Merge pull request 'Add appdata file' (#94) from bmckwm/squawk:appdata into master

Reviewed-on: blue/squawk#94
Reviewed-by: Blue <blue@macaw.me>

.gitea/workflows/release.yml

@@ -41,5 +41,5 @@ jobs:
         working-directory: aur
         run: |
           git add PKGBUILD .SRCINFO
-          git commit -m "${{ gitea.event.release.body }}"
+          git commit -m "${{ gitea.event.release.body//\"/\\\" }}"
           GIT_SSH_COMMAND="ssh -i ../key -o 'IdentitiesOnly yes' -o 'StrictHostKeyChecking no'" git push

CHANGELOG.md

@@ -17,7 +17,7 @@
 ### New features
 - now you can enable tray icon from settings!
 - there is a job queue now, this allowes to spread a bit the spam on the server at connection time
-- squawk now querries clients of it's peers, you can see what programs other people use
+- squawk now queries clients of it's peers, you can see what programs other people use
 
 ## Squawk 0.2.2 (May 05, 2022)
 ### Bug fixes

README.md

@@ -4,14 +4,14 @@
 [![AUR version](https://img.shields.io/aur/version/squawk?style=flat-square)](https://aur.archlinux.org/packages/squawk/)
 [![Liberapay patrons](https://img.shields.io/liberapay/patrons/macaw.me?logo=liberapay&style=flat-square)](https://liberapay.com/macaw.me)
 
-![Squawk screenshot](https://macaw.me/images/squawk/0.2.2.png)
+![Squawk screenshot](https://macaw.me/projects/squawk/0.2.2.png)
 
 ### Prerequisites
 
 - QT 5.12 *(lower versions might work but it wasn't tested)*
 - CMake 3.4 or higher
 - qxmpp 1.1.0 or higher
-- LMDBAL (my own [library](https://git.macaw.me/blue/lmdbal) around lmdb)
+- LMDBAL (my own [library](https://git.macaw.me/blue/lmdbal) for lmdb)
 - KDE Frameworks: kwallet (optional)
 - KDE Frameworks: KIO (optional)
 - KDE Frameworks: KConfig (optional)
@@ -33,14 +33,49 @@ $ pacaur -S squawk
 
 ### Building
 
-You can also clone the repo and build it from source
+You can also the repo and build it from source
 
 Squawk requires Qt with SSL enabled. It uses CMake as build system.
 
 Please check the prerequisites and install them before installation.
 
+---
+
+There are several ways to build Squawk. The one you need depends on whether you have `qxmpp` and `lmdbal` installed in your system.
+
+#### Building with system dependencies
+
+This is the easiest way but it requires you to have `qxmpp` and `lmdbal` installed as system packages. Here is what you do:
+
+```
+$ git clone https://git.macaw.me/blue/squawk
+$ cd squawk
+$ mkdir build
+$ cd build
+$ cmake ..
+$ cmake --build .
+```
+
+#### Building with bundled qxmpp
+
+If you don't have any of `qxmpp` or `lmdbal` (or both) installed the process is abit mor complicated.
+On the configuration stage you need to enable one or both entries in the square brackets, depending on what package your system lacks.
+
+Here is what you do
+
+```
+$ git clone --recurse-submodules https://git.macaw.me/blue/squawk
+$ cd squawk
+$ mkdir build
+$ cd build
+$ cmake .. [-D SYSTEM_QXMPP=False] [-D SYSTEM_LMDBAL=False]
+$ cmake --build .
+```
+
 #### For Windows (Mingw-w64) build
 
+**Building for windows is not mainteined, but was possible in the past, you can try, but it probably won't work**
+
 You need Qt for mingw64 (MinGW 64-bit) platform when installing Qt.
 
 The best way to acquire library `lmdb` and `boost` is through Msys2.
@@ -49,54 +84,30 @@ First install Msys2, and then install `mingw-w64-x86_64-lmdb` and `mingw-w64-x86
 
 Then you need to provide the cmake cache entry when calling cmake for configuration:
 
-```
-cmake .. -D LMDB_ROOT_DIR:PATH=<Msys2 Mingw64 Root Directory> -D BOOST_ROOT:PATH=<Msys2 Mingw64 Root Directory>
-```
-
 `<Msys2 Mingw64 Root Directory>`: e.g. `C:/msys64/mingw64`.
 
----
-
-There are two ways to build, it depends whether you have qxmpp installed in your system
-
-#### Building with system qxmpp
-
-Here is what you do
-
-```
-$ git clone https://git.macaw.me/blue/squawk
-$ cd squawk
-$ mkdir build
-$ cd build
-$ cmake .. [-D LMDB_ROOT_DIR:PATH=...] [-D BOOST_ROOT:PATH=...]
-$ cmake --build .
-```
-
-#### Building with bundled qxmpp
-
-Here is what you do
-
 ```
 $ git clone --recurse-submodules https://git.macaw.me/blue/squawk
 $ cd squawk
 $ mkdir build
 $ cd build
-$ cmake .. -D SYSTEM_QXMPP=False [-D LMDB_ROOT_DIR:PATH=...] [-D BOOST_ROOT:PATH=...]
+$ cmake .. -D SYSTEM_QXMPP=False -D SYSTEM_LMDBAL=False -D LMDB_ROOT_DIR:PATH=<Msys2 Mingw64 Root Directory> -D BOOST_ROOT:PATH=<Msys2 Mingw64 Root Directory>
 $ cmake --build .
 ```
 
-You can always refer to `appveyor.yml` to see how AppVeyor build squawk.
+You can always refer to `appveyor.yml` to see how AppVeyor build squawk for windows.
 
 ### List of keys
 
-Here is the list of keys you can pass to configuration phase of `cmake ..`. 
+Here is the list of keys you can pass to configuration phase of `cmake ..`:
+
 - `CMAKE_BUILD_TYPE` - `Debug` just builds showing all warnings, `Release` builds with no warnings and applies optimizations (default is `Debug`)
 - `SYSTEM_QXMPP` - `True` tries to link against `qxmpp` installed in the system, `False` builds bundled `qxmpp` library (default is `True`)
 - `SYSTEM_LMDBAL` - `True` tries to link against `LMDABL` installed in the system, `False` builds bundled `LMDBAL` library (default is `True`)
 - `WITH_KWALLET` - `True` builds the `KWallet` capability module if `KWallet` is installed and if not goes to `False`. `False` disables `KWallet` support (default is `True`)
 - `WITH_KIO` - `True` builds the `KIO` capability module if `KIO` is installed and if not goes to `False`. `False` disables `KIO` support (default is `True`)
 - `WITH_KCONFIG` - `True` builds the `KConfig` and `KConfigWidgets` capability module if such packages are installed and if not goes to `False`. `False` disables `KConfig` and `KConfigWidgets` support (default is `True`)
-- `WITH_OMEMO` - `True` builds the OMEMO encryption, requires `qxmpp` of version >= 1.5.0 built with OMEMO support. `False` disables OMEMO support (default is `True`)
+- `WITH_OMEMO` - `True` builds the OMEMO encryption, requires `qxmpp` of version >= 1.5.0 built with OMEMO support. `False` disables OMEMO support (default is `False`)
 
 ## License
 

external/simpleCrypt/simplecrypt.cpp

@@ -19,7 +19,7 @@
  DISCLAIMED. IN NO EVENT SHALL ANDRE SOMERS 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 #######; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ 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.

external/simpleCrypt/simplecrypt.h

@@ -19,7 +19,7 @@
  DISCLAIMED. IN NO EVENT SHALL ANDRE SOMERS 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 #######; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ 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.

main/application.cpp

@@ -245,7 +245,7 @@ void Application::onChangeTray(bool enabled, bool hide) {
                 trayIcon = nullptr;
             }
         }
-    } else if (trayIcon == nullptr) {
+    } else if (trayIcon != nullptr) {
         trayIcon->deleteLater();
         trayIcon = nullptr;
     }

packaging/Archlinux/PKGBUILD

@@ -8,10 +8,10 @@ url="https://git.macaw.me/blue/squawk"
 license=('GPL3')
 depends=('hicolor-icon-theme' 'desktop-file-utils' 'lmdbal' 'qxmpp-qt5')
 makedepends=('cmake>=3.3' 'imagemagick' 'qt5-tools' 'boost')
-optdepends=('kwallet: secure password storage (requires rebuild)'
-            'kconfig: system themes support (requires rebuild)'
-            'kconfigwidgets: system themes support (requires rebuild)'
-            'kio: better show in folder action (requires rebuild)')
+optdepends=('kwallet5: secure password storage (requires rebuild)'
+            'kconfig5: system themes support (requires rebuild)'
+            'kconfigwidgets5: system themes support (requires rebuild)'
+            'kio5: better show in folder action (requires rebuild)')
 
 source=("$pkgname-$pkgver.tar.gz::https://git.macaw.me/blue/$pkgname/archive/$pkgver.tar.gz")
 sha256sums=('SKIP')

packaging/CMakeLists.txt

@@ -1,3 +1,7 @@
 configure_file(squawk.desktop squawk.desktop COPYONLY)
 
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/squawk.desktop DESTINATION ${CMAKE_INSTALL_DATADIR}/applications)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/squawk.desktop DESTINATION ${CMAKE_INSTALL_DATADIR}/applications)
+
+configure_file(macaw.me.squawk.appdata.xml macaw.me.squawk.appdata.xml COPYONLY)
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/macaw.me.squawk.appdata.xml DESTINATION ${CMAKE_INSTALL_DATADIR}/metainfo)

packaging/macaw.me.squawk.appdata.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:its="http://www.w3.org/2005/11/its" xmlns="https://specifications.freedesktop.org/metainfo/1.0" type="desktop-application">
+  <id>macaw.me.squawk</id>
+  <metadata_license>CC0-1.0</metadata_license>
+  <project_license>GPL-3.0+</project_license>
+  <name>Squawk</name>
+  <summary>Desktop Qt based XMPP messenger</summary>
+  <description>
+    <p>
+      Squawk is a lightweight XMPP desktop messenger.
+      The primary objective of this project is to offer
+      you a fast and user-friendly messaging experience
+      that closely aligns with your system’s style, while
+      also minimizing resource consumption.
+    </p>
+    <p>
+      Squawk is still at a very early stage and might not suit
+      everyone but you are welcome to try it out.
+    </p>
+  </description>
+  <launchable type="desktop-id">macaw.me.squawk.desktop</launchable>
+  <screenshots>
+    <screenshot type="default">
+      <image>https://macaw.me/projects/squawk/0.2.2.png</image>
+      <caption>View XMPP contacts and conversations</caption>
+    </screenshot>
+  </screenshots>
+  <url type="homepage">https://macaw.me/projects/squawk/</url>
+  <provides>
+    <binary>squawk</binary>
+  </provides>
+  <update_contact>blue@macaw.me</update_contact>
+</component>