Updated version 5.0 from 'upstream/5.0'

with Debian dir 2ae31d03ffb1d79153a692af23c7b2b097cc4b2b

1 files changed, 71 insertions, 0 deletions

diff --git a/src/xmpp/adhoc_commands_handler.hpp b/src/xmpp/adhoc_commands_handler.hpp
new file mode 100644
index 0000000..e37d913
--- /dev/null
+++ b/src/xmpp/adhoc_commands_handler.hpp
@@ -0,0 +1,71 @@
+#pragma once
+
+/**
+ * Manage a list of available AdhocCommands and the list of ongoing
+ * AdhocCommandSessions.
+ */
+
+#include <xmpp/adhoc_command.hpp>
+#include <xmpp/xmpp_stanza.hpp>
+
+#include <utility>
+#include <string>
+#include <map>
+
+class AdhocCommandsHandler
+{
+public:
+  explicit AdhocCommandsHandler(XmppComponent& xmpp_component):
+    xmpp_component(xmpp_component),
+    commands{}
+  { }
+  ~AdhocCommandsHandler() = default;
+
+  AdhocCommandsHandler(const AdhocCommandsHandler&) = delete;
+  AdhocCommandsHandler(AdhocCommandsHandler&&) = delete;
+  AdhocCommandsHandler& operator=(const AdhocCommandsHandler&) = delete;
+  AdhocCommandsHandler& operator=(AdhocCommandsHandler&&) = delete;
+
+  /**
+   * Returns the list of available commands.
+   */
+  const std::map<const std::string, const AdhocCommand>& get_commands() const;
+  /**
+   * Add a command into the list, associated with the given name
+   */
+  void add_command(std::string name, AdhocCommand command);
+  /**
+   * Find the requested command, create a new session or use an existing
+   * one, and process the request (provide a new form, an error, or a
+   * result).
+   *
+   * Returns a (moved) XmlNode that will be inserted in the iq response. It
+   * should be a <command/> node containing one or more useful children. If
+   * it contains an <error/> node, the iq response will have an error type.
+   *
+   * Takes a copy of the <command/> node so we can actually edit it and use
+   * it as our return value.
+   */
+  XmlNode handle_request(const std::string& executor_jid, const std::string& to, XmlNode command_node);
+  /**
+   * Remove the session from the list. This is done to avoid filling the
+   * memory with waiting session (for example due to a client that starts
+   * multi-steps command but never finishes them).
+   */
+  void remove_session(const std::string& session_id, const std::string& initiator_jid);
+private:
+  /**
+   * To access basically anything in the gateway.
+   */
+  XmppComponent& xmpp_component;
+  /**
+   * The list of all available commands.
+   */
+  std::map<const std::string, const AdhocCommand> commands;
+  /**
+   * The list of all currently on-going commands.
+   *
+   * Of the form: {{session_id, owner_jid}, session}.
+   */
+  std::map<std::pair<const std::string, const std::string>, AdhocSession> sessions;
+};