File:
[LON-CAPA] /
loncom /
lond
Revision
1.466:
download - view:
text,
annotated -
select for diffs
Fri Nov 12 21:52:51 2010 UTC (13 years, 11 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- In light of bug 6377, enforce timeout of 3s for each call to get courseinfo
(nohist_courseids.db entry) for a course with a different home server.
- Such calls occur when courseinfo for course is not cached, and user's own roles
are being retrieved (home server is 2.10) but user session is on a
pre-2.10 server, and course's home server is on a different library server.
1: #!/usr/bin/perl
2: # The LearningOnline Network
3: # lond "LON Daemon" Server (port "LOND" 5663)
4: #
5: # $Id: lond,v 1.466 2010/11/12 21:52:51 raeburn Exp $
6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27:
28:
29: # http://www.lon-capa.org/
30: #
31:
32: use strict;
33: use lib '/home/httpd/lib/perl/';
34: use LONCAPA;
35: use LONCAPA::Configuration;
36:
37: use IO::Socket;
38: use IO::File;
39: #use Apache::File;
40: use POSIX;
41: use Crypt::IDEA;
42: use LWP::UserAgent();
43: use Digest::MD5 qw(md5_hex);
44: use GDBM_File;
45: use Authen::Krb5;
46: use localauth;
47: use localenroll;
48: use localstudentphoto;
49: use File::Copy;
50: use File::Find;
51: use LONCAPA::lonlocal;
52: use LONCAPA::lonssl;
53: use Fcntl qw(:flock);
54: use Apache::lonnet;
55:
56: my $DEBUG = 0; # Non zero to enable debug log entries.
57:
58: my $status='';
59: my $lastlog='';
60:
61: my $VERSION='$Revision: 1.466 $'; #' stupid emacs
62: my $remoteVERSION;
63: my $currenthostid="default";
64: my $currentdomainid;
65:
66: my $client;
67: my $clientip; # IP address of client.
68: my $clientname; # LonCAPA name of client.
69: my $clientversion; # LonCAPA version running on client.
70: my $clienthomedom; # LonCAPA domain of homeID for client.
71: # primary library server.
72:
73: my $server;
74:
75: my $keymode;
76:
77: my $cipher; # Cipher key negotiated with client
78: my $tmpsnum = 0; # Id of tmpputs.
79:
80: #
81: # Connection type is:
82: # client - All client actions are allowed
83: # manager - only management functions allowed.
84: # both - Both management and client actions are allowed
85: #
86:
87: my $ConnectionType;
88:
89: my %managers; # Ip -> manager names
90:
91: my %perlvar; # Will have the apache conf defined perl vars.
92:
93: #
94: # The hash below is used for command dispatching, and is therefore keyed on the request keyword.
95: # Each element of the hash contains a reference to an array that contains:
96: # A reference to a sub that executes the request corresponding to the keyword.
97: # A flag that is true if the request must be encoded to be acceptable.
98: # A mask with bits as follows:
99: # CLIENT_OK - Set when the function is allowed by ordinary clients
100: # MANAGER_OK - Set when the function is allowed to manager clients.
101: #
102: my $CLIENT_OK = 1;
103: my $MANAGER_OK = 2;
104: my %Dispatcher;
105:
106:
107: #
108: # The array below are password error strings."
109: #
110: my $lastpwderror = 13; # Largest error number from lcpasswd.
111: my @passwderrors = ("ok",
112: "pwchange_failure - lcpasswd must be run as user 'www'",
113: "pwchange_failure - lcpasswd got incorrect number of arguments",
114: "pwchange_failure - lcpasswd did not get the right nubmer of input text lines",
115: "pwchange_failure - lcpasswd too many simultaneous pwd changes in progress",
116: "pwchange_failure - lcpasswd User does not exist.",
117: "pwchange_failure - lcpasswd Incorrect current passwd",
118: "pwchange_failure - lcpasswd Unable to su to root.",
119: "pwchange_failure - lcpasswd Cannot set new passwd.",
120: "pwchange_failure - lcpasswd Username has invalid characters",
121: "pwchange_failure - lcpasswd Invalid characters in password",
122: "pwchange_failure - lcpasswd User already exists",
123: "pwchange_failure - lcpasswd Something went wrong with user addition.",
124: "pwchange_failure - lcpasswd Password mismatch",
125: "pwchange_failure - lcpasswd Error filename is invalid");
126:
127:
128: # The array below are lcuseradd error strings.:
129:
130: my $lastadderror = 13;
131: my @adderrors = ("ok",
132: "User ID mismatch, lcuseradd must run as user www",
133: "lcuseradd Incorrect number of command line parameters must be 3",
134: "lcuseradd Incorrect number of stdinput lines, must be 3",
135: "lcuseradd Too many other simultaneous pwd changes in progress",
136: "lcuseradd User does not exist",
137: "lcuseradd Unable to make www member of users's group",
138: "lcuseradd Unable to su to root",
139: "lcuseradd Unable to set password",
140: "lcuseradd Username has invalid characters",
141: "lcuseradd Password has an invalid character",
142: "lcuseradd User already exists",
143: "lcuseradd Could not add user.",
144: "lcuseradd Password mismatch");
145:
146:
147: # This array are the errors from lcinstallfile:
148:
149: my @installerrors = ("ok",
150: "Initial user id of client not that of www",
151: "Usage error, not enough command line arguments",
152: "Source file name does not exist",
153: "Destination file name does not exist",
154: "Some file operation failed",
155: "Invalid table filename."
156: );
157:
158: #
159: # Statistics that are maintained and dislayed in the status line.
160: #
161: my $Transactions = 0; # Number of attempted transactions.
162: my $Failures = 0; # Number of transcations failed.
163:
164: # ResetStatistics:
165: # Resets the statistics counters:
166: #
167: sub ResetStatistics {
168: $Transactions = 0;
169: $Failures = 0;
170: }
171:
172: #------------------------------------------------------------------------
173: #
174: # LocalConnection
175: # Completes the formation of a locally authenticated connection.
176: # This function will ensure that the 'remote' client is really the
177: # local host. If not, the connection is closed, and the function fails.
178: # If so, initcmd is parsed for the name of a file containing the
179: # IDEA session key. The fie is opened, read, deleted and the session
180: # key returned to the caller.
181: #
182: # Parameters:
183: # $Socket - Socket open on client.
184: # $initcmd - The full text of the init command.
185: #
186: # Returns:
187: # IDEA session key on success.
188: # undef on failure.
189: #
190: sub LocalConnection {
191: my ($Socket, $initcmd) = @_;
192: Debug("Attempting local connection: $initcmd client: $clientip");
193: if($clientip ne "127.0.0.1") {
194: &logthis('<font color="red"> LocalConnection rejecting non local: '
195: ."$clientip ne 127.0.0.1 </font>");
196: close $Socket;
197: return undef;
198: } else {
199: chomp($initcmd); # Get rid of \n in filename.
200: my ($init, $type, $name) = split(/:/, $initcmd);
201: Debug(" Init command: $init $type $name ");
202:
203: # Require that $init = init, and $type = local: Otherwise
204: # the caller is insane:
205:
206: if(($init ne "init") && ($type ne "local")) {
207: &logthis('<font color = "red"> LocalConnection: caller is insane! '
208: ."init = $init, and type = $type </font>");
209: close($Socket);;
210: return undef;
211:
212: }
213: # Now get the key filename:
214:
215: my $IDEAKey = lonlocal::ReadKeyFile($name);
216: return $IDEAKey;
217: }
218: }
219: #------------------------------------------------------------------------------
220: #
221: # SSLConnection
222: # Completes the formation of an ssh authenticated connection. The
223: # socket is promoted to an ssl socket. If this promotion and the associated
224: # certificate exchange are successful, the IDEA key is generated and sent
225: # to the remote peer via the SSL tunnel. The IDEA key is also returned to
226: # the caller after the SSL tunnel is torn down.
227: #
228: # Parameters:
229: # Name Type Purpose
230: # $Socket IO::Socket::INET Plaintext socket.
231: #
232: # Returns:
233: # IDEA key on success.
234: # undef on failure.
235: #
236: sub SSLConnection {
237: my $Socket = shift;
238:
239: Debug("SSLConnection: ");
240: my $KeyFile = lonssl::KeyFile();
241: if(!$KeyFile) {
242: my $err = lonssl::LastError();
243: &logthis("<font color=\"red\"> CRITICAL"
244: ."Can't get key file $err </font>");
245: return undef;
246: }
247: my ($CACertificate,
248: $Certificate) = lonssl::CertificateFile();
249:
250:
251: # If any of the key, certificate or certificate authority
252: # certificate filenames are not defined, this can't work.
253:
254: if((!$Certificate) || (!$CACertificate)) {
255: my $err = lonssl::LastError();
256: &logthis("<font color=\"red\"> CRITICAL"
257: ."Can't get certificates: $err </font>");
258:
259: return undef;
260: }
261: Debug("Key: $KeyFile CA: $CACertificate Cert: $Certificate");
262:
263: # Indicate to our peer that we can procede with
264: # a transition to ssl authentication:
265:
266: print $Socket "ok:ssl\n";
267:
268: Debug("Approving promotion -> ssl");
269: # And do so:
270:
271: my $SSLSocket = lonssl::PromoteServerSocket($Socket,
272: $CACertificate,
273: $Certificate,
274: $KeyFile);
275: if(! ($SSLSocket) ) { # SSL socket promotion failed.
276: my $err = lonssl::LastError();
277: &logthis("<font color=\"red\"> CRITICAL "
278: ."SSL Socket promotion failed: $err </font>");
279: return undef;
280: }
281: Debug("SSL Promotion successful");
282:
283: #
284: # The only thing we'll use the socket for is to send the IDEA key
285: # to the peer:
286:
287: my $Key = lonlocal::CreateCipherKey();
288: print $SSLSocket "$Key\n";
289:
290: lonssl::Close($SSLSocket);
291:
292: Debug("Key exchange complete: $Key");
293:
294: return $Key;
295: }
296: #
297: # InsecureConnection:
298: # If insecure connections are allowd,
299: # exchange a challenge with the client to 'validate' the
300: # client (not really, but that's the protocol):
301: # We produce a challenge string that's sent to the client.
302: # The client must then echo the challenge verbatim to us.
303: #
304: # Parameter:
305: # Socket - Socket open on the client.
306: # Returns:
307: # 1 - success.
308: # 0 - failure (e.g.mismatch or insecure not allowed).
309: #
310: sub InsecureConnection {
311: my $Socket = shift;
312:
313: # Don't even start if insecure connections are not allowed.
314:
315: if(! $perlvar{londAllowInsecure}) { # Insecure connections not allowed.
316: return 0;
317: }
318:
319: # Fabricate a challenge string and send it..
320:
321: my $challenge = "$$".time; # pid + time.
322: print $Socket "$challenge\n";
323: &status("Waiting for challenge reply");
324:
325: my $answer = <$Socket>;
326: $answer =~s/\W//g;
327: if($challenge eq $answer) {
328: return 1;
329: } else {
330: logthis("<font color='blue'>WARNING client did not respond to challenge</font>");
331: &status("No challenge reqply");
332: return 0;
333: }
334:
335:
336: }
337: #
338: # Safely execute a command (as long as it's not a shel command and doesn
339: # not require/rely on shell escapes. The function operates by doing a
340: # a pipe based fork and capturing stdout and stderr from the pipe.
341: #
342: # Formal Parameters:
343: # $line - A line of text to be executed as a command.
344: # Returns:
345: # The output from that command. If the output is multiline the caller
346: # must know how to split up the output.
347: #
348: #
349: sub execute_command {
350: my ($line) = @_;
351: my @words = split(/\s/, $line); # Bust the command up into words.
352: my $output = "";
353:
354: my $pid = open(CHILD, "-|");
355:
356: if($pid) { # Parent process
357: Debug("In parent process for execute_command");
358: my @data = <CHILD>; # Read the child's outupt...
359: close CHILD;
360: foreach my $output_line (@data) {
361: Debug("Adding $output_line");
362: $output .= $output_line; # Presumably has a \n on it.
363: }
364:
365: } else { # Child process
366: close (STDERR);
367: open (STDERR, ">&STDOUT");# Combine stderr, and stdout...
368: exec(@words); # won't return.
369: }
370: return $output;
371: }
372:
373:
374: # GetCertificate: Given a transaction that requires a certificate,
375: # this function will extract the certificate from the transaction
376: # request. Note that at this point, the only concept of a certificate
377: # is the hostname to which we are connected.
378: #
379: # Parameter:
380: # request - The request sent by our client (this parameterization may
381: # need to change when we really use a certificate granting
382: # authority.
383: #
384: sub GetCertificate {
385: my $request = shift;
386:
387: return $clientip;
388: }
389:
390: #
391: # Return true if client is a manager.
392: #
393: sub isManager {
394: return (($ConnectionType eq "manager") || ($ConnectionType eq "both"));
395: }
396: #
397: # Return tru if client can do client functions
398: #
399: sub isClient {
400: return (($ConnectionType eq "client") || ($ConnectionType eq "both"));
401: }
402:
403:
404: #
405: # ReadManagerTable: Reads in the current manager table. For now this is
406: # done on each manager authentication because:
407: # - These authentications are not frequent
408: # - This allows dynamic changes to the manager table
409: # without the need to signal to the lond.
410: #
411: sub ReadManagerTable {
412:
413: &Debug("Reading manager table");
414: # Clean out the old table first..
415:
416: foreach my $key (keys %managers) {
417: delete $managers{$key};
418: }
419:
420: my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
421: if (!open (MANAGERS, $tablename)) {
422: logthis('<font color="red">No manager table. Nobody can manage!!</font>');
423: return;
424: }
425: while(my $host = <MANAGERS>) {
426: chomp($host);
427: if ($host =~ "^#") { # Comment line.
428: next;
429: }
430: if (!defined &Apache::lonnet::get_host_ip($host)) { # This is a non cluster member
431: # The entry is of the form:
432: # cluname:hostname
433: # cluname - A 'cluster hostname' is needed in order to negotiate
434: # the host key.
435: # hostname- The dns name of the host.
436: #
437: my($cluname, $dnsname) = split(/:/, $host);
438:
439: my $ip = gethostbyname($dnsname);
440: if(defined($ip)) { # bad names don't deserve entry.
441: my $hostip = inet_ntoa($ip);
442: $managers{$hostip} = $cluname;
443: logthis('<font color="green"> registering manager '.
444: "$dnsname as $cluname with $hostip </font>\n");
445: }
446: } else {
447: logthis('<font color="green"> existing host'." $host</font>\n");
448: $managers{&Apache::lonnet::get_host_ip($host)} = $host; # Use info from cluster tab if clumemeber
449: }
450: }
451: }
452:
453: #
454: # ValidManager: Determines if a given certificate represents a valid manager.
455: # in this primitive implementation, the 'certificate' is
456: # just the connecting loncapa client name. This is checked
457: # against a valid client list in the configuration.
458: #
459: #
460: sub ValidManager {
461: my $certificate = shift;
462:
463: return isManager;
464: }
465: #
466: # CopyFile: Called as part of the process of installing a
467: # new configuration file. This function copies an existing
468: # file to a backup file.
469: # Parameters:
470: # oldfile - Name of the file to backup.
471: # newfile - Name of the backup file.
472: # Return:
473: # 0 - Failure (errno has failure reason).
474: # 1 - Success.
475: #
476: sub CopyFile {
477:
478: my ($oldfile, $newfile) = @_;
479:
480: if (! copy($oldfile,$newfile)) {
481: return 0;
482: }
483: chmod(0660, $newfile);
484: return 1;
485: }
486: #
487: # Host files are passed out with externally visible host IPs.
488: # If, for example, we are behind a fire-wall or NAT host, our
489: # internally visible IP may be different than the externally
490: # visible IP. Therefore, we always adjust the contents of the
491: # host file so that the entry for ME is the IP that we believe
492: # we have. At present, this is defined as the entry that
493: # DNS has for us. If by some chance we are not able to get a
494: # DNS translation for us, then we assume that the host.tab file
495: # is correct.
496: # BUGBUGBUG - in the future, we really should see if we can
497: # easily query the interface(s) instead.
498: # Parameter(s):
499: # contents - The contents of the host.tab to check.
500: # Returns:
501: # newcontents - The adjusted contents.
502: #
503: #
504: sub AdjustHostContents {
505: my $contents = shift;
506: my $adjusted;
507: my $me = $perlvar{'lonHostID'};
508:
509: foreach my $line (split(/\n/,$contents)) {
510: if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
511: chomp($line);
512: my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
513: if ($id eq $me) {
514: my $ip = gethostbyname($name);
515: my $ipnew = inet_ntoa($ip);
516: $ip = $ipnew;
517: # Reconstruct the host line and append to adjusted:
518:
519: my $newline = "$id:$domain:$role:$name:$ip";
520: if($maxcon ne "") { # Not all hosts have loncnew tuning params
521: $newline .= ":$maxcon:$idleto:$mincon";
522: }
523: $adjusted .= $newline."\n";
524:
525: } else { # Not me, pass unmodified.
526: $adjusted .= $line."\n";
527: }
528: } else { # Blank or comment never re-written.
529: $adjusted .= $line."\n"; # Pass blanks and comments as is.
530: }
531: }
532: return $adjusted;
533: }
534: #
535: # InstallFile: Called to install an administrative file:
536: # - The file is created int a temp directory called <name>.tmp
537: # - lcinstall file is called to install the file.
538: # since the web app has no direct write access to the table directory
539: #
540: # Parameters:
541: # Name of the file
542: # File Contents.
543: # Return:
544: # nonzero - success.
545: # 0 - failure and $! has an errno.
546: # Assumptions:
547: # File installtion is a relatively infrequent
548: #
549: sub InstallFile {
550:
551: my ($Filename, $Contents) = @_;
552: # my $TempFile = $Filename.".tmp";
553: my $exedir = $perlvar{'lonDaemons'};
554: my $tmpdir = $exedir.'/tmp/';
555: my $TempFile = $tmpdir."TempTableFile.tmp";
556:
557: # Open the file for write:
558:
559: my $fh = IO::File->new("> $TempFile"); # Write to temp.
560: if(!(defined $fh)) {
561: &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
562: return 0;
563: }
564: # write the contents of the file:
565:
566: print $fh ($Contents);
567: $fh->close; # In case we ever have a filesystem w. locking
568:
569: chmod(0664, $TempFile); # Everyone can write it.
570:
571: # Use lcinstall file to put the file in the table directory...
572:
573: &Debug("Opening pipe to $exedir/lcinstallfile $TempFile $Filename");
574: my $pf = IO::File->new("| $exedir/lcinstallfile $TempFile $Filename > $exedir/logs/lcinstallfile.log");
575: close $pf;
576: my $err = $?;
577: &Debug("Status is $err");
578: if ($err != 0) {
579: my $msg = $err;
580: if ($err < @installerrors) {
581: $msg = $installerrors[$err];
582: }
583: &logthis("Install failed for table file $Filename : $msg");
584: return 0;
585: }
586:
587: # Remove the temp file:
588:
589: unlink($TempFile);
590:
591: return 1;
592: }
593:
594:
595: #
596: # ConfigFileFromSelector: converts a configuration file selector
597: # into a configuration file pathname.
598: # It's probably no longer necessary to preserve
599: # special handling of hosts or domain as those
600: # files have been superceded by dns_hosts, dns_domain.
601: # The default action is just to prepend the directory
602: # and append .tab
603: #
604: #
605: # Parameters:
606: # selector - Configuration file selector.
607: # Returns:
608: # Full path to the file or undef if the selector is invalid.
609: #
610: sub ConfigFileFromSelector {
611: my $selector = shift;
612: my $tablefile;
613:
614: my $tabledir = $perlvar{'lonTabDir'}.'/';
615: if ($selector eq "hosts") {
616: $tablefile = $tabledir."hosts.tab";
617: } elsif ($selector eq "domain") {
618: $tablefile = $tabledir."domain.tab";
619: } else {
620: $tablefile = $tabledir.$selector.'.tab';
621: }
622: return $tablefile;
623:
624: }
625: #
626: # PushFile: Called to do an administrative push of a file.
627: # - Ensure the file being pushed is one we support.
628: # - Backup the old file to <filename.saved>
629: # - Separate the contents of the new file out from the
630: # rest of the request.
631: # - Write the new file.
632: # Parameter:
633: # Request - The entire user request. This consists of a : separated
634: # string pushfile:tablename:contents.
635: # NOTE: The contents may have :'s in it as well making things a bit
636: # more interesting... but not much.
637: # Returns:
638: # String to send to client ("ok" or "refused" if bad file).
639: #
640: sub PushFile {
641: my $request = shift;
642: my ($command, $filename, $contents) = split(":", $request, 3);
643: &Debug("PushFile");
644:
645: # At this point in time, pushes for only the following tables are
646: # supported:
647: # hosts.tab ($filename eq host).
648: # domain.tab ($filename eq domain).
649: # Construct the destination filename or reject the request.
650: #
651: # lonManage is supposed to ensure this, however this session could be
652: # part of some elaborate spoof that managed somehow to authenticate.
653: #
654:
655:
656: my $tablefile = ConfigFileFromSelector($filename);
657: if(! (defined $tablefile)) {
658: return "refused";
659: }
660:
661: # If the file being pushed is the host file, we adjust the entry for ourself so that the
662: # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
663: # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
664: # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
665: # that possibilty.
666:
667: if($filename eq "host") {
668: $contents = AdjustHostContents($contents);
669: }
670:
671: # Install the new file:
672:
673: &logthis("Installing new $tablefile contents:\n$contents");
674: if(!InstallFile($tablefile, $contents)) {
675: &logthis('<font color="red"> Pushfile: unable to install '
676: .$tablefile." $! </font>");
677: return "error:$!";
678: } else {
679: &logthis('<font color="green"> Installed new '.$tablefile
680: ."</font>");
681:
682: }
683:
684:
685: # Indicate success:
686:
687: return "ok";
688:
689: }
690:
691: #
692: # Called to re-init either lonc or lond.
693: #
694: # Parameters:
695: # request - The full request by the client. This is of the form
696: # reinit:<process>
697: # where <process> is allowed to be either of
698: # lonc or lond
699: #
700: # Returns:
701: # The string to be sent back to the client either:
702: # ok - Everything worked just fine.
703: # error:why - There was a failure and why describes the reason.
704: #
705: #
706: sub ReinitProcess {
707: my $request = shift;
708:
709:
710: # separate the request (reinit) from the process identifier and
711: # validate it producing the name of the .pid file for the process.
712: #
713: #
714: my ($junk, $process) = split(":", $request);
715: my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
716: if($process eq 'lonc') {
717: $processpidfile = $processpidfile."lonc.pid";
718: if (!open(PIDFILE, "< $processpidfile")) {
719: return "error:Open failed for $processpidfile";
720: }
721: my $loncpid = <PIDFILE>;
722: close(PIDFILE);
723: logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
724: ."</font>");
725: kill("USR2", $loncpid);
726: } elsif ($process eq 'lond') {
727: logthis('<font color="red"> Reinitializing self (lond) </font>');
728: &UpdateHosts; # Lond is us!!
729: } else {
730: &logthis('<font color="yellow" Invalid reinit request for '.$process
731: ."</font>");
732: return "error:Invalid process identifier $process";
733: }
734: return 'ok';
735: }
736: # Validate a line in a configuration file edit script:
737: # Validation includes:
738: # - Ensuring the command is valid.
739: # - Ensuring the command has sufficient parameters
740: # Parameters:
741: # scriptline - A line to validate (\n has been stripped for what it's worth).
742: #
743: # Return:
744: # 0 - Invalid scriptline.
745: # 1 - Valid scriptline
746: # NOTE:
747: # Only the command syntax is checked, not the executability of the
748: # command.
749: #
750: sub isValidEditCommand {
751: my $scriptline = shift;
752:
753: # Line elements are pipe separated:
754:
755: my ($command, $key, $newline) = split(/\|/, $scriptline);
756: &logthis('<font color="green"> isValideditCommand checking: '.
757: "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
758:
759: if ($command eq "delete") {
760: #
761: # key with no newline.
762: #
763: if( ($key eq "") || ($newline ne "")) {
764: return 0; # Must have key but no newline.
765: } else {
766: return 1; # Valid syntax.
767: }
768: } elsif ($command eq "replace") {
769: #
770: # key and newline:
771: #
772: if (($key eq "") || ($newline eq "")) {
773: return 0;
774: } else {
775: return 1;
776: }
777: } elsif ($command eq "append") {
778: if (($key ne "") && ($newline eq "")) {
779: return 1;
780: } else {
781: return 0;
782: }
783: } else {
784: return 0; # Invalid command.
785: }
786: return 0; # Should not get here!!!
787: }
788: #
789: # ApplyEdit - Applies an edit command to a line in a configuration
790: # file. It is the caller's responsiblity to validate the
791: # edit line.
792: # Parameters:
793: # $directive - A single edit directive to apply.
794: # Edit directives are of the form:
795: # append|newline - Appends a new line to the file.
796: # replace|key|newline - Replaces the line with key value 'key'
797: # delete|key - Deletes the line with key value 'key'.
798: # $editor - A config file editor object that contains the
799: # file being edited.
800: #
801: sub ApplyEdit {
802:
803: my ($directive, $editor) = @_;
804:
805: # Break the directive down into its command and its parameters
806: # (at most two at this point. The meaning of the parameters, if in fact
807: # they exist depends on the command).
808:
809: my ($command, $p1, $p2) = split(/\|/, $directive);
810:
811: if($command eq "append") {
812: $editor->Append($p1); # p1 - key p2 null.
813: } elsif ($command eq "replace") {
814: $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
815: } elsif ($command eq "delete") {
816: $editor->DeleteLine($p1); # p1 - key p2 null.
817: } else { # Should not get here!!!
818: die "Invalid command given to ApplyEdit $command"
819: }
820: }
821: #
822: # AdjustOurHost:
823: # Adjusts a host file stored in a configuration file editor object
824: # for the true IP address of this host. This is necessary for hosts
825: # that live behind a firewall.
826: # Those hosts have a publicly distributed IP of the firewall, but
827: # internally must use their actual IP. We assume that a given
828: # host only has a single IP interface for now.
829: # Formal Parameters:
830: # editor - The configuration file editor to adjust. This
831: # editor is assumed to contain a hosts.tab file.
832: # Strategy:
833: # - Figure out our hostname.
834: # - Lookup the entry for this host.
835: # - Modify the line to contain our IP
836: # - Do a replace for this host.
837: sub AdjustOurHost {
838: my $editor = shift;
839:
840: # figure out who I am.
841:
842: my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
843:
844: # Get my host file entry.
845:
846: my $ConfigLine = $editor->Find($myHostName);
847: if(! (defined $ConfigLine)) {
848: die "AdjustOurHost - no entry for me in hosts file $myHostName";
849: }
850: # figure out my IP:
851: # Use the config line to get my hostname.
852: # Use gethostbyname to translate that into an IP address.
853: #
854: my ($id,$domain,$role,$name,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
855: #
856: # Reassemble the config line from the elements in the list.
857: # Note that if the loncnew items were not present before, they will
858: # be now even if they would be empty
859: #
860: my $newConfigLine = $id;
861: foreach my $item ($domain, $role, $name, $maxcon, $idleto, $mincon) {
862: $newConfigLine .= ":".$item;
863: }
864: # Replace the line:
865:
866: $editor->ReplaceLine($id, $newConfigLine);
867:
868: }
869: #
870: # ReplaceConfigFile:
871: # Replaces a configuration file with the contents of a
872: # configuration file editor object.
873: # This is done by:
874: # - Copying the target file to <filename>.old
875: # - Writing the new file to <filename>.tmp
876: # - Moving <filename.tmp> -> <filename>
877: # This laborious process ensures that the system is never without
878: # a configuration file that's at least valid (even if the contents
879: # may be dated).
880: # Parameters:
881: # filename - Name of the file to modify... this is a full path.
882: # editor - Editor containing the file.
883: #
884: sub ReplaceConfigFile {
885:
886: my ($filename, $editor) = @_;
887:
888: CopyFile ($filename, $filename.".old");
889:
890: my $contents = $editor->Get(); # Get the contents of the file.
891:
892: InstallFile($filename, $contents);
893: }
894: #
895: #
896: # Called to edit a configuration table file
897: # Parameters:
898: # request - The entire command/request sent by lonc or lonManage
899: # Return:
900: # The reply to send to the client.
901: #
902: sub EditFile {
903: my $request = shift;
904:
905: # Split the command into it's pieces: edit:filetype:script
906:
907: my ($cmd, $filetype, $script) = split(/:/, $request,3); # : in script
908:
909: # Check the pre-coditions for success:
910:
911: if($cmd != "edit") { # Something is amiss afoot alack.
912: return "error:edit request detected, but request != 'edit'\n";
913: }
914: if( ($filetype ne "hosts") &&
915: ($filetype ne "domain")) {
916: return "error:edit requested with invalid file specifier: $filetype \n";
917: }
918:
919: # Split the edit script and check it's validity.
920:
921: my @scriptlines = split(/\n/, $script); # one line per element.
922: my $linecount = scalar(@scriptlines);
923: for(my $i = 0; $i < $linecount; $i++) {
924: chomp($scriptlines[$i]);
925: if(!isValidEditCommand($scriptlines[$i])) {
926: return "error:edit with bad script line: '$scriptlines[$i]' \n";
927: }
928: }
929:
930: # Execute the edit operation.
931: # - Create a config file editor for the appropriate file and
932: # - execute each command in the script:
933: #
934: my $configfile = ConfigFileFromSelector($filetype);
935: if (!(defined $configfile)) {
936: return "refused\n";
937: }
938: my $editor = ConfigFileEdit->new($configfile);
939:
940: for (my $i = 0; $i < $linecount; $i++) {
941: ApplyEdit($scriptlines[$i], $editor);
942: }
943: # If the file is the host file, ensure that our host is
944: # adjusted to have our ip:
945: #
946: if($filetype eq "host") {
947: AdjustOurHost($editor);
948: }
949: # Finally replace the current file with our file.
950: #
951: ReplaceConfigFile($configfile, $editor);
952:
953: return "ok\n";
954: }
955:
956: # read_profile
957: #
958: # Returns a set of specific entries from a user's profile file.
959: # this is a utility function that is used by both get_profile_entry and
960: # get_profile_entry_encrypted.
961: #
962: # Parameters:
963: # udom - Domain in which the user exists.
964: # uname - User's account name (loncapa account)
965: # namespace - The profile namespace to open.
966: # what - A set of & separated queries.
967: # Returns:
968: # If all ok: - The string that needs to be shipped back to the user.
969: # If failure - A string that starts with error: followed by the failure
970: # reason.. note that this probabyl gets shipped back to the
971: # user as well.
972: #
973: sub read_profile {
974: my ($udom, $uname, $namespace, $what) = @_;
975:
976: my $hashref = &tie_user_hash($udom, $uname, $namespace,
977: &GDBM_READER());
978: if ($hashref) {
979: my @queries=split(/\&/,$what);
980: if ($namespace eq 'roles') {
981: @queries = map { &unescape($_); } @queries;
982: }
983: my $qresult='';
984:
985: for (my $i=0;$i<=$#queries;$i++) {
986: $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
987: }
988: $qresult=~s/\&$//; # Remove trailing & from last lookup.
989: if (&untie_user_hash($hashref)) {
990: return $qresult;
991: } else {
992: return "error: ".($!+0)." untie (GDBM) Failed";
993: }
994: } else {
995: if ($!+0 == 2) {
996: return "error:No such file or GDBM reported bad block error";
997: } else {
998: return "error: ".($!+0)." tie (GDBM) Failed";
999: }
1000: }
1001:
1002: }
1003: #--------------------- Request Handlers --------------------------------------------
1004: #
1005: # By convention each request handler registers itself prior to the sub
1006: # declaration:
1007: #
1008:
1009: #++
1010: #
1011: # Handles ping requests.
1012: # Parameters:
1013: # $cmd - the actual keyword that invoked us.
1014: # $tail - the tail of the request that invoked us.
1015: # $replyfd- File descriptor connected to the client
1016: # Implicit Inputs:
1017: # $currenthostid - Global variable that carries the name of the host we are
1018: # known as.
1019: # Returns:
1020: # 1 - Ok to continue processing.
1021: # 0 - Program should exit.
1022: # Side effects:
1023: # Reply information is sent to the client.
1024: sub ping_handler {
1025: my ($cmd, $tail, $client) = @_;
1026: Debug("$cmd $tail $client .. $currenthostid:");
1027:
1028: Reply( $client,\$currenthostid,"$cmd:$tail");
1029:
1030: return 1;
1031: }
1032: ®ister_handler("ping", \&ping_handler, 0, 1, 1); # Ping unencoded, client or manager.
1033:
1034: #++
1035: #
1036: # Handles pong requests. Pong replies with our current host id, and
1037: # the results of a ping sent to us via our lonc.
1038: #
1039: # Parameters:
1040: # $cmd - the actual keyword that invoked us.
1041: # $tail - the tail of the request that invoked us.
1042: # $replyfd- File descriptor connected to the client
1043: # Implicit Inputs:
1044: # $currenthostid - Global variable that carries the name of the host we are
1045: # connected to.
1046: # Returns:
1047: # 1 - Ok to continue processing.
1048: # 0 - Program should exit.
1049: # Side effects:
1050: # Reply information is sent to the client.
1051: sub pong_handler {
1052: my ($cmd, $tail, $replyfd) = @_;
1053:
1054: my $reply=&Apache::lonnet::reply("ping",$clientname);
1055: &Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
1056: return 1;
1057: }
1058: ®ister_handler("pong", \&pong_handler, 0, 1, 1); # Pong unencoded, client or manager
1059:
1060: #++
1061: # Called to establish an encrypted session key with the remote client.
1062: # Note that with secure lond, in most cases this function is never
1063: # invoked. Instead, the secure session key is established either
1064: # via a local file that's locked down tight and only lives for a short
1065: # time, or via an ssl tunnel...and is generated from a bunch-o-random
1066: # bits from /dev/urandom, rather than the predictable pattern used by
1067: # by this sub. This sub is only used in the old-style insecure
1068: # key negotiation.
1069: # Parameters:
1070: # $cmd - the actual keyword that invoked us.
1071: # $tail - the tail of the request that invoked us.
1072: # $replyfd- File descriptor connected to the client
1073: # Implicit Inputs:
1074: # $currenthostid - Global variable that carries the name of the host
1075: # known as.
1076: # $clientname - Global variable that carries the name of the host we're connected to.
1077: # Returns:
1078: # 1 - Ok to continue processing.
1079: # 0 - Program should exit.
1080: # Implicit Outputs:
1081: # Reply information is sent to the client.
1082: # $cipher is set with a reference to a new IDEA encryption object.
1083: #
1084: sub establish_key_handler {
1085: my ($cmd, $tail, $replyfd) = @_;
1086:
1087: my $buildkey=time.$$.int(rand 100000);
1088: $buildkey=~tr/1-6/A-F/;
1089: $buildkey=int(rand 100000).$buildkey.int(rand 100000);
1090: my $key=$currenthostid.$clientname;
1091: $key=~tr/a-z/A-Z/;
1092: $key=~tr/G-P/0-9/;
1093: $key=~tr/Q-Z/0-9/;
1094: $key=$key.$buildkey.$key.$buildkey.$key.$buildkey;
1095: $key=substr($key,0,32);
1096: my $cipherkey=pack("H32",$key);
1097: $cipher=new IDEA $cipherkey;
1098: &Reply($replyfd, \$buildkey, "$cmd:$tail");
1099:
1100: return 1;
1101:
1102: }
1103: ®ister_handler("ekey", \&establish_key_handler, 0, 1,1);
1104:
1105: # Handler for the load command. Returns the current system load average
1106: # to the requestor.
1107: #
1108: # Parameters:
1109: # $cmd - the actual keyword that invoked us.
1110: # $tail - the tail of the request that invoked us.
1111: # $replyfd- File descriptor connected to the client
1112: # Implicit Inputs:
1113: # $currenthostid - Global variable that carries the name of the host
1114: # known as.
1115: # $clientname - Global variable that carries the name of the host we're connected to.
1116: # Returns:
1117: # 1 - Ok to continue processing.
1118: # 0 - Program should exit.
1119: # Side effects:
1120: # Reply information is sent to the client.
1121: sub load_handler {
1122: my ($cmd, $tail, $replyfd) = @_;
1123:
1124:
1125:
1126: # Get the load average from /proc/loadavg and calculate it as a percentage of
1127: # the allowed load limit as set by the perl global variable lonLoadLim
1128:
1129: my $loadavg;
1130: my $loadfile=IO::File->new('/proc/loadavg');
1131:
1132: $loadavg=<$loadfile>;
1133: $loadavg =~ s/\s.*//g; # Extract the first field only.
1134:
1135: my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};
1136:
1137: &Reply( $replyfd, \$loadpercent, "$cmd:$tail");
1138:
1139: return 1;
1140: }
1141: ®ister_handler("load", \&load_handler, 0, 1, 0);
1142:
1143: #
1144: # Process the userload request. This sub returns to the client the current
1145: # user load average. It can be invoked either by clients or managers.
1146: #
1147: # Parameters:
1148: # $cmd - the actual keyword that invoked us.
1149: # $tail - the tail of the request that invoked us.
1150: # $replyfd- File descriptor connected to the client
1151: # Implicit Inputs:
1152: # $currenthostid - Global variable that carries the name of the host
1153: # known as.
1154: # $clientname - Global variable that carries the name of the host we're connected to.
1155: # Returns:
1156: # 1 - Ok to continue processing.
1157: # 0 - Program should exit
1158: # Implicit inputs:
1159: # whatever the userload() function requires.
1160: # Implicit outputs:
1161: # the reply is written to the client.
1162: #
1163: sub user_load_handler {
1164: my ($cmd, $tail, $replyfd) = @_;
1165:
1166: my $userloadpercent=&Apache::lonnet::userload();
1167: &Reply($replyfd, \$userloadpercent, "$cmd:$tail");
1168:
1169: return 1;
1170: }
1171: ®ister_handler("userload", \&user_load_handler, 0, 1, 0);
1172:
1173: # Process a request for the authorization type of a user:
1174: # (userauth).
1175: #
1176: # Parameters:
1177: # $cmd - the actual keyword that invoked us.
1178: # $tail - the tail of the request that invoked us.
1179: # $replyfd- File descriptor connected to the client
1180: # Returns:
1181: # 1 - Ok to continue processing.
1182: # 0 - Program should exit
1183: # Implicit outputs:
1184: # The user authorization type is written to the client.
1185: #
1186: sub user_authorization_type {
1187: my ($cmd, $tail, $replyfd) = @_;
1188:
1189: my $userinput = "$cmd:$tail";
1190:
1191: # Pull the domain and username out of the command tail.
1192: # and call get_auth_type to determine the authentication type.
1193:
1194: my ($udom,$uname)=split(/:/,$tail);
1195: my $result = &get_auth_type($udom, $uname);
1196: if($result eq "nouser") {
1197: &Failure( $replyfd, "unknown_user\n", $userinput);
1198: } else {
1199: #
1200: # We only want to pass the second field from get_auth_type
1201: # for ^krb.. otherwise we'll be handing out the encrypted
1202: # password for internals e.g.
1203: #
1204: my ($type,$otherinfo) = split(/:/,$result);
1205: if($type =~ /^krb/) {
1206: $type = $result;
1207: } else {
1208: $type .= ':';
1209: }
1210: &Reply( $replyfd, \$type, $userinput);
1211: }
1212:
1213: return 1;
1214: }
1215: ®ister_handler("currentauth", \&user_authorization_type, 1, 1, 0);
1216:
1217: # Process a request by a manager to push a hosts or domain table
1218: # to us. We pick apart the command and pass it on to the subs
1219: # that already exist to do this.
1220: #
1221: # Parameters:
1222: # $cmd - the actual keyword that invoked us.
1223: # $tail - the tail of the request that invoked us.
1224: # $client - File descriptor connected to the client
1225: # Returns:
1226: # 1 - Ok to continue processing.
1227: # 0 - Program should exit
1228: # Implicit Output:
1229: # a reply is written to the client.
1230: sub push_file_handler {
1231: my ($cmd, $tail, $client) = @_;
1232: &Debug("In push file handler");
1233: my $userinput = "$cmd:$tail";
1234:
1235: # At this time we only know that the IP of our partner is a valid manager
1236: # the code below is a hook to do further authentication (e.g. to resolve
1237: # spoofing).
1238:
1239: my $cert = &GetCertificate($userinput);
1240: if(&ValidManager($cert)) {
1241: &Debug("Valid manager: $client");
1242:
1243: # Now presumably we have the bona fides of both the peer host and the
1244: # process making the request.
1245:
1246: my $reply = &PushFile($userinput);
1247: &Reply($client, \$reply, $userinput);
1248:
1249: } else {
1250: &logthis("push_file_handler $client is not valid");
1251: &Failure( $client, "refused\n", $userinput);
1252: }
1253: return 1;
1254: }
1255: ®ister_handler("pushfile", \&push_file_handler, 1, 0, 1);
1256:
1257: # The du_handler routine should be considered obsolete and is retained
1258: # for communication with legacy servers. Please see the du2_handler.
1259: #
1260: # du - list the disk usage of a directory recursively.
1261: #
1262: # note: stolen code from the ls file handler
1263: # under construction by Rick Banghart
1264: # .
1265: # Parameters:
1266: # $cmd - The command that dispatched us (du).
1267: # $ududir - The directory path to list... I'm not sure what this
1268: # is relative as things like ls:. return e.g.
1269: # no_such_dir.
1270: # $client - Socket open on the client.
1271: # Returns:
1272: # 1 - indicating that the daemon should not disconnect.
1273: # Side Effects:
1274: # The reply is written to $client.
1275: #
1276: sub du_handler {
1277: my ($cmd, $ududir, $client) = @_;
1278: ($ududir) = split(/:/,$ududir); # Make 'telnet' testing easier.
1279: my $userinput = "$cmd:$ududir";
1280:
1281: if ($ududir=~/\.\./ || $ududir!~m|^/home/httpd/|) {
1282: &Failure($client,"refused\n","$cmd:$ududir");
1283: return 1;
1284: }
1285: # Since $ududir could have some nasties in it,
1286: # we will require that ududir is a valid
1287: # directory. Just in case someone tries to
1288: # slip us a line like .;(cd /home/httpd rm -rf*)
1289: # etc.
1290: #
1291: if (-d $ududir) {
1292: my $total_size=0;
1293: my $code=sub {
1294: if ($_=~/\.\d+\./) { return;}
1295: if ($_=~/\.meta$/) { return;}
1296: if (-d $_) { return;}
1297: $total_size+=(stat($_))[7];
1298: };
1299: chdir($ududir);
1300: find($code,$ududir);
1301: $total_size=int($total_size/1024);
1302: &Reply($client,\$total_size,"$cmd:$ududir");
1303: } else {
1304: &Failure($client, "bad_directory:$ududir\n","$cmd:$ududir");
1305: }
1306: return 1;
1307: }
1308: ®ister_handler("du", \&du_handler, 0, 1, 0);
1309:
1310: # Please also see the du_handler, which is obsoleted by du2.
1311: # du2_handler differs from du_handler in that required path to directory
1312: # provided by &propath() is prepended in the handler instead of on the
1313: # client side.
1314: #
1315: # du2 - list the disk usage of a directory recursively.
1316: #
1317: # Parameters:
1318: # $cmd - The command that dispatched us (du).
1319: # $tail - The tail of the request that invoked us.
1320: # $tail is a : separated list of the following:
1321: # - $ududir - directory path to list (before prepending)
1322: # - $getpropath = 1 if &propath() should prepend
1323: # - $uname - username to use for &propath or user dir
1324: # - $udom - domain to use for &propath or user dir
1325: # All are escaped.
1326: # $client - Socket open on the client.
1327: # Returns:
1328: # 1 - indicating that the daemon should not disconnect.
1329: # Side Effects:
1330: # The reply is written to $client.
1331: #
1332:
1333: sub du2_handler {
1334: my ($cmd, $tail, $client) = @_;
1335: my ($ududir,$getpropath,$uname,$udom) = map { &unescape($_) } (split(/:/, $tail));
1336: my $userinput = "$cmd:$tail";
1337: if (($ududir=~/\.\./) || (($ududir!~m|^/home/httpd/|) && (!$getpropath))) {
1338: &Failure($client,"refused\n","$cmd:$tail");
1339: return 1;
1340: }
1341: if ($getpropath) {
1342: if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
1343: $ududir = &propath($udom,$uname).'/'.$ududir;
1344: } else {
1345: &Failure($client,"refused\n","$cmd:$tail");
1346: return 1;
1347: }
1348: }
1349: # Since $ududir could have some nasties in it,
1350: # we will require that ududir is a valid
1351: # directory. Just in case someone tries to
1352: # slip us a line like .;(cd /home/httpd rm -rf*)
1353: # etc.
1354: #
1355: if (-d $ududir) {
1356: my $total_size=0;
1357: my $code=sub {
1358: if ($_=~/\.\d+\./) { return;}
1359: if ($_=~/\.meta$/) { return;}
1360: if (-d $_) { return;}
1361: $total_size+=(stat($_))[7];
1362: };
1363: chdir($ududir);
1364: find($code,$ududir);
1365: $total_size=int($total_size/1024);
1366: &Reply($client,\$total_size,"$cmd:$ududir");
1367: } else {
1368: &Failure($client, "bad_directory:$ududir\n","$cmd:$tail");
1369: }
1370: return 1;
1371: }
1372: ®ister_handler("du2", \&du2_handler, 0, 1, 0);
1373:
1374: #
1375: # The ls_handler routine should be considered obsolete and is retained
1376: # for communication with legacy servers. Please see the ls3_handler.
1377: #
1378: # ls - list the contents of a directory. For each file in the
1379: # selected directory the filename followed by the full output of
1380: # the stat function is returned. The returned info for each
1381: # file are separated by ':'. The stat fields are separated by &'s.
1382: # Parameters:
1383: # $cmd - The command that dispatched us (ls).
1384: # $ulsdir - The directory path to list... I'm not sure what this
1385: # is relative as things like ls:. return e.g.
1386: # no_such_dir.
1387: # $client - Socket open on the client.
1388: # Returns:
1389: # 1 - indicating that the daemon should not disconnect.
1390: # Side Effects:
1391: # The reply is written to $client.
1392: #
1393: sub ls_handler {
1394: # obsoleted by ls2_handler
1395: my ($cmd, $ulsdir, $client) = @_;
1396:
1397: my $userinput = "$cmd:$ulsdir";
1398:
1399: my $obs;
1400: my $rights;
1401: my $ulsout='';
1402: my $ulsfn;
1403: if (-e $ulsdir) {
1404: if(-d $ulsdir) {
1405: if (opendir(LSDIR,$ulsdir)) {
1406: while ($ulsfn=readdir(LSDIR)) {
1407: undef($obs);
1408: undef($rights);
1409: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
1410: #We do some obsolete checking here
1411: if(-e $ulsdir.'/'.$ulsfn.".meta") {
1412: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
1413: my @obsolete=<FILE>;
1414: foreach my $obsolete (@obsolete) {
1415: if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
1416: if($obsolete =~ m|(<copyright>)(default)|) { $rights = 1; }
1417: }
1418: }
1419: $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
1420: if($obs eq '1') { $ulsout.="&1"; }
1421: else { $ulsout.="&0"; }
1422: if($rights eq '1') { $ulsout.="&1:"; }
1423: else { $ulsout.="&0:"; }
1424: }
1425: closedir(LSDIR);
1426: }
1427: } else {
1428: my @ulsstats=stat($ulsdir);
1429: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
1430: }
1431: } else {
1432: $ulsout='no_such_dir';
1433: }
1434: if ($ulsout eq '') { $ulsout='empty'; }
1435: &Reply($client, \$ulsout, $userinput); # This supports debug logging.
1436:
1437: return 1;
1438:
1439: }
1440: ®ister_handler("ls", \&ls_handler, 0, 1, 0);
1441:
1442: # The ls2_handler routine should be considered obsolete and is retained
1443: # for communication with legacy servers. Please see the ls3_handler.
1444: # Please also see the ls_handler, which was itself obsoleted by ls2.
1445: # ls2_handler differs from ls_handler in that it escapes its return
1446: # values before concatenating them together with ':'s.
1447: #
1448: # ls2 - list the contents of a directory. For each file in the
1449: # selected directory the filename followed by the full output of
1450: # the stat function is returned. The returned info for each
1451: # file are separated by ':'. The stat fields are separated by &'s.
1452: # Parameters:
1453: # $cmd - The command that dispatched us (ls).
1454: # $ulsdir - The directory path to list... I'm not sure what this
1455: # is relative as things like ls:. return e.g.
1456: # no_such_dir.
1457: # $client - Socket open on the client.
1458: # Returns:
1459: # 1 - indicating that the daemon should not disconnect.
1460: # Side Effects:
1461: # The reply is written to $client.
1462: #
1463: sub ls2_handler {
1464: my ($cmd, $ulsdir, $client) = @_;
1465:
1466: my $userinput = "$cmd:$ulsdir";
1467:
1468: my $obs;
1469: my $rights;
1470: my $ulsout='';
1471: my $ulsfn;
1472: if (-e $ulsdir) {
1473: if(-d $ulsdir) {
1474: if (opendir(LSDIR,$ulsdir)) {
1475: while ($ulsfn=readdir(LSDIR)) {
1476: undef($obs);
1477: undef($rights);
1478: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
1479: #We do some obsolete checking here
1480: if(-e $ulsdir.'/'.$ulsfn.".meta") {
1481: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
1482: my @obsolete=<FILE>;
1483: foreach my $obsolete (@obsolete) {
1484: if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
1485: if($obsolete =~ m|(<copyright>)(default)|) {
1486: $rights = 1;
1487: }
1488: }
1489: }
1490: my $tmp = $ulsfn.'&'.join('&',@ulsstats);
1491: if ($obs eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
1492: if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
1493: $ulsout.= &escape($tmp).':';
1494: }
1495: closedir(LSDIR);
1496: }
1497: } else {
1498: my @ulsstats=stat($ulsdir);
1499: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
1500: }
1501: } else {
1502: $ulsout='no_such_dir';
1503: }
1504: if ($ulsout eq '') { $ulsout='empty'; }
1505: &Reply($client, \$ulsout, $userinput); # This supports debug logging.
1506: return 1;
1507: }
1508: ®ister_handler("ls2", \&ls2_handler, 0, 1, 0);
1509: #
1510: # ls3 - list the contents of a directory. For each file in the
1511: # selected directory the filename followed by the full output of
1512: # the stat function is returned. The returned info for each
1513: # file are separated by ':'. The stat fields are separated by &'s.
1514: # Parameters:
1515: # $cmd - The command that dispatched us (ls).
1516: # $tail - The tail of the request that invoked us.
1517: # $tail is a : separated list of the following:
1518: # - $ulsdir - directory path to list (before prepending)
1519: # - $getpropath = 1 if &propath() should prepend
1520: # - $getuserdir = 1 if path to user dir in lonUsers should
1521: # prepend
1522: # - $alternate_root - path to prepend
1523: # - $uname - username to use for &propath or user dir
1524: # - $udom - domain to use for &propath or user dir
1525: # All of these except $getpropath and &getuserdir are escaped.
1526: # no_such_dir.
1527: # $client - Socket open on the client.
1528: # Returns:
1529: # 1 - indicating that the daemon should not disconnect.
1530: # Side Effects:
1531: # The reply is written to $client.
1532: #
1533:
1534: sub ls3_handler {
1535: my ($cmd, $tail, $client) = @_;
1536: my $userinput = "$cmd:$tail";
1537: my ($ulsdir,$getpropath,$getuserdir,$alternate_root,$uname,$udom) =
1538: split(/:/,$tail);
1539: if (defined($ulsdir)) {
1540: $ulsdir = &unescape($ulsdir);
1541: }
1542: if (defined($alternate_root)) {
1543: $alternate_root = &unescape($alternate_root);
1544: }
1545: if (defined($uname)) {
1546: $uname = &unescape($uname);
1547: }
1548: if (defined($udom)) {
1549: $udom = &unescape($udom);
1550: }
1551:
1552: my $dir_root = $perlvar{'lonDocRoot'};
1553: if ($getpropath) {
1554: if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
1555: $dir_root = &propath($udom,$uname);
1556: $dir_root =~ s/\/$//;
1557: } else {
1558: &Failure($client,"refused\n","$cmd:$tail");
1559: return 1;
1560: }
1561: } elsif ($getuserdir) {
1562: if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
1563: my $subdir=$uname.'__';
1564: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
1565: $dir_root = $Apache::lonnet::perlvar{'lonUsersDir'}
1566: ."/$udom/$subdir/$uname";
1567: } else {
1568: &Failure($client,"refused\n","$cmd:$tail");
1569: return 1;
1570: }
1571: } elsif ($alternate_root ne '') {
1572: $dir_root = $alternate_root;
1573: }
1574: if (($dir_root ne '') && ($dir_root ne '/')) {
1575: if ($ulsdir =~ /^\//) {
1576: $ulsdir = $dir_root.$ulsdir;
1577: } else {
1578: $ulsdir = $dir_root.'/'.$ulsdir;
1579: }
1580: }
1581: my $obs;
1582: my $rights;
1583: my $ulsout='';
1584: my $ulsfn;
1585: if (-e $ulsdir) {
1586: if(-d $ulsdir) {
1587: if (opendir(LSDIR,$ulsdir)) {
1588: while ($ulsfn=readdir(LSDIR)) {
1589: undef($obs);
1590: undef($rights);
1591: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
1592: #We do some obsolete checking here
1593: if(-e $ulsdir.'/'.$ulsfn.".meta") {
1594: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
1595: my @obsolete=<FILE>;
1596: foreach my $obsolete (@obsolete) {
1597: if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
1598: if($obsolete =~ m|(<copyright>)(default)|) {
1599: $rights = 1;
1600: }
1601: }
1602: }
1603: my $tmp = $ulsfn.'&'.join('&',@ulsstats);
1604: if ($obs eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
1605: if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
1606: $ulsout.= &escape($tmp).':';
1607: }
1608: closedir(LSDIR);
1609: }
1610: } else {
1611: my @ulsstats=stat($ulsdir);
1612: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
1613: }
1614: } else {
1615: $ulsout='no_such_dir';
1616: }
1617: if ($ulsout eq '') { $ulsout='empty'; }
1618: &Reply($client, \$ulsout, $userinput); # This supports debug logging.
1619: return 1;
1620: }
1621: ®ister_handler("ls3", \&ls3_handler, 0, 1, 0);
1622:
1623: sub server_timezone_handler {
1624: my ($cmd,$tail,$client) = @_;
1625: my $userinput = "$cmd:$tail";
1626: my $timezone;
1627: my $clockfile = '/etc/sysconfig/clock'; # Fedora/CentOS/SuSE
1628: my $tzfile = '/etc/timezone'; # Debian/Ubuntu
1629: if (-e $clockfile) {
1630: if (open(my $fh,"<$clockfile")) {
1631: while (<$fh>) {
1632: next if (/^[\#\s]/);
1633: if (/^(?:TIME)?ZONE\s*=\s*['"]?\s*([\w\/]+)/) {
1634: $timezone = $1;
1635: last;
1636: }
1637: }
1638: close($fh);
1639: }
1640: } elsif (-e $tzfile) {
1641: if (open(my $fh,"<$tzfile")) {
1642: $timezone = <$fh>;
1643: close($fh);
1644: chomp($timezone);
1645: if ($timezone =~ m{^Etc/(\w+)$}) {
1646: $timezone = $1;
1647: }
1648: }
1649: }
1650: &Reply($client,\$timezone,$userinput); # This supports debug logging.
1651: return 1;
1652: }
1653: ®ister_handler("servertimezone", \&server_timezone_handler, 0, 1, 0);
1654:
1655: sub server_loncaparev_handler {
1656: my ($cmd,$tail,$client) = @_;
1657: my $userinput = "$cmd:$tail";
1658: &Reply($client,\$perlvar{'lonVersion'},$userinput);
1659: return 1;
1660: }
1661: ®ister_handler("serverloncaparev", \&server_loncaparev_handler, 0, 1, 0);
1662:
1663: sub server_homeID_handler {
1664: my ($cmd,$tail,$client) = @_;
1665: my $userinput = "$cmd:$tail";
1666: &Reply($client,\$perlvar{'lonHostID'},$userinput);
1667: return 1;
1668: }
1669: ®ister_handler("serverhomeID", \&server_homeID_handler, 0, 1, 0);
1670:
1671: # Process a reinit request. Reinit requests that either
1672: # lonc or lond be reinitialized so that an updated
1673: # host.tab or domain.tab can be processed.
1674: #
1675: # Parameters:
1676: # $cmd - the actual keyword that invoked us.
1677: # $tail - the tail of the request that invoked us.
1678: # $client - File descriptor connected to the client
1679: # Returns:
1680: # 1 - Ok to continue processing.
1681: # 0 - Program should exit
1682: # Implicit output:
1683: # a reply is sent to the client.
1684: #
1685: sub reinit_process_handler {
1686: my ($cmd, $tail, $client) = @_;
1687:
1688: my $userinput = "$cmd:$tail";
1689:
1690: my $cert = &GetCertificate($userinput);
1691: if(&ValidManager($cert)) {
1692: chomp($userinput);
1693: my $reply = &ReinitProcess($userinput);
1694: &Reply( $client, \$reply, $userinput);
1695: } else {
1696: &Failure( $client, "refused\n", $userinput);
1697: }
1698: return 1;
1699: }
1700: ®ister_handler("reinit", \&reinit_process_handler, 1, 0, 1);
1701:
1702: # Process the editing script for a table edit operation.
1703: # the editing operation must be encrypted and requested by
1704: # a manager host.
1705: #
1706: # Parameters:
1707: # $cmd - the actual keyword that invoked us.
1708: # $tail - the tail of the request that invoked us.
1709: # $client - File descriptor connected to the client
1710: # Returns:
1711: # 1 - Ok to continue processing.
1712: # 0 - Program should exit
1713: # Implicit output:
1714: # a reply is sent to the client.
1715: #
1716: sub edit_table_handler {
1717: my ($command, $tail, $client) = @_;
1718:
1719: my $userinput = "$command:$tail";
1720:
1721: my $cert = &GetCertificate($userinput);
1722: if(&ValidManager($cert)) {
1723: my($filetype, $script) = split(/:/, $tail);
1724: if (($filetype eq "hosts") ||
1725: ($filetype eq "domain")) {
1726: if($script ne "") {
1727: &Reply($client, # BUGBUG - EditFile
1728: &EditFile($userinput), # could fail.
1729: $userinput);
1730: } else {
1731: &Failure($client,"refused\n",$userinput);
1732: }
1733: } else {
1734: &Failure($client,"refused\n",$userinput);
1735: }
1736: } else {
1737: &Failure($client,"refused\n",$userinput);
1738: }
1739: return 1;
1740: }
1741: ®ister_handler("edit", \&edit_table_handler, 1, 0, 1);
1742:
1743: #
1744: # Authenticate a user against the LonCAPA authentication
1745: # database. Note that there are several authentication
1746: # possibilities:
1747: # - unix - The user can be authenticated against the unix
1748: # password file.
1749: # - internal - The user can be authenticated against a purely
1750: # internal per user password file.
1751: # - kerberos - The user can be authenticated against either a kerb4 or kerb5
1752: # ticket granting authority.
1753: # - user - The person tailoring LonCAPA can supply a user authentication
1754: # mechanism that is per system.
1755: #
1756: # Parameters:
1757: # $cmd - The command that got us here.
1758: # $tail - Tail of the command (remaining parameters).
1759: # $client - File descriptor connected to client.
1760: # Returns
1761: # 0 - Requested to exit, caller should shut down.
1762: # 1 - Continue processing.
1763: # Implicit inputs:
1764: # The authentication systems describe above have their own forms of implicit
1765: # input into the authentication process that are described above.
1766: #
1767: sub authenticate_handler {
1768: my ($cmd, $tail, $client) = @_;
1769:
1770:
1771: # Regenerate the full input line
1772:
1773: my $userinput = $cmd.":".$tail;
1774:
1775: # udom - User's domain.
1776: # uname - Username.
1777: # upass - User's password.
1778: # checkdefauth - Pass to validate_user() to try authentication
1779: # with default auth type(s) if no user account.
1780: # clientcancheckhost - Passed by clients with functionality in lonauth.pm
1781: # to check if session can be hosted.
1782:
1783: my ($udom, $uname, $upass, $checkdefauth, $clientcancheckhost)=split(/:/,$tail);
1784: &Debug(" Authenticate domain = $udom, user = $uname, password = $upass, checkdefauth = $checkdefauth");
1785: chomp($upass);
1786: $upass=&unescape($upass);
1787:
1788: my $pwdcorrect = &validate_user($udom,$uname,$upass,$checkdefauth);
1789: if($pwdcorrect) {
1790: my $canhost = 1;
1791: unless ($clientcancheckhost) {
1792: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1793: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1794: my @intdoms;
1795: my $internet_names = &Apache::lonnet::get_internet_names($clientname);
1796: if (ref($internet_names) eq 'ARRAY') {
1797: @intdoms = @{$internet_names};
1798: }
1799: unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
1800: my ($remote,$hosted);
1801: my $remotesession = &get_usersession_config($udom,'remotesession');
1802: if (ref($remotesession) eq 'HASH') {
1803: $remote = $remotesession->{'remote'}
1804: }
1805: my $hostedsession = &get_usersession_config($clienthomedom,'hostedsession');
1806: if (ref($hostedsession) eq 'HASH') {
1807: $hosted = $hostedsession->{'hosted'};
1808: }
1809: my $loncaparev = $clientversion;
1810: if ($loncaparev eq '') {
1811: $loncaparev = $Apache::lonnet::loncaparevs{$clientname};
1812: }
1813: $canhost = &Apache::lonnet::can_host_session($udom,$clientname,
1814: $loncaparev,
1815: $remote,$hosted);
1816: }
1817: }
1818: if ($canhost) {
1819: &Reply( $client, "authorized\n", $userinput);
1820: } else {
1821: &Reply( $client, "not_allowed_to_host\n", $userinput);
1822: }
1823: #
1824: # Bad credentials: Failed to authorize
1825: #
1826: } else {
1827: &Failure( $client, "non_authorized\n", $userinput);
1828: }
1829:
1830: return 1;
1831: }
1832: ®ister_handler("auth", \&authenticate_handler, 1, 1, 0);
1833:
1834: #
1835: # Change a user's password. Note that this function is complicated by
1836: # the fact that a user may be authenticated in more than one way:
1837: # At present, we are not able to change the password for all types of
1838: # authentication methods. Only for:
1839: # unix - unix password or shadow passoword style authentication.
1840: # local - Locally written authentication mechanism.
1841: # For now, kerb4 and kerb5 password changes are not supported and result
1842: # in an error.
1843: # FUTURE WORK:
1844: # Support kerberos passwd changes?
1845: # Parameters:
1846: # $cmd - The command that got us here.
1847: # $tail - Tail of the command (remaining parameters).
1848: # $client - File descriptor connected to client.
1849: # Returns
1850: # 0 - Requested to exit, caller should shut down.
1851: # 1 - Continue processing.
1852: # Implicit inputs:
1853: # The authentication systems describe above have their own forms of implicit
1854: # input into the authentication process that are described above.
1855: sub change_password_handler {
1856: my ($cmd, $tail, $client) = @_;
1857:
1858: my $userinput = $cmd.":".$tail; # Reconstruct client's string.
1859:
1860: #
1861: # udom - user's domain.
1862: # uname - Username.
1863: # upass - Current password.
1864: # npass - New password.
1865: # context - Context in which this was called
1866: # (preferences or reset_by_email).
1867: # lonhost - HostID of server where request originated
1868:
1869: my ($udom,$uname,$upass,$npass,$context,$lonhost)=split(/:/,$tail);
1870:
1871: $upass=&unescape($upass);
1872: $npass=&unescape($npass);
1873: &Debug("Trying to change password for $uname");
1874:
1875: # First require that the user can be authenticated with their
1876: # old password unless context was 'reset_by_email':
1877:
1878: my ($validated,$failure);
1879: if ($context eq 'reset_by_email') {
1880: if ($lonhost eq '') {
1881: $failure = 'invalid_client';
1882: } else {
1883: $validated = 1;
1884: }
1885: } else {
1886: $validated = &validate_user($udom, $uname, $upass);
1887: }
1888: if($validated) {
1889: my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
1890:
1891: my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
1892: if ($howpwd eq 'internal') {
1893: &Debug("internal auth");
1894: my $salt=time;
1895: $salt=substr($salt,6,2);
1896: my $ncpass=crypt($npass,$salt);
1897: if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
1898: my $msg="Result of password change for $uname: pwchange_success";
1899: if ($lonhost) {
1900: $msg .= " - request originated from: $lonhost";
1901: }
1902: &logthis($msg);
1903: &Reply($client, "ok\n", $userinput);
1904: } else {
1905: &logthis("Unable to open $uname passwd "
1906: ."to change password");
1907: &Failure( $client, "non_authorized\n",$userinput);
1908: }
1909: } elsif ($howpwd eq 'unix' && $context ne 'reset_by_email') {
1910: my $result = &change_unix_password($uname, $npass);
1911: &logthis("Result of password change for $uname: ".
1912: $result);
1913: &Reply($client, \$result, $userinput);
1914: } else {
1915: # this just means that the current password mode is not
1916: # one we know how to change (e.g the kerberos auth modes or
1917: # locally written auth handler).
1918: #
1919: &Failure( $client, "auth_mode_error\n", $userinput);
1920: }
1921:
1922: } else {
1923: if ($failure eq '') {
1924: $failure = 'non_authorized';
1925: }
1926: &Failure( $client, "$failure\n", $userinput);
1927: }
1928:
1929: return 1;
1930: }
1931: ®ister_handler("passwd", \&change_password_handler, 1, 1, 0);
1932:
1933: #
1934: # Create a new user. User in this case means a lon-capa user.
1935: # The user must either already exist in some authentication realm
1936: # like kerberos or the /etc/passwd. If not, a user completely local to
1937: # this loncapa system is created.
1938: #
1939: # Parameters:
1940: # $cmd - The command that got us here.
1941: # $tail - Tail of the command (remaining parameters).
1942: # $client - File descriptor connected to client.
1943: # Returns
1944: # 0 - Requested to exit, caller should shut down.
1945: # 1 - Continue processing.
1946: # Implicit inputs:
1947: # The authentication systems describe above have their own forms of implicit
1948: # input into the authentication process that are described above.
1949: sub add_user_handler {
1950:
1951: my ($cmd, $tail, $client) = @_;
1952:
1953:
1954: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1955: my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
1956:
1957: &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
1958:
1959:
1960: if($udom eq $currentdomainid) { # Reject new users for other domains...
1961:
1962: my $oldumask=umask(0077);
1963: chomp($npass);
1964: $npass=&unescape($npass);
1965: my $passfilename = &password_path($udom, $uname);
1966: &Debug("Password file created will be:".$passfilename);
1967: if (-e $passfilename) {
1968: &Failure( $client, "already_exists\n", $userinput);
1969: } else {
1970: my $fperror='';
1971: if (!&mkpath($passfilename)) {
1972: $fperror="error: ".($!+0)." mkdir failed while attempting "
1973: ."makeuser";
1974: }
1975: unless ($fperror) {
1976: my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
1977: &Reply($client,\$result, $userinput); #BUGBUG - could be fail
1978: } else {
1979: &Failure($client, \$fperror, $userinput);
1980: }
1981: }
1982: umask($oldumask);
1983: } else {
1984: &Failure($client, "not_right_domain\n",
1985: $userinput); # Even if we are multihomed.
1986:
1987: }
1988: return 1;
1989:
1990: }
1991: ®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
1992:
1993: #
1994: # Change the authentication method of a user. Note that this may
1995: # also implicitly change the user's password if, for example, the user is
1996: # joining an existing authentication realm. Known authentication realms at
1997: # this time are:
1998: # internal - Purely internal password file (only loncapa knows this user)
1999: # local - Institutionally written authentication module.
2000: # unix - Unix user (/etc/passwd with or without /etc/shadow).
2001: # kerb4 - kerberos version 4
2002: # kerb5 - kerberos version 5
2003: #
2004: # Parameters:
2005: # $cmd - The command that got us here.
2006: # $tail - Tail of the command (remaining parameters).
2007: # $client - File descriptor connected to client.
2008: # Returns
2009: # 0 - Requested to exit, caller should shut down.
2010: # 1 - Continue processing.
2011: # Implicit inputs:
2012: # The authentication systems describe above have their own forms of implicit
2013: # input into the authentication process that are described above.
2014: # NOTE:
2015: # This is also used to change the authentication credential values (e.g. passwd).
2016: #
2017: #
2018: sub change_authentication_handler {
2019:
2020: my ($cmd, $tail, $client) = @_;
2021:
2022: my $userinput = "$cmd:$tail"; # Reconstruct user input.
2023:
2024: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
2025: &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
2026: if ($udom ne $currentdomainid) {
2027: &Failure( $client, "not_right_domain\n", $client);
2028: } else {
2029:
2030: chomp($npass);
2031:
2032: $npass=&unescape($npass);
2033: my $oldauth = &get_auth_type($udom, $uname); # Get old auth info.
2034: my $passfilename = &password_path($udom, $uname);
2035: if ($passfilename) { # Not allowed to create a new user!!
2036: # If just changing the unix passwd. need to arrange to run
2037: # passwd since otherwise make_passwd_file will run
2038: # lcuseradd which fails if an account already exists
2039: # (to prevent an unscrupulous LONCAPA admin from stealing
2040: # an existing account by overwriting it as a LonCAPA account).
2041:
2042: if(($oldauth =~/^unix/) && ($umode eq "unix")) {
2043: my $result = &change_unix_password($uname, $npass);
2044: &logthis("Result of password change for $uname: ".$result);
2045: if ($result eq "ok") {
2046: &Reply($client, \$result);
2047: } else {
2048: &Failure($client, \$result);
2049: }
2050: } else {
2051: my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
2052: #
2053: # If the current auth mode is internal, and the old auth mode was
2054: # unix, or krb*, and the user is an author for this domain,
2055: # re-run manage_permissions for that role in order to be able
2056: # to take ownership of the construction space back to www:www
2057: #
2058:
2059:
2060: if( (($oldauth =~ /^unix/) && ($umode eq "internal")) ||
2061: (($oldauth =~ /^internal/) && ($umode eq "unix")) ) {
2062: if(&is_author($udom, $uname)) {
2063: &Debug(" Need to manage author permissions...");
2064: &manage_permissions("/$udom/_au", $udom, $uname, "$umode:");
2065: }
2066: }
2067: &Reply($client, \$result, $userinput);
2068: }
2069:
2070:
2071: } else {
2072: &Failure($client, "non_authorized\n", $userinput); # Fail the user now.
2073: }
2074: }
2075: return 1;
2076: }
2077: ®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
2078:
2079: #
2080: # Determines if this is the home server for a user. The home server
2081: # for a user will have his/her lon-capa passwd file. Therefore all we need
2082: # to do is determine if this file exists.
2083: #
2084: # Parameters:
2085: # $cmd - The command that got us here.
2086: # $tail - Tail of the command (remaining parameters).
2087: # $client - File descriptor connected to client.
2088: # Returns
2089: # 0 - Requested to exit, caller should shut down.
2090: # 1 - Continue processing.
2091: # Implicit inputs:
2092: # The authentication systems describe above have their own forms of implicit
2093: # input into the authentication process that are described above.
2094: #
2095: sub is_home_handler {
2096: my ($cmd, $tail, $client) = @_;
2097:
2098: my $userinput = "$cmd:$tail";
2099:
2100: my ($udom,$uname)=split(/:/,$tail);
2101: chomp($uname);
2102: my $passfile = &password_filename($udom, $uname);
2103: if($passfile) {
2104: &Reply( $client, "found\n", $userinput);
2105: } else {
2106: &Failure($client, "not_found\n", $userinput);
2107: }
2108: return 1;
2109: }
2110: ®ister_handler("home", \&is_home_handler, 0,1,0);
2111:
2112: #
2113: # Process an update request for a resource.
2114: # A resource has been modified that we hold a subscription to.
2115: # If the resource is not local, then we must update, or at least invalidate our
2116: # cached copy of the resource.
2117: # Parameters:
2118: # $cmd - The command that got us here.
2119: # $tail - Tail of the command (remaining parameters).
2120: # $client - File descriptor connected to client.
2121: # Returns
2122: # 0 - Requested to exit, caller should shut down.
2123: # 1 - Continue processing.
2124: # Implicit inputs:
2125: # The authentication systems describe above have their own forms of implicit
2126: # input into the authentication process that are described above.
2127: #
2128: sub update_resource_handler {
2129:
2130: my ($cmd, $tail, $client) = @_;
2131:
2132: my $userinput = "$cmd:$tail";
2133:
2134: my $fname= $tail; # This allows interactive testing
2135:
2136:
2137: my $ownership=ishome($fname);
2138: if ($ownership eq 'not_owner') {
2139: if (-e $fname) {
2140: # Delete preview file, if exists
2141: unlink("$fname.tmp");
2142: # Get usage stats
2143: my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
2144: $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
2145: my $now=time;
2146: my $since=$now-$atime;
2147: # If the file has not been used within lonExpire seconds,
2148: # unsubscribe from it and delete local copy
2149: if ($since>$perlvar{'lonExpire'}) {
2150: my $reply=&Apache::lonnet::reply("unsub:$fname","$clientname");
2151: &devalidate_meta_cache($fname);
2152: unlink("$fname");
2153: unlink("$fname.meta");
2154: } else {
2155: # Yes, this is in active use. Get a fresh copy. Since it might be in
2156: # very active use and huge (like a movie), copy it to "in.transfer" filename first.
2157: my $transname="$fname.in.transfer";
2158: my $remoteurl=&Apache::lonnet::reply("sub:$fname","$clientname");
2159: my $response;
2160: # FIXME: cannot replicate files that take more than two minutes to transfer?
2161: # alarm(120);
2162: # FIXME: this should use the LWP mechanism, not internal alarms.
2163: alarm(1200);
2164: {
2165: my $ua=new LWP::UserAgent;
2166: my $request=new HTTP::Request('GET',"$remoteurl");
2167: $response=$ua->request($request,$transname);
2168: }
2169: alarm(0);
2170: if ($response->is_error()) {
2171: # FIXME: we should probably clean up here instead of just whine
2172: unlink($transname);
2173: my $message=$response->status_line;
2174: &logthis("LWP GET: $message for $fname ($remoteurl)");
2175: } else {
2176: if ($remoteurl!~/\.meta$/) {
2177: # FIXME: isn't there an internal LWP mechanism for this?
2178: alarm(120);
2179: {
2180: my $ua=new LWP::UserAgent;
2181: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2182: my $mresponse=$ua->request($mrequest,$fname.'.meta');
2183: if ($mresponse->is_error()) {
2184: unlink($fname.'.meta');
2185: }
2186: }
2187: alarm(0);
2188: }
2189: # we successfully transfered, copy file over to real name
2190: rename($transname,$fname);
2191: &devalidate_meta_cache($fname);
2192: }
2193: }
2194: &Reply( $client, "ok\n", $userinput);
2195: } else {
2196: &Failure($client, "not_found\n", $userinput);
2197: }
2198: } else {
2199: &Failure($client, "rejected\n", $userinput);
2200: }
2201: return 1;
2202: }
2203: ®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
2204:
2205: sub devalidate_meta_cache {
2206: my ($url) = @_;
2207: use Cache::Memcached;
2208: my $memcache = new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
2209: $url = &Apache::lonnet::declutter($url);
2210: $url =~ s-\.meta$--;
2211: my $id = &escape('meta:'.$url);
2212: $memcache->delete($id);
2213: }
2214:
2215: #
2216: # Fetch a user file from a remote server to the user's home directory
2217: # userfiles subdir.
2218: # Parameters:
2219: # $cmd - The command that got us here.
2220: # $tail - Tail of the command (remaining parameters).
2221: # $client - File descriptor connected to client.
2222: # Returns
2223: # 0 - Requested to exit, caller should shut down.
2224: # 1 - Continue processing.
2225: #
2226: sub fetch_user_file_handler {
2227:
2228: my ($cmd, $tail, $client) = @_;
2229:
2230: my $userinput = "$cmd:$tail";
2231: my $fname = $tail;
2232: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
2233: my $udir=&propath($udom,$uname).'/userfiles';
2234: unless (-e $udir) {
2235: mkdir($udir,0770);
2236: }
2237: Debug("fetch user file for $fname");
2238: if (-e $udir) {
2239: $ufile=~s/^[\.\~]+//;
2240:
2241: # IF necessary, create the path right down to the file.
2242: # Note that any regular files in the way of this path are
2243: # wiped out to deal with some earlier folly of mine.
2244:
2245: if (!&mkpath($udir.'/'.$ufile)) {
2246: &Failure($client, "unable_to_create\n", $userinput);
2247: }
2248:
2249: my $destname=$udir.'/'.$ufile;
2250: my $transname=$udir.'/'.$ufile.'.in.transit';
2251: my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
2252: my $response;
2253: Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
2254: alarm(120);
2255: {
2256: my $ua=new LWP::UserAgent;
2257: my $request=new HTTP::Request('GET',"$remoteurl");
2258: $response=$ua->request($request,$transname);
2259: }
2260: alarm(0);
2261: if ($response->is_error()) {
2262: unlink($transname);
2263: my $message=$response->status_line;
2264: &logthis("LWP GET: $message for $fname ($remoteurl)");
2265: &Failure($client, "failed\n", $userinput);
2266: } else {
2267: Debug("Renaming $transname to $destname");
2268: if (!rename($transname,$destname)) {
2269: &logthis("Unable to move $transname to $destname");
2270: unlink($transname);
2271: &Failure($client, "failed\n", $userinput);
2272: } else {
2273: &Reply($client, "ok\n", $userinput);
2274: }
2275: }
2276: } else {
2277: &Failure($client, "not_home\n", $userinput);
2278: }
2279: return 1;
2280: }
2281: ®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
2282:
2283: #
2284: # Remove a file from a user's home directory userfiles subdirectory.
2285: # Parameters:
2286: # cmd - the Lond request keyword that got us here.
2287: # tail - the part of the command past the keyword.
2288: # client- File descriptor connected with the client.
2289: #
2290: # Returns:
2291: # 1 - Continue processing.
2292: sub remove_user_file_handler {
2293: my ($cmd, $tail, $client) = @_;
2294:
2295: my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
2296:
2297: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
2298: if ($ufile =~m|/\.\./|) {
2299: # any files paths with /../ in them refuse
2300: # to deal with
2301: &Failure($client, "refused\n", "$cmd:$tail");
2302: } else {
2303: my $udir = &propath($udom,$uname);
2304: if (-e $udir) {
2305: my $file=$udir.'/userfiles/'.$ufile;
2306: if (-e $file) {
2307: #
2308: # If the file is a regular file unlink is fine...
2309: # However it's possible the client wants a dir.
2310: # removed, in which case rmdir is more approprate:
2311: #
2312: if (-f $file){
2313: unlink($file);
2314: } elsif(-d $file) {
2315: rmdir($file);
2316: }
2317: if (-e $file) {
2318: # File is still there after we deleted it ?!?
2319:
2320: &Failure($client, "failed\n", "$cmd:$tail");
2321: } else {
2322: &Reply($client, "ok\n", "$cmd:$tail");
2323: }
2324: } else {
2325: &Failure($client, "not_found\n", "$cmd:$tail");
2326: }
2327: } else {
2328: &Failure($client, "not_home\n", "$cmd:$tail");
2329: }
2330: }
2331: return 1;
2332: }
2333: ®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
2334:
2335: #
2336: # make a directory in a user's home directory userfiles subdirectory.
2337: # Parameters:
2338: # cmd - the Lond request keyword that got us here.
2339: # tail - the part of the command past the keyword.
2340: # client- File descriptor connected with the client.
2341: #
2342: # Returns:
2343: # 1 - Continue processing.
2344: sub mkdir_user_file_handler {
2345: my ($cmd, $tail, $client) = @_;
2346:
2347: my ($dir) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
2348: $dir=&unescape($dir);
2349: my ($udom,$uname,$ufile) = ($dir =~ m|^([^/]+)/([^/]+)/(.+)$|);
2350: if ($ufile =~m|/\.\./|) {
2351: # any files paths with /../ in them refuse
2352: # to deal with
2353: &Failure($client, "refused\n", "$cmd:$tail");
2354: } else {
2355: my $udir = &propath($udom,$uname);
2356: if (-e $udir) {
2357: my $newdir=$udir.'/userfiles/'.$ufile.'/';
2358: if (!&mkpath($newdir)) {
2359: &Failure($client, "failed\n", "$cmd:$tail");
2360: }
2361: &Reply($client, "ok\n", "$cmd:$tail");
2362: } else {
2363: &Failure($client, "not_home\n", "$cmd:$tail");
2364: }
2365: }
2366: return 1;
2367: }
2368: ®ister_handler("mkdiruserfile", \&mkdir_user_file_handler, 0,1,0);
2369:
2370: #
2371: # rename a file in a user's home directory userfiles subdirectory.
2372: # Parameters:
2373: # cmd - the Lond request keyword that got us here.
2374: # tail - the part of the command past the keyword.
2375: # client- File descriptor connected with the client.
2376: #
2377: # Returns:
2378: # 1 - Continue processing.
2379: sub rename_user_file_handler {
2380: my ($cmd, $tail, $client) = @_;
2381:
2382: my ($udom,$uname,$old,$new) = split(/:/, $tail);
2383: $old=&unescape($old);
2384: $new=&unescape($new);
2385: if ($new =~m|/\.\./| || $old =~m|/\.\./|) {
2386: # any files paths with /../ in them refuse to deal with
2387: &Failure($client, "refused\n", "$cmd:$tail");
2388: } else {
2389: my $udir = &propath($udom,$uname);
2390: if (-e $udir) {
2391: my $oldfile=$udir.'/userfiles/'.$old;
2392: my $newfile=$udir.'/userfiles/'.$new;
2393: if (-e $newfile) {
2394: &Failure($client, "exists\n", "$cmd:$tail");
2395: } elsif (! -e $oldfile) {
2396: &Failure($client, "not_found\n", "$cmd:$tail");
2397: } else {
2398: if (!rename($oldfile,$newfile)) {
2399: &Failure($client, "failed\n", "$cmd:$tail");
2400: } else {
2401: &Reply($client, "ok\n", "$cmd:$tail");
2402: }
2403: }
2404: } else {
2405: &Failure($client, "not_home\n", "$cmd:$tail");
2406: }
2407: }
2408: return 1;
2409: }
2410: ®ister_handler("renameuserfile", \&rename_user_file_handler, 0,1,0);
2411:
2412: #
2413: # Checks if the specified user has an active session on the server
2414: # return ok if so, not_found if not
2415: #
2416: # Parameters:
2417: # cmd - The request keyword that dispatched to tus.
2418: # tail - The tail of the request (colon separated parameters).
2419: # client - Filehandle open on the client.
2420: # Return:
2421: # 1.
2422: sub user_has_session_handler {
2423: my ($cmd, $tail, $client) = @_;
2424:
2425: my ($udom, $uname) = map { &unescape($_) } (split(/:/, $tail));
2426:
2427: &logthis("Looking for $udom $uname");
2428: opendir(DIR,$perlvar{'lonIDsDir'});
2429: my $filename;
2430: while ($filename=readdir(DIR)) {
2431: last if ($filename=~/^\Q$uname\E_\d+_\Q$udom\E_/);
2432: }
2433: if ($filename) {
2434: &Reply($client, "ok\n", "$cmd:$tail");
2435: } else {
2436: &Failure($client, "not_found\n", "$cmd:$tail");
2437: }
2438: return 1;
2439:
2440: }
2441: ®ister_handler("userhassession", \&user_has_session_handler, 0,1,0);
2442:
2443: #
2444: # Authenticate access to a user file by checking that the token the user's
2445: # passed also exists in their session file
2446: #
2447: # Parameters:
2448: # cmd - The request keyword that dispatched to tus.
2449: # tail - The tail of the request (colon separated parameters).
2450: # client - Filehandle open on the client.
2451: # Return:
2452: # 1.
2453: sub token_auth_user_file_handler {
2454: my ($cmd, $tail, $client) = @_;
2455:
2456: my ($fname, $session) = split(/:/, $tail);
2457:
2458: chomp($session);
2459: my $reply="non_auth";
2460: my $file = $perlvar{'lonIDsDir'}.'/'.$session.'.id';
2461: if (open(ENVIN,"$file")) {
2462: flock(ENVIN,LOCK_SH);
2463: tie(my %disk_env,'GDBM_File',"$file",&GDBM_READER(),0640);
2464: if (exists($disk_env{"userfile.$fname"})) {
2465: $reply="ok";
2466: } else {
2467: foreach my $envname (keys(%disk_env)) {
2468: if ($envname=~ m|^userfile\.\Q$fname\E|) {
2469: $reply="ok";
2470: last;
2471: }
2472: }
2473: }
2474: untie(%disk_env);
2475: close(ENVIN);
2476: &Reply($client, \$reply, "$cmd:$tail");
2477: } else {
2478: &Failure($client, "invalid_token\n", "$cmd:$tail");
2479: }
2480: return 1;
2481:
2482: }
2483: ®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
2484:
2485: #
2486: # Unsubscribe from a resource.
2487: #
2488: # Parameters:
2489: # $cmd - The command that got us here.
2490: # $tail - Tail of the command (remaining parameters).
2491: # $client - File descriptor connected to client.
2492: # Returns
2493: # 0 - Requested to exit, caller should shut down.
2494: # 1 - Continue processing.
2495: #
2496: sub unsubscribe_handler {
2497: my ($cmd, $tail, $client) = @_;
2498:
2499: my $userinput= "$cmd:$tail";
2500:
2501: my ($fname) = split(/:/,$tail); # Split in case there's extrs.
2502:
2503: &Debug("Unsubscribing $fname");
2504: if (-e $fname) {
2505: &Debug("Exists");
2506: &Reply($client, &unsub($fname,$clientip), $userinput);
2507: } else {
2508: &Failure($client, "not_found\n", $userinput);
2509: }
2510: return 1;
2511: }
2512: ®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
2513:
2514: # Subscribe to a resource
2515: #
2516: # Parameters:
2517: # $cmd - The command that got us here.
2518: # $tail - Tail of the command (remaining parameters).
2519: # $client - File descriptor connected to client.
2520: # Returns
2521: # 0 - Requested to exit, caller should shut down.
2522: # 1 - Continue processing.
2523: #
2524: sub subscribe_handler {
2525: my ($cmd, $tail, $client)= @_;
2526:
2527: my $userinput = "$cmd:$tail";
2528:
2529: &Reply( $client, &subscribe($userinput,$clientip), $userinput);
2530:
2531: return 1;
2532: }
2533: ®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
2534:
2535: #
2536: # Determine the latest version of a resource (it looks for the highest
2537: # past version and then returns that +1)
2538: #
2539: # Parameters:
2540: # $cmd - The command that got us here.
2541: # $tail - Tail of the command (remaining parameters).
2542: # (Should consist of an absolute path to a file)
2543: # $client - File descriptor connected to client.
2544: # Returns
2545: # 0 - Requested to exit, caller should shut down.
2546: # 1 - Continue processing.
2547: #
2548: sub current_version_handler {
2549: my ($cmd, $tail, $client) = @_;
2550:
2551: my $userinput= "$cmd:$tail";
2552:
2553: my $fname = $tail;
2554: &Reply( $client, ¤tversion($fname)."\n", $userinput);
2555: return 1;
2556:
2557: }
2558: ®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
2559:
2560: # Make an entry in a user's activity log.
2561: #
2562: # Parameters:
2563: # $cmd - The command that got us here.
2564: # $tail - Tail of the command (remaining parameters).
2565: # $client - File descriptor connected to client.
2566: # Returns
2567: # 0 - Requested to exit, caller should shut down.
2568: # 1 - Continue processing.
2569: #
2570: sub activity_log_handler {
2571: my ($cmd, $tail, $client) = @_;
2572:
2573:
2574: my $userinput= "$cmd:$tail";
2575:
2576: my ($udom,$uname,$what)=split(/:/,$tail);
2577: chomp($what);
2578: my $proname=&propath($udom,$uname);
2579: my $now=time;
2580: my $hfh;
2581: if ($hfh=IO::File->new(">>$proname/activity.log")) {
2582: print $hfh "$now:$clientname:$what\n";
2583: &Reply( $client, "ok\n", $userinput);
2584: } else {
2585: &Failure($client, "error: ".($!+0)." IO::File->new Failed "
2586: ."while attempting log\n",
2587: $userinput);
2588: }
2589:
2590: return 1;
2591: }
2592: ®ister_handler("log", \&activity_log_handler, 0, 1, 0);
2593:
2594: #
2595: # Put a namespace entry in a user profile hash.
2596: # My druthers would be for this to be an encrypted interaction too.
2597: # anything that might be an inadvertent covert channel about either
2598: # user authentication or user personal information....
2599: #
2600: # Parameters:
2601: # $cmd - The command that got us here.
2602: # $tail - Tail of the command (remaining parameters).
2603: # $client - File descriptor connected to client.
2604: # Returns
2605: # 0 - Requested to exit, caller should shut down.
2606: # 1 - Continue processing.
2607: #
2608: sub put_user_profile_entry {
2609: my ($cmd, $tail, $client) = @_;
2610:
2611: my $userinput = "$cmd:$tail";
2612:
2613: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
2614: if ($namespace ne 'roles') {
2615: chomp($what);
2616: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2617: &GDBM_WRCREAT(),"P",$what);
2618: if($hashref) {
2619: my @pairs=split(/\&/,$what);
2620: foreach my $pair (@pairs) {
2621: my ($key,$value)=split(/=/,$pair);
2622: $hashref->{$key}=$value;
2623: }
2624: if (&untie_user_hash($hashref)) {
2625: &Reply( $client, "ok\n", $userinput);
2626: } else {
2627: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2628: "while attempting put\n",
2629: $userinput);
2630: }
2631: } else {
2632: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2633: "while attempting put\n", $userinput);
2634: }
2635: } else {
2636: &Failure( $client, "refused\n", $userinput);
2637: }
2638:
2639: return 1;
2640: }
2641: ®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
2642:
2643: # Put a piece of new data in hash, returns error if entry already exists
2644: # Parameters:
2645: # $cmd - The command that got us here.
2646: # $tail - Tail of the command (remaining parameters).
2647: # $client - File descriptor connected to client.
2648: # Returns
2649: # 0 - Requested to exit, caller should shut down.
2650: # 1 - Continue processing.
2651: #
2652: sub newput_user_profile_entry {
2653: my ($cmd, $tail, $client) = @_;
2654:
2655: my $userinput = "$cmd:$tail";
2656:
2657: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
2658: if ($namespace eq 'roles') {
2659: &Failure( $client, "refused\n", $userinput);
2660: return 1;
2661: }
2662:
2663: chomp($what);
2664:
2665: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2666: &GDBM_WRCREAT(),"N",$what);
2667: if(!$hashref) {
2668: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2669: "while attempting put\n", $userinput);
2670: return 1;
2671: }
2672:
2673: my @pairs=split(/\&/,$what);
2674: foreach my $pair (@pairs) {
2675: my ($key,$value)=split(/=/,$pair);
2676: if (exists($hashref->{$key})) {
2677: &Failure($client, "key_exists: ".$key."\n",$userinput);
2678: return 1;
2679: }
2680: }
2681:
2682: foreach my $pair (@pairs) {
2683: my ($key,$value)=split(/=/,$pair);
2684: $hashref->{$key}=$value;
2685: }
2686:
2687: if (&untie_user_hash($hashref)) {
2688: &Reply( $client, "ok\n", $userinput);
2689: } else {
2690: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2691: "while attempting put\n",
2692: $userinput);
2693: }
2694: return 1;
2695: }
2696: ®ister_handler("newput", \&newput_user_profile_entry, 0, 1, 0);
2697:
2698: #
2699: # Increment a profile entry in the user history file.
2700: # The history contains keyword value pairs. In this case,
2701: # The value itself is a pair of numbers. The first, the current value
2702: # the second an increment that this function applies to the current
2703: # value.
2704: #
2705: # Parameters:
2706: # $cmd - The command that got us here.
2707: # $tail - Tail of the command (remaining parameters).
2708: # $client - File descriptor connected to client.
2709: # Returns
2710: # 0 - Requested to exit, caller should shut down.
2711: # 1 - Continue processing.
2712: #
2713: sub increment_user_value_handler {
2714: my ($cmd, $tail, $client) = @_;
2715:
2716: my $userinput = "$cmd:$tail";
2717:
2718: my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
2719: if ($namespace ne 'roles') {
2720: chomp($what);
2721: my $hashref = &tie_user_hash($udom, $uname,
2722: $namespace, &GDBM_WRCREAT(),
2723: "P",$what);
2724: if ($hashref) {
2725: my @pairs=split(/\&/,$what);
2726: foreach my $pair (@pairs) {
2727: my ($key,$value)=split(/=/,$pair);
2728: $value = &unescape($value);
2729: # We could check that we have a number...
2730: if (! defined($value) || $value eq '') {
2731: $value = 1;
2732: }
2733: $hashref->{$key}+=$value;
2734: if ($namespace eq 'nohist_resourcetracker') {
2735: if ($hashref->{$key} < 0) {
2736: $hashref->{$key} = 0;
2737: }
2738: }
2739: }
2740: if (&untie_user_hash($hashref)) {
2741: &Reply( $client, "ok\n", $userinput);
2742: } else {
2743: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2744: "while attempting inc\n", $userinput);
2745: }
2746: } else {
2747: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2748: "while attempting inc\n", $userinput);
2749: }
2750: } else {
2751: &Failure($client, "refused\n", $userinput);
2752: }
2753:
2754: return 1;
2755: }
2756: ®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
2757:
2758: #
2759: # Put a new role for a user. Roles are LonCAPA's packaging of permissions.
2760: # Each 'role' a user has implies a set of permissions. Adding a new role
2761: # for a person grants the permissions packaged with that role
2762: # to that user when the role is selected.
2763: #
2764: # Parameters:
2765: # $cmd - The command string (rolesput).
2766: # $tail - The remainder of the request line. For rolesput this
2767: # consists of a colon separated list that contains:
2768: # The domain and user that is granting the role (logged).
2769: # The domain and user that is getting the role.
2770: # The roles being granted as a set of & separated pairs.
2771: # each pair a key value pair.
2772: # $client - File descriptor connected to the client.
2773: # Returns:
2774: # 0 - If the daemon should exit
2775: # 1 - To continue processing.
2776: #
2777: #
2778: sub roles_put_handler {
2779: my ($cmd, $tail, $client) = @_;
2780:
2781: my $userinput = "$cmd:$tail";
2782:
2783: my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
2784:
2785:
2786: my $namespace='roles';
2787: chomp($what);
2788: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2789: &GDBM_WRCREAT(), "P",
2790: "$exedom:$exeuser:$what");
2791: #
2792: # Log the attempt to set a role. The {}'s here ensure that the file
2793: # handle is open for the minimal amount of time. Since the flush
2794: # is done on close this improves the chances the log will be an un-
2795: # corrupted ordered thing.
2796: if ($hashref) {
2797: my $pass_entry = &get_auth_type($udom, $uname);
2798: my ($auth_type,$pwd) = split(/:/, $pass_entry);
2799: $auth_type = $auth_type.":";
2800: my @pairs=split(/\&/,$what);
2801: foreach my $pair (@pairs) {
2802: my ($key,$value)=split(/=/,$pair);
2803: &manage_permissions($key, $udom, $uname,
2804: $auth_type);
2805: $hashref->{$key}=$value;
2806: }
2807: if (&untie_user_hash($hashref)) {
2808: &Reply($client, "ok\n", $userinput);
2809: } else {
2810: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2811: "while attempting rolesput\n", $userinput);
2812: }
2813: } else {
2814: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2815: "while attempting rolesput\n", $userinput);
2816: }
2817: return 1;
2818: }
2819: ®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
2820:
2821: #
2822: # Deletes (removes) a role for a user. This is equivalent to removing
2823: # a permissions package associated with the role from the user's profile.
2824: #
2825: # Parameters:
2826: # $cmd - The command (rolesdel)
2827: # $tail - The remainder of the request line. This consists
2828: # of:
2829: # The domain and user requesting the change (logged)
2830: # The domain and user being changed.
2831: # The roles being revoked. These are shipped to us
2832: # as a bunch of & separated role name keywords.
2833: # $client - The file handle open on the client.
2834: # Returns:
2835: # 1 - Continue processing
2836: # 0 - Exit.
2837: #
2838: sub roles_delete_handler {
2839: my ($cmd, $tail, $client) = @_;
2840:
2841: my $userinput = "$cmd:$tail";
2842:
2843: my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
2844: &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
2845: "what = ".$what);
2846: my $namespace='roles';
2847: chomp($what);
2848: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2849: &GDBM_WRCREAT(), "D",
2850: "$exedom:$exeuser:$what");
2851:
2852: if ($hashref) {
2853: my @rolekeys=split(/\&/,$what);
2854:
2855: foreach my $key (@rolekeys) {
2856: delete $hashref->{$key};
2857: }
2858: if (&untie_user_hash($hashref)) {
2859: &Reply($client, "ok\n", $userinput);
2860: } else {
2861: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2862: "while attempting rolesdel\n", $userinput);
2863: }
2864: } else {
2865: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2866: "while attempting rolesdel\n", $userinput);
2867: }
2868:
2869: return 1;
2870: }
2871: ®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
2872:
2873: # Unencrypted get from a user's profile database. See
2874: # GetProfileEntryEncrypted for a version that does end-to-end encryption.
2875: # This function retrieves a keyed item from a specific named database in the
2876: # user's directory.
2877: #
2878: # Parameters:
2879: # $cmd - Command request keyword (get).
2880: # $tail - Tail of the command. This is a colon separated list
2881: # consisting of the domain and username that uniquely
2882: # identifies the profile,
2883: # The 'namespace' which selects the gdbm file to
2884: # do the lookup in,
2885: # & separated list of keys to lookup. Note that
2886: # the values are returned as an & separated list too.
2887: # $client - File descriptor open on the client.
2888: # Returns:
2889: # 1 - Continue processing.
2890: # 0 - Exit.
2891: #
2892: sub get_profile_entry {
2893: my ($cmd, $tail, $client) = @_;
2894:
2895: my $userinput= "$cmd:$tail";
2896:
2897: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2898: chomp($what);
2899:
2900:
2901: my $replystring = read_profile($udom, $uname, $namespace, $what);
2902: my ($first) = split(/:/,$replystring);
2903: if($first ne "error") {
2904: &Reply($client, \$replystring, $userinput);
2905: } else {
2906: &Failure($client, $replystring." while attempting get\n", $userinput);
2907: }
2908: return 1;
2909:
2910:
2911: }
2912: ®ister_handler("get", \&get_profile_entry, 0,1,0);
2913:
2914: #
2915: # Process the encrypted get request. Note that the request is sent
2916: # in clear, but the reply is encrypted. This is a small covert channel:
2917: # information about the sensitive keys is given to the snooper. Just not
2918: # information about the values of the sensitive key. Hmm if I wanted to
2919: # know these I'd snoop for the egets. Get the profile item names from them
2920: # and then issue a get for them since there's no enforcement of the
2921: # requirement of an encrypted get for particular profile items. If I
2922: # were re-doing this, I'd force the request to be encrypted as well as the
2923: # reply. I'd also just enforce encrypted transactions for all gets since
2924: # that would prevent any covert channel snooping.
2925: #
2926: # Parameters:
2927: # $cmd - Command keyword of request (eget).
2928: # $tail - Tail of the command. See GetProfileEntry
# for more information about this.
2929: # $client - File open on the client.
2930: # Returns:
2931: # 1 - Continue processing
2932: # 0 - server should exit.
2933: sub get_profile_entry_encrypted {
2934: my ($cmd, $tail, $client) = @_;
2935:
2936: my $userinput = "$cmd:$tail";
2937:
2938: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2939: chomp($what);
2940: my $qresult = read_profile($udom, $uname, $namespace, $what);
2941: my ($first) = split(/:/, $qresult);
2942: if($first ne "error") {
2943:
2944: if ($cipher) {
2945: my $cmdlength=length($qresult);
2946: $qresult.=" ";
2947: my $encqresult='';
2948: for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
2949: $encqresult.= unpack("H16",
2950: $cipher->encrypt(substr($qresult,
2951: $encidx,
2952: 8)));
2953: }
2954: &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
2955: } else {
2956: &Failure( $client, "error:no_key\n", $userinput);
2957: }
2958: } else {
2959: &Failure($client, "$qresult while attempting eget\n", $userinput);
2960:
2961: }
2962:
2963: return 1;
2964: }
2965: ®ister_handler("eget", \&get_profile_entry_encrypted, 0, 1, 0);
2966:
2967: #
2968: # Deletes a key in a user profile database.
2969: #
2970: # Parameters:
2971: # $cmd - Command keyword (del).
2972: # $tail - Command tail. IN this case a colon
2973: # separated list containing:
2974: # The domain and user that identifies uniquely
2975: # the identity of the user.
2976: # The profile namespace (name of the profile
2977: # database file).
2978: # & separated list of keywords to delete.
2979: # $client - File open on client socket.
2980: # Returns:
2981: # 1 - Continue processing
2982: # 0 - Exit server.
2983: #
2984: #
2985: sub delete_profile_entry {
2986: my ($cmd, $tail, $client) = @_;
2987:
2988: my $userinput = "cmd:$tail";
2989:
2990: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2991: chomp($what);
2992: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2993: &GDBM_WRCREAT(),
2994: "D",$what);
2995: if ($hashref) {
2996: my @keys=split(/\&/,$what);
2997: foreach my $key (@keys) {
2998: delete($hashref->{$key});
2999: }
3000: if (&untie_user_hash($hashref)) {
3001: &Reply($client, "ok\n", $userinput);
3002: } else {
3003: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3004: "while attempting del\n", $userinput);
3005: }
3006: } else {
3007: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3008: "while attempting del\n", $userinput);
3009: }
3010: return 1;
3011: }
3012: ®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
3013:
3014: #
3015: # List the set of keys that are defined in a profile database file.
3016: # A successful reply from this will contain an & separated list of
3017: # the keys.
3018: # Parameters:
3019: # $cmd - Command request (keys).
3020: # $tail - Remainder of the request, a colon separated
3021: # list containing domain/user that identifies the
3022: # user being queried, and the database namespace
3023: # (database filename essentially).
3024: # $client - File open on the client.
3025: # Returns:
3026: # 1 - Continue processing.
3027: # 0 - Exit the server.
3028: #
3029: sub get_profile_keys {
3030: my ($cmd, $tail, $client) = @_;
3031:
3032: my $userinput = "$cmd:$tail";
3033:
3034: my ($udom,$uname,$namespace)=split(/:/,$tail);
3035: my $qresult='';
3036: my $hashref = &tie_user_hash($udom, $uname, $namespace,
3037: &GDBM_READER());
3038: if ($hashref) {
3039: foreach my $key (keys %$hashref) {
3040: $qresult.="$key&";
3041: }
3042: if (&untie_user_hash($hashref)) {
3043: $qresult=~s/\&$//;
3044: &Reply($client, \$qresult, $userinput);
3045: } else {
3046: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3047: "while attempting keys\n", $userinput);
3048: }
3049: } else {
3050: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3051: "while attempting keys\n", $userinput);
3052: }
3053:
3054: return 1;
3055: }
3056: ®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
3057:
3058: #
3059: # Dump the contents of a user profile database.
3060: # Note that this constitutes a very large covert channel too since
3061: # the dump will return sensitive information that is not encrypted.
3062: # The naive security assumption is that the session negotiation ensures
3063: # our client is trusted and I don't believe that's assured at present.
3064: # Sure want badly to go to ssl or tls. Of course if my peer isn't really
3065: # a LonCAPA node they could have negotiated an encryption key too so >sigh<.
3066: #
3067: # Parameters:
3068: # $cmd - The command request keyword (currentdump).
3069: # $tail - Remainder of the request, consisting of a colon
3070: # separated list that has the domain/username and
3071: # the namespace to dump (database file).
3072: # $client - file open on the remote client.
3073: # Returns:
3074: # 1 - Continue processing.
3075: # 0 - Exit the server.
3076: #
3077: sub dump_profile_database {
3078: my ($cmd, $tail, $client) = @_;
3079:
3080: my $userinput = "$cmd:$tail";
3081:
3082: my ($udom,$uname,$namespace) = split(/:/,$tail);
3083: my $hashref = &tie_user_hash($udom, $uname, $namespace,
3084: &GDBM_READER());
3085: if ($hashref) {
3086: # Structure of %data:
3087: # $data{$symb}->{$parameter}=$value;
3088: # $data{$symb}->{'v.'.$parameter}=$version;
3089: # since $parameter will be unescaped, we do not
3090: # have to worry about silly parameter names...
3091:
3092: my $qresult='';
3093: my %data = (); # A hash of anonymous hashes..
3094: while (my ($key,$value) = each(%$hashref)) {
3095: my ($v,$symb,$param) = split(/:/,$key);
3096: next if ($v eq 'version' || $symb eq 'keys');
3097: next if (exists($data{$symb}) &&
3098: exists($data{$symb}->{$param}) &&
3099: $data{$symb}->{'v.'.$param} > $v);
3100: $data{$symb}->{$param}=$value;
3101: $data{$symb}->{'v.'.$param}=$v;
3102: }
3103: if (&untie_user_hash($hashref)) {
3104: while (my ($symb,$param_hash) = each(%data)) {
3105: while(my ($param,$value) = each (%$param_hash)){
3106: next if ($param =~ /^v\./); # Ignore versions...
3107: #
3108: # Just dump the symb=value pairs separated by &
3109: #
3110: $qresult.=$symb.':'.$param.'='.$value.'&';
3111: }
3112: }
3113: chop($qresult);
3114: &Reply($client , \$qresult, $userinput);
3115: } else {
3116: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3117: "while attempting currentdump\n", $userinput);
3118: }
3119: } else {
3120: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3121: "while attempting currentdump\n", $userinput);
3122: }
3123:
3124: return 1;
3125: }
3126: ®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
3127:
3128: #
3129: # Dump a profile database with an optional regular expression
3130: # to match against the keys. In this dump, no effort is made
3131: # to separate symb from version information. Presumably the
3132: # databases that are dumped by this command are of a different
3133: # structure. Need to look at this and improve the documentation of
3134: # both this and the currentdump handler.
3135: # Parameters:
3136: # $cmd - The command keyword.
3137: # $tail - All of the characters after the $cmd:
3138: # These are expected to be a colon
3139: # separated list containing:
3140: # domain/user - identifying the user.
3141: # namespace - identifying the database.
3142: # regexp - optional regular expression
3143: # that is matched against
3144: # database keywords to do
3145: # selective dumps.
3146: # $client - Channel open on the client.
3147: # Returns:
3148: # 1 - Continue processing.
3149: # Side effects:
3150: # response is written to $client.
3151: #
3152: sub dump_with_regexp {
3153: my ($cmd, $tail, $client) = @_;
3154:
3155:
3156: my $userinput = "$cmd:$tail";
3157:
3158: my ($udom,$uname,$namespace,$regexp,$range,$extra)=split(/:/,$tail);
3159: if (defined($regexp)) {
3160: $regexp=&unescape($regexp);
3161: } else {
3162: $regexp='.';
3163: }
3164: my ($start,$end);
3165: if (defined($range)) {
3166: if ($range =~/^(\d+)\-(\d+)$/) {
3167: ($start,$end) = ($1,$2);
3168: } elsif ($range =~/^(\d+)$/) {
3169: ($start,$end) = (0,$1);
3170: } else {
3171: undef($range);
3172: }
3173: }
3174: my $hashref = &tie_user_hash($udom, $uname, $namespace,
3175: &GDBM_READER());
3176: my $skipcheck;
3177: if ($hashref) {
3178: my $qresult='';
3179: my $count=0;
3180: if ($extra ne '') {
3181: $extra = &Apache::lonnet::thaw_unescape($extra);
3182: $skipcheck = $extra->{'skipcheck'};
3183: }
3184: my @ids = &Apache::lonnet::current_machine_ids();
3185: my (%homecourses,$major,$minor,$now);
3186: if (($namespace eq 'roles') && (!$skipcheck)) {
3187: my $loncaparev = $clientversion;
3188: if ($loncaparev eq '') {
3189: $loncaparev = $Apache::lonnet::loncaparevs{$clientname};
3190: }
3191: if ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?/) {
3192: $major = $1;
3193: $minor = $2;
3194: }
3195: $now = time;
3196: }
3197: while (my ($key,$value) = each(%$hashref)) {
3198: if ($namespace eq 'roles') {
3199: if ($key =~ m{^/($LONCAPA::match_domain)/($LONCAPA::match_courseid)(/?[^_]*)_(cc|co|in|ta|ep|ad|st|cr)$}) {
3200: my $cdom = $1;
3201: my $cnum = $2;
3202: unless ($skipcheck) {
3203: my ($role,$end,$start) = split(/\_/,$value);
3204: if (!$end || $end > $now) {
3205: next unless (&releasereqd_check($cnum,$cdom,$key,$value,$major,
3206: $minor,\%homecourses,\@ids));
3207: }
3208: }
3209: }
3210: }
3211: if ($regexp eq '.') {
3212: $count++;
3213: if (defined($range) && $count >= $end) { last; }
3214: if (defined($range) && $count < $start) { next; }
3215: $qresult.=$key.'='.$value.'&';
3216: } else {
3217: my $unescapeKey = &unescape($key);
3218: if (eval('$unescapeKey=~/$regexp/')) {
3219: $count++;
3220: if (defined($range) && $count >= $end) { last; }
3221: if (defined($range) && $count < $start) { next; }
3222: $qresult.="$key=$value&";
3223: }
3224: }
3225: }
3226: if (&untie_user_hash($hashref)) {
3227: if (($namespace eq 'roles') && (!$skipcheck)) {
3228: if (keys(%homecourses) > 0) {
3229: $qresult .= &check_homecourses(\%homecourses,$udom,$regexp,$count,
3230: $range,$start,$end,$major,$minor);
3231: }
3232: }
3233: chop($qresult);
3234: &Reply($client, \$qresult, $userinput);
3235: } else {
3236: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3237: "while attempting dump\n", $userinput);
3238: }
3239: } else {
3240: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3241: "while attempting dump\n", $userinput);
3242: }
3243:
3244: return 1;
3245: }
3246: ®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
3247:
3248: # Store a set of key=value pairs associated with a versioned name.
3249: #
3250: # Parameters:
3251: # $cmd - Request command keyword.
3252: # $tail - Tail of the request. This is a colon
3253: # separated list containing:
3254: # domain/user - User and authentication domain.
3255: # namespace - Name of the database being modified
3256: # rid - Resource keyword to modify.
3257: # what - new value associated with rid.
3258: #
3259: # $client - Socket open on the client.
3260: #
3261: #
3262: # Returns:
3263: # 1 (keep on processing).
3264: # Side-Effects:
3265: # Writes to the client
3266: sub store_handler {
3267: my ($cmd, $tail, $client) = @_;
3268:
3269: my $userinput = "$cmd:$tail";
3270:
3271: my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
3272: if ($namespace ne 'roles') {
3273:
3274: chomp($what);
3275: my @pairs=split(/\&/,$what);
3276: my $hashref = &tie_user_hash($udom, $uname, $namespace,
3277: &GDBM_WRCREAT(), "S",
3278: "$rid:$what");
3279: if ($hashref) {
3280: my $now = time;
3281: my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
3282: my $key;
3283: $hashref->{"version:$rid"}++;
3284: my $version=$hashref->{"version:$rid"};
3285: my $allkeys='';
3286: foreach my $pair (@pairs) {
3287: my ($key,$value)=split(/=/,$pair);
3288: $allkeys.=$key.':';
3289: $hashref->{"$version:$rid:$key"}=$value;
3290: }
3291: $hashref->{"$version:$rid:timestamp"}=$now;
3292: $allkeys.='timestamp';
3293: $hashref->{"$version:keys:$rid"}=$allkeys;
3294: if (&untie_user_hash($hashref)) {
3295: &Reply($client, "ok\n", $userinput);
3296: } else {
3297: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3298: "while attempting store\n", $userinput);
3299: }
3300: } else {
3301: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3302: "while attempting store\n", $userinput);
3303: }
3304: } else {
3305: &Failure($client, "refused\n", $userinput);
3306: }
3307:
3308: return 1;
3309: }
3310: ®ister_handler("store", \&store_handler, 0, 1, 0);
3311:
3312: # Modify a set of key=value pairs associated with a versioned name.
3313: #
3314: # Parameters:
3315: # $cmd - Request command keyword.
3316: # $tail - Tail of the request. This is a colon
3317: # separated list containing:
3318: # domain/user - User and authentication domain.
3319: # namespace - Name of the database being modified
3320: # rid - Resource keyword to modify.
3321: # v - Version item to modify
3322: # what - new value associated with rid.
3323: #
3324: # $client - Socket open on the client.
3325: #
3326: #
3327: # Returns:
3328: # 1 (keep on processing).
3329: # Side-Effects:
3330: # Writes to the client
3331: sub putstore_handler {
3332: my ($cmd, $tail, $client) = @_;
3333:
3334: my $userinput = "$cmd:$tail";
3335:
3336: my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
3337: if ($namespace ne 'roles') {
3338:
3339: chomp($what);
3340: my $hashref = &tie_user_hash($udom, $uname, $namespace,
3341: &GDBM_WRCREAT(), "M",
3342: "$rid:$v:$what");
3343: if ($hashref) {
3344: my $now = time;
3345: my %data = &hash_extract($what);
3346: my @allkeys;
3347: while (my($key,$value) = each(%data)) {
3348: push(@allkeys,$key);
3349: $hashref->{"$v:$rid:$key"} = $value;
3350: }
3351: my $allkeys = join(':',@allkeys);
3352: $hashref->{"$v:keys:$rid"}=$allkeys;
3353:
3354: if (&untie_user_hash($hashref)) {
3355: &Reply($client, "ok\n", $userinput);
3356: } else {
3357: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3358: "while attempting store\n", $userinput);
3359: }
3360: } else {
3361: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3362: "while attempting store\n", $userinput);
3363: }
3364: } else {
3365: &Failure($client, "refused\n", $userinput);
3366: }
3367:
3368: return 1;
3369: }
3370: ®ister_handler("putstore", \&putstore_handler, 0, 1, 0);
3371:
3372: sub hash_extract {
3373: my ($str)=@_;
3374: my %hash;
3375: foreach my $pair (split(/\&/,$str)) {
3376: my ($key,$value)=split(/=/,$pair);
3377: $hash{$key}=$value;
3378: }
3379: return (%hash);
3380: }
3381: sub hash_to_str {
3382: my ($hash_ref)=@_;
3383: my $str;
3384: foreach my $key (keys(%$hash_ref)) {
3385: $str.=$key.'='.$hash_ref->{$key}.'&';
3386: }
3387: $str=~s/\&$//;
3388: return $str;
3389: }
3390:
3391: #
3392: # Dump out all versions of a resource that has key=value pairs associated
3393: # with it for each version. These resources are built up via the store
3394: # command.
3395: #
3396: # Parameters:
3397: # $cmd - Command keyword.
3398: # $tail - Remainder of the request which consists of:
3399: # domain/user - User and auth. domain.
3400: # namespace - name of resource database.
3401: # rid - Resource id.
3402: # $client - socket open on the client.
3403: #
3404: # Returns:
3405: # 1 indicating the caller should not yet exit.
3406: # Side-effects:
3407: # Writes a reply to the client.
3408: # The reply is a string of the following shape:
3409: # version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
3410: # Where the 1 above represents version 1.
3411: # this continues for all pairs of keys in all versions.
3412: #
3413: #
3414: #
3415: #
3416: sub restore_handler {
3417: my ($cmd, $tail, $client) = @_;
3418:
3419: my $userinput = "$cmd:$tail"; # Only used for logging purposes.
3420: my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
3421: $namespace=~s/\//\_/g;
3422: $namespace = &LONCAPA::clean_username($namespace);
3423:
3424: chomp($rid);
3425: my $qresult='';
3426: my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
3427: if ($hashref) {
3428: my $version=$hashref->{"version:$rid"};
3429: $qresult.="version=$version&";
3430: my $scope;
3431: for ($scope=1;$scope<=$version;$scope++) {
3432: my $vkeys=$hashref->{"$scope:keys:$rid"};
3433: my @keys=split(/:/,$vkeys);
3434: my $key;
3435: $qresult.="$scope:keys=$vkeys&";
3436: foreach $key (@keys) {
3437: $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
3438: }
3439: }
3440: if (&untie_user_hash($hashref)) {
3441: $qresult=~s/\&$//;
3442: &Reply( $client, \$qresult, $userinput);
3443: } else {
3444: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3445: "while attempting restore\n", $userinput);
3446: }
3447: } else {
3448: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3449: "while attempting restore\n", $userinput);
3450: }
3451:
3452: return 1;
3453:
3454:
3455: }
3456: ®ister_handler("restore", \&restore_handler, 0,1,0);
3457:
3458: #
3459: # Add a chat message to a synchronous discussion board.
3460: #
3461: # Parameters:
3462: # $cmd - Request keyword.
3463: # $tail - Tail of the command. A colon separated list
3464: # containing:
3465: # cdom - Domain on which the chat board lives
3466: # cnum - Course containing the chat board.
3467: # newpost - Body of the posting.
3468: # group - Optional group, if chat board is only
3469: # accessible in a group within the course
3470: # $client - Socket open on the client.
3471: # Returns:
3472: # 1 - Indicating caller should keep on processing.
3473: #
3474: # Side-effects:
3475: # writes a reply to the client.
3476: #
3477: #
3478: sub send_chat_handler {
3479: my ($cmd, $tail, $client) = @_;
3480:
3481:
3482: my $userinput = "$cmd:$tail";
3483:
3484: my ($cdom,$cnum,$newpost,$group)=split(/\:/,$tail);
3485: &chat_add($cdom,$cnum,$newpost,$group);
3486: &Reply($client, "ok\n", $userinput);
3487:
3488: return 1;
3489: }
3490: ®ister_handler("chatsend", \&send_chat_handler, 0, 1, 0);
3491:
3492: #
3493: # Retrieve the set of chat messages from a discussion board.
3494: #
3495: # Parameters:
3496: # $cmd - Command keyword that initiated the request.
3497: # $tail - Remainder of the request after the command
3498: # keyword. In this case a colon separated list of
3499: # chat domain - Which discussion board.
3500: # chat id - Discussion thread(?)
3501: # domain/user - Authentication domain and username
3502: # of the requesting person.
3503: # group - Optional course group containing
3504: # the board.
3505: # $client - Socket open on the client program.
3506: # Returns:
3507: # 1 - continue processing
3508: # Side effects:
3509: # Response is written to the client.
3510: #
3511: sub retrieve_chat_handler {
3512: my ($cmd, $tail, $client) = @_;
3513:
3514:
3515: my $userinput = "$cmd:$tail";
3516:
3517: my ($cdom,$cnum,$udom,$uname,$group)=split(/\:/,$tail);
3518: my $reply='';
3519: foreach (&get_chat($cdom,$cnum,$udom,$uname,$group)) {
3520: $reply.=&escape($_).':';
3521: }
3522: $reply=~s/\:$//;
3523: &Reply($client, \$reply, $userinput);
3524:
3525:
3526: return 1;
3527: }
3528: ®ister_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
3529:
3530: #
3531: # Initiate a query of an sql database. SQL query repsonses get put in
3532: # a file for later retrieval. This prevents sql query results from
3533: # bottlenecking the system. Note that with loncnew, perhaps this is
3534: # less of an issue since multiple outstanding requests can be concurrently
3535: # serviced.
3536: #
3537: # Parameters:
3538: # $cmd - COmmand keyword that initiated the request.
3539: # $tail - Remainder of the command after the keyword.
3540: # For this function, this consists of a query and
3541: # 3 arguments that are self-documentingly labelled
3542: # in the original arg1, arg2, arg3.
3543: # $client - Socket open on the client.
3544: # Return:
3545: # 1 - Indicating processing should continue.
3546: # Side-effects:
3547: # a reply is written to $client.
3548: #
3549: sub send_query_handler {
3550: my ($cmd, $tail, $client) = @_;
3551:
3552:
3553: my $userinput = "$cmd:$tail";
3554:
3555: my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
3556: $query=~s/\n*$//g;
3557: &Reply($client, "". &sql_reply("$clientname\&$query".
3558: "\&$arg1"."\&$arg2"."\&$arg3")."\n",
3559: $userinput);
3560:
3561: return 1;
3562: }
3563: ®ister_handler("querysend", \&send_query_handler, 0, 1, 0);
3564:
3565: #
3566: # Add a reply to an sql query. SQL queries are done asyncrhonously.
3567: # The query is submitted via a "querysend" transaction.
3568: # There it is passed on to the lonsql daemon, queued and issued to
3569: # mysql.
3570: # This transaction is invoked when the sql transaction is complete
3571: # it stores the query results in flie and indicates query completion.
3572: # presumably local software then fetches this response... I'm guessing
3573: # the sequence is: lonc does a querysend, we ask lonsql to do it.
3574: # lonsql on completion of the query interacts with the lond of our
3575: # client to do a query reply storing two files:
3576: # - id - The results of the query.
3577: # - id.end - Indicating the transaction completed.
3578: # NOTE: id is a unique id assigned to the query and querysend time.
3579: # Parameters:
3580: # $cmd - Command keyword that initiated this request.
3581: # $tail - Remainder of the tail. In this case that's a colon
3582: # separated list containing the query Id and the
3583: # results of the query.
3584: # $client - Socket open on the client.
3585: # Return:
3586: # 1 - Indicating that we should continue processing.
3587: # Side effects:
3588: # ok written to the client.
3589: #
3590: sub reply_query_handler {
3591: my ($cmd, $tail, $client) = @_;
3592:
3593:
3594: my $userinput = "$cmd:$tail";
3595:
3596: my ($id,$reply)=split(/:/,$tail);
3597: my $store;
3598: my $execdir=$perlvar{'lonDaemons'};
3599: if ($store=IO::File->new(">$execdir/tmp/$id")) {
3600: $reply=~s/\&/\n/g;
3601: print $store $reply;
3602: close $store;
3603: my $store2=IO::File->new(">$execdir/tmp/$id.end");
3604: print $store2 "done\n";
3605: close $store2;
3606: &Reply($client, "ok\n", $userinput);
3607: } else {
3608: &Failure($client, "error: ".($!+0)
3609: ." IO::File->new Failed ".
3610: "while attempting queryreply\n", $userinput);
3611: }
3612:
3613:
3614: return 1;
3615: }
3616: ®ister_handler("queryreply", \&reply_query_handler, 0, 1, 0);
3617:
3618: #
3619: # Process the courseidput request. Not quite sure what this means
3620: # at the system level sense. It appears a gdbm file in the
3621: # /home/httpd/lonUsers/$domain/nohist_courseids is tied and
3622: # a set of entries made in that database.
3623: #
3624: # Parameters:
3625: # $cmd - The command keyword that initiated this request.
3626: # $tail - Tail of the command. In this case consists of a colon
3627: # separated list contaning the domain to apply this to and
3628: # an ampersand separated list of keyword=value pairs.
3629: # Each value is a colon separated list that includes:
3630: # description, institutional code and course owner.
3631: # For backward compatibility with versions included
3632: # in LON-CAPA 1.1.X (and earlier) and 1.2.X, institutional
3633: # code and/or course owner are preserved from the existing
3634: # record when writing a new record in response to 1.1 or
3635: # 1.2 implementations of lonnet::flushcourselogs().
3636: #
3637: # $client - Socket open on the client.
3638: # Returns:
3639: # 1 - indicating that processing should continue
3640: #
3641: # Side effects:
3642: # reply is written to the client.
3643: #
3644: sub put_course_id_handler {
3645: my ($cmd, $tail, $client) = @_;
3646:
3647:
3648: my $userinput = "$cmd:$tail";
3649:
3650: my ($udom, $what) = split(/:/, $tail,2);
3651: chomp($what);
3652: my $now=time;
3653: my @pairs=split(/\&/,$what);
3654:
3655: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3656: if ($hashref) {
3657: foreach my $pair (@pairs) {
3658: my ($key,$courseinfo) = split(/=/,$pair,2);
3659: $courseinfo =~ s/=/:/g;
3660: if (defined($hashref->{$key})) {
3661: my $value = &Apache::lonnet::thaw_unescape($hashref->{$key});
3662: if (ref($value) eq 'HASH') {
3663: my @items = ('description','inst_code','owner','type');
3664: my @new_items = split(/:/,$courseinfo,-1);
3665: my %storehash;
3666: for (my $i=0; $i<@new_items; $i++) {
3667: $storehash{$items[$i]} = &unescape($new_items[$i]);
3668: }
3669: $hashref->{$key} =
3670: &Apache::lonnet::freeze_escape(\%storehash);
3671: my $unesc_key = &unescape($key);
3672: $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
3673: next;
3674: }
3675: }
3676: my @current_items = split(/:/,$hashref->{$key},-1);
3677: shift(@current_items); # remove description
3678: pop(@current_items); # remove last access
3679: my $numcurrent = scalar(@current_items);
3680: if ($numcurrent > 3) {
3681: $numcurrent = 3;
3682: }
3683: my @new_items = split(/:/,$courseinfo,-1);
3684: my $numnew = scalar(@new_items);
3685: if ($numcurrent > 0) {
3686: if ($numnew <= $numcurrent) { # flushcourselogs() from pre 2.2
3687: for (my $j=$numcurrent-$numnew; $j>=0; $j--) {
3688: $courseinfo .= ':'.$current_items[$numcurrent-$j-1];
3689: }
3690: }
3691: }
3692: $hashref->{$key}=$courseinfo.':'.$now;
3693: }
3694: if (&untie_domain_hash($hashref)) {
3695: &Reply( $client, "ok\n", $userinput);
3696: } else {
3697: &Failure($client, "error: ".($!+0)
3698: ." untie(GDBM) Failed ".
3699: "while attempting courseidput\n", $userinput);
3700: }
3701: } else {
3702: &Failure($client, "error: ".($!+0)
3703: ." tie(GDBM) Failed ".
3704: "while attempting courseidput\n", $userinput);
3705: }
3706:
3707: return 1;
3708: }
3709: ®ister_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
3710:
3711: sub put_course_id_hash_handler {
3712: my ($cmd, $tail, $client) = @_;
3713: my $userinput = "$cmd:$tail";
3714: my ($udom,$mode,$what) = split(/:/, $tail,3);
3715: chomp($what);
3716: my $now=time;
3717: my @pairs=split(/\&/,$what);
3718: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3719: if ($hashref) {
3720: foreach my $pair (@pairs) {
3721: my ($key,$value)=split(/=/,$pair);
3722: my $unesc_key = &unescape($key);
3723: if ($mode ne 'timeonly') {
3724: if (!defined($hashref->{&escape('lasttime:'.$unesc_key)})) {
3725: my $curritems = &Apache::lonnet::thaw_unescape($key);
3726: if (ref($curritems) ne 'HASH') {
3727: my @current_items = split(/:/,$hashref->{$key},-1);
3728: my $lasttime = pop(@current_items);
3729: $hashref->{&escape('lasttime:'.$unesc_key)} = $lasttime;
3730: } else {
3731: $hashref->{&escape('lasttime:'.$unesc_key)} = '';
3732: }
3733: }
3734: $hashref->{$key} = $value;
3735: }
3736: if ($mode ne 'notime') {
3737: $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
3738: }
3739: }
3740: if (&untie_domain_hash($hashref)) {
3741: &Reply($client, "ok\n", $userinput);
3742: } else {
3743: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3744: "while attempting courseidputhash\n", $userinput);
3745: }
3746: } else {
3747: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3748: "while attempting courseidputhash\n", $userinput);
3749: }
3750: return 1;
3751: }
3752: ®ister_handler("courseidputhash", \&put_course_id_hash_handler, 0, 1, 0);
3753:
3754: # Retrieves the value of a course id resource keyword pattern
3755: # defined since a starting date. Both the starting date and the
3756: # keyword pattern are optional. If the starting date is not supplied it
3757: # is treated as the beginning of time. If the pattern is not found,
3758: # it is treatred as "." matching everything.
3759: #
3760: # Parameters:
3761: # $cmd - Command keyword that resulted in us being dispatched.
3762: # $tail - The remainder of the command that, in this case, consists
3763: # of a colon separated list of:
3764: # domain - The domain in which the course database is
3765: # defined.
3766: # since - Optional parameter describing the minimum
3767: # time of definition(?) of the resources that
3768: # will match the dump.
3769: # description - regular expression that is used to filter
3770: # the dump. Only keywords matching this regexp
3771: # will be used.
3772: # institutional code - optional supplied code to filter
3773: # the dump. Only courses with an institutional code
3774: # that match the supplied code will be returned.
3775: # owner - optional supplied username and domain of owner to
3776: # filter the dump. Only courses for which the course
3777: # owner matches the supplied username and/or domain
3778: # will be returned. Pre-2.2.0 legacy entries from
3779: # nohist_courseiddump will only contain usernames.
3780: # type - optional parameter for selection
3781: # regexp_ok - if 1 or -1 allow the supplied institutional code
3782: # filter to behave as a regular expression:
3783: # 1 will not exclude the course if the instcode matches the RE
3784: # -1 will exclude the course if the instcode matches the RE
3785: # rtn_as_hash - whether to return the information available for
3786: # each matched item as a frozen hash of all
3787: # key, value pairs in the item's hash, or as a
3788: # colon-separated list of (in order) description,
3789: # institutional code, and course owner.
3790: # selfenrollonly - filter by courses allowing self-enrollment
3791: # now or in the future (selfenrollonly = 1).
3792: # catfilter - filter by course category, assigned to a course
3793: # using manually defined categories (i.e., not
3794: # self-cataloging based on on institutional code).
3795: # showhidden - include course in results even if course
3796: # was set to be excluded from course catalog (DC only).
3797: # caller - if set to 'coursecatalog', courses set to be hidden
3798: # from course catalog will be excluded from results (unless
3799: # overridden by "showhidden".
3800: # cloner - escaped username:domain of course cloner (if picking course to
3801: # clone).
3802: # cc_clone_list - escaped comma separated list of courses for which
3803: # course cloner has active CC role (and so can clone
3804: # automatically).
3805: # cloneonly - filter by courses for which cloner has rights to clone.
3806: # createdbefore - include courses for which creation date preceeded this date.
3807: # createdafter - include courses for which creation date followed this date.
3808: # creationcontext - include courses created in specified context
3809: #
3810: # domcloner - flag to indicate if user can create CCs in course's domain.
3811: # If so, ability to clone course is automatic.
3812: #
3813: # $client - The socket open on the client.
3814: # Returns:
3815: # 1 - Continue processing.
3816: # Side Effects:
3817: # a reply is written to $client.
3818: sub dump_course_id_handler {
3819: my ($cmd, $tail, $client) = @_;
3820: my $userinput = "$cmd:$tail";
3821:
3822: my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
3823: $typefilter,$regexp_ok,$rtn_as_hash,$selfenrollonly,$catfilter,$showhidden,
3824: $caller,$cloner,$cc_clone_list,$cloneonly,$createdbefore,$createdafter,
3825: $creationcontext,$domcloner) =split(/:/,$tail);
3826: my $now = time;
3827: my ($cloneruname,$clonerudom,%cc_clone);
3828: if (defined($description)) {
3829: $description=&unescape($description);
3830: } else {
3831: $description='.';
3832: }
3833: if (defined($instcodefilter)) {
3834: $instcodefilter=&unescape($instcodefilter);
3835: } else {
3836: $instcodefilter='.';
3837: }
3838: my ($ownerunamefilter,$ownerdomfilter);
3839: if (defined($ownerfilter)) {
3840: $ownerfilter=&unescape($ownerfilter);
3841: if ($ownerfilter ne '.' && defined($ownerfilter)) {
3842: if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
3843: $ownerunamefilter = $1;
3844: $ownerdomfilter = $2;
3845: } else {
3846: $ownerunamefilter = $ownerfilter;
3847: $ownerdomfilter = '';
3848: }
3849: }
3850: } else {
3851: $ownerfilter='.';
3852: }
3853:
3854: if (defined($coursefilter)) {
3855: $coursefilter=&unescape($coursefilter);
3856: } else {
3857: $coursefilter='.';
3858: }
3859: if (defined($typefilter)) {
3860: $typefilter=&unescape($typefilter);
3861: } else {
3862: $typefilter='.';
3863: }
3864: if (defined($regexp_ok)) {
3865: $regexp_ok=&unescape($regexp_ok);
3866: }
3867: if (defined($catfilter)) {
3868: $catfilter=&unescape($catfilter);
3869: }
3870: if (defined($cloner)) {
3871: $cloner = &unescape($cloner);
3872: ($cloneruname,$clonerudom) = ($cloner =~ /^($LONCAPA::match_username):($LONCAPA::match_domain)$/);
3873: }
3874: if (defined($cc_clone_list)) {
3875: $cc_clone_list = &unescape($cc_clone_list);
3876: my @cc_cloners = split('&',$cc_clone_list);
3877: foreach my $cid (@cc_cloners) {
3878: my ($clonedom,$clonenum) = split(':',$cid);
3879: next if ($clonedom ne $udom);
3880: $cc_clone{$clonedom.'_'.$clonenum} = 1;
3881: }
3882: }
3883: if ($createdbefore ne '') {
3884: $createdbefore = &unescape($createdbefore);
3885: } else {
3886: $createdbefore = 0;
3887: }
3888: if ($createdafter ne '') {
3889: $createdafter = &unescape($createdafter);
3890: } else {
3891: $createdafter = 0;
3892: }
3893: if ($creationcontext ne '') {
3894: $creationcontext = &unescape($creationcontext);
3895: } else {
3896: $creationcontext = '.';
3897: }
3898: my $unpack = 1;
3899: if ($description eq '.' && $instcodefilter eq '.' && $coursefilter eq '.' &&
3900: $typefilter eq '.') {
3901: $unpack = 0;
3902: }
3903: if (!defined($since)) { $since=0; }
3904: my $qresult='';
3905: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3906: if ($hashref) {
3907: while (my ($key,$value) = each(%$hashref)) {
3908: my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,
3909: %unesc_val,$selfenroll_end,$selfenroll_types,$created,
3910: $context);
3911: $unesc_key = &unescape($key);
3912: if ($unesc_key =~ /^lasttime:/) {
3913: next;
3914: } else {
3915: $lasttime_key = &escape('lasttime:'.$unesc_key);
3916: }
3917: if ($hashref->{$lasttime_key} ne '') {
3918: $lasttime = $hashref->{$lasttime_key};
3919: next if ($lasttime<$since);
3920: }
3921: my ($canclone,$valchange);
3922: my $items = &Apache::lonnet::thaw_unescape($value);
3923: if (ref($items) eq 'HASH') {
3924: if ($hashref->{$lasttime_key} eq '') {
3925: next if ($since > 1);
3926: }
3927: $is_hash = 1;
3928: if ($domcloner) {
3929: $canclone = 1;
3930: } elsif (defined($clonerudom)) {
3931: if ($items->{'cloners'}) {
3932: my @cloneable = split(',',$items->{'cloners'});
3933: if (@cloneable) {
3934: if (grep(/^\*$/,@cloneable)) {
3935: $canclone = 1;
3936: } elsif (grep(/^\*:\Q$clonerudom\E$/,@cloneable)) {
3937: $canclone = 1;
3938: } elsif (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
3939: $canclone = 1;
3940: }
3941: }
3942: unless ($canclone) {
3943: if ($cloneruname ne '' && $clonerudom ne '') {
3944: if ($cc_clone{$unesc_key}) {
3945: $canclone = 1;
3946: $items->{'cloners'} .= ','.$cloneruname.':'.
3947: $clonerudom;
3948: $valchange = 1;
3949: }
3950: }
3951: }
3952: } elsif (defined($cloneruname)) {
3953: if ($cc_clone{$unesc_key}) {
3954: $canclone = 1;
3955: $items->{'cloners'} = $cloneruname.':'.$clonerudom;
3956: $valchange = 1;
3957: }
3958: unless ($canclone) {
3959: if ($items->{'owner'} =~ /:/) {
3960: if ($items->{'owner'} eq $cloner) {
3961: $canclone = 1;
3962: }
3963: } elsif ($cloner eq $items->{'owner'}.':'.$udom) {
3964: $canclone = 1;
3965: }
3966: if ($canclone) {
3967: $items->{'cloners'} = $cloneruname.':'.$clonerudom;
3968: $valchange = 1;
3969: }
3970: }
3971: }
3972: }
3973: if ($unpack || !$rtn_as_hash) {
3974: $unesc_val{'descr'} = $items->{'description'};
3975: $unesc_val{'inst_code'} = $items->{'inst_code'};
3976: $unesc_val{'owner'} = $items->{'owner'};
3977: $unesc_val{'type'} = $items->{'type'};
3978: $unesc_val{'cloners'} = $items->{'cloners'};
3979: $unesc_val{'created'} = $items->{'created'};
3980: $unesc_val{'context'} = $items->{'context'};
3981: }
3982: $selfenroll_types = $items->{'selfenroll_types'};
3983: $selfenroll_end = $items->{'selfenroll_end_date'};
3984: $created = $items->{'created'};
3985: $context = $items->{'context'};
3986: if ($selfenrollonly) {
3987: next if (!$selfenroll_types);
3988: if (($selfenroll_end > 0) && ($selfenroll_end <= $now)) {
3989: next;
3990: }
3991: }
3992: if ($creationcontext ne '.') {
3993: next if (($context ne '') && ($context ne $creationcontext));
3994: }
3995: if ($createdbefore > 0) {
3996: next if (($created eq '') || ($created > $createdbefore));
3997: }
3998: if ($createdafter > 0) {
3999: next if (($created eq '') || ($created <= $createdafter));
4000: }
4001: if ($catfilter ne '') {
4002: next if ($items->{'categories'} eq '');
4003: my @categories = split('&',$items->{'categories'});
4004: next if (@categories == 0);
4005: my @subcats = split('&',$catfilter);
4006: my $matchcat = 0;
4007: foreach my $cat (@categories) {
4008: if (grep(/^\Q$cat\E$/,@subcats)) {
4009: $matchcat = 1;
4010: last;
4011: }
4012: }
4013: next if (!$matchcat);
4014: }
4015: if ($caller eq 'coursecatalog') {
4016: if ($items->{'hidefromcat'} eq 'yes') {
4017: next if !$showhidden;
4018: }
4019: }
4020: } else {
4021: next if ($catfilter ne '');
4022: next if ($selfenrollonly);
4023: next if ($createdbefore || $createdafter);
4024: next if ($creationcontext ne '.');
4025: if ((defined($clonerudom)) && (defined($cloneruname))) {
4026: if ($cc_clone{$unesc_key}) {
4027: $canclone = 1;
4028: $val{'cloners'} = &escape($cloneruname.':'.$clonerudom);
4029: }
4030: }
4031: $is_hash = 0;
4032: my @courseitems = split(/:/,$value);
4033: $lasttime = pop(@courseitems);
4034: if ($hashref->{$lasttime_key} eq '') {
4035: next if ($lasttime<$since);
4036: }
4037: ($val{'descr'},$val{'inst_code'},$val{'owner'},$val{'type'}) = @courseitems;
4038: }
4039: if ($cloneonly) {
4040: next unless ($canclone);
4041: }
4042: my $match = 1;
4043: if ($description ne '.') {
4044: if (!$is_hash) {
4045: $unesc_val{'descr'} = &unescape($val{'descr'});
4046: }
4047: if (eval{$unesc_val{'descr'} !~ /\Q$description\E/i}) {
4048: $match = 0;
4049: }
4050: }
4051: if ($instcodefilter ne '.') {
4052: if (!$is_hash) {
4053: $unesc_val{'inst_code'} = &unescape($val{'inst_code'});
4054: }
4055: if ($regexp_ok == 1) {
4056: if (eval{$unesc_val{'inst_code'} !~ /$instcodefilter/}) {
4057: $match = 0;
4058: }
4059: } elsif ($regexp_ok == -1) {
4060: if (eval{$unesc_val{'inst_code'} =~ /$instcodefilter/}) {
4061: $match = 0;
4062: }
4063: } else {
4064: if (eval{$unesc_val{'inst_code'} !~ /\Q$instcodefilter\E/i}) {
4065: $match = 0;
4066: }
4067: }
4068: }
4069: if ($ownerfilter ne '.') {
4070: if (!$is_hash) {
4071: $unesc_val{'owner'} = &unescape($val{'owner'});
4072: }
4073: if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
4074: if ($unesc_val{'owner'} =~ /:/) {
4075: if (eval{$unesc_val{'owner'} !~
4076: /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i}) {
4077: $match = 0;
4078: }
4079: } else {
4080: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
4081: $match = 0;
4082: }
4083: }
4084: } elsif ($ownerunamefilter ne '') {
4085: if ($unesc_val{'owner'} =~ /:/) {
4086: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E:[^:]+$/i}) {
4087: $match = 0;
4088: }
4089: } else {
4090: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
4091: $match = 0;
4092: }
4093: }
4094: } elsif ($ownerdomfilter ne '') {
4095: if ($unesc_val{'owner'} =~ /:/) {
4096: if (eval{$unesc_val{'owner'} !~ /^[^:]+:\Q$ownerdomfilter\E/}) {
4097: $match = 0;
4098: }
4099: } else {
4100: if ($ownerdomfilter ne $udom) {
4101: $match = 0;
4102: }
4103: }
4104: }
4105: }
4106: if ($coursefilter ne '.') {
4107: if (eval{$unesc_key !~ /^$udom(_)\Q$coursefilter\E$/}) {
4108: $match = 0;
4109: }
4110: }
4111: if ($typefilter ne '.') {
4112: if (!$is_hash) {
4113: $unesc_val{'type'} = &unescape($val{'type'});
4114: }
4115: if ($unesc_val{'type'} eq '') {
4116: if ($typefilter ne 'Course') {
4117: $match = 0;
4118: }
4119: } else {
4120: if (eval{$unesc_val{'type'} !~ /^\Q$typefilter\E$/}) {
4121: $match = 0;
4122: }
4123: }
4124: }
4125: if ($match == 1) {
4126: if ($rtn_as_hash) {
4127: if ($is_hash) {
4128: if ($valchange) {
4129: my $newvalue = &Apache::lonnet::freeze_escape($items);
4130: $qresult.=$key.'='.$newvalue.'&';
4131: } else {
4132: $qresult.=$key.'='.$value.'&';
4133: }
4134: } else {
4135: my %rtnhash = ( 'description' => &unescape($val{'descr'}),
4136: 'inst_code' => &unescape($val{'inst_code'}),
4137: 'owner' => &unescape($val{'owner'}),
4138: 'type' => &unescape($val{'type'}),
4139: 'cloners' => &unescape($val{'cloners'}),
4140: );
4141: my $items = &Apache::lonnet::freeze_escape(\%rtnhash);
4142: $qresult.=$key.'='.$items.'&';
4143: }
4144: } else {
4145: if ($is_hash) {
4146: $qresult .= $key.'='.&escape($unesc_val{'descr'}).':'.
4147: &escape($unesc_val{'inst_code'}).':'.
4148: &escape($unesc_val{'owner'}).'&';
4149: } else {
4150: $qresult .= $key.'='.$val{'descr'}.':'.$val{'inst_code'}.
4151: ':'.$val{'owner'}.'&';
4152: }
4153: }
4154: }
4155: }
4156: if (&untie_domain_hash($hashref)) {
4157: chop($qresult);
4158: &Reply($client, \$qresult, $userinput);
4159: } else {
4160: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4161: "while attempting courseiddump\n", $userinput);
4162: }
4163: } else {
4164: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4165: "while attempting courseiddump\n", $userinput);
4166: }
4167: return 1;
4168: }
4169: ®ister_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
4170:
4171: sub course_lastaccess_handler {
4172: my ($cmd, $tail, $client) = @_;
4173: my $userinput = "$cmd:$tail";
4174: my ($cdom,$cnum) = split(':',$tail);
4175: my (%lastaccess,$qresult);
4176: my $hashref = &tie_domain_hash($cdom, "nohist_courseids", &GDBM_WRCREAT());
4177: if ($hashref) {
4178: while (my ($key,$value) = each(%$hashref)) {
4179: my ($unesc_key,$lasttime);
4180: $unesc_key = &unescape($key);
4181: if ($cnum) {
4182: next unless ($unesc_key =~ /\Q$cdom\E_\Q$cnum\E$/);
4183: }
4184: if ($unesc_key =~ /^lasttime:($LONCAPA::match_domain\_$LONCAPA::match_courseid)/) {
4185: $lastaccess{$1} = $value;
4186: } else {
4187: my $items = &Apache::lonnet::thaw_unescape($value);
4188: if (ref($items) eq 'HASH') {
4189: unless ($lastaccess{$unesc_key}) {
4190: $lastaccess{$unesc_key} = '';
4191: }
4192: } else {
4193: my @courseitems = split(':',$value);
4194: $lastaccess{$unesc_key} = pop(@courseitems);
4195: }
4196: }
4197: }
4198: foreach my $cid (sort(keys(%lastaccess))) {
4199: $qresult.=&escape($cid).'='.$lastaccess{$cid}.'&';
4200: }
4201: if (&untie_domain_hash($hashref)) {
4202: if ($qresult) {
4203: chop($qresult);
4204: }
4205: &Reply($client, \$qresult, $userinput);
4206: } else {
4207: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4208: "while attempting lastacourseaccess\n", $userinput);
4209: }
4210: } else {
4211: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4212: "while attempting lastcourseaccess\n", $userinput);
4213: }
4214: return 1;
4215: }
4216: ®ister_handler("courselastaccess",\&course_lastaccess_handler, 0, 1, 0);
4217:
4218: #
4219: # Puts an unencrypted entry in a namespace db file at the domain level
4220: #
4221: # Parameters:
4222: # $cmd - The command that got us here.
4223: # $tail - Tail of the command (remaining parameters).
4224: # $client - File descriptor connected to client.
4225: # Returns
4226: # 0 - Requested to exit, caller should shut down.
4227: # 1 - Continue processing.
4228: # Side effects:
4229: # reply is written to $client.
4230: #
4231: sub put_domain_handler {
4232: my ($cmd,$tail,$client) = @_;
4233:
4234: my $userinput = "$cmd:$tail";
4235:
4236: my ($udom,$namespace,$what) =split(/:/,$tail,3);
4237: chomp($what);
4238: my @pairs=split(/\&/,$what);
4239: my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_WRCREAT(),
4240: "P", $what);
4241: if ($hashref) {
4242: foreach my $pair (@pairs) {
4243: my ($key,$value)=split(/=/,$pair);
4244: $hashref->{$key}=$value;
4245: }
4246: if (&untie_domain_hash($hashref)) {
4247: &Reply($client, "ok\n", $userinput);
4248: } else {
4249: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4250: "while attempting putdom\n", $userinput);
4251: }
4252: } else {
4253: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
4254: "while attempting putdom\n", $userinput);
4255: }
4256:
4257: return 1;
4258: }
4259: ®ister_handler("putdom", \&put_domain_handler, 0, 1, 0);
4260:
4261: # Unencrypted get from the namespace database file at the domain level.
4262: # This function retrieves a keyed item from a specific named database in the
4263: # domain directory.
4264: #
4265: # Parameters:
4266: # $cmd - Command request keyword (get).
4267: # $tail - Tail of the command. This is a colon separated list
4268: # consisting of the domain and the 'namespace'
4269: # which selects the gdbm file to do the lookup in,
4270: # & separated list of keys to lookup. Note that
4271: # the values are returned as an & separated list too.
4272: # $client - File descriptor open on the client.
4273: # Returns:
4274: # 1 - Continue processing.
4275: # 0 - Exit.
4276: # Side effects:
4277: # reply is written to $client.
4278: #
4279:
4280: sub get_domain_handler {
4281: my ($cmd, $tail, $client) = @_;
4282:
4283:
4284: my $userinput = "$client:$tail";
4285:
4286: my ($udom,$namespace,$what)=split(/:/,$tail,3);
4287: chomp($what);
4288: my @queries=split(/\&/,$what);
4289: my $qresult='';
4290: my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_READER());
4291: if ($hashref) {
4292: for (my $i=0;$i<=$#queries;$i++) {
4293: $qresult.="$hashref->{$queries[$i]}&";
4294: }
4295: if (&untie_domain_hash($hashref)) {
4296: $qresult=~s/\&$//;
4297: &Reply($client, \$qresult, $userinput);
4298: } else {
4299: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
4300: "while attempting getdom\n",$userinput);
4301: }
4302: } else {
4303: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4304: "while attempting getdom\n",$userinput);
4305: }
4306:
4307: return 1;
4308: }
4309: ®ister_handler("getdom", \&get_domain_handler, 0, 1, 0);
4310:
4311: #
4312: # Puts an id to a domains id database.
4313: #
4314: # Parameters:
4315: # $cmd - The command that triggered us.
4316: # $tail - Remainder of the request other than the command. This is a
4317: # colon separated list containing:
4318: # $domain - The domain for which we are writing the id.
4319: # $pairs - The id info to write... this is and & separated list
4320: # of keyword=value.
4321: # $client - Socket open on the client.
4322: # Returns:
4323: # 1 - Continue processing.
4324: # Side effects:
4325: # reply is written to $client.
4326: #
4327: sub put_id_handler {
4328: my ($cmd,$tail,$client) = @_;
4329:
4330:
4331: my $userinput = "$cmd:$tail";
4332:
4333: my ($udom,$what)=split(/:/,$tail);
4334: chomp($what);
4335: my @pairs=split(/\&/,$what);
4336: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
4337: "P", $what);
4338: if ($hashref) {
4339: foreach my $pair (@pairs) {
4340: my ($key,$value)=split(/=/,$pair);
4341: $hashref->{$key}=$value;
4342: }
4343: if (&untie_domain_hash($hashref)) {
4344: &Reply($client, "ok\n", $userinput);
4345: } else {
4346: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4347: "while attempting idput\n", $userinput);
4348: }
4349: } else {
4350: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
4351: "while attempting idput\n", $userinput);
4352: }
4353:
4354: return 1;
4355: }
4356: ®ister_handler("idput", \&put_id_handler, 0, 1, 0);
4357:
4358: #
4359: # Retrieves a set of id values from the id database.
4360: # Returns an & separated list of results, one for each requested id to the
4361: # client.
4362: #
4363: # Parameters:
4364: # $cmd - Command keyword that caused us to be dispatched.
4365: # $tail - Tail of the command. Consists of a colon separated:
4366: # domain - the domain whose id table we dump
4367: # ids Consists of an & separated list of
4368: # id keywords whose values will be fetched.
4369: # nonexisting keywords will have an empty value.
4370: # $client - Socket open on the client.
4371: #
4372: # Returns:
4373: # 1 - indicating processing should continue.
4374: # Side effects:
4375: # An & separated list of results is written to $client.
4376: #
4377: sub get_id_handler {
4378: my ($cmd, $tail, $client) = @_;
4379:
4380:
4381: my $userinput = "$client:$tail";
4382:
4383: my ($udom,$what)=split(/:/,$tail);
4384: chomp($what);
4385: my @queries=split(/\&/,$what);
4386: my $qresult='';
4387: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
4388: if ($hashref) {
4389: for (my $i=0;$i<=$#queries;$i++) {
4390: $qresult.="$hashref->{$queries[$i]}&";
4391: }
4392: if (&untie_domain_hash($hashref)) {
4393: $qresult=~s/\&$//;
4394: &Reply($client, \$qresult, $userinput);
4395: } else {
4396: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
4397: "while attempting idget\n",$userinput);
4398: }
4399: } else {
4400: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4401: "while attempting idget\n",$userinput);
4402: }
4403:
4404: return 1;
4405: }
4406: ®ister_handler("idget", \&get_id_handler, 0, 1, 0);
4407:
4408: #
4409: # Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database
4410: #
4411: # Parameters
4412: # $cmd - Command keyword that caused us to be dispatched.
4413: # $tail - Tail of the command. Consists of a colon separated:
4414: # domain - the domain whose dcmail we are recording
4415: # email Consists of key=value pair
4416: # where key is unique msgid
4417: # and value is message (in XML)
4418: # $client - Socket open on the client.
4419: #
4420: # Returns:
4421: # 1 - indicating processing should continue.
4422: # Side effects
4423: # reply is written to $client.
4424: #
4425: sub put_dcmail_handler {
4426: my ($cmd,$tail,$client) = @_;
4427: my $userinput = "$cmd:$tail";
4428:
4429:
4430: my ($udom,$what)=split(/:/,$tail);
4431: chomp($what);
4432: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
4433: if ($hashref) {
4434: my ($key,$value)=split(/=/,$what);
4435: $hashref->{$key}=$value;
4436: }
4437: if (&untie_domain_hash($hashref)) {
4438: &Reply($client, "ok\n", $userinput);
4439: } else {
4440: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4441: "while attempting dcmailput\n", $userinput);
4442: }
4443: return 1;
4444: }
4445: ®ister_handler("dcmailput", \&put_dcmail_handler, 0, 1, 0);
4446:
4447: #
4448: # Retrieves broadcast e-mail from nohist_dcmail database
4449: # Returns to client an & separated list of key=value pairs,
4450: # where key is msgid and value is message information.
4451: #
4452: # Parameters
4453: # $cmd - Command keyword that caused us to be dispatched.
4454: # $tail - Tail of the command. Consists of a colon separated:
4455: # domain - the domain whose dcmail table we dump
4456: # startfilter - beginning of time window
4457: # endfilter - end of time window
4458: # sendersfilter - & separated list of username:domain
4459: # for senders to search for.
4460: # $client - Socket open on the client.
4461: #
4462: # Returns:
4463: # 1 - indicating processing should continue.
4464: # Side effects
4465: # reply (& separated list of msgid=messageinfo pairs) is
4466: # written to $client.
4467: #
4468: sub dump_dcmail_handler {
4469: my ($cmd, $tail, $client) = @_;
4470:
4471: my $userinput = "$cmd:$tail";
4472: my ($udom,$startfilter,$endfilter,$sendersfilter) = split(/:/,$tail);
4473: chomp($sendersfilter);
4474: my @senders = ();
4475: if (defined($startfilter)) {
4476: $startfilter=&unescape($startfilter);
4477: } else {
4478: $startfilter='.';
4479: }
4480: if (defined($endfilter)) {
4481: $endfilter=&unescape($endfilter);
4482: } else {
4483: $endfilter='.';
4484: }
4485: if (defined($sendersfilter)) {
4486: $sendersfilter=&unescape($sendersfilter);
4487: @senders = map { &unescape($_) } split(/\&/,$sendersfilter);
4488: }
4489:
4490: my $qresult='';
4491: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
4492: if ($hashref) {
4493: while (my ($key,$value) = each(%$hashref)) {
4494: my $match = 1;
4495: my ($timestamp,$subj,$uname,$udom) =
4496: split(/:/,&unescape(&unescape($key)),5); # yes, twice really
4497: $subj = &unescape($subj);
4498: unless ($startfilter eq '.' || !defined($startfilter)) {
4499: if ($timestamp < $startfilter) {
4500: $match = 0;
4501: }
4502: }
4503: unless ($endfilter eq '.' || !defined($endfilter)) {
4504: if ($timestamp > $endfilter) {
4505: $match = 0;
4506: }
4507: }
4508: unless (@senders < 1) {
4509: unless (grep/^$uname:$udom$/,@senders) {
4510: $match = 0;
4511: }
4512: }
4513: if ($match == 1) {
4514: $qresult.=$key.'='.$value.'&';
4515: }
4516: }
4517: if (&untie_domain_hash($hashref)) {
4518: chop($qresult);
4519: &Reply($client, \$qresult, $userinput);
4520: } else {
4521: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4522: "while attempting dcmaildump\n", $userinput);
4523: }
4524: } else {
4525: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4526: "while attempting dcmaildump\n", $userinput);
4527: }
4528: return 1;
4529: }
4530:
4531: ®ister_handler("dcmaildump", \&dump_dcmail_handler, 0, 1, 0);
4532:
4533: #
4534: # Puts domain roles in nohist_domainroles database
4535: #
4536: # Parameters
4537: # $cmd - Command keyword that caused us to be dispatched.
4538: # $tail - Tail of the command. Consists of a colon separated:
4539: # domain - the domain whose roles we are recording
4540: # role - Consists of key=value pair
4541: # where key is unique role
4542: # and value is start/end date information
4543: # $client - Socket open on the client.
4544: #
4545: # Returns:
4546: # 1 - indicating processing should continue.
4547: # Side effects
4548: # reply is written to $client.
4549: #
4550:
4551: sub put_domainroles_handler {
4552: my ($cmd,$tail,$client) = @_;
4553:
4554: my $userinput = "$cmd:$tail";
4555: my ($udom,$what)=split(/:/,$tail);
4556: chomp($what);
4557: my @pairs=split(/\&/,$what);
4558: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
4559: if ($hashref) {
4560: foreach my $pair (@pairs) {
4561: my ($key,$value)=split(/=/,$pair);
4562: $hashref->{$key}=$value;
4563: }
4564: if (&untie_domain_hash($hashref)) {
4565: &Reply($client, "ok\n", $userinput);
4566: } else {
4567: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4568: "while attempting domroleput\n", $userinput);
4569: }
4570: } else {
4571: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
4572: "while attempting domroleput\n", $userinput);
4573: }
4574:
4575: return 1;
4576: }
4577:
4578: ®ister_handler("domroleput", \&put_domainroles_handler, 0, 1, 0);
4579:
4580: #
4581: # Retrieves domain roles from nohist_domainroles database
4582: # Returns to client an & separated list of key=value pairs,
4583: # where key is role and value is start and end date information.
4584: #
4585: # Parameters
4586: # $cmd - Command keyword that caused us to be dispatched.
4587: # $tail - Tail of the command. Consists of a colon separated:
4588: # domain - the domain whose domain roles table we dump
4589: # $client - Socket open on the client.
4590: #
4591: # Returns:
4592: # 1 - indicating processing should continue.
4593: # Side effects
4594: # reply (& separated list of role=start/end info pairs) is
4595: # written to $client.
4596: #
4597: sub dump_domainroles_handler {
4598: my ($cmd, $tail, $client) = @_;
4599:
4600: my $userinput = "$cmd:$tail";
4601: my ($udom,$startfilter,$endfilter,$rolesfilter) = split(/:/,$tail);
4602: chomp($rolesfilter);
4603: my @roles = ();
4604: if (defined($startfilter)) {
4605: $startfilter=&unescape($startfilter);
4606: } else {
4607: $startfilter='.';
4608: }
4609: if (defined($endfilter)) {
4610: $endfilter=&unescape($endfilter);
4611: } else {
4612: $endfilter='.';
4613: }
4614: if (defined($rolesfilter)) {
4615: $rolesfilter=&unescape($rolesfilter);
4616: @roles = split(/\&/,$rolesfilter);
4617: }
4618:
4619: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
4620: if ($hashref) {
4621: my $qresult = '';
4622: while (my ($key,$value) = each(%$hashref)) {
4623: my $match = 1;
4624: my ($end,$start) = split(/:/,&unescape($value));
4625: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,&unescape($key));
4626: unless (@roles < 1) {
4627: unless (grep/^\Q$trole\E$/,@roles) {
4628: $match = 0;
4629: next;
4630: }
4631: }
4632: unless ($startfilter eq '.' || !defined($startfilter)) {
4633: if ((defined($start)) && ($start >= $startfilter)) {
4634: $match = 0;
4635: next;
4636: }
4637: }
4638: unless ($endfilter eq '.' || !defined($endfilter)) {
4639: if ((defined($end)) && (($end > 0) && ($end <= $endfilter))) {
4640: $match = 0;
4641: next;
4642: }
4643: }
4644: if ($match == 1) {
4645: $qresult.=$key.'='.$value.'&';
4646: }
4647: }
4648: if (&untie_domain_hash($hashref)) {
4649: chop($qresult);
4650: &Reply($client, \$qresult, $userinput);
4651: } else {
4652: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4653: "while attempting domrolesdump\n", $userinput);
4654: }
4655: } else {
4656: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4657: "while attempting domrolesdump\n", $userinput);
4658: }
4659: return 1;
4660: }
4661:
4662: ®ister_handler("domrolesdump", \&dump_domainroles_handler, 0, 1, 0);
4663:
4664:
4665: # Process the tmpput command I'm not sure what this does.. Seems to
4666: # create a file in the lonDaemons/tmp directory of the form $id.tmp
4667: # where Id is the client's ip concatenated with a sequence number.
4668: # The file will contain some value that is passed in. Is this e.g.
4669: # a login token?
4670: #
4671: # Parameters:
4672: # $cmd - The command that got us dispatched.
4673: # $tail - The remainder of the request following $cmd:
4674: # In this case this will be the contents of the file.
4675: # $client - Socket connected to the client.
4676: # Returns:
4677: # 1 indicating processing can continue.
4678: # Side effects:
4679: # A file is created in the local filesystem.
4680: # A reply is sent to the client.
4681: sub tmp_put_handler {
4682: my ($cmd, $what, $client) = @_;
4683:
4684: my $userinput = "$cmd:$what"; # Reconstruct for logging.
4685:
4686: my ($record,$context) = split(/:/,$what);
4687: if ($context ne '') {
4688: chomp($context);
4689: $context = &unescape($context);
4690: }
4691: my ($id,$store);
4692: $tmpsnum++;
4693: if (($context eq 'resetpw') || ($context eq 'createaccount')) {
4694: $id = &md5_hex(&md5_hex(time.{}.rand().$$));
4695: } else {
4696: $id = $$.'_'.$clientip.'_'.$tmpsnum;
4697: }
4698: $id=~s/\W/\_/g;
4699: $record=~s/\n//g;
4700: my $execdir=$perlvar{'lonDaemons'};
4701: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
4702: print $store $record;
4703: close $store;
4704: &Reply($client, \$id, $userinput);
4705: } else {
4706: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
4707: "while attempting tmpput\n", $userinput);
4708: }
4709: return 1;
4710:
4711: }
4712: ®ister_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
4713:
4714: # Processes the tmpget command. This command returns the contents
4715: # of a temporary resource file(?) created via tmpput.
4716: #
4717: # Paramters:
4718: # $cmd - Command that got us dispatched.
4719: # $id - Tail of the command, contain the id of the resource
4720: # we want to fetch.
4721: # $client - socket open on the client.
4722: # Return:
4723: # 1 - Inidcating processing can continue.
4724: # Side effects:
4725: # A reply is sent to the client.
4726: #
4727: sub tmp_get_handler {
4728: my ($cmd, $id, $client) = @_;
4729:
4730: my $userinput = "$cmd:$id";
4731:
4732:
4733: $id=~s/\W/\_/g;
4734: my $store;
4735: my $execdir=$perlvar{'lonDaemons'};
4736: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
4737: my $reply=<$store>;
4738: &Reply( $client, \$reply, $userinput);
4739: close $store;
4740: } else {
4741: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
4742: "while attempting tmpget\n", $userinput);
4743: }
4744:
4745: return 1;
4746: }
4747: ®ister_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
4748:
4749: #
4750: # Process the tmpdel command. This command deletes a temp resource
4751: # created by the tmpput command.
4752: #
4753: # Parameters:
4754: # $cmd - Command that got us here.
4755: # $id - Id of the temporary resource created.
4756: # $client - socket open on the client process.
4757: #
4758: # Returns:
4759: # 1 - Indicating processing should continue.
4760: # Side Effects:
4761: # A file is deleted
4762: # A reply is sent to the client.
4763: sub tmp_del_handler {
4764: my ($cmd, $id, $client) = @_;
4765:
4766: my $userinput= "$cmd:$id";
4767:
4768: chomp($id);
4769: $id=~s/\W/\_/g;
4770: my $execdir=$perlvar{'lonDaemons'};
4771: if (unlink("$execdir/tmp/$id.tmp")) {
4772: &Reply($client, "ok\n", $userinput);
4773: } else {
4774: &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
4775: "while attempting tmpdel\n", $userinput);
4776: }
4777:
4778: return 1;
4779:
4780: }
4781: ®ister_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
4782:
4783: #
4784: # Processes the setannounce command. This command
4785: # creates a file named announce.txt in the top directory of
4786: # the documentn root and sets its contents. The announce.txt file is
4787: # printed in its entirety at the LonCAPA login page. Note:
4788: # once the announcement.txt fileis created it cannot be deleted.
4789: # However, setting the contents of the file to empty removes the
4790: # announcement from the login page of loncapa so who cares.
4791: #
4792: # Parameters:
4793: # $cmd - The command that got us dispatched.
4794: # $announcement - The text of the announcement.
4795: # $client - Socket open on the client process.
4796: # Retunrns:
4797: # 1 - Indicating request processing should continue
4798: # Side Effects:
4799: # The file {DocRoot}/announcement.txt is created.
4800: # A reply is sent to $client.
4801: #
4802: sub set_announce_handler {
4803: my ($cmd, $announcement, $client) = @_;
4804:
4805: my $userinput = "$cmd:$announcement";
4806:
4807: chomp($announcement);
4808: $announcement=&unescape($announcement);
4809: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
4810: '/announcement.txt')) {
4811: print $store $announcement;
4812: close $store;
4813: &Reply($client, "ok\n", $userinput);
4814: } else {
4815: &Failure($client, "error: ".($!+0)."\n", $userinput);
4816: }
4817:
4818: return 1;
4819: }
4820: ®ister_handler("setannounce", \&set_announce_handler, 0, 1, 0);
4821:
4822: #
4823: # Return the version of the daemon. This can be used to determine
4824: # the compatibility of cross version installations or, alternatively to
4825: # simply know who's out of date and who isn't. Note that the version
4826: # is returned concatenated with the tail.
4827: # Parameters:
4828: # $cmd - the request that dispatched to us.
4829: # $tail - Tail of the request (client's version?).
4830: # $client - Socket open on the client.
4831: #Returns:
4832: # 1 - continue processing requests.
4833: # Side Effects:
4834: # Replies with version to $client.
4835: sub get_version_handler {
4836: my ($cmd, $tail, $client) = @_;
4837:
4838: my $userinput = $cmd.$tail;
4839:
4840: &Reply($client, &version($userinput)."\n", $userinput);
4841:
4842:
4843: return 1;
4844: }
4845: ®ister_handler("version", \&get_version_handler, 0, 1, 0);
4846:
4847: # Set the current host and domain. This is used to support
4848: # multihomed systems. Each IP of the system, or even separate daemons
4849: # on the same IP can be treated as handling a separate lonCAPA virtual
4850: # machine. This command selects the virtual lonCAPA. The client always
4851: # knows the right one since it is lonc and it is selecting the domain/system
4852: # from the hosts.tab file.
4853: # Parameters:
4854: # $cmd - Command that dispatched us.
4855: # $tail - Tail of the command (domain/host requested).
4856: # $socket - Socket open on the client.
4857: #
4858: # Returns:
4859: # 1 - Indicates the program should continue to process requests.
4860: # Side-effects:
4861: # The default domain/system context is modified for this daemon.
4862: # a reply is sent to the client.
4863: #
4864: sub set_virtual_host_handler {
4865: my ($cmd, $tail, $socket) = @_;
4866:
4867: my $userinput ="$cmd:$tail";
4868:
4869: &Reply($client, &sethost($userinput)."\n", $userinput);
4870:
4871:
4872: return 1;
4873: }
4874: ®ister_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
4875:
4876: # Process a request to exit:
4877: # - "bye" is sent to the client.
4878: # - The client socket is shutdown and closed.
4879: # - We indicate to the caller that we should exit.
4880: # Formal Parameters:
4881: # $cmd - The command that got us here.
4882: # $tail - Tail of the command (empty).
4883: # $client - Socket open on the tail.
4884: # Returns:
4885: # 0 - Indicating the program should exit!!
4886: #
4887: sub exit_handler {
4888: my ($cmd, $tail, $client) = @_;
4889:
4890: my $userinput = "$cmd:$tail";
4891:
4892: &logthis("Client $clientip ($clientname) hanging up: $userinput");
4893: &Reply($client, "bye\n", $userinput);
4894: $client->shutdown(2); # shutdown the socket forcibly.
4895: $client->close();
4896:
4897: return 0;
4898: }
4899: ®ister_handler("exit", \&exit_handler, 0,1,1);
4900: ®ister_handler("init", \&exit_handler, 0,1,1);
4901: ®ister_handler("quit", \&exit_handler, 0,1,1);
4902:
4903: # Determine if auto-enrollment is enabled.
4904: # Note that the original had what I believe to be a defect.
4905: # The original returned 0 if the requestor was not a registerd client.
4906: # It should return "refused".
4907: # Formal Parameters:
4908: # $cmd - The command that invoked us.
4909: # $tail - The tail of the command (Extra command parameters.
4910: # $client - The socket open on the client that issued the request.
4911: # Returns:
4912: # 1 - Indicating processing should continue.
4913: #
4914: sub enrollment_enabled_handler {
4915: my ($cmd, $tail, $client) = @_;
4916: my $userinput = $cmd.":".$tail; # For logging purposes.
4917:
4918:
4919: my ($cdom) = split(/:/, $tail, 2); # Domain we're asking about.
4920:
4921: my $outcome = &localenroll::run($cdom);
4922: &Reply($client, \$outcome, $userinput);
4923:
4924: return 1;
4925: }
4926: ®ister_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
4927:
4928: #
4929: # Validate an institutional code used for a LON-CAPA course.
4930: #
4931: # Formal Parameters:
4932: # $cmd - The command request that got us dispatched.
4933: # $tail - The tail of the command. In this case,
4934: # this is a colon separated set of words that will be split
4935: # into:
4936: # $dom - The domain for which the check of
4937: # institutional course code will occur.
4938: #
4939: # $instcode - The institutional code for the course
4940: # being requested, or validated for rights
4941: # to request.
4942: #
4943: # $owner - The course requestor (who will be the
4944: # course owner, in the form username:domain
4945: #
4946: # $client - Socket open on the client.
4947: # Returns:
4948: # 1 - Indicating processing should continue.
4949: #
4950: sub validate_instcode_handler {
4951: my ($cmd, $tail, $client) = @_;
4952: my $userinput = "$cmd:$tail";
4953: my ($dom,$instcode,$owner) = split(/:/, $tail);
4954: $instcode = &unescape($instcode);
4955: $owner = &unescape($owner);
4956: my ($outcome,$description) =
4957: &localenroll::validate_instcode($dom,$instcode,$owner);
4958: my $result = &escape($outcome).'&'.&escape($description);
4959: &Reply($client, \$result, $userinput);
4960:
4961: return 1;
4962: }
4963: ®ister_handler("autovalidateinstcode", \&validate_instcode_handler, 0, 1, 0);
4964:
4965: # Get the official sections for which auto-enrollment is possible.
4966: # Since the admin people won't know about 'unofficial sections'
4967: # we cannot auto-enroll on them.
4968: # Formal Parameters:
4969: # $cmd - The command request that got us dispatched here.
4970: # $tail - The remainder of the request. In our case this
4971: # will be split into:
4972: # $coursecode - The course name from the admin point of view.
4973: # $cdom - The course's domain(?).
4974: # $client - Socket open on the client.
4975: # Returns:
4976: # 1 - Indiciting processing should continue.
4977: #
4978: sub get_sections_handler {
4979: my ($cmd, $tail, $client) = @_;
4980: my $userinput = "$cmd:$tail";
4981:
4982: my ($coursecode, $cdom) = split(/:/, $tail);
4983: my @secs = &localenroll::get_sections($coursecode,$cdom);
4984: my $seclist = &escape(join(':',@secs));
4985:
4986: &Reply($client, \$seclist, $userinput);
4987:
4988:
4989: return 1;
4990: }
4991: ®ister_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
4992:
4993: # Validate the owner of a new course section.
4994: #
4995: # Formal Parameters:
4996: # $cmd - Command that got us dispatched.
4997: # $tail - the remainder of the command. For us this consists of a
4998: # colon separated string containing:
4999: # $inst - Course Id from the institutions point of view.
5000: # $owner - Proposed owner of the course.
5001: # $cdom - Domain of the course (from the institutions
5002: # point of view?)..
5003: # $client - Socket open on the client.
5004: #
5005: # Returns:
5006: # 1 - Processing should continue.
5007: #
5008: sub validate_course_owner_handler {
5009: my ($cmd, $tail, $client) = @_;
5010: my $userinput = "$cmd:$tail";
5011: my ($inst_course_id, $owner, $cdom) = split(/:/, $tail);
5012:
5013: $owner = &unescape($owner);
5014: my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
5015: &Reply($client, \$outcome, $userinput);
5016:
5017:
5018:
5019: return 1;
5020: }
5021: ®ister_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
5022:
5023: #
5024: # Validate a course section in the official schedule of classes
5025: # from the institutions point of view (part of autoenrollment).
5026: #
5027: # Formal Parameters:
5028: # $cmd - The command request that got us dispatched.
5029: # $tail - The tail of the command. In this case,
5030: # this is a colon separated set of words that will be split
5031: # into:
5032: # $inst_course_id - The course/section id from the
5033: # institutions point of view.
5034: # $cdom - The domain from the institutions
5035: # point of view.
5036: # $client - Socket open on the client.
5037: # Returns:
5038: # 1 - Indicating processing should continue.
5039: #
5040: sub validate_course_section_handler {
5041: my ($cmd, $tail, $client) = @_;
5042: my $userinput = "$cmd:$tail";
5043: my ($inst_course_id, $cdom) = split(/:/, $tail);
5044:
5045: my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
5046: &Reply($client, \$outcome, $userinput);
5047:
5048:
5049: return 1;
5050: }
5051: ®ister_handler("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
5052:
5053: #
5054: # Validate course owner's access to enrollment data for specific class section.
5055: #
5056: #
5057: # Formal Parameters:
5058: # $cmd - The command request that got us dispatched.
5059: # $tail - The tail of the command. In this case this is a colon separated
5060: # set of words that will be split into:
5061: # $inst_class - Institutional code for the specific class section
5062: # $courseowner - The escaped username:domain of the course owner
5063: # $cdom - The domain of the course from the institution's
5064: # point of view.
5065: # $client - The socket open on the client.
5066: # Returns:
5067: # 1 - continue processing.
5068: #
5069:
5070: sub validate_class_access_handler {
5071: my ($cmd, $tail, $client) = @_;
5072: my $userinput = "$cmd:$tail";
5073: my ($inst_class,$ownerlist,$cdom) = split(/:/, $tail);
5074: my $owners = &unescape($ownerlist);
5075: my $outcome;
5076: eval {
5077: local($SIG{__DIE__})='DEFAULT';
5078: $outcome=&localenroll::check_section($inst_class,$owners,$cdom);
5079: };
5080: &Reply($client,\$outcome, $userinput);
5081:
5082: return 1;
5083: }
5084: ®ister_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
5085:
5086: #
5087: # Create a password for a new LON-CAPA user added by auto-enrollment.
5088: # Only used for case where authentication method for new user is localauth
5089: #
5090: # Formal Parameters:
5091: # $cmd - The command request that got us dispatched.
5092: # $tail - The tail of the command. In this case this is a colon separated
5093: # set of words that will be split into:
5094: # $authparam - An authentication parameter (localauth parameter).
5095: # $cdom - The domain of the course from the institution's
5096: # point of view.
5097: # $client - The socket open on the client.
5098: # Returns:
5099: # 1 - continue processing.
5100: #
5101: sub create_auto_enroll_password_handler {
5102: my ($cmd, $tail, $client) = @_;
5103: my $userinput = "$cmd:$tail";
5104:
5105: my ($authparam, $cdom) = split(/:/, $userinput);
5106:
5107: my ($create_passwd,$authchk);
5108: ($authparam,
5109: $create_passwd,
5110: $authchk) = &localenroll::create_password($authparam,$cdom);
5111:
5112: &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
5113: $userinput);
5114:
5115:
5116: return 1;
5117: }
5118: ®ister_handler("autocreatepassword", \&create_auto_enroll_password_handler,
5119: 0, 1, 0);
5120:
5121: # Retrieve and remove temporary files created by/during autoenrollment.
5122: #
5123: # Formal Parameters:
5124: # $cmd - The command that got us dispatched.
5125: # $tail - The tail of the command. In our case this is a colon
5126: # separated list that will be split into:
5127: # $filename - The name of the file to remove.
5128: # The filename is given as a path relative to
5129: # the LonCAPA temp file directory.
5130: # $client - Socket open on the client.
5131: #
5132: # Returns:
5133: # 1 - Continue processing.
5134: sub retrieve_auto_file_handler {
5135: my ($cmd, $tail, $client) = @_;
5136: my $userinput = "cmd:$tail";
5137:
5138: my ($filename) = split(/:/, $tail);
5139:
5140: my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
5141: if ( (-e $source) && ($filename ne '') ) {
5142: my $reply = '';
5143: if (open(my $fh,$source)) {
5144: while (<$fh>) {
5145: chomp($_);
5146: $_ =~ s/^\s+//g;
5147: $_ =~ s/\s+$//g;
5148: $reply .= $_;
5149: }
5150: close($fh);
5151: &Reply($client, &escape($reply)."\n", $userinput);
5152:
5153: # Does this have to be uncommented??!? (RF).
5154: #
5155: # unlink($source);
5156: } else {
5157: &Failure($client, "error\n", $userinput);
5158: }
5159: } else {
5160: &Failure($client, "error\n", $userinput);
5161: }
5162:
5163:
5164: return 1;
5165: }
5166: ®ister_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
5167:
5168: sub crsreq_checks_handler {
5169: my ($cmd, $tail, $client) = @_;
5170: my $userinput = "$cmd:$tail";
5171: my $dom = $tail;
5172: my $result;
5173: my @reqtypes = ('official','unofficial','community');
5174: eval {
5175: local($SIG{__DIE__})='DEFAULT';
5176: my %validations;
5177: my $response = &localenroll::crsreq_checks($dom,\@reqtypes,
5178: \%validations);
5179: if ($response eq 'ok') {
5180: foreach my $key (keys(%validations)) {
5181: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($validations{$key}).'&';
5182: }
5183: $result =~ s/\&$//;
5184: } else {
5185: $result = 'error';
5186: }
5187: };
5188: if (!$@) {
5189: &Reply($client, \$result, $userinput);
5190: } else {
5191: &Failure($client,"unknown_cmd\n",$userinput);
5192: }
5193: return 1;
5194: }
5195: ®ister_handler("autocrsreqchecks", \&crsreq_checks_handler, 0, 1, 0);
5196:
5197: sub validate_crsreq_handler {
5198: my ($cmd, $tail, $client) = @_;
5199: my $userinput = "$cmd:$tail";
5200: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = split(/:/, $tail);
5201: $instcode = &unescape($instcode);
5202: $owner = &unescape($owner);
5203: $crstype = &unescape($crstype);
5204: $inststatuslist = &unescape($inststatuslist);
5205: $instcode = &unescape($instcode);
5206: $instseclist = &unescape($instseclist);
5207: my $outcome;
5208: eval {
5209: local($SIG{__DIE__})='DEFAULT';
5210: $outcome = &localenroll::validate_crsreq($dom,$owner,$crstype,
5211: $inststatuslist,$instcode,
5212: $instseclist);
5213: };
5214: if (!$@) {
5215: &Reply($client, \$outcome, $userinput);
5216: } else {
5217: &Failure($client,"unknown_cmd\n",$userinput);
5218: }
5219: return 1;
5220: }
5221: ®ister_handler("autocrsreqvalidation", \&validate_crsreq_handler, 0, 1, 0);
5222:
5223: #
5224: # Read and retrieve institutional code format (for support form).
5225: # Formal Parameters:
5226: # $cmd - Command that dispatched us.
5227: # $tail - Tail of the command. In this case it conatins
5228: # the course domain and the coursename.
5229: # $client - Socket open on the client.
5230: # Returns:
5231: # 1 - Continue processing.
5232: #
5233: sub get_institutional_code_format_handler {
5234: my ($cmd, $tail, $client) = @_;
5235: my $userinput = "$cmd:$tail";
5236:
5237: my $reply;
5238: my($cdom,$course) = split(/:/,$tail);
5239: my @pairs = split/\&/,$course;
5240: my %instcodes = ();
5241: my %codes = ();
5242: my @codetitles = ();
5243: my %cat_titles = ();
5244: my %cat_order = ();
5245: foreach (@pairs) {
5246: my ($key,$value) = split/=/,$_;
5247: $instcodes{&unescape($key)} = &unescape($value);
5248: }
5249: my $formatreply = &localenroll::instcode_format($cdom,
5250: \%instcodes,
5251: \%codes,
5252: \@codetitles,
5253: \%cat_titles,
5254: \%cat_order);
5255: if ($formatreply eq 'ok') {
5256: my $codes_str = &Apache::lonnet::hash2str(%codes);
5257: my $codetitles_str = &Apache::lonnet::array2str(@codetitles);
5258: my $cat_titles_str = &Apache::lonnet::hash2str(%cat_titles);
5259: my $cat_order_str = &Apache::lonnet::hash2str(%cat_order);
5260: &Reply($client,
5261: $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'
5262: .$cat_order_str."\n",
5263: $userinput);
5264: } else {
5265: # this else branch added by RF since if not ok, lonc will
5266: # hang waiting on reply until timeout.
5267: #
5268: &Reply($client, "format_error\n", $userinput);
5269: }
5270:
5271: return 1;
5272: }
5273: ®ister_handler("autoinstcodeformat",
5274: \&get_institutional_code_format_handler,0,1,0);
5275:
5276: sub get_institutional_defaults_handler {
5277: my ($cmd, $tail, $client) = @_;
5278: my $userinput = "$cmd:$tail";
5279:
5280: my $dom = $tail;
5281: my %defaults_hash;
5282: my @code_order;
5283: my $outcome;
5284: eval {
5285: local($SIG{__DIE__})='DEFAULT';
5286: $outcome = &localenroll::instcode_defaults($dom,\%defaults_hash,
5287: \@code_order);
5288: };
5289: if (!$@) {
5290: if ($outcome eq 'ok') {
5291: my $result='';
5292: while (my ($key,$value) = each(%defaults_hash)) {
5293: $result.=&escape($key).'='.&escape($value).'&';
5294: }
5295: $result .= 'code_order='.&escape(join('&',@code_order));
5296: &Reply($client,\$result,$userinput);
5297: } else {
5298: &Reply($client,"error\n", $userinput);
5299: }
5300: } else {
5301: &Failure($client,"unknown_cmd\n",$userinput);
5302: }
5303: }
5304: ®ister_handler("autoinstcodedefaults",
5305: \&get_institutional_defaults_handler,0,1,0);
5306:
5307: sub get_possible_instcodes_handler {
5308: my ($cmd, $tail, $client) = @_;
5309: my $userinput = "$cmd:$tail";
5310:
5311: my $reply;
5312: my $cdom = $tail;
5313: my (@codetitles,%cat_titles,%cat_order,@code_order);
5314: my $formatreply = &localenroll::possible_instcodes($cdom,
5315: \@codetitles,
5316: \%cat_titles,
5317: \%cat_order,
5318: \@code_order);
5319: if ($formatreply eq 'ok') {
5320: my $result = join('&',map {&escape($_);} (@codetitles)).':';
5321: $result .= join('&',map {&escape($_);} (@code_order)).':';
5322: foreach my $key (keys(%cat_titles)) {
5323: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_titles{$key}).'&';
5324: }
5325: $result =~ s/\&$//;
5326: $result .= ':';
5327: foreach my $key (keys(%cat_order)) {
5328: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_order{$key}).'&';
5329: }
5330: $result =~ s/\&$//;
5331: &Reply($client,\$result,$userinput);
5332: } else {
5333: &Reply($client, "format_error\n", $userinput);
5334: }
5335: return 1;
5336: }
5337: ®ister_handler("autopossibleinstcodes",
5338: \&get_possible_instcodes_handler,0,1,0);
5339:
5340: sub get_institutional_user_rules {
5341: my ($cmd, $tail, $client) = @_;
5342: my $userinput = "$cmd:$tail";
5343: my $dom = &unescape($tail);
5344: my (%rules_hash,@rules_order);
5345: my $outcome;
5346: eval {
5347: local($SIG{__DIE__})='DEFAULT';
5348: $outcome = &localenroll::username_rules($dom,\%rules_hash,\@rules_order);
5349: };
5350: if (!$@) {
5351: if ($outcome eq 'ok') {
5352: my $result;
5353: foreach my $key (keys(%rules_hash)) {
5354: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
5355: }
5356: $result =~ s/\&$//;
5357: $result .= ':';
5358: if (@rules_order > 0) {
5359: foreach my $item (@rules_order) {
5360: $result .= &escape($item).'&';
5361: }
5362: }
5363: $result =~ s/\&$//;
5364: &Reply($client,\$result,$userinput);
5365: } else {
5366: &Reply($client,"error\n", $userinput);
5367: }
5368: } else {
5369: &Failure($client,"unknown_cmd\n",$userinput);
5370: }
5371: }
5372: ®ister_handler("instuserrules",\&get_institutional_user_rules,0,1,0);
5373:
5374: sub get_institutional_id_rules {
5375: my ($cmd, $tail, $client) = @_;
5376: my $userinput = "$cmd:$tail";
5377: my $dom = &unescape($tail);
5378: my (%rules_hash,@rules_order);
5379: my $outcome;
5380: eval {
5381: local($SIG{__DIE__})='DEFAULT';
5382: $outcome = &localenroll::id_rules($dom,\%rules_hash,\@rules_order);
5383: };
5384: if (!$@) {
5385: if ($outcome eq 'ok') {
5386: my $result;
5387: foreach my $key (keys(%rules_hash)) {
5388: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
5389: }
5390: $result =~ s/\&$//;
5391: $result .= ':';
5392: if (@rules_order > 0) {
5393: foreach my $item (@rules_order) {
5394: $result .= &escape($item).'&';
5395: }
5396: }
5397: $result =~ s/\&$//;
5398: &Reply($client,\$result,$userinput);
5399: } else {
5400: &Reply($client,"error\n", $userinput);
5401: }
5402: } else {
5403: &Failure($client,"unknown_cmd\n",$userinput);
5404: }
5405: }
5406: ®ister_handler("instidrules",\&get_institutional_id_rules,0,1,0);
5407:
5408: sub get_institutional_selfcreate_rules {
5409: my ($cmd, $tail, $client) = @_;
5410: my $userinput = "$cmd:$tail";
5411: my $dom = &unescape($tail);
5412: my (%rules_hash,@rules_order);
5413: my $outcome;
5414: eval {
5415: local($SIG{__DIE__})='DEFAULT';
5416: $outcome = &localenroll::selfcreate_rules($dom,\%rules_hash,\@rules_order);
5417: };
5418: if (!$@) {
5419: if ($outcome eq 'ok') {
5420: my $result;
5421: foreach my $key (keys(%rules_hash)) {
5422: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
5423: }
5424: $result =~ s/\&$//;
5425: $result .= ':';
5426: if (@rules_order > 0) {
5427: foreach my $item (@rules_order) {
5428: $result .= &escape($item).'&';
5429: }
5430: }
5431: $result =~ s/\&$//;
5432: &Reply($client,\$result,$userinput);
5433: } else {
5434: &Reply($client,"error\n", $userinput);
5435: }
5436: } else {
5437: &Failure($client,"unknown_cmd\n",$userinput);
5438: }
5439: }
5440: ®ister_handler("instemailrules",\&get_institutional_selfcreate_rules,0,1,0);
5441:
5442:
5443: sub institutional_username_check {
5444: my ($cmd, $tail, $client) = @_;
5445: my $userinput = "$cmd:$tail";
5446: my %rulecheck;
5447: my $outcome;
5448: my ($udom,$uname,@rules) = split(/:/,$tail);
5449: $udom = &unescape($udom);
5450: $uname = &unescape($uname);
5451: @rules = map {&unescape($_);} (@rules);
5452: eval {
5453: local($SIG{__DIE__})='DEFAULT';
5454: $outcome = &localenroll::username_check($udom,$uname,\@rules,\%rulecheck);
5455: };
5456: if (!$@) {
5457: if ($outcome eq 'ok') {
5458: my $result='';
5459: foreach my $key (keys(%rulecheck)) {
5460: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
5461: }
5462: &Reply($client,\$result,$userinput);
5463: } else {
5464: &Reply($client,"error\n", $userinput);
5465: }
5466: } else {
5467: &Failure($client,"unknown_cmd\n",$userinput);
5468: }
5469: }
5470: ®ister_handler("instrulecheck",\&institutional_username_check,0,1,0);
5471:
5472: sub institutional_id_check {
5473: my ($cmd, $tail, $client) = @_;
5474: my $userinput = "$cmd:$tail";
5475: my %rulecheck;
5476: my $outcome;
5477: my ($udom,$id,@rules) = split(/:/,$tail);
5478: $udom = &unescape($udom);
5479: $id = &unescape($id);
5480: @rules = map {&unescape($_);} (@rules);
5481: eval {
5482: local($SIG{__DIE__})='DEFAULT';
5483: $outcome = &localenroll::id_check($udom,$id,\@rules,\%rulecheck);
5484: };
5485: if (!$@) {
5486: if ($outcome eq 'ok') {
5487: my $result='';
5488: foreach my $key (keys(%rulecheck)) {
5489: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
5490: }
5491: &Reply($client,\$result,$userinput);
5492: } else {
5493: &Reply($client,"error\n", $userinput);
5494: }
5495: } else {
5496: &Failure($client,"unknown_cmd\n",$userinput);
5497: }
5498: }
5499: ®ister_handler("instidrulecheck",\&institutional_id_check,0,1,0);
5500:
5501: sub institutional_selfcreate_check {
5502: my ($cmd, $tail, $client) = @_;
5503: my $userinput = "$cmd:$tail";
5504: my %rulecheck;
5505: my $outcome;
5506: my ($udom,$email,@rules) = split(/:/,$tail);
5507: $udom = &unescape($udom);
5508: $email = &unescape($email);
5509: @rules = map {&unescape($_);} (@rules);
5510: eval {
5511: local($SIG{__DIE__})='DEFAULT';
5512: $outcome = &localenroll::selfcreate_check($udom,$email,\@rules,\%rulecheck);
5513: };
5514: if (!$@) {
5515: if ($outcome eq 'ok') {
5516: my $result='';
5517: foreach my $key (keys(%rulecheck)) {
5518: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
5519: }
5520: &Reply($client,\$result,$userinput);
5521: } else {
5522: &Reply($client,"error\n", $userinput);
5523: }
5524: } else {
5525: &Failure($client,"unknown_cmd\n",$userinput);
5526: }
5527: }
5528: ®ister_handler("instselfcreatecheck",\&institutional_selfcreate_check,0,1,0);
5529:
5530: # Get domain specific conditions for import of student photographs to a course
5531: #
5532: # Retrieves information from photo_permission subroutine in localenroll.
5533: # Returns outcome (ok) if no processing errors, and whether course owner is
5534: # required to accept conditions of use (yes/no).
5535: #
5536: #
5537: sub photo_permission_handler {
5538: my ($cmd, $tail, $client) = @_;
5539: my $userinput = "$cmd:$tail";
5540: my $cdom = $tail;
5541: my ($perm_reqd,$conditions);
5542: my $outcome;
5543: eval {
5544: local($SIG{__DIE__})='DEFAULT';
5545: $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
5546: \$conditions);
5547: };
5548: if (!$@) {
5549: &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
5550: $userinput);
5551: } else {
5552: &Failure($client,"unknown_cmd\n",$userinput);
5553: }
5554: return 1;
5555: }
5556: ®ister_handler("autophotopermission",\&photo_permission_handler,0,1,0);
5557:
5558: #
5559: # Checks if student photo is available for a user in the domain, in the user's
5560: # directory (in /userfiles/internal/studentphoto.jpg).
5561: # Uses localstudentphoto:fetch() to ensure there is an up to date copy of
5562: # the student's photo.
5563:
5564: sub photo_check_handler {
5565: my ($cmd, $tail, $client) = @_;
5566: my $userinput = "$cmd:$tail";
5567: my ($udom,$uname,$pid) = split(/:/,$tail);
5568: $udom = &unescape($udom);
5569: $uname = &unescape($uname);
5570: $pid = &unescape($pid);
5571: my $path=&propath($udom,$uname).'/userfiles/internal/';
5572: if (!-e $path) {
5573: &mkpath($path);
5574: }
5575: my $response;
5576: my $result = &localstudentphoto::fetch($udom,$uname,$pid,\$response);
5577: $result .= ':'.$response;
5578: &Reply($client, &escape($result)."\n",$userinput);
5579: return 1;
5580: }
5581: ®ister_handler("autophotocheck",\&photo_check_handler,0,1,0);
5582:
5583: #
5584: # Retrieve information from localenroll about whether to provide a button
5585: # for users who have enbled import of student photos to initiate an
5586: # update of photo files for registered students. Also include
5587: # comment to display alongside button.
5588:
5589: sub photo_choice_handler {
5590: my ($cmd, $tail, $client) = @_;
5591: my $userinput = "$cmd:$tail";
5592: my $cdom = &unescape($tail);
5593: my ($update,$comment);
5594: eval {
5595: local($SIG{__DIE__})='DEFAULT';
5596: ($update,$comment) = &localenroll::manager_photo_update($cdom);
5597: };
5598: if (!$@) {
5599: &Reply($client,&escape($update).':'.&escape($comment)."\n",$userinput);
5600: } else {
5601: &Failure($client,"unknown_cmd\n",$userinput);
5602: }
5603: return 1;
5604: }
5605: ®ister_handler("autophotochoice",\&photo_choice_handler,0,1,0);
5606:
5607: #
5608: # Gets a student's photo to exist (in the correct image type) in the user's
5609: # directory.
5610: # Formal Parameters:
5611: # $cmd - The command request that got us dispatched.
5612: # $tail - A colon separated set of words that will be split into:
5613: # $domain - student's domain
5614: # $uname - student username
5615: # $type - image type desired
5616: # $client - The socket open on the client.
5617: # Returns:
5618: # 1 - continue processing.
5619:
5620: sub student_photo_handler {
5621: my ($cmd, $tail, $client) = @_;
5622: my ($domain,$uname,$ext,$type) = split(/:/, $tail);
5623:
5624: my $path=&propath($domain,$uname). '/userfiles/internal/';
5625: my $filename = 'studentphoto.'.$ext;
5626: if ($type eq 'thumbnail') {
5627: $filename = 'studentphoto_tn.'.$ext;
5628: }
5629: if (-e $path.$filename) {
5630: &Reply($client,"ok\n","$cmd:$tail");
5631: return 1;
5632: }
5633: &mkpath($path);
5634: my $file;
5635: if ($type eq 'thumbnail') {
5636: eval {
5637: local($SIG{__DIE__})='DEFAULT';
5638: $file=&localstudentphoto::fetch_thumbnail($domain,$uname);
5639: };
5640: } else {
5641: $file=&localstudentphoto::fetch($domain,$uname);
5642: }
5643: if (!$file) {
5644: &Failure($client,"unavailable\n","$cmd:$tail");
5645: return 1;
5646: }
5647: if (!-e $path.$filename) { &convert_photo($file,$path.$filename); }
5648: if (-e $path.$filename) {
5649: &Reply($client,"ok\n","$cmd:$tail");
5650: return 1;
5651: }
5652: &Failure($client,"unable_to_convert\n","$cmd:$tail");
5653: return 1;
5654: }
5655: ®ister_handler("studentphoto", \&student_photo_handler, 0, 1, 0);
5656:
5657: sub inst_usertypes_handler {
5658: my ($cmd, $domain, $client) = @_;
5659: my $res;
5660: my $userinput = $cmd.":".$domain; # For logging purposes.
5661: my (%typeshash,@order,$result);
5662: eval {
5663: local($SIG{__DIE__})='DEFAULT';
5664: $result=&localenroll::inst_usertypes($domain,\%typeshash,\@order);
5665: };
5666: if ($result eq 'ok') {
5667: if (keys(%typeshash) > 0) {
5668: foreach my $key (keys(%typeshash)) {
5669: $res.=&escape($key).'='.&escape($typeshash{$key}).'&';
5670: }
5671: }
5672: $res=~s/\&$//;
5673: $res .= ':';
5674: if (@order > 0) {
5675: foreach my $item (@order) {
5676: $res .= &escape($item).'&';
5677: }
5678: }
5679: $res=~s/\&$//;
5680: }
5681: &Reply($client, \$res, $userinput);
5682: return 1;
5683: }
5684: ®ister_handler("inst_usertypes", \&inst_usertypes_handler, 0, 1, 0);
5685:
5686: # mkpath makes all directories for a file, expects an absolute path with a
5687: # file or a trailing / if just a dir is passed
5688: # returns 1 on success 0 on failure
5689: sub mkpath {
5690: my ($file)=@_;
5691: my @parts=split(/\//,$file,-1);
5692: my $now=$parts[0].'/'.$parts[1].'/'.$parts[2];
5693: for (my $i=3;$i<= ($#parts-1);$i++) {
5694: $now.='/'.$parts[$i];
5695: if (!-e $now) {
5696: if (!mkdir($now,0770)) { return 0; }
5697: }
5698: }
5699: return 1;
5700: }
5701:
5702: #---------------------------------------------------------------
5703: #
5704: # Getting, decoding and dispatching requests:
5705: #
5706: #
5707: # Get a Request:
5708: # Gets a Request message from the client. The transaction
5709: # is defined as a 'line' of text. We remove the new line
5710: # from the text line.
5711: #
5712: sub get_request {
5713: my $input = <$client>;
5714: chomp($input);
5715:
5716: &Debug("get_request: Request = $input\n");
5717:
5718: &status('Processing '.$clientname.':'.$input);
5719:
5720: return $input;
5721: }
5722: #---------------------------------------------------------------
5723: #
5724: # Process a request. This sub should shrink as each action
5725: # gets farmed out into a separat sub that is registered
5726: # with the dispatch hash.
5727: #
5728: # Parameters:
5729: # user_input - The request received from the client (lonc).
5730: # Returns:
5731: # true to keep processing, false if caller should exit.
5732: #
5733: sub process_request {
5734: my ($userinput) = @_; # Easier for now to break style than to
5735: # fix all the userinput -> user_input.
5736: my $wasenc = 0; # True if request was encrypted.
5737: # ------------------------------------------------------------ See if encrypted
5738: # for command
5739: # sethost:<server>
5740: # <command>:<args>
5741: # we just send it to the processor
5742: # for
5743: # sethost:<server>:<command>:<args>
5744: # we do the implict set host and then do the command
5745: if ($userinput =~ /^sethost:/) {
5746: (my $cmd,my $newid,$userinput) = split(':',$userinput,3);
5747: if (defined($userinput)) {
5748: &sethost("$cmd:$newid");
5749: } else {
5750: $userinput = "$cmd:$newid";
5751: }
5752: }
5753:
5754: if ($userinput =~ /^enc/) {
5755: $userinput = decipher($userinput);
5756: $wasenc=1;
5757: if(!$userinput) { # Cipher not defined.
5758: &Failure($client, "error: Encrypted data without negotated key\n");
5759: return 0;
5760: }
5761: }
5762: Debug("process_request: $userinput\n");
5763:
5764: #
5765: # The 'correct way' to add a command to lond is now to
5766: # write a sub to execute it and Add it to the command dispatch
5767: # hash via a call to register_handler.. The comments to that
5768: # sub should give you enough to go on to show how to do this
5769: # along with the examples that are building up as this code
5770: # is getting refactored. Until all branches of the
5771: # if/elseif monster below have been factored out into
5772: # separate procesor subs, if the dispatch hash is missing
5773: # the command keyword, we will fall through to the remainder
5774: # of the if/else chain below in order to keep this thing in
5775: # working order throughout the transmogrification.
5776:
5777: my ($command, $tail) = split(/:/, $userinput, 2);
5778: chomp($command);
5779: chomp($tail);
5780: $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
5781: $command =~ s/(\r)//; # And this too for parameterless commands.
5782: if(!$tail) {
5783: $tail =""; # defined but blank.
5784: }
5785:
5786: &Debug("Command received: $command, encoded = $wasenc");
5787:
5788: if(defined $Dispatcher{$command}) {
5789:
5790: my $dispatch_info = $Dispatcher{$command};
5791: my $handler = $$dispatch_info[0];
5792: my $need_encode = $$dispatch_info[1];
5793: my $client_types = $$dispatch_info[2];
5794: Debug("Matched dispatch hash: mustencode: $need_encode "
5795: ."ClientType $client_types");
5796:
5797: # Validate the request:
5798:
5799: my $ok = 1;
5800: my $requesterprivs = 0;
5801: if(&isClient()) {
5802: $requesterprivs |= $CLIENT_OK;
5803: }
5804: if(&isManager()) {
5805: $requesterprivs |= $MANAGER_OK;
5806: }
5807: if($need_encode && (!$wasenc)) {
5808: Debug("Must encode but wasn't: $need_encode $wasenc");
5809: $ok = 0;
5810: }
5811: if(($client_types & $requesterprivs) == 0) {
5812: Debug("Client not privileged to do this operation");
5813: $ok = 0;
5814: }
5815:
5816: if($ok) {
5817: Debug("Dispatching to handler $command $tail");
5818: my $keep_going = &$handler($command, $tail, $client);
5819: return $keep_going;
5820: } else {
5821: Debug("Refusing to dispatch because client did not match requirements");
5822: Failure($client, "refused\n", $userinput);
5823: return 1;
5824: }
5825:
5826: }
5827:
5828: print $client "unknown_cmd\n";
5829: # -------------------------------------------------------------------- complete
5830: Debug("process_request - returning 1");
5831: return 1;
5832: }
5833: #
5834: # Decipher encoded traffic
5835: # Parameters:
5836: # input - Encoded data.
5837: # Returns:
5838: # Decoded data or undef if encryption key was not yet negotiated.
5839: # Implicit input:
5840: # cipher - This global holds the negotiated encryption key.
5841: #
5842: sub decipher {
5843: my ($input) = @_;
5844: my $output = '';
5845:
5846:
5847: if($cipher) {
5848: my($enc, $enclength, $encinput) = split(/:/, $input);
5849: for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
5850: $output .=
5851: $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
5852: }
5853: return substr($output, 0, $enclength);
5854: } else {
5855: return undef;
5856: }
5857: }
5858:
5859: #
5860: # Register a command processor. This function is invoked to register a sub
5861: # to process a request. Once registered, the ProcessRequest sub can automatically
5862: # dispatch requests to an appropriate sub, and do the top level validity checking
5863: # as well:
5864: # - Is the keyword recognized.
5865: # - Is the proper client type attempting the request.
5866: # - Is the request encrypted if it has to be.
5867: # Parameters:
5868: # $request_name - Name of the request being registered.
5869: # This is the command request that will match
5870: # against the hash keywords to lookup the information
5871: # associated with the dispatch information.
5872: # $procedure - Reference to a sub to call to process the request.
5873: # All subs get called as follows:
5874: # Procedure($cmd, $tail, $replyfd, $key)
5875: # $cmd - the actual keyword that invoked us.
5876: # $tail - the tail of the request that invoked us.
5877: # $replyfd- File descriptor connected to the client
5878: # $must_encode - True if the request must be encoded to be good.
5879: # $client_ok - True if it's ok for a client to request this.
5880: # $manager_ok - True if it's ok for a manager to request this.
5881: # Side effects:
5882: # - On success, the Dispatcher hash has an entry added for the key $RequestName
5883: # - On failure, the program will die as it's a bad internal bug to try to
5884: # register a duplicate command handler.
5885: #
5886: sub register_handler {
5887: my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
5888:
5889: # Don't allow duplication#
5890:
5891: if (defined $Dispatcher{$request_name}) {
5892: die "Attempting to define a duplicate request handler for $request_name\n";
5893: }
5894: # Build the client type mask:
5895:
5896: my $client_type_mask = 0;
5897: if($client_ok) {
5898: $client_type_mask |= $CLIENT_OK;
5899: }
5900: if($manager_ok) {
5901: $client_type_mask |= $MANAGER_OK;
5902: }
5903:
5904: # Enter the hash:
5905:
5906: my @entry = ($procedure, $must_encode, $client_type_mask);
5907:
5908: $Dispatcher{$request_name} = \@entry;
5909:
5910: }
5911:
5912:
5913: #------------------------------------------------------------------
5914:
5915:
5916:
5917:
5918: #
5919: # Convert an error return code from lcpasswd to a string value.
5920: #
5921: sub lcpasswdstrerror {
5922: my $ErrorCode = shift;
5923: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
5924: return "lcpasswd Unrecognized error return value ".$ErrorCode;
5925: } else {
5926: return $passwderrors[$ErrorCode];
5927: }
5928: }
5929:
5930: #
5931: # Convert an error return code from lcuseradd to a string value:
5932: #
5933: sub lcuseraddstrerror {
5934: my $ErrorCode = shift;
5935: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
5936: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
5937: } else {
5938: return $adderrors[$ErrorCode];
5939: }
5940: }
5941:
5942: # grabs exception and records it to log before exiting
5943: sub catchexception {
5944: my ($error)=@_;
5945: $SIG{'QUIT'}='DEFAULT';
5946: $SIG{__DIE__}='DEFAULT';
5947: &status("Catching exception");
5948: &logthis("<font color='red'>CRITICAL: "
5949: ."ABNORMAL EXIT. Child $$ for server ".$perlvar{'lonHostID'}." died through "
5950: ."a crash with this error msg->[$error]</font>");
5951: &logthis('Famous last words: '.$status.' - '.$lastlog);
5952: if ($client) { print $client "error: $error\n"; }
5953: $server->close();
5954: die($error);
5955: }
5956: sub timeout {
5957: &status("Handling Timeout");
5958: &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
5959: &catchexception('Timeout');
5960: }
5961: # -------------------------------- Set signal handlers to record abnormal exits
5962:
5963:
5964: $SIG{'QUIT'}=\&catchexception;
5965: $SIG{__DIE__}=\&catchexception;
5966:
5967: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
5968: &status("Read loncapa.conf and loncapa_apache.conf");
5969: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
5970: %perlvar=%{$perlvarref};
5971: undef $perlvarref;
5972:
5973: # ----------------------------- Make sure this process is running from user=www
5974: my $wwwid=getpwnam('www');
5975: if ($wwwid!=$<) {
5976: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
5977: my $subj="LON: $currenthostid User ID mismatch";
5978: system("echo 'User ID mismatch. lond must be run as user www.' |\
5979: mailto $emailto -s '$subj' > /dev/null");
5980: exit 1;
5981: }
5982:
5983: # --------------------------------------------- Check if other instance running
5984:
5985: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
5986:
5987: if (-e $pidfile) {
5988: my $lfh=IO::File->new("$pidfile");
5989: my $pide=<$lfh>;
5990: chomp($pide);
5991: if (kill 0 => $pide) { die "already running"; }
5992: }
5993:
5994: # ------------------------------------------------------------- Read hosts file
5995:
5996:
5997:
5998: # establish SERVER socket, bind and listen.
5999: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
6000: Type => SOCK_STREAM,
6001: Proto => 'tcp',
6002: Reuse => 1,
6003: Listen => 10 )
6004: or die "making socket: $@\n";
6005:
6006: # --------------------------------------------------------- Do global variables
6007:
6008: # global variables
6009:
6010: my %children = (); # keys are current child process IDs
6011:
6012: sub REAPER { # takes care of dead children
6013: $SIG{CHLD} = \&REAPER;
6014: &status("Handling child death");
6015: my $pid;
6016: do {
6017: $pid = waitpid(-1,&WNOHANG());
6018: if (defined($children{$pid})) {
6019: &logthis("Child $pid died");
6020: delete($children{$pid});
6021: } elsif ($pid > 0) {
6022: &logthis("Unknown Child $pid died");
6023: }
6024: } while ( $pid > 0 );
6025: foreach my $child (keys(%children)) {
6026: $pid = waitpid($child,&WNOHANG());
6027: if ($pid > 0) {
6028: &logthis("Child $child - $pid looks like we missed it's death");
6029: delete($children{$pid});
6030: }
6031: }
6032: &status("Finished Handling child death");
6033: }
6034:
6035: sub HUNTSMAN { # signal handler for SIGINT
6036: &status("Killing children (INT)");
6037: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
6038: kill 'INT' => keys %children;
6039: &logthis("Free socket: ".shutdown($server,2)); # free up socket
6040: my $execdir=$perlvar{'lonDaemons'};
6041: unlink("$execdir/logs/lond.pid");
6042: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
6043: &status("Done killing children");
6044: exit; # clean up with dignity
6045: }
6046:
6047: sub HUPSMAN { # signal handler for SIGHUP
6048: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
6049: &status("Killing children for restart (HUP)");
6050: kill 'INT' => keys %children;
6051: &logthis("Free socket: ".shutdown($server,2)); # free up socket
6052: &logthis("<font color='red'>CRITICAL: Restarting</font>");
6053: my $execdir=$perlvar{'lonDaemons'};
6054: unlink("$execdir/logs/lond.pid");
6055: &status("Restarting self (HUP)");
6056: exec("$execdir/lond"); # here we go again
6057: }
6058:
6059: #
6060: # Reload the Apache daemon's state.
6061: # This is done by invoking /home/httpd/perl/apachereload
6062: # a setuid perl script that can be root for us to do this job.
6063: #
6064: sub ReloadApache {
6065: my $execdir = $perlvar{'lonDaemons'};
6066: my $script = $execdir."/apachereload";
6067: system($script);
6068: }
6069:
6070: #
6071: # Called in response to a USR2 signal.
6072: # - Reread hosts.tab
6073: # - All children connected to hosts that were removed from hosts.tab
6074: # are killed via SIGINT
6075: # - All children connected to previously existing hosts are sent SIGUSR1
6076: # - Our internal hosts hash is updated to reflect the new contents of
6077: # hosts.tab causing connections from hosts added to hosts.tab to
6078: # now be honored.
6079: #
6080: sub UpdateHosts {
6081: &status("Reload hosts.tab");
6082: logthis('<font color="blue"> Updating connections </font>');
6083: #
6084: # The %children hash has the set of IP's we currently have children
6085: # on. These need to be matched against records in the hosts.tab
6086: # Any ip's no longer in the table get killed off they correspond to
6087: # either dropped or changed hosts. Note that the re-read of the table
6088: # will take care of new and changed hosts as connections come into being.
6089:
6090: &Apache::lonnet::reset_hosts_info();
6091:
6092: foreach my $child (keys(%children)) {
6093: my $childip = $children{$child};
6094: if ($childip ne '127.0.0.1'
6095: && !defined(&Apache::lonnet::get_hosts_from_ip($childip))) {
6096: logthis('<font color="blue"> UpdateHosts killing child '
6097: ." $child for ip $childip </font>");
6098: kill('INT', $child);
6099: } else {
6100: logthis('<font color="green"> keeping child for ip '
6101: ." $childip (pid=$child) </font>");
6102: }
6103: }
6104: ReloadApache;
6105: &status("Finished reloading hosts.tab");
6106: }
6107:
6108:
6109: sub checkchildren {
6110: &status("Checking on the children (sending signals)");
6111: &initnewstatus();
6112: &logstatus();
6113: &logthis('Going to check on the children');
6114: my $docdir=$perlvar{'lonDocRoot'};
6115: foreach (sort keys %children) {
6116: #sleep 1;
6117: unless (kill 'USR1' => $_) {
6118: &logthis ('Child '.$_.' is dead');
6119: &logstatus($$.' is dead');
6120: delete($children{$_});
6121: }
6122: }
6123: sleep 5;
6124: $SIG{ALRM} = sub { Debug("timeout");
6125: die "timeout"; };
6126: $SIG{__DIE__} = 'DEFAULT';
6127: &status("Checking on the children (waiting for reports)");
6128: foreach (sort keys %children) {
6129: unless (-e "$docdir/lon-status/londchld/$_.txt") {
6130: eval {
6131: alarm(300);
6132: &logthis('Child '.$_.' did not respond');
6133: kill 9 => $_;
6134: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
6135: #$subj="LON: $currenthostid killed lond process $_";
6136: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
6137: #$execdir=$perlvar{'lonDaemons'};
6138: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
6139: delete($children{$_});
6140: alarm(0);
6141: }
6142: }
6143: }
6144: $SIG{ALRM} = 'DEFAULT';
6145: $SIG{__DIE__} = \&catchexception;
6146: &status("Finished checking children");
6147: &logthis('Finished Checking children');
6148: }
6149:
6150: # --------------------------------------------------------------------- Logging
6151:
6152: sub logthis {
6153: my $message=shift;
6154: my $execdir=$perlvar{'lonDaemons'};
6155: my $fh=IO::File->new(">>$execdir/logs/lond.log");
6156: my $now=time;
6157: my $local=localtime($now);
6158: $lastlog=$local.': '.$message;
6159: print $fh "$local ($$): $message\n";
6160: }
6161:
6162: # ------------------------- Conditional log if $DEBUG true.
6163: sub Debug {
6164: my $message = shift;
6165: if($DEBUG) {
6166: &logthis($message);
6167: }
6168: }
6169:
6170: #
6171: # Sub to do replies to client.. this gives a hook for some
6172: # debug tracing too:
6173: # Parameters:
6174: # fd - File open on client.
6175: # reply - Text to send to client.
6176: # request - Original request from client.
6177: #
6178: sub Reply {
6179: my ($fd, $reply, $request) = @_;
6180: if (ref($reply)) {
6181: print $fd $$reply;
6182: print $fd "\n";
6183: if ($DEBUG) { Debug("Request was $request Reply was $$reply"); }
6184: } else {
6185: print $fd $reply;
6186: if ($DEBUG) { Debug("Request was $request Reply was $reply"); }
6187: }
6188: $Transactions++;
6189: }
6190:
6191:
6192: #
6193: # Sub to report a failure.
6194: # This function:
6195: # - Increments the failure statistic counters.
6196: # - Invokes Reply to send the error message to the client.
6197: # Parameters:
6198: # fd - File descriptor open on the client
6199: # reply - Reply text to emit.
6200: # request - The original request message (used by Reply
6201: # to debug if that's enabled.
6202: # Implicit outputs:
6203: # $Failures- The number of failures is incremented.
6204: # Reply (invoked here) sends a message to the
6205: # client:
6206: #
6207: sub Failure {
6208: my $fd = shift;
6209: my $reply = shift;
6210: my $request = shift;
6211:
6212: $Failures++;
6213: Reply($fd, $reply, $request); # That's simple eh?
6214: }
6215: # ------------------------------------------------------------------ Log status
6216:
6217: sub logstatus {
6218: &status("Doing logging");
6219: my $docdir=$perlvar{'lonDocRoot'};
6220: {
6221: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
6222: print $fh $status."\n".$lastlog."\n".time."\n$keymode";
6223: $fh->close();
6224: }
6225: &status("Finished $$.txt");
6226: {
6227: open(LOG,">>$docdir/lon-status/londstatus.txt");
6228: flock(LOG,LOCK_EX);
6229: print LOG $$."\t".$clientname."\t".$currenthostid."\t"
6230: .$status."\t".$lastlog."\t $keymode\n";
6231: flock(LOG,LOCK_UN);
6232: close(LOG);
6233: }
6234: &status("Finished logging");
6235: }
6236:
6237: sub initnewstatus {
6238: my $docdir=$perlvar{'lonDocRoot'};
6239: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
6240: my $now=time();
6241: my $local=localtime($now);
6242: print $fh "LOND status $local - parent $$\n\n";
6243: opendir(DIR,"$docdir/lon-status/londchld");
6244: while (my $filename=readdir(DIR)) {
6245: unlink("$docdir/lon-status/londchld/$filename");
6246: }
6247: closedir(DIR);
6248: }
6249:
6250: # -------------------------------------------------------------- Status setting
6251:
6252: sub status {
6253: my $what=shift;
6254: my $now=time;
6255: my $local=localtime($now);
6256: $status=$local.': '.$what;
6257: $0='lond: '.$what.' '.$local;
6258: }
6259:
6260: # -------------------------------------------------------------- Talk to lonsql
6261:
6262: sub sql_reply {
6263: my ($cmd)=@_;
6264: my $answer=&sub_sql_reply($cmd);
6265: if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
6266: return $answer;
6267: }
6268:
6269: sub sub_sql_reply {
6270: my ($cmd)=@_;
6271: my $unixsock="mysqlsock";
6272: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
6273: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
6274: Type => SOCK_STREAM,
6275: Timeout => 10)
6276: or return "con_lost";
6277: print $sclient "$cmd:$currentdomainid\n";
6278: my $answer=<$sclient>;
6279: chomp($answer);
6280: if (!$answer) { $answer="con_lost"; }
6281: return $answer;
6282: }
6283:
6284: # --------------------------------------- Is this the home server of an author?
6285:
6286: sub ishome {
6287: my $author=shift;
6288: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
6289: my ($udom,$uname)=split(/\//,$author);
6290: my $proname=propath($udom,$uname);
6291: if (-e $proname) {
6292: return 'owner';
6293: } else {
6294: return 'not_owner';
6295: }
6296: }
6297:
6298: # ======================================================= Continue main program
6299: # ---------------------------------------------------- Fork once and dissociate
6300:
6301: my $fpid=fork;
6302: exit if $fpid;
6303: die "Couldn't fork: $!" unless defined ($fpid);
6304:
6305: POSIX::setsid() or die "Can't start new session: $!";
6306:
6307: # ------------------------------------------------------- Write our PID on disk
6308:
6309: my $execdir=$perlvar{'lonDaemons'};
6310: open (PIDSAVE,">$execdir/logs/lond.pid");
6311: print PIDSAVE "$$\n";
6312: close(PIDSAVE);
6313: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
6314: &status('Starting');
6315:
6316:
6317:
6318: # ----------------------------------------------------- Install signal handlers
6319:
6320:
6321: $SIG{CHLD} = \&REAPER;
6322: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
6323: $SIG{HUP} = \&HUPSMAN;
6324: $SIG{USR1} = \&checkchildren;
6325: $SIG{USR2} = \&UpdateHosts;
6326:
6327: # Read the host hashes:
6328: &Apache::lonnet::load_hosts_tab();
6329: my %iphost = &Apache::lonnet::get_iphost(1);
6330:
6331: my $dist=`$perlvar{'lonDaemons'}/distprobe`;
6332:
6333: # --------------------------------------------------------------
6334: # Accept connections. When a connection comes in, it is validated
6335: # and if good, a child process is created to process transactions
6336: # along the connection.
6337:
6338: while (1) {
6339: &status('Starting accept');
6340: $client = $server->accept() or next;
6341: &status('Accepted '.$client.' off to spawn');
6342: make_new_child($client);
6343: &status('Finished spawning');
6344: }
6345:
6346: sub make_new_child {
6347: my $pid;
6348: # my $cipher; # Now global
6349: my $sigset;
6350:
6351: $client = shift;
6352: &status('Starting new child '.$client);
6353: &logthis('<font color="green"> Attempting to start child ('.$client.
6354: ")</font>");
6355: # block signal for fork
6356: $sigset = POSIX::SigSet->new(SIGINT);
6357: sigprocmask(SIG_BLOCK, $sigset)
6358: or die "Can't block SIGINT for fork: $!\n";
6359:
6360: die "fork: $!" unless defined ($pid = fork);
6361:
6362: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
6363: # connection liveness.
6364:
6365: #
6366: # Figure out who we're talking to so we can record the peer in
6367: # the pid hash.
6368: #
6369: my $caller = getpeername($client);
6370: my ($port,$iaddr);
6371: if (defined($caller) && length($caller) > 0) {
6372: ($port,$iaddr)=unpack_sockaddr_in($caller);
6373: } else {
6374: &logthis("Unable to determine who caller was, getpeername returned nothing");
6375: }
6376: if (defined($iaddr)) {
6377: $clientip = inet_ntoa($iaddr);
6378: Debug("Connected with $clientip");
6379: } else {
6380: &logthis("Unable to determine clientip");
6381: $clientip='Unavailable';
6382: }
6383:
6384: if ($pid) {
6385: # Parent records the child's birth and returns.
6386: sigprocmask(SIG_UNBLOCK, $sigset)
6387: or die "Can't unblock SIGINT for fork: $!\n";
6388: $children{$pid} = $clientip;
6389: &status('Started child '.$pid);
6390: close($client);
6391: return;
6392: } else {
6393: # Child can *not* return from this subroutine.
6394: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
6395: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
6396: #don't get intercepted
6397: $SIG{USR1}= \&logstatus;
6398: $SIG{ALRM}= \&timeout;
6399: $lastlog='Forked ';
6400: $status='Forked';
6401:
6402: # unblock signals
6403: sigprocmask(SIG_UNBLOCK, $sigset)
6404: or die "Can't unblock SIGINT for fork: $!\n";
6405:
6406: # my $tmpsnum=0; # Now global
6407: #---------------------------------------------------- kerberos 5 initialization
6408: &Authen::Krb5::init_context();
6409: unless (($dist eq 'fedora5') || ($dist eq 'fedora4') ||
6410: ($dist eq 'fedora6') || ($dist eq 'suse9.3')) {
6411: &Authen::Krb5::init_ets();
6412: }
6413:
6414: &status('Accepted connection');
6415: # =============================================================================
6416: # do something with the connection
6417: # -----------------------------------------------------------------------------
6418: # see if we know client and 'check' for spoof IP by ineffective challenge
6419:
6420: my $outsideip=$clientip;
6421: if ($clientip eq '127.0.0.1') {
6422: $outsideip=&Apache::lonnet::get_host_ip($perlvar{'lonHostID'});
6423: }
6424: &ReadManagerTable();
6425: my $clientrec=defined(&Apache::lonnet::get_hosts_from_ip($outsideip));
6426: my $ismanager=($managers{$outsideip} ne undef);
6427: $clientname = "[unknown]";
6428: if($clientrec) { # Establish client type.
6429: $ConnectionType = "client";
6430: $clientname = (&Apache::lonnet::get_hosts_from_ip($outsideip))[-1];
6431: if($ismanager) {
6432: $ConnectionType = "both";
6433: }
6434: } else {
6435: $ConnectionType = "manager";
6436: $clientname = $managers{$outsideip};
6437: }
6438: my $clientok;
6439:
6440: if ($clientrec || $ismanager) {
6441: &status("Waiting for init from $clientip $clientname");
6442: &logthis('<font color="yellow">INFO: Connection, '.
6443: $clientip.
6444: " ($clientname) connection type = $ConnectionType </font>" );
6445: &status("Connecting $clientip ($clientname))");
6446: my $remotereq=<$client>;
6447: chomp($remotereq);
6448: Debug("Got init: $remotereq");
6449:
6450: if ($remotereq =~ /^init/) {
6451: &sethost("sethost:$perlvar{'lonHostID'}");
6452: #
6453: # If the remote is attempting a local init... give that a try:
6454: #
6455: (my $i, my $inittype, $clientversion) = split(/:/, $remotereq);
6456:
6457: # If the connection type is ssl, but I didn't get my
6458: # certificate files yet, then I'll drop back to
6459: # insecure (if allowed).
6460:
6461: if($inittype eq "ssl") {
6462: my ($ca, $cert) = lonssl::CertificateFile;
6463: my $kfile = lonssl::KeyFile;
6464: if((!$ca) ||
6465: (!$cert) ||
6466: (!$kfile)) {
6467: $inittype = ""; # This forces insecure attempt.
6468: &logthis("<font color=\"blue\"> Certificates not "
6469: ."installed -- trying insecure auth</font>");
6470: } else { # SSL certificates are in place so
6471: } # Leave the inittype alone.
6472: }
6473:
6474: if($inittype eq "local") {
6475: $clientversion = $perlvar{'lonVersion'};
6476: my $key = LocalConnection($client, $remotereq);
6477: if($key) {
6478: Debug("Got local key $key");
6479: $clientok = 1;
6480: my $cipherkey = pack("H32", $key);
6481: $cipher = new IDEA($cipherkey);
6482: print $client "ok:local\n";
6483: &logthis('<font color="green">'
6484: . "Successful local authentication </font>");
6485: $keymode = "local"
6486: } else {
6487: Debug("Failed to get local key");
6488: $clientok = 0;
6489: shutdown($client, 3);
6490: close $client;
6491: }
6492: } elsif ($inittype eq "ssl") {
6493: my $key = SSLConnection($client);
6494: if ($key) {
6495: $clientok = 1;
6496: my $cipherkey = pack("H32", $key);
6497: $cipher = new IDEA($cipherkey);
6498: &logthis('<font color="green">'
6499: ."Successfull ssl authentication with $clientname </font>");
6500: $keymode = "ssl";
6501:
6502: } else {
6503: $clientok = 0;
6504: close $client;
6505: }
6506:
6507: } else {
6508: my $ok = InsecureConnection($client);
6509: if($ok) {
6510: $clientok = 1;
6511: &logthis('<font color="green">'
6512: ."Successful insecure authentication with $clientname </font>");
6513: print $client "ok\n";
6514: $keymode = "insecure";
6515: } else {
6516: &logthis('<font color="yellow">'
6517: ."Attempted insecure connection disallowed </font>");
6518: close $client;
6519: $clientok = 0;
6520:
6521: }
6522: }
6523: } else {
6524: &logthis(
6525: "<font color='blue'>WARNING: "
6526: ."$clientip failed to initialize: >$remotereq< </font>");
6527: &status('No init '.$clientip);
6528: }
6529:
6530: } else {
6531: &logthis(
6532: "<font color='blue'>WARNING: Unknown client $clientip</font>");
6533: &status('Hung up on '.$clientip);
6534: }
6535:
6536: if ($clientok) {
6537: # ---------------- New known client connecting, could mean machine online again
6538: if (&Apache::lonnet::get_host_ip($currenthostid) ne $clientip
6539: && $clientip ne '127.0.0.1') {
6540: &Apache::lonnet::reconlonc($clientname);
6541: }
6542: &logthis("<font color='green'>Established connection: $clientname</font>");
6543: &status('Will listen to '.$clientname);
6544: # ------------------------------------------------------------ Process requests
6545: my $keep_going = 1;
6546: my $user_input;
6547: my $clienthost = &Apache::lonnet::hostname($clientname);
6548: my $clientserverhomeID = &Apache::lonnet::get_server_homeID($clienthost);
6549: $clienthomedom = &Apache::lonnet::host_domain($clientserverhomeID);
6550: while(($user_input = get_request) && $keep_going) {
6551: alarm(120);
6552: Debug("Main: Got $user_input\n");
6553: $keep_going = &process_request($user_input);
6554: alarm(0);
6555: &status('Listening to '.$clientname." ($keymode)");
6556: }
6557:
6558: # --------------------------------------------- client unknown or fishy, refuse
6559: } else {
6560: print $client "refused\n";
6561: $client->close();
6562: &logthis("<font color='blue'>WARNING: "
6563: ."Rejected client $clientip, closing connection</font>");
6564: }
6565: }
6566:
6567: # =============================================================================
6568:
6569: &logthis("<font color='red'>CRITICAL: "
6570: ."Disconnect from $clientip ($clientname)</font>");
6571:
6572:
6573: # this exit is VERY important, otherwise the child will become
6574: # a producer of more and more children, forking yourself into
6575: # process death.
6576: exit;
6577:
6578: }
6579: #
6580: # Determine if a user is an author for the indicated domain.
6581: #
6582: # Parameters:
6583: # domain - domain to check in .
6584: # user - Name of user to check.
6585: #
6586: # Return:
6587: # 1 - User is an author for domain.
6588: # 0 - User is not an author for domain.
6589: sub is_author {
6590: my ($domain, $user) = @_;
6591:
6592: &Debug("is_author: $user @ $domain");
6593:
6594: my $hashref = &tie_user_hash($domain, $user, "roles",
6595: &GDBM_READER());
6596:
6597: # Author role should show up as a key /domain/_au
6598:
6599: my $key = "/$domain/_au";
6600: my $value;
6601: if (defined($hashref)) {
6602: $value = $hashref->{$key};
6603: }
6604:
6605: if(defined($value)) {
6606: &Debug("$user @ $domain is an author");
6607: }
6608:
6609: return defined($value);
6610: }
6611: #
6612: # Checks to see if the input roleput request was to set
6613: # an author role. If so, invokes the lchtmldir script to set
6614: # up a correct public_html
6615: # Parameters:
6616: # request - The request sent to the rolesput subchunk.
6617: # We're looking for /domain/_au
6618: # domain - The domain in which the user is having roles doctored.
6619: # user - Name of the user for which the role is being put.
6620: # authtype - The authentication type associated with the user.
6621: #
6622: sub manage_permissions {
6623: my ($request, $domain, $user, $authtype) = @_;
6624:
6625: &Debug("manage_permissions: $request $domain $user $authtype");
6626:
6627: # See if the request is of the form /$domain/_au
6628: if($request =~ /^(\/\Q$domain\E\/_au)$/) { # It's an author rolesput...
6629: my $execdir = $perlvar{'lonDaemons'};
6630: my $userhome= "/home/$user" ;
6631: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
6632: &Debug("Setting homedir permissions for $userhome");
6633: system("$execdir/lchtmldir $userhome $user $authtype");
6634: }
6635: }
6636:
6637:
6638: #
6639: # Return the full path of a user password file, whether it exists or not.
6640: # Parameters:
6641: # domain - Domain in which the password file lives.
6642: # user - name of the user.
6643: # Returns:
6644: # Full passwd path:
6645: #
6646: sub password_path {
6647: my ($domain, $user) = @_;
6648: return &propath($domain, $user).'/passwd';
6649: }
6650:
6651: # Password Filename
6652: # Returns the path to a passwd file given domain and user... only if
6653: # it exists.
6654: # Parameters:
6655: # domain - Domain in which to search.
6656: # user - username.
6657: # Returns:
6658: # - If the password file exists returns its path.
6659: # - If the password file does not exist, returns undefined.
6660: #
6661: sub password_filename {
6662: my ($domain, $user) = @_;
6663:
6664: Debug ("PasswordFilename called: dom = $domain user = $user");
6665:
6666: my $path = &password_path($domain, $user);
6667: Debug("PasswordFilename got path: $path");
6668: if(-e $path) {
6669: return $path;
6670: } else {
6671: return undef;
6672: }
6673: }
6674:
6675: #
6676: # Rewrite the contents of the user's passwd file.
6677: # Parameters:
6678: # domain - domain of the user.
6679: # name - User's name.
6680: # contents - New contents of the file.
6681: # Returns:
6682: # 0 - Failed.
6683: # 1 - Success.
6684: #
6685: sub rewrite_password_file {
6686: my ($domain, $user, $contents) = @_;
6687:
6688: my $file = &password_filename($domain, $user);
6689: if (defined $file) {
6690: my $pf = IO::File->new(">$file");
6691: if($pf) {
6692: print $pf "$contents\n";
6693: return 1;
6694: } else {
6695: return 0;
6696: }
6697: } else {
6698: return 0;
6699: }
6700:
6701: }
6702:
6703: #
6704: # get_auth_type - Determines the authorization type of a user in a domain.
6705:
6706: # Returns the authorization type or nouser if there is no such user.
6707: #
6708: sub get_auth_type {
6709: my ($domain, $user) = @_;
6710:
6711: Debug("get_auth_type( $domain, $user ) \n");
6712: my $proname = &propath($domain, $user);
6713: my $passwdfile = "$proname/passwd";
6714: if( -e $passwdfile ) {
6715: my $pf = IO::File->new($passwdfile);
6716: my $realpassword = <$pf>;
6717: chomp($realpassword);
6718: Debug("Password info = $realpassword\n");
6719: my ($authtype, $contentpwd) = split(/:/, $realpassword);
6720: Debug("Authtype = $authtype, content = $contentpwd\n");
6721: return "$authtype:$contentpwd";
6722: } else {
6723: Debug("Returning nouser");
6724: return "nouser";
6725: }
6726: }
6727:
6728: #
6729: # Validate a user given their domain, name and password. This utility
6730: # function is used by both AuthenticateHandler and ChangePasswordHandler
6731: # to validate the login credentials of a user.
6732: # Parameters:
6733: # $domain - The domain being logged into (this is required due to
6734: # the capability for multihomed systems.
6735: # $user - The name of the user being validated.
6736: # $password - The user's propoposed password.
6737: #
6738: # Returns:
6739: # 1 - The domain,user,pasword triplet corresponds to a valid
6740: # user.
6741: # 0 - The domain,user,password triplet is not a valid user.
6742: #
6743: sub validate_user {
6744: my ($domain, $user, $password, $checkdefauth) = @_;
6745:
6746: # Why negative ~pi you may well ask? Well this function is about
6747: # authentication, and therefore very important to get right.
6748: # I've initialized the flag that determines whether or not I've
6749: # validated correctly to a value it's not supposed to get.
6750: # At the end of this function. I'll ensure that it's not still that
6751: # value so we don't just wind up returning some accidental value
6752: # as a result of executing an unforseen code path that
6753: # did not set $validated. At the end of valid execution paths,
6754: # validated shoule be 1 for success or 0 for failuer.
6755:
6756: my $validated = -3.14159;
6757:
6758: # How we authenticate is determined by the type of authentication
6759: # the user has been assigned. If the authentication type is
6760: # "nouser", the user does not exist so we will return 0.
6761:
6762: my $contents = &get_auth_type($domain, $user);
6763: my ($howpwd, $contentpwd) = split(/:/, $contents);
6764:
6765: my $null = pack("C",0); # Used by kerberos auth types.
6766:
6767: if ($howpwd eq 'nouser') {
6768: if ($checkdefauth) {
6769: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
6770: if ($domdefaults{'auth_def'} eq 'localauth') {
6771: $howpwd = $domdefaults{'auth_def'};
6772: $contentpwd = $domdefaults{'auth_arg_def'};
6773: } elsif ((($domdefaults{'auth_def'} eq 'krb4') ||
6774: ($domdefaults{'auth_def'} eq 'krb5')) &&
6775: ($domdefaults{'auth_arg_def'} ne '')) {
6776: $howpwd = $domdefaults{'auth_def'};
6777: $contentpwd = $domdefaults{'auth_arg_def'};
6778: }
6779: }
6780: }
6781: if ($howpwd ne 'nouser') {
6782: if($howpwd eq "internal") { # Encrypted is in local password file.
6783: $validated = (crypt($password, $contentpwd) eq $contentpwd);
6784: }
6785: elsif ($howpwd eq "unix") { # User is a normal unix user.
6786: $contentpwd = (getpwnam($user))[1];
6787: if($contentpwd) {
6788: if($contentpwd eq 'x') { # Shadow password file...
6789: my $pwauth_path = "/usr/local/sbin/pwauth";
6790: open PWAUTH, "|$pwauth_path" or
6791: die "Cannot invoke authentication";
6792: print PWAUTH "$user\n$password\n";
6793: close PWAUTH;
6794: $validated = ! $?;
6795:
6796: } else { # Passwords in /etc/passwd.
6797: $validated = (crypt($password,
6798: $contentpwd) eq $contentpwd);
6799: }
6800: } else {
6801: $validated = 0;
6802: }
6803: } elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
6804: my $checkwithkrb5 = 0;
6805: if ($dist =~/^fedora(\d+)$/) {
6806: if ($1 > 11) {
6807: $checkwithkrb5 = 1;
6808: }
6809: } elsif ($dist =~ /^suse([\d.]+)$/) {
6810: if ($1 > 11.1) {
6811: $checkwithkrb5 = 1;
6812: }
6813: }
6814: if ($checkwithkrb5) {
6815: $validated = &krb5_authen($password,$null,$user,$contentpwd);
6816: } else {
6817: $validated = &krb4_authen($password,$null,$user,$contentpwd);
6818: }
6819: } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
6820: $validated = &krb5_authen($password,$null,$user,$contentpwd);
6821: } elsif ($howpwd eq "localauth") {
6822: # Authenticate via installation specific authentcation method:
6823: $validated = &localauth::localauth($user,
6824: $password,
6825: $contentpwd,
6826: $domain);
6827: if ($validated < 0) {
6828: &logthis("localauth for $contentpwd $user:$domain returned a $validated");
6829: $validated = 0;
6830: }
6831: } else { # Unrecognized auth is also bad.
6832: $validated = 0;
6833: }
6834: } else {
6835: $validated = 0;
6836: }
6837: #
6838: # $validated has the correct stat of the authentication:
6839: #
6840:
6841: unless ($validated != -3.14159) {
6842: # I >really really< want to know if this happens.
6843: # since it indicates that user authentication is badly
6844: # broken in some code path.
6845: #
6846: die "ValidateUser - failed to set the value of validated $domain, $user $password";
6847: }
6848: return $validated;
6849: }
6850:
6851: sub krb4_authen {
6852: my ($password,$null,$user,$contentpwd) = @_;
6853: my $validated = 0;
6854: if (!($password =~ /$null/) ) { # Null password not allowed.
6855: eval {
6856: require Authen::Krb4;
6857: };
6858: if (!$@) {
6859: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
6860: "",
6861: $contentpwd,,
6862: 'krbtgt',
6863: $contentpwd,
6864: 1,
6865: $password);
6866: if(!$k4error) {
6867: $validated = 1;
6868: } else {
6869: $validated = 0;
6870: &logthis('krb4: '.$user.', '.$contentpwd.', '.
6871: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
6872: }
6873: } else {
6874: $validated = krb5_authen($password,$null,$user,$contentpwd);
6875: }
6876: }
6877: return $validated;
6878: }
6879:
6880: sub krb5_authen {
6881: my ($password,$null,$user,$contentpwd) = @_;
6882: my $validated = 0;
6883: if(!($password =~ /$null/)) { # Null password not allowed.
6884: my $krbclient = &Authen::Krb5::parse_name($user.'@'
6885: .$contentpwd);
6886: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
6887: my $krbserver = &Authen::Krb5::parse_name($krbservice);
6888: my $credentials= &Authen::Krb5::cc_default();
6889: $credentials->initialize(&Authen::Krb5::parse_name($user.'@'
6890: .$contentpwd));
6891: my $krbreturn;
6892: if (exists(&Authen::Krb5::get_init_creds_password)) {
6893: $krbreturn =
6894: &Authen::Krb5::get_init_creds_password($krbclient,$password,
6895: $krbservice);
6896: $validated = (ref($krbreturn) eq 'Authen::Krb5::Creds');
6897: } else {
6898: $krbreturn =
6899: &Authen::Krb5::get_in_tkt_with_password($krbclient,$krbserver,
6900: $password,$credentials);
6901: $validated = ($krbreturn == 1);
6902: }
6903: if (!$validated) {
6904: &logthis('krb5: '.$user.', '.$contentpwd.', '.
6905: &Authen::Krb5::error());
6906: }
6907: }
6908: return $validated;
6909: }
6910:
6911: sub addline {
6912: my ($fname,$hostid,$ip,$newline)=@_;
6913: my $contents;
6914: my $found=0;
6915: my $expr='^'.quotemeta($hostid).':'.quotemeta($ip).':';
6916: my $sh;
6917: if ($sh=IO::File->new("$fname.subscription")) {
6918: while (my $subline=<$sh>) {
6919: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
6920: }
6921: $sh->close();
6922: }
6923: $sh=IO::File->new(">$fname.subscription");
6924: if ($contents) { print $sh $contents; }
6925: if ($newline) { print $sh $newline; }
6926: $sh->close();
6927: return $found;
6928: }
6929:
6930: sub get_chat {
6931: my ($cdom,$cname,$udom,$uname,$group)=@_;
6932:
6933: my @entries=();
6934: my $namespace = 'nohist_chatroom';
6935: my $namespace_inroom = 'nohist_inchatroom';
6936: if ($group ne '') {
6937: $namespace .= '_'.$group;
6938: $namespace_inroom .= '_'.$group;
6939: }
6940: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
6941: &GDBM_READER());
6942: if ($hashref) {
6943: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
6944: &untie_user_hash($hashref);
6945: }
6946: my @participants=();
6947: my $cutoff=time-60;
6948: $hashref = &tie_user_hash($cdom, $cname, $namespace_inroom,
6949: &GDBM_WRCREAT());
6950: if ($hashref) {
6951: $hashref->{$uname.':'.$udom}=time;
6952: foreach my $user (sort(keys(%$hashref))) {
6953: if ($hashref->{$user}>$cutoff) {
6954: push(@participants, 'active_participant:'.$user);
6955: }
6956: }
6957: &untie_user_hash($hashref);
6958: }
6959: return (@participants,@entries);
6960: }
6961:
6962: sub chat_add {
6963: my ($cdom,$cname,$newchat,$group)=@_;
6964: my @entries=();
6965: my $time=time;
6966: my $namespace = 'nohist_chatroom';
6967: my $logfile = 'chatroom.log';
6968: if ($group ne '') {
6969: $namespace .= '_'.$group;
6970: $logfile = 'chatroom_'.$group.'.log';
6971: }
6972: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
6973: &GDBM_WRCREAT());
6974: if ($hashref) {
6975: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
6976: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
6977: my ($thentime,$idnum)=split(/\_/,$lastid);
6978: my $newid=$time.'_000000';
6979: if ($thentime==$time) {
6980: $idnum=~s/^0+//;
6981: $idnum++;
6982: $idnum=substr('000000'.$idnum,-6,6);
6983: $newid=$time.'_'.$idnum;
6984: }
6985: $hashref->{$newid}=$newchat;
6986: my $expired=$time-3600;
6987: foreach my $comment (keys(%$hashref)) {
6988: my ($thistime) = ($comment=~/(\d+)\_/);
6989: if ($thistime<$expired) {
6990: delete $hashref->{$comment};
6991: }
6992: }
6993: {
6994: my $proname=&propath($cdom,$cname);
6995: if (open(CHATLOG,">>$proname/$logfile")) {
6996: print CHATLOG ("$time:".&unescape($newchat)."\n");
6997: }
6998: close(CHATLOG);
6999: }
7000: &untie_user_hash($hashref);
7001: }
7002: }
7003:
7004: sub unsub {
7005: my ($fname,$clientip)=@_;
7006: my $result;
7007: my $unsubs = 0; # Number of successful unsubscribes:
7008:
7009:
7010: # An old way subscriptions were handled was to have a
7011: # subscription marker file:
7012:
7013: Debug("Attempting unlink of $fname.$clientname");
7014: if (unlink("$fname.$clientname")) {
7015: $unsubs++; # Successful unsub via marker file.
7016: }
7017:
7018: # The more modern way to do it is to have a subscription list
7019: # file:
7020:
7021: if (-e "$fname.subscription") {
7022: my $found=&addline($fname,$clientname,$clientip,'');
7023: if ($found) {
7024: $unsubs++;
7025: }
7026: }
7027:
7028: # If either or both of these mechanisms succeeded in unsubscribing a
7029: # resource we can return ok:
7030:
7031: if($unsubs) {
7032: $result = "ok\n";
7033: } else {
7034: $result = "not_subscribed\n";
7035: }
7036:
7037: return $result;
7038: }
7039:
7040: sub currentversion {
7041: my $fname=shift;
7042: my $version=-1;
7043: my $ulsdir='';
7044: if ($fname=~/^(.+)\/[^\/]+$/) {
7045: $ulsdir=$1;
7046: }
7047: my ($fnamere1,$fnamere2);
7048: # remove version if already specified
7049: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
7050: # get the bits that go before and after the version number
7051: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
7052: $fnamere1=$1;
7053: $fnamere2='.'.$2;
7054: }
7055: if (-e $fname) { $version=1; }
7056: if (-e $ulsdir) {
7057: if(-d $ulsdir) {
7058: if (opendir(LSDIR,$ulsdir)) {
7059: my $ulsfn;
7060: while ($ulsfn=readdir(LSDIR)) {
7061: # see if this is a regular file (ignore links produced earlier)
7062: my $thisfile=$ulsdir.'/'.$ulsfn;
7063: unless (-l $thisfile) {
7064: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
7065: if ($1>$version) { $version=$1; }
7066: }
7067: }
7068: }
7069: closedir(LSDIR);
7070: $version++;
7071: }
7072: }
7073: }
7074: return $version;
7075: }
7076:
7077: sub thisversion {
7078: my $fname=shift;
7079: my $version=-1;
7080: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
7081: $version=$1;
7082: }
7083: return $version;
7084: }
7085:
7086: sub subscribe {
7087: my ($userinput,$clientip)=@_;
7088: my $result;
7089: my ($cmd,$fname)=split(/:/,$userinput,2);
7090: my $ownership=&ishome($fname);
7091: if ($ownership eq 'owner') {
7092: # explitly asking for the current version?
7093: unless (-e $fname) {
7094: my $currentversion=¤tversion($fname);
7095: if (&thisversion($fname)==$currentversion) {
7096: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
7097: my $root=$1;
7098: my $extension=$2;
7099: symlink($root.'.'.$extension,
7100: $root.'.'.$currentversion.'.'.$extension);
7101: unless ($extension=~/\.meta$/) {
7102: symlink($root.'.'.$extension.'.meta',
7103: $root.'.'.$currentversion.'.'.$extension.'.meta');
7104: }
7105: }
7106: }
7107: }
7108: if (-e $fname) {
7109: if (-d $fname) {
7110: $result="directory\n";
7111: } else {
7112: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
7113: my $now=time;
7114: my $found=&addline($fname,$clientname,$clientip,
7115: "$clientname:$clientip:$now\n");
7116: if ($found) { $result="$fname\n"; }
7117: # if they were subscribed to only meta data, delete that
7118: # subscription, when you subscribe to a file you also get
7119: # the metadata
7120: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
7121: $fname=~s/\/home\/httpd\/html\/res/raw/;
7122: $fname="http://".&Apache::lonnet::hostname($perlvar{'lonHostID'})."/".$fname;
7123: $result="$fname\n";
7124: }
7125: } else {
7126: $result="not_found\n";
7127: }
7128: } else {
7129: $result="rejected\n";
7130: }
7131: return $result;
7132: }
7133: # Change the passwd of a unix user. The caller must have
7134: # first verified that the user is a loncapa user.
7135: #
7136: # Parameters:
7137: # user - Unix user name to change.
7138: # pass - New password for the user.
7139: # Returns:
7140: # ok - if success
7141: # other - Some meaningfule error message string.
7142: # NOTE:
7143: # invokes a setuid script to change the passwd.
7144: sub change_unix_password {
7145: my ($user, $pass) = @_;
7146:
7147: &Debug("change_unix_password");
7148: my $execdir=$perlvar{'lonDaemons'};
7149: &Debug("Opening lcpasswd pipeline");
7150: my $pf = IO::File->new("|$execdir/lcpasswd > "
7151: ."$perlvar{'lonDaemons'}"
7152: ."/logs/lcpasswd.log");
7153: print $pf "$user\n$pass\n$pass\n";
7154: close $pf;
7155: my $err = $?;
7156: return ($err < @passwderrors) ? $passwderrors[$err] :
7157: "pwchange_falure - unknown error";
7158:
7159:
7160: }
7161:
7162:
7163: sub make_passwd_file {
7164: my ($uname, $umode,$npass,$passfilename)=@_;
7165: my $result="ok";
7166: if ($umode eq 'krb4' or $umode eq 'krb5') {
7167: {
7168: my $pf = IO::File->new(">$passfilename");
7169: if ($pf) {
7170: print $pf "$umode:$npass\n";
7171: } else {
7172: $result = "pass_file_failed_error";
7173: }
7174: }
7175: } elsif ($umode eq 'internal') {
7176: my $salt=time;
7177: $salt=substr($salt,6,2);
7178: my $ncpass=crypt($npass,$salt);
7179: {
7180: &Debug("Creating internal auth");
7181: my $pf = IO::File->new(">$passfilename");
7182: if($pf) {
7183: print $pf "internal:$ncpass\n";
7184: } else {
7185: $result = "pass_file_failed_error";
7186: }
7187: }
7188: } elsif ($umode eq 'localauth') {
7189: {
7190: my $pf = IO::File->new(">$passfilename");
7191: if($pf) {
7192: print $pf "localauth:$npass\n";
7193: } else {
7194: $result = "pass_file_failed_error";
7195: }
7196: }
7197: } elsif ($umode eq 'unix') {
7198: {
7199: #
7200: # Don't allow the creation of privileged accounts!!! that would
7201: # be real bad!!!
7202: #
7203: my $uid = getpwnam($uname);
7204: if((defined $uid) && ($uid == 0)) {
7205: &logthis(">>>Attempted to create privilged account blocked");
7206: return "no_priv_account_error\n";
7207: }
7208:
7209: my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
7210:
7211: my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
7212: {
7213: &Debug("Executing external: ".$execpath);
7214: &Debug("user = ".$uname.", Password =". $npass);
7215: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
7216: print $se "$uname\n";
7217: print $se "$npass\n";
7218: print $se "$npass\n";
7219: print $se "$lc_error_file\n"; # Status -> unique file.
7220: }
7221: if (-r $lc_error_file) {
7222: &Debug("Opening error file: $lc_error_file");
7223: my $error = IO::File->new("< $lc_error_file");
7224: my $useraddok = <$error>;
7225: $error->close;
7226: unlink($lc_error_file);
7227:
7228: chomp $useraddok;
7229:
7230: if($useraddok > 0) {
7231: my $error_text = &lcuseraddstrerror($useraddok);
7232: &logthis("Failed lcuseradd: $error_text");
7233: $result = "lcuseradd_failed:$error_text";
7234: } else {
7235: my $pf = IO::File->new(">$passfilename");
7236: if($pf) {
7237: print $pf "unix:\n";
7238: } else {
7239: $result = "pass_file_failed_error";
7240: }
7241: }
7242: } else {
7243: &Debug("Could not locate lcuseradd error: $lc_error_file");
7244: $result="bug_lcuseradd_no_output_file";
7245: }
7246: }
7247: } elsif ($umode eq 'none') {
7248: {
7249: my $pf = IO::File->new("> $passfilename");
7250: if($pf) {
7251: print $pf "none:\n";
7252: } else {
7253: $result = "pass_file_failed_error";
7254: }
7255: }
7256: } else {
7257: $result="auth_mode_error";
7258: }
7259: return $result;
7260: }
7261:
7262: sub convert_photo {
7263: my ($start,$dest)=@_;
7264: system("convert $start $dest");
7265: }
7266:
7267: sub sethost {
7268: my ($remotereq) = @_;
7269: my (undef,$hostid)=split(/:/,$remotereq);
7270: # ignore sethost if we are already correct
7271: if ($hostid eq $currenthostid) {
7272: return 'ok';
7273: }
7274:
7275: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
7276: if (&Apache::lonnet::get_host_ip($perlvar{'lonHostID'})
7277: eq &Apache::lonnet::get_host_ip($hostid)) {
7278: $currenthostid =$hostid;
7279: $currentdomainid=&Apache::lonnet::host_domain($hostid);
7280: # &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
7281: } else {
7282: &logthis("Requested host id $hostid not an alias of ".
7283: $perlvar{'lonHostID'}." refusing connection");
7284: return 'unable_to_set';
7285: }
7286: return 'ok';
7287: }
7288:
7289: sub version {
7290: my ($userinput)=@_;
7291: $remoteVERSION=(split(/:/,$userinput))[1];
7292: return "version:$VERSION";
7293: }
7294:
7295: sub get_usersession_config {
7296: my ($dom,$name) = @_;
7297: my ($usersessionconf,$cached)=&Apache::lonnet::is_cached_new($name,$dom);
7298: if (defined($cached)) {
7299: return $usersessionconf;
7300: } else {
7301: my %domconfig = &Apache::lonnet::get_dom('configuration',['usersessions'],$dom);
7302: if (ref($domconfig{'usersessions'}) eq 'HASH') {
7303: &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'usersessions'},3600);
7304: return $domconfig{'usersessions'};
7305: }
7306: }
7307: return;
7308: }
7309:
7310: sub releasereqd_check {
7311: my ($cnum,$cdom,$key,$value,$major,$minor,$homecourses,$ids) = @_;
7312: my $home = &Apache::lonnet::homeserver($cnum,$cdom);
7313: return if ($home eq 'no_host');
7314: my ($reqdmajor,$reqdminor,$displayrole);
7315: if ($cnum =~ /$LONCAPA::match_community/) {
7316: if ($major eq '' && $minor eq '') {
7317: return unless ((ref($ids) eq 'ARRAY') &&
7318: (grep(/^\Q$home\E$/,@{$ids})));
7319: } else {
7320: $reqdmajor = 2;
7321: $reqdminor = 9;
7322: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
7323: }
7324: }
7325: my $hashid = $cdom.':'.$cnum;
7326: my ($courseinfo,$cached) =
7327: &Apache::lonnet::is_cached_new('courseinfo',$hashid);
7328: if (defined($cached)) {
7329: if (ref($courseinfo) eq 'HASH') {
7330: if (exists($courseinfo->{'releaserequired'})) {
7331: my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
7332: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
7333: }
7334: }
7335: } else {
7336: if (ref($ids) eq 'ARRAY') {
7337: if (grep(/^\Q$home\E$/,@{$ids})) {
7338: if (ref($homecourses) eq 'HASH') {
7339: if (ref($homecourses->{$hashid}) eq 'ARRAY') {
7340: push(@{$homecourses->{$hashid}},{$key=>$value});
7341: } else {
7342: $homecourses->{$hashid} = [{$key=>$value}];
7343: }
7344: }
7345: return;
7346: }
7347: }
7348: my $courseinfo = &get_courseinfo_hash($cnum,$cdom,$home);
7349: if (ref($courseinfo) eq 'HASH') {
7350: if (exists($courseinfo->{'releaserequired'})) {
7351: my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
7352: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
7353: }
7354: } else {
7355: return;
7356: }
7357: }
7358: return 1;
7359: }
7360:
7361: sub get_courseinfo_hash {
7362: my ($cnum,$cdom,$home) = @_;
7363: my %info;
7364: eval {
7365: local($SIG{ALRM}) = sub { die "timeout\n"; };
7366: local($SIG{__DIE__})='DEFAULT';
7367: alarm(3);
7368: %info = &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,1,[$home],'.');
7369: alarm(0);
7370: };
7371: if ($@) {
7372: if ($@ eq "timeout\n") {
7373: &logthis("<font color='blue'>WARNING courseiddump for $cnum:$cdom from $home timedout</font>");
7374: } else {
7375: &logthis("<font color='yellow'>WARNING unexpected error during eval of call for courseiddump from $home</font>");
7376: }
7377: } else {
7378: if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
7379: my $hashid = $cdom.':'.$cnum;
7380: return &Apache::lonnet::do_cache_new('courseinfo',$hashid,$info{$cdom.'_'.$cnum},600);
7381: }
7382: }
7383: return;
7384: }
7385:
7386: sub check_homecourses {
7387: my ($homecourses,$udom,$regexp,$count,$range,$start,$end,$major,$minor) = @_;
7388: my ($result,%addtocache);
7389: my $yesterday = time - 24*3600;
7390: if (ref($homecourses) eq 'HASH') {
7391: my (%okcourses,%courseinfo,%recent);
7392: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
7393: if ($hashref) {
7394: while (my ($key,$value) = each(%$hashref)) {
7395: my $unesc_key = &unescape($key);
7396: if ($unesc_key =~ /^lasttime:(\w+)$/) {
7397: my $cid = $1;
7398: $cid =~ s/_/:/;
7399: if ($value > $yesterday ) {
7400: $recent{$cid} = 1;
7401: }
7402: next;
7403: }
7404: my $items = &Apache::lonnet::thaw_unescape($value);
7405: if (ref($items) eq 'HASH') {
7406: my $hashid = $unesc_key;
7407: $hashid =~ s/_/:/;
7408: $courseinfo{$hashid} = $items;
7409: if (ref($homecourses->{$hashid}) eq 'ARRAY') {
7410: my ($reqdmajor,$reqdminor) = split(/\./,$items->{'releaserequired'});
7411: if (&useable_role($reqdmajor,$reqdminor,$major,$minor)) {
7412: $okcourses{$hashid} = 1;
7413: }
7414: }
7415: }
7416: }
7417: unless (&untie_domain_hash($hashref)) {
7418: &logthis('Failed to untie tied hash for nohist_courseids.db');
7419: }
7420: } else {
7421: &logthis('Failed to tie hash for nohist_courseids.db');
7422: return;
7423: }
7424: foreach my $hashid (keys(%recent)) {
7425: my ($result,$cached)=&Apache::lonnet::is_cached_new('courseinfo',$hashid);
7426: unless ($cached) {
7427: &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
7428: }
7429: }
7430: foreach my $hashid (keys(%{$homecourses})) {
7431: next if ($recent{$hashid});
7432: &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
7433: }
7434: foreach my $hashid (keys(%okcourses)) {
7435: if (ref($homecourses->{$hashid}) eq 'ARRAY') {
7436: foreach my $role (@{$homecourses->{$hashid}}) {
7437: if (ref($role) eq 'HASH') {
7438: while (my ($key,$value) = each(%{$role})) {
7439: if ($regexp eq '.') {
7440: $count++;
7441: if (defined($range) && $count >= $end) { last; }
7442: if (defined($range) && $count < $start) { next; }
7443: $result.=$key.'='.$value.'&';
7444: } else {
7445: my $unescapeKey = &unescape($key);
7446: if (eval('$unescapeKey=~/$regexp/')) {
7447: $count++;
7448: if (defined($range) && $count >= $end) { last; }
7449: if (defined($range) && $count < $start) { next; }
7450: $result.="$key=$value&";
7451: }
7452: }
7453: }
7454: }
7455: }
7456: }
7457: }
7458: }
7459: return $result;
7460: }
7461:
7462: sub useable_role {
7463: my ($reqdmajor,$reqdminor,$major,$minor) = @_;
7464: if ($reqdmajor ne '' && $reqdminor ne '') {
7465: return if (($major eq '' && $minor eq '') ||
7466: ($major < $reqdmajor) ||
7467: (($major == $reqdmajor) && ($minor < $reqdminor)));
7468: }
7469: return 1;
7470: }
7471:
7472: # ----------------------------------- POD (plain old documentation, CPAN style)
7473:
7474: =head1 NAME
7475:
7476: lond - "LON Daemon" Server (port "LOND" 5663)
7477:
7478: =head1 SYNOPSIS
7479:
7480: Usage: B<lond>
7481:
7482: Should only be run as user=www. This is a command-line script which
7483: is invoked by B<loncron>. There is no expectation that a typical user
7484: will manually start B<lond> from the command-line. (In other words,
7485: DO NOT START B<lond> YOURSELF.)
7486:
7487: =head1 DESCRIPTION
7488:
7489: There are two characteristics associated with the running of B<lond>,
7490: PROCESS MANAGEMENT (starting, stopping, handling child processes)
7491: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
7492: subscriptions, etc). These are described in two large
7493: sections below.
7494:
7495: B<PROCESS MANAGEMENT>
7496:
7497: Preforker - server who forks first. Runs as a daemon. HUPs.
7498: Uses IDEA encryption
7499:
7500: B<lond> forks off children processes that correspond to the other servers
7501: in the network. Management of these processes can be done at the
7502: parent process level or the child process level.
7503:
7504: B<logs/lond.log> is the location of log messages.
7505:
7506: The process management is now explained in terms of linux shell commands,
7507: subroutines internal to this code, and signal assignments:
7508:
7509: =over 4
7510:
7511: =item *
7512:
7513: PID is stored in B<logs/lond.pid>
7514:
7515: This is the process id number of the parent B<lond> process.
7516:
7517: =item *
7518:
7519: SIGTERM and SIGINT
7520:
7521: Parent signal assignment:
7522: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
7523:
7524: Child signal assignment:
7525: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
7526: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
7527: to restart a new child.)
7528:
7529: Command-line invocations:
7530: B<kill> B<-s> SIGTERM I<PID>
7531: B<kill> B<-s> SIGINT I<PID>
7532:
7533: Subroutine B<HUNTSMAN>:
7534: This is only invoked for the B<lond> parent I<PID>.
7535: This kills all the children, and then the parent.
7536: The B<lonc.pid> file is cleared.
7537:
7538: =item *
7539:
7540: SIGHUP
7541:
7542: Current bug:
7543: This signal can only be processed the first time
7544: on the parent process. Subsequent SIGHUP signals
7545: have no effect.
7546:
7547: Parent signal assignment:
7548: $SIG{HUP} = \&HUPSMAN;
7549:
7550: Child signal assignment:
7551: none (nothing happens)
7552:
7553: Command-line invocations:
7554: B<kill> B<-s> SIGHUP I<PID>
7555:
7556: Subroutine B<HUPSMAN>:
7557: This is only invoked for the B<lond> parent I<PID>,
7558: This kills all the children, and then the parent.
7559: The B<lond.pid> file is cleared.
7560:
7561: =item *
7562:
7563: SIGUSR1
7564:
7565: Parent signal assignment:
7566: $SIG{USR1} = \&USRMAN;
7567:
7568: Child signal assignment:
7569: $SIG{USR1}= \&logstatus;
7570:
7571: Command-line invocations:
7572: B<kill> B<-s> SIGUSR1 I<PID>
7573:
7574: Subroutine B<USRMAN>:
7575: When invoked for the B<lond> parent I<PID>,
7576: SIGUSR1 is sent to all the children, and the status of
7577: each connection is logged.
7578:
7579: =item *
7580:
7581: SIGUSR2
7582:
7583: Parent Signal assignment:
7584: $SIG{USR2} = \&UpdateHosts
7585:
7586: Child signal assignment:
7587: NONE
7588:
7589:
7590: =item *
7591:
7592: SIGCHLD
7593:
7594: Parent signal assignment:
7595: $SIG{CHLD} = \&REAPER;
7596:
7597: Child signal assignment:
7598: none
7599:
7600: Command-line invocations:
7601: B<kill> B<-s> SIGCHLD I<PID>
7602:
7603: Subroutine B<REAPER>:
7604: This is only invoked for the B<lond> parent I<PID>.
7605: Information pertaining to the child is removed.
7606: The socket port is cleaned up.
7607:
7608: =back
7609:
7610: B<SERVER-SIDE ACTIVITIES>
7611:
7612: Server-side information can be accepted in an encrypted or non-encrypted
7613: method.
7614:
7615: =over 4
7616:
7617: =item ping
7618:
7619: Query a client in the hosts.tab table; "Are you there?"
7620:
7621: =item pong
7622:
7623: Respond to a ping query.
7624:
7625: =item ekey
7626:
7627: Read in encrypted key, make cipher. Respond with a buildkey.
7628:
7629: =item load
7630:
7631: Respond with CPU load based on a computation upon /proc/loadavg.
7632:
7633: =item currentauth
7634:
7635: Reply with current authentication information (only over an
7636: encrypted channel).
7637:
7638: =item auth
7639:
7640: Only over an encrypted channel, reply as to whether a user's
7641: authentication information can be validated.
7642:
7643: =item passwd
7644:
7645: Allow for a password to be set.
7646:
7647: =item makeuser
7648:
7649: Make a user.
7650:
7651: =item passwd
7652:
7653: Allow for authentication mechanism and password to be changed.
7654:
7655: =item home
7656:
7657: Respond to a question "are you the home for a given user?"
7658:
7659: =item update
7660:
7661: Update contents of a subscribed resource.
7662:
7663: =item unsubscribe
7664:
7665: The server is unsubscribing from a resource.
7666:
7667: =item subscribe
7668:
7669: The server is subscribing to a resource.
7670:
7671: =item log
7672:
7673: Place in B<logs/lond.log>
7674:
7675: =item put
7676:
7677: stores hash in namespace
7678:
7679: =item rolesputy
7680:
7681: put a role into a user's environment
7682:
7683: =item get
7684:
7685: returns hash with keys from array
7686: reference filled in from namespace
7687:
7688: =item eget
7689:
7690: returns hash with keys from array
7691: reference filled in from namesp (encrypts the return communication)
7692:
7693: =item rolesget
7694:
7695: get a role from a user's environment
7696:
7697: =item del
7698:
7699: deletes keys out of array from namespace
7700:
7701: =item keys
7702:
7703: returns namespace keys
7704:
7705: =item dump
7706:
7707: dumps the complete (or key matching regexp) namespace into a hash
7708:
7709: =item store
7710:
7711: stores hash permanently
7712: for this url; hashref needs to be given and should be a \%hashname; the
7713: remaining args aren't required and if they aren't passed or are '' they will
7714: be derived from the ENV
7715:
7716: =item restore
7717:
7718: returns a hash for a given url
7719:
7720: =item querysend
7721:
7722: Tells client about the lonsql process that has been launched in response
7723: to a sent query.
7724:
7725: =item queryreply
7726:
7727: Accept information from lonsql and make appropriate storage in temporary
7728: file space.
7729:
7730: =item idput
7731:
7732: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
7733: for each student, defined perhaps by the institutional Registrar.)
7734:
7735: =item idget
7736:
7737: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
7738: for each student, defined perhaps by the institutional Registrar.)
7739:
7740: =item tmpput
7741:
7742: Accept and store information in temporary space.
7743:
7744: =item tmpget
7745:
7746: Send along temporarily stored information.
7747:
7748: =item ls
7749:
7750: List part of a user's directory.
7751:
7752: =item pushtable
7753:
7754: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
7755: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
7756: must be restored manually in case of a problem with the new table file.
7757: pushtable requires that the request be encrypted and validated via
7758: ValidateManager. The form of the command is:
7759: enc:pushtable tablename <tablecontents> \n
7760: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
7761: cleartext newline.
7762:
7763: =item Hanging up (exit or init)
7764:
7765: What to do when a client tells the server that they (the client)
7766: are leaving the network.
7767:
7768: =item unknown command
7769:
7770: If B<lond> is sent an unknown command (not in the list above),
7771: it replys to the client "unknown_cmd".
7772:
7773:
7774: =item UNKNOWN CLIENT
7775:
7776: If the anti-spoofing algorithm cannot verify the client,
7777: the client is rejected (with a "refused" message sent
7778: to the client, and the connection is closed.
7779:
7780: =back
7781:
7782: =head1 PREREQUISITES
7783:
7784: IO::Socket
7785: IO::File
7786: Apache::File
7787: POSIX
7788: Crypt::IDEA
7789: LWP::UserAgent()
7790: GDBM_File
7791: Authen::Krb4
7792: Authen::Krb5
7793:
7794: =head1 COREQUISITES
7795:
7796: =head1 OSNAMES
7797:
7798: linux
7799:
7800: =head1 SCRIPT CATEGORIES
7801:
7802: Server/Process
7803:
7804: =cut
7805:
7806:
7807: =pod
7808:
7809: =head1 LOG MESSAGES
7810:
7811: The messages below can be emitted in the lond log. This log is located
7812: in ~httpd/perl/logs/lond.log Many log messages have HTML encapsulation
7813: to provide coloring if examined from inside a web page. Some do not.
7814: Where color is used, the colors are; Red for sometihhng to get excited
7815: about and to follow up on. Yellow for something to keep an eye on to
7816: be sure it does not get worse, Green,and Blue for informational items.
7817:
7818: In the discussions below, sometimes reference is made to ~httpd
7819: when describing file locations. There isn't really an httpd
7820: user, however there is an httpd directory that gets installed in the
7821: place that user home directories go. On linux, this is usually
7822: (always?) /home/httpd.
7823:
7824:
7825: Some messages are colorless. These are usually (not always)
7826: Green/Blue color level messages.
7827:
7828: =over 2
7829:
7830: =item (Red) LocalConnection rejecting non local: <ip> ne 127.0.0.1
7831:
7832: A local connection negotiation was attempted by
7833: a host whose IP address was not 127.0.0.1.
7834: The socket is closed and the child will exit.
7835: lond has three ways to establish an encyrption
7836: key with a client:
7837:
7838: =over 2
7839:
7840: =item local
7841:
7842: The key is written and read from a file.
7843: This is only valid for connections from localhost.
7844:
7845: =item insecure
7846:
7847: The key is generated by the server and
7848: transmitted to the client.
7849:
7850: =item ssl (secure)
7851:
7852: An ssl connection is negotiated with the client,
7853: the key is generated by the server and sent to the
7854: client across this ssl connection before the
7855: ssl connectionis terminated and clear text
7856: transmission resumes.
7857:
7858: =back
7859:
7860: =item (Red) LocalConnection: caller is insane! init = <init> and type = <type>
7861:
7862: The client is local but has not sent an initialization
7863: string that is the literal "init:local" The connection
7864: is closed and the child exits.
7865:
7866: =item Red CRITICAL Can't get key file <error>
7867:
7868: SSL key negotiation is being attempted but the call to
7869: lonssl::KeyFile failed. This usually means that the
7870: configuration file is not correctly defining or protecting
7871: the directories/files lonCertificateDirectory or
7872: lonnetPrivateKey
7873: <error> is a string that describes the reason that
7874: the key file could not be located.
7875:
7876: =item (Red) CRITICAL Can't get certificates <error>
7877:
7878: SSL key negotiation failed because we were not able to retrives our certificate
7879: or the CA's certificate in the call to lonssl::CertificateFile
7880: <error> is the textual reason this failed. Usual reasons:
7881:
7882: =over 2
7883:
7884: =item Apache config file for loncapa incorrect:
7885:
7886: one of the variables
7887: lonCertificateDirectory, lonnetCertificateAuthority, or lonnetCertificate
7888: undefined or incorrect
7889:
7890: =item Permission error:
7891:
7892: The directory pointed to by lonCertificateDirectory is not readable by lond
7893:
7894: =item Permission error:
7895:
7896: Files in the directory pointed to by lonCertificateDirectory are not readable by lond.
7897:
7898: =item Installation error:
7899:
7900: Either the certificate authority file or the certificate have not
7901: been installed in lonCertificateDirectory.
7902:
7903: =item (Red) CRITICAL SSL Socket promotion failed: <err>
7904:
7905: The promotion of the connection from plaintext to SSL failed
7906: <err> is the reason for the failure. There are two
7907: system calls involved in the promotion (one of which failed),
7908: a dup to produce
7909: a second fd on the raw socket over which the encrypted data
7910: will flow and IO::SOcket::SSL->new_from_fd which creates
7911: the SSL connection on the duped fd.
7912:
7913: =item (Blue) WARNING client did not respond to challenge
7914:
7915: This occurs on an insecure (non SSL) connection negotiation request.
7916: lond generates some number from the time, the PID and sends it to
7917: the client. The client must respond by echoing this information back.
7918: If the client does not do so, that's a violation of the challenge
7919: protocols and the connection will be failed.
7920:
7921: =item (Red) No manager table. Nobody can manage!!
7922:
7923: lond has the concept of privileged hosts that
7924: can perform remote management function such
7925: as update the hosts.tab. The manager hosts
7926: are described in the
7927: ~httpd/lonTabs/managers.tab file.
7928: this message is logged if this file is missing.
7929:
7930:
7931: =item (Green) Registering manager <dnsname> as <cluster_name> with <ipaddress>
7932:
7933: Reports the successful parse and registration
7934: of a specific manager.
7935:
7936: =item Green existing host <clustername:dnsname>
7937:
7938: The manager host is already defined in the hosts.tab
7939: the information in that table, rather than the info in the
7940: manager table will be used to determine the manager's ip.
7941:
7942: =item (Red) Unable to craete <filename>
7943:
7944: lond has been asked to create new versions of an administrative
7945: file (by a manager). When this is done, the new file is created
7946: in a temp file and then renamed into place so that there are always
7947: usable administrative files, even if the update fails. This failure
7948: message means that the temp file could not be created.
7949: The update is abandoned, and the old file is available for use.
7950:
7951: =item (Green) CopyFile from <oldname> to <newname> failed
7952:
7953: In an update of administrative files, the copy of the existing file to a
7954: backup file failed. The installation of the new file may still succeed,
7955: but there will not be a back up file to rever to (this should probably
7956: be yellow).
7957:
7958: =item (Green) Pushfile: backed up <oldname> to <newname>
7959:
7960: See above, the backup of the old administrative file succeeded.
7961:
7962: =item (Red) Pushfile: Unable to install <filename> <reason>
7963:
7964: The new administrative file could not be installed. In this case,
7965: the old administrative file is still in use.
7966:
7967: =item (Green) Installed new < filename>.
7968:
7969: The new administrative file was successfullly installed.
7970:
7971: =item (Red) Reinitializing lond pid=<pid>
7972:
7973: The lonc child process <pid> will be sent a USR2
7974: signal.
7975:
7976: =item (Red) Reinitializing self
7977:
7978: We've been asked to re-read our administrative files,and
7979: are doing so.
7980:
7981: =item (Yellow) error:Invalid process identifier <ident>
7982:
7983: A reinit command was received, but the target part of the
7984: command was not valid. It must be either
7985: 'lond' or 'lonc' but was <ident>
7986:
7987: =item (Green) isValideditCommand checking: Command = <command> Key = <key> newline = <newline>
7988:
7989: Checking to see if lond has been handed a valid edit
7990: command. It is possible the edit command is not valid
7991: in that case there are no log messages to indicate that.
7992:
7993: =item Result of password change for <username> pwchange_success
7994:
7995: The password for <username> was
7996: successfully changed.
7997:
7998: =item Unable to open <user> passwd to change password
7999:
8000: Could not rewrite the
8001: internal password file for a user
8002:
8003: =item Result of password change for <user> : <result>
8004:
8005: A unix password change for <user> was attempted
8006: and the pipe returned <result>
8007:
8008: =item LWP GET: <message> for <fname> (<remoteurl>)
8009:
8010: The lightweight process fetch for a resource failed
8011: with <message> the local filename that should
8012: have existed/been created was <fname> the
8013: corresponding URI: <remoteurl> This is emitted in several
8014: places.
8015:
8016: =item Unable to move <transname> to <destname>
8017:
8018: From fetch_user_file_handler - the user file was replicated but could not
8019: be mv'd to its final location.
8020:
8021: =item Looking for <domain> <username>
8022:
8023: From user_has_session_handler - This should be a Debug call instead
8024: it indicates lond is about to check whether the specified user has a
8025: session active on the specified domain on the local host.
8026:
8027: =item Client <ip> (<name>) hanging up: <input>
8028:
8029: lond has been asked to exit by its client. The <ip> and <name> identify the
8030: client systemand <input> is the full exit command sent to the server.
8031:
8032: =item Red CRITICAL: ABNORMAL EXIT. child <pid> for server <hostname> died through a crass with this error->[<message>].
8033:
8034: A lond child terminated. NOte that this termination can also occur when the
8035: child receives the QUIT or DIE signals. <pid> is the process id of the child,
8036: <hostname> the host lond is working for, and <message> the reason the child died
8037: to the best of our ability to get it (I would guess that any numeric value
8038: represents and errno value). This is immediately followed by
8039:
8040: =item Famous last words: Catching exception - <log>
8041:
8042: Where log is some recent information about the state of the child.
8043:
8044: =item Red CRITICAL: TIME OUT <pid>
8045:
8046: Some timeout occured for server <pid>. THis is normally a timeout on an LWP
8047: doing an HTTP::GET.
8048:
8049: =item child <pid> died
8050:
8051: The reaper caught a SIGCHILD for the lond child process <pid>
8052: This should be modified to also display the IP of the dying child
8053: $children{$pid}
8054:
8055: =item Unknown child 0 died
8056: A child died but the wait for it returned a pid of zero which really should not
8057: ever happen.
8058:
8059: =item Child <which> - <pid> looks like we missed it's death
8060:
8061: When a sigchild is received, the reaper process checks all children to see if they are
8062: alive. If children are dying quite quickly, the lack of signal queuing can mean
8063: that a signal hearalds the death of more than one child. If so this message indicates
8064: which other one died. <which> is the ip of a dead child
8065:
8066: =item Free socket: <shutdownretval>
8067:
8068: The HUNTSMAN sub was called due to a SIGINT in a child process. The socket is being shutdown.
8069: for whatever reason, <shutdownretval> is printed but in fact shutdown() is not documented
8070: to return anything. This is followed by:
8071:
8072: =item Red CRITICAL: Shutting down
8073:
8074: Just prior to exit.
8075:
8076: =item Free socket: <shutdownretval>
8077:
8078: The HUPSMAN sub was called due to a SIGHUP. all children get killsed, and lond execs itself.
8079: This is followed by:
8080:
8081: =item (Red) CRITICAL: Restarting
8082:
8083: lond is about to exec itself to restart.
8084:
8085: =item (Blue) Updating connections
8086:
8087: (In response to a USR2). All the children (except the one for localhost)
8088: are about to be killed, the hosts tab reread, and Apache reloaded via apachereload.
8089:
8090: =item (Blue) UpdateHosts killing child <pid> for ip <ip>
8091:
8092: Due to USR2 as above.
8093:
8094: =item (Green) keeping child for ip <ip> (pid = <pid>)
8095:
8096: In response to USR2 as above, the child indicated is not being restarted because
8097: it's assumed that we'll always need a child for the localhost.
8098:
8099:
8100: =item Going to check on the children
8101:
8102: Parent is about to check on the health of the child processes.
8103: Note that this is in response to a USR1 sent to the parent lond.
8104: there may be one or more of the next two messages:
8105:
8106: =item <pid> is dead
8107:
8108: A child that we have in our child hash as alive has evidently died.
8109:
8110: =item Child <pid> did not respond
8111:
8112: In the health check the child <pid> did not update/produce a pid_.txt
8113: file when sent it's USR1 signal. That process is killed with a 9 signal, as it's
8114: assumed to be hung in some un-fixable way.
8115:
8116: =item Finished checking children
8117:
8118: Master processs's USR1 processing is cojmplete.
8119:
8120: =item (Red) CRITICAL: ------- Starting ------
8121:
8122: (There are more '-'s on either side). Lond has forked itself off to
8123: form a new session and is about to start actual initialization.
8124:
8125: =item (Green) Attempting to start child (<client>)
8126:
8127: Started a new child process for <client>. Client is IO::Socket object
8128: connected to the child. This was as a result of a TCP/IP connection from a client.
8129:
8130: =item Unable to determine who caller was, getpeername returned nothing
8131:
8132: In child process initialization. either getpeername returned undef or
8133: a zero sized object was returned. Processing continues, but in my opinion,
8134: this should be cause for the child to exit.
8135:
8136: =item Unable to determine clientip
8137:
8138: In child process initialization. The peer address from getpeername was not defined.
8139: The client address is stored as "Unavailable" and processing continues.
8140:
8141: =item (Yellow) INFO: Connection <ip> <name> connection type = <type>
8142:
8143: In child initialization. A good connectionw as received from <ip>.
8144:
8145: =over 2
8146:
8147: =item <name>
8148:
8149: is the name of the client from hosts.tab.
8150:
8151: =item <type>
8152:
8153: Is the connection type which is either
8154:
8155: =over 2
8156:
8157: =item manager
8158:
8159: The connection is from a manager node, not in hosts.tab
8160:
8161: =item client
8162:
8163: the connection is from a non-manager in the hosts.tab
8164:
8165: =item both
8166:
8167: The connection is from a manager in the hosts.tab.
8168:
8169: =back
8170:
8171: =back
8172:
8173: =item (Blue) Certificates not installed -- trying insecure auth
8174:
8175: One of the certificate file, key file or
8176: certificate authority file could not be found for a client attempting
8177: SSL connection intiation. COnnection will be attemptied in in-secure mode.
8178: (this would be a system with an up to date lond that has not gotten a
8179: certificate from us).
8180:
8181: =item (Green) Successful local authentication
8182:
8183: A local connection successfully negotiated the encryption key.
8184: In this case the IDEA key is in a file (that is hopefully well protected).
8185:
8186: =item (Green) Successful ssl authentication with <client>
8187:
8188: The client (<client> is the peer's name in hosts.tab), has successfully
8189: negotiated an SSL connection with this child process.
8190:
8191: =item (Green) Successful insecure authentication with <client>
8192:
8193:
8194: The client has successfully negotiated an insecure connection withthe child process.
8195:
8196: =item (Yellow) Attempted insecure connection disallowed
8197:
8198: The client attempted and failed to successfully negotiate a successful insecure
8199: connection. This can happen either because the variable londAllowInsecure is false
8200: or undefined, or becuse the child did not successfully echo back the challenge
8201: string.
8202:
8203:
8204: =back
8205:
8206: =back
8207:
8208:
8209: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lond CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom