lomiri.lomiri-system-settings-unwrapped: init at 1.0.2

From 8e21cf46551091c884014985d3e0dd9704d6dc04 Mon Sep 17 00:00:00 2001

From: OPNA2608 <opna2608@protonmail.com>

Date: Wed, 14 Feb 2024 16:00:24 +0100

Subject: [PATCH] Support wrapping for Nixpkgs

---

 src/CMakeLists.txt   | 24 +++++++++++++++++++-----

 src/main.cpp         |  8 +++++---

 src/plugin.cpp       | 19 +++++++++++++++++--

 tests/CMakeLists.txt | 18 ++++++++++++++----

 4 files changed, 55 insertions(+), 14 deletions(-)

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt

index cd3131d0..fcd78bdf 100644

--- a/src/CMakeLists.txt

+++ b/src/CMakeLists.txt

@@ -1,13 +1,27 @@

 include_directories(${GLIB_INCLUDE_DIRS})

-add_definitions(-DI18N_DIRECTORY="${CMAKE_INSTALL_FULL_LOCALEDIR}")

 add_definitions(-DI18N_DOMAIN="lomiri-system-settings")

-add_definitions(-DPLUGIN_PRIVATE_MODULE_DIR="${PLUGIN_PRIVATE_MODULE_DIR}")

+

+add_definitions(-DNIX_FALLBACK_PREFIX="${CMAKE_INSTALL_PREFIX}")

+

+set(I18N_DIRECTORY "${CMAKE_INSTALL_FULL_LOCALEDIR}")

+

+list(APPEND NIX_LOCATION_VARIABLES

+    I18N_DIRECTORY

+    PLUGIN_PRIVATE_MODULE_DIR

+    PLUGIN_MANIFEST_DIR

+    PLUGIN_QML_DIR

+    PLUGIN_MODULE_DIR

+)

+

+foreach(locvar IN LISTS NIX_LOCATION_VARIABLES)

+    string(REPLACE "${CMAKE_INSTALL_PREFIX}" "" NIX_${locvar}_RELATIVE "${${locvar}}")

+    add_definitions(-D${locvar}=do_not_use_me)

+    add_definitions(-DNIX_${locvar}_RELATIVE="${NIX_${locvar}_RELATIVE}")

+endforeach()

+

 add_definitions(-DMANIFEST_DIR="${MANIFEST_DIR}")

-add_definitions(-DPLUGIN_MANIFEST_DIR="${PLUGIN_MANIFEST_DIR}")

 add_definitions(-DQML_DIR="${QML_DIR}")

-add_definitions(-DPLUGIN_QML_DIR="${PLUGIN_QML_DIR}")

-add_definitions(-DPLUGIN_MODULE_DIR="${PLUGIN_MODULE_DIR}")

 add_subdirectory(SystemSettings)

diff --git a/src/main.cpp b/src/main.cpp

index 64441da3..cfcabe42 100644

--- a/src/main.cpp

+++ b/src/main.cpp

@@ -42,6 +42,8 @@ int main(int argc, char **argv)

     QByteArray mountPoint = qEnvironmentVariableIsSet("SNAP") ? qgetenv("SNAP") : "";

     bool isSnap = !mountPoint.isEmpty();

+    QByteArray dataPrefix = qEnvironmentVariableIsSet("NIX_LSS_PREFIX") ? qgetenv("NIX_LSS_PREFIX") : NIX_FALLBACK_PREFIX;

+

     // Ensure printing environment is correct.

     qputenv("QT_PRINTER_MODULE", "cupsprintersupport");

@@ -78,12 +80,12 @@ int main(int argc, char **argv)

     qmlRegisterType<LomiriSystemSettings::PluginManager>("SystemSettings", 1, 0, "PluginManager");

     view.engine()->rootContext()->setContextProperty("Utilities", &utils);

     view.setResizeMode(QQuickView::SizeRootObjectToView);

-    view.engine()->addImportPath(mountPoint + PLUGIN_PRIVATE_MODULE_DIR);

-    view.engine()->addImportPath(mountPoint + PLUGIN_QML_DIR);

+    view.engine()->addImportPath(mountPoint + dataPrefix + "/" + NIX_PLUGIN_PRIVATE_MODULE_DIR_RELATIVE);

