Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1004
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1004 ! droeschl 4: # $Id: lonnet.pm,v 1.1003 2009/06/11 19:19:57 raeburn Exp $
1.178 www 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: #
1.169 harris41 28: ###
29:
1.971 jms 30: =pod
31:
1.972 jms 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:
1.971 jms 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:
1.1 albertel 71: package Apache::lonnet;
72:
73: use strict;
1.8 www 74: use LWP::UserAgent();
1.486 www 75: use HTTP::Date;
1.977 amueller 76: use Image::Magick;
77:
1.871 albertel 78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.968 raeburn 79: $_64bit %env %protocol);
1.871 albertel 80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 84: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 85:
1.1 albertel 86: use IO::Socket;
1.31 www 87: use GDBM_File;
1.208 albertel 88: use HTML::LCParser;
1.88 www 89: use Fcntl qw(:flock);
1.870 albertel 90: use Storable qw(thaw nfreeze);
1.539 albertel 91: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 92: use Cache::Memcached;
1.676 albertel 93: use Digest::MD5;
1.790 albertel 94: use Math::Random;
1.807 albertel 95: use LONCAPA qw(:DEFAULT :match);
1.740 www 96: use LONCAPA::Configuration;
1.676 albertel 97:
1.195 www 98: my $readit;
1.550 foxr 99: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 100:
1.977 amueller 101: my $upload_photo_form = 0; #Variable to check when user upload a photo 0=not 1=true
102:
1.619 albertel 103: require Exporter;
104:
105: our @ISA = qw (Exporter);
106: our @EXPORT = qw(%env);
107:
1.449 matthew 108:
1.1 albertel 109: # --------------------------------------------------------------------- Logging
1.729 www 110: {
111: my $logid;
112: sub instructor_log {
1.957 raeburn 113: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
114: if (($cnum eq '') || ($cdom eq '')) {
115: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
116: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
117: }
1.729 www 118: $logid++;
1.957 raeburn 119: my $now = time();
120: my $id=$now.'00000'.$$.'00000'.$logid;
1.729 www 121: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 122: { $id => {
123: 'exe_uname' => $env{'user.name'},
124: 'exe_udom' => $env{'user.domain'},
1.957 raeburn 125: 'exe_time' => $now,
1.730 www 126: 'exe_ip' => $ENV{'REMOTE_ADDR'},
127: 'delflag' => $delflag,
128: 'logentry' => $storehash,
129: 'uname' => $uname,
130: 'udom' => $udom,
131: }
1.957 raeburn 132: },$cdom,$cnum);
1.729 www 133: }
134: }
1.1 albertel 135:
1.163 harris41 136: sub logtouch {
137: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 138: unless (-e "$execdir/logs/lonnet.log") {
139: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 140: close $fh;
141: }
142: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
143: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
144: }
145:
1.1 albertel 146: sub logthis {
147: my $message=shift;
148: my $execdir=$perlvar{'lonDaemons'};
149: my $now=time;
150: my $local=localtime($now);
1.448 albertel 151: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986 foxr 152: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
153: print $fh $logstring;
1.448 albertel 154: close($fh);
155: }
1.1 albertel 156: return 1;
157: }
158:
159: sub logperm {
160: my $message=shift;
161: my $execdir=$perlvar{'lonDaemons'};
162: my $now=time;
163: my $local=localtime($now);
1.448 albertel 164: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
165: print $fh "$now:$message:$local\n";
166: close($fh);
167: }
1.1 albertel 168: return 1;
169: }
170:
1.850 albertel 171: sub create_connection {
1.853 albertel 172: my ($hostname,$lonid) = @_;
1.851 albertel 173: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 174: Type => SOCK_STREAM,
175: Timeout => 10);
176: return 0 if (!$client);
1.890 albertel 177: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 178: my $result = <$client>;
179: chomp($result);
180: return 1 if ($result eq 'done');
181: return 0;
182: }
183:
1.983 raeburn 184: sub get_server_timezone {
185: my ($cnum,$cdom) = @_;
186: my $home=&homeserver($cnum,$cdom);
187: if ($home ne 'no_host') {
188: my $cachetime = 24*3600;
189: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
190: if (defined($cached)) {
191: return $timezone;
192: } else {
193: my $timezone = &reply('servertimezone',$home);
194: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
195: }
196: }
197: }
1.850 albertel 198:
1.993 raeburn 199: sub get_server_loncaparev {
200: my ($dom,$lonhost) = @_;
201: if (defined($lonhost)) {
202: if (!defined(&hostname($lonhost))) {
203: undef($lonhost);
204: }
205: }
206: if (!defined($lonhost)) {
207: if (defined(&domain($dom,'primary'))) {
208: $lonhost=&domain($dom,'primary');
209: if ($lonhost eq 'no_host') {
210: undef($lonhost);
211: }
212: }
213: }
214: if (defined($lonhost)) {
215: my $cachetime = 24*3600;
216: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
217: if (defined($cached)) {
218: return $loncaparev;
219: } else {
220: my $loncaparev = &reply('serverloncaparev',$lonhost);
221: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
222: }
223: }
224: }
225:
1.1 albertel 226: # -------------------------------------------------- Non-critical communication
227: sub subreply {
228: my ($cmd,$server)=@_;
1.838 albertel 229: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 230: #
231: # With loncnew process trimming, there's a timing hole between lonc server
232: # process exit and the master server picking up the listen on the AF_UNIX
233: # socket. In that time interval, a lock file will exist:
234:
235: my $lockfile=$peerfile.".lock";
236: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
237: sleep(1);
238: }
239: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 240: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 241: #
1.550 foxr 242: # We'll give the connection a few tries before abandoning it. If
243: # connection is not possible, we'll con_lost back to the client.
244: #
245: my $client;
246: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
247: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
248: Type => SOCK_STREAM,
249: Timeout => 10);
1.869 albertel 250: if ($client) {
1.550 foxr 251: last; # Connected!
1.850 albertel 252: } else {
1.853 albertel 253: &create_connection(&hostname($server),$server);
1.550 foxr 254: }
1.850 albertel 255: sleep(1); # Try again later if failed connection.
1.550 foxr 256: }
257: my $answer;
258: if ($client) {
1.704 albertel 259: print $client "sethost:$server:$cmd\n";
1.550 foxr 260: $answer=<$client>;
261: if (!$answer) { $answer="con_lost"; }
262: chomp($answer);
263: } else {
264: $answer = 'con_lost'; # Failed connection.
265: }
1.1 albertel 266: return $answer;
267: }
268:
269: sub reply {
270: my ($cmd,$server)=@_;
1.838 albertel 271: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 272: my $answer=subreply($cmd,$server);
1.65 www 273: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 274: &logthis("<font color=\"blue\">WARNING:".
1.12 www 275: " $cmd to $server returned $answer</font>");
276: }
1.1 albertel 277: return $answer;
278: }
279:
280: # ----------------------------------------------------------- Send USR1 to lonc
281:
282: sub reconlonc {
1.891 albertel 283: my ($lonid) = @_;
284: my $hostname = &hostname($lonid);
285: if ($lonid) {
286: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
287: if ($hostname && -e $peerfile) {
288: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
289: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
290: Type => SOCK_STREAM,
291: Timeout => 10);
292: if ($client) {
293: print $client ("reset_retries\n");
294: my $answer=<$client>;
295: #reset just this one.
296: }
297: }
298: return;
299: }
300:
1.836 www 301: &logthis("Trying to reconnect lonc");
1.1 albertel 302: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 303: if (open(my $fh,"<$loncfile")) {
1.1 albertel 304: my $loncpid=<$fh>;
305: chomp($loncpid);
306: if (kill 0 => $loncpid) {
307: &logthis("lonc at pid $loncpid responding, sending USR1");
308: kill USR1 => $loncpid;
309: sleep 1;
1.836 www 310: } else {
1.12 www 311: &logthis(
1.672 albertel 312: "<font color=\"blue\">WARNING:".
1.12 www 313: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 314: }
315: } else {
1.836 www 316: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 317: }
318: }
319:
320: # ------------------------------------------------------ Critical communication
1.12 www 321:
1.1 albertel 322: sub critical {
323: my ($cmd,$server)=@_;
1.838 albertel 324: unless (&hostname($server)) {
1.672 albertel 325: &logthis("<font color=\"blue\">WARNING:".
1.89 www 326: " Critical message to unknown server ($server)</font>");
327: return 'no_such_host';
328: }
1.1 albertel 329: my $answer=reply($cmd,$server);
330: if ($answer eq 'con_lost') {
331: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 332: my $answer=reply($cmd,$server);
1.1 albertel 333: if ($answer eq 'con_lost') {
334: my $now=time;
335: my $middlename=$cmd;
1.5 www 336: $middlename=substr($middlename,0,16);
1.1 albertel 337: $middlename=~s/\W//g;
338: my $dfilename=
1.305 www 339: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
340: $dumpcount++;
1.1 albertel 341: {
1.448 albertel 342: my $dfh;
343: if (open($dfh,">$dfilename")) {
344: print $dfh "$cmd\n";
345: close($dfh);
346: }
1.1 albertel 347: }
348: sleep 2;
349: my $wcmd='';
350: {
1.448 albertel 351: my $dfh;
352: if (open($dfh,"<$dfilename")) {
353: $wcmd=<$dfh>;
354: close($dfh);
355: }
1.1 albertel 356: }
357: chomp($wcmd);
1.7 www 358: if ($wcmd eq $cmd) {
1.672 albertel 359: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 360: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 361: &logperm("D:$server:$cmd");
362: return 'con_delayed';
363: } else {
1.672 albertel 364: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 365: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 366: &logperm("F:$server:$cmd");
367: return 'con_failed';
368: }
369: }
370: }
371: return $answer;
1.405 albertel 372: }
373:
1.755 albertel 374: # ------------------------------------------- check if return value is an error
375:
376: sub error {
377: my ($result) = @_;
1.756 albertel 378: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 379: if ($2 == 2) { return undef; }
380: return $1;
381: }
382: return undef;
383: }
384:
1.783 albertel 385: sub convert_and_load_session_env {
386: my ($lonidsdir,$handle)=@_;
387: my @profile;
388: {
1.917 albertel 389: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
390: if (!$opened) {
1.915 albertel 391: return 0;
392: }
1.783 albertel 393: flock($idf,LOCK_SH);
394: @profile=<$idf>;
395: close($idf);
396: }
397: my %temp_env;
398: foreach my $line (@profile) {
1.786 albertel 399: if ($line !~ m/=/) {
400: return 0;
401: }
1.783 albertel 402: chomp($line);
403: my ($envname,$envvalue)=split(/=/,$line,2);
404: $temp_env{&unescape($envname)} = &unescape($envvalue);
405: }
406: unlink("$lonidsdir/$handle.id");
407: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
408: 0640)) {
409: %disk_env = %temp_env;
410: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
411: untie(%disk_env);
412: }
1.786 albertel 413: return 1;
1.783 albertel 414: }
415:
1.374 www 416: # ------------------------------------------- Transfer profile into environment
1.780 albertel 417: my $env_loaded;
418: sub transfer_profile_to_env {
1.788 albertel 419: my ($lonidsdir,$handle,$force_transfer) = @_;
420: if (!$force_transfer && $env_loaded) { return; }
1.374 www 421:
1.720 albertel 422: if (!defined($lonidsdir)) {
423: $lonidsdir = $perlvar{'lonIDsDir'};
424: }
425: if (!defined($handle)) {
426: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
427: }
428:
1.786 albertel 429: my $convert;
430: {
1.917 albertel 431: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
432: if (!$opened) {
1.915 albertel 433: return;
434: }
1.786 albertel 435: flock($idf,LOCK_SH);
436: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
437: &GDBM_READER(),0640)) {
438: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
439: untie(%disk_env);
440: } else {
441: $convert = 1;
442: }
443: }
444: if ($convert) {
445: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
446: &logthis("Failed to load session, or convert session.");
447: }
1.374 www 448: }
1.783 albertel 449:
1.786 albertel 450: my %remove;
1.783 albertel 451: while ( my $envname = each(%env) ) {
1.433 matthew 452: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
453: if ($time < time-300) {
1.783 albertel 454: $remove{$key}++;
1.433 matthew 455: }
456: }
457: }
1.783 albertel 458:
1.619 albertel 459: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 460: $env_loaded=1;
1.783 albertel 461: foreach my $expired_key (keys(%remove)) {
1.433 matthew 462: &delenv($expired_key);
1.374 www 463: }
1.1 albertel 464: }
465:
1.916 albertel 466: # ---------------------------------------------------- Check for valid session
467: sub check_for_valid_session {
468: my ($r) = @_;
469: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
470: my $lonid=$cookies{'lonID'};
471: return undef if (!$lonid);
472:
473: my $handle=&LONCAPA::clean_handle($lonid->value);
474: my $lonidsdir=$r->dir_config('lonIDsDir');
475: return undef if (!-e "$lonidsdir/$handle.id");
476:
1.917 albertel 477: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
478: return undef if (!$opened);
1.916 albertel 479:
480: flock($idf,LOCK_SH);
481: my %disk_env;
482: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
483: &GDBM_READER(),0640)) {
484: return undef;
485: }
486:
487: if (!defined($disk_env{'user.name'})
488: || !defined($disk_env{'user.domain'})) {
489: return undef;
490: }
491: return $handle;
492: }
493:
1.830 albertel 494: sub timed_flock {
495: my ($file,$lock_type) = @_;
496: my $failed=0;
497: eval {
498: local $SIG{__DIE__}='DEFAULT';
499: local $SIG{ALRM}=sub {
500: $failed=1;
501: die("failed lock");
502: };
503: alarm(13);
504: flock($file,$lock_type);
505: alarm(0);
506: };
507: if ($failed) {
508: return undef;
509: } else {
510: return 1;
511: }
512: }
513:
1.5 www 514: # ---------------------------------------------------------- Append Environment
515:
516: sub appenv {
1.949 raeburn 517: my ($newenv,$roles) = @_;
518: if (ref($newenv) eq 'HASH') {
519: foreach my $key (keys(%{$newenv})) {
520: my $refused = 0;
521: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
522: $refused = 1;
523: if (ref($roles) eq 'ARRAY') {
524: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
525: if (grep(/^\Q$role\E$/,@{$roles})) {
526: $refused = 0;
527: }
528: }
529: }
530: if ($refused) {
531: &logthis("<font color=\"blue\">WARNING: ".
532: "Attempt to modify environment ".$key." to ".$newenv->{$key}
533: .'</font>');
534: delete($newenv->{$key});
535: } else {
536: $env{$key}=$newenv->{$key};
537: }
538: }
539: my $opened = open(my $env_file,'+<',$env{'user.environment'});
540: if ($opened
541: && &timed_flock($env_file,LOCK_EX)
542: &&
543: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
544: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
545: while (my ($key,$value) = each(%{$newenv})) {
546: $disk_env{$key} = $value;
547: }
548: untie(%disk_env);
1.35 www 549: }
1.191 harris41 550: }
1.56 www 551: return 'ok';
552: }
553: # ----------------------------------------------------- Delete from Environment
554:
555: sub delenv {
1.987 raeburn 556: my ($delthis,$regexp) = @_;
1.56 www 557: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 558: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 559: "Attempt to delete from environment ".$delthis);
560: return 'error';
561: }
1.917 albertel 562: my $opened = open(my $env_file,'+<',$env{'user.environment'});
563: if ($opened
1.915 albertel 564: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 565: &&
566: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
567: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 568: foreach my $key (keys(%disk_env)) {
1.987 raeburn 569: if ($regexp) {
570: if ($key=~/^$delthis/) {
571: delete($env{$key});
572: delete($disk_env{$key});
573: }
574: } else {
575: if ($key=~/^\Q$delthis\E/) {
576: delete($env{$key});
577: delete($disk_env{$key});
578: }
579: }
1.448 albertel 580: }
1.783 albertel 581: untie(%disk_env);
1.5 www 582: }
583: return 'ok';
1.369 albertel 584: }
585:
1.790 albertel 586: sub get_env_multiple {
587: my ($name) = @_;
588: my @values;
589: if (defined($env{$name})) {
590: # exists is it an array
591: if (ref($env{$name})) {
592: @values=@{ $env{$name} };
593: } else {
594: $values[0]=$env{$name};
595: }
596: }
597: return(@values);
598: }
599:
1.958 www 600: # ------------------------------------------------------------------- Locking
601:
602: sub set_lock {
603: my ($text)=@_;
604: $locknum++;
605: my $id=$$.'-'.$locknum;
606: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
607: 'session.lock.'.$id => $text});
608: return $id;
609: }
610:
611: sub get_locks {
612: my $num=0;
613: my %texts=();
614: foreach my $lock (split(/\,/,$env{'session.locks'})) {
615: if ($lock=~/\w/) {
616: $num++;
617: $texts{$lock}=$env{'session.lock.'.$lock};
618: }
619: }
620: return ($num,%texts);
621: }
622:
623: sub remove_lock {
624: my ($id)=@_;
625: my $newlocks='';
626: foreach my $lock (split(/\,/,$env{'session.locks'})) {
627: if (($lock=~/\w/) && ($lock ne $id)) {
628: $newlocks.=','.$lock;
629: }
630: }
631: &appenv({'session.locks' => $newlocks});
632: &delenv('session.lock.'.$id);
633: }
634:
635: sub remove_all_locks {
636: my $activelocks=$env{'session.locks'};
637: foreach my $lock (split(/\,/,$env{'session.locks'})) {
638: if ($lock=~/\w/) {
639: &remove_lock($lock);
640: }
641: }
642: }
643:
644:
1.369 albertel 645: # ------------------------------------------ Find out current server userload
646: sub userload {
647: my $numusers=0;
648: {
649: opendir(LONIDS,$perlvar{'lonIDsDir'});
650: my $filename;
651: my $curtime=time;
652: while ($filename=readdir(LONIDS)) {
1.925 albertel 653: next if ($filename eq '.' || $filename eq '..');
654: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 655: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 656: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 657: }
658: closedir(LONIDS);
659: }
660: my $userloadpercent=0;
661: my $maxuserload=$perlvar{'lonUserLoadLim'};
662: if ($maxuserload) {
1.371 albertel 663: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 664: }
1.372 albertel 665: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 666: return $userloadpercent;
1.283 www 667: }
668:
669: # ------------------------------------------ Fight off request when overloaded
670:
671: sub overloaderror {
672: my ($r,$checkserver)=@_;
673: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
674: my $loadavg;
675: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 676: open(my $loadfile,'/proc/loadavg');
1.283 www 677: $loadavg=<$loadfile>;
678: $loadavg =~ s/\s.*//g;
1.285 matthew 679: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 680: close($loadfile);
1.283 www 681: } else {
682: $loadavg=&reply('load',$checkserver);
683: }
1.285 matthew 684: my $overload=$loadavg-100;
1.283 www 685: if ($overload>0) {
1.285 matthew 686: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 687: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 688: return 413;
1.283 www 689: }
690: return '';
1.5 www 691: }
1.1 albertel 692:
693: # ------------------------------ Find server with least workload from spare.tab
1.11 www 694:
1.1 albertel 695: sub spareserver {
1.670 albertel 696: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.784 albertel 697: my $spare_server;
1.370 albertel 698: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 699: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
700: : $userloadpercent;
701:
702: foreach my $try_server (@{ $spareid{'primary'} }) {
703: ($spare_server, $lowest_load) =
704: &compare_server_load($try_server, $spare_server, $lowest_load);
705: }
706:
707: my $found_server = ($spare_server ne '' && $lowest_load < 100);
708:
709: if (!$found_server) {
710: foreach my $try_server (@{ $spareid{'default'} }) {
711: ($spare_server, $lowest_load) =
712: &compare_server_load($try_server, $spare_server, $lowest_load);
713: }
714: }
715:
716: if (!$want_server_name) {
1.968 raeburn 717: my $protocol = 'http';
718: if ($protocol{$spare_server} eq 'https') {
719: $protocol = $protocol{$spare_server};
720: }
1.1001 raeburn 721: if (defined($spare_server)) {
722: my $hostname = &hostname($spare_server);
723: if (defined($hostname)) {
724: $spare_server = $protocol.'://'.$hostname;
725: }
726: }
1.784 albertel 727: }
728: return $spare_server;
729: }
730:
731: sub compare_server_load {
732: my ($try_server, $spare_server, $lowest_load) = @_;
733:
734: my $loadans = &reply('load', $try_server);
735: my $userloadans = &reply('userload',$try_server);
736:
737: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
738: next; #didn't get a number from the server
739: }
740:
741: my $load;
742: if ($loadans =~ /\d/) {
743: if ($userloadans =~ /\d/) {
744: #both are numbers, pick the bigger one
745: $load = ($loadans > $userloadans) ? $loadans
746: : $userloadans;
1.411 albertel 747: } else {
1.784 albertel 748: $load = $loadans;
1.411 albertel 749: }
1.784 albertel 750: } else {
751: $load = $userloadans;
752: }
753:
754: if (($load =~ /\d/) && ($load < $lowest_load)) {
755: $spare_server = $try_server;
756: $lowest_load = $load;
1.370 albertel 757: }
1.784 albertel 758: return ($spare_server,$lowest_load);
1.202 matthew 759: }
1.914 albertel 760:
761: # --------------------------- ask offload servers if user already has a session
762: sub find_existing_session {
763: my ($udom,$uname) = @_;
764: foreach my $try_server (@{ $spareid{'primary'} },
765: @{ $spareid{'default'} }) {
766: return $try_server if (&has_user_session($try_server, $udom, $uname));
767: }
768: return;
769: }
770:
771: # -------------------------------- ask if server already has a session for user
772: sub has_user_session {
773: my ($lonid,$udom,$uname) = @_;
774: my $result = &reply(join(':','userhassession',
775: map {&escape($_)} ($udom,$uname)),$lonid);
776: return 1 if ($result eq 'ok');
777:
778: return 0;
779: }
780:
1.202 matthew 781: # --------------------------------------------- Try to change a user's password
782:
783: sub changepass {
1.799 raeburn 784: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 785: $currentpass = &escape($currentpass);
786: $newpass = &escape($newpass);
1.799 raeburn 787: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
1.202 matthew 788: $server);
789: if (! $answer) {
790: &logthis("No reply on password change request to $server ".
791: "by $uname in domain $udom.");
792: } elsif ($answer =~ "^ok") {
793: &logthis("$uname in $udom successfully changed their password ".
794: "on $server.");
795: } elsif ($answer =~ "^pwchange_failure") {
796: &logthis("$uname in $udom was unable to change their password ".
797: "on $server. The action was blocked by either lcpasswd ".
798: "or pwchange");
799: } elsif ($answer =~ "^non_authorized") {
800: &logthis("$uname in $udom did not get their password correct when ".
801: "attempting to change it on $server.");
802: } elsif ($answer =~ "^auth_mode_error") {
803: &logthis("$uname in $udom attempted to change their password despite ".
804: "not being locally or internally authenticated on $server.");
805: } elsif ($answer =~ "^unknown_user") {
806: &logthis("$uname in $udom attempted to change their password ".
807: "on $server but were unable to because $server is not ".
808: "their home server.");
809: } elsif ($answer =~ "^refused") {
810: &logthis("$server refused to change $uname in $udom password because ".
811: "it was sent an unencrypted request to change the password.");
812: }
813: return $answer;
1.1 albertel 814: }
815:
1.169 harris41 816: # ----------------------- Try to determine user's current authentication scheme
817:
818: sub queryauthenticate {
819: my ($uname,$udom)=@_;
1.456 albertel 820: my $uhome=&homeserver($uname,$udom);
821: if (!$uhome) {
822: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
823: return 'no_host';
824: }
825: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
826: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
827: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 828: }
1.456 albertel 829: return $answer;
1.169 harris41 830: }
831:
1.1 albertel 832: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 833:
1.1 albertel 834: sub authenticate {
1.952 raeburn 835: my ($uname,$upass,$udom,$checkdefauth)=@_;
1.807 albertel 836: $upass=&escape($upass);
837: $uname= &LONCAPA::clean_username($uname);
1.836 www 838: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 839: my $newhome;
1.836 www 840: if ((!$uhome) || ($uhome eq 'no_host')) {
841: # Maybe the machine was offline and only re-appeared again recently?
842: &reconlonc();
843: # One more
1.952 raeburn 844: $uhome=&homeserver($uname,$udom,1);
845: if (($uhome eq 'no_host') && $checkdefauth) {
846: if (defined(&domain($udom,'primary'))) {
847: $newhome=&domain($udom,'primary');
848: }
849: if ($newhome ne '') {
850: $uhome = $newhome;
851: }
852: }
1.836 www 853: if ((!$uhome) || ($uhome eq 'no_host')) {
854: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 855: return 'no_host';
856: }
1.1 albertel 857: }
1.952 raeburn 858: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
1.471 albertel 859: if ($answer eq 'authorized') {
1.952 raeburn 860: if ($newhome) {
861: &logthis("User $uname at $udom authorized by $uhome, but needs account");
862: return 'no_account_on_host';
863: } else {
864: &logthis("User $uname at $udom authorized by $uhome");
865: return $uhome;
866: }
1.471 albertel 867: }
868: if ($answer eq 'non_authorized') {
869: &logthis("User $uname at $udom rejected by $uhome");
870: return 'no_host';
1.9 www 871: }
1.471 albertel 872: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 873: return 'no_host';
874: }
875:
876: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 877:
1.599 albertel 878: my %homecache;
1.1 albertel 879: sub homeserver {
1.230 stredwic 880: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 881: my $index="$uname:$udom";
1.426 albertel 882:
1.599 albertel 883: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 884:
885: my %servers = &get_servers($udom,'library');
886: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 887: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 888: exists($badServerCache{$tryserver}));
1.841 albertel 889:
890: my $answer=reply("home:$udom:$uname",$tryserver);
891: if ($answer eq 'found') {
892: delete($badServerCache{$tryserver});
893: return $homecache{$index}=$tryserver;
894: } elsif ($answer eq 'no_host') {
895: $badServerCache{$tryserver}=1;
896: }
1.1 albertel 897: }
898: return 'no_host';
1.70 www 899: }
900:
901: # ------------------------------------- Find the usernames behind a list of IDs
902:
903: sub idget {
904: my ($udom,@ids)=@_;
905: my %returnhash=();
906:
1.841 albertel 907: my %servers = &get_servers($udom,'library');
908: foreach my $tryserver (keys(%servers)) {
909: my $idlist=join('&',@ids);
910: $idlist=~tr/A-Z/a-z/;
911: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
912: my @answer=();
913: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
914: @answer=split(/\&/,$reply);
915: } ;
916: my $i;
917: for ($i=0;$i<=$#ids;$i++) {
918: if ($answer[$i]) {
919: $returnhash{$ids[$i]}=$answer[$i];
920: }
921: }
922: }
1.70 www 923: return %returnhash;
924: }
925:
926: # ------------------------------------- Find the IDs behind a list of usernames
927:
928: sub idrget {
929: my ($udom,@unames)=@_;
930: my %returnhash=();
1.800 albertel 931: foreach my $uname (@unames) {
932: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 933: }
1.70 www 934: return %returnhash;
935: }
936:
937: # ------------------------------- Store away a list of names and associated IDs
938:
939: sub idput {
940: my ($udom,%ids)=@_;
941: my %servers=();
1.800 albertel 942: foreach my $uname (keys(%ids)) {
943: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
944: my $uhom=&homeserver($uname,$udom);
1.70 www 945: if ($uhom ne 'no_host') {
1.800 albertel 946: my $id=&escape($ids{$uname});
1.70 www 947: $id=~tr/A-Z/a-z/;
1.800 albertel 948: my $esc_unam=&escape($uname);
1.70 www 949: if ($servers{$uhom}) {
1.800 albertel 950: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 951: } else {
1.800 albertel 952: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 953: }
954: }
1.191 harris41 955: }
1.800 albertel 956: foreach my $server (keys(%servers)) {
957: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 958: }
1.344 www 959: }
960:
1.806 raeburn 961: # ------------------------------------------- get items from domain db files
962:
963: sub get_dom {
1.860 raeburn 964: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 965: my $items='';
966: foreach my $item (@$storearr) {
967: $items.=&escape($item).'&';
968: }
969: $items=~s/\&$//;
1.860 raeburn 970: if (!$udom) {
971: $udom=$env{'user.domain'};
972: if (defined(&domain($udom,'primary'))) {
973: $uhome=&domain($udom,'primary');
974: } else {
1.874 albertel 975: undef($uhome);
1.860 raeburn 976: }
977: } else {
978: if (!$uhome) {
979: if (defined(&domain($udom,'primary'))) {
980: $uhome=&domain($udom,'primary');
981: }
982: }
983: }
984: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 985: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 986: my %returnhash;
1.875 albertel 987: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 988: return %returnhash;
989: }
1.806 raeburn 990: my @pairs=split(/\&/,$rep);
991: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
992: return @pairs;
993: }
994: my $i=0;
995: foreach my $item (@$storearr) {
996: $returnhash{$item}=&thaw_unescape($pairs[$i]);
997: $i++;
998: }
999: return %returnhash;
1000: } else {
1.880 banghart 1001: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1002: }
1003: }
1004:
1005: # -------------------------------------------- put items in domain db files
1006:
1007: sub put_dom {
1.860 raeburn 1008: my ($namespace,$storehash,$udom,$uhome)=@_;
1009: if (!$udom) {
1010: $udom=$env{'user.domain'};
1011: if (defined(&domain($udom,'primary'))) {
1012: $uhome=&domain($udom,'primary');
1013: } else {
1.874 albertel 1014: undef($uhome);
1.860 raeburn 1015: }
1016: } else {
1017: if (!$uhome) {
1018: if (defined(&domain($udom,'primary'))) {
1019: $uhome=&domain($udom,'primary');
1020: }
1021: }
1022: }
1023: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1024: my $items='';
1025: foreach my $item (keys(%$storehash)) {
1026: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1027: }
1028: $items=~s/\&$//;
1029: return &reply("putdom:$udom:$namespace:$items",$uhome);
1030: } else {
1.860 raeburn 1031: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1032: }
1033: }
1034:
1.837 raeburn 1035: sub retrieve_inst_usertypes {
1036: my ($udom) = @_;
1037: my (%returnhash,@order);
1.989 raeburn 1038: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1039: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1040: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1041: %returnhash = %{$domdefs{'inststatustypes'}};
1042: @order = @{$domdefs{'inststatusorder'}};
1043: } else {
1044: if (defined(&domain($udom,'primary'))) {
1045: my $uhome=&domain($udom,'primary');
1046: my $rep=&reply("inst_usertypes:$udom",$uhome);
1047: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1048: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1049: return (\%returnhash,\@order);
1050: }
1051: my ($hashitems,$orderitems) = split(/:/,$rep);
1052: my @pairs=split(/\&/,$hashitems);
1053: foreach my $item (@pairs) {
1054: my ($key,$value)=split(/=/,$item,2);
1055: $key = &unescape($key);
1056: next if ($key =~ /^error: 2 /);
1057: $returnhash{$key}=&thaw_unescape($value);
1058: }
1059: my @esc_order = split(/\&/,$orderitems);
1060: foreach my $item (@esc_order) {
1061: push(@order,&unescape($item));
1062: }
1063: } else {
1064: &logthis("get_dom failed - no primary domain server for $udom");
1.837 raeburn 1065: }
1066: }
1067: return (\%returnhash,\@order);
1068: }
1069:
1.868 raeburn 1070: sub is_domainimage {
1071: my ($url) = @_;
1072: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1073: if (&domain($1) ne '') {
1074: return '1';
1075: }
1076: }
1077: return;
1078: }
1079:
1.899 raeburn 1080: sub inst_directory_query {
1081: my ($srch) = @_;
1082: my $udom = $srch->{'srchdomain'};
1083: my %results;
1084: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1085: my $outcome;
1.899 raeburn 1086: if ($homeserver ne '') {
1.904 albertel 1087: my $queryid=&reply("querysend:instdirsearch:".
1088: &escape($srch->{'srchby'}).':'.
1089: &escape($srch->{'srchterm'}).':'.
1090: &escape($srch->{'srchtype'}),$homeserver);
1091: my $host=&hostname($homeserver);
1092: if ($queryid !~/^\Q$host\E\_/) {
1093: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1094: return;
1095: }
1096: my $response = &get_query_reply($queryid);
1097: my $maxtries = 5;
1098: my $tries = 1;
1099: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1100: $response = &get_query_reply($queryid);
1101: $tries ++;
1102: }
1103:
1104: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1105: if ($response eq 'unavailable') {
1106: $outcome = $response;
1107: } else {
1108: $outcome = 'ok';
1109: my @matches = split(/\n/,$response);
1110: foreach my $match (@matches) {
1111: my ($key,$value) = split(/=/,$match);
1112: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1113: }
1.899 raeburn 1114: }
1115: }
1116: }
1.909 raeburn 1117: return ($outcome,%results);
1.899 raeburn 1118: }
1119:
1120: sub usersearch {
1121: my ($srch) = @_;
1122: my $dom = $srch->{'srchdomain'};
1123: my %results;
1124: my %libserv = &all_library();
1125: my $query = 'usersearch';
1126: foreach my $tryserver (keys(%libserv)) {
1127: if (&host_domain($tryserver) eq $dom) {
1128: my $host=&hostname($tryserver);
1129: my $queryid=
1.911 raeburn 1130: &reply("querysend:".&escape($query).':'.
1131: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1132: &escape($srch->{'srchtype'}).':'.
1133: &escape($srch->{'srchterm'}),$tryserver);
1134: if ($queryid !~/^\Q$host\E\_/) {
1135: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1136: next;
1.899 raeburn 1137: }
1138: my $reply = &get_query_reply($queryid);
1139: my $maxtries = 1;
1140: my $tries = 1;
1141: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1142: $reply = &get_query_reply($queryid);
1143: $tries ++;
1144: }
1145: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1146: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1147: } else {
1.911 raeburn 1148: my @matches;
1149: if ($reply =~ /\n/) {
1150: @matches = split(/\n/,$reply);
1151: } else {
1152: @matches = split(/\&/,$reply);
1153: }
1.899 raeburn 1154: foreach my $match (@matches) {
1155: my ($uname,$udom,%userhash);
1.911 raeburn 1156: foreach my $entry (split(/:/,$match)) {
1157: my ($key,$value) =
1158: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1159: $userhash{$key} = $value;
1160: if ($key eq 'username') {
1161: $uname = $value;
1162: } elsif ($key eq 'domain') {
1163: $udom = $value;
1.911 raeburn 1164: }
1.899 raeburn 1165: }
1166: $results{$uname.':'.$udom} = \%userhash;
1167: }
1168: }
1169: }
1170: }
1171: return %results;
1172: }
1173:
1.912 raeburn 1174: sub get_instuser {
1175: my ($udom,$uname,$id) = @_;
1176: my $homeserver = &domain($udom,'primary');
1177: my ($outcome,%results);
1178: if ($homeserver ne '') {
1179: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1180: &escape($id).':'.&escape($udom),$homeserver);
1181: my $host=&hostname($homeserver);
1182: if ($queryid !~/^\Q$host\E\_/) {
1183: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1184: return;
1185: }
1186: my $response = &get_query_reply($queryid);
1187: my $maxtries = 5;
1188: my $tries = 1;
1189: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1190: $response = &get_query_reply($queryid);
1191: $tries ++;
1192: }
1193: if (!&error($response) && $response ne 'refused') {
1194: if ($response eq 'unavailable') {
1195: $outcome = $response;
1196: } else {
1197: $outcome = 'ok';
1198: my @matches = split(/\n/,$response);
1199: foreach my $match (@matches) {
1200: my ($key,$value) = split(/=/,$match);
1201: $results{&unescape($key)} = &thaw_unescape($value);
1202: }
1203: }
1204: }
1205: }
1206: my %userinfo;
1207: if (ref($results{$uname}) eq 'HASH') {
1208: %userinfo = %{$results{$uname}};
1209: }
1210: return ($outcome,%userinfo);
1211: }
1212:
1213: sub inst_rulecheck {
1.923 raeburn 1214: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1215: my %returnhash;
1216: if ($udom ne '') {
1217: if (ref($rules) eq 'ARRAY') {
1218: @{$rules} = map {&escape($_);} (@{$rules});
1219: my $rulestr = join(':',@{$rules});
1220: my $homeserver=&domain($udom,'primary');
1221: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1222: my $response;
1223: if ($item eq 'username') {
1224: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1225: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1226: $homeserver));
1.923 raeburn 1227: } elsif ($item eq 'id') {
1228: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1229: ':'.&escape($id).':'.$rulestr,
1230: $homeserver));
1.945 raeburn 1231: } elsif ($item eq 'selfcreate') {
1232: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 1233: &escape($udom).':'.&escape($uname).
1234: ':'.$rulestr,$homeserver));
1.923 raeburn 1235: }
1.912 raeburn 1236: if ($response ne 'refused') {
1237: my @pairs=split(/\&/,$response);
1238: foreach my $item (@pairs) {
1239: my ($key,$value)=split(/=/,$item,2);
1240: $key = &unescape($key);
1241: next if ($key =~ /^error: 2 /);
1242: $returnhash{$key}=&thaw_unescape($value);
1243: }
1244: }
1245: }
1246: }
1247: }
1248: return %returnhash;
1249: }
1250:
1251: sub inst_userrules {
1.923 raeburn 1252: my ($udom,$check) = @_;
1.912 raeburn 1253: my (%ruleshash,@ruleorder);
1254: if ($udom ne '') {
1255: my $homeserver=&domain($udom,'primary');
1256: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1257: my $response;
1258: if ($check eq 'id') {
1259: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1260: $homeserver);
1.943 raeburn 1261: } elsif ($check eq 'email') {
1262: $response=&reply('instemailrules:'.&escape($udom),
1263: $homeserver);
1.923 raeburn 1264: } else {
1265: $response=&reply('instuserrules:'.&escape($udom),
1266: $homeserver);
1267: }
1.912 raeburn 1268: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1269: ($response ne 'unknown_cmd') &&
1.912 raeburn 1270: ($response ne 'no_such_host')) {
1271: my ($hashitems,$orderitems) = split(/:/,$response);
1272: my @pairs=split(/\&/,$hashitems);
1273: foreach my $item (@pairs) {
1274: my ($key,$value)=split(/=/,$item,2);
1275: $key = &unescape($key);
1276: next if ($key =~ /^error: 2 /);
1277: $ruleshash{$key}=&thaw_unescape($value);
1278: }
1279: my @esc_order = split(/\&/,$orderitems);
1280: foreach my $item (@esc_order) {
1281: push(@ruleorder,&unescape($item));
1282: }
1283: }
1284: }
1285: }
1286: return (\%ruleshash,\@ruleorder);
1287: }
1288:
1.976 raeburn 1289: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 1290:
1291: sub get_domain_defaults {
1292: my ($domain) = @_;
1293: my $cachetime = 60*60*24;
1294: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1295: if (defined($cached)) {
1296: if (ref($result) eq 'HASH') {
1297: return %{$result};
1298: }
1299: }
1300: my %domdefaults;
1301: my %domconfig =
1.989 raeburn 1302: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1303: 'requestcourses','inststatus'],$domain);
1.943 raeburn 1304: if (ref($domconfig{'defaults'}) eq 'HASH') {
1305: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1306: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1307: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 1308: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 1309: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.943 raeburn 1310: } else {
1311: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1312: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1313: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1314: }
1.976 raeburn 1315: if (ref($domconfig{'quotas'}) eq 'HASH') {
1316: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1317: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1318: } else {
1319: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1320: }
1321: my @usertools = ('aboutme','blog','portfolio');
1322: foreach my $item (@usertools) {
1323: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1324: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1325: }
1326: }
1327: }
1.985 raeburn 1328: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1329: foreach my $item ('official','unofficial') {
1330: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1331: }
1332: }
1.989 raeburn 1333: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1334: foreach my $item ('inststatustypes','inststatusorder') {
1335: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1336: }
1337: }
1.943 raeburn 1338: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1339: $cachetime);
1340: return %domdefaults;
1341: }
1342:
1.344 www 1343: # --------------------------------------------------- Assign a key to a student
1344:
1345: sub assign_access_key {
1.364 www 1346: #
1347: # a valid key looks like uname:udom#comments
1348: # comments are being appended
1349: #
1.498 www 1350: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1351: $kdom=
1.620 albertel 1352: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 1353: $knum=
1.620 albertel 1354: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 1355: $cdom=
1.620 albertel 1356: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1357: $cnum=
1.620 albertel 1358: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1359: $udom=$env{'user.name'} unless (defined($udom));
1360: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 1361: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 1362: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 1363: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 1364: # assigned to this person
1365: # - this should not happen,
1.345 www 1366: # unless something went wrong
1367: # the first time around
1368: # ready to assign
1.364 www 1369: $logentry=$1.'; '.$logentry;
1.496 www 1370: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 1371: $kdom,$knum) eq 'ok') {
1.345 www 1372: # key now belongs to user
1.346 www 1373: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 1374: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 1375: &appenv({'environment.'.$envkey => $ckey});
1.345 www 1376: return 'ok';
1377: } else {
1378: return
1379: 'error: Count not permanently assign key, will need to be re-entered later.';
1380: }
1381: } else {
1382: return 'error: Could not assign key, try again later.';
1383: }
1.364 www 1384: } elsif (!$existing{$ckey}) {
1.345 www 1385: # the key does not exist
1386: return 'error: The key does not exist';
1387: } else {
1388: # the key is somebody else's
1389: return 'error: The key is already in use';
1390: }
1.344 www 1391: }
1392:
1.364 www 1393: # ------------------------------------------ put an additional comment on a key
1394:
1395: sub comment_access_key {
1396: #
1397: # a valid key looks like uname:udom#comments
1398: # comments are being appended
1399: #
1400: my ($ckey,$cdom,$cnum,$logentry)=@_;
1401: $cdom=
1.620 albertel 1402: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 1403: $cnum=
1.620 albertel 1404: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 1405: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1406: if ($existing{$ckey}) {
1407: $existing{$ckey}.='; '.$logentry;
1408: # ready to assign
1.367 www 1409: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 1410: $cdom,$cnum) eq 'ok') {
1411: return 'ok';
1412: } else {
1413: return 'error: Count not store comment.';
1414: }
1415: } else {
1416: # the key does not exist
1417: return 'error: The key does not exist';
1418: }
1419: }
1420:
1.344 www 1421: # ------------------------------------------------------ Generate a set of keys
1422:
1423: sub generate_access_keys {
1.364 www 1424: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 1425: $cdom=
1.620 albertel 1426: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1427: $cnum=
1.620 albertel 1428: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 1429: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 1430: unless (($cdom) && ($cnum)) { return 0; }
1431: if ($number>10000) { return 0; }
1432: sleep(2); # make sure don't get same seed twice
1433: srand(time()^($$+($$<<15))); # from "Programming Perl"
1434: my $total=0;
1435: for (my $i=1;$i<=$number;$i++) {
1436: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1437: sprintf("%lx",int(100000*rand)).'-'.
1438: sprintf("%lx",int(100000*rand));
1439: $newkey=~s/1/g/g; # folks mix up 1 and l
1440: $newkey=~s/0/h/g; # and also 0 and O
1441: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1442: if ($existing{$newkey}) {
1443: $i--;
1444: } else {
1.364 www 1445: if (&put('accesskeys',
1446: { $newkey => '# generated '.localtime().
1.620 albertel 1447: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 1448: '; '.$logentry },
1449: $cdom,$cnum) eq 'ok') {
1.344 www 1450: $total++;
1451: }
1452: }
1453: }
1.620 albertel 1454: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 1455: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1456: return $total;
1457: }
1458:
1459: # ------------------------------------------------------- Validate an accesskey
1460:
1461: sub validate_access_key {
1462: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1463: $cdom=
1.620 albertel 1464: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1465: $cnum=
1.620 albertel 1466: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1467: $udom=$env{'user.domain'} unless (defined($udom));
1468: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 1469: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 1470: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 1471: }
1472:
1473: # ------------------------------------- Find the section of student in a course
1.652 albertel 1474: sub devalidate_getsection_cache {
1475: my ($udom,$unam,$courseid)=@_;
1476: my $hashid="$udom:$unam:$courseid";
1477: &devalidate_cache_new('getsection',$hashid);
1478: }
1.298 matthew 1479:
1.815 albertel 1480: sub courseid_to_courseurl {
1481: my ($courseid) = @_;
1482: #already url style courseid
1483: return $courseid if ($courseid =~ m{^/});
1484:
1485: if (exists($env{'course.'.$courseid.'.num'})) {
1486: my $cnum = $env{'course.'.$courseid.'.num'};
1487: my $cdom = $env{'course.'.$courseid.'.domain'};
1488: return "/$cdom/$cnum";
1489: }
1490:
1491: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1492: if (exists($courseinfo{'num'})) {
1493: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1494: }
1495:
1496: return undef;
1497: }
1498:
1.298 matthew 1499: sub getsection {
1500: my ($udom,$unam,$courseid)=@_;
1.599 albertel 1501: my $cachetime=1800;
1.551 albertel 1502:
1503: my $hashid="$udom:$unam:$courseid";
1.599 albertel 1504: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 1505: if (defined($cached)) { return $result; }
1506:
1.298 matthew 1507: my %Pending;
1508: my %Expired;
1509: #
1510: # Each role can either have not started yet (pending), be active,
1511: # or have expired.
1512: #
1513: # If there is an active role, we are done.
1514: #
1515: # If there is more than one role which has not started yet,
1516: # choose the one which will start sooner
1517: # If there is one role which has not started yet, return it.
1518: #
1519: # If there is more than one expired role, choose the one which ended last.
1520: # If there is a role which has expired, return it.
1521: #
1.815 albertel 1522: $courseid = &courseid_to_courseurl($courseid);
1.817 raeburn 1523: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1524: foreach my $key (keys(%roleshash)) {
1.479 albertel 1525: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 1526: my $section=$1;
1527: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 1528: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 1529: my $now=time;
1.548 albertel 1530: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 1531: $Expired{$end}=$section;
1532: next;
1533: }
1.548 albertel 1534: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 1535: $Pending{$start}=$section;
1536: next;
1537: }
1.599 albertel 1538: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 1539: }
1540: #
1541: # Presumedly there will be few matching roles from the above
1542: # loop and the sorting time will be negligible.
1543: if (scalar(keys(%Pending))) {
1544: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 1545: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 1546: }
1547: if (scalar(keys(%Expired))) {
1548: my @sorted = sort {$a <=> $b} keys(%Expired);
1549: my $time = pop(@sorted);
1.599 albertel 1550: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 1551: }
1.599 albertel 1552: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 1553: }
1.70 www 1554:
1.599 albertel 1555: sub save_cache {
1556: &purge_remembered();
1.722 albertel 1557: #&Apache::loncommon::validate_page();
1.620 albertel 1558: undef(%env);
1.780 albertel 1559: undef($env_loaded);
1.599 albertel 1560: }
1.452 albertel 1561:
1.599 albertel 1562: my $to_remember=-1;
1563: my %remembered;
1564: my %accessed;
1565: my $kicks=0;
1566: my $hits=0;
1.849 albertel 1567: sub make_key {
1568: my ($name,$id) = @_;
1.872 albertel 1569: if (length($id) > 65
1570: && length(&escape($id)) > 200) {
1571: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1572: }
1.849 albertel 1573: return &escape($name.':'.$id);
1574: }
1575:
1.599 albertel 1576: sub devalidate_cache_new {
1577: my ($name,$id,$debug) = @_;
1578: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 1579: $id=&make_key($name,$id);
1.599 albertel 1580: $memcache->delete($id);
1581: delete($remembered{$id});
1582: delete($accessed{$id});
1583: }
1584:
1585: sub is_cached_new {
1586: my ($name,$id,$debug) = @_;
1.849 albertel 1587: $id=&make_key($name,$id);
1.599 albertel 1588: if (exists($remembered{$id})) {
1589: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1590: $accessed{$id}=[&gettimeofday()];
1591: $hits++;
1592: return ($remembered{$id},1);
1593: }
1594: my $value = $memcache->get($id);
1595: if (!(defined($value))) {
1596: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 1597: return (undef,undef);
1.416 albertel 1598: }
1.599 albertel 1599: if ($value eq '__undef__') {
1600: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1601: $value=undef;
1602: }
1603: &make_room($id,$value,$debug);
1604: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1605: return ($value,1);
1606: }
1607:
1608: sub do_cache_new {
1609: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 1610: $id=&make_key($name,$id);
1.599 albertel 1611: my $setvalue=$value;
1612: if (!defined($setvalue)) {
1613: $setvalue='__undef__';
1614: }
1.623 albertel 1615: if (!defined($time) ) {
1616: $time=600;
1617: }
1.599 albertel 1618: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 1619: my $result = $memcache->set($id,$setvalue,$time);
1620: if (! $result) {
1.872 albertel 1621: &logthis("caching of id -> $id failed");
1.910 albertel 1622: $memcache->disconnect_all();
1.872 albertel 1623: }
1.600 albertel 1624: # need to make a copy of $value
1.919 albertel 1625: &make_room($id,$value,$debug);
1.599 albertel 1626: return $value;
1627: }
1628:
1629: sub make_room {
1630: my ($id,$value,$debug)=@_;
1.919 albertel 1631:
1632: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1633: : $value;
1.599 albertel 1634: if ($to_remember<0) { return; }
1635: $accessed{$id}=[&gettimeofday()];
1636: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1637: my $to_kick;
1638: my $max_time=0;
1639: foreach my $other (keys(%accessed)) {
1640: if (&tv_interval($accessed{$other}) > $max_time) {
1641: $to_kick=$other;
1642: $max_time=&tv_interval($accessed{$other});
1643: }
1644: }
1645: delete($remembered{$to_kick});
1646: delete($accessed{$to_kick});
1647: $kicks++;
1648: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 1649: return;
1650: }
1651:
1.599 albertel 1652: sub purge_remembered {
1.604 albertel 1653: #&logthis("Tossing ".scalar(keys(%remembered)));
1654: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 1655: undef(%remembered);
1656: undef(%accessed);
1.428 albertel 1657: }
1.70 www 1658: # ------------------------------------- Read an entry from a user's environment
1659:
1660: sub userenvironment {
1661: my ($udom,$unam,@what)=@_;
1.976 raeburn 1662: my $items;
1663: foreach my $item (@what) {
1664: $items.=&escape($item).'&';
1665: }
1666: $items=~s/\&$//;
1.70 www 1667: my %returnhash=();
1668: my @answer=split(/\&/,
1.976 raeburn 1669: &reply('get:'.$udom.':'.$unam.':environment:'.$items,
1.70 www 1670: &homeserver($unam,$udom)));
1671: my $i;
1672: for ($i=0;$i<=$#what;$i++) {
1673: $returnhash{$what[$i]}=&unescape($answer[$i]);
1674: }
1675: return %returnhash;
1.1 albertel 1676: }
1677:
1.617 albertel 1678: # ---------------------------------------------------------- Get a studentphoto
1679: sub studentphoto {
1680: my ($udom,$unam,$ext) = @_;
1681: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 1682: if (defined($env{'request.course.id'})) {
1.708 raeburn 1683: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 1684: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1685: return(&retrievestudentphoto($udom,$unam,$ext));
1686: } else {
1687: my ($result,$perm_reqd)=
1.707 albertel 1688: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1689: if ($result eq 'ok') {
1690: if (!($perm_reqd eq 'yes')) {
1691: return(&retrievestudentphoto($udom,$unam,$ext));
1692: }
1693: }
1694: }
1695: }
1696: } else {
1697: my ($result,$perm_reqd) =
1.707 albertel 1698: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1699: if ($result eq 'ok') {
1700: if (!($perm_reqd eq 'yes')) {
1701: return(&retrievestudentphoto($udom,$unam,$ext));
1702: }
1703: }
1704: }
1705: return '/adm/lonKaputt/lonlogo_broken.gif';
1706: }
1707:
1708: sub retrievestudentphoto {
1709: my ($udom,$unam,$ext,$type) = @_;
1710: my $home=&Apache::lonnet::homeserver($unam,$udom);
1711: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1712: if ($ret eq 'ok') {
1713: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1714: if ($type eq 'thumbnail') {
1715: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1716: }
1717: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1718: return $tokenurl;
1719: } else {
1720: if ($type eq 'thumbnail') {
1721: return '/adm/lonKaputt/genericstudent_tn.gif';
1722: } else {
1723: return '/adm/lonKaputt/lonlogo_broken.gif';
1724: }
1.617 albertel 1725: }
1726: }
1727:
1.263 www 1728: # -------------------------------------------------------------------- New chat
1729:
1730: sub chatsend {
1.724 raeburn 1731: my ($newentry,$anon,$group)=@_;
1.620 albertel 1732: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1733: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1734: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1735: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1736: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1737: &escape($newentry)).':'.$group,$chome);
1.292 www 1738: }
1739:
1740: # ------------------------------------------ Find current version of a resource
1741:
1742: sub getversion {
1743: my $fname=&clutter(shift);
1744: unless ($fname=~/^\/res\//) { return -1; }
1745: return ¤tversion(&filelocation('',$fname));
1746: }
1747:
1748: sub currentversion {
1749: my $fname=shift;
1.599 albertel 1750: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1751: if (defined($cached)) { return $result; }
1.292 www 1752: my $author=$fname;
1753: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1754: my ($udom,$uname)=split(/\//,$author);
1755: my $home=homeserver($uname,$udom);
1756: if ($home eq 'no_host') {
1757: return -1;
1758: }
1759: my $answer=reply("currentversion:$fname",$home);
1760: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1761: return -1;
1762: }
1.599 albertel 1763: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1764: }
1765:
1.1 albertel 1766: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1767:
1.1 albertel 1768: sub subscribe {
1769: my $fname=shift;
1.761 raeburn 1770: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1771: $fname=~s/[\n\r]//g;
1.1 albertel 1772: my $author=$fname;
1773: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1774: my ($udom,$uname)=split(/\//,$author);
1775: my $home=homeserver($uname,$udom);
1.335 albertel 1776: if ($home eq 'no_host') {
1777: return 'not_found';
1.1 albertel 1778: }
1779: my $answer=reply("sub:$fname",$home);
1.64 www 1780: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1781: $answer.=' by '.$home;
1782: }
1.1 albertel 1783: return $answer;
1784: }
1785:
1.8 www 1786: # -------------------------------------------------------------- Replicate file
1787:
1788: sub repcopy {
1789: my $filename=shift;
1.23 www 1790: $filename=~s/\/+/\//g;
1.607 raeburn 1791: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1792: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1793: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1794: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1795: return &repcopy_userfile($filename);
1796: }
1.532 albertel 1797: $filename=~s/[\n\r]//g;
1.8 www 1798: my $transname="$filename.in.transfer";
1.828 www 1799: # FIXME: this should flock
1.607 raeburn 1800: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1801: my $remoteurl=subscribe($filename);
1.64 www 1802: if ($remoteurl =~ /^con_lost by/) {
1803: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1804: return 'unavailable';
1.8 www 1805: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1806: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1807: return 'not_found';
1.64 www 1808: } elsif ($remoteurl =~ /^rejected by/) {
1809: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1810: return 'forbidden';
1.20 www 1811: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1812: return 'ok';
1.8 www 1813: } else {
1.290 www 1814: my $author=$filename;
1815: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1816: my ($udom,$uname)=split(/\//,$author);
1817: my $home=homeserver($uname,$udom);
1818: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1819: my @parts=split(/\//,$filename);
1820: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1821: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1822: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1823: return 'bad_request';
1.8 www 1824: }
1825: my $count;
1826: for ($count=5;$count<$#parts;$count++) {
1827: $path.="/$parts[$count]";
1828: if ((-e $path)!=1) {
1829: mkdir($path,0777);
1830: }
1831: }
1832: my $ua=new LWP::UserAgent;
1833: my $request=new HTTP::Request('GET',"$remoteurl");
1834: my $response=$ua->request($request,$transname);
1835: if ($response->is_error()) {
1836: unlink($transname);
1837: my $message=$response->status_line;
1.672 albertel 1838: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1839: ." LWP get: $message: $filename</font>");
1.607 raeburn 1840: return 'unavailable';
1.8 www 1841: } else {
1.16 www 1842: if ($remoteurl!~/\.meta$/) {
1843: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1844: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1845: if ($mresponse->is_error()) {
1846: unlink($filename.'.meta');
1847: &logthis(
1.672 albertel 1848: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1849: }
1850: }
1.8 www 1851: rename($transname,$filename);
1.607 raeburn 1852: return 'ok';
1.8 www 1853: }
1.290 www 1854: }
1.8 www 1855: }
1.330 www 1856: }
1857:
1858: # ------------------------------------------------ Get server side include body
1859: sub ssi_body {
1.381 albertel 1860: my ($filelink,%form)=@_;
1.606 matthew 1861: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1862: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1863: }
1.953 www 1864: my $output='';
1865: my $response;
1.980 raeburn 1866: if ($filelink=~/^https?\:/) {
1.954 raeburn 1867: ($output,$response)=&externalssi($filelink);
1.953 www 1868: } else {
1.1004 ! droeschl 1869: $filelink .= $filelink=~/\?/ ? '&' : '?';
! 1870: $filelink .= 'inhibitmenu=yes';
1.953 www 1871: ($output,$response)=&ssi($filelink,%form);
1872: }
1.778 albertel 1873: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1874: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 1875: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 1876: if (wantarray) {
1877: return ($output, $response);
1878: } else {
1879: return $output;
1880: }
1.8 www 1881: }
1882:
1.15 www 1883: # --------------------------------------------------------- Server Side Include
1884:
1.782 albertel 1885: sub absolute_url {
1886: my ($host_name) = @_;
1887: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1888: if ($host_name eq '') {
1889: $host_name = $ENV{'SERVER_NAME'};
1890: }
1891: return $protocol.$host_name;
1892: }
1893:
1.942 foxr 1894: #
1895: # Server side include.
1896: # Parameters:
1897: # fn Possibly encrypted resource name/id.
1898: # form Hash that describes how the rendering should be done
1899: # and other things.
1.944 foxr 1900: # Returns:
1.950 raeburn 1901: # Scalar context: The content of the response.
1902: # Array context: 2 element list of the content and the full response object.
1.942 foxr 1903: #
1.15 www 1904: sub ssi {
1905:
1.944 foxr 1906: my ($fn,%form)=@_;
1.15 www 1907: my $ua=new LWP::UserAgent;
1.23 www 1908: my $request;
1.711 albertel 1909:
1910: $form{'no_update_last_known'}=1;
1.895 albertel 1911: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 1912: if (%form) {
1.782 albertel 1913: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000 raeburn 1914: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23 www 1915: } else {
1.782 albertel 1916: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 1917: }
1918:
1.15 www 1919: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1920: my $response=$ua->request($request);
1921:
1.944 foxr 1922: if (wantarray) {
1923: return ($response->content, $response);
1924: } else {
1925: return $response->content;
1.942 foxr 1926: }
1.324 www 1927: }
1928:
1929: sub externalssi {
1930: my ($url)=@_;
1931: my $ua=new LWP::UserAgent;
1932: my $request=new HTTP::Request('GET',$url);
1933: my $response=$ua->request($request);
1.954 raeburn 1934: if (wantarray) {
1935: return ($response->content, $response);
1936: } else {
1937: return $response->content;
1938: }
1.15 www 1939: }
1.254 www 1940:
1.492 albertel 1941: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1942:
1943: sub allowuploaded {
1944: my ($srcurl,$url)=@_;
1945: $url=&clutter(&declutter($url));
1946: my $dir=$url;
1947: $dir=~s/\/[^\/]+$//;
1948: my %httpref=();
1949: my $httpurl=&hreflocation('',$url);
1950: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 1951: &Apache::lonnet::appenv(\%httpref);
1.254 www 1952: }
1.477 raeburn 1953:
1.478 albertel 1954: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 1955: # input: action, courseID, current domain, intended
1.637 raeburn 1956: # path to file, source of file, instruction to parse file for objects,
1957: # ref to hash for embedded objects,
1958: # ref to hash for codebase of java objects.
1959: #
1.485 raeburn 1960: # output: url to file (if action was uploaddoc),
1961: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 1962: #
1.478 albertel 1963: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1964: # course.
1.477 raeburn 1965: #
1.478 albertel 1966: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1967: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1968: # course's home server.
1.477 raeburn 1969: #
1.478 albertel 1970: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1971: # be copied from $source (current location) to
1972: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1973: # and will then be copied to
1974: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1975: # course's home server.
1.485 raeburn 1976: #
1.481 raeburn 1977: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 1978: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 1979: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1980: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1981: # in course's home server.
1.637 raeburn 1982: #
1.477 raeburn 1983:
1984: sub process_coursefile {
1.638 albertel 1985: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 1986: my $fetchresult;
1.638 albertel 1987: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 1988: if ($action eq 'propagate') {
1.638 albertel 1989: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1990: $home);
1.481 raeburn 1991: } else {
1.477 raeburn 1992: my $fpath = '';
1993: my $fname = $file;
1.478 albertel 1994: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 1995: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 1996: my $filepath = &build_filepath($fpath);
1.481 raeburn 1997: if ($action eq 'copy') {
1998: if ($source eq '') {
1999: $fetchresult = 'no source file';
2000: return $fetchresult;
2001: } else {
2002: my $destination = $filepath.'/'.$fname;
2003: rename($source,$destination);
2004: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2005: $home);
1.481 raeburn 2006: }
2007: } elsif ($action eq 'uploaddoc') {
2008: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 2009: print $fh $env{'form.'.$source};
1.481 raeburn 2010: close($fh);
1.637 raeburn 2011: if ($parser eq 'parse') {
1.961 raeburn 2012: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
1.637 raeburn 2013: unless ($parse_result eq 'ok') {
2014: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2015: }
2016: }
1.477 raeburn 2017: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2018: $home);
1.481 raeburn 2019: if ($fetchresult eq 'ok') {
2020: return '/uploaded/'.$fpath.'/'.$fname;
2021: } else {
2022: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2023: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 2024: return '/adm/notfound.html';
2025: }
1.477 raeburn 2026: }
2027: }
1.485 raeburn 2028: unless ( $fetchresult eq 'ok') {
1.477 raeburn 2029: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2030: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 2031: }
2032: return $fetchresult;
2033: }
2034:
1.637 raeburn 2035: sub build_filepath {
2036: my ($fpath) = @_;
2037: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2038: unless ($fpath eq '') {
2039: my @parts=split('/',$fpath);
2040: foreach my $part (@parts) {
2041: $filepath.= '/'.$part;
2042: if ((-e $filepath)!=1) {
2043: mkdir($filepath,0777);
2044: }
2045: }
2046: }
2047: return $filepath;
2048: }
2049:
2050: sub store_edited_file {
1.638 albertel 2051: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 2052: my $file = $primary_url;
2053: $file =~ s#^/uploaded/$docudom/$docuname/##;
2054: my $fpath = '';
2055: my $fname = $file;
2056: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2057: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2058: my $filepath = &build_filepath($fpath);
2059: open(my $fh,'>'.$filepath.'/'.$fname);
2060: print $fh $content;
2061: close($fh);
1.638 albertel 2062: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 2063: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2064: $home);
1.637 raeburn 2065: if ($$fetchresult eq 'ok') {
2066: return '/uploaded/'.$fpath.'/'.$fname;
2067: } else {
1.638 albertel 2068: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2069: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 2070: return '/adm/notfound.html';
2071: }
2072: }
2073:
1.531 albertel 2074: sub clean_filename {
1.831 albertel 2075: my ($fname,$args)=@_;
1.315 www 2076: # Replace Windows backslashes by forward slashes
1.257 www 2077: $fname=~s/\\/\//g;
1.831 albertel 2078: if (!$args->{'keep_path'}) {
2079: # Get rid of everything but the actual filename
2080: $fname=~s/^.*\/([^\/]+)$/$1/;
2081: }
1.315 www 2082: # Replace spaces by underscores
2083: $fname=~s/\s+/\_/g;
2084: # Replace all other weird characters by nothing
1.831 albertel 2085: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 2086: # Replace all .\d. sequences with _\d. so they no longer look like version
2087: # numbers
2088: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 2089: return $fname;
2090: }
1.984 neumanie 2091: #This Function check if a Image max 400px width and height 500px. If not then scale the image down
2092: sub resizeImage {
2093: my($img_url) = @_;
2094: my $ima = Image::Magick->new;
2095: $ima->Read($img_url);
2096: if($ima->Get('width') > 400)
2097: {
2098: my $factor = $ima->Get('width')/400;
2099: $ima->Scale( width=>400, height=>$ima->Get('height')/$factor );
2100: }
2101: if($ima->Get('height') > 500)
2102: {
2103: my $factor = $ima->Get('height')/500;
2104: $ima->Scale( width=>$ima->Get('width')/$factor, height=>500);
2105: }
2106:
2107: $ima->Write($img_url);
2108: }
1.531 albertel 2109:
1.977 amueller 2110: #Wrapper function for userphotoupload
2111: sub userphotoupload
2112: {
2113: my($formname,$subdir) = @_;
2114: $upload_photo_form = 1;
2115: return &userfileupload($formname,undef,$subdir);
2116: }
2117:
1.608 albertel 2118: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 2119: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 2120: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 2121: # $coursedoc - if true up to the current course
2122: # if false
2123: # $subdir - directory in userfile to store the file into
1.858 raeburn 2124: # $parser - instruction to parse file for objects ($parser = parse)
2125: # $allfiles - reference to hash for embedded objects
2126: # $codebase - reference to hash for codebase of java objects
2127: # $desuname - username for permanent storage of uploaded file
2128: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 2129: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2130: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.858 raeburn 2131: #
1.686 albertel 2132: # output: url of file in userspace, or error: <message>
2133: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 2134:
2135:
1.531 albertel 2136: sub userfileupload {
1.860 raeburn 2137: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2138: $destudom,$thumbwidth,$thumbheight)=@_;
1.531 albertel 2139: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 2140: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 2141: $fname=&clean_filename($fname);
1.315 www 2142: # See if there is anything left
1.257 www 2143: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 2144: chop($env{'form.'.$formname});
1.523 raeburn 2145: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2146: my $now = time;
2147: my $filepath = 'tmp/helprequests/'.$now;
2148: my @parts=split(/\//,$filepath);
2149: my $fullpath = $perlvar{'lonDaemons'};
2150: for (my $i=0;$i<@parts;$i++) {
2151: $fullpath .= '/'.$parts[$i];
2152: if ((-e $fullpath)!=1) {
2153: mkdir($fullpath,0777);
2154: }
2155: }
2156: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 2157: print $fh $env{'form.'.$formname};
1.523 raeburn 2158: close($fh);
1.741 raeburn 2159: return $fullpath.'/'.$fname;
2160: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2161: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2162: '_'.$env{'user.domain'}.'/pending';
2163: my @parts=split(/\//,$filepath);
2164: my $fullpath = $perlvar{'lonDaemons'};
2165: for (my $i=0;$i<@parts;$i++) {
2166: $fullpath .= '/'.$parts[$i];
2167: if ((-e $fullpath)!=1) {
2168: mkdir($fullpath,0777);
2169: }
2170: }
2171: open(my $fh,'>'.$fullpath.'/'.$fname);
2172: print $fh $env{'form.'.$formname};
2173: close($fh);
2174: return $fullpath.'/'.$fname;
1.523 raeburn 2175: }
1.995 raeburn 2176: if ($subdir eq 'scantron') {
2177: $fname = 'scantron_orig_'.$fname;
2178: } else {
1.258 www 2179: # Create the directory if not present
1.995 raeburn 2180: $fname="$subdir/$fname";
2181: }
1.259 www 2182: if ($coursedoc) {
1.638 albertel 2183: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2184: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 2185: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 2186: return &finishuserfileupload($docuname,$docudom,
2187: $formname,$fname,$parser,$allfiles,
1.860 raeburn 2188: $codebase,$thumbwidth,$thumbheight);
1.481 raeburn 2189: } else {
1.620 albertel 2190: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 2191: return &process_coursefile('uploaddoc',$docuname,$docudom,
2192: $fname,$formname,$parser,
2193: $allfiles,$codebase);
1.481 raeburn 2194: }
1.719 banghart 2195: } elsif (defined($destuname)) {
2196: my $docuname=$destuname;
2197: my $docudom=$destudom;
1.860 raeburn 2198: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2199: $parser,$allfiles,$codebase,
2200: $thumbwidth,$thumbheight);
1.719 banghart 2201:
1.259 www 2202: } else {
1.638 albertel 2203: my $docuname=$env{'user.name'};
2204: my $docudom=$env{'user.domain'};
1.714 raeburn 2205: if (exists($env{'form.group'})) {
2206: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2207: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2208: }
1.860 raeburn 2209: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2210: $parser,$allfiles,$codebase,
2211: $thumbwidth,$thumbheight);
1.259 www 2212: }
1.271 www 2213: }
2214:
2215: sub finishuserfileupload {
1.860 raeburn 2216: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2217: $thumbwidth,$thumbheight) = @_;
1.477 raeburn 2218: my $path=$docudom.'/'.$docuname.'/';
1.258 www 2219: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 2220:
1.860 raeburn 2221: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 2222: $file=$fname;
2223: if ($fname=~m|/|) {
2224: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2225: $path.=$fnamepath.'/';
2226: }
1.259 www 2227: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 2228: my $count;
2229: for ($count=4;$count<=$#parts;$count++) {
2230: $filepath.="/$parts[$count]";
2231: if ((-e $filepath)!=1) {
2232: mkdir($filepath,0777);
2233: }
2234: }
1.984 neumanie 2235:
1.258 www 2236: # Save the file
2237: {
1.701 albertel 2238: if (!open(FH,'>'.$filepath.'/'.$file)) {
2239: &logthis('Failed to create '.$filepath.'/'.$file);
2240: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2241: return '/adm/notfound.html';
2242: }
2243: if (!print FH ($env{'form.'.$formname})) {
2244: &logthis('Failed to write to '.$filepath.'/'.$file);
2245: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2246: return '/adm/notfound.html';
2247: }
1.570 albertel 2248: close(FH);
1.977 amueller 2249: if($upload_photo_form==1)
2250: {
1.984 neumanie 2251: resizeImage($filepath.'/'.$file);
1.977 amueller 2252: $upload_photo_form = 0;
2253: }
1.258 www 2254: }
1.637 raeburn 2255: if ($parser eq 'parse') {
1.961 raeburn 2256: my $parse_result = &extract_embedded_items($filepath.'/'.$file,$allfiles,
1.638 albertel 2257: $codebase);
1.637 raeburn 2258: unless ($parse_result eq 'ok') {
1.638 albertel 2259: &logthis('Failed to parse '.$filepath.$file.
2260: ' for embedded media: '.$parse_result);
1.637 raeburn 2261: }
2262: }
1.860 raeburn 2263: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2264: my $input = $filepath.'/'.$file;
2265: my $output = $filepath.'/'.'tn-'.$file;
2266: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2267: system("convert -sample $thumbsize $input $output");
2268: if (-e $filepath.'/'.'tn-'.$file) {
2269: $fetchthumb = 1;
2270: }
2271: }
1.858 raeburn 2272:
1.259 www 2273: # Notify homeserver to grep it
2274: #
1.984 neumanie 2275: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 2276: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 2277: if ($fetchresult eq 'ok') {
1.860 raeburn 2278: if ($fetchthumb) {
2279: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2280: if ($thumbresult ne 'ok') {
2281: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2282: $docuhome.': '.$thumbresult);
2283: }
2284: }
1.259 www 2285: #
1.258 www 2286: # Return the URL to it
1.494 albertel 2287: return '/uploaded/'.$path.$file;
1.263 www 2288: } else {
1.494 albertel 2289: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2290: ': '.$fetchresult);
1.263 www 2291: return '/adm/notfound.html';
1.858 raeburn 2292: }
1.493 albertel 2293: }
2294:
1.637 raeburn 2295: sub extract_embedded_items {
1.961 raeburn 2296: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 2297: my @state = ();
2298: my %javafiles = (
2299: codebase => '',
2300: code => '',
2301: archive => ''
2302: );
2303: my %mediafiles = (
2304: src => '',
2305: movie => '',
2306: );
1.648 raeburn 2307: my $p;
2308: if ($content) {
2309: $p = HTML::LCParser->new($content);
2310: } else {
1.961 raeburn 2311: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 2312: }
1.641 albertel 2313: while (my $t=$p->get_token()) {
1.640 albertel 2314: if ($t->[0] eq 'S') {
2315: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 2316: push(@state, $tagname);
1.648 raeburn 2317: if (lc($tagname) eq 'allow') {
2318: &add_filetype($allfiles,$attr->{'src'},'src');
2319: }
1.640 albertel 2320: if (lc($tagname) eq 'img') {
2321: &add_filetype($allfiles,$attr->{'src'},'src');
2322: }
1.886 albertel 2323: if (lc($tagname) eq 'a') {
2324: &add_filetype($allfiles,$attr->{'href'},'href');
2325: }
1.645 raeburn 2326: if (lc($tagname) eq 'script') {
2327: if ($attr->{'archive'} =~ /\.jar$/i) {
2328: &add_filetype($allfiles,$attr->{'archive'},'archive');
2329: } else {
2330: &add_filetype($allfiles,$attr->{'src'},'src');
2331: }
2332: }
2333: if (lc($tagname) eq 'link') {
2334: if (lc($attr->{'rel'}) eq 'stylesheet') {
2335: &add_filetype($allfiles,$attr->{'href'},'href');
2336: }
2337: }
1.640 albertel 2338: if (lc($tagname) eq 'object' ||
2339: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2340: foreach my $item (keys(%javafiles)) {
2341: $javafiles{$item} = '';
2342: }
2343: }
2344: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2345: my $name = lc($attr->{'name'});
2346: foreach my $item (keys(%javafiles)) {
2347: if ($name eq $item) {
2348: $javafiles{$item} = $attr->{'value'};
2349: last;
2350: }
2351: }
2352: foreach my $item (keys(%mediafiles)) {
2353: if ($name eq $item) {
2354: &add_filetype($allfiles, $attr->{'value'}, 'value');
2355: last;
2356: }
2357: }
2358: }
2359: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2360: foreach my $item (keys(%javafiles)) {
2361: if ($attr->{$item}) {
2362: $javafiles{$item} = $attr->{$item};
2363: last;
2364: }
2365: }
2366: foreach my $item (keys(%mediafiles)) {
2367: if ($attr->{$item}) {
2368: &add_filetype($allfiles,$attr->{$item},$item);
2369: last;
2370: }
2371: }
2372: }
2373: } elsif ($t->[0] eq 'E') {
2374: my ($tagname) = ($t->[1]);
2375: if ($javafiles{'codebase'} ne '') {
2376: $javafiles{'codebase'} .= '/';
2377: }
2378: if (lc($tagname) eq 'applet' ||
2379: lc($tagname) eq 'object' ||
2380: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2381: ) {
2382: foreach my $item (keys(%javafiles)) {
2383: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2384: my $file=$javafiles{'codebase'}.$javafiles{$item};
2385: &add_filetype($allfiles,$file,$item);
2386: }
2387: }
2388: }
2389: pop @state;
2390: }
2391: }
1.637 raeburn 2392: return 'ok';
2393: }
2394:
1.639 albertel 2395: sub add_filetype {
2396: my ($allfiles,$file,$type)=@_;
2397: if (exists($allfiles->{$file})) {
2398: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2399: push(@{$allfiles->{$file}}, &escape($type));
2400: }
2401: } else {
2402: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 2403: }
2404: }
2405:
1.493 albertel 2406: sub removeuploadedurl {
1.984 neumanie 2407: my ($url)=@_;
2408: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 2409: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 2410: }
2411:
2412: sub removeuserfile {
2413: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 2414: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2415: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 2416: if ($result eq 'ok') {
1.798 raeburn 2417: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2418: my $metafile = $fname.'.meta';
2419: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 2420: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 2421: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2422: my $sqlresult =
1.823 albertel 2423: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2424: 'portfolio_metadata',$group,
2425: 'delete');
1.798 raeburn 2426: }
2427: }
2428: return $result;
1.257 www 2429: }
1.15 www 2430:
1.530 albertel 2431: sub mkdiruserfile {
2432: my ($docuname,$docudom,$dir)=@_;
2433: my $home=&homeserver($docuname,$docudom);
2434: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2435: }
2436:
1.531 albertel 2437: sub renameuserfile {
2438: my ($docuname,$docudom,$old,$new)=@_;
2439: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2440: my $result = &reply("renameuserfile:$docudom:$docuname:".
2441: &escape("$old").':'.&escape("$new"),$home);
2442: if ($result eq 'ok') {
2443: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2444: my $oldmeta = $old.'.meta';
2445: my $newmeta = $new.'.meta';
2446: my $metaresult =
2447: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 2448: my $url = "/uploaded/$docudom/$docuname/$old";
2449: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2450: my $sqlresult =
1.823 albertel 2451: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2452: 'portfolio_metadata',$group,
2453: 'delete');
1.798 raeburn 2454: }
2455: }
2456: return $result;
1.531 albertel 2457: }
2458:
1.14 www 2459: # ------------------------------------------------------------------------- Log
2460:
2461: sub log {
2462: my ($dom,$nam,$hom,$what)=@_;
1.47 www 2463: return critical("log:$dom:$nam:$what",$hom);
1.157 www 2464: }
2465:
2466: # ------------------------------------------------------------------ Course Log
1.352 www 2467: #
2468: # This routine flushes several buffers of non-mission-critical nature
2469: #
1.157 www 2470:
2471: sub flushcourselogs {
1.352 www 2472: &logthis('Flushing log buffers');
2473: #
2474: # course logs
2475: # This is a log of all transactions in a course, which can be used
2476: # for data mining purposes
2477: #
2478: # It also collects the courseid database, which lists last transaction
2479: # times and course titles for all courseids
2480: #
2481: my %courseidbuffer=();
1.921 raeburn 2482: foreach my $crsid (keys(%courselogs)) {
1.352 www 2483: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 2484: &escape($courselogs{$crsid}),
2485: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 2486: delete $courselogs{$crsid};
2487: } else {
2488: &logthis('Failed to flush log buffer for '.$crsid);
2489: if (length($courselogs{$crsid})>40000) {
1.672 albertel 2490: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 2491: " exceeded maximum size, deleting.</font>");
2492: delete $courselogs{$crsid};
2493: }
1.352 www 2494: }
1.920 raeburn 2495: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 2496: 'description' => $coursedescrbuf{$crsid},
2497: 'inst_code' => $courseinstcodebuf{$crsid},
2498: 'type' => $coursetypebuf{$crsid},
2499: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 2500: };
1.191 harris41 2501: }
1.352 www 2502: #
2503: # Write course id database (reverse lookup) to homeserver of courses
2504: # Is used in pickcourse
2505: #
1.840 albertel 2506: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 2507: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 2508: $courseidbuffer{$crs_home},
2509: $crs_home,'timeonly');
1.352 www 2510: }
2511: #
2512: # File accesses
2513: # Writes to the dynamic metadata of resources to get hit counts, etc.
2514: #
1.449 matthew 2515: foreach my $entry (keys(%accesshash)) {
1.458 matthew 2516: if ($entry =~ /___count$/) {
2517: my ($dom,$name);
1.807 albertel 2518: ($dom,$name,undef)=
1.811 albertel 2519: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 2520: if (! defined($dom) || $dom eq '' ||
2521: ! defined($name) || $name eq '') {
1.620 albertel 2522: my $cid = $env{'request.course.id'};
2523: $dom = $env{'request.'.$cid.'.domain'};
2524: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 2525: }
1.450 matthew 2526: my $value = $accesshash{$entry};
2527: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2528: my %temphash=($url => $value);
1.449 matthew 2529: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2530: if ($result eq 'ok') {
2531: delete $accesshash{$entry};
2532: } elsif ($result eq 'unknown_cmd') {
2533: # Target server has old code running on it.
1.450 matthew 2534: my %temphash=($entry => $value);
1.449 matthew 2535: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2536: delete $accesshash{$entry};
2537: }
2538: }
2539: } else {
1.811 albertel 2540: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.450 matthew 2541: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 2542: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2543: delete $accesshash{$entry};
2544: }
1.185 www 2545: }
1.191 harris41 2546: }
1.352 www 2547: #
2548: # Roles
2549: # Reverse lookup of user roles for course faculty/staff and co-authorship
2550: #
1.800 albertel 2551: foreach my $entry (keys(%userrolehash)) {
1.351 www 2552: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 2553: split(/\:/,$entry);
2554: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 2555: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 2556: $rudom,$runame) eq 'ok') {
2557: delete $userrolehash{$entry};
2558: }
2559: }
1.662 raeburn 2560: #
2561: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2562: #
2563: my %domrolebuffer = ();
1.1000 raeburn 2564: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 2565: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 2566: if ($domrolebuffer{$rudom}) {
2567: $domrolebuffer{$rudom}.='&'.&escape($entry).
2568: '='.&escape($domainrolehash{$entry});
2569: } else {
2570: $domrolebuffer{$rudom}.=&escape($entry).
2571: '='.&escape($domainrolehash{$entry});
2572: }
2573: delete $domainrolehash{$entry};
2574: }
2575: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 2576: my %servers = &get_servers($dom,'library');
2577: foreach my $tryserver (keys(%servers)) {
2578: unless (&reply('domroleput:'.$dom.':'.
2579: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2580: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2581: }
1.662 raeburn 2582: }
2583: }
1.186 www 2584: $dumpcount++;
1.157 www 2585: }
2586:
2587: sub courselog {
2588: my $what=shift;
1.158 www 2589: $what=time.':'.$what;
1.620 albertel 2590: unless ($env{'request.course.id'}) { return ''; }
2591: $coursedombuf{$env{'request.course.id'}}=
2592: $env{'course.'.$env{'request.course.id'}.'.domain'};
2593: $coursenumbuf{$env{'request.course.id'}}=
2594: $env{'course.'.$env{'request.course.id'}.'.num'};
2595: $coursehombuf{$env{'request.course.id'}}=
2596: $env{'course.'.$env{'request.course.id'}.'.home'};
2597: $coursedescrbuf{$env{'request.course.id'}}=
2598: $env{'course.'.$env{'request.course.id'}.'.description'};
2599: $courseinstcodebuf{$env{'request.course.id'}}=
2600: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2601: $courseownerbuf{$env{'request.course.id'}}=
2602: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 2603: $coursetypebuf{$env{'request.course.id'}}=
2604: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 2605: if (defined $courselogs{$env{'request.course.id'}}) {
2606: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 2607: } else {
1.620 albertel 2608: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 2609: }
1.620 albertel 2610: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 2611: &flushcourselogs();
2612: }
1.158 www 2613: }
2614:
2615: sub courseacclog {
2616: my $fnsymb=shift;
1.620 albertel 2617: unless ($env{'request.course.id'}) { return ''; }
2618: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 2619: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 2620: $what.=':POST';
1.583 matthew 2621: # FIXME: Probably ought to escape things....
1.800 albertel 2622: foreach my $key (keys(%env)) {
2623: if ($key=~/^form\.(.*)/) {
1.975 raeburn 2624: my $formitem = $1;
2625: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2626: $what.=':'.$formitem.'='.$env{$key};
2627: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2628: $what.=':'.$formitem.'='.$env{$key};
2629: }
1.158 www 2630: }
1.191 harris41 2631: }
1.583 matthew 2632: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2633: # FIXME: We should not be depending on a form parameter that someone
2634: # editing lonsearchcat.pm might change in the future.
1.620 albertel 2635: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 2636: $what.= ':POST';
2637: # FIXME: Probably ought to escape things....
2638: foreach my $element ('courseexp','crsfulltext','crsrelated',
2639: 'crsdiscuss') {
1.620 albertel 2640: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 2641: }
2642: }
1.158 www 2643: }
2644: &courselog($what);
1.149 www 2645: }
2646:
1.185 www 2647: sub countacc {
2648: my $url=&declutter(shift);
1.458 matthew 2649: return if (! defined($url) || $url eq '');
1.620 albertel 2650: unless ($env{'request.course.id'}) { return ''; }
2651: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 2652: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 2653: $accesshash{$key}++;
1.185 www 2654: }
1.349 www 2655:
1.361 www 2656: sub linklog {
2657: my ($from,$to)=@_;
2658: $from=&declutter($from);
2659: $to=&declutter($to);
2660: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2661: $accesshash{$to.'___'.$from.'___goto'}=1;
2662: }
2663:
1.349 www 2664: sub userrolelog {
2665: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 2666: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 2667: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 2668: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2669: ($trole=~/^ta/)) {
1.350 www 2670: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2671: $userrolehash
2672: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 2673: =$tend.':'.$tstart;
1.662 raeburn 2674: }
1.898 albertel 2675: if (($env{'request.role'} =~ /dc\./) &&
2676: (($trole=~/^au/) || ($trole=~/^in/) ||
2677: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2678: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2679: $userrolehash
2680: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2681: =$tend.':'.$tstart;
2682: }
1.662 raeburn 2683: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2684: ($trole=~/^li/) || ($trole=~/^li/) ||
2685: ($trole=~/^au/) || ($trole=~/^dg/) ||
2686: ($trole=~/^sc/)) {
2687: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2688: $domainrolehash
2689: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2690: = $tend.':'.$tstart;
2691: }
1.351 www 2692: }
2693:
1.957 raeburn 2694: sub courserolelog {
2695: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2696: if (($trole eq 'cc') || ($trole eq 'in') ||
2697: ($trole eq 'ep') || ($trole eq 'ad') ||
2698: ($trole eq 'ta') || ($trole eq 'st') ||
2699: ($trole=~/^cr/) || ($trole eq 'gr')) {
2700: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2701: my $cdom = $1;
2702: my $cnum = $2;
2703: my $sec = $3;
2704: my $namespace = 'rolelog';
2705: my %storehash = (
2706: role => $trole,
2707: start => $tstart,
2708: end => $tend,
2709: selfenroll => $selfenroll,
2710: context => $context,
2711: );
2712: if ($trole eq 'gr') {
2713: $namespace = 'groupslog';
2714: $storehash{'group'} = $sec;
2715: } else {
2716: $storehash{'section'} = $sec;
2717: }
2718: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
1.996 raeburn 2719: if (($trole ne 'st') || ($sec ne '')) {
2720: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2721: }
1.957 raeburn 2722: }
2723: }
2724: return;
2725: }
2726:
1.351 www 2727: sub get_course_adv_roles {
1.948 raeburn 2728: my ($cid,$codes) = @_;
1.620 albertel 2729: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 2730: my %coursehash=&coursedescription($cid);
1.988 raeburn 2731: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 2732: my %nothide=();
1.800 albertel 2733: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 2734: if ($user !~ /:/) {
2735: $nothide{join(':',split(/[\@]/,$user))}=1;
2736: } else {
2737: $nothide{$user}=1;
2738: }
1.470 www 2739: }
1.351 www 2740: my %returnhash=();
2741: my %dumphash=
2742: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2743: my $now=time;
1.997 raeburn 2744: my %privileged;
1.1000 raeburn 2745: foreach my $entry (keys(%dumphash)) {
1.800 albertel 2746: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 2747: if (($tstart) && ($tstart<0)) { next; }
2748: if (($tend) && ($tend<$now)) { next; }
2749: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 2750: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 2751: if ($username eq '' || $domain eq '') { next; }
1.997 raeburn 2752: unless (ref($privileged{$domain}) eq 'HASH') {
2753: my %dompersonnel =
1.998 raeburn 2754: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997 raeburn 2755: $privileged{$domain} = {};
2756: foreach my $server (keys(%dompersonnel)) {
1.999 raeburn 2757: if (ref($dompersonnel{$server}) eq 'HASH') {
1.997 raeburn 2758: foreach my $user (keys(%{$dompersonnel{$server}})) {
2759: my ($trole,$uname,$udom) = split(/:/,$user);
2760: $privileged{$udom}{$uname} = 1;
2761: }
2762: }
2763: }
2764: }
2765: if ((exists($privileged{$domain}{$username})) &&
2766: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 2767: if ($role eq 'cr') { next; }
1.948 raeburn 2768: if ($codes) {
2769: if ($section) { $role .= ':'.$section; }
2770: if ($returnhash{$role}) {
2771: $returnhash{$role}.=','.$username.':'.$domain;
2772: } else {
2773: $returnhash{$role}=$username.':'.$domain;
2774: }
1.351 www 2775: } else {
1.988 raeburn 2776: my $key=&plaintext($role,$crstype);
1.973 bisitz 2777: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 2778: if ($returnhash{$key}) {
2779: $returnhash{$key}.=','.$username.':'.$domain;
2780: } else {
2781: $returnhash{$key}=$username.':'.$domain;
2782: }
1.351 www 2783: }
1.948 raeburn 2784: }
1.400 www 2785: return %returnhash;
2786: }
2787:
2788: sub get_my_roles {
1.937 raeburn 2789: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 2790: unless (defined($uname)) { $uname=$env{'user.name'}; }
2791: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 2792: my (%dumphash,%nothide);
1.858 raeburn 2793: if ($context eq 'userroles') {
2794: %dumphash = &dump('roles',$udom,$uname);
2795: } else {
2796: %dumphash=
1.400 www 2797: &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 2798: if ($hidepriv) {
2799: my %coursehash=&coursedescription($udom.'_'.$uname);
2800: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2801: if ($user !~ /:/) {
2802: $nothide{join(':',split(/[\@]/,$user))} = 1;
2803: } else {
2804: $nothide{$user} = 1;
2805: }
2806: }
2807: }
1.858 raeburn 2808: }
1.400 www 2809: my %returnhash=();
2810: my $now=time;
1.999 raeburn 2811: my %privileged;
1.800 albertel 2812: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 2813: my ($role,$tend,$tstart);
2814: if ($context eq 'userroles') {
2815: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2816: } else {
2817: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2818: }
1.400 www 2819: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 2820: my $status = 'active';
1.939 raeburn 2821: if (($tend) && ($tend<=$now)) {
1.832 raeburn 2822: $status = 'previous';
2823: }
2824: if (($tstart) && ($now<$tstart)) {
2825: $status = 'future';
2826: }
2827: if (ref($types) eq 'ARRAY') {
2828: if (!grep(/^\Q$status\E$/,@{$types})) {
2829: next;
2830: }
2831: } else {
2832: if ($status ne 'active') {
2833: next;
2834: }
2835: }
1.867 raeburn 2836: my ($rolecode,$username,$domain,$section,$area);
2837: if ($context eq 'userroles') {
2838: ($area,$rolecode) = split(/_/,$entry);
2839: (undef,$domain,$username,$section) = split(/\//,$area);
2840: } else {
2841: ($role,$username,$domain,$section) = split(/\:/,$entry);
2842: }
1.832 raeburn 2843: if (ref($roledoms) eq 'ARRAY') {
2844: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2845: next;
2846: }
2847: }
2848: if (ref($roles) eq 'ARRAY') {
2849: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 2850: if ($role =~ /^cr\//) {
2851: if (!grep(/^cr$/,@{$roles})) {
2852: next;
2853: }
2854: } else {
2855: next;
2856: }
1.832 raeburn 2857: }
1.867 raeburn 2858: }
1.937 raeburn 2859: if ($hidepriv) {
1.999 raeburn 2860: if ($context eq 'userroles') {
2861: if ((&privileged($username,$domain)) &&
2862: (!$nothide{$username.':'.$domain})) {
2863: next;
2864: }
2865: } else {
2866: unless (ref($privileged{$domain}) eq 'HASH') {
2867: my %dompersonnel =
2868: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2869: $privileged{$domain} = {};
2870: if (keys(%dompersonnel)) {
2871: foreach my $server (keys(%dompersonnel)) {
2872: if (ref($dompersonnel{$server}) eq 'HASH') {
2873: foreach my $user (keys(%{$dompersonnel{$server}})) {
2874: my ($trole,$uname,$udom) = split(/:/,$user);
2875: $privileged{$udom}{$uname} = $trole;
2876: }
2877: }
2878: }
2879: }
2880: }
2881: if (exists($privileged{$domain}{$username})) {
2882: if (!$nothide{$username.':'.$domain}) {
2883: next;
2884: }
2885: }
1.937 raeburn 2886: }
2887: }
1.933 raeburn 2888: if ($withsec) {
2889: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2890: $tstart.':'.$tend;
2891: } else {
2892: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2893: }
1.832 raeburn 2894: }
1.373 www 2895: return %returnhash;
1.399 www 2896: }
2897:
2898: # ----------------------------------------------------- Frontpage Announcements
2899: #
2900: #
2901:
2902: sub postannounce {
2903: my ($server,$text)=@_;
1.844 albertel 2904: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 2905: unless ($text=~/\w/) { $text=''; }
2906: return &reply('setannounce:'.&escape($text),$server);
2907: }
2908:
2909: sub getannounce {
1.448 albertel 2910:
2911: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 2912: my $announcement='';
1.800 albertel 2913: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 2914: close($fh);
1.399 www 2915: if ($announcement=~/\w/) {
2916: return
2917: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 2918: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 2919: } else {
2920: return '';
2921: }
2922: } else {
2923: return '';
2924: }
1.351 www 2925: }
1.353 www 2926:
2927: # ---------------------------------------------------------- Course ID routines
2928: # Deal with domain's nohist_courseid.db files
2929: #
2930:
2931: sub courseidput {
1.921 raeburn 2932: my ($domain,$storehash,$coursehome,$caller) = @_;
2933: my $outcome;
2934: if ($caller eq 'timeonly') {
2935: my $cids = '';
2936: foreach my $item (keys(%$storehash)) {
2937: $cids.=&escape($item).'&';
2938: }
2939: $cids=~s/\&$//;
2940: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
2941: $coursehome);
2942: } else {
2943: my $items = '';
2944: foreach my $item (keys(%$storehash)) {
2945: $items.= &escape($item).'='.
2946: &freeze_escape($$storehash{$item}).'&';
2947: }
2948: $items=~s/\&$//;
2949: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
2950: $coursehome);
1.918 raeburn 2951: }
2952: if ($outcome eq 'unknown_cmd') {
2953: my $what;
2954: foreach my $cid (keys(%$storehash)) {
2955: $what .= &escape($cid).'=';
1.921 raeburn 2956: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 2957: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 2958: }
2959: $what =~ s/\:$/&/;
2960: }
2961: $what =~ s/\&$//;
2962: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2963: } else {
2964: return $outcome;
2965: }
1.353 www 2966: }
2967:
2968: sub courseiddump {
1.921 raeburn 2969: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 2970: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.962 raeburn 2971: $selfenrollonly,$catfilter,$showhidden,$caller)=@_;
1.918 raeburn 2972: my $as_hash = 1;
2973: my %returnhash;
2974: if (!$domfilter) { $domfilter=''; }
1.845 albertel 2975: my %libserv = &all_library();
2976: foreach my $tryserver (keys(%libserv)) {
2977: if ( ( $hostidflag == 1
2978: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2979: || (!defined($hostidflag)) ) {
2980:
1.918 raeburn 2981: if (($domfilter eq '') ||
2982: (&host_domain($tryserver) eq $domfilter)) {
2983: my $rep =
2984: &reply('courseiddump:'.&host_domain($tryserver).':'.
2985: $sincefilter.':'.&escape($descfilter).':'.
2986: &escape($instcodefilter).':'.&escape($ownerfilter).
2987: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 2988: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 2989: &escape($selfenrollonly).':'.&escape($catfilter).':'.
2990: $showhidden.':'.$caller,$tryserver);
1.918 raeburn 2991: my @pairs=split(/\&/,$rep);
2992: foreach my $item (@pairs) {
2993: my ($key,$value)=split(/\=/,$item,2);
2994: $key = &unescape($key);
2995: next if ($key =~ /^error: 2 /);
2996: my $result = &thaw_unescape($value);
2997: if (ref($result) eq 'HASH') {
2998: $returnhash{$key}=$result;
2999: } else {
1.921 raeburn 3000: my @responses = split(/:/,$value);
3001: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3002: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3003: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3004: }
3005: }
1.353 www 3006: }
3007: }
3008: }
3009: }
3010: return %returnhash;
3011: }
3012:
1.658 raeburn 3013: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3014:
3015: sub dcmailput {
1.685 raeburn 3016: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3017: my $status = &Apache::lonnet::critical(
1.740 www 3018: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3019: &escape($message),$server);
1.662 raeburn 3020: return $status;
3021: }
3022:
1.658 raeburn 3023: sub dcmaildump {
3024: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3025: my %returnhash=();
1.846 albertel 3026:
3027: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3028: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3029: &escape($enddate).':';
3030: my @esc_senders=map { &escape($_)} @$senders;
3031: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3032: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3033: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3034: if (($key) && ($value)) {
3035: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3036: }
3037: }
3038: }
3039: return %returnhash;
3040: }
1.662 raeburn 3041: # ---------------------------------------------------------- Domain roles
3042:
3043: sub get_domain_roles {
3044: my ($dom,$roles,$startdate,$enddate)=@_;
3045: if (undef($startdate) || $startdate eq '') {
3046: $startdate = '.';
3047: }
3048: if (undef($enddate) || $enddate eq '') {
3049: $enddate = '.';
3050: }
1.922 raeburn 3051: my $rolelist;
3052: if (ref($roles) eq 'ARRAY') {
3053: $rolelist = join(':',@{$roles});
3054: }
1.662 raeburn 3055: my %personnel = ();
1.841 albertel 3056:
3057: my %servers = &get_servers($dom,'library');
3058: foreach my $tryserver (keys(%servers)) {
3059: %{$personnel{$tryserver}}=();
3060: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3061: &escape($startdate).':'.
3062: &escape($enddate).':'.
3063: &escape($rolelist), $tryserver))) {
3064: my ($key,$value) = split(/\=/,$line,2);
3065: if (($key) && ($value)) {
3066: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3067: }
3068: }
1.662 raeburn 3069: }
3070: return %personnel;
3071: }
1.658 raeburn 3072:
1.149 www 3073: # ----------------------------------------------------------- Check out an item
3074:
1.504 albertel 3075: sub get_first_access {
3076: my ($type,$argsymb)=@_;
1.790 albertel 3077: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3078: if ($argsymb) { $symb=$argsymb; }
3079: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3080: if ($type eq 'course') {
3081: $res='course';
3082: } elsif ($type eq 'map') {
1.588 albertel 3083: $res=&symbread($map);
3084: } else {
3085: $res=$symb;
3086: }
3087: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3088: return $times{"$courseid\0$res"};
1.504 albertel 3089: }
3090:
3091: sub set_first_access {
3092: my ($type)=@_;
1.790 albertel 3093: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3094: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3095: if ($type eq 'course') {
3096: $res='course';
3097: } elsif ($type eq 'map') {
1.588 albertel 3098: $res=&symbread($map);
3099: } else {
3100: $res=$symb;
3101: }
3102: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3103: if (!$firstaccess) {
1.588 albertel 3104: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3105: }
3106: return 'already_set';
1.504 albertel 3107: }
3108:
1.149 www 3109: sub checkout {
3110: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3111: my $now=time;
3112: my $lonhost=$perlvar{'lonHostID'};
3113: my $infostr=&escape(
1.234 www 3114: 'CHECKOUTTOKEN&'.
1.149 www 3115: $tuname.'&'.
3116: $tudom.'&'.
3117: $tcrsid.'&'.
3118: $symb.'&'.
3119: $now.'&'.$ENV{'REMOTE_ADDR'});
3120: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 3121: if ($token=~/^error\:/) {
1.672 albertel 3122: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3123: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3124: "</font>");
3125: return '';
3126: }
3127:
1.149 www 3128: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3129: $token=~tr/a-z/A-Z/;
3130:
1.153 www 3131: my %infohash=('resource.0.outtoken' => $token,
3132: 'resource.0.checkouttime' => $now,
3133: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 3134:
3135: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3136: return '';
1.151 www 3137: } else {
1.672 albertel 3138: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3139: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3140: "</font>");
1.149 www 3141: }
3142:
3143: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3144: &escape('Checkout '.$infostr.' - '.
3145: $token)) ne 'ok') {
3146: return '';
1.151 www 3147: } else {
1.672 albertel 3148: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3149: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3150: "</font>");
1.149 www 3151: }
1.151 www 3152: return $token;
1.149 www 3153: }
3154:
3155: # ------------------------------------------------------------ Check in an item
3156:
3157: sub checkin {
3158: my $token=shift;
1.150 www 3159: my $now=time;
3160: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3161: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 3162: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 3163: $dtoken=~s/\W/\_/g;
1.234 www 3164: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 3165: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3166:
1.154 www 3167: unless (($tuname) && ($tudom)) {
3168: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3169: return '';
3170: }
3171:
3172: unless (&allowed('mgr',$tcrsid)) {
3173: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 3174: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 3175: return '';
3176: }
3177:
1.153 www 3178: my %infohash=('resource.0.intoken' => $token,
3179: 'resource.0.checkintime' => $now,
3180: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 3181:
3182: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3183: return '';
3184: }
3185:
3186: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3187: &escape('Checkin - '.$token)) ne 'ok') {
3188: return '';
3189: }
3190:
3191: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 3192: }
3193:
3194: # --------------------------------------------- Set Expire Date for Spreadsheet
3195:
3196: sub expirespread {
3197: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3198: my $cid=$env{'request.course.id'};
1.110 www 3199: if ($cid) {
3200: my $now=time;
3201: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3202: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3203: $env{'course.'.$cid.'.num'}.
1.110 www 3204: ':nohist_expirationdates:'.
3205: &escape($key).'='.$now,
1.620 albertel 3206: $env{'course.'.$cid.'.home'})
1.110 www 3207: }
3208: return 'ok';
1.14 www 3209: }
3210:
1.109 www 3211: # ----------------------------------------------------- Devalidate Spreadsheets
3212:
3213: sub devalidate {
1.325 www 3214: my ($symb,$uname,$udom)=@_;
1.620 albertel 3215: my $cid=$env{'request.course.id'};
1.109 www 3216: if ($cid) {
1.391 matthew 3217: # delete the stored spreadsheets for
3218: # - the student level sheet of this user in course's homespace
3219: # - the assessment level sheet for this resource
3220: # for this user in user's homespace
1.553 albertel 3221: # - current conditional state info
1.325 www 3222: my $key=$uname.':'.$udom.':';
1.109 www 3223: my $status=
1.299 matthew 3224: &del('nohist_calculatedsheets',
1.391 matthew 3225: [$key.'studentcalc:'],
1.620 albertel 3226: $env{'course.'.$cid.'.domain'},
3227: $env{'course.'.$cid.'.num'})
1.133 albertel 3228: .' '.
3229: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3230: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3231: unless ($status eq 'ok ok') {
3232: &logthis('Could not devalidate spreadsheet '.
1.325 www 3233: $uname.' at '.$udom.' for '.
1.109 www 3234: $symb.': '.$status);
1.133 albertel 3235: }
1.553 albertel 3236: &delenv('user.state.'.$cid);
1.109 www 3237: }
3238: }
3239:
1.265 albertel 3240: sub get_scalar {
3241: my ($string,$end) = @_;
3242: my $value;
3243: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3244: $value = $1;
3245: } elsif ($$string =~ s/^([^&]*?)&//) {
3246: $value = $1;
3247: }
3248: return &unescape($value);
3249: }
3250:
3251: sub array2str {
3252: my (@array) = @_;
3253: my $result=&arrayref2str(\@array);
3254: $result=~s/^__ARRAY_REF__//;
3255: $result=~s/__END_ARRAY_REF__$//;
3256: return $result;
3257: }
3258:
1.204 albertel 3259: sub arrayref2str {
3260: my ($arrayref) = @_;
1.265 albertel 3261: my $result='__ARRAY_REF__';
1.204 albertel 3262: foreach my $elem (@$arrayref) {
1.265 albertel 3263: if(ref($elem) eq 'ARRAY') {
3264: $result.=&arrayref2str($elem).'&';
3265: } elsif(ref($elem) eq 'HASH') {
3266: $result.=&hashref2str($elem).'&';
3267: } elsif(ref($elem)) {
3268: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3269: } else {
3270: $result.=&escape($elem).'&';
3271: }
3272: }
3273: $result=~s/\&$//;
1.265 albertel 3274: $result .= '__END_ARRAY_REF__';
1.204 albertel 3275: return $result;
3276: }
3277:
1.168 albertel 3278: sub hash2str {
1.204 albertel 3279: my (%hash) = @_;
3280: my $result=&hashref2str(\%hash);
1.265 albertel 3281: $result=~s/^__HASH_REF__//;
3282: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3283: return $result;
3284: }
3285:
3286: sub hashref2str {
3287: my ($hashref)=@_;
1.265 albertel 3288: my $result='__HASH_REF__';
1.800 albertel 3289: foreach my $key (sort(keys(%$hashref))) {
3290: if (ref($key) eq 'ARRAY') {
3291: $result.=&arrayref2str($key).'=';
3292: } elsif (ref($key) eq 'HASH') {
3293: $result.=&hashref2str($key).'=';
3294: } elsif (ref($key)) {
1.265 albertel 3295: $result.='=';
1.800 albertel 3296: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3297: } else {
1.800 albertel 3298: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3299: }
3300:
1.800 albertel 3301: if(ref($hashref->{$key}) eq 'ARRAY') {
3302: $result.=&arrayref2str($hashref->{$key}).'&';
3303: } elsif(ref($hashref->{$key}) eq 'HASH') {
3304: $result.=&hashref2str($hashref->{$key}).'&';
3305: } elsif(ref($hashref->{$key})) {
1.265 albertel 3306: $result.='&';
1.800 albertel 3307: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3308: } else {
1.800 albertel 3309: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3310: }
3311: }
1.168 albertel 3312: $result=~s/\&$//;
1.265 albertel 3313: $result .= '__END_HASH_REF__';
1.168 albertel 3314: return $result;
3315: }
3316:
3317: sub str2hash {
1.265 albertel 3318: my ($string)=@_;
3319: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3320: return %$hash;
3321: }
3322:
3323: sub str2hashref {
1.168 albertel 3324: my ($string) = @_;
1.265 albertel 3325:
3326: my %hash;
3327:
3328: if($string !~ /^__HASH_REF__/) {
3329: if (! ($string eq '' || !defined($string))) {
3330: $hash{'error'}='Not hash reference';
3331: }
3332: return (\%hash, $string);
3333: }
3334:
3335: $string =~ s/^__HASH_REF__//;
3336:
3337: while($string !~ /^__END_HASH_REF__/) {
3338: #key
3339: my $key='';
3340: if($string =~ /^__HASH_REF__/) {
3341: ($key, $string)=&str2hashref($string);
3342: if(defined($key->{'error'})) {
3343: $hash{'error'}='Bad data';
3344: return (\%hash, $string);
3345: }
3346: } elsif($string =~ /^__ARRAY_REF__/) {
3347: ($key, $string)=&str2arrayref($string);
3348: if($key->[0] eq 'Array reference error') {
3349: $hash{'error'}='Bad data';
3350: return (\%hash, $string);
3351: }
3352: } else {
3353: $string =~ s/^(.*?)=//;
1.267 albertel 3354: $key=&unescape($1);
1.265 albertel 3355: }
3356: $string =~ s/^=//;
3357:
3358: #value
3359: my $value='';
3360: if($string =~ /^__HASH_REF__/) {
3361: ($value, $string)=&str2hashref($string);
3362: if(defined($value->{'error'})) {
3363: $hash{'error'}='Bad data';
3364: return (\%hash, $string);
3365: }
3366: } elsif($string =~ /^__ARRAY_REF__/) {
3367: ($value, $string)=&str2arrayref($string);
3368: if($value->[0] eq 'Array reference error') {
3369: $hash{'error'}='Bad data';
3370: return (\%hash, $string);
3371: }
3372: } else {
3373: $value=&get_scalar(\$string,'__END_HASH_REF__');
3374: }
3375: $string =~ s/^&//;
3376:
3377: $hash{$key}=$value;
1.204 albertel 3378: }
1.265 albertel 3379:
3380: $string =~ s/^__END_HASH_REF__//;
3381:
3382: return (\%hash, $string);
1.204 albertel 3383: }
3384:
3385: sub str2array {
1.265 albertel 3386: my ($string)=@_;
3387: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3388: return @$array;
3389: }
3390:
3391: sub str2arrayref {
1.204 albertel 3392: my ($string) = @_;
1.265 albertel 3393: my @array;
3394:
3395: if($string !~ /^__ARRAY_REF__/) {
3396: if (! ($string eq '' || !defined($string))) {
3397: $array[0]='Array reference error';
3398: }
3399: return (\@array, $string);
3400: }
3401:
3402: $string =~ s/^__ARRAY_REF__//;
3403:
3404: while($string !~ /^__END_ARRAY_REF__/) {
3405: my $value='';
3406: if($string =~ /^__HASH_REF__/) {
3407: ($value, $string)=&str2hashref($string);
3408: if(defined($value->{'error'})) {
3409: $array[0] ='Array reference error';
3410: return (\@array, $string);
3411: }
3412: } elsif($string =~ /^__ARRAY_REF__/) {
3413: ($value, $string)=&str2arrayref($string);
3414: if($value->[0] eq 'Array reference error') {
3415: $array[0] ='Array reference error';
3416: return (\@array, $string);
3417: }
3418: } else {
3419: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3420: }
3421: $string =~ s/^&//;
3422:
3423: push(@array, $value);
1.191 harris41 3424: }
1.265 albertel 3425:
3426: $string =~ s/^__END_ARRAY_REF__//;
3427:
3428: return (\@array, $string);
1.168 albertel 3429: }
3430:
1.167 albertel 3431: # -------------------------------------------------------------------Temp Store
3432:
1.168 albertel 3433: sub tmpreset {
3434: my ($symb,$namespace,$domain,$stuname) = @_;
3435: if (!$symb) {
3436: $symb=&symbread();
1.620 albertel 3437: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3438: }
3439: $symb=escape($symb);
3440:
1.620 albertel 3441: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3442: $namespace=~s/\//\_/g;
3443: $namespace=~s/\W//g;
3444:
1.620 albertel 3445: if (!$domain) { $domain=$env{'user.domain'}; }
3446: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3447: if ($domain eq 'public' && $stuname eq 'public') {
3448: $stuname=$ENV{'REMOTE_ADDR'};
3449: }
1.168 albertel 3450: my $path=$perlvar{'lonDaemons'}.'/tmp';
3451: my %hash;
3452: if (tie(%hash,'GDBM_File',
3453: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3454: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3455: foreach my $key (keys(%hash)) {
1.180 albertel 3456: if ($key=~ /:$symb/) {
1.168 albertel 3457: delete($hash{$key});
3458: }
3459: }
3460: }
3461: }
3462:
1.167 albertel 3463: sub tmpstore {
1.168 albertel 3464: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3465:
3466: if (!$symb) {
3467: $symb=&symbread();
1.620 albertel 3468: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3469: }
3470: $symb=escape($symb);
3471:
3472: if (!$namespace) {
3473: # I don't think we would ever want to store this for a course.
3474: # it seems this will only be used if we don't have a course.
1.620 albertel 3475: #$namespace=$env{'request.course.id'};
1.168 albertel 3476: #if (!$namespace) {
1.620 albertel 3477: $namespace=$env{'request.state'};
1.168 albertel 3478: #}
3479: }
3480: $namespace=~s/\//\_/g;
3481: $namespace=~s/\W//g;
1.620 albertel 3482: if (!$domain) { $domain=$env{'user.domain'}; }
3483: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3484: if ($domain eq 'public' && $stuname eq 'public') {
3485: $stuname=$ENV{'REMOTE_ADDR'};
3486: }
1.168 albertel 3487: my $now=time;
3488: my %hash;
3489: my $path=$perlvar{'lonDaemons'}.'/tmp';
3490: if (tie(%hash,'GDBM_File',
3491: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3492: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3493: $hash{"version:$symb"}++;
3494: my $version=$hash{"version:$symb"};
3495: my $allkeys='';
3496: foreach my $key (keys(%$storehash)) {
3497: $allkeys.=$key.':';
1.591 albertel 3498: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3499: }
3500: $hash{"$version:$symb:timestamp"}=$now;
3501: $allkeys.='timestamp';
3502: $hash{"$version:keys:$symb"}=$allkeys;
3503: if (untie(%hash)) {
3504: return 'ok';
3505: } else {
3506: return "error:$!";
3507: }
3508: } else {
3509: return "error:$!";
3510: }
3511: }
1.167 albertel 3512:
1.168 albertel 3513: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3514:
1.168 albertel 3515: sub tmprestore {
3516: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3517:
1.168 albertel 3518: if (!$symb) {
3519: $symb=&symbread();
1.620 albertel 3520: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3521: }
3522: $symb=escape($symb);
3523:
1.620 albertel 3524: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3525:
1.620 albertel 3526: if (!$domain) { $domain=$env{'user.domain'}; }
3527: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3528: if ($domain eq 'public' && $stuname eq 'public') {
3529: $stuname=$ENV{'REMOTE_ADDR'};
3530: }
1.168 albertel 3531: my %returnhash;
3532: $namespace=~s/\//\_/g;
3533: $namespace=~s/\W//g;
3534: my %hash;
3535: my $path=$perlvar{'lonDaemons'}.'/tmp';
3536: if (tie(%hash,'GDBM_File',
3537: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3538: &GDBM_READER(),0640)) {
1.168 albertel 3539: my $version=$hash{"version:$symb"};
3540: $returnhash{'version'}=$version;
3541: my $scope;
3542: for ($scope=1;$scope<=$version;$scope++) {
3543: my $vkeys=$hash{"$scope:keys:$symb"};
3544: my @keys=split(/:/,$vkeys);
3545: my $key;
3546: $returnhash{"$scope:keys"}=$vkeys;
3547: foreach $key (@keys) {
1.591 albertel 3548: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3549: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3550: }
3551: }
1.168 albertel 3552: if (!(untie(%hash))) {
3553: return "error:$!";
3554: }
3555: } else {
3556: return "error:$!";
3557: }
3558: return %returnhash;
1.167 albertel 3559: }
3560:
1.9 www 3561: # ----------------------------------------------------------------------- Store
3562:
3563: sub store {
1.124 www 3564: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3565: my $home='';
3566:
1.168 albertel 3567: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3568:
1.213 www 3569: $symb=&symbclean($symb);
1.122 albertel 3570: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3571:
1.620 albertel 3572: if (!$domain) { $domain=$env{'user.domain'}; }
3573: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3574:
3575: &devalidate($symb,$stuname,$domain);
1.109 www 3576:
3577: $symb=escape($symb);
1.187 www 3578: if (!$namespace) {
1.620 albertel 3579: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3580: return '';
3581: }
3582: }
1.620 albertel 3583: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3584:
3585: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3586: $$storehash{'host'}=$perlvar{'lonHostID'};
3587:
1.12 www 3588: my $namevalue='';
1.800 albertel 3589: foreach my $key (keys(%$storehash)) {
3590: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3591: }
1.12 www 3592: $namevalue=~s/\&$//;
1.187 www 3593: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3594: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3595: }
3596:
1.47 www 3597: # -------------------------------------------------------------- Critical Store
3598:
3599: sub cstore {
1.124 www 3600: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3601: my $home='';
3602:
1.168 albertel 3603: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3604:
1.213 www 3605: $symb=&symbclean($symb);
1.122 albertel 3606: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3607:
1.620 albertel 3608: if (!$domain) { $domain=$env{'user.domain'}; }
3609: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3610:
3611: &devalidate($symb,$stuname,$domain);
1.109 www 3612:
3613: $symb=escape($symb);
1.187 www 3614: if (!$namespace) {
1.620 albertel 3615: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3616: return '';
3617: }
3618: }
1.620 albertel 3619: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3620:
3621: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3622: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3623:
1.47 www 3624: my $namevalue='';
1.800 albertel 3625: foreach my $key (keys(%$storehash)) {
3626: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3627: }
1.47 www 3628: $namevalue=~s/\&$//;
1.187 www 3629: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3630: return critical
3631: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3632: }
3633:
1.9 www 3634: # --------------------------------------------------------------------- Restore
3635:
3636: sub restore {
1.124 www 3637: my ($symb,$namespace,$domain,$stuname) = @_;
3638: my $home='';
3639:
1.168 albertel 3640: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3641:
1.122 albertel 3642: if (!$symb) {
3643: unless ($symb=escape(&symbread())) { return ''; }
3644: } else {
1.213 www 3645: $symb=&escape(&symbclean($symb));
1.122 albertel 3646: }
1.188 www 3647: if (!$namespace) {
1.620 albertel 3648: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3649: return '';
3650: }
3651: }
1.620 albertel 3652: if (!$domain) { $domain=$env{'user.domain'}; }
3653: if (!$stuname) { $stuname=$env{'user.name'}; }
3654: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3655: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3656:
1.12 www 3657: my %returnhash=();
1.800 albertel 3658: foreach my $line (split(/\&/,$answer)) {
3659: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3660: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3661: }
1.75 www 3662: my $version;
3663: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3664: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3665: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3666: }
1.75 www 3667: }
1.13 www 3668: return %returnhash;
1.34 www 3669: }
3670:
3671: # ---------------------------------------------------------- Course Description
3672:
3673: sub coursedescription {
1.731 albertel 3674: my ($courseid,$args)=@_;
1.34 www 3675: $courseid=~s/^\///;
1.49 www 3676: $courseid=~s/\_/\//g;
1.34 www 3677: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3678: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3679: my $normalid=$cdomain.'_'.$cnum;
3680: # need to always cache even if we get errors otherwise we keep
3681: # trying and trying and trying to get the course description.
3682: my %envhash=();
3683: my %returnhash=();
1.731 albertel 3684:
3685: my $expiretime=600;
3686: if ($env{'request.course.id'} eq $normalid) {
3687: $expiretime=120;
3688: }
3689:
3690: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3691: if (!$args->{'freshen_cache'}
3692: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3693: foreach my $key (keys(%env)) {
3694: next if ($key !~ /^\Q$prefix\E(.*)/);
3695: my ($setting) = $1;
3696: $returnhash{$setting} = $env{$key};
3697: }
3698: return %returnhash;
3699: }
3700:
3701: # get the data agin
3702: if (!$args->{'one_time'}) {
3703: $envhash{'course.'.$normalid.'.last_cache'}=time;
3704: }
1.811 albertel 3705:
1.34 www 3706: if ($chome ne 'no_host') {
1.302 albertel 3707: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3708: if (!exists($returnhash{'con_lost'})) {
3709: $returnhash{'home'}= $chome;
3710: $returnhash{'domain'} = $cdomain;
3711: $returnhash{'num'} = $cnum;
1.741 raeburn 3712: if (!defined($returnhash{'type'})) {
3713: $returnhash{'type'} = 'Course';
3714: }
1.130 albertel 3715: while (my ($name,$value) = each %returnhash) {
1.53 www 3716: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3717: }
1.270 www 3718: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3719: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3720: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3721: $envhash{'course.'.$normalid.'.home'}=$chome;
3722: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3723: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3724: }
3725: }
1.731 albertel 3726: if (!$args->{'one_time'}) {
1.949 raeburn 3727: &appenv(\%envhash);
1.731 albertel 3728: }
1.302 albertel 3729: return %returnhash;
1.461 www 3730: }
3731:
3732: # -------------------------------------------------See if a user is privileged
3733:
3734: sub privileged {
3735: my ($username,$domain)=@_;
3736: my $rolesdump=&reply("dump:$domain:$username:roles",
3737: &homeserver($username,$domain));
3738: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3739: my $now=time;
3740: if ($rolesdump ne '') {
1.800 albertel 3741: foreach my $entry (split(/&/,$rolesdump)) {
3742: if ($entry!~/^rolesdef_/) {
3743: my ($area,$role)=split(/=/,$entry);
1.461 www 3744: $area=~s/\_\w\w$//;
3745: my ($trole,$tend,$tstart)=split(/_/,$role);
3746: if (($trole eq 'dc') || ($trole eq 'su')) {
3747: my $active=1;
3748: if ($tend) {
3749: if ($tend<$now) { $active=0; }
3750: }
3751: if ($tstart) {
3752: if ($tstart>$now) { $active=0; }
3753: }
3754: if ($active) { return 1; }
3755: }
3756: }
3757: }
3758: }
3759: return 0;
1.9 www 3760: }
1.1 albertel 3761:
1.103 harris41 3762: # -------------------------------------------------------- Get user privileges
1.11 www 3763:
3764: sub rolesinit {
3765: my ($domain,$username,$authhost)=@_;
1.966 raeburn 3766: my %userroles;
1.11 www 3767: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.966 raeburn 3768: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return \%userroles; }
1.11 www 3769: my %allroles=();
1.678 raeburn 3770: my %allgroups=();
1.11 www 3771: my $now=time;
1.966 raeburn 3772: %userroles = ('user.login.time' => $now);
1.678 raeburn 3773: my $group_privs;
1.11 www 3774:
3775: if ($rolesdump ne '') {
1.800 albertel 3776: foreach my $entry (split(/&/,$rolesdump)) {
3777: if ($entry!~/^rolesdef_/) {
3778: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3779: $area=~s/\_\w\w$//;
1.678 raeburn 3780: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3781: if ($role=~/^cr/) {
1.807 albertel 3782: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3783: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3784: ($tend,$tstart)=split('_',$trest);
3785: } else {
3786: $trole=$role;
3787: }
1.678 raeburn 3788: } elsif ($role =~ m|^gr/|) {
3789: ($trole,$tend,$tstart) = split(/_/,$role);
3790: ($trole,$group_privs) = split(/\//,$trole);
3791: $group_privs = &unescape($group_privs);
1.587 albertel 3792: } else {
3793: ($trole,$tend,$tstart)=split(/_/,$role);
3794: }
1.743 albertel 3795: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3796: $username);
3797: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3798: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3799: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3800: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3801: my $spec=$trole.'.'.$area;
3802: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3803: if ($trole =~ /^cr\//) {
1.567 raeburn 3804: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3805: } elsif ($trole eq 'gr') {
3806: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3807: } else {
1.567 raeburn 3808: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3809: }
1.12 www 3810: }
1.662 raeburn 3811: }
1.191 harris41 3812: }
1.743 albertel 3813: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3814: $userroles{'user.adv'} = $adv;
3815: $userroles{'user.author'} = $author;
1.620 albertel 3816: $env{'user.adv'}=$adv;
1.11 www 3817: }
1.743 albertel 3818: return \%userroles;
1.11 www 3819: }
3820:
1.567 raeburn 3821: sub set_arearole {
3822: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3823: # log the associated role with the area
3824: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3825: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3826: }
3827:
3828: sub custom_roleprivs {
3829: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3830: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3831: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3832: if (&hostname($homsvr) ne '') {
1.567 raeburn 3833: my ($rdummy,$roledef)=
3834: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3835: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3836: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3837: if (defined($syspriv)) {
3838: $$allroles{'cm./'}.=':'.$syspriv;
3839: $$allroles{$spec.'./'}.=':'.$syspriv;
3840: }
3841: if ($tdomain ne '') {
3842: if (defined($dompriv)) {
3843: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3844: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3845: }
3846: if (($trest ne '') && (defined($coursepriv))) {
3847: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3848: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3849: }
3850: }
3851: }
3852: }
3853: }
3854:
1.678 raeburn 3855: sub group_roleprivs {
3856: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3857: my $access = 1;
3858: my $now = time;
3859: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3860: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3861: if ($access) {
1.811 albertel 3862: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 3863: $$allgroups{$course}{$group} .=':'.$group_privs;
3864: }
3865: }
1.567 raeburn 3866:
3867: sub standard_roleprivs {
3868: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3869: if (defined($pr{$trole.':s'})) {
3870: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3871: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3872: }
3873: if ($tdomain ne '') {
3874: if (defined($pr{$trole.':d'})) {
3875: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3876: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3877: }
3878: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3879: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3880: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3881: }
3882: }
3883: }
3884:
3885: sub set_userprivs {
1.678 raeburn 3886: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 3887: my $author=0;
3888: my $adv=0;
1.678 raeburn 3889: my %grouproles = ();
3890: if (keys(%{$allgroups}) > 0) {
1.1000 raeburn 3891: foreach my $role (keys(%{$allroles})) {
1.681 raeburn 3892: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 3893: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 3894: $trole = $1;
3895: $area = $2;
1.681 raeburn 3896: $sec = $3;
3897: $extendedarea = $area.$sec;
3898: if (exists($$allgroups{$area})) {
3899: foreach my $group (keys(%{$$allgroups{$area}})) {
3900: my $spec = $trole.'.'.$extendedarea;
3901: $grouproles{$spec.'.'.$area.'/'.$group} =
3902: $$allgroups{$area}{$group};
1.678 raeburn 3903: }
3904: }
3905: }
3906: }
3907: }
1.800 albertel 3908: foreach my $group (keys(%grouproles)) {
3909: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 3910: }
1.800 albertel 3911: foreach my $role (keys(%{$allroles})) {
3912: my %thesepriv;
1.941 raeburn 3913: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 3914: foreach my $item (split(/:/,$$allroles{$role})) {
3915: if ($item ne '') {
3916: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 3917: if ($restrictions eq '') {
3918: $thesepriv{$privilege}='F';
3919: } elsif ($thesepriv{$privilege} ne 'F') {
3920: $thesepriv{$privilege}.=$restrictions;
3921: }
3922: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3923: }
3924: }
3925: my $thesestr='';
1.800 albertel 3926: foreach my $priv (keys(%thesepriv)) {
3927: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3928: }
3929: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 3930: }
3931: return ($author,$adv);
3932: }
3933:
1.994 raeburn 3934: sub role_status {
1.1002 raeburn 3935: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 3936: my @pwhere = ();
3937: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
3938: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
3939: unless (!defined($$role) || $$role eq '') {
3940: $$where=join('.',@pwhere);
3941: $$trolecode=$$role.'.'.$$where;
3942: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
3943: $$tstatus='is';
3944: if ($$tstart && $$tstart>$then) {
3945: $$tstatus='future';
1.1002 raeburn 3946: if ($$tstart && $$tstart>$refresh) {
3947: if ($$tstart<$now) {
3948: if (($$where ne '') && ($$role ne '')) {
3949: my (%allroles,%allgroups,$group_privs);
3950: my %userroles = (
3951: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
3952: );
3953: my $spec=$$role.'.'.$$where;
3954: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
3955: if ($$role eq 'gr') {
3956: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
3957: $env{'user.name'})=@_;
3958: my ($trole) = split('_',$role,1);
3959: (undef,my $group_privs) = split(/\//,$trole);
3960: $group_privs = &unescape($group_privs);
3961: }
3962: if ($$role =~ /^cr\//) {
3963: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
3964: } elsif ($$role eq 'gr') {
3965: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
3966: $env{'user.name'});
3967: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
3968: (undef,my $group_privs) = split(/\//,$trole);
3969: $group_privs = &unescape($group_privs);
3970: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
3971: } else {
3972: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
3973: }
3974: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
3975: &appenv(\%userroles,[$$role,'cm']);
3976: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
3977: $$tstatus = 'is';
3978: }
3979: }
3980: }
1.994 raeburn 3981: }
3982: if ($$tend) {
3983: if ($$tend<$then) {
3984: $$tstatus='expired';
3985: } elsif ($$tend<$now) {
3986: $$tstatus='will_not';
3987: }
3988: }
3989: }
3990: }
3991: }
3992:
3993: sub check_adhoc_privs {
1.1002 raeburn 3994: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 3995: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
3996: if ($env{$cckey}) {
3997: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 3998: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 3999: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4000: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4001: }
4002: } else {
4003: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4004: }
4005: }
4006:
4007: sub set_adhoc_privileges {
4008: # role can be cc or ca
4009: my ($dcdom,$pickedcourse,$role) = @_;
4010: my $area = '/'.$dcdom.'/'.$pickedcourse;
4011: my $spec = $role.'.'.$area;
4012: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4013: $env{'user.name'});
4014: my %ccrole = ();
4015: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4016: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4017: &appenv(\%userroles,[$role,'cm']);
4018: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4019: &appenv( {'request.role' => $spec,
4020: 'request.role.domain' => $dcdom,
4021: 'request.course.sec' => ''
4022: }
4023: );
4024: my $tadv=0;
4025: if (&allowed('adv') eq 'F') { $tadv=1; }
4026: &appenv({'request.role.adv' => $tadv});
4027: }
4028:
1.12 www 4029: # --------------------------------------------------------------- get interface
4030:
4031: sub get {
1.131 albertel 4032: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4033: my $items='';
1.800 albertel 4034: foreach my $item (@$storearr) {
4035: $items.=&escape($item).'&';
1.191 harris41 4036: }
1.12 www 4037: $items=~s/\&$//;
1.620 albertel 4038: if (!$udomain) { $udomain=$env{'user.domain'}; }
4039: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4040: my $uhome=&homeserver($uname,$udomain);
4041:
1.133 albertel 4042: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4043: my @pairs=split(/\&/,$rep);
1.273 albertel 4044: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4045: return @pairs;
4046: }
1.15 www 4047: my %returnhash=();
1.42 www 4048: my $i=0;
1.800 albertel 4049: foreach my $item (@$storearr) {
4050: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4051: $i++;
1.191 harris41 4052: }
1.15 www 4053: return %returnhash;
1.27 www 4054: }
4055:
4056: # --------------------------------------------------------------- del interface
4057:
4058: sub del {
1.133 albertel 4059: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4060: my $items='';
1.800 albertel 4061: foreach my $item (@$storearr) {
4062: $items.=&escape($item).'&';
1.191 harris41 4063: }
1.984 neumanie 4064:
1.27 www 4065: $items=~s/\&$//;
1.620 albertel 4066: if (!$udomain) { $udomain=$env{'user.domain'}; }
4067: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4068: my $uhome=&homeserver($uname,$udomain);
4069: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4070: }
4071:
4072: # -------------------------------------------------------------- dump interface
4073:
4074: sub dump {
1.755 albertel 4075: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4076: if (!$udomain) { $udomain=$env{'user.domain'}; }
4077: if (!$uname) { $uname=$env{'user.name'}; }
4078: my $uhome=&homeserver($uname,$udomain);
4079: if ($regexp) {
4080: $regexp=&escape($regexp);
4081: } else {
4082: $regexp='.';
4083: }
4084: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4085: my @pairs=split(/\&/,$rep);
4086: my %returnhash=();
4087: foreach my $item (@pairs) {
4088: my ($key,$value)=split(/=/,$item,2);
4089: $key = &unescape($key);
4090: next if ($key =~ /^error: 2 /);
4091: $returnhash{$key}=&thaw_unescape($value);
4092: }
4093: return %returnhash;
1.407 www 4094: }
4095:
1.717 albertel 4096: # --------------------------------------------------------- dumpstore interface
4097:
4098: sub dumpstore {
4099: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 4100: if (!$udomain) { $udomain=$env{'user.domain'}; }
4101: if (!$uname) { $uname=$env{'user.name'}; }
4102: my $uhome=&homeserver($uname,$udomain);
4103: if ($regexp) {
4104: $regexp=&escape($regexp);
4105: } else {
4106: $regexp='.';
4107: }
4108: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4109: my @pairs=split(/\&/,$rep);
4110: my %returnhash=();
4111: foreach my $item (@pairs) {
4112: my ($key,$value)=split(/=/,$item,2);
4113: next if ($key =~ /^error: 2 /);
4114: $returnhash{$key}=&thaw_unescape($value);
4115: }
4116: return %returnhash;
1.717 albertel 4117: }
4118:
1.407 www 4119: # -------------------------------------------------------------- keys interface
4120:
4121: sub getkeys {
4122: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4123: if (!$udomain) { $udomain=$env{'user.domain'}; }
4124: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4125: my $uhome=&homeserver($uname,$udomain);
4126: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4127: my @keyarray=();
1.800 albertel 4128: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4129: next if ($key =~ /^error: 2 /);
1.800 albertel 4130: push(@keyarray,&unescape($key));
1.407 www 4131: }
4132: return @keyarray;
1.318 matthew 4133: }
4134:
1.319 matthew 4135: # --------------------------------------------------------------- currentdump
4136: sub currentdump {
1.328 matthew 4137: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4138: $courseid = $env{'request.course.id'} if (! defined($courseid));
4139: $sdom = $env{'user.domain'} if (! defined($sdom));
4140: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4141: my $uhome = &homeserver($sname,$sdom);
4142: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4143: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4144: #
1.318 matthew 4145: my %returnhash=();
1.319 matthew 4146: #
4147: if ($rep eq "unknown_cmd") {
4148: # an old lond will not know currentdump
4149: # Do a dump and make it look like a currentdump
1.822 albertel 4150: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4151: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4152: my %hash = @tmp;
4153: @tmp=();
1.424 matthew 4154: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4155: } else {
4156: my @pairs=split(/\&/,$rep);
1.800 albertel 4157: foreach my $pair (@pairs) {
4158: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4159: my ($symb,$param) = split(/:/,$key);
4160: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4161: &thaw_unescape($value);
1.319 matthew 4162: }
1.191 harris41 4163: }
1.12 www 4164: return %returnhash;
1.424 matthew 4165: }
4166:
4167: sub convert_dump_to_currentdump{
4168: my %hash = %{shift()};
4169: my %returnhash;
4170: # Code ripped from lond, essentially. The only difference
4171: # here is the unescaping done by lonnet::dump(). Conceivably
4172: # we might run in to problems with parameter names =~ /^v\./
4173: while (my ($key,$value) = each(%hash)) {
4174: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4175: $symb = &unescape($symb);
4176: $param = &unescape($param);
1.424 matthew 4177: next if ($v eq 'version' || $symb eq 'keys');
4178: next if (exists($returnhash{$symb}) &&
4179: exists($returnhash{$symb}->{$param}) &&
4180: $returnhash{$symb}->{'v.'.$param} > $v);
4181: $returnhash{$symb}->{$param}=$value;
4182: $returnhash{$symb}->{'v.'.$param}=$v;
4183: }
4184: #
4185: # Remove all of the keys in the hashes which keep track of
4186: # the version of the parameter.
4187: while (my ($symb,$param_hash) = each(%returnhash)) {
4188: # use a foreach because we are going to delete from the hash.
4189: foreach my $key (keys(%$param_hash)) {
4190: delete($param_hash->{$key}) if ($key =~ /^v\./);
4191: }
4192: }
4193: return \%returnhash;
1.12 www 4194: }
4195:
1.627 albertel 4196: # ------------------------------------------------------ critical inc interface
4197:
4198: sub cinc {
4199: return &inc(@_,'critical');
4200: }
4201:
1.449 matthew 4202: # --------------------------------------------------------------- inc interface
4203:
4204: sub inc {
1.627 albertel 4205: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4206: if (!$udomain) { $udomain=$env{'user.domain'}; }
4207: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4208: my $uhome=&homeserver($uname,$udomain);
4209: my $items='';
4210: if (! ref($store)) {
4211: # got a single value, so use that instead
4212: $items = &escape($store).'=&';
4213: } elsif (ref($store) eq 'SCALAR') {
4214: $items = &escape($$store).'=&';
4215: } elsif (ref($store) eq 'ARRAY') {
4216: $items = join('=&',map {&escape($_);} @{$store});
4217: } elsif (ref($store) eq 'HASH') {
4218: while (my($key,$value) = each(%{$store})) {
4219: $items.= &escape($key).'='.&escape($value).'&';
4220: }
4221: }
4222: $items=~s/\&$//;
1.627 albertel 4223: if ($critical) {
4224: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4225: } else {
4226: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4227: }
1.449 matthew 4228: }
4229:
1.12 www 4230: # --------------------------------------------------------------- put interface
4231:
4232: sub put {
1.134 albertel 4233: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4234: if (!$udomain) { $udomain=$env{'user.domain'}; }
4235: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4236: my $uhome=&homeserver($uname,$udomain);
1.12 www 4237: my $items='';
1.800 albertel 4238: foreach my $item (keys(%$storehash)) {
4239: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4240: }
1.12 www 4241: $items=~s/\&$//;
1.134 albertel 4242: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4243: }
4244:
1.631 albertel 4245: # ------------------------------------------------------------ newput interface
4246:
4247: sub newput {
4248: my ($namespace,$storehash,$udomain,$uname)=@_;
4249: if (!$udomain) { $udomain=$env{'user.domain'}; }
4250: if (!$uname) { $uname=$env{'user.name'}; }
4251: my $uhome=&homeserver($uname,$udomain);
4252: my $items='';
4253: foreach my $key (keys(%$storehash)) {
4254: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4255: }
4256: $items=~s/\&$//;
4257: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4258: }
4259:
4260: # --------------------------------------------------------- putstore interface
4261:
1.524 raeburn 4262: sub putstore {
1.715 albertel 4263: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4264: if (!$udomain) { $udomain=$env{'user.domain'}; }
4265: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4266: my $uhome=&homeserver($uname,$udomain);
4267: my $items='';
1.715 albertel 4268: foreach my $key (keys(%$storehash)) {
4269: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4270: }
1.715 albertel 4271: $items=~s/\&$//;
1.716 albertel 4272: my $esc_symb=&escape($symb);
4273: my $esc_v=&escape($version);
1.715 albertel 4274: my $reply =
1.716 albertel 4275: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4276: $uhome);
4277: if ($reply eq 'unknown_cmd') {
1.716 albertel 4278: # gfall back to way things use to be done
1.715 albertel 4279: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4280: $uname);
1.524 raeburn 4281: }
1.715 albertel 4282: return $reply;
4283: }
4284:
4285: sub old_putstore {
1.716 albertel 4286: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4287: if (!$udomain) { $udomain=$env{'user.domain'}; }
4288: if (!$uname) { $uname=$env{'user.name'}; }
4289: my $uhome=&homeserver($uname,$udomain);
4290: my %newstorehash;
1.800 albertel 4291: foreach my $item (keys(%$storehash)) {
4292: my $key = $version.':'.&escape($symb).':'.$item;
4293: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4294: }
4295: my $items='';
4296: my %allitems = ();
1.800 albertel 4297: foreach my $item (keys(%newstorehash)) {
4298: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4299: my $key = $1.':keys:'.$2;
4300: $allitems{$key} .= $3.':';
4301: }
1.800 albertel 4302: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4303: }
1.800 albertel 4304: foreach my $item (keys(%allitems)) {
4305: $allitems{$item} =~ s/\:$//;
4306: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4307: }
4308: $items=~s/\&$//;
4309: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4310: }
4311:
1.47 www 4312: # ------------------------------------------------------ critical put interface
4313:
4314: sub cput {
1.134 albertel 4315: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4316: if (!$udomain) { $udomain=$env{'user.domain'}; }
4317: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4318: my $uhome=&homeserver($uname,$udomain);
1.47 www 4319: my $items='';
1.800 albertel 4320: foreach my $item (keys(%$storehash)) {
4321: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4322: }
1.47 www 4323: $items=~s/\&$//;
1.134 albertel 4324: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4325: }
4326:
4327: # -------------------------------------------------------------- eget interface
4328:
4329: sub eget {
1.133 albertel 4330: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4331: my $items='';
1.800 albertel 4332: foreach my $item (@$storearr) {
4333: $items.=&escape($item).'&';
1.191 harris41 4334: }
1.12 www 4335: $items=~s/\&$//;
1.620 albertel 4336: if (!$udomain) { $udomain=$env{'user.domain'}; }
4337: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4338: my $uhome=&homeserver($uname,$udomain);
4339: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4340: my @pairs=split(/\&/,$rep);
4341: my %returnhash=();
1.42 www 4342: my $i=0;
1.800 albertel 4343: foreach my $item (@$storearr) {
4344: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4345: $i++;
1.191 harris41 4346: }
1.12 www 4347: return %returnhash;
4348: }
4349:
1.667 albertel 4350: # ------------------------------------------------------------ tmpput interface
4351: sub tmpput {
1.802 raeburn 4352: my ($storehash,$server,$context)=@_;
1.667 albertel 4353: my $items='';
1.800 albertel 4354: foreach my $item (keys(%$storehash)) {
4355: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4356: }
4357: $items=~s/\&$//;
1.802 raeburn 4358: if (defined($context)) {
4359: $items .= ':'.&escape($context);
4360: }
1.667 albertel 4361: return &reply("tmpput:$items",$server);
4362: }
4363:
4364: # ------------------------------------------------------------ tmpget interface
4365: sub tmpget {
1.688 albertel 4366: my ($token,$server)=@_;
4367: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4368: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4369: my %returnhash;
4370: foreach my $item (split(/\&/,$rep)) {
4371: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4372: next if ($key =~ /^error: 2 /);
1.667 albertel 4373: $returnhash{&unescape($key)}=&thaw_unescape($value);
4374: }
4375: return %returnhash;
4376: }
4377:
1.688 albertel 4378: # ------------------------------------------------------------ tmpget interface
4379: sub tmpdel {
4380: my ($token,$server)=@_;
4381: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4382: return &reply("tmpdel:$token",$server);
4383: }
4384:
1.765 albertel 4385: # -------------------------------------------------- portfolio access checking
4386:
4387: sub portfolio_access {
1.766 albertel 4388: my ($requrl) = @_;
1.765 albertel 4389: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4390: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4391: if ($result) {
4392: my %setters;
4393: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4394: my ($startblock,$endblock) =
4395: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4396: if ($startblock && $endblock) {
4397: return 'B';
4398: }
4399: } else {
4400: my ($startblock,$endblock) =
4401: &Apache::loncommon::blockcheck(\%setters,'port');
4402: if ($startblock && $endblock) {
4403: return 'B';
4404: }
4405: }
4406: }
1.765 albertel 4407: if ($result eq 'ok') {
1.766 albertel 4408: return 'F';
1.765 albertel 4409: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4410: return 'A';
1.765 albertel 4411: }
1.766 albertel 4412: return '';
1.765 albertel 4413: }
4414:
4415: sub get_portfolio_access {
1.767 albertel 4416: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4417:
4418: if (!ref($access_hash)) {
4419: my $current_perms = &get_portfile_permissions($udom,$unum);
4420: my %access_controls = &get_access_controls($current_perms,$group,
4421: $file_name);
4422: $access_hash = $access_controls{$file_name};
4423: }
4424:
1.765 albertel 4425: my ($public,$guest,@domains,@users,@courses,@groups);
4426: my $now = time;
4427: if (ref($access_hash) eq 'HASH') {
4428: foreach my $key (keys(%{$access_hash})) {
4429: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4430: if ($start > $now) {
4431: next;
4432: }
4433: if ($end && $end<$now) {
4434: next;
4435: }
4436: if ($scope eq 'public') {
4437: $public = $key;
4438: last;
4439: } elsif ($scope eq 'guest') {
4440: $guest = $key;
4441: } elsif ($scope eq 'domains') {
4442: push(@domains,$key);
4443: } elsif ($scope eq 'users') {
4444: push(@users,$key);
4445: } elsif ($scope eq 'course') {
4446: push(@courses,$key);
4447: } elsif ($scope eq 'group') {
4448: push(@groups,$key);
4449: }
4450: }
4451: if ($public) {
4452: return 'ok';
4453: }
4454: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4455: if ($guest) {
4456: return $guest;
4457: }
4458: } else {
4459: if (@domains > 0) {
4460: foreach my $domkey (@domains) {
4461: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4462: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4463: return 'ok';
4464: }
4465: }
4466: }
4467: }
4468: if (@users > 0) {
4469: foreach my $userkey (@users) {
1.865 raeburn 4470: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4471: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4472: if (ref($item) eq 'HASH') {
4473: if (($item->{'uname'} eq $env{'user.name'}) &&
4474: ($item->{'udom'} eq $env{'user.domain'})) {
4475: return 'ok';
4476: }
4477: }
4478: }
4479: }
1.765 albertel 4480: }
4481: }
4482: my %roleshash;
4483: my @courses_and_groups = @courses;
4484: push(@courses_and_groups,@groups);
4485: if (@courses_and_groups > 0) {
4486: my (%allgroups,%allroles);
4487: my ($start,$end,$role,$sec,$group);
4488: foreach my $envkey (%env) {
1.811 albertel 4489: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4490: my $cid = $2.'_'.$3;
4491: if ($1 eq 'gr') {
4492: $group = $4;
4493: $allgroups{$cid}{$group} = $env{$envkey};
4494: } else {
4495: if ($4 eq '') {
4496: $sec = 'none';
4497: } else {
4498: $sec = $4;
4499: }
4500: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4501: }
1.811 albertel 4502: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4503: my $cid = $2.'_'.$3;
4504: if ($4 eq '') {
4505: $sec = 'none';
4506: } else {
4507: $sec = $4;
4508: }
4509: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4510: }
4511: }
4512: if (keys(%allroles) == 0) {
4513: return;
4514: }
4515: foreach my $key (@courses_and_groups) {
4516: my %content = %{$$access_hash{$key}};
4517: my $cnum = $content{'number'};
4518: my $cdom = $content{'domain'};
4519: my $cid = $cdom.'_'.$cnum;
4520: if (!exists($allroles{$cid})) {
4521: next;
4522: }
4523: foreach my $role_id (keys(%{$content{'roles'}})) {
4524: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4525: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4526: my @status = @{$content{'roles'}{$role_id}{'access'}};
4527: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4528: foreach my $role (keys(%{$allroles{$cid}})) {
4529: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4530: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4531: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4532: if (grep/^all$/,@sections) {
4533: return 'ok';
4534: } else {
4535: if (grep/^$sec$/,@sections) {
4536: return 'ok';
4537: }
4538: }
4539: }
4540: }
4541: if (keys(%{$allgroups{$cid}}) == 0) {
4542: if (grep/^none$/,@groups) {
4543: return 'ok';
4544: }
4545: } else {
4546: if (grep/^all$/,@groups) {
4547: return 'ok';
4548: }
4549: foreach my $group (keys(%{$allgroups{$cid}})) {
4550: if (grep/^$group$/,@groups) {
4551: return 'ok';
4552: }
4553: }
4554: }
4555: }
4556: }
4557: }
4558: }
4559: }
4560: if ($guest) {
4561: return $guest;
4562: }
4563: }
4564: }
4565: return;
4566: }
4567:
4568: sub course_group_datechecker {
4569: my ($dates,$now,$status) = @_;
4570: my ($start,$end) = split(/\./,$dates);
4571: if (!$start && !$end) {
4572: return 'ok';
4573: }
4574: if (grep/^active$/,@{$status}) {
4575: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4576: return 'ok';
4577: }
4578: }
4579: if (grep/^previous$/,@{$status}) {
4580: if ($end > $now ) {
4581: return 'ok';
4582: }
4583: }
4584: if (grep/^future$/,@{$status}) {
4585: if ($start > $now) {
4586: return 'ok';
4587: }
4588: }
4589: return;
4590: }
4591:
4592: sub parse_portfolio_url {
4593: my ($url) = @_;
4594:
4595: my ($type,$udom,$unum,$group,$file_name);
4596:
1.823 albertel 4597: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4598: $type = 1;
4599: $udom = $1;
4600: $unum = $2;
4601: $file_name = $3;
1.823 albertel 4602: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4603: $type = 2;
4604: $udom = $1;
4605: $unum = $2;
4606: $group = $3;
4607: $file_name = $3.'/'.$4;
4608: }
4609: if (wantarray) {
4610: return ($type,$udom,$unum,$file_name,$group);
4611: }
4612: return $type;
4613: }
4614:
4615: sub is_portfolio_url {
4616: my ($url) = @_;
4617: return scalar(&parse_portfolio_url($url));
4618: }
4619:
1.798 raeburn 4620: sub is_portfolio_file {
4621: my ($file) = @_;
1.820 raeburn 4622: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4623: return 1;
4624: }
4625: return;
4626: }
4627:
1.976 raeburn 4628: sub usertools_access {
1.985 raeburn 4629: my ($uname,$udom,$tool,$action,$context) = @_;
4630: my ($access,%tools);
4631: if ($context eq '') {
4632: $context = 'tools';
4633: }
4634: if ($context eq 'requestcourses') {
4635: %tools = (
4636: official => 1,
4637: unofficial => 1,
4638: );
4639: } else {
4640: %tools = (
4641: aboutme => 1,
4642: blog => 1,
4643: portfolio => 1,
4644: );
4645: }
1.976 raeburn 4646: return if (!defined($tools{$tool}));
4647:
4648: if ((!defined($udom)) || (!defined($uname))) {
4649: $udom = $env{'user.domain'};
4650: $uname = $env{'user.name'};
4651: }
4652:
1.978 raeburn 4653: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4654: if ($action ne 'reload') {
1.985 raeburn 4655: if ($context eq 'requestcourses') {
4656: return $env{'environment.canrequest.'.$tool};
4657: } else {
4658: return $env{'environment.availabletools.'.$tool};
4659: }
4660: }
1.976 raeburn 4661: }
4662:
4663: my ($toolstatus,$inststatus);
4664:
1.985 raeburn 4665: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4666: ($action ne 'reload')) {
4667: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4668: $inststatus = $env{'environment.inststatus'};
4669: } else {
1.985 raeburn 4670: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool);
4671: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4672: $inststatus = $userenv{'inststatus'};
4673: }
4674:
4675: if ($toolstatus ne '') {
4676: if ($toolstatus) {
4677: $access = 1;
4678: } else {
4679: $access = 0;
4680: }
4681: return $access;
4682: }
4683:
4684: my $is_adv = &is_advanced_user($udom,$uname);
4685: my %domdef = &get_domain_defaults($udom);
4686: if (ref($domdef{$tool}) eq 'HASH') {
4687: if ($is_adv) {
4688: if ($domdef{$tool}{'_LC_adv'} ne '') {
4689: if ($domdef{$tool}{'_LC_adv'}) {
4690: $access = 1;
4691: } else {
4692: $access = 0;
4693: }
4694: return $access;
4695: }
4696: }
4697: if ($inststatus ne '') {
4698: my ($hasaccess,$hasnoaccess);
4699: foreach my $affiliation (split(/:/,$inststatus)) {
4700: if ($domdef{$tool}{$affiliation} ne '') {
4701: if ($domdef{$tool}{$affiliation}) {
4702: $hasaccess = 1;
4703: } else {
4704: $hasnoaccess = 1;
4705: }
4706: }
4707: }
4708: if ($hasaccess || $hasnoaccess) {
4709: if ($hasaccess) {
4710: $access = 1;
4711: } elsif ($hasnoaccess) {
4712: $access = 0;
4713: }
4714: return $access;
4715: }
4716: } else {
4717: if ($domdef{$tool}{'default'} ne '') {
4718: if ($domdef{$tool}{'default'}) {
4719: $access = 1;
4720: } elsif ($domdef{$tool}{'default'} == 0) {
4721: $access = 0;
4722: }
4723: return $access;
4724: }
4725: }
4726: } else {
1.985 raeburn 4727: if ($context eq 'tools') {
4728: $access = 1;
4729: } else {
4730: $access = 0;
4731: }
1.976 raeburn 4732: return $access;
4733: }
4734: }
4735:
4736: sub is_advanced_user {
4737: my ($udom,$uname) = @_;
4738: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4739: my %allroles;
4740: my $is_adv;
4741: foreach my $role (keys(%roleshash)) {
4742: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4743: my $area = '/'.$tdomain.'/'.$trest;
4744: if ($sec ne '') {
4745: $area .= '/'.$sec;
4746: }
4747: if (($area ne '') && ($trole ne '')) {
4748: my $spec=$trole.'.'.$area;
4749: if ($trole =~ /^cr\//) {
4750: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4751: } elsif ($trole ne 'gr') {
4752: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4753: }
4754: }
4755: }
4756: foreach my $role (keys(%allroles)) {
4757: last if ($is_adv);
4758: foreach my $item (split(/:/,$allroles{$role})) {
4759: if ($item ne '') {
4760: my ($privilege,$restrictions)=split(/&/,$item);
4761: if ($privilege eq 'adv') {
4762: $is_adv = 1;
4763: last;
4764: }
4765: }
4766: }
4767: }
4768: return $is_adv;
4769: }
1.798 raeburn 4770:
1.341 www 4771: # ---------------------------------------------- Custom access rule evaluation
4772:
4773: sub customaccess {
4774: my ($priv,$uri)=@_;
1.807 albertel 4775: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4776: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4777: $udom = &LONCAPA::clean_domain($udom);
4778: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4779: my $access=0;
1.800 albertel 4780: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4781: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4782: if ($type eq 'user') {
4783: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4784: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4785: if ($tdom) {
4786: if ($tdom ne $env{'user.domain'}) { next; }
4787: }
1.896 albertel 4788: if ($tuname) {
4789: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4790: }
4791: $access=($effect eq 'allow');
4792: last;
4793: }
4794: } else {
4795: if ($role) {
4796: if ($role ne $urole) { next; }
4797: }
4798: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4799: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4800: if ($tdom) {
4801: if ($tdom ne $udom) { next; }
4802: }
4803: if ($tcrs) {
4804: if ($tcrs ne $ucrs) { next; }
4805: }
4806: if ($tsec) {
4807: if ($tsec ne $usec) { next; }
4808: }
4809: $access=($effect eq 'allow');
4810: last;
4811: }
4812: if ($realm eq '' && $role eq '') {
4813: $access=($effect eq 'allow');
4814: }
1.402 bowersj2 4815: }
1.341 www 4816: }
4817: return $access;
4818: }
4819:
1.103 harris41 4820: # ------------------------------------------------- Check for a user privilege
1.12 www 4821:
4822: sub allowed {
1.810 raeburn 4823: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 4824: my $ver_orguri=$uri;
1.439 www 4825: $uri=&deversion($uri);
1.152 www 4826: my $orguri=$uri;
1.52 www 4827: $uri=&declutter($uri);
1.809 raeburn 4828:
1.810 raeburn 4829: if ($priv eq 'evb') {
4830: # Evade communication block restrictions for specified role in a course
4831: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4832: return $1;
4833: } else {
4834: return;
4835: }
4836: }
4837:
1.620 albertel 4838: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 4839: # Free bre access to adm and meta resources
1.775 albertel 4840: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 4841: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4842: && ($priv eq 'bre')) {
1.14 www 4843: return 'F';
1.159 www 4844: }
4845:
1.545 banghart 4846: # Free bre access to user's own portfolio contents
1.714 raeburn 4847: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 4848: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 4849: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 4850: my %setters;
4851: my ($startblock,$endblock) =
4852: &Apache::loncommon::blockcheck(\%setters,'port');
4853: if ($startblock && $endblock) {
4854: return 'B';
4855: } else {
4856: return 'F';
4857: }
1.545 banghart 4858: }
4859:
1.762 raeburn 4860: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 4861: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4862: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4863: if (exists($env{'request.course.id'})) {
4864: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4865: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4866: if (($domain eq $cdom) && ($name eq $cnum)) {
4867: my $courseprivid=$env{'request.course.id'};
4868: $courseprivid=~s/\_/\//;
4869: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4870: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4871: return $1;
1.762 raeburn 4872: } else {
4873: if ($env{'request.course.sec'}) {
4874: $courseprivid.='/'.$env{'request.course.sec'};
4875: }
4876: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4877: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
4878: return $2;
4879: }
1.714 raeburn 4880: }
4881: }
4882: }
4883: }
4884:
1.159 www 4885: # Free bre to public access
4886:
4887: if ($priv eq 'bre') {
1.238 www 4888: my $copyright=&metadata($uri,'copyright');
1.620 albertel 4889: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 4890: return 'F';
4891: }
1.238 www 4892: if ($copyright eq 'priv') {
4893: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 4894: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 4895: return '';
4896: }
4897: }
4898: if ($copyright eq 'domain') {
4899: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 4900: unless (($env{'user.domain'} eq $1) ||
4901: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 4902: return '';
4903: }
1.262 matthew 4904: }
1.620 albertel 4905: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 4906: # Library role, so allow browsing of resources in this domain.
4907: return 'F';
1.238 www 4908: }
1.341 www 4909: if ($copyright eq 'custom') {
4910: unless (&customaccess($priv,$uri)) { return ''; }
4911: }
1.14 www 4912: }
1.264 matthew 4913: # Domain coordinator is trying to create a course
1.620 albertel 4914: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 4915: # uri is the requested domain in this case.
4916: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 4917: # a role of dc for the domain in question.
1.620 albertel 4918: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 4919: }
1.29 www 4920:
1.52 www 4921: my $thisallowed='';
4922: my $statecond=0;
4923: my $courseprivid='';
4924:
4925: # Course
4926:
1.620 albertel 4927: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.52 www 4928: $thisallowed.=$1;
4929: }
1.29 www 4930:
1.52 www 4931: # Domain
4932:
1.620 albertel 4933: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 4934: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 4935: $thisallowed.=$1;
4936: }
1.52 www 4937:
4938: # Course: uri itself is a course
1.66 www 4939: my $courseuri=$uri;
4940: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 4941: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 4942:
1.620 albertel 4943: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 4944: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 4945: $thisallowed.=$1;
4946: }
1.29 www 4947:
1.665 albertel 4948: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 4949: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 4950: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 4951: $thisallowed='';
1.671 raeburn 4952: my ($match)=&is_on_map($uri);
4953: if ($match) {
4954: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4955: =~/\Q$priv\E\&([^\:]*)/) {
4956: $thisallowed.=$1;
4957: }
4958: } else {
1.705 albertel 4959: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 4960: if ($refuri) {
4961: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 4962: $thisallowed='F';
1.671 raeburn 4963: } else {
4964: $refuri=&declutter($refuri);
4965: my ($match) = &is_on_map($refuri);
4966: if ($match) {
4967: $thisallowed='F';
4968: }
1.669 raeburn 4969: }
1.671 raeburn 4970: }
4971: }
1.314 www 4972: }
1.492 albertel 4973:
1.766 albertel 4974: if ($priv eq 'bre'
4975: && $thisallowed ne 'F'
4976: && $thisallowed ne '2'
4977: && &is_portfolio_url($uri)) {
4978: $thisallowed = &portfolio_access($uri);
4979: }
4980:
1.52 www 4981: # Full access at system, domain or course-wide level? Exit.
1.29 www 4982: if ($thisallowed=~/F/) {
4983: return 'F';
4984: }
4985:
1.52 www 4986: # If this is generating or modifying users, exit with special codes
1.29 www 4987:
1.643 www 4988: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4989: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 4990: my ($audom,$auname)=split('/',$uri);
1.643 www 4991: # no author name given, so this just checks on the general right to make a co-author in this domain
4992: unless ($auname) { return $thisallowed; }
4993: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 4994: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4995: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4996: ($audom ne $env{'request.role.domain'}))) { return ''; }
4997: }
1.52 www 4998: return $thisallowed;
4999: }
5000: #
1.103 harris41 5001: # Gathered so far: system, domain and course wide privileges
1.52 www 5002: #
5003: # Course: See if uri or referer is an individual resource that is part of
5004: # the course
5005:
1.620 albertel 5006: if ($env{'request.course.id'}) {
1.232 www 5007:
1.620 albertel 5008: $courseprivid=$env{'request.course.id'};
5009: if ($env{'request.course.sec'}) {
5010: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5011: }
5012: $courseprivid=~s/\_/\//;
5013: my $checkreferer=1;
1.232 www 5014: my ($match,$cond)=&is_on_map($uri);
5015: if ($match) {
5016: $statecond=$cond;
1.620 albertel 5017: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5018: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5019: $thisallowed.=$1;
5020: $checkreferer=0;
5021: }
1.29 www 5022: }
1.83 www 5023:
1.148 www 5024: if ($checkreferer) {
1.620 albertel 5025: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5026: unless ($refuri) {
1.800 albertel 5027: foreach my $key (keys(%env)) {
5028: if ($key=~/^httpref\..*\*/) {
5029: my $pattern=$key;
1.156 www 5030: $pattern=~s/^httpref\.\/res\///;
1.148 www 5031: $pattern=~s/\*/\[\^\/\]\+/g;
5032: $pattern=~s/\//\\\//g;
1.152 www 5033: if ($orguri=~/$pattern/) {
1.800 albertel 5034: $refuri=$env{$key};
1.148 www 5035: }
5036: }
1.191 harris41 5037: }
1.148 www 5038: }
1.232 www 5039:
1.148 www 5040: if ($refuri) {
1.152 www 5041: $refuri=&declutter($refuri);
1.232 www 5042: my ($match,$cond)=&is_on_map($refuri);
5043: if ($match) {
5044: my $refstatecond=$cond;
1.620 albertel 5045: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5046: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5047: $thisallowed.=$1;
1.53 www 5048: $uri=$refuri;
5049: $statecond=$refstatecond;
1.52 www 5050: }
5051: }
1.148 www 5052: }
1.29 www 5053: }
1.52 www 5054: }
1.29 www 5055:
1.52 www 5056: #
1.103 harris41 5057: # Gathered now: all privileges that could apply, and condition number
1.52 www 5058: #
5059: #
5060: # Full or no access?
5061: #
1.29 www 5062:
1.52 www 5063: if ($thisallowed=~/F/) {
5064: return 'F';
5065: }
1.29 www 5066:
1.52 www 5067: unless ($thisallowed) {
5068: return '';
5069: }
1.29 www 5070:
1.52 www 5071: # Restrictions exist, deal with them
5072: #
5073: # C:according to course preferences
5074: # R:according to resource settings
5075: # L:unless locked
5076: # X:according to user session state
5077: #
5078:
5079: # Possibly locked functionality, check all courses
1.54 www 5080: # Locks might take effect only after 10 minutes cache expiration for other
5081: # courses, and 2 minutes for current course
1.52 www 5082:
5083: my $envkey;
5084: if ($thisallowed=~/L/) {
1.1000 raeburn 5085: foreach $envkey (keys(%env)) {
1.54 www 5086: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5087: my $courseid=$2;
5088: my $roleid=$1.'.'.$2;
1.92 www 5089: $courseid=~s/^\///;
1.54 www 5090: my $expiretime=600;
1.620 albertel 5091: if ($env{'request.role'} eq $roleid) {
1.54 www 5092: $expiretime=120;
5093: }
5094: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5095: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5096: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5097: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5098: }
1.620 albertel 5099: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5100: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5101: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5102: &log($env{'user.domain'},$env{'user.name'},
5103: $env{'user.home'},
1.57 www 5104: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5105: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5106: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5107: return '';
5108: }
5109: }
1.620 albertel 5110: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5111: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5112: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5113: &log($env{'user.domain'},$env{'user.name'},
5114: $env{'user.home'},
1.57 www 5115: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5116: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5117: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5118: return '';
5119: }
5120: }
5121: }
1.29 www 5122: }
1.52 www 5123: }
5124:
5125: #
5126: # Rest of the restrictions depend on selected course
5127: #
5128:
1.620 albertel 5129: unless ($env{'request.course.id'}) {
1.766 albertel 5130: if ($thisallowed eq 'A') {
5131: return 'A';
1.814 raeburn 5132: } elsif ($thisallowed eq 'B') {
5133: return 'B';
1.766 albertel 5134: } else {
5135: return '1';
5136: }
1.52 www 5137: }
1.29 www 5138:
1.52 www 5139: #
5140: # Now user is definitely in a course
5141: #
1.53 www 5142:
5143:
5144: # Course preferences
5145:
5146: if ($thisallowed=~/C/) {
1.620 albertel 5147: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5148: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5149: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5150: =~/\Q$rolecode\E/) {
1.689 albertel 5151: if ($priv ne 'pch') {
5152: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5153: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5154: $env{'request.course.id'});
5155: }
1.237 www 5156: return '';
5157: }
5158:
1.620 albertel 5159: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5160: =~/\Q$unamedom\E/) {
1.689 albertel 5161: if ($priv ne 'pch') {
5162: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5163: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5164: $env{'request.course.id'});
5165: }
1.54 www 5166: return '';
5167: }
1.53 www 5168: }
5169:
5170: # Resource preferences
5171:
5172: if ($thisallowed=~/R/) {
1.620 albertel 5173: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5174: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5175: if ($priv ne 'pch') {
5176: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5177: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5178: }
5179: return '';
1.54 www 5180: }
1.53 www 5181: }
1.30 www 5182:
1.246 www 5183: # Restricted by state or randomout?
1.30 www 5184:
1.52 www 5185: if ($thisallowed=~/X/) {
1.620 albertel 5186: if ($env{'acc.randomout'}) {
1.579 albertel 5187: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5188: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5189: return '';
5190: }
1.247 www 5191: }
5192: if (&condval($statecond)) {
1.52 www 5193: return '2';
5194: } else {
5195: return '';
5196: }
5197: }
1.30 www 5198:
1.766 albertel 5199: if ($thisallowed eq 'A') {
5200: return 'A';
1.814 raeburn 5201: } elsif ($thisallowed eq 'B') {
5202: return 'B';
1.766 albertel 5203: }
1.52 www 5204: return 'F';
1.232 www 5205: }
5206:
1.710 albertel 5207: sub split_uri_for_cond {
5208: my $uri=&deversion(&declutter(shift));
5209: my @uriparts=split(/\//,$uri);
5210: my $filename=pop(@uriparts);
5211: my $pathname=join('/',@uriparts);
5212: return ($pathname,$filename);
5213: }
1.232 www 5214: # --------------------------------------------------- Is a resource on the map?
5215:
5216: sub is_on_map {
1.710 albertel 5217: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5218: #Trying to find the conditional for the file
1.620 albertel 5219: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5220: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5221: if ($match) {
1.289 bowersj2 5222: return (1,$1);
5223: } else {
1.434 www 5224: return (0,0);
1.289 bowersj2 5225: }
1.12 www 5226: }
5227:
1.427 www 5228: # --------------------------------------------------------- Get symb from alias
5229:
5230: sub get_symb_from_alias {
5231: my $symb=shift;
5232: my ($map,$resid,$url)=&decode_symb($symb);
5233: # Already is a symb
5234: if ($url) { return $symb; }
5235: # Must be an alias
5236: my $aliassymb='';
5237: my %bighash;
1.620 albertel 5238: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5239: &GDBM_READER(),0640)) {
5240: my $rid=$bighash{'mapalias_'.$symb};
5241: if ($rid) {
5242: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5243: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5244: $resid,$bighash{'src_'.$rid});
1.427 www 5245: }
5246: untie %bighash;
5247: }
5248: return $aliassymb;
5249: }
5250:
1.12 www 5251: # ----------------------------------------------------------------- Define Role
5252:
5253: sub definerole {
5254: if (allowed('mcr','/')) {
5255: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5256: foreach my $role (split(':',$sysrole)) {
5257: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5258: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5259: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5260: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5261: return "refused:s:$crole&$cqual";
5262: }
5263: }
1.191 harris41 5264: }
1.800 albertel 5265: foreach my $role (split(':',$domrole)) {
5266: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5267: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5268: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5269: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5270: return "refused:d:$crole&$cqual";
5271: }
5272: }
1.191 harris41 5273: }
1.800 albertel 5274: foreach my $role (split(':',$courole)) {
5275: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5276: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5277: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5278: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5279: return "refused:c:$crole&$cqual";
5280: }
5281: }
1.191 harris41 5282: }
1.620 albertel 5283: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5284: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5285: "rolesdef_$rolename=".
5286: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5287: return reply($command,$env{'user.home'});
1.12 www 5288: } else {
5289: return 'refused';
5290: }
1.105 harris41 5291: }
5292:
5293: # ---------------- Make a metadata query against the network of library servers
5294:
5295: sub metadata_query {
1.244 matthew 5296: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5297: my %rhash;
1.845 albertel 5298: my %libserv = &all_library();
1.244 matthew 5299: my @server_list = (defined($server_array) ? @$server_array
5300: : keys(%libserv) );
5301: for my $server (@server_list) {
1.118 harris41 5302: unless ($custom or $customshow) {
5303: my $reply=&reply("querysend:".&escape($query),$server);
5304: $rhash{$server}=$reply;
5305: }
5306: else {
5307: my $reply=&reply("querysend:".&escape($query).':'.
5308: &escape($custom).':'.&escape($customshow),
5309: $server);
5310: $rhash{$server}=$reply;
5311: }
1.112 harris41 5312: }
1.118 harris41 5313: return \%rhash;
1.240 www 5314: }
5315:
5316: # ----------------------------------------- Send log queries and wait for reply
5317:
5318: sub log_query {
5319: my ($uname,$udom,$query,%filters)=@_;
5320: my $uhome=&homeserver($uname,$udom);
5321: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5322: my $uhost=&hostname($uhome);
1.800 albertel 5323: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5324: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5325: $uhome);
1.479 albertel 5326: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5327: return get_query_reply($queryid);
5328: }
5329:
1.818 raeburn 5330: # -------------------------- Update MySQL table for portfolio file
5331:
5332: sub update_portfolio_table {
1.821 raeburn 5333: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5334: if ($group ne '') {
5335: $file_name =~s /^\Q$group\E//;
5336: }
1.818 raeburn 5337: my $homeserver = &homeserver($uname,$udom);
5338: my $queryid=
1.821 raeburn 5339: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5340: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5341: my $reply = &get_query_reply($queryid);
5342: return $reply;
5343: }
5344:
1.899 raeburn 5345: # -------------------------- Update MySQL allusers table
5346:
5347: sub update_allusers_table {
5348: my ($uname,$udom,$names) = @_;
5349: my $homeserver = &homeserver($uname,$udom);
5350: my $queryid=
5351: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5352: 'lastname='.&escape($names->{'lastname'}).'%%'.
5353: 'firstname='.&escape($names->{'firstname'}).'%%'.
5354: 'middlename='.&escape($names->{'middlename'}).'%%'.
5355: 'generation='.&escape($names->{'generation'}).'%%'.
5356: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5357: 'id='.&escape($names->{'id'}),$homeserver);
5358: my $reply = &get_query_reply($queryid);
5359: return $reply;
5360: }
5361:
1.508 raeburn 5362: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5363:
5364: sub fetch_enrollment_query {
1.511 raeburn 5365: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5366: my $homeserver;
1.547 raeburn 5367: my $maxtries = 1;
1.508 raeburn 5368: if ($context eq 'automated') {
5369: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5370: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5371: } else {
5372: $homeserver = &homeserver($cnum,$dom);
5373: }
1.838 albertel 5374: my $host=&hostname($homeserver);
1.506 raeburn 5375: my $cmd = '';
1.1000 raeburn 5376: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5377: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5378: }
5379: $cmd =~ s/%%$//;
5380: $cmd = &escape($cmd);
5381: my $query = 'fetchenrollment';
1.620 albertel 5382: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5383: unless ($queryid=~/^\Q$host\E\_/) {
5384: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5385: return 'error: '.$queryid;
5386: }
1.506 raeburn 5387: my $reply = &get_query_reply($queryid);
1.547 raeburn 5388: my $tries = 1;
5389: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5390: $reply = &get_query_reply($queryid);
5391: $tries ++;
5392: }
1.526 raeburn 5393: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5394: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5395: } else {
1.901 albertel 5396: my @responses = split(/:/,$reply);
1.515 raeburn 5397: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5398: foreach my $line (@responses) {
5399: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5400: $$replyref{$key} = $value;
5401: }
5402: } else {
1.506 raeburn 5403: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5404: foreach my $line (@responses) {
5405: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5406: $$replyref{$key} = $value;
5407: if ($value > 0) {
1.800 albertel 5408: foreach my $item (@{$$affiliatesref{$key}}) {
5409: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5410: my $destname = $pathname.'/'.$filename;
5411: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5412: if ($xml_classlist =~ /^error/) {
5413: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5414: } else {
1.506 raeburn 5415: if ( open(FILE,">$destname") ) {
5416: print FILE &unescape($xml_classlist);
5417: close(FILE);
1.526 raeburn 5418: } else {
5419: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5420: }
5421: }
5422: }
5423: }
5424: }
5425: }
5426: return 'ok';
5427: }
5428: return 'error';
5429: }
5430:
1.242 www 5431: sub get_query_reply {
5432: my $queryid=shift;
1.240 www 5433: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5434: my $reply='';
5435: for (1..100) {
5436: sleep 2;
5437: if (-e $replyfile.'.end') {
1.448 albertel 5438: if (open(my $fh,$replyfile)) {
1.904 albertel 5439: $reply = join('',<$fh>);
5440: close($fh);
1.240 www 5441: } else { return 'error: reply_file_error'; }
1.242 www 5442: return &unescape($reply);
5443: }
1.240 www 5444: }
1.242 www 5445: return 'timeout:'.$queryid;
1.240 www 5446: }
5447:
5448: sub courselog_query {
1.241 www 5449: #
5450: # possible filters:
5451: # url: url or symb
5452: # username
5453: # domain
5454: # action: view, submit, grade
5455: # start: timestamp
5456: # end: timestamp
5457: #
1.240 www 5458: my (%filters)=@_;
1.620 albertel 5459: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5460: if ($filters{'url'}) {
5461: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5462: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5463: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5464: }
1.620 albertel 5465: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5466: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5467: return &log_query($cname,$cdom,'courselog',%filters);
5468: }
5469:
5470: sub userlog_query {
1.858 raeburn 5471: #
5472: # possible filters:
5473: # action: log check role
5474: # start: timestamp
5475: # end: timestamp
5476: #
1.240 www 5477: my ($uname,$udom,%filters)=@_;
5478: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5479: }
5480:
1.506 raeburn 5481: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5482:
5483: sub auto_run {
1.508 raeburn 5484: my ($cnum,$cdom) = @_;
1.876 raeburn 5485: my $response = 0;
5486: my $settings;
5487: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5488: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5489: $settings = $domconfig{'autoenroll'};
5490: if ($settings->{'run'} eq '1') {
5491: $response = 1;
5492: }
5493: } else {
1.934 raeburn 5494: my $homeserver;
5495: if (&is_course($cdom,$cnum)) {
5496: $homeserver = &homeserver($cnum,$cdom);
5497: } else {
5498: $homeserver = &domain($cdom,'primary');
5499: }
5500: if ($homeserver ne 'no_host') {
5501: $response = &reply('autorun:'.$cdom,$homeserver);
5502: }
1.876 raeburn 5503: }
1.506 raeburn 5504: return $response;
5505: }
1.776 albertel 5506:
1.506 raeburn 5507: sub auto_get_sections {
1.508 raeburn 5508: my ($cnum,$cdom,$inst_coursecode) = @_;
5509: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 5510: my @secs = ();
1.511 raeburn 5511: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
1.506 raeburn 5512: unless ($response eq 'refused') {
1.901 albertel 5513: @secs = split(/:/,$response);
1.506 raeburn 5514: }
5515: return @secs;
5516: }
1.776 albertel 5517:
1.506 raeburn 5518: sub auto_new_course {
1.508 raeburn 5519: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5520: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5521: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5522: return $response;
5523: }
1.776 albertel 5524:
1.506 raeburn 5525: sub auto_validate_courseID {
1.508 raeburn 5526: my ($cnum,$cdom,$inst_course_id) = @_;
5527: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5528: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5529: return $response;
5530: }
1.776 albertel 5531:
1.506 raeburn 5532: sub auto_create_password {
1.873 raeburn 5533: my ($cnum,$cdom,$authparam,$udom) = @_;
5534: my ($homeserver,$response);
1.506 raeburn 5535: my $create_passwd = 0;
5536: my $authchk = '';
1.873 raeburn 5537: if ($udom =~ /^$match_domain$/) {
5538: $homeserver = &domain($udom,'primary');
5539: }
5540: if ($homeserver eq '') {
5541: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5542: $homeserver = &homeserver($cnum,$cdom);
5543: }
5544: }
5545: if ($homeserver eq '') {
5546: $authchk = 'nodomain';
1.506 raeburn 5547: } else {
1.873 raeburn 5548: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5549: if ($response eq 'refused') {
5550: $authchk = 'refused';
5551: } else {
1.901 albertel 5552: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5553: }
1.506 raeburn 5554: }
5555: return ($authparam,$create_passwd,$authchk);
5556: }
5557:
1.706 raeburn 5558: sub auto_photo_permission {
5559: my ($cnum,$cdom,$students) = @_;
5560: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5561: my ($outcome,$perm_reqd,$conditions) =
5562: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5563: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5564: return (undef,undef);
5565: }
1.706 raeburn 5566: return ($outcome,$perm_reqd,$conditions);
5567: }
5568:
5569: sub auto_checkphotos {
5570: my ($uname,$udom,$pid) = @_;
5571: my $homeserver = &homeserver($uname,$udom);
5572: my ($result,$resulttype);
5573: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5574: &escape($uname).':'.&escape($pid),
5575: $homeserver));
1.709 albertel 5576: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5577: return (undef,undef);
5578: }
1.706 raeburn 5579: if ($outcome) {
5580: ($result,$resulttype) = split(/:/,$outcome);
5581: }
5582: return ($result,$resulttype);
5583: }
5584:
5585: sub auto_photochoice {
5586: my ($cnum,$cdom) = @_;
5587: my $homeserver = &homeserver($cnum,$cdom);
5588: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5589: &escape($cdom),
5590: $homeserver)));
1.709 albertel 5591: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5592: return (undef,undef);
5593: }
1.706 raeburn 5594: return ($update,$comment);
5595: }
5596:
5597: sub auto_photoupdate {
5598: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5599: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5600: my $host=&hostname($homeserver);
1.706 raeburn 5601: my $cmd = '';
5602: my $maxtries = 1;
1.800 albertel 5603: foreach my $affiliate (keys(%{$affiliatesref})) {
5604: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5605: }
5606: $cmd =~ s/%%$//;
5607: $cmd = &escape($cmd);
5608: my $query = 'institutionalphotos';
5609: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5610: unless ($queryid=~/^\Q$host\E\_/) {
5611: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5612: return 'error: '.$queryid;
5613: }
5614: my $reply = &get_query_reply($queryid);
5615: my $tries = 1;
5616: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5617: $reply = &get_query_reply($queryid);
5618: $tries ++;
5619: }
5620: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5621: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5622: } else {
5623: my @responses = split(/:/,$reply);
5624: my $outcome = shift(@responses);
5625: foreach my $item (@responses) {
5626: my ($key,$value) = split(/=/,$item);
5627: $$photo{$key} = $value;
5628: }
5629: return $outcome;
5630: }
5631: return 'error';
5632: }
5633:
1.521 raeburn 5634: sub auto_instcode_format {
1.793 albertel 5635: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5636: $cat_order) = @_;
1.521 raeburn 5637: my $courses = '';
1.772 raeburn 5638: my @homeservers;
1.521 raeburn 5639: if ($caller eq 'global') {
1.841 albertel 5640: my %servers = &get_servers($codedom,'library');
5641: foreach my $tryserver (keys(%servers)) {
5642: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5643: push(@homeservers,$tryserver);
5644: }
1.584 raeburn 5645: }
1.521 raeburn 5646: } else {
1.772 raeburn 5647: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5648: }
1.793 albertel 5649: foreach my $code (keys(%{$instcodes})) {
5650: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5651: }
5652: chop($courses);
1.772 raeburn 5653: my $ok_response = 0;
5654: my $response;
5655: while (@homeservers > 0 && $ok_response == 0) {
5656: my $server = shift(@homeservers);
5657: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5658: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5659: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5660: split(/:/,$response);
1.772 raeburn 5661: %{$codes} = (%{$codes},&str2hash($codes_str));
5662: push(@{$codetitles},&str2array($codetitles_str));
5663: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5664: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5665: $ok_response = 1;
5666: }
5667: }
5668: if ($ok_response) {
1.521 raeburn 5669: return 'ok';
1.772 raeburn 5670: } else {
5671: return $response;
1.521 raeburn 5672: }
5673: }
5674:
1.792 raeburn 5675: sub auto_instcode_defaults {
5676: my ($domain,$returnhash,$code_order) = @_;
5677: my @homeservers;
1.841 albertel 5678:
5679: my %servers = &get_servers($domain,'library');
5680: foreach my $tryserver (keys(%servers)) {
5681: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5682: push(@homeservers,$tryserver);
5683: }
1.792 raeburn 5684: }
1.841 albertel 5685:
1.792 raeburn 5686: my $response;
1.841 albertel 5687: foreach my $server (@homeservers) {
1.792 raeburn 5688: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5689: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5690:
5691: foreach my $pair (split(/\&/,$response)) {
5692: my ($name,$value)=split(/\=/,$pair);
5693: if ($name eq 'code_order') {
5694: @{$code_order} = split(/\&/,&unescape($value));
5695: } else {
5696: $returnhash->{&unescape($name)}=&unescape($value);
5697: }
5698: }
5699: return 'ok';
1.792 raeburn 5700: }
1.841 albertel 5701:
5702: return $response;
1.1003 raeburn 5703: }
5704:
5705: sub auto_possible_instcodes {
5706: my ($domain,$codetitles,$cat_titles,$cat_order) = @_;
5707: my (@homeservers,$uhome);
5708: if (defined(&domain($domain,'primary'))) {
5709: $uhome=&domain($domain,'primary');
5710: push(@homeservers,&domain($domain,'primary'));
5711: } else {
5712: my %servers = &get_servers($domain,'library');
5713: foreach my $tryserver (keys(%servers)) {
5714: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5715: push(@homeservers,$tryserver);
5716: }
5717: }
5718: }
5719: my $response;
5720: foreach my $server (@homeservers) {
5721: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5722: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5723: my ($codetitlestr,$cat_title,$cat_order) = split(':',$response);
5724: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5725: foreach my $item (split('&',$cat_title)) {
5726: my ($name,$value)=split('&',$item);
5727: $cat_titles->{&unescape($name)}=&unescape($value);
5728: }
5729: foreach my $item (split('&',$cat_order)) {
5730: my ($name,$value)=split('&',$item);
5731: $cat_order->{&unescape($name)}=&unescape($value);
5732: }
5733: return 'ok';
5734: }
5735: return $response;
5736: }
1.792 raeburn 5737:
1.777 albertel 5738: sub auto_validate_class_sec {
1.918 raeburn 5739: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 5740: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 5741: my $ownerlist;
5742: if (ref($owners) eq 'ARRAY') {
5743: $ownerlist = join(',',@{$owners});
5744: } else {
5745: $ownerlist = $owners;
5746: }
1.773 raeburn 5747: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 5748: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 5749: return $response;
5750: }
5751:
1.679 raeburn 5752: # ------------------------------------------------------- Course Group routines
5753:
5754: sub get_coursegroups {
1.809 raeburn 5755: my ($cdom,$cnum,$group,$namespace) = @_;
5756: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 5757: }
5758:
1.679 raeburn 5759: sub modify_coursegroup {
5760: my ($cdom,$cnum,$groupsettings) = @_;
5761: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
5762: }
5763:
1.809 raeburn 5764: sub toggle_coursegroup_status {
5765: my ($cdom,$cnum,$group,$action) = @_;
5766: my ($from_namespace,$to_namespace);
5767: if ($action eq 'delete') {
5768: $from_namespace = 'coursegroups';
5769: $to_namespace = 'deleted_groups';
5770: } else {
5771: $from_namespace = 'deleted_groups';
5772: $to_namespace = 'coursegroups';
5773: }
5774: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 5775: if (my $tmp = &error(%curr_group)) {
5776: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
5777: return ('read error',$tmp);
5778: } else {
5779: my %savedsettings = %curr_group;
1.809 raeburn 5780: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 5781: my $deloutcome;
5782: if ($result eq 'ok') {
1.809 raeburn 5783: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 5784: } else {
5785: return ('write error',$result);
5786: }
5787: if ($deloutcome eq 'ok') {
5788: return 'ok';
5789: } else {
5790: return ('delete error',$deloutcome);
5791: }
5792: }
5793: }
5794:
1.679 raeburn 5795: sub modify_group_roles {
1.957 raeburn 5796: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 5797: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
5798: my $role = 'gr/'.&escape($userprivs);
5799: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 5800: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 5801: if ($result eq 'ok') {
5802: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
5803: }
1.679 raeburn 5804: return $result;
5805: }
5806:
5807: sub modify_coursegroup_membership {
5808: my ($cdom,$cnum,$membership) = @_;
5809: my $result = &put('groupmembership',$membership,$cdom,$cnum);
5810: return $result;
5811: }
5812:
1.682 raeburn 5813: sub get_active_groups {
5814: my ($udom,$uname,$cdom,$cnum) = @_;
5815: my $now = time;
5816: my %groups = ();
5817: foreach my $key (keys(%env)) {
1.811 albertel 5818: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 5819: my ($start,$end) = split(/\./,$env{$key});
5820: if (($end!=0) && ($end<$now)) { next; }
5821: if (($start!=0) && ($start>$now)) { next; }
5822: if ($1 eq $cdom && $2 eq $cnum) {
5823: $groups{$3} = $env{$key} ;
5824: }
5825: }
5826: }
5827: return %groups;
5828: }
5829:
1.683 raeburn 5830: sub get_group_membership {
5831: my ($cdom,$cnum,$group) = @_;
5832: return(&dump('groupmembership',$cdom,$cnum,$group));
5833: }
5834:
5835: sub get_users_groups {
5836: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 5837: my @usersgroups;
1.683 raeburn 5838: my $cachetime=1800;
5839:
5840: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 5841: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
5842: if (defined($cached)) {
1.734 albertel 5843: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 5844: } else {
5845: $grouplist = '';
1.816 raeburn 5846: my $courseurl = &courseid_to_courseurl($courseid);
5847: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 5848: my $access_end = $env{'course.'.$courseid.
5849: '.default_enrollment_end_date'};
5850: my $now = time;
5851: foreach my $key (keys(%roleshash)) {
5852: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
5853: my $group = $1;
5854: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
5855: my $start = $2;
5856: my $end = $1;
5857: if ($start == -1) { next; } # deleted from group
5858: if (($start!=0) && ($start>$now)) { next; }
5859: if (($end!=0) && ($end<$now)) {
5860: if ($access_end && $access_end < $now) {
5861: if ($access_end - $end < 86400) {
5862: push(@usersgroups,$group);
1.733 raeburn 5863: }
5864: }
1.817 raeburn 5865: next;
1.733 raeburn 5866: }
1.817 raeburn 5867: push(@usersgroups,$group);
1.683 raeburn 5868: }
5869: }
5870: }
1.817 raeburn 5871: @usersgroups = &sort_course_groups($courseid,@usersgroups);
5872: $grouplist = join(':',@usersgroups);
5873: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 5874: }
1.733 raeburn 5875: return @usersgroups;
1.683 raeburn 5876: }
5877:
5878: sub devalidate_getgroups_cache {
5879: my ($udom,$uname,$cdom,$cnum)=@_;
5880: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 5881:
1.683 raeburn 5882: my $hashid="$udom:$uname:$courseid";
5883: &devalidate_cache_new('getgroups',$hashid);
5884: }
5885:
1.12 www 5886: # ------------------------------------------------------------------ Plain Text
5887:
5888: sub plaintext {
1.988 raeburn 5889: my ($short,$type,$cid,$forcedefault) = @_;
1.758 albertel 5890: if ($short =~ /^cr/) {
5891: return (split('/',$short))[-1];
5892: }
1.742 raeburn 5893: if (!defined($cid)) {
5894: $cid = $env{'request.course.id'};
5895: }
1.988 raeburn 5896: if (defined($cid) && ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '')) {
5897: unless ($forcedefault) {
5898: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
5899: &Apache::lonlocal::mt_escape(\$roletext);
5900: return &Apache::lonlocal::mt($roletext);
5901: }
1.742 raeburn 5902: }
5903: my %rolenames = (
5904: Course => 'std',
5905: Group => 'alt1',
5906: );
5907: if (defined($type) &&
5908: defined($rolenames{$type}) &&
5909: defined($prp{$short}{$rolenames{$type}})) {
5910: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
5911: } else {
5912: return &Apache::lonlocal::mt($prp{$short}{'std'});
5913: }
1.12 www 5914: }
5915:
5916: # ----------------------------------------------------------------- Assign Role
5917:
5918: sub assignrole {
1.957 raeburn 5919: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
5920: $context)=@_;
1.21 www 5921: my $mrole;
5922: if ($role =~ /^cr\//) {
1.393 www 5923: my $cwosec=$url;
1.811 albertel 5924: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 5925: unless (&allowed('ccr',$cwosec)) {
1.104 www 5926: &logthis('Refused custom assignrole: '.
5927: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 5928: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 5929: return 'refused';
5930: }
1.21 www 5931: $mrole='cr';
1.678 raeburn 5932: } elsif ($role =~ /^gr\//) {
5933: my $cwogrp=$url;
1.811 albertel 5934: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 5935: unless (&allowed('mdg',$cwogrp)) {
5936: &logthis('Refused group assignrole: '.
5937: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5938: $env{'user.name'}.' at '.$env{'user.domain'});
5939: return 'refused';
5940: }
5941: $mrole='gr';
1.21 www 5942: } else {
1.82 www 5943: my $cwosec=$url;
1.811 albertel 5944: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 5945: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
5946: my $refused;
5947: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
5948: if (!(&allowed('c'.$role,$url))) {
5949: $refused = 1;
5950: }
5951: } else {
5952: $refused = 1;
5953: }
1.947 raeburn 5954: if ($refused) {
5955: if (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5956: $refused = '';
5957: } else {
5958: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
5959: ' '.$role.' '.$end.' '.$start.' by '.
5960: $env{'user.name'}.' at '.$env{'user.domain'});
5961: return 'refused';
5962: }
1.932 raeburn 5963: }
1.104 www 5964: }
1.21 www 5965: $mrole=$role;
5966: }
1.620 albertel 5967: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5968: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 5969: if ($end) { $command.='_'.$end; }
1.21 www 5970: if ($start) {
5971: if ($end) {
1.81 www 5972: $command.='_'.$start;
1.21 www 5973: } else {
1.81 www 5974: $command.='_0_'.$start;
1.21 www 5975: }
5976: }
1.739 raeburn 5977: my $origstart = $start;
5978: my $origend = $end;
1.957 raeburn 5979: my $delflag;
1.357 www 5980: # actually delete
5981: if ($deleteflag) {
1.373 www 5982: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 5983: # modify command to delete the role
1.620 albertel 5984: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 5985: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 5986: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 5987: # set start and finish to negative values for userrolelog
5988: $start=-1;
5989: $end=-1;
1.957 raeburn 5990: $delflag = 1;
1.357 www 5991: }
5992: }
5993: # send command
1.349 www 5994: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 5995: # log new user role if status is ok
1.349 www 5996: if ($answer eq 'ok') {
1.663 raeburn 5997: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 5998: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 5999: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6000: unless ($role =~ /^gr/) {
6001: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6002: $origstart,$selfenroll,$context);
1.739 raeburn 6003: }
1.349 www 6004: }
6005: return $answer;
1.169 harris41 6006: }
6007:
6008: # -------------------------------------------------- Modify user authentication
1.197 www 6009: # Overrides without validation
6010:
1.169 harris41 6011: sub modifyuserauth {
6012: my ($udom,$uname,$umode,$upass)=@_;
6013: my $uhome=&homeserver($uname,$udom);
1.197 www 6014: unless (&allowed('mau',$udom)) { return 'refused'; }
6015: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6016: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6017: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6018: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6019: &escape($upass),$uhome);
1.620 albertel 6020: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6021: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6022: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6023: &log($udom,,$uname,$uhome,
1.620 albertel 6024: 'Authentication changed by '.$env{'user.domain'}.', '.
6025: $env{'user.name'}.', '.$umode.
1.197 www 6026: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6027: unless ($reply eq 'ok') {
1.197 www 6028: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6029: return 'error: '.$reply;
6030: }
1.170 harris41 6031: return 'ok';
1.80 www 6032: }
6033:
1.81 www 6034: # --------------------------------------------------------------- Modify a user
1.80 www 6035:
1.81 www 6036: sub modifyuser {
1.206 matthew 6037: my ($udom, $uname, $uid,
6038: $umode, $upass, $first,
6039: $middle, $last, $gene,
1.963 raeburn 6040: $forceid, $desiredhome, $email, $inststatus)=@_;
1.807 albertel 6041: $udom= &LONCAPA::clean_domain($udom);
6042: $uname=&LONCAPA::clean_username($uname);
1.81 www 6043: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6044: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 6045: $last.', '.$gene.'(forceid: '.$forceid.')'.
6046: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6047: ' desiredhome not specified').
1.620 albertel 6048: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6049: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6050: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6051: # ----------------------------------------------------------------- Create User
1.406 albertel 6052: if (($uhome eq 'no_host') &&
6053: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6054: my $unhome='';
1.844 albertel 6055: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6056: $unhome = $desiredhome;
1.620 albertel 6057: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6058: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6059: } else { # load balancing routine for determining $unhome
1.81 www 6060: my $loadm=10000000;
1.841 albertel 6061: my %servers = &get_servers($udom,'library');
6062: foreach my $tryserver (keys(%servers)) {
6063: my $answer=reply('load',$tryserver);
6064: if (($answer=~/\d+/) && ($answer<$loadm)) {
6065: $loadm=$answer;
6066: $unhome=$tryserver;
6067: }
1.80 www 6068: }
6069: }
6070: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6071: return 'error: unable to find a home server for '.$uname.
6072: ' in domain '.$udom;
1.80 www 6073: }
6074: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6075: &escape($upass),$unhome);
6076: unless ($reply eq 'ok') {
6077: return 'error: '.$reply;
6078: }
1.230 stredwic 6079: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6080: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6081: return 'error: unable verify users home machine.';
1.80 www 6082: }
1.209 matthew 6083: } # End of creation of new user
1.80 www 6084: # ---------------------------------------------------------------------- Add ID
6085: if ($uid) {
6086: $uid=~tr/A-Z/a-z/;
6087: my %uidhash=&idrget($udom,$uname);
1.196 www 6088: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6089: && (!$forceid)) {
1.80 www 6090: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6091: return 'error: user id "'.$uid.'" does not match '.
6092: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6093: }
6094: } else {
6095: &idput($udom,($uname => $uid));
6096: }
6097: }
6098: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6099: my @tmp=&get('environment',
1.899 raeburn 6100: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6101: 'permanentemail','inststatus'],
1.134 albertel 6102: $udom,$uname);
1.313 matthew 6103: my %names;
6104: if ($tmp[0] =~ m/^error:.*/) {
6105: %names=();
6106: } else {
6107: %names = @tmp;
6108: }
1.388 www 6109: #
6110: # Make sure to not trash student environment if instructor does not bother
6111: # to supply name and email information
6112: #
6113: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6114: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6115: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6116: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6117: if ($email) {
6118: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6119: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6120: }
1.899 raeburn 6121: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6122: if (defined($inststatus)) {
6123: $names{'inststatus'} = '';
6124: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6125: if (ref($usertypes) eq 'HASH') {
6126: my @okstatuses;
6127: foreach my $item (split(/:/,$inststatus)) {
6128: if (defined($usertypes->{$item})) {
6129: push(@okstatuses,$item);
6130: }
6131: }
6132: if (@okstatuses) {
6133: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6134: }
6135: }
6136: }
1.134 albertel 6137: my $reply = &put('environment', \%names, $udom,$uname);
6138: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6139: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6140: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6141: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6142: $umode.', '.$first.', '.$middle.', '.
6143: $last.', '.$gene.', '.$email.', '.$inststatus;
6144: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6145: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6146: } else {
6147: $logmsg .= ' during self creation';
6148: }
6149: &logthis($logmsg);
1.134 albertel 6150: return 'ok';
1.80 www 6151: }
6152:
1.81 www 6153: # -------------------------------------------------------------- Modify student
1.80 www 6154:
1.81 www 6155: sub modifystudent {
6156: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6157: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6158: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6159: if (!$cid) {
1.620 albertel 6160: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6161: return 'not_in_class';
6162: }
1.80 www 6163: }
6164: # --------------------------------------------------------------- Make the user
1.81 www 6165: my $reply=&modifyuser
1.209 matthew 6166: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6167: $desiredhome,$email,$inststatus);
1.80 www 6168: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6169: # This will cause &modify_student_enrollment to get the uid from the
6170: # students environment
6171: $uid = undef if (!$forceid);
1.455 albertel 6172: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6173: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6174: return $reply;
6175: }
6176:
6177: sub modify_student_enrollment {
1.957 raeburn 6178: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6179: my ($cdom,$cnum,$chome);
6180: if (!$cid) {
1.620 albertel 6181: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6182: return 'not_in_class';
6183: }
1.620 albertel 6184: $cdom=$env{'course.'.$cid.'.domain'};
6185: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6186: } else {
6187: ($cdom,$cnum)=split(/_/,$cid);
6188: }
1.620 albertel 6189: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6190: if (!$chome) {
1.457 raeburn 6191: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6192: }
1.455 albertel 6193: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6194: # Make sure the user exists
1.81 www 6195: my $uhome=&homeserver($uname,$udom);
6196: if (($uhome eq '') || ($uhome eq 'no_host')) {
6197: return 'error: no such user';
6198: }
1.297 matthew 6199: # Get student data if we were not given enough information
6200: if (!defined($first) || $first eq '' ||
6201: !defined($last) || $last eq '' ||
6202: !defined($uid) || $uid eq '' ||
6203: !defined($middle) || $middle eq '' ||
6204: !defined($gene) || $gene eq '') {
1.294 matthew 6205: # They did not supply us with enough data to enroll the student, so
6206: # we need to pick up more information.
1.297 matthew 6207: my %tmp = &get('environment',
1.294 matthew 6208: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6209: ,$udom,$uname);
6210:
1.800 albertel 6211: #foreach my $key (keys(%tmp)) {
6212: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6213: #}
1.294 matthew 6214: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6215: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6216: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6217: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6218: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6219: }
1.556 albertel 6220: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6221: my $reply=cput('classlist',
6222: {"$uname:$udom" =>
1.515 raeburn 6223: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6224: $cdom,$cnum);
1.81 www 6225: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6226: return 'error: '.$reply;
1.652 albertel 6227: } else {
6228: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6229: }
1.297 matthew 6230: # Add student role to user
1.83 www 6231: my $uurl='/'.$cid;
1.81 www 6232: $uurl=~s/\_/\//g;
6233: if ($usec) {
6234: $uurl.='/'.$usec;
6235: }
1.957 raeburn 6236: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6237: }
6238:
1.556 albertel 6239: sub format_name {
6240: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6241: my $name;
6242: if ($first ne 'lastname') {
6243: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6244: } else {
6245: if ($lastname=~/\S/) {
6246: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6247: $name=~s/\s+,/,/;
6248: } else {
6249: $name.= $firstname.' '.$middlename.' '.$generation;
6250: }
6251: }
6252: $name=~s/^\s+//;
6253: $name=~s/\s+$//;
6254: $name=~s/\s+/ /g;
6255: return $name;
6256: }
6257:
1.84 www 6258: # ------------------------------------------------- Write to course preferences
6259:
6260: sub writecoursepref {
6261: my ($courseid,%prefs)=@_;
6262: $courseid=~s/^\///;
6263: $courseid=~s/\_/\//g;
6264: my ($cdomain,$cnum)=split(/\//,$courseid);
6265: my $chome=homeserver($cnum,$cdomain);
6266: if (($chome eq '') || ($chome eq 'no_host')) {
6267: return 'error: no such course';
6268: }
6269: my $cstring='';
1.800 albertel 6270: foreach my $pref (keys(%prefs)) {
6271: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6272: }
1.84 www 6273: $cstring=~s/\&$//;
6274: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6275: }
6276:
6277: # ---------------------------------------------------------- Make/modify course
6278:
6279: sub createcourse {
1.741 raeburn 6280: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6281: $course_owner,$crstype)=@_;
1.84 www 6282: $url=&declutter($url);
6283: my $cid='';
1.264 matthew 6284: unless (&allowed('ccc',$udom)) {
1.84 www 6285: return 'refused';
6286: }
6287: # ------------------------------------------------------------------- Create ID
1.674 www 6288: my $uname=int(1+rand(9)).
6289: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6290: substr($$.time,0,5).unpack("H8",pack("I32",time)).
1.84 www 6291: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6292: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 6293: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6294: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6295: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
6296: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 6297: $uhome=&homeserver($uname,$udom,'true');
1.84 www 6298: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6299: return 'error: unable to generate unique course-ID';
6300: }
6301: }
1.264 matthew 6302: # ------------------------------------------------ Check supplied server name
1.620 albertel 6303: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.845 albertel 6304: if (! &is_library($course_server)) {
1.264 matthew 6305: return 'error:bad server name '.$course_server;
6306: }
1.84 www 6307: # ------------------------------------------------------------- Make the course
6308: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6309: $course_server);
1.84 www 6310: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 6311: $uhome=&homeserver($uname,$udom,'true');
1.84 www 6312: if (($uhome eq '') || ($uhome eq 'no_host')) {
6313: return 'error: no such course';
6314: }
1.271 www 6315: # ----------------------------------------------------------------- Course made
1.516 raeburn 6316: # log existence
1.918 raeburn 6317: my $newcourse = {
6318: $udom.'_'.$uname => {
1.921 raeburn 6319: description => $description,
6320: inst_code => $inst_code,
6321: owner => $course_owner,
6322: type => $crstype,
1.918 raeburn 6323: },
6324: };
1.921 raeburn 6325: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6326: # set toplevel url
1.271 www 6327: my $topurl=$url;
6328: unless ($nonstandard) {
6329: # ------------------------------------------ For standard courses, make top url
6330: my $mapurl=&clutter($url);
1.278 www 6331: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6332: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6333: <map>
6334: <resource id="1" type="start"></resource>
6335: <resource id="2" src="$mapurl"></resource>
6336: <resource id="3" type="finish"></resource>
6337: <link index="1" from="1" to="2"></link>
6338: <link index="2" from="2" to="3"></link>
6339: </map>
6340: ENDINITMAP
6341: $topurl=&declutter(
1.638 albertel 6342: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6343: );
6344: }
6345: # ----------------------------------------------------------- Write preferences
1.84 www 6346: &writecoursepref($udom.'_'.$uname,
6347: ('description' => $description,
1.271 www 6348: 'url' => $topurl));
1.84 www 6349: return '/'.$udom.'/'.$uname;
6350: }
6351:
1.813 albertel 6352: sub is_course {
6353: my ($cdom,$cnum) = @_;
6354: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 6355: undef,'.');
1.813 albertel 6356: if (exists($courses{$cdom.'_'.$cnum})) {
6357: return 1;
6358: }
6359: return 0;
6360: }
6361:
1.21 www 6362: # ---------------------------------------------------------- Assign Custom Role
6363:
6364: sub assigncustomrole {
1.957 raeburn 6365: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6366: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 6367: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 6368: }
6369:
6370: # ----------------------------------------------------------------- Revoke Role
6371:
6372: sub revokerole {
1.957 raeburn 6373: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6374: my $now=time;
1.965 raeburn 6375: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 6376: }
6377:
6378: # ---------------------------------------------------------- Revoke Custom Role
6379:
6380: sub revokecustomrole {
1.957 raeburn 6381: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6382: my $now=time;
1.357 www 6383: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 6384: $deleteflag,$selfenroll,$context);
1.17 www 6385: }
6386:
1.533 banghart 6387: # ------------------------------------------------------------ Disk usage
1.535 albertel 6388: sub diskusage {
1.955 raeburn 6389: my ($udom,$uname,$directorypath,$getpropath)=@_;
6390: $directorypath =~ s/\/$//;
6391: my $listing=&reply('du2:'.&escape($directorypath).':'
6392: .&escape($getpropath).':'.&escape($uname).':'
6393: .&escape($udom),homeserver($uname,$udom));
6394: if ($listing eq 'unknown_cmd') {
6395: if ($getpropath) {
6396: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6397: }
6398: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6399: }
1.514 albertel 6400: return $listing;
1.512 banghart 6401: }
6402:
1.566 banghart 6403: sub is_locked {
6404: my ($file_name, $domain, $user) = @_;
6405: my @check;
6406: my $is_locked;
6407: push @check, $file_name;
1.613 albertel 6408: my %locked = &get('file_permissions',\@check,
1.620 albertel 6409: $env{'user.domain'},$env{'user.name'});
1.615 albertel 6410: my ($tmp)=keys(%locked);
6411: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 6412:
1.566 banghart 6413: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 6414: $is_locked = 'false';
6415: foreach my $entry (@{$locked{$file_name}}) {
6416: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 6417: $is_locked = 'true';
6418: last;
1.745 raeburn 6419: }
6420: }
1.566 banghart 6421: } else {
6422: $is_locked = 'false';
6423: }
6424: }
6425:
1.759 albertel 6426: sub declutter_portfile {
6427: my ($file) = @_;
1.833 albertel 6428: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 6429: return $file;
6430: }
6431:
1.559 banghart 6432: # ------------------------------------------------------------- Mark as Read Only
6433:
6434: sub mark_as_readonly {
6435: my ($domain,$user,$files,$what) = @_;
1.613 albertel 6436: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6437: my ($tmp)=keys(%current_permissions);
6438: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 6439: foreach my $file (@{$files}) {
1.759 albertel 6440: $file = &declutter_portfile($file);
1.561 banghart 6441: push(@{$current_permissions{$file}},$what);
1.559 banghart 6442: }
1.613 albertel 6443: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6444: return;
6445: }
6446:
1.572 banghart 6447: # ------------------------------------------------------------Save Selected Files
6448:
6449: sub save_selected_files {
6450: my ($user, $path, @files) = @_;
6451: my $filename = $user."savedfiles";
1.573 banghart 6452: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 6453: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 6454: foreach my $file (@files) {
1.620 albertel 6455: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 6456: }
6457: foreach my $file (@other_files) {
1.574 banghart 6458: print (OUT $file."\n");
1.572 banghart 6459: }
1.574 banghart 6460: close (OUT);
1.572 banghart 6461: return 'ok';
6462: }
6463:
1.574 banghart 6464: sub clear_selected_files {
6465: my ($user) = @_;
6466: my $filename = $user."savedfiles";
6467: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6468: print (OUT undef);
6469: close (OUT);
6470: return ("ok");
6471: }
6472:
1.572 banghart 6473: sub files_in_path {
6474: my ($user, $path) = @_;
6475: my $filename = $user."savedfiles";
6476: my %return_files;
1.574 banghart 6477: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 6478: while (my $line_in = <IN>) {
1.574 banghart 6479: chomp ($line_in);
6480: my @paths_and_file = split (m!/!, $line_in);
6481: my $file_part = pop (@paths_and_file);
6482: my $path_part = join ('/', @paths_and_file);
1.573 banghart 6483: $path_part.='/';
6484: my $path_and_file = $path_part.$file_part;
6485: if ($path_part eq $path) {
6486: $return_files{$file_part}= 'selected';
6487: }
6488: }
1.574 banghart 6489: close (IN);
6490: return (\%return_files);
1.572 banghart 6491: }
6492:
6493: # called in portfolio select mode, to show files selected NOT in current directory
6494: sub files_not_in_path {
6495: my ($user, $path) = @_;
6496: my $filename = $user."savedfiles";
6497: my @return_files;
6498: my $path_part;
1.800 albertel 6499: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6500: while (my $line = <IN>) {
1.572 banghart 6501: #ok, I know it's clunky, but I want it to work
1.800 albertel 6502: my @paths_and_file = split(m|/|, $line);
6503: my $file_part = pop(@paths_and_file);
6504: chomp($file_part);
6505: my $path_part = join('/', @paths_and_file);
1.572 banghart 6506: $path_part .= '/';
6507: my $path_and_file = $path_part.$file_part;
6508: if ($path_part ne $path) {
1.800 albertel 6509: push(@return_files, ($path_and_file));
1.572 banghart 6510: }
6511: }
1.800 albertel 6512: close(OUT);
1.574 banghart 6513: return (@return_files);
1.572 banghart 6514: }
6515:
1.745 raeburn 6516: #----------------------------------------------Get portfolio file permissions
1.629 banghart 6517:
1.745 raeburn 6518: sub get_portfile_permissions {
6519: my ($domain,$user) = @_;
1.613 albertel 6520: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6521: my ($tmp)=keys(%current_permissions);
6522: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 6523: return \%current_permissions;
6524: }
6525:
6526: #---------------------------------------------Get portfolio file access controls
6527:
1.749 raeburn 6528: sub get_access_controls {
1.745 raeburn 6529: my ($current_permissions,$group,$file) = @_;
1.769 albertel 6530: my %access;
6531: my $real_file = $file;
6532: $file =~ s/\.meta$//;
1.745 raeburn 6533: if (defined($file)) {
1.749 raeburn 6534: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
6535: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 6536: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 6537: }
6538: }
1.745 raeburn 6539: } else {
1.749 raeburn 6540: foreach my $key (keys(%{$current_permissions})) {
6541: if ($key =~ /\0accesscontrol$/) {
6542: if (defined($group)) {
6543: if ($key !~ m-^\Q$group\E/-) {
6544: next;
6545: }
6546: }
6547: my ($fullpath) = split(/\0/,$key);
6548: if (ref($$current_permissions{$key}) eq 'HASH') {
6549: foreach my $control (keys(%{$$current_permissions{$key}})) {
6550: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
6551: }
6552: }
6553: }
6554: }
6555: }
6556: return %access;
6557: }
6558:
6559: sub modify_access_controls {
6560: my ($file_name,$changes,$domain,$user)=@_;
6561: my ($outcome,$deloutcome);
6562: my %store_permissions;
6563: my %new_values;
6564: my %new_control;
6565: my %translation;
6566: my @deletions = ();
6567: my $now = time;
6568: if (exists($$changes{'activate'})) {
6569: if (ref($$changes{'activate'}) eq 'HASH') {
6570: my @newitems = sort(keys(%{$$changes{'activate'}}));
6571: my $numnew = scalar(@newitems);
6572: for (my $i=0; $i<$numnew; $i++) {
6573: my $newkey = $newitems[$i];
6574: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 6575: if ($newkey =~ /^\d+:/) {
6576: $newkey =~ s/^(\d+)/$newid/;
6577: $translation{$1} = $newid;
6578: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
6579: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
6580: $translation{$1} = $newid;
6581: }
1.749 raeburn 6582: $new_values{$file_name."\0".$newkey} =
6583: $$changes{'activate'}{$newitems[$i]};
6584: $new_control{$newkey} = $now;
6585: }
6586: }
6587: }
6588: my %todelete;
6589: my %changed_items;
6590: foreach my $action ('delete','update') {
6591: if (exists($$changes{$action})) {
6592: if (ref($$changes{$action}) eq 'HASH') {
6593: foreach my $key (keys(%{$$changes{$action}})) {
6594: my ($itemnum) = ($key =~ /^([^:]+):/);
6595: if ($action eq 'delete') {
6596: $todelete{$itemnum} = 1;
6597: } else {
6598: $changed_items{$itemnum} = $key;
6599: }
6600: }
1.745 raeburn 6601: }
6602: }
1.749 raeburn 6603: }
6604: # get lock on access controls for file.
6605: my $lockhash = {
6606: $file_name."\0".'locked_access_records' => $env{'user.name'}.
6607: ':'.$env{'user.domain'},
6608: };
6609: my $tries = 0;
6610: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6611:
6612: while (($gotlock ne 'ok') && $tries <3) {
6613: $tries ++;
6614: sleep 1;
6615: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6616: }
6617: if ($gotlock eq 'ok') {
6618: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
6619: my ($tmp)=keys(%curr_permissions);
6620: if ($tmp=~/^error:/) { undef(%curr_permissions); }
6621: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
6622: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
6623: if (ref($curr_controls) eq 'HASH') {
6624: foreach my $control_item (keys(%{$curr_controls})) {
6625: my ($itemnum) = ($control_item =~ /^([^:]+):/);
6626: if (defined($todelete{$itemnum})) {
6627: push(@deletions,$file_name."\0".$control_item);
6628: } else {
6629: if (defined($changed_items{$itemnum})) {
6630: $new_control{$changed_items{$itemnum}} = $now;
6631: push(@deletions,$file_name."\0".$control_item);
6632: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
6633: } else {
6634: $new_control{$control_item} = $$curr_controls{$control_item};
6635: }
6636: }
1.745 raeburn 6637: }
6638: }
6639: }
1.970 raeburn 6640: my ($group);
6641: if (&is_course($domain,$user)) {
6642: ($group,my $file) = split(/\//,$file_name,2);
6643: }
1.749 raeburn 6644: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
6645: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
6646: $outcome = &put('file_permissions',\%new_values,$domain,$user);
6647: # remove lock
6648: my @del_lock = ($file_name."\0".'locked_access_records');
6649: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 6650: my $sqlresult =
1.970 raeburn 6651: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 6652: $group);
1.749 raeburn 6653: } else {
6654: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 6655: }
1.749 raeburn 6656: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 6657: }
6658:
1.827 raeburn 6659: sub make_public_indefinitely {
6660: my ($requrl) = @_;
6661: my $now = time;
6662: my $action = 'activate';
6663: my $aclnum = 0;
6664: if (&is_portfolio_url($requrl)) {
6665: my (undef,$udom,$unum,$file_name,$group) =
6666: &parse_portfolio_url($requrl);
6667: my $current_perms = &get_portfile_permissions($udom,$unum);
6668: my %access_controls = &get_access_controls($current_perms,
6669: $group,$file_name);
6670: foreach my $key (keys(%{$access_controls{$file_name}})) {
6671: my ($num,$scope,$end,$start) =
6672: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6673: if ($scope eq 'public') {
6674: if ($start <= $now && $end == 0) {
6675: $action = 'none';
6676: } else {
6677: $action = 'update';
6678: $aclnum = $num;
6679: }
6680: last;
6681: }
6682: }
6683: if ($action eq 'none') {
6684: return 'ok';
6685: } else {
6686: my %changes;
6687: my $newend = 0;
6688: my $newstart = $now;
6689: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
6690: $changes{$action}{$newkey} = {
6691: type => 'public',
6692: time => {
6693: start => $newstart,
6694: end => $newend,
6695: },
6696: };
6697: my ($outcome,$deloutcome,$new_values,$translation) =
6698: &modify_access_controls($file_name,\%changes,$udom,$unum);
6699: return $outcome;
6700: }
6701: } else {
6702: return 'invalid';
6703: }
6704: }
6705:
1.745 raeburn 6706: #------------------------------------------------------Get Marked as Read Only
6707:
6708: sub get_marked_as_readonly {
6709: my ($domain,$user,$what,$group) = @_;
6710: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 6711: my @readonly_files;
1.629 banghart 6712: my $cmp1=$what;
6713: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 6714: while (my ($file_name,$value) = each(%{$current_permissions})) {
6715: if (defined($group)) {
6716: if ($file_name !~ m-^\Q$group\E/-) {
6717: next;
6718: }
6719: }
1.561 banghart 6720: if (ref($value) eq "ARRAY"){
6721: foreach my $stored_what (@{$value}) {
1.629 banghart 6722: my $cmp2=$stored_what;
1.759 albertel 6723: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 6724: $cmp2=join('',@{$stored_what});
1.745 raeburn 6725: }
1.629 banghart 6726: if ($cmp1 eq $cmp2) {
1.561 banghart 6727: push(@readonly_files, $file_name);
1.745 raeburn 6728: last;
1.563 banghart 6729: } elsif (!defined($what)) {
6730: push(@readonly_files, $file_name);
1.745 raeburn 6731: last;
1.561 banghart 6732: }
6733: }
1.745 raeburn 6734: }
1.561 banghart 6735: }
6736: return @readonly_files;
6737: }
1.577 banghart 6738: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 6739:
1.577 banghart 6740: sub get_marked_as_readonly_hash {
1.745 raeburn 6741: my ($current_permissions,$group,$what) = @_;
1.577 banghart 6742: my %readonly_files;
1.745 raeburn 6743: while (my ($file_name,$value) = each(%{$current_permissions})) {
6744: if (defined($group)) {
6745: if ($file_name !~ m-^\Q$group\E/-) {
6746: next;
6747: }
6748: }
1.577 banghart 6749: if (ref($value) eq "ARRAY"){
6750: foreach my $stored_what (@{$value}) {
1.745 raeburn 6751: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 6752: foreach my $lock_descriptor(@{$stored_what}) {
6753: if ($lock_descriptor eq 'graded') {
6754: $readonly_files{$file_name} = 'graded';
6755: } elsif ($lock_descriptor eq 'handback') {
6756: $readonly_files{$file_name} = 'handback';
6757: } else {
6758: if (!exists($readonly_files{$file_name})) {
6759: $readonly_files{$file_name} = 'locked';
6760: }
6761: }
1.745 raeburn 6762: }
1.750 banghart 6763: }
1.577 banghart 6764: }
6765: }
6766: }
6767: return %readonly_files;
6768: }
1.559 banghart 6769: # ------------------------------------------------------------ Unmark as Read Only
6770:
6771: sub unmark_as_readonly {
1.629 banghart 6772: # unmarks $file_name (if $file_name is defined), or all files locked by $what
6773: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 6774: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 6775: $file_name = &declutter_portfile($file_name);
1.634 albertel 6776: my $symb_crs = $what;
6777: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 6778: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 6779: my ($tmp)=keys(%current_permissions);
6780: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 6781: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 6782: foreach my $file (@readonly_files) {
1.759 albertel 6783: my $clean_file = &declutter_portfile($file);
6784: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 6785: my $current_locks = $current_permissions{$file};
1.563 banghart 6786: my @new_locks;
6787: my @del_keys;
6788: if (ref($current_locks) eq "ARRAY"){
6789: foreach my $locker (@{$current_locks}) {
1.632 albertel 6790: my $compare=$locker;
1.749 raeburn 6791: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 6792: $compare=join('',@{$locker});
1.746 raeburn 6793: if ($compare ne $symb_crs) {
6794: push(@new_locks, $locker);
6795: }
1.563 banghart 6796: }
6797: }
1.650 albertel 6798: if (scalar(@new_locks) > 0) {
1.563 banghart 6799: $current_permissions{$file} = \@new_locks;
6800: } else {
6801: push(@del_keys, $file);
1.613 albertel 6802: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 6803: delete($current_permissions{$file});
1.563 banghart 6804: }
6805: }
1.561 banghart 6806: }
1.613 albertel 6807: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6808: return;
6809: }
1.512 banghart 6810:
1.17 www 6811: # ------------------------------------------------------------ Directory lister
6812:
6813: sub dirlist {
1.955 raeburn 6814: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 6815: $uri=~s/^\///;
6816: $uri=~s/\/$//;
1.253 stredwic 6817: my ($udom, $uname);
1.955 raeburn 6818: if ($getuserdir) {
1.253 stredwic 6819: $udom = $userdomain;
6820: $uname = $username;
1.955 raeburn 6821: } else {
6822: (undef,$udom,$uname)=split(/\//,$uri);
6823: if(defined($userdomain)) {
6824: $udom = $userdomain;
6825: }
6826: if(defined($username)) {
6827: $uname = $username;
6828: }
1.253 stredwic 6829: }
1.955 raeburn 6830: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 6831:
1.955 raeburn 6832: $dirRoot = $perlvar{'lonDocRoot'};
6833: if (defined($getpropath)) {
6834: $dirRoot = &propath($udom,$uname);
1.253 stredwic 6835: $dirRoot =~ s/\/$//;
1.955 raeburn 6836: } elsif (defined($getuserdir)) {
6837: my $subdir=$uname.'__';
6838: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
6839: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
6840: ."/$udom/$subdir/$uname";
6841: } elsif (defined($alternateRoot)) {
6842: $dirRoot = $alternateRoot;
1.751 banghart 6843: }
1.253 stredwic 6844:
6845: if($udom) {
6846: if($uname) {
1.955 raeburn 6847: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 6848: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 6849: .':'.&escape($uname).':'.&escape($udom),
6850: &homeserver($uname,$udom));
6851: if ($listing eq 'unknown_cmd') {
6852: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
6853: &homeserver($uname,$udom));
6854: } else {
6855: @listing_results = map { &unescape($_); } split(/:/,$listing);
6856: }
1.605 matthew 6857: if ($listing eq 'unknown_cmd') {
1.800 albertel 6858: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
6859: &homeserver($uname,$udom));
1.605 matthew 6860: @listing_results = split(/:/,$listing);
6861: } else {
6862: @listing_results = map { &unescape($_); } split(/:/,$listing);
6863: }
6864: return @listing_results;
1.955 raeburn 6865: } elsif(!$alternateRoot) {
1.800 albertel 6866: my %allusers;
1.841 albertel 6867: my %servers = &get_servers($udom,'library');
1.955 raeburn 6868: foreach my $tryserver (keys(%servers)) {
6869: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
6870: &escape($udom),$tryserver);
6871: if ($listing eq 'unknown_cmd') {
6872: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
6873: $udom, $tryserver);
6874: } else {
6875: @listing_results = map { &unescape($_); } split(/:/,$listing);
6876: }
1.841 albertel 6877: if ($listing eq 'unknown_cmd') {
6878: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
6879: $udom, $tryserver);
6880: @listing_results = split(/:/,$listing);
6881: } else {
6882: @listing_results =
6883: map { &unescape($_); } split(/:/,$listing);
6884: }
6885: if ($listing_results[0] ne 'no_such_dir' &&
6886: $listing_results[0] ne 'empty' &&
6887: $listing_results[0] ne 'con_lost') {
6888: foreach my $line (@listing_results) {
6889: my ($entry) = split(/&/,$line,2);
6890: $allusers{$entry} = 1;
6891: }
6892: }
1.253 stredwic 6893: }
6894: my $alluserstr='';
1.800 albertel 6895: foreach my $user (sort(keys(%allusers))) {
6896: $alluserstr.=$user.'&user:';
1.253 stredwic 6897: }
6898: $alluserstr=~s/:$//;
6899: return split(/:/,$alluserstr);
6900: } else {
1.800 albertel 6901: return ('missing user name');
1.253 stredwic 6902: }
1.955 raeburn 6903: } elsif(!defined($getpropath)) {
1.841 albertel 6904: my @all_domains = sort(&all_domains());
1.955 raeburn 6905: foreach my $domain (@all_domains) {
6906: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
6907: }
6908: return @all_domains;
6909: } else {
1.800 albertel 6910: return ('missing domain');
1.275 stredwic 6911: }
6912: }
6913:
6914: # --------------------------------------------- GetFileTimestamp
6915: # This function utilizes dirlist and returns the date stamp for
6916: # when it was last modified. It will also return an error of -1
6917: # if an error occurs
6918:
6919: sub GetFileTimestamp {
1.955 raeburn 6920: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 6921: $studentDomain = &LONCAPA::clean_domain($studentDomain);
6922: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 6923: my ($fileStat) =
6924: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
6925: undef,$getuserdir);
1.275 stredwic 6926: my @stats = split('&', $fileStat);
6927: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 6928: # @stats contains first the filename, then the stat output
6929: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 6930: } else {
6931: return -1;
1.253 stredwic 6932: }
1.26 www 6933: }
6934:
1.712 albertel 6935: sub stat_file {
6936: my ($uri) = @_;
1.787 albertel 6937: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 6938:
1.955 raeburn 6939: my ($udom,$uname,$file);
1.712 albertel 6940: if ($uri =~ m-^/(uploaded|editupload)/-) {
6941: ($udom,$uname,$file) =
1.811 albertel 6942: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 6943: $file = 'userfiles/'.$file;
6944: }
6945: if ($uri =~ m-^/res/-) {
6946: ($udom,$uname) =
1.807 albertel 6947: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 6948: $file = $uri;
6949: }
6950:
6951: if (!$udom || !$uname || !$file) {
6952: # unable to handle the uri
6953: return ();
6954: }
1.956 raeburn 6955: my $getpropath;
6956: if ($file =~ /^userfiles\//) {
6957: $getpropath = 1;
6958: }
1.955 raeburn 6959: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 6960: my @stats = split('&', $result);
1.721 banghart 6961:
1.712 albertel 6962: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6963: shift(@stats); #filename is first
6964: return @stats;
6965: }
6966: return ();
6967: }
6968:
1.26 www 6969: # -------------------------------------------------------- Value of a Condition
6970:
1.713 albertel 6971: # gets the value of a specific preevaluated condition
6972: # stored in the string $env{user.state.<cid>}
6973: # or looks up a condition reference in the bighash and if if hasn't
6974: # already been evaluated recurses into docondval to get the value of
6975: # the condition, then memoizing it to
6976: # $env{user.state.<cid>.<condition>}
1.40 www 6977: sub directcondval {
6978: my $number=shift;
1.620 albertel 6979: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 6980: &Apache::lonuserstate::evalstate();
6981: }
1.713 albertel 6982: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
6983: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
6984: } elsif ($number =~ /^_/) {
6985: my $sub_condition;
6986: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6987: &GDBM_READER(),0640)) {
6988: $sub_condition=$bighash{'conditions'.$number};
6989: untie(%bighash);
6990: }
6991: my $value = &docondval($sub_condition);
1.949 raeburn 6992: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 6993: return $value;
6994: }
1.620 albertel 6995: if ($env{'user.state.'.$env{'request.course.id'}}) {
6996: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 6997: } else {
6998: return 2;
6999: }
7000: }
7001:
1.713 albertel 7002: # get the collection of conditions for this resource
1.26 www 7003: sub condval {
7004: my $condidx=shift;
1.54 www 7005: my $allpathcond='';
1.713 albertel 7006: foreach my $cond (split(/\|/,$condidx)) {
7007: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7008: $allpathcond.=
7009: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7010: }
1.191 harris41 7011: }
1.54 www 7012: $allpathcond=~s/\|$//;
1.713 albertel 7013: return &docondval($allpathcond);
7014: }
7015:
7016: #evaluates an expression of conditions
7017: sub docondval {
7018: my ($allpathcond) = @_;
7019: my $result=0;
7020: if ($env{'request.course.id'}
7021: && defined($allpathcond)) {
7022: my $operand='|';
7023: my @stack;
7024: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7025: if ($chunk eq '(') {
7026: push @stack,($operand,$result);
7027: } elsif ($chunk eq ')') {
7028: my $before=pop @stack;
7029: if (pop @stack eq '&') {
7030: $result=$result>$before?$before:$result;
7031: } else {
7032: $result=$result>$before?$result:$before;
7033: }
7034: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7035: $operand=$chunk;
7036: } else {
7037: my $new=directcondval($chunk);
7038: if ($operand eq '&') {
7039: $result=$result>$new?$new:$result;
7040: } else {
7041: $result=$result>$new?$result:$new;
7042: }
7043: }
7044: }
1.26 www 7045: }
7046: return $result;
1.421 albertel 7047: }
7048:
7049: # ---------------------------------------------------- Devalidate courseresdata
7050:
7051: sub devalidatecourseresdata {
7052: my ($coursenum,$coursedomain)=@_;
7053: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7054: &devalidate_cache_new('courseres',$hashid);
1.28 www 7055: }
7056:
1.763 www 7057:
1.200 www 7058: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7059: #
7060: # Parameters:
7061: # $coursenum - Number of the course.
7062: # $coursedomain - Domain at which the course was created.
7063: # Returns:
7064: # A hash of the course parameters along (I think) with timestamps
7065: # and version info.
1.877 foxr 7066:
1.624 albertel 7067: sub get_courseresdata {
7068: my ($coursenum,$coursedomain)=@_;
1.200 www 7069: my $coursehom=&homeserver($coursenum,$coursedomain);
7070: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7071: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7072: my %dumpreply;
1.417 albertel 7073: unless (defined($cached)) {
1.624 albertel 7074: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7075: $result=\%dumpreply;
1.251 albertel 7076: my ($tmp) = keys(%dumpreply);
7077: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7078: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7079: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7080: return $tmp;
1.416 albertel 7081: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7082: $result=undef;
1.599 albertel 7083: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7084: }
7085: }
1.624 albertel 7086: return $result;
7087: }
7088:
1.633 albertel 7089: sub devalidateuserresdata {
7090: my ($uname,$udom)=@_;
7091: my $hashid="$udom:$uname";
7092: &devalidate_cache_new('userres',$hashid);
7093: }
7094:
1.624 albertel 7095: sub get_userresdata {
7096: my ($uname,$udom)=@_;
7097: #most student don\'t have any data set, check if there is some data
7098: if (&EXT_cache_status($udom,$uname)) { return undef; }
7099:
7100: my $hashid="$udom:$uname";
7101: my ($result,$cached)=&is_cached_new('userres',$hashid);
7102: if (!defined($cached)) {
7103: my %resourcedata=&dump('resourcedata',$udom,$uname);
7104: $result=\%resourcedata;
7105: &do_cache_new('userres',$hashid,$result,600);
7106: }
7107: my ($tmp)=keys(%$result);
7108: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7109: return $result;
7110: }
7111: #error 2 occurs when the .db doesn't exist
7112: if ($tmp!~/error: 2 /) {
1.672 albertel 7113: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7114: " Trying to get resource data for ".
7115: $uname." at ".$udom.": ".
7116: $tmp."</font>");
7117: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7118: #&EXT_cache_set($udom,$uname);
7119: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7120: undef($tmp); # not really an error so don't send it back
1.624 albertel 7121: }
7122: return $tmp;
7123: }
1.879 foxr 7124: #----------------------------------------------- resdata - return resource data
7125: # Purpose:
7126: # Return resource data for either users or for a course.
7127: # Parameters:
7128: # $name - Course/user name.
7129: # $domain - Name of the domain the user/course is registered on.
7130: # $type - Type of thing $name is (must be 'course' or 'user'
7131: # @which - Array of names of resources desired.
7132: # Returns:
7133: # The value of the first reasource in @which that is found in the
7134: # resource hash.
7135: # Exceptional Conditions:
7136: # If the $type passed in is not valid (not the string 'course' or
7137: # 'user', an undefined reference is returned.
7138: # If none of the resources are found, an undef is returned
1.624 albertel 7139: sub resdata {
7140: my ($name,$domain,$type,@which)=@_;
7141: my $result;
7142: if ($type eq 'course') {
7143: $result=&get_courseresdata($name,$domain);
7144: } elsif ($type eq 'user') {
7145: $result=&get_userresdata($name,$domain);
7146: }
7147: if (!ref($result)) { return $result; }
1.251 albertel 7148: foreach my $item (@which) {
1.927 albertel 7149: if (defined($result->{$item->[0]})) {
7150: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7151: }
1.250 albertel 7152: }
1.291 albertel 7153: return undef;
1.200 www 7154: }
7155:
1.379 matthew 7156: #
7157: # EXT resource caching routines
7158: #
7159:
7160: sub clear_EXT_cache_status {
1.383 albertel 7161: &delenv('cache.EXT.');
1.379 matthew 7162: }
7163:
7164: sub EXT_cache_status {
7165: my ($target_domain,$target_user) = @_;
1.383 albertel 7166: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7167: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7168: # We know already the user has no data
7169: return 1;
7170: } else {
7171: return 0;
7172: }
7173: }
7174:
7175: sub EXT_cache_set {
7176: my ($target_domain,$target_user) = @_;
1.383 albertel 7177: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7178: #&appenv({$cachename => time});
1.379 matthew 7179: }
7180:
1.28 www 7181: # --------------------------------------------------------- Value of a Variable
1.58 www 7182: sub EXT {
1.715 albertel 7183:
1.395 albertel 7184: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7185: unless ($varname) { return ''; }
1.218 albertel 7186: #get real user name/domain, courseid and symb
7187: my $courseid;
1.359 albertel 7188: my $publicuser;
1.427 www 7189: if ($symbparm) {
7190: $symbparm=&get_symb_from_alias($symbparm);
7191: }
1.218 albertel 7192: if (!($uname && $udom)) {
1.790 albertel 7193: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7194: if (!$symbparm) { $symbparm=$cursymb; }
7195: } else {
1.620 albertel 7196: $courseid=$env{'request.course.id'};
1.218 albertel 7197: }
1.48 www 7198: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7199: my $rest;
1.320 albertel 7200: if (defined($therest[0])) {
1.48 www 7201: $rest=join('.',@therest);
7202: } else {
7203: $rest='';
7204: }
1.320 albertel 7205:
1.57 www 7206: my $qualifierrest=$qualifier;
7207: if ($rest) { $qualifierrest.='.'.$rest; }
7208: my $spacequalifierrest=$space;
7209: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7210: if ($realm eq 'user') {
1.48 www 7211: # --------------------------------------------------------------- user.resource
7212: if ($space eq 'resource') {
1.651 albertel 7213: if ( (defined($Apache::lonhomework::parsing_a_problem)
7214: || defined($Apache::lonhomework::parsing_a_task))
7215: &&
1.744 albertel 7216: ($symbparm eq &symbread()) ) {
7217: # if we are in the middle of processing the resource the
7218: # get the value we are planning on committing
7219: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7220: return $Apache::lonhomework::results{$qualifierrest};
7221: } else {
7222: return $Apache::lonhomework::history{$qualifierrest};
7223: }
1.335 albertel 7224: } else {
1.359 albertel 7225: my %restored;
1.620 albertel 7226: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7227: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7228: } else {
7229: %restored=&restore($symbparm,$courseid,$udom,$uname);
7230: }
1.335 albertel 7231: return $restored{$qualifierrest};
7232: }
1.48 www 7233: # ----------------------------------------------------------------- user.access
7234: } elsif ($space eq 'access') {
1.218 albertel 7235: # FIXME - not supporting calls for a specific user
1.48 www 7236: return &allowed($qualifier,$rest);
7237: # ------------------------------------------ user.preferences, user.environment
7238: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7239: if (($uname eq $env{'user.name'}) &&
7240: ($udom eq $env{'user.domain'})) {
7241: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7242: } else {
1.359 albertel 7243: my %returnhash;
7244: if (!$publicuser) {
7245: %returnhash=&userenvironment($udom,$uname,
7246: $qualifierrest);
7247: }
1.218 albertel 7248: return $returnhash{$qualifierrest};
7249: }
1.48 www 7250: # ----------------------------------------------------------------- user.course
7251: } elsif ($space eq 'course') {
1.218 albertel 7252: # FIXME - not supporting calls for a specific user
1.620 albertel 7253: return $env{join('.',('request.course',$qualifier))};
1.48 www 7254: # ------------------------------------------------------------------- user.role
7255: } elsif ($space eq 'role') {
1.218 albertel 7256: # FIXME - not supporting calls for a specific user
1.620 albertel 7257: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7258: if ($qualifier eq 'value') {
7259: return $role;
7260: } elsif ($qualifier eq 'extent') {
7261: return $where;
7262: }
7263: # ----------------------------------------------------------------- user.domain
7264: } elsif ($space eq 'domain') {
1.218 albertel 7265: return $udom;
1.48 www 7266: # ------------------------------------------------------------------- user.name
7267: } elsif ($space eq 'name') {
1.218 albertel 7268: return $uname;
1.48 www 7269: # ---------------------------------------------------- Any other user namespace
1.29 www 7270: } else {
1.359 albertel 7271: my %reply;
7272: if (!$publicuser) {
7273: %reply=&get($space,[$qualifierrest],$udom,$uname);
7274: }
7275: return $reply{$qualifierrest};
1.48 www 7276: }
1.236 www 7277: } elsif ($realm eq 'query') {
7278: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7279: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7280: [$spacequalifierrest]);
1.620 albertel 7281: return $env{'form.'.$spacequalifierrest};
1.236 www 7282: } elsif ($realm eq 'request') {
1.48 www 7283: # ------------------------------------------------------------- request.browser
7284: if ($space eq 'browser') {
1.430 www 7285: if ($qualifier eq 'textremote') {
1.676 albertel 7286: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7287: return 1;
7288: } else {
7289: return 0;
7290: }
7291: } else {
1.620 albertel 7292: return $env{'browser.'.$qualifier};
1.430 www 7293: }
1.57 www 7294: # ------------------------------------------------------------ request.filename
7295: } else {
1.620 albertel 7296: return $env{'request.'.$spacequalifierrest};
1.29 www 7297: }
1.28 www 7298: } elsif ($realm eq 'course') {
1.48 www 7299: # ---------------------------------------------------------- course.description
1.620 albertel 7300: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7301: } elsif ($realm eq 'resource') {
1.165 www 7302:
1.620 albertel 7303: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7304: if (!$symbparm) { $symbparm=&symbread(); }
7305: }
1.693 albertel 7306:
7307: if ($space eq 'title') {
7308: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7309: return &gettitle($symbparm);
7310: }
7311:
7312: if ($space eq 'map') {
7313: my ($map) = &decode_symb($symbparm);
7314: return &symbread($map);
7315: }
1.905 albertel 7316: if ($space eq 'filename') {
7317: if ($symbparm) {
7318: return &clutter((&decode_symb($symbparm))[2]);
7319: }
7320: return &hreflocation('',$env{'request.filename'});
7321: }
1.693 albertel 7322:
7323: my ($section, $group, @groups);
1.593 albertel 7324: my ($courselevelm,$courselevel);
1.539 albertel 7325: if ($symbparm && defined($courseid) &&
1.620 albertel 7326: $courseid eq $env{'request.course.id'}) {
1.165 www 7327:
1.218 albertel 7328: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 7329:
1.60 www 7330: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 7331: my $symbp=$symbparm;
1.735 albertel 7332: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 7333:
7334: my $symbparm=$symbp.'.'.$spacequalifierrest;
7335: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7336:
1.620 albertel 7337: if (($env{'user.name'} eq $uname) &&
7338: ($env{'user.domain'} eq $udom)) {
7339: $section=$env{'request.course.sec'};
1.733 raeburn 7340: @groups = split(/:/,$env{'request.course.groups'});
7341: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 7342: } else {
1.539 albertel 7343: if (! defined($usection)) {
1.551 albertel 7344: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 7345: } else {
7346: $section = $usection;
7347: }
1.733 raeburn 7348: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 7349: }
7350:
7351: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7352: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7353: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7354:
1.593 albertel 7355: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 7356: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 7357: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 7358:
1.60 www 7359: # ----------------------------------------------------------- first, check user
1.624 albertel 7360:
7361: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 7362: ([$courselevelr,'resource'],
7363: [$courselevelm,'map' ],
7364: [$courselevel, 'course' ]));
1.931 albertel 7365: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 7366:
1.594 albertel 7367: # ------------------------------------------------ second, check some of course
1.684 raeburn 7368: my $coursereply;
1.691 raeburn 7369: if (@groups > 0) {
7370: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7371: $mapparm,$spacequalifierrest);
1.927 albertel 7372: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 7373: }
1.96 www 7374:
1.684 raeburn 7375: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 7376: $env{'course.'.$courseid.'.domain'},
7377: 'course',
7378: ([$seclevelr, 'resource'],
7379: [$seclevelm, 'map' ],
7380: [$seclevel, 'course' ],
7381: [$courselevelr,'resource']));
7382: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 7383:
1.60 www 7384: # ------------------------------------------------------ third, check map parms
1.218 albertel 7385: my %parmhash=();
7386: my $thisparm='';
7387: if (tie(%parmhash,'GDBM_File',
1.620 albertel 7388: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 7389: &GDBM_READER(),0640)) {
1.218 albertel 7390: $thisparm=$parmhash{$symbparm};
7391: untie(%parmhash);
7392: }
1.927 albertel 7393: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 7394: }
1.594 albertel 7395: # ------------------------------------------ fourth, look in resource metadata
1.71 www 7396:
1.218 albertel 7397: $spacequalifierrest=~s/\./\_/;
1.282 albertel 7398: my $filename;
7399: if (!$symbparm) { $symbparm=&symbread(); }
7400: if ($symbparm) {
1.409 www 7401: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 7402: } else {
1.620 albertel 7403: $filename=$env{'request.filename'};
1.282 albertel 7404: }
7405: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 7406: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 7407: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 7408: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 7409:
1.927 albertel 7410: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 7411: if ($symbparm && defined($courseid) &&
1.620 albertel 7412: $courseid eq $env{'request.course.id'}) {
1.624 albertel 7413: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7414: $env{'course.'.$courseid.'.domain'},
7415: 'course',
1.927 albertel 7416: ([$courselevelm,'map' ],
7417: [$courselevel, 'course']));
7418: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 7419: }
1.145 www 7420: # ------------------------------------------------------------------ Cascade up
1.218 albertel 7421: unless ($space eq '0') {
1.336 albertel 7422: my @parts=split(/_/,$space);
7423: my $id=pop(@parts);
7424: my $part=join('_',@parts);
7425: if ($part eq '') { $part='0'; }
1.927 albertel 7426: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 7427: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 7428: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 7429: }
1.395 albertel 7430: if ($recurse) { return undef; }
7431: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 7432: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 7433: # ---------------------------------------------------- Any other user namespace
7434: } elsif ($realm eq 'environment') {
7435: # ----------------------------------------------------------------- environment
1.620 albertel 7436: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7437: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 7438: } else {
1.770 albertel 7439: if ($uname eq 'anonymous' && $udom eq '') {
7440: return '';
7441: }
1.219 albertel 7442: my %returnhash=&userenvironment($udom,$uname,
7443: $spacequalifierrest);
7444: return $returnhash{$spacequalifierrest};
7445: }
1.28 www 7446: } elsif ($realm eq 'system') {
1.48 www 7447: # ----------------------------------------------------------------- system.time
7448: if ($space eq 'time') {
7449: return time;
7450: }
1.696 albertel 7451: } elsif ($realm eq 'server') {
7452: # ----------------------------------------------------------------- system.time
7453: if ($space eq 'name') {
7454: return $ENV{'SERVER_NAME'};
7455: }
1.28 www 7456: }
1.48 www 7457: return '';
1.61 www 7458: }
7459:
1.927 albertel 7460: sub get_reply {
7461: my ($reply_value) = @_;
1.940 raeburn 7462: if (ref($reply_value) eq 'ARRAY') {
7463: if (wantarray) {
7464: return @$reply_value;
7465: }
7466: return $reply_value->[0];
7467: } else {
7468: return $reply_value;
1.927 albertel 7469: }
7470: }
7471:
1.691 raeburn 7472: sub check_group_parms {
7473: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
7474: my @groupitems = ();
7475: my $resultitem;
1.927 albertel 7476: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 7477: foreach my $group (@{$groups}) {
7478: foreach my $level (@levels) {
1.927 albertel 7479: my $item = $courseid.'.['.$group.'].'.$level->[0];
7480: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 7481: }
7482: }
7483: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
7484: $env{'course.'.$courseid.'.domain'},
7485: 'course',@groupitems);
7486: return $coursereply;
7487: }
7488:
7489: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 7490: my ($courseid,@groups) = @_;
7491: @groups = sort(@groups);
1.691 raeburn 7492: return @groups;
7493: }
7494:
1.395 albertel 7495: sub packages_tab_default {
7496: my ($uri,$varname)=@_;
7497: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 7498:
7499: my (@extension,@specifics,$do_default);
7500: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 7501: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 7502: if ($pack_type eq 'default') {
7503: $do_default=1;
7504: } elsif ($pack_type eq 'extension') {
7505: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 7506: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 7507: # only look at packages defaults for packages that this id is
1.738 albertel 7508: push(@specifics,[$package,$pack_type,$pack_part]);
7509: }
7510: }
7511: # first look for a package that matches the requested part id
7512: foreach my $package (@specifics) {
7513: my (undef,$pack_type,$pack_part)=@{$package};
7514: next if ($pack_part ne $part);
7515: if (defined($packagetab{"$pack_type&$name&default"})) {
7516: return $packagetab{"$pack_type&$name&default"};
7517: }
7518: }
7519: # look for any possible matching non extension_ package
7520: foreach my $package (@specifics) {
7521: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 7522: if (defined($packagetab{"$pack_type&$name&default"})) {
7523: return $packagetab{"$pack_type&$name&default"};
7524: }
1.585 albertel 7525: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 7526: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
7527: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 7528: }
7529: }
1.738 albertel 7530: # look for any posible extension_ match
7531: foreach my $package (@extension) {
7532: my ($package,$pack_type)=@{$package};
7533: if (defined($packagetab{"$pack_type&$name&default"})) {
7534: return $packagetab{"$pack_type&$name&default"};
7535: }
7536: if (defined($packagetab{$package."&$name&default"})) {
7537: return $packagetab{$package."&$name&default"};
7538: }
7539: }
7540: # look for a global default setting
7541: if ($do_default && defined($packagetab{"default&$name&default"})) {
7542: return $packagetab{"default&$name&default"};
7543: }
1.395 albertel 7544: return undef;
7545: }
7546:
1.334 albertel 7547: sub add_prefix_and_part {
7548: my ($prefix,$part)=@_;
7549: my $keyroot;
7550: if (defined($prefix) && $prefix !~ /^__/) {
7551: # prefix that has a part already
7552: $keyroot=$prefix;
7553: } elsif (defined($prefix)) {
7554: # prefix that is missing a part
7555: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
7556: } else {
7557: # no prefix at all
7558: if (defined($part)) { $keyroot='_'.$part; }
7559: }
7560: return $keyroot;
7561: }
7562:
1.71 www 7563: # ---------------------------------------------------------------- Get metadata
7564:
1.599 albertel 7565: my %metaentry;
1.71 www 7566: sub metadata {
1.176 www 7567: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 7568: $uri=&declutter($uri);
1.288 albertel 7569: # if it is a non metadata possible uri return quickly
1.529 albertel 7570: if (($uri eq '') ||
7571: (($uri =~ m|^/*adm/|) &&
1.698 albertel 7572: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 7573: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
7574: return undef;
7575: }
7576: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
7577: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 7578: return undef;
1.288 albertel 7579: }
1.73 www 7580: my $filename=$uri;
7581: $uri=~s/\.meta$//;
1.172 www 7582: #
7583: # Is the metadata already cached?
1.177 www 7584: # Look at timestamp of caching
1.172 www 7585: # Everything is cached by the main uri, libraries are never directly cached
7586: #
1.428 albertel 7587: if (!defined($liburi)) {
1.599 albertel 7588: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 7589: if (defined($cached)) { return $result->{':'.$what}; }
7590: }
7591: {
1.172 www 7592: #
7593: # Is this a recursive call for a library?
7594: #
1.599 albertel 7595: # if (! exists($metacache{$uri})) {
7596: # $metacache{$uri}={};
7597: # }
1.924 albertel 7598: my $cachetime = 60*60;
1.171 www 7599: if ($liburi) {
7600: $liburi=&declutter($liburi);
7601: $filename=$liburi;
1.401 bowersj2 7602: } else {
1.599 albertel 7603: &devalidate_cache_new('meta',$uri);
7604: undef(%metaentry);
1.401 bowersj2 7605: }
1.140 www 7606: my %metathesekeys=();
1.73 www 7607: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 7608: my $metastring;
1.924 albertel 7609: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 7610: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 7611: $metastring =
1.929 albertel 7612: &Apache::lonnet::ssi_body($which,
1.924 albertel 7613: ('grade_target' => 'meta'));
7614: $cachetime = 1; # only want this cached in the child not long term
7615: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 7616: my $file=&filelocation('',&clutter($filename));
1.599 albertel 7617: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 7618: $metastring=&getfile($file);
1.489 albertel 7619: }
1.208 albertel 7620: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 7621: my $token;
1.140 www 7622: undef %metathesekeys;
1.71 www 7623: while ($token=$parser->get_token) {
1.339 albertel 7624: if ($token->[0] eq 'S') {
7625: if (defined($token->[2]->{'package'})) {
1.172 www 7626: #
7627: # This is a package - get package info
7628: #
1.339 albertel 7629: my $package=$token->[2]->{'package'};
7630: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7631: if (defined($token->[2]->{'id'})) {
7632: $keyroot.='_'.$token->[2]->{'id'};
7633: }
1.599 albertel 7634: if ($metaentry{':packages'}) {
7635: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 7636: } else {
1.599 albertel 7637: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 7638: }
1.736 albertel 7639: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 7640: my $part=$keyroot;
7641: $part=~s/^\_//;
1.736 albertel 7642: if ($pack_entry=~/^\Q$package\E\&/ ||
7643: $pack_entry=~/^\Q$package\E_0\&/) {
7644: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 7645: # ignore package.tab specified default values
7646: # here &package_tab_default() will fetch those
7647: if ($subp eq 'default') { next; }
1.736 albertel 7648: my $value=$packagetab{$pack_entry};
1.432 albertel 7649: my $unikey;
7650: if ($pack =~ /_0$/) {
7651: $unikey='parameter_0_'.$name;
7652: $part=0;
7653: } else {
7654: $unikey='parameter'.$keyroot.'_'.$name;
7655: }
1.339 albertel 7656: if ($subp eq 'display') {
7657: $value.=' [Part: '.$part.']';
7658: }
1.599 albertel 7659: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 7660: $metathesekeys{$unikey}=1;
1.599 albertel 7661: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7662: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 7663: }
1.599 albertel 7664: if (defined($metaentry{':'.$unikey.'.default'})) {
7665: $metaentry{':'.$unikey}=
7666: $metaentry{':'.$unikey.'.default'};
1.356 albertel 7667: }
1.339 albertel 7668: }
7669: }
7670: } else {
1.172 www 7671: #
7672: # This is not a package - some other kind of start tag
1.339 albertel 7673: #
7674: my $entry=$token->[1];
7675: my $unikey;
7676: if ($entry eq 'import') {
7677: $unikey='';
7678: } else {
7679: $unikey=$entry;
7680: }
7681: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7682:
7683: if (defined($token->[2]->{'id'})) {
7684: $unikey.='_'.$token->[2]->{'id'};
7685: }
1.175 www 7686:
1.339 albertel 7687: if ($entry eq 'import') {
1.175 www 7688: #
7689: # Importing a library here
1.339 albertel 7690: #
7691: if ($depthcount<20) {
7692: my $location=$parser->get_text('/import');
7693: my $dir=$filename;
7694: $dir=~s|[^/]*$||;
7695: $location=&filelocation($dir,$location);
1.736 albertel 7696: my $metadata =
7697: &metadata($uri,'keys', $location,$unikey,
7698: $depthcount+1);
7699: foreach my $meta (split(',',$metadata)) {
7700: $metaentry{':'.$meta}=$metaentry{':'.$meta};
7701: $metathesekeys{$meta}=1;
1.339 albertel 7702: }
7703: }
7704: } else {
7705:
7706: if (defined($token->[2]->{'name'})) {
7707: $unikey.='_'.$token->[2]->{'name'};
7708: }
7709: $metathesekeys{$unikey}=1;
1.736 albertel 7710: foreach my $param (@{$token->[3]}) {
7711: $metaentry{':'.$unikey.'.'.$param} =
7712: $token->[2]->{$param};
1.339 albertel 7713: }
7714: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 7715: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 7716: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
7717: # only ws inside the tag, and not in default, so use default
7718: # as value
1.599 albertel 7719: $metaentry{':'.$unikey}=$default;
1.908 albertel 7720: } elsif ( $internaltext =~ /\S/ ) {
7721: # something interesting inside the tag
7722: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 7723: } else {
1.908 albertel 7724: # no interesting values, don't set a default
1.339 albertel 7725: }
1.172 www 7726: # end of not-a-package not-a-library import
1.339 albertel 7727: }
1.172 www 7728: # end of not-a-package start tag
1.339 albertel 7729: }
1.172 www 7730: # the next is the end of "start tag"
1.339 albertel 7731: }
7732: }
1.483 albertel 7733: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 7734: $extension = lc($extension);
7735: if ($extension eq 'htm') { $extension='html'; }
7736:
1.737 albertel 7737: foreach my $key (keys(%packagetab)) {
1.483 albertel 7738: #no specific packages #how's our extension
7739: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 7740: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 7741: \%metathesekeys);
7742: }
1.883 albertel 7743:
7744: if (!exists($metaentry{':packages'})
7745: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 7746: foreach my $key (keys(%packagetab)) {
1.483 albertel 7747: #no specific packages well let's get default then
7748: if ($key!~/^default&/) { next; }
1.488 albertel 7749: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 7750: \%metathesekeys);
7751: }
7752: }
1.338 www 7753: # are there custom rights to evaluate
1.599 albertel 7754: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 7755:
1.338 www 7756: #
7757: # Importing a rights file here
1.339 albertel 7758: #
7759: unless ($depthcount) {
1.599 albertel 7760: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 7761: my $dir=$filename;
7762: $dir=~s|[^/]*$||;
7763: $location=&filelocation($dir,$location);
1.736 albertel 7764: my $rights_metadata =
7765: &metadata($uri,'keys',$location,'_rights',
7766: $depthcount+1);
7767: foreach my $rights (split(',',$rights_metadata)) {
7768: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
7769: $metathesekeys{$rights}=1;
1.339 albertel 7770: }
7771: }
7772: }
1.737 albertel 7773: # uniqifiy package listing
7774: my %seen;
7775: my @uniq_packages =
7776: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
7777: $metaentry{':packages'} = join(',',@uniq_packages);
7778:
7779: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 7780: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
7781: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 7782: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 7783: # this is the end of "was not already recently cached
1.71 www 7784: }
1.599 albertel 7785: return $metaentry{':'.$what};
1.261 albertel 7786: }
7787:
1.488 albertel 7788: sub metadata_create_package_def {
1.483 albertel 7789: my ($uri,$key,$package,$metathesekeys)=@_;
7790: my ($pack,$name,$subp)=split(/\&/,$key);
7791: if ($subp eq 'default') { next; }
7792:
1.599 albertel 7793: if (defined($metaentry{':packages'})) {
7794: $metaentry{':packages'}.=','.$package;
1.483 albertel 7795: } else {
1.599 albertel 7796: $metaentry{':packages'}=$package;
1.483 albertel 7797: }
7798: my $value=$packagetab{$key};
7799: my $unikey;
7800: $unikey='parameter_0_'.$name;
1.599 albertel 7801: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 7802: $$metathesekeys{$unikey}=1;
1.599 albertel 7803: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7804: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 7805: }
1.599 albertel 7806: if (defined($metaentry{':'.$unikey.'.default'})) {
7807: $metaentry{':'.$unikey}=
7808: $metaentry{':'.$unikey.'.default'};
1.483 albertel 7809: }
7810: }
7811:
1.261 albertel 7812: sub metadata_generate_part0 {
7813: my ($metadata,$metacache,$uri) = @_;
7814: my %allnames;
1.737 albertel 7815: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 7816: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 7817: my $part=$$metacache{':'.$metakey.'.part'};
7818: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 7819: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 7820: $allnames{$name}=$part;
7821: }
7822: }
7823: }
7824: foreach my $name (keys(%allnames)) {
7825: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 7826: my $key=":parameter_0_$name";
1.261 albertel 7827: $$metacache{"$key.part"}='0';
7828: $$metacache{"$key.name"}=$name;
1.428 albertel 7829: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 7830: $allnames{$name}.'_'.$name.
7831: '.type'};
1.428 albertel 7832: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 7833: '.display'};
1.644 www 7834: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 7835: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 7836: $$metacache{"$key.display"}=$olddis;
7837: }
1.71 www 7838: }
7839:
1.764 albertel 7840: # ------------------------------------------------------ Devalidate title cache
7841:
7842: sub devalidate_title_cache {
7843: my ($url)=@_;
7844: if (!$env{'request.course.id'}) { return; }
7845: my $symb=&symbread($url);
7846: if (!$symb) { return; }
7847: my $key=$env{'request.course.id'}."\0".$symb;
7848: &devalidate_cache_new('title',$key);
7849: }
7850:
1.301 www 7851: # ------------------------------------------------- Get the title of a resource
7852:
7853: sub gettitle {
7854: my $urlsymb=shift;
7855: my $symb=&symbread($urlsymb);
1.534 albertel 7856: if ($symb) {
1.620 albertel 7857: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 7858: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 7859: if (defined($cached)) {
7860: return $result;
7861: }
1.534 albertel 7862: my ($map,$resid,$url)=&decode_symb($symb);
7863: my $title='';
1.907 albertel 7864: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
7865: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
7866: } else {
7867: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7868: &GDBM_READER(),0640)) {
7869: my $mapid=$bighash{'map_pc_'.&clutter($map)};
7870: $title=$bighash{'title_'.$mapid.'.'.$resid};
7871: untie(%bighash);
7872: }
1.534 albertel 7873: }
7874: $title=~s/\&colon\;/\:/gs;
7875: if ($title) {
1.599 albertel 7876: return &do_cache_new('title',$key,$title,600);
1.534 albertel 7877: }
7878: $urlsymb=$url;
7879: }
7880: my $title=&metadata($urlsymb,'title');
7881: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
7882: return $title;
1.301 www 7883: }
1.613 albertel 7884:
1.614 albertel 7885: sub get_slot {
7886: my ($which,$cnum,$cdom)=@_;
7887: if (!$cnum || !$cdom) {
1.790 albertel 7888: (undef,my $courseid)=&whichuser();
1.620 albertel 7889: $cdom=$env{'course.'.$courseid.'.domain'};
7890: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 7891: }
1.703 albertel 7892: my $key=join("\0",'slots',$cdom,$cnum,$which);
7893: my %slotinfo;
7894: if (exists($remembered{$key})) {
7895: $slotinfo{$which} = $remembered{$key};
7896: } else {
7897: %slotinfo=&get('slots',[$which],$cdom,$cnum);
7898: &Apache::lonhomework::showhash(%slotinfo);
7899: my ($tmp)=keys(%slotinfo);
7900: if ($tmp=~/^error:/) { return (); }
7901: $remembered{$key} = $slotinfo{$which};
7902: }
1.616 albertel 7903: if (ref($slotinfo{$which}) eq 'HASH') {
7904: return %{$slotinfo{$which}};
7905: }
7906: return $slotinfo{$which};
1.614 albertel 7907: }
1.31 www 7908: # ------------------------------------------------- Update symbolic store links
7909:
7910: sub symblist {
7911: my ($mapname,%newhash)=@_;
1.438 www 7912: $mapname=&deversion(&declutter($mapname));
1.31 www 7913: my %hash;
1.620 albertel 7914: if (($env{'request.course.fn'}) && (%newhash)) {
7915: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 7916: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 7917: foreach my $url (keys(%newhash)) {
1.711 albertel 7918: next if ($url eq 'last_known'
7919: && $env{'form.no_update_last_known'});
7920: $hash{declutter($url)}=&encode_symb($mapname,
7921: $newhash{$url}->[1],
7922: $newhash{$url}->[0]);
1.191 harris41 7923: }
1.31 www 7924: if (untie(%hash)) {
7925: return 'ok';
7926: }
7927: }
7928: }
7929: return 'error';
1.212 www 7930: }
7931:
7932: # --------------------------------------------------------------- Verify a symb
7933:
7934: sub symbverify {
1.510 www 7935: my ($symb,$thisurl)=@_;
7936: my $thisfn=$thisurl;
1.439 www 7937: $thisfn=&declutter($thisfn);
1.215 www 7938: # direct jump to resource in page or to a sequence - will construct own symbs
7939: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
7940: # check URL part
1.409 www 7941: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 7942:
1.431 www 7943: unless ($url eq $thisfn) { return 0; }
1.213 www 7944:
1.216 www 7945: $symb=&symbclean($symb);
1.510 www 7946: $thisurl=&deversion($thisurl);
1.439 www 7947: $thisfn=&deversion($thisfn);
1.213 www 7948:
7949: my %bighash;
7950: my $okay=0;
1.431 www 7951:
1.620 albertel 7952: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 7953: &GDBM_READER(),0640)) {
1.510 www 7954: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 7955: unless ($ids) {
1.510 www 7956: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 7957: }
7958: if ($ids) {
7959: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 7960: foreach my $id (split(/\,/,$ids)) {
7961: my ($mapid,$resid)=split(/\./,$id);
1.216 www 7962: if (
7963: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
7964: eq $symb) {
1.620 albertel 7965: if (($env{'request.role.adv'}) ||
1.800 albertel 7966: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 7967: $okay=1;
7968: }
7969: }
1.216 www 7970: }
7971: }
1.213 www 7972: untie(%bighash);
7973: }
7974: return $okay;
1.31 www 7975: }
7976:
1.210 www 7977: # --------------------------------------------------------------- Clean-up symb
7978:
7979: sub symbclean {
7980: my $symb=shift;
1.568 albertel 7981: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 7982: # remove version from map
7983: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 7984:
1.210 www 7985: # remove version from URL
7986: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 7987:
1.507 www 7988: # remove wrapper
7989:
1.510 www 7990: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 7991: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 7992: return $symb;
1.409 www 7993: }
7994:
7995: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 7996:
7997: sub encode_symb {
7998: my ($map,$resid,$url)=@_;
7999: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8000: }
1.409 www 8001:
8002: sub decode_symb {
1.568 albertel 8003: my $symb=shift;
8004: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8005: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8006: return (&fixversion($map),$resid,&fixversion($url));
8007: }
8008:
8009: sub fixversion {
8010: my $fn=shift;
1.609 banghart 8011: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8012: my %bighash;
8013: my $uri=&clutter($fn);
1.620 albertel 8014: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8015: # is this cached?
1.599 albertel 8016: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8017: if (defined($cached)) { return $result; }
8018: # unfortunately not cached, or expired
1.620 albertel 8019: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8020: &GDBM_READER(),0640)) {
8021: if ($bighash{'version_'.$uri}) {
8022: my $version=$bighash{'version_'.$uri};
1.444 www 8023: unless (($version eq 'mostrecent') ||
8024: ($version==&getversion($uri))) {
1.440 www 8025: $uri=~s/\.(\w+)$/\.$version\.$1/;
8026: }
8027: }
8028: untie %bighash;
1.413 www 8029: }
1.599 albertel 8030: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8031: }
8032:
8033: sub deversion {
8034: my $url=shift;
8035: $url=~s/\.\d+\.(\w+)$/\.$1/;
8036: return $url;
1.210 www 8037: }
8038:
1.31 www 8039: # ------------------------------------------------------ Return symb list entry
8040:
8041: sub symbread {
1.249 www 8042: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8043: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8044: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8045: # no filename provided? try from environment
1.44 www 8046: unless ($thisfn) {
1.620 albertel 8047: if ($env{'request.symb'}) {
8048: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8049: }
1.620 albertel 8050: $thisfn=$env{'request.filename'};
1.44 www 8051: }
1.569 albertel 8052: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8053: # is that filename actually a symb? Verify, clean, and return
8054: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8055: if (&symbverify($thisfn,$1)) {
1.620 albertel 8056: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8057: }
1.242 www 8058: }
1.44 www 8059: $thisfn=declutter($thisfn);
1.31 www 8060: my %hash;
1.37 www 8061: my %bighash;
8062: my $syval='';
1.620 albertel 8063: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8064: my $targetfn = $thisfn;
1.609 banghart 8065: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8066: $targetfn = 'adm/wrapper/'.$thisfn;
8067: }
1.687 albertel 8068: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8069: $targetfn=$1;
8070: }
1.620 albertel 8071: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8072: &GDBM_READER(),0640)) {
1.481 raeburn 8073: $syval=$hash{$targetfn};
1.37 www 8074: untie(%hash);
8075: }
8076: # ---------------------------------------------------------- There was an entry
8077: if ($syval) {
1.601 albertel 8078: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8079: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8080: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8081: #return $env{$cache_str}='';
1.601 albertel 8082: #}
8083: #$syval.=$1;
8084: #}
1.37 www 8085: } else {
8086: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8087: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8088: &GDBM_READER(),0640)) {
1.37 www 8089: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8090: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8091: unless ($ids) {
8092: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8093: }
8094: unless ($ids) {
8095: # alias?
8096: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8097: }
1.37 www 8098: if ($ids) {
8099: # ------------------------------------------------------------------- Has ID(s)
8100: my @possibilities=split(/\,/,$ids);
1.39 www 8101: if ($#possibilities==0) {
8102: # ----------------------------------------------- There is only one possibility
1.37 www 8103: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8104: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8105: $resid,$thisfn);
1.249 www 8106: } elsif (!$donotrecurse) {
1.39 www 8107: # ------------------------------------------ There is more than one possibility
8108: my $realpossible=0;
1.800 albertel 8109: foreach my $id (@possibilities) {
8110: my $file=$bighash{'src_'.$id};
1.39 www 8111: if (&allowed('bre',$file)) {
1.800 albertel 8112: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8113: if ($bighash{'map_type_'.$mapid} ne 'page') {
8114: $realpossible++;
1.626 albertel 8115: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8116: $resid,$thisfn);
1.39 www 8117: }
8118: }
1.191 harris41 8119: }
1.39 www 8120: if ($realpossible!=1) { $syval=''; }
1.249 www 8121: } else {
8122: $syval='';
1.37 www 8123: }
8124: }
8125: untie(%bighash)
1.481 raeburn 8126: }
1.31 www 8127: }
1.62 www 8128: if ($syval) {
1.620 albertel 8129: return $env{$cache_str}=$syval;
1.62 www 8130: }
1.31 www 8131: }
1.949 raeburn 8132: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8133: return $env{$cache_str}='';
1.31 www 8134: }
8135:
8136: # ---------------------------------------------------------- Return random seed
8137:
1.32 www 8138: sub numval {
8139: my $txt=shift;
8140: $txt=~tr/A-J/0-9/;
8141: $txt=~tr/a-j/0-9/;
8142: $txt=~tr/K-T/0-9/;
8143: $txt=~tr/k-t/0-9/;
8144: $txt=~tr/U-Z/0-5/;
8145: $txt=~tr/u-z/0-5/;
8146: $txt=~s/\D//g;
1.564 albertel 8147: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8148: return int($txt);
1.368 albertel 8149: }
8150:
1.484 albertel 8151: sub numval2 {
8152: my $txt=shift;
8153: $txt=~tr/A-J/0-9/;
8154: $txt=~tr/a-j/0-9/;
8155: $txt=~tr/K-T/0-9/;
8156: $txt=~tr/k-t/0-9/;
8157: $txt=~tr/U-Z/0-5/;
8158: $txt=~tr/u-z/0-5/;
8159: $txt=~s/\D//g;
8160: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8161: my $total;
8162: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8163: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8164: return int($total);
8165: }
8166:
1.575 albertel 8167: sub numval3 {
8168: use integer;
8169: my $txt=shift;
8170: $txt=~tr/A-J/0-9/;
8171: $txt=~tr/a-j/0-9/;
8172: $txt=~tr/K-T/0-9/;
8173: $txt=~tr/k-t/0-9/;
8174: $txt=~tr/U-Z/0-5/;
8175: $txt=~tr/u-z/0-5/;
8176: $txt=~s/\D//g;
8177: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8178: my $total;
8179: foreach my $val (@txts) { $total+=$val; }
8180: if ($_64bit) { $total=(($total<<32)>>32); }
8181: return $total;
8182: }
8183:
1.675 albertel 8184: sub digest {
8185: my ($data)=@_;
8186: my $digest=&Digest::MD5::md5($data);
8187: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8188: my ($e,$f);
8189: {
8190: use integer;
8191: $e=($a+$b);
8192: $f=($c+$d);
8193: if ($_64bit) {
8194: $e=(($e<<32)>>32);
8195: $f=(($f<<32)>>32);
8196: }
8197: }
8198: if (wantarray) {
8199: return ($e,$f);
8200: } else {
8201: my $g;
8202: {
8203: use integer;
8204: $g=($e+$f);
8205: if ($_64bit) {
8206: $g=(($g<<32)>>32);
8207: }
8208: }
8209: return $g;
8210: }
8211: }
8212:
1.368 albertel 8213: sub latest_rnd_algorithm_id {
1.675 albertel 8214: return '64bit5';
1.366 albertel 8215: }
1.32 www 8216:
1.503 albertel 8217: sub get_rand_alg {
8218: my ($courseid)=@_;
1.790 albertel 8219: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8220: if ($courseid) {
1.620 albertel 8221: return $env{"course.$courseid.rndseed"};
1.503 albertel 8222: }
8223: return &latest_rnd_algorithm_id();
8224: }
8225:
1.562 albertel 8226: sub validCODE {
8227: my ($CODE)=@_;
8228: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8229: return 0;
8230: }
8231:
1.491 albertel 8232: sub getCODE {
1.620 albertel 8233: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8234: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8235: defined($Apache::lonhomework::parsing_a_task) ) &&
8236: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8237: return $Apache::lonhomework::history{'resource.CODE'};
8238: }
8239: return undef;
8240: }
8241:
1.31 www 8242: sub rndseed {
1.155 albertel 8243: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8244: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8245: if (!defined($symb)) {
1.366 albertel 8246: unless ($symb=$wsymb) { return time; }
8247: }
8248: if (!$courseid) { $courseid=$wcourseid; }
8249: if (!$domain) { $domain=$wdomain; }
8250: if (!$username) { $username=$wusername }
1.503 albertel 8251: my $which=&get_rand_alg();
1.803 albertel 8252:
1.491 albertel 8253: if (defined(&getCODE())) {
1.675 albertel 8254: if ($which eq '64bit5') {
8255: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8256: } elsif ($which eq '64bit4') {
1.575 albertel 8257: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8258: } else {
8259: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8260: }
1.675 albertel 8261: } elsif ($which eq '64bit5') {
8262: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8263: } elsif ($which eq '64bit4') {
8264: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8265: } elsif ($which eq '64bit3') {
8266: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8267: } elsif ($which eq '64bit2') {
8268: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8269: } elsif ($which eq '64bit') {
8270: return &rndseed_64bit($symb,$courseid,$domain,$username);
8271: }
8272: return &rndseed_32bit($symb,$courseid,$domain,$username);
8273: }
8274:
8275: sub rndseed_32bit {
8276: my ($symb,$courseid,$domain,$username)=@_;
8277: {
8278: use integer;
8279: my $symbchck=unpack("%32C*",$symb) << 27;
8280: my $symbseed=numval($symb) << 22;
8281: my $namechck=unpack("%32C*",$username) << 17;
8282: my $nameseed=numval($username) << 12;
8283: my $domainseed=unpack("%32C*",$domain) << 7;
8284: my $courseseed=unpack("%32C*",$courseid);
8285: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8286: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8287: #&logthis("rndseed :$num:$symb");
1.564 albertel 8288: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8289: return $num;
8290: }
8291: }
8292:
8293: sub rndseed_64bit {
8294: my ($symb,$courseid,$domain,$username)=@_;
8295: {
8296: use integer;
8297: my $symbchck=unpack("%32S*",$symb) << 21;
8298: my $symbseed=numval($symb) << 10;
8299: my $namechck=unpack("%32S*",$username);
8300:
8301: my $nameseed=numval($username) << 21;
8302: my $domainseed=unpack("%32S*",$domain) << 10;
8303: my $courseseed=unpack("%32S*",$courseid);
8304:
8305: my $num1=$symbchck+$symbseed+$namechck;
8306: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8307: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8308: #&logthis("rndseed :$num:$symb");
1.564 albertel 8309: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8310: return "$num1,$num2";
1.155 albertel 8311: }
1.366 albertel 8312: }
8313:
1.443 albertel 8314: sub rndseed_64bit2 {
8315: my ($symb,$courseid,$domain,$username)=@_;
8316: {
8317: use integer;
8318: # strings need to be an even # of cahracters long, it it is odd the
8319: # last characters gets thrown away
8320: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8321: my $symbseed=numval($symb) << 10;
8322: my $namechck=unpack("%32S*",$username.' ');
8323:
8324: my $nameseed=numval($username) << 21;
1.501 albertel 8325: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8326: my $courseseed=unpack("%32S*",$courseid.' ');
8327:
8328: my $num1=$symbchck+$symbseed+$namechck;
8329: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8330: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8331: #&logthis("rndseed :$num:$symb");
1.803 albertel 8332: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 8333: return "$num1,$num2";
8334: }
8335: }
8336:
8337: sub rndseed_64bit3 {
8338: my ($symb,$courseid,$domain,$username)=@_;
8339: {
8340: use integer;
8341: # strings need to be an even # of cahracters long, it it is odd the
8342: # last characters gets thrown away
8343: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8344: my $symbseed=numval2($symb) << 10;
8345: my $namechck=unpack("%32S*",$username.' ');
8346:
8347: my $nameseed=numval2($username) << 21;
1.443 albertel 8348: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8349: my $courseseed=unpack("%32S*",$courseid.' ');
8350:
8351: my $num1=$symbchck+$symbseed+$namechck;
8352: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8353: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8354: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 8355: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8356:
1.503 albertel 8357: return "$num1:$num2";
1.443 albertel 8358: }
8359: }
8360:
1.575 albertel 8361: sub rndseed_64bit4 {
8362: my ($symb,$courseid,$domain,$username)=@_;
8363: {
8364: use integer;
8365: # strings need to be an even # of cahracters long, it it is odd the
8366: # last characters gets thrown away
8367: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8368: my $symbseed=numval3($symb) << 10;
8369: my $namechck=unpack("%32S*",$username.' ');
8370:
8371: my $nameseed=numval3($username) << 21;
8372: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8373: my $courseseed=unpack("%32S*",$courseid.' ');
8374:
8375: my $num1=$symbchck+$symbseed+$namechck;
8376: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8377: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8378: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 8379: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8380:
8381: return "$num1:$num2";
8382: }
8383: }
8384:
1.675 albertel 8385: sub rndseed_64bit5 {
8386: my ($symb,$courseid,$domain,$username)=@_;
8387: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8388: return "$num1:$num2";
8389: }
8390:
1.366 albertel 8391: sub rndseed_CODE_64bit {
8392: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 8393: {
1.366 albertel 8394: use integer;
1.443 albertel 8395: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 8396: my $symbseed=numval2($symb);
1.491 albertel 8397: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8398: my $CODEseed=numval(&getCODE());
1.443 albertel 8399: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 8400: my $num1=$symbseed+$CODEchck;
8401: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8402: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8403: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 8404: if ($_64bit) { $num1=(($num1<<32)>>32); }
8405: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 8406: return "$num1:$num2";
1.366 albertel 8407: }
8408: }
8409:
1.575 albertel 8410: sub rndseed_CODE_64bit4 {
8411: my ($symb,$courseid,$domain,$username)=@_;
8412: {
8413: use integer;
8414: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8415: my $symbseed=numval3($symb);
8416: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8417: my $CODEseed=numval3(&getCODE());
8418: my $courseseed=unpack("%32S*",$courseid.' ');
8419: my $num1=$symbseed+$CODEchck;
8420: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8421: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8422: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 8423: if ($_64bit) { $num1=(($num1<<32)>>32); }
8424: if ($_64bit) { $num2=(($num2<<32)>>32); }
8425: return "$num1:$num2";
8426: }
8427: }
8428:
1.675 albertel 8429: sub rndseed_CODE_64bit5 {
8430: my ($symb,$courseid,$domain,$username)=@_;
8431: my $code = &getCODE();
8432: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8433: return "$num1:$num2";
8434: }
8435:
1.366 albertel 8436: sub setup_random_from_rndseed {
8437: my ($rndseed)=@_;
1.503 albertel 8438: if ($rndseed =~/([,:])/) {
8439: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 8440: &Math::Random::random_set_seed(abs($num1),abs($num2));
8441: } else {
8442: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 8443: }
1.36 albertel 8444: }
8445:
1.474 albertel 8446: sub latest_receipt_algorithm_id {
1.835 albertel 8447: return 'receipt3';
1.474 albertel 8448: }
8449:
1.480 www 8450: sub recunique {
8451: my $fucourseid=shift;
8452: my $unique;
1.835 albertel 8453: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
8454: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 8455: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 8456: } else {
8457: $unique=$perlvar{'lonReceipt'};
8458: }
8459: return unpack("%32C*",$unique);
8460: }
8461:
8462: sub recprefix {
8463: my $fucourseid=shift;
8464: my $prefix;
1.835 albertel 8465: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
8466: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 8467: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 8468: } else {
8469: $prefix=$perlvar{'lonHostID'};
8470: }
8471: return unpack("%32C*",$prefix);
8472: }
8473:
1.76 www 8474: sub ireceipt {
1.474 albertel 8475: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 8476:
8477: my $return =&recprefix($fucourseid).'-';
8478:
8479: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
8480: $env{'request.state'} eq 'construct') {
8481: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
8482: return $return;
8483: }
8484:
1.76 www 8485: my $cuname=unpack("%32C*",$funame);
8486: my $cudom=unpack("%32C*",$fudom);
8487: my $cucourseid=unpack("%32C*",$fucourseid);
8488: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 8489: my $cunique=&recunique($fucourseid);
1.474 albertel 8490: my $cpart=unpack("%32S*",$part);
1.835 albertel 8491: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
8492:
1.790 albertel 8493: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 8494:
8495: $return.= ($cunique%$cuname+
8496: $cunique%$cudom+
8497: $cusymb%$cuname+
8498: $cusymb%$cudom+
8499: $cucourseid%$cuname+
8500: $cucourseid%$cudom+
8501: $cpart%$cuname+
8502: $cpart%$cudom);
8503: } else {
8504: $return.= ($cunique%$cuname+
8505: $cunique%$cudom+
8506: $cusymb%$cuname+
8507: $cusymb%$cudom+
8508: $cucourseid%$cuname+
8509: $cucourseid%$cudom);
8510: }
8511: return $return;
1.76 www 8512: }
8513:
8514: sub receipt {
1.474 albertel 8515: my ($part)=@_;
1.790 albertel 8516: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 8517: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 8518: }
1.260 ng 8519:
1.790 albertel 8520: sub whichuser {
8521: my ($passedsymb)=@_;
8522: my ($symb,$courseid,$domain,$name,$publicuser);
8523: if (defined($env{'form.grade_symb'})) {
8524: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
8525: my $allowed=&allowed('vgr',$tmp_courseid);
8526: if (!$allowed &&
8527: exists($env{'request.course.sec'}) &&
8528: $env{'request.course.sec'} !~ /^\s*$/) {
8529: $allowed=&allowed('vgr',$tmp_courseid.
8530: '/'.$env{'request.course.sec'});
8531: }
8532: if ($allowed) {
8533: ($symb)=&get_env_multiple('form.grade_symb');
8534: $courseid=$tmp_courseid;
8535: ($domain)=&get_env_multiple('form.grade_domain');
8536: ($name)=&get_env_multiple('form.grade_username');
8537: return ($symb,$courseid,$domain,$name,$publicuser);
8538: }
8539: }
8540: if (!$passedsymb) {
8541: $symb=&symbread();
8542: } else {
8543: $symb=$passedsymb;
8544: }
8545: $courseid=$env{'request.course.id'};
8546: $domain=$env{'user.domain'};
8547: $name=$env{'user.name'};
8548: if ($name eq 'public' && $domain eq 'public') {
8549: if (!defined($env{'form.username'})) {
8550: $env{'form.username'}.=time.rand(10000000);
8551: }
8552: $name.=$env{'form.username'};
8553: }
8554: return ($symb,$courseid,$domain,$name,$publicuser);
8555:
8556: }
8557:
1.36 albertel 8558: # ------------------------------------------------------------ Serves up a file
1.472 albertel 8559: # returns either the contents of the file or
8560: # -1 if the file doesn't exist
1.481 raeburn 8561: #
8562: # if the target is a file that was uploaded via DOCS,
8563: # a check will be made to see if a current copy exists on the local server,
8564: # if it does this will be served, otherwise a copy will be retrieved from
8565: # the home server for the course and stored in /home/httpd/html/userfiles on
8566: # the local server.
1.472 albertel 8567:
1.36 albertel 8568: sub getfile {
1.538 albertel 8569: my ($file) = @_;
1.609 banghart 8570: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 8571: &repcopy($file);
8572: return &readfile($file);
8573: }
8574:
8575: sub repcopy_userfile {
8576: my ($file)=@_;
1.609 banghart 8577: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 8578: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 8579: my ($cdom,$cnum,$filename) =
1.811 albertel 8580: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 8581: my $uri="/uploaded/$cdom/$cnum/$filename";
8582: if (-e "$file") {
1.828 www 8583: # we already have a local copy, check it out
1.538 albertel 8584: my @fileinfo = stat($file);
1.828 www 8585: my $rtncode;
8586: my $info;
1.538 albertel 8587: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 8588: if ($lwpresp ne 'ok') {
1.828 www 8589: # there is no such file anymore, even though we had a local copy
1.482 albertel 8590: if ($rtncode eq '404') {
1.538 albertel 8591: unlink($file);
1.482 albertel 8592: }
8593: return -1;
8594: }
8595: if ($info < $fileinfo[9]) {
1.828 www 8596: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 8597: return 'ok';
1.828 www 8598: } else {
8599: # the file is outdated, get rid of it
8600: unlink($file);
1.482 albertel 8601: }
1.828 www 8602: }
8603: # one way or the other, at this point, we don't have the file
8604: # construct the correct path for the file
8605: my @parts = ($cdom,$cnum);
8606: if ($filename =~ m|^(.+)/[^/]+$|) {
8607: push @parts, split(/\//,$1);
8608: }
8609: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
8610: foreach my $part (@parts) {
8611: $path .= '/'.$part;
8612: if (!-e $path) {
8613: mkdir($path,0770);
1.482 albertel 8614: }
8615: }
1.828 www 8616: # now the path exists for sure
8617: # get a user agent
8618: my $ua=new LWP::UserAgent;
8619: my $transferfile=$file.'.in.transfer';
8620: # FIXME: this should flock
8621: if (-e $transferfile) { return 'ok'; }
8622: my $request;
8623: $uri=~s/^\///;
1.980 raeburn 8624: my $homeserver = &homeserver($cnum,$cdom);
8625: my $protocol = $protocol{$homeserver};
8626: $protocol = 'http' if ($protocol ne 'https');
8627: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 8628: my $response=$ua->request($request,$transferfile);
8629: # did it work?
8630: if ($response->is_error()) {
8631: unlink($transferfile);
8632: &logthis("Userfile repcopy failed for $uri");
8633: return -1;
8634: }
8635: # worked, rename the transfer file
8636: rename($transferfile,$file);
1.607 raeburn 8637: return 'ok';
1.481 raeburn 8638: }
8639:
1.517 albertel 8640: sub tokenwrapper {
8641: my $uri=shift;
1.980 raeburn 8642: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 8643: $uri=~s|^/||;
1.620 albertel 8644: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 8645: my $token=$1;
1.552 albertel 8646: my (undef,$udom,$uname,$file)=split('/',$uri,4);
8647: if ($udom && $uname && $file) {
8648: $file=~s|(\?\.*)*$||;
1.949 raeburn 8649: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 8650: my $homeserver = &homeserver($uname,$udom);
8651: my $protocol = $protocol{$homeserver};
8652: $protocol = 'http' if ($protocol ne 'https');
8653: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 8654: (($uri=~/\?/)?'&':'?').'token='.$token.
8655: '&tokenissued='.$perlvar{'lonHostID'};
8656: } else {
8657: return '/adm/notfound.html';
8658: }
8659: }
8660:
1.828 www 8661: # call with reqtype HEAD: get last modification time
8662: # call with reqtype GET: get the file contents
8663: # Do not call this with reqtype GET for large files! It loads everything into memory
8664: #
1.481 raeburn 8665: sub getuploaded {
8666: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
8667: $uri=~s/^\///;
1.980 raeburn 8668: my $homeserver = &homeserver($cnum,$cdom);
8669: my $protocol = $protocol{$homeserver};
8670: $protocol = 'http' if ($protocol ne 'https');
8671: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 8672: my $ua=new LWP::UserAgent;
8673: my $request=new HTTP::Request($reqtype,$uri);
8674: my $response=$ua->request($request);
8675: $$rtncode = $response->code;
1.482 albertel 8676: if (! $response->is_success()) {
8677: return 'failed';
8678: }
8679: if ($reqtype eq 'HEAD') {
1.486 www 8680: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 8681: } elsif ($reqtype eq 'GET') {
8682: $$info = $response->content;
1.472 albertel 8683: }
1.482 albertel 8684: return 'ok';
1.36 albertel 8685: }
8686:
1.481 raeburn 8687: sub readfile {
8688: my $file = shift;
8689: if ( (! -e $file ) || ($file eq '') ) { return -1; };
8690: my $fh;
8691: open($fh,"<$file");
8692: my $a='';
1.800 albertel 8693: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 8694: return $a;
8695: }
8696:
1.36 albertel 8697: sub filelocation {
1.590 banghart 8698: my ($dir,$file) = @_;
8699: my $location;
8700: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 8701:
8702: if ($file =~ m-^/adm/-) {
8703: $file=~s-^/adm/wrapper/-/-;
8704: $file=~s-^/adm/coursedocs/showdoc/-/-;
8705: }
1.882 albertel 8706:
1.590 banghart 8707: if ($file=~m:^/~:) { # is a contruction space reference
8708: $location = $file;
8709: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 8710: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 8711: # is a correct contruction space reference
8712: $location = $file;
1.956 raeburn 8713: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
8714: $location = $file;
1.609 banghart 8715: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 8716: my ($udom,$uname,$filename)=
1.811 albertel 8717: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 8718: my $home=&homeserver($uname,$udom);
8719: my $is_me=0;
8720: my @ids=¤t_machine_ids();
8721: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
8722: if ($is_me) {
1.955 raeburn 8723: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 8724: } else {
8725: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
8726: $udom.'/'.$uname.'/'.$filename;
8727: }
1.882 albertel 8728: } elsif ($file =~ m-^/adm/-) {
8729: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 8730: } else {
8731: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8732: $file=~s:^/res/:/:;
8733: if ( !( $file =~ m:^/:) ) {
8734: $location = $dir. '/'.$file;
8735: } else {
8736: $location = '/home/httpd/html/res'.$file;
8737: }
1.59 albertel 8738: }
1.590 banghart 8739: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 8740: while ($location=~m{/\.\./}) {
8741: if ($location =~ m{/[^/]+/\.\./}) {
8742: $location=~ s{/[^/]+/\.\./}{/}g;
8743: } else {
8744: $location=~ s{/\.\./}{/}g;
8745: }
8746: } #remove dir/..
1.590 banghart 8747: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
8748: return $location;
1.46 www 8749: }
1.36 albertel 8750:
1.46 www 8751: sub hreflocation {
8752: my ($dir,$file)=@_;
1.980 raeburn 8753: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 8754: $file=filelocation($dir,$file);
1.700 albertel 8755: } elsif ($file=~m-^/adm/-) {
8756: $file=~s-^/adm/wrapper/-/-;
8757: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 8758: }
8759: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
8760: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 8761: } elsif ($file=~m-/home/($match_username)/public_html/-) {
8762: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 8763: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 8764: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 8765: -/uploaded/$1/$2/-x;
1.46 www 8766: }
1.913 albertel 8767: if ($file=~ m{^/userfiles/}) {
8768: $file =~ s{^/userfiles/}{/uploaded/};
8769: }
1.462 albertel 8770: return $file;
1.465 albertel 8771: }
8772:
8773: sub current_machine_domains {
1.853 albertel 8774: return &machine_domains(&hostname($perlvar{'lonHostID'}));
8775: }
8776:
8777: sub machine_domains {
8778: my ($hostname) = @_;
1.465 albertel 8779: my @domains;
1.838 albertel 8780: my %hostname = &all_hostnames();
1.465 albertel 8781: while( my($id, $name) = each(%hostname)) {
1.467 matthew 8782: # &logthis("-$id-$name-$hostname-");
1.465 albertel 8783: if ($hostname eq $name) {
1.844 albertel 8784: push(@domains,&host_domain($id));
1.465 albertel 8785: }
8786: }
8787: return @domains;
8788: }
8789:
8790: sub current_machine_ids {
1.853 albertel 8791: return &machine_ids(&hostname($perlvar{'lonHostID'}));
8792: }
8793:
8794: sub machine_ids {
8795: my ($hostname) = @_;
8796: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 8797: my @ids;
1.888 albertel 8798: my %name_to_host = &all_names();
1.889 albertel 8799: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
8800: return @{ $name_to_host{$hostname} };
8801: }
8802: return;
1.31 www 8803: }
8804:
1.824 raeburn 8805: sub additional_machine_domains {
8806: my @domains;
8807: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
8808: while( my $line = <$fh>) {
8809: $line =~ s/\s//g;
8810: push(@domains,$line);
8811: }
8812: return @domains;
8813: }
8814:
8815: sub default_login_domain {
8816: my $domain = $perlvar{'lonDefDomain'};
8817: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
8818: foreach my $posdom (¤t_machine_domains(),
8819: &additional_machine_domains()) {
8820: if (lc($posdom) eq lc($testdomain)) {
8821: $domain=$posdom;
8822: last;
8823: }
8824: }
8825: return $domain;
8826: }
8827:
1.31 www 8828: # ------------------------------------------------------------- Declutters URLs
8829:
8830: sub declutter {
8831: my $thisfn=shift;
1.569 albertel 8832: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 8833: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 8834: $thisfn=~s/^\///;
1.697 albertel 8835: $thisfn=~s|^adm/wrapper/||;
8836: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 8837: $thisfn=~s/^res\///;
1.235 www 8838: $thisfn=~s/\?.+$//;
1.268 www 8839: return $thisfn;
8840: }
8841:
8842: # ------------------------------------------------------------- Clutter up URLs
8843:
8844: sub clutter {
8845: my $thisfn='/'.&declutter(shift);
1.887 albertel 8846: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 8847: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 8848: $thisfn='/res'.$thisfn;
8849: }
1.694 albertel 8850: if ($thisfn !~m|/adm|) {
1.695 albertel 8851: if ($thisfn =~ m|/ext/|) {
1.694 albertel 8852: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 8853: } else {
8854: my ($ext) = ($thisfn =~ /\.(\w+)$/);
8855: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 8856: if ($embstyle eq 'ssi'
8857: || ($embstyle eq 'hdn')
8858: || ($embstyle eq 'rat')
8859: || ($embstyle eq 'prv')
8860: || ($embstyle eq 'ign')) {
8861: #do nothing with these
8862: } elsif (($embstyle eq 'img')
1.695 albertel 8863: || ($embstyle eq 'emb')
8864: || ($embstyle eq 'wrp')) {
8865: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 8866: } elsif ($embstyle eq 'unk'
8867: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 8868: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 8869: } else {
1.718 www 8870: # &logthis("Got a blank emb style");
1.695 albertel 8871: }
1.694 albertel 8872: }
8873: }
1.31 www 8874: return $thisfn;
1.12 www 8875: }
8876:
1.787 albertel 8877: sub clutter_with_no_wrapper {
8878: my $uri = &clutter(shift);
8879: if ($uri =~ m-^/adm/-) {
8880: $uri =~ s-^/adm/wrapper/-/-;
8881: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
8882: }
8883: return $uri;
8884: }
8885:
1.557 albertel 8886: sub freeze_escape {
8887: my ($value)=@_;
8888: if (ref($value)) {
8889: $value=&nfreeze($value);
8890: return '__FROZEN__'.&escape($value);
8891: }
8892: return &escape($value);
8893: }
8894:
1.11 www 8895:
1.557 albertel 8896: sub thaw_unescape {
8897: my ($value)=@_;
8898: if ($value =~ /^__FROZEN__/) {
8899: substr($value,0,10,undef);
8900: $value=&unescape($value);
8901: return &thaw($value);
8902: }
8903: return &unescape($value);
8904: }
8905:
1.436 albertel 8906: sub correct_line_ends {
8907: my ($result)=@_;
8908: $$result =~s/\r\n/\n/mg;
8909: $$result =~s/\r/\n/mg;
1.415 albertel 8910: }
1.1 albertel 8911: # ================================================================ Main Program
8912:
1.184 www 8913: sub goodbye {
1.204 albertel 8914: &logthis("Starting Shut down");
1.443 albertel 8915: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 8916: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 8917: #converted
1.599 albertel 8918: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 8919: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
8920: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
8921: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 8922: #1.1 only
1.870 albertel 8923: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
8924: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
8925: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
8926: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
8927: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 8928: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
8929: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 8930: &flushcourselogs();
8931: &logthis("Shutting down");
8932: }
8933:
1.852 albertel 8934: sub get_dns {
1.869 albertel 8935: my ($url,$func,$ignore_cache) = @_;
8936: if (!$ignore_cache) {
8937: my ($content,$cached)=
8938: &Apache::lonnet::is_cached_new('dns',$url);
8939: if ($cached) {
8940: &$func($content);
8941: return;
8942: }
8943: }
8944:
8945: my %alldns;
1.852 albertel 8946: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8947: foreach my $dns (<$config>) {
8948: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 8949: my $line = $1;
8950: my ($host,$protocol) = split(/:/,$line);
8951: if ($protocol ne 'https') {
8952: $protocol = 'http';
8953: }
8954: $alldns{$host} = $protocol;
1.869 albertel 8955: }
8956: while (%alldns) {
8957: my ($dns) = keys(%alldns);
1.852 albertel 8958: my $ua=new LWP::UserAgent;
1.979 raeburn 8959: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 8960: my $response=$ua->request($request);
1.979 raeburn 8961: delete($alldns{$dns});
1.852 albertel 8962: next if ($response->is_error());
8963: my @content = split("\n",$response->content);
1.869 albertel 8964: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 8965: &$func(\@content);
1.869 albertel 8966: return;
1.852 albertel 8967: }
8968: close($config);
1.871 albertel 8969: my $which = (split('/',$url))[3];
8970: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
8971: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 8972: my @content = <$config>;
8973: &$func(\@content);
8974: return;
1.852 albertel 8975: }
1.327 albertel 8976: # ------------------------------------------------------------ Read domain file
8977: {
1.852 albertel 8978: my $loaded;
1.846 albertel 8979: my %domain;
8980:
1.852 albertel 8981: sub parse_domain_tab {
8982: my ($lines) = @_;
8983: foreach my $line (@$lines) {
8984: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 8985:
1.846 albertel 8986: chomp($line);
1.852 albertel 8987: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 8988: my %this_domain;
8989: foreach my $field ('description', 'auth_def', 'auth_arg_def',
8990: 'lang_def', 'city', 'longi', 'lati',
8991: 'primary') {
8992: $this_domain{$field} = shift(@elements);
8993: }
8994: $domain{$name} = \%this_domain;
1.852 albertel 8995: }
8996: }
1.864 albertel 8997:
8998: sub reset_domain_info {
8999: undef($loaded);
9000: undef(%domain);
9001: }
9002:
1.852 albertel 9003: sub load_domain_tab {
1.869 albertel 9004: my ($ignore_cache) = @_;
9005: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9006: my $fh;
9007: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9008: my @lines = <$fh>;
9009: &parse_domain_tab(\@lines);
1.448 albertel 9010: }
1.852 albertel 9011: close($fh);
9012: $loaded = 1;
1.327 albertel 9013: }
1.846 albertel 9014:
9015: sub domain {
1.852 albertel 9016: &load_domain_tab() if (!$loaded);
9017:
1.846 albertel 9018: my ($name,$what) = @_;
9019: return if ( !exists($domain{$name}) );
9020:
9021: if (!$what) {
9022: return $domain{$name}{'description'};
9023: }
9024: return $domain{$name}{$what};
9025: }
1.974 raeburn 9026:
9027: sub domain_info {
9028: &load_domain_tab() if (!$loaded);
9029: return %domain;
9030: }
9031:
1.327 albertel 9032: }
9033:
9034:
1.1 albertel 9035: # ------------------------------------------------------------- Read hosts file
9036: {
1.838 albertel 9037: my %hostname;
1.844 albertel 9038: my %hostdom;
1.845 albertel 9039: my %libserv;
1.852 albertel 9040: my $loaded;
1.888 albertel 9041: my %name_to_host;
1.852 albertel 9042:
9043: sub parse_hosts_tab {
9044: my ($file) = @_;
9045: foreach my $configline (@$file) {
9046: next if ($configline =~ /^(\#|\s*$ )/x);
9047: next if ($configline =~ /^\^/);
9048: chomp($configline);
1.968 raeburn 9049: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9050: $name=~s/\s//g;
9051: if ($id && $domain && $role && $name) {
9052: $hostname{$id}=$name;
1.888 albertel 9053: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9054: $hostdom{$id}=$domain;
9055: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9056: if (defined($protocol)) {
9057: if ($protocol eq 'https') {
9058: $protocol{$id} = $protocol;
9059: } else {
9060: $protocol{$id} = 'http';
9061: }
1.968 raeburn 9062: } else {
1.969 raeburn 9063: $protocol{$id} = 'http';
1.968 raeburn 9064: }
1.852 albertel 9065: }
9066: }
9067: }
1.864 albertel 9068:
9069: sub reset_hosts_info {
1.897 albertel 9070: &purge_remembered();
1.864 albertel 9071: &reset_domain_info();
9072: &reset_hosts_ip_info();
1.892 albertel 9073: undef(%name_to_host);
1.864 albertel 9074: undef(%hostname);
9075: undef(%hostdom);
9076: undef(%libserv);
9077: undef($loaded);
9078: }
1.1 albertel 9079:
1.852 albertel 9080: sub load_hosts_tab {
1.869 albertel 9081: my ($ignore_cache) = @_;
9082: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9083: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9084: my @config = <$config>;
9085: &parse_hosts_tab(\@config);
9086: close($config);
9087: $loaded=1;
1.1 albertel 9088: }
1.852 albertel 9089:
1.838 albertel 9090: sub hostname {
1.852 albertel 9091: &load_hosts_tab() if (!$loaded);
9092:
1.838 albertel 9093: my ($lonid) = @_;
9094: return $hostname{$lonid};
9095: }
1.845 albertel 9096:
1.838 albertel 9097: sub all_hostnames {
1.852 albertel 9098: &load_hosts_tab() if (!$loaded);
9099:
1.838 albertel 9100: return %hostname;
9101: }
1.845 albertel 9102:
1.888 albertel 9103: sub all_names {
9104: &load_hosts_tab() if (!$loaded);
9105:
9106: return %name_to_host;
9107: }
9108:
1.974 raeburn 9109: sub all_host_domain {
9110: &load_hosts_tab() if (!$loaded);
9111: return %hostdom;
9112: }
9113:
1.845 albertel 9114: sub is_library {
1.852 albertel 9115: &load_hosts_tab() if (!$loaded);
9116:
1.845 albertel 9117: return exists($libserv{$_[0]});
9118: }
9119:
9120: sub all_library {
1.852 albertel 9121: &load_hosts_tab() if (!$loaded);
9122:
1.845 albertel 9123: return %libserv;
9124: }
9125:
1.841 albertel 9126: sub get_servers {
1.852 albertel 9127: &load_hosts_tab() if (!$loaded);
9128:
1.841 albertel 9129: my ($domain,$type) = @_;
9130: my %possible_hosts = ($type eq 'library') ? %libserv
9131: : %hostname;
9132: my %result;
1.842 albertel 9133: if (ref($domain) eq 'ARRAY') {
9134: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9135: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9136: $result{$host} = $hostname;
9137: }
9138: }
9139: } else {
9140: while ( my ($host,$hostname) = each(%possible_hosts)) {
9141: if ($hostdom{$host} eq $domain) {
9142: $result{$host} = $hostname;
9143: }
1.841 albertel 9144: }
9145: }
9146: return %result;
9147: }
1.845 albertel 9148:
1.844 albertel 9149: sub host_domain {
1.852 albertel 9150: &load_hosts_tab() if (!$loaded);
9151:
1.844 albertel 9152: my ($lonid) = @_;
9153: return $hostdom{$lonid};
9154: }
9155:
1.841 albertel 9156: sub all_domains {
1.852 albertel 9157: &load_hosts_tab() if (!$loaded);
9158:
1.841 albertel 9159: my %seen;
9160: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9161: return @uniq;
9162: }
1.1 albertel 9163: }
9164:
1.847 albertel 9165: {
9166: my %iphost;
1.856 albertel 9167: my %name_to_ip;
9168: my %lonid_to_ip;
1.869 albertel 9169:
1.847 albertel 9170: sub get_hosts_from_ip {
9171: my ($ip) = @_;
9172: my %iphosts = &get_iphost();
9173: if (ref($iphosts{$ip})) {
9174: return @{$iphosts{$ip}};
9175: }
9176: return;
1.839 albertel 9177: }
1.864 albertel 9178:
9179: sub reset_hosts_ip_info {
9180: undef(%iphost);
9181: undef(%name_to_ip);
9182: undef(%lonid_to_ip);
9183: }
1.856 albertel 9184:
9185: sub get_host_ip {
9186: my ($lonid) = @_;
9187: if (exists($lonid_to_ip{$lonid})) {
9188: return $lonid_to_ip{$lonid};
9189: }
9190: my $name=&hostname($lonid);
9191: my $ip = gethostbyname($name);
9192: return if (!$ip || length($ip) ne 4);
9193: $ip=inet_ntoa($ip);
9194: $name_to_ip{$name} = $ip;
9195: $lonid_to_ip{$lonid} = $ip;
9196: return $ip;
9197: }
1.847 albertel 9198:
9199: sub get_iphost {
1.869 albertel 9200: my ($ignore_cache) = @_;
1.894 albertel 9201:
1.869 albertel 9202: if (!$ignore_cache) {
9203: if (%iphost) {
9204: return %iphost;
9205: }
9206: my ($ip_info,$cached)=
9207: &Apache::lonnet::is_cached_new('iphost','iphost');
9208: if ($cached) {
9209: %iphost = %{$ip_info->[0]};
9210: %name_to_ip = %{$ip_info->[1]};
9211: %lonid_to_ip = %{$ip_info->[2]};
9212: return %iphost;
9213: }
9214: }
1.894 albertel 9215:
9216: # get yesterday's info for fallback
9217: my %old_name_to_ip;
9218: my ($ip_info,$cached)=
9219: &Apache::lonnet::is_cached_new('iphost','iphost');
9220: if ($cached) {
9221: %old_name_to_ip = %{$ip_info->[1]};
9222: }
9223:
1.888 albertel 9224: my %name_to_host = &all_names();
9225: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9226: my $ip;
9227: if (!exists($name_to_ip{$name})) {
9228: $ip = gethostbyname($name);
9229: if (!$ip || length($ip) ne 4) {
1.894 albertel 9230: if (defined($old_name_to_ip{$name})) {
9231: $ip = $old_name_to_ip{$name};
9232: &logthis("Can't find $name defaulting to old $ip");
9233: } else {
9234: &logthis("Name $name no IP found");
9235: next;
9236: }
9237: } else {
9238: $ip=inet_ntoa($ip);
1.847 albertel 9239: }
9240: $name_to_ip{$name} = $ip;
9241: } else {
9242: $ip = $name_to_ip{$name};
1.653 albertel 9243: }
1.888 albertel 9244: foreach my $id (@{ $name_to_host{$name} }) {
9245: $lonid_to_ip{$id} = $ip;
9246: }
9247: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9248: }
1.869 albertel 9249: &Apache::lonnet::do_cache_new('iphost','iphost',
9250: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9251: 48*60*60);
1.869 albertel 9252:
1.847 albertel 9253: return %iphost;
1.598 albertel 9254: }
9255:
1.992 raeburn 9256: #
9257: # Given a DNS returns the loncapa host name for that DNS
9258: #
9259: sub host_from_dns {
9260: my ($dns) = @_;
9261: my @hosts;
9262: my $ip;
9263:
1.993 raeburn 9264: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9265: $ip = $name_to_ip{$dns};
9266: }
9267: if (!$ip) {
9268: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9269: if (length($ip) == 4) {
9270: $ip = &IO::Socket::inet_ntoa($ip);
9271: }
9272: }
9273: if ($ip) {
9274: @hosts = get_hosts_from_ip($ip);
9275: return $hosts[0];
9276: }
9277: return undef;
1.986 foxr 9278: }
1.992 raeburn 9279:
1.986 foxr 9280: }
9281:
1.862 albertel 9282: BEGIN {
9283:
9284: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9285: unless ($readit) {
9286: {
9287: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9288: %perlvar = (%perlvar,%{$configvars});
9289: }
9290:
9291:
1.1 albertel 9292: # ------------------------------------------------------ Read spare server file
9293: {
1.448 albertel 9294: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9295:
9296: while (my $configline=<$config>) {
9297: chomp($configline);
1.284 matthew 9298: if ($configline) {
1.784 albertel 9299: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9300: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9301: push(@{ $spareid{$type} }, $host);
1.1 albertel 9302: }
9303: }
1.448 albertel 9304: close($config);
1.1 albertel 9305: }
1.11 www 9306: # ------------------------------------------------------------ Read permissions
9307: {
1.448 albertel 9308: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 9309:
9310: while (my $configline=<$config>) {
1.448 albertel 9311: chomp($configline);
9312: if ($configline) {
9313: my ($role,$perm)=split(/ /,$configline);
9314: if ($perm ne '') { $pr{$role}=$perm; }
9315: }
1.11 www 9316: }
1.448 albertel 9317: close($config);
1.11 www 9318: }
9319:
9320: # -------------------------------------------- Read plain texts for permissions
9321: {
1.448 albertel 9322: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 9323:
9324: while (my $configline=<$config>) {
1.448 albertel 9325: chomp($configline);
9326: if ($configline) {
1.742 raeburn 9327: my ($short,@plain)=split(/:/,$configline);
9328: %{$prp{$short}} = ();
9329: if (@plain > 0) {
9330: $prp{$short}{'std'} = $plain[0];
9331: for (my $i=1; $i<@plain; $i++) {
9332: $prp{$short}{'alt'.$i} = $plain[$i];
9333: }
9334: }
1.448 albertel 9335: }
1.135 www 9336: }
1.448 albertel 9337: close($config);
1.135 www 9338: }
9339:
9340: # ---------------------------------------------------------- Read package table
9341: {
1.448 albertel 9342: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 9343:
9344: while (my $configline=<$config>) {
1.483 albertel 9345: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 9346: chomp($configline);
9347: my ($short,$plain)=split(/:/,$configline);
9348: my ($pack,$name)=split(/\&/,$short);
9349: if ($plain ne '') {
9350: $packagetab{$pack.'&'.$name.'&name'}=$name;
9351: $packagetab{$short}=$plain;
9352: }
1.11 www 9353: }
1.448 albertel 9354: close($config);
1.329 matthew 9355: }
9356:
9357: # ------------- set up temporary directory
9358: {
9359: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9360:
1.11 www 9361: }
9362:
1.794 albertel 9363: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9364: 'compress_threshold'=> 20_000,
9365: });
1.185 www 9366:
1.281 www 9367: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 9368: $dumpcount=0;
1.958 www 9369: $locknum=0;
1.22 www 9370:
1.163 harris41 9371: &logtouch();
1.672 albertel 9372: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 9373: $readit=1;
1.564 albertel 9374: {
9375: use integer;
9376: my $test=(2**32)+1;
1.568 albertel 9377: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 9378: &logthis(" Detected 64bit platform ($_64bit)");
9379: }
1.195 www 9380: }
1.1 albertel 9381: }
1.179 www 9382:
1.1 albertel 9383: 1;
1.191 harris41 9384: __END__
9385:
1.243 albertel 9386: =pod
9387:
1.191 harris41 9388: =head1 NAME
9389:
1.243 albertel 9390: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 9391:
9392: =head1 SYNOPSIS
9393:
1.243 albertel 9394: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 9395:
9396: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9397:
1.243 albertel 9398: Common parameters:
9399:
9400: =over 4
9401:
9402: =item *
9403:
9404: $uname : an internal username (if $cname expecting a course Id specifically)
9405:
9406: =item *
9407:
9408: $udom : a domain (if $cdom expecting a course's domain specifically)
9409:
9410: =item *
9411:
9412: $symb : a resource instance identifier
9413:
9414: =item *
9415:
9416: $namespace : the name of a .db file that contains the data needed or
9417: being set.
9418:
9419: =back
9420:
1.394 bowersj2 9421: =head1 OVERVIEW
1.191 harris41 9422:
1.394 bowersj2 9423: lonnet provides subroutines which interact with the
9424: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9425: about classes, users, and resources.
1.243 albertel 9426:
9427: For many of these objects you can also use this to store data about
9428: them or modify them in various ways.
1.191 harris41 9429:
1.394 bowersj2 9430: =head2 Symbs
1.191 harris41 9431:
1.394 bowersj2 9432: To identify a specific instance of a resource, LON-CAPA uses symbols
9433: or "symbs"X<symb>. These identifiers are built from the URL of the
9434: map, the resource number of the resource in the map, and the URL of
9435: the resource itself. The latter is somewhat redundant, but might help
9436: if maps change.
9437:
9438: An example is
9439:
9440: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9441:
9442: The respective map entry is
9443:
9444: <resource id="19" src="/res/msu/korte/tests/part12.problem"
9445: title="Problem 2">
9446: </resource>
9447:
9448: Symbs are used by the random number generator, as well as to store and
9449: restore data specific to a certain instance of for example a problem.
9450:
9451: =head2 Storing And Retrieving Data
9452:
9453: X<store()>X<cstore()>X<restore()>Three of the most important functions
9454: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
9455: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
9456: is is the non-critical message twin of cstore. These functions are for
9457: handlers to store a perl hash to a user's permanent data space in an
9458: easy manner, and to retrieve it again on another call. It is expected
9459: that a handler would use this once at the beginning to retrieve data,
9460: and then again once at the end to send only the new data back.
9461:
9462: The data is stored in the user's data directory on the user's
9463: homeserver under the ID of the course.
9464:
9465: The hash that is returned by restore will have all of the previous
9466: value for all of the elements of the hash.
9467:
9468: Example:
9469:
9470: #creating a hash
9471: my %hash;
9472: $hash{'foo'}='bar';
9473:
9474: #storing it
9475: &Apache::lonnet::cstore(\%hash);
9476:
9477: #changing a value
9478: $hash{'foo'}='notbar';
9479:
9480: #adding a new value
9481: $hash{'bar'}='foo';
9482: &Apache::lonnet::cstore(\%hash);
9483:
9484: #retrieving the hash
9485: my %history=&Apache::lonnet::restore();
9486:
9487: #print the hash
9488: foreach my $key (sort(keys(%history))) {
9489: print("\%history{$key} = $history{$key}");
9490: }
9491:
9492: Will print out:
1.191 harris41 9493:
1.394 bowersj2 9494: %history{1:foo} = bar
9495: %history{1:keys} = foo:timestamp
9496: %history{1:timestamp} = 990455579
9497: %history{2:bar} = foo
9498: %history{2:foo} = notbar
9499: %history{2:keys} = foo:bar:timestamp
9500: %history{2:timestamp} = 990455580
9501: %history{bar} = foo
9502: %history{foo} = notbar
9503: %history{timestamp} = 990455580
9504: %history{version} = 2
9505:
9506: Note that the special hash entries C<keys>, C<version> and
9507: C<timestamp> were added to the hash. C<version> will be equal to the
9508: total number of versions of the data that have been stored. The
9509: C<timestamp> attribute will be the UNIX time the hash was
9510: stored. C<keys> is available in every historical section to list which
9511: keys were added or changed at a specific historical revision of a
9512: hash.
9513:
9514: B<Warning>: do not store the hash that restore returns directly. This
9515: will cause a mess since it will restore the historical keys as if the
9516: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 9517:
1.394 bowersj2 9518: Calling convention:
1.191 harris41 9519:
1.394 bowersj2 9520: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
9521: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 9522:
1.394 bowersj2 9523: For more detailed information, see lonnet specific documentation.
1.191 harris41 9524:
1.394 bowersj2 9525: =head1 RETURN MESSAGES
1.191 harris41 9526:
1.394 bowersj2 9527: =over 4
1.191 harris41 9528:
1.394 bowersj2 9529: =item * B<con_lost>: unable to contact remote host
1.191 harris41 9530:
1.394 bowersj2 9531: =item * B<con_delayed>: unable to contact remote host, message will be delivered
9532: when the connection is brought back up
1.191 harris41 9533:
1.394 bowersj2 9534: =item * B<con_failed>: unable to contact remote host and unable to save message
9535: for later delivery
1.191 harris41 9536:
1.967 bisitz 9537: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 9538:
1.394 bowersj2 9539: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 9540: that was requested
1.191 harris41 9541:
1.243 albertel 9542: =back
1.191 harris41 9543:
1.243 albertel 9544: =head1 PUBLIC SUBROUTINES
1.191 harris41 9545:
1.243 albertel 9546: =head2 Session Environment Functions
1.191 harris41 9547:
1.243 albertel 9548: =over 4
1.191 harris41 9549:
1.394 bowersj2 9550: =item *
9551: X<appenv()>
1.949 raeburn 9552: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 9553: the user envirnoment file, and will be restored for each access this
1.620 albertel 9554: user makes during this session, also modifies the %env for the current
1.949 raeburn 9555: process. Optional rolesarrayref - if defined contains a reference to an array
9556: of roles which are exempt from the restriction on modifying user.role entries
9557: in the user's environment.db and in %env.
1.191 harris41 9558:
9559: =item *
1.394 bowersj2 9560: X<delenv()>
1.987 raeburn 9561: B<delenv($delthis,$regexp)>: removes all items from the session
9562: environment file that begin with $delthis. If the
9563: optional second arg - $regexp - is true, $delthis is treated as a
9564: regular expression, otherwise \Q$delthis\E is used.
9565: The values are also deleted from the current processes %env.
1.191 harris41 9566:
1.795 albertel 9567: =item * get_env_multiple($name)
9568:
9569: gets $name from the %env hash, it seemlessly handles the cases where multiple
9570: values may be defined and end up as an array ref.
9571:
9572: returns an array of values
9573:
1.243 albertel 9574: =back
9575:
9576: =head2 User Information
1.191 harris41 9577:
1.243 albertel 9578: =over 4
1.191 harris41 9579:
9580: =item *
1.394 bowersj2 9581: X<queryauthenticate()>
9582: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 9583: authentication scheme
9584:
9585: =item *
1.394 bowersj2 9586: X<authenticate()>
9587: B<authenticate($uname,$upass,$udom)>: try to
9588: authenticate user from domain's lib servers (first use the current
9589: one). C<$upass> should be the users password.
1.191 harris41 9590:
9591: =item *
1.394 bowersj2 9592: X<homeserver()>
9593: B<homeserver($uname,$udom)>: find the server which has
9594: the user's directory and files (there must be only one), this caches
9595: the answer, and also caches if there is a borken connection.
1.191 harris41 9596:
9597: =item *
1.394 bowersj2 9598: X<idget()>
9599: B<idget($udom,@ids)>: find the usernames behind a list of IDs
9600: (IDs are a unique resource in a domain, there must be only 1 ID per
9601: username, and only 1 username per ID in a specific domain) (returns
9602: hash: id=>name,id=>name)
1.191 harris41 9603:
9604: =item *
1.394 bowersj2 9605: X<idrget()>
9606: B<idrget($udom,@unames)>: find the IDs behind a list of
9607: usernames (returns hash: name=>id,name=>id)
1.191 harris41 9608:
9609: =item *
1.394 bowersj2 9610: X<idput()>
9611: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 9612:
9613: =item *
1.394 bowersj2 9614: X<rolesinit()>
9615: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 9616:
9617: =item *
1.551 albertel 9618: X<getsection()>
9619: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 9620: course $cname, return section name/number or '' for "not in course"
9621: and '-1' for "no section"
9622:
9623: =item *
1.394 bowersj2 9624: X<userenvironment()>
9625: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 9626: passed in @what from the requested user's environment, returns a hash
9627:
1.858 raeburn 9628: =item *
9629: X<userlog_query()>
1.859 albertel 9630: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
9631: activity.log file. %filters defines filters applied when parsing the
9632: log file. These can be start or end timestamps, or the type of action
9633: - log to look for Login or Logout events, check for Checkin or
9634: Checkout, role for role selection. The response is in the form
9635: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
9636: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 9637:
1.243 albertel 9638: =back
9639:
9640: =head2 User Roles
9641:
9642: =over 4
9643:
9644: =item *
9645:
1.810 raeburn 9646: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 9647: F: full access
9648: U,I,K: authentication modes (cxx only)
9649: '': forbidden
9650: 1: user needs to choose course
9651: 2: browse allowed
1.766 albertel 9652: A: passphrase authentication needed
1.243 albertel 9653:
9654: =item *
9655:
9656: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
9657: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
9658: and course level
9659:
9660: =item *
9661:
1.988 raeburn 9662: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
9663: (rolesplain.tab); plain text explanation of a user role term.
9664: $type is Course (default) or Group.
9665: If $forcedefault evaluates to true, text returned will be default
9666: text for $type. Otherwise, if this is a course, the text returned
9667: will be a custom name for the role (if defined in the course's
9668: environment). If no custom name is defined the default is returned.
9669:
1.832 raeburn 9670: =item *
9671:
1.935 raeburn 9672: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 9673: All arguments are optional. Returns a hash of a roles, either for
9674: co-author/assistant author roles for a user's Construction Space
1.906 albertel 9675: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 9676: In the hash, keys are set to colon-separated $uname,$udom,$role, and
9677: (optionally) if $withsec is true, a fourth colon-separated item - $section.
9678: For each key, value is set to colon-separated start and end times for
9679: the role. If no username and domain are specified, will default to
1.934 raeburn 9680: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 9681: of role statuses (active, future or previous), roles
9682: (e.g., cc,in, st etc.) and domains of the roles which can be used
9683: to restrict the list of roles reported. If no array ref is
9684: provided for types, will default to return only active roles.
1.834 albertel 9685:
1.243 albertel 9686: =back
9687:
9688: =head2 User Modification
9689:
9690: =over 4
9691:
9692: =item *
9693:
1.957 raeburn 9694: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 9695: user for the level given by URL. Optional start and end dates (leave empty
9696: string or zero for "no date")
1.191 harris41 9697:
9698: =item *
9699:
1.243 albertel 9700: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
9701: change a users, password, possible return values are: ok,
9702: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
9703: refused
1.191 harris41 9704:
9705: =item *
9706:
1.243 albertel 9707: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 9708:
9709: =item *
9710:
1.963 raeburn 9711: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
9712: $forceid,$desiredhome,$email,$inststatus) :
1.243 albertel 9713: modify user
1.191 harris41 9714:
9715: =item *
9716:
1.286 matthew 9717: modifystudent
9718:
1.957 raeburn 9719: modify a student's enrollment and identification information.
1.286 matthew 9720: The course id is resolved based on the current users environment.
9721: This means the envoking user must be a course coordinator or otherwise
9722: associated with a course.
9723:
1.297 matthew 9724: This call is essentially a wrapper for lonnet::modifyuser and
9725: lonnet::modify_student_enrollment
1.286 matthew 9726:
9727: Inputs:
9728:
9729: =over 4
9730:
1.957 raeburn 9731: =item B<$udom> Student's loncapa domain
1.286 matthew 9732:
1.957 raeburn 9733: =item B<$uname> Student's loncapa login name
1.286 matthew 9734:
1.964 bisitz 9735: =item B<$uid> Student/Employee ID
1.286 matthew 9736:
1.957 raeburn 9737: =item B<$umode> Student's authentication mode
1.286 matthew 9738:
1.957 raeburn 9739: =item B<$upass> Student's password
1.286 matthew 9740:
1.957 raeburn 9741: =item B<$first> Student's first name
1.286 matthew 9742:
1.957 raeburn 9743: =item B<$middle> Student's middle name
1.286 matthew 9744:
1.957 raeburn 9745: =item B<$last> Student's last name
1.286 matthew 9746:
1.957 raeburn 9747: =item B<$gene> Student's generation
1.286 matthew 9748:
1.957 raeburn 9749: =item B<$usec> Student's section in course
1.286 matthew 9750:
9751: =item B<$end> Unix time of the roles expiration
9752:
9753: =item B<$start> Unix time of the roles start date
9754:
9755: =item B<$forceid> If defined, allow $uid to be changed
9756:
9757: =item B<$desiredhome> server to use as home server for student
9758:
1.957 raeburn 9759: =item B<$email> Student's permanent e-mail address
9760:
9761: =item B<$type> Type of enrollment (auto or manual)
9762:
1.963 raeburn 9763: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
9764:
9765: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 9766:
1.963 raeburn 9767: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 9768:
1.963 raeburn 9769: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 9770:
1.963 raeburn 9771: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 9772:
1.286 matthew 9773: =back
1.297 matthew 9774:
9775: =item *
9776:
9777: modify_student_enrollment
9778:
9779: Change a students enrollment status in a class. The environment variable
9780: 'role.request.course' must be defined for this function to proceed.
9781:
9782: Inputs:
9783:
9784: =over 4
9785:
9786: =item $udom, students domain
9787:
9788: =item $uname, students name
9789:
9790: =item $uid, students user id
9791:
9792: =item $first, students first name
9793:
9794: =item $middle
9795:
9796: =item $last
9797:
9798: =item $gene
9799:
9800: =item $usec
9801:
9802: =item $end
9803:
9804: =item $start
9805:
1.957 raeburn 9806: =item $type
9807:
9808: =item $locktype
9809:
9810: =item $cid
9811:
9812: =item $selfenroll
9813:
9814: =item $context
9815:
1.297 matthew 9816: =back
9817:
1.191 harris41 9818:
9819: =item *
9820:
1.243 albertel 9821: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
9822: custom role; give a custom role to a user for the level given by URL. Specify
9823: name and domain of role author, and role name
1.191 harris41 9824:
9825: =item *
9826:
1.243 albertel 9827: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 9828:
9829: =item *
9830:
1.243 albertel 9831: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
9832:
9833: =back
9834:
9835: =head2 Course Infomation
9836:
9837: =over 4
1.191 harris41 9838:
9839: =item *
9840:
1.631 albertel 9841: coursedescription($courseid) : returns a hash of information about the
9842: specified course id, including all environment settings for the
9843: course, the description of the course will be in the hash under the
9844: key 'description'
1.191 harris41 9845:
9846: =item *
9847:
1.624 albertel 9848: resdata($name,$domain,$type,@which) : request for current parameter
9849: setting for a specific $type, where $type is either 'course' or 'user',
9850: @what should be a list of parameters to ask about. This routine caches
9851: answers for 5 minutes.
1.243 albertel 9852:
1.877 foxr 9853: =item *
9854:
9855: get_courseresdata($courseid, $domain) : dump the entire course resource
9856: data base, returning a hash that is keyed by the resource name and has
9857: values that are the resource value. I believe that the timestamps and
9858: versions are also returned.
9859:
9860:
1.243 albertel 9861: =back
9862:
9863: =head2 Course Modification
9864:
9865: =over 4
1.191 harris41 9866:
9867: =item *
9868:
1.243 albertel 9869: writecoursepref($courseid,%prefs) : write preferences (environment
9870: database) for a course
1.191 harris41 9871:
9872: =item *
9873:
1.243 albertel 9874: createcourse($udom,$description,$url) : make/modify course
9875:
9876: =back
9877:
9878: =head2 Resource Subroutines
9879:
9880: =over 4
1.191 harris41 9881:
9882: =item *
9883:
1.243 albertel 9884: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 9885:
9886: =item *
9887:
1.243 albertel 9888: repcopy($filename) : subscribes to the requested file, and attempts to
9889: replicate from the owning library server, Might return
1.607 raeburn 9890: 'unavailable', 'not_found', 'forbidden', 'ok', or
9891: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 9892: resource. Expects the local filesystem pathname
9893: (/home/httpd/html/res/....)
9894:
9895: =back
9896:
9897: =head2 Resource Information
9898:
9899: =over 4
1.191 harris41 9900:
9901: =item *
9902:
1.243 albertel 9903: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
9904: a vairety of different possible values, $varname should be a request
9905: string, and the other parameters can be used to specify who and what
9906: one is asking about.
9907:
9908: Possible values for $varname are environment.lastname (or other item
9909: from the envirnment hash), user.name (or someother aspect about the
9910: user), resource.0.maxtries (or some other part and parameter of a
9911: resource)
1.204 albertel 9912:
9913: =item *
9914:
1.243 albertel 9915: directcondval($number) : get current value of a condition; reads from a state
9916: string
1.204 albertel 9917:
9918: =item *
9919:
1.243 albertel 9920: condval($condidx) : value of condition index based on state
1.204 albertel 9921:
9922: =item *
9923:
1.243 albertel 9924: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
9925: resource's metadata, $what should be either a specific key, or either
9926: 'keys' (to get a list of possible keys) or 'packages' to get a list of
9927: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
9928:
9929: this function automatically caches all requests
1.191 harris41 9930:
9931: =item *
9932:
1.243 albertel 9933: metadata_query($query,$custom,$customshow) : make a metadata query against the
9934: network of library servers; returns file handle of where SQL and regex results
9935: will be stored for query
1.191 harris41 9936:
9937: =item *
9938:
1.243 albertel 9939: symbread($filename) : return symbolic list entry (filename argument optional);
9940: returns the data handle
1.191 harris41 9941:
9942: =item *
9943:
1.243 albertel 9944: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 9945: a possible symb for the URL in $thisfn, and if is an encryypted
9946: resource that the user accessed using /enc/ returns a 1 on success, 0
9947: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 9948: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 9949:
1.191 harris41 9950:
9951: =item *
9952:
1.243 albertel 9953: symbclean($symb) : removes versions numbers from a symb, returns the
9954: cleaned symb
1.191 harris41 9955:
9956: =item *
9957:
1.243 albertel 9958: is_on_map($uri) : checks if the $uri is somewhere on the current
9959: course map, user must be in a course for it to work.
1.191 harris41 9960:
9961: =item *
9962:
1.243 albertel 9963: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 9964:
9965: =item *
9966:
1.243 albertel 9967: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
9968: a random seed, all arguments are optional, if they aren't sent it uses the
9969: environment to derive them. Note: if symb isn't sent and it can't get one
9970: from &symbread it will use the current time as its return value
1.191 harris41 9971:
9972: =item *
9973:
1.243 albertel 9974: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
9975: unfakeable, receipt
1.191 harris41 9976:
9977: =item *
9978:
1.620 albertel 9979: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 9980:
9981: =item *
9982:
1.243 albertel 9983: countacc($url) : count the number of accesses to a given URL
1.191 harris41 9984:
9985: =item *
9986:
1.243 albertel 9987: 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
1.191 harris41 9988:
9989: =item *
9990:
1.243 albertel 9991: 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)
1.191 harris41 9992:
9993: =item *
9994:
1.243 albertel 9995: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 9996:
9997: =item *
9998:
1.243 albertel 9999: devalidate($symb) : devalidate temporary spreadsheet calculations,
10000: forcing spreadsheet to reevaluate the resource scores next time.
10001:
10002: =back
10003:
10004: =head2 Storing/Retreiving Data
10005:
10006: =over 4
1.191 harris41 10007:
10008: =item *
10009:
1.243 albertel 10010: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10011: for this url; hashref needs to be given and should be a \%hashname; the
10012: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10013: be derived from the env
1.191 harris41 10014:
10015: =item *
10016:
1.243 albertel 10017: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10018: uses critical subroutine
1.191 harris41 10019:
10020: =item *
10021:
1.243 albertel 10022: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10023: all args are optional
1.191 harris41 10024:
10025: =item *
10026:
1.717 albertel 10027: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10028: dumps the complete (or key matching regexp) namespace into a hash
10029: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10030: normally &store()ed into
10031:
10032: $range should be either an integer '100' (give me the first 100
10033: matching records)
10034: or be two integers sperated by a - with no spaces
10035: '30-50' (give me the 30th through the 50th matching
10036: records)
10037:
10038:
10039: =item *
10040:
10041: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10042: replaces a &store() version of data with a replacement set of data
10043: for a particular resource in a namespace passed in the $storehash hash
10044: reference
10045:
10046: =item *
10047:
1.243 albertel 10048: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10049: works very similar to store/cstore, but all data is stored in a
10050: temporary location and can be reset using tmpreset, $storehash should
10051: be a hash reference, returns nothing on success
1.191 harris41 10052:
10053: =item *
10054:
1.243 albertel 10055: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10056: similar to restore, but all data is stored in a temporary location and
10057: can be reset using tmpreset. Returns a hash of values on success,
10058: error string otherwise.
1.191 harris41 10059:
10060: =item *
10061:
1.243 albertel 10062: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10063: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10064:
10065: =item *
10066:
1.243 albertel 10067: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10068: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10069:
10070: =item *
10071:
1.243 albertel 10072: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10073: namesp ($udom and $uname are optional)
1.191 harris41 10074:
10075: =item *
10076:
1.702 albertel 10077: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10078: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10079: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10080:
1.702 albertel 10081: $range should be either an integer '100' (give me the first 100
10082: matching records)
10083: or be two integers sperated by a - with no spaces
10084: '30-50' (give me the 30th through the 50th matching
10085: records)
1.449 matthew 10086: =item *
10087:
10088: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10089: $store can be a scalar, an array reference, or if the amount to be
10090: incremented is > 1, a hash reference.
10091:
10092: ($udom and $uname are optional)
1.191 harris41 10093:
10094: =item *
10095:
1.243 albertel 10096: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10097: ($udom and $uname are optional)
1.191 harris41 10098:
10099: =item *
10100:
1.243 albertel 10101: cput($namespace,$storehash,$udom,$uname) : critical put
10102: ($udom and $uname are optional)
1.191 harris41 10103:
10104: =item *
10105:
1.748 albertel 10106: newput($namespace,$storehash,$udom,$uname) :
10107:
10108: Attempts to store the items in the $storehash, but only if they don't
10109: currently exist, if this succeeds you can be certain that you have
10110: successfully created a new key value pair in the $namespace db.
10111:
10112:
10113: Args:
10114: $namespace: name of database to store values to
10115: $storehash: hashref to store to the db
10116: $udom: (optional) domain of user containing the db
10117: $uname: (optional) name of user caontaining the db
10118:
10119: Returns:
10120: 'ok' -> succeeded in storing all keys of $storehash
10121: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10122: least <key> already existed in the db (other
10123: requested keys may also already exist)
1.967 bisitz 10124: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10125: 'con_lost' -> unable to contact request server
10126: 'refused' -> action was not allowed by remote machine
10127:
10128:
10129: =item *
10130:
1.243 albertel 10131: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10132: reference filled in from namesp (encrypts the return communication)
10133: ($udom and $uname are optional)
1.191 harris41 10134:
10135: =item *
10136:
1.243 albertel 10137: log($udom,$name,$home,$message) : write to permanent log for user; use
10138: critical subroutine
10139:
1.806 raeburn 10140: =item *
10141:
1.860 raeburn 10142: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10143: array reference filled in from namespace found in domain level on either
10144: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10145:
10146: =item *
10147:
1.860 raeburn 10148: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10149: domain level either on specified domain server ($uhome) or primary domain
10150: server ($udom and $uhome are optional)
1.806 raeburn 10151:
1.943 raeburn 10152: =item *
10153:
10154: get_domain_defaults($target_domain) : returns hash with defaults for
10155: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10156: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10157: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10158: Values are retrieved from cache (if current), or from domain's configuration.db
10159: (if available), or lastly from values in lonTabs/dns_domain,tab,
10160: or lonTabs/domain.tab.
10161:
10162: %domdefaults = &get_auth_defaults($target_domain);
10163:
1.243 albertel 10164: =back
10165:
10166: =head2 Network Status Functions
10167:
10168: =over 4
1.191 harris41 10169:
10170: =item *
10171:
10172: dirlist($uri) : return directory list based on URI
10173:
10174: =item *
10175:
1.243 albertel 10176: spareserver() : find server with least workload from spare.tab
10177:
1.986 foxr 10178:
10179: =item *
10180:
10181: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10182: if there is no corresponding loncapa host.
10183:
1.243 albertel 10184: =back
10185:
1.986 foxr 10186:
1.243 albertel 10187: =head2 Apache Request
10188:
10189: =over 4
1.191 harris41 10190:
10191: =item *
10192:
1.243 albertel 10193: ssi($url,%hash) : server side include, does a complete request cycle on url to
10194: localhost, posts hash
10195:
10196: =back
10197:
10198: =head2 Data to String to Data
10199:
10200: =over 4
1.191 harris41 10201:
10202: =item *
10203:
1.243 albertel 10204: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10205: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10206:
10207: =item *
10208:
1.243 albertel 10209: hashref2str($hashref) : convert a hashref into a string complete with
10210: escaping and '=' and '&' separators, supports elements that are
10211: arrayrefs and hashrefs
1.191 harris41 10212:
10213: =item *
10214:
1.243 albertel 10215: arrayref2str($arrayref) : convert an arrayref into a string complete
10216: with escaping and '&' separators, supports elements that are arrayrefs
10217: and hashrefs
1.191 harris41 10218:
10219: =item *
10220:
1.243 albertel 10221: str2hash($string) : convert string to hash using unescaping and
10222: splitting on '=' and '&', supports elements that are arrayrefs and
10223: hashrefs
1.191 harris41 10224:
10225: =item *
10226:
1.243 albertel 10227: str2array($string) : convert string to hash using unescaping and
10228: splitting on '&', supports elements that are arrayrefs and hashrefs
10229:
10230: =back
10231:
10232: =head2 Logging Routines
10233:
10234: =over 4
10235:
10236: These routines allow one to make log messages in the lonnet.log and
10237: lonnet.perm logfiles.
1.191 harris41 10238:
10239: =item *
10240:
1.243 albertel 10241: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10242:
10243: =item *
10244:
1.243 albertel 10245: logthis() : append message to the normal lonnet.log file, it gets
10246: preiodically rolled over and deleted.
1.191 harris41 10247:
10248: =item *
10249:
1.243 albertel 10250: logperm() : append a permanent message to lonnet.perm.log, this log
10251: file never gets deleted by any automated portion of the system, only
10252: messages of critical importance should go in here.
10253:
10254: =back
10255:
10256: =head2 General File Helper Routines
10257:
10258: =over 4
1.191 harris41 10259:
10260: =item *
10261:
1.481 raeburn 10262: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10263: (a) files in /uploaded
10264: (i) If a local copy of the file exists -
10265: compares modification date of local copy with last-modified date for
10266: definitive version stored on home server for course. If local copy is
10267: stale, requests a new version from the home server and stores it.
10268: If the original has been removed from the home server, then local copy
10269: is unlinked.
10270: (ii) If local copy does not exist -
10271: requests the file from the home server and stores it.
10272:
10273: If $caller is 'uploadrep':
10274: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10275: for request for files originally uploaded via DOCS.
10276: - returns 'ok' if fresh local copy now available, -1 otherwise.
10277:
10278: Otherwise:
10279: This indicates a call from the content generation phase of the request.
10280: - returns the entire contents of the file or -1.
10281:
10282: (b) files in /res
10283: - returns the entire contents of a file or -1;
10284: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10285:
1.712 albertel 10286:
10287: =item *
10288:
10289: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10290: reference
10291:
10292: returns either a stat() list of data about the file or an empty list
10293: if the file doesn't exist or couldn't find out about it (connection
10294: problems or user unknown)
10295:
1.191 harris41 10296: =item *
10297:
1.243 albertel 10298: filelocation($dir,$file) : returns file system location of a file
10299: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10300: directory that relative $file lookups are to looked in ($dir of /a/dir
10301: and a file of ../bob will become /a/bob)
1.191 harris41 10302:
10303: =item *
10304:
10305: hreflocation($dir,$file) : returns file system location or a URL; same as
10306: filelocation except for hrefs
10307:
10308: =item *
10309:
10310: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10311:
1.243 albertel 10312: =back
10313:
1.608 albertel 10314: =head2 Usererfile file routines (/uploaded*)
10315:
10316: =over 4
10317:
10318: =item *
10319:
10320: userfileupload(): main rotine for putting a file in a user or course's
10321: filespace, arguments are,
10322:
1.620 albertel 10323: formname - required - this is the name of the element in $env where the
1.608 albertel 10324: filename, and the contents of the file to create/modifed exist
1.620 albertel 10325: the filename is in $env{'form.'.$formname.'.filename'} and the
10326: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 10327: coursedoc - if true, store the file in the course of the active role
10328: of the current user
10329: subdir - required - subdirectory to put the file in under ../userfiles/
10330: if undefined, it will be placed in "unknown"
10331:
10332: (This routine calls clean_filename() to remove any dangerous
10333: characters from the filename, and then calls finuserfileupload() to
10334: complete the transaction)
10335:
10336: returns either the url of the uploaded file (/uploaded/....) if successful
10337: and /adm/notfound.html if unsuccessful
10338:
10339: =item *
10340:
10341: clean_filename(): routine for cleaing a filename up for storage in
10342: userfile space, argument is:
10343:
10344: filename - proposed filename
10345:
10346: returns: the new clean filename
10347:
10348: =item *
10349:
10350: finishuserfileupload(): routine that creaes and sends the file to
10351: userspace, probably shouldn't be called directly
10352:
10353: docuname: username or courseid of destination for the file
10354: docudom: domain of user/course of destination for the file
10355: formname: same as for userfileupload()
10356: fname: filename (inculding subdirectories) for the file
10357:
10358: returns either the url of the uploaded file (/uploaded/....) if successful
10359: and /adm/notfound.html if unsuccessful
10360:
10361: =item *
10362:
10363: renameuserfile(): renames an existing userfile to a new name
10364:
10365: Args:
10366: docuname: username or courseid of destination for the file
10367: docudom: domain of user/course of destination for the file
10368: old: current file name (including any subdirs under userfiles)
10369: new: desired file name (including any subdirs under userfiles)
10370:
10371: =item *
10372:
10373: mkdiruserfile(): creates a directory is a userfiles dir
10374:
10375: Args:
10376: docuname: username or courseid of destination for the file
10377: docudom: domain of user/course of destination for the file
10378: dir: dir to create (including any subdirs under userfiles)
10379:
10380: =item *
10381:
10382: removeuserfile(): removes a file that exists in userfiles
10383:
10384: Args:
10385: docuname: username or courseid of destination for the file
10386: docudom: domain of user/course of destination for the file
10387: fname: filname to delete (including any subdirs under userfiles)
10388:
10389: =item *
10390:
10391: removeuploadedurl(): convience function for removeuserfile()
10392:
10393: Args:
10394: url: a full /uploaded/... url to delete
10395:
1.747 albertel 10396: =item *
10397:
10398: get_portfile_permissions():
10399: Args:
10400: domain: domain of user or course contain the portfolio files
10401: user: name of user or num of course contain the portfolio files
10402: Returns:
10403: hashref of a dump of the proper file_permissions.db
10404:
10405:
10406: =item *
10407:
10408: get_access_controls():
10409:
10410: Args:
10411: current_permissions: the hash ref returned from get_portfile_permissions()
10412: group: (optional) the group you want the files associated with
10413: file: (optional) the file you want access info on
10414:
10415: Returns:
1.749 raeburn 10416: a hash (keys are file names) of hashes containing
10417: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10418: values are XML containing access control settings (see below)
1.747 albertel 10419:
10420: Internal notes:
10421:
1.749 raeburn 10422: access controls are stored in file_permissions.db as key=value pairs.
10423: key -> path to file/file_name\0uniqueID:scope_end_start
10424: where scope -> public,guest,course,group,domains or users.
10425: end -> UNIX time for end of access (0 -> no end date)
10426: start -> UNIX time for start of access
10427:
10428: value -> XML description of access control
10429: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10430: <start></start>
10431: <end></end>
10432:
10433: <password></password> for scope type = guest
10434:
10435: <domain></domain> for scope type = course or group
10436: <number></number>
10437: <roles id="">
10438: <role></role>
10439: <access></access>
10440: <section></section>
10441: <group></group>
10442: </roles>
10443:
10444: <dom></dom> for scope type = domains
10445:
10446: <users> for scope type = users
10447: <user>
10448: <uname></uname>
10449: <udom></udom>
10450: </user>
10451: </users>
10452: </scope>
10453:
10454: Access data is also aggregated for each file in an additional key=value pair:
10455: key -> path to file/file_name\0accesscontrol
10456: value -> reference to hash
10457: hash contains key = value pairs
10458: where key = uniqueID:scope_end_start
10459: value = UNIX time record was last updated
10460:
10461: Used to improve speed of look-ups of access controls for each file.
10462:
10463: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
10464:
10465: modify_access_controls():
10466:
10467: Modifies access controls for a portfolio file
10468: Args
10469: 1. file name
10470: 2. reference to hash of required changes,
10471: 3. domain
10472: 4. username
10473: where domain,username are the domain of the portfolio owner
10474: (either a user or a course)
10475:
10476: Returns:
10477: 1. result of additions or updates ('ok' or 'error', with error message).
10478: 2. result of deletions ('ok' or 'error', with error message).
10479: 3. reference to hash of any new or updated access controls.
10480: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
10481: key = integer (inbound ID)
10482: value = uniqueID
1.747 albertel 10483:
1.608 albertel 10484: =back
10485:
1.243 albertel 10486: =head2 HTTP Helper Routines
10487:
10488: =over 4
10489:
1.191 harris41 10490: =item *
10491:
10492: escape() : unpack non-word characters into CGI-compatible hex codes
10493:
10494: =item *
10495:
10496: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
10497:
1.243 albertel 10498: =back
10499:
10500: =head1 PRIVATE SUBROUTINES
10501:
10502: =head2 Underlying communication routines (Shouldn't call)
10503:
10504: =over 4
10505:
10506: =item *
10507:
10508: subreply() : tries to pass a message to lonc, returns con_lost if incapable
10509:
10510: =item *
10511:
10512: reply() : uses subreply to send a message to remote machine, logs all failures
10513:
10514: =item *
10515:
10516: critical() : passes a critical message to another server; if cannot
10517: get through then place message in connection buffer directory and
10518: returns con_delayed, if incapable of saving message, returns
10519: con_failed
10520:
10521: =item *
10522:
10523: reconlonc() : tries to reconnect lonc client processes.
10524:
10525: =back
10526:
10527: =head2 Resource Access Logging
10528:
10529: =over 4
10530:
10531: =item *
10532:
10533: flushcourselogs() : flush (save) buffer logs and access logs
10534:
10535: =item *
10536:
10537: courselog($what) : save message for course in hash
10538:
10539: =item *
10540:
10541: courseacclog($what) : save message for course using &courselog(). Perform
10542: special processing for specific resource types (problems, exams, quizzes, etc).
10543:
1.191 harris41 10544: =item *
10545:
10546: goodbye() : flush course logs and log shutting down; it is called in srm.conf
10547: as a PerlChildExitHandler
1.243 albertel 10548:
10549: =back
10550:
10551: =head2 Other
10552:
10553: =over 4
10554:
10555: =item *
10556:
10557: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 10558:
10559: =back
10560:
10561: =cut
1.877 foxr 10562:
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