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