+    view.engine()->addImportPath(mountPoint + dataPrefix + "/" + NIX_PLUGIN_QML_DIR_RELATIVE);

     view.rootContext()->setContextProperty("defaultPlugin", defaultPlugin);

     view.rootContext()->setContextProperty("mountPoint", mountPoint);

     view.rootContext()->setContextProperty("isSnap", isSnap);

-    view.rootContext()->setContextProperty("i18nDirectory", mountPoint + I18N_DIRECTORY);

+    view.rootContext()->setContextProperty("i18nDirectory", mountPoint + dataPrefix + "/" + NIX_I18N_DIRECTORY_RELATIVE);

     view.rootContext()->setContextProperty("pluginOptions", pluginOptions);

     view.rootContext()->setContextProperty("view", &view);

     view.setSource(QUrl("qrc:/qml/MainWindow.qml"));

diff --git a/src/plugin.cpp b/src/plugin.cpp

index 133821af..6a1a152c 100644

--- a/src/plugin.cpp

+++ b/src/plugin.cpp

@@ -36,9 +36,16 @@

 #include <LomiriSystemSettings/ItemBase>

 #include <LomiriSystemSettings/PluginInterface>

+#include <libintl.h>

+

 using namespace LomiriSystemSettings;

-static const QLatin1String pluginModuleDir{PLUGIN_MODULE_DIR};

+const QLatin1String getWrapperPrefix()

+{

+    const QLatin1String pluginWrapperPrefix {qEnvironmentVariableIsSet("NIX_LSS_PREFIX") ? qgetenv("NIX_LSS_PREFIX") : NIX_FALLBACK_PREFIX};

+    return pluginWrapperPrefix;

+}

+static const QLatin1String pluginModuleDirRelative{NIX_PLUGIN_MODULE_DIR_RELATIVE};

 static const QLatin1String pluginQmlDir{QML_DIR};

 namespace LomiriSystemSettings {

@@ -89,6 +96,11 @@ PluginPrivate::PluginPrivate(Plugin *q, const QFileInfo &manifest):

     m_data = json.toVariant().toMap();

     m_dataPath = manifest.absolutePath();

+

+    QString textDomain = m_data.value(keyTranslations).toString();

+    QString textDomainDir = QString("%1/%2")

+        .arg(getWrapperPrefix()).arg(NIX_I18N_DIRECTORY_RELATIVE);

+    bindtextdomain(qPrintable(textDomain), qPrintable(textDomainDir));

 }

 bool PluginPrivate::ensureLoaded() const

@@ -110,8 +122,11 @@ bool PluginPrivate::ensureLoaded() const

         ctx->contextProperty("mountPoint").value<QByteArray>() :

         "";

+    QString wrapperModuleDir = QString("%1/%2")

+        .arg(getWrapperPrefix()).arg(pluginModuleDirRelative);

+

     QString name = QString("%1%2/lib%3.so")

-        .arg(mountPoint).arg(pluginModuleDir).arg(plugin);

