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