File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.996:
download - view:
text,
annotated -
select for diffs
Wed May 6 12:13:26 2009 UTC (15 years, 2 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Bug 5946
- Course roles and section counts cached for 10 minutes
(used for inline roles selector for CC)
- Cache expired when a role change occurs for a non-student role or a sectioned-role.
- Code which gathers information about all roles and all sections moved to:
&get_all_courseroles
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.996 2009/05/06 12:13:26 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: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol);
80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
84: %courseownerbuf, %coursetypebuf,$locknum);
85:
86: use IO::Socket;
87: use GDBM_File;
88: use HTML::LCParser;
89: use Fcntl qw(:flock);
90: use Storable qw(thaw nfreeze);
91: use Time::HiRes qw( gettimeofday tv_interval );
92: use Cache::Memcached;
93: use Digest::MD5;
94: use Math::Random;
95: use LONCAPA qw(:DEFAULT :match);
96: use LONCAPA::Configuration;
97:
98: my $readit;
99: my $max_connection_retries = 10; # Or some such value.
100:
101: my $upload_photo_form = 0; #Variable to check when user upload a photo 0=not 1=true
102:
103: require Exporter;
104:
105: our @ISA = qw (Exporter);
106: our @EXPORT = qw(%env);
107:
108:
109: # --------------------------------------------------------------------- Logging
110: {
111: my $logid;
112: sub instructor_log {
113: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
114: if (($cnum eq '') || ($cdom eq '')) {
115: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
116: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
117: }
118: $logid++;
119: my $now = time();
120: my $id=$now.'00000'.$$.'00000'.$logid;
121: return &Apache::lonnet::put('nohist_'.$hash_name,
122: { $id => {
123: 'exe_uname' => $env{'user.name'},
124: 'exe_udom' => $env{'user.domain'},
125: 'exe_time' => $now,
126: 'exe_ip' => $ENV{'REMOTE_ADDR'},
127: 'delflag' => $delflag,
128: 'logentry' => $storehash,
129: 'uname' => $uname,
130: 'udom' => $udom,
131: }
132: },$cdom,$cnum);
133: }
134: }
135:
136: sub logtouch {
137: my $execdir=$perlvar{'lonDaemons'};
138: unless (-e "$execdir/logs/lonnet.log") {
139: open(my $fh,">>$execdir/logs/lonnet.log");
140: close $fh;
141: }
142: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
143: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
144: }
145:
146: sub logthis {
147: my $message=shift;
148: my $execdir=$perlvar{'lonDaemons'};
149: my $now=time;
150: my $local=localtime($now);
151: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
152: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
153: print $fh $logstring;
154: close($fh);
155: }
156: return 1;
157: }
158:
159: sub logperm {
160: my $message=shift;
161: my $execdir=$perlvar{'lonDaemons'};
162: my $now=time;
163: my $local=localtime($now);
164: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
165: print $fh "$now:$message:$local\n";
166: close($fh);
167: }
168: return 1;
169: }
170:
171: sub create_connection {
172: my ($hostname,$lonid) = @_;
173: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
174: Type => SOCK_STREAM,
175: Timeout => 10);
176: return 0 if (!$client);
177: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
178: my $result = <$client>;
179: chomp($result);
180: return 1 if ($result eq 'done');
181: return 0;
182: }
183:
184: sub get_server_timezone {
185: my ($cnum,$cdom) = @_;
186: my $home=&homeserver($cnum,$cdom);
187: if ($home ne 'no_host') {
188: my $cachetime = 24*3600;
189: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
190: if (defined($cached)) {
191: return $timezone;
192: } else {
193: my $timezone = &reply('servertimezone',$home);
194: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
195: }
196: }
197: }
198:
199: sub get_server_loncaparev {
200: my ($dom,$lonhost) = @_;
201: if (defined($lonhost)) {
202: if (!defined(&hostname($lonhost))) {
203: undef($lonhost);
204: }
205: }
206: if (!defined($lonhost)) {
207: if (defined(&domain($dom,'primary'))) {
208: $lonhost=&domain($dom,'primary');
209: if ($lonhost eq 'no_host') {
210: undef($lonhost);
211: }
212: }
213: }
214: if (defined($lonhost)) {
215: my $cachetime = 24*3600;
216: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
217: if (defined($cached)) {
218: return $loncaparev;
219: } else {
220: my $loncaparev = &reply('serverloncaparev',$lonhost);
221: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
222: }
223: }
224: }
225:
226: # -------------------------------------------------- Non-critical communication
227: sub subreply {
228: my ($cmd,$server)=@_;
229: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
230: #
231: # With loncnew process trimming, there's a timing hole between lonc server
232: # process exit and the master server picking up the listen on the AF_UNIX
233: # socket. In that time interval, a lock file will exist:
234:
235: my $lockfile=$peerfile.".lock";
236: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
237: sleep(1);
238: }
239: # At this point, either a loncnew parent is listening or an old lonc
240: # or loncnew child is listening so we can connect or everything's dead.
241: #
242: # We'll give the connection a few tries before abandoning it. If
243: # connection is not possible, we'll con_lost back to the client.
244: #
245: my $client;
246: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
247: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
248: Type => SOCK_STREAM,
249: Timeout => 10);
250: if ($client) {
251: last; # Connected!
252: } else {
253: &create_connection(&hostname($server),$server);
254: }
255: sleep(1); # Try again later if failed connection.
256: }
257: my $answer;
258: if ($client) {
259: print $client "sethost:$server:$cmd\n";
260: $answer=<$client>;
261: if (!$answer) { $answer="con_lost"; }
262: chomp($answer);
263: } else {
264: $answer = 'con_lost'; # Failed connection.
265: }
266: return $answer;
267: }
268:
269: sub reply {
270: my ($cmd,$server)=@_;
271: unless (defined(&hostname($server))) { return 'no_such_host'; }
272: my $answer=subreply($cmd,$server);
273: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
274: &logthis("<font color=\"blue\">WARNING:".
275: " $cmd to $server returned $answer</font>");
276: }
277: return $answer;
278: }
279:
280: # ----------------------------------------------------------- Send USR1 to lonc
281:
282: sub reconlonc {
283: my ($lonid) = @_;
284: my $hostname = &hostname($lonid);
285: if ($lonid) {
286: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
287: if ($hostname && -e $peerfile) {
288: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
289: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
290: Type => SOCK_STREAM,
291: Timeout => 10);
292: if ($client) {
293: print $client ("reset_retries\n");
294: my $answer=<$client>;
295: #reset just this one.
296: }
297: }
298: return;
299: }
300:
301: &logthis("Trying to reconnect lonc");
302: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
303: if (open(my $fh,"<$loncfile")) {
304: my $loncpid=<$fh>;
305: chomp($loncpid);
306: if (kill 0 => $loncpid) {
307: &logthis("lonc at pid $loncpid responding, sending USR1");
308: kill USR1 => $loncpid;
309: sleep 1;
310: } else {
311: &logthis(
312: "<font color=\"blue\">WARNING:".
313: " lonc at pid $loncpid not responding, giving up</font>");
314: }
315: } else {
316: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
317: }
318: }
319:
320: # ------------------------------------------------------ Critical communication
321:
322: sub critical {
323: my ($cmd,$server)=@_;
324: unless (&hostname($server)) {
325: &logthis("<font color=\"blue\">WARNING:".
326: " Critical message to unknown server ($server)</font>");
327: return 'no_such_host';
328: }
329: my $answer=reply($cmd,$server);
330: if ($answer eq 'con_lost') {
331: &reconlonc("$perlvar{'lonSockDir'}/$server");
332: my $answer=reply($cmd,$server);
333: if ($answer eq 'con_lost') {
334: my $now=time;
335: my $middlename=$cmd;
336: $middlename=substr($middlename,0,16);
337: $middlename=~s/\W//g;
338: my $dfilename=
339: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
340: $dumpcount++;
341: {
342: my $dfh;
343: if (open($dfh,">$dfilename")) {
344: print $dfh "$cmd\n";
345: close($dfh);
346: }
347: }
348: sleep 2;
349: my $wcmd='';
350: {
351: my $dfh;
352: if (open($dfh,"<$dfilename")) {
353: $wcmd=<$dfh>;
354: close($dfh);
355: }
356: }
357: chomp($wcmd);
358: if ($wcmd eq $cmd) {
359: &logthis("<font color=\"blue\">WARNING: ".
360: "Connection buffer $dfilename: $cmd</font>");
361: &logperm("D:$server:$cmd");
362: return 'con_delayed';
363: } else {
364: &logthis("<font color=\"red\">CRITICAL:"
365: ." Critical connection failed: $server $cmd</font>");
366: &logperm("F:$server:$cmd");
367: return 'con_failed';
368: }
369: }
370: }
371: return $answer;
372: }
373:
374: # ------------------------------------------- check if return value is an error
375:
376: sub error {
377: my ($result) = @_;
378: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
379: if ($2 == 2) { return undef; }
380: return $1;
381: }
382: return undef;
383: }
384:
385: sub convert_and_load_session_env {
386: my ($lonidsdir,$handle)=@_;
387: my @profile;
388: {
389: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
390: if (!$opened) {
391: return 0;
392: }
393: flock($idf,LOCK_SH);
394: @profile=<$idf>;
395: close($idf);
396: }
397: my %temp_env;
398: foreach my $line (@profile) {
399: if ($line !~ m/=/) {
400: return 0;
401: }
402: chomp($line);
403: my ($envname,$envvalue)=split(/=/,$line,2);
404: $temp_env{&unescape($envname)} = &unescape($envvalue);
405: }
406: unlink("$lonidsdir/$handle.id");
407: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
408: 0640)) {
409: %disk_env = %temp_env;
410: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
411: untie(%disk_env);
412: }
413: return 1;
414: }
415:
416: # ------------------------------------------- Transfer profile into environment
417: my $env_loaded;
418: sub transfer_profile_to_env {
419: my ($lonidsdir,$handle,$force_transfer) = @_;
420: if (!$force_transfer && $env_loaded) { return; }
421:
422: if (!defined($lonidsdir)) {
423: $lonidsdir = $perlvar{'lonIDsDir'};
424: }
425: if (!defined($handle)) {
426: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
427: }
428:
429: my $convert;
430: {
431: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
432: if (!$opened) {
433: return;
434: }
435: flock($idf,LOCK_SH);
436: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
437: &GDBM_READER(),0640)) {
438: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
439: untie(%disk_env);
440: } else {
441: $convert = 1;
442: }
443: }
444: if ($convert) {
445: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
446: &logthis("Failed to load session, or convert session.");
447: }
448: }
449:
450: my %remove;
451: while ( my $envname = each(%env) ) {
452: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
453: if ($time < time-300) {
454: $remove{$key}++;
455: }
456: }
457: }
458:
459: $env{'user.environment'} = "$lonidsdir/$handle.id";
460: $env_loaded=1;
461: foreach my $expired_key (keys(%remove)) {
462: &delenv($expired_key);
463: }
464: }
465:
466: # ---------------------------------------------------- Check for valid session
467: sub check_for_valid_session {
468: my ($r) = @_;
469: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
470: my $lonid=$cookies{'lonID'};
471: return undef if (!$lonid);
472:
473: my $handle=&LONCAPA::clean_handle($lonid->value);
474: my $lonidsdir=$r->dir_config('lonIDsDir');
475: return undef if (!-e "$lonidsdir/$handle.id");
476:
477: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
478: return undef if (!$opened);
479:
480: flock($idf,LOCK_SH);
481: my %disk_env;
482: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
483: &GDBM_READER(),0640)) {
484: return undef;
485: }
486:
487: if (!defined($disk_env{'user.name'})
488: || !defined($disk_env{'user.domain'})) {
489: return undef;
490: }
491: return $handle;
492: }
493:
494: sub timed_flock {
495: my ($file,$lock_type) = @_;
496: my $failed=0;
497: eval {
498: local $SIG{__DIE__}='DEFAULT';
499: local $SIG{ALRM}=sub {
500: $failed=1;
501: die("failed lock");
502: };
503: alarm(13);
504: flock($file,$lock_type);
505: alarm(0);
506: };
507: if ($failed) {
508: return undef;
509: } else {
510: return 1;
511: }
512: }
513:
514: # ---------------------------------------------------------- Append Environment
515:
516: sub appenv {
517: my ($newenv,$roles) = @_;
518: if (ref($newenv) eq 'HASH') {
519: foreach my $key (keys(%{$newenv})) {
520: my $refused = 0;
521: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
522: $refused = 1;
523: if (ref($roles) eq 'ARRAY') {
524: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
525: if (grep(/^\Q$role\E$/,@{$roles})) {
526: $refused = 0;
527: }
528: }
529: }
530: if ($refused) {
531: &logthis("<font color=\"blue\">WARNING: ".
532: "Attempt to modify environment ".$key." to ".$newenv->{$key}
533: .'</font>');
534: delete($newenv->{$key});
535: } else {
536: $env{$key}=$newenv->{$key};
537: }
538: }
539: my $opened = open(my $env_file,'+<',$env{'user.environment'});
540: if ($opened
541: && &timed_flock($env_file,LOCK_EX)
542: &&
543: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
544: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
545: while (my ($key,$value) = each(%{$newenv})) {
546: $disk_env{$key} = $value;
547: }
548: untie(%disk_env);
549: }
550: }
551: return 'ok';
552: }
553: # ----------------------------------------------------- Delete from Environment
554:
555: sub delenv {
556: my ($delthis,$regexp) = @_;
557: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
558: &logthis("<font color=\"blue\">WARNING: ".
559: "Attempt to delete from environment ".$delthis);
560: return 'error';
561: }
562: my $opened = open(my $env_file,'+<',$env{'user.environment'});
563: if ($opened
564: && &timed_flock($env_file,LOCK_EX)
565: &&
566: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
567: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
568: foreach my $key (keys(%disk_env)) {
569: if ($regexp) {
570: if ($key=~/^$delthis/) {
571: delete($env{$key});
572: delete($disk_env{$key});
573: }
574: } else {
575: if ($key=~/^\Q$delthis\E/) {
576: delete($env{$key});
577: delete($disk_env{$key});
578: }
579: }
580: }
581: untie(%disk_env);
582: }
583: return 'ok';
584: }
585:
586: sub get_env_multiple {
587: my ($name) = @_;
588: my @values;
589: if (defined($env{$name})) {
590: # exists is it an array
591: if (ref($env{$name})) {
592: @values=@{ $env{$name} };
593: } else {
594: $values[0]=$env{$name};
595: }
596: }
597: return(@values);
598: }
599:
600: # ------------------------------------------------------------------- Locking
601:
602: sub set_lock {
603: my ($text)=@_;
604: $locknum++;
605: my $id=$$.'-'.$locknum;
606: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
607: 'session.lock.'.$id => $text});
608: return $id;
609: }
610:
611: sub get_locks {
612: my $num=0;
613: my %texts=();
614: foreach my $lock (split(/\,/,$env{'session.locks'})) {
615: if ($lock=~/\w/) {
616: $num++;
617: $texts{$lock}=$env{'session.lock.'.$lock};
618: }
619: }
620: return ($num,%texts);
621: }
622:
623: sub remove_lock {
624: my ($id)=@_;
625: my $newlocks='';
626: foreach my $lock (split(/\,/,$env{'session.locks'})) {
627: if (($lock=~/\w/) && ($lock ne $id)) {
628: $newlocks.=','.$lock;
629: }
630: }
631: &appenv({'session.locks' => $newlocks});
632: &delenv('session.lock.'.$id);
633: }
634:
635: sub remove_all_locks {
636: my $activelocks=$env{'session.locks'};
637: foreach my $lock (split(/\,/,$env{'session.locks'})) {
638: if ($lock=~/\w/) {
639: &remove_lock($lock);
640: }
641: }
642: }
643:
644:
645: # ------------------------------------------ Find out current server userload
646: sub userload {
647: my $numusers=0;
648: {
649: opendir(LONIDS,$perlvar{'lonIDsDir'});
650: my $filename;
651: my $curtime=time;
652: while ($filename=readdir(LONIDS)) {
653: next if ($filename eq '.' || $filename eq '..');
654: next if ($filename =~ /publicuser_\d+\.id/);
655: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
656: if ($curtime-$mtime < 1800) { $numusers++; }
657: }
658: closedir(LONIDS);
659: }
660: my $userloadpercent=0;
661: my $maxuserload=$perlvar{'lonUserLoadLim'};
662: if ($maxuserload) {
663: $userloadpercent=100*$numusers/$maxuserload;
664: }
665: $userloadpercent=sprintf("%.2f",$userloadpercent);
666: return $userloadpercent;
667: }
668:
669: # ------------------------------------------ Fight off request when overloaded
670:
671: sub overloaderror {
672: my ($r,$checkserver)=@_;
673: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
674: my $loadavg;
675: if ($checkserver eq $perlvar{'lonHostID'}) {
676: open(my $loadfile,'/proc/loadavg');
677: $loadavg=<$loadfile>;
678: $loadavg =~ s/\s.*//g;
679: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
680: close($loadfile);
681: } else {
682: $loadavg=&reply('load',$checkserver);
683: }
684: my $overload=$loadavg-100;
685: if ($overload>0) {
686: $r->err_headers_out->{'Retry-After'}=$overload;
687: $r->log_error('Overload of '.$overload.' on '.$checkserver);
688: return 413;
689: }
690: return '';
691: }
692:
693: # ------------------------------ Find server with least workload from spare.tab
694:
695: sub spareserver {
696: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
697: my $spare_server;
698: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
699: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
700: : $userloadpercent;
701:
702: foreach my $try_server (@{ $spareid{'primary'} }) {
703: ($spare_server, $lowest_load) =
704: &compare_server_load($try_server, $spare_server, $lowest_load);
705: }
706:
707: my $found_server = ($spare_server ne '' && $lowest_load < 100);
708:
709: if (!$found_server) {
710: foreach my $try_server (@{ $spareid{'default'} }) {
711: ($spare_server, $lowest_load) =
712: &compare_server_load($try_server, $spare_server, $lowest_load);
713: }
714: }
715:
716: if (!$want_server_name) {
717: my $protocol = 'http';
718: if ($protocol{$spare_server} eq 'https') {
719: $protocol = $protocol{$spare_server};
720: }
721: $spare_server = $protocol.'://'.&hostname($spare_server);
722: }
723: return $spare_server;
724: }
725:
726: sub compare_server_load {
727: my ($try_server, $spare_server, $lowest_load) = @_;
728:
729: my $loadans = &reply('load', $try_server);
730: my $userloadans = &reply('userload',$try_server);
731:
732: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
733: next; #didn't get a number from the server
734: }
735:
736: my $load;
737: if ($loadans =~ /\d/) {
738: if ($userloadans =~ /\d/) {
739: #both are numbers, pick the bigger one
740: $load = ($loadans > $userloadans) ? $loadans
741: : $userloadans;
742: } else {
743: $load = $loadans;
744: }
745: } else {
746: $load = $userloadans;
747: }
748:
749: if (($load =~ /\d/) && ($load < $lowest_load)) {
750: $spare_server = $try_server;
751: $lowest_load = $load;
752: }
753: return ($spare_server,$lowest_load);
754: }
755:
756: # --------------------------- ask offload servers if user already has a session
757: sub find_existing_session {
758: my ($udom,$uname) = @_;
759: foreach my $try_server (@{ $spareid{'primary'} },
760: @{ $spareid{'default'} }) {
761: return $try_server if (&has_user_session($try_server, $udom, $uname));
762: }
763: return;
764: }
765:
766: # -------------------------------- ask if server already has a session for user
767: sub has_user_session {
768: my ($lonid,$udom,$uname) = @_;
769: my $result = &reply(join(':','userhassession',
770: map {&escape($_)} ($udom,$uname)),$lonid);
771: return 1 if ($result eq 'ok');
772:
773: return 0;
774: }
775:
776: # --------------------------------------------- Try to change a user's password
777:
778: sub changepass {
779: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
780: $currentpass = &escape($currentpass);
781: $newpass = &escape($newpass);
782: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
783: $server);
784: if (! $answer) {
785: &logthis("No reply on password change request to $server ".
786: "by $uname in domain $udom.");
787: } elsif ($answer =~ "^ok") {
788: &logthis("$uname in $udom successfully changed their password ".
789: "on $server.");
790: } elsif ($answer =~ "^pwchange_failure") {
791: &logthis("$uname in $udom was unable to change their password ".
792: "on $server. The action was blocked by either lcpasswd ".
793: "or pwchange");
794: } elsif ($answer =~ "^non_authorized") {
795: &logthis("$uname in $udom did not get their password correct when ".
796: "attempting to change it on $server.");
797: } elsif ($answer =~ "^auth_mode_error") {
798: &logthis("$uname in $udom attempted to change their password despite ".
799: "not being locally or internally authenticated on $server.");
800: } elsif ($answer =~ "^unknown_user") {
801: &logthis("$uname in $udom attempted to change their password ".
802: "on $server but were unable to because $server is not ".
803: "their home server.");
804: } elsif ($answer =~ "^refused") {
805: &logthis("$server refused to change $uname in $udom password because ".
806: "it was sent an unencrypted request to change the password.");
807: }
808: return $answer;
809: }
810:
811: # ----------------------- Try to determine user's current authentication scheme
812:
813: sub queryauthenticate {
814: my ($uname,$udom)=@_;
815: my $uhome=&homeserver($uname,$udom);
816: if (!$uhome) {
817: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
818: return 'no_host';
819: }
820: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
821: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
822: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
823: }
824: return $answer;
825: }
826:
827: # --------- Try to authenticate user from domain's lib servers (first this one)
828:
829: sub authenticate {
830: my ($uname,$upass,$udom,$checkdefauth)=@_;
831: $upass=&escape($upass);
832: $uname= &LONCAPA::clean_username($uname);
833: my $uhome=&homeserver($uname,$udom,1);
834: my $newhome;
835: if ((!$uhome) || ($uhome eq 'no_host')) {
836: # Maybe the machine was offline and only re-appeared again recently?
837: &reconlonc();
838: # One more
839: $uhome=&homeserver($uname,$udom,1);
840: if (($uhome eq 'no_host') && $checkdefauth) {
841: if (defined(&domain($udom,'primary'))) {
842: $newhome=&domain($udom,'primary');
843: }
844: if ($newhome ne '') {
845: $uhome = $newhome;
846: }
847: }
848: if ((!$uhome) || ($uhome eq 'no_host')) {
849: &logthis("User $uname at $udom is unknown in authenticate");
850: return 'no_host';
851: }
852: }
853: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
854: if ($answer eq 'authorized') {
855: if ($newhome) {
856: &logthis("User $uname at $udom authorized by $uhome, but needs account");
857: return 'no_account_on_host';
858: } else {
859: &logthis("User $uname at $udom authorized by $uhome");
860: return $uhome;
861: }
862: }
863: if ($answer eq 'non_authorized') {
864: &logthis("User $uname at $udom rejected by $uhome");
865: return 'no_host';
866: }
867: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
868: return 'no_host';
869: }
870:
871: # ---------------------- Find the homebase for a user from domain's lib servers
872:
873: my %homecache;
874: sub homeserver {
875: my ($uname,$udom,$ignoreBadCache)=@_;
876: my $index="$uname:$udom";
877:
878: if (exists($homecache{$index})) { return $homecache{$index}; }
879:
880: my %servers = &get_servers($udom,'library');
881: foreach my $tryserver (keys(%servers)) {
882: next if ($ignoreBadCache ne 'true' &&
883: exists($badServerCache{$tryserver}));
884:
885: my $answer=reply("home:$udom:$uname",$tryserver);
886: if ($answer eq 'found') {
887: delete($badServerCache{$tryserver});
888: return $homecache{$index}=$tryserver;
889: } elsif ($answer eq 'no_host') {
890: $badServerCache{$tryserver}=1;
891: }
892: }
893: return 'no_host';
894: }
895:
896: # ------------------------------------- Find the usernames behind a list of IDs
897:
898: sub idget {
899: my ($udom,@ids)=@_;
900: my %returnhash=();
901:
902: my %servers = &get_servers($udom,'library');
903: foreach my $tryserver (keys(%servers)) {
904: my $idlist=join('&',@ids);
905: $idlist=~tr/A-Z/a-z/;
906: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
907: my @answer=();
908: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
909: @answer=split(/\&/,$reply);
910: } ;
911: my $i;
912: for ($i=0;$i<=$#ids;$i++) {
913: if ($answer[$i]) {
914: $returnhash{$ids[$i]}=$answer[$i];
915: }
916: }
917: }
918: return %returnhash;
919: }
920:
921: # ------------------------------------- Find the IDs behind a list of usernames
922:
923: sub idrget {
924: my ($udom,@unames)=@_;
925: my %returnhash=();
926: foreach my $uname (@unames) {
927: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
928: }
929: return %returnhash;
930: }
931:
932: # ------------------------------- Store away a list of names and associated IDs
933:
934: sub idput {
935: my ($udom,%ids)=@_;
936: my %servers=();
937: foreach my $uname (keys(%ids)) {
938: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
939: my $uhom=&homeserver($uname,$udom);
940: if ($uhom ne 'no_host') {
941: my $id=&escape($ids{$uname});
942: $id=~tr/A-Z/a-z/;
943: my $esc_unam=&escape($uname);
944: if ($servers{$uhom}) {
945: $servers{$uhom}.='&'.$id.'='.$esc_unam;
946: } else {
947: $servers{$uhom}=$id.'='.$esc_unam;
948: }
949: }
950: }
951: foreach my $server (keys(%servers)) {
952: &critical('idput:'.$udom.':'.$servers{$server},$server);
953: }
954: }
955:
956: # ------------------------------------------- get items from domain db files
957:
958: sub get_dom {
959: my ($namespace,$storearr,$udom,$uhome)=@_;
960: my $items='';
961: foreach my $item (@$storearr) {
962: $items.=&escape($item).'&';
963: }
964: $items=~s/\&$//;
965: if (!$udom) {
966: $udom=$env{'user.domain'};
967: if (defined(&domain($udom,'primary'))) {
968: $uhome=&domain($udom,'primary');
969: } else {
970: undef($uhome);
971: }
972: } else {
973: if (!$uhome) {
974: if (defined(&domain($udom,'primary'))) {
975: $uhome=&domain($udom,'primary');
976: }
977: }
978: }
979: if ($udom && $uhome && ($uhome ne 'no_host')) {
980: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
981: my %returnhash;
982: if ($rep eq '' || $rep =~ /^error: 2 /) {
983: return %returnhash;
984: }
985: my @pairs=split(/\&/,$rep);
986: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
987: return @pairs;
988: }
989: my $i=0;
990: foreach my $item (@$storearr) {
991: $returnhash{$item}=&thaw_unescape($pairs[$i]);
992: $i++;
993: }
994: return %returnhash;
995: } else {
996: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
997: }
998: }
999:
1000: # -------------------------------------------- put items in domain db files
1001:
1002: sub put_dom {
1003: my ($namespace,$storehash,$udom,$uhome)=@_;
1004: if (!$udom) {
1005: $udom=$env{'user.domain'};
1006: if (defined(&domain($udom,'primary'))) {
1007: $uhome=&domain($udom,'primary');
1008: } else {
1009: undef($uhome);
1010: }
1011: } else {
1012: if (!$uhome) {
1013: if (defined(&domain($udom,'primary'))) {
1014: $uhome=&domain($udom,'primary');
1015: }
1016: }
1017: }
1018: if ($udom && $uhome && ($uhome ne 'no_host')) {
1019: my $items='';
1020: foreach my $item (keys(%$storehash)) {
1021: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1022: }
1023: $items=~s/\&$//;
1024: return &reply("putdom:$udom:$namespace:$items",$uhome);
1025: } else {
1026: &logthis("put_dom failed - no homeserver and/or domain");
1027: }
1028: }
1029:
1030: sub retrieve_inst_usertypes {
1031: my ($udom) = @_;
1032: my (%returnhash,@order);
1033: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1034: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1035: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1036: %returnhash = %{$domdefs{'inststatustypes'}};
1037: @order = @{$domdefs{'inststatusorder'}};
1038: } else {
1039: if (defined(&domain($udom,'primary'))) {
1040: my $uhome=&domain($udom,'primary');
1041: my $rep=&reply("inst_usertypes:$udom",$uhome);
1042: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1043: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1044: return (\%returnhash,\@order);
1045: }
1046: my ($hashitems,$orderitems) = split(/:/,$rep);
1047: my @pairs=split(/\&/,$hashitems);
1048: foreach my $item (@pairs) {
1049: my ($key,$value)=split(/=/,$item,2);
1050: $key = &unescape($key);
1051: next if ($key =~ /^error: 2 /);
1052: $returnhash{$key}=&thaw_unescape($value);
1053: }
1054: my @esc_order = split(/\&/,$orderitems);
1055: foreach my $item (@esc_order) {
1056: push(@order,&unescape($item));
1057: }
1058: } else {
1059: &logthis("get_dom failed - no primary domain server for $udom");
1060: }
1061: }
1062: return (\%returnhash,\@order);
1063: }
1064:
1065: sub is_domainimage {
1066: my ($url) = @_;
1067: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1068: if (&domain($1) ne '') {
1069: return '1';
1070: }
1071: }
1072: return;
1073: }
1074:
1075: sub inst_directory_query {
1076: my ($srch) = @_;
1077: my $udom = $srch->{'srchdomain'};
1078: my %results;
1079: my $homeserver = &domain($udom,'primary');
1080: my $outcome;
1081: if ($homeserver ne '') {
1082: my $queryid=&reply("querysend:instdirsearch:".
1083: &escape($srch->{'srchby'}).':'.
1084: &escape($srch->{'srchterm'}).':'.
1085: &escape($srch->{'srchtype'}),$homeserver);
1086: my $host=&hostname($homeserver);
1087: if ($queryid !~/^\Q$host\E\_/) {
1088: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1089: return;
1090: }
1091: my $response = &get_query_reply($queryid);
1092: my $maxtries = 5;
1093: my $tries = 1;
1094: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1095: $response = &get_query_reply($queryid);
1096: $tries ++;
1097: }
1098:
1099: if (!&error($response) && $response ne 'refused') {
1100: if ($response eq 'unavailable') {
1101: $outcome = $response;
1102: } else {
1103: $outcome = 'ok';
1104: my @matches = split(/\n/,$response);
1105: foreach my $match (@matches) {
1106: my ($key,$value) = split(/=/,$match);
1107: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1108: }
1109: }
1110: }
1111: }
1112: return ($outcome,%results);
1113: }
1114:
1115: sub usersearch {
1116: my ($srch) = @_;
1117: my $dom = $srch->{'srchdomain'};
1118: my %results;
1119: my %libserv = &all_library();
1120: my $query = 'usersearch';
1121: foreach my $tryserver (keys(%libserv)) {
1122: if (&host_domain($tryserver) eq $dom) {
1123: my $host=&hostname($tryserver);
1124: my $queryid=
1125: &reply("querysend:".&escape($query).':'.
1126: &escape($srch->{'srchby'}).':'.
1127: &escape($srch->{'srchtype'}).':'.
1128: &escape($srch->{'srchterm'}),$tryserver);
1129: if ($queryid !~/^\Q$host\E\_/) {
1130: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1131: next;
1132: }
1133: my $reply = &get_query_reply($queryid);
1134: my $maxtries = 1;
1135: my $tries = 1;
1136: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1137: $reply = &get_query_reply($queryid);
1138: $tries ++;
1139: }
1140: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1141: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1142: } else {
1143: my @matches;
1144: if ($reply =~ /\n/) {
1145: @matches = split(/\n/,$reply);
1146: } else {
1147: @matches = split(/\&/,$reply);
1148: }
1149: foreach my $match (@matches) {
1150: my ($uname,$udom,%userhash);
1151: foreach my $entry (split(/:/,$match)) {
1152: my ($key,$value) =
1153: map {&unescape($_);} split(/=/,$entry);
1154: $userhash{$key} = $value;
1155: if ($key eq 'username') {
1156: $uname = $value;
1157: } elsif ($key eq 'domain') {
1158: $udom = $value;
1159: }
1160: }
1161: $results{$uname.':'.$udom} = \%userhash;
1162: }
1163: }
1164: }
1165: }
1166: return %results;
1167: }
1168:
1169: sub get_instuser {
1170: my ($udom,$uname,$id) = @_;
1171: my $homeserver = &domain($udom,'primary');
1172: my ($outcome,%results);
1173: if ($homeserver ne '') {
1174: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1175: &escape($id).':'.&escape($udom),$homeserver);
1176: my $host=&hostname($homeserver);
1177: if ($queryid !~/^\Q$host\E\_/) {
1178: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1179: return;
1180: }
1181: my $response = &get_query_reply($queryid);
1182: my $maxtries = 5;
1183: my $tries = 1;
1184: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1185: $response = &get_query_reply($queryid);
1186: $tries ++;
1187: }
1188: if (!&error($response) && $response ne 'refused') {
1189: if ($response eq 'unavailable') {
1190: $outcome = $response;
1191: } else {
1192: $outcome = 'ok';
1193: my @matches = split(/\n/,$response);
1194: foreach my $match (@matches) {
1195: my ($key,$value) = split(/=/,$match);
1196: $results{&unescape($key)} = &thaw_unescape($value);
1197: }
1198: }
1199: }
1200: }
1201: my %userinfo;
1202: if (ref($results{$uname}) eq 'HASH') {
1203: %userinfo = %{$results{$uname}};
1204: }
1205: return ($outcome,%userinfo);
1206: }
1207:
1208: sub inst_rulecheck {
1209: my ($udom,$uname,$id,$item,$rules) = @_;
1210: my %returnhash;
1211: if ($udom ne '') {
1212: if (ref($rules) eq 'ARRAY') {
1213: @{$rules} = map {&escape($_);} (@{$rules});
1214: my $rulestr = join(':',@{$rules});
1215: my $homeserver=&domain($udom,'primary');
1216: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1217: my $response;
1218: if ($item eq 'username') {
1219: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1220: ':'.&escape($uname).':'.$rulestr,
1221: $homeserver));
1222: } elsif ($item eq 'id') {
1223: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1224: ':'.&escape($id).':'.$rulestr,
1225: $homeserver));
1226: } elsif ($item eq 'selfcreate') {
1227: $response=&unescape(&reply('instselfcreatecheck:'.
1228: &escape($udom).':'.&escape($uname).
1229: ':'.$rulestr,$homeserver));
1230: }
1231: if ($response ne 'refused') {
1232: my @pairs=split(/\&/,$response);
1233: foreach my $item (@pairs) {
1234: my ($key,$value)=split(/=/,$item,2);
1235: $key = &unescape($key);
1236: next if ($key =~ /^error: 2 /);
1237: $returnhash{$key}=&thaw_unescape($value);
1238: }
1239: }
1240: }
1241: }
1242: }
1243: return %returnhash;
1244: }
1245:
1246: sub inst_userrules {
1247: my ($udom,$check) = @_;
1248: my (%ruleshash,@ruleorder);
1249: if ($udom ne '') {
1250: my $homeserver=&domain($udom,'primary');
1251: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1252: my $response;
1253: if ($check eq 'id') {
1254: $response=&reply('instidrules:'.&escape($udom),
1255: $homeserver);
1256: } elsif ($check eq 'email') {
1257: $response=&reply('instemailrules:'.&escape($udom),
1258: $homeserver);
1259: } else {
1260: $response=&reply('instuserrules:'.&escape($udom),
1261: $homeserver);
1262: }
1263: if (($response ne 'refused') && ($response ne 'error') &&
1264: ($response ne 'unknown_cmd') &&
1265: ($response ne 'no_such_host')) {
1266: my ($hashitems,$orderitems) = split(/:/,$response);
1267: my @pairs=split(/\&/,$hashitems);
1268: foreach my $item (@pairs) {
1269: my ($key,$value)=split(/=/,$item,2);
1270: $key = &unescape($key);
1271: next if ($key =~ /^error: 2 /);
1272: $ruleshash{$key}=&thaw_unescape($value);
1273: }
1274: my @esc_order = split(/\&/,$orderitems);
1275: foreach my $item (@esc_order) {
1276: push(@ruleorder,&unescape($item));
1277: }
1278: }
1279: }
1280: }
1281: return (\%ruleshash,\@ruleorder);
1282: }
1283:
1284: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1285:
1286: sub get_domain_defaults {
1287: my ($domain) = @_;
1288: my $cachetime = 60*60*24;
1289: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1290: if (defined($cached)) {
1291: if (ref($result) eq 'HASH') {
1292: return %{$result};
1293: }
1294: }
1295: my %domdefaults;
1296: my %domconfig =
1297: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1298: 'requestcourses','inststatus'],$domain);
1299: if (ref($domconfig{'defaults'}) eq 'HASH') {
1300: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1301: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1302: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1303: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1304: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1305: } else {
1306: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1307: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1308: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1309: }
1310: if (ref($domconfig{'quotas'}) eq 'HASH') {
1311: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1312: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1313: } else {
1314: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1315: }
1316: my @usertools = ('aboutme','blog','portfolio');
1317: foreach my $item (@usertools) {
1318: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1319: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1320: }
1321: }
1322: }
1323: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1324: foreach my $item ('official','unofficial') {
1325: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1326: }
1327: }
1328: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1329: foreach my $item ('inststatustypes','inststatusorder') {
1330: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1331: }
1332: }
1333: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1334: $cachetime);
1335: return %domdefaults;
1336: }
1337:
1338: # --------------------------------------------------- Assign a key to a student
1339:
1340: sub assign_access_key {
1341: #
1342: # a valid key looks like uname:udom#comments
1343: # comments are being appended
1344: #
1345: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1346: $kdom=
1347: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1348: $knum=
1349: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1350: $cdom=
1351: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1352: $cnum=
1353: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1354: $udom=$env{'user.name'} unless (defined($udom));
1355: $uname=$env{'user.domain'} unless (defined($uname));
1356: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1357: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1358: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1359: # assigned to this person
1360: # - this should not happen,
1361: # unless something went wrong
1362: # the first time around
1363: # ready to assign
1364: $logentry=$1.'; '.$logentry;
1365: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1366: $kdom,$knum) eq 'ok') {
1367: # key now belongs to user
1368: my $envkey='key.'.$cdom.'_'.$cnum;
1369: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1370: &appenv({'environment.'.$envkey => $ckey});
1371: return 'ok';
1372: } else {
1373: return
1374: 'error: Count not permanently assign key, will need to be re-entered later.';
1375: }
1376: } else {
1377: return 'error: Could not assign key, try again later.';
1378: }
1379: } elsif (!$existing{$ckey}) {
1380: # the key does not exist
1381: return 'error: The key does not exist';
1382: } else {
1383: # the key is somebody else's
1384: return 'error: The key is already in use';
1385: }
1386: }
1387:
1388: # ------------------------------------------ put an additional comment on a key
1389:
1390: sub comment_access_key {
1391: #
1392: # a valid key looks like uname:udom#comments
1393: # comments are being appended
1394: #
1395: my ($ckey,$cdom,$cnum,$logentry)=@_;
1396: $cdom=
1397: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1398: $cnum=
1399: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1400: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1401: if ($existing{$ckey}) {
1402: $existing{$ckey}.='; '.$logentry;
1403: # ready to assign
1404: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1405: $cdom,$cnum) eq 'ok') {
1406: return 'ok';
1407: } else {
1408: return 'error: Count not store comment.';
1409: }
1410: } else {
1411: # the key does not exist
1412: return 'error: The key does not exist';
1413: }
1414: }
1415:
1416: # ------------------------------------------------------ Generate a set of keys
1417:
1418: sub generate_access_keys {
1419: my ($number,$cdom,$cnum,$logentry)=@_;
1420: $cdom=
1421: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1422: $cnum=
1423: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1424: unless (&allowed('mky',$cdom)) { return 0; }
1425: unless (($cdom) && ($cnum)) { return 0; }
1426: if ($number>10000) { return 0; }
1427: sleep(2); # make sure don't get same seed twice
1428: srand(time()^($$+($$<<15))); # from "Programming Perl"
1429: my $total=0;
1430: for (my $i=1;$i<=$number;$i++) {
1431: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1432: sprintf("%lx",int(100000*rand)).'-'.
1433: sprintf("%lx",int(100000*rand));
1434: $newkey=~s/1/g/g; # folks mix up 1 and l
1435: $newkey=~s/0/h/g; # and also 0 and O
1436: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1437: if ($existing{$newkey}) {
1438: $i--;
1439: } else {
1440: if (&put('accesskeys',
1441: { $newkey => '# generated '.localtime().
1442: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1443: '; '.$logentry },
1444: $cdom,$cnum) eq 'ok') {
1445: $total++;
1446: }
1447: }
1448: }
1449: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1450: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1451: return $total;
1452: }
1453:
1454: # ------------------------------------------------------- Validate an accesskey
1455:
1456: sub validate_access_key {
1457: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1458: $cdom=
1459: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1460: $cnum=
1461: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1462: $udom=$env{'user.domain'} unless (defined($udom));
1463: $uname=$env{'user.name'} unless (defined($uname));
1464: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1465: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1466: }
1467:
1468: # ------------------------------------- Find the section of student in a course
1469: sub devalidate_getsection_cache {
1470: my ($udom,$unam,$courseid)=@_;
1471: my $hashid="$udom:$unam:$courseid";
1472: &devalidate_cache_new('getsection',$hashid);
1473: }
1474:
1475: sub courseid_to_courseurl {
1476: my ($courseid) = @_;
1477: #already url style courseid
1478: return $courseid if ($courseid =~ m{^/});
1479:
1480: if (exists($env{'course.'.$courseid.'.num'})) {
1481: my $cnum = $env{'course.'.$courseid.'.num'};
1482: my $cdom = $env{'course.'.$courseid.'.domain'};
1483: return "/$cdom/$cnum";
1484: }
1485:
1486: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1487: if (exists($courseinfo{'num'})) {
1488: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1489: }
1490:
1491: return undef;
1492: }
1493:
1494: sub getsection {
1495: my ($udom,$unam,$courseid)=@_;
1496: my $cachetime=1800;
1497:
1498: my $hashid="$udom:$unam:$courseid";
1499: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1500: if (defined($cached)) { return $result; }
1501:
1502: my %Pending;
1503: my %Expired;
1504: #
1505: # Each role can either have not started yet (pending), be active,
1506: # or have expired.
1507: #
1508: # If there is an active role, we are done.
1509: #
1510: # If there is more than one role which has not started yet,
1511: # choose the one which will start sooner
1512: # If there is one role which has not started yet, return it.
1513: #
1514: # If there is more than one expired role, choose the one which ended last.
1515: # If there is a role which has expired, return it.
1516: #
1517: $courseid = &courseid_to_courseurl($courseid);
1518: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1519: foreach my $key (keys(%roleshash)) {
1520: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1521: my $section=$1;
1522: if ($key eq $courseid.'_st') { $section=''; }
1523: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1524: my $now=time;
1525: if (defined($end) && $end && ($now > $end)) {
1526: $Expired{$end}=$section;
1527: next;
1528: }
1529: if (defined($start) && $start && ($now < $start)) {
1530: $Pending{$start}=$section;
1531: next;
1532: }
1533: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1534: }
1535: #
1536: # Presumedly there will be few matching roles from the above
1537: # loop and the sorting time will be negligible.
1538: if (scalar(keys(%Pending))) {
1539: my ($time) = sort {$a <=> $b} keys(%Pending);
1540: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1541: }
1542: if (scalar(keys(%Expired))) {
1543: my @sorted = sort {$a <=> $b} keys(%Expired);
1544: my $time = pop(@sorted);
1545: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1546: }
1547: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1548: }
1549:
1550: sub save_cache {
1551: &purge_remembered();
1552: #&Apache::loncommon::validate_page();
1553: undef(%env);
1554: undef($env_loaded);
1555: }
1556:
1557: my $to_remember=-1;
1558: my %remembered;
1559: my %accessed;
1560: my $kicks=0;
1561: my $hits=0;
1562: sub make_key {
1563: my ($name,$id) = @_;
1564: if (length($id) > 65
1565: && length(&escape($id)) > 200) {
1566: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1567: }
1568: return &escape($name.':'.$id);
1569: }
1570:
1571: sub devalidate_cache_new {
1572: my ($name,$id,$debug) = @_;
1573: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1574: $id=&make_key($name,$id);
1575: $memcache->delete($id);
1576: delete($remembered{$id});
1577: delete($accessed{$id});
1578: }
1579:
1580: sub is_cached_new {
1581: my ($name,$id,$debug) = @_;
1582: $id=&make_key($name,$id);
1583: if (exists($remembered{$id})) {
1584: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1585: $accessed{$id}=[&gettimeofday()];
1586: $hits++;
1587: return ($remembered{$id},1);
1588: }
1589: my $value = $memcache->get($id);
1590: if (!(defined($value))) {
1591: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1592: return (undef,undef);
1593: }
1594: if ($value eq '__undef__') {
1595: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1596: $value=undef;
1597: }
1598: &make_room($id,$value,$debug);
1599: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1600: return ($value,1);
1601: }
1602:
1603: sub do_cache_new {
1604: my ($name,$id,$value,$time,$debug) = @_;
1605: $id=&make_key($name,$id);
1606: my $setvalue=$value;
1607: if (!defined($setvalue)) {
1608: $setvalue='__undef__';
1609: }
1610: if (!defined($time) ) {
1611: $time=600;
1612: }
1613: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1614: my $result = $memcache->set($id,$setvalue,$time);
1615: if (! $result) {
1616: &logthis("caching of id -> $id failed");
1617: $memcache->disconnect_all();
1618: }
1619: # need to make a copy of $value
1620: &make_room($id,$value,$debug);
1621: return $value;
1622: }
1623:
1624: sub make_room {
1625: my ($id,$value,$debug)=@_;
1626:
1627: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1628: : $value;
1629: if ($to_remember<0) { return; }
1630: $accessed{$id}=[&gettimeofday()];
1631: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1632: my $to_kick;
1633: my $max_time=0;
1634: foreach my $other (keys(%accessed)) {
1635: if (&tv_interval($accessed{$other}) > $max_time) {
1636: $to_kick=$other;
1637: $max_time=&tv_interval($accessed{$other});
1638: }
1639: }
1640: delete($remembered{$to_kick});
1641: delete($accessed{$to_kick});
1642: $kicks++;
1643: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1644: return;
1645: }
1646:
1647: sub purge_remembered {
1648: #&logthis("Tossing ".scalar(keys(%remembered)));
1649: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1650: undef(%remembered);
1651: undef(%accessed);
1652: }
1653: # ------------------------------------- Read an entry from a user's environment
1654:
1655: sub userenvironment {
1656: my ($udom,$unam,@what)=@_;
1657: my $items;
1658: foreach my $item (@what) {
1659: $items.=&escape($item).'&';
1660: }
1661: $items=~s/\&$//;
1662: my %returnhash=();
1663: my @answer=split(/\&/,
1664: &reply('get:'.$udom.':'.$unam.':environment:'.$items,
1665: &homeserver($unam,$udom)));
1666: my $i;
1667: for ($i=0;$i<=$#what;$i++) {
1668: $returnhash{$what[$i]}=&unescape($answer[$i]);
1669: }
1670: return %returnhash;
1671: }
1672:
1673: # ---------------------------------------------------------- Get a studentphoto
1674: sub studentphoto {
1675: my ($udom,$unam,$ext) = @_;
1676: my $home=&Apache::lonnet::homeserver($unam,$udom);
1677: if (defined($env{'request.course.id'})) {
1678: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1679: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1680: return(&retrievestudentphoto($udom,$unam,$ext));
1681: } else {
1682: my ($result,$perm_reqd)=
1683: &Apache::lonnet::auto_photo_permission($unam,$udom);
1684: if ($result eq 'ok') {
1685: if (!($perm_reqd eq 'yes')) {
1686: return(&retrievestudentphoto($udom,$unam,$ext));
1687: }
1688: }
1689: }
1690: }
1691: } else {
1692: my ($result,$perm_reqd) =
1693: &Apache::lonnet::auto_photo_permission($unam,$udom);
1694: if ($result eq 'ok') {
1695: if (!($perm_reqd eq 'yes')) {
1696: return(&retrievestudentphoto($udom,$unam,$ext));
1697: }
1698: }
1699: }
1700: return '/adm/lonKaputt/lonlogo_broken.gif';
1701: }
1702:
1703: sub retrievestudentphoto {
1704: my ($udom,$unam,$ext,$type) = @_;
1705: my $home=&Apache::lonnet::homeserver($unam,$udom);
1706: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1707: if ($ret eq 'ok') {
1708: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1709: if ($type eq 'thumbnail') {
1710: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1711: }
1712: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1713: return $tokenurl;
1714: } else {
1715: if ($type eq 'thumbnail') {
1716: return '/adm/lonKaputt/genericstudent_tn.gif';
1717: } else {
1718: return '/adm/lonKaputt/lonlogo_broken.gif';
1719: }
1720: }
1721: }
1722:
1723: # -------------------------------------------------------------------- New chat
1724:
1725: sub chatsend {
1726: my ($newentry,$anon,$group)=@_;
1727: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1728: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1729: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1730: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1731: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1732: &escape($newentry)).':'.$group,$chome);
1733: }
1734:
1735: # ------------------------------------------ Find current version of a resource
1736:
1737: sub getversion {
1738: my $fname=&clutter(shift);
1739: unless ($fname=~/^\/res\//) { return -1; }
1740: return ¤tversion(&filelocation('',$fname));
1741: }
1742:
1743: sub currentversion {
1744: my $fname=shift;
1745: my ($result,$cached)=&is_cached_new('resversion',$fname);
1746: if (defined($cached)) { return $result; }
1747: my $author=$fname;
1748: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1749: my ($udom,$uname)=split(/\//,$author);
1750: my $home=homeserver($uname,$udom);
1751: if ($home eq 'no_host') {
1752: return -1;
1753: }
1754: my $answer=reply("currentversion:$fname",$home);
1755: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1756: return -1;
1757: }
1758: return &do_cache_new('resversion',$fname,$answer,600);
1759: }
1760:
1761: # ----------------------------- Subscribe to a resource, return URL if possible
1762:
1763: sub subscribe {
1764: my $fname=shift;
1765: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1766: $fname=~s/[\n\r]//g;
1767: my $author=$fname;
1768: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1769: my ($udom,$uname)=split(/\//,$author);
1770: my $home=homeserver($uname,$udom);
1771: if ($home eq 'no_host') {
1772: return 'not_found';
1773: }
1774: my $answer=reply("sub:$fname",$home);
1775: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1776: $answer.=' by '.$home;
1777: }
1778: return $answer;
1779: }
1780:
1781: # -------------------------------------------------------------- Replicate file
1782:
1783: sub repcopy {
1784: my $filename=shift;
1785: $filename=~s/\/+/\//g;
1786: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1787: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1788: if ($filename=~m|^/home/httpd/html/userfiles/| or
1789: $filename=~m -^/*(uploaded|editupload)/-) {
1790: return &repcopy_userfile($filename);
1791: }
1792: $filename=~s/[\n\r]//g;
1793: my $transname="$filename.in.transfer";
1794: # FIXME: this should flock
1795: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1796: my $remoteurl=subscribe($filename);
1797: if ($remoteurl =~ /^con_lost by/) {
1798: &logthis("Subscribe returned $remoteurl: $filename");
1799: return 'unavailable';
1800: } elsif ($remoteurl eq 'not_found') {
1801: #&logthis("Subscribe returned not_found: $filename");
1802: return 'not_found';
1803: } elsif ($remoteurl =~ /^rejected by/) {
1804: &logthis("Subscribe returned $remoteurl: $filename");
1805: return 'forbidden';
1806: } elsif ($remoteurl eq 'directory') {
1807: return 'ok';
1808: } else {
1809: my $author=$filename;
1810: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1811: my ($udom,$uname)=split(/\//,$author);
1812: my $home=homeserver($uname,$udom);
1813: unless ($home eq $perlvar{'lonHostID'}) {
1814: my @parts=split(/\//,$filename);
1815: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1816: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1817: &logthis("Malconfiguration for replication: $filename");
1818: return 'bad_request';
1819: }
1820: my $count;
1821: for ($count=5;$count<$#parts;$count++) {
1822: $path.="/$parts[$count]";
1823: if ((-e $path)!=1) {
1824: mkdir($path,0777);
1825: }
1826: }
1827: my $ua=new LWP::UserAgent;
1828: my $request=new HTTP::Request('GET',"$remoteurl");
1829: my $response=$ua->request($request,$transname);
1830: if ($response->is_error()) {
1831: unlink($transname);
1832: my $message=$response->status_line;
1833: &logthis("<font color=\"blue\">WARNING:"
1834: ." LWP get: $message: $filename</font>");
1835: return 'unavailable';
1836: } else {
1837: if ($remoteurl!~/\.meta$/) {
1838: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1839: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1840: if ($mresponse->is_error()) {
1841: unlink($filename.'.meta');
1842: &logthis(
1843: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1844: }
1845: }
1846: rename($transname,$filename);
1847: return 'ok';
1848: }
1849: }
1850: }
1851: }
1852:
1853: # ------------------------------------------------ Get server side include body
1854: sub ssi_body {
1855: my ($filelink,%form)=@_;
1856: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1857: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1858: }
1859: my $output='';
1860: my $response;
1861: if ($filelink=~/^https?\:/) {
1862: ($output,$response)=&externalssi($filelink);
1863: } else {
1864: ($output,$response)=&ssi($filelink,%form);
1865: }
1866: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1867: $output=~s/^.*?\<body[^\>]*\>//si;
1868: $output=~s/\<\/body\s*\>.*?$//si;
1869: if (wantarray) {
1870: return ($output, $response);
1871: } else {
1872: return $output;
1873: }
1874: }
1875:
1876: # --------------------------------------------------------- Server Side Include
1877:
1878: sub absolute_url {
1879: my ($host_name) = @_;
1880: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1881: if ($host_name eq '') {
1882: $host_name = $ENV{'SERVER_NAME'};
1883: }
1884: return $protocol.$host_name;
1885: }
1886:
1887: #
1888: # Server side include.
1889: # Parameters:
1890: # fn Possibly encrypted resource name/id.
1891: # form Hash that describes how the rendering should be done
1892: # and other things.
1893: # Returns:
1894: # Scalar context: The content of the response.
1895: # Array context: 2 element list of the content and the full response object.
1896: #
1897: sub ssi {
1898:
1899: my ($fn,%form)=@_;
1900: my $ua=new LWP::UserAgent;
1901: my $request;
1902:
1903: $form{'no_update_last_known'}=1;
1904: &Apache::lonenc::check_encrypt(\$fn);
1905: if (%form) {
1906: $request=new HTTP::Request('POST',&absolute_url().$fn);
1907: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1908: } else {
1909: $request=new HTTP::Request('GET',&absolute_url().$fn);
1910: }
1911:
1912: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1913: my $response=$ua->request($request);
1914:
1915: if (wantarray) {
1916: return ($response->content, $response);
1917: } else {
1918: return $response->content;
1919: }
1920: }
1921:
1922: sub externalssi {
1923: my ($url)=@_;
1924: my $ua=new LWP::UserAgent;
1925: my $request=new HTTP::Request('GET',$url);
1926: my $response=$ua->request($request);
1927: if (wantarray) {
1928: return ($response->content, $response);
1929: } else {
1930: return $response->content;
1931: }
1932: }
1933:
1934: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1935:
1936: sub allowuploaded {
1937: my ($srcurl,$url)=@_;
1938: $url=&clutter(&declutter($url));
1939: my $dir=$url;
1940: $dir=~s/\/[^\/]+$//;
1941: my %httpref=();
1942: my $httpurl=&hreflocation('',$url);
1943: $httpref{'httpref.'.$httpurl}=$srcurl;
1944: &Apache::lonnet::appenv(\%httpref);
1945: }
1946:
1947: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1948: # input: action, courseID, current domain, intended
1949: # path to file, source of file, instruction to parse file for objects,
1950: # ref to hash for embedded objects,
1951: # ref to hash for codebase of java objects.
1952: #
1953: # output: url to file (if action was uploaddoc),
1954: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1955: #
1956: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1957: # course.
1958: #
1959: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1960: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1961: # course's home server.
1962: #
1963: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1964: # be copied from $source (current location) to
1965: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1966: # and will then be copied to
1967: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1968: # course's home server.
1969: #
1970: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1971: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1972: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1973: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1974: # in course's home server.
1975: #
1976:
1977: sub process_coursefile {
1978: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1979: my $fetchresult;
1980: my $home=&homeserver($docuname,$docudom);
1981: if ($action eq 'propagate') {
1982: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1983: $home);
1984: } else {
1985: my $fpath = '';
1986: my $fname = $file;
1987: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1988: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1989: my $filepath = &build_filepath($fpath);
1990: if ($action eq 'copy') {
1991: if ($source eq '') {
1992: $fetchresult = 'no source file';
1993: return $fetchresult;
1994: } else {
1995: my $destination = $filepath.'/'.$fname;
1996: rename($source,$destination);
1997: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1998: $home);
1999: }
2000: } elsif ($action eq 'uploaddoc') {
2001: open(my $fh,'>'.$filepath.'/'.$fname);
2002: print $fh $env{'form.'.$source};
2003: close($fh);
2004: if ($parser eq 'parse') {
2005: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2006: unless ($parse_result eq 'ok') {
2007: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2008: }
2009: }
2010: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2011: $home);
2012: if ($fetchresult eq 'ok') {
2013: return '/uploaded/'.$fpath.'/'.$fname;
2014: } else {
2015: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2016: ' to host '.$home.': '.$fetchresult);
2017: return '/adm/notfound.html';
2018: }
2019: }
2020: }
2021: unless ( $fetchresult eq 'ok') {
2022: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2023: ' to host '.$home.': '.$fetchresult);
2024: }
2025: return $fetchresult;
2026: }
2027:
2028: sub build_filepath {
2029: my ($fpath) = @_;
2030: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2031: unless ($fpath eq '') {
2032: my @parts=split('/',$fpath);
2033: foreach my $part (@parts) {
2034: $filepath.= '/'.$part;
2035: if ((-e $filepath)!=1) {
2036: mkdir($filepath,0777);
2037: }
2038: }
2039: }
2040: return $filepath;
2041: }
2042:
2043: sub store_edited_file {
2044: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2045: my $file = $primary_url;
2046: $file =~ s#^/uploaded/$docudom/$docuname/##;
2047: my $fpath = '';
2048: my $fname = $file;
2049: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2050: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2051: my $filepath = &build_filepath($fpath);
2052: open(my $fh,'>'.$filepath.'/'.$fname);
2053: print $fh $content;
2054: close($fh);
2055: my $home=&homeserver($docuname,$docudom);
2056: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2057: $home);
2058: if ($$fetchresult eq 'ok') {
2059: return '/uploaded/'.$fpath.'/'.$fname;
2060: } else {
2061: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2062: ' to host '.$home.': '.$$fetchresult);
2063: return '/adm/notfound.html';
2064: }
2065: }
2066:
2067: sub clean_filename {
2068: my ($fname,$args)=@_;
2069: # Replace Windows backslashes by forward slashes
2070: $fname=~s/\\/\//g;
2071: if (!$args->{'keep_path'}) {
2072: # Get rid of everything but the actual filename
2073: $fname=~s/^.*\/([^\/]+)$/$1/;
2074: }
2075: # Replace spaces by underscores
2076: $fname=~s/\s+/\_/g;
2077: # Replace all other weird characters by nothing
2078: $fname=~s{[^/\w\.\-]}{}g;
2079: # Replace all .\d. sequences with _\d. so they no longer look like version
2080: # numbers
2081: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2082: return $fname;
2083: }
2084: #This Function check if a Image max 400px width and height 500px. If not then scale the image down
2085: sub resizeImage {
2086: my($img_url) = @_;
2087: my $ima = Image::Magick->new;
2088: $ima->Read($img_url);
2089: if($ima->Get('width') > 400)
2090: {
2091: my $factor = $ima->Get('width')/400;
2092: $ima->Scale( width=>400, height=>$ima->Get('height')/$factor );
2093: }
2094: if($ima->Get('height') > 500)
2095: {
2096: my $factor = $ima->Get('height')/500;
2097: $ima->Scale( width=>$ima->Get('width')/$factor, height=>500);
2098: }
2099:
2100: $ima->Write($img_url);
2101: }
2102:
2103: #Wrapper function for userphotoupload
2104: sub userphotoupload
2105: {
2106: my($formname,$subdir) = @_;
2107: $upload_photo_form = 1;
2108: return &userfileupload($formname,undef,$subdir);
2109: }
2110:
2111: # --------------- Take an uploaded file and put it into the userfiles directory
2112: # input: $formname - the contents of the file are in $env{"form.$formname"}
2113: # the desired filenam is in $env{"form.$formname.filename"}
2114: # $coursedoc - if true up to the current course
2115: # if false
2116: # $subdir - directory in userfile to store the file into
2117: # $parser - instruction to parse file for objects ($parser = parse)
2118: # $allfiles - reference to hash for embedded objects
2119: # $codebase - reference to hash for codebase of java objects
2120: # $desuname - username for permanent storage of uploaded file
2121: # $dsetudom - domain for permanaent storage of uploaded file
2122: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2123: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2124: #
2125: # output: url of file in userspace, or error: <message>
2126: # or /adm/notfound.html if failure to upload occurse
2127:
2128:
2129: sub userfileupload {
2130: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2131: $destudom,$thumbwidth,$thumbheight)=@_;
2132: if (!defined($subdir)) { $subdir='unknown'; }
2133: my $fname=$env{'form.'.$formname.'.filename'};
2134: $fname=&clean_filename($fname);
2135: # See if there is anything left
2136: unless ($fname) { return 'error: no uploaded file'; }
2137: chop($env{'form.'.$formname});
2138: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2139: my $now = time;
2140: my $filepath = 'tmp/helprequests/'.$now;
2141: my @parts=split(/\//,$filepath);
2142: my $fullpath = $perlvar{'lonDaemons'};
2143: for (my $i=0;$i<@parts;$i++) {
2144: $fullpath .= '/'.$parts[$i];
2145: if ((-e $fullpath)!=1) {
2146: mkdir($fullpath,0777);
2147: }
2148: }
2149: open(my $fh,'>'.$fullpath.'/'.$fname);
2150: print $fh $env{'form.'.$formname};
2151: close($fh);
2152: return $fullpath.'/'.$fname;
2153: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2154: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2155: '_'.$env{'user.domain'}.'/pending';
2156: my @parts=split(/\//,$filepath);
2157: my $fullpath = $perlvar{'lonDaemons'};
2158: for (my $i=0;$i<@parts;$i++) {
2159: $fullpath .= '/'.$parts[$i];
2160: if ((-e $fullpath)!=1) {
2161: mkdir($fullpath,0777);
2162: }
2163: }
2164: open(my $fh,'>'.$fullpath.'/'.$fname);
2165: print $fh $env{'form.'.$formname};
2166: close($fh);
2167: return $fullpath.'/'.$fname;
2168: }
2169: if ($subdir eq 'scantron') {
2170: $fname = 'scantron_orig_'.$fname;
2171: } else {
2172: # Create the directory if not present
2173: $fname="$subdir/$fname";
2174: }
2175: if ($coursedoc) {
2176: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2177: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2178: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2179: return &finishuserfileupload($docuname,$docudom,
2180: $formname,$fname,$parser,$allfiles,
2181: $codebase,$thumbwidth,$thumbheight);
2182: } else {
2183: $fname=$env{'form.folder'}.'/'.$fname;
2184: return &process_coursefile('uploaddoc',$docuname,$docudom,
2185: $fname,$formname,$parser,
2186: $allfiles,$codebase);
2187: }
2188: } elsif (defined($destuname)) {
2189: my $docuname=$destuname;
2190: my $docudom=$destudom;
2191: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2192: $parser,$allfiles,$codebase,
2193: $thumbwidth,$thumbheight);
2194:
2195: } else {
2196: my $docuname=$env{'user.name'};
2197: my $docudom=$env{'user.domain'};
2198: if (exists($env{'form.group'})) {
2199: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2200: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2201: }
2202: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2203: $parser,$allfiles,$codebase,
2204: $thumbwidth,$thumbheight);
2205: }
2206: }
2207:
2208: sub finishuserfileupload {
2209: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2210: $thumbwidth,$thumbheight) = @_;
2211: my $path=$docudom.'/'.$docuname.'/';
2212: my $filepath=$perlvar{'lonDocRoot'};
2213:
2214: my ($fnamepath,$file,$fetchthumb);
2215: $file=$fname;
2216: if ($fname=~m|/|) {
2217: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2218: $path.=$fnamepath.'/';
2219: }
2220: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2221: my $count;
2222: for ($count=4;$count<=$#parts;$count++) {
2223: $filepath.="/$parts[$count]";
2224: if ((-e $filepath)!=1) {
2225: mkdir($filepath,0777);
2226: }
2227: }
2228:
2229: # Save the file
2230: {
2231: if (!open(FH,'>'.$filepath.'/'.$file)) {
2232: &logthis('Failed to create '.$filepath.'/'.$file);
2233: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2234: return '/adm/notfound.html';
2235: }
2236: if (!print FH ($env{'form.'.$formname})) {
2237: &logthis('Failed to write to '.$filepath.'/'.$file);
2238: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2239: return '/adm/notfound.html';
2240: }
2241: close(FH);
2242: if($upload_photo_form==1)
2243: {
2244: resizeImage($filepath.'/'.$file);
2245: $upload_photo_form = 0;
2246: }
2247: }
2248: if ($parser eq 'parse') {
2249: my $parse_result = &extract_embedded_items($filepath.'/'.$file,$allfiles,
2250: $codebase);
2251: unless ($parse_result eq 'ok') {
2252: &logthis('Failed to parse '.$filepath.$file.
2253: ' for embedded media: '.$parse_result);
2254: }
2255: }
2256: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2257: my $input = $filepath.'/'.$file;
2258: my $output = $filepath.'/'.'tn-'.$file;
2259: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2260: system("convert -sample $thumbsize $input $output");
2261: if (-e $filepath.'/'.'tn-'.$file) {
2262: $fetchthumb = 1;
2263: }
2264: }
2265:
2266: # Notify homeserver to grep it
2267: #
2268: my $docuhome=&homeserver($docuname,$docudom);
2269: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
2270: if ($fetchresult eq 'ok') {
2271: if ($fetchthumb) {
2272: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2273: if ($thumbresult ne 'ok') {
2274: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2275: $docuhome.': '.$thumbresult);
2276: }
2277: }
2278: #
2279: # Return the URL to it
2280: return '/uploaded/'.$path.$file;
2281: } else {
2282: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2283: ': '.$fetchresult);
2284: return '/adm/notfound.html';
2285: }
2286: }
2287:
2288: sub extract_embedded_items {
2289: my ($fullpath,$allfiles,$codebase,$content) = @_;
2290: my @state = ();
2291: my %javafiles = (
2292: codebase => '',
2293: code => '',
2294: archive => ''
2295: );
2296: my %mediafiles = (
2297: src => '',
2298: movie => '',
2299: );
2300: my $p;
2301: if ($content) {
2302: $p = HTML::LCParser->new($content);
2303: } else {
2304: $p = HTML::LCParser->new($fullpath);
2305: }
2306: while (my $t=$p->get_token()) {
2307: if ($t->[0] eq 'S') {
2308: my ($tagname, $attr) = ($t->[1],$t->[2]);
2309: push(@state, $tagname);
2310: if (lc($tagname) eq 'allow') {
2311: &add_filetype($allfiles,$attr->{'src'},'src');
2312: }
2313: if (lc($tagname) eq 'img') {
2314: &add_filetype($allfiles,$attr->{'src'},'src');
2315: }
2316: if (lc($tagname) eq 'a') {
2317: &add_filetype($allfiles,$attr->{'href'},'href');
2318: }
2319: if (lc($tagname) eq 'script') {
2320: if ($attr->{'archive'} =~ /\.jar$/i) {
2321: &add_filetype($allfiles,$attr->{'archive'},'archive');
2322: } else {
2323: &add_filetype($allfiles,$attr->{'src'},'src');
2324: }
2325: }
2326: if (lc($tagname) eq 'link') {
2327: if (lc($attr->{'rel'}) eq 'stylesheet') {
2328: &add_filetype($allfiles,$attr->{'href'},'href');
2329: }
2330: }
2331: if (lc($tagname) eq 'object' ||
2332: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2333: foreach my $item (keys(%javafiles)) {
2334: $javafiles{$item} = '';
2335: }
2336: }
2337: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2338: my $name = lc($attr->{'name'});
2339: foreach my $item (keys(%javafiles)) {
2340: if ($name eq $item) {
2341: $javafiles{$item} = $attr->{'value'};
2342: last;
2343: }
2344: }
2345: foreach my $item (keys(%mediafiles)) {
2346: if ($name eq $item) {
2347: &add_filetype($allfiles, $attr->{'value'}, 'value');
2348: last;
2349: }
2350: }
2351: }
2352: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2353: foreach my $item (keys(%javafiles)) {
2354: if ($attr->{$item}) {
2355: $javafiles{$item} = $attr->{$item};
2356: last;
2357: }
2358: }
2359: foreach my $item (keys(%mediafiles)) {
2360: if ($attr->{$item}) {
2361: &add_filetype($allfiles,$attr->{$item},$item);
2362: last;
2363: }
2364: }
2365: }
2366: } elsif ($t->[0] eq 'E') {
2367: my ($tagname) = ($t->[1]);
2368: if ($javafiles{'codebase'} ne '') {
2369: $javafiles{'codebase'} .= '/';
2370: }
2371: if (lc($tagname) eq 'applet' ||
2372: lc($tagname) eq 'object' ||
2373: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2374: ) {
2375: foreach my $item (keys(%javafiles)) {
2376: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2377: my $file=$javafiles{'codebase'}.$javafiles{$item};
2378: &add_filetype($allfiles,$file,$item);
2379: }
2380: }
2381: }
2382: pop @state;
2383: }
2384: }
2385: return 'ok';
2386: }
2387:
2388: sub add_filetype {
2389: my ($allfiles,$file,$type)=@_;
2390: if (exists($allfiles->{$file})) {
2391: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2392: push(@{$allfiles->{$file}}, &escape($type));
2393: }
2394: } else {
2395: @{$allfiles->{$file}} = (&escape($type));
2396: }
2397: }
2398:
2399: sub removeuploadedurl {
2400: my ($url)=@_;
2401: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2402: return &removeuserfile($uname,$udom,$fname);
2403: }
2404:
2405: sub removeuserfile {
2406: my ($docuname,$docudom,$fname)=@_;
2407: my $home=&homeserver($docuname,$docudom);
2408: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2409: if ($result eq 'ok') {
2410: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2411: my $metafile = $fname.'.meta';
2412: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2413: my $url = "/uploaded/$docudom/$docuname/$fname";
2414: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2415: my $sqlresult =
2416: &update_portfolio_table($docuname,$docudom,$file,
2417: 'portfolio_metadata',$group,
2418: 'delete');
2419: }
2420: }
2421: return $result;
2422: }
2423:
2424: sub mkdiruserfile {
2425: my ($docuname,$docudom,$dir)=@_;
2426: my $home=&homeserver($docuname,$docudom);
2427: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2428: }
2429:
2430: sub renameuserfile {
2431: my ($docuname,$docudom,$old,$new)=@_;
2432: my $home=&homeserver($docuname,$docudom);
2433: my $result = &reply("renameuserfile:$docudom:$docuname:".
2434: &escape("$old").':'.&escape("$new"),$home);
2435: if ($result eq 'ok') {
2436: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2437: my $oldmeta = $old.'.meta';
2438: my $newmeta = $new.'.meta';
2439: my $metaresult =
2440: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2441: my $url = "/uploaded/$docudom/$docuname/$old";
2442: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2443: my $sqlresult =
2444: &update_portfolio_table($docuname,$docudom,$file,
2445: 'portfolio_metadata',$group,
2446: 'delete');
2447: }
2448: }
2449: return $result;
2450: }
2451:
2452: # ------------------------------------------------------------------------- Log
2453:
2454: sub log {
2455: my ($dom,$nam,$hom,$what)=@_;
2456: return critical("log:$dom:$nam:$what",$hom);
2457: }
2458:
2459: # ------------------------------------------------------------------ Course Log
2460: #
2461: # This routine flushes several buffers of non-mission-critical nature
2462: #
2463:
2464: sub flushcourselogs {
2465: &logthis('Flushing log buffers');
2466: #
2467: # course logs
2468: # This is a log of all transactions in a course, which can be used
2469: # for data mining purposes
2470: #
2471: # It also collects the courseid database, which lists last transaction
2472: # times and course titles for all courseids
2473: #
2474: my %courseidbuffer=();
2475: foreach my $crsid (keys(%courselogs)) {
2476: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2477: &escape($courselogs{$crsid}),
2478: $coursehombuf{$crsid}) eq 'ok') {
2479: delete $courselogs{$crsid};
2480: } else {
2481: &logthis('Failed to flush log buffer for '.$crsid);
2482: if (length($courselogs{$crsid})>40000) {
2483: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2484: " exceeded maximum size, deleting.</font>");
2485: delete $courselogs{$crsid};
2486: }
2487: }
2488: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2489: 'description' => $coursedescrbuf{$crsid},
2490: 'inst_code' => $courseinstcodebuf{$crsid},
2491: 'type' => $coursetypebuf{$crsid},
2492: 'owner' => $courseownerbuf{$crsid},
2493: };
2494: }
2495: #
2496: # Write course id database (reverse lookup) to homeserver of courses
2497: # Is used in pickcourse
2498: #
2499: foreach my $crs_home (keys(%courseidbuffer)) {
2500: my $response = &courseidput(&host_domain($crs_home),
2501: $courseidbuffer{$crs_home},
2502: $crs_home,'timeonly');
2503: }
2504: #
2505: # File accesses
2506: # Writes to the dynamic metadata of resources to get hit counts, etc.
2507: #
2508: foreach my $entry (keys(%accesshash)) {
2509: if ($entry =~ /___count$/) {
2510: my ($dom,$name);
2511: ($dom,$name,undef)=
2512: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2513: if (! defined($dom) || $dom eq '' ||
2514: ! defined($name) || $name eq '') {
2515: my $cid = $env{'request.course.id'};
2516: $dom = $env{'request.'.$cid.'.domain'};
2517: $name = $env{'request.'.$cid.'.num'};
2518: }
2519: my $value = $accesshash{$entry};
2520: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2521: my %temphash=($url => $value);
2522: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2523: if ($result eq 'ok') {
2524: delete $accesshash{$entry};
2525: } elsif ($result eq 'unknown_cmd') {
2526: # Target server has old code running on it.
2527: my %temphash=($entry => $value);
2528: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2529: delete $accesshash{$entry};
2530: }
2531: }
2532: } else {
2533: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2534: my %temphash=($entry => $accesshash{$entry});
2535: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2536: delete $accesshash{$entry};
2537: }
2538: }
2539: }
2540: #
2541: # Roles
2542: # Reverse lookup of user roles for course faculty/staff and co-authorship
2543: #
2544: foreach my $entry (keys(%userrolehash)) {
2545: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2546: split(/\:/,$entry);
2547: if (&Apache::lonnet::put('nohist_userroles',
2548: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2549: $rudom,$runame) eq 'ok') {
2550: delete $userrolehash{$entry};
2551: }
2552: }
2553: #
2554: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2555: #
2556: my %domrolebuffer = ();
2557: foreach my $entry (keys %domainrolehash) {
2558: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2559: if ($domrolebuffer{$rudom}) {
2560: $domrolebuffer{$rudom}.='&'.&escape($entry).
2561: '='.&escape($domainrolehash{$entry});
2562: } else {
2563: $domrolebuffer{$rudom}.=&escape($entry).
2564: '='.&escape($domainrolehash{$entry});
2565: }
2566: delete $domainrolehash{$entry};
2567: }
2568: foreach my $dom (keys(%domrolebuffer)) {
2569: my %servers = &get_servers($dom,'library');
2570: foreach my $tryserver (keys(%servers)) {
2571: unless (&reply('domroleput:'.$dom.':'.
2572: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2573: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2574: }
2575: }
2576: }
2577: $dumpcount++;
2578: }
2579:
2580: sub courselog {
2581: my $what=shift;
2582: $what=time.':'.$what;
2583: unless ($env{'request.course.id'}) { return ''; }
2584: $coursedombuf{$env{'request.course.id'}}=
2585: $env{'course.'.$env{'request.course.id'}.'.domain'};
2586: $coursenumbuf{$env{'request.course.id'}}=
2587: $env{'course.'.$env{'request.course.id'}.'.num'};
2588: $coursehombuf{$env{'request.course.id'}}=
2589: $env{'course.'.$env{'request.course.id'}.'.home'};
2590: $coursedescrbuf{$env{'request.course.id'}}=
2591: $env{'course.'.$env{'request.course.id'}.'.description'};
2592: $courseinstcodebuf{$env{'request.course.id'}}=
2593: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2594: $courseownerbuf{$env{'request.course.id'}}=
2595: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2596: $coursetypebuf{$env{'request.course.id'}}=
2597: $env{'course.'.$env{'request.course.id'}.'.type'};
2598: if (defined $courselogs{$env{'request.course.id'}}) {
2599: $courselogs{$env{'request.course.id'}}.='&'.$what;
2600: } else {
2601: $courselogs{$env{'request.course.id'}}.=$what;
2602: }
2603: if (length($courselogs{$env{'request.course.id'}})>4048) {
2604: &flushcourselogs();
2605: }
2606: }
2607:
2608: sub courseacclog {
2609: my $fnsymb=shift;
2610: unless ($env{'request.course.id'}) { return ''; }
2611: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2612: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2613: $what.=':POST';
2614: # FIXME: Probably ought to escape things....
2615: foreach my $key (keys(%env)) {
2616: if ($key=~/^form\.(.*)/) {
2617: my $formitem = $1;
2618: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2619: $what.=':'.$formitem.'='.$env{$key};
2620: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2621: $what.=':'.$formitem.'='.$env{$key};
2622: }
2623: }
2624: }
2625: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2626: # FIXME: We should not be depending on a form parameter that someone
2627: # editing lonsearchcat.pm might change in the future.
2628: if ($env{'form.phase'} eq 'course_search') {
2629: $what.= ':POST';
2630: # FIXME: Probably ought to escape things....
2631: foreach my $element ('courseexp','crsfulltext','crsrelated',
2632: 'crsdiscuss') {
2633: $what.=':'.$element.'='.$env{'form.'.$element};
2634: }
2635: }
2636: }
2637: &courselog($what);
2638: }
2639:
2640: sub countacc {
2641: my $url=&declutter(shift);
2642: return if (! defined($url) || $url eq '');
2643: unless ($env{'request.course.id'}) { return ''; }
2644: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2645: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2646: $accesshash{$key}++;
2647: }
2648:
2649: sub linklog {
2650: my ($from,$to)=@_;
2651: $from=&declutter($from);
2652: $to=&declutter($to);
2653: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2654: $accesshash{$to.'___'.$from.'___goto'}=1;
2655: }
2656:
2657: sub userrolelog {
2658: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2659: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2660: ($trole=~/^in/) || ($trole=~/^cc/) ||
2661: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2662: ($trole=~/^ta/)) {
2663: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2664: $userrolehash
2665: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2666: =$tend.':'.$tstart;
2667: }
2668: if (($env{'request.role'} =~ /dc\./) &&
2669: (($trole=~/^au/) || ($trole=~/^in/) ||
2670: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2671: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2672: $userrolehash
2673: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2674: =$tend.':'.$tstart;
2675: }
2676: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2677: ($trole=~/^li/) || ($trole=~/^li/) ||
2678: ($trole=~/^au/) || ($trole=~/^dg/) ||
2679: ($trole=~/^sc/)) {
2680: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2681: $domainrolehash
2682: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2683: = $tend.':'.$tstart;
2684: }
2685: }
2686:
2687: sub courserolelog {
2688: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2689: if (($trole eq 'cc') || ($trole eq 'in') ||
2690: ($trole eq 'ep') || ($trole eq 'ad') ||
2691: ($trole eq 'ta') || ($trole eq 'st') ||
2692: ($trole=~/^cr/) || ($trole eq 'gr')) {
2693: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2694: my $cdom = $1;
2695: my $cnum = $2;
2696: my $sec = $3;
2697: my $namespace = 'rolelog';
2698: my %storehash = (
2699: role => $trole,
2700: start => $tstart,
2701: end => $tend,
2702: selfenroll => $selfenroll,
2703: context => $context,
2704: );
2705: if ($trole eq 'gr') {
2706: $namespace = 'groupslog';
2707: $storehash{'group'} = $sec;
2708: } else {
2709: $storehash{'section'} = $sec;
2710: }
2711: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
2712: if (($trole ne 'st') || ($sec ne '')) {
2713: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2714: }
2715: }
2716: }
2717: return;
2718: }
2719:
2720: sub get_course_adv_roles {
2721: my ($cid,$codes) = @_;
2722: $cid=$env{'request.course.id'} unless (defined($cid));
2723: my %coursehash=&coursedescription($cid);
2724: my $crstype = &Apache::loncommon::course_type($cid);
2725: my %nothide=();
2726: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2727: if ($user !~ /:/) {
2728: $nothide{join(':',split(/[\@]/,$user))}=1;
2729: } else {
2730: $nothide{$user}=1;
2731: }
2732: }
2733: my %returnhash=();
2734: my %dumphash=
2735: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2736: my $now=time;
2737: foreach my $entry (keys %dumphash) {
2738: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2739: if (($tstart) && ($tstart<0)) { next; }
2740: if (($tend) && ($tend<$now)) { next; }
2741: if (($tstart) && ($now<$tstart)) { next; }
2742: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2743: if ($username eq '' || $domain eq '') { next; }
2744: if ((&privileged($username,$domain)) &&
2745: (!$nothide{$username.':'.$domain})) { next; }
2746: if ($role eq 'cr') { next; }
2747: if ($codes) {
2748: if ($section) { $role .= ':'.$section; }
2749: if ($returnhash{$role}) {
2750: $returnhash{$role}.=','.$username.':'.$domain;
2751: } else {
2752: $returnhash{$role}=$username.':'.$domain;
2753: }
2754: } else {
2755: my $key=&plaintext($role,$crstype);
2756: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2757: if ($returnhash{$key}) {
2758: $returnhash{$key}.=','.$username.':'.$domain;
2759: } else {
2760: $returnhash{$key}=$username.':'.$domain;
2761: }
2762: }
2763: }
2764: return %returnhash;
2765: }
2766:
2767: sub get_my_roles {
2768: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2769: unless (defined($uname)) { $uname=$env{'user.name'}; }
2770: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2771: my (%dumphash,%nothide);
2772: if ($context eq 'userroles') {
2773: %dumphash = &dump('roles',$udom,$uname);
2774: } else {
2775: %dumphash=
2776: &dump('nohist_userroles',$udom,$uname);
2777: if ($hidepriv) {
2778: my %coursehash=&coursedescription($udom.'_'.$uname);
2779: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2780: if ($user !~ /:/) {
2781: $nothide{join(':',split(/[\@]/,$user))} = 1;
2782: } else {
2783: $nothide{$user} = 1;
2784: }
2785: }
2786: }
2787: }
2788: my %returnhash=();
2789: my $now=time;
2790: foreach my $entry (keys(%dumphash)) {
2791: my ($role,$tend,$tstart);
2792: if ($context eq 'userroles') {
2793: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2794: } else {
2795: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2796: }
2797: if (($tstart) && ($tstart<0)) { next; }
2798: my $status = 'active';
2799: if (($tend) && ($tend<=$now)) {
2800: $status = 'previous';
2801: }
2802: if (($tstart) && ($now<$tstart)) {
2803: $status = 'future';
2804: }
2805: if (ref($types) eq 'ARRAY') {
2806: if (!grep(/^\Q$status\E$/,@{$types})) {
2807: next;
2808: }
2809: } else {
2810: if ($status ne 'active') {
2811: next;
2812: }
2813: }
2814: my ($rolecode,$username,$domain,$section,$area);
2815: if ($context eq 'userroles') {
2816: ($area,$rolecode) = split(/_/,$entry);
2817: (undef,$domain,$username,$section) = split(/\//,$area);
2818: } else {
2819: ($role,$username,$domain,$section) = split(/\:/,$entry);
2820: }
2821: if (ref($roledoms) eq 'ARRAY') {
2822: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2823: next;
2824: }
2825: }
2826: if (ref($roles) eq 'ARRAY') {
2827: if (!grep(/^\Q$role\E$/,@{$roles})) {
2828: if ($role =~ /^cr\//) {
2829: if (!grep(/^cr$/,@{$roles})) {
2830: next;
2831: }
2832: } else {
2833: next;
2834: }
2835: }
2836: }
2837: if ($hidepriv) {
2838: if ((&privileged($username,$domain)) &&
2839: (!$nothide{$username.':'.$domain})) {
2840: next;
2841: }
2842: }
2843: if ($withsec) {
2844: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2845: $tstart.':'.$tend;
2846: } else {
2847: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2848: }
2849: }
2850: return %returnhash;
2851: }
2852:
2853: # ----------------------------------------------------- Frontpage Announcements
2854: #
2855: #
2856:
2857: sub postannounce {
2858: my ($server,$text)=@_;
2859: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2860: unless ($text=~/\w/) { $text=''; }
2861: return &reply('setannounce:'.&escape($text),$server);
2862: }
2863:
2864: sub getannounce {
2865:
2866: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2867: my $announcement='';
2868: while (my $line = <$fh>) { $announcement .= $line; }
2869: close($fh);
2870: if ($announcement=~/\w/) {
2871: return
2872: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2873: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2874: } else {
2875: return '';
2876: }
2877: } else {
2878: return '';
2879: }
2880: }
2881:
2882: # ---------------------------------------------------------- Course ID routines
2883: # Deal with domain's nohist_courseid.db files
2884: #
2885:
2886: sub courseidput {
2887: my ($domain,$storehash,$coursehome,$caller) = @_;
2888: my $outcome;
2889: if ($caller eq 'timeonly') {
2890: my $cids = '';
2891: foreach my $item (keys(%$storehash)) {
2892: $cids.=&escape($item).'&';
2893: }
2894: $cids=~s/\&$//;
2895: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
2896: $coursehome);
2897: } else {
2898: my $items = '';
2899: foreach my $item (keys(%$storehash)) {
2900: $items.= &escape($item).'='.
2901: &freeze_escape($$storehash{$item}).'&';
2902: }
2903: $items=~s/\&$//;
2904: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
2905: $coursehome);
2906: }
2907: if ($outcome eq 'unknown_cmd') {
2908: my $what;
2909: foreach my $cid (keys(%$storehash)) {
2910: $what .= &escape($cid).'=';
2911: foreach my $item ('description','inst_code','owner','type') {
2912: $what .= &escape($storehash->{$cid}{$item}).':';
2913: }
2914: $what =~ s/\:$/&/;
2915: }
2916: $what =~ s/\&$//;
2917: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2918: } else {
2919: return $outcome;
2920: }
2921: }
2922:
2923: sub courseiddump {
2924: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
2925: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
2926: $selfenrollonly,$catfilter,$showhidden,$caller)=@_;
2927: my $as_hash = 1;
2928: my %returnhash;
2929: if (!$domfilter) { $domfilter=''; }
2930: my %libserv = &all_library();
2931: foreach my $tryserver (keys(%libserv)) {
2932: if ( ( $hostidflag == 1
2933: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2934: || (!defined($hostidflag)) ) {
2935:
2936: if (($domfilter eq '') ||
2937: (&host_domain($tryserver) eq $domfilter)) {
2938: my $rep =
2939: &reply('courseiddump:'.&host_domain($tryserver).':'.
2940: $sincefilter.':'.&escape($descfilter).':'.
2941: &escape($instcodefilter).':'.&escape($ownerfilter).
2942: ':'.&escape($coursefilter).':'.&escape($typefilter).
2943: ':'.&escape($regexp_ok).':'.$as_hash.':'.
2944: &escape($selfenrollonly).':'.&escape($catfilter).':'.
2945: $showhidden.':'.$caller,$tryserver);
2946: my @pairs=split(/\&/,$rep);
2947: foreach my $item (@pairs) {
2948: my ($key,$value)=split(/\=/,$item,2);
2949: $key = &unescape($key);
2950: next if ($key =~ /^error: 2 /);
2951: my $result = &thaw_unescape($value);
2952: if (ref($result) eq 'HASH') {
2953: $returnhash{$key}=$result;
2954: } else {
2955: my @responses = split(/:/,$value);
2956: my @items = ('description','inst_code','owner','type');
2957: for (my $i=0; $i<@responses; $i++) {
2958: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
2959: }
2960: }
2961: }
2962: }
2963: }
2964: }
2965: return %returnhash;
2966: }
2967:
2968: # ---------------------------------------------------------- DC e-mail
2969:
2970: sub dcmailput {
2971: my ($domain,$msgid,$message,$server)=@_;
2972: my $status = &Apache::lonnet::critical(
2973: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2974: &escape($message),$server);
2975: return $status;
2976: }
2977:
2978: sub dcmaildump {
2979: my ($dom,$startdate,$enddate,$senders) = @_;
2980: my %returnhash=();
2981:
2982: if (defined(&domain($dom,'primary'))) {
2983: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2984: &escape($enddate).':';
2985: my @esc_senders=map { &escape($_)} @$senders;
2986: $cmd.=&escape(join('&',@esc_senders));
2987: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
2988: my ($key,$value) = split(/\=/,$line,2);
2989: if (($key) && ($value)) {
2990: $returnhash{&unescape($key)} = &unescape($value);
2991: }
2992: }
2993: }
2994: return %returnhash;
2995: }
2996: # ---------------------------------------------------------- Domain roles
2997:
2998: sub get_domain_roles {
2999: my ($dom,$roles,$startdate,$enddate)=@_;
3000: if (undef($startdate) || $startdate eq '') {
3001: $startdate = '.';
3002: }
3003: if (undef($enddate) || $enddate eq '') {
3004: $enddate = '.';
3005: }
3006: my $rolelist;
3007: if (ref($roles) eq 'ARRAY') {
3008: $rolelist = join(':',@{$roles});
3009: }
3010: my %personnel = ();
3011:
3012: my %servers = &get_servers($dom,'library');
3013: foreach my $tryserver (keys(%servers)) {
3014: %{$personnel{$tryserver}}=();
3015: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3016: &escape($startdate).':'.
3017: &escape($enddate).':'.
3018: &escape($rolelist), $tryserver))) {
3019: my ($key,$value) = split(/\=/,$line,2);
3020: if (($key) && ($value)) {
3021: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3022: }
3023: }
3024: }
3025: return %personnel;
3026: }
3027:
3028: # ----------------------------------------------------------- Check out an item
3029:
3030: sub get_first_access {
3031: my ($type,$argsymb)=@_;
3032: my ($symb,$courseid,$udom,$uname)=&whichuser();
3033: if ($argsymb) { $symb=$argsymb; }
3034: my ($map,$id,$res)=&decode_symb($symb);
3035: if ($type eq 'course') {
3036: $res='course';
3037: } elsif ($type eq 'map') {
3038: $res=&symbread($map);
3039: } else {
3040: $res=$symb;
3041: }
3042: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3043: return $times{"$courseid\0$res"};
3044: }
3045:
3046: sub set_first_access {
3047: my ($type)=@_;
3048: my ($symb,$courseid,$udom,$uname)=&whichuser();
3049: my ($map,$id,$res)=&decode_symb($symb);
3050: if ($type eq 'course') {
3051: $res='course';
3052: } elsif ($type eq 'map') {
3053: $res=&symbread($map);
3054: } else {
3055: $res=$symb;
3056: }
3057: my $firstaccess=&get_first_access($type,$symb);
3058: if (!$firstaccess) {
3059: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3060: }
3061: return 'already_set';
3062: }
3063:
3064: sub checkout {
3065: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3066: my $now=time;
3067: my $lonhost=$perlvar{'lonHostID'};
3068: my $infostr=&escape(
3069: 'CHECKOUTTOKEN&'.
3070: $tuname.'&'.
3071: $tudom.'&'.
3072: $tcrsid.'&'.
3073: $symb.'&'.
3074: $now.'&'.$ENV{'REMOTE_ADDR'});
3075: my $token=&reply('tmpput:'.$infostr,$lonhost);
3076: if ($token=~/^error\:/) {
3077: &logthis("<font color=\"blue\">WARNING: ".
3078: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3079: "</font>");
3080: return '';
3081: }
3082:
3083: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3084: $token=~tr/a-z/A-Z/;
3085:
3086: my %infohash=('resource.0.outtoken' => $token,
3087: 'resource.0.checkouttime' => $now,
3088: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
3089:
3090: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3091: return '';
3092: } else {
3093: &logthis("<font color=\"blue\">WARNING: ".
3094: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3095: "</font>");
3096: }
3097:
3098: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3099: &escape('Checkout '.$infostr.' - '.
3100: $token)) ne 'ok') {
3101: return '';
3102: } else {
3103: &logthis("<font color=\"blue\">WARNING: ".
3104: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3105: "</font>");
3106: }
3107: return $token;
3108: }
3109:
3110: # ------------------------------------------------------------ Check in an item
3111:
3112: sub checkin {
3113: my $token=shift;
3114: my $now=time;
3115: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3116: $lonhost=~tr/A-Z/a-z/;
3117: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
3118: $dtoken=~s/\W/\_/g;
3119: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
3120: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3121:
3122: unless (($tuname) && ($tudom)) {
3123: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3124: return '';
3125: }
3126:
3127: unless (&allowed('mgr',$tcrsid)) {
3128: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
3129: $env{'user.name'}.' - '.$env{'user.domain'});
3130: return '';
3131: }
3132:
3133: my %infohash=('resource.0.intoken' => $token,
3134: 'resource.0.checkintime' => $now,
3135: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
3136:
3137: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3138: return '';
3139: }
3140:
3141: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3142: &escape('Checkin - '.$token)) ne 'ok') {
3143: return '';
3144: }
3145:
3146: return ($symb,$tuname,$tudom,$tcrsid);
3147: }
3148:
3149: # --------------------------------------------- Set Expire Date for Spreadsheet
3150:
3151: sub expirespread {
3152: my ($uname,$udom,$stype,$usymb)=@_;
3153: my $cid=$env{'request.course.id'};
3154: if ($cid) {
3155: my $now=time;
3156: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3157: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3158: $env{'course.'.$cid.'.num'}.
3159: ':nohist_expirationdates:'.
3160: &escape($key).'='.$now,
3161: $env{'course.'.$cid.'.home'})
3162: }
3163: return 'ok';
3164: }
3165:
3166: # ----------------------------------------------------- Devalidate Spreadsheets
3167:
3168: sub devalidate {
3169: my ($symb,$uname,$udom)=@_;
3170: my $cid=$env{'request.course.id'};
3171: if ($cid) {
3172: # delete the stored spreadsheets for
3173: # - the student level sheet of this user in course's homespace
3174: # - the assessment level sheet for this resource
3175: # for this user in user's homespace
3176: # - current conditional state info
3177: my $key=$uname.':'.$udom.':';
3178: my $status=
3179: &del('nohist_calculatedsheets',
3180: [$key.'studentcalc:'],
3181: $env{'course.'.$cid.'.domain'},
3182: $env{'course.'.$cid.'.num'})
3183: .' '.
3184: &del('nohist_calculatedsheets_'.$cid,
3185: [$key.'assesscalc:'.$symb],$udom,$uname);
3186: unless ($status eq 'ok ok') {
3187: &logthis('Could not devalidate spreadsheet '.
3188: $uname.' at '.$udom.' for '.
3189: $symb.': '.$status);
3190: }
3191: &delenv('user.state.'.$cid);
3192: }
3193: }
3194:
3195: sub get_scalar {
3196: my ($string,$end) = @_;
3197: my $value;
3198: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3199: $value = $1;
3200: } elsif ($$string =~ s/^([^&]*?)&//) {
3201: $value = $1;
3202: }
3203: return &unescape($value);
3204: }
3205:
3206: sub array2str {
3207: my (@array) = @_;
3208: my $result=&arrayref2str(\@array);
3209: $result=~s/^__ARRAY_REF__//;
3210: $result=~s/__END_ARRAY_REF__$//;
3211: return $result;
3212: }
3213:
3214: sub arrayref2str {
3215: my ($arrayref) = @_;
3216: my $result='__ARRAY_REF__';
3217: foreach my $elem (@$arrayref) {
3218: if(ref($elem) eq 'ARRAY') {
3219: $result.=&arrayref2str($elem).'&';
3220: } elsif(ref($elem) eq 'HASH') {
3221: $result.=&hashref2str($elem).'&';
3222: } elsif(ref($elem)) {
3223: #print("Got a ref of ".(ref($elem))." skipping.");
3224: } else {
3225: $result.=&escape($elem).'&';
3226: }
3227: }
3228: $result=~s/\&$//;
3229: $result .= '__END_ARRAY_REF__';
3230: return $result;
3231: }
3232:
3233: sub hash2str {
3234: my (%hash) = @_;
3235: my $result=&hashref2str(\%hash);
3236: $result=~s/^__HASH_REF__//;
3237: $result=~s/__END_HASH_REF__$//;
3238: return $result;
3239: }
3240:
3241: sub hashref2str {
3242: my ($hashref)=@_;
3243: my $result='__HASH_REF__';
3244: foreach my $key (sort(keys(%$hashref))) {
3245: if (ref($key) eq 'ARRAY') {
3246: $result.=&arrayref2str($key).'=';
3247: } elsif (ref($key) eq 'HASH') {
3248: $result.=&hashref2str($key).'=';
3249: } elsif (ref($key)) {
3250: $result.='=';
3251: #print("Got a ref of ".(ref($key))." skipping.");
3252: } else {
3253: if ($key) {$result.=&escape($key).'=';} else { last; }
3254: }
3255:
3256: if(ref($hashref->{$key}) eq 'ARRAY') {
3257: $result.=&arrayref2str($hashref->{$key}).'&';
3258: } elsif(ref($hashref->{$key}) eq 'HASH') {
3259: $result.=&hashref2str($hashref->{$key}).'&';
3260: } elsif(ref($hashref->{$key})) {
3261: $result.='&';
3262: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3263: } else {
3264: $result.=&escape($hashref->{$key}).'&';
3265: }
3266: }
3267: $result=~s/\&$//;
3268: $result .= '__END_HASH_REF__';
3269: return $result;
3270: }
3271:
3272: sub str2hash {
3273: my ($string)=@_;
3274: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3275: return %$hash;
3276: }
3277:
3278: sub str2hashref {
3279: my ($string) = @_;
3280:
3281: my %hash;
3282:
3283: if($string !~ /^__HASH_REF__/) {
3284: if (! ($string eq '' || !defined($string))) {
3285: $hash{'error'}='Not hash reference';
3286: }
3287: return (\%hash, $string);
3288: }
3289:
3290: $string =~ s/^__HASH_REF__//;
3291:
3292: while($string !~ /^__END_HASH_REF__/) {
3293: #key
3294: my $key='';
3295: if($string =~ /^__HASH_REF__/) {
3296: ($key, $string)=&str2hashref($string);
3297: if(defined($key->{'error'})) {
3298: $hash{'error'}='Bad data';
3299: return (\%hash, $string);
3300: }
3301: } elsif($string =~ /^__ARRAY_REF__/) {
3302: ($key, $string)=&str2arrayref($string);
3303: if($key->[0] eq 'Array reference error') {
3304: $hash{'error'}='Bad data';
3305: return (\%hash, $string);
3306: }
3307: } else {
3308: $string =~ s/^(.*?)=//;
3309: $key=&unescape($1);
3310: }
3311: $string =~ s/^=//;
3312:
3313: #value
3314: my $value='';
3315: if($string =~ /^__HASH_REF__/) {
3316: ($value, $string)=&str2hashref($string);
3317: if(defined($value->{'error'})) {
3318: $hash{'error'}='Bad data';
3319: return (\%hash, $string);
3320: }
3321: } elsif($string =~ /^__ARRAY_REF__/) {
3322: ($value, $string)=&str2arrayref($string);
3323: if($value->[0] eq 'Array reference error') {
3324: $hash{'error'}='Bad data';
3325: return (\%hash, $string);
3326: }
3327: } else {
3328: $value=&get_scalar(\$string,'__END_HASH_REF__');
3329: }
3330: $string =~ s/^&//;
3331:
3332: $hash{$key}=$value;
3333: }
3334:
3335: $string =~ s/^__END_HASH_REF__//;
3336:
3337: return (\%hash, $string);
3338: }
3339:
3340: sub str2array {
3341: my ($string)=@_;
3342: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3343: return @$array;
3344: }
3345:
3346: sub str2arrayref {
3347: my ($string) = @_;
3348: my @array;
3349:
3350: if($string !~ /^__ARRAY_REF__/) {
3351: if (! ($string eq '' || !defined($string))) {
3352: $array[0]='Array reference error';
3353: }
3354: return (\@array, $string);
3355: }
3356:
3357: $string =~ s/^__ARRAY_REF__//;
3358:
3359: while($string !~ /^__END_ARRAY_REF__/) {
3360: my $value='';
3361: if($string =~ /^__HASH_REF__/) {
3362: ($value, $string)=&str2hashref($string);
3363: if(defined($value->{'error'})) {
3364: $array[0] ='Array reference error';
3365: return (\@array, $string);
3366: }
3367: } elsif($string =~ /^__ARRAY_REF__/) {
3368: ($value, $string)=&str2arrayref($string);
3369: if($value->[0] eq 'Array reference error') {
3370: $array[0] ='Array reference error';
3371: return (\@array, $string);
3372: }
3373: } else {
3374: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3375: }
3376: $string =~ s/^&//;
3377:
3378: push(@array, $value);
3379: }
3380:
3381: $string =~ s/^__END_ARRAY_REF__//;
3382:
3383: return (\@array, $string);
3384: }
3385:
3386: # -------------------------------------------------------------------Temp Store
3387:
3388: sub tmpreset {
3389: my ($symb,$namespace,$domain,$stuname) = @_;
3390: if (!$symb) {
3391: $symb=&symbread();
3392: if (!$symb) { $symb= $env{'request.url'}; }
3393: }
3394: $symb=escape($symb);
3395:
3396: if (!$namespace) { $namespace=$env{'request.state'}; }
3397: $namespace=~s/\//\_/g;
3398: $namespace=~s/\W//g;
3399:
3400: if (!$domain) { $domain=$env{'user.domain'}; }
3401: if (!$stuname) { $stuname=$env{'user.name'}; }
3402: if ($domain eq 'public' && $stuname eq 'public') {
3403: $stuname=$ENV{'REMOTE_ADDR'};
3404: }
3405: my $path=$perlvar{'lonDaemons'}.'/tmp';
3406: my %hash;
3407: if (tie(%hash,'GDBM_File',
3408: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3409: &GDBM_WRCREAT(),0640)) {
3410: foreach my $key (keys %hash) {
3411: if ($key=~ /:$symb/) {
3412: delete($hash{$key});
3413: }
3414: }
3415: }
3416: }
3417:
3418: sub tmpstore {
3419: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3420:
3421: if (!$symb) {
3422: $symb=&symbread();
3423: if (!$symb) { $symb= $env{'request.url'}; }
3424: }
3425: $symb=escape($symb);
3426:
3427: if (!$namespace) {
3428: # I don't think we would ever want to store this for a course.
3429: # it seems this will only be used if we don't have a course.
3430: #$namespace=$env{'request.course.id'};
3431: #if (!$namespace) {
3432: $namespace=$env{'request.state'};
3433: #}
3434: }
3435: $namespace=~s/\//\_/g;
3436: $namespace=~s/\W//g;
3437: if (!$domain) { $domain=$env{'user.domain'}; }
3438: if (!$stuname) { $stuname=$env{'user.name'}; }
3439: if ($domain eq 'public' && $stuname eq 'public') {
3440: $stuname=$ENV{'REMOTE_ADDR'};
3441: }
3442: my $now=time;
3443: my %hash;
3444: my $path=$perlvar{'lonDaemons'}.'/tmp';
3445: if (tie(%hash,'GDBM_File',
3446: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3447: &GDBM_WRCREAT(),0640)) {
3448: $hash{"version:$symb"}++;
3449: my $version=$hash{"version:$symb"};
3450: my $allkeys='';
3451: foreach my $key (keys(%$storehash)) {
3452: $allkeys.=$key.':';
3453: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3454: }
3455: $hash{"$version:$symb:timestamp"}=$now;
3456: $allkeys.='timestamp';
3457: $hash{"$version:keys:$symb"}=$allkeys;
3458: if (untie(%hash)) {
3459: return 'ok';
3460: } else {
3461: return "error:$!";
3462: }
3463: } else {
3464: return "error:$!";
3465: }
3466: }
3467:
3468: # -----------------------------------------------------------------Temp Restore
3469:
3470: sub tmprestore {
3471: my ($symb,$namespace,$domain,$stuname) = @_;
3472:
3473: if (!$symb) {
3474: $symb=&symbread();
3475: if (!$symb) { $symb= $env{'request.url'}; }
3476: }
3477: $symb=escape($symb);
3478:
3479: if (!$namespace) { $namespace=$env{'request.state'}; }
3480:
3481: if (!$domain) { $domain=$env{'user.domain'}; }
3482: if (!$stuname) { $stuname=$env{'user.name'}; }
3483: if ($domain eq 'public' && $stuname eq 'public') {
3484: $stuname=$ENV{'REMOTE_ADDR'};
3485: }
3486: my %returnhash;
3487: $namespace=~s/\//\_/g;
3488: $namespace=~s/\W//g;
3489: my %hash;
3490: my $path=$perlvar{'lonDaemons'}.'/tmp';
3491: if (tie(%hash,'GDBM_File',
3492: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3493: &GDBM_READER(),0640)) {
3494: my $version=$hash{"version:$symb"};
3495: $returnhash{'version'}=$version;
3496: my $scope;
3497: for ($scope=1;$scope<=$version;$scope++) {
3498: my $vkeys=$hash{"$scope:keys:$symb"};
3499: my @keys=split(/:/,$vkeys);
3500: my $key;
3501: $returnhash{"$scope:keys"}=$vkeys;
3502: foreach $key (@keys) {
3503: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3504: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3505: }
3506: }
3507: if (!(untie(%hash))) {
3508: return "error:$!";
3509: }
3510: } else {
3511: return "error:$!";
3512: }
3513: return %returnhash;
3514: }
3515:
3516: # ----------------------------------------------------------------------- Store
3517:
3518: sub store {
3519: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3520: my $home='';
3521:
3522: if ($stuname) { $home=&homeserver($stuname,$domain); }
3523:
3524: $symb=&symbclean($symb);
3525: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3526:
3527: if (!$domain) { $domain=$env{'user.domain'}; }
3528: if (!$stuname) { $stuname=$env{'user.name'}; }
3529:
3530: &devalidate($symb,$stuname,$domain);
3531:
3532: $symb=escape($symb);
3533: if (!$namespace) {
3534: unless ($namespace=$env{'request.course.id'}) {
3535: return '';
3536: }
3537: }
3538: if (!$home) { $home=$env{'user.home'}; }
3539:
3540: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3541: $$storehash{'host'}=$perlvar{'lonHostID'};
3542:
3543: my $namevalue='';
3544: foreach my $key (keys(%$storehash)) {
3545: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3546: }
3547: $namevalue=~s/\&$//;
3548: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3549: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3550: }
3551:
3552: # -------------------------------------------------------------- Critical Store
3553:
3554: sub cstore {
3555: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3556: my $home='';
3557:
3558: if ($stuname) { $home=&homeserver($stuname,$domain); }
3559:
3560: $symb=&symbclean($symb);
3561: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3562:
3563: if (!$domain) { $domain=$env{'user.domain'}; }
3564: if (!$stuname) { $stuname=$env{'user.name'}; }
3565:
3566: &devalidate($symb,$stuname,$domain);
3567:
3568: $symb=escape($symb);
3569: if (!$namespace) {
3570: unless ($namespace=$env{'request.course.id'}) {
3571: return '';
3572: }
3573: }
3574: if (!$home) { $home=$env{'user.home'}; }
3575:
3576: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3577: $$storehash{'host'}=$perlvar{'lonHostID'};
3578:
3579: my $namevalue='';
3580: foreach my $key (keys(%$storehash)) {
3581: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3582: }
3583: $namevalue=~s/\&$//;
3584: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3585: return critical
3586: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3587: }
3588:
3589: # --------------------------------------------------------------------- Restore
3590:
3591: sub restore {
3592: my ($symb,$namespace,$domain,$stuname) = @_;
3593: my $home='';
3594:
3595: if ($stuname) { $home=&homeserver($stuname,$domain); }
3596:
3597: if (!$symb) {
3598: unless ($symb=escape(&symbread())) { return ''; }
3599: } else {
3600: $symb=&escape(&symbclean($symb));
3601: }
3602: if (!$namespace) {
3603: unless ($namespace=$env{'request.course.id'}) {
3604: return '';
3605: }
3606: }
3607: if (!$domain) { $domain=$env{'user.domain'}; }
3608: if (!$stuname) { $stuname=$env{'user.name'}; }
3609: if (!$home) { $home=$env{'user.home'}; }
3610: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3611:
3612: my %returnhash=();
3613: foreach my $line (split(/\&/,$answer)) {
3614: my ($name,$value)=split(/\=/,$line);
3615: $returnhash{&unescape($name)}=&thaw_unescape($value);
3616: }
3617: my $version;
3618: for ($version=1;$version<=$returnhash{'version'};$version++) {
3619: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3620: $returnhash{$item}=$returnhash{$version.':'.$item};
3621: }
3622: }
3623: return %returnhash;
3624: }
3625:
3626: # ---------------------------------------------------------- Course Description
3627:
3628: sub coursedescription {
3629: my ($courseid,$args)=@_;
3630: $courseid=~s/^\///;
3631: $courseid=~s/\_/\//g;
3632: my ($cdomain,$cnum)=split(/\//,$courseid);
3633: my $chome=&homeserver($cnum,$cdomain);
3634: my $normalid=$cdomain.'_'.$cnum;
3635: # need to always cache even if we get errors otherwise we keep
3636: # trying and trying and trying to get the course description.
3637: my %envhash=();
3638: my %returnhash=();
3639:
3640: my $expiretime=600;
3641: if ($env{'request.course.id'} eq $normalid) {
3642: $expiretime=120;
3643: }
3644:
3645: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3646: if (!$args->{'freshen_cache'}
3647: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3648: foreach my $key (keys(%env)) {
3649: next if ($key !~ /^\Q$prefix\E(.*)/);
3650: my ($setting) = $1;
3651: $returnhash{$setting} = $env{$key};
3652: }
3653: return %returnhash;
3654: }
3655:
3656: # get the data agin
3657: if (!$args->{'one_time'}) {
3658: $envhash{'course.'.$normalid.'.last_cache'}=time;
3659: }
3660:
3661: if ($chome ne 'no_host') {
3662: %returnhash=&dump('environment',$cdomain,$cnum);
3663: if (!exists($returnhash{'con_lost'})) {
3664: $returnhash{'home'}= $chome;
3665: $returnhash{'domain'} = $cdomain;
3666: $returnhash{'num'} = $cnum;
3667: if (!defined($returnhash{'type'})) {
3668: $returnhash{'type'} = 'Course';
3669: }
3670: while (my ($name,$value) = each %returnhash) {
3671: $envhash{'course.'.$normalid.'.'.$name}=$value;
3672: }
3673: $returnhash{'url'}=&clutter($returnhash{'url'});
3674: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3675: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3676: $envhash{'course.'.$normalid.'.home'}=$chome;
3677: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3678: $envhash{'course.'.$normalid.'.num'}=$cnum;
3679: }
3680: }
3681: if (!$args->{'one_time'}) {
3682: &appenv(\%envhash);
3683: }
3684: return %returnhash;
3685: }
3686:
3687: # -------------------------------------------------See if a user is privileged
3688:
3689: sub privileged {
3690: my ($username,$domain)=@_;
3691: my $rolesdump=&reply("dump:$domain:$username:roles",
3692: &homeserver($username,$domain));
3693: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3694: my $now=time;
3695: if ($rolesdump ne '') {
3696: foreach my $entry (split(/&/,$rolesdump)) {
3697: if ($entry!~/^rolesdef_/) {
3698: my ($area,$role)=split(/=/,$entry);
3699: $area=~s/\_\w\w$//;
3700: my ($trole,$tend,$tstart)=split(/_/,$role);
3701: if (($trole eq 'dc') || ($trole eq 'su')) {
3702: my $active=1;
3703: if ($tend) {
3704: if ($tend<$now) { $active=0; }
3705: }
3706: if ($tstart) {
3707: if ($tstart>$now) { $active=0; }
3708: }
3709: if ($active) { return 1; }
3710: }
3711: }
3712: }
3713: }
3714: return 0;
3715: }
3716:
3717: # -------------------------------------------------------- Get user privileges
3718:
3719: sub rolesinit {
3720: my ($domain,$username,$authhost)=@_;
3721: my %userroles;
3722: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3723: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return \%userroles; }
3724: my %allroles=();
3725: my %allgroups=();
3726: my $now=time;
3727: %userroles = ('user.login.time' => $now);
3728: my $group_privs;
3729:
3730: if ($rolesdump ne '') {
3731: foreach my $entry (split(/&/,$rolesdump)) {
3732: if ($entry!~/^rolesdef_/) {
3733: my ($area,$role)=split(/=/,$entry);
3734: $area=~s/\_\w\w$//;
3735: my ($trole,$tend,$tstart,$group_privs);
3736: if ($role=~/^cr/) {
3737: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3738: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3739: ($tend,$tstart)=split('_',$trest);
3740: } else {
3741: $trole=$role;
3742: }
3743: } elsif ($role =~ m|^gr/|) {
3744: ($trole,$tend,$tstart) = split(/_/,$role);
3745: ($trole,$group_privs) = split(/\//,$trole);
3746: $group_privs = &unescape($group_privs);
3747: } else {
3748: ($trole,$tend,$tstart)=split(/_/,$role);
3749: }
3750: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3751: $username);
3752: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3753: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3754: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3755: if (($area ne '') && ($trole ne '')) {
3756: my $spec=$trole.'.'.$area;
3757: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3758: if ($trole =~ /^cr\//) {
3759: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3760: } elsif ($trole eq 'gr') {
3761: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3762: } else {
3763: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3764: }
3765: }
3766: }
3767: }
3768: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3769: $userroles{'user.adv'} = $adv;
3770: $userroles{'user.author'} = $author;
3771: $env{'user.adv'}=$adv;
3772: }
3773: return \%userroles;
3774: }
3775:
3776: sub set_arearole {
3777: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3778: # log the associated role with the area
3779: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3780: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3781: }
3782:
3783: sub custom_roleprivs {
3784: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3785: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3786: my $homsvr=homeserver($rauthor,$rdomain);
3787: if (&hostname($homsvr) ne '') {
3788: my ($rdummy,$roledef)=
3789: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3790: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3791: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3792: if (defined($syspriv)) {
3793: $$allroles{'cm./'}.=':'.$syspriv;
3794: $$allroles{$spec.'./'}.=':'.$syspriv;
3795: }
3796: if ($tdomain ne '') {
3797: if (defined($dompriv)) {
3798: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3799: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3800: }
3801: if (($trest ne '') && (defined($coursepriv))) {
3802: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3803: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3804: }
3805: }
3806: }
3807: }
3808: }
3809:
3810: sub group_roleprivs {
3811: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3812: my $access = 1;
3813: my $now = time;
3814: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3815: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3816: if ($access) {
3817: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3818: $$allgroups{$course}{$group} .=':'.$group_privs;
3819: }
3820: }
3821:
3822: sub standard_roleprivs {
3823: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3824: if (defined($pr{$trole.':s'})) {
3825: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3826: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3827: }
3828: if ($tdomain ne '') {
3829: if (defined($pr{$trole.':d'})) {
3830: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3831: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3832: }
3833: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3834: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3835: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3836: }
3837: }
3838: }
3839:
3840: sub set_userprivs {
3841: my ($userroles,$allroles,$allgroups) = @_;
3842: my $author=0;
3843: my $adv=0;
3844: my %grouproles = ();
3845: if (keys(%{$allgroups}) > 0) {
3846: foreach my $role (keys %{$allroles}) {
3847: my ($trole,$area,$sec,$extendedarea);
3848: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3849: $trole = $1;
3850: $area = $2;
3851: $sec = $3;
3852: $extendedarea = $area.$sec;
3853: if (exists($$allgroups{$area})) {
3854: foreach my $group (keys(%{$$allgroups{$area}})) {
3855: my $spec = $trole.'.'.$extendedarea;
3856: $grouproles{$spec.'.'.$area.'/'.$group} =
3857: $$allgroups{$area}{$group};
3858: }
3859: }
3860: }
3861: }
3862: }
3863: foreach my $group (keys(%grouproles)) {
3864: $$allroles{$group} = $grouproles{$group};
3865: }
3866: foreach my $role (keys(%{$allroles})) {
3867: my %thesepriv;
3868: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
3869: foreach my $item (split(/:/,$$allroles{$role})) {
3870: if ($item ne '') {
3871: my ($privilege,$restrictions)=split(/&/,$item);
3872: if ($restrictions eq '') {
3873: $thesepriv{$privilege}='F';
3874: } elsif ($thesepriv{$privilege} ne 'F') {
3875: $thesepriv{$privilege}.=$restrictions;
3876: }
3877: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3878: }
3879: }
3880: my $thesestr='';
3881: foreach my $priv (keys(%thesepriv)) {
3882: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3883: }
3884: $userroles->{'user.priv.'.$role} = $thesestr;
3885: }
3886: return ($author,$adv);
3887: }
3888:
3889: sub role_status {
3890: my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
3891: my @pwhere = ();
3892: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
3893: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
3894: unless (!defined($$role) || $$role eq '') {
3895: $$where=join('.',@pwhere);
3896: $$trolecode=$$role.'.'.$$where;
3897: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
3898: $$tstatus='is';
3899: if ($$tstart && $$tstart>$then) {
3900: $$tstatus='future';
3901: if ($$tstart<$now) { $$tstatus='will'; }
3902: }
3903: if ($$tend) {
3904: if ($$tend<$then) {
3905: $$tstatus='expired';
3906: } elsif ($$tend<$now) {
3907: $$tstatus='will_not';
3908: }
3909: }
3910: }
3911: }
3912: }
3913:
3914: sub check_adhoc_privs {
3915: my ($cdom,$cnum,$then,$now,$checkrole) = @_;
3916: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
3917: if ($env{$cckey}) {
3918: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
3919: &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
3920: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
3921: &set_adhoc_privileges($cdom,$cnum,$checkrole);
3922: }
3923: } else {
3924: &set_adhoc_privileges($cdom,$cnum,$checkrole);
3925: }
3926: }
3927:
3928: sub set_adhoc_privileges {
3929: # role can be cc or ca
3930: my ($dcdom,$pickedcourse,$role) = @_;
3931: my $area = '/'.$dcdom.'/'.$pickedcourse;
3932: my $spec = $role.'.'.$area;
3933: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
3934: $env{'user.name'});
3935: my %ccrole = ();
3936: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
3937: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
3938: &appenv(\%userroles,[$role,'cm']);
3939: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
3940: &appenv( {'request.role' => $spec,
3941: 'request.role.domain' => $dcdom,
3942: 'request.course.sec' => ''
3943: }
3944: );
3945: my $tadv=0;
3946: if (&allowed('adv') eq 'F') { $tadv=1; }
3947: &appenv({'request.role.adv' => $tadv});
3948: }
3949:
3950: # --------------------------------------------------------------- get interface
3951:
3952: sub get {
3953: my ($namespace,$storearr,$udomain,$uname)=@_;
3954: my $items='';
3955: foreach my $item (@$storearr) {
3956: $items.=&escape($item).'&';
3957: }
3958: $items=~s/\&$//;
3959: if (!$udomain) { $udomain=$env{'user.domain'}; }
3960: if (!$uname) { $uname=$env{'user.name'}; }
3961: my $uhome=&homeserver($uname,$udomain);
3962:
3963: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
3964: my @pairs=split(/\&/,$rep);
3965: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3966: return @pairs;
3967: }
3968: my %returnhash=();
3969: my $i=0;
3970: foreach my $item (@$storearr) {
3971: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3972: $i++;
3973: }
3974: return %returnhash;
3975: }
3976:
3977: # --------------------------------------------------------------- del interface
3978:
3979: sub del {
3980: my ($namespace,$storearr,$udomain,$uname)=@_;
3981: my $items='';
3982: foreach my $item (@$storearr) {
3983: $items.=&escape($item).'&';
3984: }
3985:
3986: $items=~s/\&$//;
3987: if (!$udomain) { $udomain=$env{'user.domain'}; }
3988: if (!$uname) { $uname=$env{'user.name'}; }
3989: my $uhome=&homeserver($uname,$udomain);
3990: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3991: }
3992:
3993: # -------------------------------------------------------------- dump interface
3994:
3995: sub dump {
3996: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3997: if (!$udomain) { $udomain=$env{'user.domain'}; }
3998: if (!$uname) { $uname=$env{'user.name'}; }
3999: my $uhome=&homeserver($uname,$udomain);
4000: if ($regexp) {
4001: $regexp=&escape($regexp);
4002: } else {
4003: $regexp='.';
4004: }
4005: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4006: my @pairs=split(/\&/,$rep);
4007: my %returnhash=();
4008: foreach my $item (@pairs) {
4009: my ($key,$value)=split(/=/,$item,2);
4010: $key = &unescape($key);
4011: next if ($key =~ /^error: 2 /);
4012: $returnhash{$key}=&thaw_unescape($value);
4013: }
4014: return %returnhash;
4015: }
4016:
4017: # --------------------------------------------------------- dumpstore interface
4018:
4019: sub dumpstore {
4020: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4021: if (!$udomain) { $udomain=$env{'user.domain'}; }
4022: if (!$uname) { $uname=$env{'user.name'}; }
4023: my $uhome=&homeserver($uname,$udomain);
4024: if ($regexp) {
4025: $regexp=&escape($regexp);
4026: } else {
4027: $regexp='.';
4028: }
4029: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4030: my @pairs=split(/\&/,$rep);
4031: my %returnhash=();
4032: foreach my $item (@pairs) {
4033: my ($key,$value)=split(/=/,$item,2);
4034: next if ($key =~ /^error: 2 /);
4035: $returnhash{$key}=&thaw_unescape($value);
4036: }
4037: return %returnhash;
4038: }
4039:
4040: # -------------------------------------------------------------- keys interface
4041:
4042: sub getkeys {
4043: my ($namespace,$udomain,$uname)=@_;
4044: if (!$udomain) { $udomain=$env{'user.domain'}; }
4045: if (!$uname) { $uname=$env{'user.name'}; }
4046: my $uhome=&homeserver($uname,$udomain);
4047: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4048: my @keyarray=();
4049: foreach my $key (split(/\&/,$rep)) {
4050: next if ($key =~ /^error: 2 /);
4051: push(@keyarray,&unescape($key));
4052: }
4053: return @keyarray;
4054: }
4055:
4056: # --------------------------------------------------------------- currentdump
4057: sub currentdump {
4058: my ($courseid,$sdom,$sname)=@_;
4059: $courseid = $env{'request.course.id'} if (! defined($courseid));
4060: $sdom = $env{'user.domain'} if (! defined($sdom));
4061: $sname = $env{'user.name'} if (! defined($sname));
4062: my $uhome = &homeserver($sname,$sdom);
4063: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4064: return if ($rep =~ /^(error:|no_such_host)/);
4065: #
4066: my %returnhash=();
4067: #
4068: if ($rep eq "unknown_cmd") {
4069: # an old lond will not know currentdump
4070: # Do a dump and make it look like a currentdump
4071: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4072: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4073: my %hash = @tmp;
4074: @tmp=();
4075: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4076: } else {
4077: my @pairs=split(/\&/,$rep);
4078: foreach my $pair (@pairs) {
4079: my ($key,$value)=split(/=/,$pair,2);
4080: my ($symb,$param) = split(/:/,$key);
4081: $returnhash{&unescape($symb)}->{&unescape($param)} =
4082: &thaw_unescape($value);
4083: }
4084: }
4085: return %returnhash;
4086: }
4087:
4088: sub convert_dump_to_currentdump{
4089: my %hash = %{shift()};
4090: my %returnhash;
4091: # Code ripped from lond, essentially. The only difference
4092: # here is the unescaping done by lonnet::dump(). Conceivably
4093: # we might run in to problems with parameter names =~ /^v\./
4094: while (my ($key,$value) = each(%hash)) {
4095: my ($v,$symb,$param) = split(/:/,$key);
4096: $symb = &unescape($symb);
4097: $param = &unescape($param);
4098: next if ($v eq 'version' || $symb eq 'keys');
4099: next if (exists($returnhash{$symb}) &&
4100: exists($returnhash{$symb}->{$param}) &&
4101: $returnhash{$symb}->{'v.'.$param} > $v);
4102: $returnhash{$symb}->{$param}=$value;
4103: $returnhash{$symb}->{'v.'.$param}=$v;
4104: }
4105: #
4106: # Remove all of the keys in the hashes which keep track of
4107: # the version of the parameter.
4108: while (my ($symb,$param_hash) = each(%returnhash)) {
4109: # use a foreach because we are going to delete from the hash.
4110: foreach my $key (keys(%$param_hash)) {
4111: delete($param_hash->{$key}) if ($key =~ /^v\./);
4112: }
4113: }
4114: return \%returnhash;
4115: }
4116:
4117: # ------------------------------------------------------ critical inc interface
4118:
4119: sub cinc {
4120: return &inc(@_,'critical');
4121: }
4122:
4123: # --------------------------------------------------------------- inc interface
4124:
4125: sub inc {
4126: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4127: if (!$udomain) { $udomain=$env{'user.domain'}; }
4128: if (!$uname) { $uname=$env{'user.name'}; }
4129: my $uhome=&homeserver($uname,$udomain);
4130: my $items='';
4131: if (! ref($store)) {
4132: # got a single value, so use that instead
4133: $items = &escape($store).'=&';
4134: } elsif (ref($store) eq 'SCALAR') {
4135: $items = &escape($$store).'=&';
4136: } elsif (ref($store) eq 'ARRAY') {
4137: $items = join('=&',map {&escape($_);} @{$store});
4138: } elsif (ref($store) eq 'HASH') {
4139: while (my($key,$value) = each(%{$store})) {
4140: $items.= &escape($key).'='.&escape($value).'&';
4141: }
4142: }
4143: $items=~s/\&$//;
4144: if ($critical) {
4145: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4146: } else {
4147: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4148: }
4149: }
4150:
4151: # --------------------------------------------------------------- put interface
4152:
4153: sub put {
4154: my ($namespace,$storehash,$udomain,$uname)=@_;
4155: if (!$udomain) { $udomain=$env{'user.domain'}; }
4156: if (!$uname) { $uname=$env{'user.name'}; }
4157: my $uhome=&homeserver($uname,$udomain);
4158: my $items='';
4159: foreach my $item (keys(%$storehash)) {
4160: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4161: }
4162: $items=~s/\&$//;
4163: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4164: }
4165:
4166: # ------------------------------------------------------------ newput interface
4167:
4168: sub newput {
4169: my ($namespace,$storehash,$udomain,$uname)=@_;
4170: if (!$udomain) { $udomain=$env{'user.domain'}; }
4171: if (!$uname) { $uname=$env{'user.name'}; }
4172: my $uhome=&homeserver($uname,$udomain);
4173: my $items='';
4174: foreach my $key (keys(%$storehash)) {
4175: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4176: }
4177: $items=~s/\&$//;
4178: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4179: }
4180:
4181: # --------------------------------------------------------- putstore interface
4182:
4183: sub putstore {
4184: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4185: if (!$udomain) { $udomain=$env{'user.domain'}; }
4186: if (!$uname) { $uname=$env{'user.name'}; }
4187: my $uhome=&homeserver($uname,$udomain);
4188: my $items='';
4189: foreach my $key (keys(%$storehash)) {
4190: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4191: }
4192: $items=~s/\&$//;
4193: my $esc_symb=&escape($symb);
4194: my $esc_v=&escape($version);
4195: my $reply =
4196: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4197: $uhome);
4198: if ($reply eq 'unknown_cmd') {
4199: # gfall back to way things use to be done
4200: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4201: $uname);
4202: }
4203: return $reply;
4204: }
4205:
4206: sub old_putstore {
4207: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4208: if (!$udomain) { $udomain=$env{'user.domain'}; }
4209: if (!$uname) { $uname=$env{'user.name'}; }
4210: my $uhome=&homeserver($uname,$udomain);
4211: my %newstorehash;
4212: foreach my $item (keys(%$storehash)) {
4213: my $key = $version.':'.&escape($symb).':'.$item;
4214: $newstorehash{$key} = $storehash->{$item};
4215: }
4216: my $items='';
4217: my %allitems = ();
4218: foreach my $item (keys(%newstorehash)) {
4219: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4220: my $key = $1.':keys:'.$2;
4221: $allitems{$key} .= $3.':';
4222: }
4223: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4224: }
4225: foreach my $item (keys(%allitems)) {
4226: $allitems{$item} =~ s/\:$//;
4227: $items.= $item.'='.$allitems{$item}.'&';
4228: }
4229: $items=~s/\&$//;
4230: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4231: }
4232:
4233: # ------------------------------------------------------ critical put interface
4234:
4235: sub cput {
4236: my ($namespace,$storehash,$udomain,$uname)=@_;
4237: if (!$udomain) { $udomain=$env{'user.domain'}; }
4238: if (!$uname) { $uname=$env{'user.name'}; }
4239: my $uhome=&homeserver($uname,$udomain);
4240: my $items='';
4241: foreach my $item (keys(%$storehash)) {
4242: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4243: }
4244: $items=~s/\&$//;
4245: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4246: }
4247:
4248: # -------------------------------------------------------------- eget interface
4249:
4250: sub eget {
4251: my ($namespace,$storearr,$udomain,$uname)=@_;
4252: my $items='';
4253: foreach my $item (@$storearr) {
4254: $items.=&escape($item).'&';
4255: }
4256: $items=~s/\&$//;
4257: if (!$udomain) { $udomain=$env{'user.domain'}; }
4258: if (!$uname) { $uname=$env{'user.name'}; }
4259: my $uhome=&homeserver($uname,$udomain);
4260: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4261: my @pairs=split(/\&/,$rep);
4262: my %returnhash=();
4263: my $i=0;
4264: foreach my $item (@$storearr) {
4265: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4266: $i++;
4267: }
4268: return %returnhash;
4269: }
4270:
4271: # ------------------------------------------------------------ tmpput interface
4272: sub tmpput {
4273: my ($storehash,$server,$context)=@_;
4274: my $items='';
4275: foreach my $item (keys(%$storehash)) {
4276: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4277: }
4278: $items=~s/\&$//;
4279: if (defined($context)) {
4280: $items .= ':'.&escape($context);
4281: }
4282: return &reply("tmpput:$items",$server);
4283: }
4284:
4285: # ------------------------------------------------------------ tmpget interface
4286: sub tmpget {
4287: my ($token,$server)=@_;
4288: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4289: my $rep=&reply("tmpget:$token",$server);
4290: my %returnhash;
4291: foreach my $item (split(/\&/,$rep)) {
4292: my ($key,$value)=split(/=/,$item);
4293: next if ($key =~ /^error: 2 /);
4294: $returnhash{&unescape($key)}=&thaw_unescape($value);
4295: }
4296: return %returnhash;
4297: }
4298:
4299: # ------------------------------------------------------------ tmpget interface
4300: sub tmpdel {
4301: my ($token,$server)=@_;
4302: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4303: return &reply("tmpdel:$token",$server);
4304: }
4305:
4306: # -------------------------------------------------- portfolio access checking
4307:
4308: sub portfolio_access {
4309: my ($requrl) = @_;
4310: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4311: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4312: if ($result) {
4313: my %setters;
4314: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4315: my ($startblock,$endblock) =
4316: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4317: if ($startblock && $endblock) {
4318: return 'B';
4319: }
4320: } else {
4321: my ($startblock,$endblock) =
4322: &Apache::loncommon::blockcheck(\%setters,'port');
4323: if ($startblock && $endblock) {
4324: return 'B';
4325: }
4326: }
4327: }
4328: if ($result eq 'ok') {
4329: return 'F';
4330: } elsif ($result =~ /^[^:]+:guest_/) {
4331: return 'A';
4332: }
4333: return '';
4334: }
4335:
4336: sub get_portfolio_access {
4337: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4338:
4339: if (!ref($access_hash)) {
4340: my $current_perms = &get_portfile_permissions($udom,$unum);
4341: my %access_controls = &get_access_controls($current_perms,$group,
4342: $file_name);
4343: $access_hash = $access_controls{$file_name};
4344: }
4345:
4346: my ($public,$guest,@domains,@users,@courses,@groups);
4347: my $now = time;
4348: if (ref($access_hash) eq 'HASH') {
4349: foreach my $key (keys(%{$access_hash})) {
4350: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4351: if ($start > $now) {
4352: next;
4353: }
4354: if ($end && $end<$now) {
4355: next;
4356: }
4357: if ($scope eq 'public') {
4358: $public = $key;
4359: last;
4360: } elsif ($scope eq 'guest') {
4361: $guest = $key;
4362: } elsif ($scope eq 'domains') {
4363: push(@domains,$key);
4364: } elsif ($scope eq 'users') {
4365: push(@users,$key);
4366: } elsif ($scope eq 'course') {
4367: push(@courses,$key);
4368: } elsif ($scope eq 'group') {
4369: push(@groups,$key);
4370: }
4371: }
4372: if ($public) {
4373: return 'ok';
4374: }
4375: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4376: if ($guest) {
4377: return $guest;
4378: }
4379: } else {
4380: if (@domains > 0) {
4381: foreach my $domkey (@domains) {
4382: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4383: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4384: return 'ok';
4385: }
4386: }
4387: }
4388: }
4389: if (@users > 0) {
4390: foreach my $userkey (@users) {
4391: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4392: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4393: if (ref($item) eq 'HASH') {
4394: if (($item->{'uname'} eq $env{'user.name'}) &&
4395: ($item->{'udom'} eq $env{'user.domain'})) {
4396: return 'ok';
4397: }
4398: }
4399: }
4400: }
4401: }
4402: }
4403: my %roleshash;
4404: my @courses_and_groups = @courses;
4405: push(@courses_and_groups,@groups);
4406: if (@courses_and_groups > 0) {
4407: my (%allgroups,%allroles);
4408: my ($start,$end,$role,$sec,$group);
4409: foreach my $envkey (%env) {
4410: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4411: my $cid = $2.'_'.$3;
4412: if ($1 eq 'gr') {
4413: $group = $4;
4414: $allgroups{$cid}{$group} = $env{$envkey};
4415: } else {
4416: if ($4 eq '') {
4417: $sec = 'none';
4418: } else {
4419: $sec = $4;
4420: }
4421: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4422: }
4423: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4424: my $cid = $2.'_'.$3;
4425: if ($4 eq '') {
4426: $sec = 'none';
4427: } else {
4428: $sec = $4;
4429: }
4430: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4431: }
4432: }
4433: if (keys(%allroles) == 0) {
4434: return;
4435: }
4436: foreach my $key (@courses_and_groups) {
4437: my %content = %{$$access_hash{$key}};
4438: my $cnum = $content{'number'};
4439: my $cdom = $content{'domain'};
4440: my $cid = $cdom.'_'.$cnum;
4441: if (!exists($allroles{$cid})) {
4442: next;
4443: }
4444: foreach my $role_id (keys(%{$content{'roles'}})) {
4445: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4446: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4447: my @status = @{$content{'roles'}{$role_id}{'access'}};
4448: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4449: foreach my $role (keys(%{$allroles{$cid}})) {
4450: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4451: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4452: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4453: if (grep/^all$/,@sections) {
4454: return 'ok';
4455: } else {
4456: if (grep/^$sec$/,@sections) {
4457: return 'ok';
4458: }
4459: }
4460: }
4461: }
4462: if (keys(%{$allgroups{$cid}}) == 0) {
4463: if (grep/^none$/,@groups) {
4464: return 'ok';
4465: }
4466: } else {
4467: if (grep/^all$/,@groups) {
4468: return 'ok';
4469: }
4470: foreach my $group (keys(%{$allgroups{$cid}})) {
4471: if (grep/^$group$/,@groups) {
4472: return 'ok';
4473: }
4474: }
4475: }
4476: }
4477: }
4478: }
4479: }
4480: }
4481: if ($guest) {
4482: return $guest;
4483: }
4484: }
4485: }
4486: return;
4487: }
4488:
4489: sub course_group_datechecker {
4490: my ($dates,$now,$status) = @_;
4491: my ($start,$end) = split(/\./,$dates);
4492: if (!$start && !$end) {
4493: return 'ok';
4494: }
4495: if (grep/^active$/,@{$status}) {
4496: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4497: return 'ok';
4498: }
4499: }
4500: if (grep/^previous$/,@{$status}) {
4501: if ($end > $now ) {
4502: return 'ok';
4503: }
4504: }
4505: if (grep/^future$/,@{$status}) {
4506: if ($start > $now) {
4507: return 'ok';
4508: }
4509: }
4510: return;
4511: }
4512:
4513: sub parse_portfolio_url {
4514: my ($url) = @_;
4515:
4516: my ($type,$udom,$unum,$group,$file_name);
4517:
4518: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4519: $type = 1;
4520: $udom = $1;
4521: $unum = $2;
4522: $file_name = $3;
4523: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4524: $type = 2;
4525: $udom = $1;
4526: $unum = $2;
4527: $group = $3;
4528: $file_name = $3.'/'.$4;
4529: }
4530: if (wantarray) {
4531: return ($type,$udom,$unum,$file_name,$group);
4532: }
4533: return $type;
4534: }
4535:
4536: sub is_portfolio_url {
4537: my ($url) = @_;
4538: return scalar(&parse_portfolio_url($url));
4539: }
4540:
4541: sub is_portfolio_file {
4542: my ($file) = @_;
4543: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4544: return 1;
4545: }
4546: return;
4547: }
4548:
4549: sub usertools_access {
4550: my ($uname,$udom,$tool,$action,$context) = @_;
4551: my ($access,%tools);
4552: if ($context eq '') {
4553: $context = 'tools';
4554: }
4555: if ($context eq 'requestcourses') {
4556: %tools = (
4557: official => 1,
4558: unofficial => 1,
4559: );
4560: } else {
4561: %tools = (
4562: aboutme => 1,
4563: blog => 1,
4564: portfolio => 1,
4565: );
4566: }
4567: return if (!defined($tools{$tool}));
4568:
4569: if ((!defined($udom)) || (!defined($uname))) {
4570: $udom = $env{'user.domain'};
4571: $uname = $env{'user.name'};
4572: }
4573:
4574: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4575: if ($action ne 'reload') {
4576: if ($context eq 'requestcourses') {
4577: return $env{'environment.canrequest.'.$tool};
4578: } else {
4579: return $env{'environment.availabletools.'.$tool};
4580: }
4581: }
4582: }
4583:
4584: my ($toolstatus,$inststatus);
4585:
4586: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4587: ($action ne 'reload')) {
4588: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4589: $inststatus = $env{'environment.inststatus'};
4590: } else {
4591: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool);
4592: $toolstatus = $userenv{$context.'.'.$tool};
4593: $inststatus = $userenv{'inststatus'};
4594: }
4595:
4596: if ($toolstatus ne '') {
4597: if ($toolstatus) {
4598: $access = 1;
4599: } else {
4600: $access = 0;
4601: }
4602: return $access;
4603: }
4604:
4605: my $is_adv = &is_advanced_user($udom,$uname);
4606: my %domdef = &get_domain_defaults($udom);
4607: if (ref($domdef{$tool}) eq 'HASH') {
4608: if ($is_adv) {
4609: if ($domdef{$tool}{'_LC_adv'} ne '') {
4610: if ($domdef{$tool}{'_LC_adv'}) {
4611: $access = 1;
4612: } else {
4613: $access = 0;
4614: }
4615: return $access;
4616: }
4617: }
4618: if ($inststatus ne '') {
4619: my ($hasaccess,$hasnoaccess);
4620: foreach my $affiliation (split(/:/,$inststatus)) {
4621: if ($domdef{$tool}{$affiliation} ne '') {
4622: if ($domdef{$tool}{$affiliation}) {
4623: $hasaccess = 1;
4624: } else {
4625: $hasnoaccess = 1;
4626: }
4627: }
4628: }
4629: if ($hasaccess || $hasnoaccess) {
4630: if ($hasaccess) {
4631: $access = 1;
4632: } elsif ($hasnoaccess) {
4633: $access = 0;
4634: }
4635: return $access;
4636: }
4637: } else {
4638: if ($domdef{$tool}{'default'} ne '') {
4639: if ($domdef{$tool}{'default'}) {
4640: $access = 1;
4641: } elsif ($domdef{$tool}{'default'} == 0) {
4642: $access = 0;
4643: }
4644: return $access;
4645: }
4646: }
4647: } else {
4648: if ($context eq 'tools') {
4649: $access = 1;
4650: } else {
4651: $access = 0;
4652: }
4653: return $access;
4654: }
4655: }
4656:
4657: sub is_advanced_user {
4658: my ($udom,$uname) = @_;
4659: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4660: my %allroles;
4661: my $is_adv;
4662: foreach my $role (keys(%roleshash)) {
4663: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4664: my $area = '/'.$tdomain.'/'.$trest;
4665: if ($sec ne '') {
4666: $area .= '/'.$sec;
4667: }
4668: if (($area ne '') && ($trole ne '')) {
4669: my $spec=$trole.'.'.$area;
4670: if ($trole =~ /^cr\//) {
4671: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4672: } elsif ($trole ne 'gr') {
4673: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4674: }
4675: }
4676: }
4677: foreach my $role (keys(%allroles)) {
4678: last if ($is_adv);
4679: foreach my $item (split(/:/,$allroles{$role})) {
4680: if ($item ne '') {
4681: my ($privilege,$restrictions)=split(/&/,$item);
4682: if ($privilege eq 'adv') {
4683: $is_adv = 1;
4684: last;
4685: }
4686: }
4687: }
4688: }
4689: return $is_adv;
4690: }
4691:
4692: # ---------------------------------------------- Custom access rule evaluation
4693:
4694: sub customaccess {
4695: my ($priv,$uri)=@_;
4696: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4697: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4698: $udom = &LONCAPA::clean_domain($udom);
4699: $ucrs = &LONCAPA::clean_username($ucrs);
4700: my $access=0;
4701: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4702: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4703: if ($type eq 'user') {
4704: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4705: my ($tdom,$tuname)=split(m{/},$scope);
4706: if ($tdom) {
4707: if ($tdom ne $env{'user.domain'}) { next; }
4708: }
4709: if ($tuname) {
4710: if ($tuname ne $env{'user.name'}) { next; }
4711: }
4712: $access=($effect eq 'allow');
4713: last;
4714: }
4715: } else {
4716: if ($role) {
4717: if ($role ne $urole) { next; }
4718: }
4719: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4720: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4721: if ($tdom) {
4722: if ($tdom ne $udom) { next; }
4723: }
4724: if ($tcrs) {
4725: if ($tcrs ne $ucrs) { next; }
4726: }
4727: if ($tsec) {
4728: if ($tsec ne $usec) { next; }
4729: }
4730: $access=($effect eq 'allow');
4731: last;
4732: }
4733: if ($realm eq '' && $role eq '') {
4734: $access=($effect eq 'allow');
4735: }
4736: }
4737: }
4738: return $access;
4739: }
4740:
4741: # ------------------------------------------------- Check for a user privilege
4742:
4743: sub allowed {
4744: my ($priv,$uri,$symb,$role)=@_;
4745: my $ver_orguri=$uri;
4746: $uri=&deversion($uri);
4747: my $orguri=$uri;
4748: $uri=&declutter($uri);
4749:
4750: if ($priv eq 'evb') {
4751: # Evade communication block restrictions for specified role in a course
4752: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4753: return $1;
4754: } else {
4755: return;
4756: }
4757: }
4758:
4759: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4760: # Free bre access to adm and meta resources
4761: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4762: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4763: && ($priv eq 'bre')) {
4764: return 'F';
4765: }
4766:
4767: # Free bre access to user's own portfolio contents
4768: my ($space,$domain,$name,@dir)=split('/',$uri);
4769: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4770: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4771: my %setters;
4772: my ($startblock,$endblock) =
4773: &Apache::loncommon::blockcheck(\%setters,'port');
4774: if ($startblock && $endblock) {
4775: return 'B';
4776: } else {
4777: return 'F';
4778: }
4779: }
4780:
4781: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
4782: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4783: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4784: if (exists($env{'request.course.id'})) {
4785: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4786: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4787: if (($domain eq $cdom) && ($name eq $cnum)) {
4788: my $courseprivid=$env{'request.course.id'};
4789: $courseprivid=~s/\_/\//;
4790: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4791: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4792: return $1;
4793: } else {
4794: if ($env{'request.course.sec'}) {
4795: $courseprivid.='/'.$env{'request.course.sec'};
4796: }
4797: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4798: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
4799: return $2;
4800: }
4801: }
4802: }
4803: }
4804: }
4805:
4806: # Free bre to public access
4807:
4808: if ($priv eq 'bre') {
4809: my $copyright=&metadata($uri,'copyright');
4810: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
4811: return 'F';
4812: }
4813: if ($copyright eq 'priv') {
4814: $uri=~/([^\/]+)\/([^\/]+)\//;
4815: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
4816: return '';
4817: }
4818: }
4819: if ($copyright eq 'domain') {
4820: $uri=~/([^\/]+)\/([^\/]+)\//;
4821: unless (($env{'user.domain'} eq $1) ||
4822: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
4823: return '';
4824: }
4825: }
4826: if ($env{'request.role'}=~ /li\.\//) {
4827: # Library role, so allow browsing of resources in this domain.
4828: return 'F';
4829: }
4830: if ($copyright eq 'custom') {
4831: unless (&customaccess($priv,$uri)) { return ''; }
4832: }
4833: }
4834: # Domain coordinator is trying to create a course
4835: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
4836: # uri is the requested domain in this case.
4837: # comparison to 'request.role.domain' shows if the user has selected
4838: # a role of dc for the domain in question.
4839: return 'F' if ($uri eq $env{'request.role.domain'});
4840: }
4841:
4842: my $thisallowed='';
4843: my $statecond=0;
4844: my $courseprivid='';
4845:
4846: # Course
4847:
4848: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
4849: $thisallowed.=$1;
4850: }
4851:
4852: # Domain
4853:
4854: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
4855: =~/\Q$priv\E\&([^\:]*)/) {
4856: $thisallowed.=$1;
4857: }
4858:
4859: # Course: uri itself is a course
4860: my $courseuri=$uri;
4861: $courseuri=~s/\_(\d)/\/$1/;
4862: $courseuri=~s/^([^\/])/\/$1/;
4863:
4864: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
4865: =~/\Q$priv\E\&([^\:]*)/) {
4866: $thisallowed.=$1;
4867: }
4868:
4869: # URI is an uploaded document for this course, default permissions don't matter
4870: # not allowing 'edit' access (editupload) to uploaded course docs
4871: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
4872: $thisallowed='';
4873: my ($match)=&is_on_map($uri);
4874: if ($match) {
4875: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4876: =~/\Q$priv\E\&([^\:]*)/) {
4877: $thisallowed.=$1;
4878: }
4879: } else {
4880: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
4881: if ($refuri) {
4882: if ($refuri =~ m|^/adm/|) {
4883: $thisallowed='F';
4884: } else {
4885: $refuri=&declutter($refuri);
4886: my ($match) = &is_on_map($refuri);
4887: if ($match) {
4888: $thisallowed='F';
4889: }
4890: }
4891: }
4892: }
4893: }
4894:
4895: if ($priv eq 'bre'
4896: && $thisallowed ne 'F'
4897: && $thisallowed ne '2'
4898: && &is_portfolio_url($uri)) {
4899: $thisallowed = &portfolio_access($uri);
4900: }
4901:
4902: # Full access at system, domain or course-wide level? Exit.
4903: if ($thisallowed=~/F/) {
4904: return 'F';
4905: }
4906:
4907: # If this is generating or modifying users, exit with special codes
4908:
4909: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4910: if (($priv eq 'cca') || ($priv eq 'caa')) {
4911: my ($audom,$auname)=split('/',$uri);
4912: # no author name given, so this just checks on the general right to make a co-author in this domain
4913: unless ($auname) { return $thisallowed; }
4914: # an author name is given, so we are about to actually make a co-author for a certain account
4915: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4916: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4917: ($audom ne $env{'request.role.domain'}))) { return ''; }
4918: }
4919: return $thisallowed;
4920: }
4921: #
4922: # Gathered so far: system, domain and course wide privileges
4923: #
4924: # Course: See if uri or referer is an individual resource that is part of
4925: # the course
4926:
4927: if ($env{'request.course.id'}) {
4928:
4929: $courseprivid=$env{'request.course.id'};
4930: if ($env{'request.course.sec'}) {
4931: $courseprivid.='/'.$env{'request.course.sec'};
4932: }
4933: $courseprivid=~s/\_/\//;
4934: my $checkreferer=1;
4935: my ($match,$cond)=&is_on_map($uri);
4936: if ($match) {
4937: $statecond=$cond;
4938: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4939: =~/\Q$priv\E\&([^\:]*)/) {
4940: $thisallowed.=$1;
4941: $checkreferer=0;
4942: }
4943: }
4944:
4945: if ($checkreferer) {
4946: my $refuri=$env{'httpref.'.$orguri};
4947: unless ($refuri) {
4948: foreach my $key (keys(%env)) {
4949: if ($key=~/^httpref\..*\*/) {
4950: my $pattern=$key;
4951: $pattern=~s/^httpref\.\/res\///;
4952: $pattern=~s/\*/\[\^\/\]\+/g;
4953: $pattern=~s/\//\\\//g;
4954: if ($orguri=~/$pattern/) {
4955: $refuri=$env{$key};
4956: }
4957: }
4958: }
4959: }
4960:
4961: if ($refuri) {
4962: $refuri=&declutter($refuri);
4963: my ($match,$cond)=&is_on_map($refuri);
4964: if ($match) {
4965: my $refstatecond=$cond;
4966: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4967: =~/\Q$priv\E\&([^\:]*)/) {
4968: $thisallowed.=$1;
4969: $uri=$refuri;
4970: $statecond=$refstatecond;
4971: }
4972: }
4973: }
4974: }
4975: }
4976:
4977: #
4978: # Gathered now: all privileges that could apply, and condition number
4979: #
4980: #
4981: # Full or no access?
4982: #
4983:
4984: if ($thisallowed=~/F/) {
4985: return 'F';
4986: }
4987:
4988: unless ($thisallowed) {
4989: return '';
4990: }
4991:
4992: # Restrictions exist, deal with them
4993: #
4994: # C:according to course preferences
4995: # R:according to resource settings
4996: # L:unless locked
4997: # X:according to user session state
4998: #
4999:
5000: # Possibly locked functionality, check all courses
5001: # Locks might take effect only after 10 minutes cache expiration for other
5002: # courses, and 2 minutes for current course
5003:
5004: my $envkey;
5005: if ($thisallowed=~/L/) {
5006: foreach $envkey (keys %env) {
5007: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5008: my $courseid=$2;
5009: my $roleid=$1.'.'.$2;
5010: $courseid=~s/^\///;
5011: my $expiretime=600;
5012: if ($env{'request.role'} eq $roleid) {
5013: $expiretime=120;
5014: }
5015: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5016: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5017: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5018: &coursedescription($courseid,{'freshen_cache' => 1});
5019: }
5020: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5021: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5022: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5023: &log($env{'user.domain'},$env{'user.name'},
5024: $env{'user.home'},
5025: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5026: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5027: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5028: return '';
5029: }
5030: }
5031: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5032: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5033: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5034: &log($env{'user.domain'},$env{'user.name'},
5035: $env{'user.home'},
5036: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5037: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5038: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5039: return '';
5040: }
5041: }
5042: }
5043: }
5044: }
5045:
5046: #
5047: # Rest of the restrictions depend on selected course
5048: #
5049:
5050: unless ($env{'request.course.id'}) {
5051: if ($thisallowed eq 'A') {
5052: return 'A';
5053: } elsif ($thisallowed eq 'B') {
5054: return 'B';
5055: } else {
5056: return '1';
5057: }
5058: }
5059:
5060: #
5061: # Now user is definitely in a course
5062: #
5063:
5064:
5065: # Course preferences
5066:
5067: if ($thisallowed=~/C/) {
5068: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5069: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5070: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5071: =~/\Q$rolecode\E/) {
5072: if ($priv ne 'pch') {
5073: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5074: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5075: $env{'request.course.id'});
5076: }
5077: return '';
5078: }
5079:
5080: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5081: =~/\Q$unamedom\E/) {
5082: if ($priv ne 'pch') {
5083: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5084: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5085: $env{'request.course.id'});
5086: }
5087: return '';
5088: }
5089: }
5090:
5091: # Resource preferences
5092:
5093: if ($thisallowed=~/R/) {
5094: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5095: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5096: if ($priv ne 'pch') {
5097: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5098: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5099: }
5100: return '';
5101: }
5102: }
5103:
5104: # Restricted by state or randomout?
5105:
5106: if ($thisallowed=~/X/) {
5107: if ($env{'acc.randomout'}) {
5108: if (!$symb) { $symb=&symbread($uri,1); }
5109: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5110: return '';
5111: }
5112: }
5113: if (&condval($statecond)) {
5114: return '2';
5115: } else {
5116: return '';
5117: }
5118: }
5119:
5120: if ($thisallowed eq 'A') {
5121: return 'A';
5122: } elsif ($thisallowed eq 'B') {
5123: return 'B';
5124: }
5125: return 'F';
5126: }
5127:
5128: sub split_uri_for_cond {
5129: my $uri=&deversion(&declutter(shift));
5130: my @uriparts=split(/\//,$uri);
5131: my $filename=pop(@uriparts);
5132: my $pathname=join('/',@uriparts);
5133: return ($pathname,$filename);
5134: }
5135: # --------------------------------------------------- Is a resource on the map?
5136:
5137: sub is_on_map {
5138: my ($pathname,$filename) = &split_uri_for_cond(shift);
5139: #Trying to find the conditional for the file
5140: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5141: /\&\Q$filename\E\:([\d\|]+)\&/);
5142: if ($match) {
5143: return (1,$1);
5144: } else {
5145: return (0,0);
5146: }
5147: }
5148:
5149: # --------------------------------------------------------- Get symb from alias
5150:
5151: sub get_symb_from_alias {
5152: my $symb=shift;
5153: my ($map,$resid,$url)=&decode_symb($symb);
5154: # Already is a symb
5155: if ($url) { return $symb; }
5156: # Must be an alias
5157: my $aliassymb='';
5158: my %bighash;
5159: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5160: &GDBM_READER(),0640)) {
5161: my $rid=$bighash{'mapalias_'.$symb};
5162: if ($rid) {
5163: my ($mapid,$resid)=split(/\./,$rid);
5164: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5165: $resid,$bighash{'src_'.$rid});
5166: }
5167: untie %bighash;
5168: }
5169: return $aliassymb;
5170: }
5171:
5172: # ----------------------------------------------------------------- Define Role
5173:
5174: sub definerole {
5175: if (allowed('mcr','/')) {
5176: my ($rolename,$sysrole,$domrole,$courole)=@_;
5177: foreach my $role (split(':',$sysrole)) {
5178: my ($crole,$cqual)=split(/\&/,$role);
5179: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5180: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5181: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5182: return "refused:s:$crole&$cqual";
5183: }
5184: }
5185: }
5186: foreach my $role (split(':',$domrole)) {
5187: my ($crole,$cqual)=split(/\&/,$role);
5188: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5189: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5190: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5191: return "refused:d:$crole&$cqual";
5192: }
5193: }
5194: }
5195: foreach my $role (split(':',$courole)) {
5196: my ($crole,$cqual)=split(/\&/,$role);
5197: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5198: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5199: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5200: return "refused:c:$crole&$cqual";
5201: }
5202: }
5203: }
5204: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5205: "$env{'user.domain'}:$env{'user.name'}:".
5206: "rolesdef_$rolename=".
5207: escape($sysrole.'_'.$domrole.'_'.$courole);
5208: return reply($command,$env{'user.home'});
5209: } else {
5210: return 'refused';
5211: }
5212: }
5213:
5214: # ---------------- Make a metadata query against the network of library servers
5215:
5216: sub metadata_query {
5217: my ($query,$custom,$customshow,$server_array)=@_;
5218: my %rhash;
5219: my %libserv = &all_library();
5220: my @server_list = (defined($server_array) ? @$server_array
5221: : keys(%libserv) );
5222: for my $server (@server_list) {
5223: unless ($custom or $customshow) {
5224: my $reply=&reply("querysend:".&escape($query),$server);
5225: $rhash{$server}=$reply;
5226: }
5227: else {
5228: my $reply=&reply("querysend:".&escape($query).':'.
5229: &escape($custom).':'.&escape($customshow),
5230: $server);
5231: $rhash{$server}=$reply;
5232: }
5233: }
5234: return \%rhash;
5235: }
5236:
5237: # ----------------------------------------- Send log queries and wait for reply
5238:
5239: sub log_query {
5240: my ($uname,$udom,$query,%filters)=@_;
5241: my $uhome=&homeserver($uname,$udom);
5242: if ($uhome eq 'no_host') { return 'error: no_host'; }
5243: my $uhost=&hostname($uhome);
5244: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5245: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5246: $uhome);
5247: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5248: return get_query_reply($queryid);
5249: }
5250:
5251: # -------------------------- Update MySQL table for portfolio file
5252:
5253: sub update_portfolio_table {
5254: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5255: if ($group ne '') {
5256: $file_name =~s /^\Q$group\E//;
5257: }
5258: my $homeserver = &homeserver($uname,$udom);
5259: my $queryid=
5260: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5261: ':'.&escape($file_name).':'.$action,$homeserver);
5262: my $reply = &get_query_reply($queryid);
5263: return $reply;
5264: }
5265:
5266: # -------------------------- Update MySQL allusers table
5267:
5268: sub update_allusers_table {
5269: my ($uname,$udom,$names) = @_;
5270: my $homeserver = &homeserver($uname,$udom);
5271: my $queryid=
5272: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5273: 'lastname='.&escape($names->{'lastname'}).'%%'.
5274: 'firstname='.&escape($names->{'firstname'}).'%%'.
5275: 'middlename='.&escape($names->{'middlename'}).'%%'.
5276: 'generation='.&escape($names->{'generation'}).'%%'.
5277: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5278: 'id='.&escape($names->{'id'}),$homeserver);
5279: my $reply = &get_query_reply($queryid);
5280: return $reply;
5281: }
5282:
5283: # ------- Request retrieval of institutional classlists for course(s)
5284:
5285: sub fetch_enrollment_query {
5286: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5287: my $homeserver;
5288: my $maxtries = 1;
5289: if ($context eq 'automated') {
5290: $homeserver = $perlvar{'lonHostID'};
5291: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5292: } else {
5293: $homeserver = &homeserver($cnum,$dom);
5294: }
5295: my $host=&hostname($homeserver);
5296: my $cmd = '';
5297: foreach my $affiliate (keys %{$affiliatesref}) {
5298: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5299: }
5300: $cmd =~ s/%%$//;
5301: $cmd = &escape($cmd);
5302: my $query = 'fetchenrollment';
5303: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5304: unless ($queryid=~/^\Q$host\E\_/) {
5305: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5306: return 'error: '.$queryid;
5307: }
5308: my $reply = &get_query_reply($queryid);
5309: my $tries = 1;
5310: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5311: $reply = &get_query_reply($queryid);
5312: $tries ++;
5313: }
5314: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5315: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5316: } else {
5317: my @responses = split(/:/,$reply);
5318: if ($homeserver eq $perlvar{'lonHostID'}) {
5319: foreach my $line (@responses) {
5320: my ($key,$value) = split(/=/,$line,2);
5321: $$replyref{$key} = $value;
5322: }
5323: } else {
5324: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5325: foreach my $line (@responses) {
5326: my ($key,$value) = split(/=/,$line);
5327: $$replyref{$key} = $value;
5328: if ($value > 0) {
5329: foreach my $item (@{$$affiliatesref{$key}}) {
5330: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5331: my $destname = $pathname.'/'.$filename;
5332: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5333: if ($xml_classlist =~ /^error/) {
5334: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5335: } else {
5336: if ( open(FILE,">$destname") ) {
5337: print FILE &unescape($xml_classlist);
5338: close(FILE);
5339: } else {
5340: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5341: }
5342: }
5343: }
5344: }
5345: }
5346: }
5347: return 'ok';
5348: }
5349: return 'error';
5350: }
5351:
5352: sub get_query_reply {
5353: my $queryid=shift;
5354: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5355: my $reply='';
5356: for (1..100) {
5357: sleep 2;
5358: if (-e $replyfile.'.end') {
5359: if (open(my $fh,$replyfile)) {
5360: $reply = join('',<$fh>);
5361: close($fh);
5362: } else { return 'error: reply_file_error'; }
5363: return &unescape($reply);
5364: }
5365: }
5366: return 'timeout:'.$queryid;
5367: }
5368:
5369: sub courselog_query {
5370: #
5371: # possible filters:
5372: # url: url or symb
5373: # username
5374: # domain
5375: # action: view, submit, grade
5376: # start: timestamp
5377: # end: timestamp
5378: #
5379: my (%filters)=@_;
5380: unless ($env{'request.course.id'}) { return 'no_course'; }
5381: if ($filters{'url'}) {
5382: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5383: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5384: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5385: }
5386: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5387: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5388: return &log_query($cname,$cdom,'courselog',%filters);
5389: }
5390:
5391: sub userlog_query {
5392: #
5393: # possible filters:
5394: # action: log check role
5395: # start: timestamp
5396: # end: timestamp
5397: #
5398: my ($uname,$udom,%filters)=@_;
5399: return &log_query($uname,$udom,'userlog',%filters);
5400: }
5401:
5402: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5403:
5404: sub auto_run {
5405: my ($cnum,$cdom) = @_;
5406: my $response = 0;
5407: my $settings;
5408: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5409: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5410: $settings = $domconfig{'autoenroll'};
5411: if ($settings->{'run'} eq '1') {
5412: $response = 1;
5413: }
5414: } else {
5415: my $homeserver;
5416: if (&is_course($cdom,$cnum)) {
5417: $homeserver = &homeserver($cnum,$cdom);
5418: } else {
5419: $homeserver = &domain($cdom,'primary');
5420: }
5421: if ($homeserver ne 'no_host') {
5422: $response = &reply('autorun:'.$cdom,$homeserver);
5423: }
5424: }
5425: return $response;
5426: }
5427:
5428: sub auto_get_sections {
5429: my ($cnum,$cdom,$inst_coursecode) = @_;
5430: my $homeserver = &homeserver($cnum,$cdom);
5431: my @secs = ();
5432: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5433: unless ($response eq 'refused') {
5434: @secs = split(/:/,$response);
5435: }
5436: return @secs;
5437: }
5438:
5439: sub auto_new_course {
5440: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5441: my $homeserver = &homeserver($cnum,$cdom);
5442: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5443: return $response;
5444: }
5445:
5446: sub auto_validate_courseID {
5447: my ($cnum,$cdom,$inst_course_id) = @_;
5448: my $homeserver = &homeserver($cnum,$cdom);
5449: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5450: return $response;
5451: }
5452:
5453: sub auto_create_password {
5454: my ($cnum,$cdom,$authparam,$udom) = @_;
5455: my ($homeserver,$response);
5456: my $create_passwd = 0;
5457: my $authchk = '';
5458: if ($udom =~ /^$match_domain$/) {
5459: $homeserver = &domain($udom,'primary');
5460: }
5461: if ($homeserver eq '') {
5462: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5463: $homeserver = &homeserver($cnum,$cdom);
5464: }
5465: }
5466: if ($homeserver eq '') {
5467: $authchk = 'nodomain';
5468: } else {
5469: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5470: if ($response eq 'refused') {
5471: $authchk = 'refused';
5472: } else {
5473: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5474: }
5475: }
5476: return ($authparam,$create_passwd,$authchk);
5477: }
5478:
5479: sub auto_photo_permission {
5480: my ($cnum,$cdom,$students) = @_;
5481: my $homeserver = &homeserver($cnum,$cdom);
5482: my ($outcome,$perm_reqd,$conditions) =
5483: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5484: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5485: return (undef,undef);
5486: }
5487: return ($outcome,$perm_reqd,$conditions);
5488: }
5489:
5490: sub auto_checkphotos {
5491: my ($uname,$udom,$pid) = @_;
5492: my $homeserver = &homeserver($uname,$udom);
5493: my ($result,$resulttype);
5494: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5495: &escape($uname).':'.&escape($pid),
5496: $homeserver));
5497: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5498: return (undef,undef);
5499: }
5500: if ($outcome) {
5501: ($result,$resulttype) = split(/:/,$outcome);
5502: }
5503: return ($result,$resulttype);
5504: }
5505:
5506: sub auto_photochoice {
5507: my ($cnum,$cdom) = @_;
5508: my $homeserver = &homeserver($cnum,$cdom);
5509: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5510: &escape($cdom),
5511: $homeserver)));
5512: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5513: return (undef,undef);
5514: }
5515: return ($update,$comment);
5516: }
5517:
5518: sub auto_photoupdate {
5519: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5520: my $homeserver = &homeserver($cnum,$dom);
5521: my $host=&hostname($homeserver);
5522: my $cmd = '';
5523: my $maxtries = 1;
5524: foreach my $affiliate (keys(%{$affiliatesref})) {
5525: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5526: }
5527: $cmd =~ s/%%$//;
5528: $cmd = &escape($cmd);
5529: my $query = 'institutionalphotos';
5530: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5531: unless ($queryid=~/^\Q$host\E\_/) {
5532: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5533: return 'error: '.$queryid;
5534: }
5535: my $reply = &get_query_reply($queryid);
5536: my $tries = 1;
5537: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5538: $reply = &get_query_reply($queryid);
5539: $tries ++;
5540: }
5541: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5542: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5543: } else {
5544: my @responses = split(/:/,$reply);
5545: my $outcome = shift(@responses);
5546: foreach my $item (@responses) {
5547: my ($key,$value) = split(/=/,$item);
5548: $$photo{$key} = $value;
5549: }
5550: return $outcome;
5551: }
5552: return 'error';
5553: }
5554:
5555: sub auto_instcode_format {
5556: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5557: $cat_order) = @_;
5558: my $courses = '';
5559: my @homeservers;
5560: if ($caller eq 'global') {
5561: my %servers = &get_servers($codedom,'library');
5562: foreach my $tryserver (keys(%servers)) {
5563: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5564: push(@homeservers,$tryserver);
5565: }
5566: }
5567: } else {
5568: push(@homeservers,&homeserver($caller,$codedom));
5569: }
5570: foreach my $code (keys(%{$instcodes})) {
5571: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5572: }
5573: chop($courses);
5574: my $ok_response = 0;
5575: my $response;
5576: while (@homeservers > 0 && $ok_response == 0) {
5577: my $server = shift(@homeservers);
5578: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5579: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5580: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5581: split(/:/,$response);
5582: %{$codes} = (%{$codes},&str2hash($codes_str));
5583: push(@{$codetitles},&str2array($codetitles_str));
5584: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5585: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5586: $ok_response = 1;
5587: }
5588: }
5589: if ($ok_response) {
5590: return 'ok';
5591: } else {
5592: return $response;
5593: }
5594: }
5595:
5596: sub auto_instcode_defaults {
5597: my ($domain,$returnhash,$code_order) = @_;
5598: my @homeservers;
5599:
5600: my %servers = &get_servers($domain,'library');
5601: foreach my $tryserver (keys(%servers)) {
5602: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5603: push(@homeservers,$tryserver);
5604: }
5605: }
5606:
5607: my $response;
5608: foreach my $server (@homeservers) {
5609: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5610: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5611:
5612: foreach my $pair (split(/\&/,$response)) {
5613: my ($name,$value)=split(/\=/,$pair);
5614: if ($name eq 'code_order') {
5615: @{$code_order} = split(/\&/,&unescape($value));
5616: } else {
5617: $returnhash->{&unescape($name)}=&unescape($value);
5618: }
5619: }
5620: return 'ok';
5621: }
5622:
5623: return $response;
5624: }
5625:
5626: sub auto_validate_class_sec {
5627: my ($cdom,$cnum,$owners,$inst_class) = @_;
5628: my $homeserver = &homeserver($cnum,$cdom);
5629: my $ownerlist;
5630: if (ref($owners) eq 'ARRAY') {
5631: $ownerlist = join(',',@{$owners});
5632: } else {
5633: $ownerlist = $owners;
5634: }
5635: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
5636: &escape($ownerlist).':'.$cdom,$homeserver);
5637: return $response;
5638: }
5639:
5640: # ------------------------------------------------------- Course Group routines
5641:
5642: sub get_coursegroups {
5643: my ($cdom,$cnum,$group,$namespace) = @_;
5644: return(&dump($namespace,$cdom,$cnum,$group));
5645: }
5646:
5647: sub modify_coursegroup {
5648: my ($cdom,$cnum,$groupsettings) = @_;
5649: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
5650: }
5651:
5652: sub toggle_coursegroup_status {
5653: my ($cdom,$cnum,$group,$action) = @_;
5654: my ($from_namespace,$to_namespace);
5655: if ($action eq 'delete') {
5656: $from_namespace = 'coursegroups';
5657: $to_namespace = 'deleted_groups';
5658: } else {
5659: $from_namespace = 'deleted_groups';
5660: $to_namespace = 'coursegroups';
5661: }
5662: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
5663: if (my $tmp = &error(%curr_group)) {
5664: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
5665: return ('read error',$tmp);
5666: } else {
5667: my %savedsettings = %curr_group;
5668: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
5669: my $deloutcome;
5670: if ($result eq 'ok') {
5671: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
5672: } else {
5673: return ('write error',$result);
5674: }
5675: if ($deloutcome eq 'ok') {
5676: return 'ok';
5677: } else {
5678: return ('delete error',$deloutcome);
5679: }
5680: }
5681: }
5682:
5683: sub modify_group_roles {
5684: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
5685: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
5686: my $role = 'gr/'.&escape($userprivs);
5687: my ($uname,$udom) = split(/:/,$user);
5688: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
5689: if ($result eq 'ok') {
5690: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
5691: }
5692: return $result;
5693: }
5694:
5695: sub modify_coursegroup_membership {
5696: my ($cdom,$cnum,$membership) = @_;
5697: my $result = &put('groupmembership',$membership,$cdom,$cnum);
5698: return $result;
5699: }
5700:
5701: sub get_active_groups {
5702: my ($udom,$uname,$cdom,$cnum) = @_;
5703: my $now = time;
5704: my %groups = ();
5705: foreach my $key (keys(%env)) {
5706: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
5707: my ($start,$end) = split(/\./,$env{$key});
5708: if (($end!=0) && ($end<$now)) { next; }
5709: if (($start!=0) && ($start>$now)) { next; }
5710: if ($1 eq $cdom && $2 eq $cnum) {
5711: $groups{$3} = $env{$key} ;
5712: }
5713: }
5714: }
5715: return %groups;
5716: }
5717:
5718: sub get_group_membership {
5719: my ($cdom,$cnum,$group) = @_;
5720: return(&dump('groupmembership',$cdom,$cnum,$group));
5721: }
5722:
5723: sub get_users_groups {
5724: my ($udom,$uname,$courseid) = @_;
5725: my @usersgroups;
5726: my $cachetime=1800;
5727:
5728: my $hashid="$udom:$uname:$courseid";
5729: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
5730: if (defined($cached)) {
5731: @usersgroups = split(/:/,$grouplist);
5732: } else {
5733: $grouplist = '';
5734: my $courseurl = &courseid_to_courseurl($courseid);
5735: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
5736: my $access_end = $env{'course.'.$courseid.
5737: '.default_enrollment_end_date'};
5738: my $now = time;
5739: foreach my $key (keys(%roleshash)) {
5740: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
5741: my $group = $1;
5742: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
5743: my $start = $2;
5744: my $end = $1;
5745: if ($start == -1) { next; } # deleted from group
5746: if (($start!=0) && ($start>$now)) { next; }
5747: if (($end!=0) && ($end<$now)) {
5748: if ($access_end && $access_end < $now) {
5749: if ($access_end - $end < 86400) {
5750: push(@usersgroups,$group);
5751: }
5752: }
5753: next;
5754: }
5755: push(@usersgroups,$group);
5756: }
5757: }
5758: }
5759: @usersgroups = &sort_course_groups($courseid,@usersgroups);
5760: $grouplist = join(':',@usersgroups);
5761: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
5762: }
5763: return @usersgroups;
5764: }
5765:
5766: sub devalidate_getgroups_cache {
5767: my ($udom,$uname,$cdom,$cnum)=@_;
5768: my $courseid = $cdom.'_'.$cnum;
5769:
5770: my $hashid="$udom:$uname:$courseid";
5771: &devalidate_cache_new('getgroups',$hashid);
5772: }
5773:
5774: # ------------------------------------------------------------------ Plain Text
5775:
5776: sub plaintext {
5777: my ($short,$type,$cid,$forcedefault) = @_;
5778: if ($short =~ /^cr/) {
5779: return (split('/',$short))[-1];
5780: }
5781: if (!defined($cid)) {
5782: $cid = $env{'request.course.id'};
5783: }
5784: if (defined($cid) && ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '')) {
5785: unless ($forcedefault) {
5786: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
5787: &Apache::lonlocal::mt_escape(\$roletext);
5788: return &Apache::lonlocal::mt($roletext);
5789: }
5790: }
5791: my %rolenames = (
5792: Course => 'std',
5793: Group => 'alt1',
5794: );
5795: if (defined($type) &&
5796: defined($rolenames{$type}) &&
5797: defined($prp{$short}{$rolenames{$type}})) {
5798: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
5799: } else {
5800: return &Apache::lonlocal::mt($prp{$short}{'std'});
5801: }
5802: }
5803:
5804: # ----------------------------------------------------------------- Assign Role
5805:
5806: sub assignrole {
5807: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
5808: $context)=@_;
5809: my $mrole;
5810: if ($role =~ /^cr\//) {
5811: my $cwosec=$url;
5812: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5813: unless (&allowed('ccr',$cwosec)) {
5814: &logthis('Refused custom assignrole: '.
5815: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5816: $env{'user.name'}.' at '.$env{'user.domain'});
5817: return 'refused';
5818: }
5819: $mrole='cr';
5820: } elsif ($role =~ /^gr\//) {
5821: my $cwogrp=$url;
5822: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
5823: unless (&allowed('mdg',$cwogrp)) {
5824: &logthis('Refused group assignrole: '.
5825: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5826: $env{'user.name'}.' at '.$env{'user.domain'});
5827: return 'refused';
5828: }
5829: $mrole='gr';
5830: } else {
5831: my $cwosec=$url;
5832: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5833: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
5834: my $refused;
5835: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
5836: if (!(&allowed('c'.$role,$url))) {
5837: $refused = 1;
5838: }
5839: } else {
5840: $refused = 1;
5841: }
5842: if ($refused) {
5843: if (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5844: $refused = '';
5845: } else {
5846: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
5847: ' '.$role.' '.$end.' '.$start.' by '.
5848: $env{'user.name'}.' at '.$env{'user.domain'});
5849: return 'refused';
5850: }
5851: }
5852: }
5853: $mrole=$role;
5854: }
5855: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5856: "$udom:$uname:$url".'_'."$mrole=$role";
5857: if ($end) { $command.='_'.$end; }
5858: if ($start) {
5859: if ($end) {
5860: $command.='_'.$start;
5861: } else {
5862: $command.='_0_'.$start;
5863: }
5864: }
5865: my $origstart = $start;
5866: my $origend = $end;
5867: my $delflag;
5868: # actually delete
5869: if ($deleteflag) {
5870: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
5871: # modify command to delete the role
5872: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
5873: "$udom:$uname:$url".'_'."$mrole";
5874: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
5875: # set start and finish to negative values for userrolelog
5876: $start=-1;
5877: $end=-1;
5878: $delflag = 1;
5879: }
5880: }
5881: # send command
5882: my $answer=&reply($command,&homeserver($uname,$udom));
5883: # log new user role if status is ok
5884: if ($answer eq 'ok') {
5885: &userrolelog($role,$uname,$udom,$url,$start,$end);
5886: # for course roles, perform group memberships changes triggered by role change.
5887: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
5888: unless ($role =~ /^gr/) {
5889: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
5890: $origstart,$selfenroll,$context);
5891: }
5892: }
5893: return $answer;
5894: }
5895:
5896: # -------------------------------------------------- Modify user authentication
5897: # Overrides without validation
5898:
5899: sub modifyuserauth {
5900: my ($udom,$uname,$umode,$upass)=@_;
5901: my $uhome=&homeserver($uname,$udom);
5902: unless (&allowed('mau',$udom)) { return 'refused'; }
5903: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
5904: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5905: ' in domain '.$env{'request.role.domain'});
5906: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
5907: &escape($upass),$uhome);
5908: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
5909: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
5910: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5911: &log($udom,,$uname,$uhome,
5912: 'Authentication changed by '.$env{'user.domain'}.', '.
5913: $env{'user.name'}.', '.$umode.
5914: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5915: unless ($reply eq 'ok') {
5916: &logthis('Authentication mode error: '.$reply);
5917: return 'error: '.$reply;
5918: }
5919: return 'ok';
5920: }
5921:
5922: # --------------------------------------------------------------- Modify a user
5923:
5924: sub modifyuser {
5925: my ($udom, $uname, $uid,
5926: $umode, $upass, $first,
5927: $middle, $last, $gene,
5928: $forceid, $desiredhome, $email, $inststatus)=@_;
5929: $udom= &LONCAPA::clean_domain($udom);
5930: $uname=&LONCAPA::clean_username($uname);
5931: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
5932: $umode.', '.$first.', '.$middle.', '.
5933: $last.', '.$gene.'(forceid: '.$forceid.')'.
5934: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
5935: ' desiredhome not specified').
5936: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5937: ' in domain '.$env{'request.role.domain'});
5938: my $uhome=&homeserver($uname,$udom,'true');
5939: # ----------------------------------------------------------------- Create User
5940: if (($uhome eq 'no_host') &&
5941: (($umode && $upass) || ($umode eq 'localauth'))) {
5942: my $unhome='';
5943: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
5944: $unhome = $desiredhome;
5945: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5946: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
5947: } else { # load balancing routine for determining $unhome
5948: my $loadm=10000000;
5949: my %servers = &get_servers($udom,'library');
5950: foreach my $tryserver (keys(%servers)) {
5951: my $answer=reply('load',$tryserver);
5952: if (($answer=~/\d+/) && ($answer<$loadm)) {
5953: $loadm=$answer;
5954: $unhome=$tryserver;
5955: }
5956: }
5957: }
5958: if (($unhome eq '') || ($unhome eq 'no_host')) {
5959: return 'error: unable to find a home server for '.$uname.
5960: ' in domain '.$udom;
5961: }
5962: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
5963: &escape($upass),$unhome);
5964: unless ($reply eq 'ok') {
5965: return 'error: '.$reply;
5966: }
5967: $uhome=&homeserver($uname,$udom,'true');
5968: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
5969: return 'error: unable verify users home machine.';
5970: }
5971: } # End of creation of new user
5972: # ---------------------------------------------------------------------- Add ID
5973: if ($uid) {
5974: $uid=~tr/A-Z/a-z/;
5975: my %uidhash=&idrget($udom,$uname);
5976: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
5977: && (!$forceid)) {
5978: unless ($uid eq $uidhash{$uname}) {
5979: return 'error: user id "'.$uid.'" does not match '.
5980: 'current user id "'.$uidhash{$uname}.'".';
5981: }
5982: } else {
5983: &idput($udom,($uname => $uid));
5984: }
5985: }
5986: # -------------------------------------------------------------- Add names, etc
5987: my @tmp=&get('environment',
5988: ['firstname','middlename','lastname','generation','id',
5989: 'permanentemail','inststatus'],
5990: $udom,$uname);
5991: my %names;
5992: if ($tmp[0] =~ m/^error:.*/) {
5993: %names=();
5994: } else {
5995: %names = @tmp;
5996: }
5997: #
5998: # Make sure to not trash student environment if instructor does not bother
5999: # to supply name and email information
6000: #
6001: if ($first) { $names{'firstname'} = $first; }
6002: if (defined($middle)) { $names{'middlename'} = $middle; }
6003: if ($last) { $names{'lastname'} = $last; }
6004: if (defined($gene)) { $names{'generation'} = $gene; }
6005: if ($email) {
6006: $email=~s/[^\w\@\.\-\,]//gs;
6007: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6008: }
6009: if ($uid) { $names{'id'} = $uid; }
6010: if (defined($inststatus)) {
6011: $names{'inststatus'} = '';
6012: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6013: if (ref($usertypes) eq 'HASH') {
6014: my @okstatuses;
6015: foreach my $item (split(/:/,$inststatus)) {
6016: if (defined($usertypes->{$item})) {
6017: push(@okstatuses,$item);
6018: }
6019: }
6020: if (@okstatuses) {
6021: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6022: }
6023: }
6024: }
6025: my $reply = &put('environment', \%names, $udom,$uname);
6026: if ($reply ne 'ok') { return 'error: '.$reply; }
6027: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6028: &devalidate_cache_new('namescache',$uname.':'.$udom);
6029: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6030: $umode.', '.$first.', '.$middle.', '.
6031: $last.', '.$gene.', '.$email.', '.$inststatus;
6032: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6033: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6034: } else {
6035: $logmsg .= ' during self creation';
6036: }
6037: &logthis($logmsg);
6038: return 'ok';
6039: }
6040:
6041: # -------------------------------------------------------------- Modify student
6042:
6043: sub modifystudent {
6044: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6045: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6046: $selfenroll,$context,$inststatus)=@_;
6047: if (!$cid) {
6048: unless ($cid=$env{'request.course.id'}) {
6049: return 'not_in_class';
6050: }
6051: }
6052: # --------------------------------------------------------------- Make the user
6053: my $reply=&modifyuser
6054: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6055: $desiredhome,$email,$inststatus);
6056: unless ($reply eq 'ok') { return $reply; }
6057: # This will cause &modify_student_enrollment to get the uid from the
6058: # students environment
6059: $uid = undef if (!$forceid);
6060: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6061: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6062: return $reply;
6063: }
6064:
6065: sub modify_student_enrollment {
6066: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6067: my ($cdom,$cnum,$chome);
6068: if (!$cid) {
6069: unless ($cid=$env{'request.course.id'}) {
6070: return 'not_in_class';
6071: }
6072: $cdom=$env{'course.'.$cid.'.domain'};
6073: $cnum=$env{'course.'.$cid.'.num'};
6074: } else {
6075: ($cdom,$cnum)=split(/_/,$cid);
6076: }
6077: $chome=$env{'course.'.$cid.'.home'};
6078: if (!$chome) {
6079: $chome=&homeserver($cnum,$cdom);
6080: }
6081: if (!$chome) { return 'unknown_course'; }
6082: # Make sure the user exists
6083: my $uhome=&homeserver($uname,$udom);
6084: if (($uhome eq '') || ($uhome eq 'no_host')) {
6085: return 'error: no such user';
6086: }
6087: # Get student data if we were not given enough information
6088: if (!defined($first) || $first eq '' ||
6089: !defined($last) || $last eq '' ||
6090: !defined($uid) || $uid eq '' ||
6091: !defined($middle) || $middle eq '' ||
6092: !defined($gene) || $gene eq '') {
6093: # They did not supply us with enough data to enroll the student, so
6094: # we need to pick up more information.
6095: my %tmp = &get('environment',
6096: ['firstname','middlename','lastname', 'generation','id']
6097: ,$udom,$uname);
6098:
6099: #foreach my $key (keys(%tmp)) {
6100: # &logthis("key $key = ".$tmp{$key});
6101: #}
6102: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6103: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6104: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6105: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6106: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6107: }
6108: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6109: my $reply=cput('classlist',
6110: {"$uname:$udom" =>
6111: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6112: $cdom,$cnum);
6113: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6114: return 'error: '.$reply;
6115: } else {
6116: &devalidate_getsection_cache($udom,$uname,$cid);
6117: }
6118: # Add student role to user
6119: my $uurl='/'.$cid;
6120: $uurl=~s/\_/\//g;
6121: if ($usec) {
6122: $uurl.='/'.$usec;
6123: }
6124: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6125: }
6126:
6127: sub format_name {
6128: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6129: my $name;
6130: if ($first ne 'lastname') {
6131: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6132: } else {
6133: if ($lastname=~/\S/) {
6134: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6135: $name=~s/\s+,/,/;
6136: } else {
6137: $name.= $firstname.' '.$middlename.' '.$generation;
6138: }
6139: }
6140: $name=~s/^\s+//;
6141: $name=~s/\s+$//;
6142: $name=~s/\s+/ /g;
6143: return $name;
6144: }
6145:
6146: # ------------------------------------------------- Write to course preferences
6147:
6148: sub writecoursepref {
6149: my ($courseid,%prefs)=@_;
6150: $courseid=~s/^\///;
6151: $courseid=~s/\_/\//g;
6152: my ($cdomain,$cnum)=split(/\//,$courseid);
6153: my $chome=homeserver($cnum,$cdomain);
6154: if (($chome eq '') || ($chome eq 'no_host')) {
6155: return 'error: no such course';
6156: }
6157: my $cstring='';
6158: foreach my $pref (keys(%prefs)) {
6159: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6160: }
6161: $cstring=~s/\&$//;
6162: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6163: }
6164:
6165: # ---------------------------------------------------------- Make/modify course
6166:
6167: sub createcourse {
6168: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6169: $course_owner,$crstype)=@_;
6170: $url=&declutter($url);
6171: my $cid='';
6172: unless (&allowed('ccc',$udom)) {
6173: return 'refused';
6174: }
6175: # ------------------------------------------------------------------- Create ID
6176: my $uname=int(1+rand(9)).
6177: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6178: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6179: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6180: # ----------------------------------------------- Make sure that does not exist
6181: my $uhome=&homeserver($uname,$udom,'true');
6182: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6183: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
6184: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6185: $uhome=&homeserver($uname,$udom,'true');
6186: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6187: return 'error: unable to generate unique course-ID';
6188: }
6189: }
6190: # ------------------------------------------------ Check supplied server name
6191: $course_server = $env{'user.homeserver'} if (! defined($course_server));
6192: if (! &is_library($course_server)) {
6193: return 'error:bad server name '.$course_server;
6194: }
6195: # ------------------------------------------------------------- Make the course
6196: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6197: $course_server);
6198: unless ($reply eq 'ok') { return 'error: '.$reply; }
6199: $uhome=&homeserver($uname,$udom,'true');
6200: if (($uhome eq '') || ($uhome eq 'no_host')) {
6201: return 'error: no such course';
6202: }
6203: # ----------------------------------------------------------------- Course made
6204: # log existence
6205: my $newcourse = {
6206: $udom.'_'.$uname => {
6207: description => $description,
6208: inst_code => $inst_code,
6209: owner => $course_owner,
6210: type => $crstype,
6211: },
6212: };
6213: &courseidput($udom,$newcourse,$uhome,'notime');
6214: # set toplevel url
6215: my $topurl=$url;
6216: unless ($nonstandard) {
6217: # ------------------------------------------ For standard courses, make top url
6218: my $mapurl=&clutter($url);
6219: if ($mapurl eq '/res/') { $mapurl=''; }
6220: $env{'form.initmap'}=(<<ENDINITMAP);
6221: <map>
6222: <resource id="1" type="start"></resource>
6223: <resource id="2" src="$mapurl"></resource>
6224: <resource id="3" type="finish"></resource>
6225: <link index="1" from="1" to="2"></link>
6226: <link index="2" from="2" to="3"></link>
6227: </map>
6228: ENDINITMAP
6229: $topurl=&declutter(
6230: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6231: );
6232: }
6233: # ----------------------------------------------------------- Write preferences
6234: &writecoursepref($udom.'_'.$uname,
6235: ('description' => $description,
6236: 'url' => $topurl));
6237: return '/'.$udom.'/'.$uname;
6238: }
6239:
6240: sub is_course {
6241: my ($cdom,$cnum) = @_;
6242: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
6243: undef,'.');
6244: if (exists($courses{$cdom.'_'.$cnum})) {
6245: return 1;
6246: }
6247: return 0;
6248: }
6249:
6250: # ---------------------------------------------------------- Assign Custom Role
6251:
6252: sub assigncustomrole {
6253: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
6254: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
6255: $end,$start,$deleteflag,$selfenroll,$context);
6256: }
6257:
6258: # ----------------------------------------------------------------- Revoke Role
6259:
6260: sub revokerole {
6261: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
6262: my $now=time;
6263: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
6264: }
6265:
6266: # ---------------------------------------------------------- Revoke Custom Role
6267:
6268: sub revokecustomrole {
6269: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
6270: my $now=time;
6271: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
6272: $deleteflag,$selfenroll,$context);
6273: }
6274:
6275: # ------------------------------------------------------------ Disk usage
6276: sub diskusage {
6277: my ($udom,$uname,$directorypath,$getpropath)=@_;
6278: $directorypath =~ s/\/$//;
6279: my $listing=&reply('du2:'.&escape($directorypath).':'
6280: .&escape($getpropath).':'.&escape($uname).':'
6281: .&escape($udom),homeserver($uname,$udom));
6282: if ($listing eq 'unknown_cmd') {
6283: if ($getpropath) {
6284: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6285: }
6286: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6287: }
6288: return $listing;
6289: }
6290:
6291: sub is_locked {
6292: my ($file_name, $domain, $user) = @_;
6293: my @check;
6294: my $is_locked;
6295: push @check, $file_name;
6296: my %locked = &get('file_permissions',\@check,
6297: $env{'user.domain'},$env{'user.name'});
6298: my ($tmp)=keys(%locked);
6299: if ($tmp=~/^error:/) { undef(%locked); }
6300:
6301: if (ref($locked{$file_name}) eq 'ARRAY') {
6302: $is_locked = 'false';
6303: foreach my $entry (@{$locked{$file_name}}) {
6304: if (ref($entry) eq 'ARRAY') {
6305: $is_locked = 'true';
6306: last;
6307: }
6308: }
6309: } else {
6310: $is_locked = 'false';
6311: }
6312: }
6313:
6314: sub declutter_portfile {
6315: my ($file) = @_;
6316: $file =~ s{^(/portfolio/|portfolio/)}{/};
6317: return $file;
6318: }
6319:
6320: # ------------------------------------------------------------- Mark as Read Only
6321:
6322: sub mark_as_readonly {
6323: my ($domain,$user,$files,$what) = @_;
6324: my %current_permissions = &dump('file_permissions',$domain,$user);
6325: my ($tmp)=keys(%current_permissions);
6326: if ($tmp=~/^error:/) { undef(%current_permissions); }
6327: foreach my $file (@{$files}) {
6328: $file = &declutter_portfile($file);
6329: push(@{$current_permissions{$file}},$what);
6330: }
6331: &put('file_permissions',\%current_permissions,$domain,$user);
6332: return;
6333: }
6334:
6335: # ------------------------------------------------------------Save Selected Files
6336:
6337: sub save_selected_files {
6338: my ($user, $path, @files) = @_;
6339: my $filename = $user."savedfiles";
6340: my @other_files = &files_not_in_path($user, $path);
6341: open (OUT, '>'.$tmpdir.$filename);
6342: foreach my $file (@files) {
6343: print (OUT $env{'form.currentpath'}.$file."\n");
6344: }
6345: foreach my $file (@other_files) {
6346: print (OUT $file."\n");
6347: }
6348: close (OUT);
6349: return 'ok';
6350: }
6351:
6352: sub clear_selected_files {
6353: my ($user) = @_;
6354: my $filename = $user."savedfiles";
6355: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6356: print (OUT undef);
6357: close (OUT);
6358: return ("ok");
6359: }
6360:
6361: sub files_in_path {
6362: my ($user, $path) = @_;
6363: my $filename = $user."savedfiles";
6364: my %return_files;
6365: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6366: while (my $line_in = <IN>) {
6367: chomp ($line_in);
6368: my @paths_and_file = split (m!/!, $line_in);
6369: my $file_part = pop (@paths_and_file);
6370: my $path_part = join ('/', @paths_and_file);
6371: $path_part.='/';
6372: my $path_and_file = $path_part.$file_part;
6373: if ($path_part eq $path) {
6374: $return_files{$file_part}= 'selected';
6375: }
6376: }
6377: close (IN);
6378: return (\%return_files);
6379: }
6380:
6381: # called in portfolio select mode, to show files selected NOT in current directory
6382: sub files_not_in_path {
6383: my ($user, $path) = @_;
6384: my $filename = $user."savedfiles";
6385: my @return_files;
6386: my $path_part;
6387: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6388: while (my $line = <IN>) {
6389: #ok, I know it's clunky, but I want it to work
6390: my @paths_and_file = split(m|/|, $line);
6391: my $file_part = pop(@paths_and_file);
6392: chomp($file_part);
6393: my $path_part = join('/', @paths_and_file);
6394: $path_part .= '/';
6395: my $path_and_file = $path_part.$file_part;
6396: if ($path_part ne $path) {
6397: push(@return_files, ($path_and_file));
6398: }
6399: }
6400: close(OUT);
6401: return (@return_files);
6402: }
6403:
6404: #----------------------------------------------Get portfolio file permissions
6405:
6406: sub get_portfile_permissions {
6407: my ($domain,$user) = @_;
6408: my %current_permissions = &dump('file_permissions',$domain,$user);
6409: my ($tmp)=keys(%current_permissions);
6410: if ($tmp=~/^error:/) { undef(%current_permissions); }
6411: return \%current_permissions;
6412: }
6413:
6414: #---------------------------------------------Get portfolio file access controls
6415:
6416: sub get_access_controls {
6417: my ($current_permissions,$group,$file) = @_;
6418: my %access;
6419: my $real_file = $file;
6420: $file =~ s/\.meta$//;
6421: if (defined($file)) {
6422: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
6423: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
6424: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
6425: }
6426: }
6427: } else {
6428: foreach my $key (keys(%{$current_permissions})) {
6429: if ($key =~ /\0accesscontrol$/) {
6430: if (defined($group)) {
6431: if ($key !~ m-^\Q$group\E/-) {
6432: next;
6433: }
6434: }
6435: my ($fullpath) = split(/\0/,$key);
6436: if (ref($$current_permissions{$key}) eq 'HASH') {
6437: foreach my $control (keys(%{$$current_permissions{$key}})) {
6438: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
6439: }
6440: }
6441: }
6442: }
6443: }
6444: return %access;
6445: }
6446:
6447: sub modify_access_controls {
6448: my ($file_name,$changes,$domain,$user)=@_;
6449: my ($outcome,$deloutcome);
6450: my %store_permissions;
6451: my %new_values;
6452: my %new_control;
6453: my %translation;
6454: my @deletions = ();
6455: my $now = time;
6456: if (exists($$changes{'activate'})) {
6457: if (ref($$changes{'activate'}) eq 'HASH') {
6458: my @newitems = sort(keys(%{$$changes{'activate'}}));
6459: my $numnew = scalar(@newitems);
6460: for (my $i=0; $i<$numnew; $i++) {
6461: my $newkey = $newitems[$i];
6462: my $newid = &Apache::loncommon::get_cgi_id();
6463: if ($newkey =~ /^\d+:/) {
6464: $newkey =~ s/^(\d+)/$newid/;
6465: $translation{$1} = $newid;
6466: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
6467: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
6468: $translation{$1} = $newid;
6469: }
6470: $new_values{$file_name."\0".$newkey} =
6471: $$changes{'activate'}{$newitems[$i]};
6472: $new_control{$newkey} = $now;
6473: }
6474: }
6475: }
6476: my %todelete;
6477: my %changed_items;
6478: foreach my $action ('delete','update') {
6479: if (exists($$changes{$action})) {
6480: if (ref($$changes{$action}) eq 'HASH') {
6481: foreach my $key (keys(%{$$changes{$action}})) {
6482: my ($itemnum) = ($key =~ /^([^:]+):/);
6483: if ($action eq 'delete') {
6484: $todelete{$itemnum} = 1;
6485: } else {
6486: $changed_items{$itemnum} = $key;
6487: }
6488: }
6489: }
6490: }
6491: }
6492: # get lock on access controls for file.
6493: my $lockhash = {
6494: $file_name."\0".'locked_access_records' => $env{'user.name'}.
6495: ':'.$env{'user.domain'},
6496: };
6497: my $tries = 0;
6498: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6499:
6500: while (($gotlock ne 'ok') && $tries <3) {
6501: $tries ++;
6502: sleep 1;
6503: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6504: }
6505: if ($gotlock eq 'ok') {
6506: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
6507: my ($tmp)=keys(%curr_permissions);
6508: if ($tmp=~/^error:/) { undef(%curr_permissions); }
6509: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
6510: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
6511: if (ref($curr_controls) eq 'HASH') {
6512: foreach my $control_item (keys(%{$curr_controls})) {
6513: my ($itemnum) = ($control_item =~ /^([^:]+):/);
6514: if (defined($todelete{$itemnum})) {
6515: push(@deletions,$file_name."\0".$control_item);
6516: } else {
6517: if (defined($changed_items{$itemnum})) {
6518: $new_control{$changed_items{$itemnum}} = $now;
6519: push(@deletions,$file_name."\0".$control_item);
6520: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
6521: } else {
6522: $new_control{$control_item} = $$curr_controls{$control_item};
6523: }
6524: }
6525: }
6526: }
6527: }
6528: my ($group);
6529: if (&is_course($domain,$user)) {
6530: ($group,my $file) = split(/\//,$file_name,2);
6531: }
6532: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
6533: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
6534: $outcome = &put('file_permissions',\%new_values,$domain,$user);
6535: # remove lock
6536: my @del_lock = ($file_name."\0".'locked_access_records');
6537: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
6538: my $sqlresult =
6539: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
6540: $group);
6541: } else {
6542: $outcome = "error: could not obtain lockfile\n";
6543: }
6544: return ($outcome,$deloutcome,\%new_values,\%translation);
6545: }
6546:
6547: sub make_public_indefinitely {
6548: my ($requrl) = @_;
6549: my $now = time;
6550: my $action = 'activate';
6551: my $aclnum = 0;
6552: if (&is_portfolio_url($requrl)) {
6553: my (undef,$udom,$unum,$file_name,$group) =
6554: &parse_portfolio_url($requrl);
6555: my $current_perms = &get_portfile_permissions($udom,$unum);
6556: my %access_controls = &get_access_controls($current_perms,
6557: $group,$file_name);
6558: foreach my $key (keys(%{$access_controls{$file_name}})) {
6559: my ($num,$scope,$end,$start) =
6560: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6561: if ($scope eq 'public') {
6562: if ($start <= $now && $end == 0) {
6563: $action = 'none';
6564: } else {
6565: $action = 'update';
6566: $aclnum = $num;
6567: }
6568: last;
6569: }
6570: }
6571: if ($action eq 'none') {
6572: return 'ok';
6573: } else {
6574: my %changes;
6575: my $newend = 0;
6576: my $newstart = $now;
6577: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
6578: $changes{$action}{$newkey} = {
6579: type => 'public',
6580: time => {
6581: start => $newstart,
6582: end => $newend,
6583: },
6584: };
6585: my ($outcome,$deloutcome,$new_values,$translation) =
6586: &modify_access_controls($file_name,\%changes,$udom,$unum);
6587: return $outcome;
6588: }
6589: } else {
6590: return 'invalid';
6591: }
6592: }
6593:
6594: #------------------------------------------------------Get Marked as Read Only
6595:
6596: sub get_marked_as_readonly {
6597: my ($domain,$user,$what,$group) = @_;
6598: my $current_permissions = &get_portfile_permissions($domain,$user);
6599: my @readonly_files;
6600: my $cmp1=$what;
6601: if (ref($what)) { $cmp1=join('',@{$what}) };
6602: while (my ($file_name,$value) = each(%{$current_permissions})) {
6603: if (defined($group)) {
6604: if ($file_name !~ m-^\Q$group\E/-) {
6605: next;
6606: }
6607: }
6608: if (ref($value) eq "ARRAY"){
6609: foreach my $stored_what (@{$value}) {
6610: my $cmp2=$stored_what;
6611: if (ref($stored_what) eq 'ARRAY') {
6612: $cmp2=join('',@{$stored_what});
6613: }
6614: if ($cmp1 eq $cmp2) {
6615: push(@readonly_files, $file_name);
6616: last;
6617: } elsif (!defined($what)) {
6618: push(@readonly_files, $file_name);
6619: last;
6620: }
6621: }
6622: }
6623: }
6624: return @readonly_files;
6625: }
6626: #-----------------------------------------------------------Get Marked as Read Only Hash
6627:
6628: sub get_marked_as_readonly_hash {
6629: my ($current_permissions,$group,$what) = @_;
6630: my %readonly_files;
6631: while (my ($file_name,$value) = each(%{$current_permissions})) {
6632: if (defined($group)) {
6633: if ($file_name !~ m-^\Q$group\E/-) {
6634: next;
6635: }
6636: }
6637: if (ref($value) eq "ARRAY"){
6638: foreach my $stored_what (@{$value}) {
6639: if (ref($stored_what) eq 'ARRAY') {
6640: foreach my $lock_descriptor(@{$stored_what}) {
6641: if ($lock_descriptor eq 'graded') {
6642: $readonly_files{$file_name} = 'graded';
6643: } elsif ($lock_descriptor eq 'handback') {
6644: $readonly_files{$file_name} = 'handback';
6645: } else {
6646: if (!exists($readonly_files{$file_name})) {
6647: $readonly_files{$file_name} = 'locked';
6648: }
6649: }
6650: }
6651: }
6652: }
6653: }
6654: }
6655: return %readonly_files;
6656: }
6657: # ------------------------------------------------------------ Unmark as Read Only
6658:
6659: sub unmark_as_readonly {
6660: # unmarks $file_name (if $file_name is defined), or all files locked by $what
6661: # for portfolio submissions, $what contains [$symb,$crsid]
6662: my ($domain,$user,$what,$file_name,$group) = @_;
6663: $file_name = &declutter_portfile($file_name);
6664: my $symb_crs = $what;
6665: if (ref($what)) { $symb_crs=join('',@$what); }
6666: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
6667: my ($tmp)=keys(%current_permissions);
6668: if ($tmp=~/^error:/) { undef(%current_permissions); }
6669: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
6670: foreach my $file (@readonly_files) {
6671: my $clean_file = &declutter_portfile($file);
6672: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
6673: my $current_locks = $current_permissions{$file};
6674: my @new_locks;
6675: my @del_keys;
6676: if (ref($current_locks) eq "ARRAY"){
6677: foreach my $locker (@{$current_locks}) {
6678: my $compare=$locker;
6679: if (ref($locker) eq 'ARRAY') {
6680: $compare=join('',@{$locker});
6681: if ($compare ne $symb_crs) {
6682: push(@new_locks, $locker);
6683: }
6684: }
6685: }
6686: if (scalar(@new_locks) > 0) {
6687: $current_permissions{$file} = \@new_locks;
6688: } else {
6689: push(@del_keys, $file);
6690: &del('file_permissions',\@del_keys, $domain, $user);
6691: delete($current_permissions{$file});
6692: }
6693: }
6694: }
6695: &put('file_permissions',\%current_permissions,$domain,$user);
6696: return;
6697: }
6698:
6699: # ------------------------------------------------------------ Directory lister
6700:
6701: sub dirlist {
6702: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
6703: $uri=~s/^\///;
6704: $uri=~s/\/$//;
6705: my ($udom, $uname);
6706: if ($getuserdir) {
6707: $udom = $userdomain;
6708: $uname = $username;
6709: } else {
6710: (undef,$udom,$uname)=split(/\//,$uri);
6711: if(defined($userdomain)) {
6712: $udom = $userdomain;
6713: }
6714: if(defined($username)) {
6715: $uname = $username;
6716: }
6717: }
6718: my ($dirRoot,$listing,@listing_results);
6719:
6720: $dirRoot = $perlvar{'lonDocRoot'};
6721: if (defined($getpropath)) {
6722: $dirRoot = &propath($udom,$uname);
6723: $dirRoot =~ s/\/$//;
6724: } elsif (defined($getuserdir)) {
6725: my $subdir=$uname.'__';
6726: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
6727: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
6728: ."/$udom/$subdir/$uname";
6729: } elsif (defined($alternateRoot)) {
6730: $dirRoot = $alternateRoot;
6731: }
6732:
6733: if($udom) {
6734: if($uname) {
6735: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
6736: .$getuserdir.':'.&escape($dirRoot)
6737: .':'.&escape($uname).':'.&escape($udom),
6738: &homeserver($uname,$udom));
6739: if ($listing eq 'unknown_cmd') {
6740: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
6741: &homeserver($uname,$udom));
6742: } else {
6743: @listing_results = map { &unescape($_); } split(/:/,$listing);
6744: }
6745: if ($listing eq 'unknown_cmd') {
6746: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
6747: &homeserver($uname,$udom));
6748: @listing_results = split(/:/,$listing);
6749: } else {
6750: @listing_results = map { &unescape($_); } split(/:/,$listing);
6751: }
6752: return @listing_results;
6753: } elsif(!$alternateRoot) {
6754: my %allusers;
6755: my %servers = &get_servers($udom,'library');
6756: foreach my $tryserver (keys(%servers)) {
6757: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
6758: &escape($udom),$tryserver);
6759: if ($listing eq 'unknown_cmd') {
6760: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
6761: $udom, $tryserver);
6762: } else {
6763: @listing_results = map { &unescape($_); } split(/:/,$listing);
6764: }
6765: if ($listing eq 'unknown_cmd') {
6766: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
6767: $udom, $tryserver);
6768: @listing_results = split(/:/,$listing);
6769: } else {
6770: @listing_results =
6771: map { &unescape($_); } split(/:/,$listing);
6772: }
6773: if ($listing_results[0] ne 'no_such_dir' &&
6774: $listing_results[0] ne 'empty' &&
6775: $listing_results[0] ne 'con_lost') {
6776: foreach my $line (@listing_results) {
6777: my ($entry) = split(/&/,$line,2);
6778: $allusers{$entry} = 1;
6779: }
6780: }
6781: }
6782: my $alluserstr='';
6783: foreach my $user (sort(keys(%allusers))) {
6784: $alluserstr.=$user.'&user:';
6785: }
6786: $alluserstr=~s/:$//;
6787: return split(/:/,$alluserstr);
6788: } else {
6789: return ('missing user name');
6790: }
6791: } elsif(!defined($getpropath)) {
6792: my @all_domains = sort(&all_domains());
6793: foreach my $domain (@all_domains) {
6794: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
6795: }
6796: return @all_domains;
6797: } else {
6798: return ('missing domain');
6799: }
6800: }
6801:
6802: # --------------------------------------------- GetFileTimestamp
6803: # This function utilizes dirlist and returns the date stamp for
6804: # when it was last modified. It will also return an error of -1
6805: # if an error occurs
6806:
6807: sub GetFileTimestamp {
6808: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
6809: $studentDomain = &LONCAPA::clean_domain($studentDomain);
6810: $studentName = &LONCAPA::clean_username($studentName);
6811: my ($fileStat) =
6812: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
6813: undef,$getuserdir);
6814: my @stats = split('&', $fileStat);
6815: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6816: # @stats contains first the filename, then the stat output
6817: return $stats[10]; # so this is 10 instead of 9.
6818: } else {
6819: return -1;
6820: }
6821: }
6822:
6823: sub stat_file {
6824: my ($uri) = @_;
6825: $uri = &clutter_with_no_wrapper($uri);
6826:
6827: my ($udom,$uname,$file);
6828: if ($uri =~ m-^/(uploaded|editupload)/-) {
6829: ($udom,$uname,$file) =
6830: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
6831: $file = 'userfiles/'.$file;
6832: }
6833: if ($uri =~ m-^/res/-) {
6834: ($udom,$uname) =
6835: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
6836: $file = $uri;
6837: }
6838:
6839: if (!$udom || !$uname || !$file) {
6840: # unable to handle the uri
6841: return ();
6842: }
6843: my $getpropath;
6844: if ($file =~ /^userfiles\//) {
6845: $getpropath = 1;
6846: }
6847: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
6848: my @stats = split('&', $result);
6849:
6850: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6851: shift(@stats); #filename is first
6852: return @stats;
6853: }
6854: return ();
6855: }
6856:
6857: # -------------------------------------------------------- Value of a Condition
6858:
6859: # gets the value of a specific preevaluated condition
6860: # stored in the string $env{user.state.<cid>}
6861: # or looks up a condition reference in the bighash and if if hasn't
6862: # already been evaluated recurses into docondval to get the value of
6863: # the condition, then memoizing it to
6864: # $env{user.state.<cid>.<condition>}
6865: sub directcondval {
6866: my $number=shift;
6867: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
6868: &Apache::lonuserstate::evalstate();
6869: }
6870: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
6871: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
6872: } elsif ($number =~ /^_/) {
6873: my $sub_condition;
6874: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6875: &GDBM_READER(),0640)) {
6876: $sub_condition=$bighash{'conditions'.$number};
6877: untie(%bighash);
6878: }
6879: my $value = &docondval($sub_condition);
6880: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
6881: return $value;
6882: }
6883: if ($env{'user.state.'.$env{'request.course.id'}}) {
6884: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
6885: } else {
6886: return 2;
6887: }
6888: }
6889:
6890: # get the collection of conditions for this resource
6891: sub condval {
6892: my $condidx=shift;
6893: my $allpathcond='';
6894: foreach my $cond (split(/\|/,$condidx)) {
6895: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
6896: $allpathcond.=
6897: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
6898: }
6899: }
6900: $allpathcond=~s/\|$//;
6901: return &docondval($allpathcond);
6902: }
6903:
6904: #evaluates an expression of conditions
6905: sub docondval {
6906: my ($allpathcond) = @_;
6907: my $result=0;
6908: if ($env{'request.course.id'}
6909: && defined($allpathcond)) {
6910: my $operand='|';
6911: my @stack;
6912: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
6913: if ($chunk eq '(') {
6914: push @stack,($operand,$result);
6915: } elsif ($chunk eq ')') {
6916: my $before=pop @stack;
6917: if (pop @stack eq '&') {
6918: $result=$result>$before?$before:$result;
6919: } else {
6920: $result=$result>$before?$result:$before;
6921: }
6922: } elsif (($chunk eq '&') || ($chunk eq '|')) {
6923: $operand=$chunk;
6924: } else {
6925: my $new=directcondval($chunk);
6926: if ($operand eq '&') {
6927: $result=$result>$new?$new:$result;
6928: } else {
6929: $result=$result>$new?$result:$new;
6930: }
6931: }
6932: }
6933: }
6934: return $result;
6935: }
6936:
6937: # ---------------------------------------------------- Devalidate courseresdata
6938:
6939: sub devalidatecourseresdata {
6940: my ($coursenum,$coursedomain)=@_;
6941: my $hashid=$coursenum.':'.$coursedomain;
6942: &devalidate_cache_new('courseres',$hashid);
6943: }
6944:
6945:
6946: # --------------------------------------------------- Course Resourcedata Query
6947: #
6948: # Parameters:
6949: # $coursenum - Number of the course.
6950: # $coursedomain - Domain at which the course was created.
6951: # Returns:
6952: # A hash of the course parameters along (I think) with timestamps
6953: # and version info.
6954:
6955: sub get_courseresdata {
6956: my ($coursenum,$coursedomain)=@_;
6957: my $coursehom=&homeserver($coursenum,$coursedomain);
6958: my $hashid=$coursenum.':'.$coursedomain;
6959: my ($result,$cached)=&is_cached_new('courseres',$hashid);
6960: my %dumpreply;
6961: unless (defined($cached)) {
6962: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
6963: $result=\%dumpreply;
6964: my ($tmp) = keys(%dumpreply);
6965: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6966: &do_cache_new('courseres',$hashid,$result,600);
6967: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
6968: return $tmp;
6969: } elsif ($tmp =~ /^(error)/) {
6970: $result=undef;
6971: &do_cache_new('courseres',$hashid,$result,600);
6972: }
6973: }
6974: return $result;
6975: }
6976:
6977: sub devalidateuserresdata {
6978: my ($uname,$udom)=@_;
6979: my $hashid="$udom:$uname";
6980: &devalidate_cache_new('userres',$hashid);
6981: }
6982:
6983: sub get_userresdata {
6984: my ($uname,$udom)=@_;
6985: #most student don\'t have any data set, check if there is some data
6986: if (&EXT_cache_status($udom,$uname)) { return undef; }
6987:
6988: my $hashid="$udom:$uname";
6989: my ($result,$cached)=&is_cached_new('userres',$hashid);
6990: if (!defined($cached)) {
6991: my %resourcedata=&dump('resourcedata',$udom,$uname);
6992: $result=\%resourcedata;
6993: &do_cache_new('userres',$hashid,$result,600);
6994: }
6995: my ($tmp)=keys(%$result);
6996: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
6997: return $result;
6998: }
6999: #error 2 occurs when the .db doesn't exist
7000: if ($tmp!~/error: 2 /) {
7001: &logthis("<font color=\"blue\">WARNING:".
7002: " Trying to get resource data for ".
7003: $uname." at ".$udom.": ".
7004: $tmp."</font>");
7005: } elsif ($tmp=~/error: 2 /) {
7006: #&EXT_cache_set($udom,$uname);
7007: &do_cache_new('userres',$hashid,undef,600);
7008: undef($tmp); # not really an error so don't send it back
7009: }
7010: return $tmp;
7011: }
7012: #----------------------------------------------- resdata - return resource data
7013: # Purpose:
7014: # Return resource data for either users or for a course.
7015: # Parameters:
7016: # $name - Course/user name.
7017: # $domain - Name of the domain the user/course is registered on.
7018: # $type - Type of thing $name is (must be 'course' or 'user'
7019: # @which - Array of names of resources desired.
7020: # Returns:
7021: # The value of the first reasource in @which that is found in the
7022: # resource hash.
7023: # Exceptional Conditions:
7024: # If the $type passed in is not valid (not the string 'course' or
7025: # 'user', an undefined reference is returned.
7026: # If none of the resources are found, an undef is returned
7027: sub resdata {
7028: my ($name,$domain,$type,@which)=@_;
7029: my $result;
7030: if ($type eq 'course') {
7031: $result=&get_courseresdata($name,$domain);
7032: } elsif ($type eq 'user') {
7033: $result=&get_userresdata($name,$domain);
7034: }
7035: if (!ref($result)) { return $result; }
7036: foreach my $item (@which) {
7037: if (defined($result->{$item->[0]})) {
7038: return [$result->{$item->[0]},$item->[1]];
7039: }
7040: }
7041: return undef;
7042: }
7043:
7044: #
7045: # EXT resource caching routines
7046: #
7047:
7048: sub clear_EXT_cache_status {
7049: &delenv('cache.EXT.');
7050: }
7051:
7052: sub EXT_cache_status {
7053: my ($target_domain,$target_user) = @_;
7054: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7055: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7056: # We know already the user has no data
7057: return 1;
7058: } else {
7059: return 0;
7060: }
7061: }
7062:
7063: sub EXT_cache_set {
7064: my ($target_domain,$target_user) = @_;
7065: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7066: #&appenv({$cachename => time});
7067: }
7068:
7069: # --------------------------------------------------------- Value of a Variable
7070: sub EXT {
7071:
7072: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7073: unless ($varname) { return ''; }
7074: #get real user name/domain, courseid and symb
7075: my $courseid;
7076: my $publicuser;
7077: if ($symbparm) {
7078: $symbparm=&get_symb_from_alias($symbparm);
7079: }
7080: if (!($uname && $udom)) {
7081: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7082: if (!$symbparm) { $symbparm=$cursymb; }
7083: } else {
7084: $courseid=$env{'request.course.id'};
7085: }
7086: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7087: my $rest;
7088: if (defined($therest[0])) {
7089: $rest=join('.',@therest);
7090: } else {
7091: $rest='';
7092: }
7093:
7094: my $qualifierrest=$qualifier;
7095: if ($rest) { $qualifierrest.='.'.$rest; }
7096: my $spacequalifierrest=$space;
7097: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7098: if ($realm eq 'user') {
7099: # --------------------------------------------------------------- user.resource
7100: if ($space eq 'resource') {
7101: if ( (defined($Apache::lonhomework::parsing_a_problem)
7102: || defined($Apache::lonhomework::parsing_a_task))
7103: &&
7104: ($symbparm eq &symbread()) ) {
7105: # if we are in the middle of processing the resource the
7106: # get the value we are planning on committing
7107: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7108: return $Apache::lonhomework::results{$qualifierrest};
7109: } else {
7110: return $Apache::lonhomework::history{$qualifierrest};
7111: }
7112: } else {
7113: my %restored;
7114: if ($publicuser || $env{'request.state'} eq 'construct') {
7115: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7116: } else {
7117: %restored=&restore($symbparm,$courseid,$udom,$uname);
7118: }
7119: return $restored{$qualifierrest};
7120: }
7121: # ----------------------------------------------------------------- user.access
7122: } elsif ($space eq 'access') {
7123: # FIXME - not supporting calls for a specific user
7124: return &allowed($qualifier,$rest);
7125: # ------------------------------------------ user.preferences, user.environment
7126: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7127: if (($uname eq $env{'user.name'}) &&
7128: ($udom eq $env{'user.domain'})) {
7129: return $env{join('.',('environment',$qualifierrest))};
7130: } else {
7131: my %returnhash;
7132: if (!$publicuser) {
7133: %returnhash=&userenvironment($udom,$uname,
7134: $qualifierrest);
7135: }
7136: return $returnhash{$qualifierrest};
7137: }
7138: # ----------------------------------------------------------------- user.course
7139: } elsif ($space eq 'course') {
7140: # FIXME - not supporting calls for a specific user
7141: return $env{join('.',('request.course',$qualifier))};
7142: # ------------------------------------------------------------------- user.role
7143: } elsif ($space eq 'role') {
7144: # FIXME - not supporting calls for a specific user
7145: my ($role,$where)=split(/\./,$env{'request.role'});
7146: if ($qualifier eq 'value') {
7147: return $role;
7148: } elsif ($qualifier eq 'extent') {
7149: return $where;
7150: }
7151: # ----------------------------------------------------------------- user.domain
7152: } elsif ($space eq 'domain') {
7153: return $udom;
7154: # ------------------------------------------------------------------- user.name
7155: } elsif ($space eq 'name') {
7156: return $uname;
7157: # ---------------------------------------------------- Any other user namespace
7158: } else {
7159: my %reply;
7160: if (!$publicuser) {
7161: %reply=&get($space,[$qualifierrest],$udom,$uname);
7162: }
7163: return $reply{$qualifierrest};
7164: }
7165: } elsif ($realm eq 'query') {
7166: # ---------------------------------------------- pull stuff out of query string
7167: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7168: [$spacequalifierrest]);
7169: return $env{'form.'.$spacequalifierrest};
7170: } elsif ($realm eq 'request') {
7171: # ------------------------------------------------------------- request.browser
7172: if ($space eq 'browser') {
7173: if ($qualifier eq 'textremote') {
7174: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7175: return 1;
7176: } else {
7177: return 0;
7178: }
7179: } else {
7180: return $env{'browser.'.$qualifier};
7181: }
7182: # ------------------------------------------------------------ request.filename
7183: } else {
7184: return $env{'request.'.$spacequalifierrest};
7185: }
7186: } elsif ($realm eq 'course') {
7187: # ---------------------------------------------------------- course.description
7188: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7189: } elsif ($realm eq 'resource') {
7190:
7191: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7192: if (!$symbparm) { $symbparm=&symbread(); }
7193: }
7194:
7195: if ($space eq 'title') {
7196: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7197: return &gettitle($symbparm);
7198: }
7199:
7200: if ($space eq 'map') {
7201: my ($map) = &decode_symb($symbparm);
7202: return &symbread($map);
7203: }
7204: if ($space eq 'filename') {
7205: if ($symbparm) {
7206: return &clutter((&decode_symb($symbparm))[2]);
7207: }
7208: return &hreflocation('',$env{'request.filename'});
7209: }
7210:
7211: my ($section, $group, @groups);
7212: my ($courselevelm,$courselevel);
7213: if ($symbparm && defined($courseid) &&
7214: $courseid eq $env{'request.course.id'}) {
7215:
7216: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
7217:
7218: # ----------------------------------------------------- Cascading lookup scheme
7219: my $symbp=$symbparm;
7220: my $mapp=&deversion((&decode_symb($symbp))[0]);
7221:
7222: my $symbparm=$symbp.'.'.$spacequalifierrest;
7223: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7224:
7225: if (($env{'user.name'} eq $uname) &&
7226: ($env{'user.domain'} eq $udom)) {
7227: $section=$env{'request.course.sec'};
7228: @groups = split(/:/,$env{'request.course.groups'});
7229: @groups=&sort_course_groups($courseid,@groups);
7230: } else {
7231: if (! defined($usection)) {
7232: $section=&getsection($udom,$uname,$courseid);
7233: } else {
7234: $section = $usection;
7235: }
7236: @groups = &get_users_groups($udom,$uname,$courseid);
7237: }
7238:
7239: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7240: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7241: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7242:
7243: $courselevel=$courseid.'.'.$spacequalifierrest;
7244: my $courselevelr=$courseid.'.'.$symbparm;
7245: $courselevelm=$courseid.'.'.$mapparm;
7246:
7247: # ----------------------------------------------------------- first, check user
7248:
7249: my $userreply=&resdata($uname,$udom,'user',
7250: ([$courselevelr,'resource'],
7251: [$courselevelm,'map' ],
7252: [$courselevel, 'course' ]));
7253: if (defined($userreply)) { return &get_reply($userreply); }
7254:
7255: # ------------------------------------------------ second, check some of course
7256: my $coursereply;
7257: if (@groups > 0) {
7258: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7259: $mapparm,$spacequalifierrest);
7260: if (defined($coursereply)) { return &get_reply($coursereply); }
7261: }
7262:
7263: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7264: $env{'course.'.$courseid.'.domain'},
7265: 'course',
7266: ([$seclevelr, 'resource'],
7267: [$seclevelm, 'map' ],
7268: [$seclevel, 'course' ],
7269: [$courselevelr,'resource']));
7270: if (defined($coursereply)) { return &get_reply($coursereply); }
7271:
7272: # ------------------------------------------------------ third, check map parms
7273: my %parmhash=();
7274: my $thisparm='';
7275: if (tie(%parmhash,'GDBM_File',
7276: $env{'request.course.fn'}.'_parms.db',
7277: &GDBM_READER(),0640)) {
7278: $thisparm=$parmhash{$symbparm};
7279: untie(%parmhash);
7280: }
7281: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
7282: }
7283: # ------------------------------------------ fourth, look in resource metadata
7284:
7285: $spacequalifierrest=~s/\./\_/;
7286: my $filename;
7287: if (!$symbparm) { $symbparm=&symbread(); }
7288: if ($symbparm) {
7289: $filename=(&decode_symb($symbparm))[2];
7290: } else {
7291: $filename=$env{'request.filename'};
7292: }
7293: my $metadata=&metadata($filename,$spacequalifierrest);
7294: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7295: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
7296: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7297:
7298: # ---------------------------------------------- fourth, look in rest of course
7299: if ($symbparm && defined($courseid) &&
7300: $courseid eq $env{'request.course.id'}) {
7301: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7302: $env{'course.'.$courseid.'.domain'},
7303: 'course',
7304: ([$courselevelm,'map' ],
7305: [$courselevel, 'course']));
7306: if (defined($coursereply)) { return &get_reply($coursereply); }
7307: }
7308: # ------------------------------------------------------------------ Cascade up
7309: unless ($space eq '0') {
7310: my @parts=split(/_/,$space);
7311: my $id=pop(@parts);
7312: my $part=join('_',@parts);
7313: if ($part eq '') { $part='0'; }
7314: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
7315: $symbparm,$udom,$uname,$section,1);
7316: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
7317: }
7318: if ($recurse) { return undef; }
7319: my $pack_def=&packages_tab_default($filename,$varname);
7320: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
7321: # ---------------------------------------------------- Any other user namespace
7322: } elsif ($realm eq 'environment') {
7323: # ----------------------------------------------------------------- environment
7324: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7325: return $env{'environment.'.$spacequalifierrest};
7326: } else {
7327: if ($uname eq 'anonymous' && $udom eq '') {
7328: return '';
7329: }
7330: my %returnhash=&userenvironment($udom,$uname,
7331: $spacequalifierrest);
7332: return $returnhash{$spacequalifierrest};
7333: }
7334: } elsif ($realm eq 'system') {
7335: # ----------------------------------------------------------------- system.time
7336: if ($space eq 'time') {
7337: return time;
7338: }
7339: } elsif ($realm eq 'server') {
7340: # ----------------------------------------------------------------- system.time
7341: if ($space eq 'name') {
7342: return $ENV{'SERVER_NAME'};
7343: }
7344: }
7345: return '';
7346: }
7347:
7348: sub get_reply {
7349: my ($reply_value) = @_;
7350: if (ref($reply_value) eq 'ARRAY') {
7351: if (wantarray) {
7352: return @$reply_value;
7353: }
7354: return $reply_value->[0];
7355: } else {
7356: return $reply_value;
7357: }
7358: }
7359:
7360: sub check_group_parms {
7361: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
7362: my @groupitems = ();
7363: my $resultitem;
7364: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
7365: foreach my $group (@{$groups}) {
7366: foreach my $level (@levels) {
7367: my $item = $courseid.'.['.$group.'].'.$level->[0];
7368: push(@groupitems,[$item,$level->[1]]);
7369: }
7370: }
7371: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
7372: $env{'course.'.$courseid.'.domain'},
7373: 'course',@groupitems);
7374: return $coursereply;
7375: }
7376:
7377: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
7378: my ($courseid,@groups) = @_;
7379: @groups = sort(@groups);
7380: return @groups;
7381: }
7382:
7383: sub packages_tab_default {
7384: my ($uri,$varname)=@_;
7385: my (undef,$part,$name)=split(/\./,$varname);
7386:
7387: my (@extension,@specifics,$do_default);
7388: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
7389: my ($pack_type,$pack_part)=split(/_/,$package,2);
7390: if ($pack_type eq 'default') {
7391: $do_default=1;
7392: } elsif ($pack_type eq 'extension') {
7393: push(@extension,[$package,$pack_type,$pack_part]);
7394: } elsif ($pack_part eq $part || $pack_type eq 'part') {
7395: # only look at packages defaults for packages that this id is
7396: push(@specifics,[$package,$pack_type,$pack_part]);
7397: }
7398: }
7399: # first look for a package that matches the requested part id
7400: foreach my $package (@specifics) {
7401: my (undef,$pack_type,$pack_part)=@{$package};
7402: next if ($pack_part ne $part);
7403: if (defined($packagetab{"$pack_type&$name&default"})) {
7404: return $packagetab{"$pack_type&$name&default"};
7405: }
7406: }
7407: # look for any possible matching non extension_ package
7408: foreach my $package (@specifics) {
7409: my (undef,$pack_type,$pack_part)=@{$package};
7410: if (defined($packagetab{"$pack_type&$name&default"})) {
7411: return $packagetab{"$pack_type&$name&default"};
7412: }
7413: if ($pack_type eq 'part') { $pack_part='0'; }
7414: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
7415: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
7416: }
7417: }
7418: # look for any posible extension_ match
7419: foreach my $package (@extension) {
7420: my ($package,$pack_type)=@{$package};
7421: if (defined($packagetab{"$pack_type&$name&default"})) {
7422: return $packagetab{"$pack_type&$name&default"};
7423: }
7424: if (defined($packagetab{$package."&$name&default"})) {
7425: return $packagetab{$package."&$name&default"};
7426: }
7427: }
7428: # look for a global default setting
7429: if ($do_default && defined($packagetab{"default&$name&default"})) {
7430: return $packagetab{"default&$name&default"};
7431: }
7432: return undef;
7433: }
7434:
7435: sub add_prefix_and_part {
7436: my ($prefix,$part)=@_;
7437: my $keyroot;
7438: if (defined($prefix) && $prefix !~ /^__/) {
7439: # prefix that has a part already
7440: $keyroot=$prefix;
7441: } elsif (defined($prefix)) {
7442: # prefix that is missing a part
7443: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
7444: } else {
7445: # no prefix at all
7446: if (defined($part)) { $keyroot='_'.$part; }
7447: }
7448: return $keyroot;
7449: }
7450:
7451: # ---------------------------------------------------------------- Get metadata
7452:
7453: my %metaentry;
7454: sub metadata {
7455: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
7456: $uri=&declutter($uri);
7457: # if it is a non metadata possible uri return quickly
7458: if (($uri eq '') ||
7459: (($uri =~ m|^/*adm/|) &&
7460: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
7461: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
7462: return undef;
7463: }
7464: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
7465: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
7466: return undef;
7467: }
7468: my $filename=$uri;
7469: $uri=~s/\.meta$//;
7470: #
7471: # Is the metadata already cached?
7472: # Look at timestamp of caching
7473: # Everything is cached by the main uri, libraries are never directly cached
7474: #
7475: if (!defined($liburi)) {
7476: my ($result,$cached)=&is_cached_new('meta',$uri);
7477: if (defined($cached)) { return $result->{':'.$what}; }
7478: }
7479: {
7480: #
7481: # Is this a recursive call for a library?
7482: #
7483: # if (! exists($metacache{$uri})) {
7484: # $metacache{$uri}={};
7485: # }
7486: my $cachetime = 60*60;
7487: if ($liburi) {
7488: $liburi=&declutter($liburi);
7489: $filename=$liburi;
7490: } else {
7491: &devalidate_cache_new('meta',$uri);
7492: undef(%metaentry);
7493: }
7494: my %metathesekeys=();
7495: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
7496: my $metastring;
7497: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
7498: my $which = &hreflocation('','/'.($liburi || $uri));
7499: $metastring =
7500: &Apache::lonnet::ssi_body($which,
7501: ('grade_target' => 'meta'));
7502: $cachetime = 1; # only want this cached in the child not long term
7503: } elsif ($uri !~ m -^(editupload)/-) {
7504: my $file=&filelocation('',&clutter($filename));
7505: #push(@{$metaentry{$uri.'.file'}},$file);
7506: $metastring=&getfile($file);
7507: }
7508: my $parser=HTML::LCParser->new(\$metastring);
7509: my $token;
7510: undef %metathesekeys;
7511: while ($token=$parser->get_token) {
7512: if ($token->[0] eq 'S') {
7513: if (defined($token->[2]->{'package'})) {
7514: #
7515: # This is a package - get package info
7516: #
7517: my $package=$token->[2]->{'package'};
7518: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7519: if (defined($token->[2]->{'id'})) {
7520: $keyroot.='_'.$token->[2]->{'id'};
7521: }
7522: if ($metaentry{':packages'}) {
7523: $metaentry{':packages'}.=','.$package.$keyroot;
7524: } else {
7525: $metaentry{':packages'}=$package.$keyroot;
7526: }
7527: foreach my $pack_entry (keys(%packagetab)) {
7528: my $part=$keyroot;
7529: $part=~s/^\_//;
7530: if ($pack_entry=~/^\Q$package\E\&/ ||
7531: $pack_entry=~/^\Q$package\E_0\&/) {
7532: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
7533: # ignore package.tab specified default values
7534: # here &package_tab_default() will fetch those
7535: if ($subp eq 'default') { next; }
7536: my $value=$packagetab{$pack_entry};
7537: my $unikey;
7538: if ($pack =~ /_0$/) {
7539: $unikey='parameter_0_'.$name;
7540: $part=0;
7541: } else {
7542: $unikey='parameter'.$keyroot.'_'.$name;
7543: }
7544: if ($subp eq 'display') {
7545: $value.=' [Part: '.$part.']';
7546: }
7547: $metaentry{':'.$unikey.'.part'}=$part;
7548: $metathesekeys{$unikey}=1;
7549: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7550: $metaentry{':'.$unikey.'.'.$subp}=$value;
7551: }
7552: if (defined($metaentry{':'.$unikey.'.default'})) {
7553: $metaentry{':'.$unikey}=
7554: $metaentry{':'.$unikey.'.default'};
7555: }
7556: }
7557: }
7558: } else {
7559: #
7560: # This is not a package - some other kind of start tag
7561: #
7562: my $entry=$token->[1];
7563: my $unikey;
7564: if ($entry eq 'import') {
7565: $unikey='';
7566: } else {
7567: $unikey=$entry;
7568: }
7569: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7570:
7571: if (defined($token->[2]->{'id'})) {
7572: $unikey.='_'.$token->[2]->{'id'};
7573: }
7574:
7575: if ($entry eq 'import') {
7576: #
7577: # Importing a library here
7578: #
7579: if ($depthcount<20) {
7580: my $location=$parser->get_text('/import');
7581: my $dir=$filename;
7582: $dir=~s|[^/]*$||;
7583: $location=&filelocation($dir,$location);
7584: my $metadata =
7585: &metadata($uri,'keys', $location,$unikey,
7586: $depthcount+1);
7587: foreach my $meta (split(',',$metadata)) {
7588: $metaentry{':'.$meta}=$metaentry{':'.$meta};
7589: $metathesekeys{$meta}=1;
7590: }
7591: }
7592: } else {
7593:
7594: if (defined($token->[2]->{'name'})) {
7595: $unikey.='_'.$token->[2]->{'name'};
7596: }
7597: $metathesekeys{$unikey}=1;
7598: foreach my $param (@{$token->[3]}) {
7599: $metaentry{':'.$unikey.'.'.$param} =
7600: $token->[2]->{$param};
7601: }
7602: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
7603: my $default=$metaentry{':'.$unikey.'.default'};
7604: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
7605: # only ws inside the tag, and not in default, so use default
7606: # as value
7607: $metaentry{':'.$unikey}=$default;
7608: } elsif ( $internaltext =~ /\S/ ) {
7609: # something interesting inside the tag
7610: $metaentry{':'.$unikey}=$internaltext;
7611: } else {
7612: # no interesting values, don't set a default
7613: }
7614: # end of not-a-package not-a-library import
7615: }
7616: # end of not-a-package start tag
7617: }
7618: # the next is the end of "start tag"
7619: }
7620: }
7621: my ($extension) = ($uri =~ /\.(\w+)$/);
7622: $extension = lc($extension);
7623: if ($extension eq 'htm') { $extension='html'; }
7624:
7625: foreach my $key (keys(%packagetab)) {
7626: #no specific packages #how's our extension
7627: if ($key!~/^extension_\Q$extension\E&/) { next; }
7628: &metadata_create_package_def($uri,$key,'extension_'.$extension,
7629: \%metathesekeys);
7630: }
7631:
7632: if (!exists($metaentry{':packages'})
7633: || $packagetab{"import_defaults&extension_$extension"}) {
7634: foreach my $key (keys(%packagetab)) {
7635: #no specific packages well let's get default then
7636: if ($key!~/^default&/) { next; }
7637: &metadata_create_package_def($uri,$key,'default',
7638: \%metathesekeys);
7639: }
7640: }
7641: # are there custom rights to evaluate
7642: if ($metaentry{':copyright'} eq 'custom') {
7643:
7644: #
7645: # Importing a rights file here
7646: #
7647: unless ($depthcount) {
7648: my $location=$metaentry{':customdistributionfile'};
7649: my $dir=$filename;
7650: $dir=~s|[^/]*$||;
7651: $location=&filelocation($dir,$location);
7652: my $rights_metadata =
7653: &metadata($uri,'keys',$location,'_rights',
7654: $depthcount+1);
7655: foreach my $rights (split(',',$rights_metadata)) {
7656: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
7657: $metathesekeys{$rights}=1;
7658: }
7659: }
7660: }
7661: # uniqifiy package listing
7662: my %seen;
7663: my @uniq_packages =
7664: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
7665: $metaentry{':packages'} = join(',',@uniq_packages);
7666:
7667: $metaentry{':keys'} = join(',',keys(%metathesekeys));
7668: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
7669: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
7670: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
7671: # this is the end of "was not already recently cached
7672: }
7673: return $metaentry{':'.$what};
7674: }
7675:
7676: sub metadata_create_package_def {
7677: my ($uri,$key,$package,$metathesekeys)=@_;
7678: my ($pack,$name,$subp)=split(/\&/,$key);
7679: if ($subp eq 'default') { next; }
7680:
7681: if (defined($metaentry{':packages'})) {
7682: $metaentry{':packages'}.=','.$package;
7683: } else {
7684: $metaentry{':packages'}=$package;
7685: }
7686: my $value=$packagetab{$key};
7687: my $unikey;
7688: $unikey='parameter_0_'.$name;
7689: $metaentry{':'.$unikey.'.part'}=0;
7690: $$metathesekeys{$unikey}=1;
7691: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7692: $metaentry{':'.$unikey.'.'.$subp}=$value;
7693: }
7694: if (defined($metaentry{':'.$unikey.'.default'})) {
7695: $metaentry{':'.$unikey}=
7696: $metaentry{':'.$unikey.'.default'};
7697: }
7698: }
7699:
7700: sub metadata_generate_part0 {
7701: my ($metadata,$metacache,$uri) = @_;
7702: my %allnames;
7703: foreach my $metakey (keys(%$metadata)) {
7704: if ($metakey=~/^parameter\_(.*)/) {
7705: my $part=$$metacache{':'.$metakey.'.part'};
7706: my $name=$$metacache{':'.$metakey.'.name'};
7707: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
7708: $allnames{$name}=$part;
7709: }
7710: }
7711: }
7712: foreach my $name (keys(%allnames)) {
7713: $$metadata{"parameter_0_$name"}=1;
7714: my $key=":parameter_0_$name";
7715: $$metacache{"$key.part"}='0';
7716: $$metacache{"$key.name"}=$name;
7717: $$metacache{"$key.type"}=$$metacache{':parameter_'.
7718: $allnames{$name}.'_'.$name.
7719: '.type'};
7720: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
7721: '.display'};
7722: my $expr='[Part: '.$allnames{$name}.']';
7723: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
7724: $$metacache{"$key.display"}=$olddis;
7725: }
7726: }
7727:
7728: # ------------------------------------------------------ Devalidate title cache
7729:
7730: sub devalidate_title_cache {
7731: my ($url)=@_;
7732: if (!$env{'request.course.id'}) { return; }
7733: my $symb=&symbread($url);
7734: if (!$symb) { return; }
7735: my $key=$env{'request.course.id'}."\0".$symb;
7736: &devalidate_cache_new('title',$key);
7737: }
7738:
7739: # ------------------------------------------------- Get the title of a resource
7740:
7741: sub gettitle {
7742: my $urlsymb=shift;
7743: my $symb=&symbread($urlsymb);
7744: if ($symb) {
7745: my $key=$env{'request.course.id'}."\0".$symb;
7746: my ($result,$cached)=&is_cached_new('title',$key);
7747: if (defined($cached)) {
7748: return $result;
7749: }
7750: my ($map,$resid,$url)=&decode_symb($symb);
7751: my $title='';
7752: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
7753: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
7754: } else {
7755: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7756: &GDBM_READER(),0640)) {
7757: my $mapid=$bighash{'map_pc_'.&clutter($map)};
7758: $title=$bighash{'title_'.$mapid.'.'.$resid};
7759: untie(%bighash);
7760: }
7761: }
7762: $title=~s/\&colon\;/\:/gs;
7763: if ($title) {
7764: return &do_cache_new('title',$key,$title,600);
7765: }
7766: $urlsymb=$url;
7767: }
7768: my $title=&metadata($urlsymb,'title');
7769: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
7770: return $title;
7771: }
7772:
7773: sub get_slot {
7774: my ($which,$cnum,$cdom)=@_;
7775: if (!$cnum || !$cdom) {
7776: (undef,my $courseid)=&whichuser();
7777: $cdom=$env{'course.'.$courseid.'.domain'};
7778: $cnum=$env{'course.'.$courseid.'.num'};
7779: }
7780: my $key=join("\0",'slots',$cdom,$cnum,$which);
7781: my %slotinfo;
7782: if (exists($remembered{$key})) {
7783: $slotinfo{$which} = $remembered{$key};
7784: } else {
7785: %slotinfo=&get('slots',[$which],$cdom,$cnum);
7786: &Apache::lonhomework::showhash(%slotinfo);
7787: my ($tmp)=keys(%slotinfo);
7788: if ($tmp=~/^error:/) { return (); }
7789: $remembered{$key} = $slotinfo{$which};
7790: }
7791: if (ref($slotinfo{$which}) eq 'HASH') {
7792: return %{$slotinfo{$which}};
7793: }
7794: return $slotinfo{$which};
7795: }
7796: # ------------------------------------------------- Update symbolic store links
7797:
7798: sub symblist {
7799: my ($mapname,%newhash)=@_;
7800: $mapname=&deversion(&declutter($mapname));
7801: my %hash;
7802: if (($env{'request.course.fn'}) && (%newhash)) {
7803: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7804: &GDBM_WRCREAT(),0640)) {
7805: foreach my $url (keys %newhash) {
7806: next if ($url eq 'last_known'
7807: && $env{'form.no_update_last_known'});
7808: $hash{declutter($url)}=&encode_symb($mapname,
7809: $newhash{$url}->[1],
7810: $newhash{$url}->[0]);
7811: }
7812: if (untie(%hash)) {
7813: return 'ok';
7814: }
7815: }
7816: }
7817: return 'error';
7818: }
7819:
7820: # --------------------------------------------------------------- Verify a symb
7821:
7822: sub symbverify {
7823: my ($symb,$thisurl)=@_;
7824: my $thisfn=$thisurl;
7825: $thisfn=&declutter($thisfn);
7826: # direct jump to resource in page or to a sequence - will construct own symbs
7827: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
7828: # check URL part
7829: my ($map,$resid,$url)=&decode_symb($symb);
7830:
7831: unless ($url eq $thisfn) { return 0; }
7832:
7833: $symb=&symbclean($symb);
7834: $thisurl=&deversion($thisurl);
7835: $thisfn=&deversion($thisfn);
7836:
7837: my %bighash;
7838: my $okay=0;
7839:
7840: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7841: &GDBM_READER(),0640)) {
7842: my $ids=$bighash{'ids_'.&clutter($thisurl)};
7843: unless ($ids) {
7844: $ids=$bighash{'ids_/'.$thisurl};
7845: }
7846: if ($ids) {
7847: # ------------------------------------------------------------------- Has ID(s)
7848: foreach my $id (split(/\,/,$ids)) {
7849: my ($mapid,$resid)=split(/\./,$id);
7850: if (
7851: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
7852: eq $symb) {
7853: if (($env{'request.role.adv'}) ||
7854: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
7855: $okay=1;
7856: }
7857: }
7858: }
7859: }
7860: untie(%bighash);
7861: }
7862: return $okay;
7863: }
7864:
7865: # --------------------------------------------------------------- Clean-up symb
7866:
7867: sub symbclean {
7868: my $symb=shift;
7869: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7870: # remove version from map
7871: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
7872:
7873: # remove version from URL
7874: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
7875:
7876: # remove wrapper
7877:
7878: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
7879: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
7880: return $symb;
7881: }
7882:
7883: # ---------------------------------------------- Split symb to find map and url
7884:
7885: sub encode_symb {
7886: my ($map,$resid,$url)=@_;
7887: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
7888: }
7889:
7890: sub decode_symb {
7891: my $symb=shift;
7892: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7893: my ($map,$resid,$url)=split(/___/,$symb);
7894: return (&fixversion($map),$resid,&fixversion($url));
7895: }
7896:
7897: sub fixversion {
7898: my $fn=shift;
7899: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
7900: my %bighash;
7901: my $uri=&clutter($fn);
7902: my $key=$env{'request.course.id'}.'_'.$uri;
7903: # is this cached?
7904: my ($result,$cached)=&is_cached_new('courseresversion',$key);
7905: if (defined($cached)) { return $result; }
7906: # unfortunately not cached, or expired
7907: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7908: &GDBM_READER(),0640)) {
7909: if ($bighash{'version_'.$uri}) {
7910: my $version=$bighash{'version_'.$uri};
7911: unless (($version eq 'mostrecent') ||
7912: ($version==&getversion($uri))) {
7913: $uri=~s/\.(\w+)$/\.$version\.$1/;
7914: }
7915: }
7916: untie %bighash;
7917: }
7918: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
7919: }
7920:
7921: sub deversion {
7922: my $url=shift;
7923: $url=~s/\.\d+\.(\w+)$/\.$1/;
7924: return $url;
7925: }
7926:
7927: # ------------------------------------------------------ Return symb list entry
7928:
7929: sub symbread {
7930: my ($thisfn,$donotrecurse)=@_;
7931: my $cache_str='request.symbread.cached.'.$thisfn;
7932: if (defined($env{$cache_str})) { return $env{$cache_str}; }
7933: # no filename provided? try from environment
7934: unless ($thisfn) {
7935: if ($env{'request.symb'}) {
7936: return $env{$cache_str}=&symbclean($env{'request.symb'});
7937: }
7938: $thisfn=$env{'request.filename'};
7939: }
7940: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7941: # is that filename actually a symb? Verify, clean, and return
7942: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
7943: if (&symbverify($thisfn,$1)) {
7944: return $env{$cache_str}=&symbclean($thisfn);
7945: }
7946: }
7947: $thisfn=declutter($thisfn);
7948: my %hash;
7949: my %bighash;
7950: my $syval='';
7951: if (($env{'request.course.fn'}) && ($thisfn)) {
7952: my $targetfn = $thisfn;
7953: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
7954: $targetfn = 'adm/wrapper/'.$thisfn;
7955: }
7956: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
7957: $targetfn=$1;
7958: }
7959: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7960: &GDBM_READER(),0640)) {
7961: $syval=$hash{$targetfn};
7962: untie(%hash);
7963: }
7964: # ---------------------------------------------------------- There was an entry
7965: if ($syval) {
7966: #unless ($syval=~/\_\d+$/) {
7967: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
7968: #&appenv({'request.ambiguous' => $thisfn});
7969: #return $env{$cache_str}='';
7970: #}
7971: #$syval.=$1;
7972: #}
7973: } else {
7974: # ------------------------------------------------------- Was not in symb table
7975: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7976: &GDBM_READER(),0640)) {
7977: # ---------------------------------------------- Get ID(s) for current resource
7978: my $ids=$bighash{'ids_'.&clutter($thisfn)};
7979: unless ($ids) {
7980: $ids=$bighash{'ids_/'.$thisfn};
7981: }
7982: unless ($ids) {
7983: # alias?
7984: $ids=$bighash{'mapalias_'.$thisfn};
7985: }
7986: if ($ids) {
7987: # ------------------------------------------------------------------- Has ID(s)
7988: my @possibilities=split(/\,/,$ids);
7989: if ($#possibilities==0) {
7990: # ----------------------------------------------- There is only one possibility
7991: my ($mapid,$resid)=split(/\./,$ids);
7992: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7993: $resid,$thisfn);
7994: } elsif (!$donotrecurse) {
7995: # ------------------------------------------ There is more than one possibility
7996: my $realpossible=0;
7997: foreach my $id (@possibilities) {
7998: my $file=$bighash{'src_'.$id};
7999: if (&allowed('bre',$file)) {
8000: my ($mapid,$resid)=split(/\./,$id);
8001: if ($bighash{'map_type_'.$mapid} ne 'page') {
8002: $realpossible++;
8003: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8004: $resid,$thisfn);
8005: }
8006: }
8007: }
8008: if ($realpossible!=1) { $syval=''; }
8009: } else {
8010: $syval='';
8011: }
8012: }
8013: untie(%bighash)
8014: }
8015: }
8016: if ($syval) {
8017: return $env{$cache_str}=$syval;
8018: }
8019: }
8020: &appenv({'request.ambiguous' => $thisfn});
8021: return $env{$cache_str}='';
8022: }
8023:
8024: # ---------------------------------------------------------- Return random seed
8025:
8026: sub numval {
8027: my $txt=shift;
8028: $txt=~tr/A-J/0-9/;
8029: $txt=~tr/a-j/0-9/;
8030: $txt=~tr/K-T/0-9/;
8031: $txt=~tr/k-t/0-9/;
8032: $txt=~tr/U-Z/0-5/;
8033: $txt=~tr/u-z/0-5/;
8034: $txt=~s/\D//g;
8035: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8036: return int($txt);
8037: }
8038:
8039: sub numval2 {
8040: my $txt=shift;
8041: $txt=~tr/A-J/0-9/;
8042: $txt=~tr/a-j/0-9/;
8043: $txt=~tr/K-T/0-9/;
8044: $txt=~tr/k-t/0-9/;
8045: $txt=~tr/U-Z/0-5/;
8046: $txt=~tr/u-z/0-5/;
8047: $txt=~s/\D//g;
8048: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8049: my $total;
8050: foreach my $val (@txts) { $total+=$val; }
8051: if ($_64bit) { if ($total > 2**32) { return -1; } }
8052: return int($total);
8053: }
8054:
8055: sub numval3 {
8056: use integer;
8057: my $txt=shift;
8058: $txt=~tr/A-J/0-9/;
8059: $txt=~tr/a-j/0-9/;
8060: $txt=~tr/K-T/0-9/;
8061: $txt=~tr/k-t/0-9/;
8062: $txt=~tr/U-Z/0-5/;
8063: $txt=~tr/u-z/0-5/;
8064: $txt=~s/\D//g;
8065: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8066: my $total;
8067: foreach my $val (@txts) { $total+=$val; }
8068: if ($_64bit) { $total=(($total<<32)>>32); }
8069: return $total;
8070: }
8071:
8072: sub digest {
8073: my ($data)=@_;
8074: my $digest=&Digest::MD5::md5($data);
8075: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8076: my ($e,$f);
8077: {
8078: use integer;
8079: $e=($a+$b);
8080: $f=($c+$d);
8081: if ($_64bit) {
8082: $e=(($e<<32)>>32);
8083: $f=(($f<<32)>>32);
8084: }
8085: }
8086: if (wantarray) {
8087: return ($e,$f);
8088: } else {
8089: my $g;
8090: {
8091: use integer;
8092: $g=($e+$f);
8093: if ($_64bit) {
8094: $g=(($g<<32)>>32);
8095: }
8096: }
8097: return $g;
8098: }
8099: }
8100:
8101: sub latest_rnd_algorithm_id {
8102: return '64bit5';
8103: }
8104:
8105: sub get_rand_alg {
8106: my ($courseid)=@_;
8107: if (!$courseid) { $courseid=(&whichuser())[1]; }
8108: if ($courseid) {
8109: return $env{"course.$courseid.rndseed"};
8110: }
8111: return &latest_rnd_algorithm_id();
8112: }
8113:
8114: sub validCODE {
8115: my ($CODE)=@_;
8116: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8117: return 0;
8118: }
8119:
8120: sub getCODE {
8121: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8122: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8123: defined($Apache::lonhomework::parsing_a_task) ) &&
8124: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8125: return $Apache::lonhomework::history{'resource.CODE'};
8126: }
8127: return undef;
8128: }
8129:
8130: sub rndseed {
8131: my ($symb,$courseid,$domain,$username)=@_;
8132: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
8133: if (!defined($symb)) {
8134: unless ($symb=$wsymb) { return time; }
8135: }
8136: if (!$courseid) { $courseid=$wcourseid; }
8137: if (!$domain) { $domain=$wdomain; }
8138: if (!$username) { $username=$wusername }
8139: my $which=&get_rand_alg();
8140:
8141: if (defined(&getCODE())) {
8142: if ($which eq '64bit5') {
8143: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8144: } elsif ($which eq '64bit4') {
8145: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8146: } else {
8147: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8148: }
8149: } elsif ($which eq '64bit5') {
8150: return &rndseed_64bit5($symb,$courseid,$domain,$username);
8151: } elsif ($which eq '64bit4') {
8152: return &rndseed_64bit4($symb,$courseid,$domain,$username);
8153: } elsif ($which eq '64bit3') {
8154: return &rndseed_64bit3($symb,$courseid,$domain,$username);
8155: } elsif ($which eq '64bit2') {
8156: return &rndseed_64bit2($symb,$courseid,$domain,$username);
8157: } elsif ($which eq '64bit') {
8158: return &rndseed_64bit($symb,$courseid,$domain,$username);
8159: }
8160: return &rndseed_32bit($symb,$courseid,$domain,$username);
8161: }
8162:
8163: sub rndseed_32bit {
8164: my ($symb,$courseid,$domain,$username)=@_;
8165: {
8166: use integer;
8167: my $symbchck=unpack("%32C*",$symb) << 27;
8168: my $symbseed=numval($symb) << 22;
8169: my $namechck=unpack("%32C*",$username) << 17;
8170: my $nameseed=numval($username) << 12;
8171: my $domainseed=unpack("%32C*",$domain) << 7;
8172: my $courseseed=unpack("%32C*",$courseid);
8173: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
8174: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8175: #&logthis("rndseed :$num:$symb");
8176: if ($_64bit) { $num=(($num<<32)>>32); }
8177: return $num;
8178: }
8179: }
8180:
8181: sub rndseed_64bit {
8182: my ($symb,$courseid,$domain,$username)=@_;
8183: {
8184: use integer;
8185: my $symbchck=unpack("%32S*",$symb) << 21;
8186: my $symbseed=numval($symb) << 10;
8187: my $namechck=unpack("%32S*",$username);
8188:
8189: my $nameseed=numval($username) << 21;
8190: my $domainseed=unpack("%32S*",$domain) << 10;
8191: my $courseseed=unpack("%32S*",$courseid);
8192:
8193: my $num1=$symbchck+$symbseed+$namechck;
8194: my $num2=$nameseed+$domainseed+$courseseed;
8195: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8196: #&logthis("rndseed :$num:$symb");
8197: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8198: return "$num1,$num2";
8199: }
8200: }
8201:
8202: sub rndseed_64bit2 {
8203: my ($symb,$courseid,$domain,$username)=@_;
8204: {
8205: use integer;
8206: # strings need to be an even # of cahracters long, it it is odd the
8207: # last characters gets thrown away
8208: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8209: my $symbseed=numval($symb) << 10;
8210: my $namechck=unpack("%32S*",$username.' ');
8211:
8212: my $nameseed=numval($username) << 21;
8213: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8214: my $courseseed=unpack("%32S*",$courseid.' ');
8215:
8216: my $num1=$symbchck+$symbseed+$namechck;
8217: my $num2=$nameseed+$domainseed+$courseseed;
8218: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8219: #&logthis("rndseed :$num:$symb");
8220: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8221: return "$num1,$num2";
8222: }
8223: }
8224:
8225: sub rndseed_64bit3 {
8226: my ($symb,$courseid,$domain,$username)=@_;
8227: {
8228: use integer;
8229: # strings need to be an even # of cahracters long, it it is odd the
8230: # last characters gets thrown away
8231: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8232: my $symbseed=numval2($symb) << 10;
8233: my $namechck=unpack("%32S*",$username.' ');
8234:
8235: my $nameseed=numval2($username) << 21;
8236: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8237: my $courseseed=unpack("%32S*",$courseid.' ');
8238:
8239: my $num1=$symbchck+$symbseed+$namechck;
8240: my $num2=$nameseed+$domainseed+$courseseed;
8241: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8242: #&logthis("rndseed :$num1:$num2:$_64bit");
8243: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8244:
8245: return "$num1:$num2";
8246: }
8247: }
8248:
8249: sub rndseed_64bit4 {
8250: my ($symb,$courseid,$domain,$username)=@_;
8251: {
8252: use integer;
8253: # strings need to be an even # of cahracters long, it it is odd the
8254: # last characters gets thrown away
8255: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8256: my $symbseed=numval3($symb) << 10;
8257: my $namechck=unpack("%32S*",$username.' ');
8258:
8259: my $nameseed=numval3($username) << 21;
8260: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8261: my $courseseed=unpack("%32S*",$courseid.' ');
8262:
8263: my $num1=$symbchck+$symbseed+$namechck;
8264: my $num2=$nameseed+$domainseed+$courseseed;
8265: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8266: #&logthis("rndseed :$num1:$num2:$_64bit");
8267: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8268:
8269: return "$num1:$num2";
8270: }
8271: }
8272:
8273: sub rndseed_64bit5 {
8274: my ($symb,$courseid,$domain,$username)=@_;
8275: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8276: return "$num1:$num2";
8277: }
8278:
8279: sub rndseed_CODE_64bit {
8280: my ($symb,$courseid,$domain,$username)=@_;
8281: {
8282: use integer;
8283: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8284: my $symbseed=numval2($symb);
8285: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8286: my $CODEseed=numval(&getCODE());
8287: my $courseseed=unpack("%32S*",$courseid.' ');
8288: my $num1=$symbseed+$CODEchck;
8289: my $num2=$CODEseed+$courseseed+$symbchck;
8290: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8291: #&logthis("rndseed :$num1:$num2:$symb");
8292: if ($_64bit) { $num1=(($num1<<32)>>32); }
8293: if ($_64bit) { $num2=(($num2<<32)>>32); }
8294: return "$num1:$num2";
8295: }
8296: }
8297:
8298: sub rndseed_CODE_64bit4 {
8299: my ($symb,$courseid,$domain,$username)=@_;
8300: {
8301: use integer;
8302: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8303: my $symbseed=numval3($symb);
8304: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8305: my $CODEseed=numval3(&getCODE());
8306: my $courseseed=unpack("%32S*",$courseid.' ');
8307: my $num1=$symbseed+$CODEchck;
8308: my $num2=$CODEseed+$courseseed+$symbchck;
8309: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8310: #&logthis("rndseed :$num1:$num2:$symb");
8311: if ($_64bit) { $num1=(($num1<<32)>>32); }
8312: if ($_64bit) { $num2=(($num2<<32)>>32); }
8313: return "$num1:$num2";
8314: }
8315: }
8316:
8317: sub rndseed_CODE_64bit5 {
8318: my ($symb,$courseid,$domain,$username)=@_;
8319: my $code = &getCODE();
8320: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8321: return "$num1:$num2";
8322: }
8323:
8324: sub setup_random_from_rndseed {
8325: my ($rndseed)=@_;
8326: if ($rndseed =~/([,:])/) {
8327: my ($num1,$num2)=split(/[,:]/,$rndseed);
8328: &Math::Random::random_set_seed(abs($num1),abs($num2));
8329: } else {
8330: &Math::Random::random_set_seed_from_phrase($rndseed);
8331: }
8332: }
8333:
8334: sub latest_receipt_algorithm_id {
8335: return 'receipt3';
8336: }
8337:
8338: sub recunique {
8339: my $fucourseid=shift;
8340: my $unique;
8341: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
8342: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8343: $unique=$env{"course.$fucourseid.internal.encseed"};
8344: } else {
8345: $unique=$perlvar{'lonReceipt'};
8346: }
8347: return unpack("%32C*",$unique);
8348: }
8349:
8350: sub recprefix {
8351: my $fucourseid=shift;
8352: my $prefix;
8353: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
8354: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8355: $prefix=$env{"course.$fucourseid.internal.encpref"};
8356: } else {
8357: $prefix=$perlvar{'lonHostID'};
8358: }
8359: return unpack("%32C*",$prefix);
8360: }
8361:
8362: sub ireceipt {
8363: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
8364:
8365: my $return =&recprefix($fucourseid).'-';
8366:
8367: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
8368: $env{'request.state'} eq 'construct') {
8369: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
8370: return $return;
8371: }
8372:
8373: my $cuname=unpack("%32C*",$funame);
8374: my $cudom=unpack("%32C*",$fudom);
8375: my $cucourseid=unpack("%32C*",$fucourseid);
8376: my $cusymb=unpack("%32C*",$fusymb);
8377: my $cunique=&recunique($fucourseid);
8378: my $cpart=unpack("%32S*",$part);
8379: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
8380:
8381: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
8382:
8383: $return.= ($cunique%$cuname+
8384: $cunique%$cudom+
8385: $cusymb%$cuname+
8386: $cusymb%$cudom+
8387: $cucourseid%$cuname+
8388: $cucourseid%$cudom+
8389: $cpart%$cuname+
8390: $cpart%$cudom);
8391: } else {
8392: $return.= ($cunique%$cuname+
8393: $cunique%$cudom+
8394: $cusymb%$cuname+
8395: $cusymb%$cudom+
8396: $cucourseid%$cuname+
8397: $cucourseid%$cudom);
8398: }
8399: return $return;
8400: }
8401:
8402: sub receipt {
8403: my ($part)=@_;
8404: my ($symb,$courseid,$domain,$name) = &whichuser();
8405: return &ireceipt($name,$domain,$courseid,$symb,$part);
8406: }
8407:
8408: sub whichuser {
8409: my ($passedsymb)=@_;
8410: my ($symb,$courseid,$domain,$name,$publicuser);
8411: if (defined($env{'form.grade_symb'})) {
8412: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
8413: my $allowed=&allowed('vgr',$tmp_courseid);
8414: if (!$allowed &&
8415: exists($env{'request.course.sec'}) &&
8416: $env{'request.course.sec'} !~ /^\s*$/) {
8417: $allowed=&allowed('vgr',$tmp_courseid.
8418: '/'.$env{'request.course.sec'});
8419: }
8420: if ($allowed) {
8421: ($symb)=&get_env_multiple('form.grade_symb');
8422: $courseid=$tmp_courseid;
8423: ($domain)=&get_env_multiple('form.grade_domain');
8424: ($name)=&get_env_multiple('form.grade_username');
8425: return ($symb,$courseid,$domain,$name,$publicuser);
8426: }
8427: }
8428: if (!$passedsymb) {
8429: $symb=&symbread();
8430: } else {
8431: $symb=$passedsymb;
8432: }
8433: $courseid=$env{'request.course.id'};
8434: $domain=$env{'user.domain'};
8435: $name=$env{'user.name'};
8436: if ($name eq 'public' && $domain eq 'public') {
8437: if (!defined($env{'form.username'})) {
8438: $env{'form.username'}.=time.rand(10000000);
8439: }
8440: $name.=$env{'form.username'};
8441: }
8442: return ($symb,$courseid,$domain,$name,$publicuser);
8443:
8444: }
8445:
8446: # ------------------------------------------------------------ Serves up a file
8447: # returns either the contents of the file or
8448: # -1 if the file doesn't exist
8449: #
8450: # if the target is a file that was uploaded via DOCS,
8451: # a check will be made to see if a current copy exists on the local server,
8452: # if it does this will be served, otherwise a copy will be retrieved from
8453: # the home server for the course and stored in /home/httpd/html/userfiles on
8454: # the local server.
8455:
8456: sub getfile {
8457: my ($file) = @_;
8458: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
8459: &repcopy($file);
8460: return &readfile($file);
8461: }
8462:
8463: sub repcopy_userfile {
8464: my ($file)=@_;
8465: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
8466: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
8467: my ($cdom,$cnum,$filename) =
8468: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
8469: my $uri="/uploaded/$cdom/$cnum/$filename";
8470: if (-e "$file") {
8471: # we already have a local copy, check it out
8472: my @fileinfo = stat($file);
8473: my $rtncode;
8474: my $info;
8475: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
8476: if ($lwpresp ne 'ok') {
8477: # there is no such file anymore, even though we had a local copy
8478: if ($rtncode eq '404') {
8479: unlink($file);
8480: }
8481: return -1;
8482: }
8483: if ($info < $fileinfo[9]) {
8484: # nice, the file we have is up-to-date, just say okay
8485: return 'ok';
8486: } else {
8487: # the file is outdated, get rid of it
8488: unlink($file);
8489: }
8490: }
8491: # one way or the other, at this point, we don't have the file
8492: # construct the correct path for the file
8493: my @parts = ($cdom,$cnum);
8494: if ($filename =~ m|^(.+)/[^/]+$|) {
8495: push @parts, split(/\//,$1);
8496: }
8497: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
8498: foreach my $part (@parts) {
8499: $path .= '/'.$part;
8500: if (!-e $path) {
8501: mkdir($path,0770);
8502: }
8503: }
8504: # now the path exists for sure
8505: # get a user agent
8506: my $ua=new LWP::UserAgent;
8507: my $transferfile=$file.'.in.transfer';
8508: # FIXME: this should flock
8509: if (-e $transferfile) { return 'ok'; }
8510: my $request;
8511: $uri=~s/^\///;
8512: my $homeserver = &homeserver($cnum,$cdom);
8513: my $protocol = $protocol{$homeserver};
8514: $protocol = 'http' if ($protocol ne 'https');
8515: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
8516: my $response=$ua->request($request,$transferfile);
8517: # did it work?
8518: if ($response->is_error()) {
8519: unlink($transferfile);
8520: &logthis("Userfile repcopy failed for $uri");
8521: return -1;
8522: }
8523: # worked, rename the transfer file
8524: rename($transferfile,$file);
8525: return 'ok';
8526: }
8527:
8528: sub tokenwrapper {
8529: my $uri=shift;
8530: $uri=~s|^https?\://([^/]+)||;
8531: $uri=~s|^/||;
8532: $env{'user.environment'}=~/\/([^\/]+)\.id/;
8533: my $token=$1;
8534: my (undef,$udom,$uname,$file)=split('/',$uri,4);
8535: if ($udom && $uname && $file) {
8536: $file=~s|(\?\.*)*$||;
8537: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
8538: my $homeserver = &homeserver($uname,$udom);
8539: my $protocol = $protocol{$homeserver};
8540: $protocol = 'http' if ($protocol ne 'https');
8541: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
8542: (($uri=~/\?/)?'&':'?').'token='.$token.
8543: '&tokenissued='.$perlvar{'lonHostID'};
8544: } else {
8545: return '/adm/notfound.html';
8546: }
8547: }
8548:
8549: # call with reqtype HEAD: get last modification time
8550: # call with reqtype GET: get the file contents
8551: # Do not call this with reqtype GET for large files! It loads everything into memory
8552: #
8553: sub getuploaded {
8554: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
8555: $uri=~s/^\///;
8556: my $homeserver = &homeserver($cnum,$cdom);
8557: my $protocol = $protocol{$homeserver};
8558: $protocol = 'http' if ($protocol ne 'https');
8559: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
8560: my $ua=new LWP::UserAgent;
8561: my $request=new HTTP::Request($reqtype,$uri);
8562: my $response=$ua->request($request);
8563: $$rtncode = $response->code;
8564: if (! $response->is_success()) {
8565: return 'failed';
8566: }
8567: if ($reqtype eq 'HEAD') {
8568: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
8569: } elsif ($reqtype eq 'GET') {
8570: $$info = $response->content;
8571: }
8572: return 'ok';
8573: }
8574:
8575: sub readfile {
8576: my $file = shift;
8577: if ( (! -e $file ) || ($file eq '') ) { return -1; };
8578: my $fh;
8579: open($fh,"<$file");
8580: my $a='';
8581: while (my $line = <$fh>) { $a .= $line; }
8582: return $a;
8583: }
8584:
8585: sub filelocation {
8586: my ($dir,$file) = @_;
8587: my $location;
8588: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
8589:
8590: if ($file =~ m-^/adm/-) {
8591: $file=~s-^/adm/wrapper/-/-;
8592: $file=~s-^/adm/coursedocs/showdoc/-/-;
8593: }
8594:
8595: if ($file=~m:^/~:) { # is a contruction space reference
8596: $location = $file;
8597: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
8598: } elsif ($file=~m{^/home/$match_username/public_html/}) {
8599: # is a correct contruction space reference
8600: $location = $file;
8601: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
8602: $location = $file;
8603: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
8604: my ($udom,$uname,$filename)=
8605: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
8606: my $home=&homeserver($uname,$udom);
8607: my $is_me=0;
8608: my @ids=¤t_machine_ids();
8609: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
8610: if ($is_me) {
8611: $location=&propath($udom,$uname).'/userfiles/'.$filename;
8612: } else {
8613: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
8614: $udom.'/'.$uname.'/'.$filename;
8615: }
8616: } elsif ($file =~ m-^/adm/-) {
8617: $location = $perlvar{'lonDocRoot'}.'/'.$file;
8618: } else {
8619: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8620: $file=~s:^/res/:/:;
8621: if ( !( $file =~ m:^/:) ) {
8622: $location = $dir. '/'.$file;
8623: } else {
8624: $location = '/home/httpd/html/res'.$file;
8625: }
8626: }
8627: $location=~s://+:/:g; # remove duplicate /
8628: while ($location=~m{/\.\./}) {
8629: if ($location =~ m{/[^/]+/\.\./}) {
8630: $location=~ s{/[^/]+/\.\./}{/}g;
8631: } else {
8632: $location=~ s{/\.\./}{/}g;
8633: }
8634: } #remove dir/..
8635: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
8636: return $location;
8637: }
8638:
8639: sub hreflocation {
8640: my ($dir,$file)=@_;
8641: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
8642: $file=filelocation($dir,$file);
8643: } elsif ($file=~m-^/adm/-) {
8644: $file=~s-^/adm/wrapper/-/-;
8645: $file=~s-^/adm/coursedocs/showdoc/-/-;
8646: }
8647: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
8648: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
8649: } elsif ($file=~m-/home/($match_username)/public_html/-) {
8650: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
8651: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
8652: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
8653: -/uploaded/$1/$2/-x;
8654: }
8655: if ($file=~ m{^/userfiles/}) {
8656: $file =~ s{^/userfiles/}{/uploaded/};
8657: }
8658: return $file;
8659: }
8660:
8661: sub current_machine_domains {
8662: return &machine_domains(&hostname($perlvar{'lonHostID'}));
8663: }
8664:
8665: sub machine_domains {
8666: my ($hostname) = @_;
8667: my @domains;
8668: my %hostname = &all_hostnames();
8669: while( my($id, $name) = each(%hostname)) {
8670: # &logthis("-$id-$name-$hostname-");
8671: if ($hostname eq $name) {
8672: push(@domains,&host_domain($id));
8673: }
8674: }
8675: return @domains;
8676: }
8677:
8678: sub current_machine_ids {
8679: return &machine_ids(&hostname($perlvar{'lonHostID'}));
8680: }
8681:
8682: sub machine_ids {
8683: my ($hostname) = @_;
8684: $hostname ||= &hostname($perlvar{'lonHostID'});
8685: my @ids;
8686: my %name_to_host = &all_names();
8687: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
8688: return @{ $name_to_host{$hostname} };
8689: }
8690: return;
8691: }
8692:
8693: sub additional_machine_domains {
8694: my @domains;
8695: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
8696: while( my $line = <$fh>) {
8697: $line =~ s/\s//g;
8698: push(@domains,$line);
8699: }
8700: return @domains;
8701: }
8702:
8703: sub default_login_domain {
8704: my $domain = $perlvar{'lonDefDomain'};
8705: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
8706: foreach my $posdom (¤t_machine_domains(),
8707: &additional_machine_domains()) {
8708: if (lc($posdom) eq lc($testdomain)) {
8709: $domain=$posdom;
8710: last;
8711: }
8712: }
8713: return $domain;
8714: }
8715:
8716: # ------------------------------------------------------------- Declutters URLs
8717:
8718: sub declutter {
8719: my $thisfn=shift;
8720: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8721: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8722: $thisfn=~s/^\///;
8723: $thisfn=~s|^adm/wrapper/||;
8724: $thisfn=~s|^adm/coursedocs/showdoc/||;
8725: $thisfn=~s/^res\///;
8726: $thisfn=~s/\?.+$//;
8727: return $thisfn;
8728: }
8729:
8730: # ------------------------------------------------------------- Clutter up URLs
8731:
8732: sub clutter {
8733: my $thisfn='/'.&declutter(shift);
8734: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
8735: || $thisfn =~ m{^/adm/(includes|pages)} ) {
8736: $thisfn='/res'.$thisfn;
8737: }
8738: if ($thisfn !~m|/adm|) {
8739: if ($thisfn =~ m|/ext/|) {
8740: $thisfn='/adm/wrapper'.$thisfn;
8741: } else {
8742: my ($ext) = ($thisfn =~ /\.(\w+)$/);
8743: my $embstyle=&Apache::loncommon::fileembstyle($ext);
8744: if ($embstyle eq 'ssi'
8745: || ($embstyle eq 'hdn')
8746: || ($embstyle eq 'rat')
8747: || ($embstyle eq 'prv')
8748: || ($embstyle eq 'ign')) {
8749: #do nothing with these
8750: } elsif (($embstyle eq 'img')
8751: || ($embstyle eq 'emb')
8752: || ($embstyle eq 'wrp')) {
8753: $thisfn='/adm/wrapper'.$thisfn;
8754: } elsif ($embstyle eq 'unk'
8755: && $thisfn!~/\.(sequence|page)$/) {
8756: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
8757: } else {
8758: # &logthis("Got a blank emb style");
8759: }
8760: }
8761: }
8762: return $thisfn;
8763: }
8764:
8765: sub clutter_with_no_wrapper {
8766: my $uri = &clutter(shift);
8767: if ($uri =~ m-^/adm/-) {
8768: $uri =~ s-^/adm/wrapper/-/-;
8769: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
8770: }
8771: return $uri;
8772: }
8773:
8774: sub freeze_escape {
8775: my ($value)=@_;
8776: if (ref($value)) {
8777: $value=&nfreeze($value);
8778: return '__FROZEN__'.&escape($value);
8779: }
8780: return &escape($value);
8781: }
8782:
8783:
8784: sub thaw_unescape {
8785: my ($value)=@_;
8786: if ($value =~ /^__FROZEN__/) {
8787: substr($value,0,10,undef);
8788: $value=&unescape($value);
8789: return &thaw($value);
8790: }
8791: return &unescape($value);
8792: }
8793:
8794: sub correct_line_ends {
8795: my ($result)=@_;
8796: $$result =~s/\r\n/\n/mg;
8797: $$result =~s/\r/\n/mg;
8798: }
8799: # ================================================================ Main Program
8800:
8801: sub goodbye {
8802: &logthis("Starting Shut down");
8803: #not converted to using infrastruture and probably shouldn't be
8804: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
8805: #converted
8806: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
8807: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
8808: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
8809: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
8810: #1.1 only
8811: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
8812: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
8813: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
8814: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
8815: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
8816: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
8817: &logthis(sprintf("%-20s is %s",'hits',$hits));
8818: &flushcourselogs();
8819: &logthis("Shutting down");
8820: }
8821:
8822: sub get_dns {
8823: my ($url,$func,$ignore_cache) = @_;
8824: if (!$ignore_cache) {
8825: my ($content,$cached)=
8826: &Apache::lonnet::is_cached_new('dns',$url);
8827: if ($cached) {
8828: &$func($content);
8829: return;
8830: }
8831: }
8832:
8833: my %alldns;
8834: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8835: foreach my $dns (<$config>) {
8836: next if ($dns !~ /^\^(\S*)/x);
8837: my $line = $1;
8838: my ($host,$protocol) = split(/:/,$line);
8839: if ($protocol ne 'https') {
8840: $protocol = 'http';
8841: }
8842: $alldns{$host} = $protocol;
8843: }
8844: while (%alldns) {
8845: my ($dns) = keys(%alldns);
8846: my $ua=new LWP::UserAgent;
8847: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
8848: my $response=$ua->request($request);
8849: delete($alldns{$dns});
8850: next if ($response->is_error());
8851: my @content = split("\n",$response->content);
8852: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
8853: &$func(\@content);
8854: return;
8855: }
8856: close($config);
8857: my $which = (split('/',$url))[3];
8858: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
8859: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
8860: my @content = <$config>;
8861: &$func(\@content);
8862: return;
8863: }
8864: # ------------------------------------------------------------ Read domain file
8865: {
8866: my $loaded;
8867: my %domain;
8868:
8869: sub parse_domain_tab {
8870: my ($lines) = @_;
8871: foreach my $line (@$lines) {
8872: next if ($line =~ /^(\#|\s*$ )/x);
8873:
8874: chomp($line);
8875: my ($name,@elements) = split(/:/,$line,9);
8876: my %this_domain;
8877: foreach my $field ('description', 'auth_def', 'auth_arg_def',
8878: 'lang_def', 'city', 'longi', 'lati',
8879: 'primary') {
8880: $this_domain{$field} = shift(@elements);
8881: }
8882: $domain{$name} = \%this_domain;
8883: }
8884: }
8885:
8886: sub reset_domain_info {
8887: undef($loaded);
8888: undef(%domain);
8889: }
8890:
8891: sub load_domain_tab {
8892: my ($ignore_cache) = @_;
8893: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
8894: my $fh;
8895: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
8896: my @lines = <$fh>;
8897: &parse_domain_tab(\@lines);
8898: }
8899: close($fh);
8900: $loaded = 1;
8901: }
8902:
8903: sub domain {
8904: &load_domain_tab() if (!$loaded);
8905:
8906: my ($name,$what) = @_;
8907: return if ( !exists($domain{$name}) );
8908:
8909: if (!$what) {
8910: return $domain{$name}{'description'};
8911: }
8912: return $domain{$name}{$what};
8913: }
8914:
8915: sub domain_info {
8916: &load_domain_tab() if (!$loaded);
8917: return %domain;
8918: }
8919:
8920: }
8921:
8922:
8923: # ------------------------------------------------------------- Read hosts file
8924: {
8925: my %hostname;
8926: my %hostdom;
8927: my %libserv;
8928: my $loaded;
8929: my %name_to_host;
8930:
8931: sub parse_hosts_tab {
8932: my ($file) = @_;
8933: foreach my $configline (@$file) {
8934: next if ($configline =~ /^(\#|\s*$ )/x);
8935: next if ($configline =~ /^\^/);
8936: chomp($configline);
8937: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
8938: $name=~s/\s//g;
8939: if ($id && $domain && $role && $name) {
8940: $hostname{$id}=$name;
8941: push(@{$name_to_host{$name}}, $id);
8942: $hostdom{$id}=$domain;
8943: if ($role eq 'library') { $libserv{$id}=$name; }
8944: if (defined($protocol)) {
8945: if ($protocol eq 'https') {
8946: $protocol{$id} = $protocol;
8947: } else {
8948: $protocol{$id} = 'http';
8949: }
8950: } else {
8951: $protocol{$id} = 'http';
8952: }
8953: }
8954: }
8955: }
8956:
8957: sub reset_hosts_info {
8958: &purge_remembered();
8959: &reset_domain_info();
8960: &reset_hosts_ip_info();
8961: undef(%name_to_host);
8962: undef(%hostname);
8963: undef(%hostdom);
8964: undef(%libserv);
8965: undef($loaded);
8966: }
8967:
8968: sub load_hosts_tab {
8969: my ($ignore_cache) = @_;
8970: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
8971: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8972: my @config = <$config>;
8973: &parse_hosts_tab(\@config);
8974: close($config);
8975: $loaded=1;
8976: }
8977:
8978: sub hostname {
8979: &load_hosts_tab() if (!$loaded);
8980:
8981: my ($lonid) = @_;
8982: return $hostname{$lonid};
8983: }
8984:
8985: sub all_hostnames {
8986: &load_hosts_tab() if (!$loaded);
8987:
8988: return %hostname;
8989: }
8990:
8991: sub all_names {
8992: &load_hosts_tab() if (!$loaded);
8993:
8994: return %name_to_host;
8995: }
8996:
8997: sub all_host_domain {
8998: &load_hosts_tab() if (!$loaded);
8999: return %hostdom;
9000: }
9001:
9002: sub is_library {
9003: &load_hosts_tab() if (!$loaded);
9004:
9005: return exists($libserv{$_[0]});
9006: }
9007:
9008: sub all_library {
9009: &load_hosts_tab() if (!$loaded);
9010:
9011: return %libserv;
9012: }
9013:
9014: sub get_servers {
9015: &load_hosts_tab() if (!$loaded);
9016:
9017: my ($domain,$type) = @_;
9018: my %possible_hosts = ($type eq 'library') ? %libserv
9019: : %hostname;
9020: my %result;
9021: if (ref($domain) eq 'ARRAY') {
9022: while ( my ($host,$hostname) = each(%possible_hosts)) {
9023: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9024: $result{$host} = $hostname;
9025: }
9026: }
9027: } else {
9028: while ( my ($host,$hostname) = each(%possible_hosts)) {
9029: if ($hostdom{$host} eq $domain) {
9030: $result{$host} = $hostname;
9031: }
9032: }
9033: }
9034: return %result;
9035: }
9036:
9037: sub host_domain {
9038: &load_hosts_tab() if (!$loaded);
9039:
9040: my ($lonid) = @_;
9041: return $hostdom{$lonid};
9042: }
9043:
9044: sub all_domains {
9045: &load_hosts_tab() if (!$loaded);
9046:
9047: my %seen;
9048: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9049: return @uniq;
9050: }
9051: }
9052:
9053: {
9054: my %iphost;
9055: my %name_to_ip;
9056: my %lonid_to_ip;
9057:
9058: sub get_hosts_from_ip {
9059: my ($ip) = @_;
9060: my %iphosts = &get_iphost();
9061: if (ref($iphosts{$ip})) {
9062: return @{$iphosts{$ip}};
9063: }
9064: return;
9065: }
9066:
9067: sub reset_hosts_ip_info {
9068: undef(%iphost);
9069: undef(%name_to_ip);
9070: undef(%lonid_to_ip);
9071: }
9072:
9073: sub get_host_ip {
9074: my ($lonid) = @_;
9075: if (exists($lonid_to_ip{$lonid})) {
9076: return $lonid_to_ip{$lonid};
9077: }
9078: my $name=&hostname($lonid);
9079: my $ip = gethostbyname($name);
9080: return if (!$ip || length($ip) ne 4);
9081: $ip=inet_ntoa($ip);
9082: $name_to_ip{$name} = $ip;
9083: $lonid_to_ip{$lonid} = $ip;
9084: return $ip;
9085: }
9086:
9087: sub get_iphost {
9088: my ($ignore_cache) = @_;
9089:
9090: if (!$ignore_cache) {
9091: if (%iphost) {
9092: return %iphost;
9093: }
9094: my ($ip_info,$cached)=
9095: &Apache::lonnet::is_cached_new('iphost','iphost');
9096: if ($cached) {
9097: %iphost = %{$ip_info->[0]};
9098: %name_to_ip = %{$ip_info->[1]};
9099: %lonid_to_ip = %{$ip_info->[2]};
9100: return %iphost;
9101: }
9102: }
9103:
9104: # get yesterday's info for fallback
9105: my %old_name_to_ip;
9106: my ($ip_info,$cached)=
9107: &Apache::lonnet::is_cached_new('iphost','iphost');
9108: if ($cached) {
9109: %old_name_to_ip = %{$ip_info->[1]};
9110: }
9111:
9112: my %name_to_host = &all_names();
9113: foreach my $name (keys(%name_to_host)) {
9114: my $ip;
9115: if (!exists($name_to_ip{$name})) {
9116: $ip = gethostbyname($name);
9117: if (!$ip || length($ip) ne 4) {
9118: if (defined($old_name_to_ip{$name})) {
9119: $ip = $old_name_to_ip{$name};
9120: &logthis("Can't find $name defaulting to old $ip");
9121: } else {
9122: &logthis("Name $name no IP found");
9123: next;
9124: }
9125: } else {
9126: $ip=inet_ntoa($ip);
9127: }
9128: $name_to_ip{$name} = $ip;
9129: } else {
9130: $ip = $name_to_ip{$name};
9131: }
9132: foreach my $id (@{ $name_to_host{$name} }) {
9133: $lonid_to_ip{$id} = $ip;
9134: }
9135: push(@{$iphost{$ip}},@{$name_to_host{$name}});
9136: }
9137: &Apache::lonnet::do_cache_new('iphost','iphost',
9138: [\%iphost,\%name_to_ip,\%lonid_to_ip],
9139: 48*60*60);
9140:
9141: return %iphost;
9142: }
9143:
9144: #
9145: # Given a DNS returns the loncapa host name for that DNS
9146: #
9147: sub host_from_dns {
9148: my ($dns) = @_;
9149: my @hosts;
9150: my $ip;
9151:
9152: if (exists($name_to_ip{$dns})) {
9153: $ip = $name_to_ip{$dns};
9154: }
9155: if (!$ip) {
9156: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9157: if (length($ip) == 4) {
9158: $ip = &IO::Socket::inet_ntoa($ip);
9159: }
9160: }
9161: if ($ip) {
9162: @hosts = get_hosts_from_ip($ip);
9163: return $hosts[0];
9164: }
9165: return undef;
9166: }
9167:
9168: }
9169:
9170: BEGIN {
9171:
9172: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9173: unless ($readit) {
9174: {
9175: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9176: %perlvar = (%perlvar,%{$configvars});
9177: }
9178:
9179:
9180: # ------------------------------------------------------ Read spare server file
9181: {
9182: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
9183:
9184: while (my $configline=<$config>) {
9185: chomp($configline);
9186: if ($configline) {
9187: my ($host,$type) = split(':',$configline,2);
9188: if (!defined($type) || $type eq '') { $type = 'default' };
9189: push(@{ $spareid{$type} }, $host);
9190: }
9191: }
9192: close($config);
9193: }
9194: # ------------------------------------------------------------ Read permissions
9195: {
9196: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
9197:
9198: while (my $configline=<$config>) {
9199: chomp($configline);
9200: if ($configline) {
9201: my ($role,$perm)=split(/ /,$configline);
9202: if ($perm ne '') { $pr{$role}=$perm; }
9203: }
9204: }
9205: close($config);
9206: }
9207:
9208: # -------------------------------------------- Read plain texts for permissions
9209: {
9210: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
9211:
9212: while (my $configline=<$config>) {
9213: chomp($configline);
9214: if ($configline) {
9215: my ($short,@plain)=split(/:/,$configline);
9216: %{$prp{$short}} = ();
9217: if (@plain > 0) {
9218: $prp{$short}{'std'} = $plain[0];
9219: for (my $i=1; $i<@plain; $i++) {
9220: $prp{$short}{'alt'.$i} = $plain[$i];
9221: }
9222: }
9223: }
9224: }
9225: close($config);
9226: }
9227:
9228: # ---------------------------------------------------------- Read package table
9229: {
9230: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
9231:
9232: while (my $configline=<$config>) {
9233: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
9234: chomp($configline);
9235: my ($short,$plain)=split(/:/,$configline);
9236: my ($pack,$name)=split(/\&/,$short);
9237: if ($plain ne '') {
9238: $packagetab{$pack.'&'.$name.'&name'}=$name;
9239: $packagetab{$short}=$plain;
9240: }
9241: }
9242: close($config);
9243: }
9244:
9245: # ------------- set up temporary directory
9246: {
9247: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9248:
9249: }
9250:
9251: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9252: 'compress_threshold'=> 20_000,
9253: });
9254:
9255: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
9256: $dumpcount=0;
9257: $locknum=0;
9258:
9259: &logtouch();
9260: &logthis('<font color="yellow">INFO: Read configuration</font>');
9261: $readit=1;
9262: {
9263: use integer;
9264: my $test=(2**32)+1;
9265: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
9266: &logthis(" Detected 64bit platform ($_64bit)");
9267: }
9268: }
9269: }
9270:
9271: 1;
9272: __END__
9273:
9274: =pod
9275:
9276: =head1 NAME
9277:
9278: Apache::lonnet - Subroutines to ask questions about things in the network.
9279:
9280: =head1 SYNOPSIS
9281:
9282: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
9283:
9284: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9285:
9286: Common parameters:
9287:
9288: =over 4
9289:
9290: =item *
9291:
9292: $uname : an internal username (if $cname expecting a course Id specifically)
9293:
9294: =item *
9295:
9296: $udom : a domain (if $cdom expecting a course's domain specifically)
9297:
9298: =item *
9299:
9300: $symb : a resource instance identifier
9301:
9302: =item *
9303:
9304: $namespace : the name of a .db file that contains the data needed or
9305: being set.
9306:
9307: =back
9308:
9309: =head1 OVERVIEW
9310:
9311: lonnet provides subroutines which interact with the
9312: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9313: about classes, users, and resources.
9314:
9315: For many of these objects you can also use this to store data about
9316: them or modify them in various ways.
9317:
9318: =head2 Symbs
9319:
9320: To identify a specific instance of a resource, LON-CAPA uses symbols
9321: or "symbs"X<symb>. These identifiers are built from the URL of the
9322: map, the resource number of the resource in the map, and the URL of
9323: the resource itself. The latter is somewhat redundant, but might help
9324: if maps change.
9325:
9326: An example is
9327:
9328: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9329:
9330: The respective map entry is
9331:
9332: <resource id="19" src="/res/msu/korte/tests/part12.problem"
9333: title="Problem 2">
9334: </resource>
9335:
9336: Symbs are used by the random number generator, as well as to store and
9337: restore data specific to a certain instance of for example a problem.
9338:
9339: =head2 Storing And Retrieving Data
9340:
9341: X<store()>X<cstore()>X<restore()>Three of the most important functions
9342: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
9343: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
9344: is is the non-critical message twin of cstore. These functions are for
9345: handlers to store a perl hash to a user's permanent data space in an
9346: easy manner, and to retrieve it again on another call. It is expected
9347: that a handler would use this once at the beginning to retrieve data,
9348: and then again once at the end to send only the new data back.
9349:
9350: The data is stored in the user's data directory on the user's
9351: homeserver under the ID of the course.
9352:
9353: The hash that is returned by restore will have all of the previous
9354: value for all of the elements of the hash.
9355:
9356: Example:
9357:
9358: #creating a hash
9359: my %hash;
9360: $hash{'foo'}='bar';
9361:
9362: #storing it
9363: &Apache::lonnet::cstore(\%hash);
9364:
9365: #changing a value
9366: $hash{'foo'}='notbar';
9367:
9368: #adding a new value
9369: $hash{'bar'}='foo';
9370: &Apache::lonnet::cstore(\%hash);
9371:
9372: #retrieving the hash
9373: my %history=&Apache::lonnet::restore();
9374:
9375: #print the hash
9376: foreach my $key (sort(keys(%history))) {
9377: print("\%history{$key} = $history{$key}");
9378: }
9379:
9380: Will print out:
9381:
9382: %history{1:foo} = bar
9383: %history{1:keys} = foo:timestamp
9384: %history{1:timestamp} = 990455579
9385: %history{2:bar} = foo
9386: %history{2:foo} = notbar
9387: %history{2:keys} = foo:bar:timestamp
9388: %history{2:timestamp} = 990455580
9389: %history{bar} = foo
9390: %history{foo} = notbar
9391: %history{timestamp} = 990455580
9392: %history{version} = 2
9393:
9394: Note that the special hash entries C<keys>, C<version> and
9395: C<timestamp> were added to the hash. C<version> will be equal to the
9396: total number of versions of the data that have been stored. The
9397: C<timestamp> attribute will be the UNIX time the hash was
9398: stored. C<keys> is available in every historical section to list which
9399: keys were added or changed at a specific historical revision of a
9400: hash.
9401:
9402: B<Warning>: do not store the hash that restore returns directly. This
9403: will cause a mess since it will restore the historical keys as if the
9404: were new keys. I.E. 1:foo will become 1:1:foo etc.
9405:
9406: Calling convention:
9407:
9408: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
9409: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
9410:
9411: For more detailed information, see lonnet specific documentation.
9412:
9413: =head1 RETURN MESSAGES
9414:
9415: =over 4
9416:
9417: =item * B<con_lost>: unable to contact remote host
9418:
9419: =item * B<con_delayed>: unable to contact remote host, message will be delivered
9420: when the connection is brought back up
9421:
9422: =item * B<con_failed>: unable to contact remote host and unable to save message
9423: for later delivery
9424:
9425: =item * B<error:>: an error a occurred, a description of the error follows the :
9426:
9427: =item * B<no_such_host>: unable to fund a host associated with the user/domain
9428: that was requested
9429:
9430: =back
9431:
9432: =head1 PUBLIC SUBROUTINES
9433:
9434: =head2 Session Environment Functions
9435:
9436: =over 4
9437:
9438: =item *
9439: X<appenv()>
9440: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
9441: the user envirnoment file, and will be restored for each access this
9442: user makes during this session, also modifies the %env for the current
9443: process. Optional rolesarrayref - if defined contains a reference to an array
9444: of roles which are exempt from the restriction on modifying user.role entries
9445: in the user's environment.db and in %env.
9446:
9447: =item *
9448: X<delenv()>
9449: B<delenv($delthis,$regexp)>: removes all items from the session
9450: environment file that begin with $delthis. If the
9451: optional second arg - $regexp - is true, $delthis is treated as a
9452: regular expression, otherwise \Q$delthis\E is used.
9453: The values are also deleted from the current processes %env.
9454:
9455: =item * get_env_multiple($name)
9456:
9457: gets $name from the %env hash, it seemlessly handles the cases where multiple
9458: values may be defined and end up as an array ref.
9459:
9460: returns an array of values
9461:
9462: =back
9463:
9464: =head2 User Information
9465:
9466: =over 4
9467:
9468: =item *
9469: X<queryauthenticate()>
9470: B<queryauthenticate($uname,$udom)>: try to determine user's current
9471: authentication scheme
9472:
9473: =item *
9474: X<authenticate()>
9475: B<authenticate($uname,$upass,$udom)>: try to
9476: authenticate user from domain's lib servers (first use the current
9477: one). C<$upass> should be the users password.
9478:
9479: =item *
9480: X<homeserver()>
9481: B<homeserver($uname,$udom)>: find the server which has
9482: the user's directory and files (there must be only one), this caches
9483: the answer, and also caches if there is a borken connection.
9484:
9485: =item *
9486: X<idget()>
9487: B<idget($udom,@ids)>: find the usernames behind a list of IDs
9488: (IDs are a unique resource in a domain, there must be only 1 ID per
9489: username, and only 1 username per ID in a specific domain) (returns
9490: hash: id=>name,id=>name)
9491:
9492: =item *
9493: X<idrget()>
9494: B<idrget($udom,@unames)>: find the IDs behind a list of
9495: usernames (returns hash: name=>id,name=>id)
9496:
9497: =item *
9498: X<idput()>
9499: B<idput($udom,%ids)>: store away a list of names and associated IDs
9500:
9501: =item *
9502: X<rolesinit()>
9503: B<rolesinit($udom,$username,$authhost)>: get user privileges
9504:
9505: =item *
9506: X<getsection()>
9507: B<getsection($udom,$uname,$cname)>: finds the section of student in the
9508: course $cname, return section name/number or '' for "not in course"
9509: and '-1' for "no section"
9510:
9511: =item *
9512: X<userenvironment()>
9513: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
9514: passed in @what from the requested user's environment, returns a hash
9515:
9516: =item *
9517: X<userlog_query()>
9518: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
9519: activity.log file. %filters defines filters applied when parsing the
9520: log file. These can be start or end timestamps, or the type of action
9521: - log to look for Login or Logout events, check for Checkin or
9522: Checkout, role for role selection. The response is in the form
9523: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
9524: escaped strings of the action recorded in the activity.log file.
9525:
9526: =back
9527:
9528: =head2 User Roles
9529:
9530: =over 4
9531:
9532: =item *
9533:
9534: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
9535: F: full access
9536: U,I,K: authentication modes (cxx only)
9537: '': forbidden
9538: 1: user needs to choose course
9539: 2: browse allowed
9540: A: passphrase authentication needed
9541:
9542: =item *
9543:
9544: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
9545: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
9546: and course level
9547:
9548: =item *
9549:
9550: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
9551: (rolesplain.tab); plain text explanation of a user role term.
9552: $type is Course (default) or Group.
9553: If $forcedefault evaluates to true, text returned will be default
9554: text for $type. Otherwise, if this is a course, the text returned
9555: will be a custom name for the role (if defined in the course's
9556: environment). If no custom name is defined the default is returned.
9557:
9558: =item *
9559:
9560: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
9561: All arguments are optional. Returns a hash of a roles, either for
9562: co-author/assistant author roles for a user's Construction Space
9563: (default), or if $context is 'userroles', roles for the user himself,
9564: In the hash, keys are set to colon-separated $uname,$udom,$role, and
9565: (optionally) if $withsec is true, a fourth colon-separated item - $section.
9566: For each key, value is set to colon-separated start and end times for
9567: the role. If no username and domain are specified, will default to
9568: current user/domain. Types, roles, and roledoms are references to arrays
9569: of role statuses (active, future or previous), roles
9570: (e.g., cc,in, st etc.) and domains of the roles which can be used
9571: to restrict the list of roles reported. If no array ref is
9572: provided for types, will default to return only active roles.
9573:
9574: =back
9575:
9576: =head2 User Modification
9577:
9578: =over 4
9579:
9580: =item *
9581:
9582: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
9583: user for the level given by URL. Optional start and end dates (leave empty
9584: string or zero for "no date")
9585:
9586: =item *
9587:
9588: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
9589: change a users, password, possible return values are: ok,
9590: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
9591: refused
9592:
9593: =item *
9594:
9595: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
9596:
9597: =item *
9598:
9599: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
9600: $forceid,$desiredhome,$email,$inststatus) :
9601: modify user
9602:
9603: =item *
9604:
9605: modifystudent
9606:
9607: modify a student's enrollment and identification information.
9608: The course id is resolved based on the current users environment.
9609: This means the envoking user must be a course coordinator or otherwise
9610: associated with a course.
9611:
9612: This call is essentially a wrapper for lonnet::modifyuser and
9613: lonnet::modify_student_enrollment
9614:
9615: Inputs:
9616:
9617: =over 4
9618:
9619: =item B<$udom> Student's loncapa domain
9620:
9621: =item B<$uname> Student's loncapa login name
9622:
9623: =item B<$uid> Student/Employee ID
9624:
9625: =item B<$umode> Student's authentication mode
9626:
9627: =item B<$upass> Student's password
9628:
9629: =item B<$first> Student's first name
9630:
9631: =item B<$middle> Student's middle name
9632:
9633: =item B<$last> Student's last name
9634:
9635: =item B<$gene> Student's generation
9636:
9637: =item B<$usec> Student's section in course
9638:
9639: =item B<$end> Unix time of the roles expiration
9640:
9641: =item B<$start> Unix time of the roles start date
9642:
9643: =item B<$forceid> If defined, allow $uid to be changed
9644:
9645: =item B<$desiredhome> server to use as home server for student
9646:
9647: =item B<$email> Student's permanent e-mail address
9648:
9649: =item B<$type> Type of enrollment (auto or manual)
9650:
9651: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
9652:
9653: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
9654:
9655: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
9656:
9657: =item B<$context> role change context (shown in User Management Logs display in a course)
9658:
9659: =item B<$inststatus> institutional status of user - : separated string of escaped status types
9660:
9661: =back
9662:
9663: =item *
9664:
9665: modify_student_enrollment
9666:
9667: Change a students enrollment status in a class. The environment variable
9668: 'role.request.course' must be defined for this function to proceed.
9669:
9670: Inputs:
9671:
9672: =over 4
9673:
9674: =item $udom, students domain
9675:
9676: =item $uname, students name
9677:
9678: =item $uid, students user id
9679:
9680: =item $first, students first name
9681:
9682: =item $middle
9683:
9684: =item $last
9685:
9686: =item $gene
9687:
9688: =item $usec
9689:
9690: =item $end
9691:
9692: =item $start
9693:
9694: =item $type
9695:
9696: =item $locktype
9697:
9698: =item $cid
9699:
9700: =item $selfenroll
9701:
9702: =item $context
9703:
9704: =back
9705:
9706:
9707: =item *
9708:
9709: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
9710: custom role; give a custom role to a user for the level given by URL. Specify
9711: name and domain of role author, and role name
9712:
9713: =item *
9714:
9715: revokerole($udom,$uname,$url,$role) : revoke a role for url
9716:
9717: =item *
9718:
9719: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
9720:
9721: =back
9722:
9723: =head2 Course Infomation
9724:
9725: =over 4
9726:
9727: =item *
9728:
9729: coursedescription($courseid) : returns a hash of information about the
9730: specified course id, including all environment settings for the
9731: course, the description of the course will be in the hash under the
9732: key 'description'
9733:
9734: =item *
9735:
9736: resdata($name,$domain,$type,@which) : request for current parameter
9737: setting for a specific $type, where $type is either 'course' or 'user',
9738: @what should be a list of parameters to ask about. This routine caches
9739: answers for 5 minutes.
9740:
9741: =item *
9742:
9743: get_courseresdata($courseid, $domain) : dump the entire course resource
9744: data base, returning a hash that is keyed by the resource name and has
9745: values that are the resource value. I believe that the timestamps and
9746: versions are also returned.
9747:
9748:
9749: =back
9750:
9751: =head2 Course Modification
9752:
9753: =over 4
9754:
9755: =item *
9756:
9757: writecoursepref($courseid,%prefs) : write preferences (environment
9758: database) for a course
9759:
9760: =item *
9761:
9762: createcourse($udom,$description,$url) : make/modify course
9763:
9764: =back
9765:
9766: =head2 Resource Subroutines
9767:
9768: =over 4
9769:
9770: =item *
9771:
9772: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
9773:
9774: =item *
9775:
9776: repcopy($filename) : subscribes to the requested file, and attempts to
9777: replicate from the owning library server, Might return
9778: 'unavailable', 'not_found', 'forbidden', 'ok', or
9779: 'bad_request', also attempts to grab the metadata for the
9780: resource. Expects the local filesystem pathname
9781: (/home/httpd/html/res/....)
9782:
9783: =back
9784:
9785: =head2 Resource Information
9786:
9787: =over 4
9788:
9789: =item *
9790:
9791: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
9792: a vairety of different possible values, $varname should be a request
9793: string, and the other parameters can be used to specify who and what
9794: one is asking about.
9795:
9796: Possible values for $varname are environment.lastname (or other item
9797: from the envirnment hash), user.name (or someother aspect about the
9798: user), resource.0.maxtries (or some other part and parameter of a
9799: resource)
9800:
9801: =item *
9802:
9803: directcondval($number) : get current value of a condition; reads from a state
9804: string
9805:
9806: =item *
9807:
9808: condval($condidx) : value of condition index based on state
9809:
9810: =item *
9811:
9812: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
9813: resource's metadata, $what should be either a specific key, or either
9814: 'keys' (to get a list of possible keys) or 'packages' to get a list of
9815: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
9816:
9817: this function automatically caches all requests
9818:
9819: =item *
9820:
9821: metadata_query($query,$custom,$customshow) : make a metadata query against the
9822: network of library servers; returns file handle of where SQL and regex results
9823: will be stored for query
9824:
9825: =item *
9826:
9827: symbread($filename) : return symbolic list entry (filename argument optional);
9828: returns the data handle
9829:
9830: =item *
9831:
9832: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
9833: a possible symb for the URL in $thisfn, and if is an encryypted
9834: resource that the user accessed using /enc/ returns a 1 on success, 0
9835: on failure, user must be in a course, as it assumes the existance of
9836: the course initial hash, and uses $env('request.course.id'}
9837:
9838:
9839: =item *
9840:
9841: symbclean($symb) : removes versions numbers from a symb, returns the
9842: cleaned symb
9843:
9844: =item *
9845:
9846: is_on_map($uri) : checks if the $uri is somewhere on the current
9847: course map, user must be in a course for it to work.
9848:
9849: =item *
9850:
9851: numval($salt) : return random seed value (addend for rndseed)
9852:
9853: =item *
9854:
9855: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
9856: a random seed, all arguments are optional, if they aren't sent it uses the
9857: environment to derive them. Note: if symb isn't sent and it can't get one
9858: from &symbread it will use the current time as its return value
9859:
9860: =item *
9861:
9862: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
9863: unfakeable, receipt
9864:
9865: =item *
9866:
9867: receipt() : API to ireceipt working off of env values; given out to users
9868:
9869: =item *
9870:
9871: countacc($url) : count the number of accesses to a given URL
9872:
9873: =item *
9874:
9875: 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
9876:
9877: =item *
9878:
9879: 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)
9880:
9881: =item *
9882:
9883: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
9884:
9885: =item *
9886:
9887: devalidate($symb) : devalidate temporary spreadsheet calculations,
9888: forcing spreadsheet to reevaluate the resource scores next time.
9889:
9890: =back
9891:
9892: =head2 Storing/Retreiving Data
9893:
9894: =over 4
9895:
9896: =item *
9897:
9898: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
9899: for this url; hashref needs to be given and should be a \%hashname; the
9900: remaining args aren't required and if they aren't passed or are '' they will
9901: be derived from the env
9902:
9903: =item *
9904:
9905: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
9906: uses critical subroutine
9907:
9908: =item *
9909:
9910: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
9911: all args are optional
9912:
9913: =item *
9914:
9915: dumpstore($namespace,$udom,$uname,$regexp,$range) :
9916: dumps the complete (or key matching regexp) namespace into a hash
9917: ($udom, $uname, $regexp, $range are optional) for a namespace that is
9918: normally &store()ed into
9919:
9920: $range should be either an integer '100' (give me the first 100
9921: matching records)
9922: or be two integers sperated by a - with no spaces
9923: '30-50' (give me the 30th through the 50th matching
9924: records)
9925:
9926:
9927: =item *
9928:
9929: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
9930: replaces a &store() version of data with a replacement set of data
9931: for a particular resource in a namespace passed in the $storehash hash
9932: reference
9933:
9934: =item *
9935:
9936: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
9937: works very similar to store/cstore, but all data is stored in a
9938: temporary location and can be reset using tmpreset, $storehash should
9939: be a hash reference, returns nothing on success
9940:
9941: =item *
9942:
9943: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
9944: similar to restore, but all data is stored in a temporary location and
9945: can be reset using tmpreset. Returns a hash of values on success,
9946: error string otherwise.
9947:
9948: =item *
9949:
9950: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
9951: deltes all keys for $symb form the temporary storage hash.
9952:
9953: =item *
9954:
9955: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9956: reference filled in from namesp ($udom and $uname are optional)
9957:
9958: =item *
9959:
9960: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
9961: namesp ($udom and $uname are optional)
9962:
9963: =item *
9964:
9965: dump($namespace,$udom,$uname,$regexp,$range) :
9966: dumps the complete (or key matching regexp) namespace into a hash
9967: ($udom, $uname, $regexp, $range are optional)
9968:
9969: $range should be either an integer '100' (give me the first 100
9970: matching records)
9971: or be two integers sperated by a - with no spaces
9972: '30-50' (give me the 30th through the 50th matching
9973: records)
9974: =item *
9975:
9976: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
9977: $store can be a scalar, an array reference, or if the amount to be
9978: incremented is > 1, a hash reference.
9979:
9980: ($udom and $uname are optional)
9981:
9982: =item *
9983:
9984: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
9985: ($udom and $uname are optional)
9986:
9987: =item *
9988:
9989: cput($namespace,$storehash,$udom,$uname) : critical put
9990: ($udom and $uname are optional)
9991:
9992: =item *
9993:
9994: newput($namespace,$storehash,$udom,$uname) :
9995:
9996: Attempts to store the items in the $storehash, but only if they don't
9997: currently exist, if this succeeds you can be certain that you have
9998: successfully created a new key value pair in the $namespace db.
9999:
10000:
10001: Args:
10002: $namespace: name of database to store values to
10003: $storehash: hashref to store to the db
10004: $udom: (optional) domain of user containing the db
10005: $uname: (optional) name of user caontaining the db
10006:
10007: Returns:
10008: 'ok' -> succeeded in storing all keys of $storehash
10009: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10010: least <key> already existed in the db (other
10011: requested keys may also already exist)
10012: 'error: <msg>' -> unable to tie the DB or other error occurred
10013: 'con_lost' -> unable to contact request server
10014: 'refused' -> action was not allowed by remote machine
10015:
10016:
10017: =item *
10018:
10019: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10020: reference filled in from namesp (encrypts the return communication)
10021: ($udom and $uname are optional)
10022:
10023: =item *
10024:
10025: log($udom,$name,$home,$message) : write to permanent log for user; use
10026: critical subroutine
10027:
10028: =item *
10029:
10030: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10031: array reference filled in from namespace found in domain level on either
10032: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
10033:
10034: =item *
10035:
10036: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10037: domain level either on specified domain server ($uhome) or primary domain
10038: server ($udom and $uhome are optional)
10039:
10040: =item *
10041:
10042: get_domain_defaults($target_domain) : returns hash with defaults for
10043: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10044: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10045: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10046: Values are retrieved from cache (if current), or from domain's configuration.db
10047: (if available), or lastly from values in lonTabs/dns_domain,tab,
10048: or lonTabs/domain.tab.
10049:
10050: %domdefaults = &get_auth_defaults($target_domain);
10051:
10052: =back
10053:
10054: =head2 Network Status Functions
10055:
10056: =over 4
10057:
10058: =item *
10059:
10060: dirlist($uri) : return directory list based on URI
10061:
10062: =item *
10063:
10064: spareserver() : find server with least workload from spare.tab
10065:
10066:
10067: =item *
10068:
10069: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10070: if there is no corresponding loncapa host.
10071:
10072: =back
10073:
10074:
10075: =head2 Apache Request
10076:
10077: =over 4
10078:
10079: =item *
10080:
10081: ssi($url,%hash) : server side include, does a complete request cycle on url to
10082: localhost, posts hash
10083:
10084: =back
10085:
10086: =head2 Data to String to Data
10087:
10088: =over 4
10089:
10090: =item *
10091:
10092: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10093: and '&' separators, supports elements that are arrayrefs and hashrefs
10094:
10095: =item *
10096:
10097: hashref2str($hashref) : convert a hashref into a string complete with
10098: escaping and '=' and '&' separators, supports elements that are
10099: arrayrefs and hashrefs
10100:
10101: =item *
10102:
10103: arrayref2str($arrayref) : convert an arrayref into a string complete
10104: with escaping and '&' separators, supports elements that are arrayrefs
10105: and hashrefs
10106:
10107: =item *
10108:
10109: str2hash($string) : convert string to hash using unescaping and
10110: splitting on '=' and '&', supports elements that are arrayrefs and
10111: hashrefs
10112:
10113: =item *
10114:
10115: str2array($string) : convert string to hash using unescaping and
10116: splitting on '&', supports elements that are arrayrefs and hashrefs
10117:
10118: =back
10119:
10120: =head2 Logging Routines
10121:
10122: =over 4
10123:
10124: These routines allow one to make log messages in the lonnet.log and
10125: lonnet.perm logfiles.
10126:
10127: =item *
10128:
10129: logtouch() : make sure the logfile, lonnet.log, exists
10130:
10131: =item *
10132:
10133: logthis() : append message to the normal lonnet.log file, it gets
10134: preiodically rolled over and deleted.
10135:
10136: =item *
10137:
10138: logperm() : append a permanent message to lonnet.perm.log, this log
10139: file never gets deleted by any automated portion of the system, only
10140: messages of critical importance should go in here.
10141:
10142: =back
10143:
10144: =head2 General File Helper Routines
10145:
10146: =over 4
10147:
10148: =item *
10149:
10150: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10151: (a) files in /uploaded
10152: (i) If a local copy of the file exists -
10153: compares modification date of local copy with last-modified date for
10154: definitive version stored on home server for course. If local copy is
10155: stale, requests a new version from the home server and stores it.
10156: If the original has been removed from the home server, then local copy
10157: is unlinked.
10158: (ii) If local copy does not exist -
10159: requests the file from the home server and stores it.
10160:
10161: If $caller is 'uploadrep':
10162: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10163: for request for files originally uploaded via DOCS.
10164: - returns 'ok' if fresh local copy now available, -1 otherwise.
10165:
10166: Otherwise:
10167: This indicates a call from the content generation phase of the request.
10168: - returns the entire contents of the file or -1.
10169:
10170: (b) files in /res
10171: - returns the entire contents of a file or -1;
10172: it properly subscribes to and replicates the file if neccessary.
10173:
10174:
10175: =item *
10176:
10177: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10178: reference
10179:
10180: returns either a stat() list of data about the file or an empty list
10181: if the file doesn't exist or couldn't find out about it (connection
10182: problems or user unknown)
10183:
10184: =item *
10185:
10186: filelocation($dir,$file) : returns file system location of a file
10187: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10188: directory that relative $file lookups are to looked in ($dir of /a/dir
10189: and a file of ../bob will become /a/bob)
10190:
10191: =item *
10192:
10193: hreflocation($dir,$file) : returns file system location or a URL; same as
10194: filelocation except for hrefs
10195:
10196: =item *
10197:
10198: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10199:
10200: =back
10201:
10202: =head2 Usererfile file routines (/uploaded*)
10203:
10204: =over 4
10205:
10206: =item *
10207:
10208: userfileupload(): main rotine for putting a file in a user or course's
10209: filespace, arguments are,
10210:
10211: formname - required - this is the name of the element in $env where the
10212: filename, and the contents of the file to create/modifed exist
10213: the filename is in $env{'form.'.$formname.'.filename'} and the
10214: contents of the file is located in $env{'form.'.$formname}
10215: coursedoc - if true, store the file in the course of the active role
10216: of the current user
10217: subdir - required - subdirectory to put the file in under ../userfiles/
10218: if undefined, it will be placed in "unknown"
10219:
10220: (This routine calls clean_filename() to remove any dangerous
10221: characters from the filename, and then calls finuserfileupload() to
10222: complete the transaction)
10223:
10224: returns either the url of the uploaded file (/uploaded/....) if successful
10225: and /adm/notfound.html if unsuccessful
10226:
10227: =item *
10228:
10229: clean_filename(): routine for cleaing a filename up for storage in
10230: userfile space, argument is:
10231:
10232: filename - proposed filename
10233:
10234: returns: the new clean filename
10235:
10236: =item *
10237:
10238: finishuserfileupload(): routine that creaes and sends the file to
10239: userspace, probably shouldn't be called directly
10240:
10241: docuname: username or courseid of destination for the file
10242: docudom: domain of user/course of destination for the file
10243: formname: same as for userfileupload()
10244: fname: filename (inculding subdirectories) for the file
10245:
10246: returns either the url of the uploaded file (/uploaded/....) if successful
10247: and /adm/notfound.html if unsuccessful
10248:
10249: =item *
10250:
10251: renameuserfile(): renames an existing userfile to a new name
10252:
10253: Args:
10254: docuname: username or courseid of destination for the file
10255: docudom: domain of user/course of destination for the file
10256: old: current file name (including any subdirs under userfiles)
10257: new: desired file name (including any subdirs under userfiles)
10258:
10259: =item *
10260:
10261: mkdiruserfile(): creates a directory is a userfiles dir
10262:
10263: Args:
10264: docuname: username or courseid of destination for the file
10265: docudom: domain of user/course of destination for the file
10266: dir: dir to create (including any subdirs under userfiles)
10267:
10268: =item *
10269:
10270: removeuserfile(): removes a file that exists in userfiles
10271:
10272: Args:
10273: docuname: username or courseid of destination for the file
10274: docudom: domain of user/course of destination for the file
10275: fname: filname to delete (including any subdirs under userfiles)
10276:
10277: =item *
10278:
10279: removeuploadedurl(): convience function for removeuserfile()
10280:
10281: Args:
10282: url: a full /uploaded/... url to delete
10283:
10284: =item *
10285:
10286: get_portfile_permissions():
10287: Args:
10288: domain: domain of user or course contain the portfolio files
10289: user: name of user or num of course contain the portfolio files
10290: Returns:
10291: hashref of a dump of the proper file_permissions.db
10292:
10293:
10294: =item *
10295:
10296: get_access_controls():
10297:
10298: Args:
10299: current_permissions: the hash ref returned from get_portfile_permissions()
10300: group: (optional) the group you want the files associated with
10301: file: (optional) the file you want access info on
10302:
10303: Returns:
10304: a hash (keys are file names) of hashes containing
10305: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10306: values are XML containing access control settings (see below)
10307:
10308: Internal notes:
10309:
10310: access controls are stored in file_permissions.db as key=value pairs.
10311: key -> path to file/file_name\0uniqueID:scope_end_start
10312: where scope -> public,guest,course,group,domains or users.
10313: end -> UNIX time for end of access (0 -> no end date)
10314: start -> UNIX time for start of access
10315:
10316: value -> XML description of access control
10317: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10318: <start></start>
10319: <end></end>
10320:
10321: <password></password> for scope type = guest
10322:
10323: <domain></domain> for scope type = course or group
10324: <number></number>
10325: <roles id="">
10326: <role></role>
10327: <access></access>
10328: <section></section>
10329: <group></group>
10330: </roles>
10331:
10332: <dom></dom> for scope type = domains
10333:
10334: <users> for scope type = users
10335: <user>
10336: <uname></uname>
10337: <udom></udom>
10338: </user>
10339: </users>
10340: </scope>
10341:
10342: Access data is also aggregated for each file in an additional key=value pair:
10343: key -> path to file/file_name\0accesscontrol
10344: value -> reference to hash
10345: hash contains key = value pairs
10346: where key = uniqueID:scope_end_start
10347: value = UNIX time record was last updated
10348:
10349: Used to improve speed of look-ups of access controls for each file.
10350:
10351: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
10352:
10353: modify_access_controls():
10354:
10355: Modifies access controls for a portfolio file
10356: Args
10357: 1. file name
10358: 2. reference to hash of required changes,
10359: 3. domain
10360: 4. username
10361: where domain,username are the domain of the portfolio owner
10362: (either a user or a course)
10363:
10364: Returns:
10365: 1. result of additions or updates ('ok' or 'error', with error message).
10366: 2. result of deletions ('ok' or 'error', with error message).
10367: 3. reference to hash of any new or updated access controls.
10368: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
10369: key = integer (inbound ID)
10370: value = uniqueID
10371:
10372: =back
10373:
10374: =head2 HTTP Helper Routines
10375:
10376: =over 4
10377:
10378: =item *
10379:
10380: escape() : unpack non-word characters into CGI-compatible hex codes
10381:
10382: =item *
10383:
10384: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
10385:
10386: =back
10387:
10388: =head1 PRIVATE SUBROUTINES
10389:
10390: =head2 Underlying communication routines (Shouldn't call)
10391:
10392: =over 4
10393:
10394: =item *
10395:
10396: subreply() : tries to pass a message to lonc, returns con_lost if incapable
10397:
10398: =item *
10399:
10400: reply() : uses subreply to send a message to remote machine, logs all failures
10401:
10402: =item *
10403:
10404: critical() : passes a critical message to another server; if cannot
10405: get through then place message in connection buffer directory and
10406: returns con_delayed, if incapable of saving message, returns
10407: con_failed
10408:
10409: =item *
10410:
10411: reconlonc() : tries to reconnect lonc client processes.
10412:
10413: =back
10414:
10415: =head2 Resource Access Logging
10416:
10417: =over 4
10418:
10419: =item *
10420:
10421: flushcourselogs() : flush (save) buffer logs and access logs
10422:
10423: =item *
10424:
10425: courselog($what) : save message for course in hash
10426:
10427: =item *
10428:
10429: courseacclog($what) : save message for course using &courselog(). Perform
10430: special processing for specific resource types (problems, exams, quizzes, etc).
10431:
10432: =item *
10433:
10434: goodbye() : flush course logs and log shutting down; it is called in srm.conf
10435: as a PerlChildExitHandler
10436:
10437: =back
10438:
10439: =head2 Other
10440:
10441: =over 4
10442:
10443: =item *
10444:
10445: symblist($mapname,%newhash) : update symbolic storage links
10446:
10447: =back
10448:
10449: =cut
10450:
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