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