Bug 432526

Summary:	Include Platform Input Context Qt plugin in AppImage bundle
Product:	[Applications] digikam	Reporter:	Rimits <Kaira.Y>
Component:	Bundle-AppImage	Assignee:	Digikam Developers <digikam-bugs-null>
Status:	RESOLVED FIXED
Severity:	normal	CC:	caulier.gilles, tysontanx
Priority:	NOR
Version First Reported In:	7.5.0
Target Milestone:	---
Platform:	Appimage
OS:	Linux
Latest Commit:		Version Fixed In:	7.5.0
Sentry Crash Report:

Description Rimits 2021-02-05 08:10:16 UTC

SUMMARY
Appimage hardcodes QT_PLUGIN_PATH in AppRun, I can't add plugins like  IMEs, except unpack and repack the appimage


In file AppRun, QT_PLUGIN_PATH is coded this way:

69  export LD_LIBRARY_PATH=$DIR/usr/lib/:$LD_LIBRARY_PATH
70  export QT_PLUGIN_PATH=$DIR/usr/plugins/
71  export XDG_DATA_DIRS=$DIR/usr/share/:$XDG_DATA_DIRS

As a result, my IME, fcitx, doesn't work because it relys on a file located in
/usr/lib/x86_64-linux-gnu/qt5/plugins/platforminputcontexts/libfcitxplatforminputcontextplugin.so
The IME problem is easy to solve, since the bundled qt is newer than the system one, I only need to unpack image, copy the file, and repack.
I can also solve the IME problem by changing line 70 in AppRun to QT_PLUGIN_PATH=$DIR/usr/plugins:$QT_PLUGIN_PATH, and setting QT_PLUGIN_PATH=/usr/lib/x86_64-linux-gnu/qt5/plugins before running digikam.
Yet both require unpacking and repacking.

But my question is, is there any specific reason that in AppRun, QT_PLUGIN_PATH is dealt with differently from, e.g., XDG_DATA_DIRS and LD_LIBRARY_PATH ?

Can it be ,like, QT_PLUGIN_PATH=$DIR/usr/plugins:$QT_PLUGIN_PATH, so that users can add plugins using QT_PLUGIN_PATH without unpacking and repacking ?


SOFTWARE/OS VERSIONS
OS: ubuntu 20.04
software: digikam appimage 7.2.0-rc

Comment 1 caulier.gilles 2021-02-05 10:06:12 UTC

Hi,

Mixing different Qt5 plugins version can make digiKAm unstable. This is why this kind of PATH settings is private in AppImage.

The solution is to include the IME Qt plugin officially in embedded version compiled for AppImage. 

Gilles Caulier

Comment 2 caulier.gilles 2021-12-28 17:05:05 UTC

*** Bug 435897 has been marked as a duplicate of this bug. ***

Comment 3 caulier.gilles 2021-12-31 19:03:50 UTC

Packaging FCITX Qt5 plugin for Krita is done here :

https://invent.kde.org/graphics/krita/-/blob/master/3rdparty/ext_fcitx-qt/CMakeLists.txt

These Qt plugin is also compatible with Qt6 : https://github.com/fcitx/fcitx-qt5

Last release was done at 4 dec 2021 : https://groups.google.com/g/fcitx-announce/c/PFb5-aU3cMU

Gilles Caulier

Comment 4 caulier.gilles 2021-12-31 23:27:25 UTC

Git commit 8698d5431ce3bfef733cd4c1ac6f019c603db5bf by Gilles Caulier.
Committed on 31/12/2021 at 23:26.
Pushed by cgilles into branch 'master'.

prepare to add Platform Input Context Qt plugin in bundles
Related: bug 435897

M  +1    -0    project/bundles/3rdparty/CMakeLists.txt
A  +24   -0    project/bundles/3rdparty/ext_fcitx-qt/CMakeLists.txt

https://invent.kde.org/graphics/digikam/commit/8698d5431ce3bfef733cd4c1ac6f019c603db5bf

