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