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