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