Merge pull request #3069 from B3n30/announce_room_webservice

Announce room webservice

src/common/CMakeLists.txt

@@ -26,6 +26,7 @@ configure_file("${CMAKE_CURRENT_SOURCE_DIR}/scm_rev.cpp.in" "${CMAKE_CURRENT_SOU
 
 add_library(common STATIC
     alignment.h
+    announce_multiplayer_room.h
     assert.h
     bit_field.h
     bit_set.h

src/common/announce_multiplayer_room.h

@@ -0,0 +1,143 @@
+// Copyright 2017 Citra Emulator Project
+// Licensed under GPLv2 or any later version
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include <array>
+#include <functional>
+#include <future>
+#include <string>
+#include <vector>
+#include "common/common_types.h"
+
+namespace Common {
+struct WebResult {
+    enum class Code : u32 {
+        Success,
+        InvalidURL,
+        CredentialsMissing,
+        CprError,
+        HttpError,
+        WrongContent,
+        NoWebservice,
+    };
+    Code result_code;
+    std::string result_string;
+};
+} // namespace Common
+
+namespace AnnounceMultiplayerRoom {
+
+using MacAddress = std::array<u8, 6>;
+
+struct Room {
+    struct Member {
+        std::string name;
+        MacAddress mac_address;
+        std::string game_name;
+        u64 game_id;
+    };
+    std::string name;
+    std::string UID;
+    std::string owner;
+    std::string ip;
+    u16 port;
+    u32 max_player;
+    u32 net_version;
+    bool has_password;
+    std::string preferred_game;
+    u64 preferred_game_id;
+
+    std::vector<Member> members;
+};
+using RoomList = std::vector<Room>;
+
+/**
+ * A AnnounceMultiplayerRoom interface class. A backend to submit/get to/from a web service should
+ * implement this interface.
+ */
+class Backend : NonCopyable {
+public:
+    virtual ~Backend() = default;
+
+    /**
+     * Sets the Information that gets used for the announce
+     * @param uid The Id of the room
+     * @param name The name of the room
+     * @param port The port of the room
+     * @param net_version The version of the libNetwork that gets used
+     * @param has_password True if the room is passowrd protected
+     * @param preferred_game The preferred game of the room
+     * @param preferred_game_id The title id of the preferred game
+     */
+    virtual void SetRoomInformation(const std::string& uid, const std::string& name, const u16 port,
+                                    const u32 max_player, const u32 net_version,
+                                    const bool has_password, const std::string& preferred_game,
+                                    const u64 preferred_game_id) = 0;
+    /**
+     * Adds a player information to the data that gets announced
+     * @param nickname The nickname of the player
+     * @param mac_address The MAC Address of the player
+     * @param game_id The title id of the game the player plays
+     * @param game_name The name of the game the player plays
+     */
+    virtual void AddPlayer(const std::string& nickname, const MacAddress& mac_address,
+                           const u64 game_id, const std::string& game_name) = 0;
+
+    /**
+     * Send the data to the announce service
+     * @result The result of the announce attempt
+     */
+    virtual std::future<Common::WebResult> Announce() = 0;
+
+    /**
+     * Empties the stored players
+     */
+    virtual void ClearPlayers() = 0;
+
+    /**
+     * Get the room information from the announce service
+     * @param func a function that gets exectued when the get finished.
+     * Can be used as a callback
+     * @result A list of all rooms the announce service has
+     */
+    virtual std::future<RoomList> GetRoomList(std::function<void()> func) = 0;
+
+    /**
+     * Sends a delete message to the announce service
+     */
+    virtual void Delete() = 0;
+};
+
+/**
+ * Empty implementation of AnnounceMultiplayerRoom interface that drops all data. Used when a
+ * functional backend implementation is not available.
+ */
+class NullBackend : public Backend {
+public:
+    ~NullBackend() = default;
+    void SetRoomInformation(const std::string& /*uid*/, const std::string& /*name*/,
+                            const u16 /*port*/, const u32 /*max_player*/, const u32 /*net_version*/,
+                            const bool /*has_password*/, const std::string& /*preferred_game*/,
+                            const u64 /*preferred_game_id*/) override {}
+    void AddPlayer(const std::string& /*nickname*/, const MacAddress& /*mac_address*/,
+                   const u64 /*game_id*/, const std::string& /*game_name*/) override {}
+    std::future<Common::WebResult> Announce() override {
+        return std::async(std::launch::deferred, []() {
+            return Common::WebResult{Common::WebResult::Code::NoWebservice,
+                                     "WebService is missing"};
+        });
+    }
+    void ClearPlayers() override {}
+    std::future<RoomList> GetRoomList(std::function<void()> func) override {
+        return std::async(std::launch::deferred, [func]() {
+            func();
+            return RoomList{};
+        });
+    }
+
+    void Delete() override {}
+};
+
+} // namespace AnnounceMultiplayerRoom