File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.827:
download - view:
text,
annotated -
select for diffs
Thu Jan 18 18:21:10 2007 UTC (17 years, 6 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
make_public_indefinitely() for podcasting. Sets public access for a portfolio file to start immediately with no end date. Makes new record, updates existing, or does nothing as appropriate. Returns 'ok' if successful.
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.827 2007/01/18 18:21:10 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::lonnet;
31:
32: use strict;
33: use LWP::UserAgent();
34: use HTTP::Headers;
35: use HTTP::Date;
36: # use Date::Parse;
37: use vars
38: qw(%perlvar %hostname %badServerCache %iphost %spareid %hostdom
39: %libserv %pr %prp $memcache %packagetab
40: %courselogs %accesshash %userrolehash %domainrolehash $processmarker $dumpcount
41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseinstcodebuf %courseownerbuf %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 Math::Random;
56: use LONCAPA qw(:DEFAULT :match);
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: # ------------------------------------------- check if return value is an error
285:
286: sub error {
287: my ($result) = @_;
288: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
289: if ($2 == 2) { return undef; }
290: return $1;
291: }
292: return undef;
293: }
294:
295: sub convert_and_load_session_env {
296: my ($lonidsdir,$handle)=@_;
297: my @profile;
298: {
299: open(my $idf,"$lonidsdir/$handle.id");
300: flock($idf,LOCK_SH);
301: @profile=<$idf>;
302: close($idf);
303: }
304: my %temp_env;
305: foreach my $line (@profile) {
306: if ($line !~ m/=/) {
307: return 0;
308: }
309: chomp($line);
310: my ($envname,$envvalue)=split(/=/,$line,2);
311: $temp_env{&unescape($envname)} = &unescape($envvalue);
312: }
313: unlink("$lonidsdir/$handle.id");
314: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
315: 0640)) {
316: %disk_env = %temp_env;
317: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
318: untie(%disk_env);
319: }
320: return 1;
321: }
322:
323: # ------------------------------------------- Transfer profile into environment
324: my $env_loaded;
325: sub transfer_profile_to_env {
326: my ($lonidsdir,$handle,$force_transfer) = @_;
327: if (!$force_transfer && $env_loaded) { return; }
328:
329: if (!defined($lonidsdir)) {
330: $lonidsdir = $perlvar{'lonIDsDir'};
331: }
332: if (!defined($handle)) {
333: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
334: }
335:
336: my $convert;
337: {
338: open(my $idf,"$lonidsdir/$handle.id");
339: flock($idf,LOCK_SH);
340: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
341: &GDBM_READER(),0640)) {
342: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
343: untie(%disk_env);
344: } else {
345: $convert = 1;
346: }
347: }
348: if ($convert) {
349: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
350: &logthis("Failed to load session, or convert session.");
351: }
352: }
353:
354: my %remove;
355: while ( my $envname = each(%env) ) {
356: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
357: if ($time < time-300) {
358: $remove{$key}++;
359: }
360: }
361: }
362:
363: $env{'user.environment'} = "$lonidsdir/$handle.id";
364: $env_loaded=1;
365: foreach my $expired_key (keys(%remove)) {
366: &delenv($expired_key);
367: }
368: }
369:
370: # ---------------------------------------------------------- Append Environment
371:
372: sub appenv {
373: my %newenv=@_;
374: foreach my $key (keys(%newenv)) {
375: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
376: &logthis("<font color=\"blue\">WARNING: ".
377: "Attempt to modify environment ".$key." to ".$newenv{$key}
378: .'</font>');
379: delete($newenv{$key});
380: } else {
381: $env{$key}=$newenv{$key};
382: }
383: }
384: if (tie(my %disk_env,'GDBM_File',$env{'user.environment'},&GDBM_WRITER(),
385: 0640)) {
386: while (my ($key,$value) = each(%newenv)) {
387: $disk_env{$key} = $value;
388: }
389: untie(%disk_env);
390: }
391: return 'ok';
392: }
393: # ----------------------------------------------------- Delete from Environment
394:
395: sub delenv {
396: my $delthis=shift;
397: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
398: &logthis("<font color=\"blue\">WARNING: ".
399: "Attempt to delete from environment ".$delthis);
400: return 'error';
401: }
402: if (tie(my %disk_env,'GDBM_File',$env{'user.environment'},&GDBM_WRITER(),
403: 0640)) {
404: foreach my $key (keys(%disk_env)) {
405: if ($key=~/^$delthis/) {
406: delete($env{$key});
407: delete($disk_env{$key});
408: }
409: }
410: untie(%disk_env);
411: }
412: return 'ok';
413: }
414:
415: sub get_env_multiple {
416: my ($name) = @_;
417: my @values;
418: if (defined($env{$name})) {
419: # exists is it an array
420: if (ref($env{$name})) {
421: @values=@{ $env{$name} };
422: } else {
423: $values[0]=$env{$name};
424: }
425: }
426: return(@values);
427: }
428:
429: # ------------------------------------------ Find out current server userload
430: # there is a copy in lond
431: sub userload {
432: my $numusers=0;
433: {
434: opendir(LONIDS,$perlvar{'lonIDsDir'});
435: my $filename;
436: my $curtime=time;
437: while ($filename=readdir(LONIDS)) {
438: if ($filename eq '.' || $filename eq '..') {next;}
439: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
440: if ($curtime-$mtime < 1800) { $numusers++; }
441: }
442: closedir(LONIDS);
443: }
444: my $userloadpercent=0;
445: my $maxuserload=$perlvar{'lonUserLoadLim'};
446: if ($maxuserload) {
447: $userloadpercent=100*$numusers/$maxuserload;
448: }
449: $userloadpercent=sprintf("%.2f",$userloadpercent);
450: return $userloadpercent;
451: }
452:
453: # ------------------------------------------ Fight off request when overloaded
454:
455: sub overloaderror {
456: my ($r,$checkserver)=@_;
457: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
458: my $loadavg;
459: if ($checkserver eq $perlvar{'lonHostID'}) {
460: open(my $loadfile,'/proc/loadavg');
461: $loadavg=<$loadfile>;
462: $loadavg =~ s/\s.*//g;
463: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
464: close($loadfile);
465: } else {
466: $loadavg=&reply('load',$checkserver);
467: }
468: my $overload=$loadavg-100;
469: if ($overload>0) {
470: $r->err_headers_out->{'Retry-After'}=$overload;
471: $r->log_error('Overload of '.$overload.' on '.$checkserver);
472: return 413;
473: }
474: return '';
475: }
476:
477: # ------------------------------ Find server with least workload from spare.tab
478:
479: sub spareserver {
480: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
481: my $spare_server;
482: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
483: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
484: : $userloadpercent;
485:
486: foreach my $try_server (@{ $spareid{'primary'} }) {
487: ($spare_server, $lowest_load) =
488: &compare_server_load($try_server, $spare_server, $lowest_load);
489: }
490:
491: my $found_server = ($spare_server ne '' && $lowest_load < 100);
492:
493: if (!$found_server) {
494: foreach my $try_server (@{ $spareid{'default'} }) {
495: ($spare_server, $lowest_load) =
496: &compare_server_load($try_server, $spare_server, $lowest_load);
497: }
498: }
499:
500: if (!$want_server_name) {
501: $spare_server="http://$hostname{$spare_server}";
502: }
503: return $spare_server;
504: }
505:
506: sub compare_server_load {
507: my ($try_server, $spare_server, $lowest_load) = @_;
508:
509: my $loadans = &reply('load', $try_server);
510: my $userloadans = &reply('userload',$try_server);
511:
512: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
513: next; #didn't get a number from the server
514: }
515:
516: my $load;
517: if ($loadans =~ /\d/) {
518: if ($userloadans =~ /\d/) {
519: #both are numbers, pick the bigger one
520: $load = ($loadans > $userloadans) ? $loadans
521: : $userloadans;
522: } else {
523: $load = $loadans;
524: }
525: } else {
526: $load = $userloadans;
527: }
528:
529: if (($load =~ /\d/) && ($load < $lowest_load)) {
530: $spare_server = $try_server;
531: $lowest_load = $load;
532: }
533: return ($spare_server,$lowest_load);
534: }
535: # --------------------------------------------- Try to change a user's password
536:
537: sub changepass {
538: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
539: $currentpass = &escape($currentpass);
540: $newpass = &escape($newpass);
541: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
542: $server);
543: if (! $answer) {
544: &logthis("No reply on password change request to $server ".
545: "by $uname in domain $udom.");
546: } elsif ($answer =~ "^ok") {
547: &logthis("$uname in $udom successfully changed their password ".
548: "on $server.");
549: } elsif ($answer =~ "^pwchange_failure") {
550: &logthis("$uname in $udom was unable to change their password ".
551: "on $server. The action was blocked by either lcpasswd ".
552: "or pwchange");
553: } elsif ($answer =~ "^non_authorized") {
554: &logthis("$uname in $udom did not get their password correct when ".
555: "attempting to change it on $server.");
556: } elsif ($answer =~ "^auth_mode_error") {
557: &logthis("$uname in $udom attempted to change their password despite ".
558: "not being locally or internally authenticated on $server.");
559: } elsif ($answer =~ "^unknown_user") {
560: &logthis("$uname in $udom attempted to change their password ".
561: "on $server but were unable to because $server is not ".
562: "their home server.");
563: } elsif ($answer =~ "^refused") {
564: &logthis("$server refused to change $uname in $udom password because ".
565: "it was sent an unencrypted request to change the password.");
566: }
567: return $answer;
568: }
569:
570: # ----------------------- Try to determine user's current authentication scheme
571:
572: sub queryauthenticate {
573: my ($uname,$udom)=@_;
574: my $uhome=&homeserver($uname,$udom);
575: if (!$uhome) {
576: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
577: return 'no_host';
578: }
579: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
580: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
581: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
582: }
583: return $answer;
584: }
585:
586: # --------- Try to authenticate user from domain's lib servers (first this one)
587:
588: sub authenticate {
589: my ($uname,$upass,$udom)=@_;
590: $upass=&escape($upass);
591: $uname= &LONCAPA::clean_username($uname);
592: my $uhome=&homeserver($uname,$udom);
593: if (!$uhome) {
594: &logthis("User $uname at $udom is unknown in authenticate");
595: return 'no_host';
596: }
597: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
598: if ($answer eq 'authorized') {
599: &logthis("User $uname at $udom authorized by $uhome");
600: return $uhome;
601: }
602: if ($answer eq 'non_authorized') {
603: &logthis("User $uname at $udom rejected by $uhome");
604: return 'no_host';
605: }
606: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
607: return 'no_host';
608: }
609:
610: # ---------------------- Find the homebase for a user from domain's lib servers
611:
612: my %homecache;
613: sub homeserver {
614: my ($uname,$udom,$ignoreBadCache)=@_;
615: my $index="$uname:$udom";
616:
617: if (exists($homecache{$index})) { return $homecache{$index}; }
618: my $tryserver;
619: foreach $tryserver (keys %libserv) {
620: next if ($ignoreBadCache ne 'true' &&
621: exists($badServerCache{$tryserver}));
622: if ($hostdom{$tryserver} eq $udom) {
623: my $answer=reply("home:$udom:$uname",$tryserver);
624: if ($answer eq 'found') {
625: return $homecache{$index}=$tryserver;
626: } elsif ($answer eq 'no_host') {
627: $badServerCache{$tryserver}=1;
628: }
629: }
630: }
631: return 'no_host';
632: }
633:
634: # ------------------------------------- Find the usernames behind a list of IDs
635:
636: sub idget {
637: my ($udom,@ids)=@_;
638: my %returnhash=();
639:
640: my $tryserver;
641: foreach $tryserver (keys %libserv) {
642: if ($hostdom{$tryserver} eq $udom) {
643: my $idlist=join('&',@ids);
644: $idlist=~tr/A-Z/a-z/;
645: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
646: my @answer=();
647: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
648: @answer=split(/\&/,$reply);
649: } ;
650: my $i;
651: for ($i=0;$i<=$#ids;$i++) {
652: if ($answer[$i]) {
653: $returnhash{$ids[$i]}=$answer[$i];
654: }
655: }
656: }
657: }
658: return %returnhash;
659: }
660:
661: # ------------------------------------- Find the IDs behind a list of usernames
662:
663: sub idrget {
664: my ($udom,@unames)=@_;
665: my %returnhash=();
666: foreach my $uname (@unames) {
667: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
668: }
669: return %returnhash;
670: }
671:
672: # ------------------------------- Store away a list of names and associated IDs
673:
674: sub idput {
675: my ($udom,%ids)=@_;
676: my %servers=();
677: foreach my $uname (keys(%ids)) {
678: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
679: my $uhom=&homeserver($uname,$udom);
680: if ($uhom ne 'no_host') {
681: my $id=&escape($ids{$uname});
682: $id=~tr/A-Z/a-z/;
683: my $esc_unam=&escape($uname);
684: if ($servers{$uhom}) {
685: $servers{$uhom}.='&'.$id.'='.$esc_unam;
686: } else {
687: $servers{$uhom}=$id.'='.$esc_unam;
688: }
689: }
690: }
691: foreach my $server (keys(%servers)) {
692: &critical('idput:'.$udom.':'.$servers{$server},$server);
693: }
694: }
695:
696: # ------------------------------------------- get items from domain db files
697:
698: sub get_dom {
699: my ($namespace,$storearr,$udom)=@_;
700: my $items='';
701: foreach my $item (@$storearr) {
702: $items.=&escape($item).'&';
703: }
704: $items=~s/\&$//;
705: if (!$udom) { $udom=$env{'user.domain'}; }
706: if (exists($domain_primary{$udom})) {
707: my $uhome=$domain_primary{$udom};
708: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
709: my @pairs=split(/\&/,$rep);
710: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
711: return @pairs;
712: }
713: my %returnhash=();
714: my $i=0;
715: foreach my $item (@$storearr) {
716: $returnhash{$item}=&thaw_unescape($pairs[$i]);
717: $i++;
718: }
719: return %returnhash;
720: } else {
721: &logthis("get_dom failed - no primary domain server for $udom");
722: }
723: }
724:
725: # -------------------------------------------- put items in domain db files
726:
727: sub put_dom {
728: my ($namespace,$storehash,$udom)=@_;
729: if (!$udom) { $udom=$env{'user.domain'}; }
730: if (exists($domain_primary{$udom})) {
731: my $uhome=$domain_primary{$udom};
732: my $items='';
733: foreach my $item (keys(%$storehash)) {
734: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
735: }
736: $items=~s/\&$//;
737: return &reply("putdom:$udom:$namespace:$items",$uhome);
738: } else {
739: &logthis("put_dom failed - no primary domain server for $udom");
740: }
741: }
742:
743: # --------------------------------------------------- Assign a key to a student
744:
745: sub assign_access_key {
746: #
747: # a valid key looks like uname:udom#comments
748: # comments are being appended
749: #
750: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
751: $kdom=
752: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
753: $knum=
754: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
755: $cdom=
756: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
757: $cnum=
758: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
759: $udom=$env{'user.name'} unless (defined($udom));
760: $uname=$env{'user.domain'} unless (defined($uname));
761: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
762: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
763: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
764: # assigned to this person
765: # - this should not happen,
766: # unless something went wrong
767: # the first time around
768: # ready to assign
769: $logentry=$1.'; '.$logentry;
770: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
771: $kdom,$knum) eq 'ok') {
772: # key now belongs to user
773: my $envkey='key.'.$cdom.'_'.$cnum;
774: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
775: &appenv('environment.'.$envkey => $ckey);
776: return 'ok';
777: } else {
778: return
779: 'error: Count not permanently assign key, will need to be re-entered later.';
780: }
781: } else {
782: return 'error: Could not assign key, try again later.';
783: }
784: } elsif (!$existing{$ckey}) {
785: # the key does not exist
786: return 'error: The key does not exist';
787: } else {
788: # the key is somebody else's
789: return 'error: The key is already in use';
790: }
791: }
792:
793: # ------------------------------------------ put an additional comment on a key
794:
795: sub comment_access_key {
796: #
797: # a valid key looks like uname:udom#comments
798: # comments are being appended
799: #
800: my ($ckey,$cdom,$cnum,$logentry)=@_;
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: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
806: if ($existing{$ckey}) {
807: $existing{$ckey}.='; '.$logentry;
808: # ready to assign
809: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
810: $cdom,$cnum) eq 'ok') {
811: return 'ok';
812: } else {
813: return 'error: Count not store comment.';
814: }
815: } else {
816: # the key does not exist
817: return 'error: The key does not exist';
818: }
819: }
820:
821: # ------------------------------------------------------ Generate a set of keys
822:
823: sub generate_access_keys {
824: my ($number,$cdom,$cnum,$logentry)=@_;
825: $cdom=
826: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
827: $cnum=
828: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
829: unless (&allowed('mky',$cdom)) { return 0; }
830: unless (($cdom) && ($cnum)) { return 0; }
831: if ($number>10000) { return 0; }
832: sleep(2); # make sure don't get same seed twice
833: srand(time()^($$+($$<<15))); # from "Programming Perl"
834: my $total=0;
835: for (my $i=1;$i<=$number;$i++) {
836: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
837: sprintf("%lx",int(100000*rand)).'-'.
838: sprintf("%lx",int(100000*rand));
839: $newkey=~s/1/g/g; # folks mix up 1 and l
840: $newkey=~s/0/h/g; # and also 0 and O
841: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
842: if ($existing{$newkey}) {
843: $i--;
844: } else {
845: if (&put('accesskeys',
846: { $newkey => '# generated '.localtime().
847: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
848: '; '.$logentry },
849: $cdom,$cnum) eq 'ok') {
850: $total++;
851: }
852: }
853: }
854: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
855: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
856: return $total;
857: }
858:
859: # ------------------------------------------------------- Validate an accesskey
860:
861: sub validate_access_key {
862: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
863: $cdom=
864: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
865: $cnum=
866: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
867: $udom=$env{'user.domain'} unless (defined($udom));
868: $uname=$env{'user.name'} unless (defined($uname));
869: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
870: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
871: }
872:
873: # ------------------------------------- Find the section of student in a course
874: sub devalidate_getsection_cache {
875: my ($udom,$unam,$courseid)=@_;
876: my $hashid="$udom:$unam:$courseid";
877: &devalidate_cache_new('getsection',$hashid);
878: }
879:
880: sub courseid_to_courseurl {
881: my ($courseid) = @_;
882: #already url style courseid
883: return $courseid if ($courseid =~ m{^/});
884:
885: if (exists($env{'course.'.$courseid.'.num'})) {
886: my $cnum = $env{'course.'.$courseid.'.num'};
887: my $cdom = $env{'course.'.$courseid.'.domain'};
888: return "/$cdom/$cnum";
889: }
890:
891: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
892: if (exists($courseinfo{'num'})) {
893: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
894: }
895:
896: return undef;
897: }
898:
899: sub getsection {
900: my ($udom,$unam,$courseid)=@_;
901: my $cachetime=1800;
902:
903: my $hashid="$udom:$unam:$courseid";
904: my ($result,$cached)=&is_cached_new('getsection',$hashid);
905: if (defined($cached)) { return $result; }
906:
907: my %Pending;
908: my %Expired;
909: #
910: # Each role can either have not started yet (pending), be active,
911: # or have expired.
912: #
913: # If there is an active role, we are done.
914: #
915: # If there is more than one role which has not started yet,
916: # choose the one which will start sooner
917: # If there is one role which has not started yet, return it.
918: #
919: # If there is more than one expired role, choose the one which ended last.
920: # If there is a role which has expired, return it.
921: #
922: $courseid = &courseid_to_courseurl($courseid);
923: my %roleshash = &dump('roles',$udom,$unam,$courseid);
924: foreach my $key (keys(%roleshash)) {
925: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
926: my $section=$1;
927: if ($key eq $courseid.'_st') { $section=''; }
928: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
929: my $now=time;
930: if (defined($end) && $end && ($now > $end)) {
931: $Expired{$end}=$section;
932: next;
933: }
934: if (defined($start) && $start && ($now < $start)) {
935: $Pending{$start}=$section;
936: next;
937: }
938: return &do_cache_new('getsection',$hashid,$section,$cachetime);
939: }
940: #
941: # Presumedly there will be few matching roles from the above
942: # loop and the sorting time will be negligible.
943: if (scalar(keys(%Pending))) {
944: my ($time) = sort {$a <=> $b} keys(%Pending);
945: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
946: }
947: if (scalar(keys(%Expired))) {
948: my @sorted = sort {$a <=> $b} keys(%Expired);
949: my $time = pop(@sorted);
950: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
951: }
952: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
953: }
954:
955: sub save_cache {
956: &purge_remembered();
957: #&Apache::loncommon::validate_page();
958: undef(%env);
959: undef($env_loaded);
960: }
961:
962: my $to_remember=-1;
963: my %remembered;
964: my %accessed;
965: my $kicks=0;
966: my $hits=0;
967: sub devalidate_cache_new {
968: my ($name,$id,$debug) = @_;
969: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
970: $id=&escape($name.':'.$id);
971: $memcache->delete($id);
972: delete($remembered{$id});
973: delete($accessed{$id});
974: }
975:
976: sub is_cached_new {
977: my ($name,$id,$debug) = @_;
978: $id=&escape($name.':'.$id);
979: if (exists($remembered{$id})) {
980: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
981: $accessed{$id}=[&gettimeofday()];
982: $hits++;
983: return ($remembered{$id},1);
984: }
985: my $value = $memcache->get($id);
986: if (!(defined($value))) {
987: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
988: return (undef,undef);
989: }
990: if ($value eq '__undef__') {
991: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
992: $value=undef;
993: }
994: &make_room($id,$value,$debug);
995: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
996: return ($value,1);
997: }
998:
999: sub do_cache_new {
1000: my ($name,$id,$value,$time,$debug) = @_;
1001: $id=&escape($name.':'.$id);
1002: my $setvalue=$value;
1003: if (!defined($setvalue)) {
1004: $setvalue='__undef__';
1005: }
1006: if (!defined($time) ) {
1007: $time=600;
1008: }
1009: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1010: $memcache->set($id,$setvalue,$time);
1011: # need to make a copy of $value
1012: #&make_room($id,$value,$debug);
1013: return $value;
1014: }
1015:
1016: sub make_room {
1017: my ($id,$value,$debug)=@_;
1018: $remembered{$id}=$value;
1019: if ($to_remember<0) { return; }
1020: $accessed{$id}=[&gettimeofday()];
1021: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1022: my $to_kick;
1023: my $max_time=0;
1024: foreach my $other (keys(%accessed)) {
1025: if (&tv_interval($accessed{$other}) > $max_time) {
1026: $to_kick=$other;
1027: $max_time=&tv_interval($accessed{$other});
1028: }
1029: }
1030: delete($remembered{$to_kick});
1031: delete($accessed{$to_kick});
1032: $kicks++;
1033: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1034: return;
1035: }
1036:
1037: sub purge_remembered {
1038: #&logthis("Tossing ".scalar(keys(%remembered)));
1039: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1040: undef(%remembered);
1041: undef(%accessed);
1042: }
1043: # ------------------------------------- Read an entry from a user's environment
1044:
1045: sub userenvironment {
1046: my ($udom,$unam,@what)=@_;
1047: my %returnhash=();
1048: my @answer=split(/\&/,
1049: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1050: &homeserver($unam,$udom)));
1051: my $i;
1052: for ($i=0;$i<=$#what;$i++) {
1053: $returnhash{$what[$i]}=&unescape($answer[$i]);
1054: }
1055: return %returnhash;
1056: }
1057:
1058: # ---------------------------------------------------------- Get a studentphoto
1059: sub studentphoto {
1060: my ($udom,$unam,$ext) = @_;
1061: my $home=&Apache::lonnet::homeserver($unam,$udom);
1062: if (defined($env{'request.course.id'})) {
1063: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1064: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1065: return(&retrievestudentphoto($udom,$unam,$ext));
1066: } else {
1067: my ($result,$perm_reqd)=
1068: &Apache::lonnet::auto_photo_permission($unam,$udom);
1069: if ($result eq 'ok') {
1070: if (!($perm_reqd eq 'yes')) {
1071: return(&retrievestudentphoto($udom,$unam,$ext));
1072: }
1073: }
1074: }
1075: }
1076: } else {
1077: my ($result,$perm_reqd) =
1078: &Apache::lonnet::auto_photo_permission($unam,$udom);
1079: if ($result eq 'ok') {
1080: if (!($perm_reqd eq 'yes')) {
1081: return(&retrievestudentphoto($udom,$unam,$ext));
1082: }
1083: }
1084: }
1085: return '/adm/lonKaputt/lonlogo_broken.gif';
1086: }
1087:
1088: sub retrievestudentphoto {
1089: my ($udom,$unam,$ext,$type) = @_;
1090: my $home=&Apache::lonnet::homeserver($unam,$udom);
1091: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1092: if ($ret eq 'ok') {
1093: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1094: if ($type eq 'thumbnail') {
1095: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1096: }
1097: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1098: return $tokenurl;
1099: } else {
1100: if ($type eq 'thumbnail') {
1101: return '/adm/lonKaputt/genericstudent_tn.gif';
1102: } else {
1103: return '/adm/lonKaputt/lonlogo_broken.gif';
1104: }
1105: }
1106: }
1107:
1108: # -------------------------------------------------------------------- New chat
1109:
1110: sub chatsend {
1111: my ($newentry,$anon,$group)=@_;
1112: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1113: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1114: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1115: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1116: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1117: &escape($newentry)).':'.$group,$chome);
1118: }
1119:
1120: # ------------------------------------------ Find current version of a resource
1121:
1122: sub getversion {
1123: my $fname=&clutter(shift);
1124: unless ($fname=~/^\/res\//) { return -1; }
1125: return ¤tversion(&filelocation('',$fname));
1126: }
1127:
1128: sub currentversion {
1129: my $fname=shift;
1130: my ($result,$cached)=&is_cached_new('resversion',$fname);
1131: if (defined($cached)) { return $result; }
1132: my $author=$fname;
1133: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1134: my ($udom,$uname)=split(/\//,$author);
1135: my $home=homeserver($uname,$udom);
1136: if ($home eq 'no_host') {
1137: return -1;
1138: }
1139: my $answer=reply("currentversion:$fname",$home);
1140: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1141: return -1;
1142: }
1143: return &do_cache_new('resversion',$fname,$answer,600);
1144: }
1145:
1146: # ----------------------------- Subscribe to a resource, return URL if possible
1147:
1148: sub subscribe {
1149: my $fname=shift;
1150: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1151: $fname=~s/[\n\r]//g;
1152: my $author=$fname;
1153: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1154: my ($udom,$uname)=split(/\//,$author);
1155: my $home=homeserver($uname,$udom);
1156: if ($home eq 'no_host') {
1157: return 'not_found';
1158: }
1159: my $answer=reply("sub:$fname",$home);
1160: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1161: $answer.=' by '.$home;
1162: }
1163: return $answer;
1164: }
1165:
1166: # -------------------------------------------------------------- Replicate file
1167:
1168: sub repcopy {
1169: my $filename=shift;
1170: $filename=~s/\/+/\//g;
1171: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1172: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1173: if ($filename=~m|^/home/httpd/html/userfiles/| or
1174: $filename=~m -^/*(uploaded|editupload)/-) {
1175: return &repcopy_userfile($filename);
1176: }
1177: $filename=~s/[\n\r]//g;
1178: my $transname="$filename.in.transfer";
1179: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1180: my $remoteurl=subscribe($filename);
1181: if ($remoteurl =~ /^con_lost by/) {
1182: &logthis("Subscribe returned $remoteurl: $filename");
1183: return 'unavailable';
1184: } elsif ($remoteurl eq 'not_found') {
1185: #&logthis("Subscribe returned not_found: $filename");
1186: return 'not_found';
1187: } elsif ($remoteurl =~ /^rejected by/) {
1188: &logthis("Subscribe returned $remoteurl: $filename");
1189: return 'forbidden';
1190: } elsif ($remoteurl eq 'directory') {
1191: return 'ok';
1192: } else {
1193: my $author=$filename;
1194: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1195: my ($udom,$uname)=split(/\//,$author);
1196: my $home=homeserver($uname,$udom);
1197: unless ($home eq $perlvar{'lonHostID'}) {
1198: my @parts=split(/\//,$filename);
1199: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1200: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1201: &logthis("Malconfiguration for replication: $filename");
1202: return 'bad_request';
1203: }
1204: my $count;
1205: for ($count=5;$count<$#parts;$count++) {
1206: $path.="/$parts[$count]";
1207: if ((-e $path)!=1) {
1208: mkdir($path,0777);
1209: }
1210: }
1211: my $ua=new LWP::UserAgent;
1212: my $request=new HTTP::Request('GET',"$remoteurl");
1213: my $response=$ua->request($request,$transname);
1214: if ($response->is_error()) {
1215: unlink($transname);
1216: my $message=$response->status_line;
1217: &logthis("<font color=\"blue\">WARNING:"
1218: ." LWP get: $message: $filename</font>");
1219: return 'unavailable';
1220: } else {
1221: if ($remoteurl!~/\.meta$/) {
1222: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1223: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1224: if ($mresponse->is_error()) {
1225: unlink($filename.'.meta');
1226: &logthis(
1227: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1228: }
1229: }
1230: rename($transname,$filename);
1231: return 'ok';
1232: }
1233: }
1234: }
1235: }
1236:
1237: # ------------------------------------------------ Get server side include body
1238: sub ssi_body {
1239: my ($filelink,%form)=@_;
1240: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1241: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1242: }
1243: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1244: &ssi($filelink,%form));
1245: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1246: $output=~s/^.*?\<body[^\>]*\>//si;
1247: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1248: return $output;
1249: }
1250:
1251: # --------------------------------------------------------- Server Side Include
1252:
1253: sub absolute_url {
1254: my ($host_name) = @_;
1255: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1256: if ($host_name eq '') {
1257: $host_name = $ENV{'SERVER_NAME'};
1258: }
1259: return $protocol.$host_name;
1260: }
1261:
1262: sub ssi {
1263:
1264: my ($fn,%form)=@_;
1265:
1266: my $ua=new LWP::UserAgent;
1267:
1268: my $request;
1269:
1270: $form{'no_update_last_known'}=1;
1271:
1272: if (%form) {
1273: $request=new HTTP::Request('POST',&absolute_url().$fn);
1274: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1275: } else {
1276: $request=new HTTP::Request('GET',&absolute_url().$fn);
1277: }
1278:
1279: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1280: my $response=$ua->request($request);
1281:
1282: return $response->content;
1283: }
1284:
1285: sub externalssi {
1286: my ($url)=@_;
1287: my $ua=new LWP::UserAgent;
1288: my $request=new HTTP::Request('GET',$url);
1289: my $response=$ua->request($request);
1290: return $response->content;
1291: }
1292:
1293: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1294:
1295: sub allowuploaded {
1296: my ($srcurl,$url)=@_;
1297: $url=&clutter(&declutter($url));
1298: my $dir=$url;
1299: $dir=~s/\/[^\/]+$//;
1300: my %httpref=();
1301: my $httpurl=&hreflocation('',$url);
1302: $httpref{'httpref.'.$httpurl}=$srcurl;
1303: &Apache::lonnet::appenv(%httpref);
1304: }
1305:
1306: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1307: # input: action, courseID, current domain, intended
1308: # path to file, source of file, instruction to parse file for objects,
1309: # ref to hash for embedded objects,
1310: # ref to hash for codebase of java objects.
1311: #
1312: # output: url to file (if action was uploaddoc),
1313: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1314: #
1315: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1316: # course.
1317: #
1318: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1319: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1320: # course's home server.
1321: #
1322: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1323: # be copied from $source (current location) to
1324: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1325: # and will then be copied to
1326: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1327: # course's home server.
1328: #
1329: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1330: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1331: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1332: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1333: # in course's home server.
1334: #
1335:
1336: sub process_coursefile {
1337: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1338: my $fetchresult;
1339: my $home=&homeserver($docuname,$docudom);
1340: if ($action eq 'propagate') {
1341: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1342: $home);
1343: } else {
1344: my $fpath = '';
1345: my $fname = $file;
1346: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1347: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1348: my $filepath = &build_filepath($fpath);
1349: if ($action eq 'copy') {
1350: if ($source eq '') {
1351: $fetchresult = 'no source file';
1352: return $fetchresult;
1353: } else {
1354: my $destination = $filepath.'/'.$fname;
1355: rename($source,$destination);
1356: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1357: $home);
1358: }
1359: } elsif ($action eq 'uploaddoc') {
1360: open(my $fh,'>'.$filepath.'/'.$fname);
1361: print $fh $env{'form.'.$source};
1362: close($fh);
1363: if ($parser eq 'parse') {
1364: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1365: unless ($parse_result eq 'ok') {
1366: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1367: }
1368: }
1369: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1370: $home);
1371: if ($fetchresult eq 'ok') {
1372: return '/uploaded/'.$fpath.'/'.$fname;
1373: } else {
1374: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1375: ' to host '.$home.': '.$fetchresult);
1376: return '/adm/notfound.html';
1377: }
1378: }
1379: }
1380: unless ( $fetchresult eq 'ok') {
1381: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1382: ' to host '.$home.': '.$fetchresult);
1383: }
1384: return $fetchresult;
1385: }
1386:
1387: sub build_filepath {
1388: my ($fpath) = @_;
1389: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1390: unless ($fpath eq '') {
1391: my @parts=split('/',$fpath);
1392: foreach my $part (@parts) {
1393: $filepath.= '/'.$part;
1394: if ((-e $filepath)!=1) {
1395: mkdir($filepath,0777);
1396: }
1397: }
1398: }
1399: return $filepath;
1400: }
1401:
1402: sub store_edited_file {
1403: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1404: my $file = $primary_url;
1405: $file =~ s#^/uploaded/$docudom/$docuname/##;
1406: my $fpath = '';
1407: my $fname = $file;
1408: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1409: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1410: my $filepath = &build_filepath($fpath);
1411: open(my $fh,'>'.$filepath.'/'.$fname);
1412: print $fh $content;
1413: close($fh);
1414: my $home=&homeserver($docuname,$docudom);
1415: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1416: $home);
1417: if ($$fetchresult eq 'ok') {
1418: return '/uploaded/'.$fpath.'/'.$fname;
1419: } else {
1420: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1421: ' to host '.$home.': '.$$fetchresult);
1422: return '/adm/notfound.html';
1423: }
1424: }
1425:
1426: sub clean_filename {
1427: my ($fname)=@_;
1428: # Replace Windows backslashes by forward slashes
1429: $fname=~s/\\/\//g;
1430: # Get rid of everything but the actual filename
1431: $fname=~s/^.*\/([^\/]+)$/$1/;
1432: # Replace spaces by underscores
1433: $fname=~s/\s+/\_/g;
1434: # Replace all other weird characters by nothing
1435: $fname=~s/[^\w\.\-]//g;
1436: # Replace all .\d. sequences with _\d. so they no longer look like version
1437: # numbers
1438: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1439: return $fname;
1440: }
1441:
1442: # --------------- Take an uploaded file and put it into the userfiles directory
1443: # input: $formname - the contents of the file are in $env{"form.$formname"}
1444: # the desired filenam is in $env{"form.$formname.filename"}
1445: # $coursedoc - if true up to the current course
1446: # if false
1447: # $subdir - directory in userfile to store the file into
1448: # $parser, $allfiles, $codebase - unknown
1449: #
1450: # output: url of file in userspace, or error: <message>
1451: # or /adm/notfound.html if failure to upload occurse
1452:
1453:
1454: sub userfileupload {
1455: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1456: if (!defined($subdir)) { $subdir='unknown'; }
1457: my $fname=$env{'form.'.$formname.'.filename'};
1458: $fname=&clean_filename($fname);
1459: # See if there is anything left
1460: unless ($fname) { return 'error: no uploaded file'; }
1461: chop($env{'form.'.$formname});
1462: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1463: my $now = time;
1464: my $filepath = 'tmp/helprequests/'.$now;
1465: my @parts=split(/\//,$filepath);
1466: my $fullpath = $perlvar{'lonDaemons'};
1467: for (my $i=0;$i<@parts;$i++) {
1468: $fullpath .= '/'.$parts[$i];
1469: if ((-e $fullpath)!=1) {
1470: mkdir($fullpath,0777);
1471: }
1472: }
1473: open(my $fh,'>'.$fullpath.'/'.$fname);
1474: print $fh $env{'form.'.$formname};
1475: close($fh);
1476: return $fullpath.'/'.$fname;
1477: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1478: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1479: '_'.$env{'user.domain'}.'/pending';
1480: my @parts=split(/\//,$filepath);
1481: my $fullpath = $perlvar{'lonDaemons'};
1482: for (my $i=0;$i<@parts;$i++) {
1483: $fullpath .= '/'.$parts[$i];
1484: if ((-e $fullpath)!=1) {
1485: mkdir($fullpath,0777);
1486: }
1487: }
1488: open(my $fh,'>'.$fullpath.'/'.$fname);
1489: print $fh $env{'form.'.$formname};
1490: close($fh);
1491: return $fullpath.'/'.$fname;
1492: }
1493:
1494: # Create the directory if not present
1495: $fname="$subdir/$fname";
1496: if ($coursedoc) {
1497: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1498: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1499: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1500: return &finishuserfileupload($docuname,$docudom,
1501: $formname,$fname,$parser,$allfiles,
1502: $codebase);
1503: } else {
1504: $fname=$env{'form.folder'}.'/'.$fname;
1505: return &process_coursefile('uploaddoc',$docuname,$docudom,
1506: $fname,$formname,$parser,
1507: $allfiles,$codebase);
1508: }
1509: } elsif (defined($destuname)) {
1510: my $docuname=$destuname;
1511: my $docudom=$destudom;
1512: return &finishuserfileupload($docuname,$docudom,$formname,
1513: $fname,$parser,$allfiles,$codebase);
1514:
1515: } else {
1516: my $docuname=$env{'user.name'};
1517: my $docudom=$env{'user.domain'};
1518: if (exists($env{'form.group'})) {
1519: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1520: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1521: }
1522: return &finishuserfileupload($docuname,$docudom,$formname,
1523: $fname,$parser,$allfiles,$codebase);
1524: }
1525: }
1526:
1527: sub finishuserfileupload {
1528: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1529: my $path=$docudom.'/'.$docuname.'/';
1530: my $filepath=$perlvar{'lonDocRoot'};
1531: my ($fnamepath,$file);
1532: $file=$fname;
1533: if ($fname=~m|/|) {
1534: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1535: $path.=$fnamepath.'/';
1536: }
1537: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1538: my $count;
1539: for ($count=4;$count<=$#parts;$count++) {
1540: $filepath.="/$parts[$count]";
1541: if ((-e $filepath)!=1) {
1542: mkdir($filepath,0777);
1543: }
1544: }
1545: # Save the file
1546: {
1547: if (!open(FH,'>'.$filepath.'/'.$file)) {
1548: &logthis('Failed to create '.$filepath.'/'.$file);
1549: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1550: return '/adm/notfound.html';
1551: }
1552: if (!print FH ($env{'form.'.$formname})) {
1553: &logthis('Failed to write to '.$filepath.'/'.$file);
1554: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1555: return '/adm/notfound.html';
1556: }
1557: close(FH);
1558: }
1559: if ($parser eq 'parse') {
1560: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1561: $codebase);
1562: unless ($parse_result eq 'ok') {
1563: &logthis('Failed to parse '.$filepath.$file.
1564: ' for embedded media: '.$parse_result);
1565: }
1566: }
1567: # Notify homeserver to grep it
1568: #
1569: my $docuhome=&homeserver($docuname,$docudom);
1570: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1571: if ($fetchresult eq 'ok') {
1572: #
1573: # Return the URL to it
1574: return '/uploaded/'.$path.$file;
1575: } else {
1576: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1577: ': '.$fetchresult);
1578: return '/adm/notfound.html';
1579: }
1580: }
1581:
1582: sub extract_embedded_items {
1583: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1584: my @state = ();
1585: my %javafiles = (
1586: codebase => '',
1587: code => '',
1588: archive => ''
1589: );
1590: my %mediafiles = (
1591: src => '',
1592: movie => '',
1593: );
1594: my $p;
1595: if ($content) {
1596: $p = HTML::LCParser->new($content);
1597: } else {
1598: $p = HTML::LCParser->new($filepath.'/'.$file);
1599: }
1600: while (my $t=$p->get_token()) {
1601: if ($t->[0] eq 'S') {
1602: my ($tagname, $attr) = ($t->[1],$t->[2]);
1603: push (@state, $tagname);
1604: if (lc($tagname) eq 'allow') {
1605: &add_filetype($allfiles,$attr->{'src'},'src');
1606: }
1607: if (lc($tagname) eq 'img') {
1608: &add_filetype($allfiles,$attr->{'src'},'src');
1609: }
1610: if (lc($tagname) eq 'script') {
1611: if ($attr->{'archive'} =~ /\.jar$/i) {
1612: &add_filetype($allfiles,$attr->{'archive'},'archive');
1613: } else {
1614: &add_filetype($allfiles,$attr->{'src'},'src');
1615: }
1616: }
1617: if (lc($tagname) eq 'link') {
1618: if (lc($attr->{'rel'}) eq 'stylesheet') {
1619: &add_filetype($allfiles,$attr->{'href'},'href');
1620: }
1621: }
1622: if (lc($tagname) eq 'object' ||
1623: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1624: foreach my $item (keys(%javafiles)) {
1625: $javafiles{$item} = '';
1626: }
1627: }
1628: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1629: my $name = lc($attr->{'name'});
1630: foreach my $item (keys(%javafiles)) {
1631: if ($name eq $item) {
1632: $javafiles{$item} = $attr->{'value'};
1633: last;
1634: }
1635: }
1636: foreach my $item (keys(%mediafiles)) {
1637: if ($name eq $item) {
1638: &add_filetype($allfiles, $attr->{'value'}, 'value');
1639: last;
1640: }
1641: }
1642: }
1643: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1644: foreach my $item (keys(%javafiles)) {
1645: if ($attr->{$item}) {
1646: $javafiles{$item} = $attr->{$item};
1647: last;
1648: }
1649: }
1650: foreach my $item (keys(%mediafiles)) {
1651: if ($attr->{$item}) {
1652: &add_filetype($allfiles,$attr->{$item},$item);
1653: last;
1654: }
1655: }
1656: }
1657: } elsif ($t->[0] eq 'E') {
1658: my ($tagname) = ($t->[1]);
1659: if ($javafiles{'codebase'} ne '') {
1660: $javafiles{'codebase'} .= '/';
1661: }
1662: if (lc($tagname) eq 'applet' ||
1663: lc($tagname) eq 'object' ||
1664: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1665: ) {
1666: foreach my $item (keys(%javafiles)) {
1667: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1668: my $file=$javafiles{'codebase'}.$javafiles{$item};
1669: &add_filetype($allfiles,$file,$item);
1670: }
1671: }
1672: }
1673: pop @state;
1674: }
1675: }
1676: return 'ok';
1677: }
1678:
1679: sub add_filetype {
1680: my ($allfiles,$file,$type)=@_;
1681: if (exists($allfiles->{$file})) {
1682: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1683: push(@{$allfiles->{$file}}, &escape($type));
1684: }
1685: } else {
1686: @{$allfiles->{$file}} = (&escape($type));
1687: }
1688: }
1689:
1690: sub removeuploadedurl {
1691: my ($url)=@_;
1692: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1693: return &removeuserfile($uname,$udom,$fname);
1694: }
1695:
1696: sub removeuserfile {
1697: my ($docuname,$docudom,$fname)=@_;
1698: my $home=&homeserver($docuname,$docudom);
1699: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1700: if ($result eq 'ok') {
1701: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
1702: my $metafile = $fname.'.meta';
1703: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1704: my $url = "/uploaded/$docudom/$docuname/$fname";
1705: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1706: my $sqlresult =
1707: &update_portfolio_table($docuname,$docudom,$file,
1708: 'portfolio_metadata',$group,
1709: 'delete');
1710: }
1711: }
1712: return $result;
1713: }
1714:
1715: sub mkdiruserfile {
1716: my ($docuname,$docudom,$dir)=@_;
1717: my $home=&homeserver($docuname,$docudom);
1718: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1719: }
1720:
1721: sub renameuserfile {
1722: my ($docuname,$docudom,$old,$new)=@_;
1723: my $home=&homeserver($docuname,$docudom);
1724: my $result = &reply("renameuserfile:$docudom:$docuname:".
1725: &escape("$old").':'.&escape("$new"),$home);
1726: if ($result eq 'ok') {
1727: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
1728: my $oldmeta = $old.'.meta';
1729: my $newmeta = $new.'.meta';
1730: my $metaresult =
1731: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1732: my $url = "/uploaded/$docudom/$docuname/$old";
1733: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1734: my $sqlresult =
1735: &update_portfolio_table($docuname,$docudom,$file,
1736: 'portfolio_metadata',$group,
1737: 'delete');
1738: }
1739: }
1740: return $result;
1741: }
1742:
1743: # ------------------------------------------------------------------------- Log
1744:
1745: sub log {
1746: my ($dom,$nam,$hom,$what)=@_;
1747: return critical("log:$dom:$nam:$what",$hom);
1748: }
1749:
1750: # ------------------------------------------------------------------ Course Log
1751: #
1752: # This routine flushes several buffers of non-mission-critical nature
1753: #
1754:
1755: sub flushcourselogs {
1756: &logthis('Flushing log buffers');
1757: #
1758: # course logs
1759: # This is a log of all transactions in a course, which can be used
1760: # for data mining purposes
1761: #
1762: # It also collects the courseid database, which lists last transaction
1763: # times and course titles for all courseids
1764: #
1765: my %courseidbuffer=();
1766: foreach my $crsid (keys %courselogs) {
1767: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1768: &escape($courselogs{$crsid}),
1769: $coursehombuf{$crsid}) eq 'ok') {
1770: delete $courselogs{$crsid};
1771: } else {
1772: &logthis('Failed to flush log buffer for '.$crsid);
1773: if (length($courselogs{$crsid})>40000) {
1774: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1775: " exceeded maximum size, deleting.</font>");
1776: delete $courselogs{$crsid};
1777: }
1778: }
1779: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1780: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1781: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1782: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1783: } else {
1784: $courseidbuffer{$coursehombuf{$crsid}}=
1785: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1786: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1787: }
1788: }
1789: #
1790: # Write course id database (reverse lookup) to homeserver of courses
1791: # Is used in pickcourse
1792: #
1793: foreach my $crsid (keys(%courseidbuffer)) {
1794: &courseidput($hostdom{$crsid},$courseidbuffer{$crsid},$crsid);
1795: }
1796: #
1797: # File accesses
1798: # Writes to the dynamic metadata of resources to get hit counts, etc.
1799: #
1800: foreach my $entry (keys(%accesshash)) {
1801: if ($entry =~ /___count$/) {
1802: my ($dom,$name);
1803: ($dom,$name,undef)=
1804: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1805: if (! defined($dom) || $dom eq '' ||
1806: ! defined($name) || $name eq '') {
1807: my $cid = $env{'request.course.id'};
1808: $dom = $env{'request.'.$cid.'.domain'};
1809: $name = $env{'request.'.$cid.'.num'};
1810: }
1811: my $value = $accesshash{$entry};
1812: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1813: my %temphash=($url => $value);
1814: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1815: if ($result eq 'ok') {
1816: delete $accesshash{$entry};
1817: } elsif ($result eq 'unknown_cmd') {
1818: # Target server has old code running on it.
1819: my %temphash=($entry => $value);
1820: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1821: delete $accesshash{$entry};
1822: }
1823: }
1824: } else {
1825: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1826: my %temphash=($entry => $accesshash{$entry});
1827: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1828: delete $accesshash{$entry};
1829: }
1830: }
1831: }
1832: #
1833: # Roles
1834: # Reverse lookup of user roles for course faculty/staff and co-authorship
1835: #
1836: foreach my $entry (keys(%userrolehash)) {
1837: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1838: split(/\:/,$entry);
1839: if (&Apache::lonnet::put('nohist_userroles',
1840: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1841: $rudom,$runame) eq 'ok') {
1842: delete $userrolehash{$entry};
1843: }
1844: }
1845: #
1846: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1847: #
1848: my %domrolebuffer = ();
1849: foreach my $entry (keys %domainrolehash) {
1850: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1851: if ($domrolebuffer{$rudom}) {
1852: $domrolebuffer{$rudom}.='&'.&escape($entry).
1853: '='.&escape($domainrolehash{$entry});
1854: } else {
1855: $domrolebuffer{$rudom}.=&escape($entry).
1856: '='.&escape($domainrolehash{$entry});
1857: }
1858: delete $domainrolehash{$entry};
1859: }
1860: foreach my $dom (keys(%domrolebuffer)) {
1861: foreach my $tryserver (keys %libserv) {
1862: if ($hostdom{$tryserver} eq $dom) {
1863: unless (&reply('domroleput:'.$dom.':'.
1864: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1865: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1866: }
1867: }
1868: }
1869: }
1870: $dumpcount++;
1871: }
1872:
1873: sub courselog {
1874: my $what=shift;
1875: $what=time.':'.$what;
1876: unless ($env{'request.course.id'}) { return ''; }
1877: $coursedombuf{$env{'request.course.id'}}=
1878: $env{'course.'.$env{'request.course.id'}.'.domain'};
1879: $coursenumbuf{$env{'request.course.id'}}=
1880: $env{'course.'.$env{'request.course.id'}.'.num'};
1881: $coursehombuf{$env{'request.course.id'}}=
1882: $env{'course.'.$env{'request.course.id'}.'.home'};
1883: $coursedescrbuf{$env{'request.course.id'}}=
1884: $env{'course.'.$env{'request.course.id'}.'.description'};
1885: $courseinstcodebuf{$env{'request.course.id'}}=
1886: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1887: $courseownerbuf{$env{'request.course.id'}}=
1888: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1889: $coursetypebuf{$env{'request.course.id'}}=
1890: $env{'course.'.$env{'request.course.id'}.'.type'};
1891: if (defined $courselogs{$env{'request.course.id'}}) {
1892: $courselogs{$env{'request.course.id'}}.='&'.$what;
1893: } else {
1894: $courselogs{$env{'request.course.id'}}.=$what;
1895: }
1896: if (length($courselogs{$env{'request.course.id'}})>4048) {
1897: &flushcourselogs();
1898: }
1899: }
1900:
1901: sub courseacclog {
1902: my $fnsymb=shift;
1903: unless ($env{'request.course.id'}) { return ''; }
1904: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1905: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1906: $what.=':POST';
1907: # FIXME: Probably ought to escape things....
1908: foreach my $key (keys(%env)) {
1909: if ($key=~/^form\.(.*)/) {
1910: $what.=':'.$1.'='.$env{$key};
1911: }
1912: }
1913: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1914: # FIXME: We should not be depending on a form parameter that someone
1915: # editing lonsearchcat.pm might change in the future.
1916: if ($env{'form.phase'} eq 'course_search') {
1917: $what.= ':POST';
1918: # FIXME: Probably ought to escape things....
1919: foreach my $element ('courseexp','crsfulltext','crsrelated',
1920: 'crsdiscuss') {
1921: $what.=':'.$element.'='.$env{'form.'.$element};
1922: }
1923: }
1924: }
1925: &courselog($what);
1926: }
1927:
1928: sub countacc {
1929: my $url=&declutter(shift);
1930: return if (! defined($url) || $url eq '');
1931: unless ($env{'request.course.id'}) { return ''; }
1932: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1933: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1934: $accesshash{$key}++;
1935: }
1936:
1937: sub linklog {
1938: my ($from,$to)=@_;
1939: $from=&declutter($from);
1940: $to=&declutter($to);
1941: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1942: $accesshash{$to.'___'.$from.'___goto'}=1;
1943: }
1944:
1945: sub userrolelog {
1946: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1947: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1948: ($trole=~/^in/) || ($trole=~/^cc/) ||
1949: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1950: ($trole=~/^ta/)) {
1951: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1952: $userrolehash
1953: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1954: =$tend.':'.$tstart;
1955: }
1956: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1957: ($trole=~/^li/) || ($trole=~/^li/) ||
1958: ($trole=~/^au/) || ($trole=~/^dg/) ||
1959: ($trole=~/^sc/)) {
1960: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1961: $domainrolehash
1962: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1963: = $tend.':'.$tstart;
1964: }
1965: }
1966:
1967: sub get_course_adv_roles {
1968: my $cid=shift;
1969: $cid=$env{'request.course.id'} unless (defined($cid));
1970: my %coursehash=&coursedescription($cid);
1971: my %nothide=();
1972: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1973: $nothide{join(':',split(/[\@\:]/,$user))}=1;
1974: }
1975: my %returnhash=();
1976: my %dumphash=
1977: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1978: my $now=time;
1979: foreach my $entry (keys %dumphash) {
1980: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1981: if (($tstart) && ($tstart<0)) { next; }
1982: if (($tend) && ($tend<$now)) { next; }
1983: if (($tstart) && ($now<$tstart)) { next; }
1984: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1985: if ($username eq '' || $domain eq '') { next; }
1986: if ((&privileged($username,$domain)) &&
1987: (!$nothide{$username.':'.$domain})) { next; }
1988: if ($role eq 'cr') { next; }
1989: my $key=&plaintext($role);
1990: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1991: if ($returnhash{$key}) {
1992: $returnhash{$key}.=','.$username.':'.$domain;
1993: } else {
1994: $returnhash{$key}=$username.':'.$domain;
1995: }
1996: }
1997: return %returnhash;
1998: }
1999:
2000: sub get_my_roles {
2001: my ($uname,$udom)=@_;
2002: unless (defined($uname)) { $uname=$env{'user.name'}; }
2003: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2004: my %dumphash=
2005: &dump('nohist_userroles',$udom,$uname);
2006: my %returnhash=();
2007: my $now=time;
2008: foreach my $entry (keys(%dumphash)) {
2009: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2010: if (($tstart) && ($tstart<0)) { next; }
2011: if (($tend) && ($tend<$now)) { next; }
2012: if (($tstart) && ($now<$tstart)) { next; }
2013: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2014: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2015: }
2016: return %returnhash;
2017: }
2018:
2019: # ----------------------------------------------------- Frontpage Announcements
2020: #
2021: #
2022:
2023: sub postannounce {
2024: my ($server,$text)=@_;
2025: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
2026: unless ($text=~/\w/) { $text=''; }
2027: return &reply('setannounce:'.&escape($text),$server);
2028: }
2029:
2030: sub getannounce {
2031:
2032: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2033: my $announcement='';
2034: while (my $line = <$fh>) { $announcement .= $line; }
2035: close($fh);
2036: if ($announcement=~/\w/) {
2037: return
2038: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2039: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2040: } else {
2041: return '';
2042: }
2043: } else {
2044: return '';
2045: }
2046: }
2047:
2048: # ---------------------------------------------------------- Course ID routines
2049: # Deal with domain's nohist_courseid.db files
2050: #
2051:
2052: sub courseidput {
2053: my ($domain,$what,$coursehome)=@_;
2054: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2055: }
2056:
2057: sub courseiddump {
2058: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
2059: my %returnhash=();
2060: unless ($domfilter) { $domfilter=''; }
2061: foreach my $tryserver (keys %libserv) {
2062: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
2063: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
2064: foreach my $line (
2065: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
2066: $sincefilter.':'.&escape($descfilter).':'.
2067: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter).':'.&escape($regexp_ok),
2068: $tryserver))) {
2069: my ($key,$value)=split(/\=/,$line,2);
2070: if (($key) && ($value)) {
2071: $returnhash{&unescape($key)}=$value;
2072: }
2073: }
2074: }
2075: }
2076: }
2077: return %returnhash;
2078: }
2079:
2080: # ---------------------------------------------------------- DC e-mail
2081:
2082: sub dcmailput {
2083: my ($domain,$msgid,$message,$server)=@_;
2084: my $status = &Apache::lonnet::critical(
2085: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2086: &escape($message),$server);
2087: return $status;
2088: }
2089:
2090: sub dcmaildump {
2091: my ($dom,$startdate,$enddate,$senders) = @_;
2092: my %returnhash=();
2093: if (exists($domain_primary{$dom})) {
2094: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2095: &escape($enddate).':';
2096: my @esc_senders=map { &escape($_)} @$senders;
2097: $cmd.=&escape(join('&',@esc_senders));
2098: foreach my $line (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
2099: my ($key,$value) = split(/\=/,$line,2);
2100: if (($key) && ($value)) {
2101: $returnhash{&unescape($key)} = &unescape($value);
2102: }
2103: }
2104: }
2105: return %returnhash;
2106: }
2107: # ---------------------------------------------------------- Domain roles
2108:
2109: sub get_domain_roles {
2110: my ($dom,$roles,$startdate,$enddate)=@_;
2111: if (undef($startdate) || $startdate eq '') {
2112: $startdate = '.';
2113: }
2114: if (undef($enddate) || $enddate eq '') {
2115: $enddate = '.';
2116: }
2117: my $rolelist = join(':',@{$roles});
2118: my %personnel = ();
2119: foreach my $tryserver (keys(%libserv)) {
2120: if ($hostdom{$tryserver} eq $dom) {
2121: %{$personnel{$tryserver}}=();
2122: foreach my $line (
2123: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2124: &escape($startdate).':'.&escape($enddate).':'.
2125: &escape($rolelist), $tryserver))) {
2126: my ($key,$value) = split(/\=/,$line,2);
2127: if (($key) && ($value)) {
2128: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2129: }
2130: }
2131: }
2132: }
2133: return %personnel;
2134: }
2135:
2136: # ----------------------------------------------------------- Check out an item
2137:
2138: sub get_first_access {
2139: my ($type,$argsymb)=@_;
2140: my ($symb,$courseid,$udom,$uname)=&whichuser();
2141: if ($argsymb) { $symb=$argsymb; }
2142: my ($map,$id,$res)=&decode_symb($symb);
2143: if ($type eq 'map') {
2144: $res=&symbread($map);
2145: } else {
2146: $res=$symb;
2147: }
2148: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2149: return $times{"$courseid\0$res"};
2150: }
2151:
2152: sub set_first_access {
2153: my ($type)=@_;
2154: my ($symb,$courseid,$udom,$uname)=&whichuser();
2155: my ($map,$id,$res)=&decode_symb($symb);
2156: if ($type eq 'map') {
2157: $res=&symbread($map);
2158: } else {
2159: $res=$symb;
2160: }
2161: my $firstaccess=&get_first_access($type,$symb);
2162: if (!$firstaccess) {
2163: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2164: }
2165: return 'already_set';
2166: }
2167:
2168: sub checkout {
2169: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2170: my $now=time;
2171: my $lonhost=$perlvar{'lonHostID'};
2172: my $infostr=&escape(
2173: 'CHECKOUTTOKEN&'.
2174: $tuname.'&'.
2175: $tudom.'&'.
2176: $tcrsid.'&'.
2177: $symb.'&'.
2178: $now.'&'.$ENV{'REMOTE_ADDR'});
2179: my $token=&reply('tmpput:'.$infostr,$lonhost);
2180: if ($token=~/^error\:/) {
2181: &logthis("<font color=\"blue\">WARNING: ".
2182: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2183: "</font>");
2184: return '';
2185: }
2186:
2187: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2188: $token=~tr/a-z/A-Z/;
2189:
2190: my %infohash=('resource.0.outtoken' => $token,
2191: 'resource.0.checkouttime' => $now,
2192: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2193:
2194: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2195: return '';
2196: } else {
2197: &logthis("<font color=\"blue\">WARNING: ".
2198: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2199: "</font>");
2200: }
2201:
2202: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2203: &escape('Checkout '.$infostr.' - '.
2204: $token)) ne 'ok') {
2205: return '';
2206: } else {
2207: &logthis("<font color=\"blue\">WARNING: ".
2208: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2209: "</font>");
2210: }
2211: return $token;
2212: }
2213:
2214: # ------------------------------------------------------------ Check in an item
2215:
2216: sub checkin {
2217: my $token=shift;
2218: my $now=time;
2219: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2220: $lonhost=~tr/A-Z/a-z/;
2221: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2222: $dtoken=~s/\W/\_/g;
2223: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2224: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2225:
2226: unless (($tuname) && ($tudom)) {
2227: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2228: return '';
2229: }
2230:
2231: unless (&allowed('mgr',$tcrsid)) {
2232: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2233: $env{'user.name'}.' - '.$env{'user.domain'});
2234: return '';
2235: }
2236:
2237: my %infohash=('resource.0.intoken' => $token,
2238: 'resource.0.checkintime' => $now,
2239: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2240:
2241: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2242: return '';
2243: }
2244:
2245: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2246: &escape('Checkin - '.$token)) ne 'ok') {
2247: return '';
2248: }
2249:
2250: return ($symb,$tuname,$tudom,$tcrsid);
2251: }
2252:
2253: # --------------------------------------------- Set Expire Date for Spreadsheet
2254:
2255: sub expirespread {
2256: my ($uname,$udom,$stype,$usymb)=@_;
2257: my $cid=$env{'request.course.id'};
2258: if ($cid) {
2259: my $now=time;
2260: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2261: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2262: $env{'course.'.$cid.'.num'}.
2263: ':nohist_expirationdates:'.
2264: &escape($key).'='.$now,
2265: $env{'course.'.$cid.'.home'})
2266: }
2267: return 'ok';
2268: }
2269:
2270: # ----------------------------------------------------- Devalidate Spreadsheets
2271:
2272: sub devalidate {
2273: my ($symb,$uname,$udom)=@_;
2274: my $cid=$env{'request.course.id'};
2275: if ($cid) {
2276: # delete the stored spreadsheets for
2277: # - the student level sheet of this user in course's homespace
2278: # - the assessment level sheet for this resource
2279: # for this user in user's homespace
2280: # - current conditional state info
2281: my $key=$uname.':'.$udom.':';
2282: my $status=
2283: &del('nohist_calculatedsheets',
2284: [$key.'studentcalc:'],
2285: $env{'course.'.$cid.'.domain'},
2286: $env{'course.'.$cid.'.num'})
2287: .' '.
2288: &del('nohist_calculatedsheets_'.$cid,
2289: [$key.'assesscalc:'.$symb],$udom,$uname);
2290: unless ($status eq 'ok ok') {
2291: &logthis('Could not devalidate spreadsheet '.
2292: $uname.' at '.$udom.' for '.
2293: $symb.': '.$status);
2294: }
2295: &delenv('user.state.'.$cid);
2296: }
2297: }
2298:
2299: sub get_scalar {
2300: my ($string,$end) = @_;
2301: my $value;
2302: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2303: $value = $1;
2304: } elsif ($$string =~ s/^([^&]*?)&//) {
2305: $value = $1;
2306: }
2307: return &unescape($value);
2308: }
2309:
2310: sub array2str {
2311: my (@array) = @_;
2312: my $result=&arrayref2str(\@array);
2313: $result=~s/^__ARRAY_REF__//;
2314: $result=~s/__END_ARRAY_REF__$//;
2315: return $result;
2316: }
2317:
2318: sub arrayref2str {
2319: my ($arrayref) = @_;
2320: my $result='__ARRAY_REF__';
2321: foreach my $elem (@$arrayref) {
2322: if(ref($elem) eq 'ARRAY') {
2323: $result.=&arrayref2str($elem).'&';
2324: } elsif(ref($elem) eq 'HASH') {
2325: $result.=&hashref2str($elem).'&';
2326: } elsif(ref($elem)) {
2327: #print("Got a ref of ".(ref($elem))." skipping.");
2328: } else {
2329: $result.=&escape($elem).'&';
2330: }
2331: }
2332: $result=~s/\&$//;
2333: $result .= '__END_ARRAY_REF__';
2334: return $result;
2335: }
2336:
2337: sub hash2str {
2338: my (%hash) = @_;
2339: my $result=&hashref2str(\%hash);
2340: $result=~s/^__HASH_REF__//;
2341: $result=~s/__END_HASH_REF__$//;
2342: return $result;
2343: }
2344:
2345: sub hashref2str {
2346: my ($hashref)=@_;
2347: my $result='__HASH_REF__';
2348: foreach my $key (sort(keys(%$hashref))) {
2349: if (ref($key) eq 'ARRAY') {
2350: $result.=&arrayref2str($key).'=';
2351: } elsif (ref($key) eq 'HASH') {
2352: $result.=&hashref2str($key).'=';
2353: } elsif (ref($key)) {
2354: $result.='=';
2355: #print("Got a ref of ".(ref($key))." skipping.");
2356: } else {
2357: if ($key) {$result.=&escape($key).'=';} else { last; }
2358: }
2359:
2360: if(ref($hashref->{$key}) eq 'ARRAY') {
2361: $result.=&arrayref2str($hashref->{$key}).'&';
2362: } elsif(ref($hashref->{$key}) eq 'HASH') {
2363: $result.=&hashref2str($hashref->{$key}).'&';
2364: } elsif(ref($hashref->{$key})) {
2365: $result.='&';
2366: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
2367: } else {
2368: $result.=&escape($hashref->{$key}).'&';
2369: }
2370: }
2371: $result=~s/\&$//;
2372: $result .= '__END_HASH_REF__';
2373: return $result;
2374: }
2375:
2376: sub str2hash {
2377: my ($string)=@_;
2378: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2379: return %$hash;
2380: }
2381:
2382: sub str2hashref {
2383: my ($string) = @_;
2384:
2385: my %hash;
2386:
2387: if($string !~ /^__HASH_REF__/) {
2388: if (! ($string eq '' || !defined($string))) {
2389: $hash{'error'}='Not hash reference';
2390: }
2391: return (\%hash, $string);
2392: }
2393:
2394: $string =~ s/^__HASH_REF__//;
2395:
2396: while($string !~ /^__END_HASH_REF__/) {
2397: #key
2398: my $key='';
2399: if($string =~ /^__HASH_REF__/) {
2400: ($key, $string)=&str2hashref($string);
2401: if(defined($key->{'error'})) {
2402: $hash{'error'}='Bad data';
2403: return (\%hash, $string);
2404: }
2405: } elsif($string =~ /^__ARRAY_REF__/) {
2406: ($key, $string)=&str2arrayref($string);
2407: if($key->[0] eq 'Array reference error') {
2408: $hash{'error'}='Bad data';
2409: return (\%hash, $string);
2410: }
2411: } else {
2412: $string =~ s/^(.*?)=//;
2413: $key=&unescape($1);
2414: }
2415: $string =~ s/^=//;
2416:
2417: #value
2418: my $value='';
2419: if($string =~ /^__HASH_REF__/) {
2420: ($value, $string)=&str2hashref($string);
2421: if(defined($value->{'error'})) {
2422: $hash{'error'}='Bad data';
2423: return (\%hash, $string);
2424: }
2425: } elsif($string =~ /^__ARRAY_REF__/) {
2426: ($value, $string)=&str2arrayref($string);
2427: if($value->[0] eq 'Array reference error') {
2428: $hash{'error'}='Bad data';
2429: return (\%hash, $string);
2430: }
2431: } else {
2432: $value=&get_scalar(\$string,'__END_HASH_REF__');
2433: }
2434: $string =~ s/^&//;
2435:
2436: $hash{$key}=$value;
2437: }
2438:
2439: $string =~ s/^__END_HASH_REF__//;
2440:
2441: return (\%hash, $string);
2442: }
2443:
2444: sub str2array {
2445: my ($string)=@_;
2446: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2447: return @$array;
2448: }
2449:
2450: sub str2arrayref {
2451: my ($string) = @_;
2452: my @array;
2453:
2454: if($string !~ /^__ARRAY_REF__/) {
2455: if (! ($string eq '' || !defined($string))) {
2456: $array[0]='Array reference error';
2457: }
2458: return (\@array, $string);
2459: }
2460:
2461: $string =~ s/^__ARRAY_REF__//;
2462:
2463: while($string !~ /^__END_ARRAY_REF__/) {
2464: my $value='';
2465: if($string =~ /^__HASH_REF__/) {
2466: ($value, $string)=&str2hashref($string);
2467: if(defined($value->{'error'})) {
2468: $array[0] ='Array reference error';
2469: return (\@array, $string);
2470: }
2471: } elsif($string =~ /^__ARRAY_REF__/) {
2472: ($value, $string)=&str2arrayref($string);
2473: if($value->[0] eq 'Array reference error') {
2474: $array[0] ='Array reference error';
2475: return (\@array, $string);
2476: }
2477: } else {
2478: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2479: }
2480: $string =~ s/^&//;
2481:
2482: push(@array, $value);
2483: }
2484:
2485: $string =~ s/^__END_ARRAY_REF__//;
2486:
2487: return (\@array, $string);
2488: }
2489:
2490: # -------------------------------------------------------------------Temp Store
2491:
2492: sub tmpreset {
2493: my ($symb,$namespace,$domain,$stuname) = @_;
2494: if (!$symb) {
2495: $symb=&symbread();
2496: if (!$symb) { $symb= $env{'request.url'}; }
2497: }
2498: $symb=escape($symb);
2499:
2500: if (!$namespace) { $namespace=$env{'request.state'}; }
2501: $namespace=~s/\//\_/g;
2502: $namespace=~s/\W//g;
2503:
2504: if (!$domain) { $domain=$env{'user.domain'}; }
2505: if (!$stuname) { $stuname=$env{'user.name'}; }
2506: if ($domain eq 'public' && $stuname eq 'public') {
2507: $stuname=$ENV{'REMOTE_ADDR'};
2508: }
2509: my $path=$perlvar{'lonDaemons'}.'/tmp';
2510: my %hash;
2511: if (tie(%hash,'GDBM_File',
2512: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2513: &GDBM_WRCREAT(),0640)) {
2514: foreach my $key (keys %hash) {
2515: if ($key=~ /:$symb/) {
2516: delete($hash{$key});
2517: }
2518: }
2519: }
2520: }
2521:
2522: sub tmpstore {
2523: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2524:
2525: if (!$symb) {
2526: $symb=&symbread();
2527: if (!$symb) { $symb= $env{'request.url'}; }
2528: }
2529: $symb=escape($symb);
2530:
2531: if (!$namespace) {
2532: # I don't think we would ever want to store this for a course.
2533: # it seems this will only be used if we don't have a course.
2534: #$namespace=$env{'request.course.id'};
2535: #if (!$namespace) {
2536: $namespace=$env{'request.state'};
2537: #}
2538: }
2539: $namespace=~s/\//\_/g;
2540: $namespace=~s/\W//g;
2541: if (!$domain) { $domain=$env{'user.domain'}; }
2542: if (!$stuname) { $stuname=$env{'user.name'}; }
2543: if ($domain eq 'public' && $stuname eq 'public') {
2544: $stuname=$ENV{'REMOTE_ADDR'};
2545: }
2546: my $now=time;
2547: my %hash;
2548: my $path=$perlvar{'lonDaemons'}.'/tmp';
2549: if (tie(%hash,'GDBM_File',
2550: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2551: &GDBM_WRCREAT(),0640)) {
2552: $hash{"version:$symb"}++;
2553: my $version=$hash{"version:$symb"};
2554: my $allkeys='';
2555: foreach my $key (keys(%$storehash)) {
2556: $allkeys.=$key.':';
2557: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2558: }
2559: $hash{"$version:$symb:timestamp"}=$now;
2560: $allkeys.='timestamp';
2561: $hash{"$version:keys:$symb"}=$allkeys;
2562: if (untie(%hash)) {
2563: return 'ok';
2564: } else {
2565: return "error:$!";
2566: }
2567: } else {
2568: return "error:$!";
2569: }
2570: }
2571:
2572: # -----------------------------------------------------------------Temp Restore
2573:
2574: sub tmprestore {
2575: my ($symb,$namespace,$domain,$stuname) = @_;
2576:
2577: if (!$symb) {
2578: $symb=&symbread();
2579: if (!$symb) { $symb= $env{'request.url'}; }
2580: }
2581: $symb=escape($symb);
2582:
2583: if (!$namespace) { $namespace=$env{'request.state'}; }
2584:
2585: if (!$domain) { $domain=$env{'user.domain'}; }
2586: if (!$stuname) { $stuname=$env{'user.name'}; }
2587: if ($domain eq 'public' && $stuname eq 'public') {
2588: $stuname=$ENV{'REMOTE_ADDR'};
2589: }
2590: my %returnhash;
2591: $namespace=~s/\//\_/g;
2592: $namespace=~s/\W//g;
2593: my %hash;
2594: my $path=$perlvar{'lonDaemons'}.'/tmp';
2595: if (tie(%hash,'GDBM_File',
2596: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2597: &GDBM_READER(),0640)) {
2598: my $version=$hash{"version:$symb"};
2599: $returnhash{'version'}=$version;
2600: my $scope;
2601: for ($scope=1;$scope<=$version;$scope++) {
2602: my $vkeys=$hash{"$scope:keys:$symb"};
2603: my @keys=split(/:/,$vkeys);
2604: my $key;
2605: $returnhash{"$scope:keys"}=$vkeys;
2606: foreach $key (@keys) {
2607: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2608: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2609: }
2610: }
2611: if (!(untie(%hash))) {
2612: return "error:$!";
2613: }
2614: } else {
2615: return "error:$!";
2616: }
2617: return %returnhash;
2618: }
2619:
2620: # ----------------------------------------------------------------------- Store
2621:
2622: sub store {
2623: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2624: my $home='';
2625:
2626: if ($stuname) { $home=&homeserver($stuname,$domain); }
2627:
2628: $symb=&symbclean($symb);
2629: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2630:
2631: if (!$domain) { $domain=$env{'user.domain'}; }
2632: if (!$stuname) { $stuname=$env{'user.name'}; }
2633:
2634: &devalidate($symb,$stuname,$domain);
2635:
2636: $symb=escape($symb);
2637: if (!$namespace) {
2638: unless ($namespace=$env{'request.course.id'}) {
2639: return '';
2640: }
2641: }
2642: if (!$home) { $home=$env{'user.home'}; }
2643:
2644: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2645: $$storehash{'host'}=$perlvar{'lonHostID'};
2646:
2647: my $namevalue='';
2648: foreach my $key (keys(%$storehash)) {
2649: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2650: }
2651: $namevalue=~s/\&$//;
2652: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2653: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2654: }
2655:
2656: # -------------------------------------------------------------- Critical Store
2657:
2658: sub cstore {
2659: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2660: my $home='';
2661:
2662: if ($stuname) { $home=&homeserver($stuname,$domain); }
2663:
2664: $symb=&symbclean($symb);
2665: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2666:
2667: if (!$domain) { $domain=$env{'user.domain'}; }
2668: if (!$stuname) { $stuname=$env{'user.name'}; }
2669:
2670: &devalidate($symb,$stuname,$domain);
2671:
2672: $symb=escape($symb);
2673: if (!$namespace) {
2674: unless ($namespace=$env{'request.course.id'}) {
2675: return '';
2676: }
2677: }
2678: if (!$home) { $home=$env{'user.home'}; }
2679:
2680: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2681: $$storehash{'host'}=$perlvar{'lonHostID'};
2682:
2683: my $namevalue='';
2684: foreach my $key (keys(%$storehash)) {
2685: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2686: }
2687: $namevalue=~s/\&$//;
2688: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2689: return critical
2690: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2691: }
2692:
2693: # --------------------------------------------------------------------- Restore
2694:
2695: sub restore {
2696: my ($symb,$namespace,$domain,$stuname) = @_;
2697: my $home='';
2698:
2699: if ($stuname) { $home=&homeserver($stuname,$domain); }
2700:
2701: if (!$symb) {
2702: unless ($symb=escape(&symbread())) { return ''; }
2703: } else {
2704: $symb=&escape(&symbclean($symb));
2705: }
2706: if (!$namespace) {
2707: unless ($namespace=$env{'request.course.id'}) {
2708: return '';
2709: }
2710: }
2711: if (!$domain) { $domain=$env{'user.domain'}; }
2712: if (!$stuname) { $stuname=$env{'user.name'}; }
2713: if (!$home) { $home=$env{'user.home'}; }
2714: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2715:
2716: my %returnhash=();
2717: foreach my $line (split(/\&/,$answer)) {
2718: my ($name,$value)=split(/\=/,$line);
2719: $returnhash{&unescape($name)}=&thaw_unescape($value);
2720: }
2721: my $version;
2722: for ($version=1;$version<=$returnhash{'version'};$version++) {
2723: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
2724: $returnhash{$item}=$returnhash{$version.':'.$item};
2725: }
2726: }
2727: return %returnhash;
2728: }
2729:
2730: # ---------------------------------------------------------- Course Description
2731:
2732: sub coursedescription {
2733: my ($courseid,$args)=@_;
2734: $courseid=~s/^\///;
2735: $courseid=~s/\_/\//g;
2736: my ($cdomain,$cnum)=split(/\//,$courseid);
2737: my $chome=&homeserver($cnum,$cdomain);
2738: my $normalid=$cdomain.'_'.$cnum;
2739: # need to always cache even if we get errors otherwise we keep
2740: # trying and trying and trying to get the course description.
2741: my %envhash=();
2742: my %returnhash=();
2743:
2744: my $expiretime=600;
2745: if ($env{'request.course.id'} eq $normalid) {
2746: $expiretime=120;
2747: }
2748:
2749: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2750: if (!$args->{'freshen_cache'}
2751: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2752: foreach my $key (keys(%env)) {
2753: next if ($key !~ /^\Q$prefix\E(.*)/);
2754: my ($setting) = $1;
2755: $returnhash{$setting} = $env{$key};
2756: }
2757: return %returnhash;
2758: }
2759:
2760: # get the data agin
2761: if (!$args->{'one_time'}) {
2762: $envhash{'course.'.$normalid.'.last_cache'}=time;
2763: }
2764:
2765: if ($chome ne 'no_host') {
2766: %returnhash=&dump('environment',$cdomain,$cnum);
2767: if (!exists($returnhash{'con_lost'})) {
2768: $returnhash{'home'}= $chome;
2769: $returnhash{'domain'} = $cdomain;
2770: $returnhash{'num'} = $cnum;
2771: if (!defined($returnhash{'type'})) {
2772: $returnhash{'type'} = 'Course';
2773: }
2774: while (my ($name,$value) = each %returnhash) {
2775: $envhash{'course.'.$normalid.'.'.$name}=$value;
2776: }
2777: $returnhash{'url'}=&clutter($returnhash{'url'});
2778: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2779: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2780: $envhash{'course.'.$normalid.'.home'}=$chome;
2781: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2782: $envhash{'course.'.$normalid.'.num'}=$cnum;
2783: }
2784: }
2785: if (!$args->{'one_time'}) {
2786: &appenv(%envhash);
2787: }
2788: return %returnhash;
2789: }
2790:
2791: # -------------------------------------------------See if a user is privileged
2792:
2793: sub privileged {
2794: my ($username,$domain)=@_;
2795: my $rolesdump=&reply("dump:$domain:$username:roles",
2796: &homeserver($username,$domain));
2797: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2798: my $now=time;
2799: if ($rolesdump ne '') {
2800: foreach my $entry (split(/&/,$rolesdump)) {
2801: if ($entry!~/^rolesdef_/) {
2802: my ($area,$role)=split(/=/,$entry);
2803: $area=~s/\_\w\w$//;
2804: my ($trole,$tend,$tstart)=split(/_/,$role);
2805: if (($trole eq 'dc') || ($trole eq 'su')) {
2806: my $active=1;
2807: if ($tend) {
2808: if ($tend<$now) { $active=0; }
2809: }
2810: if ($tstart) {
2811: if ($tstart>$now) { $active=0; }
2812: }
2813: if ($active) { return 1; }
2814: }
2815: }
2816: }
2817: }
2818: return 0;
2819: }
2820:
2821: # -------------------------------------------------------- Get user privileges
2822:
2823: sub rolesinit {
2824: my ($domain,$username,$authhost)=@_;
2825: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2826: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2827: my %allroles=();
2828: my %allgroups=();
2829: my $now=time;
2830: my %userroles = ('user.login.time' => $now);
2831: my $group_privs;
2832:
2833: if ($rolesdump ne '') {
2834: foreach my $entry (split(/&/,$rolesdump)) {
2835: if ($entry!~/^rolesdef_/) {
2836: my ($area,$role)=split(/=/,$entry);
2837: $area=~s/\_\w\w$//;
2838: my ($trole,$tend,$tstart,$group_privs);
2839: if ($role=~/^cr/) {
2840: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
2841: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
2842: ($tend,$tstart)=split('_',$trest);
2843: } else {
2844: $trole=$role;
2845: }
2846: } elsif ($role =~ m|^gr/|) {
2847: ($trole,$tend,$tstart) = split(/_/,$role);
2848: ($trole,$group_privs) = split(/\//,$trole);
2849: $group_privs = &unescape($group_privs);
2850: } else {
2851: ($trole,$tend,$tstart)=split(/_/,$role);
2852: }
2853: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2854: $username);
2855: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2856: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2857: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2858: if (($area ne '') && ($trole ne '')) {
2859: my $spec=$trole.'.'.$area;
2860: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2861: if ($trole =~ /^cr\//) {
2862: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2863: } elsif ($trole eq 'gr') {
2864: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2865: } else {
2866: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2867: }
2868: }
2869: }
2870: }
2871: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2872: $userroles{'user.adv'} = $adv;
2873: $userroles{'user.author'} = $author;
2874: $env{'user.adv'}=$adv;
2875: }
2876: return \%userroles;
2877: }
2878:
2879: sub set_arearole {
2880: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2881: # log the associated role with the area
2882: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2883: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2884: }
2885:
2886: sub custom_roleprivs {
2887: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2888: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2889: my $homsvr=homeserver($rauthor,$rdomain);
2890: if ($hostname{$homsvr} ne '') {
2891: my ($rdummy,$roledef)=
2892: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2893: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2894: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2895: if (defined($syspriv)) {
2896: $$allroles{'cm./'}.=':'.$syspriv;
2897: $$allroles{$spec.'./'}.=':'.$syspriv;
2898: }
2899: if ($tdomain ne '') {
2900: if (defined($dompriv)) {
2901: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2902: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2903: }
2904: if (($trest ne '') && (defined($coursepriv))) {
2905: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2906: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2907: }
2908: }
2909: }
2910: }
2911: }
2912:
2913: sub group_roleprivs {
2914: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2915: my $access = 1;
2916: my $now = time;
2917: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2918: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2919: if ($access) {
2920: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
2921: $$allgroups{$course}{$group} .=':'.$group_privs;
2922: }
2923: }
2924:
2925: sub standard_roleprivs {
2926: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2927: if (defined($pr{$trole.':s'})) {
2928: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2929: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2930: }
2931: if ($tdomain ne '') {
2932: if (defined($pr{$trole.':d'})) {
2933: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2934: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2935: }
2936: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2937: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2938: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2939: }
2940: }
2941: }
2942:
2943: sub set_userprivs {
2944: my ($userroles,$allroles,$allgroups) = @_;
2945: my $author=0;
2946: my $adv=0;
2947: my %grouproles = ();
2948: if (keys(%{$allgroups}) > 0) {
2949: foreach my $role (keys %{$allroles}) {
2950: my ($trole,$area,$sec,$extendedarea);
2951: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)-) {
2952: $trole = $1;
2953: $area = $2;
2954: $sec = $3;
2955: $extendedarea = $area.$sec;
2956: if (exists($$allgroups{$area})) {
2957: foreach my $group (keys(%{$$allgroups{$area}})) {
2958: my $spec = $trole.'.'.$extendedarea;
2959: $grouproles{$spec.'.'.$area.'/'.$group} =
2960: $$allgroups{$area}{$group};
2961: }
2962: }
2963: }
2964: }
2965: }
2966: foreach my $group (keys(%grouproles)) {
2967: $$allroles{$group} = $grouproles{$group};
2968: }
2969: foreach my $role (keys(%{$allroles})) {
2970: my %thesepriv;
2971: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
2972: foreach my $item (split(/:/,$$allroles{$role})) {
2973: if ($item ne '') {
2974: my ($privilege,$restrictions)=split(/&/,$item);
2975: if ($restrictions eq '') {
2976: $thesepriv{$privilege}='F';
2977: } elsif ($thesepriv{$privilege} ne 'F') {
2978: $thesepriv{$privilege}.=$restrictions;
2979: }
2980: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2981: }
2982: }
2983: my $thesestr='';
2984: foreach my $priv (keys(%thesepriv)) {
2985: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
2986: }
2987: $userroles->{'user.priv.'.$role} = $thesestr;
2988: }
2989: return ($author,$adv);
2990: }
2991:
2992: # --------------------------------------------------------------- get interface
2993:
2994: sub get {
2995: my ($namespace,$storearr,$udomain,$uname)=@_;
2996: my $items='';
2997: foreach my $item (@$storearr) {
2998: $items.=&escape($item).'&';
2999: }
3000: $items=~s/\&$//;
3001: if (!$udomain) { $udomain=$env{'user.domain'}; }
3002: if (!$uname) { $uname=$env{'user.name'}; }
3003: my $uhome=&homeserver($uname,$udomain);
3004:
3005: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
3006: my @pairs=split(/\&/,$rep);
3007: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3008: return @pairs;
3009: }
3010: my %returnhash=();
3011: my $i=0;
3012: foreach my $item (@$storearr) {
3013: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3014: $i++;
3015: }
3016: return %returnhash;
3017: }
3018:
3019: # --------------------------------------------------------------- del interface
3020:
3021: sub del {
3022: my ($namespace,$storearr,$udomain,$uname)=@_;
3023: my $items='';
3024: foreach my $item (@$storearr) {
3025: $items.=&escape($item).'&';
3026: }
3027: $items=~s/\&$//;
3028: if (!$udomain) { $udomain=$env{'user.domain'}; }
3029: if (!$uname) { $uname=$env{'user.name'}; }
3030: my $uhome=&homeserver($uname,$udomain);
3031:
3032: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3033: }
3034:
3035: # -------------------------------------------------------------- dump interface
3036:
3037: sub dump {
3038: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3039: if (!$udomain) { $udomain=$env{'user.domain'}; }
3040: if (!$uname) { $uname=$env{'user.name'}; }
3041: my $uhome=&homeserver($uname,$udomain);
3042: if ($regexp) {
3043: $regexp=&escape($regexp);
3044: } else {
3045: $regexp='.';
3046: }
3047: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3048: my @pairs=split(/\&/,$rep);
3049: my %returnhash=();
3050: foreach my $item (@pairs) {
3051: my ($key,$value)=split(/=/,$item,2);
3052: $key = &unescape($key);
3053: next if ($key =~ /^error: 2 /);
3054: $returnhash{$key}=&thaw_unescape($value);
3055: }
3056: return %returnhash;
3057: }
3058:
3059: # --------------------------------------------------------- dumpstore interface
3060:
3061: sub dumpstore {
3062: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3063: if (!$udomain) { $udomain=$env{'user.domain'}; }
3064: if (!$uname) { $uname=$env{'user.name'}; }
3065: my $uhome=&homeserver($uname,$udomain);
3066: if ($regexp) {
3067: $regexp=&escape($regexp);
3068: } else {
3069: $regexp='.';
3070: }
3071: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3072: my @pairs=split(/\&/,$rep);
3073: my %returnhash=();
3074: foreach my $item (@pairs) {
3075: my ($key,$value)=split(/=/,$item,2);
3076: next if ($key =~ /^error: 2 /);
3077: $returnhash{$key}=&thaw_unescape($value);
3078: }
3079: return %returnhash;
3080: }
3081:
3082: # -------------------------------------------------------------- keys interface
3083:
3084: sub getkeys {
3085: my ($namespace,$udomain,$uname)=@_;
3086: if (!$udomain) { $udomain=$env{'user.domain'}; }
3087: if (!$uname) { $uname=$env{'user.name'}; }
3088: my $uhome=&homeserver($uname,$udomain);
3089: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3090: my @keyarray=();
3091: foreach my $key (split(/\&/,$rep)) {
3092: next if ($key =~ /^error: 2 /);
3093: push(@keyarray,&unescape($key));
3094: }
3095: return @keyarray;
3096: }
3097:
3098: # --------------------------------------------------------------- currentdump
3099: sub currentdump {
3100: my ($courseid,$sdom,$sname)=@_;
3101: $courseid = $env{'request.course.id'} if (! defined($courseid));
3102: $sdom = $env{'user.domain'} if (! defined($sdom));
3103: $sname = $env{'user.name'} if (! defined($sname));
3104: my $uhome = &homeserver($sname,$sdom);
3105: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3106: return if ($rep =~ /^(error:|no_such_host)/);
3107: #
3108: my %returnhash=();
3109: #
3110: if ($rep eq "unknown_cmd") {
3111: # an old lond will not know currentdump
3112: # Do a dump and make it look like a currentdump
3113: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
3114: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3115: my %hash = @tmp;
3116: @tmp=();
3117: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3118: } else {
3119: my @pairs=split(/\&/,$rep);
3120: foreach my $pair (@pairs) {
3121: my ($key,$value)=split(/=/,$pair,2);
3122: my ($symb,$param) = split(/:/,$key);
3123: $returnhash{&unescape($symb)}->{&unescape($param)} =
3124: &thaw_unescape($value);
3125: }
3126: }
3127: return %returnhash;
3128: }
3129:
3130: sub convert_dump_to_currentdump{
3131: my %hash = %{shift()};
3132: my %returnhash;
3133: # Code ripped from lond, essentially. The only difference
3134: # here is the unescaping done by lonnet::dump(). Conceivably
3135: # we might run in to problems with parameter names =~ /^v\./
3136: while (my ($key,$value) = each(%hash)) {
3137: my ($v,$symb,$param) = split(/:/,$key);
3138: $symb = &unescape($symb);
3139: $param = &unescape($param);
3140: next if ($v eq 'version' || $symb eq 'keys');
3141: next if (exists($returnhash{$symb}) &&
3142: exists($returnhash{$symb}->{$param}) &&
3143: $returnhash{$symb}->{'v.'.$param} > $v);
3144: $returnhash{$symb}->{$param}=$value;
3145: $returnhash{$symb}->{'v.'.$param}=$v;
3146: }
3147: #
3148: # Remove all of the keys in the hashes which keep track of
3149: # the version of the parameter.
3150: while (my ($symb,$param_hash) = each(%returnhash)) {
3151: # use a foreach because we are going to delete from the hash.
3152: foreach my $key (keys(%$param_hash)) {
3153: delete($param_hash->{$key}) if ($key =~ /^v\./);
3154: }
3155: }
3156: return \%returnhash;
3157: }
3158:
3159: # ------------------------------------------------------ critical inc interface
3160:
3161: sub cinc {
3162: return &inc(@_,'critical');
3163: }
3164:
3165: # --------------------------------------------------------------- inc interface
3166:
3167: sub inc {
3168: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3169: if (!$udomain) { $udomain=$env{'user.domain'}; }
3170: if (!$uname) { $uname=$env{'user.name'}; }
3171: my $uhome=&homeserver($uname,$udomain);
3172: my $items='';
3173: if (! ref($store)) {
3174: # got a single value, so use that instead
3175: $items = &escape($store).'=&';
3176: } elsif (ref($store) eq 'SCALAR') {
3177: $items = &escape($$store).'=&';
3178: } elsif (ref($store) eq 'ARRAY') {
3179: $items = join('=&',map {&escape($_);} @{$store});
3180: } elsif (ref($store) eq 'HASH') {
3181: while (my($key,$value) = each(%{$store})) {
3182: $items.= &escape($key).'='.&escape($value).'&';
3183: }
3184: }
3185: $items=~s/\&$//;
3186: if ($critical) {
3187: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3188: } else {
3189: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3190: }
3191: }
3192:
3193: # --------------------------------------------------------------- put interface
3194:
3195: sub put {
3196: my ($namespace,$storehash,$udomain,$uname)=@_;
3197: if (!$udomain) { $udomain=$env{'user.domain'}; }
3198: if (!$uname) { $uname=$env{'user.name'}; }
3199: my $uhome=&homeserver($uname,$udomain);
3200: my $items='';
3201: foreach my $item (keys(%$storehash)) {
3202: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3203: }
3204: $items=~s/\&$//;
3205: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3206: }
3207:
3208: # ------------------------------------------------------------ newput interface
3209:
3210: sub newput {
3211: my ($namespace,$storehash,$udomain,$uname)=@_;
3212: if (!$udomain) { $udomain=$env{'user.domain'}; }
3213: if (!$uname) { $uname=$env{'user.name'}; }
3214: my $uhome=&homeserver($uname,$udomain);
3215: my $items='';
3216: foreach my $key (keys(%$storehash)) {
3217: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3218: }
3219: $items=~s/\&$//;
3220: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3221: }
3222:
3223: # --------------------------------------------------------- putstore interface
3224:
3225: sub putstore {
3226: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3227: if (!$udomain) { $udomain=$env{'user.domain'}; }
3228: if (!$uname) { $uname=$env{'user.name'}; }
3229: my $uhome=&homeserver($uname,$udomain);
3230: my $items='';
3231: foreach my $key (keys(%$storehash)) {
3232: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3233: }
3234: $items=~s/\&$//;
3235: my $esc_symb=&escape($symb);
3236: my $esc_v=&escape($version);
3237: my $reply =
3238: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3239: $uhome);
3240: if ($reply eq 'unknown_cmd') {
3241: # gfall back to way things use to be done
3242: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3243: $uname);
3244: }
3245: return $reply;
3246: }
3247:
3248: sub old_putstore {
3249: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3250: if (!$udomain) { $udomain=$env{'user.domain'}; }
3251: if (!$uname) { $uname=$env{'user.name'}; }
3252: my $uhome=&homeserver($uname,$udomain);
3253: my %newstorehash;
3254: foreach my $item (keys(%$storehash)) {
3255: my $key = $version.':'.&escape($symb).':'.$item;
3256: $newstorehash{$key} = $storehash->{$item};
3257: }
3258: my $items='';
3259: my %allitems = ();
3260: foreach my $item (keys(%newstorehash)) {
3261: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3262: my $key = $1.':keys:'.$2;
3263: $allitems{$key} .= $3.':';
3264: }
3265: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3266: }
3267: foreach my $item (keys(%allitems)) {
3268: $allitems{$item} =~ s/\:$//;
3269: $items.= $item.'='.$allitems{$item}.'&';
3270: }
3271: $items=~s/\&$//;
3272: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3273: }
3274:
3275: # ------------------------------------------------------ critical put interface
3276:
3277: sub cput {
3278: my ($namespace,$storehash,$udomain,$uname)=@_;
3279: if (!$udomain) { $udomain=$env{'user.domain'}; }
3280: if (!$uname) { $uname=$env{'user.name'}; }
3281: my $uhome=&homeserver($uname,$udomain);
3282: my $items='';
3283: foreach my $item (keys(%$storehash)) {
3284: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3285: }
3286: $items=~s/\&$//;
3287: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3288: }
3289:
3290: # -------------------------------------------------------------- eget interface
3291:
3292: sub eget {
3293: my ($namespace,$storearr,$udomain,$uname)=@_;
3294: my $items='';
3295: foreach my $item (@$storearr) {
3296: $items.=&escape($item).'&';
3297: }
3298: $items=~s/\&$//;
3299: if (!$udomain) { $udomain=$env{'user.domain'}; }
3300: if (!$uname) { $uname=$env{'user.name'}; }
3301: my $uhome=&homeserver($uname,$udomain);
3302: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3303: my @pairs=split(/\&/,$rep);
3304: my %returnhash=();
3305: my $i=0;
3306: foreach my $item (@$storearr) {
3307: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3308: $i++;
3309: }
3310: return %returnhash;
3311: }
3312:
3313: # ------------------------------------------------------------ tmpput interface
3314: sub tmpput {
3315: my ($storehash,$server,$context)=@_;
3316: my $items='';
3317: foreach my $item (keys(%$storehash)) {
3318: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3319: }
3320: $items=~s/\&$//;
3321: if (defined($context)) {
3322: $items .= ':'.&escape($context);
3323: }
3324: return &reply("tmpput:$items",$server);
3325: }
3326:
3327: # ------------------------------------------------------------ tmpget interface
3328: sub tmpget {
3329: my ($token,$server)=@_;
3330: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3331: my $rep=&reply("tmpget:$token",$server);
3332: my %returnhash;
3333: foreach my $item (split(/\&/,$rep)) {
3334: my ($key,$value)=split(/=/,$item);
3335: $returnhash{&unescape($key)}=&thaw_unescape($value);
3336: }
3337: return %returnhash;
3338: }
3339:
3340: # ------------------------------------------------------------ tmpget interface
3341: sub tmpdel {
3342: my ($token,$server)=@_;
3343: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3344: return &reply("tmpdel:$token",$server);
3345: }
3346:
3347: # -------------------------------------------------- portfolio access checking
3348:
3349: sub portfolio_access {
3350: my ($requrl) = @_;
3351: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3352: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3353: if ($result) {
3354: my %setters;
3355: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3356: my ($startblock,$endblock) =
3357: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
3358: if ($startblock && $endblock) {
3359: return 'B';
3360: }
3361: } else {
3362: my ($startblock,$endblock) =
3363: &Apache::loncommon::blockcheck(\%setters,'port');
3364: if ($startblock && $endblock) {
3365: return 'B';
3366: }
3367: }
3368: }
3369: if ($result eq 'ok') {
3370: return 'F';
3371: } elsif ($result =~ /^[^:]+:guest_/) {
3372: return 'A';
3373: }
3374: return '';
3375: }
3376:
3377: sub get_portfolio_access {
3378: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3379:
3380: if (!ref($access_hash)) {
3381: my $current_perms = &get_portfile_permissions($udom,$unum);
3382: my %access_controls = &get_access_controls($current_perms,$group,
3383: $file_name);
3384: $access_hash = $access_controls{$file_name};
3385: }
3386:
3387: my ($public,$guest,@domains,@users,@courses,@groups);
3388: my $now = time;
3389: if (ref($access_hash) eq 'HASH') {
3390: foreach my $key (keys(%{$access_hash})) {
3391: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3392: if ($start > $now) {
3393: next;
3394: }
3395: if ($end && $end<$now) {
3396: next;
3397: }
3398: if ($scope eq 'public') {
3399: $public = $key;
3400: last;
3401: } elsif ($scope eq 'guest') {
3402: $guest = $key;
3403: } elsif ($scope eq 'domains') {
3404: push(@domains,$key);
3405: } elsif ($scope eq 'users') {
3406: push(@users,$key);
3407: } elsif ($scope eq 'course') {
3408: push(@courses,$key);
3409: } elsif ($scope eq 'group') {
3410: push(@groups,$key);
3411: }
3412: }
3413: if ($public) {
3414: return 'ok';
3415: }
3416: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3417: if ($guest) {
3418: return $guest;
3419: }
3420: } else {
3421: if (@domains > 0) {
3422: foreach my $domkey (@domains) {
3423: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3424: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3425: return 'ok';
3426: }
3427: }
3428: }
3429: }
3430: if (@users > 0) {
3431: foreach my $userkey (@users) {
3432: if (exists($access_hash->{$userkey}{'users'}{$env{'user.name'}.':'.$env{'user.domain'}})) {
3433: return 'ok';
3434: }
3435: }
3436: }
3437: my %roleshash;
3438: my @courses_and_groups = @courses;
3439: push(@courses_and_groups,@groups);
3440: if (@courses_and_groups > 0) {
3441: my (%allgroups,%allroles);
3442: my ($start,$end,$role,$sec,$group);
3443: foreach my $envkey (%env) {
3444: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
3445: my $cid = $2.'_'.$3;
3446: if ($1 eq 'gr') {
3447: $group = $4;
3448: $allgroups{$cid}{$group} = $env{$envkey};
3449: } else {
3450: if ($4 eq '') {
3451: $sec = 'none';
3452: } else {
3453: $sec = $4;
3454: }
3455: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3456: }
3457: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
3458: my $cid = $2.'_'.$3;
3459: if ($4 eq '') {
3460: $sec = 'none';
3461: } else {
3462: $sec = $4;
3463: }
3464: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3465: }
3466: }
3467: if (keys(%allroles) == 0) {
3468: return;
3469: }
3470: foreach my $key (@courses_and_groups) {
3471: my %content = %{$$access_hash{$key}};
3472: my $cnum = $content{'number'};
3473: my $cdom = $content{'domain'};
3474: my $cid = $cdom.'_'.$cnum;
3475: if (!exists($allroles{$cid})) {
3476: next;
3477: }
3478: foreach my $role_id (keys(%{$content{'roles'}})) {
3479: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3480: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3481: my @status = @{$content{'roles'}{$role_id}{'access'}};
3482: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3483: foreach my $role (keys(%{$allroles{$cid}})) {
3484: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3485: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3486: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3487: if (grep/^all$/,@sections) {
3488: return 'ok';
3489: } else {
3490: if (grep/^$sec$/,@sections) {
3491: return 'ok';
3492: }
3493: }
3494: }
3495: }
3496: if (keys(%{$allgroups{$cid}}) == 0) {
3497: if (grep/^none$/,@groups) {
3498: return 'ok';
3499: }
3500: } else {
3501: if (grep/^all$/,@groups) {
3502: return 'ok';
3503: }
3504: foreach my $group (keys(%{$allgroups{$cid}})) {
3505: if (grep/^$group$/,@groups) {
3506: return 'ok';
3507: }
3508: }
3509: }
3510: }
3511: }
3512: }
3513: }
3514: }
3515: if ($guest) {
3516: return $guest;
3517: }
3518: }
3519: }
3520: return;
3521: }
3522:
3523: sub course_group_datechecker {
3524: my ($dates,$now,$status) = @_;
3525: my ($start,$end) = split(/\./,$dates);
3526: if (!$start && !$end) {
3527: return 'ok';
3528: }
3529: if (grep/^active$/,@{$status}) {
3530: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3531: return 'ok';
3532: }
3533: }
3534: if (grep/^previous$/,@{$status}) {
3535: if ($end > $now ) {
3536: return 'ok';
3537: }
3538: }
3539: if (grep/^future$/,@{$status}) {
3540: if ($start > $now) {
3541: return 'ok';
3542: }
3543: }
3544: return;
3545: }
3546:
3547: sub parse_portfolio_url {
3548: my ($url) = @_;
3549:
3550: my ($type,$udom,$unum,$group,$file_name);
3551:
3552: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
3553: $type = 1;
3554: $udom = $1;
3555: $unum = $2;
3556: $file_name = $3;
3557: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
3558: $type = 2;
3559: $udom = $1;
3560: $unum = $2;
3561: $group = $3;
3562: $file_name = $3.'/'.$4;
3563: }
3564: if (wantarray) {
3565: return ($type,$udom,$unum,$file_name,$group);
3566: }
3567: return $type;
3568: }
3569:
3570: sub is_portfolio_url {
3571: my ($url) = @_;
3572: return scalar(&parse_portfolio_url($url));
3573: }
3574:
3575: sub is_portfolio_file {
3576: my ($file) = @_;
3577: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
3578: return 1;
3579: }
3580: return;
3581: }
3582:
3583:
3584: # ---------------------------------------------- Custom access rule evaluation
3585:
3586: sub customaccess {
3587: my ($priv,$uri)=@_;
3588: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
3589: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
3590: $udom = &LONCAPA::clean_domain($udom);
3591: $ucrs = &LONCAPA::clean_username($ucrs);
3592: my $access=0;
3593: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3594: my ($effect,$realm,$role)=split(/\:/,$right);
3595: if ($role) {
3596: if ($role ne $urole) { next; }
3597: }
3598: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3599: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
3600: if ($tdom) {
3601: if ($tdom ne $udom) { next; }
3602: }
3603: if ($tcrs) {
3604: if ($tcrs ne $ucrs) { next; }
3605: }
3606: if ($tsec) {
3607: if ($tsec ne $usec) { next; }
3608: }
3609: $access=($effect eq 'allow');
3610: last;
3611: }
3612: if ($realm eq '' && $role eq '') {
3613: $access=($effect eq 'allow');
3614: }
3615: }
3616: return $access;
3617: }
3618:
3619: # ------------------------------------------------- Check for a user privilege
3620:
3621: sub allowed {
3622: my ($priv,$uri,$symb,$role)=@_;
3623: my $ver_orguri=$uri;
3624: $uri=&deversion($uri);
3625: my $orguri=$uri;
3626: $uri=&declutter($uri);
3627:
3628: if ($priv eq 'evb') {
3629: # Evade communication block restrictions for specified role in a course
3630: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
3631: return $1;
3632: } else {
3633: return;
3634: }
3635: }
3636:
3637: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3638: # Free bre access to adm and meta resources
3639: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3640: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3641: && ($priv eq 'bre')) {
3642: return 'F';
3643: }
3644:
3645: # Free bre access to user's own portfolio contents
3646: my ($space,$domain,$name,@dir)=split('/',$uri);
3647: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3648: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3649: my %setters;
3650: my ($startblock,$endblock) =
3651: &Apache::loncommon::blockcheck(\%setters,'port');
3652: if ($startblock && $endblock) {
3653: return 'B';
3654: } else {
3655: return 'F';
3656: }
3657: }
3658:
3659: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3660: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3661: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3662: if (exists($env{'request.course.id'})) {
3663: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3664: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3665: if (($domain eq $cdom) && ($name eq $cnum)) {
3666: my $courseprivid=$env{'request.course.id'};
3667: $courseprivid=~s/\_/\//;
3668: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3669: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3670: return $1;
3671: } else {
3672: if ($env{'request.course.sec'}) {
3673: $courseprivid.='/'.$env{'request.course.sec'};
3674: }
3675: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3676: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3677: return $2;
3678: }
3679: }
3680: }
3681: }
3682: }
3683:
3684: # Free bre to public access
3685:
3686: if ($priv eq 'bre') {
3687: my $copyright=&metadata($uri,'copyright');
3688: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3689: return 'F';
3690: }
3691: if ($copyright eq 'priv') {
3692: $uri=~/([^\/]+)\/([^\/]+)\//;
3693: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3694: return '';
3695: }
3696: }
3697: if ($copyright eq 'domain') {
3698: $uri=~/([^\/]+)\/([^\/]+)\//;
3699: unless (($env{'user.domain'} eq $1) ||
3700: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3701: return '';
3702: }
3703: }
3704: if ($env{'request.role'}=~ /li\.\//) {
3705: # Library role, so allow browsing of resources in this domain.
3706: return 'F';
3707: }
3708: if ($copyright eq 'custom') {
3709: unless (&customaccess($priv,$uri)) { return ''; }
3710: }
3711: }
3712: # Domain coordinator is trying to create a course
3713: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3714: # uri is the requested domain in this case.
3715: # comparison to 'request.role.domain' shows if the user has selected
3716: # a role of dc for the domain in question.
3717: return 'F' if ($uri eq $env{'request.role.domain'});
3718: }
3719:
3720: my $thisallowed='';
3721: my $statecond=0;
3722: my $courseprivid='';
3723:
3724: # Course
3725:
3726: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3727: $thisallowed.=$1;
3728: }
3729:
3730: # Domain
3731:
3732: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3733: =~/\Q$priv\E\&([^\:]*)/) {
3734: $thisallowed.=$1;
3735: }
3736:
3737: # Course: uri itself is a course
3738: my $courseuri=$uri;
3739: $courseuri=~s/\_(\d)/\/$1/;
3740: $courseuri=~s/^([^\/])/\/$1/;
3741:
3742: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3743: =~/\Q$priv\E\&([^\:]*)/) {
3744: $thisallowed.=$1;
3745: }
3746:
3747: # URI is an uploaded document for this course, default permissions don't matter
3748: # not allowing 'edit' access (editupload) to uploaded course docs
3749: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3750: $thisallowed='';
3751: my ($match)=&is_on_map($uri);
3752: if ($match) {
3753: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3754: =~/\Q$priv\E\&([^\:]*)/) {
3755: $thisallowed.=$1;
3756: }
3757: } else {
3758: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3759: if ($refuri) {
3760: if ($refuri =~ m|^/adm/|) {
3761: $thisallowed='F';
3762: } else {
3763: $refuri=&declutter($refuri);
3764: my ($match) = &is_on_map($refuri);
3765: if ($match) {
3766: $thisallowed='F';
3767: }
3768: }
3769: }
3770: }
3771: }
3772:
3773: if ($priv eq 'bre'
3774: && $thisallowed ne 'F'
3775: && $thisallowed ne '2'
3776: && &is_portfolio_url($uri)) {
3777: $thisallowed = &portfolio_access($uri);
3778: }
3779:
3780: # Full access at system, domain or course-wide level? Exit.
3781:
3782: if ($thisallowed=~/F/) {
3783: return 'F';
3784: }
3785:
3786: # If this is generating or modifying users, exit with special codes
3787:
3788: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3789: if (($priv eq 'cca') || ($priv eq 'caa')) {
3790: my ($audom,$auname)=split('/',$uri);
3791: # no author name given, so this just checks on the general right to make a co-author in this domain
3792: unless ($auname) { return $thisallowed; }
3793: # an author name is given, so we are about to actually make a co-author for a certain account
3794: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3795: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3796: ($audom ne $env{'request.role.domain'}))) { return ''; }
3797: }
3798: return $thisallowed;
3799: }
3800: #
3801: # Gathered so far: system, domain and course wide privileges
3802: #
3803: # Course: See if uri or referer is an individual resource that is part of
3804: # the course
3805:
3806: if ($env{'request.course.id'}) {
3807:
3808: $courseprivid=$env{'request.course.id'};
3809: if ($env{'request.course.sec'}) {
3810: $courseprivid.='/'.$env{'request.course.sec'};
3811: }
3812: $courseprivid=~s/\_/\//;
3813: my $checkreferer=1;
3814: my ($match,$cond)=&is_on_map($uri);
3815: if ($match) {
3816: $statecond=$cond;
3817: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3818: =~/\Q$priv\E\&([^\:]*)/) {
3819: $thisallowed.=$1;
3820: $checkreferer=0;
3821: }
3822: }
3823:
3824: if ($checkreferer) {
3825: my $refuri=$env{'httpref.'.$orguri};
3826: unless ($refuri) {
3827: foreach my $key (keys(%env)) {
3828: if ($key=~/^httpref\..*\*/) {
3829: my $pattern=$key;
3830: $pattern=~s/^httpref\.\/res\///;
3831: $pattern=~s/\*/\[\^\/\]\+/g;
3832: $pattern=~s/\//\\\//g;
3833: if ($orguri=~/$pattern/) {
3834: $refuri=$env{$key};
3835: }
3836: }
3837: }
3838: }
3839:
3840: if ($refuri) {
3841: $refuri=&declutter($refuri);
3842: my ($match,$cond)=&is_on_map($refuri);
3843: if ($match) {
3844: my $refstatecond=$cond;
3845: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3846: =~/\Q$priv\E\&([^\:]*)/) {
3847: $thisallowed.=$1;
3848: $uri=$refuri;
3849: $statecond=$refstatecond;
3850: }
3851: }
3852: }
3853: }
3854: }
3855:
3856: #
3857: # Gathered now: all privileges that could apply, and condition number
3858: #
3859: #
3860: # Full or no access?
3861: #
3862:
3863: if ($thisallowed=~/F/) {
3864: return 'F';
3865: }
3866:
3867: unless ($thisallowed) {
3868: return '';
3869: }
3870:
3871: # Restrictions exist, deal with them
3872: #
3873: # C:according to course preferences
3874: # R:according to resource settings
3875: # L:unless locked
3876: # X:according to user session state
3877: #
3878:
3879: # Possibly locked functionality, check all courses
3880: # Locks might take effect only after 10 minutes cache expiration for other
3881: # courses, and 2 minutes for current course
3882:
3883: my $envkey;
3884: if ($thisallowed=~/L/) {
3885: foreach $envkey (keys %env) {
3886: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3887: my $courseid=$2;
3888: my $roleid=$1.'.'.$2;
3889: $courseid=~s/^\///;
3890: my $expiretime=600;
3891: if ($env{'request.role'} eq $roleid) {
3892: $expiretime=120;
3893: }
3894: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3895: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3896: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3897: &coursedescription($courseid,{'freshen_cache' => 1});
3898: }
3899: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3900: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3901: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3902: &log($env{'user.domain'},$env{'user.name'},
3903: $env{'user.home'},
3904: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3905: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3906: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3907: return '';
3908: }
3909: }
3910: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3911: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3912: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3913: &log($env{'user.domain'},$env{'user.name'},
3914: $env{'user.home'},
3915: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3916: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3917: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3918: return '';
3919: }
3920: }
3921: }
3922: }
3923: }
3924:
3925: #
3926: # Rest of the restrictions depend on selected course
3927: #
3928:
3929: unless ($env{'request.course.id'}) {
3930: if ($thisallowed eq 'A') {
3931: return 'A';
3932: } elsif ($thisallowed eq 'B') {
3933: return 'B';
3934: } else {
3935: return '1';
3936: }
3937: }
3938:
3939: #
3940: # Now user is definitely in a course
3941: #
3942:
3943:
3944: # Course preferences
3945:
3946: if ($thisallowed=~/C/) {
3947: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3948: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3949: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3950: =~/\Q$rolecode\E/) {
3951: if ($priv ne 'pch') {
3952: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3953: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3954: $env{'request.course.id'});
3955: }
3956: return '';
3957: }
3958:
3959: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3960: =~/\Q$unamedom\E/) {
3961: if ($priv ne 'pch') {
3962: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3963: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3964: $env{'request.course.id'});
3965: }
3966: return '';
3967: }
3968: }
3969:
3970: # Resource preferences
3971:
3972: if ($thisallowed=~/R/) {
3973: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3974: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3975: if ($priv ne 'pch') {
3976: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3977: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3978: }
3979: return '';
3980: }
3981: }
3982:
3983: # Restricted by state or randomout?
3984:
3985: if ($thisallowed=~/X/) {
3986: if ($env{'acc.randomout'}) {
3987: if (!$symb) { $symb=&symbread($uri,1); }
3988: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3989: return '';
3990: }
3991: }
3992: if (&condval($statecond)) {
3993: return '2';
3994: } else {
3995: return '';
3996: }
3997: }
3998:
3999: if ($thisallowed eq 'A') {
4000: return 'A';
4001: } elsif ($thisallowed eq 'B') {
4002: return 'B';
4003: }
4004: return 'F';
4005: }
4006:
4007: sub split_uri_for_cond {
4008: my $uri=&deversion(&declutter(shift));
4009: my @uriparts=split(/\//,$uri);
4010: my $filename=pop(@uriparts);
4011: my $pathname=join('/',@uriparts);
4012: return ($pathname,$filename);
4013: }
4014: # --------------------------------------------------- Is a resource on the map?
4015:
4016: sub is_on_map {
4017: my ($pathname,$filename) = &split_uri_for_cond(shift);
4018: #Trying to find the conditional for the file
4019: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
4020: /\&\Q$filename\E\:([\d\|]+)\&/);
4021: if ($match) {
4022: return (1,$1);
4023: } else {
4024: return (0,0);
4025: }
4026: }
4027:
4028: # --------------------------------------------------------- Get symb from alias
4029:
4030: sub get_symb_from_alias {
4031: my $symb=shift;
4032: my ($map,$resid,$url)=&decode_symb($symb);
4033: # Already is a symb
4034: if ($url) { return $symb; }
4035: # Must be an alias
4036: my $aliassymb='';
4037: my %bighash;
4038: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4039: &GDBM_READER(),0640)) {
4040: my $rid=$bighash{'mapalias_'.$symb};
4041: if ($rid) {
4042: my ($mapid,$resid)=split(/\./,$rid);
4043: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
4044: $resid,$bighash{'src_'.$rid});
4045: }
4046: untie %bighash;
4047: }
4048: return $aliassymb;
4049: }
4050:
4051: # ----------------------------------------------------------------- Define Role
4052:
4053: sub definerole {
4054: if (allowed('mcr','/')) {
4055: my ($rolename,$sysrole,$domrole,$courole)=@_;
4056: foreach my $role (split(':',$sysrole)) {
4057: my ($crole,$cqual)=split(/\&/,$role);
4058: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
4059: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
4060: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4061: return "refused:s:$crole&$cqual";
4062: }
4063: }
4064: }
4065: foreach my $role (split(':',$domrole)) {
4066: my ($crole,$cqual)=split(/\&/,$role);
4067: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
4068: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
4069: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
4070: return "refused:d:$crole&$cqual";
4071: }
4072: }
4073: }
4074: foreach my $role (split(':',$courole)) {
4075: my ($crole,$cqual)=split(/\&/,$role);
4076: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4077: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4078: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4079: return "refused:c:$crole&$cqual";
4080: }
4081: }
4082: }
4083: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4084: "$env{'user.domain'}:$env{'user.name'}:".
4085: "rolesdef_$rolename=".
4086: escape($sysrole.'_'.$domrole.'_'.$courole);
4087: return reply($command,$env{'user.home'});
4088: } else {
4089: return 'refused';
4090: }
4091: }
4092:
4093: # ---------------- Make a metadata query against the network of library servers
4094:
4095: sub metadata_query {
4096: my ($query,$custom,$customshow,$server_array)=@_;
4097: my %rhash;
4098: my @server_list = (defined($server_array) ? @$server_array
4099: : keys(%libserv) );
4100: for my $server (@server_list) {
4101: unless ($custom or $customshow) {
4102: my $reply=&reply("querysend:".&escape($query),$server);
4103: $rhash{$server}=$reply;
4104: }
4105: else {
4106: my $reply=&reply("querysend:".&escape($query).':'.
4107: &escape($custom).':'.&escape($customshow),
4108: $server);
4109: $rhash{$server}=$reply;
4110: }
4111: }
4112: return \%rhash;
4113: }
4114:
4115: # ----------------------------------------- Send log queries and wait for reply
4116:
4117: sub log_query {
4118: my ($uname,$udom,$query,%filters)=@_;
4119: my $uhome=&homeserver($uname,$udom);
4120: if ($uhome eq 'no_host') { return 'error: no_host'; }
4121: my $uhost=$hostname{$uhome};
4122: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4123: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4124: $uhome);
4125: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4126: return get_query_reply($queryid);
4127: }
4128:
4129: # -------------------------- Update MySQL table for portfolio file
4130:
4131: sub update_portfolio_table {
4132: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
4133: my $homeserver = &homeserver($uname,$udom);
4134: my $queryid=
4135: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
4136: ':'.&escape($file_name).':'.$action,$homeserver);
4137: my $reply = &get_query_reply($queryid);
4138: return $reply;
4139: }
4140:
4141: # ------- Request retrieval of institutional classlists for course(s)
4142:
4143: sub fetch_enrollment_query {
4144: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4145: my $homeserver;
4146: my $maxtries = 1;
4147: if ($context eq 'automated') {
4148: $homeserver = $perlvar{'lonHostID'};
4149: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4150: } else {
4151: $homeserver = &homeserver($cnum,$dom);
4152: }
4153: my $host=$hostname{$homeserver};
4154: my $cmd = '';
4155: foreach my $affiliate (keys %{$affiliatesref}) {
4156: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4157: }
4158: $cmd =~ s/%%$//;
4159: $cmd = &escape($cmd);
4160: my $query = 'fetchenrollment';
4161: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4162: unless ($queryid=~/^\Q$host\E\_/) {
4163: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4164: return 'error: '.$queryid;
4165: }
4166: my $reply = &get_query_reply($queryid);
4167: my $tries = 1;
4168: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4169: $reply = &get_query_reply($queryid);
4170: $tries ++;
4171: }
4172: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4173: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4174: } else {
4175: my @responses = split/:/,$reply;
4176: if ($homeserver eq $perlvar{'lonHostID'}) {
4177: foreach my $line (@responses) {
4178: my ($key,$value) = split(/=/,$line,2);
4179: $$replyref{$key} = $value;
4180: }
4181: } else {
4182: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4183: foreach my $line (@responses) {
4184: my ($key,$value) = split(/=/,$line);
4185: $$replyref{$key} = $value;
4186: if ($value > 0) {
4187: foreach my $item (@{$$affiliatesref{$key}}) {
4188: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4189: my $destname = $pathname.'/'.$filename;
4190: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4191: if ($xml_classlist =~ /^error/) {
4192: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4193: } else {
4194: if ( open(FILE,">$destname") ) {
4195: print FILE &unescape($xml_classlist);
4196: close(FILE);
4197: } else {
4198: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4199: }
4200: }
4201: }
4202: }
4203: }
4204: }
4205: return 'ok';
4206: }
4207: return 'error';
4208: }
4209:
4210: sub get_query_reply {
4211: my $queryid=shift;
4212: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4213: my $reply='';
4214: for (1..100) {
4215: sleep 2;
4216: if (-e $replyfile.'.end') {
4217: if (open(my $fh,$replyfile)) {
4218: $reply.=<$fh>;
4219: close($fh);
4220: } else { return 'error: reply_file_error'; }
4221: return &unescape($reply);
4222: }
4223: }
4224: return 'timeout:'.$queryid;
4225: }
4226:
4227: sub courselog_query {
4228: #
4229: # possible filters:
4230: # url: url or symb
4231: # username
4232: # domain
4233: # action: view, submit, grade
4234: # start: timestamp
4235: # end: timestamp
4236: #
4237: my (%filters)=@_;
4238: unless ($env{'request.course.id'}) { return 'no_course'; }
4239: if ($filters{'url'}) {
4240: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4241: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4242: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4243: }
4244: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4245: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4246: return &log_query($cname,$cdom,'courselog',%filters);
4247: }
4248:
4249: sub userlog_query {
4250: my ($uname,$udom,%filters)=@_;
4251: return &log_query($uname,$udom,'userlog',%filters);
4252: }
4253:
4254: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4255:
4256: sub auto_run {
4257: my ($cnum,$cdom) = @_;
4258: my $homeserver = &homeserver($cnum,$cdom);
4259: my $response = &reply('autorun:'.$cdom,$homeserver);
4260: return $response;
4261: }
4262:
4263: sub auto_get_sections {
4264: my ($cnum,$cdom,$inst_coursecode) = @_;
4265: my $homeserver = &homeserver($cnum,$cdom);
4266: my @secs = ();
4267: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4268: unless ($response eq 'refused') {
4269: @secs = split/:/,$response;
4270: }
4271: return @secs;
4272: }
4273:
4274: sub auto_new_course {
4275: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4276: my $homeserver = &homeserver($cnum,$cdom);
4277: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4278: return $response;
4279: }
4280:
4281: sub auto_validate_courseID {
4282: my ($cnum,$cdom,$inst_course_id) = @_;
4283: my $homeserver = &homeserver($cnum,$cdom);
4284: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4285: return $response;
4286: }
4287:
4288: sub auto_create_password {
4289: my ($cnum,$cdom,$authparam) = @_;
4290: my $homeserver = &homeserver($cnum,$cdom);
4291: my $create_passwd = 0;
4292: my $authchk = '';
4293: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4294: if ($response eq 'refused') {
4295: $authchk = 'refused';
4296: } else {
4297: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4298: }
4299: return ($authparam,$create_passwd,$authchk);
4300: }
4301:
4302: sub auto_photo_permission {
4303: my ($cnum,$cdom,$students) = @_;
4304: my $homeserver = &homeserver($cnum,$cdom);
4305: my ($outcome,$perm_reqd,$conditions) =
4306: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4307: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4308: return (undef,undef);
4309: }
4310: return ($outcome,$perm_reqd,$conditions);
4311: }
4312:
4313: sub auto_checkphotos {
4314: my ($uname,$udom,$pid) = @_;
4315: my $homeserver = &homeserver($uname,$udom);
4316: my ($result,$resulttype);
4317: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4318: &escape($uname).':'.&escape($pid),
4319: $homeserver));
4320: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4321: return (undef,undef);
4322: }
4323: if ($outcome) {
4324: ($result,$resulttype) = split(/:/,$outcome);
4325: }
4326: return ($result,$resulttype);
4327: }
4328:
4329: sub auto_photochoice {
4330: my ($cnum,$cdom) = @_;
4331: my $homeserver = &homeserver($cnum,$cdom);
4332: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4333: &escape($cdom),
4334: $homeserver)));
4335: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4336: return (undef,undef);
4337: }
4338: return ($update,$comment);
4339: }
4340:
4341: sub auto_photoupdate {
4342: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4343: my $homeserver = &homeserver($cnum,$dom);
4344: my $host=$hostname{$homeserver};
4345: my $cmd = '';
4346: my $maxtries = 1;
4347: foreach my $affiliate (keys(%{$affiliatesref})) {
4348: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4349: }
4350: $cmd =~ s/%%$//;
4351: $cmd = &escape($cmd);
4352: my $query = 'institutionalphotos';
4353: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4354: unless ($queryid=~/^\Q$host\E\_/) {
4355: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4356: return 'error: '.$queryid;
4357: }
4358: my $reply = &get_query_reply($queryid);
4359: my $tries = 1;
4360: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4361: $reply = &get_query_reply($queryid);
4362: $tries ++;
4363: }
4364: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4365: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4366: } else {
4367: my @responses = split(/:/,$reply);
4368: my $outcome = shift(@responses);
4369: foreach my $item (@responses) {
4370: my ($key,$value) = split(/=/,$item);
4371: $$photo{$key} = $value;
4372: }
4373: return $outcome;
4374: }
4375: return 'error';
4376: }
4377:
4378: sub auto_instcode_format {
4379: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4380: $cat_order) = @_;
4381: my $courses = '';
4382: my @homeservers;
4383: if ($caller eq 'global') {
4384: foreach my $tryserver (keys(%libserv)) {
4385: if ($hostdom{$tryserver} eq $codedom) {
4386: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4387: push(@homeservers,$tryserver);
4388: }
4389: }
4390: }
4391: } else {
4392: push(@homeservers,&homeserver($caller,$codedom));
4393: }
4394: foreach my $code (keys(%{$instcodes})) {
4395: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4396: }
4397: chop($courses);
4398: my $ok_response = 0;
4399: my $response;
4400: while (@homeservers > 0 && $ok_response == 0) {
4401: my $server = shift(@homeservers);
4402: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4403: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4404: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4405: split/:/,$response;
4406: %{$codes} = (%{$codes},&str2hash($codes_str));
4407: push(@{$codetitles},&str2array($codetitles_str));
4408: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4409: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4410: $ok_response = 1;
4411: }
4412: }
4413: if ($ok_response) {
4414: return 'ok';
4415: } else {
4416: return $response;
4417: }
4418: }
4419:
4420: sub auto_instcode_defaults {
4421: my ($domain,$returnhash,$code_order) = @_;
4422: my @homeservers;
4423: foreach my $tryserver (keys(%libserv)) {
4424: if ($hostdom{$tryserver} eq $domain) {
4425: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4426: push(@homeservers,$tryserver);
4427: }
4428: }
4429: }
4430: my $ok_response = 0;
4431: my $response;
4432: while (@homeservers > 0 && $ok_response == 0) {
4433: my $server = shift(@homeservers);
4434: $response=&reply('autoinstcodedefaults:'.$domain,$server);
4435: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4436: foreach my $pair (split(/\&/,$response)) {
4437: my ($name,$value)=split(/\=/,$pair);
4438: if ($name eq 'code_order') {
4439: @{$code_order} = split(/\&/,&unescape($value));
4440: } else {
4441: $returnhash->{&unescape($name)}=&unescape($value);
4442: }
4443: }
4444: $ok_response = 1;
4445: }
4446: }
4447: if ($ok_response) {
4448: return 'ok';
4449: } else {
4450: return $response;
4451: }
4452: }
4453:
4454: sub auto_validate_class_sec {
4455: my ($cdom,$cnum,$owner,$inst_class) = @_;
4456: my $homeserver = &homeserver($cnum,$cdom);
4457: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4458: &escape($owner).':'.$cdom,$homeserver);
4459: return $response;
4460: }
4461:
4462: # ------------------------------------------------------- Course Group routines
4463:
4464: sub get_coursegroups {
4465: my ($cdom,$cnum,$group,$namespace) = @_;
4466: return(&dump($namespace,$cdom,$cnum,$group));
4467: }
4468:
4469: sub modify_coursegroup {
4470: my ($cdom,$cnum,$groupsettings) = @_;
4471: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4472: }
4473:
4474: sub toggle_coursegroup_status {
4475: my ($cdom,$cnum,$group,$action) = @_;
4476: my ($from_namespace,$to_namespace);
4477: if ($action eq 'delete') {
4478: $from_namespace = 'coursegroups';
4479: $to_namespace = 'deleted_groups';
4480: } else {
4481: $from_namespace = 'deleted_groups';
4482: $to_namespace = 'coursegroups';
4483: }
4484: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
4485: if (my $tmp = &error(%curr_group)) {
4486: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
4487: return ('read error',$tmp);
4488: } else {
4489: my %savedsettings = %curr_group;
4490: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
4491: my $deloutcome;
4492: if ($result eq 'ok') {
4493: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
4494: } else {
4495: return ('write error',$result);
4496: }
4497: if ($deloutcome eq 'ok') {
4498: return 'ok';
4499: } else {
4500: return ('delete error',$deloutcome);
4501: }
4502: }
4503: }
4504:
4505: sub modify_group_roles {
4506: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4507: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4508: my $role = 'gr/'.&escape($userprivs);
4509: my ($uname,$udom) = split(/:/,$user);
4510: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4511: if ($result eq 'ok') {
4512: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4513: }
4514: return $result;
4515: }
4516:
4517: sub modify_coursegroup_membership {
4518: my ($cdom,$cnum,$membership) = @_;
4519: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4520: return $result;
4521: }
4522:
4523: sub get_active_groups {
4524: my ($udom,$uname,$cdom,$cnum) = @_;
4525: my $now = time;
4526: my %groups = ();
4527: foreach my $key (keys(%env)) {
4528: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
4529: my ($start,$end) = split(/\./,$env{$key});
4530: if (($end!=0) && ($end<$now)) { next; }
4531: if (($start!=0) && ($start>$now)) { next; }
4532: if ($1 eq $cdom && $2 eq $cnum) {
4533: $groups{$3} = $env{$key} ;
4534: }
4535: }
4536: }
4537: return %groups;
4538: }
4539:
4540: sub get_group_membership {
4541: my ($cdom,$cnum,$group) = @_;
4542: return(&dump('groupmembership',$cdom,$cnum,$group));
4543: }
4544:
4545: sub get_users_groups {
4546: my ($udom,$uname,$courseid) = @_;
4547: my @usersgroups;
4548: my $cachetime=1800;
4549:
4550: my $hashid="$udom:$uname:$courseid";
4551: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4552: if (defined($cached)) {
4553: @usersgroups = split(/:/,$grouplist);
4554: } else {
4555: $grouplist = '';
4556: my $courseurl = &courseid_to_courseurl($courseid);
4557: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
4558: my $access_end = $env{'course.'.$courseid.
4559: '.default_enrollment_end_date'};
4560: my $now = time;
4561: foreach my $key (keys(%roleshash)) {
4562: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
4563: my $group = $1;
4564: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4565: my $start = $2;
4566: my $end = $1;
4567: if ($start == -1) { next; } # deleted from group
4568: if (($start!=0) && ($start>$now)) { next; }
4569: if (($end!=0) && ($end<$now)) {
4570: if ($access_end && $access_end < $now) {
4571: if ($access_end - $end < 86400) {
4572: push(@usersgroups,$group);
4573: }
4574: }
4575: next;
4576: }
4577: push(@usersgroups,$group);
4578: }
4579: }
4580: }
4581: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4582: $grouplist = join(':',@usersgroups);
4583: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4584: }
4585: return @usersgroups;
4586: }
4587:
4588: sub devalidate_getgroups_cache {
4589: my ($udom,$uname,$cdom,$cnum)=@_;
4590: my $courseid = $cdom.'_'.$cnum;
4591:
4592: my $hashid="$udom:$uname:$courseid";
4593: &devalidate_cache_new('getgroups',$hashid);
4594: }
4595:
4596: # ------------------------------------------------------------------ Plain Text
4597:
4598: sub plaintext {
4599: my ($short,$type,$cid) = @_;
4600: if ($short =~ /^cr/) {
4601: return (split('/',$short))[-1];
4602: }
4603: if (!defined($cid)) {
4604: $cid = $env{'request.course.id'};
4605: }
4606: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4607: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4608: '.plaintext'});
4609: }
4610: my %rolenames = (
4611: Course => 'std',
4612: Group => 'alt1',
4613: );
4614: if (defined($type) &&
4615: defined($rolenames{$type}) &&
4616: defined($prp{$short}{$rolenames{$type}})) {
4617: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4618: } else {
4619: return &Apache::lonlocal::mt($prp{$short}{'std'});
4620: }
4621: }
4622:
4623: # ----------------------------------------------------------------- Assign Role
4624:
4625: sub assignrole {
4626: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4627: my $mrole;
4628: if ($role =~ /^cr\//) {
4629: my $cwosec=$url;
4630: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
4631: unless (&allowed('ccr',$cwosec)) {
4632: &logthis('Refused custom assignrole: '.
4633: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4634: $env{'user.name'}.' at '.$env{'user.domain'});
4635: return 'refused';
4636: }
4637: $mrole='cr';
4638: } elsif ($role =~ /^gr\//) {
4639: my $cwogrp=$url;
4640: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
4641: unless (&allowed('mdg',$cwogrp)) {
4642: &logthis('Refused group assignrole: '.
4643: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4644: $env{'user.name'}.' at '.$env{'user.domain'});
4645: return 'refused';
4646: }
4647: $mrole='gr';
4648: } else {
4649: my $cwosec=$url;
4650: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
4651: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4652: &logthis('Refused assignrole: '.
4653: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4654: $env{'user.name'}.' at '.$env{'user.domain'});
4655: return 'refused';
4656: }
4657: $mrole=$role;
4658: }
4659: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4660: "$udom:$uname:$url".'_'."$mrole=$role";
4661: if ($end) { $command.='_'.$end; }
4662: if ($start) {
4663: if ($end) {
4664: $command.='_'.$start;
4665: } else {
4666: $command.='_0_'.$start;
4667: }
4668: }
4669: my $origstart = $start;
4670: my $origend = $end;
4671: # actually delete
4672: if ($deleteflag) {
4673: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4674: # modify command to delete the role
4675: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4676: "$udom:$uname:$url".'_'."$mrole";
4677: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4678: # set start and finish to negative values for userrolelog
4679: $start=-1;
4680: $end=-1;
4681: }
4682: }
4683: # send command
4684: my $answer=&reply($command,&homeserver($uname,$udom));
4685: # log new user role if status is ok
4686: if ($answer eq 'ok') {
4687: &userrolelog($role,$uname,$udom,$url,$start,$end);
4688: # for course roles, perform group memberships changes triggered by role change.
4689: unless ($role =~ /^gr/) {
4690: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4691: $origstart);
4692: }
4693: }
4694: return $answer;
4695: }
4696:
4697: # -------------------------------------------------- Modify user authentication
4698: # Overrides without validation
4699:
4700: sub modifyuserauth {
4701: my ($udom,$uname,$umode,$upass)=@_;
4702: my $uhome=&homeserver($uname,$udom);
4703: unless (&allowed('mau',$udom)) { return 'refused'; }
4704: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4705: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4706: ' in domain '.$env{'request.role.domain'});
4707: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4708: &escape($upass),$uhome);
4709: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4710: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4711: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4712: &log($udom,,$uname,$uhome,
4713: 'Authentication changed by '.$env{'user.domain'}.', '.
4714: $env{'user.name'}.', '.$umode.
4715: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4716: unless ($reply eq 'ok') {
4717: &logthis('Authentication mode error: '.$reply);
4718: return 'error: '.$reply;
4719: }
4720: return 'ok';
4721: }
4722:
4723: # --------------------------------------------------------------- Modify a user
4724:
4725: sub modifyuser {
4726: my ($udom, $uname, $uid,
4727: $umode, $upass, $first,
4728: $middle, $last, $gene,
4729: $forceid, $desiredhome, $email)=@_;
4730: $udom= &LONCAPA::clean_domain($udom);
4731: $uname=&LONCAPA::clean_username($uname);
4732: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4733: $umode.', '.$first.', '.$middle.', '.
4734: $last.', '.$gene.'(forceid: '.$forceid.')'.
4735: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4736: ' desiredhome not specified').
4737: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4738: ' in domain '.$env{'request.role.domain'});
4739: my $uhome=&homeserver($uname,$udom,'true');
4740: # ----------------------------------------------------------------- Create User
4741: if (($uhome eq 'no_host') &&
4742: (($umode && $upass) || ($umode eq 'localauth'))) {
4743: my $unhome='';
4744: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4745: $unhome = $desiredhome;
4746: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4747: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4748: } else { # load balancing routine for determining $unhome
4749: my $tryserver;
4750: my $loadm=10000000;
4751: foreach $tryserver (keys %libserv) {
4752: if ($hostdom{$tryserver} eq $udom) {
4753: my $answer=reply('load',$tryserver);
4754: if (($answer=~/\d+/) && ($answer<$loadm)) {
4755: $loadm=$answer;
4756: $unhome=$tryserver;
4757: }
4758: }
4759: }
4760: }
4761: if (($unhome eq '') || ($unhome eq 'no_host')) {
4762: return 'error: unable to find a home server for '.$uname.
4763: ' in domain '.$udom;
4764: }
4765: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4766: &escape($upass),$unhome);
4767: unless ($reply eq 'ok') {
4768: return 'error: '.$reply;
4769: }
4770: $uhome=&homeserver($uname,$udom,'true');
4771: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4772: return 'error: unable verify users home machine.';
4773: }
4774: } # End of creation of new user
4775: # ---------------------------------------------------------------------- Add ID
4776: if ($uid) {
4777: $uid=~tr/A-Z/a-z/;
4778: my %uidhash=&idrget($udom,$uname);
4779: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4780: && (!$forceid)) {
4781: unless ($uid eq $uidhash{$uname}) {
4782: return 'error: user id "'.$uid.'" does not match '.
4783: 'current user id "'.$uidhash{$uname}.'".';
4784: }
4785: } else {
4786: &idput($udom,($uname => $uid));
4787: }
4788: }
4789: # -------------------------------------------------------------- Add names, etc
4790: my @tmp=&get('environment',
4791: ['firstname','middlename','lastname','generation'],
4792: $udom,$uname);
4793: my %names;
4794: if ($tmp[0] =~ m/^error:.*/) {
4795: %names=();
4796: } else {
4797: %names = @tmp;
4798: }
4799: #
4800: # Make sure to not trash student environment if instructor does not bother
4801: # to supply name and email information
4802: #
4803: if ($first) { $names{'firstname'} = $first; }
4804: if (defined($middle)) { $names{'middlename'} = $middle; }
4805: if ($last) { $names{'lastname'} = $last; }
4806: if (defined($gene)) { $names{'generation'} = $gene; }
4807: if ($email) {
4808: $email=~s/[^\w\@\.\-\,]//gs;
4809: if ($email=~/\@/) { $names{'notification'} = $email;
4810: $names{'critnotification'} = $email;
4811: $names{'permanentemail'} = $email; }
4812: }
4813: my $reply = &put('environment', \%names, $udom,$uname);
4814: if ($reply ne 'ok') { return 'error: '.$reply; }
4815: &devalidate_cache_new('namescache',$uname.':'.$udom);
4816: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4817: $umode.', '.$first.', '.$middle.', '.
4818: $last.', '.$gene.' by '.
4819: $env{'user.name'}.' at '.$env{'user.domain'});
4820: return 'ok';
4821: }
4822:
4823: # -------------------------------------------------------------- Modify student
4824:
4825: sub modifystudent {
4826: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4827: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4828: if (!$cid) {
4829: unless ($cid=$env{'request.course.id'}) {
4830: return 'not_in_class';
4831: }
4832: }
4833: # --------------------------------------------------------------- Make the user
4834: my $reply=&modifyuser
4835: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4836: $desiredhome,$email);
4837: unless ($reply eq 'ok') { return $reply; }
4838: # This will cause &modify_student_enrollment to get the uid from the
4839: # students environment
4840: $uid = undef if (!$forceid);
4841: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4842: $gene,$usec,$end,$start,$type,$locktype,$cid);
4843: return $reply;
4844: }
4845:
4846: sub modify_student_enrollment {
4847: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4848: my ($cdom,$cnum,$chome);
4849: if (!$cid) {
4850: unless ($cid=$env{'request.course.id'}) {
4851: return 'not_in_class';
4852: }
4853: $cdom=$env{'course.'.$cid.'.domain'};
4854: $cnum=$env{'course.'.$cid.'.num'};
4855: } else {
4856: ($cdom,$cnum)=split(/_/,$cid);
4857: }
4858: $chome=$env{'course.'.$cid.'.home'};
4859: if (!$chome) {
4860: $chome=&homeserver($cnum,$cdom);
4861: }
4862: if (!$chome) { return 'unknown_course'; }
4863: # Make sure the user exists
4864: my $uhome=&homeserver($uname,$udom);
4865: if (($uhome eq '') || ($uhome eq 'no_host')) {
4866: return 'error: no such user';
4867: }
4868: # Get student data if we were not given enough information
4869: if (!defined($first) || $first eq '' ||
4870: !defined($last) || $last eq '' ||
4871: !defined($uid) || $uid eq '' ||
4872: !defined($middle) || $middle eq '' ||
4873: !defined($gene) || $gene eq '') {
4874: # They did not supply us with enough data to enroll the student, so
4875: # we need to pick up more information.
4876: my %tmp = &get('environment',
4877: ['firstname','middlename','lastname', 'generation','id']
4878: ,$udom,$uname);
4879:
4880: #foreach my $key (keys(%tmp)) {
4881: # &logthis("key $key = ".$tmp{$key});
4882: #}
4883: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4884: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4885: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4886: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4887: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4888: }
4889: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4890: my $reply=cput('classlist',
4891: {"$uname:$udom" =>
4892: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4893: $cdom,$cnum);
4894: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4895: return 'error: '.$reply;
4896: } else {
4897: &devalidate_getsection_cache($udom,$uname,$cid);
4898: }
4899: # Add student role to user
4900: my $uurl='/'.$cid;
4901: $uurl=~s/\_/\//g;
4902: if ($usec) {
4903: $uurl.='/'.$usec;
4904: }
4905: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4906: }
4907:
4908: sub format_name {
4909: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4910: my $name;
4911: if ($first ne 'lastname') {
4912: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4913: } else {
4914: if ($lastname=~/\S/) {
4915: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4916: $name=~s/\s+,/,/;
4917: } else {
4918: $name.= $firstname.' '.$middlename.' '.$generation;
4919: }
4920: }
4921: $name=~s/^\s+//;
4922: $name=~s/\s+$//;
4923: $name=~s/\s+/ /g;
4924: return $name;
4925: }
4926:
4927: # ------------------------------------------------- Write to course preferences
4928:
4929: sub writecoursepref {
4930: my ($courseid,%prefs)=@_;
4931: $courseid=~s/^\///;
4932: $courseid=~s/\_/\//g;
4933: my ($cdomain,$cnum)=split(/\//,$courseid);
4934: my $chome=homeserver($cnum,$cdomain);
4935: if (($chome eq '') || ($chome eq 'no_host')) {
4936: return 'error: no such course';
4937: }
4938: my $cstring='';
4939: foreach my $pref (keys(%prefs)) {
4940: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
4941: }
4942: $cstring=~s/\&$//;
4943: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4944: }
4945:
4946: # ---------------------------------------------------------- Make/modify course
4947:
4948: sub createcourse {
4949: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4950: $course_owner,$crstype)=@_;
4951: $url=&declutter($url);
4952: my $cid='';
4953: unless (&allowed('ccc',$udom)) {
4954: return 'refused';
4955: }
4956: # ------------------------------------------------------------------- Create ID
4957: my $uname=int(1+rand(9)).
4958: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4959: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4960: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4961: # ----------------------------------------------- Make sure that does not exist
4962: my $uhome=&homeserver($uname,$udom,'true');
4963: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4964: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4965: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4966: $uhome=&homeserver($uname,$udom,'true');
4967: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4968: return 'error: unable to generate unique course-ID';
4969: }
4970: }
4971: # ------------------------------------------------ Check supplied server name
4972: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4973: if (! exists($libserv{$course_server})) {
4974: return 'error:bad server name '.$course_server;
4975: }
4976: # ------------------------------------------------------------- Make the course
4977: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4978: $course_server);
4979: unless ($reply eq 'ok') { return 'error: '.$reply; }
4980: $uhome=&homeserver($uname,$udom,'true');
4981: if (($uhome eq '') || ($uhome eq 'no_host')) {
4982: return 'error: no such course';
4983: }
4984: # ----------------------------------------------------------------- Course made
4985: # log existence
4986: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4987: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4988: &escape($crstype),$uhome);
4989: &flushcourselogs();
4990: # set toplevel url
4991: my $topurl=$url;
4992: unless ($nonstandard) {
4993: # ------------------------------------------ For standard courses, make top url
4994: my $mapurl=&clutter($url);
4995: if ($mapurl eq '/res/') { $mapurl=''; }
4996: $env{'form.initmap'}=(<<ENDINITMAP);
4997: <map>
4998: <resource id="1" type="start"></resource>
4999: <resource id="2" src="$mapurl"></resource>
5000: <resource id="3" type="finish"></resource>
5001: <link index="1" from="1" to="2"></link>
5002: <link index="2" from="2" to="3"></link>
5003: </map>
5004: ENDINITMAP
5005: $topurl=&declutter(
5006: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
5007: );
5008: }
5009: # ----------------------------------------------------------- Write preferences
5010: &writecoursepref($udom.'_'.$uname,
5011: ('description' => $description,
5012: 'url' => $topurl));
5013: return '/'.$udom.'/'.$uname;
5014: }
5015:
5016: sub is_course {
5017: my ($cdom,$cnum) = @_;
5018: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
5019: undef,'.');
5020: if (exists($courses{$cdom.'_'.$cnum})) {
5021: return 1;
5022: }
5023: return 0;
5024: }
5025:
5026: # ---------------------------------------------------------- Assign Custom Role
5027:
5028: sub assigncustomrole {
5029: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
5030: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
5031: $end,$start,$deleteflag);
5032: }
5033:
5034: # ----------------------------------------------------------------- Revoke Role
5035:
5036: sub revokerole {
5037: my ($udom,$uname,$url,$role,$deleteflag)=@_;
5038: my $now=time;
5039: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
5040: }
5041:
5042: # ---------------------------------------------------------- Revoke Custom Role
5043:
5044: sub revokecustomrole {
5045: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
5046: my $now=time;
5047: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
5048: $deleteflag);
5049: }
5050:
5051: # ------------------------------------------------------------ Disk usage
5052: sub diskusage {
5053: my ($udom,$uname,$directoryRoot)=@_;
5054: $directoryRoot =~ s/\/$//;
5055: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
5056: return $listing;
5057: }
5058:
5059: sub is_locked {
5060: my ($file_name, $domain, $user) = @_;
5061: my @check;
5062: my $is_locked;
5063: push @check, $file_name;
5064: my %locked = &get('file_permissions',\@check,
5065: $env{'user.domain'},$env{'user.name'});
5066: my ($tmp)=keys(%locked);
5067: if ($tmp=~/^error:/) { undef(%locked); }
5068:
5069: if (ref($locked{$file_name}) eq 'ARRAY') {
5070: $is_locked = 'false';
5071: foreach my $entry (@{$locked{$file_name}}) {
5072: if (ref($entry) eq 'ARRAY') {
5073: $is_locked = 'true';
5074: last;
5075: }
5076: }
5077: } else {
5078: $is_locked = 'false';
5079: }
5080: }
5081:
5082: sub declutter_portfile {
5083: my ($file) = @_;
5084: &logthis("got $file");
5085: $file =~ s-^(/portfolio/|portfolio/)-/-;
5086: &logthis("ret $file");
5087: return $file;
5088: }
5089:
5090: # ------------------------------------------------------------- Mark as Read Only
5091:
5092: sub mark_as_readonly {
5093: my ($domain,$user,$files,$what) = @_;
5094: my %current_permissions = &dump('file_permissions',$domain,$user);
5095: my ($tmp)=keys(%current_permissions);
5096: if ($tmp=~/^error:/) { undef(%current_permissions); }
5097: foreach my $file (@{$files}) {
5098: $file = &declutter_portfile($file);
5099: push(@{$current_permissions{$file}},$what);
5100: }
5101: &put('file_permissions',\%current_permissions,$domain,$user);
5102: return;
5103: }
5104:
5105: # ------------------------------------------------------------Save Selected Files
5106:
5107: sub save_selected_files {
5108: my ($user, $path, @files) = @_;
5109: my $filename = $user."savedfiles";
5110: my @other_files = &files_not_in_path($user, $path);
5111: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5112: foreach my $file (@files) {
5113: print (OUT $env{'form.currentpath'}.$file."\n");
5114: }
5115: foreach my $file (@other_files) {
5116: print (OUT $file."\n");
5117: }
5118: close (OUT);
5119: return 'ok';
5120: }
5121:
5122: sub clear_selected_files {
5123: my ($user) = @_;
5124: my $filename = $user."savedfiles";
5125: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5126: print (OUT undef);
5127: close (OUT);
5128: return ("ok");
5129: }
5130:
5131: sub files_in_path {
5132: my ($user, $path) = @_;
5133: my $filename = $user."savedfiles";
5134: my %return_files;
5135: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5136: while (my $line_in = <IN>) {
5137: chomp ($line_in);
5138: my @paths_and_file = split (m!/!, $line_in);
5139: my $file_part = pop (@paths_and_file);
5140: my $path_part = join ('/', @paths_and_file);
5141: $path_part.='/';
5142: my $path_and_file = $path_part.$file_part;
5143: if ($path_part eq $path) {
5144: $return_files{$file_part}= 'selected';
5145: }
5146: }
5147: close (IN);
5148: return (\%return_files);
5149: }
5150:
5151: # called in portfolio select mode, to show files selected NOT in current directory
5152: sub files_not_in_path {
5153: my ($user, $path) = @_;
5154: my $filename = $user."savedfiles";
5155: my @return_files;
5156: my $path_part;
5157: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5158: while (my $line = <IN>) {
5159: #ok, I know it's clunky, but I want it to work
5160: my @paths_and_file = split(m|/|, $line);
5161: my $file_part = pop(@paths_and_file);
5162: chomp($file_part);
5163: my $path_part = join('/', @paths_and_file);
5164: $path_part .= '/';
5165: my $path_and_file = $path_part.$file_part;
5166: if ($path_part ne $path) {
5167: push(@return_files, ($path_and_file));
5168: }
5169: }
5170: close(OUT);
5171: return (@return_files);
5172: }
5173:
5174: #----------------------------------------------Get portfolio file permissions
5175:
5176: sub get_portfile_permissions {
5177: my ($domain,$user) = @_;
5178: my %current_permissions = &dump('file_permissions',$domain,$user);
5179: my ($tmp)=keys(%current_permissions);
5180: if ($tmp=~/^error:/) { undef(%current_permissions); }
5181: return \%current_permissions;
5182: }
5183:
5184: #---------------------------------------------Get portfolio file access controls
5185:
5186: sub get_access_controls {
5187: my ($current_permissions,$group,$file) = @_;
5188: my %access;
5189: my $real_file = $file;
5190: $file =~ s/\.meta$//;
5191: if (defined($file)) {
5192: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5193: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5194: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5195: }
5196: }
5197: } else {
5198: foreach my $key (keys(%{$current_permissions})) {
5199: if ($key =~ /\0accesscontrol$/) {
5200: if (defined($group)) {
5201: if ($key !~ m-^\Q$group\E/-) {
5202: next;
5203: }
5204: }
5205: my ($fullpath) = split(/\0/,$key);
5206: if (ref($$current_permissions{$key}) eq 'HASH') {
5207: foreach my $control (keys(%{$$current_permissions{$key}})) {
5208: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5209: }
5210: }
5211: }
5212: }
5213: }
5214: return %access;
5215: }
5216:
5217: sub modify_access_controls {
5218: my ($file_name,$changes,$domain,$user)=@_;
5219: my ($outcome,$deloutcome);
5220: my %store_permissions;
5221: my %new_values;
5222: my %new_control;
5223: my %translation;
5224: my @deletions = ();
5225: my $now = time;
5226: if (exists($$changes{'activate'})) {
5227: if (ref($$changes{'activate'}) eq 'HASH') {
5228: my @newitems = sort(keys(%{$$changes{'activate'}}));
5229: my $numnew = scalar(@newitems);
5230: for (my $i=0; $i<$numnew; $i++) {
5231: my $newkey = $newitems[$i];
5232: my $newid = &Apache::loncommon::get_cgi_id();
5233: if ($newkey =~ /^\d+:/) {
5234: $newkey =~ s/^(\d+)/$newid/;
5235: $translation{$1} = $newid;
5236: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5237: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5238: $translation{$1} = $newid;
5239: }
5240: $new_values{$file_name."\0".$newkey} =
5241: $$changes{'activate'}{$newitems[$i]};
5242: $new_control{$newkey} = $now;
5243: }
5244: }
5245: }
5246: my %todelete;
5247: my %changed_items;
5248: foreach my $action ('delete','update') {
5249: if (exists($$changes{$action})) {
5250: if (ref($$changes{$action}) eq 'HASH') {
5251: foreach my $key (keys(%{$$changes{$action}})) {
5252: my ($itemnum) = ($key =~ /^([^:]+):/);
5253: if ($action eq 'delete') {
5254: $todelete{$itemnum} = 1;
5255: } else {
5256: $changed_items{$itemnum} = $key;
5257: }
5258: }
5259: }
5260: }
5261: }
5262: # get lock on access controls for file.
5263: my $lockhash = {
5264: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5265: ':'.$env{'user.domain'},
5266: };
5267: my $tries = 0;
5268: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5269:
5270: while (($gotlock ne 'ok') && $tries <3) {
5271: $tries ++;
5272: sleep 1;
5273: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5274: }
5275: if ($gotlock eq 'ok') {
5276: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5277: my ($tmp)=keys(%curr_permissions);
5278: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5279: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5280: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5281: if (ref($curr_controls) eq 'HASH') {
5282: foreach my $control_item (keys(%{$curr_controls})) {
5283: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5284: if (defined($todelete{$itemnum})) {
5285: push(@deletions,$file_name."\0".$control_item);
5286: } else {
5287: if (defined($changed_items{$itemnum})) {
5288: $new_control{$changed_items{$itemnum}} = $now;
5289: push(@deletions,$file_name."\0".$control_item);
5290: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5291: } else {
5292: $new_control{$control_item} = $$curr_controls{$control_item};
5293: }
5294: }
5295: }
5296: }
5297: }
5298: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5299: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5300: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5301: # remove lock
5302: my @del_lock = ($file_name."\0".'locked_access_records');
5303: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5304: my ($file,$group);
5305: if (&is_course($domain,$user)) {
5306: ($group,$file) = split(/\//,$file_name,2);
5307: } else {
5308: $file = $file_name;
5309: }
5310: my $sqlresult =
5311: &update_portfolio_table($user,$domain,$file,'portfolio_access',
5312: $group);
5313: } else {
5314: $outcome = "error: could not obtain lockfile\n";
5315: }
5316: return ($outcome,$deloutcome,\%new_values,\%translation);
5317: }
5318:
5319: sub make_public_indefinitely {
5320: my ($requrl) = @_;
5321: my $now = time;
5322: my $action = 'activate';
5323: my $aclnum = 0;
5324: if (&is_portfolio_url($requrl)) {
5325: my (undef,$udom,$unum,$file_name,$group) =
5326: &parse_portfolio_url($requrl);
5327: my $current_perms = &get_portfile_permissions($udom,$unum);
5328: my %access_controls = &get_access_controls($current_perms,
5329: $group,$file_name);
5330: foreach my $key (keys(%{$access_controls{$file_name}})) {
5331: my ($num,$scope,$end,$start) =
5332: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5333: if ($scope eq 'public') {
5334: if ($start <= $now && $end == 0) {
5335: $action = 'none';
5336: } else {
5337: $action = 'update';
5338: $aclnum = $num;
5339: }
5340: last;
5341: }
5342: }
5343: if ($action eq 'none') {
5344: return 'ok';
5345: } else {
5346: my %changes;
5347: my $newend = 0;
5348: my $newstart = $now;
5349: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
5350: $changes{$action}{$newkey} = {
5351: type => 'public',
5352: time => {
5353: start => $newstart,
5354: end => $newend,
5355: },
5356: };
5357: my ($outcome,$deloutcome,$new_values,$translation) =
5358: &modify_access_controls($file_name,\%changes,$udom,$unum);
5359: return $outcome;
5360: }
5361: } else {
5362: return 'invalid';
5363: }
5364: }
5365:
5366: #------------------------------------------------------Get Marked as Read Only
5367:
5368: sub get_marked_as_readonly {
5369: my ($domain,$user,$what,$group) = @_;
5370: my $current_permissions = &get_portfile_permissions($domain,$user);
5371: my @readonly_files;
5372: my $cmp1=$what;
5373: if (ref($what)) { $cmp1=join('',@{$what}) };
5374: while (my ($file_name,$value) = each(%{$current_permissions})) {
5375: if (defined($group)) {
5376: if ($file_name !~ m-^\Q$group\E/-) {
5377: next;
5378: }
5379: }
5380: if (ref($value) eq "ARRAY"){
5381: foreach my $stored_what (@{$value}) {
5382: my $cmp2=$stored_what;
5383: if (ref($stored_what) eq 'ARRAY') {
5384: $cmp2=join('',@{$stored_what});
5385: }
5386: if ($cmp1 eq $cmp2) {
5387: push(@readonly_files, $file_name);
5388: last;
5389: } elsif (!defined($what)) {
5390: push(@readonly_files, $file_name);
5391: last;
5392: }
5393: }
5394: }
5395: }
5396: return @readonly_files;
5397: }
5398: #-----------------------------------------------------------Get Marked as Read Only Hash
5399:
5400: sub get_marked_as_readonly_hash {
5401: my ($current_permissions,$group,$what) = @_;
5402: my %readonly_files;
5403: while (my ($file_name,$value) = each(%{$current_permissions})) {
5404: if (defined($group)) {
5405: if ($file_name !~ m-^\Q$group\E/-) {
5406: next;
5407: }
5408: }
5409: if (ref($value) eq "ARRAY"){
5410: foreach my $stored_what (@{$value}) {
5411: if (ref($stored_what) eq 'ARRAY') {
5412: foreach my $lock_descriptor(@{$stored_what}) {
5413: if ($lock_descriptor eq 'graded') {
5414: $readonly_files{$file_name} = 'graded';
5415: } elsif ($lock_descriptor eq 'handback') {
5416: $readonly_files{$file_name} = 'handback';
5417: } else {
5418: if (!exists($readonly_files{$file_name})) {
5419: $readonly_files{$file_name} = 'locked';
5420: }
5421: }
5422: }
5423: }
5424: }
5425: }
5426: }
5427: return %readonly_files;
5428: }
5429: # ------------------------------------------------------------ Unmark as Read Only
5430:
5431: sub unmark_as_readonly {
5432: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5433: # for portfolio submissions, $what contains [$symb,$crsid]
5434: my ($domain,$user,$what,$file_name,$group) = @_;
5435: $file_name = &declutter_portfile($file_name);
5436: my $symb_crs = $what;
5437: if (ref($what)) { $symb_crs=join('',@$what); }
5438: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5439: my ($tmp)=keys(%current_permissions);
5440: if ($tmp=~/^error:/) { undef(%current_permissions); }
5441: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5442: foreach my $file (@readonly_files) {
5443: my $clean_file = &declutter_portfile($file);
5444: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5445: my $current_locks = $current_permissions{$file};
5446: my @new_locks;
5447: my @del_keys;
5448: if (ref($current_locks) eq "ARRAY"){
5449: foreach my $locker (@{$current_locks}) {
5450: my $compare=$locker;
5451: if (ref($locker) eq 'ARRAY') {
5452: $compare=join('',@{$locker});
5453: if ($compare ne $symb_crs) {
5454: push(@new_locks, $locker);
5455: }
5456: }
5457: }
5458: if (scalar(@new_locks) > 0) {
5459: $current_permissions{$file} = \@new_locks;
5460: } else {
5461: push(@del_keys, $file);
5462: &del('file_permissions',\@del_keys, $domain, $user);
5463: delete($current_permissions{$file});
5464: }
5465: }
5466: }
5467: &put('file_permissions',\%current_permissions,$domain,$user);
5468: return;
5469: }
5470:
5471: # ------------------------------------------------------------ Directory lister
5472:
5473: sub dirlist {
5474: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5475:
5476: $uri=~s/^\///;
5477: $uri=~s/\/$//;
5478: my ($udom, $uname);
5479: (undef,$udom,$uname)=split(/\//,$uri);
5480: if(defined($userdomain)) {
5481: $udom = $userdomain;
5482: }
5483: if(defined($username)) {
5484: $uname = $username;
5485: }
5486:
5487: my $dirRoot = $perlvar{'lonDocRoot'};
5488: if(defined($alternateDirectoryRoot)) {
5489: $dirRoot = $alternateDirectoryRoot;
5490: $dirRoot =~ s/\/$//;
5491: }
5492:
5493: if($udom) {
5494: if($uname) {
5495: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
5496: &homeserver($uname,$udom));
5497: my @listing_results;
5498: if ($listing eq 'unknown_cmd') {
5499: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
5500: &homeserver($uname,$udom));
5501: @listing_results = split(/:/,$listing);
5502: } else {
5503: @listing_results = map { &unescape($_); } split(/:/,$listing);
5504: }
5505: return @listing_results;
5506: } elsif(!defined($alternateDirectoryRoot)) {
5507: my %allusers;
5508: foreach my $tryserver (keys(%libserv)) {
5509: if($hostdom{$tryserver} eq $udom) {
5510: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5511: $udom, $tryserver);
5512: my @listing_results;
5513: if ($listing eq 'unknown_cmd') {
5514: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5515: $udom, $tryserver);
5516: @listing_results = split(/:/,$listing);
5517: } else {
5518: @listing_results =
5519: map { &unescape($_); } split(/:/,$listing);
5520: }
5521: if ($listing_results[0] ne 'no_such_dir' &&
5522: $listing_results[0] ne 'empty' &&
5523: $listing_results[0] ne 'con_lost') {
5524: foreach my $line (@listing_results) {
5525: my ($entry) = split(/&/,$line,2);
5526: $allusers{$entry} = 1;
5527: }
5528: }
5529: }
5530: }
5531: my $alluserstr='';
5532: foreach my $user (sort(keys(%allusers))) {
5533: $alluserstr.=$user.'&user:';
5534: }
5535: $alluserstr=~s/:$//;
5536: return split(/:/,$alluserstr);
5537: } else {
5538: return ('missing user name');
5539: }
5540: } elsif(!defined($alternateDirectoryRoot)) {
5541: my $tryserver;
5542: my %alldom=();
5543: foreach $tryserver (keys(%libserv)) {
5544: $alldom{$hostdom{$tryserver}}=1;
5545: }
5546: my $alldomstr='';
5547: foreach my $domain (sort(keys(%alldom))) {
5548: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain:';
5549: }
5550: $alldomstr=~s/:$//;
5551: return split(/:/,$alldomstr);
5552: } else {
5553: return ('missing domain');
5554: }
5555: }
5556:
5557: # --------------------------------------------- GetFileTimestamp
5558: # This function utilizes dirlist and returns the date stamp for
5559: # when it was last modified. It will also return an error of -1
5560: # if an error occurs
5561:
5562: ##
5563: ## FIXME: This subroutine assumes its caller knows something about the
5564: ## directory structure of the home server for the student ($root).
5565: ## Not a good assumption to make. Since this is for looking up files
5566: ## in user directories, the full path should be constructed by lond, not
5567: ## whatever machine we request data from.
5568: ##
5569: sub GetFileTimestamp {
5570: my ($studentDomain,$studentName,$filename,$root)=@_;
5571: $studentDomain = &LONCAPA::clean_domain($studentDomain);
5572: $studentName = &LONCAPA::clean_username($studentName);
5573: my $subdir=$studentName.'__';
5574: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5575: my $proname="$studentDomain/$subdir/$studentName";
5576: $proname .= '/'.$filename;
5577: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5578: $studentName, $root);
5579: my @stats = split('&', $fileStat);
5580: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5581: # @stats contains first the filename, then the stat output
5582: return $stats[10]; # so this is 10 instead of 9.
5583: } else {
5584: return -1;
5585: }
5586: }
5587:
5588: sub stat_file {
5589: my ($uri) = @_;
5590: $uri = &clutter_with_no_wrapper($uri);
5591:
5592: my ($udom,$uname,$file,$dir);
5593: if ($uri =~ m-^/(uploaded|editupload)/-) {
5594: ($udom,$uname,$file) =
5595: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
5596: $file = 'userfiles/'.$file;
5597: $dir = &propath($udom,$uname);
5598: }
5599: if ($uri =~ m-^/res/-) {
5600: ($udom,$uname) =
5601: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
5602: $file = $uri;
5603: }
5604:
5605: if (!$udom || !$uname || !$file) {
5606: # unable to handle the uri
5607: return ();
5608: }
5609:
5610: my ($result) = &dirlist($file,$udom,$uname,$dir);
5611: my @stats = split('&', $result);
5612:
5613: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5614: shift(@stats); #filename is first
5615: return @stats;
5616: }
5617: return ();
5618: }
5619:
5620: # -------------------------------------------------------- Value of a Condition
5621:
5622: # gets the value of a specific preevaluated condition
5623: # stored in the string $env{user.state.<cid>}
5624: # or looks up a condition reference in the bighash and if if hasn't
5625: # already been evaluated recurses into docondval to get the value of
5626: # the condition, then memoizing it to
5627: # $env{user.state.<cid>.<condition>}
5628: sub directcondval {
5629: my $number=shift;
5630: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5631: &Apache::lonuserstate::evalstate();
5632: }
5633: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5634: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5635: } elsif ($number =~ /^_/) {
5636: my $sub_condition;
5637: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5638: &GDBM_READER(),0640)) {
5639: $sub_condition=$bighash{'conditions'.$number};
5640: untie(%bighash);
5641: }
5642: my $value = &docondval($sub_condition);
5643: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5644: return $value;
5645: }
5646: if ($env{'user.state.'.$env{'request.course.id'}}) {
5647: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5648: } else {
5649: return 2;
5650: }
5651: }
5652:
5653: # get the collection of conditions for this resource
5654: sub condval {
5655: my $condidx=shift;
5656: my $allpathcond='';
5657: foreach my $cond (split(/\|/,$condidx)) {
5658: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5659: $allpathcond.=
5660: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5661: }
5662: }
5663: $allpathcond=~s/\|$//;
5664: return &docondval($allpathcond);
5665: }
5666:
5667: #evaluates an expression of conditions
5668: sub docondval {
5669: my ($allpathcond) = @_;
5670: my $result=0;
5671: if ($env{'request.course.id'}
5672: && defined($allpathcond)) {
5673: my $operand='|';
5674: my @stack;
5675: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5676: if ($chunk eq '(') {
5677: push @stack,($operand,$result);
5678: } elsif ($chunk eq ')') {
5679: my $before=pop @stack;
5680: if (pop @stack eq '&') {
5681: $result=$result>$before?$before:$result;
5682: } else {
5683: $result=$result>$before?$result:$before;
5684: }
5685: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5686: $operand=$chunk;
5687: } else {
5688: my $new=directcondval($chunk);
5689: if ($operand eq '&') {
5690: $result=$result>$new?$new:$result;
5691: } else {
5692: $result=$result>$new?$result:$new;
5693: }
5694: }
5695: }
5696: }
5697: return $result;
5698: }
5699:
5700: # ---------------------------------------------------- Devalidate courseresdata
5701:
5702: sub devalidatecourseresdata {
5703: my ($coursenum,$coursedomain)=@_;
5704: my $hashid=$coursenum.':'.$coursedomain;
5705: &devalidate_cache_new('courseres',$hashid);
5706: }
5707:
5708:
5709: # --------------------------------------------------- Course Resourcedata Query
5710:
5711: sub get_courseresdata {
5712: my ($coursenum,$coursedomain)=@_;
5713: my $coursehom=&homeserver($coursenum,$coursedomain);
5714: my $hashid=$coursenum.':'.$coursedomain;
5715: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5716: my %dumpreply;
5717: unless (defined($cached)) {
5718: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5719: $result=\%dumpreply;
5720: my ($tmp) = keys(%dumpreply);
5721: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5722: &do_cache_new('courseres',$hashid,$result,600);
5723: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5724: return $tmp;
5725: } elsif ($tmp =~ /^(error)/) {
5726: $result=undef;
5727: &do_cache_new('courseres',$hashid,$result,600);
5728: }
5729: }
5730: return $result;
5731: }
5732:
5733: sub devalidateuserresdata {
5734: my ($uname,$udom)=@_;
5735: my $hashid="$udom:$uname";
5736: &devalidate_cache_new('userres',$hashid);
5737: }
5738:
5739: sub get_userresdata {
5740: my ($uname,$udom)=@_;
5741: #most student don\'t have any data set, check if there is some data
5742: if (&EXT_cache_status($udom,$uname)) { return undef; }
5743:
5744: my $hashid="$udom:$uname";
5745: my ($result,$cached)=&is_cached_new('userres',$hashid);
5746: if (!defined($cached)) {
5747: my %resourcedata=&dump('resourcedata',$udom,$uname);
5748: $result=\%resourcedata;
5749: &do_cache_new('userres',$hashid,$result,600);
5750: }
5751: my ($tmp)=keys(%$result);
5752: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5753: return $result;
5754: }
5755: #error 2 occurs when the .db doesn't exist
5756: if ($tmp!~/error: 2 /) {
5757: &logthis("<font color=\"blue\">WARNING:".
5758: " Trying to get resource data for ".
5759: $uname." at ".$udom.": ".
5760: $tmp."</font>");
5761: } elsif ($tmp=~/error: 2 /) {
5762: #&EXT_cache_set($udom,$uname);
5763: &do_cache_new('userres',$hashid,undef,600);
5764: undef($tmp); # not really an error so don't send it back
5765: }
5766: return $tmp;
5767: }
5768:
5769: sub resdata {
5770: my ($name,$domain,$type,@which)=@_;
5771: my $result;
5772: if ($type eq 'course') {
5773: $result=&get_courseresdata($name,$domain);
5774: } elsif ($type eq 'user') {
5775: $result=&get_userresdata($name,$domain);
5776: }
5777: if (!ref($result)) { return $result; }
5778: foreach my $item (@which) {
5779: if (defined($result->{$item})) {
5780: return $result->{$item};
5781: }
5782: }
5783: return undef;
5784: }
5785:
5786: #
5787: # EXT resource caching routines
5788: #
5789:
5790: sub clear_EXT_cache_status {
5791: &delenv('cache.EXT.');
5792: }
5793:
5794: sub EXT_cache_status {
5795: my ($target_domain,$target_user) = @_;
5796: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5797: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5798: # We know already the user has no data
5799: return 1;
5800: } else {
5801: return 0;
5802: }
5803: }
5804:
5805: sub EXT_cache_set {
5806: my ($target_domain,$target_user) = @_;
5807: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5808: #&appenv($cachename => time);
5809: }
5810:
5811: # --------------------------------------------------------- Value of a Variable
5812: sub EXT {
5813:
5814: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5815: unless ($varname) { return ''; }
5816: #get real user name/domain, courseid and symb
5817: my $courseid;
5818: my $publicuser;
5819: if ($symbparm) {
5820: $symbparm=&get_symb_from_alias($symbparm);
5821: }
5822: if (!($uname && $udom)) {
5823: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
5824: if (!$symbparm) { $symbparm=$cursymb; }
5825: } else {
5826: $courseid=$env{'request.course.id'};
5827: }
5828: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5829: my $rest;
5830: if (defined($therest[0])) {
5831: $rest=join('.',@therest);
5832: } else {
5833: $rest='';
5834: }
5835:
5836: my $qualifierrest=$qualifier;
5837: if ($rest) { $qualifierrest.='.'.$rest; }
5838: my $spacequalifierrest=$space;
5839: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5840: if ($realm eq 'user') {
5841: # --------------------------------------------------------------- user.resource
5842: if ($space eq 'resource') {
5843: if ( (defined($Apache::lonhomework::parsing_a_problem)
5844: || defined($Apache::lonhomework::parsing_a_task))
5845: &&
5846: ($symbparm eq &symbread()) ) {
5847: # if we are in the middle of processing the resource the
5848: # get the value we are planning on committing
5849: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5850: return $Apache::lonhomework::results{$qualifierrest};
5851: } else {
5852: return $Apache::lonhomework::history{$qualifierrest};
5853: }
5854: } else {
5855: my %restored;
5856: if ($publicuser || $env{'request.state'} eq 'construct') {
5857: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5858: } else {
5859: %restored=&restore($symbparm,$courseid,$udom,$uname);
5860: }
5861: return $restored{$qualifierrest};
5862: }
5863: # ----------------------------------------------------------------- user.access
5864: } elsif ($space eq 'access') {
5865: # FIXME - not supporting calls for a specific user
5866: return &allowed($qualifier,$rest);
5867: # ------------------------------------------ user.preferences, user.environment
5868: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5869: if (($uname eq $env{'user.name'}) &&
5870: ($udom eq $env{'user.domain'})) {
5871: return $env{join('.',('environment',$qualifierrest))};
5872: } else {
5873: my %returnhash;
5874: if (!$publicuser) {
5875: %returnhash=&userenvironment($udom,$uname,
5876: $qualifierrest);
5877: }
5878: return $returnhash{$qualifierrest};
5879: }
5880: # ----------------------------------------------------------------- user.course
5881: } elsif ($space eq 'course') {
5882: # FIXME - not supporting calls for a specific user
5883: return $env{join('.',('request.course',$qualifier))};
5884: # ------------------------------------------------------------------- user.role
5885: } elsif ($space eq 'role') {
5886: # FIXME - not supporting calls for a specific user
5887: my ($role,$where)=split(/\./,$env{'request.role'});
5888: if ($qualifier eq 'value') {
5889: return $role;
5890: } elsif ($qualifier eq 'extent') {
5891: return $where;
5892: }
5893: # ----------------------------------------------------------------- user.domain
5894: } elsif ($space eq 'domain') {
5895: return $udom;
5896: # ------------------------------------------------------------------- user.name
5897: } elsif ($space eq 'name') {
5898: return $uname;
5899: # ---------------------------------------------------- Any other user namespace
5900: } else {
5901: my %reply;
5902: if (!$publicuser) {
5903: %reply=&get($space,[$qualifierrest],$udom,$uname);
5904: }
5905: return $reply{$qualifierrest};
5906: }
5907: } elsif ($realm eq 'query') {
5908: # ---------------------------------------------- pull stuff out of query string
5909: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5910: [$spacequalifierrest]);
5911: return $env{'form.'.$spacequalifierrest};
5912: } elsif ($realm eq 'request') {
5913: # ------------------------------------------------------------- request.browser
5914: if ($space eq 'browser') {
5915: if ($qualifier eq 'textremote') {
5916: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5917: return 1;
5918: } else {
5919: return 0;
5920: }
5921: } else {
5922: return $env{'browser.'.$qualifier};
5923: }
5924: # ------------------------------------------------------------ request.filename
5925: } else {
5926: return $env{'request.'.$spacequalifierrest};
5927: }
5928: } elsif ($realm eq 'course') {
5929: # ---------------------------------------------------------- course.description
5930: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5931: } elsif ($realm eq 'resource') {
5932:
5933: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5934: if (!$symbparm) { $symbparm=&symbread(); }
5935: }
5936:
5937: if ($space eq 'title') {
5938: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5939: return &gettitle($symbparm);
5940: }
5941:
5942: if ($space eq 'map') {
5943: my ($map) = &decode_symb($symbparm);
5944: return &symbread($map);
5945: }
5946:
5947: my ($section, $group, @groups);
5948: my ($courselevelm,$courselevel);
5949: if ($symbparm && defined($courseid) &&
5950: $courseid eq $env{'request.course.id'}) {
5951:
5952: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5953:
5954: # ----------------------------------------------------- Cascading lookup scheme
5955: my $symbp=$symbparm;
5956: my $mapp=&deversion((&decode_symb($symbp))[0]);
5957:
5958: my $symbparm=$symbp.'.'.$spacequalifierrest;
5959: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5960:
5961: if (($env{'user.name'} eq $uname) &&
5962: ($env{'user.domain'} eq $udom)) {
5963: $section=$env{'request.course.sec'};
5964: @groups = split(/:/,$env{'request.course.groups'});
5965: @groups=&sort_course_groups($courseid,@groups);
5966: } else {
5967: if (! defined($usection)) {
5968: $section=&getsection($udom,$uname,$courseid);
5969: } else {
5970: $section = $usection;
5971: }
5972: @groups = &get_users_groups($udom,$uname,$courseid);
5973: }
5974:
5975: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5976: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5977: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5978:
5979: $courselevel=$courseid.'.'.$spacequalifierrest;
5980: my $courselevelr=$courseid.'.'.$symbparm;
5981: $courselevelm=$courseid.'.'.$mapparm;
5982:
5983: # ----------------------------------------------------------- first, check user
5984:
5985: my $userreply=&resdata($uname,$udom,'user',
5986: ($courselevelr,$courselevelm,
5987: $courselevel));
5988: if (defined($userreply)) { return $userreply; }
5989:
5990: # ------------------------------------------------ second, check some of course
5991: my $coursereply;
5992: if (@groups > 0) {
5993: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5994: $mapparm,$spacequalifierrest);
5995: if (defined($coursereply)) { return $coursereply; }
5996: }
5997:
5998: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5999: $env{'course.'.$courseid.'.domain'},
6000: 'course',
6001: ($seclevelr,$seclevelm,$seclevel,
6002: $courselevelr));
6003: if (defined($coursereply)) { return $coursereply; }
6004:
6005: # ------------------------------------------------------ third, check map parms
6006: my %parmhash=();
6007: my $thisparm='';
6008: if (tie(%parmhash,'GDBM_File',
6009: $env{'request.course.fn'}.'_parms.db',
6010: &GDBM_READER(),0640)) {
6011: $thisparm=$parmhash{$symbparm};
6012: untie(%parmhash);
6013: }
6014: if ($thisparm) { return $thisparm; }
6015: }
6016: # ------------------------------------------ fourth, look in resource metadata
6017:
6018: $spacequalifierrest=~s/\./\_/;
6019: my $filename;
6020: if (!$symbparm) { $symbparm=&symbread(); }
6021: if ($symbparm) {
6022: $filename=(&decode_symb($symbparm))[2];
6023: } else {
6024: $filename=$env{'request.filename'};
6025: }
6026: my $metadata=&metadata($filename,$spacequalifierrest);
6027: if (defined($metadata)) { return $metadata; }
6028: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
6029: if (defined($metadata)) { return $metadata; }
6030:
6031: # ---------------------------------------------- fourth, look in rest pf course
6032: if ($symbparm && defined($courseid) &&
6033: $courseid eq $env{'request.course.id'}) {
6034: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6035: $env{'course.'.$courseid.'.domain'},
6036: 'course',
6037: ($courselevelm,$courselevel));
6038: if (defined($coursereply)) { return $coursereply; }
6039: }
6040: # ------------------------------------------------------------------ Cascade up
6041: unless ($space eq '0') {
6042: my @parts=split(/_/,$space);
6043: my $id=pop(@parts);
6044: my $part=join('_',@parts);
6045: if ($part eq '') { $part='0'; }
6046: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
6047: $symbparm,$udom,$uname,$section,1);
6048: if (defined($partgeneral)) { return $partgeneral; }
6049: }
6050: if ($recurse) { return undef; }
6051: my $pack_def=&packages_tab_default($filename,$varname);
6052: if (defined($pack_def)) { return $pack_def; }
6053:
6054: # ---------------------------------------------------- Any other user namespace
6055: } elsif ($realm eq 'environment') {
6056: # ----------------------------------------------------------------- environment
6057: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
6058: return $env{'environment.'.$spacequalifierrest};
6059: } else {
6060: if ($uname eq 'anonymous' && $udom eq '') {
6061: return '';
6062: }
6063: my %returnhash=&userenvironment($udom,$uname,
6064: $spacequalifierrest);
6065: return $returnhash{$spacequalifierrest};
6066: }
6067: } elsif ($realm eq 'system') {
6068: # ----------------------------------------------------------------- system.time
6069: if ($space eq 'time') {
6070: return time;
6071: }
6072: } elsif ($realm eq 'server') {
6073: # ----------------------------------------------------------------- system.time
6074: if ($space eq 'name') {
6075: return $ENV{'SERVER_NAME'};
6076: }
6077: }
6078: return '';
6079: }
6080:
6081: sub check_group_parms {
6082: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
6083: my @groupitems = ();
6084: my $resultitem;
6085: my @levels = ($symbparm,$mapparm,$what);
6086: foreach my $group (@{$groups}) {
6087: foreach my $level (@levels) {
6088: my $item = $courseid.'.['.$group.'].'.$level;
6089: push(@groupitems,$item);
6090: }
6091: }
6092: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
6093: $env{'course.'.$courseid.'.domain'},
6094: 'course',@groupitems);
6095: return $coursereply;
6096: }
6097:
6098: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
6099: my ($courseid,@groups) = @_;
6100: @groups = sort(@groups);
6101: return @groups;
6102: }
6103:
6104: sub packages_tab_default {
6105: my ($uri,$varname)=@_;
6106: my (undef,$part,$name)=split(/\./,$varname);
6107:
6108: my (@extension,@specifics,$do_default);
6109: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
6110: my ($pack_type,$pack_part)=split(/_/,$package,2);
6111: if ($pack_type eq 'default') {
6112: $do_default=1;
6113: } elsif ($pack_type eq 'extension') {
6114: push(@extension,[$package,$pack_type,$pack_part]);
6115: } else {
6116: push(@specifics,[$package,$pack_type,$pack_part]);
6117: }
6118: }
6119: # first look for a package that matches the requested part id
6120: foreach my $package (@specifics) {
6121: my (undef,$pack_type,$pack_part)=@{$package};
6122: next if ($pack_part ne $part);
6123: if (defined($packagetab{"$pack_type&$name&default"})) {
6124: return $packagetab{"$pack_type&$name&default"};
6125: }
6126: }
6127: # look for any possible matching non extension_ package
6128: foreach my $package (@specifics) {
6129: my (undef,$pack_type,$pack_part)=@{$package};
6130: if (defined($packagetab{"$pack_type&$name&default"})) {
6131: return $packagetab{"$pack_type&$name&default"};
6132: }
6133: if ($pack_type eq 'part') { $pack_part='0'; }
6134: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
6135: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
6136: }
6137: }
6138: # look for any posible extension_ match
6139: foreach my $package (@extension) {
6140: my ($package,$pack_type)=@{$package};
6141: if (defined($packagetab{"$pack_type&$name&default"})) {
6142: return $packagetab{"$pack_type&$name&default"};
6143: }
6144: if (defined($packagetab{$package."&$name&default"})) {
6145: return $packagetab{$package."&$name&default"};
6146: }
6147: }
6148: # look for a global default setting
6149: if ($do_default && defined($packagetab{"default&$name&default"})) {
6150: return $packagetab{"default&$name&default"};
6151: }
6152: return undef;
6153: }
6154:
6155: sub add_prefix_and_part {
6156: my ($prefix,$part)=@_;
6157: my $keyroot;
6158: if (defined($prefix) && $prefix !~ /^__/) {
6159: # prefix that has a part already
6160: $keyroot=$prefix;
6161: } elsif (defined($prefix)) {
6162: # prefix that is missing a part
6163: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6164: } else {
6165: # no prefix at all
6166: if (defined($part)) { $keyroot='_'.$part; }
6167: }
6168: return $keyroot;
6169: }
6170:
6171: # ---------------------------------------------------------------- Get metadata
6172:
6173: my %metaentry;
6174: sub metadata {
6175: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6176: $uri=&declutter($uri);
6177: # if it is a non metadata possible uri return quickly
6178: if (($uri eq '') ||
6179: (($uri =~ m|^/*adm/|) &&
6180: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6181: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
6182: ($uri =~ m|home/$match_username/public_html/|)) {
6183: return undef;
6184: }
6185: my $filename=$uri;
6186: $uri=~s/\.meta$//;
6187: #
6188: # Is the metadata already cached?
6189: # Look at timestamp of caching
6190: # Everything is cached by the main uri, libraries are never directly cached
6191: #
6192: if (!defined($liburi)) {
6193: my ($result,$cached)=&is_cached_new('meta',$uri);
6194: if (defined($cached)) { return $result->{':'.$what}; }
6195: }
6196: {
6197: #
6198: # Is this a recursive call for a library?
6199: #
6200: # if (! exists($metacache{$uri})) {
6201: # $metacache{$uri}={};
6202: # }
6203: if ($liburi) {
6204: $liburi=&declutter($liburi);
6205: $filename=$liburi;
6206: } else {
6207: &devalidate_cache_new('meta',$uri);
6208: undef(%metaentry);
6209: }
6210: my %metathesekeys=();
6211: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
6212: my $metastring;
6213: if ($uri !~ m -^(editupload)/-) {
6214: my $file=&filelocation('',&clutter($filename));
6215: #push(@{$metaentry{$uri.'.file'}},$file);
6216: $metastring=&getfile($file);
6217: }
6218: my $parser=HTML::LCParser->new(\$metastring);
6219: my $token;
6220: undef %metathesekeys;
6221: while ($token=$parser->get_token) {
6222: if ($token->[0] eq 'S') {
6223: if (defined($token->[2]->{'package'})) {
6224: #
6225: # This is a package - get package info
6226: #
6227: my $package=$token->[2]->{'package'};
6228: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6229: if (defined($token->[2]->{'id'})) {
6230: $keyroot.='_'.$token->[2]->{'id'};
6231: }
6232: if ($metaentry{':packages'}) {
6233: $metaentry{':packages'}.=','.$package.$keyroot;
6234: } else {
6235: $metaentry{':packages'}=$package.$keyroot;
6236: }
6237: foreach my $pack_entry (keys(%packagetab)) {
6238: my $part=$keyroot;
6239: $part=~s/^\_//;
6240: if ($pack_entry=~/^\Q$package\E\&/ ||
6241: $pack_entry=~/^\Q$package\E_0\&/) {
6242: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6243: # ignore package.tab specified default values
6244: # here &package_tab_default() will fetch those
6245: if ($subp eq 'default') { next; }
6246: my $value=$packagetab{$pack_entry};
6247: my $unikey;
6248: if ($pack =~ /_0$/) {
6249: $unikey='parameter_0_'.$name;
6250: $part=0;
6251: } else {
6252: $unikey='parameter'.$keyroot.'_'.$name;
6253: }
6254: if ($subp eq 'display') {
6255: $value.=' [Part: '.$part.']';
6256: }
6257: $metaentry{':'.$unikey.'.part'}=$part;
6258: $metathesekeys{$unikey}=1;
6259: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6260: $metaentry{':'.$unikey.'.'.$subp}=$value;
6261: }
6262: if (defined($metaentry{':'.$unikey.'.default'})) {
6263: $metaentry{':'.$unikey}=
6264: $metaentry{':'.$unikey.'.default'};
6265: }
6266: }
6267: }
6268: } else {
6269: #
6270: # This is not a package - some other kind of start tag
6271: #
6272: my $entry=$token->[1];
6273: my $unikey;
6274: if ($entry eq 'import') {
6275: $unikey='';
6276: } else {
6277: $unikey=$entry;
6278: }
6279: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6280:
6281: if (defined($token->[2]->{'id'})) {
6282: $unikey.='_'.$token->[2]->{'id'};
6283: }
6284:
6285: if ($entry eq 'import') {
6286: #
6287: # Importing a library here
6288: #
6289: if ($depthcount<20) {
6290: my $location=$parser->get_text('/import');
6291: my $dir=$filename;
6292: $dir=~s|[^/]*$||;
6293: $location=&filelocation($dir,$location);
6294: my $metadata =
6295: &metadata($uri,'keys', $location,$unikey,
6296: $depthcount+1);
6297: foreach my $meta (split(',',$metadata)) {
6298: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6299: $metathesekeys{$meta}=1;
6300: }
6301: }
6302: } else {
6303:
6304: if (defined($token->[2]->{'name'})) {
6305: $unikey.='_'.$token->[2]->{'name'};
6306: }
6307: $metathesekeys{$unikey}=1;
6308: foreach my $param (@{$token->[3]}) {
6309: $metaentry{':'.$unikey.'.'.$param} =
6310: $token->[2]->{$param};
6311: }
6312: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6313: my $default=$metaentry{':'.$unikey.'.default'};
6314: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6315: # only ws inside the tag, and not in default, so use default
6316: # as value
6317: $metaentry{':'.$unikey}=$default;
6318: } else {
6319: # either something interesting inside the tag or default
6320: # uninteresting
6321: $metaentry{':'.$unikey}=$internaltext;
6322: }
6323: # end of not-a-package not-a-library import
6324: }
6325: # end of not-a-package start tag
6326: }
6327: # the next is the end of "start tag"
6328: }
6329: }
6330: my ($extension) = ($uri =~ /\.(\w+)$/);
6331: foreach my $key (keys(%packagetab)) {
6332: #no specific packages #how's our extension
6333: if ($key!~/^extension_\Q$extension\E&/) { next; }
6334: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6335: \%metathesekeys);
6336: }
6337: if (!exists($metaentry{':packages'})) {
6338: foreach my $key (keys(%packagetab)) {
6339: #no specific packages well let's get default then
6340: if ($key!~/^default&/) { next; }
6341: &metadata_create_package_def($uri,$key,'default',
6342: \%metathesekeys);
6343: }
6344: }
6345: # are there custom rights to evaluate
6346: if ($metaentry{':copyright'} eq 'custom') {
6347:
6348: #
6349: # Importing a rights file here
6350: #
6351: unless ($depthcount) {
6352: my $location=$metaentry{':customdistributionfile'};
6353: my $dir=$filename;
6354: $dir=~s|[^/]*$||;
6355: $location=&filelocation($dir,$location);
6356: my $rights_metadata =
6357: &metadata($uri,'keys',$location,'_rights',
6358: $depthcount+1);
6359: foreach my $rights (split(',',$rights_metadata)) {
6360: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6361: $metathesekeys{$rights}=1;
6362: }
6363: }
6364: }
6365: # uniqifiy package listing
6366: my %seen;
6367: my @uniq_packages =
6368: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6369: $metaentry{':packages'} = join(',',@uniq_packages);
6370:
6371: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6372: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6373: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6374: &do_cache_new('meta',$uri,\%metaentry,60*60);
6375: # this is the end of "was not already recently cached
6376: }
6377: return $metaentry{':'.$what};
6378: }
6379:
6380: sub metadata_create_package_def {
6381: my ($uri,$key,$package,$metathesekeys)=@_;
6382: my ($pack,$name,$subp)=split(/\&/,$key);
6383: if ($subp eq 'default') { next; }
6384:
6385: if (defined($metaentry{':packages'})) {
6386: $metaentry{':packages'}.=','.$package;
6387: } else {
6388: $metaentry{':packages'}=$package;
6389: }
6390: my $value=$packagetab{$key};
6391: my $unikey;
6392: $unikey='parameter_0_'.$name;
6393: $metaentry{':'.$unikey.'.part'}=0;
6394: $$metathesekeys{$unikey}=1;
6395: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6396: $metaentry{':'.$unikey.'.'.$subp}=$value;
6397: }
6398: if (defined($metaentry{':'.$unikey.'.default'})) {
6399: $metaentry{':'.$unikey}=
6400: $metaentry{':'.$unikey.'.default'};
6401: }
6402: }
6403:
6404: sub metadata_generate_part0 {
6405: my ($metadata,$metacache,$uri) = @_;
6406: my %allnames;
6407: foreach my $metakey (keys(%$metadata)) {
6408: if ($metakey=~/^parameter\_(.*)/) {
6409: my $part=$$metacache{':'.$metakey.'.part'};
6410: my $name=$$metacache{':'.$metakey.'.name'};
6411: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6412: $allnames{$name}=$part;
6413: }
6414: }
6415: }
6416: foreach my $name (keys(%allnames)) {
6417: $$metadata{"parameter_0_$name"}=1;
6418: my $key=":parameter_0_$name";
6419: $$metacache{"$key.part"}='0';
6420: $$metacache{"$key.name"}=$name;
6421: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6422: $allnames{$name}.'_'.$name.
6423: '.type'};
6424: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6425: '.display'};
6426: my $expr='[Part: '.$allnames{$name}.']';
6427: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6428: $$metacache{"$key.display"}=$olddis;
6429: }
6430: }
6431:
6432: # ------------------------------------------------------ Devalidate title cache
6433:
6434: sub devalidate_title_cache {
6435: my ($url)=@_;
6436: if (!$env{'request.course.id'}) { return; }
6437: my $symb=&symbread($url);
6438: if (!$symb) { return; }
6439: my $key=$env{'request.course.id'}."\0".$symb;
6440: &devalidate_cache_new('title',$key);
6441: }
6442:
6443: # ------------------------------------------------- Get the title of a resource
6444:
6445: sub gettitle {
6446: my $urlsymb=shift;
6447: my $symb=&symbread($urlsymb);
6448: if ($symb) {
6449: my $key=$env{'request.course.id'}."\0".$symb;
6450: my ($result,$cached)=&is_cached_new('title',$key);
6451: if (defined($cached)) {
6452: return $result;
6453: }
6454: my ($map,$resid,$url)=&decode_symb($symb);
6455: my $title='';
6456: my %bighash;
6457: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6458: &GDBM_READER(),0640)) {
6459: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6460: $title=$bighash{'title_'.$mapid.'.'.$resid};
6461: untie %bighash;
6462: }
6463: $title=~s/\&colon\;/\:/gs;
6464: if ($title) {
6465: return &do_cache_new('title',$key,$title,600);
6466: }
6467: $urlsymb=$url;
6468: }
6469: my $title=&metadata($urlsymb,'title');
6470: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6471: return $title;
6472: }
6473:
6474: sub get_slot {
6475: my ($which,$cnum,$cdom)=@_;
6476: if (!$cnum || !$cdom) {
6477: (undef,my $courseid)=&whichuser();
6478: $cdom=$env{'course.'.$courseid.'.domain'};
6479: $cnum=$env{'course.'.$courseid.'.num'};
6480: }
6481: my $key=join("\0",'slots',$cdom,$cnum,$which);
6482: my %slotinfo;
6483: if (exists($remembered{$key})) {
6484: $slotinfo{$which} = $remembered{$key};
6485: } else {
6486: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6487: &Apache::lonhomework::showhash(%slotinfo);
6488: my ($tmp)=keys(%slotinfo);
6489: if ($tmp=~/^error:/) { return (); }
6490: $remembered{$key} = $slotinfo{$which};
6491: }
6492: if (ref($slotinfo{$which}) eq 'HASH') {
6493: return %{$slotinfo{$which}};
6494: }
6495: return $slotinfo{$which};
6496: }
6497: # ------------------------------------------------- Update symbolic store links
6498:
6499: sub symblist {
6500: my ($mapname,%newhash)=@_;
6501: $mapname=&deversion(&declutter($mapname));
6502: my %hash;
6503: if (($env{'request.course.fn'}) && (%newhash)) {
6504: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6505: &GDBM_WRCREAT(),0640)) {
6506: foreach my $url (keys %newhash) {
6507: next if ($url eq 'last_known'
6508: && $env{'form.no_update_last_known'});
6509: $hash{declutter($url)}=&encode_symb($mapname,
6510: $newhash{$url}->[1],
6511: $newhash{$url}->[0]);
6512: }
6513: if (untie(%hash)) {
6514: return 'ok';
6515: }
6516: }
6517: }
6518: return 'error';
6519: }
6520:
6521: # --------------------------------------------------------------- Verify a symb
6522:
6523: sub symbverify {
6524: my ($symb,$thisurl)=@_;
6525: my $thisfn=$thisurl;
6526: $thisfn=&declutter($thisfn);
6527: # direct jump to resource in page or to a sequence - will construct own symbs
6528: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6529: # check URL part
6530: my ($map,$resid,$url)=&decode_symb($symb);
6531:
6532: unless ($url eq $thisfn) { return 0; }
6533:
6534: $symb=&symbclean($symb);
6535: $thisurl=&deversion($thisurl);
6536: $thisfn=&deversion($thisfn);
6537:
6538: my %bighash;
6539: my $okay=0;
6540:
6541: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6542: &GDBM_READER(),0640)) {
6543: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6544: unless ($ids) {
6545: $ids=$bighash{'ids_/'.$thisurl};
6546: }
6547: if ($ids) {
6548: # ------------------------------------------------------------------- Has ID(s)
6549: foreach my $id (split(/\,/,$ids)) {
6550: my ($mapid,$resid)=split(/\./,$id);
6551: if (
6552: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6553: eq $symb) {
6554: if (($env{'request.role.adv'}) ||
6555: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
6556: $okay=1;
6557: }
6558: }
6559: }
6560: }
6561: untie(%bighash);
6562: }
6563: return $okay;
6564: }
6565:
6566: # --------------------------------------------------------------- Clean-up symb
6567:
6568: sub symbclean {
6569: my $symb=shift;
6570: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6571: # remove version from map
6572: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6573:
6574: # remove version from URL
6575: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6576:
6577: # remove wrapper
6578:
6579: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6580: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6581: return $symb;
6582: }
6583:
6584: # ---------------------------------------------- Split symb to find map and url
6585:
6586: sub encode_symb {
6587: my ($map,$resid,$url)=@_;
6588: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6589: }
6590:
6591: sub decode_symb {
6592: my $symb=shift;
6593: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6594: my ($map,$resid,$url)=split(/___/,$symb);
6595: return (&fixversion($map),$resid,&fixversion($url));
6596: }
6597:
6598: sub fixversion {
6599: my $fn=shift;
6600: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6601: my %bighash;
6602: my $uri=&clutter($fn);
6603: my $key=$env{'request.course.id'}.'_'.$uri;
6604: # is this cached?
6605: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6606: if (defined($cached)) { return $result; }
6607: # unfortunately not cached, or expired
6608: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6609: &GDBM_READER(),0640)) {
6610: if ($bighash{'version_'.$uri}) {
6611: my $version=$bighash{'version_'.$uri};
6612: unless (($version eq 'mostrecent') ||
6613: ($version==&getversion($uri))) {
6614: $uri=~s/\.(\w+)$/\.$version\.$1/;
6615: }
6616: }
6617: untie %bighash;
6618: }
6619: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6620: }
6621:
6622: sub deversion {
6623: my $url=shift;
6624: $url=~s/\.\d+\.(\w+)$/\.$1/;
6625: return $url;
6626: }
6627:
6628: # ------------------------------------------------------ Return symb list entry
6629:
6630: sub symbread {
6631: my ($thisfn,$donotrecurse)=@_;
6632: my $cache_str='request.symbread.cached.'.$thisfn;
6633: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6634: # no filename provided? try from environment
6635: unless ($thisfn) {
6636: if ($env{'request.symb'}) {
6637: return $env{$cache_str}=&symbclean($env{'request.symb'});
6638: }
6639: $thisfn=$env{'request.filename'};
6640: }
6641: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6642: # is that filename actually a symb? Verify, clean, and return
6643: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6644: if (&symbverify($thisfn,$1)) {
6645: return $env{$cache_str}=&symbclean($thisfn);
6646: }
6647: }
6648: $thisfn=declutter($thisfn);
6649: my %hash;
6650: my %bighash;
6651: my $syval='';
6652: if (($env{'request.course.fn'}) && ($thisfn)) {
6653: my $targetfn = $thisfn;
6654: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6655: $targetfn = 'adm/wrapper/'.$thisfn;
6656: }
6657: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6658: $targetfn=$1;
6659: }
6660: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6661: &GDBM_READER(),0640)) {
6662: $syval=$hash{$targetfn};
6663: untie(%hash);
6664: }
6665: # ---------------------------------------------------------- There was an entry
6666: if ($syval) {
6667: #unless ($syval=~/\_\d+$/) {
6668: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6669: #&appenv('request.ambiguous' => $thisfn);
6670: #return $env{$cache_str}='';
6671: #}
6672: #$syval.=$1;
6673: #}
6674: } else {
6675: # ------------------------------------------------------- Was not in symb table
6676: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6677: &GDBM_READER(),0640)) {
6678: # ---------------------------------------------- Get ID(s) for current resource
6679: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6680: unless ($ids) {
6681: $ids=$bighash{'ids_/'.$thisfn};
6682: }
6683: unless ($ids) {
6684: # alias?
6685: $ids=$bighash{'mapalias_'.$thisfn};
6686: }
6687: if ($ids) {
6688: # ------------------------------------------------------------------- Has ID(s)
6689: my @possibilities=split(/\,/,$ids);
6690: if ($#possibilities==0) {
6691: # ----------------------------------------------- There is only one possibility
6692: my ($mapid,$resid)=split(/\./,$ids);
6693: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6694: $resid,$thisfn);
6695: } elsif (!$donotrecurse) {
6696: # ------------------------------------------ There is more than one possibility
6697: my $realpossible=0;
6698: foreach my $id (@possibilities) {
6699: my $file=$bighash{'src_'.$id};
6700: if (&allowed('bre',$file)) {
6701: my ($mapid,$resid)=split(/\./,$id);
6702: if ($bighash{'map_type_'.$mapid} ne 'page') {
6703: $realpossible++;
6704: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6705: $resid,$thisfn);
6706: }
6707: }
6708: }
6709: if ($realpossible!=1) { $syval=''; }
6710: } else {
6711: $syval='';
6712: }
6713: }
6714: untie(%bighash)
6715: }
6716: }
6717: if ($syval) {
6718: return $env{$cache_str}=$syval;
6719: }
6720: }
6721: &appenv('request.ambiguous' => $thisfn);
6722: return $env{$cache_str}='';
6723: }
6724:
6725: # ---------------------------------------------------------- Return random seed
6726:
6727: sub numval {
6728: my $txt=shift;
6729: $txt=~tr/A-J/0-9/;
6730: $txt=~tr/a-j/0-9/;
6731: $txt=~tr/K-T/0-9/;
6732: $txt=~tr/k-t/0-9/;
6733: $txt=~tr/U-Z/0-5/;
6734: $txt=~tr/u-z/0-5/;
6735: $txt=~s/\D//g;
6736: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6737: return int($txt);
6738: }
6739:
6740: sub numval2 {
6741: my $txt=shift;
6742: $txt=~tr/A-J/0-9/;
6743: $txt=~tr/a-j/0-9/;
6744: $txt=~tr/K-T/0-9/;
6745: $txt=~tr/k-t/0-9/;
6746: $txt=~tr/U-Z/0-5/;
6747: $txt=~tr/u-z/0-5/;
6748: $txt=~s/\D//g;
6749: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6750: my $total;
6751: foreach my $val (@txts) { $total+=$val; }
6752: if ($_64bit) { if ($total > 2**32) { return -1; } }
6753: return int($total);
6754: }
6755:
6756: sub numval3 {
6757: use integer;
6758: my $txt=shift;
6759: $txt=~tr/A-J/0-9/;
6760: $txt=~tr/a-j/0-9/;
6761: $txt=~tr/K-T/0-9/;
6762: $txt=~tr/k-t/0-9/;
6763: $txt=~tr/U-Z/0-5/;
6764: $txt=~tr/u-z/0-5/;
6765: $txt=~s/\D//g;
6766: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6767: my $total;
6768: foreach my $val (@txts) { $total+=$val; }
6769: if ($_64bit) { $total=(($total<<32)>>32); }
6770: return $total;
6771: }
6772:
6773: sub digest {
6774: my ($data)=@_;
6775: my $digest=&Digest::MD5::md5($data);
6776: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6777: my ($e,$f);
6778: {
6779: use integer;
6780: $e=($a+$b);
6781: $f=($c+$d);
6782: if ($_64bit) {
6783: $e=(($e<<32)>>32);
6784: $f=(($f<<32)>>32);
6785: }
6786: }
6787: if (wantarray) {
6788: return ($e,$f);
6789: } else {
6790: my $g;
6791: {
6792: use integer;
6793: $g=($e+$f);
6794: if ($_64bit) {
6795: $g=(($g<<32)>>32);
6796: }
6797: }
6798: return $g;
6799: }
6800: }
6801:
6802: sub latest_rnd_algorithm_id {
6803: return '64bit5';
6804: }
6805:
6806: sub get_rand_alg {
6807: my ($courseid)=@_;
6808: if (!$courseid) { $courseid=(&whichuser())[1]; }
6809: if ($courseid) {
6810: return $env{"course.$courseid.rndseed"};
6811: }
6812: return &latest_rnd_algorithm_id();
6813: }
6814:
6815: sub validCODE {
6816: my ($CODE)=@_;
6817: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6818: return 0;
6819: }
6820:
6821: sub getCODE {
6822: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6823: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6824: defined($Apache::lonhomework::parsing_a_task) ) &&
6825: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6826: return $Apache::lonhomework::history{'resource.CODE'};
6827: }
6828: return undef;
6829: }
6830:
6831: sub rndseed {
6832: my ($symb,$courseid,$domain,$username)=@_;
6833:
6834: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
6835: if (!$symb) {
6836: unless ($symb=$wsymb) { return time; }
6837: }
6838: if (!$courseid) { $courseid=$wcourseid; }
6839: if (!$domain) { $domain=$wdomain; }
6840: if (!$username) { $username=$wusername }
6841: my $which=&get_rand_alg();
6842:
6843: if (defined(&getCODE())) {
6844: if ($which eq '64bit5') {
6845: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6846: } elsif ($which eq '64bit4') {
6847: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6848: } else {
6849: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6850: }
6851: } elsif ($which eq '64bit5') {
6852: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6853: } elsif ($which eq '64bit4') {
6854: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6855: } elsif ($which eq '64bit3') {
6856: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6857: } elsif ($which eq '64bit2') {
6858: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6859: } elsif ($which eq '64bit') {
6860: return &rndseed_64bit($symb,$courseid,$domain,$username);
6861: }
6862: return &rndseed_32bit($symb,$courseid,$domain,$username);
6863: }
6864:
6865: sub rndseed_32bit {
6866: my ($symb,$courseid,$domain,$username)=@_;
6867: {
6868: use integer;
6869: my $symbchck=unpack("%32C*",$symb) << 27;
6870: my $symbseed=numval($symb) << 22;
6871: my $namechck=unpack("%32C*",$username) << 17;
6872: my $nameseed=numval($username) << 12;
6873: my $domainseed=unpack("%32C*",$domain) << 7;
6874: my $courseseed=unpack("%32C*",$courseid);
6875: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6876: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6877: #&logthis("rndseed :$num:$symb");
6878: if ($_64bit) { $num=(($num<<32)>>32); }
6879: return $num;
6880: }
6881: }
6882:
6883: sub rndseed_64bit {
6884: my ($symb,$courseid,$domain,$username)=@_;
6885: {
6886: use integer;
6887: my $symbchck=unpack("%32S*",$symb) << 21;
6888: my $symbseed=numval($symb) << 10;
6889: my $namechck=unpack("%32S*",$username);
6890:
6891: my $nameseed=numval($username) << 21;
6892: my $domainseed=unpack("%32S*",$domain) << 10;
6893: my $courseseed=unpack("%32S*",$courseid);
6894:
6895: my $num1=$symbchck+$symbseed+$namechck;
6896: my $num2=$nameseed+$domainseed+$courseseed;
6897: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6898: #&logthis("rndseed :$num:$symb");
6899: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6900: return "$num1,$num2";
6901: }
6902: }
6903:
6904: sub rndseed_64bit2 {
6905: my ($symb,$courseid,$domain,$username)=@_;
6906: {
6907: use integer;
6908: # strings need to be an even # of cahracters long, it it is odd the
6909: # last characters gets thrown away
6910: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6911: my $symbseed=numval($symb) << 10;
6912: my $namechck=unpack("%32S*",$username.' ');
6913:
6914: my $nameseed=numval($username) << 21;
6915: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6916: my $courseseed=unpack("%32S*",$courseid.' ');
6917:
6918: my $num1=$symbchck+$symbseed+$namechck;
6919: my $num2=$nameseed+$domainseed+$courseseed;
6920: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6921: #&logthis("rndseed :$num:$symb");
6922: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6923: return "$num1,$num2";
6924: }
6925: }
6926:
6927: sub rndseed_64bit3 {
6928: my ($symb,$courseid,$domain,$username)=@_;
6929: {
6930: use integer;
6931: # strings need to be an even # of cahracters long, it it is odd the
6932: # last characters gets thrown away
6933: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6934: my $symbseed=numval2($symb) << 10;
6935: my $namechck=unpack("%32S*",$username.' ');
6936:
6937: my $nameseed=numval2($username) << 21;
6938: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6939: my $courseseed=unpack("%32S*",$courseid.' ');
6940:
6941: my $num1=$symbchck+$symbseed+$namechck;
6942: my $num2=$nameseed+$domainseed+$courseseed;
6943: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6944: #&logthis("rndseed :$num1:$num2:$_64bit");
6945: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6946:
6947: return "$num1:$num2";
6948: }
6949: }
6950:
6951: sub rndseed_64bit4 {
6952: my ($symb,$courseid,$domain,$username)=@_;
6953: {
6954: use integer;
6955: # strings need to be an even # of cahracters long, it it is odd the
6956: # last characters gets thrown away
6957: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6958: my $symbseed=numval3($symb) << 10;
6959: my $namechck=unpack("%32S*",$username.' ');
6960:
6961: my $nameseed=numval3($username) << 21;
6962: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6963: my $courseseed=unpack("%32S*",$courseid.' ');
6964:
6965: my $num1=$symbchck+$symbseed+$namechck;
6966: my $num2=$nameseed+$domainseed+$courseseed;
6967: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6968: #&logthis("rndseed :$num1:$num2:$_64bit");
6969: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6970:
6971: return "$num1:$num2";
6972: }
6973: }
6974:
6975: sub rndseed_64bit5 {
6976: my ($symb,$courseid,$domain,$username)=@_;
6977: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6978: return "$num1:$num2";
6979: }
6980:
6981: sub rndseed_CODE_64bit {
6982: my ($symb,$courseid,$domain,$username)=@_;
6983: {
6984: use integer;
6985: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6986: my $symbseed=numval2($symb);
6987: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6988: my $CODEseed=numval(&getCODE());
6989: my $courseseed=unpack("%32S*",$courseid.' ');
6990: my $num1=$symbseed+$CODEchck;
6991: my $num2=$CODEseed+$courseseed+$symbchck;
6992: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6993: #&logthis("rndseed :$num1:$num2:$symb");
6994: if ($_64bit) { $num1=(($num1<<32)>>32); }
6995: if ($_64bit) { $num2=(($num2<<32)>>32); }
6996: return "$num1:$num2";
6997: }
6998: }
6999:
7000: sub rndseed_CODE_64bit4 {
7001: my ($symb,$courseid,$domain,$username)=@_;
7002: {
7003: use integer;
7004: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7005: my $symbseed=numval3($symb);
7006: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7007: my $CODEseed=numval3(&getCODE());
7008: my $courseseed=unpack("%32S*",$courseid.' ');
7009: my $num1=$symbseed+$CODEchck;
7010: my $num2=$CODEseed+$courseseed+$symbchck;
7011: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7012: #&logthis("rndseed :$num1:$num2:$symb");
7013: if ($_64bit) { $num1=(($num1<<32)>>32); }
7014: if ($_64bit) { $num2=(($num2<<32)>>32); }
7015: return "$num1:$num2";
7016: }
7017: }
7018:
7019: sub rndseed_CODE_64bit5 {
7020: my ($symb,$courseid,$domain,$username)=@_;
7021: my $code = &getCODE();
7022: my ($num1,$num2)=&digest("$symb,$courseid,$code");
7023: return "$num1:$num2";
7024: }
7025:
7026: sub setup_random_from_rndseed {
7027: my ($rndseed)=@_;
7028: if ($rndseed =~/([,:])/) {
7029: my ($num1,$num2)=split(/[,:]/,$rndseed);
7030: &Math::Random::random_set_seed(abs($num1),abs($num2));
7031: } else {
7032: &Math::Random::random_set_seed_from_phrase($rndseed);
7033: }
7034: }
7035:
7036: sub latest_receipt_algorithm_id {
7037: return 'receipt2';
7038: }
7039:
7040: sub recunique {
7041: my $fucourseid=shift;
7042: my $unique;
7043: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7044: $unique=$env{"course.$fucourseid.internal.encseed"};
7045: } else {
7046: $unique=$perlvar{'lonReceipt'};
7047: }
7048: return unpack("%32C*",$unique);
7049: }
7050:
7051: sub recprefix {
7052: my $fucourseid=shift;
7053: my $prefix;
7054: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7055: $prefix=$env{"course.$fucourseid.internal.encpref"};
7056: } else {
7057: $prefix=$perlvar{'lonHostID'};
7058: }
7059: return unpack("%32C*",$prefix);
7060: }
7061:
7062: sub ireceipt {
7063: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
7064: my $cuname=unpack("%32C*",$funame);
7065: my $cudom=unpack("%32C*",$fudom);
7066: my $cucourseid=unpack("%32C*",$fucourseid);
7067: my $cusymb=unpack("%32C*",$fusymb);
7068: my $cunique=&recunique($fucourseid);
7069: my $cpart=unpack("%32S*",$part);
7070: my $return =&recprefix($fucourseid).'-';
7071: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
7072: $env{'request.state'} eq 'construct') {
7073: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
7074:
7075: $return.= ($cunique%$cuname+
7076: $cunique%$cudom+
7077: $cusymb%$cuname+
7078: $cusymb%$cudom+
7079: $cucourseid%$cuname+
7080: $cucourseid%$cudom+
7081: $cpart%$cuname+
7082: $cpart%$cudom);
7083: } else {
7084: $return.= ($cunique%$cuname+
7085: $cunique%$cudom+
7086: $cusymb%$cuname+
7087: $cusymb%$cudom+
7088: $cucourseid%$cuname+
7089: $cucourseid%$cudom);
7090: }
7091: return $return;
7092: }
7093:
7094: sub receipt {
7095: my ($part)=@_;
7096: my ($symb,$courseid,$domain,$name) = &whichuser();
7097: return &ireceipt($name,$domain,$courseid,$symb,$part);
7098: }
7099:
7100: sub whichuser {
7101: my ($passedsymb)=@_;
7102: my ($symb,$courseid,$domain,$name,$publicuser);
7103: if (defined($env{'form.grade_symb'})) {
7104: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
7105: my $allowed=&allowed('vgr',$tmp_courseid);
7106: if (!$allowed &&
7107: exists($env{'request.course.sec'}) &&
7108: $env{'request.course.sec'} !~ /^\s*$/) {
7109: $allowed=&allowed('vgr',$tmp_courseid.
7110: '/'.$env{'request.course.sec'});
7111: }
7112: if ($allowed) {
7113: ($symb)=&get_env_multiple('form.grade_symb');
7114: $courseid=$tmp_courseid;
7115: ($domain)=&get_env_multiple('form.grade_domain');
7116: ($name)=&get_env_multiple('form.grade_username');
7117: return ($symb,$courseid,$domain,$name,$publicuser);
7118: }
7119: }
7120: if (!$passedsymb) {
7121: $symb=&symbread();
7122: } else {
7123: $symb=$passedsymb;
7124: }
7125: $courseid=$env{'request.course.id'};
7126: $domain=$env{'user.domain'};
7127: $name=$env{'user.name'};
7128: if ($name eq 'public' && $domain eq 'public') {
7129: if (!defined($env{'form.username'})) {
7130: $env{'form.username'}.=time.rand(10000000);
7131: }
7132: $name.=$env{'form.username'};
7133: }
7134: return ($symb,$courseid,$domain,$name,$publicuser);
7135:
7136: }
7137:
7138: # ------------------------------------------------------------ Serves up a file
7139: # returns either the contents of the file or
7140: # -1 if the file doesn't exist
7141: #
7142: # if the target is a file that was uploaded via DOCS,
7143: # a check will be made to see if a current copy exists on the local server,
7144: # if it does this will be served, otherwise a copy will be retrieved from
7145: # the home server for the course and stored in /home/httpd/html/userfiles on
7146: # the local server.
7147:
7148: sub getfile {
7149: my ($file) = @_;
7150: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7151: &repcopy($file);
7152: return &readfile($file);
7153: }
7154:
7155: sub repcopy_userfile {
7156: my ($file)=@_;
7157: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7158: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7159: my ($cdom,$cnum,$filename) =
7160: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
7161: my ($info,$rtncode);
7162: my $uri="/uploaded/$cdom/$cnum/$filename";
7163: if (-e "$file") {
7164: my @fileinfo = stat($file);
7165: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
7166: if ($lwpresp ne 'ok') {
7167: if ($rtncode eq '404') {
7168: unlink($file);
7169: }
7170: #my $ua=new LWP::UserAgent;
7171: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
7172: #my $response=$ua->request($request);
7173: #if ($response->is_success()) {
7174: # return $response->content;
7175: # } else {
7176: # return -1;
7177: # }
7178: return -1;
7179: }
7180: if ($info < $fileinfo[9]) {
7181: return 'ok';
7182: }
7183: $info = '';
7184: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
7185: if ($lwpresp ne 'ok') {
7186: return -1;
7187: }
7188: } else {
7189: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
7190: if ($lwpresp ne 'ok') {
7191: my $ua=new LWP::UserAgent;
7192: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
7193: # FIXME, right reads everything into memory then writes it out
7194: # doing something like
7195: # my $response=$ua->request($request,$file);
7196: # would make this write directly to disk
7197: my $response=$ua->request($request);
7198: if ($response->is_success()) {
7199: $info=$response->content;
7200: } else {
7201: return -1;
7202: }
7203: }
7204: my @parts = ($cdom,$cnum);
7205: if ($filename =~ m|^(.+)/[^/]+$|) {
7206: push @parts, split(/\//,$1);
7207: }
7208: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7209: foreach my $part (@parts) {
7210: $path .= '/'.$part;
7211: if (!-e $path) {
7212: mkdir($path,0770);
7213: }
7214: }
7215: }
7216: open(FILE,">$file");
7217: print FILE $info;
7218: close(FILE);
7219: return 'ok';
7220: }
7221:
7222: sub tokenwrapper {
7223: my $uri=shift;
7224: $uri=~s|^http\://([^/]+)||;
7225: $uri=~s|^/||;
7226: $env{'user.environment'}=~/\/([^\/]+)\.id/;
7227: my $token=$1;
7228: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7229: if ($udom && $uname && $file) {
7230: $file=~s|(\?\.*)*$||;
7231: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
7232: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
7233: (($uri=~/\?/)?'&':'?').'token='.$token.
7234: '&tokenissued='.$perlvar{'lonHostID'};
7235: } else {
7236: return '/adm/notfound.html';
7237: }
7238: }
7239:
7240: sub getuploaded {
7241: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7242: $uri=~s/^\///;
7243: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
7244: my $ua=new LWP::UserAgent;
7245: my $request=new HTTP::Request($reqtype,$uri);
7246: my $response=$ua->request($request);
7247: $$rtncode = $response->code;
7248: if (! $response->is_success()) {
7249: return 'failed';
7250: }
7251: if ($reqtype eq 'HEAD') {
7252: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7253: } elsif ($reqtype eq 'GET') {
7254: $$info = $response->content;
7255: }
7256: return 'ok';
7257: }
7258:
7259: sub readfile {
7260: my $file = shift;
7261: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7262: my $fh;
7263: open($fh,"<$file");
7264: my $a='';
7265: while (my $line = <$fh>) { $a .= $line; }
7266: return $a;
7267: }
7268:
7269: sub filelocation {
7270: my ($dir,$file) = @_;
7271: my $location;
7272: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7273:
7274: if ($file =~ m-^/adm/-) {
7275: $file=~s-^/adm/wrapper/-/-;
7276: $file=~s-^/adm/coursedocs/showdoc/-/-;
7277: }
7278: if ($file=~m:^/~:) { # is a contruction space reference
7279: $location = $file;
7280: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7281: } elsif ($file=~m{^/home/$match_username/public_html/}) {
7282: # is a correct contruction space reference
7283: $location = $file;
7284: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7285: my ($udom,$uname,$filename)=
7286: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
7287: my $home=&homeserver($uname,$udom);
7288: my $is_me=0;
7289: my @ids=¤t_machine_ids();
7290: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7291: if ($is_me) {
7292: $location=&propath($udom,$uname).
7293: '/userfiles/'.$filename;
7294: } else {
7295: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7296: $udom.'/'.$uname.'/'.$filename;
7297: }
7298: } else {
7299: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7300: $file=~s:^/res/:/:;
7301: if ( !( $file =~ m:^/:) ) {
7302: $location = $dir. '/'.$file;
7303: } else {
7304: $location = '/home/httpd/html/res'.$file;
7305: }
7306: }
7307: $location=~s://+:/:g; # remove duplicate /
7308: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7309: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7310: return $location;
7311: }
7312:
7313: sub hreflocation {
7314: my ($dir,$file)=@_;
7315: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7316: $file=filelocation($dir,$file);
7317: } elsif ($file=~m-^/adm/-) {
7318: $file=~s-^/adm/wrapper/-/-;
7319: $file=~s-^/adm/coursedocs/showdoc/-/-;
7320: }
7321: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7322: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7323: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7324: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
7325: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
7326: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
7327: -/uploaded/$1/$2/-x;
7328: }
7329: return $file;
7330: }
7331:
7332: sub current_machine_domains {
7333: my $hostname=$hostname{$perlvar{'lonHostID'}};
7334: my @domains;
7335: while( my($id, $name) = each(%hostname)) {
7336: # &logthis("-$id-$name-$hostname-");
7337: if ($hostname eq $name) {
7338: push(@domains,$hostdom{$id});
7339: }
7340: }
7341: return @domains;
7342: }
7343:
7344: sub current_machine_ids {
7345: my $hostname=$hostname{$perlvar{'lonHostID'}};
7346: my @ids;
7347: while( my($id, $name) = each(%hostname)) {
7348: # &logthis("-$id-$name-$hostname-");
7349: if ($hostname eq $name) {
7350: push(@ids,$id);
7351: }
7352: }
7353: return @ids;
7354: }
7355:
7356: sub additional_machine_domains {
7357: my @domains;
7358: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
7359: while( my $line = <$fh>) {
7360: $line =~ s/\s//g;
7361: push(@domains,$line);
7362: }
7363: return @domains;
7364: }
7365:
7366: sub default_login_domain {
7367: my $domain = $perlvar{'lonDefDomain'};
7368: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
7369: foreach my $posdom (¤t_machine_domains(),
7370: &additional_machine_domains()) {
7371: if (lc($posdom) eq lc($testdomain)) {
7372: $domain=$posdom;
7373: last;
7374: }
7375: }
7376: return $domain;
7377: }
7378:
7379: # ------------------------------------------------------------- Declutters URLs
7380:
7381: sub declutter {
7382: my $thisfn=shift;
7383: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7384: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7385: $thisfn=~s/^\///;
7386: $thisfn=~s|^adm/wrapper/||;
7387: $thisfn=~s|^adm/coursedocs/showdoc/||;
7388: $thisfn=~s/^res\///;
7389: $thisfn=~s/\?.+$//;
7390: return $thisfn;
7391: }
7392:
7393: # ------------------------------------------------------------- Clutter up URLs
7394:
7395: sub clutter {
7396: my $thisfn='/'.&declutter(shift);
7397: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
7398: $thisfn='/res'.$thisfn;
7399: }
7400: if ($thisfn !~m|/adm|) {
7401: if ($thisfn =~ m|/ext/|) {
7402: $thisfn='/adm/wrapper'.$thisfn;
7403: } else {
7404: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7405: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7406: if ($embstyle eq 'ssi'
7407: || ($embstyle eq 'hdn')
7408: || ($embstyle eq 'rat')
7409: || ($embstyle eq 'prv')
7410: || ($embstyle eq 'ign')) {
7411: #do nothing with these
7412: } elsif (($embstyle eq 'img')
7413: || ($embstyle eq 'emb')
7414: || ($embstyle eq 'wrp')) {
7415: $thisfn='/adm/wrapper'.$thisfn;
7416: } elsif ($embstyle eq 'unk'
7417: && $thisfn!~/\.(sequence|page)$/) {
7418: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7419: } else {
7420: # &logthis("Got a blank emb style");
7421: }
7422: }
7423: }
7424: return $thisfn;
7425: }
7426:
7427: sub clutter_with_no_wrapper {
7428: my $uri = &clutter(shift);
7429: if ($uri =~ m-^/adm/-) {
7430: $uri =~ s-^/adm/wrapper/-/-;
7431: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
7432: }
7433: return $uri;
7434: }
7435:
7436: sub freeze_escape {
7437: my ($value)=@_;
7438: if (ref($value)) {
7439: $value=&nfreeze($value);
7440: return '__FROZEN__'.&escape($value);
7441: }
7442: return &escape($value);
7443: }
7444:
7445:
7446: sub thaw_unescape {
7447: my ($value)=@_;
7448: if ($value =~ /^__FROZEN__/) {
7449: substr($value,0,10,undef);
7450: $value=&unescape($value);
7451: return &thaw($value);
7452: }
7453: return &unescape($value);
7454: }
7455:
7456: sub correct_line_ends {
7457: my ($result)=@_;
7458: $$result =~s/\r\n/\n/mg;
7459: $$result =~s/\r/\n/mg;
7460: }
7461: # ================================================================ Main Program
7462:
7463: sub goodbye {
7464: &logthis("Starting Shut down");
7465: #not converted to using infrastruture and probably shouldn't be
7466: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
7467: #converted
7468: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7469: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
7470: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
7471: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
7472: #1.1 only
7473: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
7474: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
7475: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
7476: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
7477: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
7478: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7479: &logthis(sprintf("%-20s is %s",'hits',$hits));
7480: &flushcourselogs();
7481: &logthis("Shutting down");
7482: }
7483:
7484: BEGIN {
7485: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
7486: unless ($readit) {
7487: {
7488: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
7489: %perlvar = (%perlvar,%{$configvars});
7490: }
7491:
7492: # ------------------------------------------------------------ Read domain file
7493: {
7494: %domaindescription = ();
7495: %domain_auth_def = ();
7496: %domain_auth_arg_def = ();
7497: my $fh;
7498: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
7499: while (my $line = <$fh>) {
7500: next if ($line =~ /^(\#|\s*$)/);
7501: # next if /^\#/;
7502: chomp $line;
7503: my ($domain, $domain_description, $def_auth, $def_auth_arg,
7504: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$line,9);
7505: $domain_auth_def{$domain}=$def_auth;
7506: $domain_auth_arg_def{$domain}=$def_auth_arg;
7507: $domaindescription{$domain}=$domain_description;
7508: $domain_lang_def{$domain}=$def_lang;
7509: $domain_city{$domain}=$city;
7510: $domain_longi{$domain}=$longi;
7511: $domain_lati{$domain}=$lati;
7512: $domain_primary{$domain}=$primary;
7513:
7514: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
7515: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
7516: }
7517: }
7518: close ($fh);
7519: }
7520:
7521:
7522: # ------------------------------------------------------------- Read hosts file
7523: {
7524: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7525:
7526: while (my $configline=<$config>) {
7527: next if ($configline =~ /^(\#|\s*$)/);
7528: chomp($configline);
7529: my ($id,$domain,$role,$name)=split(/:/,$configline);
7530: $name=~s/\s//g;
7531: if ($id && $domain && $role && $name) {
7532: $hostname{$id}=$name;
7533: $hostdom{$id}=$domain;
7534: if ($role eq 'library') { $libserv{$id}=$name; }
7535: }
7536: }
7537: close($config);
7538: # FIXME: dev server don't want this, production servers _do_ want this
7539: #&get_iphost();
7540: }
7541:
7542: sub get_iphost {
7543: if (%iphost) { return %iphost; }
7544: my %name_to_ip;
7545: foreach my $id (keys(%hostname)) {
7546: my $name=$hostname{$id};
7547: my $ip;
7548: if (!exists($name_to_ip{$name})) {
7549: $ip = gethostbyname($name);
7550: if (!$ip || length($ip) ne 4) {
7551: &logthis("Skipping host $id name $name no IP found");
7552: next;
7553: }
7554: $ip=inet_ntoa($ip);
7555: $name_to_ip{$name} = $ip;
7556: } else {
7557: $ip = $name_to_ip{$name};
7558: }
7559: push(@{$iphost{$ip}},$id);
7560: }
7561: return %iphost;
7562: }
7563:
7564: # ------------------------------------------------------ Read spare server file
7565: {
7566: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
7567:
7568: while (my $configline=<$config>) {
7569: chomp($configline);
7570: if ($configline) {
7571: my ($host,$type) = split(':',$configline,2);
7572: if (!defined($type) || $type eq '') { $type = 'default' };
7573: push(@{ $spareid{$type} }, $host);
7574: }
7575: }
7576: close($config);
7577: }
7578: # ------------------------------------------------------------ Read permissions
7579: {
7580: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
7581:
7582: while (my $configline=<$config>) {
7583: chomp($configline);
7584: if ($configline) {
7585: my ($role,$perm)=split(/ /,$configline);
7586: if ($perm ne '') { $pr{$role}=$perm; }
7587: }
7588: }
7589: close($config);
7590: }
7591:
7592: # -------------------------------------------- Read plain texts for permissions
7593: {
7594: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
7595:
7596: while (my $configline=<$config>) {
7597: chomp($configline);
7598: if ($configline) {
7599: my ($short,@plain)=split(/:/,$configline);
7600: %{$prp{$short}} = ();
7601: if (@plain > 0) {
7602: $prp{$short}{'std'} = $plain[0];
7603: for (my $i=1; $i<@plain; $i++) {
7604: $prp{$short}{'alt'.$i} = $plain[$i];
7605: }
7606: }
7607: }
7608: }
7609: close($config);
7610: }
7611:
7612: # ---------------------------------------------------------- Read package table
7613: {
7614: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
7615:
7616: while (my $configline=<$config>) {
7617: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
7618: chomp($configline);
7619: my ($short,$plain)=split(/:/,$configline);
7620: my ($pack,$name)=split(/\&/,$short);
7621: if ($plain ne '') {
7622: $packagetab{$pack.'&'.$name.'&name'}=$name;
7623: $packagetab{$short}=$plain;
7624: }
7625: }
7626: close($config);
7627: }
7628:
7629: # ------------- set up temporary directory
7630: {
7631: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7632:
7633: }
7634:
7635: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
7636: 'compress_threshold'=> 20_000,
7637: });
7638:
7639: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7640: $dumpcount=0;
7641:
7642: &logtouch();
7643: &logthis('<font color="yellow">INFO: Read configuration</font>');
7644: $readit=1;
7645: {
7646: use integer;
7647: my $test=(2**32)+1;
7648: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7649: &logthis(" Detected 64bit platform ($_64bit)");
7650: }
7651: }
7652: }
7653:
7654: 1;
7655: __END__
7656:
7657: =pod
7658:
7659: =head1 NAME
7660:
7661: Apache::lonnet - Subroutines to ask questions about things in the network.
7662:
7663: =head1 SYNOPSIS
7664:
7665: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7666:
7667: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7668:
7669: Common parameters:
7670:
7671: =over 4
7672:
7673: =item *
7674:
7675: $uname : an internal username (if $cname expecting a course Id specifically)
7676:
7677: =item *
7678:
7679: $udom : a domain (if $cdom expecting a course's domain specifically)
7680:
7681: =item *
7682:
7683: $symb : a resource instance identifier
7684:
7685: =item *
7686:
7687: $namespace : the name of a .db file that contains the data needed or
7688: being set.
7689:
7690: =back
7691:
7692: =head1 OVERVIEW
7693:
7694: lonnet provides subroutines which interact with the
7695: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7696: about classes, users, and resources.
7697:
7698: For many of these objects you can also use this to store data about
7699: them or modify them in various ways.
7700:
7701: =head2 Symbs
7702:
7703: To identify a specific instance of a resource, LON-CAPA uses symbols
7704: or "symbs"X<symb>. These identifiers are built from the URL of the
7705: map, the resource number of the resource in the map, and the URL of
7706: the resource itself. The latter is somewhat redundant, but might help
7707: if maps change.
7708:
7709: An example is
7710:
7711: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7712:
7713: The respective map entry is
7714:
7715: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7716: title="Problem 2">
7717: </resource>
7718:
7719: Symbs are used by the random number generator, as well as to store and
7720: restore data specific to a certain instance of for example a problem.
7721:
7722: =head2 Storing And Retrieving Data
7723:
7724: X<store()>X<cstore()>X<restore()>Three of the most important functions
7725: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7726: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7727: is is the non-critical message twin of cstore. These functions are for
7728: handlers to store a perl hash to a user's permanent data space in an
7729: easy manner, and to retrieve it again on another call. It is expected
7730: that a handler would use this once at the beginning to retrieve data,
7731: and then again once at the end to send only the new data back.
7732:
7733: The data is stored in the user's data directory on the user's
7734: homeserver under the ID of the course.
7735:
7736: The hash that is returned by restore will have all of the previous
7737: value for all of the elements of the hash.
7738:
7739: Example:
7740:
7741: #creating a hash
7742: my %hash;
7743: $hash{'foo'}='bar';
7744:
7745: #storing it
7746: &Apache::lonnet::cstore(\%hash);
7747:
7748: #changing a value
7749: $hash{'foo'}='notbar';
7750:
7751: #adding a new value
7752: $hash{'bar'}='foo';
7753: &Apache::lonnet::cstore(\%hash);
7754:
7755: #retrieving the hash
7756: my %history=&Apache::lonnet::restore();
7757:
7758: #print the hash
7759: foreach my $key (sort(keys(%history))) {
7760: print("\%history{$key} = $history{$key}");
7761: }
7762:
7763: Will print out:
7764:
7765: %history{1:foo} = bar
7766: %history{1:keys} = foo:timestamp
7767: %history{1:timestamp} = 990455579
7768: %history{2:bar} = foo
7769: %history{2:foo} = notbar
7770: %history{2:keys} = foo:bar:timestamp
7771: %history{2:timestamp} = 990455580
7772: %history{bar} = foo
7773: %history{foo} = notbar
7774: %history{timestamp} = 990455580
7775: %history{version} = 2
7776:
7777: Note that the special hash entries C<keys>, C<version> and
7778: C<timestamp> were added to the hash. C<version> will be equal to the
7779: total number of versions of the data that have been stored. The
7780: C<timestamp> attribute will be the UNIX time the hash was
7781: stored. C<keys> is available in every historical section to list which
7782: keys were added or changed at a specific historical revision of a
7783: hash.
7784:
7785: B<Warning>: do not store the hash that restore returns directly. This
7786: will cause a mess since it will restore the historical keys as if the
7787: were new keys. I.E. 1:foo will become 1:1:foo etc.
7788:
7789: Calling convention:
7790:
7791: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7792: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7793:
7794: For more detailed information, see lonnet specific documentation.
7795:
7796: =head1 RETURN MESSAGES
7797:
7798: =over 4
7799:
7800: =item * B<con_lost>: unable to contact remote host
7801:
7802: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7803: when the connection is brought back up
7804:
7805: =item * B<con_failed>: unable to contact remote host and unable to save message
7806: for later delivery
7807:
7808: =item * B<error:>: an error a occured, a description of the error follows the :
7809:
7810: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7811: that was requested
7812:
7813: =back
7814:
7815: =head1 PUBLIC SUBROUTINES
7816:
7817: =head2 Session Environment Functions
7818:
7819: =over 4
7820:
7821: =item *
7822: X<appenv()>
7823: B<appenv(%hash)>: the value of %hash is written to
7824: the user envirnoment file, and will be restored for each access this
7825: user makes during this session, also modifies the %env for the current
7826: process
7827:
7828: =item *
7829: X<delenv()>
7830: B<delenv($regexp)>: removes all items from the session
7831: environment file that matches the regular expression in $regexp. The
7832: values are also delted from the current processes %env.
7833:
7834: =item * get_env_multiple($name)
7835:
7836: gets $name from the %env hash, it seemlessly handles the cases where multiple
7837: values may be defined and end up as an array ref.
7838:
7839: returns an array of values
7840:
7841: =back
7842:
7843: =head2 User Information
7844:
7845: =over 4
7846:
7847: =item *
7848: X<queryauthenticate()>
7849: B<queryauthenticate($uname,$udom)>: try to determine user's current
7850: authentication scheme
7851:
7852: =item *
7853: X<authenticate()>
7854: B<authenticate($uname,$upass,$udom)>: try to
7855: authenticate user from domain's lib servers (first use the current
7856: one). C<$upass> should be the users password.
7857:
7858: =item *
7859: X<homeserver()>
7860: B<homeserver($uname,$udom)>: find the server which has
7861: the user's directory and files (there must be only one), this caches
7862: the answer, and also caches if there is a borken connection.
7863:
7864: =item *
7865: X<idget()>
7866: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7867: (IDs are a unique resource in a domain, there must be only 1 ID per
7868: username, and only 1 username per ID in a specific domain) (returns
7869: hash: id=>name,id=>name)
7870:
7871: =item *
7872: X<idrget()>
7873: B<idrget($udom,@unames)>: find the IDs behind a list of
7874: usernames (returns hash: name=>id,name=>id)
7875:
7876: =item *
7877: X<idput()>
7878: B<idput($udom,%ids)>: store away a list of names and associated IDs
7879:
7880: =item *
7881: X<rolesinit()>
7882: B<rolesinit($udom,$username,$authhost)>: get user privileges
7883:
7884: =item *
7885: X<getsection()>
7886: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7887: course $cname, return section name/number or '' for "not in course"
7888: and '-1' for "no section"
7889:
7890: =item *
7891: X<userenvironment()>
7892: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7893: passed in @what from the requested user's environment, returns a hash
7894:
7895: =back
7896:
7897: =head2 User Roles
7898:
7899: =over 4
7900:
7901: =item *
7902:
7903: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
7904: F: full access
7905: U,I,K: authentication modes (cxx only)
7906: '': forbidden
7907: 1: user needs to choose course
7908: 2: browse allowed
7909: A: passphrase authentication needed
7910:
7911: =item *
7912:
7913: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7914: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7915: and course level
7916:
7917: =item *
7918:
7919: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7920: explanation of a user role term
7921:
7922: =back
7923:
7924: =head2 User Modification
7925:
7926: =over 4
7927:
7928: =item *
7929:
7930: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7931: user for the level given by URL. Optional start and end dates (leave empty
7932: string or zero for "no date")
7933:
7934: =item *
7935:
7936: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7937: change a users, password, possible return values are: ok,
7938: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7939: refused
7940:
7941: =item *
7942:
7943: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7944:
7945: =item *
7946:
7947: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7948: modify user
7949:
7950: =item *
7951:
7952: modifystudent
7953:
7954: modify a students enrollment and identification information.
7955: The course id is resolved based on the current users environment.
7956: This means the envoking user must be a course coordinator or otherwise
7957: associated with a course.
7958:
7959: This call is essentially a wrapper for lonnet::modifyuser and
7960: lonnet::modify_student_enrollment
7961:
7962: Inputs:
7963:
7964: =over 4
7965:
7966: =item B<$udom> Students loncapa domain
7967:
7968: =item B<$uname> Students loncapa login name
7969:
7970: =item B<$uid> Students id/student number
7971:
7972: =item B<$umode> Students authentication mode
7973:
7974: =item B<$upass> Students password
7975:
7976: =item B<$first> Students first name
7977:
7978: =item B<$middle> Students middle name
7979:
7980: =item B<$last> Students last name
7981:
7982: =item B<$gene> Students generation
7983:
7984: =item B<$usec> Students section in course
7985:
7986: =item B<$end> Unix time of the roles expiration
7987:
7988: =item B<$start> Unix time of the roles start date
7989:
7990: =item B<$forceid> If defined, allow $uid to be changed
7991:
7992: =item B<$desiredhome> server to use as home server for student
7993:
7994: =back
7995:
7996: =item *
7997:
7998: modify_student_enrollment
7999:
8000: Change a students enrollment status in a class. The environment variable
8001: 'role.request.course' must be defined for this function to proceed.
8002:
8003: Inputs:
8004:
8005: =over 4
8006:
8007: =item $udom, students domain
8008:
8009: =item $uname, students name
8010:
8011: =item $uid, students user id
8012:
8013: =item $first, students first name
8014:
8015: =item $middle
8016:
8017: =item $last
8018:
8019: =item $gene
8020:
8021: =item $usec
8022:
8023: =item $end
8024:
8025: =item $start
8026:
8027: =back
8028:
8029:
8030: =item *
8031:
8032: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
8033: custom role; give a custom role to a user for the level given by URL. Specify
8034: name and domain of role author, and role name
8035:
8036: =item *
8037:
8038: revokerole($udom,$uname,$url,$role) : revoke a role for url
8039:
8040: =item *
8041:
8042: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
8043:
8044: =back
8045:
8046: =head2 Course Infomation
8047:
8048: =over 4
8049:
8050: =item *
8051:
8052: coursedescription($courseid) : returns a hash of information about the
8053: specified course id, including all environment settings for the
8054: course, the description of the course will be in the hash under the
8055: key 'description'
8056:
8057: =item *
8058:
8059: resdata($name,$domain,$type,@which) : request for current parameter
8060: setting for a specific $type, where $type is either 'course' or 'user',
8061: @what should be a list of parameters to ask about. This routine caches
8062: answers for 5 minutes.
8063:
8064: =back
8065:
8066: =head2 Course Modification
8067:
8068: =over 4
8069:
8070: =item *
8071:
8072: writecoursepref($courseid,%prefs) : write preferences (environment
8073: database) for a course
8074:
8075: =item *
8076:
8077: createcourse($udom,$description,$url) : make/modify course
8078:
8079: =back
8080:
8081: =head2 Resource Subroutines
8082:
8083: =over 4
8084:
8085: =item *
8086:
8087: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
8088:
8089: =item *
8090:
8091: repcopy($filename) : subscribes to the requested file, and attempts to
8092: replicate from the owning library server, Might return
8093: 'unavailable', 'not_found', 'forbidden', 'ok', or
8094: 'bad_request', also attempts to grab the metadata for the
8095: resource. Expects the local filesystem pathname
8096: (/home/httpd/html/res/....)
8097:
8098: =back
8099:
8100: =head2 Resource Information
8101:
8102: =over 4
8103:
8104: =item *
8105:
8106: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
8107: a vairety of different possible values, $varname should be a request
8108: string, and the other parameters can be used to specify who and what
8109: one is asking about.
8110:
8111: Possible values for $varname are environment.lastname (or other item
8112: from the envirnment hash), user.name (or someother aspect about the
8113: user), resource.0.maxtries (or some other part and parameter of a
8114: resource)
8115:
8116: =item *
8117:
8118: directcondval($number) : get current value of a condition; reads from a state
8119: string
8120:
8121: =item *
8122:
8123: condval($condidx) : value of condition index based on state
8124:
8125: =item *
8126:
8127: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
8128: resource's metadata, $what should be either a specific key, or either
8129: 'keys' (to get a list of possible keys) or 'packages' to get a list of
8130: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
8131:
8132: this function automatically caches all requests
8133:
8134: =item *
8135:
8136: metadata_query($query,$custom,$customshow) : make a metadata query against the
8137: network of library servers; returns file handle of where SQL and regex results
8138: will be stored for query
8139:
8140: =item *
8141:
8142: symbread($filename) : return symbolic list entry (filename argument optional);
8143: returns the data handle
8144:
8145: =item *
8146:
8147: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
8148: a possible symb for the URL in $thisfn, and if is an encryypted
8149: resource that the user accessed using /enc/ returns a 1 on success, 0
8150: on failure, user must be in a course, as it assumes the existance of
8151: the course initial hash, and uses $env('request.course.id'}
8152:
8153:
8154: =item *
8155:
8156: symbclean($symb) : removes versions numbers from a symb, returns the
8157: cleaned symb
8158:
8159: =item *
8160:
8161: is_on_map($uri) : checks if the $uri is somewhere on the current
8162: course map, user must be in a course for it to work.
8163:
8164: =item *
8165:
8166: numval($salt) : return random seed value (addend for rndseed)
8167:
8168: =item *
8169:
8170: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
8171: a random seed, all arguments are optional, if they aren't sent it uses the
8172: environment to derive them. Note: if symb isn't sent and it can't get one
8173: from &symbread it will use the current time as its return value
8174:
8175: =item *
8176:
8177: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
8178: unfakeable, receipt
8179:
8180: =item *
8181:
8182: receipt() : API to ireceipt working off of env values; given out to users
8183:
8184: =item *
8185:
8186: countacc($url) : count the number of accesses to a given URL
8187:
8188: =item *
8189:
8190: 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
8191:
8192: =item *
8193:
8194: 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)
8195:
8196: =item *
8197:
8198: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
8199:
8200: =item *
8201:
8202: devalidate($symb) : devalidate temporary spreadsheet calculations,
8203: forcing spreadsheet to reevaluate the resource scores next time.
8204:
8205: =back
8206:
8207: =head2 Storing/Retreiving Data
8208:
8209: =over 4
8210:
8211: =item *
8212:
8213: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
8214: for this url; hashref needs to be given and should be a \%hashname; the
8215: remaining args aren't required and if they aren't passed or are '' they will
8216: be derived from the env
8217:
8218: =item *
8219:
8220: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
8221: uses critical subroutine
8222:
8223: =item *
8224:
8225: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
8226: all args are optional
8227:
8228: =item *
8229:
8230: dumpstore($namespace,$udom,$uname,$regexp,$range) :
8231: dumps the complete (or key matching regexp) namespace into a hash
8232: ($udom, $uname, $regexp, $range are optional) for a namespace that is
8233: normally &store()ed into
8234:
8235: $range should be either an integer '100' (give me the first 100
8236: matching records)
8237: or be two integers sperated by a - with no spaces
8238: '30-50' (give me the 30th through the 50th matching
8239: records)
8240:
8241:
8242: =item *
8243:
8244: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
8245: replaces a &store() version of data with a replacement set of data
8246: for a particular resource in a namespace passed in the $storehash hash
8247: reference
8248:
8249: =item *
8250:
8251: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
8252: works very similar to store/cstore, but all data is stored in a
8253: temporary location and can be reset using tmpreset, $storehash should
8254: be a hash reference, returns nothing on success
8255:
8256: =item *
8257:
8258: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
8259: similar to restore, but all data is stored in a temporary location and
8260: can be reset using tmpreset. Returns a hash of values on success,
8261: error string otherwise.
8262:
8263: =item *
8264:
8265: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
8266: deltes all keys for $symb form the temporary storage hash.
8267:
8268: =item *
8269:
8270: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8271: reference filled in from namesp ($udom and $uname are optional)
8272:
8273: =item *
8274:
8275: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
8276: namesp ($udom and $uname are optional)
8277:
8278: =item *
8279:
8280: dump($namespace,$udom,$uname,$regexp,$range) :
8281: dumps the complete (or key matching regexp) namespace into a hash
8282: ($udom, $uname, $regexp, $range are optional)
8283:
8284: $range should be either an integer '100' (give me the first 100
8285: matching records)
8286: or be two integers sperated by a - with no spaces
8287: '30-50' (give me the 30th through the 50th matching
8288: records)
8289: =item *
8290:
8291: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
8292: $store can be a scalar, an array reference, or if the amount to be
8293: incremented is > 1, a hash reference.
8294:
8295: ($udom and $uname are optional)
8296:
8297: =item *
8298:
8299: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
8300: ($udom and $uname are optional)
8301:
8302: =item *
8303:
8304: cput($namespace,$storehash,$udom,$uname) : critical put
8305: ($udom and $uname are optional)
8306:
8307: =item *
8308:
8309: newput($namespace,$storehash,$udom,$uname) :
8310:
8311: Attempts to store the items in the $storehash, but only if they don't
8312: currently exist, if this succeeds you can be certain that you have
8313: successfully created a new key value pair in the $namespace db.
8314:
8315:
8316: Args:
8317: $namespace: name of database to store values to
8318: $storehash: hashref to store to the db
8319: $udom: (optional) domain of user containing the db
8320: $uname: (optional) name of user caontaining the db
8321:
8322: Returns:
8323: 'ok' -> succeeded in storing all keys of $storehash
8324: 'key_exists: <key>' -> failed to anything out of $storehash, as at
8325: least <key> already existed in the db (other
8326: requested keys may also already exist)
8327: 'error: <msg>' -> unable to tie the DB or other erorr occured
8328: 'con_lost' -> unable to contact request server
8329: 'refused' -> action was not allowed by remote machine
8330:
8331:
8332: =item *
8333:
8334: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8335: reference filled in from namesp (encrypts the return communication)
8336: ($udom and $uname are optional)
8337:
8338: =item *
8339:
8340: log($udom,$name,$home,$message) : write to permanent log for user; use
8341: critical subroutine
8342:
8343: =item *
8344:
8345: get_dom($namespace,$storearr,$udomain) : returns hash with keys from array
8346: reference filled in from namespace found in domain level on primary domain server ($udomain is optional)
8347:
8348: =item *
8349:
8350: put_dom($namespace,$storehash,$udomain) : stores hash in namespace at domain level on primary domain server ($udomain is optional)
8351:
8352: =back
8353:
8354: =head2 Network Status Functions
8355:
8356: =over 4
8357:
8358: =item *
8359:
8360: dirlist($uri) : return directory list based on URI
8361:
8362: =item *
8363:
8364: spareserver() : find server with least workload from spare.tab
8365:
8366: =back
8367:
8368: =head2 Apache Request
8369:
8370: =over 4
8371:
8372: =item *
8373:
8374: ssi($url,%hash) : server side include, does a complete request cycle on url to
8375: localhost, posts hash
8376:
8377: =back
8378:
8379: =head2 Data to String to Data
8380:
8381: =over 4
8382:
8383: =item *
8384:
8385: hash2str(%hash) : convert a hash into a string complete with escaping and '='
8386: and '&' separators, supports elements that are arrayrefs and hashrefs
8387:
8388: =item *
8389:
8390: hashref2str($hashref) : convert a hashref into a string complete with
8391: escaping and '=' and '&' separators, supports elements that are
8392: arrayrefs and hashrefs
8393:
8394: =item *
8395:
8396: arrayref2str($arrayref) : convert an arrayref into a string complete
8397: with escaping and '&' separators, supports elements that are arrayrefs
8398: and hashrefs
8399:
8400: =item *
8401:
8402: str2hash($string) : convert string to hash using unescaping and
8403: splitting on '=' and '&', supports elements that are arrayrefs and
8404: hashrefs
8405:
8406: =item *
8407:
8408: str2array($string) : convert string to hash using unescaping and
8409: splitting on '&', supports elements that are arrayrefs and hashrefs
8410:
8411: =back
8412:
8413: =head2 Logging Routines
8414:
8415: =over 4
8416:
8417: These routines allow one to make log messages in the lonnet.log and
8418: lonnet.perm logfiles.
8419:
8420: =item *
8421:
8422: logtouch() : make sure the logfile, lonnet.log, exists
8423:
8424: =item *
8425:
8426: logthis() : append message to the normal lonnet.log file, it gets
8427: preiodically rolled over and deleted.
8428:
8429: =item *
8430:
8431: logperm() : append a permanent message to lonnet.perm.log, this log
8432: file never gets deleted by any automated portion of the system, only
8433: messages of critical importance should go in here.
8434:
8435: =back
8436:
8437: =head2 General File Helper Routines
8438:
8439: =over 4
8440:
8441: =item *
8442:
8443: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
8444: (a) files in /uploaded
8445: (i) If a local copy of the file exists -
8446: compares modification date of local copy with last-modified date for
8447: definitive version stored on home server for course. If local copy is
8448: stale, requests a new version from the home server and stores it.
8449: If the original has been removed from the home server, then local copy
8450: is unlinked.
8451: (ii) If local copy does not exist -
8452: requests the file from the home server and stores it.
8453:
8454: If $caller is 'uploadrep':
8455: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
8456: for request for files originally uploaded via DOCS.
8457: - returns 'ok' if fresh local copy now available, -1 otherwise.
8458:
8459: Otherwise:
8460: This indicates a call from the content generation phase of the request.
8461: - returns the entire contents of the file or -1.
8462:
8463: (b) files in /res
8464: - returns the entire contents of a file or -1;
8465: it properly subscribes to and replicates the file if neccessary.
8466:
8467:
8468: =item *
8469:
8470: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
8471: reference
8472:
8473: returns either a stat() list of data about the file or an empty list
8474: if the file doesn't exist or couldn't find out about it (connection
8475: problems or user unknown)
8476:
8477: =item *
8478:
8479: filelocation($dir,$file) : returns file system location of a file
8480: based on URI; meant to be "fairly clean" absolute reference, $dir is a
8481: directory that relative $file lookups are to looked in ($dir of /a/dir
8482: and a file of ../bob will become /a/bob)
8483:
8484: =item *
8485:
8486: hreflocation($dir,$file) : returns file system location or a URL; same as
8487: filelocation except for hrefs
8488:
8489: =item *
8490:
8491: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
8492:
8493: =back
8494:
8495: =head2 Usererfile file routines (/uploaded*)
8496:
8497: =over 4
8498:
8499: =item *
8500:
8501: userfileupload(): main rotine for putting a file in a user or course's
8502: filespace, arguments are,
8503:
8504: formname - required - this is the name of the element in $env where the
8505: filename, and the contents of the file to create/modifed exist
8506: the filename is in $env{'form.'.$formname.'.filename'} and the
8507: contents of the file is located in $env{'form.'.$formname}
8508: coursedoc - if true, store the file in the course of the active role
8509: of the current user
8510: subdir - required - subdirectory to put the file in under ../userfiles/
8511: if undefined, it will be placed in "unknown"
8512:
8513: (This routine calls clean_filename() to remove any dangerous
8514: characters from the filename, and then calls finuserfileupload() to
8515: complete the transaction)
8516:
8517: returns either the url of the uploaded file (/uploaded/....) if successful
8518: and /adm/notfound.html if unsuccessful
8519:
8520: =item *
8521:
8522: clean_filename(): routine for cleaing a filename up for storage in
8523: userfile space, argument is:
8524:
8525: filename - proposed filename
8526:
8527: returns: the new clean filename
8528:
8529: =item *
8530:
8531: finishuserfileupload(): routine that creaes and sends the file to
8532: userspace, probably shouldn't be called directly
8533:
8534: docuname: username or courseid of destination for the file
8535: docudom: domain of user/course of destination for the file
8536: formname: same as for userfileupload()
8537: fname: filename (inculding subdirectories) for the file
8538:
8539: returns either the url of the uploaded file (/uploaded/....) if successful
8540: and /adm/notfound.html if unsuccessful
8541:
8542: =item *
8543:
8544: renameuserfile(): renames an existing userfile to a new name
8545:
8546: Args:
8547: docuname: username or courseid of destination for the file
8548: docudom: domain of user/course of destination for the file
8549: old: current file name (including any subdirs under userfiles)
8550: new: desired file name (including any subdirs under userfiles)
8551:
8552: =item *
8553:
8554: mkdiruserfile(): creates a directory is a userfiles dir
8555:
8556: Args:
8557: docuname: username or courseid of destination for the file
8558: docudom: domain of user/course of destination for the file
8559: dir: dir to create (including any subdirs under userfiles)
8560:
8561: =item *
8562:
8563: removeuserfile(): removes a file that exists in userfiles
8564:
8565: Args:
8566: docuname: username or courseid of destination for the file
8567: docudom: domain of user/course of destination for the file
8568: fname: filname to delete (including any subdirs under userfiles)
8569:
8570: =item *
8571:
8572: removeuploadedurl(): convience function for removeuserfile()
8573:
8574: Args:
8575: url: a full /uploaded/... url to delete
8576:
8577: =item *
8578:
8579: get_portfile_permissions():
8580: Args:
8581: domain: domain of user or course contain the portfolio files
8582: user: name of user or num of course contain the portfolio files
8583: Returns:
8584: hashref of a dump of the proper file_permissions.db
8585:
8586:
8587: =item *
8588:
8589: get_access_controls():
8590:
8591: Args:
8592: current_permissions: the hash ref returned from get_portfile_permissions()
8593: group: (optional) the group you want the files associated with
8594: file: (optional) the file you want access info on
8595:
8596: Returns:
8597: a hash (keys are file names) of hashes containing
8598: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8599: values are XML containing access control settings (see below)
8600:
8601: Internal notes:
8602:
8603: access controls are stored in file_permissions.db as key=value pairs.
8604: key -> path to file/file_name\0uniqueID:scope_end_start
8605: where scope -> public,guest,course,group,domains or users.
8606: end -> UNIX time for end of access (0 -> no end date)
8607: start -> UNIX time for start of access
8608:
8609: value -> XML description of access control
8610: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8611: <start></start>
8612: <end></end>
8613:
8614: <password></password> for scope type = guest
8615:
8616: <domain></domain> for scope type = course or group
8617: <number></number>
8618: <roles id="">
8619: <role></role>
8620: <access></access>
8621: <section></section>
8622: <group></group>
8623: </roles>
8624:
8625: <dom></dom> for scope type = domains
8626:
8627: <users> for scope type = users
8628: <user>
8629: <uname></uname>
8630: <udom></udom>
8631: </user>
8632: </users>
8633: </scope>
8634:
8635: Access data is also aggregated for each file in an additional key=value pair:
8636: key -> path to file/file_name\0accesscontrol
8637: value -> reference to hash
8638: hash contains key = value pairs
8639: where key = uniqueID:scope_end_start
8640: value = UNIX time record was last updated
8641:
8642: Used to improve speed of look-ups of access controls for each file.
8643:
8644: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8645:
8646: modify_access_controls():
8647:
8648: Modifies access controls for a portfolio file
8649: Args
8650: 1. file name
8651: 2. reference to hash of required changes,
8652: 3. domain
8653: 4. username
8654: where domain,username are the domain of the portfolio owner
8655: (either a user or a course)
8656:
8657: Returns:
8658: 1. result of additions or updates ('ok' or 'error', with error message).
8659: 2. result of deletions ('ok' or 'error', with error message).
8660: 3. reference to hash of any new or updated access controls.
8661: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8662: key = integer (inbound ID)
8663: value = uniqueID
8664:
8665: =back
8666:
8667: =head2 HTTP Helper Routines
8668:
8669: =over 4
8670:
8671: =item *
8672:
8673: escape() : unpack non-word characters into CGI-compatible hex codes
8674:
8675: =item *
8676:
8677: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8678:
8679: =back
8680:
8681: =head1 PRIVATE SUBROUTINES
8682:
8683: =head2 Underlying communication routines (Shouldn't call)
8684:
8685: =over 4
8686:
8687: =item *
8688:
8689: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8690:
8691: =item *
8692:
8693: reply() : uses subreply to send a message to remote machine, logs all failures
8694:
8695: =item *
8696:
8697: critical() : passes a critical message to another server; if cannot
8698: get through then place message in connection buffer directory and
8699: returns con_delayed, if incapable of saving message, returns
8700: con_failed
8701:
8702: =item *
8703:
8704: reconlonc() : tries to reconnect lonc client processes.
8705:
8706: =back
8707:
8708: =head2 Resource Access Logging
8709:
8710: =over 4
8711:
8712: =item *
8713:
8714: flushcourselogs() : flush (save) buffer logs and access logs
8715:
8716: =item *
8717:
8718: courselog($what) : save message for course in hash
8719:
8720: =item *
8721:
8722: courseacclog($what) : save message for course using &courselog(). Perform
8723: special processing for specific resource types (problems, exams, quizzes, etc).
8724:
8725: =item *
8726:
8727: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8728: as a PerlChildExitHandler
8729:
8730: =back
8731:
8732: =head2 Other
8733:
8734: =over 4
8735:
8736: =item *
8737:
8738: symblist($mapname,%newhash) : update symbolic storage links
8739:
8740: =back
8741:
8742: =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