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