Annotation of loncom/lond, revision 1.489.2.26

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

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