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