File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.1074:
download - view:
text,
annotated -
select for diffs
Tue Jul 20 02:42:47 2010 UTC (14 years ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Control hosting of user sessions.
- To accommodate multi-domain library servers, use internet domain names (e.g., msu.edu)
instead of LON-CAPA domains in interface DC uses to set options for session hosting.
- Provide mechanism to retrieve lonHostID for a hostname, so we can tell which
domain determines session hosting config for external users on a multi-domain
machine.
- New routines in lonnet.pm:
&get_server_homeID() -- gets lonHostID for a hostname
&internet_dom() -- gets internet domain name for a LON-CAPA Host ID
&get_internet_names() -- gets internet domain names for all domains
for a server given one of the LC host IDs for the server.
- New file in /home/httpd/lonTabs:
- serverhomeIDs.tab (populated by loncron). : paired hostname:lonHostID
- New subroutine in loncron: &write_serverhomeIDs() -- populates serverhomeIDs.tab
- New subroutine in lond: &server_homeID_handler() -- returns LON-CAPA Host ID of server
- New scalar in lond: $clienthomedom -- set to domain of LON-CAPA Host ID of client
- New subroutine in domainprefs.pm: &build_location_hashes()
-- used to set up options for session hosting as internet domain names
- where two names (e.g., msu.edu, loncapa.org) are controlled by the same
institution these will receive a single checkbox.
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1074 2010/07/20 02:42:47 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol %loncaparevs %serverhomeIDs);
80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
84: %courseownerbuf, %coursetypebuf,$locknum);
85:
86: use IO::Socket;
87: use GDBM_File;
88: use HTML::LCParser;
89: use Fcntl qw(:flock);
90: use Storable qw(thaw nfreeze);
91: use Time::HiRes qw( gettimeofday tv_interval );
92: use Cache::Memcached;
93: use Digest::MD5;
94: use Math::Random;
95: use File::MMagic;
96: use LONCAPA qw(:DEFAULT :match);
97: use LONCAPA::Configuration;
98:
99: my $readit;
100: my $max_connection_retries = 10; # Or some such value.
101:
102: require Exporter;
103:
104: our @ISA = qw (Exporter);
105: our @EXPORT = qw(%env);
106:
107:
108: # --------------------------------------------------------------------- Logging
109: {
110: my $logid;
111: sub instructor_log {
112: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
113: if (($cnum eq '') || ($cdom eq '')) {
114: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
115: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
116: }
117: $logid++;
118: my $now = time();
119: my $id=$now.'00000'.$$.'00000'.$logid;
120: return &Apache::lonnet::put('nohist_'.$hash_name,
121: { $id => {
122: 'exe_uname' => $env{'user.name'},
123: 'exe_udom' => $env{'user.domain'},
124: 'exe_time' => $now,
125: 'exe_ip' => $ENV{'REMOTE_ADDR'},
126: 'delflag' => $delflag,
127: 'logentry' => $storehash,
128: 'uname' => $uname,
129: 'udom' => $udom,
130: }
131: },$cdom,$cnum);
132: }
133: }
134:
135: sub logtouch {
136: my $execdir=$perlvar{'lonDaemons'};
137: unless (-e "$execdir/logs/lonnet.log") {
138: open(my $fh,">>$execdir/logs/lonnet.log");
139: close $fh;
140: }
141: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
142: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
143: }
144:
145: sub logthis {
146: my $message=shift;
147: my $execdir=$perlvar{'lonDaemons'};
148: my $now=time;
149: my $local=localtime($now);
150: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
151: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
152: print $fh $logstring;
153: close($fh);
154: }
155: return 1;
156: }
157:
158: sub logperm {
159: my $message=shift;
160: my $execdir=$perlvar{'lonDaemons'};
161: my $now=time;
162: my $local=localtime($now);
163: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
164: print $fh "$now:$message:$local\n";
165: close($fh);
166: }
167: return 1;
168: }
169:
170: sub create_connection {
171: my ($hostname,$lonid) = @_;
172: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
173: Type => SOCK_STREAM,
174: Timeout => 10);
175: return 0 if (!$client);
176: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
177: my $result = <$client>;
178: chomp($result);
179: return 1 if ($result eq 'done');
180: return 0;
181: }
182:
183: sub get_server_timezone {
184: my ($cnum,$cdom) = @_;
185: my $home=&homeserver($cnum,$cdom);
186: if ($home ne 'no_host') {
187: my $cachetime = 24*3600;
188: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
189: if (defined($cached)) {
190: return $timezone;
191: } else {
192: my $timezone = &reply('servertimezone',$home);
193: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
194: }
195: }
196: }
197:
198: sub get_server_loncaparev {
199: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
200: if (defined($lonhost)) {
201: if (!defined(&hostname($lonhost))) {
202: undef($lonhost);
203: }
204: }
205: if (!defined($lonhost)) {
206: if (defined(&domain($dom,'primary'))) {
207: $lonhost=&domain($dom,'primary');
208: if ($lonhost eq 'no_host') {
209: undef($lonhost);
210: }
211: }
212: }
213: if (defined($lonhost)) {
214: my $cachetime = 12*3600;
215: if (!$ignore_cache) {
216: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
217: if (defined($cached)) {
218: return $loncaparev;
219: }
220: }
221: my ($answer,$loncaparev);
222: my @ids=¤t_machine_ids();
223: if (grep(/^\Q$lonhost\E$/,@ids)) {
224: $answer = $perlvar{'lonVersion'};
225: if ($answer =~ /^[\'\"]?([\d.\-]+)[\'\"]?$/) {
226: $loncaparev = $1;
227: }
228: } else {
229: $answer = &reply('serverloncaparev',$lonhost);
230: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
231: if ($caller eq 'loncron') {
232: my $ua=new LWP::UserAgent;
233: $ua->timeout(20);
234: my $protocol = $protocol{$lonhost};
235: $protocol = 'http' if ($protocol ne 'https');
236: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
237: my $request=new HTTP::Request('GET',$url);
238: my $response=$ua->request($request);
239: unless ($response->is_error()) {
240: my $content = $response->content;
241: if ($content =~ /<p>VERSION\:\s*([\d.\-]+)<\/p>/) {
242: $loncaparev = $1;
243: }
244: }
245: } else {
246: $loncaparev = $loncaparevs{$lonhost};
247: }
248: } elsif ($answer =~ /^[\'\"]?([\d.\-]+)[\'\"]?$/) {
249: $loncaparev = $1;
250: }
251: }
252: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
253: }
254: }
255:
256: sub get_server_homeID {
257: my ($hostname,$ignore_cache,$caller) = @_;
258: unless ($ignore_cache) {
259: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
260: if (defined($cached)) {
261: return $serverhomeID;
262: }
263: }
264: my $cachetime = 12*3600;
265: my $serverhomeID;
266: if ($caller eq 'loncron') {
267: my @machine_ids = &machine_ids($hostname);
268: foreach my $id (@machine_ids) {
269: my $response = &reply('serverhomeID',$id);
270: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
271: $serverhomeID = $response;
272: last;
273: }
274: }
275: if ($serverhomeID eq '') {
276: $serverhomeID = $machine_ids[-1];
277: }
278: } else {
279: $serverhomeID = $serverhomeIDs{$hostname};
280: }
281: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
282: }
283:
284: # -------------------------------------------------- Non-critical communication
285: sub subreply {
286: my ($cmd,$server)=@_;
287: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
288: #
289: # With loncnew process trimming, there's a timing hole between lonc server
290: # process exit and the master server picking up the listen on the AF_UNIX
291: # socket. In that time interval, a lock file will exist:
292:
293: my $lockfile=$peerfile.".lock";
294: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
295: sleep(1);
296: }
297: # At this point, either a loncnew parent is listening or an old lonc
298: # or loncnew child is listening so we can connect or everything's dead.
299: #
300: # We'll give the connection a few tries before abandoning it. If
301: # connection is not possible, we'll con_lost back to the client.
302: #
303: my $client;
304: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
305: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
306: Type => SOCK_STREAM,
307: Timeout => 10);
308: if ($client) {
309: last; # Connected!
310: } else {
311: &create_connection(&hostname($server),$server);
312: }
313: sleep(1); # Try again later if failed connection.
314: }
315: my $answer;
316: if ($client) {
317: print $client "sethost:$server:$cmd\n";
318: $answer=<$client>;
319: if (!$answer) { $answer="con_lost"; }
320: chomp($answer);
321: } else {
322: $answer = 'con_lost'; # Failed connection.
323: }
324: return $answer;
325: }
326:
327: sub reply {
328: my ($cmd,$server)=@_;
329: unless (defined(&hostname($server))) { return 'no_such_host'; }
330: my $answer=subreply($cmd,$server);
331: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
332: &logthis("<font color=\"blue\">WARNING:".
333: " $cmd to $server returned $answer</font>");
334: }
335: return $answer;
336: }
337:
338: # ----------------------------------------------------------- Send USR1 to lonc
339:
340: sub reconlonc {
341: my ($lonid) = @_;
342: my $hostname = &hostname($lonid);
343: if ($lonid) {
344: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
345: if ($hostname && -e $peerfile) {
346: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
347: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
348: Type => SOCK_STREAM,
349: Timeout => 10);
350: if ($client) {
351: print $client ("reset_retries\n");
352: my $answer=<$client>;
353: #reset just this one.
354: }
355: }
356: return;
357: }
358:
359: &logthis("Trying to reconnect lonc");
360: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
361: if (open(my $fh,"<$loncfile")) {
362: my $loncpid=<$fh>;
363: chomp($loncpid);
364: if (kill 0 => $loncpid) {
365: &logthis("lonc at pid $loncpid responding, sending USR1");
366: kill USR1 => $loncpid;
367: sleep 1;
368: } else {
369: &logthis(
370: "<font color=\"blue\">WARNING:".
371: " lonc at pid $loncpid not responding, giving up</font>");
372: }
373: } else {
374: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
375: }
376: }
377:
378: # ------------------------------------------------------ Critical communication
379:
380: sub critical {
381: my ($cmd,$server)=@_;
382: unless (&hostname($server)) {
383: &logthis("<font color=\"blue\">WARNING:".
384: " Critical message to unknown server ($server)</font>");
385: return 'no_such_host';
386: }
387: my $answer=reply($cmd,$server);
388: if ($answer eq 'con_lost') {
389: &reconlonc("$perlvar{'lonSockDir'}/$server");
390: my $answer=reply($cmd,$server);
391: if ($answer eq 'con_lost') {
392: my $now=time;
393: my $middlename=$cmd;
394: $middlename=substr($middlename,0,16);
395: $middlename=~s/\W//g;
396: my $dfilename=
397: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
398: $dumpcount++;
399: {
400: my $dfh;
401: if (open($dfh,">$dfilename")) {
402: print $dfh "$cmd\n";
403: close($dfh);
404: }
405: }
406: sleep 2;
407: my $wcmd='';
408: {
409: my $dfh;
410: if (open($dfh,"<$dfilename")) {
411: $wcmd=<$dfh>;
412: close($dfh);
413: }
414: }
415: chomp($wcmd);
416: if ($wcmd eq $cmd) {
417: &logthis("<font color=\"blue\">WARNING: ".
418: "Connection buffer $dfilename: $cmd</font>");
419: &logperm("D:$server:$cmd");
420: return 'con_delayed';
421: } else {
422: &logthis("<font color=\"red\">CRITICAL:"
423: ." Critical connection failed: $server $cmd</font>");
424: &logperm("F:$server:$cmd");
425: return 'con_failed';
426: }
427: }
428: }
429: return $answer;
430: }
431:
432: # ------------------------------------------- check if return value is an error
433:
434: sub error {
435: my ($result) = @_;
436: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
437: if ($2 == 2) { return undef; }
438: return $1;
439: }
440: return undef;
441: }
442:
443: sub convert_and_load_session_env {
444: my ($lonidsdir,$handle)=@_;
445: my @profile;
446: {
447: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
448: if (!$opened) {
449: return 0;
450: }
451: flock($idf,LOCK_SH);
452: @profile=<$idf>;
453: close($idf);
454: }
455: my %temp_env;
456: foreach my $line (@profile) {
457: if ($line !~ m/=/) {
458: return 0;
459: }
460: chomp($line);
461: my ($envname,$envvalue)=split(/=/,$line,2);
462: $temp_env{&unescape($envname)} = &unescape($envvalue);
463: }
464: unlink("$lonidsdir/$handle.id");
465: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
466: 0640)) {
467: %disk_env = %temp_env;
468: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
469: untie(%disk_env);
470: }
471: return 1;
472: }
473:
474: # ------------------------------------------- Transfer profile into environment
475: my $env_loaded;
476: sub transfer_profile_to_env {
477: my ($lonidsdir,$handle,$force_transfer) = @_;
478: if (!$force_transfer && $env_loaded) { return; }
479:
480: if (!defined($lonidsdir)) {
481: $lonidsdir = $perlvar{'lonIDsDir'};
482: }
483: if (!defined($handle)) {
484: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
485: }
486:
487: my $convert;
488: {
489: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
490: if (!$opened) {
491: return;
492: }
493: flock($idf,LOCK_SH);
494: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
495: &GDBM_READER(),0640)) {
496: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
497: untie(%disk_env);
498: } else {
499: $convert = 1;
500: }
501: }
502: if ($convert) {
503: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
504: &logthis("Failed to load session, or convert session.");
505: }
506: }
507:
508: my %remove;
509: while ( my $envname = each(%env) ) {
510: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
511: if ($time < time-300) {
512: $remove{$key}++;
513: }
514: }
515: }
516:
517: $env{'user.environment'} = "$lonidsdir/$handle.id";
518: $env_loaded=1;
519: foreach my $expired_key (keys(%remove)) {
520: &delenv($expired_key);
521: }
522: }
523:
524: # ---------------------------------------------------- Check for valid session
525: sub check_for_valid_session {
526: my ($r) = @_;
527: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
528: my $lonid=$cookies{'lonID'};
529: return undef if (!$lonid);
530:
531: my $handle=&LONCAPA::clean_handle($lonid->value);
532: my $lonidsdir=$r->dir_config('lonIDsDir');
533: return undef if (!-e "$lonidsdir/$handle.id");
534:
535: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
536: return undef if (!$opened);
537:
538: flock($idf,LOCK_SH);
539: my %disk_env;
540: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
541: &GDBM_READER(),0640)) {
542: return undef;
543: }
544:
545: if (!defined($disk_env{'user.name'})
546: || !defined($disk_env{'user.domain'})) {
547: return undef;
548: }
549: return $handle;
550: }
551:
552: sub timed_flock {
553: my ($file,$lock_type) = @_;
554: my $failed=0;
555: eval {
556: local $SIG{__DIE__}='DEFAULT';
557: local $SIG{ALRM}=sub {
558: $failed=1;
559: die("failed lock");
560: };
561: alarm(13);
562: flock($file,$lock_type);
563: alarm(0);
564: };
565: if ($failed) {
566: return undef;
567: } else {
568: return 1;
569: }
570: }
571:
572: # ---------------------------------------------------------- Append Environment
573:
574: sub appenv {
575: my ($newenv,$roles) = @_;
576: if (ref($newenv) eq 'HASH') {
577: foreach my $key (keys(%{$newenv})) {
578: my $refused = 0;
579: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
580: $refused = 1;
581: if (ref($roles) eq 'ARRAY') {
582: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
583: if (grep(/^\Q$role\E$/,@{$roles})) {
584: $refused = 0;
585: }
586: }
587: }
588: if ($refused) {
589: &logthis("<font color=\"blue\">WARNING: ".
590: "Attempt to modify environment ".$key." to ".$newenv->{$key}
591: .'</font>');
592: delete($newenv->{$key});
593: } else {
594: $env{$key}=$newenv->{$key};
595: }
596: }
597: my $opened = open(my $env_file,'+<',$env{'user.environment'});
598: if ($opened
599: && &timed_flock($env_file,LOCK_EX)
600: &&
601: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
602: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
603: while (my ($key,$value) = each(%{$newenv})) {
604: $disk_env{$key} = $value;
605: }
606: untie(%disk_env);
607: }
608: }
609: return 'ok';
610: }
611: # ----------------------------------------------------- Delete from Environment
612:
613: sub delenv {
614: my ($delthis,$regexp) = @_;
615: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
616: &logthis("<font color=\"blue\">WARNING: ".
617: "Attempt to delete from environment ".$delthis);
618: return 'error';
619: }
620: my $opened = open(my $env_file,'+<',$env{'user.environment'});
621: if ($opened
622: && &timed_flock($env_file,LOCK_EX)
623: &&
624: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
625: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
626: foreach my $key (keys(%disk_env)) {
627: if ($regexp) {
628: if ($key=~/^$delthis/) {
629: delete($env{$key});
630: delete($disk_env{$key});
631: }
632: } else {
633: if ($key=~/^\Q$delthis\E/) {
634: delete($env{$key});
635: delete($disk_env{$key});
636: }
637: }
638: }
639: untie(%disk_env);
640: }
641: return 'ok';
642: }
643:
644: sub get_env_multiple {
645: my ($name) = @_;
646: my @values;
647: if (defined($env{$name})) {
648: # exists is it an array
649: if (ref($env{$name})) {
650: @values=@{ $env{$name} };
651: } else {
652: $values[0]=$env{$name};
653: }
654: }
655: return(@values);
656: }
657:
658: # ------------------------------------------------------------------- Locking
659:
660: sub set_lock {
661: my ($text)=@_;
662: $locknum++;
663: my $id=$$.'-'.$locknum;
664: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
665: 'session.lock.'.$id => $text});
666: return $id;
667: }
668:
669: sub get_locks {
670: my $num=0;
671: my %texts=();
672: foreach my $lock (split(/\,/,$env{'session.locks'})) {
673: if ($lock=~/\w/) {
674: $num++;
675: $texts{$lock}=$env{'session.lock.'.$lock};
676: }
677: }
678: return ($num,%texts);
679: }
680:
681: sub remove_lock {
682: my ($id)=@_;
683: my $newlocks='';
684: foreach my $lock (split(/\,/,$env{'session.locks'})) {
685: if (($lock=~/\w/) && ($lock ne $id)) {
686: $newlocks.=','.$lock;
687: }
688: }
689: &appenv({'session.locks' => $newlocks});
690: &delenv('session.lock.'.$id);
691: }
692:
693: sub remove_all_locks {
694: my $activelocks=$env{'session.locks'};
695: foreach my $lock (split(/\,/,$env{'session.locks'})) {
696: if ($lock=~/\w/) {
697: &remove_lock($lock);
698: }
699: }
700: }
701:
702:
703: # ------------------------------------------ Find out current server userload
704: sub userload {
705: my $numusers=0;
706: {
707: opendir(LONIDS,$perlvar{'lonIDsDir'});
708: my $filename;
709: my $curtime=time;
710: while ($filename=readdir(LONIDS)) {
711: next if ($filename eq '.' || $filename eq '..');
712: next if ($filename =~ /publicuser_\d+\.id/);
713: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
714: if ($curtime-$mtime < 1800) { $numusers++; }
715: }
716: closedir(LONIDS);
717: }
718: my $userloadpercent=0;
719: my $maxuserload=$perlvar{'lonUserLoadLim'};
720: if ($maxuserload) {
721: $userloadpercent=100*$numusers/$maxuserload;
722: }
723: $userloadpercent=sprintf("%.2f",$userloadpercent);
724: return $userloadpercent;
725: }
726:
727: # ------------------------------ Find server with least workload from spare.tab
728:
729: sub spareserver {
730: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
731: my $spare_server;
732: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
733: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
734: : $userloadpercent;
735:
736: foreach my $try_server (@{ $spareid{'primary'} }) {
737: ($spare_server, $lowest_load) =
738: &compare_server_load($try_server, $spare_server, $lowest_load);
739: }
740:
741: my $found_server = ($spare_server ne '' && $lowest_load < 100);
742:
743: if (!$found_server) {
744: foreach my $try_server (@{ $spareid{'default'} }) {
745: ($spare_server, $lowest_load) =
746: &compare_server_load($try_server, $spare_server, $lowest_load);
747: }
748: }
749:
750: if (!$want_server_name) {
751: my $protocol = 'http';
752: if ($protocol{$spare_server} eq 'https') {
753: $protocol = $protocol{$spare_server};
754: }
755: if (defined($spare_server)) {
756: my $hostname = &hostname($spare_server);
757: if (defined($hostname)) {
758: $spare_server = $protocol.'://'.$hostname;
759: }
760: }
761: }
762: return $spare_server;
763: }
764:
765: sub compare_server_load {
766: my ($try_server, $spare_server, $lowest_load) = @_;
767:
768: my $loadans = &reply('load', $try_server);
769: my $userloadans = &reply('userload',$try_server);
770:
771: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
772: return; #didn't get a number from the server
773: }
774:
775: my $load;
776: if ($loadans =~ /\d/) {
777: if ($userloadans =~ /\d/) {
778: #both are numbers, pick the bigger one
779: $load = ($loadans > $userloadans) ? $loadans
780: : $userloadans;
781: } else {
782: $load = $loadans;
783: }
784: } else {
785: $load = $userloadans;
786: }
787:
788: if (($load =~ /\d/) && ($load < $lowest_load)) {
789: $spare_server = $try_server;
790: $lowest_load = $load;
791: }
792: return ($spare_server,$lowest_load);
793: }
794:
795: # --------------------------- ask offload servers if user already has a session
796: sub find_existing_session {
797: my ($udom,$uname) = @_;
798: foreach my $try_server (@{ $spareid{'primary'} },
799: @{ $spareid{'default'} }) {
800: return $try_server if (&has_user_session($try_server, $udom, $uname));
801: }
802: return;
803: }
804:
805: # -------------------------------- ask if server already has a session for user
806: sub has_user_session {
807: my ($lonid,$udom,$uname) = @_;
808: my $result = &reply(join(':','userhassession',
809: map {&escape($_)} ($udom,$uname)),$lonid);
810: return 1 if ($result eq 'ok');
811:
812: return 0;
813: }
814:
815: # --------------------------------------------- Try to change a user's password
816:
817: sub changepass {
818: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
819: $currentpass = &escape($currentpass);
820: $newpass = &escape($newpass);
821: my $lonhost = $perlvar{'lonHostID'};
822: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
823: $server);
824: if (! $answer) {
825: &logthis("No reply on password change request to $server ".
826: "by $uname in domain $udom.");
827: } elsif ($answer =~ "^ok") {
828: &logthis("$uname in $udom successfully changed their password ".
829: "on $server.");
830: } elsif ($answer =~ "^pwchange_failure") {
831: &logthis("$uname in $udom was unable to change their password ".
832: "on $server. The action was blocked by either lcpasswd ".
833: "or pwchange");
834: } elsif ($answer =~ "^non_authorized") {
835: &logthis("$uname in $udom did not get their password correct when ".
836: "attempting to change it on $server.");
837: } elsif ($answer =~ "^auth_mode_error") {
838: &logthis("$uname in $udom attempted to change their password despite ".
839: "not being locally or internally authenticated on $server.");
840: } elsif ($answer =~ "^unknown_user") {
841: &logthis("$uname in $udom attempted to change their password ".
842: "on $server but were unable to because $server is not ".
843: "their home server.");
844: } elsif ($answer =~ "^refused") {
845: &logthis("$server refused to change $uname in $udom password because ".
846: "it was sent an unencrypted request to change the password.");
847: } elsif ($answer =~ "invalid_client") {
848: &logthis("$server refused to change $uname in $udom password because ".
849: "it was a reset by e-mail originating from an invalid server.");
850: }
851: return $answer;
852: }
853:
854: # ----------------------- Try to determine user's current authentication scheme
855:
856: sub queryauthenticate {
857: my ($uname,$udom)=@_;
858: my $uhome=&homeserver($uname,$udom);
859: if (!$uhome) {
860: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
861: return 'no_host';
862: }
863: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
864: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
865: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
866: }
867: return $answer;
868: }
869:
870: # --------- Try to authenticate user from domain's lib servers (first this one)
871:
872: sub authenticate {
873: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
874: $upass=&escape($upass);
875: $uname= &LONCAPA::clean_username($uname);
876: my $uhome=&homeserver($uname,$udom,1);
877: my $newhome;
878: if ((!$uhome) || ($uhome eq 'no_host')) {
879: # Maybe the machine was offline and only re-appeared again recently?
880: &reconlonc();
881: # One more
882: $uhome=&homeserver($uname,$udom,1);
883: if (($uhome eq 'no_host') && $checkdefauth) {
884: if (defined(&domain($udom,'primary'))) {
885: $newhome=&domain($udom,'primary');
886: }
887: if ($newhome ne '') {
888: $uhome = $newhome;
889: }
890: }
891: if ((!$uhome) || ($uhome eq 'no_host')) {
892: &logthis("User $uname at $udom is unknown in authenticate");
893: return 'no_host';
894: }
895: }
896: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
897: if ($answer eq 'authorized') {
898: if ($newhome) {
899: &logthis("User $uname at $udom authorized by $uhome, but needs account");
900: return 'no_account_on_host';
901: } else {
902: &logthis("User $uname at $udom authorized by $uhome");
903: return $uhome;
904: }
905: }
906: if ($answer eq 'non_authorized') {
907: &logthis("User $uname at $udom rejected by $uhome");
908: return 'no_host';
909: }
910: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
911: return 'no_host';
912: }
913:
914: sub can_host_session {
915: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
916: my $canhost = 1;
917: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
918: if (ref($remotesessions) eq 'HASH') {
919: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
920: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
921: $canhost = 0;
922: } else {
923: $canhost = 1;
924: }
925: }
926: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
927: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
928: $canhost = 1;
929: } else {
930: $canhost = 0;
931: }
932: }
933: if ($canhost) {
934: if ($remotesessions->{'version'} ne '') {
935: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
936: if ($reqmajor ne '' && $reqminor ne '') {
937: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
938: my $major = $1;
939: my $minor = $2;
940: if (($major < $reqmajor ) ||
941: (($major == $reqmajor) && ($minor < $reqminor))) {
942: $canhost = 0;
943: }
944: } else {
945: $canhost = 0;
946: }
947: }
948: }
949: }
950: }
951: if ($canhost) {
952: if (ref($hostedsessions) eq 'HASH') {
953: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
954: if (grep(/^\Q$udom\E$/,@{$hostedsessions->{'excludedomain'}})) {
955: $canhost = 0;
956: } else {
957: $canhost = 1;
958: }
959: }
960: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
961: if (grep(/^\Q$udom\E$/,@{$hostedsessions->{'includedomain'}})) {
962: $canhost = 1;
963: } else {
964: $canhost = 0;
965: }
966: }
967: }
968: }
969: return $canhost;
970: }
971:
972: # ---------------------- Find the homebase for a user from domain's lib servers
973:
974: my %homecache;
975: sub homeserver {
976: my ($uname,$udom,$ignoreBadCache)=@_;
977: my $index="$uname:$udom";
978:
979: if (exists($homecache{$index})) { return $homecache{$index}; }
980:
981: my %servers = &get_servers($udom,'library');
982: foreach my $tryserver (keys(%servers)) {
983: next if ($ignoreBadCache ne 'true' &&
984: exists($badServerCache{$tryserver}));
985:
986: my $answer=reply("home:$udom:$uname",$tryserver);
987: if ($answer eq 'found') {
988: delete($badServerCache{$tryserver});
989: return $homecache{$index}=$tryserver;
990: } elsif ($answer eq 'no_host') {
991: $badServerCache{$tryserver}=1;
992: }
993: }
994: return 'no_host';
995: }
996:
997: # ------------------------------------- Find the usernames behind a list of IDs
998:
999: sub idget {
1000: my ($udom,@ids)=@_;
1001: my %returnhash=();
1002:
1003: my %servers = &get_servers($udom,'library');
1004: foreach my $tryserver (keys(%servers)) {
1005: my $idlist=join('&',@ids);
1006: $idlist=~tr/A-Z/a-z/;
1007: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1008: my @answer=();
1009: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1010: @answer=split(/\&/,$reply);
1011: } ;
1012: my $i;
1013: for ($i=0;$i<=$#ids;$i++) {
1014: if ($answer[$i]) {
1015: $returnhash{$ids[$i]}=$answer[$i];
1016: }
1017: }
1018: }
1019: return %returnhash;
1020: }
1021:
1022: # ------------------------------------- Find the IDs behind a list of usernames
1023:
1024: sub idrget {
1025: my ($udom,@unames)=@_;
1026: my %returnhash=();
1027: foreach my $uname (@unames) {
1028: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1029: }
1030: return %returnhash;
1031: }
1032:
1033: # ------------------------------- Store away a list of names and associated IDs
1034:
1035: sub idput {
1036: my ($udom,%ids)=@_;
1037: my %servers=();
1038: foreach my $uname (keys(%ids)) {
1039: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1040: my $uhom=&homeserver($uname,$udom);
1041: if ($uhom ne 'no_host') {
1042: my $id=&escape($ids{$uname});
1043: $id=~tr/A-Z/a-z/;
1044: my $esc_unam=&escape($uname);
1045: if ($servers{$uhom}) {
1046: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1047: } else {
1048: $servers{$uhom}=$id.'='.$esc_unam;
1049: }
1050: }
1051: }
1052: foreach my $server (keys(%servers)) {
1053: &critical('idput:'.$udom.':'.$servers{$server},$server);
1054: }
1055: }
1056:
1057: # ------------------------------dump from db file owned by domainconfig user
1058: sub dump_dom {
1059: my ($namespace,$udom,$regexp,$range)=@_;
1060: if (!$udom) {
1061: $udom=$env{'user.domain'};
1062: }
1063: my %returnhash;
1064: if ($udom) {
1065: my $uname = &get_domainconfiguser($udom);
1066: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1067: }
1068: return %returnhash;
1069: }
1070:
1071: # ------------------------------------------ get items from domain db files
1072:
1073: sub get_dom {
1074: my ($namespace,$storearr,$udom,$uhome)=@_;
1075: my $items='';
1076: foreach my $item (@$storearr) {
1077: $items.=&escape($item).'&';
1078: }
1079: $items=~s/\&$//;
1080: if (!$udom) {
1081: $udom=$env{'user.domain'};
1082: if (defined(&domain($udom,'primary'))) {
1083: $uhome=&domain($udom,'primary');
1084: } else {
1085: undef($uhome);
1086: }
1087: } else {
1088: if (!$uhome) {
1089: if (defined(&domain($udom,'primary'))) {
1090: $uhome=&domain($udom,'primary');
1091: }
1092: }
1093: }
1094: if ($udom && $uhome && ($uhome ne 'no_host')) {
1095: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1096: my %returnhash;
1097: if ($rep eq '' || $rep =~ /^error: 2 /) {
1098: return %returnhash;
1099: }
1100: my @pairs=split(/\&/,$rep);
1101: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1102: return @pairs;
1103: }
1104: my $i=0;
1105: foreach my $item (@$storearr) {
1106: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1107: $i++;
1108: }
1109: return %returnhash;
1110: } else {
1111: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1112: }
1113: }
1114:
1115: # -------------------------------------------- put items in domain db files
1116:
1117: sub put_dom {
1118: my ($namespace,$storehash,$udom,$uhome)=@_;
1119: if (!$udom) {
1120: $udom=$env{'user.domain'};
1121: if (defined(&domain($udom,'primary'))) {
1122: $uhome=&domain($udom,'primary');
1123: } else {
1124: undef($uhome);
1125: }
1126: } else {
1127: if (!$uhome) {
1128: if (defined(&domain($udom,'primary'))) {
1129: $uhome=&domain($udom,'primary');
1130: }
1131: }
1132: }
1133: if ($udom && $uhome && ($uhome ne 'no_host')) {
1134: my $items='';
1135: foreach my $item (keys(%$storehash)) {
1136: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1137: }
1138: $items=~s/\&$//;
1139: return &reply("putdom:$udom:$namespace:$items",$uhome);
1140: } else {
1141: &logthis("put_dom failed - no homeserver and/or domain");
1142: }
1143: }
1144:
1145: # --------------------- newput for items in db file owned by domainconfig user
1146: sub newput_dom {
1147: my ($namespace,$storehash,$udom) = @_;
1148: my $result;
1149: if (!$udom) {
1150: $udom=$env{'user.domain'};
1151: }
1152: if ($udom) {
1153: my $uname = &get_domainconfiguser($udom);
1154: $result = &newput($namespace,$storehash,$udom,$uname);
1155: }
1156: return $result;
1157: }
1158:
1159: # --------------------- delete for items in db file owned by domainconfig user
1160: sub del_dom {
1161: my ($namespace,$storearr,$udom)=@_;
1162: if (ref($storearr) eq 'ARRAY') {
1163: if (!$udom) {
1164: $udom=$env{'user.domain'};
1165: }
1166: if ($udom) {
1167: my $uname = &get_domainconfiguser($udom);
1168: return &del($namespace,$storearr,$udom,$uname);
1169: }
1170: }
1171: }
1172:
1173: # ----------------------------------construct domainconfig user for a domain
1174: sub get_domainconfiguser {
1175: my ($udom) = @_;
1176: return $udom.'-domainconfig';
1177: }
1178:
1179: sub retrieve_inst_usertypes {
1180: my ($udom) = @_;
1181: my (%returnhash,@order);
1182: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1183: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1184: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1185: %returnhash = %{$domdefs{'inststatustypes'}};
1186: @order = @{$domdefs{'inststatusorder'}};
1187: } else {
1188: if (defined(&domain($udom,'primary'))) {
1189: my $uhome=&domain($udom,'primary');
1190: my $rep=&reply("inst_usertypes:$udom",$uhome);
1191: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1192: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1193: return (\%returnhash,\@order);
1194: }
1195: my ($hashitems,$orderitems) = split(/:/,$rep);
1196: my @pairs=split(/\&/,$hashitems);
1197: foreach my $item (@pairs) {
1198: my ($key,$value)=split(/=/,$item,2);
1199: $key = &unescape($key);
1200: next if ($key =~ /^error: 2 /);
1201: $returnhash{$key}=&thaw_unescape($value);
1202: }
1203: my @esc_order = split(/\&/,$orderitems);
1204: foreach my $item (@esc_order) {
1205: push(@order,&unescape($item));
1206: }
1207: } else {
1208: &logthis("get_dom failed - no primary domain server for $udom");
1209: }
1210: }
1211: return (\%returnhash,\@order);
1212: }
1213:
1214: sub is_domainimage {
1215: my ($url) = @_;
1216: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1217: if (&domain($1) ne '') {
1218: return '1';
1219: }
1220: }
1221: return;
1222: }
1223:
1224: sub inst_directory_query {
1225: my ($srch) = @_;
1226: my $udom = $srch->{'srchdomain'};
1227: my %results;
1228: my $homeserver = &domain($udom,'primary');
1229: my $outcome;
1230: if ($homeserver ne '') {
1231: my $queryid=&reply("querysend:instdirsearch:".
1232: &escape($srch->{'srchby'}).':'.
1233: &escape($srch->{'srchterm'}).':'.
1234: &escape($srch->{'srchtype'}),$homeserver);
1235: my $host=&hostname($homeserver);
1236: if ($queryid !~/^\Q$host\E\_/) {
1237: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1238: return;
1239: }
1240: my $response = &get_query_reply($queryid);
1241: my $maxtries = 5;
1242: my $tries = 1;
1243: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1244: $response = &get_query_reply($queryid);
1245: $tries ++;
1246: }
1247:
1248: if (!&error($response) && $response ne 'refused') {
1249: if ($response eq 'unavailable') {
1250: $outcome = $response;
1251: } else {
1252: $outcome = 'ok';
1253: my @matches = split(/\n/,$response);
1254: foreach my $match (@matches) {
1255: my ($key,$value) = split(/=/,$match);
1256: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1257: }
1258: }
1259: }
1260: }
1261: return ($outcome,%results);
1262: }
1263:
1264: sub usersearch {
1265: my ($srch) = @_;
1266: my $dom = $srch->{'srchdomain'};
1267: my %results;
1268: my %libserv = &all_library();
1269: my $query = 'usersearch';
1270: foreach my $tryserver (keys(%libserv)) {
1271: if (&host_domain($tryserver) eq $dom) {
1272: my $host=&hostname($tryserver);
1273: my $queryid=
1274: &reply("querysend:".&escape($query).':'.
1275: &escape($srch->{'srchby'}).':'.
1276: &escape($srch->{'srchtype'}).':'.
1277: &escape($srch->{'srchterm'}),$tryserver);
1278: if ($queryid !~/^\Q$host\E\_/) {
1279: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1280: next;
1281: }
1282: my $reply = &get_query_reply($queryid);
1283: my $maxtries = 1;
1284: my $tries = 1;
1285: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1286: $reply = &get_query_reply($queryid);
1287: $tries ++;
1288: }
1289: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1290: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1291: } else {
1292: my @matches;
1293: if ($reply =~ /\n/) {
1294: @matches = split(/\n/,$reply);
1295: } else {
1296: @matches = split(/\&/,$reply);
1297: }
1298: foreach my $match (@matches) {
1299: my ($uname,$udom,%userhash);
1300: foreach my $entry (split(/:/,$match)) {
1301: my ($key,$value) =
1302: map {&unescape($_);} split(/=/,$entry);
1303: $userhash{$key} = $value;
1304: if ($key eq 'username') {
1305: $uname = $value;
1306: } elsif ($key eq 'domain') {
1307: $udom = $value;
1308: }
1309: }
1310: $results{$uname.':'.$udom} = \%userhash;
1311: }
1312: }
1313: }
1314: }
1315: return %results;
1316: }
1317:
1318: sub get_instuser {
1319: my ($udom,$uname,$id) = @_;
1320: my $homeserver = &domain($udom,'primary');
1321: my ($outcome,%results);
1322: if ($homeserver ne '') {
1323: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1324: &escape($id).':'.&escape($udom),$homeserver);
1325: my $host=&hostname($homeserver);
1326: if ($queryid !~/^\Q$host\E\_/) {
1327: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1328: return;
1329: }
1330: my $response = &get_query_reply($queryid);
1331: my $maxtries = 5;
1332: my $tries = 1;
1333: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1334: $response = &get_query_reply($queryid);
1335: $tries ++;
1336: }
1337: if (!&error($response) && $response ne 'refused') {
1338: if ($response eq 'unavailable') {
1339: $outcome = $response;
1340: } else {
1341: $outcome = 'ok';
1342: my @matches = split(/\n/,$response);
1343: foreach my $match (@matches) {
1344: my ($key,$value) = split(/=/,$match);
1345: $results{&unescape($key)} = &thaw_unescape($value);
1346: }
1347: }
1348: }
1349: }
1350: my %userinfo;
1351: if (ref($results{$uname}) eq 'HASH') {
1352: %userinfo = %{$results{$uname}};
1353: }
1354: return ($outcome,%userinfo);
1355: }
1356:
1357: sub inst_rulecheck {
1358: my ($udom,$uname,$id,$item,$rules) = @_;
1359: my %returnhash;
1360: if ($udom ne '') {
1361: if (ref($rules) eq 'ARRAY') {
1362: @{$rules} = map {&escape($_);} (@{$rules});
1363: my $rulestr = join(':',@{$rules});
1364: my $homeserver=&domain($udom,'primary');
1365: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1366: my $response;
1367: if ($item eq 'username') {
1368: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1369: ':'.&escape($uname).':'.$rulestr,
1370: $homeserver));
1371: } elsif ($item eq 'id') {
1372: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1373: ':'.&escape($id).':'.$rulestr,
1374: $homeserver));
1375: } elsif ($item eq 'selfcreate') {
1376: $response=&unescape(&reply('instselfcreatecheck:'.
1377: &escape($udom).':'.&escape($uname).
1378: ':'.$rulestr,$homeserver));
1379: }
1380: if ($response ne 'refused') {
1381: my @pairs=split(/\&/,$response);
1382: foreach my $item (@pairs) {
1383: my ($key,$value)=split(/=/,$item,2);
1384: $key = &unescape($key);
1385: next if ($key =~ /^error: 2 /);
1386: $returnhash{$key}=&thaw_unescape($value);
1387: }
1388: }
1389: }
1390: }
1391: }
1392: return %returnhash;
1393: }
1394:
1395: sub inst_userrules {
1396: my ($udom,$check) = @_;
1397: my (%ruleshash,@ruleorder);
1398: if ($udom ne '') {
1399: my $homeserver=&domain($udom,'primary');
1400: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1401: my $response;
1402: if ($check eq 'id') {
1403: $response=&reply('instidrules:'.&escape($udom),
1404: $homeserver);
1405: } elsif ($check eq 'email') {
1406: $response=&reply('instemailrules:'.&escape($udom),
1407: $homeserver);
1408: } else {
1409: $response=&reply('instuserrules:'.&escape($udom),
1410: $homeserver);
1411: }
1412: if (($response ne 'refused') && ($response ne 'error') &&
1413: ($response ne 'unknown_cmd') &&
1414: ($response ne 'no_such_host')) {
1415: my ($hashitems,$orderitems) = split(/:/,$response);
1416: my @pairs=split(/\&/,$hashitems);
1417: foreach my $item (@pairs) {
1418: my ($key,$value)=split(/=/,$item,2);
1419: $key = &unescape($key);
1420: next if ($key =~ /^error: 2 /);
1421: $ruleshash{$key}=&thaw_unescape($value);
1422: }
1423: my @esc_order = split(/\&/,$orderitems);
1424: foreach my $item (@esc_order) {
1425: push(@ruleorder,&unescape($item));
1426: }
1427: }
1428: }
1429: }
1430: return (\%ruleshash,\@ruleorder);
1431: }
1432:
1433: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1434:
1435: sub get_domain_defaults {
1436: my ($domain) = @_;
1437: my $cachetime = 60*60*24;
1438: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1439: if (defined($cached)) {
1440: if (ref($result) eq 'HASH') {
1441: return %{$result};
1442: }
1443: }
1444: my %domdefaults;
1445: my %domconfig =
1446: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1447: 'requestcourses','inststatus',
1448: 'coursedefaults','usersessions'],$domain);
1449: if (ref($domconfig{'defaults'}) eq 'HASH') {
1450: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1451: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1452: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1453: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1454: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1455: } else {
1456: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1457: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1458: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1459: }
1460: if (ref($domconfig{'quotas'}) eq 'HASH') {
1461: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1462: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1463: } else {
1464: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1465: }
1466: my @usertools = ('aboutme','blog','portfolio');
1467: foreach my $item (@usertools) {
1468: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1469: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1470: }
1471: }
1472: }
1473: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1474: foreach my $item ('official','unofficial','community') {
1475: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1476: }
1477: }
1478: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1479: foreach my $item ('inststatustypes','inststatusorder') {
1480: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1481: }
1482: }
1483: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1484: foreach my $item ('canuse_pdfforms') {
1485: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1486: }
1487: }
1488: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1489: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
1490: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
1491: }
1492: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
1493: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
1494: }
1495: }
1496: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1497: $cachetime);
1498: return %domdefaults;
1499: }
1500:
1501: # --------------------------------------------------- Assign a key to a student
1502:
1503: sub assign_access_key {
1504: #
1505: # a valid key looks like uname:udom#comments
1506: # comments are being appended
1507: #
1508: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1509: $kdom=
1510: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1511: $knum=
1512: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1513: $cdom=
1514: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1515: $cnum=
1516: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1517: $udom=$env{'user.name'} unless (defined($udom));
1518: $uname=$env{'user.domain'} unless (defined($uname));
1519: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1520: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1521: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1522: # assigned to this person
1523: # - this should not happen,
1524: # unless something went wrong
1525: # the first time around
1526: # ready to assign
1527: $logentry=$1.'; '.$logentry;
1528: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1529: $kdom,$knum) eq 'ok') {
1530: # key now belongs to user
1531: my $envkey='key.'.$cdom.'_'.$cnum;
1532: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1533: &appenv({'environment.'.$envkey => $ckey});
1534: return 'ok';
1535: } else {
1536: return
1537: 'error: Count not permanently assign key, will need to be re-entered later.';
1538: }
1539: } else {
1540: return 'error: Could not assign key, try again later.';
1541: }
1542: } elsif (!$existing{$ckey}) {
1543: # the key does not exist
1544: return 'error: The key does not exist';
1545: } else {
1546: # the key is somebody else's
1547: return 'error: The key is already in use';
1548: }
1549: }
1550:
1551: # ------------------------------------------ put an additional comment on a key
1552:
1553: sub comment_access_key {
1554: #
1555: # a valid key looks like uname:udom#comments
1556: # comments are being appended
1557: #
1558: my ($ckey,$cdom,$cnum,$logentry)=@_;
1559: $cdom=
1560: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1561: $cnum=
1562: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1563: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1564: if ($existing{$ckey}) {
1565: $existing{$ckey}.='; '.$logentry;
1566: # ready to assign
1567: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1568: $cdom,$cnum) eq 'ok') {
1569: return 'ok';
1570: } else {
1571: return 'error: Count not store comment.';
1572: }
1573: } else {
1574: # the key does not exist
1575: return 'error: The key does not exist';
1576: }
1577: }
1578:
1579: # ------------------------------------------------------ Generate a set of keys
1580:
1581: sub generate_access_keys {
1582: my ($number,$cdom,$cnum,$logentry)=@_;
1583: $cdom=
1584: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1585: $cnum=
1586: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1587: unless (&allowed('mky',$cdom)) { return 0; }
1588: unless (($cdom) && ($cnum)) { return 0; }
1589: if ($number>10000) { return 0; }
1590: sleep(2); # make sure don't get same seed twice
1591: srand(time()^($$+($$<<15))); # from "Programming Perl"
1592: my $total=0;
1593: for (my $i=1;$i<=$number;$i++) {
1594: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1595: sprintf("%lx",int(100000*rand)).'-'.
1596: sprintf("%lx",int(100000*rand));
1597: $newkey=~s/1/g/g; # folks mix up 1 and l
1598: $newkey=~s/0/h/g; # and also 0 and O
1599: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1600: if ($existing{$newkey}) {
1601: $i--;
1602: } else {
1603: if (&put('accesskeys',
1604: { $newkey => '# generated '.localtime().
1605: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1606: '; '.$logentry },
1607: $cdom,$cnum) eq 'ok') {
1608: $total++;
1609: }
1610: }
1611: }
1612: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1613: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1614: return $total;
1615: }
1616:
1617: # ------------------------------------------------------- Validate an accesskey
1618:
1619: sub validate_access_key {
1620: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1621: $cdom=
1622: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1623: $cnum=
1624: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1625: $udom=$env{'user.domain'} unless (defined($udom));
1626: $uname=$env{'user.name'} unless (defined($uname));
1627: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1628: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1629: }
1630:
1631: # ------------------------------------- Find the section of student in a course
1632: sub devalidate_getsection_cache {
1633: my ($udom,$unam,$courseid)=@_;
1634: my $hashid="$udom:$unam:$courseid";
1635: &devalidate_cache_new('getsection',$hashid);
1636: }
1637:
1638: sub courseid_to_courseurl {
1639: my ($courseid) = @_;
1640: #already url style courseid
1641: return $courseid if ($courseid =~ m{^/});
1642:
1643: if (exists($env{'course.'.$courseid.'.num'})) {
1644: my $cnum = $env{'course.'.$courseid.'.num'};
1645: my $cdom = $env{'course.'.$courseid.'.domain'};
1646: return "/$cdom/$cnum";
1647: }
1648:
1649: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1650: if (exists($courseinfo{'num'})) {
1651: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1652: }
1653:
1654: return undef;
1655: }
1656:
1657: sub getsection {
1658: my ($udom,$unam,$courseid)=@_;
1659: my $cachetime=1800;
1660:
1661: my $hashid="$udom:$unam:$courseid";
1662: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1663: if (defined($cached)) { return $result; }
1664:
1665: my %Pending;
1666: my %Expired;
1667: #
1668: # Each role can either have not started yet (pending), be active,
1669: # or have expired.
1670: #
1671: # If there is an active role, we are done.
1672: #
1673: # If there is more than one role which has not started yet,
1674: # choose the one which will start sooner
1675: # If there is one role which has not started yet, return it.
1676: #
1677: # If there is more than one expired role, choose the one which ended last.
1678: # If there is a role which has expired, return it.
1679: #
1680: $courseid = &courseid_to_courseurl($courseid);
1681: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1682: foreach my $key (keys(%roleshash)) {
1683: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1684: my $section=$1;
1685: if ($key eq $courseid.'_st') { $section=''; }
1686: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1687: my $now=time;
1688: if (defined($end) && $end && ($now > $end)) {
1689: $Expired{$end}=$section;
1690: next;
1691: }
1692: if (defined($start) && $start && ($now < $start)) {
1693: $Pending{$start}=$section;
1694: next;
1695: }
1696: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1697: }
1698: #
1699: # Presumedly there will be few matching roles from the above
1700: # loop and the sorting time will be negligible.
1701: if (scalar(keys(%Pending))) {
1702: my ($time) = sort {$a <=> $b} keys(%Pending);
1703: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1704: }
1705: if (scalar(keys(%Expired))) {
1706: my @sorted = sort {$a <=> $b} keys(%Expired);
1707: my $time = pop(@sorted);
1708: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1709: }
1710: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1711: }
1712:
1713: sub save_cache {
1714: &purge_remembered();
1715: #&Apache::loncommon::validate_page();
1716: undef(%env);
1717: undef($env_loaded);
1718: }
1719:
1720: my $to_remember=-1;
1721: my %remembered;
1722: my %accessed;
1723: my $kicks=0;
1724: my $hits=0;
1725: sub make_key {
1726: my ($name,$id) = @_;
1727: if (length($id) > 65
1728: && length(&escape($id)) > 200) {
1729: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1730: }
1731: return &escape($name.':'.$id);
1732: }
1733:
1734: sub devalidate_cache_new {
1735: my ($name,$id,$debug) = @_;
1736: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1737: $id=&make_key($name,$id);
1738: $memcache->delete($id);
1739: delete($remembered{$id});
1740: delete($accessed{$id});
1741: }
1742:
1743: sub is_cached_new {
1744: my ($name,$id,$debug) = @_;
1745: $id=&make_key($name,$id);
1746: if (exists($remembered{$id})) {
1747: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1748: $accessed{$id}=[&gettimeofday()];
1749: $hits++;
1750: return ($remembered{$id},1);
1751: }
1752: my $value = $memcache->get($id);
1753: if (!(defined($value))) {
1754: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1755: return (undef,undef);
1756: }
1757: if ($value eq '__undef__') {
1758: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1759: $value=undef;
1760: }
1761: &make_room($id,$value,$debug);
1762: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1763: return ($value,1);
1764: }
1765:
1766: sub do_cache_new {
1767: my ($name,$id,$value,$time,$debug) = @_;
1768: $id=&make_key($name,$id);
1769: my $setvalue=$value;
1770: if (!defined($setvalue)) {
1771: $setvalue='__undef__';
1772: }
1773: if (!defined($time) ) {
1774: $time=600;
1775: }
1776: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1777: my $result = $memcache->set($id,$setvalue,$time);
1778: if (! $result) {
1779: &logthis("caching of id -> $id failed");
1780: $memcache->disconnect_all();
1781: }
1782: # need to make a copy of $value
1783: &make_room($id,$value,$debug);
1784: return $value;
1785: }
1786:
1787: sub make_room {
1788: my ($id,$value,$debug)=@_;
1789:
1790: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1791: : $value;
1792: if ($to_remember<0) { return; }
1793: $accessed{$id}=[&gettimeofday()];
1794: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1795: my $to_kick;
1796: my $max_time=0;
1797: foreach my $other (keys(%accessed)) {
1798: if (&tv_interval($accessed{$other}) > $max_time) {
1799: $to_kick=$other;
1800: $max_time=&tv_interval($accessed{$other});
1801: }
1802: }
1803: delete($remembered{$to_kick});
1804: delete($accessed{$to_kick});
1805: $kicks++;
1806: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1807: return;
1808: }
1809:
1810: sub purge_remembered {
1811: #&logthis("Tossing ".scalar(keys(%remembered)));
1812: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1813: undef(%remembered);
1814: undef(%accessed);
1815: }
1816: # ------------------------------------- Read an entry from a user's environment
1817:
1818: sub userenvironment {
1819: my ($udom,$unam,@what)=@_;
1820: my $items;
1821: foreach my $item (@what) {
1822: $items.=&escape($item).'&';
1823: }
1824: $items=~s/\&$//;
1825: my %returnhash=();
1826: my $uhome = &homeserver($unam,$udom);
1827: unless ($uhome eq 'no_host') {
1828: my @answer=split(/\&/,
1829: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1830: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1831: return %returnhash;
1832: }
1833: my $i;
1834: for ($i=0;$i<=$#what;$i++) {
1835: $returnhash{$what[$i]}=&unescape($answer[$i]);
1836: }
1837: }
1838: return %returnhash;
1839: }
1840:
1841: # ---------------------------------------------------------- Get a studentphoto
1842: sub studentphoto {
1843: my ($udom,$unam,$ext) = @_;
1844: my $home=&Apache::lonnet::homeserver($unam,$udom);
1845: if (defined($env{'request.course.id'})) {
1846: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1847: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1848: return(&retrievestudentphoto($udom,$unam,$ext));
1849: } else {
1850: my ($result,$perm_reqd)=
1851: &Apache::lonnet::auto_photo_permission($unam,$udom);
1852: if ($result eq 'ok') {
1853: if (!($perm_reqd eq 'yes')) {
1854: return(&retrievestudentphoto($udom,$unam,$ext));
1855: }
1856: }
1857: }
1858: }
1859: } else {
1860: my ($result,$perm_reqd) =
1861: &Apache::lonnet::auto_photo_permission($unam,$udom);
1862: if ($result eq 'ok') {
1863: if (!($perm_reqd eq 'yes')) {
1864: return(&retrievestudentphoto($udom,$unam,$ext));
1865: }
1866: }
1867: }
1868: return '/adm/lonKaputt/lonlogo_broken.gif';
1869: }
1870:
1871: sub retrievestudentphoto {
1872: my ($udom,$unam,$ext,$type) = @_;
1873: my $home=&Apache::lonnet::homeserver($unam,$udom);
1874: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1875: if ($ret eq 'ok') {
1876: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1877: if ($type eq 'thumbnail') {
1878: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1879: }
1880: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1881: return $tokenurl;
1882: } else {
1883: if ($type eq 'thumbnail') {
1884: return '/adm/lonKaputt/genericstudent_tn.gif';
1885: } else {
1886: return '/adm/lonKaputt/lonlogo_broken.gif';
1887: }
1888: }
1889: }
1890:
1891: # -------------------------------------------------------------------- New chat
1892:
1893: sub chatsend {
1894: my ($newentry,$anon,$group)=@_;
1895: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1896: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1897: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1898: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1899: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1900: &escape($newentry)).':'.$group,$chome);
1901: }
1902:
1903: # ------------------------------------------ Find current version of a resource
1904:
1905: sub getversion {
1906: my $fname=&clutter(shift);
1907: unless ($fname=~/^\/res\//) { return -1; }
1908: return ¤tversion(&filelocation('',$fname));
1909: }
1910:
1911: sub currentversion {
1912: my $fname=shift;
1913: my ($result,$cached)=&is_cached_new('resversion',$fname);
1914: if (defined($cached)) { return $result; }
1915: my $author=$fname;
1916: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1917: my ($udom,$uname)=split(/\//,$author);
1918: my $home=homeserver($uname,$udom);
1919: if ($home eq 'no_host') {
1920: return -1;
1921: }
1922: my $answer=reply("currentversion:$fname",$home);
1923: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1924: return -1;
1925: }
1926: return &do_cache_new('resversion',$fname,$answer,600);
1927: }
1928:
1929: # ----------------------------- Subscribe to a resource, return URL if possible
1930:
1931: sub subscribe {
1932: my $fname=shift;
1933: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1934: $fname=~s/[\n\r]//g;
1935: my $author=$fname;
1936: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1937: my ($udom,$uname)=split(/\//,$author);
1938: my $home=homeserver($uname,$udom);
1939: if ($home eq 'no_host') {
1940: return 'not_found';
1941: }
1942: my $answer=reply("sub:$fname",$home);
1943: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1944: $answer.=' by '.$home;
1945: }
1946: return $answer;
1947: }
1948:
1949: # -------------------------------------------------------------- Replicate file
1950:
1951: sub repcopy {
1952: my $filename=shift;
1953: $filename=~s/\/+/\//g;
1954: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1955: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1956: if ($filename=~m|^/home/httpd/html/userfiles/| or
1957: $filename=~m -^/*(uploaded|editupload)/-) {
1958: return &repcopy_userfile($filename);
1959: }
1960: $filename=~s/[\n\r]//g;
1961: my $transname="$filename.in.transfer";
1962: # FIXME: this should flock
1963: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1964: my $remoteurl=subscribe($filename);
1965: if ($remoteurl =~ /^con_lost by/) {
1966: &logthis("Subscribe returned $remoteurl: $filename");
1967: return 'unavailable';
1968: } elsif ($remoteurl eq 'not_found') {
1969: #&logthis("Subscribe returned not_found: $filename");
1970: return 'not_found';
1971: } elsif ($remoteurl =~ /^rejected by/) {
1972: &logthis("Subscribe returned $remoteurl: $filename");
1973: return 'forbidden';
1974: } elsif ($remoteurl eq 'directory') {
1975: return 'ok';
1976: } else {
1977: my $author=$filename;
1978: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1979: my ($udom,$uname)=split(/\//,$author);
1980: my $home=homeserver($uname,$udom);
1981: unless ($home eq $perlvar{'lonHostID'}) {
1982: my @parts=split(/\//,$filename);
1983: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1984: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1985: &logthis("Malconfiguration for replication: $filename");
1986: return 'bad_request';
1987: }
1988: my $count;
1989: for ($count=5;$count<$#parts;$count++) {
1990: $path.="/$parts[$count]";
1991: if ((-e $path)!=1) {
1992: mkdir($path,0777);
1993: }
1994: }
1995: my $ua=new LWP::UserAgent;
1996: my $request=new HTTP::Request('GET',"$remoteurl");
1997: my $response=$ua->request($request,$transname);
1998: if ($response->is_error()) {
1999: unlink($transname);
2000: my $message=$response->status_line;
2001: &logthis("<font color=\"blue\">WARNING:"
2002: ." LWP get: $message: $filename</font>");
2003: return 'unavailable';
2004: } else {
2005: if ($remoteurl!~/\.meta$/) {
2006: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2007: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2008: if ($mresponse->is_error()) {
2009: unlink($filename.'.meta');
2010: &logthis(
2011: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2012: }
2013: }
2014: rename($transname,$filename);
2015: return 'ok';
2016: }
2017: }
2018: }
2019: }
2020:
2021: # ------------------------------------------------ Get server side include body
2022: sub ssi_body {
2023: my ($filelink,%form)=@_;
2024: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2025: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2026: }
2027: my $output='';
2028: my $response;
2029: if ($filelink=~/^https?\:/) {
2030: ($output,$response)=&externalssi($filelink);
2031: } else {
2032: $filelink .= $filelink=~/\?/ ? '&' : '?';
2033: $filelink .= 'inhibitmenu=yes';
2034: ($output,$response)=&ssi($filelink,%form);
2035: }
2036: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2037: $output=~s/^.*?\<body[^\>]*\>//si;
2038: $output=~s/\<\/body\s*\>.*?$//si;
2039: if (wantarray) {
2040: return ($output, $response);
2041: } else {
2042: return $output;
2043: }
2044: }
2045:
2046: # --------------------------------------------------------- Server Side Include
2047:
2048: sub absolute_url {
2049: my ($host_name) = @_;
2050: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2051: if ($host_name eq '') {
2052: $host_name = $ENV{'SERVER_NAME'};
2053: }
2054: return $protocol.$host_name;
2055: }
2056:
2057: #
2058: # Server side include.
2059: # Parameters:
2060: # fn Possibly encrypted resource name/id.
2061: # form Hash that describes how the rendering should be done
2062: # and other things.
2063: # Returns:
2064: # Scalar context: The content of the response.
2065: # Array context: 2 element list of the content and the full response object.
2066: #
2067: sub ssi {
2068:
2069: my ($fn,%form)=@_;
2070: my $ua=new LWP::UserAgent;
2071: my $request;
2072:
2073: $form{'no_update_last_known'}=1;
2074: &Apache::lonenc::check_encrypt(\$fn);
2075: if (%form) {
2076: $request=new HTTP::Request('POST',&absolute_url().$fn);
2077: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
2078: } else {
2079: $request=new HTTP::Request('GET',&absolute_url().$fn);
2080: }
2081:
2082: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2083: my $response=$ua->request($request);
2084:
2085: if (wantarray) {
2086: return ($response->content, $response);
2087: } else {
2088: return $response->content;
2089: }
2090: }
2091:
2092: sub externalssi {
2093: my ($url)=@_;
2094: my $ua=new LWP::UserAgent;
2095: my $request=new HTTP::Request('GET',$url);
2096: my $response=$ua->request($request);
2097: if (wantarray) {
2098: return ($response->content, $response);
2099: } else {
2100: return $response->content;
2101: }
2102: }
2103:
2104: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2105:
2106: sub allowuploaded {
2107: my ($srcurl,$url)=@_;
2108: $url=&clutter(&declutter($url));
2109: my $dir=$url;
2110: $dir=~s/\/[^\/]+$//;
2111: my %httpref=();
2112: my $httpurl=&hreflocation('',$url);
2113: $httpref{'httpref.'.$httpurl}=$srcurl;
2114: &Apache::lonnet::appenv(\%httpref);
2115: }
2116:
2117: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2118: # input: action, courseID, current domain, intended
2119: # path to file, source of file, instruction to parse file for objects,
2120: # ref to hash for embedded objects,
2121: # ref to hash for codebase of java objects.
2122: #
2123: # output: url to file (if action was uploaddoc),
2124: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2125: #
2126: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2127: # course.
2128: #
2129: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2130: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2131: # course's home server.
2132: #
2133: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2134: # be copied from $source (current location) to
2135: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2136: # and will then be copied to
2137: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2138: # course's home server.
2139: #
2140: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2141: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2142: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2143: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2144: # in course's home server.
2145: #
2146:
2147: sub process_coursefile {
2148: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
2149: my $fetchresult;
2150: my $home=&homeserver($docuname,$docudom);
2151: if ($action eq 'propagate') {
2152: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2153: $home);
2154: } else {
2155: my $fpath = '';
2156: my $fname = $file;
2157: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2158: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2159: my $filepath = &build_filepath($fpath);
2160: if ($action eq 'copy') {
2161: if ($source eq '') {
2162: $fetchresult = 'no source file';
2163: return $fetchresult;
2164: } else {
2165: my $destination = $filepath.'/'.$fname;
2166: rename($source,$destination);
2167: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2168: $home);
2169: }
2170: } elsif ($action eq 'uploaddoc') {
2171: open(my $fh,'>'.$filepath.'/'.$fname);
2172: print $fh $env{'form.'.$source};
2173: close($fh);
2174: if ($parser eq 'parse') {
2175: my $mm = new File::MMagic;
2176: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2177: if ($mime_type eq 'text/html') {
2178: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2179: unless ($parse_result eq 'ok') {
2180: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2181: }
2182: }
2183: }
2184: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2185: $home);
2186: if ($fetchresult eq 'ok') {
2187: return '/uploaded/'.$fpath.'/'.$fname;
2188: } else {
2189: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2190: ' to host '.$home.': '.$fetchresult);
2191: return '/adm/notfound.html';
2192: }
2193: }
2194: }
2195: unless ( $fetchresult eq 'ok') {
2196: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2197: ' to host '.$home.': '.$fetchresult);
2198: }
2199: return $fetchresult;
2200: }
2201:
2202: sub build_filepath {
2203: my ($fpath) = @_;
2204: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2205: unless ($fpath eq '') {
2206: my @parts=split('/',$fpath);
2207: foreach my $part (@parts) {
2208: $filepath.= '/'.$part;
2209: if ((-e $filepath)!=1) {
2210: mkdir($filepath,0777);
2211: }
2212: }
2213: }
2214: return $filepath;
2215: }
2216:
2217: sub store_edited_file {
2218: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2219: my $file = $primary_url;
2220: $file =~ s#^/uploaded/$docudom/$docuname/##;
2221: my $fpath = '';
2222: my $fname = $file;
2223: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2224: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2225: my $filepath = &build_filepath($fpath);
2226: open(my $fh,'>'.$filepath.'/'.$fname);
2227: print $fh $content;
2228: close($fh);
2229: my $home=&homeserver($docuname,$docudom);
2230: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2231: $home);
2232: if ($$fetchresult eq 'ok') {
2233: return '/uploaded/'.$fpath.'/'.$fname;
2234: } else {
2235: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2236: ' to host '.$home.': '.$$fetchresult);
2237: return '/adm/notfound.html';
2238: }
2239: }
2240:
2241: sub clean_filename {
2242: my ($fname,$args)=@_;
2243: # Replace Windows backslashes by forward slashes
2244: $fname=~s/\\/\//g;
2245: if (!$args->{'keep_path'}) {
2246: # Get rid of everything but the actual filename
2247: $fname=~s/^.*\/([^\/]+)$/$1/;
2248: }
2249: # Replace spaces by underscores
2250: $fname=~s/\s+/\_/g;
2251: # Replace all other weird characters by nothing
2252: $fname=~s{[^/\w\.\-]}{}g;
2253: # Replace all .\d. sequences with _\d. so they no longer look like version
2254: # numbers
2255: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2256: return $fname;
2257: }
2258: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2259: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2260: # image with the same aspect ratio as the original, but with dimensions which do
2261: # not exceed $resizewidth and $resizeheight.
2262:
2263: sub resizeImage {
2264: my ($img_path,$resizewidth,$resizeheight) = @_;
2265: my $ima = Image::Magick->new;
2266: my $resized;
2267: if (-e $img_path) {
2268: $ima->Read($img_path);
2269: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2270: my $width = $ima->Get('width');
2271: my $height = $ima->Get('height');
2272: if ($width > $resizewidth) {
2273: my $factor = $width/$resizewidth;
2274: my $newheight = $height/$factor;
2275: $ima->Scale(width=>$resizewidth,height=>$newheight);
2276: $resized = 1;
2277: }
2278: }
2279: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2280: my $width = $ima->Get('width');
2281: my $height = $ima->Get('height');
2282: if ($height > $resizeheight) {
2283: my $factor = $height/$resizeheight;
2284: my $newwidth = $width/$factor;
2285: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2286: $resized = 1;
2287: }
2288: }
2289: if ($resized) {
2290: $ima->Write($img_path);
2291: }
2292: }
2293: return;
2294: }
2295:
2296: # --------------- Take an uploaded file and put it into the userfiles directory
2297: # input: $formname - the contents of the file are in $env{"form.$formname"}
2298: # the desired filenam is in $env{"form.$formname.filename"}
2299: # $coursedoc - if true up to the current course
2300: # if false
2301: # $subdir - directory in userfile to store the file into
2302: # $parser - instruction to parse file for objects ($parser = parse)
2303: # $allfiles - reference to hash for embedded objects
2304: # $codebase - reference to hash for codebase of java objects
2305: # $desuname - username for permanent storage of uploaded file
2306: # $dsetudom - domain for permanaent storage of uploaded file
2307: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2308: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2309: # $resizewidth - width (pixels) to which to resize uploaded image
2310: # $resizeheight - height (pixels) to which to resize uploaded image
2311: #
2312: # output: url of file in userspace, or error: <message>
2313: # or /adm/notfound.html if failure to upload occurse
2314:
2315: sub userfileupload {
2316: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2317: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_;
2318: if (!defined($subdir)) { $subdir='unknown'; }
2319: my $fname=$env{'form.'.$formname.'.filename'};
2320: $fname=&clean_filename($fname);
2321: # See if there is anything left
2322: unless ($fname) { return 'error: no uploaded file'; }
2323: chop($env{'form.'.$formname});
2324: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2325: my $now = time;
2326: my $filepath = 'tmp/helprequests/'.$now;
2327: my @parts=split(/\//,$filepath);
2328: my $fullpath = $perlvar{'lonDaemons'};
2329: for (my $i=0;$i<@parts;$i++) {
2330: $fullpath .= '/'.$parts[$i];
2331: if ((-e $fullpath)!=1) {
2332: mkdir($fullpath,0777);
2333: }
2334: }
2335: open(my $fh,'>'.$fullpath.'/'.$fname);
2336: print $fh $env{'form.'.$formname};
2337: close($fh);
2338: return $fullpath.'/'.$fname;
2339: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2340: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2341: '_'.$env{'user.domain'}.'/pending';
2342: my @parts=split(/\//,$filepath);
2343: my $fullpath = $perlvar{'lonDaemons'};
2344: for (my $i=0;$i<@parts;$i++) {
2345: $fullpath .= '/'.$parts[$i];
2346: if ((-e $fullpath)!=1) {
2347: mkdir($fullpath,0777);
2348: }
2349: }
2350: open(my $fh,'>'.$fullpath.'/'.$fname);
2351: print $fh $env{'form.'.$formname};
2352: close($fh);
2353: return $fullpath.'/'.$fname;
2354: }
2355: if ($subdir eq 'scantron') {
2356: $fname = 'scantron_orig_'.$fname;
2357: } else {
2358: # Create the directory if not present
2359: $fname="$subdir/$fname";
2360: }
2361: if ($coursedoc) {
2362: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2363: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2364: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2365: return &finishuserfileupload($docuname,$docudom,
2366: $formname,$fname,$parser,$allfiles,
2367: $codebase,$thumbwidth,$thumbheight,
2368: $resizewidth,$resizeheight);
2369: } else {
2370: $fname=$env{'form.folder'}.'/'.$fname;
2371: return &process_coursefile('uploaddoc',$docuname,$docudom,
2372: $fname,$formname,$parser,
2373: $allfiles,$codebase);
2374: }
2375: } elsif (defined($destuname)) {
2376: my $docuname=$destuname;
2377: my $docudom=$destudom;
2378: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2379: $parser,$allfiles,$codebase,
2380: $thumbwidth,$thumbheight,
2381: $resizewidth,$resizeheight);
2382:
2383: } else {
2384: my $docuname=$env{'user.name'};
2385: my $docudom=$env{'user.domain'};
2386: if (exists($env{'form.group'})) {
2387: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2388: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2389: }
2390: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2391: $parser,$allfiles,$codebase,
2392: $thumbwidth,$thumbheight,
2393: $resizewidth,$resizeheight);
2394: }
2395: }
2396:
2397: sub finishuserfileupload {
2398: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2399: $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_;
2400: my $path=$docudom.'/'.$docuname.'/';
2401: my $filepath=$perlvar{'lonDocRoot'};
2402:
2403: my ($fnamepath,$file,$fetchthumb);
2404: $file=$fname;
2405: if ($fname=~m|/|) {
2406: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2407: $path.=$fnamepath.'/';
2408: }
2409: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2410: my $count;
2411: for ($count=4;$count<=$#parts;$count++) {
2412: $filepath.="/$parts[$count]";
2413: if ((-e $filepath)!=1) {
2414: mkdir($filepath,0777);
2415: }
2416: }
2417:
2418: # Save the file
2419: {
2420: if (!open(FH,'>'.$filepath.'/'.$file)) {
2421: &logthis('Failed to create '.$filepath.'/'.$file);
2422: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2423: return '/adm/notfound.html';
2424: }
2425: if (!print FH ($env{'form.'.$formname})) {
2426: &logthis('Failed to write to '.$filepath.'/'.$file);
2427: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2428: return '/adm/notfound.html';
2429: }
2430: close(FH);
2431: if ($resizewidth && $resizeheight) {
2432: my $mm = new File::MMagic;
2433: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2434: if ($mime_type =~ m{^image/}) {
2435: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2436: }
2437: }
2438: }
2439: if ($parser eq 'parse') {
2440: my $mm = new File::MMagic;
2441: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2442: if ($mime_type eq 'text/html') {
2443: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2444: $allfiles,$codebase);
2445: unless ($parse_result eq 'ok') {
2446: &logthis('Failed to parse '.$filepath.$file.
2447: ' for embedded media: '.$parse_result);
2448: }
2449: }
2450: }
2451: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2452: my $input = $filepath.'/'.$file;
2453: my $output = $filepath.'/'.'tn-'.$file;
2454: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2455: system("convert -sample $thumbsize $input $output");
2456: if (-e $filepath.'/'.'tn-'.$file) {
2457: $fetchthumb = 1;
2458: }
2459: }
2460:
2461: # Notify homeserver to grep it
2462: #
2463: my $docuhome=&homeserver($docuname,$docudom);
2464: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
2465: if ($fetchresult eq 'ok') {
2466: if ($fetchthumb) {
2467: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2468: if ($thumbresult ne 'ok') {
2469: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2470: $docuhome.': '.$thumbresult);
2471: }
2472: }
2473: #
2474: # Return the URL to it
2475: return '/uploaded/'.$path.$file;
2476: } else {
2477: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2478: ': '.$fetchresult);
2479: return '/adm/notfound.html';
2480: }
2481: }
2482:
2483: sub extract_embedded_items {
2484: my ($fullpath,$allfiles,$codebase,$content) = @_;
2485: my @state = ();
2486: my %javafiles = (
2487: codebase => '',
2488: code => '',
2489: archive => ''
2490: );
2491: my %mediafiles = (
2492: src => '',
2493: movie => '',
2494: );
2495: my $p;
2496: if ($content) {
2497: $p = HTML::LCParser->new($content);
2498: } else {
2499: $p = HTML::LCParser->new($fullpath);
2500: }
2501: while (my $t=$p->get_token()) {
2502: if ($t->[0] eq 'S') {
2503: my ($tagname, $attr) = ($t->[1],$t->[2]);
2504: push(@state, $tagname);
2505: if (lc($tagname) eq 'allow') {
2506: &add_filetype($allfiles,$attr->{'src'},'src');
2507: }
2508: if (lc($tagname) eq 'img') {
2509: &add_filetype($allfiles,$attr->{'src'},'src');
2510: }
2511: if (lc($tagname) eq 'a') {
2512: &add_filetype($allfiles,$attr->{'href'},'href');
2513: }
2514: if (lc($tagname) eq 'script') {
2515: if ($attr->{'archive'} =~ /\.jar$/i) {
2516: &add_filetype($allfiles,$attr->{'archive'},'archive');
2517: } else {
2518: &add_filetype($allfiles,$attr->{'src'},'src');
2519: }
2520: }
2521: if (lc($tagname) eq 'link') {
2522: if (lc($attr->{'rel'}) eq 'stylesheet') {
2523: &add_filetype($allfiles,$attr->{'href'},'href');
2524: }
2525: }
2526: if (lc($tagname) eq 'object' ||
2527: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2528: foreach my $item (keys(%javafiles)) {
2529: $javafiles{$item} = '';
2530: }
2531: }
2532: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2533: my $name = lc($attr->{'name'});
2534: foreach my $item (keys(%javafiles)) {
2535: if ($name eq $item) {
2536: $javafiles{$item} = $attr->{'value'};
2537: last;
2538: }
2539: }
2540: foreach my $item (keys(%mediafiles)) {
2541: if ($name eq $item) {
2542: &add_filetype($allfiles, $attr->{'value'}, 'value');
2543: last;
2544: }
2545: }
2546: }
2547: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2548: foreach my $item (keys(%javafiles)) {
2549: if ($attr->{$item}) {
2550: $javafiles{$item} = $attr->{$item};
2551: last;
2552: }
2553: }
2554: foreach my $item (keys(%mediafiles)) {
2555: if ($attr->{$item}) {
2556: &add_filetype($allfiles,$attr->{$item},$item);
2557: last;
2558: }
2559: }
2560: }
2561: } elsif ($t->[0] eq 'E') {
2562: my ($tagname) = ($t->[1]);
2563: if ($javafiles{'codebase'} ne '') {
2564: $javafiles{'codebase'} .= '/';
2565: }
2566: if (lc($tagname) eq 'applet' ||
2567: lc($tagname) eq 'object' ||
2568: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2569: ) {
2570: foreach my $item (keys(%javafiles)) {
2571: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2572: my $file=$javafiles{'codebase'}.$javafiles{$item};
2573: &add_filetype($allfiles,$file,$item);
2574: }
2575: }
2576: }
2577: pop @state;
2578: }
2579: }
2580: return 'ok';
2581: }
2582:
2583: sub add_filetype {
2584: my ($allfiles,$file,$type)=@_;
2585: if (exists($allfiles->{$file})) {
2586: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2587: push(@{$allfiles->{$file}}, &escape($type));
2588: }
2589: } else {
2590: @{$allfiles->{$file}} = (&escape($type));
2591: }
2592: }
2593:
2594: sub removeuploadedurl {
2595: my ($url)=@_;
2596: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2597: return &removeuserfile($uname,$udom,$fname);
2598: }
2599:
2600: sub removeuserfile {
2601: my ($docuname,$docudom,$fname)=@_;
2602: my $home=&homeserver($docuname,$docudom);
2603: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2604: if ($result eq 'ok') {
2605: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2606: my $metafile = $fname.'.meta';
2607: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2608: my $url = "/uploaded/$docudom/$docuname/$fname";
2609: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2610: my $sqlresult =
2611: &update_portfolio_table($docuname,$docudom,$file,
2612: 'portfolio_metadata',$group,
2613: 'delete');
2614: }
2615: }
2616: return $result;
2617: }
2618:
2619: sub mkdiruserfile {
2620: my ($docuname,$docudom,$dir)=@_;
2621: my $home=&homeserver($docuname,$docudom);
2622: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2623: }
2624:
2625: sub renameuserfile {
2626: my ($docuname,$docudom,$old,$new)=@_;
2627: my $home=&homeserver($docuname,$docudom);
2628: my $result = &reply("renameuserfile:$docudom:$docuname:".
2629: &escape("$old").':'.&escape("$new"),$home);
2630: if ($result eq 'ok') {
2631: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2632: my $oldmeta = $old.'.meta';
2633: my $newmeta = $new.'.meta';
2634: my $metaresult =
2635: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2636: my $url = "/uploaded/$docudom/$docuname/$old";
2637: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2638: my $sqlresult =
2639: &update_portfolio_table($docuname,$docudom,$file,
2640: 'portfolio_metadata',$group,
2641: 'delete');
2642: }
2643: }
2644: return $result;
2645: }
2646:
2647: # ------------------------------------------------------------------------- Log
2648:
2649: sub log {
2650: my ($dom,$nam,$hom,$what)=@_;
2651: return critical("log:$dom:$nam:$what",$hom);
2652: }
2653:
2654: # ------------------------------------------------------------------ Course Log
2655: #
2656: # This routine flushes several buffers of non-mission-critical nature
2657: #
2658:
2659: sub flushcourselogs {
2660: &logthis('Flushing log buffers');
2661: #
2662: # course logs
2663: # This is a log of all transactions in a course, which can be used
2664: # for data mining purposes
2665: #
2666: # It also collects the courseid database, which lists last transaction
2667: # times and course titles for all courseids
2668: #
2669: my %courseidbuffer=();
2670: foreach my $crsid (keys(%courselogs)) {
2671: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2672: &escape($courselogs{$crsid}),
2673: $coursehombuf{$crsid}) eq 'ok') {
2674: delete $courselogs{$crsid};
2675: } else {
2676: &logthis('Failed to flush log buffer for '.$crsid);
2677: if (length($courselogs{$crsid})>40000) {
2678: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2679: " exceeded maximum size, deleting.</font>");
2680: delete $courselogs{$crsid};
2681: }
2682: }
2683: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2684: 'description' => $coursedescrbuf{$crsid},
2685: 'inst_code' => $courseinstcodebuf{$crsid},
2686: 'type' => $coursetypebuf{$crsid},
2687: 'owner' => $courseownerbuf{$crsid},
2688: };
2689: }
2690: #
2691: # Write course id database (reverse lookup) to homeserver of courses
2692: # Is used in pickcourse
2693: #
2694: foreach my $crs_home (keys(%courseidbuffer)) {
2695: my $response = &courseidput(&host_domain($crs_home),
2696: $courseidbuffer{$crs_home},
2697: $crs_home,'timeonly');
2698: }
2699: #
2700: # File accesses
2701: # Writes to the dynamic metadata of resources to get hit counts, etc.
2702: #
2703: foreach my $entry (keys(%accesshash)) {
2704: if ($entry =~ /___count$/) {
2705: my ($dom,$name);
2706: ($dom,$name,undef)=
2707: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2708: if (! defined($dom) || $dom eq '' ||
2709: ! defined($name) || $name eq '') {
2710: my $cid = $env{'request.course.id'};
2711: $dom = $env{'request.'.$cid.'.domain'};
2712: $name = $env{'request.'.$cid.'.num'};
2713: }
2714: my $value = $accesshash{$entry};
2715: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2716: my %temphash=($url => $value);
2717: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2718: if ($result eq 'ok') {
2719: delete $accesshash{$entry};
2720: } elsif ($result eq 'unknown_cmd') {
2721: # Target server has old code running on it.
2722: my %temphash=($entry => $value);
2723: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2724: delete $accesshash{$entry};
2725: }
2726: }
2727: } else {
2728: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2729: my %temphash=($entry => $accesshash{$entry});
2730: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2731: delete $accesshash{$entry};
2732: }
2733: }
2734: }
2735: #
2736: # Roles
2737: # Reverse lookup of user roles for course faculty/staff and co-authorship
2738: #
2739: foreach my $entry (keys(%userrolehash)) {
2740: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2741: split(/\:/,$entry);
2742: if (&Apache::lonnet::put('nohist_userroles',
2743: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2744: $rudom,$runame) eq 'ok') {
2745: delete $userrolehash{$entry};
2746: }
2747: }
2748: #
2749: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2750: #
2751: my %domrolebuffer = ();
2752: foreach my $entry (keys(%domainrolehash)) {
2753: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2754: if ($domrolebuffer{$rudom}) {
2755: $domrolebuffer{$rudom}.='&'.&escape($entry).
2756: '='.&escape($domainrolehash{$entry});
2757: } else {
2758: $domrolebuffer{$rudom}.=&escape($entry).
2759: '='.&escape($domainrolehash{$entry});
2760: }
2761: delete $domainrolehash{$entry};
2762: }
2763: foreach my $dom (keys(%domrolebuffer)) {
2764: my %servers = &get_servers($dom,'library');
2765: foreach my $tryserver (keys(%servers)) {
2766: unless (&reply('domroleput:'.$dom.':'.
2767: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2768: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2769: }
2770: }
2771: }
2772: $dumpcount++;
2773: }
2774:
2775: sub courselog {
2776: my $what=shift;
2777: $what=time.':'.$what;
2778: unless ($env{'request.course.id'}) { return ''; }
2779: $coursedombuf{$env{'request.course.id'}}=
2780: $env{'course.'.$env{'request.course.id'}.'.domain'};
2781: $coursenumbuf{$env{'request.course.id'}}=
2782: $env{'course.'.$env{'request.course.id'}.'.num'};
2783: $coursehombuf{$env{'request.course.id'}}=
2784: $env{'course.'.$env{'request.course.id'}.'.home'};
2785: $coursedescrbuf{$env{'request.course.id'}}=
2786: $env{'course.'.$env{'request.course.id'}.'.description'};
2787: $courseinstcodebuf{$env{'request.course.id'}}=
2788: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2789: $courseownerbuf{$env{'request.course.id'}}=
2790: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2791: $coursetypebuf{$env{'request.course.id'}}=
2792: $env{'course.'.$env{'request.course.id'}.'.type'};
2793: if (defined $courselogs{$env{'request.course.id'}}) {
2794: $courselogs{$env{'request.course.id'}}.='&'.$what;
2795: } else {
2796: $courselogs{$env{'request.course.id'}}.=$what;
2797: }
2798: if (length($courselogs{$env{'request.course.id'}})>4048) {
2799: &flushcourselogs();
2800: }
2801: }
2802:
2803: sub courseacclog {
2804: my $fnsymb=shift;
2805: unless ($env{'request.course.id'}) { return ''; }
2806: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2807: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2808: $what.=':POST';
2809: # FIXME: Probably ought to escape things....
2810: foreach my $key (keys(%env)) {
2811: if ($key=~/^form\.(.*)/) {
2812: my $formitem = $1;
2813: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2814: $what.=':'.$formitem.'='.$env{$key};
2815: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2816: $what.=':'.$formitem.'='.$env{$key};
2817: }
2818: }
2819: }
2820: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2821: # FIXME: We should not be depending on a form parameter that someone
2822: # editing lonsearchcat.pm might change in the future.
2823: if ($env{'form.phase'} eq 'course_search') {
2824: $what.= ':POST';
2825: # FIXME: Probably ought to escape things....
2826: foreach my $element ('courseexp','crsfulltext','crsrelated',
2827: 'crsdiscuss') {
2828: $what.=':'.$element.'='.$env{'form.'.$element};
2829: }
2830: }
2831: }
2832: &courselog($what);
2833: }
2834:
2835: sub countacc {
2836: my $url=&declutter(shift);
2837: return if (! defined($url) || $url eq '');
2838: unless ($env{'request.course.id'}) { return ''; }
2839: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2840: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2841: $accesshash{$key}++;
2842: }
2843:
2844: sub linklog {
2845: my ($from,$to)=@_;
2846: $from=&declutter($from);
2847: $to=&declutter($to);
2848: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2849: $accesshash{$to.'___'.$from.'___goto'}=1;
2850: }
2851:
2852: sub userrolelog {
2853: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2854: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2855: ($trole=~/^in/) || ($trole=~/^cc/) ||
2856: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2857: ($trole=~/^ta/) || ($trole=~/^co/)) {
2858: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2859: $userrolehash
2860: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2861: =$tend.':'.$tstart;
2862: }
2863: if (($env{'request.role'} =~ /dc\./) &&
2864: (($trole=~/^au/) || ($trole=~/^in/) ||
2865: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2866: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2867: ($trole=~/^co/))) {
2868: $userrolehash
2869: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2870: =$tend.':'.$tstart;
2871: }
2872: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2873: ($trole=~/^li/) || ($trole=~/^li/) ||
2874: ($trole=~/^au/) || ($trole=~/^dg/) ||
2875: ($trole=~/^sc/)) {
2876: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2877: $domainrolehash
2878: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2879: = $tend.':'.$tstart;
2880: }
2881: }
2882:
2883: sub courserolelog {
2884: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2885: if (($trole eq 'cc') || ($trole eq 'in') ||
2886: ($trole eq 'ep') || ($trole eq 'ad') ||
2887: ($trole eq 'ta') || ($trole eq 'st') ||
2888: ($trole=~/^cr/) || ($trole eq 'gr') ||
2889: ($trole eq 'co')) {
2890: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2891: my $cdom = $1;
2892: my $cnum = $2;
2893: my $sec = $3;
2894: my $namespace = 'rolelog';
2895: my %storehash = (
2896: role => $trole,
2897: start => $tstart,
2898: end => $tend,
2899: selfenroll => $selfenroll,
2900: context => $context,
2901: );
2902: if ($trole eq 'gr') {
2903: $namespace = 'groupslog';
2904: $storehash{'group'} = $sec;
2905: } else {
2906: $storehash{'section'} = $sec;
2907: }
2908: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
2909: if (($trole ne 'st') || ($sec ne '')) {
2910: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2911: }
2912: }
2913: }
2914: return;
2915: }
2916:
2917: sub get_course_adv_roles {
2918: my ($cid,$codes) = @_;
2919: $cid=$env{'request.course.id'} unless (defined($cid));
2920: my %coursehash=&coursedescription($cid);
2921: my $crstype = &Apache::loncommon::course_type($cid);
2922: my %nothide=();
2923: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2924: if ($user !~ /:/) {
2925: $nothide{join(':',split(/[\@]/,$user))}=1;
2926: } else {
2927: $nothide{$user}=1;
2928: }
2929: }
2930: my %returnhash=();
2931: my %dumphash=
2932: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2933: my $now=time;
2934: my %privileged;
2935: foreach my $entry (keys(%dumphash)) {
2936: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2937: if (($tstart) && ($tstart<0)) { next; }
2938: if (($tend) && ($tend<$now)) { next; }
2939: if (($tstart) && ($now<$tstart)) { next; }
2940: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2941: if ($username eq '' || $domain eq '') { next; }
2942: unless (ref($privileged{$domain}) eq 'HASH') {
2943: my %dompersonnel =
2944: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2945: $privileged{$domain} = {};
2946: foreach my $server (keys(%dompersonnel)) {
2947: if (ref($dompersonnel{$server}) eq 'HASH') {
2948: foreach my $user (keys(%{$dompersonnel{$server}})) {
2949: my ($trole,$uname,$udom) = split(/:/,$user);
2950: $privileged{$udom}{$uname} = 1;
2951: }
2952: }
2953: }
2954: }
2955: if ((exists($privileged{$domain}{$username})) &&
2956: (!$nothide{$username.':'.$domain})) { next; }
2957: if ($role eq 'cr') { next; }
2958: if ($codes) {
2959: if ($section) { $role .= ':'.$section; }
2960: if ($returnhash{$role}) {
2961: $returnhash{$role}.=','.$username.':'.$domain;
2962: } else {
2963: $returnhash{$role}=$username.':'.$domain;
2964: }
2965: } else {
2966: my $key=&plaintext($role,$crstype);
2967: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2968: if ($returnhash{$key}) {
2969: $returnhash{$key}.=','.$username.':'.$domain;
2970: } else {
2971: $returnhash{$key}=$username.':'.$domain;
2972: }
2973: }
2974: }
2975: return %returnhash;
2976: }
2977:
2978: sub get_my_roles {
2979: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2980: unless (defined($uname)) { $uname=$env{'user.name'}; }
2981: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2982: my (%dumphash,%nothide);
2983: if ($context eq 'userroles') {
2984: %dumphash = &dump('roles',$udom,$uname);
2985: } else {
2986: %dumphash=
2987: &dump('nohist_userroles',$udom,$uname);
2988: if ($hidepriv) {
2989: my %coursehash=&coursedescription($udom.'_'.$uname);
2990: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2991: if ($user !~ /:/) {
2992: $nothide{join(':',split(/[\@]/,$user))} = 1;
2993: } else {
2994: $nothide{$user} = 1;
2995: }
2996: }
2997: }
2998: }
2999: my %returnhash=();
3000: my $now=time;
3001: my %privileged;
3002: foreach my $entry (keys(%dumphash)) {
3003: my ($role,$tend,$tstart);
3004: if ($context eq 'userroles') {
3005: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
3006: } else {
3007: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3008: }
3009: if (($tstart) && ($tstart<0)) { next; }
3010: my $status = 'active';
3011: if (($tend) && ($tend<=$now)) {
3012: $status = 'previous';
3013: }
3014: if (($tstart) && ($now<$tstart)) {
3015: $status = 'future';
3016: }
3017: if (ref($types) eq 'ARRAY') {
3018: if (!grep(/^\Q$status\E$/,@{$types})) {
3019: next;
3020: }
3021: } else {
3022: if ($status ne 'active') {
3023: next;
3024: }
3025: }
3026: my ($rolecode,$username,$domain,$section,$area);
3027: if ($context eq 'userroles') {
3028: ($area,$rolecode) = split(/_/,$entry);
3029: (undef,$domain,$username,$section) = split(/\//,$area);
3030: } else {
3031: ($role,$username,$domain,$section) = split(/\:/,$entry);
3032: }
3033: if (ref($roledoms) eq 'ARRAY') {
3034: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
3035: next;
3036: }
3037: }
3038: if (ref($roles) eq 'ARRAY') {
3039: if (!grep(/^\Q$role\E$/,@{$roles})) {
3040: if ($role =~ /^cr\//) {
3041: if (!grep(/^cr$/,@{$roles})) {
3042: next;
3043: }
3044: } else {
3045: next;
3046: }
3047: }
3048: }
3049: if ($hidepriv) {
3050: if ($context eq 'userroles') {
3051: if ((&privileged($username,$domain)) &&
3052: (!$nothide{$username.':'.$domain})) {
3053: next;
3054: }
3055: } else {
3056: unless (ref($privileged{$domain}) eq 'HASH') {
3057: my %dompersonnel =
3058: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3059: $privileged{$domain} = {};
3060: if (keys(%dompersonnel)) {
3061: foreach my $server (keys(%dompersonnel)) {
3062: if (ref($dompersonnel{$server}) eq 'HASH') {
3063: foreach my $user (keys(%{$dompersonnel{$server}})) {
3064: my ($trole,$uname,$udom) = split(/:/,$user);
3065: $privileged{$udom}{$uname} = $trole;
3066: }
3067: }
3068: }
3069: }
3070: }
3071: if (exists($privileged{$domain}{$username})) {
3072: if (!$nothide{$username.':'.$domain}) {
3073: next;
3074: }
3075: }
3076: }
3077: }
3078: if ($withsec) {
3079: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
3080: $tstart.':'.$tend;
3081: } else {
3082: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
3083: }
3084: }
3085: return %returnhash;
3086: }
3087:
3088: # ----------------------------------------------------- Frontpage Announcements
3089: #
3090: #
3091:
3092: sub postannounce {
3093: my ($server,$text)=@_;
3094: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
3095: unless ($text=~/\w/) { $text=''; }
3096: return &reply('setannounce:'.&escape($text),$server);
3097: }
3098:
3099: sub getannounce {
3100:
3101: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
3102: my $announcement='';
3103: while (my $line = <$fh>) { $announcement .= $line; }
3104: close($fh);
3105: if ($announcement=~/\w/) {
3106: return
3107: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
3108: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
3109: } else {
3110: return '';
3111: }
3112: } else {
3113: return '';
3114: }
3115: }
3116:
3117: # ---------------------------------------------------------- Course ID routines
3118: # Deal with domain's nohist_courseid.db files
3119: #
3120:
3121: sub courseidput {
3122: my ($domain,$storehash,$coursehome,$caller) = @_;
3123: return unless (ref($storehash) eq 'HASH');
3124: my $outcome;
3125: if ($caller eq 'timeonly') {
3126: my $cids = '';
3127: foreach my $item (keys(%$storehash)) {
3128: $cids.=&escape($item).'&';
3129: }
3130: $cids=~s/\&$//;
3131: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3132: $coursehome);
3133: } else {
3134: my $items = '';
3135: foreach my $item (keys(%$storehash)) {
3136: $items.= &escape($item).'='.
3137: &freeze_escape($$storehash{$item}).'&';
3138: }
3139: $items=~s/\&$//;
3140: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3141: $coursehome);
3142: }
3143: if ($outcome eq 'unknown_cmd') {
3144: my $what;
3145: foreach my $cid (keys(%$storehash)) {
3146: $what .= &escape($cid).'=';
3147: foreach my $item ('description','inst_code','owner','type') {
3148: $what .= &escape($storehash->{$cid}{$item}).':';
3149: }
3150: $what =~ s/\:$/&/;
3151: }
3152: $what =~ s/\&$//;
3153: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3154: } else {
3155: return $outcome;
3156: }
3157: }
3158:
3159: sub courseiddump {
3160: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3161: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3162: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3163: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
3164: my $as_hash = 1;
3165: my %returnhash;
3166: if (!$domfilter) { $domfilter=''; }
3167: my %libserv = &all_library();
3168: foreach my $tryserver (keys(%libserv)) {
3169: if ( ( $hostidflag == 1
3170: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3171: || (!defined($hostidflag)) ) {
3172:
3173: if (($domfilter eq '') ||
3174: (&host_domain($tryserver) eq $domfilter)) {
3175: my $rep =
3176: &reply('courseiddump:'.&host_domain($tryserver).':'.
3177: $sincefilter.':'.&escape($descfilter).':'.
3178: &escape($instcodefilter).':'.&escape($ownerfilter).
3179: ':'.&escape($coursefilter).':'.&escape($typefilter).
3180: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3181: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3182: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3183: &escape($cc_clone).':'.$cloneonly.':'.
3184: &escape($createdbefore).':'.&escape($createdafter).':'.
3185: &escape($creationcontext).':'.$domcloner,
3186: $tryserver);
3187: my @pairs=split(/\&/,$rep);
3188: foreach my $item (@pairs) {
3189: my ($key,$value)=split(/\=/,$item,2);
3190: $key = &unescape($key);
3191: next if ($key =~ /^error: 2 /);
3192: my $result = &thaw_unescape($value);
3193: if (ref($result) eq 'HASH') {
3194: $returnhash{$key}=$result;
3195: } else {
3196: my @responses = split(/:/,$value);
3197: my @items = ('description','inst_code','owner','type');
3198: for (my $i=0; $i<@responses; $i++) {
3199: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3200: }
3201: }
3202: }
3203: }
3204: }
3205: }
3206: return %returnhash;
3207: }
3208:
3209: sub courselastaccess {
3210: my ($cdom,$cnum,$hostidref) = @_;
3211: my %returnhash;
3212: if ($cdom && $cnum) {
3213: my $chome = &homeserver($cnum,$cdom);
3214: if ($chome ne 'no_host') {
3215: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3216: &extract_lastaccess(\%returnhash,$rep);
3217: }
3218: } else {
3219: if (!$cdom) { $cdom=''; }
3220: my %libserv = &all_library();
3221: foreach my $tryserver (keys(%libserv)) {
3222: if (ref($hostidref) eq 'ARRAY') {
3223: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3224: }
3225: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3226: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3227: &extract_lastaccess(\%returnhash,$rep);
3228: }
3229: }
3230: }
3231: return %returnhash;
3232: }
3233:
3234: sub extract_lastaccess {
3235: my ($returnhash,$rep) = @_;
3236: if (ref($returnhash) eq 'HASH') {
3237: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3238: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3239: $rep eq '') {
3240: my @pairs=split(/\&/,$rep);
3241: foreach my $item (@pairs) {
3242: my ($key,$value)=split(/\=/,$item,2);
3243: $key = &unescape($key);
3244: next if ($key =~ /^error: 2 /);
3245: $returnhash->{$key} = &thaw_unescape($value);
3246: }
3247: }
3248: }
3249: return;
3250: }
3251:
3252: # ---------------------------------------------------------- DC e-mail
3253:
3254: sub dcmailput {
3255: my ($domain,$msgid,$message,$server)=@_;
3256: my $status = &Apache::lonnet::critical(
3257: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3258: &escape($message),$server);
3259: return $status;
3260: }
3261:
3262: sub dcmaildump {
3263: my ($dom,$startdate,$enddate,$senders) = @_;
3264: my %returnhash=();
3265:
3266: if (defined(&domain($dom,'primary'))) {
3267: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3268: &escape($enddate).':';
3269: my @esc_senders=map { &escape($_)} @$senders;
3270: $cmd.=&escape(join('&',@esc_senders));
3271: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3272: my ($key,$value) = split(/\=/,$line,2);
3273: if (($key) && ($value)) {
3274: $returnhash{&unescape($key)} = &unescape($value);
3275: }
3276: }
3277: }
3278: return %returnhash;
3279: }
3280: # ---------------------------------------------------------- Domain roles
3281:
3282: sub get_domain_roles {
3283: my ($dom,$roles,$startdate,$enddate)=@_;
3284: if ((!defined($startdate)) || ($startdate eq '')) {
3285: $startdate = '.';
3286: }
3287: if ((!defined($enddate)) || ($enddate eq '')) {
3288: $enddate = '.';
3289: }
3290: my $rolelist;
3291: if (ref($roles) eq 'ARRAY') {
3292: $rolelist = join(':',@{$roles});
3293: }
3294: my %personnel = ();
3295:
3296: my %servers = &get_servers($dom,'library');
3297: foreach my $tryserver (keys(%servers)) {
3298: %{$personnel{$tryserver}}=();
3299: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3300: &escape($startdate).':'.
3301: &escape($enddate).':'.
3302: &escape($rolelist), $tryserver))) {
3303: my ($key,$value) = split(/\=/,$line,2);
3304: if (($key) && ($value)) {
3305: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3306: }
3307: }
3308: }
3309: return %personnel;
3310: }
3311:
3312: # ----------------------------------------------------------- Interval timing
3313:
3314: sub get_first_access {
3315: my ($type,$argsymb)=@_;
3316: my ($symb,$courseid,$udom,$uname)=&whichuser();
3317: if ($argsymb) { $symb=$argsymb; }
3318: my ($map,$id,$res)=&decode_symb($symb);
3319: if ($type eq 'course') {
3320: $res='course';
3321: } elsif ($type eq 'map') {
3322: $res=&symbread($map);
3323: } else {
3324: $res=$symb;
3325: }
3326: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3327: return $times{"$courseid\0$res"};
3328: }
3329:
3330: sub set_first_access {
3331: my ($type)=@_;
3332: my ($symb,$courseid,$udom,$uname)=&whichuser();
3333: my ($map,$id,$res)=&decode_symb($symb);
3334: if ($type eq 'course') {
3335: $res='course';
3336: } elsif ($type eq 'map') {
3337: $res=&symbread($map);
3338: } else {
3339: $res=$symb;
3340: }
3341: my $firstaccess=&get_first_access($type,$symb);
3342: if (!$firstaccess) {
3343: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3344: }
3345: return 'already_set';
3346: }
3347:
3348: # --------------------------------------------- Set Expire Date for Spreadsheet
3349:
3350: sub expirespread {
3351: my ($uname,$udom,$stype,$usymb)=@_;
3352: my $cid=$env{'request.course.id'};
3353: if ($cid) {
3354: my $now=time;
3355: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3356: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3357: $env{'course.'.$cid.'.num'}.
3358: ':nohist_expirationdates:'.
3359: &escape($key).'='.$now,
3360: $env{'course.'.$cid.'.home'})
3361: }
3362: return 'ok';
3363: }
3364:
3365: # ----------------------------------------------------- Devalidate Spreadsheets
3366:
3367: sub devalidate {
3368: my ($symb,$uname,$udom)=@_;
3369: my $cid=$env{'request.course.id'};
3370: if ($cid) {
3371: # delete the stored spreadsheets for
3372: # - the student level sheet of this user in course's homespace
3373: # - the assessment level sheet for this resource
3374: # for this user in user's homespace
3375: # - current conditional state info
3376: my $key=$uname.':'.$udom.':';
3377: my $status=
3378: &del('nohist_calculatedsheets',
3379: [$key.'studentcalc:'],
3380: $env{'course.'.$cid.'.domain'},
3381: $env{'course.'.$cid.'.num'})
3382: .' '.
3383: &del('nohist_calculatedsheets_'.$cid,
3384: [$key.'assesscalc:'.$symb],$udom,$uname);
3385: unless ($status eq 'ok ok') {
3386: &logthis('Could not devalidate spreadsheet '.
3387: $uname.' at '.$udom.' for '.
3388: $symb.': '.$status);
3389: }
3390: &delenv('user.state.'.$cid);
3391: }
3392: }
3393:
3394: sub get_scalar {
3395: my ($string,$end) = @_;
3396: my $value;
3397: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3398: $value = $1;
3399: } elsif ($$string =~ s/^([^&]*?)&//) {
3400: $value = $1;
3401: }
3402: return &unescape($value);
3403: }
3404:
3405: sub array2str {
3406: my (@array) = @_;
3407: my $result=&arrayref2str(\@array);
3408: $result=~s/^__ARRAY_REF__//;
3409: $result=~s/__END_ARRAY_REF__$//;
3410: return $result;
3411: }
3412:
3413: sub arrayref2str {
3414: my ($arrayref) = @_;
3415: my $result='__ARRAY_REF__';
3416: foreach my $elem (@$arrayref) {
3417: if(ref($elem) eq 'ARRAY') {
3418: $result.=&arrayref2str($elem).'&';
3419: } elsif(ref($elem) eq 'HASH') {
3420: $result.=&hashref2str($elem).'&';
3421: } elsif(ref($elem)) {
3422: #print("Got a ref of ".(ref($elem))." skipping.");
3423: } else {
3424: $result.=&escape($elem).'&';
3425: }
3426: }
3427: $result=~s/\&$//;
3428: $result .= '__END_ARRAY_REF__';
3429: return $result;
3430: }
3431:
3432: sub hash2str {
3433: my (%hash) = @_;
3434: my $result=&hashref2str(\%hash);
3435: $result=~s/^__HASH_REF__//;
3436: $result=~s/__END_HASH_REF__$//;
3437: return $result;
3438: }
3439:
3440: sub hashref2str {
3441: my ($hashref)=@_;
3442: my $result='__HASH_REF__';
3443: foreach my $key (sort(keys(%$hashref))) {
3444: if (ref($key) eq 'ARRAY') {
3445: $result.=&arrayref2str($key).'=';
3446: } elsif (ref($key) eq 'HASH') {
3447: $result.=&hashref2str($key).'=';
3448: } elsif (ref($key)) {
3449: $result.='=';
3450: #print("Got a ref of ".(ref($key))." skipping.");
3451: } else {
3452: if ($key) {$result.=&escape($key).'=';} else { last; }
3453: }
3454:
3455: if(ref($hashref->{$key}) eq 'ARRAY') {
3456: $result.=&arrayref2str($hashref->{$key}).'&';
3457: } elsif(ref($hashref->{$key}) eq 'HASH') {
3458: $result.=&hashref2str($hashref->{$key}).'&';
3459: } elsif(ref($hashref->{$key})) {
3460: $result.='&';
3461: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3462: } else {
3463: $result.=&escape($hashref->{$key}).'&';
3464: }
3465: }
3466: $result=~s/\&$//;
3467: $result .= '__END_HASH_REF__';
3468: return $result;
3469: }
3470:
3471: sub str2hash {
3472: my ($string)=@_;
3473: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3474: return %$hash;
3475: }
3476:
3477: sub str2hashref {
3478: my ($string) = @_;
3479:
3480: my %hash;
3481:
3482: if($string !~ /^__HASH_REF__/) {
3483: if (! ($string eq '' || !defined($string))) {
3484: $hash{'error'}='Not hash reference';
3485: }
3486: return (\%hash, $string);
3487: }
3488:
3489: $string =~ s/^__HASH_REF__//;
3490:
3491: while($string !~ /^__END_HASH_REF__/) {
3492: #key
3493: my $key='';
3494: if($string =~ /^__HASH_REF__/) {
3495: ($key, $string)=&str2hashref($string);
3496: if(defined($key->{'error'})) {
3497: $hash{'error'}='Bad data';
3498: return (\%hash, $string);
3499: }
3500: } elsif($string =~ /^__ARRAY_REF__/) {
3501: ($key, $string)=&str2arrayref($string);
3502: if($key->[0] eq 'Array reference error') {
3503: $hash{'error'}='Bad data';
3504: return (\%hash, $string);
3505: }
3506: } else {
3507: $string =~ s/^(.*?)=//;
3508: $key=&unescape($1);
3509: }
3510: $string =~ s/^=//;
3511:
3512: #value
3513: my $value='';
3514: if($string =~ /^__HASH_REF__/) {
3515: ($value, $string)=&str2hashref($string);
3516: if(defined($value->{'error'})) {
3517: $hash{'error'}='Bad data';
3518: return (\%hash, $string);
3519: }
3520: } elsif($string =~ /^__ARRAY_REF__/) {
3521: ($value, $string)=&str2arrayref($string);
3522: if($value->[0] eq 'Array reference error') {
3523: $hash{'error'}='Bad data';
3524: return (\%hash, $string);
3525: }
3526: } else {
3527: $value=&get_scalar(\$string,'__END_HASH_REF__');
3528: }
3529: $string =~ s/^&//;
3530:
3531: $hash{$key}=$value;
3532: }
3533:
3534: $string =~ s/^__END_HASH_REF__//;
3535:
3536: return (\%hash, $string);
3537: }
3538:
3539: sub str2array {
3540: my ($string)=@_;
3541: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3542: return @$array;
3543: }
3544:
3545: sub str2arrayref {
3546: my ($string) = @_;
3547: my @array;
3548:
3549: if($string !~ /^__ARRAY_REF__/) {
3550: if (! ($string eq '' || !defined($string))) {
3551: $array[0]='Array reference error';
3552: }
3553: return (\@array, $string);
3554: }
3555:
3556: $string =~ s/^__ARRAY_REF__//;
3557:
3558: while($string !~ /^__END_ARRAY_REF__/) {
3559: my $value='';
3560: if($string =~ /^__HASH_REF__/) {
3561: ($value, $string)=&str2hashref($string);
3562: if(defined($value->{'error'})) {
3563: $array[0] ='Array reference error';
3564: return (\@array, $string);
3565: }
3566: } elsif($string =~ /^__ARRAY_REF__/) {
3567: ($value, $string)=&str2arrayref($string);
3568: if($value->[0] eq 'Array reference error') {
3569: $array[0] ='Array reference error';
3570: return (\@array, $string);
3571: }
3572: } else {
3573: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3574: }
3575: $string =~ s/^&//;
3576:
3577: push(@array, $value);
3578: }
3579:
3580: $string =~ s/^__END_ARRAY_REF__//;
3581:
3582: return (\@array, $string);
3583: }
3584:
3585: # -------------------------------------------------------------------Temp Store
3586:
3587: sub tmpreset {
3588: my ($symb,$namespace,$domain,$stuname) = @_;
3589: if (!$symb) {
3590: $symb=&symbread();
3591: if (!$symb) { $symb= $env{'request.url'}; }
3592: }
3593: $symb=escape($symb);
3594:
3595: if (!$namespace) { $namespace=$env{'request.state'}; }
3596: $namespace=~s/\//\_/g;
3597: $namespace=~s/\W//g;
3598:
3599: if (!$domain) { $domain=$env{'user.domain'}; }
3600: if (!$stuname) { $stuname=$env{'user.name'}; }
3601: if ($domain eq 'public' && $stuname eq 'public') {
3602: $stuname=$ENV{'REMOTE_ADDR'};
3603: }
3604: my $path=$perlvar{'lonDaemons'}.'/tmp';
3605: my %hash;
3606: if (tie(%hash,'GDBM_File',
3607: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3608: &GDBM_WRCREAT(),0640)) {
3609: foreach my $key (keys(%hash)) {
3610: if ($key=~ /:$symb/) {
3611: delete($hash{$key});
3612: }
3613: }
3614: }
3615: }
3616:
3617: sub tmpstore {
3618: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3619:
3620: if (!$symb) {
3621: $symb=&symbread();
3622: if (!$symb) { $symb= $env{'request.url'}; }
3623: }
3624: $symb=escape($symb);
3625:
3626: if (!$namespace) {
3627: # I don't think we would ever want to store this for a course.
3628: # it seems this will only be used if we don't have a course.
3629: #$namespace=$env{'request.course.id'};
3630: #if (!$namespace) {
3631: $namespace=$env{'request.state'};
3632: #}
3633: }
3634: $namespace=~s/\//\_/g;
3635: $namespace=~s/\W//g;
3636: if (!$domain) { $domain=$env{'user.domain'}; }
3637: if (!$stuname) { $stuname=$env{'user.name'}; }
3638: if ($domain eq 'public' && $stuname eq 'public') {
3639: $stuname=$ENV{'REMOTE_ADDR'};
3640: }
3641: my $now=time;
3642: my %hash;
3643: my $path=$perlvar{'lonDaemons'}.'/tmp';
3644: if (tie(%hash,'GDBM_File',
3645: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3646: &GDBM_WRCREAT(),0640)) {
3647: $hash{"version:$symb"}++;
3648: my $version=$hash{"version:$symb"};
3649: my $allkeys='';
3650: foreach my $key (keys(%$storehash)) {
3651: $allkeys.=$key.':';
3652: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3653: }
3654: $hash{"$version:$symb:timestamp"}=$now;
3655: $allkeys.='timestamp';
3656: $hash{"$version:keys:$symb"}=$allkeys;
3657: if (untie(%hash)) {
3658: return 'ok';
3659: } else {
3660: return "error:$!";
3661: }
3662: } else {
3663: return "error:$!";
3664: }
3665: }
3666:
3667: # -----------------------------------------------------------------Temp Restore
3668:
3669: sub tmprestore {
3670: my ($symb,$namespace,$domain,$stuname) = @_;
3671:
3672: if (!$symb) {
3673: $symb=&symbread();
3674: if (!$symb) { $symb= $env{'request.url'}; }
3675: }
3676: $symb=escape($symb);
3677:
3678: if (!$namespace) { $namespace=$env{'request.state'}; }
3679:
3680: if (!$domain) { $domain=$env{'user.domain'}; }
3681: if (!$stuname) { $stuname=$env{'user.name'}; }
3682: if ($domain eq 'public' && $stuname eq 'public') {
3683: $stuname=$ENV{'REMOTE_ADDR'};
3684: }
3685: my %returnhash;
3686: $namespace=~s/\//\_/g;
3687: $namespace=~s/\W//g;
3688: my %hash;
3689: my $path=$perlvar{'lonDaemons'}.'/tmp';
3690: if (tie(%hash,'GDBM_File',
3691: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3692: &GDBM_READER(),0640)) {
3693: my $version=$hash{"version:$symb"};
3694: $returnhash{'version'}=$version;
3695: my $scope;
3696: for ($scope=1;$scope<=$version;$scope++) {
3697: my $vkeys=$hash{"$scope:keys:$symb"};
3698: my @keys=split(/:/,$vkeys);
3699: my $key;
3700: $returnhash{"$scope:keys"}=$vkeys;
3701: foreach $key (@keys) {
3702: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3703: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3704: }
3705: }
3706: if (!(untie(%hash))) {
3707: return "error:$!";
3708: }
3709: } else {
3710: return "error:$!";
3711: }
3712: return %returnhash;
3713: }
3714:
3715: # ----------------------------------------------------------------------- Store
3716:
3717: sub store {
3718: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3719: my $home='';
3720:
3721: if ($stuname) { $home=&homeserver($stuname,$domain); }
3722:
3723: $symb=&symbclean($symb);
3724: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3725:
3726: if (!$domain) { $domain=$env{'user.domain'}; }
3727: if (!$stuname) { $stuname=$env{'user.name'}; }
3728:
3729: &devalidate($symb,$stuname,$domain);
3730:
3731: $symb=escape($symb);
3732: if (!$namespace) {
3733: unless ($namespace=$env{'request.course.id'}) {
3734: return '';
3735: }
3736: }
3737: if (!$home) { $home=$env{'user.home'}; }
3738:
3739: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3740: $$storehash{'host'}=$perlvar{'lonHostID'};
3741:
3742: my $namevalue='';
3743: foreach my $key (keys(%$storehash)) {
3744: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3745: }
3746: $namevalue=~s/\&$//;
3747: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3748: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3749: }
3750:
3751: # -------------------------------------------------------------- Critical Store
3752:
3753: sub cstore {
3754: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3755: my $home='';
3756:
3757: if ($stuname) { $home=&homeserver($stuname,$domain); }
3758:
3759: $symb=&symbclean($symb);
3760: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3761:
3762: if (!$domain) { $domain=$env{'user.domain'}; }
3763: if (!$stuname) { $stuname=$env{'user.name'}; }
3764:
3765: &devalidate($symb,$stuname,$domain);
3766:
3767: $symb=escape($symb);
3768: if (!$namespace) {
3769: unless ($namespace=$env{'request.course.id'}) {
3770: return '';
3771: }
3772: }
3773: if (!$home) { $home=$env{'user.home'}; }
3774:
3775: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3776: $$storehash{'host'}=$perlvar{'lonHostID'};
3777:
3778: my $namevalue='';
3779: foreach my $key (keys(%$storehash)) {
3780: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3781: }
3782: $namevalue=~s/\&$//;
3783: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3784: return critical
3785: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3786: }
3787:
3788: # --------------------------------------------------------------------- Restore
3789:
3790: sub restore {
3791: my ($symb,$namespace,$domain,$stuname) = @_;
3792: my $home='';
3793:
3794: if ($stuname) { $home=&homeserver($stuname,$domain); }
3795:
3796: if (!$symb) {
3797: unless ($symb=escape(&symbread())) { return ''; }
3798: } else {
3799: $symb=&escape(&symbclean($symb));
3800: }
3801: if (!$namespace) {
3802: unless ($namespace=$env{'request.course.id'}) {
3803: return '';
3804: }
3805: }
3806: if (!$domain) { $domain=$env{'user.domain'}; }
3807: if (!$stuname) { $stuname=$env{'user.name'}; }
3808: if (!$home) { $home=$env{'user.home'}; }
3809: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3810:
3811: my %returnhash=();
3812: foreach my $line (split(/\&/,$answer)) {
3813: my ($name,$value)=split(/\=/,$line);
3814: $returnhash{&unescape($name)}=&thaw_unescape($value);
3815: }
3816: my $version;
3817: for ($version=1;$version<=$returnhash{'version'};$version++) {
3818: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3819: $returnhash{$item}=$returnhash{$version.':'.$item};
3820: }
3821: }
3822: return %returnhash;
3823: }
3824:
3825: # ---------------------------------------------------------- Course Description
3826:
3827: sub coursedescription {
3828: my ($courseid,$args)=@_;
3829: $courseid=~s/^\///;
3830: $courseid=~s/\_/\//g;
3831: my ($cdomain,$cnum)=split(/\//,$courseid);
3832: my $chome=&homeserver($cnum,$cdomain);
3833: my $normalid=$cdomain.'_'.$cnum;
3834: # need to always cache even if we get errors otherwise we keep
3835: # trying and trying and trying to get the course description.
3836: my %envhash=();
3837: my %returnhash=();
3838:
3839: my $expiretime=600;
3840: if ($env{'request.course.id'} eq $normalid) {
3841: $expiretime=120;
3842: }
3843:
3844: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3845: if (!$args->{'freshen_cache'}
3846: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3847: foreach my $key (keys(%env)) {
3848: next if ($key !~ /^\Q$prefix\E(.*)/);
3849: my ($setting) = $1;
3850: $returnhash{$setting} = $env{$key};
3851: }
3852: return %returnhash;
3853: }
3854:
3855: # get the data agin
3856: if (!$args->{'one_time'}) {
3857: $envhash{'course.'.$normalid.'.last_cache'}=time;
3858: }
3859:
3860: if ($chome ne 'no_host') {
3861: %returnhash=&dump('environment',$cdomain,$cnum);
3862: if (!exists($returnhash{'con_lost'})) {
3863: $returnhash{'home'}= $chome;
3864: $returnhash{'domain'} = $cdomain;
3865: $returnhash{'num'} = $cnum;
3866: if (!defined($returnhash{'type'})) {
3867: $returnhash{'type'} = 'Course';
3868: }
3869: while (my ($name,$value) = each %returnhash) {
3870: $envhash{'course.'.$normalid.'.'.$name}=$value;
3871: }
3872: $returnhash{'url'}=&clutter($returnhash{'url'});
3873: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3874: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3875: $envhash{'course.'.$normalid.'.home'}=$chome;
3876: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3877: $envhash{'course.'.$normalid.'.num'}=$cnum;
3878: }
3879: }
3880: if (!$args->{'one_time'}) {
3881: &appenv(\%envhash);
3882: }
3883: return %returnhash;
3884: }
3885:
3886: # -------------------------------------------------See if a user is privileged
3887:
3888: sub privileged {
3889: my ($username,$domain)=@_;
3890: my $rolesdump=&reply("dump:$domain:$username:roles",
3891: &homeserver($username,$domain));
3892: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3893: ($rolesdump =~ /^error:/)) {
3894: return 0;
3895: }
3896: my $now=time;
3897: if ($rolesdump ne '') {
3898: foreach my $entry (split(/&/,$rolesdump)) {
3899: if ($entry!~/^rolesdef_/) {
3900: my ($area,$role)=split(/=/,$entry);
3901: $area=~s/\_\w\w$//;
3902: my ($trole,$tend,$tstart)=split(/_/,$role);
3903: if (($trole eq 'dc') || ($trole eq 'su')) {
3904: my $active=1;
3905: if ($tend) {
3906: if ($tend<$now) { $active=0; }
3907: }
3908: if ($tstart) {
3909: if ($tstart>$now) { $active=0; }
3910: }
3911: if ($active) { return 1; }
3912: }
3913: }
3914: }
3915: }
3916: return 0;
3917: }
3918:
3919: # -------------------------------------------------------- Get user privileges
3920:
3921: sub rolesinit {
3922: my ($domain,$username,$authhost)=@_;
3923: my $now=time;
3924: my %userroles = ('user.login.time' => $now);
3925: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3926: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3927: ($rolesdump =~ /^error:/)) {
3928: return \%userroles;
3929: }
3930: my %allroles=();
3931: my %allgroups=();
3932: my $group_privs;
3933:
3934: if ($rolesdump ne '') {
3935: foreach my $entry (split(/&/,$rolesdump)) {
3936: if ($entry!~/^rolesdef_/) {
3937: my ($area,$role)=split(/=/,$entry);
3938: $area=~s/\_\w\w$//;
3939: my ($trole,$tend,$tstart,$group_privs);
3940: if ($role=~/^cr/) {
3941: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3942: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3943: ($tend,$tstart)=split('_',$trest);
3944: } else {
3945: $trole=$role;
3946: }
3947: } elsif ($role =~ m|^gr/|) {
3948: ($trole,$tend,$tstart) = split(/_/,$role);
3949: ($trole,$group_privs) = split(/\//,$trole);
3950: $group_privs = &unescape($group_privs);
3951: } else {
3952: ($trole,$tend,$tstart)=split(/_/,$role);
3953: }
3954: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3955: $username);
3956: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3957: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3958: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3959: if (($area ne '') && ($trole ne '')) {
3960: my $spec=$trole.'.'.$area;
3961: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3962: if ($trole =~ /^cr\//) {
3963: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3964: } elsif ($trole eq 'gr') {
3965: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3966: } else {
3967: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3968: }
3969: }
3970: }
3971: }
3972: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3973: $userroles{'user.adv'} = $adv;
3974: $userroles{'user.author'} = $author;
3975: $env{'user.adv'}=$adv;
3976: }
3977: return \%userroles;
3978: }
3979:
3980: sub set_arearole {
3981: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3982: # log the associated role with the area
3983: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3984: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3985: }
3986:
3987: sub custom_roleprivs {
3988: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3989: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3990: my $homsvr=homeserver($rauthor,$rdomain);
3991: if (&hostname($homsvr) ne '') {
3992: my ($rdummy,$roledef)=
3993: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3994: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3995: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3996: if (defined($syspriv)) {
3997: if ($trest =~ /^$match_community$/) {
3998: $syspriv =~ s/bre\&S//;
3999: }
4000: $$allroles{'cm./'}.=':'.$syspriv;
4001: $$allroles{$spec.'./'}.=':'.$syspriv;
4002: }
4003: if ($tdomain ne '') {
4004: if (defined($dompriv)) {
4005: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
4006: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
4007: }
4008: if (($trest ne '') && (defined($coursepriv))) {
4009: $$allroles{'cm.'.$area}.=':'.$coursepriv;
4010: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
4011: }
4012: }
4013: }
4014: }
4015: }
4016:
4017: sub group_roleprivs {
4018: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4019: my $access = 1;
4020: my $now = time;
4021: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4022: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4023: if ($access) {
4024: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
4025: $$allgroups{$course}{$group} .=':'.$group_privs;
4026: }
4027: }
4028:
4029: sub standard_roleprivs {
4030: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4031: if (defined($pr{$trole.':s'})) {
4032: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4033: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4034: }
4035: if ($tdomain ne '') {
4036: if (defined($pr{$trole.':d'})) {
4037: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4038: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4039: }
4040: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4041: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4042: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4043: }
4044: }
4045: }
4046:
4047: sub set_userprivs {
4048: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
4049: my $author=0;
4050: my $adv=0;
4051: my %grouproles = ();
4052: if (keys(%{$allgroups}) > 0) {
4053: my @groupkeys;
4054: foreach my $role (keys(%{$allroles})) {
4055: push(@groupkeys,$role);
4056: }
4057: if (ref($groups_roles) eq 'HASH') {
4058: foreach my $key (keys(%{$groups_roles})) {
4059: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4060: push(@groupkeys,$key);
4061: }
4062: }
4063: }
4064: if (@groupkeys > 0) {
4065: foreach my $role (@groupkeys) {
4066: my ($trole,$area,$sec,$extendedarea);
4067: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4068: $trole = $1;
4069: $area = $2;
4070: $sec = $3;
4071: $extendedarea = $area.$sec;
4072: if (exists($$allgroups{$area})) {
4073: foreach my $group (keys(%{$$allgroups{$area}})) {
4074: my $spec = $trole.'.'.$extendedarea;
4075: $grouproles{$spec.'.'.$area.'/'.$group} =
4076: $$allgroups{$area}{$group};
4077: }
4078: }
4079: }
4080: }
4081: }
4082: }
4083: foreach my $group (keys(%grouproles)) {
4084: $$allroles{$group} = $grouproles{$group};
4085: }
4086: foreach my $role (keys(%{$allroles})) {
4087: my %thesepriv;
4088: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
4089: foreach my $item (split(/:/,$$allroles{$role})) {
4090: if ($item ne '') {
4091: my ($privilege,$restrictions)=split(/&/,$item);
4092: if ($restrictions eq '') {
4093: $thesepriv{$privilege}='F';
4094: } elsif ($thesepriv{$privilege} ne 'F') {
4095: $thesepriv{$privilege}.=$restrictions;
4096: }
4097: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4098: }
4099: }
4100: my $thesestr='';
4101: foreach my $priv (keys(%thesepriv)) {
4102: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4103: }
4104: $userroles->{'user.priv.'.$role} = $thesestr;
4105: }
4106: return ($author,$adv);
4107: }
4108:
4109: sub role_status {
4110: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4111: my @pwhere = ();
4112: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4113: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4114: unless (!defined($$role) || $$role eq '') {
4115: $$where=join('.',@pwhere);
4116: $$trolecode=$$role.'.'.$$where;
4117: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4118: $$tstatus='is';
4119: if ($$tstart && $$tstart>$then) {
4120: $$tstatus='future';
4121: if ($$tstart<$now) {
4122: if ($$tstart && $$tstart>$refresh) {
4123: if (($$where ne '') && ($$role ne '')) {
4124: my (%allroles,%allgroups,$group_privs,
4125: %groups_roles,@rolecodes);
4126: my %userroles = (
4127: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4128: );
4129: @rolecodes = ('cm');
4130: my $spec=$$role.'.'.$$where;
4131: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4132: if ($$role =~ /^cr\//) {
4133: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4134: push(@rolecodes,'cr');
4135: } elsif ($$role eq 'gr') {
4136: push(@rolecodes,$$role);
4137: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4138: $env{'user.name'});
4139: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
4140: (undef,my $group_privs) = split(/\//,$trole);
4141: $group_privs = &unescape($group_privs);
4142: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4143: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4144: if (keys(%course_roles) > 0) {
4145: my ($tnum) = ($trest =~ /^($match_courseid)/);
4146: if ($tdomain ne '' && $tnum ne '') {
4147: foreach my $key (keys(%course_roles)) {
4148: if ($key =~ /^\Q$tnum\E:\Q$tdomain\E:([^:]+):?([^:]*)/) {
4149: my $crsrole = $1;
4150: my $crssec = $2;
4151: if ($crsrole =~ /^cr/) {
4152: unless (grep(/^cr$/,@rolecodes)) {
4153: push(@rolecodes,'cr');
4154: }
4155: } else {
4156: unless(grep(/^\Q$crsrole\E$/,@rolecodes)) {
4157: push(@rolecodes,$crsrole);
4158: }
4159: }
4160: my $rolekey = $crsrole.'./'.$tdomain.'/'.$tnum;
4161: if ($crssec ne '') {
4162: $rolekey .= '/'.$crssec;
4163: }
4164: $rolekey .= './';
4165: $groups_roles{$rolekey} = \@rolecodes;
4166: }
4167: }
4168: }
4169: }
4170: } else {
4171: push(@rolecodes,$$role);
4172: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4173: }
4174: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4175: &appenv(\%userroles,\@rolecodes);
4176: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4177: }
4178: }
4179: $$tstatus = 'is';
4180: }
4181: }
4182: if ($$tend) {
4183: if ($$tend<$then) {
4184: $$tstatus='expired';
4185: } elsif ($$tend<$now) {
4186: $$tstatus='will_not';
4187: }
4188: }
4189: }
4190: }
4191: }
4192:
4193: sub check_adhoc_privs {
4194: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
4195: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4196: if ($env{$cckey}) {
4197: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4198: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4199: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4200: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4201: }
4202: } else {
4203: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4204: }
4205: }
4206:
4207: sub set_adhoc_privileges {
4208: # role can be cc or ca
4209: my ($dcdom,$pickedcourse,$role) = @_;
4210: my $area = '/'.$dcdom.'/'.$pickedcourse;
4211: my $spec = $role.'.'.$area;
4212: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4213: $env{'user.name'});
4214: my %ccrole = ();
4215: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4216: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4217: &appenv(\%userroles,[$role,'cm']);
4218: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4219: &appenv( {'request.role' => $spec,
4220: 'request.role.domain' => $dcdom,
4221: 'request.course.sec' => ''
4222: }
4223: );
4224: my $tadv=0;
4225: if (&allowed('adv') eq 'F') { $tadv=1; }
4226: &appenv({'request.role.adv' => $tadv});
4227: }
4228:
4229: # --------------------------------------------------------------- get interface
4230:
4231: sub get {
4232: my ($namespace,$storearr,$udomain,$uname)=@_;
4233: my $items='';
4234: foreach my $item (@$storearr) {
4235: $items.=&escape($item).'&';
4236: }
4237: $items=~s/\&$//;
4238: if (!$udomain) { $udomain=$env{'user.domain'}; }
4239: if (!$uname) { $uname=$env{'user.name'}; }
4240: my $uhome=&homeserver($uname,$udomain);
4241:
4242: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4243: my @pairs=split(/\&/,$rep);
4244: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4245: return @pairs;
4246: }
4247: my %returnhash=();
4248: my $i=0;
4249: foreach my $item (@$storearr) {
4250: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4251: $i++;
4252: }
4253: return %returnhash;
4254: }
4255:
4256: # --------------------------------------------------------------- del interface
4257:
4258: sub del {
4259: my ($namespace,$storearr,$udomain,$uname)=@_;
4260: my $items='';
4261: foreach my $item (@$storearr) {
4262: $items.=&escape($item).'&';
4263: }
4264:
4265: $items=~s/\&$//;
4266: if (!$udomain) { $udomain=$env{'user.domain'}; }
4267: if (!$uname) { $uname=$env{'user.name'}; }
4268: my $uhome=&homeserver($uname,$udomain);
4269: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4270: }
4271:
4272: # -------------------------------------------------------------- dump interface
4273:
4274: sub dump {
4275: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4276: if (!$udomain) { $udomain=$env{'user.domain'}; }
4277: if (!$uname) { $uname=$env{'user.name'}; }
4278: my $uhome=&homeserver($uname,$udomain);
4279: if ($regexp) {
4280: $regexp=&escape($regexp);
4281: } else {
4282: $regexp='.';
4283: }
4284: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4285: my @pairs=split(/\&/,$rep);
4286: my %returnhash=();
4287: foreach my $item (@pairs) {
4288: my ($key,$value)=split(/=/,$item,2);
4289: $key = &unescape($key);
4290: next if ($key =~ /^error: 2 /);
4291: $returnhash{$key}=&thaw_unescape($value);
4292: }
4293: return %returnhash;
4294: }
4295:
4296: # --------------------------------------------------------- dumpstore interface
4297:
4298: sub dumpstore {
4299: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4300: if (!$udomain) { $udomain=$env{'user.domain'}; }
4301: if (!$uname) { $uname=$env{'user.name'}; }
4302: my $uhome=&homeserver($uname,$udomain);
4303: if ($regexp) {
4304: $regexp=&escape($regexp);
4305: } else {
4306: $regexp='.';
4307: }
4308: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4309: my @pairs=split(/\&/,$rep);
4310: my %returnhash=();
4311: foreach my $item (@pairs) {
4312: my ($key,$value)=split(/=/,$item,2);
4313: next if ($key =~ /^error: 2 /);
4314: $returnhash{$key}=&thaw_unescape($value);
4315: }
4316: return %returnhash;
4317: }
4318:
4319: # -------------------------------------------------------------- keys interface
4320:
4321: sub getkeys {
4322: my ($namespace,$udomain,$uname)=@_;
4323: if (!$udomain) { $udomain=$env{'user.domain'}; }
4324: if (!$uname) { $uname=$env{'user.name'}; }
4325: my $uhome=&homeserver($uname,$udomain);
4326: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4327: my @keyarray=();
4328: foreach my $key (split(/\&/,$rep)) {
4329: next if ($key =~ /^error: 2 /);
4330: push(@keyarray,&unescape($key));
4331: }
4332: return @keyarray;
4333: }
4334:
4335: # --------------------------------------------------------------- currentdump
4336: sub currentdump {
4337: my ($courseid,$sdom,$sname)=@_;
4338: $courseid = $env{'request.course.id'} if (! defined($courseid));
4339: $sdom = $env{'user.domain'} if (! defined($sdom));
4340: $sname = $env{'user.name'} if (! defined($sname));
4341: my $uhome = &homeserver($sname,$sdom);
4342: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4343: return if ($rep =~ /^(error:|no_such_host)/);
4344: #
4345: my %returnhash=();
4346: #
4347: if ($rep eq "unknown_cmd") {
4348: # an old lond will not know currentdump
4349: # Do a dump and make it look like a currentdump
4350: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4351: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4352: my %hash = @tmp;
4353: @tmp=();
4354: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4355: } else {
4356: my @pairs=split(/\&/,$rep);
4357: foreach my $pair (@pairs) {
4358: my ($key,$value)=split(/=/,$pair,2);
4359: my ($symb,$param) = split(/:/,$key);
4360: $returnhash{&unescape($symb)}->{&unescape($param)} =
4361: &thaw_unescape($value);
4362: }
4363: }
4364: return %returnhash;
4365: }
4366:
4367: sub convert_dump_to_currentdump{
4368: my %hash = %{shift()};
4369: my %returnhash;
4370: # Code ripped from lond, essentially. The only difference
4371: # here is the unescaping done by lonnet::dump(). Conceivably
4372: # we might run in to problems with parameter names =~ /^v\./
4373: while (my ($key,$value) = each(%hash)) {
4374: my ($v,$symb,$param) = split(/:/,$key);
4375: $symb = &unescape($symb);
4376: $param = &unescape($param);
4377: next if ($v eq 'version' || $symb eq 'keys');
4378: next if (exists($returnhash{$symb}) &&
4379: exists($returnhash{$symb}->{$param}) &&
4380: $returnhash{$symb}->{'v.'.$param} > $v);
4381: $returnhash{$symb}->{$param}=$value;
4382: $returnhash{$symb}->{'v.'.$param}=$v;
4383: }
4384: #
4385: # Remove all of the keys in the hashes which keep track of
4386: # the version of the parameter.
4387: while (my ($symb,$param_hash) = each(%returnhash)) {
4388: # use a foreach because we are going to delete from the hash.
4389: foreach my $key (keys(%$param_hash)) {
4390: delete($param_hash->{$key}) if ($key =~ /^v\./);
4391: }
4392: }
4393: return \%returnhash;
4394: }
4395:
4396: # ------------------------------------------------------ critical inc interface
4397:
4398: sub cinc {
4399: return &inc(@_,'critical');
4400: }
4401:
4402: # --------------------------------------------------------------- inc interface
4403:
4404: sub inc {
4405: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4406: if (!$udomain) { $udomain=$env{'user.domain'}; }
4407: if (!$uname) { $uname=$env{'user.name'}; }
4408: my $uhome=&homeserver($uname,$udomain);
4409: my $items='';
4410: if (! ref($store)) {
4411: # got a single value, so use that instead
4412: $items = &escape($store).'=&';
4413: } elsif (ref($store) eq 'SCALAR') {
4414: $items = &escape($$store).'=&';
4415: } elsif (ref($store) eq 'ARRAY') {
4416: $items = join('=&',map {&escape($_);} @{$store});
4417: } elsif (ref($store) eq 'HASH') {
4418: while (my($key,$value) = each(%{$store})) {
4419: $items.= &escape($key).'='.&escape($value).'&';
4420: }
4421: }
4422: $items=~s/\&$//;
4423: if ($critical) {
4424: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4425: } else {
4426: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4427: }
4428: }
4429:
4430: # --------------------------------------------------------------- put interface
4431:
4432: sub put {
4433: my ($namespace,$storehash,$udomain,$uname)=@_;
4434: if (!$udomain) { $udomain=$env{'user.domain'}; }
4435: if (!$uname) { $uname=$env{'user.name'}; }
4436: my $uhome=&homeserver($uname,$udomain);
4437: my $items='';
4438: foreach my $item (keys(%$storehash)) {
4439: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4440: }
4441: $items=~s/\&$//;
4442: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4443: }
4444:
4445: # ------------------------------------------------------------ newput interface
4446:
4447: sub newput {
4448: my ($namespace,$storehash,$udomain,$uname)=@_;
4449: if (!$udomain) { $udomain=$env{'user.domain'}; }
4450: if (!$uname) { $uname=$env{'user.name'}; }
4451: my $uhome=&homeserver($uname,$udomain);
4452: my $items='';
4453: foreach my $key (keys(%$storehash)) {
4454: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4455: }
4456: $items=~s/\&$//;
4457: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4458: }
4459:
4460: # --------------------------------------------------------- putstore interface
4461:
4462: sub putstore {
4463: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4464: if (!$udomain) { $udomain=$env{'user.domain'}; }
4465: if (!$uname) { $uname=$env{'user.name'}; }
4466: my $uhome=&homeserver($uname,$udomain);
4467: my $items='';
4468: foreach my $key (keys(%$storehash)) {
4469: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4470: }
4471: $items=~s/\&$//;
4472: my $esc_symb=&escape($symb);
4473: my $esc_v=&escape($version);
4474: my $reply =
4475: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4476: $uhome);
4477: if ($reply eq 'unknown_cmd') {
4478: # gfall back to way things use to be done
4479: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4480: $uname);
4481: }
4482: return $reply;
4483: }
4484:
4485: sub old_putstore {
4486: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4487: if (!$udomain) { $udomain=$env{'user.domain'}; }
4488: if (!$uname) { $uname=$env{'user.name'}; }
4489: my $uhome=&homeserver($uname,$udomain);
4490: my %newstorehash;
4491: foreach my $item (keys(%$storehash)) {
4492: my $key = $version.':'.&escape($symb).':'.$item;
4493: $newstorehash{$key} = $storehash->{$item};
4494: }
4495: my $items='';
4496: my %allitems = ();
4497: foreach my $item (keys(%newstorehash)) {
4498: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4499: my $key = $1.':keys:'.$2;
4500: $allitems{$key} .= $3.':';
4501: }
4502: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4503: }
4504: foreach my $item (keys(%allitems)) {
4505: $allitems{$item} =~ s/\:$//;
4506: $items.= $item.'='.$allitems{$item}.'&';
4507: }
4508: $items=~s/\&$//;
4509: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4510: }
4511:
4512: # ------------------------------------------------------ critical put interface
4513:
4514: sub cput {
4515: my ($namespace,$storehash,$udomain,$uname)=@_;
4516: if (!$udomain) { $udomain=$env{'user.domain'}; }
4517: if (!$uname) { $uname=$env{'user.name'}; }
4518: my $uhome=&homeserver($uname,$udomain);
4519: my $items='';
4520: foreach my $item (keys(%$storehash)) {
4521: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4522: }
4523: $items=~s/\&$//;
4524: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4525: }
4526:
4527: # -------------------------------------------------------------- eget interface
4528:
4529: sub eget {
4530: my ($namespace,$storearr,$udomain,$uname)=@_;
4531: my $items='';
4532: foreach my $item (@$storearr) {
4533: $items.=&escape($item).'&';
4534: }
4535: $items=~s/\&$//;
4536: if (!$udomain) { $udomain=$env{'user.domain'}; }
4537: if (!$uname) { $uname=$env{'user.name'}; }
4538: my $uhome=&homeserver($uname,$udomain);
4539: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4540: my @pairs=split(/\&/,$rep);
4541: my %returnhash=();
4542: my $i=0;
4543: foreach my $item (@$storearr) {
4544: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4545: $i++;
4546: }
4547: return %returnhash;
4548: }
4549:
4550: # ------------------------------------------------------------ tmpput interface
4551: sub tmpput {
4552: my ($storehash,$server,$context)=@_;
4553: my $items='';
4554: foreach my $item (keys(%$storehash)) {
4555: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4556: }
4557: $items=~s/\&$//;
4558: if (defined($context)) {
4559: $items .= ':'.&escape($context);
4560: }
4561: return &reply("tmpput:$items",$server);
4562: }
4563:
4564: # ------------------------------------------------------------ tmpget interface
4565: sub tmpget {
4566: my ($token,$server)=@_;
4567: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4568: my $rep=&reply("tmpget:$token",$server);
4569: my %returnhash;
4570: foreach my $item (split(/\&/,$rep)) {
4571: my ($key,$value)=split(/=/,$item);
4572: next if ($key =~ /^error: 2 /);
4573: $returnhash{&unescape($key)}=&thaw_unescape($value);
4574: }
4575: return %returnhash;
4576: }
4577:
4578: # ------------------------------------------------------------ tmpget interface
4579: sub tmpdel {
4580: my ($token,$server)=@_;
4581: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4582: return &reply("tmpdel:$token",$server);
4583: }
4584:
4585: # -------------------------------------------------- portfolio access checking
4586:
4587: sub portfolio_access {
4588: my ($requrl) = @_;
4589: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4590: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4591: if ($result) {
4592: my %setters;
4593: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4594: my ($startblock,$endblock) =
4595: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4596: if ($startblock && $endblock) {
4597: return 'B';
4598: }
4599: } else {
4600: my ($startblock,$endblock) =
4601: &Apache::loncommon::blockcheck(\%setters,'port');
4602: if ($startblock && $endblock) {
4603: return 'B';
4604: }
4605: }
4606: }
4607: if ($result eq 'ok') {
4608: return 'F';
4609: } elsif ($result =~ /^[^:]+:guest_/) {
4610: return 'A';
4611: }
4612: return '';
4613: }
4614:
4615: sub get_portfolio_access {
4616: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4617:
4618: if (!ref($access_hash)) {
4619: my $current_perms = &get_portfile_permissions($udom,$unum);
4620: my %access_controls = &get_access_controls($current_perms,$group,
4621: $file_name);
4622: $access_hash = $access_controls{$file_name};
4623: }
4624:
4625: my ($public,$guest,@domains,@users,@courses,@groups);
4626: my $now = time;
4627: if (ref($access_hash) eq 'HASH') {
4628: foreach my $key (keys(%{$access_hash})) {
4629: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4630: if ($start > $now) {
4631: next;
4632: }
4633: if ($end && $end<$now) {
4634: next;
4635: }
4636: if ($scope eq 'public') {
4637: $public = $key;
4638: last;
4639: } elsif ($scope eq 'guest') {
4640: $guest = $key;
4641: } elsif ($scope eq 'domains') {
4642: push(@domains,$key);
4643: } elsif ($scope eq 'users') {
4644: push(@users,$key);
4645: } elsif ($scope eq 'course') {
4646: push(@courses,$key);
4647: } elsif ($scope eq 'group') {
4648: push(@groups,$key);
4649: }
4650: }
4651: if ($public) {
4652: return 'ok';
4653: }
4654: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4655: if ($guest) {
4656: return $guest;
4657: }
4658: } else {
4659: if (@domains > 0) {
4660: foreach my $domkey (@domains) {
4661: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4662: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4663: return 'ok';
4664: }
4665: }
4666: }
4667: }
4668: if (@users > 0) {
4669: foreach my $userkey (@users) {
4670: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4671: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4672: if (ref($item) eq 'HASH') {
4673: if (($item->{'uname'} eq $env{'user.name'}) &&
4674: ($item->{'udom'} eq $env{'user.domain'})) {
4675: return 'ok';
4676: }
4677: }
4678: }
4679: }
4680: }
4681: }
4682: my %roleshash;
4683: my @courses_and_groups = @courses;
4684: push(@courses_and_groups,@groups);
4685: if (@courses_and_groups > 0) {
4686: my (%allgroups,%allroles);
4687: my ($start,$end,$role,$sec,$group);
4688: foreach my $envkey (%env) {
4689: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4690: my $cid = $2.'_'.$3;
4691: if ($1 eq 'gr') {
4692: $group = $4;
4693: $allgroups{$cid}{$group} = $env{$envkey};
4694: } else {
4695: if ($4 eq '') {
4696: $sec = 'none';
4697: } else {
4698: $sec = $4;
4699: }
4700: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4701: }
4702: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4703: my $cid = $2.'_'.$3;
4704: if ($4 eq '') {
4705: $sec = 'none';
4706: } else {
4707: $sec = $4;
4708: }
4709: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4710: }
4711: }
4712: if (keys(%allroles) == 0) {
4713: return;
4714: }
4715: foreach my $key (@courses_and_groups) {
4716: my %content = %{$$access_hash{$key}};
4717: my $cnum = $content{'number'};
4718: my $cdom = $content{'domain'};
4719: my $cid = $cdom.'_'.$cnum;
4720: if (!exists($allroles{$cid})) {
4721: next;
4722: }
4723: foreach my $role_id (keys(%{$content{'roles'}})) {
4724: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4725: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4726: my @status = @{$content{'roles'}{$role_id}{'access'}};
4727: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4728: foreach my $role (keys(%{$allroles{$cid}})) {
4729: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4730: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4731: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4732: if (grep/^all$/,@sections) {
4733: return 'ok';
4734: } else {
4735: if (grep/^$sec$/,@sections) {
4736: return 'ok';
4737: }
4738: }
4739: }
4740: }
4741: if (keys(%{$allgroups{$cid}}) == 0) {
4742: if (grep/^none$/,@groups) {
4743: return 'ok';
4744: }
4745: } else {
4746: if (grep/^all$/,@groups) {
4747: return 'ok';
4748: }
4749: foreach my $group (keys(%{$allgroups{$cid}})) {
4750: if (grep/^$group$/,@groups) {
4751: return 'ok';
4752: }
4753: }
4754: }
4755: }
4756: }
4757: }
4758: }
4759: }
4760: if ($guest) {
4761: return $guest;
4762: }
4763: }
4764: }
4765: return;
4766: }
4767:
4768: sub course_group_datechecker {
4769: my ($dates,$now,$status) = @_;
4770: my ($start,$end) = split(/\./,$dates);
4771: if (!$start && !$end) {
4772: return 'ok';
4773: }
4774: if (grep/^active$/,@{$status}) {
4775: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4776: return 'ok';
4777: }
4778: }
4779: if (grep/^previous$/,@{$status}) {
4780: if ($end > $now ) {
4781: return 'ok';
4782: }
4783: }
4784: if (grep/^future$/,@{$status}) {
4785: if ($start > $now) {
4786: return 'ok';
4787: }
4788: }
4789: return;
4790: }
4791:
4792: sub parse_portfolio_url {
4793: my ($url) = @_;
4794:
4795: my ($type,$udom,$unum,$group,$file_name);
4796:
4797: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4798: $type = 1;
4799: $udom = $1;
4800: $unum = $2;
4801: $file_name = $3;
4802: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4803: $type = 2;
4804: $udom = $1;
4805: $unum = $2;
4806: $group = $3;
4807: $file_name = $3.'/'.$4;
4808: }
4809: if (wantarray) {
4810: return ($type,$udom,$unum,$file_name,$group);
4811: }
4812: return $type;
4813: }
4814:
4815: sub is_portfolio_url {
4816: my ($url) = @_;
4817: return scalar(&parse_portfolio_url($url));
4818: }
4819:
4820: sub is_portfolio_file {
4821: my ($file) = @_;
4822: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4823: return 1;
4824: }
4825: return;
4826: }
4827:
4828: sub usertools_access {
4829: my ($uname,$udom,$tool,$action,$context) = @_;
4830: my ($access,%tools);
4831: if ($context eq '') {
4832: $context = 'tools';
4833: }
4834: if ($context eq 'requestcourses') {
4835: %tools = (
4836: official => 1,
4837: unofficial => 1,
4838: community => 1,
4839: );
4840: } else {
4841: %tools = (
4842: aboutme => 1,
4843: blog => 1,
4844: portfolio => 1,
4845: );
4846: }
4847: return if (!defined($tools{$tool}));
4848:
4849: if ((!defined($udom)) || (!defined($uname))) {
4850: $udom = $env{'user.domain'};
4851: $uname = $env{'user.name'};
4852: }
4853:
4854: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4855: if ($action ne 'reload') {
4856: if ($context eq 'requestcourses') {
4857: return $env{'environment.canrequest.'.$tool};
4858: } else {
4859: return $env{'environment.availabletools.'.$tool};
4860: }
4861: }
4862: }
4863:
4864: my ($toolstatus,$inststatus);
4865:
4866: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4867: ($action ne 'reload')) {
4868: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4869: $inststatus = $env{'environment.inststatus'};
4870: } else {
4871: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
4872: $toolstatus = $userenv{$context.'.'.$tool};
4873: $inststatus = $userenv{'inststatus'};
4874: }
4875:
4876: if ($toolstatus ne '') {
4877: if ($toolstatus) {
4878: $access = 1;
4879: } else {
4880: $access = 0;
4881: }
4882: return $access;
4883: }
4884:
4885: my $is_adv = &is_advanced_user($udom,$uname);
4886: my %domdef = &get_domain_defaults($udom);
4887: if (ref($domdef{$tool}) eq 'HASH') {
4888: if ($is_adv) {
4889: if ($domdef{$tool}{'_LC_adv'} ne '') {
4890: if ($domdef{$tool}{'_LC_adv'}) {
4891: $access = 1;
4892: } else {
4893: $access = 0;
4894: }
4895: return $access;
4896: }
4897: }
4898: if ($inststatus ne '') {
4899: my ($hasaccess,$hasnoaccess);
4900: foreach my $affiliation (split(/:/,$inststatus)) {
4901: if ($domdef{$tool}{$affiliation} ne '') {
4902: if ($domdef{$tool}{$affiliation}) {
4903: $hasaccess = 1;
4904: } else {
4905: $hasnoaccess = 1;
4906: }
4907: }
4908: }
4909: if ($hasaccess || $hasnoaccess) {
4910: if ($hasaccess) {
4911: $access = 1;
4912: } elsif ($hasnoaccess) {
4913: $access = 0;
4914: }
4915: return $access;
4916: }
4917: } else {
4918: if ($domdef{$tool}{'default'} ne '') {
4919: if ($domdef{$tool}{'default'}) {
4920: $access = 1;
4921: } elsif ($domdef{$tool}{'default'} == 0) {
4922: $access = 0;
4923: }
4924: return $access;
4925: }
4926: }
4927: } else {
4928: if ($context eq 'tools') {
4929: $access = 1;
4930: } else {
4931: $access = 0;
4932: }
4933: return $access;
4934: }
4935: }
4936:
4937: sub is_course_owner {
4938: my ($cdom,$cnum,$udom,$uname) = @_;
4939: if (($udom eq '') || ($uname eq '')) {
4940: $udom = $env{'user.domain'};
4941: $uname = $env{'user.name'};
4942: }
4943: unless (($udom eq '') || ($uname eq '')) {
4944: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4945: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4946: return 1;
4947: } else {
4948: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4949: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4950: return 1;
4951: }
4952: }
4953: }
4954: }
4955: return;
4956: }
4957:
4958: sub is_advanced_user {
4959: my ($udom,$uname) = @_;
4960: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4961: my %allroles;
4962: my $is_adv;
4963: foreach my $role (keys(%roleshash)) {
4964: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4965: my $area = '/'.$tdomain.'/'.$trest;
4966: if ($sec ne '') {
4967: $area .= '/'.$sec;
4968: }
4969: if (($area ne '') && ($trole ne '')) {
4970: my $spec=$trole.'.'.$area;
4971: if ($trole =~ /^cr\//) {
4972: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4973: } elsif ($trole ne 'gr') {
4974: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4975: }
4976: }
4977: }
4978: foreach my $role (keys(%allroles)) {
4979: last if ($is_adv);
4980: foreach my $item (split(/:/,$allroles{$role})) {
4981: if ($item ne '') {
4982: my ($privilege,$restrictions)=split(/&/,$item);
4983: if ($privilege eq 'adv') {
4984: $is_adv = 1;
4985: last;
4986: }
4987: }
4988: }
4989: }
4990: return $is_adv;
4991: }
4992:
4993: sub check_can_request {
4994: my ($dom,$can_request,$request_domains) = @_;
4995: my $canreq = 0;
4996: my ($types,$typename) = &Apache::loncommon::course_types();
4997: my @options = ('approval','validate','autolimit');
4998: my $optregex = join('|',@options);
4999: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
5000: foreach my $type (@{$types}) {
5001: if (&usertools_access($env{'user.name'},
5002: $env{'user.domain'},
5003: $type,undef,'requestcourses')) {
5004: $canreq ++;
5005: if (ref($request_domains) eq 'HASH') {
5006: push(@{$request_domains->{$type}},$env{'user.domain'});
5007: }
5008: if ($dom eq $env{'user.domain'}) {
5009: $can_request->{$type} = 1;
5010: }
5011: }
5012: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
5013: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
5014: if (@curr > 0) {
5015: foreach my $item (@curr) {
5016: if (ref($request_domains) eq 'HASH') {
5017: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5018: if ($otherdom ne '') {
5019: if (ref($request_domains->{$type}) eq 'ARRAY') {
5020: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5021: push(@{$request_domains->{$type}},$otherdom);
5022: }
5023: } else {
5024: push(@{$request_domains->{$type}},$otherdom);
5025: }
5026: }
5027: }
5028: }
5029: unless($dom eq $env{'user.domain'}) {
5030: $canreq ++;
5031: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5032: $can_request->{$type} = 1;
5033: }
5034: }
5035: }
5036: }
5037: }
5038: }
5039: return $canreq;
5040: }
5041:
5042: # ---------------------------------------------- Custom access rule evaluation
5043:
5044: sub customaccess {
5045: my ($priv,$uri)=@_;
5046: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
5047: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
5048: $udom = &LONCAPA::clean_domain($udom);
5049: $ucrs = &LONCAPA::clean_username($ucrs);
5050: my $access=0;
5051: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
5052: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5053: if ($type eq 'user') {
5054: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5055: my ($tdom,$tuname)=split(m{/},$scope);
5056: if ($tdom) {
5057: if ($tdom ne $env{'user.domain'}) { next; }
5058: }
5059: if ($tuname) {
5060: if ($tuname ne $env{'user.name'}) { next; }
5061: }
5062: $access=($effect eq 'allow');
5063: last;
5064: }
5065: } else {
5066: if ($role) {
5067: if ($role ne $urole) { next; }
5068: }
5069: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5070: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5071: if ($tdom) {
5072: if ($tdom ne $udom) { next; }
5073: }
5074: if ($tcrs) {
5075: if ($tcrs ne $ucrs) { next; }
5076: }
5077: if ($tsec) {
5078: if ($tsec ne $usec) { next; }
5079: }
5080: $access=($effect eq 'allow');
5081: last;
5082: }
5083: if ($realm eq '' && $role eq '') {
5084: $access=($effect eq 'allow');
5085: }
5086: }
5087: }
5088: return $access;
5089: }
5090:
5091: # ------------------------------------------------- Check for a user privilege
5092:
5093: sub allowed {
5094: my ($priv,$uri,$symb,$role)=@_;
5095: my $ver_orguri=$uri;
5096: $uri=&deversion($uri);
5097: my $orguri=$uri;
5098: $uri=&declutter($uri);
5099:
5100: if ($priv eq 'evb') {
5101: # Evade communication block restrictions for specified role in a course
5102: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5103: return $1;
5104: } else {
5105: return;
5106: }
5107: }
5108:
5109: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
5110: # Free bre access to adm and meta resources
5111: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
5112: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5113: && ($priv eq 'bre')) {
5114: return 'F';
5115: }
5116:
5117: # Free bre access to user's own portfolio contents
5118: my ($space,$domain,$name,@dir)=split('/',$uri);
5119: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
5120: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
5121: my %setters;
5122: my ($startblock,$endblock) =
5123: &Apache::loncommon::blockcheck(\%setters,'port');
5124: if ($startblock && $endblock) {
5125: return 'B';
5126: } else {
5127: return 'F';
5128: }
5129: }
5130:
5131: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
5132: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5133: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5134: if (exists($env{'request.course.id'})) {
5135: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5136: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5137: if (($domain eq $cdom) && ($name eq $cnum)) {
5138: my $courseprivid=$env{'request.course.id'};
5139: $courseprivid=~s/\_/\//;
5140: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5141: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5142: return $1;
5143: } else {
5144: if ($env{'request.course.sec'}) {
5145: $courseprivid.='/'.$env{'request.course.sec'};
5146: }
5147: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5148: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5149: return $2;
5150: }
5151: }
5152: }
5153: }
5154: }
5155:
5156: # Free bre to public access
5157:
5158: if ($priv eq 'bre') {
5159: my $copyright=&metadata($uri,'copyright');
5160: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5161: return 'F';
5162: }
5163: if ($copyright eq 'priv') {
5164: $uri=~/([^\/]+)\/([^\/]+)\//;
5165: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5166: return '';
5167: }
5168: }
5169: if ($copyright eq 'domain') {
5170: $uri=~/([^\/]+)\/([^\/]+)\//;
5171: unless (($env{'user.domain'} eq $1) ||
5172: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5173: return '';
5174: }
5175: }
5176: if ($env{'request.role'}=~ /li\.\//) {
5177: # Library role, so allow browsing of resources in this domain.
5178: return 'F';
5179: }
5180: if ($copyright eq 'custom') {
5181: unless (&customaccess($priv,$uri)) { return ''; }
5182: }
5183: }
5184: # Domain coordinator is trying to create a course
5185: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5186: # uri is the requested domain in this case.
5187: # comparison to 'request.role.domain' shows if the user has selected
5188: # a role of dc for the domain in question.
5189: return 'F' if ($uri eq $env{'request.role.domain'});
5190: }
5191:
5192: my $thisallowed='';
5193: my $statecond=0;
5194: my $courseprivid='';
5195:
5196: my $ownaccess;
5197: # Community Coordinator or Assistant Co-author browsing resource space.
5198: if (($priv eq 'bro') && ($env{'user.author'})) {
5199: if ($uri eq '') {
5200: $ownaccess = 1;
5201: } else {
5202: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5203: my $udom = $env{'user.domain'};
5204: my $uname = $env{'user.name'};
5205: if ($uri =~ m{^\Q$udom\E/?$}) {
5206: $ownaccess = 1;
5207: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
5208: unless ($uri =~ m{\.\./}) {
5209: $ownaccess = 1;
5210: }
5211: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5212: my $now = time;
5213: if ($uri =~ m{^([^/]+)/?$}) {
5214: my $adom = $1;
5215: foreach my $key (keys(%env)) {
5216: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
5217: my ($start,$end) = split('.',$env{$key});
5218: if (($now >= $start) && (!$end || $end < $now)) {
5219: $ownaccess = 1;
5220: last;
5221: }
5222: }
5223: }
5224: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5225: my $adom = $1;
5226: my $aname = $2;
5227: foreach my $role ('ca','aa') {
5228: if ($env{"user.role.$role./$adom/$aname"}) {
5229: my ($start,$end) =
5230: split('.',$env{"user.role.$role./$adom/$aname"});
5231: if (($now >= $start) && (!$end || $end < $now)) {
5232: $ownaccess = 1;
5233: last;
5234: }
5235: }
5236: }
5237: }
5238: }
5239: }
5240: }
5241: }
5242:
5243: # Course
5244:
5245: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5246: unless (($priv eq 'bro') && (!$ownaccess)) {
5247: $thisallowed.=$1;
5248: }
5249: }
5250:
5251: # Domain
5252:
5253: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5254: =~/\Q$priv\E\&([^\:]*)/) {
5255: unless (($priv eq 'bro') && (!$ownaccess)) {
5256: $thisallowed.=$1;
5257: }
5258: }
5259:
5260: # Course: uri itself is a course
5261: my $courseuri=$uri;
5262: $courseuri=~s/\_(\d)/\/$1/;
5263: $courseuri=~s/^([^\/])/\/$1/;
5264:
5265: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5266: =~/\Q$priv\E\&([^\:]*)/) {
5267: unless (($priv eq 'bro') && (!$ownaccess)) {
5268: $thisallowed.=$1;
5269: }
5270: }
5271:
5272: # URI is an uploaded document for this course, default permissions don't matter
5273: # not allowing 'edit' access (editupload) to uploaded course docs
5274: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5275: $thisallowed='';
5276: my ($match)=&is_on_map($uri);
5277: if ($match) {
5278: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5279: =~/\Q$priv\E\&([^\:]*)/) {
5280: $thisallowed.=$1;
5281: }
5282: } else {
5283: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5284: if ($refuri) {
5285: if ($refuri =~ m|^/adm/|) {
5286: $thisallowed='F';
5287: } else {
5288: $refuri=&declutter($refuri);
5289: my ($match) = &is_on_map($refuri);
5290: if ($match) {
5291: $thisallowed='F';
5292: }
5293: }
5294: }
5295: }
5296: }
5297:
5298: if ($priv eq 'bre'
5299: && $thisallowed ne 'F'
5300: && $thisallowed ne '2'
5301: && &is_portfolio_url($uri)) {
5302: $thisallowed = &portfolio_access($uri);
5303: }
5304:
5305: # Full access at system, domain or course-wide level? Exit.
5306: if ($thisallowed=~/F/) {
5307: return 'F';
5308: }
5309:
5310: # If this is generating or modifying users, exit with special codes
5311:
5312: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5313: if (($priv eq 'cca') || ($priv eq 'caa')) {
5314: my ($audom,$auname)=split('/',$uri);
5315: # no author name given, so this just checks on the general right to make a co-author in this domain
5316: unless ($auname) { return $thisallowed; }
5317: # an author name is given, so we are about to actually make a co-author for a certain account
5318: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5319: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5320: ($audom ne $env{'request.role.domain'}))) { return ''; }
5321: }
5322: return $thisallowed;
5323: }
5324: #
5325: # Gathered so far: system, domain and course wide privileges
5326: #
5327: # Course: See if uri or referer is an individual resource that is part of
5328: # the course
5329:
5330: if ($env{'request.course.id'}) {
5331:
5332: $courseprivid=$env{'request.course.id'};
5333: if ($env{'request.course.sec'}) {
5334: $courseprivid.='/'.$env{'request.course.sec'};
5335: }
5336: $courseprivid=~s/\_/\//;
5337: my $checkreferer=1;
5338: my ($match,$cond)=&is_on_map($uri);
5339: if ($match) {
5340: $statecond=$cond;
5341: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5342: =~/\Q$priv\E\&([^\:]*)/) {
5343: $thisallowed.=$1;
5344: $checkreferer=0;
5345: }
5346: }
5347:
5348: if ($checkreferer) {
5349: my $refuri=$env{'httpref.'.$orguri};
5350: unless ($refuri) {
5351: foreach my $key (keys(%env)) {
5352: if ($key=~/^httpref\..*\*/) {
5353: my $pattern=$key;
5354: $pattern=~s/^httpref\.\/res\///;
5355: $pattern=~s/\*/\[\^\/\]\+/g;
5356: $pattern=~s/\//\\\//g;
5357: if ($orguri=~/$pattern/) {
5358: $refuri=$env{$key};
5359: }
5360: }
5361: }
5362: }
5363:
5364: if ($refuri) {
5365: $refuri=&declutter($refuri);
5366: my ($match,$cond)=&is_on_map($refuri);
5367: if ($match) {
5368: my $refstatecond=$cond;
5369: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5370: =~/\Q$priv\E\&([^\:]*)/) {
5371: $thisallowed.=$1;
5372: $uri=$refuri;
5373: $statecond=$refstatecond;
5374: }
5375: }
5376: }
5377: }
5378: }
5379:
5380: #
5381: # Gathered now: all privileges that could apply, and condition number
5382: #
5383: #
5384: # Full or no access?
5385: #
5386:
5387: if ($thisallowed=~/F/) {
5388: return 'F';
5389: }
5390:
5391: unless ($thisallowed) {
5392: return '';
5393: }
5394:
5395: # Restrictions exist, deal with them
5396: #
5397: # C:according to course preferences
5398: # R:according to resource settings
5399: # L:unless locked
5400: # X:according to user session state
5401: #
5402:
5403: # Possibly locked functionality, check all courses
5404: # Locks might take effect only after 10 minutes cache expiration for other
5405: # courses, and 2 minutes for current course
5406:
5407: my $envkey;
5408: if ($thisallowed=~/L/) {
5409: foreach $envkey (keys(%env)) {
5410: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5411: my $courseid=$2;
5412: my $roleid=$1.'.'.$2;
5413: $courseid=~s/^\///;
5414: my $expiretime=600;
5415: if ($env{'request.role'} eq $roleid) {
5416: $expiretime=120;
5417: }
5418: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5419: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5420: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5421: &coursedescription($courseid,{'freshen_cache' => 1});
5422: }
5423: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5424: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5425: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5426: &log($env{'user.domain'},$env{'user.name'},
5427: $env{'user.home'},
5428: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5429: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5430: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5431: return '';
5432: }
5433: }
5434: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5435: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5436: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5437: &log($env{'user.domain'},$env{'user.name'},
5438: $env{'user.home'},
5439: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5440: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5441: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5442: return '';
5443: }
5444: }
5445: }
5446: }
5447: }
5448:
5449: #
5450: # Rest of the restrictions depend on selected course
5451: #
5452:
5453: unless ($env{'request.course.id'}) {
5454: if ($thisallowed eq 'A') {
5455: return 'A';
5456: } elsif ($thisallowed eq 'B') {
5457: return 'B';
5458: } else {
5459: return '1';
5460: }
5461: }
5462:
5463: #
5464: # Now user is definitely in a course
5465: #
5466:
5467:
5468: # Course preferences
5469:
5470: if ($thisallowed=~/C/) {
5471: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5472: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5473: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5474: =~/\Q$rolecode\E/) {
5475: if ($priv ne 'pch') {
5476: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5477: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5478: $env{'request.course.id'});
5479: }
5480: return '';
5481: }
5482:
5483: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5484: =~/\Q$unamedom\E/) {
5485: if ($priv ne 'pch') {
5486: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5487: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5488: $env{'request.course.id'});
5489: }
5490: return '';
5491: }
5492: }
5493:
5494: # Resource preferences
5495:
5496: if ($thisallowed=~/R/) {
5497: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5498: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5499: if ($priv ne 'pch') {
5500: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5501: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5502: }
5503: return '';
5504: }
5505: }
5506:
5507: # Restricted by state or randomout?
5508:
5509: if ($thisallowed=~/X/) {
5510: if ($env{'acc.randomout'}) {
5511: if (!$symb) { $symb=&symbread($uri,1); }
5512: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5513: return '';
5514: }
5515: }
5516: if (&condval($statecond)) {
5517: return '2';
5518: } else {
5519: return '';
5520: }
5521: }
5522:
5523: if ($thisallowed eq 'A') {
5524: return 'A';
5525: } elsif ($thisallowed eq 'B') {
5526: return 'B';
5527: }
5528: return 'F';
5529: }
5530:
5531: sub split_uri_for_cond {
5532: my $uri=&deversion(&declutter(shift));
5533: my @uriparts=split(/\//,$uri);
5534: my $filename=pop(@uriparts);
5535: my $pathname=join('/',@uriparts);
5536: return ($pathname,$filename);
5537: }
5538: # --------------------------------------------------- Is a resource on the map?
5539:
5540: sub is_on_map {
5541: my ($pathname,$filename) = &split_uri_for_cond(shift);
5542: #Trying to find the conditional for the file
5543: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5544: /\&\Q$filename\E\:([\d\|]+)\&/);
5545: if ($match) {
5546: return (1,$1);
5547: } else {
5548: return (0,0);
5549: }
5550: }
5551:
5552: # --------------------------------------------------------- Get symb from alias
5553:
5554: sub get_symb_from_alias {
5555: my $symb=shift;
5556: my ($map,$resid,$url)=&decode_symb($symb);
5557: # Already is a symb
5558: if ($url) { return $symb; }
5559: # Must be an alias
5560: my $aliassymb='';
5561: my %bighash;
5562: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5563: &GDBM_READER(),0640)) {
5564: my $rid=$bighash{'mapalias_'.$symb};
5565: if ($rid) {
5566: my ($mapid,$resid)=split(/\./,$rid);
5567: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5568: $resid,$bighash{'src_'.$rid});
5569: }
5570: untie %bighash;
5571: }
5572: return $aliassymb;
5573: }
5574:
5575: # ----------------------------------------------------------------- Define Role
5576:
5577: sub definerole {
5578: if (allowed('mcr','/')) {
5579: my ($rolename,$sysrole,$domrole,$courole)=@_;
5580: foreach my $role (split(':',$sysrole)) {
5581: my ($crole,$cqual)=split(/\&/,$role);
5582: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5583: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5584: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5585: return "refused:s:$crole&$cqual";
5586: }
5587: }
5588: }
5589: foreach my $role (split(':',$domrole)) {
5590: my ($crole,$cqual)=split(/\&/,$role);
5591: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5592: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5593: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5594: return "refused:d:$crole&$cqual";
5595: }
5596: }
5597: }
5598: foreach my $role (split(':',$courole)) {
5599: my ($crole,$cqual)=split(/\&/,$role);
5600: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5601: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5602: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5603: return "refused:c:$crole&$cqual";
5604: }
5605: }
5606: }
5607: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5608: "$env{'user.domain'}:$env{'user.name'}:".
5609: "rolesdef_$rolename=".
5610: escape($sysrole.'_'.$domrole.'_'.$courole);
5611: return reply($command,$env{'user.home'});
5612: } else {
5613: return 'refused';
5614: }
5615: }
5616:
5617: # ---------------- Make a metadata query against the network of library servers
5618:
5619: sub metadata_query {
5620: my ($query,$custom,$customshow,$server_array)=@_;
5621: my %rhash;
5622: my %libserv = &all_library();
5623: my @server_list = (defined($server_array) ? @$server_array
5624: : keys(%libserv) );
5625: for my $server (@server_list) {
5626: unless ($custom or $customshow) {
5627: my $reply=&reply("querysend:".&escape($query),$server);
5628: $rhash{$server}=$reply;
5629: }
5630: else {
5631: my $reply=&reply("querysend:".&escape($query).':'.
5632: &escape($custom).':'.&escape($customshow),
5633: $server);
5634: $rhash{$server}=$reply;
5635: }
5636: }
5637: return \%rhash;
5638: }
5639:
5640: # ----------------------------------------- Send log queries and wait for reply
5641:
5642: sub log_query {
5643: my ($uname,$udom,$query,%filters)=@_;
5644: my $uhome=&homeserver($uname,$udom);
5645: if ($uhome eq 'no_host') { return 'error: no_host'; }
5646: my $uhost=&hostname($uhome);
5647: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5648: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5649: $uhome);
5650: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5651: return get_query_reply($queryid);
5652: }
5653:
5654: # -------------------------- Update MySQL table for portfolio file
5655:
5656: sub update_portfolio_table {
5657: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5658: if ($group ne '') {
5659: $file_name =~s /^\Q$group\E//;
5660: }
5661: my $homeserver = &homeserver($uname,$udom);
5662: my $queryid=
5663: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5664: ':'.&escape($file_name).':'.$action,$homeserver);
5665: my $reply = &get_query_reply($queryid);
5666: return $reply;
5667: }
5668:
5669: # -------------------------- Update MySQL allusers table
5670:
5671: sub update_allusers_table {
5672: my ($uname,$udom,$names) = @_;
5673: my $homeserver = &homeserver($uname,$udom);
5674: my $queryid=
5675: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5676: 'lastname='.&escape($names->{'lastname'}).'%%'.
5677: 'firstname='.&escape($names->{'firstname'}).'%%'.
5678: 'middlename='.&escape($names->{'middlename'}).'%%'.
5679: 'generation='.&escape($names->{'generation'}).'%%'.
5680: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5681: 'id='.&escape($names->{'id'}),$homeserver);
5682: my $reply = &get_query_reply($queryid);
5683: return $reply;
5684: }
5685:
5686: # ------- Request retrieval of institutional classlists for course(s)
5687:
5688: sub fetch_enrollment_query {
5689: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5690: my $homeserver;
5691: my $maxtries = 1;
5692: if ($context eq 'automated') {
5693: $homeserver = $perlvar{'lonHostID'};
5694: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5695: } else {
5696: $homeserver = &homeserver($cnum,$dom);
5697: }
5698: my $host=&hostname($homeserver);
5699: my $cmd = '';
5700: foreach my $affiliate (keys(%{$affiliatesref})) {
5701: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5702: }
5703: $cmd =~ s/%%$//;
5704: $cmd = &escape($cmd);
5705: my $query = 'fetchenrollment';
5706: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5707: unless ($queryid=~/^\Q$host\E\_/) {
5708: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5709: return 'error: '.$queryid;
5710: }
5711: my $reply = &get_query_reply($queryid);
5712: my $tries = 1;
5713: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5714: $reply = &get_query_reply($queryid);
5715: $tries ++;
5716: }
5717: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5718: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5719: } else {
5720: my @responses = split(/:/,$reply);
5721: if ($homeserver eq $perlvar{'lonHostID'}) {
5722: foreach my $line (@responses) {
5723: my ($key,$value) = split(/=/,$line,2);
5724: $$replyref{$key} = $value;
5725: }
5726: } else {
5727: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5728: foreach my $line (@responses) {
5729: my ($key,$value) = split(/=/,$line);
5730: $$replyref{$key} = $value;
5731: if ($value > 0) {
5732: foreach my $item (@{$$affiliatesref{$key}}) {
5733: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5734: my $destname = $pathname.'/'.$filename;
5735: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5736: if ($xml_classlist =~ /^error/) {
5737: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5738: } else {
5739: if ( open(FILE,">$destname") ) {
5740: print FILE &unescape($xml_classlist);
5741: close(FILE);
5742: } else {
5743: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5744: }
5745: }
5746: }
5747: }
5748: }
5749: }
5750: return 'ok';
5751: }
5752: return 'error';
5753: }
5754:
5755: sub get_query_reply {
5756: my $queryid=shift;
5757: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5758: my $reply='';
5759: for (1..100) {
5760: sleep 2;
5761: if (-e $replyfile.'.end') {
5762: if (open(my $fh,$replyfile)) {
5763: $reply = join('',<$fh>);
5764: close($fh);
5765: } else { return 'error: reply_file_error'; }
5766: return &unescape($reply);
5767: }
5768: }
5769: return 'timeout:'.$queryid;
5770: }
5771:
5772: sub courselog_query {
5773: #
5774: # possible filters:
5775: # url: url or symb
5776: # username
5777: # domain
5778: # action: view, submit, grade
5779: # start: timestamp
5780: # end: timestamp
5781: #
5782: my (%filters)=@_;
5783: unless ($env{'request.course.id'}) { return 'no_course'; }
5784: if ($filters{'url'}) {
5785: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5786: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5787: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5788: }
5789: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5790: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5791: return &log_query($cname,$cdom,'courselog',%filters);
5792: }
5793:
5794: sub userlog_query {
5795: #
5796: # possible filters:
5797: # action: log check role
5798: # start: timestamp
5799: # end: timestamp
5800: #
5801: my ($uname,$udom,%filters)=@_;
5802: return &log_query($uname,$udom,'userlog',%filters);
5803: }
5804:
5805: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5806:
5807: sub auto_run {
5808: my ($cnum,$cdom) = @_;
5809: my $response = 0;
5810: my $settings;
5811: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5812: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5813: $settings = $domconfig{'autoenroll'};
5814: if ($settings->{'run'} eq '1') {
5815: $response = 1;
5816: }
5817: } else {
5818: my $homeserver;
5819: if (&is_course($cdom,$cnum)) {
5820: $homeserver = &homeserver($cnum,$cdom);
5821: } else {
5822: $homeserver = &domain($cdom,'primary');
5823: }
5824: if ($homeserver ne 'no_host') {
5825: $response = &reply('autorun:'.$cdom,$homeserver);
5826: }
5827: }
5828: return $response;
5829: }
5830:
5831: sub auto_get_sections {
5832: my ($cnum,$cdom,$inst_coursecode) = @_;
5833: my $homeserver;
5834: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5835: $homeserver = &homeserver($cnum,$cdom);
5836: }
5837: if (!defined($homeserver)) {
5838: if ($cdom =~ /^$match_domain$/) {
5839: $homeserver = &domain($cdom,'primary');
5840: }
5841: }
5842: my @secs;
5843: if (defined($homeserver)) {
5844: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5845: unless ($response eq 'refused') {
5846: @secs = split(/:/,$response);
5847: }
5848: }
5849: return @secs;
5850: }
5851:
5852: sub auto_new_course {
5853: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5854: my $homeserver = &homeserver($cnum,$cdom);
5855: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5856: return $response;
5857: }
5858:
5859: sub auto_validate_courseID {
5860: my ($cnum,$cdom,$inst_course_id) = @_;
5861: my $homeserver = &homeserver($cnum,$cdom);
5862: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5863: return $response;
5864: }
5865:
5866: sub auto_validate_instcode {
5867: my ($cnum,$cdom,$instcode,$owner) = @_;
5868: my ($homeserver,$response);
5869: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5870: $homeserver = &homeserver($cnum,$cdom);
5871: }
5872: if (!defined($homeserver)) {
5873: if ($cdom =~ /^$match_domain$/) {
5874: $homeserver = &domain($cdom,'primary');
5875: }
5876: }
5877: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
5878: &escape($instcode).':'.&escape($owner),$homeserver));
5879: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5880: return ($outcome,$description);
5881: }
5882:
5883: sub auto_create_password {
5884: my ($cnum,$cdom,$authparam,$udom) = @_;
5885: my ($homeserver,$response);
5886: my $create_passwd = 0;
5887: my $authchk = '';
5888: if ($udom =~ /^$match_domain$/) {
5889: $homeserver = &domain($udom,'primary');
5890: }
5891: if ($homeserver eq '') {
5892: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5893: $homeserver = &homeserver($cnum,$cdom);
5894: }
5895: }
5896: if ($homeserver eq '') {
5897: $authchk = 'nodomain';
5898: } else {
5899: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5900: if ($response eq 'refused') {
5901: $authchk = 'refused';
5902: } else {
5903: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5904: }
5905: }
5906: return ($authparam,$create_passwd,$authchk);
5907: }
5908:
5909: sub auto_photo_permission {
5910: my ($cnum,$cdom,$students) = @_;
5911: my $homeserver = &homeserver($cnum,$cdom);
5912: my ($outcome,$perm_reqd,$conditions) =
5913: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5914: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5915: return (undef,undef);
5916: }
5917: return ($outcome,$perm_reqd,$conditions);
5918: }
5919:
5920: sub auto_checkphotos {
5921: my ($uname,$udom,$pid) = @_;
5922: my $homeserver = &homeserver($uname,$udom);
5923: my ($result,$resulttype);
5924: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5925: &escape($uname).':'.&escape($pid),
5926: $homeserver));
5927: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5928: return (undef,undef);
5929: }
5930: if ($outcome) {
5931: ($result,$resulttype) = split(/:/,$outcome);
5932: }
5933: return ($result,$resulttype);
5934: }
5935:
5936: sub auto_photochoice {
5937: my ($cnum,$cdom) = @_;
5938: my $homeserver = &homeserver($cnum,$cdom);
5939: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5940: &escape($cdom),
5941: $homeserver)));
5942: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5943: return (undef,undef);
5944: }
5945: return ($update,$comment);
5946: }
5947:
5948: sub auto_photoupdate {
5949: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5950: my $homeserver = &homeserver($cnum,$dom);
5951: my $host=&hostname($homeserver);
5952: my $cmd = '';
5953: my $maxtries = 1;
5954: foreach my $affiliate (keys(%{$affiliatesref})) {
5955: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5956: }
5957: $cmd =~ s/%%$//;
5958: $cmd = &escape($cmd);
5959: my $query = 'institutionalphotos';
5960: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5961: unless ($queryid=~/^\Q$host\E\_/) {
5962: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5963: return 'error: '.$queryid;
5964: }
5965: my $reply = &get_query_reply($queryid);
5966: my $tries = 1;
5967: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5968: $reply = &get_query_reply($queryid);
5969: $tries ++;
5970: }
5971: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5972: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5973: } else {
5974: my @responses = split(/:/,$reply);
5975: my $outcome = shift(@responses);
5976: foreach my $item (@responses) {
5977: my ($key,$value) = split(/=/,$item);
5978: $$photo{$key} = $value;
5979: }
5980: return $outcome;
5981: }
5982: return 'error';
5983: }
5984:
5985: sub auto_instcode_format {
5986: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5987: $cat_order) = @_;
5988: my $courses = '';
5989: my @homeservers;
5990: if ($caller eq 'global') {
5991: my %servers = &get_servers($codedom,'library');
5992: foreach my $tryserver (keys(%servers)) {
5993: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5994: push(@homeservers,$tryserver);
5995: }
5996: }
5997: } elsif ($caller eq 'requests') {
5998: if ($codedom =~ /^$match_domain$/) {
5999: my $chome = &domain($codedom,'primary');
6000: unless ($chome eq 'no_host') {
6001: push(@homeservers,$chome);
6002: }
6003: }
6004: } else {
6005: push(@homeservers,&homeserver($caller,$codedom));
6006: }
6007: foreach my $code (keys(%{$instcodes})) {
6008: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
6009: }
6010: chop($courses);
6011: my $ok_response = 0;
6012: my $response;
6013: while (@homeservers > 0 && $ok_response == 0) {
6014: my $server = shift(@homeservers);
6015: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
6016: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
6017: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
6018: split(/:/,$response);
6019: %{$codes} = (%{$codes},&str2hash($codes_str));
6020: push(@{$codetitles},&str2array($codetitles_str));
6021: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
6022: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
6023: $ok_response = 1;
6024: }
6025: }
6026: if ($ok_response) {
6027: return 'ok';
6028: } else {
6029: return $response;
6030: }
6031: }
6032:
6033: sub auto_instcode_defaults {
6034: my ($domain,$returnhash,$code_order) = @_;
6035: my @homeservers;
6036:
6037: my %servers = &get_servers($domain,'library');
6038: foreach my $tryserver (keys(%servers)) {
6039: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6040: push(@homeservers,$tryserver);
6041: }
6042: }
6043:
6044: my $response;
6045: foreach my $server (@homeservers) {
6046: $response=&reply('autoinstcodedefaults:'.$domain,$server);
6047: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6048:
6049: foreach my $pair (split(/\&/,$response)) {
6050: my ($name,$value)=split(/\=/,$pair);
6051: if ($name eq 'code_order') {
6052: @{$code_order} = split(/\&/,&unescape($value));
6053: } else {
6054: $returnhash->{&unescape($name)}=&unescape($value);
6055: }
6056: }
6057: return 'ok';
6058: }
6059:
6060: return $response;
6061: }
6062:
6063: sub auto_possible_instcodes {
6064: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
6065: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
6066: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
6067: return;
6068: }
6069: my (@homeservers,$uhome);
6070: if (defined(&domain($domain,'primary'))) {
6071: $uhome=&domain($domain,'primary');
6072: push(@homeservers,&domain($domain,'primary'));
6073: } else {
6074: my %servers = &get_servers($domain,'library');
6075: foreach my $tryserver (keys(%servers)) {
6076: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6077: push(@homeservers,$tryserver);
6078: }
6079: }
6080: }
6081: my $response;
6082: foreach my $server (@homeservers) {
6083: $response=&reply('autopossibleinstcodes:'.$domain,$server);
6084: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6085: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
6086: split(':',$response);
6087: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
6088: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
6089: foreach my $item (split('&',$cat_title)) {
6090: my ($name,$value)=split('=',$item);
6091: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
6092: }
6093: foreach my $item (split('&',$cat_order)) {
6094: my ($name,$value)=split('=',$item);
6095: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
6096: }
6097: return 'ok';
6098: }
6099: return $response;
6100: }
6101:
6102: sub auto_courserequest_checks {
6103: my ($dom) = @_;
6104: my ($homeserver,%validations);
6105: if ($dom =~ /^$match_domain$/) {
6106: $homeserver = &domain($dom,'primary');
6107: }
6108: unless ($homeserver eq 'no_host') {
6109: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6110: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6111: my @items = split(/&/,$response);
6112: foreach my $item (@items) {
6113: my ($key,$value) = split('=',$item);
6114: $validations{&unescape($key)} = &thaw_unescape($value);
6115: }
6116: }
6117: }
6118: return %validations;
6119: }
6120:
6121: sub auto_courserequest_validation {
6122: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6123: my ($homeserver,$response);
6124: if ($dom =~ /^$match_domain$/) {
6125: $homeserver = &domain($dom,'primary');
6126: }
6127: unless ($homeserver eq 'no_host') {
6128:
6129: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
6130: ':'.&escape($crstype).':'.&escape($inststatuslist).
6131: ':'.&escape($instcode).':'.&escape($instseclist),
6132: $homeserver));
6133: }
6134: return $response;
6135: }
6136:
6137: sub auto_validate_class_sec {
6138: my ($cdom,$cnum,$owners,$inst_class) = @_;
6139: my $homeserver = &homeserver($cnum,$cdom);
6140: my $ownerlist;
6141: if (ref($owners) eq 'ARRAY') {
6142: $ownerlist = join(',',@{$owners});
6143: } else {
6144: $ownerlist = $owners;
6145: }
6146: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
6147: &escape($ownerlist).':'.$cdom,$homeserver);
6148: return $response;
6149: }
6150:
6151: # ------------------------------------------------------- Course Group routines
6152:
6153: sub get_coursegroups {
6154: my ($cdom,$cnum,$group,$namespace) = @_;
6155: return(&dump($namespace,$cdom,$cnum,$group));
6156: }
6157:
6158: sub modify_coursegroup {
6159: my ($cdom,$cnum,$groupsettings) = @_;
6160: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6161: }
6162:
6163: sub toggle_coursegroup_status {
6164: my ($cdom,$cnum,$group,$action) = @_;
6165: my ($from_namespace,$to_namespace);
6166: if ($action eq 'delete') {
6167: $from_namespace = 'coursegroups';
6168: $to_namespace = 'deleted_groups';
6169: } else {
6170: $from_namespace = 'deleted_groups';
6171: $to_namespace = 'coursegroups';
6172: }
6173: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6174: if (my $tmp = &error(%curr_group)) {
6175: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6176: return ('read error',$tmp);
6177: } else {
6178: my %savedsettings = %curr_group;
6179: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6180: my $deloutcome;
6181: if ($result eq 'ok') {
6182: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6183: } else {
6184: return ('write error',$result);
6185: }
6186: if ($deloutcome eq 'ok') {
6187: return 'ok';
6188: } else {
6189: return ('delete error',$deloutcome);
6190: }
6191: }
6192: }
6193:
6194: sub modify_group_roles {
6195: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6196: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6197: my $role = 'gr/'.&escape($userprivs);
6198: my ($uname,$udom) = split(/:/,$user);
6199: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6200: if ($result eq 'ok') {
6201: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6202: }
6203: return $result;
6204: }
6205:
6206: sub modify_coursegroup_membership {
6207: my ($cdom,$cnum,$membership) = @_;
6208: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6209: return $result;
6210: }
6211:
6212: sub get_active_groups {
6213: my ($udom,$uname,$cdom,$cnum) = @_;
6214: my $now = time;
6215: my %groups = ();
6216: foreach my $key (keys(%env)) {
6217: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6218: my ($start,$end) = split(/\./,$env{$key});
6219: if (($end!=0) && ($end<$now)) { next; }
6220: if (($start!=0) && ($start>$now)) { next; }
6221: if ($1 eq $cdom && $2 eq $cnum) {
6222: $groups{$3} = $env{$key} ;
6223: }
6224: }
6225: }
6226: return %groups;
6227: }
6228:
6229: sub get_group_membership {
6230: my ($cdom,$cnum,$group) = @_;
6231: return(&dump('groupmembership',$cdom,$cnum,$group));
6232: }
6233:
6234: sub get_users_groups {
6235: my ($udom,$uname,$courseid) = @_;
6236: my @usersgroups;
6237: my $cachetime=1800;
6238:
6239: my $hashid="$udom:$uname:$courseid";
6240: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6241: if (defined($cached)) {
6242: @usersgroups = split(/:/,$grouplist);
6243: } else {
6244: $grouplist = '';
6245: my $courseurl = &courseid_to_courseurl($courseid);
6246: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
6247: my $access_end = $env{'course.'.$courseid.
6248: '.default_enrollment_end_date'};
6249: my $now = time;
6250: foreach my $key (keys(%roleshash)) {
6251: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6252: my $group = $1;
6253: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6254: my $start = $2;
6255: my $end = $1;
6256: if ($start == -1) { next; } # deleted from group
6257: if (($start!=0) && ($start>$now)) { next; }
6258: if (($end!=0) && ($end<$now)) {
6259: if ($access_end && $access_end < $now) {
6260: if ($access_end - $end < 86400) {
6261: push(@usersgroups,$group);
6262: }
6263: }
6264: next;
6265: }
6266: push(@usersgroups,$group);
6267: }
6268: }
6269: }
6270: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6271: $grouplist = join(':',@usersgroups);
6272: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6273: }
6274: return @usersgroups;
6275: }
6276:
6277: sub devalidate_getgroups_cache {
6278: my ($udom,$uname,$cdom,$cnum)=@_;
6279: my $courseid = $cdom.'_'.$cnum;
6280:
6281: my $hashid="$udom:$uname:$courseid";
6282: &devalidate_cache_new('getgroups',$hashid);
6283: }
6284:
6285: # ------------------------------------------------------------------ Plain Text
6286:
6287: sub plaintext {
6288: my ($short,$type,$cid,$forcedefault) = @_;
6289: if ($short =~ m{^cr/}) {
6290: return (split('/',$short))[-1];
6291: }
6292: if (!defined($cid)) {
6293: $cid = $env{'request.course.id'};
6294: }
6295: my %rolenames = (
6296: Course => 'std',
6297: Community => 'alt1',
6298: );
6299: if ($cid ne '') {
6300: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6301: unless ($forcedefault) {
6302: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6303: &Apache::lonlocal::mt_escape(\$roletext);
6304: return &Apache::lonlocal::mt($roletext);
6305: }
6306: }
6307: }
6308: if ((defined($type)) && (defined($rolenames{$type})) &&
6309: (defined($rolenames{$type})) &&
6310: (defined($prp{$short}{$rolenames{$type}}))) {
6311: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
6312: } elsif ($cid ne '') {
6313: my $crstype = $env{'course.'.$cid.'.type'};
6314: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6315: (defined($prp{$short}{$rolenames{$crstype}}))) {
6316: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6317: }
6318: }
6319: return &Apache::lonlocal::mt($prp{$short}{'std'});
6320: }
6321:
6322: # ----------------------------------------------------------------- Assign Role
6323:
6324: sub assignrole {
6325: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6326: $context)=@_;
6327: my $mrole;
6328: if ($role =~ /^cr\//) {
6329: my $cwosec=$url;
6330: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6331: unless (&allowed('ccr',$cwosec)) {
6332: my $refused = 1;
6333: if ($context eq 'requestcourses') {
6334: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6335: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6336: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6337: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6338: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6339: if ($crsenv{'internal.courseowner'} eq
6340: $env{'user.name'}.':'.$env{'user.domain'}) {
6341: $refused = '';
6342: }
6343: }
6344: }
6345: }
6346: }
6347: if ($refused) {
6348: &logthis('Refused custom assignrole: '.
6349: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6350: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6351: return 'refused';
6352: }
6353: }
6354: $mrole='cr';
6355: } elsif ($role =~ /^gr\//) {
6356: my $cwogrp=$url;
6357: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
6358: unless (&allowed('mdg',$cwogrp)) {
6359: &logthis('Refused group assignrole: '.
6360: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6361: $env{'user.name'}.' at '.$env{'user.domain'});
6362: return 'refused';
6363: }
6364: $mrole='gr';
6365: } else {
6366: my $cwosec=$url;
6367: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6368: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6369: my $refused;
6370: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6371: if (!(&allowed('c'.$role,$url))) {
6372: $refused = 1;
6373: }
6374: } else {
6375: $refused = 1;
6376: }
6377: if ($refused) {
6378: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6379: if (!$selfenroll && $context eq 'course') {
6380: my %crsenv;
6381: if ($role eq 'cc' || $role eq 'co') {
6382: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6383: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6384: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6385: if ($crsenv{'internal.courseowner'} eq
6386: $env{'user.name'}.':'.$env{'user.domain'}) {
6387: $refused = '';
6388: }
6389: }
6390: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6391: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6392: if ($crsenv{'internal.courseowner'} eq
6393: $env{'user.name'}.':'.$env{'user.domain'}) {
6394: $refused = '';
6395: }
6396: }
6397: }
6398: }
6399: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6400: $refused = '';
6401: } elsif ($context eq 'requestcourses') {
6402: my @possroles = ('st','ta','ep','in','cc','co');
6403: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
6404: my $wrongcc;
6405: if ($cnum =~ /^$match_community$/) {
6406: $wrongcc = 1 if ($role eq 'cc');
6407: } else {
6408: $wrongcc = 1 if ($role eq 'co');
6409: }
6410: unless ($wrongcc) {
6411: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6412: if ($crsenv{'internal.courseowner'} eq
6413: $env{'user.name'}.':'.$env{'user.domain'}) {
6414: $refused = '';
6415: }
6416: }
6417: }
6418: }
6419: if ($refused) {
6420: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6421: ' '.$role.' '.$end.' '.$start.' by '.
6422: $env{'user.name'}.' at '.$env{'user.domain'});
6423: return 'refused';
6424: }
6425: }
6426: }
6427: $mrole=$role;
6428: }
6429: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6430: "$udom:$uname:$url".'_'."$mrole=$role";
6431: if ($end) { $command.='_'.$end; }
6432: if ($start) {
6433: if ($end) {
6434: $command.='_'.$start;
6435: } else {
6436: $command.='_0_'.$start;
6437: }
6438: }
6439: my $origstart = $start;
6440: my $origend = $end;
6441: my $delflag;
6442: # actually delete
6443: if ($deleteflag) {
6444: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
6445: # modify command to delete the role
6446: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
6447: "$udom:$uname:$url".'_'."$mrole";
6448: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
6449: # set start and finish to negative values for userrolelog
6450: $start=-1;
6451: $end=-1;
6452: $delflag = 1;
6453: }
6454: }
6455: # send command
6456: my $answer=&reply($command,&homeserver($uname,$udom));
6457: # log new user role if status is ok
6458: if ($answer eq 'ok') {
6459: &userrolelog($role,$uname,$udom,$url,$start,$end);
6460: # for course roles, perform group memberships changes triggered by role change.
6461: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
6462: unless ($role =~ /^gr/) {
6463: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
6464: $origstart,$selfenroll,$context);
6465: }
6466: if ($role eq 'cc') {
6467: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6468: }
6469: }
6470: return $answer;
6471: }
6472:
6473: sub autoupdate_coowners {
6474: my ($url,$end,$start,$uname,$udom) = @_;
6475: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6476: if (($cdom ne '') && ($cnum ne '')) {
6477: my $now = time;
6478: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6479: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6480: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6481: my $instcode = $coursehash{'internal.coursecode'};
6482: if ($instcode ne '') {
6483: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
6484: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
6485: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
6486: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6487: if ($result eq 'valid') {
6488: if ($coursehash{'internal.co-owners'}) {
6489: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6490: push(@newcoowners,$coowner);
6491: }
6492: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6493: push(@newcoowners,$uname.':'.$udom);
6494: }
6495: @newcoowners = sort(@newcoowners);
6496: } else {
6497: push(@newcoowners,$uname.':'.$udom);
6498: }
6499: } else {
6500: if ($coursehash{'internal.co-owners'}) {
6501: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6502: unless ($coowner eq $uname.':'.$udom) {
6503: push(@newcoowners,$coowner);
6504: }
6505: }
6506: unless (@newcoowners > 0) {
6507: $delcoowners = 1;
6508: $coowners = '';
6509: }
6510: }
6511: }
6512: if (@newcoowners || $delcoowners) {
6513: &store_coowners($cdom,$cnum,$coursehash{'home'},
6514: $delcoowners,@newcoowners);
6515: }
6516: }
6517: }
6518: }
6519: }
6520: }
6521: }
6522:
6523: sub store_coowners {
6524: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6525: my $cid = $cdom.'_'.$cnum;
6526: my ($coowners,$delresult,$putresult);
6527: if (@newcoowners) {
6528: $coowners = join(',',@newcoowners);
6529: my %coownershash = (
6530: 'internal.co-owners' => $coowners,
6531: );
6532: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6533: if ($putresult eq 'ok') {
6534: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6535: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6536: }
6537: }
6538: }
6539: if ($delcoowners) {
6540: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6541: if ($delresult eq 'ok') {
6542: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6543: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6544: }
6545: }
6546: }
6547: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6548: my %crsinfo =
6549: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6550: if (ref($crsinfo{$cid}) eq 'HASH') {
6551: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6552: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6553: }
6554: }
6555: }
6556:
6557: # -------------------------------------------------- Modify user authentication
6558: # Overrides without validation
6559:
6560: sub modifyuserauth {
6561: my ($udom,$uname,$umode,$upass)=@_;
6562: my $uhome=&homeserver($uname,$udom);
6563: unless (&allowed('mau',$udom)) { return 'refused'; }
6564: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
6565: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6566: ' in domain '.$env{'request.role.domain'});
6567: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6568: &escape($upass),$uhome);
6569: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
6570: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6571: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6572: &log($udom,,$uname,$uhome,
6573: 'Authentication changed by '.$env{'user.domain'}.', '.
6574: $env{'user.name'}.', '.$umode.
6575: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6576: unless ($reply eq 'ok') {
6577: &logthis('Authentication mode error: '.$reply);
6578: return 'error: '.$reply;
6579: }
6580: return 'ok';
6581: }
6582:
6583: # --------------------------------------------------------------- Modify a user
6584:
6585: sub modifyuser {
6586: my ($udom, $uname, $uid,
6587: $umode, $upass, $first,
6588: $middle, $last, $gene,
6589: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
6590: $udom= &LONCAPA::clean_domain($udom);
6591: $uname=&LONCAPA::clean_username($uname);
6592: my $showcandelete = 'none';
6593: if (ref($candelete) eq 'ARRAY') {
6594: if (@{$candelete} > 0) {
6595: $showcandelete = join(', ',@{$candelete});
6596: }
6597: }
6598: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
6599: $umode.', '.$first.', '.$middle.', '.
6600: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
6601: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6602: ' desiredhome not specified').
6603: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6604: ' in domain '.$env{'request.role.domain'});
6605: my $uhome=&homeserver($uname,$udom,'true');
6606: # ----------------------------------------------------------------- Create User
6607: if (($uhome eq 'no_host') &&
6608: (($umode && $upass) || ($umode eq 'localauth'))) {
6609: my $unhome='';
6610: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
6611: $unhome = $desiredhome;
6612: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6613: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
6614: } else { # load balancing routine for determining $unhome
6615: my $loadm=10000000;
6616: my %servers = &get_servers($udom,'library');
6617: foreach my $tryserver (keys(%servers)) {
6618: my $answer=reply('load',$tryserver);
6619: if (($answer=~/\d+/) && ($answer<$loadm)) {
6620: $loadm=$answer;
6621: $unhome=$tryserver;
6622: }
6623: }
6624: }
6625: if (($unhome eq '') || ($unhome eq 'no_host')) {
6626: return 'error: unable to find a home server for '.$uname.
6627: ' in domain '.$udom;
6628: }
6629: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6630: &escape($upass),$unhome);
6631: unless ($reply eq 'ok') {
6632: return 'error: '.$reply;
6633: }
6634: $uhome=&homeserver($uname,$udom,'true');
6635: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
6636: return 'error: unable verify users home machine.';
6637: }
6638: } # End of creation of new user
6639: # ---------------------------------------------------------------------- Add ID
6640: if ($uid) {
6641: $uid=~tr/A-Z/a-z/;
6642: my %uidhash=&idrget($udom,$uname);
6643: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6644: && (!$forceid)) {
6645: unless ($uid eq $uidhash{$uname}) {
6646: return 'error: user id "'.$uid.'" does not match '.
6647: 'current user id "'.$uidhash{$uname}.'".';
6648: }
6649: } else {
6650: &idput($udom,($uname => $uid));
6651: }
6652: }
6653: # -------------------------------------------------------------- Add names, etc
6654: my @tmp=&get('environment',
6655: ['firstname','middlename','lastname','generation','id',
6656: 'permanentemail','inststatus'],
6657: $udom,$uname);
6658: my %names;
6659: if ($tmp[0] =~ m/^error:.*/) {
6660: %names=();
6661: } else {
6662: %names = @tmp;
6663: }
6664: #
6665: # If name, email and/or uid are blank (e.g., because an uploaded file
6666: # of users did not contain them), do not overwrite existing values
6667: # unless field is in $candelete array ref.
6668: #
6669:
6670: my @fields = ('firstname','middlename','lastname','generation',
6671: 'permanentemail','id');
6672: my %newvalues;
6673: if (ref($candelete) eq 'ARRAY') {
6674: foreach my $field (@fields) {
6675: if (grep(/^\Q$field\E$/,@{$candelete})) {
6676: if ($field eq 'firstname') {
6677: $names{$field} = $first;
6678: } elsif ($field eq 'middlename') {
6679: $names{$field} = $middle;
6680: } elsif ($field eq 'lastname') {
6681: $names{$field} = $last;
6682: } elsif ($field eq 'generation') {
6683: $names{$field} = $gene;
6684: } elsif ($field eq 'permanentemail') {
6685: $names{$field} = $email;
6686: } elsif ($field eq 'id') {
6687: $names{$field} = $uid;
6688: }
6689: }
6690: }
6691: }
6692: if ($first) { $names{'firstname'} = $first; }
6693: if (defined($middle)) { $names{'middlename'} = $middle; }
6694: if ($last) { $names{'lastname'} = $last; }
6695: if (defined($gene)) { $names{'generation'} = $gene; }
6696: if ($email) {
6697: $email=~s/[^\w\@\.\-\,]//gs;
6698: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6699: }
6700: if ($uid) { $names{'id'} = $uid; }
6701: if (defined($inststatus)) {
6702: $names{'inststatus'} = '';
6703: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6704: if (ref($usertypes) eq 'HASH') {
6705: my @okstatuses;
6706: foreach my $item (split(/:/,$inststatus)) {
6707: if (defined($usertypes->{$item})) {
6708: push(@okstatuses,$item);
6709: }
6710: }
6711: if (@okstatuses) {
6712: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6713: }
6714: }
6715: }
6716: my $reply = &put('environment', \%names, $udom,$uname);
6717: if ($reply ne 'ok') { return 'error: '.$reply; }
6718: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6719: &devalidate_cache_new('namescache',$uname.':'.$udom);
6720: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6721: $umode.', '.$first.', '.$middle.', '.
6722: $last.', '.$gene.', '.$email.', '.$inststatus;
6723: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6724: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6725: } else {
6726: $logmsg .= ' during self creation';
6727: }
6728: &logthis($logmsg);
6729: return 'ok';
6730: }
6731:
6732: # -------------------------------------------------------------- Modify student
6733:
6734: sub modifystudent {
6735: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6736: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6737: $selfenroll,$context,$inststatus)=@_;
6738: if (!$cid) {
6739: unless ($cid=$env{'request.course.id'}) {
6740: return 'not_in_class';
6741: }
6742: }
6743: # --------------------------------------------------------------- Make the user
6744: my $reply=&modifyuser
6745: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6746: $desiredhome,$email,$inststatus);
6747: unless ($reply eq 'ok') { return $reply; }
6748: # This will cause &modify_student_enrollment to get the uid from the
6749: # students environment
6750: $uid = undef if (!$forceid);
6751: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6752: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6753: return $reply;
6754: }
6755:
6756: sub modify_student_enrollment {
6757: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6758: my ($cdom,$cnum,$chome);
6759: if (!$cid) {
6760: unless ($cid=$env{'request.course.id'}) {
6761: return 'not_in_class';
6762: }
6763: $cdom=$env{'course.'.$cid.'.domain'};
6764: $cnum=$env{'course.'.$cid.'.num'};
6765: } else {
6766: ($cdom,$cnum)=split(/_/,$cid);
6767: }
6768: $chome=$env{'course.'.$cid.'.home'};
6769: if (!$chome) {
6770: $chome=&homeserver($cnum,$cdom);
6771: }
6772: if (!$chome) { return 'unknown_course'; }
6773: # Make sure the user exists
6774: my $uhome=&homeserver($uname,$udom);
6775: if (($uhome eq '') || ($uhome eq 'no_host')) {
6776: return 'error: no such user';
6777: }
6778: # Get student data if we were not given enough information
6779: if (!defined($first) || $first eq '' ||
6780: !defined($last) || $last eq '' ||
6781: !defined($uid) || $uid eq '' ||
6782: !defined($middle) || $middle eq '' ||
6783: !defined($gene) || $gene eq '') {
6784: # They did not supply us with enough data to enroll the student, so
6785: # we need to pick up more information.
6786: my %tmp = &get('environment',
6787: ['firstname','middlename','lastname', 'generation','id']
6788: ,$udom,$uname);
6789:
6790: #foreach my $key (keys(%tmp)) {
6791: # &logthis("key $key = ".$tmp{$key});
6792: #}
6793: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6794: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6795: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6796: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6797: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6798: }
6799: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6800: my $reply=cput('classlist',
6801: {"$uname:$udom" =>
6802: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6803: $cdom,$cnum);
6804: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6805: return 'error: '.$reply;
6806: } else {
6807: &devalidate_getsection_cache($udom,$uname,$cid);
6808: }
6809: # Add student role to user
6810: my $uurl='/'.$cid;
6811: $uurl=~s/\_/\//g;
6812: if ($usec) {
6813: $uurl.='/'.$usec;
6814: }
6815: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6816: }
6817:
6818: sub format_name {
6819: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6820: my $name;
6821: if ($first ne 'lastname') {
6822: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6823: } else {
6824: if ($lastname=~/\S/) {
6825: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6826: $name=~s/\s+,/,/;
6827: } else {
6828: $name.= $firstname.' '.$middlename.' '.$generation;
6829: }
6830: }
6831: $name=~s/^\s+//;
6832: $name=~s/\s+$//;
6833: $name=~s/\s+/ /g;
6834: return $name;
6835: }
6836:
6837: # ------------------------------------------------- Write to course preferences
6838:
6839: sub writecoursepref {
6840: my ($courseid,%prefs)=@_;
6841: $courseid=~s/^\///;
6842: $courseid=~s/\_/\//g;
6843: my ($cdomain,$cnum)=split(/\//,$courseid);
6844: my $chome=homeserver($cnum,$cdomain);
6845: if (($chome eq '') || ($chome eq 'no_host')) {
6846: return 'error: no such course';
6847: }
6848: my $cstring='';
6849: foreach my $pref (keys(%prefs)) {
6850: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6851: }
6852: $cstring=~s/\&$//;
6853: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6854: }
6855:
6856: # ---------------------------------------------------------- Make/modify course
6857:
6858: sub createcourse {
6859: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6860: $course_owner,$crstype,$cnum,$context,$category)=@_;
6861: $url=&declutter($url);
6862: my $cid='';
6863: if ($context eq 'requestcourses') {
6864: my $can_create = 0;
6865: my ($ownername,$ownerdom) = split(':',$course_owner);
6866: if ($udom eq $ownerdom) {
6867: if (&usertools_access($ownername,$ownerdom,$category,undef,
6868: $context)) {
6869: $can_create = 1;
6870: }
6871: } else {
6872: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6873: $category);
6874: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6875: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6876: if (@curr > 0) {
6877: my @options = qw(approval validate autolimit);
6878: my $optregex = join('|',@options);
6879: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6880: $can_create = 1;
6881: }
6882: }
6883: }
6884: }
6885: if ($can_create) {
6886: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6887: unless (&allowed('ccc',$udom)) {
6888: return 'refused';
6889: }
6890: }
6891: } else {
6892: return 'refused';
6893: }
6894: } elsif (!&allowed('ccc',$udom)) {
6895: return 'refused';
6896: }
6897: # --------------------------------------------------------------- Get Unique ID
6898: my $uname;
6899: if ($cnum =~ /^$match_courseid$/) {
6900: my $chome=&homeserver($cnum,$udom,'true');
6901: if (($chome eq '') || ($chome eq 'no_host')) {
6902: $uname = $cnum;
6903: } else {
6904: $uname = &generate_coursenum($udom,$crstype);
6905: }
6906: } else {
6907: $uname = &generate_coursenum($udom,$crstype);
6908: }
6909: return $uname if ($uname =~ /^error/);
6910: # -------------------------------------------------- Check supplied server name
6911: if (!defined($course_server)) {
6912: if (defined(&domain($udom,'primary'))) {
6913: $course_server = &domain($udom,'primary');
6914: } else {
6915: $course_server = $env{'user.home'};
6916: }
6917: }
6918: my %host_servers =
6919: &Apache::lonnet::get_servers($udom,'library');
6920: unless ($host_servers{$course_server}) {
6921: return 'error: invalid home server for course: '.$course_server;
6922: }
6923: # ------------------------------------------------------------- Make the course
6924: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6925: $course_server);
6926: unless ($reply eq 'ok') { return 'error: '.$reply; }
6927: my $uhome=&homeserver($uname,$udom,'true');
6928: if (($uhome eq '') || ($uhome eq 'no_host')) {
6929: return 'error: no such course';
6930: }
6931: # ----------------------------------------------------------------- Course made
6932: # log existence
6933: my $now = time;
6934: my $newcourse = {
6935: $udom.'_'.$uname => {
6936: description => $description,
6937: inst_code => $inst_code,
6938: owner => $course_owner,
6939: type => $crstype,
6940: creator => $env{'user.name'}.':'.
6941: $env{'user.domain'},
6942: created => $now,
6943: context => $context,
6944: },
6945: };
6946: &courseidput($udom,$newcourse,$uhome,'notime');
6947: # set toplevel url
6948: my $topurl=$url;
6949: unless ($nonstandard) {
6950: # ------------------------------------------ For standard courses, make top url
6951: my $mapurl=&clutter($url);
6952: if ($mapurl eq '/res/') { $mapurl=''; }
6953: $env{'form.initmap'}=(<<ENDINITMAP);
6954: <map>
6955: <resource id="1" type="start"></resource>
6956: <resource id="2" src="$mapurl"></resource>
6957: <resource id="3" type="finish"></resource>
6958: <link index="1" from="1" to="2"></link>
6959: <link index="2" from="2" to="3"></link>
6960: </map>
6961: ENDINITMAP
6962: $topurl=&declutter(
6963: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6964: );
6965: }
6966: # ----------------------------------------------------------- Write preferences
6967: &writecoursepref($udom.'_'.$uname,
6968: ('description' => $description,
6969: 'url' => $topurl,
6970: 'internal.creator' => $env{'user.name'}.':'.
6971: $env{'user.domain'},
6972: 'internal.created' => $now,
6973: 'internal.creationcontext' => $context)
6974: );
6975: return '/'.$udom.'/'.$uname;
6976: }
6977:
6978: # ------------------------------------------------------------------- Create ID
6979: sub generate_coursenum {
6980: my ($udom,$crstype) = @_;
6981: my $domdesc = &domain($udom);
6982: return 'error: invalid domain' if ($domdesc eq '');
6983: my $first;
6984: if ($crstype eq 'Community') {
6985: $first = '0';
6986: } else {
6987: $first = int(1+rand(9));
6988: }
6989: my $uname=$first.
6990: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6991: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6992: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6993: # ----------------------------------------------- Make sure that does not exist
6994: my $uhome=&homeserver($uname,$udom,'true');
6995: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6996: if ($crstype eq 'Community') {
6997: $first = '0';
6998: } else {
6999: $first = int(1+rand(9));
7000: }
7001: $uname=$first.
7002: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
7003: substr($$.time,0,5).unpack("H8",pack("I32",time)).
7004: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
7005: $uhome=&homeserver($uname,$udom,'true');
7006: unless (($uhome eq '') || ($uhome eq 'no_host')) {
7007: return 'error: unable to generate unique course-ID';
7008: }
7009: }
7010: return $uname;
7011: }
7012:
7013: sub is_course {
7014: my ($cdom,$cnum) = @_;
7015: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
7016: undef,'.');
7017: if (exists($courses{$cdom.'_'.$cnum})) {
7018: return 1;
7019: }
7020: return 0;
7021: }
7022:
7023: sub store_userdata {
7024: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
7025: my $result;
7026: if ($datakey ne '') {
7027: if (ref($storehash) eq 'HASH') {
7028: if ($udom eq '' || $uname eq '') {
7029: $udom = $env{'user.domain'};
7030: $uname = $env{'user.name'};
7031: }
7032: my $uhome=&homeserver($uname,$udom);
7033: if (($uhome eq '') || ($uhome eq 'no_host')) {
7034: $result = 'error: no_host';
7035: } else {
7036: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
7037: $storehash->{'host'} = $perlvar{'lonHostID'};
7038:
7039: my $namevalue='';
7040: foreach my $key (keys(%{$storehash})) {
7041: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7042: }
7043: $namevalue=~s/\&$//;
7044: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
7045: "$namespace:$datakey:$namevalue",$uhome);
7046: }
7047: } else {
7048: $result = 'error: data to store was not a hash reference';
7049: }
7050: } else {
7051: $result= 'error: invalid requestkey';
7052: }
7053: return $result;
7054: }
7055:
7056: # ---------------------------------------------------------- Assign Custom Role
7057:
7058: sub assigncustomrole {
7059: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
7060: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
7061: $end,$start,$deleteflag,$selfenroll,$context);
7062: }
7063:
7064: # ----------------------------------------------------------------- Revoke Role
7065:
7066: sub revokerole {
7067: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
7068: my $now=time;
7069: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
7070: }
7071:
7072: # ---------------------------------------------------------- Revoke Custom Role
7073:
7074: sub revokecustomrole {
7075: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
7076: my $now=time;
7077: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
7078: $deleteflag,$selfenroll,$context);
7079: }
7080:
7081: # ------------------------------------------------------------ Disk usage
7082: sub diskusage {
7083: my ($udom,$uname,$directorypath,$getpropath)=@_;
7084: $directorypath =~ s/\/$//;
7085: my $listing=&reply('du2:'.&escape($directorypath).':'
7086: .&escape($getpropath).':'.&escape($uname).':'
7087: .&escape($udom),homeserver($uname,$udom));
7088: if ($listing eq 'unknown_cmd') {
7089: if ($getpropath) {
7090: $directorypath = &propath($udom,$uname).'/'.$directorypath;
7091: }
7092: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
7093: }
7094: return $listing;
7095: }
7096:
7097: sub is_locked {
7098: my ($file_name, $domain, $user) = @_;
7099: my @check;
7100: my $is_locked;
7101: push @check, $file_name;
7102: my %locked = &get('file_permissions',\@check,
7103: $env{'user.domain'},$env{'user.name'});
7104: my ($tmp)=keys(%locked);
7105: if ($tmp=~/^error:/) { undef(%locked); }
7106:
7107: if (ref($locked{$file_name}) eq 'ARRAY') {
7108: $is_locked = 'false';
7109: foreach my $entry (@{$locked{$file_name}}) {
7110: if (ref($entry) eq 'ARRAY') {
7111: $is_locked = 'true';
7112: last;
7113: }
7114: }
7115: } else {
7116: $is_locked = 'false';
7117: }
7118: }
7119:
7120: sub declutter_portfile {
7121: my ($file) = @_;
7122: $file =~ s{^(/portfolio/|portfolio/)}{/};
7123: return $file;
7124: }
7125:
7126: # ------------------------------------------------------------- Mark as Read Only
7127:
7128: sub mark_as_readonly {
7129: my ($domain,$user,$files,$what) = @_;
7130: my %current_permissions = &dump('file_permissions',$domain,$user);
7131: my ($tmp)=keys(%current_permissions);
7132: if ($tmp=~/^error:/) { undef(%current_permissions); }
7133: foreach my $file (@{$files}) {
7134: $file = &declutter_portfile($file);
7135: push(@{$current_permissions{$file}},$what);
7136: }
7137: &put('file_permissions',\%current_permissions,$domain,$user);
7138: return;
7139: }
7140:
7141: # ------------------------------------------------------------Save Selected Files
7142:
7143: sub save_selected_files {
7144: my ($user, $path, @files) = @_;
7145: my $filename = $user."savedfiles";
7146: my @other_files = &files_not_in_path($user, $path);
7147: open (OUT, '>'.$tmpdir.$filename);
7148: foreach my $file (@files) {
7149: print (OUT $env{'form.currentpath'}.$file."\n");
7150: }
7151: foreach my $file (@other_files) {
7152: print (OUT $file."\n");
7153: }
7154: close (OUT);
7155: return 'ok';
7156: }
7157:
7158: sub clear_selected_files {
7159: my ($user) = @_;
7160: my $filename = $user."savedfiles";
7161: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7162: print (OUT undef);
7163: close (OUT);
7164: return ("ok");
7165: }
7166:
7167: sub files_in_path {
7168: my ($user, $path) = @_;
7169: my $filename = $user."savedfiles";
7170: my %return_files;
7171: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7172: while (my $line_in = <IN>) {
7173: chomp ($line_in);
7174: my @paths_and_file = split (m!/!, $line_in);
7175: my $file_part = pop (@paths_and_file);
7176: my $path_part = join ('/', @paths_and_file);
7177: $path_part.='/';
7178: my $path_and_file = $path_part.$file_part;
7179: if ($path_part eq $path) {
7180: $return_files{$file_part}= 'selected';
7181: }
7182: }
7183: close (IN);
7184: return (\%return_files);
7185: }
7186:
7187: # called in portfolio select mode, to show files selected NOT in current directory
7188: sub files_not_in_path {
7189: my ($user, $path) = @_;
7190: my $filename = $user."savedfiles";
7191: my @return_files;
7192: my $path_part;
7193: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7194: while (my $line = <IN>) {
7195: #ok, I know it's clunky, but I want it to work
7196: my @paths_and_file = split(m|/|, $line);
7197: my $file_part = pop(@paths_and_file);
7198: chomp($file_part);
7199: my $path_part = join('/', @paths_and_file);
7200: $path_part .= '/';
7201: my $path_and_file = $path_part.$file_part;
7202: if ($path_part ne $path) {
7203: push(@return_files, ($path_and_file));
7204: }
7205: }
7206: close(OUT);
7207: return (@return_files);
7208: }
7209:
7210: #----------------------------------------------Get portfolio file permissions
7211:
7212: sub get_portfile_permissions {
7213: my ($domain,$user) = @_;
7214: my %current_permissions = &dump('file_permissions',$domain,$user);
7215: my ($tmp)=keys(%current_permissions);
7216: if ($tmp=~/^error:/) { undef(%current_permissions); }
7217: return \%current_permissions;
7218: }
7219:
7220: #---------------------------------------------Get portfolio file access controls
7221:
7222: sub get_access_controls {
7223: my ($current_permissions,$group,$file) = @_;
7224: my %access;
7225: my $real_file = $file;
7226: $file =~ s/\.meta$//;
7227: if (defined($file)) {
7228: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7229: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
7230: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
7231: }
7232: }
7233: } else {
7234: foreach my $key (keys(%{$current_permissions})) {
7235: if ($key =~ /\0accesscontrol$/) {
7236: if (defined($group)) {
7237: if ($key !~ m-^\Q$group\E/-) {
7238: next;
7239: }
7240: }
7241: my ($fullpath) = split(/\0/,$key);
7242: if (ref($$current_permissions{$key}) eq 'HASH') {
7243: foreach my $control (keys(%{$$current_permissions{$key}})) {
7244: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7245: }
7246: }
7247: }
7248: }
7249: }
7250: return %access;
7251: }
7252:
7253: sub modify_access_controls {
7254: my ($file_name,$changes,$domain,$user)=@_;
7255: my ($outcome,$deloutcome);
7256: my %store_permissions;
7257: my %new_values;
7258: my %new_control;
7259: my %translation;
7260: my @deletions = ();
7261: my $now = time;
7262: if (exists($$changes{'activate'})) {
7263: if (ref($$changes{'activate'}) eq 'HASH') {
7264: my @newitems = sort(keys(%{$$changes{'activate'}}));
7265: my $numnew = scalar(@newitems);
7266: for (my $i=0; $i<$numnew; $i++) {
7267: my $newkey = $newitems[$i];
7268: my $newid = &Apache::loncommon::get_cgi_id();
7269: if ($newkey =~ /^\d+:/) {
7270: $newkey =~ s/^(\d+)/$newid/;
7271: $translation{$1} = $newid;
7272: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7273: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7274: $translation{$1} = $newid;
7275: }
7276: $new_values{$file_name."\0".$newkey} =
7277: $$changes{'activate'}{$newitems[$i]};
7278: $new_control{$newkey} = $now;
7279: }
7280: }
7281: }
7282: my %todelete;
7283: my %changed_items;
7284: foreach my $action ('delete','update') {
7285: if (exists($$changes{$action})) {
7286: if (ref($$changes{$action}) eq 'HASH') {
7287: foreach my $key (keys(%{$$changes{$action}})) {
7288: my ($itemnum) = ($key =~ /^([^:]+):/);
7289: if ($action eq 'delete') {
7290: $todelete{$itemnum} = 1;
7291: } else {
7292: $changed_items{$itemnum} = $key;
7293: }
7294: }
7295: }
7296: }
7297: }
7298: # get lock on access controls for file.
7299: my $lockhash = {
7300: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7301: ':'.$env{'user.domain'},
7302: };
7303: my $tries = 0;
7304: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7305:
7306: while (($gotlock ne 'ok') && $tries <3) {
7307: $tries ++;
7308: sleep 1;
7309: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7310: }
7311: if ($gotlock eq 'ok') {
7312: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7313: my ($tmp)=keys(%curr_permissions);
7314: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7315: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7316: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7317: if (ref($curr_controls) eq 'HASH') {
7318: foreach my $control_item (keys(%{$curr_controls})) {
7319: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7320: if (defined($todelete{$itemnum})) {
7321: push(@deletions,$file_name."\0".$control_item);
7322: } else {
7323: if (defined($changed_items{$itemnum})) {
7324: $new_control{$changed_items{$itemnum}} = $now;
7325: push(@deletions,$file_name."\0".$control_item);
7326: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7327: } else {
7328: $new_control{$control_item} = $$curr_controls{$control_item};
7329: }
7330: }
7331: }
7332: }
7333: }
7334: my ($group);
7335: if (&is_course($domain,$user)) {
7336: ($group,my $file) = split(/\//,$file_name,2);
7337: }
7338: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7339: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7340: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7341: # remove lock
7342: my @del_lock = ($file_name."\0".'locked_access_records');
7343: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
7344: my $sqlresult =
7345: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
7346: $group);
7347: } else {
7348: $outcome = "error: could not obtain lockfile\n";
7349: }
7350: return ($outcome,$deloutcome,\%new_values,\%translation);
7351: }
7352:
7353: sub make_public_indefinitely {
7354: my ($requrl) = @_;
7355: my $now = time;
7356: my $action = 'activate';
7357: my $aclnum = 0;
7358: if (&is_portfolio_url($requrl)) {
7359: my (undef,$udom,$unum,$file_name,$group) =
7360: &parse_portfolio_url($requrl);
7361: my $current_perms = &get_portfile_permissions($udom,$unum);
7362: my %access_controls = &get_access_controls($current_perms,
7363: $group,$file_name);
7364: foreach my $key (keys(%{$access_controls{$file_name}})) {
7365: my ($num,$scope,$end,$start) =
7366: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7367: if ($scope eq 'public') {
7368: if ($start <= $now && $end == 0) {
7369: $action = 'none';
7370: } else {
7371: $action = 'update';
7372: $aclnum = $num;
7373: }
7374: last;
7375: }
7376: }
7377: if ($action eq 'none') {
7378: return 'ok';
7379: } else {
7380: my %changes;
7381: my $newend = 0;
7382: my $newstart = $now;
7383: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7384: $changes{$action}{$newkey} = {
7385: type => 'public',
7386: time => {
7387: start => $newstart,
7388: end => $newend,
7389: },
7390: };
7391: my ($outcome,$deloutcome,$new_values,$translation) =
7392: &modify_access_controls($file_name,\%changes,$udom,$unum);
7393: return $outcome;
7394: }
7395: } else {
7396: return 'invalid';
7397: }
7398: }
7399:
7400: #------------------------------------------------------Get Marked as Read Only
7401:
7402: sub get_marked_as_readonly {
7403: my ($domain,$user,$what,$group) = @_;
7404: my $current_permissions = &get_portfile_permissions($domain,$user);
7405: my @readonly_files;
7406: my $cmp1=$what;
7407: if (ref($what)) { $cmp1=join('',@{$what}) };
7408: while (my ($file_name,$value) = each(%{$current_permissions})) {
7409: if (defined($group)) {
7410: if ($file_name !~ m-^\Q$group\E/-) {
7411: next;
7412: }
7413: }
7414: if (ref($value) eq "ARRAY"){
7415: foreach my $stored_what (@{$value}) {
7416: my $cmp2=$stored_what;
7417: if (ref($stored_what) eq 'ARRAY') {
7418: $cmp2=join('',@{$stored_what});
7419: }
7420: if ($cmp1 eq $cmp2) {
7421: push(@readonly_files, $file_name);
7422: last;
7423: } elsif (!defined($what)) {
7424: push(@readonly_files, $file_name);
7425: last;
7426: }
7427: }
7428: }
7429: }
7430: return @readonly_files;
7431: }
7432: #-----------------------------------------------------------Get Marked as Read Only Hash
7433:
7434: sub get_marked_as_readonly_hash {
7435: my ($current_permissions,$group,$what) = @_;
7436: my %readonly_files;
7437: while (my ($file_name,$value) = each(%{$current_permissions})) {
7438: if (defined($group)) {
7439: if ($file_name !~ m-^\Q$group\E/-) {
7440: next;
7441: }
7442: }
7443: if (ref($value) eq "ARRAY"){
7444: foreach my $stored_what (@{$value}) {
7445: if (ref($stored_what) eq 'ARRAY') {
7446: foreach my $lock_descriptor(@{$stored_what}) {
7447: if ($lock_descriptor eq 'graded') {
7448: $readonly_files{$file_name} = 'graded';
7449: } elsif ($lock_descriptor eq 'handback') {
7450: $readonly_files{$file_name} = 'handback';
7451: } else {
7452: if (!exists($readonly_files{$file_name})) {
7453: $readonly_files{$file_name} = 'locked';
7454: }
7455: }
7456: }
7457: }
7458: }
7459: }
7460: }
7461: return %readonly_files;
7462: }
7463: # ------------------------------------------------------------ Unmark as Read Only
7464:
7465: sub unmark_as_readonly {
7466: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7467: # for portfolio submissions, $what contains [$symb,$crsid]
7468: my ($domain,$user,$what,$file_name,$group) = @_;
7469: $file_name = &declutter_portfile($file_name);
7470: my $symb_crs = $what;
7471: if (ref($what)) { $symb_crs=join('',@$what); }
7472: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
7473: my ($tmp)=keys(%current_permissions);
7474: if ($tmp=~/^error:/) { undef(%current_permissions); }
7475: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
7476: foreach my $file (@readonly_files) {
7477: my $clean_file = &declutter_portfile($file);
7478: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
7479: my $current_locks = $current_permissions{$file};
7480: my @new_locks;
7481: my @del_keys;
7482: if (ref($current_locks) eq "ARRAY"){
7483: foreach my $locker (@{$current_locks}) {
7484: my $compare=$locker;
7485: if (ref($locker) eq 'ARRAY') {
7486: $compare=join('',@{$locker});
7487: if ($compare ne $symb_crs) {
7488: push(@new_locks, $locker);
7489: }
7490: }
7491: }
7492: if (scalar(@new_locks) > 0) {
7493: $current_permissions{$file} = \@new_locks;
7494: } else {
7495: push(@del_keys, $file);
7496: &del('file_permissions',\@del_keys, $domain, $user);
7497: delete($current_permissions{$file});
7498: }
7499: }
7500: }
7501: &put('file_permissions',\%current_permissions,$domain,$user);
7502: return;
7503: }
7504:
7505: # ------------------------------------------------------------ Directory lister
7506:
7507: sub dirlist {
7508: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
7509: $uri=~s/^\///;
7510: $uri=~s/\/$//;
7511: my ($udom, $uname);
7512: if ($getuserdir) {
7513: $udom = $userdomain;
7514: $uname = $username;
7515: } else {
7516: (undef,$udom,$uname)=split(/\//,$uri);
7517: if(defined($userdomain)) {
7518: $udom = $userdomain;
7519: }
7520: if(defined($username)) {
7521: $uname = $username;
7522: }
7523: }
7524: my ($dirRoot,$listing,@listing_results);
7525:
7526: $dirRoot = $perlvar{'lonDocRoot'};
7527: if (defined($getpropath)) {
7528: $dirRoot = &propath($udom,$uname);
7529: $dirRoot =~ s/\/$//;
7530: } elsif (defined($getuserdir)) {
7531: my $subdir=$uname.'__';
7532: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7533: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7534: ."/$udom/$subdir/$uname";
7535: } elsif (defined($alternateRoot)) {
7536: $dirRoot = $alternateRoot;
7537: }
7538:
7539: if($udom) {
7540: if($uname) {
7541: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
7542: .$getuserdir.':'.&escape($dirRoot)
7543: .':'.&escape($uname).':'.&escape($udom),
7544: &homeserver($uname,$udom));
7545: if ($listing eq 'unknown_cmd') {
7546: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7547: &homeserver($uname,$udom));
7548: } else {
7549: @listing_results = map { &unescape($_); } split(/:/,$listing);
7550: }
7551: if ($listing eq 'unknown_cmd') {
7552: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7553: &homeserver($uname,$udom));
7554: @listing_results = split(/:/,$listing);
7555: } else {
7556: @listing_results = map { &unescape($_); } split(/:/,$listing);
7557: }
7558: return @listing_results;
7559: } elsif(!$alternateRoot) {
7560: my %allusers;
7561: my %servers = &get_servers($udom,'library');
7562: foreach my $tryserver (keys(%servers)) {
7563: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7564: &escape($udom),$tryserver);
7565: if ($listing eq 'unknown_cmd') {
7566: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7567: $udom, $tryserver);
7568: } else {
7569: @listing_results = map { &unescape($_); } split(/:/,$listing);
7570: }
7571: if ($listing eq 'unknown_cmd') {
7572: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7573: $udom, $tryserver);
7574: @listing_results = split(/:/,$listing);
7575: } else {
7576: @listing_results =
7577: map { &unescape($_); } split(/:/,$listing);
7578: }
7579: if ($listing_results[0] ne 'no_such_dir' &&
7580: $listing_results[0] ne 'empty' &&
7581: $listing_results[0] ne 'con_lost') {
7582: foreach my $line (@listing_results) {
7583: my ($entry) = split(/&/,$line,2);
7584: $allusers{$entry} = 1;
7585: }
7586: }
7587: }
7588: my $alluserstr='';
7589: foreach my $user (sort(keys(%allusers))) {
7590: $alluserstr.=$user.'&user:';
7591: }
7592: $alluserstr=~s/:$//;
7593: return split(/:/,$alluserstr);
7594: } else {
7595: return ('missing user name');
7596: }
7597: } elsif(!defined($getpropath)) {
7598: my @all_domains = sort(&all_domains());
7599: foreach my $domain (@all_domains) {
7600: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7601: }
7602: return @all_domains;
7603: } else {
7604: return ('missing domain');
7605: }
7606: }
7607:
7608: # --------------------------------------------- GetFileTimestamp
7609: # This function utilizes dirlist and returns the date stamp for
7610: # when it was last modified. It will also return an error of -1
7611: # if an error occurs
7612:
7613: sub GetFileTimestamp {
7614: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
7615: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7616: $studentName = &LONCAPA::clean_username($studentName);
7617: my ($fileStat) =
7618: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7619: undef,$getuserdir);
7620: my @stats = split('&', $fileStat);
7621: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7622: # @stats contains first the filename, then the stat output
7623: return $stats[10]; # so this is 10 instead of 9.
7624: } else {
7625: return -1;
7626: }
7627: }
7628:
7629: sub stat_file {
7630: my ($uri) = @_;
7631: $uri = &clutter_with_no_wrapper($uri);
7632:
7633: my ($udom,$uname,$file);
7634: if ($uri =~ m-^/(uploaded|editupload)/-) {
7635: ($udom,$uname,$file) =
7636: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
7637: $file = 'userfiles/'.$file;
7638: }
7639: if ($uri =~ m-^/res/-) {
7640: ($udom,$uname) =
7641: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
7642: $file = $uri;
7643: }
7644:
7645: if (!$udom || !$uname || !$file) {
7646: # unable to handle the uri
7647: return ();
7648: }
7649: my $getpropath;
7650: if ($file =~ /^userfiles\//) {
7651: $getpropath = 1;
7652: }
7653: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
7654: my @stats = split('&', $result);
7655:
7656: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7657: shift(@stats); #filename is first
7658: return @stats;
7659: }
7660: return ();
7661: }
7662:
7663: # -------------------------------------------------------- Value of a Condition
7664:
7665: # gets the value of a specific preevaluated condition
7666: # stored in the string $env{user.state.<cid>}
7667: # or looks up a condition reference in the bighash and if if hasn't
7668: # already been evaluated recurses into docondval to get the value of
7669: # the condition, then memoizing it to
7670: # $env{user.state.<cid>.<condition>}
7671: sub directcondval {
7672: my $number=shift;
7673: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
7674: &Apache::lonuserstate::evalstate();
7675: }
7676: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7677: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7678: } elsif ($number =~ /^_/) {
7679: my $sub_condition;
7680: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7681: &GDBM_READER(),0640)) {
7682: $sub_condition=$bighash{'conditions'.$number};
7683: untie(%bighash);
7684: }
7685: my $value = &docondval($sub_condition);
7686: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
7687: return $value;
7688: }
7689: if ($env{'user.state.'.$env{'request.course.id'}}) {
7690: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
7691: } else {
7692: return 2;
7693: }
7694: }
7695:
7696: # get the collection of conditions for this resource
7697: sub condval {
7698: my $condidx=shift;
7699: my $allpathcond='';
7700: foreach my $cond (split(/\|/,$condidx)) {
7701: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7702: $allpathcond.=
7703: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7704: }
7705: }
7706: $allpathcond=~s/\|$//;
7707: return &docondval($allpathcond);
7708: }
7709:
7710: #evaluates an expression of conditions
7711: sub docondval {
7712: my ($allpathcond) = @_;
7713: my $result=0;
7714: if ($env{'request.course.id'}
7715: && defined($allpathcond)) {
7716: my $operand='|';
7717: my @stack;
7718: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7719: if ($chunk eq '(') {
7720: push @stack,($operand,$result);
7721: } elsif ($chunk eq ')') {
7722: my $before=pop @stack;
7723: if (pop @stack eq '&') {
7724: $result=$result>$before?$before:$result;
7725: } else {
7726: $result=$result>$before?$result:$before;
7727: }
7728: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7729: $operand=$chunk;
7730: } else {
7731: my $new=directcondval($chunk);
7732: if ($operand eq '&') {
7733: $result=$result>$new?$new:$result;
7734: } else {
7735: $result=$result>$new?$result:$new;
7736: }
7737: }
7738: }
7739: }
7740: return $result;
7741: }
7742:
7743: # ---------------------------------------------------- Devalidate courseresdata
7744:
7745: sub devalidatecourseresdata {
7746: my ($coursenum,$coursedomain)=@_;
7747: my $hashid=$coursenum.':'.$coursedomain;
7748: &devalidate_cache_new('courseres',$hashid);
7749: }
7750:
7751:
7752: # --------------------------------------------------- Course Resourcedata Query
7753: #
7754: # Parameters:
7755: # $coursenum - Number of the course.
7756: # $coursedomain - Domain at which the course was created.
7757: # Returns:
7758: # A hash of the course parameters along (I think) with timestamps
7759: # and version info.
7760:
7761: sub get_courseresdata {
7762: my ($coursenum,$coursedomain)=@_;
7763: my $coursehom=&homeserver($coursenum,$coursedomain);
7764: my $hashid=$coursenum.':'.$coursedomain;
7765: my ($result,$cached)=&is_cached_new('courseres',$hashid);
7766: my %dumpreply;
7767: unless (defined($cached)) {
7768: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
7769: $result=\%dumpreply;
7770: my ($tmp) = keys(%dumpreply);
7771: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7772: &do_cache_new('courseres',$hashid,$result,600);
7773: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7774: return $tmp;
7775: } elsif ($tmp =~ /^(error)/) {
7776: $result=undef;
7777: &do_cache_new('courseres',$hashid,$result,600);
7778: }
7779: }
7780: return $result;
7781: }
7782:
7783: sub devalidateuserresdata {
7784: my ($uname,$udom)=@_;
7785: my $hashid="$udom:$uname";
7786: &devalidate_cache_new('userres',$hashid);
7787: }
7788:
7789: sub get_userresdata {
7790: my ($uname,$udom)=@_;
7791: #most student don\'t have any data set, check if there is some data
7792: if (&EXT_cache_status($udom,$uname)) { return undef; }
7793:
7794: my $hashid="$udom:$uname";
7795: my ($result,$cached)=&is_cached_new('userres',$hashid);
7796: if (!defined($cached)) {
7797: my %resourcedata=&dump('resourcedata',$udom,$uname);
7798: $result=\%resourcedata;
7799: &do_cache_new('userres',$hashid,$result,600);
7800: }
7801: my ($tmp)=keys(%$result);
7802: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7803: return $result;
7804: }
7805: #error 2 occurs when the .db doesn't exist
7806: if ($tmp!~/error: 2 /) {
7807: &logthis("<font color=\"blue\">WARNING:".
7808: " Trying to get resource data for ".
7809: $uname." at ".$udom.": ".
7810: $tmp."</font>");
7811: } elsif ($tmp=~/error: 2 /) {
7812: #&EXT_cache_set($udom,$uname);
7813: &do_cache_new('userres',$hashid,undef,600);
7814: undef($tmp); # not really an error so don't send it back
7815: }
7816: return $tmp;
7817: }
7818: #----------------------------------------------- resdata - return resource data
7819: # Purpose:
7820: # Return resource data for either users or for a course.
7821: # Parameters:
7822: # $name - Course/user name.
7823: # $domain - Name of the domain the user/course is registered on.
7824: # $type - Type of thing $name is (must be 'course' or 'user'
7825: # @which - Array of names of resources desired.
7826: # Returns:
7827: # The value of the first reasource in @which that is found in the
7828: # resource hash.
7829: # Exceptional Conditions:
7830: # If the $type passed in is not valid (not the string 'course' or
7831: # 'user', an undefined reference is returned.
7832: # If none of the resources are found, an undef is returned
7833: sub resdata {
7834: my ($name,$domain,$type,@which)=@_;
7835: my $result;
7836: if ($type eq 'course') {
7837: $result=&get_courseresdata($name,$domain);
7838: } elsif ($type eq 'user') {
7839: $result=&get_userresdata($name,$domain);
7840: }
7841: if (!ref($result)) { return $result; }
7842: foreach my $item (@which) {
7843: if (defined($result->{$item->[0]})) {
7844: return [$result->{$item->[0]},$item->[1]];
7845: }
7846: }
7847: return undef;
7848: }
7849:
7850: #
7851: # EXT resource caching routines
7852: #
7853:
7854: sub clear_EXT_cache_status {
7855: &delenv('cache.EXT.');
7856: }
7857:
7858: sub EXT_cache_status {
7859: my ($target_domain,$target_user) = @_;
7860: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7861: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7862: # We know already the user has no data
7863: return 1;
7864: } else {
7865: return 0;
7866: }
7867: }
7868:
7869: sub EXT_cache_set {
7870: my ($target_domain,$target_user) = @_;
7871: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7872: #&appenv({$cachename => time});
7873: }
7874:
7875: # --------------------------------------------------------- Value of a Variable
7876: sub EXT {
7877:
7878: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7879: unless ($varname) { return ''; }
7880: #get real user name/domain, courseid and symb
7881: my $courseid;
7882: my $publicuser;
7883: if ($symbparm) {
7884: $symbparm=&get_symb_from_alias($symbparm);
7885: }
7886: if (!($uname && $udom)) {
7887: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7888: if (!$symbparm) { $symbparm=$cursymb; }
7889: } else {
7890: $courseid=$env{'request.course.id'};
7891: }
7892: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7893: my $rest;
7894: if (defined($therest[0])) {
7895: $rest=join('.',@therest);
7896: } else {
7897: $rest='';
7898: }
7899:
7900: my $qualifierrest=$qualifier;
7901: if ($rest) { $qualifierrest.='.'.$rest; }
7902: my $spacequalifierrest=$space;
7903: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7904: if ($realm eq 'user') {
7905: # --------------------------------------------------------------- user.resource
7906: if ($space eq 'resource') {
7907: if ( (defined($Apache::lonhomework::parsing_a_problem)
7908: || defined($Apache::lonhomework::parsing_a_task))
7909: &&
7910: ($symbparm eq &symbread()) ) {
7911: # if we are in the middle of processing the resource the
7912: # get the value we are planning on committing
7913: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7914: return $Apache::lonhomework::results{$qualifierrest};
7915: } else {
7916: return $Apache::lonhomework::history{$qualifierrest};
7917: }
7918: } else {
7919: my %restored;
7920: if ($publicuser || $env{'request.state'} eq 'construct') {
7921: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7922: } else {
7923: %restored=&restore($symbparm,$courseid,$udom,$uname);
7924: }
7925: return $restored{$qualifierrest};
7926: }
7927: # ----------------------------------------------------------------- user.access
7928: } elsif ($space eq 'access') {
7929: # FIXME - not supporting calls for a specific user
7930: return &allowed($qualifier,$rest);
7931: # ------------------------------------------ user.preferences, user.environment
7932: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7933: if (($uname eq $env{'user.name'}) &&
7934: ($udom eq $env{'user.domain'})) {
7935: return $env{join('.',('environment',$qualifierrest))};
7936: } else {
7937: my %returnhash;
7938: if (!$publicuser) {
7939: %returnhash=&userenvironment($udom,$uname,
7940: $qualifierrest);
7941: }
7942: return $returnhash{$qualifierrest};
7943: }
7944: # ----------------------------------------------------------------- user.course
7945: } elsif ($space eq 'course') {
7946: # FIXME - not supporting calls for a specific user
7947: return $env{join('.',('request.course',$qualifier))};
7948: # ------------------------------------------------------------------- user.role
7949: } elsif ($space eq 'role') {
7950: # FIXME - not supporting calls for a specific user
7951: my ($role,$where)=split(/\./,$env{'request.role'});
7952: if ($qualifier eq 'value') {
7953: return $role;
7954: } elsif ($qualifier eq 'extent') {
7955: return $where;
7956: }
7957: # ----------------------------------------------------------------- user.domain
7958: } elsif ($space eq 'domain') {
7959: return $udom;
7960: # ------------------------------------------------------------------- user.name
7961: } elsif ($space eq 'name') {
7962: return $uname;
7963: # ---------------------------------------------------- Any other user namespace
7964: } else {
7965: my %reply;
7966: if (!$publicuser) {
7967: %reply=&get($space,[$qualifierrest],$udom,$uname);
7968: }
7969: return $reply{$qualifierrest};
7970: }
7971: } elsif ($realm eq 'query') {
7972: # ---------------------------------------------- pull stuff out of query string
7973: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7974: [$spacequalifierrest]);
7975: return $env{'form.'.$spacequalifierrest};
7976: } elsif ($realm eq 'request') {
7977: # ------------------------------------------------------------- request.browser
7978: if ($space eq 'browser') {
7979: if ($qualifier eq 'textremote') {
7980: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7981: return 1;
7982: } else {
7983: return 0;
7984: }
7985: } else {
7986: return $env{'browser.'.$qualifier};
7987: }
7988: # ------------------------------------------------------------ request.filename
7989: } else {
7990: return $env{'request.'.$spacequalifierrest};
7991: }
7992: } elsif ($realm eq 'course') {
7993: # ---------------------------------------------------------- course.description
7994: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7995: } elsif ($realm eq 'resource') {
7996:
7997: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7998: if (!$symbparm) { $symbparm=&symbread(); }
7999: }
8000:
8001: if ($space eq 'title') {
8002: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
8003: return &gettitle($symbparm);
8004: }
8005:
8006: if ($space eq 'map') {
8007: my ($map) = &decode_symb($symbparm);
8008: return &symbread($map);
8009: }
8010: if ($space eq 'filename') {
8011: if ($symbparm) {
8012: return &clutter((&decode_symb($symbparm))[2]);
8013: }
8014: return &hreflocation('',$env{'request.filename'});
8015: }
8016:
8017: my ($section, $group, @groups);
8018: my ($courselevelm,$courselevel);
8019: if ($symbparm && defined($courseid) &&
8020: $courseid eq $env{'request.course.id'}) {
8021:
8022: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
8023:
8024: # ----------------------------------------------------- Cascading lookup scheme
8025: my $symbp=$symbparm;
8026: my $mapp=&deversion((&decode_symb($symbp))[0]);
8027:
8028: my $symbparm=$symbp.'.'.$spacequalifierrest;
8029: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
8030:
8031: if (($env{'user.name'} eq $uname) &&
8032: ($env{'user.domain'} eq $udom)) {
8033: $section=$env{'request.course.sec'};
8034: @groups = split(/:/,$env{'request.course.groups'});
8035: @groups=&sort_course_groups($courseid,@groups);
8036: } else {
8037: if (! defined($usection)) {
8038: $section=&getsection($udom,$uname,$courseid);
8039: } else {
8040: $section = $usection;
8041: }
8042: @groups = &get_users_groups($udom,$uname,$courseid);
8043: }
8044:
8045: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
8046: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
8047: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
8048:
8049: $courselevel=$courseid.'.'.$spacequalifierrest;
8050: my $courselevelr=$courseid.'.'.$symbparm;
8051: $courselevelm=$courseid.'.'.$mapparm;
8052:
8053: # ----------------------------------------------------------- first, check user
8054:
8055: my $userreply=&resdata($uname,$udom,'user',
8056: ([$courselevelr,'resource'],
8057: [$courselevelm,'map' ],
8058: [$courselevel, 'course' ]));
8059: if (defined($userreply)) { return &get_reply($userreply); }
8060:
8061: # ------------------------------------------------ second, check some of course
8062: my $coursereply;
8063: if (@groups > 0) {
8064: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
8065: $mapparm,$spacequalifierrest);
8066: if (defined($coursereply)) { return &get_reply($coursereply); }
8067: }
8068:
8069: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8070: $env{'course.'.$courseid.'.domain'},
8071: 'course',
8072: ([$seclevelr, 'resource'],
8073: [$seclevelm, 'map' ],
8074: [$seclevel, 'course' ],
8075: [$courselevelr,'resource']));
8076: if (defined($coursereply)) { return &get_reply($coursereply); }
8077:
8078: # ------------------------------------------------------ third, check map parms
8079: my %parmhash=();
8080: my $thisparm='';
8081: if (tie(%parmhash,'GDBM_File',
8082: $env{'request.course.fn'}.'_parms.db',
8083: &GDBM_READER(),0640)) {
8084: $thisparm=$parmhash{$symbparm};
8085: untie(%parmhash);
8086: }
8087: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
8088: }
8089: # ------------------------------------------ fourth, look in resource metadata
8090:
8091: $spacequalifierrest=~s/\./\_/;
8092: my $filename;
8093: if (!$symbparm) { $symbparm=&symbread(); }
8094: if ($symbparm) {
8095: $filename=(&decode_symb($symbparm))[2];
8096: } else {
8097: $filename=$env{'request.filename'};
8098: }
8099: my $metadata=&metadata($filename,$spacequalifierrest);
8100: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8101: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
8102: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8103:
8104: # ---------------------------------------------- fourth, look in rest of course
8105: if ($symbparm && defined($courseid) &&
8106: $courseid eq $env{'request.course.id'}) {
8107: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8108: $env{'course.'.$courseid.'.domain'},
8109: 'course',
8110: ([$courselevelm,'map' ],
8111: [$courselevel, 'course']));
8112: if (defined($coursereply)) { return &get_reply($coursereply); }
8113: }
8114: # ------------------------------------------------------------------ Cascade up
8115: unless ($space eq '0') {
8116: my @parts=split(/_/,$space);
8117: my $id=pop(@parts);
8118: my $part=join('_',@parts);
8119: if ($part eq '') { $part='0'; }
8120: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
8121: $symbparm,$udom,$uname,$section,1);
8122: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
8123: }
8124: if ($recurse) { return undef; }
8125: my $pack_def=&packages_tab_default($filename,$varname);
8126: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
8127: # ---------------------------------------------------- Any other user namespace
8128: } elsif ($realm eq 'environment') {
8129: # ----------------------------------------------------------------- environment
8130: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8131: return $env{'environment.'.$spacequalifierrest};
8132: } else {
8133: if ($uname eq 'anonymous' && $udom eq '') {
8134: return '';
8135: }
8136: my %returnhash=&userenvironment($udom,$uname,
8137: $spacequalifierrest);
8138: return $returnhash{$spacequalifierrest};
8139: }
8140: } elsif ($realm eq 'system') {
8141: # ----------------------------------------------------------------- system.time
8142: if ($space eq 'time') {
8143: return time;
8144: }
8145: } elsif ($realm eq 'server') {
8146: # ----------------------------------------------------------------- system.time
8147: if ($space eq 'name') {
8148: return $ENV{'SERVER_NAME'};
8149: }
8150: }
8151: return '';
8152: }
8153:
8154: sub get_reply {
8155: my ($reply_value) = @_;
8156: if (ref($reply_value) eq 'ARRAY') {
8157: if (wantarray) {
8158: return @$reply_value;
8159: }
8160: return $reply_value->[0];
8161: } else {
8162: return $reply_value;
8163: }
8164: }
8165:
8166: sub check_group_parms {
8167: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8168: my @groupitems = ();
8169: my $resultitem;
8170: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
8171: foreach my $group (@{$groups}) {
8172: foreach my $level (@levels) {
8173: my $item = $courseid.'.['.$group.'].'.$level->[0];
8174: push(@groupitems,[$item,$level->[1]]);
8175: }
8176: }
8177: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8178: $env{'course.'.$courseid.'.domain'},
8179: 'course',@groupitems);
8180: return $coursereply;
8181: }
8182:
8183: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
8184: my ($courseid,@groups) = @_;
8185: @groups = sort(@groups);
8186: return @groups;
8187: }
8188:
8189: sub packages_tab_default {
8190: my ($uri,$varname)=@_;
8191: my (undef,$part,$name)=split(/\./,$varname);
8192:
8193: my (@extension,@specifics,$do_default);
8194: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
8195: my ($pack_type,$pack_part)=split(/_/,$package,2);
8196: if ($pack_type eq 'default') {
8197: $do_default=1;
8198: } elsif ($pack_type eq 'extension') {
8199: push(@extension,[$package,$pack_type,$pack_part]);
8200: } elsif ($pack_part eq $part || $pack_type eq 'part') {
8201: # only look at packages defaults for packages that this id is
8202: push(@specifics,[$package,$pack_type,$pack_part]);
8203: }
8204: }
8205: # first look for a package that matches the requested part id
8206: foreach my $package (@specifics) {
8207: my (undef,$pack_type,$pack_part)=@{$package};
8208: next if ($pack_part ne $part);
8209: if (defined($packagetab{"$pack_type&$name&default"})) {
8210: return $packagetab{"$pack_type&$name&default"};
8211: }
8212: }
8213: # look for any possible matching non extension_ package
8214: foreach my $package (@specifics) {
8215: my (undef,$pack_type,$pack_part)=@{$package};
8216: if (defined($packagetab{"$pack_type&$name&default"})) {
8217: return $packagetab{"$pack_type&$name&default"};
8218: }
8219: if ($pack_type eq 'part') { $pack_part='0'; }
8220: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8221: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
8222: }
8223: }
8224: # look for any posible extension_ match
8225: foreach my $package (@extension) {
8226: my ($package,$pack_type)=@{$package};
8227: if (defined($packagetab{"$pack_type&$name&default"})) {
8228: return $packagetab{"$pack_type&$name&default"};
8229: }
8230: if (defined($packagetab{$package."&$name&default"})) {
8231: return $packagetab{$package."&$name&default"};
8232: }
8233: }
8234: # look for a global default setting
8235: if ($do_default && defined($packagetab{"default&$name&default"})) {
8236: return $packagetab{"default&$name&default"};
8237: }
8238: return undef;
8239: }
8240:
8241: sub add_prefix_and_part {
8242: my ($prefix,$part)=@_;
8243: my $keyroot;
8244: if (defined($prefix) && $prefix !~ /^__/) {
8245: # prefix that has a part already
8246: $keyroot=$prefix;
8247: } elsif (defined($prefix)) {
8248: # prefix that is missing a part
8249: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8250: } else {
8251: # no prefix at all
8252: if (defined($part)) { $keyroot='_'.$part; }
8253: }
8254: return $keyroot;
8255: }
8256:
8257: # ---------------------------------------------------------------- Get metadata
8258:
8259: my %metaentry;
8260: my %importedpartids;
8261: sub metadata {
8262: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
8263: $uri=&declutter($uri);
8264: # if it is a non metadata possible uri return quickly
8265: if (($uri eq '') ||
8266: (($uri =~ m|^/*adm/|) &&
8267: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
8268: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8269: return undef;
8270: }
8271: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8272: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
8273: return undef;
8274: }
8275: my $filename=$uri;
8276: $uri=~s/\.meta$//;
8277: #
8278: # Is the metadata already cached?
8279: # Look at timestamp of caching
8280: # Everything is cached by the main uri, libraries are never directly cached
8281: #
8282: if (!defined($liburi)) {
8283: my ($result,$cached)=&is_cached_new('meta',$uri);
8284: if (defined($cached)) { return $result->{':'.$what}; }
8285: }
8286: {
8287: # Imported parts would go here
8288: my %importedids=();
8289: my @origfileimportpartids=();
8290: my $importedparts=0;
8291: #
8292: # Is this a recursive call for a library?
8293: #
8294: # if (! exists($metacache{$uri})) {
8295: # $metacache{$uri}={};
8296: # }
8297: my $cachetime = 60*60;
8298: if ($liburi) {
8299: $liburi=&declutter($liburi);
8300: $filename=$liburi;
8301: } else {
8302: &devalidate_cache_new('meta',$uri);
8303: undef(%metaentry);
8304: }
8305: my %metathesekeys=();
8306: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
8307: my $metastring;
8308: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
8309: my $which = &hreflocation('','/'.($liburi || $uri));
8310: $metastring =
8311: &Apache::lonnet::ssi_body($which,
8312: ('grade_target' => 'meta'));
8313: $cachetime = 1; # only want this cached in the child not long term
8314: } elsif ($uri !~ m -^(editupload)/-) {
8315: my $file=&filelocation('',&clutter($filename));
8316: #push(@{$metaentry{$uri.'.file'}},$file);
8317: $metastring=&getfile($file);
8318: }
8319: my $parser=HTML::LCParser->new(\$metastring);
8320: my $token;
8321: undef %metathesekeys;
8322: while ($token=$parser->get_token) {
8323: if ($token->[0] eq 'S') {
8324: if (defined($token->[2]->{'package'})) {
8325: #
8326: # This is a package - get package info
8327: #
8328: my $package=$token->[2]->{'package'};
8329: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8330: if (defined($token->[2]->{'id'})) {
8331: $keyroot.='_'.$token->[2]->{'id'};
8332: }
8333: if ($metaentry{':packages'}) {
8334: $metaentry{':packages'}.=','.$package.$keyroot;
8335: } else {
8336: $metaentry{':packages'}=$package.$keyroot;
8337: }
8338: foreach my $pack_entry (keys(%packagetab)) {
8339: my $part=$keyroot;
8340: $part=~s/^\_//;
8341: if ($pack_entry=~/^\Q$package\E\&/ ||
8342: $pack_entry=~/^\Q$package\E_0\&/) {
8343: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
8344: # ignore package.tab specified default values
8345: # here &package_tab_default() will fetch those
8346: if ($subp eq 'default') { next; }
8347: my $value=$packagetab{$pack_entry};
8348: my $unikey;
8349: if ($pack =~ /_0$/) {
8350: $unikey='parameter_0_'.$name;
8351: $part=0;
8352: } else {
8353: $unikey='parameter'.$keyroot.'_'.$name;
8354: }
8355: if ($subp eq 'display') {
8356: $value.=' [Part: '.$part.']';
8357: }
8358: $metaentry{':'.$unikey.'.part'}=$part;
8359: $metathesekeys{$unikey}=1;
8360: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8361: $metaentry{':'.$unikey.'.'.$subp}=$value;
8362: }
8363: if (defined($metaentry{':'.$unikey.'.default'})) {
8364: $metaentry{':'.$unikey}=
8365: $metaentry{':'.$unikey.'.default'};
8366: }
8367: }
8368: }
8369: } else {
8370: #
8371: # This is not a package - some other kind of start tag
8372: #
8373: my $entry=$token->[1];
8374: my $unikey='';
8375:
8376: if ($entry eq 'import') {
8377: #
8378: # Importing a library here
8379: #
8380: my $location=$parser->get_text('/import');
8381: my $dir=$filename;
8382: $dir=~s|[^/]*$||;
8383: $location=&filelocation($dir,$location);
8384:
8385: my $importmode=$token->[2]->{'importmode'};
8386: if ($importmode eq 'problem') {
8387: # Import as problem/response
8388: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8389: } elsif ($importmode eq 'part') {
8390: # Import as part(s)
8391: $importedparts=1;
8392: # We need to get the original file and the imported file to get the part order correct
8393: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
8394: # Load and inspect original file
8395: if ($#origfileimportpartids<0) {
8396: undef(%importedpartids);
8397: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
8398: my $origfile=&getfile($origfilelocation);
8399: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
8400: }
8401:
8402: # Load and inspect imported file
8403: my $impfile=&getfile($location);
8404: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
8405: if ($#impfilepartids>=0) {
8406: # This problem had parts
8407: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
8408: } else {
8409: # Importing by turning a single problem into a problem part
8410: # It gets the import-tags ID as part-ID
8411: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
8412: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
8413: }
8414: } else {
8415: # Normal import
8416: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8417: if (defined($token->[2]->{'id'})) {
8418: $unikey.='_'.$token->[2]->{'id'};
8419: }
8420: }
8421:
8422: if ($depthcount<20) {
8423: my $metadata =
8424: &metadata($uri,'keys', $location,$unikey,
8425: $depthcount+1);
8426: foreach my $meta (split(',',$metadata)) {
8427: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8428: $metathesekeys{$meta}=1;
8429: }
8430:
8431: }
8432: } else {
8433: #
8434: # Not importing, some other kind of non-package, non-library start tag
8435: #
8436: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
8437: if (defined($token->[2]->{'id'})) {
8438: $unikey.='_'.$token->[2]->{'id'};
8439: }
8440: if (defined($token->[2]->{'name'})) {
8441: $unikey.='_'.$token->[2]->{'name'};
8442: }
8443: $metathesekeys{$unikey}=1;
8444: foreach my $param (@{$token->[3]}) {
8445: $metaentry{':'.$unikey.'.'.$param} =
8446: $token->[2]->{$param};
8447: }
8448: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
8449: my $default=$metaentry{':'.$unikey.'.default'};
8450: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8451: # only ws inside the tag, and not in default, so use default
8452: # as value
8453: $metaentry{':'.$unikey}=$default;
8454: } elsif ( $internaltext =~ /\S/ ) {
8455: # something interesting inside the tag
8456: $metaentry{':'.$unikey}=$internaltext;
8457: } else {
8458: # no interesting values, don't set a default
8459: }
8460: # end of not-a-package not-a-library import
8461: }
8462: # end of not-a-package start tag
8463: }
8464: # the next is the end of "start tag"
8465: }
8466: }
8467: my ($extension) = ($uri =~ /\.(\w+)$/);
8468: $extension = lc($extension);
8469: if ($extension eq 'htm') { $extension='html'; }
8470:
8471: foreach my $key (keys(%packagetab)) {
8472: #no specific packages #how's our extension
8473: if ($key!~/^extension_\Q$extension\E&/) { next; }
8474: &metadata_create_package_def($uri,$key,'extension_'.$extension,
8475: \%metathesekeys);
8476: }
8477:
8478: if (!exists($metaentry{':packages'})
8479: || $packagetab{"import_defaults&extension_$extension"}) {
8480: foreach my $key (keys(%packagetab)) {
8481: #no specific packages well let's get default then
8482: if ($key!~/^default&/) { next; }
8483: &metadata_create_package_def($uri,$key,'default',
8484: \%metathesekeys);
8485: }
8486: }
8487: # are there custom rights to evaluate
8488: if ($metaentry{':copyright'} eq 'custom') {
8489:
8490: #
8491: # Importing a rights file here
8492: #
8493: unless ($depthcount) {
8494: my $location=$metaentry{':customdistributionfile'};
8495: my $dir=$filename;
8496: $dir=~s|[^/]*$||;
8497: $location=&filelocation($dir,$location);
8498: my $rights_metadata =
8499: &metadata($uri,'keys',$location,'_rights',
8500: $depthcount+1);
8501: foreach my $rights (split(',',$rights_metadata)) {
8502: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8503: $metathesekeys{$rights}=1;
8504: }
8505: }
8506: }
8507: # uniqifiy package listing
8508: my %seen;
8509: my @uniq_packages =
8510: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8511: $metaentry{':packages'} = join(',',@uniq_packages);
8512:
8513: if ($importedparts) {
8514: # We had imported parts and need to rebuild partorder
8515: $metaentry{':partorder'}='';
8516: $metathesekeys{'partorder'}=1;
8517: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
8518: if ($origfileimportpartids[$index] eq 'part') {
8519: # original part, part of the problem
8520: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
8521: } else {
8522: # we have imported parts at this position
8523: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
8524: }
8525: }
8526: $metaentry{':partorder'}=~s/^\,//;
8527: }
8528:
8529: $metaentry{':keys'} = join(',',keys(%metathesekeys));
8530: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8531: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
8532: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
8533: # this is the end of "was not already recently cached
8534: }
8535: return $metaentry{':'.$what};
8536: }
8537:
8538: sub metadata_create_package_def {
8539: my ($uri,$key,$package,$metathesekeys)=@_;
8540: my ($pack,$name,$subp)=split(/\&/,$key);
8541: if ($subp eq 'default') { next; }
8542:
8543: if (defined($metaentry{':packages'})) {
8544: $metaentry{':packages'}.=','.$package;
8545: } else {
8546: $metaentry{':packages'}=$package;
8547: }
8548: my $value=$packagetab{$key};
8549: my $unikey;
8550: $unikey='parameter_0_'.$name;
8551: $metaentry{':'.$unikey.'.part'}=0;
8552: $$metathesekeys{$unikey}=1;
8553: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8554: $metaentry{':'.$unikey.'.'.$subp}=$value;
8555: }
8556: if (defined($metaentry{':'.$unikey.'.default'})) {
8557: $metaentry{':'.$unikey}=
8558: $metaentry{':'.$unikey.'.default'};
8559: }
8560: }
8561:
8562: sub metadata_generate_part0 {
8563: my ($metadata,$metacache,$uri) = @_;
8564: my %allnames;
8565: foreach my $metakey (keys(%$metadata)) {
8566: if ($metakey=~/^parameter\_(.*)/) {
8567: my $part=$$metacache{':'.$metakey.'.part'};
8568: my $name=$$metacache{':'.$metakey.'.name'};
8569: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
8570: $allnames{$name}=$part;
8571: }
8572: }
8573: }
8574: foreach my $name (keys(%allnames)) {
8575: $$metadata{"parameter_0_$name"}=1;
8576: my $key=":parameter_0_$name";
8577: $$metacache{"$key.part"}='0';
8578: $$metacache{"$key.name"}=$name;
8579: $$metacache{"$key.type"}=$$metacache{':parameter_'.
8580: $allnames{$name}.'_'.$name.
8581: '.type'};
8582: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
8583: '.display'};
8584: my $expr='[Part: '.$allnames{$name}.']';
8585: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
8586: $$metacache{"$key.display"}=$olddis;
8587: }
8588: }
8589:
8590: # ------------------------------------------------------ Devalidate title cache
8591:
8592: sub devalidate_title_cache {
8593: my ($url)=@_;
8594: if (!$env{'request.course.id'}) { return; }
8595: my $symb=&symbread($url);
8596: if (!$symb) { return; }
8597: my $key=$env{'request.course.id'}."\0".$symb;
8598: &devalidate_cache_new('title',$key);
8599: }
8600:
8601: # ------------------------------------------------- Get the title of a course
8602:
8603: sub current_course_title {
8604: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8605: }
8606: # ------------------------------------------------- Get the title of a resource
8607:
8608: sub gettitle {
8609: my $urlsymb=shift;
8610: my $symb=&symbread($urlsymb);
8611: if ($symb) {
8612: my $key=$env{'request.course.id'}."\0".$symb;
8613: my ($result,$cached)=&is_cached_new('title',$key);
8614: if (defined($cached)) {
8615: return $result;
8616: }
8617: my ($map,$resid,$url)=&decode_symb($symb);
8618: my $title='';
8619: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8620: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8621: } else {
8622: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8623: &GDBM_READER(),0640)) {
8624: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8625: $title=$bighash{'title_'.$mapid.'.'.$resid};
8626: untie(%bighash);
8627: }
8628: }
8629: $title=~s/\&colon\;/\:/gs;
8630: if ($title) {
8631: return &do_cache_new('title',$key,$title,600);
8632: }
8633: $urlsymb=$url;
8634: }
8635: my $title=&metadata($urlsymb,'title');
8636: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8637: return $title;
8638: }
8639:
8640: sub get_slot {
8641: my ($which,$cnum,$cdom)=@_;
8642: if (!$cnum || !$cdom) {
8643: (undef,my $courseid)=&whichuser();
8644: $cdom=$env{'course.'.$courseid.'.domain'};
8645: $cnum=$env{'course.'.$courseid.'.num'};
8646: }
8647: my $key=join("\0",'slots',$cdom,$cnum,$which);
8648: my %slotinfo;
8649: if (exists($remembered{$key})) {
8650: $slotinfo{$which} = $remembered{$key};
8651: } else {
8652: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8653: &Apache::lonhomework::showhash(%slotinfo);
8654: my ($tmp)=keys(%slotinfo);
8655: if ($tmp=~/^error:/) { return (); }
8656: $remembered{$key} = $slotinfo{$which};
8657: }
8658: if (ref($slotinfo{$which}) eq 'HASH') {
8659: return %{$slotinfo{$which}};
8660: }
8661: return $slotinfo{$which};
8662: }
8663: # ------------------------------------------------- Update symbolic store links
8664:
8665: sub symblist {
8666: my ($mapname,%newhash)=@_;
8667: $mapname=&deversion(&declutter($mapname));
8668: my %hash;
8669: if (($env{'request.course.fn'}) && (%newhash)) {
8670: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8671: &GDBM_WRCREAT(),0640)) {
8672: foreach my $url (keys(%newhash)) {
8673: next if ($url eq 'last_known'
8674: && $env{'form.no_update_last_known'});
8675: $hash{declutter($url)}=&encode_symb($mapname,
8676: $newhash{$url}->[1],
8677: $newhash{$url}->[0]);
8678: }
8679: if (untie(%hash)) {
8680: return 'ok';
8681: }
8682: }
8683: }
8684: return 'error';
8685: }
8686:
8687: # --------------------------------------------------------------- Verify a symb
8688:
8689: sub symbverify {
8690: my ($symb,$thisurl)=@_;
8691: my $thisfn=$thisurl;
8692: $thisfn=&declutter($thisfn);
8693: # direct jump to resource in page or to a sequence - will construct own symbs
8694: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8695: # check URL part
8696: my ($map,$resid,$url)=&decode_symb($symb);
8697:
8698: unless ($url eq $thisfn) { return 0; }
8699:
8700: $symb=&symbclean($symb);
8701: $thisurl=&deversion($thisurl);
8702: $thisfn=&deversion($thisfn);
8703:
8704: my %bighash;
8705: my $okay=0;
8706:
8707: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8708: &GDBM_READER(),0640)) {
8709: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8710: $thisurl =~ s/\?.+$//;
8711: }
8712: my $ids=$bighash{'ids_'.&clutter($thisurl)};
8713: unless ($ids) {
8714: $ids=$bighash{'ids_/'.$thisurl};
8715: }
8716: if ($ids) {
8717: # ------------------------------------------------------------------- Has ID(s)
8718: foreach my $id (split(/\,/,$ids)) {
8719: my ($mapid,$resid)=split(/\./,$id);
8720: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8721: $symb =~ s/\?.+$//;
8722: }
8723: if (
8724: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8725: eq $symb) {
8726: if (($env{'request.role.adv'}) ||
8727: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
8728: $okay=1;
8729: }
8730: }
8731: }
8732: }
8733: untie(%bighash);
8734: }
8735: return $okay;
8736: }
8737:
8738: # --------------------------------------------------------------- Clean-up symb
8739:
8740: sub symbclean {
8741: my $symb=shift;
8742: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8743: # remove version from map
8744: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
8745:
8746: # remove version from URL
8747: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
8748:
8749: # remove wrapper
8750:
8751: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
8752: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
8753: return $symb;
8754: }
8755:
8756: # ---------------------------------------------- Split symb to find map and url
8757:
8758: sub encode_symb {
8759: my ($map,$resid,$url)=@_;
8760: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8761: }
8762:
8763: sub decode_symb {
8764: my $symb=shift;
8765: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8766: my ($map,$resid,$url)=split(/___/,$symb);
8767: return (&fixversion($map),$resid,&fixversion($url));
8768: }
8769:
8770: sub fixversion {
8771: my $fn=shift;
8772: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
8773: my %bighash;
8774: my $uri=&clutter($fn);
8775: my $key=$env{'request.course.id'}.'_'.$uri;
8776: # is this cached?
8777: my ($result,$cached)=&is_cached_new('courseresversion',$key);
8778: if (defined($cached)) { return $result; }
8779: # unfortunately not cached, or expired
8780: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8781: &GDBM_READER(),0640)) {
8782: if ($bighash{'version_'.$uri}) {
8783: my $version=$bighash{'version_'.$uri};
8784: unless (($version eq 'mostrecent') ||
8785: ($version==&getversion($uri))) {
8786: $uri=~s/\.(\w+)$/\.$version\.$1/;
8787: }
8788: }
8789: untie %bighash;
8790: }
8791: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
8792: }
8793:
8794: sub deversion {
8795: my $url=shift;
8796: $url=~s/\.\d+\.(\w+)$/\.$1/;
8797: return $url;
8798: }
8799:
8800: # ------------------------------------------------------ Return symb list entry
8801:
8802: sub symbread {
8803: my ($thisfn,$donotrecurse)=@_;
8804: my $cache_str='request.symbread.cached.'.$thisfn;
8805: if (defined($env{$cache_str})) { return $env{$cache_str}; }
8806: # no filename provided? try from environment
8807: unless ($thisfn) {
8808: if ($env{'request.symb'}) {
8809: return $env{$cache_str}=&symbclean($env{'request.symb'});
8810: }
8811: $thisfn=$env{'request.filename'};
8812: }
8813: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8814: # is that filename actually a symb? Verify, clean, and return
8815: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
8816: if (&symbverify($thisfn,$1)) {
8817: return $env{$cache_str}=&symbclean($thisfn);
8818: }
8819: }
8820: $thisfn=declutter($thisfn);
8821: my %hash;
8822: my %bighash;
8823: my $syval='';
8824: if (($env{'request.course.fn'}) && ($thisfn)) {
8825: my $targetfn = $thisfn;
8826: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
8827: $targetfn = 'adm/wrapper/'.$thisfn;
8828: }
8829: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8830: $targetfn=$1;
8831: }
8832: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8833: &GDBM_READER(),0640)) {
8834: $syval=$hash{$targetfn};
8835: untie(%hash);
8836: }
8837: # ---------------------------------------------------------- There was an entry
8838: if ($syval) {
8839: #unless ($syval=~/\_\d+$/) {
8840: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
8841: #&appenv({'request.ambiguous' => $thisfn});
8842: #return $env{$cache_str}='';
8843: #}
8844: #$syval.=$1;
8845: #}
8846: } else {
8847: # ------------------------------------------------------- Was not in symb table
8848: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8849: &GDBM_READER(),0640)) {
8850: # ---------------------------------------------- Get ID(s) for current resource
8851: my $ids=$bighash{'ids_'.&clutter($thisfn)};
8852: unless ($ids) {
8853: $ids=$bighash{'ids_/'.$thisfn};
8854: }
8855: unless ($ids) {
8856: # alias?
8857: $ids=$bighash{'mapalias_'.$thisfn};
8858: }
8859: if ($ids) {
8860: # ------------------------------------------------------------------- Has ID(s)
8861: my @possibilities=split(/\,/,$ids);
8862: if ($#possibilities==0) {
8863: # ----------------------------------------------- There is only one possibility
8864: my ($mapid,$resid)=split(/\./,$ids);
8865: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8866: $resid,$thisfn);
8867: } elsif (!$donotrecurse) {
8868: # ------------------------------------------ There is more than one possibility
8869: my $realpossible=0;
8870: foreach my $id (@possibilities) {
8871: my $file=$bighash{'src_'.$id};
8872: if (&allowed('bre',$file)) {
8873: my ($mapid,$resid)=split(/\./,$id);
8874: if ($bighash{'map_type_'.$mapid} ne 'page') {
8875: $realpossible++;
8876: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8877: $resid,$thisfn);
8878: }
8879: }
8880: }
8881: if ($realpossible!=1) { $syval=''; }
8882: } else {
8883: $syval='';
8884: }
8885: }
8886: untie(%bighash)
8887: }
8888: }
8889: if ($syval) {
8890: return $env{$cache_str}=$syval;
8891: }
8892: }
8893: &appenv({'request.ambiguous' => $thisfn});
8894: return $env{$cache_str}='';
8895: }
8896:
8897: # ---------------------------------------------------------- Return random seed
8898:
8899: sub numval {
8900: my $txt=shift;
8901: $txt=~tr/A-J/0-9/;
8902: $txt=~tr/a-j/0-9/;
8903: $txt=~tr/K-T/0-9/;
8904: $txt=~tr/k-t/0-9/;
8905: $txt=~tr/U-Z/0-5/;
8906: $txt=~tr/u-z/0-5/;
8907: $txt=~s/\D//g;
8908: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8909: return int($txt);
8910: }
8911:
8912: sub numval2 {
8913: my $txt=shift;
8914: $txt=~tr/A-J/0-9/;
8915: $txt=~tr/a-j/0-9/;
8916: $txt=~tr/K-T/0-9/;
8917: $txt=~tr/k-t/0-9/;
8918: $txt=~tr/U-Z/0-5/;
8919: $txt=~tr/u-z/0-5/;
8920: $txt=~s/\D//g;
8921: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8922: my $total;
8923: foreach my $val (@txts) { $total+=$val; }
8924: if ($_64bit) { if ($total > 2**32) { return -1; } }
8925: return int($total);
8926: }
8927:
8928: sub numval3 {
8929: use integer;
8930: my $txt=shift;
8931: $txt=~tr/A-J/0-9/;
8932: $txt=~tr/a-j/0-9/;
8933: $txt=~tr/K-T/0-9/;
8934: $txt=~tr/k-t/0-9/;
8935: $txt=~tr/U-Z/0-5/;
8936: $txt=~tr/u-z/0-5/;
8937: $txt=~s/\D//g;
8938: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8939: my $total;
8940: foreach my $val (@txts) { $total+=$val; }
8941: if ($_64bit) { $total=(($total<<32)>>32); }
8942: return $total;
8943: }
8944:
8945: sub digest {
8946: my ($data)=@_;
8947: my $digest=&Digest::MD5::md5($data);
8948: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8949: my ($e,$f);
8950: {
8951: use integer;
8952: $e=($a+$b);
8953: $f=($c+$d);
8954: if ($_64bit) {
8955: $e=(($e<<32)>>32);
8956: $f=(($f<<32)>>32);
8957: }
8958: }
8959: if (wantarray) {
8960: return ($e,$f);
8961: } else {
8962: my $g;
8963: {
8964: use integer;
8965: $g=($e+$f);
8966: if ($_64bit) {
8967: $g=(($g<<32)>>32);
8968: }
8969: }
8970: return $g;
8971: }
8972: }
8973:
8974: sub latest_rnd_algorithm_id {
8975: return '64bit5';
8976: }
8977:
8978: sub get_rand_alg {
8979: my ($courseid)=@_;
8980: if (!$courseid) { $courseid=(&whichuser())[1]; }
8981: if ($courseid) {
8982: return $env{"course.$courseid.rndseed"};
8983: }
8984: return &latest_rnd_algorithm_id();
8985: }
8986:
8987: sub validCODE {
8988: my ($CODE)=@_;
8989: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8990: return 0;
8991: }
8992:
8993: sub getCODE {
8994: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8995: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8996: defined($Apache::lonhomework::parsing_a_task) ) &&
8997: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8998: return $Apache::lonhomework::history{'resource.CODE'};
8999: }
9000: return undef;
9001: }
9002:
9003: sub rndseed {
9004: my ($symb,$courseid,$domain,$username)=@_;
9005: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
9006: if (!defined($symb)) {
9007: unless ($symb=$wsymb) { return time; }
9008: }
9009: if (!$courseid) { $courseid=$wcourseid; }
9010: if (!$domain) { $domain=$wdomain; }
9011: if (!$username) { $username=$wusername }
9012: my $which=&get_rand_alg();
9013:
9014: if (defined(&getCODE())) {
9015: if ($which eq '64bit5') {
9016: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
9017: } elsif ($which eq '64bit4') {
9018: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
9019: } else {
9020: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
9021: }
9022: } elsif ($which eq '64bit5') {
9023: return &rndseed_64bit5($symb,$courseid,$domain,$username);
9024: } elsif ($which eq '64bit4') {
9025: return &rndseed_64bit4($symb,$courseid,$domain,$username);
9026: } elsif ($which eq '64bit3') {
9027: return &rndseed_64bit3($symb,$courseid,$domain,$username);
9028: } elsif ($which eq '64bit2') {
9029: return &rndseed_64bit2($symb,$courseid,$domain,$username);
9030: } elsif ($which eq '64bit') {
9031: return &rndseed_64bit($symb,$courseid,$domain,$username);
9032: }
9033: return &rndseed_32bit($symb,$courseid,$domain,$username);
9034: }
9035:
9036: sub rndseed_32bit {
9037: my ($symb,$courseid,$domain,$username)=@_;
9038: {
9039: use integer;
9040: my $symbchck=unpack("%32C*",$symb) << 27;
9041: my $symbseed=numval($symb) << 22;
9042: my $namechck=unpack("%32C*",$username) << 17;
9043: my $nameseed=numval($username) << 12;
9044: my $domainseed=unpack("%32C*",$domain) << 7;
9045: my $courseseed=unpack("%32C*",$courseid);
9046: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
9047: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9048: #&logthis("rndseed :$num:$symb");
9049: if ($_64bit) { $num=(($num<<32)>>32); }
9050: return $num;
9051: }
9052: }
9053:
9054: sub rndseed_64bit {
9055: my ($symb,$courseid,$domain,$username)=@_;
9056: {
9057: use integer;
9058: my $symbchck=unpack("%32S*",$symb) << 21;
9059: my $symbseed=numval($symb) << 10;
9060: my $namechck=unpack("%32S*",$username);
9061:
9062: my $nameseed=numval($username) << 21;
9063: my $domainseed=unpack("%32S*",$domain) << 10;
9064: my $courseseed=unpack("%32S*",$courseid);
9065:
9066: my $num1=$symbchck+$symbseed+$namechck;
9067: my $num2=$nameseed+$domainseed+$courseseed;
9068: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9069: #&logthis("rndseed :$num:$symb");
9070: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9071: return "$num1,$num2";
9072: }
9073: }
9074:
9075: sub rndseed_64bit2 {
9076: my ($symb,$courseid,$domain,$username)=@_;
9077: {
9078: use integer;
9079: # strings need to be an even # of cahracters long, it it is odd the
9080: # last characters gets thrown away
9081: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9082: my $symbseed=numval($symb) << 10;
9083: my $namechck=unpack("%32S*",$username.' ');
9084:
9085: my $nameseed=numval($username) << 21;
9086: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9087: my $courseseed=unpack("%32S*",$courseid.' ');
9088:
9089: my $num1=$symbchck+$symbseed+$namechck;
9090: my $num2=$nameseed+$domainseed+$courseseed;
9091: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9092: #&logthis("rndseed :$num:$symb");
9093: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9094: return "$num1,$num2";
9095: }
9096: }
9097:
9098: sub rndseed_64bit3 {
9099: my ($symb,$courseid,$domain,$username)=@_;
9100: {
9101: use integer;
9102: # strings need to be an even # of cahracters long, it it is odd the
9103: # last characters gets thrown away
9104: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9105: my $symbseed=numval2($symb) << 10;
9106: my $namechck=unpack("%32S*",$username.' ');
9107:
9108: my $nameseed=numval2($username) << 21;
9109: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9110: my $courseseed=unpack("%32S*",$courseid.' ');
9111:
9112: my $num1=$symbchck+$symbseed+$namechck;
9113: my $num2=$nameseed+$domainseed+$courseseed;
9114: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9115: #&logthis("rndseed :$num1:$num2:$_64bit");
9116: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9117:
9118: return "$num1:$num2";
9119: }
9120: }
9121:
9122: sub rndseed_64bit4 {
9123: my ($symb,$courseid,$domain,$username)=@_;
9124: {
9125: use integer;
9126: # strings need to be an even # of cahracters long, it it is odd the
9127: # last characters gets thrown away
9128: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9129: my $symbseed=numval3($symb) << 10;
9130: my $namechck=unpack("%32S*",$username.' ');
9131:
9132: my $nameseed=numval3($username) << 21;
9133: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9134: my $courseseed=unpack("%32S*",$courseid.' ');
9135:
9136: my $num1=$symbchck+$symbseed+$namechck;
9137: my $num2=$nameseed+$domainseed+$courseseed;
9138: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9139: #&logthis("rndseed :$num1:$num2:$_64bit");
9140: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9141:
9142: return "$num1:$num2";
9143: }
9144: }
9145:
9146: sub rndseed_64bit5 {
9147: my ($symb,$courseid,$domain,$username)=@_;
9148: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
9149: return "$num1:$num2";
9150: }
9151:
9152: sub rndseed_CODE_64bit {
9153: my ($symb,$courseid,$domain,$username)=@_;
9154: {
9155: use integer;
9156: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9157: my $symbseed=numval2($symb);
9158: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9159: my $CODEseed=numval(&getCODE());
9160: my $courseseed=unpack("%32S*",$courseid.' ');
9161: my $num1=$symbseed+$CODEchck;
9162: my $num2=$CODEseed+$courseseed+$symbchck;
9163: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9164: #&logthis("rndseed :$num1:$num2:$symb");
9165: if ($_64bit) { $num1=(($num1<<32)>>32); }
9166: if ($_64bit) { $num2=(($num2<<32)>>32); }
9167: return "$num1:$num2";
9168: }
9169: }
9170:
9171: sub rndseed_CODE_64bit4 {
9172: my ($symb,$courseid,$domain,$username)=@_;
9173: {
9174: use integer;
9175: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9176: my $symbseed=numval3($symb);
9177: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9178: my $CODEseed=numval3(&getCODE());
9179: my $courseseed=unpack("%32S*",$courseid.' ');
9180: my $num1=$symbseed+$CODEchck;
9181: my $num2=$CODEseed+$courseseed+$symbchck;
9182: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9183: #&logthis("rndseed :$num1:$num2:$symb");
9184: if ($_64bit) { $num1=(($num1<<32)>>32); }
9185: if ($_64bit) { $num2=(($num2<<32)>>32); }
9186: return "$num1:$num2";
9187: }
9188: }
9189:
9190: sub rndseed_CODE_64bit5 {
9191: my ($symb,$courseid,$domain,$username)=@_;
9192: my $code = &getCODE();
9193: my ($num1,$num2)=&digest("$symb,$courseid,$code");
9194: return "$num1:$num2";
9195: }
9196:
9197: sub setup_random_from_rndseed {
9198: my ($rndseed)=@_;
9199: if ($rndseed =~/([,:])/) {
9200: my ($num1,$num2)=split(/[,:]/,$rndseed);
9201: &Math::Random::random_set_seed(abs($num1),abs($num2));
9202: } else {
9203: &Math::Random::random_set_seed_from_phrase($rndseed);
9204: }
9205: }
9206:
9207: sub latest_receipt_algorithm_id {
9208: return 'receipt3';
9209: }
9210:
9211: sub recunique {
9212: my $fucourseid=shift;
9213: my $unique;
9214: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9215: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
9216: $unique=$env{"course.$fucourseid.internal.encseed"};
9217: } else {
9218: $unique=$perlvar{'lonReceipt'};
9219: }
9220: return unpack("%32C*",$unique);
9221: }
9222:
9223: sub recprefix {
9224: my $fucourseid=shift;
9225: my $prefix;
9226: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9227: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
9228: $prefix=$env{"course.$fucourseid.internal.encpref"};
9229: } else {
9230: $prefix=$perlvar{'lonHostID'};
9231: }
9232: return unpack("%32C*",$prefix);
9233: }
9234:
9235: sub ireceipt {
9236: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
9237:
9238: my $return =&recprefix($fucourseid).'-';
9239:
9240: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9241: $env{'request.state'} eq 'construct') {
9242: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9243: return $return;
9244: }
9245:
9246: my $cuname=unpack("%32C*",$funame);
9247: my $cudom=unpack("%32C*",$fudom);
9248: my $cucourseid=unpack("%32C*",$fucourseid);
9249: my $cusymb=unpack("%32C*",$fusymb);
9250: my $cunique=&recunique($fucourseid);
9251: my $cpart=unpack("%32S*",$part);
9252: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9253:
9254: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
9255:
9256: $return.= ($cunique%$cuname+
9257: $cunique%$cudom+
9258: $cusymb%$cuname+
9259: $cusymb%$cudom+
9260: $cucourseid%$cuname+
9261: $cucourseid%$cudom+
9262: $cpart%$cuname+
9263: $cpart%$cudom);
9264: } else {
9265: $return.= ($cunique%$cuname+
9266: $cunique%$cudom+
9267: $cusymb%$cuname+
9268: $cusymb%$cudom+
9269: $cucourseid%$cuname+
9270: $cucourseid%$cudom);
9271: }
9272: return $return;
9273: }
9274:
9275: sub receipt {
9276: my ($part)=@_;
9277: my ($symb,$courseid,$domain,$name) = &whichuser();
9278: return &ireceipt($name,$domain,$courseid,$symb,$part);
9279: }
9280:
9281: sub whichuser {
9282: my ($passedsymb)=@_;
9283: my ($symb,$courseid,$domain,$name,$publicuser);
9284: if (defined($env{'form.grade_symb'})) {
9285: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9286: my $allowed=&allowed('vgr',$tmp_courseid);
9287: if (!$allowed &&
9288: exists($env{'request.course.sec'}) &&
9289: $env{'request.course.sec'} !~ /^\s*$/) {
9290: $allowed=&allowed('vgr',$tmp_courseid.
9291: '/'.$env{'request.course.sec'});
9292: }
9293: if ($allowed) {
9294: ($symb)=&get_env_multiple('form.grade_symb');
9295: $courseid=$tmp_courseid;
9296: ($domain)=&get_env_multiple('form.grade_domain');
9297: ($name)=&get_env_multiple('form.grade_username');
9298: return ($symb,$courseid,$domain,$name,$publicuser);
9299: }
9300: }
9301: if (!$passedsymb) {
9302: $symb=&symbread();
9303: } else {
9304: $symb=$passedsymb;
9305: }
9306: $courseid=$env{'request.course.id'};
9307: $domain=$env{'user.domain'};
9308: $name=$env{'user.name'};
9309: if ($name eq 'public' && $domain eq 'public') {
9310: if (!defined($env{'form.username'})) {
9311: $env{'form.username'}.=time.rand(10000000);
9312: }
9313: $name.=$env{'form.username'};
9314: }
9315: return ($symb,$courseid,$domain,$name,$publicuser);
9316:
9317: }
9318:
9319: # ------------------------------------------------------------ Serves up a file
9320: # returns either the contents of the file or
9321: # -1 if the file doesn't exist
9322: #
9323: # if the target is a file that was uploaded via DOCS,
9324: # a check will be made to see if a current copy exists on the local server,
9325: # if it does this will be served, otherwise a copy will be retrieved from
9326: # the home server for the course and stored in /home/httpd/html/userfiles on
9327: # the local server.
9328:
9329: sub getfile {
9330: my ($file) = @_;
9331: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9332: &repcopy($file);
9333: return &readfile($file);
9334: }
9335:
9336: sub repcopy_userfile {
9337: my ($file)=@_;
9338: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9339: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
9340: my ($cdom,$cnum,$filename) =
9341: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
9342: my $uri="/uploaded/$cdom/$cnum/$filename";
9343: if (-e "$file") {
9344: # we already have a local copy, check it out
9345: my @fileinfo = stat($file);
9346: my $rtncode;
9347: my $info;
9348: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
9349: if ($lwpresp ne 'ok') {
9350: # there is no such file anymore, even though we had a local copy
9351: if ($rtncode eq '404') {
9352: unlink($file);
9353: }
9354: return -1;
9355: }
9356: if ($info < $fileinfo[9]) {
9357: # nice, the file we have is up-to-date, just say okay
9358: return 'ok';
9359: } else {
9360: # the file is outdated, get rid of it
9361: unlink($file);
9362: }
9363: }
9364: # one way or the other, at this point, we don't have the file
9365: # construct the correct path for the file
9366: my @parts = ($cdom,$cnum);
9367: if ($filename =~ m|^(.+)/[^/]+$|) {
9368: push @parts, split(/\//,$1);
9369: }
9370: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9371: foreach my $part (@parts) {
9372: $path .= '/'.$part;
9373: if (!-e $path) {
9374: mkdir($path,0770);
9375: }
9376: }
9377: # now the path exists for sure
9378: # get a user agent
9379: my $ua=new LWP::UserAgent;
9380: my $transferfile=$file.'.in.transfer';
9381: # FIXME: this should flock
9382: if (-e $transferfile) { return 'ok'; }
9383: my $request;
9384: $uri=~s/^\///;
9385: my $homeserver = &homeserver($cnum,$cdom);
9386: my $protocol = $protocol{$homeserver};
9387: $protocol = 'http' if ($protocol ne 'https');
9388: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
9389: my $response=$ua->request($request,$transferfile);
9390: # did it work?
9391: if ($response->is_error()) {
9392: unlink($transferfile);
9393: &logthis("Userfile repcopy failed for $uri");
9394: return -1;
9395: }
9396: # worked, rename the transfer file
9397: rename($transferfile,$file);
9398: return 'ok';
9399: }
9400:
9401: sub tokenwrapper {
9402: my $uri=shift;
9403: $uri=~s|^https?\://([^/]+)||;
9404: $uri=~s|^/||;
9405: $env{'user.environment'}=~/\/([^\/]+)\.id/;
9406: my $token=$1;
9407: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9408: if ($udom && $uname && $file) {
9409: $file=~s|(\?\.*)*$||;
9410: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
9411: my $homeserver = &homeserver($uname,$udom);
9412: my $protocol = $protocol{$homeserver};
9413: $protocol = 'http' if ($protocol ne 'https');
9414: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
9415: (($uri=~/\?/)?'&':'?').'token='.$token.
9416: '&tokenissued='.$perlvar{'lonHostID'};
9417: } else {
9418: return '/adm/notfound.html';
9419: }
9420: }
9421:
9422: # call with reqtype HEAD: get last modification time
9423: # call with reqtype GET: get the file contents
9424: # Do not call this with reqtype GET for large files! It loads everything into memory
9425: #
9426: sub getuploaded {
9427: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9428: $uri=~s/^\///;
9429: my $homeserver = &homeserver($cnum,$cdom);
9430: my $protocol = $protocol{$homeserver};
9431: $protocol = 'http' if ($protocol ne 'https');
9432: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
9433: my $ua=new LWP::UserAgent;
9434: my $request=new HTTP::Request($reqtype,$uri);
9435: my $response=$ua->request($request);
9436: $$rtncode = $response->code;
9437: if (! $response->is_success()) {
9438: return 'failed';
9439: }
9440: if ($reqtype eq 'HEAD') {
9441: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
9442: } elsif ($reqtype eq 'GET') {
9443: $$info = $response->content;
9444: }
9445: return 'ok';
9446: }
9447:
9448: sub readfile {
9449: my $file = shift;
9450: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9451: my $fh;
9452: open($fh,"<$file");
9453: my $a='';
9454: while (my $line = <$fh>) { $a .= $line; }
9455: return $a;
9456: }
9457:
9458: sub filelocation {
9459: my ($dir,$file) = @_;
9460: my $location;
9461: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
9462:
9463: if ($file =~ m-^/adm/-) {
9464: $file=~s-^/adm/wrapper/-/-;
9465: $file=~s-^/adm/coursedocs/showdoc/-/-;
9466: }
9467:
9468: if ($file=~m:^/~:) { # is a contruction space reference
9469: $location = $file;
9470: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
9471: } elsif ($file=~m{^/home/$match_username/public_html/}) {
9472: # is a correct contruction space reference
9473: $location = $file;
9474: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9475: $location = $file;
9476: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
9477: my ($udom,$uname,$filename)=
9478: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
9479: my $home=&homeserver($uname,$udom);
9480: my $is_me=0;
9481: my @ids=¤t_machine_ids();
9482: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9483: if ($is_me) {
9484: $location=&propath($udom,$uname).'/userfiles/'.$filename;
9485: } else {
9486: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9487: $udom.'/'.$uname.'/'.$filename;
9488: }
9489: } elsif ($file =~ m-^/adm/-) {
9490: $location = $perlvar{'lonDocRoot'}.'/'.$file;
9491: } else {
9492: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9493: $file=~s:^/res/:/:;
9494: if ( !( $file =~ m:^/:) ) {
9495: $location = $dir. '/'.$file;
9496: } else {
9497: $location = '/home/httpd/html/res'.$file;
9498: }
9499: }
9500: $location=~s://+:/:g; # remove duplicate /
9501: while ($location=~m{/\.\./}) {
9502: if ($location =~ m{/[^/]+/\.\./}) {
9503: $location=~ s{/[^/]+/\.\./}{/}g;
9504: } else {
9505: $location=~ s{/\.\./}{/}g;
9506: }
9507: } #remove dir/..
9508: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9509: return $location;
9510: }
9511:
9512: sub hreflocation {
9513: my ($dir,$file)=@_;
9514: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
9515: $file=filelocation($dir,$file);
9516: } elsif ($file=~m-^/adm/-) {
9517: $file=~s-^/adm/wrapper/-/-;
9518: $file=~s-^/adm/coursedocs/showdoc/-/-;
9519: }
9520: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9521: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
9522: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9523: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
9524: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
9525: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
9526: -/uploaded/$1/$2/-x;
9527: }
9528: if ($file=~ m{^/userfiles/}) {
9529: $file =~ s{^/userfiles/}{/uploaded/};
9530: }
9531: return $file;
9532: }
9533:
9534: sub current_machine_domains {
9535: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9536: }
9537:
9538: sub machine_domains {
9539: my ($hostname) = @_;
9540: my @domains;
9541: my %hostname = &all_hostnames();
9542: while( my($id, $name) = each(%hostname)) {
9543: # &logthis("-$id-$name-$hostname-");
9544: if ($hostname eq $name) {
9545: push(@domains,&host_domain($id));
9546: }
9547: }
9548: return @domains;
9549: }
9550:
9551: sub current_machine_ids {
9552: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9553: }
9554:
9555: sub machine_ids {
9556: my ($hostname) = @_;
9557: $hostname ||= &hostname($perlvar{'lonHostID'});
9558: my @ids;
9559: my %name_to_host = &all_names();
9560: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9561: return @{ $name_to_host{$hostname} };
9562: }
9563: return;
9564: }
9565:
9566: sub additional_machine_domains {
9567: my @domains;
9568: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9569: while( my $line = <$fh>) {
9570: $line =~ s/\s//g;
9571: push(@domains,$line);
9572: }
9573: return @domains;
9574: }
9575:
9576: sub default_login_domain {
9577: my $domain = $perlvar{'lonDefDomain'};
9578: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9579: foreach my $posdom (¤t_machine_domains(),
9580: &additional_machine_domains()) {
9581: if (lc($posdom) eq lc($testdomain)) {
9582: $domain=$posdom;
9583: last;
9584: }
9585: }
9586: return $domain;
9587: }
9588:
9589: # ------------------------------------------------------------- Declutters URLs
9590:
9591: sub declutter {
9592: my $thisfn=shift;
9593: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9594: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9595: $thisfn=~s/^\///;
9596: $thisfn=~s|^adm/wrapper/||;
9597: $thisfn=~s|^adm/coursedocs/showdoc/||;
9598: $thisfn=~s/^res\///;
9599: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9600: $thisfn=~s/\?.+$//;
9601: }
9602: return $thisfn;
9603: }
9604:
9605: # ------------------------------------------------------------- Clutter up URLs
9606:
9607: sub clutter {
9608: my $thisfn='/'.&declutter(shift);
9609: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
9610: || $thisfn =~ m{^/adm/(includes|pages)} ) {
9611: $thisfn='/res'.$thisfn;
9612: }
9613: if ($thisfn !~m|^/adm|) {
9614: if ($thisfn =~ m|^/ext/|) {
9615: $thisfn='/adm/wrapper'.$thisfn;
9616: } else {
9617: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9618: my $embstyle=&Apache::loncommon::fileembstyle($ext);
9619: if ($embstyle eq 'ssi'
9620: || ($embstyle eq 'hdn')
9621: || ($embstyle eq 'rat')
9622: || ($embstyle eq 'prv')
9623: || ($embstyle eq 'ign')) {
9624: #do nothing with these
9625: } elsif (($embstyle eq 'img')
9626: || ($embstyle eq 'emb')
9627: || ($embstyle eq 'wrp')) {
9628: $thisfn='/adm/wrapper'.$thisfn;
9629: } elsif ($embstyle eq 'unk'
9630: && $thisfn!~/\.(sequence|page)$/) {
9631: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
9632: } else {
9633: # &logthis("Got a blank emb style");
9634: }
9635: }
9636: }
9637: return $thisfn;
9638: }
9639:
9640: sub clutter_with_no_wrapper {
9641: my $uri = &clutter(shift);
9642: if ($uri =~ m-^/adm/-) {
9643: $uri =~ s-^/adm/wrapper/-/-;
9644: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9645: }
9646: return $uri;
9647: }
9648:
9649: sub freeze_escape {
9650: my ($value)=@_;
9651: if (ref($value)) {
9652: $value=&nfreeze($value);
9653: return '__FROZEN__'.&escape($value);
9654: }
9655: return &escape($value);
9656: }
9657:
9658:
9659: sub thaw_unescape {
9660: my ($value)=@_;
9661: if ($value =~ /^__FROZEN__/) {
9662: substr($value,0,10,undef);
9663: $value=&unescape($value);
9664: return &thaw($value);
9665: }
9666: return &unescape($value);
9667: }
9668:
9669: sub correct_line_ends {
9670: my ($result)=@_;
9671: $$result =~s/\r\n/\n/mg;
9672: $$result =~s/\r/\n/mg;
9673: }
9674: # ================================================================ Main Program
9675:
9676: sub goodbye {
9677: &logthis("Starting Shut down");
9678: #not converted to using infrastruture and probably shouldn't be
9679: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
9680: #converted
9681: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
9682: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9683: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9684: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
9685: #1.1 only
9686: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9687: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9688: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9689: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9690: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
9691: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9692: &logthis(sprintf("%-20s is %s",'hits',$hits));
9693: &flushcourselogs();
9694: &logthis("Shutting down");
9695: }
9696:
9697: sub get_dns {
9698: my ($url,$func,$ignore_cache) = @_;
9699: if (!$ignore_cache) {
9700: my ($content,$cached)=
9701: &Apache::lonnet::is_cached_new('dns',$url);
9702: if ($cached) {
9703: &$func($content);
9704: return;
9705: }
9706: }
9707:
9708: my %alldns;
9709: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9710: foreach my $dns (<$config>) {
9711: next if ($dns !~ /^\^(\S*)/x);
9712: my $line = $1;
9713: my ($host,$protocol) = split(/:/,$line);
9714: if ($protocol ne 'https') {
9715: $protocol = 'http';
9716: }
9717: $alldns{$host} = $protocol;
9718: }
9719: while (%alldns) {
9720: my ($dns) = keys(%alldns);
9721: my $ua=new LWP::UserAgent;
9722: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
9723: my $response=$ua->request($request);
9724: delete($alldns{$dns});
9725: next if ($response->is_error());
9726: my @content = split("\n",$response->content);
9727: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
9728: &$func(\@content);
9729: return;
9730: }
9731: close($config);
9732: my $which = (split('/',$url))[3];
9733: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9734: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
9735: my @content = <$config>;
9736: &$func(\@content);
9737: return;
9738: }
9739: # ------------------------------------------------------------ Read domain file
9740: {
9741: my $loaded;
9742: my %domain;
9743:
9744: sub parse_domain_tab {
9745: my ($lines) = @_;
9746: foreach my $line (@$lines) {
9747: next if ($line =~ /^(\#|\s*$ )/x);
9748:
9749: chomp($line);
9750: my ($name,@elements) = split(/:/,$line,9);
9751: my %this_domain;
9752: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9753: 'lang_def', 'city', 'longi', 'lati',
9754: 'primary') {
9755: $this_domain{$field} = shift(@elements);
9756: }
9757: $domain{$name} = \%this_domain;
9758: }
9759: }
9760:
9761: sub reset_domain_info {
9762: undef($loaded);
9763: undef(%domain);
9764: }
9765:
9766: sub load_domain_tab {
9767: my ($ignore_cache) = @_;
9768: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
9769: my $fh;
9770: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9771: my @lines = <$fh>;
9772: &parse_domain_tab(\@lines);
9773: }
9774: close($fh);
9775: $loaded = 1;
9776: }
9777:
9778: sub domain {
9779: &load_domain_tab() if (!$loaded);
9780:
9781: my ($name,$what) = @_;
9782: return if ( !exists($domain{$name}) );
9783:
9784: if (!$what) {
9785: return $domain{$name}{'description'};
9786: }
9787: return $domain{$name}{$what};
9788: }
9789:
9790: sub domain_info {
9791: &load_domain_tab() if (!$loaded);
9792: return %domain;
9793: }
9794:
9795: }
9796:
9797:
9798: # ------------------------------------------------------------- Read hosts file
9799: {
9800: my %hostname;
9801: my %hostdom;
9802: my %libserv;
9803: my $loaded;
9804: my %name_to_host;
9805: my %internetdom;
9806:
9807: sub parse_hosts_tab {
9808: my ($file) = @_;
9809: foreach my $configline (@$file) {
9810: next if ($configline =~ /^(\#|\s*$ )/x);
9811: next if ($configline =~ /^\^/);
9812: chomp($configline);
9813: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
9814: $name=~s/\s//g;
9815: if ($id && $domain && $role && $name) {
9816: $hostname{$id}=$name;
9817: push(@{$name_to_host{$name}}, $id);
9818: $hostdom{$id}=$domain;
9819: if ($role eq 'library') { $libserv{$id}=$name; }
9820: if (defined($protocol)) {
9821: if ($protocol eq 'https') {
9822: $protocol{$id} = $protocol;
9823: } else {
9824: $protocol{$id} = 'http';
9825: }
9826: } else {
9827: $protocol{$id} = 'http';
9828: }
9829: if (defined($intdom)) {
9830: $internetdom{$id} = $intdom;
9831: }
9832: }
9833: }
9834: }
9835:
9836: sub reset_hosts_info {
9837: &purge_remembered();
9838: &reset_domain_info();
9839: &reset_hosts_ip_info();
9840: undef(%name_to_host);
9841: undef(%hostname);
9842: undef(%hostdom);
9843: undef(%libserv);
9844: undef($loaded);
9845: }
9846:
9847: sub load_hosts_tab {
9848: my ($ignore_cache) = @_;
9849: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
9850: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9851: my @config = <$config>;
9852: &parse_hosts_tab(\@config);
9853: close($config);
9854: $loaded=1;
9855: }
9856:
9857: sub hostname {
9858: &load_hosts_tab() if (!$loaded);
9859:
9860: my ($lonid) = @_;
9861: return $hostname{$lonid};
9862: }
9863:
9864: sub all_hostnames {
9865: &load_hosts_tab() if (!$loaded);
9866:
9867: return %hostname;
9868: }
9869:
9870: sub all_names {
9871: &load_hosts_tab() if (!$loaded);
9872:
9873: return %name_to_host;
9874: }
9875:
9876: sub all_host_domain {
9877: &load_hosts_tab() if (!$loaded);
9878: return %hostdom;
9879: }
9880:
9881: sub is_library {
9882: &load_hosts_tab() if (!$loaded);
9883:
9884: return exists($libserv{$_[0]});
9885: }
9886:
9887: sub all_library {
9888: &load_hosts_tab() if (!$loaded);
9889:
9890: return %libserv;
9891: }
9892:
9893: sub unique_library {
9894: #2x reverse removes all hostnames that appear more than once
9895: my %unique = reverse &all_library();
9896: return reverse %unique;
9897: }
9898:
9899: sub get_servers {
9900: &load_hosts_tab() if (!$loaded);
9901:
9902: my ($domain,$type) = @_;
9903: my %possible_hosts = ($type eq 'library') ? %libserv
9904: : %hostname;
9905: my %result;
9906: if (ref($domain) eq 'ARRAY') {
9907: while ( my ($host,$hostname) = each(%possible_hosts)) {
9908: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9909: $result{$host} = $hostname;
9910: }
9911: }
9912: } else {
9913: while ( my ($host,$hostname) = each(%possible_hosts)) {
9914: if ($hostdom{$host} eq $domain) {
9915: $result{$host} = $hostname;
9916: }
9917: }
9918: }
9919: return %result;
9920: }
9921:
9922: sub get_unique_servers {
9923: my %unique = reverse &get_servers(@_);
9924: return reverse %unique;
9925: }
9926:
9927: sub host_domain {
9928: &load_hosts_tab() if (!$loaded);
9929:
9930: my ($lonid) = @_;
9931: return $hostdom{$lonid};
9932: }
9933:
9934: sub all_domains {
9935: &load_hosts_tab() if (!$loaded);
9936:
9937: my %seen;
9938: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9939: return @uniq;
9940: }
9941:
9942: sub internet_dom {
9943: &load_hosts_tab() if (!$loaded);
9944:
9945: my ($lonid) = @_;
9946: return $internetdom{$lonid};
9947: }
9948: }
9949:
9950: {
9951: my %iphost;
9952: my %name_to_ip;
9953: my %lonid_to_ip;
9954:
9955: sub get_hosts_from_ip {
9956: my ($ip) = @_;
9957: my %iphosts = &get_iphost();
9958: if (ref($iphosts{$ip})) {
9959: return @{$iphosts{$ip}};
9960: }
9961: return;
9962: }
9963:
9964: sub reset_hosts_ip_info {
9965: undef(%iphost);
9966: undef(%name_to_ip);
9967: undef(%lonid_to_ip);
9968: }
9969:
9970: sub get_host_ip {
9971: my ($lonid) = @_;
9972: if (exists($lonid_to_ip{$lonid})) {
9973: return $lonid_to_ip{$lonid};
9974: }
9975: my $name=&hostname($lonid);
9976: my $ip = gethostbyname($name);
9977: return if (!$ip || length($ip) ne 4);
9978: $ip=inet_ntoa($ip);
9979: $name_to_ip{$name} = $ip;
9980: $lonid_to_ip{$lonid} = $ip;
9981: return $ip;
9982: }
9983:
9984: sub get_iphost {
9985: my ($ignore_cache) = @_;
9986:
9987: if (!$ignore_cache) {
9988: if (%iphost) {
9989: return %iphost;
9990: }
9991: my ($ip_info,$cached)=
9992: &Apache::lonnet::is_cached_new('iphost','iphost');
9993: if ($cached) {
9994: %iphost = %{$ip_info->[0]};
9995: %name_to_ip = %{$ip_info->[1]};
9996: %lonid_to_ip = %{$ip_info->[2]};
9997: return %iphost;
9998: }
9999: }
10000:
10001: # get yesterday's info for fallback
10002: my %old_name_to_ip;
10003: my ($ip_info,$cached)=
10004: &Apache::lonnet::is_cached_new('iphost','iphost');
10005: if ($cached) {
10006: %old_name_to_ip = %{$ip_info->[1]};
10007: }
10008:
10009: my %name_to_host = &all_names();
10010: foreach my $name (keys(%name_to_host)) {
10011: my $ip;
10012: if (!exists($name_to_ip{$name})) {
10013: $ip = gethostbyname($name);
10014: if (!$ip || length($ip) ne 4) {
10015: if (defined($old_name_to_ip{$name})) {
10016: $ip = $old_name_to_ip{$name};
10017: &logthis("Can't find $name defaulting to old $ip");
10018: } else {
10019: &logthis("Name $name no IP found");
10020: next;
10021: }
10022: } else {
10023: $ip=inet_ntoa($ip);
10024: }
10025: $name_to_ip{$name} = $ip;
10026: } else {
10027: $ip = $name_to_ip{$name};
10028: }
10029: foreach my $id (@{ $name_to_host{$name} }) {
10030: $lonid_to_ip{$id} = $ip;
10031: }
10032: push(@{$iphost{$ip}},@{$name_to_host{$name}});
10033: }
10034: &Apache::lonnet::do_cache_new('iphost','iphost',
10035: [\%iphost,\%name_to_ip,\%lonid_to_ip],
10036: 48*60*60);
10037:
10038: return %iphost;
10039: }
10040:
10041: #
10042: # Given a DNS returns the loncapa host name for that DNS
10043: #
10044: sub host_from_dns {
10045: my ($dns) = @_;
10046: my @hosts;
10047: my $ip;
10048:
10049: if (exists($name_to_ip{$dns})) {
10050: $ip = $name_to_ip{$dns};
10051: }
10052: if (!$ip) {
10053: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
10054: if (length($ip) == 4) {
10055: $ip = &IO::Socket::inet_ntoa($ip);
10056: }
10057: }
10058: if ($ip) {
10059: @hosts = get_hosts_from_ip($ip);
10060: return $hosts[0];
10061: }
10062: return undef;
10063: }
10064:
10065: sub get_internet_names {
10066: my ($lonid) = @_;
10067: return if ($lonid eq '');
10068: my ($idnref,$cached)=
10069: &Apache::lonnet::is_cached_new('internetnames',$lonid);
10070: if ($cached) {
10071: return $idnref;
10072: }
10073: my $ip = &get_host_ip($lonid);
10074: my @hosts = &get_hosts_from_ip($ip);
10075: my %iphost = &get_iphost();
10076: my (@idns,%seen);
10077: foreach my $id (@hosts) {
10078: my $dom = &host_domain($id);
10079: my $prim_id = &domain($dom,'primary');
10080: my $prim_ip = &get_host_ip($prim_id);
10081: next if ($seen{$prim_ip});
10082: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
10083: foreach my $id (@{$iphost{$prim_ip}}) {
10084: my $intdom = &internet_dom($id);
10085: unless (grep(/^\Q$intdom\E$/,@idns)) {
10086: push(@idns,$intdom);
10087: }
10088: }
10089: }
10090: $seen{$prim_ip} = 1;
10091: }
10092: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60);
10093: }
10094:
10095: }
10096:
10097: BEGIN {
10098:
10099: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
10100: unless ($readit) {
10101: {
10102: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
10103: %perlvar = (%perlvar,%{$configvars});
10104: }
10105:
10106:
10107: # ------------------------------------------------------ Read spare server file
10108: {
10109: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
10110:
10111: while (my $configline=<$config>) {
10112: chomp($configline);
10113: if ($configline) {
10114: my ($host,$type) = split(':',$configline,2);
10115: if (!defined($type) || $type eq '') { $type = 'default' };
10116: push(@{ $spareid{$type} }, $host);
10117: }
10118: }
10119: close($config);
10120: }
10121: # ------------------------------------------------------------ Read permissions
10122: {
10123: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
10124:
10125: while (my $configline=<$config>) {
10126: chomp($configline);
10127: if ($configline) {
10128: my ($role,$perm)=split(/ /,$configline);
10129: if ($perm ne '') { $pr{$role}=$perm; }
10130: }
10131: }
10132: close($config);
10133: }
10134:
10135: # -------------------------------------------- Read plain texts for permissions
10136: {
10137: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
10138:
10139: while (my $configline=<$config>) {
10140: chomp($configline);
10141: if ($configline) {
10142: my ($short,@plain)=split(/:/,$configline);
10143: %{$prp{$short}} = ();
10144: if (@plain > 0) {
10145: $prp{$short}{'std'} = $plain[0];
10146: for (my $i=1; $i<@plain; $i++) {
10147: $prp{$short}{'alt'.$i} = $plain[$i];
10148: }
10149: }
10150: }
10151: }
10152: close($config);
10153: }
10154:
10155: # ---------------------------------------------------------- Read package table
10156: {
10157: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
10158:
10159: while (my $configline=<$config>) {
10160: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
10161: chomp($configline);
10162: my ($short,$plain)=split(/:/,$configline);
10163: my ($pack,$name)=split(/\&/,$short);
10164: if ($plain ne '') {
10165: $packagetab{$pack.'&'.$name.'&name'}=$name;
10166: $packagetab{$short}=$plain;
10167: }
10168: }
10169: close($config);
10170: }
10171:
10172: # ---------------------------------------------------------- Read loncaparev table
10173: {
10174: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
10175: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
10176: while (my $configline=<$config>) {
10177: chomp($configline);
10178: my ($hostid,$loncaparev)=split(/:/,$configline);
10179: $loncaparevs{$hostid}=$loncaparev;
10180: }
10181: close($config);
10182: }
10183: }
10184: }
10185:
10186: # ---------------------------------------------------------- Read serverhostID table
10187: {
10188: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
10189: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
10190: while (my $configline=<$config>) {
10191: chomp($configline);
10192: my ($name,$id)=split(/:/,$configline);
10193: $serverhomeIDs{$name}=$id;
10194: }
10195: close($config);
10196: }
10197: }
10198: }
10199:
10200: sub all_loncaparevs {
10201: 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);
10202: }
10203:
10204: # ------------- set up temporary directory
10205: {
10206: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
10207:
10208: }
10209:
10210: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
10211: 'compress_threshold'=> 20_000,
10212: });
10213:
10214: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
10215: $dumpcount=0;
10216: $locknum=0;
10217:
10218: &logtouch();
10219: &logthis('<font color="yellow">INFO: Read configuration</font>');
10220: $readit=1;
10221: {
10222: use integer;
10223: my $test=(2**32)+1;
10224: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
10225: &logthis(" Detected 64bit platform ($_64bit)");
10226: }
10227: }
10228: }
10229:
10230: 1;
10231: __END__
10232:
10233: =pod
10234:
10235: =head1 NAME
10236:
10237: Apache::lonnet - Subroutines to ask questions about things in the network.
10238:
10239: =head1 SYNOPSIS
10240:
10241: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
10242:
10243: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
10244:
10245: Common parameters:
10246:
10247: =over 4
10248:
10249: =item *
10250:
10251: $uname : an internal username (if $cname expecting a course Id specifically)
10252:
10253: =item *
10254:
10255: $udom : a domain (if $cdom expecting a course's domain specifically)
10256:
10257: =item *
10258:
10259: $symb : a resource instance identifier
10260:
10261: =item *
10262:
10263: $namespace : the name of a .db file that contains the data needed or
10264: being set.
10265:
10266: =back
10267:
10268: =head1 OVERVIEW
10269:
10270: lonnet provides subroutines which interact with the
10271: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
10272: about classes, users, and resources.
10273:
10274: For many of these objects you can also use this to store data about
10275: them or modify them in various ways.
10276:
10277: =head2 Symbs
10278:
10279: To identify a specific instance of a resource, LON-CAPA uses symbols
10280: or "symbs"X<symb>. These identifiers are built from the URL of the
10281: map, the resource number of the resource in the map, and the URL of
10282: the resource itself. The latter is somewhat redundant, but might help
10283: if maps change.
10284:
10285: An example is
10286:
10287: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10288:
10289: The respective map entry is
10290:
10291: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10292: title="Problem 2">
10293: </resource>
10294:
10295: Symbs are used by the random number generator, as well as to store and
10296: restore data specific to a certain instance of for example a problem.
10297:
10298: =head2 Storing And Retrieving Data
10299:
10300: X<store()>X<cstore()>X<restore()>Three of the most important functions
10301: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10302: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10303: is is the non-critical message twin of cstore. These functions are for
10304: handlers to store a perl hash to a user's permanent data space in an
10305: easy manner, and to retrieve it again on another call. It is expected
10306: that a handler would use this once at the beginning to retrieve data,
10307: and then again once at the end to send only the new data back.
10308:
10309: The data is stored in the user's data directory on the user's
10310: homeserver under the ID of the course.
10311:
10312: The hash that is returned by restore will have all of the previous
10313: value for all of the elements of the hash.
10314:
10315: Example:
10316:
10317: #creating a hash
10318: my %hash;
10319: $hash{'foo'}='bar';
10320:
10321: #storing it
10322: &Apache::lonnet::cstore(\%hash);
10323:
10324: #changing a value
10325: $hash{'foo'}='notbar';
10326:
10327: #adding a new value
10328: $hash{'bar'}='foo';
10329: &Apache::lonnet::cstore(\%hash);
10330:
10331: #retrieving the hash
10332: my %history=&Apache::lonnet::restore();
10333:
10334: #print the hash
10335: foreach my $key (sort(keys(%history))) {
10336: print("\%history{$key} = $history{$key}");
10337: }
10338:
10339: Will print out:
10340:
10341: %history{1:foo} = bar
10342: %history{1:keys} = foo:timestamp
10343: %history{1:timestamp} = 990455579
10344: %history{2:bar} = foo
10345: %history{2:foo} = notbar
10346: %history{2:keys} = foo:bar:timestamp
10347: %history{2:timestamp} = 990455580
10348: %history{bar} = foo
10349: %history{foo} = notbar
10350: %history{timestamp} = 990455580
10351: %history{version} = 2
10352:
10353: Note that the special hash entries C<keys>, C<version> and
10354: C<timestamp> were added to the hash. C<version> will be equal to the
10355: total number of versions of the data that have been stored. The
10356: C<timestamp> attribute will be the UNIX time the hash was
10357: stored. C<keys> is available in every historical section to list which
10358: keys were added or changed at a specific historical revision of a
10359: hash.
10360:
10361: B<Warning>: do not store the hash that restore returns directly. This
10362: will cause a mess since it will restore the historical keys as if the
10363: were new keys. I.E. 1:foo will become 1:1:foo etc.
10364:
10365: Calling convention:
10366:
10367: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10368: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
10369:
10370: For more detailed information, see lonnet specific documentation.
10371:
10372: =head1 RETURN MESSAGES
10373:
10374: =over 4
10375:
10376: =item * B<con_lost>: unable to contact remote host
10377:
10378: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10379: when the connection is brought back up
10380:
10381: =item * B<con_failed>: unable to contact remote host and unable to save message
10382: for later delivery
10383:
10384: =item * B<error:>: an error a occurred, a description of the error follows the :
10385:
10386: =item * B<no_such_host>: unable to fund a host associated with the user/domain
10387: that was requested
10388:
10389: =back
10390:
10391: =head1 PUBLIC SUBROUTINES
10392:
10393: =head2 Session Environment Functions
10394:
10395: =over 4
10396:
10397: =item *
10398: X<appenv()>
10399: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
10400: the user envirnoment file, and will be restored for each access this
10401: user makes during this session, also modifies the %env for the current
10402: process. Optional rolesarrayref - if defined contains a reference to an array
10403: of roles which are exempt from the restriction on modifying user.role entries
10404: in the user's environment.db and in %env.
10405:
10406: =item *
10407: X<delenv()>
10408: B<delenv($delthis,$regexp)>: removes all items from the session
10409: environment file that begin with $delthis. If the
10410: optional second arg - $regexp - is true, $delthis is treated as a
10411: regular expression, otherwise \Q$delthis\E is used.
10412: The values are also deleted from the current processes %env.
10413:
10414: =item * get_env_multiple($name)
10415:
10416: gets $name from the %env hash, it seemlessly handles the cases where multiple
10417: values may be defined and end up as an array ref.
10418:
10419: returns an array of values
10420:
10421: =back
10422:
10423: =head2 User Information
10424:
10425: =over 4
10426:
10427: =item *
10428: X<queryauthenticate()>
10429: B<queryauthenticate($uname,$udom)>: try to determine user's current
10430: authentication scheme
10431:
10432: =item *
10433: X<authenticate()>
10434: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
10435: authenticate user from domain's lib servers (first use the current
10436: one). C<$upass> should be the users password.
10437: $checkdefauth is optional (value is 1 if a check should be made to
10438: authenticate user using default authentication method, and allow
10439: account creation if username does not have account in the domain).
10440: $clientcancheckhost is optional (value is 1 if checking whether the
10441: server can host will occur on the client side in lonauth.pm).
10442:
10443: =item *
10444: X<homeserver()>
10445: B<homeserver($uname,$udom)>: find the server which has
10446: the user's directory and files (there must be only one), this caches
10447: the answer, and also caches if there is a borken connection.
10448:
10449: =item *
10450: X<idget()>
10451: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10452: (IDs are a unique resource in a domain, there must be only 1 ID per
10453: username, and only 1 username per ID in a specific domain) (returns
10454: hash: id=>name,id=>name)
10455:
10456: =item *
10457: X<idrget()>
10458: B<idrget($udom,@unames)>: find the IDs behind a list of
10459: usernames (returns hash: name=>id,name=>id)
10460:
10461: =item *
10462: X<idput()>
10463: B<idput($udom,%ids)>: store away a list of names and associated IDs
10464:
10465: =item *
10466: X<rolesinit()>
10467: B<rolesinit($udom,$username,$authhost)>: get user privileges
10468:
10469: =item *
10470: X<getsection()>
10471: B<getsection($udom,$uname,$cname)>: finds the section of student in the
10472: course $cname, return section name/number or '' for "not in course"
10473: and '-1' for "no section"
10474:
10475: =item *
10476: X<userenvironment()>
10477: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
10478: passed in @what from the requested user's environment, returns a hash
10479:
10480: =item *
10481: X<userlog_query()>
10482: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10483: activity.log file. %filters defines filters applied when parsing the
10484: log file. These can be start or end timestamps, or the type of action
10485: - log to look for Login or Logout events, check for Checkin or
10486: Checkout, role for role selection. The response is in the form
10487: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10488: escaped strings of the action recorded in the activity.log file.
10489:
10490: =back
10491:
10492: =head2 User Roles
10493:
10494: =over 4
10495:
10496: =item *
10497:
10498: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
10499: F: full access
10500: U,I,K: authentication modes (cxx only)
10501: '': forbidden
10502: 1: user needs to choose course
10503: 2: browse allowed
10504: A: passphrase authentication needed
10505:
10506: =item *
10507:
10508: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10509: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10510: and course level
10511:
10512: =item *
10513:
10514: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10515: (rolesplain.tab); plain text explanation of a user role term.
10516: $type is Course (default) or Community.
10517: If $forcedefault evaluates to true, text returned will be default
10518: text for $type. Otherwise, if this is a course, the text returned
10519: will be a custom name for the role (if defined in the course's
10520: environment). If no custom name is defined the default is returned.
10521:
10522: =item *
10523:
10524: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
10525: All arguments are optional. Returns a hash of a roles, either for
10526: co-author/assistant author roles for a user's Construction Space
10527: (default), or if $context is 'userroles', roles for the user himself,
10528: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10529: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10530: For each key, value is set to colon-separated start and end times for
10531: the role. If no username and domain are specified, will default to
10532: current user/domain. Types, roles, and roledoms are references to arrays
10533: of role statuses (active, future or previous), roles
10534: (e.g., cc,in, st etc.) and domains of the roles which can be used
10535: to restrict the list of roles reported. If no array ref is
10536: provided for types, will default to return only active roles.
10537:
10538: =back
10539:
10540: =head2 User Modification
10541:
10542: =over 4
10543:
10544: =item *
10545:
10546: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
10547: user for the level given by URL. Optional start and end dates (leave empty
10548: string or zero for "no date")
10549:
10550: =item *
10551:
10552: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10553: change a users, password, possible return values are: ok,
10554: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10555: refused
10556:
10557: =item *
10558:
10559: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
10560:
10561: =item *
10562:
10563: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
10564: $forceid,$desiredhome,$email,$inststatus,$candelete) :
10565:
10566: will update user information (firstname,middlename,lastname,generation,
10567: permanentemail), and if forceid is true, student/employee ID also.
10568: A user's institutional affiliation(s) can also be updated.
10569: User information fields will not be overwritten with empty entries
10570: unless the field is included in the $candelete array reference.
10571: This array is included when a single user is modified via "Manage Users",
10572: or when Autoupdate.pl is run by cron in a domain.
10573:
10574: =item *
10575:
10576: modifystudent
10577:
10578: modify a student's enrollment and identification information.
10579: The course id is resolved based on the current users environment.
10580: This means the envoking user must be a course coordinator or otherwise
10581: associated with a course.
10582:
10583: This call is essentially a wrapper for lonnet::modifyuser and
10584: lonnet::modify_student_enrollment
10585:
10586: Inputs:
10587:
10588: =over 4
10589:
10590: =item B<$udom> Student's loncapa domain
10591:
10592: =item B<$uname> Student's loncapa login name
10593:
10594: =item B<$uid> Student/Employee ID
10595:
10596: =item B<$umode> Student's authentication mode
10597:
10598: =item B<$upass> Student's password
10599:
10600: =item B<$first> Student's first name
10601:
10602: =item B<$middle> Student's middle name
10603:
10604: =item B<$last> Student's last name
10605:
10606: =item B<$gene> Student's generation
10607:
10608: =item B<$usec> Student's section in course
10609:
10610: =item B<$end> Unix time of the roles expiration
10611:
10612: =item B<$start> Unix time of the roles start date
10613:
10614: =item B<$forceid> If defined, allow $uid to be changed
10615:
10616: =item B<$desiredhome> server to use as home server for student
10617:
10618: =item B<$email> Student's permanent e-mail address
10619:
10620: =item B<$type> Type of enrollment (auto or manual)
10621:
10622: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10623:
10624: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
10625:
10626: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
10627:
10628: =item B<$context> role change context (shown in User Management Logs display in a course)
10629:
10630: =item B<$inststatus> institutional status of user - : separated string of escaped status types
10631:
10632: =back
10633:
10634: =item *
10635:
10636: modify_student_enrollment
10637:
10638: Change a students enrollment status in a class. The environment variable
10639: 'role.request.course' must be defined for this function to proceed.
10640:
10641: Inputs:
10642:
10643: =over 4
10644:
10645: =item $udom, students domain
10646:
10647: =item $uname, students name
10648:
10649: =item $uid, students user id
10650:
10651: =item $first, students first name
10652:
10653: =item $middle
10654:
10655: =item $last
10656:
10657: =item $gene
10658:
10659: =item $usec
10660:
10661: =item $end
10662:
10663: =item $start
10664:
10665: =item $type
10666:
10667: =item $locktype
10668:
10669: =item $cid
10670:
10671: =item $selfenroll
10672:
10673: =item $context
10674:
10675: =back
10676:
10677:
10678: =item *
10679:
10680: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10681: custom role; give a custom role to a user for the level given by URL. Specify
10682: name and domain of role author, and role name
10683:
10684: =item *
10685:
10686: revokerole($udom,$uname,$url,$role) : revoke a role for url
10687:
10688: =item *
10689:
10690: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10691:
10692: =back
10693:
10694: =head2 Course Infomation
10695:
10696: =over 4
10697:
10698: =item *
10699:
10700: coursedescription($courseid) : returns a hash of information about the
10701: specified course id, including all environment settings for the
10702: course, the description of the course will be in the hash under the
10703: key 'description'
10704:
10705: =item *
10706:
10707: resdata($name,$domain,$type,@which) : request for current parameter
10708: setting for a specific $type, where $type is either 'course' or 'user',
10709: @what should be a list of parameters to ask about. This routine caches
10710: answers for 5 minutes.
10711:
10712: =item *
10713:
10714: get_courseresdata($courseid, $domain) : dump the entire course resource
10715: data base, returning a hash that is keyed by the resource name and has
10716: values that are the resource value. I believe that the timestamps and
10717: versions are also returned.
10718:
10719:
10720: =back
10721:
10722: =head2 Course Modification
10723:
10724: =over 4
10725:
10726: =item *
10727:
10728: writecoursepref($courseid,%prefs) : write preferences (environment
10729: database) for a course
10730:
10731: =item *
10732:
10733: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10734:
10735: =item *
10736:
10737: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
10738:
10739: =back
10740:
10741: =head2 Resource Subroutines
10742:
10743: =over 4
10744:
10745: =item *
10746:
10747: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
10748:
10749: =item *
10750:
10751: repcopy($filename) : subscribes to the requested file, and attempts to
10752: replicate from the owning library server, Might return
10753: 'unavailable', 'not_found', 'forbidden', 'ok', or
10754: 'bad_request', also attempts to grab the metadata for the
10755: resource. Expects the local filesystem pathname
10756: (/home/httpd/html/res/....)
10757:
10758: =back
10759:
10760: =head2 Resource Information
10761:
10762: =over 4
10763:
10764: =item *
10765:
10766: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10767: a vairety of different possible values, $varname should be a request
10768: string, and the other parameters can be used to specify who and what
10769: one is asking about.
10770:
10771: Possible values for $varname are environment.lastname (or other item
10772: from the envirnment hash), user.name (or someother aspect about the
10773: user), resource.0.maxtries (or some other part and parameter of a
10774: resource)
10775:
10776: =item *
10777:
10778: directcondval($number) : get current value of a condition; reads from a state
10779: string
10780:
10781: =item *
10782:
10783: condval($condidx) : value of condition index based on state
10784:
10785: =item *
10786:
10787: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10788: resource's metadata, $what should be either a specific key, or either
10789: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10790: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10791:
10792: this function automatically caches all requests
10793:
10794: =item *
10795:
10796: metadata_query($query,$custom,$customshow) : make a metadata query against the
10797: network of library servers; returns file handle of where SQL and regex results
10798: will be stored for query
10799:
10800: =item *
10801:
10802: symbread($filename) : return symbolic list entry (filename argument optional);
10803: returns the data handle
10804:
10805: =item *
10806:
10807: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
10808: a possible symb for the URL in $thisfn, and if is an encryypted
10809: resource that the user accessed using /enc/ returns a 1 on success, 0
10810: on failure, user must be in a course, as it assumes the existance of
10811: the course initial hash, and uses $env('request.course.id'}
10812:
10813:
10814: =item *
10815:
10816: symbclean($symb) : removes versions numbers from a symb, returns the
10817: cleaned symb
10818:
10819: =item *
10820:
10821: is_on_map($uri) : checks if the $uri is somewhere on the current
10822: course map, user must be in a course for it to work.
10823:
10824: =item *
10825:
10826: numval($salt) : return random seed value (addend for rndseed)
10827:
10828: =item *
10829:
10830: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10831: a random seed, all arguments are optional, if they aren't sent it uses the
10832: environment to derive them. Note: if symb isn't sent and it can't get one
10833: from &symbread it will use the current time as its return value
10834:
10835: =item *
10836:
10837: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10838: unfakeable, receipt
10839:
10840: =item *
10841:
10842: receipt() : API to ireceipt working off of env values; given out to users
10843:
10844: =item *
10845:
10846: countacc($url) : count the number of accesses to a given URL
10847:
10848: =item *
10849:
10850: 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
10851:
10852: =item *
10853:
10854: 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)
10855:
10856: =item *
10857:
10858: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
10859:
10860: =item *
10861:
10862: devalidate($symb) : devalidate temporary spreadsheet calculations,
10863: forcing spreadsheet to reevaluate the resource scores next time.
10864:
10865: =back
10866:
10867: =head2 Storing/Retreiving Data
10868:
10869: =over 4
10870:
10871: =item *
10872:
10873: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10874: for this url; hashref needs to be given and should be a \%hashname; the
10875: remaining args aren't required and if they aren't passed or are '' they will
10876: be derived from the env
10877:
10878: =item *
10879:
10880: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10881: uses critical subroutine
10882:
10883: =item *
10884:
10885: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10886: all args are optional
10887:
10888: =item *
10889:
10890: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10891: dumps the complete (or key matching regexp) namespace into a hash
10892: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10893: normally &store()ed into
10894:
10895: $range should be either an integer '100' (give me the first 100
10896: matching records)
10897: or be two integers sperated by a - with no spaces
10898: '30-50' (give me the 30th through the 50th matching
10899: records)
10900:
10901:
10902: =item *
10903:
10904: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10905: replaces a &store() version of data with a replacement set of data
10906: for a particular resource in a namespace passed in the $storehash hash
10907: reference
10908:
10909: =item *
10910:
10911: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10912: works very similar to store/cstore, but all data is stored in a
10913: temporary location and can be reset using tmpreset, $storehash should
10914: be a hash reference, returns nothing on success
10915:
10916: =item *
10917:
10918: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10919: similar to restore, but all data is stored in a temporary location and
10920: can be reset using tmpreset. Returns a hash of values on success,
10921: error string otherwise.
10922:
10923: =item *
10924:
10925: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10926: deltes all keys for $symb form the temporary storage hash.
10927:
10928: =item *
10929:
10930: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10931: reference filled in from namesp ($udom and $uname are optional)
10932:
10933: =item *
10934:
10935: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10936: namesp ($udom and $uname are optional)
10937:
10938: =item *
10939:
10940: dump($namespace,$udom,$uname,$regexp,$range) :
10941: dumps the complete (or key matching regexp) namespace into a hash
10942: ($udom, $uname, $regexp, $range are optional)
10943:
10944: $range should be either an integer '100' (give me the first 100
10945: matching records)
10946: or be two integers sperated by a - with no spaces
10947: '30-50' (give me the 30th through the 50th matching
10948: records)
10949: =item *
10950:
10951: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10952: $store can be a scalar, an array reference, or if the amount to be
10953: incremented is > 1, a hash reference.
10954:
10955: ($udom and $uname are optional)
10956:
10957: =item *
10958:
10959: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10960: ($udom and $uname are optional)
10961:
10962: =item *
10963:
10964: cput($namespace,$storehash,$udom,$uname) : critical put
10965: ($udom and $uname are optional)
10966:
10967: =item *
10968:
10969: newput($namespace,$storehash,$udom,$uname) :
10970:
10971: Attempts to store the items in the $storehash, but only if they don't
10972: currently exist, if this succeeds you can be certain that you have
10973: successfully created a new key value pair in the $namespace db.
10974:
10975:
10976: Args:
10977: $namespace: name of database to store values to
10978: $storehash: hashref to store to the db
10979: $udom: (optional) domain of user containing the db
10980: $uname: (optional) name of user caontaining the db
10981:
10982: Returns:
10983: 'ok' -> succeeded in storing all keys of $storehash
10984: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10985: least <key> already existed in the db (other
10986: requested keys may also already exist)
10987: 'error: <msg>' -> unable to tie the DB or other error occurred
10988: 'con_lost' -> unable to contact request server
10989: 'refused' -> action was not allowed by remote machine
10990:
10991:
10992: =item *
10993:
10994: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10995: reference filled in from namesp (encrypts the return communication)
10996: ($udom and $uname are optional)
10997:
10998: =item *
10999:
11000: log($udom,$name,$home,$message) : write to permanent log for user; use
11001: critical subroutine
11002:
11003: =item *
11004:
11005: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
11006: array reference filled in from namespace found in domain level on either
11007: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
11008:
11009: =item *
11010:
11011: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
11012: domain level either on specified domain server ($uhome) or primary domain
11013: server ($udom and $uhome are optional)
11014:
11015: =item *
11016:
11017: get_domain_defaults($target_domain) : returns hash with defaults for
11018: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
11019: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
11020: or localauth), initial password or a kerberos realm, language (e.g., en-us).
11021: Values are retrieved from cache (if current), or from domain's configuration.db
11022: (if available), or lastly from values in lonTabs/dns_domain,tab,
11023: or lonTabs/domain.tab.
11024:
11025: %domdefaults = &get_auth_defaults($target_domain);
11026:
11027: =back
11028:
11029: =head2 Network Status Functions
11030:
11031: =over 4
11032:
11033: =item *
11034:
11035: dirlist($uri) : return directory list based on URI
11036:
11037: =item *
11038:
11039: spareserver() : find server with least workload from spare.tab
11040:
11041:
11042: =item *
11043:
11044: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
11045: if there is no corresponding loncapa host.
11046:
11047: =back
11048:
11049:
11050: =head2 Apache Request
11051:
11052: =over 4
11053:
11054: =item *
11055:
11056: ssi($url,%hash) : server side include, does a complete request cycle on url to
11057: localhost, posts hash
11058:
11059: =back
11060:
11061: =head2 Data to String to Data
11062:
11063: =over 4
11064:
11065: =item *
11066:
11067: hash2str(%hash) : convert a hash into a string complete with escaping and '='
11068: and '&' separators, supports elements that are arrayrefs and hashrefs
11069:
11070: =item *
11071:
11072: hashref2str($hashref) : convert a hashref into a string complete with
11073: escaping and '=' and '&' separators, supports elements that are
11074: arrayrefs and hashrefs
11075:
11076: =item *
11077:
11078: arrayref2str($arrayref) : convert an arrayref into a string complete
11079: with escaping and '&' separators, supports elements that are arrayrefs
11080: and hashrefs
11081:
11082: =item *
11083:
11084: str2hash($string) : convert string to hash using unescaping and
11085: splitting on '=' and '&', supports elements that are arrayrefs and
11086: hashrefs
11087:
11088: =item *
11089:
11090: str2array($string) : convert string to hash using unescaping and
11091: splitting on '&', supports elements that are arrayrefs and hashrefs
11092:
11093: =back
11094:
11095: =head2 Logging Routines
11096:
11097: =over 4
11098:
11099: These routines allow one to make log messages in the lonnet.log and
11100: lonnet.perm logfiles.
11101:
11102: =item *
11103:
11104: logtouch() : make sure the logfile, lonnet.log, exists
11105:
11106: =item *
11107:
11108: logthis() : append message to the normal lonnet.log file, it gets
11109: preiodically rolled over and deleted.
11110:
11111: =item *
11112:
11113: logperm() : append a permanent message to lonnet.perm.log, this log
11114: file never gets deleted by any automated portion of the system, only
11115: messages of critical importance should go in here.
11116:
11117: =back
11118:
11119: =head2 General File Helper Routines
11120:
11121: =over 4
11122:
11123: =item *
11124:
11125: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
11126: (a) files in /uploaded
11127: (i) If a local copy of the file exists -
11128: compares modification date of local copy with last-modified date for
11129: definitive version stored on home server for course. If local copy is
11130: stale, requests a new version from the home server and stores it.
11131: If the original has been removed from the home server, then local copy
11132: is unlinked.
11133: (ii) If local copy does not exist -
11134: requests the file from the home server and stores it.
11135:
11136: If $caller is 'uploadrep':
11137: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
11138: for request for files originally uploaded via DOCS.
11139: - returns 'ok' if fresh local copy now available, -1 otherwise.
11140:
11141: Otherwise:
11142: This indicates a call from the content generation phase of the request.
11143: - returns the entire contents of the file or -1.
11144:
11145: (b) files in /res
11146: - returns the entire contents of a file or -1;
11147: it properly subscribes to and replicates the file if neccessary.
11148:
11149:
11150: =item *
11151:
11152: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
11153: reference
11154:
11155: returns either a stat() list of data about the file or an empty list
11156: if the file doesn't exist or couldn't find out about it (connection
11157: problems or user unknown)
11158:
11159: =item *
11160:
11161: filelocation($dir,$file) : returns file system location of a file
11162: based on URI; meant to be "fairly clean" absolute reference, $dir is a
11163: directory that relative $file lookups are to looked in ($dir of /a/dir
11164: and a file of ../bob will become /a/bob)
11165:
11166: =item *
11167:
11168: hreflocation($dir,$file) : returns file system location or a URL; same as
11169: filelocation except for hrefs
11170:
11171: =item *
11172:
11173: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
11174:
11175: =back
11176:
11177: =head2 Usererfile file routines (/uploaded*)
11178:
11179: =over 4
11180:
11181: =item *
11182:
11183: userfileupload(): main rotine for putting a file in a user or course's
11184: filespace, arguments are,
11185:
11186: formname - required - this is the name of the element in $env where the
11187: filename, and the contents of the file to create/modifed exist
11188: the filename is in $env{'form.'.$formname.'.filename'} and the
11189: contents of the file is located in $env{'form.'.$formname}
11190: coursedoc - if true, store the file in the course of the active role
11191: of the current user
11192: subdir - required - subdirectory to put the file in under ../userfiles/
11193: if undefined, it will be placed in "unknown"
11194:
11195: (This routine calls clean_filename() to remove any dangerous
11196: characters from the filename, and then calls finuserfileupload() to
11197: complete the transaction)
11198:
11199: returns either the url of the uploaded file (/uploaded/....) if successful
11200: and /adm/notfound.html if unsuccessful
11201:
11202: =item *
11203:
11204: clean_filename(): routine for cleaing a filename up for storage in
11205: userfile space, argument is:
11206:
11207: filename - proposed filename
11208:
11209: returns: the new clean filename
11210:
11211: =item *
11212:
11213: finishuserfileupload(): routine that creaes and sends the file to
11214: userspace, probably shouldn't be called directly
11215:
11216: docuname: username or courseid of destination for the file
11217: docudom: domain of user/course of destination for the file
11218: formname: same as for userfileupload()
11219: fname: filename (inculding subdirectories) for the file
11220:
11221: returns either the url of the uploaded file (/uploaded/....) if successful
11222: and /adm/notfound.html if unsuccessful
11223:
11224: =item *
11225:
11226: renameuserfile(): renames an existing userfile to a new name
11227:
11228: Args:
11229: docuname: username or courseid of destination for the file
11230: docudom: domain of user/course of destination for the file
11231: old: current file name (including any subdirs under userfiles)
11232: new: desired file name (including any subdirs under userfiles)
11233:
11234: =item *
11235:
11236: mkdiruserfile(): creates a directory is a userfiles dir
11237:
11238: Args:
11239: docuname: username or courseid of destination for the file
11240: docudom: domain of user/course of destination for the file
11241: dir: dir to create (including any subdirs under userfiles)
11242:
11243: =item *
11244:
11245: removeuserfile(): removes a file that exists in userfiles
11246:
11247: Args:
11248: docuname: username or courseid of destination for the file
11249: docudom: domain of user/course of destination for the file
11250: fname: filname to delete (including any subdirs under userfiles)
11251:
11252: =item *
11253:
11254: removeuploadedurl(): convience function for removeuserfile()
11255:
11256: Args:
11257: url: a full /uploaded/... url to delete
11258:
11259: =item *
11260:
11261: get_portfile_permissions():
11262: Args:
11263: domain: domain of user or course contain the portfolio files
11264: user: name of user or num of course contain the portfolio files
11265: Returns:
11266: hashref of a dump of the proper file_permissions.db
11267:
11268:
11269: =item *
11270:
11271: get_access_controls():
11272:
11273: Args:
11274: current_permissions: the hash ref returned from get_portfile_permissions()
11275: group: (optional) the group you want the files associated with
11276: file: (optional) the file you want access info on
11277:
11278: Returns:
11279: a hash (keys are file names) of hashes containing
11280: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
11281: values are XML containing access control settings (see below)
11282:
11283: Internal notes:
11284:
11285: access controls are stored in file_permissions.db as key=value pairs.
11286: key -> path to file/file_name\0uniqueID:scope_end_start
11287: where scope -> public,guest,course,group,domains or users.
11288: end -> UNIX time for end of access (0 -> no end date)
11289: start -> UNIX time for start of access
11290:
11291: value -> XML description of access control
11292: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11293: <start></start>
11294: <end></end>
11295:
11296: <password></password> for scope type = guest
11297:
11298: <domain></domain> for scope type = course or group
11299: <number></number>
11300: <roles id="">
11301: <role></role>
11302: <access></access>
11303: <section></section>
11304: <group></group>
11305: </roles>
11306:
11307: <dom></dom> for scope type = domains
11308:
11309: <users> for scope type = users
11310: <user>
11311: <uname></uname>
11312: <udom></udom>
11313: </user>
11314: </users>
11315: </scope>
11316:
11317: Access data is also aggregated for each file in an additional key=value pair:
11318: key -> path to file/file_name\0accesscontrol
11319: value -> reference to hash
11320: hash contains key = value pairs
11321: where key = uniqueID:scope_end_start
11322: value = UNIX time record was last updated
11323:
11324: Used to improve speed of look-ups of access controls for each file.
11325:
11326: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11327:
11328: modify_access_controls():
11329:
11330: Modifies access controls for a portfolio file
11331: Args
11332: 1. file name
11333: 2. reference to hash of required changes,
11334: 3. domain
11335: 4. username
11336: where domain,username are the domain of the portfolio owner
11337: (either a user or a course)
11338:
11339: Returns:
11340: 1. result of additions or updates ('ok' or 'error', with error message).
11341: 2. result of deletions ('ok' or 'error', with error message).
11342: 3. reference to hash of any new or updated access controls.
11343: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11344: key = integer (inbound ID)
11345: value = uniqueID
11346:
11347: =back
11348:
11349: =head2 HTTP Helper Routines
11350:
11351: =over 4
11352:
11353: =item *
11354:
11355: escape() : unpack non-word characters into CGI-compatible hex codes
11356:
11357: =item *
11358:
11359: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11360:
11361: =back
11362:
11363: =head1 PRIVATE SUBROUTINES
11364:
11365: =head2 Underlying communication routines (Shouldn't call)
11366:
11367: =over 4
11368:
11369: =item *
11370:
11371: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11372:
11373: =item *
11374:
11375: reply() : uses subreply to send a message to remote machine, logs all failures
11376:
11377: =item *
11378:
11379: critical() : passes a critical message to another server; if cannot
11380: get through then place message in connection buffer directory and
11381: returns con_delayed, if incapable of saving message, returns
11382: con_failed
11383:
11384: =item *
11385:
11386: reconlonc() : tries to reconnect lonc client processes.
11387:
11388: =back
11389:
11390: =head2 Resource Access Logging
11391:
11392: =over 4
11393:
11394: =item *
11395:
11396: flushcourselogs() : flush (save) buffer logs and access logs
11397:
11398: =item *
11399:
11400: courselog($what) : save message for course in hash
11401:
11402: =item *
11403:
11404: courseacclog($what) : save message for course using &courselog(). Perform
11405: special processing for specific resource types (problems, exams, quizzes, etc).
11406:
11407: =item *
11408:
11409: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11410: as a PerlChildExitHandler
11411:
11412: =back
11413:
11414: =head2 Other
11415:
11416: =over 4
11417:
11418: =item *
11419:
11420: symblist($mapname,%newhash) : update symbolic storage links
11421:
11422: =back
11423:
11424: =cut
11425:
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