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