1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1270 2014/12/01 22:53:00 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:
79: use Encode;
80:
81: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
82: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
83: %managerstab);
84:
85: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
86: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
87: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
88: %courseownerbuf, %coursetypebuf,$locknum);
89:
90: use IO::Socket;
91: use GDBM_File;
92: use HTML::LCParser;
93: use Fcntl qw(:flock);
94: use Storable qw(thaw nfreeze);
95: use Time::HiRes qw( gettimeofday tv_interval );
96: use Cache::Memcached;
97: use Digest::MD5;
98: use Math::Random;
99: use File::MMagic;
100: use LONCAPA qw(:DEFAULT :match);
101: use LONCAPA::Configuration;
102: use LONCAPA::lonmetadata;
103: use LONCAPA::Lond;
104:
105: use File::Copy;
106:
107: my $readit;
108: my $max_connection_retries = 10; # Or some such value.
109:
110: require Exporter;
111:
112: our @ISA = qw (Exporter);
113: our @EXPORT = qw(%env);
114:
115:
116: # ------------------------------------ Logging (parameters, docs, slots, roles)
117: {
118: my $logid;
119: sub write_log {
120: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
121: if ($context eq 'course') {
122: if (($cnum eq '') || ($cdom eq '')) {
123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
125: }
126: }
127: $logid ++;
128: my $now = time();
129: my $id=$now.'00000'.$$.'00000'.$logid;
130: my $logentry = {
131: $id => {
132: 'exe_uname' => $env{'user.name'},
133: 'exe_udom' => $env{'user.domain'},
134: 'exe_time' => $now,
135: 'exe_ip' => $ENV{'REMOTE_ADDR'},
136: 'delflag' => $delflag,
137: 'logentry' => $storehash,
138: 'uname' => $uname,
139: 'udom' => $udom,
140: }
141: };
142: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
143: }
144: }
145:
146: sub logtouch {
147: my $execdir=$perlvar{'lonDaemons'};
148: unless (-e "$execdir/logs/lonnet.log") {
149: open(my $fh,">>$execdir/logs/lonnet.log");
150: close $fh;
151: }
152: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
153: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
154: }
155:
156: sub logthis {
157: my $message=shift;
158: my $execdir=$perlvar{'lonDaemons'};
159: my $now=time;
160: my $local=localtime($now);
161: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
162: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
163: print $fh $logstring;
164: close($fh);
165: }
166: return 1;
167: }
168:
169: sub logperm {
170: my $message=shift;
171: my $execdir=$perlvar{'lonDaemons'};
172: my $now=time;
173: my $local=localtime($now);
174: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
175: print $fh "$now:$message:$local\n";
176: close($fh);
177: }
178: return 1;
179: }
180:
181: sub create_connection {
182: my ($hostname,$lonid) = @_;
183: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
184: Type => SOCK_STREAM,
185: Timeout => 10);
186: return 0 if (!$client);
187: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
188: my $result = <$client>;
189: chomp($result);
190: return 1 if ($result eq 'done');
191: return 0;
192: }
193:
194: sub get_server_timezone {
195: my ($cnum,$cdom) = @_;
196: my $home=&homeserver($cnum,$cdom);
197: if ($home ne 'no_host') {
198: my $cachetime = 24*3600;
199: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
200: if (defined($cached)) {
201: return $timezone;
202: } else {
203: my $timezone = &reply('servertimezone',$home);
204: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
205: }
206: }
207: }
208:
209: sub get_server_distarch {
210: my ($lonhost,$ignore_cache) = @_;
211: if (defined($lonhost)) {
212: if (!defined(&hostname($lonhost))) {
213: return;
214: }
215: my $cachetime = 12*3600;
216: if (!$ignore_cache) {
217: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
218: if (defined($cached)) {
219: return $distarch;
220: }
221: }
222: my $rep = &reply('serverdistarch',$lonhost);
223: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
224: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
225: $rep eq '') {
226: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
227: }
228: }
229: return;
230: }
231:
232: sub get_server_loncaparev {
233: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
234: if (defined($lonhost)) {
235: if (!defined(&hostname($lonhost))) {
236: undef($lonhost);
237: }
238: }
239: if (!defined($lonhost)) {
240: if (defined(&domain($dom,'primary'))) {
241: $lonhost=&domain($dom,'primary');
242: if ($lonhost eq 'no_host') {
243: undef($lonhost);
244: }
245: }
246: }
247: if (defined($lonhost)) {
248: my $cachetime = 12*3600;
249: if (!$ignore_cache) {
250: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
251: if (defined($cached)) {
252: return $loncaparev;
253: }
254: }
255: my ($answer,$loncaparev);
256: my @ids=¤t_machine_ids();
257: if (grep(/^\Q$lonhost\E$/,@ids)) {
258: $answer = $perlvar{'lonVersion'};
259: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
260: $loncaparev = $1;
261: }
262: } else {
263: $answer = &reply('serverloncaparev',$lonhost);
264: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
265: if ($caller eq 'loncron') {
266: my $ua=new LWP::UserAgent;
267: $ua->timeout(4);
268: my $protocol = $protocol{$lonhost};
269: $protocol = 'http' if ($protocol ne 'https');
270: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
271: my $request=new HTTP::Request('GET',$url);
272: my $response=$ua->request($request);
273: unless ($response->is_error()) {
274: my $content = $response->content;
275: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
276: $loncaparev = $1;
277: }
278: }
279: } else {
280: $loncaparev = $loncaparevs{$lonhost};
281: }
282: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
283: $loncaparev = $1;
284: }
285: }
286: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
287: }
288: }
289:
290: sub get_server_homeID {
291: my ($hostname,$ignore_cache,$caller) = @_;
292: unless ($ignore_cache) {
293: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
294: if (defined($cached)) {
295: return $serverhomeID;
296: }
297: }
298: my $cachetime = 12*3600;
299: my $serverhomeID;
300: if ($caller eq 'loncron') {
301: my @machine_ids = &machine_ids($hostname);
302: foreach my $id (@machine_ids) {
303: my $response = &reply('serverhomeID',$id);
304: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
305: $serverhomeID = $response;
306: last;
307: }
308: }
309: if ($serverhomeID eq '') {
310: $serverhomeID = $machine_ids[-1];
311: }
312: } else {
313: $serverhomeID = $serverhomeIDs{$hostname};
314: }
315: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
316: }
317:
318: sub get_remote_globals {
319: my ($lonhost,$whathash,$ignore_cache) = @_;
320: my ($result,%returnhash,%whatneeded);
321: if (ref($whathash) eq 'HASH') {
322: foreach my $what (sort(keys(%{$whathash}))) {
323: my $hashid = $lonhost.'-'.$what;
324: my ($response,$cached);
325: unless ($ignore_cache) {
326: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
327: }
328: if (defined($cached)) {
329: $returnhash{$what} = $response;
330: } else {
331: $whatneeded{$what} = 1;
332: }
333: }
334: if (keys(%whatneeded) == 0) {
335: $result = 'ok';
336: } else {
337: my $requested = &freeze_escape(\%whatneeded);
338: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
339: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
340: ($rep eq 'unknown_cmd')) {
341: $result = $rep;
342: } else {
343: $result = 'ok';
344: my @pairs=split(/\&/,$rep);
345: foreach my $item (@pairs) {
346: my ($key,$value)=split(/=/,$item,2);
347: my $what = &unescape($key);
348: my $hashid = $lonhost.'-'.$what;
349: $returnhash{$what}=&thaw_unescape($value);
350: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
351: }
352: }
353: }
354: }
355: return ($result,\%returnhash);
356: }
357:
358: sub remote_devalidate_cache {
359: my ($lonhost,$cachekeys) = @_;
360: my $items;
361: return unless (ref($cachekeys) eq 'ARRAY');
362: my $cachestr = join('&',@{$cachekeys});
363: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
364: return $response;
365: }
366:
367: # -------------------------------------------------- Non-critical communication
368: sub subreply {
369: my ($cmd,$server)=@_;
370: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
371: #
372: # With loncnew process trimming, there's a timing hole between lonc server
373: # process exit and the master server picking up the listen on the AF_UNIX
374: # socket. In that time interval, a lock file will exist:
375:
376: my $lockfile=$peerfile.".lock";
377: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
378: sleep(1);
379: }
380: # At this point, either a loncnew parent is listening or an old lonc
381: # or loncnew child is listening so we can connect or everything's dead.
382: #
383: # We'll give the connection a few tries before abandoning it. If
384: # connection is not possible, we'll con_lost back to the client.
385: #
386: my $client;
387: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
388: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
389: Type => SOCK_STREAM,
390: Timeout => 10);
391: if ($client) {
392: last; # Connected!
393: } else {
394: &create_connection(&hostname($server),$server);
395: }
396: sleep(1); # Try again later if failed connection.
397: }
398: my $answer;
399: if ($client) {
400: print $client "sethost:$server:$cmd\n";
401: $answer=<$client>;
402: if (!$answer) { $answer="con_lost"; }
403: chomp($answer);
404: } else {
405: $answer = 'con_lost'; # Failed connection.
406: }
407: return $answer;
408: }
409:
410: sub reply {
411: my ($cmd,$server)=@_;
412: unless (defined(&hostname($server))) { return 'no_such_host'; }
413: my $answer=subreply($cmd,$server);
414: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
415: &logthis("<font color=\"blue\">WARNING:".
416: " $cmd to $server returned $answer</font>");
417: }
418: return $answer;
419: }
420:
421: # ----------------------------------------------------------- Send USR1 to lonc
422:
423: sub reconlonc {
424: my ($lonid) = @_;
425: my $hostname = &hostname($lonid);
426: if ($lonid) {
427: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
428: if ($hostname && -e $peerfile) {
429: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
430: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
431: Type => SOCK_STREAM,
432: Timeout => 10);
433: if ($client) {
434: print $client ("reset_retries\n");
435: my $answer=<$client>;
436: #reset just this one.
437: }
438: }
439: return;
440: }
441:
442: &logthis("Trying to reconnect lonc");
443: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
444: if (open(my $fh,"<$loncfile")) {
445: my $loncpid=<$fh>;
446: chomp($loncpid);
447: if (kill 0 => $loncpid) {
448: &logthis("lonc at pid $loncpid responding, sending USR1");
449: kill USR1 => $loncpid;
450: sleep 1;
451: } else {
452: &logthis(
453: "<font color=\"blue\">WARNING:".
454: " lonc at pid $loncpid not responding, giving up</font>");
455: }
456: } else {
457: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
458: }
459: }
460:
461: # ------------------------------------------------------ Critical communication
462:
463: sub critical {
464: my ($cmd,$server)=@_;
465: unless (&hostname($server)) {
466: &logthis("<font color=\"blue\">WARNING:".
467: " Critical message to unknown server ($server)</font>");
468: return 'no_such_host';
469: }
470: my $answer=reply($cmd,$server);
471: if ($answer eq 'con_lost') {
472: &reconlonc("$perlvar{'lonSockDir'}/$server");
473: my $answer=reply($cmd,$server);
474: if ($answer eq 'con_lost') {
475: my $now=time;
476: my $middlename=$cmd;
477: $middlename=substr($middlename,0,16);
478: $middlename=~s/\W//g;
479: my $dfilename=
480: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
481: $dumpcount++;
482: {
483: my $dfh;
484: if (open($dfh,">$dfilename")) {
485: print $dfh "$cmd\n";
486: close($dfh);
487: }
488: }
489: sleep 2;
490: my $wcmd='';
491: {
492: my $dfh;
493: if (open($dfh,"<$dfilename")) {
494: $wcmd=<$dfh>;
495: close($dfh);
496: }
497: }
498: chomp($wcmd);
499: if ($wcmd eq $cmd) {
500: &logthis("<font color=\"blue\">WARNING: ".
501: "Connection buffer $dfilename: $cmd</font>");
502: &logperm("D:$server:$cmd");
503: return 'con_delayed';
504: } else {
505: &logthis("<font color=\"red\">CRITICAL:"
506: ." Critical connection failed: $server $cmd</font>");
507: &logperm("F:$server:$cmd");
508: return 'con_failed';
509: }
510: }
511: }
512: return $answer;
513: }
514:
515: # ------------------------------------------- check if return value is an error
516:
517: sub error {
518: my ($result) = @_;
519: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
520: if ($2 == 2) { return undef; }
521: return $1;
522: }
523: return undef;
524: }
525:
526: sub convert_and_load_session_env {
527: my ($lonidsdir,$handle)=@_;
528: my @profile;
529: {
530: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
531: if (!$opened) {
532: return 0;
533: }
534: flock($idf,LOCK_SH);
535: @profile=<$idf>;
536: close($idf);
537: }
538: my %temp_env;
539: foreach my $line (@profile) {
540: if ($line !~ m/=/) {
541: return 0;
542: }
543: chomp($line);
544: my ($envname,$envvalue)=split(/=/,$line,2);
545: $temp_env{&unescape($envname)} = &unescape($envvalue);
546: }
547: unlink("$lonidsdir/$handle.id");
548: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
549: 0640)) {
550: %disk_env = %temp_env;
551: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
552: untie(%disk_env);
553: }
554: return 1;
555: }
556:
557: # ------------------------------------------- Transfer profile into environment
558: my $env_loaded;
559: sub transfer_profile_to_env {
560: my ($lonidsdir,$handle,$force_transfer) = @_;
561: if (!$force_transfer && $env_loaded) { return; }
562:
563: if (!defined($lonidsdir)) {
564: $lonidsdir = $perlvar{'lonIDsDir'};
565: }
566: if (!defined($handle)) {
567: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
568: }
569:
570: my $convert;
571: {
572: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
573: if (!$opened) {
574: return;
575: }
576: flock($idf,LOCK_SH);
577: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
578: &GDBM_READER(),0640)) {
579: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
580: untie(%disk_env);
581: } else {
582: $convert = 1;
583: }
584: }
585: if ($convert) {
586: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
587: &logthis("Failed to load session, or convert session.");
588: }
589: }
590:
591: my %remove;
592: while ( my $envname = each(%env) ) {
593: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
594: if ($time < time-300) {
595: $remove{$key}++;
596: }
597: }
598: }
599:
600: $env{'user.environment'} = "$lonidsdir/$handle.id";
601: $env_loaded=1;
602: foreach my $expired_key (keys(%remove)) {
603: &delenv($expired_key);
604: }
605: }
606:
607: # ---------------------------------------------------- Check for valid session
608: sub check_for_valid_session {
609: my ($r,$name,$userhashref) = @_;
610: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
611: if ($name eq '') {
612: $name = 'lonID';
613: }
614: my $lonid=$cookies{$name};
615: return undef if (!$lonid);
616:
617: my $handle=&LONCAPA::clean_handle($lonid->value);
618: my $lonidsdir;
619: if ($name eq 'lonDAV') {
620: $lonidsdir=$r->dir_config('lonDAVsessDir');
621: } else {
622: $lonidsdir=$r->dir_config('lonIDsDir');
623: }
624: return undef if (!-e "$lonidsdir/$handle.id");
625:
626: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
627: return undef if (!$opened);
628:
629: flock($idf,LOCK_SH);
630: my %disk_env;
631: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
632: &GDBM_READER(),0640)) {
633: return undef;
634: }
635:
636: if (!defined($disk_env{'user.name'})
637: || !defined($disk_env{'user.domain'})) {
638: return undef;
639: }
640:
641: if (ref($userhashref) eq 'HASH') {
642: $userhashref->{'name'} = $disk_env{'user.name'};
643: $userhashref->{'domain'} = $disk_env{'user.domain'};
644: }
645:
646: return $handle;
647: }
648:
649: sub timed_flock {
650: my ($file,$lock_type) = @_;
651: my $failed=0;
652: eval {
653: local $SIG{__DIE__}='DEFAULT';
654: local $SIG{ALRM}=sub {
655: $failed=1;
656: die("failed lock");
657: };
658: alarm(13);
659: flock($file,$lock_type);
660: alarm(0);
661: };
662: if ($failed) {
663: return undef;
664: } else {
665: return 1;
666: }
667: }
668:
669: # ---------------------------------------------------------- Append Environment
670:
671: sub appenv {
672: my ($newenv,$roles) = @_;
673: if (ref($newenv) eq 'HASH') {
674: foreach my $key (keys(%{$newenv})) {
675: my $refused = 0;
676: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
677: $refused = 1;
678: if (ref($roles) eq 'ARRAY') {
679: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
680: if (grep(/^\Q$role\E$/,@{$roles})) {
681: $refused = 0;
682: }
683: }
684: }
685: if ($refused) {
686: &logthis("<font color=\"blue\">WARNING: ".
687: "Attempt to modify environment ".$key." to ".$newenv->{$key}
688: .'</font>');
689: delete($newenv->{$key});
690: } else {
691: $env{$key}=$newenv->{$key};
692: }
693: }
694: my $opened = open(my $env_file,'+<',$env{'user.environment'});
695: if ($opened
696: && &timed_flock($env_file,LOCK_EX)
697: &&
698: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
699: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
700: while (my ($key,$value) = each(%{$newenv})) {
701: $disk_env{$key} = $value;
702: }
703: untie(%disk_env);
704: }
705: }
706: return 'ok';
707: }
708: # ----------------------------------------------------- Delete from Environment
709:
710: sub delenv {
711: my ($delthis,$regexp,$roles) = @_;
712: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
713: my $refused = 1;
714: if (ref($roles) eq 'ARRAY') {
715: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
716: if (grep(/^\Q$role\E$/,@{$roles})) {
717: $refused = 0;
718: }
719: }
720: if ($refused) {
721: &logthis("<font color=\"blue\">WARNING: ".
722: "Attempt to delete from environment ".$delthis);
723: return 'error';
724: }
725: }
726: my $opened = open(my $env_file,'+<',$env{'user.environment'});
727: if ($opened
728: && &timed_flock($env_file,LOCK_EX)
729: &&
730: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
731: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
732: foreach my $key (keys(%disk_env)) {
733: if ($regexp) {
734: if ($key=~/^$delthis/) {
735: delete($env{$key});
736: delete($disk_env{$key});
737: }
738: } else {
739: if ($key=~/^\Q$delthis\E/) {
740: delete($env{$key});
741: delete($disk_env{$key});
742: }
743: }
744: }
745: untie(%disk_env);
746: }
747: return 'ok';
748: }
749:
750: sub get_env_multiple {
751: my ($name) = @_;
752: my @values;
753: if (defined($env{$name})) {
754: # exists is it an array
755: if (ref($env{$name})) {
756: @values=@{ $env{$name} };
757: } else {
758: $values[0]=$env{$name};
759: }
760: }
761: return(@values);
762: }
763:
764: # ------------------------------------------------------------------- Locking
765:
766: sub set_lock {
767: my ($text)=@_;
768: $locknum++;
769: my $id=$$.'-'.$locknum;
770: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
771: 'session.lock.'.$id => $text});
772: return $id;
773: }
774:
775: sub get_locks {
776: my $num=0;
777: my %texts=();
778: foreach my $lock (split(/\,/,$env{'session.locks'})) {
779: if ($lock=~/\w/) {
780: $num++;
781: $texts{$lock}=$env{'session.lock.'.$lock};
782: }
783: }
784: return ($num,%texts);
785: }
786:
787: sub remove_lock {
788: my ($id)=@_;
789: my $newlocks='';
790: foreach my $lock (split(/\,/,$env{'session.locks'})) {
791: if (($lock=~/\w/) && ($lock ne $id)) {
792: $newlocks.=','.$lock;
793: }
794: }
795: &appenv({'session.locks' => $newlocks});
796: &delenv('session.lock.'.$id);
797: }
798:
799: sub remove_all_locks {
800: my $activelocks=$env{'session.locks'};
801: foreach my $lock (split(/\,/,$env{'session.locks'})) {
802: if ($lock=~/\w/) {
803: &remove_lock($lock);
804: }
805: }
806: }
807:
808:
809: # ------------------------------------------ Find out current server userload
810: sub userload {
811: my $numusers=0;
812: {
813: opendir(LONIDS,$perlvar{'lonIDsDir'});
814: my $filename;
815: my $curtime=time;
816: while ($filename=readdir(LONIDS)) {
817: next if ($filename eq '.' || $filename eq '..');
818: next if ($filename =~ /publicuser_\d+\.id/);
819: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
820: if ($curtime-$mtime < 1800) { $numusers++; }
821: }
822: closedir(LONIDS);
823: }
824: my $userloadpercent=0;
825: my $maxuserload=$perlvar{'lonUserLoadLim'};
826: if ($maxuserload) {
827: $userloadpercent=100*$numusers/$maxuserload;
828: }
829: $userloadpercent=sprintf("%.2f",$userloadpercent);
830: return $userloadpercent;
831: }
832:
833: # ------------------------------ Find server with least workload from spare.tab
834:
835: sub spareserver {
836: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
837: my $spare_server;
838: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
839: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
840: : $userloadpercent;
841: my ($uint_dom,$remotesessions);
842: if (($udom ne '') && (&domain($udom) ne '')) {
843: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
844: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
845: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
846: $remotesessions = $udomdefaults{'remotesessions'};
847: }
848: my $spareshash = &this_host_spares($udom);
849: if (ref($spareshash) eq 'HASH') {
850: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
851: foreach my $try_server (@{ $spareshash->{'primary'} }) {
852: if ($uint_dom) {
853: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
854: $try_server));
855: }
856: ($spare_server, $lowest_load) =
857: &compare_server_load($try_server, $spare_server, $lowest_load);
858: }
859: }
860:
861: my $found_server = ($spare_server ne '' && $lowest_load < 100);
862:
863: if (!$found_server) {
864: if (ref($spareshash->{'default'}) eq 'ARRAY') {
865: foreach my $try_server (@{ $spareshash->{'default'} }) {
866: if ($uint_dom) {
867: next unless (&spare_can_host($udom,$uint_dom,
868: $remotesessions,$try_server));
869: }
870: ($spare_server, $lowest_load) =
871: &compare_server_load($try_server, $spare_server, $lowest_load);
872: }
873: }
874: }
875: }
876:
877: if (!$want_server_name) {
878: my $protocol = 'http';
879: if ($protocol{$spare_server} eq 'https') {
880: $protocol = $protocol{$spare_server};
881: }
882: if (defined($spare_server)) {
883: my $hostname = &hostname($spare_server);
884: if (defined($hostname)) {
885: $spare_server = $protocol.'://'.$hostname;
886: }
887: }
888: }
889: return $spare_server;
890: }
891:
892: sub compare_server_load {
893: my ($try_server, $spare_server, $lowest_load, $required) = @_;
894:
895: if ($required) {
896: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
897: my $remoterev = &get_server_loncaparev(undef,$try_server);
898: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
899: if (($major eq '' && $minor eq '') ||
900: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
901: return ($spare_server,$lowest_load);
902: }
903: }
904:
905: my $loadans = &reply('load', $try_server);
906: my $userloadans = &reply('userload',$try_server);
907:
908: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
909: return ($spare_server, $lowest_load); #didn't get a number from the server
910: }
911:
912: my $load;
913: if ($loadans =~ /\d/) {
914: if ($userloadans =~ /\d/) {
915: #both are numbers, pick the bigger one
916: $load = ($loadans > $userloadans) ? $loadans
917: : $userloadans;
918: } else {
919: $load = $loadans;
920: }
921: } else {
922: $load = $userloadans;
923: }
924:
925: if (($load =~ /\d/) && ($load < $lowest_load)) {
926: $spare_server = $try_server;
927: $lowest_load = $load;
928: }
929: return ($spare_server,$lowest_load);
930: }
931:
932: # --------------------------- ask offload servers if user already has a session
933: sub find_existing_session {
934: my ($udom,$uname) = @_;
935: my $spareshash = &this_host_spares($udom);
936: if (ref($spareshash) eq 'HASH') {
937: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
938: foreach my $try_server (@{ $spareshash->{'primary'} }) {
939: return $try_server if (&has_user_session($try_server, $udom, $uname));
940: }
941: }
942: if (ref($spareshash->{'default'}) eq 'ARRAY') {
943: foreach my $try_server (@{ $spareshash->{'default'} }) {
944: return $try_server if (&has_user_session($try_server, $udom, $uname));
945: }
946: }
947: }
948: return;
949: }
950:
951: # -------------------------------- ask if server already has a session for user
952: sub has_user_session {
953: my ($lonid,$udom,$uname) = @_;
954: my $result = &reply(join(':','userhassession',
955: map {&escape($_)} ($udom,$uname)),$lonid);
956: return 1 if ($result eq 'ok');
957:
958: return 0;
959: }
960:
961: # --------- determine least loaded server in a user's domain which allows login
962:
963: sub choose_server {
964: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
965: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
966: my %servers = &get_servers($udom);
967: my $lowest_load = 30000;
968: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
969: if ($skiploadbal) {
970: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
971: unless (defined($cached)) {
972: my $cachetime = 60*60*24;
973: my %domconfig =
974: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
975: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
976: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
977: $cachetime);
978: }
979: }
980: }
981: foreach my $lonhost (keys(%servers)) {
982: if ($skiploadbal) {
983: if (ref($balancers) eq 'HASH') {
984: next if (exists($balancers->{$lonhost}));
985: }
986: }
987: my $loginvia;
988: if ($checkloginvia) {
989: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
990: if ($loginvia) {
991: my ($server,$path) = split(/:/,$loginvia);
992: ($login_host, $lowest_load) =
993: &compare_server_load($server, $login_host, $lowest_load, $required);
994: if ($login_host eq $server) {
995: $portal_path = $path;
996: $isredirect = 1;
997: }
998: } else {
999: ($login_host, $lowest_load) =
1000: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1001: if ($login_host eq $lonhost) {
1002: $portal_path = '';
1003: $isredirect = '';
1004: }
1005: }
1006: } else {
1007: ($login_host, $lowest_load) =
1008: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1009: }
1010: }
1011: if ($login_host ne '') {
1012: $hostname = &hostname($login_host);
1013: }
1014: return ($login_host,$hostname,$portal_path,$isredirect);
1015: }
1016:
1017: # --------------------------------------------- Try to change a user's password
1018:
1019: sub changepass {
1020: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1021: $currentpass = &escape($currentpass);
1022: $newpass = &escape($newpass);
1023: my $lonhost = $perlvar{'lonHostID'};
1024: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1025: $server);
1026: if (! $answer) {
1027: &logthis("No reply on password change request to $server ".
1028: "by $uname in domain $udom.");
1029: } elsif ($answer =~ "^ok") {
1030: &logthis("$uname in $udom successfully changed their password ".
1031: "on $server.");
1032: } elsif ($answer =~ "^pwchange_failure") {
1033: &logthis("$uname in $udom was unable to change their password ".
1034: "on $server. The action was blocked by either lcpasswd ".
1035: "or pwchange");
1036: } elsif ($answer =~ "^non_authorized") {
1037: &logthis("$uname in $udom did not get their password correct when ".
1038: "attempting to change it on $server.");
1039: } elsif ($answer =~ "^auth_mode_error") {
1040: &logthis("$uname in $udom attempted to change their password despite ".
1041: "not being locally or internally authenticated on $server.");
1042: } elsif ($answer =~ "^unknown_user") {
1043: &logthis("$uname in $udom attempted to change their password ".
1044: "on $server but were unable to because $server is not ".
1045: "their home server.");
1046: } elsif ($answer =~ "^refused") {
1047: &logthis("$server refused to change $uname in $udom password because ".
1048: "it was sent an unencrypted request to change the password.");
1049: } elsif ($answer =~ "invalid_client") {
1050: &logthis("$server refused to change $uname in $udom password because ".
1051: "it was a reset by e-mail originating from an invalid server.");
1052: }
1053: return $answer;
1054: }
1055:
1056: # ----------------------- Try to determine user's current authentication scheme
1057:
1058: sub queryauthenticate {
1059: my ($uname,$udom)=@_;
1060: my $uhome=&homeserver($uname,$udom);
1061: if (!$uhome) {
1062: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1063: return 'no_host';
1064: }
1065: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1066: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1067: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1068: }
1069: return $answer;
1070: }
1071:
1072: # --------- Try to authenticate user from domain's lib servers (first this one)
1073:
1074: sub authenticate {
1075: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1076: $upass=&escape($upass);
1077: $uname= &LONCAPA::clean_username($uname);
1078: my $uhome=&homeserver($uname,$udom,1);
1079: my $newhome;
1080: if ((!$uhome) || ($uhome eq 'no_host')) {
1081: # Maybe the machine was offline and only re-appeared again recently?
1082: &reconlonc();
1083: # One more
1084: $uhome=&homeserver($uname,$udom,1);
1085: if (($uhome eq 'no_host') && $checkdefauth) {
1086: if (defined(&domain($udom,'primary'))) {
1087: $newhome=&domain($udom,'primary');
1088: }
1089: if ($newhome ne '') {
1090: $uhome = $newhome;
1091: }
1092: }
1093: if ((!$uhome) || ($uhome eq 'no_host')) {
1094: &logthis("User $uname at $udom is unknown in authenticate");
1095: return 'no_host';
1096: }
1097: }
1098: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1099: if ($answer eq 'authorized') {
1100: if ($newhome) {
1101: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1102: return 'no_account_on_host';
1103: } else {
1104: &logthis("User $uname at $udom authorized by $uhome");
1105: return $uhome;
1106: }
1107: }
1108: if ($answer eq 'non_authorized') {
1109: &logthis("User $uname at $udom rejected by $uhome");
1110: return 'no_host';
1111: }
1112: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1113: return 'no_host';
1114: }
1115:
1116: sub can_host_session {
1117: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1118: my $canhost = 1;
1119: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1120: if (ref($remotesessions) eq 'HASH') {
1121: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1122: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1123: $canhost = 0;
1124: } else {
1125: $canhost = 1;
1126: }
1127: }
1128: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1129: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1130: $canhost = 1;
1131: } else {
1132: $canhost = 0;
1133: }
1134: }
1135: if ($canhost) {
1136: if ($remotesessions->{'version'} ne '') {
1137: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1138: if ($reqmajor ne '' && $reqminor ne '') {
1139: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1140: my $major = $1;
1141: my $minor = $2;
1142: if (($major < $reqmajor ) ||
1143: (($major == $reqmajor) && ($minor < $reqminor))) {
1144: $canhost = 0;
1145: }
1146: } else {
1147: $canhost = 0;
1148: }
1149: }
1150: }
1151: }
1152: }
1153: if ($canhost) {
1154: if (ref($hostedsessions) eq 'HASH') {
1155: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1156: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1157: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1158: if (($uint_dom ne '') &&
1159: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1160: $canhost = 0;
1161: } else {
1162: $canhost = 1;
1163: }
1164: }
1165: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1166: if (($uint_dom ne '') &&
1167: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1168: $canhost = 1;
1169: } else {
1170: $canhost = 0;
1171: }
1172: }
1173: }
1174: }
1175: return $canhost;
1176: }
1177:
1178: sub spare_can_host {
1179: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1180: my $canhost=1;
1181: my @intdoms;
1182: my $internet_names = &Apache::lonnet::get_internet_names($try_server);
1183: if (ref($internet_names) eq 'ARRAY') {
1184: @intdoms = @{$internet_names};
1185: }
1186: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1187: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
1188: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1189: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
1190: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
1191: $canhost = &can_host_session($udom,$try_server,$remoterev,
1192: $remotesessions,
1193: $defdomdefaults{'hostedsessions'});
1194: }
1195: return $canhost;
1196: }
1197:
1198: sub this_host_spares {
1199: my ($dom) = @_;
1200: my ($dom_in_use,$lonhost_in_use,$result);
1201: my @hosts = ¤t_machine_ids();
1202: foreach my $lonhost (@hosts) {
1203: if (&host_domain($lonhost) eq $dom) {
1204: $dom_in_use = $dom;
1205: $lonhost_in_use = $lonhost;
1206: last;
1207: }
1208: }
1209: if ($dom_in_use ne '') {
1210: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1211: }
1212: if (ref($result) ne 'HASH') {
1213: $lonhost_in_use = $perlvar{'lonHostID'};
1214: $dom_in_use = &host_domain($lonhost_in_use);
1215: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1216: if (ref($result) ne 'HASH') {
1217: $result = \%spareid;
1218: }
1219: }
1220: return $result;
1221: }
1222:
1223: sub spares_for_offload {
1224: my ($dom_in_use,$lonhost_in_use) = @_;
1225: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1226: if (defined($cached)) {
1227: return $result;
1228: } else {
1229: my $cachetime = 60*60*24;
1230: my %domconfig =
1231: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1232: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1233: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1234: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1235: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1236: }
1237: }
1238: }
1239: }
1240: return;
1241: }
1242:
1243: sub get_lonbalancer_config {
1244: my ($servers) = @_;
1245: my ($currbalancer,$currtargets);
1246: if (ref($servers) eq 'HASH') {
1247: foreach my $server (keys(%{$servers})) {
1248: my %what = (
1249: spareid => 1,
1250: perlvar => 1,
1251: );
1252: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1253: if ($result eq 'ok') {
1254: if (ref($returnhash) eq 'HASH') {
1255: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1256: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1257: $currbalancer = $server;
1258: $currtargets = {};
1259: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1260: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1261: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1262: }
1263: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1264: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1265: }
1266: }
1267: last;
1268: }
1269: }
1270: }
1271: }
1272: }
1273: }
1274: return ($currbalancer,$currtargets);
1275: }
1276:
1277: sub check_loadbalancing {
1278: my ($uname,$udom) = @_;
1279: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1280: $rule_in_effect,$offloadto,$otherserver);
1281: my $lonhost = $perlvar{'lonHostID'};
1282: my @hosts = ¤t_machine_ids();
1283: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1284: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1285: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1286: my $serverhomedom = &host_domain($lonhost);
1287:
1288: my $cachetime = 60*60*24;
1289:
1290: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1291: $dom_in_use = $udom;
1292: $homeintdom = 1;
1293: } else {
1294: $dom_in_use = $serverhomedom;
1295: }
1296: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1297: unless (defined($cached)) {
1298: my %domconfig =
1299: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1300: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1301: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1302: }
1303: }
1304: if (ref($result) eq 'HASH') {
1305: ($is_balancer,$currtargets,$currrules) =
1306: &check_balancer_result($result,@hosts);
1307: if ($is_balancer) {
1308: if (ref($currrules) eq 'HASH') {
1309: if ($homeintdom) {
1310: if ($uname ne '') {
1311: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1312: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1313: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1314: $rule_in_effect = $currrules->{'_LC_author'};
1315: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1316: $rule_in_effect = $currrules->{'_LC_adv'}
1317: }
1318: }
1319: if ($rule_in_effect eq '') {
1320: my %userenv = &userenvironment($udom,$uname,'inststatus');
1321: if ($userenv{'inststatus'} ne '') {
1322: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1323: my ($othertitle,$usertypes,$types) =
1324: &Apache::loncommon::sorted_inst_types($udom);
1325: if (ref($types) eq 'ARRAY') {
1326: foreach my $type (@{$types}) {
1327: if (grep(/^\Q$type\E$/,@statuses)) {
1328: if (exists($currrules->{$type})) {
1329: $rule_in_effect = $currrules->{$type};
1330: }
1331: }
1332: }
1333: }
1334: } else {
1335: if (exists($currrules->{'default'})) {
1336: $rule_in_effect = $currrules->{'default'};
1337: }
1338: }
1339: }
1340: } else {
1341: if (exists($currrules->{'default'})) {
1342: $rule_in_effect = $currrules->{'default'};
1343: }
1344: }
1345: } else {
1346: if ($currrules->{'_LC_external'} ne '') {
1347: $rule_in_effect = $currrules->{'_LC_external'};
1348: }
1349: }
1350: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1351: $uname,$udom);
1352: }
1353: }
1354: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1355: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1356: unless (defined($cached)) {
1357: my %domconfig =
1358: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1359: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1360: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1361: }
1362: }
1363: if (ref($result) eq 'HASH') {
1364: ($is_balancer,$currtargets,$currrules) =
1365: &check_balancer_result($result,@hosts);
1366: if ($is_balancer) {
1367: if (ref($currrules) eq 'HASH') {
1368: if ($currrules->{'_LC_internetdom'} ne '') {
1369: $rule_in_effect = $currrules->{'_LC_internetdom'};
1370: }
1371: }
1372: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1373: $uname,$udom);
1374: }
1375: } else {
1376: if ($perlvar{'lonBalancer'} eq 'yes') {
1377: $is_balancer = 1;
1378: $offloadto = &this_host_spares($dom_in_use);
1379: }
1380: }
1381: } else {
1382: if ($perlvar{'lonBalancer'} eq 'yes') {
1383: $is_balancer = 1;
1384: $offloadto = &this_host_spares($dom_in_use);
1385: }
1386: }
1387: if ($is_balancer) {
1388: my $lowest_load = 30000;
1389: if (ref($offloadto) eq 'HASH') {
1390: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1391: foreach my $try_server (@{$offloadto->{'primary'}}) {
1392: ($otherserver,$lowest_load) =
1393: &compare_server_load($try_server,$otherserver,$lowest_load);
1394: }
1395: }
1396: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1397:
1398: if (!$found_server) {
1399: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1400: foreach my $try_server (@{$offloadto->{'default'}}) {
1401: ($otherserver,$lowest_load) =
1402: &compare_server_load($try_server,$otherserver,$lowest_load);
1403: }
1404: }
1405: }
1406: } elsif (ref($offloadto) eq 'ARRAY') {
1407: if (@{$offloadto} == 1) {
1408: $otherserver = $offloadto->[0];
1409: } elsif (@{$offloadto} > 1) {
1410: foreach my $try_server (@{$offloadto}) {
1411: ($otherserver,$lowest_load) =
1412: &compare_server_load($try_server,$otherserver,$lowest_load);
1413: }
1414: }
1415: }
1416: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1417: $is_balancer = 0;
1418: if ($uname ne '' && $udom ne '') {
1419: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1420:
1421: &appenv({'user.loadbalexempt' => $lonhost,
1422: 'user.loadbalcheck.time' => time});
1423: }
1424: }
1425: }
1426: }
1427: return ($is_balancer,$otherserver);
1428: }
1429:
1430: sub check_balancer_result {
1431: my ($result,@hosts) = @_;
1432: my ($is_balancer,$currtargets,$currrules);
1433: if (ref($result) eq 'HASH') {
1434: if ($result->{'lonhost'} ne '') {
1435: my $currbalancer = $result->{'lonhost'};
1436: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1437: $is_balancer = 1;
1438: $currtargets = $result->{'targets'};
1439: $currrules = $result->{'rules'};
1440: }
1441: } else {
1442: foreach my $key (keys(%{$result})) {
1443: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1444: (ref($result->{$key}) eq 'HASH')) {
1445: $is_balancer = 1;
1446: $currrules = $result->{$key}{'rules'};
1447: $currtargets = $result->{$key}{'targets'};
1448: last;
1449: }
1450: }
1451: }
1452: }
1453: return ($is_balancer,$currtargets,$currrules);
1454: }
1455:
1456: sub get_loadbalancer_targets {
1457: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1458: my $offloadto;
1459: if ($rule_in_effect eq 'none') {
1460: return [$perlvar{'lonHostID'}];
1461: } elsif ($rule_in_effect eq '') {
1462: $offloadto = $currtargets;
1463: } else {
1464: if ($rule_in_effect eq 'homeserver') {
1465: my $homeserver = &homeserver($uname,$udom);
1466: if ($homeserver ne 'no_host') {
1467: $offloadto = [$homeserver];
1468: }
1469: } elsif ($rule_in_effect eq 'externalbalancer') {
1470: my %domconfig =
1471: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1472: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1473: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1474: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1475: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1476: }
1477: }
1478: } else {
1479: my %servers = &internet_dom_servers($udom);
1480: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1481: if (&hostname($remotebalancer) ne '') {
1482: $offloadto = [$remotebalancer];
1483: }
1484: }
1485: } elsif (&hostname($rule_in_effect) ne '') {
1486: $offloadto = [$rule_in_effect];
1487: }
1488: }
1489: return $offloadto;
1490: }
1491:
1492: sub internet_dom_servers {
1493: my ($dom) = @_;
1494: my (%uniqservers,%servers);
1495: my $primaryserver = &hostname(&domain($dom,'primary'));
1496: my @machinedoms = &machine_domains($primaryserver);
1497: foreach my $mdom (@machinedoms) {
1498: my %currservers = %servers;
1499: my %server = &get_servers($mdom);
1500: %servers = (%currservers,%server);
1501: }
1502: my %by_hostname;
1503: foreach my $id (keys(%servers)) {
1504: push(@{$by_hostname{$servers{$id}}},$id);
1505: }
1506: foreach my $hostname (sort(keys(%by_hostname))) {
1507: if (@{$by_hostname{$hostname}} > 1) {
1508: my $match = 0;
1509: foreach my $id (@{$by_hostname{$hostname}}) {
1510: if (&host_domain($id) eq $dom) {
1511: $uniqservers{$id} = $hostname;
1512: $match = 1;
1513: }
1514: }
1515: unless ($match) {
1516: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1517: }
1518: } else {
1519: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1520: }
1521: }
1522: return %uniqservers;
1523: }
1524:
1525: # ---------------------- Find the homebase for a user from domain's lib servers
1526:
1527: my %homecache;
1528: sub homeserver {
1529: my ($uname,$udom,$ignoreBadCache)=@_;
1530: my $index="$uname:$udom";
1531:
1532: if (exists($homecache{$index})) { return $homecache{$index}; }
1533:
1534: my %servers = &get_servers($udom,'library');
1535: foreach my $tryserver (keys(%servers)) {
1536: next if ($ignoreBadCache ne 'true' &&
1537: exists($badServerCache{$tryserver}));
1538:
1539: my $answer=reply("home:$udom:$uname",$tryserver);
1540: if ($answer eq 'found') {
1541: delete($badServerCache{$tryserver});
1542: return $homecache{$index}=$tryserver;
1543: } elsif ($answer eq 'no_host') {
1544: $badServerCache{$tryserver}=1;
1545: }
1546: }
1547: return 'no_host';
1548: }
1549:
1550: # ------------------------------------- Find the usernames behind a list of IDs
1551:
1552: sub idget {
1553: my ($udom,@ids)=@_;
1554: my %returnhash=();
1555:
1556: my %servers = &get_servers($udom,'library');
1557: foreach my $tryserver (keys(%servers)) {
1558: my $idlist=join('&',@ids);
1559: $idlist=~tr/A-Z/a-z/;
1560: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1561: my @answer=();
1562: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1563: @answer=split(/\&/,$reply);
1564: } ;
1565: my $i;
1566: for ($i=0;$i<=$#ids;$i++) {
1567: if ($answer[$i]) {
1568: $returnhash{$ids[$i]}=$answer[$i];
1569: }
1570: }
1571: }
1572: return %returnhash;
1573: }
1574:
1575: # ------------------------------------- Find the IDs behind a list of usernames
1576:
1577: sub idrget {
1578: my ($udom,@unames)=@_;
1579: my %returnhash=();
1580: foreach my $uname (@unames) {
1581: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1582: }
1583: return %returnhash;
1584: }
1585:
1586: # ------------------------------- Store away a list of names and associated IDs
1587:
1588: sub idput {
1589: my ($udom,%ids)=@_;
1590: my %servers=();
1591: foreach my $uname (keys(%ids)) {
1592: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1593: my $uhom=&homeserver($uname,$udom);
1594: if ($uhom ne 'no_host') {
1595: my $id=&escape($ids{$uname});
1596: $id=~tr/A-Z/a-z/;
1597: my $esc_unam=&escape($uname);
1598: if ($servers{$uhom}) {
1599: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1600: } else {
1601: $servers{$uhom}=$id.'='.$esc_unam;
1602: }
1603: }
1604: }
1605: foreach my $server (keys(%servers)) {
1606: &critical('idput:'.$udom.':'.$servers{$server},$server);
1607: }
1608: }
1609:
1610: # ---------------------------------------- Delete unwanted IDs from ids.db file
1611:
1612: sub iddel {
1613: my ($udom,$idshashref,$uhome)=@_;
1614: my %result=();
1615: unless (ref($idshashref) eq 'HASH') {
1616: return %result;
1617: }
1618: my %servers=();
1619: while (my ($id,$uname) = each(%{$idshashref})) {
1620: my $uhom;
1621: if ($uhome) {
1622: $uhom = $uhome;
1623: } else {
1624: $uhom=&homeserver($uname,$udom);
1625: }
1626: if ($uhom ne 'no_host') {
1627: if ($servers{$uhom}) {
1628: $servers{$uhom}.='&'.&escape($id);
1629: } else {
1630: $servers{$uhom}=&escape($id);
1631: }
1632: }
1633: }
1634: foreach my $server (keys(%servers)) {
1635: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1636: }
1637: return %result;
1638: }
1639:
1640: # ------------------------------dump from db file owned by domainconfig user
1641: sub dump_dom {
1642: my ($namespace, $udom, $regexp) = @_;
1643:
1644: $udom ||= $env{'user.domain'};
1645:
1646: return () unless $udom;
1647:
1648: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1649: }
1650:
1651: # ------------------------------------------ get items from domain db files
1652:
1653: sub get_dom {
1654: my ($namespace,$storearr,$udom,$uhome)=@_;
1655: return if ($udom eq 'public');
1656: my $items='';
1657: foreach my $item (@$storearr) {
1658: $items.=&escape($item).'&';
1659: }
1660: $items=~s/\&$//;
1661: if (!$udom) {
1662: $udom=$env{'user.domain'};
1663: return if ($udom eq 'public');
1664: if (defined(&domain($udom,'primary'))) {
1665: $uhome=&domain($udom,'primary');
1666: } else {
1667: undef($uhome);
1668: }
1669: } else {
1670: if (!$uhome) {
1671: if (defined(&domain($udom,'primary'))) {
1672: $uhome=&domain($udom,'primary');
1673: }
1674: }
1675: }
1676: if ($udom && $uhome && ($uhome ne 'no_host')) {
1677: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1678: my %returnhash;
1679: if ($rep eq '' || $rep =~ /^error: 2 /) {
1680: return %returnhash;
1681: }
1682: my @pairs=split(/\&/,$rep);
1683: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1684: return @pairs;
1685: }
1686: my $i=0;
1687: foreach my $item (@$storearr) {
1688: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1689: $i++;
1690: }
1691: return %returnhash;
1692: } else {
1693: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1694: }
1695: }
1696:
1697: # -------------------------------------------- put items in domain db files
1698:
1699: sub put_dom {
1700: my ($namespace,$storehash,$udom,$uhome)=@_;
1701: if (!$udom) {
1702: $udom=$env{'user.domain'};
1703: if (defined(&domain($udom,'primary'))) {
1704: $uhome=&domain($udom,'primary');
1705: } else {
1706: undef($uhome);
1707: }
1708: } else {
1709: if (!$uhome) {
1710: if (defined(&domain($udom,'primary'))) {
1711: $uhome=&domain($udom,'primary');
1712: }
1713: }
1714: }
1715: if ($udom && $uhome && ($uhome ne 'no_host')) {
1716: my $items='';
1717: foreach my $item (keys(%$storehash)) {
1718: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1719: }
1720: $items=~s/\&$//;
1721: return &reply("putdom:$udom:$namespace:$items",$uhome);
1722: } else {
1723: &logthis("put_dom failed - no homeserver and/or domain");
1724: }
1725: }
1726:
1727: # --------------------- newput for items in db file owned by domainconfig user
1728: sub newput_dom {
1729: my ($namespace,$storehash,$udom) = @_;
1730: my $result;
1731: if (!$udom) {
1732: $udom=$env{'user.domain'};
1733: }
1734: if ($udom) {
1735: my $uname = &get_domainconfiguser($udom);
1736: $result = &newput($namespace,$storehash,$udom,$uname);
1737: }
1738: return $result;
1739: }
1740:
1741: # --------------------- delete for items in db file owned by domainconfig user
1742: sub del_dom {
1743: my ($namespace,$storearr,$udom)=@_;
1744: if (ref($storearr) eq 'ARRAY') {
1745: if (!$udom) {
1746: $udom=$env{'user.domain'};
1747: }
1748: if ($udom) {
1749: my $uname = &get_domainconfiguser($udom);
1750: return &del($namespace,$storearr,$udom,$uname);
1751: }
1752: }
1753: }
1754:
1755: # ----------------------------------construct domainconfig user for a domain
1756: sub get_domainconfiguser {
1757: my ($udom) = @_;
1758: return $udom.'-domainconfig';
1759: }
1760:
1761: sub retrieve_inst_usertypes {
1762: my ($udom) = @_;
1763: my (%returnhash,@order);
1764: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1765: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1766: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1767: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1768: } else {
1769: if (defined(&domain($udom,'primary'))) {
1770: my $uhome=&domain($udom,'primary');
1771: my $rep=&reply("inst_usertypes:$udom",$uhome);
1772: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1773: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1774: return (\%returnhash,\@order);
1775: }
1776: my ($hashitems,$orderitems) = split(/:/,$rep);
1777: my @pairs=split(/\&/,$hashitems);
1778: foreach my $item (@pairs) {
1779: my ($key,$value)=split(/=/,$item,2);
1780: $key = &unescape($key);
1781: next if ($key =~ /^error: 2 /);
1782: $returnhash{$key}=&thaw_unescape($value);
1783: }
1784: my @esc_order = split(/\&/,$orderitems);
1785: foreach my $item (@esc_order) {
1786: push(@order,&unescape($item));
1787: }
1788: } else {
1789: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1790: }
1791: return (\%returnhash,\@order);
1792: }
1793: }
1794:
1795: sub is_domainimage {
1796: my ($url) = @_;
1797: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1798: if (&domain($1) ne '') {
1799: return '1';
1800: }
1801: }
1802: return;
1803: }
1804:
1805: sub inst_directory_query {
1806: my ($srch) = @_;
1807: my $udom = $srch->{'srchdomain'};
1808: my %results;
1809: my $homeserver = &domain($udom,'primary');
1810: my $outcome;
1811: if ($homeserver ne '') {
1812: my $queryid=&reply("querysend:instdirsearch:".
1813: &escape($srch->{'srchby'}).':'.
1814: &escape($srch->{'srchterm'}).':'.
1815: &escape($srch->{'srchtype'}),$homeserver);
1816: my $host=&hostname($homeserver);
1817: if ($queryid !~/^\Q$host\E\_/) {
1818: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1819: return;
1820: }
1821: my $response = &get_query_reply($queryid);
1822: my $maxtries = 5;
1823: my $tries = 1;
1824: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1825: $response = &get_query_reply($queryid);
1826: $tries ++;
1827: }
1828:
1829: if (!&error($response) && $response ne 'refused') {
1830: if ($response eq 'unavailable') {
1831: $outcome = $response;
1832: } else {
1833: $outcome = 'ok';
1834: my @matches = split(/\n/,$response);
1835: foreach my $match (@matches) {
1836: my ($key,$value) = split(/=/,$match);
1837: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1838: }
1839: }
1840: }
1841: }
1842: return ($outcome,%results);
1843: }
1844:
1845: sub usersearch {
1846: my ($srch) = @_;
1847: my $dom = $srch->{'srchdomain'};
1848: my %results;
1849: my %libserv = &all_library();
1850: my $query = 'usersearch';
1851: foreach my $tryserver (keys(%libserv)) {
1852: if (&host_domain($tryserver) eq $dom) {
1853: my $host=&hostname($tryserver);
1854: my $queryid=
1855: &reply("querysend:".&escape($query).':'.
1856: &escape($srch->{'srchby'}).':'.
1857: &escape($srch->{'srchtype'}).':'.
1858: &escape($srch->{'srchterm'}),$tryserver);
1859: if ($queryid !~/^\Q$host\E\_/) {
1860: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1861: next;
1862: }
1863: my $reply = &get_query_reply($queryid);
1864: my $maxtries = 1;
1865: my $tries = 1;
1866: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1867: $reply = &get_query_reply($queryid);
1868: $tries ++;
1869: }
1870: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1871: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1872: } else {
1873: my @matches;
1874: if ($reply =~ /\n/) {
1875: @matches = split(/\n/,$reply);
1876: } else {
1877: @matches = split(/\&/,$reply);
1878: }
1879: foreach my $match (@matches) {
1880: my ($uname,$udom,%userhash);
1881: foreach my $entry (split(/:/,$match)) {
1882: my ($key,$value) =
1883: map {&unescape($_);} split(/=/,$entry);
1884: $userhash{$key} = $value;
1885: if ($key eq 'username') {
1886: $uname = $value;
1887: } elsif ($key eq 'domain') {
1888: $udom = $value;
1889: }
1890: }
1891: $results{$uname.':'.$udom} = \%userhash;
1892: }
1893: }
1894: }
1895: }
1896: return %results;
1897: }
1898:
1899: sub get_instuser {
1900: my ($udom,$uname,$id) = @_;
1901: my $homeserver = &domain($udom,'primary');
1902: my ($outcome,%results);
1903: if ($homeserver ne '') {
1904: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1905: &escape($id).':'.&escape($udom),$homeserver);
1906: my $host=&hostname($homeserver);
1907: if ($queryid !~/^\Q$host\E\_/) {
1908: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1909: return;
1910: }
1911: my $response = &get_query_reply($queryid);
1912: my $maxtries = 5;
1913: my $tries = 1;
1914: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1915: $response = &get_query_reply($queryid);
1916: $tries ++;
1917: }
1918: if (!&error($response) && $response ne 'refused') {
1919: if ($response eq 'unavailable') {
1920: $outcome = $response;
1921: } else {
1922: $outcome = 'ok';
1923: my @matches = split(/\n/,$response);
1924: foreach my $match (@matches) {
1925: my ($key,$value) = split(/=/,$match);
1926: $results{&unescape($key)} = &thaw_unescape($value);
1927: }
1928: }
1929: }
1930: }
1931: my %userinfo;
1932: if (ref($results{$uname}) eq 'HASH') {
1933: %userinfo = %{$results{$uname}};
1934: }
1935: return ($outcome,%userinfo);
1936: }
1937:
1938: sub inst_rulecheck {
1939: my ($udom,$uname,$id,$item,$rules) = @_;
1940: my %returnhash;
1941: if ($udom ne '') {
1942: if (ref($rules) eq 'ARRAY') {
1943: @{$rules} = map {&escape($_);} (@{$rules});
1944: my $rulestr = join(':',@{$rules});
1945: my $homeserver=&domain($udom,'primary');
1946: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1947: my $response;
1948: if ($item eq 'username') {
1949: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1950: ':'.&escape($uname).':'.$rulestr,
1951: $homeserver));
1952: } elsif ($item eq 'id') {
1953: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1954: ':'.&escape($id).':'.$rulestr,
1955: $homeserver));
1956: } elsif ($item eq 'selfcreate') {
1957: $response=&unescape(&reply('instselfcreatecheck:'.
1958: &escape($udom).':'.&escape($uname).
1959: ':'.$rulestr,$homeserver));
1960: }
1961: if ($response ne 'refused') {
1962: my @pairs=split(/\&/,$response);
1963: foreach my $item (@pairs) {
1964: my ($key,$value)=split(/=/,$item,2);
1965: $key = &unescape($key);
1966: next if ($key =~ /^error: 2 /);
1967: $returnhash{$key}=&thaw_unescape($value);
1968: }
1969: }
1970: }
1971: }
1972: }
1973: return %returnhash;
1974: }
1975:
1976: sub inst_userrules {
1977: my ($udom,$check) = @_;
1978: my (%ruleshash,@ruleorder);
1979: if ($udom ne '') {
1980: my $homeserver=&domain($udom,'primary');
1981: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1982: my $response;
1983: if ($check eq 'id') {
1984: $response=&reply('instidrules:'.&escape($udom),
1985: $homeserver);
1986: } elsif ($check eq 'email') {
1987: $response=&reply('instemailrules:'.&escape($udom),
1988: $homeserver);
1989: } else {
1990: $response=&reply('instuserrules:'.&escape($udom),
1991: $homeserver);
1992: }
1993: if (($response ne 'refused') && ($response ne 'error') &&
1994: ($response ne 'unknown_cmd') &&
1995: ($response ne 'no_such_host')) {
1996: my ($hashitems,$orderitems) = split(/:/,$response);
1997: my @pairs=split(/\&/,$hashitems);
1998: foreach my $item (@pairs) {
1999: my ($key,$value)=split(/=/,$item,2);
2000: $key = &unescape($key);
2001: next if ($key =~ /^error: 2 /);
2002: $ruleshash{$key}=&thaw_unescape($value);
2003: }
2004: my @esc_order = split(/\&/,$orderitems);
2005: foreach my $item (@esc_order) {
2006: push(@ruleorder,&unescape($item));
2007: }
2008: }
2009: }
2010: }
2011: return (\%ruleshash,\@ruleorder);
2012: }
2013:
2014: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2015:
2016: sub get_domain_defaults {
2017: my ($domain,$ignore_cache) = @_;
2018: return if (($domain eq '') || ($domain eq 'public'));
2019: my $cachetime = 60*60*24;
2020: unless ($ignore_cache) {
2021: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2022: if (defined($cached)) {
2023: if (ref($result) eq 'HASH') {
2024: return %{$result};
2025: }
2026: }
2027: }
2028: my %domdefaults;
2029: my %domconfig =
2030: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2031: 'requestcourses','inststatus',
2032: 'coursedefaults','usersessions',
2033: 'requestauthor','selfenrollment',
2034: 'coursecategories'],$domain);
2035: my @coursetypes = ('official','unofficial','community','textbook');
2036: if (ref($domconfig{'defaults'}) eq 'HASH') {
2037: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2038: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2039: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2040: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2041: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2042: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2043: } else {
2044: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2045: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2046: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2047: }
2048: if (ref($domconfig{'quotas'}) eq 'HASH') {
2049: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2050: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2051: } else {
2052: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2053: }
2054: my @usertools = ('aboutme','blog','webdav','portfolio');
2055: foreach my $item (@usertools) {
2056: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2057: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2058: }
2059: }
2060: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2061: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2062: }
2063: }
2064: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2065: foreach my $item ('official','unofficial','community','textbook') {
2066: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2067: }
2068: }
2069: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2070: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2071: }
2072: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2073: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2074: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2075: }
2076: }
2077: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2078: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
2079: foreach my $type (@coursetypes) {
2080: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2081: unless ($type eq 'community') {
2082: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2083: }
2084: }
2085: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2086: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2087: }
2088: }
2089: }
2090: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2091: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2092: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2093: }
2094: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2095: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2096: }
2097: }
2098: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2099: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2100: my @settings = ('types','registered','enroll_dates','access_dates','section',
2101: 'approval','limit');
2102: foreach my $type (@coursetypes) {
2103: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2104: my @mgrdc = ();
2105: foreach my $item (@settings) {
2106: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2107: push(@mgrdc,$item);
2108: }
2109: }
2110: if (@mgrdc) {
2111: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2112: }
2113: }
2114: }
2115: }
2116: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2117: foreach my $type (@coursetypes) {
2118: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2119: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2120: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2121: }
2122: }
2123: }
2124: }
2125: }
2126: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2127: $domdefaults{'catauth'} = 'std';
2128: $domdefaults{'catunauth'} = 'std';
2129: if ($domconfig{'coursecategories'}{'auth'}) {
2130: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2131: }
2132: if ($domconfig{'coursecategories'}{'unauth'}) {
2133: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2134: }
2135: }
2136: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2137: return %domdefaults;
2138: }
2139:
2140: # --------------------------------------------------- Assign a key to a student
2141:
2142: sub assign_access_key {
2143: #
2144: # a valid key looks like uname:udom#comments
2145: # comments are being appended
2146: #
2147: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2148: $kdom=
2149: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2150: $knum=
2151: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2152: $cdom=
2153: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2154: $cnum=
2155: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2156: $udom=$env{'user.name'} unless (defined($udom));
2157: $uname=$env{'user.domain'} unless (defined($uname));
2158: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2159: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2160: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2161: # assigned to this person
2162: # - this should not happen,
2163: # unless something went wrong
2164: # the first time around
2165: # ready to assign
2166: $logentry=$1.'; '.$logentry;
2167: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2168: $kdom,$knum) eq 'ok') {
2169: # key now belongs to user
2170: my $envkey='key.'.$cdom.'_'.$cnum;
2171: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2172: &appenv({'environment.'.$envkey => $ckey});
2173: return 'ok';
2174: } else {
2175: return
2176: 'error: Count not permanently assign key, will need to be re-entered later.';
2177: }
2178: } else {
2179: return 'error: Could not assign key, try again later.';
2180: }
2181: } elsif (!$existing{$ckey}) {
2182: # the key does not exist
2183: return 'error: The key does not exist';
2184: } else {
2185: # the key is somebody else's
2186: return 'error: The key is already in use';
2187: }
2188: }
2189:
2190: # ------------------------------------------ put an additional comment on a key
2191:
2192: sub comment_access_key {
2193: #
2194: # a valid key looks like uname:udom#comments
2195: # comments are being appended
2196: #
2197: my ($ckey,$cdom,$cnum,$logentry)=@_;
2198: $cdom=
2199: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2200: $cnum=
2201: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2202: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2203: if ($existing{$ckey}) {
2204: $existing{$ckey}.='; '.$logentry;
2205: # ready to assign
2206: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2207: $cdom,$cnum) eq 'ok') {
2208: return 'ok';
2209: } else {
2210: return 'error: Count not store comment.';
2211: }
2212: } else {
2213: # the key does not exist
2214: return 'error: The key does not exist';
2215: }
2216: }
2217:
2218: # ------------------------------------------------------ Generate a set of keys
2219:
2220: sub generate_access_keys {
2221: my ($number,$cdom,$cnum,$logentry)=@_;
2222: $cdom=
2223: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2224: $cnum=
2225: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2226: unless (&allowed('mky',$cdom)) { return 0; }
2227: unless (($cdom) && ($cnum)) { return 0; }
2228: if ($number>10000) { return 0; }
2229: sleep(2); # make sure don't get same seed twice
2230: srand(time()^($$+($$<<15))); # from "Programming Perl"
2231: my $total=0;
2232: for (my $i=1;$i<=$number;$i++) {
2233: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2234: sprintf("%lx",int(100000*rand)).'-'.
2235: sprintf("%lx",int(100000*rand));
2236: $newkey=~s/1/g/g; # folks mix up 1 and l
2237: $newkey=~s/0/h/g; # and also 0 and O
2238: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2239: if ($existing{$newkey}) {
2240: $i--;
2241: } else {
2242: if (&put('accesskeys',
2243: { $newkey => '# generated '.localtime().
2244: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2245: '; '.$logentry },
2246: $cdom,$cnum) eq 'ok') {
2247: $total++;
2248: }
2249: }
2250: }
2251: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2252: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2253: return $total;
2254: }
2255:
2256: # ------------------------------------------------------- Validate an accesskey
2257:
2258: sub validate_access_key {
2259: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2260: $cdom=
2261: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2262: $cnum=
2263: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2264: $udom=$env{'user.domain'} unless (defined($udom));
2265: $uname=$env{'user.name'} unless (defined($uname));
2266: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2267: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2268: }
2269:
2270: # ------------------------------------- Find the section of student in a course
2271: sub devalidate_getsection_cache {
2272: my ($udom,$unam,$courseid)=@_;
2273: my $hashid="$udom:$unam:$courseid";
2274: &devalidate_cache_new('getsection',$hashid);
2275: }
2276:
2277: sub courseid_to_courseurl {
2278: my ($courseid) = @_;
2279: #already url style courseid
2280: return $courseid if ($courseid =~ m{^/});
2281:
2282: if (exists($env{'course.'.$courseid.'.num'})) {
2283: my $cnum = $env{'course.'.$courseid.'.num'};
2284: my $cdom = $env{'course.'.$courseid.'.domain'};
2285: return "/$cdom/$cnum";
2286: }
2287:
2288: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2289: if (exists($courseinfo{'num'})) {
2290: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2291: }
2292:
2293: return undef;
2294: }
2295:
2296: sub getsection {
2297: my ($udom,$unam,$courseid)=@_;
2298: my $cachetime=1800;
2299:
2300: my $hashid="$udom:$unam:$courseid";
2301: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2302: if (defined($cached)) { return $result; }
2303:
2304: my %Pending;
2305: my %Expired;
2306: #
2307: # Each role can either have not started yet (pending), be active,
2308: # or have expired.
2309: #
2310: # If there is an active role, we are done.
2311: #
2312: # If there is more than one role which has not started yet,
2313: # choose the one which will start sooner
2314: # If there is one role which has not started yet, return it.
2315: #
2316: # If there is more than one expired role, choose the one which ended last.
2317: # If there is a role which has expired, return it.
2318: #
2319: $courseid = &courseid_to_courseurl($courseid);
2320: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2321: foreach my $key (keys(%roleshash)) {
2322: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2323: my $section=$1;
2324: if ($key eq $courseid.'_st') { $section=''; }
2325: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2326: my $now=time;
2327: if (defined($end) && $end && ($now > $end)) {
2328: $Expired{$end}=$section;
2329: next;
2330: }
2331: if (defined($start) && $start && ($now < $start)) {
2332: $Pending{$start}=$section;
2333: next;
2334: }
2335: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2336: }
2337: #
2338: # Presumedly there will be few matching roles from the above
2339: # loop and the sorting time will be negligible.
2340: if (scalar(keys(%Pending))) {
2341: my ($time) = sort {$a <=> $b} keys(%Pending);
2342: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2343: }
2344: if (scalar(keys(%Expired))) {
2345: my @sorted = sort {$a <=> $b} keys(%Expired);
2346: my $time = pop(@sorted);
2347: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2348: }
2349: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2350: }
2351:
2352: sub save_cache {
2353: &purge_remembered();
2354: #&Apache::loncommon::validate_page();
2355: undef(%env);
2356: undef($env_loaded);
2357: }
2358:
2359: my $to_remember=-1;
2360: my %remembered;
2361: my %accessed;
2362: my $kicks=0;
2363: my $hits=0;
2364: sub make_key {
2365: my ($name,$id) = @_;
2366: if (length($id) > 65
2367: && length(&escape($id)) > 200) {
2368: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2369: }
2370: return &escape($name.':'.$id);
2371: }
2372:
2373: sub devalidate_cache_new {
2374: my ($name,$id,$debug) = @_;
2375: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2376: $id=&make_key($name,$id);
2377: $memcache->delete($id);
2378: delete($remembered{$id});
2379: delete($accessed{$id});
2380: }
2381:
2382: sub is_cached_new {
2383: my ($name,$id,$debug) = @_;
2384: $id=&make_key($name,$id);
2385: if (exists($remembered{$id})) {
2386: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
2387: $accessed{$id}=[&gettimeofday()];
2388: $hits++;
2389: return ($remembered{$id},1);
2390: }
2391: my $value = $memcache->get($id);
2392: if (!(defined($value))) {
2393: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2394: return (undef,undef);
2395: }
2396: if ($value eq '__undef__') {
2397: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2398: $value=undef;
2399: }
2400: &make_room($id,$value,$debug);
2401: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2402: return ($value,1);
2403: }
2404:
2405: sub do_cache_new {
2406: my ($name,$id,$value,$time,$debug) = @_;
2407: $id=&make_key($name,$id);
2408: my $setvalue=$value;
2409: if (!defined($setvalue)) {
2410: $setvalue='__undef__';
2411: }
2412: if (!defined($time) ) {
2413: $time=600;
2414: }
2415: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2416: my $result = $memcache->set($id,$setvalue,$time);
2417: if (! $result) {
2418: &logthis("caching of id -> $id failed");
2419: $memcache->disconnect_all();
2420: }
2421: # need to make a copy of $value
2422: &make_room($id,$value,$debug);
2423: return $value;
2424: }
2425:
2426: sub make_room {
2427: my ($id,$value,$debug)=@_;
2428:
2429: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2430: : $value;
2431: if ($to_remember<0) { return; }
2432: $accessed{$id}=[&gettimeofday()];
2433: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2434: my $to_kick;
2435: my $max_time=0;
2436: foreach my $other (keys(%accessed)) {
2437: if (&tv_interval($accessed{$other}) > $max_time) {
2438: $to_kick=$other;
2439: $max_time=&tv_interval($accessed{$other});
2440: }
2441: }
2442: delete($remembered{$to_kick});
2443: delete($accessed{$to_kick});
2444: $kicks++;
2445: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2446: return;
2447: }
2448:
2449: sub purge_remembered {
2450: #&logthis("Tossing ".scalar(keys(%remembered)));
2451: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2452: undef(%remembered);
2453: undef(%accessed);
2454: }
2455: # ------------------------------------- Read an entry from a user's environment
2456:
2457: sub userenvironment {
2458: my ($udom,$unam,@what)=@_;
2459: my $items;
2460: foreach my $item (@what) {
2461: $items.=&escape($item).'&';
2462: }
2463: $items=~s/\&$//;
2464: my %returnhash=();
2465: my $uhome = &homeserver($unam,$udom);
2466: unless ($uhome eq 'no_host') {
2467: my @answer=split(/\&/,
2468: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2469: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2470: return %returnhash;
2471: }
2472: my $i;
2473: for ($i=0;$i<=$#what;$i++) {
2474: $returnhash{$what[$i]}=&unescape($answer[$i]);
2475: }
2476: }
2477: return %returnhash;
2478: }
2479:
2480: # ---------------------------------------------------------- Get a studentphoto
2481: sub studentphoto {
2482: my ($udom,$unam,$ext) = @_;
2483: my $home=&Apache::lonnet::homeserver($unam,$udom);
2484: if (defined($env{'request.course.id'})) {
2485: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2486: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2487: return(&retrievestudentphoto($udom,$unam,$ext));
2488: } else {
2489: my ($result,$perm_reqd)=
2490: &Apache::lonnet::auto_photo_permission($unam,$udom);
2491: if ($result eq 'ok') {
2492: if (!($perm_reqd eq 'yes')) {
2493: return(&retrievestudentphoto($udom,$unam,$ext));
2494: }
2495: }
2496: }
2497: }
2498: } else {
2499: my ($result,$perm_reqd) =
2500: &Apache::lonnet::auto_photo_permission($unam,$udom);
2501: if ($result eq 'ok') {
2502: if (!($perm_reqd eq 'yes')) {
2503: return(&retrievestudentphoto($udom,$unam,$ext));
2504: }
2505: }
2506: }
2507: return '/adm/lonKaputt/lonlogo_broken.gif';
2508: }
2509:
2510: sub retrievestudentphoto {
2511: my ($udom,$unam,$ext,$type) = @_;
2512: my $home=&Apache::lonnet::homeserver($unam,$udom);
2513: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2514: if ($ret eq 'ok') {
2515: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2516: if ($type eq 'thumbnail') {
2517: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2518: }
2519: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2520: return $tokenurl;
2521: } else {
2522: if ($type eq 'thumbnail') {
2523: return '/adm/lonKaputt/genericstudent_tn.gif';
2524: } else {
2525: return '/adm/lonKaputt/lonlogo_broken.gif';
2526: }
2527: }
2528: }
2529:
2530: # -------------------------------------------------------------------- New chat
2531:
2532: sub chatsend {
2533: my ($newentry,$anon,$group)=@_;
2534: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2535: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2536: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2537: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2538: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2539: &escape($newentry)).':'.$group,$chome);
2540: }
2541:
2542: # ------------------------------------------ Find current version of a resource
2543:
2544: sub getversion {
2545: my $fname=&clutter(shift);
2546: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
2547: return ¤tversion(&filelocation('',$fname));
2548: }
2549:
2550: sub currentversion {
2551: my $fname=shift;
2552: my $author=$fname;
2553: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2554: my ($udom,$uname)=split(/\//,$author);
2555: my $home=&homeserver($uname,$udom);
2556: if ($home eq 'no_host') {
2557: return -1;
2558: }
2559: my $answer=&reply("currentversion:$fname",$home);
2560: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2561: return -1;
2562: }
2563: return $answer;
2564: }
2565:
2566: #
2567: # Return special version number of resource if set by override, empty otherwise
2568: #
2569: sub usedversion {
2570: my $fname=shift;
2571: unless ($fname) { $fname=$env{'request.uri'}; }
2572: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2573: if ($urlversion) { return $urlversion; }
2574: return '';
2575: }
2576:
2577: # ----------------------------- Subscribe to a resource, return URL if possible
2578:
2579: sub subscribe {
2580: my $fname=shift;
2581: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2582: $fname=~s/[\n\r]//g;
2583: my $author=$fname;
2584: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2585: my ($udom,$uname)=split(/\//,$author);
2586: my $home=homeserver($uname,$udom);
2587: if ($home eq 'no_host') {
2588: return 'not_found';
2589: }
2590: my $answer=reply("sub:$fname",$home);
2591: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2592: $answer.=' by '.$home;
2593: }
2594: return $answer;
2595: }
2596:
2597: # -------------------------------------------------------------- Replicate file
2598:
2599: sub repcopy {
2600: my $filename=shift;
2601: $filename=~s/\/+/\//g;
2602: my $londocroot = $perlvar{'lonDocRoot'};
2603: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2604: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
2605: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2606: $filename=~m{^/*(uploaded|editupload)/}) {
2607: return &repcopy_userfile($filename);
2608: }
2609: $filename=~s/[\n\r]//g;
2610: my $transname="$filename.in.transfer";
2611: # FIXME: this should flock
2612: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2613: my $remoteurl=subscribe($filename);
2614: if ($remoteurl =~ /^con_lost by/) {
2615: &logthis("Subscribe returned $remoteurl: $filename");
2616: return 'unavailable';
2617: } elsif ($remoteurl eq 'not_found') {
2618: #&logthis("Subscribe returned not_found: $filename");
2619: return 'not_found';
2620: } elsif ($remoteurl =~ /^rejected by/) {
2621: &logthis("Subscribe returned $remoteurl: $filename");
2622: return 'forbidden';
2623: } elsif ($remoteurl eq 'directory') {
2624: return 'ok';
2625: } else {
2626: my $author=$filename;
2627: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2628: my ($udom,$uname)=split(/\//,$author);
2629: my $home=homeserver($uname,$udom);
2630: unless ($home eq $perlvar{'lonHostID'}) {
2631: my @parts=split(/\//,$filename);
2632: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2633: if ($path ne "$londocroot/res") {
2634: &logthis("Malconfiguration for replication: $filename");
2635: return 'bad_request';
2636: }
2637: my $count;
2638: for ($count=5;$count<$#parts;$count++) {
2639: $path.="/$parts[$count]";
2640: if ((-e $path)!=1) {
2641: mkdir($path,0777);
2642: }
2643: }
2644: my $ua=new LWP::UserAgent;
2645: my $request=new HTTP::Request('GET',"$remoteurl");
2646: my $response=$ua->request($request,$transname);
2647: if ($response->is_error()) {
2648: unlink($transname);
2649: my $message=$response->status_line;
2650: &logthis("<font color=\"blue\">WARNING:"
2651: ." LWP get: $message: $filename</font>");
2652: return 'unavailable';
2653: } else {
2654: if ($remoteurl!~/\.meta$/) {
2655: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2656: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2657: if ($mresponse->is_error()) {
2658: unlink($filename.'.meta');
2659: &logthis(
2660: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2661: }
2662: }
2663: rename($transname,$filename);
2664: return 'ok';
2665: }
2666: }
2667: }
2668: }
2669:
2670: # ------------------------------------------------ Get server side include body
2671: sub ssi_body {
2672: my ($filelink,%form)=@_;
2673: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2674: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2675: }
2676: my $output='';
2677: my $response;
2678: if ($filelink=~/^https?\:/) {
2679: ($output,$response)=&externalssi($filelink);
2680: } else {
2681: $filelink .= $filelink=~/\?/ ? '&' : '?';
2682: $filelink .= 'inhibitmenu=yes';
2683: ($output,$response)=&ssi($filelink,%form);
2684: }
2685: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2686: $output=~s/^.*?\<body[^\>]*\>//si;
2687: $output=~s/\<\/body\s*\>.*?$//si;
2688: if (wantarray) {
2689: return ($output, $response);
2690: } else {
2691: return $output;
2692: }
2693: }
2694:
2695: # --------------------------------------------------------- Server Side Include
2696:
2697: sub absolute_url {
2698: my ($host_name) = @_;
2699: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2700: if ($host_name eq '') {
2701: $host_name = $ENV{'SERVER_NAME'};
2702: }
2703: return $protocol.$host_name;
2704: }
2705:
2706: #
2707: # Server side include.
2708: # Parameters:
2709: # fn Possibly encrypted resource name/id.
2710: # form Hash that describes how the rendering should be done
2711: # and other things.
2712: # Returns:
2713: # Scalar context: The content of the response.
2714: # Array context: 2 element list of the content and the full response object.
2715: #
2716: sub ssi {
2717:
2718: my ($fn,%form)=@_;
2719: my $ua=new LWP::UserAgent;
2720: my $request;
2721:
2722: $form{'no_update_last_known'}=1;
2723: &Apache::lonenc::check_encrypt(\$fn);
2724: if (%form) {
2725: $request=new HTTP::Request('POST',&absolute_url().$fn);
2726: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
2727: } else {
2728: $request=new HTTP::Request('GET',&absolute_url().$fn);
2729: }
2730:
2731: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2732: my $response= $ua->request($request);
2733: my $content = $response->content;
2734:
2735:
2736: if (wantarray) {
2737: return ($content, $response);
2738: } else {
2739: return $content;
2740: }
2741: }
2742:
2743: sub externalssi {
2744: my ($url)=@_;
2745: my $ua=new LWP::UserAgent;
2746: my $request=new HTTP::Request('GET',$url);
2747: my $response=$ua->request($request);
2748: if (wantarray) {
2749: return ($response->content, $response);
2750: } else {
2751: return $response->content;
2752: }
2753: }
2754:
2755: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2756:
2757: sub allowuploaded {
2758: my ($srcurl,$url)=@_;
2759: $url=&clutter(&declutter($url));
2760: my $dir=$url;
2761: $dir=~s/\/[^\/]+$//;
2762: my %httpref=();
2763: my $httpurl=&hreflocation('',$url);
2764: $httpref{'httpref.'.$httpurl}=$srcurl;
2765: &Apache::lonnet::appenv(\%httpref);
2766: }
2767:
2768: #
2769: # Determine if the current user should be able to edit a particular resource,
2770: # when viewing in course context.
2771: # (a) When viewing resource used to determine if "Edit" item is included in
2772: # Functions.
2773: # (b) When displaying folder contents in course editor, used to determine if
2774: # "Edit" link will be displayed alongside resource.
2775: #
2776: # input: six args -- filename (decluttered), course number, course domain,
2777: # url, symb (if registered) and group (if this is a group
2778: # item -- e.g., bulletin board, group page etc.).
2779: # output: array of five scalars --
2780: # $cfile -- url for file editing if editable on current server
2781: # $home -- homeserver of resource (i.e., for author if published,
2782: # or course if uploaded.).
2783: # $switchserver -- 1 if server switch will be needed.
2784: # $forceedit -- 1 if icon/link should be to go to edit mode
2785: # $forceview -- 1 if icon/link should be to go to view mode
2786: #
2787:
2788: sub can_edit_resource {
2789: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
2790: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
2791: #
2792: # For aboutme pages user can only edit his/her own.
2793: #
2794: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
2795: my ($sdom,$sname) = ($1,$2);
2796: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
2797: $home = $env{'user.home'};
2798: $cfile = $resurl;
2799: if ($env{'form.forceedit'}) {
2800: $forceview = 1;
2801: } else {
2802: $forceedit = 1;
2803: }
2804: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2805: } else {
2806: return;
2807: }
2808: }
2809:
2810: if ($env{'request.course.id'}) {
2811: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
2812: if ($group ne '') {
2813: # if this is a group homepage or group bulletin board, check group privs
2814: my $allowed = 0;
2815: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
2816: if ((&allowed('mdg',$env{'request.course.id'}.
2817: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2818: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2819: $allowed = 1;
2820: }
2821: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
2822: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2823: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2824: $allowed = 1;
2825: }
2826: }
2827: if ($allowed) {
2828: $home=&homeserver($cnum,$cdom);
2829: if ($env{'form.forceedit'}) {
2830: $forceview = 1;
2831: } else {
2832: $forceedit = 1;
2833: }
2834: $cfile = $resurl;
2835: } else {
2836: return;
2837: }
2838: } else {
2839: if ($resurl =~ m{^/?adm/viewclasslist$}) {
2840: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
2841: return;
2842: }
2843: } elsif (!$crsedit) {
2844: #
2845: # No edit allowed where CC has switched to student role.
2846: #
2847: return;
2848: }
2849: }
2850: }
2851:
2852: if ($file ne '') {
2853: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
2854: if (&is_course_upload($file,$cnum,$cdom)) {
2855: $uploaded = 1;
2856: $incourse = 1;
2857: if ($file =~/\.(htm|html|css|js|txt)$/) {
2858: $cfile = &hreflocation('',$file);
2859: if ($env{'form.forceedit'}) {
2860: $forceview = 1;
2861: } else {
2862: $forceedit = 1;
2863: }
2864: }
2865: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
2866: $incourse = 1;
2867: if ($env{'form.forceedit'}) {
2868: $forceview = 1;
2869: } else {
2870: $forceedit = 1;
2871: }
2872: $cfile = $resurl;
2873: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
2874: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
2875: $incourse = 1;
2876: if ($env{'form.forceedit'}) {
2877: $forceview = 1;
2878: } else {
2879: $forceedit = 1;
2880: }
2881: $cfile = $resurl;
2882: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
2883: $incourse = 1;
2884: $cfile = $resurl.'/smpedit';
2885: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
2886: $incourse = 1;
2887: if ($env{'form.forceedit'}) {
2888: $forceview = 1;
2889: } else {
2890: $forceedit = 1;
2891: }
2892: $cfile = $resurl;
2893: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
2894: $incourse = 1;
2895: if ($env{'form.forceedit'}) {
2896: $forceview = 1;
2897: } else {
2898: $forceedit = 1;
2899: }
2900: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
2901: }
2902: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
2903: my $template = '/res/lib/templates/simpleproblem.problem';
2904: if (&is_on_map($template)) {
2905: $incourse = 1;
2906: $forceview = 1;
2907: $cfile = $template;
2908: }
2909: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
2910: $incourse = 1;
2911: if ($env{'form.forceedit'}) {
2912: $forceview = 1;
2913: } else {
2914: $forceedit = 1;
2915: }
2916: $cfile = $resurl;
2917: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
2918: $incourse = 1;
2919: $forceview = 1;
2920: if ($symb) {
2921: my ($map,$id,$res)=&decode_symb($symb);
2922: $env{'request.symb'} = $symb;
2923: $cfile = &clutter($res);
2924: } else {
2925: $cfile = $env{'form.suppurl'};
2926: $cfile =~ s{^http://}{};
2927: $cfile = '/adm/wrapper/ext/'.$cfile;
2928: }
2929: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
2930: if ($env{'form.forceedit'}) {
2931: $forceview = 1;
2932: } else {
2933: $forceedit = 1;
2934: }
2935: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
2936: }
2937: }
2938: if ($uploaded || $incourse) {
2939: $home=&homeserver($cnum,$cdom);
2940: } elsif ($file !~ m{/$}) {
2941: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
2942: $file=~s{^($match_domain/$match_username)}{/priv/$1};
2943: # Check that the user has permission to edit this resource
2944: my $setpriv = 1;
2945: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
2946: if (defined($cfudom)) {
2947: $home=&homeserver($cfuname,$cfudom);
2948: $cfile=$file;
2949: }
2950: }
2951: if (($cfile ne '') && (!$incourse || $uploaded) &&
2952: (($home ne '') && ($home ne 'no_host'))) {
2953: my @ids=¤t_machine_ids();
2954: unless (grep(/^\Q$home\E$/,@ids)) {
2955: $switchserver=1;
2956: }
2957: }
2958: }
2959: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2960: }
2961:
2962: sub is_course_upload {
2963: my ($file,$cnum,$cdom) = @_;
2964: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
2965: $uploadpath =~ s{^\/}{};
2966: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
2967: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
2968: return 1;
2969: }
2970: return;
2971: }
2972:
2973: sub in_course {
2974: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
2975: if ($hideprivileged) {
2976: my $skipuser;
2977: my %coursehash = &coursedescription($cdom.'_'.$cnum);
2978: my @possdoms = ($cdom);
2979: if ($coursehash{'checkforpriv'}) {
2980: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
2981: }
2982: if (&privileged($uname,$udom,\@possdoms)) {
2983: $skipuser = 1;
2984: if ($coursehash{'nothideprivileged'}) {
2985: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2986: my $user;
2987: if ($item =~ /:/) {
2988: $user = $item;
2989: } else {
2990: $user = join(':',split(/[\@]/,$item));
2991: }
2992: if ($user eq $uname.':'.$udom) {
2993: undef($skipuser);
2994: last;
2995: }
2996: }
2997: }
2998: if ($skipuser) {
2999: return 0;
3000: }
3001: }
3002: }
3003: $type ||= 'any';
3004: if (!defined($cdom) || !defined($cnum)) {
3005: my $cid = $env{'request.course.id'};
3006: $cdom = $env{'course.'.$cid.'.domain'};
3007: $cnum = $env{'course.'.$cid.'.num'};
3008: }
3009: my $typesref;
3010: if (($type eq 'any') || ($type eq 'all')) {
3011: $typesref = ['active','previous','future'];
3012: } elsif ($type eq 'previous' || $type eq 'future') {
3013: $typesref = [$type];
3014: }
3015: my %roles = &get_my_roles($uname,$udom,'userroles',
3016: $typesref,undef,[$cdom]);
3017: my ($tmp) = keys(%roles);
3018: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3019: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3020: if (@course_roles > 0) {
3021: return 1;
3022: }
3023: return 0;
3024: }
3025:
3026: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
3027: # input: action, courseID, current domain, intended
3028: # path to file, source of file, instruction to parse file for objects,
3029: # ref to hash for embedded objects,
3030: # ref to hash for codebase of java objects.
3031: # reference to scalar to accommodate mime type determined
3032: # from File::MMagic if $parser = parse.
3033: #
3034: # output: url to file (if action was uploaddoc),
3035: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
3036: #
3037: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3038: # course.
3039: #
3040: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3041: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3042: # course's home server.
3043: #
3044: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3045: # be copied from $source (current location) to
3046: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3047: # and will then be copied to
3048: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3049: # course's home server.
3050: #
3051: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3052: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
3053: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3054: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3055: # in course's home server.
3056: #
3057:
3058: sub process_coursefile {
3059: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3060: $mimetype)=@_;
3061: my $fetchresult;
3062: my $home=&homeserver($docuname,$docudom);
3063: if ($action eq 'propagate') {
3064: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3065: $home);
3066: } else {
3067: my $fpath = '';
3068: my $fname = $file;
3069: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3070: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3071: my $filepath = &build_filepath($fpath);
3072: if ($action eq 'copy') {
3073: if ($source eq '') {
3074: $fetchresult = 'no source file';
3075: return $fetchresult;
3076: } else {
3077: my $destination = $filepath.'/'.$fname;
3078: rename($source,$destination);
3079: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3080: $home);
3081: }
3082: } elsif ($action eq 'uploaddoc') {
3083: open(my $fh,'>'.$filepath.'/'.$fname);
3084: print $fh $env{'form.'.$source};
3085: close($fh);
3086: if ($parser eq 'parse') {
3087: my $mm = new File::MMagic;
3088: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3089: if ($type eq 'text/html') {
3090: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3091: unless ($parse_result eq 'ok') {
3092: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3093: }
3094: }
3095: if (ref($mimetype)) {
3096: $$mimetype = $type;
3097: }
3098: }
3099: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3100: $home);
3101: if ($fetchresult eq 'ok') {
3102: return '/uploaded/'.$fpath.'/'.$fname;
3103: } else {
3104: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3105: ' to host '.$home.': '.$fetchresult);
3106: return '/adm/notfound.html';
3107: }
3108: }
3109: }
3110: unless ( $fetchresult eq 'ok') {
3111: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3112: ' to host '.$home.': '.$fetchresult);
3113: }
3114: return $fetchresult;
3115: }
3116:
3117: sub build_filepath {
3118: my ($fpath) = @_;
3119: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3120: unless ($fpath eq '') {
3121: my @parts=split('/',$fpath);
3122: foreach my $part (@parts) {
3123: $filepath.= '/'.$part;
3124: if ((-e $filepath)!=1) {
3125: mkdir($filepath,0777);
3126: }
3127: }
3128: }
3129: return $filepath;
3130: }
3131:
3132: sub store_edited_file {
3133: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
3134: my $file = $primary_url;
3135: $file =~ s#^/uploaded/$docudom/$docuname/##;
3136: my $fpath = '';
3137: my $fname = $file;
3138: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3139: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3140: my $filepath = &build_filepath($fpath);
3141: open(my $fh,'>'.$filepath.'/'.$fname);
3142: print $fh $content;
3143: close($fh);
3144: my $home=&homeserver($docuname,$docudom);
3145: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3146: $home);
3147: if ($$fetchresult eq 'ok') {
3148: return '/uploaded/'.$fpath.'/'.$fname;
3149: } else {
3150: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3151: ' to host '.$home.': '.$$fetchresult);
3152: return '/adm/notfound.html';
3153: }
3154: }
3155:
3156: sub clean_filename {
3157: my ($fname,$args)=@_;
3158: # Replace Windows backslashes by forward slashes
3159: $fname=~s/\\/\//g;
3160: if (!$args->{'keep_path'}) {
3161: # Get rid of everything but the actual filename
3162: $fname=~s/^.*\/([^\/]+)$/$1/;
3163: }
3164: # Replace spaces by underscores
3165: $fname=~s/\s+/\_/g;
3166: # Replace all other weird characters by nothing
3167: $fname=~s{[^/\w\.\-]}{}g;
3168: # Replace all .\d. sequences with _\d. so they no longer look like version
3169: # numbers
3170: $fname=~s/\.(\d+)(?=\.)/_$1/g;
3171: return $fname;
3172: }
3173: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3174: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3175: # image with the same aspect ratio as the original, but with dimensions which do
3176: # not exceed $resizewidth and $resizeheight.
3177:
3178: sub resizeImage {
3179: my ($img_path,$resizewidth,$resizeheight) = @_;
3180: my $ima = Image::Magick->new;
3181: my $resized;
3182: if (-e $img_path) {
3183: $ima->Read($img_path);
3184: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3185: my $width = $ima->Get('width');
3186: my $height = $ima->Get('height');
3187: if ($width > $resizewidth) {
3188: my $factor = $width/$resizewidth;
3189: my $newheight = $height/$factor;
3190: $ima->Scale(width=>$resizewidth,height=>$newheight);
3191: $resized = 1;
3192: }
3193: }
3194: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3195: my $width = $ima->Get('width');
3196: my $height = $ima->Get('height');
3197: if ($height > $resizeheight) {
3198: my $factor = $height/$resizeheight;
3199: my $newwidth = $width/$factor;
3200: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3201: $resized = 1;
3202: }
3203: }
3204: if ($resized) {
3205: $ima->Write($img_path);
3206: }
3207: }
3208: return;
3209: }
3210:
3211: # --------------- Take an uploaded file and put it into the userfiles directory
3212: # input: $formname - the contents of the file are in $env{"form.$formname"}
3213: # the desired filename is in $env{"form.$formname.filename"}
3214: # $context - possible values: coursedoc, existingfile, overwrite,
3215: # canceloverwrite, or ''.
3216: # if 'coursedoc': upload to the current course
3217: # if 'existingfile': write file to tmp/overwrites directory
3218: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3219: # $context is passed as argument to &finishuserfileupload
3220: # $subdir - directory in userfile to store the file into
3221: # $parser - instruction to parse file for objects ($parser = parse)
3222: # $allfiles - reference to hash for embedded objects
3223: # $codebase - reference to hash for codebase of java objects
3224: # $desuname - username for permanent storage of uploaded file
3225: # $dsetudom - domain for permanaent storage of uploaded file
3226: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3227: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
3228: # $resizewidth - width (pixels) to which to resize uploaded image
3229: # $resizeheight - height (pixels) to which to resize uploaded image
3230: # $mimetype - reference to scalar to accommodate mime type determined
3231: # from File::MMagic.
3232: #
3233: # output: url of file in userspace, or error: <message>
3234: # or /adm/notfound.html if failure to upload occurse
3235:
3236: sub userfileupload {
3237: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
3238: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
3239: if (!defined($subdir)) { $subdir='unknown'; }
3240: my $fname=$env{'form.'.$formname.'.filename'};
3241: $fname=&clean_filename($fname);
3242: # See if there is anything left
3243: unless ($fname) { return 'error: no uploaded file'; }
3244: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3245: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3246: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3247: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3248: my $now = time;
3249: my $filepath;
3250: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
3251: $filepath = 'tmp/helprequests/'.$now;
3252: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3253: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3254: '_'.$env{'user.domain'}.'/pending';
3255: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3256: my ($docuname,$docudom);
3257: if ($destudom) {
3258: $docudom = $destudom;
3259: } else {
3260: $docudom = $env{'user.domain'};
3261: }
3262: if ($destuname) {
3263: $docuname = $destuname;
3264: } else {
3265: $docuname = $env{'user.name'};
3266: }
3267: if (exists($env{'form.group'})) {
3268: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3269: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3270: }
3271: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3272: if ($context eq 'canceloverwrite') {
3273: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3274: if (-e $tempfile) {
3275: my @info = stat($tempfile);
3276: if ($info[9] eq $env{'form.timestamp'}) {
3277: unlink($tempfile);
3278: }
3279: }
3280: return;
3281: }
3282: }
3283: # Create the directory if not present
3284: my @parts=split(/\//,$filepath);
3285: my $fullpath = $perlvar{'lonDaemons'};
3286: for (my $i=0;$i<@parts;$i++) {
3287: $fullpath .= '/'.$parts[$i];
3288: if ((-e $fullpath)!=1) {
3289: mkdir($fullpath,0777);
3290: }
3291: }
3292: open(my $fh,'>'.$fullpath.'/'.$fname);
3293: print $fh $env{'form.'.$formname};
3294: close($fh);
3295: if ($context eq 'existingfile') {
3296: my @info = stat($fullpath.'/'.$fname);
3297: return ($fullpath.'/'.$fname,$info[9]);
3298: } else {
3299: return $fullpath.'/'.$fname;
3300: }
3301: }
3302: if ($subdir eq 'scantron') {
3303: $fname = 'scantron_orig_'.$fname;
3304: } else {
3305: $fname="$subdir/$fname";
3306: }
3307: if ($context eq 'coursedoc') {
3308: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3309: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3310: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
3311: return &finishuserfileupload($docuname,$docudom,
3312: $formname,$fname,$parser,$allfiles,
3313: $codebase,$thumbwidth,$thumbheight,
3314: $resizewidth,$resizeheight,$context,$mimetype);
3315: } else {
3316: if ($env{'form.folder'}) {
3317: $fname=$env{'form.folder'}.'/'.$fname;
3318: }
3319: return &process_coursefile('uploaddoc',$docuname,$docudom,
3320: $fname,$formname,$parser,
3321: $allfiles,$codebase,$mimetype);
3322: }
3323: } elsif (defined($destuname)) {
3324: my $docuname=$destuname;
3325: my $docudom=$destudom;
3326: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3327: $parser,$allfiles,$codebase,
3328: $thumbwidth,$thumbheight,
3329: $resizewidth,$resizeheight,$context,$mimetype);
3330: } else {
3331: my $docuname=$env{'user.name'};
3332: my $docudom=$env{'user.domain'};
3333: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
3334: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3335: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3336: }
3337: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3338: $parser,$allfiles,$codebase,
3339: $thumbwidth,$thumbheight,
3340: $resizewidth,$resizeheight,$context,$mimetype);
3341: }
3342: }
3343:
3344: sub finishuserfileupload {
3345: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
3346: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
3347: my $path=$docudom.'/'.$docuname.'/';
3348: my $filepath=$perlvar{'lonDocRoot'};
3349:
3350: my ($fnamepath,$file,$fetchthumb);
3351: $file=$fname;
3352: if ($fname=~m|/|) {
3353: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3354: $path.=$fnamepath.'/';
3355: }
3356: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
3357: my $count;
3358: for ($count=4;$count<=$#parts;$count++) {
3359: $filepath.="/$parts[$count]";
3360: if ((-e $filepath)!=1) {
3361: mkdir($filepath,0777);
3362: }
3363: }
3364:
3365: # Save the file
3366: {
3367: if (!open(FH,'>'.$filepath.'/'.$file)) {
3368: &logthis('Failed to create '.$filepath.'/'.$file);
3369: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3370: return '/adm/notfound.html';
3371: }
3372: if ($context eq 'overwrite') {
3373: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
3374: my $target = $filepath.'/'.$file;
3375: if (-e $source) {
3376: my @info = stat($source);
3377: if ($info[9] eq $env{'form.timestamp'}) {
3378: unless (&File::Copy::move($source,$target)) {
3379: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3380: return "Moving from $source failed";
3381: }
3382: } else {
3383: return "Temporary file: $source had unexpected date/time for last modification";
3384: }
3385: } else {
3386: return "Temporary file: $source missing";
3387: }
3388: } elsif (!print FH ($env{'form.'.$formname})) {
3389: &logthis('Failed to write to '.$filepath.'/'.$file);
3390: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3391: return '/adm/notfound.html';
3392: }
3393: close(FH);
3394: if ($resizewidth && $resizeheight) {
3395: my $mm = new File::MMagic;
3396: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3397: if ($mime_type =~ m{^image/}) {
3398: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3399: }
3400: }
3401: }
3402: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3403: if (ref($mimetype)) {
3404: if ($$mimetype eq '') {
3405: my $mm = new File::MMagic;
3406: my $type = $mm->checktype_filename($filepath.'/'.$file);
3407: $$mimetype = $type;
3408: }
3409: }
3410: }
3411: if ($parser eq 'parse') {
3412: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
3413: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3414: $allfiles,$codebase);
3415: unless ($parse_result eq 'ok') {
3416: &logthis('Failed to parse '.$filepath.$file.
3417: ' for embedded media: '.$parse_result);
3418: }
3419: }
3420: }
3421: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3422: my $input = $filepath.'/'.$file;
3423: my $output = $filepath.'/'.'tn-'.$file;
3424: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3425: system("convert -sample $thumbsize $input $output");
3426: if (-e $filepath.'/'.'tn-'.$file) {
3427: $fetchthumb = 1;
3428: }
3429: }
3430:
3431: # Notify homeserver to grep it
3432: #
3433: my $docuhome=&homeserver($docuname,$docudom);
3434: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3435: if ($fetchresult eq 'ok') {
3436: if ($fetchthumb) {
3437: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3438: if ($thumbresult ne 'ok') {
3439: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3440: $docuhome.': '.$thumbresult);
3441: }
3442: }
3443: #
3444: # Return the URL to it
3445: return '/uploaded/'.$path.$file;
3446: } else {
3447: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3448: ': '.$fetchresult);
3449: return '/adm/notfound.html';
3450: }
3451: }
3452:
3453: sub extract_embedded_items {
3454: my ($fullpath,$allfiles,$codebase,$content) = @_;
3455: my @state = ();
3456: my (%lastids,%related,%shockwave,%flashvars);
3457: my %javafiles = (
3458: codebase => '',
3459: code => '',
3460: archive => ''
3461: );
3462: my %mediafiles = (
3463: src => '',
3464: movie => '',
3465: );
3466: my $p;
3467: if ($content) {
3468: $p = HTML::LCParser->new($content);
3469: } else {
3470: $p = HTML::LCParser->new($fullpath);
3471: }
3472: while (my $t=$p->get_token()) {
3473: if ($t->[0] eq 'S') {
3474: my ($tagname, $attr) = ($t->[1],$t->[2]);
3475: push(@state, $tagname);
3476: if (lc($tagname) eq 'allow') {
3477: &add_filetype($allfiles,$attr->{'src'},'src');
3478: }
3479: if (lc($tagname) eq 'img') {
3480: &add_filetype($allfiles,$attr->{'src'},'src');
3481: }
3482: if (lc($tagname) eq 'a') {
3483: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
3484: &add_filetype($allfiles,$attr->{'href'},'href');
3485: }
3486: }
3487: if (lc($tagname) eq 'script') {
3488: my $src;
3489: if ($attr->{'archive'} =~ /\.jar$/i) {
3490: &add_filetype($allfiles,$attr->{'archive'},'archive');
3491: } else {
3492: if ($attr->{'src'} ne '') {
3493: $src = $attr->{'src'};
3494: &add_filetype($allfiles,$src,'src');
3495: }
3496: }
3497: my $text = $p->get_trimmed_text();
3498: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3499: my @swfargs = split(/,/,$1);
3500: foreach my $item (@swfargs) {
3501: $item =~ s/["']//g;
3502: $item =~ s/^\s+//;
3503: $item =~ s/\s+$//;
3504: }
3505: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3506: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3507: push(@{$related{$swfargs[0]}},$swfargs[2]);
3508: } else {
3509: $related{$swfargs[0]} = [$swfargs[2]];
3510: }
3511: }
3512: }
3513: }
3514: if (lc($tagname) eq 'link') {
3515: if (lc($attr->{'rel'}) eq 'stylesheet') {
3516: &add_filetype($allfiles,$attr->{'href'},'href');
3517: }
3518: }
3519: if (lc($tagname) eq 'object' ||
3520: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3521: foreach my $item (keys(%javafiles)) {
3522: $javafiles{$item} = '';
3523: }
3524: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3525: $lastids{lc($tagname)} = $attr->{'id'};
3526: }
3527: }
3528: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3529: my $name = lc($attr->{'name'});
3530: foreach my $item (keys(%javafiles)) {
3531: if ($name eq $item) {
3532: $javafiles{$item} = $attr->{'value'};
3533: last;
3534: }
3535: }
3536: my $pathfrom;
3537: foreach my $item (keys(%mediafiles)) {
3538: if ($name eq $item) {
3539: $pathfrom = $attr->{'value'};
3540: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3541: &add_filetype($allfiles,$pathfrom,$name);
3542: last;
3543: }
3544: }
3545: if ($name eq 'flashvars') {
3546: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3547: }
3548: if ($pathfrom ne '') {
3549: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3550: $pathfrom);
3551: }
3552: }
3553: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3554: foreach my $item (keys(%javafiles)) {
3555: if ($attr->{$item}) {
3556: $javafiles{$item} = $attr->{$item};
3557: last;
3558: }
3559: }
3560: foreach my $item (keys(%mediafiles)) {
3561: if ($attr->{$item}) {
3562: &add_filetype($allfiles,$attr->{$item},$item);
3563: last;
3564: }
3565: }
3566: if (lc($tagname) eq 'embed') {
3567: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3568: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3569: $attr->{'src'});
3570: }
3571: }
3572: }
3573: if (lc($tagname) eq 'iframe') {
3574: my $src = $attr->{'src'} ;
3575: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3576: &add_filetype($allfiles,$src,'src');
3577: } elsif ($src =~ m{^/}) {
3578: if ($env{'request.course.id'}) {
3579: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3580: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3581: my $url = &hreflocation('',$fullpath);
3582: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3583: my $relpath = $1;
3584: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3585: &add_filetype($allfiles,$1,'src');
3586: }
3587: }
3588: }
3589: }
3590: }
3591: if ($t->[4] =~ m{/>$}) {
3592: pop(@state);
3593: }
3594: } elsif ($t->[0] eq 'E') {
3595: my ($tagname) = ($t->[1]);
3596: if ($javafiles{'codebase'} ne '') {
3597: $javafiles{'codebase'} .= '/';
3598: }
3599: if (lc($tagname) eq 'applet' ||
3600: lc($tagname) eq 'object' ||
3601: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3602: ) {
3603: foreach my $item (keys(%javafiles)) {
3604: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3605: my $file=$javafiles{'codebase'}.$javafiles{$item};
3606: &add_filetype($allfiles,$file,$item);
3607: }
3608: }
3609: }
3610: pop @state;
3611: }
3612: }
3613: foreach my $id (sort(keys(%flashvars))) {
3614: if ($shockwave{$id} ne '') {
3615: my @pairs = split(/\&/,$flashvars{$id});
3616: foreach my $pair (@pairs) {
3617: my ($key,$value) = split(/\=/,$pair);
3618: if ($key eq 'thumb') {
3619: &add_filetype($allfiles,$value,$key);
3620: } elsif ($key eq 'content') {
3621: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3622: my ($ext) = ($value =~ /\.([^.]+)$/);
3623: if ($ext ne '') {
3624: &add_filetype($allfiles,$path.$value,$ext);
3625: }
3626: }
3627: }
3628: }
3629: }
3630: return 'ok';
3631: }
3632:
3633: sub add_filetype {
3634: my ($allfiles,$file,$type)=@_;
3635: if (exists($allfiles->{$file})) {
3636: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3637: push(@{$allfiles->{$file}}, &escape($type));
3638: }
3639: } else {
3640: @{$allfiles->{$file}} = (&escape($type));
3641: }
3642: }
3643:
3644: sub embedded_dependency {
3645: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3646: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3647: if (($identifier ne '') &&
3648: (ref($related->{$identifier}) eq 'ARRAY') &&
3649: ($pathfrom ne '')) {
3650: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3651: foreach my $dep (@{$related->{$identifier}}) {
3652: &add_filetype($allfiles,$path.$dep,'object');
3653: }
3654: }
3655: }
3656: return;
3657: }
3658:
3659: sub removeuploadedurl {
3660: my ($url)=@_;
3661: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3662: return &removeuserfile($uname,$udom,$fname);
3663: }
3664:
3665: sub removeuserfile {
3666: my ($docuname,$docudom,$fname)=@_;
3667: my $home=&homeserver($docuname,$docudom);
3668: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3669: if ($result eq 'ok') {
3670: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3671: my $metafile = $fname.'.meta';
3672: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3673: my $url = "/uploaded/$docudom/$docuname/$fname";
3674: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3675: my $sqlresult =
3676: &update_portfolio_table($docuname,$docudom,$file,
3677: 'portfolio_metadata',$group,
3678: 'delete');
3679: }
3680: }
3681: return $result;
3682: }
3683:
3684: sub mkdiruserfile {
3685: my ($docuname,$docudom,$dir)=@_;
3686: my $home=&homeserver($docuname,$docudom);
3687: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3688: }
3689:
3690: sub renameuserfile {
3691: my ($docuname,$docudom,$old,$new)=@_;
3692: my $home=&homeserver($docuname,$docudom);
3693: my $result = &reply("renameuserfile:$docudom:$docuname:".
3694: &escape("$old").':'.&escape("$new"),$home);
3695: if ($result eq 'ok') {
3696: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3697: my $oldmeta = $old.'.meta';
3698: my $newmeta = $new.'.meta';
3699: my $metaresult =
3700: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3701: my $url = "/uploaded/$docudom/$docuname/$old";
3702: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3703: my $sqlresult =
3704: &update_portfolio_table($docuname,$docudom,$file,
3705: 'portfolio_metadata',$group,
3706: 'delete');
3707: }
3708: }
3709: return $result;
3710: }
3711:
3712: # ------------------------------------------------------------------------- Log
3713:
3714: sub log {
3715: my ($dom,$nam,$hom,$what)=@_;
3716: return critical("log:$dom:$nam:$what",$hom);
3717: }
3718:
3719: # ------------------------------------------------------------------ Course Log
3720: #
3721: # This routine flushes several buffers of non-mission-critical nature
3722: #
3723:
3724: sub flushcourselogs {
3725: &logthis('Flushing log buffers');
3726: #
3727: # course logs
3728: # This is a log of all transactions in a course, which can be used
3729: # for data mining purposes
3730: #
3731: # It also collects the courseid database, which lists last transaction
3732: # times and course titles for all courseids
3733: #
3734: my %courseidbuffer=();
3735: foreach my $crsid (keys(%courselogs)) {
3736: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
3737: &escape($courselogs{$crsid}),
3738: $coursehombuf{$crsid}) eq 'ok') {
3739: delete $courselogs{$crsid};
3740: } else {
3741: &logthis('Failed to flush log buffer for '.$crsid);
3742: if (length($courselogs{$crsid})>40000) {
3743: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
3744: " exceeded maximum size, deleting.</font>");
3745: delete $courselogs{$crsid};
3746: }
3747: }
3748: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
3749: 'description' => $coursedescrbuf{$crsid},
3750: 'inst_code' => $courseinstcodebuf{$crsid},
3751: 'type' => $coursetypebuf{$crsid},
3752: 'owner' => $courseownerbuf{$crsid},
3753: };
3754: }
3755: #
3756: # Write course id database (reverse lookup) to homeserver of courses
3757: # Is used in pickcourse
3758: #
3759: foreach my $crs_home (keys(%courseidbuffer)) {
3760: my $response = &courseidput(&host_domain($crs_home),
3761: $courseidbuffer{$crs_home},
3762: $crs_home,'timeonly');
3763: }
3764: #
3765: # File accesses
3766: # Writes to the dynamic metadata of resources to get hit counts, etc.
3767: #
3768: foreach my $entry (keys(%accesshash)) {
3769: if ($entry =~ /___count$/) {
3770: my ($dom,$name);
3771: ($dom,$name,undef)=
3772: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
3773: if (! defined($dom) || $dom eq '' ||
3774: ! defined($name) || $name eq '') {
3775: my $cid = $env{'request.course.id'};
3776: $dom = $env{'request.'.$cid.'.domain'};
3777: $name = $env{'request.'.$cid.'.num'};
3778: }
3779: my $value = $accesshash{$entry};
3780: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3781: my %temphash=($url => $value);
3782: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3783: if ($result eq 'ok') {
3784: delete $accesshash{$entry};
3785: }
3786: } else {
3787: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
3788: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
3789: my %temphash=($entry => $accesshash{$entry});
3790: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3791: delete $accesshash{$entry};
3792: }
3793: }
3794: }
3795: #
3796: # Roles
3797: # Reverse lookup of user roles for course faculty/staff and co-authorship
3798: #
3799: foreach my $entry (keys(%userrolehash)) {
3800: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
3801: split(/\:/,$entry);
3802: if (&Apache::lonnet::put('nohist_userroles',
3803: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
3804: $rudom,$runame) eq 'ok') {
3805: delete $userrolehash{$entry};
3806: }
3807: }
3808: #
3809: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3810: #
3811: my %domrolebuffer = ();
3812: foreach my $entry (keys(%domainrolehash)) {
3813: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
3814: if ($domrolebuffer{$rudom}) {
3815: $domrolebuffer{$rudom}.='&'.&escape($entry).
3816: '='.&escape($domainrolehash{$entry});
3817: } else {
3818: $domrolebuffer{$rudom}.=&escape($entry).
3819: '='.&escape($domainrolehash{$entry});
3820: }
3821: delete $domainrolehash{$entry};
3822: }
3823: foreach my $dom (keys(%domrolebuffer)) {
3824: my %servers = &get_servers($dom,'library');
3825: foreach my $tryserver (keys(%servers)) {
3826: unless (&reply('domroleput:'.$dom.':'.
3827: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3828: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3829: }
3830: }
3831: }
3832: $dumpcount++;
3833: }
3834:
3835: sub courselog {
3836: my $what=shift;
3837: $what=time.':'.$what;
3838: unless ($env{'request.course.id'}) { return ''; }
3839: $coursedombuf{$env{'request.course.id'}}=
3840: $env{'course.'.$env{'request.course.id'}.'.domain'};
3841: $coursenumbuf{$env{'request.course.id'}}=
3842: $env{'course.'.$env{'request.course.id'}.'.num'};
3843: $coursehombuf{$env{'request.course.id'}}=
3844: $env{'course.'.$env{'request.course.id'}.'.home'};
3845: $coursedescrbuf{$env{'request.course.id'}}=
3846: $env{'course.'.$env{'request.course.id'}.'.description'};
3847: $courseinstcodebuf{$env{'request.course.id'}}=
3848: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3849: $courseownerbuf{$env{'request.course.id'}}=
3850: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
3851: $coursetypebuf{$env{'request.course.id'}}=
3852: $env{'course.'.$env{'request.course.id'}.'.type'};
3853: if (defined $courselogs{$env{'request.course.id'}}) {
3854: $courselogs{$env{'request.course.id'}}.='&'.$what;
3855: } else {
3856: $courselogs{$env{'request.course.id'}}.=$what;
3857: }
3858: if (length($courselogs{$env{'request.course.id'}})>4048) {
3859: &flushcourselogs();
3860: }
3861: }
3862:
3863: sub courseacclog {
3864: my $fnsymb=shift;
3865: unless ($env{'request.course.id'}) { return ''; }
3866: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
3867: if ($fnsymb=~/$LONCAPA::assess_re/) {
3868: $what.=':POST';
3869: # FIXME: Probably ought to escape things....
3870: foreach my $key (keys(%env)) {
3871: if ($key=~/^form\.(.*)/) {
3872: my $formitem = $1;
3873: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3874: $what.=':'.$formitem.'='.$env{$key};
3875: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3876: $what.=':'.$formitem.'='.$env{$key};
3877: }
3878: }
3879: }
3880: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3881: # FIXME: We should not be depending on a form parameter that someone
3882: # editing lonsearchcat.pm might change in the future.
3883: if ($env{'form.phase'} eq 'course_search') {
3884: $what.= ':POST';
3885: # FIXME: Probably ought to escape things....
3886: foreach my $element ('courseexp','crsfulltext','crsrelated',
3887: 'crsdiscuss') {
3888: $what.=':'.$element.'='.$env{'form.'.$element};
3889: }
3890: }
3891: }
3892: &courselog($what);
3893: }
3894:
3895: sub countacc {
3896: my $url=&declutter(shift);
3897: return if (! defined($url) || $url eq '');
3898: unless ($env{'request.course.id'}) { return ''; }
3899: #
3900: # Mark that this url was used in this course
3901: #
3902: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
3903: #
3904: # Increase the access count for this resource in this child process
3905: #
3906: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
3907: $accesshash{$key}++;
3908: }
3909:
3910: sub linklog {
3911: my ($from,$to)=@_;
3912: $from=&declutter($from);
3913: $to=&declutter($to);
3914: $accesshash{$from.'___'.$to.'___comefrom'}=1;
3915: $accesshash{$to.'___'.$from.'___goto'}=1;
3916: }
3917:
3918: sub statslog {
3919: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
3920: if ($users<2) { return; }
3921: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
3922: 'course' => $env{'request.course.id'},
3923: 'sections' => '"all"',
3924: 'num_students' => $users,
3925: 'part' => $part,
3926: 'symb' => $symb,
3927: 'mean_tries' => $av_attempts,
3928: 'deg_of_diff' => $degdiff});
3929: foreach my $key (keys(%dynstore)) {
3930: $accesshash{$key}=$dynstore{$key};
3931: }
3932: }
3933:
3934: sub userrolelog {
3935: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
3936: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
3937: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3938: $userrolehash
3939: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3940: =$tend.':'.$tstart;
3941: }
3942: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
3943: $userrolehash
3944: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
3945: =$tend.':'.$tstart;
3946: }
3947: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
3948: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3949: $domainrolehash
3950: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3951: = $tend.':'.$tstart;
3952: }
3953: }
3954:
3955: sub courserolelog {
3956: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
3957: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
3958: my $cdom = $1;
3959: my $cnum = $2;
3960: my $sec = $3;
3961: my $namespace = 'rolelog';
3962: my %storehash = (
3963: role => $trole,
3964: start => $tstart,
3965: end => $tend,
3966: selfenroll => $selfenroll,
3967: context => $context,
3968: );
3969: if ($trole eq 'gr') {
3970: $namespace = 'groupslog';
3971: $storehash{'group'} = $sec;
3972: } else {
3973: $storehash{'section'} = $sec;
3974: }
3975: &write_log('course',$namespace,\%storehash,$delflag,$username,
3976: $domain,$cnum,$cdom);
3977: if (($trole ne 'st') || ($sec ne '')) {
3978: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
3979: }
3980: }
3981: return;
3982: }
3983:
3984: sub domainrolelog {
3985: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
3986: if ($area =~ m{^/($match_domain)/$}) {
3987: my $cdom = $1;
3988: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
3989: my $namespace = 'rolelog';
3990: my %storehash = (
3991: role => $trole,
3992: start => $tstart,
3993: end => $tend,
3994: context => $context,
3995: );
3996: &write_log('domain',$namespace,\%storehash,$delflag,$username,
3997: $domain,$domconfiguser,$cdom);
3998: }
3999: return;
4000:
4001: }
4002:
4003: sub coauthorrolelog {
4004: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4005: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4006: my $audom = $1;
4007: my $auname = $2;
4008: my $namespace = 'rolelog';
4009: my %storehash = (
4010: role => $trole,
4011: start => $tstart,
4012: end => $tend,
4013: context => $context,
4014: );
4015: &write_log('author',$namespace,\%storehash,$delflag,$username,
4016: $domain,$auname,$audom);
4017: }
4018: return;
4019: }
4020:
4021: sub get_course_adv_roles {
4022: my ($cid,$codes) = @_;
4023: $cid=$env{'request.course.id'} unless (defined($cid));
4024: my %coursehash=&coursedescription($cid);
4025: my $crstype = &Apache::loncommon::course_type($cid);
4026: my %nothide=();
4027: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4028: if ($user !~ /:/) {
4029: $nothide{join(':',split(/[\@]/,$user))}=1;
4030: } else {
4031: $nothide{$user}=1;
4032: }
4033: }
4034: my @possdoms = ($coursehash{'domain'});
4035: if ($coursehash{'checkforpriv'}) {
4036: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4037: }
4038: my %returnhash=();
4039: my %dumphash=
4040: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4041: my $now=time;
4042: my %privileged;
4043: foreach my $entry (keys(%dumphash)) {
4044: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4045: if (($tstart) && ($tstart<0)) { next; }
4046: if (($tend) && ($tend<$now)) { next; }
4047: if (($tstart) && ($now<$tstart)) { next; }
4048: my ($role,$username,$domain,$section)=split(/\:/,$entry);
4049: if ($username eq '' || $domain eq '') { next; }
4050: if ((&privileged($username,$domain,\@possdoms)) &&
4051: (!$nothide{$username.':'.$domain})) { next; }
4052: if ($role eq 'cr') { next; }
4053: if ($codes) {
4054: if ($section) { $role .= ':'.$section; }
4055: if ($returnhash{$role}) {
4056: $returnhash{$role}.=','.$username.':'.$domain;
4057: } else {
4058: $returnhash{$role}=$username.':'.$domain;
4059: }
4060: } else {
4061: my $key=&plaintext($role,$crstype);
4062: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
4063: if ($returnhash{$key}) {
4064: $returnhash{$key}.=','.$username.':'.$domain;
4065: } else {
4066: $returnhash{$key}=$username.':'.$domain;
4067: }
4068: }
4069: }
4070: return %returnhash;
4071: }
4072:
4073: sub get_my_roles {
4074: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
4075: unless (defined($uname)) { $uname=$env{'user.name'}; }
4076: unless (defined($udom)) { $udom=$env{'user.domain'}; }
4077: my (%dumphash,%nothide);
4078: if ($context eq 'userroles') {
4079: %dumphash = &dump('roles',$udom,$uname);
4080: } else {
4081: %dumphash = &dump('nohist_userroles',$udom,$uname);
4082: if ($hidepriv) {
4083: my %coursehash=&coursedescription($udom.'_'.$uname);
4084: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4085: if ($user !~ /:/) {
4086: $nothide{join(':',split(/[\@]/,$user))} = 1;
4087: } else {
4088: $nothide{$user} = 1;
4089: }
4090: }
4091: }
4092: }
4093: my %returnhash=();
4094: my $now=time;
4095: my %privileged;
4096: foreach my $entry (keys(%dumphash)) {
4097: my ($role,$tend,$tstart);
4098: if ($context eq 'userroles') {
4099: next if ($entry =~ /^rolesdef/);
4100: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4101: } else {
4102: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4103: }
4104: if (($tstart) && ($tstart<0)) { next; }
4105: my $status = 'active';
4106: if (($tend) && ($tend<=$now)) {
4107: $status = 'previous';
4108: }
4109: if (($tstart) && ($now<$tstart)) {
4110: $status = 'future';
4111: }
4112: if (ref($types) eq 'ARRAY') {
4113: if (!grep(/^\Q$status\E$/,@{$types})) {
4114: next;
4115: }
4116: } else {
4117: if ($status ne 'active') {
4118: next;
4119: }
4120: }
4121: my ($rolecode,$username,$domain,$section,$area);
4122: if ($context eq 'userroles') {
4123: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
4124: (undef,$domain,$username,$section) = split(/\//,$area);
4125: } else {
4126: ($role,$username,$domain,$section) = split(/\:/,$entry);
4127: }
4128: if (ref($roledoms) eq 'ARRAY') {
4129: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4130: next;
4131: }
4132: }
4133: if (ref($roles) eq 'ARRAY') {
4134: if (!grep(/^\Q$role\E$/,@{$roles})) {
4135: if ($role =~ /^cr\//) {
4136: if (!grep(/^cr$/,@{$roles})) {
4137: next;
4138: }
4139: } elsif ($role =~ /^gr\//) {
4140: if (!grep(/^gr$/,@{$roles})) {
4141: next;
4142: }
4143: } else {
4144: next;
4145: }
4146: }
4147: }
4148: if ($hidepriv) {
4149: my @privroles = ('dc','su');
4150: if ($context eq 'userroles') {
4151: next if (grep(/^\Q$role\E$/,@privroles));
4152: } else {
4153: my $possdoms = [$domain];
4154: if (ref($roledoms) eq 'ARRAY') {
4155: push(@{$possdoms},@{$roledoms});
4156: }
4157: if (&privileged($username,$domain,$possdoms,\@privroles)) {
4158: if (!$nothide{$username.':'.$domain}) {
4159: next;
4160: }
4161: }
4162: }
4163: }
4164: if ($withsec) {
4165: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4166: $tstart.':'.$tend;
4167: } else {
4168: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4169: }
4170: }
4171: return %returnhash;
4172: }
4173:
4174: # ----------------------------------------------------- Frontpage Announcements
4175: #
4176: #
4177:
4178: sub postannounce {
4179: my ($server,$text)=@_;
4180: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
4181: unless ($text=~/\w/) { $text=''; }
4182: return &reply('setannounce:'.&escape($text),$server);
4183: }
4184:
4185: sub getannounce {
4186:
4187: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
4188: my $announcement='';
4189: while (my $line = <$fh>) { $announcement .= $line; }
4190: close($fh);
4191: if ($announcement=~/\w/) {
4192: return
4193: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
4194: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
4195: } else {
4196: return '';
4197: }
4198: } else {
4199: return '';
4200: }
4201: }
4202:
4203: # ---------------------------------------------------------- Course ID routines
4204: # Deal with domain's nohist_courseid.db files
4205: #
4206:
4207: sub courseidput {
4208: my ($domain,$storehash,$coursehome,$caller) = @_;
4209: return unless (ref($storehash) eq 'HASH');
4210: my $outcome;
4211: if ($caller eq 'timeonly') {
4212: my $cids = '';
4213: foreach my $item (keys(%$storehash)) {
4214: $cids.=&escape($item).'&';
4215: }
4216: $cids=~s/\&$//;
4217: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4218: $coursehome);
4219: } else {
4220: my $items = '';
4221: foreach my $item (keys(%$storehash)) {
4222: $items.= &escape($item).'='.
4223: &freeze_escape($$storehash{$item}).'&';
4224: }
4225: $items=~s/\&$//;
4226: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4227: $coursehome);
4228: }
4229: if ($outcome eq 'unknown_cmd') {
4230: my $what;
4231: foreach my $cid (keys(%$storehash)) {
4232: $what .= &escape($cid).'=';
4233: foreach my $item ('description','inst_code','owner','type') {
4234: $what .= &escape($storehash->{$cid}{$item}).':';
4235: }
4236: $what =~ s/\:$/&/;
4237: }
4238: $what =~ s/\&$//;
4239: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4240: } else {
4241: return $outcome;
4242: }
4243: }
4244:
4245: sub courseiddump {
4246: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
4247: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
4248: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
4249: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
4250: $hasuniquecode)=@_;
4251: my $as_hash = 1;
4252: my %returnhash;
4253: if (!$domfilter) { $domfilter=''; }
4254: my %libserv = &all_library();
4255: foreach my $tryserver (keys(%libserv)) {
4256: if ( ( $hostidflag == 1
4257: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4258: || (!defined($hostidflag)) ) {
4259:
4260: if (($domfilter eq '') ||
4261: (&host_domain($tryserver) eq $domfilter)) {
4262: my $rep;
4263: if (grep { $_ eq $tryserver } current_machine_ids()) {
4264: $rep = LONCAPA::Lond::dump_course_id_handler(
4265: join(":", (&host_domain($tryserver), $sincefilter,
4266: &escape($descfilter), &escape($instcodefilter),
4267: &escape($ownerfilter), &escape($coursefilter),
4268: &escape($typefilter), &escape($regexp_ok),
4269: $as_hash, &escape($selfenrollonly),
4270: &escape($catfilter), $showhidden, $caller,
4271: &escape($cloner), &escape($cc_clone), $cloneonly,
4272: &escape($createdbefore), &escape($createdafter),
4273: &escape($creationcontext), $domcloner, $hasuniquecode)));
4274: } else {
4275: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4276: $sincefilter.':'.&escape($descfilter).':'.
4277: &escape($instcodefilter).':'.&escape($ownerfilter).
4278: ':'.&escape($coursefilter).':'.&escape($typefilter).
4279: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4280: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4281: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4282: &escape($cc_clone).':'.$cloneonly.':'.
4283: &escape($createdbefore).':'.&escape($createdafter).':'.
4284: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode,
4285: $tryserver);
4286: }
4287:
4288: my @pairs=split(/\&/,$rep);
4289: foreach my $item (@pairs) {
4290: my ($key,$value)=split(/\=/,$item,2);
4291: $key = &unescape($key);
4292: next if ($key =~ /^error: 2 /);
4293: my $result = &thaw_unescape($value);
4294: if (ref($result) eq 'HASH') {
4295: $returnhash{$key}=$result;
4296: } else {
4297: my @responses = split(/:/,$value);
4298: my @items = ('description','inst_code','owner','type');
4299: for (my $i=0; $i<@responses; $i++) {
4300: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
4301: }
4302: }
4303: }
4304: }
4305: }
4306: }
4307: return %returnhash;
4308: }
4309:
4310: sub courselastaccess {
4311: my ($cdom,$cnum,$hostidref) = @_;
4312: my %returnhash;
4313: if ($cdom && $cnum) {
4314: my $chome = &homeserver($cnum,$cdom);
4315: if ($chome ne 'no_host') {
4316: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4317: &extract_lastaccess(\%returnhash,$rep);
4318: }
4319: } else {
4320: if (!$cdom) { $cdom=''; }
4321: my %libserv = &all_library();
4322: foreach my $tryserver (keys(%libserv)) {
4323: if (ref($hostidref) eq 'ARRAY') {
4324: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4325: }
4326: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4327: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4328: &extract_lastaccess(\%returnhash,$rep);
4329: }
4330: }
4331: }
4332: return %returnhash;
4333: }
4334:
4335: sub extract_lastaccess {
4336: my ($returnhash,$rep) = @_;
4337: if (ref($returnhash) eq 'HASH') {
4338: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4339: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4340: $rep eq '') {
4341: my @pairs=split(/\&/,$rep);
4342: foreach my $item (@pairs) {
4343: my ($key,$value)=split(/\=/,$item,2);
4344: $key = &unescape($key);
4345: next if ($key =~ /^error: 2 /);
4346: $returnhash->{$key} = &thaw_unescape($value);
4347: }
4348: }
4349: }
4350: return;
4351: }
4352:
4353: # ---------------------------------------------------------- DC e-mail
4354:
4355: sub dcmailput {
4356: my ($domain,$msgid,$message,$server)=@_;
4357: my $status = &Apache::lonnet::critical(
4358: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4359: &escape($message),$server);
4360: return $status;
4361: }
4362:
4363: sub dcmaildump {
4364: my ($dom,$startdate,$enddate,$senders) = @_;
4365: my %returnhash=();
4366:
4367: if (defined(&domain($dom,'primary'))) {
4368: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4369: &escape($enddate).':';
4370: my @esc_senders=map { &escape($_)} @$senders;
4371: $cmd.=&escape(join('&',@esc_senders));
4372: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
4373: my ($key,$value) = split(/\=/,$line,2);
4374: if (($key) && ($value)) {
4375: $returnhash{&unescape($key)} = &unescape($value);
4376: }
4377: }
4378: }
4379: return %returnhash;
4380: }
4381: # ---------------------------------------------------------- Domain roles
4382:
4383: sub get_domain_roles {
4384: my ($dom,$roles,$startdate,$enddate)=@_;
4385: if ((!defined($startdate)) || ($startdate eq '')) {
4386: $startdate = '.';
4387: }
4388: if ((!defined($enddate)) || ($enddate eq '')) {
4389: $enddate = '.';
4390: }
4391: my $rolelist;
4392: if (ref($roles) eq 'ARRAY') {
4393: $rolelist = join('&',@{$roles});
4394: }
4395: my %personnel = ();
4396:
4397: my %servers = &get_servers($dom,'library');
4398: foreach my $tryserver (keys(%servers)) {
4399: %{$personnel{$tryserver}}=();
4400: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4401: &escape($startdate).':'.
4402: &escape($enddate).':'.
4403: &escape($rolelist), $tryserver))) {
4404: my ($key,$value) = split(/\=/,$line,2);
4405: if (($key) && ($value)) {
4406: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4407: }
4408: }
4409: }
4410: return %personnel;
4411: }
4412:
4413: # ----------------------------------------------------------- Interval timing
4414:
4415: {
4416: # Caches needed for speedup of navmaps
4417: # We don't want to cache this for very long at all (5 seconds at most)
4418: #
4419: # The user for whom we cache
4420: my $cachedkey='';
4421: # The cached times for this user
4422: my %cachedtimes=();
4423: # When this was last done
4424: my $cachedtime=();
4425:
4426: sub load_all_first_access {
4427: my ($uname,$udom)=@_;
4428: if (($cachedkey eq $uname.':'.$udom) &&
4429: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
4430: return;
4431: }
4432: $cachedtime=time;
4433: $cachedkey=$uname.':'.$udom;
4434: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
4435: }
4436:
4437: sub get_first_access {
4438: my ($type,$argsymb,$argmap)=@_;
4439: my ($symb,$courseid,$udom,$uname)=&whichuser();
4440: if ($argsymb) { $symb=$argsymb; }
4441: my ($map,$id,$res)=&decode_symb($symb);
4442: if ($argmap) { $map = $argmap; }
4443: if ($type eq 'course') {
4444: $res='course';
4445: } elsif ($type eq 'map') {
4446: $res=&symbread($map);
4447: } else {
4448: $res=$symb;
4449: }
4450: &load_all_first_access($uname,$udom);
4451: return $cachedtimes{"$courseid\0$res"};
4452: }
4453:
4454: sub set_first_access {
4455: my ($type,$interval)=@_;
4456: my ($symb,$courseid,$udom,$uname)=&whichuser();
4457: my ($map,$id,$res)=&decode_symb($symb);
4458: if ($type eq 'course') {
4459: $res='course';
4460: } elsif ($type eq 'map') {
4461: $res=&symbread($map);
4462: } else {
4463: $res=$symb;
4464: }
4465: $cachedkey='';
4466: my $firstaccess=&get_first_access($type,$symb,$map);
4467: if (!$firstaccess) {
4468: my $start = time;
4469: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4470: $udom,$uname);
4471: if ($putres eq 'ok') {
4472: &put('timerinterval',{"$courseid\0$res"=>$interval},
4473: $udom,$uname);
4474: &appenv(
4475: {
4476: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4477: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4478: }
4479: );
4480: }
4481: return $putres;
4482: }
4483: return 'already_set';
4484: }
4485: }
4486: # --------------------------------------------- Set Expire Date for Spreadsheet
4487:
4488: sub expirespread {
4489: my ($uname,$udom,$stype,$usymb)=@_;
4490: my $cid=$env{'request.course.id'};
4491: if ($cid) {
4492: my $now=time;
4493: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
4494: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4495: $env{'course.'.$cid.'.num'}.
4496: ':nohist_expirationdates:'.
4497: &escape($key).'='.$now,
4498: $env{'course.'.$cid.'.home'})
4499: }
4500: return 'ok';
4501: }
4502:
4503: # ----------------------------------------------------- Devalidate Spreadsheets
4504:
4505: sub devalidate {
4506: my ($symb,$uname,$udom)=@_;
4507: my $cid=$env{'request.course.id'};
4508: if ($cid) {
4509: # delete the stored spreadsheets for
4510: # - the student level sheet of this user in course's homespace
4511: # - the assessment level sheet for this resource
4512: # for this user in user's homespace
4513: # - current conditional state info
4514: my $key=$uname.':'.$udom.':';
4515: my $status=
4516: &del('nohist_calculatedsheets',
4517: [$key.'studentcalc:'],
4518: $env{'course.'.$cid.'.domain'},
4519: $env{'course.'.$cid.'.num'})
4520: .' '.
4521: &del('nohist_calculatedsheets_'.$cid,
4522: [$key.'assesscalc:'.$symb],$udom,$uname);
4523: unless ($status eq 'ok ok') {
4524: &logthis('Could not devalidate spreadsheet '.
4525: $uname.' at '.$udom.' for '.
4526: $symb.': '.$status);
4527: }
4528: &delenv('user.state.'.$cid);
4529: }
4530: }
4531:
4532: sub get_scalar {
4533: my ($string,$end) = @_;
4534: my $value;
4535: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4536: $value = $1;
4537: } elsif ($$string =~ s/^([^&]*?)&//) {
4538: $value = $1;
4539: }
4540: return &unescape($value);
4541: }
4542:
4543: sub array2str {
4544: my (@array) = @_;
4545: my $result=&arrayref2str(\@array);
4546: $result=~s/^__ARRAY_REF__//;
4547: $result=~s/__END_ARRAY_REF__$//;
4548: return $result;
4549: }
4550:
4551: sub arrayref2str {
4552: my ($arrayref) = @_;
4553: my $result='__ARRAY_REF__';
4554: foreach my $elem (@$arrayref) {
4555: if(ref($elem) eq 'ARRAY') {
4556: $result.=&arrayref2str($elem).'&';
4557: } elsif(ref($elem) eq 'HASH') {
4558: $result.=&hashref2str($elem).'&';
4559: } elsif(ref($elem)) {
4560: #print("Got a ref of ".(ref($elem))." skipping.");
4561: } else {
4562: $result.=&escape($elem).'&';
4563: }
4564: }
4565: $result=~s/\&$//;
4566: $result .= '__END_ARRAY_REF__';
4567: return $result;
4568: }
4569:
4570: sub hash2str {
4571: my (%hash) = @_;
4572: my $result=&hashref2str(\%hash);
4573: $result=~s/^__HASH_REF__//;
4574: $result=~s/__END_HASH_REF__$//;
4575: return $result;
4576: }
4577:
4578: sub hashref2str {
4579: my ($hashref)=@_;
4580: my $result='__HASH_REF__';
4581: foreach my $key (sort(keys(%$hashref))) {
4582: if (ref($key) eq 'ARRAY') {
4583: $result.=&arrayref2str($key).'=';
4584: } elsif (ref($key) eq 'HASH') {
4585: $result.=&hashref2str($key).'=';
4586: } elsif (ref($key)) {
4587: $result.='=';
4588: #print("Got a ref of ".(ref($key))." skipping.");
4589: } else {
4590: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
4591: }
4592:
4593: if(ref($hashref->{$key}) eq 'ARRAY') {
4594: $result.=&arrayref2str($hashref->{$key}).'&';
4595: } elsif(ref($hashref->{$key}) eq 'HASH') {
4596: $result.=&hashref2str($hashref->{$key}).'&';
4597: } elsif(ref($hashref->{$key})) {
4598: $result.='&';
4599: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
4600: } else {
4601: $result.=&escape($hashref->{$key}).'&';
4602: }
4603: }
4604: $result=~s/\&$//;
4605: $result .= '__END_HASH_REF__';
4606: return $result;
4607: }
4608:
4609: sub str2hash {
4610: my ($string)=@_;
4611: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4612: return %$hash;
4613: }
4614:
4615: sub str2hashref {
4616: my ($string) = @_;
4617:
4618: my %hash;
4619:
4620: if($string !~ /^__HASH_REF__/) {
4621: if (! ($string eq '' || !defined($string))) {
4622: $hash{'error'}='Not hash reference';
4623: }
4624: return (\%hash, $string);
4625: }
4626:
4627: $string =~ s/^__HASH_REF__//;
4628:
4629: while($string !~ /^__END_HASH_REF__/) {
4630: #key
4631: my $key='';
4632: if($string =~ /^__HASH_REF__/) {
4633: ($key, $string)=&str2hashref($string);
4634: if(defined($key->{'error'})) {
4635: $hash{'error'}='Bad data';
4636: return (\%hash, $string);
4637: }
4638: } elsif($string =~ /^__ARRAY_REF__/) {
4639: ($key, $string)=&str2arrayref($string);
4640: if($key->[0] eq 'Array reference error') {
4641: $hash{'error'}='Bad data';
4642: return (\%hash, $string);
4643: }
4644: } else {
4645: $string =~ s/^(.*?)=//;
4646: $key=&unescape($1);
4647: }
4648: $string =~ s/^=//;
4649:
4650: #value
4651: my $value='';
4652: if($string =~ /^__HASH_REF__/) {
4653: ($value, $string)=&str2hashref($string);
4654: if(defined($value->{'error'})) {
4655: $hash{'error'}='Bad data';
4656: return (\%hash, $string);
4657: }
4658: } elsif($string =~ /^__ARRAY_REF__/) {
4659: ($value, $string)=&str2arrayref($string);
4660: if($value->[0] eq 'Array reference error') {
4661: $hash{'error'}='Bad data';
4662: return (\%hash, $string);
4663: }
4664: } else {
4665: $value=&get_scalar(\$string,'__END_HASH_REF__');
4666: }
4667: $string =~ s/^&//;
4668:
4669: $hash{$key}=$value;
4670: }
4671:
4672: $string =~ s/^__END_HASH_REF__//;
4673:
4674: return (\%hash, $string);
4675: }
4676:
4677: sub str2array {
4678: my ($string)=@_;
4679: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4680: return @$array;
4681: }
4682:
4683: sub str2arrayref {
4684: my ($string) = @_;
4685: my @array;
4686:
4687: if($string !~ /^__ARRAY_REF__/) {
4688: if (! ($string eq '' || !defined($string))) {
4689: $array[0]='Array reference error';
4690: }
4691: return (\@array, $string);
4692: }
4693:
4694: $string =~ s/^__ARRAY_REF__//;
4695:
4696: while($string !~ /^__END_ARRAY_REF__/) {
4697: my $value='';
4698: if($string =~ /^__HASH_REF__/) {
4699: ($value, $string)=&str2hashref($string);
4700: if(defined($value->{'error'})) {
4701: $array[0] ='Array reference error';
4702: return (\@array, $string);
4703: }
4704: } elsif($string =~ /^__ARRAY_REF__/) {
4705: ($value, $string)=&str2arrayref($string);
4706: if($value->[0] eq 'Array reference error') {
4707: $array[0] ='Array reference error';
4708: return (\@array, $string);
4709: }
4710: } else {
4711: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4712: }
4713: $string =~ s/^&//;
4714:
4715: push(@array, $value);
4716: }
4717:
4718: $string =~ s/^__END_ARRAY_REF__//;
4719:
4720: return (\@array, $string);
4721: }
4722:
4723: # -------------------------------------------------------------------Temp Store
4724:
4725: sub tmpreset {
4726: my ($symb,$namespace,$domain,$stuname) = @_;
4727: if (!$symb) {
4728: $symb=&symbread();
4729: if (!$symb) { $symb= $env{'request.url'}; }
4730: }
4731: $symb=escape($symb);
4732:
4733: if (!$namespace) { $namespace=$env{'request.state'}; }
4734: $namespace=~s/\//\_/g;
4735: $namespace=~s/\W//g;
4736:
4737: if (!$domain) { $domain=$env{'user.domain'}; }
4738: if (!$stuname) { $stuname=$env{'user.name'}; }
4739: if ($domain eq 'public' && $stuname eq 'public') {
4740: $stuname=$ENV{'REMOTE_ADDR'};
4741: }
4742: my $path=LONCAPA::tempdir();
4743: my %hash;
4744: if (tie(%hash,'GDBM_File',
4745: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4746: &GDBM_WRCREAT(),0640)) {
4747: foreach my $key (keys(%hash)) {
4748: if ($key=~ /:$symb/) {
4749: delete($hash{$key});
4750: }
4751: }
4752: }
4753: }
4754:
4755: sub tmpstore {
4756: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4757:
4758: if (!$symb) {
4759: $symb=&symbread();
4760: if (!$symb) { $symb= $env{'request.url'}; }
4761: }
4762: $symb=escape($symb);
4763:
4764: if (!$namespace) {
4765: # I don't think we would ever want to store this for a course.
4766: # it seems this will only be used if we don't have a course.
4767: #$namespace=$env{'request.course.id'};
4768: #if (!$namespace) {
4769: $namespace=$env{'request.state'};
4770: #}
4771: }
4772: $namespace=~s/\//\_/g;
4773: $namespace=~s/\W//g;
4774: if (!$domain) { $domain=$env{'user.domain'}; }
4775: if (!$stuname) { $stuname=$env{'user.name'}; }
4776: if ($domain eq 'public' && $stuname eq 'public') {
4777: $stuname=$ENV{'REMOTE_ADDR'};
4778: }
4779: my $now=time;
4780: my %hash;
4781: my $path=LONCAPA::tempdir();
4782: if (tie(%hash,'GDBM_File',
4783: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4784: &GDBM_WRCREAT(),0640)) {
4785: $hash{"version:$symb"}++;
4786: my $version=$hash{"version:$symb"};
4787: my $allkeys='';
4788: foreach my $key (keys(%$storehash)) {
4789: $allkeys.=$key.':';
4790: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
4791: }
4792: $hash{"$version:$symb:timestamp"}=$now;
4793: $allkeys.='timestamp';
4794: $hash{"$version:keys:$symb"}=$allkeys;
4795: if (untie(%hash)) {
4796: return 'ok';
4797: } else {
4798: return "error:$!";
4799: }
4800: } else {
4801: return "error:$!";
4802: }
4803: }
4804:
4805: # -----------------------------------------------------------------Temp Restore
4806:
4807: sub tmprestore {
4808: my ($symb,$namespace,$domain,$stuname) = @_;
4809:
4810: if (!$symb) {
4811: $symb=&symbread();
4812: if (!$symb) { $symb= $env{'request.url'}; }
4813: }
4814: $symb=escape($symb);
4815:
4816: if (!$namespace) { $namespace=$env{'request.state'}; }
4817:
4818: if (!$domain) { $domain=$env{'user.domain'}; }
4819: if (!$stuname) { $stuname=$env{'user.name'}; }
4820: if ($domain eq 'public' && $stuname eq 'public') {
4821: $stuname=$ENV{'REMOTE_ADDR'};
4822: }
4823: my %returnhash;
4824: $namespace=~s/\//\_/g;
4825: $namespace=~s/\W//g;
4826: my %hash;
4827: my $path=LONCAPA::tempdir();
4828: if (tie(%hash,'GDBM_File',
4829: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4830: &GDBM_READER(),0640)) {
4831: my $version=$hash{"version:$symb"};
4832: $returnhash{'version'}=$version;
4833: my $scope;
4834: for ($scope=1;$scope<=$version;$scope++) {
4835: my $vkeys=$hash{"$scope:keys:$symb"};
4836: my @keys=split(/:/,$vkeys);
4837: my $key;
4838: $returnhash{"$scope:keys"}=$vkeys;
4839: foreach $key (@keys) {
4840: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4841: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4842: }
4843: }
4844: if (!(untie(%hash))) {
4845: return "error:$!";
4846: }
4847: } else {
4848: return "error:$!";
4849: }
4850: return %returnhash;
4851: }
4852:
4853: # ----------------------------------------------------------------------- Store
4854:
4855: sub store {
4856: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
4857: my $home='';
4858:
4859: if ($stuname) { $home=&homeserver($stuname,$domain); }
4860:
4861: $symb=&symbclean($symb);
4862: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4863:
4864: if (!$domain) { $domain=$env{'user.domain'}; }
4865: if (!$stuname) { $stuname=$env{'user.name'}; }
4866:
4867: &devalidate($symb,$stuname,$domain);
4868:
4869: $symb=escape($symb);
4870: if (!$namespace) {
4871: unless ($namespace=$env{'request.course.id'}) {
4872: return '';
4873: }
4874: }
4875: if (!$home) { $home=$env{'user.home'}; }
4876:
4877: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4878: $$storehash{'host'}=$perlvar{'lonHostID'};
4879:
4880: my $namevalue='';
4881: foreach my $key (keys(%$storehash)) {
4882: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4883: }
4884: $namevalue=~s/\&$//;
4885: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
4886: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
4887: }
4888:
4889: # -------------------------------------------------------------- Critical Store
4890:
4891: sub cstore {
4892: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
4893: my $home='';
4894:
4895: if ($stuname) { $home=&homeserver($stuname,$domain); }
4896:
4897: $symb=&symbclean($symb);
4898: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4899:
4900: if (!$domain) { $domain=$env{'user.domain'}; }
4901: if (!$stuname) { $stuname=$env{'user.name'}; }
4902:
4903: &devalidate($symb,$stuname,$domain);
4904:
4905: $symb=escape($symb);
4906: if (!$namespace) {
4907: unless ($namespace=$env{'request.course.id'}) {
4908: return '';
4909: }
4910: }
4911: if (!$home) { $home=$env{'user.home'}; }
4912:
4913: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4914: $$storehash{'host'}=$perlvar{'lonHostID'};
4915:
4916: my $namevalue='';
4917: foreach my $key (keys(%$storehash)) {
4918: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4919: }
4920: $namevalue=~s/\&$//;
4921: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
4922: return critical
4923: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
4924: }
4925:
4926: # --------------------------------------------------------------------- Restore
4927:
4928: sub restore {
4929: my ($symb,$namespace,$domain,$stuname) = @_;
4930: my $home='';
4931:
4932: if ($stuname) { $home=&homeserver($stuname,$domain); }
4933:
4934: if (!$symb) {
4935: return if ($namespace eq 'courserequests');
4936: unless ($symb=escape(&symbread())) { return ''; }
4937: } else {
4938: unless ($namespace eq 'courserequests') {
4939: $symb=&escape(&symbclean($symb));
4940: }
4941: }
4942: if (!$namespace) {
4943: unless ($namespace=$env{'request.course.id'}) {
4944: return '';
4945: }
4946: }
4947: if (!$domain) { $domain=$env{'user.domain'}; }
4948: if (!$stuname) { $stuname=$env{'user.name'}; }
4949: if (!$home) { $home=$env{'user.home'}; }
4950: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
4951:
4952: my %returnhash=();
4953: foreach my $line (split(/\&/,$answer)) {
4954: my ($name,$value)=split(/\=/,$line);
4955: $returnhash{&unescape($name)}=&thaw_unescape($value);
4956: }
4957: my $version;
4958: for ($version=1;$version<=$returnhash{'version'};$version++) {
4959: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
4960: $returnhash{$item}=$returnhash{$version.':'.$item};
4961: }
4962: }
4963: return %returnhash;
4964: }
4965:
4966: # ---------------------------------------------------------- Course Description
4967: #
4968: #
4969:
4970: sub coursedescription {
4971: my ($courseid,$args)=@_;
4972: $courseid=~s/^\///;
4973: $courseid=~s/\_/\//g;
4974: my ($cdomain,$cnum)=split(/\//,$courseid);
4975: my $chome=&homeserver($cnum,$cdomain);
4976: my $normalid=$cdomain.'_'.$cnum;
4977: # need to always cache even if we get errors otherwise we keep
4978: # trying and trying and trying to get the course description.
4979: my %envhash=();
4980: my %returnhash=();
4981:
4982: my $expiretime=600;
4983: if ($env{'request.course.id'} eq $normalid) {
4984: $expiretime=120;
4985: }
4986:
4987: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
4988: if (!$args->{'freshen_cache'}
4989: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
4990: foreach my $key (keys(%env)) {
4991: next if ($key !~ /^\Q$prefix\E(.*)/);
4992: my ($setting) = $1;
4993: $returnhash{$setting} = $env{$key};
4994: }
4995: return %returnhash;
4996: }
4997:
4998: # get the data again
4999:
5000: if (!$args->{'one_time'}) {
5001: $envhash{'course.'.$normalid.'.last_cache'}=time;
5002: }
5003:
5004: if ($chome ne 'no_host') {
5005: %returnhash=&dump('environment',$cdomain,$cnum);
5006: if (!exists($returnhash{'con_lost'})) {
5007: my $username = $env{'user.name'}; # Defult username
5008: if(defined $args->{'user'}) {
5009: $username = $args->{'user'};
5010: }
5011: $returnhash{'home'}= $chome;
5012: $returnhash{'domain'} = $cdomain;
5013: $returnhash{'num'} = $cnum;
5014: if (!defined($returnhash{'type'})) {
5015: $returnhash{'type'} = 'Course';
5016: }
5017: while (my ($name,$value) = each %returnhash) {
5018: $envhash{'course.'.$normalid.'.'.$name}=$value;
5019: }
5020: $returnhash{'url'}=&clutter($returnhash{'url'});
5021: $returnhash{'fn'}=LONCAPA::tempdir() .
5022: $username.'_'.$cdomain.'_'.$cnum;
5023: $envhash{'course.'.$normalid.'.home'}=$chome;
5024: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5025: $envhash{'course.'.$normalid.'.num'}=$cnum;
5026: }
5027: }
5028: if (!$args->{'one_time'}) {
5029: &appenv(\%envhash);
5030: }
5031: return %returnhash;
5032: }
5033:
5034: sub update_released_required {
5035: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5036: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5037: $cid = $env{'request.course.id'};
5038: $cdom = $env{'course.'.$cid.'.domain'};
5039: $cnum = $env{'course.'.$cid.'.num'};
5040: $chome = $env{'course.'.$cid.'.home'};
5041: }
5042: if ($needsrelease) {
5043: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5044: my $needsupdate;
5045: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5046: $needsupdate = 1;
5047: } else {
5048: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5049: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5050: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5051: $needsupdate = 1;
5052: }
5053: }
5054: if ($needsupdate) {
5055: my %needshash = (
5056: 'internal.releaserequired' => $needsrelease,
5057: );
5058: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5059: if ($putresult eq 'ok') {
5060: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5061: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5062: if (ref($crsinfo{$cid}) eq 'HASH') {
5063: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5064: &courseidput($cdom,\%crsinfo,$chome,'notime');
5065: }
5066: }
5067: }
5068: }
5069: return;
5070: }
5071:
5072: # -------------------------------------------------See if a user is privileged
5073:
5074: sub privileged {
5075: my ($username,$domain,$possdomains,$possroles)=@_;
5076: my $now = time;
5077: my $roles;
5078: if (ref($possroles) eq 'ARRAY') {
5079: $roles = $possroles;
5080: } else {
5081: $roles = ['dc','su'];
5082: }
5083: if (ref($possdomains) eq 'ARRAY') {
5084: my %privileged = &privileged_by_domain($possdomains,$roles);
5085: foreach my $dom (@{$possdomains}) {
5086: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5087: (ref($privileged{$dom}) eq 'HASH')) {
5088: foreach my $role (@{$roles}) {
5089: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5090: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5091: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5092: return 1 unless (($end && $end < $now) ||
5093: ($start && $start > $now));
5094: }
5095: }
5096: }
5097: }
5098: }
5099: } else {
5100: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5101: my $now = time;
5102:
5103: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys %rolesdump}) {
5104: my ($trole, $tend, $tstart) = split(/_/, $role);
5105: if (grep(/^\Q$trole\E$/,@{$roles})) {
5106: return 1 unless ($tend && $tend < $now)
5107: or ($tstart && $tstart > $now);
5108: }
5109: }
5110: }
5111: return 0;
5112: }
5113:
5114: sub privileged_by_domain {
5115: my ($domains,$roles) = @_;
5116: my %privileged = ();
5117: my $cachetime = 60*60*24;
5118: my $now = time;
5119: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5120: return %privileged;
5121: }
5122: foreach my $dom (@{$domains}) {
5123: next if (ref($privileged{$dom}) eq 'HASH');
5124: my $needroles;
5125: foreach my $role (@{$roles}) {
5126: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5127: if (defined($cached)) {
5128: if (ref($result) eq 'HASH') {
5129: $privileged{$dom}{$role} = $result;
5130: }
5131: } else {
5132: $needroles = 1;
5133: }
5134: }
5135: if ($needroles) {
5136: my %dompersonnel = &get_domain_roles($dom,$roles);
5137: $privileged{$dom} = {};
5138: foreach my $server (keys(%dompersonnel)) {
5139: if (ref($dompersonnel{$server}) eq 'HASH') {
5140: foreach my $item (keys(%{$dompersonnel{$server}})) {
5141: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5142: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5143: next if ($end && $end < $now);
5144: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5145: $dompersonnel{$server}{$item};
5146: }
5147: }
5148: }
5149: if (ref($privileged{$dom}) eq 'HASH') {
5150: foreach my $role (@{$roles}) {
5151: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5152: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5153: } else {
5154: my %hash = ();
5155: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5156: }
5157: }
5158: }
5159: }
5160: }
5161: return %privileged;
5162: }
5163:
5164: # -------------------------------------------------------- Get user privileges
5165:
5166: sub rolesinit {
5167: my ($domain, $username) = @_;
5168: my %userroles = ('user.login.time' => time);
5169: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5170:
5171: # firstaccess and timerinterval are related to timed maps/resources.
5172: # also, blocking can be triggered by an activating timer
5173: # it's saved in the user's %env.
5174: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5175: my %timerinterval = &dump('timerinterval', $domain, $username);
5176: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5177: %timerintchk, %timerintenv);
5178:
5179: foreach my $key (keys(%firstaccess)) {
5180: my ($cid, $rest) = split(/\0/, $key);
5181: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5182: }
5183:
5184: foreach my $key (keys(%timerinterval)) {
5185: my ($cid,$rest) = split(/\0/,$key);
5186: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5187: }
5188:
5189: my %allroles=();
5190: my %allgroups=();
5191:
5192: for my $area (grep { ! /^rolesdef_/ } keys %rolesdump) {
5193: my $role = $rolesdump{$area};
5194: $area =~ s/\_\w\w$//;
5195:
5196: my ($trole, $tend, $tstart, $group_privs);
5197:
5198: if ($role =~ /^cr/) {
5199: # Custom role, defined by a user
5200: # e.g., user.role.cr/msu/smith/mynewrole
5201: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5202: $trole = $1;
5203: ($tend, $tstart) = split('_', $2);
5204: } else {
5205: $trole = $role;
5206: }
5207: } elsif ($role =~ m|^gr/|) {
5208: # Role of member in a group, defined within a course/community
5209: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5210: ($trole, $tend, $tstart) = split(/_/, $role);
5211: next if $tstart eq '-1';
5212: ($trole, $group_privs) = split(/\//, $trole);
5213: $group_privs = &unescape($group_privs);
5214: } else {
5215: # Just a normal role, defined in roles.tab
5216: ($trole, $tend, $tstart) = split(/_/,$role);
5217: }
5218:
5219: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5220: $username);
5221: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5222:
5223: # role expired or not available yet?
5224: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5225: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5226:
5227: next if $area eq '' or $trole eq '';
5228:
5229: my $spec = "$trole.$area";
5230: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5231:
5232: if ($trole =~ /^cr\//) {
5233: # Custom role, defined by a user
5234: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5235: } elsif ($trole eq 'gr') {
5236: # Role of a member in a group, defined within a course/community
5237: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5238: next;
5239: } else {
5240: # Normal role, defined in roles.tab
5241: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5242: }
5243:
5244: my $cid = $tdomain.'_'.$trest;
5245: unless ($firstaccchk{$cid}) {
5246: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5247: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5248: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5249: $coursetimerstarts{$cid}{$item};
5250: }
5251: }
5252: $firstaccchk{$cid} = 1;
5253: }
5254: unless ($timerintchk{$cid}) {
5255: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5256: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5257: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5258: $coursetimerintervals{$cid}{$item};
5259: }
5260: }
5261: $timerintchk{$cid} = 1;
5262: }
5263: }
5264:
5265: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
5266: \%allroles, \%allgroups);
5267: $env{'user.adv'} = $userroles{'user.adv'};
5268:
5269: return (\%userroles,\%firstaccenv,\%timerintenv);
5270: }
5271:
5272: sub set_arearole {
5273: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5274: unless ($nolog) {
5275: # log the associated role with the area
5276: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5277: }
5278: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
5279: }
5280:
5281: sub custom_roleprivs {
5282: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5283: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
5284: my $homsvr = &homeserver($rauthor,$rdomain);
5285: if (&hostname($homsvr) ne '') {
5286: my ($rdummy,$roledef)=
5287: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5288: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5289: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5290: if (defined($syspriv)) {
5291: if ($trest =~ /^$match_community$/) {
5292: $syspriv =~ s/bre\&S//;
5293: }
5294: $$allroles{'cm./'}.=':'.$syspriv;
5295: $$allroles{$spec.'./'}.=':'.$syspriv;
5296: }
5297: if ($tdomain ne '') {
5298: if (defined($dompriv)) {
5299: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5300: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5301: }
5302: if (($trest ne '') && (defined($coursepriv))) {
5303: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5304: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5305: }
5306: }
5307: }
5308: }
5309: }
5310:
5311: sub group_roleprivs {
5312: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5313: my $access = 1;
5314: my $now = time;
5315: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5316: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5317: if ($access) {
5318: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
5319: $$allgroups{$course}{$group} .=':'.$group_privs;
5320: }
5321: }
5322:
5323: sub standard_roleprivs {
5324: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5325: if (defined($pr{$trole.':s'})) {
5326: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5327: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5328: }
5329: if ($tdomain ne '') {
5330: if (defined($pr{$trole.':d'})) {
5331: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5332: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5333: }
5334: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5335: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5336: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5337: }
5338: }
5339: }
5340:
5341: sub set_userprivs {
5342: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
5343: my $author=0;
5344: my $adv=0;
5345: my %grouproles = ();
5346: if (keys(%{$allgroups}) > 0) {
5347: my @groupkeys;
5348: foreach my $role (keys(%{$allroles})) {
5349: push(@groupkeys,$role);
5350: }
5351: if (ref($groups_roles) eq 'HASH') {
5352: foreach my $key (keys(%{$groups_roles})) {
5353: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5354: push(@groupkeys,$key);
5355: }
5356: }
5357: }
5358: if (@groupkeys > 0) {
5359: foreach my $role (@groupkeys) {
5360: my ($trole,$area,$sec,$extendedarea);
5361: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5362: $trole = $1;
5363: $area = $2;
5364: $sec = $3;
5365: $extendedarea = $area.$sec;
5366: if (exists($$allgroups{$area})) {
5367: foreach my $group (keys(%{$$allgroups{$area}})) {
5368: my $spec = $trole.'.'.$extendedarea;
5369: $grouproles{$spec.'.'.$area.'/'.$group} =
5370: $$allgroups{$area}{$group};
5371: }
5372: }
5373: }
5374: }
5375: }
5376: }
5377: foreach my $group (keys(%grouproles)) {
5378: $$allroles{$group} = $grouproles{$group};
5379: }
5380: foreach my $role (keys(%{$allroles})) {
5381: my %thesepriv;
5382: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
5383: foreach my $item (split(/:/,$$allroles{$role})) {
5384: if ($item ne '') {
5385: my ($privilege,$restrictions)=split(/&/,$item);
5386: if ($restrictions eq '') {
5387: $thesepriv{$privilege}='F';
5388: } elsif ($thesepriv{$privilege} ne 'F') {
5389: $thesepriv{$privilege}.=$restrictions;
5390: }
5391: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5392: }
5393: }
5394: my $thesestr='';
5395: foreach my $priv (sort(keys(%thesepriv))) {
5396: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5397: }
5398: $userroles->{'user.priv.'.$role} = $thesestr;
5399: }
5400: return ($author,$adv);
5401: }
5402:
5403: sub role_status {
5404: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
5405: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
5406: my ($one,$two) = split(m{\./},$rolekey,2);
5407: (undef,undef,$$role) = split(/\./,$one,3);
5408: unless (!defined($$role) || $$role eq '') {
5409: $$where = '/'.$two;
5410: $$trolecode=$$role.'.'.$$where;
5411: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5412: $$tstatus='is';
5413: if ($$tstart && $$tstart>$update) {
5414: $$tstatus='future';
5415: if ($$tstart<$now) {
5416: if ($$tstart && $$tstart>$refresh) {
5417: if (($$where ne '') && ($$role ne '')) {
5418: my (%allroles,%allgroups,$group_privs,
5419: %groups_roles,@rolecodes);
5420: my %userroles = (
5421: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5422: );
5423: @rolecodes = ('cm');
5424: my $spec=$$role.'.'.$$where;
5425: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5426: if ($$role =~ /^cr\//) {
5427: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
5428: push(@rolecodes,'cr');
5429: } elsif ($$role eq 'gr') {
5430: push(@rolecodes,$$role);
5431: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5432: $env{'user.name'});
5433: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
5434: (undef,my $group_privs) = split(/\//,$trole);
5435: $group_privs = &unescape($group_privs);
5436: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
5437: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
5438: &get_groups_roles($tdomain,$trest,
5439: \%course_roles,\@rolecodes,
5440: \%groups_roles);
5441: } else {
5442: push(@rolecodes,$$role);
5443: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5444: }
5445: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
5446: &appenv(\%userroles,\@rolecodes);
5447: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5448: }
5449: }
5450: $$tstatus = 'is';
5451: }
5452: }
5453: if ($$tend) {
5454: if ($$tend<$update) {
5455: $$tstatus='expired';
5456: } elsif ($$tend<$now) {
5457: $$tstatus='will_not';
5458: }
5459: }
5460: }
5461: }
5462: }
5463:
5464: sub get_groups_roles {
5465: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5466: return unless((ref($cdom_courseroles) eq 'HASH') &&
5467: (ref($rolecodes) eq 'ARRAY') &&
5468: (ref($groups_roles) eq 'HASH'));
5469: if (keys(%{$cdom_courseroles}) > 0) {
5470: my ($cnum) = ($rest =~ /^($match_courseid)/);
5471: if ($cdom ne '' && $cnum ne '') {
5472: foreach my $key (keys(%{$cdom_courseroles})) {
5473: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5474: my $crsrole = $1;
5475: my $crssec = $2;
5476: if ($crsrole =~ /^cr/) {
5477: unless (grep(/^cr$/,@{$rolecodes})) {
5478: push(@{$rolecodes},'cr');
5479: }
5480: } else {
5481: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5482: push(@{$rolecodes},$crsrole);
5483: }
5484: }
5485: my $rolekey = "$crsrole./$cdom/$cnum";
5486: if ($crssec ne '') {
5487: $rolekey .= "/$crssec";
5488: }
5489: $rolekey .= './';
5490: $groups_roles->{$rolekey} = $rolecodes;
5491: }
5492: }
5493: }
5494: }
5495: return;
5496: }
5497:
5498: sub delete_env_groupprivs {
5499: my ($where,$courseroles,$possroles) = @_;
5500: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5501: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5502: unless (ref($courseroles->{$udom}) eq 'HASH') {
5503: %{$courseroles->{$udom}} =
5504: &get_my_roles('','','userroles',['active'],
5505: $possroles,[$udom],1);
5506: }
5507: if (ref($courseroles->{$udom}) eq 'HASH') {
5508: foreach my $item (keys(%{$courseroles->{$udom}})) {
5509: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5510: my $area = '/'.$cdom.'/'.$cnum;
5511: my $privkey = "user.priv.$crsrole.$area";
5512: if ($crssec ne '') {
5513: $privkey .= '/'.$crssec;
5514: }
5515: $privkey .= ".$area/$group";
5516: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5517: }
5518: }
5519: return;
5520: }
5521:
5522: sub check_adhoc_privs {
5523: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
5524: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
5525: my $setprivs;
5526: if ($env{$cckey}) {
5527: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
5528: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
5529: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
5530: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5531: $setprivs = 1;
5532: }
5533: } else {
5534: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5535: $setprivs = 1;
5536: }
5537: return $setprivs;
5538: }
5539:
5540: sub set_adhoc_privileges {
5541: # role can be cc or ca
5542: my ($dcdom,$pickedcourse,$role,$caller) = @_;
5543: my $area = '/'.$dcdom.'/'.$pickedcourse;
5544: my $spec = $role.'.'.$area;
5545: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
5546: $env{'user.name'},1);
5547: my %ccrole = ();
5548: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5549: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5550: &appenv(\%userroles,[$role,'cm']);
5551: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5552: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5553: &appenv( {'request.role' => $spec,
5554: 'request.role.domain' => $dcdom,
5555: 'request.course.sec' => ''
5556: }
5557: );
5558: my $tadv=0;
5559: if (&allowed('adv') eq 'F') { $tadv=1; }
5560: &appenv({'request.role.adv' => $tadv});
5561: }
5562: }
5563:
5564: # --------------------------------------------------------------- get interface
5565:
5566: sub get {
5567: my ($namespace,$storearr,$udomain,$uname)=@_;
5568: my $items='';
5569: foreach my $item (@$storearr) {
5570: $items.=&escape($item).'&';
5571: }
5572: $items=~s/\&$//;
5573: if (!$udomain) { $udomain=$env{'user.domain'}; }
5574: if (!$uname) { $uname=$env{'user.name'}; }
5575: my $uhome=&homeserver($uname,$udomain);
5576:
5577: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
5578: my @pairs=split(/\&/,$rep);
5579: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5580: return @pairs;
5581: }
5582: my %returnhash=();
5583: my $i=0;
5584: foreach my $item (@$storearr) {
5585: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5586: $i++;
5587: }
5588: return %returnhash;
5589: }
5590:
5591: # --------------------------------------------------------------- del interface
5592:
5593: sub del {
5594: my ($namespace,$storearr,$udomain,$uname)=@_;
5595: my $items='';
5596: foreach my $item (@$storearr) {
5597: $items.=&escape($item).'&';
5598: }
5599:
5600: $items=~s/\&$//;
5601: if (!$udomain) { $udomain=$env{'user.domain'}; }
5602: if (!$uname) { $uname=$env{'user.name'}; }
5603: my $uhome=&homeserver($uname,$udomain);
5604: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
5605: }
5606:
5607: # -------------------------------------------------------------- dump interface
5608:
5609: sub unserialize {
5610: my ($rep, $escapedkeys) = @_;
5611:
5612: return {} if $rep =~ /^error/;
5613:
5614: my %returnhash=();
5615: foreach my $item (split(/\&/,$rep)) {
5616: my ($key, $value) = split(/=/, $item, 2);
5617: $key = unescape($key) unless $escapedkeys;
5618: next if $key =~ /^error: 2 /;
5619: $returnhash{$key} = &thaw_unescape($value);
5620: }
5621: #return %returnhash;
5622: return \%returnhash;
5623: }
5624:
5625: # see Lond::dump_with_regexp
5626: # if $escapedkeys hash keys won't get unescaped.
5627: sub dump {
5628: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
5629: if (!$udomain) { $udomain=$env{'user.domain'}; }
5630: if (!$uname) { $uname=$env{'user.name'}; }
5631: my $uhome=&homeserver($uname,$udomain);
5632:
5633: if ($regexp) {
5634: $regexp=&escape($regexp);
5635: } else {
5636: $regexp='.';
5637: }
5638: if (grep { $_ eq $uhome } current_machine_ids()) {
5639: # user is hosted on this machine
5640: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
5641: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
5642: return %{unserialize($reply, $escapedkeys)};
5643: }
5644: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
5645: my @pairs=split(/\&/,$rep);
5646: my %returnhash=();
5647: if (!($rep =~ /^error/ )) {
5648: foreach my $item (@pairs) {
5649: my ($key,$value)=split(/=/,$item,2);
5650: $key = unescape($key) unless $escapedkeys;
5651: #$key = &unescape($key);
5652: next if ($key =~ /^error: 2 /);
5653: $returnhash{$key}=&thaw_unescape($value);
5654: }
5655: }
5656: return %returnhash;
5657: }
5658:
5659:
5660: # --------------------------------------------------------- dumpstore interface
5661:
5662: sub dumpstore {
5663: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
5664: # same as dump but keys must be escaped. They may contain colon separated
5665: # lists of values that may themself contain colons (e.g. symbs).
5666: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
5667: }
5668:
5669: # -------------------------------------------------------------- keys interface
5670:
5671: sub getkeys {
5672: my ($namespace,$udomain,$uname)=@_;
5673: if (!$udomain) { $udomain=$env{'user.domain'}; }
5674: if (!$uname) { $uname=$env{'user.name'}; }
5675: my $uhome=&homeserver($uname,$udomain);
5676: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5677: my @keyarray=();
5678: foreach my $key (split(/\&/,$rep)) {
5679: next if ($key =~ /^error: 2 /);
5680: push(@keyarray,&unescape($key));
5681: }
5682: return @keyarray;
5683: }
5684:
5685: # --------------------------------------------------------------- currentdump
5686: sub currentdump {
5687: my ($courseid,$sdom,$sname)=@_;
5688: $courseid = $env{'request.course.id'} if (! defined($courseid));
5689: $sdom = $env{'user.domain'} if (! defined($sdom));
5690: $sname = $env{'user.name'} if (! defined($sname));
5691: my $uhome = &homeserver($sname,$sdom);
5692: my $rep;
5693:
5694: if (grep { $_ eq $uhome } current_machine_ids()) {
5695: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
5696: $courseid)));
5697: } else {
5698: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5699: }
5700:
5701: return if ($rep =~ /^(error:|no_such_host)/);
5702: #
5703: my %returnhash=();
5704: #
5705: if ($rep eq "unknown_cmd") {
5706: # an old lond will not know currentdump
5707: # Do a dump and make it look like a currentdump
5708: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
5709: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5710: my %hash = @tmp;
5711: @tmp=();
5712: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
5713: } else {
5714: my @pairs=split(/\&/,$rep);
5715: foreach my $pair (@pairs) {
5716: my ($key,$value)=split(/=/,$pair,2);
5717: my ($symb,$param) = split(/:/,$key);
5718: $returnhash{&unescape($symb)}->{&unescape($param)} =
5719: &thaw_unescape($value);
5720: }
5721: }
5722: return %returnhash;
5723: }
5724:
5725: sub convert_dump_to_currentdump{
5726: my %hash = %{shift()};
5727: my %returnhash;
5728: # Code ripped from lond, essentially. The only difference
5729: # here is the unescaping done by lonnet::dump(). Conceivably
5730: # we might run in to problems with parameter names =~ /^v\./
5731: while (my ($key,$value) = each(%hash)) {
5732: my ($v,$symb,$param) = split(/:/,$key);
5733: $symb = &unescape($symb);
5734: $param = &unescape($param);
5735: next if ($v eq 'version' || $symb eq 'keys');
5736: next if (exists($returnhash{$symb}) &&
5737: exists($returnhash{$symb}->{$param}) &&
5738: $returnhash{$symb}->{'v.'.$param} > $v);
5739: $returnhash{$symb}->{$param}=$value;
5740: $returnhash{$symb}->{'v.'.$param}=$v;
5741: }
5742: #
5743: # Remove all of the keys in the hashes which keep track of
5744: # the version of the parameter.
5745: while (my ($symb,$param_hash) = each(%returnhash)) {
5746: # use a foreach because we are going to delete from the hash.
5747: foreach my $key (keys(%$param_hash)) {
5748: delete($param_hash->{$key}) if ($key =~ /^v\./);
5749: }
5750: }
5751: return \%returnhash;
5752: }
5753:
5754: # ------------------------------------------------------ critical inc interface
5755:
5756: sub cinc {
5757: return &inc(@_,'critical');
5758: }
5759:
5760: # --------------------------------------------------------------- inc interface
5761:
5762: sub inc {
5763: my ($namespace,$store,$udomain,$uname,$critical) = @_;
5764: if (!$udomain) { $udomain=$env{'user.domain'}; }
5765: if (!$uname) { $uname=$env{'user.name'}; }
5766: my $uhome=&homeserver($uname,$udomain);
5767: my $items='';
5768: if (! ref($store)) {
5769: # got a single value, so use that instead
5770: $items = &escape($store).'=&';
5771: } elsif (ref($store) eq 'SCALAR') {
5772: $items = &escape($$store).'=&';
5773: } elsif (ref($store) eq 'ARRAY') {
5774: $items = join('=&',map {&escape($_);} @{$store});
5775: } elsif (ref($store) eq 'HASH') {
5776: while (my($key,$value) = each(%{$store})) {
5777: $items.= &escape($key).'='.&escape($value).'&';
5778: }
5779: }
5780: $items=~s/\&$//;
5781: if ($critical) {
5782: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5783: } else {
5784: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5785: }
5786: }
5787:
5788: # --------------------------------------------------------------- put interface
5789:
5790: sub put {
5791: my ($namespace,$storehash,$udomain,$uname)=@_;
5792: if (!$udomain) { $udomain=$env{'user.domain'}; }
5793: if (!$uname) { $uname=$env{'user.name'}; }
5794: my $uhome=&homeserver($uname,$udomain);
5795: my $items='';
5796: foreach my $item (keys(%$storehash)) {
5797: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5798: }
5799: $items=~s/\&$//;
5800: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5801: }
5802:
5803: # ------------------------------------------------------------ newput interface
5804:
5805: sub newput {
5806: my ($namespace,$storehash,$udomain,$uname)=@_;
5807: if (!$udomain) { $udomain=$env{'user.domain'}; }
5808: if (!$uname) { $uname=$env{'user.name'}; }
5809: my $uhome=&homeserver($uname,$udomain);
5810: my $items='';
5811: foreach my $key (keys(%$storehash)) {
5812: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5813: }
5814: $items=~s/\&$//;
5815: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5816: }
5817:
5818: # --------------------------------------------------------- putstore interface
5819:
5820: sub putstore {
5821: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
5822: if (!$udomain) { $udomain=$env{'user.domain'}; }
5823: if (!$uname) { $uname=$env{'user.name'}; }
5824: my $uhome=&homeserver($uname,$udomain);
5825: my $items='';
5826: foreach my $key (keys(%$storehash)) {
5827: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
5828: }
5829: $items=~s/\&$//;
5830: my $esc_symb=&escape($symb);
5831: my $esc_v=&escape($version);
5832: my $reply =
5833: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
5834: $uhome);
5835: if (($tolog) && ($reply eq 'ok')) {
5836: my $namevalue='';
5837: foreach my $key (keys(%{$storehash})) {
5838: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
5839: }
5840: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
5841: '&host='.&escape($perlvar{'lonHostID'}).
5842: '&version='.$esc_v.
5843: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
5844: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
5845: }
5846: if ($reply eq 'unknown_cmd') {
5847: # gfall back to way things use to be done
5848: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5849: $uname);
5850: }
5851: return $reply;
5852: }
5853:
5854: sub old_putstore {
5855: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5856: if (!$udomain) { $udomain=$env{'user.domain'}; }
5857: if (!$uname) { $uname=$env{'user.name'}; }
5858: my $uhome=&homeserver($uname,$udomain);
5859: my %newstorehash;
5860: foreach my $item (keys(%$storehash)) {
5861: my $key = $version.':'.&escape($symb).':'.$item;
5862: $newstorehash{$key} = $storehash->{$item};
5863: }
5864: my $items='';
5865: my %allitems = ();
5866: foreach my $item (keys(%newstorehash)) {
5867: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
5868: my $key = $1.':keys:'.$2;
5869: $allitems{$key} .= $3.':';
5870: }
5871: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
5872: }
5873: foreach my $item (keys(%allitems)) {
5874: $allitems{$item} =~ s/\:$//;
5875: $items.= $item.'='.$allitems{$item}.'&';
5876: }
5877: $items=~s/\&$//;
5878: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5879: }
5880:
5881: # ------------------------------------------------------ critical put interface
5882:
5883: sub cput {
5884: my ($namespace,$storehash,$udomain,$uname)=@_;
5885: if (!$udomain) { $udomain=$env{'user.domain'}; }
5886: if (!$uname) { $uname=$env{'user.name'}; }
5887: my $uhome=&homeserver($uname,$udomain);
5888: my $items='';
5889: foreach my $item (keys(%$storehash)) {
5890: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5891: }
5892: $items=~s/\&$//;
5893: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
5894: }
5895:
5896: # -------------------------------------------------------------- eget interface
5897:
5898: sub eget {
5899: my ($namespace,$storearr,$udomain,$uname)=@_;
5900: my $items='';
5901: foreach my $item (@$storearr) {
5902: $items.=&escape($item).'&';
5903: }
5904: $items=~s/\&$//;
5905: if (!$udomain) { $udomain=$env{'user.domain'}; }
5906: if (!$uname) { $uname=$env{'user.name'}; }
5907: my $uhome=&homeserver($uname,$udomain);
5908: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
5909: my @pairs=split(/\&/,$rep);
5910: my %returnhash=();
5911: my $i=0;
5912: foreach my $item (@$storearr) {
5913: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5914: $i++;
5915: }
5916: return %returnhash;
5917: }
5918:
5919: # ------------------------------------------------------------ tmpput interface
5920: sub tmpput {
5921: my ($storehash,$server,$context)=@_;
5922: my $items='';
5923: foreach my $item (keys(%$storehash)) {
5924: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5925: }
5926: $items=~s/\&$//;
5927: if (defined($context)) {
5928: $items .= ':'.&escape($context);
5929: }
5930: return &reply("tmpput:$items",$server);
5931: }
5932:
5933: # ------------------------------------------------------------ tmpget interface
5934: sub tmpget {
5935: my ($token,$server)=@_;
5936: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5937: my $rep=&reply("tmpget:$token",$server);
5938: my %returnhash;
5939: foreach my $item (split(/\&/,$rep)) {
5940: my ($key,$value)=split(/=/,$item);
5941: next if ($key =~ /^error: 2 /);
5942: $returnhash{&unescape($key)}=&thaw_unescape($value);
5943: }
5944: return %returnhash;
5945: }
5946:
5947: # ------------------------------------------------------------ tmpdel interface
5948: sub tmpdel {
5949: my ($token,$server)=@_;
5950: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5951: return &reply("tmpdel:$token",$server);
5952: }
5953:
5954: # ------------------------------------------------------------ get_timebased_id
5955:
5956: sub get_timebased_id {
5957: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
5958: $maxtries) = @_;
5959: my ($newid,$error,$dellock);
5960: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
5961: return ('','ok','invalid call to get suffix');
5962: }
5963:
5964: # set defaults for any optional args for which values were not supplied
5965: if ($who eq '') {
5966: $who = $env{'user.name'}.':'.$env{'user.domain'};
5967: }
5968: if (!$locktries) {
5969: $locktries = 3;
5970: }
5971: if (!$maxtries) {
5972: $maxtries = 10;
5973: }
5974:
5975: if (($cdom eq '') || ($cnum eq '')) {
5976: if ($env{'request.course.id'}) {
5977: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5978: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5979: }
5980: if (($cdom eq '') || ($cnum eq '')) {
5981: return ('','ok','call to get suffix not in course context');
5982: }
5983: }
5984:
5985: # construct locking item
5986: my $lockhash = {
5987: $prefix."\0".'locked_'.$keyid => $who,
5988: };
5989: my $tries = 0;
5990:
5991: # attempt to get lock on nohist_$namespace file
5992: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
5993: while (($gotlock ne 'ok') && $tries <$locktries) {
5994: $tries ++;
5995: sleep 1;
5996: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
5997: }
5998:
5999: # attempt to get unique identifier, based on current timestamp
6000: if ($gotlock eq 'ok') {
6001: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6002: my $id = time;
6003: $newid = $id;
6004: if ($idtype eq 'addcode') {
6005: $newid .= &sixnum_code();
6006: }
6007: my $idtries = 0;
6008: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6009: if ($idtype eq 'concat') {
6010: $newid = $id.$idtries;
6011: } elsif ($idtype eq 'addcode') {
6012: $newid = $newid.&sixnum_code();
6013: } else {
6014: $newid ++;
6015: }
6016: $idtries ++;
6017: }
6018: if (!exists($inuse{$prefix."\0".$newid})) {
6019: my %new_item = (
6020: $prefix."\0".$newid => $who,
6021: );
6022: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6023: $cdom,$cnum);
6024: if ($putresult ne 'ok') {
6025: undef($newid);
6026: $error = 'error saving new item: '.$putresult;
6027: }
6028: } else {
6029: undef($newid);
6030: $error = ('error: no unique suffix available for the new item ');
6031: }
6032: # remove lock
6033: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6034: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6035: } else {
6036: $error = "error: could not obtain lockfile\n";
6037: $dellock = 'ok';
6038: }
6039: return ($newid,$dellock,$error);
6040: }
6041:
6042: sub sixnum_code {
6043: my $code;
6044: for (0..6) {
6045: $code .= int( rand(9) );
6046: }
6047: return $code;
6048: }
6049:
6050: # -------------------------------------------------- portfolio access checking
6051:
6052: sub portfolio_access {
6053: my ($requrl,$clientip) = @_;
6054: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
6055: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
6056: if ($result) {
6057: my %setters;
6058: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6059: my ($startblock,$endblock) =
6060: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6061: if ($startblock && $endblock) {
6062: return 'B';
6063: }
6064: } else {
6065: my ($startblock,$endblock) =
6066: &Apache::loncommon::blockcheck(\%setters,'port');
6067: if ($startblock && $endblock) {
6068: return 'B';
6069: }
6070: }
6071: }
6072: if ($result eq 'ok') {
6073: return 'F';
6074: } elsif ($result =~ /^[^:]+:guest_/) {
6075: return 'A';
6076: }
6077: return '';
6078: }
6079:
6080: sub get_portfolio_access {
6081: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
6082:
6083: if (!ref($access_hash)) {
6084: my $current_perms = &get_portfile_permissions($udom,$unum);
6085: my %access_controls = &get_access_controls($current_perms,$group,
6086: $file_name);
6087: $access_hash = $access_controls{$file_name};
6088: }
6089:
6090: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
6091: my $now = time;
6092: if (ref($access_hash) eq 'HASH') {
6093: foreach my $key (keys(%{$access_hash})) {
6094: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6095: if ($start > $now) {
6096: next;
6097: }
6098: if ($end && $end<$now) {
6099: next;
6100: }
6101: if ($scope eq 'public') {
6102: $public = $key;
6103: last;
6104: } elsif ($scope eq 'guest') {
6105: $guest = $key;
6106: } elsif ($scope eq 'domains') {
6107: push(@domains,$key);
6108: } elsif ($scope eq 'users') {
6109: push(@users,$key);
6110: } elsif ($scope eq 'course') {
6111: push(@courses,$key);
6112: } elsif ($scope eq 'group') {
6113: push(@groups,$key);
6114: } elsif ($scope eq 'ip') {
6115: push(@ips,$key);
6116: }
6117: }
6118: if ($public) {
6119: return 'ok';
6120: } elsif (@ips > 0) {
6121: my $allowed;
6122: foreach my $ipkey (@ips) {
6123: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6124: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6125: $allowed = 1;
6126: last;
6127: }
6128: }
6129: }
6130: if ($allowed) {
6131: return 'ok';
6132: }
6133: }
6134: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6135: if ($guest) {
6136: return $guest;
6137: }
6138: } else {
6139: if (@domains > 0) {
6140: foreach my $domkey (@domains) {
6141: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6142: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6143: return 'ok';
6144: }
6145: }
6146: }
6147: }
6148: if (@users > 0) {
6149: foreach my $userkey (@users) {
6150: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6151: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6152: if (ref($item) eq 'HASH') {
6153: if (($item->{'uname'} eq $env{'user.name'}) &&
6154: ($item->{'udom'} eq $env{'user.domain'})) {
6155: return 'ok';
6156: }
6157: }
6158: }
6159: }
6160: }
6161: }
6162: my %roleshash;
6163: my @courses_and_groups = @courses;
6164: push(@courses_and_groups,@groups);
6165: if (@courses_and_groups > 0) {
6166: my (%allgroups,%allroles);
6167: my ($start,$end,$role,$sec,$group);
6168: foreach my $envkey (%env) {
6169: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
6170: my $cid = $2.'_'.$3;
6171: if ($1 eq 'gr') {
6172: $group = $4;
6173: $allgroups{$cid}{$group} = $env{$envkey};
6174: } else {
6175: if ($4 eq '') {
6176: $sec = 'none';
6177: } else {
6178: $sec = $4;
6179: }
6180: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6181: }
6182: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
6183: my $cid = $2.'_'.$3;
6184: if ($4 eq '') {
6185: $sec = 'none';
6186: } else {
6187: $sec = $4;
6188: }
6189: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6190: }
6191: }
6192: if (keys(%allroles) == 0) {
6193: return;
6194: }
6195: foreach my $key (@courses_and_groups) {
6196: my %content = %{$$access_hash{$key}};
6197: my $cnum = $content{'number'};
6198: my $cdom = $content{'domain'};
6199: my $cid = $cdom.'_'.$cnum;
6200: if (!exists($allroles{$cid})) {
6201: next;
6202: }
6203: foreach my $role_id (keys(%{$content{'roles'}})) {
6204: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6205: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6206: my @status = @{$content{'roles'}{$role_id}{'access'}};
6207: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6208: foreach my $role (keys(%{$allroles{$cid}})) {
6209: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6210: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6211: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6212: if (grep/^all$/,@sections) {
6213: return 'ok';
6214: } else {
6215: if (grep/^$sec$/,@sections) {
6216: return 'ok';
6217: }
6218: }
6219: }
6220: }
6221: if (keys(%{$allgroups{$cid}}) == 0) {
6222: if (grep/^none$/,@groups) {
6223: return 'ok';
6224: }
6225: } else {
6226: if (grep/^all$/,@groups) {
6227: return 'ok';
6228: }
6229: foreach my $group (keys(%{$allgroups{$cid}})) {
6230: if (grep/^$group$/,@groups) {
6231: return 'ok';
6232: }
6233: }
6234: }
6235: }
6236: }
6237: }
6238: }
6239: }
6240: if ($guest) {
6241: return $guest;
6242: }
6243: }
6244: }
6245: return;
6246: }
6247:
6248: sub course_group_datechecker {
6249: my ($dates,$now,$status) = @_;
6250: my ($start,$end) = split(/\./,$dates);
6251: if (!$start && !$end) {
6252: return 'ok';
6253: }
6254: if (grep/^active$/,@{$status}) {
6255: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6256: return 'ok';
6257: }
6258: }
6259: if (grep/^previous$/,@{$status}) {
6260: if ($end > $now ) {
6261: return 'ok';
6262: }
6263: }
6264: if (grep/^future$/,@{$status}) {
6265: if ($start > $now) {
6266: return 'ok';
6267: }
6268: }
6269: return;
6270: }
6271:
6272: sub parse_portfolio_url {
6273: my ($url) = @_;
6274:
6275: my ($type,$udom,$unum,$group,$file_name);
6276:
6277: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
6278: $type = 1;
6279: $udom = $1;
6280: $unum = $2;
6281: $file_name = $3;
6282: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
6283: $type = 2;
6284: $udom = $1;
6285: $unum = $2;
6286: $group = $3;
6287: $file_name = $3.'/'.$4;
6288: }
6289: if (wantarray) {
6290: return ($type,$udom,$unum,$file_name,$group);
6291: }
6292: return $type;
6293: }
6294:
6295: sub is_portfolio_url {
6296: my ($url) = @_;
6297: return scalar(&parse_portfolio_url($url));
6298: }
6299:
6300: sub is_portfolio_file {
6301: my ($file) = @_;
6302: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
6303: return 1;
6304: }
6305: return;
6306: }
6307:
6308: sub usertools_access {
6309: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
6310: my ($access,%tools);
6311: if ($context eq '') {
6312: $context = 'tools';
6313: }
6314: if ($context eq 'requestcourses') {
6315: %tools = (
6316: official => 1,
6317: unofficial => 1,
6318: community => 1,
6319: textbook => 1,
6320: );
6321: } elsif ($context eq 'requestauthor') {
6322: %tools = (
6323: requestauthor => 1,
6324: );
6325: } else {
6326: %tools = (
6327: aboutme => 1,
6328: blog => 1,
6329: webdav => 1,
6330: portfolio => 1,
6331: );
6332: }
6333: return if (!defined($tools{$tool}));
6334:
6335: if (($udom eq '') || ($uname eq '')) {
6336: $udom = $env{'user.domain'};
6337: $uname = $env{'user.name'};
6338: }
6339:
6340: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6341: if ($action ne 'reload') {
6342: if ($context eq 'requestcourses') {
6343: return $env{'environment.canrequest.'.$tool};
6344: } elsif ($context eq 'requestauthor') {
6345: return $env{'environment.canrequest.author'};
6346: } else {
6347: return $env{'environment.availabletools.'.$tool};
6348: }
6349: }
6350: }
6351:
6352: my ($toolstatus,$inststatus,$envkey);
6353: if ($context eq 'requestauthor') {
6354: $envkey = $context;
6355: } else {
6356: $envkey = $context.'.'.$tool;
6357: }
6358:
6359: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6360: ($action ne 'reload')) {
6361: $toolstatus = $env{'environment.'.$envkey};
6362: $inststatus = $env{'environment.inststatus'};
6363: } else {
6364: if (ref($userenvref) eq 'HASH') {
6365: $toolstatus = $userenvref->{$envkey};
6366: $inststatus = $userenvref->{'inststatus'};
6367: } else {
6368: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6369: $toolstatus = $userenv{$envkey};
6370: $inststatus = $userenv{'inststatus'};
6371: }
6372: }
6373:
6374: if ($toolstatus ne '') {
6375: if ($toolstatus) {
6376: $access = 1;
6377: } else {
6378: $access = 0;
6379: }
6380: return $access;
6381: }
6382:
6383: my ($is_adv,%domdef);
6384: if (ref($is_advref) eq 'HASH') {
6385: $is_adv = $is_advref->{'is_adv'};
6386: } else {
6387: $is_adv = &is_advanced_user($udom,$uname);
6388: }
6389: if (ref($domdefref) eq 'HASH') {
6390: %domdef = %{$domdefref};
6391: } else {
6392: %domdef = &get_domain_defaults($udom);
6393: }
6394: if (ref($domdef{$tool}) eq 'HASH') {
6395: if ($is_adv) {
6396: if ($domdef{$tool}{'_LC_adv'} ne '') {
6397: if ($domdef{$tool}{'_LC_adv'}) {
6398: $access = 1;
6399: } else {
6400: $access = 0;
6401: }
6402: return $access;
6403: }
6404: }
6405: if ($inststatus ne '') {
6406: my ($hasaccess,$hasnoaccess);
6407: foreach my $affiliation (split(/:/,$inststatus)) {
6408: if ($domdef{$tool}{$affiliation} ne '') {
6409: if ($domdef{$tool}{$affiliation}) {
6410: $hasaccess = 1;
6411: } else {
6412: $hasnoaccess = 1;
6413: }
6414: }
6415: }
6416: if ($hasaccess || $hasnoaccess) {
6417: if ($hasaccess) {
6418: $access = 1;
6419: } elsif ($hasnoaccess) {
6420: $access = 0;
6421: }
6422: return $access;
6423: }
6424: } else {
6425: if ($domdef{$tool}{'default'} ne '') {
6426: if ($domdef{$tool}{'default'}) {
6427: $access = 1;
6428: } elsif ($domdef{$tool}{'default'} == 0) {
6429: $access = 0;
6430: }
6431: return $access;
6432: }
6433: }
6434: } else {
6435: if (($context eq 'tools') && ($tool ne 'webdav')) {
6436: $access = 1;
6437: } else {
6438: $access = 0;
6439: }
6440: return $access;
6441: }
6442: }
6443:
6444: sub is_course_owner {
6445: my ($cdom,$cnum,$udom,$uname) = @_;
6446: if (($udom eq '') || ($uname eq '')) {
6447: $udom = $env{'user.domain'};
6448: $uname = $env{'user.name'};
6449: }
6450: unless (($udom eq '') || ($uname eq '')) {
6451: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6452: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6453: return 1;
6454: } else {
6455: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6456: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6457: return 1;
6458: }
6459: }
6460: }
6461: }
6462: return;
6463: }
6464:
6465: sub is_advanced_user {
6466: my ($udom,$uname) = @_;
6467: if ($udom ne '' && $uname ne '') {
6468: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6469: if (wantarray) {
6470: return ($env{'user.adv'},$env{'user.author'});
6471: } else {
6472: return $env{'user.adv'};
6473: }
6474: }
6475: }
6476: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6477: my %allroles;
6478: my ($is_adv,$is_author);
6479: foreach my $role (keys(%roleshash)) {
6480: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6481: my $area = '/'.$tdomain.'/'.$trest;
6482: if ($sec ne '') {
6483: $area .= '/'.$sec;
6484: }
6485: if (($area ne '') && ($trole ne '')) {
6486: my $spec=$trole.'.'.$area;
6487: if ($trole =~ /^cr\//) {
6488: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6489: } elsif ($trole ne 'gr') {
6490: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6491: }
6492: if ($trole eq 'au') {
6493: $is_author = 1;
6494: }
6495: }
6496: }
6497: foreach my $role (keys(%allroles)) {
6498: last if ($is_adv);
6499: foreach my $item (split(/:/,$allroles{$role})) {
6500: if ($item ne '') {
6501: my ($privilege,$restrictions)=split(/&/,$item);
6502: if ($privilege eq 'adv') {
6503: $is_adv = 1;
6504: last;
6505: }
6506: }
6507: }
6508: }
6509: if (wantarray) {
6510: return ($is_adv,$is_author);
6511: }
6512: return $is_adv;
6513: }
6514:
6515: sub check_can_request {
6516: my ($dom,$can_request,$request_domains) = @_;
6517: my $canreq = 0;
6518: my ($types,$typename) = &Apache::loncommon::course_types();
6519: my @options = ('approval','validate','autolimit');
6520: my $optregex = join('|',@options);
6521: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6522: foreach my $type (@{$types}) {
6523: if (&usertools_access($env{'user.name'},
6524: $env{'user.domain'},
6525: $type,undef,'requestcourses')) {
6526: $canreq ++;
6527: if (ref($request_domains) eq 'HASH') {
6528: push(@{$request_domains->{$type}},$env{'user.domain'});
6529: }
6530: if ($dom eq $env{'user.domain'}) {
6531: $can_request->{$type} = 1;
6532: }
6533: }
6534: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
6535: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
6536: if (@curr > 0) {
6537: foreach my $item (@curr) {
6538: if (ref($request_domains) eq 'HASH') {
6539: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
6540: if ($otherdom ne '') {
6541: if (ref($request_domains->{$type}) eq 'ARRAY') {
6542: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
6543: push(@{$request_domains->{$type}},$otherdom);
6544: }
6545: } else {
6546: push(@{$request_domains->{$type}},$otherdom);
6547: }
6548: }
6549: }
6550: }
6551: unless($dom eq $env{'user.domain'}) {
6552: $canreq ++;
6553: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
6554: $can_request->{$type} = 1;
6555: }
6556: }
6557: }
6558: }
6559: }
6560: }
6561: return $canreq;
6562: }
6563:
6564: # ---------------------------------------------- Custom access rule evaluation
6565:
6566: sub customaccess {
6567: my ($priv,$uri)=@_;
6568: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
6569: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
6570: $udom = &LONCAPA::clean_domain($udom);
6571: $ucrs = &LONCAPA::clean_username($ucrs);
6572: my $access=0;
6573: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
6574: my ($effect,$realm,$role,$type)=split(/\:/,$right);
6575: if ($type eq 'user') {
6576: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6577: my ($tdom,$tuname)=split(m{/},$scope);
6578: if ($tdom) {
6579: if ($tdom ne $env{'user.domain'}) { next; }
6580: }
6581: if ($tuname) {
6582: if ($tuname ne $env{'user.name'}) { next; }
6583: }
6584: $access=($effect eq 'allow');
6585: last;
6586: }
6587: } else {
6588: if ($role) {
6589: if ($role ne $urole) { next; }
6590: }
6591: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6592: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6593: if ($tdom) {
6594: if ($tdom ne $udom) { next; }
6595: }
6596: if ($tcrs) {
6597: if ($tcrs ne $ucrs) { next; }
6598: }
6599: if ($tsec) {
6600: if ($tsec ne $usec) { next; }
6601: }
6602: $access=($effect eq 'allow');
6603: last;
6604: }
6605: if ($realm eq '' && $role eq '') {
6606: $access=($effect eq 'allow');
6607: }
6608: }
6609: }
6610: return $access;
6611: }
6612:
6613: # ------------------------------------------------- Check for a user privilege
6614:
6615: sub allowed {
6616: my ($priv,$uri,$symb,$role,$clientip)=@_;
6617: my $ver_orguri=$uri;
6618: $uri=&deversion($uri);
6619: my $orguri=$uri;
6620: $uri=&declutter($uri);
6621:
6622: if ($priv eq 'evb') {
6623: # Evade communication block restrictions for specified role in a course
6624: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6625: return $1;
6626: } else {
6627: return;
6628: }
6629: }
6630:
6631: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
6632: # Free bre access to adm and meta resources
6633: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
6634: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6635: && ($priv eq 'bre')) {
6636: return 'F';
6637: }
6638:
6639: # Free bre access to user's own portfolio contents
6640: my ($space,$domain,$name,@dir)=split('/',$uri);
6641: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
6642: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
6643: my %setters;
6644: my ($startblock,$endblock) =
6645: &Apache::loncommon::blockcheck(\%setters,'port');
6646: if ($startblock && $endblock) {
6647: return 'B';
6648: } else {
6649: return 'F';
6650: }
6651: }
6652:
6653: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
6654: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6655: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6656: if (exists($env{'request.course.id'})) {
6657: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6658: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6659: if (($domain eq $cdom) && ($name eq $cnum)) {
6660: my $courseprivid=$env{'request.course.id'};
6661: $courseprivid=~s/\_/\//;
6662: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6663: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6664: return $1;
6665: } else {
6666: if ($env{'request.course.sec'}) {
6667: $courseprivid.='/'.$env{'request.course.sec'};
6668: }
6669: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6670: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6671: return $2;
6672: }
6673: }
6674: }
6675: }
6676: }
6677:
6678: # Free bre to public access
6679:
6680: if ($priv eq 'bre') {
6681: my $copyright=&metadata($uri,'copyright');
6682: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
6683: return 'F';
6684: }
6685: if ($copyright eq 'priv') {
6686: $uri=~/([^\/]+)\/([^\/]+)\//;
6687: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
6688: return '';
6689: }
6690: }
6691: if ($copyright eq 'domain') {
6692: $uri=~/([^\/]+)\/([^\/]+)\//;
6693: unless (($env{'user.domain'} eq $1) ||
6694: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
6695: return '';
6696: }
6697: }
6698: if ($env{'request.role'}=~ /li\.\//) {
6699: # Library role, so allow browsing of resources in this domain.
6700: return 'F';
6701: }
6702: if ($copyright eq 'custom') {
6703: unless (&customaccess($priv,$uri)) { return ''; }
6704: }
6705: }
6706: # Domain coordinator is trying to create a course
6707: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
6708: # uri is the requested domain in this case.
6709: # comparison to 'request.role.domain' shows if the user has selected
6710: # a role of dc for the domain in question.
6711: return 'F' if ($uri eq $env{'request.role.domain'});
6712: }
6713:
6714: my $thisallowed='';
6715: my $statecond=0;
6716: my $courseprivid='';
6717:
6718: my $ownaccess;
6719: # Community Coordinator or Assistant Co-author browsing resource space.
6720: if (($priv eq 'bro') && ($env{'user.author'})) {
6721: if ($uri eq '') {
6722: $ownaccess = 1;
6723: } else {
6724: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6725: my $udom = $env{'user.domain'};
6726: my $uname = $env{'user.name'};
6727: if ($uri =~ m{^\Q$udom\E/?$}) {
6728: $ownaccess = 1;
6729: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
6730: unless ($uri =~ m{\.\./}) {
6731: $ownaccess = 1;
6732: }
6733: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6734: my $now = time;
6735: if ($uri =~ m{^([^/]+)/?$}) {
6736: my $adom = $1;
6737: foreach my $key (keys(%env)) {
6738: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
6739: my ($start,$end) = split('.',$env{$key});
6740: if (($now >= $start) && (!$end || $end < $now)) {
6741: $ownaccess = 1;
6742: last;
6743: }
6744: }
6745: }
6746: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6747: my $adom = $1;
6748: my $aname = $2;
6749: foreach my $role ('ca','aa') {
6750: if ($env{"user.role.$role./$adom/$aname"}) {
6751: my ($start,$end) =
6752: split('.',$env{"user.role.$role./$adom/$aname"});
6753: if (($now >= $start) && (!$end || $end < $now)) {
6754: $ownaccess = 1;
6755: last;
6756: }
6757: }
6758: }
6759: }
6760: }
6761: }
6762: }
6763: }
6764:
6765: # Course
6766:
6767: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
6768: unless (($priv eq 'bro') && (!$ownaccess)) {
6769: $thisallowed.=$1;
6770: }
6771: }
6772:
6773: # Domain
6774:
6775: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
6776: =~/\Q$priv\E\&([^\:]*)/) {
6777: unless (($priv eq 'bro') && (!$ownaccess)) {
6778: $thisallowed.=$1;
6779: }
6780: }
6781:
6782: # User who is not author or co-author might still be able to edit
6783: # resource of an author in the domain (e.g., if Domain Coordinator).
6784: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
6785: (&allowed('mdc',$env{'request.course.id'}))) {
6786: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
6787: $thisallowed.=$1;
6788: }
6789: }
6790:
6791: # Course: uri itself is a course
6792: my $courseuri=$uri;
6793: $courseuri=~s/\_(\d)/\/$1/;
6794: $courseuri=~s/^([^\/])/\/$1/;
6795:
6796: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
6797: =~/\Q$priv\E\&([^\:]*)/) {
6798: unless (($priv eq 'bro') && (!$ownaccess)) {
6799: $thisallowed.=$1;
6800: }
6801: }
6802:
6803: # URI is an uploaded document for this course, default permissions don't matter
6804: # not allowing 'edit' access (editupload) to uploaded course docs
6805: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
6806: $thisallowed='';
6807: my ($match)=&is_on_map($uri);
6808: if ($match) {
6809: if ($env{'user.priv.'.$env{'request.role'}.'./'}
6810: =~/\Q$priv\E\&([^\:]*)/) {
6811: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6812: if (@blockers > 0) {
6813: $thisallowed = 'B';
6814: } else {
6815: $thisallowed.=$1;
6816: }
6817: }
6818: } else {
6819: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
6820: if ($refuri) {
6821: if ($refuri =~ m|^/adm/|) {
6822: $thisallowed='F';
6823: } else {
6824: $refuri=&declutter($refuri);
6825: my ($match) = &is_on_map($refuri);
6826: if ($match) {
6827: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6828: if (@blockers > 0) {
6829: $thisallowed = 'B';
6830: } else {
6831: $thisallowed='F';
6832: }
6833: }
6834: }
6835: }
6836: }
6837: }
6838:
6839: if ($priv eq 'bre'
6840: && $thisallowed ne 'F'
6841: && $thisallowed ne '2'
6842: && &is_portfolio_url($uri)) {
6843: $thisallowed = &portfolio_access($uri,$clientip);
6844: }
6845:
6846: # Full access at system, domain or course-wide level? Exit.
6847: if ($thisallowed=~/F/) {
6848: return 'F';
6849: }
6850:
6851: # If this is generating or modifying users, exit with special codes
6852:
6853: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6854: if (($priv eq 'cca') || ($priv eq 'caa')) {
6855: my ($audom,$auname)=split('/',$uri);
6856: # no author name given, so this just checks on the general right to make a co-author in this domain
6857: unless ($auname) { return $thisallowed; }
6858: # an author name is given, so we are about to actually make a co-author for a certain account
6859: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6860: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6861: ($audom ne $env{'request.role.domain'}))) { return ''; }
6862: }
6863: return $thisallowed;
6864: }
6865: #
6866: # Gathered so far: system, domain and course wide privileges
6867: #
6868: # Course: See if uri or referer is an individual resource that is part of
6869: # the course
6870:
6871: if ($env{'request.course.id'}) {
6872:
6873: $courseprivid=$env{'request.course.id'};
6874: if ($env{'request.course.sec'}) {
6875: $courseprivid.='/'.$env{'request.course.sec'};
6876: }
6877: $courseprivid=~s/\_/\//;
6878: my $checkreferer=1;
6879: my ($match,$cond)=&is_on_map($uri);
6880: if ($match) {
6881: $statecond=$cond;
6882: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6883: =~/\Q$priv\E\&([^\:]*)/) {
6884: my $value = $1;
6885: if ($priv eq 'bre') {
6886: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6887: if (@blockers > 0) {
6888: $thisallowed = 'B';
6889: } else {
6890: $thisallowed.=$value;
6891: }
6892: } else {
6893: $thisallowed.=$value;
6894: }
6895: $checkreferer=0;
6896: }
6897: }
6898:
6899: if ($checkreferer) {
6900: my $refuri=$env{'httpref.'.$orguri};
6901: unless ($refuri) {
6902: foreach my $key (keys(%env)) {
6903: if ($key=~/^httpref\..*\*/) {
6904: my $pattern=$key;
6905: $pattern=~s/^httpref\.\/res\///;
6906: $pattern=~s/\*/\[\^\/\]\+/g;
6907: $pattern=~s/\//\\\//g;
6908: if ($orguri=~/$pattern/) {
6909: $refuri=$env{$key};
6910: }
6911: }
6912: }
6913: }
6914:
6915: if ($refuri) {
6916: $refuri=&declutter($refuri);
6917: my ($match,$cond)=&is_on_map($refuri);
6918: if ($match) {
6919: my $refstatecond=$cond;
6920: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6921: =~/\Q$priv\E\&([^\:]*)/) {
6922: my $value = $1;
6923: if ($priv eq 'bre') {
6924: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6925: if (@blockers > 0) {
6926: $thisallowed = 'B';
6927: } else {
6928: $thisallowed.=$value;
6929: }
6930: } else {
6931: $thisallowed.=$value;
6932: }
6933: $uri=$refuri;
6934: $statecond=$refstatecond;
6935: }
6936: }
6937: }
6938: }
6939: }
6940:
6941: #
6942: # Gathered now: all privileges that could apply, and condition number
6943: #
6944: #
6945: # Full or no access?
6946: #
6947:
6948: if ($thisallowed=~/F/) {
6949: return 'F';
6950: }
6951:
6952: unless ($thisallowed) {
6953: return '';
6954: }
6955:
6956: # Restrictions exist, deal with them
6957: #
6958: # C:according to course preferences
6959: # R:according to resource settings
6960: # L:unless locked
6961: # X:according to user session state
6962: #
6963:
6964: # Possibly locked functionality, check all courses
6965: # Locks might take effect only after 10 minutes cache expiration for other
6966: # courses, and 2 minutes for current course
6967:
6968: my $envkey;
6969: if ($thisallowed=~/L/) {
6970: foreach $envkey (keys(%env)) {
6971: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6972: my $courseid=$2;
6973: my $roleid=$1.'.'.$2;
6974: $courseid=~s/^\///;
6975: my $expiretime=600;
6976: if ($env{'request.role'} eq $roleid) {
6977: $expiretime=120;
6978: }
6979: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6980: my $prefix='course.'.$cdom.'_'.$cnum.'.';
6981: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
6982: &coursedescription($courseid,{'freshen_cache' => 1});
6983: }
6984: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6985: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6986: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6987: &log($env{'user.domain'},$env{'user.name'},
6988: $env{'user.home'},
6989: 'Locked by res: '.$priv.' for '.$uri.' due to '.
6990: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6991: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6992: return '';
6993: }
6994: }
6995: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6996: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6997: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6998: &log($env{'user.domain'},$env{'user.name'},
6999: $env{'user.home'},
7000: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
7001: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7002: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7003: return '';
7004: }
7005: }
7006: }
7007: }
7008: }
7009:
7010: #
7011: # Rest of the restrictions depend on selected course
7012: #
7013:
7014: unless ($env{'request.course.id'}) {
7015: if ($thisallowed eq 'A') {
7016: return 'A';
7017: } elsif ($thisallowed eq 'B') {
7018: return 'B';
7019: } else {
7020: return '1';
7021: }
7022: }
7023:
7024: #
7025: # Now user is definitely in a course
7026: #
7027:
7028:
7029: # Course preferences
7030:
7031: if ($thisallowed=~/C/) {
7032: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7033: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7034: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
7035: =~/\Q$rolecode\E/) {
7036: if (($priv ne 'pch') && ($priv ne 'plc')) {
7037: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7038: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7039: $env{'request.course.id'});
7040: }
7041: return '';
7042: }
7043:
7044: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
7045: =~/\Q$unamedom\E/) {
7046: if (($priv ne 'pch') && ($priv ne 'plc')) {
7047: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7048: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7049: $env{'request.course.id'});
7050: }
7051: return '';
7052: }
7053: }
7054:
7055: # Resource preferences
7056:
7057: if ($thisallowed=~/R/) {
7058: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7059: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
7060: if (($priv ne 'pch') && ($priv ne 'plc')) {
7061: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7062: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7063: }
7064: return '';
7065: }
7066: }
7067:
7068: # Restricted by state or randomout?
7069:
7070: if ($thisallowed=~/X/) {
7071: if ($env{'acc.randomout'}) {
7072: if (!$symb) { $symb=&symbread($uri,1); }
7073: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
7074: return '';
7075: }
7076: }
7077: if (&condval($statecond)) {
7078: return '2';
7079: } else {
7080: return '';
7081: }
7082: }
7083:
7084: if ($thisallowed eq 'A') {
7085: return 'A';
7086: } elsif ($thisallowed eq 'B') {
7087: return 'B';
7088: }
7089: return 'F';
7090: }
7091:
7092: # ------------------------------------------- Check construction space access
7093:
7094: sub constructaccess {
7095: my ($url,$setpriv)=@_;
7096:
7097: # We do not allow editing of previous versions of files
7098: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7099:
7100: # Get username and domain from URL
7101: my ($ownername,$ownerdomain,$ownerhome);
7102:
7103: ($ownerdomain,$ownername) =
7104: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)/});
7105:
7106: # The URL does not really point to any authorspace, forget it
7107: unless (($ownername) && ($ownerdomain)) { return ''; }
7108:
7109: # Now we need to see if the user has access to the authorspace of
7110: # $ownername at $ownerdomain
7111:
7112: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7113: # Real author for this?
7114: $ownerhome = $env{'user.home'};
7115: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7116: return ($ownername,$ownerdomain,$ownerhome);
7117: }
7118: } else {
7119: # Co-author for this?
7120: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7121: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7122: $ownerhome = &homeserver($ownername,$ownerdomain);
7123: return ($ownername,$ownerdomain,$ownerhome);
7124: }
7125: }
7126:
7127: # We don't have any access right now. If we are not possibly going to do anything about this,
7128: # we might as well leave
7129: unless ($setpriv) { return ''; }
7130:
7131: # Backdoor access?
7132: my $allowed=&allowed('eco',$ownerdomain);
7133: # Nope
7134: unless ($allowed) { return ''; }
7135: # Looks like we may have access, but could be locked by the owner of the construction space
7136: if ($allowed eq 'U') {
7137: my %blocked=&get('environment',['domcoord.author'],
7138: $ownerdomain,$ownername);
7139: # Is blocked by owner
7140: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7141: }
7142: if (($allowed eq 'F') || ($allowed eq 'U')) {
7143: # Grant temporary access
7144: my $then=$env{'user.login.time'};
7145: my $update=$env{'user.update.time'};
7146: if (!$update) { $update = $then; }
7147: my $refresh=$env{'user.refresh.time'};
7148: if (!$refresh) { $refresh = $update; }
7149: my $now = time;
7150: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7151: $now,'ca','constructaccess');
7152: $ownerhome = &homeserver($ownername,$ownerdomain);
7153: return($ownername,$ownerdomain,$ownerhome);
7154: }
7155: # No business here
7156: return '';
7157: }
7158:
7159: sub get_comm_blocks {
7160: my ($cdom,$cnum) = @_;
7161: if ($cdom eq '' || $cnum eq '') {
7162: return unless ($env{'request.course.id'});
7163: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7164: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7165: }
7166: my %commblocks;
7167: my $hashid=$cdom.'_'.$cnum;
7168: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7169: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7170: %commblocks = %{$blocksref};
7171: } else {
7172: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7173: my $cachetime = 600;
7174: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7175: }
7176: return %commblocks;
7177: }
7178:
7179: sub has_comm_blocking {
7180: my ($priv,$symb,$uri,$blocks) = @_;
7181: return unless ($env{'request.course.id'});
7182: return unless ($priv eq 'bre');
7183: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7184: my %commblocks;
7185: if (ref($blocks) eq 'HASH') {
7186: %commblocks = %{$blocks};
7187: } else {
7188: %commblocks = &get_comm_blocks();
7189: }
7190: return unless (keys(%commblocks) > 0);
7191: if (!$symb) { $symb=&symbread($uri,1); }
7192: my ($map,$resid,undef)=&decode_symb($symb);
7193: my %tocheck = (
7194: maps => $map,
7195: resources => $symb,
7196: );
7197: my @blockers;
7198: my $now = time;
7199: my $navmap = Apache::lonnavmaps::navmap->new();
7200: foreach my $block (keys(%commblocks)) {
7201: if ($block =~ /^(\d+)____(\d+)$/) {
7202: my ($start,$end) = ($1,$2);
7203: if ($start <= $now && $end >= $now) {
7204: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7205: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7206: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7207: if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
7208: unless (grep(/^\Q$block\E$/,@blockers)) {
7209: push(@blockers,$block);
7210: }
7211: }
7212: }
7213: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7214: if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
7215: unless (grep(/^\Q$block\E$/,@blockers)) {
7216: push(@blockers,$block);
7217: }
7218: }
7219: }
7220: }
7221: }
7222: }
7223: } elsif ($block =~ /^firstaccess____(.+)$/) {
7224: my $item = $1;
7225: my @to_test;
7226: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7227: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7228: my $check_interval;
7229: if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
7230: my @interval;
7231: my $type = 'map';
7232: if ($item eq 'course') {
7233: $type = 'course';
7234: @interval=&EXT("resource.0.interval");
7235: } else {
7236: if ($item =~ /___\d+___/) {
7237: $type = 'resource';
7238: @interval=&EXT("resource.0.interval",$item);
7239: if (ref($navmap)) {
7240: my $res = $navmap->getBySymb($item);
7241: push(@to_test,$res);
7242: }
7243: } else {
7244: my $mapsymb = &symbread($item,1);
7245: if ($mapsymb) {
7246: if (ref($navmap)) {
7247: my $mapres = $navmap->getBySymb($mapsymb);
7248: @to_test = $mapres->retrieveResources($mapres,undef,0,1);
7249: foreach my $res (@to_test) {
7250: my $symb = $res->symb();
7251: next if ($symb eq $mapsymb);
7252: if ($symb ne '') {
7253: @interval=&EXT("resource.0.interval",$symb);
7254: last;
7255: }
7256: }
7257: }
7258: }
7259: }
7260: }
7261: if ($interval[0] =~ /\d+/) {
7262: my $first_access;
7263: if ($type eq 'resource') {
7264: $first_access=&get_first_access($interval[1],$item);
7265: } elsif ($type eq 'map') {
7266: $first_access=&get_first_access($interval[1],undef,$item);
7267: } else {
7268: $first_access=&get_first_access($interval[1]);
7269: }
7270: if ($first_access) {
7271: my $timesup = $first_access+$interval[0];
7272: if ($timesup > $now) {
7273: foreach my $res (@to_test) {
7274: if ($res->is_problem()) {
7275: if ($res->completable()) {
7276: unless (grep(/^\Q$block\E$/,@blockers)) {
7277: push(@blockers,$block);
7278: }
7279: last;
7280: }
7281: }
7282: }
7283: }
7284: }
7285: }
7286: }
7287: }
7288: }
7289: }
7290: }
7291: return @blockers;
7292: }
7293:
7294: sub check_docs_block {
7295: my ($docsblock,$tocheck) =@_;
7296: if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
7297: return;
7298: }
7299: if (ref($docsblock->{'maps'}) eq 'HASH') {
7300: if ($tocheck->{'maps'}) {
7301: if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
7302: return 1;
7303: }
7304: }
7305: }
7306: if (ref($docsblock->{'resources'}) eq 'HASH') {
7307: if ($tocheck->{'resources'}) {
7308: if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
7309: return 1;
7310: }
7311: }
7312: }
7313: return;
7314: }
7315:
7316: #
7317: # Removes the versino from a URI and
7318: # splits it in to its filename and path to the filename.
7319: # Seems like File::Basename could have done this more clearly.
7320: # Parameters:
7321: # $uri - input URI
7322: # Returns:
7323: # Two element list consisting of
7324: # $pathname - the URI up to and excluding the trailing /
7325: # $filename - The part of the URI following the last /
7326: # NOTE:
7327: # Another realization of this is simply:
7328: # use File::Basename;
7329: # ...
7330: # $uri = shift;
7331: # $filename = basename($uri);
7332: # $path = dirname($uri);
7333: # return ($filename, $path);
7334: #
7335: # The implementation below is probably faster however.
7336: #
7337: sub split_uri_for_cond {
7338: my $uri=&deversion(&declutter(shift));
7339: my @uriparts=split(/\//,$uri);
7340: my $filename=pop(@uriparts);
7341: my $pathname=join('/',@uriparts);
7342: return ($pathname,$filename);
7343: }
7344: # --------------------------------------------------- Is a resource on the map?
7345:
7346: sub is_on_map {
7347: my ($pathname,$filename) = &split_uri_for_cond(shift);
7348: #Trying to find the conditional for the file
7349: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
7350: /\&\Q$filename\E\:([\d\|]+)\&/);
7351: if ($match) {
7352: return (1,$1);
7353: } else {
7354: return (0,0);
7355: }
7356: }
7357:
7358: # --------------------------------------------------------- Get symb from alias
7359:
7360: sub get_symb_from_alias {
7361: my $symb=shift;
7362: my ($map,$resid,$url)=&decode_symb($symb);
7363: # Already is a symb
7364: if ($url) { return $symb; }
7365: # Must be an alias
7366: my $aliassymb='';
7367: my %bighash;
7368: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7369: &GDBM_READER(),0640)) {
7370: my $rid=$bighash{'mapalias_'.$symb};
7371: if ($rid) {
7372: my ($mapid,$resid)=split(/\./,$rid);
7373: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7374: $resid,$bighash{'src_'.$rid});
7375: }
7376: untie %bighash;
7377: }
7378: return $aliassymb;
7379: }
7380:
7381: # ----------------------------------------------------------------- Define Role
7382:
7383: sub definerole {
7384: if (allowed('mcr','/')) {
7385: my ($rolename,$sysrole,$domrole,$courole)=@_;
7386: foreach my $role (split(':',$sysrole)) {
7387: my ($crole,$cqual)=split(/\&/,$role);
7388: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7389: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7390: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7391: return "refused:s:$crole&$cqual";
7392: }
7393: }
7394: }
7395: foreach my $role (split(':',$domrole)) {
7396: my ($crole,$cqual)=split(/\&/,$role);
7397: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7398: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7399: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
7400: return "refused:d:$crole&$cqual";
7401: }
7402: }
7403: }
7404: foreach my $role (split(':',$courole)) {
7405: my ($crole,$cqual)=split(/\&/,$role);
7406: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7407: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7408: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7409: return "refused:c:$crole&$cqual";
7410: }
7411: }
7412: }
7413: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7414: "$env{'user.domain'}:$env{'user.name'}:".
7415: "rolesdef_$rolename=".
7416: escape($sysrole.'_'.$domrole.'_'.$courole);
7417: return reply($command,$env{'user.home'});
7418: } else {
7419: return 'refused';
7420: }
7421: }
7422:
7423: # ---------------- Make a metadata query against the network of library servers
7424:
7425: sub metadata_query {
7426: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
7427: my %rhash;
7428: my %libserv = &all_library();
7429: my @server_list = (defined($server_array) ? @$server_array
7430: : keys(%libserv) );
7431: for my $server (@server_list) {
7432: my $domains = '';
7433: if (ref($domains_hash) eq 'HASH') {
7434: $domains = $domains_hash->{$server};
7435: }
7436: unless ($custom or $customshow) {
7437: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
7438: $rhash{$server}=$reply;
7439: }
7440: else {
7441: my $reply=&reply("querysend:".&escape($query).':'.
7442: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
7443: $server);
7444: $rhash{$server}=$reply;
7445: }
7446: }
7447: return \%rhash;
7448: }
7449:
7450: # ----------------------------------------- Send log queries and wait for reply
7451:
7452: sub log_query {
7453: my ($uname,$udom,$query,%filters)=@_;
7454: my $uhome=&homeserver($uname,$udom);
7455: if ($uhome eq 'no_host') { return 'error: no_host'; }
7456: my $uhost=&hostname($uhome);
7457: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
7458: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
7459: $uhome);
7460: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
7461: return get_query_reply($queryid);
7462: }
7463:
7464: # -------------------------- Update MySQL table for portfolio file
7465:
7466: sub update_portfolio_table {
7467: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
7468: if ($group ne '') {
7469: $file_name =~s /^\Q$group\E//;
7470: }
7471: my $homeserver = &homeserver($uname,$udom);
7472: my $queryid=
7473: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
7474: ':'.&escape($file_name).':'.$action,$homeserver);
7475: my $reply = &get_query_reply($queryid);
7476: return $reply;
7477: }
7478:
7479: # -------------------------- Update MySQL allusers table
7480:
7481: sub update_allusers_table {
7482: my ($uname,$udom,$names) = @_;
7483: my $homeserver = &homeserver($uname,$udom);
7484: my $queryid=
7485: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
7486: 'lastname='.&escape($names->{'lastname'}).'%%'.
7487: 'firstname='.&escape($names->{'firstname'}).'%%'.
7488: 'middlename='.&escape($names->{'middlename'}).'%%'.
7489: 'generation='.&escape($names->{'generation'}).'%%'.
7490: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
7491: 'id='.&escape($names->{'id'}),$homeserver);
7492: return;
7493: }
7494:
7495: # ------- Request retrieval of institutional classlists for course(s)
7496:
7497: sub fetch_enrollment_query {
7498: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
7499: my $homeserver;
7500: my $maxtries = 1;
7501: if ($context eq 'automated') {
7502: $homeserver = $perlvar{'lonHostID'};
7503: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
7504: } else {
7505: $homeserver = &homeserver($cnum,$dom);
7506: }
7507: my $host=&hostname($homeserver);
7508: my $cmd = '';
7509: foreach my $affiliate (keys(%{$affiliatesref})) {
7510: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7511: }
7512: $cmd =~ s/%%$//;
7513: $cmd = &escape($cmd);
7514: my $query = 'fetchenrollment';
7515: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
7516: unless ($queryid=~/^\Q$host\E\_/) {
7517: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
7518: return 'error: '.$queryid;
7519: }
7520: my $reply = &get_query_reply($queryid);
7521: my $tries = 1;
7522: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7523: $reply = &get_query_reply($queryid);
7524: $tries ++;
7525: }
7526: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7527: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7528: } else {
7529: my @responses = split(/:/,$reply);
7530: if ($homeserver eq $perlvar{'lonHostID'}) {
7531: foreach my $line (@responses) {
7532: my ($key,$value) = split(/=/,$line,2);
7533: $$replyref{$key} = $value;
7534: }
7535: } else {
7536: my $pathname = LONCAPA::tempdir();
7537: foreach my $line (@responses) {
7538: my ($key,$value) = split(/=/,$line);
7539: $$replyref{$key} = $value;
7540: if ($value > 0) {
7541: foreach my $item (@{$$affiliatesref{$key}}) {
7542: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
7543: my $destname = $pathname.'/'.$filename;
7544: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
7545: if ($xml_classlist =~ /^error/) {
7546: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
7547: } else {
7548: if ( open(FILE,">$destname") ) {
7549: print FILE &unescape($xml_classlist);
7550: close(FILE);
7551: } else {
7552: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
7553: }
7554: }
7555: }
7556: }
7557: }
7558: }
7559: return 'ok';
7560: }
7561: return 'error';
7562: }
7563:
7564: sub get_query_reply {
7565: my $queryid=shift;
7566: my $replyfile=LONCAPA::tempdir().$queryid;
7567: my $reply='';
7568: for (1..100) {
7569: sleep 2;
7570: if (-e $replyfile.'.end') {
7571: if (open(my $fh,$replyfile)) {
7572: $reply = join('',<$fh>);
7573: close($fh);
7574: } else { return 'error: reply_file_error'; }
7575: return &unescape($reply);
7576: }
7577: }
7578: return 'timeout:'.$queryid;
7579: }
7580:
7581: sub courselog_query {
7582: #
7583: # possible filters:
7584: # url: url or symb
7585: # username
7586: # domain
7587: # action: view, submit, grade
7588: # start: timestamp
7589: # end: timestamp
7590: #
7591: my (%filters)=@_;
7592: unless ($env{'request.course.id'}) { return 'no_course'; }
7593: if ($filters{'url'}) {
7594: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
7595: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
7596: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
7597: }
7598: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
7599: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
7600: return &log_query($cname,$cdom,'courselog',%filters);
7601: }
7602:
7603: sub userlog_query {
7604: #
7605: # possible filters:
7606: # action: log check role
7607: # start: timestamp
7608: # end: timestamp
7609: #
7610: my ($uname,$udom,%filters)=@_;
7611: return &log_query($uname,$udom,'userlog',%filters);
7612: }
7613:
7614: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
7615:
7616: sub auto_run {
7617: my ($cnum,$cdom) = @_;
7618: my $response = 0;
7619: my $settings;
7620: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
7621: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
7622: $settings = $domconfig{'autoenroll'};
7623: if ($settings->{'run'} eq '1') {
7624: $response = 1;
7625: }
7626: } else {
7627: my $homeserver;
7628: if (&is_course($cdom,$cnum)) {
7629: $homeserver = &homeserver($cnum,$cdom);
7630: } else {
7631: $homeserver = &domain($cdom,'primary');
7632: }
7633: if ($homeserver ne 'no_host') {
7634: $response = &reply('autorun:'.$cdom,$homeserver);
7635: }
7636: }
7637: return $response;
7638: }
7639:
7640: sub auto_get_sections {
7641: my ($cnum,$cdom,$inst_coursecode) = @_;
7642: my $homeserver;
7643: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7644: $homeserver = &homeserver($cnum,$cdom);
7645: }
7646: if (!defined($homeserver)) {
7647: if ($cdom =~ /^$match_domain$/) {
7648: $homeserver = &domain($cdom,'primary');
7649: }
7650: }
7651: my @secs;
7652: if (defined($homeserver)) {
7653: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
7654: unless ($response eq 'refused') {
7655: @secs = split(/:/,$response);
7656: }
7657: }
7658: return @secs;
7659: }
7660:
7661: sub auto_new_course {
7662: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
7663: my $homeserver = &homeserver($cnum,$cdom);
7664: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
7665: return $response;
7666: }
7667:
7668: sub auto_validate_courseID {
7669: my ($cnum,$cdom,$inst_course_id) = @_;
7670: my $homeserver = &homeserver($cnum,$cdom);
7671: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
7672: return $response;
7673: }
7674:
7675: sub auto_validate_instcode {
7676: my ($cnum,$cdom,$instcode,$owner) = @_;
7677: my ($homeserver,$response);
7678: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7679: $homeserver = &homeserver($cnum,$cdom);
7680: }
7681: if (!defined($homeserver)) {
7682: if ($cdom =~ /^$match_domain$/) {
7683: $homeserver = &domain($cdom,'primary');
7684: }
7685: }
7686: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
7687: &escape($instcode).':'.&escape($owner),$homeserver));
7688: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
7689: return ($outcome,$description,$defaultcredits);
7690: }
7691:
7692: sub auto_create_password {
7693: my ($cnum,$cdom,$authparam,$udom) = @_;
7694: my ($homeserver,$response);
7695: my $create_passwd = 0;
7696: my $authchk = '';
7697: if ($udom =~ /^$match_domain$/) {
7698: $homeserver = &domain($udom,'primary');
7699: }
7700: if ($homeserver eq '') {
7701: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7702: $homeserver = &homeserver($cnum,$cdom);
7703: }
7704: }
7705: if ($homeserver eq '') {
7706: $authchk = 'nodomain';
7707: } else {
7708: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
7709: if ($response eq 'refused') {
7710: $authchk = 'refused';
7711: } else {
7712: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
7713: }
7714: }
7715: return ($authparam,$create_passwd,$authchk);
7716: }
7717:
7718: sub auto_photo_permission {
7719: my ($cnum,$cdom,$students) = @_;
7720: my $homeserver = &homeserver($cnum,$cdom);
7721: my ($outcome,$perm_reqd,$conditions) =
7722: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
7723: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7724: return (undef,undef);
7725: }
7726: return ($outcome,$perm_reqd,$conditions);
7727: }
7728:
7729: sub auto_checkphotos {
7730: my ($uname,$udom,$pid) = @_;
7731: my $homeserver = &homeserver($uname,$udom);
7732: my ($result,$resulttype);
7733: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
7734: &escape($uname).':'.&escape($pid),
7735: $homeserver));
7736: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7737: return (undef,undef);
7738: }
7739: if ($outcome) {
7740: ($result,$resulttype) = split(/:/,$outcome);
7741: }
7742: return ($result,$resulttype);
7743: }
7744:
7745: sub auto_photochoice {
7746: my ($cnum,$cdom) = @_;
7747: my $homeserver = &homeserver($cnum,$cdom);
7748: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
7749: &escape($cdom),
7750: $homeserver)));
7751: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7752: return (undef,undef);
7753: }
7754: return ($update,$comment);
7755: }
7756:
7757: sub auto_photoupdate {
7758: my ($affiliatesref,$dom,$cnum,$photo) = @_;
7759: my $homeserver = &homeserver($cnum,$dom);
7760: my $host=&hostname($homeserver);
7761: my $cmd = '';
7762: my $maxtries = 1;
7763: foreach my $affiliate (keys(%{$affiliatesref})) {
7764: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7765: }
7766: $cmd =~ s/%%$//;
7767: $cmd = &escape($cmd);
7768: my $query = 'institutionalphotos';
7769: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
7770: unless ($queryid=~/^\Q$host\E\_/) {
7771: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
7772: return 'error: '.$queryid;
7773: }
7774: my $reply = &get_query_reply($queryid);
7775: my $tries = 1;
7776: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7777: $reply = &get_query_reply($queryid);
7778: $tries ++;
7779: }
7780: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7781: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7782: } else {
7783: my @responses = split(/:/,$reply);
7784: my $outcome = shift(@responses);
7785: foreach my $item (@responses) {
7786: my ($key,$value) = split(/=/,$item);
7787: $$photo{$key} = $value;
7788: }
7789: return $outcome;
7790: }
7791: return 'error';
7792: }
7793:
7794: sub auto_instcode_format {
7795: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
7796: $cat_order) = @_;
7797: my $courses = '';
7798: my @homeservers;
7799: if ($caller eq 'global') {
7800: my %servers = &get_servers($codedom,'library');
7801: foreach my $tryserver (keys(%servers)) {
7802: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7803: push(@homeservers,$tryserver);
7804: }
7805: }
7806: } elsif ($caller eq 'requests') {
7807: if ($codedom =~ /^$match_domain$/) {
7808: my $chome = &domain($codedom,'primary');
7809: unless ($chome eq 'no_host') {
7810: push(@homeservers,$chome);
7811: }
7812: }
7813: } else {
7814: push(@homeservers,&homeserver($caller,$codedom));
7815: }
7816: foreach my $code (keys(%{$instcodes})) {
7817: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
7818: }
7819: chop($courses);
7820: my $ok_response = 0;
7821: my $response;
7822: while (@homeservers > 0 && $ok_response == 0) {
7823: my $server = shift(@homeservers);
7824: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
7825: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
7826: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
7827: split(/:/,$response);
7828: %{$codes} = (%{$codes},&str2hash($codes_str));
7829: push(@{$codetitles},&str2array($codetitles_str));
7830: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
7831: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
7832: $ok_response = 1;
7833: }
7834: }
7835: if ($ok_response) {
7836: return 'ok';
7837: } else {
7838: return $response;
7839: }
7840: }
7841:
7842: sub auto_instcode_defaults {
7843: my ($domain,$returnhash,$code_order) = @_;
7844: my @homeservers;
7845:
7846: my %servers = &get_servers($domain,'library');
7847: foreach my $tryserver (keys(%servers)) {
7848: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7849: push(@homeservers,$tryserver);
7850: }
7851: }
7852:
7853: my $response;
7854: foreach my $server (@homeservers) {
7855: $response=&reply('autoinstcodedefaults:'.$domain,$server);
7856: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7857:
7858: foreach my $pair (split(/\&/,$response)) {
7859: my ($name,$value)=split(/\=/,$pair);
7860: if ($name eq 'code_order') {
7861: @{$code_order} = split(/\&/,&unescape($value));
7862: } else {
7863: $returnhash->{&unescape($name)}=&unescape($value);
7864: }
7865: }
7866: return 'ok';
7867: }
7868:
7869: return $response;
7870: }
7871:
7872: sub auto_possible_instcodes {
7873: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
7874: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
7875: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
7876: return;
7877: }
7878: my (@homeservers,$uhome);
7879: if (defined(&domain($domain,'primary'))) {
7880: $uhome=&domain($domain,'primary');
7881: push(@homeservers,&domain($domain,'primary'));
7882: } else {
7883: my %servers = &get_servers($domain,'library');
7884: foreach my $tryserver (keys(%servers)) {
7885: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7886: push(@homeservers,$tryserver);
7887: }
7888: }
7889: }
7890: my $response;
7891: foreach my $server (@homeservers) {
7892: $response=&reply('autopossibleinstcodes:'.$domain,$server);
7893: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7894: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
7895: split(':',$response);
7896: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
7897: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
7898: foreach my $item (split('&',$cat_title)) {
7899: my ($name,$value)=split('=',$item);
7900: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
7901: }
7902: foreach my $item (split('&',$cat_order)) {
7903: my ($name,$value)=split('=',$item);
7904: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
7905: }
7906: return 'ok';
7907: }
7908: return $response;
7909: }
7910:
7911: sub auto_courserequest_checks {
7912: my ($dom) = @_;
7913: my ($homeserver,%validations);
7914: if ($dom =~ /^$match_domain$/) {
7915: $homeserver = &domain($dom,'primary');
7916: }
7917: unless ($homeserver eq 'no_host') {
7918: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
7919: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7920: my @items = split(/&/,$response);
7921: foreach my $item (@items) {
7922: my ($key,$value) = split('=',$item);
7923: $validations{&unescape($key)} = &thaw_unescape($value);
7924: }
7925: }
7926: }
7927: return %validations;
7928: }
7929:
7930: sub auto_courserequest_validation {
7931: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
7932: my ($homeserver,$response);
7933: if ($dom =~ /^$match_domain$/) {
7934: $homeserver = &domain($dom,'primary');
7935: }
7936: unless ($homeserver eq 'no_host') {
7937: my $customdata;
7938: if (ref($custominfo) eq 'HASH') {
7939: $customdata = &freeze_escape($custominfo);
7940: }
7941: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
7942: ':'.&escape($crstype).':'.&escape($inststatuslist).
7943: ':'.&escape($instcode).':'.&escape($instseclist).':'.
7944: $customdata,$homeserver));
7945: }
7946: return $response;
7947: }
7948:
7949: sub auto_validate_class_sec {
7950: my ($cdom,$cnum,$owners,$inst_class) = @_;
7951: my $homeserver = &homeserver($cnum,$cdom);
7952: my $ownerlist;
7953: if (ref($owners) eq 'ARRAY') {
7954: $ownerlist = join(',',@{$owners});
7955: } else {
7956: $ownerlist = $owners;
7957: }
7958: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
7959: &escape($ownerlist).':'.$cdom,$homeserver);
7960: return $response;
7961: }
7962:
7963: sub auto_crsreq_update {
7964: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
7965: $code,$accessstart,$accessend,$inbound) = @_;
7966: my ($homeserver,%crsreqresponse);
7967: if ($cdom =~ /^$match_domain$/) {
7968: $homeserver = &domain($cdom,'primary');
7969: }
7970: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
7971: my $info;
7972: if (ref($inbound) eq 'HASH') {
7973: $info = &freeze_escape($inbound);
7974: }
7975: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
7976: ':'.&escape($action).':'.&escape($ownername).':'.
7977: &escape($ownerdomain).':'.&escape($fullname).':'.
7978: &escape($title).':'.&escape($code).':'.
7979: &escape($accessstart).':'.&escape($accessend).':'.$info,
7980: $homeserver);
7981: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7982: my @items = split(/&/,$response);
7983: foreach my $item (@items) {
7984: my ($key,$value) = split('=',$item);
7985: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
7986: }
7987: }
7988: }
7989: return \%crsreqresponse;
7990: }
7991:
7992: # ------------------------------------------------------- Course Group routines
7993:
7994: sub get_coursegroups {
7995: my ($cdom,$cnum,$group,$namespace) = @_;
7996: return(&dump($namespace,$cdom,$cnum,$group));
7997: }
7998:
7999: sub modify_coursegroup {
8000: my ($cdom,$cnum,$groupsettings) = @_;
8001: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8002: }
8003:
8004: sub toggle_coursegroup_status {
8005: my ($cdom,$cnum,$group,$action) = @_;
8006: my ($from_namespace,$to_namespace);
8007: if ($action eq 'delete') {
8008: $from_namespace = 'coursegroups';
8009: $to_namespace = 'deleted_groups';
8010: } else {
8011: $from_namespace = 'deleted_groups';
8012: $to_namespace = 'coursegroups';
8013: }
8014: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
8015: if (my $tmp = &error(%curr_group)) {
8016: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8017: return ('read error',$tmp);
8018: } else {
8019: my %savedsettings = %curr_group;
8020: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
8021: my $deloutcome;
8022: if ($result eq 'ok') {
8023: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
8024: } else {
8025: return ('write error',$result);
8026: }
8027: if ($deloutcome eq 'ok') {
8028: return 'ok';
8029: } else {
8030: return ('delete error',$deloutcome);
8031: }
8032: }
8033: }
8034:
8035: sub modify_group_roles {
8036: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
8037: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8038: my $role = 'gr/'.&escape($userprivs);
8039: my ($uname,$udom) = split(/:/,$user);
8040: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
8041: if ($result eq 'ok') {
8042: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8043: }
8044: return $result;
8045: }
8046:
8047: sub modify_coursegroup_membership {
8048: my ($cdom,$cnum,$membership) = @_;
8049: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8050: return $result;
8051: }
8052:
8053: sub get_active_groups {
8054: my ($udom,$uname,$cdom,$cnum) = @_;
8055: my $now = time;
8056: my %groups = ();
8057: foreach my $key (keys(%env)) {
8058: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
8059: my ($start,$end) = split(/\./,$env{$key});
8060: if (($end!=0) && ($end<$now)) { next; }
8061: if (($start!=0) && ($start>$now)) { next; }
8062: if ($1 eq $cdom && $2 eq $cnum) {
8063: $groups{$3} = $env{$key} ;
8064: }
8065: }
8066: }
8067: return %groups;
8068: }
8069:
8070: sub get_group_membership {
8071: my ($cdom,$cnum,$group) = @_;
8072: return(&dump('groupmembership',$cdom,$cnum,$group));
8073: }
8074:
8075: sub get_users_groups {
8076: my ($udom,$uname,$courseid) = @_;
8077: my @usersgroups;
8078: my $cachetime=1800;
8079:
8080: my $hashid="$udom:$uname:$courseid";
8081: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8082: if (defined($cached)) {
8083: @usersgroups = split(/:/,$grouplist);
8084: } else {
8085: $grouplist = '';
8086: my $courseurl = &courseid_to_courseurl($courseid);
8087: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
8088: my $access_end = $env{'course.'.$courseid.
8089: '.default_enrollment_end_date'};
8090: my $now = time;
8091: foreach my $key (keys(%roleshash)) {
8092: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8093: my $group = $1;
8094: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8095: my $start = $2;
8096: my $end = $1;
8097: if ($start == -1) { next; } # deleted from group
8098: if (($start!=0) && ($start>$now)) { next; }
8099: if (($end!=0) && ($end<$now)) {
8100: if ($access_end && $access_end < $now) {
8101: if ($access_end - $end < 86400) {
8102: push(@usersgroups,$group);
8103: }
8104: }
8105: next;
8106: }
8107: push(@usersgroups,$group);
8108: }
8109: }
8110: }
8111: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8112: $grouplist = join(':',@usersgroups);
8113: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
8114: }
8115: return @usersgroups;
8116: }
8117:
8118: sub devalidate_getgroups_cache {
8119: my ($udom,$uname,$cdom,$cnum)=@_;
8120: my $courseid = $cdom.'_'.$cnum;
8121:
8122: my $hashid="$udom:$uname:$courseid";
8123: &devalidate_cache_new('getgroups',$hashid);
8124: }
8125:
8126: # ------------------------------------------------------------------ Plain Text
8127:
8128: sub plaintext {
8129: my ($short,$type,$cid,$forcedefault) = @_;
8130: if ($short =~ m{^cr/}) {
8131: return (split('/',$short))[-1];
8132: }
8133: if (!defined($cid)) {
8134: $cid = $env{'request.course.id'};
8135: }
8136: my %rolenames = (
8137: Course => 'std',
8138: Community => 'alt1',
8139: );
8140: if ($cid ne '') {
8141: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8142: unless ($forcedefault) {
8143: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8144: &Apache::lonlocal::mt_escape(\$roletext);
8145: return &Apache::lonlocal::mt($roletext);
8146: }
8147: }
8148: }
8149: if ((defined($type)) && (defined($rolenames{$type})) &&
8150: (defined($rolenames{$type})) &&
8151: (defined($prp{$short}{$rolenames{$type}}))) {
8152: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
8153: } elsif ($cid ne '') {
8154: my $crstype = $env{'course.'.$cid.'.type'};
8155: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8156: (defined($prp{$short}{$rolenames{$crstype}}))) {
8157: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8158: }
8159: }
8160: return &Apache::lonlocal::mt($prp{$short}{'std'});
8161: }
8162:
8163: # ----------------------------------------------------------------- Assign Role
8164:
8165: sub assignrole {
8166: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8167: $context)=@_;
8168: my $mrole;
8169: if ($role =~ /^cr\//) {
8170: my $cwosec=$url;
8171: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8172: unless (&allowed('ccr',$cwosec)) {
8173: my $refused = 1;
8174: if ($context eq 'requestcourses') {
8175: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8176: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8177: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8178: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8179: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8180: if ($crsenv{'internal.courseowner'} eq
8181: $env{'user.name'}.':'.$env{'user.domain'}) {
8182: $refused = '';
8183: }
8184: }
8185: }
8186: }
8187: }
8188: if ($refused) {
8189: &logthis('Refused custom assignrole: '.
8190: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8191: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8192: return 'refused';
8193: }
8194: }
8195: $mrole='cr';
8196: } elsif ($role =~ /^gr\//) {
8197: my $cwogrp=$url;
8198: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
8199: unless (&allowed('mdg',$cwogrp)) {
8200: &logthis('Refused group assignrole: '.
8201: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8202: $env{'user.name'}.' at '.$env{'user.domain'});
8203: return 'refused';
8204: }
8205: $mrole='gr';
8206: } else {
8207: my $cwosec=$url;
8208: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8209: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8210: my $refused;
8211: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8212: if (!(&allowed('c'.$role,$url))) {
8213: $refused = 1;
8214: }
8215: } else {
8216: $refused = 1;
8217: }
8218: if ($refused) {
8219: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8220: if (!$selfenroll && $context eq 'course') {
8221: my %crsenv;
8222: if ($role eq 'cc' || $role eq 'co') {
8223: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8224: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8225: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8226: if ($crsenv{'internal.courseowner'} eq
8227: $env{'user.name'}.':'.$env{'user.domain'}) {
8228: $refused = '';
8229: }
8230: }
8231: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8232: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8233: if ($crsenv{'internal.courseowner'} eq
8234: $env{'user.name'}.':'.$env{'user.domain'}) {
8235: $refused = '';
8236: }
8237: }
8238: }
8239: }
8240: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8241: $refused = '';
8242: } elsif ($context eq 'requestcourses') {
8243: my @possroles = ('st','ta','ep','in','cc','co');
8244: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
8245: my $wrongcc;
8246: if ($cnum =~ /^$match_community$/) {
8247: $wrongcc = 1 if ($role eq 'cc');
8248: } else {
8249: $wrongcc = 1 if ($role eq 'co');
8250: }
8251: unless ($wrongcc) {
8252: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8253: if ($crsenv{'internal.courseowner'} eq
8254: $env{'user.name'}.':'.$env{'user.domain'}) {
8255: $refused = '';
8256: }
8257: }
8258: }
8259: } elsif ($context eq 'requestauthor') {
8260: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8261: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8262: if ($env{'environment.requestauthor'} eq 'automatic') {
8263: $refused = '';
8264: } else {
8265: my %domdefaults = &get_domain_defaults($udom);
8266: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8267: my $checkbystatus;
8268: if ($env{'user.adv'}) {
8269: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8270: if ($disposition eq 'automatic') {
8271: $refused = '';
8272: } elsif ($disposition eq '') {
8273: $checkbystatus = 1;
8274: }
8275: } else {
8276: $checkbystatus = 1;
8277: }
8278: if ($checkbystatus) {
8279: if ($env{'environment.inststatus'}) {
8280: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8281: foreach my $type (@inststatuses) {
8282: if (($type ne '') &&
8283: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8284: $refused = '';
8285: }
8286: }
8287: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8288: $refused = '';
8289: }
8290: }
8291: }
8292: }
8293: }
8294: }
8295: if ($refused) {
8296: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8297: ' '.$role.' '.$end.' '.$start.' by '.
8298: $env{'user.name'}.' at '.$env{'user.domain'});
8299: return 'refused';
8300: }
8301: }
8302: } elsif ($role eq 'au') {
8303: if ($url ne '/'.$udom.'/') {
8304: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8305: ' to assign author role for '.$uname.':'.$udom.
8306: ' in domain: '.$url.' refused (wrong domain).');
8307: return 'refused';
8308: }
8309: }
8310: $mrole=$role;
8311: }
8312: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8313: "$udom:$uname:$url".'_'."$mrole=$role";
8314: if ($end) { $command.='_'.$end; }
8315: if ($start) {
8316: if ($end) {
8317: $command.='_'.$start;
8318: } else {
8319: $command.='_0_'.$start;
8320: }
8321: }
8322: my $origstart = $start;
8323: my $origend = $end;
8324: my $delflag;
8325: # actually delete
8326: if ($deleteflag) {
8327: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
8328: # modify command to delete the role
8329: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
8330: "$udom:$uname:$url".'_'."$mrole";
8331: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
8332: # set start and finish to negative values for userrolelog
8333: $start=-1;
8334: $end=-1;
8335: $delflag = 1;
8336: }
8337: }
8338: # send command
8339: my $answer=&reply($command,&homeserver($uname,$udom));
8340: # log new user role if status is ok
8341: if ($answer eq 'ok') {
8342: &userrolelog($role,$uname,$udom,$url,$start,$end);
8343: if (($role eq 'cc') || ($role eq 'in') ||
8344: ($role eq 'ep') || ($role eq 'ad') ||
8345: ($role eq 'ta') || ($role eq 'st') ||
8346: ($role=~/^cr/) || ($role eq 'gr') ||
8347: ($role eq 'co')) {
8348: # for course roles, perform group memberships changes triggered by role change.
8349: unless ($role =~ /^gr/) {
8350: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
8351: $origstart,$selfenroll,$context);
8352: }
8353: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8354: $selfenroll,$context);
8355: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
8356: ($role eq 'au') || ($role eq 'dc')) {
8357: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8358: $context);
8359: } elsif (($role eq 'ca') || ($role eq 'aa')) {
8360: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8361: $context);
8362: }
8363: if ($role eq 'cc') {
8364: &autoupdate_coowners($url,$end,$start,$uname,$udom);
8365: }
8366: }
8367: return $answer;
8368: }
8369:
8370: sub autoupdate_coowners {
8371: my ($url,$end,$start,$uname,$udom) = @_;
8372: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
8373: if (($cdom ne '') && ($cnum ne '')) {
8374: my $now = time;
8375: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
8376: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
8377: my %coursehash = &coursedescription($cdom.'_'.$cnum);
8378: my $instcode = $coursehash{'internal.coursecode'};
8379: if ($instcode ne '') {
8380: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
8381: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
8382: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
8383: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
8384: if ($result eq 'valid') {
8385: if ($coursehash{'internal.co-owners'}) {
8386: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8387: push(@newcoowners,$coowner);
8388: }
8389: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
8390: push(@newcoowners,$uname.':'.$udom);
8391: }
8392: @newcoowners = sort(@newcoowners);
8393: } else {
8394: push(@newcoowners,$uname.':'.$udom);
8395: }
8396: } else {
8397: if ($coursehash{'internal.co-owners'}) {
8398: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8399: unless ($coowner eq $uname.':'.$udom) {
8400: push(@newcoowners,$coowner);
8401: }
8402: }
8403: unless (@newcoowners > 0) {
8404: $delcoowners = 1;
8405: $coowners = '';
8406: }
8407: }
8408: }
8409: if (@newcoowners || $delcoowners) {
8410: &store_coowners($cdom,$cnum,$coursehash{'home'},
8411: $delcoowners,@newcoowners);
8412: }
8413: }
8414: }
8415: }
8416: }
8417: }
8418: }
8419:
8420: sub store_coowners {
8421: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
8422: my $cid = $cdom.'_'.$cnum;
8423: my ($coowners,$delresult,$putresult);
8424: if (@newcoowners) {
8425: $coowners = join(',',@newcoowners);
8426: my %coownershash = (
8427: 'internal.co-owners' => $coowners,
8428: );
8429: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
8430: if ($putresult eq 'ok') {
8431: if ($env{'course.'.$cid.'.num'} eq $cnum) {
8432: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
8433: }
8434: }
8435: }
8436: if ($delcoowners) {
8437: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
8438: if ($delresult eq 'ok') {
8439: if ($env{'course.'.$cid.'.internal.co-owners'}) {
8440: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
8441: }
8442: }
8443: }
8444: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
8445: my %crsinfo =
8446: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
8447: if (ref($crsinfo{$cid}) eq 'HASH') {
8448: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
8449: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
8450: }
8451: }
8452: }
8453:
8454: # -------------------------------------------------- Modify user authentication
8455: # Overrides without validation
8456:
8457: sub modifyuserauth {
8458: my ($udom,$uname,$umode,$upass)=@_;
8459: my $uhome=&homeserver($uname,$udom);
8460: unless (&allowed('mau',$udom)) { return 'refused'; }
8461: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
8462: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8463: ' in domain '.$env{'request.role.domain'});
8464: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
8465: &escape($upass),$uhome);
8466: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
8467: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
8468: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8469: &log($udom,,$uname,$uhome,
8470: 'Authentication changed by '.$env{'user.domain'}.', '.
8471: $env{'user.name'}.', '.$umode.
8472: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8473: unless ($reply eq 'ok') {
8474: &logthis('Authentication mode error: '.$reply);
8475: return 'error: '.$reply;
8476: }
8477: return 'ok';
8478: }
8479:
8480: # --------------------------------------------------------------- Modify a user
8481:
8482: sub modifyuser {
8483: my ($udom, $uname, $uid,
8484: $umode, $upass, $first,
8485: $middle, $last, $gene,
8486: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
8487: $udom= &LONCAPA::clean_domain($udom);
8488: $uname=&LONCAPA::clean_username($uname);
8489: my $showcandelete = 'none';
8490: if (ref($candelete) eq 'ARRAY') {
8491: if (@{$candelete} > 0) {
8492: $showcandelete = join(', ',@{$candelete});
8493: }
8494: }
8495: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
8496: $umode.', '.$first.', '.$middle.', '.
8497: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
8498: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
8499: ' desiredhome not specified').
8500: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8501: ' in domain '.$env{'request.role.domain'});
8502: my $uhome=&homeserver($uname,$udom,'true');
8503: my $newuser;
8504: if ($uhome eq 'no_host') {
8505: $newuser = 1;
8506: }
8507: # ----------------------------------------------------------------- Create User
8508: if (($uhome eq 'no_host') &&
8509: (($umode && $upass) || ($umode eq 'localauth'))) {
8510: my $unhome='';
8511: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
8512: $unhome = $desiredhome;
8513: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
8514: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
8515: } else { # load balancing routine for determining $unhome
8516: my $loadm=10000000;
8517: my %servers = &get_servers($udom,'library');
8518: foreach my $tryserver (keys(%servers)) {
8519: my $answer=reply('load',$tryserver);
8520: if (($answer=~/\d+/) && ($answer<$loadm)) {
8521: $loadm=$answer;
8522: $unhome=$tryserver;
8523: }
8524: }
8525: }
8526: if (($unhome eq '') || ($unhome eq 'no_host')) {
8527: return 'error: unable to find a home server for '.$uname.
8528: ' in domain '.$udom;
8529: }
8530: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
8531: &escape($upass),$unhome);
8532: unless ($reply eq 'ok') {
8533: return 'error: '.$reply;
8534: }
8535: $uhome=&homeserver($uname,$udom,'true');
8536: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
8537: return 'error: unable verify users home machine.';
8538: }
8539: } # End of creation of new user
8540: # ---------------------------------------------------------------------- Add ID
8541: if ($uid) {
8542: $uid=~tr/A-Z/a-z/;
8543: my %uidhash=&idrget($udom,$uname);
8544: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
8545: && (!$forceid)) {
8546: unless ($uid eq $uidhash{$uname}) {
8547: return 'error: user id "'.$uid.'" does not match '.
8548: 'current user id "'.$uidhash{$uname}.'".';
8549: }
8550: } else {
8551: &idput($udom,($uname => $uid));
8552: }
8553: }
8554: # -------------------------------------------------------------- Add names, etc
8555: my @tmp=&get('environment',
8556: ['firstname','middlename','lastname','generation','id',
8557: 'permanentemail','inststatus'],
8558: $udom,$uname);
8559: my (%names,%oldnames);
8560: if ($tmp[0] =~ m/^error:.*/) {
8561: %names=();
8562: } else {
8563: %names = @tmp;
8564: %oldnames = %names;
8565: }
8566: #
8567: # If name, email and/or uid are blank (e.g., because an uploaded file
8568: # of users did not contain them), do not overwrite existing values
8569: # unless field is in $candelete array ref.
8570: #
8571:
8572: my @fields = ('firstname','middlename','lastname','generation',
8573: 'permanentemail','id');
8574: my %newvalues;
8575: if (ref($candelete) eq 'ARRAY') {
8576: foreach my $field (@fields) {
8577: if (grep(/^\Q$field\E$/,@{$candelete})) {
8578: if ($field eq 'firstname') {
8579: $names{$field} = $first;
8580: } elsif ($field eq 'middlename') {
8581: $names{$field} = $middle;
8582: } elsif ($field eq 'lastname') {
8583: $names{$field} = $last;
8584: } elsif ($field eq 'generation') {
8585: $names{$field} = $gene;
8586: } elsif ($field eq 'permanentemail') {
8587: $names{$field} = $email;
8588: } elsif ($field eq 'id') {
8589: $names{$field} = $uid;
8590: }
8591: }
8592: }
8593: }
8594: if ($first) { $names{'firstname'} = $first; }
8595: if (defined($middle)) { $names{'middlename'} = $middle; }
8596: if ($last) { $names{'lastname'} = $last; }
8597: if (defined($gene)) { $names{'generation'} = $gene; }
8598: if ($email) {
8599: $email=~s/[^\w\@\.\-\,]//gs;
8600: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
8601: }
8602: if ($uid) { $names{'id'} = $uid; }
8603: if (defined($inststatus)) {
8604: $names{'inststatus'} = '';
8605: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
8606: if (ref($usertypes) eq 'HASH') {
8607: my @okstatuses;
8608: foreach my $item (split(/:/,$inststatus)) {
8609: if (defined($usertypes->{$item})) {
8610: push(@okstatuses,$item);
8611: }
8612: }
8613: if (@okstatuses) {
8614: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
8615: }
8616: }
8617: }
8618: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
8619: $umode.', '.$first.', '.$middle.', '.
8620: $last.', '.$gene.', '.$email.', '.$inststatus;
8621: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
8622: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
8623: } else {
8624: $logmsg .= ' during self creation';
8625: }
8626: my $changed;
8627: if ($newuser) {
8628: $changed = 1;
8629: } else {
8630: foreach my $field (@fields) {
8631: if ($names{$field} ne $oldnames{$field}) {
8632: $changed = 1;
8633: last;
8634: }
8635: }
8636: }
8637: unless ($changed) {
8638: $logmsg = 'No changes in user information needed for: '.$logmsg;
8639: &logthis($logmsg);
8640: return 'ok';
8641: }
8642: my $reply = &put('environment', \%names, $udom,$uname);
8643: if ($reply ne 'ok') {
8644: return 'error: '.$reply;
8645: }
8646: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
8647: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
8648: }
8649: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
8650: &devalidate_cache_new('namescache',$uname.':'.$udom);
8651: $logmsg = 'Success modifying user '.$logmsg;
8652: &logthis($logmsg);
8653: return 'ok';
8654: }
8655:
8656: # -------------------------------------------------------------- Modify student
8657:
8658: sub modifystudent {
8659: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
8660: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
8661: $selfenroll,$context,$inststatus,$credits)=@_;
8662: if (!$cid) {
8663: unless ($cid=$env{'request.course.id'}) {
8664: return 'not_in_class';
8665: }
8666: }
8667: # --------------------------------------------------------------- Make the user
8668: my $reply=&modifyuser
8669: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
8670: $desiredhome,$email,$inststatus);
8671: unless ($reply eq 'ok') { return $reply; }
8672: # This will cause &modify_student_enrollment to get the uid from the
8673: # student's environment
8674: $uid = undef if (!$forceid);
8675: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
8676: $gene,$usec,$end,$start,$type,$locktype,
8677: $cid,$selfenroll,$context,$credits);
8678: return $reply;
8679: }
8680:
8681: sub modify_student_enrollment {
8682: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
8683: $locktype,$cid,$selfenroll,$context,$credits) = @_;
8684: my ($cdom,$cnum,$chome);
8685: if (!$cid) {
8686: unless ($cid=$env{'request.course.id'}) {
8687: return 'not_in_class';
8688: }
8689: $cdom=$env{'course.'.$cid.'.domain'};
8690: $cnum=$env{'course.'.$cid.'.num'};
8691: } else {
8692: ($cdom,$cnum)=split(/_/,$cid);
8693: }
8694: $chome=$env{'course.'.$cid.'.home'};
8695: if (!$chome) {
8696: $chome=&homeserver($cnum,$cdom);
8697: }
8698: if (!$chome) { return 'unknown_course'; }
8699: # Make sure the user exists
8700: my $uhome=&homeserver($uname,$udom);
8701: if (($uhome eq '') || ($uhome eq 'no_host')) {
8702: return 'error: no such user';
8703: }
8704: # Get student data if we were not given enough information
8705: if (!defined($first) || $first eq '' ||
8706: !defined($last) || $last eq '' ||
8707: !defined($uid) || $uid eq '' ||
8708: !defined($middle) || $middle eq '' ||
8709: !defined($gene) || $gene eq '') {
8710: # They did not supply us with enough data to enroll the student, so
8711: # we need to pick up more information.
8712: my %tmp = &get('environment',
8713: ['firstname','middlename','lastname', 'generation','id']
8714: ,$udom,$uname);
8715:
8716: #foreach my $key (keys(%tmp)) {
8717: # &logthis("key $key = ".$tmp{$key});
8718: #}
8719: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
8720: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
8721: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
8722: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
8723: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
8724: }
8725: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
8726: my $user = "$uname:$udom";
8727: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
8728: my $reply=cput('classlist',
8729: {$user =>
8730: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits) },
8731: $cdom,$cnum);
8732: if (($reply eq 'ok') || ($reply eq 'delayed')) {
8733: &devalidate_getsection_cache($udom,$uname,$cid);
8734: } else {
8735: return 'error: '.$reply;
8736: }
8737: # Add student role to user
8738: my $uurl='/'.$cid;
8739: $uurl=~s/\_/\//g;
8740: if ($usec) {
8741: $uurl.='/'.$usec;
8742: }
8743: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
8744: $selfenroll,$context);
8745: if ($result ne 'ok') {
8746: if ($old_entry{$user} ne '') {
8747: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
8748: } else {
8749: $reply = &del('classlist',[$user],$cdom,$cnum);
8750: }
8751: }
8752: return $result;
8753: }
8754:
8755: sub format_name {
8756: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
8757: my $name;
8758: if ($first ne 'lastname') {
8759: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
8760: } else {
8761: if ($lastname=~/\S/) {
8762: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
8763: $name=~s/\s+,/,/;
8764: } else {
8765: $name.= $firstname.' '.$middlename.' '.$generation;
8766: }
8767: }
8768: $name=~s/^\s+//;
8769: $name=~s/\s+$//;
8770: $name=~s/\s+/ /g;
8771: return $name;
8772: }
8773:
8774: # ------------------------------------------------- Write to course preferences
8775:
8776: sub writecoursepref {
8777: my ($courseid,%prefs)=@_;
8778: $courseid=~s/^\///;
8779: $courseid=~s/\_/\//g;
8780: my ($cdomain,$cnum)=split(/\//,$courseid);
8781: my $chome=homeserver($cnum,$cdomain);
8782: if (($chome eq '') || ($chome eq 'no_host')) {
8783: return 'error: no such course';
8784: }
8785: my $cstring='';
8786: foreach my $pref (keys(%prefs)) {
8787: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
8788: }
8789: $cstring=~s/\&$//;
8790: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
8791: }
8792:
8793: # ---------------------------------------------------------- Make/modify course
8794:
8795: sub createcourse {
8796: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
8797: $course_owner,$crstype,$cnum,$context,$category)=@_;
8798: $url=&declutter($url);
8799: my $cid='';
8800: if ($context eq 'requestcourses') {
8801: my $can_create = 0;
8802: my ($ownername,$ownerdom) = split(':',$course_owner);
8803: if ($udom eq $ownerdom) {
8804: if (&usertools_access($ownername,$ownerdom,$category,undef,
8805: $context)) {
8806: $can_create = 1;
8807: }
8808: } else {
8809: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
8810: $category);
8811: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
8812: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
8813: if (@curr > 0) {
8814: my @options = qw(approval validate autolimit);
8815: my $optregex = join('|',@options);
8816: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
8817: $can_create = 1;
8818: }
8819: }
8820: }
8821: }
8822: if ($can_create) {
8823: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
8824: unless (&allowed('ccc',$udom)) {
8825: return 'refused';
8826: }
8827: }
8828: } else {
8829: return 'refused';
8830: }
8831: } elsif (!&allowed('ccc',$udom)) {
8832: return 'refused';
8833: }
8834: # --------------------------------------------------------------- Get Unique ID
8835: my $uname;
8836: if ($cnum =~ /^$match_courseid$/) {
8837: my $chome=&homeserver($cnum,$udom,'true');
8838: if (($chome eq '') || ($chome eq 'no_host')) {
8839: $uname = $cnum;
8840: } else {
8841: $uname = &generate_coursenum($udom,$crstype);
8842: }
8843: } else {
8844: $uname = &generate_coursenum($udom,$crstype);
8845: }
8846: return $uname if ($uname =~ /^error/);
8847: # -------------------------------------------------- Check supplied server name
8848: if (!defined($course_server)) {
8849: if (defined(&domain($udom,'primary'))) {
8850: $course_server = &domain($udom,'primary');
8851: } else {
8852: $course_server = $env{'user.home'};
8853: }
8854: }
8855: my %host_servers =
8856: &Apache::lonnet::get_servers($udom,'library');
8857: unless ($host_servers{$course_server}) {
8858: return 'error: invalid home server for course: '.$course_server;
8859: }
8860: # ------------------------------------------------------------- Make the course
8861: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
8862: $course_server);
8863: unless ($reply eq 'ok') { return 'error: '.$reply; }
8864: my $uhome=&homeserver($uname,$udom,'true');
8865: if (($uhome eq '') || ($uhome eq 'no_host')) {
8866: return 'error: no such course';
8867: }
8868: # ----------------------------------------------------------------- Course made
8869: # log existence
8870: my $now = time;
8871: my $newcourse = {
8872: $udom.'_'.$uname => {
8873: description => $description,
8874: inst_code => $inst_code,
8875: owner => $course_owner,
8876: type => $crstype,
8877: creator => $env{'user.name'}.':'.
8878: $env{'user.domain'},
8879: created => $now,
8880: context => $context,
8881: },
8882: };
8883: &courseidput($udom,$newcourse,$uhome,'notime');
8884: # set toplevel url
8885: my $topurl=$url;
8886: unless ($nonstandard) {
8887: # ------------------------------------------ For standard courses, make top url
8888: my $mapurl=&clutter($url);
8889: if ($mapurl eq '/res/') { $mapurl=''; }
8890: $env{'form.initmap'}=(<<ENDINITMAP);
8891: <map>
8892: <resource id="1" type="start"></resource>
8893: <resource id="2" src="$mapurl"></resource>
8894: <resource id="3" type="finish"></resource>
8895: <link index="1" from="1" to="2"></link>
8896: <link index="2" from="2" to="3"></link>
8897: </map>
8898: ENDINITMAP
8899: $topurl=&declutter(
8900: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
8901: );
8902: }
8903: # ----------------------------------------------------------- Write preferences
8904: &writecoursepref($udom.'_'.$uname,
8905: ('description' => $description,
8906: 'url' => $topurl,
8907: 'internal.creator' => $env{'user.name'}.':'.
8908: $env{'user.domain'},
8909: 'internal.created' => $now,
8910: 'internal.creationcontext' => $context)
8911: );
8912: return '/'.$udom.'/'.$uname;
8913: }
8914:
8915: # ------------------------------------------------------------------- Create ID
8916: sub generate_coursenum {
8917: my ($udom,$crstype) = @_;
8918: my $domdesc = &domain($udom);
8919: return 'error: invalid domain' if ($domdesc eq '');
8920: my $first;
8921: if ($crstype eq 'Community') {
8922: $first = '0';
8923: } else {
8924: $first = int(1+rand(9));
8925: }
8926: my $uname=$first.
8927: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8928: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8929: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8930: # ----------------------------------------------- Make sure that does not exist
8931: my $uhome=&homeserver($uname,$udom,'true');
8932: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8933: if ($crstype eq 'Community') {
8934: $first = '0';
8935: } else {
8936: $first = int(1+rand(9));
8937: }
8938: $uname=$first.
8939: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8940: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8941: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8942: $uhome=&homeserver($uname,$udom,'true');
8943: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8944: return 'error: unable to generate unique course-ID';
8945: }
8946: }
8947: return $uname;
8948: }
8949:
8950: sub is_course {
8951: my ($cdom, $cnum) = scalar(@_) == 1 ?
8952: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
8953:
8954: return unless $cdom and $cnum;
8955:
8956: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
8957: '.');
8958:
8959: return unless(exists($courses{$cdom.'_'.$cnum}));
8960: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
8961: }
8962:
8963: sub store_userdata {
8964: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
8965: my $result;
8966: if ($datakey ne '') {
8967: if (ref($storehash) eq 'HASH') {
8968: if ($udom eq '' || $uname eq '') {
8969: $udom = $env{'user.domain'};
8970: $uname = $env{'user.name'};
8971: }
8972: my $uhome=&homeserver($uname,$udom);
8973: if (($uhome eq '') || ($uhome eq 'no_host')) {
8974: $result = 'error: no_host';
8975: } else {
8976: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
8977: $storehash->{'host'} = $perlvar{'lonHostID'};
8978:
8979: my $namevalue='';
8980: foreach my $key (keys(%{$storehash})) {
8981: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
8982: }
8983: $namevalue=~s/\&$//;
8984: unless ($namespace eq 'courserequests') {
8985: $datakey = &escape($datakey);
8986: }
8987: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
8988: $namevalue,$uhome);
8989: }
8990: } else {
8991: $result = 'error: data to store was not a hash reference';
8992: }
8993: } else {
8994: $result= 'error: invalid requestkey';
8995: }
8996: return $result;
8997: }
8998:
8999: # ---------------------------------------------------------- Assign Custom Role
9000:
9001: sub assigncustomrole {
9002: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
9003: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
9004: $end,$start,$deleteflag,$selfenroll,$context);
9005: }
9006:
9007: # ----------------------------------------------------------------- Revoke Role
9008:
9009: sub revokerole {
9010: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
9011: my $now=time;
9012: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
9013: }
9014:
9015: # ---------------------------------------------------------- Revoke Custom Role
9016:
9017: sub revokecustomrole {
9018: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
9019: my $now=time;
9020: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
9021: $deleteflag,$selfenroll,$context);
9022: }
9023:
9024: # ------------------------------------------------------------ Disk usage
9025: sub diskusage {
9026: my ($udom,$uname,$directorypath,$getpropath)=@_;
9027: $directorypath =~ s/\/$//;
9028: my $listing=&reply('du2:'.&escape($directorypath).':'
9029: .&escape($getpropath).':'.&escape($uname).':'
9030: .&escape($udom),homeserver($uname,$udom));
9031: if ($listing eq 'unknown_cmd') {
9032: if ($getpropath) {
9033: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9034: }
9035: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9036: }
9037: return $listing;
9038: }
9039:
9040: sub is_locked {
9041: my ($file_name, $domain, $user, $which) = @_;
9042: my @check;
9043: my $is_locked;
9044: push (@check,$file_name);
9045: my %locked = &get('file_permissions',\@check,
9046: $env{'user.domain'},$env{'user.name'});
9047: my ($tmp)=keys(%locked);
9048: if ($tmp=~/^error:/) { undef(%locked); }
9049:
9050: if (ref($locked{$file_name}) eq 'ARRAY') {
9051: $is_locked = 'false';
9052: foreach my $entry (@{$locked{$file_name}}) {
9053: if (ref($entry) eq 'ARRAY') {
9054: $is_locked = 'true';
9055: if (ref($which) eq 'ARRAY') {
9056: push(@{$which},$entry);
9057: } else {
9058: last;
9059: }
9060: }
9061: }
9062: } else {
9063: $is_locked = 'false';
9064: }
9065: return $is_locked;
9066: }
9067:
9068: sub declutter_portfile {
9069: my ($file) = @_;
9070: $file =~ s{^(/portfolio/|portfolio/)}{/};
9071: return $file;
9072: }
9073:
9074: # ------------------------------------------------------------- Mark as Read Only
9075:
9076: sub mark_as_readonly {
9077: my ($domain,$user,$files,$what) = @_;
9078: my %current_permissions = &dump('file_permissions',$domain,$user);
9079: my ($tmp)=keys(%current_permissions);
9080: if ($tmp=~/^error:/) { undef(%current_permissions); }
9081: foreach my $file (@{$files}) {
9082: $file = &declutter_portfile($file);
9083: push(@{$current_permissions{$file}},$what);
9084: }
9085: &put('file_permissions',\%current_permissions,$domain,$user);
9086: return;
9087: }
9088:
9089: # ------------------------------------------------------------Save Selected Files
9090:
9091: sub save_selected_files {
9092: my ($user, $path, @files) = @_;
9093: my $filename = $user."savedfiles";
9094: my @other_files = &files_not_in_path($user, $path);
9095: open (OUT, '>'.$tmpdir.$filename);
9096: foreach my $file (@files) {
9097: print (OUT $env{'form.currentpath'}.$file."\n");
9098: }
9099: foreach my $file (@other_files) {
9100: print (OUT $file."\n");
9101: }
9102: close (OUT);
9103: return 'ok';
9104: }
9105:
9106: sub clear_selected_files {
9107: my ($user) = @_;
9108: my $filename = $user."savedfiles";
9109: open (OUT, '>'.LONCAPA::tempdir().$filename);
9110: print (OUT undef);
9111: close (OUT);
9112: return ("ok");
9113: }
9114:
9115: sub files_in_path {
9116: my ($user, $path) = @_;
9117: my $filename = $user."savedfiles";
9118: my %return_files;
9119: open (IN, '<'.LONCAPA::tempdir().$filename);
9120: while (my $line_in = <IN>) {
9121: chomp ($line_in);
9122: my @paths_and_file = split (m!/!, $line_in);
9123: my $file_part = pop (@paths_and_file);
9124: my $path_part = join ('/', @paths_and_file);
9125: $path_part.='/';
9126: my $path_and_file = $path_part.$file_part;
9127: if ($path_part eq $path) {
9128: $return_files{$file_part}= 'selected';
9129: }
9130: }
9131: close (IN);
9132: return (\%return_files);
9133: }
9134:
9135: # called in portfolio select mode, to show files selected NOT in current directory
9136: sub files_not_in_path {
9137: my ($user, $path) = @_;
9138: my $filename = $user."savedfiles";
9139: my @return_files;
9140: my $path_part;
9141: open(IN, '<'.LONCAPA::.$filename);
9142: while (my $line = <IN>) {
9143: #ok, I know it's clunky, but I want it to work
9144: my @paths_and_file = split(m|/|, $line);
9145: my $file_part = pop(@paths_and_file);
9146: chomp($file_part);
9147: my $path_part = join('/', @paths_and_file);
9148: $path_part .= '/';
9149: my $path_and_file = $path_part.$file_part;
9150: if ($path_part ne $path) {
9151: push(@return_files, ($path_and_file));
9152: }
9153: }
9154: close(OUT);
9155: return (@return_files);
9156: }
9157:
9158: #----------------------------------------------Get portfolio file permissions
9159:
9160: sub get_portfile_permissions {
9161: my ($domain,$user) = @_;
9162: my %current_permissions = &dump('file_permissions',$domain,$user);
9163: my ($tmp)=keys(%current_permissions);
9164: if ($tmp=~/^error:/) { undef(%current_permissions); }
9165: return \%current_permissions;
9166: }
9167:
9168: #---------------------------------------------Get portfolio file access controls
9169:
9170: sub get_access_controls {
9171: my ($current_permissions,$group,$file) = @_;
9172: my %access;
9173: my $real_file = $file;
9174: $file =~ s/\.meta$//;
9175: if (defined($file)) {
9176: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9177: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
9178: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
9179: }
9180: }
9181: } else {
9182: foreach my $key (keys(%{$current_permissions})) {
9183: if ($key =~ /\0accesscontrol$/) {
9184: if (defined($group)) {
9185: if ($key !~ m-^\Q$group\E/-) {
9186: next;
9187: }
9188: }
9189: my ($fullpath) = split(/\0/,$key);
9190: if (ref($$current_permissions{$key}) eq 'HASH') {
9191: foreach my $control (keys(%{$$current_permissions{$key}})) {
9192: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9193: }
9194: }
9195: }
9196: }
9197: }
9198: return %access;
9199: }
9200:
9201: sub modify_access_controls {
9202: my ($file_name,$changes,$domain,$user)=@_;
9203: my ($outcome,$deloutcome);
9204: my %store_permissions;
9205: my %new_values;
9206: my %new_control;
9207: my %translation;
9208: my @deletions = ();
9209: my $now = time;
9210: if (exists($$changes{'activate'})) {
9211: if (ref($$changes{'activate'}) eq 'HASH') {
9212: my @newitems = sort(keys(%{$$changes{'activate'}}));
9213: my $numnew = scalar(@newitems);
9214: for (my $i=0; $i<$numnew; $i++) {
9215: my $newkey = $newitems[$i];
9216: my $newid = &Apache::loncommon::get_cgi_id();
9217: if ($newkey =~ /^\d+:/) {
9218: $newkey =~ s/^(\d+)/$newid/;
9219: $translation{$1} = $newid;
9220: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9221: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9222: $translation{$1} = $newid;
9223: }
9224: $new_values{$file_name."\0".$newkey} =
9225: $$changes{'activate'}{$newitems[$i]};
9226: $new_control{$newkey} = $now;
9227: }
9228: }
9229: }
9230: my %todelete;
9231: my %changed_items;
9232: foreach my $action ('delete','update') {
9233: if (exists($$changes{$action})) {
9234: if (ref($$changes{$action}) eq 'HASH') {
9235: foreach my $key (keys(%{$$changes{$action}})) {
9236: my ($itemnum) = ($key =~ /^([^:]+):/);
9237: if ($action eq 'delete') {
9238: $todelete{$itemnum} = 1;
9239: } else {
9240: $changed_items{$itemnum} = $key;
9241: }
9242: }
9243: }
9244: }
9245: }
9246: # get lock on access controls for file.
9247: my $lockhash = {
9248: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9249: ':'.$env{'user.domain'},
9250: };
9251: my $tries = 0;
9252: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9253:
9254: while (($gotlock ne 'ok') && $tries <3) {
9255: $tries ++;
9256: sleep 1;
9257: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9258: }
9259: if ($gotlock eq 'ok') {
9260: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9261: my ($tmp)=keys(%curr_permissions);
9262: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9263: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9264: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9265: if (ref($curr_controls) eq 'HASH') {
9266: foreach my $control_item (keys(%{$curr_controls})) {
9267: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9268: if (defined($todelete{$itemnum})) {
9269: push(@deletions,$file_name."\0".$control_item);
9270: } else {
9271: if (defined($changed_items{$itemnum})) {
9272: $new_control{$changed_items{$itemnum}} = $now;
9273: push(@deletions,$file_name."\0".$control_item);
9274: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9275: } else {
9276: $new_control{$control_item} = $$curr_controls{$control_item};
9277: }
9278: }
9279: }
9280: }
9281: }
9282: my ($group);
9283: if (&is_course($domain,$user)) {
9284: ($group,my $file) = split(/\//,$file_name,2);
9285: }
9286: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9287: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9288: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9289: # remove lock
9290: my @del_lock = ($file_name."\0".'locked_access_records');
9291: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
9292: my $sqlresult =
9293: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
9294: $group);
9295: } else {
9296: $outcome = "error: could not obtain lockfile\n";
9297: }
9298: return ($outcome,$deloutcome,\%new_values,\%translation);
9299: }
9300:
9301: sub make_public_indefinitely {
9302: my ($requrl) = @_;
9303: my $now = time;
9304: my $action = 'activate';
9305: my $aclnum = 0;
9306: if (&is_portfolio_url($requrl)) {
9307: my (undef,$udom,$unum,$file_name,$group) =
9308: &parse_portfolio_url($requrl);
9309: my $current_perms = &get_portfile_permissions($udom,$unum);
9310: my %access_controls = &get_access_controls($current_perms,
9311: $group,$file_name);
9312: foreach my $key (keys(%{$access_controls{$file_name}})) {
9313: my ($num,$scope,$end,$start) =
9314: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9315: if ($scope eq 'public') {
9316: if ($start <= $now && $end == 0) {
9317: $action = 'none';
9318: } else {
9319: $action = 'update';
9320: $aclnum = $num;
9321: }
9322: last;
9323: }
9324: }
9325: if ($action eq 'none') {
9326: return 'ok';
9327: } else {
9328: my %changes;
9329: my $newend = 0;
9330: my $newstart = $now;
9331: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
9332: $changes{$action}{$newkey} = {
9333: type => 'public',
9334: time => {
9335: start => $newstart,
9336: end => $newend,
9337: },
9338: };
9339: my ($outcome,$deloutcome,$new_values,$translation) =
9340: &modify_access_controls($file_name,\%changes,$udom,$unum);
9341: return $outcome;
9342: }
9343: } else {
9344: return 'invalid';
9345: }
9346: }
9347:
9348: #------------------------------------------------------Get Marked as Read Only
9349:
9350: sub get_marked_as_readonly {
9351: my ($domain,$user,$what,$group) = @_;
9352: my $current_permissions = &get_portfile_permissions($domain,$user);
9353: my @readonly_files;
9354: my $cmp1=$what;
9355: if (ref($what)) { $cmp1=join('',@{$what}) };
9356: while (my ($file_name,$value) = each(%{$current_permissions})) {
9357: if (defined($group)) {
9358: if ($file_name !~ m-^\Q$group\E/-) {
9359: next;
9360: }
9361: }
9362: if (ref($value) eq "ARRAY"){
9363: foreach my $stored_what (@{$value}) {
9364: my $cmp2=$stored_what;
9365: if (ref($stored_what) eq 'ARRAY') {
9366: $cmp2=join('',@{$stored_what});
9367: }
9368: if ($cmp1 eq $cmp2) {
9369: push(@readonly_files, $file_name);
9370: last;
9371: } elsif (!defined($what)) {
9372: push(@readonly_files, $file_name);
9373: last;
9374: }
9375: }
9376: }
9377: }
9378: return @readonly_files;
9379: }
9380: #-----------------------------------------------------------Get Marked as Read Only Hash
9381:
9382: sub get_marked_as_readonly_hash {
9383: my ($current_permissions,$group,$what) = @_;
9384: my %readonly_files;
9385: while (my ($file_name,$value) = each(%{$current_permissions})) {
9386: if (defined($group)) {
9387: if ($file_name !~ m-^\Q$group\E/-) {
9388: next;
9389: }
9390: }
9391: if (ref($value) eq "ARRAY"){
9392: foreach my $stored_what (@{$value}) {
9393: if (ref($stored_what) eq 'ARRAY') {
9394: foreach my $lock_descriptor(@{$stored_what}) {
9395: if ($lock_descriptor eq 'graded') {
9396: $readonly_files{$file_name} = 'graded';
9397: } elsif ($lock_descriptor eq 'handback') {
9398: $readonly_files{$file_name} = 'handback';
9399: } else {
9400: if (!exists($readonly_files{$file_name})) {
9401: $readonly_files{$file_name} = 'locked';
9402: }
9403: }
9404: }
9405: }
9406: }
9407: }
9408: }
9409: return %readonly_files;
9410: }
9411: # ------------------------------------------------------------ Unmark as Read Only
9412:
9413: sub unmark_as_readonly {
9414: # unmarks $file_name (if $file_name is defined), or all files locked by $what
9415: # for portfolio submissions, $what contains [$symb,$crsid]
9416: my ($domain,$user,$what,$file_name,$group) = @_;
9417: $file_name = &declutter_portfile($file_name);
9418: my $symb_crs = $what;
9419: if (ref($what)) { $symb_crs=join('',@$what); }
9420: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
9421: my ($tmp)=keys(%current_permissions);
9422: if ($tmp=~/^error:/) { undef(%current_permissions); }
9423: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
9424: foreach my $file (@readonly_files) {
9425: my $clean_file = &declutter_portfile($file);
9426: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
9427: my $current_locks = $current_permissions{$file};
9428: my @new_locks;
9429: my @del_keys;
9430: if (ref($current_locks) eq "ARRAY"){
9431: foreach my $locker (@{$current_locks}) {
9432: my $compare=$locker;
9433: if (ref($locker) eq 'ARRAY') {
9434: $compare=join('',@{$locker});
9435: if ($compare ne $symb_crs) {
9436: push(@new_locks, $locker);
9437: }
9438: }
9439: }
9440: if (scalar(@new_locks) > 0) {
9441: $current_permissions{$file} = \@new_locks;
9442: } else {
9443: push(@del_keys, $file);
9444: &del('file_permissions',\@del_keys, $domain, $user);
9445: delete($current_permissions{$file});
9446: }
9447: }
9448: }
9449: &put('file_permissions',\%current_permissions,$domain,$user);
9450: return;
9451: }
9452:
9453: # ------------------------------------------------------------ Directory lister
9454:
9455: sub dirlist {
9456: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
9457: $uri=~s/^\///;
9458: $uri=~s/\/$//;
9459: my ($udom, $uname);
9460: if ($getuserdir) {
9461: $udom = $userdomain;
9462: $uname = $username;
9463: } else {
9464: (undef,$udom,$uname)=split(/\//,$uri);
9465: if(defined($userdomain)) {
9466: $udom = $userdomain;
9467: }
9468: if(defined($username)) {
9469: $uname = $username;
9470: }
9471: }
9472: my ($dirRoot,$listing,@listing_results);
9473:
9474: $dirRoot = $perlvar{'lonDocRoot'};
9475: if (defined($getpropath)) {
9476: $dirRoot = &propath($udom,$uname);
9477: $dirRoot =~ s/\/$//;
9478: } elsif (defined($getuserdir)) {
9479: my $subdir=$uname.'__';
9480: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
9481: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
9482: ."/$udom/$subdir/$uname";
9483: } elsif (defined($alternateRoot)) {
9484: $dirRoot = $alternateRoot;
9485: }
9486:
9487: if($udom) {
9488: if($uname) {
9489: my $uhome = &homeserver($uname,$udom);
9490: if ($uhome eq 'no_host') {
9491: return ([],'no_host');
9492: }
9493: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
9494: .$getuserdir.':'.&escape($dirRoot)
9495: .':'.&escape($uname).':'.&escape($udom),$uhome);
9496: if ($listing eq 'unknown_cmd') {
9497: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
9498: } else {
9499: @listing_results = map { &unescape($_); } split(/:/,$listing);
9500: }
9501: if ($listing eq 'unknown_cmd') {
9502: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
9503: @listing_results = split(/:/,$listing);
9504: } else {
9505: @listing_results = map { &unescape($_); } split(/:/,$listing);
9506: }
9507: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
9508: ($listing eq 'rejected') || ($listing eq 'refused') ||
9509: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9510: return ([],$listing);
9511: } else {
9512: return (\@listing_results);
9513: }
9514: } elsif(!$alternateRoot) {
9515: my (%allusers,%listerror);
9516: my %servers = &get_servers($udom,'library');
9517: foreach my $tryserver (keys(%servers)) {
9518: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
9519: &escape($udom),$tryserver);
9520: if ($listing eq 'unknown_cmd') {
9521: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
9522: $udom, $tryserver);
9523: } else {
9524: @listing_results = map { &unescape($_); } split(/:/,$listing);
9525: }
9526: if ($listing eq 'unknown_cmd') {
9527: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
9528: $udom, $tryserver);
9529: @listing_results = split(/:/,$listing);
9530: } else {
9531: @listing_results =
9532: map { &unescape($_); } split(/:/,$listing);
9533: }
9534: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
9535: ($listing eq 'rejected') || ($listing eq 'refused') ||
9536: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9537: $listerror{$tryserver} = $listing;
9538: } else {
9539: foreach my $line (@listing_results) {
9540: my ($entry) = split(/&/,$line,2);
9541: $allusers{$entry} = 1;
9542: }
9543: }
9544: }
9545: my @alluserslist=();
9546: foreach my $user (sort(keys(%allusers))) {
9547: push(@alluserslist,$user.'&user');
9548: }
9549: return (\@alluserslist);
9550: } else {
9551: return ([],'missing username');
9552: }
9553: } elsif(!defined($getpropath)) {
9554: my $path = $perlvar{'lonDocRoot'}.'/res/';
9555: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
9556: return (\@all_domains);
9557: } else {
9558: return ([],'missing domain');
9559: }
9560: }
9561:
9562: # --------------------------------------------- GetFileTimestamp
9563: # This function utilizes dirlist and returns the date stamp for
9564: # when it was last modified. It will also return an error of -1
9565: # if an error occurs
9566:
9567: sub GetFileTimestamp {
9568: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
9569: $studentDomain = &LONCAPA::clean_domain($studentDomain);
9570: $studentName = &LONCAPA::clean_username($studentName);
9571: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
9572: undef,$getuserdir);
9573: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9574: return -1;
9575: }
9576: if (ref($fileref) eq 'ARRAY') {
9577: my @stats = split('&',$fileref->[0]);
9578: # @stats contains first the filename, then the stat output
9579: return $stats[10]; # so this is 10 instead of 9.
9580: } else {
9581: return -1;
9582: }
9583: }
9584:
9585: sub stat_file {
9586: my ($uri) = @_;
9587: $uri = &clutter_with_no_wrapper($uri);
9588:
9589: my ($udom,$uname,$file);
9590: if ($uri =~ m-^/(uploaded|editupload)/-) {
9591: ($udom,$uname,$file) =
9592: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
9593: $file = 'userfiles/'.$file;
9594: }
9595: if ($uri =~ m-^/res/-) {
9596: ($udom,$uname) =
9597: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
9598: $file = $uri;
9599: }
9600:
9601: if (!$udom || !$uname || !$file) {
9602: # unable to handle the uri
9603: return ();
9604: }
9605: my $getpropath;
9606: if ($file =~ /^userfiles\//) {
9607: $getpropath = 1;
9608: }
9609: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
9610: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9611: return ();
9612: } else {
9613: if (ref($listref) eq 'ARRAY') {
9614: my @stats = split('&',$listref->[0]);
9615: shift(@stats); #filename is first
9616: return @stats;
9617: }
9618: }
9619: return ();
9620: }
9621:
9622: # -------------------------------------------------------- Value of a Condition
9623:
9624: # gets the value of a specific preevaluated condition
9625: # stored in the string $env{user.state.<cid>}
9626: # or looks up a condition reference in the bighash and if if hasn't
9627: # already been evaluated recurses into docondval to get the value of
9628: # the condition, then memoizing it to
9629: # $env{user.state.<cid>.<condition>}
9630: sub directcondval {
9631: my $number=shift;
9632: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
9633: &Apache::lonuserstate::evalstate();
9634: }
9635: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
9636: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
9637: } elsif ($number =~ /^_/) {
9638: my $sub_condition;
9639: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9640: &GDBM_READER(),0640)) {
9641: $sub_condition=$bighash{'conditions'.$number};
9642: untie(%bighash);
9643: }
9644: my $value = &docondval($sub_condition);
9645: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
9646: return $value;
9647: }
9648: if ($env{'user.state.'.$env{'request.course.id'}}) {
9649: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
9650: } else {
9651: return 2;
9652: }
9653: }
9654:
9655: # get the collection of conditions for this resource
9656: sub condval {
9657: my $condidx=shift;
9658: my $allpathcond='';
9659: foreach my $cond (split(/\|/,$condidx)) {
9660: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
9661: $allpathcond.=
9662: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
9663: }
9664: }
9665: $allpathcond=~s/\|$//;
9666: return &docondval($allpathcond);
9667: }
9668:
9669: #evaluates an expression of conditions
9670: sub docondval {
9671: my ($allpathcond) = @_;
9672: my $result=0;
9673: if ($env{'request.course.id'}
9674: && defined($allpathcond)) {
9675: my $operand='|';
9676: my @stack;
9677: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
9678: if ($chunk eq '(') {
9679: push @stack,($operand,$result);
9680: } elsif ($chunk eq ')') {
9681: my $before=pop @stack;
9682: if (pop @stack eq '&') {
9683: $result=$result>$before?$before:$result;
9684: } else {
9685: $result=$result>$before?$result:$before;
9686: }
9687: } elsif (($chunk eq '&') || ($chunk eq '|')) {
9688: $operand=$chunk;
9689: } else {
9690: my $new=directcondval($chunk);
9691: if ($operand eq '&') {
9692: $result=$result>$new?$new:$result;
9693: } else {
9694: $result=$result>$new?$result:$new;
9695: }
9696: }
9697: }
9698: }
9699: return $result;
9700: }
9701:
9702: # ---------------------------------------------------- Devalidate courseresdata
9703:
9704: sub devalidatecourseresdata {
9705: my ($coursenum,$coursedomain)=@_;
9706: my $hashid=$coursenum.':'.$coursedomain;
9707: &devalidate_cache_new('courseres',$hashid);
9708: }
9709:
9710:
9711: # --------------------------------------------------- Course Resourcedata Query
9712: #
9713: # Parameters:
9714: # $coursenum - Number of the course.
9715: # $coursedomain - Domain at which the course was created.
9716: # Returns:
9717: # A hash of the course parameters along (I think) with timestamps
9718: # and version info.
9719:
9720: sub get_courseresdata {
9721: my ($coursenum,$coursedomain)=@_;
9722: my $coursehom=&homeserver($coursenum,$coursedomain);
9723: my $hashid=$coursenum.':'.$coursedomain;
9724: my ($result,$cached)=&is_cached_new('courseres',$hashid);
9725: my %dumpreply;
9726: unless (defined($cached)) {
9727: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
9728: $result=\%dumpreply;
9729: my ($tmp) = keys(%dumpreply);
9730: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9731: &do_cache_new('courseres',$hashid,$result,600);
9732: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
9733: return $tmp;
9734: } elsif ($tmp =~ /^(error)/) {
9735: $result=undef;
9736: &do_cache_new('courseres',$hashid,$result,600);
9737: }
9738: }
9739: return $result;
9740: }
9741:
9742: sub devalidateuserresdata {
9743: my ($uname,$udom)=@_;
9744: my $hashid="$udom:$uname";
9745: &devalidate_cache_new('userres',$hashid);
9746: }
9747:
9748: sub get_userresdata {
9749: my ($uname,$udom)=@_;
9750: #most student don\'t have any data set, check if there is some data
9751: if (&EXT_cache_status($udom,$uname)) { return undef; }
9752:
9753: my $hashid="$udom:$uname";
9754: my ($result,$cached)=&is_cached_new('userres',$hashid);
9755: if (!defined($cached)) {
9756: my %resourcedata=&dump('resourcedata',$udom,$uname);
9757: $result=\%resourcedata;
9758: &do_cache_new('userres',$hashid,$result,600);
9759: }
9760: my ($tmp)=keys(%$result);
9761: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
9762: return $result;
9763: }
9764: #error 2 occurs when the .db doesn't exist
9765: if ($tmp!~/error: 2 /) {
9766: &logthis("<font color=\"blue\">WARNING:".
9767: " Trying to get resource data for ".
9768: $uname." at ".$udom.": ".
9769: $tmp."</font>");
9770: } elsif ($tmp=~/error: 2 /) {
9771: #&EXT_cache_set($udom,$uname);
9772: &do_cache_new('userres',$hashid,undef,600);
9773: undef($tmp); # not really an error so don't send it back
9774: }
9775: return $tmp;
9776: }
9777: #----------------------------------------------- resdata - return resource data
9778: # Purpose:
9779: # Return resource data for either users or for a course.
9780: # Parameters:
9781: # $name - Course/user name.
9782: # $domain - Name of the domain the user/course is registered on.
9783: # $type - Type of thing $name is (must be 'course' or 'user'
9784: # @which - Array of names of resources desired.
9785: # Returns:
9786: # The value of the first reasource in @which that is found in the
9787: # resource hash.
9788: # Exceptional Conditions:
9789: # If the $type passed in is not valid (not the string 'course' or
9790: # 'user', an undefined reference is returned.
9791: # If none of the resources are found, an undef is returned
9792: sub resdata {
9793: my ($name,$domain,$type,@which)=@_;
9794: my $result;
9795: if ($type eq 'course') {
9796: $result=&get_courseresdata($name,$domain);
9797: } elsif ($type eq 'user') {
9798: $result=&get_userresdata($name,$domain);
9799: }
9800: if (!ref($result)) { return $result; }
9801: foreach my $item (@which) {
9802: if (defined($result->{$item->[0]})) {
9803: return [$result->{$item->[0]},$item->[1]];
9804: }
9805: }
9806: return undef;
9807: }
9808:
9809: sub get_numsuppfiles {
9810: my ($cnum,$cdom,$ignorecache)=@_;
9811: my $hashid=$cnum.':'.$cdom;
9812: my ($suppcount,$cached);
9813: unless ($ignorecache) {
9814: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
9815: }
9816: unless (defined($cached)) {
9817: my $chome=&homeserver($cnum,$cdom);
9818: unless ($chome eq 'no_host') {
9819: ($suppcount,my $errors) = (0,0);
9820: my $suppmap = 'supplemental.sequence';
9821: ($suppcount,$errors) =
9822: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
9823: }
9824: &do_cache_new('suppcount',$hashid,$suppcount,600);
9825: }
9826: return $suppcount;
9827: }
9828:
9829: #
9830: # EXT resource caching routines
9831: #
9832:
9833: sub clear_EXT_cache_status {
9834: &delenv('cache.EXT.');
9835: }
9836:
9837: sub EXT_cache_status {
9838: my ($target_domain,$target_user) = @_;
9839: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
9840: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
9841: # We know already the user has no data
9842: return 1;
9843: } else {
9844: return 0;
9845: }
9846: }
9847:
9848: sub EXT_cache_set {
9849: my ($target_domain,$target_user) = @_;
9850: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
9851: #&appenv({$cachename => time});
9852: }
9853:
9854: # --------------------------------------------------------- Value of a Variable
9855: sub EXT {
9856:
9857: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
9858: unless ($varname) { return ''; }
9859: #get real user name/domain, courseid and symb
9860: my $courseid;
9861: my $publicuser;
9862: if ($symbparm) {
9863: $symbparm=&get_symb_from_alias($symbparm);
9864: }
9865: if (!($uname && $udom)) {
9866: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
9867: if (!$symbparm) { $symbparm=$cursymb; }
9868: } else {
9869: $courseid=$env{'request.course.id'};
9870: }
9871: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
9872: my $rest;
9873: if (defined($therest[0])) {
9874: $rest=join('.',@therest);
9875: } else {
9876: $rest='';
9877: }
9878:
9879: my $qualifierrest=$qualifier;
9880: if ($rest) { $qualifierrest.='.'.$rest; }
9881: my $spacequalifierrest=$space;
9882: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
9883: if ($realm eq 'user') {
9884: # --------------------------------------------------------------- user.resource
9885: if ($space eq 'resource') {
9886: if ( (defined($Apache::lonhomework::parsing_a_problem)
9887: || defined($Apache::lonhomework::parsing_a_task))
9888: &&
9889: ($symbparm eq &symbread()) ) {
9890: # if we are in the middle of processing the resource the
9891: # get the value we are planning on committing
9892: if (defined($Apache::lonhomework::results{$qualifierrest})) {
9893: return $Apache::lonhomework::results{$qualifierrest};
9894: } else {
9895: return $Apache::lonhomework::history{$qualifierrest};
9896: }
9897: } else {
9898: my %restored;
9899: if ($publicuser || $env{'request.state'} eq 'construct') {
9900: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
9901: } else {
9902: %restored=&restore($symbparm,$courseid,$udom,$uname);
9903: }
9904: return $restored{$qualifierrest};
9905: }
9906: # ----------------------------------------------------------------- user.access
9907: } elsif ($space eq 'access') {
9908: # FIXME - not supporting calls for a specific user
9909: return &allowed($qualifier,$rest);
9910: # ------------------------------------------ user.preferences, user.environment
9911: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
9912: if (($uname eq $env{'user.name'}) &&
9913: ($udom eq $env{'user.domain'})) {
9914: return $env{join('.',('environment',$qualifierrest))};
9915: } else {
9916: my %returnhash;
9917: if (!$publicuser) {
9918: %returnhash=&userenvironment($udom,$uname,
9919: $qualifierrest);
9920: }
9921: return $returnhash{$qualifierrest};
9922: }
9923: # ----------------------------------------------------------------- user.course
9924: } elsif ($space eq 'course') {
9925: # FIXME - not supporting calls for a specific user
9926: return $env{join('.',('request.course',$qualifier))};
9927: # ------------------------------------------------------------------- user.role
9928: } elsif ($space eq 'role') {
9929: # FIXME - not supporting calls for a specific user
9930: my ($role,$where)=split(/\./,$env{'request.role'});
9931: if ($qualifier eq 'value') {
9932: return $role;
9933: } elsif ($qualifier eq 'extent') {
9934: return $where;
9935: }
9936: # ----------------------------------------------------------------- user.domain
9937: } elsif ($space eq 'domain') {
9938: return $udom;
9939: # ------------------------------------------------------------------- user.name
9940: } elsif ($space eq 'name') {
9941: return $uname;
9942: # ---------------------------------------------------- Any other user namespace
9943: } else {
9944: my %reply;
9945: if (!$publicuser) {
9946: %reply=&get($space,[$qualifierrest],$udom,$uname);
9947: }
9948: return $reply{$qualifierrest};
9949: }
9950: } elsif ($realm eq 'query') {
9951: # ---------------------------------------------- pull stuff out of query string
9952: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
9953: [$spacequalifierrest]);
9954: return $env{'form.'.$spacequalifierrest};
9955: } elsif ($realm eq 'request') {
9956: # ------------------------------------------------------------- request.browser
9957: if ($space eq 'browser') {
9958: return $env{'browser.'.$qualifier};
9959: # ------------------------------------------------------------ request.filename
9960: } else {
9961: return $env{'request.'.$spacequalifierrest};
9962: }
9963: } elsif ($realm eq 'course') {
9964: # ---------------------------------------------------------- course.description
9965: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
9966: } elsif ($realm eq 'resource') {
9967:
9968: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
9969: if (!$symbparm) { $symbparm=&symbread(); }
9970: }
9971:
9972: if ($qualifier eq '') {
9973: if ($space eq 'title') {
9974: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
9975: return &gettitle($symbparm);
9976: }
9977:
9978: if ($space eq 'map') {
9979: my ($map) = &decode_symb($symbparm);
9980: return &symbread($map);
9981: }
9982: if ($space eq 'maptitle') {
9983: my ($map) = &decode_symb($symbparm);
9984: return &gettitle($map);
9985: }
9986: if ($space eq 'filename') {
9987: if ($symbparm) {
9988: return &clutter((&decode_symb($symbparm))[2]);
9989: }
9990: return &hreflocation('',$env{'request.filename'});
9991: }
9992:
9993: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
9994: if ($space eq 'visibleparts') {
9995: my $navmap = Apache::lonnavmaps::navmap->new();
9996: my $item;
9997: if (ref($navmap)) {
9998: my $res = $navmap->getBySymb($symbparm);
9999: my $parts = $res->parts();
10000: if (ref($parts) eq 'ARRAY') {
10001: $item = join(',',@{$parts});
10002: }
10003: undef($navmap);
10004: }
10005: return $item;
10006: }
10007: }
10008: }
10009:
10010: my ($section, $group, @groups);
10011: my ($courselevelm,$courselevel);
10012: if (($courseid eq '') && ($cid)) {
10013: $courseid = $cid;
10014: }
10015: if (($symbparm && $courseid) &&
10016: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
10017:
10018: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
10019:
10020: # ----------------------------------------------------- Cascading lookup scheme
10021: my $symbp=$symbparm;
10022: my $mapp=&deversion((&decode_symb($symbp))[0]);
10023:
10024: my $symbparm=$symbp.'.'.$spacequalifierrest;
10025: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10026:
10027: if (($env{'user.name'} eq $uname) &&
10028: ($env{'user.domain'} eq $udom)) {
10029: $section=$env{'request.course.sec'};
10030: @groups = split(/:/,$env{'request.course.groups'});
10031: @groups=&sort_course_groups($courseid,@groups);
10032: } else {
10033: if (! defined($usection)) {
10034: $section=&getsection($udom,$uname,$courseid);
10035: } else {
10036: $section = $usection;
10037: }
10038: @groups = &get_users_groups($udom,$uname,$courseid);
10039: }
10040:
10041: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10042: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10043: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10044:
10045: $courselevel=$courseid.'.'.$spacequalifierrest;
10046: my $courselevelr=$courseid.'.'.$symbparm;
10047: $courselevelm=$courseid.'.'.$mapparm;
10048:
10049: # ----------------------------------------------------------- first, check user
10050:
10051: my $userreply=&resdata($uname,$udom,'user',
10052: ([$courselevelr,'resource'],
10053: [$courselevelm,'map' ],
10054: [$courselevel, 'course' ]));
10055: if (defined($userreply)) { return &get_reply($userreply); }
10056:
10057: # ------------------------------------------------ second, check some of course
10058: my $coursereply;
10059: if (@groups > 0) {
10060: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10061: $mapparm,$spacequalifierrest);
10062: if (defined($coursereply)) { return &get_reply($coursereply); }
10063: }
10064:
10065: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10066: $env{'course.'.$courseid.'.domain'},
10067: 'course',
10068: ([$seclevelr, 'resource'],
10069: [$seclevelm, 'map' ],
10070: [$seclevel, 'course' ],
10071: [$courselevelr,'resource']));
10072: if (defined($coursereply)) { return &get_reply($coursereply); }
10073:
10074: # ------------------------------------------------------ third, check map parms
10075: my %parmhash=();
10076: my $thisparm='';
10077: if (tie(%parmhash,'GDBM_File',
10078: $env{'request.course.fn'}.'_parms.db',
10079: &GDBM_READER(),0640)) {
10080: $thisparm=$parmhash{$symbparm};
10081: untie(%parmhash);
10082: }
10083: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
10084: }
10085: # ------------------------------------------ fourth, look in resource metadata
10086:
10087: $spacequalifierrest=~s/\./\_/;
10088: my $filename;
10089: if (!$symbparm) { $symbparm=&symbread(); }
10090: if ($symbparm) {
10091: $filename=(&decode_symb($symbparm))[2];
10092: } else {
10093: $filename=$env{'request.filename'};
10094: }
10095: my $metadata=&metadata($filename,$spacequalifierrest);
10096: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10097: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
10098: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10099:
10100: # ---------------------------------------------- fourth, look in rest of course
10101: if ($symbparm && defined($courseid) &&
10102: $courseid eq $env{'request.course.id'}) {
10103: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10104: $env{'course.'.$courseid.'.domain'},
10105: 'course',
10106: ([$courselevelm,'map' ],
10107: [$courselevel, 'course']));
10108: if (defined($coursereply)) { return &get_reply($coursereply); }
10109: }
10110: # ------------------------------------------------------------------ Cascade up
10111: unless ($space eq '0') {
10112: my @parts=split(/_/,$space);
10113: my $id=pop(@parts);
10114: my $part=join('_',@parts);
10115: if ($part eq '') { $part='0'; }
10116: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
10117: $symbparm,$udom,$uname,$section,1);
10118: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
10119: }
10120: if ($recurse) { return undef; }
10121: my $pack_def=&packages_tab_default($filename,$varname);
10122: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
10123: # ---------------------------------------------------- Any other user namespace
10124: } elsif ($realm eq 'environment') {
10125: # ----------------------------------------------------------------- environment
10126: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10127: return $env{'environment.'.$spacequalifierrest};
10128: } else {
10129: if ($uname eq 'anonymous' && $udom eq '') {
10130: return '';
10131: }
10132: my %returnhash=&userenvironment($udom,$uname,
10133: $spacequalifierrest);
10134: return $returnhash{$spacequalifierrest};
10135: }
10136: } elsif ($realm eq 'system') {
10137: # ----------------------------------------------------------------- system.time
10138: if ($space eq 'time') {
10139: return time;
10140: }
10141: } elsif ($realm eq 'server') {
10142: # ----------------------------------------------------------------- system.time
10143: if ($space eq 'name') {
10144: return $ENV{'SERVER_NAME'};
10145: }
10146: }
10147: return '';
10148: }
10149:
10150: sub get_reply {
10151: my ($reply_value) = @_;
10152: if (ref($reply_value) eq 'ARRAY') {
10153: if (wantarray) {
10154: return @$reply_value;
10155: }
10156: return $reply_value->[0];
10157: } else {
10158: return $reply_value;
10159: }
10160: }
10161:
10162: sub check_group_parms {
10163: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
10164: my @groupitems = ();
10165: my $resultitem;
10166: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
10167: foreach my $group (@{$groups}) {
10168: foreach my $level (@levels) {
10169: my $item = $courseid.'.['.$group.'].'.$level->[0];
10170: push(@groupitems,[$item,$level->[1]]);
10171: }
10172: }
10173: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10174: $env{'course.'.$courseid.'.domain'},
10175: 'course',@groupitems);
10176: return $coursereply;
10177: }
10178:
10179: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
10180: my ($courseid,@groups) = @_;
10181: @groups = sort(@groups);
10182: return @groups;
10183: }
10184:
10185: sub packages_tab_default {
10186: my ($uri,$varname)=@_;
10187: my (undef,$part,$name)=split(/\./,$varname);
10188:
10189: my (@extension,@specifics,$do_default);
10190: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
10191: my ($pack_type,$pack_part)=split(/_/,$package,2);
10192: if ($pack_type eq 'default') {
10193: $do_default=1;
10194: } elsif ($pack_type eq 'extension') {
10195: push(@extension,[$package,$pack_type,$pack_part]);
10196: } elsif ($pack_part eq $part || $pack_type eq 'part') {
10197: # only look at packages defaults for packages that this id is
10198: push(@specifics,[$package,$pack_type,$pack_part]);
10199: }
10200: }
10201: # first look for a package that matches the requested part id
10202: foreach my $package (@specifics) {
10203: my (undef,$pack_type,$pack_part)=@{$package};
10204: next if ($pack_part ne $part);
10205: if (defined($packagetab{"$pack_type&$name&default"})) {
10206: return $packagetab{"$pack_type&$name&default"};
10207: }
10208: }
10209: # look for any possible matching non extension_ package
10210: foreach my $package (@specifics) {
10211: my (undef,$pack_type,$pack_part)=@{$package};
10212: if (defined($packagetab{"$pack_type&$name&default"})) {
10213: return $packagetab{"$pack_type&$name&default"};
10214: }
10215: if ($pack_type eq 'part') { $pack_part='0'; }
10216: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10217: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
10218: }
10219: }
10220: # look for any posible extension_ match
10221: foreach my $package (@extension) {
10222: my ($package,$pack_type)=@{$package};
10223: if (defined($packagetab{"$pack_type&$name&default"})) {
10224: return $packagetab{"$pack_type&$name&default"};
10225: }
10226: if (defined($packagetab{$package."&$name&default"})) {
10227: return $packagetab{$package."&$name&default"};
10228: }
10229: }
10230: # look for a global default setting
10231: if ($do_default && defined($packagetab{"default&$name&default"})) {
10232: return $packagetab{"default&$name&default"};
10233: }
10234: return undef;
10235: }
10236:
10237: sub add_prefix_and_part {
10238: my ($prefix,$part)=@_;
10239: my $keyroot;
10240: if (defined($prefix) && $prefix !~ /^__/) {
10241: # prefix that has a part already
10242: $keyroot=$prefix;
10243: } elsif (defined($prefix)) {
10244: # prefix that is missing a part
10245: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10246: } else {
10247: # no prefix at all
10248: if (defined($part)) { $keyroot='_'.$part; }
10249: }
10250: return $keyroot;
10251: }
10252:
10253: # ---------------------------------------------------------------- Get metadata
10254:
10255: my %metaentry;
10256: my %importedpartids;
10257: sub metadata {
10258: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
10259: $uri=&declutter($uri);
10260: # if it is a non metadata possible uri return quickly
10261: if (($uri eq '') ||
10262: (($uri =~ m|^/*adm/|) &&
10263: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
10264: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
10265: return undef;
10266: }
10267: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
10268: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
10269: return undef;
10270: }
10271: my $filename=$uri;
10272: $uri=~s/\.meta$//;
10273: #
10274: # Is the metadata already cached?
10275: # Look at timestamp of caching
10276: # Everything is cached by the main uri, libraries are never directly cached
10277: #
10278: if (!defined($liburi)) {
10279: my ($result,$cached)=&is_cached_new('meta',$uri);
10280: if (defined($cached)) { return $result->{':'.$what}; }
10281: }
10282: {
10283: # Imported parts would go here
10284: my %importedids=();
10285: my @origfileimportpartids=();
10286: my $importedparts=0;
10287: #
10288: # Is this a recursive call for a library?
10289: #
10290: # if (! exists($metacache{$uri})) {
10291: # $metacache{$uri}={};
10292: # }
10293: my $cachetime = 60*60;
10294: if ($liburi) {
10295: $liburi=&declutter($liburi);
10296: $filename=$liburi;
10297: } else {
10298: &devalidate_cache_new('meta',$uri);
10299: undef(%metaentry);
10300: }
10301: my %metathesekeys=();
10302: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
10303: my $metastring;
10304: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
10305: my $which = &hreflocation('','/'.($liburi || $uri));
10306: $metastring =
10307: &Apache::lonnet::ssi_body($which,
10308: ('grade_target' => 'meta'));
10309: $cachetime = 1; # only want this cached in the child not long term
10310: } elsif (($uri !~ m -^(editupload)/-) &&
10311: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
10312: my $file=&filelocation('',&clutter($filename));
10313: #push(@{$metaentry{$uri.'.file'}},$file);
10314: $metastring=&getfile($file);
10315: }
10316: my $parser=HTML::LCParser->new(\$metastring);
10317: my $token;
10318: undef %metathesekeys;
10319: while ($token=$parser->get_token) {
10320: if ($token->[0] eq 'S') {
10321: if (defined($token->[2]->{'package'})) {
10322: #
10323: # This is a package - get package info
10324: #
10325: my $package=$token->[2]->{'package'};
10326: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10327: if (defined($token->[2]->{'id'})) {
10328: $keyroot.='_'.$token->[2]->{'id'};
10329: }
10330: if ($metaentry{':packages'}) {
10331: $metaentry{':packages'}.=','.$package.$keyroot;
10332: } else {
10333: $metaentry{':packages'}=$package.$keyroot;
10334: }
10335: foreach my $pack_entry (keys(%packagetab)) {
10336: my $part=$keyroot;
10337: $part=~s/^\_//;
10338: if ($pack_entry=~/^\Q$package\E\&/ ||
10339: $pack_entry=~/^\Q$package\E_0\&/) {
10340: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
10341: # ignore package.tab specified default values
10342: # here &package_tab_default() will fetch those
10343: if ($subp eq 'default') { next; }
10344: my $value=$packagetab{$pack_entry};
10345: my $unikey;
10346: if ($pack =~ /_0$/) {
10347: $unikey='parameter_0_'.$name;
10348: $part=0;
10349: } else {
10350: $unikey='parameter'.$keyroot.'_'.$name;
10351: }
10352: if ($subp eq 'display') {
10353: $value.=' [Part: '.$part.']';
10354: }
10355: $metaentry{':'.$unikey.'.part'}=$part;
10356: $metathesekeys{$unikey}=1;
10357: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10358: $metaentry{':'.$unikey.'.'.$subp}=$value;
10359: }
10360: if (defined($metaentry{':'.$unikey.'.default'})) {
10361: $metaentry{':'.$unikey}=
10362: $metaentry{':'.$unikey.'.default'};
10363: }
10364: }
10365: }
10366: } else {
10367: #
10368: # This is not a package - some other kind of start tag
10369: #
10370: my $entry=$token->[1];
10371: my $unikey='';
10372:
10373: if ($entry eq 'import') {
10374: #
10375: # Importing a library here
10376: #
10377: my $location=$parser->get_text('/import');
10378: my $dir=$filename;
10379: $dir=~s|[^/]*$||;
10380: $location=&filelocation($dir,$location);
10381:
10382: my $importmode=$token->[2]->{'importmode'};
10383: if ($importmode eq 'problem') {
10384: # Import as problem/response
10385: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10386: } elsif ($importmode eq 'part') {
10387: # Import as part(s)
10388: $importedparts=1;
10389: # We need to get the original file and the imported file to get the part order correct
10390: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
10391: # Load and inspect original file
10392: if ($#origfileimportpartids<0) {
10393: undef(%importedpartids);
10394: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
10395: my $origfile=&getfile($origfilelocation);
10396: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10397: }
10398:
10399: # Load and inspect imported file
10400: my $impfile=&getfile($location);
10401: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10402: if ($#impfilepartids>=0) {
10403: # This problem had parts
10404: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
10405: } else {
10406: # Importing by turning a single problem into a problem part
10407: # It gets the import-tags ID as part-ID
10408: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
10409: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
10410: }
10411: } else {
10412: # Normal import
10413: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10414: if (defined($token->[2]->{'id'})) {
10415: $unikey.='_'.$token->[2]->{'id'};
10416: }
10417: }
10418:
10419: if ($depthcount<20) {
10420: my $metadata =
10421: &metadata($uri,'keys', $location,$unikey,
10422: $depthcount+1);
10423: foreach my $meta (split(',',$metadata)) {
10424: $metaentry{':'.$meta}=$metaentry{':'.$meta};
10425: $metathesekeys{$meta}=1;
10426: }
10427:
10428: }
10429: } else {
10430: #
10431: # Not importing, some other kind of non-package, non-library start tag
10432: #
10433: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
10434: if (defined($token->[2]->{'id'})) {
10435: $unikey.='_'.$token->[2]->{'id'};
10436: }
10437: if (defined($token->[2]->{'name'})) {
10438: $unikey.='_'.$token->[2]->{'name'};
10439: }
10440: $metathesekeys{$unikey}=1;
10441: foreach my $param (@{$token->[3]}) {
10442: $metaentry{':'.$unikey.'.'.$param} =
10443: $token->[2]->{$param};
10444: }
10445: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
10446: my $default=$metaentry{':'.$unikey.'.default'};
10447: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
10448: # only ws inside the tag, and not in default, so use default
10449: # as value
10450: $metaentry{':'.$unikey}=$default;
10451: } elsif ( $internaltext =~ /\S/ ) {
10452: # something interesting inside the tag
10453: $metaentry{':'.$unikey}=$internaltext;
10454: } else {
10455: # no interesting values, don't set a default
10456: }
10457: # end of not-a-package not-a-library import
10458: }
10459: # end of not-a-package start tag
10460: }
10461: # the next is the end of "start tag"
10462: }
10463: }
10464: my ($extension) = ($uri =~ /\.(\w+)$/);
10465: $extension = lc($extension);
10466: if ($extension eq 'htm') { $extension='html'; }
10467:
10468: foreach my $key (keys(%packagetab)) {
10469: #no specific packages #how's our extension
10470: if ($key!~/^extension_\Q$extension\E&/) { next; }
10471: &metadata_create_package_def($uri,$key,'extension_'.$extension,
10472: \%metathesekeys);
10473: }
10474:
10475: if (!exists($metaentry{':packages'})
10476: || $packagetab{"import_defaults&extension_$extension"}) {
10477: foreach my $key (keys(%packagetab)) {
10478: #no specific packages well let's get default then
10479: if ($key!~/^default&/) { next; }
10480: &metadata_create_package_def($uri,$key,'default',
10481: \%metathesekeys);
10482: }
10483: }
10484: # are there custom rights to evaluate
10485: if ($metaentry{':copyright'} eq 'custom') {
10486:
10487: #
10488: # Importing a rights file here
10489: #
10490: unless ($depthcount) {
10491: my $location=$metaentry{':customdistributionfile'};
10492: my $dir=$filename;
10493: $dir=~s|[^/]*$||;
10494: $location=&filelocation($dir,$location);
10495: my $rights_metadata =
10496: &metadata($uri,'keys',$location,'_rights',
10497: $depthcount+1);
10498: foreach my $rights (split(',',$rights_metadata)) {
10499: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
10500: $metathesekeys{$rights}=1;
10501: }
10502: }
10503: }
10504: # uniqifiy package listing
10505: my %seen;
10506: my @uniq_packages =
10507: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
10508: $metaentry{':packages'} = join(',',@uniq_packages);
10509:
10510: if ($importedparts) {
10511: # We had imported parts and need to rebuild partorder
10512: $metaentry{':partorder'}='';
10513: $metathesekeys{'partorder'}=1;
10514: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
10515: if ($origfileimportpartids[$index] eq 'part') {
10516: # original part, part of the problem
10517: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
10518: } else {
10519: # we have imported parts at this position
10520: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
10521: }
10522: }
10523: $metaentry{':partorder'}=~s/^\,//;
10524: }
10525:
10526: $metaentry{':keys'} = join(',',keys(%metathesekeys));
10527: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
10528: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
10529: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
10530: # this is the end of "was not already recently cached
10531: }
10532: return $metaentry{':'.$what};
10533: }
10534:
10535: sub metadata_create_package_def {
10536: my ($uri,$key,$package,$metathesekeys)=@_;
10537: my ($pack,$name,$subp)=split(/\&/,$key);
10538: if ($subp eq 'default') { next; }
10539:
10540: if (defined($metaentry{':packages'})) {
10541: $metaentry{':packages'}.=','.$package;
10542: } else {
10543: $metaentry{':packages'}=$package;
10544: }
10545: my $value=$packagetab{$key};
10546: my $unikey;
10547: $unikey='parameter_0_'.$name;
10548: $metaentry{':'.$unikey.'.part'}=0;
10549: $$metathesekeys{$unikey}=1;
10550: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10551: $metaentry{':'.$unikey.'.'.$subp}=$value;
10552: }
10553: if (defined($metaentry{':'.$unikey.'.default'})) {
10554: $metaentry{':'.$unikey}=
10555: $metaentry{':'.$unikey.'.default'};
10556: }
10557: }
10558:
10559: sub metadata_generate_part0 {
10560: my ($metadata,$metacache,$uri) = @_;
10561: my %allnames;
10562: foreach my $metakey (keys(%$metadata)) {
10563: if ($metakey=~/^parameter\_(.*)/) {
10564: my $part=$$metacache{':'.$metakey.'.part'};
10565: my $name=$$metacache{':'.$metakey.'.name'};
10566: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
10567: $allnames{$name}=$part;
10568: }
10569: }
10570: }
10571: foreach my $name (keys(%allnames)) {
10572: $$metadata{"parameter_0_$name"}=1;
10573: my $key=":parameter_0_$name";
10574: $$metacache{"$key.part"}='0';
10575: $$metacache{"$key.name"}=$name;
10576: $$metacache{"$key.type"}=$$metacache{':parameter_'.
10577: $allnames{$name}.'_'.$name.
10578: '.type'};
10579: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
10580: '.display'};
10581: my $expr='[Part: '.$allnames{$name}.']';
10582: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
10583: $$metacache{"$key.display"}=$olddis;
10584: }
10585: }
10586:
10587: # ------------------------------------------------------ Devalidate title cache
10588:
10589: sub devalidate_title_cache {
10590: my ($url)=@_;
10591: if (!$env{'request.course.id'}) { return; }
10592: my $symb=&symbread($url);
10593: if (!$symb) { return; }
10594: my $key=$env{'request.course.id'}."\0".$symb;
10595: &devalidate_cache_new('title',$key);
10596: }
10597:
10598: # ------------------------------------------------- Get the title of a course
10599:
10600: sub current_course_title {
10601: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
10602: }
10603: # ------------------------------------------------- Get the title of a resource
10604:
10605: sub gettitle {
10606: my $urlsymb=shift;
10607: my $symb=&symbread($urlsymb);
10608: if ($symb) {
10609: my $key=$env{'request.course.id'}."\0".$symb;
10610: my ($result,$cached)=&is_cached_new('title',$key);
10611: if (defined($cached)) {
10612: return $result;
10613: }
10614: my ($map,$resid,$url)=&decode_symb($symb);
10615: my $title='';
10616: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
10617: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
10618: } else {
10619: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10620: &GDBM_READER(),0640)) {
10621: my $mapid=$bighash{'map_pc_'.&clutter($map)};
10622: $title=$bighash{'title_'.$mapid.'.'.$resid};
10623: untie(%bighash);
10624: }
10625: }
10626: $title=~s/\&colon\;/\:/gs;
10627: if ($title) {
10628: # Remember both $symb and $title for dynamic metadata
10629: $accesshash{$symb.'___crstitle'}=$title;
10630: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
10631: # Cache this title and then return it
10632: return &do_cache_new('title',$key,$title,600);
10633: }
10634: $urlsymb=$url;
10635: }
10636: my $title=&metadata($urlsymb,'title');
10637: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
10638: return $title;
10639: }
10640:
10641: sub get_slot {
10642: my ($which,$cnum,$cdom)=@_;
10643: if (!$cnum || !$cdom) {
10644: (undef,my $courseid)=&whichuser();
10645: $cdom=$env{'course.'.$courseid.'.domain'};
10646: $cnum=$env{'course.'.$courseid.'.num'};
10647: }
10648: my $key=join("\0",'slots',$cdom,$cnum,$which);
10649: my %slotinfo;
10650: if (exists($remembered{$key})) {
10651: $slotinfo{$which} = $remembered{$key};
10652: } else {
10653: %slotinfo=&get('slots',[$which],$cdom,$cnum);
10654: &Apache::lonhomework::showhash(%slotinfo);
10655: my ($tmp)=keys(%slotinfo);
10656: if ($tmp=~/^error:/) { return (); }
10657: $remembered{$key} = $slotinfo{$which};
10658: }
10659: if (ref($slotinfo{$which}) eq 'HASH') {
10660: return %{$slotinfo{$which}};
10661: }
10662: return $slotinfo{$which};
10663: }
10664:
10665: sub get_reservable_slots {
10666: my ($cnum,$cdom,$uname,$udom) = @_;
10667: my $now = time;
10668: my $reservable_info;
10669: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
10670: if (exists($remembered{$key})) {
10671: $reservable_info = $remembered{$key};
10672: } else {
10673: my %resv;
10674: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
10675: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
10676: $reservable_info = \%resv;
10677: $remembered{$key} = $reservable_info;
10678: }
10679: return $reservable_info;
10680: }
10681:
10682: sub get_course_slots {
10683: my ($cnum,$cdom) = @_;
10684: my $hashid=$cnum.':'.$cdom;
10685: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
10686: if (defined($cached)) {
10687: if (ref($result) eq 'HASH') {
10688: return %{$result};
10689: }
10690: } else {
10691: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
10692: my ($tmp) = keys(%slots);
10693: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10694: &do_cache_new('allslots',$hashid,\%slots,600);
10695: return %slots;
10696: }
10697: }
10698: return;
10699: }
10700:
10701: sub devalidate_slots_cache {
10702: my ($cnum,$cdom)=@_;
10703: my $hashid=$cnum.':'.$cdom;
10704: &devalidate_cache_new('allslots',$hashid);
10705: }
10706:
10707: sub get_coursechange {
10708: my ($cdom,$cnum) = @_;
10709: if ($cdom eq '' || $cnum eq '') {
10710: return unless ($env{'request.course.id'});
10711: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10712: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10713: }
10714: my $hashid=$cdom.'_'.$cnum;
10715: my ($change,$cached)=&is_cached_new('crschange',$hashid);
10716: if ((defined($cached)) && ($change ne '')) {
10717: return $change;
10718: } else {
10719: my %crshash;
10720: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
10721: if ($crshash{'internal.contentchange'} eq '') {
10722: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
10723: if ($change eq '') {
10724: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
10725: $change = $crshash{'internal.created'};
10726: }
10727: } else {
10728: $change = $crshash{'internal.contentchange'};
10729: }
10730: my $cachetime = 600;
10731: &do_cache_new('crschange',$hashid,$change,$cachetime);
10732: }
10733: return $change;
10734: }
10735:
10736: sub devalidate_coursechange_cache {
10737: my ($cnum,$cdom)=@_;
10738: my $hashid=$cnum.':'.$cdom;
10739: &devalidate_cache_new('crschange',$hashid);
10740: }
10741:
10742: # ------------------------------------------------- Update symbolic store links
10743:
10744: sub symblist {
10745: my ($mapname,%newhash)=@_;
10746: $mapname=&deversion(&declutter($mapname));
10747: my %hash;
10748: if (($env{'request.course.fn'}) && (%newhash)) {
10749: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
10750: &GDBM_WRCREAT(),0640)) {
10751: foreach my $url (keys(%newhash)) {
10752: next if ($url eq 'last_known'
10753: && $env{'form.no_update_last_known'});
10754: $hash{declutter($url)}=&encode_symb($mapname,
10755: $newhash{$url}->[1],
10756: $newhash{$url}->[0]);
10757: }
10758: if (untie(%hash)) {
10759: return 'ok';
10760: }
10761: }
10762: }
10763: return 'error';
10764: }
10765:
10766: # --------------------------------------------------------------- Verify a symb
10767:
10768: sub symbverify {
10769: my ($symb,$thisurl,$encstate)=@_;
10770: my $thisfn=$thisurl;
10771: $thisfn=&declutter($thisfn);
10772: # direct jump to resource in page or to a sequence - will construct own symbs
10773: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
10774: # check URL part
10775: my ($map,$resid,$url)=&decode_symb($symb);
10776:
10777: unless ($url eq $thisfn) { return 0; }
10778:
10779: $symb=&symbclean($symb);
10780: $thisurl=&deversion($thisurl);
10781: $thisfn=&deversion($thisfn);
10782:
10783: my %bighash;
10784: my $okay=0;
10785:
10786: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10787: &GDBM_READER(),0640)) {
10788: my $noclutter;
10789: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
10790: $thisurl =~ s/\?.+$//;
10791: if ($map =~ m{^uploaded/.+\.page$}) {
10792: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
10793: $thisurl =~ s{^\Qhttp://https://\E}{https://};
10794: $noclutter = 1;
10795: }
10796: }
10797: my $ids;
10798: if ($noclutter) {
10799: $ids=$bighash{'ids_'.$thisurl};
10800: } else {
10801: $ids=$bighash{'ids_'.&clutter($thisurl)};
10802: }
10803: unless ($ids) {
10804: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
10805: $ids=$bighash{$idkey};
10806: }
10807: if ($ids) {
10808: # ------------------------------------------------------------------- Has ID(s)
10809: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
10810: $symb =~ s/\?.+$//;
10811: }
10812: foreach my $id (split(/\,/,$ids)) {
10813: my ($mapid,$resid)=split(/\./,$id);
10814: if (
10815: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
10816: eq $symb) {
10817: if (ref($encstate)) {
10818: $$encstate = $bighash{'encrypted_'.$id};
10819: }
10820: if (($env{'request.role.adv'}) ||
10821: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
10822: ($thisurl eq '/adm/navmaps')) {
10823: $okay=1;
10824: last;
10825: }
10826: }
10827: }
10828: }
10829: untie(%bighash);
10830: }
10831: return $okay;
10832: }
10833:
10834: # --------------------------------------------------------------- Clean-up symb
10835:
10836: sub symbclean {
10837: my $symb=shift;
10838: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10839: # remove version from map
10840: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
10841:
10842: # remove version from URL
10843: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
10844:
10845: # remove wrapper
10846:
10847: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
10848: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
10849: return $symb;
10850: }
10851:
10852: # ---------------------------------------------- Split symb to find map and url
10853:
10854: sub encode_symb {
10855: my ($map,$resid,$url)=@_;
10856: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
10857: }
10858:
10859: sub decode_symb {
10860: my $symb=shift;
10861: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10862: my ($map,$resid,$url)=split(/___/,$symb);
10863: return (&fixversion($map),$resid,&fixversion($url));
10864: }
10865:
10866: sub fixversion {
10867: my $fn=shift;
10868: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
10869: my %bighash;
10870: my $uri=&clutter($fn);
10871: my $key=$env{'request.course.id'}.'_'.$uri;
10872: # is this cached?
10873: my ($result,$cached)=&is_cached_new('courseresversion',$key);
10874: if (defined($cached)) { return $result; }
10875: # unfortunately not cached, or expired
10876: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10877: &GDBM_READER(),0640)) {
10878: if ($bighash{'version_'.$uri}) {
10879: my $version=$bighash{'version_'.$uri};
10880: unless (($version eq 'mostrecent') ||
10881: ($version==&getversion($uri))) {
10882: $uri=~s/\.(\w+)$/\.$version\.$1/;
10883: }
10884: }
10885: untie %bighash;
10886: }
10887: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
10888: }
10889:
10890: sub deversion {
10891: my $url=shift;
10892: $url=~s/\.\d+\.(\w+)$/\.$1/;
10893: return $url;
10894: }
10895:
10896: # ------------------------------------------------------ Return symb list entry
10897:
10898: sub symbread {
10899: my ($thisfn,$donotrecurse)=@_;
10900: my $cache_str='request.symbread.cached.'.$thisfn;
10901: if (defined($env{$cache_str})) { return $env{$cache_str}; }
10902: # no filename provided? try from environment
10903: unless ($thisfn) {
10904: if ($env{'request.symb'}) {
10905: return $env{$cache_str}=&symbclean($env{'request.symb'});
10906: }
10907: $thisfn=$env{'request.filename'};
10908: }
10909: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
10910: # is that filename actually a symb? Verify, clean, and return
10911: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
10912: if (&symbverify($thisfn,$1)) {
10913: return $env{$cache_str}=&symbclean($thisfn);
10914: }
10915: }
10916: $thisfn=declutter($thisfn);
10917: my %hash;
10918: my %bighash;
10919: my $syval='';
10920: if (($env{'request.course.fn'}) && ($thisfn)) {
10921: my $targetfn = $thisfn;
10922: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
10923: $targetfn = 'adm/wrapper/'.$thisfn;
10924: }
10925: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
10926: $targetfn=$1;
10927: }
10928: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
10929: &GDBM_READER(),0640)) {
10930: $syval=$hash{$targetfn};
10931: untie(%hash);
10932: }
10933: # ---------------------------------------------------------- There was an entry
10934: if ($syval) {
10935: #unless ($syval=~/\_\d+$/) {
10936: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
10937: #&appenv({'request.ambiguous' => $thisfn});
10938: #return $env{$cache_str}='';
10939: #}
10940: #$syval.=$1;
10941: #}
10942: } else {
10943: # ------------------------------------------------------- Was not in symb table
10944: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10945: &GDBM_READER(),0640)) {
10946: # ---------------------------------------------- Get ID(s) for current resource
10947: my $ids=$bighash{'ids_'.&clutter($thisfn)};
10948: unless ($ids) {
10949: $ids=$bighash{'ids_/'.$thisfn};
10950: }
10951: unless ($ids) {
10952: # alias?
10953: $ids=$bighash{'mapalias_'.$thisfn};
10954: }
10955: if ($ids) {
10956: # ------------------------------------------------------------------- Has ID(s)
10957: my @possibilities=split(/\,/,$ids);
10958: if ($#possibilities==0) {
10959: # ----------------------------------------------- There is only one possibility
10960: my ($mapid,$resid)=split(/\./,$ids);
10961: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10962: $resid,$thisfn);
10963: } elsif (!$donotrecurse) {
10964: # ------------------------------------------ There is more than one possibility
10965: my $realpossible=0;
10966: foreach my $id (@possibilities) {
10967: my $file=$bighash{'src_'.$id};
10968: if (&allowed('bre',$file)) {
10969: my ($mapid,$resid)=split(/\./,$id);
10970: if ($bighash{'map_type_'.$mapid} ne 'page') {
10971: $realpossible++;
10972: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10973: $resid,$thisfn);
10974: }
10975: }
10976: }
10977: if ($realpossible!=1) { $syval=''; }
10978: } else {
10979: $syval='';
10980: }
10981: }
10982: untie(%bighash)
10983: }
10984: }
10985: if ($syval) {
10986: return $env{$cache_str}=$syval;
10987: }
10988: }
10989: &appenv({'request.ambiguous' => $thisfn});
10990: return $env{$cache_str}='';
10991: }
10992:
10993: # ---------------------------------------------------------- Return random seed
10994:
10995: sub numval {
10996: my $txt=shift;
10997: $txt=~tr/A-J/0-9/;
10998: $txt=~tr/a-j/0-9/;
10999: $txt=~tr/K-T/0-9/;
11000: $txt=~tr/k-t/0-9/;
11001: $txt=~tr/U-Z/0-5/;
11002: $txt=~tr/u-z/0-5/;
11003: $txt=~s/\D//g;
11004: if ($_64bit) { if ($txt > 2**32) { return -1; } }
11005: return int($txt);
11006: }
11007:
11008: sub numval2 {
11009: my $txt=shift;
11010: $txt=~tr/A-J/0-9/;
11011: $txt=~tr/a-j/0-9/;
11012: $txt=~tr/K-T/0-9/;
11013: $txt=~tr/k-t/0-9/;
11014: $txt=~tr/U-Z/0-5/;
11015: $txt=~tr/u-z/0-5/;
11016: $txt=~s/\D//g;
11017: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11018: my $total;
11019: foreach my $val (@txts) { $total+=$val; }
11020: if ($_64bit) { if ($total > 2**32) { return -1; } }
11021: return int($total);
11022: }
11023:
11024: sub numval3 {
11025: use integer;
11026: my $txt=shift;
11027: $txt=~tr/A-J/0-9/;
11028: $txt=~tr/a-j/0-9/;
11029: $txt=~tr/K-T/0-9/;
11030: $txt=~tr/k-t/0-9/;
11031: $txt=~tr/U-Z/0-5/;
11032: $txt=~tr/u-z/0-5/;
11033: $txt=~s/\D//g;
11034: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11035: my $total;
11036: foreach my $val (@txts) { $total+=$val; }
11037: if ($_64bit) { $total=(($total<<32)>>32); }
11038: return $total;
11039: }
11040:
11041: sub digest {
11042: my ($data)=@_;
11043: my $digest=&Digest::MD5::md5($data);
11044: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11045: my ($e,$f);
11046: {
11047: use integer;
11048: $e=($a+$b);
11049: $f=($c+$d);
11050: if ($_64bit) {
11051: $e=(($e<<32)>>32);
11052: $f=(($f<<32)>>32);
11053: }
11054: }
11055: if (wantarray) {
11056: return ($e,$f);
11057: } else {
11058: my $g;
11059: {
11060: use integer;
11061: $g=($e+$f);
11062: if ($_64bit) {
11063: $g=(($g<<32)>>32);
11064: }
11065: }
11066: return $g;
11067: }
11068: }
11069:
11070: sub latest_rnd_algorithm_id {
11071: return '64bit5';
11072: }
11073:
11074: sub get_rand_alg {
11075: my ($courseid)=@_;
11076: if (!$courseid) { $courseid=(&whichuser())[1]; }
11077: if ($courseid) {
11078: return $env{"course.$courseid.rndseed"};
11079: }
11080: return &latest_rnd_algorithm_id();
11081: }
11082:
11083: sub validCODE {
11084: my ($CODE)=@_;
11085: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11086: return 0;
11087: }
11088:
11089: sub getCODE {
11090: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
11091: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11092: defined($Apache::lonhomework::parsing_a_task) ) &&
11093: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
11094: return $Apache::lonhomework::history{'resource.CODE'};
11095: }
11096: return undef;
11097: }
11098: #
11099: # Determines the random seed for a specific context:
11100: #
11101: # parameters:
11102: # symb - in course context the symb for the seed.
11103: # course_id - The course id of the form domain_coursenum.
11104: # domain - Domain for the user.
11105: # course - Course for the user.
11106: # cenv - environment of the course.
11107: #
11108: # NOTE:
11109: # All parameters are picked out of the environment if missing
11110: # or not defined.
11111: # If a symb cannot be determined the current time is used instead.
11112: #
11113: # For a given well defined symb, courside, domain, username,
11114: # and course environment, the seed is reproducible.
11115: #
11116: sub rndseed {
11117: my ($symb,$courseid,$domain,$username, $cenv)=@_;
11118: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
11119: if (!defined($symb)) {
11120: unless ($symb=$wsymb) { return time; }
11121: }
11122: if (!defined $courseid) {
11123: $courseid=$wcourseid;
11124: }
11125: if (!defined $domain) { $domain=$wdomain; }
11126: if (!defined $username) { $username=$wusername }
11127:
11128: my $which;
11129: if (defined($cenv->{'rndseed'})) {
11130: $which = $cenv->{'rndseed'};
11131: } else {
11132: $which =&get_rand_alg($courseid);
11133: }
11134: if (defined(&getCODE())) {
11135:
11136: if ($which eq '64bit5') {
11137: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11138: } elsif ($which eq '64bit4') {
11139: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11140: } else {
11141: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11142: }
11143: } elsif ($which eq '64bit5') {
11144: return &rndseed_64bit5($symb,$courseid,$domain,$username);
11145: } elsif ($which eq '64bit4') {
11146: return &rndseed_64bit4($symb,$courseid,$domain,$username);
11147: } elsif ($which eq '64bit3') {
11148: return &rndseed_64bit3($symb,$courseid,$domain,$username);
11149: } elsif ($which eq '64bit2') {
11150: return &rndseed_64bit2($symb,$courseid,$domain,$username);
11151: } elsif ($which eq '64bit') {
11152: return &rndseed_64bit($symb,$courseid,$domain,$username);
11153: }
11154: return &rndseed_32bit($symb,$courseid,$domain,$username);
11155: }
11156:
11157: sub rndseed_32bit {
11158: my ($symb,$courseid,$domain,$username)=@_;
11159: {
11160: use integer;
11161: my $symbchck=unpack("%32C*",$symb) << 27;
11162: my $symbseed=numval($symb) << 22;
11163: my $namechck=unpack("%32C*",$username) << 17;
11164: my $nameseed=numval($username) << 12;
11165: my $domainseed=unpack("%32C*",$domain) << 7;
11166: my $courseseed=unpack("%32C*",$courseid);
11167: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
11168: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11169: #&logthis("rndseed :$num:$symb");
11170: if ($_64bit) { $num=(($num<<32)>>32); }
11171: return $num;
11172: }
11173: }
11174:
11175: sub rndseed_64bit {
11176: my ($symb,$courseid,$domain,$username)=@_;
11177: {
11178: use integer;
11179: my $symbchck=unpack("%32S*",$symb) << 21;
11180: my $symbseed=numval($symb) << 10;
11181: my $namechck=unpack("%32S*",$username);
11182:
11183: my $nameseed=numval($username) << 21;
11184: my $domainseed=unpack("%32S*",$domain) << 10;
11185: my $courseseed=unpack("%32S*",$courseid);
11186:
11187: my $num1=$symbchck+$symbseed+$namechck;
11188: my $num2=$nameseed+$domainseed+$courseseed;
11189: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11190: #&logthis("rndseed :$num:$symb");
11191: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11192: return "$num1,$num2";
11193: }
11194: }
11195:
11196: sub rndseed_64bit2 {
11197: my ($symb,$courseid,$domain,$username)=@_;
11198: {
11199: use integer;
11200: # strings need to be an even # of cahracters long, it it is odd the
11201: # last characters gets thrown away
11202: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11203: my $symbseed=numval($symb) << 10;
11204: my $namechck=unpack("%32S*",$username.' ');
11205:
11206: my $nameseed=numval($username) << 21;
11207: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11208: my $courseseed=unpack("%32S*",$courseid.' ');
11209:
11210: my $num1=$symbchck+$symbseed+$namechck;
11211: my $num2=$nameseed+$domainseed+$courseseed;
11212: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11213: #&logthis("rndseed :$num:$symb");
11214: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11215: return "$num1,$num2";
11216: }
11217: }
11218:
11219: sub rndseed_64bit3 {
11220: my ($symb,$courseid,$domain,$username)=@_;
11221: {
11222: use integer;
11223: # strings need to be an even # of cahracters long, it it is odd the
11224: # last characters gets thrown away
11225: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11226: my $symbseed=numval2($symb) << 10;
11227: my $namechck=unpack("%32S*",$username.' ');
11228:
11229: my $nameseed=numval2($username) << 21;
11230: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11231: my $courseseed=unpack("%32S*",$courseid.' ');
11232:
11233: my $num1=$symbchck+$symbseed+$namechck;
11234: my $num2=$nameseed+$domainseed+$courseseed;
11235: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11236: #&logthis("rndseed :$num1:$num2:$_64bit");
11237: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11238:
11239: return "$num1:$num2";
11240: }
11241: }
11242:
11243: sub rndseed_64bit4 {
11244: my ($symb,$courseid,$domain,$username)=@_;
11245: {
11246: use integer;
11247: # strings need to be an even # of cahracters long, it it is odd the
11248: # last characters gets thrown away
11249: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11250: my $symbseed=numval3($symb) << 10;
11251: my $namechck=unpack("%32S*",$username.' ');
11252:
11253: my $nameseed=numval3($username) << 21;
11254: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11255: my $courseseed=unpack("%32S*",$courseid.' ');
11256:
11257: my $num1=$symbchck+$symbseed+$namechck;
11258: my $num2=$nameseed+$domainseed+$courseseed;
11259: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11260: #&logthis("rndseed :$num1:$num2:$_64bit");
11261: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11262:
11263: return "$num1:$num2";
11264: }
11265: }
11266:
11267: sub rndseed_64bit5 {
11268: my ($symb,$courseid,$domain,$username)=@_;
11269: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11270: return "$num1:$num2";
11271: }
11272:
11273: sub rndseed_CODE_64bit {
11274: my ($symb,$courseid,$domain,$username)=@_;
11275: {
11276: use integer;
11277: my $symbchck=unpack("%32S*",$symb.' ') << 16;
11278: my $symbseed=numval2($symb);
11279: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11280: my $CODEseed=numval(&getCODE());
11281: my $courseseed=unpack("%32S*",$courseid.' ');
11282: my $num1=$symbseed+$CODEchck;
11283: my $num2=$CODEseed+$courseseed+$symbchck;
11284: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11285: #&logthis("rndseed :$num1:$num2:$symb");
11286: if ($_64bit) { $num1=(($num1<<32)>>32); }
11287: if ($_64bit) { $num2=(($num2<<32)>>32); }
11288: return "$num1:$num2";
11289: }
11290: }
11291:
11292: sub rndseed_CODE_64bit4 {
11293: my ($symb,$courseid,$domain,$username)=@_;
11294: {
11295: use integer;
11296: my $symbchck=unpack("%32S*",$symb.' ') << 16;
11297: my $symbseed=numval3($symb);
11298: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11299: my $CODEseed=numval3(&getCODE());
11300: my $courseseed=unpack("%32S*",$courseid.' ');
11301: my $num1=$symbseed+$CODEchck;
11302: my $num2=$CODEseed+$courseseed+$symbchck;
11303: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11304: #&logthis("rndseed :$num1:$num2:$symb");
11305: if ($_64bit) { $num1=(($num1<<32)>>32); }
11306: if ($_64bit) { $num2=(($num2<<32)>>32); }
11307: return "$num1:$num2";
11308: }
11309: }
11310:
11311: sub rndseed_CODE_64bit5 {
11312: my ($symb,$courseid,$domain,$username)=@_;
11313: my $code = &getCODE();
11314: my ($num1,$num2)=&digest("$symb,$courseid,$code");
11315: return "$num1:$num2";
11316: }
11317:
11318: sub setup_random_from_rndseed {
11319: my ($rndseed)=@_;
11320: if ($rndseed =~/([,:])/) {
11321: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
11322: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
11323: &Math::Random::random_set_seed_from_phrase($rndseed);
11324: } else {
11325: &Math::Random::random_set_seed($num1,$num2);
11326: }
11327: } else {
11328: &Math::Random::random_set_seed_from_phrase($rndseed);
11329: }
11330: }
11331:
11332: sub latest_receipt_algorithm_id {
11333: return 'receipt3';
11334: }
11335:
11336: sub recunique {
11337: my $fucourseid=shift;
11338: my $unique;
11339: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
11340: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
11341: $unique=$env{"course.$fucourseid.internal.encseed"};
11342: } else {
11343: $unique=$perlvar{'lonReceipt'};
11344: }
11345: return unpack("%32C*",$unique);
11346: }
11347:
11348: sub recprefix {
11349: my $fucourseid=shift;
11350: my $prefix;
11351: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
11352: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
11353: $prefix=$env{"course.$fucourseid.internal.encpref"};
11354: } else {
11355: $prefix=$perlvar{'lonHostID'};
11356: }
11357: return unpack("%32C*",$prefix);
11358: }
11359:
11360: sub ireceipt {
11361: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
11362:
11363: my $return =&recprefix($fucourseid).'-';
11364:
11365: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
11366: $env{'request.state'} eq 'construct') {
11367: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
11368: return $return;
11369: }
11370:
11371: my $cuname=unpack("%32C*",$funame);
11372: my $cudom=unpack("%32C*",$fudom);
11373: my $cucourseid=unpack("%32C*",$fucourseid);
11374: my $cusymb=unpack("%32C*",$fusymb);
11375: my $cunique=&recunique($fucourseid);
11376: my $cpart=unpack("%32S*",$part);
11377: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
11378:
11379: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
11380:
11381: $return.= ($cunique%$cuname+
11382: $cunique%$cudom+
11383: $cusymb%$cuname+
11384: $cusymb%$cudom+
11385: $cucourseid%$cuname+
11386: $cucourseid%$cudom+
11387: $cpart%$cuname+
11388: $cpart%$cudom);
11389: } else {
11390: $return.= ($cunique%$cuname+
11391: $cunique%$cudom+
11392: $cusymb%$cuname+
11393: $cusymb%$cudom+
11394: $cucourseid%$cuname+
11395: $cucourseid%$cudom);
11396: }
11397: return $return;
11398: }
11399:
11400: sub receipt {
11401: my ($part)=@_;
11402: my ($symb,$courseid,$domain,$name) = &whichuser();
11403: return &ireceipt($name,$domain,$courseid,$symb,$part);
11404: }
11405:
11406: sub whichuser {
11407: my ($passedsymb)=@_;
11408: my ($symb,$courseid,$domain,$name,$publicuser);
11409: if (defined($env{'form.grade_symb'})) {
11410: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
11411: my $allowed=&allowed('vgr',$tmp_courseid);
11412: if (!$allowed &&
11413: exists($env{'request.course.sec'}) &&
11414: $env{'request.course.sec'} !~ /^\s*$/) {
11415: $allowed=&allowed('vgr',$tmp_courseid.
11416: '/'.$env{'request.course.sec'});
11417: }
11418: if ($allowed) {
11419: ($symb)=&get_env_multiple('form.grade_symb');
11420: $courseid=$tmp_courseid;
11421: ($domain)=&get_env_multiple('form.grade_domain');
11422: ($name)=&get_env_multiple('form.grade_username');
11423: return ($symb,$courseid,$domain,$name,$publicuser);
11424: }
11425: }
11426: if (!$passedsymb) {
11427: $symb=&symbread();
11428: } else {
11429: $symb=$passedsymb;
11430: }
11431: $courseid=$env{'request.course.id'};
11432: $domain=$env{'user.domain'};
11433: $name=$env{'user.name'};
11434: if ($name eq 'public' && $domain eq 'public') {
11435: if (!defined($env{'form.username'})) {
11436: $env{'form.username'}.=time.rand(10000000);
11437: }
11438: $name.=$env{'form.username'};
11439: }
11440: return ($symb,$courseid,$domain,$name,$publicuser);
11441:
11442: }
11443:
11444: # ------------------------------------------------------------ Serves up a file
11445: # returns either the contents of the file or
11446: # -1 if the file doesn't exist
11447: #
11448: # if the target is a file that was uploaded via DOCS,
11449: # a check will be made to see if a current copy exists on the local server,
11450: # if it does this will be served, otherwise a copy will be retrieved from
11451: # the home server for the course and stored in /home/httpd/html/userfiles on
11452: # the local server.
11453:
11454: sub getfile {
11455: my ($file) = @_;
11456: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
11457: &repcopy($file);
11458: return &readfile($file);
11459: }
11460:
11461: sub repcopy_userfile {
11462: my ($file)=@_;
11463: my $londocroot = $perlvar{'lonDocRoot'};
11464: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
11465: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
11466: my ($cdom,$cnum,$filename) =
11467: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
11468: my $uri="/uploaded/$cdom/$cnum/$filename";
11469: if (-e "$file") {
11470: # we already have a local copy, check it out
11471: my @fileinfo = stat($file);
11472: my $rtncode;
11473: my $info;
11474: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
11475: if ($lwpresp ne 'ok') {
11476: # there is no such file anymore, even though we had a local copy
11477: if ($rtncode eq '404') {
11478: unlink($file);
11479: }
11480: return -1;
11481: }
11482: if ($info < $fileinfo[9]) {
11483: # nice, the file we have is up-to-date, just say okay
11484: return 'ok';
11485: } else {
11486: # the file is outdated, get rid of it
11487: unlink($file);
11488: }
11489: }
11490: # one way or the other, at this point, we don't have the file
11491: # construct the correct path for the file
11492: my @parts = ($cdom,$cnum);
11493: if ($filename =~ m|^(.+)/[^/]+$|) {
11494: push @parts, split(/\//,$1);
11495: }
11496: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
11497: foreach my $part (@parts) {
11498: $path .= '/'.$part;
11499: if (!-e $path) {
11500: mkdir($path,0770);
11501: }
11502: }
11503: # now the path exists for sure
11504: # get a user agent
11505: my $ua=new LWP::UserAgent;
11506: my $transferfile=$file.'.in.transfer';
11507: # FIXME: this should flock
11508: if (-e $transferfile) { return 'ok'; }
11509: my $request;
11510: $uri=~s/^\///;
11511: my $homeserver = &homeserver($cnum,$cdom);
11512: my $protocol = $protocol{$homeserver};
11513: $protocol = 'http' if ($protocol ne 'https');
11514: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
11515: my $response=$ua->request($request,$transferfile);
11516: # did it work?
11517: if ($response->is_error()) {
11518: unlink($transferfile);
11519: &logthis("Userfile repcopy failed for $uri");
11520: return -1;
11521: }
11522: # worked, rename the transfer file
11523: rename($transferfile,$file);
11524: return 'ok';
11525: }
11526:
11527: sub tokenwrapper {
11528: my $uri=shift;
11529: $uri=~s|^https?\://([^/]+)||;
11530: $uri=~s|^/||;
11531: $env{'user.environment'}=~/\/([^\/]+)\.id/;
11532: my $token=$1;
11533: my (undef,$udom,$uname,$file)=split('/',$uri,4);
11534: if ($udom && $uname && $file) {
11535: $file=~s|(\?\.*)*$||;
11536: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
11537: my $homeserver = &homeserver($uname,$udom);
11538: my $protocol = $protocol{$homeserver};
11539: $protocol = 'http' if ($protocol ne 'https');
11540: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
11541: (($uri=~/\?/)?'&':'?').'token='.$token.
11542: '&tokenissued='.$perlvar{'lonHostID'};
11543: } else {
11544: return '/adm/notfound.html';
11545: }
11546: }
11547:
11548: # call with reqtype HEAD: get last modification time
11549: # call with reqtype GET: get the file contents
11550: # Do not call this with reqtype GET for large files! It loads everything into memory
11551: #
11552: sub getuploaded {
11553: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
11554: $uri=~s/^\///;
11555: my $homeserver = &homeserver($cnum,$cdom);
11556: my $protocol = $protocol{$homeserver};
11557: $protocol = 'http' if ($protocol ne 'https');
11558: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
11559: my $ua=new LWP::UserAgent;
11560: my $request=new HTTP::Request($reqtype,$uri);
11561: my $response=$ua->request($request);
11562: $$rtncode = $response->code;
11563: if (! $response->is_success()) {
11564: return 'failed';
11565: }
11566: if ($reqtype eq 'HEAD') {
11567: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
11568: } elsif ($reqtype eq 'GET') {
11569: $$info = $response->content;
11570: }
11571: return 'ok';
11572: }
11573:
11574: sub readfile {
11575: my $file = shift;
11576: if ( (! -e $file ) || ($file eq '') ) { return -1; };
11577: my $fh;
11578: open($fh,"<$file");
11579: my $a='';
11580: while (my $line = <$fh>) { $a .= $line; }
11581: return $a;
11582: }
11583:
11584: sub filelocation {
11585: my ($dir,$file) = @_;
11586: my $location;
11587: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
11588:
11589: if ($file =~ m-^/adm/-) {
11590: $file=~s-^/adm/wrapper/-/-;
11591: $file=~s-^/adm/coursedocs/showdoc/-/-;
11592: }
11593:
11594: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
11595: $location = $file;
11596: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
11597: my ($udom,$uname,$filename)=
11598: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
11599: my $home=&homeserver($uname,$udom);
11600: my $is_me=0;
11601: my @ids=¤t_machine_ids();
11602: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
11603: if ($is_me) {
11604: $location=propath($udom,$uname).'/userfiles/'.$filename;
11605: } else {
11606: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
11607: $udom.'/'.$uname.'/'.$filename;
11608: }
11609: } elsif ($file =~ m-^/adm/-) {
11610: $location = $perlvar{'lonDocRoot'}.'/'.$file;
11611: } else {
11612: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
11613: $file=~s:^/(res|priv)/:/:;
11614: my $space=$1;
11615: if ( !( $file =~ m:^/:) ) {
11616: $location = $dir. '/'.$file;
11617: } else {
11618: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
11619: }
11620: }
11621: $location=~s://+:/:g; # remove duplicate /
11622: while ($location=~m{/\.\./}) {
11623: if ($location =~ m{/[^/]+/\.\./}) {
11624: $location=~ s{/[^/]+/\.\./}{/}g;
11625: } else {
11626: $location=~ s{/\.\./}{/}g;
11627: }
11628: } #remove dir/..
11629: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
11630: return $location;
11631: }
11632:
11633: sub hreflocation {
11634: my ($dir,$file)=@_;
11635: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
11636: $file=filelocation($dir,$file);
11637: } elsif ($file=~m-^/adm/-) {
11638: $file=~s-^/adm/wrapper/-/-;
11639: $file=~s-^/adm/coursedocs/showdoc/-/-;
11640: }
11641: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
11642: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
11643: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
11644: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
11645: {/uploaded/$1/$2/}x;
11646: }
11647: if ($file=~ m{^/userfiles/}) {
11648: $file =~ s{^/userfiles/}{/uploaded/};
11649: }
11650: return $file;
11651: }
11652:
11653:
11654:
11655:
11656:
11657: sub current_machine_domains {
11658: return &machine_domains(&hostname($perlvar{'lonHostID'}));
11659: }
11660:
11661: sub machine_domains {
11662: my ($hostname) = @_;
11663: my @domains;
11664: my %hostname = &all_hostnames();
11665: while( my($id, $name) = each(%hostname)) {
11666: # &logthis("-$id-$name-$hostname-");
11667: if ($hostname eq $name) {
11668: push(@domains,&host_domain($id));
11669: }
11670: }
11671: return @domains;
11672: }
11673:
11674: sub current_machine_ids {
11675: return &machine_ids(&hostname($perlvar{'lonHostID'}));
11676: }
11677:
11678: sub machine_ids {
11679: my ($hostname) = @_;
11680: $hostname ||= &hostname($perlvar{'lonHostID'});
11681: my @ids;
11682: my %name_to_host = &all_names();
11683: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
11684: return @{ $name_to_host{$hostname} };
11685: }
11686: return;
11687: }
11688:
11689: sub additional_machine_domains {
11690: my @domains;
11691: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
11692: while( my $line = <$fh>) {
11693: $line =~ s/\s//g;
11694: push(@domains,$line);
11695: }
11696: return @domains;
11697: }
11698:
11699: sub default_login_domain {
11700: my $domain = $perlvar{'lonDefDomain'};
11701: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
11702: foreach my $posdom (¤t_machine_domains(),
11703: &additional_machine_domains()) {
11704: if (lc($posdom) eq lc($testdomain)) {
11705: $domain=$posdom;
11706: last;
11707: }
11708: }
11709: return $domain;
11710: }
11711:
11712: # ------------------------------------------------------------- Declutters URLs
11713:
11714: sub declutter {
11715: my $thisfn=shift;
11716: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
11717: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
11718: $thisfn=~s{^/home/httpd/html}{};
11719: }
11720: $thisfn=~s/^\///;
11721: $thisfn=~s|^adm/wrapper/||;
11722: $thisfn=~s|^adm/coursedocs/showdoc/||;
11723: $thisfn=~s/^res\///;
11724: $thisfn=~s/^priv\///;
11725: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
11726: $thisfn=~s/\?.+$//;
11727: }
11728: return $thisfn;
11729: }
11730:
11731: # ------------------------------------------------------------- Clutter up URLs
11732:
11733: sub clutter {
11734: my $thisfn='/'.&declutter(shift);
11735: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
11736: || $thisfn =~ m{^/adm/(includes|pages)} ) {
11737: $thisfn='/res'.$thisfn;
11738: }
11739: if ($thisfn !~m|^/adm|) {
11740: if ($thisfn =~ m|^/ext/|) {
11741: $thisfn='/adm/wrapper'.$thisfn;
11742: } else {
11743: my ($ext) = ($thisfn =~ /\.(\w+)$/);
11744: my $embstyle=&Apache::loncommon::fileembstyle($ext);
11745: if ($embstyle eq 'ssi'
11746: || ($embstyle eq 'hdn')
11747: || ($embstyle eq 'rat')
11748: || ($embstyle eq 'prv')
11749: || ($embstyle eq 'ign')) {
11750: #do nothing with these
11751: } elsif (($embstyle eq 'img')
11752: || ($embstyle eq 'emb')
11753: || ($embstyle eq 'wrp')) {
11754: $thisfn='/adm/wrapper'.$thisfn;
11755: } elsif ($embstyle eq 'unk'
11756: && $thisfn!~/\.(sequence|page)$/) {
11757: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
11758: } else {
11759: # &logthis("Got a blank emb style");
11760: }
11761: }
11762: }
11763: return $thisfn;
11764: }
11765:
11766: sub clutter_with_no_wrapper {
11767: my $uri = &clutter(shift);
11768: if ($uri =~ m-^/adm/-) {
11769: $uri =~ s-^/adm/wrapper/-/-;
11770: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
11771: }
11772: return $uri;
11773: }
11774:
11775: sub freeze_escape {
11776: my ($value)=@_;
11777: if (ref($value)) {
11778: $value=&nfreeze($value);
11779: return '__FROZEN__'.&escape($value);
11780: }
11781: return &escape($value);
11782: }
11783:
11784:
11785: sub thaw_unescape {
11786: my ($value)=@_;
11787: if ($value =~ /^__FROZEN__/) {
11788: substr($value,0,10,undef);
11789: $value=&unescape($value);
11790: return &thaw($value);
11791: }
11792: return &unescape($value);
11793: }
11794:
11795: sub correct_line_ends {
11796: my ($result)=@_;
11797: $$result =~s/\r\n/\n/mg;
11798: $$result =~s/\r/\n/mg;
11799: }
11800: # ================================================================ Main Program
11801:
11802: sub goodbye {
11803: &logthis("Starting Shut down");
11804: #not converted to using infrastruture and probably shouldn't be
11805: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
11806: #converted
11807: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
11808: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
11809: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
11810: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
11811: #1.1 only
11812: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
11813: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
11814: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
11815: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
11816: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
11817: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
11818: &logthis(sprintf("%-20s is %s",'hits',$hits));
11819: &flushcourselogs();
11820: &logthis("Shutting down");
11821: }
11822:
11823: sub get_dns {
11824: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
11825: if (!$ignore_cache) {
11826: my ($content,$cached)=
11827: &Apache::lonnet::is_cached_new('dns',$url);
11828: if ($cached) {
11829: &$func($content,$hashref);
11830: return;
11831: }
11832: }
11833:
11834: my %alldns;
11835: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11836: foreach my $dns (<$config>) {
11837: next if ($dns !~ /^\^(\S*)/x);
11838: my $line = $1;
11839: my ($host,$protocol) = split(/:/,$line);
11840: if ($protocol ne 'https') {
11841: $protocol = 'http';
11842: }
11843: $alldns{$host} = $protocol;
11844: }
11845: while (%alldns) {
11846: my ($dns) = sort { $b cmp $a } keys(%alldns);
11847: my $ua=new LWP::UserAgent;
11848: $ua->timeout(30);
11849: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
11850: my $response=$ua->request($request);
11851: delete($alldns{$dns});
11852: next if ($response->is_error());
11853: my @content = split("\n",$response->content);
11854: unless ($nocache) {
11855: &do_cache_new('dns',$url,\@content,30*24*60*60);
11856: }
11857: &$func(\@content,$hashref);
11858: return;
11859: }
11860: close($config);
11861: my $which = (split('/',$url))[3];
11862: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
11863: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
11864: my @content = <$config>;
11865: &$func(\@content,$hashref);
11866: return;
11867: }
11868:
11869: # ------------------------------------------------------Get DNS checksums file
11870: sub parse_dns_checksums_tab {
11871: my ($lines,$hashref) = @_;
11872: my $lonhost = $perlvar{'lonHostID'};
11873: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
11874: my $loncaparev = &get_server_loncaparev($machine_dom);
11875: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
11876: my $webconfdir = '/etc/httpd/conf';
11877: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
11878: $webconfdir = '/etc/apache2';
11879: } elsif ($distro =~ /^sles(\d+)$/) {
11880: if ($1 >= 10) {
11881: $webconfdir = '/etc/apache2';
11882: }
11883: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
11884: if ($1 >= 10.0) {
11885: $webconfdir = '/etc/apache2';
11886: }
11887: }
11888: my ($release,$timestamp) = split(/\-/,$loncaparev);
11889: my (%chksum,%revnum);
11890: if (ref($lines) eq 'ARRAY') {
11891: chomp(@{$lines});
11892: my $version = shift(@{$lines});
11893: if ($version eq $release) {
11894: foreach my $line (@{$lines}) {
11895: my ($file,$version,$shasum) = split(/,/,$line);
11896: if ($file =~ m{^/etc/httpd/conf}) {
11897: if ($webconfdir eq '/etc/apache2') {
11898: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
11899: }
11900: }
11901: $chksum{$file} = $shasum;
11902: $revnum{$file} = $version;
11903: }
11904: if (ref($hashref) eq 'HASH') {
11905: %{$hashref} = (
11906: sums => \%chksum,
11907: versions => \%revnum,
11908: );
11909: }
11910: }
11911: }
11912: return;
11913: }
11914:
11915: sub fetch_dns_checksums {
11916: my %checksums;
11917: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
11918: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
11919: my ($release,$timestamp) = split(/\-/,$loncaparev);
11920: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
11921: \%checksums);
11922: return \%checksums;
11923: }
11924:
11925: # ------------------------------------------------------------ Read domain file
11926: {
11927: my $loaded;
11928: my %domain;
11929:
11930: sub parse_domain_tab {
11931: my ($lines) = @_;
11932: foreach my $line (@$lines) {
11933: next if ($line =~ /^(\#|\s*$ )/x);
11934:
11935: chomp($line);
11936: my ($name,@elements) = split(/:/,$line,9);
11937: my %this_domain;
11938: foreach my $field ('description', 'auth_def', 'auth_arg_def',
11939: 'lang_def', 'city', 'longi', 'lati',
11940: 'primary') {
11941: $this_domain{$field} = shift(@elements);
11942: }
11943: $domain{$name} = \%this_domain;
11944: }
11945: }
11946:
11947: sub reset_domain_info {
11948: undef($loaded);
11949: undef(%domain);
11950: }
11951:
11952: sub load_domain_tab {
11953: my ($ignore_cache) = @_;
11954: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
11955: my $fh;
11956: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
11957: my @lines = <$fh>;
11958: &parse_domain_tab(\@lines);
11959: }
11960: close($fh);
11961: $loaded = 1;
11962: }
11963:
11964: sub domain {
11965: &load_domain_tab() if (!$loaded);
11966:
11967: my ($name,$what) = @_;
11968: return if ( !exists($domain{$name}) );
11969:
11970: if (!$what) {
11971: return $domain{$name}{'description'};
11972: }
11973: return $domain{$name}{$what};
11974: }
11975:
11976: sub domain_info {
11977: &load_domain_tab() if (!$loaded);
11978: return %domain;
11979: }
11980:
11981: }
11982:
11983:
11984: # ------------------------------------------------------------- Read hosts file
11985: {
11986: my %hostname;
11987: my %hostdom;
11988: my %libserv;
11989: my $loaded;
11990: my %name_to_host;
11991: my %internetdom;
11992: my %LC_dns_serv;
11993:
11994: sub parse_hosts_tab {
11995: my ($file) = @_;
11996: foreach my $configline (@$file) {
11997: next if ($configline =~ /^(\#|\s*$ )/x);
11998: chomp($configline);
11999: if ($configline =~ /^\^/) {
12000: if ($configline =~ /^\^([\w.\-]+)/) {
12001: $LC_dns_serv{$1} = 1;
12002: }
12003: next;
12004: }
12005: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
12006: $name=~s/\s//g;
12007: if ($id && $domain && $role && $name) {
12008: $hostname{$id}=$name;
12009: push(@{$name_to_host{$name}}, $id);
12010: $hostdom{$id}=$domain;
12011: if ($role eq 'library') { $libserv{$id}=$name; }
12012: if (defined($protocol)) {
12013: if ($protocol eq 'https') {
12014: $protocol{$id} = $protocol;
12015: } else {
12016: $protocol{$id} = 'http';
12017: }
12018: } else {
12019: $protocol{$id} = 'http';
12020: }
12021: if (defined($intdom)) {
12022: $internetdom{$id} = $intdom;
12023: }
12024: }
12025: }
12026: }
12027:
12028: sub reset_hosts_info {
12029: &purge_remembered();
12030: &reset_domain_info();
12031: &reset_hosts_ip_info();
12032: undef(%name_to_host);
12033: undef(%hostname);
12034: undef(%hostdom);
12035: undef(%libserv);
12036: undef($loaded);
12037: }
12038:
12039: sub load_hosts_tab {
12040: my ($ignore_cache) = @_;
12041: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
12042: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12043: my @config = <$config>;
12044: &parse_hosts_tab(\@config);
12045: close($config);
12046: $loaded=1;
12047: }
12048:
12049: sub hostname {
12050: &load_hosts_tab() if (!$loaded);
12051:
12052: my ($lonid) = @_;
12053: return $hostname{$lonid};
12054: }
12055:
12056: sub all_hostnames {
12057: &load_hosts_tab() if (!$loaded);
12058:
12059: return %hostname;
12060: }
12061:
12062: sub all_names {
12063: &load_hosts_tab() if (!$loaded);
12064:
12065: return %name_to_host;
12066: }
12067:
12068: sub all_host_domain {
12069: &load_hosts_tab() if (!$loaded);
12070: return %hostdom;
12071: }
12072:
12073: sub is_library {
12074: &load_hosts_tab() if (!$loaded);
12075:
12076: return exists($libserv{$_[0]});
12077: }
12078:
12079: sub all_library {
12080: &load_hosts_tab() if (!$loaded);
12081:
12082: return %libserv;
12083: }
12084:
12085: sub unique_library {
12086: #2x reverse removes all hostnames that appear more than once
12087: my %unique = reverse &all_library();
12088: return reverse %unique;
12089: }
12090:
12091: sub get_servers {
12092: &load_hosts_tab() if (!$loaded);
12093:
12094: my ($domain,$type) = @_;
12095: my %possible_hosts = ($type eq 'library') ? %libserv
12096: : %hostname;
12097: my %result;
12098: if (ref($domain) eq 'ARRAY') {
12099: while ( my ($host,$hostname) = each(%possible_hosts)) {
12100: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
12101: $result{$host} = $hostname;
12102: }
12103: }
12104: } else {
12105: while ( my ($host,$hostname) = each(%possible_hosts)) {
12106: if ($hostdom{$host} eq $domain) {
12107: $result{$host} = $hostname;
12108: }
12109: }
12110: }
12111: return %result;
12112: }
12113:
12114: sub get_unique_servers {
12115: my %unique = reverse &get_servers(@_);
12116: return reverse %unique;
12117: }
12118:
12119: sub host_domain {
12120: &load_hosts_tab() if (!$loaded);
12121:
12122: my ($lonid) = @_;
12123: return $hostdom{$lonid};
12124: }
12125:
12126: sub all_domains {
12127: &load_hosts_tab() if (!$loaded);
12128:
12129: my %seen;
12130: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12131: return @uniq;
12132: }
12133:
12134: sub internet_dom {
12135: &load_hosts_tab() if (!$loaded);
12136:
12137: my ($lonid) = @_;
12138: return $internetdom{$lonid};
12139: }
12140:
12141: sub is_LC_dns {
12142: &load_hosts_tab() if (!$loaded);
12143:
12144: my ($hostname) = @_;
12145: return exists($LC_dns_serv{$hostname});
12146: }
12147:
12148: }
12149:
12150: {
12151: my %iphost;
12152: my %name_to_ip;
12153: my %lonid_to_ip;
12154:
12155: sub get_hosts_from_ip {
12156: my ($ip) = @_;
12157: my %iphosts = &get_iphost();
12158: if (ref($iphosts{$ip})) {
12159: return @{$iphosts{$ip}};
12160: }
12161: return;
12162: }
12163:
12164: sub reset_hosts_ip_info {
12165: undef(%iphost);
12166: undef(%name_to_ip);
12167: undef(%lonid_to_ip);
12168: }
12169:
12170: sub get_host_ip {
12171: my ($lonid) = @_;
12172: if (exists($lonid_to_ip{$lonid})) {
12173: return $lonid_to_ip{$lonid};
12174: }
12175: my $name=&hostname($lonid);
12176: my $ip = gethostbyname($name);
12177: return if (!$ip || length($ip) ne 4);
12178: $ip=inet_ntoa($ip);
12179: $name_to_ip{$name} = $ip;
12180: $lonid_to_ip{$lonid} = $ip;
12181: return $ip;
12182: }
12183:
12184: sub get_iphost {
12185: my ($ignore_cache) = @_;
12186:
12187: if (!$ignore_cache) {
12188: if (%iphost) {
12189: return %iphost;
12190: }
12191: my ($ip_info,$cached)=
12192: &Apache::lonnet::is_cached_new('iphost','iphost');
12193: if ($cached) {
12194: %iphost = %{$ip_info->[0]};
12195: %name_to_ip = %{$ip_info->[1]};
12196: %lonid_to_ip = %{$ip_info->[2]};
12197: return %iphost;
12198: }
12199: }
12200:
12201: # get yesterday's info for fallback
12202: my %old_name_to_ip;
12203: my ($ip_info,$cached)=
12204: &Apache::lonnet::is_cached_new('iphost','iphost');
12205: if ($cached) {
12206: %old_name_to_ip = %{$ip_info->[1]};
12207: }
12208:
12209: my %name_to_host = &all_names();
12210: foreach my $name (keys(%name_to_host)) {
12211: my $ip;
12212: if (!exists($name_to_ip{$name})) {
12213: $ip = gethostbyname($name);
12214: if (!$ip || length($ip) ne 4) {
12215: if (defined($old_name_to_ip{$name})) {
12216: $ip = $old_name_to_ip{$name};
12217: &logthis("Can't find $name defaulting to old $ip");
12218: } else {
12219: &logthis("Name $name no IP found");
12220: next;
12221: }
12222: } else {
12223: $ip=inet_ntoa($ip);
12224: }
12225: $name_to_ip{$name} = $ip;
12226: } else {
12227: $ip = $name_to_ip{$name};
12228: }
12229: foreach my $id (@{ $name_to_host{$name} }) {
12230: $lonid_to_ip{$id} = $ip;
12231: }
12232: push(@{$iphost{$ip}},@{$name_to_host{$name}});
12233: }
12234: &do_cache_new('iphost','iphost',
12235: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12236: 48*60*60);
12237:
12238: return %iphost;
12239: }
12240:
12241: #
12242: # Given a DNS returns the loncapa host name for that DNS
12243: #
12244: sub host_from_dns {
12245: my ($dns) = @_;
12246: my @hosts;
12247: my $ip;
12248:
12249: if (exists($name_to_ip{$dns})) {
12250: $ip = $name_to_ip{$dns};
12251: }
12252: if (!$ip) {
12253: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12254: if (length($ip) == 4) {
12255: $ip = &IO::Socket::inet_ntoa($ip);
12256: }
12257: }
12258: if ($ip) {
12259: @hosts = get_hosts_from_ip($ip);
12260: return $hosts[0];
12261: }
12262: return undef;
12263: }
12264:
12265: sub get_internet_names {
12266: my ($lonid) = @_;
12267: return if ($lonid eq '');
12268: my ($idnref,$cached)=
12269: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12270: if ($cached) {
12271: return $idnref;
12272: }
12273: my $ip = &get_host_ip($lonid);
12274: my @hosts = &get_hosts_from_ip($ip);
12275: my %iphost = &get_iphost();
12276: my (@idns,%seen);
12277: foreach my $id (@hosts) {
12278: my $dom = &host_domain($id);
12279: my $prim_id = &domain($dom,'primary');
12280: my $prim_ip = &get_host_ip($prim_id);
12281: next if ($seen{$prim_ip});
12282: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
12283: foreach my $id (@{$iphost{$prim_ip}}) {
12284: my $intdom = &internet_dom($id);
12285: unless (grep(/^\Q$intdom\E$/,@idns)) {
12286: push(@idns,$intdom);
12287: }
12288: }
12289: }
12290: $seen{$prim_ip} = 1;
12291: }
12292: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
12293: }
12294:
12295: }
12296:
12297: sub all_loncaparevs {
12298: return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11);
12299: }
12300:
12301: # ---------------------------------------------------------- Read loncaparev table
12302: {
12303: sub load_loncaparevs {
12304: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
12305: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
12306: while (my $configline=<$config>) {
12307: chomp($configline);
12308: my ($hostid,$loncaparev)=split(/:/,$configline);
12309: $loncaparevs{$hostid}=$loncaparev;
12310: }
12311: close($config);
12312: }
12313: }
12314: }
12315: }
12316:
12317: # ---------------------------------------------------------- Read serverhostID table
12318: {
12319: sub load_serverhomeIDs {
12320: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
12321: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
12322: while (my $configline=<$config>) {
12323: chomp($configline);
12324: my ($name,$id)=split(/:/,$configline);
12325: $serverhomeIDs{$name}=$id;
12326: }
12327: close($config);
12328: }
12329: }
12330: }
12331: }
12332:
12333:
12334: BEGIN {
12335:
12336: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
12337: unless ($readit) {
12338: {
12339: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
12340: %perlvar = (%perlvar,%{$configvars});
12341: }
12342:
12343:
12344: # ------------------------------------------------------ Read spare server file
12345: {
12346: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
12347:
12348: while (my $configline=<$config>) {
12349: chomp($configline);
12350: if ($configline) {
12351: my ($host,$type) = split(':',$configline,2);
12352: if (!defined($type) || $type eq '') { $type = 'default' };
12353: push(@{ $spareid{$type} }, $host);
12354: }
12355: }
12356: close($config);
12357: }
12358: # ------------------------------------------------------------ Read permissions
12359: {
12360: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
12361:
12362: while (my $configline=<$config>) {
12363: chomp($configline);
12364: if ($configline) {
12365: my ($role,$perm)=split(/ /,$configline);
12366: if ($perm ne '') { $pr{$role}=$perm; }
12367: }
12368: }
12369: close($config);
12370: }
12371:
12372: # -------------------------------------------- Read plain texts for permissions
12373: {
12374: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
12375:
12376: while (my $configline=<$config>) {
12377: chomp($configline);
12378: if ($configline) {
12379: my ($short,@plain)=split(/:/,$configline);
12380: %{$prp{$short}} = ();
12381: if (@plain > 0) {
12382: $prp{$short}{'std'} = $plain[0];
12383: for (my $i=1; $i<@plain; $i++) {
12384: $prp{$short}{'alt'.$i} = $plain[$i];
12385: }
12386: }
12387: }
12388: }
12389: close($config);
12390: }
12391:
12392: # ---------------------------------------------------------- Read package table
12393: {
12394: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
12395:
12396: while (my $configline=<$config>) {
12397: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
12398: chomp($configline);
12399: my ($short,$plain)=split(/:/,$configline);
12400: my ($pack,$name)=split(/\&/,$short);
12401: if ($plain ne '') {
12402: $packagetab{$pack.'&'.$name.'&name'}=$name;
12403: $packagetab{$short}=$plain;
12404: }
12405: }
12406: close($config);
12407: }
12408:
12409: # ---------------------------------------------------------- Read loncaparev table
12410:
12411: &load_loncaparevs();
12412:
12413: # ---------------------------------------------------------- Read serverhostID table
12414:
12415: &load_serverhomeIDs();
12416:
12417: # ---------------------------------------------------------- Read releaseslist XML
12418: {
12419: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
12420: if (-e $file) {
12421: my $parser = HTML::LCParser->new($file);
12422: while (my $token = $parser->get_token()) {
12423: if ($token->[0] eq 'S') {
12424: my $item = $token->[1];
12425: my $name = $token->[2]{'name'};
12426: my $value = $token->[2]{'value'};
12427: if ($item ne '' && $name ne '' && $value ne '') {
12428: my $release = $parser->get_text();
12429: $release =~ s/(^\s*|\s*$ )//gx;
12430: $needsrelease{$item.':'.$name.':'.$value} = $release;
12431: }
12432: }
12433: }
12434: }
12435: }
12436:
12437: # ---------------------------------------------------------- Read managers table
12438: {
12439: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
12440: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
12441: while (my $configline=<$config>) {
12442: chomp($configline);
12443: next if ($configline =~ /^\#/);
12444: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
12445: $managerstab{$configline} = 1;
12446: }
12447: }
12448: close($config);
12449: }
12450: }
12451: }
12452:
12453: # ------------- set up temporary directory
12454: {
12455: $tmpdir = LONCAPA::tempdir();
12456:
12457: }
12458:
12459: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
12460: 'compress_threshold'=> 20_000,
12461: });
12462:
12463: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
12464: $dumpcount=0;
12465: $locknum=0;
12466:
12467: &logtouch();
12468: &logthis('<font color="yellow">INFO: Read configuration</font>');
12469: $readit=1;
12470: {
12471: use integer;
12472: my $test=(2**32)+1;
12473: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
12474: &logthis(" Detected 64bit platform ($_64bit)");
12475: }
12476: }
12477: }
12478:
12479: 1;
12480: __END__
12481:
12482: =pod
12483:
12484: =head1 NAME
12485:
12486: Apache::lonnet - Subroutines to ask questions about things in the network.
12487:
12488: =head1 SYNOPSIS
12489:
12490: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
12491:
12492: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
12493:
12494: Common parameters:
12495:
12496: =over 4
12497:
12498: =item *
12499:
12500: $uname : an internal username (if $cname expecting a course Id specifically)
12501:
12502: =item *
12503:
12504: $udom : a domain (if $cdom expecting a course's domain specifically)
12505:
12506: =item *
12507:
12508: $symb : a resource instance identifier
12509:
12510: =item *
12511:
12512: $namespace : the name of a .db file that contains the data needed or
12513: being set.
12514:
12515: =back
12516:
12517: =head1 OVERVIEW
12518:
12519: lonnet provides subroutines which interact with the
12520: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
12521: about classes, users, and resources.
12522:
12523: For many of these objects you can also use this to store data about
12524: them or modify them in various ways.
12525:
12526: =head2 Symbs
12527:
12528: To identify a specific instance of a resource, LON-CAPA uses symbols
12529: or "symbs"X<symb>. These identifiers are built from the URL of the
12530: map, the resource number of the resource in the map, and the URL of
12531: the resource itself. The latter is somewhat redundant, but might help
12532: if maps change.
12533:
12534: An example is
12535:
12536: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
12537:
12538: The respective map entry is
12539:
12540: <resource id="19" src="/res/msu/korte/tests/part12.problem"
12541: title="Problem 2">
12542: </resource>
12543:
12544: Symbs are used by the random number generator, as well as to store and
12545: restore data specific to a certain instance of for example a problem.
12546:
12547: =head2 Storing And Retrieving Data
12548:
12549: X<store()>X<cstore()>X<restore()>Three of the most important functions
12550: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
12551: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
12552: is is the non-critical message twin of cstore. These functions are for
12553: handlers to store a perl hash to a user's permanent data space in an
12554: easy manner, and to retrieve it again on another call. It is expected
12555: that a handler would use this once at the beginning to retrieve data,
12556: and then again once at the end to send only the new data back.
12557:
12558: The data is stored in the user's data directory on the user's
12559: homeserver under the ID of the course.
12560:
12561: The hash that is returned by restore will have all of the previous
12562: value for all of the elements of the hash.
12563:
12564: Example:
12565:
12566: #creating a hash
12567: my %hash;
12568: $hash{'foo'}='bar';
12569:
12570: #storing it
12571: &Apache::lonnet::cstore(\%hash);
12572:
12573: #changing a value
12574: $hash{'foo'}='notbar';
12575:
12576: #adding a new value
12577: $hash{'bar'}='foo';
12578: &Apache::lonnet::cstore(\%hash);
12579:
12580: #retrieving the hash
12581: my %history=&Apache::lonnet::restore();
12582:
12583: #print the hash
12584: foreach my $key (sort(keys(%history))) {
12585: print("\%history{$key} = $history{$key}");
12586: }
12587:
12588: Will print out:
12589:
12590: %history{1:foo} = bar
12591: %history{1:keys} = foo:timestamp
12592: %history{1:timestamp} = 990455579
12593: %history{2:bar} = foo
12594: %history{2:foo} = notbar
12595: %history{2:keys} = foo:bar:timestamp
12596: %history{2:timestamp} = 990455580
12597: %history{bar} = foo
12598: %history{foo} = notbar
12599: %history{timestamp} = 990455580
12600: %history{version} = 2
12601:
12602: Note that the special hash entries C<keys>, C<version> and
12603: C<timestamp> were added to the hash. C<version> will be equal to the
12604: total number of versions of the data that have been stored. The
12605: C<timestamp> attribute will be the UNIX time the hash was
12606: stored. C<keys> is available in every historical section to list which
12607: keys were added or changed at a specific historical revision of a
12608: hash.
12609:
12610: B<Warning>: do not store the hash that restore returns directly. This
12611: will cause a mess since it will restore the historical keys as if the
12612: were new keys. I.E. 1:foo will become 1:1:foo etc.
12613:
12614: Calling convention:
12615:
12616: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
12617: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
12618:
12619: For more detailed information, see lonnet specific documentation.
12620:
12621: =head1 RETURN MESSAGES
12622:
12623: =over 4
12624:
12625: =item * B<con_lost>: unable to contact remote host
12626:
12627: =item * B<con_delayed>: unable to contact remote host, message will be delivered
12628: when the connection is brought back up
12629:
12630: =item * B<con_failed>: unable to contact remote host and unable to save message
12631: for later delivery
12632:
12633: =item * B<error:>: an error a occurred, a description of the error follows the :
12634:
12635: =item * B<no_such_host>: unable to fund a host associated with the user/domain
12636: that was requested
12637:
12638: =back
12639:
12640: =head1 PUBLIC SUBROUTINES
12641:
12642: =head2 Session Environment Functions
12643:
12644: =over 4
12645:
12646: =item *
12647: X<appenv()>
12648: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
12649: the user envirnoment file, and will be restored for each access this
12650: user makes during this session, also modifies the %env for the current
12651: process. Optional rolesarrayref - if defined contains a reference to an array
12652: of roles which are exempt from the restriction on modifying user.role entries
12653: in the user's environment.db and in %env.
12654:
12655: =item *
12656: X<delenv()>
12657: B<delenv($delthis,$regexp)>: removes all items from the session
12658: environment file that begin with $delthis. If the
12659: optional second arg - $regexp - is true, $delthis is treated as a
12660: regular expression, otherwise \Q$delthis\E is used.
12661: The values are also deleted from the current processes %env.
12662:
12663: =item * get_env_multiple($name)
12664:
12665: gets $name from the %env hash, it seemlessly handles the cases where multiple
12666: values may be defined and end up as an array ref.
12667:
12668: returns an array of values
12669:
12670: =back
12671:
12672: =head2 User Information
12673:
12674: =over 4
12675:
12676: =item *
12677: X<queryauthenticate()>
12678: B<queryauthenticate($uname,$udom)>: try to determine user's current
12679: authentication scheme
12680:
12681: =item *
12682: X<authenticate()>
12683: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
12684: authenticate user from domain's lib servers (first use the current
12685: one). C<$upass> should be the users password.
12686: $checkdefauth is optional (value is 1 if a check should be made to
12687: authenticate user using default authentication method, and allow
12688: account creation if username does not have account in the domain).
12689: $clientcancheckhost is optional (value is 1 if checking whether the
12690: server can host will occur on the client side in lonauth.pm).
12691:
12692: =item *
12693: X<homeserver()>
12694: B<homeserver($uname,$udom)>: find the server which has
12695: the user's directory and files (there must be only one), this caches
12696: the answer, and also caches if there is a borken connection.
12697:
12698: =item *
12699: X<idget()>
12700: B<idget($udom,@ids)>: find the usernames behind a list of IDs
12701: (IDs are a unique resource in a domain, there must be only 1 ID per
12702: username, and only 1 username per ID in a specific domain) (returns
12703: hash: id=>name,id=>name)
12704:
12705: =item *
12706: X<idrget()>
12707: B<idrget($udom,@unames)>: find the IDs behind a list of
12708: usernames (returns hash: name=>id,name=>id)
12709:
12710: =item *
12711: X<idput()>
12712: B<idput($udom,%ids)>: store away a list of names and associated IDs
12713:
12714: =item *
12715: X<rolesinit()>
12716: B<rolesinit($udom,$username)>: get user privileges.
12717: returns user role, first access and timer interval hashes
12718:
12719: =item *
12720: X<privileged()>
12721: B<privileged($username,$domain)>: returns a true if user has a
12722: privileged and active role (i.e. su or dc), false otherwise.
12723:
12724: =item *
12725: X<getsection()>
12726: B<getsection($udom,$uname,$cname)>: finds the section of student in the
12727: course $cname, return section name/number or '' for "not in course"
12728: and '-1' for "no section"
12729:
12730: =item *
12731: X<userenvironment()>
12732: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
12733: passed in @what from the requested user's environment, returns a hash
12734:
12735: =item *
12736: X<userlog_query()>
12737: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
12738: activity.log file. %filters defines filters applied when parsing the
12739: log file. These can be start or end timestamps, or the type of action
12740: - log to look for Login or Logout events, check for Checkin or
12741: Checkout, role for role selection. The response is in the form
12742: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
12743: escaped strings of the action recorded in the activity.log file.
12744:
12745: =back
12746:
12747: =head2 User Roles
12748:
12749: =over 4
12750:
12751: =item *
12752:
12753: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
12754: F: full access
12755: U,I,K: authentication modes (cxx only)
12756: '': forbidden
12757: 1: user needs to choose course
12758: 2: browse allowed
12759: A: passphrase authentication needed
12760:
12761: =item *
12762:
12763: constructaccess($url,$setpriv) : check for access to construction space URL
12764:
12765: See if the owner domain and name in the URL match those in the
12766: expected environment. If so, return three element list
12767: ($ownername,$ownerdomain,$ownerhome).
12768:
12769: Otherwise return the null string.
12770:
12771: If second argument 'setpriv' is true, it assigns the privileges,
12772: and returns the same three element list, unless the owner has
12773: blocked "ad hoc" Domain Coordinator access to the Author Space,
12774: in which case the null string is returned.
12775:
12776: =item *
12777:
12778: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
12779: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
12780: and course level
12781:
12782: =item *
12783:
12784: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
12785: (rolesplain.tab); plain text explanation of a user role term.
12786: $type is Course (default) or Community.
12787: If $forcedefault evaluates to true, text returned will be default
12788: text for $type. Otherwise, if this is a course, the text returned
12789: will be a custom name for the role (if defined in the course's
12790: environment). If no custom name is defined the default is returned.
12791:
12792: =item *
12793:
12794: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
12795: All arguments are optional. Returns a hash of a roles, either for
12796: co-author/assistant author roles for a user's Construction Space
12797: (default), or if $context is 'userroles', roles for the user himself,
12798: In the hash, keys are set to colon-separated $uname,$udom,$role, and
12799: (optionally) if $withsec is true, a fourth colon-separated item - $section.
12800: For each key, value is set to colon-separated start and end times for
12801: the role. If no username and domain are specified, will default to
12802: current user/domain. Types, roles, and roledoms are references to arrays
12803: of role statuses (active, future or previous), roles
12804: (e.g., cc,in, st etc.) and domains of the roles which can be used
12805: to restrict the list of roles reported. If no array ref is
12806: provided for types, will default to return only active roles.
12807:
12808: =item *
12809:
12810: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
12811: user: $uname:$udom has a role in the course: $cdom_$cnum.
12812:
12813: Additional optional arguments are: $type (if role checking is to be restricted
12814: to certain user status types -- previous (expired roles), active (currently
12815: available roles) or future (roles available in the future), and
12816: $hideprivileged -- if true will not report course roles for users who
12817: have active Domain Coordinator role in course's domain or in additional
12818: domains (specified in 'Domains to check for privileged users' in course
12819: environment -- set via: Course Settings -> Classlists and staff listing).
12820:
12821: =item *
12822:
12823: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
12824: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
12825: $possdomains and $possroles are optional array refs -- to domains to check and
12826: roles to check. If $possdomains is not specified, a dump will be done of the
12827: users' roles.db to check for a dc or su role in any domain. This can be
12828: time consuming if &privileged is called repeatedly (e.g., when displaying a
12829: classlist), so in such cases, supplying a $possdomains array is preferred, as
12830: this then allows &privileged_by_domain() to be used, which caches the identity
12831: of privileged users, eliminating the need for repeated calls to &dump().
12832:
12833: =item *
12834:
12835: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
12836: where the outer hash keys are domains specified in the $possdomains array ref,
12837: next inner hash keys are privileged roles specified in the $roles array ref,
12838: and the innermost hash contains key = value pairs for username:domain = end:start
12839: for active or future "privileged" users with that role in that domain. To avoid
12840: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
12841: innerhash are cached using priv_$role and $dom as the identifiers.
12842:
12843: =back
12844:
12845: =head2 User Modification
12846:
12847: =over 4
12848:
12849: =item *
12850:
12851: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
12852: user for the level given by URL. Optional start and end dates (leave empty
12853: string or zero for "no date")
12854:
12855: =item *
12856:
12857: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
12858: change a users, password, possible return values are: ok,
12859: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
12860: refused
12861:
12862: =item *
12863:
12864: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
12865:
12866: =item *
12867:
12868: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
12869: $forceid,$desiredhome,$email,$inststatus,$candelete) :
12870:
12871: will update user information (firstname,middlename,lastname,generation,
12872: permanentemail), and if forceid is true, student/employee ID also.
12873: A user's institutional affiliation(s) can also be updated.
12874: User information fields will not be overwritten with empty entries
12875: unless the field is included in the $candelete array reference.
12876: This array is included when a single user is modified via "Manage Users",
12877: or when Autoupdate.pl is run by cron in a domain.
12878:
12879: =item *
12880:
12881: modifystudent
12882:
12883: modify a student's enrollment and identification information.
12884: The course id is resolved based on the current user's environment.
12885: This means the invoking user must be a course coordinator or otherwise
12886: associated with a course.
12887:
12888: This call is essentially a wrapper for lonnet::modifyuser and
12889: lonnet::modify_student_enrollment
12890:
12891: Inputs:
12892:
12893: =over 4
12894:
12895: =item B<$udom> Student's loncapa domain
12896:
12897: =item B<$uname> Student's loncapa login name
12898:
12899: =item B<$uid> Student/Employee ID
12900:
12901: =item B<$umode> Student's authentication mode
12902:
12903: =item B<$upass> Student's password
12904:
12905: =item B<$first> Student's first name
12906:
12907: =item B<$middle> Student's middle name
12908:
12909: =item B<$last> Student's last name
12910:
12911: =item B<$gene> Student's generation
12912:
12913: =item B<$usec> Student's section in course
12914:
12915: =item B<$end> Unix time of the roles expiration
12916:
12917: =item B<$start> Unix time of the roles start date
12918:
12919: =item B<$forceid> If defined, allow $uid to be changed
12920:
12921: =item B<$desiredhome> server to use as home server for student
12922:
12923: =item B<$email> Student's permanent e-mail address
12924:
12925: =item B<$type> Type of enrollment (auto or manual)
12926:
12927: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
12928:
12929: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
12930:
12931: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
12932:
12933: =item B<$context> role change context (shown in User Management Logs display in a course)
12934:
12935: =item B<$inststatus> institutional status of user - : separated string of escaped status types
12936:
12937: =item B<$credits> Number of credits student will earn from this class - only needs to be supplied if value needs to be different from default credits for class.
12938:
12939: =back
12940:
12941: =item *
12942:
12943: modify_student_enrollment
12944:
12945: Change a student's enrollment status in a class. The environment variable
12946: 'role.request.course' must be defined for this function to proceed.
12947:
12948: Inputs:
12949:
12950: =over 4
12951:
12952: =item $udom, student's domain
12953:
12954: =item $uname, student's name
12955:
12956: =item $uid, student's user id
12957:
12958: =item $first, student's first name
12959:
12960: =item $middle
12961:
12962: =item $last
12963:
12964: =item $gene
12965:
12966: =item $usec
12967:
12968: =item $end
12969:
12970: =item $start
12971:
12972: =item $type
12973:
12974: =item $locktype
12975:
12976: =item $cid
12977:
12978: =item $selfenroll
12979:
12980: =item $context
12981:
12982: =item $credits, number of credits student will earn from this class
12983:
12984: =back
12985:
12986:
12987: =item *
12988:
12989: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
12990: custom role; give a custom role to a user for the level given by URL. Specify
12991: name and domain of role author, and role name
12992:
12993: =item *
12994:
12995: revokerole($udom,$uname,$url,$role) : revoke a role for url
12996:
12997: =item *
12998:
12999: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13000:
13001: =back
13002:
13003: =head2 Course Infomation
13004:
13005: =over 4
13006:
13007: =item *
13008:
13009: coursedescription($courseid,$options) : returns a hash of information about the
13010: specified course id, including all environment settings for the
13011: course, the description of the course will be in the hash under the
13012: key 'description'
13013:
13014: $options is an optional parameter that if supplied is a hash reference that controls
13015: what how this function works. It has the following key/values:
13016:
13017: =over 4
13018:
13019: =item freshen_cache
13020:
13021: If defined, and the environment cache for the course is valid, it is
13022: returned in the returned hash.
13023:
13024: =item one_time
13025:
13026: If defined, the last cache time is set to _now_
13027:
13028: =item user
13029:
13030: If defined, the supplied username is used instead of the current user.
13031:
13032:
13033: =back
13034:
13035: =item *
13036:
13037: resdata($name,$domain,$type,@which) : request for current parameter
13038: setting for a specific $type, where $type is either 'course' or 'user',
13039: @what should be a list of parameters to ask about. This routine caches
13040: answers for 10 minutes.
13041:
13042: =item *
13043:
13044: get_courseresdata($courseid, $domain) : dump the entire course resource
13045: data base, returning a hash that is keyed by the resource name and has
13046: values that are the resource value. I believe that the timestamps and
13047: versions are also returned.
13048:
13049: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13050: supplemental content area. This routine caches the number of files for
13051: 10 minutes.
13052:
13053: =back
13054:
13055: =head2 Course Modification
13056:
13057: =over 4
13058:
13059: =item *
13060:
13061: writecoursepref($courseid,%prefs) : write preferences (environment
13062: database) for a course
13063:
13064: =item *
13065:
13066: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13067:
13068: =item *
13069:
13070: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
13071:
13072: =item *
13073:
13074: is_course($courseid), is_course($cdom, $cnum)
13075:
13076: Accepts either a combined $courseid (in the form of domain_courseid) or the
13077: two component version $cdom, $cnum. It checks if the specified course exists.
13078:
13079: Returns:
13080: undef if the course doesn't exist, otherwise
13081: in scalar context the combined courseid.
13082: in list context the two components of the course identifier, domain and
13083: courseid.
13084:
13085: =back
13086:
13087: =head2 Resource Subroutines
13088:
13089: =over 4
13090:
13091: =item *
13092:
13093: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
13094:
13095: =item *
13096:
13097: repcopy($filename) : subscribes to the requested file, and attempts to
13098: replicate from the owning library server, Might return
13099: 'unavailable', 'not_found', 'forbidden', 'ok', or
13100: 'bad_request', also attempts to grab the metadata for the
13101: resource. Expects the local filesystem pathname
13102: (/home/httpd/html/res/....)
13103:
13104: =back
13105:
13106: =head2 Resource Information
13107:
13108: =over 4
13109:
13110: =item *
13111:
13112: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13113: and returns the value of a variety of different possible values,
13114: $varname should be a request string, and the other parameters can be
13115: used to specify who and what one is asking about. Ordinarily, $cid
13116: does not need to be specified, as it is retrived from
13117: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13118: within lonuserstate::loadmap() when initializing a course, before
13119: $env{'request.course.id'} has been set, so it needs to be provided
13120: in that one case.
13121:
13122: Possible values for $varname are environment.lastname (or other item
13123: from the envirnment hash), user.name (or someother aspect about the
13124: user), resource.0.maxtries (or some other part and parameter of a
13125: resource)
13126:
13127: =item *
13128:
13129: directcondval($number) : get current value of a condition; reads from a state
13130: string
13131:
13132: =item *
13133:
13134: condval($condidx) : value of condition index based on state
13135:
13136: =item *
13137:
13138: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13139: resource's metadata, $what should be either a specific key, or either
13140: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13141: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13142:
13143: this function automatically caches all requests
13144:
13145: =item *
13146:
13147: metadata_query($query,$custom,$customshow) : make a metadata query against the
13148: network of library servers; returns file handle of where SQL and regex results
13149: will be stored for query
13150:
13151: =item *
13152:
13153: symbread($filename) : return symbolic list entry (filename argument optional);
13154: returns the data handle
13155:
13156: =item *
13157:
13158: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
13159: and is a possible symb for the URL in $thisfn, and if is an encrypted
13160: resource that the user accessed using /enc/ returns a 1 on success, 0
13161: on failure, user must be in a course, as it assumes the existence of
13162: the course initial hash, and uses $env('request.course.id'}. The third
13163: arg is an optional reference to a scalar. If this arg is passed in the
13164: call to symbverify, it will be set to 1 if the symb has been set to be
13165: encrypted; otherwise it will be null.
13166:
13167: =item *
13168:
13169: symbclean($symb) : removes versions numbers from a symb, returns the
13170: cleaned symb
13171:
13172: =item *
13173:
13174: is_on_map($uri) : checks if the $uri is somewhere on the current
13175: course map, user must be in a course for it to work.
13176:
13177: =item *
13178:
13179: numval($salt) : return random seed value (addend for rndseed)
13180:
13181: =item *
13182:
13183: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13184: a random seed, all arguments are optional, if they aren't sent it uses the
13185: environment to derive them. Note: if symb isn't sent and it can't get one
13186: from &symbread it will use the current time as its return value
13187:
13188: =item *
13189:
13190: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13191: unfakeable, receipt
13192:
13193: =item *
13194:
13195: receipt() : API to ireceipt working off of env values; given out to users
13196:
13197: =item *
13198:
13199: countacc($url) : count the number of accesses to a given URL
13200:
13201: =item *
13202:
13203: 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
13204:
13205: =item *
13206:
13207: 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)
13208:
13209: =item *
13210:
13211: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
13212:
13213: =item *
13214:
13215: devalidate($symb) : devalidate temporary spreadsheet calculations,
13216: forcing spreadsheet to reevaluate the resource scores next time.
13217:
13218: =item *
13219:
13220: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
13221: when viewing in course context.
13222:
13223: input: six args -- filename (decluttered), course number, course domain,
13224: url, symb (if registered) and group (if this is a
13225: group item -- e.g., bulletin board, group page etc.).
13226:
13227: output: array of five scalars --
13228: $cfile -- url for file editing if editable on current server
13229: $home -- homeserver of resource (i.e., for author if published,
13230: or course if uploaded.).
13231: $switchserver -- 1 if server switch will be needed.
13232: $forceedit -- 1 if icon/link should be to go to edit mode
13233: $forceview -- 1 if icon/link should be to go to view mode
13234:
13235: =item *
13236:
13237: is_course_upload($file,$cnum,$cdom)
13238:
13239: Used in course context to determine if current file was uploaded to
13240: the course (i.e., would be found in /userfiles/docs on the course's
13241: homeserver.
13242:
13243: input: 3 args -- filename (decluttered), course number and course domain.
13244: output: boolean -- 1 if file was uploaded.
13245:
13246: =back
13247:
13248: =head2 Storing/Retreiving Data
13249:
13250: =over 4
13251:
13252: =item *
13253:
13254: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
13255: permanently for this url; hashref needs to be given and should be a \%hashname;
13256: the remaining args aren't required and if they aren't passed or are '' they will
13257: be derived from the env (with the exception of $laststore, which is an
13258: optional arg used when a user's submission is stored in grading).
13259: $laststore is $version=$timestamp, where $version is the most recent version
13260: number retrieved for the corresponding $symb in the $namespace db file, and
13261: $timestamp is the timestamp for that transaction (UNIX time).
13262: $laststore is currently only passed when cstore() is called by
13263: structuretags::finalize_storage().
13264:
13265: =item *
13266:
13267: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
13268: but uses critical subroutine
13269:
13270: =item *
13271:
13272: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
13273: all args are optional
13274:
13275: =item *
13276:
13277: dumpstore($namespace,$udom,$uname,$regexp,$range) :
13278: dumps the complete (or key matching regexp) namespace into a hash
13279: ($udom, $uname, $regexp, $range are optional) for a namespace that is
13280: normally &store()ed into
13281:
13282: $range should be either an integer '100' (give me the first 100
13283: matching records)
13284: or be two integers sperated by a - with no spaces
13285: '30-50' (give me the 30th through the 50th matching
13286: records)
13287:
13288:
13289: =item *
13290:
13291: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
13292: replaces a &store() version of data with a replacement set of data
13293: for a particular resource in a namespace passed in the $storehash hash
13294: reference. If $tolog is true, the transaction is logged in the courselog
13295: with an action=PUTSTORE.
13296:
13297: =item *
13298:
13299: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
13300: works very similar to store/cstore, but all data is stored in a
13301: temporary location and can be reset using tmpreset, $storehash should
13302: be a hash reference, returns nothing on success
13303:
13304: =item *
13305:
13306: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
13307: similar to restore, but all data is stored in a temporary location and
13308: can be reset using tmpreset. Returns a hash of values on success,
13309: error string otherwise.
13310:
13311: =item *
13312:
13313: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
13314: deltes all keys for $symb form the temporary storage hash.
13315:
13316: =item *
13317:
13318: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13319: reference filled in from namesp ($udom and $uname are optional)
13320:
13321: =item *
13322:
13323: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
13324: namesp ($udom and $uname are optional)
13325:
13326: =item *
13327:
13328: dump($namespace,$udom,$uname,$regexp,$range) :
13329: dumps the complete (or key matching regexp) namespace into a hash
13330: ($udom, $uname, $regexp, $range are optional)
13331:
13332: $range should be either an integer '100' (give me the first 100
13333: matching records)
13334: or be two integers sperated by a - with no spaces
13335: '30-50' (give me the 30th through the 50th matching
13336: records)
13337: =item *
13338:
13339: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
13340: $store can be a scalar, an array reference, or if the amount to be
13341: incremented is > 1, a hash reference.
13342:
13343: ($udom and $uname are optional)
13344:
13345: =item *
13346:
13347: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
13348: ($udom and $uname are optional)
13349:
13350: =item *
13351:
13352: cput($namespace,$storehash,$udom,$uname) : critical put
13353: ($udom and $uname are optional)
13354:
13355: =item *
13356:
13357: newput($namespace,$storehash,$udom,$uname) :
13358:
13359: Attempts to store the items in the $storehash, but only if they don't
13360: currently exist, if this succeeds you can be certain that you have
13361: successfully created a new key value pair in the $namespace db.
13362:
13363:
13364: Args:
13365: $namespace: name of database to store values to
13366: $storehash: hashref to store to the db
13367: $udom: (optional) domain of user containing the db
13368: $uname: (optional) name of user caontaining the db
13369:
13370: Returns:
13371: 'ok' -> succeeded in storing all keys of $storehash
13372: 'key_exists: <key>' -> failed to anything out of $storehash, as at
13373: least <key> already existed in the db (other
13374: requested keys may also already exist)
13375: 'error: <msg>' -> unable to tie the DB or other error occurred
13376: 'con_lost' -> unable to contact request server
13377: 'refused' -> action was not allowed by remote machine
13378:
13379:
13380: =item *
13381:
13382: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13383: reference filled in from namesp (encrypts the return communication)
13384: ($udom and $uname are optional)
13385:
13386: =item *
13387:
13388: log($udom,$name,$home,$message) : write to permanent log for user; use
13389: critical subroutine
13390:
13391: =item *
13392:
13393: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
13394: array reference filled in from namespace found in domain level on either
13395: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
13396:
13397: =item *
13398:
13399: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
13400: domain level either on specified domain server ($uhome) or primary domain
13401: server ($udom and $uhome are optional)
13402:
13403: =item *
13404:
13405: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
13406: for: authentication, language, quotas, timezone, date locale, and portal URL in
13407: the target domain.
13408:
13409: May also include additional key => value pairs for the following groups:
13410:
13411: =over
13412:
13413: =item
13414: disk quotas (MB allocated by default to portfolios and authoring spaces).
13415:
13416: =over
13417:
13418: =item defaultquota, authorquota
13419:
13420: =back
13421:
13422: =item
13423: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
13424: portfolio for users).
13425:
13426: =over
13427:
13428: =item
13429: aboutme, blog, webdav, portfolio
13430:
13431: =back
13432:
13433: =item
13434: requestcourses: ability to request courses, and how requests are processed.
13435:
13436: =over
13437:
13438: =item
13439: official, unofficial, community, textbook
13440:
13441: =back
13442:
13443: =item
13444: inststatus: types of institutional affiliation, and order in which they are displayed.
13445:
13446: =over
13447:
13448: =item
13449: inststatustypes, inststatusorder, inststatusguest
13450:
13451: =back
13452:
13453: =item
13454: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
13455: for course's uploaded content.
13456:
13457: =over
13458:
13459: =item
13460: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
13461: communityquota, textbookquota
13462:
13463: =back
13464:
13465: =item
13466: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
13467: on your servers.
13468:
13469: =over
13470:
13471: =item
13472: remotesessions, hostedsessions
13473:
13474: =back
13475:
13476: =back
13477:
13478: In cases where a domain coordinator has never used the "Set Domain Configuration"
13479: utility to create a configuration.db file on a domain's primary library server
13480: only the following domain defaults: auth_def, auth_arg_def, lang_def
13481: -- corresponding values are authentication type (internal, krb4, krb5,
13482: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
13483: will be available. Values are retrieved from cache (if current), unless the
13484: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
13485: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
13486:
13487: Typical usage:
13488:
13489: %domdefaults = &get_domain_defaults($target_domain);
13490:
13491: =back
13492:
13493: =head2 Network Status Functions
13494:
13495: =over 4
13496:
13497: =item *
13498:
13499: dirlist() : return directory list based on URI (first arg).
13500:
13501: Inputs: 1 required, 5 optional.
13502:
13503: =over
13504:
13505: =item
13506: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
13507:
13508: =item
13509: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
13510:
13511: =item
13512: $username - username of user/course to be listed. Extracted from $uri if absent.
13513:
13514: =item
13515: $getpropath - boolean: 1 if prepend path using &propath().
13516:
13517: =item
13518: $getuserdir - boolean: 1 if prepend path for "userfiles".
13519:
13520: =item
13521: $alternateRoot - path to prepend in place of path from $uri.
13522:
13523: =back
13524:
13525: Returns: Array of up to two items.
13526:
13527: =over
13528:
13529: a reference to an array of files/subdirectories
13530:
13531: =over
13532:
13533: Each element in the array of files/subdirectories is a & separated list of
13534: item name and the result of running stat on the item. If dirlist was requested
13535: for a file instead of a directory, the item name will be ''. For a directory
13536: listing, if the item is a metadata file, the element will end &N&M
13537: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
13538: default copyright set (1).
13539:
13540: =back
13541:
13542: a scalar containing error condition (if encountered).
13543:
13544: =over
13545:
13546: =item
13547: no_host (no homeserver identified for $username:$domain).
13548:
13549: =item
13550: no_such_host (server contacted for listing not identified as valid host).
13551:
13552: =item
13553: con_lost (connection to remote server failed).
13554:
13555: =item
13556: refused (invalid $username:$domain received on lond side).
13557:
13558: =item
13559: no_such_dir (directory at specified path on lond side does not exist).
13560:
13561: =item
13562: empty (directory at specified path on lond side is empty).
13563:
13564: =over
13565:
13566: This is currently not encountered because the &ls3, &ls2,
13567: &ls (_handler) routines on the lond side do not filter out
13568: . and .. from a directory listing.
13569:
13570: =back
13571:
13572: =back
13573:
13574: =back
13575:
13576: =item *
13577:
13578: spareserver() : find server with least workload from spare.tab
13579:
13580:
13581: =item *
13582:
13583: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
13584: if there is no corresponding loncapa host.
13585:
13586: =back
13587:
13588:
13589: =head2 Apache Request
13590:
13591: =over 4
13592:
13593: =item *
13594:
13595: ssi($url,%hash) : server side include, does a complete request cycle on url to
13596: localhost, posts hash
13597:
13598: =back
13599:
13600: =head2 Data to String to Data
13601:
13602: =over 4
13603:
13604: =item *
13605:
13606: hash2str(%hash) : convert a hash into a string complete with escaping and '='
13607: and '&' separators, supports elements that are arrayrefs and hashrefs
13608:
13609: =item *
13610:
13611: hashref2str($hashref) : convert a hashref into a string complete with
13612: escaping and '=' and '&' separators, supports elements that are
13613: arrayrefs and hashrefs
13614:
13615: =item *
13616:
13617: arrayref2str($arrayref) : convert an arrayref into a string complete
13618: with escaping and '&' separators, supports elements that are arrayrefs
13619: and hashrefs
13620:
13621: =item *
13622:
13623: str2hash($string) : convert string to hash using unescaping and
13624: splitting on '=' and '&', supports elements that are arrayrefs and
13625: hashrefs
13626:
13627: =item *
13628:
13629: str2array($string) : convert string to hash using unescaping and
13630: splitting on '&', supports elements that are arrayrefs and hashrefs
13631:
13632: =back
13633:
13634: =head2 Logging Routines
13635:
13636:
13637: These routines allow one to make log messages in the lonnet.log and
13638: lonnet.perm logfiles.
13639:
13640: =over 4
13641:
13642: =item *
13643:
13644: logtouch() : make sure the logfile, lonnet.log, exists
13645:
13646: =item *
13647:
13648: logthis() : append message to the normal lonnet.log file, it gets
13649: preiodically rolled over and deleted.
13650:
13651: =item *
13652:
13653: logperm() : append a permanent message to lonnet.perm.log, this log
13654: file never gets deleted by any automated portion of the system, only
13655: messages of critical importance should go in here.
13656:
13657:
13658: =back
13659:
13660: =head2 General File Helper Routines
13661:
13662: =over 4
13663:
13664: =item *
13665:
13666: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
13667: (a) files in /uploaded
13668: (i) If a local copy of the file exists -
13669: compares modification date of local copy with last-modified date for
13670: definitive version stored on home server for course. If local copy is
13671: stale, requests a new version from the home server and stores it.
13672: If the original has been removed from the home server, then local copy
13673: is unlinked.
13674: (ii) If local copy does not exist -
13675: requests the file from the home server and stores it.
13676:
13677: If $caller is 'uploadrep':
13678: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
13679: for request for files originally uploaded via DOCS.
13680: - returns 'ok' if fresh local copy now available, -1 otherwise.
13681:
13682: Otherwise:
13683: This indicates a call from the content generation phase of the request.
13684: - returns the entire contents of the file or -1.
13685:
13686: (b) files in /res
13687: - returns the entire contents of a file or -1;
13688: it properly subscribes to and replicates the file if neccessary.
13689:
13690:
13691: =item *
13692:
13693: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
13694: reference
13695:
13696: returns either a stat() list of data about the file or an empty list
13697: if the file doesn't exist or couldn't find out about it (connection
13698: problems or user unknown)
13699:
13700: =item *
13701:
13702: filelocation($dir,$file) : returns file system location of a file
13703: based on URI; meant to be "fairly clean" absolute reference, $dir is a
13704: directory that relative $file lookups are to looked in ($dir of /a/dir
13705: and a file of ../bob will become /a/bob)
13706:
13707: =item *
13708:
13709: hreflocation($dir,$file) : returns file system location or a URL; same as
13710: filelocation except for hrefs
13711:
13712: =item *
13713:
13714: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
13715: also removes beginning /home/httpd/html unless /priv/ follows it.
13716:
13717: =back
13718:
13719: =head2 Usererfile file routines (/uploaded*)
13720:
13721: =over 4
13722:
13723: =item *
13724:
13725: userfileupload(): main rotine for putting a file in a user or course's
13726: filespace, arguments are,
13727:
13728: formname - required - this is the name of the element in $env where the
13729: filename, and the contents of the file to create/modifed exist
13730: the filename is in $env{'form.'.$formname.'.filename'} and the
13731: contents of the file is located in $env{'form.'.$formname}
13732: context - if coursedoc, store the file in the course of the active role
13733: of the current user;
13734: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
13735: if 'canceloverwrite': delete file in tmp/overwrites directory
13736: subdir - required - subdirectory to put the file in under ../userfiles/
13737: if undefined, it will be placed in "unknown"
13738:
13739: (This routine calls clean_filename() to remove any dangerous
13740: characters from the filename, and then calls finuserfileupload() to
13741: complete the transaction)
13742:
13743: returns either the url of the uploaded file (/uploaded/....) if successful
13744: and /adm/notfound.html if unsuccessful
13745:
13746: =item *
13747:
13748: clean_filename(): routine for cleaing a filename up for storage in
13749: userfile space, argument is:
13750:
13751: filename - proposed filename
13752:
13753: returns: the new clean filename
13754:
13755: =item *
13756:
13757: finishuserfileupload(): routine that creates and sends the file to
13758: userspace, probably shouldn't be called directly
13759:
13760: docuname: username or courseid of destination for the file
13761: docudom: domain of user/course of destination for the file
13762: formname: same as for userfileupload()
13763: fname: filename (including subdirectories) for the file
13764: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
13765: allfiles: reference to hash used to store objects found by parser
13766: codebase: reference to hash used for codebases of java objects found by parser
13767: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
13768: thumbheight: height (pixels) of thumbnail to be created for uploaded image
13769: resizewidth: width to be used to resize image using resizeImage from ImageMagick
13770: resizeheight: height to be used to resize image using resizeImage from ImageMagick
13771: context: if 'overwrite', will move the uploaded file from its temporary location to
13772: userfiles to facilitate overwriting a previously uploaded file with same name.
13773: mimetype: reference to scalar to accommodate mime type determined
13774: from File::MMagic if $parser = parse.
13775:
13776: returns either the url of the uploaded file (/uploaded/....) if successful
13777: and /adm/notfound.html if unsuccessful (or an error message if context
13778: was 'overwrite').
13779:
13780:
13781: =item *
13782:
13783: renameuserfile(): renames an existing userfile to a new name
13784:
13785: Args:
13786: docuname: username or courseid of destination for the file
13787: docudom: domain of user/course of destination for the file
13788: old: current file name (including any subdirs under userfiles)
13789: new: desired file name (including any subdirs under userfiles)
13790:
13791: =item *
13792:
13793: mkdiruserfile(): creates a directory is a userfiles dir
13794:
13795: Args:
13796: docuname: username or courseid of destination for the file
13797: docudom: domain of user/course of destination for the file
13798: dir: dir to create (including any subdirs under userfiles)
13799:
13800: =item *
13801:
13802: removeuserfile(): removes a file that exists in userfiles
13803:
13804: Args:
13805: docuname: username or courseid of destination for the file
13806: docudom: domain of user/course of destination for the file
13807: fname: filname to delete (including any subdirs under userfiles)
13808:
13809: =item *
13810:
13811: removeuploadedurl(): convience function for removeuserfile()
13812:
13813: Args:
13814: url: a full /uploaded/... url to delete
13815:
13816: =item *
13817:
13818: get_portfile_permissions():
13819: Args:
13820: domain: domain of user or course contain the portfolio files
13821: user: name of user or num of course contain the portfolio files
13822: Returns:
13823: hashref of a dump of the proper file_permissions.db
13824:
13825:
13826: =item *
13827:
13828: get_access_controls():
13829:
13830: Args:
13831: current_permissions: the hash ref returned from get_portfile_permissions()
13832: group: (optional) the group you want the files associated with
13833: file: (optional) the file you want access info on
13834:
13835: Returns:
13836: a hash (keys are file names) of hashes containing
13837: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
13838: values are XML containing access control settings (see below)
13839:
13840: Internal notes:
13841:
13842: access controls are stored in file_permissions.db as key=value pairs.
13843: key -> path to file/file_name\0uniqueID:scope_end_start
13844: where scope -> public,guest,course,group,domains or users.
13845: end -> UNIX time for end of access (0 -> no end date)
13846: start -> UNIX time for start of access
13847:
13848: value -> XML description of access control
13849: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
13850: <start></start>
13851: <end></end>
13852:
13853: <password></password> for scope type = guest
13854:
13855: <domain></domain> for scope type = course or group
13856: <number></number>
13857: <roles id="">
13858: <role></role>
13859: <access></access>
13860: <section></section>
13861: <group></group>
13862: </roles>
13863:
13864: <dom></dom> for scope type = domains
13865:
13866: <users> for scope type = users
13867: <user>
13868: <uname></uname>
13869: <udom></udom>
13870: </user>
13871: </users>
13872: </scope>
13873:
13874: Access data is also aggregated for each file in an additional key=value pair:
13875: key -> path to file/file_name\0accesscontrol
13876: value -> reference to hash
13877: hash contains key = value pairs
13878: where key = uniqueID:scope_end_start
13879: value = UNIX time record was last updated
13880:
13881: Used to improve speed of look-ups of access controls for each file.
13882:
13883: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
13884:
13885: =item *
13886:
13887: modify_access_controls():
13888:
13889: Modifies access controls for a portfolio file
13890: Args
13891: 1. file name
13892: 2. reference to hash of required changes,
13893: 3. domain
13894: 4. username
13895: where domain,username are the domain of the portfolio owner
13896: (either a user or a course)
13897:
13898: Returns:
13899: 1. result of additions or updates ('ok' or 'error', with error message).
13900: 2. result of deletions ('ok' or 'error', with error message).
13901: 3. reference to hash of any new or updated access controls.
13902: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
13903: key = integer (inbound ID)
13904: value = uniqueID
13905:
13906: =item *
13907:
13908: get_timebased_id():
13909:
13910: Attempts to get a unique timestamp-based suffix for use with items added to a
13911: course via the Course Editor (e.g., folders, composite pages,
13912: group bulletin boards).
13913:
13914: Args: (first three required; six others optional)
13915:
13916: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
13917: docssequence, or name of group
13918:
13919: 2. keyid (alphanumeric): name of temporary locking key in hash,
13920: e.g., num, boardids
13921:
13922: 3. namespace: name of gdbm file used to store suffixes already assigned;
13923: file will be named nohist_namespace.db
13924:
13925: 4. cdom: domain of course; default is current course domain from %env
13926:
13927: 5. cnum: course number; default is current course number from %env
13928:
13929: 6. idtype: set to concat if an additional digit is to be appended to the
13930: unix timestamp to form the suffix, if the plain timestamp is already
13931: in use. Default is to not do this, but simply increment the unix
13932: timestamp by 1 until a unique key is obtained.
13933:
13934: 7. who: holder of locking key; defaults to user:domain for user.
13935:
13936: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
13937: retrying); default is 3.
13938:
13939: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
13940:
13941: Returns:
13942:
13943: 1. suffix obtained (numeric)
13944:
13945: 2. result of deleting locking key (ok if deleted, or lock never obtained)
13946:
13947: 3. error: contains (localized) error message if an error occurred.
13948:
13949:
13950: =back
13951:
13952: =head2 HTTP Helper Routines
13953:
13954: =over 4
13955:
13956: =item *
13957:
13958: escape() : unpack non-word characters into CGI-compatible hex codes
13959:
13960: =item *
13961:
13962: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
13963:
13964: =back
13965:
13966: =head1 PRIVATE SUBROUTINES
13967:
13968: =head2 Underlying communication routines (Shouldn't call)
13969:
13970: =over 4
13971:
13972: =item *
13973:
13974: subreply() : tries to pass a message to lonc, returns con_lost if incapable
13975:
13976: =item *
13977:
13978: reply() : uses subreply to send a message to remote machine, logs all failures
13979:
13980: =item *
13981:
13982: critical() : passes a critical message to another server; if cannot
13983: get through then place message in connection buffer directory and
13984: returns con_delayed, if incapable of saving message, returns
13985: con_failed
13986:
13987: =item *
13988:
13989: reconlonc() : tries to reconnect lonc client processes.
13990:
13991: =back
13992:
13993: =head2 Resource Access Logging
13994:
13995: =over 4
13996:
13997: =item *
13998:
13999: flushcourselogs() : flush (save) buffer logs and access logs
14000:
14001: =item *
14002:
14003: courselog($what) : save message for course in hash
14004:
14005: =item *
14006:
14007: courseacclog($what) : save message for course using &courselog(). Perform
14008: special processing for specific resource types (problems, exams, quizzes, etc).
14009:
14010: =item *
14011:
14012: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14013: as a PerlChildExitHandler
14014:
14015: =back
14016:
14017: =head2 Other
14018:
14019: =over 4
14020:
14021: =item *
14022:
14023: symblist($mapname,%newhash) : update symbolic storage links
14024:
14025: =back
14026:
14027: =cut
14028:
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