Annotation of loncom/lond, revision 1.516

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>