1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.999 2009/05/08 14:33:16 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: my %privileged;
2738: foreach my $entry (keys %dumphash) {
2739: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2740: if (($tstart) && ($tstart<0)) { next; }
2741: if (($tend) && ($tend<$now)) { next; }
2742: if (($tstart) && ($now<$tstart)) { next; }
2743: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2744: if ($username eq '' || $domain eq '') { next; }
2745: unless (ref($privileged{$domain}) eq 'HASH') {
2746: my %dompersonnel =
2747: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2748: $privileged{$domain} = {};
2749: foreach my $server (keys(%dompersonnel)) {
2750: if (ref($dompersonnel{$server}) eq 'HASH') {
2751: foreach my $user (keys(%{$dompersonnel{$server}})) {
2752: my ($trole,$uname,$udom) = split(/:/,$user);
2753: $privileged{$udom}{$uname} = 1;
2754: }
2755: }
2756: }
2757: }
2758: if ((exists($privileged{$domain}{$username})) &&
2759: (!$nothide{$username.':'.$domain})) { next; }
2760: if ($role eq 'cr') { next; }
2761: if ($codes) {
2762: if ($section) { $role .= ':'.$section; }
2763: if ($returnhash{$role}) {
2764: $returnhash{$role}.=','.$username.':'.$domain;
2765: } else {
2766: $returnhash{$role}=$username.':'.$domain;
2767: }
2768: } else {
2769: my $key=&plaintext($role,$crstype);
2770: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2771: if ($returnhash{$key}) {
2772: $returnhash{$key}.=','.$username.':'.$domain;
2773: } else {
2774: $returnhash{$key}=$username.':'.$domain;
2775: }
2776: }
2777: }
2778: return %returnhash;
2779: }
2780:
2781: sub get_my_roles {
2782: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2783: unless (defined($uname)) { $uname=$env{'user.name'}; }
2784: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2785: my (%dumphash,%nothide);
2786: if ($context eq 'userroles') {
2787: %dumphash = &dump('roles',$udom,$uname);
2788: } else {
2789: %dumphash=
2790: &dump('nohist_userroles',$udom,$uname);
2791: if ($hidepriv) {
2792: my %coursehash=&coursedescription($udom.'_'.$uname);
2793: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2794: if ($user !~ /:/) {
2795: $nothide{join(':',split(/[\@]/,$user))} = 1;
2796: } else {
2797: $nothide{$user} = 1;
2798: }
2799: }
2800: }
2801: }
2802: my %returnhash=();
2803: my $now=time;
2804: my %privileged;
2805: foreach my $entry (keys(%dumphash)) {
2806: my ($role,$tend,$tstart);
2807: if ($context eq 'userroles') {
2808: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2809: } else {
2810: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2811: }
2812: if (($tstart) && ($tstart<0)) { next; }
2813: my $status = 'active';
2814: if (($tend) && ($tend<=$now)) {
2815: $status = 'previous';
2816: }
2817: if (($tstart) && ($now<$tstart)) {
2818: $status = 'future';
2819: }
2820: if (ref($types) eq 'ARRAY') {
2821: if (!grep(/^\Q$status\E$/,@{$types})) {
2822: next;
2823: }
2824: } else {
2825: if ($status ne 'active') {
2826: next;
2827: }
2828: }
2829: my ($rolecode,$username,$domain,$section,$area);
2830: if ($context eq 'userroles') {
2831: ($area,$rolecode) = split(/_/,$entry);
2832: (undef,$domain,$username,$section) = split(/\//,$area);
2833: } else {
2834: ($role,$username,$domain,$section) = split(/\:/,$entry);
2835: }
2836: if (ref($roledoms) eq 'ARRAY') {
2837: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2838: next;
2839: }
2840: }
2841: if (ref($roles) eq 'ARRAY') {
2842: if (!grep(/^\Q$role\E$/,@{$roles})) {
2843: if ($role =~ /^cr\//) {
2844: if (!grep(/^cr$/,@{$roles})) {
2845: next;
2846: }
2847: } else {
2848: next;
2849: }
2850: }
2851: }
2852: if ($hidepriv) {
2853: if ($context eq 'userroles') {
2854: if ((&privileged($username,$domain)) &&
2855: (!$nothide{$username.':'.$domain})) {
2856: next;
2857: }
2858: } else {
2859: unless (ref($privileged{$domain}) eq 'HASH') {
2860: my %dompersonnel =
2861: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2862: $privileged{$domain} = {};
2863: if (keys(%dompersonnel)) {
2864: foreach my $server (keys(%dompersonnel)) {
2865: if (ref($dompersonnel{$server}) eq 'HASH') {
2866: foreach my $user (keys(%{$dompersonnel{$server}})) {
2867: my ($trole,$uname,$udom) = split(/:/,$user);
2868: $privileged{$udom}{$uname} = $trole;
2869: }
2870: }
2871: }
2872: }
2873: }
2874: if (exists($privileged{$domain}{$username})) {
2875: if (!$nothide{$username.':'.$domain}) {
2876: next;
2877: }
2878: }
2879: }
2880: }
2881: if ($withsec) {
2882: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2883: $tstart.':'.$tend;
2884: } else {
2885: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2886: }
2887: }
2888: return %returnhash;
2889: }
2890:
2891: # ----------------------------------------------------- Frontpage Announcements
2892: #
2893: #
2894:
2895: sub postannounce {
2896: my ($server,$text)=@_;
2897: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2898: unless ($text=~/\w/) { $text=''; }
2899: return &reply('setannounce:'.&escape($text),$server);
2900: }
2901:
2902: sub getannounce {
2903:
2904: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2905: my $announcement='';
2906: while (my $line = <$fh>) { $announcement .= $line; }
2907: close($fh);
2908: if ($announcement=~/\w/) {
2909: return
2910: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2911: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2912: } else {
2913: return '';
2914: }
2915: } else {
2916: return '';
2917: }
2918: }
2919:
2920: # ---------------------------------------------------------- Course ID routines
2921: # Deal with domain's nohist_courseid.db files
2922: #
2923:
2924: sub courseidput {
2925: my ($domain,$storehash,$coursehome,$caller) = @_;
2926: my $outcome;
2927: if ($caller eq 'timeonly') {
2928: my $cids = '';
2929: foreach my $item (keys(%$storehash)) {
2930: $cids.=&escape($item).'&';
2931: }
2932: $cids=~s/\&$//;
2933: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
2934: $coursehome);
2935: } else {
2936: my $items = '';
2937: foreach my $item (keys(%$storehash)) {
2938: $items.= &escape($item).'='.
2939: &freeze_escape($$storehash{$item}).'&';
2940: }
2941: $items=~s/\&$//;
2942: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
2943: $coursehome);
2944: }
2945: if ($outcome eq 'unknown_cmd') {
2946: my $what;
2947: foreach my $cid (keys(%$storehash)) {
2948: $what .= &escape($cid).'=';
2949: foreach my $item ('description','inst_code','owner','type') {
2950: $what .= &escape($storehash->{$cid}{$item}).':';
2951: }
2952: $what =~ s/\:$/&/;
2953: }
2954: $what =~ s/\&$//;
2955: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2956: } else {
2957: return $outcome;
2958: }
2959: }
2960:
2961: sub courseiddump {
2962: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
2963: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
2964: $selfenrollonly,$catfilter,$showhidden,$caller)=@_;
2965: my $as_hash = 1;
2966: my %returnhash;
2967: if (!$domfilter) { $domfilter=''; }
2968: my %libserv = &all_library();
2969: foreach my $tryserver (keys(%libserv)) {
2970: if ( ( $hostidflag == 1
2971: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2972: || (!defined($hostidflag)) ) {
2973:
2974: if (($domfilter eq '') ||
2975: (&host_domain($tryserver) eq $domfilter)) {
2976: my $rep =
2977: &reply('courseiddump:'.&host_domain($tryserver).':'.
2978: $sincefilter.':'.&escape($descfilter).':'.
2979: &escape($instcodefilter).':'.&escape($ownerfilter).
2980: ':'.&escape($coursefilter).':'.&escape($typefilter).
2981: ':'.&escape($regexp_ok).':'.$as_hash.':'.
2982: &escape($selfenrollonly).':'.&escape($catfilter).':'.
2983: $showhidden.':'.$caller,$tryserver);
2984: my @pairs=split(/\&/,$rep);
2985: foreach my $item (@pairs) {
2986: my ($key,$value)=split(/\=/,$item,2);
2987: $key = &unescape($key);
2988: next if ($key =~ /^error: 2 /);
2989: my $result = &thaw_unescape($value);
2990: if (ref($result) eq 'HASH') {
2991: $returnhash{$key}=$result;
2992: } else {
2993: my @responses = split(/:/,$value);
2994: my @items = ('description','inst_code','owner','type');
2995: for (my $i=0; $i<@responses; $i++) {
2996: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
2997: }
2998: }
2999: }
3000: }
3001: }
3002: }
3003: return %returnhash;
3004: }
3005:
3006: # ---------------------------------------------------------- DC e-mail
3007:
3008: sub dcmailput {
3009: my ($domain,$msgid,$message,$server)=@_;
3010: my $status = &Apache::lonnet::critical(
3011: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3012: &escape($message),$server);
3013: return $status;
3014: }
3015:
3016: sub dcmaildump {
3017: my ($dom,$startdate,$enddate,$senders) = @_;
3018: my %returnhash=();
3019:
3020: if (defined(&domain($dom,'primary'))) {
3021: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3022: &escape($enddate).':';
3023: my @esc_senders=map { &escape($_)} @$senders;
3024: $cmd.=&escape(join('&',@esc_senders));
3025: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3026: my ($key,$value) = split(/\=/,$line,2);
3027: if (($key) && ($value)) {
3028: $returnhash{&unescape($key)} = &unescape($value);
3029: }
3030: }
3031: }
3032: return %returnhash;
3033: }
3034: # ---------------------------------------------------------- Domain roles
3035:
3036: sub get_domain_roles {
3037: my ($dom,$roles,$startdate,$enddate)=@_;
3038: if (undef($startdate) || $startdate eq '') {
3039: $startdate = '.';
3040: }
3041: if (undef($enddate) || $enddate eq '') {
3042: $enddate = '.';
3043: }
3044: my $rolelist;
3045: if (ref($roles) eq 'ARRAY') {
3046: $rolelist = join(':',@{$roles});
3047: }
3048: my %personnel = ();
3049:
3050: my %servers = &get_servers($dom,'library');
3051: foreach my $tryserver (keys(%servers)) {
3052: %{$personnel{$tryserver}}=();
3053: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3054: &escape($startdate).':'.
3055: &escape($enddate).':'.
3056: &escape($rolelist), $tryserver))) {
3057: my ($key,$value) = split(/\=/,$line,2);
3058: if (($key) && ($value)) {
3059: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3060: }
3061: }
3062: }
3063: return %personnel;
3064: }
3065:
3066: # ----------------------------------------------------------- Check out an item
3067:
3068: sub get_first_access {
3069: my ($type,$argsymb)=@_;
3070: my ($symb,$courseid,$udom,$uname)=&whichuser();
3071: if ($argsymb) { $symb=$argsymb; }
3072: my ($map,$id,$res)=&decode_symb($symb);
3073: if ($type eq 'course') {
3074: $res='course';
3075: } elsif ($type eq 'map') {
3076: $res=&symbread($map);
3077: } else {
3078: $res=$symb;
3079: }
3080: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3081: return $times{"$courseid\0$res"};
3082: }
3083:
3084: sub set_first_access {
3085: my ($type)=@_;
3086: my ($symb,$courseid,$udom,$uname)=&whichuser();
3087: my ($map,$id,$res)=&decode_symb($symb);
3088: if ($type eq 'course') {
3089: $res='course';
3090: } elsif ($type eq 'map') {
3091: $res=&symbread($map);
3092: } else {
3093: $res=$symb;
3094: }
3095: my $firstaccess=&get_first_access($type,$symb);
3096: if (!$firstaccess) {
3097: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3098: }
3099: return 'already_set';
3100: }
3101:
3102: sub checkout {
3103: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3104: my $now=time;
3105: my $lonhost=$perlvar{'lonHostID'};
3106: my $infostr=&escape(
3107: 'CHECKOUTTOKEN&'.
3108: $tuname.'&'.
3109: $tudom.'&'.
3110: $tcrsid.'&'.
3111: $symb.'&'.
3112: $now.'&'.$ENV{'REMOTE_ADDR'});
3113: my $token=&reply('tmpput:'.$infostr,$lonhost);
3114: if ($token=~/^error\:/) {
3115: &logthis("<font color=\"blue\">WARNING: ".
3116: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3117: "</font>");
3118: return '';
3119: }
3120:
3121: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3122: $token=~tr/a-z/A-Z/;
3123:
3124: my %infohash=('resource.0.outtoken' => $token,
3125: 'resource.0.checkouttime' => $now,
3126: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
3127:
3128: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3129: return '';
3130: } else {
3131: &logthis("<font color=\"blue\">WARNING: ".
3132: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3133: "</font>");
3134: }
3135:
3136: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3137: &escape('Checkout '.$infostr.' - '.
3138: $token)) ne 'ok') {
3139: return '';
3140: } else {
3141: &logthis("<font color=\"blue\">WARNING: ".
3142: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3143: "</font>");
3144: }
3145: return $token;
3146: }
3147:
3148: # ------------------------------------------------------------ Check in an item
3149:
3150: sub checkin {
3151: my $token=shift;
3152: my $now=time;
3153: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3154: $lonhost=~tr/A-Z/a-z/;
3155: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
3156: $dtoken=~s/\W/\_/g;
3157: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
3158: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3159:
3160: unless (($tuname) && ($tudom)) {
3161: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3162: return '';
3163: }
3164:
3165: unless (&allowed('mgr',$tcrsid)) {
3166: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
3167: $env{'user.name'}.' - '.$env{'user.domain'});
3168: return '';
3169: }
3170:
3171: my %infohash=('resource.0.intoken' => $token,
3172: 'resource.0.checkintime' => $now,
3173: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
3174:
3175: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3176: return '';
3177: }
3178:
3179: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3180: &escape('Checkin - '.$token)) ne 'ok') {
3181: return '';
3182: }
3183:
3184: return ($symb,$tuname,$tudom,$tcrsid);
3185: }
3186:
3187: # --------------------------------------------- Set Expire Date for Spreadsheet
3188:
3189: sub expirespread {
3190: my ($uname,$udom,$stype,$usymb)=@_;
3191: my $cid=$env{'request.course.id'};
3192: if ($cid) {
3193: my $now=time;
3194: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3195: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3196: $env{'course.'.$cid.'.num'}.
3197: ':nohist_expirationdates:'.
3198: &escape($key).'='.$now,
3199: $env{'course.'.$cid.'.home'})
3200: }
3201: return 'ok';
3202: }
3203:
3204: # ----------------------------------------------------- Devalidate Spreadsheets
3205:
3206: sub devalidate {
3207: my ($symb,$uname,$udom)=@_;
3208: my $cid=$env{'request.course.id'};
3209: if ($cid) {
3210: # delete the stored spreadsheets for
3211: # - the student level sheet of this user in course's homespace
3212: # - the assessment level sheet for this resource
3213: # for this user in user's homespace
3214: # - current conditional state info
3215: my $key=$uname.':'.$udom.':';
3216: my $status=
3217: &del('nohist_calculatedsheets',
3218: [$key.'studentcalc:'],
3219: $env{'course.'.$cid.'.domain'},
3220: $env{'course.'.$cid.'.num'})
3221: .' '.
3222: &del('nohist_calculatedsheets_'.$cid,
3223: [$key.'assesscalc:'.$symb],$udom,$uname);
3224: unless ($status eq 'ok ok') {
3225: &logthis('Could not devalidate spreadsheet '.
3226: $uname.' at '.$udom.' for '.
3227: $symb.': '.$status);
3228: }
3229: &delenv('user.state.'.$cid);
3230: }
3231: }
3232:
3233: sub get_scalar {
3234: my ($string,$end) = @_;
3235: my $value;
3236: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3237: $value = $1;
3238: } elsif ($$string =~ s/^([^&]*?)&//) {
3239: $value = $1;
3240: }
3241: return &unescape($value);
3242: }
3243:
3244: sub array2str {
3245: my (@array) = @_;
3246: my $result=&arrayref2str(\@array);
3247: $result=~s/^__ARRAY_REF__//;
3248: $result=~s/__END_ARRAY_REF__$//;
3249: return $result;
3250: }
3251:
3252: sub arrayref2str {
3253: my ($arrayref) = @_;
3254: my $result='__ARRAY_REF__';
3255: foreach my $elem (@$arrayref) {
3256: if(ref($elem) eq 'ARRAY') {
3257: $result.=&arrayref2str($elem).'&';
3258: } elsif(ref($elem) eq 'HASH') {
3259: $result.=&hashref2str($elem).'&';
3260: } elsif(ref($elem)) {
3261: #print("Got a ref of ".(ref($elem))." skipping.");
3262: } else {
3263: $result.=&escape($elem).'&';
3264: }
3265: }
3266: $result=~s/\&$//;
3267: $result .= '__END_ARRAY_REF__';
3268: return $result;
3269: }
3270:
3271: sub hash2str {
3272: my (%hash) = @_;
3273: my $result=&hashref2str(\%hash);
3274: $result=~s/^__HASH_REF__//;
3275: $result=~s/__END_HASH_REF__$//;
3276: return $result;
3277: }
3278:
3279: sub hashref2str {
3280: my ($hashref)=@_;
3281: my $result='__HASH_REF__';
3282: foreach my $key (sort(keys(%$hashref))) {
3283: if (ref($key) eq 'ARRAY') {
3284: $result.=&arrayref2str($key).'=';
3285: } elsif (ref($key) eq 'HASH') {
3286: $result.=&hashref2str($key).'=';
3287: } elsif (ref($key)) {
3288: $result.='=';
3289: #print("Got a ref of ".(ref($key))." skipping.");
3290: } else {
3291: if ($key) {$result.=&escape($key).'=';} else { last; }
3292: }
3293:
3294: if(ref($hashref->{$key}) eq 'ARRAY') {
3295: $result.=&arrayref2str($hashref->{$key}).'&';
3296: } elsif(ref($hashref->{$key}) eq 'HASH') {
3297: $result.=&hashref2str($hashref->{$key}).'&';
3298: } elsif(ref($hashref->{$key})) {
3299: $result.='&';
3300: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3301: } else {
3302: $result.=&escape($hashref->{$key}).'&';
3303: }
3304: }
3305: $result=~s/\&$//;
3306: $result .= '__END_HASH_REF__';
3307: return $result;
3308: }
3309:
3310: sub str2hash {
3311: my ($string)=@_;
3312: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3313: return %$hash;
3314: }
3315:
3316: sub str2hashref {
3317: my ($string) = @_;
3318:
3319: my %hash;
3320:
3321: if($string !~ /^__HASH_REF__/) {
3322: if (! ($string eq '' || !defined($string))) {
3323: $hash{'error'}='Not hash reference';
3324: }
3325: return (\%hash, $string);
3326: }
3327:
3328: $string =~ s/^__HASH_REF__//;
3329:
3330: while($string !~ /^__END_HASH_REF__/) {
3331: #key
3332: my $key='';
3333: if($string =~ /^__HASH_REF__/) {
3334: ($key, $string)=&str2hashref($string);
3335: if(defined($key->{'error'})) {
3336: $hash{'error'}='Bad data';
3337: return (\%hash, $string);
3338: }
3339: } elsif($string =~ /^__ARRAY_REF__/) {
3340: ($key, $string)=&str2arrayref($string);
3341: if($key->[0] eq 'Array reference error') {
3342: $hash{'error'}='Bad data';
3343: return (\%hash, $string);
3344: }
3345: } else {
3346: $string =~ s/^(.*?)=//;
3347: $key=&unescape($1);
3348: }
3349: $string =~ s/^=//;
3350:
3351: #value
3352: my $value='';
3353: if($string =~ /^__HASH_REF__/) {
3354: ($value, $string)=&str2hashref($string);
3355: if(defined($value->{'error'})) {
3356: $hash{'error'}='Bad data';
3357: return (\%hash, $string);
3358: }
3359: } elsif($string =~ /^__ARRAY_REF__/) {
3360: ($value, $string)=&str2arrayref($string);
3361: if($value->[0] eq 'Array reference error') {
3362: $hash{'error'}='Bad data';
3363: return (\%hash, $string);
3364: }
3365: } else {
3366: $value=&get_scalar(\$string,'__END_HASH_REF__');
3367: }
3368: $string =~ s/^&//;
3369:
3370: $hash{$key}=$value;
3371: }
3372:
3373: $string =~ s/^__END_HASH_REF__//;
3374:
3375: return (\%hash, $string);
3376: }
3377:
3378: sub str2array {
3379: my ($string)=@_;
3380: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3381: return @$array;
3382: }
3383:
3384: sub str2arrayref {
3385: my ($string) = @_;
3386: my @array;
3387:
3388: if($string !~ /^__ARRAY_REF__/) {
3389: if (! ($string eq '' || !defined($string))) {
3390: $array[0]='Array reference error';
3391: }
3392: return (\@array, $string);
3393: }
3394:
3395: $string =~ s/^__ARRAY_REF__//;
3396:
3397: while($string !~ /^__END_ARRAY_REF__/) {
3398: my $value='';
3399: if($string =~ /^__HASH_REF__/) {
3400: ($value, $string)=&str2hashref($string);
3401: if(defined($value->{'error'})) {
3402: $array[0] ='Array reference error';
3403: return (\@array, $string);
3404: }
3405: } elsif($string =~ /^__ARRAY_REF__/) {
3406: ($value, $string)=&str2arrayref($string);
3407: if($value->[0] eq 'Array reference error') {
3408: $array[0] ='Array reference error';
3409: return (\@array, $string);
3410: }
3411: } else {
3412: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3413: }
3414: $string =~ s/^&//;
3415:
3416: push(@array, $value);
3417: }
3418:
3419: $string =~ s/^__END_ARRAY_REF__//;
3420:
3421: return (\@array, $string);
3422: }
3423:
3424: # -------------------------------------------------------------------Temp Store
3425:
3426: sub tmpreset {
3427: my ($symb,$namespace,$domain,$stuname) = @_;
3428: if (!$symb) {
3429: $symb=&symbread();
3430: if (!$symb) { $symb= $env{'request.url'}; }
3431: }
3432: $symb=escape($symb);
3433:
3434: if (!$namespace) { $namespace=$env{'request.state'}; }
3435: $namespace=~s/\//\_/g;
3436: $namespace=~s/\W//g;
3437:
3438: if (!$domain) { $domain=$env{'user.domain'}; }
3439: if (!$stuname) { $stuname=$env{'user.name'}; }
3440: if ($domain eq 'public' && $stuname eq 'public') {
3441: $stuname=$ENV{'REMOTE_ADDR'};
3442: }
3443: my $path=$perlvar{'lonDaemons'}.'/tmp';
3444: my %hash;
3445: if (tie(%hash,'GDBM_File',
3446: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3447: &GDBM_WRCREAT(),0640)) {
3448: foreach my $key (keys %hash) {
3449: if ($key=~ /:$symb/) {
3450: delete($hash{$key});
3451: }
3452: }
3453: }
3454: }
3455:
3456: sub tmpstore {
3457: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3458:
3459: if (!$symb) {
3460: $symb=&symbread();
3461: if (!$symb) { $symb= $env{'request.url'}; }
3462: }
3463: $symb=escape($symb);
3464:
3465: if (!$namespace) {
3466: # I don't think we would ever want to store this for a course.
3467: # it seems this will only be used if we don't have a course.
3468: #$namespace=$env{'request.course.id'};
3469: #if (!$namespace) {
3470: $namespace=$env{'request.state'};
3471: #}
3472: }
3473: $namespace=~s/\//\_/g;
3474: $namespace=~s/\W//g;
3475: if (!$domain) { $domain=$env{'user.domain'}; }
3476: if (!$stuname) { $stuname=$env{'user.name'}; }
3477: if ($domain eq 'public' && $stuname eq 'public') {
3478: $stuname=$ENV{'REMOTE_ADDR'};
3479: }
3480: my $now=time;
3481: my %hash;
3482: my $path=$perlvar{'lonDaemons'}.'/tmp';
3483: if (tie(%hash,'GDBM_File',
3484: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3485: &GDBM_WRCREAT(),0640)) {
3486: $hash{"version:$symb"}++;
3487: my $version=$hash{"version:$symb"};
3488: my $allkeys='';
3489: foreach my $key (keys(%$storehash)) {
3490: $allkeys.=$key.':';
3491: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3492: }
3493: $hash{"$version:$symb:timestamp"}=$now;
3494: $allkeys.='timestamp';
3495: $hash{"$version:keys:$symb"}=$allkeys;
3496: if (untie(%hash)) {
3497: return 'ok';
3498: } else {
3499: return "error:$!";
3500: }
3501: } else {
3502: return "error:$!";
3503: }
3504: }
3505:
3506: # -----------------------------------------------------------------Temp Restore
3507:
3508: sub tmprestore {
3509: my ($symb,$namespace,$domain,$stuname) = @_;
3510:
3511: if (!$symb) {
3512: $symb=&symbread();
3513: if (!$symb) { $symb= $env{'request.url'}; }
3514: }
3515: $symb=escape($symb);
3516:
3517: if (!$namespace) { $namespace=$env{'request.state'}; }
3518:
3519: if (!$domain) { $domain=$env{'user.domain'}; }
3520: if (!$stuname) { $stuname=$env{'user.name'}; }
3521: if ($domain eq 'public' && $stuname eq 'public') {
3522: $stuname=$ENV{'REMOTE_ADDR'};
3523: }
3524: my %returnhash;
3525: $namespace=~s/\//\_/g;
3526: $namespace=~s/\W//g;
3527: my %hash;
3528: my $path=$perlvar{'lonDaemons'}.'/tmp';
3529: if (tie(%hash,'GDBM_File',
3530: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3531: &GDBM_READER(),0640)) {
3532: my $version=$hash{"version:$symb"};
3533: $returnhash{'version'}=$version;
3534: my $scope;
3535: for ($scope=1;$scope<=$version;$scope++) {
3536: my $vkeys=$hash{"$scope:keys:$symb"};
3537: my @keys=split(/:/,$vkeys);
3538: my $key;
3539: $returnhash{"$scope:keys"}=$vkeys;
3540: foreach $key (@keys) {
3541: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3542: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3543: }
3544: }
3545: if (!(untie(%hash))) {
3546: return "error:$!";
3547: }
3548: } else {
3549: return "error:$!";
3550: }
3551: return %returnhash;
3552: }
3553:
3554: # ----------------------------------------------------------------------- Store
3555:
3556: sub store {
3557: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3558: my $home='';
3559:
3560: if ($stuname) { $home=&homeserver($stuname,$domain); }
3561:
3562: $symb=&symbclean($symb);
3563: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3564:
3565: if (!$domain) { $domain=$env{'user.domain'}; }
3566: if (!$stuname) { $stuname=$env{'user.name'}; }
3567:
3568: &devalidate($symb,$stuname,$domain);
3569:
3570: $symb=escape($symb);
3571: if (!$namespace) {
3572: unless ($namespace=$env{'request.course.id'}) {
3573: return '';
3574: }
3575: }
3576: if (!$home) { $home=$env{'user.home'}; }
3577:
3578: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3579: $$storehash{'host'}=$perlvar{'lonHostID'};
3580:
3581: my $namevalue='';
3582: foreach my $key (keys(%$storehash)) {
3583: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3584: }
3585: $namevalue=~s/\&$//;
3586: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3587: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3588: }
3589:
3590: # -------------------------------------------------------------- Critical Store
3591:
3592: sub cstore {
3593: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3594: my $home='';
3595:
3596: if ($stuname) { $home=&homeserver($stuname,$domain); }
3597:
3598: $symb=&symbclean($symb);
3599: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3600:
3601: if (!$domain) { $domain=$env{'user.domain'}; }
3602: if (!$stuname) { $stuname=$env{'user.name'}; }
3603:
3604: &devalidate($symb,$stuname,$domain);
3605:
3606: $symb=escape($symb);
3607: if (!$namespace) {
3608: unless ($namespace=$env{'request.course.id'}) {
3609: return '';
3610: }
3611: }
3612: if (!$home) { $home=$env{'user.home'}; }
3613:
3614: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3615: $$storehash{'host'}=$perlvar{'lonHostID'};
3616:
3617: my $namevalue='';
3618: foreach my $key (keys(%$storehash)) {
3619: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3620: }
3621: $namevalue=~s/\&$//;
3622: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3623: return critical
3624: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3625: }
3626:
3627: # --------------------------------------------------------------------- Restore
3628:
3629: sub restore {
3630: my ($symb,$namespace,$domain,$stuname) = @_;
3631: my $home='';
3632:
3633: if ($stuname) { $home=&homeserver($stuname,$domain); }
3634:
3635: if (!$symb) {
3636: unless ($symb=escape(&symbread())) { return ''; }
3637: } else {
3638: $symb=&escape(&symbclean($symb));
3639: }
3640: if (!$namespace) {
3641: unless ($namespace=$env{'request.course.id'}) {
3642: return '';
3643: }
3644: }
3645: if (!$domain) { $domain=$env{'user.domain'}; }
3646: if (!$stuname) { $stuname=$env{'user.name'}; }
3647: if (!$home) { $home=$env{'user.home'}; }
3648: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3649:
3650: my %returnhash=();
3651: foreach my $line (split(/\&/,$answer)) {
3652: my ($name,$value)=split(/\=/,$line);
3653: $returnhash{&unescape($name)}=&thaw_unescape($value);
3654: }
3655: my $version;
3656: for ($version=1;$version<=$returnhash{'version'};$version++) {
3657: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3658: $returnhash{$item}=$returnhash{$version.':'.$item};
3659: }
3660: }
3661: return %returnhash;
3662: }
3663:
3664: # ---------------------------------------------------------- Course Description
3665:
3666: sub coursedescription {
3667: my ($courseid,$args)=@_;
3668: $courseid=~s/^\///;
3669: $courseid=~s/\_/\//g;
3670: my ($cdomain,$cnum)=split(/\//,$courseid);
3671: my $chome=&homeserver($cnum,$cdomain);
3672: my $normalid=$cdomain.'_'.$cnum;
3673: # need to always cache even if we get errors otherwise we keep
3674: # trying and trying and trying to get the course description.
3675: my %envhash=();
3676: my %returnhash=();
3677:
3678: my $expiretime=600;
3679: if ($env{'request.course.id'} eq $normalid) {
3680: $expiretime=120;
3681: }
3682:
3683: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3684: if (!$args->{'freshen_cache'}
3685: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3686: foreach my $key (keys(%env)) {
3687: next if ($key !~ /^\Q$prefix\E(.*)/);
3688: my ($setting) = $1;
3689: $returnhash{$setting} = $env{$key};
3690: }
3691: return %returnhash;
3692: }
3693:
3694: # get the data agin
3695: if (!$args->{'one_time'}) {
3696: $envhash{'course.'.$normalid.'.last_cache'}=time;
3697: }
3698:
3699: if ($chome ne 'no_host') {
3700: %returnhash=&dump('environment',$cdomain,$cnum);
3701: if (!exists($returnhash{'con_lost'})) {
3702: $returnhash{'home'}= $chome;
3703: $returnhash{'domain'} = $cdomain;
3704: $returnhash{'num'} = $cnum;
3705: if (!defined($returnhash{'type'})) {
3706: $returnhash{'type'} = 'Course';
3707: }
3708: while (my ($name,$value) = each %returnhash) {
3709: $envhash{'course.'.$normalid.'.'.$name}=$value;
3710: }
3711: $returnhash{'url'}=&clutter($returnhash{'url'});
3712: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3713: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3714: $envhash{'course.'.$normalid.'.home'}=$chome;
3715: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3716: $envhash{'course.'.$normalid.'.num'}=$cnum;
3717: }
3718: }
3719: if (!$args->{'one_time'}) {
3720: &appenv(\%envhash);
3721: }
3722: return %returnhash;
3723: }
3724:
3725: # -------------------------------------------------See if a user is privileged
3726:
3727: sub privileged {
3728: my ($username,$domain)=@_;
3729: my $rolesdump=&reply("dump:$domain:$username:roles",
3730: &homeserver($username,$domain));
3731: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3732: my $now=time;
3733: if ($rolesdump ne '') {
3734: foreach my $entry (split(/&/,$rolesdump)) {
3735: if ($entry!~/^rolesdef_/) {
3736: my ($area,$role)=split(/=/,$entry);
3737: $area=~s/\_\w\w$//;
3738: my ($trole,$tend,$tstart)=split(/_/,$role);
3739: if (($trole eq 'dc') || ($trole eq 'su')) {
3740: my $active=1;
3741: if ($tend) {
3742: if ($tend<$now) { $active=0; }
3743: }
3744: if ($tstart) {
3745: if ($tstart>$now) { $active=0; }
3746: }
3747: if ($active) { return 1; }
3748: }
3749: }
3750: }
3751: }
3752: return 0;
3753: }
3754:
3755: # -------------------------------------------------------- Get user privileges
3756:
3757: sub rolesinit {
3758: my ($domain,$username,$authhost)=@_;
3759: my %userroles;
3760: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3761: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return \%userroles; }
3762: my %allroles=();
3763: my %allgroups=();
3764: my $now=time;
3765: %userroles = ('user.login.time' => $now);
3766: my $group_privs;
3767:
3768: if ($rolesdump ne '') {
3769: foreach my $entry (split(/&/,$rolesdump)) {
3770: if ($entry!~/^rolesdef_/) {
3771: my ($area,$role)=split(/=/,$entry);
3772: $area=~s/\_\w\w$//;
3773: my ($trole,$tend,$tstart,$group_privs);
3774: if ($role=~/^cr/) {
3775: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3776: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3777: ($tend,$tstart)=split('_',$trest);
3778: } else {
3779: $trole=$role;
3780: }
3781: } elsif ($role =~ m|^gr/|) {
3782: ($trole,$tend,$tstart) = split(/_/,$role);
3783: ($trole,$group_privs) = split(/\//,$trole);
3784: $group_privs = &unescape($group_privs);
3785: } else {
3786: ($trole,$tend,$tstart)=split(/_/,$role);
3787: }
3788: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3789: $username);
3790: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3791: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3792: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3793: if (($area ne '') && ($trole ne '')) {
3794: my $spec=$trole.'.'.$area;
3795: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3796: if ($trole =~ /^cr\//) {
3797: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3798: } elsif ($trole eq 'gr') {
3799: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3800: } else {
3801: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3802: }
3803: }
3804: }
3805: }
3806: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3807: $userroles{'user.adv'} = $adv;
3808: $userroles{'user.author'} = $author;
3809: $env{'user.adv'}=$adv;
3810: }
3811: return \%userroles;
3812: }
3813:
3814: sub set_arearole {
3815: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3816: # log the associated role with the area
3817: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3818: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3819: }
3820:
3821: sub custom_roleprivs {
3822: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3823: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3824: my $homsvr=homeserver($rauthor,$rdomain);
3825: if (&hostname($homsvr) ne '') {
3826: my ($rdummy,$roledef)=
3827: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3828: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3829: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3830: if (defined($syspriv)) {
3831: $$allroles{'cm./'}.=':'.$syspriv;
3832: $$allroles{$spec.'./'}.=':'.$syspriv;
3833: }
3834: if ($tdomain ne '') {
3835: if (defined($dompriv)) {
3836: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3837: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3838: }
3839: if (($trest ne '') && (defined($coursepriv))) {
3840: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3841: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3842: }
3843: }
3844: }
3845: }
3846: }
3847:
3848: sub group_roleprivs {
3849: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3850: my $access = 1;
3851: my $now = time;
3852: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3853: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3854: if ($access) {
3855: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3856: $$allgroups{$course}{$group} .=':'.$group_privs;
3857: }
3858: }
3859:
3860: sub standard_roleprivs {
3861: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3862: if (defined($pr{$trole.':s'})) {
3863: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3864: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3865: }
3866: if ($tdomain ne '') {
3867: if (defined($pr{$trole.':d'})) {
3868: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3869: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3870: }
3871: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3872: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3873: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3874: }
3875: }
3876: }
3877:
3878: sub set_userprivs {
3879: my ($userroles,$allroles,$allgroups) = @_;
3880: my $author=0;
3881: my $adv=0;
3882: my %grouproles = ();
3883: if (keys(%{$allgroups}) > 0) {
3884: foreach my $role (keys %{$allroles}) {
3885: my ($trole,$area,$sec,$extendedarea);
3886: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3887: $trole = $1;
3888: $area = $2;
3889: $sec = $3;
3890: $extendedarea = $area.$sec;
3891: if (exists($$allgroups{$area})) {
3892: foreach my $group (keys(%{$$allgroups{$area}})) {
3893: my $spec = $trole.'.'.$extendedarea;
3894: $grouproles{$spec.'.'.$area.'/'.$group} =
3895: $$allgroups{$area}{$group};
3896: }
3897: }
3898: }
3899: }
3900: }
3901: foreach my $group (keys(%grouproles)) {
3902: $$allroles{$group} = $grouproles{$group};
3903: }
3904: foreach my $role (keys(%{$allroles})) {
3905: my %thesepriv;
3906: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
3907: foreach my $item (split(/:/,$$allroles{$role})) {
3908: if ($item ne '') {
3909: my ($privilege,$restrictions)=split(/&/,$item);
3910: if ($restrictions eq '') {
3911: $thesepriv{$privilege}='F';
3912: } elsif ($thesepriv{$privilege} ne 'F') {
3913: $thesepriv{$privilege}.=$restrictions;
3914: }
3915: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3916: }
3917: }
3918: my $thesestr='';
3919: foreach my $priv (keys(%thesepriv)) {
3920: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3921: }
3922: $userroles->{'user.priv.'.$role} = $thesestr;
3923: }
3924: return ($author,$adv);
3925: }
3926:
3927: sub role_status {
3928: my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
3929: my @pwhere = ();
3930: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
3931: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
3932: unless (!defined($$role) || $$role eq '') {
3933: $$where=join('.',@pwhere);
3934: $$trolecode=$$role.'.'.$$where;
3935: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
3936: $$tstatus='is';
3937: if ($$tstart && $$tstart>$then) {
3938: $$tstatus='future';
3939: if ($$tstart<$now) { $$tstatus='will'; }
3940: }
3941: if ($$tend) {
3942: if ($$tend<$then) {
3943: $$tstatus='expired';
3944: } elsif ($$tend<$now) {
3945: $$tstatus='will_not';
3946: }
3947: }
3948: }
3949: }
3950: }
3951:
3952: sub check_adhoc_privs {
3953: my ($cdom,$cnum,$then,$now,$checkrole) = @_;
3954: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
3955: if ($env{$cckey}) {
3956: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
3957: &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
3958: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
3959: &set_adhoc_privileges($cdom,$cnum,$checkrole);
3960: }
3961: } else {
3962: &set_adhoc_privileges($cdom,$cnum,$checkrole);
3963: }
3964: }
3965:
3966: sub set_adhoc_privileges {
3967: # role can be cc or ca
3968: my ($dcdom,$pickedcourse,$role) = @_;
3969: my $area = '/'.$dcdom.'/'.$pickedcourse;
3970: my $spec = $role.'.'.$area;
3971: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
3972: $env{'user.name'});
3973: my %ccrole = ();
3974: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
3975: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
3976: &appenv(\%userroles,[$role,'cm']);
3977: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
3978: &appenv( {'request.role' => $spec,
3979: 'request.role.domain' => $dcdom,
3980: 'request.course.sec' => ''
3981: }
3982: );
3983: my $tadv=0;
3984: if (&allowed('adv') eq 'F') { $tadv=1; }
3985: &appenv({'request.role.adv' => $tadv});
3986: }
3987:
3988: # --------------------------------------------------------------- get interface
3989:
3990: sub get {
3991: my ($namespace,$storearr,$udomain,$uname)=@_;
3992: my $items='';
3993: foreach my $item (@$storearr) {
3994: $items.=&escape($item).'&';
3995: }
3996: $items=~s/\&$//;
3997: if (!$udomain) { $udomain=$env{'user.domain'}; }
3998: if (!$uname) { $uname=$env{'user.name'}; }
3999: my $uhome=&homeserver($uname,$udomain);
4000:
4001: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4002: my @pairs=split(/\&/,$rep);
4003: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4004: return @pairs;
4005: }
4006: my %returnhash=();
4007: my $i=0;
4008: foreach my $item (@$storearr) {
4009: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4010: $i++;
4011: }
4012: return %returnhash;
4013: }
4014:
4015: # --------------------------------------------------------------- del interface
4016:
4017: sub del {
4018: my ($namespace,$storearr,$udomain,$uname)=@_;
4019: my $items='';
4020: foreach my $item (@$storearr) {
4021: $items.=&escape($item).'&';
4022: }
4023:
4024: $items=~s/\&$//;
4025: if (!$udomain) { $udomain=$env{'user.domain'}; }
4026: if (!$uname) { $uname=$env{'user.name'}; }
4027: my $uhome=&homeserver($uname,$udomain);
4028: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4029: }
4030:
4031: # -------------------------------------------------------------- dump interface
4032:
4033: sub dump {
4034: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4035: if (!$udomain) { $udomain=$env{'user.domain'}; }
4036: if (!$uname) { $uname=$env{'user.name'}; }
4037: my $uhome=&homeserver($uname,$udomain);
4038: if ($regexp) {
4039: $regexp=&escape($regexp);
4040: } else {
4041: $regexp='.';
4042: }
4043: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4044: my @pairs=split(/\&/,$rep);
4045: my %returnhash=();
4046: foreach my $item (@pairs) {
4047: my ($key,$value)=split(/=/,$item,2);
4048: $key = &unescape($key);
4049: next if ($key =~ /^error: 2 /);
4050: $returnhash{$key}=&thaw_unescape($value);
4051: }
4052: return %returnhash;
4053: }
4054:
4055: # --------------------------------------------------------- dumpstore interface
4056:
4057: sub dumpstore {
4058: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4059: if (!$udomain) { $udomain=$env{'user.domain'}; }
4060: if (!$uname) { $uname=$env{'user.name'}; }
4061: my $uhome=&homeserver($uname,$udomain);
4062: if ($regexp) {
4063: $regexp=&escape($regexp);
4064: } else {
4065: $regexp='.';
4066: }
4067: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4068: my @pairs=split(/\&/,$rep);
4069: my %returnhash=();
4070: foreach my $item (@pairs) {
4071: my ($key,$value)=split(/=/,$item,2);
4072: next if ($key =~ /^error: 2 /);
4073: $returnhash{$key}=&thaw_unescape($value);
4074: }
4075: return %returnhash;
4076: }
4077:
4078: # -------------------------------------------------------------- keys interface
4079:
4080: sub getkeys {
4081: my ($namespace,$udomain,$uname)=@_;
4082: if (!$udomain) { $udomain=$env{'user.domain'}; }
4083: if (!$uname) { $uname=$env{'user.name'}; }
4084: my $uhome=&homeserver($uname,$udomain);
4085: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4086: my @keyarray=();
4087: foreach my $key (split(/\&/,$rep)) {
4088: next if ($key =~ /^error: 2 /);
4089: push(@keyarray,&unescape($key));
4090: }
4091: return @keyarray;
4092: }
4093:
4094: # --------------------------------------------------------------- currentdump
4095: sub currentdump {
4096: my ($courseid,$sdom,$sname)=@_;
4097: $courseid = $env{'request.course.id'} if (! defined($courseid));
4098: $sdom = $env{'user.domain'} if (! defined($sdom));
4099: $sname = $env{'user.name'} if (! defined($sname));
4100: my $uhome = &homeserver($sname,$sdom);
4101: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4102: return if ($rep =~ /^(error:|no_such_host)/);
4103: #
4104: my %returnhash=();
4105: #
4106: if ($rep eq "unknown_cmd") {
4107: # an old lond will not know currentdump
4108: # Do a dump and make it look like a currentdump
4109: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4110: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4111: my %hash = @tmp;
4112: @tmp=();
4113: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4114: } else {
4115: my @pairs=split(/\&/,$rep);
4116: foreach my $pair (@pairs) {
4117: my ($key,$value)=split(/=/,$pair,2);
4118: my ($symb,$param) = split(/:/,$key);
4119: $returnhash{&unescape($symb)}->{&unescape($param)} =
4120: &thaw_unescape($value);
4121: }
4122: }
4123: return %returnhash;
4124: }
4125:
4126: sub convert_dump_to_currentdump{
4127: my %hash = %{shift()};
4128: my %returnhash;
4129: # Code ripped from lond, essentially. The only difference
4130: # here is the unescaping done by lonnet::dump(). Conceivably
4131: # we might run in to problems with parameter names =~ /^v\./
4132: while (my ($key,$value) = each(%hash)) {
4133: my ($v,$symb,$param) = split(/:/,$key);
4134: $symb = &unescape($symb);
4135: $param = &unescape($param);
4136: next if ($v eq 'version' || $symb eq 'keys');
4137: next if (exists($returnhash{$symb}) &&
4138: exists($returnhash{$symb}->{$param}) &&
4139: $returnhash{$symb}->{'v.'.$param} > $v);
4140: $returnhash{$symb}->{$param}=$value;
4141: $returnhash{$symb}->{'v.'.$param}=$v;
4142: }
4143: #
4144: # Remove all of the keys in the hashes which keep track of
4145: # the version of the parameter.
4146: while (my ($symb,$param_hash) = each(%returnhash)) {
4147: # use a foreach because we are going to delete from the hash.
4148: foreach my $key (keys(%$param_hash)) {
4149: delete($param_hash->{$key}) if ($key =~ /^v\./);
4150: }
4151: }
4152: return \%returnhash;
4153: }
4154:
4155: # ------------------------------------------------------ critical inc interface
4156:
4157: sub cinc {
4158: return &inc(@_,'critical');
4159: }
4160:
4161: # --------------------------------------------------------------- inc interface
4162:
4163: sub inc {
4164: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4165: if (!$udomain) { $udomain=$env{'user.domain'}; }
4166: if (!$uname) { $uname=$env{'user.name'}; }
4167: my $uhome=&homeserver($uname,$udomain);
4168: my $items='';
4169: if (! ref($store)) {
4170: # got a single value, so use that instead
4171: $items = &escape($store).'=&';
4172: } elsif (ref($store) eq 'SCALAR') {
4173: $items = &escape($$store).'=&';
4174: } elsif (ref($store) eq 'ARRAY') {
4175: $items = join('=&',map {&escape($_);} @{$store});
4176: } elsif (ref($store) eq 'HASH') {
4177: while (my($key,$value) = each(%{$store})) {
4178: $items.= &escape($key).'='.&escape($value).'&';
4179: }
4180: }
4181: $items=~s/\&$//;
4182: if ($critical) {
4183: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4184: } else {
4185: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4186: }
4187: }
4188:
4189: # --------------------------------------------------------------- put interface
4190:
4191: sub put {
4192: my ($namespace,$storehash,$udomain,$uname)=@_;
4193: if (!$udomain) { $udomain=$env{'user.domain'}; }
4194: if (!$uname) { $uname=$env{'user.name'}; }
4195: my $uhome=&homeserver($uname,$udomain);
4196: my $items='';
4197: foreach my $item (keys(%$storehash)) {
4198: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4199: }
4200: $items=~s/\&$//;
4201: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4202: }
4203:
4204: # ------------------------------------------------------------ newput interface
4205:
4206: sub newput {
4207: my ($namespace,$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 $items='';
4212: foreach my $key (keys(%$storehash)) {
4213: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4214: }
4215: $items=~s/\&$//;
4216: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4217: }
4218:
4219: # --------------------------------------------------------- putstore interface
4220:
4221: sub putstore {
4222: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4223: if (!$udomain) { $udomain=$env{'user.domain'}; }
4224: if (!$uname) { $uname=$env{'user.name'}; }
4225: my $uhome=&homeserver($uname,$udomain);
4226: my $items='';
4227: foreach my $key (keys(%$storehash)) {
4228: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4229: }
4230: $items=~s/\&$//;
4231: my $esc_symb=&escape($symb);
4232: my $esc_v=&escape($version);
4233: my $reply =
4234: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4235: $uhome);
4236: if ($reply eq 'unknown_cmd') {
4237: # gfall back to way things use to be done
4238: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4239: $uname);
4240: }
4241: return $reply;
4242: }
4243:
4244: sub old_putstore {
4245: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4246: if (!$udomain) { $udomain=$env{'user.domain'}; }
4247: if (!$uname) { $uname=$env{'user.name'}; }
4248: my $uhome=&homeserver($uname,$udomain);
4249: my %newstorehash;
4250: foreach my $item (keys(%$storehash)) {
4251: my $key = $version.':'.&escape($symb).':'.$item;
4252: $newstorehash{$key} = $storehash->{$item};
4253: }
4254: my $items='';
4255: my %allitems = ();
4256: foreach my $item (keys(%newstorehash)) {
4257: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4258: my $key = $1.':keys:'.$2;
4259: $allitems{$key} .= $3.':';
4260: }
4261: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4262: }
4263: foreach my $item (keys(%allitems)) {
4264: $allitems{$item} =~ s/\:$//;
4265: $items.= $item.'='.$allitems{$item}.'&';
4266: }
4267: $items=~s/\&$//;
4268: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4269: }
4270:
4271: # ------------------------------------------------------ critical put interface
4272:
4273: sub cput {
4274: my ($namespace,$storehash,$udomain,$uname)=@_;
4275: if (!$udomain) { $udomain=$env{'user.domain'}; }
4276: if (!$uname) { $uname=$env{'user.name'}; }
4277: my $uhome=&homeserver($uname,$udomain);
4278: my $items='';
4279: foreach my $item (keys(%$storehash)) {
4280: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4281: }
4282: $items=~s/\&$//;
4283: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4284: }
4285:
4286: # -------------------------------------------------------------- eget interface
4287:
4288: sub eget {
4289: my ($namespace,$storearr,$udomain,$uname)=@_;
4290: my $items='';
4291: foreach my $item (@$storearr) {
4292: $items.=&escape($item).'&';
4293: }
4294: $items=~s/\&$//;
4295: if (!$udomain) { $udomain=$env{'user.domain'}; }
4296: if (!$uname) { $uname=$env{'user.name'}; }
4297: my $uhome=&homeserver($uname,$udomain);
4298: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4299: my @pairs=split(/\&/,$rep);
4300: my %returnhash=();
4301: my $i=0;
4302: foreach my $item (@$storearr) {
4303: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4304: $i++;
4305: }
4306: return %returnhash;
4307: }
4308:
4309: # ------------------------------------------------------------ tmpput interface
4310: sub tmpput {
4311: my ($storehash,$server,$context)=@_;
4312: my $items='';
4313: foreach my $item (keys(%$storehash)) {
4314: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4315: }
4316: $items=~s/\&$//;
4317: if (defined($context)) {
4318: $items .= ':'.&escape($context);
4319: }
4320: return &reply("tmpput:$items",$server);
4321: }
4322:
4323: # ------------------------------------------------------------ tmpget interface
4324: sub tmpget {
4325: my ($token,$server)=@_;
4326: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4327: my $rep=&reply("tmpget:$token",$server);
4328: my %returnhash;
4329: foreach my $item (split(/\&/,$rep)) {
4330: my ($key,$value)=split(/=/,$item);
4331: next if ($key =~ /^error: 2 /);
4332: $returnhash{&unescape($key)}=&thaw_unescape($value);
4333: }
4334: return %returnhash;
4335: }
4336:
4337: # ------------------------------------------------------------ tmpget interface
4338: sub tmpdel {
4339: my ($token,$server)=@_;
4340: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4341: return &reply("tmpdel:$token",$server);
4342: }
4343:
4344: # -------------------------------------------------- portfolio access checking
4345:
4346: sub portfolio_access {
4347: my ($requrl) = @_;
4348: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4349: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4350: if ($result) {
4351: my %setters;
4352: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4353: my ($startblock,$endblock) =
4354: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4355: if ($startblock && $endblock) {
4356: return 'B';
4357: }
4358: } else {
4359: my ($startblock,$endblock) =
4360: &Apache::loncommon::blockcheck(\%setters,'port');
4361: if ($startblock && $endblock) {
4362: return 'B';
4363: }
4364: }
4365: }
4366: if ($result eq 'ok') {
4367: return 'F';
4368: } elsif ($result =~ /^[^:]+:guest_/) {
4369: return 'A';
4370: }
4371: return '';
4372: }
4373:
4374: sub get_portfolio_access {
4375: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4376:
4377: if (!ref($access_hash)) {
4378: my $current_perms = &get_portfile_permissions($udom,$unum);
4379: my %access_controls = &get_access_controls($current_perms,$group,
4380: $file_name);
4381: $access_hash = $access_controls{$file_name};
4382: }
4383:
4384: my ($public,$guest,@domains,@users,@courses,@groups);
4385: my $now = time;
4386: if (ref($access_hash) eq 'HASH') {
4387: foreach my $key (keys(%{$access_hash})) {
4388: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4389: if ($start > $now) {
4390: next;
4391: }
4392: if ($end && $end<$now) {
4393: next;
4394: }
4395: if ($scope eq 'public') {
4396: $public = $key;
4397: last;
4398: } elsif ($scope eq 'guest') {
4399: $guest = $key;
4400: } elsif ($scope eq 'domains') {
4401: push(@domains,$key);
4402: } elsif ($scope eq 'users') {
4403: push(@users,$key);
4404: } elsif ($scope eq 'course') {
4405: push(@courses,$key);
4406: } elsif ($scope eq 'group') {
4407: push(@groups,$key);
4408: }
4409: }
4410: if ($public) {
4411: return 'ok';
4412: }
4413: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4414: if ($guest) {
4415: return $guest;
4416: }
4417: } else {
4418: if (@domains > 0) {
4419: foreach my $domkey (@domains) {
4420: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4421: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4422: return 'ok';
4423: }
4424: }
4425: }
4426: }
4427: if (@users > 0) {
4428: foreach my $userkey (@users) {
4429: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4430: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4431: if (ref($item) eq 'HASH') {
4432: if (($item->{'uname'} eq $env{'user.name'}) &&
4433: ($item->{'udom'} eq $env{'user.domain'})) {
4434: return 'ok';
4435: }
4436: }
4437: }
4438: }
4439: }
4440: }
4441: my %roleshash;
4442: my @courses_and_groups = @courses;
4443: push(@courses_and_groups,@groups);
4444: if (@courses_and_groups > 0) {
4445: my (%allgroups,%allroles);
4446: my ($start,$end,$role,$sec,$group);
4447: foreach my $envkey (%env) {
4448: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4449: my $cid = $2.'_'.$3;
4450: if ($1 eq 'gr') {
4451: $group = $4;
4452: $allgroups{$cid}{$group} = $env{$envkey};
4453: } else {
4454: if ($4 eq '') {
4455: $sec = 'none';
4456: } else {
4457: $sec = $4;
4458: }
4459: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4460: }
4461: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4462: my $cid = $2.'_'.$3;
4463: if ($4 eq '') {
4464: $sec = 'none';
4465: } else {
4466: $sec = $4;
4467: }
4468: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4469: }
4470: }
4471: if (keys(%allroles) == 0) {
4472: return;
4473: }
4474: foreach my $key (@courses_and_groups) {
4475: my %content = %{$$access_hash{$key}};
4476: my $cnum = $content{'number'};
4477: my $cdom = $content{'domain'};
4478: my $cid = $cdom.'_'.$cnum;
4479: if (!exists($allroles{$cid})) {
4480: next;
4481: }
4482: foreach my $role_id (keys(%{$content{'roles'}})) {
4483: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4484: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4485: my @status = @{$content{'roles'}{$role_id}{'access'}};
4486: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4487: foreach my $role (keys(%{$allroles{$cid}})) {
4488: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4489: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4490: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4491: if (grep/^all$/,@sections) {
4492: return 'ok';
4493: } else {
4494: if (grep/^$sec$/,@sections) {
4495: return 'ok';
4496: }
4497: }
4498: }
4499: }
4500: if (keys(%{$allgroups{$cid}}) == 0) {
4501: if (grep/^none$/,@groups) {
4502: return 'ok';
4503: }
4504: } else {
4505: if (grep/^all$/,@groups) {
4506: return 'ok';
4507: }
4508: foreach my $group (keys(%{$allgroups{$cid}})) {
4509: if (grep/^$group$/,@groups) {
4510: return 'ok';
4511: }
4512: }
4513: }
4514: }
4515: }
4516: }
4517: }
4518: }
4519: if ($guest) {
4520: return $guest;
4521: }
4522: }
4523: }
4524: return;
4525: }
4526:
4527: sub course_group_datechecker {
4528: my ($dates,$now,$status) = @_;
4529: my ($start,$end) = split(/\./,$dates);
4530: if (!$start && !$end) {
4531: return 'ok';
4532: }
4533: if (grep/^active$/,@{$status}) {
4534: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4535: return 'ok';
4536: }
4537: }
4538: if (grep/^previous$/,@{$status}) {
4539: if ($end > $now ) {
4540: return 'ok';
4541: }
4542: }
4543: if (grep/^future$/,@{$status}) {
4544: if ($start > $now) {
4545: return 'ok';
4546: }
4547: }
4548: return;
4549: }
4550:
4551: sub parse_portfolio_url {
4552: my ($url) = @_;
4553:
4554: my ($type,$udom,$unum,$group,$file_name);
4555:
4556: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4557: $type = 1;
4558: $udom = $1;
4559: $unum = $2;
4560: $file_name = $3;
4561: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4562: $type = 2;
4563: $udom = $1;
4564: $unum = $2;
4565: $group = $3;
4566: $file_name = $3.'/'.$4;
4567: }
4568: if (wantarray) {
4569: return ($type,$udom,$unum,$file_name,$group);
4570: }
4571: return $type;
4572: }
4573:
4574: sub is_portfolio_url {
4575: my ($url) = @_;
4576: return scalar(&parse_portfolio_url($url));
4577: }
4578:
4579: sub is_portfolio_file {
4580: my ($file) = @_;
4581: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4582: return 1;
4583: }
4584: return;
4585: }
4586:
4587: sub usertools_access {
4588: my ($uname,$udom,$tool,$action,$context) = @_;
4589: my ($access,%tools);
4590: if ($context eq '') {
4591: $context = 'tools';
4592: }
4593: if ($context eq 'requestcourses') {
4594: %tools = (
4595: official => 1,
4596: unofficial => 1,
4597: );
4598: } else {
4599: %tools = (
4600: aboutme => 1,
4601: blog => 1,
4602: portfolio => 1,
4603: );
4604: }
4605: return if (!defined($tools{$tool}));
4606:
4607: if ((!defined($udom)) || (!defined($uname))) {
4608: $udom = $env{'user.domain'};
4609: $uname = $env{'user.name'};
4610: }
4611:
4612: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4613: if ($action ne 'reload') {
4614: if ($context eq 'requestcourses') {
4615: return $env{'environment.canrequest.'.$tool};
4616: } else {
4617: return $env{'environment.availabletools.'.$tool};
4618: }
4619: }
4620: }
4621:
4622: my ($toolstatus,$inststatus);
4623:
4624: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4625: ($action ne 'reload')) {
4626: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4627: $inststatus = $env{'environment.inststatus'};
4628: } else {
4629: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool);
4630: $toolstatus = $userenv{$context.'.'.$tool};
4631: $inststatus = $userenv{'inststatus'};
4632: }
4633:
4634: if ($toolstatus ne '') {
4635: if ($toolstatus) {
4636: $access = 1;
4637: } else {
4638: $access = 0;
4639: }
4640: return $access;
4641: }
4642:
4643: my $is_adv = &is_advanced_user($udom,$uname);
4644: my %domdef = &get_domain_defaults($udom);
4645: if (ref($domdef{$tool}) eq 'HASH') {
4646: if ($is_adv) {
4647: if ($domdef{$tool}{'_LC_adv'} ne '') {
4648: if ($domdef{$tool}{'_LC_adv'}) {
4649: $access = 1;
4650: } else {
4651: $access = 0;
4652: }
4653: return $access;
4654: }
4655: }
4656: if ($inststatus ne '') {
4657: my ($hasaccess,$hasnoaccess);
4658: foreach my $affiliation (split(/:/,$inststatus)) {
4659: if ($domdef{$tool}{$affiliation} ne '') {
4660: if ($domdef{$tool}{$affiliation}) {
4661: $hasaccess = 1;
4662: } else {
4663: $hasnoaccess = 1;
4664: }
4665: }
4666: }
4667: if ($hasaccess || $hasnoaccess) {
4668: if ($hasaccess) {
4669: $access = 1;
4670: } elsif ($hasnoaccess) {
4671: $access = 0;
4672: }
4673: return $access;
4674: }
4675: } else {
4676: if ($domdef{$tool}{'default'} ne '') {
4677: if ($domdef{$tool}{'default'}) {
4678: $access = 1;
4679: } elsif ($domdef{$tool}{'default'} == 0) {
4680: $access = 0;
4681: }
4682: return $access;
4683: }
4684: }
4685: } else {
4686: if ($context eq 'tools') {
4687: $access = 1;
4688: } else {
4689: $access = 0;
4690: }
4691: return $access;
4692: }
4693: }
4694:
4695: sub is_advanced_user {
4696: my ($udom,$uname) = @_;
4697: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4698: my %allroles;
4699: my $is_adv;
4700: foreach my $role (keys(%roleshash)) {
4701: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4702: my $area = '/'.$tdomain.'/'.$trest;
4703: if ($sec ne '') {
4704: $area .= '/'.$sec;
4705: }
4706: if (($area ne '') && ($trole ne '')) {
4707: my $spec=$trole.'.'.$area;
4708: if ($trole =~ /^cr\//) {
4709: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4710: } elsif ($trole ne 'gr') {
4711: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4712: }
4713: }
4714: }
4715: foreach my $role (keys(%allroles)) {
4716: last if ($is_adv);
4717: foreach my $item (split(/:/,$allroles{$role})) {
4718: if ($item ne '') {
4719: my ($privilege,$restrictions)=split(/&/,$item);
4720: if ($privilege eq 'adv') {
4721: $is_adv = 1;
4722: last;
4723: }
4724: }
4725: }
4726: }
4727: return $is_adv;
4728: }
4729:
4730: # ---------------------------------------------- Custom access rule evaluation
4731:
4732: sub customaccess {
4733: my ($priv,$uri)=@_;
4734: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4735: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4736: $udom = &LONCAPA::clean_domain($udom);
4737: $ucrs = &LONCAPA::clean_username($ucrs);
4738: my $access=0;
4739: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4740: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4741: if ($type eq 'user') {
4742: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4743: my ($tdom,$tuname)=split(m{/},$scope);
4744: if ($tdom) {
4745: if ($tdom ne $env{'user.domain'}) { next; }
4746: }
4747: if ($tuname) {
4748: if ($tuname ne $env{'user.name'}) { next; }
4749: }
4750: $access=($effect eq 'allow');
4751: last;
4752: }
4753: } else {
4754: if ($role) {
4755: if ($role ne $urole) { next; }
4756: }
4757: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4758: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4759: if ($tdom) {
4760: if ($tdom ne $udom) { next; }
4761: }
4762: if ($tcrs) {
4763: if ($tcrs ne $ucrs) { next; }
4764: }
4765: if ($tsec) {
4766: if ($tsec ne $usec) { next; }
4767: }
4768: $access=($effect eq 'allow');
4769: last;
4770: }
4771: if ($realm eq '' && $role eq '') {
4772: $access=($effect eq 'allow');
4773: }
4774: }
4775: }
4776: return $access;
4777: }
4778:
4779: # ------------------------------------------------- Check for a user privilege
4780:
4781: sub allowed {
4782: my ($priv,$uri,$symb,$role)=@_;
4783: my $ver_orguri=$uri;
4784: $uri=&deversion($uri);
4785: my $orguri=$uri;
4786: $uri=&declutter($uri);
4787:
4788: if ($priv eq 'evb') {
4789: # Evade communication block restrictions for specified role in a course
4790: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4791: return $1;
4792: } else {
4793: return;
4794: }
4795: }
4796:
4797: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4798: # Free bre access to adm and meta resources
4799: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4800: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4801: && ($priv eq 'bre')) {
4802: return 'F';
4803: }
4804:
4805: # Free bre access to user's own portfolio contents
4806: my ($space,$domain,$name,@dir)=split('/',$uri);
4807: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4808: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4809: my %setters;
4810: my ($startblock,$endblock) =
4811: &Apache::loncommon::blockcheck(\%setters,'port');
4812: if ($startblock && $endblock) {
4813: return 'B';
4814: } else {
4815: return 'F';
4816: }
4817: }
4818:
4819: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
4820: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4821: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4822: if (exists($env{'request.course.id'})) {
4823: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4824: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4825: if (($domain eq $cdom) && ($name eq $cnum)) {
4826: my $courseprivid=$env{'request.course.id'};
4827: $courseprivid=~s/\_/\//;
4828: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4829: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4830: return $1;
4831: } else {
4832: if ($env{'request.course.sec'}) {
4833: $courseprivid.='/'.$env{'request.course.sec'};
4834: }
4835: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4836: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
4837: return $2;
4838: }
4839: }
4840: }
4841: }
4842: }
4843:
4844: # Free bre to public access
4845:
4846: if ($priv eq 'bre') {
4847: my $copyright=&metadata($uri,'copyright');
4848: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
4849: return 'F';
4850: }
4851: if ($copyright eq 'priv') {
4852: $uri=~/([^\/]+)\/([^\/]+)\//;
4853: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
4854: return '';
4855: }
4856: }
4857: if ($copyright eq 'domain') {
4858: $uri=~/([^\/]+)\/([^\/]+)\//;
4859: unless (($env{'user.domain'} eq $1) ||
4860: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
4861: return '';
4862: }
4863: }
4864: if ($env{'request.role'}=~ /li\.\//) {
4865: # Library role, so allow browsing of resources in this domain.
4866: return 'F';
4867: }
4868: if ($copyright eq 'custom') {
4869: unless (&customaccess($priv,$uri)) { return ''; }
4870: }
4871: }
4872: # Domain coordinator is trying to create a course
4873: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
4874: # uri is the requested domain in this case.
4875: # comparison to 'request.role.domain' shows if the user has selected
4876: # a role of dc for the domain in question.
4877: return 'F' if ($uri eq $env{'request.role.domain'});
4878: }
4879:
4880: my $thisallowed='';
4881: my $statecond=0;
4882: my $courseprivid='';
4883:
4884: # Course
4885:
4886: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
4887: $thisallowed.=$1;
4888: }
4889:
4890: # Domain
4891:
4892: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
4893: =~/\Q$priv\E\&([^\:]*)/) {
4894: $thisallowed.=$1;
4895: }
4896:
4897: # Course: uri itself is a course
4898: my $courseuri=$uri;
4899: $courseuri=~s/\_(\d)/\/$1/;
4900: $courseuri=~s/^([^\/])/\/$1/;
4901:
4902: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
4903: =~/\Q$priv\E\&([^\:]*)/) {
4904: $thisallowed.=$1;
4905: }
4906:
4907: # URI is an uploaded document for this course, default permissions don't matter
4908: # not allowing 'edit' access (editupload) to uploaded course docs
4909: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
4910: $thisallowed='';
4911: my ($match)=&is_on_map($uri);
4912: if ($match) {
4913: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4914: =~/\Q$priv\E\&([^\:]*)/) {
4915: $thisallowed.=$1;
4916: }
4917: } else {
4918: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
4919: if ($refuri) {
4920: if ($refuri =~ m|^/adm/|) {
4921: $thisallowed='F';
4922: } else {
4923: $refuri=&declutter($refuri);
4924: my ($match) = &is_on_map($refuri);
4925: if ($match) {
4926: $thisallowed='F';
4927: }
4928: }
4929: }
4930: }
4931: }
4932:
4933: if ($priv eq 'bre'
4934: && $thisallowed ne 'F'
4935: && $thisallowed ne '2'
4936: && &is_portfolio_url($uri)) {
4937: $thisallowed = &portfolio_access($uri);
4938: }
4939:
4940: # Full access at system, domain or course-wide level? Exit.
4941: if ($thisallowed=~/F/) {
4942: return 'F';
4943: }
4944:
4945: # If this is generating or modifying users, exit with special codes
4946:
4947: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4948: if (($priv eq 'cca') || ($priv eq 'caa')) {
4949: my ($audom,$auname)=split('/',$uri);
4950: # no author name given, so this just checks on the general right to make a co-author in this domain
4951: unless ($auname) { return $thisallowed; }
4952: # an author name is given, so we are about to actually make a co-author for a certain account
4953: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4954: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4955: ($audom ne $env{'request.role.domain'}))) { return ''; }
4956: }
4957: return $thisallowed;
4958: }
4959: #
4960: # Gathered so far: system, domain and course wide privileges
4961: #
4962: # Course: See if uri or referer is an individual resource that is part of
4963: # the course
4964:
4965: if ($env{'request.course.id'}) {
4966:
4967: $courseprivid=$env{'request.course.id'};
4968: if ($env{'request.course.sec'}) {
4969: $courseprivid.='/'.$env{'request.course.sec'};
4970: }
4971: $courseprivid=~s/\_/\//;
4972: my $checkreferer=1;
4973: my ($match,$cond)=&is_on_map($uri);
4974: if ($match) {
4975: $statecond=$cond;
4976: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4977: =~/\Q$priv\E\&([^\:]*)/) {
4978: $thisallowed.=$1;
4979: $checkreferer=0;
4980: }
4981: }
4982:
4983: if ($checkreferer) {
4984: my $refuri=$env{'httpref.'.$orguri};
4985: unless ($refuri) {
4986: foreach my $key (keys(%env)) {
4987: if ($key=~/^httpref\..*\*/) {
4988: my $pattern=$key;
4989: $pattern=~s/^httpref\.\/res\///;
4990: $pattern=~s/\*/\[\^\/\]\+/g;
4991: $pattern=~s/\//\\\//g;
4992: if ($orguri=~/$pattern/) {
4993: $refuri=$env{$key};
4994: }
4995: }
4996: }
4997: }
4998:
4999: if ($refuri) {
5000: $refuri=&declutter($refuri);
5001: my ($match,$cond)=&is_on_map($refuri);
5002: if ($match) {
5003: my $refstatecond=$cond;
5004: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5005: =~/\Q$priv\E\&([^\:]*)/) {
5006: $thisallowed.=$1;
5007: $uri=$refuri;
5008: $statecond=$refstatecond;
5009: }
5010: }
5011: }
5012: }
5013: }
5014:
5015: #
5016: # Gathered now: all privileges that could apply, and condition number
5017: #
5018: #
5019: # Full or no access?
5020: #
5021:
5022: if ($thisallowed=~/F/) {
5023: return 'F';
5024: }
5025:
5026: unless ($thisallowed) {
5027: return '';
5028: }
5029:
5030: # Restrictions exist, deal with them
5031: #
5032: # C:according to course preferences
5033: # R:according to resource settings
5034: # L:unless locked
5035: # X:according to user session state
5036: #
5037:
5038: # Possibly locked functionality, check all courses
5039: # Locks might take effect only after 10 minutes cache expiration for other
5040: # courses, and 2 minutes for current course
5041:
5042: my $envkey;
5043: if ($thisallowed=~/L/) {
5044: foreach $envkey (keys %env) {
5045: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5046: my $courseid=$2;
5047: my $roleid=$1.'.'.$2;
5048: $courseid=~s/^\///;
5049: my $expiretime=600;
5050: if ($env{'request.role'} eq $roleid) {
5051: $expiretime=120;
5052: }
5053: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5054: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5055: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5056: &coursedescription($courseid,{'freshen_cache' => 1});
5057: }
5058: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5059: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5060: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5061: &log($env{'user.domain'},$env{'user.name'},
5062: $env{'user.home'},
5063: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5064: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5065: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5066: return '';
5067: }
5068: }
5069: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5070: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5071: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5072: &log($env{'user.domain'},$env{'user.name'},
5073: $env{'user.home'},
5074: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5075: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5076: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5077: return '';
5078: }
5079: }
5080: }
5081: }
5082: }
5083:
5084: #
5085: # Rest of the restrictions depend on selected course
5086: #
5087:
5088: unless ($env{'request.course.id'}) {
5089: if ($thisallowed eq 'A') {
5090: return 'A';
5091: } elsif ($thisallowed eq 'B') {
5092: return 'B';
5093: } else {
5094: return '1';
5095: }
5096: }
5097:
5098: #
5099: # Now user is definitely in a course
5100: #
5101:
5102:
5103: # Course preferences
5104:
5105: if ($thisallowed=~/C/) {
5106: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5107: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5108: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5109: =~/\Q$rolecode\E/) {
5110: if ($priv ne 'pch') {
5111: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5112: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5113: $env{'request.course.id'});
5114: }
5115: return '';
5116: }
5117:
5118: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5119: =~/\Q$unamedom\E/) {
5120: if ($priv ne 'pch') {
5121: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5122: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5123: $env{'request.course.id'});
5124: }
5125: return '';
5126: }
5127: }
5128:
5129: # Resource preferences
5130:
5131: if ($thisallowed=~/R/) {
5132: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5133: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5134: if ($priv ne 'pch') {
5135: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5136: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5137: }
5138: return '';
5139: }
5140: }
5141:
5142: # Restricted by state or randomout?
5143:
5144: if ($thisallowed=~/X/) {
5145: if ($env{'acc.randomout'}) {
5146: if (!$symb) { $symb=&symbread($uri,1); }
5147: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5148: return '';
5149: }
5150: }
5151: if (&condval($statecond)) {
5152: return '2';
5153: } else {
5154: return '';
5155: }
5156: }
5157:
5158: if ($thisallowed eq 'A') {
5159: return 'A';
5160: } elsif ($thisallowed eq 'B') {
5161: return 'B';
5162: }
5163: return 'F';
5164: }
5165:
5166: sub split_uri_for_cond {
5167: my $uri=&deversion(&declutter(shift));
5168: my @uriparts=split(/\//,$uri);
5169: my $filename=pop(@uriparts);
5170: my $pathname=join('/',@uriparts);
5171: return ($pathname,$filename);
5172: }
5173: # --------------------------------------------------- Is a resource on the map?
5174:
5175: sub is_on_map {
5176: my ($pathname,$filename) = &split_uri_for_cond(shift);
5177: #Trying to find the conditional for the file
5178: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5179: /\&\Q$filename\E\:([\d\|]+)\&/);
5180: if ($match) {
5181: return (1,$1);
5182: } else {
5183: return (0,0);
5184: }
5185: }
5186:
5187: # --------------------------------------------------------- Get symb from alias
5188:
5189: sub get_symb_from_alias {
5190: my $symb=shift;
5191: my ($map,$resid,$url)=&decode_symb($symb);
5192: # Already is a symb
5193: if ($url) { return $symb; }
5194: # Must be an alias
5195: my $aliassymb='';
5196: my %bighash;
5197: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5198: &GDBM_READER(),0640)) {
5199: my $rid=$bighash{'mapalias_'.$symb};
5200: if ($rid) {
5201: my ($mapid,$resid)=split(/\./,$rid);
5202: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5203: $resid,$bighash{'src_'.$rid});
5204: }
5205: untie %bighash;
5206: }
5207: return $aliassymb;
5208: }
5209:
5210: # ----------------------------------------------------------------- Define Role
5211:
5212: sub definerole {
5213: if (allowed('mcr','/')) {
5214: my ($rolename,$sysrole,$domrole,$courole)=@_;
5215: foreach my $role (split(':',$sysrole)) {
5216: my ($crole,$cqual)=split(/\&/,$role);
5217: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5218: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5219: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5220: return "refused:s:$crole&$cqual";
5221: }
5222: }
5223: }
5224: foreach my $role (split(':',$domrole)) {
5225: my ($crole,$cqual)=split(/\&/,$role);
5226: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5227: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5228: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5229: return "refused:d:$crole&$cqual";
5230: }
5231: }
5232: }
5233: foreach my $role (split(':',$courole)) {
5234: my ($crole,$cqual)=split(/\&/,$role);
5235: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5236: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5237: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5238: return "refused:c:$crole&$cqual";
5239: }
5240: }
5241: }
5242: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5243: "$env{'user.domain'}:$env{'user.name'}:".
5244: "rolesdef_$rolename=".
5245: escape($sysrole.'_'.$domrole.'_'.$courole);
5246: return reply($command,$env{'user.home'});
5247: } else {
5248: return 'refused';
5249: }
5250: }
5251:
5252: # ---------------- Make a metadata query against the network of library servers
5253:
5254: sub metadata_query {
5255: my ($query,$custom,$customshow,$server_array)=@_;
5256: my %rhash;
5257: my %libserv = &all_library();
5258: my @server_list = (defined($server_array) ? @$server_array
5259: : keys(%libserv) );
5260: for my $server (@server_list) {
5261: unless ($custom or $customshow) {
5262: my $reply=&reply("querysend:".&escape($query),$server);
5263: $rhash{$server}=$reply;
5264: }
5265: else {
5266: my $reply=&reply("querysend:".&escape($query).':'.
5267: &escape($custom).':'.&escape($customshow),
5268: $server);
5269: $rhash{$server}=$reply;
5270: }
5271: }
5272: return \%rhash;
5273: }
5274:
5275: # ----------------------------------------- Send log queries and wait for reply
5276:
5277: sub log_query {
5278: my ($uname,$udom,$query,%filters)=@_;
5279: my $uhome=&homeserver($uname,$udom);
5280: if ($uhome eq 'no_host') { return 'error: no_host'; }
5281: my $uhost=&hostname($uhome);
5282: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5283: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5284: $uhome);
5285: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5286: return get_query_reply($queryid);
5287: }
5288:
5289: # -------------------------- Update MySQL table for portfolio file
5290:
5291: sub update_portfolio_table {
5292: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5293: if ($group ne '') {
5294: $file_name =~s /^\Q$group\E//;
5295: }
5296: my $homeserver = &homeserver($uname,$udom);
5297: my $queryid=
5298: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5299: ':'.&escape($file_name).':'.$action,$homeserver);
5300: my $reply = &get_query_reply($queryid);
5301: return $reply;
5302: }
5303:
5304: # -------------------------- Update MySQL allusers table
5305:
5306: sub update_allusers_table {
5307: my ($uname,$udom,$names) = @_;
5308: my $homeserver = &homeserver($uname,$udom);
5309: my $queryid=
5310: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5311: 'lastname='.&escape($names->{'lastname'}).'%%'.
5312: 'firstname='.&escape($names->{'firstname'}).'%%'.
5313: 'middlename='.&escape($names->{'middlename'}).'%%'.
5314: 'generation='.&escape($names->{'generation'}).'%%'.
5315: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5316: 'id='.&escape($names->{'id'}),$homeserver);
5317: my $reply = &get_query_reply($queryid);
5318: return $reply;
5319: }
5320:
5321: # ------- Request retrieval of institutional classlists for course(s)
5322:
5323: sub fetch_enrollment_query {
5324: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5325: my $homeserver;
5326: my $maxtries = 1;
5327: if ($context eq 'automated') {
5328: $homeserver = $perlvar{'lonHostID'};
5329: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5330: } else {
5331: $homeserver = &homeserver($cnum,$dom);
5332: }
5333: my $host=&hostname($homeserver);
5334: my $cmd = '';
5335: foreach my $affiliate (keys %{$affiliatesref}) {
5336: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5337: }
5338: $cmd =~ s/%%$//;
5339: $cmd = &escape($cmd);
5340: my $query = 'fetchenrollment';
5341: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5342: unless ($queryid=~/^\Q$host\E\_/) {
5343: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5344: return 'error: '.$queryid;
5345: }
5346: my $reply = &get_query_reply($queryid);
5347: my $tries = 1;
5348: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5349: $reply = &get_query_reply($queryid);
5350: $tries ++;
5351: }
5352: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5353: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5354: } else {
5355: my @responses = split(/:/,$reply);
5356: if ($homeserver eq $perlvar{'lonHostID'}) {
5357: foreach my $line (@responses) {
5358: my ($key,$value) = split(/=/,$line,2);
5359: $$replyref{$key} = $value;
5360: }
5361: } else {
5362: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5363: foreach my $line (@responses) {
5364: my ($key,$value) = split(/=/,$line);
5365: $$replyref{$key} = $value;
5366: if ($value > 0) {
5367: foreach my $item (@{$$affiliatesref{$key}}) {
5368: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5369: my $destname = $pathname.'/'.$filename;
5370: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5371: if ($xml_classlist =~ /^error/) {
5372: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5373: } else {
5374: if ( open(FILE,">$destname") ) {
5375: print FILE &unescape($xml_classlist);
5376: close(FILE);
5377: } else {
5378: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5379: }
5380: }
5381: }
5382: }
5383: }
5384: }
5385: return 'ok';
5386: }
5387: return 'error';
5388: }
5389:
5390: sub get_query_reply {
5391: my $queryid=shift;
5392: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5393: my $reply='';
5394: for (1..100) {
5395: sleep 2;
5396: if (-e $replyfile.'.end') {
5397: if (open(my $fh,$replyfile)) {
5398: $reply = join('',<$fh>);
5399: close($fh);
5400: } else { return 'error: reply_file_error'; }
5401: return &unescape($reply);
5402: }
5403: }
5404: return 'timeout:'.$queryid;
5405: }
5406:
5407: sub courselog_query {
5408: #
5409: # possible filters:
5410: # url: url or symb
5411: # username
5412: # domain
5413: # action: view, submit, grade
5414: # start: timestamp
5415: # end: timestamp
5416: #
5417: my (%filters)=@_;
5418: unless ($env{'request.course.id'}) { return 'no_course'; }
5419: if ($filters{'url'}) {
5420: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5421: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5422: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5423: }
5424: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5425: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5426: return &log_query($cname,$cdom,'courselog',%filters);
5427: }
5428:
5429: sub userlog_query {
5430: #
5431: # possible filters:
5432: # action: log check role
5433: # start: timestamp
5434: # end: timestamp
5435: #
5436: my ($uname,$udom,%filters)=@_;
5437: return &log_query($uname,$udom,'userlog',%filters);
5438: }
5439:
5440: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5441:
5442: sub auto_run {
5443: my ($cnum,$cdom) = @_;
5444: my $response = 0;
5445: my $settings;
5446: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5447: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5448: $settings = $domconfig{'autoenroll'};
5449: if ($settings->{'run'} eq '1') {
5450: $response = 1;
5451: }
5452: } else {
5453: my $homeserver;
5454: if (&is_course($cdom,$cnum)) {
5455: $homeserver = &homeserver($cnum,$cdom);
5456: } else {
5457: $homeserver = &domain($cdom,'primary');
5458: }
5459: if ($homeserver ne 'no_host') {
5460: $response = &reply('autorun:'.$cdom,$homeserver);
5461: }
5462: }
5463: return $response;
5464: }
5465:
5466: sub auto_get_sections {
5467: my ($cnum,$cdom,$inst_coursecode) = @_;
5468: my $homeserver = &homeserver($cnum,$cdom);
5469: my @secs = ();
5470: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5471: unless ($response eq 'refused') {
5472: @secs = split(/:/,$response);
5473: }
5474: return @secs;
5475: }
5476:
5477: sub auto_new_course {
5478: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5479: my $homeserver = &homeserver($cnum,$cdom);
5480: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5481: return $response;
5482: }
5483:
5484: sub auto_validate_courseID {
5485: my ($cnum,$cdom,$inst_course_id) = @_;
5486: my $homeserver = &homeserver($cnum,$cdom);
5487: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5488: return $response;
5489: }
5490:
5491: sub auto_create_password {
5492: my ($cnum,$cdom,$authparam,$udom) = @_;
5493: my ($homeserver,$response);
5494: my $create_passwd = 0;
5495: my $authchk = '';
5496: if ($udom =~ /^$match_domain$/) {
5497: $homeserver = &domain($udom,'primary');
5498: }
5499: if ($homeserver eq '') {
5500: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5501: $homeserver = &homeserver($cnum,$cdom);
5502: }
5503: }
5504: if ($homeserver eq '') {
5505: $authchk = 'nodomain';
5506: } else {
5507: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5508: if ($response eq 'refused') {
5509: $authchk = 'refused';
5510: } else {
5511: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5512: }
5513: }
5514: return ($authparam,$create_passwd,$authchk);
5515: }
5516:
5517: sub auto_photo_permission {
5518: my ($cnum,$cdom,$students) = @_;
5519: my $homeserver = &homeserver($cnum,$cdom);
5520: my ($outcome,$perm_reqd,$conditions) =
5521: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5522: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5523: return (undef,undef);
5524: }
5525: return ($outcome,$perm_reqd,$conditions);
5526: }
5527:
5528: sub auto_checkphotos {
5529: my ($uname,$udom,$pid) = @_;
5530: my $homeserver = &homeserver($uname,$udom);
5531: my ($result,$resulttype);
5532: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5533: &escape($uname).':'.&escape($pid),
5534: $homeserver));
5535: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5536: return (undef,undef);
5537: }
5538: if ($outcome) {
5539: ($result,$resulttype) = split(/:/,$outcome);
5540: }
5541: return ($result,$resulttype);
5542: }
5543:
5544: sub auto_photochoice {
5545: my ($cnum,$cdom) = @_;
5546: my $homeserver = &homeserver($cnum,$cdom);
5547: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5548: &escape($cdom),
5549: $homeserver)));
5550: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5551: return (undef,undef);
5552: }
5553: return ($update,$comment);
5554: }
5555:
5556: sub auto_photoupdate {
5557: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5558: my $homeserver = &homeserver($cnum,$dom);
5559: my $host=&hostname($homeserver);
5560: my $cmd = '';
5561: my $maxtries = 1;
5562: foreach my $affiliate (keys(%{$affiliatesref})) {
5563: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5564: }
5565: $cmd =~ s/%%$//;
5566: $cmd = &escape($cmd);
5567: my $query = 'institutionalphotos';
5568: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5569: unless ($queryid=~/^\Q$host\E\_/) {
5570: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5571: return 'error: '.$queryid;
5572: }
5573: my $reply = &get_query_reply($queryid);
5574: my $tries = 1;
5575: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5576: $reply = &get_query_reply($queryid);
5577: $tries ++;
5578: }
5579: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5580: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5581: } else {
5582: my @responses = split(/:/,$reply);
5583: my $outcome = shift(@responses);
5584: foreach my $item (@responses) {
5585: my ($key,$value) = split(/=/,$item);
5586: $$photo{$key} = $value;
5587: }
5588: return $outcome;
5589: }
5590: return 'error';
5591: }
5592:
5593: sub auto_instcode_format {
5594: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5595: $cat_order) = @_;
5596: my $courses = '';
5597: my @homeservers;
5598: if ($caller eq 'global') {
5599: my %servers = &get_servers($codedom,'library');
5600: foreach my $tryserver (keys(%servers)) {
5601: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5602: push(@homeservers,$tryserver);
5603: }
5604: }
5605: } else {
5606: push(@homeservers,&homeserver($caller,$codedom));
5607: }
5608: foreach my $code (keys(%{$instcodes})) {
5609: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5610: }
5611: chop($courses);
5612: my $ok_response = 0;
5613: my $response;
5614: while (@homeservers > 0 && $ok_response == 0) {
5615: my $server = shift(@homeservers);
5616: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5617: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5618: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5619: split(/:/,$response);
5620: %{$codes} = (%{$codes},&str2hash($codes_str));
5621: push(@{$codetitles},&str2array($codetitles_str));
5622: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5623: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5624: $ok_response = 1;
5625: }
5626: }
5627: if ($ok_response) {
5628: return 'ok';
5629: } else {
5630: return $response;
5631: }
5632: }
5633:
5634: sub auto_instcode_defaults {
5635: my ($domain,$returnhash,$code_order) = @_;
5636: my @homeservers;
5637:
5638: my %servers = &get_servers($domain,'library');
5639: foreach my $tryserver (keys(%servers)) {
5640: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5641: push(@homeservers,$tryserver);
5642: }
5643: }
5644:
5645: my $response;
5646: foreach my $server (@homeservers) {
5647: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5648: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5649:
5650: foreach my $pair (split(/\&/,$response)) {
5651: my ($name,$value)=split(/\=/,$pair);
5652: if ($name eq 'code_order') {
5653: @{$code_order} = split(/\&/,&unescape($value));
5654: } else {
5655: $returnhash->{&unescape($name)}=&unescape($value);
5656: }
5657: }
5658: return 'ok';
5659: }
5660:
5661: return $response;
5662: }
5663:
5664: sub auto_validate_class_sec {
5665: my ($cdom,$cnum,$owners,$inst_class) = @_;
5666: my $homeserver = &homeserver($cnum,$cdom);
5667: my $ownerlist;
5668: if (ref($owners) eq 'ARRAY') {
5669: $ownerlist = join(',',@{$owners});
5670: } else {
5671: $ownerlist = $owners;
5672: }
5673: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
5674: &escape($ownerlist).':'.$cdom,$homeserver);
5675: return $response;
5676: }
5677:
5678: # ------------------------------------------------------- Course Group routines
5679:
5680: sub get_coursegroups {
5681: my ($cdom,$cnum,$group,$namespace) = @_;
5682: return(&dump($namespace,$cdom,$cnum,$group));
5683: }
5684:
5685: sub modify_coursegroup {
5686: my ($cdom,$cnum,$groupsettings) = @_;
5687: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
5688: }
5689:
5690: sub toggle_coursegroup_status {
5691: my ($cdom,$cnum,$group,$action) = @_;
5692: my ($from_namespace,$to_namespace);
5693: if ($action eq 'delete') {
5694: $from_namespace = 'coursegroups';
5695: $to_namespace = 'deleted_groups';
5696: } else {
5697: $from_namespace = 'deleted_groups';
5698: $to_namespace = 'coursegroups';
5699: }
5700: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
5701: if (my $tmp = &error(%curr_group)) {
5702: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
5703: return ('read error',$tmp);
5704: } else {
5705: my %savedsettings = %curr_group;
5706: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
5707: my $deloutcome;
5708: if ($result eq 'ok') {
5709: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
5710: } else {
5711: return ('write error',$result);
5712: }
5713: if ($deloutcome eq 'ok') {
5714: return 'ok';
5715: } else {
5716: return ('delete error',$deloutcome);
5717: }
5718: }
5719: }
5720:
5721: sub modify_group_roles {
5722: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
5723: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
5724: my $role = 'gr/'.&escape($userprivs);
5725: my ($uname,$udom) = split(/:/,$user);
5726: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
5727: if ($result eq 'ok') {
5728: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
5729: }
5730: return $result;
5731: }
5732:
5733: sub modify_coursegroup_membership {
5734: my ($cdom,$cnum,$membership) = @_;
5735: my $result = &put('groupmembership',$membership,$cdom,$cnum);
5736: return $result;
5737: }
5738:
5739: sub get_active_groups {
5740: my ($udom,$uname,$cdom,$cnum) = @_;
5741: my $now = time;
5742: my %groups = ();
5743: foreach my $key (keys(%env)) {
5744: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
5745: my ($start,$end) = split(/\./,$env{$key});
5746: if (($end!=0) && ($end<$now)) { next; }
5747: if (($start!=0) && ($start>$now)) { next; }
5748: if ($1 eq $cdom && $2 eq $cnum) {
5749: $groups{$3} = $env{$key} ;
5750: }
5751: }
5752: }
5753: return %groups;
5754: }
5755:
5756: sub get_group_membership {
5757: my ($cdom,$cnum,$group) = @_;
5758: return(&dump('groupmembership',$cdom,$cnum,$group));
5759: }
5760:
5761: sub get_users_groups {
5762: my ($udom,$uname,$courseid) = @_;
5763: my @usersgroups;
5764: my $cachetime=1800;
5765:
5766: my $hashid="$udom:$uname:$courseid";
5767: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
5768: if (defined($cached)) {
5769: @usersgroups = split(/:/,$grouplist);
5770: } else {
5771: $grouplist = '';
5772: my $courseurl = &courseid_to_courseurl($courseid);
5773: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
5774: my $access_end = $env{'course.'.$courseid.
5775: '.default_enrollment_end_date'};
5776: my $now = time;
5777: foreach my $key (keys(%roleshash)) {
5778: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
5779: my $group = $1;
5780: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
5781: my $start = $2;
5782: my $end = $1;
5783: if ($start == -1) { next; } # deleted from group
5784: if (($start!=0) && ($start>$now)) { next; }
5785: if (($end!=0) && ($end<$now)) {
5786: if ($access_end && $access_end < $now) {
5787: if ($access_end - $end < 86400) {
5788: push(@usersgroups,$group);
5789: }
5790: }
5791: next;
5792: }
5793: push(@usersgroups,$group);
5794: }
5795: }
5796: }
5797: @usersgroups = &sort_course_groups($courseid,@usersgroups);
5798: $grouplist = join(':',@usersgroups);
5799: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
5800: }
5801: return @usersgroups;
5802: }
5803:
5804: sub devalidate_getgroups_cache {
5805: my ($udom,$uname,$cdom,$cnum)=@_;
5806: my $courseid = $cdom.'_'.$cnum;
5807:
5808: my $hashid="$udom:$uname:$courseid";
5809: &devalidate_cache_new('getgroups',$hashid);
5810: }
5811:
5812: # ------------------------------------------------------------------ Plain Text
5813:
5814: sub plaintext {
5815: my ($short,$type,$cid,$forcedefault) = @_;
5816: if ($short =~ /^cr/) {
5817: return (split('/',$short))[-1];
5818: }
5819: if (!defined($cid)) {
5820: $cid = $env{'request.course.id'};
5821: }
5822: if (defined($cid) && ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '')) {
5823: unless ($forcedefault) {
5824: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
5825: &Apache::lonlocal::mt_escape(\$roletext);
5826: return &Apache::lonlocal::mt($roletext);
5827: }
5828: }
5829: my %rolenames = (
5830: Course => 'std',
5831: Group => 'alt1',
5832: );
5833: if (defined($type) &&
5834: defined($rolenames{$type}) &&
5835: defined($prp{$short}{$rolenames{$type}})) {
5836: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
5837: } else {
5838: return &Apache::lonlocal::mt($prp{$short}{'std'});
5839: }
5840: }
5841:
5842: # ----------------------------------------------------------------- Assign Role
5843:
5844: sub assignrole {
5845: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
5846: $context)=@_;
5847: my $mrole;
5848: if ($role =~ /^cr\//) {
5849: my $cwosec=$url;
5850: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5851: unless (&allowed('ccr',$cwosec)) {
5852: &logthis('Refused custom assignrole: '.
5853: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5854: $env{'user.name'}.' at '.$env{'user.domain'});
5855: return 'refused';
5856: }
5857: $mrole='cr';
5858: } elsif ($role =~ /^gr\//) {
5859: my $cwogrp=$url;
5860: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
5861: unless (&allowed('mdg',$cwogrp)) {
5862: &logthis('Refused group assignrole: '.
5863: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5864: $env{'user.name'}.' at '.$env{'user.domain'});
5865: return 'refused';
5866: }
5867: $mrole='gr';
5868: } else {
5869: my $cwosec=$url;
5870: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5871: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
5872: my $refused;
5873: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
5874: if (!(&allowed('c'.$role,$url))) {
5875: $refused = 1;
5876: }
5877: } else {
5878: $refused = 1;
5879: }
5880: if ($refused) {
5881: if (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5882: $refused = '';
5883: } else {
5884: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
5885: ' '.$role.' '.$end.' '.$start.' by '.
5886: $env{'user.name'}.' at '.$env{'user.domain'});
5887: return 'refused';
5888: }
5889: }
5890: }
5891: $mrole=$role;
5892: }
5893: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5894: "$udom:$uname:$url".'_'."$mrole=$role";
5895: if ($end) { $command.='_'.$end; }
5896: if ($start) {
5897: if ($end) {
5898: $command.='_'.$start;
5899: } else {
5900: $command.='_0_'.$start;
5901: }
5902: }
5903: my $origstart = $start;
5904: my $origend = $end;
5905: my $delflag;
5906: # actually delete
5907: if ($deleteflag) {
5908: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
5909: # modify command to delete the role
5910: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
5911: "$udom:$uname:$url".'_'."$mrole";
5912: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
5913: # set start and finish to negative values for userrolelog
5914: $start=-1;
5915: $end=-1;
5916: $delflag = 1;
5917: }
5918: }
5919: # send command
5920: my $answer=&reply($command,&homeserver($uname,$udom));
5921: # log new user role if status is ok
5922: if ($answer eq 'ok') {
5923: &userrolelog($role,$uname,$udom,$url,$start,$end);
5924: # for course roles, perform group memberships changes triggered by role change.
5925: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
5926: unless ($role =~ /^gr/) {
5927: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
5928: $origstart,$selfenroll,$context);
5929: }
5930: }
5931: return $answer;
5932: }
5933:
5934: # -------------------------------------------------- Modify user authentication
5935: # Overrides without validation
5936:
5937: sub modifyuserauth {
5938: my ($udom,$uname,$umode,$upass)=@_;
5939: my $uhome=&homeserver($uname,$udom);
5940: unless (&allowed('mau',$udom)) { return 'refused'; }
5941: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
5942: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5943: ' in domain '.$env{'request.role.domain'});
5944: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
5945: &escape($upass),$uhome);
5946: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
5947: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
5948: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5949: &log($udom,,$uname,$uhome,
5950: 'Authentication changed by '.$env{'user.domain'}.', '.
5951: $env{'user.name'}.', '.$umode.
5952: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5953: unless ($reply eq 'ok') {
5954: &logthis('Authentication mode error: '.$reply);
5955: return 'error: '.$reply;
5956: }
5957: return 'ok';
5958: }
5959:
5960: # --------------------------------------------------------------- Modify a user
5961:
5962: sub modifyuser {
5963: my ($udom, $uname, $uid,
5964: $umode, $upass, $first,
5965: $middle, $last, $gene,
5966: $forceid, $desiredhome, $email, $inststatus)=@_;
5967: $udom= &LONCAPA::clean_domain($udom);
5968: $uname=&LONCAPA::clean_username($uname);
5969: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
5970: $umode.', '.$first.', '.$middle.', '.
5971: $last.', '.$gene.'(forceid: '.$forceid.')'.
5972: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
5973: ' desiredhome not specified').
5974: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5975: ' in domain '.$env{'request.role.domain'});
5976: my $uhome=&homeserver($uname,$udom,'true');
5977: # ----------------------------------------------------------------- Create User
5978: if (($uhome eq 'no_host') &&
5979: (($umode && $upass) || ($umode eq 'localauth'))) {
5980: my $unhome='';
5981: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
5982: $unhome = $desiredhome;
5983: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5984: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
5985: } else { # load balancing routine for determining $unhome
5986: my $loadm=10000000;
5987: my %servers = &get_servers($udom,'library');
5988: foreach my $tryserver (keys(%servers)) {
5989: my $answer=reply('load',$tryserver);
5990: if (($answer=~/\d+/) && ($answer<$loadm)) {
5991: $loadm=$answer;
5992: $unhome=$tryserver;
5993: }
5994: }
5995: }
5996: if (($unhome eq '') || ($unhome eq 'no_host')) {
5997: return 'error: unable to find a home server for '.$uname.
5998: ' in domain '.$udom;
5999: }
6000: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6001: &escape($upass),$unhome);
6002: unless ($reply eq 'ok') {
6003: return 'error: '.$reply;
6004: }
6005: $uhome=&homeserver($uname,$udom,'true');
6006: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
6007: return 'error: unable verify users home machine.';
6008: }
6009: } # End of creation of new user
6010: # ---------------------------------------------------------------------- Add ID
6011: if ($uid) {
6012: $uid=~tr/A-Z/a-z/;
6013: my %uidhash=&idrget($udom,$uname);
6014: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6015: && (!$forceid)) {
6016: unless ($uid eq $uidhash{$uname}) {
6017: return 'error: user id "'.$uid.'" does not match '.
6018: 'current user id "'.$uidhash{$uname}.'".';
6019: }
6020: } else {
6021: &idput($udom,($uname => $uid));
6022: }
6023: }
6024: # -------------------------------------------------------------- Add names, etc
6025: my @tmp=&get('environment',
6026: ['firstname','middlename','lastname','generation','id',
6027: 'permanentemail','inststatus'],
6028: $udom,$uname);
6029: my %names;
6030: if ($tmp[0] =~ m/^error:.*/) {
6031: %names=();
6032: } else {
6033: %names = @tmp;
6034: }
6035: #
6036: # Make sure to not trash student environment if instructor does not bother
6037: # to supply name and email information
6038: #
6039: if ($first) { $names{'firstname'} = $first; }
6040: if (defined($middle)) { $names{'middlename'} = $middle; }
6041: if ($last) { $names{'lastname'} = $last; }
6042: if (defined($gene)) { $names{'generation'} = $gene; }
6043: if ($email) {
6044: $email=~s/[^\w\@\.\-\,]//gs;
6045: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6046: }
6047: if ($uid) { $names{'id'} = $uid; }
6048: if (defined($inststatus)) {
6049: $names{'inststatus'} = '';
6050: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6051: if (ref($usertypes) eq 'HASH') {
6052: my @okstatuses;
6053: foreach my $item (split(/:/,$inststatus)) {
6054: if (defined($usertypes->{$item})) {
6055: push(@okstatuses,$item);
6056: }
6057: }
6058: if (@okstatuses) {
6059: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6060: }
6061: }
6062: }
6063: my $reply = &put('environment', \%names, $udom,$uname);
6064: if ($reply ne 'ok') { return 'error: '.$reply; }
6065: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6066: &devalidate_cache_new('namescache',$uname.':'.$udom);
6067: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6068: $umode.', '.$first.', '.$middle.', '.
6069: $last.', '.$gene.', '.$email.', '.$inststatus;
6070: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6071: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6072: } else {
6073: $logmsg .= ' during self creation';
6074: }
6075: &logthis($logmsg);
6076: return 'ok';
6077: }
6078:
6079: # -------------------------------------------------------------- Modify student
6080:
6081: sub modifystudent {
6082: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6083: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6084: $selfenroll,$context,$inststatus)=@_;
6085: if (!$cid) {
6086: unless ($cid=$env{'request.course.id'}) {
6087: return 'not_in_class';
6088: }
6089: }
6090: # --------------------------------------------------------------- Make the user
6091: my $reply=&modifyuser
6092: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6093: $desiredhome,$email,$inststatus);
6094: unless ($reply eq 'ok') { return $reply; }
6095: # This will cause &modify_student_enrollment to get the uid from the
6096: # students environment
6097: $uid = undef if (!$forceid);
6098: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6099: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6100: return $reply;
6101: }
6102:
6103: sub modify_student_enrollment {
6104: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6105: my ($cdom,$cnum,$chome);
6106: if (!$cid) {
6107: unless ($cid=$env{'request.course.id'}) {
6108: return 'not_in_class';
6109: }
6110: $cdom=$env{'course.'.$cid.'.domain'};
6111: $cnum=$env{'course.'.$cid.'.num'};
6112: } else {
6113: ($cdom,$cnum)=split(/_/,$cid);
6114: }
6115: $chome=$env{'course.'.$cid.'.home'};
6116: if (!$chome) {
6117: $chome=&homeserver($cnum,$cdom);
6118: }
6119: if (!$chome) { return 'unknown_course'; }
6120: # Make sure the user exists
6121: my $uhome=&homeserver($uname,$udom);
6122: if (($uhome eq '') || ($uhome eq 'no_host')) {
6123: return 'error: no such user';
6124: }
6125: # Get student data if we were not given enough information
6126: if (!defined($first) || $first eq '' ||
6127: !defined($last) || $last eq '' ||
6128: !defined($uid) || $uid eq '' ||
6129: !defined($middle) || $middle eq '' ||
6130: !defined($gene) || $gene eq '') {
6131: # They did not supply us with enough data to enroll the student, so
6132: # we need to pick up more information.
6133: my %tmp = &get('environment',
6134: ['firstname','middlename','lastname', 'generation','id']
6135: ,$udom,$uname);
6136:
6137: #foreach my $key (keys(%tmp)) {
6138: # &logthis("key $key = ".$tmp{$key});
6139: #}
6140: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6141: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6142: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6143: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6144: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6145: }
6146: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6147: my $reply=cput('classlist',
6148: {"$uname:$udom" =>
6149: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6150: $cdom,$cnum);
6151: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6152: return 'error: '.$reply;
6153: } else {
6154: &devalidate_getsection_cache($udom,$uname,$cid);
6155: }
6156: # Add student role to user
6157: my $uurl='/'.$cid;
6158: $uurl=~s/\_/\//g;
6159: if ($usec) {
6160: $uurl.='/'.$usec;
6161: }
6162: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6163: }
6164:
6165: sub format_name {
6166: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6167: my $name;
6168: if ($first ne 'lastname') {
6169: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6170: } else {
6171: if ($lastname=~/\S/) {
6172: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6173: $name=~s/\s+,/,/;
6174: } else {
6175: $name.= $firstname.' '.$middlename.' '.$generation;
6176: }
6177: }
6178: $name=~s/^\s+//;
6179: $name=~s/\s+$//;
6180: $name=~s/\s+/ /g;
6181: return $name;
6182: }
6183:
6184: # ------------------------------------------------- Write to course preferences
6185:
6186: sub writecoursepref {
6187: my ($courseid,%prefs)=@_;
6188: $courseid=~s/^\///;
6189: $courseid=~s/\_/\//g;
6190: my ($cdomain,$cnum)=split(/\//,$courseid);
6191: my $chome=homeserver($cnum,$cdomain);
6192: if (($chome eq '') || ($chome eq 'no_host')) {
6193: return 'error: no such course';
6194: }
6195: my $cstring='';
6196: foreach my $pref (keys(%prefs)) {
6197: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6198: }
6199: $cstring=~s/\&$//;
6200: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6201: }
6202:
6203: # ---------------------------------------------------------- Make/modify course
6204:
6205: sub createcourse {
6206: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6207: $course_owner,$crstype)=@_;
6208: $url=&declutter($url);
6209: my $cid='';
6210: unless (&allowed('ccc',$udom)) {
6211: return 'refused';
6212: }
6213: # ------------------------------------------------------------------- Create ID
6214: my $uname=int(1+rand(9)).
6215: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6216: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6217: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6218: # ----------------------------------------------- Make sure that does not exist
6219: my $uhome=&homeserver($uname,$udom,'true');
6220: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6221: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
6222: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6223: $uhome=&homeserver($uname,$udom,'true');
6224: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6225: return 'error: unable to generate unique course-ID';
6226: }
6227: }
6228: # ------------------------------------------------ Check supplied server name
6229: $course_server = $env{'user.homeserver'} if (! defined($course_server));
6230: if (! &is_library($course_server)) {
6231: return 'error:bad server name '.$course_server;
6232: }
6233: # ------------------------------------------------------------- Make the course
6234: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6235: $course_server);
6236: unless ($reply eq 'ok') { return 'error: '.$reply; }
6237: $uhome=&homeserver($uname,$udom,'true');
6238: if (($uhome eq '') || ($uhome eq 'no_host')) {
6239: return 'error: no such course';
6240: }
6241: # ----------------------------------------------------------------- Course made
6242: # log existence
6243: my $newcourse = {
6244: $udom.'_'.$uname => {
6245: description => $description,
6246: inst_code => $inst_code,
6247: owner => $course_owner,
6248: type => $crstype,
6249: },
6250: };
6251: &courseidput($udom,$newcourse,$uhome,'notime');
6252: # set toplevel url
6253: my $topurl=$url;
6254: unless ($nonstandard) {
6255: # ------------------------------------------ For standard courses, make top url
6256: my $mapurl=&clutter($url);
6257: if ($mapurl eq '/res/') { $mapurl=''; }
6258: $env{'form.initmap'}=(<<ENDINITMAP);
6259: <map>
6260: <resource id="1" type="start"></resource>
6261: <resource id="2" src="$mapurl"></resource>
6262: <resource id="3" type="finish"></resource>
6263: <link index="1" from="1" to="2"></link>
6264: <link index="2" from="2" to="3"></link>
6265: </map>
6266: ENDINITMAP
6267: $topurl=&declutter(
6268: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6269: );
6270: }
6271: # ----------------------------------------------------------- Write preferences
6272: &writecoursepref($udom.'_'.$uname,
6273: ('description' => $description,
6274: 'url' => $topurl));
6275: return '/'.$udom.'/'.$uname;
6276: }
6277:
6278: sub is_course {
6279: my ($cdom,$cnum) = @_;
6280: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
6281: undef,'.');
6282: if (exists($courses{$cdom.'_'.$cnum})) {
6283: return 1;
6284: }
6285: return 0;
6286: }
6287:
6288: # ---------------------------------------------------------- Assign Custom Role
6289:
6290: sub assigncustomrole {
6291: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
6292: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
6293: $end,$start,$deleteflag,$selfenroll,$context);
6294: }
6295:
6296: # ----------------------------------------------------------------- Revoke Role
6297:
6298: sub revokerole {
6299: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
6300: my $now=time;
6301: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
6302: }
6303:
6304: # ---------------------------------------------------------- Revoke Custom Role
6305:
6306: sub revokecustomrole {
6307: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
6308: my $now=time;
6309: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
6310: $deleteflag,$selfenroll,$context);
6311: }
6312:
6313: # ------------------------------------------------------------ Disk usage
6314: sub diskusage {
6315: my ($udom,$uname,$directorypath,$getpropath)=@_;
6316: $directorypath =~ s/\/$//;
6317: my $listing=&reply('du2:'.&escape($directorypath).':'
6318: .&escape($getpropath).':'.&escape($uname).':'
6319: .&escape($udom),homeserver($uname,$udom));
6320: if ($listing eq 'unknown_cmd') {
6321: if ($getpropath) {
6322: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6323: }
6324: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6325: }
6326: return $listing;
6327: }
6328:
6329: sub is_locked {
6330: my ($file_name, $domain, $user) = @_;
6331: my @check;
6332: my $is_locked;
6333: push @check, $file_name;
6334: my %locked = &get('file_permissions',\@check,
6335: $env{'user.domain'},$env{'user.name'});
6336: my ($tmp)=keys(%locked);
6337: if ($tmp=~/^error:/) { undef(%locked); }
6338:
6339: if (ref($locked{$file_name}) eq 'ARRAY') {
6340: $is_locked = 'false';
6341: foreach my $entry (@{$locked{$file_name}}) {
6342: if (ref($entry) eq 'ARRAY') {
6343: $is_locked = 'true';
6344: last;
6345: }
6346: }
6347: } else {
6348: $is_locked = 'false';
6349: }
6350: }
6351:
6352: sub declutter_portfile {
6353: my ($file) = @_;
6354: $file =~ s{^(/portfolio/|portfolio/)}{/};
6355: return $file;
6356: }
6357:
6358: # ------------------------------------------------------------- Mark as Read Only
6359:
6360: sub mark_as_readonly {
6361: my ($domain,$user,$files,$what) = @_;
6362: my %current_permissions = &dump('file_permissions',$domain,$user);
6363: my ($tmp)=keys(%current_permissions);
6364: if ($tmp=~/^error:/) { undef(%current_permissions); }
6365: foreach my $file (@{$files}) {
6366: $file = &declutter_portfile($file);
6367: push(@{$current_permissions{$file}},$what);
6368: }
6369: &put('file_permissions',\%current_permissions,$domain,$user);
6370: return;
6371: }
6372:
6373: # ------------------------------------------------------------Save Selected Files
6374:
6375: sub save_selected_files {
6376: my ($user, $path, @files) = @_;
6377: my $filename = $user."savedfiles";
6378: my @other_files = &files_not_in_path($user, $path);
6379: open (OUT, '>'.$tmpdir.$filename);
6380: foreach my $file (@files) {
6381: print (OUT $env{'form.currentpath'}.$file."\n");
6382: }
6383: foreach my $file (@other_files) {
6384: print (OUT $file."\n");
6385: }
6386: close (OUT);
6387: return 'ok';
6388: }
6389:
6390: sub clear_selected_files {
6391: my ($user) = @_;
6392: my $filename = $user."savedfiles";
6393: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6394: print (OUT undef);
6395: close (OUT);
6396: return ("ok");
6397: }
6398:
6399: sub files_in_path {
6400: my ($user, $path) = @_;
6401: my $filename = $user."savedfiles";
6402: my %return_files;
6403: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6404: while (my $line_in = <IN>) {
6405: chomp ($line_in);
6406: my @paths_and_file = split (m!/!, $line_in);
6407: my $file_part = pop (@paths_and_file);
6408: my $path_part = join ('/', @paths_and_file);
6409: $path_part.='/';
6410: my $path_and_file = $path_part.$file_part;
6411: if ($path_part eq $path) {
6412: $return_files{$file_part}= 'selected';
6413: }
6414: }
6415: close (IN);
6416: return (\%return_files);
6417: }
6418:
6419: # called in portfolio select mode, to show files selected NOT in current directory
6420: sub files_not_in_path {
6421: my ($user, $path) = @_;
6422: my $filename = $user."savedfiles";
6423: my @return_files;
6424: my $path_part;
6425: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6426: while (my $line = <IN>) {
6427: #ok, I know it's clunky, but I want it to work
6428: my @paths_and_file = split(m|/|, $line);
6429: my $file_part = pop(@paths_and_file);
6430: chomp($file_part);
6431: my $path_part = join('/', @paths_and_file);
6432: $path_part .= '/';
6433: my $path_and_file = $path_part.$file_part;
6434: if ($path_part ne $path) {
6435: push(@return_files, ($path_and_file));
6436: }
6437: }
6438: close(OUT);
6439: return (@return_files);
6440: }
6441:
6442: #----------------------------------------------Get portfolio file permissions
6443:
6444: sub get_portfile_permissions {
6445: my ($domain,$user) = @_;
6446: my %current_permissions = &dump('file_permissions',$domain,$user);
6447: my ($tmp)=keys(%current_permissions);
6448: if ($tmp=~/^error:/) { undef(%current_permissions); }
6449: return \%current_permissions;
6450: }
6451:
6452: #---------------------------------------------Get portfolio file access controls
6453:
6454: sub get_access_controls {
6455: my ($current_permissions,$group,$file) = @_;
6456: my %access;
6457: my $real_file = $file;
6458: $file =~ s/\.meta$//;
6459: if (defined($file)) {
6460: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
6461: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
6462: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
6463: }
6464: }
6465: } else {
6466: foreach my $key (keys(%{$current_permissions})) {
6467: if ($key =~ /\0accesscontrol$/) {
6468: if (defined($group)) {
6469: if ($key !~ m-^\Q$group\E/-) {
6470: next;
6471: }
6472: }
6473: my ($fullpath) = split(/\0/,$key);
6474: if (ref($$current_permissions{$key}) eq 'HASH') {
6475: foreach my $control (keys(%{$$current_permissions{$key}})) {
6476: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
6477: }
6478: }
6479: }
6480: }
6481: }
6482: return %access;
6483: }
6484:
6485: sub modify_access_controls {
6486: my ($file_name,$changes,$domain,$user)=@_;
6487: my ($outcome,$deloutcome);
6488: my %store_permissions;
6489: my %new_values;
6490: my %new_control;
6491: my %translation;
6492: my @deletions = ();
6493: my $now = time;
6494: if (exists($$changes{'activate'})) {
6495: if (ref($$changes{'activate'}) eq 'HASH') {
6496: my @newitems = sort(keys(%{$$changes{'activate'}}));
6497: my $numnew = scalar(@newitems);
6498: for (my $i=0; $i<$numnew; $i++) {
6499: my $newkey = $newitems[$i];
6500: my $newid = &Apache::loncommon::get_cgi_id();
6501: if ($newkey =~ /^\d+:/) {
6502: $newkey =~ s/^(\d+)/$newid/;
6503: $translation{$1} = $newid;
6504: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
6505: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
6506: $translation{$1} = $newid;
6507: }
6508: $new_values{$file_name."\0".$newkey} =
6509: $$changes{'activate'}{$newitems[$i]};
6510: $new_control{$newkey} = $now;
6511: }
6512: }
6513: }
6514: my %todelete;
6515: my %changed_items;
6516: foreach my $action ('delete','update') {
6517: if (exists($$changes{$action})) {
6518: if (ref($$changes{$action}) eq 'HASH') {
6519: foreach my $key (keys(%{$$changes{$action}})) {
6520: my ($itemnum) = ($key =~ /^([^:]+):/);
6521: if ($action eq 'delete') {
6522: $todelete{$itemnum} = 1;
6523: } else {
6524: $changed_items{$itemnum} = $key;
6525: }
6526: }
6527: }
6528: }
6529: }
6530: # get lock on access controls for file.
6531: my $lockhash = {
6532: $file_name."\0".'locked_access_records' => $env{'user.name'}.
6533: ':'.$env{'user.domain'},
6534: };
6535: my $tries = 0;
6536: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6537:
6538: while (($gotlock ne 'ok') && $tries <3) {
6539: $tries ++;
6540: sleep 1;
6541: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6542: }
6543: if ($gotlock eq 'ok') {
6544: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
6545: my ($tmp)=keys(%curr_permissions);
6546: if ($tmp=~/^error:/) { undef(%curr_permissions); }
6547: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
6548: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
6549: if (ref($curr_controls) eq 'HASH') {
6550: foreach my $control_item (keys(%{$curr_controls})) {
6551: my ($itemnum) = ($control_item =~ /^([^:]+):/);
6552: if (defined($todelete{$itemnum})) {
6553: push(@deletions,$file_name."\0".$control_item);
6554: } else {
6555: if (defined($changed_items{$itemnum})) {
6556: $new_control{$changed_items{$itemnum}} = $now;
6557: push(@deletions,$file_name."\0".$control_item);
6558: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
6559: } else {
6560: $new_control{$control_item} = $$curr_controls{$control_item};
6561: }
6562: }
6563: }
6564: }
6565: }
6566: my ($group);
6567: if (&is_course($domain,$user)) {
6568: ($group,my $file) = split(/\//,$file_name,2);
6569: }
6570: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
6571: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
6572: $outcome = &put('file_permissions',\%new_values,$domain,$user);
6573: # remove lock
6574: my @del_lock = ($file_name."\0".'locked_access_records');
6575: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
6576: my $sqlresult =
6577: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
6578: $group);
6579: } else {
6580: $outcome = "error: could not obtain lockfile\n";
6581: }
6582: return ($outcome,$deloutcome,\%new_values,\%translation);
6583: }
6584:
6585: sub make_public_indefinitely {
6586: my ($requrl) = @_;
6587: my $now = time;
6588: my $action = 'activate';
6589: my $aclnum = 0;
6590: if (&is_portfolio_url($requrl)) {
6591: my (undef,$udom,$unum,$file_name,$group) =
6592: &parse_portfolio_url($requrl);
6593: my $current_perms = &get_portfile_permissions($udom,$unum);
6594: my %access_controls = &get_access_controls($current_perms,
6595: $group,$file_name);
6596: foreach my $key (keys(%{$access_controls{$file_name}})) {
6597: my ($num,$scope,$end,$start) =
6598: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6599: if ($scope eq 'public') {
6600: if ($start <= $now && $end == 0) {
6601: $action = 'none';
6602: } else {
6603: $action = 'update';
6604: $aclnum = $num;
6605: }
6606: last;
6607: }
6608: }
6609: if ($action eq 'none') {
6610: return 'ok';
6611: } else {
6612: my %changes;
6613: my $newend = 0;
6614: my $newstart = $now;
6615: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
6616: $changes{$action}{$newkey} = {
6617: type => 'public',
6618: time => {
6619: start => $newstart,
6620: end => $newend,
6621: },
6622: };
6623: my ($outcome,$deloutcome,$new_values,$translation) =
6624: &modify_access_controls($file_name,\%changes,$udom,$unum);
6625: return $outcome;
6626: }
6627: } else {
6628: return 'invalid';
6629: }
6630: }
6631:
6632: #------------------------------------------------------Get Marked as Read Only
6633:
6634: sub get_marked_as_readonly {
6635: my ($domain,$user,$what,$group) = @_;
6636: my $current_permissions = &get_portfile_permissions($domain,$user);
6637: my @readonly_files;
6638: my $cmp1=$what;
6639: if (ref($what)) { $cmp1=join('',@{$what}) };
6640: while (my ($file_name,$value) = each(%{$current_permissions})) {
6641: if (defined($group)) {
6642: if ($file_name !~ m-^\Q$group\E/-) {
6643: next;
6644: }
6645: }
6646: if (ref($value) eq "ARRAY"){
6647: foreach my $stored_what (@{$value}) {
6648: my $cmp2=$stored_what;
6649: if (ref($stored_what) eq 'ARRAY') {
6650: $cmp2=join('',@{$stored_what});
6651: }
6652: if ($cmp1 eq $cmp2) {
6653: push(@readonly_files, $file_name);
6654: last;
6655: } elsif (!defined($what)) {
6656: push(@readonly_files, $file_name);
6657: last;
6658: }
6659: }
6660: }
6661: }
6662: return @readonly_files;
6663: }
6664: #-----------------------------------------------------------Get Marked as Read Only Hash
6665:
6666: sub get_marked_as_readonly_hash {
6667: my ($current_permissions,$group,$what) = @_;
6668: my %readonly_files;
6669: while (my ($file_name,$value) = each(%{$current_permissions})) {
6670: if (defined($group)) {
6671: if ($file_name !~ m-^\Q$group\E/-) {
6672: next;
6673: }
6674: }
6675: if (ref($value) eq "ARRAY"){
6676: foreach my $stored_what (@{$value}) {
6677: if (ref($stored_what) eq 'ARRAY') {
6678: foreach my $lock_descriptor(@{$stored_what}) {
6679: if ($lock_descriptor eq 'graded') {
6680: $readonly_files{$file_name} = 'graded';
6681: } elsif ($lock_descriptor eq 'handback') {
6682: $readonly_files{$file_name} = 'handback';
6683: } else {
6684: if (!exists($readonly_files{$file_name})) {
6685: $readonly_files{$file_name} = 'locked';
6686: }
6687: }
6688: }
6689: }
6690: }
6691: }
6692: }
6693: return %readonly_files;
6694: }
6695: # ------------------------------------------------------------ Unmark as Read Only
6696:
6697: sub unmark_as_readonly {
6698: # unmarks $file_name (if $file_name is defined), or all files locked by $what
6699: # for portfolio submissions, $what contains [$symb,$crsid]
6700: my ($domain,$user,$what,$file_name,$group) = @_;
6701: $file_name = &declutter_portfile($file_name);
6702: my $symb_crs = $what;
6703: if (ref($what)) { $symb_crs=join('',@$what); }
6704: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
6705: my ($tmp)=keys(%current_permissions);
6706: if ($tmp=~/^error:/) { undef(%current_permissions); }
6707: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
6708: foreach my $file (@readonly_files) {
6709: my $clean_file = &declutter_portfile($file);
6710: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
6711: my $current_locks = $current_permissions{$file};
6712: my @new_locks;
6713: my @del_keys;
6714: if (ref($current_locks) eq "ARRAY"){
6715: foreach my $locker (@{$current_locks}) {
6716: my $compare=$locker;
6717: if (ref($locker) eq 'ARRAY') {
6718: $compare=join('',@{$locker});
6719: if ($compare ne $symb_crs) {
6720: push(@new_locks, $locker);
6721: }
6722: }
6723: }
6724: if (scalar(@new_locks) > 0) {
6725: $current_permissions{$file} = \@new_locks;
6726: } else {
6727: push(@del_keys, $file);
6728: &del('file_permissions',\@del_keys, $domain, $user);
6729: delete($current_permissions{$file});
6730: }
6731: }
6732: }
6733: &put('file_permissions',\%current_permissions,$domain,$user);
6734: return;
6735: }
6736:
6737: # ------------------------------------------------------------ Directory lister
6738:
6739: sub dirlist {
6740: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
6741: $uri=~s/^\///;
6742: $uri=~s/\/$//;
6743: my ($udom, $uname);
6744: if ($getuserdir) {
6745: $udom = $userdomain;
6746: $uname = $username;
6747: } else {
6748: (undef,$udom,$uname)=split(/\//,$uri);
6749: if(defined($userdomain)) {
6750: $udom = $userdomain;
6751: }
6752: if(defined($username)) {
6753: $uname = $username;
6754: }
6755: }
6756: my ($dirRoot,$listing,@listing_results);
6757:
6758: $dirRoot = $perlvar{'lonDocRoot'};
6759: if (defined($getpropath)) {
6760: $dirRoot = &propath($udom,$uname);
6761: $dirRoot =~ s/\/$//;
6762: } elsif (defined($getuserdir)) {
6763: my $subdir=$uname.'__';
6764: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
6765: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
6766: ."/$udom/$subdir/$uname";
6767: } elsif (defined($alternateRoot)) {
6768: $dirRoot = $alternateRoot;
6769: }
6770:
6771: if($udom) {
6772: if($uname) {
6773: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
6774: .$getuserdir.':'.&escape($dirRoot)
6775: .':'.&escape($uname).':'.&escape($udom),
6776: &homeserver($uname,$udom));
6777: if ($listing eq 'unknown_cmd') {
6778: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
6779: &homeserver($uname,$udom));
6780: } else {
6781: @listing_results = map { &unescape($_); } split(/:/,$listing);
6782: }
6783: if ($listing eq 'unknown_cmd') {
6784: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
6785: &homeserver($uname,$udom));
6786: @listing_results = split(/:/,$listing);
6787: } else {
6788: @listing_results = map { &unescape($_); } split(/:/,$listing);
6789: }
6790: return @listing_results;
6791: } elsif(!$alternateRoot) {
6792: my %allusers;
6793: my %servers = &get_servers($udom,'library');
6794: foreach my $tryserver (keys(%servers)) {
6795: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
6796: &escape($udom),$tryserver);
6797: if ($listing eq 'unknown_cmd') {
6798: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
6799: $udom, $tryserver);
6800: } else {
6801: @listing_results = map { &unescape($_); } split(/:/,$listing);
6802: }
6803: if ($listing eq 'unknown_cmd') {
6804: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
6805: $udom, $tryserver);
6806: @listing_results = split(/:/,$listing);
6807: } else {
6808: @listing_results =
6809: map { &unescape($_); } split(/:/,$listing);
6810: }
6811: if ($listing_results[0] ne 'no_such_dir' &&
6812: $listing_results[0] ne 'empty' &&
6813: $listing_results[0] ne 'con_lost') {
6814: foreach my $line (@listing_results) {
6815: my ($entry) = split(/&/,$line,2);
6816: $allusers{$entry} = 1;
6817: }
6818: }
6819: }
6820: my $alluserstr='';
6821: foreach my $user (sort(keys(%allusers))) {
6822: $alluserstr.=$user.'&user:';
6823: }
6824: $alluserstr=~s/:$//;
6825: return split(/:/,$alluserstr);
6826: } else {
6827: return ('missing user name');
6828: }
6829: } elsif(!defined($getpropath)) {
6830: my @all_domains = sort(&all_domains());
6831: foreach my $domain (@all_domains) {
6832: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
6833: }
6834: return @all_domains;
6835: } else {
6836: return ('missing domain');
6837: }
6838: }
6839:
6840: # --------------------------------------------- GetFileTimestamp
6841: # This function utilizes dirlist and returns the date stamp for
6842: # when it was last modified. It will also return an error of -1
6843: # if an error occurs
6844:
6845: sub GetFileTimestamp {
6846: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
6847: $studentDomain = &LONCAPA::clean_domain($studentDomain);
6848: $studentName = &LONCAPA::clean_username($studentName);
6849: my ($fileStat) =
6850: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
6851: undef,$getuserdir);
6852: my @stats = split('&', $fileStat);
6853: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6854: # @stats contains first the filename, then the stat output
6855: return $stats[10]; # so this is 10 instead of 9.
6856: } else {
6857: return -1;
6858: }
6859: }
6860:
6861: sub stat_file {
6862: my ($uri) = @_;
6863: $uri = &clutter_with_no_wrapper($uri);
6864:
6865: my ($udom,$uname,$file);
6866: if ($uri =~ m-^/(uploaded|editupload)/-) {
6867: ($udom,$uname,$file) =
6868: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
6869: $file = 'userfiles/'.$file;
6870: }
6871: if ($uri =~ m-^/res/-) {
6872: ($udom,$uname) =
6873: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
6874: $file = $uri;
6875: }
6876:
6877: if (!$udom || !$uname || !$file) {
6878: # unable to handle the uri
6879: return ();
6880: }
6881: my $getpropath;
6882: if ($file =~ /^userfiles\//) {
6883: $getpropath = 1;
6884: }
6885: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
6886: my @stats = split('&', $result);
6887:
6888: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6889: shift(@stats); #filename is first
6890: return @stats;
6891: }
6892: return ();
6893: }
6894:
6895: # -------------------------------------------------------- Value of a Condition
6896:
6897: # gets the value of a specific preevaluated condition
6898: # stored in the string $env{user.state.<cid>}
6899: # or looks up a condition reference in the bighash and if if hasn't
6900: # already been evaluated recurses into docondval to get the value of
6901: # the condition, then memoizing it to
6902: # $env{user.state.<cid>.<condition>}
6903: sub directcondval {
6904: my $number=shift;
6905: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
6906: &Apache::lonuserstate::evalstate();
6907: }
6908: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
6909: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
6910: } elsif ($number =~ /^_/) {
6911: my $sub_condition;
6912: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6913: &GDBM_READER(),0640)) {
6914: $sub_condition=$bighash{'conditions'.$number};
6915: untie(%bighash);
6916: }
6917: my $value = &docondval($sub_condition);
6918: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
6919: return $value;
6920: }
6921: if ($env{'user.state.'.$env{'request.course.id'}}) {
6922: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
6923: } else {
6924: return 2;
6925: }
6926: }
6927:
6928: # get the collection of conditions for this resource
6929: sub condval {
6930: my $condidx=shift;
6931: my $allpathcond='';
6932: foreach my $cond (split(/\|/,$condidx)) {
6933: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
6934: $allpathcond.=
6935: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
6936: }
6937: }
6938: $allpathcond=~s/\|$//;
6939: return &docondval($allpathcond);
6940: }
6941:
6942: #evaluates an expression of conditions
6943: sub docondval {
6944: my ($allpathcond) = @_;
6945: my $result=0;
6946: if ($env{'request.course.id'}
6947: && defined($allpathcond)) {
6948: my $operand='|';
6949: my @stack;
6950: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
6951: if ($chunk eq '(') {
6952: push @stack,($operand,$result);
6953: } elsif ($chunk eq ')') {
6954: my $before=pop @stack;
6955: if (pop @stack eq '&') {
6956: $result=$result>$before?$before:$result;
6957: } else {
6958: $result=$result>$before?$result:$before;
6959: }
6960: } elsif (($chunk eq '&') || ($chunk eq '|')) {
6961: $operand=$chunk;
6962: } else {
6963: my $new=directcondval($chunk);
6964: if ($operand eq '&') {
6965: $result=$result>$new?$new:$result;
6966: } else {
6967: $result=$result>$new?$result:$new;
6968: }
6969: }
6970: }
6971: }
6972: return $result;
6973: }
6974:
6975: # ---------------------------------------------------- Devalidate courseresdata
6976:
6977: sub devalidatecourseresdata {
6978: my ($coursenum,$coursedomain)=@_;
6979: my $hashid=$coursenum.':'.$coursedomain;
6980: &devalidate_cache_new('courseres',$hashid);
6981: }
6982:
6983:
6984: # --------------------------------------------------- Course Resourcedata Query
6985: #
6986: # Parameters:
6987: # $coursenum - Number of the course.
6988: # $coursedomain - Domain at which the course was created.
6989: # Returns:
6990: # A hash of the course parameters along (I think) with timestamps
6991: # and version info.
6992:
6993: sub get_courseresdata {
6994: my ($coursenum,$coursedomain)=@_;
6995: my $coursehom=&homeserver($coursenum,$coursedomain);
6996: my $hashid=$coursenum.':'.$coursedomain;
6997: my ($result,$cached)=&is_cached_new('courseres',$hashid);
6998: my %dumpreply;
6999: unless (defined($cached)) {
7000: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
7001: $result=\%dumpreply;
7002: my ($tmp) = keys(%dumpreply);
7003: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7004: &do_cache_new('courseres',$hashid,$result,600);
7005: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7006: return $tmp;
7007: } elsif ($tmp =~ /^(error)/) {
7008: $result=undef;
7009: &do_cache_new('courseres',$hashid,$result,600);
7010: }
7011: }
7012: return $result;
7013: }
7014:
7015: sub devalidateuserresdata {
7016: my ($uname,$udom)=@_;
7017: my $hashid="$udom:$uname";
7018: &devalidate_cache_new('userres',$hashid);
7019: }
7020:
7021: sub get_userresdata {
7022: my ($uname,$udom)=@_;
7023: #most student don\'t have any data set, check if there is some data
7024: if (&EXT_cache_status($udom,$uname)) { return undef; }
7025:
7026: my $hashid="$udom:$uname";
7027: my ($result,$cached)=&is_cached_new('userres',$hashid);
7028: if (!defined($cached)) {
7029: my %resourcedata=&dump('resourcedata',$udom,$uname);
7030: $result=\%resourcedata;
7031: &do_cache_new('userres',$hashid,$result,600);
7032: }
7033: my ($tmp)=keys(%$result);
7034: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7035: return $result;
7036: }
7037: #error 2 occurs when the .db doesn't exist
7038: if ($tmp!~/error: 2 /) {
7039: &logthis("<font color=\"blue\">WARNING:".
7040: " Trying to get resource data for ".
7041: $uname." at ".$udom.": ".
7042: $tmp."</font>");
7043: } elsif ($tmp=~/error: 2 /) {
7044: #&EXT_cache_set($udom,$uname);
7045: &do_cache_new('userres',$hashid,undef,600);
7046: undef($tmp); # not really an error so don't send it back
7047: }
7048: return $tmp;
7049: }
7050: #----------------------------------------------- resdata - return resource data
7051: # Purpose:
7052: # Return resource data for either users or for a course.
7053: # Parameters:
7054: # $name - Course/user name.
7055: # $domain - Name of the domain the user/course is registered on.
7056: # $type - Type of thing $name is (must be 'course' or 'user'
7057: # @which - Array of names of resources desired.
7058: # Returns:
7059: # The value of the first reasource in @which that is found in the
7060: # resource hash.
7061: # Exceptional Conditions:
7062: # If the $type passed in is not valid (not the string 'course' or
7063: # 'user', an undefined reference is returned.
7064: # If none of the resources are found, an undef is returned
7065: sub resdata {
7066: my ($name,$domain,$type,@which)=@_;
7067: my $result;
7068: if ($type eq 'course') {
7069: $result=&get_courseresdata($name,$domain);
7070: } elsif ($type eq 'user') {
7071: $result=&get_userresdata($name,$domain);
7072: }
7073: if (!ref($result)) { return $result; }
7074: foreach my $item (@which) {
7075: if (defined($result->{$item->[0]})) {
7076: return [$result->{$item->[0]},$item->[1]];
7077: }
7078: }
7079: return undef;
7080: }
7081:
7082: #
7083: # EXT resource caching routines
7084: #
7085:
7086: sub clear_EXT_cache_status {
7087: &delenv('cache.EXT.');
7088: }
7089:
7090: sub EXT_cache_status {
7091: my ($target_domain,$target_user) = @_;
7092: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7093: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7094: # We know already the user has no data
7095: return 1;
7096: } else {
7097: return 0;
7098: }
7099: }
7100:
7101: sub EXT_cache_set {
7102: my ($target_domain,$target_user) = @_;
7103: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7104: #&appenv({$cachename => time});
7105: }
7106:
7107: # --------------------------------------------------------- Value of a Variable
7108: sub EXT {
7109:
7110: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7111: unless ($varname) { return ''; }
7112: #get real user name/domain, courseid and symb
7113: my $courseid;
7114: my $publicuser;
7115: if ($symbparm) {
7116: $symbparm=&get_symb_from_alias($symbparm);
7117: }
7118: if (!($uname && $udom)) {
7119: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7120: if (!$symbparm) { $symbparm=$cursymb; }
7121: } else {
7122: $courseid=$env{'request.course.id'};
7123: }
7124: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7125: my $rest;
7126: if (defined($therest[0])) {
7127: $rest=join('.',@therest);
7128: } else {
7129: $rest='';
7130: }
7131:
7132: my $qualifierrest=$qualifier;
7133: if ($rest) { $qualifierrest.='.'.$rest; }
7134: my $spacequalifierrest=$space;
7135: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7136: if ($realm eq 'user') {
7137: # --------------------------------------------------------------- user.resource
7138: if ($space eq 'resource') {
7139: if ( (defined($Apache::lonhomework::parsing_a_problem)
7140: || defined($Apache::lonhomework::parsing_a_task))
7141: &&
7142: ($symbparm eq &symbread()) ) {
7143: # if we are in the middle of processing the resource the
7144: # get the value we are planning on committing
7145: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7146: return $Apache::lonhomework::results{$qualifierrest};
7147: } else {
7148: return $Apache::lonhomework::history{$qualifierrest};
7149: }
7150: } else {
7151: my %restored;
7152: if ($publicuser || $env{'request.state'} eq 'construct') {
7153: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7154: } else {
7155: %restored=&restore($symbparm,$courseid,$udom,$uname);
7156: }
7157: return $restored{$qualifierrest};
7158: }
7159: # ----------------------------------------------------------------- user.access
7160: } elsif ($space eq 'access') {
7161: # FIXME - not supporting calls for a specific user
7162: return &allowed($qualifier,$rest);
7163: # ------------------------------------------ user.preferences, user.environment
7164: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7165: if (($uname eq $env{'user.name'}) &&
7166: ($udom eq $env{'user.domain'})) {
7167: return $env{join('.',('environment',$qualifierrest))};
7168: } else {
7169: my %returnhash;
7170: if (!$publicuser) {
7171: %returnhash=&userenvironment($udom,$uname,
7172: $qualifierrest);
7173: }
7174: return $returnhash{$qualifierrest};
7175: }
7176: # ----------------------------------------------------------------- user.course
7177: } elsif ($space eq 'course') {
7178: # FIXME - not supporting calls for a specific user
7179: return $env{join('.',('request.course',$qualifier))};
7180: # ------------------------------------------------------------------- user.role
7181: } elsif ($space eq 'role') {
7182: # FIXME - not supporting calls for a specific user
7183: my ($role,$where)=split(/\./,$env{'request.role'});
7184: if ($qualifier eq 'value') {
7185: return $role;
7186: } elsif ($qualifier eq 'extent') {
7187: return $where;
7188: }
7189: # ----------------------------------------------------------------- user.domain
7190: } elsif ($space eq 'domain') {
7191: return $udom;
7192: # ------------------------------------------------------------------- user.name
7193: } elsif ($space eq 'name') {
7194: return $uname;
7195: # ---------------------------------------------------- Any other user namespace
7196: } else {
7197: my %reply;
7198: if (!$publicuser) {
7199: %reply=&get($space,[$qualifierrest],$udom,$uname);
7200: }
7201: return $reply{$qualifierrest};
7202: }
7203: } elsif ($realm eq 'query') {
7204: # ---------------------------------------------- pull stuff out of query string
7205: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7206: [$spacequalifierrest]);
7207: return $env{'form.'.$spacequalifierrest};
7208: } elsif ($realm eq 'request') {
7209: # ------------------------------------------------------------- request.browser
7210: if ($space eq 'browser') {
7211: if ($qualifier eq 'textremote') {
7212: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7213: return 1;
7214: } else {
7215: return 0;
7216: }
7217: } else {
7218: return $env{'browser.'.$qualifier};
7219: }
7220: # ------------------------------------------------------------ request.filename
7221: } else {
7222: return $env{'request.'.$spacequalifierrest};
7223: }
7224: } elsif ($realm eq 'course') {
7225: # ---------------------------------------------------------- course.description
7226: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7227: } elsif ($realm eq 'resource') {
7228:
7229: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7230: if (!$symbparm) { $symbparm=&symbread(); }
7231: }
7232:
7233: if ($space eq 'title') {
7234: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7235: return &gettitle($symbparm);
7236: }
7237:
7238: if ($space eq 'map') {
7239: my ($map) = &decode_symb($symbparm);
7240: return &symbread($map);
7241: }
7242: if ($space eq 'filename') {
7243: if ($symbparm) {
7244: return &clutter((&decode_symb($symbparm))[2]);
7245: }
7246: return &hreflocation('',$env{'request.filename'});
7247: }
7248:
7249: my ($section, $group, @groups);
7250: my ($courselevelm,$courselevel);
7251: if ($symbparm && defined($courseid) &&
7252: $courseid eq $env{'request.course.id'}) {
7253:
7254: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
7255:
7256: # ----------------------------------------------------- Cascading lookup scheme
7257: my $symbp=$symbparm;
7258: my $mapp=&deversion((&decode_symb($symbp))[0]);
7259:
7260: my $symbparm=$symbp.'.'.$spacequalifierrest;
7261: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7262:
7263: if (($env{'user.name'} eq $uname) &&
7264: ($env{'user.domain'} eq $udom)) {
7265: $section=$env{'request.course.sec'};
7266: @groups = split(/:/,$env{'request.course.groups'});
7267: @groups=&sort_course_groups($courseid,@groups);
7268: } else {
7269: if (! defined($usection)) {
7270: $section=&getsection($udom,$uname,$courseid);
7271: } else {
7272: $section = $usection;
7273: }
7274: @groups = &get_users_groups($udom,$uname,$courseid);
7275: }
7276:
7277: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7278: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7279: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7280:
7281: $courselevel=$courseid.'.'.$spacequalifierrest;
7282: my $courselevelr=$courseid.'.'.$symbparm;
7283: $courselevelm=$courseid.'.'.$mapparm;
7284:
7285: # ----------------------------------------------------------- first, check user
7286:
7287: my $userreply=&resdata($uname,$udom,'user',
7288: ([$courselevelr,'resource'],
7289: [$courselevelm,'map' ],
7290: [$courselevel, 'course' ]));
7291: if (defined($userreply)) { return &get_reply($userreply); }
7292:
7293: # ------------------------------------------------ second, check some of course
7294: my $coursereply;
7295: if (@groups > 0) {
7296: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7297: $mapparm,$spacequalifierrest);
7298: if (defined($coursereply)) { return &get_reply($coursereply); }
7299: }
7300:
7301: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7302: $env{'course.'.$courseid.'.domain'},
7303: 'course',
7304: ([$seclevelr, 'resource'],
7305: [$seclevelm, 'map' ],
7306: [$seclevel, 'course' ],
7307: [$courselevelr,'resource']));
7308: if (defined($coursereply)) { return &get_reply($coursereply); }
7309:
7310: # ------------------------------------------------------ third, check map parms
7311: my %parmhash=();
7312: my $thisparm='';
7313: if (tie(%parmhash,'GDBM_File',
7314: $env{'request.course.fn'}.'_parms.db',
7315: &GDBM_READER(),0640)) {
7316: $thisparm=$parmhash{$symbparm};
7317: untie(%parmhash);
7318: }
7319: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
7320: }
7321: # ------------------------------------------ fourth, look in resource metadata
7322:
7323: $spacequalifierrest=~s/\./\_/;
7324: my $filename;
7325: if (!$symbparm) { $symbparm=&symbread(); }
7326: if ($symbparm) {
7327: $filename=(&decode_symb($symbparm))[2];
7328: } else {
7329: $filename=$env{'request.filename'};
7330: }
7331: my $metadata=&metadata($filename,$spacequalifierrest);
7332: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7333: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
7334: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7335:
7336: # ---------------------------------------------- fourth, look in rest of course
7337: if ($symbparm && defined($courseid) &&
7338: $courseid eq $env{'request.course.id'}) {
7339: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7340: $env{'course.'.$courseid.'.domain'},
7341: 'course',
7342: ([$courselevelm,'map' ],
7343: [$courselevel, 'course']));
7344: if (defined($coursereply)) { return &get_reply($coursereply); }
7345: }
7346: # ------------------------------------------------------------------ Cascade up
7347: unless ($space eq '0') {
7348: my @parts=split(/_/,$space);
7349: my $id=pop(@parts);
7350: my $part=join('_',@parts);
7351: if ($part eq '') { $part='0'; }
7352: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
7353: $symbparm,$udom,$uname,$section,1);
7354: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
7355: }
7356: if ($recurse) { return undef; }
7357: my $pack_def=&packages_tab_default($filename,$varname);
7358: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
7359: # ---------------------------------------------------- Any other user namespace
7360: } elsif ($realm eq 'environment') {
7361: # ----------------------------------------------------------------- environment
7362: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7363: return $env{'environment.'.$spacequalifierrest};
7364: } else {
7365: if ($uname eq 'anonymous' && $udom eq '') {
7366: return '';
7367: }
7368: my %returnhash=&userenvironment($udom,$uname,
7369: $spacequalifierrest);
7370: return $returnhash{$spacequalifierrest};
7371: }
7372: } elsif ($realm eq 'system') {
7373: # ----------------------------------------------------------------- system.time
7374: if ($space eq 'time') {
7375: return time;
7376: }
7377: } elsif ($realm eq 'server') {
7378: # ----------------------------------------------------------------- system.time
7379: if ($space eq 'name') {
7380: return $ENV{'SERVER_NAME'};
7381: }
7382: }
7383: return '';
7384: }
7385:
7386: sub get_reply {
7387: my ($reply_value) = @_;
7388: if (ref($reply_value) eq 'ARRAY') {
7389: if (wantarray) {
7390: return @$reply_value;
7391: }
7392: return $reply_value->[0];
7393: } else {
7394: return $reply_value;
7395: }
7396: }
7397:
7398: sub check_group_parms {
7399: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
7400: my @groupitems = ();
7401: my $resultitem;
7402: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
7403: foreach my $group (@{$groups}) {
7404: foreach my $level (@levels) {
7405: my $item = $courseid.'.['.$group.'].'.$level->[0];
7406: push(@groupitems,[$item,$level->[1]]);
7407: }
7408: }
7409: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
7410: $env{'course.'.$courseid.'.domain'},
7411: 'course',@groupitems);
7412: return $coursereply;
7413: }
7414:
7415: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
7416: my ($courseid,@groups) = @_;
7417: @groups = sort(@groups);
7418: return @groups;
7419: }
7420:
7421: sub packages_tab_default {
7422: my ($uri,$varname)=@_;
7423: my (undef,$part,$name)=split(/\./,$varname);
7424:
7425: my (@extension,@specifics,$do_default);
7426: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
7427: my ($pack_type,$pack_part)=split(/_/,$package,2);
7428: if ($pack_type eq 'default') {
7429: $do_default=1;
7430: } elsif ($pack_type eq 'extension') {
7431: push(@extension,[$package,$pack_type,$pack_part]);
7432: } elsif ($pack_part eq $part || $pack_type eq 'part') {
7433: # only look at packages defaults for packages that this id is
7434: push(@specifics,[$package,$pack_type,$pack_part]);
7435: }
7436: }
7437: # first look for a package that matches the requested part id
7438: foreach my $package (@specifics) {
7439: my (undef,$pack_type,$pack_part)=@{$package};
7440: next if ($pack_part ne $part);
7441: if (defined($packagetab{"$pack_type&$name&default"})) {
7442: return $packagetab{"$pack_type&$name&default"};
7443: }
7444: }
7445: # look for any possible matching non extension_ package
7446: foreach my $package (@specifics) {
7447: my (undef,$pack_type,$pack_part)=@{$package};
7448: if (defined($packagetab{"$pack_type&$name&default"})) {
7449: return $packagetab{"$pack_type&$name&default"};
7450: }
7451: if ($pack_type eq 'part') { $pack_part='0'; }
7452: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
7453: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
7454: }
7455: }
7456: # look for any posible extension_ match
7457: foreach my $package (@extension) {
7458: my ($package,$pack_type)=@{$package};
7459: if (defined($packagetab{"$pack_type&$name&default"})) {
7460: return $packagetab{"$pack_type&$name&default"};
7461: }
7462: if (defined($packagetab{$package."&$name&default"})) {
7463: return $packagetab{$package."&$name&default"};
7464: }
7465: }
7466: # look for a global default setting
7467: if ($do_default && defined($packagetab{"default&$name&default"})) {
7468: return $packagetab{"default&$name&default"};
7469: }
7470: return undef;
7471: }
7472:
7473: sub add_prefix_and_part {
7474: my ($prefix,$part)=@_;
7475: my $keyroot;
7476: if (defined($prefix) && $prefix !~ /^__/) {
7477: # prefix that has a part already
7478: $keyroot=$prefix;
7479: } elsif (defined($prefix)) {
7480: # prefix that is missing a part
7481: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
7482: } else {
7483: # no prefix at all
7484: if (defined($part)) { $keyroot='_'.$part; }
7485: }
7486: return $keyroot;
7487: }
7488:
7489: # ---------------------------------------------------------------- Get metadata
7490:
7491: my %metaentry;
7492: sub metadata {
7493: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
7494: $uri=&declutter($uri);
7495: # if it is a non metadata possible uri return quickly
7496: if (($uri eq '') ||
7497: (($uri =~ m|^/*adm/|) &&
7498: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
7499: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
7500: return undef;
7501: }
7502: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
7503: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
7504: return undef;
7505: }
7506: my $filename=$uri;
7507: $uri=~s/\.meta$//;
7508: #
7509: # Is the metadata already cached?
7510: # Look at timestamp of caching
7511: # Everything is cached by the main uri, libraries are never directly cached
7512: #
7513: if (!defined($liburi)) {
7514: my ($result,$cached)=&is_cached_new('meta',$uri);
7515: if (defined($cached)) { return $result->{':'.$what}; }
7516: }
7517: {
7518: #
7519: # Is this a recursive call for a library?
7520: #
7521: # if (! exists($metacache{$uri})) {
7522: # $metacache{$uri}={};
7523: # }
7524: my $cachetime = 60*60;
7525: if ($liburi) {
7526: $liburi=&declutter($liburi);
7527: $filename=$liburi;
7528: } else {
7529: &devalidate_cache_new('meta',$uri);
7530: undef(%metaentry);
7531: }
7532: my %metathesekeys=();
7533: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
7534: my $metastring;
7535: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
7536: my $which = &hreflocation('','/'.($liburi || $uri));
7537: $metastring =
7538: &Apache::lonnet::ssi_body($which,
7539: ('grade_target' => 'meta'));
7540: $cachetime = 1; # only want this cached in the child not long term
7541: } elsif ($uri !~ m -^(editupload)/-) {
7542: my $file=&filelocation('',&clutter($filename));
7543: #push(@{$metaentry{$uri.'.file'}},$file);
7544: $metastring=&getfile($file);
7545: }
7546: my $parser=HTML::LCParser->new(\$metastring);
7547: my $token;
7548: undef %metathesekeys;
7549: while ($token=$parser->get_token) {
7550: if ($token->[0] eq 'S') {
7551: if (defined($token->[2]->{'package'})) {
7552: #
7553: # This is a package - get package info
7554: #
7555: my $package=$token->[2]->{'package'};
7556: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7557: if (defined($token->[2]->{'id'})) {
7558: $keyroot.='_'.$token->[2]->{'id'};
7559: }
7560: if ($metaentry{':packages'}) {
7561: $metaentry{':packages'}.=','.$package.$keyroot;
7562: } else {
7563: $metaentry{':packages'}=$package.$keyroot;
7564: }
7565: foreach my $pack_entry (keys(%packagetab)) {
7566: my $part=$keyroot;
7567: $part=~s/^\_//;
7568: if ($pack_entry=~/^\Q$package\E\&/ ||
7569: $pack_entry=~/^\Q$package\E_0\&/) {
7570: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
7571: # ignore package.tab specified default values
7572: # here &package_tab_default() will fetch those
7573: if ($subp eq 'default') { next; }
7574: my $value=$packagetab{$pack_entry};
7575: my $unikey;
7576: if ($pack =~ /_0$/) {
7577: $unikey='parameter_0_'.$name;
7578: $part=0;
7579: } else {
7580: $unikey='parameter'.$keyroot.'_'.$name;
7581: }
7582: if ($subp eq 'display') {
7583: $value.=' [Part: '.$part.']';
7584: }
7585: $metaentry{':'.$unikey.'.part'}=$part;
7586: $metathesekeys{$unikey}=1;
7587: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7588: $metaentry{':'.$unikey.'.'.$subp}=$value;
7589: }
7590: if (defined($metaentry{':'.$unikey.'.default'})) {
7591: $metaentry{':'.$unikey}=
7592: $metaentry{':'.$unikey.'.default'};
7593: }
7594: }
7595: }
7596: } else {
7597: #
7598: # This is not a package - some other kind of start tag
7599: #
7600: my $entry=$token->[1];
7601: my $unikey;
7602: if ($entry eq 'import') {
7603: $unikey='';
7604: } else {
7605: $unikey=$entry;
7606: }
7607: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7608:
7609: if (defined($token->[2]->{'id'})) {
7610: $unikey.='_'.$token->[2]->{'id'};
7611: }
7612:
7613: if ($entry eq 'import') {
7614: #
7615: # Importing a library here
7616: #
7617: if ($depthcount<20) {
7618: my $location=$parser->get_text('/import');
7619: my $dir=$filename;
7620: $dir=~s|[^/]*$||;
7621: $location=&filelocation($dir,$location);
7622: my $metadata =
7623: &metadata($uri,'keys', $location,$unikey,
7624: $depthcount+1);
7625: foreach my $meta (split(',',$metadata)) {
7626: $metaentry{':'.$meta}=$metaentry{':'.$meta};
7627: $metathesekeys{$meta}=1;
7628: }
7629: }
7630: } else {
7631:
7632: if (defined($token->[2]->{'name'})) {
7633: $unikey.='_'.$token->[2]->{'name'};
7634: }
7635: $metathesekeys{$unikey}=1;
7636: foreach my $param (@{$token->[3]}) {
7637: $metaentry{':'.$unikey.'.'.$param} =
7638: $token->[2]->{$param};
7639: }
7640: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
7641: my $default=$metaentry{':'.$unikey.'.default'};
7642: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
7643: # only ws inside the tag, and not in default, so use default
7644: # as value
7645: $metaentry{':'.$unikey}=$default;
7646: } elsif ( $internaltext =~ /\S/ ) {
7647: # something interesting inside the tag
7648: $metaentry{':'.$unikey}=$internaltext;
7649: } else {
7650: # no interesting values, don't set a default
7651: }
7652: # end of not-a-package not-a-library import
7653: }
7654: # end of not-a-package start tag
7655: }
7656: # the next is the end of "start tag"
7657: }
7658: }
7659: my ($extension) = ($uri =~ /\.(\w+)$/);
7660: $extension = lc($extension);
7661: if ($extension eq 'htm') { $extension='html'; }
7662:
7663: foreach my $key (keys(%packagetab)) {
7664: #no specific packages #how's our extension
7665: if ($key!~/^extension_\Q$extension\E&/) { next; }
7666: &metadata_create_package_def($uri,$key,'extension_'.$extension,
7667: \%metathesekeys);
7668: }
7669:
7670: if (!exists($metaentry{':packages'})
7671: || $packagetab{"import_defaults&extension_$extension"}) {
7672: foreach my $key (keys(%packagetab)) {
7673: #no specific packages well let's get default then
7674: if ($key!~/^default&/) { next; }
7675: &metadata_create_package_def($uri,$key,'default',
7676: \%metathesekeys);
7677: }
7678: }
7679: # are there custom rights to evaluate
7680: if ($metaentry{':copyright'} eq 'custom') {
7681:
7682: #
7683: # Importing a rights file here
7684: #
7685: unless ($depthcount) {
7686: my $location=$metaentry{':customdistributionfile'};
7687: my $dir=$filename;
7688: $dir=~s|[^/]*$||;
7689: $location=&filelocation($dir,$location);
7690: my $rights_metadata =
7691: &metadata($uri,'keys',$location,'_rights',
7692: $depthcount+1);
7693: foreach my $rights (split(',',$rights_metadata)) {
7694: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
7695: $metathesekeys{$rights}=1;
7696: }
7697: }
7698: }
7699: # uniqifiy package listing
7700: my %seen;
7701: my @uniq_packages =
7702: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
7703: $metaentry{':packages'} = join(',',@uniq_packages);
7704:
7705: $metaentry{':keys'} = join(',',keys(%metathesekeys));
7706: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
7707: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
7708: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
7709: # this is the end of "was not already recently cached
7710: }
7711: return $metaentry{':'.$what};
7712: }
7713:
7714: sub metadata_create_package_def {
7715: my ($uri,$key,$package,$metathesekeys)=@_;
7716: my ($pack,$name,$subp)=split(/\&/,$key);
7717: if ($subp eq 'default') { next; }
7718:
7719: if (defined($metaentry{':packages'})) {
7720: $metaentry{':packages'}.=','.$package;
7721: } else {
7722: $metaentry{':packages'}=$package;
7723: }
7724: my $value=$packagetab{$key};
7725: my $unikey;
7726: $unikey='parameter_0_'.$name;
7727: $metaentry{':'.$unikey.'.part'}=0;
7728: $$metathesekeys{$unikey}=1;
7729: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7730: $metaentry{':'.$unikey.'.'.$subp}=$value;
7731: }
7732: if (defined($metaentry{':'.$unikey.'.default'})) {
7733: $metaentry{':'.$unikey}=
7734: $metaentry{':'.$unikey.'.default'};
7735: }
7736: }
7737:
7738: sub metadata_generate_part0 {
7739: my ($metadata,$metacache,$uri) = @_;
7740: my %allnames;
7741: foreach my $metakey (keys(%$metadata)) {
7742: if ($metakey=~/^parameter\_(.*)/) {
7743: my $part=$$metacache{':'.$metakey.'.part'};
7744: my $name=$$metacache{':'.$metakey.'.name'};
7745: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
7746: $allnames{$name}=$part;
7747: }
7748: }
7749: }
7750: foreach my $name (keys(%allnames)) {
7751: $$metadata{"parameter_0_$name"}=1;
7752: my $key=":parameter_0_$name";
7753: $$metacache{"$key.part"}='0';
7754: $$metacache{"$key.name"}=$name;
7755: $$metacache{"$key.type"}=$$metacache{':parameter_'.
7756: $allnames{$name}.'_'.$name.
7757: '.type'};
7758: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
7759: '.display'};
7760: my $expr='[Part: '.$allnames{$name}.']';
7761: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
7762: $$metacache{"$key.display"}=$olddis;
7763: }
7764: }
7765:
7766: # ------------------------------------------------------ Devalidate title cache
7767:
7768: sub devalidate_title_cache {
7769: my ($url)=@_;
7770: if (!$env{'request.course.id'}) { return; }
7771: my $symb=&symbread($url);
7772: if (!$symb) { return; }
7773: my $key=$env{'request.course.id'}."\0".$symb;
7774: &devalidate_cache_new('title',$key);
7775: }
7776:
7777: # ------------------------------------------------- Get the title of a resource
7778:
7779: sub gettitle {
7780: my $urlsymb=shift;
7781: my $symb=&symbread($urlsymb);
7782: if ($symb) {
7783: my $key=$env{'request.course.id'}."\0".$symb;
7784: my ($result,$cached)=&is_cached_new('title',$key);
7785: if (defined($cached)) {
7786: return $result;
7787: }
7788: my ($map,$resid,$url)=&decode_symb($symb);
7789: my $title='';
7790: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
7791: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
7792: } else {
7793: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7794: &GDBM_READER(),0640)) {
7795: my $mapid=$bighash{'map_pc_'.&clutter($map)};
7796: $title=$bighash{'title_'.$mapid.'.'.$resid};
7797: untie(%bighash);
7798: }
7799: }
7800: $title=~s/\&colon\;/\:/gs;
7801: if ($title) {
7802: return &do_cache_new('title',$key,$title,600);
7803: }
7804: $urlsymb=$url;
7805: }
7806: my $title=&metadata($urlsymb,'title');
7807: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
7808: return $title;
7809: }
7810:
7811: sub get_slot {
7812: my ($which,$cnum,$cdom)=@_;
7813: if (!$cnum || !$cdom) {
7814: (undef,my $courseid)=&whichuser();
7815: $cdom=$env{'course.'.$courseid.'.domain'};
7816: $cnum=$env{'course.'.$courseid.'.num'};
7817: }
7818: my $key=join("\0",'slots',$cdom,$cnum,$which);
7819: my %slotinfo;
7820: if (exists($remembered{$key})) {
7821: $slotinfo{$which} = $remembered{$key};
7822: } else {
7823: %slotinfo=&get('slots',[$which],$cdom,$cnum);
7824: &Apache::lonhomework::showhash(%slotinfo);
7825: my ($tmp)=keys(%slotinfo);
7826: if ($tmp=~/^error:/) { return (); }
7827: $remembered{$key} = $slotinfo{$which};
7828: }
7829: if (ref($slotinfo{$which}) eq 'HASH') {
7830: return %{$slotinfo{$which}};
7831: }
7832: return $slotinfo{$which};
7833: }
7834: # ------------------------------------------------- Update symbolic store links
7835:
7836: sub symblist {
7837: my ($mapname,%newhash)=@_;
7838: $mapname=&deversion(&declutter($mapname));
7839: my %hash;
7840: if (($env{'request.course.fn'}) && (%newhash)) {
7841: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7842: &GDBM_WRCREAT(),0640)) {
7843: foreach my $url (keys %newhash) {
7844: next if ($url eq 'last_known'
7845: && $env{'form.no_update_last_known'});
7846: $hash{declutter($url)}=&encode_symb($mapname,
7847: $newhash{$url}->[1],
7848: $newhash{$url}->[0]);
7849: }
7850: if (untie(%hash)) {
7851: return 'ok';
7852: }
7853: }
7854: }
7855: return 'error';
7856: }
7857:
7858: # --------------------------------------------------------------- Verify a symb
7859:
7860: sub symbverify {
7861: my ($symb,$thisurl)=@_;
7862: my $thisfn=$thisurl;
7863: $thisfn=&declutter($thisfn);
7864: # direct jump to resource in page or to a sequence - will construct own symbs
7865: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
7866: # check URL part
7867: my ($map,$resid,$url)=&decode_symb($symb);
7868:
7869: unless ($url eq $thisfn) { return 0; }
7870:
7871: $symb=&symbclean($symb);
7872: $thisurl=&deversion($thisurl);
7873: $thisfn=&deversion($thisfn);
7874:
7875: my %bighash;
7876: my $okay=0;
7877:
7878: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7879: &GDBM_READER(),0640)) {
7880: my $ids=$bighash{'ids_'.&clutter($thisurl)};
7881: unless ($ids) {
7882: $ids=$bighash{'ids_/'.$thisurl};
7883: }
7884: if ($ids) {
7885: # ------------------------------------------------------------------- Has ID(s)
7886: foreach my $id (split(/\,/,$ids)) {
7887: my ($mapid,$resid)=split(/\./,$id);
7888: if (
7889: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
7890: eq $symb) {
7891: if (($env{'request.role.adv'}) ||
7892: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
7893: $okay=1;
7894: }
7895: }
7896: }
7897: }
7898: untie(%bighash);
7899: }
7900: return $okay;
7901: }
7902:
7903: # --------------------------------------------------------------- Clean-up symb
7904:
7905: sub symbclean {
7906: my $symb=shift;
7907: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7908: # remove version from map
7909: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
7910:
7911: # remove version from URL
7912: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
7913:
7914: # remove wrapper
7915:
7916: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
7917: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
7918: return $symb;
7919: }
7920:
7921: # ---------------------------------------------- Split symb to find map and url
7922:
7923: sub encode_symb {
7924: my ($map,$resid,$url)=@_;
7925: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
7926: }
7927:
7928: sub decode_symb {
7929: my $symb=shift;
7930: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7931: my ($map,$resid,$url)=split(/___/,$symb);
7932: return (&fixversion($map),$resid,&fixversion($url));
7933: }
7934:
7935: sub fixversion {
7936: my $fn=shift;
7937: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
7938: my %bighash;
7939: my $uri=&clutter($fn);
7940: my $key=$env{'request.course.id'}.'_'.$uri;
7941: # is this cached?
7942: my ($result,$cached)=&is_cached_new('courseresversion',$key);
7943: if (defined($cached)) { return $result; }
7944: # unfortunately not cached, or expired
7945: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7946: &GDBM_READER(),0640)) {
7947: if ($bighash{'version_'.$uri}) {
7948: my $version=$bighash{'version_'.$uri};
7949: unless (($version eq 'mostrecent') ||
7950: ($version==&getversion($uri))) {
7951: $uri=~s/\.(\w+)$/\.$version\.$1/;
7952: }
7953: }
7954: untie %bighash;
7955: }
7956: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
7957: }
7958:
7959: sub deversion {
7960: my $url=shift;
7961: $url=~s/\.\d+\.(\w+)$/\.$1/;
7962: return $url;
7963: }
7964:
7965: # ------------------------------------------------------ Return symb list entry
7966:
7967: sub symbread {
7968: my ($thisfn,$donotrecurse)=@_;
7969: my $cache_str='request.symbread.cached.'.$thisfn;
7970: if (defined($env{$cache_str})) { return $env{$cache_str}; }
7971: # no filename provided? try from environment
7972: unless ($thisfn) {
7973: if ($env{'request.symb'}) {
7974: return $env{$cache_str}=&symbclean($env{'request.symb'});
7975: }
7976: $thisfn=$env{'request.filename'};
7977: }
7978: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7979: # is that filename actually a symb? Verify, clean, and return
7980: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
7981: if (&symbverify($thisfn,$1)) {
7982: return $env{$cache_str}=&symbclean($thisfn);
7983: }
7984: }
7985: $thisfn=declutter($thisfn);
7986: my %hash;
7987: my %bighash;
7988: my $syval='';
7989: if (($env{'request.course.fn'}) && ($thisfn)) {
7990: my $targetfn = $thisfn;
7991: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
7992: $targetfn = 'adm/wrapper/'.$thisfn;
7993: }
7994: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
7995: $targetfn=$1;
7996: }
7997: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7998: &GDBM_READER(),0640)) {
7999: $syval=$hash{$targetfn};
8000: untie(%hash);
8001: }
8002: # ---------------------------------------------------------- There was an entry
8003: if ($syval) {
8004: #unless ($syval=~/\_\d+$/) {
8005: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
8006: #&appenv({'request.ambiguous' => $thisfn});
8007: #return $env{$cache_str}='';
8008: #}
8009: #$syval.=$1;
8010: #}
8011: } else {
8012: # ------------------------------------------------------- Was not in symb table
8013: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8014: &GDBM_READER(),0640)) {
8015: # ---------------------------------------------- Get ID(s) for current resource
8016: my $ids=$bighash{'ids_'.&clutter($thisfn)};
8017: unless ($ids) {
8018: $ids=$bighash{'ids_/'.$thisfn};
8019: }
8020: unless ($ids) {
8021: # alias?
8022: $ids=$bighash{'mapalias_'.$thisfn};
8023: }
8024: if ($ids) {
8025: # ------------------------------------------------------------------- Has ID(s)
8026: my @possibilities=split(/\,/,$ids);
8027: if ($#possibilities==0) {
8028: # ----------------------------------------------- There is only one possibility
8029: my ($mapid,$resid)=split(/\./,$ids);
8030: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8031: $resid,$thisfn);
8032: } elsif (!$donotrecurse) {
8033: # ------------------------------------------ There is more than one possibility
8034: my $realpossible=0;
8035: foreach my $id (@possibilities) {
8036: my $file=$bighash{'src_'.$id};
8037: if (&allowed('bre',$file)) {
8038: my ($mapid,$resid)=split(/\./,$id);
8039: if ($bighash{'map_type_'.$mapid} ne 'page') {
8040: $realpossible++;
8041: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8042: $resid,$thisfn);
8043: }
8044: }
8045: }
8046: if ($realpossible!=1) { $syval=''; }
8047: } else {
8048: $syval='';
8049: }
8050: }
8051: untie(%bighash)
8052: }
8053: }
8054: if ($syval) {
8055: return $env{$cache_str}=$syval;
8056: }
8057: }
8058: &appenv({'request.ambiguous' => $thisfn});
8059: return $env{$cache_str}='';
8060: }
8061:
8062: # ---------------------------------------------------------- Return random seed
8063:
8064: sub numval {
8065: my $txt=shift;
8066: $txt=~tr/A-J/0-9/;
8067: $txt=~tr/a-j/0-9/;
8068: $txt=~tr/K-T/0-9/;
8069: $txt=~tr/k-t/0-9/;
8070: $txt=~tr/U-Z/0-5/;
8071: $txt=~tr/u-z/0-5/;
8072: $txt=~s/\D//g;
8073: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8074: return int($txt);
8075: }
8076:
8077: sub numval2 {
8078: my $txt=shift;
8079: $txt=~tr/A-J/0-9/;
8080: $txt=~tr/a-j/0-9/;
8081: $txt=~tr/K-T/0-9/;
8082: $txt=~tr/k-t/0-9/;
8083: $txt=~tr/U-Z/0-5/;
8084: $txt=~tr/u-z/0-5/;
8085: $txt=~s/\D//g;
8086: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8087: my $total;
8088: foreach my $val (@txts) { $total+=$val; }
8089: if ($_64bit) { if ($total > 2**32) { return -1; } }
8090: return int($total);
8091: }
8092:
8093: sub numval3 {
8094: use integer;
8095: my $txt=shift;
8096: $txt=~tr/A-J/0-9/;
8097: $txt=~tr/a-j/0-9/;
8098: $txt=~tr/K-T/0-9/;
8099: $txt=~tr/k-t/0-9/;
8100: $txt=~tr/U-Z/0-5/;
8101: $txt=~tr/u-z/0-5/;
8102: $txt=~s/\D//g;
8103: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8104: my $total;
8105: foreach my $val (@txts) { $total+=$val; }
8106: if ($_64bit) { $total=(($total<<32)>>32); }
8107: return $total;
8108: }
8109:
8110: sub digest {
8111: my ($data)=@_;
8112: my $digest=&Digest::MD5::md5($data);
8113: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8114: my ($e,$f);
8115: {
8116: use integer;
8117: $e=($a+$b);
8118: $f=($c+$d);
8119: if ($_64bit) {
8120: $e=(($e<<32)>>32);
8121: $f=(($f<<32)>>32);
8122: }
8123: }
8124: if (wantarray) {
8125: return ($e,$f);
8126: } else {
8127: my $g;
8128: {
8129: use integer;
8130: $g=($e+$f);
8131: if ($_64bit) {
8132: $g=(($g<<32)>>32);
8133: }
8134: }
8135: return $g;
8136: }
8137: }
8138:
8139: sub latest_rnd_algorithm_id {
8140: return '64bit5';
8141: }
8142:
8143: sub get_rand_alg {
8144: my ($courseid)=@_;
8145: if (!$courseid) { $courseid=(&whichuser())[1]; }
8146: if ($courseid) {
8147: return $env{"course.$courseid.rndseed"};
8148: }
8149: return &latest_rnd_algorithm_id();
8150: }
8151:
8152: sub validCODE {
8153: my ($CODE)=@_;
8154: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8155: return 0;
8156: }
8157:
8158: sub getCODE {
8159: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8160: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8161: defined($Apache::lonhomework::parsing_a_task) ) &&
8162: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8163: return $Apache::lonhomework::history{'resource.CODE'};
8164: }
8165: return undef;
8166: }
8167:
8168: sub rndseed {
8169: my ($symb,$courseid,$domain,$username)=@_;
8170: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
8171: if (!defined($symb)) {
8172: unless ($symb=$wsymb) { return time; }
8173: }
8174: if (!$courseid) { $courseid=$wcourseid; }
8175: if (!$domain) { $domain=$wdomain; }
8176: if (!$username) { $username=$wusername }
8177: my $which=&get_rand_alg();
8178:
8179: if (defined(&getCODE())) {
8180: if ($which eq '64bit5') {
8181: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8182: } elsif ($which eq '64bit4') {
8183: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8184: } else {
8185: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8186: }
8187: } elsif ($which eq '64bit5') {
8188: return &rndseed_64bit5($symb,$courseid,$domain,$username);
8189: } elsif ($which eq '64bit4') {
8190: return &rndseed_64bit4($symb,$courseid,$domain,$username);
8191: } elsif ($which eq '64bit3') {
8192: return &rndseed_64bit3($symb,$courseid,$domain,$username);
8193: } elsif ($which eq '64bit2') {
8194: return &rndseed_64bit2($symb,$courseid,$domain,$username);
8195: } elsif ($which eq '64bit') {
8196: return &rndseed_64bit($symb,$courseid,$domain,$username);
8197: }
8198: return &rndseed_32bit($symb,$courseid,$domain,$username);
8199: }
8200:
8201: sub rndseed_32bit {
8202: my ($symb,$courseid,$domain,$username)=@_;
8203: {
8204: use integer;
8205: my $symbchck=unpack("%32C*",$symb) << 27;
8206: my $symbseed=numval($symb) << 22;
8207: my $namechck=unpack("%32C*",$username) << 17;
8208: my $nameseed=numval($username) << 12;
8209: my $domainseed=unpack("%32C*",$domain) << 7;
8210: my $courseseed=unpack("%32C*",$courseid);
8211: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
8212: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8213: #&logthis("rndseed :$num:$symb");
8214: if ($_64bit) { $num=(($num<<32)>>32); }
8215: return $num;
8216: }
8217: }
8218:
8219: sub rndseed_64bit {
8220: my ($symb,$courseid,$domain,$username)=@_;
8221: {
8222: use integer;
8223: my $symbchck=unpack("%32S*",$symb) << 21;
8224: my $symbseed=numval($symb) << 10;
8225: my $namechck=unpack("%32S*",$username);
8226:
8227: my $nameseed=numval($username) << 21;
8228: my $domainseed=unpack("%32S*",$domain) << 10;
8229: my $courseseed=unpack("%32S*",$courseid);
8230:
8231: my $num1=$symbchck+$symbseed+$namechck;
8232: my $num2=$nameseed+$domainseed+$courseseed;
8233: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8234: #&logthis("rndseed :$num:$symb");
8235: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8236: return "$num1,$num2";
8237: }
8238: }
8239:
8240: sub rndseed_64bit2 {
8241: my ($symb,$courseid,$domain,$username)=@_;
8242: {
8243: use integer;
8244: # strings need to be an even # of cahracters long, it it is odd the
8245: # last characters gets thrown away
8246: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8247: my $symbseed=numval($symb) << 10;
8248: my $namechck=unpack("%32S*",$username.' ');
8249:
8250: my $nameseed=numval($username) << 21;
8251: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8252: my $courseseed=unpack("%32S*",$courseid.' ');
8253:
8254: my $num1=$symbchck+$symbseed+$namechck;
8255: my $num2=$nameseed+$domainseed+$courseseed;
8256: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8257: #&logthis("rndseed :$num:$symb");
8258: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8259: return "$num1,$num2";
8260: }
8261: }
8262:
8263: sub rndseed_64bit3 {
8264: my ($symb,$courseid,$domain,$username)=@_;
8265: {
8266: use integer;
8267: # strings need to be an even # of cahracters long, it it is odd the
8268: # last characters gets thrown away
8269: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8270: my $symbseed=numval2($symb) << 10;
8271: my $namechck=unpack("%32S*",$username.' ');
8272:
8273: my $nameseed=numval2($username) << 21;
8274: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8275: my $courseseed=unpack("%32S*",$courseid.' ');
8276:
8277: my $num1=$symbchck+$symbseed+$namechck;
8278: my $num2=$nameseed+$domainseed+$courseseed;
8279: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8280: #&logthis("rndseed :$num1:$num2:$_64bit");
8281: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8282:
8283: return "$num1:$num2";
8284: }
8285: }
8286:
8287: sub rndseed_64bit4 {
8288: my ($symb,$courseid,$domain,$username)=@_;
8289: {
8290: use integer;
8291: # strings need to be an even # of cahracters long, it it is odd the
8292: # last characters gets thrown away
8293: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8294: my $symbseed=numval3($symb) << 10;
8295: my $namechck=unpack("%32S*",$username.' ');
8296:
8297: my $nameseed=numval3($username) << 21;
8298: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8299: my $courseseed=unpack("%32S*",$courseid.' ');
8300:
8301: my $num1=$symbchck+$symbseed+$namechck;
8302: my $num2=$nameseed+$domainseed+$courseseed;
8303: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8304: #&logthis("rndseed :$num1:$num2:$_64bit");
8305: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8306:
8307: return "$num1:$num2";
8308: }
8309: }
8310:
8311: sub rndseed_64bit5 {
8312: my ($symb,$courseid,$domain,$username)=@_;
8313: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8314: return "$num1:$num2";
8315: }
8316:
8317: sub rndseed_CODE_64bit {
8318: my ($symb,$courseid,$domain,$username)=@_;
8319: {
8320: use integer;
8321: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8322: my $symbseed=numval2($symb);
8323: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8324: my $CODEseed=numval(&getCODE());
8325: my $courseseed=unpack("%32S*",$courseid.' ');
8326: my $num1=$symbseed+$CODEchck;
8327: my $num2=$CODEseed+$courseseed+$symbchck;
8328: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8329: #&logthis("rndseed :$num1:$num2:$symb");
8330: if ($_64bit) { $num1=(($num1<<32)>>32); }
8331: if ($_64bit) { $num2=(($num2<<32)>>32); }
8332: return "$num1:$num2";
8333: }
8334: }
8335:
8336: sub rndseed_CODE_64bit4 {
8337: my ($symb,$courseid,$domain,$username)=@_;
8338: {
8339: use integer;
8340: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8341: my $symbseed=numval3($symb);
8342: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8343: my $CODEseed=numval3(&getCODE());
8344: my $courseseed=unpack("%32S*",$courseid.' ');
8345: my $num1=$symbseed+$CODEchck;
8346: my $num2=$CODEseed+$courseseed+$symbchck;
8347: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8348: #&logthis("rndseed :$num1:$num2:$symb");
8349: if ($_64bit) { $num1=(($num1<<32)>>32); }
8350: if ($_64bit) { $num2=(($num2<<32)>>32); }
8351: return "$num1:$num2";
8352: }
8353: }
8354:
8355: sub rndseed_CODE_64bit5 {
8356: my ($symb,$courseid,$domain,$username)=@_;
8357: my $code = &getCODE();
8358: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8359: return "$num1:$num2";
8360: }
8361:
8362: sub setup_random_from_rndseed {
8363: my ($rndseed)=@_;
8364: if ($rndseed =~/([,:])/) {
8365: my ($num1,$num2)=split(/[,:]/,$rndseed);
8366: &Math::Random::random_set_seed(abs($num1),abs($num2));
8367: } else {
8368: &Math::Random::random_set_seed_from_phrase($rndseed);
8369: }
8370: }
8371:
8372: sub latest_receipt_algorithm_id {
8373: return 'receipt3';
8374: }
8375:
8376: sub recunique {
8377: my $fucourseid=shift;
8378: my $unique;
8379: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
8380: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8381: $unique=$env{"course.$fucourseid.internal.encseed"};
8382: } else {
8383: $unique=$perlvar{'lonReceipt'};
8384: }
8385: return unpack("%32C*",$unique);
8386: }
8387:
8388: sub recprefix {
8389: my $fucourseid=shift;
8390: my $prefix;
8391: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
8392: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8393: $prefix=$env{"course.$fucourseid.internal.encpref"};
8394: } else {
8395: $prefix=$perlvar{'lonHostID'};
8396: }
8397: return unpack("%32C*",$prefix);
8398: }
8399:
8400: sub ireceipt {
8401: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
8402:
8403: my $return =&recprefix($fucourseid).'-';
8404:
8405: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
8406: $env{'request.state'} eq 'construct') {
8407: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
8408: return $return;
8409: }
8410:
8411: my $cuname=unpack("%32C*",$funame);
8412: my $cudom=unpack("%32C*",$fudom);
8413: my $cucourseid=unpack("%32C*",$fucourseid);
8414: my $cusymb=unpack("%32C*",$fusymb);
8415: my $cunique=&recunique($fucourseid);
8416: my $cpart=unpack("%32S*",$part);
8417: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
8418:
8419: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
8420:
8421: $return.= ($cunique%$cuname+
8422: $cunique%$cudom+
8423: $cusymb%$cuname+
8424: $cusymb%$cudom+
8425: $cucourseid%$cuname+
8426: $cucourseid%$cudom+
8427: $cpart%$cuname+
8428: $cpart%$cudom);
8429: } else {
8430: $return.= ($cunique%$cuname+
8431: $cunique%$cudom+
8432: $cusymb%$cuname+
8433: $cusymb%$cudom+
8434: $cucourseid%$cuname+
8435: $cucourseid%$cudom);
8436: }
8437: return $return;
8438: }
8439:
8440: sub receipt {
8441: my ($part)=@_;
8442: my ($symb,$courseid,$domain,$name) = &whichuser();
8443: return &ireceipt($name,$domain,$courseid,$symb,$part);
8444: }
8445:
8446: sub whichuser {
8447: my ($passedsymb)=@_;
8448: my ($symb,$courseid,$domain,$name,$publicuser);
8449: if (defined($env{'form.grade_symb'})) {
8450: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
8451: my $allowed=&allowed('vgr',$tmp_courseid);
8452: if (!$allowed &&
8453: exists($env{'request.course.sec'}) &&
8454: $env{'request.course.sec'} !~ /^\s*$/) {
8455: $allowed=&allowed('vgr',$tmp_courseid.
8456: '/'.$env{'request.course.sec'});
8457: }
8458: if ($allowed) {
8459: ($symb)=&get_env_multiple('form.grade_symb');
8460: $courseid=$tmp_courseid;
8461: ($domain)=&get_env_multiple('form.grade_domain');
8462: ($name)=&get_env_multiple('form.grade_username');
8463: return ($symb,$courseid,$domain,$name,$publicuser);
8464: }
8465: }
8466: if (!$passedsymb) {
8467: $symb=&symbread();
8468: } else {
8469: $symb=$passedsymb;
8470: }
8471: $courseid=$env{'request.course.id'};
8472: $domain=$env{'user.domain'};
8473: $name=$env{'user.name'};
8474: if ($name eq 'public' && $domain eq 'public') {
8475: if (!defined($env{'form.username'})) {
8476: $env{'form.username'}.=time.rand(10000000);
8477: }
8478: $name.=$env{'form.username'};
8479: }
8480: return ($symb,$courseid,$domain,$name,$publicuser);
8481:
8482: }
8483:
8484: # ------------------------------------------------------------ Serves up a file
8485: # returns either the contents of the file or
8486: # -1 if the file doesn't exist
8487: #
8488: # if the target is a file that was uploaded via DOCS,
8489: # a check will be made to see if a current copy exists on the local server,
8490: # if it does this will be served, otherwise a copy will be retrieved from
8491: # the home server for the course and stored in /home/httpd/html/userfiles on
8492: # the local server.
8493:
8494: sub getfile {
8495: my ($file) = @_;
8496: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
8497: &repcopy($file);
8498: return &readfile($file);
8499: }
8500:
8501: sub repcopy_userfile {
8502: my ($file)=@_;
8503: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
8504: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
8505: my ($cdom,$cnum,$filename) =
8506: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
8507: my $uri="/uploaded/$cdom/$cnum/$filename";
8508: if (-e "$file") {
8509: # we already have a local copy, check it out
8510: my @fileinfo = stat($file);
8511: my $rtncode;
8512: my $info;
8513: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
8514: if ($lwpresp ne 'ok') {
8515: # there is no such file anymore, even though we had a local copy
8516: if ($rtncode eq '404') {
8517: unlink($file);
8518: }
8519: return -1;
8520: }
8521: if ($info < $fileinfo[9]) {
8522: # nice, the file we have is up-to-date, just say okay
8523: return 'ok';
8524: } else {
8525: # the file is outdated, get rid of it
8526: unlink($file);
8527: }
8528: }
8529: # one way or the other, at this point, we don't have the file
8530: # construct the correct path for the file
8531: my @parts = ($cdom,$cnum);
8532: if ($filename =~ m|^(.+)/[^/]+$|) {
8533: push @parts, split(/\//,$1);
8534: }
8535: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
8536: foreach my $part (@parts) {
8537: $path .= '/'.$part;
8538: if (!-e $path) {
8539: mkdir($path,0770);
8540: }
8541: }
8542: # now the path exists for sure
8543: # get a user agent
8544: my $ua=new LWP::UserAgent;
8545: my $transferfile=$file.'.in.transfer';
8546: # FIXME: this should flock
8547: if (-e $transferfile) { return 'ok'; }
8548: my $request;
8549: $uri=~s/^\///;
8550: my $homeserver = &homeserver($cnum,$cdom);
8551: my $protocol = $protocol{$homeserver};
8552: $protocol = 'http' if ($protocol ne 'https');
8553: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
8554: my $response=$ua->request($request,$transferfile);
8555: # did it work?
8556: if ($response->is_error()) {
8557: unlink($transferfile);
8558: &logthis("Userfile repcopy failed for $uri");
8559: return -1;
8560: }
8561: # worked, rename the transfer file
8562: rename($transferfile,$file);
8563: return 'ok';
8564: }
8565:
8566: sub tokenwrapper {
8567: my $uri=shift;
8568: $uri=~s|^https?\://([^/]+)||;
8569: $uri=~s|^/||;
8570: $env{'user.environment'}=~/\/([^\/]+)\.id/;
8571: my $token=$1;
8572: my (undef,$udom,$uname,$file)=split('/',$uri,4);
8573: if ($udom && $uname && $file) {
8574: $file=~s|(\?\.*)*$||;
8575: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
8576: my $homeserver = &homeserver($uname,$udom);
8577: my $protocol = $protocol{$homeserver};
8578: $protocol = 'http' if ($protocol ne 'https');
8579: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
8580: (($uri=~/\?/)?'&':'?').'token='.$token.
8581: '&tokenissued='.$perlvar{'lonHostID'};
8582: } else {
8583: return '/adm/notfound.html';
8584: }
8585: }
8586:
8587: # call with reqtype HEAD: get last modification time
8588: # call with reqtype GET: get the file contents
8589: # Do not call this with reqtype GET for large files! It loads everything into memory
8590: #
8591: sub getuploaded {
8592: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
8593: $uri=~s/^\///;
8594: my $homeserver = &homeserver($cnum,$cdom);
8595: my $protocol = $protocol{$homeserver};
8596: $protocol = 'http' if ($protocol ne 'https');
8597: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
8598: my $ua=new LWP::UserAgent;
8599: my $request=new HTTP::Request($reqtype,$uri);
8600: my $response=$ua->request($request);
8601: $$rtncode = $response->code;
8602: if (! $response->is_success()) {
8603: return 'failed';
8604: }
8605: if ($reqtype eq 'HEAD') {
8606: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
8607: } elsif ($reqtype eq 'GET') {
8608: $$info = $response->content;
8609: }
8610: return 'ok';
8611: }
8612:
8613: sub readfile {
8614: my $file = shift;
8615: if ( (! -e $file ) || ($file eq '') ) { return -1; };
8616: my $fh;
8617: open($fh,"<$file");
8618: my $a='';
8619: while (my $line = <$fh>) { $a .= $line; }
8620: return $a;
8621: }
8622:
8623: sub filelocation {
8624: my ($dir,$file) = @_;
8625: my $location;
8626: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
8627:
8628: if ($file =~ m-^/adm/-) {
8629: $file=~s-^/adm/wrapper/-/-;
8630: $file=~s-^/adm/coursedocs/showdoc/-/-;
8631: }
8632:
8633: if ($file=~m:^/~:) { # is a contruction space reference
8634: $location = $file;
8635: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
8636: } elsif ($file=~m{^/home/$match_username/public_html/}) {
8637: # is a correct contruction space reference
8638: $location = $file;
8639: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
8640: $location = $file;
8641: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
8642: my ($udom,$uname,$filename)=
8643: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
8644: my $home=&homeserver($uname,$udom);
8645: my $is_me=0;
8646: my @ids=¤t_machine_ids();
8647: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
8648: if ($is_me) {
8649: $location=&propath($udom,$uname).'/userfiles/'.$filename;
8650: } else {
8651: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
8652: $udom.'/'.$uname.'/'.$filename;
8653: }
8654: } elsif ($file =~ m-^/adm/-) {
8655: $location = $perlvar{'lonDocRoot'}.'/'.$file;
8656: } else {
8657: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8658: $file=~s:^/res/:/:;
8659: if ( !( $file =~ m:^/:) ) {
8660: $location = $dir. '/'.$file;
8661: } else {
8662: $location = '/home/httpd/html/res'.$file;
8663: }
8664: }
8665: $location=~s://+:/:g; # remove duplicate /
8666: while ($location=~m{/\.\./}) {
8667: if ($location =~ m{/[^/]+/\.\./}) {
8668: $location=~ s{/[^/]+/\.\./}{/}g;
8669: } else {
8670: $location=~ s{/\.\./}{/}g;
8671: }
8672: } #remove dir/..
8673: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
8674: return $location;
8675: }
8676:
8677: sub hreflocation {
8678: my ($dir,$file)=@_;
8679: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
8680: $file=filelocation($dir,$file);
8681: } elsif ($file=~m-^/adm/-) {
8682: $file=~s-^/adm/wrapper/-/-;
8683: $file=~s-^/adm/coursedocs/showdoc/-/-;
8684: }
8685: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
8686: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
8687: } elsif ($file=~m-/home/($match_username)/public_html/-) {
8688: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
8689: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
8690: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
8691: -/uploaded/$1/$2/-x;
8692: }
8693: if ($file=~ m{^/userfiles/}) {
8694: $file =~ s{^/userfiles/}{/uploaded/};
8695: }
8696: return $file;
8697: }
8698:
8699: sub current_machine_domains {
8700: return &machine_domains(&hostname($perlvar{'lonHostID'}));
8701: }
8702:
8703: sub machine_domains {
8704: my ($hostname) = @_;
8705: my @domains;
8706: my %hostname = &all_hostnames();
8707: while( my($id, $name) = each(%hostname)) {
8708: # &logthis("-$id-$name-$hostname-");
8709: if ($hostname eq $name) {
8710: push(@domains,&host_domain($id));
8711: }
8712: }
8713: return @domains;
8714: }
8715:
8716: sub current_machine_ids {
8717: return &machine_ids(&hostname($perlvar{'lonHostID'}));
8718: }
8719:
8720: sub machine_ids {
8721: my ($hostname) = @_;
8722: $hostname ||= &hostname($perlvar{'lonHostID'});
8723: my @ids;
8724: my %name_to_host = &all_names();
8725: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
8726: return @{ $name_to_host{$hostname} };
8727: }
8728: return;
8729: }
8730:
8731: sub additional_machine_domains {
8732: my @domains;
8733: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
8734: while( my $line = <$fh>) {
8735: $line =~ s/\s//g;
8736: push(@domains,$line);
8737: }
8738: return @domains;
8739: }
8740:
8741: sub default_login_domain {
8742: my $domain = $perlvar{'lonDefDomain'};
8743: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
8744: foreach my $posdom (¤t_machine_domains(),
8745: &additional_machine_domains()) {
8746: if (lc($posdom) eq lc($testdomain)) {
8747: $domain=$posdom;
8748: last;
8749: }
8750: }
8751: return $domain;
8752: }
8753:
8754: # ------------------------------------------------------------- Declutters URLs
8755:
8756: sub declutter {
8757: my $thisfn=shift;
8758: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8759: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8760: $thisfn=~s/^\///;
8761: $thisfn=~s|^adm/wrapper/||;
8762: $thisfn=~s|^adm/coursedocs/showdoc/||;
8763: $thisfn=~s/^res\///;
8764: $thisfn=~s/\?.+$//;
8765: return $thisfn;
8766: }
8767:
8768: # ------------------------------------------------------------- Clutter up URLs
8769:
8770: sub clutter {
8771: my $thisfn='/'.&declutter(shift);
8772: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
8773: || $thisfn =~ m{^/adm/(includes|pages)} ) {
8774: $thisfn='/res'.$thisfn;
8775: }
8776: if ($thisfn !~m|/adm|) {
8777: if ($thisfn =~ m|/ext/|) {
8778: $thisfn='/adm/wrapper'.$thisfn;
8779: } else {
8780: my ($ext) = ($thisfn =~ /\.(\w+)$/);
8781: my $embstyle=&Apache::loncommon::fileembstyle($ext);
8782: if ($embstyle eq 'ssi'
8783: || ($embstyle eq 'hdn')
8784: || ($embstyle eq 'rat')
8785: || ($embstyle eq 'prv')
8786: || ($embstyle eq 'ign')) {
8787: #do nothing with these
8788: } elsif (($embstyle eq 'img')
8789: || ($embstyle eq 'emb')
8790: || ($embstyle eq 'wrp')) {
8791: $thisfn='/adm/wrapper'.$thisfn;
8792: } elsif ($embstyle eq 'unk'
8793: && $thisfn!~/\.(sequence|page)$/) {
8794: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
8795: } else {
8796: # &logthis("Got a blank emb style");
8797: }
8798: }
8799: }
8800: return $thisfn;
8801: }
8802:
8803: sub clutter_with_no_wrapper {
8804: my $uri = &clutter(shift);
8805: if ($uri =~ m-^/adm/-) {
8806: $uri =~ s-^/adm/wrapper/-/-;
8807: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
8808: }
8809: return $uri;
8810: }
8811:
8812: sub freeze_escape {
8813: my ($value)=@_;
8814: if (ref($value)) {
8815: $value=&nfreeze($value);
8816: return '__FROZEN__'.&escape($value);
8817: }
8818: return &escape($value);
8819: }
8820:
8821:
8822: sub thaw_unescape {
8823: my ($value)=@_;
8824: if ($value =~ /^__FROZEN__/) {
8825: substr($value,0,10,undef);
8826: $value=&unescape($value);
8827: return &thaw($value);
8828: }
8829: return &unescape($value);
8830: }
8831:
8832: sub correct_line_ends {
8833: my ($result)=@_;
8834: $$result =~s/\r\n/\n/mg;
8835: $$result =~s/\r/\n/mg;
8836: }
8837: # ================================================================ Main Program
8838:
8839: sub goodbye {
8840: &logthis("Starting Shut down");
8841: #not converted to using infrastruture and probably shouldn't be
8842: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
8843: #converted
8844: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
8845: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
8846: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
8847: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
8848: #1.1 only
8849: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
8850: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
8851: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
8852: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
8853: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
8854: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
8855: &logthis(sprintf("%-20s is %s",'hits',$hits));
8856: &flushcourselogs();
8857: &logthis("Shutting down");
8858: }
8859:
8860: sub get_dns {
8861: my ($url,$func,$ignore_cache) = @_;
8862: if (!$ignore_cache) {
8863: my ($content,$cached)=
8864: &Apache::lonnet::is_cached_new('dns',$url);
8865: if ($cached) {
8866: &$func($content);
8867: return;
8868: }
8869: }
8870:
8871: my %alldns;
8872: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8873: foreach my $dns (<$config>) {
8874: next if ($dns !~ /^\^(\S*)/x);
8875: my $line = $1;
8876: my ($host,$protocol) = split(/:/,$line);
8877: if ($protocol ne 'https') {
8878: $protocol = 'http';
8879: }
8880: $alldns{$host} = $protocol;
8881: }
8882: while (%alldns) {
8883: my ($dns) = keys(%alldns);
8884: my $ua=new LWP::UserAgent;
8885: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
8886: my $response=$ua->request($request);
8887: delete($alldns{$dns});
8888: next if ($response->is_error());
8889: my @content = split("\n",$response->content);
8890: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
8891: &$func(\@content);
8892: return;
8893: }
8894: close($config);
8895: my $which = (split('/',$url))[3];
8896: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
8897: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
8898: my @content = <$config>;
8899: &$func(\@content);
8900: return;
8901: }
8902: # ------------------------------------------------------------ Read domain file
8903: {
8904: my $loaded;
8905: my %domain;
8906:
8907: sub parse_domain_tab {
8908: my ($lines) = @_;
8909: foreach my $line (@$lines) {
8910: next if ($line =~ /^(\#|\s*$ )/x);
8911:
8912: chomp($line);
8913: my ($name,@elements) = split(/:/,$line,9);
8914: my %this_domain;
8915: foreach my $field ('description', 'auth_def', 'auth_arg_def',
8916: 'lang_def', 'city', 'longi', 'lati',
8917: 'primary') {
8918: $this_domain{$field} = shift(@elements);
8919: }
8920: $domain{$name} = \%this_domain;
8921: }
8922: }
8923:
8924: sub reset_domain_info {
8925: undef($loaded);
8926: undef(%domain);
8927: }
8928:
8929: sub load_domain_tab {
8930: my ($ignore_cache) = @_;
8931: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
8932: my $fh;
8933: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
8934: my @lines = <$fh>;
8935: &parse_domain_tab(\@lines);
8936: }
8937: close($fh);
8938: $loaded = 1;
8939: }
8940:
8941: sub domain {
8942: &load_domain_tab() if (!$loaded);
8943:
8944: my ($name,$what) = @_;
8945: return if ( !exists($domain{$name}) );
8946:
8947: if (!$what) {
8948: return $domain{$name}{'description'};
8949: }
8950: return $domain{$name}{$what};
8951: }
8952:
8953: sub domain_info {
8954: &load_domain_tab() if (!$loaded);
8955: return %domain;
8956: }
8957:
8958: }
8959:
8960:
8961: # ------------------------------------------------------------- Read hosts file
8962: {
8963: my %hostname;
8964: my %hostdom;
8965: my %libserv;
8966: my $loaded;
8967: my %name_to_host;
8968:
8969: sub parse_hosts_tab {
8970: my ($file) = @_;
8971: foreach my $configline (@$file) {
8972: next if ($configline =~ /^(\#|\s*$ )/x);
8973: next if ($configline =~ /^\^/);
8974: chomp($configline);
8975: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
8976: $name=~s/\s//g;
8977: if ($id && $domain && $role && $name) {
8978: $hostname{$id}=$name;
8979: push(@{$name_to_host{$name}}, $id);
8980: $hostdom{$id}=$domain;
8981: if ($role eq 'library') { $libserv{$id}=$name; }
8982: if (defined($protocol)) {
8983: if ($protocol eq 'https') {
8984: $protocol{$id} = $protocol;
8985: } else {
8986: $protocol{$id} = 'http';
8987: }
8988: } else {
8989: $protocol{$id} = 'http';
8990: }
8991: }
8992: }
8993: }
8994:
8995: sub reset_hosts_info {
8996: &purge_remembered();
8997: &reset_domain_info();
8998: &reset_hosts_ip_info();
8999: undef(%name_to_host);
9000: undef(%hostname);
9001: undef(%hostdom);
9002: undef(%libserv);
9003: undef($loaded);
9004: }
9005:
9006: sub load_hosts_tab {
9007: my ($ignore_cache) = @_;
9008: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
9009: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9010: my @config = <$config>;
9011: &parse_hosts_tab(\@config);
9012: close($config);
9013: $loaded=1;
9014: }
9015:
9016: sub hostname {
9017: &load_hosts_tab() if (!$loaded);
9018:
9019: my ($lonid) = @_;
9020: return $hostname{$lonid};
9021: }
9022:
9023: sub all_hostnames {
9024: &load_hosts_tab() if (!$loaded);
9025:
9026: return %hostname;
9027: }
9028:
9029: sub all_names {
9030: &load_hosts_tab() if (!$loaded);
9031:
9032: return %name_to_host;
9033: }
9034:
9035: sub all_host_domain {
9036: &load_hosts_tab() if (!$loaded);
9037: return %hostdom;
9038: }
9039:
9040: sub is_library {
9041: &load_hosts_tab() if (!$loaded);
9042:
9043: return exists($libserv{$_[0]});
9044: }
9045:
9046: sub all_library {
9047: &load_hosts_tab() if (!$loaded);
9048:
9049: return %libserv;
9050: }
9051:
9052: sub get_servers {
9053: &load_hosts_tab() if (!$loaded);
9054:
9055: my ($domain,$type) = @_;
9056: my %possible_hosts = ($type eq 'library') ? %libserv
9057: : %hostname;
9058: my %result;
9059: if (ref($domain) eq 'ARRAY') {
9060: while ( my ($host,$hostname) = each(%possible_hosts)) {
9061: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9062: $result{$host} = $hostname;
9063: }
9064: }
9065: } else {
9066: while ( my ($host,$hostname) = each(%possible_hosts)) {
9067: if ($hostdom{$host} eq $domain) {
9068: $result{$host} = $hostname;
9069: }
9070: }
9071: }
9072: return %result;
9073: }
9074:
9075: sub host_domain {
9076: &load_hosts_tab() if (!$loaded);
9077:
9078: my ($lonid) = @_;
9079: return $hostdom{$lonid};
9080: }
9081:
9082: sub all_domains {
9083: &load_hosts_tab() if (!$loaded);
9084:
9085: my %seen;
9086: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9087: return @uniq;
9088: }
9089: }
9090:
9091: {
9092: my %iphost;
9093: my %name_to_ip;
9094: my %lonid_to_ip;
9095:
9096: sub get_hosts_from_ip {
9097: my ($ip) = @_;
9098: my %iphosts = &get_iphost();
9099: if (ref($iphosts{$ip})) {
9100: return @{$iphosts{$ip}};
9101: }
9102: return;
9103: }
9104:
9105: sub reset_hosts_ip_info {
9106: undef(%iphost);
9107: undef(%name_to_ip);
9108: undef(%lonid_to_ip);
9109: }
9110:
9111: sub get_host_ip {
9112: my ($lonid) = @_;
9113: if (exists($lonid_to_ip{$lonid})) {
9114: return $lonid_to_ip{$lonid};
9115: }
9116: my $name=&hostname($lonid);
9117: my $ip = gethostbyname($name);
9118: return if (!$ip || length($ip) ne 4);
9119: $ip=inet_ntoa($ip);
9120: $name_to_ip{$name} = $ip;
9121: $lonid_to_ip{$lonid} = $ip;
9122: return $ip;
9123: }
9124:
9125: sub get_iphost {
9126: my ($ignore_cache) = @_;
9127:
9128: if (!$ignore_cache) {
9129: if (%iphost) {
9130: return %iphost;
9131: }
9132: my ($ip_info,$cached)=
9133: &Apache::lonnet::is_cached_new('iphost','iphost');
9134: if ($cached) {
9135: %iphost = %{$ip_info->[0]};
9136: %name_to_ip = %{$ip_info->[1]};
9137: %lonid_to_ip = %{$ip_info->[2]};
9138: return %iphost;
9139: }
9140: }
9141:
9142: # get yesterday's info for fallback
9143: my %old_name_to_ip;
9144: my ($ip_info,$cached)=
9145: &Apache::lonnet::is_cached_new('iphost','iphost');
9146: if ($cached) {
9147: %old_name_to_ip = %{$ip_info->[1]};
9148: }
9149:
9150: my %name_to_host = &all_names();
9151: foreach my $name (keys(%name_to_host)) {
9152: my $ip;
9153: if (!exists($name_to_ip{$name})) {
9154: $ip = gethostbyname($name);
9155: if (!$ip || length($ip) ne 4) {
9156: if (defined($old_name_to_ip{$name})) {
9157: $ip = $old_name_to_ip{$name};
9158: &logthis("Can't find $name defaulting to old $ip");
9159: } else {
9160: &logthis("Name $name no IP found");
9161: next;
9162: }
9163: } else {
9164: $ip=inet_ntoa($ip);
9165: }
9166: $name_to_ip{$name} = $ip;
9167: } else {
9168: $ip = $name_to_ip{$name};
9169: }
9170: foreach my $id (@{ $name_to_host{$name} }) {
9171: $lonid_to_ip{$id} = $ip;
9172: }
9173: push(@{$iphost{$ip}},@{$name_to_host{$name}});
9174: }
9175: &Apache::lonnet::do_cache_new('iphost','iphost',
9176: [\%iphost,\%name_to_ip,\%lonid_to_ip],
9177: 48*60*60);
9178:
9179: return %iphost;
9180: }
9181:
9182: #
9183: # Given a DNS returns the loncapa host name for that DNS
9184: #
9185: sub host_from_dns {
9186: my ($dns) = @_;
9187: my @hosts;
9188: my $ip;
9189:
9190: if (exists($name_to_ip{$dns})) {
9191: $ip = $name_to_ip{$dns};
9192: }
9193: if (!$ip) {
9194: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9195: if (length($ip) == 4) {
9196: $ip = &IO::Socket::inet_ntoa($ip);
9197: }
9198: }
9199: if ($ip) {
9200: @hosts = get_hosts_from_ip($ip);
9201: return $hosts[0];
9202: }
9203: return undef;
9204: }
9205:
9206: }
9207:
9208: BEGIN {
9209:
9210: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9211: unless ($readit) {
9212: {
9213: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9214: %perlvar = (%perlvar,%{$configvars});
9215: }
9216:
9217:
9218: # ------------------------------------------------------ Read spare server file
9219: {
9220: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
9221:
9222: while (my $configline=<$config>) {
9223: chomp($configline);
9224: if ($configline) {
9225: my ($host,$type) = split(':',$configline,2);
9226: if (!defined($type) || $type eq '') { $type = 'default' };
9227: push(@{ $spareid{$type} }, $host);
9228: }
9229: }
9230: close($config);
9231: }
9232: # ------------------------------------------------------------ Read permissions
9233: {
9234: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
9235:
9236: while (my $configline=<$config>) {
9237: chomp($configline);
9238: if ($configline) {
9239: my ($role,$perm)=split(/ /,$configline);
9240: if ($perm ne '') { $pr{$role}=$perm; }
9241: }
9242: }
9243: close($config);
9244: }
9245:
9246: # -------------------------------------------- Read plain texts for permissions
9247: {
9248: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
9249:
9250: while (my $configline=<$config>) {
9251: chomp($configline);
9252: if ($configline) {
9253: my ($short,@plain)=split(/:/,$configline);
9254: %{$prp{$short}} = ();
9255: if (@plain > 0) {
9256: $prp{$short}{'std'} = $plain[0];
9257: for (my $i=1; $i<@plain; $i++) {
9258: $prp{$short}{'alt'.$i} = $plain[$i];
9259: }
9260: }
9261: }
9262: }
9263: close($config);
9264: }
9265:
9266: # ---------------------------------------------------------- Read package table
9267: {
9268: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
9269:
9270: while (my $configline=<$config>) {
9271: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
9272: chomp($configline);
9273: my ($short,$plain)=split(/:/,$configline);
9274: my ($pack,$name)=split(/\&/,$short);
9275: if ($plain ne '') {
9276: $packagetab{$pack.'&'.$name.'&name'}=$name;
9277: $packagetab{$short}=$plain;
9278: }
9279: }
9280: close($config);
9281: }
9282:
9283: # ------------- set up temporary directory
9284: {
9285: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9286:
9287: }
9288:
9289: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9290: 'compress_threshold'=> 20_000,
9291: });
9292:
9293: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
9294: $dumpcount=0;
9295: $locknum=0;
9296:
9297: &logtouch();
9298: &logthis('<font color="yellow">INFO: Read configuration</font>');
9299: $readit=1;
9300: {
9301: use integer;
9302: my $test=(2**32)+1;
9303: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
9304: &logthis(" Detected 64bit platform ($_64bit)");
9305: }
9306: }
9307: }
9308:
9309: 1;
9310: __END__
9311:
9312: =pod
9313:
9314: =head1 NAME
9315:
9316: Apache::lonnet - Subroutines to ask questions about things in the network.
9317:
9318: =head1 SYNOPSIS
9319:
9320: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
9321:
9322: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9323:
9324: Common parameters:
9325:
9326: =over 4
9327:
9328: =item *
9329:
9330: $uname : an internal username (if $cname expecting a course Id specifically)
9331:
9332: =item *
9333:
9334: $udom : a domain (if $cdom expecting a course's domain specifically)
9335:
9336: =item *
9337:
9338: $symb : a resource instance identifier
9339:
9340: =item *
9341:
9342: $namespace : the name of a .db file that contains the data needed or
9343: being set.
9344:
9345: =back
9346:
9347: =head1 OVERVIEW
9348:
9349: lonnet provides subroutines which interact with the
9350: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9351: about classes, users, and resources.
9352:
9353: For many of these objects you can also use this to store data about
9354: them or modify them in various ways.
9355:
9356: =head2 Symbs
9357:
9358: To identify a specific instance of a resource, LON-CAPA uses symbols
9359: or "symbs"X<symb>. These identifiers are built from the URL of the
9360: map, the resource number of the resource in the map, and the URL of
9361: the resource itself. The latter is somewhat redundant, but might help
9362: if maps change.
9363:
9364: An example is
9365:
9366: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9367:
9368: The respective map entry is
9369:
9370: <resource id="19" src="/res/msu/korte/tests/part12.problem"
9371: title="Problem 2">
9372: </resource>
9373:
9374: Symbs are used by the random number generator, as well as to store and
9375: restore data specific to a certain instance of for example a problem.
9376:
9377: =head2 Storing And Retrieving Data
9378:
9379: X<store()>X<cstore()>X<restore()>Three of the most important functions
9380: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
9381: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
9382: is is the non-critical message twin of cstore. These functions are for
9383: handlers to store a perl hash to a user's permanent data space in an
9384: easy manner, and to retrieve it again on another call. It is expected
9385: that a handler would use this once at the beginning to retrieve data,
9386: and then again once at the end to send only the new data back.
9387:
9388: The data is stored in the user's data directory on the user's
9389: homeserver under the ID of the course.
9390:
9391: The hash that is returned by restore will have all of the previous
9392: value for all of the elements of the hash.
9393:
9394: Example:
9395:
9396: #creating a hash
9397: my %hash;
9398: $hash{'foo'}='bar';
9399:
9400: #storing it
9401: &Apache::lonnet::cstore(\%hash);
9402:
9403: #changing a value
9404: $hash{'foo'}='notbar';
9405:
9406: #adding a new value
9407: $hash{'bar'}='foo';
9408: &Apache::lonnet::cstore(\%hash);
9409:
9410: #retrieving the hash
9411: my %history=&Apache::lonnet::restore();
9412:
9413: #print the hash
9414: foreach my $key (sort(keys(%history))) {
9415: print("\%history{$key} = $history{$key}");
9416: }
9417:
9418: Will print out:
9419:
9420: %history{1:foo} = bar
9421: %history{1:keys} = foo:timestamp
9422: %history{1:timestamp} = 990455579
9423: %history{2:bar} = foo
9424: %history{2:foo} = notbar
9425: %history{2:keys} = foo:bar:timestamp
9426: %history{2:timestamp} = 990455580
9427: %history{bar} = foo
9428: %history{foo} = notbar
9429: %history{timestamp} = 990455580
9430: %history{version} = 2
9431:
9432: Note that the special hash entries C<keys>, C<version> and
9433: C<timestamp> were added to the hash. C<version> will be equal to the
9434: total number of versions of the data that have been stored. The
9435: C<timestamp> attribute will be the UNIX time the hash was
9436: stored. C<keys> is available in every historical section to list which
9437: keys were added or changed at a specific historical revision of a
9438: hash.
9439:
9440: B<Warning>: do not store the hash that restore returns directly. This
9441: will cause a mess since it will restore the historical keys as if the
9442: were new keys. I.E. 1:foo will become 1:1:foo etc.
9443:
9444: Calling convention:
9445:
9446: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
9447: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
9448:
9449: For more detailed information, see lonnet specific documentation.
9450:
9451: =head1 RETURN MESSAGES
9452:
9453: =over 4
9454:
9455: =item * B<con_lost>: unable to contact remote host
9456:
9457: =item * B<con_delayed>: unable to contact remote host, message will be delivered
9458: when the connection is brought back up
9459:
9460: =item * B<con_failed>: unable to contact remote host and unable to save message
9461: for later delivery
9462:
9463: =item * B<error:>: an error a occurred, a description of the error follows the :
9464:
9465: =item * B<no_such_host>: unable to fund a host associated with the user/domain
9466: that was requested
9467:
9468: =back
9469:
9470: =head1 PUBLIC SUBROUTINES
9471:
9472: =head2 Session Environment Functions
9473:
9474: =over 4
9475:
9476: =item *
9477: X<appenv()>
9478: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
9479: the user envirnoment file, and will be restored for each access this
9480: user makes during this session, also modifies the %env for the current
9481: process. Optional rolesarrayref - if defined contains a reference to an array
9482: of roles which are exempt from the restriction on modifying user.role entries
9483: in the user's environment.db and in %env.
9484:
9485: =item *
9486: X<delenv()>
9487: B<delenv($delthis,$regexp)>: removes all items from the session
9488: environment file that begin with $delthis. If the
9489: optional second arg - $regexp - is true, $delthis is treated as a
9490: regular expression, otherwise \Q$delthis\E is used.
9491: The values are also deleted from the current processes %env.
9492:
9493: =item * get_env_multiple($name)
9494:
9495: gets $name from the %env hash, it seemlessly handles the cases where multiple
9496: values may be defined and end up as an array ref.
9497:
9498: returns an array of values
9499:
9500: =back
9501:
9502: =head2 User Information
9503:
9504: =over 4
9505:
9506: =item *
9507: X<queryauthenticate()>
9508: B<queryauthenticate($uname,$udom)>: try to determine user's current
9509: authentication scheme
9510:
9511: =item *
9512: X<authenticate()>
9513: B<authenticate($uname,$upass,$udom)>: try to
9514: authenticate user from domain's lib servers (first use the current
9515: one). C<$upass> should be the users password.
9516:
9517: =item *
9518: X<homeserver()>
9519: B<homeserver($uname,$udom)>: find the server which has
9520: the user's directory and files (there must be only one), this caches
9521: the answer, and also caches if there is a borken connection.
9522:
9523: =item *
9524: X<idget()>
9525: B<idget($udom,@ids)>: find the usernames behind a list of IDs
9526: (IDs are a unique resource in a domain, there must be only 1 ID per
9527: username, and only 1 username per ID in a specific domain) (returns
9528: hash: id=>name,id=>name)
9529:
9530: =item *
9531: X<idrget()>
9532: B<idrget($udom,@unames)>: find the IDs behind a list of
9533: usernames (returns hash: name=>id,name=>id)
9534:
9535: =item *
9536: X<idput()>
9537: B<idput($udom,%ids)>: store away a list of names and associated IDs
9538:
9539: =item *
9540: X<rolesinit()>
9541: B<rolesinit($udom,$username,$authhost)>: get user privileges
9542:
9543: =item *
9544: X<getsection()>
9545: B<getsection($udom,$uname,$cname)>: finds the section of student in the
9546: course $cname, return section name/number or '' for "not in course"
9547: and '-1' for "no section"
9548:
9549: =item *
9550: X<userenvironment()>
9551: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
9552: passed in @what from the requested user's environment, returns a hash
9553:
9554: =item *
9555: X<userlog_query()>
9556: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
9557: activity.log file. %filters defines filters applied when parsing the
9558: log file. These can be start or end timestamps, or the type of action
9559: - log to look for Login or Logout events, check for Checkin or
9560: Checkout, role for role selection. The response is in the form
9561: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
9562: escaped strings of the action recorded in the activity.log file.
9563:
9564: =back
9565:
9566: =head2 User Roles
9567:
9568: =over 4
9569:
9570: =item *
9571:
9572: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
9573: F: full access
9574: U,I,K: authentication modes (cxx only)
9575: '': forbidden
9576: 1: user needs to choose course
9577: 2: browse allowed
9578: A: passphrase authentication needed
9579:
9580: =item *
9581:
9582: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
9583: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
9584: and course level
9585:
9586: =item *
9587:
9588: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
9589: (rolesplain.tab); plain text explanation of a user role term.
9590: $type is Course (default) or Group.
9591: If $forcedefault evaluates to true, text returned will be default
9592: text for $type. Otherwise, if this is a course, the text returned
9593: will be a custom name for the role (if defined in the course's
9594: environment). If no custom name is defined the default is returned.
9595:
9596: =item *
9597:
9598: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
9599: All arguments are optional. Returns a hash of a roles, either for
9600: co-author/assistant author roles for a user's Construction Space
9601: (default), or if $context is 'userroles', roles for the user himself,
9602: In the hash, keys are set to colon-separated $uname,$udom,$role, and
9603: (optionally) if $withsec is true, a fourth colon-separated item - $section.
9604: For each key, value is set to colon-separated start and end times for
9605: the role. If no username and domain are specified, will default to
9606: current user/domain. Types, roles, and roledoms are references to arrays
9607: of role statuses (active, future or previous), roles
9608: (e.g., cc,in, st etc.) and domains of the roles which can be used
9609: to restrict the list of roles reported. If no array ref is
9610: provided for types, will default to return only active roles.
9611:
9612: =back
9613:
9614: =head2 User Modification
9615:
9616: =over 4
9617:
9618: =item *
9619:
9620: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
9621: user for the level given by URL. Optional start and end dates (leave empty
9622: string or zero for "no date")
9623:
9624: =item *
9625:
9626: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
9627: change a users, password, possible return values are: ok,
9628: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
9629: refused
9630:
9631: =item *
9632:
9633: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
9634:
9635: =item *
9636:
9637: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
9638: $forceid,$desiredhome,$email,$inststatus) :
9639: modify user
9640:
9641: =item *
9642:
9643: modifystudent
9644:
9645: modify a student's enrollment and identification information.
9646: The course id is resolved based on the current users environment.
9647: This means the envoking user must be a course coordinator or otherwise
9648: associated with a course.
9649:
9650: This call is essentially a wrapper for lonnet::modifyuser and
9651: lonnet::modify_student_enrollment
9652:
9653: Inputs:
9654:
9655: =over 4
9656:
9657: =item B<$udom> Student's loncapa domain
9658:
9659: =item B<$uname> Student's loncapa login name
9660:
9661: =item B<$uid> Student/Employee ID
9662:
9663: =item B<$umode> Student's authentication mode
9664:
9665: =item B<$upass> Student's password
9666:
9667: =item B<$first> Student's first name
9668:
9669: =item B<$middle> Student's middle name
9670:
9671: =item B<$last> Student's last name
9672:
9673: =item B<$gene> Student's generation
9674:
9675: =item B<$usec> Student's section in course
9676:
9677: =item B<$end> Unix time of the roles expiration
9678:
9679: =item B<$start> Unix time of the roles start date
9680:
9681: =item B<$forceid> If defined, allow $uid to be changed
9682:
9683: =item B<$desiredhome> server to use as home server for student
9684:
9685: =item B<$email> Student's permanent e-mail address
9686:
9687: =item B<$type> Type of enrollment (auto or manual)
9688:
9689: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
9690:
9691: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
9692:
9693: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
9694:
9695: =item B<$context> role change context (shown in User Management Logs display in a course)
9696:
9697: =item B<$inststatus> institutional status of user - : separated string of escaped status types
9698:
9699: =back
9700:
9701: =item *
9702:
9703: modify_student_enrollment
9704:
9705: Change a students enrollment status in a class. The environment variable
9706: 'role.request.course' must be defined for this function to proceed.
9707:
9708: Inputs:
9709:
9710: =over 4
9711:
9712: =item $udom, students domain
9713:
9714: =item $uname, students name
9715:
9716: =item $uid, students user id
9717:
9718: =item $first, students first name
9719:
9720: =item $middle
9721:
9722: =item $last
9723:
9724: =item $gene
9725:
9726: =item $usec
9727:
9728: =item $end
9729:
9730: =item $start
9731:
9732: =item $type
9733:
9734: =item $locktype
9735:
9736: =item $cid
9737:
9738: =item $selfenroll
9739:
9740: =item $context
9741:
9742: =back
9743:
9744:
9745: =item *
9746:
9747: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
9748: custom role; give a custom role to a user for the level given by URL. Specify
9749: name and domain of role author, and role name
9750:
9751: =item *
9752:
9753: revokerole($udom,$uname,$url,$role) : revoke a role for url
9754:
9755: =item *
9756:
9757: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
9758:
9759: =back
9760:
9761: =head2 Course Infomation
9762:
9763: =over 4
9764:
9765: =item *
9766:
9767: coursedescription($courseid) : returns a hash of information about the
9768: specified course id, including all environment settings for the
9769: course, the description of the course will be in the hash under the
9770: key 'description'
9771:
9772: =item *
9773:
9774: resdata($name,$domain,$type,@which) : request for current parameter
9775: setting for a specific $type, where $type is either 'course' or 'user',
9776: @what should be a list of parameters to ask about. This routine caches
9777: answers for 5 minutes.
9778:
9779: =item *
9780:
9781: get_courseresdata($courseid, $domain) : dump the entire course resource
9782: data base, returning a hash that is keyed by the resource name and has
9783: values that are the resource value. I believe that the timestamps and
9784: versions are also returned.
9785:
9786:
9787: =back
9788:
9789: =head2 Course Modification
9790:
9791: =over 4
9792:
9793: =item *
9794:
9795: writecoursepref($courseid,%prefs) : write preferences (environment
9796: database) for a course
9797:
9798: =item *
9799:
9800: createcourse($udom,$description,$url) : make/modify course
9801:
9802: =back
9803:
9804: =head2 Resource Subroutines
9805:
9806: =over 4
9807:
9808: =item *
9809:
9810: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
9811:
9812: =item *
9813:
9814: repcopy($filename) : subscribes to the requested file, and attempts to
9815: replicate from the owning library server, Might return
9816: 'unavailable', 'not_found', 'forbidden', 'ok', or
9817: 'bad_request', also attempts to grab the metadata for the
9818: resource. Expects the local filesystem pathname
9819: (/home/httpd/html/res/....)
9820:
9821: =back
9822:
9823: =head2 Resource Information
9824:
9825: =over 4
9826:
9827: =item *
9828:
9829: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
9830: a vairety of different possible values, $varname should be a request
9831: string, and the other parameters can be used to specify who and what
9832: one is asking about.
9833:
9834: Possible values for $varname are environment.lastname (or other item
9835: from the envirnment hash), user.name (or someother aspect about the
9836: user), resource.0.maxtries (or some other part and parameter of a
9837: resource)
9838:
9839: =item *
9840:
9841: directcondval($number) : get current value of a condition; reads from a state
9842: string
9843:
9844: =item *
9845:
9846: condval($condidx) : value of condition index based on state
9847:
9848: =item *
9849:
9850: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
9851: resource's metadata, $what should be either a specific key, or either
9852: 'keys' (to get a list of possible keys) or 'packages' to get a list of
9853: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
9854:
9855: this function automatically caches all requests
9856:
9857: =item *
9858:
9859: metadata_query($query,$custom,$customshow) : make a metadata query against the
9860: network of library servers; returns file handle of where SQL and regex results
9861: will be stored for query
9862:
9863: =item *
9864:
9865: symbread($filename) : return symbolic list entry (filename argument optional);
9866: returns the data handle
9867:
9868: =item *
9869:
9870: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
9871: a possible symb for the URL in $thisfn, and if is an encryypted
9872: resource that the user accessed using /enc/ returns a 1 on success, 0
9873: on failure, user must be in a course, as it assumes the existance of
9874: the course initial hash, and uses $env('request.course.id'}
9875:
9876:
9877: =item *
9878:
9879: symbclean($symb) : removes versions numbers from a symb, returns the
9880: cleaned symb
9881:
9882: =item *
9883:
9884: is_on_map($uri) : checks if the $uri is somewhere on the current
9885: course map, user must be in a course for it to work.
9886:
9887: =item *
9888:
9889: numval($salt) : return random seed value (addend for rndseed)
9890:
9891: =item *
9892:
9893: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
9894: a random seed, all arguments are optional, if they aren't sent it uses the
9895: environment to derive them. Note: if symb isn't sent and it can't get one
9896: from &symbread it will use the current time as its return value
9897:
9898: =item *
9899:
9900: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
9901: unfakeable, receipt
9902:
9903: =item *
9904:
9905: receipt() : API to ireceipt working off of env values; given out to users
9906:
9907: =item *
9908:
9909: countacc($url) : count the number of accesses to a given URL
9910:
9911: =item *
9912:
9913: 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
9914:
9915: =item *
9916:
9917: 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)
9918:
9919: =item *
9920:
9921: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
9922:
9923: =item *
9924:
9925: devalidate($symb) : devalidate temporary spreadsheet calculations,
9926: forcing spreadsheet to reevaluate the resource scores next time.
9927:
9928: =back
9929:
9930: =head2 Storing/Retreiving Data
9931:
9932: =over 4
9933:
9934: =item *
9935:
9936: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
9937: for this url; hashref needs to be given and should be a \%hashname; the
9938: remaining args aren't required and if they aren't passed or are '' they will
9939: be derived from the env
9940:
9941: =item *
9942:
9943: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
9944: uses critical subroutine
9945:
9946: =item *
9947:
9948: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
9949: all args are optional
9950:
9951: =item *
9952:
9953: dumpstore($namespace,$udom,$uname,$regexp,$range) :
9954: dumps the complete (or key matching regexp) namespace into a hash
9955: ($udom, $uname, $regexp, $range are optional) for a namespace that is
9956: normally &store()ed into
9957:
9958: $range should be either an integer '100' (give me the first 100
9959: matching records)
9960: or be two integers sperated by a - with no spaces
9961: '30-50' (give me the 30th through the 50th matching
9962: records)
9963:
9964:
9965: =item *
9966:
9967: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
9968: replaces a &store() version of data with a replacement set of data
9969: for a particular resource in a namespace passed in the $storehash hash
9970: reference
9971:
9972: =item *
9973:
9974: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
9975: works very similar to store/cstore, but all data is stored in a
9976: temporary location and can be reset using tmpreset, $storehash should
9977: be a hash reference, returns nothing on success
9978:
9979: =item *
9980:
9981: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
9982: similar to restore, but all data is stored in a temporary location and
9983: can be reset using tmpreset. Returns a hash of values on success,
9984: error string otherwise.
9985:
9986: =item *
9987:
9988: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
9989: deltes all keys for $symb form the temporary storage hash.
9990:
9991: =item *
9992:
9993: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9994: reference filled in from namesp ($udom and $uname are optional)
9995:
9996: =item *
9997:
9998: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
9999: namesp ($udom and $uname are optional)
10000:
10001: =item *
10002:
10003: dump($namespace,$udom,$uname,$regexp,$range) :
10004: dumps the complete (or key matching regexp) namespace into a hash
10005: ($udom, $uname, $regexp, $range are optional)
10006:
10007: $range should be either an integer '100' (give me the first 100
10008: matching records)
10009: or be two integers sperated by a - with no spaces
10010: '30-50' (give me the 30th through the 50th matching
10011: records)
10012: =item *
10013:
10014: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10015: $store can be a scalar, an array reference, or if the amount to be
10016: incremented is > 1, a hash reference.
10017:
10018: ($udom and $uname are optional)
10019:
10020: =item *
10021:
10022: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10023: ($udom and $uname are optional)
10024:
10025: =item *
10026:
10027: cput($namespace,$storehash,$udom,$uname) : critical put
10028: ($udom and $uname are optional)
10029:
10030: =item *
10031:
10032: newput($namespace,$storehash,$udom,$uname) :
10033:
10034: Attempts to store the items in the $storehash, but only if they don't
10035: currently exist, if this succeeds you can be certain that you have
10036: successfully created a new key value pair in the $namespace db.
10037:
10038:
10039: Args:
10040: $namespace: name of database to store values to
10041: $storehash: hashref to store to the db
10042: $udom: (optional) domain of user containing the db
10043: $uname: (optional) name of user caontaining the db
10044:
10045: Returns:
10046: 'ok' -> succeeded in storing all keys of $storehash
10047: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10048: least <key> already existed in the db (other
10049: requested keys may also already exist)
10050: 'error: <msg>' -> unable to tie the DB or other error occurred
10051: 'con_lost' -> unable to contact request server
10052: 'refused' -> action was not allowed by remote machine
10053:
10054:
10055: =item *
10056:
10057: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10058: reference filled in from namesp (encrypts the return communication)
10059: ($udom and $uname are optional)
10060:
10061: =item *
10062:
10063: log($udom,$name,$home,$message) : write to permanent log for user; use
10064: critical subroutine
10065:
10066: =item *
10067:
10068: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10069: array reference filled in from namespace found in domain level on either
10070: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
10071:
10072: =item *
10073:
10074: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10075: domain level either on specified domain server ($uhome) or primary domain
10076: server ($udom and $uhome are optional)
10077:
10078: =item *
10079:
10080: get_domain_defaults($target_domain) : returns hash with defaults for
10081: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10082: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10083: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10084: Values are retrieved from cache (if current), or from domain's configuration.db
10085: (if available), or lastly from values in lonTabs/dns_domain,tab,
10086: or lonTabs/domain.tab.
10087:
10088: %domdefaults = &get_auth_defaults($target_domain);
10089:
10090: =back
10091:
10092: =head2 Network Status Functions
10093:
10094: =over 4
10095:
10096: =item *
10097:
10098: dirlist($uri) : return directory list based on URI
10099:
10100: =item *
10101:
10102: spareserver() : find server with least workload from spare.tab
10103:
10104:
10105: =item *
10106:
10107: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10108: if there is no corresponding loncapa host.
10109:
10110: =back
10111:
10112:
10113: =head2 Apache Request
10114:
10115: =over 4
10116:
10117: =item *
10118:
10119: ssi($url,%hash) : server side include, does a complete request cycle on url to
10120: localhost, posts hash
10121:
10122: =back
10123:
10124: =head2 Data to String to Data
10125:
10126: =over 4
10127:
10128: =item *
10129:
10130: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10131: and '&' separators, supports elements that are arrayrefs and hashrefs
10132:
10133: =item *
10134:
10135: hashref2str($hashref) : convert a hashref into a string complete with
10136: escaping and '=' and '&' separators, supports elements that are
10137: arrayrefs and hashrefs
10138:
10139: =item *
10140:
10141: arrayref2str($arrayref) : convert an arrayref into a string complete
10142: with escaping and '&' separators, supports elements that are arrayrefs
10143: and hashrefs
10144:
10145: =item *
10146:
10147: str2hash($string) : convert string to hash using unescaping and
10148: splitting on '=' and '&', supports elements that are arrayrefs and
10149: hashrefs
10150:
10151: =item *
10152:
10153: str2array($string) : convert string to hash using unescaping and
10154: splitting on '&', supports elements that are arrayrefs and hashrefs
10155:
10156: =back
10157:
10158: =head2 Logging Routines
10159:
10160: =over 4
10161:
10162: These routines allow one to make log messages in the lonnet.log and
10163: lonnet.perm logfiles.
10164:
10165: =item *
10166:
10167: logtouch() : make sure the logfile, lonnet.log, exists
10168:
10169: =item *
10170:
10171: logthis() : append message to the normal lonnet.log file, it gets
10172: preiodically rolled over and deleted.
10173:
10174: =item *
10175:
10176: logperm() : append a permanent message to lonnet.perm.log, this log
10177: file never gets deleted by any automated portion of the system, only
10178: messages of critical importance should go in here.
10179:
10180: =back
10181:
10182: =head2 General File Helper Routines
10183:
10184: =over 4
10185:
10186: =item *
10187:
10188: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10189: (a) files in /uploaded
10190: (i) If a local copy of the file exists -
10191: compares modification date of local copy with last-modified date for
10192: definitive version stored on home server for course. If local copy is
10193: stale, requests a new version from the home server and stores it.
10194: If the original has been removed from the home server, then local copy
10195: is unlinked.
10196: (ii) If local copy does not exist -
10197: requests the file from the home server and stores it.
10198:
10199: If $caller is 'uploadrep':
10200: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10201: for request for files originally uploaded via DOCS.
10202: - returns 'ok' if fresh local copy now available, -1 otherwise.
10203:
10204: Otherwise:
10205: This indicates a call from the content generation phase of the request.
10206: - returns the entire contents of the file or -1.
10207:
10208: (b) files in /res
10209: - returns the entire contents of a file or -1;
10210: it properly subscribes to and replicates the file if neccessary.
10211:
10212:
10213: =item *
10214:
10215: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10216: reference
10217:
10218: returns either a stat() list of data about the file or an empty list
10219: if the file doesn't exist or couldn't find out about it (connection
10220: problems or user unknown)
10221:
10222: =item *
10223:
10224: filelocation($dir,$file) : returns file system location of a file
10225: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10226: directory that relative $file lookups are to looked in ($dir of /a/dir
10227: and a file of ../bob will become /a/bob)
10228:
10229: =item *
10230:
10231: hreflocation($dir,$file) : returns file system location or a URL; same as
10232: filelocation except for hrefs
10233:
10234: =item *
10235:
10236: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10237:
10238: =back
10239:
10240: =head2 Usererfile file routines (/uploaded*)
10241:
10242: =over 4
10243:
10244: =item *
10245:
10246: userfileupload(): main rotine for putting a file in a user or course's
10247: filespace, arguments are,
10248:
10249: formname - required - this is the name of the element in $env where the
10250: filename, and the contents of the file to create/modifed exist
10251: the filename is in $env{'form.'.$formname.'.filename'} and the
10252: contents of the file is located in $env{'form.'.$formname}
10253: coursedoc - if true, store the file in the course of the active role
10254: of the current user
10255: subdir - required - subdirectory to put the file in under ../userfiles/
10256: if undefined, it will be placed in "unknown"
10257:
10258: (This routine calls clean_filename() to remove any dangerous
10259: characters from the filename, and then calls finuserfileupload() to
10260: complete the transaction)
10261:
10262: returns either the url of the uploaded file (/uploaded/....) if successful
10263: and /adm/notfound.html if unsuccessful
10264:
10265: =item *
10266:
10267: clean_filename(): routine for cleaing a filename up for storage in
10268: userfile space, argument is:
10269:
10270: filename - proposed filename
10271:
10272: returns: the new clean filename
10273:
10274: =item *
10275:
10276: finishuserfileupload(): routine that creaes and sends the file to
10277: userspace, probably shouldn't be called directly
10278:
10279: docuname: username or courseid of destination for the file
10280: docudom: domain of user/course of destination for the file
10281: formname: same as for userfileupload()
10282: fname: filename (inculding subdirectories) for the file
10283:
10284: returns either the url of the uploaded file (/uploaded/....) if successful
10285: and /adm/notfound.html if unsuccessful
10286:
10287: =item *
10288:
10289: renameuserfile(): renames an existing userfile to a new name
10290:
10291: Args:
10292: docuname: username or courseid of destination for the file
10293: docudom: domain of user/course of destination for the file
10294: old: current file name (including any subdirs under userfiles)
10295: new: desired file name (including any subdirs under userfiles)
10296:
10297: =item *
10298:
10299: mkdiruserfile(): creates a directory is a userfiles dir
10300:
10301: Args:
10302: docuname: username or courseid of destination for the file
10303: docudom: domain of user/course of destination for the file
10304: dir: dir to create (including any subdirs under userfiles)
10305:
10306: =item *
10307:
10308: removeuserfile(): removes a file that exists in userfiles
10309:
10310: Args:
10311: docuname: username or courseid of destination for the file
10312: docudom: domain of user/course of destination for the file
10313: fname: filname to delete (including any subdirs under userfiles)
10314:
10315: =item *
10316:
10317: removeuploadedurl(): convience function for removeuserfile()
10318:
10319: Args:
10320: url: a full /uploaded/... url to delete
10321:
10322: =item *
10323:
10324: get_portfile_permissions():
10325: Args:
10326: domain: domain of user or course contain the portfolio files
10327: user: name of user or num of course contain the portfolio files
10328: Returns:
10329: hashref of a dump of the proper file_permissions.db
10330:
10331:
10332: =item *
10333:
10334: get_access_controls():
10335:
10336: Args:
10337: current_permissions: the hash ref returned from get_portfile_permissions()
10338: group: (optional) the group you want the files associated with
10339: file: (optional) the file you want access info on
10340:
10341: Returns:
10342: a hash (keys are file names) of hashes containing
10343: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10344: values are XML containing access control settings (see below)
10345:
10346: Internal notes:
10347:
10348: access controls are stored in file_permissions.db as key=value pairs.
10349: key -> path to file/file_name\0uniqueID:scope_end_start
10350: where scope -> public,guest,course,group,domains or users.
10351: end -> UNIX time for end of access (0 -> no end date)
10352: start -> UNIX time for start of access
10353:
10354: value -> XML description of access control
10355: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10356: <start></start>
10357: <end></end>
10358:
10359: <password></password> for scope type = guest
10360:
10361: <domain></domain> for scope type = course or group
10362: <number></number>
10363: <roles id="">
10364: <role></role>
10365: <access></access>
10366: <section></section>
10367: <group></group>
10368: </roles>
10369:
10370: <dom></dom> for scope type = domains
10371:
10372: <users> for scope type = users
10373: <user>
10374: <uname></uname>
10375: <udom></udom>
10376: </user>
10377: </users>
10378: </scope>
10379:
10380: Access data is also aggregated for each file in an additional key=value pair:
10381: key -> path to file/file_name\0accesscontrol
10382: value -> reference to hash
10383: hash contains key = value pairs
10384: where key = uniqueID:scope_end_start
10385: value = UNIX time record was last updated
10386:
10387: Used to improve speed of look-ups of access controls for each file.
10388:
10389: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
10390:
10391: modify_access_controls():
10392:
10393: Modifies access controls for a portfolio file
10394: Args
10395: 1. file name
10396: 2. reference to hash of required changes,
10397: 3. domain
10398: 4. username
10399: where domain,username are the domain of the portfolio owner
10400: (either a user or a course)
10401:
10402: Returns:
10403: 1. result of additions or updates ('ok' or 'error', with error message).
10404: 2. result of deletions ('ok' or 'error', with error message).
10405: 3. reference to hash of any new or updated access controls.
10406: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
10407: key = integer (inbound ID)
10408: value = uniqueID
10409:
10410: =back
10411:
10412: =head2 HTTP Helper Routines
10413:
10414: =over 4
10415:
10416: =item *
10417:
10418: escape() : unpack non-word characters into CGI-compatible hex codes
10419:
10420: =item *
10421:
10422: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
10423:
10424: =back
10425:
10426: =head1 PRIVATE SUBROUTINES
10427:
10428: =head2 Underlying communication routines (Shouldn't call)
10429:
10430: =over 4
10431:
10432: =item *
10433:
10434: subreply() : tries to pass a message to lonc, returns con_lost if incapable
10435:
10436: =item *
10437:
10438: reply() : uses subreply to send a message to remote machine, logs all failures
10439:
10440: =item *
10441:
10442: critical() : passes a critical message to another server; if cannot
10443: get through then place message in connection buffer directory and
10444: returns con_delayed, if incapable of saving message, returns
10445: con_failed
10446:
10447: =item *
10448:
10449: reconlonc() : tries to reconnect lonc client processes.
10450:
10451: =back
10452:
10453: =head2 Resource Access Logging
10454:
10455: =over 4
10456:
10457: =item *
10458:
10459: flushcourselogs() : flush (save) buffer logs and access logs
10460:
10461: =item *
10462:
10463: courselog($what) : save message for course in hash
10464:
10465: =item *
10466:
10467: courseacclog($what) : save message for course using &courselog(). Perform
10468: special processing for specific resource types (problems, exams, quizzes, etc).
10469:
10470: =item *
10471:
10472: goodbye() : flush course logs and log shutting down; it is called in srm.conf
10473: as a PerlChildExitHandler
10474:
10475: =back
10476:
10477: =head2 Other
10478:
10479: =over 4
10480:
10481: =item *
10482:
10483: symblist($mapname,%newhash) : update symbolic storage links
10484:
10485: =back
10486:
10487: =cut
10488:
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