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