Annotation of loncom/lond, revision 1.461
1.1 albertel 1: #!/usr/bin/perl
2: # The LearningOnline Network
3: # lond "LON Daemon" Server (port "LOND" 5663)
1.60 www 4: #
1.461 ! foxr 5: # $Id: lond,v 1.460 2010/10/25 10:29:33 foxr 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.460 foxr 56: my $DEBUG = 1; # Non zero to enable debug log entries.
1.77 foxr 57:
1.57 www 58: my $status='';
59: my $lastlog='';
60:
1.461 ! foxr 61: my $VERSION='$Revision: 1.460 $'; #' 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.456 raeburn 3174: my $skipcheck;
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);
1.456 raeburn 3180: $skipcheck = $extra->{'skipcheck'};
1.450 raeburn 3181: }
3182: my @ids = &Apache::lonnet::current_machine_ids();
1.453 raeburn 3183: my (%homecourses,$major,$minor,$now);
1.456 raeburn 3184: if (($namespace eq 'roles') && (!$skipcheck)) {
1.453 raeburn 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.456 raeburn 3200: unless ($skipcheck) {
1.457 raeburn 3201: my ($role,$end,$start) = split(/\_/,$value);
3202: if (!$end || $end > $now) {
3203: next unless (&releasereqd_check($cnum,$cdom,$key,$value,$major,
3204: $minor,\%homecourses,\@ids));
1.458 raeburn 3205: }
1.432 raeburn 3206: }
3207: }
3208: }
1.231 foxr 3209: if ($regexp eq '.') {
1.306 albertel 3210: $count++;
3211: if (defined($range) && $count >= $end) { last; }
3212: if (defined($range) && $count < $start) { next; }
1.231 foxr 3213: $qresult.=$key.'='.$value.'&';
3214: } else {
3215: my $unescapeKey = &unescape($key);
3216: if (eval('$unescapeKey=~/$regexp/')) {
1.306 albertel 3217: $count++;
3218: if (defined($range) && $count >= $end) { last; }
3219: if (defined($range) && $count < $start) { next; }
1.231 foxr 3220: $qresult.="$key=$value&";
3221: }
3222: }
3223: }
1.311 albertel 3224: if (&untie_user_hash($hashref)) {
1.456 raeburn 3225: if (($namespace eq 'roles') && (!$skipcheck)) {
1.453 raeburn 3226: if (keys(%homecourses) > 0) {
3227: $qresult .= &check_homecourses(\%homecourses,$udom,$regexp,$count,
3228: $range,$start,$end,$major,$minor);
3229: }
3230: }
1.231 foxr 3231: chop($qresult);
1.387 albertel 3232: &Reply($client, \$qresult, $userinput);
1.231 foxr 3233: } else {
3234: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3235: "while attempting dump\n", $userinput);
3236: }
3237: } else {
3238: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3239: "while attempting dump\n", $userinput);
3240: }
3241:
3242: return 1;
3243: }
3244: ®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
3245:
3246: # Store a set of key=value pairs associated with a versioned name.
3247: #
3248: # Parameters:
3249: # $cmd - Request command keyword.
3250: # $tail - Tail of the request. This is a colon
3251: # separated list containing:
3252: # domain/user - User and authentication domain.
3253: # namespace - Name of the database being modified
3254: # rid - Resource keyword to modify.
3255: # what - new value associated with rid.
3256: #
3257: # $client - Socket open on the client.
3258: #
3259: #
3260: # Returns:
3261: # 1 (keep on processing).
3262: # Side-Effects:
3263: # Writes to the client
3264: sub store_handler {
3265: my ($cmd, $tail, $client) = @_;
3266:
3267: my $userinput = "$cmd:$tail";
3268:
3269: my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
3270: if ($namespace ne 'roles') {
3271:
3272: chomp($what);
3273: my @pairs=split(/\&/,$what);
3274: my $hashref = &tie_user_hash($udom, $uname, $namespace,
1.268 albertel 3275: &GDBM_WRCREAT(), "S",
1.231 foxr 3276: "$rid:$what");
3277: if ($hashref) {
3278: my $now = time;
3279: my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
3280: my $key;
3281: $hashref->{"version:$rid"}++;
3282: my $version=$hashref->{"version:$rid"};
3283: my $allkeys='';
3284: foreach my $pair (@pairs) {
3285: my ($key,$value)=split(/=/,$pair);
3286: $allkeys.=$key.':';
3287: $hashref->{"$version:$rid:$key"}=$value;
3288: }
3289: $hashref->{"$version:$rid:timestamp"}=$now;
3290: $allkeys.='timestamp';
3291: $hashref->{"$version:keys:$rid"}=$allkeys;
1.311 albertel 3292: if (&untie_user_hash($hashref)) {
1.231 foxr 3293: &Reply($client, "ok\n", $userinput);
3294: } else {
3295: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3296: "while attempting store\n", $userinput);
3297: }
3298: } else {
3299: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3300: "while attempting store\n", $userinput);
3301: }
3302: } else {
3303: &Failure($client, "refused\n", $userinput);
3304: }
3305:
3306: return 1;
3307: }
3308: ®ister_handler("store", \&store_handler, 0, 1, 0);
1.263 albertel 3309:
1.323 albertel 3310: # Modify a set of key=value pairs associated with a versioned name.
3311: #
3312: # Parameters:
3313: # $cmd - Request command keyword.
3314: # $tail - Tail of the request. This is a colon
3315: # separated list containing:
3316: # domain/user - User and authentication domain.
3317: # namespace - Name of the database being modified
3318: # rid - Resource keyword to modify.
3319: # v - Version item to modify
3320: # what - new value associated with rid.
3321: #
3322: # $client - Socket open on the client.
3323: #
3324: #
3325: # Returns:
3326: # 1 (keep on processing).
3327: # Side-Effects:
3328: # Writes to the client
3329: sub putstore_handler {
3330: my ($cmd, $tail, $client) = @_;
3331:
3332: my $userinput = "$cmd:$tail";
3333:
3334: my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
3335: if ($namespace ne 'roles') {
3336:
3337: chomp($what);
3338: my $hashref = &tie_user_hash($udom, $uname, $namespace,
3339: &GDBM_WRCREAT(), "M",
3340: "$rid:$v:$what");
3341: if ($hashref) {
3342: my $now = time;
3343: my %data = &hash_extract($what);
3344: my @allkeys;
3345: while (my($key,$value) = each(%data)) {
3346: push(@allkeys,$key);
3347: $hashref->{"$v:$rid:$key"} = $value;
3348: }
3349: my $allkeys = join(':',@allkeys);
3350: $hashref->{"$v:keys:$rid"}=$allkeys;
3351:
3352: if (&untie_user_hash($hashref)) {
3353: &Reply($client, "ok\n", $userinput);
3354: } else {
3355: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3356: "while attempting store\n", $userinput);
3357: }
3358: } else {
3359: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3360: "while attempting store\n", $userinput);
3361: }
3362: } else {
3363: &Failure($client, "refused\n", $userinput);
3364: }
3365:
3366: return 1;
3367: }
3368: ®ister_handler("putstore", \&putstore_handler, 0, 1, 0);
3369:
3370: sub hash_extract {
3371: my ($str)=@_;
3372: my %hash;
3373: foreach my $pair (split(/\&/,$str)) {
3374: my ($key,$value)=split(/=/,$pair);
3375: $hash{$key}=$value;
3376: }
3377: return (%hash);
3378: }
3379: sub hash_to_str {
3380: my ($hash_ref)=@_;
3381: my $str;
3382: foreach my $key (keys(%$hash_ref)) {
3383: $str.=$key.'='.$hash_ref->{$key}.'&';
3384: }
3385: $str=~s/\&$//;
3386: return $str;
3387: }
3388:
1.231 foxr 3389: #
3390: # Dump out all versions of a resource that has key=value pairs associated
3391: # with it for each version. These resources are built up via the store
3392: # command.
3393: #
3394: # Parameters:
3395: # $cmd - Command keyword.
3396: # $tail - Remainder of the request which consists of:
3397: # domain/user - User and auth. domain.
3398: # namespace - name of resource database.
3399: # rid - Resource id.
3400: # $client - socket open on the client.
3401: #
3402: # Returns:
3403: # 1 indicating the caller should not yet exit.
3404: # Side-effects:
3405: # Writes a reply to the client.
3406: # The reply is a string of the following shape:
3407: # version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
3408: # Where the 1 above represents version 1.
3409: # this continues for all pairs of keys in all versions.
3410: #
3411: #
3412: #
3413: #
3414: sub restore_handler {
3415: my ($cmd, $tail, $client) = @_;
3416:
3417: my $userinput = "$cmd:$tail"; # Only used for logging purposes.
1.351 banghart 3418: my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
1.352 albertel 3419: $namespace=~s/\//\_/g;
1.350 albertel 3420: $namespace = &LONCAPA::clean_username($namespace);
1.349 albertel 3421:
1.231 foxr 3422: chomp($rid);
3423: my $qresult='';
1.309 albertel 3424: my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
3425: if ($hashref) {
3426: my $version=$hashref->{"version:$rid"};
1.231 foxr 3427: $qresult.="version=$version&";
3428: my $scope;
3429: for ($scope=1;$scope<=$version;$scope++) {
1.309 albertel 3430: my $vkeys=$hashref->{"$scope:keys:$rid"};
1.231 foxr 3431: my @keys=split(/:/,$vkeys);
3432: my $key;
3433: $qresult.="$scope:keys=$vkeys&";
3434: foreach $key (@keys) {
1.309 albertel 3435: $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
1.231 foxr 3436: }
3437: }
1.311 albertel 3438: if (&untie_user_hash($hashref)) {
1.231 foxr 3439: $qresult=~s/\&$//;
1.387 albertel 3440: &Reply( $client, \$qresult, $userinput);
1.231 foxr 3441: } else {
3442: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3443: "while attempting restore\n", $userinput);
3444: }
3445: } else {
3446: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3447: "while attempting restore\n", $userinput);
3448: }
3449:
3450: return 1;
3451:
3452:
3453: }
3454: ®ister_handler("restore", \&restore_handler, 0,1,0);
1.234 foxr 3455:
3456: #
1.324 raeburn 3457: # Add a chat message to a synchronous discussion board.
1.234 foxr 3458: #
3459: # Parameters:
3460: # $cmd - Request keyword.
3461: # $tail - Tail of the command. A colon separated list
3462: # containing:
3463: # cdom - Domain on which the chat board lives
1.324 raeburn 3464: # cnum - Course containing the chat board.
3465: # newpost - Body of the posting.
3466: # group - Optional group, if chat board is only
3467: # accessible in a group within the course
1.234 foxr 3468: # $client - Socket open on the client.
3469: # Returns:
3470: # 1 - Indicating caller should keep on processing.
3471: #
3472: # Side-effects:
3473: # writes a reply to the client.
3474: #
3475: #
3476: sub send_chat_handler {
3477: my ($cmd, $tail, $client) = @_;
3478:
3479:
3480: my $userinput = "$cmd:$tail";
3481:
1.324 raeburn 3482: my ($cdom,$cnum,$newpost,$group)=split(/\:/,$tail);
3483: &chat_add($cdom,$cnum,$newpost,$group);
1.234 foxr 3484: &Reply($client, "ok\n", $userinput);
3485:
3486: return 1;
3487: }
3488: ®ister_handler("chatsend", \&send_chat_handler, 0, 1, 0);
1.263 albertel 3489:
1.234 foxr 3490: #
1.324 raeburn 3491: # Retrieve the set of chat messages from a discussion board.
1.234 foxr 3492: #
3493: # Parameters:
3494: # $cmd - Command keyword that initiated the request.
3495: # $tail - Remainder of the request after the command
3496: # keyword. In this case a colon separated list of
3497: # chat domain - Which discussion board.
3498: # chat id - Discussion thread(?)
3499: # domain/user - Authentication domain and username
3500: # of the requesting person.
1.324 raeburn 3501: # group - Optional course group containing
3502: # the board.
1.234 foxr 3503: # $client - Socket open on the client program.
3504: # Returns:
3505: # 1 - continue processing
3506: # Side effects:
3507: # Response is written to the client.
3508: #
3509: sub retrieve_chat_handler {
3510: my ($cmd, $tail, $client) = @_;
3511:
3512:
3513: my $userinput = "$cmd:$tail";
3514:
1.324 raeburn 3515: my ($cdom,$cnum,$udom,$uname,$group)=split(/\:/,$tail);
1.234 foxr 3516: my $reply='';
1.324 raeburn 3517: foreach (&get_chat($cdom,$cnum,$udom,$uname,$group)) {
1.234 foxr 3518: $reply.=&escape($_).':';
3519: }
3520: $reply=~s/\:$//;
1.387 albertel 3521: &Reply($client, \$reply, $userinput);
1.234 foxr 3522:
3523:
3524: return 1;
3525: }
3526: ®ister_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
3527:
3528: #
3529: # Initiate a query of an sql database. SQL query repsonses get put in
3530: # a file for later retrieval. This prevents sql query results from
3531: # bottlenecking the system. Note that with loncnew, perhaps this is
3532: # less of an issue since multiple outstanding requests can be concurrently
3533: # serviced.
3534: #
3535: # Parameters:
3536: # $cmd - COmmand keyword that initiated the request.
3537: # $tail - Remainder of the command after the keyword.
3538: # For this function, this consists of a query and
3539: # 3 arguments that are self-documentingly labelled
3540: # in the original arg1, arg2, arg3.
3541: # $client - Socket open on the client.
3542: # Return:
3543: # 1 - Indicating processing should continue.
3544: # Side-effects:
3545: # a reply is written to $client.
3546: #
3547: sub send_query_handler {
3548: my ($cmd, $tail, $client) = @_;
3549:
3550:
3551: my $userinput = "$cmd:$tail";
3552:
3553: my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
3554: $query=~s/\n*$//g;
3555: &Reply($client, "". &sql_reply("$clientname\&$query".
3556: "\&$arg1"."\&$arg2"."\&$arg3")."\n",
3557: $userinput);
3558:
3559: return 1;
3560: }
3561: ®ister_handler("querysend", \&send_query_handler, 0, 1, 0);
3562:
3563: #
3564: # Add a reply to an sql query. SQL queries are done asyncrhonously.
3565: # The query is submitted via a "querysend" transaction.
3566: # There it is passed on to the lonsql daemon, queued and issued to
3567: # mysql.
3568: # This transaction is invoked when the sql transaction is complete
3569: # it stores the query results in flie and indicates query completion.
3570: # presumably local software then fetches this response... I'm guessing
3571: # the sequence is: lonc does a querysend, we ask lonsql to do it.
3572: # lonsql on completion of the query interacts with the lond of our
3573: # client to do a query reply storing two files:
3574: # - id - The results of the query.
3575: # - id.end - Indicating the transaction completed.
3576: # NOTE: id is a unique id assigned to the query and querysend time.
3577: # Parameters:
3578: # $cmd - Command keyword that initiated this request.
3579: # $tail - Remainder of the tail. In this case that's a colon
3580: # separated list containing the query Id and the
3581: # results of the query.
3582: # $client - Socket open on the client.
3583: # Return:
3584: # 1 - Indicating that we should continue processing.
3585: # Side effects:
3586: # ok written to the client.
3587: #
3588: sub reply_query_handler {
3589: my ($cmd, $tail, $client) = @_;
3590:
3591:
3592: my $userinput = "$cmd:$tail";
3593:
1.339 albertel 3594: my ($id,$reply)=split(/:/,$tail);
1.234 foxr 3595: my $store;
3596: my $execdir=$perlvar{'lonDaemons'};
3597: if ($store=IO::File->new(">$execdir/tmp/$id")) {
3598: $reply=~s/\&/\n/g;
3599: print $store $reply;
3600: close $store;
3601: my $store2=IO::File->new(">$execdir/tmp/$id.end");
3602: print $store2 "done\n";
3603: close $store2;
3604: &Reply($client, "ok\n", $userinput);
3605: } else {
3606: &Failure($client, "error: ".($!+0)
3607: ." IO::File->new Failed ".
3608: "while attempting queryreply\n", $userinput);
3609: }
3610:
3611:
3612: return 1;
3613: }
3614: ®ister_handler("queryreply", \&reply_query_handler, 0, 1, 0);
3615:
3616: #
3617: # Process the courseidput request. Not quite sure what this means
3618: # at the system level sense. It appears a gdbm file in the
3619: # /home/httpd/lonUsers/$domain/nohist_courseids is tied and
3620: # a set of entries made in that database.
3621: #
3622: # Parameters:
3623: # $cmd - The command keyword that initiated this request.
3624: # $tail - Tail of the command. In this case consists of a colon
3625: # separated list contaning the domain to apply this to and
3626: # an ampersand separated list of keyword=value pairs.
1.272 raeburn 3627: # Each value is a colon separated list that includes:
3628: # description, institutional code and course owner.
3629: # For backward compatibility with versions included
3630: # in LON-CAPA 1.1.X (and earlier) and 1.2.X, institutional
3631: # code and/or course owner are preserved from the existing
3632: # record when writing a new record in response to 1.1 or
3633: # 1.2 implementations of lonnet::flushcourselogs().
3634: #
1.234 foxr 3635: # $client - Socket open on the client.
3636: # Returns:
3637: # 1 - indicating that processing should continue
3638: #
3639: # Side effects:
3640: # reply is written to the client.
3641: #
3642: sub put_course_id_handler {
3643: my ($cmd, $tail, $client) = @_;
3644:
3645:
3646: my $userinput = "$cmd:$tail";
3647:
1.266 raeburn 3648: my ($udom, $what) = split(/:/, $tail,2);
1.234 foxr 3649: chomp($what);
3650: my $now=time;
3651: my @pairs=split(/\&/,$what);
3652:
3653: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3654: if ($hashref) {
3655: foreach my $pair (@pairs) {
1.271 raeburn 3656: my ($key,$courseinfo) = split(/=/,$pair,2);
3657: $courseinfo =~ s/=/:/g;
1.384 raeburn 3658: if (defined($hashref->{$key})) {
3659: my $value = &Apache::lonnet::thaw_unescape($hashref->{$key});
3660: if (ref($value) eq 'HASH') {
3661: my @items = ('description','inst_code','owner','type');
3662: my @new_items = split(/:/,$courseinfo,-1);
3663: my %storehash;
3664: for (my $i=0; $i<@new_items; $i++) {
1.391 raeburn 3665: $storehash{$items[$i]} = &unescape($new_items[$i]);
1.384 raeburn 3666: }
3667: $hashref->{$key} =
3668: &Apache::lonnet::freeze_escape(\%storehash);
3669: my $unesc_key = &unescape($key);
3670: $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
3671: next;
1.383 raeburn 3672: }
1.384 raeburn 3673: }
3674: my @current_items = split(/:/,$hashref->{$key},-1);
3675: shift(@current_items); # remove description
3676: pop(@current_items); # remove last access
3677: my $numcurrent = scalar(@current_items);
3678: if ($numcurrent > 3) {
3679: $numcurrent = 3;
3680: }
3681: my @new_items = split(/:/,$courseinfo,-1);
3682: my $numnew = scalar(@new_items);
3683: if ($numcurrent > 0) {
3684: if ($numnew <= $numcurrent) { # flushcourselogs() from pre 2.2
3685: for (my $j=$numcurrent-$numnew; $j>=0; $j--) {
3686: $courseinfo .= ':'.$current_items[$numcurrent-$j-1];
1.333 raeburn 3687: }
1.272 raeburn 3688: }
3689: }
1.384 raeburn 3690: $hashref->{$key}=$courseinfo.':'.$now;
1.234 foxr 3691: }
1.311 albertel 3692: if (&untie_domain_hash($hashref)) {
1.253 foxr 3693: &Reply( $client, "ok\n", $userinput);
1.234 foxr 3694: } else {
1.253 foxr 3695: &Failure($client, "error: ".($!+0)
1.234 foxr 3696: ." untie(GDBM) Failed ".
3697: "while attempting courseidput\n", $userinput);
3698: }
3699: } else {
1.253 foxr 3700: &Failure($client, "error: ".($!+0)
1.234 foxr 3701: ." tie(GDBM) Failed ".
3702: "while attempting courseidput\n", $userinput);
3703: }
3704:
3705: return 1;
3706: }
3707: ®ister_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
3708:
1.383 raeburn 3709: sub put_course_id_hash_handler {
3710: my ($cmd, $tail, $client) = @_;
3711: my $userinput = "$cmd:$tail";
1.384 raeburn 3712: my ($udom,$mode,$what) = split(/:/, $tail,3);
1.383 raeburn 3713: chomp($what);
3714: my $now=time;
3715: my @pairs=split(/\&/,$what);
1.384 raeburn 3716: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
1.383 raeburn 3717: if ($hashref) {
3718: foreach my $pair (@pairs) {
3719: my ($key,$value)=split(/=/,$pair);
1.384 raeburn 3720: my $unesc_key = &unescape($key);
3721: if ($mode ne 'timeonly') {
3722: if (!defined($hashref->{&escape('lasttime:'.$unesc_key)})) {
3723: my $curritems = &Apache::lonnet::thaw_unescape($key);
3724: if (ref($curritems) ne 'HASH') {
3725: my @current_items = split(/:/,$hashref->{$key},-1);
3726: my $lasttime = pop(@current_items);
3727: $hashref->{&escape('lasttime:'.$unesc_key)} = $lasttime;
3728: } else {
3729: $hashref->{&escape('lasttime:'.$unesc_key)} = '';
3730: }
3731: }
3732: $hashref->{$key} = $value;
3733: }
3734: if ($mode ne 'notime') {
3735: $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
3736: }
1.383 raeburn 3737: }
3738: if (&untie_domain_hash($hashref)) {
3739: &Reply($client, "ok\n", $userinput);
3740: } else {
3741: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3742: "while attempting courseidputhash\n", $userinput);
3743: }
3744: } else {
3745: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3746: "while attempting courseidputhash\n", $userinput);
3747: }
3748: return 1;
3749: }
3750: ®ister_handler("courseidputhash", \&put_course_id_hash_handler, 0, 1, 0);
3751:
1.234 foxr 3752: # Retrieves the value of a course id resource keyword pattern
3753: # defined since a starting date. Both the starting date and the
3754: # keyword pattern are optional. If the starting date is not supplied it
3755: # is treated as the beginning of time. If the pattern is not found,
3756: # it is treatred as "." matching everything.
3757: #
3758: # Parameters:
3759: # $cmd - Command keyword that resulted in us being dispatched.
3760: # $tail - The remainder of the command that, in this case, consists
3761: # of a colon separated list of:
3762: # domain - The domain in which the course database is
3763: # defined.
3764: # since - Optional parameter describing the minimum
3765: # time of definition(?) of the resources that
3766: # will match the dump.
3767: # description - regular expression that is used to filter
3768: # the dump. Only keywords matching this regexp
3769: # will be used.
1.272 raeburn 3770: # institutional code - optional supplied code to filter
3771: # the dump. Only courses with an institutional code
3772: # that match the supplied code will be returned.
1.336 raeburn 3773: # owner - optional supplied username and domain of owner to
3774: # filter the dump. Only courses for which the course
3775: # owner matches the supplied username and/or domain
3776: # will be returned. Pre-2.2.0 legacy entries from
3777: # nohist_courseiddump will only contain usernames.
1.384 raeburn 3778: # type - optional parameter for selection
1.418 raeburn 3779: # regexp_ok - if 1 or -1 allow the supplied institutional code
3780: # filter to behave as a regular expression:
3781: # 1 will not exclude the course if the instcode matches the RE
3782: # -1 will exclude the course if the instcode matches the RE
1.384 raeburn 3783: # rtn_as_hash - whether to return the information available for
3784: # each matched item as a frozen hash of all
3785: # key, value pairs in the item's hash, or as a
3786: # colon-separated list of (in order) description,
3787: # institutional code, and course owner.
1.404 raeburn 3788: # selfenrollonly - filter by courses allowing self-enrollment
3789: # now or in the future (selfenrollonly = 1).
3790: # catfilter - filter by course category, assigned to a course
3791: # using manually defined categories (i.e., not
1.407 raeburn 3792: # self-cataloging based on on institutional code).
1.404 raeburn 3793: # showhidden - include course in results even if course
1.407 raeburn 3794: # was set to be excluded from course catalog (DC only).
1.404 raeburn 3795: # caller - if set to 'coursecatalog', courses set to be hidden
3796: # from course catalog will be excluded from results (unless
3797: # overridden by "showhidden".
1.427 raeburn 3798: # cloner - escaped username:domain of course cloner (if picking course to
1.419 raeburn 3799: # clone).
3800: # cc_clone_list - escaped comma separated list of courses for which
3801: # course cloner has active CC role (and so can clone
3802: # automatically).
1.427 raeburn 3803: # cloneonly - filter by courses for which cloner has rights to clone.
3804: # createdbefore - include courses for which creation date preceeded this date.
3805: # createdafter - include courses for which creation date followed this date.
3806: # creationcontext - include courses created in specified context
1.404 raeburn 3807: #
1.445 raeburn 3808: # domcloner - flag to indicate if user can create CCs in course's domain.
3809: # If so, ability to clone course is automatic.
3810: #
1.234 foxr 3811: # $client - The socket open on the client.
3812: # Returns:
3813: # 1 - Continue processing.
3814: # Side Effects:
3815: # a reply is written to $client.
3816: sub dump_course_id_handler {
3817: my ($cmd, $tail, $client) = @_;
3818: my $userinput = "$cmd:$tail";
3819:
1.333 raeburn 3820: my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
1.404 raeburn 3821: $typefilter,$regexp_ok,$rtn_as_hash,$selfenrollonly,$catfilter,$showhidden,
1.427 raeburn 3822: $caller,$cloner,$cc_clone_list,$cloneonly,$createdbefore,$createdafter,
1.445 raeburn 3823: $creationcontext,$domcloner) =split(/:/,$tail);
1.397 raeburn 3824: my $now = time;
1.419 raeburn 3825: my ($cloneruname,$clonerudom,%cc_clone);
1.234 foxr 3826: if (defined($description)) {
3827: $description=&unescape($description);
3828: } else {
3829: $description='.';
3830: }
1.266 raeburn 3831: if (defined($instcodefilter)) {
3832: $instcodefilter=&unescape($instcodefilter);
3833: } else {
3834: $instcodefilter='.';
3835: }
1.336 raeburn 3836: my ($ownerunamefilter,$ownerdomfilter);
1.266 raeburn 3837: if (defined($ownerfilter)) {
3838: $ownerfilter=&unescape($ownerfilter);
1.336 raeburn 3839: if ($ownerfilter ne '.' && defined($ownerfilter)) {
3840: if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
3841: $ownerunamefilter = $1;
3842: $ownerdomfilter = $2;
3843: } else {
3844: $ownerunamefilter = $ownerfilter;
3845: $ownerdomfilter = '';
3846: }
3847: }
1.266 raeburn 3848: } else {
3849: $ownerfilter='.';
3850: }
1.336 raeburn 3851:
1.282 raeburn 3852: if (defined($coursefilter)) {
3853: $coursefilter=&unescape($coursefilter);
3854: } else {
3855: $coursefilter='.';
3856: }
1.333 raeburn 3857: if (defined($typefilter)) {
3858: $typefilter=&unescape($typefilter);
3859: } else {
3860: $typefilter='.';
3861: }
1.344 raeburn 3862: if (defined($regexp_ok)) {
3863: $regexp_ok=&unescape($regexp_ok);
3864: }
1.401 raeburn 3865: if (defined($catfilter)) {
3866: $catfilter=&unescape($catfilter);
3867: }
1.419 raeburn 3868: if (defined($cloner)) {
3869: $cloner = &unescape($cloner);
3870: ($cloneruname,$clonerudom) = ($cloner =~ /^($LONCAPA::match_username):($LONCAPA::match_domain)$/);
3871: }
3872: if (defined($cc_clone_list)) {
3873: $cc_clone_list = &unescape($cc_clone_list);
3874: my @cc_cloners = split('&',$cc_clone_list);
3875: foreach my $cid (@cc_cloners) {
3876: my ($clonedom,$clonenum) = split(':',$cid);
3877: next if ($clonedom ne $udom);
3878: $cc_clone{$clonedom.'_'.$clonenum} = 1;
3879: }
3880: }
1.431 raeburn 3881: if ($createdbefore ne '') {
1.427 raeburn 3882: $createdbefore = &unescape($createdbefore);
3883: } else {
3884: $createdbefore = 0;
3885: }
1.431 raeburn 3886: if ($createdafter ne '') {
1.427 raeburn 3887: $createdafter = &unescape($createdafter);
3888: } else {
3889: $createdafter = 0;
3890: }
1.431 raeburn 3891: if ($creationcontext ne '') {
1.427 raeburn 3892: $creationcontext = &unescape($creationcontext);
3893: } else {
3894: $creationcontext = '.';
3895: }
1.384 raeburn 3896: my $unpack = 1;
3897: if ($description eq '.' && $instcodefilter eq '.' && $coursefilter eq '.' &&
3898: $typefilter eq '.') {
3899: $unpack = 0;
3900: }
3901: if (!defined($since)) { $since=0; }
1.234 foxr 3902: my $qresult='';
3903: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3904: if ($hashref) {
1.384 raeburn 3905: while (my ($key,$value) = each(%$hashref)) {
1.397 raeburn 3906: my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,
1.427 raeburn 3907: %unesc_val,$selfenroll_end,$selfenroll_types,$created,
3908: $context);
1.384 raeburn 3909: $unesc_key = &unescape($key);
3910: if ($unesc_key =~ /^lasttime:/) {
3911: next;
3912: } else {
3913: $lasttime_key = &escape('lasttime:'.$unesc_key);
3914: }
3915: if ($hashref->{$lasttime_key} ne '') {
3916: $lasttime = $hashref->{$lasttime_key};
3917: next if ($lasttime<$since);
3918: }
1.419 raeburn 3919: my ($canclone,$valchange);
1.384 raeburn 3920: my $items = &Apache::lonnet::thaw_unescape($value);
3921: if (ref($items) eq 'HASH') {
1.429 raeburn 3922: if ($hashref->{$lasttime_key} eq '') {
1.430 raeburn 3923: next if ($since > 1);
1.429 raeburn 3924: }
1.384 raeburn 3925: $is_hash = 1;
1.445 raeburn 3926: if ($domcloner) {
3927: $canclone = 1;
3928: } elsif (defined($clonerudom)) {
1.419 raeburn 3929: if ($items->{'cloners'}) {
3930: my @cloneable = split(',',$items->{'cloners'});
3931: if (@cloneable) {
3932: if (grep(/^\*$/,@cloneable)) {
3933: $canclone = 1;
3934: } elsif (grep(/^\*:\Q$clonerudom\E$/,@cloneable)) {
3935: $canclone = 1;
3936: } elsif (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
3937: $canclone = 1;
3938: }
3939: }
3940: unless ($canclone) {
3941: if ($cloneruname ne '' && $clonerudom ne '') {
3942: if ($cc_clone{$unesc_key}) {
3943: $canclone = 1;
3944: $items->{'cloners'} .= ','.$cloneruname.':'.
3945: $clonerudom;
3946: $valchange = 1;
3947: }
3948: }
3949: }
3950: } elsif (defined($cloneruname)) {
3951: if ($cc_clone{$unesc_key}) {
3952: $canclone = 1;
3953: $items->{'cloners'} = $cloneruname.':'.$clonerudom;
3954: $valchange = 1;
3955: }
1.437 raeburn 3956: unless ($canclone) {
3957: if ($items->{'owner'} =~ /:/) {
3958: if ($items->{'owner'} eq $cloner) {
3959: $canclone = 1;
3960: }
1.444 raeburn 3961: } elsif ($cloner eq $items->{'owner'}.':'.$udom) {
1.437 raeburn 3962: $canclone = 1;
3963: }
3964: if ($canclone) {
3965: $items->{'cloners'} = $cloneruname.':'.$clonerudom;
3966: $valchange = 1;
3967: }
3968: }
1.419 raeburn 3969: }
3970: }
1.384 raeburn 3971: if ($unpack || !$rtn_as_hash) {
3972: $unesc_val{'descr'} = $items->{'description'};
3973: $unesc_val{'inst_code'} = $items->{'inst_code'};
3974: $unesc_val{'owner'} = $items->{'owner'};
3975: $unesc_val{'type'} = $items->{'type'};
1.419 raeburn 3976: $unesc_val{'cloners'} = $items->{'cloners'};
1.427 raeburn 3977: $unesc_val{'created'} = $items->{'created'};
3978: $unesc_val{'context'} = $items->{'context'};
1.404 raeburn 3979: }
3980: $selfenroll_types = $items->{'selfenroll_types'};
3981: $selfenroll_end = $items->{'selfenroll_end_date'};
1.427 raeburn 3982: $created = $items->{'created'};
3983: $context = $items->{'context'};
1.404 raeburn 3984: if ($selfenrollonly) {
3985: next if (!$selfenroll_types);
3986: if (($selfenroll_end > 0) && ($selfenroll_end <= $now)) {
3987: next;
1.397 raeburn 3988: }
1.404 raeburn 3989: }
1.427 raeburn 3990: if ($creationcontext ne '.') {
3991: next if (($context ne '') && ($context ne $creationcontext));
3992: }
3993: if ($createdbefore > 0) {
3994: next if (($created eq '') || ($created > $createdbefore));
3995: }
3996: if ($createdafter > 0) {
3997: next if (($created eq '') || ($created <= $createdafter));
3998: }
1.404 raeburn 3999: if ($catfilter ne '') {
1.406 raeburn 4000: next if ($items->{'categories'} eq '');
4001: my @categories = split('&',$items->{'categories'});
1.407 raeburn 4002: next if (@categories == 0);
4003: my @subcats = split('&',$catfilter);
4004: my $matchcat = 0;
4005: foreach my $cat (@categories) {
4006: if (grep(/^\Q$cat\E$/,@subcats)) {
4007: $matchcat = 1;
4008: last;
4009: }
4010: }
4011: next if (!$matchcat);
1.404 raeburn 4012: }
4013: if ($caller eq 'coursecatalog') {
1.405 raeburn 4014: if ($items->{'hidefromcat'} eq 'yes') {
4015: next if !$showhidden;
1.401 raeburn 4016: }
1.384 raeburn 4017: }
1.383 raeburn 4018: } else {
1.401 raeburn 4019: next if ($catfilter ne '');
1.419 raeburn 4020: next if ($selfenrollonly);
1.427 raeburn 4021: next if ($createdbefore || $createdafter);
4022: next if ($creationcontext ne '.');
1.419 raeburn 4023: if ((defined($clonerudom)) && (defined($cloneruname))) {
4024: if ($cc_clone{$unesc_key}) {
4025: $canclone = 1;
4026: $val{'cloners'} = &escape($cloneruname.':'.$clonerudom);
4027: }
4028: }
1.384 raeburn 4029: $is_hash = 0;
1.388 raeburn 4030: my @courseitems = split(/:/,$value);
1.403 raeburn 4031: $lasttime = pop(@courseitems);
1.402 raeburn 4032: if ($hashref->{$lasttime_key} eq '') {
4033: next if ($lasttime<$since);
4034: }
1.384 raeburn 4035: ($val{'descr'},$val{'inst_code'},$val{'owner'},$val{'type'}) = @courseitems;
1.383 raeburn 4036: }
1.419 raeburn 4037: if ($cloneonly) {
4038: next unless ($canclone);
4039: }
1.266 raeburn 4040: my $match = 1;
1.384 raeburn 4041: if ($description ne '.') {
4042: if (!$is_hash) {
4043: $unesc_val{'descr'} = &unescape($val{'descr'});
4044: }
4045: if (eval{$unesc_val{'descr'} !~ /\Q$description\E/i}) {
1.266 raeburn 4046: $match = 0;
1.384 raeburn 4047: }
1.266 raeburn 4048: }
1.384 raeburn 4049: if ($instcodefilter ne '.') {
4050: if (!$is_hash) {
4051: $unesc_val{'inst_code'} = &unescape($val{'inst_code'});
4052: }
1.418 raeburn 4053: if ($regexp_ok == 1) {
1.384 raeburn 4054: if (eval{$unesc_val{'inst_code'} !~ /$instcodefilter/}) {
1.344 raeburn 4055: $match = 0;
4056: }
1.418 raeburn 4057: } elsif ($regexp_ok == -1) {
4058: if (eval{$unesc_val{'inst_code'} =~ /$instcodefilter/}) {
4059: $match = 0;
4060: }
1.344 raeburn 4061: } else {
1.384 raeburn 4062: if (eval{$unesc_val{'inst_code'} !~ /\Q$instcodefilter\E/i}) {
1.344 raeburn 4063: $match = 0;
4064: }
1.266 raeburn 4065: }
1.234 foxr 4066: }
1.384 raeburn 4067: if ($ownerfilter ne '.') {
4068: if (!$is_hash) {
4069: $unesc_val{'owner'} = &unescape($val{'owner'});
4070: }
1.336 raeburn 4071: if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
1.384 raeburn 4072: if ($unesc_val{'owner'} =~ /:/) {
4073: if (eval{$unesc_val{'owner'} !~
4074: /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i}) {
1.336 raeburn 4075: $match = 0;
4076: }
4077: } else {
1.384 raeburn 4078: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
1.336 raeburn 4079: $match = 0;
4080: }
4081: }
4082: } elsif ($ownerunamefilter ne '') {
1.384 raeburn 4083: if ($unesc_val{'owner'} =~ /:/) {
4084: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E:[^:]+$/i}) {
1.336 raeburn 4085: $match = 0;
4086: }
4087: } else {
1.384 raeburn 4088: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
1.336 raeburn 4089: $match = 0;
4090: }
4091: }
4092: } elsif ($ownerdomfilter ne '') {
1.384 raeburn 4093: if ($unesc_val{'owner'} =~ /:/) {
4094: if (eval{$unesc_val{'owner'} !~ /^[^:]+:\Q$ownerdomfilter\E/}) {
1.336 raeburn 4095: $match = 0;
4096: }
4097: } else {
4098: if ($ownerdomfilter ne $udom) {
4099: $match = 0;
4100: }
4101: }
1.266 raeburn 4102: }
4103: }
1.384 raeburn 4104: if ($coursefilter ne '.') {
4105: if (eval{$unesc_key !~ /^$udom(_)\Q$coursefilter\E$/}) {
1.282 raeburn 4106: $match = 0;
4107: }
4108: }
1.384 raeburn 4109: if ($typefilter ne '.') {
4110: if (!$is_hash) {
4111: $unesc_val{'type'} = &unescape($val{'type'});
4112: }
4113: if ($unesc_val{'type'} eq '') {
1.333 raeburn 4114: if ($typefilter ne 'Course') {
4115: $match = 0;
4116: }
1.383 raeburn 4117: } else {
1.384 raeburn 4118: if (eval{$unesc_val{'type'} !~ /^\Q$typefilter\E$/}) {
1.333 raeburn 4119: $match = 0;
4120: }
4121: }
4122: }
1.266 raeburn 4123: if ($match == 1) {
1.384 raeburn 4124: if ($rtn_as_hash) {
4125: if ($is_hash) {
1.419 raeburn 4126: if ($valchange) {
4127: my $newvalue = &Apache::lonnet::freeze_escape($items);
4128: $qresult.=$key.'='.$newvalue.'&';
4129: } else {
4130: $qresult.=$key.'='.$value.'&';
4131: }
1.384 raeburn 4132: } else {
1.388 raeburn 4133: my %rtnhash = ( 'description' => &unescape($val{'descr'}),
4134: 'inst_code' => &unescape($val{'inst_code'}),
4135: 'owner' => &unescape($val{'owner'}),
4136: 'type' => &unescape($val{'type'}),
1.419 raeburn 4137: 'cloners' => &unescape($val{'cloners'}),
1.384 raeburn 4138: );
4139: my $items = &Apache::lonnet::freeze_escape(\%rtnhash);
4140: $qresult.=$key.'='.$items.'&';
4141: }
1.383 raeburn 4142: } else {
1.384 raeburn 4143: if ($is_hash) {
4144: $qresult .= $key.'='.&escape($unesc_val{'descr'}).':'.
4145: &escape($unesc_val{'inst_code'}).':'.
4146: &escape($unesc_val{'owner'}).'&';
4147: } else {
4148: $qresult .= $key.'='.$val{'descr'}.':'.$val{'inst_code'}.
4149: ':'.$val{'owner'}.'&';
4150: }
1.383 raeburn 4151: }
1.266 raeburn 4152: }
1.234 foxr 4153: }
1.311 albertel 4154: if (&untie_domain_hash($hashref)) {
1.234 foxr 4155: chop($qresult);
1.387 albertel 4156: &Reply($client, \$qresult, $userinput);
1.234 foxr 4157: } else {
4158: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4159: "while attempting courseiddump\n", $userinput);
4160: }
4161: } else {
4162: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4163: "while attempting courseiddump\n", $userinput);
4164: }
4165: return 1;
4166: }
4167: ®ister_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
1.238 foxr 4168:
1.438 raeburn 4169: sub course_lastaccess_handler {
4170: my ($cmd, $tail, $client) = @_;
4171: my $userinput = "$cmd:$tail";
4172: my ($cdom,$cnum) = split(':',$tail);
4173: my (%lastaccess,$qresult);
4174: my $hashref = &tie_domain_hash($cdom, "nohist_courseids", &GDBM_WRCREAT());
4175: if ($hashref) {
4176: while (my ($key,$value) = each(%$hashref)) {
4177: my ($unesc_key,$lasttime);
4178: $unesc_key = &unescape($key);
4179: if ($cnum) {
4180: next unless ($unesc_key =~ /\Q$cdom\E_\Q$cnum\E$/);
4181: }
4182: if ($unesc_key =~ /^lasttime:($LONCAPA::match_domain\_$LONCAPA::match_courseid)/) {
4183: $lastaccess{$1} = $value;
4184: } else {
4185: my $items = &Apache::lonnet::thaw_unescape($value);
4186: if (ref($items) eq 'HASH') {
4187: unless ($lastaccess{$unesc_key}) {
4188: $lastaccess{$unesc_key} = '';
4189: }
4190: } else {
4191: my @courseitems = split(':',$value);
4192: $lastaccess{$unesc_key} = pop(@courseitems);
4193: }
4194: }
4195: }
4196: foreach my $cid (sort(keys(%lastaccess))) {
4197: $qresult.=&escape($cid).'='.$lastaccess{$cid}.'&';
4198: }
4199: if (&untie_domain_hash($hashref)) {
4200: if ($qresult) {
4201: chop($qresult);
4202: }
4203: &Reply($client, \$qresult, $userinput);
4204: } else {
4205: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4206: "while attempting lastacourseaccess\n", $userinput);
4207: }
4208: } else {
4209: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4210: "while attempting lastcourseaccess\n", $userinput);
4211: }
4212: return 1;
4213: }
4214: ®ister_handler("courselastaccess",\&course_lastaccess_handler, 0, 1, 0);
4215:
1.238 foxr 4216: #
1.348 raeburn 4217: # Puts an unencrypted entry in a namespace db file at the domain level
4218: #
4219: # Parameters:
4220: # $cmd - The command that got us here.
4221: # $tail - Tail of the command (remaining parameters).
4222: # $client - File descriptor connected to client.
4223: # Returns
4224: # 0 - Requested to exit, caller should shut down.
4225: # 1 - Continue processing.
4226: # Side effects:
4227: # reply is written to $client.
4228: #
4229: sub put_domain_handler {
4230: my ($cmd,$tail,$client) = @_;
4231:
4232: my $userinput = "$cmd:$tail";
4233:
4234: my ($udom,$namespace,$what) =split(/:/,$tail,3);
4235: chomp($what);
4236: my @pairs=split(/\&/,$what);
4237: my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_WRCREAT(),
4238: "P", $what);
4239: if ($hashref) {
4240: foreach my $pair (@pairs) {
4241: my ($key,$value)=split(/=/,$pair);
4242: $hashref->{$key}=$value;
4243: }
4244: if (&untie_domain_hash($hashref)) {
4245: &Reply($client, "ok\n", $userinput);
4246: } else {
4247: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4248: "while attempting putdom\n", $userinput);
4249: }
4250: } else {
4251: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
4252: "while attempting putdom\n", $userinput);
4253: }
4254:
4255: return 1;
4256: }
4257: ®ister_handler("putdom", \&put_domain_handler, 0, 1, 0);
4258:
4259: # Unencrypted get from the namespace database file at the domain level.
4260: # This function retrieves a keyed item from a specific named database in the
4261: # domain directory.
4262: #
4263: # Parameters:
4264: # $cmd - Command request keyword (get).
4265: # $tail - Tail of the command. This is a colon separated list
4266: # consisting of the domain and the 'namespace'
4267: # which selects the gdbm file to do the lookup in,
4268: # & separated list of keys to lookup. Note that
4269: # the values are returned as an & separated list too.
4270: # $client - File descriptor open on the client.
4271: # Returns:
4272: # 1 - Continue processing.
4273: # 0 - Exit.
4274: # Side effects:
4275: # reply is written to $client.
4276: #
4277:
4278: sub get_domain_handler {
4279: my ($cmd, $tail, $client) = @_;
4280:
1.461 ! foxr 4281:
1.348 raeburn 4282: my $userinput = "$client:$tail";
4283:
4284: my ($udom,$namespace,$what)=split(/:/,$tail,3);
4285: chomp($what);
4286: my @queries=split(/\&/,$what);
4287: my $qresult='';
4288: my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_READER());
4289: if ($hashref) {
4290: for (my $i=0;$i<=$#queries;$i++) {
4291: $qresult.="$hashref->{$queries[$i]}&";
4292: }
4293: if (&untie_domain_hash($hashref)) {
4294: $qresult=~s/\&$//;
1.387 albertel 4295: &Reply($client, \$qresult, $userinput);
1.348 raeburn 4296: } else {
4297: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
4298: "while attempting getdom\n",$userinput);
4299: }
4300: } else {
4301: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4302: "while attempting getdom\n",$userinput);
4303: }
4304:
4305: return 1;
4306: }
1.360 raeburn 4307: ®ister_handler("getdom", \&get_domain_handler, 0, 1, 0);
1.348 raeburn 4308:
1.420 raeburn 4309: #
1.238 foxr 4310: # Puts an id to a domains id database.
4311: #
4312: # Parameters:
4313: # $cmd - The command that triggered us.
4314: # $tail - Remainder of the request other than the command. This is a
4315: # colon separated list containing:
4316: # $domain - The domain for which we are writing the id.
4317: # $pairs - The id info to write... this is and & separated list
4318: # of keyword=value.
4319: # $client - Socket open on the client.
4320: # Returns:
4321: # 1 - Continue processing.
4322: # Side effects:
4323: # reply is written to $client.
4324: #
4325: sub put_id_handler {
4326: my ($cmd,$tail,$client) = @_;
4327:
4328:
4329: my $userinput = "$cmd:$tail";
4330:
4331: my ($udom,$what)=split(/:/,$tail);
4332: chomp($what);
4333: my @pairs=split(/\&/,$what);
4334: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
4335: "P", $what);
4336: if ($hashref) {
4337: foreach my $pair (@pairs) {
4338: my ($key,$value)=split(/=/,$pair);
4339: $hashref->{$key}=$value;
4340: }
1.311 albertel 4341: if (&untie_domain_hash($hashref)) {
1.238 foxr 4342: &Reply($client, "ok\n", $userinput);
4343: } else {
4344: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4345: "while attempting idput\n", $userinput);
4346: }
4347: } else {
4348: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
4349: "while attempting idput\n", $userinput);
4350: }
4351:
4352: return 1;
4353: }
1.263 albertel 4354: ®ister_handler("idput", \&put_id_handler, 0, 1, 0);
1.238 foxr 4355:
4356: #
4357: # Retrieves a set of id values from the id database.
4358: # Returns an & separated list of results, one for each requested id to the
4359: # client.
4360: #
4361: # Parameters:
4362: # $cmd - Command keyword that caused us to be dispatched.
4363: # $tail - Tail of the command. Consists of a colon separated:
4364: # domain - the domain whose id table we dump
4365: # ids Consists of an & separated list of
4366: # id keywords whose values will be fetched.
4367: # nonexisting keywords will have an empty value.
4368: # $client - Socket open on the client.
4369: #
4370: # Returns:
4371: # 1 - indicating processing should continue.
4372: # Side effects:
4373: # An & separated list of results is written to $client.
4374: #
4375: sub get_id_handler {
4376: my ($cmd, $tail, $client) = @_;
4377:
4378:
4379: my $userinput = "$client:$tail";
4380:
4381: my ($udom,$what)=split(/:/,$tail);
4382: chomp($what);
4383: my @queries=split(/\&/,$what);
4384: my $qresult='';
4385: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
4386: if ($hashref) {
4387: for (my $i=0;$i<=$#queries;$i++) {
4388: $qresult.="$hashref->{$queries[$i]}&";
4389: }
1.311 albertel 4390: if (&untie_domain_hash($hashref)) {
1.238 foxr 4391: $qresult=~s/\&$//;
1.387 albertel 4392: &Reply($client, \$qresult, $userinput);
1.238 foxr 4393: } else {
4394: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
4395: "while attempting idget\n",$userinput);
4396: }
4397: } else {
4398: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4399: "while attempting idget\n",$userinput);
4400: }
4401:
4402: return 1;
4403: }
1.263 albertel 4404: ®ister_handler("idget", \&get_id_handler, 0, 1, 0);
1.238 foxr 4405:
4406: #
1.299 raeburn 4407: # Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database
4408: #
4409: # Parameters
4410: # $cmd - Command keyword that caused us to be dispatched.
4411: # $tail - Tail of the command. Consists of a colon separated:
4412: # domain - the domain whose dcmail we are recording
4413: # email Consists of key=value pair
4414: # where key is unique msgid
4415: # and value is message (in XML)
4416: # $client - Socket open on the client.
4417: #
4418: # Returns:
4419: # 1 - indicating processing should continue.
4420: # Side effects
4421: # reply is written to $client.
4422: #
4423: sub put_dcmail_handler {
4424: my ($cmd,$tail,$client) = @_;
4425: my $userinput = "$cmd:$tail";
4426:
4427: my ($udom,$what)=split(/:/,$tail);
4428: chomp($what);
4429: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
4430: if ($hashref) {
4431: my ($key,$value)=split(/=/,$what);
4432: $hashref->{$key}=$value;
4433: }
1.311 albertel 4434: if (&untie_domain_hash($hashref)) {
1.299 raeburn 4435: &Reply($client, "ok\n", $userinput);
4436: } else {
4437: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4438: "while attempting dcmailput\n", $userinput);
4439: }
4440: return 1;
4441: }
4442: ®ister_handler("dcmailput", \&put_dcmail_handler, 0, 1, 0);
4443:
4444: #
4445: # Retrieves broadcast e-mail from nohist_dcmail database
4446: # Returns to client an & separated list of key=value pairs,
4447: # where key is msgid and value is message information.
4448: #
4449: # Parameters
4450: # $cmd - Command keyword that caused us to be dispatched.
4451: # $tail - Tail of the command. Consists of a colon separated:
4452: # domain - the domain whose dcmail table we dump
4453: # startfilter - beginning of time window
4454: # endfilter - end of time window
4455: # sendersfilter - & separated list of username:domain
4456: # for senders to search for.
4457: # $client - Socket open on the client.
4458: #
4459: # Returns:
4460: # 1 - indicating processing should continue.
4461: # Side effects
4462: # reply (& separated list of msgid=messageinfo pairs) is
4463: # written to $client.
4464: #
4465: sub dump_dcmail_handler {
4466: my ($cmd, $tail, $client) = @_;
4467:
4468: my $userinput = "$cmd:$tail";
4469: my ($udom,$startfilter,$endfilter,$sendersfilter) = split(/:/,$tail);
4470: chomp($sendersfilter);
4471: my @senders = ();
4472: if (defined($startfilter)) {
4473: $startfilter=&unescape($startfilter);
4474: } else {
4475: $startfilter='.';
4476: }
4477: if (defined($endfilter)) {
4478: $endfilter=&unescape($endfilter);
4479: } else {
4480: $endfilter='.';
4481: }
4482: if (defined($sendersfilter)) {
4483: $sendersfilter=&unescape($sendersfilter);
1.300 albertel 4484: @senders = map { &unescape($_) } split(/\&/,$sendersfilter);
1.299 raeburn 4485: }
4486:
4487: my $qresult='';
4488: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
4489: if ($hashref) {
4490: while (my ($key,$value) = each(%$hashref)) {
4491: my $match = 1;
1.303 albertel 4492: my ($timestamp,$subj,$uname,$udom) =
4493: split(/:/,&unescape(&unescape($key)),5); # yes, twice really
1.299 raeburn 4494: $subj = &unescape($subj);
4495: unless ($startfilter eq '.' || !defined($startfilter)) {
4496: if ($timestamp < $startfilter) {
4497: $match = 0;
4498: }
4499: }
4500: unless ($endfilter eq '.' || !defined($endfilter)) {
4501: if ($timestamp > $endfilter) {
4502: $match = 0;
4503: }
4504: }
4505: unless (@senders < 1) {
4506: unless (grep/^$uname:$udom$/,@senders) {
4507: $match = 0;
4508: }
4509: }
4510: if ($match == 1) {
4511: $qresult.=$key.'='.$value.'&';
4512: }
4513: }
1.311 albertel 4514: if (&untie_domain_hash($hashref)) {
1.299 raeburn 4515: chop($qresult);
1.387 albertel 4516: &Reply($client, \$qresult, $userinput);
1.299 raeburn 4517: } else {
4518: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4519: "while attempting dcmaildump\n", $userinput);
4520: }
4521: } else {
4522: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4523: "while attempting dcmaildump\n", $userinput);
4524: }
4525: return 1;
4526: }
4527:
4528: ®ister_handler("dcmaildump", \&dump_dcmail_handler, 0, 1, 0);
4529:
4530: #
4531: # Puts domain roles in nohist_domainroles database
4532: #
4533: # Parameters
4534: # $cmd - Command keyword that caused us to be dispatched.
4535: # $tail - Tail of the command. Consists of a colon separated:
4536: # domain - the domain whose roles we are recording
4537: # role - Consists of key=value pair
4538: # where key is unique role
4539: # and value is start/end date information
4540: # $client - Socket open on the client.
4541: #
4542: # Returns:
4543: # 1 - indicating processing should continue.
4544: # Side effects
4545: # reply is written to $client.
4546: #
4547:
4548: sub put_domainroles_handler {
4549: my ($cmd,$tail,$client) = @_;
4550:
4551: my $userinput = "$cmd:$tail";
4552: my ($udom,$what)=split(/:/,$tail);
4553: chomp($what);
4554: my @pairs=split(/\&/,$what);
4555: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
4556: if ($hashref) {
4557: foreach my $pair (@pairs) {
4558: my ($key,$value)=split(/=/,$pair);
4559: $hashref->{$key}=$value;
4560: }
1.311 albertel 4561: if (&untie_domain_hash($hashref)) {
1.299 raeburn 4562: &Reply($client, "ok\n", $userinput);
4563: } else {
4564: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4565: "while attempting domroleput\n", $userinput);
4566: }
4567: } else {
4568: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
4569: "while attempting domroleput\n", $userinput);
4570: }
4571:
4572: return 1;
4573: }
4574:
4575: ®ister_handler("domroleput", \&put_domainroles_handler, 0, 1, 0);
4576:
4577: #
4578: # Retrieves domain roles from nohist_domainroles database
4579: # Returns to client an & separated list of key=value pairs,
4580: # where key is role and value is start and end date information.
4581: #
4582: # Parameters
4583: # $cmd - Command keyword that caused us to be dispatched.
4584: # $tail - Tail of the command. Consists of a colon separated:
4585: # domain - the domain whose domain roles table we dump
4586: # $client - Socket open on the client.
4587: #
4588: # Returns:
4589: # 1 - indicating processing should continue.
4590: # Side effects
4591: # reply (& separated list of role=start/end info pairs) is
4592: # written to $client.
4593: #
4594: sub dump_domainroles_handler {
4595: my ($cmd, $tail, $client) = @_;
4596:
4597: my $userinput = "$cmd:$tail";
4598: my ($udom,$startfilter,$endfilter,$rolesfilter) = split(/:/,$tail);
4599: chomp($rolesfilter);
4600: my @roles = ();
4601: if (defined($startfilter)) {
4602: $startfilter=&unescape($startfilter);
4603: } else {
4604: $startfilter='.';
4605: }
4606: if (defined($endfilter)) {
4607: $endfilter=&unescape($endfilter);
4608: } else {
4609: $endfilter='.';
4610: }
4611: if (defined($rolesfilter)) {
4612: $rolesfilter=&unescape($rolesfilter);
1.300 albertel 4613: @roles = split(/\&/,$rolesfilter);
1.299 raeburn 4614: }
1.421 raeburn 4615:
1.299 raeburn 4616: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
4617: if ($hashref) {
4618: my $qresult = '';
4619: while (my ($key,$value) = each(%$hashref)) {
4620: my $match = 1;
1.421 raeburn 4621: my ($end,$start) = split(/:/,&unescape($value));
1.299 raeburn 4622: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,&unescape($key));
1.421 raeburn 4623: unless (@roles < 1) {
4624: unless (grep/^\Q$trole\E$/,@roles) {
4625: $match = 0;
4626: next;
4627: }
4628: }
1.299 raeburn 4629: unless ($startfilter eq '.' || !defined($startfilter)) {
1.415 raeburn 4630: if ((defined($start)) && ($start >= $startfilter)) {
1.299 raeburn 4631: $match = 0;
1.421 raeburn 4632: next;
1.299 raeburn 4633: }
4634: }
4635: unless ($endfilter eq '.' || !defined($endfilter)) {
1.421 raeburn 4636: if ((defined($end)) && (($end > 0) && ($end <= $endfilter))) {
1.299 raeburn 4637: $match = 0;
1.421 raeburn 4638: next;
1.299 raeburn 4639: }
4640: }
4641: if ($match == 1) {
4642: $qresult.=$key.'='.$value.'&';
4643: }
4644: }
1.311 albertel 4645: if (&untie_domain_hash($hashref)) {
1.299 raeburn 4646: chop($qresult);
1.387 albertel 4647: &Reply($client, \$qresult, $userinput);
1.299 raeburn 4648: } else {
4649: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4650: "while attempting domrolesdump\n", $userinput);
4651: }
4652: } else {
4653: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4654: "while attempting domrolesdump\n", $userinput);
4655: }
4656: return 1;
4657: }
4658:
4659: ®ister_handler("domrolesdump", \&dump_domainroles_handler, 0, 1, 0);
4660:
4661:
1.238 foxr 4662: # Process the tmpput command I'm not sure what this does.. Seems to
4663: # create a file in the lonDaemons/tmp directory of the form $id.tmp
4664: # where Id is the client's ip concatenated with a sequence number.
4665: # The file will contain some value that is passed in. Is this e.g.
4666: # a login token?
4667: #
4668: # Parameters:
4669: # $cmd - The command that got us dispatched.
4670: # $tail - The remainder of the request following $cmd:
4671: # In this case this will be the contents of the file.
4672: # $client - Socket connected to the client.
4673: # Returns:
4674: # 1 indicating processing can continue.
4675: # Side effects:
4676: # A file is created in the local filesystem.
4677: # A reply is sent to the client.
4678: sub tmp_put_handler {
4679: my ($cmd, $what, $client) = @_;
4680:
4681: my $userinput = "$cmd:$what"; # Reconstruct for logging.
4682:
1.347 raeburn 4683: my ($record,$context) = split(/:/,$what);
4684: if ($context ne '') {
4685: chomp($context);
4686: $context = &unescape($context);
4687: }
4688: my ($id,$store);
1.238 foxr 4689: $tmpsnum++;
1.454 raeburn 4690: if (($context eq 'resetpw') || ($context eq 'createaccount')) {
1.347 raeburn 4691: $id = &md5_hex(&md5_hex(time.{}.rand().$$));
4692: } else {
4693: $id = $$.'_'.$clientip.'_'.$tmpsnum;
4694: }
1.238 foxr 4695: $id=~s/\W/\_/g;
1.347 raeburn 4696: $record=~s/\n//g;
1.238 foxr 4697: my $execdir=$perlvar{'lonDaemons'};
4698: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
1.347 raeburn 4699: print $store $record;
1.238 foxr 4700: close $store;
1.387 albertel 4701: &Reply($client, \$id, $userinput);
1.238 foxr 4702: } else {
4703: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
4704: "while attempting tmpput\n", $userinput);
4705: }
4706: return 1;
4707:
4708: }
4709: ®ister_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
1.263 albertel 4710:
1.238 foxr 4711: # Processes the tmpget command. This command returns the contents
4712: # of a temporary resource file(?) created via tmpput.
4713: #
4714: # Paramters:
4715: # $cmd - Command that got us dispatched.
4716: # $id - Tail of the command, contain the id of the resource
4717: # we want to fetch.
4718: # $client - socket open on the client.
4719: # Return:
4720: # 1 - Inidcating processing can continue.
4721: # Side effects:
4722: # A reply is sent to the client.
4723: #
4724: sub tmp_get_handler {
4725: my ($cmd, $id, $client) = @_;
4726:
4727: my $userinput = "$cmd:$id";
4728:
4729:
4730: $id=~s/\W/\_/g;
4731: my $store;
4732: my $execdir=$perlvar{'lonDaemons'};
4733: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
4734: my $reply=<$store>;
1.387 albertel 4735: &Reply( $client, \$reply, $userinput);
1.238 foxr 4736: close $store;
4737: } else {
4738: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
4739: "while attempting tmpget\n", $userinput);
4740: }
4741:
4742: return 1;
4743: }
4744: ®ister_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
1.263 albertel 4745:
1.238 foxr 4746: #
4747: # Process the tmpdel command. This command deletes a temp resource
4748: # created by the tmpput command.
4749: #
4750: # Parameters:
4751: # $cmd - Command that got us here.
4752: # $id - Id of the temporary resource created.
4753: # $client - socket open on the client process.
4754: #
4755: # Returns:
4756: # 1 - Indicating processing should continue.
4757: # Side Effects:
4758: # A file is deleted
4759: # A reply is sent to the client.
4760: sub tmp_del_handler {
4761: my ($cmd, $id, $client) = @_;
4762:
4763: my $userinput= "$cmd:$id";
4764:
4765: chomp($id);
4766: $id=~s/\W/\_/g;
4767: my $execdir=$perlvar{'lonDaemons'};
4768: if (unlink("$execdir/tmp/$id.tmp")) {
4769: &Reply($client, "ok\n", $userinput);
4770: } else {
4771: &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
4772: "while attempting tmpdel\n", $userinput);
4773: }
4774:
4775: return 1;
4776:
4777: }
4778: ®ister_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
1.263 albertel 4779:
1.238 foxr 4780: #
1.246 foxr 4781: # Processes the setannounce command. This command
4782: # creates a file named announce.txt in the top directory of
4783: # the documentn root and sets its contents. The announce.txt file is
4784: # printed in its entirety at the LonCAPA login page. Note:
4785: # once the announcement.txt fileis created it cannot be deleted.
4786: # However, setting the contents of the file to empty removes the
4787: # announcement from the login page of loncapa so who cares.
4788: #
4789: # Parameters:
4790: # $cmd - The command that got us dispatched.
4791: # $announcement - The text of the announcement.
4792: # $client - Socket open on the client process.
4793: # Retunrns:
4794: # 1 - Indicating request processing should continue
4795: # Side Effects:
4796: # The file {DocRoot}/announcement.txt is created.
4797: # A reply is sent to $client.
4798: #
4799: sub set_announce_handler {
4800: my ($cmd, $announcement, $client) = @_;
4801:
4802: my $userinput = "$cmd:$announcement";
4803:
4804: chomp($announcement);
4805: $announcement=&unescape($announcement);
4806: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
4807: '/announcement.txt')) {
4808: print $store $announcement;
4809: close $store;
4810: &Reply($client, "ok\n", $userinput);
4811: } else {
4812: &Failure($client, "error: ".($!+0)."\n", $userinput);
4813: }
4814:
4815: return 1;
4816: }
4817: ®ister_handler("setannounce", \&set_announce_handler, 0, 1, 0);
1.263 albertel 4818:
1.246 foxr 4819: #
4820: # Return the version of the daemon. This can be used to determine
4821: # the compatibility of cross version installations or, alternatively to
4822: # simply know who's out of date and who isn't. Note that the version
4823: # is returned concatenated with the tail.
4824: # Parameters:
4825: # $cmd - the request that dispatched to us.
4826: # $tail - Tail of the request (client's version?).
4827: # $client - Socket open on the client.
4828: #Returns:
4829: # 1 - continue processing requests.
4830: # Side Effects:
4831: # Replies with version to $client.
4832: sub get_version_handler {
4833: my ($cmd, $tail, $client) = @_;
4834:
4835: my $userinput = $cmd.$tail;
4836:
4837: &Reply($client, &version($userinput)."\n", $userinput);
4838:
4839:
4840: return 1;
4841: }
4842: ®ister_handler("version", \&get_version_handler, 0, 1, 0);
1.263 albertel 4843:
1.246 foxr 4844: # Set the current host and domain. This is used to support
4845: # multihomed systems. Each IP of the system, or even separate daemons
4846: # on the same IP can be treated as handling a separate lonCAPA virtual
4847: # machine. This command selects the virtual lonCAPA. The client always
4848: # knows the right one since it is lonc and it is selecting the domain/system
4849: # from the hosts.tab file.
4850: # Parameters:
4851: # $cmd - Command that dispatched us.
4852: # $tail - Tail of the command (domain/host requested).
4853: # $socket - Socket open on the client.
4854: #
4855: # Returns:
4856: # 1 - Indicates the program should continue to process requests.
4857: # Side-effects:
4858: # The default domain/system context is modified for this daemon.
4859: # a reply is sent to the client.
4860: #
4861: sub set_virtual_host_handler {
4862: my ($cmd, $tail, $socket) = @_;
4863:
4864: my $userinput ="$cmd:$tail";
4865:
4866: &Reply($client, &sethost($userinput)."\n", $userinput);
4867:
4868:
4869: return 1;
4870: }
1.247 albertel 4871: ®ister_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
1.246 foxr 4872:
4873: # Process a request to exit:
4874: # - "bye" is sent to the client.
4875: # - The client socket is shutdown and closed.
4876: # - We indicate to the caller that we should exit.
4877: # Formal Parameters:
4878: # $cmd - The command that got us here.
4879: # $tail - Tail of the command (empty).
4880: # $client - Socket open on the tail.
4881: # Returns:
4882: # 0 - Indicating the program should exit!!
4883: #
4884: sub exit_handler {
4885: my ($cmd, $tail, $client) = @_;
4886:
4887: my $userinput = "$cmd:$tail";
4888:
4889: &logthis("Client $clientip ($clientname) hanging up: $userinput");
4890: &Reply($client, "bye\n", $userinput);
4891: $client->shutdown(2); # shutdown the socket forcibly.
4892: $client->close();
4893:
4894: return 0;
4895: }
1.248 foxr 4896: ®ister_handler("exit", \&exit_handler, 0,1,1);
4897: ®ister_handler("init", \&exit_handler, 0,1,1);
4898: ®ister_handler("quit", \&exit_handler, 0,1,1);
4899:
4900: # Determine if auto-enrollment is enabled.
4901: # Note that the original had what I believe to be a defect.
4902: # The original returned 0 if the requestor was not a registerd client.
4903: # It should return "refused".
4904: # Formal Parameters:
4905: # $cmd - The command that invoked us.
4906: # $tail - The tail of the command (Extra command parameters.
4907: # $client - The socket open on the client that issued the request.
4908: # Returns:
4909: # 1 - Indicating processing should continue.
4910: #
4911: sub enrollment_enabled_handler {
4912: my ($cmd, $tail, $client) = @_;
4913: my $userinput = $cmd.":".$tail; # For logging purposes.
4914:
4915:
1.337 albertel 4916: my ($cdom) = split(/:/, $tail, 2); # Domain we're asking about.
4917:
1.248 foxr 4918: my $outcome = &localenroll::run($cdom);
1.387 albertel 4919: &Reply($client, \$outcome, $userinput);
1.248 foxr 4920:
4921: return 1;
4922: }
4923: ®ister_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
4924:
1.417 raeburn 4925: #
1.423 raeburn 4926: # Validate an institutional code used for a LON-CAPA course.
1.417 raeburn 4927: #
4928: # Formal Parameters:
4929: # $cmd - The command request that got us dispatched.
4930: # $tail - The tail of the command. In this case,
4931: # this is a colon separated set of words that will be split
4932: # into:
1.424 raeburn 4933: # $dom - The domain for which the check of
4934: # institutional course code will occur.
4935: #
4936: # $instcode - The institutional code for the course
4937: # being requested, or validated for rights
4938: # to request.
4939: #
4940: # $owner - The course requestor (who will be the
4941: # course owner, in the form username:domain
4942: #
1.417 raeburn 4943: # $client - Socket open on the client.
4944: # Returns:
4945: # 1 - Indicating processing should continue.
4946: #
4947: sub validate_instcode_handler {
4948: my ($cmd, $tail, $client) = @_;
4949: my $userinput = "$cmd:$tail";
1.423 raeburn 4950: my ($dom,$instcode,$owner) = split(/:/, $tail);
1.422 raeburn 4951: $instcode = &unescape($instcode);
4952: $owner = &unescape($owner);
1.426 raeburn 4953: my ($outcome,$description) =
4954: &localenroll::validate_instcode($dom,$instcode,$owner);
4955: my $result = &escape($outcome).'&'.&escape($description);
4956: &Reply($client, \$result, $userinput);
1.417 raeburn 4957:
4958: return 1;
4959: }
4960: ®ister_handler("autovalidateinstcode", \&validate_instcode_handler, 0, 1, 0);
4961:
1.248 foxr 4962: # Get the official sections for which auto-enrollment is possible.
4963: # Since the admin people won't know about 'unofficial sections'
4964: # we cannot auto-enroll on them.
4965: # Formal Parameters:
4966: # $cmd - The command request that got us dispatched here.
4967: # $tail - The remainder of the request. In our case this
4968: # will be split into:
4969: # $coursecode - The course name from the admin point of view.
4970: # $cdom - The course's domain(?).
4971: # $client - Socket open on the client.
4972: # Returns:
4973: # 1 - Indiciting processing should continue.
4974: #
4975: sub get_sections_handler {
4976: my ($cmd, $tail, $client) = @_;
4977: my $userinput = "$cmd:$tail";
4978:
4979: my ($coursecode, $cdom) = split(/:/, $tail);
4980: my @secs = &localenroll::get_sections($coursecode,$cdom);
4981: my $seclist = &escape(join(':',@secs));
4982:
1.387 albertel 4983: &Reply($client, \$seclist, $userinput);
1.248 foxr 4984:
4985:
4986: return 1;
4987: }
4988: ®ister_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
4989:
4990: # Validate the owner of a new course section.
4991: #
4992: # Formal Parameters:
4993: # $cmd - Command that got us dispatched.
4994: # $tail - the remainder of the command. For us this consists of a
4995: # colon separated string containing:
4996: # $inst - Course Id from the institutions point of view.
4997: # $owner - Proposed owner of the course.
4998: # $cdom - Domain of the course (from the institutions
4999: # point of view?)..
5000: # $client - Socket open on the client.
5001: #
5002: # Returns:
5003: # 1 - Processing should continue.
5004: #
5005: sub validate_course_owner_handler {
5006: my ($cmd, $tail, $client) = @_;
5007: my $userinput = "$cmd:$tail";
5008: my ($inst_course_id, $owner, $cdom) = split(/:/, $tail);
5009:
1.336 raeburn 5010: $owner = &unescape($owner);
1.248 foxr 5011: my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
1.387 albertel 5012: &Reply($client, \$outcome, $userinput);
1.248 foxr 5013:
5014:
5015:
5016: return 1;
5017: }
5018: ®ister_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
1.263 albertel 5019:
1.248 foxr 5020: #
5021: # Validate a course section in the official schedule of classes
5022: # from the institutions point of view (part of autoenrollment).
5023: #
5024: # Formal Parameters:
5025: # $cmd - The command request that got us dispatched.
5026: # $tail - The tail of the command. In this case,
5027: # this is a colon separated set of words that will be split
5028: # into:
5029: # $inst_course_id - The course/section id from the
5030: # institutions point of view.
5031: # $cdom - The domain from the institutions
5032: # point of view.
5033: # $client - Socket open on the client.
5034: # Returns:
5035: # 1 - Indicating processing should continue.
5036: #
5037: sub validate_course_section_handler {
5038: my ($cmd, $tail, $client) = @_;
5039: my $userinput = "$cmd:$tail";
5040: my ($inst_course_id, $cdom) = split(/:/, $tail);
5041:
5042: my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
1.387 albertel 5043: &Reply($client, \$outcome, $userinput);
1.248 foxr 5044:
5045:
5046: return 1;
5047: }
5048: ®ister_handler("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
5049:
5050: #
1.340 raeburn 5051: # Validate course owner's access to enrollment data for specific class section.
5052: #
5053: #
5054: # Formal Parameters:
5055: # $cmd - The command request that got us dispatched.
5056: # $tail - The tail of the command. In this case this is a colon separated
5057: # set of words that will be split into:
5058: # $inst_class - Institutional code for the specific class section
5059: # $courseowner - The escaped username:domain of the course owner
5060: # $cdom - The domain of the course from the institution's
5061: # point of view.
5062: # $client - The socket open on the client.
5063: # Returns:
5064: # 1 - continue processing.
5065: #
5066:
5067: sub validate_class_access_handler {
5068: my ($cmd, $tail, $client) = @_;
5069: my $userinput = "$cmd:$tail";
1.383 raeburn 5070: my ($inst_class,$ownerlist,$cdom) = split(/:/, $tail);
1.392 raeburn 5071: my $owners = &unescape($ownerlist);
1.341 albertel 5072: my $outcome;
5073: eval {
5074: local($SIG{__DIE__})='DEFAULT';
1.392 raeburn 5075: $outcome=&localenroll::check_section($inst_class,$owners,$cdom);
1.341 albertel 5076: };
1.387 albertel 5077: &Reply($client,\$outcome, $userinput);
1.340 raeburn 5078:
5079: return 1;
5080: }
5081: ®ister_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
5082:
5083: #
5084: # Create a password for a new LON-CAPA user added by auto-enrollment.
5085: # Only used for case where authentication method for new user is localauth
1.248 foxr 5086: #
5087: # Formal Parameters:
5088: # $cmd - The command request that got us dispatched.
5089: # $tail - The tail of the command. In this case this is a colon separated
5090: # set of words that will be split into:
1.340 raeburn 5091: # $authparam - An authentication parameter (localauth parameter).
1.248 foxr 5092: # $cdom - The domain of the course from the institution's
5093: # point of view.
5094: # $client - The socket open on the client.
5095: # Returns:
5096: # 1 - continue processing.
5097: #
5098: sub create_auto_enroll_password_handler {
5099: my ($cmd, $tail, $client) = @_;
5100: my $userinput = "$cmd:$tail";
5101:
5102: my ($authparam, $cdom) = split(/:/, $userinput);
5103:
5104: my ($create_passwd,$authchk);
5105: ($authparam,
5106: $create_passwd,
5107: $authchk) = &localenroll::create_password($authparam,$cdom);
5108:
5109: &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
5110: $userinput);
5111:
5112:
5113: return 1;
5114: }
5115: ®ister_handler("autocreatepassword", \&create_auto_enroll_password_handler,
5116: 0, 1, 0);
5117:
5118: # Retrieve and remove temporary files created by/during autoenrollment.
5119: #
5120: # Formal Parameters:
5121: # $cmd - The command that got us dispatched.
5122: # $tail - The tail of the command. In our case this is a colon
5123: # separated list that will be split into:
5124: # $filename - The name of the file to remove.
5125: # The filename is given as a path relative to
5126: # the LonCAPA temp file directory.
5127: # $client - Socket open on the client.
5128: #
5129: # Returns:
5130: # 1 - Continue processing.
5131: sub retrieve_auto_file_handler {
5132: my ($cmd, $tail, $client) = @_;
5133: my $userinput = "cmd:$tail";
5134:
5135: my ($filename) = split(/:/, $tail);
5136:
5137: my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
5138: if ( (-e $source) && ($filename ne '') ) {
5139: my $reply = '';
5140: if (open(my $fh,$source)) {
5141: while (<$fh>) {
5142: chomp($_);
5143: $_ =~ s/^\s+//g;
5144: $_ =~ s/\s+$//g;
5145: $reply .= $_;
5146: }
5147: close($fh);
5148: &Reply($client, &escape($reply)."\n", $userinput);
5149:
5150: # Does this have to be uncommented??!? (RF).
5151: #
5152: # unlink($source);
5153: } else {
5154: &Failure($client, "error\n", $userinput);
5155: }
5156: } else {
5157: &Failure($client, "error\n", $userinput);
5158: }
5159:
5160:
5161: return 1;
5162: }
5163: ®ister_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
5164:
1.423 raeburn 5165: sub crsreq_checks_handler {
5166: my ($cmd, $tail, $client) = @_;
5167: my $userinput = "$cmd:$tail";
5168: my $dom = $tail;
5169: my $result;
1.424 raeburn 5170: my @reqtypes = ('official','unofficial','community');
1.423 raeburn 5171: eval {
5172: local($SIG{__DIE__})='DEFAULT';
5173: my %validations;
1.424 raeburn 5174: my $response = &localenroll::crsreq_checks($dom,\@reqtypes,
5175: \%validations);
1.423 raeburn 5176: if ($response eq 'ok') {
5177: foreach my $key (keys(%validations)) {
5178: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($validations{$key}).'&';
5179: }
5180: $result =~ s/\&$//;
5181: } else {
5182: $result = 'error';
5183: }
5184: };
5185: if (!$@) {
5186: &Reply($client, \$result, $userinput);
5187: } else {
5188: &Failure($client,"unknown_cmd\n",$userinput);
5189: }
5190: return 1;
5191: }
5192: ®ister_handler("autocrsreqchecks", \&crsreq_checks_handler, 0, 1, 0);
5193:
5194: sub validate_crsreq_handler {
5195: my ($cmd, $tail, $client) = @_;
5196: my $userinput = "$cmd:$tail";
5197: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = split(/:/, $tail);
5198: $instcode = &unescape($instcode);
5199: $owner = &unescape($owner);
5200: $crstype = &unescape($crstype);
5201: $inststatuslist = &unescape($inststatuslist);
5202: $instcode = &unescape($instcode);
5203: $instseclist = &unescape($instseclist);
5204: my $outcome;
5205: eval {
5206: local($SIG{__DIE__})='DEFAULT';
5207: $outcome = &localenroll::validate_crsreq($dom,$owner,$crstype,
5208: $inststatuslist,$instcode,
5209: $instseclist);
5210: };
5211: if (!$@) {
5212: &Reply($client, \$outcome, $userinput);
5213: } else {
5214: &Failure($client,"unknown_cmd\n",$userinput);
5215: }
5216: return 1;
5217: }
5218: ®ister_handler("autocrsreqvalidation", \&validate_crsreq_handler, 0, 1, 0);
5219:
1.248 foxr 5220: #
5221: # Read and retrieve institutional code format (for support form).
5222: # Formal Parameters:
5223: # $cmd - Command that dispatched us.
5224: # $tail - Tail of the command. In this case it conatins
5225: # the course domain and the coursename.
5226: # $client - Socket open on the client.
5227: # Returns:
5228: # 1 - Continue processing.
5229: #
5230: sub get_institutional_code_format_handler {
5231: my ($cmd, $tail, $client) = @_;
5232: my $userinput = "$cmd:$tail";
5233:
5234: my $reply;
5235: my($cdom,$course) = split(/:/,$tail);
5236: my @pairs = split/\&/,$course;
5237: my %instcodes = ();
5238: my %codes = ();
5239: my @codetitles = ();
5240: my %cat_titles = ();
5241: my %cat_order = ();
5242: foreach (@pairs) {
5243: my ($key,$value) = split/=/,$_;
5244: $instcodes{&unescape($key)} = &unescape($value);
5245: }
5246: my $formatreply = &localenroll::instcode_format($cdom,
5247: \%instcodes,
5248: \%codes,
5249: \@codetitles,
5250: \%cat_titles,
5251: \%cat_order);
5252: if ($formatreply eq 'ok') {
1.365 albertel 5253: my $codes_str = &Apache::lonnet::hash2str(%codes);
5254: my $codetitles_str = &Apache::lonnet::array2str(@codetitles);
5255: my $cat_titles_str = &Apache::lonnet::hash2str(%cat_titles);
5256: my $cat_order_str = &Apache::lonnet::hash2str(%cat_order);
1.248 foxr 5257: &Reply($client,
5258: $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'
5259: .$cat_order_str."\n",
5260: $userinput);
5261: } else {
5262: # this else branch added by RF since if not ok, lonc will
5263: # hang waiting on reply until timeout.
5264: #
5265: &Reply($client, "format_error\n", $userinput);
5266: }
5267:
5268: return 1;
5269: }
1.265 albertel 5270: ®ister_handler("autoinstcodeformat",
5271: \&get_institutional_code_format_handler,0,1,0);
1.246 foxr 5272:
1.345 raeburn 5273: sub get_institutional_defaults_handler {
5274: my ($cmd, $tail, $client) = @_;
5275: my $userinput = "$cmd:$tail";
5276:
5277: my $dom = $tail;
5278: my %defaults_hash;
5279: my @code_order;
5280: my $outcome;
5281: eval {
5282: local($SIG{__DIE__})='DEFAULT';
5283: $outcome = &localenroll::instcode_defaults($dom,\%defaults_hash,
5284: \@code_order);
5285: };
5286: if (!$@) {
5287: if ($outcome eq 'ok') {
5288: my $result='';
5289: while (my ($key,$value) = each(%defaults_hash)) {
5290: $result.=&escape($key).'='.&escape($value).'&';
5291: }
5292: $result .= 'code_order='.&escape(join('&',@code_order));
1.387 albertel 5293: &Reply($client,\$result,$userinput);
1.345 raeburn 5294: } else {
5295: &Reply($client,"error\n", $userinput);
5296: }
5297: } else {
5298: &Failure($client,"unknown_cmd\n",$userinput);
5299: }
5300: }
5301: ®ister_handler("autoinstcodedefaults",
5302: \&get_institutional_defaults_handler,0,1,0);
5303:
1.416 raeburn 5304: sub get_possible_instcodes_handler {
5305: my ($cmd, $tail, $client) = @_;
5306: my $userinput = "$cmd:$tail";
5307:
5308: my $reply;
5309: my $cdom = $tail;
1.417 raeburn 5310: my (@codetitles,%cat_titles,%cat_order,@code_order);
1.416 raeburn 5311: my $formatreply = &localenroll::possible_instcodes($cdom,
5312: \@codetitles,
5313: \%cat_titles,
1.417 raeburn 5314: \%cat_order,
5315: \@code_order);
1.416 raeburn 5316: if ($formatreply eq 'ok') {
5317: my $result = join('&',map {&escape($_);} (@codetitles)).':';
1.417 raeburn 5318: $result .= join('&',map {&escape($_);} (@code_order)).':';
1.416 raeburn 5319: foreach my $key (keys(%cat_titles)) {
5320: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_titles{$key}).'&';
5321: }
5322: $result =~ s/\&$//;
5323: $result .= ':';
5324: foreach my $key (keys(%cat_order)) {
5325: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_order{$key}).'&';
5326: }
5327: $result =~ s/\&$//;
5328: &Reply($client,\$result,$userinput);
5329: } else {
5330: &Reply($client, "format_error\n", $userinput);
5331: }
5332: return 1;
5333: }
5334: ®ister_handler("autopossibleinstcodes",
5335: \&get_possible_instcodes_handler,0,1,0);
5336:
1.381 raeburn 5337: sub get_institutional_user_rules {
5338: my ($cmd, $tail, $client) = @_;
5339: my $userinput = "$cmd:$tail";
5340: my $dom = &unescape($tail);
5341: my (%rules_hash,@rules_order);
5342: my $outcome;
5343: eval {
5344: local($SIG{__DIE__})='DEFAULT';
5345: $outcome = &localenroll::username_rules($dom,\%rules_hash,\@rules_order);
5346: };
5347: if (!$@) {
5348: if ($outcome eq 'ok') {
5349: my $result;
5350: foreach my $key (keys(%rules_hash)) {
5351: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
5352: }
5353: $result =~ s/\&$//;
5354: $result .= ':';
5355: if (@rules_order > 0) {
5356: foreach my $item (@rules_order) {
5357: $result .= &escape($item).'&';
5358: }
5359: }
5360: $result =~ s/\&$//;
1.387 albertel 5361: &Reply($client,\$result,$userinput);
1.381 raeburn 5362: } else {
5363: &Reply($client,"error\n", $userinput);
5364: }
5365: } else {
5366: &Failure($client,"unknown_cmd\n",$userinput);
5367: }
5368: }
5369: ®ister_handler("instuserrules",\&get_institutional_user_rules,0,1,0);
5370:
1.389 raeburn 5371: sub get_institutional_id_rules {
5372: my ($cmd, $tail, $client) = @_;
5373: my $userinput = "$cmd:$tail";
5374: my $dom = &unescape($tail);
5375: my (%rules_hash,@rules_order);
5376: my $outcome;
5377: eval {
5378: local($SIG{__DIE__})='DEFAULT';
5379: $outcome = &localenroll::id_rules($dom,\%rules_hash,\@rules_order);
5380: };
5381: if (!$@) {
5382: if ($outcome eq 'ok') {
5383: my $result;
5384: foreach my $key (keys(%rules_hash)) {
5385: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
5386: }
5387: $result =~ s/\&$//;
5388: $result .= ':';
5389: if (@rules_order > 0) {
5390: foreach my $item (@rules_order) {
5391: $result .= &escape($item).'&';
5392: }
5393: }
5394: $result =~ s/\&$//;
5395: &Reply($client,\$result,$userinput);
5396: } else {
5397: &Reply($client,"error\n", $userinput);
5398: }
5399: } else {
5400: &Failure($client,"unknown_cmd\n",$userinput);
5401: }
5402: }
5403: ®ister_handler("instidrules",\&get_institutional_id_rules,0,1,0);
5404:
1.397 raeburn 5405: sub get_institutional_selfcreate_rules {
1.396 raeburn 5406: my ($cmd, $tail, $client) = @_;
5407: my $userinput = "$cmd:$tail";
5408: my $dom = &unescape($tail);
5409: my (%rules_hash,@rules_order);
5410: my $outcome;
5411: eval {
5412: local($SIG{__DIE__})='DEFAULT';
1.397 raeburn 5413: $outcome = &localenroll::selfcreate_rules($dom,\%rules_hash,\@rules_order);
1.396 raeburn 5414: };
5415: if (!$@) {
5416: if ($outcome eq 'ok') {
5417: my $result;
5418: foreach my $key (keys(%rules_hash)) {
5419: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
5420: }
5421: $result =~ s/\&$//;
5422: $result .= ':';
5423: if (@rules_order > 0) {
5424: foreach my $item (@rules_order) {
5425: $result .= &escape($item).'&';
5426: }
5427: }
5428: $result =~ s/\&$//;
5429: &Reply($client,\$result,$userinput);
5430: } else {
5431: &Reply($client,"error\n", $userinput);
5432: }
5433: } else {
5434: &Failure($client,"unknown_cmd\n",$userinput);
5435: }
5436: }
1.397 raeburn 5437: ®ister_handler("instemailrules",\&get_institutional_selfcreate_rules,0,1,0);
1.396 raeburn 5438:
1.381 raeburn 5439:
5440: sub institutional_username_check {
5441: my ($cmd, $tail, $client) = @_;
5442: my $userinput = "$cmd:$tail";
5443: my %rulecheck;
5444: my $outcome;
5445: my ($udom,$uname,@rules) = split(/:/,$tail);
5446: $udom = &unescape($udom);
5447: $uname = &unescape($uname);
5448: @rules = map {&unescape($_);} (@rules);
5449: eval {
5450: local($SIG{__DIE__})='DEFAULT';
5451: $outcome = &localenroll::username_check($udom,$uname,\@rules,\%rulecheck);
5452: };
5453: if (!$@) {
5454: if ($outcome eq 'ok') {
5455: my $result='';
5456: foreach my $key (keys(%rulecheck)) {
5457: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
5458: }
1.387 albertel 5459: &Reply($client,\$result,$userinput);
1.381 raeburn 5460: } else {
5461: &Reply($client,"error\n", $userinput);
5462: }
5463: } else {
5464: &Failure($client,"unknown_cmd\n",$userinput);
5465: }
5466: }
5467: ®ister_handler("instrulecheck",\&institutional_username_check,0,1,0);
5468:
1.389 raeburn 5469: sub institutional_id_check {
5470: my ($cmd, $tail, $client) = @_;
5471: my $userinput = "$cmd:$tail";
5472: my %rulecheck;
5473: my $outcome;
5474: my ($udom,$id,@rules) = split(/:/,$tail);
5475: $udom = &unescape($udom);
5476: $id = &unescape($id);
5477: @rules = map {&unescape($_);} (@rules);
5478: eval {
5479: local($SIG{__DIE__})='DEFAULT';
5480: $outcome = &localenroll::id_check($udom,$id,\@rules,\%rulecheck);
5481: };
5482: if (!$@) {
5483: if ($outcome eq 'ok') {
5484: my $result='';
5485: foreach my $key (keys(%rulecheck)) {
5486: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
5487: }
5488: &Reply($client,\$result,$userinput);
5489: } else {
5490: &Reply($client,"error\n", $userinput);
5491: }
5492: } else {
5493: &Failure($client,"unknown_cmd\n",$userinput);
5494: }
5495: }
5496: ®ister_handler("instidrulecheck",\&institutional_id_check,0,1,0);
1.345 raeburn 5497:
1.397 raeburn 5498: sub institutional_selfcreate_check {
1.396 raeburn 5499: my ($cmd, $tail, $client) = @_;
5500: my $userinput = "$cmd:$tail";
5501: my %rulecheck;
5502: my $outcome;
5503: my ($udom,$email,@rules) = split(/:/,$tail);
5504: $udom = &unescape($udom);
5505: $email = &unescape($email);
5506: @rules = map {&unescape($_);} (@rules);
5507: eval {
5508: local($SIG{__DIE__})='DEFAULT';
1.397 raeburn 5509: $outcome = &localenroll::selfcreate_check($udom,$email,\@rules,\%rulecheck);
1.396 raeburn 5510: };
5511: if (!$@) {
5512: if ($outcome eq 'ok') {
5513: my $result='';
5514: foreach my $key (keys(%rulecheck)) {
5515: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
5516: }
5517: &Reply($client,\$result,$userinput);
5518: } else {
5519: &Reply($client,"error\n", $userinput);
5520: }
5521: } else {
5522: &Failure($client,"unknown_cmd\n",$userinput);
5523: }
5524: }
1.397 raeburn 5525: ®ister_handler("instselfcreatecheck",\&institutional_selfcreate_check,0,1,0);
1.396 raeburn 5526:
1.317 raeburn 5527: # Get domain specific conditions for import of student photographs to a course
5528: #
5529: # Retrieves information from photo_permission subroutine in localenroll.
5530: # Returns outcome (ok) if no processing errors, and whether course owner is
5531: # required to accept conditions of use (yes/no).
5532: #
5533: #
5534: sub photo_permission_handler {
5535: my ($cmd, $tail, $client) = @_;
5536: my $userinput = "$cmd:$tail";
5537: my $cdom = $tail;
5538: my ($perm_reqd,$conditions);
1.320 albertel 5539: my $outcome;
5540: eval {
5541: local($SIG{__DIE__})='DEFAULT';
5542: $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
5543: \$conditions);
5544: };
5545: if (!$@) {
5546: &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
5547: $userinput);
5548: } else {
5549: &Failure($client,"unknown_cmd\n",$userinput);
5550: }
5551: return 1;
1.317 raeburn 5552: }
5553: ®ister_handler("autophotopermission",\&photo_permission_handler,0,1,0);
5554:
5555: #
5556: # Checks if student photo is available for a user in the domain, in the user's
5557: # directory (in /userfiles/internal/studentphoto.jpg).
5558: # Uses localstudentphoto:fetch() to ensure there is an up to date copy of
5559: # the student's photo.
5560:
5561: sub photo_check_handler {
5562: my ($cmd, $tail, $client) = @_;
5563: my $userinput = "$cmd:$tail";
5564: my ($udom,$uname,$pid) = split(/:/,$tail);
5565: $udom = &unescape($udom);
5566: $uname = &unescape($uname);
5567: $pid = &unescape($pid);
5568: my $path=&propath($udom,$uname).'/userfiles/internal/';
5569: if (!-e $path) {
5570: &mkpath($path);
5571: }
5572: my $response;
5573: my $result = &localstudentphoto::fetch($udom,$uname,$pid,\$response);
5574: $result .= ':'.$response;
5575: &Reply($client, &escape($result)."\n",$userinput);
1.320 albertel 5576: return 1;
1.317 raeburn 5577: }
5578: ®ister_handler("autophotocheck",\&photo_check_handler,0,1,0);
5579:
5580: #
5581: # Retrieve information from localenroll about whether to provide a button
5582: # for users who have enbled import of student photos to initiate an
5583: # update of photo files for registered students. Also include
5584: # comment to display alongside button.
5585:
5586: sub photo_choice_handler {
5587: my ($cmd, $tail, $client) = @_;
5588: my $userinput = "$cmd:$tail";
5589: my $cdom = &unescape($tail);
1.320 albertel 5590: my ($update,$comment);
5591: eval {
5592: local($SIG{__DIE__})='DEFAULT';
5593: ($update,$comment) = &localenroll::manager_photo_update($cdom);
5594: };
5595: if (!$@) {
5596: &Reply($client,&escape($update).':'.&escape($comment)."\n",$userinput);
5597: } else {
5598: &Failure($client,"unknown_cmd\n",$userinput);
5599: }
5600: return 1;
1.317 raeburn 5601: }
5602: ®ister_handler("autophotochoice",\&photo_choice_handler,0,1,0);
5603:
1.265 albertel 5604: #
5605: # Gets a student's photo to exist (in the correct image type) in the user's
5606: # directory.
5607: # Formal Parameters:
5608: # $cmd - The command request that got us dispatched.
5609: # $tail - A colon separated set of words that will be split into:
5610: # $domain - student's domain
5611: # $uname - student username
5612: # $type - image type desired
5613: # $client - The socket open on the client.
5614: # Returns:
5615: # 1 - continue processing.
1.317 raeburn 5616:
1.265 albertel 5617: sub student_photo_handler {
5618: my ($cmd, $tail, $client) = @_;
1.317 raeburn 5619: my ($domain,$uname,$ext,$type) = split(/:/, $tail);
1.265 albertel 5620:
1.317 raeburn 5621: my $path=&propath($domain,$uname). '/userfiles/internal/';
5622: my $filename = 'studentphoto.'.$ext;
5623: if ($type eq 'thumbnail') {
5624: $filename = 'studentphoto_tn.'.$ext;
5625: }
5626: if (-e $path.$filename) {
1.265 albertel 5627: &Reply($client,"ok\n","$cmd:$tail");
5628: return 1;
5629: }
5630: &mkpath($path);
1.317 raeburn 5631: my $file;
5632: if ($type eq 'thumbnail') {
1.320 albertel 5633: eval {
5634: local($SIG{__DIE__})='DEFAULT';
5635: $file=&localstudentphoto::fetch_thumbnail($domain,$uname);
5636: };
1.317 raeburn 5637: } else {
5638: $file=&localstudentphoto::fetch($domain,$uname);
5639: }
1.265 albertel 5640: if (!$file) {
5641: &Failure($client,"unavailable\n","$cmd:$tail");
5642: return 1;
5643: }
1.317 raeburn 5644: if (!-e $path.$filename) { &convert_photo($file,$path.$filename); }
5645: if (-e $path.$filename) {
1.265 albertel 5646: &Reply($client,"ok\n","$cmd:$tail");
5647: return 1;
5648: }
5649: &Failure($client,"unable_to_convert\n","$cmd:$tail");
5650: return 1;
5651: }
5652: ®ister_handler("studentphoto", \&student_photo_handler, 0, 1, 0);
1.246 foxr 5653:
1.361 raeburn 5654: sub inst_usertypes_handler {
5655: my ($cmd, $domain, $client) = @_;
5656: my $res;
5657: my $userinput = $cmd.":".$domain; # For logging purposes.
1.370 albertel 5658: my (%typeshash,@order,$result);
5659: eval {
5660: local($SIG{__DIE__})='DEFAULT';
5661: $result=&localenroll::inst_usertypes($domain,\%typeshash,\@order);
5662: };
5663: if ($result eq 'ok') {
1.361 raeburn 5664: if (keys(%typeshash) > 0) {
5665: foreach my $key (keys(%typeshash)) {
5666: $res.=&escape($key).'='.&escape($typeshash{$key}).'&';
5667: }
5668: }
5669: $res=~s/\&$//;
5670: $res .= ':';
5671: if (@order > 0) {
5672: foreach my $item (@order) {
5673: $res .= &escape($item).'&';
5674: }
5675: }
5676: $res=~s/\&$//;
5677: }
1.387 albertel 5678: &Reply($client, \$res, $userinput);
1.361 raeburn 5679: return 1;
5680: }
5681: ®ister_handler("inst_usertypes", \&inst_usertypes_handler, 0, 1, 0);
5682:
1.264 albertel 5683: # mkpath makes all directories for a file, expects an absolute path with a
5684: # file or a trailing / if just a dir is passed
5685: # returns 1 on success 0 on failure
5686: sub mkpath {
5687: my ($file)=@_;
5688: my @parts=split(/\//,$file,-1);
5689: my $now=$parts[0].'/'.$parts[1].'/'.$parts[2];
5690: for (my $i=3;$i<= ($#parts-1);$i++) {
1.265 albertel 5691: $now.='/'.$parts[$i];
1.264 albertel 5692: if (!-e $now) {
5693: if (!mkdir($now,0770)) { return 0; }
5694: }
5695: }
5696: return 1;
5697: }
5698:
1.207 foxr 5699: #---------------------------------------------------------------
5700: #
5701: # Getting, decoding and dispatching requests:
5702: #
5703: #
5704: # Get a Request:
5705: # Gets a Request message from the client. The transaction
5706: # is defined as a 'line' of text. We remove the new line
5707: # from the text line.
1.226 foxr 5708: #
1.211 albertel 5709: sub get_request {
1.207 foxr 5710: my $input = <$client>;
5711: chomp($input);
1.226 foxr 5712:
1.234 foxr 5713: &Debug("get_request: Request = $input\n");
1.207 foxr 5714:
5715: &status('Processing '.$clientname.':'.$input);
5716:
5717: return $input;
5718: }
1.212 foxr 5719: #---------------------------------------------------------------
5720: #
5721: # Process a request. This sub should shrink as each action
5722: # gets farmed out into a separat sub that is registered
5723: # with the dispatch hash.
5724: #
5725: # Parameters:
5726: # user_input - The request received from the client (lonc).
5727: # Returns:
5728: # true to keep processing, false if caller should exit.
5729: #
5730: sub process_request {
5731: my ($userinput) = @_; # Easier for now to break style than to
5732: # fix all the userinput -> user_input.
5733: my $wasenc = 0; # True if request was encrypted.
5734: # ------------------------------------------------------------ See if encrypted
1.322 albertel 5735: # for command
5736: # sethost:<server>
5737: # <command>:<args>
5738: # we just send it to the processor
5739: # for
5740: # sethost:<server>:<command>:<args>
5741: # we do the implict set host and then do the command
5742: if ($userinput =~ /^sethost:/) {
5743: (my $cmd,my $newid,$userinput) = split(':',$userinput,3);
5744: if (defined($userinput)) {
5745: &sethost("$cmd:$newid");
5746: } else {
5747: $userinput = "$cmd:$newid";
5748: }
5749: }
5750:
1.212 foxr 5751: if ($userinput =~ /^enc/) {
5752: $userinput = decipher($userinput);
5753: $wasenc=1;
5754: if(!$userinput) { # Cipher not defined.
1.251 foxr 5755: &Failure($client, "error: Encrypted data without negotated key\n");
1.212 foxr 5756: return 0;
5757: }
5758: }
5759: Debug("process_request: $userinput\n");
5760:
1.213 foxr 5761: #
5762: # The 'correct way' to add a command to lond is now to
5763: # write a sub to execute it and Add it to the command dispatch
5764: # hash via a call to register_handler.. The comments to that
5765: # sub should give you enough to go on to show how to do this
5766: # along with the examples that are building up as this code
5767: # is getting refactored. Until all branches of the
5768: # if/elseif monster below have been factored out into
5769: # separate procesor subs, if the dispatch hash is missing
5770: # the command keyword, we will fall through to the remainder
5771: # of the if/else chain below in order to keep this thing in
5772: # working order throughout the transmogrification.
5773:
5774: my ($command, $tail) = split(/:/, $userinput, 2);
5775: chomp($command);
5776: chomp($tail);
5777: $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
1.214 foxr 5778: $command =~ s/(\r)//; # And this too for parameterless commands.
5779: if(!$tail) {
5780: $tail =""; # defined but blank.
5781: }
1.213 foxr 5782:
5783: &Debug("Command received: $command, encoded = $wasenc");
5784:
5785: if(defined $Dispatcher{$command}) {
5786:
5787: my $dispatch_info = $Dispatcher{$command};
5788: my $handler = $$dispatch_info[0];
5789: my $need_encode = $$dispatch_info[1];
5790: my $client_types = $$dispatch_info[2];
5791: Debug("Matched dispatch hash: mustencode: $need_encode "
5792: ."ClientType $client_types");
5793:
5794: # Validate the request:
5795:
5796: my $ok = 1;
5797: my $requesterprivs = 0;
5798: if(&isClient()) {
5799: $requesterprivs |= $CLIENT_OK;
5800: }
5801: if(&isManager()) {
5802: $requesterprivs |= $MANAGER_OK;
5803: }
5804: if($need_encode && (!$wasenc)) {
5805: Debug("Must encode but wasn't: $need_encode $wasenc");
5806: $ok = 0;
5807: }
5808: if(($client_types & $requesterprivs) == 0) {
5809: Debug("Client not privileged to do this operation");
5810: $ok = 0;
5811: }
5812:
5813: if($ok) {
5814: Debug("Dispatching to handler $command $tail");
5815: my $keep_going = &$handler($command, $tail, $client);
5816: return $keep_going;
5817: } else {
5818: Debug("Refusing to dispatch because client did not match requirements");
5819: Failure($client, "refused\n", $userinput);
5820: return 1;
5821: }
5822:
5823: }
5824:
1.262 foxr 5825: print $client "unknown_cmd\n";
1.212 foxr 5826: # -------------------------------------------------------------------- complete
5827: Debug("process_request - returning 1");
5828: return 1;
5829: }
1.207 foxr 5830: #
5831: # Decipher encoded traffic
5832: # Parameters:
5833: # input - Encoded data.
5834: # Returns:
5835: # Decoded data or undef if encryption key was not yet negotiated.
5836: # Implicit input:
5837: # cipher - This global holds the negotiated encryption key.
5838: #
1.211 albertel 5839: sub decipher {
1.207 foxr 5840: my ($input) = @_;
5841: my $output = '';
1.212 foxr 5842:
5843:
1.207 foxr 5844: if($cipher) {
5845: my($enc, $enclength, $encinput) = split(/:/, $input);
5846: for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
5847: $output .=
5848: $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
5849: }
5850: return substr($output, 0, $enclength);
5851: } else {
5852: return undef;
5853: }
5854: }
5855:
5856: #
5857: # Register a command processor. This function is invoked to register a sub
5858: # to process a request. Once registered, the ProcessRequest sub can automatically
5859: # dispatch requests to an appropriate sub, and do the top level validity checking
5860: # as well:
5861: # - Is the keyword recognized.
5862: # - Is the proper client type attempting the request.
5863: # - Is the request encrypted if it has to be.
5864: # Parameters:
5865: # $request_name - Name of the request being registered.
5866: # This is the command request that will match
5867: # against the hash keywords to lookup the information
5868: # associated with the dispatch information.
5869: # $procedure - Reference to a sub to call to process the request.
5870: # All subs get called as follows:
5871: # Procedure($cmd, $tail, $replyfd, $key)
5872: # $cmd - the actual keyword that invoked us.
5873: # $tail - the tail of the request that invoked us.
5874: # $replyfd- File descriptor connected to the client
5875: # $must_encode - True if the request must be encoded to be good.
5876: # $client_ok - True if it's ok for a client to request this.
5877: # $manager_ok - True if it's ok for a manager to request this.
5878: # Side effects:
5879: # - On success, the Dispatcher hash has an entry added for the key $RequestName
5880: # - On failure, the program will die as it's a bad internal bug to try to
5881: # register a duplicate command handler.
5882: #
1.211 albertel 5883: sub register_handler {
1.212 foxr 5884: my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
1.207 foxr 5885:
5886: # Don't allow duplication#
5887:
5888: if (defined $Dispatcher{$request_name}) {
5889: die "Attempting to define a duplicate request handler for $request_name\n";
5890: }
5891: # Build the client type mask:
5892:
5893: my $client_type_mask = 0;
5894: if($client_ok) {
5895: $client_type_mask |= $CLIENT_OK;
5896: }
5897: if($manager_ok) {
5898: $client_type_mask |= $MANAGER_OK;
5899: }
5900:
5901: # Enter the hash:
5902:
5903: my @entry = ($procedure, $must_encode, $client_type_mask);
5904:
5905: $Dispatcher{$request_name} = \@entry;
5906:
5907: }
5908:
5909:
5910: #------------------------------------------------------------------
5911:
5912:
5913:
5914:
1.141 foxr 5915: #
1.96 foxr 5916: # Convert an error return code from lcpasswd to a string value.
5917: #
5918: sub lcpasswdstrerror {
5919: my $ErrorCode = shift;
1.97 foxr 5920: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
1.96 foxr 5921: return "lcpasswd Unrecognized error return value ".$ErrorCode;
5922: } else {
1.98 foxr 5923: return $passwderrors[$ErrorCode];
1.96 foxr 5924: }
5925: }
5926:
1.97 foxr 5927: #
5928: # Convert an error return code from lcuseradd to a string value:
5929: #
5930: sub lcuseraddstrerror {
5931: my $ErrorCode = shift;
5932: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
5933: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
5934: } else {
1.98 foxr 5935: return $adderrors[$ErrorCode];
1.97 foxr 5936: }
5937: }
5938:
1.23 harris41 5939: # grabs exception and records it to log before exiting
5940: sub catchexception {
1.27 albertel 5941: my ($error)=@_;
1.25 www 5942: $SIG{'QUIT'}='DEFAULT';
5943: $SIG{__DIE__}='DEFAULT';
1.165 albertel 5944: &status("Catching exception");
1.190 albertel 5945: &logthis("<font color='red'>CRITICAL: "
1.373 albertel 5946: ."ABNORMAL EXIT. Child $$ for server ".$perlvar{'lonHostID'}." died through "
1.27 albertel 5947: ."a crash with this error msg->[$error]</font>");
1.57 www 5948: &logthis('Famous last words: '.$status.' - '.$lastlog);
1.27 albertel 5949: if ($client) { print $client "error: $error\n"; }
1.59 www 5950: $server->close();
1.27 albertel 5951: die($error);
1.23 harris41 5952: }
1.63 www 5953: sub timeout {
1.165 albertel 5954: &status("Handling Timeout");
1.190 albertel 5955: &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
1.63 www 5956: &catchexception('Timeout');
5957: }
1.22 harris41 5958: # -------------------------------- Set signal handlers to record abnormal exits
5959:
1.226 foxr 5960:
1.22 harris41 5961: $SIG{'QUIT'}=\&catchexception;
5962: $SIG{__DIE__}=\&catchexception;
5963:
1.81 matthew 5964: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
1.95 harris41 5965: &status("Read loncapa.conf and loncapa_apache.conf");
5966: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
1.141 foxr 5967: %perlvar=%{$perlvarref};
1.80 harris41 5968: undef $perlvarref;
1.19 www 5969:
1.35 harris41 5970: # ----------------------------- Make sure this process is running from user=www
5971: my $wwwid=getpwnam('www');
5972: if ($wwwid!=$<) {
1.134 albertel 5973: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
5974: my $subj="LON: $currenthostid User ID mismatch";
1.37 harris41 5975: system("echo 'User ID mismatch. lond must be run as user www.' |\
1.35 harris41 5976: mailto $emailto -s '$subj' > /dev/null");
5977: exit 1;
5978: }
5979:
1.19 www 5980: # --------------------------------------------- Check if other instance running
5981:
5982: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
5983:
5984: if (-e $pidfile) {
5985: my $lfh=IO::File->new("$pidfile");
5986: my $pide=<$lfh>;
5987: chomp($pide);
1.29 harris41 5988: if (kill 0 => $pide) { die "already running"; }
1.19 www 5989: }
1.1 albertel 5990:
5991: # ------------------------------------------------------------- Read hosts file
5992:
5993:
5994:
5995: # establish SERVER socket, bind and listen.
5996: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
5997: Type => SOCK_STREAM,
5998: Proto => 'tcp',
5999: Reuse => 1,
6000: Listen => 10 )
1.29 harris41 6001: or die "making socket: $@\n";
1.1 albertel 6002:
6003: # --------------------------------------------------------- Do global variables
6004:
6005: # global variables
6006:
1.134 albertel 6007: my %children = (); # keys are current child process IDs
1.1 albertel 6008:
6009: sub REAPER { # takes care of dead children
6010: $SIG{CHLD} = \&REAPER;
1.165 albertel 6011: &status("Handling child death");
1.178 foxr 6012: my $pid;
6013: do {
6014: $pid = waitpid(-1,&WNOHANG());
6015: if (defined($children{$pid})) {
6016: &logthis("Child $pid died");
6017: delete($children{$pid});
1.183 albertel 6018: } elsif ($pid > 0) {
1.178 foxr 6019: &logthis("Unknown Child $pid died");
6020: }
6021: } while ( $pid > 0 );
6022: foreach my $child (keys(%children)) {
6023: $pid = waitpid($child,&WNOHANG());
6024: if ($pid > 0) {
6025: &logthis("Child $child - $pid looks like we missed it's death");
6026: delete($children{$pid});
6027: }
1.176 albertel 6028: }
1.165 albertel 6029: &status("Finished Handling child death");
1.1 albertel 6030: }
6031:
6032: sub HUNTSMAN { # signal handler for SIGINT
1.165 albertel 6033: &status("Killing children (INT)");
1.1 albertel 6034: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
6035: kill 'INT' => keys %children;
1.59 www 6036: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.1 albertel 6037: my $execdir=$perlvar{'lonDaemons'};
6038: unlink("$execdir/logs/lond.pid");
1.190 albertel 6039: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
1.165 albertel 6040: &status("Done killing children");
1.1 albertel 6041: exit; # clean up with dignity
6042: }
6043:
6044: sub HUPSMAN { # signal handler for SIGHUP
6045: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1.165 albertel 6046: &status("Killing children for restart (HUP)");
1.1 albertel 6047: kill 'INT' => keys %children;
1.59 www 6048: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.190 albertel 6049: &logthis("<font color='red'>CRITICAL: Restarting</font>");
1.134 albertel 6050: my $execdir=$perlvar{'lonDaemons'};
1.30 harris41 6051: unlink("$execdir/logs/lond.pid");
1.165 albertel 6052: &status("Restarting self (HUP)");
1.1 albertel 6053: exec("$execdir/lond"); # here we go again
6054: }
6055:
1.144 foxr 6056: #
1.148 foxr 6057: # Reload the Apache daemon's state.
1.150 foxr 6058: # This is done by invoking /home/httpd/perl/apachereload
6059: # a setuid perl script that can be root for us to do this job.
1.148 foxr 6060: #
6061: sub ReloadApache {
1.150 foxr 6062: my $execdir = $perlvar{'lonDaemons'};
6063: my $script = $execdir."/apachereload";
6064: system($script);
1.148 foxr 6065: }
6066:
6067: #
1.144 foxr 6068: # Called in response to a USR2 signal.
6069: # - Reread hosts.tab
6070: # - All children connected to hosts that were removed from hosts.tab
6071: # are killed via SIGINT
6072: # - All children connected to previously existing hosts are sent SIGUSR1
6073: # - Our internal hosts hash is updated to reflect the new contents of
6074: # hosts.tab causing connections from hosts added to hosts.tab to
6075: # now be honored.
6076: #
6077: sub UpdateHosts {
1.165 albertel 6078: &status("Reload hosts.tab");
1.147 foxr 6079: logthis('<font color="blue"> Updating connections </font>');
1.148 foxr 6080: #
6081: # The %children hash has the set of IP's we currently have children
6082: # on. These need to be matched against records in the hosts.tab
6083: # Any ip's no longer in the table get killed off they correspond to
6084: # either dropped or changed hosts. Note that the re-read of the table
6085: # will take care of new and changed hosts as connections come into being.
6086:
1.371 albertel 6087: &Apache::lonnet::reset_hosts_info();
1.148 foxr 6088:
1.368 albertel 6089: foreach my $child (keys(%children)) {
1.148 foxr 6090: my $childip = $children{$child};
1.374 albertel 6091: if ($childip ne '127.0.0.1'
6092: && !defined(&Apache::lonnet::get_hosts_from_ip($childip))) {
1.149 foxr 6093: logthis('<font color="blue"> UpdateHosts killing child '
6094: ." $child for ip $childip </font>");
1.148 foxr 6095: kill('INT', $child);
1.149 foxr 6096: } else {
6097: logthis('<font color="green"> keeping child for ip '
6098: ." $childip (pid=$child) </font>");
1.148 foxr 6099: }
6100: }
6101: ReloadApache;
1.165 albertel 6102: &status("Finished reloading hosts.tab");
1.144 foxr 6103: }
6104:
1.148 foxr 6105:
1.57 www 6106: sub checkchildren {
1.165 albertel 6107: &status("Checking on the children (sending signals)");
1.57 www 6108: &initnewstatus();
6109: &logstatus();
6110: &logthis('Going to check on the children');
1.134 albertel 6111: my $docdir=$perlvar{'lonDocRoot'};
1.61 harris41 6112: foreach (sort keys %children) {
1.221 albertel 6113: #sleep 1;
1.57 www 6114: unless (kill 'USR1' => $_) {
6115: &logthis ('Child '.$_.' is dead');
6116: &logstatus($$.' is dead');
1.221 albertel 6117: delete($children{$_});
1.57 www 6118: }
1.61 harris41 6119: }
1.63 www 6120: sleep 5;
1.212 foxr 6121: $SIG{ALRM} = sub { Debug("timeout");
6122: die "timeout"; };
1.113 albertel 6123: $SIG{__DIE__} = 'DEFAULT';
1.165 albertel 6124: &status("Checking on the children (waiting for reports)");
1.63 www 6125: foreach (sort keys %children) {
6126: unless (-e "$docdir/lon-status/londchld/$_.txt") {
1.113 albertel 6127: eval {
6128: alarm(300);
1.63 www 6129: &logthis('Child '.$_.' did not respond');
1.67 albertel 6130: kill 9 => $_;
1.131 albertel 6131: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
6132: #$subj="LON: $currenthostid killed lond process $_";
6133: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
6134: #$execdir=$perlvar{'lonDaemons'};
6135: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
1.221 albertel 6136: delete($children{$_});
1.113 albertel 6137: alarm(0);
6138: }
1.63 www 6139: }
6140: }
1.113 albertel 6141: $SIG{ALRM} = 'DEFAULT';
1.155 albertel 6142: $SIG{__DIE__} = \&catchexception;
1.165 albertel 6143: &status("Finished checking children");
1.221 albertel 6144: &logthis('Finished Checking children');
1.57 www 6145: }
6146:
1.1 albertel 6147: # --------------------------------------------------------------------- Logging
6148:
6149: sub logthis {
6150: my $message=shift;
6151: my $execdir=$perlvar{'lonDaemons'};
6152: my $fh=IO::File->new(">>$execdir/logs/lond.log");
6153: my $now=time;
6154: my $local=localtime($now);
1.58 www 6155: $lastlog=$local.': '.$message;
1.1 albertel 6156: print $fh "$local ($$): $message\n";
6157: }
6158:
1.77 foxr 6159: # ------------------------- Conditional log if $DEBUG true.
6160: sub Debug {
6161: my $message = shift;
6162: if($DEBUG) {
6163: &logthis($message);
6164: }
6165: }
1.161 foxr 6166:
6167: #
6168: # Sub to do replies to client.. this gives a hook for some
6169: # debug tracing too:
6170: # Parameters:
6171: # fd - File open on client.
6172: # reply - Text to send to client.
6173: # request - Original request from client.
6174: #
6175: sub Reply {
1.192 foxr 6176: my ($fd, $reply, $request) = @_;
1.387 albertel 6177: if (ref($reply)) {
6178: print $fd $$reply;
6179: print $fd "\n";
6180: if ($DEBUG) { Debug("Request was $request Reply was $$reply"); }
6181: } else {
6182: print $fd $reply;
6183: if ($DEBUG) { Debug("Request was $request Reply was $reply"); }
6184: }
1.212 foxr 6185: $Transactions++;
6186: }
6187:
6188:
6189: #
6190: # Sub to report a failure.
6191: # This function:
6192: # - Increments the failure statistic counters.
6193: # - Invokes Reply to send the error message to the client.
6194: # Parameters:
6195: # fd - File descriptor open on the client
6196: # reply - Reply text to emit.
6197: # request - The original request message (used by Reply
6198: # to debug if that's enabled.
6199: # Implicit outputs:
6200: # $Failures- The number of failures is incremented.
6201: # Reply (invoked here) sends a message to the
6202: # client:
6203: #
6204: sub Failure {
6205: my $fd = shift;
6206: my $reply = shift;
6207: my $request = shift;
6208:
6209: $Failures++;
6210: Reply($fd, $reply, $request); # That's simple eh?
1.161 foxr 6211: }
1.57 www 6212: # ------------------------------------------------------------------ Log status
6213:
6214: sub logstatus {
1.178 foxr 6215: &status("Doing logging");
6216: my $docdir=$perlvar{'lonDocRoot'};
6217: {
6218: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
1.200 matthew 6219: print $fh $status."\n".$lastlog."\n".time."\n$keymode";
1.178 foxr 6220: $fh->close();
6221: }
1.221 albertel 6222: &status("Finished $$.txt");
6223: {
6224: open(LOG,">>$docdir/lon-status/londstatus.txt");
6225: flock(LOG,LOCK_EX);
6226: print LOG $$."\t".$clientname."\t".$currenthostid."\t"
6227: .$status."\t".$lastlog."\t $keymode\n";
1.275 albertel 6228: flock(LOG,LOCK_UN);
1.221 albertel 6229: close(LOG);
6230: }
1.178 foxr 6231: &status("Finished logging");
1.57 www 6232: }
6233:
6234: sub initnewstatus {
6235: my $docdir=$perlvar{'lonDocRoot'};
6236: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
1.460 foxr 6237: my $now=time();
1.57 www 6238: my $local=localtime($now);
6239: print $fh "LOND status $local - parent $$\n\n";
1.64 www 6240: opendir(DIR,"$docdir/lon-status/londchld");
1.134 albertel 6241: while (my $filename=readdir(DIR)) {
1.64 www 6242: unlink("$docdir/lon-status/londchld/$filename");
6243: }
6244: closedir(DIR);
1.57 www 6245: }
6246:
6247: # -------------------------------------------------------------- Status setting
6248:
6249: sub status {
6250: my $what=shift;
6251: my $now=time;
6252: my $local=localtime($now);
1.178 foxr 6253: $status=$local.': '.$what;
6254: $0='lond: '.$what.' '.$local;
1.57 www 6255: }
1.11 www 6256:
1.13 www 6257: # -------------------------------------------------------------- Talk to lonsql
6258:
1.234 foxr 6259: sub sql_reply {
1.12 harris41 6260: my ($cmd)=@_;
1.234 foxr 6261: my $answer=&sub_sql_reply($cmd);
6262: if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
1.12 harris41 6263: return $answer;
6264: }
6265:
1.234 foxr 6266: sub sub_sql_reply {
1.12 harris41 6267: my ($cmd)=@_;
6268: my $unixsock="mysqlsock";
6269: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
6270: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
6271: Type => SOCK_STREAM,
6272: Timeout => 10)
6273: or return "con_lost";
1.319 www 6274: print $sclient "$cmd:$currentdomainid\n";
1.12 harris41 6275: my $answer=<$sclient>;
6276: chomp($answer);
6277: if (!$answer) { $answer="con_lost"; }
6278: return $answer;
6279: }
6280:
1.1 albertel 6281: # --------------------------------------- Is this the home server of an author?
1.11 www 6282:
1.1 albertel 6283: sub ishome {
6284: my $author=shift;
6285: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
6286: my ($udom,$uname)=split(/\//,$author);
6287: my $proname=propath($udom,$uname);
6288: if (-e $proname) {
6289: return 'owner';
6290: } else {
6291: return 'not_owner';
6292: }
6293: }
6294:
6295: # ======================================================= Continue main program
6296: # ---------------------------------------------------- Fork once and dissociate
6297:
1.134 albertel 6298: my $fpid=fork;
1.1 albertel 6299: exit if $fpid;
1.29 harris41 6300: die "Couldn't fork: $!" unless defined ($fpid);
1.1 albertel 6301:
1.29 harris41 6302: POSIX::setsid() or die "Can't start new session: $!";
1.1 albertel 6303:
6304: # ------------------------------------------------------- Write our PID on disk
6305:
1.134 albertel 6306: my $execdir=$perlvar{'lonDaemons'};
1.1 albertel 6307: open (PIDSAVE,">$execdir/logs/lond.pid");
6308: print PIDSAVE "$$\n";
6309: close(PIDSAVE);
1.190 albertel 6310: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
1.57 www 6311: &status('Starting');
1.1 albertel 6312:
1.106 foxr 6313:
1.1 albertel 6314:
6315: # ----------------------------------------------------- Install signal handlers
6316:
1.57 www 6317:
1.1 albertel 6318: $SIG{CHLD} = \&REAPER;
6319: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
6320: $SIG{HUP} = \&HUPSMAN;
1.57 www 6321: $SIG{USR1} = \&checkchildren;
1.144 foxr 6322: $SIG{USR2} = \&UpdateHosts;
1.106 foxr 6323:
1.148 foxr 6324: # Read the host hashes:
1.368 albertel 6325: &Apache::lonnet::load_hosts_tab();
1.447 raeburn 6326: my %iphost = &Apache::lonnet::get_iphost(1);
1.106 foxr 6327:
1.286 albertel 6328: my $dist=`$perlvar{'lonDaemons'}/distprobe`;
6329:
1.106 foxr 6330: # --------------------------------------------------------------
6331: # Accept connections. When a connection comes in, it is validated
6332: # and if good, a child process is created to process transactions
6333: # along the connection.
6334:
1.1 albertel 6335: while (1) {
1.165 albertel 6336: &status('Starting accept');
1.106 foxr 6337: $client = $server->accept() or next;
1.165 albertel 6338: &status('Accepted '.$client.' off to spawn');
1.386 albertel 6339: make_new_child($client);
1.165 albertel 6340: &status('Finished spawning');
1.1 albertel 6341: }
6342:
1.212 foxr 6343: sub make_new_child {
6344: my $pid;
6345: # my $cipher; # Now global
6346: my $sigset;
1.178 foxr 6347:
1.212 foxr 6348: $client = shift;
6349: &status('Starting new child '.$client);
6350: &logthis('<font color="green"> Attempting to start child ('.$client.
6351: ")</font>");
6352: # block signal for fork
6353: $sigset = POSIX::SigSet->new(SIGINT);
6354: sigprocmask(SIG_BLOCK, $sigset)
6355: or die "Can't block SIGINT for fork: $!\n";
1.178 foxr 6356:
1.212 foxr 6357: die "fork: $!" unless defined ($pid = fork);
1.178 foxr 6358:
1.212 foxr 6359: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
6360: # connection liveness.
1.178 foxr 6361:
1.212 foxr 6362: #
6363: # Figure out who we're talking to so we can record the peer in
6364: # the pid hash.
6365: #
6366: my $caller = getpeername($client);
6367: my ($port,$iaddr);
6368: if (defined($caller) && length($caller) > 0) {
6369: ($port,$iaddr)=unpack_sockaddr_in($caller);
6370: } else {
6371: &logthis("Unable to determine who caller was, getpeername returned nothing");
6372: }
6373: if (defined($iaddr)) {
6374: $clientip = inet_ntoa($iaddr);
6375: Debug("Connected with $clientip");
6376: } else {
6377: &logthis("Unable to determine clientip");
6378: $clientip='Unavailable';
6379: }
6380:
6381: if ($pid) {
6382: # Parent records the child's birth and returns.
6383: sigprocmask(SIG_UNBLOCK, $sigset)
6384: or die "Can't unblock SIGINT for fork: $!\n";
6385: $children{$pid} = $clientip;
6386: &status('Started child '.$pid);
6387: return;
6388: } else {
6389: # Child can *not* return from this subroutine.
6390: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
6391: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
6392: #don't get intercepted
6393: $SIG{USR1}= \&logstatus;
6394: $SIG{ALRM}= \&timeout;
6395: $lastlog='Forked ';
6396: $status='Forked';
1.178 foxr 6397:
1.212 foxr 6398: # unblock signals
6399: sigprocmask(SIG_UNBLOCK, $sigset)
6400: or die "Can't unblock SIGINT for fork: $!\n";
1.178 foxr 6401:
1.212 foxr 6402: # my $tmpsnum=0; # Now global
6403: #---------------------------------------------------- kerberos 5 initialization
6404: &Authen::Krb5::init_context();
1.359 raeburn 6405: unless (($dist eq 'fedora5') || ($dist eq 'fedora4') ||
6406: ($dist eq 'fedora6') || ($dist eq 'suse9.3')) {
1.286 albertel 6407: &Authen::Krb5::init_ets();
6408: }
1.209 albertel 6409:
1.212 foxr 6410: &status('Accepted connection');
6411: # =============================================================================
6412: # do something with the connection
6413: # -----------------------------------------------------------------------------
6414: # see if we know client and 'check' for spoof IP by ineffective challenge
1.178 foxr 6415:
1.278 albertel 6416: my $outsideip=$clientip;
6417: if ($clientip eq '127.0.0.1') {
1.368 albertel 6418: $outsideip=&Apache::lonnet::get_host_ip($perlvar{'lonHostID'});
1.278 albertel 6419: }
1.412 foxr 6420: &ReadManagerTable();
1.368 albertel 6421: my $clientrec=defined(&Apache::lonnet::get_hosts_from_ip($outsideip));
1.278 albertel 6422: my $ismanager=($managers{$outsideip} ne undef);
1.432 raeburn 6423: $clientname = "[unknown]";
1.212 foxr 6424: if($clientrec) { # Establish client type.
6425: $ConnectionType = "client";
1.368 albertel 6426: $clientname = (&Apache::lonnet::get_hosts_from_ip($outsideip))[-1];
1.212 foxr 6427: if($ismanager) {
6428: $ConnectionType = "both";
6429: }
6430: } else {
6431: $ConnectionType = "manager";
1.278 albertel 6432: $clientname = $managers{$outsideip};
1.212 foxr 6433: }
6434: my $clientok;
1.178 foxr 6435:
1.212 foxr 6436: if ($clientrec || $ismanager) {
6437: &status("Waiting for init from $clientip $clientname");
6438: &logthis('<font color="yellow">INFO: Connection, '.
6439: $clientip.
6440: " ($clientname) connection type = $ConnectionType </font>" );
6441: &status("Connecting $clientip ($clientname))");
6442: my $remotereq=<$client>;
6443: chomp($remotereq);
6444: Debug("Got init: $remotereq");
1.337 albertel 6445:
1.212 foxr 6446: if ($remotereq =~ /^init/) {
6447: &sethost("sethost:$perlvar{'lonHostID'}");
6448: #
6449: # If the remote is attempting a local init... give that a try:
6450: #
1.432 raeburn 6451: (my $i, my $inittype, $clientversion) = split(/:/, $remotereq);
1.209 albertel 6452:
1.212 foxr 6453: # If the connection type is ssl, but I didn't get my
6454: # certificate files yet, then I'll drop back to
6455: # insecure (if allowed).
6456:
6457: if($inittype eq "ssl") {
6458: my ($ca, $cert) = lonssl::CertificateFile;
6459: my $kfile = lonssl::KeyFile;
6460: if((!$ca) ||
6461: (!$cert) ||
6462: (!$kfile)) {
6463: $inittype = ""; # This forces insecure attempt.
6464: &logthis("<font color=\"blue\"> Certificates not "
6465: ."installed -- trying insecure auth</font>");
1.224 foxr 6466: } else { # SSL certificates are in place so
1.212 foxr 6467: } # Leave the inittype alone.
6468: }
6469:
6470: if($inittype eq "local") {
1.432 raeburn 6471: $clientversion = $perlvar{'lonVersion'};
1.212 foxr 6472: my $key = LocalConnection($client, $remotereq);
6473: if($key) {
6474: Debug("Got local key $key");
6475: $clientok = 1;
6476: my $cipherkey = pack("H32", $key);
6477: $cipher = new IDEA($cipherkey);
6478: print $client "ok:local\n";
1.442 www 6479: &logthis('<font color="green">'
1.212 foxr 6480: . "Successful local authentication </font>");
6481: $keymode = "local"
1.178 foxr 6482: } else {
1.212 foxr 6483: Debug("Failed to get local key");
6484: $clientok = 0;
6485: shutdown($client, 3);
6486: close $client;
1.178 foxr 6487: }
1.212 foxr 6488: } elsif ($inittype eq "ssl") {
6489: my $key = SSLConnection($client);
6490: if ($key) {
6491: $clientok = 1;
6492: my $cipherkey = pack("H32", $key);
6493: $cipher = new IDEA($cipherkey);
6494: &logthis('<font color="green">'
6495: ."Successfull ssl authentication with $clientname </font>");
6496: $keymode = "ssl";
6497:
1.178 foxr 6498: } else {
1.212 foxr 6499: $clientok = 0;
6500: close $client;
1.178 foxr 6501: }
1.212 foxr 6502:
6503: } else {
6504: my $ok = InsecureConnection($client);
6505: if($ok) {
6506: $clientok = 1;
6507: &logthis('<font color="green">'
6508: ."Successful insecure authentication with $clientname </font>");
6509: print $client "ok\n";
6510: $keymode = "insecure";
1.178 foxr 6511: } else {
1.212 foxr 6512: &logthis('<font color="yellow">'
6513: ."Attempted insecure connection disallowed </font>");
6514: close $client;
6515: $clientok = 0;
1.178 foxr 6516:
6517: }
6518: }
1.212 foxr 6519: } else {
6520: &logthis(
6521: "<font color='blue'>WARNING: "
6522: ."$clientip failed to initialize: >$remotereq< </font>");
6523: &status('No init '.$clientip);
6524: }
6525:
6526: } else {
6527: &logthis(
6528: "<font color='blue'>WARNING: Unknown client $clientip</font>");
6529: &status('Hung up on '.$clientip);
6530: }
6531:
6532: if ($clientok) {
6533: # ---------------- New known client connecting, could mean machine online again
1.368 albertel 6534: if (&Apache::lonnet::get_host_ip($currenthostid) ne $clientip
1.367 albertel 6535: && $clientip ne '127.0.0.1') {
1.375 albertel 6536: &Apache::lonnet::reconlonc($clientname);
1.212 foxr 6537: }
6538: &logthis("<font color='green'>Established connection: $clientname</font>");
6539: &status('Will listen to '.$clientname);
6540: # ------------------------------------------------------------ Process requests
6541: my $keep_going = 1;
6542: my $user_input;
1.448 raeburn 6543: my $clienthost = &Apache::lonnet::hostname($clientname);
6544: my $clientserverhomeID = &Apache::lonnet::get_server_homeID($clienthost);
6545: $clienthomedom = &Apache::lonnet::host_domain($clientserverhomeID);
1.212 foxr 6546: while(($user_input = get_request) && $keep_going) {
6547: alarm(120);
6548: Debug("Main: Got $user_input\n");
6549: $keep_going = &process_request($user_input);
1.178 foxr 6550: alarm(0);
1.212 foxr 6551: &status('Listening to '.$clientname." ($keymode)");
1.161 foxr 6552: }
1.212 foxr 6553:
1.59 www 6554: # --------------------------------------------- client unknown or fishy, refuse
1.212 foxr 6555: } else {
1.161 foxr 6556: print $client "refused\n";
6557: $client->close();
1.190 albertel 6558: &logthis("<font color='blue'>WARNING: "
1.161 foxr 6559: ."Rejected client $clientip, closing connection</font>");
6560: }
1.212 foxr 6561: }
1.161 foxr 6562:
1.1 albertel 6563: # =============================================================================
1.161 foxr 6564:
1.190 albertel 6565: &logthis("<font color='red'>CRITICAL: "
1.161 foxr 6566: ."Disconnect from $clientip ($clientname)</font>");
6567:
6568:
6569: # this exit is VERY important, otherwise the child will become
6570: # a producer of more and more children, forking yourself into
6571: # process death.
6572: exit;
1.106 foxr 6573:
1.78 foxr 6574: }
1.261 foxr 6575: #
6576: # Determine if a user is an author for the indicated domain.
6577: #
6578: # Parameters:
6579: # domain - domain to check in .
6580: # user - Name of user to check.
6581: #
6582: # Return:
6583: # 1 - User is an author for domain.
6584: # 0 - User is not an author for domain.
6585: sub is_author {
6586: my ($domain, $user) = @_;
6587:
6588: &Debug("is_author: $user @ $domain");
6589:
6590: my $hashref = &tie_user_hash($domain, $user, "roles",
6591: &GDBM_READER());
6592:
6593: # Author role should show up as a key /domain/_au
1.78 foxr 6594:
1.321 albertel 6595: my $key = "/$domain/_au";
6596: my $value;
6597: if (defined($hashref)) {
6598: $value = $hashref->{$key};
6599: }
1.78 foxr 6600:
1.261 foxr 6601: if(defined($value)) {
6602: &Debug("$user @ $domain is an author");
6603: }
6604:
6605: return defined($value);
6606: }
1.78 foxr 6607: #
6608: # Checks to see if the input roleput request was to set
6609: # an author role. If so, invokes the lchtmldir script to set
6610: # up a correct public_html
6611: # Parameters:
6612: # request - The request sent to the rolesput subchunk.
6613: # We're looking for /domain/_au
6614: # domain - The domain in which the user is having roles doctored.
6615: # user - Name of the user for which the role is being put.
6616: # authtype - The authentication type associated with the user.
6617: #
1.289 albertel 6618: sub manage_permissions {
1.192 foxr 6619: my ($request, $domain, $user, $authtype) = @_;
1.78 foxr 6620:
1.261 foxr 6621: &Debug("manage_permissions: $request $domain $user $authtype");
6622:
1.78 foxr 6623: # See if the request is of the form /$domain/_au
1.289 albertel 6624: if($request =~ /^(\/\Q$domain\E\/_au)$/) { # It's an author rolesput...
1.78 foxr 6625: my $execdir = $perlvar{'lonDaemons'};
6626: my $userhome= "/home/$user" ;
1.134 albertel 6627: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
1.261 foxr 6628: &Debug("Setting homedir permissions for $userhome");
1.78 foxr 6629: system("$execdir/lchtmldir $userhome $user $authtype");
6630: }
6631: }
1.222 foxr 6632:
6633:
6634: #
6635: # Return the full path of a user password file, whether it exists or not.
6636: # Parameters:
6637: # domain - Domain in which the password file lives.
6638: # user - name of the user.
6639: # Returns:
6640: # Full passwd path:
6641: #
6642: sub password_path {
6643: my ($domain, $user) = @_;
1.264 albertel 6644: return &propath($domain, $user).'/passwd';
1.222 foxr 6645: }
6646:
6647: # Password Filename
6648: # Returns the path to a passwd file given domain and user... only if
6649: # it exists.
6650: # Parameters:
6651: # domain - Domain in which to search.
6652: # user - username.
6653: # Returns:
6654: # - If the password file exists returns its path.
6655: # - If the password file does not exist, returns undefined.
6656: #
6657: sub password_filename {
6658: my ($domain, $user) = @_;
6659:
6660: Debug ("PasswordFilename called: dom = $domain user = $user");
6661:
6662: my $path = &password_path($domain, $user);
6663: Debug("PasswordFilename got path: $path");
6664: if(-e $path) {
6665: return $path;
6666: } else {
6667: return undef;
6668: }
6669: }
6670:
6671: #
6672: # Rewrite the contents of the user's passwd file.
6673: # Parameters:
6674: # domain - domain of the user.
6675: # name - User's name.
6676: # contents - New contents of the file.
6677: # Returns:
6678: # 0 - Failed.
6679: # 1 - Success.
6680: #
6681: sub rewrite_password_file {
6682: my ($domain, $user, $contents) = @_;
6683:
6684: my $file = &password_filename($domain, $user);
6685: if (defined $file) {
6686: my $pf = IO::File->new(">$file");
6687: if($pf) {
6688: print $pf "$contents\n";
6689: return 1;
6690: } else {
6691: return 0;
6692: }
6693: } else {
6694: return 0;
6695: }
6696:
6697: }
6698:
1.78 foxr 6699: #
1.222 foxr 6700: # get_auth_type - Determines the authorization type of a user in a domain.
1.78 foxr 6701:
6702: # Returns the authorization type or nouser if there is no such user.
6703: #
1.436 raeburn 6704: sub get_auth_type {
1.192 foxr 6705: my ($domain, $user) = @_;
1.78 foxr 6706:
1.222 foxr 6707: Debug("get_auth_type( $domain, $user ) \n");
1.78 foxr 6708: my $proname = &propath($domain, $user);
6709: my $passwdfile = "$proname/passwd";
6710: if( -e $passwdfile ) {
6711: my $pf = IO::File->new($passwdfile);
6712: my $realpassword = <$pf>;
6713: chomp($realpassword);
1.79 foxr 6714: Debug("Password info = $realpassword\n");
1.78 foxr 6715: my ($authtype, $contentpwd) = split(/:/, $realpassword);
1.79 foxr 6716: Debug("Authtype = $authtype, content = $contentpwd\n");
1.259 raeburn 6717: return "$authtype:$contentpwd";
1.224 foxr 6718: } else {
1.79 foxr 6719: Debug("Returning nouser");
1.78 foxr 6720: return "nouser";
6721: }
1.1 albertel 6722: }
6723:
1.220 foxr 6724: #
6725: # Validate a user given their domain, name and password. This utility
6726: # function is used by both AuthenticateHandler and ChangePasswordHandler
6727: # to validate the login credentials of a user.
6728: # Parameters:
6729: # $domain - The domain being logged into (this is required due to
6730: # the capability for multihomed systems.
6731: # $user - The name of the user being validated.
6732: # $password - The user's propoposed password.
6733: #
6734: # Returns:
6735: # 1 - The domain,user,pasword triplet corresponds to a valid
6736: # user.
6737: # 0 - The domain,user,password triplet is not a valid user.
6738: #
6739: sub validate_user {
1.396 raeburn 6740: my ($domain, $user, $password, $checkdefauth) = @_;
1.220 foxr 6741:
6742: # Why negative ~pi you may well ask? Well this function is about
6743: # authentication, and therefore very important to get right.
6744: # I've initialized the flag that determines whether or not I've
6745: # validated correctly to a value it's not supposed to get.
6746: # At the end of this function. I'll ensure that it's not still that
6747: # value so we don't just wind up returning some accidental value
6748: # as a result of executing an unforseen code path that
1.249 foxr 6749: # did not set $validated. At the end of valid execution paths,
6750: # validated shoule be 1 for success or 0 for failuer.
1.220 foxr 6751:
6752: my $validated = -3.14159;
6753:
6754: # How we authenticate is determined by the type of authentication
6755: # the user has been assigned. If the authentication type is
6756: # "nouser", the user does not exist so we will return 0.
6757:
1.222 foxr 6758: my $contents = &get_auth_type($domain, $user);
1.220 foxr 6759: my ($howpwd, $contentpwd) = split(/:/, $contents);
6760:
6761: my $null = pack("C",0); # Used by kerberos auth types.
6762:
1.395 raeburn 6763: if ($howpwd eq 'nouser') {
1.396 raeburn 6764: if ($checkdefauth) {
6765: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
6766: if ($domdefaults{'auth_def'} eq 'localauth') {
6767: $howpwd = $domdefaults{'auth_def'};
6768: $contentpwd = $domdefaults{'auth_arg_def'};
6769: } elsif ((($domdefaults{'auth_def'} eq 'krb4') ||
6770: ($domdefaults{'auth_def'} eq 'krb5')) &&
6771: ($domdefaults{'auth_arg_def'} ne '')) {
6772: $howpwd = $domdefaults{'auth_def'};
6773: $contentpwd = $domdefaults{'auth_arg_def'};
6774: }
1.395 raeburn 6775: }
6776: }
1.220 foxr 6777: if ($howpwd ne 'nouser') {
6778: if($howpwd eq "internal") { # Encrypted is in local password file.
6779: $validated = (crypt($password, $contentpwd) eq $contentpwd);
6780: }
6781: elsif ($howpwd eq "unix") { # User is a normal unix user.
6782: $contentpwd = (getpwnam($user))[1];
6783: if($contentpwd) {
6784: if($contentpwd eq 'x') { # Shadow password file...
6785: my $pwauth_path = "/usr/local/sbin/pwauth";
6786: open PWAUTH, "|$pwauth_path" or
6787: die "Cannot invoke authentication";
6788: print PWAUTH "$user\n$password\n";
6789: close PWAUTH;
6790: $validated = ! $?;
6791:
6792: } else { # Passwords in /etc/passwd.
6793: $validated = (crypt($password,
6794: $contentpwd) eq $contentpwd);
6795: }
6796: } else {
6797: $validated = 0;
6798: }
1.439 raeburn 6799: } elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
6800: my $checkwithkrb5 = 0;
6801: if ($dist =~/^fedora(\d+)$/) {
6802: if ($1 > 11) {
6803: $checkwithkrb5 = 1;
6804: }
6805: } elsif ($dist =~ /^suse([\d.]+)$/) {
6806: if ($1 > 11.1) {
6807: $checkwithkrb5 = 1;
6808: }
6809: }
6810: if ($checkwithkrb5) {
6811: $validated = &krb5_authen($password,$null,$user,$contentpwd);
6812: } else {
6813: $validated = &krb4_authen($password,$null,$user,$contentpwd);
6814: }
1.224 foxr 6815: } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
1.439 raeburn 6816: $validated = &krb5_authen($password,$null,$user,$contentpwd);
1.224 foxr 6817: } elsif ($howpwd eq "localauth") {
1.220 foxr 6818: # Authenticate via installation specific authentcation method:
6819: $validated = &localauth::localauth($user,
6820: $password,
1.353 albertel 6821: $contentpwd,
6822: $domain);
1.358 albertel 6823: if ($validated < 0) {
1.357 albertel 6824: &logthis("localauth for $contentpwd $user:$domain returned a $validated");
6825: $validated = 0;
6826: }
1.224 foxr 6827: } else { # Unrecognized auth is also bad.
1.220 foxr 6828: $validated = 0;
6829: }
6830: } else {
6831: $validated = 0;
6832: }
6833: #
6834: # $validated has the correct stat of the authentication:
6835: #
6836:
6837: unless ($validated != -3.14159) {
1.249 foxr 6838: # I >really really< want to know if this happens.
6839: # since it indicates that user authentication is badly
6840: # broken in some code path.
6841: #
6842: die "ValidateUser - failed to set the value of validated $domain, $user $password";
1.220 foxr 6843: }
6844: return $validated;
6845: }
6846:
1.439 raeburn 6847: sub krb4_authen {
6848: my ($password,$null,$user,$contentpwd) = @_;
6849: my $validated = 0;
6850: if (!($password =~ /$null/) ) { # Null password not allowed.
6851: eval {
6852: require Authen::Krb4;
6853: };
6854: if (!$@) {
6855: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
6856: "",
6857: $contentpwd,,
6858: 'krbtgt',
6859: $contentpwd,
6860: 1,
6861: $password);
6862: if(!$k4error) {
6863: $validated = 1;
6864: } else {
6865: $validated = 0;
6866: &logthis('krb4: '.$user.', '.$contentpwd.', '.
6867: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
6868: }
6869: } else {
6870: $validated = krb5_authen($password,$null,$user,$contentpwd);
6871: }
6872: }
6873: return $validated;
6874: }
6875:
6876: sub krb5_authen {
6877: my ($password,$null,$user,$contentpwd) = @_;
6878: my $validated = 0;
6879: if(!($password =~ /$null/)) { # Null password not allowed.
6880: my $krbclient = &Authen::Krb5::parse_name($user.'@'
6881: .$contentpwd);
6882: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
6883: my $krbserver = &Authen::Krb5::parse_name($krbservice);
6884: my $credentials= &Authen::Krb5::cc_default();
6885: $credentials->initialize(&Authen::Krb5::parse_name($user.'@'
6886: .$contentpwd));
6887: my $krbreturn;
6888: if (exists(&Authen::Krb5::get_init_creds_password)) {
6889: $krbreturn =
6890: &Authen::Krb5::get_init_creds_password($krbclient,$password,
6891: $krbservice);
6892: $validated = (ref($krbreturn) eq 'Authen::Krb5::Creds');
6893: } else {
6894: $krbreturn =
6895: &Authen::Krb5::get_in_tkt_with_password($krbclient,$krbserver,
6896: $password,$credentials);
6897: $validated = ($krbreturn == 1);
6898: }
6899: if (!$validated) {
6900: &logthis('krb5: '.$user.', '.$contentpwd.', '.
6901: &Authen::Krb5::error());
6902: }
6903: }
6904: return $validated;
6905: }
1.220 foxr 6906:
1.84 albertel 6907: sub addline {
6908: my ($fname,$hostid,$ip,$newline)=@_;
6909: my $contents;
6910: my $found=0;
1.355 albertel 6911: my $expr='^'.quotemeta($hostid).':'.quotemeta($ip).':';
1.134 albertel 6912: my $sh;
1.84 albertel 6913: if ($sh=IO::File->new("$fname.subscription")) {
6914: while (my $subline=<$sh>) {
6915: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
6916: }
6917: $sh->close();
6918: }
6919: $sh=IO::File->new(">$fname.subscription");
6920: if ($contents) { print $sh $contents; }
6921: if ($newline) { print $sh $newline; }
6922: $sh->close();
6923: return $found;
1.86 www 6924: }
6925:
1.234 foxr 6926: sub get_chat {
1.324 raeburn 6927: my ($cdom,$cname,$udom,$uname,$group)=@_;
1.310 albertel 6928:
1.87 www 6929: my @entries=();
1.324 raeburn 6930: my $namespace = 'nohist_chatroom';
6931: my $namespace_inroom = 'nohist_inchatroom';
1.335 albertel 6932: if ($group ne '') {
1.324 raeburn 6933: $namespace .= '_'.$group;
6934: $namespace_inroom .= '_'.$group;
6935: }
6936: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
1.310 albertel 6937: &GDBM_READER());
6938: if ($hashref) {
6939: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
1.311 albertel 6940: &untie_user_hash($hashref);
1.123 www 6941: }
1.124 www 6942: my @participants=();
1.134 albertel 6943: my $cutoff=time-60;
1.324 raeburn 6944: $hashref = &tie_user_hash($cdom, $cname, $namespace_inroom,
1.310 albertel 6945: &GDBM_WRCREAT());
6946: if ($hashref) {
6947: $hashref->{$uname.':'.$udom}=time;
6948: foreach my $user (sort(keys(%$hashref))) {
6949: if ($hashref->{$user}>$cutoff) {
6950: push(@participants, 'active_participant:'.$user);
1.123 www 6951: }
6952: }
1.311 albertel 6953: &untie_user_hash($hashref);
1.86 www 6954: }
1.124 www 6955: return (@participants,@entries);
1.86 www 6956: }
6957:
1.234 foxr 6958: sub chat_add {
1.324 raeburn 6959: my ($cdom,$cname,$newchat,$group)=@_;
1.88 albertel 6960: my @entries=();
1.142 www 6961: my $time=time;
1.324 raeburn 6962: my $namespace = 'nohist_chatroom';
6963: my $logfile = 'chatroom.log';
1.335 albertel 6964: if ($group ne '') {
1.324 raeburn 6965: $namespace .= '_'.$group;
6966: $logfile = 'chatroom_'.$group.'.log';
6967: }
6968: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
1.310 albertel 6969: &GDBM_WRCREAT());
6970: if ($hashref) {
6971: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
1.88 albertel 6972: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
6973: my ($thentime,$idnum)=split(/\_/,$lastid);
6974: my $newid=$time.'_000000';
6975: if ($thentime==$time) {
6976: $idnum=~s/^0+//;
6977: $idnum++;
6978: $idnum=substr('000000'.$idnum,-6,6);
6979: $newid=$time.'_'.$idnum;
6980: }
1.310 albertel 6981: $hashref->{$newid}=$newchat;
1.88 albertel 6982: my $expired=$time-3600;
1.310 albertel 6983: foreach my $comment (keys(%$hashref)) {
6984: my ($thistime) = ($comment=~/(\d+)\_/);
1.88 albertel 6985: if ($thistime<$expired) {
1.310 albertel 6986: delete $hashref->{$comment};
1.88 albertel 6987: }
6988: }
1.310 albertel 6989: {
6990: my $proname=&propath($cdom,$cname);
1.324 raeburn 6991: if (open(CHATLOG,">>$proname/$logfile")) {
1.310 albertel 6992: print CHATLOG ("$time:".&unescape($newchat)."\n");
6993: }
6994: close(CHATLOG);
1.142 www 6995: }
1.311 albertel 6996: &untie_user_hash($hashref);
1.86 www 6997: }
1.84 albertel 6998: }
6999:
7000: sub unsub {
7001: my ($fname,$clientip)=@_;
7002: my $result;
1.188 foxr 7003: my $unsubs = 0; # Number of successful unsubscribes:
7004:
7005:
7006: # An old way subscriptions were handled was to have a
7007: # subscription marker file:
7008:
7009: Debug("Attempting unlink of $fname.$clientname");
1.161 foxr 7010: if (unlink("$fname.$clientname")) {
1.188 foxr 7011: $unsubs++; # Successful unsub via marker file.
7012: }
7013:
7014: # The more modern way to do it is to have a subscription list
7015: # file:
7016:
1.84 albertel 7017: if (-e "$fname.subscription") {
1.161 foxr 7018: my $found=&addline($fname,$clientname,$clientip,'');
1.188 foxr 7019: if ($found) {
7020: $unsubs++;
7021: }
7022: }
7023:
7024: # If either or both of these mechanisms succeeded in unsubscribing a
7025: # resource we can return ok:
7026:
7027: if($unsubs) {
7028: $result = "ok\n";
1.84 albertel 7029: } else {
1.188 foxr 7030: $result = "not_subscribed\n";
1.84 albertel 7031: }
1.188 foxr 7032:
1.84 albertel 7033: return $result;
7034: }
7035:
1.101 www 7036: sub currentversion {
7037: my $fname=shift;
7038: my $version=-1;
7039: my $ulsdir='';
7040: if ($fname=~/^(.+)\/[^\/]+$/) {
7041: $ulsdir=$1;
7042: }
1.114 albertel 7043: my ($fnamere1,$fnamere2);
7044: # remove version if already specified
1.101 www 7045: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
1.114 albertel 7046: # get the bits that go before and after the version number
7047: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
7048: $fnamere1=$1;
7049: $fnamere2='.'.$2;
7050: }
1.101 www 7051: if (-e $fname) { $version=1; }
7052: if (-e $ulsdir) {
1.134 albertel 7053: if(-d $ulsdir) {
7054: if (opendir(LSDIR,$ulsdir)) {
7055: my $ulsfn;
7056: while ($ulsfn=readdir(LSDIR)) {
1.101 www 7057: # see if this is a regular file (ignore links produced earlier)
1.134 albertel 7058: my $thisfile=$ulsdir.'/'.$ulsfn;
7059: unless (-l $thisfile) {
1.160 www 7060: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
1.134 albertel 7061: if ($1>$version) { $version=$1; }
7062: }
7063: }
7064: }
7065: closedir(LSDIR);
7066: $version++;
7067: }
7068: }
7069: }
7070: return $version;
1.101 www 7071: }
7072:
7073: sub thisversion {
7074: my $fname=shift;
7075: my $version=-1;
7076: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
7077: $version=$1;
7078: }
7079: return $version;
7080: }
7081:
1.84 albertel 7082: sub subscribe {
7083: my ($userinput,$clientip)=@_;
7084: my $result;
1.293 albertel 7085: my ($cmd,$fname)=split(/:/,$userinput,2);
1.84 albertel 7086: my $ownership=&ishome($fname);
7087: if ($ownership eq 'owner') {
1.101 www 7088: # explitly asking for the current version?
7089: unless (-e $fname) {
7090: my $currentversion=¤tversion($fname);
7091: if (&thisversion($fname)==$currentversion) {
7092: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
7093: my $root=$1;
7094: my $extension=$2;
7095: symlink($root.'.'.$extension,
7096: $root.'.'.$currentversion.'.'.$extension);
1.102 www 7097: unless ($extension=~/\.meta$/) {
7098: symlink($root.'.'.$extension.'.meta',
7099: $root.'.'.$currentversion.'.'.$extension.'.meta');
7100: }
1.101 www 7101: }
7102: }
7103: }
1.84 albertel 7104: if (-e $fname) {
7105: if (-d $fname) {
7106: $result="directory\n";
7107: } else {
1.161 foxr 7108: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
1.134 albertel 7109: my $now=time;
1.161 foxr 7110: my $found=&addline($fname,$clientname,$clientip,
7111: "$clientname:$clientip:$now\n");
1.84 albertel 7112: if ($found) { $result="$fname\n"; }
7113: # if they were subscribed to only meta data, delete that
7114: # subscription, when you subscribe to a file you also get
7115: # the metadata
7116: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
7117: $fname=~s/\/home\/httpd\/html\/res/raw/;
1.373 albertel 7118: $fname="http://".&Apache::lonnet::hostname($perlvar{'lonHostID'})."/".$fname;
1.84 albertel 7119: $result="$fname\n";
7120: }
7121: } else {
7122: $result="not_found\n";
7123: }
7124: } else {
7125: $result="rejected\n";
7126: }
7127: return $result;
7128: }
1.287 foxr 7129: # Change the passwd of a unix user. The caller must have
7130: # first verified that the user is a loncapa user.
7131: #
7132: # Parameters:
7133: # user - Unix user name to change.
7134: # pass - New password for the user.
7135: # Returns:
7136: # ok - if success
7137: # other - Some meaningfule error message string.
7138: # NOTE:
7139: # invokes a setuid script to change the passwd.
7140: sub change_unix_password {
7141: my ($user, $pass) = @_;
7142:
7143: &Debug("change_unix_password");
7144: my $execdir=$perlvar{'lonDaemons'};
7145: &Debug("Opening lcpasswd pipeline");
7146: my $pf = IO::File->new("|$execdir/lcpasswd > "
7147: ."$perlvar{'lonDaemons'}"
7148: ."/logs/lcpasswd.log");
7149: print $pf "$user\n$pass\n$pass\n";
7150: close $pf;
7151: my $err = $?;
7152: return ($err < @passwderrors) ? $passwderrors[$err] :
7153: "pwchange_falure - unknown error";
7154:
7155:
7156: }
7157:
1.91 albertel 7158:
7159: sub make_passwd_file {
1.98 foxr 7160: my ($uname, $umode,$npass,$passfilename)=@_;
1.390 raeburn 7161: my $result="ok";
1.91 albertel 7162: if ($umode eq 'krb4' or $umode eq 'krb5') {
7163: {
7164: my $pf = IO::File->new(">$passfilename");
1.261 foxr 7165: if ($pf) {
7166: print $pf "$umode:$npass\n";
7167: } else {
7168: $result = "pass_file_failed_error";
7169: }
1.91 albertel 7170: }
7171: } elsif ($umode eq 'internal') {
7172: my $salt=time;
7173: $salt=substr($salt,6,2);
7174: my $ncpass=crypt($npass,$salt);
7175: {
7176: &Debug("Creating internal auth");
7177: my $pf = IO::File->new(">$passfilename");
1.261 foxr 7178: if($pf) {
7179: print $pf "internal:$ncpass\n";
7180: } else {
7181: $result = "pass_file_failed_error";
7182: }
1.91 albertel 7183: }
7184: } elsif ($umode eq 'localauth') {
7185: {
7186: my $pf = IO::File->new(">$passfilename");
1.261 foxr 7187: if($pf) {
7188: print $pf "localauth:$npass\n";
7189: } else {
7190: $result = "pass_file_failed_error";
7191: }
1.91 albertel 7192: }
7193: } elsif ($umode eq 'unix') {
7194: {
1.186 foxr 7195: #
7196: # Don't allow the creation of privileged accounts!!! that would
7197: # be real bad!!!
7198: #
7199: my $uid = getpwnam($uname);
7200: if((defined $uid) && ($uid == 0)) {
7201: &logthis(">>>Attempted to create privilged account blocked");
7202: return "no_priv_account_error\n";
7203: }
7204:
1.223 foxr 7205: my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
1.224 foxr 7206:
7207: my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
1.91 albertel 7208: {
7209: &Debug("Executing external: ".$execpath);
1.98 foxr 7210: &Debug("user = ".$uname.", Password =". $npass);
1.132 matthew 7211: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
1.91 albertel 7212: print $se "$uname\n";
7213: print $se "$npass\n";
7214: print $se "$npass\n";
1.223 foxr 7215: print $se "$lc_error_file\n"; # Status -> unique file.
1.97 foxr 7216: }
1.285 foxr 7217: if (-r $lc_error_file) {
7218: &Debug("Opening error file: $lc_error_file");
7219: my $error = IO::File->new("< $lc_error_file");
7220: my $useraddok = <$error>;
7221: $error->close;
7222: unlink($lc_error_file);
7223:
7224: chomp $useraddok;
7225:
7226: if($useraddok > 0) {
7227: my $error_text = &lcuseraddstrerror($useraddok);
7228: &logthis("Failed lcuseradd: $error_text");
1.390 raeburn 7229: $result = "lcuseradd_failed:$error_text";
1.285 foxr 7230: } else {
7231: my $pf = IO::File->new(">$passfilename");
7232: if($pf) {
7233: print $pf "unix:\n";
7234: } else {
7235: $result = "pass_file_failed_error";
7236: }
7237: }
1.224 foxr 7238: } else {
1.285 foxr 7239: &Debug("Could not locate lcuseradd error: $lc_error_file");
7240: $result="bug_lcuseradd_no_output_file";
1.91 albertel 7241: }
7242: }
7243: } elsif ($umode eq 'none') {
7244: {
1.223 foxr 7245: my $pf = IO::File->new("> $passfilename");
1.261 foxr 7246: if($pf) {
7247: print $pf "none:\n";
7248: } else {
7249: $result = "pass_file_failed_error";
7250: }
1.91 albertel 7251: }
7252: } else {
1.390 raeburn 7253: $result="auth_mode_error";
1.91 albertel 7254: }
7255: return $result;
1.121 albertel 7256: }
7257:
1.265 albertel 7258: sub convert_photo {
7259: my ($start,$dest)=@_;
7260: system("convert $start $dest");
7261: }
7262:
1.121 albertel 7263: sub sethost {
7264: my ($remotereq) = @_;
7265: my (undef,$hostid)=split(/:/,$remotereq);
1.322 albertel 7266: # ignore sethost if we are already correct
7267: if ($hostid eq $currenthostid) {
7268: return 'ok';
7269: }
7270:
1.121 albertel 7271: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
1.368 albertel 7272: if (&Apache::lonnet::get_host_ip($perlvar{'lonHostID'})
7273: eq &Apache::lonnet::get_host_ip($hostid)) {
1.200 matthew 7274: $currenthostid =$hostid;
1.369 albertel 7275: $currentdomainid=&Apache::lonnet::host_domain($hostid);
1.443 www 7276: # &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
1.121 albertel 7277: } else {
7278: &logthis("Requested host id $hostid not an alias of ".
7279: $perlvar{'lonHostID'}." refusing connection");
7280: return 'unable_to_set';
7281: }
7282: return 'ok';
7283: }
7284:
7285: sub version {
7286: my ($userinput)=@_;
7287: $remoteVERSION=(split(/:/,$userinput))[1];
7288: return "version:$VERSION";
1.127 albertel 7289: }
1.178 foxr 7290:
1.447 raeburn 7291: sub get_usersession_config {
7292: my ($dom,$name) = @_;
7293: my ($usersessionconf,$cached)=&Apache::lonnet::is_cached_new($name,$dom);
7294: if (defined($cached)) {
7295: return $usersessionconf;
7296: } else {
7297: my %domconfig = &Apache::lonnet::get_dom('configuration',['usersessions'],$dom);
7298: if (ref($domconfig{'usersessions'}) eq 'HASH') {
7299: &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'usersessions'},3600);
7300: return $domconfig{'usersessions'};
7301: }
7302: }
7303: return;
7304: }
1.200 matthew 7305:
1.453 raeburn 7306: sub releasereqd_check {
1.457 raeburn 7307: my ($cnum,$cdom,$key,$value,$major,$minor,$homecourses,$ids) = @_;
1.453 raeburn 7308: my $home = &Apache::lonnet::homeserver($cnum,$cdom);
7309: return if ($home eq 'no_host');
7310: my ($reqdmajor,$reqdminor,$displayrole);
7311: if ($cnum =~ /$LONCAPA::match_community/) {
7312: if ($major eq '' && $minor eq '') {
7313: return unless ((ref($ids) eq 'ARRAY') &&
7314: (grep(/^\Q$home\E$/,@{$ids})));
7315: } else {
7316: $reqdmajor = 2;
7317: $reqdminor = 9;
7318: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
7319: }
7320: }
1.457 raeburn 7321: my $hashid = $cdom.':'.$cnum;
7322: my ($courseinfo,$cached) =
7323: &Apache::lonnet::is_cached_new('courseinfo',$hashid);
7324: if (defined($cached)) {
7325: if (ref($courseinfo) eq 'HASH') {
7326: if (exists($courseinfo->{'releaserequired'})) {
7327: my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
7328: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
1.453 raeburn 7329: }
1.457 raeburn 7330: }
7331: } else {
7332: if (ref($ids) eq 'ARRAY') {
7333: if (grep(/^\Q$home\E$/,@{$ids})) {
7334: if (ref($homecourses) eq 'HASH') {
7335: if (ref($homecourses->{$hashid}) eq 'ARRAY') {
7336: push(@{$homecourses->{$hashid}},{$key=>$value});
7337: } else {
7338: $homecourses->{$hashid} = [{$key=>$value}];
1.453 raeburn 7339: }
7340: }
1.457 raeburn 7341: return;
1.453 raeburn 7342: }
1.457 raeburn 7343: }
7344: my $courseinfo = &get_courseinfo_hash($cnum,$cdom,$home);
7345: if (ref($courseinfo) eq 'HASH') {
7346: if (exists($courseinfo->{'releaserequired'})) {
7347: my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
7348: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
1.453 raeburn 7349: }
7350: }
7351: }
7352: return 1;
7353: }
7354:
1.450 raeburn 7355: sub get_courseinfo_hash {
7356: my ($cnum,$cdom,$home) = @_;
7357: my $hashid = $cdom.':'.$cnum;
1.453 raeburn 7358: my %info = &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,1,[$home],'.');
7359: if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
7360: return &Apache::lonnet::do_cache_new('courseinfo',$hashid,$info{$cdom.'_'.$cnum},600);
7361: }
7362: return;
7363: }
7364:
7365: sub check_homecourses {
7366: my ($homecourses,$udom,$regexp,$count,$range,$start,$end,$major,$minor) = @_;
7367: my ($result,%addtocache);
1.459 raeburn 7368: my $yesterday = time - 24*3600;
1.453 raeburn 7369: if (ref($homecourses) eq 'HASH') {
1.459 raeburn 7370: my (%okcourses,%courseinfo,%recent);
1.453 raeburn 7371: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
7372: if ($hashref) {
7373: while (my ($key,$value) = each(%$hashref)) {
7374: my $unesc_key = &unescape($key);
1.459 raeburn 7375: if ($unesc_key =~ /^lasttime:(\w+)$/) {
7376: my $cid = $1;
7377: $cid =~ s/_/:/;
7378: if ($value > $yesterday ) {
7379: $recent{$cid} = 1;
7380: }
7381: next;
7382: }
1.453 raeburn 7383: my $items = &Apache::lonnet::thaw_unescape($value);
7384: if (ref($items) eq 'HASH') {
7385: my $hashid = $unesc_key;
7386: $hashid =~ s/_/:/;
1.459 raeburn 7387: $courseinfo{$hashid} = $items;
1.453 raeburn 7388: if (ref($homecourses->{$hashid}) eq 'ARRAY') {
7389: my ($reqdmajor,$reqdminor) = split(/\./,$items->{'releaserequired'});
7390: if (&useable_role($reqdmajor,$reqdminor,$major,$minor)) {
7391: $okcourses{$hashid} = 1;
7392: }
7393: }
7394: }
7395: }
7396: unless (&untie_domain_hash($hashref)) {
7397: &logthis('Failed to untie tied hash for nohist_courseids.db');
7398: }
7399: } else {
7400: &logthis('Failed to tie hash for nohist_courseids.db');
7401: return;
7402: }
1.459 raeburn 7403: foreach my $hashid (keys(%recent)) {
7404: &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
7405: }
7406: foreach my $hashid (keys(%{$homecourses})) {
7407: next if ($recent{$hashid});
7408: &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
7409: }
1.453 raeburn 7410: foreach my $hashid (keys(%okcourses)) {
7411: if (ref($homecourses->{$hashid}) eq 'ARRAY') {
7412: foreach my $role (@{$homecourses->{$hashid}}) {
7413: if (ref($role) eq 'HASH') {
7414: while (my ($key,$value) = each(%{$role})) {
7415: if ($regexp eq '.') {
7416: $count++;
7417: if (defined($range) && $count >= $end) { last; }
7418: if (defined($range) && $count < $start) { next; }
7419: $result.=$key.'='.$value.'&';
7420: } else {
7421: my $unescapeKey = &unescape($key);
7422: if (eval('$unescapeKey=~/$regexp/')) {
7423: $count++;
7424: if (defined($range) && $count >= $end) { last; }
7425: if (defined($range) && $count < $start) { next; }
7426: $result.="$key=$value&";
7427: }
7428: }
7429: }
7430: }
7431: }
7432: }
1.450 raeburn 7433: }
7434: }
1.453 raeburn 7435: return $result;
7436: }
7437:
7438: sub useable_role {
7439: my ($reqdmajor,$reqdminor,$major,$minor) = @_;
7440: if ($reqdmajor ne '' && $reqdminor ne '') {
7441: return if (($major eq '' && $minor eq '') ||
7442: ($major < $reqdmajor) ||
7443: (($major == $reqdmajor) && ($minor < $reqdminor)));
7444: }
7445: return 1;
1.450 raeburn 7446: }
7447:
1.61 harris41 7448: # ----------------------------------- POD (plain old documentation, CPAN style)
7449:
7450: =head1 NAME
7451:
7452: lond - "LON Daemon" Server (port "LOND" 5663)
7453:
7454: =head1 SYNOPSIS
7455:
1.74 harris41 7456: Usage: B<lond>
7457:
7458: Should only be run as user=www. This is a command-line script which
7459: is invoked by B<loncron>. There is no expectation that a typical user
7460: will manually start B<lond> from the command-line. (In other words,
7461: DO NOT START B<lond> YOURSELF.)
1.61 harris41 7462:
7463: =head1 DESCRIPTION
7464:
1.74 harris41 7465: There are two characteristics associated with the running of B<lond>,
7466: PROCESS MANAGEMENT (starting, stopping, handling child processes)
7467: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
7468: subscriptions, etc). These are described in two large
7469: sections below.
7470:
7471: B<PROCESS MANAGEMENT>
7472:
1.61 harris41 7473: Preforker - server who forks first. Runs as a daemon. HUPs.
7474: Uses IDEA encryption
7475:
1.74 harris41 7476: B<lond> forks off children processes that correspond to the other servers
7477: in the network. Management of these processes can be done at the
7478: parent process level or the child process level.
7479:
7480: B<logs/lond.log> is the location of log messages.
7481:
7482: The process management is now explained in terms of linux shell commands,
7483: subroutines internal to this code, and signal assignments:
7484:
7485: =over 4
7486:
7487: =item *
7488:
7489: PID is stored in B<logs/lond.pid>
7490:
7491: This is the process id number of the parent B<lond> process.
7492:
7493: =item *
7494:
7495: SIGTERM and SIGINT
7496:
7497: Parent signal assignment:
7498: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
7499:
7500: Child signal assignment:
7501: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
7502: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
7503: to restart a new child.)
7504:
7505: Command-line invocations:
7506: B<kill> B<-s> SIGTERM I<PID>
7507: B<kill> B<-s> SIGINT I<PID>
7508:
7509: Subroutine B<HUNTSMAN>:
7510: This is only invoked for the B<lond> parent I<PID>.
7511: This kills all the children, and then the parent.
7512: The B<lonc.pid> file is cleared.
7513:
7514: =item *
7515:
7516: SIGHUP
7517:
7518: Current bug:
7519: This signal can only be processed the first time
7520: on the parent process. Subsequent SIGHUP signals
7521: have no effect.
7522:
7523: Parent signal assignment:
7524: $SIG{HUP} = \&HUPSMAN;
7525:
7526: Child signal assignment:
7527: none (nothing happens)
7528:
7529: Command-line invocations:
7530: B<kill> B<-s> SIGHUP I<PID>
7531:
7532: Subroutine B<HUPSMAN>:
7533: This is only invoked for the B<lond> parent I<PID>,
7534: This kills all the children, and then the parent.
7535: The B<lond.pid> file is cleared.
7536:
7537: =item *
7538:
7539: SIGUSR1
7540:
7541: Parent signal assignment:
7542: $SIG{USR1} = \&USRMAN;
7543:
7544: Child signal assignment:
7545: $SIG{USR1}= \&logstatus;
7546:
7547: Command-line invocations:
7548: B<kill> B<-s> SIGUSR1 I<PID>
7549:
7550: Subroutine B<USRMAN>:
7551: When invoked for the B<lond> parent I<PID>,
7552: SIGUSR1 is sent to all the children, and the status of
7553: each connection is logged.
1.144 foxr 7554:
7555: =item *
7556:
7557: SIGUSR2
7558:
7559: Parent Signal assignment:
7560: $SIG{USR2} = \&UpdateHosts
7561:
7562: Child signal assignment:
7563: NONE
7564:
1.74 harris41 7565:
7566: =item *
7567:
7568: SIGCHLD
7569:
7570: Parent signal assignment:
7571: $SIG{CHLD} = \&REAPER;
7572:
7573: Child signal assignment:
7574: none
7575:
7576: Command-line invocations:
7577: B<kill> B<-s> SIGCHLD I<PID>
7578:
7579: Subroutine B<REAPER>:
7580: This is only invoked for the B<lond> parent I<PID>.
7581: Information pertaining to the child is removed.
7582: The socket port is cleaned up.
7583:
7584: =back
7585:
7586: B<SERVER-SIDE ACTIVITIES>
7587:
7588: Server-side information can be accepted in an encrypted or non-encrypted
7589: method.
7590:
7591: =over 4
7592:
7593: =item ping
7594:
7595: Query a client in the hosts.tab table; "Are you there?"
7596:
7597: =item pong
7598:
7599: Respond to a ping query.
7600:
7601: =item ekey
7602:
7603: Read in encrypted key, make cipher. Respond with a buildkey.
7604:
7605: =item load
7606:
7607: Respond with CPU load based on a computation upon /proc/loadavg.
7608:
7609: =item currentauth
7610:
7611: Reply with current authentication information (only over an
7612: encrypted channel).
7613:
7614: =item auth
7615:
7616: Only over an encrypted channel, reply as to whether a user's
7617: authentication information can be validated.
7618:
7619: =item passwd
7620:
7621: Allow for a password to be set.
7622:
7623: =item makeuser
7624:
7625: Make a user.
7626:
7627: =item passwd
7628:
7629: Allow for authentication mechanism and password to be changed.
7630:
7631: =item home
1.61 harris41 7632:
1.74 harris41 7633: Respond to a question "are you the home for a given user?"
7634:
7635: =item update
7636:
7637: Update contents of a subscribed resource.
7638:
7639: =item unsubscribe
7640:
7641: The server is unsubscribing from a resource.
7642:
7643: =item subscribe
7644:
7645: The server is subscribing to a resource.
7646:
7647: =item log
7648:
7649: Place in B<logs/lond.log>
7650:
7651: =item put
7652:
7653: stores hash in namespace
7654:
1.230 foxr 7655: =item rolesputy
1.74 harris41 7656:
7657: put a role into a user's environment
7658:
7659: =item get
7660:
7661: returns hash with keys from array
7662: reference filled in from namespace
7663:
7664: =item eget
7665:
7666: returns hash with keys from array
7667: reference filled in from namesp (encrypts the return communication)
7668:
7669: =item rolesget
7670:
7671: get a role from a user's environment
7672:
7673: =item del
7674:
7675: deletes keys out of array from namespace
7676:
7677: =item keys
7678:
7679: returns namespace keys
7680:
7681: =item dump
7682:
7683: dumps the complete (or key matching regexp) namespace into a hash
7684:
7685: =item store
7686:
7687: stores hash permanently
7688: for this url; hashref needs to be given and should be a \%hashname; the
7689: remaining args aren't required and if they aren't passed or are '' they will
7690: be derived from the ENV
7691:
7692: =item restore
7693:
7694: returns a hash for a given url
7695:
7696: =item querysend
7697:
7698: Tells client about the lonsql process that has been launched in response
7699: to a sent query.
7700:
7701: =item queryreply
7702:
7703: Accept information from lonsql and make appropriate storage in temporary
7704: file space.
7705:
7706: =item idput
7707:
7708: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
7709: for each student, defined perhaps by the institutional Registrar.)
7710:
7711: =item idget
7712:
7713: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
7714: for each student, defined perhaps by the institutional Registrar.)
7715:
7716: =item tmpput
7717:
7718: Accept and store information in temporary space.
7719:
7720: =item tmpget
7721:
7722: Send along temporarily stored information.
7723:
7724: =item ls
7725:
7726: List part of a user's directory.
7727:
1.135 foxr 7728: =item pushtable
7729:
7730: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
7731: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
7732: must be restored manually in case of a problem with the new table file.
7733: pushtable requires that the request be encrypted and validated via
7734: ValidateManager. The form of the command is:
7735: enc:pushtable tablename <tablecontents> \n
7736: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
7737: cleartext newline.
7738:
1.74 harris41 7739: =item Hanging up (exit or init)
7740:
7741: What to do when a client tells the server that they (the client)
7742: are leaving the network.
7743:
7744: =item unknown command
7745:
7746: If B<lond> is sent an unknown command (not in the list above),
7747: it replys to the client "unknown_cmd".
1.135 foxr 7748:
1.74 harris41 7749:
7750: =item UNKNOWN CLIENT
7751:
7752: If the anti-spoofing algorithm cannot verify the client,
7753: the client is rejected (with a "refused" message sent
7754: to the client, and the connection is closed.
7755:
7756: =back
1.61 harris41 7757:
7758: =head1 PREREQUISITES
7759:
7760: IO::Socket
7761: IO::File
7762: Apache::File
7763: POSIX
7764: Crypt::IDEA
7765: LWP::UserAgent()
7766: GDBM_File
7767: Authen::Krb4
1.91 albertel 7768: Authen::Krb5
1.61 harris41 7769:
7770: =head1 COREQUISITES
7771:
7772: =head1 OSNAMES
7773:
7774: linux
7775:
7776: =head1 SCRIPT CATEGORIES
7777:
7778: Server/Process
7779:
7780: =cut
1.409 foxr 7781:
7782:
7783: =pod
7784:
7785: =head1 LOG MESSAGES
7786:
7787: The messages below can be emitted in the lond log. This log is located
7788: in ~httpd/perl/logs/lond.log Many log messages have HTML encapsulation
7789: to provide coloring if examined from inside a web page. Some do not.
7790: Where color is used, the colors are; Red for sometihhng to get excited
7791: about and to follow up on. Yellow for something to keep an eye on to
7792: be sure it does not get worse, Green,and Blue for informational items.
7793:
7794: In the discussions below, sometimes reference is made to ~httpd
7795: when describing file locations. There isn't really an httpd
7796: user, however there is an httpd directory that gets installed in the
7797: place that user home directories go. On linux, this is usually
7798: (always?) /home/httpd.
7799:
7800:
7801: Some messages are colorless. These are usually (not always)
7802: Green/Blue color level messages.
7803:
7804: =over 2
7805:
7806: =item (Red) LocalConnection rejecting non local: <ip> ne 127.0.0.1
7807:
7808: A local connection negotiation was attempted by
7809: a host whose IP address was not 127.0.0.1.
7810: The socket is closed and the child will exit.
7811: lond has three ways to establish an encyrption
7812: key with a client:
7813:
7814: =over 2
7815:
7816: =item local
7817:
7818: The key is written and read from a file.
7819: This is only valid for connections from localhost.
7820:
7821: =item insecure
7822:
7823: The key is generated by the server and
7824: transmitted to the client.
7825:
7826: =item ssl (secure)
7827:
7828: An ssl connection is negotiated with the client,
7829: the key is generated by the server and sent to the
7830: client across this ssl connection before the
7831: ssl connectionis terminated and clear text
7832: transmission resumes.
7833:
7834: =back
7835:
7836: =item (Red) LocalConnection: caller is insane! init = <init> and type = <type>
7837:
7838: The client is local but has not sent an initialization
7839: string that is the literal "init:local" The connection
7840: is closed and the child exits.
7841:
7842: =item Red CRITICAL Can't get key file <error>
7843:
7844: SSL key negotiation is being attempted but the call to
7845: lonssl::KeyFile failed. This usually means that the
7846: configuration file is not correctly defining or protecting
7847: the directories/files lonCertificateDirectory or
7848: lonnetPrivateKey
7849: <error> is a string that describes the reason that
7850: the key file could not be located.
7851:
7852: =item (Red) CRITICAL Can't get certificates <error>
7853:
7854: SSL key negotiation failed because we were not able to retrives our certificate
7855: or the CA's certificate in the call to lonssl::CertificateFile
7856: <error> is the textual reason this failed. Usual reasons:
7857:
7858: =over 2
7859:
7860: =item Apache config file for loncapa incorrect:
7861:
7862: one of the variables
7863: lonCertificateDirectory, lonnetCertificateAuthority, or lonnetCertificate
7864: undefined or incorrect
7865:
7866: =item Permission error:
7867:
7868: The directory pointed to by lonCertificateDirectory is not readable by lond
7869:
7870: =item Permission error:
7871:
7872: Files in the directory pointed to by lonCertificateDirectory are not readable by lond.
7873:
7874: =item Installation error:
7875:
7876: Either the certificate authority file or the certificate have not
7877: been installed in lonCertificateDirectory.
7878:
7879: =item (Red) CRITICAL SSL Socket promotion failed: <err>
7880:
7881: The promotion of the connection from plaintext to SSL failed
7882: <err> is the reason for the failure. There are two
7883: system calls involved in the promotion (one of which failed),
7884: a dup to produce
7885: a second fd on the raw socket over which the encrypted data
7886: will flow and IO::SOcket::SSL->new_from_fd which creates
7887: the SSL connection on the duped fd.
7888:
7889: =item (Blue) WARNING client did not respond to challenge
7890:
7891: This occurs on an insecure (non SSL) connection negotiation request.
7892: lond generates some number from the time, the PID and sends it to
7893: the client. The client must respond by echoing this information back.
7894: If the client does not do so, that's a violation of the challenge
7895: protocols and the connection will be failed.
7896:
7897: =item (Red) No manager table. Nobody can manage!!
7898:
7899: lond has the concept of privileged hosts that
7900: can perform remote management function such
7901: as update the hosts.tab. The manager hosts
7902: are described in the
7903: ~httpd/lonTabs/managers.tab file.
7904: this message is logged if this file is missing.
7905:
7906:
7907: =item (Green) Registering manager <dnsname> as <cluster_name> with <ipaddress>
7908:
7909: Reports the successful parse and registration
7910: of a specific manager.
7911:
7912: =item Green existing host <clustername:dnsname>
7913:
7914: The manager host is already defined in the hosts.tab
7915: the information in that table, rather than the info in the
7916: manager table will be used to determine the manager's ip.
7917:
7918: =item (Red) Unable to craete <filename>
7919:
7920: lond has been asked to create new versions of an administrative
7921: file (by a manager). When this is done, the new file is created
7922: in a temp file and then renamed into place so that there are always
7923: usable administrative files, even if the update fails. This failure
7924: message means that the temp file could not be created.
7925: The update is abandoned, and the old file is available for use.
7926:
7927: =item (Green) CopyFile from <oldname> to <newname> failed
7928:
7929: In an update of administrative files, the copy of the existing file to a
7930: backup file failed. The installation of the new file may still succeed,
7931: but there will not be a back up file to rever to (this should probably
7932: be yellow).
7933:
7934: =item (Green) Pushfile: backed up <oldname> to <newname>
7935:
7936: See above, the backup of the old administrative file succeeded.
7937:
7938: =item (Red) Pushfile: Unable to install <filename> <reason>
7939:
7940: The new administrative file could not be installed. In this case,
7941: the old administrative file is still in use.
7942:
7943: =item (Green) Installed new < filename>.
7944:
7945: The new administrative file was successfullly installed.
7946:
7947: =item (Red) Reinitializing lond pid=<pid>
7948:
7949: The lonc child process <pid> will be sent a USR2
7950: signal.
7951:
7952: =item (Red) Reinitializing self
7953:
7954: We've been asked to re-read our administrative files,and
7955: are doing so.
7956:
7957: =item (Yellow) error:Invalid process identifier <ident>
7958:
7959: A reinit command was received, but the target part of the
7960: command was not valid. It must be either
7961: 'lond' or 'lonc' but was <ident>
7962:
7963: =item (Green) isValideditCommand checking: Command = <command> Key = <key> newline = <newline>
7964:
7965: Checking to see if lond has been handed a valid edit
7966: command. It is possible the edit command is not valid
7967: in that case there are no log messages to indicate that.
7968:
7969: =item Result of password change for <username> pwchange_success
7970:
7971: The password for <username> was
7972: successfully changed.
7973:
7974: =item Unable to open <user> passwd to change password
7975:
7976: Could not rewrite the
7977: internal password file for a user
7978:
7979: =item Result of password change for <user> : <result>
7980:
7981: A unix password change for <user> was attempted
7982: and the pipe returned <result>
7983:
7984: =item LWP GET: <message> for <fname> (<remoteurl>)
7985:
7986: The lightweight process fetch for a resource failed
7987: with <message> the local filename that should
7988: have existed/been created was <fname> the
7989: corresponding URI: <remoteurl> This is emitted in several
7990: places.
7991:
7992: =item Unable to move <transname> to <destname>
7993:
7994: From fetch_user_file_handler - the user file was replicated but could not
7995: be mv'd to its final location.
7996:
7997: =item Looking for <domain> <username>
7998:
7999: From user_has_session_handler - This should be a Debug call instead
8000: it indicates lond is about to check whether the specified user has a
8001: session active on the specified domain on the local host.
8002:
8003: =item Client <ip> (<name>) hanging up: <input>
8004:
8005: lond has been asked to exit by its client. The <ip> and <name> identify the
8006: client systemand <input> is the full exit command sent to the server.
8007:
8008: =item Red CRITICAL: ABNORMAL EXIT. child <pid> for server <hostname> died through a crass with this error->[<message>].
8009:
8010: A lond child terminated. NOte that this termination can also occur when the
8011: child receives the QUIT or DIE signals. <pid> is the process id of the child,
8012: <hostname> the host lond is working for, and <message> the reason the child died
8013: to the best of our ability to get it (I would guess that any numeric value
8014: represents and errno value). This is immediately followed by
8015:
8016: =item Famous last words: Catching exception - <log>
8017:
8018: Where log is some recent information about the state of the child.
8019:
8020: =item Red CRITICAL: TIME OUT <pid>
8021:
8022: Some timeout occured for server <pid>. THis is normally a timeout on an LWP
8023: doing an HTTP::GET.
8024:
8025: =item child <pid> died
8026:
8027: The reaper caught a SIGCHILD for the lond child process <pid>
8028: This should be modified to also display the IP of the dying child
8029: $children{$pid}
8030:
8031: =item Unknown child 0 died
8032: A child died but the wait for it returned a pid of zero which really should not
8033: ever happen.
8034:
8035: =item Child <which> - <pid> looks like we missed it's death
8036:
8037: When a sigchild is received, the reaper process checks all children to see if they are
8038: alive. If children are dying quite quickly, the lack of signal queuing can mean
8039: that a signal hearalds the death of more than one child. If so this message indicates
8040: which other one died. <which> is the ip of a dead child
8041:
8042: =item Free socket: <shutdownretval>
8043:
8044: The HUNTSMAN sub was called due to a SIGINT in a child process. The socket is being shutdown.
8045: for whatever reason, <shutdownretval> is printed but in fact shutdown() is not documented
8046: to return anything. This is followed by:
8047:
8048: =item Red CRITICAL: Shutting down
8049:
8050: Just prior to exit.
8051:
8052: =item Free socket: <shutdownretval>
8053:
8054: The HUPSMAN sub was called due to a SIGHUP. all children get killsed, and lond execs itself.
8055: This is followed by:
8056:
8057: =item (Red) CRITICAL: Restarting
8058:
8059: lond is about to exec itself to restart.
8060:
8061: =item (Blue) Updating connections
8062:
8063: (In response to a USR2). All the children (except the one for localhost)
8064: are about to be killed, the hosts tab reread, and Apache reloaded via apachereload.
8065:
8066: =item (Blue) UpdateHosts killing child <pid> for ip <ip>
8067:
8068: Due to USR2 as above.
8069:
8070: =item (Green) keeping child for ip <ip> (pid = <pid>)
8071:
8072: In response to USR2 as above, the child indicated is not being restarted because
8073: it's assumed that we'll always need a child for the localhost.
8074:
8075:
8076: =item Going to check on the children
8077:
8078: Parent is about to check on the health of the child processes.
8079: Note that this is in response to a USR1 sent to the parent lond.
8080: there may be one or more of the next two messages:
8081:
8082: =item <pid> is dead
8083:
8084: A child that we have in our child hash as alive has evidently died.
8085:
8086: =item Child <pid> did not respond
8087:
8088: In the health check the child <pid> did not update/produce a pid_.txt
8089: file when sent it's USR1 signal. That process is killed with a 9 signal, as it's
8090: assumed to be hung in some un-fixable way.
8091:
8092: =item Finished checking children
8093:
8094: Master processs's USR1 processing is cojmplete.
8095:
8096: =item (Red) CRITICAL: ------- Starting ------
8097:
8098: (There are more '-'s on either side). Lond has forked itself off to
8099: form a new session and is about to start actual initialization.
8100:
8101: =item (Green) Attempting to start child (<client>)
8102:
8103: Started a new child process for <client>. Client is IO::Socket object
8104: connected to the child. This was as a result of a TCP/IP connection from a client.
8105:
8106: =item Unable to determine who caller was, getpeername returned nothing
8107:
8108: In child process initialization. either getpeername returned undef or
8109: a zero sized object was returned. Processing continues, but in my opinion,
8110: this should be cause for the child to exit.
8111:
8112: =item Unable to determine clientip
8113:
8114: In child process initialization. The peer address from getpeername was not defined.
8115: The client address is stored as "Unavailable" and processing continues.
8116:
8117: =item (Yellow) INFO: Connection <ip> <name> connection type = <type>
8118:
8119: In child initialization. A good connectionw as received from <ip>.
8120:
8121: =over 2
8122:
8123: =item <name>
8124:
8125: is the name of the client from hosts.tab.
8126:
8127: =item <type>
8128:
8129: Is the connection type which is either
8130:
8131: =over 2
8132:
8133: =item manager
8134:
8135: The connection is from a manager node, not in hosts.tab
8136:
8137: =item client
8138:
8139: the connection is from a non-manager in the hosts.tab
8140:
8141: =item both
8142:
8143: The connection is from a manager in the hosts.tab.
8144:
8145: =back
8146:
8147: =back
8148:
8149: =item (Blue) Certificates not installed -- trying insecure auth
8150:
8151: One of the certificate file, key file or
8152: certificate authority file could not be found for a client attempting
8153: SSL connection intiation. COnnection will be attemptied in in-secure mode.
8154: (this would be a system with an up to date lond that has not gotten a
8155: certificate from us).
8156:
8157: =item (Green) Successful local authentication
8158:
8159: A local connection successfully negotiated the encryption key.
8160: In this case the IDEA key is in a file (that is hopefully well protected).
8161:
8162: =item (Green) Successful ssl authentication with <client>
8163:
8164: The client (<client> is the peer's name in hosts.tab), has successfully
8165: negotiated an SSL connection with this child process.
8166:
8167: =item (Green) Successful insecure authentication with <client>
8168:
8169:
8170: The client has successfully negotiated an insecure connection withthe child process.
8171:
8172: =item (Yellow) Attempted insecure connection disallowed
8173:
8174: The client attempted and failed to successfully negotiate a successful insecure
8175: connection. This can happen either because the variable londAllowInsecure is false
8176: or undefined, or becuse the child did not successfully echo back the challenge
8177: string.
8178:
8179:
8180: =back
8181:
1.441 raeburn 8182: =back
8183:
1.409 foxr 8184:
8185: =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