Comment 5 caulier.gilles 2022-01-01 10:00:59 UTC

Git commit 18a9bd0189ece08132160138e537621b870ba737 by Gilles Caulier.
Committed on 01/01/2022 at 09:59.
Pushed by cgilles into branch 'master'.

First try to install Platform Input Context Qt plugin under MacOS
Related: bug 435897

M  +6    -3    project/bundles/macports/02-build-extralibs.sh

https://invent.kde.org/graphics/digikam/commit/18a9bd0189ece08132160138e537621b870ba737

Comment 6 caulier.gilles 2022-01-01 11:19:47 UTC

Git commit 1672b7a5fa05e6c0e4489425c260706c3782baec by Gilles Caulier.
Committed on 01/01/2022 at 11:17.
Pushed by cgilles into branch 'master'.

FCITX qt plugin is only for Linux AppImage
Related: bug 435897

M  +2    -0    NEWS
M  +3    -0    project/bundles/appimage/02-build-extralibs.sh
M  +0    -3    project/bundles/macports/02-build-extralibs.sh

https://invent.kde.org/graphics/digikam/commit/1672b7a5fa05e6c0e4489425c260706c3782baec

Comment 7 caulier.gilles 2022-01-01 19:17:39 UTC

Hi Rimits,

New digiKam 7.5.0 pre-release AppImage bundle now include the famous Platform Input Context Qt plugin : 

[gilles@localhost Downloads]$ ./digiKam-7.5.0-20220101T175533-x86-64.appimage
-- digiKam Linux AppImage Bundle
-- Use 'help' as CLI argument to know all available options for digiKam application.
-- Notes: to integrate this bundle to your desktop, use AppImageLauncher.
--        to enable all debug messages on the console, use 'export QT_LOGGING_RULES="digikam*=true"'.
Check library libudev.so.0
Check library libxcb-dri3.so.0
Check library libcrypto.so.1.1
Check library libssl.so.1.1
-- Preloading shared libs: :/usr/lib64/libxcb-dri3.so.0:/usr/lib64/libcrypto.so.1.1:/usr/lib64/libssl.so.1.1
Digikam::DXmlGuiWindow::setupIconTheme: Breeze icons resource file found
Digikam::DXmlGuiWindow::setupIconTheme: Breeze-dark icons resource file found
Digikam::unloadQtTranslationFiles: Qt standard translations removed: 0
Digikam::loadStdQtTranslationFiles: Qt standard translations path: "/tmp/.mount_digiKafKsuVU/usr/share/digikam/translations"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qt"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtbase"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qt_help"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtdeclarative"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtquickcontrols"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtquickcontrols2"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtmultimedia"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtwebengine"
Digikam::loadStdQtTranslationFiles: Loaded Qt standard translations "en_US" from catalog "qtxmlpatterns"
Digikam::ApplicationSettings::setApplicationStyle: Switch to widget style:  "breeze"
Digikam::AlbumWatch::AlbumWatch: AlbumWatch is disabled
Digikam::AlbumManager::setDatabase: Database Parameters:
   Type:                      "QSQLITE"
...

[gilles@localhost platforminputcontexts]$ pwd
/tmp/.mount_digiKafKsuVU/usr/plugins/platforminputcontexts

[gilles@localhost platforminputcontexts]$ ll
total 339
-rwxr-xr-x 1 root root  27152 Jan  1 19:51 libcomposeplatforminputcontextplugin.so*
-rwxr-xr-x 1 root root 180544 Jan  1 19:51 libfcitxplatforminputcontextplugin.so*          <==== !!!!!!!!
-rwxr-xr-x 1 root root 139432 Jan  1 19:51 libibusplatforminputcontextplugin.so*

[gilles@localhost platforminputcontexts]$ 
[gilles@localhost ~]$ 

File to test is available at usual place : https://files.kde.org/digikam/

Please test and give us a feedback.

Best regards and happy new year

Gilles Caulier

Comment 8 Tyson Tan 2022-01-02 07:42:22 UTC

Thank you, Gilles! :D