File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.810:
download - view:
text,
annotated -
select for diffs
Wed Nov 29 07:46:40 2006 UTC (17 years, 7 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
evb privilege - with this privilege users evade blocking of communication functionality defined by blocks placed by users with dcm privilege.
dcm privilege - this is now used to determine if link to block setting is displayed.
loncommon::findallcourses() now return a hash, where the keys are courseIDs instead of an array of courseIDs. Places where findallcourses() was called - lonannounce, lonpickcourse changed accordingly.
loncommon::findallcourses() now reports courses for a user where the user's only role was a custom role.
lonnet::allowed() can now take a fourth optional argument ($role) which allows privs to be investigated for roles other than the user's currently active role
&blockcheck, &parse_block_record(), and &build_block_table() moved from lonmsgdisplay to loncommon, so they are available for evaluation of blocking state for other communication functions besides COM.
Each block record for a blocking event in a course is now a hash, with key=values of the hash being setter = username:domain of user who set block, title=event title for block, and blocks = hash of blocked features ('com','chat','boards','port','groups').
Backwards compatibility retained with previous : separated text for block record value.
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.810 2006/11/29 07:46:40 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 lib '/home/httpd/lib/perl';
57: use LONCAPA qw(:DEFAULT :match);
58: use LONCAPA::Configuration;
59:
60: my $readit;
61: my $max_connection_retries = 10; # Or some such value.
62:
63: require Exporter;
64:
65: our @ISA = qw (Exporter);
66: our @EXPORT = qw(%env);
67:
68: =pod
69:
70: =head1 Package Variables
71:
72: These are largely undocumented, so if you decipher one please note it here.
73:
74: =over 4
75:
76: =item $processmarker
77:
78: Contains the time this process was started and this servers host id.
79:
80: =item $dumpcount
81:
82: Counts the number of times a message log flush has been attempted (regardless
83: of success) by this process. Used as part of the filename when messages are
84: delayed.
85:
86: =back
87:
88: =cut
89:
90:
91: # --------------------------------------------------------------------- Logging
92: {
93: my $logid;
94: sub instructor_log {
95: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
96: $logid++;
97: my $id=time().'00000'.$$.'00000'.$logid;
98: return &Apache::lonnet::put('nohist_'.$hash_name,
99: { $id => {
100: 'exe_uname' => $env{'user.name'},
101: 'exe_udom' => $env{'user.domain'},
102: 'exe_time' => time(),
103: 'exe_ip' => $ENV{'REMOTE_ADDR'},
104: 'delflag' => $delflag,
105: 'logentry' => $storehash,
106: 'uname' => $uname,
107: 'udom' => $udom,
108: }
109: },
110: $env{'course.'.$env{'request.course.id'}.'.domain'},
111: $env{'course.'.$env{'request.course.id'}.'.num'}
112: );
113: }
114: }
115:
116: sub logtouch {
117: my $execdir=$perlvar{'lonDaemons'};
118: unless (-e "$execdir/logs/lonnet.log") {
119: open(my $fh,">>$execdir/logs/lonnet.log");
120: close $fh;
121: }
122: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
123: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
124: }
125:
126: sub logthis {
127: my $message=shift;
128: my $execdir=$perlvar{'lonDaemons'};
129: my $now=time;
130: my $local=localtime($now);
131: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
132: print $fh "$local ($$): $message\n";
133: close($fh);
134: }
135: return 1;
136: }
137:
138: sub logperm {
139: my $message=shift;
140: my $execdir=$perlvar{'lonDaemons'};
141: my $now=time;
142: my $local=localtime($now);
143: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
144: print $fh "$now:$message:$local\n";
145: close($fh);
146: }
147: return 1;
148: }
149:
150: # -------------------------------------------------- Non-critical communication
151: sub subreply {
152: my ($cmd,$server)=@_;
153: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
154: #
155: # With loncnew process trimming, there's a timing hole between lonc server
156: # process exit and the master server picking up the listen on the AF_UNIX
157: # socket. In that time interval, a lock file will exist:
158:
159: my $lockfile=$peerfile.".lock";
160: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
161: sleep(1);
162: }
163: # At this point, either a loncnew parent is listening or an old lonc
164: # or loncnew child is listening so we can connect or everything's dead.
165: #
166: # We'll give the connection a few tries before abandoning it. If
167: # connection is not possible, we'll con_lost back to the client.
168: #
169: my $client;
170: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
171: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
172: Type => SOCK_STREAM,
173: Timeout => 10);
174: if($client) {
175: last; # Connected!
176: }
177: sleep(1); # Try again later if failed connection.
178: }
179: my $answer;
180: if ($client) {
181: print $client "sethost:$server:$cmd\n";
182: $answer=<$client>;
183: if (!$answer) { $answer="con_lost"; }
184: chomp($answer);
185: } else {
186: $answer = 'con_lost'; # Failed connection.
187: }
188: return $answer;
189: }
190:
191: sub reply {
192: my ($cmd,$server)=@_;
193: unless (defined($hostname{$server})) { return 'no_such_host'; }
194: my $answer=subreply($cmd,$server);
195: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
196: &logthis("<font color=\"blue\">WARNING:".
197: " $cmd to $server returned $answer</font>");
198: }
199: return $answer;
200: }
201:
202: # ----------------------------------------------------------- Send USR1 to lonc
203:
204: sub reconlonc {
205: my $peerfile=shift;
206: &logthis("Trying to reconnect for $peerfile");
207: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
208: if (open(my $fh,"<$loncfile")) {
209: my $loncpid=<$fh>;
210: chomp($loncpid);
211: if (kill 0 => $loncpid) {
212: &logthis("lonc at pid $loncpid responding, sending USR1");
213: kill USR1 => $loncpid;
214: sleep 1;
215: if (-e "$peerfile") { return; }
216: &logthis("$peerfile still not there, give it another try");
217: sleep 5;
218: if (-e "$peerfile") { return; }
219: &logthis(
220: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
221: } else {
222: &logthis(
223: "<font color=\"blue\">WARNING:".
224: " lonc at pid $loncpid not responding, giving up</font>");
225: }
226: } else {
227: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
228: }
229: }
230:
231: # ------------------------------------------------------ Critical communication
232:
233: sub critical {
234: my ($cmd,$server)=@_;
235: unless ($hostname{$server}) {
236: &logthis("<font color=\"blue\">WARNING:".
237: " Critical message to unknown server ($server)</font>");
238: return 'no_such_host';
239: }
240: my $answer=reply($cmd,$server);
241: if ($answer eq 'con_lost') {
242: &reconlonc("$perlvar{'lonSockDir'}/$server");
243: my $answer=reply($cmd,$server);
244: if ($answer eq 'con_lost') {
245: my $now=time;
246: my $middlename=$cmd;
247: $middlename=substr($middlename,0,16);
248: $middlename=~s/\W//g;
249: my $dfilename=
250: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
251: $dumpcount++;
252: {
253: my $dfh;
254: if (open($dfh,">$dfilename")) {
255: print $dfh "$cmd\n";
256: close($dfh);
257: }
258: }
259: sleep 2;
260: my $wcmd='';
261: {
262: my $dfh;
263: if (open($dfh,"<$dfilename")) {
264: $wcmd=<$dfh>;
265: close($dfh);
266: }
267: }
268: chomp($wcmd);
269: if ($wcmd eq $cmd) {
270: &logthis("<font color=\"blue\">WARNING: ".
271: "Connection buffer $dfilename: $cmd</font>");
272: &logperm("D:$server:$cmd");
273: return 'con_delayed';
274: } else {
275: &logthis("<font color=\"red\">CRITICAL:"
276: ." Critical connection failed: $server $cmd</font>");
277: &logperm("F:$server:$cmd");
278: return 'con_failed';
279: }
280: }
281: }
282: return $answer;
283: }
284:
285: # ------------------------------------------- check if return value is an error
286:
287: sub error {
288: my ($result) = @_;
289: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
290: if ($2 == 2) { return undef; }
291: return $1;
292: }
293: return undef;
294: }
295:
296: sub convert_and_load_session_env {
297: my ($lonidsdir,$handle)=@_;
298: my @profile;
299: {
300: open(my $idf,"$lonidsdir/$handle.id");
301: flock($idf,LOCK_SH);
302: @profile=<$idf>;
303: close($idf);
304: }
305: my %temp_env;
306: foreach my $line (@profile) {
307: if ($line !~ m/=/) {
308: return 0;
309: }
310: chomp($line);
311: my ($envname,$envvalue)=split(/=/,$line,2);
312: $temp_env{&unescape($envname)} = &unescape($envvalue);
313: }
314: unlink("$lonidsdir/$handle.id");
315: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
316: 0640)) {
317: %disk_env = %temp_env;
318: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
319: untie(%disk_env);
320: }
321: return 1;
322: }
323:
324: # ------------------------------------------- Transfer profile into environment
325: my $env_loaded;
326: sub transfer_profile_to_env {
327: my ($lonidsdir,$handle,$force_transfer) = @_;
328: if (!$force_transfer && $env_loaded) { return; }
329:
330: if (!defined($lonidsdir)) {
331: $lonidsdir = $perlvar{'lonIDsDir'};
332: }
333: if (!defined($handle)) {
334: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
335: }
336:
337: my $convert;
338: {
339: open(my $idf,"$lonidsdir/$handle.id");
340: flock($idf,LOCK_SH);
341: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
342: &GDBM_READER(),0640)) {
343: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
344: untie(%disk_env);
345: } else {
346: $convert = 1;
347: }
348: }
349: if ($convert) {
350: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
351: &logthis("Failed to load session, or convert session.");
352: }
353: }
354:
355: my %remove;
356: while ( my $envname = each(%env) ) {
357: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
358: if ($time < time-300) {
359: $remove{$key}++;
360: }
361: }
362: }
363:
364: $env{'user.environment'} = "$lonidsdir/$handle.id";
365: $env_loaded=1;
366: foreach my $expired_key (keys(%remove)) {
367: &delenv($expired_key);
368: }
369: }
370:
371: # ---------------------------------------------------------- Append Environment
372:
373: sub appenv {
374: my %newenv=@_;
375: foreach my $key (keys(%newenv)) {
376: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
377: &logthis("<font color=\"blue\">WARNING: ".
378: "Attempt to modify environment ".$key." to ".$newenv{$key}
379: .'</font>');
380: delete($newenv{$key});
381: } else {
382: $env{$key}=$newenv{$key};
383: }
384: }
385: if (tie(my %disk_env,'GDBM_File',$env{'user.environment'},&GDBM_WRITER(),
386: 0640)) {
387: while (my ($key,$value) = each(%newenv)) {
388: $disk_env{$key} = $value;
389: }
390: untie(%disk_env);
391: }
392: return 'ok';
393: }
394: # ----------------------------------------------------- Delete from Environment
395:
396: sub delenv {
397: my $delthis=shift;
398: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
399: &logthis("<font color=\"blue\">WARNING: ".
400: "Attempt to delete from environment ".$delthis);
401: return 'error';
402: }
403: if (tie(my %disk_env,'GDBM_File',$env{'user.environment'},&GDBM_WRITER(),
404: 0640)) {
405: foreach my $key (keys(%disk_env)) {
406: if ($key=~/^$delthis/) {
407: delete($env{$key});
408: delete($disk_env{$key});
409: }
410: }
411: untie(%disk_env);
412: }
413: return 'ok';
414: }
415:
416: sub get_env_multiple {
417: my ($name) = @_;
418: my @values;
419: if (defined($env{$name})) {
420: # exists is it an array
421: if (ref($env{$name})) {
422: @values=@{ $env{$name} };
423: } else {
424: $values[0]=$env{$name};
425: }
426: }
427: return(@values);
428: }
429:
430: # ------------------------------------------ Find out current server userload
431: # there is a copy in lond
432: sub userload {
433: my $numusers=0;
434: {
435: opendir(LONIDS,$perlvar{'lonIDsDir'});
436: my $filename;
437: my $curtime=time;
438: while ($filename=readdir(LONIDS)) {
439: if ($filename eq '.' || $filename eq '..') {next;}
440: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
441: if ($curtime-$mtime < 1800) { $numusers++; }
442: }
443: closedir(LONIDS);
444: }
445: my $userloadpercent=0;
446: my $maxuserload=$perlvar{'lonUserLoadLim'};
447: if ($maxuserload) {
448: $userloadpercent=100*$numusers/$maxuserload;
449: }
450: $userloadpercent=sprintf("%.2f",$userloadpercent);
451: return $userloadpercent;
452: }
453:
454: # ------------------------------------------ Fight off request when overloaded
455:
456: sub overloaderror {
457: my ($r,$checkserver)=@_;
458: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
459: my $loadavg;
460: if ($checkserver eq $perlvar{'lonHostID'}) {
461: open(my $loadfile,'/proc/loadavg');
462: $loadavg=<$loadfile>;
463: $loadavg =~ s/\s.*//g;
464: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
465: close($loadfile);
466: } else {
467: $loadavg=&reply('load',$checkserver);
468: }
469: my $overload=$loadavg-100;
470: if ($overload>0) {
471: $r->err_headers_out->{'Retry-After'}=$overload;
472: $r->log_error('Overload of '.$overload.' on '.$checkserver);
473: return 413;
474: }
475: return '';
476: }
477:
478: # ------------------------------ Find server with least workload from spare.tab
479:
480: sub spareserver {
481: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
482: my $spare_server;
483: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
484: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
485: : $userloadpercent;
486:
487: foreach my $try_server (@{ $spareid{'primary'} }) {
488: ($spare_server, $lowest_load) =
489: &compare_server_load($try_server, $spare_server, $lowest_load);
490: }
491:
492: my $found_server = ($spare_server ne '' && $lowest_load < 100);
493:
494: if (!$found_server) {
495: foreach my $try_server (@{ $spareid{'default'} }) {
496: ($spare_server, $lowest_load) =
497: &compare_server_load($try_server, $spare_server, $lowest_load);
498: }
499: }
500:
501: if (!$want_server_name) {
502: $spare_server="http://$hostname{$spare_server}";
503: }
504: return $spare_server;
505: }
506:
507: sub compare_server_load {
508: my ($try_server, $spare_server, $lowest_load) = @_;
509:
510: my $loadans = &reply('load', $try_server);
511: my $userloadans = &reply('userload',$try_server);
512:
513: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
514: next; #didn't get a number from the server
515: }
516:
517: my $load;
518: if ($loadans =~ /\d/) {
519: if ($userloadans =~ /\d/) {
520: #both are numbers, pick the bigger one
521: $load = ($loadans > $userloadans) ? $loadans
522: : $userloadans;
523: } else {
524: $load = $loadans;
525: }
526: } else {
527: $load = $userloadans;
528: }
529:
530: if (($load =~ /\d/) && ($load < $lowest_load)) {
531: $spare_server = $try_server;
532: $lowest_load = $load;
533: }
534: return ($spare_server,$lowest_load);
535: }
536: # --------------------------------------------- Try to change a user's password
537:
538: sub changepass {
539: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
540: $currentpass = &escape($currentpass);
541: $newpass = &escape($newpass);
542: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
543: $server);
544: if (! $answer) {
545: &logthis("No reply on password change request to $server ".
546: "by $uname in domain $udom.");
547: } elsif ($answer =~ "^ok") {
548: &logthis("$uname in $udom successfully changed their password ".
549: "on $server.");
550: } elsif ($answer =~ "^pwchange_failure") {
551: &logthis("$uname in $udom was unable to change their password ".
552: "on $server. The action was blocked by either lcpasswd ".
553: "or pwchange");
554: } elsif ($answer =~ "^non_authorized") {
555: &logthis("$uname in $udom did not get their password correct when ".
556: "attempting to change it on $server.");
557: } elsif ($answer =~ "^auth_mode_error") {
558: &logthis("$uname in $udom attempted to change their password despite ".
559: "not being locally or internally authenticated on $server.");
560: } elsif ($answer =~ "^unknown_user") {
561: &logthis("$uname in $udom attempted to change their password ".
562: "on $server but were unable to because $server is not ".
563: "their home server.");
564: } elsif ($answer =~ "^refused") {
565: &logthis("$server refused to change $uname in $udom password because ".
566: "it was sent an unencrypted request to change the password.");
567: }
568: return $answer;
569: }
570:
571: # ----------------------- Try to determine user's current authentication scheme
572:
573: sub queryauthenticate {
574: my ($uname,$udom)=@_;
575: my $uhome=&homeserver($uname,$udom);
576: if (!$uhome) {
577: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
578: return 'no_host';
579: }
580: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
581: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
582: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
583: }
584: return $answer;
585: }
586:
587: # --------- Try to authenticate user from domain's lib servers (first this one)
588:
589: sub authenticate {
590: my ($uname,$upass,$udom)=@_;
591: $upass=&escape($upass);
592: $uname= &LONCAPA::clean_username($uname);
593: my $uhome=&homeserver($uname,$udom);
594: if (!$uhome) {
595: &logthis("User $uname at $udom is unknown in authenticate");
596: return 'no_host';
597: }
598: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
599: if ($answer eq 'authorized') {
600: &logthis("User $uname at $udom authorized by $uhome");
601: return $uhome;
602: }
603: if ($answer eq 'non_authorized') {
604: &logthis("User $uname at $udom rejected by $uhome");
605: return 'no_host';
606: }
607: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
608: return 'no_host';
609: }
610:
611: # ---------------------- Find the homebase for a user from domain's lib servers
612:
613: my %homecache;
614: sub homeserver {
615: my ($uname,$udom,$ignoreBadCache)=@_;
616: my $index="$uname:$udom";
617:
618: if (exists($homecache{$index})) { return $homecache{$index}; }
619: my $tryserver;
620: foreach $tryserver (keys %libserv) {
621: next if ($ignoreBadCache ne 'true' &&
622: exists($badServerCache{$tryserver}));
623: if ($hostdom{$tryserver} eq $udom) {
624: my $answer=reply("home:$udom:$uname",$tryserver);
625: if ($answer eq 'found') {
626: return $homecache{$index}=$tryserver;
627: } elsif ($answer eq 'no_host') {
628: $badServerCache{$tryserver}=1;
629: }
630: }
631: }
632: return 'no_host';
633: }
634:
635: # ------------------------------------- Find the usernames behind a list of IDs
636:
637: sub idget {
638: my ($udom,@ids)=@_;
639: my %returnhash=();
640:
641: my $tryserver;
642: foreach $tryserver (keys %libserv) {
643: if ($hostdom{$tryserver} eq $udom) {
644: my $idlist=join('&',@ids);
645: $idlist=~tr/A-Z/a-z/;
646: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
647: my @answer=();
648: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
649: @answer=split(/\&/,$reply);
650: } ;
651: my $i;
652: for ($i=0;$i<=$#ids;$i++) {
653: if ($answer[$i]) {
654: $returnhash{$ids[$i]}=$answer[$i];
655: }
656: }
657: }
658: }
659: return %returnhash;
660: }
661:
662: # ------------------------------------- Find the IDs behind a list of usernames
663:
664: sub idrget {
665: my ($udom,@unames)=@_;
666: my %returnhash=();
667: foreach my $uname (@unames) {
668: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
669: }
670: return %returnhash;
671: }
672:
673: # ------------------------------- Store away a list of names and associated IDs
674:
675: sub idput {
676: my ($udom,%ids)=@_;
677: my %servers=();
678: foreach my $uname (keys(%ids)) {
679: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
680: my $uhom=&homeserver($uname,$udom);
681: if ($uhom ne 'no_host') {
682: my $id=&escape($ids{$uname});
683: $id=~tr/A-Z/a-z/;
684: my $esc_unam=&escape($uname);
685: if ($servers{$uhom}) {
686: $servers{$uhom}.='&'.$id.'='.$esc_unam;
687: } else {
688: $servers{$uhom}=$id.'='.$esc_unam;
689: }
690: }
691: }
692: foreach my $server (keys(%servers)) {
693: &critical('idput:'.$udom.':'.$servers{$server},$server);
694: }
695: }
696:
697: # ------------------------------------------- get items from domain db files
698:
699: sub get_dom {
700: my ($namespace,$storearr,$udom)=@_;
701: my $items='';
702: foreach my $item (@$storearr) {
703: $items.=&escape($item).'&';
704: }
705: $items=~s/\&$//;
706: if (!$udom) { $udom=$env{'user.domain'}; }
707: if (exists($domain_primary{$udom})) {
708: my $uhome=$domain_primary{$udom};
709: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
710: my @pairs=split(/\&/,$rep);
711: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
712: return @pairs;
713: }
714: my %returnhash=();
715: my $i=0;
716: foreach my $item (@$storearr) {
717: $returnhash{$item}=&thaw_unescape($pairs[$i]);
718: $i++;
719: }
720: return %returnhash;
721: } else {
722: &logthis("get_dom failed - no primary domain server for $udom");
723: }
724: }
725:
726: # -------------------------------------------- put items in domain db files
727:
728: sub put_dom {
729: my ($namespace,$storehash,$udom)=@_;
730: if (!$udom) { $udom=$env{'user.domain'}; }
731: if (exists($domain_primary{$udom})) {
732: my $uhome=$domain_primary{$udom};
733: my $items='';
734: foreach my $item (keys(%$storehash)) {
735: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
736: }
737: $items=~s/\&$//;
738: return &reply("putdom:$udom:$namespace:$items",$uhome);
739: } else {
740: &logthis("put_dom failed - no primary domain server for $udom");
741: }
742: }
743:
744: # --------------------------------------------------- Assign a key to a student
745:
746: sub assign_access_key {
747: #
748: # a valid key looks like uname:udom#comments
749: # comments are being appended
750: #
751: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
752: $kdom=
753: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
754: $knum=
755: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
756: $cdom=
757: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
758: $cnum=
759: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
760: $udom=$env{'user.name'} unless (defined($udom));
761: $uname=$env{'user.domain'} unless (defined($uname));
762: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
763: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
764: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
765: # assigned to this person
766: # - this should not happen,
767: # unless something went wrong
768: # the first time around
769: # ready to assign
770: $logentry=$1.'; '.$logentry;
771: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
772: $kdom,$knum) eq 'ok') {
773: # key now belongs to user
774: my $envkey='key.'.$cdom.'_'.$cnum;
775: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
776: &appenv('environment.'.$envkey => $ckey);
777: return 'ok';
778: } else {
779: return
780: 'error: Count not permanently assign key, will need to be re-entered later.';
781: }
782: } else {
783: return 'error: Could not assign key, try again later.';
784: }
785: } elsif (!$existing{$ckey}) {
786: # the key does not exist
787: return 'error: The key does not exist';
788: } else {
789: # the key is somebody else's
790: return 'error: The key is already in use';
791: }
792: }
793:
794: # ------------------------------------------ put an additional comment on a key
795:
796: sub comment_access_key {
797: #
798: # a valid key looks like uname:udom#comments
799: # comments are being appended
800: #
801: my ($ckey,$cdom,$cnum,$logentry)=@_;
802: $cdom=
803: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
804: $cnum=
805: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
806: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
807: if ($existing{$ckey}) {
808: $existing{$ckey}.='; '.$logentry;
809: # ready to assign
810: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
811: $cdom,$cnum) eq 'ok') {
812: return 'ok';
813: } else {
814: return 'error: Count not store comment.';
815: }
816: } else {
817: # the key does not exist
818: return 'error: The key does not exist';
819: }
820: }
821:
822: # ------------------------------------------------------ Generate a set of keys
823:
824: sub generate_access_keys {
825: my ($number,$cdom,$cnum,$logentry)=@_;
826: $cdom=
827: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
828: $cnum=
829: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
830: unless (&allowed('mky',$cdom)) { return 0; }
831: unless (($cdom) && ($cnum)) { return 0; }
832: if ($number>10000) { return 0; }
833: sleep(2); # make sure don't get same seed twice
834: srand(time()^($$+($$<<15))); # from "Programming Perl"
835: my $total=0;
836: for (my $i=1;$i<=$number;$i++) {
837: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
838: sprintf("%lx",int(100000*rand)).'-'.
839: sprintf("%lx",int(100000*rand));
840: $newkey=~s/1/g/g; # folks mix up 1 and l
841: $newkey=~s/0/h/g; # and also 0 and O
842: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
843: if ($existing{$newkey}) {
844: $i--;
845: } else {
846: if (&put('accesskeys',
847: { $newkey => '# generated '.localtime().
848: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
849: '; '.$logentry },
850: $cdom,$cnum) eq 'ok') {
851: $total++;
852: }
853: }
854: }
855: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
856: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
857: return $total;
858: }
859:
860: # ------------------------------------------------------- Validate an accesskey
861:
862: sub validate_access_key {
863: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
864: $cdom=
865: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
866: $cnum=
867: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
868: $udom=$env{'user.domain'} unless (defined($udom));
869: $uname=$env{'user.name'} unless (defined($uname));
870: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
871: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
872: }
873:
874: # ------------------------------------- Find the section of student in a course
875: sub devalidate_getsection_cache {
876: my ($udom,$unam,$courseid)=@_;
877: my $hashid="$udom:$unam:$courseid";
878: &devalidate_cache_new('getsection',$hashid);
879: }
880:
881: sub getsection {
882: my ($udom,$unam,$courseid)=@_;
883: my $cachetime=1800;
884:
885: my $hashid="$udom:$unam:$courseid";
886: my ($result,$cached)=&is_cached_new('getsection',$hashid);
887: if (defined($cached)) { return $result; }
888:
889: my %Pending;
890: my %Expired;
891: #
892: # Each role can either have not started yet (pending), be active,
893: # or have expired.
894: #
895: # If there is an active role, we are done.
896: #
897: # If there is more than one role which has not started yet,
898: # choose the one which will start sooner
899: # If there is one role which has not started yet, return it.
900: #
901: # If there is more than one expired role, choose the one which ended last.
902: # If there is a role which has expired, return it.
903: #
904: foreach my $line (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
905: &homeserver($unam,$udom)))) {
906: my ($key,$value)=split(/\=/,$line,2);
907: $key=&unescape($key);
908: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
909: my $section=$1;
910: if ($key eq $courseid.'_st') { $section=''; }
911: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
912: my $now=time;
913: if (defined($end) && $end && ($now > $end)) {
914: $Expired{$end}=$section;
915: next;
916: }
917: if (defined($start) && $start && ($now < $start)) {
918: $Pending{$start}=$section;
919: next;
920: }
921: return &do_cache_new('getsection',$hashid,$section,$cachetime);
922: }
923: #
924: # Presumedly there will be few matching roles from the above
925: # loop and the sorting time will be negligible.
926: if (scalar(keys(%Pending))) {
927: my ($time) = sort {$a <=> $b} keys(%Pending);
928: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
929: }
930: if (scalar(keys(%Expired))) {
931: my @sorted = sort {$a <=> $b} keys(%Expired);
932: my $time = pop(@sorted);
933: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
934: }
935: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
936: }
937:
938: sub save_cache {
939: &purge_remembered();
940: #&Apache::loncommon::validate_page();
941: undef(%env);
942: undef($env_loaded);
943: }
944:
945: my $to_remember=-1;
946: my %remembered;
947: my %accessed;
948: my $kicks=0;
949: my $hits=0;
950: sub devalidate_cache_new {
951: my ($name,$id,$debug) = @_;
952: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
953: $id=&escape($name.':'.$id);
954: $memcache->delete($id);
955: delete($remembered{$id});
956: delete($accessed{$id});
957: }
958:
959: sub is_cached_new {
960: my ($name,$id,$debug) = @_;
961: $id=&escape($name.':'.$id);
962: if (exists($remembered{$id})) {
963: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
964: $accessed{$id}=[&gettimeofday()];
965: $hits++;
966: return ($remembered{$id},1);
967: }
968: my $value = $memcache->get($id);
969: if (!(defined($value))) {
970: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
971: return (undef,undef);
972: }
973: if ($value eq '__undef__') {
974: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
975: $value=undef;
976: }
977: &make_room($id,$value,$debug);
978: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
979: return ($value,1);
980: }
981:
982: sub do_cache_new {
983: my ($name,$id,$value,$time,$debug) = @_;
984: $id=&escape($name.':'.$id);
985: my $setvalue=$value;
986: if (!defined($setvalue)) {
987: $setvalue='__undef__';
988: }
989: if (!defined($time) ) {
990: $time=600;
991: }
992: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
993: $memcache->set($id,$setvalue,$time);
994: # need to make a copy of $value
995: #&make_room($id,$value,$debug);
996: return $value;
997: }
998:
999: sub make_room {
1000: my ($id,$value,$debug)=@_;
1001: $remembered{$id}=$value;
1002: if ($to_remember<0) { return; }
1003: $accessed{$id}=[&gettimeofday()];
1004: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1005: my $to_kick;
1006: my $max_time=0;
1007: foreach my $other (keys(%accessed)) {
1008: if (&tv_interval($accessed{$other}) > $max_time) {
1009: $to_kick=$other;
1010: $max_time=&tv_interval($accessed{$other});
1011: }
1012: }
1013: delete($remembered{$to_kick});
1014: delete($accessed{$to_kick});
1015: $kicks++;
1016: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1017: return;
1018: }
1019:
1020: sub purge_remembered {
1021: #&logthis("Tossing ".scalar(keys(%remembered)));
1022: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1023: undef(%remembered);
1024: undef(%accessed);
1025: }
1026: # ------------------------------------- Read an entry from a user's environment
1027:
1028: sub userenvironment {
1029: my ($udom,$unam,@what)=@_;
1030: my %returnhash=();
1031: my @answer=split(/\&/,
1032: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1033: &homeserver($unam,$udom)));
1034: my $i;
1035: for ($i=0;$i<=$#what;$i++) {
1036: $returnhash{$what[$i]}=&unescape($answer[$i]);
1037: }
1038: return %returnhash;
1039: }
1040:
1041: # ---------------------------------------------------------- Get a studentphoto
1042: sub studentphoto {
1043: my ($udom,$unam,$ext) = @_;
1044: my $home=&Apache::lonnet::homeserver($unam,$udom);
1045: if (defined($env{'request.course.id'})) {
1046: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1047: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1048: return(&retrievestudentphoto($udom,$unam,$ext));
1049: } else {
1050: my ($result,$perm_reqd)=
1051: &Apache::lonnet::auto_photo_permission($unam,$udom);
1052: if ($result eq 'ok') {
1053: if (!($perm_reqd eq 'yes')) {
1054: return(&retrievestudentphoto($udom,$unam,$ext));
1055: }
1056: }
1057: }
1058: }
1059: } else {
1060: my ($result,$perm_reqd) =
1061: &Apache::lonnet::auto_photo_permission($unam,$udom);
1062: if ($result eq 'ok') {
1063: if (!($perm_reqd eq 'yes')) {
1064: return(&retrievestudentphoto($udom,$unam,$ext));
1065: }
1066: }
1067: }
1068: return '/adm/lonKaputt/lonlogo_broken.gif';
1069: }
1070:
1071: sub retrievestudentphoto {
1072: my ($udom,$unam,$ext,$type) = @_;
1073: my $home=&Apache::lonnet::homeserver($unam,$udom);
1074: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1075: if ($ret eq 'ok') {
1076: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1077: if ($type eq 'thumbnail') {
1078: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1079: }
1080: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1081: return $tokenurl;
1082: } else {
1083: if ($type eq 'thumbnail') {
1084: return '/adm/lonKaputt/genericstudent_tn.gif';
1085: } else {
1086: return '/adm/lonKaputt/lonlogo_broken.gif';
1087: }
1088: }
1089: }
1090:
1091: # -------------------------------------------------------------------- New chat
1092:
1093: sub chatsend {
1094: my ($newentry,$anon,$group)=@_;
1095: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1096: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1097: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1098: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1099: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1100: &escape($newentry)).':'.$group,$chome);
1101: }
1102:
1103: # ------------------------------------------ Find current version of a resource
1104:
1105: sub getversion {
1106: my $fname=&clutter(shift);
1107: unless ($fname=~/^\/res\//) { return -1; }
1108: return ¤tversion(&filelocation('',$fname));
1109: }
1110:
1111: sub currentversion {
1112: my $fname=shift;
1113: my ($result,$cached)=&is_cached_new('resversion',$fname);
1114: if (defined($cached)) { return $result; }
1115: my $author=$fname;
1116: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1117: my ($udom,$uname)=split(/\//,$author);
1118: my $home=homeserver($uname,$udom);
1119: if ($home eq 'no_host') {
1120: return -1;
1121: }
1122: my $answer=reply("currentversion:$fname",$home);
1123: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1124: return -1;
1125: }
1126: return &do_cache_new('resversion',$fname,$answer,600);
1127: }
1128:
1129: # ----------------------------- Subscribe to a resource, return URL if possible
1130:
1131: sub subscribe {
1132: my $fname=shift;
1133: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1134: $fname=~s/[\n\r]//g;
1135: my $author=$fname;
1136: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1137: my ($udom,$uname)=split(/\//,$author);
1138: my $home=homeserver($uname,$udom);
1139: if ($home eq 'no_host') {
1140: return 'not_found';
1141: }
1142: my $answer=reply("sub:$fname",$home);
1143: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1144: $answer.=' by '.$home;
1145: }
1146: return $answer;
1147: }
1148:
1149: # -------------------------------------------------------------- Replicate file
1150:
1151: sub repcopy {
1152: my $filename=shift;
1153: $filename=~s/\/+/\//g;
1154: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1155: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1156: if ($filename=~m|^/home/httpd/html/userfiles/| or
1157: $filename=~m -^/*(uploaded|editupload)/-) {
1158: return &repcopy_userfile($filename);
1159: }
1160: $filename=~s/[\n\r]//g;
1161: my $transname="$filename.in.transfer";
1162: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1163: my $remoteurl=subscribe($filename);
1164: if ($remoteurl =~ /^con_lost by/) {
1165: &logthis("Subscribe returned $remoteurl: $filename");
1166: return 'unavailable';
1167: } elsif ($remoteurl eq 'not_found') {
1168: #&logthis("Subscribe returned not_found: $filename");
1169: return 'not_found';
1170: } elsif ($remoteurl =~ /^rejected by/) {
1171: &logthis("Subscribe returned $remoteurl: $filename");
1172: return 'forbidden';
1173: } elsif ($remoteurl eq 'directory') {
1174: return 'ok';
1175: } else {
1176: my $author=$filename;
1177: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1178: my ($udom,$uname)=split(/\//,$author);
1179: my $home=homeserver($uname,$udom);
1180: unless ($home eq $perlvar{'lonHostID'}) {
1181: my @parts=split(/\//,$filename);
1182: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1183: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1184: &logthis("Malconfiguration for replication: $filename");
1185: return 'bad_request';
1186: }
1187: my $count;
1188: for ($count=5;$count<$#parts;$count++) {
1189: $path.="/$parts[$count]";
1190: if ((-e $path)!=1) {
1191: mkdir($path,0777);
1192: }
1193: }
1194: my $ua=new LWP::UserAgent;
1195: my $request=new HTTP::Request('GET',"$remoteurl");
1196: my $response=$ua->request($request,$transname);
1197: if ($response->is_error()) {
1198: unlink($transname);
1199: my $message=$response->status_line;
1200: &logthis("<font color=\"blue\">WARNING:"
1201: ." LWP get: $message: $filename</font>");
1202: return 'unavailable';
1203: } else {
1204: if ($remoteurl!~/\.meta$/) {
1205: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1206: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1207: if ($mresponse->is_error()) {
1208: unlink($filename.'.meta');
1209: &logthis(
1210: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1211: }
1212: }
1213: rename($transname,$filename);
1214: return 'ok';
1215: }
1216: }
1217: }
1218: }
1219:
1220: # ------------------------------------------------ Get server side include body
1221: sub ssi_body {
1222: my ($filelink,%form)=@_;
1223: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1224: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1225: }
1226: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1227: &ssi($filelink,%form));
1228: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1229: $output=~s/^.*?\<body[^\>]*\>//si;
1230: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1231: return $output;
1232: }
1233:
1234: # --------------------------------------------------------- Server Side Include
1235:
1236: sub absolute_url {
1237: my ($host_name) = @_;
1238: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1239: if ($host_name eq '') {
1240: $host_name = $ENV{'SERVER_NAME'};
1241: }
1242: return $protocol.$host_name;
1243: }
1244:
1245: sub ssi {
1246:
1247: my ($fn,%form)=@_;
1248:
1249: my $ua=new LWP::UserAgent;
1250:
1251: my $request;
1252:
1253: $form{'no_update_last_known'}=1;
1254:
1255: if (%form) {
1256: $request=new HTTP::Request('POST',&absolute_url().$fn);
1257: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1258: } else {
1259: $request=new HTTP::Request('GET',&absolute_url().$fn);
1260: }
1261:
1262: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1263: my $response=$ua->request($request);
1264:
1265: return $response->content;
1266: }
1267:
1268: sub externalssi {
1269: my ($url)=@_;
1270: my $ua=new LWP::UserAgent;
1271: my $request=new HTTP::Request('GET',$url);
1272: my $response=$ua->request($request);
1273: return $response->content;
1274: }
1275:
1276: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1277:
1278: sub allowuploaded {
1279: my ($srcurl,$url)=@_;
1280: $url=&clutter(&declutter($url));
1281: my $dir=$url;
1282: $dir=~s/\/[^\/]+$//;
1283: my %httpref=();
1284: my $httpurl=&hreflocation('',$url);
1285: $httpref{'httpref.'.$httpurl}=$srcurl;
1286: &Apache::lonnet::appenv(%httpref);
1287: }
1288:
1289: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1290: # input: action, courseID, current domain, intended
1291: # path to file, source of file, instruction to parse file for objects,
1292: # ref to hash for embedded objects,
1293: # ref to hash for codebase of java objects.
1294: #
1295: # output: url to file (if action was uploaddoc),
1296: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1297: #
1298: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1299: # course.
1300: #
1301: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1302: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1303: # course's home server.
1304: #
1305: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1306: # be copied from $source (current location) to
1307: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1308: # and will then be copied to
1309: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1310: # course's home server.
1311: #
1312: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1313: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1314: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1315: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1316: # in course's home server.
1317: #
1318:
1319: sub process_coursefile {
1320: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1321: my $fetchresult;
1322: my $home=&homeserver($docuname,$docudom);
1323: if ($action eq 'propagate') {
1324: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1325: $home);
1326: } else {
1327: my $fpath = '';
1328: my $fname = $file;
1329: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1330: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1331: my $filepath = &build_filepath($fpath);
1332: if ($action eq 'copy') {
1333: if ($source eq '') {
1334: $fetchresult = 'no source file';
1335: return $fetchresult;
1336: } else {
1337: my $destination = $filepath.'/'.$fname;
1338: rename($source,$destination);
1339: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1340: $home);
1341: }
1342: } elsif ($action eq 'uploaddoc') {
1343: open(my $fh,'>'.$filepath.'/'.$fname);
1344: print $fh $env{'form.'.$source};
1345: close($fh);
1346: if ($parser eq 'parse') {
1347: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1348: unless ($parse_result eq 'ok') {
1349: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1350: }
1351: }
1352: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1353: $home);
1354: if ($fetchresult eq 'ok') {
1355: return '/uploaded/'.$fpath.'/'.$fname;
1356: } else {
1357: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1358: ' to host '.$home.': '.$fetchresult);
1359: return '/adm/notfound.html';
1360: }
1361: }
1362: }
1363: unless ( $fetchresult eq 'ok') {
1364: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1365: ' to host '.$home.': '.$fetchresult);
1366: }
1367: return $fetchresult;
1368: }
1369:
1370: sub build_filepath {
1371: my ($fpath) = @_;
1372: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1373: unless ($fpath eq '') {
1374: my @parts=split('/',$fpath);
1375: foreach my $part (@parts) {
1376: $filepath.= '/'.$part;
1377: if ((-e $filepath)!=1) {
1378: mkdir($filepath,0777);
1379: }
1380: }
1381: }
1382: return $filepath;
1383: }
1384:
1385: sub store_edited_file {
1386: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1387: my $file = $primary_url;
1388: $file =~ s#^/uploaded/$docudom/$docuname/##;
1389: my $fpath = '';
1390: my $fname = $file;
1391: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1392: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1393: my $filepath = &build_filepath($fpath);
1394: open(my $fh,'>'.$filepath.'/'.$fname);
1395: print $fh $content;
1396: close($fh);
1397: my $home=&homeserver($docuname,$docudom);
1398: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1399: $home);
1400: if ($$fetchresult eq 'ok') {
1401: return '/uploaded/'.$fpath.'/'.$fname;
1402: } else {
1403: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1404: ' to host '.$home.': '.$$fetchresult);
1405: return '/adm/notfound.html';
1406: }
1407: }
1408:
1409: sub clean_filename {
1410: my ($fname)=@_;
1411: # Replace Windows backslashes by forward slashes
1412: $fname=~s/\\/\//g;
1413: # Get rid of everything but the actual filename
1414: $fname=~s/^.*\/([^\/]+)$/$1/;
1415: # Replace spaces by underscores
1416: $fname=~s/\s+/\_/g;
1417: # Replace all other weird characters by nothing
1418: $fname=~s/[^\w\.\-]//g;
1419: # Replace all .\d. sequences with _\d. so they no longer look like version
1420: # numbers
1421: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1422: return $fname;
1423: }
1424:
1425: # --------------- Take an uploaded file and put it into the userfiles directory
1426: # input: $formname - the contents of the file are in $env{"form.$formname"}
1427: # the desired filenam is in $env{"form.$formname.filename"}
1428: # $coursedoc - if true up to the current course
1429: # if false
1430: # $subdir - directory in userfile to store the file into
1431: # $parser, $allfiles, $codebase - unknown
1432: #
1433: # output: url of file in userspace, or error: <message>
1434: # or /adm/notfound.html if failure to upload occurse
1435:
1436:
1437: sub userfileupload {
1438: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1439: if (!defined($subdir)) { $subdir='unknown'; }
1440: my $fname=$env{'form.'.$formname.'.filename'};
1441: $fname=&clean_filename($fname);
1442: # See if there is anything left
1443: unless ($fname) { return 'error: no uploaded file'; }
1444: chop($env{'form.'.$formname});
1445: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1446: my $now = time;
1447: my $filepath = 'tmp/helprequests/'.$now;
1448: my @parts=split(/\//,$filepath);
1449: my $fullpath = $perlvar{'lonDaemons'};
1450: for (my $i=0;$i<@parts;$i++) {
1451: $fullpath .= '/'.$parts[$i];
1452: if ((-e $fullpath)!=1) {
1453: mkdir($fullpath,0777);
1454: }
1455: }
1456: open(my $fh,'>'.$fullpath.'/'.$fname);
1457: print $fh $env{'form.'.$formname};
1458: close($fh);
1459: return $fullpath.'/'.$fname;
1460: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1461: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1462: '_'.$env{'user.domain'}.'/pending';
1463: my @parts=split(/\//,$filepath);
1464: my $fullpath = $perlvar{'lonDaemons'};
1465: for (my $i=0;$i<@parts;$i++) {
1466: $fullpath .= '/'.$parts[$i];
1467: if ((-e $fullpath)!=1) {
1468: mkdir($fullpath,0777);
1469: }
1470: }
1471: open(my $fh,'>'.$fullpath.'/'.$fname);
1472: print $fh $env{'form.'.$formname};
1473: close($fh);
1474: return $fullpath.'/'.$fname;
1475: }
1476:
1477: # Create the directory if not present
1478: $fname="$subdir/$fname";
1479: if ($coursedoc) {
1480: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1481: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1482: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1483: return &finishuserfileupload($docuname,$docudom,
1484: $formname,$fname,$parser,$allfiles,
1485: $codebase);
1486: } else {
1487: $fname=$env{'form.folder'}.'/'.$fname;
1488: return &process_coursefile('uploaddoc',$docuname,$docudom,
1489: $fname,$formname,$parser,
1490: $allfiles,$codebase);
1491: }
1492: } elsif (defined($destuname)) {
1493: my $docuname=$destuname;
1494: my $docudom=$destudom;
1495: return &finishuserfileupload($docuname,$docudom,$formname,
1496: $fname,$parser,$allfiles,$codebase);
1497:
1498: } else {
1499: my $docuname=$env{'user.name'};
1500: my $docudom=$env{'user.domain'};
1501: if (exists($env{'form.group'})) {
1502: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1503: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1504: }
1505: return &finishuserfileupload($docuname,$docudom,$formname,
1506: $fname,$parser,$allfiles,$codebase);
1507: }
1508: }
1509:
1510: sub finishuserfileupload {
1511: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1512: my $path=$docudom.'/'.$docuname.'/';
1513: my $filepath=$perlvar{'lonDocRoot'};
1514: my ($fnamepath,$file);
1515: $file=$fname;
1516: if ($fname=~m|/|) {
1517: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1518: $path.=$fnamepath.'/';
1519: }
1520: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1521: my $count;
1522: for ($count=4;$count<=$#parts;$count++) {
1523: $filepath.="/$parts[$count]";
1524: if ((-e $filepath)!=1) {
1525: mkdir($filepath,0777);
1526: }
1527: }
1528: # Save the file
1529: {
1530: if (!open(FH,'>'.$filepath.'/'.$file)) {
1531: &logthis('Failed to create '.$filepath.'/'.$file);
1532: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1533: return '/adm/notfound.html';
1534: }
1535: if (!print FH ($env{'form.'.$formname})) {
1536: &logthis('Failed to write to '.$filepath.'/'.$file);
1537: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1538: return '/adm/notfound.html';
1539: }
1540: close(FH);
1541: }
1542: if ($parser eq 'parse') {
1543: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1544: $codebase);
1545: unless ($parse_result eq 'ok') {
1546: &logthis('Failed to parse '.$filepath.$file.
1547: ' for embedded media: '.$parse_result);
1548: }
1549: }
1550: # Notify homeserver to grep it
1551: #
1552: my $docuhome=&homeserver($docuname,$docudom);
1553: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1554: if ($fetchresult eq 'ok') {
1555: #
1556: # Return the URL to it
1557: return '/uploaded/'.$path.$file;
1558: } else {
1559: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1560: ': '.$fetchresult);
1561: return '/adm/notfound.html';
1562: }
1563: }
1564:
1565: sub extract_embedded_items {
1566: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1567: my @state = ();
1568: my %javafiles = (
1569: codebase => '',
1570: code => '',
1571: archive => ''
1572: );
1573: my %mediafiles = (
1574: src => '',
1575: movie => '',
1576: );
1577: my $p;
1578: if ($content) {
1579: $p = HTML::LCParser->new($content);
1580: } else {
1581: $p = HTML::LCParser->new($filepath.'/'.$file);
1582: }
1583: while (my $t=$p->get_token()) {
1584: if ($t->[0] eq 'S') {
1585: my ($tagname, $attr) = ($t->[1],$t->[2]);
1586: push (@state, $tagname);
1587: if (lc($tagname) eq 'allow') {
1588: &add_filetype($allfiles,$attr->{'src'},'src');
1589: }
1590: if (lc($tagname) eq 'img') {
1591: &add_filetype($allfiles,$attr->{'src'},'src');
1592: }
1593: if (lc($tagname) eq 'script') {
1594: if ($attr->{'archive'} =~ /\.jar$/i) {
1595: &add_filetype($allfiles,$attr->{'archive'},'archive');
1596: } else {
1597: &add_filetype($allfiles,$attr->{'src'},'src');
1598: }
1599: }
1600: if (lc($tagname) eq 'link') {
1601: if (lc($attr->{'rel'}) eq 'stylesheet') {
1602: &add_filetype($allfiles,$attr->{'href'},'href');
1603: }
1604: }
1605: if (lc($tagname) eq 'object' ||
1606: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1607: foreach my $item (keys(%javafiles)) {
1608: $javafiles{$item} = '';
1609: }
1610: }
1611: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1612: my $name = lc($attr->{'name'});
1613: foreach my $item (keys(%javafiles)) {
1614: if ($name eq $item) {
1615: $javafiles{$item} = $attr->{'value'};
1616: last;
1617: }
1618: }
1619: foreach my $item (keys(%mediafiles)) {
1620: if ($name eq $item) {
1621: &add_filetype($allfiles, $attr->{'value'}, 'value');
1622: last;
1623: }
1624: }
1625: }
1626: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1627: foreach my $item (keys(%javafiles)) {
1628: if ($attr->{$item}) {
1629: $javafiles{$item} = $attr->{$item};
1630: last;
1631: }
1632: }
1633: foreach my $item (keys(%mediafiles)) {
1634: if ($attr->{$item}) {
1635: &add_filetype($allfiles,$attr->{$item},$item);
1636: last;
1637: }
1638: }
1639: }
1640: } elsif ($t->[0] eq 'E') {
1641: my ($tagname) = ($t->[1]);
1642: if ($javafiles{'codebase'} ne '') {
1643: $javafiles{'codebase'} .= '/';
1644: }
1645: if (lc($tagname) eq 'applet' ||
1646: lc($tagname) eq 'object' ||
1647: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1648: ) {
1649: foreach my $item (keys(%javafiles)) {
1650: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1651: my $file=$javafiles{'codebase'}.$javafiles{$item};
1652: &add_filetype($allfiles,$file,$item);
1653: }
1654: }
1655: }
1656: pop @state;
1657: }
1658: }
1659: return 'ok';
1660: }
1661:
1662: sub add_filetype {
1663: my ($allfiles,$file,$type)=@_;
1664: if (exists($allfiles->{$file})) {
1665: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1666: push(@{$allfiles->{$file}}, &escape($type));
1667: }
1668: } else {
1669: @{$allfiles->{$file}} = (&escape($type));
1670: }
1671: }
1672:
1673: sub removeuploadedurl {
1674: my ($url)=@_;
1675: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1676: return &removeuserfile($uname,$udom,$fname);
1677: }
1678:
1679: sub removeuserfile {
1680: my ($docuname,$docudom,$fname)=@_;
1681: my $home=&homeserver($docuname,$docudom);
1682: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1683: if ($result eq 'ok') {
1684: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
1685: my $metafile = $fname.'.meta';
1686: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1687: }
1688: }
1689: return $result;
1690: }
1691:
1692: sub mkdiruserfile {
1693: my ($docuname,$docudom,$dir)=@_;
1694: my $home=&homeserver($docuname,$docudom);
1695: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1696: }
1697:
1698: sub renameuserfile {
1699: my ($docuname,$docudom,$old,$new)=@_;
1700: my $home=&homeserver($docuname,$docudom);
1701: my $result = &reply("renameuserfile:$docudom:$docuname:".
1702: &escape("$old").':'.&escape("$new"),$home);
1703: if ($result eq 'ok') {
1704: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
1705: my $oldmeta = $old.'.meta';
1706: my $newmeta = $new.'.meta';
1707: my $metaresult =
1708: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1709: }
1710: }
1711: return $result;
1712: }
1713:
1714: # ------------------------------------------------------------------------- Log
1715:
1716: sub log {
1717: my ($dom,$nam,$hom,$what)=@_;
1718: return critical("log:$dom:$nam:$what",$hom);
1719: }
1720:
1721: # ------------------------------------------------------------------ Course Log
1722: #
1723: # This routine flushes several buffers of non-mission-critical nature
1724: #
1725:
1726: sub flushcourselogs {
1727: &logthis('Flushing log buffers');
1728: #
1729: # course logs
1730: # This is a log of all transactions in a course, which can be used
1731: # for data mining purposes
1732: #
1733: # It also collects the courseid database, which lists last transaction
1734: # times and course titles for all courseids
1735: #
1736: my %courseidbuffer=();
1737: foreach my $crsid (keys %courselogs) {
1738: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1739: &escape($courselogs{$crsid}),
1740: $coursehombuf{$crsid}) eq 'ok') {
1741: delete $courselogs{$crsid};
1742: } else {
1743: &logthis('Failed to flush log buffer for '.$crsid);
1744: if (length($courselogs{$crsid})>40000) {
1745: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1746: " exceeded maximum size, deleting.</font>");
1747: delete $courselogs{$crsid};
1748: }
1749: }
1750: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1751: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1752: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1753: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1754: } else {
1755: $courseidbuffer{$coursehombuf{$crsid}}=
1756: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1757: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1758: }
1759: }
1760: #
1761: # Write course id database (reverse lookup) to homeserver of courses
1762: # Is used in pickcourse
1763: #
1764: foreach my $crsid (keys(%courseidbuffer)) {
1765: &courseidput($hostdom{$crsid},$courseidbuffer{$crsid},$crsid);
1766: }
1767: #
1768: # File accesses
1769: # Writes to the dynamic metadata of resources to get hit counts, etc.
1770: #
1771: foreach my $entry (keys(%accesshash)) {
1772: if ($entry =~ /___count$/) {
1773: my ($dom,$name);
1774: ($dom,$name,undef)=
1775: ($entry=~m{___($match_domain)/($match_username)/(.*)___count$});
1776: if (! defined($dom) || $dom eq '' ||
1777: ! defined($name) || $name eq '') {
1778: my $cid = $env{'request.course.id'};
1779: $dom = $env{'request.'.$cid.'.domain'};
1780: $name = $env{'request.'.$cid.'.num'};
1781: }
1782: my $value = $accesshash{$entry};
1783: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1784: my %temphash=($url => $value);
1785: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1786: if ($result eq 'ok') {
1787: delete $accesshash{$entry};
1788: } elsif ($result eq 'unknown_cmd') {
1789: # Target server has old code running on it.
1790: my %temphash=($entry => $value);
1791: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1792: delete $accesshash{$entry};
1793: }
1794: }
1795: } else {
1796: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_username)/(.*)___(\w+)$});
1797: my %temphash=($entry => $accesshash{$entry});
1798: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1799: delete $accesshash{$entry};
1800: }
1801: }
1802: }
1803: #
1804: # Roles
1805: # Reverse lookup of user roles for course faculty/staff and co-authorship
1806: #
1807: foreach my $entry (keys(%userrolehash)) {
1808: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1809: split(/\:/,$entry);
1810: if (&Apache::lonnet::put('nohist_userroles',
1811: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1812: $rudom,$runame) eq 'ok') {
1813: delete $userrolehash{$entry};
1814: }
1815: }
1816: #
1817: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1818: #
1819: my %domrolebuffer = ();
1820: foreach my $entry (keys %domainrolehash) {
1821: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1822: if ($domrolebuffer{$rudom}) {
1823: $domrolebuffer{$rudom}.='&'.&escape($entry).
1824: '='.&escape($domainrolehash{$entry});
1825: } else {
1826: $domrolebuffer{$rudom}.=&escape($entry).
1827: '='.&escape($domainrolehash{$entry});
1828: }
1829: delete $domainrolehash{$entry};
1830: }
1831: foreach my $dom (keys(%domrolebuffer)) {
1832: foreach my $tryserver (keys %libserv) {
1833: if ($hostdom{$tryserver} eq $dom) {
1834: unless (&reply('domroleput:'.$dom.':'.
1835: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1836: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1837: }
1838: }
1839: }
1840: }
1841: $dumpcount++;
1842: }
1843:
1844: sub courselog {
1845: my $what=shift;
1846: $what=time.':'.$what;
1847: unless ($env{'request.course.id'}) { return ''; }
1848: $coursedombuf{$env{'request.course.id'}}=
1849: $env{'course.'.$env{'request.course.id'}.'.domain'};
1850: $coursenumbuf{$env{'request.course.id'}}=
1851: $env{'course.'.$env{'request.course.id'}.'.num'};
1852: $coursehombuf{$env{'request.course.id'}}=
1853: $env{'course.'.$env{'request.course.id'}.'.home'};
1854: $coursedescrbuf{$env{'request.course.id'}}=
1855: $env{'course.'.$env{'request.course.id'}.'.description'};
1856: $courseinstcodebuf{$env{'request.course.id'}}=
1857: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1858: $courseownerbuf{$env{'request.course.id'}}=
1859: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1860: $coursetypebuf{$env{'request.course.id'}}=
1861: $env{'course.'.$env{'request.course.id'}.'.type'};
1862: if (defined $courselogs{$env{'request.course.id'}}) {
1863: $courselogs{$env{'request.course.id'}}.='&'.$what;
1864: } else {
1865: $courselogs{$env{'request.course.id'}}.=$what;
1866: }
1867: if (length($courselogs{$env{'request.course.id'}})>4048) {
1868: &flushcourselogs();
1869: }
1870: }
1871:
1872: sub courseacclog {
1873: my $fnsymb=shift;
1874: unless ($env{'request.course.id'}) { return ''; }
1875: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1876: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1877: $what.=':POST';
1878: # FIXME: Probably ought to escape things....
1879: foreach my $key (keys(%env)) {
1880: if ($key=~/^form\.(.*)/) {
1881: $what.=':'.$1.'='.$env{$key};
1882: }
1883: }
1884: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1885: # FIXME: We should not be depending on a form parameter that someone
1886: # editing lonsearchcat.pm might change in the future.
1887: if ($env{'form.phase'} eq 'course_search') {
1888: $what.= ':POST';
1889: # FIXME: Probably ought to escape things....
1890: foreach my $element ('courseexp','crsfulltext','crsrelated',
1891: 'crsdiscuss') {
1892: $what.=':'.$element.'='.$env{'form.'.$element};
1893: }
1894: }
1895: }
1896: &courselog($what);
1897: }
1898:
1899: sub countacc {
1900: my $url=&declutter(shift);
1901: return if (! defined($url) || $url eq '');
1902: unless ($env{'request.course.id'}) { return ''; }
1903: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1904: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1905: $accesshash{$key}++;
1906: }
1907:
1908: sub linklog {
1909: my ($from,$to)=@_;
1910: $from=&declutter($from);
1911: $to=&declutter($to);
1912: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1913: $accesshash{$to.'___'.$from.'___goto'}=1;
1914: }
1915:
1916: sub userrolelog {
1917: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1918: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1919: ($trole=~/^in/) || ($trole=~/^cc/) ||
1920: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1921: ($trole=~/^ta/)) {
1922: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1923: $userrolehash
1924: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1925: =$tend.':'.$tstart;
1926: }
1927: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1928: ($trole=~/^li/) || ($trole=~/^li/) ||
1929: ($trole=~/^au/) || ($trole=~/^dg/) ||
1930: ($trole=~/^sc/)) {
1931: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1932: $domainrolehash
1933: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1934: = $tend.':'.$tstart;
1935: }
1936: }
1937:
1938: sub get_course_adv_roles {
1939: my $cid=shift;
1940: $cid=$env{'request.course.id'} unless (defined($cid));
1941: my %coursehash=&coursedescription($cid);
1942: my %nothide=();
1943: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1944: $nothide{join(':',split(/[\@\:]/,$user))}=1;
1945: }
1946: my %returnhash=();
1947: my %dumphash=
1948: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1949: my $now=time;
1950: foreach my $entry (keys %dumphash) {
1951: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1952: if (($tstart) && ($tstart<0)) { next; }
1953: if (($tend) && ($tend<$now)) { next; }
1954: if (($tstart) && ($now<$tstart)) { next; }
1955: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1956: if ($username eq '' || $domain eq '') { next; }
1957: if ((&privileged($username,$domain)) &&
1958: (!$nothide{$username.':'.$domain})) { next; }
1959: if ($role eq 'cr') { next; }
1960: my $key=&plaintext($role);
1961: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1962: if ($returnhash{$key}) {
1963: $returnhash{$key}.=','.$username.':'.$domain;
1964: } else {
1965: $returnhash{$key}=$username.':'.$domain;
1966: }
1967: }
1968: return %returnhash;
1969: }
1970:
1971: sub get_my_roles {
1972: my ($uname,$udom)=@_;
1973: unless (defined($uname)) { $uname=$env{'user.name'}; }
1974: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1975: my %dumphash=
1976: &dump('nohist_userroles',$udom,$uname);
1977: my %returnhash=();
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: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1986: }
1987: return %returnhash;
1988: }
1989:
1990: # ----------------------------------------------------- Frontpage Announcements
1991: #
1992: #
1993:
1994: sub postannounce {
1995: my ($server,$text)=@_;
1996: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1997: unless ($text=~/\w/) { $text=''; }
1998: return &reply('setannounce:'.&escape($text),$server);
1999: }
2000:
2001: sub getannounce {
2002:
2003: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2004: my $announcement='';
2005: while (my $line = <$fh>) { $announcement .= $line; }
2006: close($fh);
2007: if ($announcement=~/\w/) {
2008: return
2009: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2010: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2011: } else {
2012: return '';
2013: }
2014: } else {
2015: return '';
2016: }
2017: }
2018:
2019: # ---------------------------------------------------------- Course ID routines
2020: # Deal with domain's nohist_courseid.db files
2021: #
2022:
2023: sub courseidput {
2024: my ($domain,$what,$coursehome)=@_;
2025: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2026: }
2027:
2028: sub courseiddump {
2029: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
2030: my %returnhash=();
2031: unless ($domfilter) { $domfilter=''; }
2032: foreach my $tryserver (keys %libserv) {
2033: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
2034: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
2035: foreach my $line (
2036: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
2037: $sincefilter.':'.&escape($descfilter).':'.
2038: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter).':'.&escape($regexp_ok),
2039: $tryserver))) {
2040: my ($key,$value)=split(/\=/,$line,2);
2041: if (($key) && ($value)) {
2042: $returnhash{&unescape($key)}=$value;
2043: }
2044: }
2045: }
2046: }
2047: }
2048: return %returnhash;
2049: }
2050:
2051: # ---------------------------------------------------------- DC e-mail
2052:
2053: sub dcmailput {
2054: my ($domain,$msgid,$message,$server)=@_;
2055: my $status = &Apache::lonnet::critical(
2056: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2057: &escape($message),$server);
2058: return $status;
2059: }
2060:
2061: sub dcmaildump {
2062: my ($dom,$startdate,$enddate,$senders) = @_;
2063: my %returnhash=();
2064: if (exists($domain_primary{$dom})) {
2065: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2066: &escape($enddate).':';
2067: my @esc_senders=map { &escape($_)} @$senders;
2068: $cmd.=&escape(join('&',@esc_senders));
2069: foreach my $line (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
2070: my ($key,$value) = split(/\=/,$line,2);
2071: if (($key) && ($value)) {
2072: $returnhash{&unescape($key)} = &unescape($value);
2073: }
2074: }
2075: }
2076: return %returnhash;
2077: }
2078: # ---------------------------------------------------------- Domain roles
2079:
2080: sub get_domain_roles {
2081: my ($dom,$roles,$startdate,$enddate)=@_;
2082: if (undef($startdate) || $startdate eq '') {
2083: $startdate = '.';
2084: }
2085: if (undef($enddate) || $enddate eq '') {
2086: $enddate = '.';
2087: }
2088: my $rolelist = join(':',@{$roles});
2089: my %personnel = ();
2090: foreach my $tryserver (keys(%libserv)) {
2091: if ($hostdom{$tryserver} eq $dom) {
2092: %{$personnel{$tryserver}}=();
2093: foreach my $line (
2094: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2095: &escape($startdate).':'.&escape($enddate).':'.
2096: &escape($rolelist), $tryserver))) {
2097: my ($key,$value) = split(/\=/,$line,2);
2098: if (($key) && ($value)) {
2099: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2100: }
2101: }
2102: }
2103: }
2104: return %personnel;
2105: }
2106:
2107: # ----------------------------------------------------------- Check out an item
2108:
2109: sub get_first_access {
2110: my ($type,$argsymb)=@_;
2111: my ($symb,$courseid,$udom,$uname)=&whichuser();
2112: if ($argsymb) { $symb=$argsymb; }
2113: my ($map,$id,$res)=&decode_symb($symb);
2114: if ($type eq 'map') {
2115: $res=&symbread($map);
2116: } else {
2117: $res=$symb;
2118: }
2119: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2120: return $times{"$courseid\0$res"};
2121: }
2122:
2123: sub set_first_access {
2124: my ($type)=@_;
2125: my ($symb,$courseid,$udom,$uname)=&whichuser();
2126: my ($map,$id,$res)=&decode_symb($symb);
2127: if ($type eq 'map') {
2128: $res=&symbread($map);
2129: } else {
2130: $res=$symb;
2131: }
2132: my $firstaccess=&get_first_access($type,$symb);
2133: if (!$firstaccess) {
2134: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2135: }
2136: return 'already_set';
2137: }
2138:
2139: sub checkout {
2140: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2141: my $now=time;
2142: my $lonhost=$perlvar{'lonHostID'};
2143: my $infostr=&escape(
2144: 'CHECKOUTTOKEN&'.
2145: $tuname.'&'.
2146: $tudom.'&'.
2147: $tcrsid.'&'.
2148: $symb.'&'.
2149: $now.'&'.$ENV{'REMOTE_ADDR'});
2150: my $token=&reply('tmpput:'.$infostr,$lonhost);
2151: if ($token=~/^error\:/) {
2152: &logthis("<font color=\"blue\">WARNING: ".
2153: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2154: "</font>");
2155: return '';
2156: }
2157:
2158: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2159: $token=~tr/a-z/A-Z/;
2160:
2161: my %infohash=('resource.0.outtoken' => $token,
2162: 'resource.0.checkouttime' => $now,
2163: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2164:
2165: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2166: return '';
2167: } else {
2168: &logthis("<font color=\"blue\">WARNING: ".
2169: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2170: "</font>");
2171: }
2172:
2173: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2174: &escape('Checkout '.$infostr.' - '.
2175: $token)) ne 'ok') {
2176: return '';
2177: } else {
2178: &logthis("<font color=\"blue\">WARNING: ".
2179: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2180: "</font>");
2181: }
2182: return $token;
2183: }
2184:
2185: # ------------------------------------------------------------ Check in an item
2186:
2187: sub checkin {
2188: my $token=shift;
2189: my $now=time;
2190: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2191: $lonhost=~tr/A-Z/a-z/;
2192: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2193: $dtoken=~s/\W/\_/g;
2194: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2195: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2196:
2197: unless (($tuname) && ($tudom)) {
2198: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2199: return '';
2200: }
2201:
2202: unless (&allowed('mgr',$tcrsid)) {
2203: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2204: $env{'user.name'}.' - '.$env{'user.domain'});
2205: return '';
2206: }
2207:
2208: my %infohash=('resource.0.intoken' => $token,
2209: 'resource.0.checkintime' => $now,
2210: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2211:
2212: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2213: return '';
2214: }
2215:
2216: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2217: &escape('Checkin - '.$token)) ne 'ok') {
2218: return '';
2219: }
2220:
2221: return ($symb,$tuname,$tudom,$tcrsid);
2222: }
2223:
2224: # --------------------------------------------- Set Expire Date for Spreadsheet
2225:
2226: sub expirespread {
2227: my ($uname,$udom,$stype,$usymb)=@_;
2228: my $cid=$env{'request.course.id'};
2229: if ($cid) {
2230: my $now=time;
2231: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2232: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2233: $env{'course.'.$cid.'.num'}.
2234: ':nohist_expirationdates:'.
2235: &escape($key).'='.$now,
2236: $env{'course.'.$cid.'.home'})
2237: }
2238: return 'ok';
2239: }
2240:
2241: # ----------------------------------------------------- Devalidate Spreadsheets
2242:
2243: sub devalidate {
2244: my ($symb,$uname,$udom)=@_;
2245: my $cid=$env{'request.course.id'};
2246: if ($cid) {
2247: # delete the stored spreadsheets for
2248: # - the student level sheet of this user in course's homespace
2249: # - the assessment level sheet for this resource
2250: # for this user in user's homespace
2251: # - current conditional state info
2252: my $key=$uname.':'.$udom.':';
2253: my $status=
2254: &del('nohist_calculatedsheets',
2255: [$key.'studentcalc:'],
2256: $env{'course.'.$cid.'.domain'},
2257: $env{'course.'.$cid.'.num'})
2258: .' '.
2259: &del('nohist_calculatedsheets_'.$cid,
2260: [$key.'assesscalc:'.$symb],$udom,$uname);
2261: unless ($status eq 'ok ok') {
2262: &logthis('Could not devalidate spreadsheet '.
2263: $uname.' at '.$udom.' for '.
2264: $symb.': '.$status);
2265: }
2266: &delenv('user.state.'.$cid);
2267: }
2268: }
2269:
2270: sub get_scalar {
2271: my ($string,$end) = @_;
2272: my $value;
2273: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2274: $value = $1;
2275: } elsif ($$string =~ s/^([^&]*?)&//) {
2276: $value = $1;
2277: }
2278: return &unescape($value);
2279: }
2280:
2281: sub array2str {
2282: my (@array) = @_;
2283: my $result=&arrayref2str(\@array);
2284: $result=~s/^__ARRAY_REF__//;
2285: $result=~s/__END_ARRAY_REF__$//;
2286: return $result;
2287: }
2288:
2289: sub arrayref2str {
2290: my ($arrayref) = @_;
2291: my $result='__ARRAY_REF__';
2292: foreach my $elem (@$arrayref) {
2293: if(ref($elem) eq 'ARRAY') {
2294: $result.=&arrayref2str($elem).'&';
2295: } elsif(ref($elem) eq 'HASH') {
2296: $result.=&hashref2str($elem).'&';
2297: } elsif(ref($elem)) {
2298: #print("Got a ref of ".(ref($elem))." skipping.");
2299: } else {
2300: $result.=&escape($elem).'&';
2301: }
2302: }
2303: $result=~s/\&$//;
2304: $result .= '__END_ARRAY_REF__';
2305: return $result;
2306: }
2307:
2308: sub hash2str {
2309: my (%hash) = @_;
2310: my $result=&hashref2str(\%hash);
2311: $result=~s/^__HASH_REF__//;
2312: $result=~s/__END_HASH_REF__$//;
2313: return $result;
2314: }
2315:
2316: sub hashref2str {
2317: my ($hashref)=@_;
2318: my $result='__HASH_REF__';
2319: foreach my $key (sort(keys(%$hashref))) {
2320: if (ref($key) eq 'ARRAY') {
2321: $result.=&arrayref2str($key).'=';
2322: } elsif (ref($key) eq 'HASH') {
2323: $result.=&hashref2str($key).'=';
2324: } elsif (ref($key)) {
2325: $result.='=';
2326: #print("Got a ref of ".(ref($key))." skipping.");
2327: } else {
2328: if ($key) {$result.=&escape($key).'=';} else { last; }
2329: }
2330:
2331: if(ref($hashref->{$key}) eq 'ARRAY') {
2332: $result.=&arrayref2str($hashref->{$key}).'&';
2333: } elsif(ref($hashref->{$key}) eq 'HASH') {
2334: $result.=&hashref2str($hashref->{$key}).'&';
2335: } elsif(ref($hashref->{$key})) {
2336: $result.='&';
2337: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
2338: } else {
2339: $result.=&escape($hashref->{$key}).'&';
2340: }
2341: }
2342: $result=~s/\&$//;
2343: $result .= '__END_HASH_REF__';
2344: return $result;
2345: }
2346:
2347: sub str2hash {
2348: my ($string)=@_;
2349: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2350: return %$hash;
2351: }
2352:
2353: sub str2hashref {
2354: my ($string) = @_;
2355:
2356: my %hash;
2357:
2358: if($string !~ /^__HASH_REF__/) {
2359: if (! ($string eq '' || !defined($string))) {
2360: $hash{'error'}='Not hash reference';
2361: }
2362: return (\%hash, $string);
2363: }
2364:
2365: $string =~ s/^__HASH_REF__//;
2366:
2367: while($string !~ /^__END_HASH_REF__/) {
2368: #key
2369: my $key='';
2370: if($string =~ /^__HASH_REF__/) {
2371: ($key, $string)=&str2hashref($string);
2372: if(defined($key->{'error'})) {
2373: $hash{'error'}='Bad data';
2374: return (\%hash, $string);
2375: }
2376: } elsif($string =~ /^__ARRAY_REF__/) {
2377: ($key, $string)=&str2arrayref($string);
2378: if($key->[0] eq 'Array reference error') {
2379: $hash{'error'}='Bad data';
2380: return (\%hash, $string);
2381: }
2382: } else {
2383: $string =~ s/^(.*?)=//;
2384: $key=&unescape($1);
2385: }
2386: $string =~ s/^=//;
2387:
2388: #value
2389: my $value='';
2390: if($string =~ /^__HASH_REF__/) {
2391: ($value, $string)=&str2hashref($string);
2392: if(defined($value->{'error'})) {
2393: $hash{'error'}='Bad data';
2394: return (\%hash, $string);
2395: }
2396: } elsif($string =~ /^__ARRAY_REF__/) {
2397: ($value, $string)=&str2arrayref($string);
2398: if($value->[0] eq 'Array reference error') {
2399: $hash{'error'}='Bad data';
2400: return (\%hash, $string);
2401: }
2402: } else {
2403: $value=&get_scalar(\$string,'__END_HASH_REF__');
2404: }
2405: $string =~ s/^&//;
2406:
2407: $hash{$key}=$value;
2408: }
2409:
2410: $string =~ s/^__END_HASH_REF__//;
2411:
2412: return (\%hash, $string);
2413: }
2414:
2415: sub str2array {
2416: my ($string)=@_;
2417: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2418: return @$array;
2419: }
2420:
2421: sub str2arrayref {
2422: my ($string) = @_;
2423: my @array;
2424:
2425: if($string !~ /^__ARRAY_REF__/) {
2426: if (! ($string eq '' || !defined($string))) {
2427: $array[0]='Array reference error';
2428: }
2429: return (\@array, $string);
2430: }
2431:
2432: $string =~ s/^__ARRAY_REF__//;
2433:
2434: while($string !~ /^__END_ARRAY_REF__/) {
2435: my $value='';
2436: if($string =~ /^__HASH_REF__/) {
2437: ($value, $string)=&str2hashref($string);
2438: if(defined($value->{'error'})) {
2439: $array[0] ='Array reference error';
2440: return (\@array, $string);
2441: }
2442: } elsif($string =~ /^__ARRAY_REF__/) {
2443: ($value, $string)=&str2arrayref($string);
2444: if($value->[0] eq 'Array reference error') {
2445: $array[0] ='Array reference error';
2446: return (\@array, $string);
2447: }
2448: } else {
2449: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2450: }
2451: $string =~ s/^&//;
2452:
2453: push(@array, $value);
2454: }
2455:
2456: $string =~ s/^__END_ARRAY_REF__//;
2457:
2458: return (\@array, $string);
2459: }
2460:
2461: # -------------------------------------------------------------------Temp Store
2462:
2463: sub tmpreset {
2464: my ($symb,$namespace,$domain,$stuname) = @_;
2465: if (!$symb) {
2466: $symb=&symbread();
2467: if (!$symb) { $symb= $env{'request.url'}; }
2468: }
2469: $symb=escape($symb);
2470:
2471: if (!$namespace) { $namespace=$env{'request.state'}; }
2472: $namespace=~s/\//\_/g;
2473: $namespace=~s/\W//g;
2474:
2475: if (!$domain) { $domain=$env{'user.domain'}; }
2476: if (!$stuname) { $stuname=$env{'user.name'}; }
2477: if ($domain eq 'public' && $stuname eq 'public') {
2478: $stuname=$ENV{'REMOTE_ADDR'};
2479: }
2480: my $path=$perlvar{'lonDaemons'}.'/tmp';
2481: my %hash;
2482: if (tie(%hash,'GDBM_File',
2483: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2484: &GDBM_WRCREAT(),0640)) {
2485: foreach my $key (keys %hash) {
2486: if ($key=~ /:$symb/) {
2487: delete($hash{$key});
2488: }
2489: }
2490: }
2491: }
2492:
2493: sub tmpstore {
2494: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2495:
2496: if (!$symb) {
2497: $symb=&symbread();
2498: if (!$symb) { $symb= $env{'request.url'}; }
2499: }
2500: $symb=escape($symb);
2501:
2502: if (!$namespace) {
2503: # I don't think we would ever want to store this for a course.
2504: # it seems this will only be used if we don't have a course.
2505: #$namespace=$env{'request.course.id'};
2506: #if (!$namespace) {
2507: $namespace=$env{'request.state'};
2508: #}
2509: }
2510: $namespace=~s/\//\_/g;
2511: $namespace=~s/\W//g;
2512: if (!$domain) { $domain=$env{'user.domain'}; }
2513: if (!$stuname) { $stuname=$env{'user.name'}; }
2514: if ($domain eq 'public' && $stuname eq 'public') {
2515: $stuname=$ENV{'REMOTE_ADDR'};
2516: }
2517: my $now=time;
2518: my %hash;
2519: my $path=$perlvar{'lonDaemons'}.'/tmp';
2520: if (tie(%hash,'GDBM_File',
2521: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2522: &GDBM_WRCREAT(),0640)) {
2523: $hash{"version:$symb"}++;
2524: my $version=$hash{"version:$symb"};
2525: my $allkeys='';
2526: foreach my $key (keys(%$storehash)) {
2527: $allkeys.=$key.':';
2528: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2529: }
2530: $hash{"$version:$symb:timestamp"}=$now;
2531: $allkeys.='timestamp';
2532: $hash{"$version:keys:$symb"}=$allkeys;
2533: if (untie(%hash)) {
2534: return 'ok';
2535: } else {
2536: return "error:$!";
2537: }
2538: } else {
2539: return "error:$!";
2540: }
2541: }
2542:
2543: # -----------------------------------------------------------------Temp Restore
2544:
2545: sub tmprestore {
2546: my ($symb,$namespace,$domain,$stuname) = @_;
2547:
2548: if (!$symb) {
2549: $symb=&symbread();
2550: if (!$symb) { $symb= $env{'request.url'}; }
2551: }
2552: $symb=escape($symb);
2553:
2554: if (!$namespace) { $namespace=$env{'request.state'}; }
2555:
2556: if (!$domain) { $domain=$env{'user.domain'}; }
2557: if (!$stuname) { $stuname=$env{'user.name'}; }
2558: if ($domain eq 'public' && $stuname eq 'public') {
2559: $stuname=$ENV{'REMOTE_ADDR'};
2560: }
2561: my %returnhash;
2562: $namespace=~s/\//\_/g;
2563: $namespace=~s/\W//g;
2564: my %hash;
2565: my $path=$perlvar{'lonDaemons'}.'/tmp';
2566: if (tie(%hash,'GDBM_File',
2567: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2568: &GDBM_READER(),0640)) {
2569: my $version=$hash{"version:$symb"};
2570: $returnhash{'version'}=$version;
2571: my $scope;
2572: for ($scope=1;$scope<=$version;$scope++) {
2573: my $vkeys=$hash{"$scope:keys:$symb"};
2574: my @keys=split(/:/,$vkeys);
2575: my $key;
2576: $returnhash{"$scope:keys"}=$vkeys;
2577: foreach $key (@keys) {
2578: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2579: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2580: }
2581: }
2582: if (!(untie(%hash))) {
2583: return "error:$!";
2584: }
2585: } else {
2586: return "error:$!";
2587: }
2588: return %returnhash;
2589: }
2590:
2591: # ----------------------------------------------------------------------- Store
2592:
2593: sub store {
2594: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2595: my $home='';
2596:
2597: if ($stuname) { $home=&homeserver($stuname,$domain); }
2598:
2599: $symb=&symbclean($symb);
2600: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2601:
2602: if (!$domain) { $domain=$env{'user.domain'}; }
2603: if (!$stuname) { $stuname=$env{'user.name'}; }
2604:
2605: &devalidate($symb,$stuname,$domain);
2606:
2607: $symb=escape($symb);
2608: if (!$namespace) {
2609: unless ($namespace=$env{'request.course.id'}) {
2610: return '';
2611: }
2612: }
2613: if (!$home) { $home=$env{'user.home'}; }
2614:
2615: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2616: $$storehash{'host'}=$perlvar{'lonHostID'};
2617:
2618: my $namevalue='';
2619: foreach my $key (keys(%$storehash)) {
2620: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2621: }
2622: $namevalue=~s/\&$//;
2623: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2624: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2625: }
2626:
2627: # -------------------------------------------------------------- Critical Store
2628:
2629: sub cstore {
2630: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2631: my $home='';
2632:
2633: if ($stuname) { $home=&homeserver($stuname,$domain); }
2634:
2635: $symb=&symbclean($symb);
2636: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2637:
2638: if (!$domain) { $domain=$env{'user.domain'}; }
2639: if (!$stuname) { $stuname=$env{'user.name'}; }
2640:
2641: &devalidate($symb,$stuname,$domain);
2642:
2643: $symb=escape($symb);
2644: if (!$namespace) {
2645: unless ($namespace=$env{'request.course.id'}) {
2646: return '';
2647: }
2648: }
2649: if (!$home) { $home=$env{'user.home'}; }
2650:
2651: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2652: $$storehash{'host'}=$perlvar{'lonHostID'};
2653:
2654: my $namevalue='';
2655: foreach my $key (keys(%$storehash)) {
2656: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2657: }
2658: $namevalue=~s/\&$//;
2659: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2660: return critical
2661: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2662: }
2663:
2664: # --------------------------------------------------------------------- Restore
2665:
2666: sub restore {
2667: my ($symb,$namespace,$domain,$stuname) = @_;
2668: my $home='';
2669:
2670: if ($stuname) { $home=&homeserver($stuname,$domain); }
2671:
2672: if (!$symb) {
2673: unless ($symb=escape(&symbread())) { return ''; }
2674: } else {
2675: $symb=&escape(&symbclean($symb));
2676: }
2677: if (!$namespace) {
2678: unless ($namespace=$env{'request.course.id'}) {
2679: return '';
2680: }
2681: }
2682: if (!$domain) { $domain=$env{'user.domain'}; }
2683: if (!$stuname) { $stuname=$env{'user.name'}; }
2684: if (!$home) { $home=$env{'user.home'}; }
2685: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2686:
2687: my %returnhash=();
2688: foreach my $line (split(/\&/,$answer)) {
2689: my ($name,$value)=split(/\=/,$line);
2690: $returnhash{&unescape($name)}=&thaw_unescape($value);
2691: }
2692: my $version;
2693: for ($version=1;$version<=$returnhash{'version'};$version++) {
2694: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
2695: $returnhash{$item}=$returnhash{$version.':'.$item};
2696: }
2697: }
2698: return %returnhash;
2699: }
2700:
2701: # ---------------------------------------------------------- Course Description
2702:
2703: sub coursedescription {
2704: my ($courseid,$args)=@_;
2705: $courseid=~s/^\///;
2706: $courseid=~s/\_/\//g;
2707: my ($cdomain,$cnum)=split(/\//,$courseid);
2708: my $chome=&homeserver($cnum,$cdomain);
2709: my $normalid=$cdomain.'_'.$cnum;
2710: # need to always cache even if we get errors otherwise we keep
2711: # trying and trying and trying to get the course description.
2712: my %envhash=();
2713: my %returnhash=();
2714:
2715: my $expiretime=600;
2716: if ($env{'request.course.id'} eq $normalid) {
2717: $expiretime=120;
2718: }
2719:
2720: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2721: if (!$args->{'freshen_cache'}
2722: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2723: foreach my $key (keys(%env)) {
2724: next if ($key !~ /^\Q$prefix\E(.*)/);
2725: my ($setting) = $1;
2726: $returnhash{$setting} = $env{$key};
2727: }
2728: return %returnhash;
2729: }
2730:
2731: # get the data agin
2732: if (!$args->{'one_time'}) {
2733: $envhash{'course.'.$normalid.'.last_cache'}=time;
2734: }
2735: if ($chome ne 'no_host') {
2736: %returnhash=&dump('environment',$cdomain,$cnum);
2737: if (!exists($returnhash{'con_lost'})) {
2738: $returnhash{'home'}= $chome;
2739: $returnhash{'domain'} = $cdomain;
2740: $returnhash{'num'} = $cnum;
2741: if (!defined($returnhash{'type'})) {
2742: $returnhash{'type'} = 'Course';
2743: }
2744: while (my ($name,$value) = each %returnhash) {
2745: $envhash{'course.'.$normalid.'.'.$name}=$value;
2746: }
2747: $returnhash{'url'}=&clutter($returnhash{'url'});
2748: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2749: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2750: $envhash{'course.'.$normalid.'.home'}=$chome;
2751: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2752: $envhash{'course.'.$normalid.'.num'}=$cnum;
2753: }
2754: }
2755: if (!$args->{'one_time'}) {
2756: &appenv(%envhash);
2757: }
2758: return %returnhash;
2759: }
2760:
2761: # -------------------------------------------------See if a user is privileged
2762:
2763: sub privileged {
2764: my ($username,$domain)=@_;
2765: my $rolesdump=&reply("dump:$domain:$username:roles",
2766: &homeserver($username,$domain));
2767: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2768: my $now=time;
2769: if ($rolesdump ne '') {
2770: foreach my $entry (split(/&/,$rolesdump)) {
2771: if ($entry!~/^rolesdef_/) {
2772: my ($area,$role)=split(/=/,$entry);
2773: $area=~s/\_\w\w$//;
2774: my ($trole,$tend,$tstart)=split(/_/,$role);
2775: if (($trole eq 'dc') || ($trole eq 'su')) {
2776: my $active=1;
2777: if ($tend) {
2778: if ($tend<$now) { $active=0; }
2779: }
2780: if ($tstart) {
2781: if ($tstart>$now) { $active=0; }
2782: }
2783: if ($active) { return 1; }
2784: }
2785: }
2786: }
2787: }
2788: return 0;
2789: }
2790:
2791: # -------------------------------------------------------- Get user privileges
2792:
2793: sub rolesinit {
2794: my ($domain,$username,$authhost)=@_;
2795: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2796: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2797: my %allroles=();
2798: my %allgroups=();
2799: my $now=time;
2800: my %userroles = ('user.login.time' => $now);
2801: my $group_privs;
2802:
2803: if ($rolesdump ne '') {
2804: foreach my $entry (split(/&/,$rolesdump)) {
2805: if ($entry!~/^rolesdef_/) {
2806: my ($area,$role)=split(/=/,$entry);
2807: $area=~s/\_\w\w$//;
2808: my ($trole,$tend,$tstart,$group_privs);
2809: if ($role=~/^cr/) {
2810: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
2811: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
2812: ($tend,$tstart)=split('_',$trest);
2813: } else {
2814: $trole=$role;
2815: }
2816: } elsif ($role =~ m|^gr/|) {
2817: ($trole,$tend,$tstart) = split(/_/,$role);
2818: ($trole,$group_privs) = split(/\//,$trole);
2819: $group_privs = &unescape($group_privs);
2820: } else {
2821: ($trole,$tend,$tstart)=split(/_/,$role);
2822: }
2823: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2824: $username);
2825: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2826: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2827: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2828: if (($area ne '') && ($trole ne '')) {
2829: my $spec=$trole.'.'.$area;
2830: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2831: if ($trole =~ /^cr\//) {
2832: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2833: } elsif ($trole eq 'gr') {
2834: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2835: } else {
2836: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2837: }
2838: }
2839: }
2840: }
2841: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2842: $userroles{'user.adv'} = $adv;
2843: $userroles{'user.author'} = $author;
2844: $env{'user.adv'}=$adv;
2845: }
2846: return \%userroles;
2847: }
2848:
2849: sub set_arearole {
2850: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2851: # log the associated role with the area
2852: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2853: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2854: }
2855:
2856: sub custom_roleprivs {
2857: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2858: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2859: my $homsvr=homeserver($rauthor,$rdomain);
2860: if ($hostname{$homsvr} ne '') {
2861: my ($rdummy,$roledef)=
2862: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2863: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2864: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2865: if (defined($syspriv)) {
2866: $$allroles{'cm./'}.=':'.$syspriv;
2867: $$allroles{$spec.'./'}.=':'.$syspriv;
2868: }
2869: if ($tdomain ne '') {
2870: if (defined($dompriv)) {
2871: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2872: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2873: }
2874: if (($trest ne '') && (defined($coursepriv))) {
2875: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2876: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2877: }
2878: }
2879: }
2880: }
2881: }
2882:
2883: sub group_roleprivs {
2884: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2885: my $access = 1;
2886: my $now = time;
2887: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2888: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2889: if ($access) {
2890: my ($course,$group) = ($area =~ m|(/$match_domain/$match_username)/([^/]+)$|);
2891: $$allgroups{$course}{$group} .=':'.$group_privs;
2892: }
2893: }
2894:
2895: sub standard_roleprivs {
2896: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2897: if (defined($pr{$trole.':s'})) {
2898: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2899: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2900: }
2901: if ($tdomain ne '') {
2902: if (defined($pr{$trole.':d'})) {
2903: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2904: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2905: }
2906: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2907: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2908: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2909: }
2910: }
2911: }
2912:
2913: sub set_userprivs {
2914: my ($userroles,$allroles,$allgroups) = @_;
2915: my $author=0;
2916: my $adv=0;
2917: my %grouproles = ();
2918: if (keys(%{$allgroups}) > 0) {
2919: foreach my $role (keys %{$allroles}) {
2920: my ($trole,$area,$sec,$extendedarea);
2921: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_username)(/?\w*)-) {
2922: $trole = $1;
2923: $area = $2;
2924: $sec = $3;
2925: $extendedarea = $area.$sec;
2926: if (exists($$allgroups{$area})) {
2927: foreach my $group (keys(%{$$allgroups{$area}})) {
2928: my $spec = $trole.'.'.$extendedarea;
2929: $grouproles{$spec.'.'.$area.'/'.$group} =
2930: $$allgroups{$area}{$group};
2931: }
2932: }
2933: }
2934: }
2935: }
2936: foreach my $group (keys(%grouproles)) {
2937: $$allroles{$group} = $grouproles{$group};
2938: }
2939: foreach my $role (keys(%{$allroles})) {
2940: my %thesepriv;
2941: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
2942: foreach my $item (split(/:/,$$allroles{$role})) {
2943: if ($item ne '') {
2944: my ($privilege,$restrictions)=split(/&/,$item);
2945: if ($restrictions eq '') {
2946: $thesepriv{$privilege}='F';
2947: } elsif ($thesepriv{$privilege} ne 'F') {
2948: $thesepriv{$privilege}.=$restrictions;
2949: }
2950: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2951: }
2952: }
2953: my $thesestr='';
2954: foreach my $priv (keys(%thesepriv)) {
2955: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
2956: }
2957: $userroles->{'user.priv.'.$role} = $thesestr;
2958: }
2959: return ($author,$adv);
2960: }
2961:
2962: # --------------------------------------------------------------- get interface
2963:
2964: sub get {
2965: my ($namespace,$storearr,$udomain,$uname)=@_;
2966: my $items='';
2967: foreach my $item (@$storearr) {
2968: $items.=&escape($item).'&';
2969: }
2970: $items=~s/\&$//;
2971: if (!$udomain) { $udomain=$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: my $uhome=&homeserver($uname,$udomain);
2974:
2975: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2976: my @pairs=split(/\&/,$rep);
2977: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2978: return @pairs;
2979: }
2980: my %returnhash=();
2981: my $i=0;
2982: foreach my $item (@$storearr) {
2983: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2984: $i++;
2985: }
2986: return %returnhash;
2987: }
2988:
2989: # --------------------------------------------------------------- del interface
2990:
2991: sub del {
2992: my ($namespace,$storearr,$udomain,$uname)=@_;
2993: my $items='';
2994: foreach my $item (@$storearr) {
2995: $items.=&escape($item).'&';
2996: }
2997: $items=~s/\&$//;
2998: if (!$udomain) { $udomain=$env{'user.domain'}; }
2999: if (!$uname) { $uname=$env{'user.name'}; }
3000: my $uhome=&homeserver($uname,$udomain);
3001:
3002: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3003: }
3004:
3005: # -------------------------------------------------------------- dump interface
3006:
3007: sub dump {
3008: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3009: if (!$udomain) { $udomain=$env{'user.domain'}; }
3010: if (!$uname) { $uname=$env{'user.name'}; }
3011: my $uhome=&homeserver($uname,$udomain);
3012: if ($regexp) {
3013: $regexp=&escape($regexp);
3014: } else {
3015: $regexp='.';
3016: }
3017: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3018: my @pairs=split(/\&/,$rep);
3019: my %returnhash=();
3020: foreach my $item (@pairs) {
3021: my ($key,$value)=split(/=/,$item,2);
3022: $key = &unescape($key);
3023: next if ($key =~ /^error: 2 /);
3024: $returnhash{$key}=&thaw_unescape($value);
3025: }
3026: return %returnhash;
3027: }
3028:
3029: # --------------------------------------------------------- dumpstore interface
3030:
3031: sub dumpstore {
3032: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3033: return &dump($namespace,$udomain,$uname,$regexp,$range);
3034: }
3035:
3036: # -------------------------------------------------------------- keys interface
3037:
3038: sub getkeys {
3039: my ($namespace,$udomain,$uname)=@_;
3040: if (!$udomain) { $udomain=$env{'user.domain'}; }
3041: if (!$uname) { $uname=$env{'user.name'}; }
3042: my $uhome=&homeserver($uname,$udomain);
3043: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3044: my @keyarray=();
3045: foreach my $key (split(/\&/,$rep)) {
3046: push(@keyarray,&unescape($key));
3047: }
3048: return @keyarray;
3049: }
3050:
3051: # --------------------------------------------------------------- currentdump
3052: sub currentdump {
3053: my ($courseid,$sdom,$sname)=@_;
3054: $courseid = $env{'request.course.id'} if (! defined($courseid));
3055: $sdom = $env{'user.domain'} if (! defined($sdom));
3056: $sname = $env{'user.name'} if (! defined($sname));
3057: my $uhome = &homeserver($sname,$sdom);
3058: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3059: return if ($rep =~ /^(error:|no_such_host)/);
3060: #
3061: my %returnhash=();
3062: #
3063: if ($rep eq "unknown_cmd") {
3064: # an old lond will not know currentdump
3065: # Do a dump and make it look like a currentdump
3066: my @tmp = &dump($courseid,$sdom,$sname,'.');
3067: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3068: my %hash = @tmp;
3069: @tmp=();
3070: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3071: } else {
3072: my @pairs=split(/\&/,$rep);
3073: foreach my $pair (@pairs) {
3074: my ($key,$value)=split(/=/,$pair,2);
3075: my ($symb,$param) = split(/:/,$key);
3076: $returnhash{&unescape($symb)}->{&unescape($param)} =
3077: &thaw_unescape($value);
3078: }
3079: }
3080: return %returnhash;
3081: }
3082:
3083: sub convert_dump_to_currentdump{
3084: my %hash = %{shift()};
3085: my %returnhash;
3086: # Code ripped from lond, essentially. The only difference
3087: # here is the unescaping done by lonnet::dump(). Conceivably
3088: # we might run in to problems with parameter names =~ /^v\./
3089: while (my ($key,$value) = each(%hash)) {
3090: my ($v,$symb,$param) = split(/:/,$key);
3091: next if ($v eq 'version' || $symb eq 'keys');
3092: next if (exists($returnhash{$symb}) &&
3093: exists($returnhash{$symb}->{$param}) &&
3094: $returnhash{$symb}->{'v.'.$param} > $v);
3095: $returnhash{$symb}->{$param}=$value;
3096: $returnhash{$symb}->{'v.'.$param}=$v;
3097: }
3098: #
3099: # Remove all of the keys in the hashes which keep track of
3100: # the version of the parameter.
3101: while (my ($symb,$param_hash) = each(%returnhash)) {
3102: # use a foreach because we are going to delete from the hash.
3103: foreach my $key (keys(%$param_hash)) {
3104: delete($param_hash->{$key}) if ($key =~ /^v\./);
3105: }
3106: }
3107: return \%returnhash;
3108: }
3109:
3110: # ------------------------------------------------------ critical inc interface
3111:
3112: sub cinc {
3113: return &inc(@_,'critical');
3114: }
3115:
3116: # --------------------------------------------------------------- inc interface
3117:
3118: sub inc {
3119: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3120: if (!$udomain) { $udomain=$env{'user.domain'}; }
3121: if (!$uname) { $uname=$env{'user.name'}; }
3122: my $uhome=&homeserver($uname,$udomain);
3123: my $items='';
3124: if (! ref($store)) {
3125: # got a single value, so use that instead
3126: $items = &escape($store).'=&';
3127: } elsif (ref($store) eq 'SCALAR') {
3128: $items = &escape($$store).'=&';
3129: } elsif (ref($store) eq 'ARRAY') {
3130: $items = join('=&',map {&escape($_);} @{$store});
3131: } elsif (ref($store) eq 'HASH') {
3132: while (my($key,$value) = each(%{$store})) {
3133: $items.= &escape($key).'='.&escape($value).'&';
3134: }
3135: }
3136: $items=~s/\&$//;
3137: if ($critical) {
3138: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3139: } else {
3140: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3141: }
3142: }
3143:
3144: # --------------------------------------------------------------- put interface
3145:
3146: sub put {
3147: my ($namespace,$storehash,$udomain,$uname)=@_;
3148: if (!$udomain) { $udomain=$env{'user.domain'}; }
3149: if (!$uname) { $uname=$env{'user.name'}; }
3150: my $uhome=&homeserver($uname,$udomain);
3151: my $items='';
3152: foreach my $item (keys(%$storehash)) {
3153: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3154: }
3155: $items=~s/\&$//;
3156: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3157: }
3158:
3159: # ------------------------------------------------------------ newput interface
3160:
3161: sub newput {
3162: my ($namespace,$storehash,$udomain,$uname)=@_;
3163: if (!$udomain) { $udomain=$env{'user.domain'}; }
3164: if (!$uname) { $uname=$env{'user.name'}; }
3165: my $uhome=&homeserver($uname,$udomain);
3166: my $items='';
3167: foreach my $key (keys(%$storehash)) {
3168: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3169: }
3170: $items=~s/\&$//;
3171: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3172: }
3173:
3174: # --------------------------------------------------------- putstore interface
3175:
3176: sub putstore {
3177: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3178: if (!$udomain) { $udomain=$env{'user.domain'}; }
3179: if (!$uname) { $uname=$env{'user.name'}; }
3180: my $uhome=&homeserver($uname,$udomain);
3181: my $items='';
3182: foreach my $key (keys(%$storehash)) {
3183: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3184: }
3185: $items=~s/\&$//;
3186: my $esc_symb=&escape($symb);
3187: my $esc_v=&escape($version);
3188: my $reply =
3189: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3190: $uhome);
3191: if ($reply eq 'unknown_cmd') {
3192: # gfall back to way things use to be done
3193: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3194: $uname);
3195: }
3196: return $reply;
3197: }
3198:
3199: sub old_putstore {
3200: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3201: if (!$udomain) { $udomain=$env{'user.domain'}; }
3202: if (!$uname) { $uname=$env{'user.name'}; }
3203: my $uhome=&homeserver($uname,$udomain);
3204: my %newstorehash;
3205: foreach my $item (keys(%$storehash)) {
3206: my $key = $version.':'.&escape($symb).':'.$item;
3207: $newstorehash{$key} = $storehash->{$item};
3208: }
3209: my $items='';
3210: my %allitems = ();
3211: foreach my $item (keys(%newstorehash)) {
3212: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3213: my $key = $1.':keys:'.$2;
3214: $allitems{$key} .= $3.':';
3215: }
3216: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3217: }
3218: foreach my $item (keys(%allitems)) {
3219: $allitems{$item} =~ s/\:$//;
3220: $items.= $item.'='.$allitems{$item}.'&';
3221: }
3222: $items=~s/\&$//;
3223: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3224: }
3225:
3226: # ------------------------------------------------------ critical put interface
3227:
3228: sub cput {
3229: my ($namespace,$storehash,$udomain,$uname)=@_;
3230: if (!$udomain) { $udomain=$env{'user.domain'}; }
3231: if (!$uname) { $uname=$env{'user.name'}; }
3232: my $uhome=&homeserver($uname,$udomain);
3233: my $items='';
3234: foreach my $item (keys(%$storehash)) {
3235: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3236: }
3237: $items=~s/\&$//;
3238: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3239: }
3240:
3241: # -------------------------------------------------------------- eget interface
3242:
3243: sub eget {
3244: my ($namespace,$storearr,$udomain,$uname)=@_;
3245: my $items='';
3246: foreach my $item (@$storearr) {
3247: $items.=&escape($item).'&';
3248: }
3249: $items=~s/\&$//;
3250: if (!$udomain) { $udomain=$env{'user.domain'}; }
3251: if (!$uname) { $uname=$env{'user.name'}; }
3252: my $uhome=&homeserver($uname,$udomain);
3253: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3254: my @pairs=split(/\&/,$rep);
3255: my %returnhash=();
3256: my $i=0;
3257: foreach my $item (@$storearr) {
3258: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3259: $i++;
3260: }
3261: return %returnhash;
3262: }
3263:
3264: # ------------------------------------------------------------ tmpput interface
3265: sub tmpput {
3266: my ($storehash,$server,$context)=@_;
3267: my $items='';
3268: foreach my $item (keys(%$storehash)) {
3269: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3270: }
3271: $items=~s/\&$//;
3272: if (defined($context)) {
3273: $items .= ':'.&escape($context);
3274: }
3275: return &reply("tmpput:$items",$server);
3276: }
3277:
3278: # ------------------------------------------------------------ tmpget interface
3279: sub tmpget {
3280: my ($token,$server)=@_;
3281: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3282: my $rep=&reply("tmpget:$token",$server);
3283: my %returnhash;
3284: foreach my $item (split(/\&/,$rep)) {
3285: my ($key,$value)=split(/=/,$item);
3286: $returnhash{&unescape($key)}=&thaw_unescape($value);
3287: }
3288: return %returnhash;
3289: }
3290:
3291: # ------------------------------------------------------------ tmpget interface
3292: sub tmpdel {
3293: my ($token,$server)=@_;
3294: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3295: return &reply("tmpdel:$token",$server);
3296: }
3297:
3298: # -------------------------------------------------- portfolio access checking
3299:
3300: sub portfolio_access {
3301: my ($requrl) = @_;
3302: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3303: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3304: if ($result eq 'ok') {
3305: return 'F';
3306: } elsif ($result =~ /^[^:]+:guest_/) {
3307: return 'A';
3308: }
3309: return '';
3310: }
3311:
3312: sub get_portfolio_access {
3313: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3314:
3315: if (!ref($access_hash)) {
3316: my $current_perms = &get_portfile_permissions($udom,$unum);
3317: my %access_controls = &get_access_controls($current_perms,$group,
3318: $file_name);
3319: $access_hash = $access_controls{$file_name};
3320: }
3321:
3322: my ($public,$guest,@domains,@users,@courses,@groups);
3323: my $now = time;
3324: if (ref($access_hash) eq 'HASH') {
3325: foreach my $key (keys(%{$access_hash})) {
3326: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3327: if ($start > $now) {
3328: next;
3329: }
3330: if ($end && $end<$now) {
3331: next;
3332: }
3333: if ($scope eq 'public') {
3334: $public = $key;
3335: last;
3336: } elsif ($scope eq 'guest') {
3337: $guest = $key;
3338: } elsif ($scope eq 'domains') {
3339: push(@domains,$key);
3340: } elsif ($scope eq 'users') {
3341: push(@users,$key);
3342: } elsif ($scope eq 'course') {
3343: push(@courses,$key);
3344: } elsif ($scope eq 'group') {
3345: push(@groups,$key);
3346: }
3347: }
3348: if ($public) {
3349: return 'ok';
3350: }
3351: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3352: if ($guest) {
3353: return $guest;
3354: }
3355: } else {
3356: if (@domains > 0) {
3357: foreach my $domkey (@domains) {
3358: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3359: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3360: return 'ok';
3361: }
3362: }
3363: }
3364: }
3365: if (@users > 0) {
3366: foreach my $userkey (@users) {
3367: if (exists($access_hash->{$userkey}{'users'}{$env{'user.name'}.':'.$env{'user.domain'}})) {
3368: return 'ok';
3369: }
3370: }
3371: }
3372: my %roleshash;
3373: my @courses_and_groups = @courses;
3374: push(@courses_and_groups,@groups);
3375: if (@courses_and_groups > 0) {
3376: my (%allgroups,%allroles);
3377: my ($start,$end,$role,$sec,$group);
3378: foreach my $envkey (%env) {
3379: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_username)/?([^/]*)$-) {
3380: my $cid = $2.'_'.$3;
3381: if ($1 eq 'gr') {
3382: $group = $4;
3383: $allgroups{$cid}{$group} = $env{$envkey};
3384: } else {
3385: if ($4 eq '') {
3386: $sec = 'none';
3387: } else {
3388: $sec = $4;
3389: }
3390: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3391: }
3392: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_username)/?([^/]*)$-) {
3393: my $cid = $2.'_'.$3;
3394: if ($4 eq '') {
3395: $sec = 'none';
3396: } else {
3397: $sec = $4;
3398: }
3399: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3400: }
3401: }
3402: if (keys(%allroles) == 0) {
3403: return;
3404: }
3405: foreach my $key (@courses_and_groups) {
3406: my %content = %{$$access_hash{$key}};
3407: my $cnum = $content{'number'};
3408: my $cdom = $content{'domain'};
3409: my $cid = $cdom.'_'.$cnum;
3410: if (!exists($allroles{$cid})) {
3411: next;
3412: }
3413: foreach my $role_id (keys(%{$content{'roles'}})) {
3414: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3415: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3416: my @status = @{$content{'roles'}{$role_id}{'access'}};
3417: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3418: foreach my $role (keys(%{$allroles{$cid}})) {
3419: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3420: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3421: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3422: if (grep/^all$/,@sections) {
3423: return 'ok';
3424: } else {
3425: if (grep/^$sec$/,@sections) {
3426: return 'ok';
3427: }
3428: }
3429: }
3430: }
3431: if (keys(%{$allgroups{$cid}}) == 0) {
3432: if (grep/^none$/,@groups) {
3433: return 'ok';
3434: }
3435: } else {
3436: if (grep/^all$/,@groups) {
3437: return 'ok';
3438: }
3439: foreach my $group (keys(%{$allgroups{$cid}})) {
3440: if (grep/^$group$/,@groups) {
3441: return 'ok';
3442: }
3443: }
3444: }
3445: }
3446: }
3447: }
3448: }
3449: }
3450: if ($guest) {
3451: return $guest;
3452: }
3453: }
3454: }
3455: return;
3456: }
3457:
3458: sub course_group_datechecker {
3459: my ($dates,$now,$status) = @_;
3460: my ($start,$end) = split(/\./,$dates);
3461: if (!$start && !$end) {
3462: return 'ok';
3463: }
3464: if (grep/^active$/,@{$status}) {
3465: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3466: return 'ok';
3467: }
3468: }
3469: if (grep/^previous$/,@{$status}) {
3470: if ($end > $now ) {
3471: return 'ok';
3472: }
3473: }
3474: if (grep/^future$/,@{$status}) {
3475: if ($start > $now) {
3476: return 'ok';
3477: }
3478: }
3479: return;
3480: }
3481:
3482: sub parse_portfolio_url {
3483: my ($url) = @_;
3484:
3485: my ($type,$udom,$unum,$group,$file_name);
3486:
3487: if ($url =~ m-^/*uploaded/($match_domain)/($match_username)/portfolio(/.+)$-) {
3488: $type = 1;
3489: $udom = $1;
3490: $unum = $2;
3491: $file_name = $3;
3492: } elsif ($url =~ m-^/*uploaded/($match_domain)/($match_username)/groups/([^/]+)/portfolio/(.+)$-) {
3493: $type = 2;
3494: $udom = $1;
3495: $unum = $2;
3496: $group = $3;
3497: $file_name = $3.'/'.$4;
3498: }
3499: if (wantarray) {
3500: return ($type,$udom,$unum,$file_name,$group);
3501: }
3502: return $type;
3503: }
3504:
3505: sub is_portfolio_url {
3506: my ($url) = @_;
3507: return scalar(&parse_portfolio_url($url));
3508: }
3509:
3510: sub is_portfolio_file {
3511: my ($file) = @_;
3512: if (($file =~ /^portfolio/) || ($file =~ /^groups\/$match_username\/portfolio/)) {
3513: return 1;
3514: }
3515: return;
3516: }
3517:
3518:
3519: # ---------------------------------------------- Custom access rule evaluation
3520:
3521: sub customaccess {
3522: my ($priv,$uri)=@_;
3523: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
3524: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3525: $udom = &LONCAPA::clean_domain($udom);
3526: $ucrs = &LONCAPA::clean_username($ucrs);
3527: my $access=0;
3528: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3529: my ($effect,$realm,$role)=split(/\:/,$right);
3530: if ($role) {
3531: if ($role ne $urole) { next; }
3532: }
3533: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3534: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
3535: if ($tdom) {
3536: if ($tdom ne $udom) { next; }
3537: }
3538: if ($tcrs) {
3539: if ($tcrs ne $ucrs) { next; }
3540: }
3541: if ($tsec) {
3542: if ($tsec ne $usec) { next; }
3543: }
3544: $access=($effect eq 'allow');
3545: last;
3546: }
3547: if ($realm eq '' && $role eq '') {
3548: $access=($effect eq 'allow');
3549: }
3550: }
3551: return $access;
3552: }
3553:
3554: # ------------------------------------------------- Check for a user privilege
3555:
3556: sub allowed {
3557: my ($priv,$uri,$symb,$role)=@_;
3558: my $ver_orguri=$uri;
3559: $uri=&deversion($uri);
3560: my $orguri=$uri;
3561: $uri=&declutter($uri);
3562:
3563: if ($priv eq 'evb') {
3564: # Evade communication block restrictions for specified role in a course
3565: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
3566: return $1;
3567: } else {
3568: return;
3569: }
3570: }
3571:
3572: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3573: # Free bre access to adm and meta resources
3574: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3575: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3576: && ($priv eq 'bre')) {
3577: return 'F';
3578: }
3579:
3580: # Free bre access to user's own portfolio contents
3581: my ($space,$domain,$name,@dir)=split('/',$uri);
3582: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3583: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3584: return 'F';
3585: }
3586:
3587: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3588: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3589: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3590: if (exists($env{'request.course.id'})) {
3591: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3592: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3593: if (($domain eq $cdom) && ($name eq $cnum)) {
3594: my $courseprivid=$env{'request.course.id'};
3595: $courseprivid=~s/\_/\//;
3596: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3597: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3598: return $1;
3599: } else {
3600: if ($env{'request.course.sec'}) {
3601: $courseprivid.='/'.$env{'request.course.sec'};
3602: }
3603: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3604: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3605: return $2;
3606: }
3607: }
3608: }
3609: }
3610: }
3611:
3612: # Free bre to public access
3613:
3614: if ($priv eq 'bre') {
3615: my $copyright=&metadata($uri,'copyright');
3616: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3617: return 'F';
3618: }
3619: if ($copyright eq 'priv') {
3620: $uri=~/([^\/]+)\/([^\/]+)\//;
3621: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3622: return '';
3623: }
3624: }
3625: if ($copyright eq 'domain') {
3626: $uri=~/([^\/]+)\/([^\/]+)\//;
3627: unless (($env{'user.domain'} eq $1) ||
3628: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3629: return '';
3630: }
3631: }
3632: if ($env{'request.role'}=~ /li\.\//) {
3633: # Library role, so allow browsing of resources in this domain.
3634: return 'F';
3635: }
3636: if ($copyright eq 'custom') {
3637: unless (&customaccess($priv,$uri)) { return ''; }
3638: }
3639: }
3640: # Domain coordinator is trying to create a course
3641: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3642: # uri is the requested domain in this case.
3643: # comparison to 'request.role.domain' shows if the user has selected
3644: # a role of dc for the domain in question.
3645: return 'F' if ($uri eq $env{'request.role.domain'});
3646: }
3647:
3648: my $thisallowed='';
3649: my $statecond=0;
3650: my $courseprivid='';
3651:
3652: # Course
3653:
3654: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3655: $thisallowed.=$1;
3656: }
3657:
3658: # Domain
3659:
3660: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3661: =~/\Q$priv\E\&([^\:]*)/) {
3662: $thisallowed.=$1;
3663: }
3664:
3665: # Course: uri itself is a course
3666: my $courseuri=$uri;
3667: $courseuri=~s/\_(\d)/\/$1/;
3668: $courseuri=~s/^([^\/])/\/$1/;
3669:
3670: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3671: =~/\Q$priv\E\&([^\:]*)/) {
3672: $thisallowed.=$1;
3673: }
3674:
3675: # URI is an uploaded document for this course, default permissions don't matter
3676: # not allowing 'edit' access (editupload) to uploaded course docs
3677: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3678: $thisallowed='';
3679: my ($match)=&is_on_map($uri);
3680: if ($match) {
3681: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3682: =~/\Q$priv\E\&([^\:]*)/) {
3683: $thisallowed.=$1;
3684: }
3685: } else {
3686: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3687: if ($refuri) {
3688: if ($refuri =~ m|^/adm/|) {
3689: $thisallowed='F';
3690: } else {
3691: $refuri=&declutter($refuri);
3692: my ($match) = &is_on_map($refuri);
3693: if ($match) {
3694: $thisallowed='F';
3695: }
3696: }
3697: }
3698: }
3699: }
3700:
3701: if ($priv eq 'bre'
3702: && $thisallowed ne 'F'
3703: && $thisallowed ne '2'
3704: && &is_portfolio_url($uri)) {
3705: $thisallowed = &portfolio_access($uri);
3706: }
3707:
3708: # Full access at system, domain or course-wide level? Exit.
3709:
3710: if ($thisallowed=~/F/) {
3711: return 'F';
3712: }
3713:
3714: # If this is generating or modifying users, exit with special codes
3715:
3716: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3717: if (($priv eq 'cca') || ($priv eq 'caa')) {
3718: my ($audom,$auname)=split('/',$uri);
3719: # no author name given, so this just checks on the general right to make a co-author in this domain
3720: unless ($auname) { return $thisallowed; }
3721: # an author name is given, so we are about to actually make a co-author for a certain account
3722: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3723: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3724: ($audom ne $env{'request.role.domain'}))) { return ''; }
3725: }
3726: return $thisallowed;
3727: }
3728: #
3729: # Gathered so far: system, domain and course wide privileges
3730: #
3731: # Course: See if uri or referer is an individual resource that is part of
3732: # the course
3733:
3734: if ($env{'request.course.id'}) {
3735:
3736: $courseprivid=$env{'request.course.id'};
3737: if ($env{'request.course.sec'}) {
3738: $courseprivid.='/'.$env{'request.course.sec'};
3739: }
3740: $courseprivid=~s/\_/\//;
3741: my $checkreferer=1;
3742: my ($match,$cond)=&is_on_map($uri);
3743: if ($match) {
3744: $statecond=$cond;
3745: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3746: =~/\Q$priv\E\&([^\:]*)/) {
3747: $thisallowed.=$1;
3748: $checkreferer=0;
3749: }
3750: }
3751:
3752: if ($checkreferer) {
3753: my $refuri=$env{'httpref.'.$orguri};
3754: unless ($refuri) {
3755: foreach my $key (keys(%env)) {
3756: if ($key=~/^httpref\..*\*/) {
3757: my $pattern=$key;
3758: $pattern=~s/^httpref\.\/res\///;
3759: $pattern=~s/\*/\[\^\/\]\+/g;
3760: $pattern=~s/\//\\\//g;
3761: if ($orguri=~/$pattern/) {
3762: $refuri=$env{$key};
3763: }
3764: }
3765: }
3766: }
3767:
3768: if ($refuri) {
3769: $refuri=&declutter($refuri);
3770: my ($match,$cond)=&is_on_map($refuri);
3771: if ($match) {
3772: my $refstatecond=$cond;
3773: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3774: =~/\Q$priv\E\&([^\:]*)/) {
3775: $thisallowed.=$1;
3776: $uri=$refuri;
3777: $statecond=$refstatecond;
3778: }
3779: }
3780: }
3781: }
3782: }
3783:
3784: #
3785: # Gathered now: all privileges that could apply, and condition number
3786: #
3787: #
3788: # Full or no access?
3789: #
3790:
3791: if ($thisallowed=~/F/) {
3792: return 'F';
3793: }
3794:
3795: unless ($thisallowed) {
3796: return '';
3797: }
3798:
3799: # Restrictions exist, deal with them
3800: #
3801: # C:according to course preferences
3802: # R:according to resource settings
3803: # L:unless locked
3804: # X:according to user session state
3805: #
3806:
3807: # Possibly locked functionality, check all courses
3808: # Locks might take effect only after 10 minutes cache expiration for other
3809: # courses, and 2 minutes for current course
3810:
3811: my $envkey;
3812: if ($thisallowed=~/L/) {
3813: foreach $envkey (keys %env) {
3814: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3815: my $courseid=$2;
3816: my $roleid=$1.'.'.$2;
3817: $courseid=~s/^\///;
3818: my $expiretime=600;
3819: if ($env{'request.role'} eq $roleid) {
3820: $expiretime=120;
3821: }
3822: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3823: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3824: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3825: &coursedescription($courseid,{'freshen_cache' => 1});
3826: }
3827: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3828: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3829: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3830: &log($env{'user.domain'},$env{'user.name'},
3831: $env{'user.home'},
3832: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3833: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3834: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3835: return '';
3836: }
3837: }
3838: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3839: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3840: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3841: &log($env{'user.domain'},$env{'user.name'},
3842: $env{'user.home'},
3843: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3844: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3845: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3846: return '';
3847: }
3848: }
3849: }
3850: }
3851: }
3852:
3853: #
3854: # Rest of the restrictions depend on selected course
3855: #
3856:
3857: unless ($env{'request.course.id'}) {
3858: if ($thisallowed eq 'A') {
3859: return 'A';
3860: } else {
3861: return '1';
3862: }
3863: }
3864:
3865: #
3866: # Now user is definitely in a course
3867: #
3868:
3869:
3870: # Course preferences
3871:
3872: if ($thisallowed=~/C/) {
3873: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3874: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3875: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3876: =~/\Q$rolecode\E/) {
3877: if ($priv ne 'pch') {
3878: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3879: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3880: $env{'request.course.id'});
3881: }
3882: return '';
3883: }
3884:
3885: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3886: =~/\Q$unamedom\E/) {
3887: if ($priv ne 'pch') {
3888: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3889: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3890: $env{'request.course.id'});
3891: }
3892: return '';
3893: }
3894: }
3895:
3896: # Resource preferences
3897:
3898: if ($thisallowed=~/R/) {
3899: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3900: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3901: if ($priv ne 'pch') {
3902: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3903: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3904: }
3905: return '';
3906: }
3907: }
3908:
3909: # Restricted by state or randomout?
3910:
3911: if ($thisallowed=~/X/) {
3912: if ($env{'acc.randomout'}) {
3913: if (!$symb) { $symb=&symbread($uri,1); }
3914: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3915: return '';
3916: }
3917: }
3918: if (&condval($statecond)) {
3919: return '2';
3920: } else {
3921: return '';
3922: }
3923: }
3924:
3925: if ($thisallowed eq 'A') {
3926: return 'A';
3927: }
3928: return 'F';
3929: }
3930:
3931: sub split_uri_for_cond {
3932: my $uri=&deversion(&declutter(shift));
3933: my @uriparts=split(/\//,$uri);
3934: my $filename=pop(@uriparts);
3935: my $pathname=join('/',@uriparts);
3936: return ($pathname,$filename);
3937: }
3938: # --------------------------------------------------- Is a resource on the map?
3939:
3940: sub is_on_map {
3941: my ($pathname,$filename) = &split_uri_for_cond(shift);
3942: #Trying to find the conditional for the file
3943: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3944: /\&\Q$filename\E\:([\d\|]+)\&/);
3945: if ($match) {
3946: return (1,$1);
3947: } else {
3948: return (0,0);
3949: }
3950: }
3951:
3952: # --------------------------------------------------------- Get symb from alias
3953:
3954: sub get_symb_from_alias {
3955: my $symb=shift;
3956: my ($map,$resid,$url)=&decode_symb($symb);
3957: # Already is a symb
3958: if ($url) { return $symb; }
3959: # Must be an alias
3960: my $aliassymb='';
3961: my %bighash;
3962: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3963: &GDBM_READER(),0640)) {
3964: my $rid=$bighash{'mapalias_'.$symb};
3965: if ($rid) {
3966: my ($mapid,$resid)=split(/\./,$rid);
3967: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3968: $resid,$bighash{'src_'.$rid});
3969: }
3970: untie %bighash;
3971: }
3972: return $aliassymb;
3973: }
3974:
3975: # ----------------------------------------------------------------- Define Role
3976:
3977: sub definerole {
3978: if (allowed('mcr','/')) {
3979: my ($rolename,$sysrole,$domrole,$courole)=@_;
3980: foreach my $role (split(':',$sysrole)) {
3981: my ($crole,$cqual)=split(/\&/,$role);
3982: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3983: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3984: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3985: return "refused:s:$crole&$cqual";
3986: }
3987: }
3988: }
3989: foreach my $role (split(':',$domrole)) {
3990: my ($crole,$cqual)=split(/\&/,$role);
3991: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3992: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3993: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3994: return "refused:d:$crole&$cqual";
3995: }
3996: }
3997: }
3998: foreach my $role (split(':',$courole)) {
3999: my ($crole,$cqual)=split(/\&/,$role);
4000: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4001: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4002: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4003: return "refused:c:$crole&$cqual";
4004: }
4005: }
4006: }
4007: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4008: "$env{'user.domain'}:$env{'user.name'}:".
4009: "rolesdef_$rolename=".
4010: escape($sysrole.'_'.$domrole.'_'.$courole);
4011: return reply($command,$env{'user.home'});
4012: } else {
4013: return 'refused';
4014: }
4015: }
4016:
4017: # ---------------- Make a metadata query against the network of library servers
4018:
4019: sub metadata_query {
4020: my ($query,$custom,$customshow,$server_array)=@_;
4021: my %rhash;
4022: my @server_list = (defined($server_array) ? @$server_array
4023: : keys(%libserv) );
4024: for my $server (@server_list) {
4025: unless ($custom or $customshow) {
4026: my $reply=&reply("querysend:".&escape($query),$server);
4027: $rhash{$server}=$reply;
4028: }
4029: else {
4030: my $reply=&reply("querysend:".&escape($query).':'.
4031: &escape($custom).':'.&escape($customshow),
4032: $server);
4033: $rhash{$server}=$reply;
4034: }
4035: }
4036: return \%rhash;
4037: }
4038:
4039: # ----------------------------------------- Send log queries and wait for reply
4040:
4041: sub log_query {
4042: my ($uname,$udom,$query,%filters)=@_;
4043: my $uhome=&homeserver($uname,$udom);
4044: if ($uhome eq 'no_host') { return 'error: no_host'; }
4045: my $uhost=$hostname{$uhome};
4046: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4047: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4048: $uhome);
4049: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4050: return get_query_reply($queryid);
4051: }
4052:
4053: # ------- Request retrieval of institutional classlists for course(s)
4054:
4055: sub fetch_enrollment_query {
4056: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4057: my $homeserver;
4058: my $maxtries = 1;
4059: if ($context eq 'automated') {
4060: $homeserver = $perlvar{'lonHostID'};
4061: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4062: } else {
4063: $homeserver = &homeserver($cnum,$dom);
4064: }
4065: my $host=$hostname{$homeserver};
4066: my $cmd = '';
4067: foreach my $affiliate (keys %{$affiliatesref}) {
4068: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4069: }
4070: $cmd =~ s/%%$//;
4071: $cmd = &escape($cmd);
4072: my $query = 'fetchenrollment';
4073: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4074: unless ($queryid=~/^\Q$host\E\_/) {
4075: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4076: return 'error: '.$queryid;
4077: }
4078: my $reply = &get_query_reply($queryid);
4079: my $tries = 1;
4080: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4081: $reply = &get_query_reply($queryid);
4082: $tries ++;
4083: }
4084: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4085: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4086: } else {
4087: my @responses = split/:/,$reply;
4088: if ($homeserver eq $perlvar{'lonHostID'}) {
4089: foreach my $line (@responses) {
4090: my ($key,$value) = split(/=/,$line,2);
4091: $$replyref{$key} = $value;
4092: }
4093: } else {
4094: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4095: foreach my $line (@responses) {
4096: my ($key,$value) = split(/=/,$line);
4097: $$replyref{$key} = $value;
4098: if ($value > 0) {
4099: foreach my $item (@{$$affiliatesref{$key}}) {
4100: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4101: my $destname = $pathname.'/'.$filename;
4102: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4103: if ($xml_classlist =~ /^error/) {
4104: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4105: } else {
4106: if ( open(FILE,">$destname") ) {
4107: print FILE &unescape($xml_classlist);
4108: close(FILE);
4109: } else {
4110: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4111: }
4112: }
4113: }
4114: }
4115: }
4116: }
4117: return 'ok';
4118: }
4119: return 'error';
4120: }
4121:
4122: sub get_query_reply {
4123: my $queryid=shift;
4124: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4125: my $reply='';
4126: for (1..100) {
4127: sleep 2;
4128: if (-e $replyfile.'.end') {
4129: if (open(my $fh,$replyfile)) {
4130: $reply.=<$fh>;
4131: close($fh);
4132: } else { return 'error: reply_file_error'; }
4133: return &unescape($reply);
4134: }
4135: }
4136: return 'timeout:'.$queryid;
4137: }
4138:
4139: sub courselog_query {
4140: #
4141: # possible filters:
4142: # url: url or symb
4143: # username
4144: # domain
4145: # action: view, submit, grade
4146: # start: timestamp
4147: # end: timestamp
4148: #
4149: my (%filters)=@_;
4150: unless ($env{'request.course.id'}) { return 'no_course'; }
4151: if ($filters{'url'}) {
4152: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4153: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4154: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4155: }
4156: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4157: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4158: return &log_query($cname,$cdom,'courselog',%filters);
4159: }
4160:
4161: sub userlog_query {
4162: my ($uname,$udom,%filters)=@_;
4163: return &log_query($uname,$udom,'userlog',%filters);
4164: }
4165:
4166: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4167:
4168: sub auto_run {
4169: my ($cnum,$cdom) = @_;
4170: my $homeserver = &homeserver($cnum,$cdom);
4171: my $response = &reply('autorun:'.$cdom,$homeserver);
4172: return $response;
4173: }
4174:
4175: sub auto_get_sections {
4176: my ($cnum,$cdom,$inst_coursecode) = @_;
4177: my $homeserver = &homeserver($cnum,$cdom);
4178: my @secs = ();
4179: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4180: unless ($response eq 'refused') {
4181: @secs = split/:/,$response;
4182: }
4183: return @secs;
4184: }
4185:
4186: sub auto_new_course {
4187: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4188: my $homeserver = &homeserver($cnum,$cdom);
4189: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4190: return $response;
4191: }
4192:
4193: sub auto_validate_courseID {
4194: my ($cnum,$cdom,$inst_course_id) = @_;
4195: my $homeserver = &homeserver($cnum,$cdom);
4196: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4197: return $response;
4198: }
4199:
4200: sub auto_create_password {
4201: my ($cnum,$cdom,$authparam) = @_;
4202: my $homeserver = &homeserver($cnum,$cdom);
4203: my $create_passwd = 0;
4204: my $authchk = '';
4205: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4206: if ($response eq 'refused') {
4207: $authchk = 'refused';
4208: } else {
4209: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4210: }
4211: return ($authparam,$create_passwd,$authchk);
4212: }
4213:
4214: sub auto_photo_permission {
4215: my ($cnum,$cdom,$students) = @_;
4216: my $homeserver = &homeserver($cnum,$cdom);
4217: my ($outcome,$perm_reqd,$conditions) =
4218: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4219: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4220: return (undef,undef);
4221: }
4222: return ($outcome,$perm_reqd,$conditions);
4223: }
4224:
4225: sub auto_checkphotos {
4226: my ($uname,$udom,$pid) = @_;
4227: my $homeserver = &homeserver($uname,$udom);
4228: my ($result,$resulttype);
4229: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4230: &escape($uname).':'.&escape($pid),
4231: $homeserver));
4232: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4233: return (undef,undef);
4234: }
4235: if ($outcome) {
4236: ($result,$resulttype) = split(/:/,$outcome);
4237: }
4238: return ($result,$resulttype);
4239: }
4240:
4241: sub auto_photochoice {
4242: my ($cnum,$cdom) = @_;
4243: my $homeserver = &homeserver($cnum,$cdom);
4244: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4245: &escape($cdom),
4246: $homeserver)));
4247: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4248: return (undef,undef);
4249: }
4250: return ($update,$comment);
4251: }
4252:
4253: sub auto_photoupdate {
4254: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4255: my $homeserver = &homeserver($cnum,$dom);
4256: my $host=$hostname{$homeserver};
4257: my $cmd = '';
4258: my $maxtries = 1;
4259: foreach my $affiliate (keys(%{$affiliatesref})) {
4260: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4261: }
4262: $cmd =~ s/%%$//;
4263: $cmd = &escape($cmd);
4264: my $query = 'institutionalphotos';
4265: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4266: unless ($queryid=~/^\Q$host\E\_/) {
4267: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4268: return 'error: '.$queryid;
4269: }
4270: my $reply = &get_query_reply($queryid);
4271: my $tries = 1;
4272: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4273: $reply = &get_query_reply($queryid);
4274: $tries ++;
4275: }
4276: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4277: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4278: } else {
4279: my @responses = split(/:/,$reply);
4280: my $outcome = shift(@responses);
4281: foreach my $item (@responses) {
4282: my ($key,$value) = split(/=/,$item);
4283: $$photo{$key} = $value;
4284: }
4285: return $outcome;
4286: }
4287: return 'error';
4288: }
4289:
4290: sub auto_instcode_format {
4291: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4292: $cat_order) = @_;
4293: my $courses = '';
4294: my @homeservers;
4295: if ($caller eq 'global') {
4296: foreach my $tryserver (keys(%libserv)) {
4297: if ($hostdom{$tryserver} eq $codedom) {
4298: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4299: push(@homeservers,$tryserver);
4300: }
4301: }
4302: }
4303: } else {
4304: push(@homeservers,&homeserver($caller,$codedom));
4305: }
4306: foreach my $code (keys(%{$instcodes})) {
4307: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4308: }
4309: chop($courses);
4310: my $ok_response = 0;
4311: my $response;
4312: while (@homeservers > 0 && $ok_response == 0) {
4313: my $server = shift(@homeservers);
4314: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4315: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4316: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4317: split/:/,$response;
4318: %{$codes} = (%{$codes},&str2hash($codes_str));
4319: push(@{$codetitles},&str2array($codetitles_str));
4320: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4321: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4322: $ok_response = 1;
4323: }
4324: }
4325: if ($ok_response) {
4326: return 'ok';
4327: } else {
4328: return $response;
4329: }
4330: }
4331:
4332: sub auto_instcode_defaults {
4333: my ($domain,$returnhash,$code_order) = @_;
4334: my @homeservers;
4335: foreach my $tryserver (keys(%libserv)) {
4336: if ($hostdom{$tryserver} eq $domain) {
4337: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4338: push(@homeservers,$tryserver);
4339: }
4340: }
4341: }
4342: my $ok_response = 0;
4343: my $response;
4344: while (@homeservers > 0 && $ok_response == 0) {
4345: my $server = shift(@homeservers);
4346: $response=&reply('autoinstcodedefaults:'.$domain,$server);
4347: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4348: foreach my $pair (split(/\&/,$response)) {
4349: my ($name,$value)=split(/\=/,$pair);
4350: if ($name eq 'code_order') {
4351: @{$code_order} = split(/\&/,&unescape($value));
4352: } else {
4353: $returnhash->{&unescape($name)}=&unescape($value);
4354: }
4355: }
4356: $ok_response = 1;
4357: }
4358: }
4359: if ($ok_response) {
4360: return 'ok';
4361: } else {
4362: return $response;
4363: }
4364: }
4365:
4366: sub auto_validate_class_sec {
4367: my ($cdom,$cnum,$owner,$inst_class) = @_;
4368: my $homeserver = &homeserver($cnum,$cdom);
4369: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4370: &escape($owner).':'.$cdom,$homeserver);
4371: return $response;
4372: }
4373:
4374: # ------------------------------------------------------- Course Group routines
4375:
4376: sub get_coursegroups {
4377: my ($cdom,$cnum,$group,$namespace) = @_;
4378: return(&dump($namespace,$cdom,$cnum,$group));
4379: }
4380:
4381: sub modify_coursegroup {
4382: my ($cdom,$cnum,$groupsettings) = @_;
4383: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4384: }
4385:
4386: sub toggle_coursegroup_status {
4387: my ($cdom,$cnum,$group,$action) = @_;
4388: my ($from_namespace,$to_namespace);
4389: if ($action eq 'delete') {
4390: $from_namespace = 'coursegroups';
4391: $to_namespace = 'deleted_groups';
4392: } else {
4393: $from_namespace = 'deleted_groups';
4394: $to_namespace = 'coursegroups';
4395: }
4396: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
4397: if (my $tmp = &error(%curr_group)) {
4398: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
4399: return ('read error',$tmp);
4400: } else {
4401: my %savedsettings = %curr_group;
4402: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
4403: my $deloutcome;
4404: if ($result eq 'ok') {
4405: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
4406: } else {
4407: return ('write error',$result);
4408: }
4409: if ($deloutcome eq 'ok') {
4410: return 'ok';
4411: } else {
4412: return ('delete error',$deloutcome);
4413: }
4414: }
4415: }
4416:
4417: sub modify_group_roles {
4418: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4419: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4420: my $role = 'gr/'.&escape($userprivs);
4421: my ($uname,$udom) = split(/:/,$user);
4422: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4423: if ($result eq 'ok') {
4424: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4425: }
4426: return $result;
4427: }
4428:
4429: sub modify_coursegroup_membership {
4430: my ($cdom,$cnum,$membership) = @_;
4431: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4432: return $result;
4433: }
4434:
4435: sub get_active_groups {
4436: my ($udom,$uname,$cdom,$cnum) = @_;
4437: my $now = time;
4438: my %groups = ();
4439: foreach my $key (keys(%env)) {
4440: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_username)/(\w+)$-) {
4441: my ($start,$end) = split(/\./,$env{$key});
4442: if (($end!=0) && ($end<$now)) { next; }
4443: if (($start!=0) && ($start>$now)) { next; }
4444: if ($1 eq $cdom && $2 eq $cnum) {
4445: $groups{$3} = $env{$key} ;
4446: }
4447: }
4448: }
4449: return %groups;
4450: }
4451:
4452: sub get_group_membership {
4453: my ($cdom,$cnum,$group) = @_;
4454: return(&dump('groupmembership',$cdom,$cnum,$group));
4455: }
4456:
4457: sub get_users_groups {
4458: my ($udom,$uname,$courseid) = @_;
4459: my @usersgroups;
4460: my $cachetime=1800;
4461:
4462: my $hashid="$udom:$uname:$courseid";
4463: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4464: if (defined($cached)) {
4465: @usersgroups = split(/:/,$grouplist);
4466: } else {
4467: $grouplist = '';
4468: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4469: my ($tmp) = keys(%roleshash);
4470: if ($tmp=~/^error:/) {
4471: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4472: } else {
4473: my $access_end = $env{'course.'.$courseid.
4474: '.default_enrollment_end_date'};
4475: my $now = time;
4476: foreach my $key (keys(%roleshash)) {
4477: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4478: my $group = $1;
4479: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4480: my $start = $2;
4481: my $end = $1;
4482: if ($start == -1) { next; } # deleted from group
4483: if (($start!=0) && ($start>$now)) { next; }
4484: if (($end!=0) && ($end<$now)) {
4485: if ($access_end && $access_end < $now) {
4486: if ($access_end - $end < 86400) {
4487: push(@usersgroups,$group);
4488: }
4489: }
4490: next;
4491: }
4492: push(@usersgroups,$group);
4493: }
4494: }
4495: }
4496: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4497: $grouplist = join(':',@usersgroups);
4498: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4499: }
4500: }
4501: return @usersgroups;
4502: }
4503:
4504: sub devalidate_getgroups_cache {
4505: my ($udom,$uname,$cdom,$cnum)=@_;
4506: my $courseid = $cdom.'_'.$cnum;
4507:
4508: my $hashid="$udom:$uname:$courseid";
4509: &devalidate_cache_new('getgroups',$hashid);
4510: }
4511:
4512: # ------------------------------------------------------------------ Plain Text
4513:
4514: sub plaintext {
4515: my ($short,$type,$cid) = @_;
4516: if ($short =~ /^cr/) {
4517: return (split('/',$short))[-1];
4518: }
4519: if (!defined($cid)) {
4520: $cid = $env{'request.course.id'};
4521: }
4522: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4523: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4524: '.plaintext'});
4525: }
4526: my %rolenames = (
4527: Course => 'std',
4528: Group => 'alt1',
4529: );
4530: if (defined($type) &&
4531: defined($rolenames{$type}) &&
4532: defined($prp{$short}{$rolenames{$type}})) {
4533: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4534: } else {
4535: return &Apache::lonlocal::mt($prp{$short}{'std'});
4536: }
4537: }
4538:
4539: # ----------------------------------------------------------------- Assign Role
4540:
4541: sub assignrole {
4542: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4543: my $mrole;
4544: if ($role =~ /^cr\//) {
4545: my $cwosec=$url;
4546: $cwosec=~s/^\/($match_domain)\/($match_username)\/.*/$1\/$2/;
4547: unless (&allowed('ccr',$cwosec)) {
4548: &logthis('Refused custom assignrole: '.
4549: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4550: $env{'user.name'}.' at '.$env{'user.domain'});
4551: return 'refused';
4552: }
4553: $mrole='cr';
4554: } elsif ($role =~ /^gr\//) {
4555: my $cwogrp=$url;
4556: $cwogrp=~s{^/($match_domain)/($match_username)/.*}
4557: {$1/$2}x;
4558: unless (&allowed('mdg',$cwogrp)) {
4559: &logthis('Refused group assignrole: '.
4560: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4561: $env{'user.name'}.' at '.$env{'user.domain'});
4562: return 'refused';
4563: }
4564: $mrole='gr';
4565: } else {
4566: my $cwosec=$url;
4567: $cwosec=~s/^\/($match_domain)\/($match_username)\/.*/$1\/$2/;
4568: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4569: &logthis('Refused assignrole: '.
4570: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4571: $env{'user.name'}.' at '.$env{'user.domain'});
4572: return 'refused';
4573: }
4574: $mrole=$role;
4575: }
4576: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4577: "$udom:$uname:$url".'_'."$mrole=$role";
4578: if ($end) { $command.='_'.$end; }
4579: if ($start) {
4580: if ($end) {
4581: $command.='_'.$start;
4582: } else {
4583: $command.='_0_'.$start;
4584: }
4585: }
4586: my $origstart = $start;
4587: my $origend = $end;
4588: # actually delete
4589: if ($deleteflag) {
4590: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4591: # modify command to delete the role
4592: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4593: "$udom:$uname:$url".'_'."$mrole";
4594: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4595: # set start and finish to negative values for userrolelog
4596: $start=-1;
4597: $end=-1;
4598: }
4599: }
4600: # send command
4601: my $answer=&reply($command,&homeserver($uname,$udom));
4602: # log new user role if status is ok
4603: if ($answer eq 'ok') {
4604: &userrolelog($role,$uname,$udom,$url,$start,$end);
4605: # for course roles, perform group memberships changes triggered by role change.
4606: unless ($role =~ /^gr/) {
4607: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4608: $origstart);
4609: }
4610: }
4611: return $answer;
4612: }
4613:
4614: # -------------------------------------------------- Modify user authentication
4615: # Overrides without validation
4616:
4617: sub modifyuserauth {
4618: my ($udom,$uname,$umode,$upass)=@_;
4619: my $uhome=&homeserver($uname,$udom);
4620: unless (&allowed('mau',$udom)) { return 'refused'; }
4621: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4622: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4623: ' in domain '.$env{'request.role.domain'});
4624: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4625: &escape($upass),$uhome);
4626: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4627: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4628: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4629: &log($udom,,$uname,$uhome,
4630: 'Authentication changed by '.$env{'user.domain'}.', '.
4631: $env{'user.name'}.', '.$umode.
4632: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4633: unless ($reply eq 'ok') {
4634: &logthis('Authentication mode error: '.$reply);
4635: return 'error: '.$reply;
4636: }
4637: return 'ok';
4638: }
4639:
4640: # --------------------------------------------------------------- Modify a user
4641:
4642: sub modifyuser {
4643: my ($udom, $uname, $uid,
4644: $umode, $upass, $first,
4645: $middle, $last, $gene,
4646: $forceid, $desiredhome, $email)=@_;
4647: $udom= &LONCAPA::clean_domain($udom);
4648: $uname=&LONCAPA::clean_username($uname);
4649: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4650: $umode.', '.$first.', '.$middle.', '.
4651: $last.', '.$gene.'(forceid: '.$forceid.')'.
4652: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4653: ' desiredhome not specified').
4654: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4655: ' in domain '.$env{'request.role.domain'});
4656: my $uhome=&homeserver($uname,$udom,'true');
4657: # ----------------------------------------------------------------- Create User
4658: if (($uhome eq 'no_host') &&
4659: (($umode && $upass) || ($umode eq 'localauth'))) {
4660: my $unhome='';
4661: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4662: $unhome = $desiredhome;
4663: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4664: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4665: } else { # load balancing routine for determining $unhome
4666: my $tryserver;
4667: my $loadm=10000000;
4668: foreach $tryserver (keys %libserv) {
4669: if ($hostdom{$tryserver} eq $udom) {
4670: my $answer=reply('load',$tryserver);
4671: if (($answer=~/\d+/) && ($answer<$loadm)) {
4672: $loadm=$answer;
4673: $unhome=$tryserver;
4674: }
4675: }
4676: }
4677: }
4678: if (($unhome eq '') || ($unhome eq 'no_host')) {
4679: return 'error: unable to find a home server for '.$uname.
4680: ' in domain '.$udom;
4681: }
4682: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4683: &escape($upass),$unhome);
4684: unless ($reply eq 'ok') {
4685: return 'error: '.$reply;
4686: }
4687: $uhome=&homeserver($uname,$udom,'true');
4688: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4689: return 'error: unable verify users home machine.';
4690: }
4691: } # End of creation of new user
4692: # ---------------------------------------------------------------------- Add ID
4693: if ($uid) {
4694: $uid=~tr/A-Z/a-z/;
4695: my %uidhash=&idrget($udom,$uname);
4696: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4697: && (!$forceid)) {
4698: unless ($uid eq $uidhash{$uname}) {
4699: return 'error: user id "'.$uid.'" does not match '.
4700: 'current user id "'.$uidhash{$uname}.'".';
4701: }
4702: } else {
4703: &idput($udom,($uname => $uid));
4704: }
4705: }
4706: # -------------------------------------------------------------- Add names, etc
4707: my @tmp=&get('environment',
4708: ['firstname','middlename','lastname','generation'],
4709: $udom,$uname);
4710: my %names;
4711: if ($tmp[0] =~ m/^error:.*/) {
4712: %names=();
4713: } else {
4714: %names = @tmp;
4715: }
4716: #
4717: # Make sure to not trash student environment if instructor does not bother
4718: # to supply name and email information
4719: #
4720: if ($first) { $names{'firstname'} = $first; }
4721: if (defined($middle)) { $names{'middlename'} = $middle; }
4722: if ($last) { $names{'lastname'} = $last; }
4723: if (defined($gene)) { $names{'generation'} = $gene; }
4724: if ($email) {
4725: $email=~s/[^\w\@\.\-\,]//gs;
4726: if ($email=~/\@/) { $names{'notification'} = $email;
4727: $names{'critnotification'} = $email;
4728: $names{'permanentemail'} = $email; }
4729: }
4730: my $reply = &put('environment', \%names, $udom,$uname);
4731: if ($reply ne 'ok') { return 'error: '.$reply; }
4732: &devalidate_cache_new('namescache',$uname.':'.$udom);
4733: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4734: $umode.', '.$first.', '.$middle.', '.
4735: $last.', '.$gene.' by '.
4736: $env{'user.name'}.' at '.$env{'user.domain'});
4737: return 'ok';
4738: }
4739:
4740: # -------------------------------------------------------------- Modify student
4741:
4742: sub modifystudent {
4743: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4744: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4745: if (!$cid) {
4746: unless ($cid=$env{'request.course.id'}) {
4747: return 'not_in_class';
4748: }
4749: }
4750: # --------------------------------------------------------------- Make the user
4751: my $reply=&modifyuser
4752: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4753: $desiredhome,$email);
4754: unless ($reply eq 'ok') { return $reply; }
4755: # This will cause &modify_student_enrollment to get the uid from the
4756: # students environment
4757: $uid = undef if (!$forceid);
4758: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4759: $gene,$usec,$end,$start,$type,$locktype,$cid);
4760: return $reply;
4761: }
4762:
4763: sub modify_student_enrollment {
4764: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4765: my ($cdom,$cnum,$chome);
4766: if (!$cid) {
4767: unless ($cid=$env{'request.course.id'}) {
4768: return 'not_in_class';
4769: }
4770: $cdom=$env{'course.'.$cid.'.domain'};
4771: $cnum=$env{'course.'.$cid.'.num'};
4772: } else {
4773: ($cdom,$cnum)=split(/_/,$cid);
4774: }
4775: $chome=$env{'course.'.$cid.'.home'};
4776: if (!$chome) {
4777: $chome=&homeserver($cnum,$cdom);
4778: }
4779: if (!$chome) { return 'unknown_course'; }
4780: # Make sure the user exists
4781: my $uhome=&homeserver($uname,$udom);
4782: if (($uhome eq '') || ($uhome eq 'no_host')) {
4783: return 'error: no such user';
4784: }
4785: # Get student data if we were not given enough information
4786: if (!defined($first) || $first eq '' ||
4787: !defined($last) || $last eq '' ||
4788: !defined($uid) || $uid eq '' ||
4789: !defined($middle) || $middle eq '' ||
4790: !defined($gene) || $gene eq '') {
4791: # They did not supply us with enough data to enroll the student, so
4792: # we need to pick up more information.
4793: my %tmp = &get('environment',
4794: ['firstname','middlename','lastname', 'generation','id']
4795: ,$udom,$uname);
4796:
4797: #foreach my $key (keys(%tmp)) {
4798: # &logthis("key $key = ".$tmp{$key});
4799: #}
4800: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4801: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4802: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4803: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4804: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4805: }
4806: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4807: my $reply=cput('classlist',
4808: {"$uname:$udom" =>
4809: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4810: $cdom,$cnum);
4811: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4812: return 'error: '.$reply;
4813: } else {
4814: &devalidate_getsection_cache($udom,$uname,$cid);
4815: }
4816: # Add student role to user
4817: my $uurl='/'.$cid;
4818: $uurl=~s/\_/\//g;
4819: if ($usec) {
4820: $uurl.='/'.$usec;
4821: }
4822: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4823: }
4824:
4825: sub format_name {
4826: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4827: my $name;
4828: if ($first ne 'lastname') {
4829: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4830: } else {
4831: if ($lastname=~/\S/) {
4832: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4833: $name=~s/\s+,/,/;
4834: } else {
4835: $name.= $firstname.' '.$middlename.' '.$generation;
4836: }
4837: }
4838: $name=~s/^\s+//;
4839: $name=~s/\s+$//;
4840: $name=~s/\s+/ /g;
4841: return $name;
4842: }
4843:
4844: # ------------------------------------------------- Write to course preferences
4845:
4846: sub writecoursepref {
4847: my ($courseid,%prefs)=@_;
4848: $courseid=~s/^\///;
4849: $courseid=~s/\_/\//g;
4850: my ($cdomain,$cnum)=split(/\//,$courseid);
4851: my $chome=homeserver($cnum,$cdomain);
4852: if (($chome eq '') || ($chome eq 'no_host')) {
4853: return 'error: no such course';
4854: }
4855: my $cstring='';
4856: foreach my $pref (keys(%prefs)) {
4857: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
4858: }
4859: $cstring=~s/\&$//;
4860: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4861: }
4862:
4863: # ---------------------------------------------------------- Make/modify course
4864:
4865: sub createcourse {
4866: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4867: $course_owner,$crstype)=@_;
4868: $url=&declutter($url);
4869: my $cid='';
4870: unless (&allowed('ccc',$udom)) {
4871: return 'refused';
4872: }
4873: # ------------------------------------------------------------------- Create ID
4874: my $uname=int(1+rand(9)).
4875: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4876: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4877: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4878: # ----------------------------------------------- Make sure that does not exist
4879: my $uhome=&homeserver($uname,$udom,'true');
4880: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4881: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4882: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4883: $uhome=&homeserver($uname,$udom,'true');
4884: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4885: return 'error: unable to generate unique course-ID';
4886: }
4887: }
4888: # ------------------------------------------------ Check supplied server name
4889: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4890: if (! exists($libserv{$course_server})) {
4891: return 'error:bad server name '.$course_server;
4892: }
4893: # ------------------------------------------------------------- Make the course
4894: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4895: $course_server);
4896: unless ($reply eq 'ok') { return 'error: '.$reply; }
4897: $uhome=&homeserver($uname,$udom,'true');
4898: if (($uhome eq '') || ($uhome eq 'no_host')) {
4899: return 'error: no such course';
4900: }
4901: # ----------------------------------------------------------------- Course made
4902: # log existence
4903: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4904: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4905: &escape($crstype),$uhome);
4906: &flushcourselogs();
4907: # set toplevel url
4908: my $topurl=$url;
4909: unless ($nonstandard) {
4910: # ------------------------------------------ For standard courses, make top url
4911: my $mapurl=&clutter($url);
4912: if ($mapurl eq '/res/') { $mapurl=''; }
4913: $env{'form.initmap'}=(<<ENDINITMAP);
4914: <map>
4915: <resource id="1" type="start"></resource>
4916: <resource id="2" src="$mapurl"></resource>
4917: <resource id="3" type="finish"></resource>
4918: <link index="1" from="1" to="2"></link>
4919: <link index="2" from="2" to="3"></link>
4920: </map>
4921: ENDINITMAP
4922: $topurl=&declutter(
4923: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4924: );
4925: }
4926: # ----------------------------------------------------------- Write preferences
4927: &writecoursepref($udom.'_'.$uname,
4928: ('description' => $description,
4929: 'url' => $topurl));
4930: return '/'.$udom.'/'.$uname;
4931: }
4932:
4933: # ---------------------------------------------------------- Assign Custom Role
4934:
4935: sub assigncustomrole {
4936: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4937: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4938: $end,$start,$deleteflag);
4939: }
4940:
4941: # ----------------------------------------------------------------- Revoke Role
4942:
4943: sub revokerole {
4944: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4945: my $now=time;
4946: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4947: }
4948:
4949: # ---------------------------------------------------------- Revoke Custom Role
4950:
4951: sub revokecustomrole {
4952: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4953: my $now=time;
4954: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4955: $deleteflag);
4956: }
4957:
4958: # ------------------------------------------------------------ Disk usage
4959: sub diskusage {
4960: my ($udom,$uname,$directoryRoot)=@_;
4961: $directoryRoot =~ s/\/$//;
4962: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4963: return $listing;
4964: }
4965:
4966: sub is_locked {
4967: my ($file_name, $domain, $user) = @_;
4968: my @check;
4969: my $is_locked;
4970: push @check, $file_name;
4971: my %locked = &get('file_permissions',\@check,
4972: $env{'user.domain'},$env{'user.name'});
4973: my ($tmp)=keys(%locked);
4974: if ($tmp=~/^error:/) { undef(%locked); }
4975:
4976: if (ref($locked{$file_name}) eq 'ARRAY') {
4977: $is_locked = 'false';
4978: foreach my $entry (@{$locked{$file_name}}) {
4979: if (ref($entry) eq 'ARRAY') {
4980: $is_locked = 'true';
4981: last;
4982: }
4983: }
4984: } else {
4985: $is_locked = 'false';
4986: }
4987: }
4988:
4989: sub declutter_portfile {
4990: my ($file) = @_;
4991: &logthis("got $file");
4992: $file =~ s-^(/portfolio/|portfolio/)-/-;
4993: &logthis("ret $file");
4994: return $file;
4995: }
4996:
4997: # ------------------------------------------------------------- Mark as Read Only
4998:
4999: sub mark_as_readonly {
5000: my ($domain,$user,$files,$what) = @_;
5001: my %current_permissions = &dump('file_permissions',$domain,$user);
5002: my ($tmp)=keys(%current_permissions);
5003: if ($tmp=~/^error:/) { undef(%current_permissions); }
5004: foreach my $file (@{$files}) {
5005: $file = &declutter_portfile($file);
5006: push(@{$current_permissions{$file}},$what);
5007: }
5008: &put('file_permissions',\%current_permissions,$domain,$user);
5009: return;
5010: }
5011:
5012: # ------------------------------------------------------------Save Selected Files
5013:
5014: sub save_selected_files {
5015: my ($user, $path, @files) = @_;
5016: my $filename = $user."savedfiles";
5017: my @other_files = &files_not_in_path($user, $path);
5018: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5019: foreach my $file (@files) {
5020: print (OUT $env{'form.currentpath'}.$file."\n");
5021: }
5022: foreach my $file (@other_files) {
5023: print (OUT $file."\n");
5024: }
5025: close (OUT);
5026: return 'ok';
5027: }
5028:
5029: sub clear_selected_files {
5030: my ($user) = @_;
5031: my $filename = $user."savedfiles";
5032: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5033: print (OUT undef);
5034: close (OUT);
5035: return ("ok");
5036: }
5037:
5038: sub files_in_path {
5039: my ($user, $path) = @_;
5040: my $filename = $user."savedfiles";
5041: my %return_files;
5042: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5043: while (my $line_in = <IN>) {
5044: chomp ($line_in);
5045: my @paths_and_file = split (m!/!, $line_in);
5046: my $file_part = pop (@paths_and_file);
5047: my $path_part = join ('/', @paths_and_file);
5048: $path_part.='/';
5049: my $path_and_file = $path_part.$file_part;
5050: if ($path_part eq $path) {
5051: $return_files{$file_part}= 'selected';
5052: }
5053: }
5054: close (IN);
5055: return (\%return_files);
5056: }
5057:
5058: # called in portfolio select mode, to show files selected NOT in current directory
5059: sub files_not_in_path {
5060: my ($user, $path) = @_;
5061: my $filename = $user."savedfiles";
5062: my @return_files;
5063: my $path_part;
5064: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5065: while (my $line = <IN>) {
5066: #ok, I know it's clunky, but I want it to work
5067: my @paths_and_file = split(m|/|, $line);
5068: my $file_part = pop(@paths_and_file);
5069: chomp($file_part);
5070: my $path_part = join('/', @paths_and_file);
5071: $path_part .= '/';
5072: my $path_and_file = $path_part.$file_part;
5073: if ($path_part ne $path) {
5074: push(@return_files, ($path_and_file));
5075: }
5076: }
5077: close(OUT);
5078: return (@return_files);
5079: }
5080:
5081: #----------------------------------------------Get portfolio file permissions
5082:
5083: sub get_portfile_permissions {
5084: my ($domain,$user) = @_;
5085: my %current_permissions = &dump('file_permissions',$domain,$user);
5086: my ($tmp)=keys(%current_permissions);
5087: if ($tmp=~/^error:/) { undef(%current_permissions); }
5088: return \%current_permissions;
5089: }
5090:
5091: #---------------------------------------------Get portfolio file access controls
5092:
5093: sub get_access_controls {
5094: my ($current_permissions,$group,$file) = @_;
5095: my %access;
5096: my $real_file = $file;
5097: $file =~ s/\.meta$//;
5098: if (defined($file)) {
5099: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5100: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5101: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5102: }
5103: }
5104: } else {
5105: foreach my $key (keys(%{$current_permissions})) {
5106: if ($key =~ /\0accesscontrol$/) {
5107: if (defined($group)) {
5108: if ($key !~ m-^\Q$group\E/-) {
5109: next;
5110: }
5111: }
5112: my ($fullpath) = split(/\0/,$key);
5113: if (ref($$current_permissions{$key}) eq 'HASH') {
5114: foreach my $control (keys(%{$$current_permissions{$key}})) {
5115: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5116: }
5117: }
5118: }
5119: }
5120: }
5121: return %access;
5122: }
5123:
5124: sub modify_access_controls {
5125: my ($file_name,$changes,$domain,$user)=@_;
5126: my ($outcome,$deloutcome);
5127: my %store_permissions;
5128: my %new_values;
5129: my %new_control;
5130: my %translation;
5131: my @deletions = ();
5132: my $now = time;
5133: if (exists($$changes{'activate'})) {
5134: if (ref($$changes{'activate'}) eq 'HASH') {
5135: my @newitems = sort(keys(%{$$changes{'activate'}}));
5136: my $numnew = scalar(@newitems);
5137: for (my $i=0; $i<$numnew; $i++) {
5138: my $newkey = $newitems[$i];
5139: my $newid = &Apache::loncommon::get_cgi_id();
5140: if ($newkey =~ /^\d+:/) {
5141: $newkey =~ s/^(\d+)/$newid/;
5142: $translation{$1} = $newid;
5143: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5144: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5145: $translation{$1} = $newid;
5146: }
5147: $new_values{$file_name."\0".$newkey} =
5148: $$changes{'activate'}{$newitems[$i]};
5149: $new_control{$newkey} = $now;
5150: }
5151: }
5152: }
5153: my %todelete;
5154: my %changed_items;
5155: foreach my $action ('delete','update') {
5156: if (exists($$changes{$action})) {
5157: if (ref($$changes{$action}) eq 'HASH') {
5158: foreach my $key (keys(%{$$changes{$action}})) {
5159: my ($itemnum) = ($key =~ /^([^:]+):/);
5160: if ($action eq 'delete') {
5161: $todelete{$itemnum} = 1;
5162: } else {
5163: $changed_items{$itemnum} = $key;
5164: }
5165: }
5166: }
5167: }
5168: }
5169: # get lock on access controls for file.
5170: my $lockhash = {
5171: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5172: ':'.$env{'user.domain'},
5173: };
5174: my $tries = 0;
5175: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5176:
5177: while (($gotlock ne 'ok') && $tries <3) {
5178: $tries ++;
5179: sleep 1;
5180: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5181: }
5182: if ($gotlock eq 'ok') {
5183: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5184: my ($tmp)=keys(%curr_permissions);
5185: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5186: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5187: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5188: if (ref($curr_controls) eq 'HASH') {
5189: foreach my $control_item (keys(%{$curr_controls})) {
5190: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5191: if (defined($todelete{$itemnum})) {
5192: push(@deletions,$file_name."\0".$control_item);
5193: } else {
5194: if (defined($changed_items{$itemnum})) {
5195: $new_control{$changed_items{$itemnum}} = $now;
5196: push(@deletions,$file_name."\0".$control_item);
5197: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5198: } else {
5199: $new_control{$control_item} = $$curr_controls{$control_item};
5200: }
5201: }
5202: }
5203: }
5204: }
5205: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5206: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5207: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5208: # remove lock
5209: my @del_lock = ($file_name."\0".'locked_access_records');
5210: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5211: } else {
5212: $outcome = "error: could not obtain lockfile\n";
5213: }
5214: return ($outcome,$deloutcome,\%new_values,\%translation);
5215: }
5216:
5217: #------------------------------------------------------Get Marked as Read Only
5218:
5219: sub get_marked_as_readonly {
5220: my ($domain,$user,$what,$group) = @_;
5221: my $current_permissions = &get_portfile_permissions($domain,$user);
5222: my @readonly_files;
5223: my $cmp1=$what;
5224: if (ref($what)) { $cmp1=join('',@{$what}) };
5225: while (my ($file_name,$value) = each(%{$current_permissions})) {
5226: if (defined($group)) {
5227: if ($file_name !~ m-^\Q$group\E/-) {
5228: next;
5229: }
5230: }
5231: if (ref($value) eq "ARRAY"){
5232: foreach my $stored_what (@{$value}) {
5233: my $cmp2=$stored_what;
5234: if (ref($stored_what) eq 'ARRAY') {
5235: $cmp2=join('',@{$stored_what});
5236: }
5237: if ($cmp1 eq $cmp2) {
5238: push(@readonly_files, $file_name);
5239: last;
5240: } elsif (!defined($what)) {
5241: push(@readonly_files, $file_name);
5242: last;
5243: }
5244: }
5245: }
5246: }
5247: return @readonly_files;
5248: }
5249: #-----------------------------------------------------------Get Marked as Read Only Hash
5250:
5251: sub get_marked_as_readonly_hash {
5252: my ($current_permissions,$group,$what) = @_;
5253: my %readonly_files;
5254: while (my ($file_name,$value) = each(%{$current_permissions})) {
5255: if (defined($group)) {
5256: if ($file_name !~ m-^\Q$group\E/-) {
5257: next;
5258: }
5259: }
5260: if (ref($value) eq "ARRAY"){
5261: foreach my $stored_what (@{$value}) {
5262: if (ref($stored_what) eq 'ARRAY') {
5263: foreach my $lock_descriptor(@{$stored_what}) {
5264: if ($lock_descriptor eq 'graded') {
5265: $readonly_files{$file_name} = 'graded';
5266: } elsif ($lock_descriptor eq 'handback') {
5267: $readonly_files{$file_name} = 'handback';
5268: } else {
5269: if (!exists($readonly_files{$file_name})) {
5270: $readonly_files{$file_name} = 'locked';
5271: }
5272: }
5273: }
5274: }
5275: }
5276: }
5277: }
5278: return %readonly_files;
5279: }
5280: # ------------------------------------------------------------ Unmark as Read Only
5281:
5282: sub unmark_as_readonly {
5283: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5284: # for portfolio submissions, $what contains [$symb,$crsid]
5285: my ($domain,$user,$what,$file_name,$group) = @_;
5286: $file_name = &declutter_portfile($file_name);
5287: my $symb_crs = $what;
5288: if (ref($what)) { $symb_crs=join('',@$what); }
5289: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5290: my ($tmp)=keys(%current_permissions);
5291: if ($tmp=~/^error:/) { undef(%current_permissions); }
5292: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5293: foreach my $file (@readonly_files) {
5294: my $clean_file = &declutter_portfile($file);
5295: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5296: my $current_locks = $current_permissions{$file};
5297: my @new_locks;
5298: my @del_keys;
5299: if (ref($current_locks) eq "ARRAY"){
5300: foreach my $locker (@{$current_locks}) {
5301: my $compare=$locker;
5302: if (ref($locker) eq 'ARRAY') {
5303: $compare=join('',@{$locker});
5304: if ($compare ne $symb_crs) {
5305: push(@new_locks, $locker);
5306: }
5307: }
5308: }
5309: if (scalar(@new_locks) > 0) {
5310: $current_permissions{$file} = \@new_locks;
5311: } else {
5312: push(@del_keys, $file);
5313: &del('file_permissions',\@del_keys, $domain, $user);
5314: delete($current_permissions{$file});
5315: }
5316: }
5317: }
5318: &put('file_permissions',\%current_permissions,$domain,$user);
5319: return;
5320: }
5321:
5322: # ------------------------------------------------------------ Directory lister
5323:
5324: sub dirlist {
5325: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5326:
5327: $uri=~s/^\///;
5328: $uri=~s/\/$//;
5329: my ($udom, $uname);
5330: (undef,$udom,$uname)=split(/\//,$uri);
5331: if(defined($userdomain)) {
5332: $udom = $userdomain;
5333: }
5334: if(defined($username)) {
5335: $uname = $username;
5336: }
5337:
5338: my $dirRoot = $perlvar{'lonDocRoot'};
5339: if(defined($alternateDirectoryRoot)) {
5340: $dirRoot = $alternateDirectoryRoot;
5341: $dirRoot =~ s/\/$//;
5342: }
5343:
5344: if($udom) {
5345: if($uname) {
5346: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
5347: &homeserver($uname,$udom));
5348: my @listing_results;
5349: if ($listing eq 'unknown_cmd') {
5350: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
5351: &homeserver($uname,$udom));
5352: @listing_results = split(/:/,$listing);
5353: } else {
5354: @listing_results = map { &unescape($_); } split(/:/,$listing);
5355: }
5356: return @listing_results;
5357: } elsif(!defined($alternateDirectoryRoot)) {
5358: my %allusers;
5359: foreach my $tryserver (keys(%libserv)) {
5360: if($hostdom{$tryserver} eq $udom) {
5361: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5362: $udom, $tryserver);
5363: my @listing_results;
5364: if ($listing eq 'unknown_cmd') {
5365: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5366: $udom, $tryserver);
5367: @listing_results = split(/:/,$listing);
5368: } else {
5369: @listing_results =
5370: map { &unescape($_); } split(/:/,$listing);
5371: }
5372: if ($listing_results[0] ne 'no_such_dir' &&
5373: $listing_results[0] ne 'empty' &&
5374: $listing_results[0] ne 'con_lost') {
5375: foreach my $line (@listing_results) {
5376: my ($entry) = split(/&/,$line,2);
5377: $allusers{$entry} = 1;
5378: }
5379: }
5380: }
5381: }
5382: my $alluserstr='';
5383: foreach my $user (sort(keys(%allusers))) {
5384: $alluserstr.=$user.'&user:';
5385: }
5386: $alluserstr=~s/:$//;
5387: return split(/:/,$alluserstr);
5388: } else {
5389: return ('missing user name');
5390: }
5391: } elsif(!defined($alternateDirectoryRoot)) {
5392: my $tryserver;
5393: my %alldom=();
5394: foreach $tryserver (keys(%libserv)) {
5395: $alldom{$hostdom{$tryserver}}=1;
5396: }
5397: my $alldomstr='';
5398: foreach my $domain (sort(keys(%alldom))) {
5399: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain:';
5400: }
5401: $alldomstr=~s/:$//;
5402: return split(/:/,$alldomstr);
5403: } else {
5404: return ('missing domain');
5405: }
5406: }
5407:
5408: # --------------------------------------------- GetFileTimestamp
5409: # This function utilizes dirlist and returns the date stamp for
5410: # when it was last modified. It will also return an error of -1
5411: # if an error occurs
5412:
5413: ##
5414: ## FIXME: This subroutine assumes its caller knows something about the
5415: ## directory structure of the home server for the student ($root).
5416: ## Not a good assumption to make. Since this is for looking up files
5417: ## in user directories, the full path should be constructed by lond, not
5418: ## whatever machine we request data from.
5419: ##
5420: sub GetFileTimestamp {
5421: my ($studentDomain,$studentName,$filename,$root)=@_;
5422: $studentDomain = &LONCAPA::clean_domain($studentDomain);
5423: $studentName = &LONCAPA::clean_username($studentName);
5424: my $subdir=$studentName.'__';
5425: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5426: my $proname="$studentDomain/$subdir/$studentName";
5427: $proname .= '/'.$filename;
5428: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5429: $studentName, $root);
5430: my @stats = split('&', $fileStat);
5431: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5432: # @stats contains first the filename, then the stat output
5433: return $stats[10]; # so this is 10 instead of 9.
5434: } else {
5435: return -1;
5436: }
5437: }
5438:
5439: sub stat_file {
5440: my ($uri) = @_;
5441: $uri = &clutter_with_no_wrapper($uri);
5442:
5443: my ($udom,$uname,$file,$dir);
5444: if ($uri =~ m-^/(uploaded|editupload)/-) {
5445: ($udom,$uname,$file) =
5446: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_username)/?(.*)-);
5447: $file = 'userfiles/'.$file;
5448: $dir = &propath($udom,$uname);
5449: }
5450: if ($uri =~ m-^/res/-) {
5451: ($udom,$uname) =
5452: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
5453: $file = $uri;
5454: }
5455:
5456: if (!$udom || !$uname || !$file) {
5457: # unable to handle the uri
5458: return ();
5459: }
5460:
5461: my ($result) = &dirlist($file,$udom,$uname,$dir);
5462: my @stats = split('&', $result);
5463:
5464: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5465: shift(@stats); #filename is first
5466: return @stats;
5467: }
5468: return ();
5469: }
5470:
5471: # -------------------------------------------------------- Value of a Condition
5472:
5473: # gets the value of a specific preevaluated condition
5474: # stored in the string $env{user.state.<cid>}
5475: # or looks up a condition reference in the bighash and if if hasn't
5476: # already been evaluated recurses into docondval to get the value of
5477: # the condition, then memoizing it to
5478: # $env{user.state.<cid>.<condition>}
5479: sub directcondval {
5480: my $number=shift;
5481: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5482: &Apache::lonuserstate::evalstate();
5483: }
5484: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5485: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5486: } elsif ($number =~ /^_/) {
5487: my $sub_condition;
5488: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5489: &GDBM_READER(),0640)) {
5490: $sub_condition=$bighash{'conditions'.$number};
5491: untie(%bighash);
5492: }
5493: my $value = &docondval($sub_condition);
5494: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5495: return $value;
5496: }
5497: if ($env{'user.state.'.$env{'request.course.id'}}) {
5498: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5499: } else {
5500: return 2;
5501: }
5502: }
5503:
5504: # get the collection of conditions for this resource
5505: sub condval {
5506: my $condidx=shift;
5507: my $allpathcond='';
5508: foreach my $cond (split(/\|/,$condidx)) {
5509: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5510: $allpathcond.=
5511: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5512: }
5513: }
5514: $allpathcond=~s/\|$//;
5515: return &docondval($allpathcond);
5516: }
5517:
5518: #evaluates an expression of conditions
5519: sub docondval {
5520: my ($allpathcond) = @_;
5521: my $result=0;
5522: if ($env{'request.course.id'}
5523: && defined($allpathcond)) {
5524: my $operand='|';
5525: my @stack;
5526: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5527: if ($chunk eq '(') {
5528: push @stack,($operand,$result);
5529: } elsif ($chunk eq ')') {
5530: my $before=pop @stack;
5531: if (pop @stack eq '&') {
5532: $result=$result>$before?$before:$result;
5533: } else {
5534: $result=$result>$before?$result:$before;
5535: }
5536: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5537: $operand=$chunk;
5538: } else {
5539: my $new=directcondval($chunk);
5540: if ($operand eq '&') {
5541: $result=$result>$new?$new:$result;
5542: } else {
5543: $result=$result>$new?$result:$new;
5544: }
5545: }
5546: }
5547: }
5548: return $result;
5549: }
5550:
5551: # ---------------------------------------------------- Devalidate courseresdata
5552:
5553: sub devalidatecourseresdata {
5554: my ($coursenum,$coursedomain)=@_;
5555: my $hashid=$coursenum.':'.$coursedomain;
5556: &devalidate_cache_new('courseres',$hashid);
5557: }
5558:
5559:
5560: # --------------------------------------------------- Course Resourcedata Query
5561:
5562: sub get_courseresdata {
5563: my ($coursenum,$coursedomain)=@_;
5564: my $coursehom=&homeserver($coursenum,$coursedomain);
5565: my $hashid=$coursenum.':'.$coursedomain;
5566: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5567: my %dumpreply;
5568: unless (defined($cached)) {
5569: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5570: $result=\%dumpreply;
5571: my ($tmp) = keys(%dumpreply);
5572: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5573: &do_cache_new('courseres',$hashid,$result,600);
5574: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5575: return $tmp;
5576: } elsif ($tmp =~ /^(error)/) {
5577: $result=undef;
5578: &do_cache_new('courseres',$hashid,$result,600);
5579: }
5580: }
5581: return $result;
5582: }
5583:
5584: sub devalidateuserresdata {
5585: my ($uname,$udom)=@_;
5586: my $hashid="$udom:$uname";
5587: &devalidate_cache_new('userres',$hashid);
5588: }
5589:
5590: sub get_userresdata {
5591: my ($uname,$udom)=@_;
5592: #most student don\'t have any data set, check if there is some data
5593: if (&EXT_cache_status($udom,$uname)) { return undef; }
5594:
5595: my $hashid="$udom:$uname";
5596: my ($result,$cached)=&is_cached_new('userres',$hashid);
5597: if (!defined($cached)) {
5598: my %resourcedata=&dump('resourcedata',$udom,$uname);
5599: $result=\%resourcedata;
5600: &do_cache_new('userres',$hashid,$result,600);
5601: }
5602: my ($tmp)=keys(%$result);
5603: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5604: return $result;
5605: }
5606: #error 2 occurs when the .db doesn't exist
5607: if ($tmp!~/error: 2 /) {
5608: &logthis("<font color=\"blue\">WARNING:".
5609: " Trying to get resource data for ".
5610: $uname." at ".$udom.": ".
5611: $tmp."</font>");
5612: } elsif ($tmp=~/error: 2 /) {
5613: #&EXT_cache_set($udom,$uname);
5614: &do_cache_new('userres',$hashid,undef,600);
5615: undef($tmp); # not really an error so don't send it back
5616: }
5617: return $tmp;
5618: }
5619:
5620: sub resdata {
5621: my ($name,$domain,$type,@which)=@_;
5622: my $result;
5623: if ($type eq 'course') {
5624: $result=&get_courseresdata($name,$domain);
5625: } elsif ($type eq 'user') {
5626: $result=&get_userresdata($name,$domain);
5627: }
5628: if (!ref($result)) { return $result; }
5629: foreach my $item (@which) {
5630: if (defined($result->{$item})) {
5631: return $result->{$item};
5632: }
5633: }
5634: return undef;
5635: }
5636:
5637: #
5638: # EXT resource caching routines
5639: #
5640:
5641: sub clear_EXT_cache_status {
5642: &delenv('cache.EXT.');
5643: }
5644:
5645: sub EXT_cache_status {
5646: my ($target_domain,$target_user) = @_;
5647: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5648: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5649: # We know already the user has no data
5650: return 1;
5651: } else {
5652: return 0;
5653: }
5654: }
5655:
5656: sub EXT_cache_set {
5657: my ($target_domain,$target_user) = @_;
5658: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5659: #&appenv($cachename => time);
5660: }
5661:
5662: # --------------------------------------------------------- Value of a Variable
5663: sub EXT {
5664:
5665: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5666: unless ($varname) { return ''; }
5667: #get real user name/domain, courseid and symb
5668: my $courseid;
5669: my $publicuser;
5670: if ($symbparm) {
5671: $symbparm=&get_symb_from_alias($symbparm);
5672: }
5673: if (!($uname && $udom)) {
5674: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
5675: if (!$symbparm) { $symbparm=$cursymb; }
5676: } else {
5677: $courseid=$env{'request.course.id'};
5678: }
5679: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5680: my $rest;
5681: if (defined($therest[0])) {
5682: $rest=join('.',@therest);
5683: } else {
5684: $rest='';
5685: }
5686:
5687: my $qualifierrest=$qualifier;
5688: if ($rest) { $qualifierrest.='.'.$rest; }
5689: my $spacequalifierrest=$space;
5690: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5691: if ($realm eq 'user') {
5692: # --------------------------------------------------------------- user.resource
5693: if ($space eq 'resource') {
5694: if ( (defined($Apache::lonhomework::parsing_a_problem)
5695: || defined($Apache::lonhomework::parsing_a_task))
5696: &&
5697: ($symbparm eq &symbread()) ) {
5698: # if we are in the middle of processing the resource the
5699: # get the value we are planning on committing
5700: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5701: return $Apache::lonhomework::results{$qualifierrest};
5702: } else {
5703: return $Apache::lonhomework::history{$qualifierrest};
5704: }
5705: } else {
5706: my %restored;
5707: if ($publicuser || $env{'request.state'} eq 'construct') {
5708: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5709: } else {
5710: %restored=&restore($symbparm,$courseid,$udom,$uname);
5711: }
5712: return $restored{$qualifierrest};
5713: }
5714: # ----------------------------------------------------------------- user.access
5715: } elsif ($space eq 'access') {
5716: # FIXME - not supporting calls for a specific user
5717: return &allowed($qualifier,$rest);
5718: # ------------------------------------------ user.preferences, user.environment
5719: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5720: if (($uname eq $env{'user.name'}) &&
5721: ($udom eq $env{'user.domain'})) {
5722: return $env{join('.',('environment',$qualifierrest))};
5723: } else {
5724: my %returnhash;
5725: if (!$publicuser) {
5726: %returnhash=&userenvironment($udom,$uname,
5727: $qualifierrest);
5728: }
5729: return $returnhash{$qualifierrest};
5730: }
5731: # ----------------------------------------------------------------- user.course
5732: } elsif ($space eq 'course') {
5733: # FIXME - not supporting calls for a specific user
5734: return $env{join('.',('request.course',$qualifier))};
5735: # ------------------------------------------------------------------- user.role
5736: } elsif ($space eq 'role') {
5737: # FIXME - not supporting calls for a specific user
5738: my ($role,$where)=split(/\./,$env{'request.role'});
5739: if ($qualifier eq 'value') {
5740: return $role;
5741: } elsif ($qualifier eq 'extent') {
5742: return $where;
5743: }
5744: # ----------------------------------------------------------------- user.domain
5745: } elsif ($space eq 'domain') {
5746: return $udom;
5747: # ------------------------------------------------------------------- user.name
5748: } elsif ($space eq 'name') {
5749: return $uname;
5750: # ---------------------------------------------------- Any other user namespace
5751: } else {
5752: my %reply;
5753: if (!$publicuser) {
5754: %reply=&get($space,[$qualifierrest],$udom,$uname);
5755: }
5756: return $reply{$qualifierrest};
5757: }
5758: } elsif ($realm eq 'query') {
5759: # ---------------------------------------------- pull stuff out of query string
5760: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5761: [$spacequalifierrest]);
5762: return $env{'form.'.$spacequalifierrest};
5763: } elsif ($realm eq 'request') {
5764: # ------------------------------------------------------------- request.browser
5765: if ($space eq 'browser') {
5766: if ($qualifier eq 'textremote') {
5767: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5768: return 1;
5769: } else {
5770: return 0;
5771: }
5772: } else {
5773: return $env{'browser.'.$qualifier};
5774: }
5775: # ------------------------------------------------------------ request.filename
5776: } else {
5777: return $env{'request.'.$spacequalifierrest};
5778: }
5779: } elsif ($realm eq 'course') {
5780: # ---------------------------------------------------------- course.description
5781: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5782: } elsif ($realm eq 'resource') {
5783:
5784: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5785: if (!$symbparm) { $symbparm=&symbread(); }
5786: }
5787:
5788: if ($space eq 'title') {
5789: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5790: return &gettitle($symbparm);
5791: }
5792:
5793: if ($space eq 'map') {
5794: my ($map) = &decode_symb($symbparm);
5795: return &symbread($map);
5796: }
5797:
5798: my ($section, $group, @groups);
5799: my ($courselevelm,$courselevel);
5800: if ($symbparm && defined($courseid) &&
5801: $courseid eq $env{'request.course.id'}) {
5802:
5803: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5804:
5805: # ----------------------------------------------------- Cascading lookup scheme
5806: my $symbp=$symbparm;
5807: my $mapp=&deversion((&decode_symb($symbp))[0]);
5808:
5809: my $symbparm=$symbp.'.'.$spacequalifierrest;
5810: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5811:
5812: if (($env{'user.name'} eq $uname) &&
5813: ($env{'user.domain'} eq $udom)) {
5814: $section=$env{'request.course.sec'};
5815: @groups = split(/:/,$env{'request.course.groups'});
5816: @groups=&sort_course_groups($courseid,@groups);
5817: } else {
5818: if (! defined($usection)) {
5819: $section=&getsection($udom,$uname,$courseid);
5820: } else {
5821: $section = $usection;
5822: }
5823: @groups = &get_users_groups($udom,$uname,$courseid);
5824: }
5825:
5826: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5827: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5828: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5829:
5830: $courselevel=$courseid.'.'.$spacequalifierrest;
5831: my $courselevelr=$courseid.'.'.$symbparm;
5832: $courselevelm=$courseid.'.'.$mapparm;
5833:
5834: # ----------------------------------------------------------- first, check user
5835:
5836: my $userreply=&resdata($uname,$udom,'user',
5837: ($courselevelr,$courselevelm,
5838: $courselevel));
5839: if (defined($userreply)) { return $userreply; }
5840:
5841: # ------------------------------------------------ second, check some of course
5842: my $coursereply;
5843: if (@groups > 0) {
5844: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5845: $mapparm,$spacequalifierrest);
5846: if (defined($coursereply)) { return $coursereply; }
5847: }
5848:
5849: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5850: $env{'course.'.$courseid.'.domain'},
5851: 'course',
5852: ($seclevelr,$seclevelm,$seclevel,
5853: $courselevelr));
5854: if (defined($coursereply)) { return $coursereply; }
5855:
5856: # ------------------------------------------------------ third, check map parms
5857: my %parmhash=();
5858: my $thisparm='';
5859: if (tie(%parmhash,'GDBM_File',
5860: $env{'request.course.fn'}.'_parms.db',
5861: &GDBM_READER(),0640)) {
5862: $thisparm=$parmhash{$symbparm};
5863: untie(%parmhash);
5864: }
5865: if ($thisparm) { return $thisparm; }
5866: }
5867: # ------------------------------------------ fourth, look in resource metadata
5868:
5869: $spacequalifierrest=~s/\./\_/;
5870: my $filename;
5871: if (!$symbparm) { $symbparm=&symbread(); }
5872: if ($symbparm) {
5873: $filename=(&decode_symb($symbparm))[2];
5874: } else {
5875: $filename=$env{'request.filename'};
5876: }
5877: my $metadata=&metadata($filename,$spacequalifierrest);
5878: if (defined($metadata)) { return $metadata; }
5879: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5880: if (defined($metadata)) { return $metadata; }
5881:
5882: # ---------------------------------------------- fourth, look in rest pf course
5883: if ($symbparm && defined($courseid) &&
5884: $courseid eq $env{'request.course.id'}) {
5885: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5886: $env{'course.'.$courseid.'.domain'},
5887: 'course',
5888: ($courselevelm,$courselevel));
5889: if (defined($coursereply)) { return $coursereply; }
5890: }
5891: # ------------------------------------------------------------------ Cascade up
5892: unless ($space eq '0') {
5893: my @parts=split(/_/,$space);
5894: my $id=pop(@parts);
5895: my $part=join('_',@parts);
5896: if ($part eq '') { $part='0'; }
5897: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5898: $symbparm,$udom,$uname,$section,1);
5899: if (defined($partgeneral)) { return $partgeneral; }
5900: }
5901: if ($recurse) { return undef; }
5902: my $pack_def=&packages_tab_default($filename,$varname);
5903: if (defined($pack_def)) { return $pack_def; }
5904:
5905: # ---------------------------------------------------- Any other user namespace
5906: } elsif ($realm eq 'environment') {
5907: # ----------------------------------------------------------------- environment
5908: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5909: return $env{'environment.'.$spacequalifierrest};
5910: } else {
5911: if ($uname eq 'anonymous' && $udom eq '') {
5912: return '';
5913: }
5914: my %returnhash=&userenvironment($udom,$uname,
5915: $spacequalifierrest);
5916: return $returnhash{$spacequalifierrest};
5917: }
5918: } elsif ($realm eq 'system') {
5919: # ----------------------------------------------------------------- system.time
5920: if ($space eq 'time') {
5921: return time;
5922: }
5923: } elsif ($realm eq 'server') {
5924: # ----------------------------------------------------------------- system.time
5925: if ($space eq 'name') {
5926: return $ENV{'SERVER_NAME'};
5927: }
5928: }
5929: return '';
5930: }
5931:
5932: sub check_group_parms {
5933: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5934: my @groupitems = ();
5935: my $resultitem;
5936: my @levels = ($symbparm,$mapparm,$what);
5937: foreach my $group (@{$groups}) {
5938: foreach my $level (@levels) {
5939: my $item = $courseid.'.['.$group.'].'.$level;
5940: push(@groupitems,$item);
5941: }
5942: }
5943: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5944: $env{'course.'.$courseid.'.domain'},
5945: 'course',@groupitems);
5946: return $coursereply;
5947: }
5948:
5949: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5950: my ($courseid,@groups) = @_;
5951: @groups = sort(@groups);
5952: return @groups;
5953: }
5954:
5955: sub packages_tab_default {
5956: my ($uri,$varname)=@_;
5957: my (undef,$part,$name)=split(/\./,$varname);
5958:
5959: my (@extension,@specifics,$do_default);
5960: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
5961: my ($pack_type,$pack_part)=split(/_/,$package,2);
5962: if ($pack_type eq 'default') {
5963: $do_default=1;
5964: } elsif ($pack_type eq 'extension') {
5965: push(@extension,[$package,$pack_type,$pack_part]);
5966: } else {
5967: push(@specifics,[$package,$pack_type,$pack_part]);
5968: }
5969: }
5970: # first look for a package that matches the requested part id
5971: foreach my $package (@specifics) {
5972: my (undef,$pack_type,$pack_part)=@{$package};
5973: next if ($pack_part ne $part);
5974: if (defined($packagetab{"$pack_type&$name&default"})) {
5975: return $packagetab{"$pack_type&$name&default"};
5976: }
5977: }
5978: # look for any possible matching non extension_ package
5979: foreach my $package (@specifics) {
5980: my (undef,$pack_type,$pack_part)=@{$package};
5981: if (defined($packagetab{"$pack_type&$name&default"})) {
5982: return $packagetab{"$pack_type&$name&default"};
5983: }
5984: if ($pack_type eq 'part') { $pack_part='0'; }
5985: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5986: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5987: }
5988: }
5989: # look for any posible extension_ match
5990: foreach my $package (@extension) {
5991: my ($package,$pack_type)=@{$package};
5992: if (defined($packagetab{"$pack_type&$name&default"})) {
5993: return $packagetab{"$pack_type&$name&default"};
5994: }
5995: if (defined($packagetab{$package."&$name&default"})) {
5996: return $packagetab{$package."&$name&default"};
5997: }
5998: }
5999: # look for a global default setting
6000: if ($do_default && defined($packagetab{"default&$name&default"})) {
6001: return $packagetab{"default&$name&default"};
6002: }
6003: return undef;
6004: }
6005:
6006: sub add_prefix_and_part {
6007: my ($prefix,$part)=@_;
6008: my $keyroot;
6009: if (defined($prefix) && $prefix !~ /^__/) {
6010: # prefix that has a part already
6011: $keyroot=$prefix;
6012: } elsif (defined($prefix)) {
6013: # prefix that is missing a part
6014: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6015: } else {
6016: # no prefix at all
6017: if (defined($part)) { $keyroot='_'.$part; }
6018: }
6019: return $keyroot;
6020: }
6021:
6022: # ---------------------------------------------------------------- Get metadata
6023:
6024: my %metaentry;
6025: sub metadata {
6026: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6027: $uri=&declutter($uri);
6028: # if it is a non metadata possible uri return quickly
6029: if (($uri eq '') ||
6030: (($uri =~ m|^/*adm/|) &&
6031: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6032: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
6033: ($uri =~ m|home/$match_username/public_html/|)) {
6034: return undef;
6035: }
6036: my $filename=$uri;
6037: $uri=~s/\.meta$//;
6038: #
6039: # Is the metadata already cached?
6040: # Look at timestamp of caching
6041: # Everything is cached by the main uri, libraries are never directly cached
6042: #
6043: if (!defined($liburi)) {
6044: my ($result,$cached)=&is_cached_new('meta',$uri);
6045: if (defined($cached)) { return $result->{':'.$what}; }
6046: }
6047: {
6048: #
6049: # Is this a recursive call for a library?
6050: #
6051: # if (! exists($metacache{$uri})) {
6052: # $metacache{$uri}={};
6053: # }
6054: if ($liburi) {
6055: $liburi=&declutter($liburi);
6056: $filename=$liburi;
6057: } else {
6058: &devalidate_cache_new('meta',$uri);
6059: undef(%metaentry);
6060: }
6061: my %metathesekeys=();
6062: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
6063: my $metastring;
6064: if ($uri !~ m -^(editupload)/-) {
6065: my $file=&filelocation('',&clutter($filename));
6066: #push(@{$metaentry{$uri.'.file'}},$file);
6067: $metastring=&getfile($file);
6068: }
6069: my $parser=HTML::LCParser->new(\$metastring);
6070: my $token;
6071: undef %metathesekeys;
6072: while ($token=$parser->get_token) {
6073: if ($token->[0] eq 'S') {
6074: if (defined($token->[2]->{'package'})) {
6075: #
6076: # This is a package - get package info
6077: #
6078: my $package=$token->[2]->{'package'};
6079: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6080: if (defined($token->[2]->{'id'})) {
6081: $keyroot.='_'.$token->[2]->{'id'};
6082: }
6083: if ($metaentry{':packages'}) {
6084: $metaentry{':packages'}.=','.$package.$keyroot;
6085: } else {
6086: $metaentry{':packages'}=$package.$keyroot;
6087: }
6088: foreach my $pack_entry (keys(%packagetab)) {
6089: my $part=$keyroot;
6090: $part=~s/^\_//;
6091: if ($pack_entry=~/^\Q$package\E\&/ ||
6092: $pack_entry=~/^\Q$package\E_0\&/) {
6093: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6094: # ignore package.tab specified default values
6095: # here &package_tab_default() will fetch those
6096: if ($subp eq 'default') { next; }
6097: my $value=$packagetab{$pack_entry};
6098: my $unikey;
6099: if ($pack =~ /_0$/) {
6100: $unikey='parameter_0_'.$name;
6101: $part=0;
6102: } else {
6103: $unikey='parameter'.$keyroot.'_'.$name;
6104: }
6105: if ($subp eq 'display') {
6106: $value.=' [Part: '.$part.']';
6107: }
6108: $metaentry{':'.$unikey.'.part'}=$part;
6109: $metathesekeys{$unikey}=1;
6110: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6111: $metaentry{':'.$unikey.'.'.$subp}=$value;
6112: }
6113: if (defined($metaentry{':'.$unikey.'.default'})) {
6114: $metaentry{':'.$unikey}=
6115: $metaentry{':'.$unikey.'.default'};
6116: }
6117: }
6118: }
6119: } else {
6120: #
6121: # This is not a package - some other kind of start tag
6122: #
6123: my $entry=$token->[1];
6124: my $unikey;
6125: if ($entry eq 'import') {
6126: $unikey='';
6127: } else {
6128: $unikey=$entry;
6129: }
6130: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6131:
6132: if (defined($token->[2]->{'id'})) {
6133: $unikey.='_'.$token->[2]->{'id'};
6134: }
6135:
6136: if ($entry eq 'import') {
6137: #
6138: # Importing a library here
6139: #
6140: if ($depthcount<20) {
6141: my $location=$parser->get_text('/import');
6142: my $dir=$filename;
6143: $dir=~s|[^/]*$||;
6144: $location=&filelocation($dir,$location);
6145: my $metadata =
6146: &metadata($uri,'keys', $location,$unikey,
6147: $depthcount+1);
6148: foreach my $meta (split(',',$metadata)) {
6149: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6150: $metathesekeys{$meta}=1;
6151: }
6152: }
6153: } else {
6154:
6155: if (defined($token->[2]->{'name'})) {
6156: $unikey.='_'.$token->[2]->{'name'};
6157: }
6158: $metathesekeys{$unikey}=1;
6159: foreach my $param (@{$token->[3]}) {
6160: $metaentry{':'.$unikey.'.'.$param} =
6161: $token->[2]->{$param};
6162: }
6163: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6164: my $default=$metaentry{':'.$unikey.'.default'};
6165: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6166: # only ws inside the tag, and not in default, so use default
6167: # as value
6168: $metaentry{':'.$unikey}=$default;
6169: } else {
6170: # either something interesting inside the tag or default
6171: # uninteresting
6172: $metaentry{':'.$unikey}=$internaltext;
6173: }
6174: # end of not-a-package not-a-library import
6175: }
6176: # end of not-a-package start tag
6177: }
6178: # the next is the end of "start tag"
6179: }
6180: }
6181: my ($extension) = ($uri =~ /\.(\w+)$/);
6182: foreach my $key (keys(%packagetab)) {
6183: #no specific packages #how's our extension
6184: if ($key!~/^extension_\Q$extension\E&/) { next; }
6185: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6186: \%metathesekeys);
6187: }
6188: if (!exists($metaentry{':packages'})) {
6189: foreach my $key (keys(%packagetab)) {
6190: #no specific packages well let's get default then
6191: if ($key!~/^default&/) { next; }
6192: &metadata_create_package_def($uri,$key,'default',
6193: \%metathesekeys);
6194: }
6195: }
6196: # are there custom rights to evaluate
6197: if ($metaentry{':copyright'} eq 'custom') {
6198:
6199: #
6200: # Importing a rights file here
6201: #
6202: unless ($depthcount) {
6203: my $location=$metaentry{':customdistributionfile'};
6204: my $dir=$filename;
6205: $dir=~s|[^/]*$||;
6206: $location=&filelocation($dir,$location);
6207: my $rights_metadata =
6208: &metadata($uri,'keys',$location,'_rights',
6209: $depthcount+1);
6210: foreach my $rights (split(',',$rights_metadata)) {
6211: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6212: $metathesekeys{$rights}=1;
6213: }
6214: }
6215: }
6216: # uniqifiy package listing
6217: my %seen;
6218: my @uniq_packages =
6219: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6220: $metaentry{':packages'} = join(',',@uniq_packages);
6221:
6222: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6223: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6224: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6225: &do_cache_new('meta',$uri,\%metaentry,60*60);
6226: # this is the end of "was not already recently cached
6227: }
6228: return $metaentry{':'.$what};
6229: }
6230:
6231: sub metadata_create_package_def {
6232: my ($uri,$key,$package,$metathesekeys)=@_;
6233: my ($pack,$name,$subp)=split(/\&/,$key);
6234: if ($subp eq 'default') { next; }
6235:
6236: if (defined($metaentry{':packages'})) {
6237: $metaentry{':packages'}.=','.$package;
6238: } else {
6239: $metaentry{':packages'}=$package;
6240: }
6241: my $value=$packagetab{$key};
6242: my $unikey;
6243: $unikey='parameter_0_'.$name;
6244: $metaentry{':'.$unikey.'.part'}=0;
6245: $$metathesekeys{$unikey}=1;
6246: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6247: $metaentry{':'.$unikey.'.'.$subp}=$value;
6248: }
6249: if (defined($metaentry{':'.$unikey.'.default'})) {
6250: $metaentry{':'.$unikey}=
6251: $metaentry{':'.$unikey.'.default'};
6252: }
6253: }
6254:
6255: sub metadata_generate_part0 {
6256: my ($metadata,$metacache,$uri) = @_;
6257: my %allnames;
6258: foreach my $metakey (keys(%$metadata)) {
6259: if ($metakey=~/^parameter\_(.*)/) {
6260: my $part=$$metacache{':'.$metakey.'.part'};
6261: my $name=$$metacache{':'.$metakey.'.name'};
6262: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6263: $allnames{$name}=$part;
6264: }
6265: }
6266: }
6267: foreach my $name (keys(%allnames)) {
6268: $$metadata{"parameter_0_$name"}=1;
6269: my $key=":parameter_0_$name";
6270: $$metacache{"$key.part"}='0';
6271: $$metacache{"$key.name"}=$name;
6272: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6273: $allnames{$name}.'_'.$name.
6274: '.type'};
6275: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6276: '.display'};
6277: my $expr='[Part: '.$allnames{$name}.']';
6278: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6279: $$metacache{"$key.display"}=$olddis;
6280: }
6281: }
6282:
6283: # ------------------------------------------------------ Devalidate title cache
6284:
6285: sub devalidate_title_cache {
6286: my ($url)=@_;
6287: if (!$env{'request.course.id'}) { return; }
6288: my $symb=&symbread($url);
6289: if (!$symb) { return; }
6290: my $key=$env{'request.course.id'}."\0".$symb;
6291: &devalidate_cache_new('title',$key);
6292: }
6293:
6294: # ------------------------------------------------- Get the title of a resource
6295:
6296: sub gettitle {
6297: my $urlsymb=shift;
6298: my $symb=&symbread($urlsymb);
6299: if ($symb) {
6300: my $key=$env{'request.course.id'}."\0".$symb;
6301: my ($result,$cached)=&is_cached_new('title',$key);
6302: if (defined($cached)) {
6303: return $result;
6304: }
6305: my ($map,$resid,$url)=&decode_symb($symb);
6306: my $title='';
6307: my %bighash;
6308: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6309: &GDBM_READER(),0640)) {
6310: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6311: $title=$bighash{'title_'.$mapid.'.'.$resid};
6312: untie %bighash;
6313: }
6314: $title=~s/\&colon\;/\:/gs;
6315: if ($title) {
6316: return &do_cache_new('title',$key,$title,600);
6317: }
6318: $urlsymb=$url;
6319: }
6320: my $title=&metadata($urlsymb,'title');
6321: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6322: return $title;
6323: }
6324:
6325: sub get_slot {
6326: my ($which,$cnum,$cdom)=@_;
6327: if (!$cnum || !$cdom) {
6328: (undef,my $courseid)=&whichuser();
6329: $cdom=$env{'course.'.$courseid.'.domain'};
6330: $cnum=$env{'course.'.$courseid.'.num'};
6331: }
6332: my $key=join("\0",'slots',$cdom,$cnum,$which);
6333: my %slotinfo;
6334: if (exists($remembered{$key})) {
6335: $slotinfo{$which} = $remembered{$key};
6336: } else {
6337: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6338: &Apache::lonhomework::showhash(%slotinfo);
6339: my ($tmp)=keys(%slotinfo);
6340: if ($tmp=~/^error:/) { return (); }
6341: $remembered{$key} = $slotinfo{$which};
6342: }
6343: if (ref($slotinfo{$which}) eq 'HASH') {
6344: return %{$slotinfo{$which}};
6345: }
6346: return $slotinfo{$which};
6347: }
6348: # ------------------------------------------------- Update symbolic store links
6349:
6350: sub symblist {
6351: my ($mapname,%newhash)=@_;
6352: $mapname=&deversion(&declutter($mapname));
6353: my %hash;
6354: if (($env{'request.course.fn'}) && (%newhash)) {
6355: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6356: &GDBM_WRCREAT(),0640)) {
6357: foreach my $url (keys %newhash) {
6358: next if ($url eq 'last_known'
6359: && $env{'form.no_update_last_known'});
6360: $hash{declutter($url)}=&encode_symb($mapname,
6361: $newhash{$url}->[1],
6362: $newhash{$url}->[0]);
6363: }
6364: if (untie(%hash)) {
6365: return 'ok';
6366: }
6367: }
6368: }
6369: return 'error';
6370: }
6371:
6372: # --------------------------------------------------------------- Verify a symb
6373:
6374: sub symbverify {
6375: my ($symb,$thisurl)=@_;
6376: my $thisfn=$thisurl;
6377: $thisfn=&declutter($thisfn);
6378: # direct jump to resource in page or to a sequence - will construct own symbs
6379: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6380: # check URL part
6381: my ($map,$resid,$url)=&decode_symb($symb);
6382:
6383: unless ($url eq $thisfn) { return 0; }
6384:
6385: $symb=&symbclean($symb);
6386: $thisurl=&deversion($thisurl);
6387: $thisfn=&deversion($thisfn);
6388:
6389: my %bighash;
6390: my $okay=0;
6391:
6392: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6393: &GDBM_READER(),0640)) {
6394: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6395: unless ($ids) {
6396: $ids=$bighash{'ids_/'.$thisurl};
6397: }
6398: if ($ids) {
6399: # ------------------------------------------------------------------- Has ID(s)
6400: foreach my $id (split(/\,/,$ids)) {
6401: my ($mapid,$resid)=split(/\./,$id);
6402: if (
6403: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6404: eq $symb) {
6405: if (($env{'request.role.adv'}) ||
6406: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
6407: $okay=1;
6408: }
6409: }
6410: }
6411: }
6412: untie(%bighash);
6413: }
6414: return $okay;
6415: }
6416:
6417: # --------------------------------------------------------------- Clean-up symb
6418:
6419: sub symbclean {
6420: my $symb=shift;
6421: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6422: # remove version from map
6423: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6424:
6425: # remove version from URL
6426: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6427:
6428: # remove wrapper
6429:
6430: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6431: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6432: return $symb;
6433: }
6434:
6435: # ---------------------------------------------- Split symb to find map and url
6436:
6437: sub encode_symb {
6438: my ($map,$resid,$url)=@_;
6439: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6440: }
6441:
6442: sub decode_symb {
6443: my $symb=shift;
6444: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6445: my ($map,$resid,$url)=split(/___/,$symb);
6446: return (&fixversion($map),$resid,&fixversion($url));
6447: }
6448:
6449: sub fixversion {
6450: my $fn=shift;
6451: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6452: my %bighash;
6453: my $uri=&clutter($fn);
6454: my $key=$env{'request.course.id'}.'_'.$uri;
6455: # is this cached?
6456: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6457: if (defined($cached)) { return $result; }
6458: # unfortunately not cached, or expired
6459: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6460: &GDBM_READER(),0640)) {
6461: if ($bighash{'version_'.$uri}) {
6462: my $version=$bighash{'version_'.$uri};
6463: unless (($version eq 'mostrecent') ||
6464: ($version==&getversion($uri))) {
6465: $uri=~s/\.(\w+)$/\.$version\.$1/;
6466: }
6467: }
6468: untie %bighash;
6469: }
6470: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6471: }
6472:
6473: sub deversion {
6474: my $url=shift;
6475: $url=~s/\.\d+\.(\w+)$/\.$1/;
6476: return $url;
6477: }
6478:
6479: # ------------------------------------------------------ Return symb list entry
6480:
6481: sub symbread {
6482: my ($thisfn,$donotrecurse)=@_;
6483: my $cache_str='request.symbread.cached.'.$thisfn;
6484: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6485: # no filename provided? try from environment
6486: unless ($thisfn) {
6487: if ($env{'request.symb'}) {
6488: return $env{$cache_str}=&symbclean($env{'request.symb'});
6489: }
6490: $thisfn=$env{'request.filename'};
6491: }
6492: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6493: # is that filename actually a symb? Verify, clean, and return
6494: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6495: if (&symbverify($thisfn,$1)) {
6496: return $env{$cache_str}=&symbclean($thisfn);
6497: }
6498: }
6499: $thisfn=declutter($thisfn);
6500: my %hash;
6501: my %bighash;
6502: my $syval='';
6503: if (($env{'request.course.fn'}) && ($thisfn)) {
6504: my $targetfn = $thisfn;
6505: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6506: $targetfn = 'adm/wrapper/'.$thisfn;
6507: }
6508: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6509: $targetfn=$1;
6510: }
6511: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6512: &GDBM_READER(),0640)) {
6513: $syval=$hash{$targetfn};
6514: untie(%hash);
6515: }
6516: # ---------------------------------------------------------- There was an entry
6517: if ($syval) {
6518: #unless ($syval=~/\_\d+$/) {
6519: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6520: #&appenv('request.ambiguous' => $thisfn);
6521: #return $env{$cache_str}='';
6522: #}
6523: #$syval.=$1;
6524: #}
6525: } else {
6526: # ------------------------------------------------------- Was not in symb table
6527: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6528: &GDBM_READER(),0640)) {
6529: # ---------------------------------------------- Get ID(s) for current resource
6530: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6531: unless ($ids) {
6532: $ids=$bighash{'ids_/'.$thisfn};
6533: }
6534: unless ($ids) {
6535: # alias?
6536: $ids=$bighash{'mapalias_'.$thisfn};
6537: }
6538: if ($ids) {
6539: # ------------------------------------------------------------------- Has ID(s)
6540: my @possibilities=split(/\,/,$ids);
6541: if ($#possibilities==0) {
6542: # ----------------------------------------------- There is only one possibility
6543: my ($mapid,$resid)=split(/\./,$ids);
6544: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6545: $resid,$thisfn);
6546: } elsif (!$donotrecurse) {
6547: # ------------------------------------------ There is more than one possibility
6548: my $realpossible=0;
6549: foreach my $id (@possibilities) {
6550: my $file=$bighash{'src_'.$id};
6551: if (&allowed('bre',$file)) {
6552: my ($mapid,$resid)=split(/\./,$id);
6553: if ($bighash{'map_type_'.$mapid} ne 'page') {
6554: $realpossible++;
6555: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6556: $resid,$thisfn);
6557: }
6558: }
6559: }
6560: if ($realpossible!=1) { $syval=''; }
6561: } else {
6562: $syval='';
6563: }
6564: }
6565: untie(%bighash)
6566: }
6567: }
6568: if ($syval) {
6569: return $env{$cache_str}=$syval;
6570: }
6571: }
6572: &appenv('request.ambiguous' => $thisfn);
6573: return $env{$cache_str}='';
6574: }
6575:
6576: # ---------------------------------------------------------- Return random seed
6577:
6578: sub numval {
6579: my $txt=shift;
6580: $txt=~tr/A-J/0-9/;
6581: $txt=~tr/a-j/0-9/;
6582: $txt=~tr/K-T/0-9/;
6583: $txt=~tr/k-t/0-9/;
6584: $txt=~tr/U-Z/0-5/;
6585: $txt=~tr/u-z/0-5/;
6586: $txt=~s/\D//g;
6587: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6588: return int($txt);
6589: }
6590:
6591: sub numval2 {
6592: my $txt=shift;
6593: $txt=~tr/A-J/0-9/;
6594: $txt=~tr/a-j/0-9/;
6595: $txt=~tr/K-T/0-9/;
6596: $txt=~tr/k-t/0-9/;
6597: $txt=~tr/U-Z/0-5/;
6598: $txt=~tr/u-z/0-5/;
6599: $txt=~s/\D//g;
6600: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6601: my $total;
6602: foreach my $val (@txts) { $total+=$val; }
6603: if ($_64bit) { if ($total > 2**32) { return -1; } }
6604: return int($total);
6605: }
6606:
6607: sub numval3 {
6608: use integer;
6609: my $txt=shift;
6610: $txt=~tr/A-J/0-9/;
6611: $txt=~tr/a-j/0-9/;
6612: $txt=~tr/K-T/0-9/;
6613: $txt=~tr/k-t/0-9/;
6614: $txt=~tr/U-Z/0-5/;
6615: $txt=~tr/u-z/0-5/;
6616: $txt=~s/\D//g;
6617: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6618: my $total;
6619: foreach my $val (@txts) { $total+=$val; }
6620: if ($_64bit) { $total=(($total<<32)>>32); }
6621: return $total;
6622: }
6623:
6624: sub digest {
6625: my ($data)=@_;
6626: my $digest=&Digest::MD5::md5($data);
6627: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6628: my ($e,$f);
6629: {
6630: use integer;
6631: $e=($a+$b);
6632: $f=($c+$d);
6633: if ($_64bit) {
6634: $e=(($e<<32)>>32);
6635: $f=(($f<<32)>>32);
6636: }
6637: }
6638: if (wantarray) {
6639: return ($e,$f);
6640: } else {
6641: my $g;
6642: {
6643: use integer;
6644: $g=($e+$f);
6645: if ($_64bit) {
6646: $g=(($g<<32)>>32);
6647: }
6648: }
6649: return $g;
6650: }
6651: }
6652:
6653: sub latest_rnd_algorithm_id {
6654: return '64bit5';
6655: }
6656:
6657: sub get_rand_alg {
6658: my ($courseid)=@_;
6659: if (!$courseid) { $courseid=(&whichuser())[1]; }
6660: if ($courseid) {
6661: return $env{"course.$courseid.rndseed"};
6662: }
6663: return &latest_rnd_algorithm_id();
6664: }
6665:
6666: sub validCODE {
6667: my ($CODE)=@_;
6668: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6669: return 0;
6670: }
6671:
6672: sub getCODE {
6673: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6674: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6675: defined($Apache::lonhomework::parsing_a_task) ) &&
6676: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6677: return $Apache::lonhomework::history{'resource.CODE'};
6678: }
6679: return undef;
6680: }
6681:
6682: sub rndseed {
6683: my ($symb,$courseid,$domain,$username)=@_;
6684:
6685: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
6686: if (!$symb) {
6687: unless ($symb=$wsymb) { return time; }
6688: }
6689: if (!$courseid) { $courseid=$wcourseid; }
6690: if (!$domain) { $domain=$wdomain; }
6691: if (!$username) { $username=$wusername }
6692: my $which=&get_rand_alg();
6693:
6694: if (defined(&getCODE())) {
6695: if ($which eq '64bit5') {
6696: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6697: } elsif ($which eq '64bit4') {
6698: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6699: } else {
6700: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6701: }
6702: } elsif ($which eq '64bit5') {
6703: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6704: } elsif ($which eq '64bit4') {
6705: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6706: } elsif ($which eq '64bit3') {
6707: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6708: } elsif ($which eq '64bit2') {
6709: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6710: } elsif ($which eq '64bit') {
6711: return &rndseed_64bit($symb,$courseid,$domain,$username);
6712: }
6713: return &rndseed_32bit($symb,$courseid,$domain,$username);
6714: }
6715:
6716: sub rndseed_32bit {
6717: my ($symb,$courseid,$domain,$username)=@_;
6718: {
6719: use integer;
6720: my $symbchck=unpack("%32C*",$symb) << 27;
6721: my $symbseed=numval($symb) << 22;
6722: my $namechck=unpack("%32C*",$username) << 17;
6723: my $nameseed=numval($username) << 12;
6724: my $domainseed=unpack("%32C*",$domain) << 7;
6725: my $courseseed=unpack("%32C*",$courseid);
6726: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6727: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6728: #&logthis("rndseed :$num:$symb");
6729: if ($_64bit) { $num=(($num<<32)>>32); }
6730: return $num;
6731: }
6732: }
6733:
6734: sub rndseed_64bit {
6735: my ($symb,$courseid,$domain,$username)=@_;
6736: {
6737: use integer;
6738: my $symbchck=unpack("%32S*",$symb) << 21;
6739: my $symbseed=numval($symb) << 10;
6740: my $namechck=unpack("%32S*",$username);
6741:
6742: my $nameseed=numval($username) << 21;
6743: my $domainseed=unpack("%32S*",$domain) << 10;
6744: my $courseseed=unpack("%32S*",$courseid);
6745:
6746: my $num1=$symbchck+$symbseed+$namechck;
6747: my $num2=$nameseed+$domainseed+$courseseed;
6748: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6749: #&logthis("rndseed :$num:$symb");
6750: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6751: return "$num1,$num2";
6752: }
6753: }
6754:
6755: sub rndseed_64bit2 {
6756: my ($symb,$courseid,$domain,$username)=@_;
6757: {
6758: use integer;
6759: # strings need to be an even # of cahracters long, it it is odd the
6760: # last characters gets thrown away
6761: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6762: my $symbseed=numval($symb) << 10;
6763: my $namechck=unpack("%32S*",$username.' ');
6764:
6765: my $nameseed=numval($username) << 21;
6766: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6767: my $courseseed=unpack("%32S*",$courseid.' ');
6768:
6769: my $num1=$symbchck+$symbseed+$namechck;
6770: my $num2=$nameseed+$domainseed+$courseseed;
6771: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6772: #&logthis("rndseed :$num:$symb");
6773: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6774: return "$num1,$num2";
6775: }
6776: }
6777:
6778: sub rndseed_64bit3 {
6779: my ($symb,$courseid,$domain,$username)=@_;
6780: {
6781: use integer;
6782: # strings need to be an even # of cahracters long, it it is odd the
6783: # last characters gets thrown away
6784: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6785: my $symbseed=numval2($symb) << 10;
6786: my $namechck=unpack("%32S*",$username.' ');
6787:
6788: my $nameseed=numval2($username) << 21;
6789: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6790: my $courseseed=unpack("%32S*",$courseid.' ');
6791:
6792: my $num1=$symbchck+$symbseed+$namechck;
6793: my $num2=$nameseed+$domainseed+$courseseed;
6794: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6795: #&logthis("rndseed :$num1:$num2:$_64bit");
6796: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6797:
6798: return "$num1:$num2";
6799: }
6800: }
6801:
6802: sub rndseed_64bit4 {
6803: my ($symb,$courseid,$domain,$username)=@_;
6804: {
6805: use integer;
6806: # strings need to be an even # of cahracters long, it it is odd the
6807: # last characters gets thrown away
6808: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6809: my $symbseed=numval3($symb) << 10;
6810: my $namechck=unpack("%32S*",$username.' ');
6811:
6812: my $nameseed=numval3($username) << 21;
6813: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6814: my $courseseed=unpack("%32S*",$courseid.' ');
6815:
6816: my $num1=$symbchck+$symbseed+$namechck;
6817: my $num2=$nameseed+$domainseed+$courseseed;
6818: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6819: #&logthis("rndseed :$num1:$num2:$_64bit");
6820: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6821:
6822: return "$num1:$num2";
6823: }
6824: }
6825:
6826: sub rndseed_64bit5 {
6827: my ($symb,$courseid,$domain,$username)=@_;
6828: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6829: return "$num1:$num2";
6830: }
6831:
6832: sub rndseed_CODE_64bit {
6833: my ($symb,$courseid,$domain,$username)=@_;
6834: {
6835: use integer;
6836: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6837: my $symbseed=numval2($symb);
6838: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6839: my $CODEseed=numval(&getCODE());
6840: my $courseseed=unpack("%32S*",$courseid.' ');
6841: my $num1=$symbseed+$CODEchck;
6842: my $num2=$CODEseed+$courseseed+$symbchck;
6843: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6844: #&logthis("rndseed :$num1:$num2:$symb");
6845: if ($_64bit) { $num1=(($num1<<32)>>32); }
6846: if ($_64bit) { $num2=(($num2<<32)>>32); }
6847: return "$num1:$num2";
6848: }
6849: }
6850:
6851: sub rndseed_CODE_64bit4 {
6852: my ($symb,$courseid,$domain,$username)=@_;
6853: {
6854: use integer;
6855: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6856: my $symbseed=numval3($symb);
6857: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6858: my $CODEseed=numval3(&getCODE());
6859: my $courseseed=unpack("%32S*",$courseid.' ');
6860: my $num1=$symbseed+$CODEchck;
6861: my $num2=$CODEseed+$courseseed+$symbchck;
6862: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6863: #&logthis("rndseed :$num1:$num2:$symb");
6864: if ($_64bit) { $num1=(($num1<<32)>>32); }
6865: if ($_64bit) { $num2=(($num2<<32)>>32); }
6866: return "$num1:$num2";
6867: }
6868: }
6869:
6870: sub rndseed_CODE_64bit5 {
6871: my ($symb,$courseid,$domain,$username)=@_;
6872: my $code = &getCODE();
6873: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6874: return "$num1:$num2";
6875: }
6876:
6877: sub setup_random_from_rndseed {
6878: my ($rndseed)=@_;
6879: if ($rndseed =~/([,:])/) {
6880: my ($num1,$num2)=split(/[,:]/,$rndseed);
6881: &Math::Random::random_set_seed(abs($num1),abs($num2));
6882: } else {
6883: &Math::Random::random_set_seed_from_phrase($rndseed);
6884: }
6885: }
6886:
6887: sub latest_receipt_algorithm_id {
6888: return 'receipt2';
6889: }
6890:
6891: sub recunique {
6892: my $fucourseid=shift;
6893: my $unique;
6894: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6895: $unique=$env{"course.$fucourseid.internal.encseed"};
6896: } else {
6897: $unique=$perlvar{'lonReceipt'};
6898: }
6899: return unpack("%32C*",$unique);
6900: }
6901:
6902: sub recprefix {
6903: my $fucourseid=shift;
6904: my $prefix;
6905: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6906: $prefix=$env{"course.$fucourseid.internal.encpref"};
6907: } else {
6908: $prefix=$perlvar{'lonHostID'};
6909: }
6910: return unpack("%32C*",$prefix);
6911: }
6912:
6913: sub ireceipt {
6914: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6915: my $cuname=unpack("%32C*",$funame);
6916: my $cudom=unpack("%32C*",$fudom);
6917: my $cucourseid=unpack("%32C*",$fucourseid);
6918: my $cusymb=unpack("%32C*",$fusymb);
6919: my $cunique=&recunique($fucourseid);
6920: my $cpart=unpack("%32S*",$part);
6921: my $return =&recprefix($fucourseid).'-';
6922: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6923: $env{'request.state'} eq 'construct') {
6924: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
6925:
6926: $return.= ($cunique%$cuname+
6927: $cunique%$cudom+
6928: $cusymb%$cuname+
6929: $cusymb%$cudom+
6930: $cucourseid%$cuname+
6931: $cucourseid%$cudom+
6932: $cpart%$cuname+
6933: $cpart%$cudom);
6934: } else {
6935: $return.= ($cunique%$cuname+
6936: $cunique%$cudom+
6937: $cusymb%$cuname+
6938: $cusymb%$cudom+
6939: $cucourseid%$cuname+
6940: $cucourseid%$cudom);
6941: }
6942: return $return;
6943: }
6944:
6945: sub receipt {
6946: my ($part)=@_;
6947: my ($symb,$courseid,$domain,$name) = &whichuser();
6948: return &ireceipt($name,$domain,$courseid,$symb,$part);
6949: }
6950:
6951: sub whichuser {
6952: my ($passedsymb)=@_;
6953: my ($symb,$courseid,$domain,$name,$publicuser);
6954: if (defined($env{'form.grade_symb'})) {
6955: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
6956: my $allowed=&allowed('vgr',$tmp_courseid);
6957: if (!$allowed &&
6958: exists($env{'request.course.sec'}) &&
6959: $env{'request.course.sec'} !~ /^\s*$/) {
6960: $allowed=&allowed('vgr',$tmp_courseid.
6961: '/'.$env{'request.course.sec'});
6962: }
6963: if ($allowed) {
6964: ($symb)=&get_env_multiple('form.grade_symb');
6965: $courseid=$tmp_courseid;
6966: ($domain)=&get_env_multiple('form.grade_domain');
6967: ($name)=&get_env_multiple('form.grade_username');
6968: return ($symb,$courseid,$domain,$name,$publicuser);
6969: }
6970: }
6971: if (!$passedsymb) {
6972: $symb=&symbread();
6973: } else {
6974: $symb=$passedsymb;
6975: }
6976: $courseid=$env{'request.course.id'};
6977: $domain=$env{'user.domain'};
6978: $name=$env{'user.name'};
6979: if ($name eq 'public' && $domain eq 'public') {
6980: if (!defined($env{'form.username'})) {
6981: $env{'form.username'}.=time.rand(10000000);
6982: }
6983: $name.=$env{'form.username'};
6984: }
6985: return ($symb,$courseid,$domain,$name,$publicuser);
6986:
6987: }
6988:
6989: # ------------------------------------------------------------ Serves up a file
6990: # returns either the contents of the file or
6991: # -1 if the file doesn't exist
6992: #
6993: # if the target is a file that was uploaded via DOCS,
6994: # a check will be made to see if a current copy exists on the local server,
6995: # if it does this will be served, otherwise a copy will be retrieved from
6996: # the home server for the course and stored in /home/httpd/html/userfiles on
6997: # the local server.
6998:
6999: sub getfile {
7000: my ($file) = @_;
7001: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7002: &repcopy($file);
7003: return &readfile($file);
7004: }
7005:
7006: sub repcopy_userfile {
7007: my ($file)=@_;
7008: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7009: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7010: my ($cdom,$cnum,$filename) =
7011: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_username)/+(.*)|);
7012: my ($info,$rtncode);
7013: my $uri="/uploaded/$cdom/$cnum/$filename";
7014: if (-e "$file") {
7015: my @fileinfo = stat($file);
7016: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
7017: if ($lwpresp ne 'ok') {
7018: if ($rtncode eq '404') {
7019: unlink($file);
7020: }
7021: #my $ua=new LWP::UserAgent;
7022: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
7023: #my $response=$ua->request($request);
7024: #if ($response->is_success()) {
7025: # return $response->content;
7026: # } else {
7027: # return -1;
7028: # }
7029: return -1;
7030: }
7031: if ($info < $fileinfo[9]) {
7032: return 'ok';
7033: }
7034: $info = '';
7035: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
7036: if ($lwpresp ne 'ok') {
7037: return -1;
7038: }
7039: } else {
7040: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
7041: if ($lwpresp ne 'ok') {
7042: my $ua=new LWP::UserAgent;
7043: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
7044: my $response=$ua->request($request);
7045: if ($response->is_success()) {
7046: $info=$response->content;
7047: } else {
7048: return -1;
7049: }
7050: }
7051: my @parts = ($cdom,$cnum);
7052: if ($filename =~ m|^(.+)/[^/]+$|) {
7053: push @parts, split(/\//,$1);
7054: }
7055: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7056: foreach my $part (@parts) {
7057: $path .= '/'.$part;
7058: if (!-e $path) {
7059: mkdir($path,0770);
7060: }
7061: }
7062: }
7063: open(FILE,">$file");
7064: print FILE $info;
7065: close(FILE);
7066: return 'ok';
7067: }
7068:
7069: sub tokenwrapper {
7070: my $uri=shift;
7071: $uri=~s|^http\://([^/]+)||;
7072: $uri=~s|^/||;
7073: $env{'user.environment'}=~/\/([^\/]+)\.id/;
7074: my $token=$1;
7075: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7076: if ($udom && $uname && $file) {
7077: $file=~s|(\?\.*)*$||;
7078: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
7079: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
7080: (($uri=~/\?/)?'&':'?').'token='.$token.
7081: '&tokenissued='.$perlvar{'lonHostID'};
7082: } else {
7083: return '/adm/notfound.html';
7084: }
7085: }
7086:
7087: sub getuploaded {
7088: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7089: $uri=~s/^\///;
7090: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
7091: my $ua=new LWP::UserAgent;
7092: my $request=new HTTP::Request($reqtype,$uri);
7093: my $response=$ua->request($request);
7094: $$rtncode = $response->code;
7095: if (! $response->is_success()) {
7096: return 'failed';
7097: }
7098: if ($reqtype eq 'HEAD') {
7099: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7100: } elsif ($reqtype eq 'GET') {
7101: $$info = $response->content;
7102: }
7103: return 'ok';
7104: }
7105:
7106: sub readfile {
7107: my $file = shift;
7108: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7109: my $fh;
7110: open($fh,"<$file");
7111: my $a='';
7112: while (my $line = <$fh>) { $a .= $line; }
7113: return $a;
7114: }
7115:
7116: sub filelocation {
7117: my ($dir,$file) = @_;
7118: my $location;
7119: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7120:
7121: if ($file =~ m-^/adm/-) {
7122: $file=~s-^/adm/wrapper/-/-;
7123: $file=~s-^/adm/coursedocs/showdoc/-/-;
7124: }
7125: if ($file=~m:^/~:) { # is a contruction space reference
7126: $location = $file;
7127: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7128: } elsif ($file=~m{^/home/$match_username/public_html/}) {
7129: # is a correct contruction space reference
7130: $location = $file;
7131: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7132: my ($udom,$uname,$filename)=
7133: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_username)/+(.*)$-);
7134: my $home=&homeserver($uname,$udom);
7135: my $is_me=0;
7136: my @ids=¤t_machine_ids();
7137: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7138: if ($is_me) {
7139: $location=&propath($udom,$uname).
7140: '/userfiles/'.$filename;
7141: } else {
7142: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7143: $udom.'/'.$uname.'/'.$filename;
7144: }
7145: } else {
7146: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7147: $file=~s:^/res/:/:;
7148: if ( !( $file =~ m:^/:) ) {
7149: $location = $dir. '/'.$file;
7150: } else {
7151: $location = '/home/httpd/html/res'.$file;
7152: }
7153: }
7154: $location=~s://+:/:g; # remove duplicate /
7155: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7156: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7157: return $location;
7158: }
7159:
7160: sub hreflocation {
7161: my ($dir,$file)=@_;
7162: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7163: $file=filelocation($dir,$file);
7164: } elsif ($file=~m-^/adm/-) {
7165: $file=~s-^/adm/wrapper/-/-;
7166: $file=~s-^/adm/coursedocs/showdoc/-/-;
7167: }
7168: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7169: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7170: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7171: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
7172: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
7173: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_username)/userfiles/
7174: -/uploaded/$1/$2/-x;
7175: }
7176: return $file;
7177: }
7178:
7179: sub current_machine_domains {
7180: my $hostname=$hostname{$perlvar{'lonHostID'}};
7181: my @domains;
7182: while( my($id, $name) = each(%hostname)) {
7183: # &logthis("-$id-$name-$hostname-");
7184: if ($hostname eq $name) {
7185: push(@domains,$hostdom{$id});
7186: }
7187: }
7188: return @domains;
7189: }
7190:
7191: sub current_machine_ids {
7192: my $hostname=$hostname{$perlvar{'lonHostID'}};
7193: my @ids;
7194: while( my($id, $name) = each(%hostname)) {
7195: # &logthis("-$id-$name-$hostname-");
7196: if ($hostname eq $name) {
7197: push(@ids,$id);
7198: }
7199: }
7200: return @ids;
7201: }
7202:
7203: # ------------------------------------------------------------- Declutters URLs
7204:
7205: sub declutter {
7206: my $thisfn=shift;
7207: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7208: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7209: $thisfn=~s/^\///;
7210: $thisfn=~s|^adm/wrapper/||;
7211: $thisfn=~s|^adm/coursedocs/showdoc/||;
7212: $thisfn=~s/^res\///;
7213: $thisfn=~s/\?.+$//;
7214: return $thisfn;
7215: }
7216:
7217: # ------------------------------------------------------------- Clutter up URLs
7218:
7219: sub clutter {
7220: my $thisfn='/'.&declutter(shift);
7221: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
7222: $thisfn='/res'.$thisfn;
7223: }
7224: if ($thisfn !~m|/adm|) {
7225: if ($thisfn =~ m|/ext/|) {
7226: $thisfn='/adm/wrapper'.$thisfn;
7227: } else {
7228: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7229: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7230: if ($embstyle eq 'ssi'
7231: || ($embstyle eq 'hdn')
7232: || ($embstyle eq 'rat')
7233: || ($embstyle eq 'prv')
7234: || ($embstyle eq 'ign')) {
7235: #do nothing with these
7236: } elsif (($embstyle eq 'img')
7237: || ($embstyle eq 'emb')
7238: || ($embstyle eq 'wrp')) {
7239: $thisfn='/adm/wrapper'.$thisfn;
7240: } elsif ($embstyle eq 'unk'
7241: && $thisfn!~/\.(sequence|page)$/) {
7242: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7243: } else {
7244: # &logthis("Got a blank emb style");
7245: }
7246: }
7247: }
7248: return $thisfn;
7249: }
7250:
7251: sub clutter_with_no_wrapper {
7252: my $uri = &clutter(shift);
7253: if ($uri =~ m-^/adm/-) {
7254: $uri =~ s-^/adm/wrapper/-/-;
7255: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
7256: }
7257: return $uri;
7258: }
7259:
7260: sub freeze_escape {
7261: my ($value)=@_;
7262: if (ref($value)) {
7263: $value=&nfreeze($value);
7264: return '__FROZEN__'.&escape($value);
7265: }
7266: return &escape($value);
7267: }
7268:
7269:
7270: sub thaw_unescape {
7271: my ($value)=@_;
7272: if ($value =~ /^__FROZEN__/) {
7273: substr($value,0,10,undef);
7274: $value=&unescape($value);
7275: return &thaw($value);
7276: }
7277: return &unescape($value);
7278: }
7279:
7280: sub correct_line_ends {
7281: my ($result)=@_;
7282: $$result =~s/\r\n/\n/mg;
7283: $$result =~s/\r/\n/mg;
7284: }
7285: # ================================================================ Main Program
7286:
7287: sub goodbye {
7288: &logthis("Starting Shut down");
7289: #not converted to using infrastruture and probably shouldn't be
7290: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
7291: #converted
7292: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7293: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
7294: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
7295: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
7296: #1.1 only
7297: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
7298: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
7299: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
7300: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
7301: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
7302: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7303: &logthis(sprintf("%-20s is %s",'hits',$hits));
7304: &flushcourselogs();
7305: &logthis("Shutting down");
7306: }
7307:
7308: BEGIN {
7309: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
7310: unless ($readit) {
7311: {
7312: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
7313: %perlvar = (%perlvar,%{$configvars});
7314: }
7315:
7316: # ------------------------------------------------------------ Read domain file
7317: {
7318: %domaindescription = ();
7319: %domain_auth_def = ();
7320: %domain_auth_arg_def = ();
7321: my $fh;
7322: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
7323: while (my $line = <$fh>) {
7324: next if ($line =~ /^(\#|\s*$)/);
7325: # next if /^\#/;
7326: chomp $line;
7327: my ($domain, $domain_description, $def_auth, $def_auth_arg,
7328: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$line,9);
7329: $domain_auth_def{$domain}=$def_auth;
7330: $domain_auth_arg_def{$domain}=$def_auth_arg;
7331: $domaindescription{$domain}=$domain_description;
7332: $domain_lang_def{$domain}=$def_lang;
7333: $domain_city{$domain}=$city;
7334: $domain_longi{$domain}=$longi;
7335: $domain_lati{$domain}=$lati;
7336: $domain_primary{$domain}=$primary;
7337:
7338: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
7339: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
7340: }
7341: }
7342: close ($fh);
7343: }
7344:
7345:
7346: # ------------------------------------------------------------- Read hosts file
7347: {
7348: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7349:
7350: while (my $configline=<$config>) {
7351: next if ($configline =~ /^(\#|\s*$)/);
7352: chomp($configline);
7353: my ($id,$domain,$role,$name)=split(/:/,$configline);
7354: $name=~s/\s//g;
7355: if ($id && $domain && $role && $name) {
7356: $hostname{$id}=$name;
7357: $hostdom{$id}=$domain;
7358: if ($role eq 'library') { $libserv{$id}=$name; }
7359: }
7360: }
7361: close($config);
7362: # FIXME: dev server don't want this, production servers _do_ want this
7363: #&get_iphost();
7364: }
7365:
7366: sub get_iphost {
7367: if (%iphost) { return %iphost; }
7368: my %name_to_ip;
7369: foreach my $id (keys(%hostname)) {
7370: my $name=$hostname{$id};
7371: my $ip;
7372: if (!exists($name_to_ip{$name})) {
7373: $ip = gethostbyname($name);
7374: if (!$ip || length($ip) ne 4) {
7375: &logthis("Skipping host $id name $name no IP found\n");
7376: next;
7377: }
7378: $ip=inet_ntoa($ip);
7379: $name_to_ip{$name} = $ip;
7380: } else {
7381: $ip = $name_to_ip{$name};
7382: }
7383: push(@{$iphost{$ip}},$id);
7384: }
7385: return %iphost;
7386: }
7387:
7388: # ------------------------------------------------------ Read spare server file
7389: {
7390: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
7391:
7392: while (my $configline=<$config>) {
7393: chomp($configline);
7394: if ($configline) {
7395: my ($host,$type) = split(':',$configline,2);
7396: if (!defined($type) || $type eq '') { $type = 'default' };
7397: push(@{ $spareid{$type} }, $host);
7398: }
7399: }
7400: close($config);
7401: }
7402: # ------------------------------------------------------------ Read permissions
7403: {
7404: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
7405:
7406: while (my $configline=<$config>) {
7407: chomp($configline);
7408: if ($configline) {
7409: my ($role,$perm)=split(/ /,$configline);
7410: if ($perm ne '') { $pr{$role}=$perm; }
7411: }
7412: }
7413: close($config);
7414: }
7415:
7416: # -------------------------------------------- Read plain texts for permissions
7417: {
7418: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
7419:
7420: while (my $configline=<$config>) {
7421: chomp($configline);
7422: if ($configline) {
7423: my ($short,@plain)=split(/:/,$configline);
7424: %{$prp{$short}} = ();
7425: if (@plain > 0) {
7426: $prp{$short}{'std'} = $plain[0];
7427: for (my $i=1; $i<@plain; $i++) {
7428: $prp{$short}{'alt'.$i} = $plain[$i];
7429: }
7430: }
7431: }
7432: }
7433: close($config);
7434: }
7435:
7436: # ---------------------------------------------------------- Read package table
7437: {
7438: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
7439:
7440: while (my $configline=<$config>) {
7441: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
7442: chomp($configline);
7443: my ($short,$plain)=split(/:/,$configline);
7444: my ($pack,$name)=split(/\&/,$short);
7445: if ($plain ne '') {
7446: $packagetab{$pack.'&'.$name.'&name'}=$name;
7447: $packagetab{$short}=$plain;
7448: }
7449: }
7450: close($config);
7451: }
7452:
7453: # ------------- set up temporary directory
7454: {
7455: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7456:
7457: }
7458:
7459: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
7460: 'compress_threshold'=> 20_000,
7461: });
7462:
7463: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7464: $dumpcount=0;
7465:
7466: &logtouch();
7467: &logthis('<font color="yellow">INFO: Read configuration</font>');
7468: $readit=1;
7469: {
7470: use integer;
7471: my $test=(2**32)+1;
7472: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7473: &logthis(" Detected 64bit platform ($_64bit)");
7474: }
7475: }
7476: }
7477:
7478: 1;
7479: __END__
7480:
7481: =pod
7482:
7483: =head1 NAME
7484:
7485: Apache::lonnet - Subroutines to ask questions about things in the network.
7486:
7487: =head1 SYNOPSIS
7488:
7489: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7490:
7491: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7492:
7493: Common parameters:
7494:
7495: =over 4
7496:
7497: =item *
7498:
7499: $uname : an internal username (if $cname expecting a course Id specifically)
7500:
7501: =item *
7502:
7503: $udom : a domain (if $cdom expecting a course's domain specifically)
7504:
7505: =item *
7506:
7507: $symb : a resource instance identifier
7508:
7509: =item *
7510:
7511: $namespace : the name of a .db file that contains the data needed or
7512: being set.
7513:
7514: =back
7515:
7516: =head1 OVERVIEW
7517:
7518: lonnet provides subroutines which interact with the
7519: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7520: about classes, users, and resources.
7521:
7522: For many of these objects you can also use this to store data about
7523: them or modify them in various ways.
7524:
7525: =head2 Symbs
7526:
7527: To identify a specific instance of a resource, LON-CAPA uses symbols
7528: or "symbs"X<symb>. These identifiers are built from the URL of the
7529: map, the resource number of the resource in the map, and the URL of
7530: the resource itself. The latter is somewhat redundant, but might help
7531: if maps change.
7532:
7533: An example is
7534:
7535: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7536:
7537: The respective map entry is
7538:
7539: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7540: title="Problem 2">
7541: </resource>
7542:
7543: Symbs are used by the random number generator, as well as to store and
7544: restore data specific to a certain instance of for example a problem.
7545:
7546: =head2 Storing And Retrieving Data
7547:
7548: X<store()>X<cstore()>X<restore()>Three of the most important functions
7549: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7550: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7551: is is the non-critical message twin of cstore. These functions are for
7552: handlers to store a perl hash to a user's permanent data space in an
7553: easy manner, and to retrieve it again on another call. It is expected
7554: that a handler would use this once at the beginning to retrieve data,
7555: and then again once at the end to send only the new data back.
7556:
7557: The data is stored in the user's data directory on the user's
7558: homeserver under the ID of the course.
7559:
7560: The hash that is returned by restore will have all of the previous
7561: value for all of the elements of the hash.
7562:
7563: Example:
7564:
7565: #creating a hash
7566: my %hash;
7567: $hash{'foo'}='bar';
7568:
7569: #storing it
7570: &Apache::lonnet::cstore(\%hash);
7571:
7572: #changing a value
7573: $hash{'foo'}='notbar';
7574:
7575: #adding a new value
7576: $hash{'bar'}='foo';
7577: &Apache::lonnet::cstore(\%hash);
7578:
7579: #retrieving the hash
7580: my %history=&Apache::lonnet::restore();
7581:
7582: #print the hash
7583: foreach my $key (sort(keys(%history))) {
7584: print("\%history{$key} = $history{$key}");
7585: }
7586:
7587: Will print out:
7588:
7589: %history{1:foo} = bar
7590: %history{1:keys} = foo:timestamp
7591: %history{1:timestamp} = 990455579
7592: %history{2:bar} = foo
7593: %history{2:foo} = notbar
7594: %history{2:keys} = foo:bar:timestamp
7595: %history{2:timestamp} = 990455580
7596: %history{bar} = foo
7597: %history{foo} = notbar
7598: %history{timestamp} = 990455580
7599: %history{version} = 2
7600:
7601: Note that the special hash entries C<keys>, C<version> and
7602: C<timestamp> were added to the hash. C<version> will be equal to the
7603: total number of versions of the data that have been stored. The
7604: C<timestamp> attribute will be the UNIX time the hash was
7605: stored. C<keys> is available in every historical section to list which
7606: keys were added or changed at a specific historical revision of a
7607: hash.
7608:
7609: B<Warning>: do not store the hash that restore returns directly. This
7610: will cause a mess since it will restore the historical keys as if the
7611: were new keys. I.E. 1:foo will become 1:1:foo etc.
7612:
7613: Calling convention:
7614:
7615: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7616: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7617:
7618: For more detailed information, see lonnet specific documentation.
7619:
7620: =head1 RETURN MESSAGES
7621:
7622: =over 4
7623:
7624: =item * B<con_lost>: unable to contact remote host
7625:
7626: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7627: when the connection is brought back up
7628:
7629: =item * B<con_failed>: unable to contact remote host and unable to save message
7630: for later delivery
7631:
7632: =item * B<error:>: an error a occured, a description of the error follows the :
7633:
7634: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7635: that was requested
7636:
7637: =back
7638:
7639: =head1 PUBLIC SUBROUTINES
7640:
7641: =head2 Session Environment Functions
7642:
7643: =over 4
7644:
7645: =item *
7646: X<appenv()>
7647: B<appenv(%hash)>: the value of %hash is written to
7648: the user envirnoment file, and will be restored for each access this
7649: user makes during this session, also modifies the %env for the current
7650: process
7651:
7652: =item *
7653: X<delenv()>
7654: B<delenv($regexp)>: removes all items from the session
7655: environment file that matches the regular expression in $regexp. The
7656: values are also delted from the current processes %env.
7657:
7658: =item * get_env_multiple($name)
7659:
7660: gets $name from the %env hash, it seemlessly handles the cases where multiple
7661: values may be defined and end up as an array ref.
7662:
7663: returns an array of values
7664:
7665: =back
7666:
7667: =head2 User Information
7668:
7669: =over 4
7670:
7671: =item *
7672: X<queryauthenticate()>
7673: B<queryauthenticate($uname,$udom)>: try to determine user's current
7674: authentication scheme
7675:
7676: =item *
7677: X<authenticate()>
7678: B<authenticate($uname,$upass,$udom)>: try to
7679: authenticate user from domain's lib servers (first use the current
7680: one). C<$upass> should be the users password.
7681:
7682: =item *
7683: X<homeserver()>
7684: B<homeserver($uname,$udom)>: find the server which has
7685: the user's directory and files (there must be only one), this caches
7686: the answer, and also caches if there is a borken connection.
7687:
7688: =item *
7689: X<idget()>
7690: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7691: (IDs are a unique resource in a domain, there must be only 1 ID per
7692: username, and only 1 username per ID in a specific domain) (returns
7693: hash: id=>name,id=>name)
7694:
7695: =item *
7696: X<idrget()>
7697: B<idrget($udom,@unames)>: find the IDs behind a list of
7698: usernames (returns hash: name=>id,name=>id)
7699:
7700: =item *
7701: X<idput()>
7702: B<idput($udom,%ids)>: store away a list of names and associated IDs
7703:
7704: =item *
7705: X<rolesinit()>
7706: B<rolesinit($udom,$username,$authhost)>: get user privileges
7707:
7708: =item *
7709: X<getsection()>
7710: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7711: course $cname, return section name/number or '' for "not in course"
7712: and '-1' for "no section"
7713:
7714: =item *
7715: X<userenvironment()>
7716: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7717: passed in @what from the requested user's environment, returns a hash
7718:
7719: =back
7720:
7721: =head2 User Roles
7722:
7723: =over 4
7724:
7725: =item *
7726:
7727: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
7728: F: full access
7729: U,I,K: authentication modes (cxx only)
7730: '': forbidden
7731: 1: user needs to choose course
7732: 2: browse allowed
7733: A: passphrase authentication needed
7734:
7735: =item *
7736:
7737: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7738: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7739: and course level
7740:
7741: =item *
7742:
7743: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7744: explanation of a user role term
7745:
7746: =back
7747:
7748: =head2 User Modification
7749:
7750: =over 4
7751:
7752: =item *
7753:
7754: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7755: user for the level given by URL. Optional start and end dates (leave empty
7756: string or zero for "no date")
7757:
7758: =item *
7759:
7760: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7761: change a users, password, possible return values are: ok,
7762: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7763: refused
7764:
7765: =item *
7766:
7767: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7768:
7769: =item *
7770:
7771: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7772: modify user
7773:
7774: =item *
7775:
7776: modifystudent
7777:
7778: modify a students enrollment and identification information.
7779: The course id is resolved based on the current users environment.
7780: This means the envoking user must be a course coordinator or otherwise
7781: associated with a course.
7782:
7783: This call is essentially a wrapper for lonnet::modifyuser and
7784: lonnet::modify_student_enrollment
7785:
7786: Inputs:
7787:
7788: =over 4
7789:
7790: =item B<$udom> Students loncapa domain
7791:
7792: =item B<$uname> Students loncapa login name
7793:
7794: =item B<$uid> Students id/student number
7795:
7796: =item B<$umode> Students authentication mode
7797:
7798: =item B<$upass> Students password
7799:
7800: =item B<$first> Students first name
7801:
7802: =item B<$middle> Students middle name
7803:
7804: =item B<$last> Students last name
7805:
7806: =item B<$gene> Students generation
7807:
7808: =item B<$usec> Students section in course
7809:
7810: =item B<$end> Unix time of the roles expiration
7811:
7812: =item B<$start> Unix time of the roles start date
7813:
7814: =item B<$forceid> If defined, allow $uid to be changed
7815:
7816: =item B<$desiredhome> server to use as home server for student
7817:
7818: =back
7819:
7820: =item *
7821:
7822: modify_student_enrollment
7823:
7824: Change a students enrollment status in a class. The environment variable
7825: 'role.request.course' must be defined for this function to proceed.
7826:
7827: Inputs:
7828:
7829: =over 4
7830:
7831: =item $udom, students domain
7832:
7833: =item $uname, students name
7834:
7835: =item $uid, students user id
7836:
7837: =item $first, students first name
7838:
7839: =item $middle
7840:
7841: =item $last
7842:
7843: =item $gene
7844:
7845: =item $usec
7846:
7847: =item $end
7848:
7849: =item $start
7850:
7851: =back
7852:
7853:
7854: =item *
7855:
7856: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7857: custom role; give a custom role to a user for the level given by URL. Specify
7858: name and domain of role author, and role name
7859:
7860: =item *
7861:
7862: revokerole($udom,$uname,$url,$role) : revoke a role for url
7863:
7864: =item *
7865:
7866: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7867:
7868: =back
7869:
7870: =head2 Course Infomation
7871:
7872: =over 4
7873:
7874: =item *
7875:
7876: coursedescription($courseid) : returns a hash of information about the
7877: specified course id, including all environment settings for the
7878: course, the description of the course will be in the hash under the
7879: key 'description'
7880:
7881: =item *
7882:
7883: resdata($name,$domain,$type,@which) : request for current parameter
7884: setting for a specific $type, where $type is either 'course' or 'user',
7885: @what should be a list of parameters to ask about. This routine caches
7886: answers for 5 minutes.
7887:
7888: =back
7889:
7890: =head2 Course Modification
7891:
7892: =over 4
7893:
7894: =item *
7895:
7896: writecoursepref($courseid,%prefs) : write preferences (environment
7897: database) for a course
7898:
7899: =item *
7900:
7901: createcourse($udom,$description,$url) : make/modify course
7902:
7903: =back
7904:
7905: =head2 Resource Subroutines
7906:
7907: =over 4
7908:
7909: =item *
7910:
7911: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7912:
7913: =item *
7914:
7915: repcopy($filename) : subscribes to the requested file, and attempts to
7916: replicate from the owning library server, Might return
7917: 'unavailable', 'not_found', 'forbidden', 'ok', or
7918: 'bad_request', also attempts to grab the metadata for the
7919: resource. Expects the local filesystem pathname
7920: (/home/httpd/html/res/....)
7921:
7922: =back
7923:
7924: =head2 Resource Information
7925:
7926: =over 4
7927:
7928: =item *
7929:
7930: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7931: a vairety of different possible values, $varname should be a request
7932: string, and the other parameters can be used to specify who and what
7933: one is asking about.
7934:
7935: Possible values for $varname are environment.lastname (or other item
7936: from the envirnment hash), user.name (or someother aspect about the
7937: user), resource.0.maxtries (or some other part and parameter of a
7938: resource)
7939:
7940: =item *
7941:
7942: directcondval($number) : get current value of a condition; reads from a state
7943: string
7944:
7945: =item *
7946:
7947: condval($condidx) : value of condition index based on state
7948:
7949: =item *
7950:
7951: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7952: resource's metadata, $what should be either a specific key, or either
7953: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7954: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7955:
7956: this function automatically caches all requests
7957:
7958: =item *
7959:
7960: metadata_query($query,$custom,$customshow) : make a metadata query against the
7961: network of library servers; returns file handle of where SQL and regex results
7962: will be stored for query
7963:
7964: =item *
7965:
7966: symbread($filename) : return symbolic list entry (filename argument optional);
7967: returns the data handle
7968:
7969: =item *
7970:
7971: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7972: a possible symb for the URL in $thisfn, and if is an encryypted
7973: resource that the user accessed using /enc/ returns a 1 on success, 0
7974: on failure, user must be in a course, as it assumes the existance of
7975: the course initial hash, and uses $env('request.course.id'}
7976:
7977:
7978: =item *
7979:
7980: symbclean($symb) : removes versions numbers from a symb, returns the
7981: cleaned symb
7982:
7983: =item *
7984:
7985: is_on_map($uri) : checks if the $uri is somewhere on the current
7986: course map, user must be in a course for it to work.
7987:
7988: =item *
7989:
7990: numval($salt) : return random seed value (addend for rndseed)
7991:
7992: =item *
7993:
7994: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7995: a random seed, all arguments are optional, if they aren't sent it uses the
7996: environment to derive them. Note: if symb isn't sent and it can't get one
7997: from &symbread it will use the current time as its return value
7998:
7999: =item *
8000:
8001: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
8002: unfakeable, receipt
8003:
8004: =item *
8005:
8006: receipt() : API to ireceipt working off of env values; given out to users
8007:
8008: =item *
8009:
8010: countacc($url) : count the number of accesses to a given URL
8011:
8012: =item *
8013:
8014: 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
8015:
8016: =item *
8017:
8018: 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)
8019:
8020: =item *
8021:
8022: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
8023:
8024: =item *
8025:
8026: devalidate($symb) : devalidate temporary spreadsheet calculations,
8027: forcing spreadsheet to reevaluate the resource scores next time.
8028:
8029: =back
8030:
8031: =head2 Storing/Retreiving Data
8032:
8033: =over 4
8034:
8035: =item *
8036:
8037: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
8038: for this url; hashref needs to be given and should be a \%hashname; the
8039: remaining args aren't required and if they aren't passed or are '' they will
8040: be derived from the env
8041:
8042: =item *
8043:
8044: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
8045: uses critical subroutine
8046:
8047: =item *
8048:
8049: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
8050: all args are optional
8051:
8052: =item *
8053:
8054: dumpstore($namespace,$udom,$uname,$regexp,$range) :
8055: dumps the complete (or key matching regexp) namespace into a hash
8056: ($udom, $uname, $regexp, $range are optional) for a namespace that is
8057: normally &store()ed into
8058:
8059: $range should be either an integer '100' (give me the first 100
8060: matching records)
8061: or be two integers sperated by a - with no spaces
8062: '30-50' (give me the 30th through the 50th matching
8063: records)
8064:
8065:
8066: =item *
8067:
8068: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
8069: replaces a &store() version of data with a replacement set of data
8070: for a particular resource in a namespace passed in the $storehash hash
8071: reference
8072:
8073: =item *
8074:
8075: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
8076: works very similar to store/cstore, but all data is stored in a
8077: temporary location and can be reset using tmpreset, $storehash should
8078: be a hash reference, returns nothing on success
8079:
8080: =item *
8081:
8082: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
8083: similar to restore, but all data is stored in a temporary location and
8084: can be reset using tmpreset. Returns a hash of values on success,
8085: error string otherwise.
8086:
8087: =item *
8088:
8089: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
8090: deltes all keys for $symb form the temporary storage hash.
8091:
8092: =item *
8093:
8094: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8095: reference filled in from namesp ($udom and $uname are optional)
8096:
8097: =item *
8098:
8099: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
8100: namesp ($udom and $uname are optional)
8101:
8102: =item *
8103:
8104: dump($namespace,$udom,$uname,$regexp,$range) :
8105: dumps the complete (or key matching regexp) namespace into a hash
8106: ($udom, $uname, $regexp, $range are optional)
8107:
8108: $range should be either an integer '100' (give me the first 100
8109: matching records)
8110: or be two integers sperated by a - with no spaces
8111: '30-50' (give me the 30th through the 50th matching
8112: records)
8113: =item *
8114:
8115: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
8116: $store can be a scalar, an array reference, or if the amount to be
8117: incremented is > 1, a hash reference.
8118:
8119: ($udom and $uname are optional)
8120:
8121: =item *
8122:
8123: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
8124: ($udom and $uname are optional)
8125:
8126: =item *
8127:
8128: cput($namespace,$storehash,$udom,$uname) : critical put
8129: ($udom and $uname are optional)
8130:
8131: =item *
8132:
8133: newput($namespace,$storehash,$udom,$uname) :
8134:
8135: Attempts to store the items in the $storehash, but only if they don't
8136: currently exist, if this succeeds you can be certain that you have
8137: successfully created a new key value pair in the $namespace db.
8138:
8139:
8140: Args:
8141: $namespace: name of database to store values to
8142: $storehash: hashref to store to the db
8143: $udom: (optional) domain of user containing the db
8144: $uname: (optional) name of user caontaining the db
8145:
8146: Returns:
8147: 'ok' -> succeeded in storing all keys of $storehash
8148: 'key_exists: <key>' -> failed to anything out of $storehash, as at
8149: least <key> already existed in the db (other
8150: requested keys may also already exist)
8151: 'error: <msg>' -> unable to tie the DB or other erorr occured
8152: 'con_lost' -> unable to contact request server
8153: 'refused' -> action was not allowed by remote machine
8154:
8155:
8156: =item *
8157:
8158: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8159: reference filled in from namesp (encrypts the return communication)
8160: ($udom and $uname are optional)
8161:
8162: =item *
8163:
8164: log($udom,$name,$home,$message) : write to permanent log for user; use
8165: critical subroutine
8166:
8167: =item *
8168:
8169: get_dom($namespace,$storearr,$udomain) : returns hash with keys from array
8170: reference filled in from namespace found in domain level on primary domain server ($udomain is optional)
8171:
8172: =item *
8173:
8174: put_dom($namespace,$storehash,$udomain) : stores hash in namespace at domain level on primary domain server ($udomain is optional)
8175:
8176: =back
8177:
8178: =head2 Network Status Functions
8179:
8180: =over 4
8181:
8182: =item *
8183:
8184: dirlist($uri) : return directory list based on URI
8185:
8186: =item *
8187:
8188: spareserver() : find server with least workload from spare.tab
8189:
8190: =back
8191:
8192: =head2 Apache Request
8193:
8194: =over 4
8195:
8196: =item *
8197:
8198: ssi($url,%hash) : server side include, does a complete request cycle on url to
8199: localhost, posts hash
8200:
8201: =back
8202:
8203: =head2 Data to String to Data
8204:
8205: =over 4
8206:
8207: =item *
8208:
8209: hash2str(%hash) : convert a hash into a string complete with escaping and '='
8210: and '&' separators, supports elements that are arrayrefs and hashrefs
8211:
8212: =item *
8213:
8214: hashref2str($hashref) : convert a hashref into a string complete with
8215: escaping and '=' and '&' separators, supports elements that are
8216: arrayrefs and hashrefs
8217:
8218: =item *
8219:
8220: arrayref2str($arrayref) : convert an arrayref into a string complete
8221: with escaping and '&' separators, supports elements that are arrayrefs
8222: and hashrefs
8223:
8224: =item *
8225:
8226: str2hash($string) : convert string to hash using unescaping and
8227: splitting on '=' and '&', supports elements that are arrayrefs and
8228: hashrefs
8229:
8230: =item *
8231:
8232: str2array($string) : convert string to hash using unescaping and
8233: splitting on '&', supports elements that are arrayrefs and hashrefs
8234:
8235: =back
8236:
8237: =head2 Logging Routines
8238:
8239: =over 4
8240:
8241: These routines allow one to make log messages in the lonnet.log and
8242: lonnet.perm logfiles.
8243:
8244: =item *
8245:
8246: logtouch() : make sure the logfile, lonnet.log, exists
8247:
8248: =item *
8249:
8250: logthis() : append message to the normal lonnet.log file, it gets
8251: preiodically rolled over and deleted.
8252:
8253: =item *
8254:
8255: logperm() : append a permanent message to lonnet.perm.log, this log
8256: file never gets deleted by any automated portion of the system, only
8257: messages of critical importance should go in here.
8258:
8259: =back
8260:
8261: =head2 General File Helper Routines
8262:
8263: =over 4
8264:
8265: =item *
8266:
8267: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
8268: (a) files in /uploaded
8269: (i) If a local copy of the file exists -
8270: compares modification date of local copy with last-modified date for
8271: definitive version stored on home server for course. If local copy is
8272: stale, requests a new version from the home server and stores it.
8273: If the original has been removed from the home server, then local copy
8274: is unlinked.
8275: (ii) If local copy does not exist -
8276: requests the file from the home server and stores it.
8277:
8278: If $caller is 'uploadrep':
8279: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
8280: for request for files originally uploaded via DOCS.
8281: - returns 'ok' if fresh local copy now available, -1 otherwise.
8282:
8283: Otherwise:
8284: This indicates a call from the content generation phase of the request.
8285: - returns the entire contents of the file or -1.
8286:
8287: (b) files in /res
8288: - returns the entire contents of a file or -1;
8289: it properly subscribes to and replicates the file if neccessary.
8290:
8291:
8292: =item *
8293:
8294: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
8295: reference
8296:
8297: returns either a stat() list of data about the file or an empty list
8298: if the file doesn't exist or couldn't find out about it (connection
8299: problems or user unknown)
8300:
8301: =item *
8302:
8303: filelocation($dir,$file) : returns file system location of a file
8304: based on URI; meant to be "fairly clean" absolute reference, $dir is a
8305: directory that relative $file lookups are to looked in ($dir of /a/dir
8306: and a file of ../bob will become /a/bob)
8307:
8308: =item *
8309:
8310: hreflocation($dir,$file) : returns file system location or a URL; same as
8311: filelocation except for hrefs
8312:
8313: =item *
8314:
8315: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
8316:
8317: =back
8318:
8319: =head2 Usererfile file routines (/uploaded*)
8320:
8321: =over 4
8322:
8323: =item *
8324:
8325: userfileupload(): main rotine for putting a file in a user or course's
8326: filespace, arguments are,
8327:
8328: formname - required - this is the name of the element in $env where the
8329: filename, and the contents of the file to create/modifed exist
8330: the filename is in $env{'form.'.$formname.'.filename'} and the
8331: contents of the file is located in $env{'form.'.$formname}
8332: coursedoc - if true, store the file in the course of the active role
8333: of the current user
8334: subdir - required - subdirectory to put the file in under ../userfiles/
8335: if undefined, it will be placed in "unknown"
8336:
8337: (This routine calls clean_filename() to remove any dangerous
8338: characters from the filename, and then calls finuserfileupload() to
8339: complete the transaction)
8340:
8341: returns either the url of the uploaded file (/uploaded/....) if successful
8342: and /adm/notfound.html if unsuccessful
8343:
8344: =item *
8345:
8346: clean_filename(): routine for cleaing a filename up for storage in
8347: userfile space, argument is:
8348:
8349: filename - proposed filename
8350:
8351: returns: the new clean filename
8352:
8353: =item *
8354:
8355: finishuserfileupload(): routine that creaes and sends the file to
8356: userspace, probably shouldn't be called directly
8357:
8358: docuname: username or courseid of destination for the file
8359: docudom: domain of user/course of destination for the file
8360: formname: same as for userfileupload()
8361: fname: filename (inculding subdirectories) for the file
8362:
8363: returns either the url of the uploaded file (/uploaded/....) if successful
8364: and /adm/notfound.html if unsuccessful
8365:
8366: =item *
8367:
8368: renameuserfile(): renames an existing userfile to a new name
8369:
8370: Args:
8371: docuname: username or courseid of destination for the file
8372: docudom: domain of user/course of destination for the file
8373: old: current file name (including any subdirs under userfiles)
8374: new: desired file name (including any subdirs under userfiles)
8375:
8376: =item *
8377:
8378: mkdiruserfile(): creates a directory is a userfiles dir
8379:
8380: Args:
8381: docuname: username or courseid of destination for the file
8382: docudom: domain of user/course of destination for the file
8383: dir: dir to create (including any subdirs under userfiles)
8384:
8385: =item *
8386:
8387: removeuserfile(): removes a file that exists in userfiles
8388:
8389: Args:
8390: docuname: username or courseid of destination for the file
8391: docudom: domain of user/course of destination for the file
8392: fname: filname to delete (including any subdirs under userfiles)
8393:
8394: =item *
8395:
8396: removeuploadedurl(): convience function for removeuserfile()
8397:
8398: Args:
8399: url: a full /uploaded/... url to delete
8400:
8401: =item *
8402:
8403: get_portfile_permissions():
8404: Args:
8405: domain: domain of user or course contain the portfolio files
8406: user: name of user or num of course contain the portfolio files
8407: Returns:
8408: hashref of a dump of the proper file_permissions.db
8409:
8410:
8411: =item *
8412:
8413: get_access_controls():
8414:
8415: Args:
8416: current_permissions: the hash ref returned from get_portfile_permissions()
8417: group: (optional) the group you want the files associated with
8418: file: (optional) the file you want access info on
8419:
8420: Returns:
8421: a hash (keys are file names) of hashes containing
8422: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8423: values are XML containing access control settings (see below)
8424:
8425: Internal notes:
8426:
8427: access controls are stored in file_permissions.db as key=value pairs.
8428: key -> path to file/file_name\0uniqueID:scope_end_start
8429: where scope -> public,guest,course,group,domains or users.
8430: end -> UNIX time for end of access (0 -> no end date)
8431: start -> UNIX time for start of access
8432:
8433: value -> XML description of access control
8434: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8435: <start></start>
8436: <end></end>
8437:
8438: <password></password> for scope type = guest
8439:
8440: <domain></domain> for scope type = course or group
8441: <number></number>
8442: <roles id="">
8443: <role></role>
8444: <access></access>
8445: <section></section>
8446: <group></group>
8447: </roles>
8448:
8449: <dom></dom> for scope type = domains
8450:
8451: <users> for scope type = users
8452: <user>
8453: <uname></uname>
8454: <udom></udom>
8455: </user>
8456: </users>
8457: </scope>
8458:
8459: Access data is also aggregated for each file in an additional key=value pair:
8460: key -> path to file/file_name\0accesscontrol
8461: value -> reference to hash
8462: hash contains key = value pairs
8463: where key = uniqueID:scope_end_start
8464: value = UNIX time record was last updated
8465:
8466: Used to improve speed of look-ups of access controls for each file.
8467:
8468: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8469:
8470: modify_access_controls():
8471:
8472: Modifies access controls for a portfolio file
8473: Args
8474: 1. file name
8475: 2. reference to hash of required changes,
8476: 3. domain
8477: 4. username
8478: where domain,username are the domain of the portfolio owner
8479: (either a user or a course)
8480:
8481: Returns:
8482: 1. result of additions or updates ('ok' or 'error', with error message).
8483: 2. result of deletions ('ok' or 'error', with error message).
8484: 3. reference to hash of any new or updated access controls.
8485: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8486: key = integer (inbound ID)
8487: value = uniqueID
8488:
8489: =back
8490:
8491: =head2 HTTP Helper Routines
8492:
8493: =over 4
8494:
8495: =item *
8496:
8497: escape() : unpack non-word characters into CGI-compatible hex codes
8498:
8499: =item *
8500:
8501: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8502:
8503: =back
8504:
8505: =head1 PRIVATE SUBROUTINES
8506:
8507: =head2 Underlying communication routines (Shouldn't call)
8508:
8509: =over 4
8510:
8511: =item *
8512:
8513: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8514:
8515: =item *
8516:
8517: reply() : uses subreply to send a message to remote machine, logs all failures
8518:
8519: =item *
8520:
8521: critical() : passes a critical message to another server; if cannot
8522: get through then place message in connection buffer directory and
8523: returns con_delayed, if incapable of saving message, returns
8524: con_failed
8525:
8526: =item *
8527:
8528: reconlonc() : tries to reconnect lonc client processes.
8529:
8530: =back
8531:
8532: =head2 Resource Access Logging
8533:
8534: =over 4
8535:
8536: =item *
8537:
8538: flushcourselogs() : flush (save) buffer logs and access logs
8539:
8540: =item *
8541:
8542: courselog($what) : save message for course in hash
8543:
8544: =item *
8545:
8546: courseacclog($what) : save message for course using &courselog(). Perform
8547: special processing for specific resource types (problems, exams, quizzes, etc).
8548:
8549: =item *
8550:
8551: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8552: as a PerlChildExitHandler
8553:
8554: =back
8555:
8556: =head2 Other
8557:
8558: =over 4
8559:
8560: =item *
8561:
8562: symblist($mapname,%newhash) : update symbolic storage links
8563:
8564: =back
8565:
8566: =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