Libraries: Move to Userland/Libraries/

Userland/Libraries/LibDesktop/AppFile.cpp

@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2020, Linus Groh <mail@linusgroh.de>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <AK/Function.h>
+#include <AK/Vector.h>
+#include <LibCore/ConfigFile.h>
+#include <LibCore/DirIterator.h>
+#include <LibDesktop/AppFile.h>
+
+namespace Desktop {
+
+NonnullRefPtr<AppFile> AppFile::get_for_app(const StringView& app_name)
+{
+    auto path = String::formatted("{}/{}.af", APP_FILES_DIRECTORY, app_name);
+    return open(path);
+}
+
+NonnullRefPtr<AppFile> AppFile::open(const StringView& path)
+{
+    return adopt(*new AppFile(path));
+}
+
+void AppFile::for_each(Function<void(NonnullRefPtr<AppFile>)> callback, const StringView& directory)
+{
+    Core::DirIterator di(directory, Core::DirIterator::SkipDots);
+    if (di.has_error())
+        return;
+    while (di.has_next()) {
+        auto name = di.next_path();
+        if (!name.ends_with(".af"))
+            continue;
+        auto path = String::formatted("{}/{}", directory, name);
+        auto af = AppFile::open(path);
+        if (!af->is_valid())
+            continue;
+        callback(af);
+    }
+}
+
+AppFile::AppFile(const StringView& path)
+    : m_config(Core::ConfigFile::open(path))
+    , m_valid(validate())
+{
+}
+
+AppFile::~AppFile()
+{
+}
+
+bool AppFile::validate() const
+{
+    if (m_config->read_entry("App", "Name").trim_whitespace().is_empty())
+        return false;
+    if (m_config->read_entry("App", "Executable").trim_whitespace().is_empty())
+        return false;
+    return true;
+}
+
+String AppFile::name() const
+{
+    auto name = m_config->read_entry("App", "Name").trim_whitespace();
+    ASSERT(!name.is_empty());
+    return name;
+}
+
+String AppFile::executable() const
+{
+    auto executable = m_config->read_entry("App", "Executable").trim_whitespace();
+    ASSERT(!executable.is_empty());
+    return executable;
+}
+
+String AppFile::category() const
+{
+    return m_config->read_entry("App", "Category").trim_whitespace();
+}
+
+Vector<String> AppFile::launcher_file_types() const
+{
+    Vector<String> file_types;
+    for (auto& entry : m_config->read_entry("Launcher", "FileTypes").split(',')) {
+        entry = entry.trim_whitespace();
+        if (!entry.is_empty())
+            file_types.append(entry);
+    }
+    return file_types;
+}
+
+Vector<String> AppFile::launcher_protocols() const
+{
+    Vector<String> protocols;
+    for (auto& entry : m_config->read_entry("Launcher", "Protocols").split(',')) {
+        entry = entry.trim_whitespace();
+        if (!entry.is_empty())
+            protocols.append(entry);
+    }
+    return protocols;
+}
+
+}

Userland/Libraries/LibDesktop/AppFile.h

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2020, Linus Groh <mail@linusgroh.de>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <LibCore/ConfigFile.h>
+#include <LibGUI/FileIconProvider.h>
+#include <LibGUI/Icon.h>
+
+namespace Desktop {
+
+class AppFile : public RefCounted<AppFile> {
+public:
+    static constexpr const char* APP_FILES_DIRECTORY = "/res/apps";
+    static NonnullRefPtr<AppFile> get_for_app(const StringView& app_name);
+    static NonnullRefPtr<AppFile> open(const StringView& path);
+    static void for_each(Function<void(NonnullRefPtr<AppFile>)>, const StringView& directory = APP_FILES_DIRECTORY);
+    ~AppFile();
+
+    bool is_valid() const { return m_valid; }
+    String file_name() const { return m_config->file_name(); }
+
+    String name() const;
+    String executable() const;
+    String category() const;
+    Vector<String> launcher_file_types() const;
+    Vector<String> launcher_protocols() const;
+
+    GUI::Icon icon() const { return GUI::FileIconProvider::icon_for_path(executable()); };
+
+private:
+    explicit AppFile(const StringView& path);
+
+    bool validate() const;
+
+    RefPtr<Core::ConfigFile> m_config;
+    bool m_valid { false };
+};
+
+}

Userland/Libraries/LibDesktop/CMakeLists.txt

@@ -0,0 +1,12 @@
+set(SOURCES
+    AppFile.cpp
+    Launcher.cpp
+)
+
+set(GENERATED_SOURCES
+    ../../Services/LaunchServer/LaunchClientEndpoint.h
+    ../../Services/LaunchServer/LaunchServerEndpoint.h
+)
+
+serenity_lib(LibDesktop desktop)
+target_link_libraries(LibDesktop LibCore LibIPC LibGUI)

Userland/Libraries/LibDesktop/Launcher.cpp

