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