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