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