1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1267 2014/10/18 16:49:19 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) = @_;
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","$home");
4887: }
4888:
4889: # -------------------------------------------------------------- Critical Store
4890:
4891: sub cstore {
4892: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
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","$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)=@_;
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 ($reply eq 'unknown_cmd') {
5836: # gfall back to way things use to be done
5837: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5838: $uname);
5839: }
5840: return $reply;
5841: }
5842:
5843: sub old_putstore {
5844: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5845: if (!$udomain) { $udomain=$env{'user.domain'}; }
5846: if (!$uname) { $uname=$env{'user.name'}; }
5847: my $uhome=&homeserver($uname,$udomain);
5848: my %newstorehash;
5849: foreach my $item (keys(%$storehash)) {
5850: my $key = $version.':'.&escape($symb).':'.$item;
5851: $newstorehash{$key} = $storehash->{$item};
5852: }
5853: my $items='';
5854: my %allitems = ();
5855: foreach my $item (keys(%newstorehash)) {
5856: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
5857: my $key = $1.':keys:'.$2;
5858: $allitems{$key} .= $3.':';
5859: }
5860: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
5861: }
5862: foreach my $item (keys(%allitems)) {
5863: $allitems{$item} =~ s/\:$//;
5864: $items.= $item.'='.$allitems{$item}.'&';
5865: }
5866: $items=~s/\&$//;
5867: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5868: }
5869:
5870: # ------------------------------------------------------ critical put interface
5871:
5872: sub cput {
5873: my ($namespace,$storehash,$udomain,$uname)=@_;
5874: if (!$udomain) { $udomain=$env{'user.domain'}; }
5875: if (!$uname) { $uname=$env{'user.name'}; }
5876: my $uhome=&homeserver($uname,$udomain);
5877: my $items='';
5878: foreach my $item (keys(%$storehash)) {
5879: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5880: }
5881: $items=~s/\&$//;
5882: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
5883: }
5884:
5885: # -------------------------------------------------------------- eget interface
5886:
5887: sub eget {
5888: my ($namespace,$storearr,$udomain,$uname)=@_;
5889: my $items='';
5890: foreach my $item (@$storearr) {
5891: $items.=&escape($item).'&';
5892: }
5893: $items=~s/\&$//;
5894: if (!$udomain) { $udomain=$env{'user.domain'}; }
5895: if (!$uname) { $uname=$env{'user.name'}; }
5896: my $uhome=&homeserver($uname,$udomain);
5897: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
5898: my @pairs=split(/\&/,$rep);
5899: my %returnhash=();
5900: my $i=0;
5901: foreach my $item (@$storearr) {
5902: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5903: $i++;
5904: }
5905: return %returnhash;
5906: }
5907:
5908: # ------------------------------------------------------------ tmpput interface
5909: sub tmpput {
5910: my ($storehash,$server,$context)=@_;
5911: my $items='';
5912: foreach my $item (keys(%$storehash)) {
5913: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5914: }
5915: $items=~s/\&$//;
5916: if (defined($context)) {
5917: $items .= ':'.&escape($context);
5918: }
5919: return &reply("tmpput:$items",$server);
5920: }
5921:
5922: # ------------------------------------------------------------ tmpget interface
5923: sub tmpget {
5924: my ($token,$server)=@_;
5925: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5926: my $rep=&reply("tmpget:$token",$server);
5927: my %returnhash;
5928: foreach my $item (split(/\&/,$rep)) {
5929: my ($key,$value)=split(/=/,$item);
5930: next if ($key =~ /^error: 2 /);
5931: $returnhash{&unescape($key)}=&thaw_unescape($value);
5932: }
5933: return %returnhash;
5934: }
5935:
5936: # ------------------------------------------------------------ tmpdel interface
5937: sub tmpdel {
5938: my ($token,$server)=@_;
5939: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5940: return &reply("tmpdel:$token",$server);
5941: }
5942:
5943: # ------------------------------------------------------------ get_timebased_id
5944:
5945: sub get_timebased_id {
5946: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
5947: $maxtries) = @_;
5948: my ($newid,$error,$dellock);
5949: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
5950: return ('','ok','invalid call to get suffix');
5951: }
5952:
5953: # set defaults for any optional args for which values were not supplied
5954: if ($who eq '') {
5955: $who = $env{'user.name'}.':'.$env{'user.domain'};
5956: }
5957: if (!$locktries) {
5958: $locktries = 3;
5959: }
5960: if (!$maxtries) {
5961: $maxtries = 10;
5962: }
5963:
5964: if (($cdom eq '') || ($cnum eq '')) {
5965: if ($env{'request.course.id'}) {
5966: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5967: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5968: }
5969: if (($cdom eq '') || ($cnum eq '')) {
5970: return ('','ok','call to get suffix not in course context');
5971: }
5972: }
5973:
5974: # construct locking item
5975: my $lockhash = {
5976: $prefix."\0".'locked_'.$keyid => $who,
5977: };
5978: my $tries = 0;
5979:
5980: # attempt to get lock on nohist_$namespace file
5981: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
5982: while (($gotlock ne 'ok') && $tries <$locktries) {
5983: $tries ++;
5984: sleep 1;
5985: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
5986: }
5987:
5988: # attempt to get unique identifier, based on current timestamp
5989: if ($gotlock eq 'ok') {
5990: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
5991: my $id = time;
5992: $newid = $id;
5993: my $idtries = 0;
5994: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
5995: if ($idtype eq 'concat') {
5996: $newid = $id.$idtries;
5997: } else {
5998: $newid ++;
5999: }
6000: $idtries ++;
6001: }
6002: if (!exists($inuse{$prefix."\0".$newid})) {
6003: my %new_item = (
6004: $prefix."\0".$newid => $who,
6005: );
6006: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6007: $cdom,$cnum);
6008: if ($putresult ne 'ok') {
6009: undef($newid);
6010: $error = 'error saving new item: '.$putresult;
6011: }
6012: } else {
6013: $error = ('error: no unique suffix available for the new item ');
6014: }
6015: # remove lock
6016: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6017: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6018: } else {
6019: $error = "error: could not obtain lockfile\n";
6020: $dellock = 'ok';
6021: }
6022: return ($newid,$dellock,$error);
6023: }
6024:
6025: # -------------------------------------------------- portfolio access checking
6026:
6027: sub portfolio_access {
6028: my ($requrl) = @_;
6029: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
6030: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
6031: if ($result) {
6032: my %setters;
6033: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6034: my ($startblock,$endblock) =
6035: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6036: if ($startblock && $endblock) {
6037: return 'B';
6038: }
6039: } else {
6040: my ($startblock,$endblock) =
6041: &Apache::loncommon::blockcheck(\%setters,'port');
6042: if ($startblock && $endblock) {
6043: return 'B';
6044: }
6045: }
6046: }
6047: if ($result eq 'ok') {
6048: return 'F';
6049: } elsif ($result =~ /^[^:]+:guest_/) {
6050: return 'A';
6051: }
6052: return '';
6053: }
6054:
6055: sub get_portfolio_access {
6056: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
6057:
6058: if (!ref($access_hash)) {
6059: my $current_perms = &get_portfile_permissions($udom,$unum);
6060: my %access_controls = &get_access_controls($current_perms,$group,
6061: $file_name);
6062: $access_hash = $access_controls{$file_name};
6063: }
6064:
6065: my ($public,$guest,@domains,@users,@courses,@groups);
6066: my $now = time;
6067: if (ref($access_hash) eq 'HASH') {
6068: foreach my $key (keys(%{$access_hash})) {
6069: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6070: if ($start > $now) {
6071: next;
6072: }
6073: if ($end && $end<$now) {
6074: next;
6075: }
6076: if ($scope eq 'public') {
6077: $public = $key;
6078: last;
6079: } elsif ($scope eq 'guest') {
6080: $guest = $key;
6081: } elsif ($scope eq 'domains') {
6082: push(@domains,$key);
6083: } elsif ($scope eq 'users') {
6084: push(@users,$key);
6085: } elsif ($scope eq 'course') {
6086: push(@courses,$key);
6087: } elsif ($scope eq 'group') {
6088: push(@groups,$key);
6089: }
6090: }
6091: if ($public) {
6092: return 'ok';
6093: }
6094: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6095: if ($guest) {
6096: return $guest;
6097: }
6098: } else {
6099: if (@domains > 0) {
6100: foreach my $domkey (@domains) {
6101: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6102: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6103: return 'ok';
6104: }
6105: }
6106: }
6107: }
6108: if (@users > 0) {
6109: foreach my $userkey (@users) {
6110: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6111: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6112: if (ref($item) eq 'HASH') {
6113: if (($item->{'uname'} eq $env{'user.name'}) &&
6114: ($item->{'udom'} eq $env{'user.domain'})) {
6115: return 'ok';
6116: }
6117: }
6118: }
6119: }
6120: }
6121: }
6122: my %roleshash;
6123: my @courses_and_groups = @courses;
6124: push(@courses_and_groups,@groups);
6125: if (@courses_and_groups > 0) {
6126: my (%allgroups,%allroles);
6127: my ($start,$end,$role,$sec,$group);
6128: foreach my $envkey (%env) {
6129: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
6130: my $cid = $2.'_'.$3;
6131: if ($1 eq 'gr') {
6132: $group = $4;
6133: $allgroups{$cid}{$group} = $env{$envkey};
6134: } else {
6135: if ($4 eq '') {
6136: $sec = 'none';
6137: } else {
6138: $sec = $4;
6139: }
6140: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6141: }
6142: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
6143: my $cid = $2.'_'.$3;
6144: if ($4 eq '') {
6145: $sec = 'none';
6146: } else {
6147: $sec = $4;
6148: }
6149: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6150: }
6151: }
6152: if (keys(%allroles) == 0) {
6153: return;
6154: }
6155: foreach my $key (@courses_and_groups) {
6156: my %content = %{$$access_hash{$key}};
6157: my $cnum = $content{'number'};
6158: my $cdom = $content{'domain'};
6159: my $cid = $cdom.'_'.$cnum;
6160: if (!exists($allroles{$cid})) {
6161: next;
6162: }
6163: foreach my $role_id (keys(%{$content{'roles'}})) {
6164: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6165: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6166: my @status = @{$content{'roles'}{$role_id}{'access'}};
6167: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6168: foreach my $role (keys(%{$allroles{$cid}})) {
6169: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6170: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6171: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6172: if (grep/^all$/,@sections) {
6173: return 'ok';
6174: } else {
6175: if (grep/^$sec$/,@sections) {
6176: return 'ok';
6177: }
6178: }
6179: }
6180: }
6181: if (keys(%{$allgroups{$cid}}) == 0) {
6182: if (grep/^none$/,@groups) {
6183: return 'ok';
6184: }
6185: } else {
6186: if (grep/^all$/,@groups) {
6187: return 'ok';
6188: }
6189: foreach my $group (keys(%{$allgroups{$cid}})) {
6190: if (grep/^$group$/,@groups) {
6191: return 'ok';
6192: }
6193: }
6194: }
6195: }
6196: }
6197: }
6198: }
6199: }
6200: if ($guest) {
6201: return $guest;
6202: }
6203: }
6204: }
6205: return;
6206: }
6207:
6208: sub course_group_datechecker {
6209: my ($dates,$now,$status) = @_;
6210: my ($start,$end) = split(/\./,$dates);
6211: if (!$start && !$end) {
6212: return 'ok';
6213: }
6214: if (grep/^active$/,@{$status}) {
6215: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6216: return 'ok';
6217: }
6218: }
6219: if (grep/^previous$/,@{$status}) {
6220: if ($end > $now ) {
6221: return 'ok';
6222: }
6223: }
6224: if (grep/^future$/,@{$status}) {
6225: if ($start > $now) {
6226: return 'ok';
6227: }
6228: }
6229: return;
6230: }
6231:
6232: sub parse_portfolio_url {
6233: my ($url) = @_;
6234:
6235: my ($type,$udom,$unum,$group,$file_name);
6236:
6237: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
6238: $type = 1;
6239: $udom = $1;
6240: $unum = $2;
6241: $file_name = $3;
6242: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
6243: $type = 2;
6244: $udom = $1;
6245: $unum = $2;
6246: $group = $3;
6247: $file_name = $3.'/'.$4;
6248: }
6249: if (wantarray) {
6250: return ($type,$udom,$unum,$file_name,$group);
6251: }
6252: return $type;
6253: }
6254:
6255: sub is_portfolio_url {
6256: my ($url) = @_;
6257: return scalar(&parse_portfolio_url($url));
6258: }
6259:
6260: sub is_portfolio_file {
6261: my ($file) = @_;
6262: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
6263: return 1;
6264: }
6265: return;
6266: }
6267:
6268: sub usertools_access {
6269: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
6270: my ($access,%tools);
6271: if ($context eq '') {
6272: $context = 'tools';
6273: }
6274: if ($context eq 'requestcourses') {
6275: %tools = (
6276: official => 1,
6277: unofficial => 1,
6278: community => 1,
6279: textbook => 1,
6280: );
6281: } elsif ($context eq 'requestauthor') {
6282: %tools = (
6283: requestauthor => 1,
6284: );
6285: } else {
6286: %tools = (
6287: aboutme => 1,
6288: blog => 1,
6289: webdav => 1,
6290: portfolio => 1,
6291: );
6292: }
6293: return if (!defined($tools{$tool}));
6294:
6295: if (($udom eq '') || ($uname eq '')) {
6296: $udom = $env{'user.domain'};
6297: $uname = $env{'user.name'};
6298: }
6299:
6300: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6301: if ($action ne 'reload') {
6302: if ($context eq 'requestcourses') {
6303: return $env{'environment.canrequest.'.$tool};
6304: } elsif ($context eq 'requestauthor') {
6305: return $env{'environment.canrequest.author'};
6306: } else {
6307: return $env{'environment.availabletools.'.$tool};
6308: }
6309: }
6310: }
6311:
6312: my ($toolstatus,$inststatus,$envkey);
6313: if ($context eq 'requestauthor') {
6314: $envkey = $context;
6315: } else {
6316: $envkey = $context.'.'.$tool;
6317: }
6318:
6319: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6320: ($action ne 'reload')) {
6321: $toolstatus = $env{'environment.'.$envkey};
6322: $inststatus = $env{'environment.inststatus'};
6323: } else {
6324: if (ref($userenvref) eq 'HASH') {
6325: $toolstatus = $userenvref->{$envkey};
6326: $inststatus = $userenvref->{'inststatus'};
6327: } else {
6328: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6329: $toolstatus = $userenv{$envkey};
6330: $inststatus = $userenv{'inststatus'};
6331: }
6332: }
6333:
6334: if ($toolstatus ne '') {
6335: if ($toolstatus) {
6336: $access = 1;
6337: } else {
6338: $access = 0;
6339: }
6340: return $access;
6341: }
6342:
6343: my ($is_adv,%domdef);
6344: if (ref($is_advref) eq 'HASH') {
6345: $is_adv = $is_advref->{'is_adv'};
6346: } else {
6347: $is_adv = &is_advanced_user($udom,$uname);
6348: }
6349: if (ref($domdefref) eq 'HASH') {
6350: %domdef = %{$domdefref};
6351: } else {
6352: %domdef = &get_domain_defaults($udom);
6353: }
6354: if (ref($domdef{$tool}) eq 'HASH') {
6355: if ($is_adv) {
6356: if ($domdef{$tool}{'_LC_adv'} ne '') {
6357: if ($domdef{$tool}{'_LC_adv'}) {
6358: $access = 1;
6359: } else {
6360: $access = 0;
6361: }
6362: return $access;
6363: }
6364: }
6365: if ($inststatus ne '') {
6366: my ($hasaccess,$hasnoaccess);
6367: foreach my $affiliation (split(/:/,$inststatus)) {
6368: if ($domdef{$tool}{$affiliation} ne '') {
6369: if ($domdef{$tool}{$affiliation}) {
6370: $hasaccess = 1;
6371: } else {
6372: $hasnoaccess = 1;
6373: }
6374: }
6375: }
6376: if ($hasaccess || $hasnoaccess) {
6377: if ($hasaccess) {
6378: $access = 1;
6379: } elsif ($hasnoaccess) {
6380: $access = 0;
6381: }
6382: return $access;
6383: }
6384: } else {
6385: if ($domdef{$tool}{'default'} ne '') {
6386: if ($domdef{$tool}{'default'}) {
6387: $access = 1;
6388: } elsif ($domdef{$tool}{'default'} == 0) {
6389: $access = 0;
6390: }
6391: return $access;
6392: }
6393: }
6394: } else {
6395: if (($context eq 'tools') && ($tool ne 'webdav')) {
6396: $access = 1;
6397: } else {
6398: $access = 0;
6399: }
6400: return $access;
6401: }
6402: }
6403:
6404: sub is_course_owner {
6405: my ($cdom,$cnum,$udom,$uname) = @_;
6406: if (($udom eq '') || ($uname eq '')) {
6407: $udom = $env{'user.domain'};
6408: $uname = $env{'user.name'};
6409: }
6410: unless (($udom eq '') || ($uname eq '')) {
6411: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6412: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6413: return 1;
6414: } else {
6415: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6416: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6417: return 1;
6418: }
6419: }
6420: }
6421: }
6422: return;
6423: }
6424:
6425: sub is_advanced_user {
6426: my ($udom,$uname) = @_;
6427: if ($udom ne '' && $uname ne '') {
6428: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6429: if (wantarray) {
6430: return ($env{'user.adv'},$env{'user.author'});
6431: } else {
6432: return $env{'user.adv'};
6433: }
6434: }
6435: }
6436: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6437: my %allroles;
6438: my ($is_adv,$is_author);
6439: foreach my $role (keys(%roleshash)) {
6440: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6441: my $area = '/'.$tdomain.'/'.$trest;
6442: if ($sec ne '') {
6443: $area .= '/'.$sec;
6444: }
6445: if (($area ne '') && ($trole ne '')) {
6446: my $spec=$trole.'.'.$area;
6447: if ($trole =~ /^cr\//) {
6448: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6449: } elsif ($trole ne 'gr') {
6450: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6451: }
6452: if ($trole eq 'au') {
6453: $is_author = 1;
6454: }
6455: }
6456: }
6457: foreach my $role (keys(%allroles)) {
6458: last if ($is_adv);
6459: foreach my $item (split(/:/,$allroles{$role})) {
6460: if ($item ne '') {
6461: my ($privilege,$restrictions)=split(/&/,$item);
6462: if ($privilege eq 'adv') {
6463: $is_adv = 1;
6464: last;
6465: }
6466: }
6467: }
6468: }
6469: if (wantarray) {
6470: return ($is_adv,$is_author);
6471: }
6472: return $is_adv;
6473: }
6474:
6475: sub check_can_request {
6476: my ($dom,$can_request,$request_domains) = @_;
6477: my $canreq = 0;
6478: my ($types,$typename) = &Apache::loncommon::course_types();
6479: my @options = ('approval','validate','autolimit');
6480: my $optregex = join('|',@options);
6481: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6482: foreach my $type (@{$types}) {
6483: if (&usertools_access($env{'user.name'},
6484: $env{'user.domain'},
6485: $type,undef,'requestcourses')) {
6486: $canreq ++;
6487: if (ref($request_domains) eq 'HASH') {
6488: push(@{$request_domains->{$type}},$env{'user.domain'});
6489: }
6490: if ($dom eq $env{'user.domain'}) {
6491: $can_request->{$type} = 1;
6492: }
6493: }
6494: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
6495: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
6496: if (@curr > 0) {
6497: foreach my $item (@curr) {
6498: if (ref($request_domains) eq 'HASH') {
6499: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
6500: if ($otherdom ne '') {
6501: if (ref($request_domains->{$type}) eq 'ARRAY') {
6502: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
6503: push(@{$request_domains->{$type}},$otherdom);
6504: }
6505: } else {
6506: push(@{$request_domains->{$type}},$otherdom);
6507: }
6508: }
6509: }
6510: }
6511: unless($dom eq $env{'user.domain'}) {
6512: $canreq ++;
6513: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
6514: $can_request->{$type} = 1;
6515: }
6516: }
6517: }
6518: }
6519: }
6520: }
6521: return $canreq;
6522: }
6523:
6524: # ---------------------------------------------- Custom access rule evaluation
6525:
6526: sub customaccess {
6527: my ($priv,$uri)=@_;
6528: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
6529: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
6530: $udom = &LONCAPA::clean_domain($udom);
6531: $ucrs = &LONCAPA::clean_username($ucrs);
6532: my $access=0;
6533: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
6534: my ($effect,$realm,$role,$type)=split(/\:/,$right);
6535: if ($type eq 'user') {
6536: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6537: my ($tdom,$tuname)=split(m{/},$scope);
6538: if ($tdom) {
6539: if ($tdom ne $env{'user.domain'}) { next; }
6540: }
6541: if ($tuname) {
6542: if ($tuname ne $env{'user.name'}) { next; }
6543: }
6544: $access=($effect eq 'allow');
6545: last;
6546: }
6547: } else {
6548: if ($role) {
6549: if ($role ne $urole) { next; }
6550: }
6551: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6552: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6553: if ($tdom) {
6554: if ($tdom ne $udom) { next; }
6555: }
6556: if ($tcrs) {
6557: if ($tcrs ne $ucrs) { next; }
6558: }
6559: if ($tsec) {
6560: if ($tsec ne $usec) { next; }
6561: }
6562: $access=($effect eq 'allow');
6563: last;
6564: }
6565: if ($realm eq '' && $role eq '') {
6566: $access=($effect eq 'allow');
6567: }
6568: }
6569: }
6570: return $access;
6571: }
6572:
6573: # ------------------------------------------------- Check for a user privilege
6574:
6575: sub allowed {
6576: my ($priv,$uri,$symb,$role)=@_;
6577: my $ver_orguri=$uri;
6578: $uri=&deversion($uri);
6579: my $orguri=$uri;
6580: $uri=&declutter($uri);
6581:
6582: if ($priv eq 'evb') {
6583: # Evade communication block restrictions for specified role in a course
6584: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6585: return $1;
6586: } else {
6587: return;
6588: }
6589: }
6590:
6591: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
6592: # Free bre access to adm and meta resources
6593: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
6594: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6595: && ($priv eq 'bre')) {
6596: return 'F';
6597: }
6598:
6599: # Free bre access to user's own portfolio contents
6600: my ($space,$domain,$name,@dir)=split('/',$uri);
6601: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
6602: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
6603: my %setters;
6604: my ($startblock,$endblock) =
6605: &Apache::loncommon::blockcheck(\%setters,'port');
6606: if ($startblock && $endblock) {
6607: return 'B';
6608: } else {
6609: return 'F';
6610: }
6611: }
6612:
6613: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
6614: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6615: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6616: if (exists($env{'request.course.id'})) {
6617: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6618: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6619: if (($domain eq $cdom) && ($name eq $cnum)) {
6620: my $courseprivid=$env{'request.course.id'};
6621: $courseprivid=~s/\_/\//;
6622: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6623: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6624: return $1;
6625: } else {
6626: if ($env{'request.course.sec'}) {
6627: $courseprivid.='/'.$env{'request.course.sec'};
6628: }
6629: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6630: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6631: return $2;
6632: }
6633: }
6634: }
6635: }
6636: }
6637:
6638: # Free bre to public access
6639:
6640: if ($priv eq 'bre') {
6641: my $copyright=&metadata($uri,'copyright');
6642: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
6643: return 'F';
6644: }
6645: if ($copyright eq 'priv') {
6646: $uri=~/([^\/]+)\/([^\/]+)\//;
6647: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
6648: return '';
6649: }
6650: }
6651: if ($copyright eq 'domain') {
6652: $uri=~/([^\/]+)\/([^\/]+)\//;
6653: unless (($env{'user.domain'} eq $1) ||
6654: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
6655: return '';
6656: }
6657: }
6658: if ($env{'request.role'}=~ /li\.\//) {
6659: # Library role, so allow browsing of resources in this domain.
6660: return 'F';
6661: }
6662: if ($copyright eq 'custom') {
6663: unless (&customaccess($priv,$uri)) { return ''; }
6664: }
6665: }
6666: # Domain coordinator is trying to create a course
6667: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
6668: # uri is the requested domain in this case.
6669: # comparison to 'request.role.domain' shows if the user has selected
6670: # a role of dc for the domain in question.
6671: return 'F' if ($uri eq $env{'request.role.domain'});
6672: }
6673:
6674: my $thisallowed='';
6675: my $statecond=0;
6676: my $courseprivid='';
6677:
6678: my $ownaccess;
6679: # Community Coordinator or Assistant Co-author browsing resource space.
6680: if (($priv eq 'bro') && ($env{'user.author'})) {
6681: if ($uri eq '') {
6682: $ownaccess = 1;
6683: } else {
6684: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6685: my $udom = $env{'user.domain'};
6686: my $uname = $env{'user.name'};
6687: if ($uri =~ m{^\Q$udom\E/?$}) {
6688: $ownaccess = 1;
6689: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
6690: unless ($uri =~ m{\.\./}) {
6691: $ownaccess = 1;
6692: }
6693: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6694: my $now = time;
6695: if ($uri =~ m{^([^/]+)/?$}) {
6696: my $adom = $1;
6697: foreach my $key (keys(%env)) {
6698: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
6699: my ($start,$end) = split('.',$env{$key});
6700: if (($now >= $start) && (!$end || $end < $now)) {
6701: $ownaccess = 1;
6702: last;
6703: }
6704: }
6705: }
6706: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6707: my $adom = $1;
6708: my $aname = $2;
6709: foreach my $role ('ca','aa') {
6710: if ($env{"user.role.$role./$adom/$aname"}) {
6711: my ($start,$end) =
6712: split('.',$env{"user.role.$role./$adom/$aname"});
6713: if (($now >= $start) && (!$end || $end < $now)) {
6714: $ownaccess = 1;
6715: last;
6716: }
6717: }
6718: }
6719: }
6720: }
6721: }
6722: }
6723: }
6724:
6725: # Course
6726:
6727: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
6728: unless (($priv eq 'bro') && (!$ownaccess)) {
6729: $thisallowed.=$1;
6730: }
6731: }
6732:
6733: # Domain
6734:
6735: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
6736: =~/\Q$priv\E\&([^\:]*)/) {
6737: unless (($priv eq 'bro') && (!$ownaccess)) {
6738: $thisallowed.=$1;
6739: }
6740: }
6741:
6742: # User who is not author or co-author might still be able to edit
6743: # resource of an author in the domain (e.g., if Domain Coordinator).
6744: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
6745: (&allowed('mdc',$env{'request.course.id'}))) {
6746: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
6747: $thisallowed.=$1;
6748: }
6749: }
6750:
6751: # Course: uri itself is a course
6752: my $courseuri=$uri;
6753: $courseuri=~s/\_(\d)/\/$1/;
6754: $courseuri=~s/^([^\/])/\/$1/;
6755:
6756: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
6757: =~/\Q$priv\E\&([^\:]*)/) {
6758: unless (($priv eq 'bro') && (!$ownaccess)) {
6759: $thisallowed.=$1;
6760: }
6761: }
6762:
6763: # URI is an uploaded document for this course, default permissions don't matter
6764: # not allowing 'edit' access (editupload) to uploaded course docs
6765: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
6766: $thisallowed='';
6767: my ($match)=&is_on_map($uri);
6768: if ($match) {
6769: if ($env{'user.priv.'.$env{'request.role'}.'./'}
6770: =~/\Q$priv\E\&([^\:]*)/) {
6771: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6772: if (@blockers > 0) {
6773: $thisallowed = 'B';
6774: } else {
6775: $thisallowed.=$1;
6776: }
6777: }
6778: } else {
6779: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
6780: if ($refuri) {
6781: if ($refuri =~ m|^/adm/|) {
6782: $thisallowed='F';
6783: } else {
6784: $refuri=&declutter($refuri);
6785: my ($match) = &is_on_map($refuri);
6786: if ($match) {
6787: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6788: if (@blockers > 0) {
6789: $thisallowed = 'B';
6790: } else {
6791: $thisallowed='F';
6792: }
6793: }
6794: }
6795: }
6796: }
6797: }
6798:
6799: if ($priv eq 'bre'
6800: && $thisallowed ne 'F'
6801: && $thisallowed ne '2'
6802: && &is_portfolio_url($uri)) {
6803: $thisallowed = &portfolio_access($uri);
6804: }
6805:
6806: # Full access at system, domain or course-wide level? Exit.
6807: if ($thisallowed=~/F/) {
6808: return 'F';
6809: }
6810:
6811: # If this is generating or modifying users, exit with special codes
6812:
6813: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6814: if (($priv eq 'cca') || ($priv eq 'caa')) {
6815: my ($audom,$auname)=split('/',$uri);
6816: # no author name given, so this just checks on the general right to make a co-author in this domain
6817: unless ($auname) { return $thisallowed; }
6818: # an author name is given, so we are about to actually make a co-author for a certain account
6819: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6820: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6821: ($audom ne $env{'request.role.domain'}))) { return ''; }
6822: }
6823: return $thisallowed;
6824: }
6825: #
6826: # Gathered so far: system, domain and course wide privileges
6827: #
6828: # Course: See if uri or referer is an individual resource that is part of
6829: # the course
6830:
6831: if ($env{'request.course.id'}) {
6832:
6833: $courseprivid=$env{'request.course.id'};
6834: if ($env{'request.course.sec'}) {
6835: $courseprivid.='/'.$env{'request.course.sec'};
6836: }
6837: $courseprivid=~s/\_/\//;
6838: my $checkreferer=1;
6839: my ($match,$cond)=&is_on_map($uri);
6840: if ($match) {
6841: $statecond=$cond;
6842: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6843: =~/\Q$priv\E\&([^\:]*)/) {
6844: my $value = $1;
6845: if ($priv eq 'bre') {
6846: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6847: if (@blockers > 0) {
6848: $thisallowed = 'B';
6849: } else {
6850: $thisallowed.=$value;
6851: }
6852: } else {
6853: $thisallowed.=$value;
6854: }
6855: $checkreferer=0;
6856: }
6857: }
6858:
6859: if ($checkreferer) {
6860: my $refuri=$env{'httpref.'.$orguri};
6861: unless ($refuri) {
6862: foreach my $key (keys(%env)) {
6863: if ($key=~/^httpref\..*\*/) {
6864: my $pattern=$key;
6865: $pattern=~s/^httpref\.\/res\///;
6866: $pattern=~s/\*/\[\^\/\]\+/g;
6867: $pattern=~s/\//\\\//g;
6868: if ($orguri=~/$pattern/) {
6869: $refuri=$env{$key};
6870: }
6871: }
6872: }
6873: }
6874:
6875: if ($refuri) {
6876: $refuri=&declutter($refuri);
6877: my ($match,$cond)=&is_on_map($refuri);
6878: if ($match) {
6879: my $refstatecond=$cond;
6880: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6881: =~/\Q$priv\E\&([^\:]*)/) {
6882: my $value = $1;
6883: if ($priv eq 'bre') {
6884: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6885: if (@blockers > 0) {
6886: $thisallowed = 'B';
6887: } else {
6888: $thisallowed.=$value;
6889: }
6890: } else {
6891: $thisallowed.=$value;
6892: }
6893: $uri=$refuri;
6894: $statecond=$refstatecond;
6895: }
6896: }
6897: }
6898: }
6899: }
6900:
6901: #
6902: # Gathered now: all privileges that could apply, and condition number
6903: #
6904: #
6905: # Full or no access?
6906: #
6907:
6908: if ($thisallowed=~/F/) {
6909: return 'F';
6910: }
6911:
6912: unless ($thisallowed) {
6913: return '';
6914: }
6915:
6916: # Restrictions exist, deal with them
6917: #
6918: # C:according to course preferences
6919: # R:according to resource settings
6920: # L:unless locked
6921: # X:according to user session state
6922: #
6923:
6924: # Possibly locked functionality, check all courses
6925: # Locks might take effect only after 10 minutes cache expiration for other
6926: # courses, and 2 minutes for current course
6927:
6928: my $envkey;
6929: if ($thisallowed=~/L/) {
6930: foreach $envkey (keys(%env)) {
6931: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6932: my $courseid=$2;
6933: my $roleid=$1.'.'.$2;
6934: $courseid=~s/^\///;
6935: my $expiretime=600;
6936: if ($env{'request.role'} eq $roleid) {
6937: $expiretime=120;
6938: }
6939: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6940: my $prefix='course.'.$cdom.'_'.$cnum.'.';
6941: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
6942: &coursedescription($courseid,{'freshen_cache' => 1});
6943: }
6944: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6945: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6946: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6947: &log($env{'user.domain'},$env{'user.name'},
6948: $env{'user.home'},
6949: 'Locked by res: '.$priv.' for '.$uri.' due to '.
6950: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6951: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6952: return '';
6953: }
6954: }
6955: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6956: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6957: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6958: &log($env{'user.domain'},$env{'user.name'},
6959: $env{'user.home'},
6960: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
6961: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6962: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6963: return '';
6964: }
6965: }
6966: }
6967: }
6968: }
6969:
6970: #
6971: # Rest of the restrictions depend on selected course
6972: #
6973:
6974: unless ($env{'request.course.id'}) {
6975: if ($thisallowed eq 'A') {
6976: return 'A';
6977: } elsif ($thisallowed eq 'B') {
6978: return 'B';
6979: } else {
6980: return '1';
6981: }
6982: }
6983:
6984: #
6985: # Now user is definitely in a course
6986: #
6987:
6988:
6989: # Course preferences
6990:
6991: if ($thisallowed=~/C/) {
6992: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6993: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
6994: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
6995: =~/\Q$rolecode\E/) {
6996: if (($priv ne 'pch') && ($priv ne 'plc')) {
6997: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6998: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
6999: $env{'request.course.id'});
7000: }
7001: return '';
7002: }
7003:
7004: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
7005: =~/\Q$unamedom\E/) {
7006: if (($priv ne 'pch') && ($priv ne 'plc')) {
7007: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7008: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7009: $env{'request.course.id'});
7010: }
7011: return '';
7012: }
7013: }
7014:
7015: # Resource preferences
7016:
7017: if ($thisallowed=~/R/) {
7018: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7019: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
7020: if (($priv ne 'pch') && ($priv ne 'plc')) {
7021: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7022: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7023: }
7024: return '';
7025: }
7026: }
7027:
7028: # Restricted by state or randomout?
7029:
7030: if ($thisallowed=~/X/) {
7031: if ($env{'acc.randomout'}) {
7032: if (!$symb) { $symb=&symbread($uri,1); }
7033: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
7034: return '';
7035: }
7036: }
7037: if (&condval($statecond)) {
7038: return '2';
7039: } else {
7040: return '';
7041: }
7042: }
7043:
7044: if ($thisallowed eq 'A') {
7045: return 'A';
7046: } elsif ($thisallowed eq 'B') {
7047: return 'B';
7048: }
7049: return 'F';
7050: }
7051:
7052: # ------------------------------------------- Check construction space access
7053:
7054: sub constructaccess {
7055: my ($url,$setpriv)=@_;
7056:
7057: # We do not allow editing of previous versions of files
7058: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7059:
7060: # Get username and domain from URL
7061: my ($ownername,$ownerdomain,$ownerhome);
7062:
7063: ($ownerdomain,$ownername) =
7064: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)/});
7065:
7066: # The URL does not really point to any authorspace, forget it
7067: unless (($ownername) && ($ownerdomain)) { return ''; }
7068:
7069: # Now we need to see if the user has access to the authorspace of
7070: # $ownername at $ownerdomain
7071:
7072: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7073: # Real author for this?
7074: $ownerhome = $env{'user.home'};
7075: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7076: return ($ownername,$ownerdomain,$ownerhome);
7077: }
7078: } else {
7079: # Co-author for this?
7080: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7081: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7082: $ownerhome = &homeserver($ownername,$ownerdomain);
7083: return ($ownername,$ownerdomain,$ownerhome);
7084: }
7085: }
7086:
7087: # We don't have any access right now. If we are not possibly going to do anything about this,
7088: # we might as well leave
7089: unless ($setpriv) { return ''; }
7090:
7091: # Backdoor access?
7092: my $allowed=&allowed('eco',$ownerdomain);
7093: # Nope
7094: unless ($allowed) { return ''; }
7095: # Looks like we may have access, but could be locked by the owner of the construction space
7096: if ($allowed eq 'U') {
7097: my %blocked=&get('environment',['domcoord.author'],
7098: $ownerdomain,$ownername);
7099: # Is blocked by owner
7100: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7101: }
7102: if (($allowed eq 'F') || ($allowed eq 'U')) {
7103: # Grant temporary access
7104: my $then=$env{'user.login.time'};
7105: my $update=$env{'user.update.time'};
7106: if (!$update) { $update = $then; }
7107: my $refresh=$env{'user.refresh.time'};
7108: if (!$refresh) { $refresh = $update; }
7109: my $now = time;
7110: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7111: $now,'ca','constructaccess');
7112: $ownerhome = &homeserver($ownername,$ownerdomain);
7113: return($ownername,$ownerdomain,$ownerhome);
7114: }
7115: # No business here
7116: return '';
7117: }
7118:
7119: sub get_comm_blocks {
7120: my ($cdom,$cnum) = @_;
7121: if ($cdom eq '' || $cnum eq '') {
7122: return unless ($env{'request.course.id'});
7123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7125: }
7126: my %commblocks;
7127: my $hashid=$cdom.'_'.$cnum;
7128: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7129: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7130: %commblocks = %{$blocksref};
7131: } else {
7132: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7133: my $cachetime = 600;
7134: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7135: }
7136: return %commblocks;
7137: }
7138:
7139: sub has_comm_blocking {
7140: my ($priv,$symb,$uri,$blocks) = @_;
7141: return unless ($env{'request.course.id'});
7142: return unless ($priv eq 'bre');
7143: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7144: my %commblocks;
7145: if (ref($blocks) eq 'HASH') {
7146: %commblocks = %{$blocks};
7147: } else {
7148: %commblocks = &get_comm_blocks();
7149: }
7150: return unless (keys(%commblocks) > 0);
7151: if (!$symb) { $symb=&symbread($uri,1); }
7152: my ($map,$resid,undef)=&decode_symb($symb);
7153: my %tocheck = (
7154: maps => $map,
7155: resources => $symb,
7156: );
7157: my @blockers;
7158: my $now = time;
7159: my $navmap = Apache::lonnavmaps::navmap->new();
7160: foreach my $block (keys(%commblocks)) {
7161: if ($block =~ /^(\d+)____(\d+)$/) {
7162: my ($start,$end) = ($1,$2);
7163: if ($start <= $now && $end >= $now) {
7164: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7165: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7166: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7167: if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
7168: unless (grep(/^\Q$block\E$/,@blockers)) {
7169: push(@blockers,$block);
7170: }
7171: }
7172: }
7173: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7174: if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
7175: unless (grep(/^\Q$block\E$/,@blockers)) {
7176: push(@blockers,$block);
7177: }
7178: }
7179: }
7180: }
7181: }
7182: }
7183: } elsif ($block =~ /^firstaccess____(.+)$/) {
7184: my $item = $1;
7185: my @to_test;
7186: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7187: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7188: my $check_interval;
7189: if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
7190: my @interval;
7191: my $type = 'map';
7192: if ($item eq 'course') {
7193: $type = 'course';
7194: @interval=&EXT("resource.0.interval");
7195: } else {
7196: if ($item =~ /___\d+___/) {
7197: $type = 'resource';
7198: @interval=&EXT("resource.0.interval",$item);
7199: if (ref($navmap)) {
7200: my $res = $navmap->getBySymb($item);
7201: push(@to_test,$res);
7202: }
7203: } else {
7204: my $mapsymb = &symbread($item,1);
7205: if ($mapsymb) {
7206: if (ref($navmap)) {
7207: my $mapres = $navmap->getBySymb($mapsymb);
7208: @to_test = $mapres->retrieveResources($mapres,undef,0,1);
7209: foreach my $res (@to_test) {
7210: my $symb = $res->symb();
7211: next if ($symb eq $mapsymb);
7212: if ($symb ne '') {
7213: @interval=&EXT("resource.0.interval",$symb);
7214: last;
7215: }
7216: }
7217: }
7218: }
7219: }
7220: }
7221: if ($interval[0] =~ /\d+/) {
7222: my $first_access;
7223: if ($type eq 'resource') {
7224: $first_access=&get_first_access($interval[1],$item);
7225: } elsif ($type eq 'map') {
7226: $first_access=&get_first_access($interval[1],undef,$item);
7227: } else {
7228: $first_access=&get_first_access($interval[1]);
7229: }
7230: if ($first_access) {
7231: my $timesup = $first_access+$interval[0];
7232: if ($timesup > $now) {
7233: foreach my $res (@to_test) {
7234: if ($res->is_problem()) {
7235: if ($res->completable()) {
7236: unless (grep(/^\Q$block\E$/,@blockers)) {
7237: push(@blockers,$block);
7238: }
7239: last;
7240: }
7241: }
7242: }
7243: }
7244: }
7245: }
7246: }
7247: }
7248: }
7249: }
7250: }
7251: return @blockers;
7252: }
7253:
7254: sub check_docs_block {
7255: my ($docsblock,$tocheck) =@_;
7256: if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
7257: return;
7258: }
7259: if (ref($docsblock->{'maps'}) eq 'HASH') {
7260: if ($tocheck->{'maps'}) {
7261: if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
7262: return 1;
7263: }
7264: }
7265: }
7266: if (ref($docsblock->{'resources'}) eq 'HASH') {
7267: if ($tocheck->{'resources'}) {
7268: if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
7269: return 1;
7270: }
7271: }
7272: }
7273: return;
7274: }
7275:
7276: #
7277: # Removes the versino from a URI and
7278: # splits it in to its filename and path to the filename.
7279: # Seems like File::Basename could have done this more clearly.
7280: # Parameters:
7281: # $uri - input URI
7282: # Returns:
7283: # Two element list consisting of
7284: # $pathname - the URI up to and excluding the trailing /
7285: # $filename - The part of the URI following the last /
7286: # NOTE:
7287: # Another realization of this is simply:
7288: # use File::Basename;
7289: # ...
7290: # $uri = shift;
7291: # $filename = basename($uri);
7292: # $path = dirname($uri);
7293: # return ($filename, $path);
7294: #
7295: # The implementation below is probably faster however.
7296: #
7297: sub split_uri_for_cond {
7298: my $uri=&deversion(&declutter(shift));
7299: my @uriparts=split(/\//,$uri);
7300: my $filename=pop(@uriparts);
7301: my $pathname=join('/',@uriparts);
7302: return ($pathname,$filename);
7303: }
7304: # --------------------------------------------------- Is a resource on the map?
7305:
7306: sub is_on_map {
7307: my ($pathname,$filename) = &split_uri_for_cond(shift);
7308: #Trying to find the conditional for the file
7309: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
7310: /\&\Q$filename\E\:([\d\|]+)\&/);
7311: if ($match) {
7312: return (1,$1);
7313: } else {
7314: return (0,0);
7315: }
7316: }
7317:
7318: # --------------------------------------------------------- Get symb from alias
7319:
7320: sub get_symb_from_alias {
7321: my $symb=shift;
7322: my ($map,$resid,$url)=&decode_symb($symb);
7323: # Already is a symb
7324: if ($url) { return $symb; }
7325: # Must be an alias
7326: my $aliassymb='';
7327: my %bighash;
7328: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7329: &GDBM_READER(),0640)) {
7330: my $rid=$bighash{'mapalias_'.$symb};
7331: if ($rid) {
7332: my ($mapid,$resid)=split(/\./,$rid);
7333: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7334: $resid,$bighash{'src_'.$rid});
7335: }
7336: untie %bighash;
7337: }
7338: return $aliassymb;
7339: }
7340:
7341: # ----------------------------------------------------------------- Define Role
7342:
7343: sub definerole {
7344: if (allowed('mcr','/')) {
7345: my ($rolename,$sysrole,$domrole,$courole)=@_;
7346: foreach my $role (split(':',$sysrole)) {
7347: my ($crole,$cqual)=split(/\&/,$role);
7348: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7349: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7350: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7351: return "refused:s:$crole&$cqual";
7352: }
7353: }
7354: }
7355: foreach my $role (split(':',$domrole)) {
7356: my ($crole,$cqual)=split(/\&/,$role);
7357: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7358: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7359: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
7360: return "refused:d:$crole&$cqual";
7361: }
7362: }
7363: }
7364: foreach my $role (split(':',$courole)) {
7365: my ($crole,$cqual)=split(/\&/,$role);
7366: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7367: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7368: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7369: return "refused:c:$crole&$cqual";
7370: }
7371: }
7372: }
7373: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7374: "$env{'user.domain'}:$env{'user.name'}:".
7375: "rolesdef_$rolename=".
7376: escape($sysrole.'_'.$domrole.'_'.$courole);
7377: return reply($command,$env{'user.home'});
7378: } else {
7379: return 'refused';
7380: }
7381: }
7382:
7383: # ---------------- Make a metadata query against the network of library servers
7384:
7385: sub metadata_query {
7386: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
7387: my %rhash;
7388: my %libserv = &all_library();
7389: my @server_list = (defined($server_array) ? @$server_array
7390: : keys(%libserv) );
7391: for my $server (@server_list) {
7392: my $domains = '';
7393: if (ref($domains_hash) eq 'HASH') {
7394: $domains = $domains_hash->{$server};
7395: }
7396: unless ($custom or $customshow) {
7397: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
7398: $rhash{$server}=$reply;
7399: }
7400: else {
7401: my $reply=&reply("querysend:".&escape($query).':'.
7402: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
7403: $server);
7404: $rhash{$server}=$reply;
7405: }
7406: }
7407: return \%rhash;
7408: }
7409:
7410: # ----------------------------------------- Send log queries and wait for reply
7411:
7412: sub log_query {
7413: my ($uname,$udom,$query,%filters)=@_;
7414: my $uhome=&homeserver($uname,$udom);
7415: if ($uhome eq 'no_host') { return 'error: no_host'; }
7416: my $uhost=&hostname($uhome);
7417: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
7418: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
7419: $uhome);
7420: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
7421: return get_query_reply($queryid);
7422: }
7423:
7424: # -------------------------- Update MySQL table for portfolio file
7425:
7426: sub update_portfolio_table {
7427: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
7428: if ($group ne '') {
7429: $file_name =~s /^\Q$group\E//;
7430: }
7431: my $homeserver = &homeserver($uname,$udom);
7432: my $queryid=
7433: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
7434: ':'.&escape($file_name).':'.$action,$homeserver);
7435: my $reply = &get_query_reply($queryid);
7436: return $reply;
7437: }
7438:
7439: # -------------------------- Update MySQL allusers table
7440:
7441: sub update_allusers_table {
7442: my ($uname,$udom,$names) = @_;
7443: my $homeserver = &homeserver($uname,$udom);
7444: my $queryid=
7445: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
7446: 'lastname='.&escape($names->{'lastname'}).'%%'.
7447: 'firstname='.&escape($names->{'firstname'}).'%%'.
7448: 'middlename='.&escape($names->{'middlename'}).'%%'.
7449: 'generation='.&escape($names->{'generation'}).'%%'.
7450: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
7451: 'id='.&escape($names->{'id'}),$homeserver);
7452: return;
7453: }
7454:
7455: # ------- Request retrieval of institutional classlists for course(s)
7456:
7457: sub fetch_enrollment_query {
7458: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
7459: my $homeserver;
7460: my $maxtries = 1;
7461: if ($context eq 'automated') {
7462: $homeserver = $perlvar{'lonHostID'};
7463: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
7464: } else {
7465: $homeserver = &homeserver($cnum,$dom);
7466: }
7467: my $host=&hostname($homeserver);
7468: my $cmd = '';
7469: foreach my $affiliate (keys(%{$affiliatesref})) {
7470: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7471: }
7472: $cmd =~ s/%%$//;
7473: $cmd = &escape($cmd);
7474: my $query = 'fetchenrollment';
7475: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
7476: unless ($queryid=~/^\Q$host\E\_/) {
7477: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
7478: return 'error: '.$queryid;
7479: }
7480: my $reply = &get_query_reply($queryid);
7481: my $tries = 1;
7482: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7483: $reply = &get_query_reply($queryid);
7484: $tries ++;
7485: }
7486: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7487: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7488: } else {
7489: my @responses = split(/:/,$reply);
7490: if ($homeserver eq $perlvar{'lonHostID'}) {
7491: foreach my $line (@responses) {
7492: my ($key,$value) = split(/=/,$line,2);
7493: $$replyref{$key} = $value;
7494: }
7495: } else {
7496: my $pathname = LONCAPA::tempdir();
7497: foreach my $line (@responses) {
7498: my ($key,$value) = split(/=/,$line);
7499: $$replyref{$key} = $value;
7500: if ($value > 0) {
7501: foreach my $item (@{$$affiliatesref{$key}}) {
7502: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
7503: my $destname = $pathname.'/'.$filename;
7504: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
7505: if ($xml_classlist =~ /^error/) {
7506: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
7507: } else {
7508: if ( open(FILE,">$destname") ) {
7509: print FILE &unescape($xml_classlist);
7510: close(FILE);
7511: } else {
7512: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
7513: }
7514: }
7515: }
7516: }
7517: }
7518: }
7519: return 'ok';
7520: }
7521: return 'error';
7522: }
7523:
7524: sub get_query_reply {
7525: my $queryid=shift;
7526: my $replyfile=LONCAPA::tempdir().$queryid;
7527: my $reply='';
7528: for (1..100) {
7529: sleep 2;
7530: if (-e $replyfile.'.end') {
7531: if (open(my $fh,$replyfile)) {
7532: $reply = join('',<$fh>);
7533: close($fh);
7534: } else { return 'error: reply_file_error'; }
7535: return &unescape($reply);
7536: }
7537: }
7538: return 'timeout:'.$queryid;
7539: }
7540:
7541: sub courselog_query {
7542: #
7543: # possible filters:
7544: # url: url or symb
7545: # username
7546: # domain
7547: # action: view, submit, grade
7548: # start: timestamp
7549: # end: timestamp
7550: #
7551: my (%filters)=@_;
7552: unless ($env{'request.course.id'}) { return 'no_course'; }
7553: if ($filters{'url'}) {
7554: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
7555: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
7556: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
7557: }
7558: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
7559: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
7560: return &log_query($cname,$cdom,'courselog',%filters);
7561: }
7562:
7563: sub userlog_query {
7564: #
7565: # possible filters:
7566: # action: log check role
7567: # start: timestamp
7568: # end: timestamp
7569: #
7570: my ($uname,$udom,%filters)=@_;
7571: return &log_query($uname,$udom,'userlog',%filters);
7572: }
7573:
7574: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
7575:
7576: sub auto_run {
7577: my ($cnum,$cdom) = @_;
7578: my $response = 0;
7579: my $settings;
7580: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
7581: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
7582: $settings = $domconfig{'autoenroll'};
7583: if ($settings->{'run'} eq '1') {
7584: $response = 1;
7585: }
7586: } else {
7587: my $homeserver;
7588: if (&is_course($cdom,$cnum)) {
7589: $homeserver = &homeserver($cnum,$cdom);
7590: } else {
7591: $homeserver = &domain($cdom,'primary');
7592: }
7593: if ($homeserver ne 'no_host') {
7594: $response = &reply('autorun:'.$cdom,$homeserver);
7595: }
7596: }
7597: return $response;
7598: }
7599:
7600: sub auto_get_sections {
7601: my ($cnum,$cdom,$inst_coursecode) = @_;
7602: my $homeserver;
7603: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7604: $homeserver = &homeserver($cnum,$cdom);
7605: }
7606: if (!defined($homeserver)) {
7607: if ($cdom =~ /^$match_domain$/) {
7608: $homeserver = &domain($cdom,'primary');
7609: }
7610: }
7611: my @secs;
7612: if (defined($homeserver)) {
7613: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
7614: unless ($response eq 'refused') {
7615: @secs = split(/:/,$response);
7616: }
7617: }
7618: return @secs;
7619: }
7620:
7621: sub auto_new_course {
7622: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
7623: my $homeserver = &homeserver($cnum,$cdom);
7624: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
7625: return $response;
7626: }
7627:
7628: sub auto_validate_courseID {
7629: my ($cnum,$cdom,$inst_course_id) = @_;
7630: my $homeserver = &homeserver($cnum,$cdom);
7631: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
7632: return $response;
7633: }
7634:
7635: sub auto_validate_instcode {
7636: my ($cnum,$cdom,$instcode,$owner) = @_;
7637: my ($homeserver,$response);
7638: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7639: $homeserver = &homeserver($cnum,$cdom);
7640: }
7641: if (!defined($homeserver)) {
7642: if ($cdom =~ /^$match_domain$/) {
7643: $homeserver = &domain($cdom,'primary');
7644: }
7645: }
7646: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
7647: &escape($instcode).':'.&escape($owner),$homeserver));
7648: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
7649: return ($outcome,$description,$defaultcredits);
7650: }
7651:
7652: sub auto_create_password {
7653: my ($cnum,$cdom,$authparam,$udom) = @_;
7654: my ($homeserver,$response);
7655: my $create_passwd = 0;
7656: my $authchk = '';
7657: if ($udom =~ /^$match_domain$/) {
7658: $homeserver = &domain($udom,'primary');
7659: }
7660: if ($homeserver eq '') {
7661: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7662: $homeserver = &homeserver($cnum,$cdom);
7663: }
7664: }
7665: if ($homeserver eq '') {
7666: $authchk = 'nodomain';
7667: } else {
7668: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
7669: if ($response eq 'refused') {
7670: $authchk = 'refused';
7671: } else {
7672: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
7673: }
7674: }
7675: return ($authparam,$create_passwd,$authchk);
7676: }
7677:
7678: sub auto_photo_permission {
7679: my ($cnum,$cdom,$students) = @_;
7680: my $homeserver = &homeserver($cnum,$cdom);
7681: my ($outcome,$perm_reqd,$conditions) =
7682: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
7683: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7684: return (undef,undef);
7685: }
7686: return ($outcome,$perm_reqd,$conditions);
7687: }
7688:
7689: sub auto_checkphotos {
7690: my ($uname,$udom,$pid) = @_;
7691: my $homeserver = &homeserver($uname,$udom);
7692: my ($result,$resulttype);
7693: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
7694: &escape($uname).':'.&escape($pid),
7695: $homeserver));
7696: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7697: return (undef,undef);
7698: }
7699: if ($outcome) {
7700: ($result,$resulttype) = split(/:/,$outcome);
7701: }
7702: return ($result,$resulttype);
7703: }
7704:
7705: sub auto_photochoice {
7706: my ($cnum,$cdom) = @_;
7707: my $homeserver = &homeserver($cnum,$cdom);
7708: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
7709: &escape($cdom),
7710: $homeserver)));
7711: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7712: return (undef,undef);
7713: }
7714: return ($update,$comment);
7715: }
7716:
7717: sub auto_photoupdate {
7718: my ($affiliatesref,$dom,$cnum,$photo) = @_;
7719: my $homeserver = &homeserver($cnum,$dom);
7720: my $host=&hostname($homeserver);
7721: my $cmd = '';
7722: my $maxtries = 1;
7723: foreach my $affiliate (keys(%{$affiliatesref})) {
7724: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7725: }
7726: $cmd =~ s/%%$//;
7727: $cmd = &escape($cmd);
7728: my $query = 'institutionalphotos';
7729: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
7730: unless ($queryid=~/^\Q$host\E\_/) {
7731: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
7732: return 'error: '.$queryid;
7733: }
7734: my $reply = &get_query_reply($queryid);
7735: my $tries = 1;
7736: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7737: $reply = &get_query_reply($queryid);
7738: $tries ++;
7739: }
7740: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7741: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7742: } else {
7743: my @responses = split(/:/,$reply);
7744: my $outcome = shift(@responses);
7745: foreach my $item (@responses) {
7746: my ($key,$value) = split(/=/,$item);
7747: $$photo{$key} = $value;
7748: }
7749: return $outcome;
7750: }
7751: return 'error';
7752: }
7753:
7754: sub auto_instcode_format {
7755: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
7756: $cat_order) = @_;
7757: my $courses = '';
7758: my @homeservers;
7759: if ($caller eq 'global') {
7760: my %servers = &get_servers($codedom,'library');
7761: foreach my $tryserver (keys(%servers)) {
7762: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7763: push(@homeservers,$tryserver);
7764: }
7765: }
7766: } elsif ($caller eq 'requests') {
7767: if ($codedom =~ /^$match_domain$/) {
7768: my $chome = &domain($codedom,'primary');
7769: unless ($chome eq 'no_host') {
7770: push(@homeservers,$chome);
7771: }
7772: }
7773: } else {
7774: push(@homeservers,&homeserver($caller,$codedom));
7775: }
7776: foreach my $code (keys(%{$instcodes})) {
7777: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
7778: }
7779: chop($courses);
7780: my $ok_response = 0;
7781: my $response;
7782: while (@homeservers > 0 && $ok_response == 0) {
7783: my $server = shift(@homeservers);
7784: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
7785: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
7786: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
7787: split(/:/,$response);
7788: %{$codes} = (%{$codes},&str2hash($codes_str));
7789: push(@{$codetitles},&str2array($codetitles_str));
7790: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
7791: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
7792: $ok_response = 1;
7793: }
7794: }
7795: if ($ok_response) {
7796: return 'ok';
7797: } else {
7798: return $response;
7799: }
7800: }
7801:
7802: sub auto_instcode_defaults {
7803: my ($domain,$returnhash,$code_order) = @_;
7804: my @homeservers;
7805:
7806: my %servers = &get_servers($domain,'library');
7807: foreach my $tryserver (keys(%servers)) {
7808: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7809: push(@homeservers,$tryserver);
7810: }
7811: }
7812:
7813: my $response;
7814: foreach my $server (@homeservers) {
7815: $response=&reply('autoinstcodedefaults:'.$domain,$server);
7816: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7817:
7818: foreach my $pair (split(/\&/,$response)) {
7819: my ($name,$value)=split(/\=/,$pair);
7820: if ($name eq 'code_order') {
7821: @{$code_order} = split(/\&/,&unescape($value));
7822: } else {
7823: $returnhash->{&unescape($name)}=&unescape($value);
7824: }
7825: }
7826: return 'ok';
7827: }
7828:
7829: return $response;
7830: }
7831:
7832: sub auto_possible_instcodes {
7833: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
7834: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
7835: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
7836: return;
7837: }
7838: my (@homeservers,$uhome);
7839: if (defined(&domain($domain,'primary'))) {
7840: $uhome=&domain($domain,'primary');
7841: push(@homeservers,&domain($domain,'primary'));
7842: } else {
7843: my %servers = &get_servers($domain,'library');
7844: foreach my $tryserver (keys(%servers)) {
7845: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7846: push(@homeservers,$tryserver);
7847: }
7848: }
7849: }
7850: my $response;
7851: foreach my $server (@homeservers) {
7852: $response=&reply('autopossibleinstcodes:'.$domain,$server);
7853: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7854: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
7855: split(':',$response);
7856: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
7857: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
7858: foreach my $item (split('&',$cat_title)) {
7859: my ($name,$value)=split('=',$item);
7860: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
7861: }
7862: foreach my $item (split('&',$cat_order)) {
7863: my ($name,$value)=split('=',$item);
7864: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
7865: }
7866: return 'ok';
7867: }
7868: return $response;
7869: }
7870:
7871: sub auto_courserequest_checks {
7872: my ($dom) = @_;
7873: my ($homeserver,%validations);
7874: if ($dom =~ /^$match_domain$/) {
7875: $homeserver = &domain($dom,'primary');
7876: }
7877: unless ($homeserver eq 'no_host') {
7878: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
7879: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7880: my @items = split(/&/,$response);
7881: foreach my $item (@items) {
7882: my ($key,$value) = split('=',$item);
7883: $validations{&unescape($key)} = &thaw_unescape($value);
7884: }
7885: }
7886: }
7887: return %validations;
7888: }
7889:
7890: sub auto_courserequest_validation {
7891: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
7892: my ($homeserver,$response);
7893: if ($dom =~ /^$match_domain$/) {
7894: $homeserver = &domain($dom,'primary');
7895: }
7896: unless ($homeserver eq 'no_host') {
7897: my $customdata;
7898: if (ref($custominfo) eq 'HASH') {
7899: $customdata = &freeze_escape($custominfo);
7900: }
7901: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
7902: ':'.&escape($crstype).':'.&escape($inststatuslist).
7903: ':'.&escape($instcode).':'.&escape($instseclist).':'.
7904: $customdata,$homeserver));
7905: }
7906: return $response;
7907: }
7908:
7909: sub auto_validate_class_sec {
7910: my ($cdom,$cnum,$owners,$inst_class) = @_;
7911: my $homeserver = &homeserver($cnum,$cdom);
7912: my $ownerlist;
7913: if (ref($owners) eq 'ARRAY') {
7914: $ownerlist = join(',',@{$owners});
7915: } else {
7916: $ownerlist = $owners;
7917: }
7918: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
7919: &escape($ownerlist).':'.$cdom,$homeserver);
7920: return $response;
7921: }
7922:
7923: sub auto_crsreq_update {
7924: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
7925: $code,$accessstart,$accessend,$inbound) = @_;
7926: my ($homeserver,%crsreqresponse);
7927: if ($cdom =~ /^$match_domain$/) {
7928: $homeserver = &domain($cdom,'primary');
7929: }
7930: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
7931: my $info;
7932: if (ref($inbound) eq 'HASH') {
7933: $info = &freeze_escape($inbound);
7934: }
7935: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
7936: ':'.&escape($action).':'.&escape($ownername).':'.
7937: &escape($ownerdomain).':'.&escape($fullname).':'.
7938: &escape($title).':'.&escape($code).':'.
7939: &escape($accessstart).':'.&escape($accessend).':'.$info,
7940: $homeserver);
7941: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7942: my @items = split(/&/,$response);
7943: foreach my $item (@items) {
7944: my ($key,$value) = split('=',$item);
7945: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
7946: }
7947: }
7948: }
7949: return \%crsreqresponse;
7950: }
7951:
7952: # ------------------------------------------------------- Course Group routines
7953:
7954: sub get_coursegroups {
7955: my ($cdom,$cnum,$group,$namespace) = @_;
7956: return(&dump($namespace,$cdom,$cnum,$group));
7957: }
7958:
7959: sub modify_coursegroup {
7960: my ($cdom,$cnum,$groupsettings) = @_;
7961: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
7962: }
7963:
7964: sub toggle_coursegroup_status {
7965: my ($cdom,$cnum,$group,$action) = @_;
7966: my ($from_namespace,$to_namespace);
7967: if ($action eq 'delete') {
7968: $from_namespace = 'coursegroups';
7969: $to_namespace = 'deleted_groups';
7970: } else {
7971: $from_namespace = 'deleted_groups';
7972: $to_namespace = 'coursegroups';
7973: }
7974: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
7975: if (my $tmp = &error(%curr_group)) {
7976: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
7977: return ('read error',$tmp);
7978: } else {
7979: my %savedsettings = %curr_group;
7980: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
7981: my $deloutcome;
7982: if ($result eq 'ok') {
7983: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
7984: } else {
7985: return ('write error',$result);
7986: }
7987: if ($deloutcome eq 'ok') {
7988: return 'ok';
7989: } else {
7990: return ('delete error',$deloutcome);
7991: }
7992: }
7993: }
7994:
7995: sub modify_group_roles {
7996: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
7997: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
7998: my $role = 'gr/'.&escape($userprivs);
7999: my ($uname,$udom) = split(/:/,$user);
8000: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
8001: if ($result eq 'ok') {
8002: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8003: }
8004: return $result;
8005: }
8006:
8007: sub modify_coursegroup_membership {
8008: my ($cdom,$cnum,$membership) = @_;
8009: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8010: return $result;
8011: }
8012:
8013: sub get_active_groups {
8014: my ($udom,$uname,$cdom,$cnum) = @_;
8015: my $now = time;
8016: my %groups = ();
8017: foreach my $key (keys(%env)) {
8018: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
8019: my ($start,$end) = split(/\./,$env{$key});
8020: if (($end!=0) && ($end<$now)) { next; }
8021: if (($start!=0) && ($start>$now)) { next; }
8022: if ($1 eq $cdom && $2 eq $cnum) {
8023: $groups{$3} = $env{$key} ;
8024: }
8025: }
8026: }
8027: return %groups;
8028: }
8029:
8030: sub get_group_membership {
8031: my ($cdom,$cnum,$group) = @_;
8032: return(&dump('groupmembership',$cdom,$cnum,$group));
8033: }
8034:
8035: sub get_users_groups {
8036: my ($udom,$uname,$courseid) = @_;
8037: my @usersgroups;
8038: my $cachetime=1800;
8039:
8040: my $hashid="$udom:$uname:$courseid";
8041: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8042: if (defined($cached)) {
8043: @usersgroups = split(/:/,$grouplist);
8044: } else {
8045: $grouplist = '';
8046: my $courseurl = &courseid_to_courseurl($courseid);
8047: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
8048: my $access_end = $env{'course.'.$courseid.
8049: '.default_enrollment_end_date'};
8050: my $now = time;
8051: foreach my $key (keys(%roleshash)) {
8052: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8053: my $group = $1;
8054: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8055: my $start = $2;
8056: my $end = $1;
8057: if ($start == -1) { next; } # deleted from group
8058: if (($start!=0) && ($start>$now)) { next; }
8059: if (($end!=0) && ($end<$now)) {
8060: if ($access_end && $access_end < $now) {
8061: if ($access_end - $end < 86400) {
8062: push(@usersgroups,$group);
8063: }
8064: }
8065: next;
8066: }
8067: push(@usersgroups,$group);
8068: }
8069: }
8070: }
8071: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8072: $grouplist = join(':',@usersgroups);
8073: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
8074: }
8075: return @usersgroups;
8076: }
8077:
8078: sub devalidate_getgroups_cache {
8079: my ($udom,$uname,$cdom,$cnum)=@_;
8080: my $courseid = $cdom.'_'.$cnum;
8081:
8082: my $hashid="$udom:$uname:$courseid";
8083: &devalidate_cache_new('getgroups',$hashid);
8084: }
8085:
8086: # ------------------------------------------------------------------ Plain Text
8087:
8088: sub plaintext {
8089: my ($short,$type,$cid,$forcedefault) = @_;
8090: if ($short =~ m{^cr/}) {
8091: return (split('/',$short))[-1];
8092: }
8093: if (!defined($cid)) {
8094: $cid = $env{'request.course.id'};
8095: }
8096: my %rolenames = (
8097: Course => 'std',
8098: Community => 'alt1',
8099: );
8100: if ($cid ne '') {
8101: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8102: unless ($forcedefault) {
8103: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8104: &Apache::lonlocal::mt_escape(\$roletext);
8105: return &Apache::lonlocal::mt($roletext);
8106: }
8107: }
8108: }
8109: if ((defined($type)) && (defined($rolenames{$type})) &&
8110: (defined($rolenames{$type})) &&
8111: (defined($prp{$short}{$rolenames{$type}}))) {
8112: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
8113: } elsif ($cid ne '') {
8114: my $crstype = $env{'course.'.$cid.'.type'};
8115: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8116: (defined($prp{$short}{$rolenames{$crstype}}))) {
8117: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8118: }
8119: }
8120: return &Apache::lonlocal::mt($prp{$short}{'std'});
8121: }
8122:
8123: # ----------------------------------------------------------------- Assign Role
8124:
8125: sub assignrole {
8126: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8127: $context)=@_;
8128: my $mrole;
8129: if ($role =~ /^cr\//) {
8130: my $cwosec=$url;
8131: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8132: unless (&allowed('ccr',$cwosec)) {
8133: my $refused = 1;
8134: if ($context eq 'requestcourses') {
8135: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8136: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8137: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8138: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8139: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8140: if ($crsenv{'internal.courseowner'} eq
8141: $env{'user.name'}.':'.$env{'user.domain'}) {
8142: $refused = '';
8143: }
8144: }
8145: }
8146: }
8147: }
8148: if ($refused) {
8149: &logthis('Refused custom assignrole: '.
8150: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8151: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8152: return 'refused';
8153: }
8154: }
8155: $mrole='cr';
8156: } elsif ($role =~ /^gr\//) {
8157: my $cwogrp=$url;
8158: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
8159: unless (&allowed('mdg',$cwogrp)) {
8160: &logthis('Refused group assignrole: '.
8161: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8162: $env{'user.name'}.' at '.$env{'user.domain'});
8163: return 'refused';
8164: }
8165: $mrole='gr';
8166: } else {
8167: my $cwosec=$url;
8168: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8169: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8170: my $refused;
8171: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8172: if (!(&allowed('c'.$role,$url))) {
8173: $refused = 1;
8174: }
8175: } else {
8176: $refused = 1;
8177: }
8178: if ($refused) {
8179: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8180: if (!$selfenroll && $context eq 'course') {
8181: my %crsenv;
8182: if ($role eq 'cc' || $role eq 'co') {
8183: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8184: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8185: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8186: if ($crsenv{'internal.courseowner'} eq
8187: $env{'user.name'}.':'.$env{'user.domain'}) {
8188: $refused = '';
8189: }
8190: }
8191: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8192: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8193: if ($crsenv{'internal.courseowner'} eq
8194: $env{'user.name'}.':'.$env{'user.domain'}) {
8195: $refused = '';
8196: }
8197: }
8198: }
8199: }
8200: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8201: $refused = '';
8202: } elsif ($context eq 'requestcourses') {
8203: my @possroles = ('st','ta','ep','in','cc','co');
8204: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
8205: my $wrongcc;
8206: if ($cnum =~ /^$match_community$/) {
8207: $wrongcc = 1 if ($role eq 'cc');
8208: } else {
8209: $wrongcc = 1 if ($role eq 'co');
8210: }
8211: unless ($wrongcc) {
8212: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8213: if ($crsenv{'internal.courseowner'} eq
8214: $env{'user.name'}.':'.$env{'user.domain'}) {
8215: $refused = '';
8216: }
8217: }
8218: }
8219: } elsif ($context eq 'requestauthor') {
8220: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8221: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8222: if ($env{'environment.requestauthor'} eq 'automatic') {
8223: $refused = '';
8224: } else {
8225: my %domdefaults = &get_domain_defaults($udom);
8226: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8227: my $checkbystatus;
8228: if ($env{'user.adv'}) {
8229: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8230: if ($disposition eq 'automatic') {
8231: $refused = '';
8232: } elsif ($disposition eq '') {
8233: $checkbystatus = 1;
8234: }
8235: } else {
8236: $checkbystatus = 1;
8237: }
8238: if ($checkbystatus) {
8239: if ($env{'environment.inststatus'}) {
8240: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8241: foreach my $type (@inststatuses) {
8242: if (($type ne '') &&
8243: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8244: $refused = '';
8245: }
8246: }
8247: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8248: $refused = '';
8249: }
8250: }
8251: }
8252: }
8253: }
8254: }
8255: if ($refused) {
8256: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8257: ' '.$role.' '.$end.' '.$start.' by '.
8258: $env{'user.name'}.' at '.$env{'user.domain'});
8259: return 'refused';
8260: }
8261: }
8262: } elsif ($role eq 'au') {
8263: if ($url ne '/'.$udom.'/') {
8264: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8265: ' to assign author role for '.$uname.':'.$udom.
8266: ' in domain: '.$url.' refused (wrong domain).');
8267: return 'refused';
8268: }
8269: }
8270: $mrole=$role;
8271: }
8272: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8273: "$udom:$uname:$url".'_'."$mrole=$role";
8274: if ($end) { $command.='_'.$end; }
8275: if ($start) {
8276: if ($end) {
8277: $command.='_'.$start;
8278: } else {
8279: $command.='_0_'.$start;
8280: }
8281: }
8282: my $origstart = $start;
8283: my $origend = $end;
8284: my $delflag;
8285: # actually delete
8286: if ($deleteflag) {
8287: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
8288: # modify command to delete the role
8289: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
8290: "$udom:$uname:$url".'_'."$mrole";
8291: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
8292: # set start and finish to negative values for userrolelog
8293: $start=-1;
8294: $end=-1;
8295: $delflag = 1;
8296: }
8297: }
8298: # send command
8299: my $answer=&reply($command,&homeserver($uname,$udom));
8300: # log new user role if status is ok
8301: if ($answer eq 'ok') {
8302: &userrolelog($role,$uname,$udom,$url,$start,$end);
8303: if (($role eq 'cc') || ($role eq 'in') ||
8304: ($role eq 'ep') || ($role eq 'ad') ||
8305: ($role eq 'ta') || ($role eq 'st') ||
8306: ($role=~/^cr/) || ($role eq 'gr') ||
8307: ($role eq 'co')) {
8308: # for course roles, perform group memberships changes triggered by role change.
8309: unless ($role =~ /^gr/) {
8310: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
8311: $origstart,$selfenroll,$context);
8312: }
8313: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8314: $selfenroll,$context);
8315: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
8316: ($role eq 'au') || ($role eq 'dc')) {
8317: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8318: $context);
8319: } elsif (($role eq 'ca') || ($role eq 'aa')) {
8320: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8321: $context);
8322: }
8323: if ($role eq 'cc') {
8324: &autoupdate_coowners($url,$end,$start,$uname,$udom);
8325: }
8326: }
8327: return $answer;
8328: }
8329:
8330: sub autoupdate_coowners {
8331: my ($url,$end,$start,$uname,$udom) = @_;
8332: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
8333: if (($cdom ne '') && ($cnum ne '')) {
8334: my $now = time;
8335: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
8336: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
8337: my %coursehash = &coursedescription($cdom.'_'.$cnum);
8338: my $instcode = $coursehash{'internal.coursecode'};
8339: if ($instcode ne '') {
8340: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
8341: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
8342: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
8343: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
8344: if ($result eq 'valid') {
8345: if ($coursehash{'internal.co-owners'}) {
8346: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8347: push(@newcoowners,$coowner);
8348: }
8349: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
8350: push(@newcoowners,$uname.':'.$udom);
8351: }
8352: @newcoowners = sort(@newcoowners);
8353: } else {
8354: push(@newcoowners,$uname.':'.$udom);
8355: }
8356: } else {
8357: if ($coursehash{'internal.co-owners'}) {
8358: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8359: unless ($coowner eq $uname.':'.$udom) {
8360: push(@newcoowners,$coowner);
8361: }
8362: }
8363: unless (@newcoowners > 0) {
8364: $delcoowners = 1;
8365: $coowners = '';
8366: }
8367: }
8368: }
8369: if (@newcoowners || $delcoowners) {
8370: &store_coowners($cdom,$cnum,$coursehash{'home'},
8371: $delcoowners,@newcoowners);
8372: }
8373: }
8374: }
8375: }
8376: }
8377: }
8378: }
8379:
8380: sub store_coowners {
8381: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
8382: my $cid = $cdom.'_'.$cnum;
8383: my ($coowners,$delresult,$putresult);
8384: if (@newcoowners) {
8385: $coowners = join(',',@newcoowners);
8386: my %coownershash = (
8387: 'internal.co-owners' => $coowners,
8388: );
8389: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
8390: if ($putresult eq 'ok') {
8391: if ($env{'course.'.$cid.'.num'} eq $cnum) {
8392: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
8393: }
8394: }
8395: }
8396: if ($delcoowners) {
8397: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
8398: if ($delresult eq 'ok') {
8399: if ($env{'course.'.$cid.'.internal.co-owners'}) {
8400: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
8401: }
8402: }
8403: }
8404: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
8405: my %crsinfo =
8406: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
8407: if (ref($crsinfo{$cid}) eq 'HASH') {
8408: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
8409: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
8410: }
8411: }
8412: }
8413:
8414: # -------------------------------------------------- Modify user authentication
8415: # Overrides without validation
8416:
8417: sub modifyuserauth {
8418: my ($udom,$uname,$umode,$upass)=@_;
8419: my $uhome=&homeserver($uname,$udom);
8420: unless (&allowed('mau',$udom)) { return 'refused'; }
8421: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
8422: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8423: ' in domain '.$env{'request.role.domain'});
8424: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
8425: &escape($upass),$uhome);
8426: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
8427: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
8428: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8429: &log($udom,,$uname,$uhome,
8430: 'Authentication changed by '.$env{'user.domain'}.', '.
8431: $env{'user.name'}.', '.$umode.
8432: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8433: unless ($reply eq 'ok') {
8434: &logthis('Authentication mode error: '.$reply);
8435: return 'error: '.$reply;
8436: }
8437: return 'ok';
8438: }
8439:
8440: # --------------------------------------------------------------- Modify a user
8441:
8442: sub modifyuser {
8443: my ($udom, $uname, $uid,
8444: $umode, $upass, $first,
8445: $middle, $last, $gene,
8446: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
8447: $udom= &LONCAPA::clean_domain($udom);
8448: $uname=&LONCAPA::clean_username($uname);
8449: my $showcandelete = 'none';
8450: if (ref($candelete) eq 'ARRAY') {
8451: if (@{$candelete} > 0) {
8452: $showcandelete = join(', ',@{$candelete});
8453: }
8454: }
8455: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
8456: $umode.', '.$first.', '.$middle.', '.
8457: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
8458: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
8459: ' desiredhome not specified').
8460: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8461: ' in domain '.$env{'request.role.domain'});
8462: my $uhome=&homeserver($uname,$udom,'true');
8463: my $newuser;
8464: if ($uhome eq 'no_host') {
8465: $newuser = 1;
8466: }
8467: # ----------------------------------------------------------------- Create User
8468: if (($uhome eq 'no_host') &&
8469: (($umode && $upass) || ($umode eq 'localauth'))) {
8470: my $unhome='';
8471: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
8472: $unhome = $desiredhome;
8473: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
8474: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
8475: } else { # load balancing routine for determining $unhome
8476: my $loadm=10000000;
8477: my %servers = &get_servers($udom,'library');
8478: foreach my $tryserver (keys(%servers)) {
8479: my $answer=reply('load',$tryserver);
8480: if (($answer=~/\d+/) && ($answer<$loadm)) {
8481: $loadm=$answer;
8482: $unhome=$tryserver;
8483: }
8484: }
8485: }
8486: if (($unhome eq '') || ($unhome eq 'no_host')) {
8487: return 'error: unable to find a home server for '.$uname.
8488: ' in domain '.$udom;
8489: }
8490: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
8491: &escape($upass),$unhome);
8492: unless ($reply eq 'ok') {
8493: return 'error: '.$reply;
8494: }
8495: $uhome=&homeserver($uname,$udom,'true');
8496: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
8497: return 'error: unable verify users home machine.';
8498: }
8499: } # End of creation of new user
8500: # ---------------------------------------------------------------------- Add ID
8501: if ($uid) {
8502: $uid=~tr/A-Z/a-z/;
8503: my %uidhash=&idrget($udom,$uname);
8504: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
8505: && (!$forceid)) {
8506: unless ($uid eq $uidhash{$uname}) {
8507: return 'error: user id "'.$uid.'" does not match '.
8508: 'current user id "'.$uidhash{$uname}.'".';
8509: }
8510: } else {
8511: &idput($udom,($uname => $uid));
8512: }
8513: }
8514: # -------------------------------------------------------------- Add names, etc
8515: my @tmp=&get('environment',
8516: ['firstname','middlename','lastname','generation','id',
8517: 'permanentemail','inststatus'],
8518: $udom,$uname);
8519: my (%names,%oldnames);
8520: if ($tmp[0] =~ m/^error:.*/) {
8521: %names=();
8522: } else {
8523: %names = @tmp;
8524: %oldnames = %names;
8525: }
8526: #
8527: # If name, email and/or uid are blank (e.g., because an uploaded file
8528: # of users did not contain them), do not overwrite existing values
8529: # unless field is in $candelete array ref.
8530: #
8531:
8532: my @fields = ('firstname','middlename','lastname','generation',
8533: 'permanentemail','id');
8534: my %newvalues;
8535: if (ref($candelete) eq 'ARRAY') {
8536: foreach my $field (@fields) {
8537: if (grep(/^\Q$field\E$/,@{$candelete})) {
8538: if ($field eq 'firstname') {
8539: $names{$field} = $first;
8540: } elsif ($field eq 'middlename') {
8541: $names{$field} = $middle;
8542: } elsif ($field eq 'lastname') {
8543: $names{$field} = $last;
8544: } elsif ($field eq 'generation') {
8545: $names{$field} = $gene;
8546: } elsif ($field eq 'permanentemail') {
8547: $names{$field} = $email;
8548: } elsif ($field eq 'id') {
8549: $names{$field} = $uid;
8550: }
8551: }
8552: }
8553: }
8554: if ($first) { $names{'firstname'} = $first; }
8555: if (defined($middle)) { $names{'middlename'} = $middle; }
8556: if ($last) { $names{'lastname'} = $last; }
8557: if (defined($gene)) { $names{'generation'} = $gene; }
8558: if ($email) {
8559: $email=~s/[^\w\@\.\-\,]//gs;
8560: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
8561: }
8562: if ($uid) { $names{'id'} = $uid; }
8563: if (defined($inststatus)) {
8564: $names{'inststatus'} = '';
8565: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
8566: if (ref($usertypes) eq 'HASH') {
8567: my @okstatuses;
8568: foreach my $item (split(/:/,$inststatus)) {
8569: if (defined($usertypes->{$item})) {
8570: push(@okstatuses,$item);
8571: }
8572: }
8573: if (@okstatuses) {
8574: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
8575: }
8576: }
8577: }
8578: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
8579: $umode.', '.$first.', '.$middle.', '.
8580: $last.', '.$gene.', '.$email.', '.$inststatus;
8581: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
8582: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
8583: } else {
8584: $logmsg .= ' during self creation';
8585: }
8586: my $changed;
8587: if ($newuser) {
8588: $changed = 1;
8589: } else {
8590: foreach my $field (@fields) {
8591: if ($names{$field} ne $oldnames{$field}) {
8592: $changed = 1;
8593: last;
8594: }
8595: }
8596: }
8597: unless ($changed) {
8598: $logmsg = 'No changes in user information needed for: '.$logmsg;
8599: &logthis($logmsg);
8600: return 'ok';
8601: }
8602: my $reply = &put('environment', \%names, $udom,$uname);
8603: if ($reply ne 'ok') {
8604: return 'error: '.$reply;
8605: }
8606: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
8607: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
8608: }
8609: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
8610: &devalidate_cache_new('namescache',$uname.':'.$udom);
8611: $logmsg = 'Success modifying user '.$logmsg;
8612: &logthis($logmsg);
8613: return 'ok';
8614: }
8615:
8616: # -------------------------------------------------------------- Modify student
8617:
8618: sub modifystudent {
8619: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
8620: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
8621: $selfenroll,$context,$inststatus,$credits)=@_;
8622: if (!$cid) {
8623: unless ($cid=$env{'request.course.id'}) {
8624: return 'not_in_class';
8625: }
8626: }
8627: # --------------------------------------------------------------- Make the user
8628: my $reply=&modifyuser
8629: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
8630: $desiredhome,$email,$inststatus);
8631: unless ($reply eq 'ok') { return $reply; }
8632: # This will cause &modify_student_enrollment to get the uid from the
8633: # student's environment
8634: $uid = undef if (!$forceid);
8635: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
8636: $gene,$usec,$end,$start,$type,$locktype,
8637: $cid,$selfenroll,$context,$credits);
8638: return $reply;
8639: }
8640:
8641: sub modify_student_enrollment {
8642: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
8643: $locktype,$cid,$selfenroll,$context,$credits) = @_;
8644: my ($cdom,$cnum,$chome);
8645: if (!$cid) {
8646: unless ($cid=$env{'request.course.id'}) {
8647: return 'not_in_class';
8648: }
8649: $cdom=$env{'course.'.$cid.'.domain'};
8650: $cnum=$env{'course.'.$cid.'.num'};
8651: } else {
8652: ($cdom,$cnum)=split(/_/,$cid);
8653: }
8654: $chome=$env{'course.'.$cid.'.home'};
8655: if (!$chome) {
8656: $chome=&homeserver($cnum,$cdom);
8657: }
8658: if (!$chome) { return 'unknown_course'; }
8659: # Make sure the user exists
8660: my $uhome=&homeserver($uname,$udom);
8661: if (($uhome eq '') || ($uhome eq 'no_host')) {
8662: return 'error: no such user';
8663: }
8664: # Get student data if we were not given enough information
8665: if (!defined($first) || $first eq '' ||
8666: !defined($last) || $last eq '' ||
8667: !defined($uid) || $uid eq '' ||
8668: !defined($middle) || $middle eq '' ||
8669: !defined($gene) || $gene eq '') {
8670: # They did not supply us with enough data to enroll the student, so
8671: # we need to pick up more information.
8672: my %tmp = &get('environment',
8673: ['firstname','middlename','lastname', 'generation','id']
8674: ,$udom,$uname);
8675:
8676: #foreach my $key (keys(%tmp)) {
8677: # &logthis("key $key = ".$tmp{$key});
8678: #}
8679: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
8680: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
8681: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
8682: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
8683: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
8684: }
8685: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
8686: my $user = "$uname:$udom";
8687: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
8688: my $reply=cput('classlist',
8689: {$user =>
8690: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits) },
8691: $cdom,$cnum);
8692: if (($reply eq 'ok') || ($reply eq 'delayed')) {
8693: &devalidate_getsection_cache($udom,$uname,$cid);
8694: } else {
8695: return 'error: '.$reply;
8696: }
8697: # Add student role to user
8698: my $uurl='/'.$cid;
8699: $uurl=~s/\_/\//g;
8700: if ($usec) {
8701: $uurl.='/'.$usec;
8702: }
8703: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
8704: $selfenroll,$context);
8705: if ($result ne 'ok') {
8706: if ($old_entry{$user} ne '') {
8707: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
8708: } else {
8709: $reply = &del('classlist',[$user],$cdom,$cnum);
8710: }
8711: }
8712: return $result;
8713: }
8714:
8715: sub format_name {
8716: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
8717: my $name;
8718: if ($first ne 'lastname') {
8719: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
8720: } else {
8721: if ($lastname=~/\S/) {
8722: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
8723: $name=~s/\s+,/,/;
8724: } else {
8725: $name.= $firstname.' '.$middlename.' '.$generation;
8726: }
8727: }
8728: $name=~s/^\s+//;
8729: $name=~s/\s+$//;
8730: $name=~s/\s+/ /g;
8731: return $name;
8732: }
8733:
8734: # ------------------------------------------------- Write to course preferences
8735:
8736: sub writecoursepref {
8737: my ($courseid,%prefs)=@_;
8738: $courseid=~s/^\///;
8739: $courseid=~s/\_/\//g;
8740: my ($cdomain,$cnum)=split(/\//,$courseid);
8741: my $chome=homeserver($cnum,$cdomain);
8742: if (($chome eq '') || ($chome eq 'no_host')) {
8743: return 'error: no such course';
8744: }
8745: my $cstring='';
8746: foreach my $pref (keys(%prefs)) {
8747: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
8748: }
8749: $cstring=~s/\&$//;
8750: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
8751: }
8752:
8753: # ---------------------------------------------------------- Make/modify course
8754:
8755: sub createcourse {
8756: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
8757: $course_owner,$crstype,$cnum,$context,$category)=@_;
8758: $url=&declutter($url);
8759: my $cid='';
8760: if ($context eq 'requestcourses') {
8761: my $can_create = 0;
8762: my ($ownername,$ownerdom) = split(':',$course_owner);
8763: if ($udom eq $ownerdom) {
8764: if (&usertools_access($ownername,$ownerdom,$category,undef,
8765: $context)) {
8766: $can_create = 1;
8767: }
8768: } else {
8769: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
8770: $category);
8771: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
8772: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
8773: if (@curr > 0) {
8774: my @options = qw(approval validate autolimit);
8775: my $optregex = join('|',@options);
8776: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
8777: $can_create = 1;
8778: }
8779: }
8780: }
8781: }
8782: if ($can_create) {
8783: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
8784: unless (&allowed('ccc',$udom)) {
8785: return 'refused';
8786: }
8787: }
8788: } else {
8789: return 'refused';
8790: }
8791: } elsif (!&allowed('ccc',$udom)) {
8792: return 'refused';
8793: }
8794: # --------------------------------------------------------------- Get Unique ID
8795: my $uname;
8796: if ($cnum =~ /^$match_courseid$/) {
8797: my $chome=&homeserver($cnum,$udom,'true');
8798: if (($chome eq '') || ($chome eq 'no_host')) {
8799: $uname = $cnum;
8800: } else {
8801: $uname = &generate_coursenum($udom,$crstype);
8802: }
8803: } else {
8804: $uname = &generate_coursenum($udom,$crstype);
8805: }
8806: return $uname if ($uname =~ /^error/);
8807: # -------------------------------------------------- Check supplied server name
8808: if (!defined($course_server)) {
8809: if (defined(&domain($udom,'primary'))) {
8810: $course_server = &domain($udom,'primary');
8811: } else {
8812: $course_server = $env{'user.home'};
8813: }
8814: }
8815: my %host_servers =
8816: &Apache::lonnet::get_servers($udom,'library');
8817: unless ($host_servers{$course_server}) {
8818: return 'error: invalid home server for course: '.$course_server;
8819: }
8820: # ------------------------------------------------------------- Make the course
8821: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
8822: $course_server);
8823: unless ($reply eq 'ok') { return 'error: '.$reply; }
8824: my $uhome=&homeserver($uname,$udom,'true');
8825: if (($uhome eq '') || ($uhome eq 'no_host')) {
8826: return 'error: no such course';
8827: }
8828: # ----------------------------------------------------------------- Course made
8829: # log existence
8830: my $now = time;
8831: my $newcourse = {
8832: $udom.'_'.$uname => {
8833: description => $description,
8834: inst_code => $inst_code,
8835: owner => $course_owner,
8836: type => $crstype,
8837: creator => $env{'user.name'}.':'.
8838: $env{'user.domain'},
8839: created => $now,
8840: context => $context,
8841: },
8842: };
8843: &courseidput($udom,$newcourse,$uhome,'notime');
8844: # set toplevel url
8845: my $topurl=$url;
8846: unless ($nonstandard) {
8847: # ------------------------------------------ For standard courses, make top url
8848: my $mapurl=&clutter($url);
8849: if ($mapurl eq '/res/') { $mapurl=''; }
8850: $env{'form.initmap'}=(<<ENDINITMAP);
8851: <map>
8852: <resource id="1" type="start"></resource>
8853: <resource id="2" src="$mapurl"></resource>
8854: <resource id="3" type="finish"></resource>
8855: <link index="1" from="1" to="2"></link>
8856: <link index="2" from="2" to="3"></link>
8857: </map>
8858: ENDINITMAP
8859: $topurl=&declutter(
8860: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
8861: );
8862: }
8863: # ----------------------------------------------------------- Write preferences
8864: &writecoursepref($udom.'_'.$uname,
8865: ('description' => $description,
8866: 'url' => $topurl,
8867: 'internal.creator' => $env{'user.name'}.':'.
8868: $env{'user.domain'},
8869: 'internal.created' => $now,
8870: 'internal.creationcontext' => $context)
8871: );
8872: return '/'.$udom.'/'.$uname;
8873: }
8874:
8875: # ------------------------------------------------------------------- Create ID
8876: sub generate_coursenum {
8877: my ($udom,$crstype) = @_;
8878: my $domdesc = &domain($udom);
8879: return 'error: invalid domain' if ($domdesc eq '');
8880: my $first;
8881: if ($crstype eq 'Community') {
8882: $first = '0';
8883: } else {
8884: $first = int(1+rand(9));
8885: }
8886: my $uname=$first.
8887: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8888: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8889: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8890: # ----------------------------------------------- Make sure that does not exist
8891: my $uhome=&homeserver($uname,$udom,'true');
8892: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8893: if ($crstype eq 'Community') {
8894: $first = '0';
8895: } else {
8896: $first = int(1+rand(9));
8897: }
8898: $uname=$first.
8899: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8900: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8901: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8902: $uhome=&homeserver($uname,$udom,'true');
8903: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8904: return 'error: unable to generate unique course-ID';
8905: }
8906: }
8907: return $uname;
8908: }
8909:
8910: sub is_course {
8911: my ($cdom, $cnum) = scalar(@_) == 1 ?
8912: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
8913:
8914: return unless $cdom and $cnum;
8915:
8916: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
8917: '.');
8918:
8919: return unless(exists($courses{$cdom.'_'.$cnum}));
8920: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
8921: }
8922:
8923: sub store_userdata {
8924: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
8925: my $result;
8926: if ($datakey ne '') {
8927: if (ref($storehash) eq 'HASH') {
8928: if ($udom eq '' || $uname eq '') {
8929: $udom = $env{'user.domain'};
8930: $uname = $env{'user.name'};
8931: }
8932: my $uhome=&homeserver($uname,$udom);
8933: if (($uhome eq '') || ($uhome eq 'no_host')) {
8934: $result = 'error: no_host';
8935: } else {
8936: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
8937: $storehash->{'host'} = $perlvar{'lonHostID'};
8938:
8939: my $namevalue='';
8940: foreach my $key (keys(%{$storehash})) {
8941: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
8942: }
8943: $namevalue=~s/\&$//;
8944: unless ($namespace eq 'courserequests') {
8945: $datakey = &escape($datakey);
8946: }
8947: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
8948: $namevalue,$uhome);
8949: }
8950: } else {
8951: $result = 'error: data to store was not a hash reference';
8952: }
8953: } else {
8954: $result= 'error: invalid requestkey';
8955: }
8956: return $result;
8957: }
8958:
8959: # ---------------------------------------------------------- Assign Custom Role
8960:
8961: sub assigncustomrole {
8962: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
8963: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
8964: $end,$start,$deleteflag,$selfenroll,$context);
8965: }
8966:
8967: # ----------------------------------------------------------------- Revoke Role
8968:
8969: sub revokerole {
8970: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
8971: my $now=time;
8972: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
8973: }
8974:
8975: # ---------------------------------------------------------- Revoke Custom Role
8976:
8977: sub revokecustomrole {
8978: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
8979: my $now=time;
8980: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
8981: $deleteflag,$selfenroll,$context);
8982: }
8983:
8984: # ------------------------------------------------------------ Disk usage
8985: sub diskusage {
8986: my ($udom,$uname,$directorypath,$getpropath)=@_;
8987: $directorypath =~ s/\/$//;
8988: my $listing=&reply('du2:'.&escape($directorypath).':'
8989: .&escape($getpropath).':'.&escape($uname).':'
8990: .&escape($udom),homeserver($uname,$udom));
8991: if ($listing eq 'unknown_cmd') {
8992: if ($getpropath) {
8993: $directorypath = &propath($udom,$uname).'/'.$directorypath;
8994: }
8995: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
8996: }
8997: return $listing;
8998: }
8999:
9000: sub is_locked {
9001: my ($file_name, $domain, $user, $which) = @_;
9002: my @check;
9003: my $is_locked;
9004: push (@check,$file_name);
9005: my %locked = &get('file_permissions',\@check,
9006: $env{'user.domain'},$env{'user.name'});
9007: my ($tmp)=keys(%locked);
9008: if ($tmp=~/^error:/) { undef(%locked); }
9009:
9010: if (ref($locked{$file_name}) eq 'ARRAY') {
9011: $is_locked = 'false';
9012: foreach my $entry (@{$locked{$file_name}}) {
9013: if (ref($entry) eq 'ARRAY') {
9014: $is_locked = 'true';
9015: if (ref($which) eq 'ARRAY') {
9016: push(@{$which},$entry);
9017: } else {
9018: last;
9019: }
9020: }
9021: }
9022: } else {
9023: $is_locked = 'false';
9024: }
9025: return $is_locked;
9026: }
9027:
9028: sub declutter_portfile {
9029: my ($file) = @_;
9030: $file =~ s{^(/portfolio/|portfolio/)}{/};
9031: return $file;
9032: }
9033:
9034: # ------------------------------------------------------------- Mark as Read Only
9035:
9036: sub mark_as_readonly {
9037: my ($domain,$user,$files,$what) = @_;
9038: my %current_permissions = &dump('file_permissions',$domain,$user);
9039: my ($tmp)=keys(%current_permissions);
9040: if ($tmp=~/^error:/) { undef(%current_permissions); }
9041: foreach my $file (@{$files}) {
9042: $file = &declutter_portfile($file);
9043: push(@{$current_permissions{$file}},$what);
9044: }
9045: &put('file_permissions',\%current_permissions,$domain,$user);
9046: return;
9047: }
9048:
9049: # ------------------------------------------------------------Save Selected Files
9050:
9051: sub save_selected_files {
9052: my ($user, $path, @files) = @_;
9053: my $filename = $user."savedfiles";
9054: my @other_files = &files_not_in_path($user, $path);
9055: open (OUT, '>'.$tmpdir.$filename);
9056: foreach my $file (@files) {
9057: print (OUT $env{'form.currentpath'}.$file."\n");
9058: }
9059: foreach my $file (@other_files) {
9060: print (OUT $file."\n");
9061: }
9062: close (OUT);
9063: return 'ok';
9064: }
9065:
9066: sub clear_selected_files {
9067: my ($user) = @_;
9068: my $filename = $user."savedfiles";
9069: open (OUT, '>'.LONCAPA::tempdir().$filename);
9070: print (OUT undef);
9071: close (OUT);
9072: return ("ok");
9073: }
9074:
9075: sub files_in_path {
9076: my ($user, $path) = @_;
9077: my $filename = $user."savedfiles";
9078: my %return_files;
9079: open (IN, '<'.LONCAPA::tempdir().$filename);
9080: while (my $line_in = <IN>) {
9081: chomp ($line_in);
9082: my @paths_and_file = split (m!/!, $line_in);
9083: my $file_part = pop (@paths_and_file);
9084: my $path_part = join ('/', @paths_and_file);
9085: $path_part.='/';
9086: my $path_and_file = $path_part.$file_part;
9087: if ($path_part eq $path) {
9088: $return_files{$file_part}= 'selected';
9089: }
9090: }
9091: close (IN);
9092: return (\%return_files);
9093: }
9094:
9095: # called in portfolio select mode, to show files selected NOT in current directory
9096: sub files_not_in_path {
9097: my ($user, $path) = @_;
9098: my $filename = $user."savedfiles";
9099: my @return_files;
9100: my $path_part;
9101: open(IN, '<'.LONCAPA::.$filename);
9102: while (my $line = <IN>) {
9103: #ok, I know it's clunky, but I want it to work
9104: my @paths_and_file = split(m|/|, $line);
9105: my $file_part = pop(@paths_and_file);
9106: chomp($file_part);
9107: my $path_part = join('/', @paths_and_file);
9108: $path_part .= '/';
9109: my $path_and_file = $path_part.$file_part;
9110: if ($path_part ne $path) {
9111: push(@return_files, ($path_and_file));
9112: }
9113: }
9114: close(OUT);
9115: return (@return_files);
9116: }
9117:
9118: #----------------------------------------------Get portfolio file permissions
9119:
9120: sub get_portfile_permissions {
9121: my ($domain,$user) = @_;
9122: my %current_permissions = &dump('file_permissions',$domain,$user);
9123: my ($tmp)=keys(%current_permissions);
9124: if ($tmp=~/^error:/) { undef(%current_permissions); }
9125: return \%current_permissions;
9126: }
9127:
9128: #---------------------------------------------Get portfolio file access controls
9129:
9130: sub get_access_controls {
9131: my ($current_permissions,$group,$file) = @_;
9132: my %access;
9133: my $real_file = $file;
9134: $file =~ s/\.meta$//;
9135: if (defined($file)) {
9136: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9137: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
9138: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
9139: }
9140: }
9141: } else {
9142: foreach my $key (keys(%{$current_permissions})) {
9143: if ($key =~ /\0accesscontrol$/) {
9144: if (defined($group)) {
9145: if ($key !~ m-^\Q$group\E/-) {
9146: next;
9147: }
9148: }
9149: my ($fullpath) = split(/\0/,$key);
9150: if (ref($$current_permissions{$key}) eq 'HASH') {
9151: foreach my $control (keys(%{$$current_permissions{$key}})) {
9152: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9153: }
9154: }
9155: }
9156: }
9157: }
9158: return %access;
9159: }
9160:
9161: sub modify_access_controls {
9162: my ($file_name,$changes,$domain,$user)=@_;
9163: my ($outcome,$deloutcome);
9164: my %store_permissions;
9165: my %new_values;
9166: my %new_control;
9167: my %translation;
9168: my @deletions = ();
9169: my $now = time;
9170: if (exists($$changes{'activate'})) {
9171: if (ref($$changes{'activate'}) eq 'HASH') {
9172: my @newitems = sort(keys(%{$$changes{'activate'}}));
9173: my $numnew = scalar(@newitems);
9174: for (my $i=0; $i<$numnew; $i++) {
9175: my $newkey = $newitems[$i];
9176: my $newid = &Apache::loncommon::get_cgi_id();
9177: if ($newkey =~ /^\d+:/) {
9178: $newkey =~ s/^(\d+)/$newid/;
9179: $translation{$1} = $newid;
9180: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9181: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9182: $translation{$1} = $newid;
9183: }
9184: $new_values{$file_name."\0".$newkey} =
9185: $$changes{'activate'}{$newitems[$i]};
9186: $new_control{$newkey} = $now;
9187: }
9188: }
9189: }
9190: my %todelete;
9191: my %changed_items;
9192: foreach my $action ('delete','update') {
9193: if (exists($$changes{$action})) {
9194: if (ref($$changes{$action}) eq 'HASH') {
9195: foreach my $key (keys(%{$$changes{$action}})) {
9196: my ($itemnum) = ($key =~ /^([^:]+):/);
9197: if ($action eq 'delete') {
9198: $todelete{$itemnum} = 1;
9199: } else {
9200: $changed_items{$itemnum} = $key;
9201: }
9202: }
9203: }
9204: }
9205: }
9206: # get lock on access controls for file.
9207: my $lockhash = {
9208: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9209: ':'.$env{'user.domain'},
9210: };
9211: my $tries = 0;
9212: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9213:
9214: while (($gotlock ne 'ok') && $tries <3) {
9215: $tries ++;
9216: sleep 1;
9217: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9218: }
9219: if ($gotlock eq 'ok') {
9220: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9221: my ($tmp)=keys(%curr_permissions);
9222: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9223: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9224: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9225: if (ref($curr_controls) eq 'HASH') {
9226: foreach my $control_item (keys(%{$curr_controls})) {
9227: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9228: if (defined($todelete{$itemnum})) {
9229: push(@deletions,$file_name."\0".$control_item);
9230: } else {
9231: if (defined($changed_items{$itemnum})) {
9232: $new_control{$changed_items{$itemnum}} = $now;
9233: push(@deletions,$file_name."\0".$control_item);
9234: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9235: } else {
9236: $new_control{$control_item} = $$curr_controls{$control_item};
9237: }
9238: }
9239: }
9240: }
9241: }
9242: my ($group);
9243: if (&is_course($domain,$user)) {
9244: ($group,my $file) = split(/\//,$file_name,2);
9245: }
9246: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9247: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9248: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9249: # remove lock
9250: my @del_lock = ($file_name."\0".'locked_access_records');
9251: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
9252: my $sqlresult =
9253: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
9254: $group);
9255: } else {
9256: $outcome = "error: could not obtain lockfile\n";
9257: }
9258: return ($outcome,$deloutcome,\%new_values,\%translation);
9259: }
9260:
9261: sub make_public_indefinitely {
9262: my ($requrl) = @_;
9263: my $now = time;
9264: my $action = 'activate';
9265: my $aclnum = 0;
9266: if (&is_portfolio_url($requrl)) {
9267: my (undef,$udom,$unum,$file_name,$group) =
9268: &parse_portfolio_url($requrl);
9269: my $current_perms = &get_portfile_permissions($udom,$unum);
9270: my %access_controls = &get_access_controls($current_perms,
9271: $group,$file_name);
9272: foreach my $key (keys(%{$access_controls{$file_name}})) {
9273: my ($num,$scope,$end,$start) =
9274: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9275: if ($scope eq 'public') {
9276: if ($start <= $now && $end == 0) {
9277: $action = 'none';
9278: } else {
9279: $action = 'update';
9280: $aclnum = $num;
9281: }
9282: last;
9283: }
9284: }
9285: if ($action eq 'none') {
9286: return 'ok';
9287: } else {
9288: my %changes;
9289: my $newend = 0;
9290: my $newstart = $now;
9291: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
9292: $changes{$action}{$newkey} = {
9293: type => 'public',
9294: time => {
9295: start => $newstart,
9296: end => $newend,
9297: },
9298: };
9299: my ($outcome,$deloutcome,$new_values,$translation) =
9300: &modify_access_controls($file_name,\%changes,$udom,$unum);
9301: return $outcome;
9302: }
9303: } else {
9304: return 'invalid';
9305: }
9306: }
9307:
9308: #------------------------------------------------------Get Marked as Read Only
9309:
9310: sub get_marked_as_readonly {
9311: my ($domain,$user,$what,$group) = @_;
9312: my $current_permissions = &get_portfile_permissions($domain,$user);
9313: my @readonly_files;
9314: my $cmp1=$what;
9315: if (ref($what)) { $cmp1=join('',@{$what}) };
9316: while (my ($file_name,$value) = each(%{$current_permissions})) {
9317: if (defined($group)) {
9318: if ($file_name !~ m-^\Q$group\E/-) {
9319: next;
9320: }
9321: }
9322: if (ref($value) eq "ARRAY"){
9323: foreach my $stored_what (@{$value}) {
9324: my $cmp2=$stored_what;
9325: if (ref($stored_what) eq 'ARRAY') {
9326: $cmp2=join('',@{$stored_what});
9327: }
9328: if ($cmp1 eq $cmp2) {
9329: push(@readonly_files, $file_name);
9330: last;
9331: } elsif (!defined($what)) {
9332: push(@readonly_files, $file_name);
9333: last;
9334: }
9335: }
9336: }
9337: }
9338: return @readonly_files;
9339: }
9340: #-----------------------------------------------------------Get Marked as Read Only Hash
9341:
9342: sub get_marked_as_readonly_hash {
9343: my ($current_permissions,$group,$what) = @_;
9344: my %readonly_files;
9345: while (my ($file_name,$value) = each(%{$current_permissions})) {
9346: if (defined($group)) {
9347: if ($file_name !~ m-^\Q$group\E/-) {
9348: next;
9349: }
9350: }
9351: if (ref($value) eq "ARRAY"){
9352: foreach my $stored_what (@{$value}) {
9353: if (ref($stored_what) eq 'ARRAY') {
9354: foreach my $lock_descriptor(@{$stored_what}) {
9355: if ($lock_descriptor eq 'graded') {
9356: $readonly_files{$file_name} = 'graded';
9357: } elsif ($lock_descriptor eq 'handback') {
9358: $readonly_files{$file_name} = 'handback';
9359: } else {
9360: if (!exists($readonly_files{$file_name})) {
9361: $readonly_files{$file_name} = 'locked';
9362: }
9363: }
9364: }
9365: }
9366: }
9367: }
9368: }
9369: return %readonly_files;
9370: }
9371: # ------------------------------------------------------------ Unmark as Read Only
9372:
9373: sub unmark_as_readonly {
9374: # unmarks $file_name (if $file_name is defined), or all files locked by $what
9375: # for portfolio submissions, $what contains [$symb,$crsid]
9376: my ($domain,$user,$what,$file_name,$group) = @_;
9377: $file_name = &declutter_portfile($file_name);
9378: my $symb_crs = $what;
9379: if (ref($what)) { $symb_crs=join('',@$what); }
9380: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
9381: my ($tmp)=keys(%current_permissions);
9382: if ($tmp=~/^error:/) { undef(%current_permissions); }
9383: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
9384: foreach my $file (@readonly_files) {
9385: my $clean_file = &declutter_portfile($file);
9386: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
9387: my $current_locks = $current_permissions{$file};
9388: my @new_locks;
9389: my @del_keys;
9390: if (ref($current_locks) eq "ARRAY"){
9391: foreach my $locker (@{$current_locks}) {
9392: my $compare=$locker;
9393: if (ref($locker) eq 'ARRAY') {
9394: $compare=join('',@{$locker});
9395: if ($compare ne $symb_crs) {
9396: push(@new_locks, $locker);
9397: }
9398: }
9399: }
9400: if (scalar(@new_locks) > 0) {
9401: $current_permissions{$file} = \@new_locks;
9402: } else {
9403: push(@del_keys, $file);
9404: &del('file_permissions',\@del_keys, $domain, $user);
9405: delete($current_permissions{$file});
9406: }
9407: }
9408: }
9409: &put('file_permissions',\%current_permissions,$domain,$user);
9410: return;
9411: }
9412:
9413: # ------------------------------------------------------------ Directory lister
9414:
9415: sub dirlist {
9416: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
9417: $uri=~s/^\///;
9418: $uri=~s/\/$//;
9419: my ($udom, $uname);
9420: if ($getuserdir) {
9421: $udom = $userdomain;
9422: $uname = $username;
9423: } else {
9424: (undef,$udom,$uname)=split(/\//,$uri);
9425: if(defined($userdomain)) {
9426: $udom = $userdomain;
9427: }
9428: if(defined($username)) {
9429: $uname = $username;
9430: }
9431: }
9432: my ($dirRoot,$listing,@listing_results);
9433:
9434: $dirRoot = $perlvar{'lonDocRoot'};
9435: if (defined($getpropath)) {
9436: $dirRoot = &propath($udom,$uname);
9437: $dirRoot =~ s/\/$//;
9438: } elsif (defined($getuserdir)) {
9439: my $subdir=$uname.'__';
9440: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
9441: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
9442: ."/$udom/$subdir/$uname";
9443: } elsif (defined($alternateRoot)) {
9444: $dirRoot = $alternateRoot;
9445: }
9446:
9447: if($udom) {
9448: if($uname) {
9449: my $uhome = &homeserver($uname,$udom);
9450: if ($uhome eq 'no_host') {
9451: return ([],'no_host');
9452: }
9453: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
9454: .$getuserdir.':'.&escape($dirRoot)
9455: .':'.&escape($uname).':'.&escape($udom),$uhome);
9456: if ($listing eq 'unknown_cmd') {
9457: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
9458: } else {
9459: @listing_results = map { &unescape($_); } split(/:/,$listing);
9460: }
9461: if ($listing eq 'unknown_cmd') {
9462: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
9463: @listing_results = split(/:/,$listing);
9464: } else {
9465: @listing_results = map { &unescape($_); } split(/:/,$listing);
9466: }
9467: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
9468: ($listing eq 'rejected') || ($listing eq 'refused') ||
9469: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9470: return ([],$listing);
9471: } else {
9472: return (\@listing_results);
9473: }
9474: } elsif(!$alternateRoot) {
9475: my (%allusers,%listerror);
9476: my %servers = &get_servers($udom,'library');
9477: foreach my $tryserver (keys(%servers)) {
9478: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
9479: &escape($udom),$tryserver);
9480: if ($listing eq 'unknown_cmd') {
9481: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
9482: $udom, $tryserver);
9483: } else {
9484: @listing_results = map { &unescape($_); } split(/:/,$listing);
9485: }
9486: if ($listing eq 'unknown_cmd') {
9487: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
9488: $udom, $tryserver);
9489: @listing_results = split(/:/,$listing);
9490: } else {
9491: @listing_results =
9492: map { &unescape($_); } split(/:/,$listing);
9493: }
9494: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
9495: ($listing eq 'rejected') || ($listing eq 'refused') ||
9496: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9497: $listerror{$tryserver} = $listing;
9498: } else {
9499: foreach my $line (@listing_results) {
9500: my ($entry) = split(/&/,$line,2);
9501: $allusers{$entry} = 1;
9502: }
9503: }
9504: }
9505: my @alluserslist=();
9506: foreach my $user (sort(keys(%allusers))) {
9507: push(@alluserslist,$user.'&user');
9508: }
9509: return (\@alluserslist);
9510: } else {
9511: return ([],'missing username');
9512: }
9513: } elsif(!defined($getpropath)) {
9514: my $path = $perlvar{'lonDocRoot'}.'/res/';
9515: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
9516: return (\@all_domains);
9517: } else {
9518: return ([],'missing domain');
9519: }
9520: }
9521:
9522: # --------------------------------------------- GetFileTimestamp
9523: # This function utilizes dirlist and returns the date stamp for
9524: # when it was last modified. It will also return an error of -1
9525: # if an error occurs
9526:
9527: sub GetFileTimestamp {
9528: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
9529: $studentDomain = &LONCAPA::clean_domain($studentDomain);
9530: $studentName = &LONCAPA::clean_username($studentName);
9531: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
9532: undef,$getuserdir);
9533: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9534: return -1;
9535: }
9536: if (ref($fileref) eq 'ARRAY') {
9537: my @stats = split('&',$fileref->[0]);
9538: # @stats contains first the filename, then the stat output
9539: return $stats[10]; # so this is 10 instead of 9.
9540: } else {
9541: return -1;
9542: }
9543: }
9544:
9545: sub stat_file {
9546: my ($uri) = @_;
9547: $uri = &clutter_with_no_wrapper($uri);
9548:
9549: my ($udom,$uname,$file);
9550: if ($uri =~ m-^/(uploaded|editupload)/-) {
9551: ($udom,$uname,$file) =
9552: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
9553: $file = 'userfiles/'.$file;
9554: }
9555: if ($uri =~ m-^/res/-) {
9556: ($udom,$uname) =
9557: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
9558: $file = $uri;
9559: }
9560:
9561: if (!$udom || !$uname || !$file) {
9562: # unable to handle the uri
9563: return ();
9564: }
9565: my $getpropath;
9566: if ($file =~ /^userfiles\//) {
9567: $getpropath = 1;
9568: }
9569: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
9570: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9571: return ();
9572: } else {
9573: if (ref($listref) eq 'ARRAY') {
9574: my @stats = split('&',$listref->[0]);
9575: shift(@stats); #filename is first
9576: return @stats;
9577: }
9578: }
9579: return ();
9580: }
9581:
9582: # -------------------------------------------------------- Value of a Condition
9583:
9584: # gets the value of a specific preevaluated condition
9585: # stored in the string $env{user.state.<cid>}
9586: # or looks up a condition reference in the bighash and if if hasn't
9587: # already been evaluated recurses into docondval to get the value of
9588: # the condition, then memoizing it to
9589: # $env{user.state.<cid>.<condition>}
9590: sub directcondval {
9591: my $number=shift;
9592: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
9593: &Apache::lonuserstate::evalstate();
9594: }
9595: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
9596: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
9597: } elsif ($number =~ /^_/) {
9598: my $sub_condition;
9599: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9600: &GDBM_READER(),0640)) {
9601: $sub_condition=$bighash{'conditions'.$number};
9602: untie(%bighash);
9603: }
9604: my $value = &docondval($sub_condition);
9605: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
9606: return $value;
9607: }
9608: if ($env{'user.state.'.$env{'request.course.id'}}) {
9609: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
9610: } else {
9611: return 2;
9612: }
9613: }
9614:
9615: # get the collection of conditions for this resource
9616: sub condval {
9617: my $condidx=shift;
9618: my $allpathcond='';
9619: foreach my $cond (split(/\|/,$condidx)) {
9620: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
9621: $allpathcond.=
9622: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
9623: }
9624: }
9625: $allpathcond=~s/\|$//;
9626: return &docondval($allpathcond);
9627: }
9628:
9629: #evaluates an expression of conditions
9630: sub docondval {
9631: my ($allpathcond) = @_;
9632: my $result=0;
9633: if ($env{'request.course.id'}
9634: && defined($allpathcond)) {
9635: my $operand='|';
9636: my @stack;
9637: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
9638: if ($chunk eq '(') {
9639: push @stack,($operand,$result);
9640: } elsif ($chunk eq ')') {
9641: my $before=pop @stack;
9642: if (pop @stack eq '&') {
9643: $result=$result>$before?$before:$result;
9644: } else {
9645: $result=$result>$before?$result:$before;
9646: }
9647: } elsif (($chunk eq '&') || ($chunk eq '|')) {
9648: $operand=$chunk;
9649: } else {
9650: my $new=directcondval($chunk);
9651: if ($operand eq '&') {
9652: $result=$result>$new?$new:$result;
9653: } else {
9654: $result=$result>$new?$result:$new;
9655: }
9656: }
9657: }
9658: }
9659: return $result;
9660: }
9661:
9662: # ---------------------------------------------------- Devalidate courseresdata
9663:
9664: sub devalidatecourseresdata {
9665: my ($coursenum,$coursedomain)=@_;
9666: my $hashid=$coursenum.':'.$coursedomain;
9667: &devalidate_cache_new('courseres',$hashid);
9668: }
9669:
9670:
9671: # --------------------------------------------------- Course Resourcedata Query
9672: #
9673: # Parameters:
9674: # $coursenum - Number of the course.
9675: # $coursedomain - Domain at which the course was created.
9676: # Returns:
9677: # A hash of the course parameters along (I think) with timestamps
9678: # and version info.
9679:
9680: sub get_courseresdata {
9681: my ($coursenum,$coursedomain)=@_;
9682: my $coursehom=&homeserver($coursenum,$coursedomain);
9683: my $hashid=$coursenum.':'.$coursedomain;
9684: my ($result,$cached)=&is_cached_new('courseres',$hashid);
9685: my %dumpreply;
9686: unless (defined($cached)) {
9687: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
9688: $result=\%dumpreply;
9689: my ($tmp) = keys(%dumpreply);
9690: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9691: &do_cache_new('courseres',$hashid,$result,600);
9692: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
9693: return $tmp;
9694: } elsif ($tmp =~ /^(error)/) {
9695: $result=undef;
9696: &do_cache_new('courseres',$hashid,$result,600);
9697: }
9698: }
9699: return $result;
9700: }
9701:
9702: sub devalidateuserresdata {
9703: my ($uname,$udom)=@_;
9704: my $hashid="$udom:$uname";
9705: &devalidate_cache_new('userres',$hashid);
9706: }
9707:
9708: sub get_userresdata {
9709: my ($uname,$udom)=@_;
9710: #most student don\'t have any data set, check if there is some data
9711: if (&EXT_cache_status($udom,$uname)) { return undef; }
9712:
9713: my $hashid="$udom:$uname";
9714: my ($result,$cached)=&is_cached_new('userres',$hashid);
9715: if (!defined($cached)) {
9716: my %resourcedata=&dump('resourcedata',$udom,$uname);
9717: $result=\%resourcedata;
9718: &do_cache_new('userres',$hashid,$result,600);
9719: }
9720: my ($tmp)=keys(%$result);
9721: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
9722: return $result;
9723: }
9724: #error 2 occurs when the .db doesn't exist
9725: if ($tmp!~/error: 2 /) {
9726: &logthis("<font color=\"blue\">WARNING:".
9727: " Trying to get resource data for ".
9728: $uname." at ".$udom.": ".
9729: $tmp."</font>");
9730: } elsif ($tmp=~/error: 2 /) {
9731: #&EXT_cache_set($udom,$uname);
9732: &do_cache_new('userres',$hashid,undef,600);
9733: undef($tmp); # not really an error so don't send it back
9734: }
9735: return $tmp;
9736: }
9737: #----------------------------------------------- resdata - return resource data
9738: # Purpose:
9739: # Return resource data for either users or for a course.
9740: # Parameters:
9741: # $name - Course/user name.
9742: # $domain - Name of the domain the user/course is registered on.
9743: # $type - Type of thing $name is (must be 'course' or 'user'
9744: # @which - Array of names of resources desired.
9745: # Returns:
9746: # The value of the first reasource in @which that is found in the
9747: # resource hash.
9748: # Exceptional Conditions:
9749: # If the $type passed in is not valid (not the string 'course' or
9750: # 'user', an undefined reference is returned.
9751: # If none of the resources are found, an undef is returned
9752: sub resdata {
9753: my ($name,$domain,$type,@which)=@_;
9754: my $result;
9755: if ($type eq 'course') {
9756: $result=&get_courseresdata($name,$domain);
9757: } elsif ($type eq 'user') {
9758: $result=&get_userresdata($name,$domain);
9759: }
9760: if (!ref($result)) { return $result; }
9761: foreach my $item (@which) {
9762: if (defined($result->{$item->[0]})) {
9763: return [$result->{$item->[0]},$item->[1]];
9764: }
9765: }
9766: return undef;
9767: }
9768:
9769: sub get_numsuppfiles {
9770: my ($cnum,$cdom,$ignorecache)=@_;
9771: my $hashid=$cnum.':'.$cdom;
9772: my ($suppcount,$cached);
9773: unless ($ignorecache) {
9774: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
9775: }
9776: unless (defined($cached)) {
9777: my $chome=&homeserver($cnum,$cdom);
9778: unless ($chome eq 'no_host') {
9779: ($suppcount,my $errors) = (0,0);
9780: my $suppmap = 'supplemental.sequence';
9781: ($suppcount,$errors) =
9782: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
9783: }
9784: &do_cache_new('suppcount',$hashid,$suppcount,600);
9785: }
9786: return $suppcount;
9787: }
9788:
9789: #
9790: # EXT resource caching routines
9791: #
9792:
9793: sub clear_EXT_cache_status {
9794: &delenv('cache.EXT.');
9795: }
9796:
9797: sub EXT_cache_status {
9798: my ($target_domain,$target_user) = @_;
9799: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
9800: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
9801: # We know already the user has no data
9802: return 1;
9803: } else {
9804: return 0;
9805: }
9806: }
9807:
9808: sub EXT_cache_set {
9809: my ($target_domain,$target_user) = @_;
9810: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
9811: #&appenv({$cachename => time});
9812: }
9813:
9814: # --------------------------------------------------------- Value of a Variable
9815: sub EXT {
9816:
9817: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
9818: unless ($varname) { return ''; }
9819: #get real user name/domain, courseid and symb
9820: my $courseid;
9821: my $publicuser;
9822: if ($symbparm) {
9823: $symbparm=&get_symb_from_alias($symbparm);
9824: }
9825: if (!($uname && $udom)) {
9826: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
9827: if (!$symbparm) { $symbparm=$cursymb; }
9828: } else {
9829: $courseid=$env{'request.course.id'};
9830: }
9831: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
9832: my $rest;
9833: if (defined($therest[0])) {
9834: $rest=join('.',@therest);
9835: } else {
9836: $rest='';
9837: }
9838:
9839: my $qualifierrest=$qualifier;
9840: if ($rest) { $qualifierrest.='.'.$rest; }
9841: my $spacequalifierrest=$space;
9842: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
9843: if ($realm eq 'user') {
9844: # --------------------------------------------------------------- user.resource
9845: if ($space eq 'resource') {
9846: if ( (defined($Apache::lonhomework::parsing_a_problem)
9847: || defined($Apache::lonhomework::parsing_a_task))
9848: &&
9849: ($symbparm eq &symbread()) ) {
9850: # if we are in the middle of processing the resource the
9851: # get the value we are planning on committing
9852: if (defined($Apache::lonhomework::results{$qualifierrest})) {
9853: return $Apache::lonhomework::results{$qualifierrest};
9854: } else {
9855: return $Apache::lonhomework::history{$qualifierrest};
9856: }
9857: } else {
9858: my %restored;
9859: if ($publicuser || $env{'request.state'} eq 'construct') {
9860: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
9861: } else {
9862: %restored=&restore($symbparm,$courseid,$udom,$uname);
9863: }
9864: return $restored{$qualifierrest};
9865: }
9866: # ----------------------------------------------------------------- user.access
9867: } elsif ($space eq 'access') {
9868: # FIXME - not supporting calls for a specific user
9869: return &allowed($qualifier,$rest);
9870: # ------------------------------------------ user.preferences, user.environment
9871: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
9872: if (($uname eq $env{'user.name'}) &&
9873: ($udom eq $env{'user.domain'})) {
9874: return $env{join('.',('environment',$qualifierrest))};
9875: } else {
9876: my %returnhash;
9877: if (!$publicuser) {
9878: %returnhash=&userenvironment($udom,$uname,
9879: $qualifierrest);
9880: }
9881: return $returnhash{$qualifierrest};
9882: }
9883: # ----------------------------------------------------------------- user.course
9884: } elsif ($space eq 'course') {
9885: # FIXME - not supporting calls for a specific user
9886: return $env{join('.',('request.course',$qualifier))};
9887: # ------------------------------------------------------------------- user.role
9888: } elsif ($space eq 'role') {
9889: # FIXME - not supporting calls for a specific user
9890: my ($role,$where)=split(/\./,$env{'request.role'});
9891: if ($qualifier eq 'value') {
9892: return $role;
9893: } elsif ($qualifier eq 'extent') {
9894: return $where;
9895: }
9896: # ----------------------------------------------------------------- user.domain
9897: } elsif ($space eq 'domain') {
9898: return $udom;
9899: # ------------------------------------------------------------------- user.name
9900: } elsif ($space eq 'name') {
9901: return $uname;
9902: # ---------------------------------------------------- Any other user namespace
9903: } else {
9904: my %reply;
9905: if (!$publicuser) {
9906: %reply=&get($space,[$qualifierrest],$udom,$uname);
9907: }
9908: return $reply{$qualifierrest};
9909: }
9910: } elsif ($realm eq 'query') {
9911: # ---------------------------------------------- pull stuff out of query string
9912: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
9913: [$spacequalifierrest]);
9914: return $env{'form.'.$spacequalifierrest};
9915: } elsif ($realm eq 'request') {
9916: # ------------------------------------------------------------- request.browser
9917: if ($space eq 'browser') {
9918: return $env{'browser.'.$qualifier};
9919: # ------------------------------------------------------------ request.filename
9920: } else {
9921: return $env{'request.'.$spacequalifierrest};
9922: }
9923: } elsif ($realm eq 'course') {
9924: # ---------------------------------------------------------- course.description
9925: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
9926: } elsif ($realm eq 'resource') {
9927:
9928: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
9929: if (!$symbparm) { $symbparm=&symbread(); }
9930: }
9931:
9932: if ($qualifier eq '') {
9933: if ($space eq 'title') {
9934: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
9935: return &gettitle($symbparm);
9936: }
9937:
9938: if ($space eq 'map') {
9939: my ($map) = &decode_symb($symbparm);
9940: return &symbread($map);
9941: }
9942: if ($space eq 'maptitle') {
9943: my ($map) = &decode_symb($symbparm);
9944: return &gettitle($map);
9945: }
9946: if ($space eq 'filename') {
9947: if ($symbparm) {
9948: return &clutter((&decode_symb($symbparm))[2]);
9949: }
9950: return &hreflocation('',$env{'request.filename'});
9951: }
9952:
9953: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
9954: if ($space eq 'visibleparts') {
9955: my $navmap = Apache::lonnavmaps::navmap->new();
9956: my $item;
9957: if (ref($navmap)) {
9958: my $res = $navmap->getBySymb($symbparm);
9959: my $parts = $res->parts();
9960: if (ref($parts) eq 'ARRAY') {
9961: $item = join(',',@{$parts});
9962: }
9963: undef($navmap);
9964: }
9965: return $item;
9966: }
9967: }
9968: }
9969:
9970: my ($section, $group, @groups);
9971: my ($courselevelm,$courselevel);
9972: if (($courseid eq '') && ($cid)) {
9973: $courseid = $cid;
9974: }
9975: if (($symbparm && $courseid) &&
9976: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
9977:
9978: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
9979:
9980: # ----------------------------------------------------- Cascading lookup scheme
9981: my $symbp=$symbparm;
9982: my $mapp=&deversion((&decode_symb($symbp))[0]);
9983:
9984: my $symbparm=$symbp.'.'.$spacequalifierrest;
9985: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
9986:
9987: if (($env{'user.name'} eq $uname) &&
9988: ($env{'user.domain'} eq $udom)) {
9989: $section=$env{'request.course.sec'};
9990: @groups = split(/:/,$env{'request.course.groups'});
9991: @groups=&sort_course_groups($courseid,@groups);
9992: } else {
9993: if (! defined($usection)) {
9994: $section=&getsection($udom,$uname,$courseid);
9995: } else {
9996: $section = $usection;
9997: }
9998: @groups = &get_users_groups($udom,$uname,$courseid);
9999: }
10000:
10001: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10002: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10003: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10004:
10005: $courselevel=$courseid.'.'.$spacequalifierrest;
10006: my $courselevelr=$courseid.'.'.$symbparm;
10007: $courselevelm=$courseid.'.'.$mapparm;
10008:
10009: # ----------------------------------------------------------- first, check user
10010:
10011: my $userreply=&resdata($uname,$udom,'user',
10012: ([$courselevelr,'resource'],
10013: [$courselevelm,'map' ],
10014: [$courselevel, 'course' ]));
10015: if (defined($userreply)) { return &get_reply($userreply); }
10016:
10017: # ------------------------------------------------ second, check some of course
10018: my $coursereply;
10019: if (@groups > 0) {
10020: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10021: $mapparm,$spacequalifierrest);
10022: if (defined($coursereply)) { return &get_reply($coursereply); }
10023: }
10024:
10025: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10026: $env{'course.'.$courseid.'.domain'},
10027: 'course',
10028: ([$seclevelr, 'resource'],
10029: [$seclevelm, 'map' ],
10030: [$seclevel, 'course' ],
10031: [$courselevelr,'resource']));
10032: if (defined($coursereply)) { return &get_reply($coursereply); }
10033:
10034: # ------------------------------------------------------ third, check map parms
10035: my %parmhash=();
10036: my $thisparm='';
10037: if (tie(%parmhash,'GDBM_File',
10038: $env{'request.course.fn'}.'_parms.db',
10039: &GDBM_READER(),0640)) {
10040: $thisparm=$parmhash{$symbparm};
10041: untie(%parmhash);
10042: }
10043: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
10044: }
10045: # ------------------------------------------ fourth, look in resource metadata
10046:
10047: $spacequalifierrest=~s/\./\_/;
10048: my $filename;
10049: if (!$symbparm) { $symbparm=&symbread(); }
10050: if ($symbparm) {
10051: $filename=(&decode_symb($symbparm))[2];
10052: } else {
10053: $filename=$env{'request.filename'};
10054: }
10055: my $metadata=&metadata($filename,$spacequalifierrest);
10056: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10057: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
10058: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10059:
10060: # ---------------------------------------------- fourth, look in rest of course
10061: if ($symbparm && defined($courseid) &&
10062: $courseid eq $env{'request.course.id'}) {
10063: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10064: $env{'course.'.$courseid.'.domain'},
10065: 'course',
10066: ([$courselevelm,'map' ],
10067: [$courselevel, 'course']));
10068: if (defined($coursereply)) { return &get_reply($coursereply); }
10069: }
10070: # ------------------------------------------------------------------ Cascade up
10071: unless ($space eq '0') {
10072: my @parts=split(/_/,$space);
10073: my $id=pop(@parts);
10074: my $part=join('_',@parts);
10075: if ($part eq '') { $part='0'; }
10076: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
10077: $symbparm,$udom,$uname,$section,1);
10078: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
10079: }
10080: if ($recurse) { return undef; }
10081: my $pack_def=&packages_tab_default($filename,$varname);
10082: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
10083: # ---------------------------------------------------- Any other user namespace
10084: } elsif ($realm eq 'environment') {
10085: # ----------------------------------------------------------------- environment
10086: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10087: return $env{'environment.'.$spacequalifierrest};
10088: } else {
10089: if ($uname eq 'anonymous' && $udom eq '') {
10090: return '';
10091: }
10092: my %returnhash=&userenvironment($udom,$uname,
10093: $spacequalifierrest);
10094: return $returnhash{$spacequalifierrest};
10095: }
10096: } elsif ($realm eq 'system') {
10097: # ----------------------------------------------------------------- system.time
10098: if ($space eq 'time') {
10099: return time;
10100: }
10101: } elsif ($realm eq 'server') {
10102: # ----------------------------------------------------------------- system.time
10103: if ($space eq 'name') {
10104: return $ENV{'SERVER_NAME'};
10105: }
10106: }
10107: return '';
10108: }
10109:
10110: sub get_reply {
10111: my ($reply_value) = @_;
10112: if (ref($reply_value) eq 'ARRAY') {
10113: if (wantarray) {
10114: return @$reply_value;
10115: }
10116: return $reply_value->[0];
10117: } else {
10118: return $reply_value;
10119: }
10120: }
10121:
10122: sub check_group_parms {
10123: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
10124: my @groupitems = ();
10125: my $resultitem;
10126: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
10127: foreach my $group (@{$groups}) {
10128: foreach my $level (@levels) {
10129: my $item = $courseid.'.['.$group.'].'.$level->[0];
10130: push(@groupitems,[$item,$level->[1]]);
10131: }
10132: }
10133: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10134: $env{'course.'.$courseid.'.domain'},
10135: 'course',@groupitems);
10136: return $coursereply;
10137: }
10138:
10139: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
10140: my ($courseid,@groups) = @_;
10141: @groups = sort(@groups);
10142: return @groups;
10143: }
10144:
10145: sub packages_tab_default {
10146: my ($uri,$varname)=@_;
10147: my (undef,$part,$name)=split(/\./,$varname);
10148:
10149: my (@extension,@specifics,$do_default);
10150: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
10151: my ($pack_type,$pack_part)=split(/_/,$package,2);
10152: if ($pack_type eq 'default') {
10153: $do_default=1;
10154: } elsif ($pack_type eq 'extension') {
10155: push(@extension,[$package,$pack_type,$pack_part]);
10156: } elsif ($pack_part eq $part || $pack_type eq 'part') {
10157: # only look at packages defaults for packages that this id is
10158: push(@specifics,[$package,$pack_type,$pack_part]);
10159: }
10160: }
10161: # first look for a package that matches the requested part id
10162: foreach my $package (@specifics) {
10163: my (undef,$pack_type,$pack_part)=@{$package};
10164: next if ($pack_part ne $part);
10165: if (defined($packagetab{"$pack_type&$name&default"})) {
10166: return $packagetab{"$pack_type&$name&default"};
10167: }
10168: }
10169: # look for any possible matching non extension_ package
10170: foreach my $package (@specifics) {
10171: my (undef,$pack_type,$pack_part)=@{$package};
10172: if (defined($packagetab{"$pack_type&$name&default"})) {
10173: return $packagetab{"$pack_type&$name&default"};
10174: }
10175: if ($pack_type eq 'part') { $pack_part='0'; }
10176: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10177: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
10178: }
10179: }
10180: # look for any posible extension_ match
10181: foreach my $package (@extension) {
10182: my ($package,$pack_type)=@{$package};
10183: if (defined($packagetab{"$pack_type&$name&default"})) {
10184: return $packagetab{"$pack_type&$name&default"};
10185: }
10186: if (defined($packagetab{$package."&$name&default"})) {
10187: return $packagetab{$package."&$name&default"};
10188: }
10189: }
10190: # look for a global default setting
10191: if ($do_default && defined($packagetab{"default&$name&default"})) {
10192: return $packagetab{"default&$name&default"};
10193: }
10194: return undef;
10195: }
10196:
10197: sub add_prefix_and_part {
10198: my ($prefix,$part)=@_;
10199: my $keyroot;
10200: if (defined($prefix) && $prefix !~ /^__/) {
10201: # prefix that has a part already
10202: $keyroot=$prefix;
10203: } elsif (defined($prefix)) {
10204: # prefix that is missing a part
10205: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10206: } else {
10207: # no prefix at all
10208: if (defined($part)) { $keyroot='_'.$part; }
10209: }
10210: return $keyroot;
10211: }
10212:
10213: # ---------------------------------------------------------------- Get metadata
10214:
10215: my %metaentry;
10216: my %importedpartids;
10217: sub metadata {
10218: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
10219: $uri=&declutter($uri);
10220: # if it is a non metadata possible uri return quickly
10221: if (($uri eq '') ||
10222: (($uri =~ m|^/*adm/|) &&
10223: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
10224: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
10225: return undef;
10226: }
10227: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
10228: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
10229: return undef;
10230: }
10231: my $filename=$uri;
10232: $uri=~s/\.meta$//;
10233: #
10234: # Is the metadata already cached?
10235: # Look at timestamp of caching
10236: # Everything is cached by the main uri, libraries are never directly cached
10237: #
10238: if (!defined($liburi)) {
10239: my ($result,$cached)=&is_cached_new('meta',$uri);
10240: if (defined($cached)) { return $result->{':'.$what}; }
10241: }
10242: {
10243: # Imported parts would go here
10244: my %importedids=();
10245: my @origfileimportpartids=();
10246: my $importedparts=0;
10247: #
10248: # Is this a recursive call for a library?
10249: #
10250: # if (! exists($metacache{$uri})) {
10251: # $metacache{$uri}={};
10252: # }
10253: my $cachetime = 60*60;
10254: if ($liburi) {
10255: $liburi=&declutter($liburi);
10256: $filename=$liburi;
10257: } else {
10258: &devalidate_cache_new('meta',$uri);
10259: undef(%metaentry);
10260: }
10261: my %metathesekeys=();
10262: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
10263: my $metastring;
10264: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
10265: my $which = &hreflocation('','/'.($liburi || $uri));
10266: $metastring =
10267: &Apache::lonnet::ssi_body($which,
10268: ('grade_target' => 'meta'));
10269: $cachetime = 1; # only want this cached in the child not long term
10270: } elsif (($uri !~ m -^(editupload)/-) &&
10271: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
10272: my $file=&filelocation('',&clutter($filename));
10273: #push(@{$metaentry{$uri.'.file'}},$file);
10274: $metastring=&getfile($file);
10275: }
10276: my $parser=HTML::LCParser->new(\$metastring);
10277: my $token;
10278: undef %metathesekeys;
10279: while ($token=$parser->get_token) {
10280: if ($token->[0] eq 'S') {
10281: if (defined($token->[2]->{'package'})) {
10282: #
10283: # This is a package - get package info
10284: #
10285: my $package=$token->[2]->{'package'};
10286: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10287: if (defined($token->[2]->{'id'})) {
10288: $keyroot.='_'.$token->[2]->{'id'};
10289: }
10290: if ($metaentry{':packages'}) {
10291: $metaentry{':packages'}.=','.$package.$keyroot;
10292: } else {
10293: $metaentry{':packages'}=$package.$keyroot;
10294: }
10295: foreach my $pack_entry (keys(%packagetab)) {
10296: my $part=$keyroot;
10297: $part=~s/^\_//;
10298: if ($pack_entry=~/^\Q$package\E\&/ ||
10299: $pack_entry=~/^\Q$package\E_0\&/) {
10300: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
10301: # ignore package.tab specified default values
10302: # here &package_tab_default() will fetch those
10303: if ($subp eq 'default') { next; }
10304: my $value=$packagetab{$pack_entry};
10305: my $unikey;
10306: if ($pack =~ /_0$/) {
10307: $unikey='parameter_0_'.$name;
10308: $part=0;
10309: } else {
10310: $unikey='parameter'.$keyroot.'_'.$name;
10311: }
10312: if ($subp eq 'display') {
10313: $value.=' [Part: '.$part.']';
10314: }
10315: $metaentry{':'.$unikey.'.part'}=$part;
10316: $metathesekeys{$unikey}=1;
10317: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10318: $metaentry{':'.$unikey.'.'.$subp}=$value;
10319: }
10320: if (defined($metaentry{':'.$unikey.'.default'})) {
10321: $metaentry{':'.$unikey}=
10322: $metaentry{':'.$unikey.'.default'};
10323: }
10324: }
10325: }
10326: } else {
10327: #
10328: # This is not a package - some other kind of start tag
10329: #
10330: my $entry=$token->[1];
10331: my $unikey='';
10332:
10333: if ($entry eq 'import') {
10334: #
10335: # Importing a library here
10336: #
10337: my $location=$parser->get_text('/import');
10338: my $dir=$filename;
10339: $dir=~s|[^/]*$||;
10340: $location=&filelocation($dir,$location);
10341:
10342: my $importmode=$token->[2]->{'importmode'};
10343: if ($importmode eq 'problem') {
10344: # Import as problem/response
10345: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10346: } elsif ($importmode eq 'part') {
10347: # Import as part(s)
10348: $importedparts=1;
10349: # We need to get the original file and the imported file to get the part order correct
10350: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
10351: # Load and inspect original file
10352: if ($#origfileimportpartids<0) {
10353: undef(%importedpartids);
10354: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
10355: my $origfile=&getfile($origfilelocation);
10356: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10357: }
10358:
10359: # Load and inspect imported file
10360: my $impfile=&getfile($location);
10361: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10362: if ($#impfilepartids>=0) {
10363: # This problem had parts
10364: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
10365: } else {
10366: # Importing by turning a single problem into a problem part
10367: # It gets the import-tags ID as part-ID
10368: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
10369: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
10370: }
10371: } else {
10372: # Normal import
10373: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10374: if (defined($token->[2]->{'id'})) {
10375: $unikey.='_'.$token->[2]->{'id'};
10376: }
10377: }
10378:
10379: if ($depthcount<20) {
10380: my $metadata =
10381: &metadata($uri,'keys', $location,$unikey,
10382: $depthcount+1);
10383: foreach my $meta (split(',',$metadata)) {
10384: $metaentry{':'.$meta}=$metaentry{':'.$meta};
10385: $metathesekeys{$meta}=1;
10386: }
10387:
10388: }
10389: } else {
10390: #
10391: # Not importing, some other kind of non-package, non-library start tag
10392: #
10393: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
10394: if (defined($token->[2]->{'id'})) {
10395: $unikey.='_'.$token->[2]->{'id'};
10396: }
10397: if (defined($token->[2]->{'name'})) {
10398: $unikey.='_'.$token->[2]->{'name'};
10399: }
10400: $metathesekeys{$unikey}=1;
10401: foreach my $param (@{$token->[3]}) {
10402: $metaentry{':'.$unikey.'.'.$param} =
10403: $token->[2]->{$param};
10404: }
10405: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
10406: my $default=$metaentry{':'.$unikey.'.default'};
10407: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
10408: # only ws inside the tag, and not in default, so use default
10409: # as value
10410: $metaentry{':'.$unikey}=$default;
10411: } elsif ( $internaltext =~ /\S/ ) {
10412: # something interesting inside the tag
10413: $metaentry{':'.$unikey}=$internaltext;
10414: } else {
10415: # no interesting values, don't set a default
10416: }
10417: # end of not-a-package not-a-library import
10418: }
10419: # end of not-a-package start tag
10420: }
10421: # the next is the end of "start tag"
10422: }
10423: }
10424: my ($extension) = ($uri =~ /\.(\w+)$/);
10425: $extension = lc($extension);
10426: if ($extension eq 'htm') { $extension='html'; }
10427:
10428: foreach my $key (keys(%packagetab)) {
10429: #no specific packages #how's our extension
10430: if ($key!~/^extension_\Q$extension\E&/) { next; }
10431: &metadata_create_package_def($uri,$key,'extension_'.$extension,
10432: \%metathesekeys);
10433: }
10434:
10435: if (!exists($metaentry{':packages'})
10436: || $packagetab{"import_defaults&extension_$extension"}) {
10437: foreach my $key (keys(%packagetab)) {
10438: #no specific packages well let's get default then
10439: if ($key!~/^default&/) { next; }
10440: &metadata_create_package_def($uri,$key,'default',
10441: \%metathesekeys);
10442: }
10443: }
10444: # are there custom rights to evaluate
10445: if ($metaentry{':copyright'} eq 'custom') {
10446:
10447: #
10448: # Importing a rights file here
10449: #
10450: unless ($depthcount) {
10451: my $location=$metaentry{':customdistributionfile'};
10452: my $dir=$filename;
10453: $dir=~s|[^/]*$||;
10454: $location=&filelocation($dir,$location);
10455: my $rights_metadata =
10456: &metadata($uri,'keys',$location,'_rights',
10457: $depthcount+1);
10458: foreach my $rights (split(',',$rights_metadata)) {
10459: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
10460: $metathesekeys{$rights}=1;
10461: }
10462: }
10463: }
10464: # uniqifiy package listing
10465: my %seen;
10466: my @uniq_packages =
10467: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
10468: $metaentry{':packages'} = join(',',@uniq_packages);
10469:
10470: if ($importedparts) {
10471: # We had imported parts and need to rebuild partorder
10472: $metaentry{':partorder'}='';
10473: $metathesekeys{'partorder'}=1;
10474: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
10475: if ($origfileimportpartids[$index] eq 'part') {
10476: # original part, part of the problem
10477: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
10478: } else {
10479: # we have imported parts at this position
10480: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
10481: }
10482: }
10483: $metaentry{':partorder'}=~s/^\,//;
10484: }
10485:
10486: $metaentry{':keys'} = join(',',keys(%metathesekeys));
10487: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
10488: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
10489: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
10490: # this is the end of "was not already recently cached
10491: }
10492: return $metaentry{':'.$what};
10493: }
10494:
10495: sub metadata_create_package_def {
10496: my ($uri,$key,$package,$metathesekeys)=@_;
10497: my ($pack,$name,$subp)=split(/\&/,$key);
10498: if ($subp eq 'default') { next; }
10499:
10500: if (defined($metaentry{':packages'})) {
10501: $metaentry{':packages'}.=','.$package;
10502: } else {
10503: $metaentry{':packages'}=$package;
10504: }
10505: my $value=$packagetab{$key};
10506: my $unikey;
10507: $unikey='parameter_0_'.$name;
10508: $metaentry{':'.$unikey.'.part'}=0;
10509: $$metathesekeys{$unikey}=1;
10510: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10511: $metaentry{':'.$unikey.'.'.$subp}=$value;
10512: }
10513: if (defined($metaentry{':'.$unikey.'.default'})) {
10514: $metaentry{':'.$unikey}=
10515: $metaentry{':'.$unikey.'.default'};
10516: }
10517: }
10518:
10519: sub metadata_generate_part0 {
10520: my ($metadata,$metacache,$uri) = @_;
10521: my %allnames;
10522: foreach my $metakey (keys(%$metadata)) {
10523: if ($metakey=~/^parameter\_(.*)/) {
10524: my $part=$$metacache{':'.$metakey.'.part'};
10525: my $name=$$metacache{':'.$metakey.'.name'};
10526: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
10527: $allnames{$name}=$part;
10528: }
10529: }
10530: }
10531: foreach my $name (keys(%allnames)) {
10532: $$metadata{"parameter_0_$name"}=1;
10533: my $key=":parameter_0_$name";
10534: $$metacache{"$key.part"}='0';
10535: $$metacache{"$key.name"}=$name;
10536: $$metacache{"$key.type"}=$$metacache{':parameter_'.
10537: $allnames{$name}.'_'.$name.
10538: '.type'};
10539: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
10540: '.display'};
10541: my $expr='[Part: '.$allnames{$name}.']';
10542: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
10543: $$metacache{"$key.display"}=$olddis;
10544: }
10545: }
10546:
10547: # ------------------------------------------------------ Devalidate title cache
10548:
10549: sub devalidate_title_cache {
10550: my ($url)=@_;
10551: if (!$env{'request.course.id'}) { return; }
10552: my $symb=&symbread($url);
10553: if (!$symb) { return; }
10554: my $key=$env{'request.course.id'}."\0".$symb;
10555: &devalidate_cache_new('title',$key);
10556: }
10557:
10558: # ------------------------------------------------- Get the title of a course
10559:
10560: sub current_course_title {
10561: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
10562: }
10563: # ------------------------------------------------- Get the title of a resource
10564:
10565: sub gettitle {
10566: my $urlsymb=shift;
10567: my $symb=&symbread($urlsymb);
10568: if ($symb) {
10569: my $key=$env{'request.course.id'}."\0".$symb;
10570: my ($result,$cached)=&is_cached_new('title',$key);
10571: if (defined($cached)) {
10572: return $result;
10573: }
10574: my ($map,$resid,$url)=&decode_symb($symb);
10575: my $title='';
10576: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
10577: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
10578: } else {
10579: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10580: &GDBM_READER(),0640)) {
10581: my $mapid=$bighash{'map_pc_'.&clutter($map)};
10582: $title=$bighash{'title_'.$mapid.'.'.$resid};
10583: untie(%bighash);
10584: }
10585: }
10586: $title=~s/\&colon\;/\:/gs;
10587: if ($title) {
10588: # Remember both $symb and $title for dynamic metadata
10589: $accesshash{$symb.'___crstitle'}=$title;
10590: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
10591: # Cache this title and then return it
10592: return &do_cache_new('title',$key,$title,600);
10593: }
10594: $urlsymb=$url;
10595: }
10596: my $title=&metadata($urlsymb,'title');
10597: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
10598: return $title;
10599: }
10600:
10601: sub get_slot {
10602: my ($which,$cnum,$cdom)=@_;
10603: if (!$cnum || !$cdom) {
10604: (undef,my $courseid)=&whichuser();
10605: $cdom=$env{'course.'.$courseid.'.domain'};
10606: $cnum=$env{'course.'.$courseid.'.num'};
10607: }
10608: my $key=join("\0",'slots',$cdom,$cnum,$which);
10609: my %slotinfo;
10610: if (exists($remembered{$key})) {
10611: $slotinfo{$which} = $remembered{$key};
10612: } else {
10613: %slotinfo=&get('slots',[$which],$cdom,$cnum);
10614: &Apache::lonhomework::showhash(%slotinfo);
10615: my ($tmp)=keys(%slotinfo);
10616: if ($tmp=~/^error:/) { return (); }
10617: $remembered{$key} = $slotinfo{$which};
10618: }
10619: if (ref($slotinfo{$which}) eq 'HASH') {
10620: return %{$slotinfo{$which}};
10621: }
10622: return $slotinfo{$which};
10623: }
10624:
10625: sub get_reservable_slots {
10626: my ($cnum,$cdom,$uname,$udom) = @_;
10627: my $now = time;
10628: my $reservable_info;
10629: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
10630: if (exists($remembered{$key})) {
10631: $reservable_info = $remembered{$key};
10632: } else {
10633: my %resv;
10634: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
10635: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
10636: $reservable_info = \%resv;
10637: $remembered{$key} = $reservable_info;
10638: }
10639: return $reservable_info;
10640: }
10641:
10642: sub get_course_slots {
10643: my ($cnum,$cdom) = @_;
10644: my $hashid=$cnum.':'.$cdom;
10645: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
10646: if (defined($cached)) {
10647: if (ref($result) eq 'HASH') {
10648: return %{$result};
10649: }
10650: } else {
10651: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
10652: my ($tmp) = keys(%slots);
10653: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10654: &do_cache_new('allslots',$hashid,\%slots,600);
10655: return %slots;
10656: }
10657: }
10658: return;
10659: }
10660:
10661: sub devalidate_slots_cache {
10662: my ($cnum,$cdom)=@_;
10663: my $hashid=$cnum.':'.$cdom;
10664: &devalidate_cache_new('allslots',$hashid);
10665: }
10666:
10667: sub get_coursechange {
10668: my ($cdom,$cnum) = @_;
10669: if ($cdom eq '' || $cnum eq '') {
10670: return unless ($env{'request.course.id'});
10671: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10672: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10673: }
10674: my $hashid=$cdom.'_'.$cnum;
10675: my ($change,$cached)=&is_cached_new('crschange',$hashid);
10676: if ((defined($cached)) && ($change ne '')) {
10677: return $change;
10678: } else {
10679: my %crshash;
10680: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
10681: if ($crshash{'internal.contentchange'} eq '') {
10682: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
10683: if ($change eq '') {
10684: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
10685: $change = $crshash{'internal.created'};
10686: }
10687: } else {
10688: $change = $crshash{'internal.contentchange'};
10689: }
10690: my $cachetime = 600;
10691: &do_cache_new('crschange',$hashid,$change,$cachetime);
10692: }
10693: return $change;
10694: }
10695:
10696: sub devalidate_coursechange_cache {
10697: my ($cnum,$cdom)=@_;
10698: my $hashid=$cnum.':'.$cdom;
10699: &devalidate_cache_new('crschange',$hashid);
10700: }
10701:
10702: # ------------------------------------------------- Update symbolic store links
10703:
10704: sub symblist {
10705: my ($mapname,%newhash)=@_;
10706: $mapname=&deversion(&declutter($mapname));
10707: my %hash;
10708: if (($env{'request.course.fn'}) && (%newhash)) {
10709: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
10710: &GDBM_WRCREAT(),0640)) {
10711: foreach my $url (keys(%newhash)) {
10712: next if ($url eq 'last_known'
10713: && $env{'form.no_update_last_known'});
10714: $hash{declutter($url)}=&encode_symb($mapname,
10715: $newhash{$url}->[1],
10716: $newhash{$url}->[0]);
10717: }
10718: if (untie(%hash)) {
10719: return 'ok';
10720: }
10721: }
10722: }
10723: return 'error';
10724: }
10725:
10726: # --------------------------------------------------------------- Verify a symb
10727:
10728: sub symbverify {
10729: my ($symb,$thisurl,$encstate)=@_;
10730: my $thisfn=$thisurl;
10731: $thisfn=&declutter($thisfn);
10732: # direct jump to resource in page or to a sequence - will construct own symbs
10733: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
10734: # check URL part
10735: my ($map,$resid,$url)=&decode_symb($symb);
10736:
10737: unless ($url eq $thisfn) { return 0; }
10738:
10739: $symb=&symbclean($symb);
10740: $thisurl=&deversion($thisurl);
10741: $thisfn=&deversion($thisfn);
10742:
10743: my %bighash;
10744: my $okay=0;
10745:
10746: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10747: &GDBM_READER(),0640)) {
10748: my $noclutter;
10749: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
10750: $thisurl =~ s/\?.+$//;
10751: if ($map =~ m{^uploaded/.+\.page$}) {
10752: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
10753: $thisurl =~ s{^\Qhttp://https://\E}{https://};
10754: $noclutter = 1;
10755: }
10756: }
10757: my $ids;
10758: if ($noclutter) {
10759: $ids=$bighash{'ids_'.$thisurl};
10760: } else {
10761: $ids=$bighash{'ids_'.&clutter($thisurl)};
10762: }
10763: unless ($ids) {
10764: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
10765: $ids=$bighash{$idkey};
10766: }
10767: if ($ids) {
10768: # ------------------------------------------------------------------- Has ID(s)
10769: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
10770: $symb =~ s/\?.+$//;
10771: }
10772: foreach my $id (split(/\,/,$ids)) {
10773: my ($mapid,$resid)=split(/\./,$id);
10774: if (
10775: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
10776: eq $symb) {
10777: if (ref($encstate)) {
10778: $$encstate = $bighash{'encrypted_'.$id};
10779: }
10780: if (($env{'request.role.adv'}) ||
10781: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
10782: ($thisurl eq '/adm/navmaps')) {
10783: $okay=1;
10784: last;
10785: }
10786: }
10787: }
10788: }
10789: untie(%bighash);
10790: }
10791: return $okay;
10792: }
10793:
10794: # --------------------------------------------------------------- Clean-up symb
10795:
10796: sub symbclean {
10797: my $symb=shift;
10798: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10799: # remove version from map
10800: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
10801:
10802: # remove version from URL
10803: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
10804:
10805: # remove wrapper
10806:
10807: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
10808: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
10809: return $symb;
10810: }
10811:
10812: # ---------------------------------------------- Split symb to find map and url
10813:
10814: sub encode_symb {
10815: my ($map,$resid,$url)=@_;
10816: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
10817: }
10818:
10819: sub decode_symb {
10820: my $symb=shift;
10821: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10822: my ($map,$resid,$url)=split(/___/,$symb);
10823: return (&fixversion($map),$resid,&fixversion($url));
10824: }
10825:
10826: sub fixversion {
10827: my $fn=shift;
10828: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
10829: my %bighash;
10830: my $uri=&clutter($fn);
10831: my $key=$env{'request.course.id'}.'_'.$uri;
10832: # is this cached?
10833: my ($result,$cached)=&is_cached_new('courseresversion',$key);
10834: if (defined($cached)) { return $result; }
10835: # unfortunately not cached, or expired
10836: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10837: &GDBM_READER(),0640)) {
10838: if ($bighash{'version_'.$uri}) {
10839: my $version=$bighash{'version_'.$uri};
10840: unless (($version eq 'mostrecent') ||
10841: ($version==&getversion($uri))) {
10842: $uri=~s/\.(\w+)$/\.$version\.$1/;
10843: }
10844: }
10845: untie %bighash;
10846: }
10847: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
10848: }
10849:
10850: sub deversion {
10851: my $url=shift;
10852: $url=~s/\.\d+\.(\w+)$/\.$1/;
10853: return $url;
10854: }
10855:
10856: # ------------------------------------------------------ Return symb list entry
10857:
10858: sub symbread {
10859: my ($thisfn,$donotrecurse)=@_;
10860: my $cache_str='request.symbread.cached.'.$thisfn;
10861: if (defined($env{$cache_str})) { return $env{$cache_str}; }
10862: # no filename provided? try from environment
10863: unless ($thisfn) {
10864: if ($env{'request.symb'}) {
10865: return $env{$cache_str}=&symbclean($env{'request.symb'});
10866: }
10867: $thisfn=$env{'request.filename'};
10868: }
10869: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
10870: # is that filename actually a symb? Verify, clean, and return
10871: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
10872: if (&symbverify($thisfn,$1)) {
10873: return $env{$cache_str}=&symbclean($thisfn);
10874: }
10875: }
10876: $thisfn=declutter($thisfn);
10877: my %hash;
10878: my %bighash;
10879: my $syval='';
10880: if (($env{'request.course.fn'}) && ($thisfn)) {
10881: my $targetfn = $thisfn;
10882: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
10883: $targetfn = 'adm/wrapper/'.$thisfn;
10884: }
10885: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
10886: $targetfn=$1;
10887: }
10888: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
10889: &GDBM_READER(),0640)) {
10890: $syval=$hash{$targetfn};
10891: untie(%hash);
10892: }
10893: # ---------------------------------------------------------- There was an entry
10894: if ($syval) {
10895: #unless ($syval=~/\_\d+$/) {
10896: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
10897: #&appenv({'request.ambiguous' => $thisfn});
10898: #return $env{$cache_str}='';
10899: #}
10900: #$syval.=$1;
10901: #}
10902: } else {
10903: # ------------------------------------------------------- Was not in symb table
10904: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10905: &GDBM_READER(),0640)) {
10906: # ---------------------------------------------- Get ID(s) for current resource
10907: my $ids=$bighash{'ids_'.&clutter($thisfn)};
10908: unless ($ids) {
10909: $ids=$bighash{'ids_/'.$thisfn};
10910: }
10911: unless ($ids) {
10912: # alias?
10913: $ids=$bighash{'mapalias_'.$thisfn};
10914: }
10915: if ($ids) {
10916: # ------------------------------------------------------------------- Has ID(s)
10917: my @possibilities=split(/\,/,$ids);
10918: if ($#possibilities==0) {
10919: # ----------------------------------------------- There is only one possibility
10920: my ($mapid,$resid)=split(/\./,$ids);
10921: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10922: $resid,$thisfn);
10923: } elsif (!$donotrecurse) {
10924: # ------------------------------------------ There is more than one possibility
10925: my $realpossible=0;
10926: foreach my $id (@possibilities) {
10927: my $file=$bighash{'src_'.$id};
10928: if (&allowed('bre',$file)) {
10929: my ($mapid,$resid)=split(/\./,$id);
10930: if ($bighash{'map_type_'.$mapid} ne 'page') {
10931: $realpossible++;
10932: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10933: $resid,$thisfn);
10934: }
10935: }
10936: }
10937: if ($realpossible!=1) { $syval=''; }
10938: } else {
10939: $syval='';
10940: }
10941: }
10942: untie(%bighash)
10943: }
10944: }
10945: if ($syval) {
10946: return $env{$cache_str}=$syval;
10947: }
10948: }
10949: &appenv({'request.ambiguous' => $thisfn});
10950: return $env{$cache_str}='';
10951: }
10952:
10953: # ---------------------------------------------------------- Return random seed
10954:
10955: sub numval {
10956: my $txt=shift;
10957: $txt=~tr/A-J/0-9/;
10958: $txt=~tr/a-j/0-9/;
10959: $txt=~tr/K-T/0-9/;
10960: $txt=~tr/k-t/0-9/;
10961: $txt=~tr/U-Z/0-5/;
10962: $txt=~tr/u-z/0-5/;
10963: $txt=~s/\D//g;
10964: if ($_64bit) { if ($txt > 2**32) { return -1; } }
10965: return int($txt);
10966: }
10967:
10968: sub numval2 {
10969: my $txt=shift;
10970: $txt=~tr/A-J/0-9/;
10971: $txt=~tr/a-j/0-9/;
10972: $txt=~tr/K-T/0-9/;
10973: $txt=~tr/k-t/0-9/;
10974: $txt=~tr/U-Z/0-5/;
10975: $txt=~tr/u-z/0-5/;
10976: $txt=~s/\D//g;
10977: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10978: my $total;
10979: foreach my $val (@txts) { $total+=$val; }
10980: if ($_64bit) { if ($total > 2**32) { return -1; } }
10981: return int($total);
10982: }
10983:
10984: sub numval3 {
10985: use integer;
10986: my $txt=shift;
10987: $txt=~tr/A-J/0-9/;
10988: $txt=~tr/a-j/0-9/;
10989: $txt=~tr/K-T/0-9/;
10990: $txt=~tr/k-t/0-9/;
10991: $txt=~tr/U-Z/0-5/;
10992: $txt=~tr/u-z/0-5/;
10993: $txt=~s/\D//g;
10994: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10995: my $total;
10996: foreach my $val (@txts) { $total+=$val; }
10997: if ($_64bit) { $total=(($total<<32)>>32); }
10998: return $total;
10999: }
11000:
11001: sub digest {
11002: my ($data)=@_;
11003: my $digest=&Digest::MD5::md5($data);
11004: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11005: my ($e,$f);
11006: {
11007: use integer;
11008: $e=($a+$b);
11009: $f=($c+$d);
11010: if ($_64bit) {
11011: $e=(($e<<32)>>32);
11012: $f=(($f<<32)>>32);
11013: }
11014: }
11015: if (wantarray) {
11016: return ($e,$f);
11017: } else {
11018: my $g;
11019: {
11020: use integer;
11021: $g=($e+$f);
11022: if ($_64bit) {
11023: $g=(($g<<32)>>32);
11024: }
11025: }
11026: return $g;
11027: }
11028: }
11029:
11030: sub latest_rnd_algorithm_id {
11031: return '64bit5';
11032: }
11033:
11034: sub get_rand_alg {
11035: my ($courseid)=@_;
11036: if (!$courseid) { $courseid=(&whichuser())[1]; }
11037: if ($courseid) {
11038: return $env{"course.$courseid.rndseed"};
11039: }
11040: return &latest_rnd_algorithm_id();
11041: }
11042:
11043: sub validCODE {
11044: my ($CODE)=@_;
11045: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11046: return 0;
11047: }
11048:
11049: sub getCODE {
11050: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
11051: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11052: defined($Apache::lonhomework::parsing_a_task) ) &&
11053: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
11054: return $Apache::lonhomework::history{'resource.CODE'};
11055: }
11056: return undef;
11057: }
11058: #
11059: # Determines the random seed for a specific context:
11060: #
11061: # parameters:
11062: # symb - in course context the symb for the seed.
11063: # course_id - The course id of the form domain_coursenum.
11064: # domain - Domain for the user.
11065: # course - Course for the user.
11066: # cenv - environment of the course.
11067: #
11068: # NOTE:
11069: # All parameters are picked out of the environment if missing
11070: # or not defined.
11071: # If a symb cannot be determined the current time is used instead.
11072: #
11073: # For a given well defined symb, courside, domain, username,
11074: # and course environment, the seed is reproducible.
11075: #
11076: sub rndseed {
11077: my ($symb,$courseid,$domain,$username, $cenv)=@_;
11078: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
11079: if (!defined($symb)) {
11080: unless ($symb=$wsymb) { return time; }
11081: }
11082: if (!defined $courseid) {
11083: $courseid=$wcourseid;
11084: }
11085: if (!defined $domain) { $domain=$wdomain; }
11086: if (!defined $username) { $username=$wusername }
11087:
11088: my $which;
11089: if (defined($cenv->{'rndseed'})) {
11090: $which = $cenv->{'rndseed'};
11091: } else {
11092: $which =&get_rand_alg($courseid);
11093: }
11094: if (defined(&getCODE())) {
11095:
11096: if ($which eq '64bit5') {
11097: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11098: } elsif ($which eq '64bit4') {
11099: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11100: } else {
11101: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11102: }
11103: } elsif ($which eq '64bit5') {
11104: return &rndseed_64bit5($symb,$courseid,$domain,$username);
11105: } elsif ($which eq '64bit4') {
11106: return &rndseed_64bit4($symb,$courseid,$domain,$username);
11107: } elsif ($which eq '64bit3') {
11108: return &rndseed_64bit3($symb,$courseid,$domain,$username);
11109: } elsif ($which eq '64bit2') {
11110: return &rndseed_64bit2($symb,$courseid,$domain,$username);
11111: } elsif ($which eq '64bit') {
11112: return &rndseed_64bit($symb,$courseid,$domain,$username);
11113: }
11114: return &rndseed_32bit($symb,$courseid,$domain,$username);
11115: }
11116:
11117: sub rndseed_32bit {
11118: my ($symb,$courseid,$domain,$username)=@_;
11119: {
11120: use integer;
11121: my $symbchck=unpack("%32C*",$symb) << 27;
11122: my $symbseed=numval($symb) << 22;
11123: my $namechck=unpack("%32C*",$username) << 17;
11124: my $nameseed=numval($username) << 12;
11125: my $domainseed=unpack("%32C*",$domain) << 7;
11126: my $courseseed=unpack("%32C*",$courseid);
11127: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
11128: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11129: #&logthis("rndseed :$num:$symb");
11130: if ($_64bit) { $num=(($num<<32)>>32); }
11131: return $num;
11132: }
11133: }
11134:
11135: sub rndseed_64bit {
11136: my ($symb,$courseid,$domain,$username)=@_;
11137: {
11138: use integer;
11139: my $symbchck=unpack("%32S*",$symb) << 21;
11140: my $symbseed=numval($symb) << 10;
11141: my $namechck=unpack("%32S*",$username);
11142:
11143: my $nameseed=numval($username) << 21;
11144: my $domainseed=unpack("%32S*",$domain) << 10;
11145: my $courseseed=unpack("%32S*",$courseid);
11146:
11147: my $num1=$symbchck+$symbseed+$namechck;
11148: my $num2=$nameseed+$domainseed+$courseseed;
11149: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11150: #&logthis("rndseed :$num:$symb");
11151: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11152: return "$num1,$num2";
11153: }
11154: }
11155:
11156: sub rndseed_64bit2 {
11157: my ($symb,$courseid,$domain,$username)=@_;
11158: {
11159: use integer;
11160: # strings need to be an even # of cahracters long, it it is odd the
11161: # last characters gets thrown away
11162: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11163: my $symbseed=numval($symb) << 10;
11164: my $namechck=unpack("%32S*",$username.' ');
11165:
11166: my $nameseed=numval($username) << 21;
11167: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11168: my $courseseed=unpack("%32S*",$courseid.' ');
11169:
11170: my $num1=$symbchck+$symbseed+$namechck;
11171: my $num2=$nameseed+$domainseed+$courseseed;
11172: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11173: #&logthis("rndseed :$num:$symb");
11174: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11175: return "$num1,$num2";
11176: }
11177: }
11178:
11179: sub rndseed_64bit3 {
11180: my ($symb,$courseid,$domain,$username)=@_;
11181: {
11182: use integer;
11183: # strings need to be an even # of cahracters long, it it is odd the
11184: # last characters gets thrown away
11185: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11186: my $symbseed=numval2($symb) << 10;
11187: my $namechck=unpack("%32S*",$username.' ');
11188:
11189: my $nameseed=numval2($username) << 21;
11190: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11191: my $courseseed=unpack("%32S*",$courseid.' ');
11192:
11193: my $num1=$symbchck+$symbseed+$namechck;
11194: my $num2=$nameseed+$domainseed+$courseseed;
11195: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11196: #&logthis("rndseed :$num1:$num2:$_64bit");
11197: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11198:
11199: return "$num1:$num2";
11200: }
11201: }
11202:
11203: sub rndseed_64bit4 {
11204: my ($symb,$courseid,$domain,$username)=@_;
11205: {
11206: use integer;
11207: # strings need to be an even # of cahracters long, it it is odd the
11208: # last characters gets thrown away
11209: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11210: my $symbseed=numval3($symb) << 10;
11211: my $namechck=unpack("%32S*",$username.' ');
11212:
11213: my $nameseed=numval3($username) << 21;
11214: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11215: my $courseseed=unpack("%32S*",$courseid.' ');
11216:
11217: my $num1=$symbchck+$symbseed+$namechck;
11218: my $num2=$nameseed+$domainseed+$courseseed;
11219: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11220: #&logthis("rndseed :$num1:$num2:$_64bit");
11221: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11222:
11223: return "$num1:$num2";
11224: }
11225: }
11226:
11227: sub rndseed_64bit5 {
11228: my ($symb,$courseid,$domain,$username)=@_;
11229: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11230: return "$num1:$num2";
11231: }
11232:
11233: sub rndseed_CODE_64bit {
11234: my ($symb,$courseid,$domain,$username)=@_;
11235: {
11236: use integer;
11237: my $symbchck=unpack("%32S*",$symb.' ') << 16;
11238: my $symbseed=numval2($symb);
11239: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11240: my $CODEseed=numval(&getCODE());
11241: my $courseseed=unpack("%32S*",$courseid.' ');
11242: my $num1=$symbseed+$CODEchck;
11243: my $num2=$CODEseed+$courseseed+$symbchck;
11244: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11245: #&logthis("rndseed :$num1:$num2:$symb");
11246: if ($_64bit) { $num1=(($num1<<32)>>32); }
11247: if ($_64bit) { $num2=(($num2<<32)>>32); }
11248: return "$num1:$num2";
11249: }
11250: }
11251:
11252: sub rndseed_CODE_64bit4 {
11253: my ($symb,$courseid,$domain,$username)=@_;
11254: {
11255: use integer;
11256: my $symbchck=unpack("%32S*",$symb.' ') << 16;
11257: my $symbseed=numval3($symb);
11258: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11259: my $CODEseed=numval3(&getCODE());
11260: my $courseseed=unpack("%32S*",$courseid.' ');
11261: my $num1=$symbseed+$CODEchck;
11262: my $num2=$CODEseed+$courseseed+$symbchck;
11263: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11264: #&logthis("rndseed :$num1:$num2:$symb");
11265: if ($_64bit) { $num1=(($num1<<32)>>32); }
11266: if ($_64bit) { $num2=(($num2<<32)>>32); }
11267: return "$num1:$num2";
11268: }
11269: }
11270:
11271: sub rndseed_CODE_64bit5 {
11272: my ($symb,$courseid,$domain,$username)=@_;
11273: my $code = &getCODE();
11274: my ($num1,$num2)=&digest("$symb,$courseid,$code");
11275: return "$num1:$num2";
11276: }
11277:
11278: sub setup_random_from_rndseed {
11279: my ($rndseed)=@_;
11280: if ($rndseed =~/([,:])/) {
11281: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
11282: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
11283: &Math::Random::random_set_seed_from_phrase($rndseed);
11284: } else {
11285: &Math::Random::random_set_seed($num1,$num2);
11286: }
11287: } else {
11288: &Math::Random::random_set_seed_from_phrase($rndseed);
11289: }
11290: }
11291:
11292: sub latest_receipt_algorithm_id {
11293: return 'receipt3';
11294: }
11295:
11296: sub recunique {
11297: my $fucourseid=shift;
11298: my $unique;
11299: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
11300: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
11301: $unique=$env{"course.$fucourseid.internal.encseed"};
11302: } else {
11303: $unique=$perlvar{'lonReceipt'};
11304: }
11305: return unpack("%32C*",$unique);
11306: }
11307:
11308: sub recprefix {
11309: my $fucourseid=shift;
11310: my $prefix;
11311: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
11312: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
11313: $prefix=$env{"course.$fucourseid.internal.encpref"};
11314: } else {
11315: $prefix=$perlvar{'lonHostID'};
11316: }
11317: return unpack("%32C*",$prefix);
11318: }
11319:
11320: sub ireceipt {
11321: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
11322:
11323: my $return =&recprefix($fucourseid).'-';
11324:
11325: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
11326: $env{'request.state'} eq 'construct') {
11327: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
11328: return $return;
11329: }
11330:
11331: my $cuname=unpack("%32C*",$funame);
11332: my $cudom=unpack("%32C*",$fudom);
11333: my $cucourseid=unpack("%32C*",$fucourseid);
11334: my $cusymb=unpack("%32C*",$fusymb);
11335: my $cunique=&recunique($fucourseid);
11336: my $cpart=unpack("%32S*",$part);
11337: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
11338:
11339: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
11340:
11341: $return.= ($cunique%$cuname+
11342: $cunique%$cudom+
11343: $cusymb%$cuname+
11344: $cusymb%$cudom+
11345: $cucourseid%$cuname+
11346: $cucourseid%$cudom+
11347: $cpart%$cuname+
11348: $cpart%$cudom);
11349: } else {
11350: $return.= ($cunique%$cuname+
11351: $cunique%$cudom+
11352: $cusymb%$cuname+
11353: $cusymb%$cudom+
11354: $cucourseid%$cuname+
11355: $cucourseid%$cudom);
11356: }
11357: return $return;
11358: }
11359:
11360: sub receipt {
11361: my ($part)=@_;
11362: my ($symb,$courseid,$domain,$name) = &whichuser();
11363: return &ireceipt($name,$domain,$courseid,$symb,$part);
11364: }
11365:
11366: sub whichuser {
11367: my ($passedsymb)=@_;
11368: my ($symb,$courseid,$domain,$name,$publicuser);
11369: if (defined($env{'form.grade_symb'})) {
11370: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
11371: my $allowed=&allowed('vgr',$tmp_courseid);
11372: if (!$allowed &&
11373: exists($env{'request.course.sec'}) &&
11374: $env{'request.course.sec'} !~ /^\s*$/) {
11375: $allowed=&allowed('vgr',$tmp_courseid.
11376: '/'.$env{'request.course.sec'});
11377: }
11378: if ($allowed) {
11379: ($symb)=&get_env_multiple('form.grade_symb');
11380: $courseid=$tmp_courseid;
11381: ($domain)=&get_env_multiple('form.grade_domain');
11382: ($name)=&get_env_multiple('form.grade_username');
11383: return ($symb,$courseid,$domain,$name,$publicuser);
11384: }
11385: }
11386: if (!$passedsymb) {
11387: $symb=&symbread();
11388: } else {
11389: $symb=$passedsymb;
11390: }
11391: $courseid=$env{'request.course.id'};
11392: $domain=$env{'user.domain'};
11393: $name=$env{'user.name'};
11394: if ($name eq 'public' && $domain eq 'public') {
11395: if (!defined($env{'form.username'})) {
11396: $env{'form.username'}.=time.rand(10000000);
11397: }
11398: $name.=$env{'form.username'};
11399: }
11400: return ($symb,$courseid,$domain,$name,$publicuser);
11401:
11402: }
11403:
11404: # ------------------------------------------------------------ Serves up a file
11405: # returns either the contents of the file or
11406: # -1 if the file doesn't exist
11407: #
11408: # if the target is a file that was uploaded via DOCS,
11409: # a check will be made to see if a current copy exists on the local server,
11410: # if it does this will be served, otherwise a copy will be retrieved from
11411: # the home server for the course and stored in /home/httpd/html/userfiles on
11412: # the local server.
11413:
11414: sub getfile {
11415: my ($file) = @_;
11416: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
11417: &repcopy($file);
11418: return &readfile($file);
11419: }
11420:
11421: sub repcopy_userfile {
11422: my ($file)=@_;
11423: my $londocroot = $perlvar{'lonDocRoot'};
11424: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
11425: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
11426: my ($cdom,$cnum,$filename) =
11427: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
11428: my $uri="/uploaded/$cdom/$cnum/$filename";
11429: if (-e "$file") {
11430: # we already have a local copy, check it out
11431: my @fileinfo = stat($file);
11432: my $rtncode;
11433: my $info;
11434: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
11435: if ($lwpresp ne 'ok') {
11436: # there is no such file anymore, even though we had a local copy
11437: if ($rtncode eq '404') {
11438: unlink($file);
11439: }
11440: return -1;
11441: }
11442: if ($info < $fileinfo[9]) {
11443: # nice, the file we have is up-to-date, just say okay
11444: return 'ok';
11445: } else {
11446: # the file is outdated, get rid of it
11447: unlink($file);
11448: }
11449: }
11450: # one way or the other, at this point, we don't have the file
11451: # construct the correct path for the file
11452: my @parts = ($cdom,$cnum);
11453: if ($filename =~ m|^(.+)/[^/]+$|) {
11454: push @parts, split(/\//,$1);
11455: }
11456: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
11457: foreach my $part (@parts) {
11458: $path .= '/'.$part;
11459: if (!-e $path) {
11460: mkdir($path,0770);
11461: }
11462: }
11463: # now the path exists for sure
11464: # get a user agent
11465: my $ua=new LWP::UserAgent;
11466: my $transferfile=$file.'.in.transfer';
11467: # FIXME: this should flock
11468: if (-e $transferfile) { return 'ok'; }
11469: my $request;
11470: $uri=~s/^\///;
11471: my $homeserver = &homeserver($cnum,$cdom);
11472: my $protocol = $protocol{$homeserver};
11473: $protocol = 'http' if ($protocol ne 'https');
11474: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
11475: my $response=$ua->request($request,$transferfile);
11476: # did it work?
11477: if ($response->is_error()) {
11478: unlink($transferfile);
11479: &logthis("Userfile repcopy failed for $uri");
11480: return -1;
11481: }
11482: # worked, rename the transfer file
11483: rename($transferfile,$file);
11484: return 'ok';
11485: }
11486:
11487: sub tokenwrapper {
11488: my $uri=shift;
11489: $uri=~s|^https?\://([^/]+)||;
11490: $uri=~s|^/||;
11491: $env{'user.environment'}=~/\/([^\/]+)\.id/;
11492: my $token=$1;
11493: my (undef,$udom,$uname,$file)=split('/',$uri,4);
11494: if ($udom && $uname && $file) {
11495: $file=~s|(\?\.*)*$||;
11496: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
11497: my $homeserver = &homeserver($uname,$udom);
11498: my $protocol = $protocol{$homeserver};
11499: $protocol = 'http' if ($protocol ne 'https');
11500: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
11501: (($uri=~/\?/)?'&':'?').'token='.$token.
11502: '&tokenissued='.$perlvar{'lonHostID'};
11503: } else {
11504: return '/adm/notfound.html';
11505: }
11506: }
11507:
11508: # call with reqtype HEAD: get last modification time
11509: # call with reqtype GET: get the file contents
11510: # Do not call this with reqtype GET for large files! It loads everything into memory
11511: #
11512: sub getuploaded {
11513: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
11514: $uri=~s/^\///;
11515: my $homeserver = &homeserver($cnum,$cdom);
11516: my $protocol = $protocol{$homeserver};
11517: $protocol = 'http' if ($protocol ne 'https');
11518: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
11519: my $ua=new LWP::UserAgent;
11520: my $request=new HTTP::Request($reqtype,$uri);
11521: my $response=$ua->request($request);
11522: $$rtncode = $response->code;
11523: if (! $response->is_success()) {
11524: return 'failed';
11525: }
11526: if ($reqtype eq 'HEAD') {
11527: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
11528: } elsif ($reqtype eq 'GET') {
11529: $$info = $response->content;
11530: }
11531: return 'ok';
11532: }
11533:
11534: sub readfile {
11535: my $file = shift;
11536: if ( (! -e $file ) || ($file eq '') ) { return -1; };
11537: my $fh;
11538: open($fh,"<$file");
11539: my $a='';
11540: while (my $line = <$fh>) { $a .= $line; }
11541: return $a;
11542: }
11543:
11544: sub filelocation {
11545: my ($dir,$file) = @_;
11546: my $location;
11547: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
11548:
11549: if ($file =~ m-^/adm/-) {
11550: $file=~s-^/adm/wrapper/-/-;
11551: $file=~s-^/adm/coursedocs/showdoc/-/-;
11552: }
11553:
11554: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
11555: $location = $file;
11556: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
11557: my ($udom,$uname,$filename)=
11558: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
11559: my $home=&homeserver($uname,$udom);
11560: my $is_me=0;
11561: my @ids=¤t_machine_ids();
11562: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
11563: if ($is_me) {
11564: $location=propath($udom,$uname).'/userfiles/'.$filename;
11565: } else {
11566: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
11567: $udom.'/'.$uname.'/'.$filename;
11568: }
11569: } elsif ($file =~ m-^/adm/-) {
11570: $location = $perlvar{'lonDocRoot'}.'/'.$file;
11571: } else {
11572: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
11573: $file=~s:^/(res|priv)/:/:;
11574: my $space=$1;
11575: if ( !( $file =~ m:^/:) ) {
11576: $location = $dir. '/'.$file;
11577: } else {
11578: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
11579: }
11580: }
11581: $location=~s://+:/:g; # remove duplicate /
11582: while ($location=~m{/\.\./}) {
11583: if ($location =~ m{/[^/]+/\.\./}) {
11584: $location=~ s{/[^/]+/\.\./}{/}g;
11585: } else {
11586: $location=~ s{/\.\./}{/}g;
11587: }
11588: } #remove dir/..
11589: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
11590: return $location;
11591: }
11592:
11593: sub hreflocation {
11594: my ($dir,$file)=@_;
11595: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
11596: $file=filelocation($dir,$file);
11597: } elsif ($file=~m-^/adm/-) {
11598: $file=~s-^/adm/wrapper/-/-;
11599: $file=~s-^/adm/coursedocs/showdoc/-/-;
11600: }
11601: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
11602: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
11603: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
11604: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
11605: {/uploaded/$1/$2/}x;
11606: }
11607: if ($file=~ m{^/userfiles/}) {
11608: $file =~ s{^/userfiles/}{/uploaded/};
11609: }
11610: return $file;
11611: }
11612:
11613:
11614:
11615:
11616:
11617: sub current_machine_domains {
11618: return &machine_domains(&hostname($perlvar{'lonHostID'}));
11619: }
11620:
11621: sub machine_domains {
11622: my ($hostname) = @_;
11623: my @domains;
11624: my %hostname = &all_hostnames();
11625: while( my($id, $name) = each(%hostname)) {
11626: # &logthis("-$id-$name-$hostname-");
11627: if ($hostname eq $name) {
11628: push(@domains,&host_domain($id));
11629: }
11630: }
11631: return @domains;
11632: }
11633:
11634: sub current_machine_ids {
11635: return &machine_ids(&hostname($perlvar{'lonHostID'}));
11636: }
11637:
11638: sub machine_ids {
11639: my ($hostname) = @_;
11640: $hostname ||= &hostname($perlvar{'lonHostID'});
11641: my @ids;
11642: my %name_to_host = &all_names();
11643: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
11644: return @{ $name_to_host{$hostname} };
11645: }
11646: return;
11647: }
11648:
11649: sub additional_machine_domains {
11650: my @domains;
11651: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
11652: while( my $line = <$fh>) {
11653: $line =~ s/\s//g;
11654: push(@domains,$line);
11655: }
11656: return @domains;
11657: }
11658:
11659: sub default_login_domain {
11660: my $domain = $perlvar{'lonDefDomain'};
11661: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
11662: foreach my $posdom (¤t_machine_domains(),
11663: &additional_machine_domains()) {
11664: if (lc($posdom) eq lc($testdomain)) {
11665: $domain=$posdom;
11666: last;
11667: }
11668: }
11669: return $domain;
11670: }
11671:
11672: # ------------------------------------------------------------- Declutters URLs
11673:
11674: sub declutter {
11675: my $thisfn=shift;
11676: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
11677: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
11678: $thisfn=~s{^/home/httpd/html}{};
11679: }
11680: $thisfn=~s/^\///;
11681: $thisfn=~s|^adm/wrapper/||;
11682: $thisfn=~s|^adm/coursedocs/showdoc/||;
11683: $thisfn=~s/^res\///;
11684: $thisfn=~s/^priv\///;
11685: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
11686: $thisfn=~s/\?.+$//;
11687: }
11688: return $thisfn;
11689: }
11690:
11691: # ------------------------------------------------------------- Clutter up URLs
11692:
11693: sub clutter {
11694: my $thisfn='/'.&declutter(shift);
11695: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
11696: || $thisfn =~ m{^/adm/(includes|pages)} ) {
11697: $thisfn='/res'.$thisfn;
11698: }
11699: if ($thisfn !~m|^/adm|) {
11700: if ($thisfn =~ m|^/ext/|) {
11701: $thisfn='/adm/wrapper'.$thisfn;
11702: } else {
11703: my ($ext) = ($thisfn =~ /\.(\w+)$/);
11704: my $embstyle=&Apache::loncommon::fileembstyle($ext);
11705: if ($embstyle eq 'ssi'
11706: || ($embstyle eq 'hdn')
11707: || ($embstyle eq 'rat')
11708: || ($embstyle eq 'prv')
11709: || ($embstyle eq 'ign')) {
11710: #do nothing with these
11711: } elsif (($embstyle eq 'img')
11712: || ($embstyle eq 'emb')
11713: || ($embstyle eq 'wrp')) {
11714: $thisfn='/adm/wrapper'.$thisfn;
11715: } elsif ($embstyle eq 'unk'
11716: && $thisfn!~/\.(sequence|page)$/) {
11717: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
11718: } else {
11719: # &logthis("Got a blank emb style");
11720: }
11721: }
11722: }
11723: return $thisfn;
11724: }
11725:
11726: sub clutter_with_no_wrapper {
11727: my $uri = &clutter(shift);
11728: if ($uri =~ m-^/adm/-) {
11729: $uri =~ s-^/adm/wrapper/-/-;
11730: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
11731: }
11732: return $uri;
11733: }
11734:
11735: sub freeze_escape {
11736: my ($value)=@_;
11737: if (ref($value)) {
11738: $value=&nfreeze($value);
11739: return '__FROZEN__'.&escape($value);
11740: }
11741: return &escape($value);
11742: }
11743:
11744:
11745: sub thaw_unescape {
11746: my ($value)=@_;
11747: if ($value =~ /^__FROZEN__/) {
11748: substr($value,0,10,undef);
11749: $value=&unescape($value);
11750: return &thaw($value);
11751: }
11752: return &unescape($value);
11753: }
11754:
11755: sub correct_line_ends {
11756: my ($result)=@_;
11757: $$result =~s/\r\n/\n/mg;
11758: $$result =~s/\r/\n/mg;
11759: }
11760: # ================================================================ Main Program
11761:
11762: sub goodbye {
11763: &logthis("Starting Shut down");
11764: #not converted to using infrastruture and probably shouldn't be
11765: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
11766: #converted
11767: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
11768: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
11769: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
11770: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
11771: #1.1 only
11772: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
11773: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
11774: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
11775: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
11776: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
11777: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
11778: &logthis(sprintf("%-20s is %s",'hits',$hits));
11779: &flushcourselogs();
11780: &logthis("Shutting down");
11781: }
11782:
11783: sub get_dns {
11784: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
11785: if (!$ignore_cache) {
11786: my ($content,$cached)=
11787: &Apache::lonnet::is_cached_new('dns',$url);
11788: if ($cached) {
11789: &$func($content,$hashref);
11790: return;
11791: }
11792: }
11793:
11794: my %alldns;
11795: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11796: foreach my $dns (<$config>) {
11797: next if ($dns !~ /^\^(\S*)/x);
11798: my $line = $1;
11799: my ($host,$protocol) = split(/:/,$line);
11800: if ($protocol ne 'https') {
11801: $protocol = 'http';
11802: }
11803: $alldns{$host} = $protocol;
11804: }
11805: while (%alldns) {
11806: my ($dns) = sort { $b cmp $a } keys(%alldns);
11807: my $ua=new LWP::UserAgent;
11808: $ua->timeout(30);
11809: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
11810: my $response=$ua->request($request);
11811: delete($alldns{$dns});
11812: next if ($response->is_error());
11813: my @content = split("\n",$response->content);
11814: unless ($nocache) {
11815: &do_cache_new('dns',$url,\@content,30*24*60*60);
11816: }
11817: &$func(\@content,$hashref);
11818: return;
11819: }
11820: close($config);
11821: my $which = (split('/',$url))[3];
11822: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
11823: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
11824: my @content = <$config>;
11825: &$func(\@content,$hashref);
11826: return;
11827: }
11828:
11829: # ------------------------------------------------------Get DNS checksums file
11830: sub parse_dns_checksums_tab {
11831: my ($lines,$hashref) = @_;
11832: my $lonhost = $perlvar{'lonHostID'};
11833: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
11834: my $loncaparev = &get_server_loncaparev($machine_dom);
11835: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
11836: my $webconfdir = '/etc/httpd/conf';
11837: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
11838: $webconfdir = '/etc/apache2';
11839: } elsif ($distro =~ /^sles(\d+)$/) {
11840: if ($1 >= 10) {
11841: $webconfdir = '/etc/apache2';
11842: }
11843: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
11844: if ($1 >= 10.0) {
11845: $webconfdir = '/etc/apache2';
11846: }
11847: }
11848: my ($release,$timestamp) = split(/\-/,$loncaparev);
11849: my (%chksum,%revnum);
11850: if (ref($lines) eq 'ARRAY') {
11851: chomp(@{$lines});
11852: my $version = shift(@{$lines});
11853: if ($version eq $release) {
11854: foreach my $line (@{$lines}) {
11855: my ($file,$version,$shasum) = split(/,/,$line);
11856: if ($file =~ m{^/etc/httpd/conf}) {
11857: if ($webconfdir eq '/etc/apache2') {
11858: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
11859: }
11860: }
11861: $chksum{$file} = $shasum;
11862: $revnum{$file} = $version;
11863: }
11864: if (ref($hashref) eq 'HASH') {
11865: %{$hashref} = (
11866: sums => \%chksum,
11867: versions => \%revnum,
11868: );
11869: }
11870: }
11871: }
11872: return;
11873: }
11874:
11875: sub fetch_dns_checksums {
11876: my %checksums;
11877: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
11878: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
11879: my ($release,$timestamp) = split(/\-/,$loncaparev);
11880: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
11881: \%checksums);
11882: return \%checksums;
11883: }
11884:
11885: # ------------------------------------------------------------ Read domain file
11886: {
11887: my $loaded;
11888: my %domain;
11889:
11890: sub parse_domain_tab {
11891: my ($lines) = @_;
11892: foreach my $line (@$lines) {
11893: next if ($line =~ /^(\#|\s*$ )/x);
11894:
11895: chomp($line);
11896: my ($name,@elements) = split(/:/,$line,9);
11897: my %this_domain;
11898: foreach my $field ('description', 'auth_def', 'auth_arg_def',
11899: 'lang_def', 'city', 'longi', 'lati',
11900: 'primary') {
11901: $this_domain{$field} = shift(@elements);
11902: }
11903: $domain{$name} = \%this_domain;
11904: }
11905: }
11906:
11907: sub reset_domain_info {
11908: undef($loaded);
11909: undef(%domain);
11910: }
11911:
11912: sub load_domain_tab {
11913: my ($ignore_cache) = @_;
11914: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
11915: my $fh;
11916: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
11917: my @lines = <$fh>;
11918: &parse_domain_tab(\@lines);
11919: }
11920: close($fh);
11921: $loaded = 1;
11922: }
11923:
11924: sub domain {
11925: &load_domain_tab() if (!$loaded);
11926:
11927: my ($name,$what) = @_;
11928: return if ( !exists($domain{$name}) );
11929:
11930: if (!$what) {
11931: return $domain{$name}{'description'};
11932: }
11933: return $domain{$name}{$what};
11934: }
11935:
11936: sub domain_info {
11937: &load_domain_tab() if (!$loaded);
11938: return %domain;
11939: }
11940:
11941: }
11942:
11943:
11944: # ------------------------------------------------------------- Read hosts file
11945: {
11946: my %hostname;
11947: my %hostdom;
11948: my %libserv;
11949: my $loaded;
11950: my %name_to_host;
11951: my %internetdom;
11952: my %LC_dns_serv;
11953:
11954: sub parse_hosts_tab {
11955: my ($file) = @_;
11956: foreach my $configline (@$file) {
11957: next if ($configline =~ /^(\#|\s*$ )/x);
11958: chomp($configline);
11959: if ($configline =~ /^\^/) {
11960: if ($configline =~ /^\^([\w.\-]+)/) {
11961: $LC_dns_serv{$1} = 1;
11962: }
11963: next;
11964: }
11965: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
11966: $name=~s/\s//g;
11967: if ($id && $domain && $role && $name) {
11968: $hostname{$id}=$name;
11969: push(@{$name_to_host{$name}}, $id);
11970: $hostdom{$id}=$domain;
11971: if ($role eq 'library') { $libserv{$id}=$name; }
11972: if (defined($protocol)) {
11973: if ($protocol eq 'https') {
11974: $protocol{$id} = $protocol;
11975: } else {
11976: $protocol{$id} = 'http';
11977: }
11978: } else {
11979: $protocol{$id} = 'http';
11980: }
11981: if (defined($intdom)) {
11982: $internetdom{$id} = $intdom;
11983: }
11984: }
11985: }
11986: }
11987:
11988: sub reset_hosts_info {
11989: &purge_remembered();
11990: &reset_domain_info();
11991: &reset_hosts_ip_info();
11992: undef(%name_to_host);
11993: undef(%hostname);
11994: undef(%hostdom);
11995: undef(%libserv);
11996: undef($loaded);
11997: }
11998:
11999: sub load_hosts_tab {
12000: my ($ignore_cache) = @_;
12001: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
12002: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12003: my @config = <$config>;
12004: &parse_hosts_tab(\@config);
12005: close($config);
12006: $loaded=1;
12007: }
12008:
12009: sub hostname {
12010: &load_hosts_tab() if (!$loaded);
12011:
12012: my ($lonid) = @_;
12013: return $hostname{$lonid};
12014: }
12015:
12016: sub all_hostnames {
12017: &load_hosts_tab() if (!$loaded);
12018:
12019: return %hostname;
12020: }
12021:
12022: sub all_names {
12023: &load_hosts_tab() if (!$loaded);
12024:
12025: return %name_to_host;
12026: }
12027:
12028: sub all_host_domain {
12029: &load_hosts_tab() if (!$loaded);
12030: return %hostdom;
12031: }
12032:
12033: sub is_library {
12034: &load_hosts_tab() if (!$loaded);
12035:
12036: return exists($libserv{$_[0]});
12037: }
12038:
12039: sub all_library {
12040: &load_hosts_tab() if (!$loaded);
12041:
12042: return %libserv;
12043: }
12044:
12045: sub unique_library {
12046: #2x reverse removes all hostnames that appear more than once
12047: my %unique = reverse &all_library();
12048: return reverse %unique;
12049: }
12050:
12051: sub get_servers {
12052: &load_hosts_tab() if (!$loaded);
12053:
12054: my ($domain,$type) = @_;
12055: my %possible_hosts = ($type eq 'library') ? %libserv
12056: : %hostname;
12057: my %result;
12058: if (ref($domain) eq 'ARRAY') {
12059: while ( my ($host,$hostname) = each(%possible_hosts)) {
12060: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
12061: $result{$host} = $hostname;
12062: }
12063: }
12064: } else {
12065: while ( my ($host,$hostname) = each(%possible_hosts)) {
12066: if ($hostdom{$host} eq $domain) {
12067: $result{$host} = $hostname;
12068: }
12069: }
12070: }
12071: return %result;
12072: }
12073:
12074: sub get_unique_servers {
12075: my %unique = reverse &get_servers(@_);
12076: return reverse %unique;
12077: }
12078:
12079: sub host_domain {
12080: &load_hosts_tab() if (!$loaded);
12081:
12082: my ($lonid) = @_;
12083: return $hostdom{$lonid};
12084: }
12085:
12086: sub all_domains {
12087: &load_hosts_tab() if (!$loaded);
12088:
12089: my %seen;
12090: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12091: return @uniq;
12092: }
12093:
12094: sub internet_dom {
12095: &load_hosts_tab() if (!$loaded);
12096:
12097: my ($lonid) = @_;
12098: return $internetdom{$lonid};
12099: }
12100:
12101: sub is_LC_dns {
12102: &load_hosts_tab() if (!$loaded);
12103:
12104: my ($hostname) = @_;
12105: return exists($LC_dns_serv{$hostname});
12106: }
12107:
12108: }
12109:
12110: {
12111: my %iphost;
12112: my %name_to_ip;
12113: my %lonid_to_ip;
12114:
12115: sub get_hosts_from_ip {
12116: my ($ip) = @_;
12117: my %iphosts = &get_iphost();
12118: if (ref($iphosts{$ip})) {
12119: return @{$iphosts{$ip}};
12120: }
12121: return;
12122: }
12123:
12124: sub reset_hosts_ip_info {
12125: undef(%iphost);
12126: undef(%name_to_ip);
12127: undef(%lonid_to_ip);
12128: }
12129:
12130: sub get_host_ip {
12131: my ($lonid) = @_;
12132: if (exists($lonid_to_ip{$lonid})) {
12133: return $lonid_to_ip{$lonid};
12134: }
12135: my $name=&hostname($lonid);
12136: my $ip = gethostbyname($name);
12137: return if (!$ip || length($ip) ne 4);
12138: $ip=inet_ntoa($ip);
12139: $name_to_ip{$name} = $ip;
12140: $lonid_to_ip{$lonid} = $ip;
12141: return $ip;
12142: }
12143:
12144: sub get_iphost {
12145: my ($ignore_cache) = @_;
12146:
12147: if (!$ignore_cache) {
12148: if (%iphost) {
12149: return %iphost;
12150: }
12151: my ($ip_info,$cached)=
12152: &Apache::lonnet::is_cached_new('iphost','iphost');
12153: if ($cached) {
12154: %iphost = %{$ip_info->[0]};
12155: %name_to_ip = %{$ip_info->[1]};
12156: %lonid_to_ip = %{$ip_info->[2]};
12157: return %iphost;
12158: }
12159: }
12160:
12161: # get yesterday's info for fallback
12162: my %old_name_to_ip;
12163: my ($ip_info,$cached)=
12164: &Apache::lonnet::is_cached_new('iphost','iphost');
12165: if ($cached) {
12166: %old_name_to_ip = %{$ip_info->[1]};
12167: }
12168:
12169: my %name_to_host = &all_names();
12170: foreach my $name (keys(%name_to_host)) {
12171: my $ip;
12172: if (!exists($name_to_ip{$name})) {
12173: $ip = gethostbyname($name);
12174: if (!$ip || length($ip) ne 4) {
12175: if (defined($old_name_to_ip{$name})) {
12176: $ip = $old_name_to_ip{$name};
12177: &logthis("Can't find $name defaulting to old $ip");
12178: } else {
12179: &logthis("Name $name no IP found");
12180: next;
12181: }
12182: } else {
12183: $ip=inet_ntoa($ip);
12184: }
12185: $name_to_ip{$name} = $ip;
12186: } else {
12187: $ip = $name_to_ip{$name};
12188: }
12189: foreach my $id (@{ $name_to_host{$name} }) {
12190: $lonid_to_ip{$id} = $ip;
12191: }
12192: push(@{$iphost{$ip}},@{$name_to_host{$name}});
12193: }
12194: &do_cache_new('iphost','iphost',
12195: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12196: 48*60*60);
12197:
12198: return %iphost;
12199: }
12200:
12201: #
12202: # Given a DNS returns the loncapa host name for that DNS
12203: #
12204: sub host_from_dns {
12205: my ($dns) = @_;
12206: my @hosts;
12207: my $ip;
12208:
12209: if (exists($name_to_ip{$dns})) {
12210: $ip = $name_to_ip{$dns};
12211: }
12212: if (!$ip) {
12213: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12214: if (length($ip) == 4) {
12215: $ip = &IO::Socket::inet_ntoa($ip);
12216: }
12217: }
12218: if ($ip) {
12219: @hosts = get_hosts_from_ip($ip);
12220: return $hosts[0];
12221: }
12222: return undef;
12223: }
12224:
12225: sub get_internet_names {
12226: my ($lonid) = @_;
12227: return if ($lonid eq '');
12228: my ($idnref,$cached)=
12229: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12230: if ($cached) {
12231: return $idnref;
12232: }
12233: my $ip = &get_host_ip($lonid);
12234: my @hosts = &get_hosts_from_ip($ip);
12235: my %iphost = &get_iphost();
12236: my (@idns,%seen);
12237: foreach my $id (@hosts) {
12238: my $dom = &host_domain($id);
12239: my $prim_id = &domain($dom,'primary');
12240: my $prim_ip = &get_host_ip($prim_id);
12241: next if ($seen{$prim_ip});
12242: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
12243: foreach my $id (@{$iphost{$prim_ip}}) {
12244: my $intdom = &internet_dom($id);
12245: unless (grep(/^\Q$intdom\E$/,@idns)) {
12246: push(@idns,$intdom);
12247: }
12248: }
12249: }
12250: $seen{$prim_ip} = 1;
12251: }
12252: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
12253: }
12254:
12255: }
12256:
12257: sub all_loncaparevs {
12258: 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);
12259: }
12260:
12261: # ---------------------------------------------------------- Read loncaparev table
12262: {
12263: sub load_loncaparevs {
12264: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
12265: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
12266: while (my $configline=<$config>) {
12267: chomp($configline);
12268: my ($hostid,$loncaparev)=split(/:/,$configline);
12269: $loncaparevs{$hostid}=$loncaparev;
12270: }
12271: close($config);
12272: }
12273: }
12274: }
12275: }
12276:
12277: # ---------------------------------------------------------- Read serverhostID table
12278: {
12279: sub load_serverhomeIDs {
12280: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
12281: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
12282: while (my $configline=<$config>) {
12283: chomp($configline);
12284: my ($name,$id)=split(/:/,$configline);
12285: $serverhomeIDs{$name}=$id;
12286: }
12287: close($config);
12288: }
12289: }
12290: }
12291: }
12292:
12293:
12294: BEGIN {
12295:
12296: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
12297: unless ($readit) {
12298: {
12299: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
12300: %perlvar = (%perlvar,%{$configvars});
12301: }
12302:
12303:
12304: # ------------------------------------------------------ Read spare server file
12305: {
12306: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
12307:
12308: while (my $configline=<$config>) {
12309: chomp($configline);
12310: if ($configline) {
12311: my ($host,$type) = split(':',$configline,2);
12312: if (!defined($type) || $type eq '') { $type = 'default' };
12313: push(@{ $spareid{$type} }, $host);
12314: }
12315: }
12316: close($config);
12317: }
12318: # ------------------------------------------------------------ Read permissions
12319: {
12320: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
12321:
12322: while (my $configline=<$config>) {
12323: chomp($configline);
12324: if ($configline) {
12325: my ($role,$perm)=split(/ /,$configline);
12326: if ($perm ne '') { $pr{$role}=$perm; }
12327: }
12328: }
12329: close($config);
12330: }
12331:
12332: # -------------------------------------------- Read plain texts for permissions
12333: {
12334: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
12335:
12336: while (my $configline=<$config>) {
12337: chomp($configline);
12338: if ($configline) {
12339: my ($short,@plain)=split(/:/,$configline);
12340: %{$prp{$short}} = ();
12341: if (@plain > 0) {
12342: $prp{$short}{'std'} = $plain[0];
12343: for (my $i=1; $i<@plain; $i++) {
12344: $prp{$short}{'alt'.$i} = $plain[$i];
12345: }
12346: }
12347: }
12348: }
12349: close($config);
12350: }
12351:
12352: # ---------------------------------------------------------- Read package table
12353: {
12354: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
12355:
12356: while (my $configline=<$config>) {
12357: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
12358: chomp($configline);
12359: my ($short,$plain)=split(/:/,$configline);
12360: my ($pack,$name)=split(/\&/,$short);
12361: if ($plain ne '') {
12362: $packagetab{$pack.'&'.$name.'&name'}=$name;
12363: $packagetab{$short}=$plain;
12364: }
12365: }
12366: close($config);
12367: }
12368:
12369: # ---------------------------------------------------------- Read loncaparev table
12370:
12371: &load_loncaparevs();
12372:
12373: # ---------------------------------------------------------- Read serverhostID table
12374:
12375: &load_serverhomeIDs();
12376:
12377: # ---------------------------------------------------------- Read releaseslist XML
12378: {
12379: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
12380: if (-e $file) {
12381: my $parser = HTML::LCParser->new($file);
12382: while (my $token = $parser->get_token()) {
12383: if ($token->[0] eq 'S') {
12384: my $item = $token->[1];
12385: my $name = $token->[2]{'name'};
12386: my $value = $token->[2]{'value'};
12387: if ($item ne '' && $name ne '' && $value ne '') {
12388: my $release = $parser->get_text();
12389: $release =~ s/(^\s*|\s*$ )//gx;
12390: $needsrelease{$item.':'.$name.':'.$value} = $release;
12391: }
12392: }
12393: }
12394: }
12395: }
12396:
12397: # ---------------------------------------------------------- Read managers table
12398: {
12399: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
12400: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
12401: while (my $configline=<$config>) {
12402: chomp($configline);
12403: next if ($configline =~ /^\#/);
12404: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
12405: $managerstab{$configline} = 1;
12406: }
12407: }
12408: close($config);
12409: }
12410: }
12411: }
12412:
12413: # ------------- set up temporary directory
12414: {
12415: $tmpdir = LONCAPA::tempdir();
12416:
12417: }
12418:
12419: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
12420: 'compress_threshold'=> 20_000,
12421: });
12422:
12423: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
12424: $dumpcount=0;
12425: $locknum=0;
12426:
12427: &logtouch();
12428: &logthis('<font color="yellow">INFO: Read configuration</font>');
12429: $readit=1;
12430: {
12431: use integer;
12432: my $test=(2**32)+1;
12433: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
12434: &logthis(" Detected 64bit platform ($_64bit)");
12435: }
12436: }
12437: }
12438:
12439: 1;
12440: __END__
12441:
12442: =pod
12443:
12444: =head1 NAME
12445:
12446: Apache::lonnet - Subroutines to ask questions about things in the network.
12447:
12448: =head1 SYNOPSIS
12449:
12450: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
12451:
12452: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
12453:
12454: Common parameters:
12455:
12456: =over 4
12457:
12458: =item *
12459:
12460: $uname : an internal username (if $cname expecting a course Id specifically)
12461:
12462: =item *
12463:
12464: $udom : a domain (if $cdom expecting a course's domain specifically)
12465:
12466: =item *
12467:
12468: $symb : a resource instance identifier
12469:
12470: =item *
12471:
12472: $namespace : the name of a .db file that contains the data needed or
12473: being set.
12474:
12475: =back
12476:
12477: =head1 OVERVIEW
12478:
12479: lonnet provides subroutines which interact with the
12480: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
12481: about classes, users, and resources.
12482:
12483: For many of these objects you can also use this to store data about
12484: them or modify them in various ways.
12485:
12486: =head2 Symbs
12487:
12488: To identify a specific instance of a resource, LON-CAPA uses symbols
12489: or "symbs"X<symb>. These identifiers are built from the URL of the
12490: map, the resource number of the resource in the map, and the URL of
12491: the resource itself. The latter is somewhat redundant, but might help
12492: if maps change.
12493:
12494: An example is
12495:
12496: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
12497:
12498: The respective map entry is
12499:
12500: <resource id="19" src="/res/msu/korte/tests/part12.problem"
12501: title="Problem 2">
12502: </resource>
12503:
12504: Symbs are used by the random number generator, as well as to store and
12505: restore data specific to a certain instance of for example a problem.
12506:
12507: =head2 Storing And Retrieving Data
12508:
12509: X<store()>X<cstore()>X<restore()>Three of the most important functions
12510: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
12511: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
12512: is is the non-critical message twin of cstore. These functions are for
12513: handlers to store a perl hash to a user's permanent data space in an
12514: easy manner, and to retrieve it again on another call. It is expected
12515: that a handler would use this once at the beginning to retrieve data,
12516: and then again once at the end to send only the new data back.
12517:
12518: The data is stored in the user's data directory on the user's
12519: homeserver under the ID of the course.
12520:
12521: The hash that is returned by restore will have all of the previous
12522: value for all of the elements of the hash.
12523:
12524: Example:
12525:
12526: #creating a hash
12527: my %hash;
12528: $hash{'foo'}='bar';
12529:
12530: #storing it
12531: &Apache::lonnet::cstore(\%hash);
12532:
12533: #changing a value
12534: $hash{'foo'}='notbar';
12535:
12536: #adding a new value
12537: $hash{'bar'}='foo';
12538: &Apache::lonnet::cstore(\%hash);
12539:
12540: #retrieving the hash
12541: my %history=&Apache::lonnet::restore();
12542:
12543: #print the hash
12544: foreach my $key (sort(keys(%history))) {
12545: print("\%history{$key} = $history{$key}");
12546: }
12547:
12548: Will print out:
12549:
12550: %history{1:foo} = bar
12551: %history{1:keys} = foo:timestamp
12552: %history{1:timestamp} = 990455579
12553: %history{2:bar} = foo
12554: %history{2:foo} = notbar
12555: %history{2:keys} = foo:bar:timestamp
12556: %history{2:timestamp} = 990455580
12557: %history{bar} = foo
12558: %history{foo} = notbar
12559: %history{timestamp} = 990455580
12560: %history{version} = 2
12561:
12562: Note that the special hash entries C<keys>, C<version> and
12563: C<timestamp> were added to the hash. C<version> will be equal to the
12564: total number of versions of the data that have been stored. The
12565: C<timestamp> attribute will be the UNIX time the hash was
12566: stored. C<keys> is available in every historical section to list which
12567: keys were added or changed at a specific historical revision of a
12568: hash.
12569:
12570: B<Warning>: do not store the hash that restore returns directly. This
12571: will cause a mess since it will restore the historical keys as if the
12572: were new keys. I.E. 1:foo will become 1:1:foo etc.
12573:
12574: Calling convention:
12575:
12576: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
12577: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname);
12578:
12579: For more detailed information, see lonnet specific documentation.
12580:
12581: =head1 RETURN MESSAGES
12582:
12583: =over 4
12584:
12585: =item * B<con_lost>: unable to contact remote host
12586:
12587: =item * B<con_delayed>: unable to contact remote host, message will be delivered
12588: when the connection is brought back up
12589:
12590: =item * B<con_failed>: unable to contact remote host and unable to save message
12591: for later delivery
12592:
12593: =item * B<error:>: an error a occurred, a description of the error follows the :
12594:
12595: =item * B<no_such_host>: unable to fund a host associated with the user/domain
12596: that was requested
12597:
12598: =back
12599:
12600: =head1 PUBLIC SUBROUTINES
12601:
12602: =head2 Session Environment Functions
12603:
12604: =over 4
12605:
12606: =item *
12607: X<appenv()>
12608: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
12609: the user envirnoment file, and will be restored for each access this
12610: user makes during this session, also modifies the %env for the current
12611: process. Optional rolesarrayref - if defined contains a reference to an array
12612: of roles which are exempt from the restriction on modifying user.role entries
12613: in the user's environment.db and in %env.
12614:
12615: =item *
12616: X<delenv()>
12617: B<delenv($delthis,$regexp)>: removes all items from the session
12618: environment file that begin with $delthis. If the
12619: optional second arg - $regexp - is true, $delthis is treated as a
12620: regular expression, otherwise \Q$delthis\E is used.
12621: The values are also deleted from the current processes %env.
12622:
12623: =item * get_env_multiple($name)
12624:
12625: gets $name from the %env hash, it seemlessly handles the cases where multiple
12626: values may be defined and end up as an array ref.
12627:
12628: returns an array of values
12629:
12630: =back
12631:
12632: =head2 User Information
12633:
12634: =over 4
12635:
12636: =item *
12637: X<queryauthenticate()>
12638: B<queryauthenticate($uname,$udom)>: try to determine user's current
12639: authentication scheme
12640:
12641: =item *
12642: X<authenticate()>
12643: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
12644: authenticate user from domain's lib servers (first use the current
12645: one). C<$upass> should be the users password.
12646: $checkdefauth is optional (value is 1 if a check should be made to
12647: authenticate user using default authentication method, and allow
12648: account creation if username does not have account in the domain).
12649: $clientcancheckhost is optional (value is 1 if checking whether the
12650: server can host will occur on the client side in lonauth.pm).
12651:
12652: =item *
12653: X<homeserver()>
12654: B<homeserver($uname,$udom)>: find the server which has
12655: the user's directory and files (there must be only one), this caches
12656: the answer, and also caches if there is a borken connection.
12657:
12658: =item *
12659: X<idget()>
12660: B<idget($udom,@ids)>: find the usernames behind a list of IDs
12661: (IDs are a unique resource in a domain, there must be only 1 ID per
12662: username, and only 1 username per ID in a specific domain) (returns
12663: hash: id=>name,id=>name)
12664:
12665: =item *
12666: X<idrget()>
12667: B<idrget($udom,@unames)>: find the IDs behind a list of
12668: usernames (returns hash: name=>id,name=>id)
12669:
12670: =item *
12671: X<idput()>
12672: B<idput($udom,%ids)>: store away a list of names and associated IDs
12673:
12674: =item *
12675: X<rolesinit()>
12676: B<rolesinit($udom,$username)>: get user privileges.
12677: returns user role, first access and timer interval hashes
12678:
12679: =item *
12680: X<privileged()>
12681: B<privileged($username,$domain)>: returns a true if user has a
12682: privileged and active role (i.e. su or dc), false otherwise.
12683:
12684: =item *
12685: X<getsection()>
12686: B<getsection($udom,$uname,$cname)>: finds the section of student in the
12687: course $cname, return section name/number or '' for "not in course"
12688: and '-1' for "no section"
12689:
12690: =item *
12691: X<userenvironment()>
12692: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
12693: passed in @what from the requested user's environment, returns a hash
12694:
12695: =item *
12696: X<userlog_query()>
12697: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
12698: activity.log file. %filters defines filters applied when parsing the
12699: log file. These can be start or end timestamps, or the type of action
12700: - log to look for Login or Logout events, check for Checkin or
12701: Checkout, role for role selection. The response is in the form
12702: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
12703: escaped strings of the action recorded in the activity.log file.
12704:
12705: =back
12706:
12707: =head2 User Roles
12708:
12709: =over 4
12710:
12711: =item *
12712:
12713: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
12714: F: full access
12715: U,I,K: authentication modes (cxx only)
12716: '': forbidden
12717: 1: user needs to choose course
12718: 2: browse allowed
12719: A: passphrase authentication needed
12720:
12721: =item *
12722:
12723: constructaccess($url,$setpriv) : check for access to construction space URL
12724:
12725: See if the owner domain and name in the URL match those in the
12726: expected environment. If so, return three element list
12727: ($ownername,$ownerdomain,$ownerhome).
12728:
12729: Otherwise return the null string.
12730:
12731: If second argument 'setpriv' is true, it assigns the privileges,
12732: and returns the same three element list, unless the owner has
12733: blocked "ad hoc" Domain Coordinator access to the Author Space,
12734: in which case the null string is returned.
12735:
12736: =item *
12737:
12738: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
12739: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
12740: and course level
12741:
12742: =item *
12743:
12744: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
12745: (rolesplain.tab); plain text explanation of a user role term.
12746: $type is Course (default) or Community.
12747: If $forcedefault evaluates to true, text returned will be default
12748: text for $type. Otherwise, if this is a course, the text returned
12749: will be a custom name for the role (if defined in the course's
12750: environment). If no custom name is defined the default is returned.
12751:
12752: =item *
12753:
12754: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
12755: All arguments are optional. Returns a hash of a roles, either for
12756: co-author/assistant author roles for a user's Construction Space
12757: (default), or if $context is 'userroles', roles for the user himself,
12758: In the hash, keys are set to colon-separated $uname,$udom,$role, and
12759: (optionally) if $withsec is true, a fourth colon-separated item - $section.
12760: For each key, value is set to colon-separated start and end times for
12761: the role. If no username and domain are specified, will default to
12762: current user/domain. Types, roles, and roledoms are references to arrays
12763: of role statuses (active, future or previous), roles
12764: (e.g., cc,in, st etc.) and domains of the roles which can be used
12765: to restrict the list of roles reported. If no array ref is
12766: provided for types, will default to return only active roles.
12767:
12768: =item *
12769:
12770: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
12771: user: $uname:$udom has a role in the course: $cdom_$cnum.
12772:
12773: Additional optional arguments are: $type (if role checking is to be restricted
12774: to certain user status types -- previous (expired roles), active (currently
12775: available roles) or future (roles available in the future), and
12776: $hideprivileged -- if true will not report course roles for users who
12777: have active Domain Coordinator role in course's domain or in additional
12778: domains (specified in 'Domains to check for privileged users' in course
12779: environment -- set via: Course Settings -> Classlists and staff listing).
12780:
12781: =item *
12782:
12783: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
12784: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
12785: $possdomains and $possroles are optional array refs -- to domains to check and
12786: roles to check. If $possdomains is not specified, a dump will be done of the
12787: users' roles.db to check for a dc or su role in any domain. This can be
12788: time consuming if &privileged is called repeatedly (e.g., when displaying a
12789: classlist), so in such cases, supplying a $possdomains array is preferred, as
12790: this then allows &privileged_by_domain() to be used, which caches the identity
12791: of privileged users, eliminating the need for repeated calls to &dump().
12792:
12793: =item *
12794:
12795: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
12796: where the outer hash keys are domains specified in the $possdomains array ref,
12797: next inner hash keys are privileged roles specified in the $roles array ref,
12798: and the innermost hash contains key = value pairs for username:domain = end:start
12799: for active or future "privileged" users with that role in that domain. To avoid
12800: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
12801: innerhash are cached using priv_$role and $dom as the identifiers.
12802:
12803: =back
12804:
12805: =head2 User Modification
12806:
12807: =over 4
12808:
12809: =item *
12810:
12811: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
12812: user for the level given by URL. Optional start and end dates (leave empty
12813: string or zero for "no date")
12814:
12815: =item *
12816:
12817: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
12818: change a users, password, possible return values are: ok,
12819: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
12820: refused
12821:
12822: =item *
12823:
12824: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
12825:
12826: =item *
12827:
12828: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
12829: $forceid,$desiredhome,$email,$inststatus,$candelete) :
12830:
12831: will update user information (firstname,middlename,lastname,generation,
12832: permanentemail), and if forceid is true, student/employee ID also.
12833: A user's institutional affiliation(s) can also be updated.
12834: User information fields will not be overwritten with empty entries
12835: unless the field is included in the $candelete array reference.
12836: This array is included when a single user is modified via "Manage Users",
12837: or when Autoupdate.pl is run by cron in a domain.
12838:
12839: =item *
12840:
12841: modifystudent
12842:
12843: modify a student's enrollment and identification information.
12844: The course id is resolved based on the current user's environment.
12845: This means the invoking user must be a course coordinator or otherwise
12846: associated with a course.
12847:
12848: This call is essentially a wrapper for lonnet::modifyuser and
12849: lonnet::modify_student_enrollment
12850:
12851: Inputs:
12852:
12853: =over 4
12854:
12855: =item B<$udom> Student's loncapa domain
12856:
12857: =item B<$uname> Student's loncapa login name
12858:
12859: =item B<$uid> Student/Employee ID
12860:
12861: =item B<$umode> Student's authentication mode
12862:
12863: =item B<$upass> Student's password
12864:
12865: =item B<$first> Student's first name
12866:
12867: =item B<$middle> Student's middle name
12868:
12869: =item B<$last> Student's last name
12870:
12871: =item B<$gene> Student's generation
12872:
12873: =item B<$usec> Student's section in course
12874:
12875: =item B<$end> Unix time of the roles expiration
12876:
12877: =item B<$start> Unix time of the roles start date
12878:
12879: =item B<$forceid> If defined, allow $uid to be changed
12880:
12881: =item B<$desiredhome> server to use as home server for student
12882:
12883: =item B<$email> Student's permanent e-mail address
12884:
12885: =item B<$type> Type of enrollment (auto or manual)
12886:
12887: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
12888:
12889: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
12890:
12891: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
12892:
12893: =item B<$context> role change context (shown in User Management Logs display in a course)
12894:
12895: =item B<$inststatus> institutional status of user - : separated string of escaped status types
12896:
12897: =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.
12898:
12899: =back
12900:
12901: =item *
12902:
12903: modify_student_enrollment
12904:
12905: Change a student's enrollment status in a class. The environment variable
12906: 'role.request.course' must be defined for this function to proceed.
12907:
12908: Inputs:
12909:
12910: =over 4
12911:
12912: =item $udom, student's domain
12913:
12914: =item $uname, student's name
12915:
12916: =item $uid, student's user id
12917:
12918: =item $first, student's first name
12919:
12920: =item $middle
12921:
12922: =item $last
12923:
12924: =item $gene
12925:
12926: =item $usec
12927:
12928: =item $end
12929:
12930: =item $start
12931:
12932: =item $type
12933:
12934: =item $locktype
12935:
12936: =item $cid
12937:
12938: =item $selfenroll
12939:
12940: =item $context
12941:
12942: =item $credits, number of credits student will earn from this class
12943:
12944: =back
12945:
12946:
12947: =item *
12948:
12949: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
12950: custom role; give a custom role to a user for the level given by URL. Specify
12951: name and domain of role author, and role name
12952:
12953: =item *
12954:
12955: revokerole($udom,$uname,$url,$role) : revoke a role for url
12956:
12957: =item *
12958:
12959: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
12960:
12961: =back
12962:
12963: =head2 Course Infomation
12964:
12965: =over 4
12966:
12967: =item *
12968:
12969: coursedescription($courseid,$options) : returns a hash of information about the
12970: specified course id, including all environment settings for the
12971: course, the description of the course will be in the hash under the
12972: key 'description'
12973:
12974: $options is an optional parameter that if supplied is a hash reference that controls
12975: what how this function works. It has the following key/values:
12976:
12977: =over 4
12978:
12979: =item freshen_cache
12980:
12981: If defined, and the environment cache for the course is valid, it is
12982: returned in the returned hash.
12983:
12984: =item one_time
12985:
12986: If defined, the last cache time is set to _now_
12987:
12988: =item user
12989:
12990: If defined, the supplied username is used instead of the current user.
12991:
12992:
12993: =back
12994:
12995: =item *
12996:
12997: resdata($name,$domain,$type,@which) : request for current parameter
12998: setting for a specific $type, where $type is either 'course' or 'user',
12999: @what should be a list of parameters to ask about. This routine caches
13000: answers for 10 minutes.
13001:
13002: =item *
13003:
13004: get_courseresdata($courseid, $domain) : dump the entire course resource
13005: data base, returning a hash that is keyed by the resource name and has
13006: values that are the resource value. I believe that the timestamps and
13007: versions are also returned.
13008:
13009: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13010: supplemental content area. This routine caches the number of files for
13011: 10 minutes.
13012:
13013: =back
13014:
13015: =head2 Course Modification
13016:
13017: =over 4
13018:
13019: =item *
13020:
13021: writecoursepref($courseid,%prefs) : write preferences (environment
13022: database) for a course
13023:
13024: =item *
13025:
13026: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13027:
13028: =item *
13029:
13030: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
13031:
13032: =item *
13033:
13034: is_course($courseid), is_course($cdom, $cnum)
13035:
13036: Accepts either a combined $courseid (in the form of domain_courseid) or the
13037: two component version $cdom, $cnum. It checks if the specified course exists.
13038:
13039: Returns:
13040: undef if the course doesn't exist, otherwise
13041: in scalar context the combined courseid.
13042: in list context the two components of the course identifier, domain and
13043: courseid.
13044:
13045: =back
13046:
13047: =head2 Resource Subroutines
13048:
13049: =over 4
13050:
13051: =item *
13052:
13053: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
13054:
13055: =item *
13056:
13057: repcopy($filename) : subscribes to the requested file, and attempts to
13058: replicate from the owning library server, Might return
13059: 'unavailable', 'not_found', 'forbidden', 'ok', or
13060: 'bad_request', also attempts to grab the metadata for the
13061: resource. Expects the local filesystem pathname
13062: (/home/httpd/html/res/....)
13063:
13064: =back
13065:
13066: =head2 Resource Information
13067:
13068: =over 4
13069:
13070: =item *
13071:
13072: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13073: and returns the value of a variety of different possible values,
13074: $varname should be a request string, and the other parameters can be
13075: used to specify who and what one is asking about. Ordinarily, $cid
13076: does not need to be specified, as it is retrived from
13077: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13078: within lonuserstate::loadmap() when initializing a course, before
13079: $env{'request.course.id'} has been set, so it needs to be provided
13080: in that one case.
13081:
13082: Possible values for $varname are environment.lastname (or other item
13083: from the envirnment hash), user.name (or someother aspect about the
13084: user), resource.0.maxtries (or some other part and parameter of a
13085: resource)
13086:
13087: =item *
13088:
13089: directcondval($number) : get current value of a condition; reads from a state
13090: string
13091:
13092: =item *
13093:
13094: condval($condidx) : value of condition index based on state
13095:
13096: =item *
13097:
13098: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13099: resource's metadata, $what should be either a specific key, or either
13100: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13101: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13102:
13103: this function automatically caches all requests
13104:
13105: =item *
13106:
13107: metadata_query($query,$custom,$customshow) : make a metadata query against the
13108: network of library servers; returns file handle of where SQL and regex results
13109: will be stored for query
13110:
13111: =item *
13112:
13113: symbread($filename) : return symbolic list entry (filename argument optional);
13114: returns the data handle
13115:
13116: =item *
13117:
13118: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
13119: and is a possible symb for the URL in $thisfn, and if is an encrypted
13120: resource that the user accessed using /enc/ returns a 1 on success, 0
13121: on failure, user must be in a course, as it assumes the existence of
13122: the course initial hash, and uses $env('request.course.id'}. The third
13123: arg is an optional reference to a scalar. If this arg is passed in the
13124: call to symbverify, it will be set to 1 if the symb has been set to be
13125: encrypted; otherwise it will be null.
13126:
13127: =item *
13128:
13129: symbclean($symb) : removes versions numbers from a symb, returns the
13130: cleaned symb
13131:
13132: =item *
13133:
13134: is_on_map($uri) : checks if the $uri is somewhere on the current
13135: course map, user must be in a course for it to work.
13136:
13137: =item *
13138:
13139: numval($salt) : return random seed value (addend for rndseed)
13140:
13141: =item *
13142:
13143: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13144: a random seed, all arguments are optional, if they aren't sent it uses the
13145: environment to derive them. Note: if symb isn't sent and it can't get one
13146: from &symbread it will use the current time as its return value
13147:
13148: =item *
13149:
13150: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13151: unfakeable, receipt
13152:
13153: =item *
13154:
13155: receipt() : API to ireceipt working off of env values; given out to users
13156:
13157: =item *
13158:
13159: countacc($url) : count the number of accesses to a given URL
13160:
13161: =item *
13162:
13163: 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
13164:
13165: =item *
13166:
13167: 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)
13168:
13169: =item *
13170:
13171: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
13172:
13173: =item *
13174:
13175: devalidate($symb) : devalidate temporary spreadsheet calculations,
13176: forcing spreadsheet to reevaluate the resource scores next time.
13177:
13178: =item *
13179:
13180: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
13181: when viewing in course context.
13182:
13183: input: six args -- filename (decluttered), course number, course domain,
13184: url, symb (if registered) and group (if this is a
13185: group item -- e.g., bulletin board, group page etc.).
13186:
13187: output: array of five scalars --
13188: $cfile -- url for file editing if editable on current server
13189: $home -- homeserver of resource (i.e., for author if published,
13190: or course if uploaded.).
13191: $switchserver -- 1 if server switch will be needed.
13192: $forceedit -- 1 if icon/link should be to go to edit mode
13193: $forceview -- 1 if icon/link should be to go to view mode
13194:
13195: =item *
13196:
13197: is_course_upload($file,$cnum,$cdom)
13198:
13199: Used in course context to determine if current file was uploaded to
13200: the course (i.e., would be found in /userfiles/docs on the course's
13201: homeserver.
13202:
13203: input: 3 args -- filename (decluttered), course number and course domain.
13204: output: boolean -- 1 if file was uploaded.
13205:
13206: =back
13207:
13208: =head2 Storing/Retreiving Data
13209:
13210: =over 4
13211:
13212: =item *
13213:
13214: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
13215: for this url; hashref needs to be given and should be a \%hashname; the
13216: remaining args aren't required and if they aren't passed or are '' they will
13217: be derived from the env
13218:
13219: =item *
13220:
13221: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
13222: uses critical subroutine
13223:
13224: =item *
13225:
13226: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
13227: all args are optional
13228:
13229: =item *
13230:
13231: dumpstore($namespace,$udom,$uname,$regexp,$range) :
13232: dumps the complete (or key matching regexp) namespace into a hash
13233: ($udom, $uname, $regexp, $range are optional) for a namespace that is
13234: normally &store()ed into
13235:
13236: $range should be either an integer '100' (give me the first 100
13237: matching records)
13238: or be two integers sperated by a - with no spaces
13239: '30-50' (give me the 30th through the 50th matching
13240: records)
13241:
13242:
13243: =item *
13244:
13245: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
13246: replaces a &store() version of data with a replacement set of data
13247: for a particular resource in a namespace passed in the $storehash hash
13248: reference
13249:
13250: =item *
13251:
13252: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
13253: works very similar to store/cstore, but all data is stored in a
13254: temporary location and can be reset using tmpreset, $storehash should
13255: be a hash reference, returns nothing on success
13256:
13257: =item *
13258:
13259: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
13260: similar to restore, but all data is stored in a temporary location and
13261: can be reset using tmpreset. Returns a hash of values on success,
13262: error string otherwise.
13263:
13264: =item *
13265:
13266: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
13267: deltes all keys for $symb form the temporary storage hash.
13268:
13269: =item *
13270:
13271: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13272: reference filled in from namesp ($udom and $uname are optional)
13273:
13274: =item *
13275:
13276: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
13277: namesp ($udom and $uname are optional)
13278:
13279: =item *
13280:
13281: dump($namespace,$udom,$uname,$regexp,$range) :
13282: dumps the complete (or key matching regexp) namespace into a hash
13283: ($udom, $uname, $regexp, $range are optional)
13284:
13285: $range should be either an integer '100' (give me the first 100
13286: matching records)
13287: or be two integers sperated by a - with no spaces
13288: '30-50' (give me the 30th through the 50th matching
13289: records)
13290: =item *
13291:
13292: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
13293: $store can be a scalar, an array reference, or if the amount to be
13294: incremented is > 1, a hash reference.
13295:
13296: ($udom and $uname are optional)
13297:
13298: =item *
13299:
13300: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
13301: ($udom and $uname are optional)
13302:
13303: =item *
13304:
13305: cput($namespace,$storehash,$udom,$uname) : critical put
13306: ($udom and $uname are optional)
13307:
13308: =item *
13309:
13310: newput($namespace,$storehash,$udom,$uname) :
13311:
13312: Attempts to store the items in the $storehash, but only if they don't
13313: currently exist, if this succeeds you can be certain that you have
13314: successfully created a new key value pair in the $namespace db.
13315:
13316:
13317: Args:
13318: $namespace: name of database to store values to
13319: $storehash: hashref to store to the db
13320: $udom: (optional) domain of user containing the db
13321: $uname: (optional) name of user caontaining the db
13322:
13323: Returns:
13324: 'ok' -> succeeded in storing all keys of $storehash
13325: 'key_exists: <key>' -> failed to anything out of $storehash, as at
13326: least <key> already existed in the db (other
13327: requested keys may also already exist)
13328: 'error: <msg>' -> unable to tie the DB or other error occurred
13329: 'con_lost' -> unable to contact request server
13330: 'refused' -> action was not allowed by remote machine
13331:
13332:
13333: =item *
13334:
13335: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13336: reference filled in from namesp (encrypts the return communication)
13337: ($udom and $uname are optional)
13338:
13339: =item *
13340:
13341: log($udom,$name,$home,$message) : write to permanent log for user; use
13342: critical subroutine
13343:
13344: =item *
13345:
13346: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
13347: array reference filled in from namespace found in domain level on either
13348: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
13349:
13350: =item *
13351:
13352: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
13353: domain level either on specified domain server ($uhome) or primary domain
13354: server ($udom and $uhome are optional)
13355:
13356: =item *
13357:
13358: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
13359: for: authentication, language, quotas, timezone, date locale, and portal URL in
13360: the target domain.
13361:
13362: May also include additional key => value pairs for the following groups:
13363:
13364: =over
13365:
13366: =item
13367: disk quotas (MB allocated by default to portfolios and authoring spaces).
13368:
13369: =over
13370:
13371: =item defaultquota, authorquota
13372:
13373: =back
13374:
13375: =item
13376: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
13377: portfolio for users).
13378:
13379: =over
13380:
13381: =item
13382: aboutme, blog, webdav, portfolio
13383:
13384: =back
13385:
13386: =item
13387: requestcourses: ability to request courses, and how requests are processed.
13388:
13389: =over
13390:
13391: =item
13392: official, unofficial, community, textbook
13393:
13394: =back
13395:
13396: =item
13397: inststatus: types of institutional affiliation, and order in which they are displayed.
13398:
13399: =over
13400:
13401: =item
13402: inststatustypes, inststatusorder, inststatusguest
13403:
13404: =back
13405:
13406: =item
13407: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
13408: for course's uploaded content.
13409:
13410: =over
13411:
13412: =item
13413: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
13414: communityquota, textbookquota
13415:
13416: =back
13417:
13418: =item
13419: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
13420: on your servers.
13421:
13422: =over
13423:
13424: =item
13425: remotesessions, hostedsessions
13426:
13427: =back
13428:
13429: =back
13430:
13431: In cases where a domain coordinator has never used the "Set Domain Configuration"
13432: utility to create a configuration.db file on a domain's primary library server
13433: only the following domain defaults: auth_def, auth_arg_def, lang_def
13434: -- corresponding values are authentication type (internal, krb4, krb5,
13435: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
13436: will be available. Values are retrieved from cache (if current), unless the
13437: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
13438: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
13439:
13440: Typical usage:
13441:
13442: %domdefaults = &get_domain_defaults($target_domain);
13443:
13444: =back
13445:
13446: =head2 Network Status Functions
13447:
13448: =over 4
13449:
13450: =item *
13451:
13452: dirlist() : return directory list based on URI (first arg).
13453:
13454: Inputs: 1 required, 5 optional.
13455:
13456: =over
13457:
13458: =item
13459: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
13460:
13461: =item
13462: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
13463:
13464: =item
13465: $username - username of user/course to be listed. Extracted from $uri if absent.
13466:
13467: =item
13468: $getpropath - boolean: 1 if prepend path using &propath().
13469:
13470: =item
13471: $getuserdir - boolean: 1 if prepend path for "userfiles".
13472:
13473: =item
13474: $alternateRoot - path to prepend in place of path from $uri.
13475:
13476: =back
13477:
13478: Returns: Array of up to two items.
13479:
13480: =over
13481:
13482: a reference to an array of files/subdirectories
13483:
13484: =over
13485:
13486: Each element in the array of files/subdirectories is a & separated list of
13487: item name and the result of running stat on the item. If dirlist was requested
13488: for a file instead of a directory, the item name will be ''. For a directory
13489: listing, if the item is a metadata file, the element will end &N&M
13490: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
13491: default copyright set (1).
13492:
13493: =back
13494:
13495: a scalar containing error condition (if encountered).
13496:
13497: =over
13498:
13499: =item
13500: no_host (no homeserver identified for $username:$domain).
13501:
13502: =item
13503: no_such_host (server contacted for listing not identified as valid host).
13504:
13505: =item
13506: con_lost (connection to remote server failed).
13507:
13508: =item
13509: refused (invalid $username:$domain received on lond side).
13510:
13511: =item
13512: no_such_dir (directory at specified path on lond side does not exist).
13513:
13514: =item
13515: empty (directory at specified path on lond side is empty).
13516:
13517: =over
13518:
13519: This is currently not encountered because the &ls3, &ls2,
13520: &ls (_handler) routines on the lond side do not filter out
13521: . and .. from a directory listing.
13522:
13523: =back
13524:
13525: =back
13526:
13527: =back
13528:
13529: =item *
13530:
13531: spareserver() : find server with least workload from spare.tab
13532:
13533:
13534: =item *
13535:
13536: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
13537: if there is no corresponding loncapa host.
13538:
13539: =back
13540:
13541:
13542: =head2 Apache Request
13543:
13544: =over 4
13545:
13546: =item *
13547:
13548: ssi($url,%hash) : server side include, does a complete request cycle on url to
13549: localhost, posts hash
13550:
13551: =back
13552:
13553: =head2 Data to String to Data
13554:
13555: =over 4
13556:
13557: =item *
13558:
13559: hash2str(%hash) : convert a hash into a string complete with escaping and '='
13560: and '&' separators, supports elements that are arrayrefs and hashrefs
13561:
13562: =item *
13563:
13564: hashref2str($hashref) : convert a hashref into a string complete with
13565: escaping and '=' and '&' separators, supports elements that are
13566: arrayrefs and hashrefs
13567:
13568: =item *
13569:
13570: arrayref2str($arrayref) : convert an arrayref into a string complete
13571: with escaping and '&' separators, supports elements that are arrayrefs
13572: and hashrefs
13573:
13574: =item *
13575:
13576: str2hash($string) : convert string to hash using unescaping and
13577: splitting on '=' and '&', supports elements that are arrayrefs and
13578: hashrefs
13579:
13580: =item *
13581:
13582: str2array($string) : convert string to hash using unescaping and
13583: splitting on '&', supports elements that are arrayrefs and hashrefs
13584:
13585: =back
13586:
13587: =head2 Logging Routines
13588:
13589:
13590: These routines allow one to make log messages in the lonnet.log and
13591: lonnet.perm logfiles.
13592:
13593: =over 4
13594:
13595: =item *
13596:
13597: logtouch() : make sure the logfile, lonnet.log, exists
13598:
13599: =item *
13600:
13601: logthis() : append message to the normal lonnet.log file, it gets
13602: preiodically rolled over and deleted.
13603:
13604: =item *
13605:
13606: logperm() : append a permanent message to lonnet.perm.log, this log
13607: file never gets deleted by any automated portion of the system, only
13608: messages of critical importance should go in here.
13609:
13610:
13611: =back
13612:
13613: =head2 General File Helper Routines
13614:
13615: =over 4
13616:
13617: =item *
13618:
13619: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
13620: (a) files in /uploaded
13621: (i) If a local copy of the file exists -
13622: compares modification date of local copy with last-modified date for
13623: definitive version stored on home server for course. If local copy is
13624: stale, requests a new version from the home server and stores it.
13625: If the original has been removed from the home server, then local copy
13626: is unlinked.
13627: (ii) If local copy does not exist -
13628: requests the file from the home server and stores it.
13629:
13630: If $caller is 'uploadrep':
13631: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
13632: for request for files originally uploaded via DOCS.
13633: - returns 'ok' if fresh local copy now available, -1 otherwise.
13634:
13635: Otherwise:
13636: This indicates a call from the content generation phase of the request.
13637: - returns the entire contents of the file or -1.
13638:
13639: (b) files in /res
13640: - returns the entire contents of a file or -1;
13641: it properly subscribes to and replicates the file if neccessary.
13642:
13643:
13644: =item *
13645:
13646: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
13647: reference
13648:
13649: returns either a stat() list of data about the file or an empty list
13650: if the file doesn't exist or couldn't find out about it (connection
13651: problems or user unknown)
13652:
13653: =item *
13654:
13655: filelocation($dir,$file) : returns file system location of a file
13656: based on URI; meant to be "fairly clean" absolute reference, $dir is a
13657: directory that relative $file lookups are to looked in ($dir of /a/dir
13658: and a file of ../bob will become /a/bob)
13659:
13660: =item *
13661:
13662: hreflocation($dir,$file) : returns file system location or a URL; same as
13663: filelocation except for hrefs
13664:
13665: =item *
13666:
13667: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
13668: also removes beginning /home/httpd/html unless /priv/ follows it.
13669:
13670: =back
13671:
13672: =head2 Usererfile file routines (/uploaded*)
13673:
13674: =over 4
13675:
13676: =item *
13677:
13678: userfileupload(): main rotine for putting a file in a user or course's
13679: filespace, arguments are,
13680:
13681: formname - required - this is the name of the element in $env where the
13682: filename, and the contents of the file to create/modifed exist
13683: the filename is in $env{'form.'.$formname.'.filename'} and the
13684: contents of the file is located in $env{'form.'.$formname}
13685: context - if coursedoc, store the file in the course of the active role
13686: of the current user;
13687: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
13688: if 'canceloverwrite': delete file in tmp/overwrites directory
13689: subdir - required - subdirectory to put the file in under ../userfiles/
13690: if undefined, it will be placed in "unknown"
13691:
13692: (This routine calls clean_filename() to remove any dangerous
13693: characters from the filename, and then calls finuserfileupload() to
13694: complete the transaction)
13695:
13696: returns either the url of the uploaded file (/uploaded/....) if successful
13697: and /adm/notfound.html if unsuccessful
13698:
13699: =item *
13700:
13701: clean_filename(): routine for cleaing a filename up for storage in
13702: userfile space, argument is:
13703:
13704: filename - proposed filename
13705:
13706: returns: the new clean filename
13707:
13708: =item *
13709:
13710: finishuserfileupload(): routine that creates and sends the file to
13711: userspace, probably shouldn't be called directly
13712:
13713: docuname: username or courseid of destination for the file
13714: docudom: domain of user/course of destination for the file
13715: formname: same as for userfileupload()
13716: fname: filename (including subdirectories) for the file
13717: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
13718: allfiles: reference to hash used to store objects found by parser
13719: codebase: reference to hash used for codebases of java objects found by parser
13720: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
13721: thumbheight: height (pixels) of thumbnail to be created for uploaded image
13722: resizewidth: width to be used to resize image using resizeImage from ImageMagick
13723: resizeheight: height to be used to resize image using resizeImage from ImageMagick
13724: context: if 'overwrite', will move the uploaded file from its temporary location to
13725: userfiles to facilitate overwriting a previously uploaded file with same name.
13726: mimetype: reference to scalar to accommodate mime type determined
13727: from File::MMagic if $parser = parse.
13728:
13729: returns either the url of the uploaded file (/uploaded/....) if successful
13730: and /adm/notfound.html if unsuccessful (or an error message if context
13731: was 'overwrite').
13732:
13733:
13734: =item *
13735:
13736: renameuserfile(): renames an existing userfile to a new name
13737:
13738: Args:
13739: docuname: username or courseid of destination for the file
13740: docudom: domain of user/course of destination for the file
13741: old: current file name (including any subdirs under userfiles)
13742: new: desired file name (including any subdirs under userfiles)
13743:
13744: =item *
13745:
13746: mkdiruserfile(): creates a directory is a userfiles dir
13747:
13748: Args:
13749: docuname: username or courseid of destination for the file
13750: docudom: domain of user/course of destination for the file
13751: dir: dir to create (including any subdirs under userfiles)
13752:
13753: =item *
13754:
13755: removeuserfile(): removes a file that exists in userfiles
13756:
13757: Args:
13758: docuname: username or courseid of destination for the file
13759: docudom: domain of user/course of destination for the file
13760: fname: filname to delete (including any subdirs under userfiles)
13761:
13762: =item *
13763:
13764: removeuploadedurl(): convience function for removeuserfile()
13765:
13766: Args:
13767: url: a full /uploaded/... url to delete
13768:
13769: =item *
13770:
13771: get_portfile_permissions():
13772: Args:
13773: domain: domain of user or course contain the portfolio files
13774: user: name of user or num of course contain the portfolio files
13775: Returns:
13776: hashref of a dump of the proper file_permissions.db
13777:
13778:
13779: =item *
13780:
13781: get_access_controls():
13782:
13783: Args:
13784: current_permissions: the hash ref returned from get_portfile_permissions()
13785: group: (optional) the group you want the files associated with
13786: file: (optional) the file you want access info on
13787:
13788: Returns:
13789: a hash (keys are file names) of hashes containing
13790: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
13791: values are XML containing access control settings (see below)
13792:
13793: Internal notes:
13794:
13795: access controls are stored in file_permissions.db as key=value pairs.
13796: key -> path to file/file_name\0uniqueID:scope_end_start
13797: where scope -> public,guest,course,group,domains or users.
13798: end -> UNIX time for end of access (0 -> no end date)
13799: start -> UNIX time for start of access
13800:
13801: value -> XML description of access control
13802: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
13803: <start></start>
13804: <end></end>
13805:
13806: <password></password> for scope type = guest
13807:
13808: <domain></domain> for scope type = course or group
13809: <number></number>
13810: <roles id="">
13811: <role></role>
13812: <access></access>
13813: <section></section>
13814: <group></group>
13815: </roles>
13816:
13817: <dom></dom> for scope type = domains
13818:
13819: <users> for scope type = users
13820: <user>
13821: <uname></uname>
13822: <udom></udom>
13823: </user>
13824: </users>
13825: </scope>
13826:
13827: Access data is also aggregated for each file in an additional key=value pair:
13828: key -> path to file/file_name\0accesscontrol
13829: value -> reference to hash
13830: hash contains key = value pairs
13831: where key = uniqueID:scope_end_start
13832: value = UNIX time record was last updated
13833:
13834: Used to improve speed of look-ups of access controls for each file.
13835:
13836: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
13837:
13838: =item *
13839:
13840: modify_access_controls():
13841:
13842: Modifies access controls for a portfolio file
13843: Args
13844: 1. file name
13845: 2. reference to hash of required changes,
13846: 3. domain
13847: 4. username
13848: where domain,username are the domain of the portfolio owner
13849: (either a user or a course)
13850:
13851: Returns:
13852: 1. result of additions or updates ('ok' or 'error', with error message).
13853: 2. result of deletions ('ok' or 'error', with error message).
13854: 3. reference to hash of any new or updated access controls.
13855: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
13856: key = integer (inbound ID)
13857: value = uniqueID
13858:
13859: =item *
13860:
13861: get_timebased_id():
13862:
13863: Attempts to get a unique timestamp-based suffix for use with items added to a
13864: course via the Course Editor (e.g., folders, composite pages,
13865: group bulletin boards).
13866:
13867: Args: (first three required; six others optional)
13868:
13869: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
13870: docssequence, or name of group
13871:
13872: 2. keyid (alphanumeric): name of temporary locking key in hash,
13873: e.g., num, boardids
13874:
13875: 3. namespace: name of gdbm file used to store suffixes already assigned;
13876: file will be named nohist_namespace.db
13877:
13878: 4. cdom: domain of course; default is current course domain from %env
13879:
13880: 5. cnum: course number; default is current course number from %env
13881:
13882: 6. idtype: set to concat if an additional digit is to be appended to the
13883: unix timestamp to form the suffix, if the plain timestamp is already
13884: in use. Default is to not do this, but simply increment the unix
13885: timestamp by 1 until a unique key is obtained.
13886:
13887: 7. who: holder of locking key; defaults to user:domain for user.
13888:
13889: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
13890: retrying); default is 3.
13891:
13892: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
13893:
13894: Returns:
13895:
13896: 1. suffix obtained (numeric)
13897:
13898: 2. result of deleting locking key (ok if deleted, or lock never obtained)
13899:
13900: 3. error: contains (localized) error message if an error occurred.
13901:
13902:
13903: =back
13904:
13905: =head2 HTTP Helper Routines
13906:
13907: =over 4
13908:
13909: =item *
13910:
13911: escape() : unpack non-word characters into CGI-compatible hex codes
13912:
13913: =item *
13914:
13915: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
13916:
13917: =back
13918:
13919: =head1 PRIVATE SUBROUTINES
13920:
13921: =head2 Underlying communication routines (Shouldn't call)
13922:
13923: =over 4
13924:
13925: =item *
13926:
13927: subreply() : tries to pass a message to lonc, returns con_lost if incapable
13928:
13929: =item *
13930:
13931: reply() : uses subreply to send a message to remote machine, logs all failures
13932:
13933: =item *
13934:
13935: critical() : passes a critical message to another server; if cannot
13936: get through then place message in connection buffer directory and
13937: returns con_delayed, if incapable of saving message, returns
13938: con_failed
13939:
13940: =item *
13941:
13942: reconlonc() : tries to reconnect lonc client processes.
13943:
13944: =back
13945:
13946: =head2 Resource Access Logging
13947:
13948: =over 4
13949:
13950: =item *
13951:
13952: flushcourselogs() : flush (save) buffer logs and access logs
13953:
13954: =item *
13955:
13956: courselog($what) : save message for course in hash
13957:
13958: =item *
13959:
13960: courseacclog($what) : save message for course using &courselog(). Perform
13961: special processing for specific resource types (problems, exams, quizzes, etc).
13962:
13963: =item *
13964:
13965: goodbye() : flush course logs and log shutting down; it is called in srm.conf
13966: as a PerlChildExitHandler
13967:
13968: =back
13969:
13970: =head2 Other
13971:
13972: =over 4
13973:
13974: =item *
13975:
13976: symblist($mapname,%newhash) : update symbolic storage links
13977:
13978: =back
13979:
13980: =cut
13981:
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