/// <summary> /// Attempts to authenticate or reauthenticate to network shares. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> protected virtual void AuthenticateRequestHandler(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Attempts to (re)authenticate to network shares."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Authenticate [Options]"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); DisplayResponseMessage(requestInfo, helpMessage.ToString()); } else { DisplayStatusMessage("Attempting to reauthenticate network shares for health and status exports...", UpdateType.Information); try { m_healthExporter.Initialize(); m_statusExporter.Initialize(); SendResponse(requestInfo, true); } catch (Exception ex) { SendResponse(requestInfo, false, "Failed to reauthenticate network shares: {0}", ex.Message); m_serviceHelper.ErrorLogger.Log(ex); } } }
private void ShowVersion(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Shows the current service version."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Version -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -actionable".PadRight(20)); helpMessage.Append("Returns results via an actionable event"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { StringBuilder versionInfo = new StringBuilder(); AssemblyInfo serviceAssembly = AssemblyInfo.EntryAssembly; string serviceName; if (m_parentService != null && !string.IsNullOrWhiteSpace(m_parentService.ServiceName)) serviceName = m_parentService.ServiceName; else serviceName = AppDomain.CurrentDomain.FriendlyName; versionInfo.AppendFormat("{0} Service Version:\r\n\r\n", serviceName); versionInfo.AppendFormat(" App Domain: {0}, running on .NET {1}\r\n", AppDomain.CurrentDomain.FriendlyName, Environment.Version.ToString()); versionInfo.AppendFormat(" Code Base: {0}\r\n", serviceAssembly.CodeBase); versionInfo.AppendFormat(" Build Date: {0}\r\n", serviceAssembly.BuildDate.ToString()); versionInfo.AppendFormat(" Version: {0}", serviceAssembly.Version.ToString()); string message = versionInfo.ToString(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, message + "\r\n\r\n"); // Also allow consumers to directly consume message via event in response to a version request if (requestInfo.Request.Arguments.Exists("actionable")) SendActionableResponse(requestInfo, true, null, message); } }
private void RemoteTelnetSession(ClientRequestInfo requestinfo) { if (m_remoteCommandProcess == null && requestinfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Allows for a telnet session to the service server."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Telnet -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -connect".PadRight(20)); helpMessage.Append("Establishes a telnet session (requires password)"); helpMessage.AppendLine(); helpMessage.Append(" -disconnect".PadRight(20)); helpMessage.Append("Terminates established telnet session"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestinfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { bool connectSession = requestinfo.Request.Arguments.Exists("connect"); bool disconnectSession = requestinfo.Request.Arguments.Exists("disconnect"); if (m_remoteCommandProcess == null && connectSession && !string.IsNullOrEmpty(requestinfo.Request.Arguments["connect"])) { // User wants to establish a remote command session. string password = requestinfo.Request.Arguments["connect"]; if (password == m_telnetSessionPassword) { // Establish remote command session m_remoteCommandProcess = new Process(); m_remoteCommandProcess.ErrorDataReceived += RemoteCommandProcess_ErrorDataReceived; m_remoteCommandProcess.OutputDataReceived += RemoteCommandProcess_OutputDataReceived; m_remoteCommandProcess.StartInfo.FileName = "cmd.exe"; m_remoteCommandProcess.StartInfo.UseShellExecute = false; m_remoteCommandProcess.StartInfo.RedirectStandardInput = true; m_remoteCommandProcess.StartInfo.RedirectStandardOutput = true; m_remoteCommandProcess.StartInfo.RedirectStandardError = true; m_remoteCommandProcess.Start(); m_remoteCommandProcess.BeginOutputReadLine(); m_remoteCommandProcess.BeginErrorReadLine(); UpdateStatus(UpdateType.Information, "Remote command session established - status updates are suspended.\r\n\r\n"); m_remoteCommandClientID = requestinfo.Sender.ClientID; SendResponse(requestinfo.Sender.ClientID, new ServiceResponse("TelnetSession", "Established")); } else { UpdateStatus(requestinfo.Sender.ClientID, UpdateType.Alarm, "Failed to establish remote command session - Password is invalid.\r\n\r\n"); } } else if (string.Compare(requestinfo.Request.Command, "Telnet", true) == 0 && m_remoteCommandProcess != null && disconnectSession) { // User wants to terminate an established remote command session. m_remoteCommandProcess.ErrorDataReceived -= RemoteCommandProcess_ErrorDataReceived; m_remoteCommandProcess.OutputDataReceived -= RemoteCommandProcess_OutputDataReceived; if (!m_remoteCommandProcess.HasExited) m_remoteCommandProcess.Kill(); m_remoteCommandProcess.Dispose(); m_remoteCommandProcess = null; m_remoteCommandClientID = Guid.Empty; SendResponse(requestinfo.Sender.ClientID, new ServiceResponse("TelnetSession", "Terminated")); UpdateStatus(UpdateType.Information, "Remote command session terminated - status updates are resumed.\r\n\r\n"); } else if (m_remoteCommandProcess != null) { // User has entered commands that must be redirected to the established command session. string input = requestinfo.Request.Command + " " + requestinfo.Request.Arguments.ToString(); m_remoteCommandProcess.StandardInput.WriteLine(input); } else { // User has provided insufficient information. requestinfo.Request = ClientRequest.Parse("Telnet /?"); RemoteTelnetSession(requestinfo); } } }
private void AbortProcess(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest || requestInfo.Request.Arguments.OrderedArgCount < 1) { bool showAdvancedHelp = requestInfo.Request.Arguments.Exists("advanced"); StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Aborts the specified service or system process if executing."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Abort \"Process Name\" -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Displays list of all service or system processes"); if (m_supportSystemCommands && showAdvancedHelp) { helpMessage.AppendLine(); helpMessage.Append(" -system".PadRight(20)); helpMessage.Append("Treats the specified process as a system process"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append("NOTE: Specify process name of \"Me\" to kill current service process. "); } helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string processName = requestInfo.Request.Arguments["orderedarg1"]; bool systemProcess = requestInfo.Request.Arguments.Exists("system"); bool listProcesses = requestInfo.Request.Arguments.Exists("list"); if (systemProcess && m_supportSystemCommands) { // Abort system process. Process processToAbort = null; if (string.Compare(processName, "Me", true) == 0) { processName = Process.GetCurrentProcess().ProcessName; } foreach (Process process in Process.GetProcessesByName(processName)) { // Lookup for the system process by name. processToAbort = process; break; } if (processToAbort == null) { int processID; if (int.TryParse(processName, out processID) && processID > 0) { processToAbort = Process.GetProcessById(processID); processName = processToAbort.ProcessName; } } if (processToAbort != null) { try { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to abort system process \"{0}\"...\r\n\r\n", processName); processToAbort.Kill(); if (processToAbort.WaitForExit(10000)) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully aborted system process \"{0}\".\r\n\r\n", processName); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to abort system process \"{0}\". Process not responding.\r\n\r\n", processName); } } catch (Exception ex) { m_errorLogger.Log(ex); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to abort system process \"{0}\". {1}.\r\n\r\n", processName, ex.Message); } } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to abort system process \"{0}\". Process is not running.\r\n\r\n", processName); } } else { // Abort service process. ServiceProcess processToAbort = FindProcess(processName); if (processToAbort != null) { if (processToAbort.CurrentState == ServiceProcessState.Processing) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to abort service process \"{0}\"...\r\n\r\n", processName); processToAbort.Abort(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully aborted service process \"{0}\".\r\n\r\n", processName); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to abort service process \"{0}\". Process is not executing.\r\n\r\n", processName); } } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to abort service process \"{0}\". Process is not defined.\r\n\r\n", processName); } } if (listProcesses) { requestInfo.Request = ClientRequest.Parse(string.Format("Processes {0}", systemProcess ? "-system" : "")); ShowProcesses(requestInfo); } } }
private void UnscheduleProcess(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest || requestInfo.Request.Arguments.OrderedArgCount < 1) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Unschedules a scheduled process defined in the service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Unschedule \"Process Name\" -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -save".PadRight(20)); helpMessage.Append("Saves all process schedules to the config file"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Displays list of all process schedules"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string processName = requestInfo.Request.Arguments["orderedarg1"]; bool saveSchedules = requestInfo.Request.Arguments.Exists("save"); bool listSchedules = requestInfo.Request.Arguments.Exists("list"); Schedule scheduleToRemove = m_processScheduler.FindSchedule(processName); if (scheduleToRemove != null) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to unschedule process \"{0}\"...\r\n\r\n", processName); m_processScheduler.Schedules.Remove(scheduleToRemove); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully unscheduled process \"{0}\".\r\n\r\n", processName); if (saveSchedules) { requestInfo.Request = ClientRequest.Parse("SaveSchedules"); SaveSchedules(requestInfo); } } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to unschedule process \"{0}\". Process is not scheduled.\r\n\r\n", processName); } if (listSchedules) { requestInfo.Request = ClientRequest.Parse("Schedules"); ShowSchedules(requestInfo); } } }
private void ReloadCryptoCache(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Reloads the local system cryptography cache with data from the common cryptography cache."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" ReloadCryptoCache -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { Cipher.ReloadCache(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Crypto cache successfully reloaded.\r\n\r\n"); } }
private void UpdateSettings(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest || requestInfo.Request.Arguments.OrderedArgCount < 3) { // We'll display help about the request since we either don't have the required arguments or the user // has explicitly requested for the help to be displayed for this request type. StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Updates the specified setting under the specified category in the config file."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" UpdateSettings \"Category Name\" \"Setting Name\" \"Setting Value\" -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -add".PadRight(20)); helpMessage.Append("Adds specified setting to the specified category"); helpMessage.AppendLine(); helpMessage.Append(" -delete".PadRight(20)); helpMessage.Append("Deletes specified setting from the specified category"); helpMessage.AppendLine(); helpMessage.Append(" -reload".PadRight(20)); helpMessage.Append("Causes corresponding component to reload settings"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Displays list all of the queryable settings"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append("IMPORTANT: Only settings under the categories listed by the \"Settings\" command can be updated."); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string categoryName = requestInfo.Request.Arguments["orderedarg1"]; string settingName = requestInfo.Request.Arguments["orderedarg2"]; string settingValue = requestInfo.Request.Arguments["orderedarg3"]; bool addSetting = requestInfo.Request.Arguments.Exists("add"); bool deleteSetting = requestInfo.Request.Arguments.Exists("delete"); bool reloadSettings = requestInfo.Request.Arguments.Exists("reload"); bool listSettings = requestInfo.Request.Arguments.Exists("list"); IPersistSettings typedComponent; lock (m_serviceComponents) { foreach (object component in m_serviceComponents) { typedComponent = component as IPersistSettings; if (typedComponent != null && string.Compare(categoryName, typedComponent.SettingsCategory, true) == 0) { ConfigurationFile config = ConfigurationFile.Current; CategorizedSettingsElementCollection settings = config.Settings[categoryName]; CategorizedSettingsElement setting = settings[settingName]; if (addSetting) { // Add new setting. if (setting == null) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to add setting \"{0}\" under category \"{1}\"...\r\n\r\n", settingName, categoryName); settings.Add(settingName, settingValue); config.Save(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully added setting \"{0}\" under category \"{1}\".\r\n\r\n", settingName, categoryName); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to add setting \"{0}\" under category \"{1}\". Setting already exists.\r\n\r\n", settingName, categoryName); return; } } else if (deleteSetting) { // Delete existing setting. if (setting != null) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to delete setting \"{0}\" under category \"{1}\"...\r\n\r\n", settingName, categoryName); settings.Remove(setting); config.Save(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully deleted setting \"{0}\" under category \"{1}\".\r\n\r\n", settingName, categoryName); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to delete setting \"{0}\" under category \"{1}\". Setting does not exist.\r\n\r\n", settingName, categoryName); return; } } else { // Update existing setting. if (setting != null) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to update setting \"{0}\" under category \"{1}\"...\r\n\r\n", settingName, categoryName); setting.Value = settingValue; config.Save(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully updated setting \"{0}\" under category \"{1}\".\r\n\r\n", settingName, categoryName); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to update value of setting \"{0}\" under category \"{1}\" . Setting does not exist.\r\n\r\n", settingName, categoryName); return; } } if (reloadSettings) { // The user has requested to reload settings for all the components. requestInfo.Request = ClientRequest.Parse(string.Format("ReloadSettings {0}", categoryName)); ReloadSettings(requestInfo); } if (listSettings) { // The user has requested to list all of the queryable settings. requestInfo.Request = ClientRequest.Parse("Settings"); ShowSettings(requestInfo); } return; } } } UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to update settings under category \"{0}\". No corresponding component exists.\r\n\r\n", categoryName); } }
/// <summary> /// Sends an actionable response to client along with an optional formatted message and attachment. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> /// <param name="success">Flag that determines if this response to client request was a success.</param> /// <param name="attachment">Attachment to send with response.</param> /// <param name="status">Formatted status message to send with response.</param> /// <param name="args">Arguments of the formatted status message.</param> /// <remarks> /// This method is used to send an actionable client response that can be used for responding to an event after a command has been issued. /// </remarks> public void SendActionableResponse(ClientRequestInfo requestInfo, bool success, object attachment = null, string status = null, params object[] args) { try { string responseType = requestInfo.Request.Command + (success ? ":Success" : ":Failure"); string message = ""; if (!string.IsNullOrWhiteSpace(status)) { if (args.Length == 0) message = status + "\r\n\r\n"; else message = string.Format(status, args) + "\r\n\r\n"; } ServiceResponse response = new ServiceResponse(responseType, message); // Add any specified attachment to the service response if (attachment != null) response.Attachments.Add(attachment); // Add original command arguments as an attachment response.Attachments.Add(requestInfo.Request.Arguments); // Send response to service SendResponse(requestInfo.Sender.ClientID, response); } catch (Exception ex) { ErrorLogger.Log(ex); UpdateStatus(UpdateType.Alarm, "Failed to send actionable client response with attachment due to an exception: " + ex.Message + "\r\n\r\n"); } }
private void RemotingServer_ReceiveClientDataComplete(object sender, EventArgs<Guid, byte[], int> e) { ClientInfo requestSender = FindConnectedClient(e.Argument1); TcpServer remotingServer = m_remotingServer as TcpServer; WindowsPrincipal clientPrincipal; if (requestSender == null) { // First message from a remote client should be its info. ClientInfo client = null; Serialization.TryDeserialize<ClientInfo>(e.Argument2.BlockCopy(0, e.Argument3), SerializationFormat.Binary, out client); try { if (client != null) { client.ClientID = e.Argument1; client.ConnectedAt = DateTime.Now; if ((object)remotingServer != null && remotingServer.TryGetClientPrincipal(e.Argument1, out clientPrincipal)) Thread.CurrentPrincipal = clientPrincipal; // Engage security for the remote client connection if configured. if (!m_secureRemoteInteractions || (m_secureRemoteInteractions && VerifySecurity(client))) { lock (m_remoteClients) { m_remoteClients.Add(client); } SendAuthenticationSuccessResponse(client.ClientID); UpdateStatus(UpdateType.Information, "Remote client connected - {0} from {1}.\r\n\r\n", client.ClientUser.Identity.Name, client.MachineName); } else { throw new SecurityException(string.Format("Authentication failed for user '{0}'", Thread.CurrentPrincipal.Identity.Name)); } } else { // Required client information is missing. throw new SecurityException("Remote client failed to transmit the required information"); } } catch (Exception ex) { try { SendResponse(e.Argument1, new ServiceResponse("AuthenticationFailure"), false); m_remotingServer.DisconnectOne(e.Argument1); UpdateStatus(UpdateType.Warning, "Remote client connection rejected - {0} from {1}.\r\n\r\n", client.ClientUser.Identity.Name, client.MachineName); m_errorLogger.Log(ex); } catch { } } } else { // All subsequest messages from a remote client would be requests. ClientRequest request = null; Serialization.TryDeserialize<ClientRequest>(e.Argument2.BlockCopy(0, e.Argument3), SerializationFormat.Binary, out request); if (request != null) { try { ClientRequestInfo requestInfo = new ClientRequestInfo(requestSender, request); string resource = requestInfo.Request.Command; if (m_remoteCommandClientID == Guid.Empty) { // Process incoming requests when remote command session is not in progress. lock (m_clientRequestHistory) { m_clientRequestHistory.Add(requestInfo); if (m_clientRequestHistory.Count > m_requestHistoryLimit) m_clientRequestHistory.RemoveRange(0, (m_clientRequestHistory.Count - m_requestHistoryLimit)); } // Check if remote client has permission to invoke the requested command. if (m_secureRemoteInteractions && VerifySecurity(requestInfo.Sender) && SecurityProviderUtility.IsResourceSecurable(resource) && !SecurityProviderUtility.IsResourceAccessible(resource)) throw new SecurityException(string.Format("Access to '{0}' is denied", requestInfo.Request.Command)); // Notify the consumer about the incoming request from client. OnReceivedClientRequest(request, requestSender); ClientRequestHandler requestHandler = FindClientRequestHandler(request.Command); if (requestHandler != null) { // Request handler exists. requestHandler.HandlerMethod(requestInfo); } else { // No request handler exists. throw new InvalidOperationException("Request is not supported"); } } else if (requestSender.ClientID == m_remoteCommandClientID) { // Redirect requests to remote command session if requests are from its originator. RemoteTelnetSession(requestInfo); } else { // Reject all request from other clients since remote command session is in progress. throw new InvalidOperationException("Remote telnet session is in progress"); } } catch (Exception ex) { m_errorLogger.Log(ex); UpdateStatus(requestSender.ClientID, UpdateType.Alarm, "Failed to process request \"{0}\" - {1}.\r\n\r\n", request.Command, ex.Message); } } else { UpdateStatus(requestSender.ClientID, UpdateType.Alarm, "Failed to process request - Request could not be deserialized.\r\n\r\n"); } } }
/// <summary> /// Sends an actionable response to client with a formatted message and attachment. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> /// <param name="success">Flag that determines if this response to client request was a success.</param> /// <param name="attachment">Attachment to send with response.</param> /// <param name="status">Formatted status message to send with response.</param> /// <param name="args">Arguments of the formatted status message.</param> protected virtual void SendResponseWithAttachment(ClientRequestInfo requestInfo, bool success, object attachment, string status, params object[] args) { try { // Send actionable response m_serviceHelper.SendActionableResponse(requestInfo, success, attachment, status, args); // Log details of client request as well as response if (m_serviceHelper.LogStatusUpdates && m_serviceHelper.StatusLog.IsOpen) { string responseType = requestInfo.Request.Command + (success ? ":Success" : ":Failure"); string arguments = requestInfo.Request.Arguments.ToString(); string message = responseType + (string.IsNullOrWhiteSpace(arguments) ? "" : "(" + arguments + ")"); if (status != null) { if (args.Length == 0) message += " - " + status; else message += " - " + string.Format(status, args); } m_serviceHelper.StatusLog.WriteTimestampedLine(message); } } catch (Exception ex) { m_serviceHelper.ErrorLogger.Log(ex); m_serviceHelper.UpdateStatus(UpdateType.Alarm, "Failed to send client response due to an exception: " + ex.Message + "\r\n\r\n"); } }
/// <summary> /// Displays a response message to client requestor. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> /// <param name="status">Formatted status message to send to client.</param> /// <param name="args">Arguments of the formatted status message.</param> protected virtual void DisplayResponseMessage(ClientRequestInfo requestInfo, string status, params object[] args) { try { m_serviceHelper.UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, string.Format("{0}\r\n\r\n", status), args); } catch (Exception ex) { m_serviceHelper.ErrorLogger.Log(ex); m_serviceHelper.UpdateStatus(UpdateType.Alarm, "Failed to update client status \"" + status.ToNonNullString() + "\" due to an exception: " + ex.Message + "\r\n\r\n"); } }
/// <summary> /// Sends an actionable response to client with a formatted message. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> /// <param name="success">Flag that determines if this response to client request was a success.</param> /// <param name="status">Formatted status message to send with response.</param> /// <param name="args">Arguments of the formatted status message.</param> protected virtual void SendResponse(ClientRequestInfo requestInfo, bool success, string status, params object[] args) { SendResponseWithAttachment(requestInfo, success, null, status, args); }
/// <summary> /// Sends an actionable response to client. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> /// <param name="success">Flag that determines if this response to client request was a success.</param> protected virtual void SendResponse(ClientRequestInfo requestInfo, bool success) { SendResponseWithAttachment(requestInfo, success, null, null); }
/// <summary> /// Attempts to restart the hose service. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> protected virtual void RestartServiceHandler(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Attempts to restart the host service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Restart [Options]"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); DisplayResponseMessage(requestInfo, helpMessage.ToString()); } else { if (m_allowRemoteRestart) { DisplayStatusMessage("Attempting to restart host service...", UpdateType.Information); try { ProcessStartInfo psi = new ProcessStartInfo(ConsoleApplicationName) { CreateNoWindow = true, WindowStyle = ProcessWindowStyle.Hidden, UseShellExecute = false, Arguments = ServiceName + " -restart" }; using (Process shell = new Process()) { shell.StartInfo = psi; shell.Start(); if (!shell.WaitForExit(30000)) shell.Kill(); } SendResponse(requestInfo, true); } catch (Exception ex) { SendResponse(requestInfo, false, "Failed to restart host service: {0}", ex.Message); m_serviceHelper.ErrorLogger.Log(ex); } } else { DisplayStatusMessage("Remote restart request denied, this is currently disallowed in the system configuration.", UpdateType.Warning); } } }
private void ResetHealthMonitor(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Resets the system resource utilization monitor."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" ResetHealthMonitor -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { try { // Dispose existing performance monitor if (m_performanceMonitor != null) m_performanceMonitor.Dispose(); // Recreate the performance monitor m_performanceMonitor = new PerformanceMonitor(m_healthMonitorInterval * 1000.0D, true); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "System health monitor successfully reset.\r\n\r\n"); } catch (Exception ex) { m_errorLogger.Log(ex); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to reset system health monitor: {0}\r\n\r\n", ex.Message); } } }
private void ShowClients(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a list of clients currently connected to the service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Clients -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { if (m_remoteClients.Count > 0) { // Display info about all of the clients connected to the service. StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("Clients connected to {0}:", Name); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("Client".PadRight(25)); responseMessage.Append(' '); responseMessage.Append("Machine".PadRight(15)); responseMessage.Append(' '); responseMessage.Append("User".PadRight(15)); responseMessage.Append(' '); responseMessage.Append("Connected".PadRight(20)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 25)); responseMessage.Append(' '); responseMessage.Append(new string('-', 15)); responseMessage.Append(' '); responseMessage.Append(new string('-', 15)); responseMessage.Append(' '); responseMessage.Append(new string('-', 20)); lock (m_remoteClients) { foreach (ClientInfo clientInfo in m_remoteClients) { responseMessage.AppendLine(); if (!string.IsNullOrEmpty(clientInfo.ClientName)) responseMessage.Append(clientInfo.ClientName.PadRight(25)); else responseMessage.Append("[Not Available]".PadRight(25)); responseMessage.Append(' '); if (!string.IsNullOrEmpty(clientInfo.MachineName)) responseMessage.Append(clientInfo.MachineName.PadRight(15)); else responseMessage.Append("[Not Available]".PadRight(15)); responseMessage.Append(' '); if (!string.IsNullOrEmpty(clientInfo.ClientUser.Identity.Name)) responseMessage.Append(clientInfo.ClientUser.Identity.Name.PadRight(15)); else responseMessage.Append("[Not Available]".PadRight(15)); responseMessage.Append(' '); responseMessage.Append(clientInfo.ConnectedAt.ToString("MM/dd/yy hh:mm:ss tt").PadRight(20)); } } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "No clients are connected to {0}\r\n\r\n", Name); } } }
private void ShowServiceStatus(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays status of this service and its components."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Status -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -actionable".PadRight(20)); helpMessage.Append("Returns results via an actionable event"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string message = Status; UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, message); // Also allow consumers to directly consume message via event in response to a status request if (requestInfo.Request.Arguments.Exists("actionable")) SendActionableResponse(requestInfo, true, null, message); } }
private void ShowSettings(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a list of service settings from the config file."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Settings -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("Settings for {0}:", Name); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("Category".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("Name".PadRight(25)); responseMessage.Append(' '); responseMessage.Append("Value".PadRight(30)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 25)); responseMessage.Append(' '); responseMessage.Append(new string('-', 30)); IPersistSettings typedComponent; lock (m_serviceComponents) { foreach (object component in m_serviceComponents) { typedComponent = component as IPersistSettings; if (typedComponent != null) { foreach (CategorizedSettingsElement setting in ConfigurationFile.Current.Settings[typedComponent.SettingsCategory]) { // Skip encrypted settings for security purpose. if (setting.Encrypted) continue; responseMessage.AppendLine(); responseMessage.Append(typedComponent.SettingsCategory.PadRight(20)); responseMessage.Append(' '); responseMessage.Append(setting.Name.PadRight(25)); responseMessage.Append(' '); if (!string.IsNullOrEmpty(setting.Value)) responseMessage.Append(setting.Value.PadRight(30)); else responseMessage.Append("[Not Set]".PadRight(30)); } } } } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } }
private void ReloadSettings(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest || requestInfo.Request.Arguments.OrderedArgCount < 1) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Reloads settings of the component whose settings are saved under the specified category in the config file."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" ReloadSettings \"Category Name\" -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append("IMPORTANT: Only settings under the categories listed by the \"Settings\" command can be reloaded."); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string categoryName = requestInfo.Request.Arguments["orderedarg1"]; IPersistSettings typedComponent; lock (m_serviceComponents) { foreach (object component in m_serviceComponents) { typedComponent = component as IPersistSettings; if ((object) typedComponent != null && string.Compare(categoryName, typedComponent.SettingsCategory, true) == 0) { typedComponent.LoadSettings(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully loaded settings from category \"{0}\".\r\n\r\n", categoryName); return; } } } UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to load settings from category \"{0}\". No corresponding component exists.\r\n\r\n", categoryName); } }
private void ShowProcesses(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { bool showAdvancedHelp = requestInfo.Request.Arguments.Exists("advanced"); StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a list of defined service processes or running system processes."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Processes -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); if (m_supportSystemCommands && showAdvancedHelp) { helpMessage.AppendLine(); helpMessage.Append(" -system".PadRight(20)); helpMessage.Append("Displays system processes instead of service processes"); } helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { bool listSystemProcesses = requestInfo.Request.Arguments.Exists("system"); if (listSystemProcesses && m_supportSystemCommands) { // Enumerate "system" processes when -system parameter is specified StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("Processes running on {0}:", Environment.MachineName); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("ID".PadRight(5)); responseMessage.Append(' '); responseMessage.Append("Name".PadRight(25)); responseMessage.Append(' '); responseMessage.Append("Priority".PadRight(15)); responseMessage.Append(' '); responseMessage.Append("Responding".PadRight(10)); responseMessage.Append(' '); responseMessage.Append("Start Time".PadRight(20)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 5)); responseMessage.Append(' '); responseMessage.Append(new string('-', 25)); responseMessage.Append(' '); responseMessage.Append(new string('-', 15)); responseMessage.Append(' '); responseMessage.Append(new string('-', 10)); responseMessage.Append(' '); responseMessage.Append(new string('-', 20)); foreach (Process process in Process.GetProcesses()) { try { responseMessage.Append(process.StartInfo.UserName); responseMessage.AppendLine(); responseMessage.Append(process.Id.ToString().PadRight(5)); responseMessage.Append(' '); responseMessage.Append(process.ProcessName.PadRight(25)); responseMessage.Append(' '); #if MONO responseMessage.Append("Undetermined".PadRight(15)); responseMessage.Append(' '); responseMessage.Append("N/A".PadRight(10)); responseMessage.Append(' '); #else responseMessage.Append(process.PriorityClass.ToString().PadRight(15)); responseMessage.Append(' '); responseMessage.Append((process.Responding ? "Yes" : "No").PadRight(10)); responseMessage.Append(' '); #endif responseMessage.Append(process.StartTime.ToString("MM/dd/yy hh:mm:ss tt").PadRight(20)); } catch { } } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } else { if (m_processes.Count > 0) { // Display info about all the processes defined in the service. StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("Processes defined in {0}:", Name); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("Name".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("State".PadRight(15)); responseMessage.Append(' '); responseMessage.Append("Last Exec. Start".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("Last Exec. Stop".PadRight(20)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 15)); responseMessage.Append(' '); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 20)); lock (m_processes) { foreach (ServiceProcess process in m_processes) { responseMessage.AppendLine(); responseMessage.Append(process.Name.PadRight(20)); responseMessage.Append(' '); responseMessage.Append(process.CurrentState.ToString().PadRight(15)); responseMessage.Append(' '); if (process.ExecutionStartTime != DateTime.MinValue) responseMessage.Append(process.ExecutionStartTime.ToString("MM/dd/yy hh:mm:ss tt").PadRight(20)); else responseMessage.Append("[Not Executed]".PadRight(20)); responseMessage.Append(' '); if (process.ExecutionStopTime != DateTime.MinValue) { responseMessage.Append(process.ExecutionStopTime.ToString("MM/dd/yy hh:mm:ss tt").PadRight(20)); } else { if (process.ExecutionStartTime != DateTime.MinValue) responseMessage.Append("[Executing]".PadRight(20)); else responseMessage.Append("[Not Executed]".PadRight(20)); } } } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } else { // No processes defined in the service to be displayed. UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "No processes are defined in {0}.\r\n\r\n", Name); } } } }
private void StartProcess(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest || requestInfo.Request.Arguments.OrderedArgCount < 1) { bool showAdvancedHelp = requestInfo.Request.Arguments.Exists("advanced"); StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Starts execution of the specified service or system process."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Start \"Process Name\" -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -args".PadRight(20)); helpMessage.Append("Arguments to be passed in to the process"); helpMessage.AppendLine(); helpMessage.Append(" -restart".PadRight(20)); helpMessage.Append("Aborts the process if executing and start it again"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Displays list of all service or system processes"); if (m_supportSystemCommands && showAdvancedHelp) { helpMessage.AppendLine(); helpMessage.Append(" -system".PadRight(20)); helpMessage.Append("Treats the specified process as a system process"); } helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string processName = requestInfo.Request.Arguments["orderedarg1"]; string processArgs = requestInfo.Request.Arguments["args"]; bool systemProcess = requestInfo.Request.Arguments.Exists("system"); bool restartProcess = requestInfo.Request.Arguments.Exists("restart"); bool listProcesses = requestInfo.Request.Arguments.Exists("list"); if (restartProcess) { requestInfo.Request = ClientRequest.Parse(string.Format("Abort \"{0}\" {1}", processName, systemProcess ? "-system" : "")); AbortProcess(requestInfo); } if (systemProcess && m_supportSystemCommands) { // Start system process. try { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to start system process \"{0}\"...\r\n\r\n", processName); Process startedProcess = Process.Start(processName, processArgs); if (startedProcess != null) UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully started system process \"{0}\".\r\n\r\n", processName); else UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to start system process \"{0}\".\r\n\r\n", processName); } catch (Exception ex) { m_errorLogger.Log(ex); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to start system process \"{0}\". {1}.\r\n\r\n", processName, ex.Message); } } else { // Start service process. ServiceProcess processToStart = FindProcess(processName); if (processToStart != null) { if (processToStart.CurrentState != ServiceProcessState.Processing) { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to start service process \"{0}\"...\r\n\r\n", processName); if (string.IsNullOrEmpty(processArgs)) { processToStart.Start(); } else { // Prepare the arguments. string[] splitArgs = processArgs.Split(','); Array.ForEach<string>(splitArgs, (string arg) => arg.Trim()); // Start the service process. processToStart.Start(splitArgs); } UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully started service process \"{0}\".\r\n\r\n", processName); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to start process \"{0}\". Process is already executing.\r\n\r\n", processName); } } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to start service process \"{0}\". Process is not defined.\r\n\r\n", processName); } } if (listProcesses) { requestInfo.Request = ClientRequest.Parse(string.Format("Processes {0}", systemProcess ? "-system" : "")); ShowProcesses(requestInfo); } } }
private void ShowSchedules(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a list of schedules for processes defined in the service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Schedules -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { if (m_processScheduler.Schedules.Count > 0) { // Display info about all the process schedules defined in the service. StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("Process schedules defined in {0}:", Name); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("Name".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("Rule".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("Last Due".PadRight(30)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 30)); foreach (Schedule schedule in m_processScheduler.Schedules) { responseMessage.AppendLine(); responseMessage.Append(schedule.Name.PadRight(20)); responseMessage.Append(' '); responseMessage.Append(schedule.Rule.PadRight(20)); responseMessage.Append(' '); if (schedule.LastDueAt != DateTime.MinValue) responseMessage.Append(schedule.LastDueAt.ToString().PadRight(30)); else responseMessage.Append("[Never]".PadRight(30)); } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } else { UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "No process schedules are defined in {0}.\r\n\r\n", Name); } } }
private void RescheduleProcess(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest || requestInfo.Request.Arguments.OrderedArgCount < 2) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Schedules or re-schedules an existing process defined in the service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Reschedule \"Process Name\" \"Schedule Rule\" -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -save".PadRight(20)); helpMessage.Append("Saves all process schedules to the config file"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Displays list of all process schedules"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append("NOTE: The schedule rule uses UNIX crontab syntax which consists of 5 parts (For example, \"* * * * *\"). "); helpMessage.Append("Following is a brief description of each of the 5 parts that make up the rule:"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Part 1 - Minute part; value range 0 to 59. "); helpMessage.AppendLine(); helpMessage.Append(" Part 2 - Hour part; value range 0 to 23. "); helpMessage.AppendLine(); helpMessage.Append(" Part 3 - Day of month part; value range 1 to 31. "); helpMessage.AppendLine(); helpMessage.Append(" Part 4 - Month part; value range 1 to 12. "); helpMessage.AppendLine(); helpMessage.Append(" Part 5 - Day of week part; value range 0 to 6 (0 = Sunday). "); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append("Following is a description of valid syntax for all parts of the rule:"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" * - Any value in the range for the date-time part."); helpMessage.AppendLine(); helpMessage.Append(" */n - Every nth value for the data-time part."); helpMessage.AppendLine(); helpMessage.Append(" n1-n2 - Range of values (inclusive) for the date-time part."); helpMessage.AppendLine(); helpMessage.Append(" n1,n2 - 1 or more specific values for the date-time part."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append("Examples:"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" \"* * * * *\" - Process executes every minute."); helpMessage.AppendLine(); helpMessage.Append(" \"*/5 * * * *\" - Process executes every 5 minutes."); helpMessage.AppendLine(); helpMessage.Append(" \"5 * * * *\" - Process executes 5 past every hour."); helpMessage.AppendLine(); helpMessage.Append(" \"0 0 * * *\" - Process executes every day at midnight."); helpMessage.AppendLine(); helpMessage.Append(" \"0 0 1 * *\" - Process executes 1st of every month at midnight."); helpMessage.AppendLine(); helpMessage.Append(" \"0 0 * * 0\" - Process executes every Sunday at midnight."); helpMessage.AppendLine(); helpMessage.Append(" \"0 0 31 12 *\" - Process executes on December 31 at midnight."); helpMessage.AppendLine(); helpMessage.Append(" \"5,10 0-2 * * *\" - Process executes 5 and 10 past hours 12am to 2am."); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string processName = requestInfo.Request.Arguments["orderedarg1"]; string scheduleRule = requestInfo.Request.Arguments["orderedarg2"]; bool saveSchedules = requestInfo.Request.Arguments.Exists("save"); bool listSchedules = requestInfo.Request.Arguments.Exists("list"); try { // Schedule the process if not scheduled or update its schedule if scheduled. UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to schedule process \"{0}\" with rule \"{1}\"...\r\n\r\n", processName, scheduleRule); ScheduleProcess(processName, scheduleRule, true); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully scheduled process \"{0}\" with rule \"{1}\".\r\n\r\n", processName, scheduleRule); if (saveSchedules) { requestInfo.Request = ClientRequest.Parse("SaveSchedules"); SaveSchedules(requestInfo); } } catch (Exception ex) { m_errorLogger.Log(ex); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, "Failed to schedule process \"{0}\". {1}\r\n\r\n", processName, ex.Message); } if (listSchedules) { requestInfo.Request = ClientRequest.Parse("Schedules"); ShowSchedules(requestInfo); } } }
private void ShowRequestHistory(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a list of recent requests received from the clients."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" History -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("History of requests received by {0}:", Name); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("Command".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("Received".PadRight(25)); responseMessage.Append(' '); responseMessage.Append("Sender".PadRight(30)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 25)); responseMessage.Append(' '); responseMessage.Append(new string('-', 30)); lock (m_clientRequestHistory) { foreach (ClientRequestInfo historicRequest in m_clientRequestHistory) { responseMessage.AppendLine(); responseMessage.Append(historicRequest.Request.Command.PadRight(20)); responseMessage.Append(' '); responseMessage.Append(historicRequest.ReceivedAt.ToString().PadRight(25)); responseMessage.Append(' '); responseMessage.Append(string.Format("{0} from {1}", historicRequest.Sender.ClientUser.Identity.Name, historicRequest.Sender.MachineName).PadRight(30)); } } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } }
private void LoadSchedules(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Loads all process schedules from the config file."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" LoadSchedules -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Displays list of all process schedules"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { bool listSchedules = requestInfo.Request.Arguments.Exists("list"); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Attempting to load process schedules from the config file...\r\n\r\n"); m_processScheduler.LoadSettings(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "Successfully loaded process schedules from the config file.\r\n\r\n"); if (listSchedules) { requestInfo.Request = ClientRequest.Parse("Schedules"); ShowSchedules(requestInfo); } } }
private void ShowRequestHelp(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a list of commands supported by the service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Help -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { bool showAdvancedHelp = requestInfo.Request.Arguments.Exists("advanced"); StringBuilder responseMessage = new StringBuilder(); responseMessage.AppendFormat("Commands supported by {0}:", Name); responseMessage.AppendLine(); responseMessage.AppendLine(); responseMessage.Append("Command".PadRight(20)); responseMessage.Append(' '); responseMessage.Append("Description".PadRight(55)); responseMessage.AppendLine(); responseMessage.Append(new string('-', 20)); responseMessage.Append(' '); responseMessage.Append(new string('-', 55)); lock (m_clientRequestHandlers) { foreach (ClientRequestHandler handler in m_clientRequestHandlers) { if (handler.IsAdvertised || showAdvancedHelp) { responseMessage.AppendLine(); responseMessage.Append(handler.Command.PadRight(20)); responseMessage.Append(' '); responseMessage.Append(handler.CommandDescription.PadRight(55)); } } } responseMessage.AppendLine(); responseMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, responseMessage.ToString()); } }
private void ShowTime(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Shows the current system time."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Time -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -actionable".PadRight(20)); helpMessage.Append("Returns results via an actionable event"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string message; // 1 2 3 4 5 6 7 8 // 12345678901234567890123456789012345678901234567890123456789012345678901234567890 // Current system time: yyyy-MM-dd HH:mm:ss.fff, yyyy-MM-dd HH:mm:ss.fff UTC // Total system runtime: xx days yy hours zz minutes ii seconds if (m_remotingServer != null) message = string.Format(" Current system time: {0}, {1} UTC\r\nTotal system runtime: {2}", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff"), DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss.fff"), m_remotingServer.RunTime.ToString()); else message = string.Format("Current system time: {0}, {1} UTC", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff"), DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss.fff")); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, message + "\r\n\r\n"); // Also allow consumers to directly consume message via event in response to a time request if (requestInfo.Request.Arguments.Exists("actionable")) SendActionableResponse(requestInfo, true, null, message); } }
private void ShowHealthReport(ClientRequestInfo requestInfo) { if (requestInfo.Request.Arguments.ContainsHelpRequest) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Displays a resource utilization report for the service."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" Health -options"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -lifetime".PadRight(20)); helpMessage.Append("Shows utilization over entire service lifetime"); helpMessage.AppendLine(); helpMessage.Append(" -actionable".PadRight(20)); helpMessage.Append("Returns results via an actionable event"); helpMessage.AppendLine(); helpMessage.AppendLine(); UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, helpMessage.ToString()); } else { string message; bool success; if (m_performanceMonitor != null) { try { if (requestInfo.Request.Arguments.Exists("lifetime")) message = m_performanceMonitor.LifetimeStatus; else message = m_performanceMonitor.Status; UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Information, "\r\n" + message + "\r\n"); success = true; } catch (Exception ex) { m_errorLogger.Log(ex); message = "Failed to query system health monitor status: " + ex.Message; UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Alarm, message + "\r\n\r\n"); success = false; } } else { message = "System health monitor is unavailable."; UpdateStatus(requestInfo.Sender.ClientID, UpdateType.Warning, message + "\r\n\r\n"); success = false; } // Also allow consumers to directly consume message via event in response to a health request if (requestInfo.Request.Arguments.Exists("actionable")) SendActionableResponse(requestInfo, success, null, message); } }
/// <summary> /// Returns an <see cref="ClientRequestInfo"/> object for the specified <paramref name="requestCommand"/> that can be used /// to invoke <see cref="ServiceHelper.ClientRequestHandlers"/> manually as if the request was sent by a <see cref="ClientHelper"/> remotely. /// </summary> /// <param name="requestCommand">Command for which an <see cref="ClientRequestInfo"/> object is to be created.</param> /// <returns>An <see cref="ClientRequestInfo"/> object.</returns> public static ClientRequestInfo PretendRequest(string requestCommand) { ClientRequest request = ClientRequest.Parse(requestCommand); ClientRequestInfo requestInfo = new ClientRequestInfo(new ClientInfo(), request); return requestInfo; }
/// <summary> /// Updates an option in the configuration file. /// </summary> /// <param name="requestInfo"><see cref="ClientRequestInfo"/> instance containing the client request.</param> protected virtual void UpdateConfigFileRequestHandler(ClientRequestInfo requestInfo) { int orderedArgCount = requestInfo.Request.Arguments.OrderedArgCount; bool listSetting = requestInfo.Request.Arguments.Exists("list"); bool deleteSetting = requestInfo.Request.Arguments.Exists("delete"); bool addSetting = requestInfo.Request.Arguments.Exists("add"); if (requestInfo.Request.Arguments.ContainsHelpRequest || (!listSetting && orderedArgCount < 2) || (!listSetting && !deleteSetting && orderedArgCount < 3)) { StringBuilder helpMessage = new StringBuilder(); helpMessage.Append("Updates an option in the configuration file."); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Usage:"); helpMessage.AppendLine(); helpMessage.Append(" UpdateConfigFile [Category Name] -list"); helpMessage.AppendLine(); helpMessage.Append(" UpdateConfigFile \"Category Name\" \"Setting Name\" -delete"); helpMessage.AppendLine(); helpMessage.Append(" UpdateConfigFile \"Category Name\" \"Setting Name\" \"Setting Value\" [-add]"); helpMessage.AppendLine(); helpMessage.AppendLine(); helpMessage.Append(" Options:"); helpMessage.AppendLine(); helpMessage.Append(" -?".PadRight(20)); helpMessage.Append("Displays this help message"); helpMessage.AppendLine(); helpMessage.Append(" -add".PadRight(20)); helpMessage.Append("Adds specified setting to the specified category"); helpMessage.AppendLine(); helpMessage.Append(" -delete".PadRight(20)); helpMessage.Append("Deletes specified setting from the specified category"); helpMessage.AppendLine(); helpMessage.Append(" -list".PadRight(20)); helpMessage.Append("Lists categories or settings under a specified category"); helpMessage.AppendLine(); helpMessage.AppendLine(); DisplayResponseMessage(requestInfo, helpMessage.ToString()); } else { string categoryName = requestInfo.Request.Arguments["OrderedArg1"]; string settingName = requestInfo.Request.Arguments["OrderedArg2"]; string settingValue = requestInfo.Request.Arguments["OrderedArg3"]; ConfigurationFile config = ConfigurationFile.Current; if (listSetting) { if (orderedArgCount == 0) { StringBuilder categoryList = new StringBuilder(); categoryList.Append("List of categories in the configuration file:"); categoryList.AppendLine(); categoryList.AppendLine(); string xml = config.Settings.SectionInformation.GetRawXml(); XmlDocument xmlDoc = new XmlDocument(); xmlDoc.LoadXml(xml); // List settings categories. foreach (XmlNode node in xmlDoc.DocumentElement) { categoryList.Append(" "); categoryList.Append(node.Name); categoryList.AppendLine(); } categoryList.AppendLine(); DisplayResponseMessage(requestInfo, categoryList.ToString()); } else { CategorizedSettingsElementCollection settings = config.Settings[categoryName]; StringBuilder settingsList = new StringBuilder(); settingsList.Append(string.Format("List of settings under the category {0}:", categoryName)); settingsList.AppendLine(); settingsList.AppendLine(); // List settings under specified category. foreach (CategorizedSettingsElement settingsElement in settings) { // Skip encrypted settings for security purpose. if (settingsElement.Encrypted) continue; settingsList.Append(" Name: "); settingsList.Append(settingsElement.Name); settingsList.AppendLine(); settingsList.Append(" Value: "); settingsList.Append(settingsElement.Value); settingsList.AppendLine(); settingsList.Append(" Description: "); settingsList.Append(settingsElement.Description); settingsList.AppendLine(); settingsList.AppendLine(); } settingsList.Replace("{", "{{{{"); settingsList.Replace("}", "}}}}"); DisplayResponseMessage(requestInfo, settingsList.ToString()); } } else { CategorizedSettingsElementCollection settings = config.Settings[categoryName]; CategorizedSettingsElement setting = settings[settingName]; if (deleteSetting) { // Delete existing setting. if (setting != null) { settings.Remove(setting); config.Save(); SendResponse(requestInfo, true, "Successfully deleted setting \"{0}\" under category \"{1}\".\r\n\r\n", settingName, categoryName); } else { SendResponse(requestInfo, false, "Failed to delete setting \"{0}\" under category \"{1}\". Setting does not exist.\r\n\r\n", settingName, categoryName); } } else if (addSetting) { // Add new setting. if (setting == null) { settings.Add(settingName, settingValue); config.Save(); SendResponse(requestInfo, true, "Successfully added setting \"{0}\" under category \"{1}\".\r\n\r\n", settingName, categoryName); } else { SendResponse(requestInfo, false, "Failed to add setting \"{0}\" under category \"{1}\". Setting already exists.\r\n\r\n", settingName, categoryName); } } else { // Update existing setting. if (setting != null) { setting.Value = settingValue; config.Save(); SendResponse(requestInfo, true, "Successfully updated setting \"{0}\" under category \"{1}\".\r\n\r\n", settingName, categoryName); } else { SendResponse(requestInfo, false, "Failed to update value of setting \"{0}\" under category \"{1}\" . Setting does not exist.\r\n\r\n", settingName, categoryName); } } } } }