Merge pull request #484 from scratchcpp/metadata_api

Add metadata API

Author: adazem009

include/scratchcpp/iengine.h

@@ -358,6 +358,12 @@ class LIBSCRATCHCPP_EXPORT IEngine
 
         /*! Returns the map of scripts (each top level block has a Script object). */
         virtual const std::unordered_map<std::shared_ptr<Block>, std::shared_ptr<Script>> &scripts() const = 0;
+
+        /*! Returns the user agent of the last person to edit the project. */
+        virtual const std::string &userAgent() const = 0;
+
+        /*! Sets the user agent of the last person to edit the project. */
+        virtual void setUserAgent(const std::string &agent) = 0;
 };
 
 } // namespace libscratchcpp

src/engine/internal/engine.cpp

@@ -1430,6 +1430,16 @@ BlockSectionContainer *Engine::blockSectionContainer(IBlockSection *section) con
     return nullptr;
 }
 
+const std::string &Engine::userAgent() const
+{
+    return m_userAgent;
+}
+
+void Engine::setUserAgent(const std::string &agent)
+{
+    m_userAgent = agent;
+}
+
 void Engine::finalize()
 {
     m_eventLoopMutex.lock();

src/engine/internal/engine.h

@@ -157,6 +157,9 @@ class Engine : public IEngine
         BlockSectionContainer *blockSectionContainer(const std::string &opcode) const;
         BlockSectionContainer *blockSectionContainer(IBlockSection *section) const;
 
+        const std::string &userAgent() const override;
+        void setUserAgent(const std::string &agent) override;
+
         IClock *m_clock = nullptr;
 
     private:
@@ -227,6 +230,7 @@ class Engine : public IEngine
         std::unordered_map<std::shared_ptr<Block>, std::shared_ptr<Script>> m_scripts;
         std::vector<BlockFunc> m_functions;
         std::recursive_mutex m_eventLoopMutex;
+        std::string m_userAgent;
 
         std::unordered_map<Target *, std::vector<Script *>> m_greenFlagHats;
         std::unordered_map<Target *, std::vector<Script *>> m_backdropChangeHats;

src/internal/iprojectreader.h

@@ -35,6 +35,7 @@ class IProjectReader
         virtual const std::vector<std::shared_ptr<Broadcast>> &broadcasts() = 0;
         virtual const std::vector<std::shared_ptr<Monitor>> &monitors() = 0;
         virtual const std::vector<std::string> &extensions() = 0;
+        virtual const std::string &userAgent() const = 0;
 
     protected:
         virtual void printErr(const std::string &errStr) final { std::cerr << "Failed to read project: " << errStr << std::endl; }

src/internal/scratch3reader.cpp

@@ -453,6 +453,13 @@ bool Scratch3Reader::load()
         auto extensions = project["extensions"];
         for (auto extension : extensions)
             m_extensions.push_back(extension);
+
+        // meta
+        READER_STEP(step, "meta");
+        auto meta = project["meta"];
+        READER_STEP(step, "meta -> agent");
+        m_userAgent = meta["agent"];
+
     } catch (std::exception &e) {
         if (strcmp(step, "") == 0)
             printErr("could not parse project JSON file", e.what());
@@ -522,6 +529,11 @@ const std::vector<std::string> &Scratch3Reader::extensions()
     return m_extensions;
 }
 
+const std::string &Scratch3Reader::userAgent() const
+{
+    return m_userAgent;
+}
+
 void Scratch3Reader::read()
 {
     if (fileName().empty())

src/internal/scratch3reader.h

@@ -21,6 +21,7 @@ class Scratch3Reader : public IProjectReader
         const std::vector<std::shared_ptr<Broadcast>> &broadcasts() override;
         const std::vector<std::shared_ptr<Monitor>> &monitors() override;
         const std::vector<std::string> &extensions() override;
+        const std::string &userAgent() const override;
 
     private:
         void read();
@@ -30,6 +31,7 @@ class Scratch3Reader : public IProjectReader
         std::vector<std::shared_ptr<Broadcast>> m_broadcasts;
         std::vector<std::shared_ptr<Monitor>> m_monitors;
         std::vector<std::string> m_extensions;
+        std::string m_userAgent;
 };
 
 } // namespace libscratchcpp

src/project_p.cpp

@@ -129,6 +129,7 @@ bool ProjectPrivate::load()
     engine->setBroadcasts(reader->broadcasts());
     engine->setMonitors(reader->monitors());
     engine->setExtensions(reader->extensions());
+    engine->setUserAgent(reader->userAgent());
     engine->compile();
     return true;
 }

test/engine/engine_test.cpp

@@ -1767,6 +1767,15 @@ TEST(EngineTest, StopOtherScriptsInSprite)
     ASSERT_EQ(GET_VAR(stage, "l")->value().toInt(), 110);
 }
 
+TEST(EngineTest, UserAgent)
+{
+    Engine engine;
+    ASSERT_TRUE(engine.userAgent().empty());
+
+    engine.setUserAgent("test");
+    ASSERT_EQ(engine.userAgent(), "test");
+}
+
 TEST(EngineTest, NoCrashAfterStop)
 {
     // Regtest for #186

test/load_project/load_project_test.cpp

@@ -72,6 +72,8 @@ TEST(LoadProjectTest, EmptyProject)
                 backdrop->dataSize()),
             0);
 
+        ASSERT_EQ(engine->userAgent(), "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Scratux/1.4.1 Chrome/76.0.3809.146 Electron/6.1.7 Safari/537.36");
+
         i++;
     }
 }
@@ -632,6 +634,9 @@ TEST(LoadProjectTest, LoadTestProject)
         ASSERT_EQ(monitor->y(), 280);
         ASSERT_TRUE(monitor->visible());
 
+        // User agent
+        ASSERT_TRUE(engine->userAgent().empty());
+
         i++;
     }
 }

test/mocks/enginemock.h

@@ -134,6 +134,9 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, setExtensions, (const std::vector<std::string> &), (override));
 
         MOCK_METHOD(const ScriptMap &, scripts, (), (const, override));
+
+        MOCK_METHOD(const std::string &, userAgent, (), (const, override));
+        MOCK_METHOD(void, setUserAgent, (const std::string &), (override));
 };
 
 } // namespace libscratchcpp