--- loncom/lond 2004/03/22 09:41:53 1.178.2.11
+++ loncom/lond 2010/07/26 21:52:10 1.450
@@ -2,7 +2,7 @@
# The LearningOnline Network
# lond "LON Daemon" Server (port "LOND" 5663)
#
-# $Id: lond,v 1.178.2.11 2004/03/22 09:41:53 foxr Exp $
+# $Id: lond,v 1.450 2010/07/26 21:52:10 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -20,7 +20,7 @@
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
@@ -31,42 +31,51 @@
use strict;
use lib '/home/httpd/lib/perl/';
+use LONCAPA;
use LONCAPA::Configuration;
use IO::Socket;
use IO::File;
#use Apache::File;
-use Symbol;
use POSIX;
use Crypt::IDEA;
use LWP::UserAgent();
+use Digest::MD5 qw(md5_hex);
use GDBM_File;
-use Authen::Krb4;
use Authen::Krb5;
-use lib '/home/httpd/lib/perl/';
use localauth;
+use localenroll;
+use localstudentphoto;
use File::Copy;
-use LONCAPA::ConfigFileEdit;
+use File::Find;
+use LONCAPA::lonlocal;
+use LONCAPA::lonssl;
+use Fcntl qw(:flock);
+use Apache::lonnet;
-my $DEBUG = 1; # Non zero to enable debug log entries.
+my $DEBUG = 0; # Non zero to enable debug log entries.
my $status='';
my $lastlog='';
-my $VERSION='$Revision: 1.178.2.11 $'; #' stupid emacs
+my $VERSION='$Revision: 1.450 $'; #' stupid emacs
my $remoteVERSION;
-my $currenthostid;
+my $currenthostid="default";
my $currentdomainid;
my $client;
-my $clientip;
-my $clientname;
-
-my $cipher; # Cipher key negotiated with client.
-my $tmpsnum = 0;; # Id of tmpputs.
+my $clientip; # IP address of client.
+my $clientname; # LonCAPA name of client.
+my $clientversion; # LonCAPA version running on client.
+my $clienthomedom; # LonCAPA domain of homeID for client.
+ # primary library server.
my $server;
-my $thisserver;
+
+my $keymode;
+
+my $cipher; # Cipher key negotiated with client
+my $tmpsnum = 0; # Id of tmpputs.
#
# Connection type is:
@@ -77,10 +86,6 @@ my $thisserver;
my $ConnectionType;
-my %hostid;
-my %hostdom;
-my %hostip;
-
my %managers; # Ip -> manager names
my %perlvar; # Will have the apache conf defined perl vars.
@@ -98,23 +103,26 @@ my $CLIENT_OK = 1;
my $MANAGER_OK = 2;
my %Dispatcher;
+
#
# The array below are password error strings."
#
my $lastpwderror = 13; # Largest error number from lcpasswd.
my @passwderrors = ("ok",
- "lcpasswd must be run as user 'www'",
- "lcpasswd got incorrect number of arguments",
- "lcpasswd did not get the right nubmer of input text lines",
- "lcpasswd too many simultaneous pwd changes in progress",
- "lcpasswd User does not exist.",
- "lcpasswd Incorrect current passwd",
- "lcpasswd Unable to su to root.",
- "lcpasswd Cannot set new passwd.",
- "lcpasswd Username has invalid characters",
- "lcpasswd Invalid characters in password",
- "11", "12",
- "lcpasswd Password mismatch");
+ "pwchange_failure - lcpasswd must be run as user 'www'",
+ "pwchange_failure - lcpasswd got incorrect number of arguments",
+ "pwchange_failure - lcpasswd did not get the right nubmer of input text lines",
+ "pwchange_failure - lcpasswd too many simultaneous pwd changes in progress",
+ "pwchange_failure - lcpasswd User does not exist.",
+ "pwchange_failure - lcpasswd Incorrect current passwd",
+ "pwchange_failure - lcpasswd Unable to su to root.",
+ "pwchange_failure - lcpasswd Cannot set new passwd.",
+ "pwchange_failure - lcpasswd Username has invalid characters",
+ "pwchange_failure - lcpasswd Invalid characters in password",
+ "pwchange_failure - lcpasswd User already exists",
+ "pwchange_failure - lcpasswd Something went wrong with user addition.",
+ "pwchange_failure - lcpasswd Password mismatch",
+ "pwchange_failure - lcpasswd Error filename is invalid");
# The array below are lcuseradd error strings.:
@@ -129,17 +137,29 @@ my @adderrors = ("ok",
"lcuseradd Unable to make www member of users's group",
"lcuseradd Unable to su to root",
"lcuseradd Unable to set password",
- "lcuseradd Usrname has invalid characters",
+ "lcuseradd Username has invalid characters",
"lcuseradd Password has an invalid character",
"lcuseradd User already exists",
"lcuseradd Could not add user.",
"lcuseradd Password mismatch");
+
+# This array are the errors from lcinstallfile:
+
+my @installerrors = ("ok",
+ "Initial user id of client not that of www",
+ "Usage error, not enough command line arguments",
+ "Source file name does not exist",
+ "Destination file name does not exist",
+ "Some file operation failed",
+ "Invalid table filename."
+ );
+
#
# Statistics that are maintained and dislayed in the status line.
#
-my $Transactions; # Number of attempted transactions.
-my $Failures; # Number of transcations failed.
+my $Transactions = 0; # Number of attempted transactions.
+my $Failures = 0; # Number of transcations failed.
# ResetStatistics:
# Resets the statistics counters:
@@ -149,6 +169,224 @@ sub ResetStatistics {
$Failures = 0;
}
+#------------------------------------------------------------------------
+#
+# LocalConnection
+# Completes the formation of a locally authenticated connection.
+# This function will ensure that the 'remote' client is really the
+# local host. If not, the connection is closed, and the function fails.
+# If so, initcmd is parsed for the name of a file containing the
+# IDEA session key. The fie is opened, read, deleted and the session
+# key returned to the caller.
+#
+# Parameters:
+# $Socket - Socket open on client.
+# $initcmd - The full text of the init command.
+#
+# Returns:
+# IDEA session key on success.
+# undef on failure.
+#
+sub LocalConnection {
+ my ($Socket, $initcmd) = @_;
+ Debug("Attempting local connection: $initcmd client: $clientip");
+ if($clientip ne "127.0.0.1") {
+ &logthis('<font color="red"> LocalConnection rejecting non local: '
+ ."$clientip ne 127.0.0.1 </font>");
+ close $Socket;
+ return undef;
+ } else {
+ chomp($initcmd); # Get rid of \n in filename.
+ my ($init, $type, $name) = split(/:/, $initcmd);
+ Debug(" Init command: $init $type $name ");
+
+ # Require that $init = init, and $type = local: Otherwise
+ # the caller is insane:
+
+ if(($init ne "init") && ($type ne "local")) {
+ &logthis('<font color = "red"> LocalConnection: caller is insane! '
+ ."init = $init, and type = $type </font>");
+ close($Socket);;
+ return undef;
+
+ }
+ # Now get the key filename:
+
+ my $IDEAKey = lonlocal::ReadKeyFile($name);
+ return $IDEAKey;
+ }
+}
+#------------------------------------------------------------------------------
+#
+# SSLConnection
+# Completes the formation of an ssh authenticated connection. The
+# socket is promoted to an ssl socket. If this promotion and the associated
+# certificate exchange are successful, the IDEA key is generated and sent
+# to the remote peer via the SSL tunnel. The IDEA key is also returned to
+# the caller after the SSL tunnel is torn down.
+#
+# Parameters:
+# Name Type Purpose
+# $Socket IO::Socket::INET Plaintext socket.
+#
+# Returns:
+# IDEA key on success.
+# undef on failure.
+#
+sub SSLConnection {
+ my $Socket = shift;
+
+ Debug("SSLConnection: ");
+ my $KeyFile = lonssl::KeyFile();
+ if(!$KeyFile) {
+ my $err = lonssl::LastError();
+ &logthis("<font color=\"red\"> CRITICAL"
+ ."Can't get key file $err </font>");
+ return undef;
+ }
+ my ($CACertificate,
+ $Certificate) = lonssl::CertificateFile();
+
+
+ # If any of the key, certificate or certificate authority
+ # certificate filenames are not defined, this can't work.
+
+ if((!$Certificate) || (!$CACertificate)) {
+ my $err = lonssl::LastError();
+ &logthis("<font color=\"red\"> CRITICAL"
+ ."Can't get certificates: $err </font>");
+
+ return undef;
+ }
+ Debug("Key: $KeyFile CA: $CACertificate Cert: $Certificate");
+
+ # Indicate to our peer that we can procede with
+ # a transition to ssl authentication:
+
+ print $Socket "ok:ssl\n";
+
+ Debug("Approving promotion -> ssl");
+ # And do so:
+
+ my $SSLSocket = lonssl::PromoteServerSocket($Socket,
+ $CACertificate,
+ $Certificate,
+ $KeyFile);
+ if(! ($SSLSocket) ) { # SSL socket promotion failed.
+ my $err = lonssl::LastError();
+ &logthis("<font color=\"red\"> CRITICAL "
+ ."SSL Socket promotion failed: $err </font>");
+ return undef;
+ }
+ Debug("SSL Promotion successful");
+
+ #
+ # The only thing we'll use the socket for is to send the IDEA key
+ # to the peer:
+
+ my $Key = lonlocal::CreateCipherKey();
+ print $SSLSocket "$Key\n";
+
+ lonssl::Close($SSLSocket);
+
+ Debug("Key exchange complete: $Key");
+
+ return $Key;
+}
+#
+# InsecureConnection:
+# If insecure connections are allowd,
+# exchange a challenge with the client to 'validate' the
+# client (not really, but that's the protocol):
+# We produce a challenge string that's sent to the client.
+# The client must then echo the challenge verbatim to us.
+#
+# Parameter:
+# Socket - Socket open on the client.
+# Returns:
+# 1 - success.
+# 0 - failure (e.g.mismatch or insecure not allowed).
+#
+sub InsecureConnection {
+ my $Socket = shift;
+
+ # Don't even start if insecure connections are not allowed.
+
+ if(! $perlvar{londAllowInsecure}) { # Insecure connections not allowed.
+ return 0;
+ }
+
+ # Fabricate a challenge string and send it..
+
+ my $challenge = "$$".time; # pid + time.
+ print $Socket "$challenge\n";
+ &status("Waiting for challenge reply");
+
+ my $answer = <$Socket>;
+ $answer =~s/\W//g;
+ if($challenge eq $answer) {
+ return 1;
+ } else {
+ logthis("<font color='blue'>WARNING client did not respond to challenge</font>");
+ &status("No challenge reqply");
+ return 0;
+ }
+
+
+}
+#
+# Safely execute a command (as long as it's not a shel command and doesn
+# not require/rely on shell escapes. The function operates by doing a
+# a pipe based fork and capturing stdout and stderr from the pipe.
+#
+# Formal Parameters:
+# $line - A line of text to be executed as a command.
+# Returns:
+# The output from that command. If the output is multiline the caller
+# must know how to split up the output.
+#
+#
+sub execute_command {
+ my ($line) = @_;
+ my @words = split(/\s/, $line); # Bust the command up into words.
+ my $output = "";
+
+ my $pid = open(CHILD, "-|");
+
+ if($pid) { # Parent process
+ Debug("In parent process for execute_command");
+ my @data = <CHILD>; # Read the child's outupt...
+ close CHILD;
+ foreach my $output_line (@data) {
+ Debug("Adding $output_line");
+ $output .= $output_line; # Presumably has a \n on it.
+ }
+
+ } else { # Child process
+ close (STDERR);
+ open (STDERR, ">&STDOUT");# Combine stderr, and stdout...
+ exec(@words); # won't return.
+ }
+ return $output;
+}
+
+
+# GetCertificate: Given a transaction that requires a certificate,
+# this function will extract the certificate from the transaction
+# request. Note that at this point, the only concept of a certificate
+# is the hostname to which we are connected.
+#
+# Parameter:
+# request - The request sent by our client (this parameterization may
+# need to change when we really use a certificate granting
+# authority.
+#
+sub GetCertificate {
+ my $request = shift;
+
+ return $clientip;
+}
+
#
# Return true if client is a manager.
#
@@ -161,214 +399,615 @@ sub isManager {
sub isClient {
return (($ConnectionType eq "client") || ($ConnectionType eq "both"));
}
+
+
#
-# Ties a domain level resource file to a hash.
-# If requested a history entry is created in the associated hist file.
+# ReadManagerTable: Reads in the current manager table. For now this is
+# done on each manager authentication because:
+# - These authentications are not frequent
+# - This allows dynamic changes to the manager table
+# without the need to signal to the lond.
#
-# Parameters:
-# domain - Name of the domain in which the resource file lives.
-# namespace - Name of the hash within that domain.
-# how - How to tie the hash (e.g. GDBM_WRCREAT()).
-# loghead - Optional parameter, if present a log entry is created
-# in the associated history file and this is the first part
-# of that entry.
-# logtail - Goes along with loghead, The actual logentry is of the
-# form $loghead:<timestamp>:logtail.
-# Returns:
-# Reference to a hash bound to the db file or alternatively undef
-# if the tie failed.
-#
-sub TieDomainHash {
- my $domain = shift;
- my $namespace = shift;
- my $how = shift;
-
- # Filter out any whitespace in the domain name:
-
- $domain =~ s/\W//g;
-
- # We have enough to go on to tie the hash:
-
- my $UserTopDir = $perlvar{'lonUsersDir'};
- my $DomainDir = $UserTopDir."/$domain";
- my $ResourceFile = $DomainDir."/$namespace.db";
- my %hash;
- if(tie(%hash, 'GDBM_File', $ResourceFile, $how, 0640)) {
- if (scalar @_) { # Need to log the operation.
- my $logFh = IO::File->new(">>$DomainDir/$namespace.hist");
- if($logFh) {
- my $TimeStamp = time;
- my ($loghead, $logtail) = @_;
- print $logFh "$loghead:$TimeStamp:$logtail\n";
- }
- }
- return \%hash; # Return the tied hash.
- }
- else {
- return undef; # Tie failed.
- }
+sub ReadManagerTable {
+
+ &Debug("Reading manager table");
+ # Clean out the old table first..
+
+ foreach my $key (keys %managers) {
+ delete $managers{$key};
+ }
+
+ my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
+ if (!open (MANAGERS, $tablename)) {
+ logthis('<font color="red">No manager table. Nobody can manage!!</font>');
+ return;
+ }
+ while(my $host = <MANAGERS>) {
+ chomp($host);
+ if ($host =~ "^#") { # Comment line.
+ next;
+ }
+ if (!defined &Apache::lonnet::get_host_ip($host)) { # This is a non cluster member
+ # The entry is of the form:
+ # cluname:hostname
+ # cluname - A 'cluster hostname' is needed in order to negotiate
+ # the host key.
+ # hostname- The dns name of the host.
+ #
+ my($cluname, $dnsname) = split(/:/, $host);
+
+ my $ip = gethostbyname($dnsname);
+ if(defined($ip)) { # bad names don't deserve entry.
+ my $hostip = inet_ntoa($ip);
+ $managers{$hostip} = $cluname;
+ logthis('<font color="green"> registering manager '.
+ "$dnsname as $cluname with $hostip </font>\n");
+ }
+ } else {
+ logthis('<font color="green"> existing host'." $host</font>\n");
+ $managers{&Apache::lonnet::get_host_ip($host)} = $host; # Use info from cluster tab if clumemeber
+ }
+ }
}
#
-# Ties a user's resource file to a hash.
-# If necessary, an appropriate history
-# log file entry is made as well.
-# This sub factors out common code from the subs that manipulate
-# the various gdbm files that keep keyword value pairs.
+# ValidManager: Determines if a given certificate represents a valid manager.
+# in this primitive implementation, the 'certificate' is
+# just the connecting loncapa client name. This is checked
+# against a valid client list in the configuration.
+#
+#
+sub ValidManager {
+ my $certificate = shift;
+
+ return isManager;
+}
+#
+# CopyFile: Called as part of the process of installing a
+# new configuration file. This function copies an existing
+# file to a backup file.
# Parameters:
-# domain - Name of the domain the user is in.
-# user - Name of the 'current user'.
-# namespace - Namespace representing the file to tie.
-# how - What the tie is done to (e.g. GDBM_WRCREAT().
-# loghead - Optional first part of log entry if there may be a
-# history file.
-# what - Optional tail of log entry if there may be a history
-# file.
+# oldfile - Name of the file to backup.
+# newfile - Name of the backup file.
+# Return:
+# 0 - Failure (errno has failure reason).
+# 1 - Success.
+#
+sub CopyFile {
+
+ my ($oldfile, $newfile) = @_;
+
+ if (! copy($oldfile,$newfile)) {
+ return 0;
+ }
+ chmod(0660, $newfile);
+ return 1;
+}
+#
+# Host files are passed out with externally visible host IPs.
+# If, for example, we are behind a fire-wall or NAT host, our
+# internally visible IP may be different than the externally
+# visible IP. Therefore, we always adjust the contents of the
+# host file so that the entry for ME is the IP that we believe
+# we have. At present, this is defined as the entry that
+# DNS has for us. If by some chance we are not able to get a
+# DNS translation for us, then we assume that the host.tab file
+# is correct.
+# BUGBUGBUG - in the future, we really should see if we can
+# easily query the interface(s) instead.
+# Parameter(s):
+# contents - The contents of the host.tab to check.
# Returns:
-# hash to which the database is tied. It's up to the caller to untie.
-# undef if the has could not be tied.
+# newcontents - The adjusted contents.
#
-sub TieUserHash {
- my $domain = shift;
- my $user = shift;
- my $namespace = shift;
- my $how = shift;
-
- $namespace=~s/\//\_/g; # / -> _
- $namespace=~s/\W//g; # whitespace eliminated.
- my $proname = propath($domain, $user);
-
- # If this is a namespace for which a history is kept,
- # make the history log entry:
-
-
- unless ($namespace =~/^nohist\_/ && (scalar @_ > 0)) {
- my $hfh = IO::File->new(">>$proname/$namespace.hist");
- if($hfh) {
- my $now = time;
- my $loghead = shift;
- my $what = shift;
- print $hfh "$loghead:$now:$what\n";
+#
+sub AdjustHostContents {
+ my $contents = shift;
+ my $adjusted;
+ my $me = $perlvar{'lonHostID'};
+
+ foreach my $line (split(/\n/,$contents)) {
+ if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
+ chomp($line);
+ my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
+ if ($id eq $me) {
+ my $ip = gethostbyname($name);
+ my $ipnew = inet_ntoa($ip);
+ $ip = $ipnew;
+ # Reconstruct the host line and append to adjusted:
+
+ my $newline = "$id:$domain:$role:$name:$ip";
+ if($maxcon ne "") { # Not all hosts have loncnew tuning params
+ $newline .= ":$maxcon:$idleto:$mincon";
+ }
+ $adjusted .= $newline."\n";
+
+ } else { # Not me, pass unmodified.
+ $adjusted .= $line."\n";
+ }
+ } else { # Blank or comment never re-written.
+ $adjusted .= $line."\n"; # Pass blanks and comments as is.
}
}
- # Tie the database.
-
- my %hash;
- if(tie(%hash, 'GDBM_FILE', "$proname/$namespace.db",
- $how, 0640)) {
- return \%hash;
+ return $adjusted;
+}
+#
+# InstallFile: Called to install an administrative file:
+# - The file is created int a temp directory called <name>.tmp
+# - lcinstall file is called to install the file.
+# since the web app has no direct write access to the table directory
+#
+# Parameters:
+# Name of the file
+# File Contents.
+# Return:
+# nonzero - success.
+# 0 - failure and $! has an errno.
+# Assumptions:
+# File installtion is a relatively infrequent
+#
+sub InstallFile {
+
+ my ($Filename, $Contents) = @_;
+# my $TempFile = $Filename.".tmp";
+ my $exedir = $perlvar{'lonDaemons'};
+ my $tmpdir = $exedir.'/tmp/';
+ my $TempFile = $tmpdir."TempTableFile.tmp";
+
+ # Open the file for write:
+
+ my $fh = IO::File->new("> $TempFile"); # Write to temp.
+ if(!(defined $fh)) {
+ &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
+ return 0;
}
- else {
- return undef;
+ # write the contents of the file:
+
+ print $fh ($Contents);
+ $fh->close; # In case we ever have a filesystem w. locking
+
+ chmod(0664, $TempFile); # Everyone can write it.
+
+ # Use lcinstall file to put the file in the table directory...
+
+ &Debug("Opening pipe to $exedir/lcinstallfile $TempFile $Filename");
+ my $pf = IO::File->new("| $exedir/lcinstallfile $TempFile $Filename > $exedir/logs/lcinstallfile.log");
+ close $pf;
+ my $err = $?;
+ &Debug("Status is $err");
+ if ($err != 0) {
+ my $msg = $err;
+ if ($err < @installerrors) {
+ $msg = $installerrors[$err];
+ }
+ &logthis("Install failed for table file $Filename : $msg");
+ return 0;
}
-
+
+ # Remove the temp file:
+
+ unlink($TempFile);
+
+ return 1;
}
+
#
-# Get a Request:
-# Gets a Request message from the client. The transaction
-# is defined as a 'line' of text. We remove the new line
-# from the text line.
-#
-sub GetRequest {
- my $input = <$client>;
- chomp($input);
+# ConfigFileFromSelector: converts a configuration file selector
+# into a configuration file pathname.
+# It's probably no longer necessary to preserve
+# special handling of hosts or domain as those
+# files have been superceded by dns_hosts, dns_domain.
+# The default action is just to prepend the directory
+# and append .tab
+#
+#
+# Parameters:
+# selector - Configuration file selector.
+# Returns:
+# Full path to the file or undef if the selector is invalid.
+#
+sub ConfigFileFromSelector {
+ my $selector = shift;
+ my $tablefile;
- Debug("Request = $input\n");
+ my $tabledir = $perlvar{'lonTabDir'}.'/';
+ if ($selector eq "hosts") {
+ $tablefile = $tabledir."hosts.tab";
+ } elsif ($selector eq "domain") {
+ $tablefile = $tabledir."domain.tab";
+ } else {
+ $tablefile = $tabledir.$selector.'.tab';
+ }
+ return $tablefile;
- &status('Processing '.$clientname.':'.$input);
+}
+#
+# PushFile: Called to do an administrative push of a file.
+# - Ensure the file being pushed is one we support.
+# - Backup the old file to <filename.saved>
+# - Separate the contents of the new file out from the
+# rest of the request.
+# - Write the new file.
+# Parameter:
+# Request - The entire user request. This consists of a : separated
+# string pushfile:tablename:contents.
+# NOTE: The contents may have :'s in it as well making things a bit
+# more interesting... but not much.
+# Returns:
+# String to send to client ("ok" or "refused" if bad file).
+#
+sub PushFile {
+ my $request = shift;
+ my ($command, $filename, $contents) = split(":", $request, 3);
+ &Debug("PushFile");
+
+ # At this point in time, pushes for only the following tables are
+ # supported:
+ # hosts.tab ($filename eq host).
+ # domain.tab ($filename eq domain).
+ # Construct the destination filename or reject the request.
+ #
+ # lonManage is supposed to ensure this, however this session could be
+ # part of some elaborate spoof that managed somehow to authenticate.
+ #
+
+
+ my $tablefile = ConfigFileFromSelector($filename);
+ if(! (defined $tablefile)) {
+ return "refused";
+ }
+
+ # If the file being pushed is the host file, we adjust the entry for ourself so that the
+ # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
+ # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
+ # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
+ # that possibilty.
+
+ if($filename eq "host") {
+ $contents = AdjustHostContents($contents);
+ }
+
+ # Install the new file:
+
+ &logthis("Installing new $tablefile contents:\n$contents");
+ if(!InstallFile($tablefile, $contents)) {
+ &logthis('<font color="red"> Pushfile: unable to install '
+ .$tablefile." $! </font>");
+ return "error:$!";
+ } else {
+ &logthis('<font color="green"> Installed new '.$tablefile
+ ."</font>");
+
+ }
+
+
+ # Indicate success:
+
+ return "ok";
- return $input;
}
+
+#
+# Called to re-init either lonc or lond.
#
-# Decipher encoded traffic
# Parameters:
-# input - Encoded data.
+# request - The full request by the client. This is of the form
+# reinit:<process>
+# where <process> is allowed to be either of
+# lonc or lond
+#
# Returns:
-# Decoded data or undef if encryption key was not yet negotiated.
-# Implicit input:
-# cipher - This global holds the negotiated encryption key.
+# The string to be sent back to the client either:
+# ok - Everything worked just fine.
+# error:why - There was a failure and why describes the reason.
#
-sub Decipher {
- my $input = shift;
- my $output = '';
-
-
- if($cipher) {
- my($enc, $enclength, $encinput) = split(/:/, $input);
- for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
- $output .=
- $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
+#
+sub ReinitProcess {
+ my $request = shift;
+
+
+ # separate the request (reinit) from the process identifier and
+ # validate it producing the name of the .pid file for the process.
+ #
+ #
+ my ($junk, $process) = split(":", $request);
+ my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
+ if($process eq 'lonc') {
+ $processpidfile = $processpidfile."lonc.pid";
+ if (!open(PIDFILE, "< $processpidfile")) {
+ return "error:Open failed for $processpidfile";
}
- return substr($output, 0, $enclength);
+ my $loncpid = <PIDFILE>;
+ close(PIDFILE);
+ logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
+ ."</font>");
+ kill("USR2", $loncpid);
+ } elsif ($process eq 'lond') {
+ logthis('<font color="red"> Reinitializing self (lond) </font>');
+ &UpdateHosts; # Lond is us!!
} else {
- return undef;
+ &logthis('<font color="yellow" Invalid reinit request for '.$process
+ ."</font>");
+ return "error:Invalid process identifier $process";
}
+ return 'ok';
}
+# Validate a line in a configuration file edit script:
+# Validation includes:
+# - Ensuring the command is valid.
+# - Ensuring the command has sufficient parameters
+# Parameters:
+# scriptline - A line to validate (\n has been stripped for what it's worth).
+#
+# Return:
+# 0 - Invalid scriptline.
+# 1 - Valid scriptline
+# NOTE:
+# Only the command syntax is checked, not the executability of the
+# command.
+#
+sub isValidEditCommand {
+ my $scriptline = shift;
+
+ # Line elements are pipe separated:
+ my ($command, $key, $newline) = split(/\|/, $scriptline);
+ &logthis('<font color="green"> isValideditCommand checking: '.
+ "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
+
+ if ($command eq "delete") {
+ #
+ # key with no newline.
+ #
+ if( ($key eq "") || ($newline ne "")) {
+ return 0; # Must have key but no newline.
+ } else {
+ return 1; # Valid syntax.
+ }
+ } elsif ($command eq "replace") {
+ #
+ # key and newline:
+ #
+ if (($key eq "") || ($newline eq "")) {
+ return 0;
+ } else {
+ return 1;
+ }
+ } elsif ($command eq "append") {
+ if (($key ne "") && ($newline eq "")) {
+ return 1;
+ } else {
+ return 0;
+ }
+ } else {
+ return 0; # Invalid command.
+ }
+ return 0; # Should not get here!!!
+}
#
-# Register a command processor. This function is invoked to register a sub
-# to process a request. Once registered, the ProcessRequest sub can automatically
-# dispatch requests to an appropriate sub, and do the top level validity checking
-# as well:
-# - Is the keyword recognized.
-# - Is the proper client type attempting the request.
-# - Is the request encrypted if it has to be.
+# ApplyEdit - Applies an edit command to a line in a configuration
+# file. It is the caller's responsiblity to validate the
+# edit line.
# Parameters:
-# $RequestName - Name of the request being registered.
-# This is the command request that will match
-# against the hash keywords to lookup the information
-# associated with the dispatch information.
-# $Procedure - Reference to a sub to call to process the request.
-# All subs get called as follows:
-# Procedure($cmd, $tail, $replyfd, $key)
-# $cmd - the actual keyword that invoked us.
-# $tail - the tail of the request that invoked us.
-# $replyfd- File descriptor connected to the client
-# $MustEncode - True if the request must be encoded to be good.
-# $ClientOk - True if it's ok for a client to request this.
-# $ManagerOk - True if it's ok for a manager to request this.
-# Side effects:
-# - On success, the Dispatcher hash has an entry added for the key $RequestName
-# - On failure, the program will die as it's a bad internal bug to try to
-# register a duplicate command handler.
+# $directive - A single edit directive to apply.
+# Edit directives are of the form:
+# append|newline - Appends a new line to the file.
+# replace|key|newline - Replaces the line with key value 'key'
+# delete|key - Deletes the line with key value 'key'.
+# $editor - A config file editor object that contains the
+# file being edited.
#
-sub RegisterHandler {
- my $RequestName = shift;
- my $Procedure = shift;
- my $MustEncode = shift;
- my $ClientOk = shift;
- my $ManagerOk = shift;
-
- # Don't allow duplication#
-
- if (defined $Dispatcher{$RequestName}) {
- die "Attempting to define a duplicate request handler for $RequestName\n";
+sub ApplyEdit {
+
+ my ($directive, $editor) = @_;
+
+ # Break the directive down into its command and its parameters
+ # (at most two at this point. The meaning of the parameters, if in fact
+ # they exist depends on the command).
+
+ my ($command, $p1, $p2) = split(/\|/, $directive);
+
+ if($command eq "append") {
+ $editor->Append($p1); # p1 - key p2 null.
+ } elsif ($command eq "replace") {
+ $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
+ } elsif ($command eq "delete") {
+ $editor->DeleteLine($p1); # p1 - key p2 null.
+ } else { # Should not get here!!!
+ die "Invalid command given to ApplyEdit $command"
}
- # Build the client type mask:
+}
+#
+# AdjustOurHost:
+# Adjusts a host file stored in a configuration file editor object
+# for the true IP address of this host. This is necessary for hosts
+# that live behind a firewall.
+# Those hosts have a publicly distributed IP of the firewall, but
+# internally must use their actual IP. We assume that a given
+# host only has a single IP interface for now.
+# Formal Parameters:
+# editor - The configuration file editor to adjust. This
+# editor is assumed to contain a hosts.tab file.
+# Strategy:
+# - Figure out our hostname.
+# - Lookup the entry for this host.
+# - Modify the line to contain our IP
+# - Do a replace for this host.
+sub AdjustOurHost {
+ my $editor = shift;
+
+ # figure out who I am.
+
+ my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
+
+ # Get my host file entry.
+
+ my $ConfigLine = $editor->Find($myHostName);
+ if(! (defined $ConfigLine)) {
+ die "AdjustOurHost - no entry for me in hosts file $myHostName";
+ }
+ # figure out my IP:
+ # Use the config line to get my hostname.
+ # Use gethostbyname to translate that into an IP address.
+ #
+ my ($id,$domain,$role,$name,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
+ #
+ # Reassemble the config line from the elements in the list.
+ # Note that if the loncnew items were not present before, they will
+ # be now even if they would be empty
+ #
+ my $newConfigLine = $id;
+ foreach my $item ($domain, $role, $name, $maxcon, $idleto, $mincon) {
+ $newConfigLine .= ":".$item;
+ }
+ # Replace the line:
+
+ $editor->ReplaceLine($id, $newConfigLine);
- my $ClientTypeMask = 0;
- if($ClientOk) {
- $ClientTypeMask |= $CLIENT_OK;
+}
+#
+# ReplaceConfigFile:
+# Replaces a configuration file with the contents of a
+# configuration file editor object.
+# This is done by:
+# - Copying the target file to <filename>.old
+# - Writing the new file to <filename>.tmp
+# - Moving <filename.tmp> -> <filename>
+# This laborious process ensures that the system is never without
+# a configuration file that's at least valid (even if the contents
+# may be dated).
+# Parameters:
+# filename - Name of the file to modify... this is a full path.
+# editor - Editor containing the file.
+#
+sub ReplaceConfigFile {
+
+ my ($filename, $editor) = @_;
+
+ CopyFile ($filename, $filename.".old");
+
+ my $contents = $editor->Get(); # Get the contents of the file.
+
+ InstallFile($filename, $contents);
+}
+#
+#
+# Called to edit a configuration table file
+# Parameters:
+# request - The entire command/request sent by lonc or lonManage
+# Return:
+# The reply to send to the client.
+#
+sub EditFile {
+ my $request = shift;
+
+ # Split the command into it's pieces: edit:filetype:script
+
+ my ($cmd, $filetype, $script) = split(/:/, $request,3); # : in script
+
+ # Check the pre-coditions for success:
+
+ if($cmd != "edit") { # Something is amiss afoot alack.
+ return "error:edit request detected, but request != 'edit'\n";
}
- if($ManagerOk) {
- $ClientTypeMask |= $MANAGER_OK;
+ if( ($filetype ne "hosts") &&
+ ($filetype ne "domain")) {
+ return "error:edit requested with invalid file specifier: $filetype \n";
}
-
- # Enter the hash:
-
- my @entry = ($Procedure, $MustEncode, $ClientTypeMask);
-
- $Dispatcher{$RequestName} = \@entry;
-
-
+
+ # Split the edit script and check it's validity.
+
+ my @scriptlines = split(/\n/, $script); # one line per element.
+ my $linecount = scalar(@scriptlines);
+ for(my $i = 0; $i < $linecount; $i++) {
+ chomp($scriptlines[$i]);
+ if(!isValidEditCommand($scriptlines[$i])) {
+ return "error:edit with bad script line: '$scriptlines[$i]' \n";
+ }
+ }
+
+ # Execute the edit operation.
+ # - Create a config file editor for the appropriate file and
+ # - execute each command in the script:
+ #
+ my $configfile = ConfigFileFromSelector($filetype);
+ if (!(defined $configfile)) {
+ return "refused\n";
+ }
+ my $editor = ConfigFileEdit->new($configfile);
+
+ for (my $i = 0; $i < $linecount; $i++) {
+ ApplyEdit($scriptlines[$i], $editor);
+ }
+ # If the file is the host file, ensure that our host is
+ # adjusted to have our ip:
+ #
+ if($filetype eq "host") {
+ AdjustOurHost($editor);
+ }
+ # Finally replace the current file with our file.
+ #
+ ReplaceConfigFile($configfile, $editor);
+
+ return "ok\n";
}
+# read_profile
+#
+# Returns a set of specific entries from a user's profile file.
+# this is a utility function that is used by both get_profile_entry and
+# get_profile_entry_encrypted.
+#
+# Parameters:
+# udom - Domain in which the user exists.
+# uname - User's account name (loncapa account)
+# namespace - The profile namespace to open.
+# what - A set of & separated queries.
+# Returns:
+# If all ok: - The string that needs to be shipped back to the user.
+# If failure - A string that starts with error: followed by the failure
+# reason.. note that this probabyl gets shipped back to the
+# user as well.
+#
+sub read_profile {
+ my ($udom, $uname, $namespace, $what) = @_;
+
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
+ my @queries=split(/\&/,$what);
+ if ($namespace eq 'roles') {
+ @queries = map { &unescape($_); } @queries;
+ }
+ my $qresult='';
+
+ for (my $i=0;$i<=$#queries;$i++) {
+ $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
+ }
+ $qresult=~s/\&$//; # Remove trailing & from last lookup.
+ if (&untie_user_hash($hashref)) {
+ return $qresult;
+ } else {
+ return "error: ".($!+0)." untie (GDBM) Failed";
+ }
+ } else {
+ if ($!+0 == 2) {
+ return "error:No such file or GDBM reported bad block error";
+ } else {
+ return "error: ".($!+0)." tie (GDBM) Failed";
+ }
+ }
+
+}
#--------------------- Request Handlers --------------------------------------------
#
-# By convention each request handler registers itself prior to the sub declaration:
+# By convention each request handler registers itself prior to the sub
+# declaration:
#
+#++
+#
# Handles ping requests.
# Parameters:
# $cmd - the actual keyword that invoked us.
@@ -382,19 +1021,21 @@ sub RegisterHandler {
# 0 - Program should exit.
# Side effects:
# Reply information is sent to the client.
-
-sub PingHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub ping_handler {
+ my ($cmd, $tail, $client) = @_;
+ Debug("$cmd $tail $client .. $currenthostid:");
- Reply( $client,"$currenthostid\n","$cmd:$tail");
+ Reply( $client,\$currenthostid,"$cmd:$tail");
return 1;
}
-RegisterHandler("ping", \&PingHandler, 0, 1, 1); # Ping unencoded, client or manager.
+®ister_handler("ping", \&ping_handler, 0, 1, 1); # Ping unencoded, client or manager.
+
+#++
+#
+# Handles pong requests. Pong replies with our current host id, and
+# the results of a ping sent to us via our lonc.
#
-# Handles pong reequests:
# Parameters:
# $cmd - the actual keyword that invoked us.
# $tail - the tail of the request that invoked us.
@@ -407,22 +1048,24 @@ RegisterHandler("ping", \&PingHandler, 0
# 0 - Program should exit.
# Side effects:
# Reply information is sent to the client.
+sub pong_handler {
+ my ($cmd, $tail, $replyfd) = @_;
-sub PongHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
-
- my $reply=&reply("ping",$clientname);
- Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
+ my $reply=&Apache::lonnet::reply("ping",$clientname);
+ &Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
return 1;
}
-RegisterHandler("pong", \&PongHandler, 0, 1, 1); # Pong unencoded, client or manager
+®ister_handler("pong", \&pong_handler, 0, 1, 1); # Pong unencoded, client or manager
-#
-# EstablishKeyHandler:
+#++
# Called to establish an encrypted session key with the remote client.
-#
+# Note that with secure lond, in most cases this function is never
+# invoked. Instead, the secure session key is established either
+# via a local file that's locked down tight and only lives for a short
+# time, or via an ssl tunnel...and is generated from a bunch-o-random
+# bits from /dev/urandom, rather than the predictable pattern used by
+# by this sub. This sub is only used in the old-style insecure
+# key negotiation.
# Parameters:
# $cmd - the actual keyword that invoked us.
# $tail - the tail of the request that invoked us.
@@ -430,7 +1073,7 @@ RegisterHandler("pong", \&PongHandler, 0
# Implicit Inputs:
# $currenthostid - Global variable that carries the name of the host
# known as.
-# $clientname - Global variable that carries the name of the hsot we're connected to.
+# $clientname - Global variable that carries the name of the host we're connected to.
# Returns:
# 1 - Ok to continue processing.
# 0 - Program should exit.
@@ -438,10 +1081,8 @@ RegisterHandler("pong", \&PongHandler, 0
# Reply information is sent to the client.
# $cipher is set with a reference to a new IDEA encryption object.
#
-sub EstablishKeyHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub establish_key_handler {
+ my ($cmd, $tail, $replyfd) = @_;
my $buildkey=time.$$.int(rand 100000);
$buildkey=~tr/1-6/A-F/;
@@ -454,14 +1095,13 @@ sub EstablishKeyHandler {
$key=substr($key,0,32);
my $cipherkey=pack("H32",$key);
$cipher=new IDEA $cipherkey;
- Reply($replyfd, "$buildkey\n", "$cmd:$tail");
+ &Reply($replyfd, \$buildkey, "$cmd:$tail");
return 1;
}
-RegisterHandler("ekey", \&EstablishKeyHandler, 0, 1,1);
+®ister_handler("ekey", \&establish_key_handler, 0, 1,1);
-# LoadHandler:
# Handler for the load command. Returns the current system load average
# to the requestor.
#
@@ -472,16 +1112,14 @@ RegisterHandler("ekey", \&EstablishKeyHa
# Implicit Inputs:
# $currenthostid - Global variable that carries the name of the host
# known as.
-# $clientname - Global variable that carries the name of the hsot we're connected to.
+# $clientname - Global variable that carries the name of the host we're connected to.
# Returns:
# 1 - Ok to continue processing.
# 0 - Program should exit.
# Side effects:
# Reply information is sent to the client.
-sub LoadHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub load_handler {
+ my ($cmd, $tail, $replyfd) = @_;
# Get the load average from /proc/loadavg and calculate it as a percentage of
# the allowed load limit as set by the perl global variable lonLoadLim
@@ -494,12 +1132,11 @@ sub LoadHandler {
my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};
- Reply( $replyfd, "$loadpercent\n", "$cmd:$tail");
+ &Reply( $replyfd, \$loadpercent, "$cmd:$tail");
return 1;
}
-RegisterHandler("load", \&LoadHandler, 0, 1, 0);
-
+®ister_handler("load", \&load_handler, 0, 1, 0);
#
# Process the userload request. This sub returns to the client the current
@@ -512,7 +1149,7 @@ RegisterHandler("load", \&LoadHandler, 0
# Implicit Inputs:
# $currenthostid - Global variable that carries the name of the host
# known as.
-# $clientname - Global variable that carries the name of the hsot we're connected to.
+# $clientname - Global variable that carries the name of the host we're connected to.
# Returns:
# 1 - Ok to continue processing.
# 0 - Program should exit
@@ -521,17 +1158,15 @@ RegisterHandler("load", \&LoadHandler, 0
# Implicit outputs:
# the reply is written to the client.
#
-sub UserLoadHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub user_load_handler {
+ my ($cmd, $tail, $replyfd) = @_;
- my $userloadpercent=&userload();
- Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");
+ my $userloadpercent=&Apache::lonnet::userload();
+ &Reply($replyfd, \$userloadpercent, "$cmd:$tail");
return 1;
}
-RegisterHandler("userload", \&UserLoadHandler, 0, 1, 0);
+®ister_handler("userload", \&user_load_handler, 0, 1, 0);
# Process a request for the authorization type of a user:
# (userauth).
@@ -546,37 +1181,37 @@ RegisterHandler("userload", \&UserLoadHa
# Implicit outputs:
# The user authorization type is written to the client.
#
-sub UserAuthorizationType {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub user_authorization_type {
+ my ($cmd, $tail, $replyfd) = @_;
my $userinput = "$cmd:$tail";
# Pull the domain and username out of the command tail.
- # and call GetAuthType to determine the authentication type.
+ # and call get_auth_type to determine the authentication type.
my ($udom,$uname)=split(/:/,$tail);
- my $result = GetAuthType($udom, $uname);
+ my $result = &get_auth_type($udom, $uname);
if($result eq "nouser") {
- Failure( $replyfd, "unknown_user\n", $userinput);
+ &Failure( $replyfd, "unknown_user\n", $userinput);
} else {
#
- # We only want to pass the second field from GetAuthType
+ # We only want to pass the second field from get_auth_type
# for ^krb.. otherwise we'll be handing out the encrypted
# password for internals e.g.
#
my ($type,$otherinfo) = split(/:/,$result);
if($type =~ /^krb/) {
$type = $result;
- }
- Reply( $replyfd, "$type\n", $userinput);
+ } else {
+ $type .= ':';
+ }
+ &Reply( $replyfd, \$type, $userinput);
}
return 1;
}
-RegisterHandler("currentauth", \&UserAuthorizationType, 1, 1, 0);
-#
+®ister_handler("currentauth", \&user_authorization_type, 1, 1, 0);
+
# Process a request by a manager to push a hosts or domain table
# to us. We pick apart the command and pass it on to the subs
# that already exist to do this.
@@ -590,34 +1225,446 @@ RegisterHandler("currentauth", \&UserAut
# 0 - Program should exit
# Implicit Output:
# a reply is written to the client.
-
-sub PushFileHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub push_file_handler {
+ my ($cmd, $tail, $client) = @_;
+ &Debug("In push file handler");
my $userinput = "$cmd:$tail";
# At this time we only know that the IP of our partner is a valid manager
# the code below is a hook to do further authentication (e.g. to resolve
# spoofing).
- my $cert = GetCertificate($userinput);
- if(ValidManager($cert)) {
+ my $cert = &GetCertificate($userinput);
+ if(&ValidManager($cert)) {
+ &Debug("Valid manager: $client");
# Now presumably we have the bona fides of both the peer host and the
# process making the request.
- my $reply = PushFile($userinput);
- Reply($client, "$reply\n", $userinput);
+ my $reply = &PushFile($userinput);
+ &Reply($client, \$reply, $userinput);
} else {
- Failure( $client, "refused\n", $userinput);
+ &logthis("push_file_handler $client is not valid");
+ &Failure( $client, "refused\n", $userinput);
}
+ return 1;
+}
+®ister_handler("pushfile", \&push_file_handler, 1, 0, 1);
+
+# The du_handler routine should be considered obsolete and is retained
+# for communication with legacy servers. Please see the du2_handler.
+#
+# du - list the disk usage of a directory recursively.
+#
+# note: stolen code from the ls file handler
+# under construction by Rick Banghart
+# .
+# Parameters:
+# $cmd - The command that dispatched us (du).
+# $ududir - The directory path to list... I'm not sure what this
+# is relative as things like ls:. return e.g.
+# no_such_dir.
+# $client - Socket open on the client.
+# Returns:
+# 1 - indicating that the daemon should not disconnect.
+# Side Effects:
+# The reply is written to $client.
+#
+sub du_handler {
+ my ($cmd, $ududir, $client) = @_;
+ ($ududir) = split(/:/,$ududir); # Make 'telnet' testing easier.
+ my $userinput = "$cmd:$ududir";
+
+ if ($ududir=~/\.\./ || $ududir!~m|^/home/httpd/|) {
+ &Failure($client,"refused\n","$cmd:$ududir");
+ return 1;
+ }
+ # Since $ududir could have some nasties in it,
+ # we will require that ududir is a valid
+ # directory. Just in case someone tries to
+ # slip us a line like .;(cd /home/httpd rm -rf*)
+ # etc.
+ #
+ if (-d $ududir) {
+ my $total_size=0;
+ my $code=sub {
+ if ($_=~/\.\d+\./) { return;}
+ if ($_=~/\.meta$/) { return;}
+ if (-d $_) { return;}
+ $total_size+=(stat($_))[7];
+ };
+ chdir($ududir);
+ find($code,$ududir);
+ $total_size=int($total_size/1024);
+ &Reply($client,\$total_size,"$cmd:$ududir");
+ } else {
+ &Failure($client, "bad_directory:$ududir\n","$cmd:$ududir");
+ }
+ return 1;
+}
+®ister_handler("du", \&du_handler, 0, 1, 0);
+
+# Please also see the du_handler, which is obsoleted by du2.
+# du2_handler differs from du_handler in that required path to directory
+# provided by &propath() is prepended in the handler instead of on the
+# client side.
+#
+# du2 - list the disk usage of a directory recursively.
+#
+# Parameters:
+# $cmd - The command that dispatched us (du).
+# $tail - The tail of the request that invoked us.
+# $tail is a : separated list of the following:
+# - $ududir - directory path to list (before prepending)
+# - $getpropath = 1 if &propath() should prepend
+# - $uname - username to use for &propath or user dir
+# - $udom - domain to use for &propath or user dir
+# All are escaped.
+# $client - Socket open on the client.
+# Returns:
+# 1 - indicating that the daemon should not disconnect.
+# Side Effects:
+# The reply is written to $client.
+#
+
+sub du2_handler {
+ my ($cmd, $tail, $client) = @_;
+ my ($ududir,$getpropath,$uname,$udom) = map { &unescape($_) } (split(/:/, $tail));
+ my $userinput = "$cmd:$tail";
+ if (($ududir=~/\.\./) || (($ududir!~m|^/home/httpd/|) && (!$getpropath))) {
+ &Failure($client,"refused\n","$cmd:$tail");
+ return 1;
+ }
+ if ($getpropath) {
+ if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
+ $ududir = &propath($udom,$uname).'/'.$ududir;
+ } else {
+ &Failure($client,"refused\n","$cmd:$tail");
+ return 1;
+ }
+ }
+ # Since $ududir could have some nasties in it,
+ # we will require that ududir is a valid
+ # directory. Just in case someone tries to
+ # slip us a line like .;(cd /home/httpd rm -rf*)
+ # etc.
+ #
+ if (-d $ududir) {
+ my $total_size=0;
+ my $code=sub {
+ if ($_=~/\.\d+\./) { return;}
+ if ($_=~/\.meta$/) { return;}
+ if (-d $_) { return;}
+ $total_size+=(stat($_))[7];
+ };
+ chdir($ududir);
+ find($code,$ududir);
+ $total_size=int($total_size/1024);
+ &Reply($client,\$total_size,"$cmd:$ududir");
+ } else {
+ &Failure($client, "bad_directory:$ududir\n","$cmd:$tail");
+ }
+ return 1;
+}
+®ister_handler("du2", \&du2_handler, 0, 1, 0);
+
+#
+# The ls_handler routine should be considered obsolete and is retained
+# for communication with legacy servers. Please see the ls3_handler.
+#
+# ls - list the contents of a directory. For each file in the
+# selected directory the filename followed by the full output of
+# the stat function is returned. The returned info for each
+# file are separated by ':'. The stat fields are separated by &'s.
+# Parameters:
+# $cmd - The command that dispatched us (ls).
+# $ulsdir - The directory path to list... I'm not sure what this
+# is relative as things like ls:. return e.g.
+# no_such_dir.
+# $client - Socket open on the client.
+# Returns:
+# 1 - indicating that the daemon should not disconnect.
+# Side Effects:
+# The reply is written to $client.
+#
+sub ls_handler {
+ # obsoleted by ls2_handler
+ my ($cmd, $ulsdir, $client) = @_;
+
+ my $userinput = "$cmd:$ulsdir";
+
+ my $obs;
+ my $rights;
+ my $ulsout='';
+ my $ulsfn;
+ if (-e $ulsdir) {
+ if(-d $ulsdir) {
+ if (opendir(LSDIR,$ulsdir)) {
+ while ($ulsfn=readdir(LSDIR)) {
+ undef($obs);
+ undef($rights);
+ my @ulsstats=stat($ulsdir.'/'.$ulsfn);
+ #We do some obsolete checking here
+ if(-e $ulsdir.'/'.$ulsfn.".meta") {
+ open(FILE, $ulsdir.'/'.$ulsfn.".meta");
+ my @obsolete=<FILE>;
+ foreach my $obsolete (@obsolete) {
+ if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
+ if($obsolete =~ m|(<copyright>)(default)|) { $rights = 1; }
+ }
+ }
+ $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
+ if($obs eq '1') { $ulsout.="&1"; }
+ else { $ulsout.="&0"; }
+ if($rights eq '1') { $ulsout.="&1:"; }
+ else { $ulsout.="&0:"; }
+ }
+ closedir(LSDIR);
+ }
+ } else {
+ my @ulsstats=stat($ulsdir);
+ $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
+ }
+ } else {
+ $ulsout='no_such_dir';
+ }
+ if ($ulsout eq '') { $ulsout='empty'; }
+ &Reply($client, \$ulsout, $userinput); # This supports debug logging.
+
+ return 1;
+
+}
+®ister_handler("ls", \&ls_handler, 0, 1, 0);
+
+# The ls2_handler routine should be considered obsolete and is retained
+# for communication with legacy servers. Please see the ls3_handler.
+# Please also see the ls_handler, which was itself obsoleted by ls2.
+# ls2_handler differs from ls_handler in that it escapes its return
+# values before concatenating them together with ':'s.
+#
+# ls2 - list the contents of a directory. For each file in the
+# selected directory the filename followed by the full output of
+# the stat function is returned. The returned info for each
+# file are separated by ':'. The stat fields are separated by &'s.
+# Parameters:
+# $cmd - The command that dispatched us (ls).
+# $ulsdir - The directory path to list... I'm not sure what this
+# is relative as things like ls:. return e.g.
+# no_such_dir.
+# $client - Socket open on the client.
+# Returns:
+# 1 - indicating that the daemon should not disconnect.
+# Side Effects:
+# The reply is written to $client.
+#
+sub ls2_handler {
+ my ($cmd, $ulsdir, $client) = @_;
+
+ my $userinput = "$cmd:$ulsdir";
+
+ my $obs;
+ my $rights;
+ my $ulsout='';
+ my $ulsfn;
+ if (-e $ulsdir) {
+ if(-d $ulsdir) {
+ if (opendir(LSDIR,$ulsdir)) {
+ while ($ulsfn=readdir(LSDIR)) {
+ undef($obs);
+ undef($rights);
+ my @ulsstats=stat($ulsdir.'/'.$ulsfn);
+ #We do some obsolete checking here
+ if(-e $ulsdir.'/'.$ulsfn.".meta") {
+ open(FILE, $ulsdir.'/'.$ulsfn.".meta");
+ my @obsolete=<FILE>;
+ foreach my $obsolete (@obsolete) {
+ if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
+ if($obsolete =~ m|(<copyright>)(default)|) {
+ $rights = 1;
+ }
+ }
+ }
+ my $tmp = $ulsfn.'&'.join('&',@ulsstats);
+ if ($obs eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
+ if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
+ $ulsout.= &escape($tmp).':';
+ }
+ closedir(LSDIR);
+ }
+ } else {
+ my @ulsstats=stat($ulsdir);
+ $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
+ }
+ } else {
+ $ulsout='no_such_dir';
+ }
+ if ($ulsout eq '') { $ulsout='empty'; }
+ &Reply($client, \$ulsout, $userinput); # This supports debug logging.
+ return 1;
+}
+®ister_handler("ls2", \&ls2_handler, 0, 1, 0);
+#
+# ls3 - list the contents of a directory. For each file in the
+# selected directory the filename followed by the full output of
+# the stat function is returned. The returned info for each
+# file are separated by ':'. The stat fields are separated by &'s.
+# Parameters:
+# $cmd - The command that dispatched us (ls).
+# $tail - The tail of the request that invoked us.
+# $tail is a : separated list of the following:
+# - $ulsdir - directory path to list (before prepending)
+# - $getpropath = 1 if &propath() should prepend
+# - $getuserdir = 1 if path to user dir in lonUsers should
+# prepend
+# - $alternate_root - path to prepend
+# - $uname - username to use for &propath or user dir
+# - $udom - domain to use for &propath or user dir
+# All of these except $getpropath and &getuserdir are escaped.
+# no_such_dir.
+# $client - Socket open on the client.
+# Returns:
+# 1 - indicating that the daemon should not disconnect.
+# Side Effects:
+# The reply is written to $client.
+#
+
+sub ls3_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($ulsdir,$getpropath,$getuserdir,$alternate_root,$uname,$udom) =
+ split(/:/,$tail);
+ if (defined($ulsdir)) {
+ $ulsdir = &unescape($ulsdir);
+ }
+ if (defined($alternate_root)) {
+ $alternate_root = &unescape($alternate_root);
+ }
+ if (defined($uname)) {
+ $uname = &unescape($uname);
+ }
+ if (defined($udom)) {
+ $udom = &unescape($udom);
+ }
+
+ my $dir_root = $perlvar{'lonDocRoot'};
+ if ($getpropath) {
+ if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
+ $dir_root = &propath($udom,$uname);
+ $dir_root =~ s/\/$//;
+ } else {
+ &Failure($client,"refused\n","$cmd:$tail");
+ return 1;
+ }
+ } elsif ($getuserdir) {
+ if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
+ my $subdir=$uname.'__';
+ $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
+ $dir_root = $Apache::lonnet::perlvar{'lonUsersDir'}
+ ."/$udom/$subdir/$uname";
+ } else {
+ &Failure($client,"refused\n","$cmd:$tail");
+ return 1;
+ }
+ } elsif ($alternate_root ne '') {
+ $dir_root = $alternate_root;
+ }
+ if (($dir_root ne '') && ($dir_root ne '/')) {
+ if ($ulsdir =~ /^\//) {
+ $ulsdir = $dir_root.$ulsdir;
+ } else {
+ $ulsdir = $dir_root.'/'.$ulsdir;
+ }
+ }
+ my $obs;
+ my $rights;
+ my $ulsout='';
+ my $ulsfn;
+ if (-e $ulsdir) {
+ if(-d $ulsdir) {
+ if (opendir(LSDIR,$ulsdir)) {
+ while ($ulsfn=readdir(LSDIR)) {
+ undef($obs);
+ undef($rights);
+ my @ulsstats=stat($ulsdir.'/'.$ulsfn);
+ #We do some obsolete checking here
+ if(-e $ulsdir.'/'.$ulsfn.".meta") {
+ open(FILE, $ulsdir.'/'.$ulsfn.".meta");
+ my @obsolete=<FILE>;
+ foreach my $obsolete (@obsolete) {
+ if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
+ if($obsolete =~ m|(<copyright>)(default)|) {
+ $rights = 1;
+ }
+ }
+ }
+ my $tmp = $ulsfn.'&'.join('&',@ulsstats);
+ if ($obs eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
+ if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
+ $ulsout.= &escape($tmp).':';
+ }
+ closedir(LSDIR);
+ }
+ } else {
+ my @ulsstats=stat($ulsdir);
+ $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
+ }
+ } else {
+ $ulsout='no_such_dir';
+ }
+ if ($ulsout eq '') { $ulsout='empty'; }
+ &Reply($client, \$ulsout, $userinput); # This supports debug logging.
+ return 1;
+}
+®ister_handler("ls3", \&ls3_handler, 0, 1, 0);
+
+sub server_timezone_handler {
+ my ($cmd,$tail,$client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $timezone;
+ my $clockfile = '/etc/sysconfig/clock'; # Fedora/CentOS/SuSE
+ my $tzfile = '/etc/timezone'; # Debian/Ubuntu
+ if (-e $clockfile) {
+ if (open(my $fh,"<$clockfile")) {
+ while (<$fh>) {
+ next if (/^[\#\s]/);
+ if (/^(?:TIME)?ZONE\s*=\s*['"]?\s*([\w\/]+)/) {
+ $timezone = $1;
+ last;
+ }
+ }
+ close($fh);
+ }
+ } elsif (-e $tzfile) {
+ if (open(my $fh,"<$tzfile")) {
+ $timezone = <$fh>;
+ close($fh);
+ chomp($timezone);
+ if ($timezone =~ m{^Etc/(\w+)$}) {
+ $timezone = $1;
+ }
+ }
+ }
+ &Reply($client,\$timezone,$userinput); # This supports debug logging.
+ return 1;
}
-RegisterHandler("pushfile", \&PushFileHandler, 1, 0, 1);
+®ister_handler("servertimezone", \&server_timezone_handler, 0, 1, 0);
+sub server_loncaparev_handler {
+ my ($cmd,$tail,$client) = @_;
+ my $userinput = "$cmd:$tail";
+ &Reply($client,\$perlvar{'lonVersion'},$userinput);
+ return 1;
+}
+®ister_handler("serverloncaparev", \&server_loncaparev_handler, 0, 1, 0);
+sub server_homeID_handler {
+ my ($cmd,$tail,$client) = @_;
+ my $userinput = "$cmd:$tail";
+ &Reply($client,\$perlvar{'lonHostID'},$userinput);
+ return 1;
+}
+®ister_handler("serverhomeID", \&server_homeID_handler, 0, 1, 0);
# Process a reinit request. Reinit requests that either
# lonc or lond be reinitialized so that an updated
@@ -633,25 +1680,22 @@ RegisterHandler("pushfile", \&PushFileHa
# Implicit output:
# a reply is sent to the client.
#
-sub ReinitProcessHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub reinit_process_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
- my $cert = GetCertificate($userinput);
- if(ValidManager($cert)) {
+ my $cert = &GetCertificate($userinput);
+ if(&ValidManager($cert)) {
chomp($userinput);
- my $reply = ReinitProcess($userinput);
- Reply( $client, "$reply\n", $userinput);
+ my $reply = &ReinitProcess($userinput);
+ &Reply( $client, \$reply, $userinput);
} else {
- Failure( $client, "refused\n", $userinput);
+ &Failure( $client, "refused\n", $userinput);
}
return 1;
}
-
-RegisterHandler("reinit", \&ReinitProcessHandler, 1, 0, 1);
+®ister_handler("reinit", \&reinit_process_handler, 1, 0, 1);
# Process the editing script for a table edit operation.
# the editing operation must be encrypted and requested by
@@ -667,35 +1711,32 @@ RegisterHandler("reinit", \&ReinitProces
# Implicit output:
# a reply is sent to the client.
#
-sub EditTableHandler {
- my $command = shift;
- my $tail = shift;
- my $client = shift;
+sub edit_table_handler {
+ my ($command, $tail, $client) = @_;
my $userinput = "$command:$tail";
- my $cert = GetCertificate($userinput);
- if(ValidManager($cert)) {
+ my $cert = &GetCertificate($userinput);
+ if(&ValidManager($cert)) {
my($filetype, $script) = split(/:/, $tail);
if (($filetype eq "hosts") ||
($filetype eq "domain")) {
if($script ne "") {
- Reply($client, # BUGBUG - EditFile
- EditFile($userinput), # could fail.
+ &Reply($client, # BUGBUG - EditFile
+ &EditFile($userinput), # could fail.
$userinput);
} else {
- Failure($client,"refused\n",$userinput);
+ &Failure($client,"refused\n",$userinput);
}
} else {
- Failure($client,"refused\n",$userinput);
+ &Failure($client,"refused\n",$userinput);
}
} else {
- Failure($client,"refused\n",$userinput);
+ &Failure($client,"refused\n",$userinput);
}
return 1;
}
-RegisterHandler("edit", \&EditTableHandler, 1, 0, 1);
-
+®ister_handler("edit", \&edit_table_handler, 1, 0, 1);
#
# Authenticate a user against the LonCAPA authentication
@@ -721,10 +1762,9 @@ RegisterHandler("edit", \&EditTableHandl
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub AuthenticateHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub authenticate_handler {
+ my ($cmd, $tail, $client) = @_;
+
# Regenerate the full input line
@@ -733,115 +1773,57 @@ sub AuthenticateHandler {
# udom - User's domain.
# uname - Username.
# upass - User's password.
+ # checkdefauth - Pass to validate_user() to try authentication
+ # with default auth type(s) if no user account.
+ # clientcancheckhost - Passed by clients with functionality in lonauth.pm
+ # to check if session can be hosted.
- my ($udom,$uname,$upass)=split(/:/,$tail);
- Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
+ my ($udom, $uname, $upass, $checkdefauth, $clientcancheckhost)=split(/:/,$tail);
+ &Debug(" Authenticate domain = $udom, user = $uname, password = $upass, checkdefauth = $checkdefauth");
chomp($upass);
- $upass=unescape($upass);
+ $upass=&unescape($upass);
- # Fetch the user authentication information:
-
- my $realpasswd = GetAuthType($udom, $uname);
- if($realpasswd ne "nouser") { # nouser means no passwd file.
- my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
- my $pwdcorrect=0;
- #
- # Authenticate against password stored in the internal file.
- #
- Debug("Authenticating via $howpwd");
- if ($howpwd eq 'internal') {
- &Debug("Internal auth");
- $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);
- #
- # Authenticate against the unix password file.
- #
- } elsif ($howpwd eq 'unix') {
- &Debug("Unix auth");
- if((getpwnam($uname))[1] eq "") { #no such user!
- $pwdcorrect = 0;
- } else {
- $contentpwd=(getpwnam($uname))[1];
- my $pwauth_path="/usr/local/sbin/pwauth";
- unless ($contentpwd eq 'x') { # Not in shadow file.
- $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);
- } elsif (-e $pwauth_path) { # In shadow file so
- open PWAUTH, "|$pwauth_path" or # use external program
- die "Cannot invoke authentication";
- print PWAUTH "$uname\n$upass\n";
- close PWAUTH;
- $pwdcorrect=!$?;
- }
- }
- #
- # Authenticate against a Kerberos 4 server:
- #
- } elsif ($howpwd eq 'krb4') {
- my $null=pack("C",0);
- unless ($upass=~/$null/) {
- my $krb4_error = &Authen::Krb4::get_pw_in_tkt($uname,
- "",
- $contentpwd,
- 'krbtgt',
- $contentpwd,
- 1,
- $upass);
- if (!$krb4_error) {
- $pwdcorrect = 1;
- } else {
- $pwdcorrect=0;
- # log error if it is not a bad password
- if ($krb4_error != 62) {
- &logthis('krb4:'.$uname.','.$contentpwd.','.
- &Authen::Krb4::get_err_txt($Authen::Krb4::error));
- }
- }
- }
- #
- # Authenticate against a Kerberos 5 server:
- #
- } elsif ($howpwd eq 'krb5') {
- my $null=pack("C",0);
- unless ($upass=~/$null/) {
- my $krbclient=&Authen::Krb5::parse_name($uname.'@'.$contentpwd);
- my $krbservice="krbtgt/".$contentpwd."\@".$contentpwd;
- my $krbserver=&Authen::Krb5::parse_name($krbservice);
- my $credentials=&Authen::Krb5::cc_default();
- $credentials->initialize($krbclient);
- my $krbreturn = &Authen::Krb5::get_in_tkt_with_password($krbclient,
- $krbserver,
- $upass,
- $credentials);
- $pwdcorrect = ($krbreturn == 1);
- } else {
- $pwdcorrect=0;
- }
- #
- # Finally, the user may have written in an authentication module.
- # in that case, if requested, authenticate against it.
- #
- } elsif ($howpwd eq 'localauth') {
- $pwdcorrect=&localauth::localauth($uname,$upass,$contentpwd);
- }
+ my $pwdcorrect = &validate_user($udom,$uname,$upass,$checkdefauth);
+ if($pwdcorrect) {
+ my $canhost = 1;
+ unless ($clientcancheckhost) {
+ my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
+ my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
+ my @intdoms = &Apache::lonnet::get_internet_names($clientname);
+ unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
+ my ($remote,$hosted);
+ my $remotesession = &get_usersession_config($udom,'remotesession');
+ if (ref($remotesession) eq 'HASH') {
+ $remote = $remotesession->{'remote'}
+ }
+ my $hostedsession = &get_usersession_config($clienthomedom,'hostedsession');
+ if (ref($hostedsession) eq 'HASH') {
+ $hosted = $hostedsession->{'hosted'};
+ }
+ my $loncaparev = $clientversion;
+ if ($loncaparev eq '') {
+ $loncaparev = $Apache::lonnet::loncaparevs{$clientname};
+ }
+ $canhost = &Apache::lonnet::can_host_session($udom,$clientname,
+ $loncaparev,
+ $remote,$hosted);
+ }
+ }
+ if ($canhost) {
+ &Reply( $client, "authorized\n", $userinput);
+ } else {
+ &Reply( $client, "not_allowed_to_host\n", $userinput);
+ }
#
- # Successfully authorized.
+ # Bad credentials: Failed to authorize
#
- if ($pwdcorrect) {
- Reply( $client, "authorized\n", $userinput);
- #
- # Bad credentials: Failed to authorize
- #
- } else {
- Failure( $client, "non_authorized\n", $userinput);
- }
- # Used to be unknown_user but that allows crackers to
- # distinguish between bad username and bad password so...
- #
} else {
- Failure( $client, "non_authorized\n", $userinput);
+ &Failure( $client, "non_authorized\n", $userinput);
}
+
return 1;
}
-RegisterHandler("auth", \&AuthenticateHandler, 1, 1, 0);
+®ister_handler("auth", \&authenticate_handler, 1, 1, 0);
#
# Change a user's password. Note that this function is complicated by
@@ -864,11 +1846,9 @@ RegisterHandler("auth", \&AuthenticateHa
# Implicit inputs:
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
-sub ChangePasswordHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub change_password_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = $cmd.":".$tail; # Reconstruct client's string.
#
@@ -876,84 +1856,73 @@ sub ChangePasswordHandler {
# uname - Username.
# upass - Current password.
# npass - New password.
+ # context - Context in which this was called
+ # (preferences or reset_by_email).
+ # lonhost - HostID of server where request originated
- my ($udom,$uname,$upass,$npass)=split(/:/,$tail);
- chomp($npass);
+ my ($udom,$uname,$upass,$npass,$context,$lonhost)=split(/:/,$tail);
+
$upass=&unescape($upass);
$npass=&unescape($npass);
&Debug("Trying to change password for $uname");
- my $realpasswd = GetAuthType($udom, $uname);
- if ($realpasswd ne "nouser") {
+
+ # First require that the user can be authenticated with their
+ # old password unless context was 'reset_by_email':
+
+ my ($validated,$failure);
+ if ($context eq 'reset_by_email') {
+ if ($lonhost eq '') {
+ $failure = 'invalid_client';
+ } else {
+ $validated = 1;
+ }
+ } else {
+ $validated = &validate_user($udom, $uname, $upass);
+ }
+ if($validated) {
+ my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
+
my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
if ($howpwd eq 'internal') {
&Debug("internal auth");
- if (crypt($upass,$contentpwd) eq $contentpwd) {
- my $salt=time;
- $salt=substr($salt,6,2);
- my $ncpass=crypt($npass,$salt);
- if(RewritePwFile($udom, $uname, "internal:$ncpass")) {
- &logthis("Result of password change for "
- ."$uname: pwchange_success");
- Reply($client, "ok\n", $userinput);
- } else {
- &logthis("Unable to open $uname passwd "
- ."to change password");
- Failure( $client, "non_authorized\n",$userinput);
- }
- } else {
- Failure($client, "non_authorized\n", $userinput);
- }
- } elsif ($howpwd eq 'unix') {
- # Unix means we have to access /etc/password
- # one way or another.
- # First: Make sure the current password is
- # correct
- &Debug("auth is unix");
- $contentpwd=(getpwnam($uname))[1];
- my $pwdcorrect = "0";
- my $pwauth_path="/usr/local/sbin/pwauth";
- unless ($contentpwd eq 'x') {
- $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);
- } elsif (-e $pwauth_path) {
- open PWAUTH, "|$pwauth_path" or
- die "Cannot invoke authentication";
- print PWAUTH "$uname\n$upass\n";
- close PWAUTH;
- &Debug("exited pwauth with $? ($uname,$upass) ");
- $pwdcorrect=($? == 0);
- }
- if ($pwdcorrect) {
- my $execdir=$perlvar{'lonDaemons'};
- &Debug("Opening lcpasswd pipeline");
- my $pf = IO::File->new("|$execdir/lcpasswd > "
- ."$perlvar{'lonDaemons'}"
- ."/logs/lcpasswd.log");
- print $pf "$uname\n$npass\n$npass\n";
- close $pf;
- my $err = $?;
- my $result = ($err>0 ? 'pwchange_failure' : 'ok');
- &logthis("Result of password change for $uname: ".
- &lcpasswdstrerror($?));
- Reply($client, "$result\n", $userinput);
+ my $salt=time;
+ $salt=substr($salt,6,2);
+ my $ncpass=crypt($npass,$salt);
+ if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
+ my $msg="Result of password change for $uname: pwchange_success";
+ if ($lonhost) {
+ $msg .= " - request originated from: $lonhost";
+ }
+ &logthis($msg);
+ &Reply($client, "ok\n", $userinput);
} else {
- Reply($client, "non_authorized\n", $userinput);
+ &logthis("Unable to open $uname passwd "
+ ."to change password");
+ &Failure( $client, "non_authorized\n",$userinput);
}
+ } elsif ($howpwd eq 'unix' && $context ne 'reset_by_email') {
+ my $result = &change_unix_password($uname, $npass);
+ &logthis("Result of password change for $uname: ".
+ $result);
+ &Reply($client, \$result, $userinput);
} else {
# this just means that the current password mode is not
# one we know how to change (e.g the kerberos auth modes or
# locally written auth handler).
#
- Reply( $client, "auth_mode_error\n", $userinput);
+ &Failure( $client, "auth_mode_error\n", $userinput);
}
+
} else {
- # used to be unknonw user but that gives out too much info..
- # so make it the same as if the initial passwd was bad.
- #
- Reply( $client, "non_authorized\n", $userinput);
+ if ($failure eq '') {
+ $failure = 'non_authorized';
+ }
+ &Failure( $client, "$failure\n", $userinput);
}
+
return 1;
}
-RegisterHandler("passwd", \&ChangePasswordHandler, 1, 1, 0);
+®ister_handler("passwd", \&change_password_handler, 1, 1, 0);
#
# Create a new user. User in this case means a lon-capa user.
@@ -971,10 +1940,10 @@ RegisterHandler("passwd", \&ChangePasswo
# Implicit inputs:
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
-sub AddUserHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub add_user_handler {
+
+ my ($cmd, $tail, $client) = @_;
+
my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
@@ -987,40 +1956,33 @@ sub AddUserHandler {
my $oldumask=umask(0077);
chomp($npass);
$npass=&unescape($npass);
- my $passfilename = PasswordPath($udom, $uname);
+ my $passfilename = &password_path($udom, $uname);
&Debug("Password file created will be:".$passfilename);
if (-e $passfilename) {
- Failure( $client, "already_exists\n", $userinput);
+ &Failure( $client, "already_exists\n", $userinput);
} else {
- my @fpparts=split(/\//,$passfilename);
- my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];
my $fperror='';
- for (my $i=3;$i<= ($#fpparts-1);$i++) {
- $fpnow.='/'.$fpparts[$i];
- unless (-e $fpnow) {
- unless (mkdir($fpnow,0777)) {
- $fperror="error: ".($!+0)." mkdir failed while attempting "
- ."makeuser";
- }
- }
+ if (!&mkpath($passfilename)) {
+ $fperror="error: ".($!+0)." mkdir failed while attempting "
+ ."makeuser";
}
unless ($fperror) {
my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
- Reply($client, $result, $userinput); #BUGBUG - could be fail
+ &Reply($client,\$result, $userinput); #BUGBUG - could be fail
} else {
- Failure($client, "$fperror\n", $userinput);
+ &Failure($client, \$fperror, $userinput);
}
}
umask($oldumask);
} else {
- Failure($client, "not_right_domain\n",
+ &Failure($client, "not_right_domain\n",
$userinput); # Even if we are multihomed.
}
return 1;
}
-RegisterHandler("makeuser", \&AddUserHandler, 1, 1, 0);
+®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
#
# Change the authentication method of a user. Note that this may
@@ -1043,34 +2005,70 @@ RegisterHandler("makeuser", \&AddUserHan
# Implicit inputs:
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
+# NOTE:
+# This is also used to change the authentication credential values (e.g. passwd).
+#
#
-sub ChangeAuthenticationHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub change_authentication_handler {
+
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail"; # Reconstruct user input.
my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
&Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
if ($udom ne $currentdomainid) {
- Failure( $client, "not_right_domain\n", $client);
+ &Failure( $client, "not_right_domain\n", $client);
} else {
chomp($npass);
$npass=&unescape($npass);
- my $passfilename = PasswordPath($udom, $uname);
+ my $oldauth = &get_auth_type($udom, $uname); # Get old auth info.
+ my $passfilename = &password_path($udom, $uname);
if ($passfilename) { # Not allowed to create a new user!!
- my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
- Reply($client, $result, $userinput);
+ # If just changing the unix passwd. need to arrange to run
+ # passwd since otherwise make_passwd_file will run
+ # lcuseradd which fails if an account already exists
+ # (to prevent an unscrupulous LONCAPA admin from stealing
+ # an existing account by overwriting it as a LonCAPA account).
+
+ if(($oldauth =~/^unix/) && ($umode eq "unix")) {
+ my $result = &change_unix_password($uname, $npass);
+ &logthis("Result of password change for $uname: ".$result);
+ if ($result eq "ok") {
+ &Reply($client, \$result);
+ } else {
+ &Failure($client, \$result);
+ }
+ } else {
+ my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
+ #
+ # If the current auth mode is internal, and the old auth mode was
+ # unix, or krb*, and the user is an author for this domain,
+ # re-run manage_permissions for that role in order to be able
+ # to take ownership of the construction space back to www:www
+ #
+
+
+ if( (($oldauth =~ /^unix/) && ($umode eq "internal")) ||
+ (($oldauth =~ /^internal/) && ($umode eq "unix")) ) {
+ if(&is_author($udom, $uname)) {
+ &Debug(" Need to manage author permissions...");
+ &manage_permissions("/$udom/_au", $udom, $uname, "$umode:");
+ }
+ }
+ &Reply($client, \$result, $userinput);
+ }
+
+
} else {
- Failure($client, "non_authorized", $userinput); # Fail the user now.
+ &Failure($client, "non_authorized\n", $userinput); # Fail the user now.
}
}
return 1;
}
-RegisterHandler("changeuserauth", \&ChangeAuthenticationHandler, 1,1, 0);
+®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
#
# Determines if this is the home server for a user. The home server
@@ -1088,35 +2086,28 @@ RegisterHandler("changeuserauth", \&Chan
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub IsHomeHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub is_home_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
my ($udom,$uname)=split(/:/,$tail);
chomp($uname);
- my $passfile = PasswordPath($udom, $uname);
+ my $passfile = &password_filename($udom, $uname);
if($passfile) {
- Reply( $client, "found\n", $userinput);
+ &Reply( $client, "found\n", $userinput);
} else {
- Failure($client, "not_found\n", $userinput);
+ &Failure($client, "not_found\n", $userinput);
}
return 1;
}
-RegisterHandler("home", \&IsHomeHandler, 0,1,0);
+®ister_handler("home", \&is_home_handler, 0,1,0);
+
#
-# Process an update request for a resource?? I think what's going on here is
-# that a resource has been modified that we hold a subscription to.
+# Process an update request for a resource.
+# A resource has been modified that we hold a subscription to.
# If the resource is not local, then we must update, or at least invalidate our
# cached copy of the resource.
-# FUTURE WORK:
-# I need to look at this logic carefully. My druthers would be to follow
-# typical caching logic, and simple invalidate the cache, drop any subscription
-# an let the next fetch start the ball rolling again... however that may
-# actually be more difficult than it looks given the complex web of
-# proxy servers.
# Parameters:
# $cmd - The command that got us here.
# $tail - Tail of the command (remaining parameters).
@@ -1128,27 +2119,37 @@ RegisterHandler("home", \&IsHomeHandler,
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub UpdateResourceHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub update_resource_handler {
+
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
- my $fname=$tail;
+ my $fname= $tail; # This allows interactive testing
+
+
my $ownership=ishome($fname);
if ($ownership eq 'not_owner') {
if (-e $fname) {
+ # Delete preview file, if exists
+ unlink("$fname.tmp");
+ # Get usage stats
my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
$atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
my $now=time;
my $since=$now-$atime;
+ # If the file has not been used within lonExpire seconds,
+ # unsubscribe from it and delete local copy
if ($since>$perlvar{'lonExpire'}) {
- my $reply=&reply("unsub:$fname","$clientname");
+ my $reply=&Apache::lonnet::reply("unsub:$fname","$clientname");
+ &devalidate_meta_cache($fname);
unlink("$fname");
+ unlink("$fname.meta");
} else {
+ # Yes, this is in active use. Get a fresh copy. Since it might be in
+ # very active use and huge (like a movie), copy it to "in.transfer" filename first.
my $transname="$fname.in.transfer";
- my $remoteurl=&reply("sub:$fname","$clientname");
+ my $remoteurl=&Apache::lonnet::reply("sub:$fname","$clientname");
my $response;
alarm(120);
{
@@ -1174,22 +2175,35 @@ sub UpdateResourceHandler {
}
alarm(0);
}
+ # we successfully transfered, copy file over to real name
rename($transname,$fname);
+ &devalidate_meta_cache($fname);
}
}
- Reply( $client, "ok\n", $userinput);
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "not_found\n", $userinput);
+ &Failure($client, "not_found\n", $userinput);
}
} else {
- Failure($client, "rejected\n", $userinput);
+ &Failure($client, "rejected\n", $userinput);
}
return 1;
}
-RegisterHandler("update", \&UpdateResourceHandler, 0 ,1, 0);
+®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
+
+sub devalidate_meta_cache {
+ my ($url) = @_;
+ use Cache::Memcached;
+ my $memcache = new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
+ $url = &Apache::lonnet::declutter($url);
+ $url =~ s-\.meta$--;
+ my $id = &escape('meta:'.$url);
+ $memcache->delete($id);
+}
#
-# Fetch a user file from a remote server:
+# Fetch a user file from a remote server to the user's home directory
+# userfiles subdir.
# Parameters:
# $cmd - The command that got us here.
# $tail - Tail of the command (remaining parameters).
@@ -1198,25 +2212,34 @@ RegisterHandler("update", \&UpdateResour
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub FetchUserFileHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub fetch_user_file_handler {
+
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my $fname = $tail;
- my ($udom,$uname,$ufile)=split(/\//,$fname);
- my $udir=propath($udom,$uname).'/userfiles';
+ my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
+ my $udir=&propath($udom,$uname).'/userfiles';
unless (-e $udir) {
mkdir($udir,0770);
}
+ Debug("fetch user file for $fname");
if (-e $udir) {
$ufile=~s/^[\.\~]+//;
- $ufile=~s/\///g;
+
+ # IF necessary, create the path right down to the file.
+ # Note that any regular files in the way of this path are
+ # wiped out to deal with some earlier folly of mine.
+
+ if (!&mkpath($udir.'/'.$ufile)) {
+ &Failure($client, "unable_to_create\n", $userinput);
+ }
+
my $destname=$udir.'/'.$ufile;
my $transname=$udir.'/'.$ufile.'.in.transit';
my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
my $response;
+ Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
alarm(120);
{
my $ua=new LWP::UserAgent;
@@ -1228,59 +2251,226 @@ sub FetchUserFileHandler {
unlink($transname);
my $message=$response->status_line;
&logthis("LWP GET: $message for $fname ($remoteurl)");
- Failure($client, "failed\n", $userinput);
+ &Failure($client, "failed\n", $userinput);
} else {
+ Debug("Renaming $transname to $destname");
if (!rename($transname,$destname)) {
&logthis("Unable to move $transname to $destname");
unlink($transname);
- Failure($client, "failed\n", $userinput);
+ &Failure($client, "failed\n", $userinput);
} else {
- Reply($client, "ok\n", $userinput);
+ &Reply($client, "ok\n", $userinput);
}
}
} else {
- Failure($client, "not_home\n", $userinput);
+ &Failure($client, "not_home\n", $userinput);
+ }
+ return 1;
+}
+®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
+
+#
+# Remove a file from a user's home directory userfiles subdirectory.
+# Parameters:
+# cmd - the Lond request keyword that got us here.
+# tail - the part of the command past the keyword.
+# client- File descriptor connected with the client.
+#
+# Returns:
+# 1 - Continue processing.
+sub remove_user_file_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
+
+ my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
+ if ($ufile =~m|/\.\./|) {
+ # any files paths with /../ in them refuse
+ # to deal with
+ &Failure($client, "refused\n", "$cmd:$tail");
+ } else {
+ my $udir = &propath($udom,$uname);
+ if (-e $udir) {
+ my $file=$udir.'/userfiles/'.$ufile;
+ if (-e $file) {
+ #
+ # If the file is a regular file unlink is fine...
+ # However it's possible the client wants a dir.
+ # removed, in which case rmdir is more approprate:
+ #
+ if (-f $file){
+ unlink($file);
+ } elsif(-d $file) {
+ rmdir($file);
+ }
+ if (-e $file) {
+ # File is still there after we deleted it ?!?
+
+ &Failure($client, "failed\n", "$cmd:$tail");
+ } else {
+ &Reply($client, "ok\n", "$cmd:$tail");
+ }
+ } else {
+ &Failure($client, "not_found\n", "$cmd:$tail");
+ }
+ } else {
+ &Failure($client, "not_home\n", "$cmd:$tail");
+ }
}
return 1;
}
-RegisterHandler("fetchuserfile", \&FetchUserFileHandler, 0, 1, 0);
+®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
+
+#
+# make a directory in a user's home directory userfiles subdirectory.
+# Parameters:
+# cmd - the Lond request keyword that got us here.
+# tail - the part of the command past the keyword.
+# client- File descriptor connected with the client.
#
-# Authenticate access to a user file. Question? The token for athentication
-# is allowed to be sent as cleartext is this really what we want? This token
-# represents the user's session id. Once it is forged does this allow too much
-# access??
+# Returns:
+# 1 - Continue processing.
+sub mkdir_user_file_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my ($dir) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
+ $dir=&unescape($dir);
+ my ($udom,$uname,$ufile) = ($dir =~ m|^([^/]+)/([^/]+)/(.+)$|);
+ if ($ufile =~m|/\.\./|) {
+ # any files paths with /../ in them refuse
+ # to deal with
+ &Failure($client, "refused\n", "$cmd:$tail");
+ } else {
+ my $udir = &propath($udom,$uname);
+ if (-e $udir) {
+ my $newdir=$udir.'/userfiles/'.$ufile.'/';
+ if (!&mkpath($newdir)) {
+ &Failure($client, "failed\n", "$cmd:$tail");
+ }
+ &Reply($client, "ok\n", "$cmd:$tail");
+ } else {
+ &Failure($client, "not_home\n", "$cmd:$tail");
+ }
+ }
+ return 1;
+}
+®ister_handler("mkdiruserfile", \&mkdir_user_file_handler, 0,1,0);
+
#
+# rename a file in a user's home directory userfiles subdirectory.
# Parameters:
-# $cmd - The command that got us here.
-# $tail - Tail of the command (remaining parameters).
-# $client - File descriptor connected to client.
-# Returns
-# 0 - Requested to exit, caller should shut down.
-# 1 - Continue processing.
-sub AuthenticateUserFileAccess {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
- my $userinput = "$cmd:$tail";
+# cmd - the Lond request keyword that got us here.
+# tail - the part of the command past the keyword.
+# client- File descriptor connected with the client.
+#
+# Returns:
+# 1 - Continue processing.
+sub rename_user_file_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my ($udom,$uname,$old,$new) = split(/:/, $tail);
+ $old=&unescape($old);
+ $new=&unescape($new);
+ if ($new =~m|/\.\./| || $old =~m|/\.\./|) {
+ # any files paths with /../ in them refuse to deal with
+ &Failure($client, "refused\n", "$cmd:$tail");
+ } else {
+ my $udir = &propath($udom,$uname);
+ if (-e $udir) {
+ my $oldfile=$udir.'/userfiles/'.$old;
+ my $newfile=$udir.'/userfiles/'.$new;
+ if (-e $newfile) {
+ &Failure($client, "exists\n", "$cmd:$tail");
+ } elsif (! -e $oldfile) {
+ &Failure($client, "not_found\n", "$cmd:$tail");
+ } else {
+ if (!rename($oldfile,$newfile)) {
+ &Failure($client, "failed\n", "$cmd:$tail");
+ } else {
+ &Reply($client, "ok\n", "$cmd:$tail");
+ }
+ }
+ } else {
+ &Failure($client, "not_home\n", "$cmd:$tail");
+ }
+ }
+ return 1;
+}
+®ister_handler("renameuserfile", \&rename_user_file_handler, 0,1,0);
+
+#
+# Checks if the specified user has an active session on the server
+# return ok if so, not_found if not
+#
+# Parameters:
+# cmd - The request keyword that dispatched to tus.
+# tail - The tail of the request (colon separated parameters).
+# client - Filehandle open on the client.
+# Return:
+# 1.
+sub user_has_session_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my ($udom, $uname) = map { &unescape($_) } (split(/:/, $tail));
+
+ &logthis("Looking for $udom $uname");
+ opendir(DIR,$perlvar{'lonIDsDir'});
+ my $filename;
+ while ($filename=readdir(DIR)) {
+ last if ($filename=~/^\Q$uname\E_\d+_\Q$udom\E_/);
+ }
+ if ($filename) {
+ &Reply($client, "ok\n", "$cmd:$tail");
+ } else {
+ &Failure($client, "not_found\n", "$cmd:$tail");
+ }
+ return 1;
- my ($fname,$session)=split(/:/,$tail);
+}
+®ister_handler("userhassession", \&user_has_session_handler, 0,1,0);
+
+#
+# Authenticate access to a user file by checking that the token the user's
+# passed also exists in their session file
+#
+# Parameters:
+# cmd - The request keyword that dispatched to tus.
+# tail - The tail of the request (colon separated parameters).
+# client - Filehandle open on the client.
+# Return:
+# 1.
+sub token_auth_user_file_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my ($fname, $session) = split(/:/, $tail);
+
chomp($session);
- my $reply='non_auth';
- if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.$session.'.id')) {
- while (my $line=<ENVIN>) {
- if ($line=~/userfile\.$fname\=/) {
- $reply='ok';
+ my $reply="non_auth";
+ my $file = $perlvar{'lonIDsDir'}.'/'.$session.'.id';
+ if (open(ENVIN,"$file")) {
+ flock(ENVIN,LOCK_SH);
+ tie(my %disk_env,'GDBM_File',"$file",&GDBM_READER(),0640);
+ if (exists($disk_env{"userfile.$fname"})) {
+ $reply="ok";
+ } else {
+ foreach my $envname (keys(%disk_env)) {
+ if ($envname=~ m|^userfile\.\Q$fname\E|) {
+ $reply="ok";
+ last;
+ }
}
}
+ untie(%disk_env);
close(ENVIN);
- Reply($client, $reply."\n", $userinput);
+ &Reply($client, \$reply, "$cmd:$tail");
} else {
- Failure($client, "invalid_token\n", $userinput);
+ &Failure($client, "invalid_token\n", "$cmd:$tail");
}
return 1;
-
+
}
-RegisterHandler("tokenauthuserfile", \&AuthenticateUserFileAccess, 0, 1, 0);
+®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
+
#
# Unsubscribe from a resource.
#
@@ -1292,23 +2482,25 @@ RegisterHandler("tokenauthuserfile", \&A
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub UnsubscribeHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub unsubscribe_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput= "$cmd:$tail";
- my $fname = $tail;
+ my ($fname) = split(/:/,$tail); # Split in case there's extrs.
+
+ &Debug("Unsubscribing $fname");
if (-e $fname) {
- Reply($client, &unsub($client,$fname,$clientip), $userinput);
+ &Debug("Exists");
+ &Reply($client, &unsub($fname,$clientip), $userinput);
} else {
- Failure($client, "not_found\n", $userinput);
+ &Failure($client, "not_found\n", $userinput);
}
return 1;
}
-RegisterHandler("unusb", \&UnsubscribeHandler, 0, 1, 0);
+®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
-# Subscribe to a resource.
+# Subscribe to a resource
#
# Parameters:
# $cmd - The command that got us here.
@@ -1318,44 +2510,41 @@ RegisterHandler("unusb", \&UnsubscribeHa
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub SubscribeHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub subscribe_handler {
+ my ($cmd, $tail, $client)= @_;
+
my $userinput = "$cmd:$tail";
- Reply( $client, &subscribe($userinput,$clientip), $userinput);
+ &Reply( $client, &subscribe($userinput,$clientip), $userinput);
return 1;
}
-RegisterHandler("sub", \&SubscribeHandler, 0, 1, 0);
+®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
#
-# Determine the version of a resource (?) Or is it return
-# the top version of the resource? Not yet clear from the
-# code in currentversion.
+# Determine the latest version of a resource (it looks for the highest
+# past version and then returns that +1)
#
# Parameters:
# $cmd - The command that got us here.
# $tail - Tail of the command (remaining parameters).
+# (Should consist of an absolute path to a file)
# $client - File descriptor connected to client.
# Returns
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub CurrentVersionHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub current_version_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput= "$cmd:$tail";
my $fname = $tail;
- Reply( $client, ¤tversion($fname)."\n", $userinput);
+ &Reply( $client, ¤tversion($fname)."\n", $userinput);
return 1;
}
-RegisterHandler("currentversion", \&CurrentVersionHandler, 0, 1, 0);
-
+®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
# Make an entry in a user's activity log.
#
@@ -1367,29 +2556,30 @@ RegisterHandler("currentversion", \&Curr
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub ActivityLogEntryHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub activity_log_handler {
+ my ($cmd, $tail, $client) = @_;
+
+
my $userinput= "$cmd:$tail";
my ($udom,$uname,$what)=split(/:/,$tail);
chomp($what);
- my $proname=propath($udom,$uname);
+ my $proname=&propath($udom,$uname);
my $now=time;
my $hfh;
if ($hfh=IO::File->new(">>$proname/activity.log")) {
print $hfh "$now:$clientname:$what\n";
- Reply( $client, "ok\n", $userinput);
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." IO::File->new Failed "
- ."while attempting log\n",
- $userinput);
+ &Failure($client, "error: ".($!+0)." IO::File->new Failed "
+ ."while attempting log\n",
+ $userinput);
}
return 1;
}
-RegisterHandler("log", \&ActivityLogEntryHandler, 0, 1, 0);
+®ister_handler("log", \&activity_log_handler, 0, 1, 0);
+
#
# Put a namespace entry in a user profile hash.
# My druthers would be for this to be an encrypted interaction too.
@@ -1404,16 +2594,15 @@ RegisterHandler("log", \&ActivityLogEntr
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub PutUserProfileEntry {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub put_user_profile_entry {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
+ my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
if ($namespace ne 'roles') {
chomp($what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
&GDBM_WRCREAT(),"P",$what);
if($hashref) {
my @pairs=split(/\&/,$what);
@@ -1421,24 +2610,79 @@ sub PutUserProfileEntry {
my ($key,$value)=split(/=/,$pair);
$hashref->{$key}=$value;
}
- if (untie(%$hashref)) {
- Reply( $client, "ok\n", $userinput);
+ if (&untie_user_hash($hashref)) {
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
"while attempting put\n",
$userinput);
}
} else {
- Failure( $client, "error: ".($!)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting put\n", $userinput);
}
} else {
- Failure( $client, "refused\n", $userinput);
+ &Failure( $client, "refused\n", $userinput);
}
return 1;
}
-RegisterHandler("put", \&PutUserProfileEntry, 0, 1, 0);
+®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
+
+# Put a piece of new data in hash, returns error if entry already exists
+# Parameters:
+# $cmd - The command that got us here.
+# $tail - Tail of the command (remaining parameters).
+# $client - File descriptor connected to client.
+# Returns
+# 0 - Requested to exit, caller should shut down.
+# 1 - Continue processing.
+#
+sub newput_user_profile_entry {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = "$cmd:$tail";
+
+ my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
+ if ($namespace eq 'roles') {
+ &Failure( $client, "refused\n", $userinput);
+ return 1;
+ }
+
+ chomp($what);
+
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(),"N",$what);
+ if(!$hashref) {
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting put\n", $userinput);
+ return 1;
+ }
+
+ my @pairs=split(/\&/,$what);
+ foreach my $pair (@pairs) {
+ my ($key,$value)=split(/=/,$pair);
+ if (exists($hashref->{$key})) {
+ &Failure($client, "key_exists: ".$key."\n",$userinput);
+ return 1;
+ }
+ }
+
+ foreach my $pair (@pairs) {
+ my ($key,$value)=split(/=/,$pair);
+ $hashref->{$key}=$value;
+ }
+
+ if (&untie_user_hash($hashref)) {
+ &Reply( $client, "ok\n", $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
+ "while attempting put\n",
+ $userinput);
+ }
+ return 1;
+}
+®ister_handler("newput", \&newput_user_profile_entry, 0, 1, 0);
#
# Increment a profile entry in the user history file.
@@ -1455,45 +2699,51 @@ RegisterHandler("put", \&PutUserProfileE
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub IncrementUserValueHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub increment_user_value_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
-
+
my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
if ($namespace ne 'roles') {
chomp($what);
- my $hashref = TieUserHash($udom, $uname,
- $namespace, &GDBM_WRCREAT(),
- "P",$what);
+ my $hashref = &tie_user_hash($udom, $uname,
+ $namespace, &GDBM_WRCREAT(),
+ "P",$what);
if ($hashref) {
my @pairs=split(/\&/,$what);
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
+ $value = &unescape($value);
# We could check that we have a number...
if (! defined($value) || $value eq '') {
$value = 1;
}
$hashref->{$key}+=$value;
+ if ($namespace eq 'nohist_resourcetracker') {
+ if ($hashref->{$key} < 0) {
+ $hashref->{$key} = 0;
+ }
+ }
}
- if (untie(%$hashref)) {
- Reply( $client, "ok\n", $userinput);
+ if (&untie_user_hash($hashref)) {
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
- "while attempting inc\n", $userinput);
+ &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
+ "while attempting inc\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting inc\n", $userinput);
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting inc\n", $userinput);
}
} else {
- Failure($client, "refused\n", $userinput);
+ &Failure($client, "refused\n", $userinput);
}
return 1;
}
-RegisterHandler("inc", \&IncrementUserValueHandler, 0, 1, 0);
+®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
+
#
# Put a new role for a user. Roles are LonCAPA's packaging of permissions.
# Each 'role' a user has implies a set of permissions. Adding a new role
@@ -1514,46 +2764,49 @@ RegisterHandler("inc", \&IncrementUserVa
# 1 - To continue processing.
#
#
-sub RolesPutHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub roles_put_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($exedom,$exeuser,$udom,$uname,$what) =split(/:/,$tail);
- &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
- "what = ".$what);
+ my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
+
+
my $namespace='roles';
chomp($what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_WRCREAT(), "P",
- "$exedom:$exeuser:$what");
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "P",
+ "$exedom:$exeuser:$what");
#
# Log the attempt to set a role. The {}'s here ensure that the file
# handle is open for the minimal amount of time. Since the flush
# is done on close this improves the chances the log will be an un-
# corrupted ordered thing.
if ($hashref) {
+ my $pass_entry = &get_auth_type($udom, $uname);
+ my ($auth_type,$pwd) = split(/:/, $pass_entry);
+ $auth_type = $auth_type.":";
my @pairs=split(/\&/,$what);
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
- &ManagePermissions($key, $udom, $uname,
- &GetAuthType( $udom, $uname));
+ &manage_permissions($key, $udom, $uname,
+ $auth_type);
$hashref->{$key}=$value;
}
- if (untie($hashref)) {
- Reply($client, "ok\n", $userinput);
+ if (&untie_user_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting rolesput\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting rolesput\n", $userinput);
}
return 1;
}
-RegisterHandler("rolesput", \&RolesPutHandler, 1,1,0); # Encoded client only.
+®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
+
#
# Deletes (removes) a role for a user. This is equivalent to removing
# a permissions package associated with the role from the user's profile.
@@ -1571,10 +2824,9 @@ RegisterHandler("rolesput", \&RolesPutHa
# 1 - Continue processing
# 0 - Exit.
#
-sub RolesDeleteHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub roles_delete_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
@@ -1582,9 +2834,9 @@ sub RolesDeleteHandler {
"what = ".$what);
my $namespace='roles';
chomp($what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_WRCREAT(), "D",
- "$exedom:$exeuser:$what");
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "D",
+ "$exedom:$exeuser:$what");
if ($hashref) {
my @rolekeys=split(/\&/,$what);
@@ -1592,20 +2844,20 @@ sub RolesDeleteHandler {
foreach my $key (@rolekeys) {
delete $hashref->{$key};
}
- if (untie(%$hashref)) {
- Reply($client, "ok\n", $userinput);
+ if (&untie_user_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting rolesdel\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting rolesdel\n", $userinput);
}
return 1;
}
-RegisterHandler("rolesdel", \&RolesDeleteHandler, 1,1, 0); # Encoded client only
+®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
# Unencrypted get from a user's profile database. See
# GetProfileEntryEncrypted for a version that does end-to-end encryption.
@@ -1626,42 +2878,28 @@ RegisterHandler("rolesdel", \&RolesDelet
# 1 - Continue processing.
# 0 - Exit.
#
-sub GetProfileEntry {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_profile_entry {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput= "$cmd:$tail";
my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
chomp($what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_READER());
- if ($hashref) {
- my @queries=split(/\&/,$what);
- my $qresult='';
-
- for (my $i=0;$i<=$#queries;$i++) {
- $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
- }
- $qresult=~s/\&$//; # Remove trailing & from last lookup.
- if (untie(%$hashref)) {
- Reply($client, "$qresult\n", $userinput);
- } else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting get\n", $userinput);
- }
+
+
+ my $replystring = read_profile($udom, $uname, $namespace, $what);
+ my ($first) = split(/:/,$replystring);
+ if($first ne "error") {
+ &Reply($client, \$replystring, $userinput);
} else {
- if ($!+0 == 2) { # +0 coerces errno -> number 2 is ENOENT
- Failure($client, "error:No such file or ".
- "GDBM reported bad block error\n", $userinput);
- } else { # Some other undifferentiated err.
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting get\n", $userinput);
- }
+ &Failure($client, $replystring." while attempting get\n", $userinput);
}
return 1;
+
+
}
-RegisterHandler("get", \&GetProfileEntry, 0,1,0);
+®ister_handler("get", \&get_profile_entry, 0,1,0);
+
#
# Process the encrypted get request. Note that the request is sent
# in clear, but the reply is encrypted. This is a small covert channel:
@@ -1681,50 +2919,39 @@ RegisterHandler("get", \&GetProfileEntry
# Returns:
# 1 - Continue processing
# 0 - server should exit.
-sub GetProfileEntryEncrypted {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_profile_entry_encrypted {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($cmd,$udom,$uname,$namespace,$what) = split(/:/,$userinput);
+ my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
chomp($what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_READER());
- if ($hashref) {
- my @queries=split(/\&/,$what);
- my $qresult='';
- for (my $i=0;$i<=$#queries;$i++) {
- $qresult.="$hashref->{$queries[$i]}&";
- }
- if (untie(%$hashref)) {
- $qresult=~s/\&$//;
- if ($cipher) {
- my $cmdlength=length($qresult);
- $qresult.=" ";
- my $encqresult='';
- for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
- $encqresult.= unpack("H16",
- $cipher->encrypt(substr($qresult,
- $encidx,
- 8)));
- }
- Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
- } else {
- Failure( $client, "error:no_key\n", $userinput);
+ my $qresult = read_profile($udom, $uname, $namespace, $what);
+ my ($first) = split(/:/, $qresult);
+ if($first ne "error") {
+
+ if ($cipher) {
+ my $cmdlength=length($qresult);
+ $qresult.=" ";
+ my $encqresult='';
+ for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
+ $encqresult.= unpack("H16",
+ $cipher->encrypt(substr($qresult,
+ $encidx,
+ 8)));
}
+ &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting eget\n", $userinput);
- }
+ &Failure( $client, "error:no_key\n", $userinput);
+ }
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting eget\n", $userinput);
+ &Failure($client, "$qresult while attempting eget\n", $userinput);
+
}
return 1;
}
-RegisterHandler("eget", \&GetProfileEncrypted, 0, 1, 0);
+®ister_handler("eget", \&get_profile_entry_encrypted, 0, 1, 0);
#
# Deletes a key in a user profile database.
@@ -1744,36 +2971,35 @@ RegisterHandler("eget", \&GetProfileEncr
# 0 - Exit server.
#
#
+sub delete_profile_entry {
+ my ($cmd, $tail, $client) = @_;
-sub DeleteProfileEntry {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
my $userinput = "cmd:$tail";
my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
chomp($what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_WRCREAT(),
- "D",$what);
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(),
+ "D",$what);
if ($hashref) {
my @keys=split(/\&/,$what);
foreach my $key (@keys) {
delete($hashref->{$key});
}
- if (untie(%$hashref)) {
- Reply($client, "ok\n", $userinput);
+ if (&untie_user_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting del\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting del\n", $userinput);
}
return 1;
}
-RegisterHandler("del", \&DeleteProfileEntry, 0, 1, 0);
+®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
+
#
# List the set of keys that are defined in a profile database file.
# A successful reply from this will contain an & separated list of
@@ -1789,35 +3015,35 @@ RegisterHandler("del", \&DeleteProfileEn
# 1 - Continue processing.
# 0 - Exit the server.
#
-sub GetProfileKeys {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_profile_keys {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($udom,$uname,$namespace)=split(/:/,$tail);
my $qresult='';
- my $hashref = TieUserHash($udom, $uname, $namespace,
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
&GDBM_READER());
if ($hashref) {
foreach my $key (keys %$hashref) {
$qresult.="$key&";
}
- if (untie(%$hashref)) {
+ if (&untie_user_hash($hashref)) {
$qresult=~s/\&$//;
- Reply($client, "$qresult\n", $userinput);
+ &Reply($client, \$qresult, $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting keys\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting keys\n", $userinput);
}
return 1;
}
-RegisterHandler("keys", \&GetProfileKeys, 0, 1, 0);
+®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
+
#
# Dump the contents of a user profile database.
# Note that this constitutes a very large covert channel too since
@@ -1837,15 +3063,14 @@ RegisterHandler("keys", \&GetProfileKeys
# 1 - Continue processing.
# 0 - Exit the server.
#
-sub DumpProfileDatabase {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub dump_profile_database {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($udom,$uname,$namespace) = split(/:/,$tail);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_READER());
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
if ($hashref) {
# Structure of %data:
# $data{$symb}->{$parameter}=$value;
@@ -1864,7 +3089,7 @@ sub DumpProfileDatabase {
$data{$symb}->{$param}=$value;
$data{$symb}->{'v.'.$param}=$v;
}
- if (untie(%$hashref)) {
+ if (&untie_user_hash($hashref)) {
while (my ($symb,$param_hash) = each(%data)) {
while(my ($param,$value) = each (%$param_hash)){
next if ($param =~ /^v\./); # Ignore versions...
@@ -1875,19 +3100,20 @@ sub DumpProfileDatabase {
}
}
chop($qresult);
- Reply($client , "$qresult\n", $userinput);
+ &Reply($client , \$qresult, $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting currentdump\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting currentdump\n", $userinput);
}
return 1;
}
-RegisterHandler("currentdump", \&DumpProfileDatabase, 0, 1, 0);
+®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
+
#
# Dump a profile database with an optional regular expression
# to match against the keys. In this dump, no effort is made
@@ -1912,50 +3138,108 @@ RegisterHandler("currentdump", \&DumpPro
# Side effects:
# response is written to $client.
#
-sub DumpWithRegexp {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub dump_with_regexp {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($udom,$uname,$namespace,$regexp)=split(/:/,$tail);
+ my ($udom,$uname,$namespace,$regexp,$range,$extra)=split(/:/,$tail);
if (defined($regexp)) {
$regexp=&unescape($regexp);
} else {
$regexp='.';
}
- my $hashref =TieUserHash($udom, $uname, $namespace,
+ my ($start,$end);
+ if (defined($range)) {
+ if ($range =~/^(\d+)\-(\d+)$/) {
+ ($start,$end) = ($1,$2);
+ } elsif ($range =~/^(\d+)$/) {
+ ($start,$end) = (0,$1);
+ } else {
+ undef($range);
+ }
+ }
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
&GDBM_READER());
+ my $clientcheckrole;
if ($hashref) {
my $qresult='';
+ my $count=0;
+ if ($extra ne '') {
+ $extra = &Apache::lonnet::thaw_unescape($extra);
+ $clientcheckrole = $extra->{'clientcheckrole'};
+ }
+ my @ids = &Apache::lonnet::current_machine_ids();
while (my ($key,$value) = each(%$hashref)) {
+ if ($namespace eq 'roles') {
+ if ($key =~ m{^/($LONCAPA::match_domain)/($LONCAPA::match_courseid)_(cc|co|in|ta|ep|ad|st|cr)}) {
+ my $cdom = $1;
+ my $cnum = $2;
+ unless ($clientcheckrole) {
+ my $home = &Apache::lonnet::homeserver($cnum,$cdom);
+ my $loncaparev = $clientversion;
+ if ($loncaparev eq '') {
+ $loncaparev = $Apache::lonnet::loncaparevs{$clientname};
+ }
+ my ($major,$minor);
+ if ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\d.\-]+\'?/) {
+ $major = $1;
+ $minor = $2;
+ }
+ if ($key =~ m{^/($LONCAPA::match_domain)/($LONCAPA::match_community)_(co|in|ta|ep|ad|st|cr)}) {
+ if ($major eq '' && $minor eq '') {
+ next unless (($home ne 'no_host') && grep(/^\Q$home\E$/,@ids));
+ }
+ }
+ unless ($home eq 'no_host') {
+ my $courseinfo = &get_courseinfo_hash($cnum,$cdom,$home);
+ if (ref($courseinfo) eq 'HASH') {
+ if (exists($courseinfo->{'releaserequired'})) {
+ my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
+ if ($reqdmajor ne '' && $reqdminor ne '') {
+ next if (($major eq '' && $minor eq '') ||
+ ($major < $reqdmajor) ||
+ (($major == $reqdmajor) && ($minor < $reqdminor)));
+ }
+ }
+ }
+ }
+ }
+ }
+ }
if ($regexp eq '.') {
+ $count++;
+ if (defined($range) && $count >= $end) { last; }
+ if (defined($range) && $count < $start) { next; }
$qresult.=$key.'='.$value.'&';
} else {
my $unescapeKey = &unescape($key);
if (eval('$unescapeKey=~/$regexp/')) {
+ $count++;
+ if (defined($range) && $count >= $end) { last; }
+ if (defined($range) && $count < $start) { next; }
$qresult.="$key=$value&";
}
}
}
- if (untie(%$hashref)) {
+ if (&untie_user_hash($hashref)) {
chop($qresult);
- Reply($client, "$qresult\n", $userinput);
+ &Reply($client, \$qresult, $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting dump\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting dump\n", $userinput);
}
return 1;
}
-RegisterHandler("dump", \&DumpWithRegexp, 0, 1, 0);
+®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
-# Store an aitem in any database but the roles database.
+# Store a set of key=value pairs associated with a versioned name.
#
# Parameters:
# $cmd - Request command keyword.
@@ -1973,10 +3257,8 @@ RegisterHandler("dump", \&DumpWithRegexp
# 1 (keep on processing).
# Side-Effects:
# Writes to the client
-sub StoreHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub store_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
@@ -1985,8 +3267,8 @@ sub StoreHandler {
chomp($what);
my @pairs=split(/\&/,$what);
- my $hashref = TieUserHash($udom, $uname, $namespace,
- &GDBM_WRCREAT(), "P",
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "S",
"$rid:$what");
if ($hashref) {
my $now = time;
@@ -2003,25 +3285,107 @@ sub StoreHandler {
$hashref->{"$version:$rid:timestamp"}=$now;
$allkeys.='timestamp';
$hashref->{"$version:keys:$rid"}=$allkeys;
- if (untie($hashref)) {
- Reply($client, "ok\n", $userinput);
+ if (&untie_user_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting store\n", $userinput);
+ }
+ } else {
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting store\n", $userinput);
+ }
+ } else {
+ &Failure($client, "refused\n", $userinput);
+ }
+
+ return 1;
+}
+®ister_handler("store", \&store_handler, 0, 1, 0);
+
+# Modify a set of key=value pairs associated with a versioned name.
+#
+# Parameters:
+# $cmd - Request command keyword.
+# $tail - Tail of the request. This is a colon
+# separated list containing:
+# domain/user - User and authentication domain.
+# namespace - Name of the database being modified
+# rid - Resource keyword to modify.
+# v - Version item to modify
+# what - new value associated with rid.
+#
+# $client - Socket open on the client.
+#
+#
+# Returns:
+# 1 (keep on processing).
+# Side-Effects:
+# Writes to the client
+sub putstore_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = "$cmd:$tail";
+
+ my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
+ if ($namespace ne 'roles') {
+
+ chomp($what);
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "M",
+ "$rid:$v:$what");
+ if ($hashref) {
+ my $now = time;
+ my %data = &hash_extract($what);
+ my @allkeys;
+ while (my($key,$value) = each(%data)) {
+ push(@allkeys,$key);
+ $hashref->{"$v:$rid:$key"} = $value;
+ }
+ my $allkeys = join(':',@allkeys);
+ $hashref->{"$v:keys:$rid"}=$allkeys;
+
+ if (&untie_user_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting store\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting store\n", $userinput);
}
} else {
- Failure($client, "refused\n", $userinput);
+ &Failure($client, "refused\n", $userinput);
}
return 1;
}
-RegisterHandler("store", \&StoreHandler, 0, 1, 0);
+®ister_handler("putstore", \&putstore_handler, 0, 1, 0);
+
+sub hash_extract {
+ my ($str)=@_;
+ my %hash;
+ foreach my $pair (split(/\&/,$str)) {
+ my ($key,$value)=split(/=/,$pair);
+ $hash{$key}=$value;
+ }
+ return (%hash);
+}
+sub hash_to_str {
+ my ($hash_ref)=@_;
+ my $str;
+ foreach my $key (keys(%$hash_ref)) {
+ $str.=$key.'='.$hash_ref->{$key}.'&';
+ }
+ $str=~s/\&$//;
+ return $str;
+}
+
#
-# Restore a prior version of a resource.
+# Dump out all versions of a resource that has key=value pairs associated
+# with it for each version. These resources are built up via the store
+# command.
#
# Parameters:
# $cmd - Command keyword.
@@ -2035,44 +3399,47 @@ RegisterHandler("store", \&StoreHandler,
# 1 indicating the caller should not yet exit.
# Side-effects:
# Writes a reply to the client.
+# The reply is a string of the following shape:
+# version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
+# Where the 1 above represents version 1.
+# this continues for all pairs of keys in all versions.
+#
#
-sub RestoreHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+#
+#
+sub restore_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail"; # Only used for logging purposes.
-
- my ($cmd,$udom,$uname,$namespace,$rid) = split(/:/,$userinput);
+ my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
$namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
+ $namespace = &LONCAPA::clean_username($namespace);
+
chomp($rid);
- my $proname=propath($udom,$uname);
my $qresult='';
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
- &GDBM_READER(),0640)) {
- my $version=$hash{"version:$rid"};
+ my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
+ if ($hashref) {
+ my $version=$hashref->{"version:$rid"};
$qresult.="version=$version&";
my $scope;
for ($scope=1;$scope<=$version;$scope++) {
- my $vkeys=$hash{"$scope:keys:$rid"};
+ my $vkeys=$hashref->{"$scope:keys:$rid"};
my @keys=split(/:/,$vkeys);
my $key;
$qresult.="$scope:keys=$vkeys&";
foreach $key (@keys) {
- $qresult.="$scope:$key=".$hash{"$scope:$rid:$key"}."&";
+ $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
}
}
- if (untie(%hash)) {
+ if (&untie_user_hash($hashref)) {
$qresult=~s/\&$//;
- Reply( $client, "$qresult\n", $userinput);
+ &Reply( $client, \$qresult, $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting restore\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting restore\n", $userinput);
}
@@ -2080,18 +3447,20 @@ sub RestoreHandler {
}
-RegisterHandler("restore", \&RestoreHandler, 0,1,0);
+®ister_handler("restore", \&restore_handler, 0,1,0);
#
-# Add a chat message to to a discussion board.
+# Add a chat message to a synchronous discussion board.
#
# Parameters:
# $cmd - Request keyword.
# $tail - Tail of the command. A colon separated list
# containing:
# cdom - Domain on which the chat board lives
-# cnum - Identifier of the discussion group.
-# post - Body of the posting.
+# cnum - Course containing the chat board.
+# newpost - Body of the posting.
+# group - Optional group, if chat board is only
+# accessible in a group within the course
# $client - Socket open on the client.
# Returns:
# 1 - Indicating caller should keep on processing.
@@ -2100,22 +3469,22 @@ RegisterHandler("restore", \&RestoreHand
# writes a reply to the client.
#
#
-sub SendChatHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub send_chat_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($cdom,$cnum,$newpost)=split(/\:/,$tail);
- &chatadd($cdom,$cnum,$newpost);
- Reply($client, "ok\n", $userinput);
+ my ($cdom,$cnum,$newpost,$group)=split(/\:/,$tail);
+ &chat_add($cdom,$cnum,$newpost,$group);
+ &Reply($client, "ok\n", $userinput);
return 1;
}
-RegisterHandler("chatsend", \&SendChatHandler, 0, 1, 0);
+®ister_handler("chatsend", \&send_chat_handler, 0, 1, 0);
+
#
-# Retrieve the set of chat messagss from a discussion board.
+# Retrieve the set of chat messages from a discussion board.
#
# Parameters:
# $cmd - Command keyword that initiated the request.
@@ -2125,31 +3494,33 @@ RegisterHandler("chatsend", \&SendChatHa
# chat id - Discussion thread(?)
# domain/user - Authentication domain and username
# of the requesting person.
+# group - Optional course group containing
+# the board.
# $client - Socket open on the client program.
# Returns:
# 1 - continue processing
# Side effects:
# Response is written to the client.
#
-sub RetrieveChatHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub retrieve_chat_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($cdom,$cnum,$udom,$uname)=split(/\:/,$tail);
+ my ($cdom,$cnum,$udom,$uname,$group)=split(/\:/,$tail);
my $reply='';
- foreach (&getchat($cdom,$cnum,$udom,$uname)) {
+ foreach (&get_chat($cdom,$cnum,$udom,$uname,$group)) {
$reply.=&escape($_).':';
}
$reply=~s/\:$//;
- Reply($client, $reply."\n", $userinput);
+ &Reply($client, \$reply, $userinput);
return 1;
}
-RegisterHandler("chatretr", \&RetrieveChatHandler, 0, 1, 0);
+®ister_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
+
#
# Initiate a query of an sql database. SQL query repsonses get put in
# a file for later retrieval. This prevents sql query results from
@@ -2169,22 +3540,21 @@ RegisterHandler("chatretr", \&RetrieveCh
# Side-effects:
# a reply is written to $client.
#
-sub SendQueryHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub send_query_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
$query=~s/\n*$//g;
- Reply($client, "". sqlreply("$clientname\&$query".
+ &Reply($client, "". &sql_reply("$clientname\&$query".
"\&$arg1"."\&$arg2"."\&$arg3")."\n",
$userinput);
return 1;
}
-RegisterHandler("querysend", \&SendQueryHandler, 0, 1, 0);
+®ister_handler("querysend", \&send_query_handler, 0, 1, 0);
#
# Add a reply to an sql query. SQL queries are done asyncrhonously.
@@ -2211,14 +3581,13 @@ RegisterHandler("querysend", \&SendQuery
# Side effects:
# ok written to the client.
#
-sub ReplyQueryHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub reply_query_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($cmd,$id,$reply)=split(/:/,$userinput);
+ my ($id,$reply)=split(/:/,$tail);
my $store;
my $execdir=$perlvar{'lonDaemons'};
if ($store=IO::File->new(">$execdir/tmp/$id")) {
@@ -2228,9 +3597,9 @@ sub ReplyQueryHandler {
my $store2=IO::File->new(">$execdir/tmp/$id.end");
print $store2 "done\n";
close $store2;
- Reply($client, "ok\n", $userinput);
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)
+ &Failure($client, "error: ".($!+0)
." IO::File->new Failed ".
"while attempting queryreply\n", $userinput);
}
@@ -2238,9 +3607,10 @@ sub ReplyQueryHandler {
return 1;
}
-RegisterHandler("queryreply", \&ReplyQueryHandler, 0, 1, 0);
+®ister_handler("queryreply", \&reply_query_handler, 0, 1, 0);
+
#
-# Process the courseidput query. Not quite sure what this means
+# Process the courseidput request. Not quite sure what this means
# at the system level sense. It appears a gdbm file in the
# /home/httpd/lonUsers/$domain/nohist_courseids is tied and
# a set of entries made in that database.
@@ -2250,6 +3620,14 @@ RegisterHandler("queryreply", \&ReplyQue
# $tail - Tail of the command. In this case consists of a colon
# separated list contaning the domain to apply this to and
# an ampersand separated list of keyword=value pairs.
+# Each value is a colon separated list that includes:
+# description, institutional code and course owner.
+# For backward compatibility with versions included
+# in LON-CAPA 1.1.X (and earlier) and 1.2.X, institutional
+# code and/or course owner are preserved from the existing
+# record when writing a new record in response to 1.1 or
+# 1.2 implementations of lonnet::flushcourselogs().
+#
# $client - Socket open on the client.
# Returns:
# 1 - indicating that processing should continue
@@ -2257,40 +3635,115 @@ RegisterHandler("queryreply", \&ReplyQue
# Side effects:
# reply is written to the client.
#
-sub PutCourseIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub put_course_id_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($udom, $what) = split(/:/, $tail);
+ my ($udom, $what) = split(/:/, $tail,2);
chomp($what);
my $now=time;
my @pairs=split(/\&/,$what);
- my $hashref = TieDomainHash($udom, "nohist_courseids", &GDBM_WRCREAT());
+ my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
if ($hashref) {
foreach my $pair (@pairs) {
- my ($key,$value)=split(/=/,$pair);
- $hashref->{$key}=$value.':'.$now;
+ my ($key,$courseinfo) = split(/=/,$pair,2);
+ $courseinfo =~ s/=/:/g;
+ if (defined($hashref->{$key})) {
+ my $value = &Apache::lonnet::thaw_unescape($hashref->{$key});
+ if (ref($value) eq 'HASH') {
+ my @items = ('description','inst_code','owner','type');
+ my @new_items = split(/:/,$courseinfo,-1);
+ my %storehash;
+ for (my $i=0; $i<@new_items; $i++) {
+ $storehash{$items[$i]} = &unescape($new_items[$i]);
+ }
+ $hashref->{$key} =
+ &Apache::lonnet::freeze_escape(\%storehash);
+ my $unesc_key = &unescape($key);
+ $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
+ next;
+ }
+ }
+ my @current_items = split(/:/,$hashref->{$key},-1);
+ shift(@current_items); # remove description
+ pop(@current_items); # remove last access
+ my $numcurrent = scalar(@current_items);
+ if ($numcurrent > 3) {
+ $numcurrent = 3;
+ }
+ my @new_items = split(/:/,$courseinfo,-1);
+ my $numnew = scalar(@new_items);
+ if ($numcurrent > 0) {
+ if ($numnew <= $numcurrent) { # flushcourselogs() from pre 2.2
+ for (my $j=$numcurrent-$numnew; $j>=0; $j--) {
+ $courseinfo .= ':'.$current_items[$numcurrent-$j-1];
+ }
+ }
+ }
+ $hashref->{$key}=$courseinfo.':'.$now;
}
- if (untie(%$hashref)) {
- Reply($client, "ok\n", $userinput);
+ if (&untie_domain_hash($hashref)) {
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)
+ &Failure($client, "error: ".($!+0)
." untie(GDBM) Failed ".
"while attempting courseidput\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)
+ &Failure($client, "error: ".($!+0)
." tie(GDBM) Failed ".
"while attempting courseidput\n", $userinput);
}
return 1;
}
-RegisterHandler("courseidput", \&PutCourseIdHandler, 0, 1, 0);
+®ister_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
+
+sub put_course_id_hash_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($udom,$mode,$what) = split(/:/, $tail,3);
+ chomp($what);
+ my $now=time;
+ my @pairs=split(/\&/,$what);
+ my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
+ if ($hashref) {
+ foreach my $pair (@pairs) {
+ my ($key,$value)=split(/=/,$pair);
+ my $unesc_key = &unescape($key);
+ if ($mode ne 'timeonly') {
+ if (!defined($hashref->{&escape('lasttime:'.$unesc_key)})) {
+ my $curritems = &Apache::lonnet::thaw_unescape($key);
+ if (ref($curritems) ne 'HASH') {
+ my @current_items = split(/:/,$hashref->{$key},-1);
+ my $lasttime = pop(@current_items);
+ $hashref->{&escape('lasttime:'.$unesc_key)} = $lasttime;
+ } else {
+ $hashref->{&escape('lasttime:'.$unesc_key)} = '';
+ }
+ }
+ $hashref->{$key} = $value;
+ }
+ if ($mode ne 'notime') {
+ $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
+ }
+ }
+ if (&untie_domain_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting courseidputhash\n", $userinput);
+ }
+ } else {
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting courseidputhash\n", $userinput);
+ }
+ return 1;
+}
+®ister_handler("courseidputhash", \&put_course_id_hash_handler, 0, 1, 0);
# Retrieves the value of a course id resource keyword pattern
# defined since a starting date. Both the starting date and the
@@ -2310,59 +3763,544 @@ RegisterHandler("courseidput", \&PutCour
# description - regular expression that is used to filter
# the dump. Only keywords matching this regexp
# will be used.
+# institutional code - optional supplied code to filter
+# the dump. Only courses with an institutional code
+# that match the supplied code will be returned.
+# owner - optional supplied username and domain of owner to
+# filter the dump. Only courses for which the course
+# owner matches the supplied username and/or domain
+# will be returned. Pre-2.2.0 legacy entries from
+# nohist_courseiddump will only contain usernames.
+# type - optional parameter for selection
+# regexp_ok - if 1 or -1 allow the supplied institutional code
+# filter to behave as a regular expression:
+# 1 will not exclude the course if the instcode matches the RE
+# -1 will exclude the course if the instcode matches the RE
+# rtn_as_hash - whether to return the information available for
+# each matched item as a frozen hash of all
+# key, value pairs in the item's hash, or as a
+# colon-separated list of (in order) description,
+# institutional code, and course owner.
+# selfenrollonly - filter by courses allowing self-enrollment
+# now or in the future (selfenrollonly = 1).
+# catfilter - filter by course category, assigned to a course
+# using manually defined categories (i.e., not
+# self-cataloging based on on institutional code).
+# showhidden - include course in results even if course
+# was set to be excluded from course catalog (DC only).
+# caller - if set to 'coursecatalog', courses set to be hidden
+# from course catalog will be excluded from results (unless
+# overridden by "showhidden".
+# cloner - escaped username:domain of course cloner (if picking course to
+# clone).
+# cc_clone_list - escaped comma separated list of courses for which
+# course cloner has active CC role (and so can clone
+# automatically).
+# cloneonly - filter by courses for which cloner has rights to clone.
+# createdbefore - include courses for which creation date preceeded this date.
+# createdafter - include courses for which creation date followed this date.
+# creationcontext - include courses created in specified context
+#
+# domcloner - flag to indicate if user can create CCs in course's domain.
+# If so, ability to clone course is automatic.
+#
# $client - The socket open on the client.
# Returns:
# 1 - Continue processing.
# Side Effects:
# a reply is written to $client.
-sub DumpCourseIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub dump_course_id_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
- my ($udom,$since,$description) =split(/:/,$tail);
+ my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
+ $typefilter,$regexp_ok,$rtn_as_hash,$selfenrollonly,$catfilter,$showhidden,
+ $caller,$cloner,$cc_clone_list,$cloneonly,$createdbefore,$createdafter,
+ $creationcontext,$domcloner) =split(/:/,$tail);
+ my $now = time;
+ my ($cloneruname,$clonerudom,%cc_clone);
if (defined($description)) {
$description=&unescape($description);
} else {
$description='.';
}
- unless (defined($since)) { $since=0; }
- my $qresult='';
+ if (defined($instcodefilter)) {
+ $instcodefilter=&unescape($instcodefilter);
+ } else {
+ $instcodefilter='.';
+ }
+ my ($ownerunamefilter,$ownerdomfilter);
+ if (defined($ownerfilter)) {
+ $ownerfilter=&unescape($ownerfilter);
+ if ($ownerfilter ne '.' && defined($ownerfilter)) {
+ if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
+ $ownerunamefilter = $1;
+ $ownerdomfilter = $2;
+ } else {
+ $ownerunamefilter = $ownerfilter;
+ $ownerdomfilter = '';
+ }
+ }
+ } else {
+ $ownerfilter='.';
+ }
- my $hashref = TieDomainHash($udom, "nohist_courseids", &GDBM_WRCREAT());
+ if (defined($coursefilter)) {
+ $coursefilter=&unescape($coursefilter);
+ } else {
+ $coursefilter='.';
+ }
+ if (defined($typefilter)) {
+ $typefilter=&unescape($typefilter);
+ } else {
+ $typefilter='.';
+ }
+ if (defined($regexp_ok)) {
+ $regexp_ok=&unescape($regexp_ok);
+ }
+ if (defined($catfilter)) {
+ $catfilter=&unescape($catfilter);
+ }
+ if (defined($cloner)) {
+ $cloner = &unescape($cloner);
+ ($cloneruname,$clonerudom) = ($cloner =~ /^($LONCAPA::match_username):($LONCAPA::match_domain)$/);
+ }
+ if (defined($cc_clone_list)) {
+ $cc_clone_list = &unescape($cc_clone_list);
+ my @cc_cloners = split('&',$cc_clone_list);
+ foreach my $cid (@cc_cloners) {
+ my ($clonedom,$clonenum) = split(':',$cid);
+ next if ($clonedom ne $udom);
+ $cc_clone{$clonedom.'_'.$clonenum} = 1;
+ }
+ }
+ if ($createdbefore ne '') {
+ $createdbefore = &unescape($createdbefore);
+ } else {
+ $createdbefore = 0;
+ }
+ if ($createdafter ne '') {
+ $createdafter = &unescape($createdafter);
+ } else {
+ $createdafter = 0;
+ }
+ if ($creationcontext ne '') {
+ $creationcontext = &unescape($creationcontext);
+ } else {
+ $creationcontext = '.';
+ }
+ my $unpack = 1;
+ if ($description eq '.' && $instcodefilter eq '.' && $coursefilter eq '.' &&
+ $typefilter eq '.') {
+ $unpack = 0;
+ }
+ if (!defined($since)) { $since=0; }
+ my $qresult='';
+ my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
if ($hashref) {
while (my ($key,$value) = each(%$hashref)) {
- my ($descr,$lasttime)=split(/\:/,$value);
- if ($lasttime<$since) {
- next;
- }
- if ($description eq '.') {
- $qresult.=$key.'='.$descr.'&';
- } else {
- my $unescapeVal = &unescape($descr);
- if (eval('$unescapeVal=~/$description/i')) {
- $qresult.="$key=$descr&";
- }
+ my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,
+ %unesc_val,$selfenroll_end,$selfenroll_types,$created,
+ $context);
+ $unesc_key = &unescape($key);
+ if ($unesc_key =~ /^lasttime:/) {
+ next;
+ } else {
+ $lasttime_key = &escape('lasttime:'.$unesc_key);
+ }
+ if ($hashref->{$lasttime_key} ne '') {
+ $lasttime = $hashref->{$lasttime_key};
+ next if ($lasttime<$since);
+ }
+ my ($canclone,$valchange);
+ my $items = &Apache::lonnet::thaw_unescape($value);
+ if (ref($items) eq 'HASH') {
+ if ($hashref->{$lasttime_key} eq '') {
+ next if ($since > 1);
+ }
+ $is_hash = 1;
+ if ($domcloner) {
+ $canclone = 1;
+ } elsif (defined($clonerudom)) {
+ if ($items->{'cloners'}) {
+ my @cloneable = split(',',$items->{'cloners'});
+ if (@cloneable) {
+ if (grep(/^\*$/,@cloneable)) {
+ $canclone = 1;
+ } elsif (grep(/^\*:\Q$clonerudom\E$/,@cloneable)) {
+ $canclone = 1;
+ } elsif (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
+ $canclone = 1;
+ }
+ }
+ unless ($canclone) {
+ if ($cloneruname ne '' && $clonerudom ne '') {
+ if ($cc_clone{$unesc_key}) {
+ $canclone = 1;
+ $items->{'cloners'} .= ','.$cloneruname.':'.
+ $clonerudom;
+ $valchange = 1;
+ }
+ }
+ }
+ } elsif (defined($cloneruname)) {
+ if ($cc_clone{$unesc_key}) {
+ $canclone = 1;
+ $items->{'cloners'} = $cloneruname.':'.$clonerudom;
+ $valchange = 1;
+ }
+ unless ($canclone) {
+ if ($items->{'owner'} =~ /:/) {
+ if ($items->{'owner'} eq $cloner) {
+ $canclone = 1;
+ }
+ } elsif ($cloner eq $items->{'owner'}.':'.$udom) {
+ $canclone = 1;
+ }
+ if ($canclone) {
+ $items->{'cloners'} = $cloneruname.':'.$clonerudom;
+ $valchange = 1;
+ }
+ }
+ }
+ }
+ if ($unpack || !$rtn_as_hash) {
+ $unesc_val{'descr'} = $items->{'description'};
+ $unesc_val{'inst_code'} = $items->{'inst_code'};
+ $unesc_val{'owner'} = $items->{'owner'};
+ $unesc_val{'type'} = $items->{'type'};
+ $unesc_val{'cloners'} = $items->{'cloners'};
+ $unesc_val{'created'} = $items->{'created'};
+ $unesc_val{'context'} = $items->{'context'};
+ }
+ $selfenroll_types = $items->{'selfenroll_types'};
+ $selfenroll_end = $items->{'selfenroll_end_date'};
+ $created = $items->{'created'};
+ $context = $items->{'context'};
+ if ($selfenrollonly) {
+ next if (!$selfenroll_types);
+ if (($selfenroll_end > 0) && ($selfenroll_end <= $now)) {
+ next;
+ }
+ }
+ if ($creationcontext ne '.') {
+ next if (($context ne '') && ($context ne $creationcontext));
+ }
+ if ($createdbefore > 0) {
+ next if (($created eq '') || ($created > $createdbefore));
+ }
+ if ($createdafter > 0) {
+ next if (($created eq '') || ($created <= $createdafter));
+ }
+ if ($catfilter ne '') {
+ next if ($items->{'categories'} eq '');
+ my @categories = split('&',$items->{'categories'});
+ next if (@categories == 0);
+ my @subcats = split('&',$catfilter);
+ my $matchcat = 0;
+ foreach my $cat (@categories) {
+ if (grep(/^\Q$cat\E$/,@subcats)) {
+ $matchcat = 1;
+ last;
+ }
+ }
+ next if (!$matchcat);
+ }
+ if ($caller eq 'coursecatalog') {
+ if ($items->{'hidefromcat'} eq 'yes') {
+ next if !$showhidden;
+ }
+ }
+ } else {
+ next if ($catfilter ne '');
+ next if ($selfenrollonly);
+ next if ($createdbefore || $createdafter);
+ next if ($creationcontext ne '.');
+ if ((defined($clonerudom)) && (defined($cloneruname))) {
+ if ($cc_clone{$unesc_key}) {
+ $canclone = 1;
+ $val{'cloners'} = &escape($cloneruname.':'.$clonerudom);
+ }
+ }
+ $is_hash = 0;
+ my @courseitems = split(/:/,$value);
+ $lasttime = pop(@courseitems);
+ if ($hashref->{$lasttime_key} eq '') {
+ next if ($lasttime<$since);
+ }
+ ($val{'descr'},$val{'inst_code'},$val{'owner'},$val{'type'}) = @courseitems;
+ }
+ if ($cloneonly) {
+ next unless ($canclone);
+ }
+ my $match = 1;
+ if ($description ne '.') {
+ if (!$is_hash) {
+ $unesc_val{'descr'} = &unescape($val{'descr'});
+ }
+ if (eval{$unesc_val{'descr'} !~ /\Q$description\E/i}) {
+ $match = 0;
+ }
+ }
+ if ($instcodefilter ne '.') {
+ if (!$is_hash) {
+ $unesc_val{'inst_code'} = &unescape($val{'inst_code'});
+ }
+ if ($regexp_ok == 1) {
+ if (eval{$unesc_val{'inst_code'} !~ /$instcodefilter/}) {
+ $match = 0;
+ }
+ } elsif ($regexp_ok == -1) {
+ if (eval{$unesc_val{'inst_code'} =~ /$instcodefilter/}) {
+ $match = 0;
+ }
+ } else {
+ if (eval{$unesc_val{'inst_code'} !~ /\Q$instcodefilter\E/i}) {
+ $match = 0;
+ }
+ }
}
+ if ($ownerfilter ne '.') {
+ if (!$is_hash) {
+ $unesc_val{'owner'} = &unescape($val{'owner'});
+ }
+ if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
+ if ($unesc_val{'owner'} =~ /:/) {
+ if (eval{$unesc_val{'owner'} !~
+ /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i}) {
+ $match = 0;
+ }
+ } else {
+ if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
+ $match = 0;
+ }
+ }
+ } elsif ($ownerunamefilter ne '') {
+ if ($unesc_val{'owner'} =~ /:/) {
+ if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E:[^:]+$/i}) {
+ $match = 0;
+ }
+ } else {
+ if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
+ $match = 0;
+ }
+ }
+ } elsif ($ownerdomfilter ne '') {
+ if ($unesc_val{'owner'} =~ /:/) {
+ if (eval{$unesc_val{'owner'} !~ /^[^:]+:\Q$ownerdomfilter\E/}) {
+ $match = 0;
+ }
+ } else {
+ if ($ownerdomfilter ne $udom) {
+ $match = 0;
+ }
+ }
+ }
+ }
+ if ($coursefilter ne '.') {
+ if (eval{$unesc_key !~ /^$udom(_)\Q$coursefilter\E$/}) {
+ $match = 0;
+ }
+ }
+ if ($typefilter ne '.') {
+ if (!$is_hash) {
+ $unesc_val{'type'} = &unescape($val{'type'});
+ }
+ if ($unesc_val{'type'} eq '') {
+ if ($typefilter ne 'Course') {
+ $match = 0;
+ }
+ } else {
+ if (eval{$unesc_val{'type'} !~ /^\Q$typefilter\E$/}) {
+ $match = 0;
+ }
+ }
+ }
+ if ($match == 1) {
+ if ($rtn_as_hash) {
+ if ($is_hash) {
+ if ($valchange) {
+ my $newvalue = &Apache::lonnet::freeze_escape($items);
+ $qresult.=$key.'='.$newvalue.'&';
+ } else {
+ $qresult.=$key.'='.$value.'&';
+ }
+ } else {
+ my %rtnhash = ( 'description' => &unescape($val{'descr'}),
+ 'inst_code' => &unescape($val{'inst_code'}),
+ 'owner' => &unescape($val{'owner'}),
+ 'type' => &unescape($val{'type'}),
+ 'cloners' => &unescape($val{'cloners'}),
+ );
+ my $items = &Apache::lonnet::freeze_escape(\%rtnhash);
+ $qresult.=$key.'='.$items.'&';
+ }
+ } else {
+ if ($is_hash) {
+ $qresult .= $key.'='.&escape($unesc_val{'descr'}).':'.
+ &escape($unesc_val{'inst_code'}).':'.
+ &escape($unesc_val{'owner'}).'&';
+ } else {
+ $qresult .= $key.'='.$val{'descr'}.':'.$val{'inst_code'}.
+ ':'.$val{'owner'}.'&';
+ }
+ }
+ }
}
- if (untie(%$hashref)) {
+ if (&untie_domain_hash($hashref)) {
chop($qresult);
- Reply($client, "$qresult\n", $userinput);
+ &Reply($client, \$qresult, $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting courseiddump\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting courseiddump\n", $userinput);
}
+ return 1;
+}
+®ister_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
+
+sub course_lastaccess_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($cdom,$cnum) = split(':',$tail);
+ my (%lastaccess,$qresult);
+ my $hashref = &tie_domain_hash($cdom, "nohist_courseids", &GDBM_WRCREAT());
+ if ($hashref) {
+ while (my ($key,$value) = each(%$hashref)) {
+ my ($unesc_key,$lasttime);
+ $unesc_key = &unescape($key);
+ if ($cnum) {
+ next unless ($unesc_key =~ /\Q$cdom\E_\Q$cnum\E$/);
+ }
+ if ($unesc_key =~ /^lasttime:($LONCAPA::match_domain\_$LONCAPA::match_courseid)/) {
+ $lastaccess{$1} = $value;
+ } else {
+ my $items = &Apache::lonnet::thaw_unescape($value);
+ if (ref($items) eq 'HASH') {
+ unless ($lastaccess{$unesc_key}) {
+ $lastaccess{$unesc_key} = '';
+ }
+ } else {
+ my @courseitems = split(':',$value);
+ $lastaccess{$unesc_key} = pop(@courseitems);
+ }
+ }
+ }
+ foreach my $cid (sort(keys(%lastaccess))) {
+ $qresult.=&escape($cid).'='.$lastaccess{$cid}.'&';
+ }
+ if (&untie_domain_hash($hashref)) {
+ if ($qresult) {
+ chop($qresult);
+ }
+ &Reply($client, \$qresult, $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting lastacourseaccess\n", $userinput);
+ }
+ } else {
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting lastcourseaccess\n", $userinput);
+ }
+ return 1;
+}
+®ister_handler("courselastaccess",\&course_lastaccess_handler, 0, 1, 0);
+#
+# Puts an unencrypted entry in a namespace db file at the domain level
+#
+# Parameters:
+# $cmd - The command that got us here.
+# $tail - Tail of the command (remaining parameters).
+# $client - File descriptor connected to client.
+# Returns
+# 0 - Requested to exit, caller should shut down.
+# 1 - Continue processing.
+# Side effects:
+# reply is written to $client.
+#
+sub put_domain_handler {
+ my ($cmd,$tail,$client) = @_;
+
+ my $userinput = "$cmd:$tail";
+
+ my ($udom,$namespace,$what) =split(/:/,$tail,3);
+ chomp($what);
+ my @pairs=split(/\&/,$what);
+ my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_WRCREAT(),
+ "P", $what);
+ if ($hashref) {
+ foreach my $pair (@pairs) {
+ my ($key,$value)=split(/=/,$pair);
+ $hashref->{$key}=$value;
+ }
+ if (&untie_domain_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting putdom\n", $userinput);
+ }
+ } else {
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting putdom\n", $userinput);
+ }
return 1;
}
-RegisterHandler("courseiddump", \&DumpCourseIdHandler, 0, 1, 0);
+®ister_handler("putdom", \&put_domain_handler, 0, 1, 0);
+
+# Unencrypted get from the namespace database file at the domain level.
+# This function retrieves a keyed item from a specific named database in the
+# domain directory.
+#
+# Parameters:
+# $cmd - Command request keyword (get).
+# $tail - Tail of the command. This is a colon separated list
+# consisting of the domain and the 'namespace'
+# which selects the gdbm file to do the lookup in,
+# & separated list of keys to lookup. Note that
+# the values are returned as an & separated list too.
+# $client - File descriptor open on the client.
+# Returns:
+# 1 - Continue processing.
+# 0 - Exit.
+# Side effects:
+# reply is written to $client.
+#
+
+sub get_domain_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = "$client:$tail";
+
+ my ($udom,$namespace,$what)=split(/:/,$tail,3);
+ chomp($what);
+ my @queries=split(/\&/,$what);
+ my $qresult='';
+ my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_READER());
+ if ($hashref) {
+ for (my $i=0;$i<=$#queries;$i++) {
+ $qresult.="$hashref->{$queries[$i]}&";
+ }
+ if (&untie_domain_hash($hashref)) {
+ $qresult=~s/\&$//;
+ &Reply($client, \$qresult, $userinput);
+ } else {
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting getdom\n",$userinput);
+ }
+ } else {
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting getdom\n",$userinput);
+ }
+
+ return 1;
+}
+®ister_handler("getdom", \&get_domain_handler, 0, 1, 0);
+
#
# Puts an id to a domains id database.
#
@@ -2379,38 +4317,37 @@ RegisterHandler("courseiddump", \&DumpCo
# Side effects:
# reply is written to $client.
#
-sub PutIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub put_id_handler {
+ my ($cmd,$tail,$client) = @_;
+
my $userinput = "$cmd:$tail";
my ($udom,$what)=split(/:/,$tail);
chomp($what);
my @pairs=split(/\&/,$what);
- my $hashref = TieDomainHash($udom, "ids", &GDBM_WRCREAT(),
- "P", $what);
+ my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
+ "P", $what);
if ($hashref) {
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
$hashref->{$key}=$value;
}
- if (untie(%$hashref)) {
- Reply($client, "ok\n", $userinput);
+ if (&untie_domain_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting idput\n", $userinput);
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting idput\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting idput\n", $userinput);
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting idput\n", $userinput);
}
return 1;
}
+®ister_handler("idput", \&put_id_handler, 0, 1, 0);
-RegisterHandler("idput", \&PutIdHandler, 0, 1, 0);
#
# Retrieves a set of id values from the id database.
# Returns an & separated list of results, one for each requested id to the
@@ -2430,10 +4367,9 @@ RegisterHandler("idput", \&PutIdHandler,
# Side effects:
# An & separated list of results is written to $client.
#
-sub GetIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_id_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$client:$tail";
@@ -2441,28 +4377,283 @@ sub GetIdHandler {
chomp($what);
my @queries=split(/\&/,$what);
my $qresult='';
- my $hashref = TieDomainHash($udom, "ids", &GDBM_READER());
+ my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
if ($hashref) {
for (my $i=0;$i<=$#queries;$i++) {
$qresult.="$hashref->{$queries[$i]}&";
}
- if (untie(%$hashref)) {
+ if (&untie_domain_hash($hashref)) {
$qresult=~s/\&$//;
- Reply($client, "$qresult\n", $userinput);
+ &Reply($client, \$qresult, $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting idget\n",$userinput);
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting idget\n",$userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting idget\n",$userinput);
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting idget\n",$userinput);
}
return 1;
}
+®ister_handler("idget", \&get_id_handler, 0, 1, 0);
-RegisterHandler("idget", \&GetIdHandler, 0, 1, 0);
#
+# Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database
+#
+# Parameters
+# $cmd - Command keyword that caused us to be dispatched.
+# $tail - Tail of the command. Consists of a colon separated:
+# domain - the domain whose dcmail we are recording
+# email Consists of key=value pair
+# where key is unique msgid
+# and value is message (in XML)
+# $client - Socket open on the client.
+#
+# Returns:
+# 1 - indicating processing should continue.
+# Side effects
+# reply is written to $client.
+#
+sub put_dcmail_handler {
+ my ($cmd,$tail,$client) = @_;
+ my $userinput = "$cmd:$tail";
+
+ my ($udom,$what)=split(/:/,$tail);
+ chomp($what);
+ my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
+ if ($hashref) {
+ my ($key,$value)=split(/=/,$what);
+ $hashref->{$key}=$value;
+ }
+ if (&untie_domain_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting dcmailput\n", $userinput);
+ }
+ return 1;
+}
+®ister_handler("dcmailput", \&put_dcmail_handler, 0, 1, 0);
+
+#
+# Retrieves broadcast e-mail from nohist_dcmail database
+# Returns to client an & separated list of key=value pairs,
+# where key is msgid and value is message information.
+#
+# Parameters
+# $cmd - Command keyword that caused us to be dispatched.
+# $tail - Tail of the command. Consists of a colon separated:
+# domain - the domain whose dcmail table we dump
+# startfilter - beginning of time window
+# endfilter - end of time window
+# sendersfilter - & separated list of username:domain
+# for senders to search for.
+# $client - Socket open on the client.
+#
+# Returns:
+# 1 - indicating processing should continue.
+# Side effects
+# reply (& separated list of msgid=messageinfo pairs) is
+# written to $client.
+#
+sub dump_dcmail_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = "$cmd:$tail";
+ my ($udom,$startfilter,$endfilter,$sendersfilter) = split(/:/,$tail);
+ chomp($sendersfilter);
+ my @senders = ();
+ if (defined($startfilter)) {
+ $startfilter=&unescape($startfilter);
+ } else {
+ $startfilter='.';
+ }
+ if (defined($endfilter)) {
+ $endfilter=&unescape($endfilter);
+ } else {
+ $endfilter='.';
+ }
+ if (defined($sendersfilter)) {
+ $sendersfilter=&unescape($sendersfilter);
+ @senders = map { &unescape($_) } split(/\&/,$sendersfilter);
+ }
+
+ my $qresult='';
+ my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
+ if ($hashref) {
+ while (my ($key,$value) = each(%$hashref)) {
+ my $match = 1;
+ my ($timestamp,$subj,$uname,$udom) =
+ split(/:/,&unescape(&unescape($key)),5); # yes, twice really
+ $subj = &unescape($subj);
+ unless ($startfilter eq '.' || !defined($startfilter)) {
+ if ($timestamp < $startfilter) {
+ $match = 0;
+ }
+ }
+ unless ($endfilter eq '.' || !defined($endfilter)) {
+ if ($timestamp > $endfilter) {
+ $match = 0;
+ }
+ }
+ unless (@senders < 1) {
+ unless (grep/^$uname:$udom$/,@senders) {
+ $match = 0;
+ }
+ }
+ if ($match == 1) {
+ $qresult.=$key.'='.$value.'&';
+ }
+ }
+ if (&untie_domain_hash($hashref)) {
+ chop($qresult);
+ &Reply($client, \$qresult, $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting dcmaildump\n", $userinput);
+ }
+ } else {
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting dcmaildump\n", $userinput);
+ }
+ return 1;
+}
+
+®ister_handler("dcmaildump", \&dump_dcmail_handler, 0, 1, 0);
+
+#
+# Puts domain roles in nohist_domainroles database
+#
+# Parameters
+# $cmd - Command keyword that caused us to be dispatched.
+# $tail - Tail of the command. Consists of a colon separated:
+# domain - the domain whose roles we are recording
+# role - Consists of key=value pair
+# where key is unique role
+# and value is start/end date information
+# $client - Socket open on the client.
+#
+# Returns:
+# 1 - indicating processing should continue.
+# Side effects
+# reply is written to $client.
+#
+
+sub put_domainroles_handler {
+ my ($cmd,$tail,$client) = @_;
+
+ my $userinput = "$cmd:$tail";
+ my ($udom,$what)=split(/:/,$tail);
+ chomp($what);
+ my @pairs=split(/\&/,$what);
+ my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
+ if ($hashref) {
+ foreach my $pair (@pairs) {
+ my ($key,$value)=split(/=/,$pair);
+ $hashref->{$key}=$value;
+ }
+ if (&untie_domain_hash($hashref)) {
+ &Reply($client, "ok\n", $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting domroleput\n", $userinput);
+ }
+ } else {
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting domroleput\n", $userinput);
+ }
+
+ return 1;
+}
+
+®ister_handler("domroleput", \&put_domainroles_handler, 0, 1, 0);
+
+#
+# Retrieves domain roles from nohist_domainroles database
+# Returns to client an & separated list of key=value pairs,
+# where key is role and value is start and end date information.
+#
+# Parameters
+# $cmd - Command keyword that caused us to be dispatched.
+# $tail - Tail of the command. Consists of a colon separated:
+# domain - the domain whose domain roles table we dump
+# $client - Socket open on the client.
+#
+# Returns:
+# 1 - indicating processing should continue.
+# Side effects
+# reply (& separated list of role=start/end info pairs) is
+# written to $client.
+#
+sub dump_domainroles_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = "$cmd:$tail";
+ my ($udom,$startfilter,$endfilter,$rolesfilter) = split(/:/,$tail);
+ chomp($rolesfilter);
+ my @roles = ();
+ if (defined($startfilter)) {
+ $startfilter=&unescape($startfilter);
+ } else {
+ $startfilter='.';
+ }
+ if (defined($endfilter)) {
+ $endfilter=&unescape($endfilter);
+ } else {
+ $endfilter='.';
+ }
+ if (defined($rolesfilter)) {
+ $rolesfilter=&unescape($rolesfilter);
+ @roles = split(/\&/,$rolesfilter);
+ }
+
+ my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
+ if ($hashref) {
+ my $qresult = '';
+ while (my ($key,$value) = each(%$hashref)) {
+ my $match = 1;
+ my ($end,$start) = split(/:/,&unescape($value));
+ my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,&unescape($key));
+ unless (@roles < 1) {
+ unless (grep/^\Q$trole\E$/,@roles) {
+ $match = 0;
+ next;
+ }
+ }
+ unless ($startfilter eq '.' || !defined($startfilter)) {
+ if ((defined($start)) && ($start >= $startfilter)) {
+ $match = 0;
+ next;
+ }
+ }
+ unless ($endfilter eq '.' || !defined($endfilter)) {
+ if ((defined($end)) && (($end > 0) && ($end <= $endfilter))) {
+ $match = 0;
+ next;
+ }
+ }
+ if ($match == 1) {
+ $qresult.=$key.'='.$value.'&';
+ }
+ }
+ if (&untie_domain_hash($hashref)) {
+ chop($qresult);
+ &Reply($client, \$qresult, $userinput);
+ } else {
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ "while attempting domrolesdump\n", $userinput);
+ }
+ } else {
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting domrolesdump\n", $userinput);
+ }
+ return 1;
+}
+
+®ister_handler("domrolesdump", \&dump_domainroles_handler, 0, 1, 0);
+
+
# Process the tmpput command I'm not sure what this does.. Seems to
# create a file in the lonDaemons/tmp directory of the form $id.tmp
# where Id is the client's ip concatenated with a sequence number.
@@ -2479,32 +4670,38 @@ RegisterHandler("idget", \&GetIdHandler,
# Side effects:
# A file is created in the local filesystem.
# A reply is sent to the client.
-sub TmpPutHandler {
- my $cmd = shift;
- my $what = shift;
- my $client = shift;
+sub tmp_put_handler {
+ my ($cmd, $what, $client) = @_;
my $userinput = "$cmd:$what"; # Reconstruct for logging.
-
- my $store;
+ my ($record,$context) = split(/:/,$what);
+ if ($context ne '') {
+ chomp($context);
+ $context = &unescape($context);
+ }
+ my ($id,$store);
$tmpsnum++;
- my $id=$$.'_'.$clientip.'_'.$tmpsnum;
+ if ($context eq 'resetpw') {
+ $id = &md5_hex(&md5_hex(time.{}.rand().$$));
+ } else {
+ $id = $$.'_'.$clientip.'_'.$tmpsnum;
+ }
$id=~s/\W/\_/g;
- $what=~s/\n//g;
+ $record=~s/\n//g;
my $execdir=$perlvar{'lonDaemons'};
if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
- print $store $what;
+ print $store $record;
close $store;
- Reply($client, "$id\n", $userinput);
+ &Reply($client, \$id, $userinput);
} else {
- Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
- "while attempting tmpput\n", $userinput);
+ &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
+ "while attempting tmpput\n", $userinput);
}
return 1;
}
-RegisterHandler("tmpput", \&TmpPutHandler, 0, 1, 0);
+®ister_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
# Processes the tmpget command. This command returns the contents
# of a temporary resource file(?) created via tmpput.
@@ -2518,30 +4715,29 @@ RegisterHandler("tmpput", \&TmpPutHandle
# 1 - Inidcating processing can continue.
# Side effects:
# A reply is sent to the client.
-
#
-sub TmpGetHandler {
- my $cmd = shift;
- my $id = shift;
- my $client = shift;
+sub tmp_get_handler {
+ my ($cmd, $id, $client) = @_;
+
my $userinput = "$cmd:$id";
- chomp($id);
+
$id=~s/\W/\_/g;
my $store;
my $execdir=$perlvar{'lonDaemons'};
if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
my $reply=<$store>;
- Reply( $client, "$reply\n", $userinput);
+ &Reply( $client, \$reply, $userinput);
close $store;
} else {
- Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
- "while attempting tmpget\n", $userinput);
+ &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
+ "while attempting tmpget\n", $userinput);
}
return 1;
}
-RegisterHandler("tmpget", \&TmpGetHandler, 0, 1, 0);
+®ister_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
+
#
# Process the tmpdel command. This command deletes a temp resource
# created by the tmpput command.
@@ -2556,10 +4752,8 @@ RegisterHandler("tmpget", \&TmpGetHandle
# Side Effects:
# A file is deleted
# A reply is sent to the client.
-sub TmpDelHandler {
- my $cmd = shift;
- my $id = shift;
- my $client = shift;
+sub tmp_del_handler {
+ my ($cmd, $id, $client) = @_;
my $userinput= "$cmd:$id";
@@ -2567,66 +4761,16 @@ sub TmpDelHandler {
$id=~s/\W/\_/g;
my $execdir=$perlvar{'lonDaemons'};
if (unlink("$execdir/tmp/$id.tmp")) {
- Reply($client, "ok\n", $userinput);
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
- "while attempting tmpdel\n", $userinput);
+ &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
+ "while attempting tmpdel\n", $userinput);
}
return 1;
}
-RegisterHandler("tmpdel", \&TmpDelHandler, 0, 1, 0);
-#
-# ls - list the contents of a directory. For each file in the
-# selected directory the filename followed by the full output of
-# the stat function is returned. The returned info for each
-# file are separated by ':'. The stat fields are separated by &'s.
-# Parameters:
-# $cmd - The command that dispatched us (ls).
-# $ulsdir - The directory path to list... I'm not sure what this
-# is relative as things like ls:. return e.g.
-# no_such_dir.
-# $client - Socket open on the client.
-# Returns:
-# 1 - indicating that the daemon should not disconnect.
-# Side Effects:
-# The reply is written to $client.
-#
-sub LsHandler {
- my $cmd = shift;
- my $ulsdir = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$ulsdir";
-
- my $ulsout='';
- my $ulsfn;
- if (-e $ulsdir) {
- if(-d $ulsdir) {
- if (opendir(LSDIR,$ulsdir)) {
- while ($ulsfn=readdir(LSDIR)) {
- my @ulsstats=stat($ulsdir.'/'.$ulsfn);
- $ulsout.=$ulsfn.'&'.
- join('&',@ulsstats).':';
- }
- closedir(LSDIR);
- }
- } else {
- my @ulsstats=stat($ulsdir);
- $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
- }
- } else {
- $ulsout='no_such_dir';
- }
- if ($ulsout eq '') { $ulsout='empty'; }
- Reply($client, "$ulsout\n", $userinput);
-
-
- return 1;
-}
-RegisterHandler("ls", \&LsHandler, 0, 1, 0);
-
+®ister_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
#
# Processes the setannounce command. This command
@@ -2647,10 +4791,8 @@ RegisterHandler("ls", \&LsHandler, 0, 1,
# The file {DocRoot}/announcement.txt is created.
# A reply is sent to $client.
#
-sub SetAnnounceHandler {
- my $cmd = shift;
- my $announcement = shift;
- my $client = shift;
+sub set_announce_handler {
+ my ($cmd, $announcement, $client) = @_;
my $userinput = "$cmd:$announcement";
@@ -2660,14 +4802,14 @@ sub SetAnnounceHandler {
'/announcement.txt')) {
print $store $announcement;
close $store;
- Reply($client, "ok\n", $userinput);
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)."\n", $userinput);
+ &Failure($client, "error: ".($!+0)."\n", $userinput);
}
return 1;
}
-RegisterHandler("setannounce", \&SetAnnounceHandler, 0, 1, 0);
+®ister_handler("setannounce", \&set_announce_handler, 0, 1, 0);
#
# Return the version of the daemon. This can be used to determine
@@ -2682,18 +4824,17 @@ RegisterHandler("setannounce", \&SetAnno
# 1 - continue processing requests.
# Side Effects:
# Replies with version to $client.
-sub GetVersionHandler {
- my $client = shift;
- my $tail = shift;
- my $client = shift;
- my $userinput = $client;
+sub get_version_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = $cmd.$tail;
- Reply($client, &version($userinput)."\n", $userinput);
+ &Reply($client, &version($userinput)."\n", $userinput);
return 1;
}
-RegisterHandler("version", \&GetVersionHandler, 0, 1, 0);
+®ister_handler("version", \&get_version_handler, 0, 1, 0);
# Set the current host and domain. This is used to support
# multihomed systems. Each IP of the system, or even separate daemons
@@ -2712,19 +4853,17 @@ RegisterHandler("version", \&GetVersionH
# The default domain/system context is modified for this daemon.
# a reply is sent to the client.
#
-sub SelectHostHandler {
- my $cmd = shift;
- my $tail = shift;
- my $socket = shift;
+sub set_virtual_host_handler {
+ my ($cmd, $tail, $socket) = @_;
my $userinput ="$cmd:$tail";
- Reply($client, &sethost($userinput)."\n", $userinput);
+ &Reply($client, &sethost($userinput)."\n", $userinput);
return 1;
}
-RegisterHandler("sethost", \&SelectHostHandler, 0, 1, 0);
+®ister_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
# Process a request to exit:
# - "bye" is sent to the client.
@@ -2737,698 +4876,1037 @@ RegisterHandler("sethost", \&SelectHostH
# Returns:
# 0 - Indicating the program should exit!!
#
-sub ExitHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub exit_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
&logthis("Client $clientip ($clientname) hanging up: $userinput");
- Reply($client, "bye\n", $userinput);
+ &Reply($client, "bye\n", $userinput);
$client->shutdown(2); # shutdown the socket forcibly.
$client->close();
return 0;
}
-RegisterHandler("exit", \&ExitHandler, 0, 1,1);
-RegisterHandler("init", \&ExitHandler, 0, 1,1); # RE-init is like exit.
-RegisterHandler("quit", \&ExitHandler, 0, 1,1); # I like this too!
-#------------------------------------------------------------------------------------
-#
-# Process a Request. Takes a request from the client validates
-# it and performs the operation requested by it. Returns
-# a response to the client.
-#
-# Parameters:
-# request - A string containing the user's request.
-# Returns:
-# 0 - Requested to exit, caller should shut down.
-# 1 - Accept additional requests from the client.
+®ister_handler("exit", \&exit_handler, 0,1,1);
+®ister_handler("init", \&exit_handler, 0,1,1);
+®ister_handler("quit", \&exit_handler, 0,1,1);
+
+# Determine if auto-enrollment is enabled.
+# Note that the original had what I believe to be a defect.
+# The original returned 0 if the requestor was not a registerd client.
+# It should return "refused".
+# Formal Parameters:
+# $cmd - The command that invoked us.
+# $tail - The tail of the command (Extra command parameters.
+# $client - The socket open on the client that issued the request.
+# Returns:
+# 1 - Indicating processing should continue.
#
-sub ProcessRequest {
- my $Request = shift;
- my $KeepGoing = 1; # Assume we're not asked to stop.
-
- my $wasenc=0;
- my $userinput = $Request; # for compatibility with oldcode <yeach>
-
+sub enrollment_enabled_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = $cmd.":".$tail; # For logging purposes.
-# ------------------------------------------------------------ See if encrypted
-
- if($userinput =~ /^enc/) {
- $wasenc = 1;
- $userinput = Decipher($userinput);
- if(! $userinput) {
- Failure($client,"error:Encrypted data without negotiating key");
- return 0; # Break off with this imposter.
- }
- }
- # Split off the request keyword from the rest of the stuff.
-
- my ($command, $tail) = split(/:/, $userinput, 2);
+
+ my ($cdom) = split(/:/, $tail, 2); # Domain we're asking about.
- Debug("Command received: $command, encoded = $wasenc");
+ my $outcome = &localenroll::run($cdom);
+ &Reply($client, \$outcome, $userinput);
-
-# ------------------------------------------------------------- Normal commands
-
- #
- # If the command is in the hash, then execute it via the hash dispatch:
- #
- if(defined $Dispatcher{$command}) {
+ return 1;
+}
+®ister_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
- my $DispatchInfo = $Dispatcher{$command};
- my $Handler = $$DispatchInfo[0];
- my $NeedEncode = $$DispatchInfo[1];
- my $ClientTypes = $$DispatchInfo[2];
- Debug("Matched dispatch hash: mustencode: $NeedEncode ClientType $ClientTypes");
-
- # Validate the request:
-
- my $ok = 1;
- my $requesterprivs = 0;
- if(isClient()) {
- $requesterprivs |= $CLIENT_OK;
- }
- if(isManager()) {
- $requesterprivs |= $MANAGER_OK;
- }
- if($NeedEncode && (!$wasenc)) {
- Debug("Must encode but wasn't: $NeedEncode $wasenc");
- $ok = 0;
- }
- if(($ClientTypes & $requesterprivs) == 0) {
- Debug("Client not privileged to do this operation");
- $ok = 0;
- }
+#
+# Validate an institutional code used for a LON-CAPA course.
+#
+# Formal Parameters:
+# $cmd - The command request that got us dispatched.
+# $tail - The tail of the command. In this case,
+# this is a colon separated set of words that will be split
+# into:
+# $dom - The domain for which the check of
+# institutional course code will occur.
+#
+# $instcode - The institutional code for the course
+# being requested, or validated for rights
+# to request.
+#
+# $owner - The course requestor (who will be the
+# course owner, in the form username:domain
+#
+# $client - Socket open on the client.
+# Returns:
+# 1 - Indicating processing should continue.
+#
+sub validate_instcode_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($dom,$instcode,$owner) = split(/:/, $tail);
+ $instcode = &unescape($instcode);
+ $owner = &unescape($owner);
+ my ($outcome,$description) =
+ &localenroll::validate_instcode($dom,$instcode,$owner);
+ my $result = &escape($outcome).'&'.&escape($description);
+ &Reply($client, \$result, $userinput);
- if($ok) {
- Debug("Dispatching to handler $command $tail");
- $KeepGoing = &$Handler($command, $tail, $client);
- } else {
- Debug("Refusing to dispatch because ok is false");
- Failure($client, "refused", $userinput);
- }
+ return 1;
+}
+®ister_handler("autovalidateinstcode", \&validate_instcode_handler, 0, 1, 0);
+# Get the official sections for which auto-enrollment is possible.
+# Since the admin people won't know about 'unofficial sections'
+# we cannot auto-enroll on them.
+# Formal Parameters:
+# $cmd - The command request that got us dispatched here.
+# $tail - The remainder of the request. In our case this
+# will be split into:
+# $coursecode - The course name from the admin point of view.
+# $cdom - The course's domain(?).
+# $client - Socket open on the client.
+# Returns:
+# 1 - Indiciting processing should continue.
+#
+sub get_sections_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
-# ------------------------------------------------------------- unknown command
+ my ($coursecode, $cdom) = split(/:/, $tail);
+ my @secs = &localenroll::get_sections($coursecode,$cdom);
+ my $seclist = &escape(join(':',@secs));
- } else {
- # unknown command
- Failure($client, "unknown_cmd\n", $userinput);
- }
+ &Reply($client, \$seclist, $userinput);
+
- return $KeepGoing;
+ return 1;
}
+®ister_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
-
+# Validate the owner of a new course section.
#
-# GetCertificate: Given a transaction that requires a certificate,
-# this function will extract the certificate from the transaction
-# request. Note that at this point, the only concept of a certificate
-# is the hostname to which we are connected.
+# Formal Parameters:
+# $cmd - Command that got us dispatched.
+# $tail - the remainder of the command. For us this consists of a
+# colon separated string containing:
+# $inst - Course Id from the institutions point of view.
+# $owner - Proposed owner of the course.
+# $cdom - Domain of the course (from the institutions
+# point of view?)..
+# $client - Socket open on the client.
#
-# Parameter:
-# request - The request sent by our client (this parameterization may
-# need to change when we really use a certificate granting
-# authority.
+# Returns:
+# 1 - Processing should continue.
#
-sub GetCertificate {
- my $request = shift;
+sub validate_course_owner_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($inst_course_id, $owner, $cdom) = split(/:/, $tail);
- return $clientip;
-}
+ $owner = &unescape($owner);
+ my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
+ &Reply($client, \$outcome, $userinput);
+ return 1;
+}
+®ister_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
+
#
-# ReadManagerTable: Reads in the current manager table. For now this is
-# done on each manager authentication because:
-# - These authentications are not frequent
-# - This allows dynamic changes to the manager table
-# without the need to signal to the lond.
+# Validate a course section in the official schedule of classes
+# from the institutions point of view (part of autoenrollment).
#
+# Formal Parameters:
+# $cmd - The command request that got us dispatched.
+# $tail - The tail of the command. In this case,
+# this is a colon separated set of words that will be split
+# into:
+# $inst_course_id - The course/section id from the
+# institutions point of view.
+# $cdom - The domain from the institutions
+# point of view.
+# $client - Socket open on the client.
+# Returns:
+# 1 - Indicating processing should continue.
+#
+sub validate_course_section_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($inst_course_id, $cdom) = split(/:/, $tail);
-sub ReadManagerTable {
-
- # Clean out the old table first..
+ my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
+ &Reply($client, \$outcome, $userinput);
- foreach my $key (keys %managers) {
- delete $managers{$key};
- }
- my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
- if (!open (MANAGERS, $tablename)) {
- logthis('<font color="red">No manager table. Nobody can manage!!</font>');
- return;
- }
- while(my $host = <MANAGERS>) {
- chomp($host);
- if ($host =~ "^#") { # Comment line.
- logthis('<font color="green"> Skipping line: '. "$host</font>\n");
- next;
- }
- if (!defined $hostip{$host}) { # This is a non cluster member
- # The entry is of the form:
- # cluname:hostname
- # cluname - A 'cluster hostname' is needed in order to negotiate
- # the host key.
- # hostname- The dns name of the host.
- #
- my($cluname, $dnsname) = split(/:/, $host);
-
- my $ip = gethostbyname($dnsname);
- if(defined($ip)) { # bad names don't deserve entry.
- my $hostip = inet_ntoa($ip);
- $managers{$hostip} = $cluname;
- logthis('<font color="green"> registering manager '.
- "$dnsname as $cluname with $hostip </font>\n");
- }
- } else {
- logthis('<font color="green"> existing host'." $host</font>\n");
- $managers{$hostip{$host}} = $host; # Use info from cluster tab if clumemeber
- }
- }
+ return 1;
}
+®ister_handler("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
#
-# ValidManager: Determines if a given certificate represents a valid manager.
-# in this primitive implementation, the 'certificate' is
-# just the connecting loncapa client name. This is checked
-# against a valid client list in the configuration.
+# Validate course owner's access to enrollment data for specific class section.
+#
+#
+# Formal Parameters:
+# $cmd - The command request that got us dispatched.
+# $tail - The tail of the command. In this case this is a colon separated
+# set of words that will be split into:
+# $inst_class - Institutional code for the specific class section
+# $courseowner - The escaped username:domain of the course owner
+# $cdom - The domain of the course from the institution's
+# point of view.
+# $client - The socket open on the client.
+# Returns:
+# 1 - continue processing.
#
-#
-sub ValidManager {
- my $certificate = shift;
- return isManager;
+sub validate_class_access_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($inst_class,$ownerlist,$cdom) = split(/:/, $tail);
+ my $owners = &unescape($ownerlist);
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome=&localenroll::check_section($inst_class,$owners,$cdom);
+ };
+ &Reply($client,\$outcome, $userinput);
+
+ return 1;
}
+®ister_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
+
#
-# CopyFile: Called as part of the process of installing a
-# new configuration file. This function copies an existing
-# file to a backup file.
-# Parameters:
-# oldfile - Name of the file to backup.
-# newfile - Name of the backup file.
-# Return:
-# 0 - Failure (errno has failure reason).
-# 1 - Success.
+# Create a password for a new LON-CAPA user added by auto-enrollment.
+# Only used for case where authentication method for new user is localauth
#
-sub CopyFile {
- my $oldfile = shift;
- my $newfile = shift;
+# Formal Parameters:
+# $cmd - The command request that got us dispatched.
+# $tail - The tail of the command. In this case this is a colon separated
+# set of words that will be split into:
+# $authparam - An authentication parameter (localauth parameter).
+# $cdom - The domain of the course from the institution's
+# point of view.
+# $client - The socket open on the client.
+# Returns:
+# 1 - continue processing.
+#
+sub create_auto_enroll_password_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
- # The file must exist:
+ my ($authparam, $cdom) = split(/:/, $userinput);
- if(-e $oldfile) {
+ my ($create_passwd,$authchk);
+ ($authparam,
+ $create_passwd,
+ $authchk) = &localenroll::create_password($authparam,$cdom);
- # Read the old file.
+ &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
+ $userinput);
- my $oldfh = IO::File->new("< $oldfile");
- if(!$oldfh) {
- return 0;
- }
- my @contents = <$oldfh>; # Suck in the entire file.
- # write the backup file:
+ return 1;
+}
+®ister_handler("autocreatepassword", \&create_auto_enroll_password_handler,
+ 0, 1, 0);
- my $newfh = IO::File->new("> $newfile");
- if(!(defined $newfh)){
- return 0;
- }
- my $lines = scalar @contents;
- for (my $i =0; $i < $lines; $i++) {
- print $newfh ($contents[$i]);
+# Retrieve and remove temporary files created by/during autoenrollment.
+#
+# Formal Parameters:
+# $cmd - The command that got us dispatched.
+# $tail - The tail of the command. In our case this is a colon
+# separated list that will be split into:
+# $filename - The name of the file to remove.
+# The filename is given as a path relative to
+# the LonCAPA temp file directory.
+# $client - Socket open on the client.
+#
+# Returns:
+# 1 - Continue processing.
+sub retrieve_auto_file_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "cmd:$tail";
+
+ my ($filename) = split(/:/, $tail);
+
+ my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
+ if ( (-e $source) && ($filename ne '') ) {
+ my $reply = '';
+ if (open(my $fh,$source)) {
+ while (<$fh>) {
+ chomp($_);
+ $_ =~ s/^\s+//g;
+ $_ =~ s/\s+$//g;
+ $reply .= $_;
+ }
+ close($fh);
+ &Reply($client, &escape($reply)."\n", $userinput);
+
+# Does this have to be uncommented??!? (RF).
+#
+# unlink($source);
+ } else {
+ &Failure($client, "error\n", $userinput);
}
+ } else {
+ &Failure($client, "error\n", $userinput);
+ }
+
- $oldfh->close;
- $newfh->close;
+ return 1;
+}
+®ister_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
- chmod(0660, $newfile);
+sub crsreq_checks_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $dom = $tail;
+ my $result;
+ my @reqtypes = ('official','unofficial','community');
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ my %validations;
+ my $response = &localenroll::crsreq_checks($dom,\@reqtypes,
+ \%validations);
+ if ($response eq 'ok') {
+ foreach my $key (keys(%validations)) {
+ $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($validations{$key}).'&';
+ }
+ $result =~ s/\&$//;
+ } else {
+ $result = 'error';
+ }
+ };
+ if (!$@) {
+ &Reply($client, \$result, $userinput);
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
+ return 1;
+}
+®ister_handler("autocrsreqchecks", \&crsreq_checks_handler, 0, 1, 0);
- return 1;
-
+sub validate_crsreq_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = split(/:/, $tail);
+ $instcode = &unescape($instcode);
+ $owner = &unescape($owner);
+ $crstype = &unescape($crstype);
+ $inststatuslist = &unescape($inststatuslist);
+ $instcode = &unescape($instcode);
+ $instseclist = &unescape($instseclist);
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::validate_crsreq($dom,$owner,$crstype,
+ $inststatuslist,$instcode,
+ $instseclist);
+ };
+ if (!$@) {
+ &Reply($client, \$outcome, $userinput);
} else {
- return 0;
+ &Failure($client,"unknown_cmd\n",$userinput);
}
+ return 1;
}
+®ister_handler("autocrsreqvalidation", \&validate_crsreq_handler, 0, 1, 0);
+
#
-# Host files are passed out with externally visible host IPs.
-# If, for example, we are behind a fire-wall or NAT host, our
-# internally visible IP may be different than the externally
-# visible IP. Therefore, we always adjust the contents of the
-# host file so that the entry for ME is the IP that we believe
-# we have. At present, this is defined as the entry that
-# DNS has for us. If by some chance we are not able to get a
-# DNS translation for us, then we assume that the host.tab file
-# is correct.
-# BUGBUGBUG - in the future, we really should see if we can
-# easily query the interface(s) instead.
-# Parameter(s):
-# contents - The contents of the host.tab to check.
+# Read and retrieve institutional code format (for support form).
+# Formal Parameters:
+# $cmd - Command that dispatched us.
+# $tail - Tail of the command. In this case it conatins
+# the course domain and the coursename.
+# $client - Socket open on the client.
# Returns:
-# newcontents - The adjusted contents.
-#
+# 1 - Continue processing.
#
-sub AdjustHostContents {
- my $contents = shift;
- my $adjusted;
- my $me = $perlvar{'lonHostID'};
+sub get_institutional_code_format_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+
+ my $reply;
+ my($cdom,$course) = split(/:/,$tail);
+ my @pairs = split/\&/,$course;
+ my %instcodes = ();
+ my %codes = ();
+ my @codetitles = ();
+ my %cat_titles = ();
+ my %cat_order = ();
+ foreach (@pairs) {
+ my ($key,$value) = split/=/,$_;
+ $instcodes{&unescape($key)} = &unescape($value);
+ }
+ my $formatreply = &localenroll::instcode_format($cdom,
+ \%instcodes,
+ \%codes,
+ \@codetitles,
+ \%cat_titles,
+ \%cat_order);
+ if ($formatreply eq 'ok') {
+ my $codes_str = &Apache::lonnet::hash2str(%codes);
+ my $codetitles_str = &Apache::lonnet::array2str(@codetitles);
+ my $cat_titles_str = &Apache::lonnet::hash2str(%cat_titles);
+ my $cat_order_str = &Apache::lonnet::hash2str(%cat_order);
+ &Reply($client,
+ $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'
+ .$cat_order_str."\n",
+ $userinput);
+ } else {
+ # this else branch added by RF since if not ok, lonc will
+ # hang waiting on reply until timeout.
+ #
+ &Reply($client, "format_error\n", $userinput);
+ }
+
+ return 1;
+}
+®ister_handler("autoinstcodeformat",
+ \&get_institutional_code_format_handler,0,1,0);
- foreach my $line (split(/\n/,$contents)) {
- if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
- chomp($line);
- my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
- if ($id eq $me) {
- my $ip = gethostbyname($name);
- my $ipnew = inet_ntoa($ip);
- $ip = $ipnew;
- # Reconstruct the host line and append to adjusted:
-
- my $newline = "$id:$domain:$role:$name:$ip";
- if($maxcon ne "") { # Not all hosts have loncnew tuning params
- $newline .= ":$maxcon:$idleto:$mincon";
- }
- $adjusted .= $newline."\n";
-
- } else { # Not me, pass unmodified.
- $adjusted .= $line."\n";
- }
- } else { # Blank or comment never re-written.
- $adjusted .= $line."\n"; # Pass blanks and comments as is.
- }
+sub get_institutional_defaults_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+
+ my $dom = $tail;
+ my %defaults_hash;
+ my @code_order;
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::instcode_defaults($dom,\%defaults_hash,
+ \@code_order);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result='';
+ while (my ($key,$value) = each(%defaults_hash)) {
+ $result.=&escape($key).'='.&escape($value).'&';
+ }
+ $result .= 'code_order='.&escape(join('&',@code_order));
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
}
- return $adjusted;
}
-#
-# InstallFile: Called to install an administrative file:
-# - The file is created with <name>.tmp
-# - The <name>.tmp file is then mv'd to <name>
-# This lugubrious procedure is done to ensure that we are never without
-# a valid, even if dated, version of the file regardless of who crashes
-# and when the crash occurs.
-#
-# Parameters:
-# Name of the file
-# File Contents.
-# Return:
-# nonzero - success.
-# 0 - failure and $! has an errno.
-#
-sub InstallFile {
- my $Filename = shift;
- my $Contents = shift;
- my $TempFile = $Filename.".tmp";
+®ister_handler("autoinstcodedefaults",
+ \&get_institutional_defaults_handler,0,1,0);
- # Open the file for write:
-
- my $fh = IO::File->new("> $TempFile"); # Write to temp.
- if(!(defined $fh)) {
- &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
- return 0;
+sub get_possible_instcodes_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+
+ my $reply;
+ my $cdom = $tail;
+ my (@codetitles,%cat_titles,%cat_order,@code_order);
+ my $formatreply = &localenroll::possible_instcodes($cdom,
+ \@codetitles,
+ \%cat_titles,
+ \%cat_order,
+ \@code_order);
+ if ($formatreply eq 'ok') {
+ my $result = join('&',map {&escape($_);} (@codetitles)).':';
+ $result .= join('&',map {&escape($_);} (@code_order)).':';
+ foreach my $key (keys(%cat_titles)) {
+ $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_titles{$key}).'&';
+ }
+ $result =~ s/\&$//;
+ $result .= ':';
+ foreach my $key (keys(%cat_order)) {
+ $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_order{$key}).'&';
+ }
+ $result =~ s/\&$//;
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client, "format_error\n", $userinput);
}
- # write the contents of the file:
-
- print $fh ($Contents);
- $fh->close; # In case we ever have a filesystem w. locking
+ return 1;
+}
+®ister_handler("autopossibleinstcodes",
+ \&get_possible_instcodes_handler,0,1,0);
+
+sub get_institutional_user_rules {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $dom = &unescape($tail);
+ my (%rules_hash,@rules_order);
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::username_rules($dom,\%rules_hash,\@rules_order);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result;
+ foreach my $key (keys(%rules_hash)) {
+ $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
+ }
+ $result =~ s/\&$//;
+ $result .= ':';
+ if (@rules_order > 0) {
+ foreach my $item (@rules_order) {
+ $result .= &escape($item).'&';
+ }
+ }
+ $result =~ s/\&$//;
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
+}
+®ister_handler("instuserrules",\&get_institutional_user_rules,0,1,0);
- chmod(0660, $TempFile);
+sub get_institutional_id_rules {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $dom = &unescape($tail);
+ my (%rules_hash,@rules_order);
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::id_rules($dom,\%rules_hash,\@rules_order);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result;
+ foreach my $key (keys(%rules_hash)) {
+ $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
+ }
+ $result =~ s/\&$//;
+ $result .= ':';
+ if (@rules_order > 0) {
+ foreach my $item (@rules_order) {
+ $result .= &escape($item).'&';
+ }
+ }
+ $result =~ s/\&$//;
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
+}
+®ister_handler("instidrules",\&get_institutional_id_rules,0,1,0);
- # Now we can move install the file in position.
-
- move($TempFile, $Filename);
+sub get_institutional_selfcreate_rules {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $dom = &unescape($tail);
+ my (%rules_hash,@rules_order);
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::selfcreate_rules($dom,\%rules_hash,\@rules_order);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result;
+ foreach my $key (keys(%rules_hash)) {
+ $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
+ }
+ $result =~ s/\&$//;
+ $result .= ':';
+ if (@rules_order > 0) {
+ foreach my $item (@rules_order) {
+ $result .= &escape($item).'&';
+ }
+ }
+ $result =~ s/\&$//;
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
+}
+®ister_handler("instemailrules",\&get_institutional_selfcreate_rules,0,1,0);
- return 1;
+
+sub institutional_username_check {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my %rulecheck;
+ my $outcome;
+ my ($udom,$uname,@rules) = split(/:/,$tail);
+ $udom = &unescape($udom);
+ $uname = &unescape($uname);
+ @rules = map {&unescape($_);} (@rules);
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::username_check($udom,$uname,\@rules,\%rulecheck);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result='';
+ foreach my $key (keys(%rulecheck)) {
+ $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
+ }
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
}
-#
-# ConfigFileFromSelector: converts a configuration file selector
-# (one of host or domain at this point) into a
-# configuration file pathname.
-#
-# Parameters:
-# selector - Configuration file selector.
-# Returns:
-# Full path to the file or undef if the selector is invalid.
-#
-sub ConfigFileFromSelector {
- my $selector = shift;
- my $tablefile;
+®ister_handler("instrulecheck",\&institutional_username_check,0,1,0);
- my $tabledir = $perlvar{'lonTabDir'}.'/';
- if ($selector eq "hosts") {
- $tablefile = $tabledir."hosts.tab";
- } elsif ($selector eq "domain") {
- $tablefile = $tabledir."domain.tab";
+sub institutional_id_check {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my %rulecheck;
+ my $outcome;
+ my ($udom,$id,@rules) = split(/:/,$tail);
+ $udom = &unescape($udom);
+ $id = &unescape($id);
+ @rules = map {&unescape($_);} (@rules);
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::id_check($udom,$id,\@rules,\%rulecheck);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result='';
+ foreach my $key (keys(%rulecheck)) {
+ $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
+ }
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
} else {
- return undef;
+ &Failure($client,"unknown_cmd\n",$userinput);
}
- return $tablefile;
+}
+®ister_handler("instidrulecheck",\&institutional_id_check,0,1,0);
+sub institutional_selfcreate_check {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my %rulecheck;
+ my $outcome;
+ my ($udom,$email,@rules) = split(/:/,$tail);
+ $udom = &unescape($udom);
+ $email = &unescape($email);
+ @rules = map {&unescape($_);} (@rules);
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::selfcreate_check($udom,$email,\@rules,\%rulecheck);
+ };
+ if (!$@) {
+ if ($outcome eq 'ok') {
+ my $result='';
+ foreach my $key (keys(%rulecheck)) {
+ $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
+ }
+ &Reply($client,\$result,$userinput);
+ } else {
+ &Reply($client,"error\n", $userinput);
+ }
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
}
+®ister_handler("instselfcreatecheck",\&institutional_selfcreate_check,0,1,0);
+
+# Get domain specific conditions for import of student photographs to a course
#
-# PushFile: Called to do an administrative push of a file.
-# - Ensure the file being pushed is one we support.
-# - Backup the old file to <filename.saved>
-# - Separate the contents of the new file out from the
-# rest of the request.
-# - Write the new file.
-# Parameter:
-# Request - The entire user request. This consists of a : separated
-# string pushfile:tablename:contents.
-# NOTE: The contents may have :'s in it as well making things a bit
-# more interesting... but not much.
-# Returns:
-# String to send to client ("ok" or "refused" if bad file).
+# Retrieves information from photo_permission subroutine in localenroll.
+# Returns outcome (ok) if no processing errors, and whether course owner is
+# required to accept conditions of use (yes/no).
#
-sub PushFile {
- my $request = shift;
- my ($command, $filename, $contents) = split(":", $request, 3);
-
- # At this point in time, pushes for only the following tables are
- # supported:
- # hosts.tab ($filename eq host).
- # domain.tab ($filename eq domain).
- # Construct the destination filename or reject the request.
- #
- # lonManage is supposed to ensure this, however this session could be
- # part of some elaborate spoof that managed somehow to authenticate.
- #
+#
+sub photo_permission_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $cdom = $tail;
+ my ($perm_reqd,$conditions);
+ my $outcome;
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
+ \$conditions);
+ };
+ if (!$@) {
+ &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
+ $userinput);
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
+ }
+ return 1;
+}
+®ister_handler("autophotopermission",\&photo_permission_handler,0,1,0);
+#
+# Checks if student photo is available for a user in the domain, in the user's
+# directory (in /userfiles/internal/studentphoto.jpg).
+# Uses localstudentphoto:fetch() to ensure there is an up to date copy of
+# the student's photo.
- my $tablefile = ConfigFileFromSelector($filename);
- if(! (defined $tablefile)) {
- return "refused";
- }
- #
- # >copy< the old table to the backup table
- # don't rename in case system crashes/reboots etc. in the time
- # window between a rename and write.
- #
- my $backupfile = $tablefile;
- $backupfile =~ s/\.tab$/.old/;
- if(!CopyFile($tablefile, $backupfile)) {
- &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");
- return "error:$!";
+sub photo_check_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my ($udom,$uname,$pid) = split(/:/,$tail);
+ $udom = &unescape($udom);
+ $uname = &unescape($uname);
+ $pid = &unescape($pid);
+ my $path=&propath($udom,$uname).'/userfiles/internal/';
+ if (!-e $path) {
+ &mkpath($path);
}
- &logthis('<font color="green"> Pushfile: backed up '
- .$tablefile." to $backupfile</font>");
-
- # If the file being pushed is the host file, we adjust the entry for ourself so that the
- # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
- # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
- # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
- # that possibilty.
+ my $response;
+ my $result = &localstudentphoto::fetch($udom,$uname,$pid,\$response);
+ $result .= ':'.$response;
+ &Reply($client, &escape($result)."\n",$userinput);
+ return 1;
+}
+®ister_handler("autophotocheck",\&photo_check_handler,0,1,0);
- if($filename eq "host") {
- $contents = AdjustHostContents($contents);
+#
+# Retrieve information from localenroll about whether to provide a button
+# for users who have enbled import of student photos to initiate an
+# update of photo files for registered students. Also include
+# comment to display alongside button.
+
+sub photo_choice_handler {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+ my $cdom = &unescape($tail);
+ my ($update,$comment);
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ ($update,$comment) = &localenroll::manager_photo_update($cdom);
+ };
+ if (!$@) {
+ &Reply($client,&escape($update).':'.&escape($comment)."\n",$userinput);
+ } else {
+ &Failure($client,"unknown_cmd\n",$userinput);
}
+ return 1;
+}
+®ister_handler("autophotochoice",\&photo_choice_handler,0,1,0);
- # Install the new file:
+#
+# Gets a student's photo to exist (in the correct image type) in the user's
+# directory.
+# Formal Parameters:
+# $cmd - The command request that got us dispatched.
+# $tail - A colon separated set of words that will be split into:
+# $domain - student's domain
+# $uname - student username
+# $type - image type desired
+# $client - The socket open on the client.
+# Returns:
+# 1 - continue processing.
- if(!InstallFile($tablefile, $contents)) {
- &logthis('<font color="red"> Pushfile: unable to install '
- .$tablefile." $! </font>");
- return "error:$!";
+sub student_photo_handler {
+ my ($cmd, $tail, $client) = @_;
+ my ($domain,$uname,$ext,$type) = split(/:/, $tail);
+
+ my $path=&propath($domain,$uname). '/userfiles/internal/';
+ my $filename = 'studentphoto.'.$ext;
+ if ($type eq 'thumbnail') {
+ $filename = 'studentphoto_tn.'.$ext;
+ }
+ if (-e $path.$filename) {
+ &Reply($client,"ok\n","$cmd:$tail");
+ return 1;
+ }
+ &mkpath($path);
+ my $file;
+ if ($type eq 'thumbnail') {
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $file=&localstudentphoto::fetch_thumbnail($domain,$uname);
+ };
} else {
- &logthis('<font color="green"> Installed new '.$tablefile
- ."</font>");
-
+ $file=&localstudentphoto::fetch($domain,$uname);
}
+ if (!$file) {
+ &Failure($client,"unavailable\n","$cmd:$tail");
+ return 1;
+ }
+ if (!-e $path.$filename) { &convert_photo($file,$path.$filename); }
+ if (-e $path.$filename) {
+ &Reply($client,"ok\n","$cmd:$tail");
+ return 1;
+ }
+ &Failure($client,"unable_to_convert\n","$cmd:$tail");
+ return 1;
+}
+®ister_handler("studentphoto", \&student_photo_handler, 0, 1, 0);
+sub inst_usertypes_handler {
+ my ($cmd, $domain, $client) = @_;
+ my $res;
+ my $userinput = $cmd.":".$domain; # For logging purposes.
+ my (%typeshash,@order,$result);
+ eval {
+ local($SIG{__DIE__})='DEFAULT';
+ $result=&localenroll::inst_usertypes($domain,\%typeshash,\@order);
+ };
+ if ($result eq 'ok') {
+ if (keys(%typeshash) > 0) {
+ foreach my $key (keys(%typeshash)) {
+ $res.=&escape($key).'='.&escape($typeshash{$key}).'&';
+ }
+ }
+ $res=~s/\&$//;
+ $res .= ':';
+ if (@order > 0) {
+ foreach my $item (@order) {
+ $res .= &escape($item).'&';
+ }
+ }
+ $res=~s/\&$//;
+ }
+ &Reply($client, \$res, $userinput);
+ return 1;
+}
+®ister_handler("inst_usertypes", \&inst_usertypes_handler, 0, 1, 0);
- # Indicate success:
-
- return "ok";
-
+# mkpath makes all directories for a file, expects an absolute path with a
+# file or a trailing / if just a dir is passed
+# returns 1 on success 0 on failure
+sub mkpath {
+ my ($file)=@_;
+ my @parts=split(/\//,$file,-1);
+ my $now=$parts[0].'/'.$parts[1].'/'.$parts[2];
+ for (my $i=3;$i<= ($#parts-1);$i++) {
+ $now.='/'.$parts[$i];
+ if (!-e $now) {
+ if (!mkdir($now,0770)) { return 0; }
+ }
+ }
+ return 1;
}
+#---------------------------------------------------------------
#
-# Called to re-init either lonc or lond.
+# Getting, decoding and dispatching requests:
#
-# Parameters:
-# request - The full request by the client. This is of the form
-# reinit:<process>
-# where <process> is allowed to be either of
-# lonc or lond
-#
-# Returns:
-# The string to be sent back to the client either:
-# ok - Everything worked just fine.
-# error:why - There was a failure and why describes the reason.
#
+# Get a Request:
+# Gets a Request message from the client. The transaction
+# is defined as a 'line' of text. We remove the new line
+# from the text line.
#
-sub ReinitProcess {
- my $request = shift;
+sub get_request {
+ my $input = <$client>;
+ chomp($input);
+ &Debug("get_request: Request = $input\n");
- # separate the request (reinit) from the process identifier and
- # validate it producing the name of the .pid file for the process.
- #
- #
- my ($junk, $process) = split(":", $request);
- my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
- if($process eq 'lonc') {
- $processpidfile = $processpidfile."lonc.pid";
- if (!open(PIDFILE, "< $processpidfile")) {
- return "error:Open failed for $processpidfile";
- }
- my $loncpid = <PIDFILE>;
- close(PIDFILE);
- logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
- ."</font>");
- kill("USR2", $loncpid);
- } elsif ($process eq 'lond') {
- logthis('<font color="red"> Reinitializing self (lond) </font>');
- &UpdateHosts; # Lond is us!!
- } else {
- &logthis('<font color="yellow" Invalid reinit request for '.$process
- ."</font>");
- return "error:Invalid process identifier $process";
- }
- return 'ok';
+ &status('Processing '.$clientname.':'.$input);
+
+ return $input;
}
-# Validate a line in a configuration file edit script:
-# Validation includes:
-# - Ensuring the command is valid.
-# - Ensuring the command has sufficient parameters
-# Parameters:
-# scriptline - A line to validate (\n has been stripped for what it's worth).
+#---------------------------------------------------------------
#
-# Return:
-# 0 - Invalid scriptline.
-# 1 - Valid scriptline
-# NOTE:
-# Only the command syntax is checked, not the executability of the
-# command.
+# Process a request. This sub should shrink as each action
+# gets farmed out into a separat sub that is registered
+# with the dispatch hash.
#
-sub isValidEditCommand {
- my $scriptline = shift;
-
- # Line elements are pipe separated:
-
- my ($command, $key, $newline) = split(/\|/, $scriptline);
- &logthis('<font color="green"> isValideditCommand checking: '.
- "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
-
- if ($command eq "delete") {
- #
- # key with no newline.
- #
- if( ($key eq "") || ($newline ne "")) {
- return 0; # Must have key but no newline.
- } else {
- return 1; # Valid syntax.
- }
- } elsif ($command eq "replace") {
- #
- # key and newline:
- #
- if (($key eq "") || ($newline eq "")) {
- return 0;
+# Parameters:
+# user_input - The request received from the client (lonc).
+# Returns:
+# true to keep processing, false if caller should exit.
+#
+sub process_request {
+ my ($userinput) = @_; # Easier for now to break style than to
+ # fix all the userinput -> user_input.
+ my $wasenc = 0; # True if request was encrypted.
+# ------------------------------------------------------------ See if encrypted
+ # for command
+ # sethost:<server>
+ # <command>:<args>
+ # we just send it to the processor
+ # for
+ # sethost:<server>:<command>:<args>
+ # we do the implict set host and then do the command
+ if ($userinput =~ /^sethost:/) {
+ (my $cmd,my $newid,$userinput) = split(':',$userinput,3);
+ if (defined($userinput)) {
+ &sethost("$cmd:$newid");
} else {
- return 1;
+ $userinput = "$cmd:$newid";
}
- } elsif ($command eq "append") {
- if (($key ne "") && ($newline eq "")) {
- return 1;
- } else {
+ }
+
+ if ($userinput =~ /^enc/) {
+ $userinput = decipher($userinput);
+ $wasenc=1;
+ if(!$userinput) { # Cipher not defined.
+ &Failure($client, "error: Encrypted data without negotated key\n");
return 0;
}
- } else {
- return 0; # Invalid command.
}
- return 0; # Should not get here!!!
-}
-#
-# ApplyEdit - Applies an edit command to a line in a configuration
-# file. It is the caller's responsiblity to validate the
-# edit line.
-# Parameters:
-# $directive - A single edit directive to apply.
-# Edit directives are of the form:
-# append|newline - Appends a new line to the file.
-# replace|key|newline - Replaces the line with key value 'key'
-# delete|key - Deletes the line with key value 'key'.
-# $editor - A config file editor object that contains the
-# file being edited.
-#
-sub ApplyEdit {
- my $directive = shift;
- my $editor = shift;
-
- # Break the directive down into its command and its parameters
- # (at most two at this point. The meaning of the parameters, if in fact
- # they exist depends on the command).
-
- my ($command, $p1, $p2) = split(/\|/, $directive);
+ Debug("process_request: $userinput\n");
+
+ #
+ # The 'correct way' to add a command to lond is now to
+ # write a sub to execute it and Add it to the command dispatch
+ # hash via a call to register_handler.. The comments to that
+ # sub should give you enough to go on to show how to do this
+ # along with the examples that are building up as this code
+ # is getting refactored. Until all branches of the
+ # if/elseif monster below have been factored out into
+ # separate procesor subs, if the dispatch hash is missing
+ # the command keyword, we will fall through to the remainder
+ # of the if/else chain below in order to keep this thing in
+ # working order throughout the transmogrification.
- if($command eq "append") {
- $editor->Append($p1); # p1 - key p2 null.
- } elsif ($command eq "replace") {
- $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
- } elsif ($command eq "delete") {
- $editor->DeleteLine($p1); # p1 - key p2 null.
- } else { # Should not get here!!!
- die "Invalid command given to ApplyEdit $command";
+ my ($command, $tail) = split(/:/, $userinput, 2);
+ chomp($command);
+ chomp($tail);
+ $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
+ $command =~ s/(\r)//; # And this too for parameterless commands.
+ if(!$tail) {
+ $tail =""; # defined but blank.
}
-}
-#
-# AdjustOurHost:
-# Adjusts a host file stored in a configuration file editor object
-# for the true IP address of this host. This is necessary for hosts
-# that live behind a firewall.
-# Those hosts have a publicly distributed IP of the firewall, but
-# internally must use their actual IP. We assume that a given
-# host only has a single IP interface for now.
-# Formal Parameters:
-# editor - The configuration file editor to adjust. This
-# editor is assumed to contain a hosts.tab file.
-# Strategy:
-# - Figure out our hostname.
-# - Lookup the entry for this host.
-# - Modify the line to contain our IP
-# - Do a replace for this host.
-sub AdjustOurHost {
- my $editor = shift;
- # figure out who I am.
+ &Debug("Command received: $command, encoded = $wasenc");
- my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
+ if(defined $Dispatcher{$command}) {
- # Get my host file entry.
+ my $dispatch_info = $Dispatcher{$command};
+ my $handler = $$dispatch_info[0];
+ my $need_encode = $$dispatch_info[1];
+ my $client_types = $$dispatch_info[2];
+ Debug("Matched dispatch hash: mustencode: $need_encode "
+ ."ClientType $client_types");
+
+ # Validate the request:
+
+ my $ok = 1;
+ my $requesterprivs = 0;
+ if(&isClient()) {
+ $requesterprivs |= $CLIENT_OK;
+ }
+ if(&isManager()) {
+ $requesterprivs |= $MANAGER_OK;
+ }
+ if($need_encode && (!$wasenc)) {
+ Debug("Must encode but wasn't: $need_encode $wasenc");
+ $ok = 0;
+ }
+ if(($client_types & $requesterprivs) == 0) {
+ Debug("Client not privileged to do this operation");
+ $ok = 0;
+ }
- my $ConfigLine = $editor->Find($myHostName);
- if(! (defined $ConfigLine)) {
- die "AdjustOurHost - no entry for me in hosts file $myHostName";
- }
- # figure out my IP:
- # Use the config line to get my hostname.
- # Use gethostbyname to translate that into an IP address.
- #
- my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
- my $BinaryIp = gethostbyname($name);
- my $ip = inet_ntoa($ip);
- #
- # Reassemble the config line from the elements in the list.
- # Note that if the loncnew items were not present before, they will
- # be now even if they would be empty
- #
- my $newConfigLine = $id;
- foreach my $item ($domain, $role, $name, $ip, $maxcon, $idleto, $mincon) {
- $newConfigLine .= ":".$item;
- }
- # Replace the line:
+ if($ok) {
+ Debug("Dispatching to handler $command $tail");
+ my $keep_going = &$handler($command, $tail, $client);
+ return $keep_going;
+ } else {
+ Debug("Refusing to dispatch because client did not match requirements");
+ Failure($client, "refused\n", $userinput);
+ return 1;
+ }
- $editor->ReplaceLine($id, $newConfigLine);
-
+ }
+
+ print $client "unknown_cmd\n";
+# -------------------------------------------------------------------- complete
+ Debug("process_request - returning 1");
+ return 1;
}
#
-# ReplaceConfigFile:
-# Replaces a configuration file with the contents of a
-# configuration file editor object.
-# This is done by:
-# - Copying the target file to <filename>.old
-# - Writing the new file to <filename>.tmp
-# - Moving <filename.tmp> -> <filename>
-# This laborious process ensures that the system is never without
-# a configuration file that's at least valid (even if the contents
-# may be dated).
-# Parameters:
-# filename - Name of the file to modify... this is a full path.
-# editor - Editor containing the file.
+# Decipher encoded traffic
+# Parameters:
+# input - Encoded data.
+# Returns:
+# Decoded data or undef if encryption key was not yet negotiated.
+# Implicit input:
+# cipher - This global holds the negotiated encryption key.
#
-sub ReplaceConfigFile {
- my $filename = shift;
- my $editor = shift;
-
- CopyFile ($filename, $filename.".old");
-
- my $contents = $editor->Get(); # Get the contents of the file.
-
- InstallFile($filename, $contents);
+sub decipher {
+ my ($input) = @_;
+ my $output = '';
+
+
+ if($cipher) {
+ my($enc, $enclength, $encinput) = split(/:/, $input);
+ for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
+ $output .=
+ $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
+ }
+ return substr($output, 0, $enclength);
+ } else {
+ return undef;
+ }
}
-#
+
#
-# Called to edit a configuration table file
+# Register a command processor. This function is invoked to register a sub
+# to process a request. Once registered, the ProcessRequest sub can automatically
+# dispatch requests to an appropriate sub, and do the top level validity checking
+# as well:
+# - Is the keyword recognized.
+# - Is the proper client type attempting the request.
+# - Is the request encrypted if it has to be.
# Parameters:
-# request - The entire command/request sent by lonc or lonManage
-# Return:
-# The reply to send to the client.
+# $request_name - Name of the request being registered.
+# This is the command request that will match
+# against the hash keywords to lookup the information
+# associated with the dispatch information.
+# $procedure - Reference to a sub to call to process the request.
+# All subs get called as follows:
+# Procedure($cmd, $tail, $replyfd, $key)
+# $cmd - the actual keyword that invoked us.
+# $tail - the tail of the request that invoked us.
+# $replyfd- File descriptor connected to the client
+# $must_encode - True if the request must be encoded to be good.
+# $client_ok - True if it's ok for a client to request this.
+# $manager_ok - True if it's ok for a manager to request this.
+# Side effects:
+# - On success, the Dispatcher hash has an entry added for the key $RequestName
+# - On failure, the program will die as it's a bad internal bug to try to
+# register a duplicate command handler.
#
-sub EditFile {
- my $request = shift;
-
- # Split the command into it's pieces: edit:filetype:script
-
- my ($request, $filetype, $script) = split(/:/, $request,3); # : in script
+sub register_handler {
+ my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
- # Check the pre-coditions for success:
-
- if($request != "edit") { # Something is amiss afoot alack.
- return "error:edit request detected, but request != 'edit'\n";
+ # Don't allow duplication#
+
+ if (defined $Dispatcher{$request_name}) {
+ die "Attempting to define a duplicate request handler for $request_name\n";
}
- if( ($filetype ne "hosts") &&
- ($filetype ne "domain")) {
- return "error:edit requested with invalid file specifier: $filetype \n";
+ # Build the client type mask:
+
+ my $client_type_mask = 0;
+ if($client_ok) {
+ $client_type_mask |= $CLIENT_OK;
}
+ if($manager_ok) {
+ $client_type_mask |= $MANAGER_OK;
+ }
+
+ # Enter the hash:
+
+ my @entry = ($procedure, $must_encode, $client_type_mask);
+
+ $Dispatcher{$request_name} = \@entry;
+
+}
- # Split the edit script and check it's validity.
- my @scriptlines = split(/\n/, $script); # one line per element.
- my $linecount = scalar(@scriptlines);
- for(my $i = 0; $i < $linecount; $i++) {
- chomp($scriptlines[$i]);
- if(!isValidEditCommand($scriptlines[$i])) {
- return "error:edit with bad script line: '$scriptlines[$i]' \n";
- }
- }
+#------------------------------------------------------------------
+
- # Execute the edit operation.
- # - Create a config file editor for the appropriate file and
- # - execute each command in the script:
- #
- my $configfile = ConfigFileFromSelector($filetype);
- if (!(defined $configfile)) {
- return "refused\n";
- }
- my $editor = ConfigFileEdit->new($configfile);
- for (my $i = 0; $i < $linecount; $i++) {
- ApplyEdit($scriptlines[$i], $editor);
- }
- # If the file is the host file, ensure that our host is
- # adjusted to have our ip:
- #
- if($filetype eq "host") {
- AdjustOurHost($editor);
- }
- # Finally replace the current file with our file.
- #
- ReplaceConfigFile($configfile, $editor);
- return "ok\n";
-}
#
# Convert an error return code from lcpasswd to a string value.
#
@@ -3459,22 +5937,22 @@ sub catchexception {
$SIG{'QUIT'}='DEFAULT';
$SIG{__DIE__}='DEFAULT';
&status("Catching exception");
- &logthis("<font color=red>CRITICAL: "
- ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
- ."a crash with this error msg->[$error]</font>");
+ &logthis("<font color='red'>CRITICAL: "
+ ."ABNORMAL EXIT. Child $$ for server ".$perlvar{'lonHostID'}." died through "
+ ."a crash with this error msg->[$error]</font>");
&logthis('Famous last words: '.$status.' - '.$lastlog);
if ($client) { print $client "error: $error\n"; }
$server->close();
die($error);
}
-
sub timeout {
&status("Handling Timeout");
- &logthis("<font color=ref>CRITICAL: TIME OUT ".$$."</font>");
+ &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
&catchexception('Timeout');
}
# -------------------------------- Set signal handlers to record abnormal exits
+
$SIG{'QUIT'}=\&catchexception;
$SIG{__DIE__}=\&catchexception;
@@ -3487,11 +5965,11 @@ undef $perlvarref;
# ----------------------------- Make sure this process is running from user=www
my $wwwid=getpwnam('www');
if ($wwwid!=$<) {
- my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
- my $subj="LON: $currenthostid User ID mismatch";
- system("echo 'User ID mismatch. lond must be run as user www.' |\
+ my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
+ my $subj="LON: $currenthostid User ID mismatch";
+ system("echo 'User ID mismatch. lond must be run as user www.' |\
mailto $emailto -s '$subj' > /dev/null");
- exit 1;
+ exit 1;
}
# --------------------------------------------- Check if other instance running
@@ -3499,10 +5977,10 @@ if ($wwwid!=$<) {
my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
if (-e $pidfile) {
- my $lfh=IO::File->new("$pidfile");
- my $pide=<$lfh>;
- chomp($pide);
- if (kill 0 => $pide) { die "already running"; }
+ my $lfh=IO::File->new("$pidfile");
+ my $pide=<$lfh>;
+ chomp($pide);
+ if (kill 0 => $pide) { die "already running"; }
}
# ------------------------------------------------------------- Read hosts file
@@ -3515,25 +5993,33 @@ $server = IO::Socket::INET->new(LocalPor
Proto => 'tcp',
Reuse => 1,
Listen => 10 )
- or die "making socket: $@\n";
+ or die "making socket: $@\n";
# --------------------------------------------------------- Do global variables
# global variables
my %children = (); # keys are current child process IDs
-my $children = 0; # current number of children
sub REAPER { # takes care of dead children
$SIG{CHLD} = \&REAPER;
&status("Handling child death");
- my $pid = wait;
- if (defined($children{$pid})) {
- &logthis("Child $pid died");
- $children --;
- delete $children{$pid};
- } else {
- &logthis("Unknown Child $pid died");
+ my $pid;
+ do {
+ $pid = waitpid(-1,&WNOHANG());
+ if (defined($children{$pid})) {
+ &logthis("Child $pid died");
+ delete($children{$pid});
+ } elsif ($pid > 0) {
+ &logthis("Unknown Child $pid died");
+ }
+ } while ( $pid > 0 );
+ foreach my $child (keys(%children)) {
+ $pid = waitpid($child,&WNOHANG());
+ if ($pid > 0) {
+ &logthis("Child $child - $pid looks like we missed it's death");
+ delete($children{$pid});
+ }
}
&status("Finished Handling child death");
}
@@ -3545,7 +6031,7 @@ sub HUNTSMAN { # si
&logthis("Free socket: ".shutdown($server,2)); # free up socket
my $execdir=$perlvar{'lonDaemons'};
unlink("$execdir/logs/lond.pid");
- &logthis("<font color=red>CRITICAL: Shutting down</font>");
+ &logthis("<font color='red'>CRITICAL: Shutting down</font>");
&status("Done killing children");
exit; # clean up with dignity
}
@@ -3555,7 +6041,7 @@ sub HUPSMAN { # sig
&status("Killing children for restart (HUP)");
kill 'INT' => keys %children;
&logthis("Free socket: ".shutdown($server,2)); # free up socket
- &logthis("<font color=red>CRITICAL: Restarting</font>");
+ &logthis("<font color='red'>CRITICAL: Restarting</font>");
my $execdir=$perlvar{'lonDaemons'};
unlink("$execdir/logs/lond.pid");
&status("Restarting self (HUP)");
@@ -3563,42 +6049,6 @@ sub HUPSMAN { # sig
}
#
-# Kill off hashes that describe the host table prior to re-reading it.
-# Hashes affected are:
-# %hostid, %hostdom %hostip
-#
-sub KillHostHashes {
- foreach my $key (keys %hostid) {
- delete $hostid{$key};
- }
- foreach my $key (keys %hostdom) {
- delete $hostdom{$key};
- }
- foreach my $key (keys %hostip) {
- delete $hostip{$key};
- }
-}
-#
-# Read in the host table from file and distribute it into the various hashes:
-#
-# - %hostid - Indexed by IP, the loncapa hostname.
-# - %hostdom - Indexed by loncapa hostname, the domain.
-# - %hostip - Indexed by hostid, the Ip address of the host.
-sub ReadHostTable {
-
- open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
-
- while (my $configline=<CONFIG>) {
- my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
- chomp($ip); $ip=~s/\D+$//;
- $hostid{$ip}=$id;
- $hostdom{$id}=$domain;
- $hostip{$id}=$ip;
- if ($id eq $perlvar{'lonHostID'}) { $thisserver=$name; }
- }
- close(CONFIG);
-}
-#
# Reload the Apache daemon's state.
# This is done by invoking /home/httpd/perl/apachereload
# a setuid perl script that can be root for us to do this job.
@@ -3629,13 +6079,12 @@ sub UpdateHosts {
# either dropped or changed hosts. Note that the re-read of the table
# will take care of new and changed hosts as connections come into being.
+ &Apache::lonnet::reset_hosts_info();
- KillHostHashes;
- ReadHostTable;
-
- foreach my $child (keys %children) {
+ foreach my $child (keys(%children)) {
my $childip = $children{$child};
- if(!$hostid{$childip}) {
+ if ($childip ne '127.0.0.1'
+ && !defined(&Apache::lonnet::get_hosts_from_ip($childip))) {
logthis('<font color="blue"> UpdateHosts killing child '
." $child for ip $childip </font>");
kill('INT', $child);
@@ -3656,34 +6105,38 @@ sub checkchildren {
&logthis('Going to check on the children');
my $docdir=$perlvar{'lonDocRoot'};
foreach (sort keys %children) {
- sleep 1;
+ #sleep 1;
unless (kill 'USR1' => $_) {
&logthis ('Child '.$_.' is dead');
&logstatus($$.' is dead');
+ delete($children{$_});
}
}
sleep 5;
- $SIG{ALRM} = sub { die "timeout" };
+ $SIG{ALRM} = sub { Debug("timeout");
+ die "timeout"; };
$SIG{__DIE__} = 'DEFAULT';
&status("Checking on the children (waiting for reports)");
foreach (sort keys %children) {
unless (-e "$docdir/lon-status/londchld/$_.txt") {
- eval {
- alarm(300);
- &logthis('Child '.$_.' did not respond');
- kill 9 => $_;
- #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
- #$subj="LON: $currenthostid killed lond process $_";
- #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
- #$execdir=$perlvar{'lonDaemons'};
- #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
- alarm(0);
- }
+ eval {
+ alarm(300);
+ &logthis('Child '.$_.' did not respond');
+ kill 9 => $_;
+ #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
+ #$subj="LON: $currenthostid killed lond process $_";
+ #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
+ #$execdir=$perlvar{'lonDaemons'};
+ #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
+ delete($children{$_});
+ alarm(0);
+ }
}
}
$SIG{ALRM} = 'DEFAULT';
$SIG{__DIE__} = \&catchexception;
&status("Finished checking children");
+ &logthis('Finished Checking children');
}
# --------------------------------------------------------------------- Logging
@@ -3714,22 +6167,20 @@ sub Debug {
# reply - Text to send to client.
# request - Original request from client.
#
-# Note: This increments Transactions
-#
sub Reply {
- alarm(120);
- my $fd = shift;
- my $reply = shift;
- my $request = shift;
-
- print $fd $reply;
- Debug("Request was $request Reply was $reply");
-
+ my ($fd, $reply, $request) = @_;
+ if (ref($reply)) {
+ print $fd $$reply;
+ print $fd "\n";
+ if ($DEBUG) { Debug("Request was $request Reply was $$reply"); }
+ } else {
+ print $fd $reply;
+ if ($DEBUG) { Debug("Request was $request Reply was $reply"); }
+ }
$Transactions++;
- alarm(0);
+}
-}
#
# Sub to report a failure.
# This function:
@@ -3759,19 +6210,20 @@ sub logstatus {
&status("Doing logging");
my $docdir=$perlvar{'lonDocRoot'};
{
- my $fh=IO::File->new(">>$docdir/lon-status/londstatus.txt");
- print $fh $$."\t".$currenthostid."\t".$status."\t".$lastlog."\n";
- $fh->close();
+ my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
+ print $fh $status."\n".$lastlog."\n".time."\n$keymode";
+ $fh->close();
}
- &status("Finished londstatus.txt");
+ &status("Finished $$.txt");
{
- my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
- print $fh $status."\n".$lastlog."\n".time;
- $fh->close();
+ open(LOG,">>$docdir/lon-status/londstatus.txt");
+ flock(LOG,LOCK_EX);
+ print LOG $$."\t".$clientname."\t".$currenthostid."\t"
+ .$status."\t".$lastlog."\t $keymode\n";
+ flock(LOG,LOCK_UN);
+ close(LOG);
}
- ResetStatistics;
&status("Finished logging");
-
}
sub initnewstatus {
@@ -3793,124 +6245,34 @@ sub status {
my $what=shift;
my $now=time;
my $local=localtime($now);
- my $status = "lond: $what $local ";
- if($Transactions) {
- $status .= " Transactions: $Transactions Failed; $Failures";
- }
- $0=$status;
-}
-
-# -------------------------------------------------------- Escape Special Chars
-
-sub escape {
- my $str=shift;
- $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
- return $str;
-}
-
-# ----------------------------------------------------- Un-Escape Special Chars
-
-sub unescape {
- my $str=shift;
- $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
- return $str;
-}
-
-# ----------------------------------------------------------- Send USR1 to lonc
-
-sub reconlonc {
- my $peerfile=shift;
- &logthis("Trying to reconnect for $peerfile");
- my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
- if (my $fh=IO::File->new("$loncfile")) {
- my $loncpid=<$fh>;
- chomp($loncpid);
- if (kill 0 => $loncpid) {
- &logthis("lonc at pid $loncpid responding, sending USR1");
- kill USR1 => $loncpid;
- } else {
- &logthis("<font color=red>CRITICAL: "
- ."lonc at pid $loncpid not responding, giving up</font>");
- }
- } else {
- &logthis('<font color=red>CRITICAL: lonc not running, giving up</font>');
- }
-}
-
-# -------------------------------------------------- Non-critical communication
-
-sub subreply {
- my ($cmd,$server)=@_;
- my $peerfile="$perlvar{'lonSockDir'}/$server";
- my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
- Type => SOCK_STREAM,
- Timeout => 10)
- or return "con_lost";
- print $sclient "$cmd\n";
- my $answer=<$sclient>;
- chomp($answer);
- if (!$answer) { $answer="con_lost"; }
- return $answer;
-}
-
-sub reply {
- my ($cmd,$server)=@_;
- my $answer;
- if ($server ne $currenthostid) {
- $answer=subreply($cmd,$server);
- if ($answer eq 'con_lost') {
- $answer=subreply("ping",$server);
- if ($answer ne $server) {
- &logthis("sub reply: answer != server answer is $answer, server is $server");
- &reconlonc("$perlvar{'lonSockDir'}/$server");
- }
- $answer=subreply($cmd,$server);
- }
- } else {
- $answer='self_reply';
- }
- return $answer;
+ $status=$local.': '.$what;
+ $0='lond: '.$what.' '.$local;
}
# -------------------------------------------------------------- Talk to lonsql
-sub sqlreply {
+sub sql_reply {
my ($cmd)=@_;
- my $answer=subsqlreply($cmd);
- if ($answer eq 'con_lost') { $answer=subsqlreply($cmd); }
+ my $answer=&sub_sql_reply($cmd);
+ if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
return $answer;
}
-sub subsqlreply {
+sub sub_sql_reply {
my ($cmd)=@_;
my $unixsock="mysqlsock";
my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
Type => SOCK_STREAM,
Timeout => 10)
- or return "con_lost";
- print $sclient "$cmd\n";
+ or return "con_lost";
+ print $sclient "$cmd:$currentdomainid\n";
my $answer=<$sclient>;
chomp($answer);
if (!$answer) { $answer="con_lost"; }
return $answer;
}
-# -------------------------------------------- Return path to profile directory
-
-sub propath {
- my ($udom,$uname)=@_;
- Debug("Propath:$udom:$uname");
- $udom=~s/\W//g;
- $uname=~s/\W//g;
- Debug("Propath2:$udom:$uname");
- my $subdir=$uname.'__';
- $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
- my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
- Debug("Propath returning $proname");
- return $proname;
-}
-
# --------------------------------------- Is this the home server of an author?
sub ishome {
@@ -3940,7 +6302,7 @@ my $execdir=$perlvar{'lonDaemons'};
open (PIDSAVE,">$execdir/logs/lond.pid");
print PIDSAVE "$$\n";
close(PIDSAVE);
-&logthis("<font color=red>CRITICAL: ---------- Starting ----------</font>");
+&logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
&status('Starting');
@@ -3955,9 +6317,10 @@ $SIG{USR1} = \&checkchildren;
$SIG{USR2} = \&UpdateHosts;
# Read the host hashes:
+&Apache::lonnet::load_hosts_tab();
+my %iphost = &Apache::lonnet::get_iphost(1);
-ReadHostTable;
-
+my $dist=`$perlvar{'lonDaemons'}/distprobe`;
# --------------------------------------------------------------
# Accept connections. When a connection comes in, it is validated
@@ -3974,6 +6337,7 @@ while (1) {
sub make_new_child {
my $pid;
+# my $cipher; # Now global
my $sigset;
$client = shift;
@@ -3984,7 +6348,7 @@ sub make_new_child {
$sigset = POSIX::SigSet->new(SIGINT);
sigprocmask(SIG_BLOCK, $sigset)
or die "Can't block SIGINT for fork: $!\n";
-
+
die "fork: $!" unless defined ($pid = fork);
$client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
@@ -3995,15 +6359,25 @@ sub make_new_child {
# the pid hash.
#
my $caller = getpeername($client);
- my ($port,$iaddr)=unpack_sockaddr_in($caller);
- $clientip=inet_ntoa($iaddr);
+ my ($port,$iaddr);
+ if (defined($caller) && length($caller) > 0) {
+ ($port,$iaddr)=unpack_sockaddr_in($caller);
+ } else {
+ &logthis("Unable to determine who caller was, getpeername returned nothing");
+ }
+ if (defined($iaddr)) {
+ $clientip = inet_ntoa($iaddr);
+ Debug("Connected with $clientip");
+ } else {
+ &logthis("Unable to determine clientip");
+ $clientip='Unavailable';
+ }
if ($pid) {
# Parent records the child's birth and returns.
sigprocmask(SIG_UNBLOCK, $sigset)
or die "Can't unblock SIGINT for fork: $!\n";
$children{$pid} = $clientip;
- $children++;
&status('Started child '.$pid);
return;
} else {
@@ -4020,100 +6394,170 @@ sub make_new_child {
sigprocmask(SIG_UNBLOCK, $sigset)
or die "Can't unblock SIGINT for fork: $!\n";
-
-
+# my $tmpsnum=0; # Now global
+#---------------------------------------------------- kerberos 5 initialization
&Authen::Krb5::init_context();
- &Authen::Krb5::init_ets();
-
+ unless (($dist eq 'fedora5') || ($dist eq 'fedora4') ||
+ ($dist eq 'fedora6') || ($dist eq 'suse9.3')) {
+ &Authen::Krb5::init_ets();
+ }
+
&status('Accepted connection');
# =============================================================================
# do something with the connection
# -----------------------------------------------------------------------------
- # see if we know client and check for spoof IP by challenge
+ # see if we know client and 'check' for spoof IP by ineffective challenge
- ReadManagerTable; # May also be a manager!!
-
- my $clientrec=($hostid{$clientip} ne undef);
- my $ismanager=($managers{$clientip} ne undef);
- $clientname = "[unknonwn]";
+ my $outsideip=$clientip;
+ if ($clientip eq '127.0.0.1') {
+ $outsideip=&Apache::lonnet::get_host_ip($perlvar{'lonHostID'});
+ }
+ &ReadManagerTable();
+ my $clientrec=defined(&Apache::lonnet::get_hosts_from_ip($outsideip));
+ my $ismanager=($managers{$outsideip} ne undef);
+ $clientname = "[unknown]";
if($clientrec) { # Establish client type.
$ConnectionType = "client";
- $clientname = $hostid{$clientip};
+ $clientname = (&Apache::lonnet::get_hosts_from_ip($outsideip))[-1];
if($ismanager) {
$ConnectionType = "both";
}
} else {
$ConnectionType = "manager";
- $clientname = $managers{$clientip};
+ $clientname = $managers{$outsideip};
}
my $clientok;
+
if ($clientrec || $ismanager) {
&status("Waiting for init from $clientip $clientname");
&logthis('<font color="yellow">INFO: Connection, '.
$clientip.
- " ($clientname) connection type = $ConnectionType </font>" );
+ " ($clientname) connection type = $ConnectionType </font>" );
&status("Connecting $clientip ($clientname))");
my $remotereq=<$client>;
- $remotereq=~s/[^\w:]//g;
+ chomp($remotereq);
+ Debug("Got init: $remotereq");
+
if ($remotereq =~ /^init/) {
&sethost("sethost:$perlvar{'lonHostID'}");
- my $challenge="$$".time;
- print $client "$challenge\n";
- &status("Waiting for challenge reply from $clientip ($clientname)");
- $remotereq=<$client>;
- $remotereq=~s/\W//g;
- if ($challenge eq $remotereq) {
- $clientok=1;
- print $client "ok\n";
+ #
+ # If the remote is attempting a local init... give that a try:
+ #
+ (my $i, my $inittype, $clientversion) = split(/:/, $remotereq);
+
+ # If the connection type is ssl, but I didn't get my
+ # certificate files yet, then I'll drop back to
+ # insecure (if allowed).
+
+ if($inittype eq "ssl") {
+ my ($ca, $cert) = lonssl::CertificateFile;
+ my $kfile = lonssl::KeyFile;
+ if((!$ca) ||
+ (!$cert) ||
+ (!$kfile)) {
+ $inittype = ""; # This forces insecure attempt.
+ &logthis("<font color=\"blue\"> Certificates not "
+ ."installed -- trying insecure auth</font>");
+ } else { # SSL certificates are in place so
+ } # Leave the inittype alone.
+ }
+
+ if($inittype eq "local") {
+ $clientversion = $perlvar{'lonVersion'};
+ my $key = LocalConnection($client, $remotereq);
+ if($key) {
+ Debug("Got local key $key");
+ $clientok = 1;
+ my $cipherkey = pack("H32", $key);
+ $cipher = new IDEA($cipherkey);
+ print $client "ok:local\n";
+ &logthis('<font color="green">'
+ . "Successful local authentication </font>");
+ $keymode = "local"
+ } else {
+ Debug("Failed to get local key");
+ $clientok = 0;
+ shutdown($client, 3);
+ close $client;
+ }
+ } elsif ($inittype eq "ssl") {
+ my $key = SSLConnection($client);
+ if ($key) {
+ $clientok = 1;
+ my $cipherkey = pack("H32", $key);
+ $cipher = new IDEA($cipherkey);
+ &logthis('<font color="green">'
+ ."Successfull ssl authentication with $clientname </font>");
+ $keymode = "ssl";
+
+ } else {
+ $clientok = 0;
+ close $client;
+ }
+
} else {
- &logthis("<font color=blue>WARNING: $clientip did not reply challenge</font>");
- &status('No challenge reply '.$clientip);
+ my $ok = InsecureConnection($client);
+ if($ok) {
+ $clientok = 1;
+ &logthis('<font color="green">'
+ ."Successful insecure authentication with $clientname </font>");
+ print $client "ok\n";
+ $keymode = "insecure";
+ } else {
+ &logthis('<font color="yellow">'
+ ."Attempted insecure connection disallowed </font>");
+ close $client;
+ $clientok = 0;
+
+ }
}
} else {
- &logthis("<font color=blue>WARNING: "
+ &logthis(
+ "<font color='blue'>WARNING: "
."$clientip failed to initialize: >$remotereq< </font>");
&status('No init '.$clientip);
}
+
} else {
- &logthis("<font color=blue>WARNING: Unknown client $clientip</font>");
+ &logthis(
+ "<font color='blue'>WARNING: Unknown client $clientip</font>");
&status('Hung up on '.$clientip);
}
+
if ($clientok) {
# ---------------- New known client connecting, could mean machine online again
-
- foreach my $id (keys(%hostip)) {
- if ($hostip{$id} ne $clientip ||
- $hostip{$currenthostid} eq $clientip) {
- # no need to try to do recon's to myself
- next;
- }
- &reconlonc("$perlvar{'lonSockDir'}/$id");
+ if (&Apache::lonnet::get_host_ip($currenthostid) ne $clientip
+ && $clientip ne '127.0.0.1') {
+ &Apache::lonnet::reconlonc($clientname);
}
- &logthis("<font color=green>Established connection: $clientname</font>");
+ &logthis("<font color='green'>Established connection: $clientname</font>");
&status('Will listen to '.$clientname);
-
- ResetStatistics();
-
# ------------------------------------------------------------ Process requests
- my $KeepGoing = 1;
- while ((my $userinput=GetRequest) && $KeepGoing) {
- $KeepGoing = ProcessRequest($userinput);
-# -------------------------------------------------------------------- complete
-
- &status('Listening to '.$clientname);
+ my $keep_going = 1;
+ my $user_input;
+ my $clienthost = &Apache::lonnet::hostname($clientname);
+ my $clientserverhomeID = &Apache::lonnet::get_server_homeID($clienthost);
+ $clienthomedom = &Apache::lonnet::host_domain($clientserverhomeID);
+ while(($user_input = get_request) && $keep_going) {
+ alarm(120);
+ Debug("Main: Got $user_input\n");
+ $keep_going = &process_request($user_input);
+ alarm(0);
+ &status('Listening to '.$clientname." ($keymode)");
}
+
# --------------------------------------------- client unknown or fishy, refuse
- } else {
+ } else {
print $client "refused\n";
$client->close();
- &logthis("<font color=blue>WARNING: "
+ &logthis("<font color='blue'>WARNING: "
."Rejected client $clientip, closing connection</font>");
}
- }
+ }
# =============================================================================
- &logthis("<font color=red>CRITICAL: "
+ &logthis("<font color='red'>CRITICAL: "
."Disconnect from $clientip ($clientname)</font>");
@@ -4123,8 +6567,38 @@ sub make_new_child {
exit;
}
+#
+# Determine if a user is an author for the indicated domain.
+#
+# Parameters:
+# domain - domain to check in .
+# user - Name of user to check.
+#
+# Return:
+# 1 - User is an author for domain.
+# 0 - User is not an author for domain.
+sub is_author {
+ my ($domain, $user) = @_;
+
+ &Debug("is_author: $user @ $domain");
+
+ my $hashref = &tie_user_hash($domain, $user, "roles",
+ &GDBM_READER());
+ # Author role should show up as a key /domain/_au
+ my $key = "/$domain/_au";
+ my $value;
+ if (defined($hashref)) {
+ $value = $hashref->{$key};
+ }
+
+ if(defined($value)) {
+ &Debug("$user @ $domain is an author");
+ }
+
+ return defined($value);
+}
#
# Checks to see if the input roleput request was to set
# an author role. If so, invokes the lchtmldir script to set
@@ -4136,22 +6610,22 @@ sub make_new_child {
# user - Name of the user for which the role is being put.
# authtype - The authentication type associated with the user.
#
-sub ManagePermissions {
- my $request = shift;
- my $domain = shift;
- my $user = shift;
- my $authtype= shift;
+sub manage_permissions {
+ my ($request, $domain, $user, $authtype) = @_;
+
+ &Debug("manage_permissions: $request $domain $user $authtype");
# See if the request is of the form /$domain/_au
- &logthis("ruequest is $request");
- if($request =~ /^(\/$domain\/_au)$/) { # It's an author rolesput...
+ if($request =~ /^(\/\Q$domain\E\/_au)$/) { # It's an author rolesput...
my $execdir = $perlvar{'lonDaemons'};
my $userhome= "/home/$user" ;
&logthis("system $execdir/lchtmldir $userhome $user $authtype");
+ &Debug("Setting homedir permissions for $userhome");
system("$execdir/lchtmldir $userhome $user $authtype");
}
}
+
#
# Return the full path of a user password file, whether it exists or not.
# Parameters:
@@ -4160,14 +6634,9 @@ sub ManagePermissions {
# Returns:
# Full passwd path:
#
-sub PasswordPath {
- my $domain = shift;
- my $user = shift;
-
- my $path = &propath($domain, $user);
- $path .= "/passwd";
-
- return $path;
+sub password_path {
+ my ($domain, $user) = @_;
+ return &propath($domain, $user).'/passwd';
}
# Password Filename
@@ -4180,13 +6649,12 @@ sub PasswordPath {
# - If the password file exists returns its path.
# - If the password file does not exist, returns undefined.
#
-sub PasswordFilename {
- my $domain = shift;
- my $user = shift;
+sub password_filename {
+ my ($domain, $user) = @_;
Debug ("PasswordFilename called: dom = $domain user = $user");
- my $path = PasswordPath($domain, $user);
+ my $path = &password_path($domain, $user);
Debug("PasswordFilename got path: $path");
if(-e $path) {
return $path;
@@ -4205,12 +6673,10 @@ sub PasswordFilename {
# 0 - Failed.
# 1 - Success.
#
-sub RewritePwFile {
- my $domain = shift;
- my $user = shift;
- my $contents = shift;
+sub rewrite_password_file {
+ my ($domain, $user, $contents) = @_;
- my $file = PasswordFilename($domain, $user);
+ my $file = &password_filename($domain, $user);
if (defined $file) {
my $pf = IO::File->new(">$file");
if($pf) {
@@ -4224,35 +6690,220 @@ sub RewritePwFile {
}
}
+
#
-# GetAuthType - Determines the authorization type of a user in a domain.
+# get_auth_type - Determines the authorization type of a user in a domain.
# Returns the authorization type or nouser if there is no such user.
#
-sub GetAuthType {
- my $domain = shift;
- my $user = shift;
-
- Debug("GetAuthType( $domain, $user ) \n");
- my $passwdfile = PasswordFilename($domain, $user);
- if( defined $passwdfile ) {
+sub get_auth_type {
+ my ($domain, $user) = @_;
+
+ Debug("get_auth_type( $domain, $user ) \n");
+ my $proname = &propath($domain, $user);
+ my $passwdfile = "$proname/passwd";
+ if( -e $passwdfile ) {
my $pf = IO::File->new($passwdfile);
my $realpassword = <$pf>;
chomp($realpassword);
Debug("Password info = $realpassword\n");
- return $realpassword;
+ my ($authtype, $contentpwd) = split(/:/, $realpassword);
+ Debug("Authtype = $authtype, content = $contentpwd\n");
+ return "$authtype:$contentpwd";
} else {
Debug("Returning nouser");
return "nouser";
}
}
+#
+# Validate a user given their domain, name and password. This utility
+# function is used by both AuthenticateHandler and ChangePasswordHandler
+# to validate the login credentials of a user.
+# Parameters:
+# $domain - The domain being logged into (this is required due to
+# the capability for multihomed systems.
+# $user - The name of the user being validated.
+# $password - The user's propoposed password.
+#
+# Returns:
+# 1 - The domain,user,pasword triplet corresponds to a valid
+# user.
+# 0 - The domain,user,password triplet is not a valid user.
+#
+sub validate_user {
+ my ($domain, $user, $password, $checkdefauth) = @_;
+
+ # Why negative ~pi you may well ask? Well this function is about
+ # authentication, and therefore very important to get right.
+ # I've initialized the flag that determines whether or not I've
+ # validated correctly to a value it's not supposed to get.
+ # At the end of this function. I'll ensure that it's not still that
+ # value so we don't just wind up returning some accidental value
+ # as a result of executing an unforseen code path that
+ # did not set $validated. At the end of valid execution paths,
+ # validated shoule be 1 for success or 0 for failuer.
+
+ my $validated = -3.14159;
+
+ # How we authenticate is determined by the type of authentication
+ # the user has been assigned. If the authentication type is
+ # "nouser", the user does not exist so we will return 0.
+
+ my $contents = &get_auth_type($domain, $user);
+ my ($howpwd, $contentpwd) = split(/:/, $contents);
+
+ my $null = pack("C",0); # Used by kerberos auth types.
+
+ if ($howpwd eq 'nouser') {
+ if ($checkdefauth) {
+ my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
+ if ($domdefaults{'auth_def'} eq 'localauth') {
+ $howpwd = $domdefaults{'auth_def'};
+ $contentpwd = $domdefaults{'auth_arg_def'};
+ } elsif ((($domdefaults{'auth_def'} eq 'krb4') ||
+ ($domdefaults{'auth_def'} eq 'krb5')) &&
+ ($domdefaults{'auth_arg_def'} ne '')) {
+ $howpwd = $domdefaults{'auth_def'};
+ $contentpwd = $domdefaults{'auth_arg_def'};
+ }
+ }
+ }
+ if ($howpwd ne 'nouser') {
+ if($howpwd eq "internal") { # Encrypted is in local password file.
+ $validated = (crypt($password, $contentpwd) eq $contentpwd);
+ }
+ elsif ($howpwd eq "unix") { # User is a normal unix user.
+ $contentpwd = (getpwnam($user))[1];
+ if($contentpwd) {
+ if($contentpwd eq 'x') { # Shadow password file...
+ my $pwauth_path = "/usr/local/sbin/pwauth";
+ open PWAUTH, "|$pwauth_path" or
+ die "Cannot invoke authentication";
+ print PWAUTH "$user\n$password\n";
+ close PWAUTH;
+ $validated = ! $?;
+
+ } else { # Passwords in /etc/passwd.
+ $validated = (crypt($password,
+ $contentpwd) eq $contentpwd);
+ }
+ } else {
+ $validated = 0;
+ }
+ } elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
+ my $checkwithkrb5 = 0;
+ if ($dist =~/^fedora(\d+)$/) {
+ if ($1 > 11) {
+ $checkwithkrb5 = 1;
+ }
+ } elsif ($dist =~ /^suse([\d.]+)$/) {
+ if ($1 > 11.1) {
+ $checkwithkrb5 = 1;
+ }
+ }
+ if ($checkwithkrb5) {
+ $validated = &krb5_authen($password,$null,$user,$contentpwd);
+ } else {
+ $validated = &krb4_authen($password,$null,$user,$contentpwd);
+ }
+ } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
+ $validated = &krb5_authen($password,$null,$user,$contentpwd);
+ } elsif ($howpwd eq "localauth") {
+ # Authenticate via installation specific authentcation method:
+ $validated = &localauth::localauth($user,
+ $password,
+ $contentpwd,
+ $domain);
+ if ($validated < 0) {
+ &logthis("localauth for $contentpwd $user:$domain returned a $validated");
+ $validated = 0;
+ }
+ } else { # Unrecognized auth is also bad.
+ $validated = 0;
+ }
+ } else {
+ $validated = 0;
+ }
+ #
+ # $validated has the correct stat of the authentication:
+ #
+
+ unless ($validated != -3.14159) {
+ # I >really really< want to know if this happens.
+ # since it indicates that user authentication is badly
+ # broken in some code path.
+ #
+ die "ValidateUser - failed to set the value of validated $domain, $user $password";
+ }
+ return $validated;
+}
+
+sub krb4_authen {
+ my ($password,$null,$user,$contentpwd) = @_;
+ my $validated = 0;
+ if (!($password =~ /$null/) ) { # Null password not allowed.
+ eval {
+ require Authen::Krb4;
+ };
+ if (!$@) {
+ my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
+ "",
+ $contentpwd,,
+ 'krbtgt',
+ $contentpwd,
+ 1,
+ $password);
+ if(!$k4error) {
+ $validated = 1;
+ } else {
+ $validated = 0;
+ &logthis('krb4: '.$user.', '.$contentpwd.', '.
+ &Authen::Krb4::get_err_txt($Authen::Krb4::error));
+ }
+ } else {
+ $validated = krb5_authen($password,$null,$user,$contentpwd);
+ }
+ }
+ return $validated;
+}
+
+sub krb5_authen {
+ my ($password,$null,$user,$contentpwd) = @_;
+ my $validated = 0;
+ if(!($password =~ /$null/)) { # Null password not allowed.
+ my $krbclient = &Authen::Krb5::parse_name($user.'@'
+ .$contentpwd);
+ my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
+ my $krbserver = &Authen::Krb5::parse_name($krbservice);
+ my $credentials= &Authen::Krb5::cc_default();
+ $credentials->initialize(&Authen::Krb5::parse_name($user.'@'
+ .$contentpwd));
+ my $krbreturn;
+ if (exists(&Authen::Krb5::get_init_creds_password)) {
+ $krbreturn =
+ &Authen::Krb5::get_init_creds_password($krbclient,$password,
+ $krbservice);
+ $validated = (ref($krbreturn) eq 'Authen::Krb5::Creds');
+ } else {
+ $krbreturn =
+ &Authen::Krb5::get_in_tkt_with_password($krbclient,$krbserver,
+ $password,$credentials);
+ $validated = ($krbreturn == 1);
+ }
+ if (!$validated) {
+ &logthis('krb5: '.$user.', '.$contentpwd.', '.
+ &Authen::Krb5::error());
+ }
+ }
+ return $validated;
+}
+
sub addline {
my ($fname,$hostid,$ip,$newline)=@_;
my $contents;
my $found=0;
- my $expr='^'.$hostid.':'.$ip.':';
- $expr =~ s/\./\\\./g;
+ my $expr='^'.quotemeta($hostid).':'.quotemeta($ip).':';
my $sh;
if ($sh=IO::File->new("$fname.subscription")) {
while (my $subline=<$sh>) {
@@ -4267,40 +6918,52 @@ sub addline {
return $found;
}
-sub getchat {
- my ($cdom,$cname,$udom,$uname)=@_;
- my %hash;
- my $proname=&propath($cdom,$cname);
+sub get_chat {
+ my ($cdom,$cname,$udom,$uname,$group)=@_;
+
my @entries=();
- if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
- &GDBM_READER(),0640)) {
- @entries=map { $_.':'.$hash{$_} } sort keys %hash;
- untie %hash;
+ my $namespace = 'nohist_chatroom';
+ my $namespace_inroom = 'nohist_inchatroom';
+ if ($group ne '') {
+ $namespace .= '_'.$group;
+ $namespace_inroom .= '_'.$group;
+ }
+ my $hashref = &tie_user_hash($cdom, $cname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
+ @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
+ &untie_user_hash($hashref);
}
my @participants=();
my $cutoff=time-60;
- if (tie(%hash,'GDBM_File',"$proname/nohist_inchatroom.db",
- &GDBM_WRCREAT(),0640)) {
- $hash{$uname.':'.$udom}=time;
- foreach (sort keys %hash) {
- if ($hash{$_}>$cutoff) {
- $participants[$#participants+1]='active_participant:'.$_;
+ $hashref = &tie_user_hash($cdom, $cname, $namespace_inroom,
+ &GDBM_WRCREAT());
+ if ($hashref) {
+ $hashref->{$uname.':'.$udom}=time;
+ foreach my $user (sort(keys(%$hashref))) {
+ if ($hashref->{$user}>$cutoff) {
+ push(@participants, 'active_participant:'.$user);
}
}
- untie %hash;
+ &untie_user_hash($hashref);
}
return (@participants,@entries);
}
-sub chatadd {
- my ($cdom,$cname,$newchat)=@_;
- my %hash;
- my $proname=&propath($cdom,$cname);
+sub chat_add {
+ my ($cdom,$cname,$newchat,$group)=@_;
my @entries=();
my $time=time;
- if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
- &GDBM_WRCREAT(),0640)) {
- @entries=map { $_.':'.$hash{$_} } sort keys %hash;
+ my $namespace = 'nohist_chatroom';
+ my $logfile = 'chatroom.log';
+ if ($group ne '') {
+ $namespace .= '_'.$group;
+ $logfile = 'chatroom_'.$group.'.log';
+ }
+ my $hashref = &tie_user_hash($cdom, $cname, $namespace,
+ &GDBM_WRCREAT());
+ if ($hashref) {
+ @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
my ($thentime,$idnum)=split(/\_/,$lastid);
my $newid=$time.'_000000';
@@ -4310,38 +6973,58 @@ sub chatadd {
$idnum=substr('000000'.$idnum,-6,6);
$newid=$time.'_'.$idnum;
}
- $hash{$newid}=$newchat;
+ $hashref->{$newid}=$newchat;
my $expired=$time-3600;
- foreach (keys %hash) {
- my ($thistime)=($_=~/(\d+)\_/);
+ foreach my $comment (keys(%$hashref)) {
+ my ($thistime) = ($comment=~/(\d+)\_/);
if ($thistime<$expired) {
- delete $hash{$_};
+ delete $hashref->{$comment};
}
}
- untie %hash;
- }
- {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/chatroom.log")) {
- print $hfh "$time:".&unescape($newchat)."\n";
+ {
+ my $proname=&propath($cdom,$cname);
+ if (open(CHATLOG,">>$proname/$logfile")) {
+ print CHATLOG ("$time:".&unescape($newchat)."\n");
+ }
+ close(CHATLOG);
}
+ &untie_user_hash($hashref);
}
}
sub unsub {
my ($fname,$clientip)=@_;
my $result;
+ my $unsubs = 0; # Number of successful unsubscribes:
+
+
+ # An old way subscriptions were handled was to have a
+ # subscription marker file:
+
+ Debug("Attempting unlink of $fname.$clientname");
if (unlink("$fname.$clientname")) {
- $result="ok\n";
- } else {
- $result="not_subscribed\n";
- }
+ $unsubs++; # Successful unsub via marker file.
+ }
+
+ # The more modern way to do it is to have a subscription list
+ # file:
+
if (-e "$fname.subscription") {
my $found=&addline($fname,$clientname,$clientip,'');
- if ($found) { $result="ok\n"; }
+ if ($found) {
+ $unsubs++;
+ }
+ }
+
+ # If either or both of these mechanisms succeeded in unsubscribing a
+ # resource we can return ok:
+
+ if($unsubs) {
+ $result = "ok\n";
} else {
- if ($result != "ok\n") { $result="not_subscribed\n"; }
+ $result = "not_subscribed\n";
}
+
return $result;
}
@@ -4350,7 +7033,7 @@ sub currentversion {
my $version=-1;
my $ulsdir='';
if ($fname=~/^(.+)\/[^\/]+$/) {
- $ulsdir=$1;
+ $ulsdir=$1;
}
my ($fnamere1,$fnamere2);
# remove version if already specified
@@ -4394,7 +7077,7 @@ sub thisversion {
sub subscribe {
my ($userinput,$clientip)=@_;
my $result;
- my ($cmd,$fname)=split(/:/,$userinput);
+ my ($cmd,$fname)=split(/:/,$userinput,2);
my $ownership=&ishome($fname);
if ($ownership eq 'owner') {
# explitly asking for the current version?
@@ -4407,8 +7090,8 @@ sub subscribe {
symlink($root.'.'.$extension,
$root.'.'.$currentversion.'.'.$extension);
unless ($extension=~/\.meta$/) {
- symlink($root.'.'.$extension.'.meta',
- $root.'.'.$currentversion.'.'.$extension.'.meta');
+ symlink($root.'.'.$extension.'.meta',
+ $root.'.'.$currentversion.'.'.$extension.'.meta');
}
}
}
@@ -4427,7 +7110,7 @@ sub subscribe {
# the metadata
unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
$fname=~s/\/home\/httpd\/html\/res/raw/;
- $fname="http://$thisserver/".$fname;
+ $fname="http://".&Apache::lonnet::hostname($perlvar{'lonHostID'})."/".$fname;
$result="$fname\n";
}
} else {
@@ -4438,14 +7121,47 @@ sub subscribe {
}
return $result;
}
+# Change the passwd of a unix user. The caller must have
+# first verified that the user is a loncapa user.
+#
+# Parameters:
+# user - Unix user name to change.
+# pass - New password for the user.
+# Returns:
+# ok - if success
+# other - Some meaningfule error message string.
+# NOTE:
+# invokes a setuid script to change the passwd.
+sub change_unix_password {
+ my ($user, $pass) = @_;
+
+ &Debug("change_unix_password");
+ my $execdir=$perlvar{'lonDaemons'};
+ &Debug("Opening lcpasswd pipeline");
+ my $pf = IO::File->new("|$execdir/lcpasswd > "
+ ."$perlvar{'lonDaemons'}"
+ ."/logs/lcpasswd.log");
+ print $pf "$user\n$pass\n$pass\n";
+ close $pf;
+ my $err = $?;
+ return ($err < @passwderrors) ? $passwderrors[$err] :
+ "pwchange_falure - unknown error";
+
+
+}
+
sub make_passwd_file {
my ($uname, $umode,$npass,$passfilename)=@_;
- my $result="ok\n";
+ my $result="ok";
if ($umode eq 'krb4' or $umode eq 'krb5') {
{
my $pf = IO::File->new(">$passfilename");
- print $pf "$umode:$npass\n";
+ if ($pf) {
+ print $pf "$umode:$npass\n";
+ } else {
+ $result = "pass_file_failed_error";
+ }
}
} elsif ($umode eq 'internal') {
my $salt=time;
@@ -4454,16 +7170,36 @@ sub make_passwd_file {
{
&Debug("Creating internal auth");
my $pf = IO::File->new(">$passfilename");
- print $pf "internal:$ncpass\n";
+ if($pf) {
+ print $pf "internal:$ncpass\n";
+ } else {
+ $result = "pass_file_failed_error";
+ }
}
} elsif ($umode eq 'localauth') {
{
my $pf = IO::File->new(">$passfilename");
- print $pf "localauth:$npass\n";
+ if($pf) {
+ print $pf "localauth:$npass\n";
+ } else {
+ $result = "pass_file_failed_error";
+ }
}
} elsif ($umode eq 'unix') {
{
- my $execpath="$perlvar{'lonDaemons'}/"."lcuseradd";
+ #
+ # Don't allow the creation of privileged accounts!!! that would
+ # be real bad!!!
+ #
+ my $uid = getpwnam($uname);
+ if((defined $uid) && ($uid == 0)) {
+ &logthis(">>>Attempted to create privilged account blocked");
+ return "no_priv_account_error\n";
+ }
+
+ my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
+
+ my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
{
&Debug("Executing external: ".$execpath);
&Debug("user = ".$uname.", Password =". $npass);
@@ -4471,33 +7207,68 @@ sub make_passwd_file {
print $se "$uname\n";
print $se "$npass\n";
print $se "$npass\n";
+ print $se "$lc_error_file\n"; # Status -> unique file.
}
- my $useraddok = $?;
- if($useraddok > 0) {
- &logthis("Failed lcuseradd: ".&lcuseraddstrerror($useraddok));
+ if (-r $lc_error_file) {
+ &Debug("Opening error file: $lc_error_file");
+ my $error = IO::File->new("< $lc_error_file");
+ my $useraddok = <$error>;
+ $error->close;
+ unlink($lc_error_file);
+
+ chomp $useraddok;
+
+ if($useraddok > 0) {
+ my $error_text = &lcuseraddstrerror($useraddok);
+ &logthis("Failed lcuseradd: $error_text");
+ $result = "lcuseradd_failed:$error_text";
+ } else {
+ my $pf = IO::File->new(">$passfilename");
+ if($pf) {
+ print $pf "unix:\n";
+ } else {
+ $result = "pass_file_failed_error";
+ }
+ }
+ } else {
+ &Debug("Could not locate lcuseradd error: $lc_error_file");
+ $result="bug_lcuseradd_no_output_file";
}
- my $pf = IO::File->new(">$passfilename");
- print $pf "unix:\n";
}
} elsif ($umode eq 'none') {
{
- my $pf = IO::File->new(">$passfilename");
- print $pf "none:\n";
+ my $pf = IO::File->new("> $passfilename");
+ if($pf) {
+ print $pf "none:\n";
+ } else {
+ $result = "pass_file_failed_error";
+ }
}
} else {
- $result="auth_mode_error\n";
+ $result="auth_mode_error";
}
return $result;
}
+sub convert_photo {
+ my ($start,$dest)=@_;
+ system("convert $start $dest");
+}
+
sub sethost {
my ($remotereq) = @_;
my (undef,$hostid)=split(/:/,$remotereq);
+ # ignore sethost if we are already correct
+ if ($hostid eq $currenthostid) {
+ return 'ok';
+ }
+
if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
- if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {
- $currenthostid=$hostid;
- $currentdomainid=$hostdom{$hostid};
- &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
+ if (&Apache::lonnet::get_host_ip($perlvar{'lonHostID'})
+ eq &Apache::lonnet::get_host_ip($hostid)) {
+ $currenthostid =$hostid;
+ $currentdomainid=&Apache::lonnet::host_domain($hostid);
+# &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
} else {
&logthis("Requested host id $hostid not an alias of ".
$perlvar{'lonHostID'}." refusing connection");
@@ -4511,30 +7282,35 @@ sub version {
$remoteVERSION=(split(/:/,$userinput))[1];
return "version:$VERSION";
}
-############## >>>>>>>>>>>>>>>>>>>>>>>>>> FUTUREWORK <<<<<<<<<<<<<<<<<<<<<<<<<<<<
-#There is a copy of this in lonnet.pm
-# Can we hoist these lil' things out into common places?
-#
-sub userload {
- my $numusers=0;
- {
- opendir(LONIDS,$perlvar{'lonIDsDir'});
- my $filename;
- my $curtime=time;
- while ($filename=readdir(LONIDS)) {
- if ($filename eq '.' || $filename eq '..') {next;}
- my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
- if ($curtime-$mtime < 1800) { $numusers++; }
- }
- closedir(LONIDS);
- }
- my $userloadpercent=0;
- my $maxuserload=$perlvar{'lonUserLoadLim'};
- if ($maxuserload) {
- $userloadpercent=100*$numusers/$maxuserload;
+
+sub get_usersession_config {
+ my ($dom,$name) = @_;
+ my ($usersessionconf,$cached)=&Apache::lonnet::is_cached_new($name,$dom);
+ if (defined($cached)) {
+ return $usersessionconf;
+ } else {
+ my %domconfig = &Apache::lonnet::get_dom('configuration',['usersessions'],$dom);
+ if (ref($domconfig{'usersessions'}) eq 'HASH') {
+ &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'usersessions'},3600);
+ return $domconfig{'usersessions'};
+ }
+ }
+ return;
+}
+
+sub get_courseinfo_hash {
+ my ($cnum,$cdom,$home) = @_;
+ my $hashid = $cdom.':'.$cnum;
+ my ($courseinfo,$cached)=&Apache::lonnet::is_cached_new('courseinfo',$hashid);
+ if (defined($cached)) {
+ return $courseinfo;
+ } else {
+ my %info = &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,1,[$home],'.');
+ if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
+ return &Apache::lonnet::do_cache_new('courseinfo',$hashid,$info{$cdom.'_'.$cnum},600);
+ }
}
- $userloadpercent=sprintf("%.2f",$userloadpercent);
- return $userloadpercent;
+ return;
}
# ----------------------------------- POD (plain old documentation, CPAN style)
@@ -4744,7 +7520,7 @@ Place in B<logs/lond.log>
stores hash in namespace
-=item rolesput
+=item rolesputy
put a role into a user's environment
@@ -4852,7 +7628,6 @@ to the client, and the connection is clo
IO::Socket
IO::File
Apache::File
-Symbol
POSIX
Crypt::IDEA
LWP::UserAgent()
@@ -4871,3 +7646,408 @@ linux
Server/Process
=cut
+
+
+=pod
+
+=head1 LOG MESSAGES
+
+The messages below can be emitted in the lond log. This log is located
+in ~httpd/perl/logs/lond.log Many log messages have HTML encapsulation
+to provide coloring if examined from inside a web page. Some do not.
+Where color is used, the colors are; Red for sometihhng to get excited
+about and to follow up on. Yellow for something to keep an eye on to
+be sure it does not get worse, Green,and Blue for informational items.
+
+In the discussions below, sometimes reference is made to ~httpd
+when describing file locations. There isn't really an httpd
+user, however there is an httpd directory that gets installed in the
+place that user home directories go. On linux, this is usually
+(always?) /home/httpd.
+
+
+Some messages are colorless. These are usually (not always)
+Green/Blue color level messages.
+
+=over 2
+
+=item (Red) LocalConnection rejecting non local: <ip> ne 127.0.0.1
+
+A local connection negotiation was attempted by
+a host whose IP address was not 127.0.0.1.
+The socket is closed and the child will exit.
+lond has three ways to establish an encyrption
+key with a client:
+
+=over 2
+
+=item local
+
+The key is written and read from a file.
+This is only valid for connections from localhost.
+
+=item insecure
+
+The key is generated by the server and
+transmitted to the client.
+
+=item ssl (secure)
+
+An ssl connection is negotiated with the client,
+the key is generated by the server and sent to the
+client across this ssl connection before the
+ssl connectionis terminated and clear text
+transmission resumes.
+
+=back
+
+=item (Red) LocalConnection: caller is insane! init = <init> and type = <type>
+
+The client is local but has not sent an initialization
+string that is the literal "init:local" The connection
+is closed and the child exits.
+
+=item Red CRITICAL Can't get key file <error>
+
+SSL key negotiation is being attempted but the call to
+lonssl::KeyFile failed. This usually means that the
+configuration file is not correctly defining or protecting
+the directories/files lonCertificateDirectory or
+lonnetPrivateKey
+<error> is a string that describes the reason that
+the key file could not be located.
+
+=item (Red) CRITICAL Can't get certificates <error>
+
+SSL key negotiation failed because we were not able to retrives our certificate
+or the CA's certificate in the call to lonssl::CertificateFile
+<error> is the textual reason this failed. Usual reasons:
+
+=over 2
+
+=item Apache config file for loncapa incorrect:
+
+one of the variables
+lonCertificateDirectory, lonnetCertificateAuthority, or lonnetCertificate
+undefined or incorrect
+
+=item Permission error:
+
+The directory pointed to by lonCertificateDirectory is not readable by lond
+
+=item Permission error:
+
+Files in the directory pointed to by lonCertificateDirectory are not readable by lond.
+
+=item Installation error:
+
+Either the certificate authority file or the certificate have not
+been installed in lonCertificateDirectory.
+
+=item (Red) CRITICAL SSL Socket promotion failed: <err>
+
+The promotion of the connection from plaintext to SSL failed
+<err> is the reason for the failure. There are two
+system calls involved in the promotion (one of which failed),
+a dup to produce
+a second fd on the raw socket over which the encrypted data
+will flow and IO::SOcket::SSL->new_from_fd which creates
+the SSL connection on the duped fd.
+
+=item (Blue) WARNING client did not respond to challenge
+
+This occurs on an insecure (non SSL) connection negotiation request.
+lond generates some number from the time, the PID and sends it to
+the client. The client must respond by echoing this information back.
+If the client does not do so, that's a violation of the challenge
+protocols and the connection will be failed.
+
+=item (Red) No manager table. Nobody can manage!!
+
+lond has the concept of privileged hosts that
+can perform remote management function such
+as update the hosts.tab. The manager hosts
+are described in the
+~httpd/lonTabs/managers.tab file.
+this message is logged if this file is missing.
+
+
+=item (Green) Registering manager <dnsname> as <cluster_name> with <ipaddress>
+
+Reports the successful parse and registration
+of a specific manager.
+
+=item Green existing host <clustername:dnsname>
+
+The manager host is already defined in the hosts.tab
+the information in that table, rather than the info in the
+manager table will be used to determine the manager's ip.
+
+=item (Red) Unable to craete <filename>
+
+lond has been asked to create new versions of an administrative
+file (by a manager). When this is done, the new file is created
+in a temp file and then renamed into place so that there are always
+usable administrative files, even if the update fails. This failure
+message means that the temp file could not be created.
+The update is abandoned, and the old file is available for use.
+
+=item (Green) CopyFile from <oldname> to <newname> failed
+
+In an update of administrative files, the copy of the existing file to a
+backup file failed. The installation of the new file may still succeed,
+but there will not be a back up file to rever to (this should probably
+be yellow).
+
+=item (Green) Pushfile: backed up <oldname> to <newname>
+
+See above, the backup of the old administrative file succeeded.
+
+=item (Red) Pushfile: Unable to install <filename> <reason>
+
+The new administrative file could not be installed. In this case,
+the old administrative file is still in use.
+
+=item (Green) Installed new < filename>.
+
+The new administrative file was successfullly installed.
+
+=item (Red) Reinitializing lond pid=<pid>
+
+The lonc child process <pid> will be sent a USR2
+signal.
+
+=item (Red) Reinitializing self
+
+We've been asked to re-read our administrative files,and
+are doing so.
+
+=item (Yellow) error:Invalid process identifier <ident>
+
+A reinit command was received, but the target part of the
+command was not valid. It must be either
+'lond' or 'lonc' but was <ident>
+
+=item (Green) isValideditCommand checking: Command = <command> Key = <key> newline = <newline>
+
+Checking to see if lond has been handed a valid edit
+command. It is possible the edit command is not valid
+in that case there are no log messages to indicate that.
+
+=item Result of password change for <username> pwchange_success
+
+The password for <username> was
+successfully changed.
+
+=item Unable to open <user> passwd to change password
+
+Could not rewrite the
+internal password file for a user
+
+=item Result of password change for <user> : <result>
+
+A unix password change for <user> was attempted
+and the pipe returned <result>
+
+=item LWP GET: <message> for <fname> (<remoteurl>)
+
+The lightweight process fetch for a resource failed
+with <message> the local filename that should
+have existed/been created was <fname> the
+corresponding URI: <remoteurl> This is emitted in several
+places.
+
+=item Unable to move <transname> to <destname>
+
+From fetch_user_file_handler - the user file was replicated but could not
+be mv'd to its final location.
+
+=item Looking for <domain> <username>
+
+From user_has_session_handler - This should be a Debug call instead
+it indicates lond is about to check whether the specified user has a
+session active on the specified domain on the local host.
+
+=item Client <ip> (<name>) hanging up: <input>
+
+lond has been asked to exit by its client. The <ip> and <name> identify the
+client systemand <input> is the full exit command sent to the server.
+
+=item Red CRITICAL: ABNORMAL EXIT. child <pid> for server <hostname> died through a crass with this error->[<message>].
+
+A lond child terminated. NOte that this termination can also occur when the
+child receives the QUIT or DIE signals. <pid> is the process id of the child,
+<hostname> the host lond is working for, and <message> the reason the child died
+to the best of our ability to get it (I would guess that any numeric value
+represents and errno value). This is immediately followed by
+
+=item Famous last words: Catching exception - <log>
+
+Where log is some recent information about the state of the child.
+
+=item Red CRITICAL: TIME OUT <pid>
+
+Some timeout occured for server <pid>. THis is normally a timeout on an LWP
+doing an HTTP::GET.
+
+=item child <pid> died
+
+The reaper caught a SIGCHILD for the lond child process <pid>
+This should be modified to also display the IP of the dying child
+$children{$pid}
+
+=item Unknown child 0 died
+A child died but the wait for it returned a pid of zero which really should not
+ever happen.
+
+=item Child <which> - <pid> looks like we missed it's death
+
+When a sigchild is received, the reaper process checks all children to see if they are
+alive. If children are dying quite quickly, the lack of signal queuing can mean
+that a signal hearalds the death of more than one child. If so this message indicates
+which other one died. <which> is the ip of a dead child
+
+=item Free socket: <shutdownretval>
+
+The HUNTSMAN sub was called due to a SIGINT in a child process. The socket is being shutdown.
+for whatever reason, <shutdownretval> is printed but in fact shutdown() is not documented
+to return anything. This is followed by:
+
+=item Red CRITICAL: Shutting down
+
+Just prior to exit.
+
+=item Free socket: <shutdownretval>
+
+The HUPSMAN sub was called due to a SIGHUP. all children get killsed, and lond execs itself.
+This is followed by:
+
+=item (Red) CRITICAL: Restarting
+
+lond is about to exec itself to restart.
+
+=item (Blue) Updating connections
+
+(In response to a USR2). All the children (except the one for localhost)
+are about to be killed, the hosts tab reread, and Apache reloaded via apachereload.
+
+=item (Blue) UpdateHosts killing child <pid> for ip <ip>
+
+Due to USR2 as above.
+
+=item (Green) keeping child for ip <ip> (pid = <pid>)
+
+In response to USR2 as above, the child indicated is not being restarted because
+it's assumed that we'll always need a child for the localhost.
+
+
+=item Going to check on the children
+
+Parent is about to check on the health of the child processes.
+Note that this is in response to a USR1 sent to the parent lond.
+there may be one or more of the next two messages:
+
+=item <pid> is dead
+
+A child that we have in our child hash as alive has evidently died.
+
+=item Child <pid> did not respond
+
+In the health check the child <pid> did not update/produce a pid_.txt
+file when sent it's USR1 signal. That process is killed with a 9 signal, as it's
+assumed to be hung in some un-fixable way.
+
+=item Finished checking children
+
+Master processs's USR1 processing is cojmplete.
+
+=item (Red) CRITICAL: ------- Starting ------
+
+(There are more '-'s on either side). Lond has forked itself off to
+form a new session and is about to start actual initialization.
+
+=item (Green) Attempting to start child (<client>)
+
+Started a new child process for <client>. Client is IO::Socket object
+connected to the child. This was as a result of a TCP/IP connection from a client.
+
+=item Unable to determine who caller was, getpeername returned nothing
+
+In child process initialization. either getpeername returned undef or
+a zero sized object was returned. Processing continues, but in my opinion,
+this should be cause for the child to exit.
+
+=item Unable to determine clientip
+
+In child process initialization. The peer address from getpeername was not defined.
+The client address is stored as "Unavailable" and processing continues.
+
+=item (Yellow) INFO: Connection <ip> <name> connection type = <type>
+
+In child initialization. A good connectionw as received from <ip>.
+
+=over 2
+
+=item <name>
+
+is the name of the client from hosts.tab.
+
+=item <type>
+
+Is the connection type which is either
+
+=over 2
+
+=item manager
+
+The connection is from a manager node, not in hosts.tab
+
+=item client
+
+the connection is from a non-manager in the hosts.tab
+
+=item both
+
+The connection is from a manager in the hosts.tab.
+
+=back
+
+=back
+
+=item (Blue) Certificates not installed -- trying insecure auth
+
+One of the certificate file, key file or
+certificate authority file could not be found for a client attempting
+SSL connection intiation. COnnection will be attemptied in in-secure mode.
+(this would be a system with an up to date lond that has not gotten a
+certificate from us).
+
+=item (Green) Successful local authentication
+
+A local connection successfully negotiated the encryption key.
+In this case the IDEA key is in a file (that is hopefully well protected).
+
+=item (Green) Successful ssl authentication with <client>
+
+The client (<client> is the peer's name in hosts.tab), has successfully
+negotiated an SSL connection with this child process.
+
+=item (Green) Successful insecure authentication with <client>
+
+
+The client has successfully negotiated an insecure connection withthe child process.
+
+=item (Yellow) Attempted insecure connection disallowed
+
+The client attempted and failed to successfully negotiate a successful insecure
+connection. This can happen either because the variable londAllowInsecure is false
+or undefined, or becuse the child did not successfully echo back the challenge
+string.
+
+
+=back
+
+=back
+
+
+=cut