+        .arg(mountPoint).arg(wrapperModuleDir).arg(plugin);

     m_loader.setFileName(name);

     if (Q_UNLIKELY(!m_loader.load())) {

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt

index c10b2e2d..a998b641 100644

--- a/tests/CMakeLists.txt

+++ b/tests/CMakeLists.txt

@@ -9,13 +9,23 @@ include_directories(

 set(XVFB_CMD xvfb-run -a -s "-screen 0 640x480x24")

 add_definitions(-DI18N_DOMAIN="lomiri-system-settings")

-add_definitions(-DPLUGIN_PRIVATE_MODULE_DIR="${PLUGIN_PRIVATE_MODULE_DIR}")

-add_definitions(-DPLUGIN_MODULE_DIR="${CMAKE_CURRENT_BINARY_DIR}")

+

+add_definitions(-DNIX_FALLBACK_PREFIX="${CMAKE_CURRENT_BINARY_DIR}")

+

+add_definitions(-DI18N_DIRECTORY=do_not_use_me)

+add_definitions(-DNIX_I18N_DIRECTORY_RELATIVE="")

+add_definitions(-DPLUGIN_PRIVATE_MODULE_DIR=do_not_use_me)

+add_definitions(-DNIX_PLUGIN_PRIVATE_MODULE_DIR_RELATIVE="")

+add_definitions(-DPLUGIN_MODULE_DIR=do_not_use_me)

+add_definitions(-DNIX_PLUGIN_MODULE_DIR_RELATIVE="")

+add_definitions(-DPLUGIN_MANIFEST_DIR=do_not_use_me)

+add_definitions(-DNIX_PLUGIN_MANIFEST_DIR_RELATIVE="../../tests/data")

+add_definitions(-DPLUGIN_QML_DIR=do_not_use_me)

+add_definitions(-DNIX_PLUGIN_QML_DIR_RELATIVE="")

+

 add_definitions(-DMANIFEST_DIR="data")

-add_definitions(-DPLUGIN_MANIFEST_DIR="${CMAKE_CURRENT_SOURCE_DIR}/data")

 add_definitions(-DQML_TEST_DIR="${CMAKE_CURRENT_SOURCE_DIR}")

 add_definitions(-DQML_DIR="${CMAKE_CURRENT_BINARY_DIR}")

-add_definitions(-DPLUGIN_QML_DIR="${CMAKE_CURRENT_BINARY_DIR}")

 add_definitions(-DSYSTEM_IMAGE_DBUS_TEMPLATE="${CMAKE_SOURCE_DIR}/tests/autopilot/lomiri_system_settings/tests/systemimage.py")

 add_library(test-plugin SHARED test-plugin.cpp test-plugin.h)

-- 

2.42.0

{ stdenv

, lib

, fetchFromGitLab

, fetchpatch

, gitUpdater

, testers

, accountsservice

, ayatana-indicator-datetime

, cmake

, cmake-extras

, content-hub

, dbus

, deviceinfo

, geonames

, gettext

, glib

, gnome-desktop

, gsettings-qt

, gtk3

, icu

, intltool

, json-glib

, libqofono

, libqtdbustest

, libqtdbusmock

, lomiri-indicator-network

, lomiri-schemas

, lomiri-settings-components

, lomiri-ui-toolkit

, maliit-keyboard

, pkg-config

, python3

, qmenumodel

, qtbase

, qtdeclarative

, qtmultimedia

, ubports-click

, upower

, validatePkgConfig

, wrapGAppsHook

, wrapQtAppsHook

, xvfb-run

}:

stdenv.mkDerivation (finalAttrs: {

  pname = "lomiri-system-settings-unwrapped";

  version = "1.0.2";

  src = fetchFromGitLab {

    owner = "ubports";

    repo = "development/core/lomiri-system-settings";

    rev = finalAttrs.version;

    hash = "sha256-gi6ZujIs0AEDLsqcTNlRNSS8SyqEU6q0+xaDf55XwuM=";

  };

  outputs = [

    "out"

    "dev"

  ];

  patches = [

    # Remove when https://gitlab.com/ubports/development/core/lomiri-system-settings/-/merge_requests/433 merged & in release

    (fetchpatch {

      name = "0001-lomiri-system-settings-plugins-language-Fix-linking-against-accountsservice.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/commit/75763ae2f9669f5f7f29aec3566606e6f6cb7478.patch";

      hash = "sha256-2CE0yizkaz93kK82DhaaFjKmGnMoaikrwFj4k7RN534=";

    })

    # Remove when https://gitlab.com/ubports/development/core/lomiri-system-settings/-/merge_requests/434 merged & in release

    (fetchpatch {

      name = "0002-lomiri-system-settings-GNUInstallDirs-and-fix-absolute-path-handling.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/commit/93ee84423f3677a608ef73addcd3ddcbe7dc1d32.patch";

      hash = "sha256-lSKAhtE3oSSv7USvDbbcfBZWAtWMmuKneWawKQABIiM=";

    })

    # Remove when version > 1.0.2

    (fetchpatch {

      name = "0003-lomiri-system-settings-Use-GSettings-for-DT2W-value.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/commit/29e2533efcac23e41b083b11c540c9221b71de7e.patch";

      hash = "sha256-d52d/b1ZdafaqhOljCg5E3I12XWtFAfG4rmn8CYngB4=";

    })

  ] ++ lib.optionals (lib.strings.versionOlder python3.pkgs.python-dbusmock.version "0.30.1") [

    # Makes tests work with newer dbusmock, but breaks with much-newer dbusmock

    # See for details:

    # - https://gitlab.com/ubports/development/core/lomiri-system-settings/-/merge_requests/354

    # - https://gitlab.com/ubports/development/core/lomiri-system-settings/-/merge_requests/426

    # Remove/adjust based on merges & next LSS release, and packaged version of dbusmock

    (fetchpatch {

      name = "0101-lomiri-system-settings-Pass-missing-parameters-to-dbusmock.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/commit/b9aacd88e3789dbb7578f32b31ad5b239db227a2.patch";

      hash = "sha256-jf+jMc+6QxONavlX5C9UZyX23jb6fZnYV8mWFyQGGbU=";

    })

    (fetchpatch {

      name = "0102-lomiri-system-settings-Fix-BT-plugin-testIsPaired.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/commit/e39b9728e18635413f07f9c9f6ddc73208260b2a.patch";

      hash = "sha256-YUtdlQ2XcanXzsxD40SbML7fSxG75yMKz/XnaQN9YP8=";

    })

    (fetchpatch {

      name = "0103-lomiri-system-settings-Fix-BT-plugin-testGet-IconName-Type.patch";

      url = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/commit/9ad5d9324945f06f764d3a963dbfc7bccefe574b.patch";

      # Merge conflict, relevant change handled further down

      excludes = [ "CMakeLists.txt" ];

      hash = "sha256-QCgkVos9Q9/8jd25rqzdEKdnBw0Re47X7B9nLH8QOQU=";

    })

  ] ++ [

    ./2000-Support-wrapping-for-Nixpkgs.patch

    # Make it work with regular accountsservice

    # https://gitlab.com/ubports/development/core/lomiri-system-settings/-/issues/341

    (fetchpatch {

      name = "2001-lomiri-system-settings-disable-current-language-switching.patch";

      url = "https://sources.debian.org/data/main/l/lomiri-system-settings/1.0.1-2/debian/patches/2001_disable-current-language-switching.patch";

      hash = "sha256-ZOFYwxS8s6+qMFw8xDCBv3nLBOBm86m9d/VhbpOjamY=";

    })

  ];

  postPatch = ''

    substituteInPlace CMakeLists.txt \

      --replace-fail "\''${CMAKE_INSTALL_LIBDIR}/qt5/qml" "\''${CMAKE_INSTALL_PREFIX}/${qtbase.qtQmlPrefix}" \

    # Port from lomiri-keyboard to maliit-keyboard

    substituteInPlace plugins/language/CMakeLists.txt \

      --replace-fail 'LOMIRI_KEYBOARD_PLUGIN_PATH=\"''${CMAKE_INSTALL_FULL_LIBDIR}/lomiri-keyboard/plugins\"' 'LOMIRI_KEYBOARD_PLUGIN_PATH=\"${lib.getLib maliit-keyboard}/lib/maliit/keyboard2/languages\"'

    substituteInPlace plugins/language/{PageComponent,SpellChecking,ThemeValues}.qml plugins/language/onscreenkeyboard-plugin.cpp plugins/sound/PageComponent.qml \

      --replace-fail 'com.lomiri.keyboard.maliit' 'org.maliit.keyboard.maliit'

    # Decide which entries should be visible based on the current system

    substituteInPlace plugins/*/*.settings \

      --replace-warn '/etc' '/run/current-system/sw/etc'

    # Don't use absolute paths in desktop file

    substituteInPlace lomiri-system-settings.desktop.in.in \

      --replace-fail 'Icon=@SETTINGS_SHARE_DIR@/system-settings.svg' 'Icon=lomiri-system-settings' \

      --replace-fail 'X-Lomiri-Splash-Image=@SETTINGS_SHARE_DIR@/system-settings-app-splash.svg' 'X-Lomiri-Splash-Image=lomiri-app-launch/splash/lomiri-system-settings.svg' \

      --replace-fail 'X-Screenshot=@SETTINGS_SHARE_DIR@/screenshot.png' 'X-Screenshot=lomiri-app-launch/screenshot/lomiri-system-settings.png'

  '';

  strictDeps = true;

  nativeBuildInputs = [

    cmake

    gettext

    glib # glib-compile-schemas

    intltool

    pkg-config

    validatePkgConfig

  ];

  buildInputs = [

    accountsservice

    cmake-extras

    deviceinfo

    geonames

    gnome-desktop

    gsettings-qt

    gtk3

    icu

    json-glib

    qtbase

    ubports-click

    upower

  ];

  # QML components and schemas the wrapper needs

  propagatedBuildInputs = [

    ayatana-indicator-datetime

    content-hub

    libqofono

    lomiri-indicator-network

    lomiri-schemas

    lomiri-settings-components

    lomiri-ui-toolkit

    maliit-keyboard

    qmenumodel

    qtdeclarative

    qtmultimedia

  ];

  nativeCheckInputs = [

    dbus

    (python3.withPackages (ps: with ps; [

      python-dbusmock

    ]))

    xvfb-run

  ];

  checkInputs = [

    libqtdbustest

    libqtdbusmock

  ];

  # Not wrapping in this derivation

  dontWrapQtApps = true;

  cmakeFlags = [

    (lib.cmakeBool "ENABLE_LIBDEVICEINFO" true)

    (lib.cmakeBool "ENABLE_TESTS" finalAttrs.finalPackage.doCheck)

    (lib.cmakeFeature "CMAKE_CTEST_ARGUMENTS" (lib.concatStringsSep ";" [

      # Exclude tests

      "-E" (lib.strings.escapeShellArg "(${lib.concatStringsSep "|" [

        # Hits OpenGL context issue inside lomiri-ui-toolkit, see derivation of that on details

        "^testmouse"

        "^tst_notifications"

      ]})")

    ]))

  ];

  # CMake option had to be excluded from earlier patchset

  env.NIX_CFLAGS_COMPILE = lib.optionalString (lib.strings.versionOlder python3.pkgs.python-dbusmock.version "0.30.1") "-DMODERN_PYTHON_DBUSMOCK";

  # The linking for this normally ignores missing symbols, which is inconvenient for figuring out why subpages may be

  # failing to load their library modules. Force it to report them at linktime instead of runtime.

  env.NIX_LDFLAGS = "--unresolved-symbols=report-all";

  doCheck = stdenv.buildPlatform.canExecute stdenv.hostPlatform;

  # Parallelism breaks D-Bus tests

  enableParallelChecking = false;

  preCheck = ''

    export QT_PLUGIN_PATH=${lib.getBin qtbase}/${qtbase.qtPluginPrefix}

    export QML2_IMPORT_PATH=${lib.makeSearchPathOutput "bin" qtbase.qtQmlPrefix ([ qtdeclarative lomiri-ui-toolkit lomiri-settings-components ] ++ lomiri-ui-toolkit.propagatedBuildInputs)}

  '';

  postInstall = ''

    glib-compile-schemas $out/share/glib-2.0/schemas

    mkdir -p $out/share/{icons/hicolor/scalable/apps,lomiri-app-launch/{splash,screenshot}}

    ln -s $out/share/lomiri-system-settings/system-settings.svg $out/share/icons/hicolor/scalable/apps/lomiri-system-settings.svg

    ln -s $out/share/lomiri-system-settings/system-settings-app-splash.svg $out/share/lomiri-app-launch/splash/lomiri-system-settings.svg

    ln -s $out/share/lomiri-system-settings/screenshot.png $out/share/lomiri-app-launch/screenshot/lomiri-system-settings.png

  '';

  passthru = {

    tests.pkg-config = testers.testMetaPkgConfig finalAttrs.finalPackage;

    updateScript = gitUpdater { };

  };

  meta = with lib; {

    description = "System Settings application for Lomiri";

    homepage = "https://gitlab.com/ubports/development/core/lomiri-system-settings";

    changelog = "https://gitlab.com/ubports/development/core/lomiri-system-settings/-/blob/${finalAttrs.version}/ChangeLog";

    license = licenses.gpl3Only;

    mainProgram = "lomiri-system-settings";

    maintainers = teams.lomiri.members;

    platforms = platforms.linux;

    pkgConfigModules = [

      "LomiriSystemSettings"

    ];

  };

})

    inherit (self) callPackage;

  in {

    #### Core Apps

    lomiri-system-settings-unwrapped = callPackage ./applications/lomiri-system-settings { };

    lomiri-terminal-app = callPackage ./applications/lomiri-terminal-app { };

    morph-browser = callPackage ./applications/morph-browser { };