/* * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals. * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ using System; using System.IO; using Newtonsoft.Json; using QuantConnect.Logging; using System.Collections.Generic; using System.Linq; using Newtonsoft.Json.Linq; namespace QuantConnect.Commands { /// /// Represents a command handler that sources it's commands from a file on the local disk /// public class FileCommandHandler : BaseCommandHandler { private readonly Queue _commands = new(); private const string _commandFilePattern = "command*.json"; private const string _resultFileBaseName = "result-command"; /// /// Initializes a new instance of the class /// using the 'command-json-file' configuration value for the command json file /// public FileCommandHandler() { } /// /// Gets all the available command files /// /// Sorted enumerator of all the available command files public static IEnumerable GetCommandFiles() { var currentDirectory = new DirectoryInfo(Directory.GetCurrentDirectory()); var filesFromPattern = currentDirectory.GetFiles(_commandFilePattern); return filesFromPattern.OrderBy(file => file.Name); } /// /// Gets the next command in the queue /// /// The next command in the queue, if present, null if no commands present protected override IEnumerable GetCommands() { foreach(var file in GetCommandFiles()) { // update the queue by reading the command file ReadCommandFile(file.FullName); while (_commands.Count != 0) { yield return _commands.Dequeue(); } } } /// /// Acknowledge a command that has been executed /// /// The command that was executed /// The result protected override void Acknowledge(ICommand command, CommandResultPacket commandResultPacket) { if (string.IsNullOrEmpty(command.Id)) { Log.Error($"FileCommandHandler.Acknowledge(): {Messages.FileCommandHandler.NullOrEmptyCommandId}"); return; } var resultFilePath = $"{_resultFileBaseName}-{command.Id}.json"; File.WriteAllText(resultFilePath, JsonConvert.SerializeObject(commandResultPacket)); } /// /// Reads the commnd file on disk and populates the queue with the commands /// private void ReadCommandFile(string commandFilePath) { Log.Trace($"FileCommandHandler.ReadCommandFile(): {Messages.FileCommandHandler.ReadingCommandFile(commandFilePath)}"); string contents = null; Exception exception = null; object deserialized = null; try { if (!File.Exists(commandFilePath)) { Log.Error($"FileCommandHandler.ReadCommandFile(): {Messages.FileCommandHandler.CommandFileDoesNotExist(commandFilePath)}"); return; } contents = File.ReadAllText(commandFilePath); deserialized = JsonConvert.DeserializeObject(contents, Settings); } catch (Exception err) { exception = err; } // remove the file when we're done reading it File.Delete(commandFilePath); // try it as an enumerable var enumerable = deserialized as IEnumerable; if (enumerable != null) { foreach (var command in enumerable) { _commands.Enqueue(command); } return; } // try it as a single command var item = deserialized as ICommand; if (item != null) { _commands.Enqueue(item); return; } var callbackCommand = TryGetCallbackCommand(contents); if (callbackCommand != null) { _commands.Enqueue(callbackCommand); return; } if (exception != null) { // if we are here we failed Log.Error(exception); } } } }