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