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