@@ -0,0 +1,147 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <AK/JsonObject.h>
+#include <AK/URL.h>
+#include <LaunchServer/LaunchClientEndpoint.h>
+#include <LaunchServer/LaunchServerEndpoint.h>
+#include <LibDesktop/Launcher.h>
+#include <LibIPC/ServerConnection.h>
+#include <stdlib.h>
+
+namespace Desktop {
+
+auto Launcher::Details::from_details_str(const String& details_str) -> NonnullRefPtr<Details>
+{
+    auto details = adopt(*new Details);
+    auto json = JsonValue::from_string(details_str);
+    ASSERT(json.has_value());
+    auto obj = json.value().as_object();
+    details->executable = obj.get("executable").to_string();
+    details->name = obj.get("name").to_string();
+    if (auto type_value = obj.get_ptr("type")) {
+        auto type_str = type_value->to_string();
+        if (type_str == "app")
+            details->launcher_type = LauncherType::Application;
+        else if (type_str == "userpreferred")
+            details->launcher_type = LauncherType::UserPreferred;
+        else if (type_str == "userdefault")
+            details->launcher_type = LauncherType::UserDefault;
+    }
+    return details;
+}
+
+class LaunchServerConnection : public IPC::ServerConnection<LaunchClientEndpoint, LaunchServerEndpoint>
+    , public LaunchClientEndpoint {
+    C_OBJECT(LaunchServerConnection)
+public:
+    virtual void handshake() override
+    {
+        auto response = send_sync<Messages::LaunchServer::Greet>();
+        set_my_client_id(response->client_id());
+    }
+
+private:
+    LaunchServerConnection()
+        : IPC::ServerConnection<LaunchClientEndpoint, LaunchServerEndpoint>(*this, "/tmp/portal/launch")
+    {
+    }
+    virtual void handle(const Messages::LaunchClient::Dummy&) override { }
+};
+
+static LaunchServerConnection& connection()
+{
+    static auto connection = LaunchServerConnection::construct();
+    return connection;
+}
+
+bool Launcher::add_allowed_url(const URL& url)
+{
+    auto response = connection().send_sync<Messages::LaunchServer::AddAllowedURL>(url);
+    if (!response) {
+        dbgln("Launcher::add_allowed_url: Failed");
+        return false;
+    }
+    return true;
+}
+
+bool Launcher::add_allowed_handler_with_any_url(const String& handler)
+{
+    auto response = connection().send_sync<Messages::LaunchServer::AddAllowedHandlerWithAnyURL>(handler);
+    if (!response) {
+        dbgln("Launcher::add_allowed_handler_with_any_url: Failed");
+        return false;
+    }
+    return true;
+}
+
+bool Launcher::add_allowed_handler_with_only_specific_urls(const String& handler, const Vector<URL>& urls)
+{
+    auto response = connection().send_sync<Messages::LaunchServer::AddAllowedHandlerWithOnlySpecificURLs>(handler, urls);
+    if (!response) {
+        dbgln("Launcher::add_allowed_handler_with_only_specific_urls: Failed");
+        return false;
+    }
+    return true;
+}
+
+bool Launcher::seal_allowlist()
+{
+    auto response = connection().send_sync<Messages::LaunchServer::SealAllowlist>();
+    if (!response) {
+        dbgln("Launcher::seal_allowlist: Failed");
+        return false;
+    }
+    return true;
+}
+
+bool Launcher::open(const URL& url, const String& handler_name)
+{
+    return connection().send_sync<Messages::LaunchServer::OpenURL>(url, handler_name)->response();
+}
+
+bool Launcher::open(const URL& url, const Details& details)
+{
+    ASSERT(details.launcher_type != LauncherType::Application); // Launcher should not be used to execute arbitrary applications
+    return open(url, details.executable);
+}
+
+Vector<String> Launcher::get_handlers_for_url(const URL& url)
+{
+    return connection().send_sync<Messages::LaunchServer::GetHandlersForURL>(url.to_string())->handlers();
+}
+
+auto Launcher::get_handlers_with_details_for_url(const URL& url) -> NonnullRefPtrVector<Details>
+{
+    auto details = connection().send_sync<Messages::LaunchServer::GetHandlersWithDetailsForURL>(url.to_string())->handlers_details();
+    NonnullRefPtrVector<Details> handlers_with_details;
+    for (auto& value : details) {
+        handlers_with_details.append(Details::from_details_str(value));
+    }
+    return handlers_with_details;
+}
+
+}

Userland/Libraries/LibDesktop/Launcher.h

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/Forward.h>
+#include <AK/HashMap.h>
+#include <AK/NonnullRefPtrVector.h>
+#include <AK/RefCounted.h>
+#include <AK/String.h>
+
+namespace Desktop {
+
+class Launcher {
+public:
+    enum class LauncherType {
+        Default = 0,
+        Application,
+        UserPreferred,
+        UserDefault
+    };
+
+    struct Details : public RefCounted<Details> {
+        String name;
+        String executable;
+        LauncherType launcher_type { LauncherType::Default };
+
+        static NonnullRefPtr<Details> from_details_str(const String&);
+    };
+
+    [[nodiscard]] static bool add_allowed_url(const URL&);
+    [[nodiscard]] static bool add_allowed_handler_with_any_url(const String& handler);
+    [[nodiscard]] static bool add_allowed_handler_with_only_specific_urls(const String& handler, const Vector<URL>&);
+    [[nodiscard]] static bool seal_allowlist();
+    static bool open(const URL&, const String& handler_name = {});
+    static bool open(const URL&, const Details& details);
+    static Vector<String> get_handlers_for_url(const URL&);
+    static NonnullRefPtrVector<Details> get_handlers_with_details_for_url(const URL&);
+};
+
+}