Annotation of loncom/lond, revision 1.396
1.1 albertel 1: #!/usr/bin/perl
2: # The LearningOnline Network
3: # lond "LON Daemon" Server (port "LOND" 5663)
1.60 www 4: #
1.396 ! raeburn 5: # $Id: lond,v 1.395 2008/02/21 16:04:19 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.396 ! raeburn 62: my $VERSION='$Revision: 1.395 $'; #' 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.
1.396 ! raeburn 1517: # checkdefauth - Pass to validate_user() to try authentication
! 1518: # with default auth type(s) if no user account.
1.220 foxr 1519:
1.396 ! raeburn 1520: my ($udom, $uname, $upass, $checkdefauth)=split(/:/,$tail);
1.220 foxr 1521: &Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
1522: chomp($upass);
1523: $upass=&unescape($upass);
1524:
1.396 ! raeburn 1525: my $pwdcorrect = &validate_user($udom,$uname,$upass,$checkdefauth);
1.220 foxr 1526: if($pwdcorrect) {
1527: &Reply( $client, "authorized\n", $userinput);
1528: #
1529: # Bad credentials: Failed to authorize
1530: #
1531: } else {
1532: &Failure( $client, "non_authorized\n", $userinput);
1533: }
1534:
1535: return 1;
1536: }
1.263 albertel 1537: ®ister_handler("auth", \&authenticate_handler, 1, 1, 0);
1.214 foxr 1538:
1.222 foxr 1539: #
1540: # Change a user's password. Note that this function is complicated by
1541: # the fact that a user may be authenticated in more than one way:
1542: # At present, we are not able to change the password for all types of
1543: # authentication methods. Only for:
1544: # unix - unix password or shadow passoword style authentication.
1545: # local - Locally written authentication mechanism.
1546: # For now, kerb4 and kerb5 password changes are not supported and result
1547: # in an error.
1548: # FUTURE WORK:
1549: # Support kerberos passwd changes?
1550: # Parameters:
1551: # $cmd - The command that got us here.
1552: # $tail - Tail of the command (remaining parameters).
1553: # $client - File descriptor connected to client.
1554: # Returns
1555: # 0 - Requested to exit, caller should shut down.
1556: # 1 - Continue processing.
1557: # Implicit inputs:
1558: # The authentication systems describe above have their own forms of implicit
1559: # input into the authentication process that are described above.
1560: sub change_password_handler {
1561: my ($cmd, $tail, $client) = @_;
1562:
1563: my $userinput = $cmd.":".$tail; # Reconstruct client's string.
1564:
1565: #
1566: # udom - user's domain.
1567: # uname - Username.
1568: # upass - Current password.
1569: # npass - New password.
1.346 raeburn 1570: # context - Context in which this was called
1571: # (preferences or reset_by_email).
1.222 foxr 1572:
1.346 raeburn 1573: my ($udom,$uname,$upass,$npass,$context)=split(/:/,$tail);
1.222 foxr 1574:
1575: $upass=&unescape($upass);
1576: $npass=&unescape($npass);
1577: &Debug("Trying to change password for $uname");
1578:
1579: # First require that the user can be authenticated with their
1.346 raeburn 1580: # old password unless context was 'reset_by_email':
1581:
1582: my $validated;
1583: if ($context eq 'reset_by_email') {
1584: $validated = 1;
1585: } else {
1586: $validated = &validate_user($udom, $uname, $upass);
1587: }
1.222 foxr 1588: if($validated) {
1589: my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
1590:
1591: my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
1592: if ($howpwd eq 'internal') {
1593: &Debug("internal auth");
1594: my $salt=time;
1595: $salt=substr($salt,6,2);
1596: my $ncpass=crypt($npass,$salt);
1597: if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
1598: &logthis("Result of password change for "
1599: ."$uname: pwchange_success");
1600: &Reply($client, "ok\n", $userinput);
1601: } else {
1602: &logthis("Unable to open $uname passwd "
1603: ."to change password");
1604: &Failure( $client, "non_authorized\n",$userinput);
1605: }
1.346 raeburn 1606: } elsif ($howpwd eq 'unix' && $context ne 'reset_by_email') {
1.287 foxr 1607: my $result = &change_unix_password($uname, $npass);
1.222 foxr 1608: &logthis("Result of password change for $uname: ".
1.287 foxr 1609: $result);
1.387 albertel 1610: &Reply($client, \$result, $userinput);
1.222 foxr 1611: } else {
1612: # this just means that the current password mode is not
1613: # one we know how to change (e.g the kerberos auth modes or
1614: # locally written auth handler).
1615: #
1616: &Failure( $client, "auth_mode_error\n", $userinput);
1617: }
1618:
1.224 foxr 1619: } else {
1.222 foxr 1620: &Failure( $client, "non_authorized\n", $userinput);
1621: }
1622:
1623: return 1;
1624: }
1.263 albertel 1625: ®ister_handler("passwd", \&change_password_handler, 1, 1, 0);
1.222 foxr 1626:
1.225 foxr 1627: #
1628: # Create a new user. User in this case means a lon-capa user.
1629: # The user must either already exist in some authentication realm
1630: # like kerberos or the /etc/passwd. If not, a user completely local to
1631: # this loncapa system is created.
1632: #
1633: # Parameters:
1634: # $cmd - The command that got us here.
1635: # $tail - Tail of the command (remaining parameters).
1636: # $client - File descriptor connected to client.
1637: # Returns
1638: # 0 - Requested to exit, caller should shut down.
1639: # 1 - Continue processing.
1640: # Implicit inputs:
1641: # The authentication systems describe above have their own forms of implicit
1642: # input into the authentication process that are described above.
1643: sub add_user_handler {
1644:
1645: my ($cmd, $tail, $client) = @_;
1646:
1647:
1648: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1649: my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
1650:
1651: &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
1652:
1653:
1654: if($udom eq $currentdomainid) { # Reject new users for other domains...
1655:
1656: my $oldumask=umask(0077);
1657: chomp($npass);
1658: $npass=&unescape($npass);
1659: my $passfilename = &password_path($udom, $uname);
1660: &Debug("Password file created will be:".$passfilename);
1661: if (-e $passfilename) {
1662: &Failure( $client, "already_exists\n", $userinput);
1663: } else {
1664: my $fperror='';
1.264 albertel 1665: if (!&mkpath($passfilename)) {
1666: $fperror="error: ".($!+0)." mkdir failed while attempting "
1667: ."makeuser";
1.225 foxr 1668: }
1669: unless ($fperror) {
1670: my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
1.390 raeburn 1671: &Reply($client,\$result, $userinput); #BUGBUG - could be fail
1.225 foxr 1672: } else {
1.387 albertel 1673: &Failure($client, \$fperror, $userinput);
1.225 foxr 1674: }
1675: }
1676: umask($oldumask);
1677: } else {
1678: &Failure($client, "not_right_domain\n",
1679: $userinput); # Even if we are multihomed.
1680:
1681: }
1682: return 1;
1683:
1684: }
1685: ®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
1686:
1687: #
1688: # Change the authentication method of a user. Note that this may
1689: # also implicitly change the user's password if, for example, the user is
1690: # joining an existing authentication realm. Known authentication realms at
1691: # this time are:
1692: # internal - Purely internal password file (only loncapa knows this user)
1693: # local - Institutionally written authentication module.
1694: # unix - Unix user (/etc/passwd with or without /etc/shadow).
1695: # kerb4 - kerberos version 4
1696: # kerb5 - kerberos version 5
1697: #
1698: # Parameters:
1699: # $cmd - The command that got us here.
1700: # $tail - Tail of the command (remaining parameters).
1701: # $client - File descriptor connected to client.
1702: # Returns
1703: # 0 - Requested to exit, caller should shut down.
1704: # 1 - Continue processing.
1705: # Implicit inputs:
1706: # The authentication systems describe above have their own forms of implicit
1707: # input into the authentication process that are described above.
1.287 foxr 1708: # NOTE:
1709: # This is also used to change the authentication credential values (e.g. passwd).
1710: #
1.225 foxr 1711: #
1712: sub change_authentication_handler {
1713:
1714: my ($cmd, $tail, $client) = @_;
1715:
1716: my $userinput = "$cmd:$tail"; # Reconstruct user input.
1717:
1718: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1719: &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
1720: if ($udom ne $currentdomainid) {
1721: &Failure( $client, "not_right_domain\n", $client);
1722: } else {
1723:
1724: chomp($npass);
1725:
1726: $npass=&unescape($npass);
1.261 foxr 1727: my $oldauth = &get_auth_type($udom, $uname); # Get old auth info.
1.225 foxr 1728: my $passfilename = &password_path($udom, $uname);
1729: if ($passfilename) { # Not allowed to create a new user!!
1.287 foxr 1730: # If just changing the unix passwd. need to arrange to run
1731: # passwd since otherwise make_passwd_file will run
1732: # lcuseradd which fails if an account already exists
1733: # (to prevent an unscrupulous LONCAPA admin from stealing
1734: # an existing account by overwriting it as a LonCAPA account).
1735:
1736: if(($oldauth =~/^unix/) && ($umode eq "unix")) {
1737: my $result = &change_unix_password($uname, $npass);
1738: &logthis("Result of password change for $uname: ".$result);
1739: if ($result eq "ok") {
1.390 raeburn 1740: &Reply($client, \$result);
1.288 albertel 1741: } else {
1.387 albertel 1742: &Failure($client, \$result);
1.287 foxr 1743: }
1.288 albertel 1744: } else {
1.287 foxr 1745: my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
1746: #
1747: # If the current auth mode is internal, and the old auth mode was
1748: # unix, or krb*, and the user is an author for this domain,
1749: # re-run manage_permissions for that role in order to be able
1750: # to take ownership of the construction space back to www:www
1751: #
1752:
1753:
1754: if( (($oldauth =~ /^unix/) && ($umode eq "internal")) ||
1755: (($oldauth =~ /^internal/) && ($umode eq "unix")) ) {
1756: if(&is_author($udom, $uname)) {
1757: &Debug(" Need to manage author permissions...");
1758: &manage_permissions("/$udom/_au", $udom, $uname, "$umode:");
1759: }
1.261 foxr 1760: }
1.387 albertel 1761: &Reply($client, \$result, $userinput);
1.261 foxr 1762: }
1763:
1764:
1.225 foxr 1765: } else {
1.251 foxr 1766: &Failure($client, "non_authorized\n", $userinput); # Fail the user now.
1.225 foxr 1767: }
1768: }
1769: return 1;
1770: }
1771: ®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
1772:
1773: #
1774: # Determines if this is the home server for a user. The home server
1775: # for a user will have his/her lon-capa passwd file. Therefore all we need
1776: # to do is determine if this file exists.
1777: #
1778: # Parameters:
1779: # $cmd - The command that got us here.
1780: # $tail - Tail of the command (remaining parameters).
1781: # $client - File descriptor connected to client.
1782: # Returns
1783: # 0 - Requested to exit, caller should shut down.
1784: # 1 - Continue processing.
1785: # Implicit inputs:
1786: # The authentication systems describe above have their own forms of implicit
1787: # input into the authentication process that are described above.
1788: #
1789: sub is_home_handler {
1790: my ($cmd, $tail, $client) = @_;
1791:
1792: my $userinput = "$cmd:$tail";
1793:
1794: my ($udom,$uname)=split(/:/,$tail);
1795: chomp($uname);
1796: my $passfile = &password_filename($udom, $uname);
1797: if($passfile) {
1798: &Reply( $client, "found\n", $userinput);
1799: } else {
1800: &Failure($client, "not_found\n", $userinput);
1801: }
1802: return 1;
1803: }
1804: ®ister_handler("home", \&is_home_handler, 0,1,0);
1805:
1806: #
1807: # Process an update request for a resource?? I think what's going on here is
1808: # that a resource has been modified that we hold a subscription to.
1809: # If the resource is not local, then we must update, or at least invalidate our
1810: # cached copy of the resource.
1811: # FUTURE WORK:
1812: # I need to look at this logic carefully. My druthers would be to follow
1813: # typical caching logic, and simple invalidate the cache, drop any subscription
1814: # an let the next fetch start the ball rolling again... however that may
1815: # actually be more difficult than it looks given the complex web of
1816: # proxy servers.
1817: # Parameters:
1818: # $cmd - The command that got us here.
1819: # $tail - Tail of the command (remaining parameters).
1820: # $client - File descriptor connected to client.
1821: # Returns
1822: # 0 - Requested to exit, caller should shut down.
1823: # 1 - Continue processing.
1824: # Implicit inputs:
1825: # The authentication systems describe above have their own forms of implicit
1826: # input into the authentication process that are described above.
1827: #
1828: sub update_resource_handler {
1829:
1830: my ($cmd, $tail, $client) = @_;
1831:
1832: my $userinput = "$cmd:$tail";
1833:
1834: my $fname= $tail; # This allows interactive testing
1835:
1836:
1837: my $ownership=ishome($fname);
1838: if ($ownership eq 'not_owner') {
1839: if (-e $fname) {
1840: my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
1841: $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
1842: my $now=time;
1843: my $since=$now-$atime;
1844: if ($since>$perlvar{'lonExpire'}) {
1.365 albertel 1845: my $reply=&Apache::lonnet::reply("unsub:$fname","$clientname");
1.308 albertel 1846: &devalidate_meta_cache($fname);
1.225 foxr 1847: unlink("$fname");
1.334 albertel 1848: unlink("$fname.meta");
1.225 foxr 1849: } else {
1850: my $transname="$fname.in.transfer";
1.365 albertel 1851: my $remoteurl=&Apache::lonnet::reply("sub:$fname","$clientname");
1.225 foxr 1852: my $response;
1853: alarm(120);
1854: {
1855: my $ua=new LWP::UserAgent;
1856: my $request=new HTTP::Request('GET',"$remoteurl");
1857: $response=$ua->request($request,$transname);
1858: }
1859: alarm(0);
1860: if ($response->is_error()) {
1861: unlink($transname);
1862: my $message=$response->status_line;
1863: &logthis("LWP GET: $message for $fname ($remoteurl)");
1864: } else {
1865: if ($remoteurl!~/\.meta$/) {
1866: alarm(120);
1867: {
1868: my $ua=new LWP::UserAgent;
1869: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1870: my $mresponse=$ua->request($mrequest,$fname.'.meta');
1871: if ($mresponse->is_error()) {
1872: unlink($fname.'.meta');
1873: }
1874: }
1875: alarm(0);
1876: }
1877: rename($transname,$fname);
1.308 albertel 1878: &devalidate_meta_cache($fname);
1.225 foxr 1879: }
1880: }
1881: &Reply( $client, "ok\n", $userinput);
1882: } else {
1883: &Failure($client, "not_found\n", $userinput);
1884: }
1885: } else {
1886: &Failure($client, "rejected\n", $userinput);
1887: }
1888: return 1;
1889: }
1890: ®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
1891:
1.308 albertel 1892: sub devalidate_meta_cache {
1893: my ($url) = @_;
1894: use Cache::Memcached;
1895: my $memcache = new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
1.365 albertel 1896: $url = &Apache::lonnet::declutter($url);
1.308 albertel 1897: $url =~ s-\.meta$--;
1898: my $id = &escape('meta:'.$url);
1899: $memcache->delete($id);
1900: }
1901:
1.225 foxr 1902: #
1.226 foxr 1903: # Fetch a user file from a remote server to the user's home directory
1904: # userfiles subdir.
1.225 foxr 1905: # Parameters:
1906: # $cmd - The command that got us here.
1907: # $tail - Tail of the command (remaining parameters).
1908: # $client - File descriptor connected to client.
1909: # Returns
1910: # 0 - Requested to exit, caller should shut down.
1911: # 1 - Continue processing.
1912: #
1913: sub fetch_user_file_handler {
1914:
1915: my ($cmd, $tail, $client) = @_;
1916:
1917: my $userinput = "$cmd:$tail";
1918: my $fname = $tail;
1.232 foxr 1919: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1.225 foxr 1920: my $udir=&propath($udom,$uname).'/userfiles';
1921: unless (-e $udir) {
1922: mkdir($udir,0770);
1923: }
1.232 foxr 1924: Debug("fetch user file for $fname");
1.225 foxr 1925: if (-e $udir) {
1926: $ufile=~s/^[\.\~]+//;
1.232 foxr 1927:
1928: # IF necessary, create the path right down to the file.
1929: # Note that any regular files in the way of this path are
1930: # wiped out to deal with some earlier folly of mine.
1931:
1.267 raeburn 1932: if (!&mkpath($udir.'/'.$ufile)) {
1.264 albertel 1933: &Failure($client, "unable_to_create\n", $userinput);
1.232 foxr 1934: }
1935:
1.225 foxr 1936: my $destname=$udir.'/'.$ufile;
1937: my $transname=$udir.'/'.$ufile.'.in.transit';
1938: my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
1939: my $response;
1.232 foxr 1940: Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
1.225 foxr 1941: alarm(120);
1942: {
1943: my $ua=new LWP::UserAgent;
1944: my $request=new HTTP::Request('GET',"$remoteurl");
1945: $response=$ua->request($request,$transname);
1946: }
1947: alarm(0);
1948: if ($response->is_error()) {
1949: unlink($transname);
1950: my $message=$response->status_line;
1951: &logthis("LWP GET: $message for $fname ($remoteurl)");
1952: &Failure($client, "failed\n", $userinput);
1953: } else {
1.232 foxr 1954: Debug("Renaming $transname to $destname");
1.225 foxr 1955: if (!rename($transname,$destname)) {
1956: &logthis("Unable to move $transname to $destname");
1957: unlink($transname);
1958: &Failure($client, "failed\n", $userinput);
1959: } else {
1960: &Reply($client, "ok\n", $userinput);
1961: }
1962: }
1963: } else {
1964: &Failure($client, "not_home\n", $userinput);
1965: }
1966: return 1;
1967: }
1968: ®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
1969:
1.226 foxr 1970: #
1971: # Remove a file from a user's home directory userfiles subdirectory.
1972: # Parameters:
1973: # cmd - the Lond request keyword that got us here.
1974: # tail - the part of the command past the keyword.
1975: # client- File descriptor connected with the client.
1976: #
1977: # Returns:
1978: # 1 - Continue processing.
1979: sub remove_user_file_handler {
1980: my ($cmd, $tail, $client) = @_;
1981:
1982: my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
1983:
1984: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1985: if ($ufile =~m|/\.\./|) {
1986: # any files paths with /../ in them refuse
1987: # to deal with
1988: &Failure($client, "refused\n", "$cmd:$tail");
1989: } else {
1990: my $udir = &propath($udom,$uname);
1991: if (-e $udir) {
1992: my $file=$udir.'/userfiles/'.$ufile;
1993: if (-e $file) {
1.253 foxr 1994: #
1995: # If the file is a regular file unlink is fine...
1996: # However it's possible the client wants a dir.
1997: # removed, in which case rmdir is more approprate:
1998: #
1.240 banghart 1999: if (-f $file){
1.241 albertel 2000: unlink($file);
2001: } elsif(-d $file) {
2002: rmdir($file);
1.240 banghart 2003: }
1.226 foxr 2004: if (-e $file) {
1.253 foxr 2005: # File is still there after we deleted it ?!?
2006:
1.226 foxr 2007: &Failure($client, "failed\n", "$cmd:$tail");
2008: } else {
2009: &Reply($client, "ok\n", "$cmd:$tail");
2010: }
2011: } else {
2012: &Failure($client, "not_found\n", "$cmd:$tail");
2013: }
2014: } else {
2015: &Failure($client, "not_home\n", "$cmd:$tail");
2016: }
2017: }
2018: return 1;
2019: }
2020: ®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
2021:
1.236 albertel 2022: #
2023: # make a directory in a user's home directory userfiles subdirectory.
2024: # Parameters:
2025: # cmd - the Lond request keyword that got us here.
2026: # tail - the part of the command past the keyword.
2027: # client- File descriptor connected with the client.
2028: #
2029: # Returns:
2030: # 1 - Continue processing.
2031: sub mkdir_user_file_handler {
2032: my ($cmd, $tail, $client) = @_;
2033:
2034: my ($dir) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
2035: $dir=&unescape($dir);
2036: my ($udom,$uname,$ufile) = ($dir =~ m|^([^/]+)/([^/]+)/(.+)$|);
2037: if ($ufile =~m|/\.\./|) {
2038: # any files paths with /../ in them refuse
2039: # to deal with
2040: &Failure($client, "refused\n", "$cmd:$tail");
2041: } else {
2042: my $udir = &propath($udom,$uname);
2043: if (-e $udir) {
1.264 albertel 2044: my $newdir=$udir.'/userfiles/'.$ufile.'/';
2045: if (!&mkpath($newdir)) {
2046: &Failure($client, "failed\n", "$cmd:$tail");
1.236 albertel 2047: }
1.264 albertel 2048: &Reply($client, "ok\n", "$cmd:$tail");
1.236 albertel 2049: } else {
2050: &Failure($client, "not_home\n", "$cmd:$tail");
2051: }
2052: }
2053: return 1;
2054: }
2055: ®ister_handler("mkdiruserfile", \&mkdir_user_file_handler, 0,1,0);
2056:
1.237 albertel 2057: #
2058: # rename a file in a user's home directory userfiles subdirectory.
2059: # Parameters:
2060: # cmd - the Lond request keyword that got us here.
2061: # tail - the part of the command past the keyword.
2062: # client- File descriptor connected with the client.
2063: #
2064: # Returns:
2065: # 1 - Continue processing.
2066: sub rename_user_file_handler {
2067: my ($cmd, $tail, $client) = @_;
2068:
2069: my ($udom,$uname,$old,$new) = split(/:/, $tail);
2070: $old=&unescape($old);
2071: $new=&unescape($new);
2072: if ($new =~m|/\.\./| || $old =~m|/\.\./|) {
2073: # any files paths with /../ in them refuse to deal with
2074: &Failure($client, "refused\n", "$cmd:$tail");
2075: } else {
2076: my $udir = &propath($udom,$uname);
2077: if (-e $udir) {
2078: my $oldfile=$udir.'/userfiles/'.$old;
2079: my $newfile=$udir.'/userfiles/'.$new;
2080: if (-e $newfile) {
2081: &Failure($client, "exists\n", "$cmd:$tail");
2082: } elsif (! -e $oldfile) {
2083: &Failure($client, "not_found\n", "$cmd:$tail");
2084: } else {
2085: if (!rename($oldfile,$newfile)) {
2086: &Failure($client, "failed\n", "$cmd:$tail");
2087: } else {
2088: &Reply($client, "ok\n", "$cmd:$tail");
2089: }
2090: }
2091: } else {
2092: &Failure($client, "not_home\n", "$cmd:$tail");
2093: }
2094: }
2095: return 1;
2096: }
2097: ®ister_handler("renameuserfile", \&rename_user_file_handler, 0,1,0);
2098:
1.227 foxr 2099: #
1.382 albertel 2100: # Checks if the specified user has an active session on the server
2101: # return ok if so, not_found if not
2102: #
2103: # Parameters:
2104: # cmd - The request keyword that dispatched to tus.
2105: # tail - The tail of the request (colon separated parameters).
2106: # client - Filehandle open on the client.
2107: # Return:
2108: # 1.
2109: sub user_has_session_handler {
2110: my ($cmd, $tail, $client) = @_;
2111:
2112: my ($udom, $uname) = map { &unescape($_) } (split(/:/, $tail));
2113:
2114: &logthis("Looking for $udom $uname");
2115: opendir(DIR,$perlvar{'lonIDsDir'});
2116: my $filename;
2117: while ($filename=readdir(DIR)) {
2118: last if ($filename=~/^\Q$uname\E_\d+_\Q$udom\E_/);
2119: }
2120: if ($filename) {
2121: &Reply($client, "ok\n", "$cmd:$tail");
2122: } else {
2123: &Failure($client, "not_found\n", "$cmd:$tail");
2124: }
2125: return 1;
2126:
2127: }
2128: ®ister_handler("userhassession", \&user_has_session_handler, 0,1,0);
2129:
2130: #
1.263 albertel 2131: # Authenticate access to a user file by checking that the token the user's
2132: # passed also exists in their session file
1.227 foxr 2133: #
2134: # Parameters:
2135: # cmd - The request keyword that dispatched to tus.
2136: # tail - The tail of the request (colon separated parameters).
2137: # client - Filehandle open on the client.
2138: # Return:
2139: # 1.
2140: sub token_auth_user_file_handler {
2141: my ($cmd, $tail, $client) = @_;
2142:
2143: my ($fname, $session) = split(/:/, $tail);
2144:
2145: chomp($session);
1.393 raeburn 2146: my $reply="non_auth";
1.343 albertel 2147: my $file = $perlvar{'lonIDsDir'}.'/'.$session.'.id';
2148: if (open(ENVIN,"$file")) {
1.332 albertel 2149: flock(ENVIN,LOCK_SH);
1.343 albertel 2150: tie(my %disk_env,'GDBM_File',"$file",&GDBM_READER(),0640);
2151: if (exists($disk_env{"userfile.$fname"})) {
1.393 raeburn 2152: $reply="ok";
1.343 albertel 2153: } else {
2154: foreach my $envname (keys(%disk_env)) {
2155: if ($envname=~ m|^userfile\.\Q$fname\E|) {
1.393 raeburn 2156: $reply="ok";
1.343 albertel 2157: last;
2158: }
2159: }
1.227 foxr 2160: }
1.343 albertel 2161: untie(%disk_env);
1.227 foxr 2162: close(ENVIN);
1.387 albertel 2163: &Reply($client, \$reply, "$cmd:$tail");
1.227 foxr 2164: } else {
2165: &Failure($client, "invalid_token\n", "$cmd:$tail");
2166: }
2167: return 1;
2168:
2169: }
2170: ®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
1.229 foxr 2171:
2172: #
2173: # Unsubscribe from a resource.
2174: #
2175: # Parameters:
2176: # $cmd - The command that got us here.
2177: # $tail - Tail of the command (remaining parameters).
2178: # $client - File descriptor connected to client.
2179: # Returns
2180: # 0 - Requested to exit, caller should shut down.
2181: # 1 - Continue processing.
2182: #
2183: sub unsubscribe_handler {
2184: my ($cmd, $tail, $client) = @_;
2185:
2186: my $userinput= "$cmd:$tail";
2187:
2188: my ($fname) = split(/:/,$tail); # Split in case there's extrs.
2189:
2190: &Debug("Unsubscribing $fname");
2191: if (-e $fname) {
2192: &Debug("Exists");
2193: &Reply($client, &unsub($fname,$clientip), $userinput);
2194: } else {
2195: &Failure($client, "not_found\n", $userinput);
2196: }
2197: return 1;
2198: }
2199: ®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
1.263 albertel 2200:
1.230 foxr 2201: # Subscribe to a resource
2202: #
2203: # Parameters:
2204: # $cmd - The command that got us here.
2205: # $tail - Tail of the command (remaining parameters).
2206: # $client - File descriptor connected to client.
2207: # Returns
2208: # 0 - Requested to exit, caller should shut down.
2209: # 1 - Continue processing.
2210: #
2211: sub subscribe_handler {
2212: my ($cmd, $tail, $client)= @_;
2213:
2214: my $userinput = "$cmd:$tail";
2215:
2216: &Reply( $client, &subscribe($userinput,$clientip), $userinput);
2217:
2218: return 1;
2219: }
2220: ®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
2221:
2222: #
1.379 albertel 2223: # Determine the latest version of a resource (it looks for the highest
2224: # past version and then returns that +1)
1.230 foxr 2225: #
2226: # Parameters:
2227: # $cmd - The command that got us here.
2228: # $tail - Tail of the command (remaining parameters).
1.379 albertel 2229: # (Should consist of an absolute path to a file)
1.230 foxr 2230: # $client - File descriptor connected to client.
2231: # Returns
2232: # 0 - Requested to exit, caller should shut down.
2233: # 1 - Continue processing.
2234: #
2235: sub current_version_handler {
2236: my ($cmd, $tail, $client) = @_;
2237:
2238: my $userinput= "$cmd:$tail";
2239:
2240: my $fname = $tail;
2241: &Reply( $client, ¤tversion($fname)."\n", $userinput);
2242: return 1;
2243:
2244: }
2245: ®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
2246:
2247: # Make an entry in a user's activity log.
2248: #
2249: # Parameters:
2250: # $cmd - The command that got us here.
2251: # $tail - Tail of the command (remaining parameters).
2252: # $client - File descriptor connected to client.
2253: # Returns
2254: # 0 - Requested to exit, caller should shut down.
2255: # 1 - Continue processing.
2256: #
2257: sub activity_log_handler {
2258: my ($cmd, $tail, $client) = @_;
2259:
2260:
2261: my $userinput= "$cmd:$tail";
2262:
2263: my ($udom,$uname,$what)=split(/:/,$tail);
2264: chomp($what);
2265: my $proname=&propath($udom,$uname);
2266: my $now=time;
2267: my $hfh;
2268: if ($hfh=IO::File->new(">>$proname/activity.log")) {
2269: print $hfh "$now:$clientname:$what\n";
2270: &Reply( $client, "ok\n", $userinput);
2271: } else {
2272: &Failure($client, "error: ".($!+0)." IO::File->new Failed "
2273: ."while attempting log\n",
2274: $userinput);
2275: }
2276:
2277: return 1;
2278: }
1.263 albertel 2279: ®ister_handler("log", \&activity_log_handler, 0, 1, 0);
1.230 foxr 2280:
2281: #
2282: # Put a namespace entry in a user profile hash.
2283: # My druthers would be for this to be an encrypted interaction too.
2284: # anything that might be an inadvertent covert channel about either
2285: # user authentication or user personal information....
2286: #
2287: # Parameters:
2288: # $cmd - The command that got us here.
2289: # $tail - Tail of the command (remaining parameters).
2290: # $client - File descriptor connected to client.
2291: # Returns
2292: # 0 - Requested to exit, caller should shut down.
2293: # 1 - Continue processing.
2294: #
2295: sub put_user_profile_entry {
2296: my ($cmd, $tail, $client) = @_;
1.229 foxr 2297:
1.230 foxr 2298: my $userinput = "$cmd:$tail";
2299:
1.242 raeburn 2300: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
1.230 foxr 2301: if ($namespace ne 'roles') {
2302: chomp($what);
2303: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2304: &GDBM_WRCREAT(),"P",$what);
2305: if($hashref) {
2306: my @pairs=split(/\&/,$what);
2307: foreach my $pair (@pairs) {
2308: my ($key,$value)=split(/=/,$pair);
2309: $hashref->{$key}=$value;
2310: }
1.311 albertel 2311: if (&untie_user_hash($hashref)) {
1.230 foxr 2312: &Reply( $client, "ok\n", $userinput);
2313: } else {
2314: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2315: "while attempting put\n",
2316: $userinput);
2317: }
2318: } else {
1.316 albertel 2319: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
1.230 foxr 2320: "while attempting put\n", $userinput);
2321: }
2322: } else {
2323: &Failure( $client, "refused\n", $userinput);
2324: }
2325:
2326: return 1;
2327: }
2328: ®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
2329:
1.283 albertel 2330: # Put a piece of new data in hash, returns error if entry already exists
2331: # Parameters:
2332: # $cmd - The command that got us here.
2333: # $tail - Tail of the command (remaining parameters).
2334: # $client - File descriptor connected to client.
2335: # Returns
2336: # 0 - Requested to exit, caller should shut down.
2337: # 1 - Continue processing.
2338: #
2339: sub newput_user_profile_entry {
2340: my ($cmd, $tail, $client) = @_;
2341:
2342: my $userinput = "$cmd:$tail";
2343:
2344: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
2345: if ($namespace eq 'roles') {
2346: &Failure( $client, "refused\n", $userinput);
2347: return 1;
2348: }
2349:
2350: chomp($what);
2351:
2352: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2353: &GDBM_WRCREAT(),"N",$what);
2354: if(!$hashref) {
1.316 albertel 2355: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
1.283 albertel 2356: "while attempting put\n", $userinput);
2357: return 1;
2358: }
2359:
2360: my @pairs=split(/\&/,$what);
2361: foreach my $pair (@pairs) {
2362: my ($key,$value)=split(/=/,$pair);
2363: if (exists($hashref->{$key})) {
2364: &Failure($client, "key_exists: ".$key."\n",$userinput);
2365: return 1;
2366: }
2367: }
2368:
2369: foreach my $pair (@pairs) {
2370: my ($key,$value)=split(/=/,$pair);
2371: $hashref->{$key}=$value;
2372: }
2373:
1.311 albertel 2374: if (&untie_user_hash($hashref)) {
1.283 albertel 2375: &Reply( $client, "ok\n", $userinput);
2376: } else {
2377: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2378: "while attempting put\n",
2379: $userinput);
2380: }
2381: return 1;
2382: }
2383: ®ister_handler("newput", \&newput_user_profile_entry, 0, 1, 0);
2384:
1.230 foxr 2385: #
2386: # Increment a profile entry in the user history file.
2387: # The history contains keyword value pairs. In this case,
2388: # The value itself is a pair of numbers. The first, the current value
2389: # the second an increment that this function applies to the current
2390: # value.
2391: #
2392: # Parameters:
2393: # $cmd - The command that got us here.
2394: # $tail - Tail of the command (remaining parameters).
2395: # $client - File descriptor connected to client.
2396: # Returns
2397: # 0 - Requested to exit, caller should shut down.
2398: # 1 - Continue processing.
2399: #
2400: sub increment_user_value_handler {
2401: my ($cmd, $tail, $client) = @_;
2402:
2403: my $userinput = "$cmd:$tail";
2404:
2405: my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
2406: if ($namespace ne 'roles') {
2407: chomp($what);
2408: my $hashref = &tie_user_hash($udom, $uname,
2409: $namespace, &GDBM_WRCREAT(),
2410: "P",$what);
2411: if ($hashref) {
2412: my @pairs=split(/\&/,$what);
2413: foreach my $pair (@pairs) {
2414: my ($key,$value)=split(/=/,$pair);
1.284 raeburn 2415: $value = &unescape($value);
1.230 foxr 2416: # We could check that we have a number...
2417: if (! defined($value) || $value eq '') {
2418: $value = 1;
2419: }
2420: $hashref->{$key}+=$value;
1.284 raeburn 2421: if ($namespace eq 'nohist_resourcetracker') {
2422: if ($hashref->{$key} < 0) {
2423: $hashref->{$key} = 0;
2424: }
2425: }
1.230 foxr 2426: }
1.311 albertel 2427: if (&untie_user_hash($hashref)) {
1.230 foxr 2428: &Reply( $client, "ok\n", $userinput);
2429: } else {
2430: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2431: "while attempting inc\n", $userinput);
2432: }
2433: } else {
2434: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2435: "while attempting inc\n", $userinput);
2436: }
2437: } else {
2438: &Failure($client, "refused\n", $userinput);
2439: }
2440:
2441: return 1;
2442: }
2443: ®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
2444:
2445: #
2446: # Put a new role for a user. Roles are LonCAPA's packaging of permissions.
2447: # Each 'role' a user has implies a set of permissions. Adding a new role
2448: # for a person grants the permissions packaged with that role
2449: # to that user when the role is selected.
2450: #
2451: # Parameters:
2452: # $cmd - The command string (rolesput).
2453: # $tail - The remainder of the request line. For rolesput this
2454: # consists of a colon separated list that contains:
2455: # The domain and user that is granting the role (logged).
2456: # The domain and user that is getting the role.
2457: # The roles being granted as a set of & separated pairs.
2458: # each pair a key value pair.
2459: # $client - File descriptor connected to the client.
2460: # Returns:
2461: # 0 - If the daemon should exit
2462: # 1 - To continue processing.
2463: #
2464: #
2465: sub roles_put_handler {
2466: my ($cmd, $tail, $client) = @_;
2467:
2468: my $userinput = "$cmd:$tail";
2469:
2470: my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
2471:
2472:
2473: my $namespace='roles';
2474: chomp($what);
2475: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2476: &GDBM_WRCREAT(), "P",
2477: "$exedom:$exeuser:$what");
2478: #
2479: # Log the attempt to set a role. The {}'s here ensure that the file
2480: # handle is open for the minimal amount of time. Since the flush
2481: # is done on close this improves the chances the log will be an un-
2482: # corrupted ordered thing.
2483: if ($hashref) {
1.261 foxr 2484: my $pass_entry = &get_auth_type($udom, $uname);
2485: my ($auth_type,$pwd) = split(/:/, $pass_entry);
2486: $auth_type = $auth_type.":";
1.230 foxr 2487: my @pairs=split(/\&/,$what);
2488: foreach my $pair (@pairs) {
2489: my ($key,$value)=split(/=/,$pair);
2490: &manage_permissions($key, $udom, $uname,
1.260 foxr 2491: $auth_type);
1.230 foxr 2492: $hashref->{$key}=$value;
2493: }
1.311 albertel 2494: if (&untie_user_hash($hashref)) {
1.230 foxr 2495: &Reply($client, "ok\n", $userinput);
2496: } else {
2497: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2498: "while attempting rolesput\n", $userinput);
2499: }
2500: } else {
2501: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2502: "while attempting rolesput\n", $userinput);
2503: }
2504: return 1;
2505: }
2506: ®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
2507:
2508: #
1.231 foxr 2509: # Deletes (removes) a role for a user. This is equivalent to removing
2510: # a permissions package associated with the role from the user's profile.
2511: #
2512: # Parameters:
2513: # $cmd - The command (rolesdel)
2514: # $tail - The remainder of the request line. This consists
2515: # of:
2516: # The domain and user requesting the change (logged)
2517: # The domain and user being changed.
2518: # The roles being revoked. These are shipped to us
2519: # as a bunch of & separated role name keywords.
2520: # $client - The file handle open on the client.
2521: # Returns:
2522: # 1 - Continue processing
2523: # 0 - Exit.
2524: #
2525: sub roles_delete_handler {
2526: my ($cmd, $tail, $client) = @_;
2527:
2528: my $userinput = "$cmd:$tail";
2529:
2530: my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
2531: &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
2532: "what = ".$what);
2533: my $namespace='roles';
2534: chomp($what);
2535: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2536: &GDBM_WRCREAT(), "D",
2537: "$exedom:$exeuser:$what");
2538:
2539: if ($hashref) {
2540: my @rolekeys=split(/\&/,$what);
2541:
2542: foreach my $key (@rolekeys) {
2543: delete $hashref->{$key};
2544: }
1.315 albertel 2545: if (&untie_user_hash($hashref)) {
1.231 foxr 2546: &Reply($client, "ok\n", $userinput);
2547: } else {
2548: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2549: "while attempting rolesdel\n", $userinput);
2550: }
2551: } else {
2552: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2553: "while attempting rolesdel\n", $userinput);
2554: }
2555:
2556: return 1;
2557: }
2558: ®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
2559:
2560: # Unencrypted get from a user's profile database. See
2561: # GetProfileEntryEncrypted for a version that does end-to-end encryption.
2562: # This function retrieves a keyed item from a specific named database in the
2563: # user's directory.
2564: #
2565: # Parameters:
2566: # $cmd - Command request keyword (get).
2567: # $tail - Tail of the command. This is a colon separated list
2568: # consisting of the domain and username that uniquely
2569: # identifies the profile,
2570: # The 'namespace' which selects the gdbm file to
2571: # do the lookup in,
2572: # & separated list of keys to lookup. Note that
2573: # the values are returned as an & separated list too.
2574: # $client - File descriptor open on the client.
2575: # Returns:
2576: # 1 - Continue processing.
2577: # 0 - Exit.
2578: #
2579: sub get_profile_entry {
2580: my ($cmd, $tail, $client) = @_;
2581:
2582: my $userinput= "$cmd:$tail";
2583:
2584: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2585: chomp($what);
1.255 foxr 2586:
1.390 raeburn 2587:
1.255 foxr 2588: my $replystring = read_profile($udom, $uname, $namespace, $what);
2589: my ($first) = split(/:/,$replystring);
2590: if($first ne "error") {
1.387 albertel 2591: &Reply($client, \$replystring, $userinput);
1.231 foxr 2592: } else {
1.255 foxr 2593: &Failure($client, $replystring." while attempting get\n", $userinput);
1.231 foxr 2594: }
2595: return 1;
1.255 foxr 2596:
2597:
1.231 foxr 2598: }
2599: ®ister_handler("get", \&get_profile_entry, 0,1,0);
2600:
2601: #
2602: # Process the encrypted get request. Note that the request is sent
2603: # in clear, but the reply is encrypted. This is a small covert channel:
2604: # information about the sensitive keys is given to the snooper. Just not
2605: # information about the values of the sensitive key. Hmm if I wanted to
2606: # know these I'd snoop for the egets. Get the profile item names from them
2607: # and then issue a get for them since there's no enforcement of the
2608: # requirement of an encrypted get for particular profile items. If I
2609: # were re-doing this, I'd force the request to be encrypted as well as the
2610: # reply. I'd also just enforce encrypted transactions for all gets since
2611: # that would prevent any covert channel snooping.
2612: #
2613: # Parameters:
2614: # $cmd - Command keyword of request (eget).
2615: # $tail - Tail of the command. See GetProfileEntry
# for more information about this.
2616: # $client - File open on the client.
2617: # Returns:
2618: # 1 - Continue processing
2619: # 0 - server should exit.
2620: sub get_profile_entry_encrypted {
2621: my ($cmd, $tail, $client) = @_;
2622:
2623: my $userinput = "$cmd:$tail";
2624:
1.339 albertel 2625: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
1.231 foxr 2626: chomp($what);
1.255 foxr 2627: my $qresult = read_profile($udom, $uname, $namespace, $what);
2628: my ($first) = split(/:/, $qresult);
2629: if($first ne "error") {
2630:
2631: if ($cipher) {
2632: my $cmdlength=length($qresult);
2633: $qresult.=" ";
2634: my $encqresult='';
2635: for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
2636: $encqresult.= unpack("H16",
2637: $cipher->encrypt(substr($qresult,
2638: $encidx,
2639: 8)));
2640: }
2641: &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
2642: } else {
1.231 foxr 2643: &Failure( $client, "error:no_key\n", $userinput);
2644: }
2645: } else {
1.255 foxr 2646: &Failure($client, "$qresult while attempting eget\n", $userinput);
2647:
1.231 foxr 2648: }
2649:
2650: return 1;
2651: }
1.255 foxr 2652: ®ister_handler("eget", \&get_profile_entry_encrypted, 0, 1, 0);
1.263 albertel 2653:
1.231 foxr 2654: #
2655: # Deletes a key in a user profile database.
2656: #
2657: # Parameters:
2658: # $cmd - Command keyword (del).
2659: # $tail - Command tail. IN this case a colon
2660: # separated list containing:
2661: # The domain and user that identifies uniquely
2662: # the identity of the user.
2663: # The profile namespace (name of the profile
2664: # database file).
2665: # & separated list of keywords to delete.
2666: # $client - File open on client socket.
2667: # Returns:
2668: # 1 - Continue processing
2669: # 0 - Exit server.
2670: #
2671: #
2672: sub delete_profile_entry {
2673: my ($cmd, $tail, $client) = @_;
2674:
2675: my $userinput = "cmd:$tail";
2676:
2677: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2678: chomp($what);
2679: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2680: &GDBM_WRCREAT(),
2681: "D",$what);
2682: if ($hashref) {
2683: my @keys=split(/\&/,$what);
2684: foreach my $key (@keys) {
2685: delete($hashref->{$key});
2686: }
1.315 albertel 2687: if (&untie_user_hash($hashref)) {
1.231 foxr 2688: &Reply($client, "ok\n", $userinput);
2689: } else {
2690: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2691: "while attempting del\n", $userinput);
2692: }
2693: } else {
2694: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2695: "while attempting del\n", $userinput);
2696: }
2697: return 1;
2698: }
2699: ®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
1.263 albertel 2700:
1.231 foxr 2701: #
2702: # List the set of keys that are defined in a profile database file.
2703: # A successful reply from this will contain an & separated list of
2704: # the keys.
2705: # Parameters:
2706: # $cmd - Command request (keys).
2707: # $tail - Remainder of the request, a colon separated
2708: # list containing domain/user that identifies the
2709: # user being queried, and the database namespace
2710: # (database filename essentially).
2711: # $client - File open on the client.
2712: # Returns:
2713: # 1 - Continue processing.
2714: # 0 - Exit the server.
2715: #
2716: sub get_profile_keys {
2717: my ($cmd, $tail, $client) = @_;
2718:
2719: my $userinput = "$cmd:$tail";
2720:
2721: my ($udom,$uname,$namespace)=split(/:/,$tail);
2722: my $qresult='';
2723: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2724: &GDBM_READER());
2725: if ($hashref) {
2726: foreach my $key (keys %$hashref) {
2727: $qresult.="$key&";
2728: }
1.315 albertel 2729: if (&untie_user_hash($hashref)) {
1.231 foxr 2730: $qresult=~s/\&$//;
1.387 albertel 2731: &Reply($client, \$qresult, $userinput);
1.231 foxr 2732: } else {
2733: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2734: "while attempting keys\n", $userinput);
2735: }
2736: } else {
2737: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2738: "while attempting keys\n", $userinput);
2739: }
2740:
2741: return 1;
2742: }
2743: ®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
2744:
2745: #
2746: # Dump the contents of a user profile database.
2747: # Note that this constitutes a very large covert channel too since
2748: # the dump will return sensitive information that is not encrypted.
2749: # The naive security assumption is that the session negotiation ensures
2750: # our client is trusted and I don't believe that's assured at present.
2751: # Sure want badly to go to ssl or tls. Of course if my peer isn't really
2752: # a LonCAPA node they could have negotiated an encryption key too so >sigh<.
2753: #
2754: # Parameters:
2755: # $cmd - The command request keyword (currentdump).
2756: # $tail - Remainder of the request, consisting of a colon
2757: # separated list that has the domain/username and
2758: # the namespace to dump (database file).
2759: # $client - file open on the remote client.
2760: # Returns:
2761: # 1 - Continue processing.
2762: # 0 - Exit the server.
2763: #
2764: sub dump_profile_database {
2765: my ($cmd, $tail, $client) = @_;
2766:
2767: my $userinput = "$cmd:$tail";
2768:
2769: my ($udom,$uname,$namespace) = split(/:/,$tail);
2770: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2771: &GDBM_READER());
2772: if ($hashref) {
2773: # Structure of %data:
2774: # $data{$symb}->{$parameter}=$value;
2775: # $data{$symb}->{'v.'.$parameter}=$version;
2776: # since $parameter will be unescaped, we do not
2777: # have to worry about silly parameter names...
2778:
2779: my $qresult='';
2780: my %data = (); # A hash of anonymous hashes..
2781: while (my ($key,$value) = each(%$hashref)) {
2782: my ($v,$symb,$param) = split(/:/,$key);
2783: next if ($v eq 'version' || $symb eq 'keys');
2784: next if (exists($data{$symb}) &&
2785: exists($data{$symb}->{$param}) &&
2786: $data{$symb}->{'v.'.$param} > $v);
2787: $data{$symb}->{$param}=$value;
2788: $data{$symb}->{'v.'.$param}=$v;
2789: }
1.311 albertel 2790: if (&untie_user_hash($hashref)) {
1.231 foxr 2791: while (my ($symb,$param_hash) = each(%data)) {
2792: while(my ($param,$value) = each (%$param_hash)){
2793: next if ($param =~ /^v\./); # Ignore versions...
2794: #
2795: # Just dump the symb=value pairs separated by &
2796: #
2797: $qresult.=$symb.':'.$param.'='.$value.'&';
2798: }
2799: }
2800: chop($qresult);
1.387 albertel 2801: &Reply($client , \$qresult, $userinput);
1.231 foxr 2802: } else {
2803: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2804: "while attempting currentdump\n", $userinput);
2805: }
2806: } else {
2807: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2808: "while attempting currentdump\n", $userinput);
2809: }
2810:
2811: return 1;
2812: }
2813: ®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
2814:
2815: #
2816: # Dump a profile database with an optional regular expression
2817: # to match against the keys. In this dump, no effort is made
2818: # to separate symb from version information. Presumably the
2819: # databases that are dumped by this command are of a different
2820: # structure. Need to look at this and improve the documentation of
2821: # both this and the currentdump handler.
2822: # Parameters:
2823: # $cmd - The command keyword.
2824: # $tail - All of the characters after the $cmd:
2825: # These are expected to be a colon
2826: # separated list containing:
2827: # domain/user - identifying the user.
2828: # namespace - identifying the database.
2829: # regexp - optional regular expression
2830: # that is matched against
2831: # database keywords to do
2832: # selective dumps.
2833: # $client - Channel open on the client.
2834: # Returns:
2835: # 1 - Continue processing.
2836: # Side effects:
2837: # response is written to $client.
2838: #
2839: sub dump_with_regexp {
2840: my ($cmd, $tail, $client) = @_;
2841:
2842:
2843: my $userinput = "$cmd:$tail";
2844:
1.306 albertel 2845: my ($udom,$uname,$namespace,$regexp,$range)=split(/:/,$tail);
1.231 foxr 2846: if (defined($regexp)) {
2847: $regexp=&unescape($regexp);
2848: } else {
2849: $regexp='.';
2850: }
1.306 albertel 2851: my ($start,$end);
2852: if (defined($range)) {
2853: if ($range =~/^(\d+)\-(\d+)$/) {
2854: ($start,$end) = ($1,$2);
2855: } elsif ($range =~/^(\d+)$/) {
2856: ($start,$end) = (0,$1);
2857: } else {
2858: undef($range);
2859: }
2860: }
1.231 foxr 2861: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2862: &GDBM_READER());
2863: if ($hashref) {
2864: my $qresult='';
1.306 albertel 2865: my $count=0;
1.231 foxr 2866: while (my ($key,$value) = each(%$hashref)) {
2867: if ($regexp eq '.') {
1.306 albertel 2868: $count++;
2869: if (defined($range) && $count >= $end) { last; }
2870: if (defined($range) && $count < $start) { next; }
1.231 foxr 2871: $qresult.=$key.'='.$value.'&';
2872: } else {
2873: my $unescapeKey = &unescape($key);
2874: if (eval('$unescapeKey=~/$regexp/')) {
1.306 albertel 2875: $count++;
2876: if (defined($range) && $count >= $end) { last; }
2877: if (defined($range) && $count < $start) { next; }
1.231 foxr 2878: $qresult.="$key=$value&";
2879: }
2880: }
2881: }
1.311 albertel 2882: if (&untie_user_hash($hashref)) {
1.231 foxr 2883: chop($qresult);
1.387 albertel 2884: &Reply($client, \$qresult, $userinput);
1.231 foxr 2885: } else {
2886: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2887: "while attempting dump\n", $userinput);
2888: }
2889: } else {
2890: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2891: "while attempting dump\n", $userinput);
2892: }
2893:
2894: return 1;
2895: }
2896: ®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
2897:
2898: # Store a set of key=value pairs associated with a versioned name.
2899: #
2900: # Parameters:
2901: # $cmd - Request command keyword.
2902: # $tail - Tail of the request. This is a colon
2903: # separated list containing:
2904: # domain/user - User and authentication domain.
2905: # namespace - Name of the database being modified
2906: # rid - Resource keyword to modify.
2907: # what - new value associated with rid.
2908: #
2909: # $client - Socket open on the client.
2910: #
2911: #
2912: # Returns:
2913: # 1 (keep on processing).
2914: # Side-Effects:
2915: # Writes to the client
2916: sub store_handler {
2917: my ($cmd, $tail, $client) = @_;
2918:
2919: my $userinput = "$cmd:$tail";
2920:
2921: my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
2922: if ($namespace ne 'roles') {
2923:
2924: chomp($what);
2925: my @pairs=split(/\&/,$what);
2926: my $hashref = &tie_user_hash($udom, $uname, $namespace,
1.268 albertel 2927: &GDBM_WRCREAT(), "S",
1.231 foxr 2928: "$rid:$what");
2929: if ($hashref) {
2930: my $now = time;
2931: my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
2932: my $key;
2933: $hashref->{"version:$rid"}++;
2934: my $version=$hashref->{"version:$rid"};
2935: my $allkeys='';
2936: foreach my $pair (@pairs) {
2937: my ($key,$value)=split(/=/,$pair);
2938: $allkeys.=$key.':';
2939: $hashref->{"$version:$rid:$key"}=$value;
2940: }
2941: $hashref->{"$version:$rid:timestamp"}=$now;
2942: $allkeys.='timestamp';
2943: $hashref->{"$version:keys:$rid"}=$allkeys;
1.311 albertel 2944: if (&untie_user_hash($hashref)) {
1.231 foxr 2945: &Reply($client, "ok\n", $userinput);
2946: } else {
2947: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2948: "while attempting store\n", $userinput);
2949: }
2950: } else {
2951: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2952: "while attempting store\n", $userinput);
2953: }
2954: } else {
2955: &Failure($client, "refused\n", $userinput);
2956: }
2957:
2958: return 1;
2959: }
2960: ®ister_handler("store", \&store_handler, 0, 1, 0);
1.263 albertel 2961:
1.323 albertel 2962: # Modify a set of key=value pairs associated with a versioned name.
2963: #
2964: # Parameters:
2965: # $cmd - Request command keyword.
2966: # $tail - Tail of the request. This is a colon
2967: # separated list containing:
2968: # domain/user - User and authentication domain.
2969: # namespace - Name of the database being modified
2970: # rid - Resource keyword to modify.
2971: # v - Version item to modify
2972: # what - new value associated with rid.
2973: #
2974: # $client - Socket open on the client.
2975: #
2976: #
2977: # Returns:
2978: # 1 (keep on processing).
2979: # Side-Effects:
2980: # Writes to the client
2981: sub putstore_handler {
2982: my ($cmd, $tail, $client) = @_;
2983:
2984: my $userinput = "$cmd:$tail";
2985:
2986: my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
2987: if ($namespace ne 'roles') {
2988:
2989: chomp($what);
2990: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2991: &GDBM_WRCREAT(), "M",
2992: "$rid:$v:$what");
2993: if ($hashref) {
2994: my $now = time;
2995: my %data = &hash_extract($what);
2996: my @allkeys;
2997: while (my($key,$value) = each(%data)) {
2998: push(@allkeys,$key);
2999: $hashref->{"$v:$rid:$key"} = $value;
3000: }
3001: my $allkeys = join(':',@allkeys);
3002: $hashref->{"$v:keys:$rid"}=$allkeys;
3003:
3004: if (&untie_user_hash($hashref)) {
3005: &Reply($client, "ok\n", $userinput);
3006: } else {
3007: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3008: "while attempting store\n", $userinput);
3009: }
3010: } else {
3011: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3012: "while attempting store\n", $userinput);
3013: }
3014: } else {
3015: &Failure($client, "refused\n", $userinput);
3016: }
3017:
3018: return 1;
3019: }
3020: ®ister_handler("putstore", \&putstore_handler, 0, 1, 0);
3021:
3022: sub hash_extract {
3023: my ($str)=@_;
3024: my %hash;
3025: foreach my $pair (split(/\&/,$str)) {
3026: my ($key,$value)=split(/=/,$pair);
3027: $hash{$key}=$value;
3028: }
3029: return (%hash);
3030: }
3031: sub hash_to_str {
3032: my ($hash_ref)=@_;
3033: my $str;
3034: foreach my $key (keys(%$hash_ref)) {
3035: $str.=$key.'='.$hash_ref->{$key}.'&';
3036: }
3037: $str=~s/\&$//;
3038: return $str;
3039: }
3040:
1.231 foxr 3041: #
3042: # Dump out all versions of a resource that has key=value pairs associated
3043: # with it for each version. These resources are built up via the store
3044: # command.
3045: #
3046: # Parameters:
3047: # $cmd - Command keyword.
3048: # $tail - Remainder of the request which consists of:
3049: # domain/user - User and auth. domain.
3050: # namespace - name of resource database.
3051: # rid - Resource id.
3052: # $client - socket open on the client.
3053: #
3054: # Returns:
3055: # 1 indicating the caller should not yet exit.
3056: # Side-effects:
3057: # Writes a reply to the client.
3058: # The reply is a string of the following shape:
3059: # version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
3060: # Where the 1 above represents version 1.
3061: # this continues for all pairs of keys in all versions.
3062: #
3063: #
3064: #
3065: #
3066: sub restore_handler {
3067: my ($cmd, $tail, $client) = @_;
3068:
3069: my $userinput = "$cmd:$tail"; # Only used for logging purposes.
1.351 banghart 3070: my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
1.352 albertel 3071: $namespace=~s/\//\_/g;
1.350 albertel 3072: $namespace = &LONCAPA::clean_username($namespace);
1.349 albertel 3073:
1.231 foxr 3074: chomp($rid);
3075: my $qresult='';
1.309 albertel 3076: my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
3077: if ($hashref) {
3078: my $version=$hashref->{"version:$rid"};
1.231 foxr 3079: $qresult.="version=$version&";
3080: my $scope;
3081: for ($scope=1;$scope<=$version;$scope++) {
1.309 albertel 3082: my $vkeys=$hashref->{"$scope:keys:$rid"};
1.231 foxr 3083: my @keys=split(/:/,$vkeys);
3084: my $key;
3085: $qresult.="$scope:keys=$vkeys&";
3086: foreach $key (@keys) {
1.309 albertel 3087: $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
1.231 foxr 3088: }
3089: }
1.311 albertel 3090: if (&untie_user_hash($hashref)) {
1.231 foxr 3091: $qresult=~s/\&$//;
1.387 albertel 3092: &Reply( $client, \$qresult, $userinput);
1.231 foxr 3093: } else {
3094: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3095: "while attempting restore\n", $userinput);
3096: }
3097: } else {
3098: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3099: "while attempting restore\n", $userinput);
3100: }
3101:
3102: return 1;
3103:
3104:
3105: }
3106: ®ister_handler("restore", \&restore_handler, 0,1,0);
1.234 foxr 3107:
3108: #
1.324 raeburn 3109: # Add a chat message to a synchronous discussion board.
1.234 foxr 3110: #
3111: # Parameters:
3112: # $cmd - Request keyword.
3113: # $tail - Tail of the command. A colon separated list
3114: # containing:
3115: # cdom - Domain on which the chat board lives
1.324 raeburn 3116: # cnum - Course containing the chat board.
3117: # newpost - Body of the posting.
3118: # group - Optional group, if chat board is only
3119: # accessible in a group within the course
1.234 foxr 3120: # $client - Socket open on the client.
3121: # Returns:
3122: # 1 - Indicating caller should keep on processing.
3123: #
3124: # Side-effects:
3125: # writes a reply to the client.
3126: #
3127: #
3128: sub send_chat_handler {
3129: my ($cmd, $tail, $client) = @_;
3130:
3131:
3132: my $userinput = "$cmd:$tail";
3133:
1.324 raeburn 3134: my ($cdom,$cnum,$newpost,$group)=split(/\:/,$tail);
3135: &chat_add($cdom,$cnum,$newpost,$group);
1.234 foxr 3136: &Reply($client, "ok\n", $userinput);
3137:
3138: return 1;
3139: }
3140: ®ister_handler("chatsend", \&send_chat_handler, 0, 1, 0);
1.263 albertel 3141:
1.234 foxr 3142: #
1.324 raeburn 3143: # Retrieve the set of chat messages from a discussion board.
1.234 foxr 3144: #
3145: # Parameters:
3146: # $cmd - Command keyword that initiated the request.
3147: # $tail - Remainder of the request after the command
3148: # keyword. In this case a colon separated list of
3149: # chat domain - Which discussion board.
3150: # chat id - Discussion thread(?)
3151: # domain/user - Authentication domain and username
3152: # of the requesting person.
1.324 raeburn 3153: # group - Optional course group containing
3154: # the board.
1.234 foxr 3155: # $client - Socket open on the client program.
3156: # Returns:
3157: # 1 - continue processing
3158: # Side effects:
3159: # Response is written to the client.
3160: #
3161: sub retrieve_chat_handler {
3162: my ($cmd, $tail, $client) = @_;
3163:
3164:
3165: my $userinput = "$cmd:$tail";
3166:
1.324 raeburn 3167: my ($cdom,$cnum,$udom,$uname,$group)=split(/\:/,$tail);
1.234 foxr 3168: my $reply='';
1.324 raeburn 3169: foreach (&get_chat($cdom,$cnum,$udom,$uname,$group)) {
1.234 foxr 3170: $reply.=&escape($_).':';
3171: }
3172: $reply=~s/\:$//;
1.387 albertel 3173: &Reply($client, \$reply, $userinput);
1.234 foxr 3174:
3175:
3176: return 1;
3177: }
3178: ®ister_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
3179:
3180: #
3181: # Initiate a query of an sql database. SQL query repsonses get put in
3182: # a file for later retrieval. This prevents sql query results from
3183: # bottlenecking the system. Note that with loncnew, perhaps this is
3184: # less of an issue since multiple outstanding requests can be concurrently
3185: # serviced.
3186: #
3187: # Parameters:
3188: # $cmd - COmmand keyword that initiated the request.
3189: # $tail - Remainder of the command after the keyword.
3190: # For this function, this consists of a query and
3191: # 3 arguments that are self-documentingly labelled
3192: # in the original arg1, arg2, arg3.
3193: # $client - Socket open on the client.
3194: # Return:
3195: # 1 - Indicating processing should continue.
3196: # Side-effects:
3197: # a reply is written to $client.
3198: #
3199: sub send_query_handler {
3200: my ($cmd, $tail, $client) = @_;
3201:
3202:
3203: my $userinput = "$cmd:$tail";
3204:
3205: my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
3206: $query=~s/\n*$//g;
3207: &Reply($client, "". &sql_reply("$clientname\&$query".
3208: "\&$arg1"."\&$arg2"."\&$arg3")."\n",
3209: $userinput);
3210:
3211: return 1;
3212: }
3213: ®ister_handler("querysend", \&send_query_handler, 0, 1, 0);
3214:
3215: #
3216: # Add a reply to an sql query. SQL queries are done asyncrhonously.
3217: # The query is submitted via a "querysend" transaction.
3218: # There it is passed on to the lonsql daemon, queued and issued to
3219: # mysql.
3220: # This transaction is invoked when the sql transaction is complete
3221: # it stores the query results in flie and indicates query completion.
3222: # presumably local software then fetches this response... I'm guessing
3223: # the sequence is: lonc does a querysend, we ask lonsql to do it.
3224: # lonsql on completion of the query interacts with the lond of our
3225: # client to do a query reply storing two files:
3226: # - id - The results of the query.
3227: # - id.end - Indicating the transaction completed.
3228: # NOTE: id is a unique id assigned to the query and querysend time.
3229: # Parameters:
3230: # $cmd - Command keyword that initiated this request.
3231: # $tail - Remainder of the tail. In this case that's a colon
3232: # separated list containing the query Id and the
3233: # results of the query.
3234: # $client - Socket open on the client.
3235: # Return:
3236: # 1 - Indicating that we should continue processing.
3237: # Side effects:
3238: # ok written to the client.
3239: #
3240: sub reply_query_handler {
3241: my ($cmd, $tail, $client) = @_;
3242:
3243:
3244: my $userinput = "$cmd:$tail";
3245:
1.339 albertel 3246: my ($id,$reply)=split(/:/,$tail);
1.234 foxr 3247: my $store;
3248: my $execdir=$perlvar{'lonDaemons'};
3249: if ($store=IO::File->new(">$execdir/tmp/$id")) {
3250: $reply=~s/\&/\n/g;
3251: print $store $reply;
3252: close $store;
3253: my $store2=IO::File->new(">$execdir/tmp/$id.end");
3254: print $store2 "done\n";
3255: close $store2;
3256: &Reply($client, "ok\n", $userinput);
3257: } else {
3258: &Failure($client, "error: ".($!+0)
3259: ." IO::File->new Failed ".
3260: "while attempting queryreply\n", $userinput);
3261: }
3262:
3263:
3264: return 1;
3265: }
3266: ®ister_handler("queryreply", \&reply_query_handler, 0, 1, 0);
3267:
3268: #
3269: # Process the courseidput request. Not quite sure what this means
3270: # at the system level sense. It appears a gdbm file in the
3271: # /home/httpd/lonUsers/$domain/nohist_courseids is tied and
3272: # a set of entries made in that database.
3273: #
3274: # Parameters:
3275: # $cmd - The command keyword that initiated this request.
3276: # $tail - Tail of the command. In this case consists of a colon
3277: # separated list contaning the domain to apply this to and
3278: # an ampersand separated list of keyword=value pairs.
1.272 raeburn 3279: # Each value is a colon separated list that includes:
3280: # description, institutional code and course owner.
3281: # For backward compatibility with versions included
3282: # in LON-CAPA 1.1.X (and earlier) and 1.2.X, institutional
3283: # code and/or course owner are preserved from the existing
3284: # record when writing a new record in response to 1.1 or
3285: # 1.2 implementations of lonnet::flushcourselogs().
3286: #
1.234 foxr 3287: # $client - Socket open on the client.
3288: # Returns:
3289: # 1 - indicating that processing should continue
3290: #
3291: # Side effects:
3292: # reply is written to the client.
3293: #
3294: sub put_course_id_handler {
3295: my ($cmd, $tail, $client) = @_;
3296:
3297:
3298: my $userinput = "$cmd:$tail";
3299:
1.266 raeburn 3300: my ($udom, $what) = split(/:/, $tail,2);
1.234 foxr 3301: chomp($what);
3302: my $now=time;
3303: my @pairs=split(/\&/,$what);
3304:
3305: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3306: if ($hashref) {
3307: foreach my $pair (@pairs) {
1.271 raeburn 3308: my ($key,$courseinfo) = split(/=/,$pair,2);
3309: $courseinfo =~ s/=/:/g;
1.384 raeburn 3310: if (defined($hashref->{$key})) {
3311: my $value = &Apache::lonnet::thaw_unescape($hashref->{$key});
3312: if (ref($value) eq 'HASH') {
3313: my @items = ('description','inst_code','owner','type');
3314: my @new_items = split(/:/,$courseinfo,-1);
3315: my %storehash;
3316: for (my $i=0; $i<@new_items; $i++) {
1.391 raeburn 3317: $storehash{$items[$i]} = &unescape($new_items[$i]);
1.384 raeburn 3318: }
3319: $hashref->{$key} =
3320: &Apache::lonnet::freeze_escape(\%storehash);
3321: my $unesc_key = &unescape($key);
3322: $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
3323: next;
1.383 raeburn 3324: }
1.384 raeburn 3325: }
3326: my @current_items = split(/:/,$hashref->{$key},-1);
3327: shift(@current_items); # remove description
3328: pop(@current_items); # remove last access
3329: my $numcurrent = scalar(@current_items);
3330: if ($numcurrent > 3) {
3331: $numcurrent = 3;
3332: }
3333: my @new_items = split(/:/,$courseinfo,-1);
3334: my $numnew = scalar(@new_items);
3335: if ($numcurrent > 0) {
3336: if ($numnew <= $numcurrent) { # flushcourselogs() from pre 2.2
3337: for (my $j=$numcurrent-$numnew; $j>=0; $j--) {
3338: $courseinfo .= ':'.$current_items[$numcurrent-$j-1];
1.333 raeburn 3339: }
1.272 raeburn 3340: }
3341: }
1.384 raeburn 3342: $hashref->{$key}=$courseinfo.':'.$now;
1.234 foxr 3343: }
1.311 albertel 3344: if (&untie_domain_hash($hashref)) {
1.253 foxr 3345: &Reply( $client, "ok\n", $userinput);
1.234 foxr 3346: } else {
1.253 foxr 3347: &Failure($client, "error: ".($!+0)
1.234 foxr 3348: ." untie(GDBM) Failed ".
3349: "while attempting courseidput\n", $userinput);
3350: }
3351: } else {
1.253 foxr 3352: &Failure($client, "error: ".($!+0)
1.234 foxr 3353: ." tie(GDBM) Failed ".
3354: "while attempting courseidput\n", $userinput);
3355: }
3356:
3357: return 1;
3358: }
3359: ®ister_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
3360:
1.383 raeburn 3361: sub put_course_id_hash_handler {
3362: my ($cmd, $tail, $client) = @_;
3363: my $userinput = "$cmd:$tail";
1.384 raeburn 3364: my ($udom,$mode,$what) = split(/:/, $tail,3);
1.383 raeburn 3365: chomp($what);
3366: my $now=time;
3367: my @pairs=split(/\&/,$what);
1.384 raeburn 3368: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
1.383 raeburn 3369: if ($hashref) {
3370: foreach my $pair (@pairs) {
3371: my ($key,$value)=split(/=/,$pair);
1.384 raeburn 3372: my $unesc_key = &unescape($key);
3373: if ($mode ne 'timeonly') {
3374: if (!defined($hashref->{&escape('lasttime:'.$unesc_key)})) {
3375: my $curritems = &Apache::lonnet::thaw_unescape($key);
3376: if (ref($curritems) ne 'HASH') {
3377: my @current_items = split(/:/,$hashref->{$key},-1);
3378: my $lasttime = pop(@current_items);
3379: $hashref->{&escape('lasttime:'.$unesc_key)} = $lasttime;
3380: } else {
3381: $hashref->{&escape('lasttime:'.$unesc_key)} = '';
3382: }
3383: }
3384: $hashref->{$key} = $value;
3385: }
3386: if ($mode ne 'notime') {
3387: $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
3388: }
1.383 raeburn 3389: }
3390: if (&untie_domain_hash($hashref)) {
3391: &Reply($client, "ok\n", $userinput);
3392: } else {
3393: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3394: "while attempting courseidputhash\n", $userinput);
3395: }
3396: } else {
3397: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3398: "while attempting courseidputhash\n", $userinput);
3399: }
3400: return 1;
3401: }
3402: ®ister_handler("courseidputhash", \&put_course_id_hash_handler, 0, 1, 0);
3403:
1.234 foxr 3404: # Retrieves the value of a course id resource keyword pattern
3405: # defined since a starting date. Both the starting date and the
3406: # keyword pattern are optional. If the starting date is not supplied it
3407: # is treated as the beginning of time. If the pattern is not found,
3408: # it is treatred as "." matching everything.
3409: #
3410: # Parameters:
3411: # $cmd - Command keyword that resulted in us being dispatched.
3412: # $tail - The remainder of the command that, in this case, consists
3413: # of a colon separated list of:
3414: # domain - The domain in which the course database is
3415: # defined.
3416: # since - Optional parameter describing the minimum
3417: # time of definition(?) of the resources that
3418: # will match the dump.
3419: # description - regular expression that is used to filter
3420: # the dump. Only keywords matching this regexp
3421: # will be used.
1.272 raeburn 3422: # institutional code - optional supplied code to filter
3423: # the dump. Only courses with an institutional code
3424: # that match the supplied code will be returned.
1.336 raeburn 3425: # owner - optional supplied username and domain of owner to
3426: # filter the dump. Only courses for which the course
3427: # owner matches the supplied username and/or domain
3428: # will be returned. Pre-2.2.0 legacy entries from
3429: # nohist_courseiddump will only contain usernames.
1.384 raeburn 3430: # type - optional parameter for selection
3431: # regexp_ok - if true, allow the supplied institutional code
3432: # filter to behave as a regular expression.
3433: # rtn_as_hash - whether to return the information available for
3434: # each matched item as a frozen hash of all
3435: # key, value pairs in the item's hash, or as a
3436: # colon-separated list of (in order) description,
3437: # institutional code, and course owner.
3438: #
1.234 foxr 3439: # $client - The socket open on the client.
3440: # Returns:
3441: # 1 - Continue processing.
3442: # Side Effects:
3443: # a reply is written to $client.
3444: sub dump_course_id_handler {
3445: my ($cmd, $tail, $client) = @_;
3446: my $userinput = "$cmd:$tail";
3447:
1.333 raeburn 3448: my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
1.384 raeburn 3449: $typefilter,$regexp_ok,$rtn_as_hash) =split(/:/,$tail);
1.234 foxr 3450: if (defined($description)) {
3451: $description=&unescape($description);
3452: } else {
3453: $description='.';
3454: }
1.266 raeburn 3455: if (defined($instcodefilter)) {
3456: $instcodefilter=&unescape($instcodefilter);
3457: } else {
3458: $instcodefilter='.';
3459: }
1.336 raeburn 3460: my ($ownerunamefilter,$ownerdomfilter);
1.266 raeburn 3461: if (defined($ownerfilter)) {
3462: $ownerfilter=&unescape($ownerfilter);
1.336 raeburn 3463: if ($ownerfilter ne '.' && defined($ownerfilter)) {
3464: if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
3465: $ownerunamefilter = $1;
3466: $ownerdomfilter = $2;
3467: } else {
3468: $ownerunamefilter = $ownerfilter;
3469: $ownerdomfilter = '';
3470: }
3471: }
1.266 raeburn 3472: } else {
3473: $ownerfilter='.';
3474: }
1.336 raeburn 3475:
1.282 raeburn 3476: if (defined($coursefilter)) {
3477: $coursefilter=&unescape($coursefilter);
3478: } else {
3479: $coursefilter='.';
3480: }
1.333 raeburn 3481: if (defined($typefilter)) {
3482: $typefilter=&unescape($typefilter);
3483: } else {
3484: $typefilter='.';
3485: }
1.344 raeburn 3486: if (defined($regexp_ok)) {
3487: $regexp_ok=&unescape($regexp_ok);
3488: }
1.384 raeburn 3489: my $unpack = 1;
3490: if ($description eq '.' && $instcodefilter eq '.' && $coursefilter eq '.' &&
3491: $typefilter eq '.') {
3492: $unpack = 0;
3493: }
3494: if (!defined($since)) { $since=0; }
1.234 foxr 3495: my $qresult='';
3496: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3497: if ($hashref) {
1.384 raeburn 3498: while (my ($key,$value) = each(%$hashref)) {
3499: my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,%unesc_val);
3500: $unesc_key = &unescape($key);
3501: if ($unesc_key =~ /^lasttime:/) {
3502: next;
3503: } else {
3504: $lasttime_key = &escape('lasttime:'.$unesc_key);
3505: }
3506: if ($hashref->{$lasttime_key} ne '') {
3507: $lasttime = $hashref->{$lasttime_key};
3508: next if ($lasttime<$since);
3509: }
3510: my $items = &Apache::lonnet::thaw_unescape($value);
3511: if (ref($items) eq 'HASH') {
3512: $is_hash = 1;
3513: if ($unpack || !$rtn_as_hash) {
3514: $unesc_val{'descr'} = $items->{'description'};
3515: $unesc_val{'inst_code'} = $items->{'inst_code'};
3516: $unesc_val{'owner'} = $items->{'owner'};
3517: $unesc_val{'type'} = $items->{'type'};
3518: }
1.383 raeburn 3519: } else {
1.384 raeburn 3520: $is_hash = 0;
1.388 raeburn 3521: my @courseitems = split(/:/,$value);
1.383 raeburn 3522: $lasttime = pop(@courseitems);
1.384 raeburn 3523: next if ($lasttime<$since);
3524: ($val{'descr'},$val{'inst_code'},$val{'owner'},$val{'type'}) = @courseitems;
1.383 raeburn 3525: }
1.266 raeburn 3526: my $match = 1;
1.384 raeburn 3527: if ($description ne '.') {
3528: if (!$is_hash) {
3529: $unesc_val{'descr'} = &unescape($val{'descr'});
3530: }
3531: if (eval{$unesc_val{'descr'} !~ /\Q$description\E/i}) {
1.266 raeburn 3532: $match = 0;
1.384 raeburn 3533: }
1.266 raeburn 3534: }
1.384 raeburn 3535: if ($instcodefilter ne '.') {
3536: if (!$is_hash) {
3537: $unesc_val{'inst_code'} = &unescape($val{'inst_code'});
3538: }
1.344 raeburn 3539: if ($regexp_ok) {
1.384 raeburn 3540: if (eval{$unesc_val{'inst_code'} !~ /$instcodefilter/}) {
1.344 raeburn 3541: $match = 0;
3542: }
3543: } else {
1.384 raeburn 3544: if (eval{$unesc_val{'inst_code'} !~ /\Q$instcodefilter\E/i}) {
1.344 raeburn 3545: $match = 0;
3546: }
1.266 raeburn 3547: }
1.234 foxr 3548: }
1.384 raeburn 3549: if ($ownerfilter ne '.') {
3550: if (!$is_hash) {
3551: $unesc_val{'owner'} = &unescape($val{'owner'});
3552: }
1.336 raeburn 3553: if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
1.384 raeburn 3554: if ($unesc_val{'owner'} =~ /:/) {
3555: if (eval{$unesc_val{'owner'} !~
3556: /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i}) {
1.336 raeburn 3557: $match = 0;
3558: }
3559: } else {
1.384 raeburn 3560: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
1.336 raeburn 3561: $match = 0;
3562: }
3563: }
3564: } elsif ($ownerunamefilter ne '') {
1.384 raeburn 3565: if ($unesc_val{'owner'} =~ /:/) {
3566: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E:[^:]+$/i}) {
1.336 raeburn 3567: $match = 0;
3568: }
3569: } else {
1.384 raeburn 3570: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
1.336 raeburn 3571: $match = 0;
3572: }
3573: }
3574: } elsif ($ownerdomfilter ne '') {
1.384 raeburn 3575: if ($unesc_val{'owner'} =~ /:/) {
3576: if (eval{$unesc_val{'owner'} !~ /^[^:]+:\Q$ownerdomfilter\E/}) {
1.336 raeburn 3577: $match = 0;
3578: }
3579: } else {
3580: if ($ownerdomfilter ne $udom) {
3581: $match = 0;
3582: }
3583: }
1.266 raeburn 3584: }
3585: }
1.384 raeburn 3586: if ($coursefilter ne '.') {
3587: if (eval{$unesc_key !~ /^$udom(_)\Q$coursefilter\E$/}) {
1.282 raeburn 3588: $match = 0;
3589: }
3590: }
1.384 raeburn 3591: if ($typefilter ne '.') {
3592: if (!$is_hash) {
3593: $unesc_val{'type'} = &unescape($val{'type'});
3594: }
3595: if ($unesc_val{'type'} eq '') {
1.333 raeburn 3596: if ($typefilter ne 'Course') {
3597: $match = 0;
3598: }
1.383 raeburn 3599: } else {
1.384 raeburn 3600: if (eval{$unesc_val{'type'} !~ /^\Q$typefilter\E$/}) {
1.333 raeburn 3601: $match = 0;
3602: }
3603: }
3604: }
1.266 raeburn 3605: if ($match == 1) {
1.384 raeburn 3606: if ($rtn_as_hash) {
3607: if ($is_hash) {
3608: $qresult.=$key.'='.$value.'&';
3609: } else {
1.388 raeburn 3610: my %rtnhash = ( 'description' => &unescape($val{'descr'}),
3611: 'inst_code' => &unescape($val{'inst_code'}),
3612: 'owner' => &unescape($val{'owner'}),
3613: 'type' => &unescape($val{'type'}),
1.384 raeburn 3614: );
3615: my $items = &Apache::lonnet::freeze_escape(\%rtnhash);
3616: $qresult.=$key.'='.$items.'&';
3617: }
1.383 raeburn 3618: } else {
1.384 raeburn 3619: if ($is_hash) {
3620: $qresult .= $key.'='.&escape($unesc_val{'descr'}).':'.
3621: &escape($unesc_val{'inst_code'}).':'.
3622: &escape($unesc_val{'owner'}).'&';
3623: } else {
3624: $qresult .= $key.'='.$val{'descr'}.':'.$val{'inst_code'}.
3625: ':'.$val{'owner'}.'&';
3626: }
1.383 raeburn 3627: }
1.266 raeburn 3628: }
1.234 foxr 3629: }
1.311 albertel 3630: if (&untie_domain_hash($hashref)) {
1.234 foxr 3631: chop($qresult);
1.387 albertel 3632: &Reply($client, \$qresult, $userinput);
1.234 foxr 3633: } else {
3634: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3635: "while attempting courseiddump\n", $userinput);
3636: }
3637: } else {
3638: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3639: "while attempting courseiddump\n", $userinput);
3640: }
3641: return 1;
3642: }
3643: ®ister_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
1.238 foxr 3644:
3645: #
1.348 raeburn 3646: # Puts an unencrypted entry in a namespace db file at the domain level
3647: #
3648: # Parameters:
3649: # $cmd - The command that got us here.
3650: # $tail - Tail of the command (remaining parameters).
3651: # $client - File descriptor connected to client.
3652: # Returns
3653: # 0 - Requested to exit, caller should shut down.
3654: # 1 - Continue processing.
3655: # Side effects:
3656: # reply is written to $client.
3657: #
3658: sub put_domain_handler {
3659: my ($cmd,$tail,$client) = @_;
3660:
3661: my $userinput = "$cmd:$tail";
3662:
3663: my ($udom,$namespace,$what) =split(/:/,$tail,3);
3664: chomp($what);
3665: my @pairs=split(/\&/,$what);
3666: my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_WRCREAT(),
3667: "P", $what);
3668: if ($hashref) {
3669: foreach my $pair (@pairs) {
3670: my ($key,$value)=split(/=/,$pair);
3671: $hashref->{$key}=$value;
3672: }
3673: if (&untie_domain_hash($hashref)) {
3674: &Reply($client, "ok\n", $userinput);
3675: } else {
3676: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3677: "while attempting putdom\n", $userinput);
3678: }
3679: } else {
3680: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3681: "while attempting putdom\n", $userinput);
3682: }
3683:
3684: return 1;
3685: }
3686: ®ister_handler("putdom", \&put_domain_handler, 0, 1, 0);
3687:
3688: # Unencrypted get from the namespace database file at the domain level.
3689: # This function retrieves a keyed item from a specific named database in the
3690: # domain directory.
3691: #
3692: # Parameters:
3693: # $cmd - Command request keyword (get).
3694: # $tail - Tail of the command. This is a colon separated list
3695: # consisting of the domain and the 'namespace'
3696: # which selects the gdbm file to do the lookup in,
3697: # & separated list of keys to lookup. Note that
3698: # the values are returned as an & separated list too.
3699: # $client - File descriptor open on the client.
3700: # Returns:
3701: # 1 - Continue processing.
3702: # 0 - Exit.
3703: # Side effects:
3704: # reply is written to $client.
3705: #
3706:
3707: sub get_domain_handler {
3708: my ($cmd, $tail, $client) = @_;
3709:
3710: my $userinput = "$client:$tail";
3711:
3712: my ($udom,$namespace,$what)=split(/:/,$tail,3);
3713: chomp($what);
3714: my @queries=split(/\&/,$what);
3715: my $qresult='';
3716: my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_READER());
3717: if ($hashref) {
3718: for (my $i=0;$i<=$#queries;$i++) {
3719: $qresult.="$hashref->{$queries[$i]}&";
3720: }
3721: if (&untie_domain_hash($hashref)) {
3722: $qresult=~s/\&$//;
1.387 albertel 3723: &Reply($client, \$qresult, $userinput);
1.348 raeburn 3724: } else {
3725: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3726: "while attempting getdom\n",$userinput);
3727: }
3728: } else {
3729: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3730: "while attempting getdom\n",$userinput);
3731: }
3732:
3733: return 1;
3734: }
1.360 raeburn 3735: ®ister_handler("getdom", \&get_domain_handler, 0, 1, 0);
1.348 raeburn 3736:
3737:
3738: #
1.238 foxr 3739: # Puts an id to a domains id database.
3740: #
3741: # Parameters:
3742: # $cmd - The command that triggered us.
3743: # $tail - Remainder of the request other than the command. This is a
3744: # colon separated list containing:
3745: # $domain - The domain for which we are writing the id.
3746: # $pairs - The id info to write... this is and & separated list
3747: # of keyword=value.
3748: # $client - Socket open on the client.
3749: # Returns:
3750: # 1 - Continue processing.
3751: # Side effects:
3752: # reply is written to $client.
3753: #
3754: sub put_id_handler {
3755: my ($cmd,$tail,$client) = @_;
3756:
3757:
3758: my $userinput = "$cmd:$tail";
3759:
3760: my ($udom,$what)=split(/:/,$tail);
3761: chomp($what);
3762: my @pairs=split(/\&/,$what);
3763: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
3764: "P", $what);
3765: if ($hashref) {
3766: foreach my $pair (@pairs) {
3767: my ($key,$value)=split(/=/,$pair);
3768: $hashref->{$key}=$value;
3769: }
1.311 albertel 3770: if (&untie_domain_hash($hashref)) {
1.238 foxr 3771: &Reply($client, "ok\n", $userinput);
3772: } else {
3773: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3774: "while attempting idput\n", $userinput);
3775: }
3776: } else {
3777: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3778: "while attempting idput\n", $userinput);
3779: }
3780:
3781: return 1;
3782: }
1.263 albertel 3783: ®ister_handler("idput", \&put_id_handler, 0, 1, 0);
1.238 foxr 3784:
3785: #
3786: # Retrieves a set of id values from the id database.
3787: # Returns an & separated list of results, one for each requested id to the
3788: # client.
3789: #
3790: # Parameters:
3791: # $cmd - Command keyword that caused us to be dispatched.
3792: # $tail - Tail of the command. Consists of a colon separated:
3793: # domain - the domain whose id table we dump
3794: # ids Consists of an & separated list of
3795: # id keywords whose values will be fetched.
3796: # nonexisting keywords will have an empty value.
3797: # $client - Socket open on the client.
3798: #
3799: # Returns:
3800: # 1 - indicating processing should continue.
3801: # Side effects:
3802: # An & separated list of results is written to $client.
3803: #
3804: sub get_id_handler {
3805: my ($cmd, $tail, $client) = @_;
3806:
3807:
3808: my $userinput = "$client:$tail";
3809:
3810: my ($udom,$what)=split(/:/,$tail);
3811: chomp($what);
3812: my @queries=split(/\&/,$what);
3813: my $qresult='';
3814: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
3815: if ($hashref) {
3816: for (my $i=0;$i<=$#queries;$i++) {
3817: $qresult.="$hashref->{$queries[$i]}&";
3818: }
1.311 albertel 3819: if (&untie_domain_hash($hashref)) {
1.238 foxr 3820: $qresult=~s/\&$//;
1.387 albertel 3821: &Reply($client, \$qresult, $userinput);
1.238 foxr 3822: } else {
3823: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3824: "while attempting idget\n",$userinput);
3825: }
3826: } else {
3827: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3828: "while attempting idget\n",$userinput);
3829: }
3830:
3831: return 1;
3832: }
1.263 albertel 3833: ®ister_handler("idget", \&get_id_handler, 0, 1, 0);
1.238 foxr 3834:
3835: #
1.299 raeburn 3836: # Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database
3837: #
3838: # Parameters
3839: # $cmd - Command keyword that caused us to be dispatched.
3840: # $tail - Tail of the command. Consists of a colon separated:
3841: # domain - the domain whose dcmail we are recording
3842: # email Consists of key=value pair
3843: # where key is unique msgid
3844: # and value is message (in XML)
3845: # $client - Socket open on the client.
3846: #
3847: # Returns:
3848: # 1 - indicating processing should continue.
3849: # Side effects
3850: # reply is written to $client.
3851: #
3852: sub put_dcmail_handler {
3853: my ($cmd,$tail,$client) = @_;
3854: my $userinput = "$cmd:$tail";
3855:
3856: my ($udom,$what)=split(/:/,$tail);
3857: chomp($what);
3858: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
3859: if ($hashref) {
3860: my ($key,$value)=split(/=/,$what);
3861: $hashref->{$key}=$value;
3862: }
1.311 albertel 3863: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3864: &Reply($client, "ok\n", $userinput);
3865: } else {
3866: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3867: "while attempting dcmailput\n", $userinput);
3868: }
3869: return 1;
3870: }
3871: ®ister_handler("dcmailput", \&put_dcmail_handler, 0, 1, 0);
3872:
3873: #
3874: # Retrieves broadcast e-mail from nohist_dcmail database
3875: # Returns to client an & separated list of key=value pairs,
3876: # where key is msgid and value is message information.
3877: #
3878: # Parameters
3879: # $cmd - Command keyword that caused us to be dispatched.
3880: # $tail - Tail of the command. Consists of a colon separated:
3881: # domain - the domain whose dcmail table we dump
3882: # startfilter - beginning of time window
3883: # endfilter - end of time window
3884: # sendersfilter - & separated list of username:domain
3885: # for senders to search for.
3886: # $client - Socket open on the client.
3887: #
3888: # Returns:
3889: # 1 - indicating processing should continue.
3890: # Side effects
3891: # reply (& separated list of msgid=messageinfo pairs) is
3892: # written to $client.
3893: #
3894: sub dump_dcmail_handler {
3895: my ($cmd, $tail, $client) = @_;
3896:
3897: my $userinput = "$cmd:$tail";
3898: my ($udom,$startfilter,$endfilter,$sendersfilter) = split(/:/,$tail);
3899: chomp($sendersfilter);
3900: my @senders = ();
3901: if (defined($startfilter)) {
3902: $startfilter=&unescape($startfilter);
3903: } else {
3904: $startfilter='.';
3905: }
3906: if (defined($endfilter)) {
3907: $endfilter=&unescape($endfilter);
3908: } else {
3909: $endfilter='.';
3910: }
3911: if (defined($sendersfilter)) {
3912: $sendersfilter=&unescape($sendersfilter);
1.300 albertel 3913: @senders = map { &unescape($_) } split(/\&/,$sendersfilter);
1.299 raeburn 3914: }
3915:
3916: my $qresult='';
3917: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
3918: if ($hashref) {
3919: while (my ($key,$value) = each(%$hashref)) {
3920: my $match = 1;
1.303 albertel 3921: my ($timestamp,$subj,$uname,$udom) =
3922: split(/:/,&unescape(&unescape($key)),5); # yes, twice really
1.299 raeburn 3923: $subj = &unescape($subj);
3924: unless ($startfilter eq '.' || !defined($startfilter)) {
3925: if ($timestamp < $startfilter) {
3926: $match = 0;
3927: }
3928: }
3929: unless ($endfilter eq '.' || !defined($endfilter)) {
3930: if ($timestamp > $endfilter) {
3931: $match = 0;
3932: }
3933: }
3934: unless (@senders < 1) {
3935: unless (grep/^$uname:$udom$/,@senders) {
3936: $match = 0;
3937: }
3938: }
3939: if ($match == 1) {
3940: $qresult.=$key.'='.$value.'&';
3941: }
3942: }
1.311 albertel 3943: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3944: chop($qresult);
1.387 albertel 3945: &Reply($client, \$qresult, $userinput);
1.299 raeburn 3946: } else {
3947: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3948: "while attempting dcmaildump\n", $userinput);
3949: }
3950: } else {
3951: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3952: "while attempting dcmaildump\n", $userinput);
3953: }
3954: return 1;
3955: }
3956:
3957: ®ister_handler("dcmaildump", \&dump_dcmail_handler, 0, 1, 0);
3958:
3959: #
3960: # Puts domain roles in nohist_domainroles database
3961: #
3962: # Parameters
3963: # $cmd - Command keyword that caused us to be dispatched.
3964: # $tail - Tail of the command. Consists of a colon separated:
3965: # domain - the domain whose roles we are recording
3966: # role - Consists of key=value pair
3967: # where key is unique role
3968: # and value is start/end date information
3969: # $client - Socket open on the client.
3970: #
3971: # Returns:
3972: # 1 - indicating processing should continue.
3973: # Side effects
3974: # reply is written to $client.
3975: #
3976:
3977: sub put_domainroles_handler {
3978: my ($cmd,$tail,$client) = @_;
3979:
3980: my $userinput = "$cmd:$tail";
3981: my ($udom,$what)=split(/:/,$tail);
3982: chomp($what);
3983: my @pairs=split(/\&/,$what);
3984: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
3985: if ($hashref) {
3986: foreach my $pair (@pairs) {
3987: my ($key,$value)=split(/=/,$pair);
3988: $hashref->{$key}=$value;
3989: }
1.311 albertel 3990: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3991: &Reply($client, "ok\n", $userinput);
3992: } else {
3993: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3994: "while attempting domroleput\n", $userinput);
3995: }
3996: } else {
3997: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3998: "while attempting domroleput\n", $userinput);
3999: }
4000:
4001: return 1;
4002: }
4003:
4004: ®ister_handler("domroleput", \&put_domainroles_handler, 0, 1, 0);
4005:
4006: #
4007: # Retrieves domain roles from nohist_domainroles database
4008: # Returns to client an & separated list of key=value pairs,
4009: # where key is role and value is start and end date information.
4010: #
4011: # Parameters
4012: # $cmd - Command keyword that caused us to be dispatched.
4013: # $tail - Tail of the command. Consists of a colon separated:
4014: # domain - the domain whose domain roles table we dump
4015: # $client - Socket open on the client.
4016: #
4017: # Returns:
4018: # 1 - indicating processing should continue.
4019: # Side effects
4020: # reply (& separated list of role=start/end info pairs) is
4021: # written to $client.
4022: #
4023: sub dump_domainroles_handler {
4024: my ($cmd, $tail, $client) = @_;
4025:
4026: my $userinput = "$cmd:$tail";
4027: my ($udom,$startfilter,$endfilter,$rolesfilter) = split(/:/,$tail);
4028: chomp($rolesfilter);
4029: my @roles = ();
4030: if (defined($startfilter)) {
4031: $startfilter=&unescape($startfilter);
4032: } else {
4033: $startfilter='.';
4034: }
4035: if (defined($endfilter)) {
4036: $endfilter=&unescape($endfilter);
4037: } else {
4038: $endfilter='.';
4039: }
4040: if (defined($rolesfilter)) {
4041: $rolesfilter=&unescape($rolesfilter);
1.300 albertel 4042: @roles = split(/\&/,$rolesfilter);
1.299 raeburn 4043: }
4044:
4045: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
4046: if ($hashref) {
4047: my $qresult = '';
4048: while (my ($key,$value) = each(%$hashref)) {
4049: my $match = 1;
4050: my ($start,$end) = split(/:/,&unescape($value));
4051: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,&unescape($key));
4052: unless ($startfilter eq '.' || !defined($startfilter)) {
4053: if ($start >= $startfilter) {
4054: $match = 0;
4055: }
4056: }
4057: unless ($endfilter eq '.' || !defined($endfilter)) {
4058: if ($end <= $endfilter) {
4059: $match = 0;
4060: }
4061: }
4062: unless (@roles < 1) {
1.389 raeburn 4063: unless (grep/^\Q$trole\E$/,@roles) {
1.299 raeburn 4064: $match = 0;
4065: }
4066: }
4067: if ($match == 1) {
4068: $qresult.=$key.'='.$value.'&';
4069: }
4070: }
1.311 albertel 4071: if (&untie_domain_hash($hashref)) {
1.299 raeburn 4072: chop($qresult);
1.387 albertel 4073: &Reply($client, \$qresult, $userinput);
1.299 raeburn 4074: } else {
4075: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
4076: "while attempting domrolesdump\n", $userinput);
4077: }
4078: } else {
4079: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
4080: "while attempting domrolesdump\n", $userinput);
4081: }
4082: return 1;
4083: }
4084:
4085: ®ister_handler("domrolesdump", \&dump_domainroles_handler, 0, 1, 0);
4086:
4087:
1.238 foxr 4088: # Process the tmpput command I'm not sure what this does.. Seems to
4089: # create a file in the lonDaemons/tmp directory of the form $id.tmp
4090: # where Id is the client's ip concatenated with a sequence number.
4091: # The file will contain some value that is passed in. Is this e.g.
4092: # a login token?
4093: #
4094: # Parameters:
4095: # $cmd - The command that got us dispatched.
4096: # $tail - The remainder of the request following $cmd:
4097: # In this case this will be the contents of the file.
4098: # $client - Socket connected to the client.
4099: # Returns:
4100: # 1 indicating processing can continue.
4101: # Side effects:
4102: # A file is created in the local filesystem.
4103: # A reply is sent to the client.
4104: sub tmp_put_handler {
4105: my ($cmd, $what, $client) = @_;
4106:
4107: my $userinput = "$cmd:$what"; # Reconstruct for logging.
4108:
1.347 raeburn 4109: my ($record,$context) = split(/:/,$what);
4110: if ($context ne '') {
4111: chomp($context);
4112: $context = &unescape($context);
4113: }
4114: my ($id,$store);
1.238 foxr 4115: $tmpsnum++;
1.347 raeburn 4116: if ($context eq 'resetpw') {
4117: $id = &md5_hex(&md5_hex(time.{}.rand().$$));
4118: } else {
4119: $id = $$.'_'.$clientip.'_'.$tmpsnum;
4120: }
1.238 foxr 4121: $id=~s/\W/\_/g;
1.347 raeburn 4122: $record=~s/\n//g;
1.238 foxr 4123: my $execdir=$perlvar{'lonDaemons'};
4124: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
1.347 raeburn 4125: print $store $record;
1.238 foxr 4126: close $store;
1.387 albertel 4127: &Reply($client, \$id, $userinput);
1.238 foxr 4128: } else {
4129: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
4130: "while attempting tmpput\n", $userinput);
4131: }
4132: return 1;
4133:
4134: }
4135: ®ister_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
1.263 albertel 4136:
1.238 foxr 4137: # Processes the tmpget command. This command returns the contents
4138: # of a temporary resource file(?) created via tmpput.
4139: #
4140: # Paramters:
4141: # $cmd - Command that got us dispatched.
4142: # $id - Tail of the command, contain the id of the resource
4143: # we want to fetch.
4144: # $client - socket open on the client.
4145: # Return:
4146: # 1 - Inidcating processing can continue.
4147: # Side effects:
4148: # A reply is sent to the client.
4149: #
4150: sub tmp_get_handler {
4151: my ($cmd, $id, $client) = @_;
4152:
4153: my $userinput = "$cmd:$id";
4154:
4155:
4156: $id=~s/\W/\_/g;
4157: my $store;
4158: my $execdir=$perlvar{'lonDaemons'};
4159: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
4160: my $reply=<$store>;
1.387 albertel 4161: &Reply( $client, \$reply, $userinput);
1.238 foxr 4162: close $store;
4163: } else {
4164: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
4165: "while attempting tmpget\n", $userinput);
4166: }
4167:
4168: return 1;
4169: }
4170: ®ister_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
1.263 albertel 4171:
1.238 foxr 4172: #
4173: # Process the tmpdel command. This command deletes a temp resource
4174: # created by the tmpput command.
4175: #
4176: # Parameters:
4177: # $cmd - Command that got us here.
4178: # $id - Id of the temporary resource created.
4179: # $client - socket open on the client process.
4180: #
4181: # Returns:
4182: # 1 - Indicating processing should continue.
4183: # Side Effects:
4184: # A file is deleted
4185: # A reply is sent to the client.
4186: sub tmp_del_handler {
4187: my ($cmd, $id, $client) = @_;
4188:
4189: my $userinput= "$cmd:$id";
4190:
4191: chomp($id);
4192: $id=~s/\W/\_/g;
4193: my $execdir=$perlvar{'lonDaemons'};
4194: if (unlink("$execdir/tmp/$id.tmp")) {
4195: &Reply($client, "ok\n", $userinput);
4196: } else {
4197: &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
4198: "while attempting tmpdel\n", $userinput);
4199: }
4200:
4201: return 1;
4202:
4203: }
4204: ®ister_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
1.263 albertel 4205:
1.238 foxr 4206: #
1.246 foxr 4207: # Processes the setannounce command. This command
4208: # creates a file named announce.txt in the top directory of
4209: # the documentn root and sets its contents. The announce.txt file is
4210: # printed in its entirety at the LonCAPA login page. Note:
4211: # once the announcement.txt fileis created it cannot be deleted.
4212: # However, setting the contents of the file to empty removes the
4213: # announcement from the login page of loncapa so who cares.
4214: #
4215: # Parameters:
4216: # $cmd - The command that got us dispatched.
4217: # $announcement - The text of the announcement.
4218: # $client - Socket open on the client process.
4219: # Retunrns:
4220: # 1 - Indicating request processing should continue
4221: # Side Effects:
4222: # The file {DocRoot}/announcement.txt is created.
4223: # A reply is sent to $client.
4224: #
4225: sub set_announce_handler {
4226: my ($cmd, $announcement, $client) = @_;
4227:
4228: my $userinput = "$cmd:$announcement";
4229:
4230: chomp($announcement);
4231: $announcement=&unescape($announcement);
4232: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
4233: '/announcement.txt')) {
4234: print $store $announcement;
4235: close $store;
4236: &Reply($client, "ok\n", $userinput);
4237: } else {
4238: &Failure($client, "error: ".($!+0)."\n", $userinput);
4239: }
4240:
4241: return 1;
4242: }
4243: ®ister_handler("setannounce", \&set_announce_handler, 0, 1, 0);
1.263 albertel 4244:
1.246 foxr 4245: #
4246: # Return the version of the daemon. This can be used to determine
4247: # the compatibility of cross version installations or, alternatively to
4248: # simply know who's out of date and who isn't. Note that the version
4249: # is returned concatenated with the tail.
4250: # Parameters:
4251: # $cmd - the request that dispatched to us.
4252: # $tail - Tail of the request (client's version?).
4253: # $client - Socket open on the client.
4254: #Returns:
4255: # 1 - continue processing requests.
4256: # Side Effects:
4257: # Replies with version to $client.
4258: sub get_version_handler {
4259: my ($cmd, $tail, $client) = @_;
4260:
4261: my $userinput = $cmd.$tail;
4262:
4263: &Reply($client, &version($userinput)."\n", $userinput);
4264:
4265:
4266: return 1;
4267: }
4268: ®ister_handler("version", \&get_version_handler, 0, 1, 0);
1.263 albertel 4269:
1.246 foxr 4270: # Set the current host and domain. This is used to support
4271: # multihomed systems. Each IP of the system, or even separate daemons
4272: # on the same IP can be treated as handling a separate lonCAPA virtual
4273: # machine. This command selects the virtual lonCAPA. The client always
4274: # knows the right one since it is lonc and it is selecting the domain/system
4275: # from the hosts.tab file.
4276: # Parameters:
4277: # $cmd - Command that dispatched us.
4278: # $tail - Tail of the command (domain/host requested).
4279: # $socket - Socket open on the client.
4280: #
4281: # Returns:
4282: # 1 - Indicates the program should continue to process requests.
4283: # Side-effects:
4284: # The default domain/system context is modified for this daemon.
4285: # a reply is sent to the client.
4286: #
4287: sub set_virtual_host_handler {
4288: my ($cmd, $tail, $socket) = @_;
4289:
4290: my $userinput ="$cmd:$tail";
4291:
4292: &Reply($client, &sethost($userinput)."\n", $userinput);
4293:
4294:
4295: return 1;
4296: }
1.247 albertel 4297: ®ister_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
1.246 foxr 4298:
4299: # Process a request to exit:
4300: # - "bye" is sent to the client.
4301: # - The client socket is shutdown and closed.
4302: # - We indicate to the caller that we should exit.
4303: # Formal Parameters:
4304: # $cmd - The command that got us here.
4305: # $tail - Tail of the command (empty).
4306: # $client - Socket open on the tail.
4307: # Returns:
4308: # 0 - Indicating the program should exit!!
4309: #
4310: sub exit_handler {
4311: my ($cmd, $tail, $client) = @_;
4312:
4313: my $userinput = "$cmd:$tail";
4314:
4315: &logthis("Client $clientip ($clientname) hanging up: $userinput");
4316: &Reply($client, "bye\n", $userinput);
4317: $client->shutdown(2); # shutdown the socket forcibly.
4318: $client->close();
4319:
4320: return 0;
4321: }
1.248 foxr 4322: ®ister_handler("exit", \&exit_handler, 0,1,1);
4323: ®ister_handler("init", \&exit_handler, 0,1,1);
4324: ®ister_handler("quit", \&exit_handler, 0,1,1);
4325:
4326: # Determine if auto-enrollment is enabled.
4327: # Note that the original had what I believe to be a defect.
4328: # The original returned 0 if the requestor was not a registerd client.
4329: # It should return "refused".
4330: # Formal Parameters:
4331: # $cmd - The command that invoked us.
4332: # $tail - The tail of the command (Extra command parameters.
4333: # $client - The socket open on the client that issued the request.
4334: # Returns:
4335: # 1 - Indicating processing should continue.
4336: #
4337: sub enrollment_enabled_handler {
4338: my ($cmd, $tail, $client) = @_;
4339: my $userinput = $cmd.":".$tail; # For logging purposes.
4340:
4341:
1.337 albertel 4342: my ($cdom) = split(/:/, $tail, 2); # Domain we're asking about.
4343:
1.248 foxr 4344: my $outcome = &localenroll::run($cdom);
1.387 albertel 4345: &Reply($client, \$outcome, $userinput);
1.248 foxr 4346:
4347: return 1;
4348: }
4349: ®ister_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
4350:
4351: # Get the official sections for which auto-enrollment is possible.
4352: # Since the admin people won't know about 'unofficial sections'
4353: # we cannot auto-enroll on them.
4354: # Formal Parameters:
4355: # $cmd - The command request that got us dispatched here.
4356: # $tail - The remainder of the request. In our case this
4357: # will be split into:
4358: # $coursecode - The course name from the admin point of view.
4359: # $cdom - The course's domain(?).
4360: # $client - Socket open on the client.
4361: # Returns:
4362: # 1 - Indiciting processing should continue.
4363: #
4364: sub get_sections_handler {
4365: my ($cmd, $tail, $client) = @_;
4366: my $userinput = "$cmd:$tail";
4367:
4368: my ($coursecode, $cdom) = split(/:/, $tail);
4369: my @secs = &localenroll::get_sections($coursecode,$cdom);
4370: my $seclist = &escape(join(':',@secs));
4371:
1.387 albertel 4372: &Reply($client, \$seclist, $userinput);
1.248 foxr 4373:
4374:
4375: return 1;
4376: }
4377: ®ister_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
4378:
4379: # Validate the owner of a new course section.
4380: #
4381: # Formal Parameters:
4382: # $cmd - Command that got us dispatched.
4383: # $tail - the remainder of the command. For us this consists of a
4384: # colon separated string containing:
4385: # $inst - Course Id from the institutions point of view.
4386: # $owner - Proposed owner of the course.
4387: # $cdom - Domain of the course (from the institutions
4388: # point of view?)..
4389: # $client - Socket open on the client.
4390: #
4391: # Returns:
4392: # 1 - Processing should continue.
4393: #
4394: sub validate_course_owner_handler {
4395: my ($cmd, $tail, $client) = @_;
4396: my $userinput = "$cmd:$tail";
4397: my ($inst_course_id, $owner, $cdom) = split(/:/, $tail);
4398:
1.336 raeburn 4399: $owner = &unescape($owner);
1.248 foxr 4400: my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
1.387 albertel 4401: &Reply($client, \$outcome, $userinput);
1.248 foxr 4402:
4403:
4404:
4405: return 1;
4406: }
4407: ®ister_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
1.263 albertel 4408:
1.248 foxr 4409: #
4410: # Validate a course section in the official schedule of classes
4411: # from the institutions point of view (part of autoenrollment).
4412: #
4413: # Formal Parameters:
4414: # $cmd - The command request that got us dispatched.
4415: # $tail - The tail of the command. In this case,
4416: # this is a colon separated set of words that will be split
4417: # into:
4418: # $inst_course_id - The course/section id from the
4419: # institutions point of view.
4420: # $cdom - The domain from the institutions
4421: # point of view.
4422: # $client - Socket open on the client.
4423: # Returns:
4424: # 1 - Indicating processing should continue.
4425: #
4426: sub validate_course_section_handler {
4427: my ($cmd, $tail, $client) = @_;
4428: my $userinput = "$cmd:$tail";
4429: my ($inst_course_id, $cdom) = split(/:/, $tail);
4430:
4431: my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
1.387 albertel 4432: &Reply($client, \$outcome, $userinput);
1.248 foxr 4433:
4434:
4435: return 1;
4436: }
4437: ®ister_handler("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
4438:
4439: #
1.340 raeburn 4440: # Validate course owner's access to enrollment data for specific class section.
4441: #
4442: #
4443: # Formal Parameters:
4444: # $cmd - The command request that got us dispatched.
4445: # $tail - The tail of the command. In this case this is a colon separated
4446: # set of words that will be split into:
4447: # $inst_class - Institutional code for the specific class section
4448: # $courseowner - The escaped username:domain of the course owner
4449: # $cdom - The domain of the course from the institution's
4450: # point of view.
4451: # $client - The socket open on the client.
4452: # Returns:
4453: # 1 - continue processing.
4454: #
4455:
4456: sub validate_class_access_handler {
4457: my ($cmd, $tail, $client) = @_;
4458: my $userinput = "$cmd:$tail";
1.383 raeburn 4459: my ($inst_class,$ownerlist,$cdom) = split(/:/, $tail);
1.392 raeburn 4460: my $owners = &unescape($ownerlist);
1.341 albertel 4461: my $outcome;
4462: eval {
4463: local($SIG{__DIE__})='DEFAULT';
1.392 raeburn 4464: $outcome=&localenroll::check_section($inst_class,$owners,$cdom);
1.341 albertel 4465: };
1.387 albertel 4466: &Reply($client,\$outcome, $userinput);
1.340 raeburn 4467:
4468: return 1;
4469: }
4470: ®ister_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
4471:
4472: #
4473: # Create a password for a new LON-CAPA user added by auto-enrollment.
4474: # Only used for case where authentication method for new user is localauth
1.248 foxr 4475: #
4476: # Formal Parameters:
4477: # $cmd - The command request that got us dispatched.
4478: # $tail - The tail of the command. In this case this is a colon separated
4479: # set of words that will be split into:
1.340 raeburn 4480: # $authparam - An authentication parameter (localauth parameter).
1.248 foxr 4481: # $cdom - The domain of the course from the institution's
4482: # point of view.
4483: # $client - The socket open on the client.
4484: # Returns:
4485: # 1 - continue processing.
4486: #
4487: sub create_auto_enroll_password_handler {
4488: my ($cmd, $tail, $client) = @_;
4489: my $userinput = "$cmd:$tail";
4490:
4491: my ($authparam, $cdom) = split(/:/, $userinput);
4492:
4493: my ($create_passwd,$authchk);
4494: ($authparam,
4495: $create_passwd,
4496: $authchk) = &localenroll::create_password($authparam,$cdom);
4497:
4498: &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
4499: $userinput);
4500:
4501:
4502: return 1;
4503: }
4504: ®ister_handler("autocreatepassword", \&create_auto_enroll_password_handler,
4505: 0, 1, 0);
4506:
4507: # Retrieve and remove temporary files created by/during autoenrollment.
4508: #
4509: # Formal Parameters:
4510: # $cmd - The command that got us dispatched.
4511: # $tail - The tail of the command. In our case this is a colon
4512: # separated list that will be split into:
4513: # $filename - The name of the file to remove.
4514: # The filename is given as a path relative to
4515: # the LonCAPA temp file directory.
4516: # $client - Socket open on the client.
4517: #
4518: # Returns:
4519: # 1 - Continue processing.
4520: sub retrieve_auto_file_handler {
4521: my ($cmd, $tail, $client) = @_;
4522: my $userinput = "cmd:$tail";
4523:
4524: my ($filename) = split(/:/, $tail);
4525:
4526: my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
4527: if ( (-e $source) && ($filename ne '') ) {
4528: my $reply = '';
4529: if (open(my $fh,$source)) {
4530: while (<$fh>) {
4531: chomp($_);
4532: $_ =~ s/^\s+//g;
4533: $_ =~ s/\s+$//g;
4534: $reply .= $_;
4535: }
4536: close($fh);
4537: &Reply($client, &escape($reply)."\n", $userinput);
4538:
4539: # Does this have to be uncommented??!? (RF).
4540: #
4541: # unlink($source);
4542: } else {
4543: &Failure($client, "error\n", $userinput);
4544: }
4545: } else {
4546: &Failure($client, "error\n", $userinput);
4547: }
4548:
4549:
4550: return 1;
4551: }
4552: ®ister_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
4553:
4554: #
4555: # Read and retrieve institutional code format (for support form).
4556: # Formal Parameters:
4557: # $cmd - Command that dispatched us.
4558: # $tail - Tail of the command. In this case it conatins
4559: # the course domain and the coursename.
4560: # $client - Socket open on the client.
4561: # Returns:
4562: # 1 - Continue processing.
4563: #
4564: sub get_institutional_code_format_handler {
4565: my ($cmd, $tail, $client) = @_;
4566: my $userinput = "$cmd:$tail";
4567:
4568: my $reply;
4569: my($cdom,$course) = split(/:/,$tail);
4570: my @pairs = split/\&/,$course;
4571: my %instcodes = ();
4572: my %codes = ();
4573: my @codetitles = ();
4574: my %cat_titles = ();
4575: my %cat_order = ();
4576: foreach (@pairs) {
4577: my ($key,$value) = split/=/,$_;
4578: $instcodes{&unescape($key)} = &unescape($value);
4579: }
4580: my $formatreply = &localenroll::instcode_format($cdom,
4581: \%instcodes,
4582: \%codes,
4583: \@codetitles,
4584: \%cat_titles,
4585: \%cat_order);
4586: if ($formatreply eq 'ok') {
1.365 albertel 4587: my $codes_str = &Apache::lonnet::hash2str(%codes);
4588: my $codetitles_str = &Apache::lonnet::array2str(@codetitles);
4589: my $cat_titles_str = &Apache::lonnet::hash2str(%cat_titles);
4590: my $cat_order_str = &Apache::lonnet::hash2str(%cat_order);
1.248 foxr 4591: &Reply($client,
4592: $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'
4593: .$cat_order_str."\n",
4594: $userinput);
4595: } else {
4596: # this else branch added by RF since if not ok, lonc will
4597: # hang waiting on reply until timeout.
4598: #
4599: &Reply($client, "format_error\n", $userinput);
4600: }
4601:
4602: return 1;
4603: }
1.265 albertel 4604: ®ister_handler("autoinstcodeformat",
4605: \&get_institutional_code_format_handler,0,1,0);
1.246 foxr 4606:
1.345 raeburn 4607: sub get_institutional_defaults_handler {
4608: my ($cmd, $tail, $client) = @_;
4609: my $userinput = "$cmd:$tail";
4610:
4611: my $dom = $tail;
4612: my %defaults_hash;
4613: my @code_order;
4614: my $outcome;
4615: eval {
4616: local($SIG{__DIE__})='DEFAULT';
4617: $outcome = &localenroll::instcode_defaults($dom,\%defaults_hash,
4618: \@code_order);
4619: };
4620: if (!$@) {
4621: if ($outcome eq 'ok') {
4622: my $result='';
4623: while (my ($key,$value) = each(%defaults_hash)) {
4624: $result.=&escape($key).'='.&escape($value).'&';
4625: }
4626: $result .= 'code_order='.&escape(join('&',@code_order));
1.387 albertel 4627: &Reply($client,\$result,$userinput);
1.345 raeburn 4628: } else {
4629: &Reply($client,"error\n", $userinput);
4630: }
4631: } else {
4632: &Failure($client,"unknown_cmd\n",$userinput);
4633: }
4634: }
4635: ®ister_handler("autoinstcodedefaults",
4636: \&get_institutional_defaults_handler,0,1,0);
4637:
1.381 raeburn 4638: sub get_institutional_user_rules {
4639: my ($cmd, $tail, $client) = @_;
4640: my $userinput = "$cmd:$tail";
4641: my $dom = &unescape($tail);
4642: my (%rules_hash,@rules_order);
4643: my $outcome;
4644: eval {
4645: local($SIG{__DIE__})='DEFAULT';
4646: $outcome = &localenroll::username_rules($dom,\%rules_hash,\@rules_order);
4647: };
4648: if (!$@) {
4649: if ($outcome eq 'ok') {
4650: my $result;
4651: foreach my $key (keys(%rules_hash)) {
4652: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
4653: }
4654: $result =~ s/\&$//;
4655: $result .= ':';
4656: if (@rules_order > 0) {
4657: foreach my $item (@rules_order) {
4658: $result .= &escape($item).'&';
4659: }
4660: }
4661: $result =~ s/\&$//;
1.387 albertel 4662: &Reply($client,\$result,$userinput);
1.381 raeburn 4663: } else {
4664: &Reply($client,"error\n", $userinput);
4665: }
4666: } else {
4667: &Failure($client,"unknown_cmd\n",$userinput);
4668: }
4669: }
4670: ®ister_handler("instuserrules",\&get_institutional_user_rules,0,1,0);
4671:
1.389 raeburn 4672: sub get_institutional_id_rules {
4673: my ($cmd, $tail, $client) = @_;
4674: my $userinput = "$cmd:$tail";
4675: my $dom = &unescape($tail);
4676: my (%rules_hash,@rules_order);
4677: my $outcome;
4678: eval {
4679: local($SIG{__DIE__})='DEFAULT';
4680: $outcome = &localenroll::id_rules($dom,\%rules_hash,\@rules_order);
4681: };
4682: if (!$@) {
4683: if ($outcome eq 'ok') {
4684: my $result;
4685: foreach my $key (keys(%rules_hash)) {
4686: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
4687: }
4688: $result =~ s/\&$//;
4689: $result .= ':';
4690: if (@rules_order > 0) {
4691: foreach my $item (@rules_order) {
4692: $result .= &escape($item).'&';
4693: }
4694: }
4695: $result =~ s/\&$//;
4696: &Reply($client,\$result,$userinput);
4697: } else {
4698: &Reply($client,"error\n", $userinput);
4699: }
4700: } else {
4701: &Failure($client,"unknown_cmd\n",$userinput);
4702: }
4703: }
4704: ®ister_handler("instidrules",\&get_institutional_id_rules,0,1,0);
4705:
1.396 ! raeburn 4706: sub get_institutional_selfenroll_rules {
! 4707: my ($cmd, $tail, $client) = @_;
! 4708: my $userinput = "$cmd:$tail";
! 4709: my $dom = &unescape($tail);
! 4710: my (%rules_hash,@rules_order);
! 4711: my $outcome;
! 4712: eval {
! 4713: local($SIG{__DIE__})='DEFAULT';
! 4714: $outcome = &localenroll::selfenroll_rules($dom,\%rules_hash,\@rules_order);
! 4715: };
! 4716: if (!$@) {
! 4717: if ($outcome eq 'ok') {
! 4718: my $result;
! 4719: foreach my $key (keys(%rules_hash)) {
! 4720: $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
! 4721: }
! 4722: $result =~ s/\&$//;
! 4723: $result .= ':';
! 4724: if (@rules_order > 0) {
! 4725: foreach my $item (@rules_order) {
! 4726: $result .= &escape($item).'&';
! 4727: }
! 4728: }
! 4729: $result =~ s/\&$//;
! 4730: &Reply($client,\$result,$userinput);
! 4731: } else {
! 4732: &Reply($client,"error\n", $userinput);
! 4733: }
! 4734: } else {
! 4735: &Failure($client,"unknown_cmd\n",$userinput);
! 4736: }
! 4737: }
! 4738: ®ister_handler("instemailrules",\&get_institutional_selfenroll_rules,0,1,0);
! 4739:
1.381 raeburn 4740:
4741: sub institutional_username_check {
4742: my ($cmd, $tail, $client) = @_;
4743: my $userinput = "$cmd:$tail";
4744: my %rulecheck;
4745: my $outcome;
4746: my ($udom,$uname,@rules) = split(/:/,$tail);
4747: $udom = &unescape($udom);
4748: $uname = &unescape($uname);
4749: @rules = map {&unescape($_);} (@rules);
4750: eval {
4751: local($SIG{__DIE__})='DEFAULT';
4752: $outcome = &localenroll::username_check($udom,$uname,\@rules,\%rulecheck);
4753: };
4754: if (!$@) {
4755: if ($outcome eq 'ok') {
4756: my $result='';
4757: foreach my $key (keys(%rulecheck)) {
4758: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
4759: }
1.387 albertel 4760: &Reply($client,\$result,$userinput);
1.381 raeburn 4761: } else {
4762: &Reply($client,"error\n", $userinput);
4763: }
4764: } else {
4765: &Failure($client,"unknown_cmd\n",$userinput);
4766: }
4767: }
4768: ®ister_handler("instrulecheck",\&institutional_username_check,0,1,0);
4769:
1.389 raeburn 4770: sub institutional_id_check {
4771: my ($cmd, $tail, $client) = @_;
4772: my $userinput = "$cmd:$tail";
4773: my %rulecheck;
4774: my $outcome;
4775: my ($udom,$id,@rules) = split(/:/,$tail);
4776: $udom = &unescape($udom);
4777: $id = &unescape($id);
4778: @rules = map {&unescape($_);} (@rules);
4779: eval {
4780: local($SIG{__DIE__})='DEFAULT';
4781: $outcome = &localenroll::id_check($udom,$id,\@rules,\%rulecheck);
4782: };
4783: if (!$@) {
4784: if ($outcome eq 'ok') {
4785: my $result='';
4786: foreach my $key (keys(%rulecheck)) {
4787: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
4788: }
4789: &Reply($client,\$result,$userinput);
4790: } else {
4791: &Reply($client,"error\n", $userinput);
4792: }
4793: } else {
4794: &Failure($client,"unknown_cmd\n",$userinput);
4795: }
4796: }
4797: ®ister_handler("instidrulecheck",\&institutional_id_check,0,1,0);
1.345 raeburn 4798:
1.396 ! raeburn 4799: sub institutional_selfenroll_check {
! 4800: my ($cmd, $tail, $client) = @_;
! 4801: my $userinput = "$cmd:$tail";
! 4802: my %rulecheck;
! 4803: my $outcome;
! 4804: my ($udom,$email,@rules) = split(/:/,$tail);
! 4805: $udom = &unescape($udom);
! 4806: $email = &unescape($email);
! 4807: @rules = map {&unescape($_);} (@rules);
! 4808: eval {
! 4809: local($SIG{__DIE__})='DEFAULT';
! 4810: $outcome = &localenroll::selfenroll_check($udom,$email,\@rules,\%rulecheck);
! 4811: };
! 4812: if (!$@) {
! 4813: if ($outcome eq 'ok') {
! 4814: my $result='';
! 4815: foreach my $key (keys(%rulecheck)) {
! 4816: $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
! 4817: }
! 4818: &Reply($client,\$result,$userinput);
! 4819: } else {
! 4820: &Reply($client,"error\n", $userinput);
! 4821: }
! 4822: } else {
! 4823: &Failure($client,"unknown_cmd\n",$userinput);
! 4824: }
! 4825: }
! 4826: ®ister_handler("instselfenrollcheck",\&institutional_selfenroll_check,0,1,0);
! 4827:
1.317 raeburn 4828: # Get domain specific conditions for import of student photographs to a course
4829: #
4830: # Retrieves information from photo_permission subroutine in localenroll.
4831: # Returns outcome (ok) if no processing errors, and whether course owner is
4832: # required to accept conditions of use (yes/no).
4833: #
4834: #
4835: sub photo_permission_handler {
4836: my ($cmd, $tail, $client) = @_;
4837: my $userinput = "$cmd:$tail";
4838: my $cdom = $tail;
4839: my ($perm_reqd,$conditions);
1.320 albertel 4840: my $outcome;
4841: eval {
4842: local($SIG{__DIE__})='DEFAULT';
4843: $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
4844: \$conditions);
4845: };
4846: if (!$@) {
4847: &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
4848: $userinput);
4849: } else {
4850: &Failure($client,"unknown_cmd\n",$userinput);
4851: }
4852: return 1;
1.317 raeburn 4853: }
4854: ®ister_handler("autophotopermission",\&photo_permission_handler,0,1,0);
4855:
4856: #
4857: # Checks if student photo is available for a user in the domain, in the user's
4858: # directory (in /userfiles/internal/studentphoto.jpg).
4859: # Uses localstudentphoto:fetch() to ensure there is an up to date copy of
4860: # the student's photo.
4861:
4862: sub photo_check_handler {
4863: my ($cmd, $tail, $client) = @_;
4864: my $userinput = "$cmd:$tail";
4865: my ($udom,$uname,$pid) = split(/:/,$tail);
4866: $udom = &unescape($udom);
4867: $uname = &unescape($uname);
4868: $pid = &unescape($pid);
4869: my $path=&propath($udom,$uname).'/userfiles/internal/';
4870: if (!-e $path) {
4871: &mkpath($path);
4872: }
4873: my $response;
4874: my $result = &localstudentphoto::fetch($udom,$uname,$pid,\$response);
4875: $result .= ':'.$response;
4876: &Reply($client, &escape($result)."\n",$userinput);
1.320 albertel 4877: return 1;
1.317 raeburn 4878: }
4879: ®ister_handler("autophotocheck",\&photo_check_handler,0,1,0);
4880:
4881: #
4882: # Retrieve information from localenroll about whether to provide a button
4883: # for users who have enbled import of student photos to initiate an
4884: # update of photo files for registered students. Also include
4885: # comment to display alongside button.
4886:
4887: sub photo_choice_handler {
4888: my ($cmd, $tail, $client) = @_;
4889: my $userinput = "$cmd:$tail";
4890: my $cdom = &unescape($tail);
1.320 albertel 4891: my ($update,$comment);
4892: eval {
4893: local($SIG{__DIE__})='DEFAULT';
4894: ($update,$comment) = &localenroll::manager_photo_update($cdom);
4895: };
4896: if (!$@) {
4897: &Reply($client,&escape($update).':'.&escape($comment)."\n",$userinput);
4898: } else {
4899: &Failure($client,"unknown_cmd\n",$userinput);
4900: }
4901: return 1;
1.317 raeburn 4902: }
4903: ®ister_handler("autophotochoice",\&photo_choice_handler,0,1,0);
4904:
1.265 albertel 4905: #
4906: # Gets a student's photo to exist (in the correct image type) in the user's
4907: # directory.
4908: # Formal Parameters:
4909: # $cmd - The command request that got us dispatched.
4910: # $tail - A colon separated set of words that will be split into:
4911: # $domain - student's domain
4912: # $uname - student username
4913: # $type - image type desired
4914: # $client - The socket open on the client.
4915: # Returns:
4916: # 1 - continue processing.
1.317 raeburn 4917:
1.265 albertel 4918: sub student_photo_handler {
4919: my ($cmd, $tail, $client) = @_;
1.317 raeburn 4920: my ($domain,$uname,$ext,$type) = split(/:/, $tail);
1.265 albertel 4921:
1.317 raeburn 4922: my $path=&propath($domain,$uname). '/userfiles/internal/';
4923: my $filename = 'studentphoto.'.$ext;
4924: if ($type eq 'thumbnail') {
4925: $filename = 'studentphoto_tn.'.$ext;
4926: }
4927: if (-e $path.$filename) {
1.265 albertel 4928: &Reply($client,"ok\n","$cmd:$tail");
4929: return 1;
4930: }
4931: &mkpath($path);
1.317 raeburn 4932: my $file;
4933: if ($type eq 'thumbnail') {
1.320 albertel 4934: eval {
4935: local($SIG{__DIE__})='DEFAULT';
4936: $file=&localstudentphoto::fetch_thumbnail($domain,$uname);
4937: };
1.317 raeburn 4938: } else {
4939: $file=&localstudentphoto::fetch($domain,$uname);
4940: }
1.265 albertel 4941: if (!$file) {
4942: &Failure($client,"unavailable\n","$cmd:$tail");
4943: return 1;
4944: }
1.317 raeburn 4945: if (!-e $path.$filename) { &convert_photo($file,$path.$filename); }
4946: if (-e $path.$filename) {
1.265 albertel 4947: &Reply($client,"ok\n","$cmd:$tail");
4948: return 1;
4949: }
4950: &Failure($client,"unable_to_convert\n","$cmd:$tail");
4951: return 1;
4952: }
4953: ®ister_handler("studentphoto", \&student_photo_handler, 0, 1, 0);
1.246 foxr 4954:
1.361 raeburn 4955: sub inst_usertypes_handler {
4956: my ($cmd, $domain, $client) = @_;
4957: my $res;
4958: my $userinput = $cmd.":".$domain; # For logging purposes.
1.370 albertel 4959: my (%typeshash,@order,$result);
4960: eval {
4961: local($SIG{__DIE__})='DEFAULT';
4962: $result=&localenroll::inst_usertypes($domain,\%typeshash,\@order);
4963: };
4964: if ($result eq 'ok') {
1.361 raeburn 4965: if (keys(%typeshash) > 0) {
4966: foreach my $key (keys(%typeshash)) {
4967: $res.=&escape($key).'='.&escape($typeshash{$key}).'&';
4968: }
4969: }
4970: $res=~s/\&$//;
4971: $res .= ':';
4972: if (@order > 0) {
4973: foreach my $item (@order) {
4974: $res .= &escape($item).'&';
4975: }
4976: }
4977: $res=~s/\&$//;
4978: }
1.387 albertel 4979: &Reply($client, \$res, $userinput);
1.361 raeburn 4980: return 1;
4981: }
4982: ®ister_handler("inst_usertypes", \&inst_usertypes_handler, 0, 1, 0);
4983:
1.264 albertel 4984: # mkpath makes all directories for a file, expects an absolute path with a
4985: # file or a trailing / if just a dir is passed
4986: # returns 1 on success 0 on failure
4987: sub mkpath {
4988: my ($file)=@_;
4989: my @parts=split(/\//,$file,-1);
4990: my $now=$parts[0].'/'.$parts[1].'/'.$parts[2];
4991: for (my $i=3;$i<= ($#parts-1);$i++) {
1.265 albertel 4992: $now.='/'.$parts[$i];
1.264 albertel 4993: if (!-e $now) {
4994: if (!mkdir($now,0770)) { return 0; }
4995: }
4996: }
4997: return 1;
4998: }
4999:
1.207 foxr 5000: #---------------------------------------------------------------
5001: #
5002: # Getting, decoding and dispatching requests:
5003: #
5004: #
5005: # Get a Request:
5006: # Gets a Request message from the client. The transaction
5007: # is defined as a 'line' of text. We remove the new line
5008: # from the text line.
1.226 foxr 5009: #
1.211 albertel 5010: sub get_request {
1.207 foxr 5011: my $input = <$client>;
5012: chomp($input);
1.226 foxr 5013:
1.234 foxr 5014: &Debug("get_request: Request = $input\n");
1.207 foxr 5015:
5016: &status('Processing '.$clientname.':'.$input);
5017:
5018: return $input;
5019: }
1.212 foxr 5020: #---------------------------------------------------------------
5021: #
5022: # Process a request. This sub should shrink as each action
5023: # gets farmed out into a separat sub that is registered
5024: # with the dispatch hash.
5025: #
5026: # Parameters:
5027: # user_input - The request received from the client (lonc).
5028: # Returns:
5029: # true to keep processing, false if caller should exit.
5030: #
5031: sub process_request {
5032: my ($userinput) = @_; # Easier for now to break style than to
5033: # fix all the userinput -> user_input.
5034: my $wasenc = 0; # True if request was encrypted.
5035: # ------------------------------------------------------------ See if encrypted
1.322 albertel 5036: # for command
5037: # sethost:<server>
5038: # <command>:<args>
5039: # we just send it to the processor
5040: # for
5041: # sethost:<server>:<command>:<args>
5042: # we do the implict set host and then do the command
5043: if ($userinput =~ /^sethost:/) {
5044: (my $cmd,my $newid,$userinput) = split(':',$userinput,3);
5045: if (defined($userinput)) {
5046: &sethost("$cmd:$newid");
5047: } else {
5048: $userinput = "$cmd:$newid";
5049: }
5050: }
5051:
1.212 foxr 5052: if ($userinput =~ /^enc/) {
5053: $userinput = decipher($userinput);
5054: $wasenc=1;
5055: if(!$userinput) { # Cipher not defined.
1.251 foxr 5056: &Failure($client, "error: Encrypted data without negotated key\n");
1.212 foxr 5057: return 0;
5058: }
5059: }
5060: Debug("process_request: $userinput\n");
5061:
1.213 foxr 5062: #
5063: # The 'correct way' to add a command to lond is now to
5064: # write a sub to execute it and Add it to the command dispatch
5065: # hash via a call to register_handler.. The comments to that
5066: # sub should give you enough to go on to show how to do this
5067: # along with the examples that are building up as this code
5068: # is getting refactored. Until all branches of the
5069: # if/elseif monster below have been factored out into
5070: # separate procesor subs, if the dispatch hash is missing
5071: # the command keyword, we will fall through to the remainder
5072: # of the if/else chain below in order to keep this thing in
5073: # working order throughout the transmogrification.
5074:
5075: my ($command, $tail) = split(/:/, $userinput, 2);
5076: chomp($command);
5077: chomp($tail);
5078: $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
1.214 foxr 5079: $command =~ s/(\r)//; # And this too for parameterless commands.
5080: if(!$tail) {
5081: $tail =""; # defined but blank.
5082: }
1.213 foxr 5083:
5084: &Debug("Command received: $command, encoded = $wasenc");
5085:
5086: if(defined $Dispatcher{$command}) {
5087:
5088: my $dispatch_info = $Dispatcher{$command};
5089: my $handler = $$dispatch_info[0];
5090: my $need_encode = $$dispatch_info[1];
5091: my $client_types = $$dispatch_info[2];
5092: Debug("Matched dispatch hash: mustencode: $need_encode "
5093: ."ClientType $client_types");
5094:
5095: # Validate the request:
5096:
5097: my $ok = 1;
5098: my $requesterprivs = 0;
5099: if(&isClient()) {
5100: $requesterprivs |= $CLIENT_OK;
5101: }
5102: if(&isManager()) {
5103: $requesterprivs |= $MANAGER_OK;
5104: }
5105: if($need_encode && (!$wasenc)) {
5106: Debug("Must encode but wasn't: $need_encode $wasenc");
5107: $ok = 0;
5108: }
5109: if(($client_types & $requesterprivs) == 0) {
5110: Debug("Client not privileged to do this operation");
5111: $ok = 0;
5112: }
5113:
5114: if($ok) {
5115: Debug("Dispatching to handler $command $tail");
5116: my $keep_going = &$handler($command, $tail, $client);
5117: return $keep_going;
5118: } else {
5119: Debug("Refusing to dispatch because client did not match requirements");
5120: Failure($client, "refused\n", $userinput);
5121: return 1;
5122: }
5123:
5124: }
5125:
1.262 foxr 5126: print $client "unknown_cmd\n";
1.212 foxr 5127: # -------------------------------------------------------------------- complete
5128: Debug("process_request - returning 1");
5129: return 1;
5130: }
1.207 foxr 5131: #
5132: # Decipher encoded traffic
5133: # Parameters:
5134: # input - Encoded data.
5135: # Returns:
5136: # Decoded data or undef if encryption key was not yet negotiated.
5137: # Implicit input:
5138: # cipher - This global holds the negotiated encryption key.
5139: #
1.211 albertel 5140: sub decipher {
1.207 foxr 5141: my ($input) = @_;
5142: my $output = '';
1.212 foxr 5143:
5144:
1.207 foxr 5145: if($cipher) {
5146: my($enc, $enclength, $encinput) = split(/:/, $input);
5147: for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
5148: $output .=
5149: $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
5150: }
5151: return substr($output, 0, $enclength);
5152: } else {
5153: return undef;
5154: }
5155: }
5156:
5157: #
5158: # Register a command processor. This function is invoked to register a sub
5159: # to process a request. Once registered, the ProcessRequest sub can automatically
5160: # dispatch requests to an appropriate sub, and do the top level validity checking
5161: # as well:
5162: # - Is the keyword recognized.
5163: # - Is the proper client type attempting the request.
5164: # - Is the request encrypted if it has to be.
5165: # Parameters:
5166: # $request_name - Name of the request being registered.
5167: # This is the command request that will match
5168: # against the hash keywords to lookup the information
5169: # associated with the dispatch information.
5170: # $procedure - Reference to a sub to call to process the request.
5171: # All subs get called as follows:
5172: # Procedure($cmd, $tail, $replyfd, $key)
5173: # $cmd - the actual keyword that invoked us.
5174: # $tail - the tail of the request that invoked us.
5175: # $replyfd- File descriptor connected to the client
5176: # $must_encode - True if the request must be encoded to be good.
5177: # $client_ok - True if it's ok for a client to request this.
5178: # $manager_ok - True if it's ok for a manager to request this.
5179: # Side effects:
5180: # - On success, the Dispatcher hash has an entry added for the key $RequestName
5181: # - On failure, the program will die as it's a bad internal bug to try to
5182: # register a duplicate command handler.
5183: #
1.211 albertel 5184: sub register_handler {
1.212 foxr 5185: my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
1.207 foxr 5186:
5187: # Don't allow duplication#
5188:
5189: if (defined $Dispatcher{$request_name}) {
5190: die "Attempting to define a duplicate request handler for $request_name\n";
5191: }
5192: # Build the client type mask:
5193:
5194: my $client_type_mask = 0;
5195: if($client_ok) {
5196: $client_type_mask |= $CLIENT_OK;
5197: }
5198: if($manager_ok) {
5199: $client_type_mask |= $MANAGER_OK;
5200: }
5201:
5202: # Enter the hash:
5203:
5204: my @entry = ($procedure, $must_encode, $client_type_mask);
5205:
5206: $Dispatcher{$request_name} = \@entry;
5207:
5208: }
5209:
5210:
5211: #------------------------------------------------------------------
5212:
5213:
5214:
5215:
1.141 foxr 5216: #
1.96 foxr 5217: # Convert an error return code from lcpasswd to a string value.
5218: #
5219: sub lcpasswdstrerror {
5220: my $ErrorCode = shift;
1.97 foxr 5221: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
1.96 foxr 5222: return "lcpasswd Unrecognized error return value ".$ErrorCode;
5223: } else {
1.98 foxr 5224: return $passwderrors[$ErrorCode];
1.96 foxr 5225: }
5226: }
5227:
1.97 foxr 5228: #
5229: # Convert an error return code from lcuseradd to a string value:
5230: #
5231: sub lcuseraddstrerror {
5232: my $ErrorCode = shift;
5233: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
5234: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
5235: } else {
1.98 foxr 5236: return $adderrors[$ErrorCode];
1.97 foxr 5237: }
5238: }
5239:
1.23 harris41 5240: # grabs exception and records it to log before exiting
5241: sub catchexception {
1.27 albertel 5242: my ($error)=@_;
1.25 www 5243: $SIG{'QUIT'}='DEFAULT';
5244: $SIG{__DIE__}='DEFAULT';
1.165 albertel 5245: &status("Catching exception");
1.190 albertel 5246: &logthis("<font color='red'>CRITICAL: "
1.373 albertel 5247: ."ABNORMAL EXIT. Child $$ for server ".$perlvar{'lonHostID'}." died through "
1.27 albertel 5248: ."a crash with this error msg->[$error]</font>");
1.57 www 5249: &logthis('Famous last words: '.$status.' - '.$lastlog);
1.27 albertel 5250: if ($client) { print $client "error: $error\n"; }
1.59 www 5251: $server->close();
1.27 albertel 5252: die($error);
1.23 harris41 5253: }
1.63 www 5254: sub timeout {
1.165 albertel 5255: &status("Handling Timeout");
1.190 albertel 5256: &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
1.63 www 5257: &catchexception('Timeout');
5258: }
1.22 harris41 5259: # -------------------------------- Set signal handlers to record abnormal exits
5260:
1.226 foxr 5261:
1.22 harris41 5262: $SIG{'QUIT'}=\&catchexception;
5263: $SIG{__DIE__}=\&catchexception;
5264:
1.81 matthew 5265: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
1.95 harris41 5266: &status("Read loncapa.conf and loncapa_apache.conf");
5267: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
1.141 foxr 5268: %perlvar=%{$perlvarref};
1.80 harris41 5269: undef $perlvarref;
1.19 www 5270:
1.35 harris41 5271: # ----------------------------- Make sure this process is running from user=www
5272: my $wwwid=getpwnam('www');
5273: if ($wwwid!=$<) {
1.134 albertel 5274: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
5275: my $subj="LON: $currenthostid User ID mismatch";
1.37 harris41 5276: system("echo 'User ID mismatch. lond must be run as user www.' |\
1.35 harris41 5277: mailto $emailto -s '$subj' > /dev/null");
5278: exit 1;
5279: }
5280:
1.19 www 5281: # --------------------------------------------- Check if other instance running
5282:
5283: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
5284:
5285: if (-e $pidfile) {
5286: my $lfh=IO::File->new("$pidfile");
5287: my $pide=<$lfh>;
5288: chomp($pide);
1.29 harris41 5289: if (kill 0 => $pide) { die "already running"; }
1.19 www 5290: }
1.1 albertel 5291:
5292: # ------------------------------------------------------------- Read hosts file
5293:
5294:
5295:
5296: # establish SERVER socket, bind and listen.
5297: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
5298: Type => SOCK_STREAM,
5299: Proto => 'tcp',
5300: Reuse => 1,
5301: Listen => 10 )
1.29 harris41 5302: or die "making socket: $@\n";
1.1 albertel 5303:
5304: # --------------------------------------------------------- Do global variables
5305:
5306: # global variables
5307:
1.134 albertel 5308: my %children = (); # keys are current child process IDs
1.1 albertel 5309:
5310: sub REAPER { # takes care of dead children
5311: $SIG{CHLD} = \&REAPER;
1.165 albertel 5312: &status("Handling child death");
1.178 foxr 5313: my $pid;
5314: do {
5315: $pid = waitpid(-1,&WNOHANG());
5316: if (defined($children{$pid})) {
5317: &logthis("Child $pid died");
5318: delete($children{$pid});
1.183 albertel 5319: } elsif ($pid > 0) {
1.178 foxr 5320: &logthis("Unknown Child $pid died");
5321: }
5322: } while ( $pid > 0 );
5323: foreach my $child (keys(%children)) {
5324: $pid = waitpid($child,&WNOHANG());
5325: if ($pid > 0) {
5326: &logthis("Child $child - $pid looks like we missed it's death");
5327: delete($children{$pid});
5328: }
1.176 albertel 5329: }
1.165 albertel 5330: &status("Finished Handling child death");
1.1 albertel 5331: }
5332:
5333: sub HUNTSMAN { # signal handler for SIGINT
1.165 albertel 5334: &status("Killing children (INT)");
1.1 albertel 5335: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
5336: kill 'INT' => keys %children;
1.59 www 5337: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.1 albertel 5338: my $execdir=$perlvar{'lonDaemons'};
5339: unlink("$execdir/logs/lond.pid");
1.190 albertel 5340: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
1.165 albertel 5341: &status("Done killing children");
1.1 albertel 5342: exit; # clean up with dignity
5343: }
5344:
5345: sub HUPSMAN { # signal handler for SIGHUP
5346: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1.165 albertel 5347: &status("Killing children for restart (HUP)");
1.1 albertel 5348: kill 'INT' => keys %children;
1.59 www 5349: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.190 albertel 5350: &logthis("<font color='red'>CRITICAL: Restarting</font>");
1.134 albertel 5351: my $execdir=$perlvar{'lonDaemons'};
1.30 harris41 5352: unlink("$execdir/logs/lond.pid");
1.165 albertel 5353: &status("Restarting self (HUP)");
1.1 albertel 5354: exec("$execdir/lond"); # here we go again
5355: }
5356:
1.144 foxr 5357: #
1.148 foxr 5358: # Reload the Apache daemon's state.
1.150 foxr 5359: # This is done by invoking /home/httpd/perl/apachereload
5360: # a setuid perl script that can be root for us to do this job.
1.148 foxr 5361: #
5362: sub ReloadApache {
1.150 foxr 5363: my $execdir = $perlvar{'lonDaemons'};
5364: my $script = $execdir."/apachereload";
5365: system($script);
1.148 foxr 5366: }
5367:
5368: #
1.144 foxr 5369: # Called in response to a USR2 signal.
5370: # - Reread hosts.tab
5371: # - All children connected to hosts that were removed from hosts.tab
5372: # are killed via SIGINT
5373: # - All children connected to previously existing hosts are sent SIGUSR1
5374: # - Our internal hosts hash is updated to reflect the new contents of
5375: # hosts.tab causing connections from hosts added to hosts.tab to
5376: # now be honored.
5377: #
5378: sub UpdateHosts {
1.165 albertel 5379: &status("Reload hosts.tab");
1.147 foxr 5380: logthis('<font color="blue"> Updating connections </font>');
1.148 foxr 5381: #
5382: # The %children hash has the set of IP's we currently have children
5383: # on. These need to be matched against records in the hosts.tab
5384: # Any ip's no longer in the table get killed off they correspond to
5385: # either dropped or changed hosts. Note that the re-read of the table
5386: # will take care of new and changed hosts as connections come into being.
5387:
1.371 albertel 5388: &Apache::lonnet::reset_hosts_info();
1.148 foxr 5389:
1.368 albertel 5390: foreach my $child (keys(%children)) {
1.148 foxr 5391: my $childip = $children{$child};
1.374 albertel 5392: if ($childip ne '127.0.0.1'
5393: && !defined(&Apache::lonnet::get_hosts_from_ip($childip))) {
1.149 foxr 5394: logthis('<font color="blue"> UpdateHosts killing child '
5395: ." $child for ip $childip </font>");
1.148 foxr 5396: kill('INT', $child);
1.149 foxr 5397: } else {
5398: logthis('<font color="green"> keeping child for ip '
5399: ." $childip (pid=$child) </font>");
1.148 foxr 5400: }
5401: }
5402: ReloadApache;
1.165 albertel 5403: &status("Finished reloading hosts.tab");
1.144 foxr 5404: }
5405:
1.148 foxr 5406:
1.57 www 5407: sub checkchildren {
1.165 albertel 5408: &status("Checking on the children (sending signals)");
1.57 www 5409: &initnewstatus();
5410: &logstatus();
5411: &logthis('Going to check on the children');
1.134 albertel 5412: my $docdir=$perlvar{'lonDocRoot'};
1.61 harris41 5413: foreach (sort keys %children) {
1.221 albertel 5414: #sleep 1;
1.57 www 5415: unless (kill 'USR1' => $_) {
5416: &logthis ('Child '.$_.' is dead');
5417: &logstatus($$.' is dead');
1.221 albertel 5418: delete($children{$_});
1.57 www 5419: }
1.61 harris41 5420: }
1.63 www 5421: sleep 5;
1.212 foxr 5422: $SIG{ALRM} = sub { Debug("timeout");
5423: die "timeout"; };
1.113 albertel 5424: $SIG{__DIE__} = 'DEFAULT';
1.165 albertel 5425: &status("Checking on the children (waiting for reports)");
1.63 www 5426: foreach (sort keys %children) {
5427: unless (-e "$docdir/lon-status/londchld/$_.txt") {
1.113 albertel 5428: eval {
5429: alarm(300);
1.63 www 5430: &logthis('Child '.$_.' did not respond');
1.67 albertel 5431: kill 9 => $_;
1.131 albertel 5432: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
5433: #$subj="LON: $currenthostid killed lond process $_";
5434: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
5435: #$execdir=$perlvar{'lonDaemons'};
5436: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
1.221 albertel 5437: delete($children{$_});
1.113 albertel 5438: alarm(0);
5439: }
1.63 www 5440: }
5441: }
1.113 albertel 5442: $SIG{ALRM} = 'DEFAULT';
1.155 albertel 5443: $SIG{__DIE__} = \&catchexception;
1.165 albertel 5444: &status("Finished checking children");
1.221 albertel 5445: &logthis('Finished Checking children');
1.57 www 5446: }
5447:
1.1 albertel 5448: # --------------------------------------------------------------------- Logging
5449:
5450: sub logthis {
5451: my $message=shift;
5452: my $execdir=$perlvar{'lonDaemons'};
5453: my $fh=IO::File->new(">>$execdir/logs/lond.log");
5454: my $now=time;
5455: my $local=localtime($now);
1.58 www 5456: $lastlog=$local.': '.$message;
1.1 albertel 5457: print $fh "$local ($$): $message\n";
5458: }
5459:
1.77 foxr 5460: # ------------------------- Conditional log if $DEBUG true.
5461: sub Debug {
5462: my $message = shift;
5463: if($DEBUG) {
5464: &logthis($message);
5465: }
5466: }
1.161 foxr 5467:
5468: #
5469: # Sub to do replies to client.. this gives a hook for some
5470: # debug tracing too:
5471: # Parameters:
5472: # fd - File open on client.
5473: # reply - Text to send to client.
5474: # request - Original request from client.
5475: #
5476: sub Reply {
1.192 foxr 5477: my ($fd, $reply, $request) = @_;
1.387 albertel 5478: if (ref($reply)) {
5479: print $fd $$reply;
5480: print $fd "\n";
5481: if ($DEBUG) { Debug("Request was $request Reply was $$reply"); }
5482: } else {
5483: print $fd $reply;
5484: if ($DEBUG) { Debug("Request was $request Reply was $reply"); }
5485: }
1.212 foxr 5486: $Transactions++;
5487: }
5488:
5489:
5490: #
5491: # Sub to report a failure.
5492: # This function:
5493: # - Increments the failure statistic counters.
5494: # - Invokes Reply to send the error message to the client.
5495: # Parameters:
5496: # fd - File descriptor open on the client
5497: # reply - Reply text to emit.
5498: # request - The original request message (used by Reply
5499: # to debug if that's enabled.
5500: # Implicit outputs:
5501: # $Failures- The number of failures is incremented.
5502: # Reply (invoked here) sends a message to the
5503: # client:
5504: #
5505: sub Failure {
5506: my $fd = shift;
5507: my $reply = shift;
5508: my $request = shift;
5509:
5510: $Failures++;
5511: Reply($fd, $reply, $request); # That's simple eh?
1.161 foxr 5512: }
1.57 www 5513: # ------------------------------------------------------------------ Log status
5514:
5515: sub logstatus {
1.178 foxr 5516: &status("Doing logging");
5517: my $docdir=$perlvar{'lonDocRoot'};
5518: {
5519: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
1.200 matthew 5520: print $fh $status."\n".$lastlog."\n".time."\n$keymode";
1.178 foxr 5521: $fh->close();
5522: }
1.221 albertel 5523: &status("Finished $$.txt");
5524: {
5525: open(LOG,">>$docdir/lon-status/londstatus.txt");
5526: flock(LOG,LOCK_EX);
5527: print LOG $$."\t".$clientname."\t".$currenthostid."\t"
5528: .$status."\t".$lastlog."\t $keymode\n";
1.275 albertel 5529: flock(LOG,LOCK_UN);
1.221 albertel 5530: close(LOG);
5531: }
1.178 foxr 5532: &status("Finished logging");
1.57 www 5533: }
5534:
5535: sub initnewstatus {
5536: my $docdir=$perlvar{'lonDocRoot'};
5537: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
5538: my $now=time;
5539: my $local=localtime($now);
5540: print $fh "LOND status $local - parent $$\n\n";
1.64 www 5541: opendir(DIR,"$docdir/lon-status/londchld");
1.134 albertel 5542: while (my $filename=readdir(DIR)) {
1.64 www 5543: unlink("$docdir/lon-status/londchld/$filename");
5544: }
5545: closedir(DIR);
1.57 www 5546: }
5547:
5548: # -------------------------------------------------------------- Status setting
5549:
5550: sub status {
5551: my $what=shift;
5552: my $now=time;
5553: my $local=localtime($now);
1.178 foxr 5554: $status=$local.': '.$what;
5555: $0='lond: '.$what.' '.$local;
1.57 www 5556: }
1.11 www 5557:
1.13 www 5558: # -------------------------------------------------------------- Talk to lonsql
5559:
1.234 foxr 5560: sub sql_reply {
1.12 harris41 5561: my ($cmd)=@_;
1.234 foxr 5562: my $answer=&sub_sql_reply($cmd);
5563: if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
1.12 harris41 5564: return $answer;
5565: }
5566:
1.234 foxr 5567: sub sub_sql_reply {
1.12 harris41 5568: my ($cmd)=@_;
5569: my $unixsock="mysqlsock";
5570: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
5571: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
5572: Type => SOCK_STREAM,
5573: Timeout => 10)
5574: or return "con_lost";
1.319 www 5575: print $sclient "$cmd:$currentdomainid\n";
1.12 harris41 5576: my $answer=<$sclient>;
5577: chomp($answer);
5578: if (!$answer) { $answer="con_lost"; }
5579: return $answer;
5580: }
5581:
1.1 albertel 5582: # --------------------------------------- Is this the home server of an author?
1.11 www 5583:
1.1 albertel 5584: sub ishome {
5585: my $author=shift;
5586: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
5587: my ($udom,$uname)=split(/\//,$author);
5588: my $proname=propath($udom,$uname);
5589: if (-e $proname) {
5590: return 'owner';
5591: } else {
5592: return 'not_owner';
5593: }
5594: }
5595:
5596: # ======================================================= Continue main program
5597: # ---------------------------------------------------- Fork once and dissociate
5598:
1.134 albertel 5599: my $fpid=fork;
1.1 albertel 5600: exit if $fpid;
1.29 harris41 5601: die "Couldn't fork: $!" unless defined ($fpid);
1.1 albertel 5602:
1.29 harris41 5603: POSIX::setsid() or die "Can't start new session: $!";
1.1 albertel 5604:
5605: # ------------------------------------------------------- Write our PID on disk
5606:
1.134 albertel 5607: my $execdir=$perlvar{'lonDaemons'};
1.1 albertel 5608: open (PIDSAVE,">$execdir/logs/lond.pid");
5609: print PIDSAVE "$$\n";
5610: close(PIDSAVE);
1.190 albertel 5611: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
1.57 www 5612: &status('Starting');
1.1 albertel 5613:
1.106 foxr 5614:
1.1 albertel 5615:
5616: # ----------------------------------------------------- Install signal handlers
5617:
1.57 www 5618:
1.1 albertel 5619: $SIG{CHLD} = \&REAPER;
5620: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
5621: $SIG{HUP} = \&HUPSMAN;
1.57 www 5622: $SIG{USR1} = \&checkchildren;
1.144 foxr 5623: $SIG{USR2} = \&UpdateHosts;
1.106 foxr 5624:
1.148 foxr 5625: # Read the host hashes:
1.368 albertel 5626: &Apache::lonnet::load_hosts_tab();
1.106 foxr 5627:
1.286 albertel 5628: my $dist=`$perlvar{'lonDaemons'}/distprobe`;
5629:
1.106 foxr 5630: # --------------------------------------------------------------
5631: # Accept connections. When a connection comes in, it is validated
5632: # and if good, a child process is created to process transactions
5633: # along the connection.
5634:
1.1 albertel 5635: while (1) {
1.165 albertel 5636: &status('Starting accept');
1.106 foxr 5637: $client = $server->accept() or next;
1.165 albertel 5638: &status('Accepted '.$client.' off to spawn');
1.386 albertel 5639: make_new_child($client);
1.165 albertel 5640: &status('Finished spawning');
1.1 albertel 5641: }
5642:
1.212 foxr 5643: sub make_new_child {
5644: my $pid;
5645: # my $cipher; # Now global
5646: my $sigset;
1.178 foxr 5647:
1.212 foxr 5648: $client = shift;
5649: &status('Starting new child '.$client);
5650: &logthis('<font color="green"> Attempting to start child ('.$client.
5651: ")</font>");
5652: # block signal for fork
5653: $sigset = POSIX::SigSet->new(SIGINT);
5654: sigprocmask(SIG_BLOCK, $sigset)
5655: or die "Can't block SIGINT for fork: $!\n";
1.178 foxr 5656:
1.212 foxr 5657: die "fork: $!" unless defined ($pid = fork);
1.178 foxr 5658:
1.212 foxr 5659: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
5660: # connection liveness.
1.178 foxr 5661:
1.212 foxr 5662: #
5663: # Figure out who we're talking to so we can record the peer in
5664: # the pid hash.
5665: #
5666: my $caller = getpeername($client);
5667: my ($port,$iaddr);
5668: if (defined($caller) && length($caller) > 0) {
5669: ($port,$iaddr)=unpack_sockaddr_in($caller);
5670: } else {
5671: &logthis("Unable to determine who caller was, getpeername returned nothing");
5672: }
5673: if (defined($iaddr)) {
5674: $clientip = inet_ntoa($iaddr);
5675: Debug("Connected with $clientip");
5676: } else {
5677: &logthis("Unable to determine clientip");
5678: $clientip='Unavailable';
5679: }
5680:
5681: if ($pid) {
5682: # Parent records the child's birth and returns.
5683: sigprocmask(SIG_UNBLOCK, $sigset)
5684: or die "Can't unblock SIGINT for fork: $!\n";
5685: $children{$pid} = $clientip;
5686: &status('Started child '.$pid);
5687: return;
5688: } else {
5689: # Child can *not* return from this subroutine.
5690: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
5691: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
5692: #don't get intercepted
5693: $SIG{USR1}= \&logstatus;
5694: $SIG{ALRM}= \&timeout;
5695: $lastlog='Forked ';
5696: $status='Forked';
1.178 foxr 5697:
1.212 foxr 5698: # unblock signals
5699: sigprocmask(SIG_UNBLOCK, $sigset)
5700: or die "Can't unblock SIGINT for fork: $!\n";
1.178 foxr 5701:
1.212 foxr 5702: # my $tmpsnum=0; # Now global
5703: #---------------------------------------------------- kerberos 5 initialization
5704: &Authen::Krb5::init_context();
1.359 raeburn 5705: unless (($dist eq 'fedora5') || ($dist eq 'fedora4') ||
5706: ($dist eq 'fedora6') || ($dist eq 'suse9.3')) {
1.286 albertel 5707: &Authen::Krb5::init_ets();
5708: }
1.209 albertel 5709:
1.212 foxr 5710: &status('Accepted connection');
5711: # =============================================================================
5712: # do something with the connection
5713: # -----------------------------------------------------------------------------
5714: # see if we know client and 'check' for spoof IP by ineffective challenge
1.178 foxr 5715:
1.278 albertel 5716: my $outsideip=$clientip;
5717: if ($clientip eq '127.0.0.1') {
1.368 albertel 5718: $outsideip=&Apache::lonnet::get_host_ip($perlvar{'lonHostID'});
1.278 albertel 5719: }
5720:
1.368 albertel 5721: my $clientrec=defined(&Apache::lonnet::get_hosts_from_ip($outsideip));
1.278 albertel 5722: my $ismanager=($managers{$outsideip} ne undef);
1.212 foxr 5723: $clientname = "[unknonwn]";
5724: if($clientrec) { # Establish client type.
5725: $ConnectionType = "client";
1.368 albertel 5726: $clientname = (&Apache::lonnet::get_hosts_from_ip($outsideip))[-1];
1.212 foxr 5727: if($ismanager) {
5728: $ConnectionType = "both";
5729: }
5730: } else {
5731: $ConnectionType = "manager";
1.278 albertel 5732: $clientname = $managers{$outsideip};
1.212 foxr 5733: }
5734: my $clientok;
1.178 foxr 5735:
1.212 foxr 5736: if ($clientrec || $ismanager) {
5737: &status("Waiting for init from $clientip $clientname");
5738: &logthis('<font color="yellow">INFO: Connection, '.
5739: $clientip.
5740: " ($clientname) connection type = $ConnectionType </font>" );
5741: &status("Connecting $clientip ($clientname))");
5742: my $remotereq=<$client>;
5743: chomp($remotereq);
5744: Debug("Got init: $remotereq");
1.337 albertel 5745:
1.212 foxr 5746: if ($remotereq =~ /^init/) {
5747: &sethost("sethost:$perlvar{'lonHostID'}");
5748: #
5749: # If the remote is attempting a local init... give that a try:
5750: #
5751: my ($i, $inittype) = split(/:/, $remotereq);
1.209 albertel 5752:
1.212 foxr 5753: # If the connection type is ssl, but I didn't get my
5754: # certificate files yet, then I'll drop back to
5755: # insecure (if allowed).
5756:
5757: if($inittype eq "ssl") {
5758: my ($ca, $cert) = lonssl::CertificateFile;
5759: my $kfile = lonssl::KeyFile;
5760: if((!$ca) ||
5761: (!$cert) ||
5762: (!$kfile)) {
5763: $inittype = ""; # This forces insecure attempt.
5764: &logthis("<font color=\"blue\"> Certificates not "
5765: ."installed -- trying insecure auth</font>");
1.224 foxr 5766: } else { # SSL certificates are in place so
1.212 foxr 5767: } # Leave the inittype alone.
5768: }
5769:
5770: if($inittype eq "local") {
5771: my $key = LocalConnection($client, $remotereq);
5772: if($key) {
5773: Debug("Got local key $key");
5774: $clientok = 1;
5775: my $cipherkey = pack("H32", $key);
5776: $cipher = new IDEA($cipherkey);
5777: print $client "ok:local\n";
5778: &logthis('<font color="green"'
5779: . "Successful local authentication </font>");
5780: $keymode = "local"
1.178 foxr 5781: } else {
1.212 foxr 5782: Debug("Failed to get local key");
5783: $clientok = 0;
5784: shutdown($client, 3);
5785: close $client;
1.178 foxr 5786: }
1.212 foxr 5787: } elsif ($inittype eq "ssl") {
5788: my $key = SSLConnection($client);
5789: if ($key) {
5790: $clientok = 1;
5791: my $cipherkey = pack("H32", $key);
5792: $cipher = new IDEA($cipherkey);
5793: &logthis('<font color="green">'
5794: ."Successfull ssl authentication with $clientname </font>");
5795: $keymode = "ssl";
5796:
1.178 foxr 5797: } else {
1.212 foxr 5798: $clientok = 0;
5799: close $client;
1.178 foxr 5800: }
1.212 foxr 5801:
5802: } else {
5803: my $ok = InsecureConnection($client);
5804: if($ok) {
5805: $clientok = 1;
5806: &logthis('<font color="green">'
5807: ."Successful insecure authentication with $clientname </font>");
5808: print $client "ok\n";
5809: $keymode = "insecure";
1.178 foxr 5810: } else {
1.212 foxr 5811: &logthis('<font color="yellow">'
5812: ."Attempted insecure connection disallowed </font>");
5813: close $client;
5814: $clientok = 0;
1.178 foxr 5815:
5816: }
5817: }
1.212 foxr 5818: } else {
5819: &logthis(
5820: "<font color='blue'>WARNING: "
5821: ."$clientip failed to initialize: >$remotereq< </font>");
5822: &status('No init '.$clientip);
5823: }
5824:
5825: } else {
5826: &logthis(
5827: "<font color='blue'>WARNING: Unknown client $clientip</font>");
5828: &status('Hung up on '.$clientip);
5829: }
5830:
5831: if ($clientok) {
5832: # ---------------- New known client connecting, could mean machine online again
1.368 albertel 5833: if (&Apache::lonnet::get_host_ip($currenthostid) ne $clientip
1.367 albertel 5834: && $clientip ne '127.0.0.1') {
1.375 albertel 5835: &Apache::lonnet::reconlonc($clientname);
1.212 foxr 5836: }
5837: &logthis("<font color='green'>Established connection: $clientname</font>");
5838: &status('Will listen to '.$clientname);
5839: # ------------------------------------------------------------ Process requests
5840: my $keep_going = 1;
5841: my $user_input;
5842: while(($user_input = get_request) && $keep_going) {
5843: alarm(120);
5844: Debug("Main: Got $user_input\n");
5845: $keep_going = &process_request($user_input);
1.178 foxr 5846: alarm(0);
1.212 foxr 5847: &status('Listening to '.$clientname." ($keymode)");
1.161 foxr 5848: }
1.212 foxr 5849:
1.59 www 5850: # --------------------------------------------- client unknown or fishy, refuse
1.212 foxr 5851: } else {
1.161 foxr 5852: print $client "refused\n";
5853: $client->close();
1.190 albertel 5854: &logthis("<font color='blue'>WARNING: "
1.161 foxr 5855: ."Rejected client $clientip, closing connection</font>");
5856: }
1.212 foxr 5857: }
1.161 foxr 5858:
1.1 albertel 5859: # =============================================================================
1.161 foxr 5860:
1.190 albertel 5861: &logthis("<font color='red'>CRITICAL: "
1.161 foxr 5862: ."Disconnect from $clientip ($clientname)</font>");
5863:
5864:
5865: # this exit is VERY important, otherwise the child will become
5866: # a producer of more and more children, forking yourself into
5867: # process death.
5868: exit;
1.106 foxr 5869:
1.78 foxr 5870: }
1.261 foxr 5871: #
5872: # Determine if a user is an author for the indicated domain.
5873: #
5874: # Parameters:
5875: # domain - domain to check in .
5876: # user - Name of user to check.
5877: #
5878: # Return:
5879: # 1 - User is an author for domain.
5880: # 0 - User is not an author for domain.
5881: sub is_author {
5882: my ($domain, $user) = @_;
5883:
5884: &Debug("is_author: $user @ $domain");
5885:
5886: my $hashref = &tie_user_hash($domain, $user, "roles",
5887: &GDBM_READER());
5888:
5889: # Author role should show up as a key /domain/_au
1.78 foxr 5890:
1.321 albertel 5891: my $key = "/$domain/_au";
5892: my $value;
5893: if (defined($hashref)) {
5894: $value = $hashref->{$key};
5895: }
1.78 foxr 5896:
1.261 foxr 5897: if(defined($value)) {
5898: &Debug("$user @ $domain is an author");
5899: }
5900:
5901: return defined($value);
5902: }
1.78 foxr 5903: #
5904: # Checks to see if the input roleput request was to set
5905: # an author role. If so, invokes the lchtmldir script to set
5906: # up a correct public_html
5907: # Parameters:
5908: # request - The request sent to the rolesput subchunk.
5909: # We're looking for /domain/_au
5910: # domain - The domain in which the user is having roles doctored.
5911: # user - Name of the user for which the role is being put.
5912: # authtype - The authentication type associated with the user.
5913: #
1.289 albertel 5914: sub manage_permissions {
1.192 foxr 5915: my ($request, $domain, $user, $authtype) = @_;
1.78 foxr 5916:
1.261 foxr 5917: &Debug("manage_permissions: $request $domain $user $authtype");
5918:
1.78 foxr 5919: # See if the request is of the form /$domain/_au
1.289 albertel 5920: if($request =~ /^(\/\Q$domain\E\/_au)$/) { # It's an author rolesput...
1.78 foxr 5921: my $execdir = $perlvar{'lonDaemons'};
5922: my $userhome= "/home/$user" ;
1.134 albertel 5923: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
1.261 foxr 5924: &Debug("Setting homedir permissions for $userhome");
1.78 foxr 5925: system("$execdir/lchtmldir $userhome $user $authtype");
5926: }
5927: }
1.222 foxr 5928:
5929:
5930: #
5931: # Return the full path of a user password file, whether it exists or not.
5932: # Parameters:
5933: # domain - Domain in which the password file lives.
5934: # user - name of the user.
5935: # Returns:
5936: # Full passwd path:
5937: #
5938: sub password_path {
5939: my ($domain, $user) = @_;
1.264 albertel 5940: return &propath($domain, $user).'/passwd';
1.222 foxr 5941: }
5942:
5943: # Password Filename
5944: # Returns the path to a passwd file given domain and user... only if
5945: # it exists.
5946: # Parameters:
5947: # domain - Domain in which to search.
5948: # user - username.
5949: # Returns:
5950: # - If the password file exists returns its path.
5951: # - If the password file does not exist, returns undefined.
5952: #
5953: sub password_filename {
5954: my ($domain, $user) = @_;
5955:
5956: Debug ("PasswordFilename called: dom = $domain user = $user");
5957:
5958: my $path = &password_path($domain, $user);
5959: Debug("PasswordFilename got path: $path");
5960: if(-e $path) {
5961: return $path;
5962: } else {
5963: return undef;
5964: }
5965: }
5966:
5967: #
5968: # Rewrite the contents of the user's passwd file.
5969: # Parameters:
5970: # domain - domain of the user.
5971: # name - User's name.
5972: # contents - New contents of the file.
5973: # Returns:
5974: # 0 - Failed.
5975: # 1 - Success.
5976: #
5977: sub rewrite_password_file {
5978: my ($domain, $user, $contents) = @_;
5979:
5980: my $file = &password_filename($domain, $user);
5981: if (defined $file) {
5982: my $pf = IO::File->new(">$file");
5983: if($pf) {
5984: print $pf "$contents\n";
5985: return 1;
5986: } else {
5987: return 0;
5988: }
5989: } else {
5990: return 0;
5991: }
5992:
5993: }
5994:
1.78 foxr 5995: #
1.222 foxr 5996: # get_auth_type - Determines the authorization type of a user in a domain.
1.78 foxr 5997:
5998: # Returns the authorization type or nouser if there is no such user.
5999: #
1.222 foxr 6000: sub get_auth_type
1.78 foxr 6001: {
1.192 foxr 6002:
6003: my ($domain, $user) = @_;
1.78 foxr 6004:
1.222 foxr 6005: Debug("get_auth_type( $domain, $user ) \n");
1.78 foxr 6006: my $proname = &propath($domain, $user);
6007: my $passwdfile = "$proname/passwd";
6008: if( -e $passwdfile ) {
6009: my $pf = IO::File->new($passwdfile);
6010: my $realpassword = <$pf>;
6011: chomp($realpassword);
1.79 foxr 6012: Debug("Password info = $realpassword\n");
1.78 foxr 6013: my ($authtype, $contentpwd) = split(/:/, $realpassword);
1.79 foxr 6014: Debug("Authtype = $authtype, content = $contentpwd\n");
1.259 raeburn 6015: return "$authtype:$contentpwd";
1.224 foxr 6016: } else {
1.79 foxr 6017: Debug("Returning nouser");
1.78 foxr 6018: return "nouser";
6019: }
1.1 albertel 6020: }
6021:
1.220 foxr 6022: #
6023: # Validate a user given their domain, name and password. This utility
6024: # function is used by both AuthenticateHandler and ChangePasswordHandler
6025: # to validate the login credentials of a user.
6026: # Parameters:
6027: # $domain - The domain being logged into (this is required due to
6028: # the capability for multihomed systems.
6029: # $user - The name of the user being validated.
6030: # $password - The user's propoposed password.
6031: #
6032: # Returns:
6033: # 1 - The domain,user,pasword triplet corresponds to a valid
6034: # user.
6035: # 0 - The domain,user,password triplet is not a valid user.
6036: #
6037: sub validate_user {
1.396 ! raeburn 6038: my ($domain, $user, $password, $checkdefauth) = @_;
1.220 foxr 6039:
6040: # Why negative ~pi you may well ask? Well this function is about
6041: # authentication, and therefore very important to get right.
6042: # I've initialized the flag that determines whether or not I've
6043: # validated correctly to a value it's not supposed to get.
6044: # At the end of this function. I'll ensure that it's not still that
6045: # value so we don't just wind up returning some accidental value
6046: # as a result of executing an unforseen code path that
1.249 foxr 6047: # did not set $validated. At the end of valid execution paths,
6048: # validated shoule be 1 for success or 0 for failuer.
1.220 foxr 6049:
6050: my $validated = -3.14159;
6051:
6052: # How we authenticate is determined by the type of authentication
6053: # the user has been assigned. If the authentication type is
6054: # "nouser", the user does not exist so we will return 0.
6055:
1.222 foxr 6056: my $contents = &get_auth_type($domain, $user);
1.220 foxr 6057: my ($howpwd, $contentpwd) = split(/:/, $contents);
6058:
6059: my $null = pack("C",0); # Used by kerberos auth types.
6060:
1.395 raeburn 6061: if ($howpwd eq 'nouser') {
1.396 ! raeburn 6062: if ($checkdefauth) {
! 6063: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
! 6064: if ($domdefaults{'auth_def'} eq 'localauth') {
! 6065: $howpwd = $domdefaults{'auth_def'};
! 6066: $contentpwd = $domdefaults{'auth_arg_def'};
! 6067: } elsif ((($domdefaults{'auth_def'} eq 'krb4') ||
! 6068: ($domdefaults{'auth_def'} eq 'krb5')) &&
! 6069: ($domdefaults{'auth_arg_def'} ne '')) {
! 6070: $howpwd = $domdefaults{'auth_def'};
! 6071: $contentpwd = $domdefaults{'auth_arg_def'};
! 6072: }
1.395 raeburn 6073: }
6074: }
1.220 foxr 6075: if ($howpwd ne 'nouser') {
6076: if($howpwd eq "internal") { # Encrypted is in local password file.
6077: $validated = (crypt($password, $contentpwd) eq $contentpwd);
6078: }
6079: elsif ($howpwd eq "unix") { # User is a normal unix user.
6080: $contentpwd = (getpwnam($user))[1];
6081: if($contentpwd) {
6082: if($contentpwd eq 'x') { # Shadow password file...
6083: my $pwauth_path = "/usr/local/sbin/pwauth";
6084: open PWAUTH, "|$pwauth_path" or
6085: die "Cannot invoke authentication";
6086: print PWAUTH "$user\n$password\n";
6087: close PWAUTH;
6088: $validated = ! $?;
6089:
6090: } else { # Passwords in /etc/passwd.
6091: $validated = (crypt($password,
6092: $contentpwd) eq $contentpwd);
6093: }
6094: } else {
6095: $validated = 0;
6096: }
6097: }
6098: elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
6099: if(! ($password =~ /$null/) ) {
6100: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
6101: "",
6102: $contentpwd,,
6103: 'krbtgt',
6104: $contentpwd,
6105: 1,
6106: $password);
6107: if(!$k4error) {
6108: $validated = 1;
1.224 foxr 6109: } else {
1.220 foxr 6110: $validated = 0;
6111: &logthis('krb4: '.$user.', '.$contentpwd.', '.
6112: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
6113: }
1.224 foxr 6114: } else {
1.220 foxr 6115: $validated = 0; # Password has a match with null.
6116: }
1.224 foxr 6117: } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
1.220 foxr 6118: if(!($password =~ /$null/)) { # Null password not allowed.
6119: my $krbclient = &Authen::Krb5::parse_name($user.'@'
6120: .$contentpwd);
6121: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
6122: my $krbserver = &Authen::Krb5::parse_name($krbservice);
6123: my $credentials= &Authen::Krb5::cc_default();
1.359 raeburn 6124: $credentials->initialize(&Authen::Krb5::parse_name($user.'@'
6125: .$contentpwd));
1.394 raeburn 6126: my $krbreturn;
6127: if (exists(&Authen::Krb5::get_init_creds_password)) {
6128: $krbreturn =
6129: &Authen::Krb5::get_init_creds_password($krbclient,$password,
6130: $krbservice);
6131: $validated = (ref($krbreturn) eq 'Authen::Krb5::Creds');
6132: } else {
6133: $krbreturn =
6134: &Authen::Krb5::get_in_tkt_with_password($krbclient,$krbserver,
6135: $password,$credentials);
6136: $validated = ($krbreturn == 1);
6137: }
1.380 albertel 6138: if (!$validated) {
6139: &logthis('krb5: '.$user.', '.$contentpwd.', '.
6140: &Authen::Krb5::error());
6141: }
1.224 foxr 6142: } else {
1.220 foxr 6143: $validated = 0;
6144: }
1.224 foxr 6145: } elsif ($howpwd eq "localauth") {
1.220 foxr 6146: # Authenticate via installation specific authentcation method:
6147: $validated = &localauth::localauth($user,
6148: $password,
1.353 albertel 6149: $contentpwd,
6150: $domain);
1.358 albertel 6151: if ($validated < 0) {
1.357 albertel 6152: &logthis("localauth for $contentpwd $user:$domain returned a $validated");
6153: $validated = 0;
6154: }
1.224 foxr 6155: } else { # Unrecognized auth is also bad.
1.220 foxr 6156: $validated = 0;
6157: }
6158: } else {
6159: $validated = 0;
6160: }
6161: #
6162: # $validated has the correct stat of the authentication:
6163: #
6164:
6165: unless ($validated != -3.14159) {
1.249 foxr 6166: # I >really really< want to know if this happens.
6167: # since it indicates that user authentication is badly
6168: # broken in some code path.
6169: #
6170: die "ValidateUser - failed to set the value of validated $domain, $user $password";
1.220 foxr 6171: }
6172: return $validated;
6173: }
6174:
6175:
1.84 albertel 6176: sub addline {
6177: my ($fname,$hostid,$ip,$newline)=@_;
6178: my $contents;
6179: my $found=0;
1.355 albertel 6180: my $expr='^'.quotemeta($hostid).':'.quotemeta($ip).':';
1.134 albertel 6181: my $sh;
1.84 albertel 6182: if ($sh=IO::File->new("$fname.subscription")) {
6183: while (my $subline=<$sh>) {
6184: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
6185: }
6186: $sh->close();
6187: }
6188: $sh=IO::File->new(">$fname.subscription");
6189: if ($contents) { print $sh $contents; }
6190: if ($newline) { print $sh $newline; }
6191: $sh->close();
6192: return $found;
1.86 www 6193: }
6194:
1.234 foxr 6195: sub get_chat {
1.324 raeburn 6196: my ($cdom,$cname,$udom,$uname,$group)=@_;
1.310 albertel 6197:
1.87 www 6198: my @entries=();
1.324 raeburn 6199: my $namespace = 'nohist_chatroom';
6200: my $namespace_inroom = 'nohist_inchatroom';
1.335 albertel 6201: if ($group ne '') {
1.324 raeburn 6202: $namespace .= '_'.$group;
6203: $namespace_inroom .= '_'.$group;
6204: }
6205: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
1.310 albertel 6206: &GDBM_READER());
6207: if ($hashref) {
6208: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
1.311 albertel 6209: &untie_user_hash($hashref);
1.123 www 6210: }
1.124 www 6211: my @participants=();
1.134 albertel 6212: my $cutoff=time-60;
1.324 raeburn 6213: $hashref = &tie_user_hash($cdom, $cname, $namespace_inroom,
1.310 albertel 6214: &GDBM_WRCREAT());
6215: if ($hashref) {
6216: $hashref->{$uname.':'.$udom}=time;
6217: foreach my $user (sort(keys(%$hashref))) {
6218: if ($hashref->{$user}>$cutoff) {
6219: push(@participants, 'active_participant:'.$user);
1.123 www 6220: }
6221: }
1.311 albertel 6222: &untie_user_hash($hashref);
1.86 www 6223: }
1.124 www 6224: return (@participants,@entries);
1.86 www 6225: }
6226:
1.234 foxr 6227: sub chat_add {
1.324 raeburn 6228: my ($cdom,$cname,$newchat,$group)=@_;
1.88 albertel 6229: my @entries=();
1.142 www 6230: my $time=time;
1.324 raeburn 6231: my $namespace = 'nohist_chatroom';
6232: my $logfile = 'chatroom.log';
1.335 albertel 6233: if ($group ne '') {
1.324 raeburn 6234: $namespace .= '_'.$group;
6235: $logfile = 'chatroom_'.$group.'.log';
6236: }
6237: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
1.310 albertel 6238: &GDBM_WRCREAT());
6239: if ($hashref) {
6240: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
1.88 albertel 6241: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
6242: my ($thentime,$idnum)=split(/\_/,$lastid);
6243: my $newid=$time.'_000000';
6244: if ($thentime==$time) {
6245: $idnum=~s/^0+//;
6246: $idnum++;
6247: $idnum=substr('000000'.$idnum,-6,6);
6248: $newid=$time.'_'.$idnum;
6249: }
1.310 albertel 6250: $hashref->{$newid}=$newchat;
1.88 albertel 6251: my $expired=$time-3600;
1.310 albertel 6252: foreach my $comment (keys(%$hashref)) {
6253: my ($thistime) = ($comment=~/(\d+)\_/);
1.88 albertel 6254: if ($thistime<$expired) {
1.310 albertel 6255: delete $hashref->{$comment};
1.88 albertel 6256: }
6257: }
1.310 albertel 6258: {
6259: my $proname=&propath($cdom,$cname);
1.324 raeburn 6260: if (open(CHATLOG,">>$proname/$logfile")) {
1.310 albertel 6261: print CHATLOG ("$time:".&unescape($newchat)."\n");
6262: }
6263: close(CHATLOG);
1.142 www 6264: }
1.311 albertel 6265: &untie_user_hash($hashref);
1.86 www 6266: }
1.84 albertel 6267: }
6268:
6269: sub unsub {
6270: my ($fname,$clientip)=@_;
6271: my $result;
1.188 foxr 6272: my $unsubs = 0; # Number of successful unsubscribes:
6273:
6274:
6275: # An old way subscriptions were handled was to have a
6276: # subscription marker file:
6277:
6278: Debug("Attempting unlink of $fname.$clientname");
1.161 foxr 6279: if (unlink("$fname.$clientname")) {
1.188 foxr 6280: $unsubs++; # Successful unsub via marker file.
6281: }
6282:
6283: # The more modern way to do it is to have a subscription list
6284: # file:
6285:
1.84 albertel 6286: if (-e "$fname.subscription") {
1.161 foxr 6287: my $found=&addline($fname,$clientname,$clientip,'');
1.188 foxr 6288: if ($found) {
6289: $unsubs++;
6290: }
6291: }
6292:
6293: # If either or both of these mechanisms succeeded in unsubscribing a
6294: # resource we can return ok:
6295:
6296: if($unsubs) {
6297: $result = "ok\n";
1.84 albertel 6298: } else {
1.188 foxr 6299: $result = "not_subscribed\n";
1.84 albertel 6300: }
1.188 foxr 6301:
1.84 albertel 6302: return $result;
6303: }
6304:
1.101 www 6305: sub currentversion {
6306: my $fname=shift;
6307: my $version=-1;
6308: my $ulsdir='';
6309: if ($fname=~/^(.+)\/[^\/]+$/) {
6310: $ulsdir=$1;
6311: }
1.114 albertel 6312: my ($fnamere1,$fnamere2);
6313: # remove version if already specified
1.101 www 6314: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
1.114 albertel 6315: # get the bits that go before and after the version number
6316: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
6317: $fnamere1=$1;
6318: $fnamere2='.'.$2;
6319: }
1.101 www 6320: if (-e $fname) { $version=1; }
6321: if (-e $ulsdir) {
1.134 albertel 6322: if(-d $ulsdir) {
6323: if (opendir(LSDIR,$ulsdir)) {
6324: my $ulsfn;
6325: while ($ulsfn=readdir(LSDIR)) {
1.101 www 6326: # see if this is a regular file (ignore links produced earlier)
1.134 albertel 6327: my $thisfile=$ulsdir.'/'.$ulsfn;
6328: unless (-l $thisfile) {
1.160 www 6329: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
1.134 albertel 6330: if ($1>$version) { $version=$1; }
6331: }
6332: }
6333: }
6334: closedir(LSDIR);
6335: $version++;
6336: }
6337: }
6338: }
6339: return $version;
1.101 www 6340: }
6341:
6342: sub thisversion {
6343: my $fname=shift;
6344: my $version=-1;
6345: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
6346: $version=$1;
6347: }
6348: return $version;
6349: }
6350:
1.84 albertel 6351: sub subscribe {
6352: my ($userinput,$clientip)=@_;
6353: my $result;
1.293 albertel 6354: my ($cmd,$fname)=split(/:/,$userinput,2);
1.84 albertel 6355: my $ownership=&ishome($fname);
6356: if ($ownership eq 'owner') {
1.101 www 6357: # explitly asking for the current version?
6358: unless (-e $fname) {
6359: my $currentversion=¤tversion($fname);
6360: if (&thisversion($fname)==$currentversion) {
6361: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
6362: my $root=$1;
6363: my $extension=$2;
6364: symlink($root.'.'.$extension,
6365: $root.'.'.$currentversion.'.'.$extension);
1.102 www 6366: unless ($extension=~/\.meta$/) {
6367: symlink($root.'.'.$extension.'.meta',
6368: $root.'.'.$currentversion.'.'.$extension.'.meta');
6369: }
1.101 www 6370: }
6371: }
6372: }
1.84 albertel 6373: if (-e $fname) {
6374: if (-d $fname) {
6375: $result="directory\n";
6376: } else {
1.161 foxr 6377: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
1.134 albertel 6378: my $now=time;
1.161 foxr 6379: my $found=&addline($fname,$clientname,$clientip,
6380: "$clientname:$clientip:$now\n");
1.84 albertel 6381: if ($found) { $result="$fname\n"; }
6382: # if they were subscribed to only meta data, delete that
6383: # subscription, when you subscribe to a file you also get
6384: # the metadata
6385: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
6386: $fname=~s/\/home\/httpd\/html\/res/raw/;
1.373 albertel 6387: $fname="http://".&Apache::lonnet::hostname($perlvar{'lonHostID'})."/".$fname;
1.84 albertel 6388: $result="$fname\n";
6389: }
6390: } else {
6391: $result="not_found\n";
6392: }
6393: } else {
6394: $result="rejected\n";
6395: }
6396: return $result;
6397: }
1.287 foxr 6398: # Change the passwd of a unix user. The caller must have
6399: # first verified that the user is a loncapa user.
6400: #
6401: # Parameters:
6402: # user - Unix user name to change.
6403: # pass - New password for the user.
6404: # Returns:
6405: # ok - if success
6406: # other - Some meaningfule error message string.
6407: # NOTE:
6408: # invokes a setuid script to change the passwd.
6409: sub change_unix_password {
6410: my ($user, $pass) = @_;
6411:
6412: &Debug("change_unix_password");
6413: my $execdir=$perlvar{'lonDaemons'};
6414: &Debug("Opening lcpasswd pipeline");
6415: my $pf = IO::File->new("|$execdir/lcpasswd > "
6416: ."$perlvar{'lonDaemons'}"
6417: ."/logs/lcpasswd.log");
6418: print $pf "$user\n$pass\n$pass\n";
6419: close $pf;
6420: my $err = $?;
6421: return ($err < @passwderrors) ? $passwderrors[$err] :
6422: "pwchange_falure - unknown error";
6423:
6424:
6425: }
6426:
1.91 albertel 6427:
6428: sub make_passwd_file {
1.98 foxr 6429: my ($uname, $umode,$npass,$passfilename)=@_;
1.390 raeburn 6430: my $result="ok";
1.91 albertel 6431: if ($umode eq 'krb4' or $umode eq 'krb5') {
6432: {
6433: my $pf = IO::File->new(">$passfilename");
1.261 foxr 6434: if ($pf) {
6435: print $pf "$umode:$npass\n";
6436: } else {
6437: $result = "pass_file_failed_error";
6438: }
1.91 albertel 6439: }
6440: } elsif ($umode eq 'internal') {
6441: my $salt=time;
6442: $salt=substr($salt,6,2);
6443: my $ncpass=crypt($npass,$salt);
6444: {
6445: &Debug("Creating internal auth");
6446: my $pf = IO::File->new(">$passfilename");
1.261 foxr 6447: if($pf) {
6448: print $pf "internal:$ncpass\n";
6449: } else {
6450: $result = "pass_file_failed_error";
6451: }
1.91 albertel 6452: }
6453: } elsif ($umode eq 'localauth') {
6454: {
6455: my $pf = IO::File->new(">$passfilename");
1.261 foxr 6456: if($pf) {
6457: print $pf "localauth:$npass\n";
6458: } else {
6459: $result = "pass_file_failed_error";
6460: }
1.91 albertel 6461: }
6462: } elsif ($umode eq 'unix') {
6463: {
1.186 foxr 6464: #
6465: # Don't allow the creation of privileged accounts!!! that would
6466: # be real bad!!!
6467: #
6468: my $uid = getpwnam($uname);
6469: if((defined $uid) && ($uid == 0)) {
6470: &logthis(">>>Attempted to create privilged account blocked");
6471: return "no_priv_account_error\n";
6472: }
6473:
1.223 foxr 6474: my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
1.224 foxr 6475:
6476: my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
1.91 albertel 6477: {
6478: &Debug("Executing external: ".$execpath);
1.98 foxr 6479: &Debug("user = ".$uname.", Password =". $npass);
1.132 matthew 6480: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
1.91 albertel 6481: print $se "$uname\n";
6482: print $se "$npass\n";
6483: print $se "$npass\n";
1.223 foxr 6484: print $se "$lc_error_file\n"; # Status -> unique file.
1.97 foxr 6485: }
1.285 foxr 6486: if (-r $lc_error_file) {
6487: &Debug("Opening error file: $lc_error_file");
6488: my $error = IO::File->new("< $lc_error_file");
6489: my $useraddok = <$error>;
6490: $error->close;
6491: unlink($lc_error_file);
6492:
6493: chomp $useraddok;
6494:
6495: if($useraddok > 0) {
6496: my $error_text = &lcuseraddstrerror($useraddok);
6497: &logthis("Failed lcuseradd: $error_text");
1.390 raeburn 6498: $result = "lcuseradd_failed:$error_text";
1.285 foxr 6499: } else {
6500: my $pf = IO::File->new(">$passfilename");
6501: if($pf) {
6502: print $pf "unix:\n";
6503: } else {
6504: $result = "pass_file_failed_error";
6505: }
6506: }
1.224 foxr 6507: } else {
1.285 foxr 6508: &Debug("Could not locate lcuseradd error: $lc_error_file");
6509: $result="bug_lcuseradd_no_output_file";
1.91 albertel 6510: }
6511: }
6512: } elsif ($umode eq 'none') {
6513: {
1.223 foxr 6514: my $pf = IO::File->new("> $passfilename");
1.261 foxr 6515: if($pf) {
6516: print $pf "none:\n";
6517: } else {
6518: $result = "pass_file_failed_error";
6519: }
1.91 albertel 6520: }
6521: } else {
1.390 raeburn 6522: $result="auth_mode_error";
1.91 albertel 6523: }
6524: return $result;
1.121 albertel 6525: }
6526:
1.265 albertel 6527: sub convert_photo {
6528: my ($start,$dest)=@_;
6529: system("convert $start $dest");
6530: }
6531:
1.121 albertel 6532: sub sethost {
6533: my ($remotereq) = @_;
6534: my (undef,$hostid)=split(/:/,$remotereq);
1.322 albertel 6535: # ignore sethost if we are already correct
6536: if ($hostid eq $currenthostid) {
6537: return 'ok';
6538: }
6539:
1.121 albertel 6540: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
1.368 albertel 6541: if (&Apache::lonnet::get_host_ip($perlvar{'lonHostID'})
6542: eq &Apache::lonnet::get_host_ip($hostid)) {
1.200 matthew 6543: $currenthostid =$hostid;
1.369 albertel 6544: $currentdomainid=&Apache::lonnet::host_domain($hostid);
1.386 albertel 6545: &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
1.121 albertel 6546: } else {
6547: &logthis("Requested host id $hostid not an alias of ".
6548: $perlvar{'lonHostID'}." refusing connection");
6549: return 'unable_to_set';
6550: }
6551: return 'ok';
6552: }
6553:
6554: sub version {
6555: my ($userinput)=@_;
6556: $remoteVERSION=(split(/:/,$userinput))[1];
6557: return "version:$VERSION";
1.127 albertel 6558: }
1.178 foxr 6559:
1.200 matthew 6560:
1.61 harris41 6561: # ----------------------------------- POD (plain old documentation, CPAN style)
6562:
6563: =head1 NAME
6564:
6565: lond - "LON Daemon" Server (port "LOND" 5663)
6566:
6567: =head1 SYNOPSIS
6568:
1.74 harris41 6569: Usage: B<lond>
6570:
6571: Should only be run as user=www. This is a command-line script which
6572: is invoked by B<loncron>. There is no expectation that a typical user
6573: will manually start B<lond> from the command-line. (In other words,
6574: DO NOT START B<lond> YOURSELF.)
1.61 harris41 6575:
6576: =head1 DESCRIPTION
6577:
1.74 harris41 6578: There are two characteristics associated with the running of B<lond>,
6579: PROCESS MANAGEMENT (starting, stopping, handling child processes)
6580: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
6581: subscriptions, etc). These are described in two large
6582: sections below.
6583:
6584: B<PROCESS MANAGEMENT>
6585:
1.61 harris41 6586: Preforker - server who forks first. Runs as a daemon. HUPs.
6587: Uses IDEA encryption
6588:
1.74 harris41 6589: B<lond> forks off children processes that correspond to the other servers
6590: in the network. Management of these processes can be done at the
6591: parent process level or the child process level.
6592:
6593: B<logs/lond.log> is the location of log messages.
6594:
6595: The process management is now explained in terms of linux shell commands,
6596: subroutines internal to this code, and signal assignments:
6597:
6598: =over 4
6599:
6600: =item *
6601:
6602: PID is stored in B<logs/lond.pid>
6603:
6604: This is the process id number of the parent B<lond> process.
6605:
6606: =item *
6607:
6608: SIGTERM and SIGINT
6609:
6610: Parent signal assignment:
6611: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
6612:
6613: Child signal assignment:
6614: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
6615: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
6616: to restart a new child.)
6617:
6618: Command-line invocations:
6619: B<kill> B<-s> SIGTERM I<PID>
6620: B<kill> B<-s> SIGINT I<PID>
6621:
6622: Subroutine B<HUNTSMAN>:
6623: This is only invoked for the B<lond> parent I<PID>.
6624: This kills all the children, and then the parent.
6625: The B<lonc.pid> file is cleared.
6626:
6627: =item *
6628:
6629: SIGHUP
6630:
6631: Current bug:
6632: This signal can only be processed the first time
6633: on the parent process. Subsequent SIGHUP signals
6634: have no effect.
6635:
6636: Parent signal assignment:
6637: $SIG{HUP} = \&HUPSMAN;
6638:
6639: Child signal assignment:
6640: none (nothing happens)
6641:
6642: Command-line invocations:
6643: B<kill> B<-s> SIGHUP I<PID>
6644:
6645: Subroutine B<HUPSMAN>:
6646: This is only invoked for the B<lond> parent I<PID>,
6647: This kills all the children, and then the parent.
6648: The B<lond.pid> file is cleared.
6649:
6650: =item *
6651:
6652: SIGUSR1
6653:
6654: Parent signal assignment:
6655: $SIG{USR1} = \&USRMAN;
6656:
6657: Child signal assignment:
6658: $SIG{USR1}= \&logstatus;
6659:
6660: Command-line invocations:
6661: B<kill> B<-s> SIGUSR1 I<PID>
6662:
6663: Subroutine B<USRMAN>:
6664: When invoked for the B<lond> parent I<PID>,
6665: SIGUSR1 is sent to all the children, and the status of
6666: each connection is logged.
1.144 foxr 6667:
6668: =item *
6669:
6670: SIGUSR2
6671:
6672: Parent Signal assignment:
6673: $SIG{USR2} = \&UpdateHosts
6674:
6675: Child signal assignment:
6676: NONE
6677:
1.74 harris41 6678:
6679: =item *
6680:
6681: SIGCHLD
6682:
6683: Parent signal assignment:
6684: $SIG{CHLD} = \&REAPER;
6685:
6686: Child signal assignment:
6687: none
6688:
6689: Command-line invocations:
6690: B<kill> B<-s> SIGCHLD I<PID>
6691:
6692: Subroutine B<REAPER>:
6693: This is only invoked for the B<lond> parent I<PID>.
6694: Information pertaining to the child is removed.
6695: The socket port is cleaned up.
6696:
6697: =back
6698:
6699: B<SERVER-SIDE ACTIVITIES>
6700:
6701: Server-side information can be accepted in an encrypted or non-encrypted
6702: method.
6703:
6704: =over 4
6705:
6706: =item ping
6707:
6708: Query a client in the hosts.tab table; "Are you there?"
6709:
6710: =item pong
6711:
6712: Respond to a ping query.
6713:
6714: =item ekey
6715:
6716: Read in encrypted key, make cipher. Respond with a buildkey.
6717:
6718: =item load
6719:
6720: Respond with CPU load based on a computation upon /proc/loadavg.
6721:
6722: =item currentauth
6723:
6724: Reply with current authentication information (only over an
6725: encrypted channel).
6726:
6727: =item auth
6728:
6729: Only over an encrypted channel, reply as to whether a user's
6730: authentication information can be validated.
6731:
6732: =item passwd
6733:
6734: Allow for a password to be set.
6735:
6736: =item makeuser
6737:
6738: Make a user.
6739:
6740: =item passwd
6741:
6742: Allow for authentication mechanism and password to be changed.
6743:
6744: =item home
1.61 harris41 6745:
1.74 harris41 6746: Respond to a question "are you the home for a given user?"
6747:
6748: =item update
6749:
6750: Update contents of a subscribed resource.
6751:
6752: =item unsubscribe
6753:
6754: The server is unsubscribing from a resource.
6755:
6756: =item subscribe
6757:
6758: The server is subscribing to a resource.
6759:
6760: =item log
6761:
6762: Place in B<logs/lond.log>
6763:
6764: =item put
6765:
6766: stores hash in namespace
6767:
1.230 foxr 6768: =item rolesputy
1.74 harris41 6769:
6770: put a role into a user's environment
6771:
6772: =item get
6773:
6774: returns hash with keys from array
6775: reference filled in from namespace
6776:
6777: =item eget
6778:
6779: returns hash with keys from array
6780: reference filled in from namesp (encrypts the return communication)
6781:
6782: =item rolesget
6783:
6784: get a role from a user's environment
6785:
6786: =item del
6787:
6788: deletes keys out of array from namespace
6789:
6790: =item keys
6791:
6792: returns namespace keys
6793:
6794: =item dump
6795:
6796: dumps the complete (or key matching regexp) namespace into a hash
6797:
6798: =item store
6799:
6800: stores hash permanently
6801: for this url; hashref needs to be given and should be a \%hashname; the
6802: remaining args aren't required and if they aren't passed or are '' they will
6803: be derived from the ENV
6804:
6805: =item restore
6806:
6807: returns a hash for a given url
6808:
6809: =item querysend
6810:
6811: Tells client about the lonsql process that has been launched in response
6812: to a sent query.
6813:
6814: =item queryreply
6815:
6816: Accept information from lonsql and make appropriate storage in temporary
6817: file space.
6818:
6819: =item idput
6820:
6821: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
6822: for each student, defined perhaps by the institutional Registrar.)
6823:
6824: =item idget
6825:
6826: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
6827: for each student, defined perhaps by the institutional Registrar.)
6828:
6829: =item tmpput
6830:
6831: Accept and store information in temporary space.
6832:
6833: =item tmpget
6834:
6835: Send along temporarily stored information.
6836:
6837: =item ls
6838:
6839: List part of a user's directory.
6840:
1.135 foxr 6841: =item pushtable
6842:
6843: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
6844: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
6845: must be restored manually in case of a problem with the new table file.
6846: pushtable requires that the request be encrypted and validated via
6847: ValidateManager. The form of the command is:
6848: enc:pushtable tablename <tablecontents> \n
6849: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
6850: cleartext newline.
6851:
1.74 harris41 6852: =item Hanging up (exit or init)
6853:
6854: What to do when a client tells the server that they (the client)
6855: are leaving the network.
6856:
6857: =item unknown command
6858:
6859: If B<lond> is sent an unknown command (not in the list above),
6860: it replys to the client "unknown_cmd".
1.135 foxr 6861:
1.74 harris41 6862:
6863: =item UNKNOWN CLIENT
6864:
6865: If the anti-spoofing algorithm cannot verify the client,
6866: the client is rejected (with a "refused" message sent
6867: to the client, and the connection is closed.
6868:
6869: =back
1.61 harris41 6870:
6871: =head1 PREREQUISITES
6872:
6873: IO::Socket
6874: IO::File
6875: Apache::File
6876: POSIX
6877: Crypt::IDEA
6878: LWP::UserAgent()
6879: GDBM_File
6880: Authen::Krb4
1.91 albertel 6881: Authen::Krb5
1.61 harris41 6882:
6883: =head1 COREQUISITES
6884:
6885: =head1 OSNAMES
6886:
6887: linux
6888:
6889: =head1 SCRIPT CATEGORIES
6890:
6891: Server/Process
6892:
6893: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>