#include "ExecutableDictionarySource.h" #include #include #include #include #include #include #include #include #include #include #include #include "DictionarySourceFactory.h" #include "DictionarySourceHelpers.h" #include "DictionaryStructure.h" #include "registerDictionaries.h" namespace DB { static const UInt64 max_block_size = 8192; namespace ErrorCodes { extern const int LOGICAL_ERROR; extern const int DICTIONARY_ACCESS_DENIED; } namespace { /// Owns ShellCommand and calls wait for it. class ShellCommandOwningBlockInputStream : public OwningBlockInputStream { public: ShellCommandOwningBlockInputStream(const BlockInputStreamPtr & impl, std::unique_ptr own_) : OwningBlockInputStream(std::move(impl), std::move(own_)) { } void readSuffix() override { OwningBlockInputStream::readSuffix(); own->wait(); } }; } ExecutableDictionarySource::ExecutableDictionarySource( const DictionaryStructure & dict_struct_, const Poco::Util::AbstractConfiguration & config, const std::string & config_prefix, Block & sample_block_, const Context & context_) : log(&Logger::get("ExecutableDictionarySource")) , dict_struct{dict_struct_} , command{config.getString(config_prefix + ".command")} , update_field{config.getString(config_prefix + ".update_field", "")} , format{config.getString(config_prefix + ".format")} , sample_block{sample_block_} , context(context_) { } ExecutableDictionarySource::ExecutableDictionarySource(const ExecutableDictionarySource & other) : log(&Logger::get("ExecutableDictionarySource")) , update_time{other.update_time} , dict_struct{other.dict_struct} , command{other.command} , update_field{other.update_field} , format{other.format} , sample_block{other.sample_block} , context(other.context) { } BlockInputStreamPtr ExecutableDictionarySource::loadAll() { LOG_TRACE(log, "loadAll " + toString()); auto process = ShellCommand::execute(command); auto input_stream = context.getInputFormat(format, process->out, sample_block, max_block_size); return std::make_shared(input_stream, std::move(process)); } BlockInputStreamPtr ExecutableDictionarySource::loadUpdatedAll() { time_t new_update_time = time(nullptr); SCOPE_EXIT(update_time = new_update_time); std::string command_with_update_field = command; if (update_time) command_with_update_field += " " + update_field + " " + DB::toString(LocalDateTime(update_time - 1)); LOG_TRACE(log, "loadUpdatedAll " + command_with_update_field); auto process = ShellCommand::execute(command_with_update_field); auto input_stream = context.getInputFormat(format, process->out, sample_block, max_block_size); return std::make_shared(input_stream, std::move(process)); } namespace { /** A stream, that also runs and waits for background thread * (that will feed data into pipe to be read from the other side of the pipe). */ class BlockInputStreamWithBackgroundThread final : public IBlockInputStream { public: BlockInputStreamWithBackgroundThread( const BlockInputStreamPtr & stream_, std::unique_ptr && command_, std::packaged_task && task_) : stream{stream_}, command{std::move(command_)}, task(std::move(task_)), thread([this] { task(); command->in.close(); }) { children.push_back(stream); } ~BlockInputStreamWithBackgroundThread() override { if (thread.joinable()) { try { readSuffix(); } catch (...) { tryLogCurrentException(__PRETTY_FUNCTION__); } } } Block getHeader() const override { return stream->getHeader(); } private: Block readImpl() override { return stream->read(); } void readSuffix() override { IBlockInputStream::readSuffix(); if (!wait_called) { wait_called = true; command->wait(); } thread.join(); /// To rethrow an exception, if any. task.get_future().get(); } String getName() const override { return "WithBackgroundThread"; } BlockInputStreamPtr stream; std::unique_ptr command; std::packaged_task task; ThreadFromGlobalPool thread; bool wait_called = false; }; } BlockInputStreamPtr ExecutableDictionarySource::loadIds(const std::vector & ids) { LOG_TRACE(log, "loadIds " << toString() << " size = " << ids.size()); auto process = ShellCommand::execute(command); auto output_stream = context.getOutputFormat(format, process->in, sample_block); auto input_stream = context.getInputFormat(format, process->out, sample_block, max_block_size); return std::make_shared( input_stream, std::move(process), std::packaged_task([output_stream, &ids]() mutable { formatIDs(output_stream, ids); })); } BlockInputStreamPtr ExecutableDictionarySource::loadKeys(const Columns & key_columns, const std::vector & requested_rows) { LOG_TRACE(log, "loadKeys " << toString() << " size = " << requested_rows.size()); auto process = ShellCommand::execute(command); auto output_stream = context.getOutputFormat(format, process->in, sample_block); auto input_stream = context.getInputFormat(format, process->out, sample_block, max_block_size); return std::make_shared( input_stream, std::move(process), std::packaged_task([output_stream, key_columns, &requested_rows, this]() mutable { formatKeys(dict_struct, output_stream, key_columns, requested_rows); })); } bool ExecutableDictionarySource::isModified() const { return true; } bool ExecutableDictionarySource::supportsSelectiveLoad() const { return true; } bool ExecutableDictionarySource::hasUpdateField() const { return !update_field.empty(); } DictionarySourcePtr ExecutableDictionarySource::clone() const { return std::make_unique(*this); } std::string ExecutableDictionarySource::toString() const { return "Executable: " + command; } void registerDictionarySourceExecutable(DictionarySourceFactory & factory) { auto create_table_source = [=](const DictionaryStructure & dict_struct, const Poco::Util::AbstractConfiguration & config, const std::string & config_prefix, Block & sample_block, const Context & context, bool check_config) -> DictionarySourcePtr { if (dict_struct.has_expressions) throw Exception{"Dictionary source of type `executable` does not support attribute expressions", ErrorCodes::LOGICAL_ERROR}; /// Executable dictionaries may execute arbitrary commands. /// It's OK for dictionaries created by administrator from xml-file, but /// maybe dangerous for dictionaries created from DDL-queries. if (check_config) throw Exception("Dictionaries with Executable dictionary source is not allowed", ErrorCodes::DICTIONARY_ACCESS_DENIED); return std::make_unique( dict_struct, config, config_prefix + ".executable", sample_block, context); }; factory.registerSource("executable", create_table_source); } }