|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager.changes
|
|
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager.spec
^
|
|
|
|
[-]
[+]
|
Changed |
_service
^
|
| @@ -2,7 +2,7 @@
<service name="tar_git">
<param name="url">https://github.com/sailfishos-patches/patchmanager.git</param>
<param name="branch"/>
- <param name="revision">3.2.9</param>
+ <param name="revision">3.2.11</param>
<param name="token"/>
<param name="debian">N</param>
<param name="dumb">N</param>
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/.github/workflows/gendoc-create-html_qt56.yml
^
|
| @@ -0,0 +1,95 @@
+name: Generate Documentation (on Qt5.6)
+
+on:
+ release:
+ types: [published]
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+ inputs:
+ SOURCE_BRANCH:
+ description: 'Branch to use as source'
+ required: true
+ default: 'master'
+ type: string
+
+# Allow only one build run, skipping runs queued between the run in-progress and latest queued.
+# cancel in-progress runs
+concurrency:
+ group: "gendoc"
+ cancel-in-progress: true
+
+jobs:
+ ### Build the documentation files:
+ # - check out the branch
+ # - Use a docker image containing `qdoc` to generate the files
+ # - upload the results so the deployment job can pick it up
+ build:
+ runs-on: ubuntu-22.04
+ env:
+ SEGMENT_DOWNLOAD_TIMEOUT_MINS: 3
+ # branch to compile from
+ DOC_SOURCE_BRANCH: ${{ inputs.SOURCE_BRANCH != '' && inputs.SOURCE_BRANCH || 'master' }}
+ steps:
+ - name: Checkout Source (${{ env.DOC_SOURCE_BRANCH }})
+ uses: actions/checkout@v3
+ with:
+ ref: ${{ env.DOC_SOURCE_BRANCH }}
+ - name: Generate Docs
+ env:
+ # docker image to run qdoc etc. on
+ DOCKER_IMG: "icsinc/qt5.6.1-x64:latest"
+ run: |
+ mkdir -p out
+ docker run --rm -v $PWD:/share $DOCKER_IMG /bin/bash -xc "
+ echo 'debconf debconf/frontend select Noninteractive' | sudo debconf-set-selections;
+ sudo rm -f /etc/apt/sources.list.d/beineri-opt-qt561-trusty-trusty.list
+ sudo apt-get -qq update;
+ sudo apt-get -qq install -y qtbase5-dev;
+ sudo apt-get -qq install -y git-core;
+ mkdir -p build ;
+ cd build ;
+ cp -r /share/* . ;
+ mkdir -p doc/generated;
+ git clone --depth 1 -b upgrade-4.5.0 https://github.com/sailfishos/sailfish-qdoc-template doc/qdoc/sailfish-qdoc-template;
+ /bin/bash -c ./makedocs;
+ cp -rv doc/generated/* /share/out/;
+ "
+ # The builder outputs its index files in several subdirectories.
+ # The web root has no index file, so GH Pages throws a 404 when browsing there.
+ # So, lets add an index.html file to the root which redirects where we want to go:
+ - name: Add redirect Page
+ env:
+ REDIRECTOR: |
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Redirecting...</title>
+ <meta http-equiv="refresh" content="1; url='patchmanager'"/>
+ </head>
+ <body>
+ <p>You will be redirected to the Documentation pages soon.</p>
+ <p>If this does not happpen, <a href="patchmanager">please click here</a>.</p>
+ </body>
+ </html>
+ run: echo "${REDIRECTOR}" > out/index.html
+ # Upload artifact for deploying to pages:
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v1
+ with:
+ path: './out'
+
+ # Now deploy to GH Pages
+ deploy:
+ needs: build
+ runs-on: ubuntu-22.04
+ # Grant GITHUB_TOKEN the permissions required by deploy-pages action
+ permissions:
+ pages: write # to deploy to Pages
+ id-token: write # to verify the deployment originates from an appropriate source
+ steps:
+ - name: Setup Pages
+ uses: actions/configure-pages@v3
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v2
+
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/.gitignore
^
|
| @@ -17,3 +17,4 @@
src/icons/z*
src/icons/ss
*.list
+doc/generated
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/README.md
^
|
| @@ -33,8 +33,8 @@
The metadata file contains information about a Patch. It is a simple JSON file, that must be named `patch.json`.
This file contains the title of the Patch, a short description of the Patch, a category, and additional information. For the documentation of this JSON file format see:
- - for the [modern format](./doc/example_patch.json.md)
- - for the much simpler [legacy format](./doc/example_legacy_patch.json.md)
+ - for the [modern format](./doc/examples/patch.json.md)
+ - for the much simpler [legacy format](./doc/examples/legacy_patch.json.md)
Either format is supported, but the modern one provides more useful features and is recommended.
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/examples/legacy_patch.json.md
^
|
| (renamed from doc/example_legacy_patch.json.md)
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/examples/patch-rpm.spec
^
|
| (renamed from doc/example_patch-rpm.spec)
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/examples/patch.json.md
^
|
| (renamed from doc/example_patch.json.md)
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/common.qdocconf
^
|
| @@ -0,0 +1,34 @@
+# include some Qt defaults
+# -- macros for QDoc commands
+include($QT_INSTALL_DOCS/global/macros.qdocconf)
+# -- needed by C++ projects
+include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
+# -- compatibility macros
+include($QT_INSTALL_DOCS/global/compat.qdocconf)
+# -- configuration common among QDoc projects
+include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)
+# -- offline HTML template for documentation shipped to Qt Creator
+#include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
+include($SAILFISH_INSTALL_DOCS/sailfish-html-templates.qdocconf)
+
+# Reduce padding around code
+codeprefix = "\n"
+codesuffix = "\n"
+
+# override/add some things to the stylesheets:
+HTML.stylesheets += ./pm.css
+
+# assign custom HTML footer to replace Qt's default copyright notice
+HTML.footer = "<div align='center'><hr/>" \
+ "<p><small>Patchmanager Documentation\n" \
+ "Copyright (c) 2023 Patchmanager for SailfishOS contributors.\n" \
+ "This document may be used under the terms of the " \
+ "<a href='https://spdx.org/licenses/CC-BY-SA-4.0.html'>" \
+ "Creative Commons Attribution Share Alike 4.0 International</a> " \
+ "License.</small></p>" \
+ "<p/></div>"
+
+navigation.homepage = https://github.com/sailfishos-patches/patchmanager/wiki
+navigation.hometitle = Patchmanager
+navigation.landingpage = Patchmanager Documentation
+
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/daemon.qdocconf
^
|
| @@ -0,0 +1,13 @@
+project = daemon
+description = Patchmanager Daemon Reference Documentation
+versionsym =
+version = 2.0
+url = https://github.com/sailfishos-patches/patchmanager
+
+include (common.qdocconf)
+
+headerdirs += ../../src/bin/patchmanager-daemon
+headers.fileextensions = "*.h *.hpp"
+
+sourcedirs += ../../src/bin/patchmanager-daemon
+#sources.fileextensions = "*.cpp *.qdoc *.qml"
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/dialog.qdocconf
^
|
| @@ -0,0 +1,10 @@
+project = dialog
+description = Patchmanager Startup Dialog Documentation
+versionsym =
+version = 2.0
+url = https://github.com/sailfishos-patches/patchmanager
+
+include (common.qdocconf)
+
+sourcedirs = ../../src/bin/dialog
+
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/general.qdocconf
^
|
| @@ -0,0 +1,10 @@
+project = patchmanager
+description = Patchmanager
+
+include (common.qdocconf)
+
+## Sources
+sources += ../../src/index.qdoc
+# for quoting
+exampledirs += ../../src/bin/patchmanager-daemon
+
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/master.qdocconf
^
|
| @@ -0,0 +1,6 @@
+doc/qdoc/general.qdocconf
+doc/qdoc/qmlplugin.qdocconf
+doc/qdoc/daemon.qdocconf
+doc/qdoc/plugin.qdocconf
+doc/qdoc/preload.qdocconf
+doc/qdoc/dialog.qdocconf
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/plugin.qdocconf
^
|
| @@ -0,0 +1,11 @@
+project = settings-plugin
+description = Patchmanager Settings Plugin Documentation
+versionsym =
+version = 2.0
+url = https://github.com/sailfishos-patches/patchmanager
+
+include (common.qdocconf)
+
+sourcedirs = ../../src/plugin
+
+
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/pm.css
^
|
| @@ -0,0 +1,5 @@
+a:link { color: #8C001A; text-decoration: none; text-align: left; }
+a.qa-mark:target:before { content: "***"; color: #ff0000; }
+a:hover { color: #8C0060; text-align: left; }
+a:visited { color: #8C001A; text-align: left; }
+a:visited:hover { color: #8C0060; text-align: left; }
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/preload.qdocconf
^
|
| @@ -0,0 +1,13 @@
+project = preload
+description = Patchmanager Preload Library
+versionsym =
+version = 2.0
+url = https://github.com/sailfishos-patches/patchmanager
+
+include(common.qdocconf)
+
+sources = ../../src/preload/src/preloadpatchmanager.qdoc
+# needed for quoting source code:
+exampledirs += ../../src/preload/src
+
+
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/doc/qdoc/qmlplugin.qdocconf
^
|
| @@ -0,0 +1,19 @@
+project = qml-plugin
+description = Patchmanager QML Plugin Reference Documentation
+versionsym =
+version = 2.0
+url = https://github.com/sailfishos-patches/patchmanager
+
+include(common.qdocconf)
+
+depends += qtcore qtqml
+
+headerdirs = ../../src/qml
+#headers.fileextensions = "*.h *.hpp"
+
+sourcedirs = ../../src/qml
+sources += qmlplugin.qdoc
+#sources.fileextensions = "*.cpp *.qdoc *.qml"
+
+# get rid of warnings about undoicumented stuff in patchmanager.h
+Cpp.ignoretokens += Q_PROPERTY
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/makedocs
^
|
| @@ -0,0 +1,67 @@
+#!/bin/sh
+#
+# Copyright (c) 2023, Peter G. "nephros" <sailfish@nephros.org>
+# Licensed under the terms of the BSD 3-Clause License
+#
+
+# This will build Documentation.
+#
+# It is intended to be run from within the source tree.
+# It is also used in Github Actions.
+#
+# Note that there are large differnces in the qdoc command between Qt 5.6
+# (SFOS), and later Qt versions.
+# In order to enable building in newer Qt versions, changes in both the qdoc
+# config files as well as the code comments will be required.
+
+printf '####### %s starting... #######\n' $0
+### verify "build" environment
+printf '## Verifying build environment:\n'
+switched_dirs="false"
+if gitroot=$(git rev-parse --show-toplevel 2>/dev/null); then
+ printf '## found a git root at %s, running from there...\n' "$gitroot"
+ pushd $gitroot >/dev/null || cd $gitroot
+ switched_dirs="true"
+else
+ printf '## this is not a git repo, assuming root is %s\n' "$PWD"
+fi
+
+# this is searched relative to the qdocconf file!!
+export SAILFISH_INSTALL_DOCS=sailfish-qdoc-template/config
+
+qdocver=$(qdoc --version)
+if [ $? -ne 0 ]; then
+ printf '## ERROR: qdoc does not seem to work! Please check your qt5 installation\n'
+ exit 1
+else
+ printf '## QDoc is: %s\n' "$qdocver"
+fi
+if [ ! -e doc/qdoc/sailfish-qdoc-template ]; then
+ printf '## ERROR: sailfish-qdoc-template does not exist\n'
+ printf "## You should \'git clone --depth 1 -b upgrade-4.5.0 https://github.com/sailfishos/sailfish-qdoc-template doc/qdoc/sailfish-qdoc-template'\n"
+ exit 1
+fi
+
+OUT=$PWD/doc/generated
+
+export QT_VER=5
+export QT_INSTALL_DOCS
+
+if [ -z "$QT_INSTALL_DOCS" ]; then
+ if [ -f /usr/share/doc/qt5/global/macros.qdocconf ]; then
+ QT_INSTALL_DOCS=/usr/share/doc/qt5
+ elif [ -f /usr/share/qt5/doc/global/macros.qdocconf ]; then
+ QT_INSTALL_DOCS=/usr/share/qt5/doc
+ fi
+fi
+
+printf '## Generating Docs...\n'
+[ -d $OUT ] && rm -r $OUT
+qdoc --no-examples --outputdir $OUT --outputformat HTML --installdir $QMAKE_INSTALL_ROOT/doc doc/qdoc/master.qdocconf --single-exec $@
+printf '## End of Doc generation at "%s"\n' "$OUT"
+
+[ $switched_dirs = "true" ] && popd >/dev/null || cd -
+
+printf '####### %s done. #######\n' $0
+# always exit 0 for CI runs:
+exit 0
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/bin/dialog/dialog.qdoc
^
|
| @@ -0,0 +1,55 @@
+/*!
+ \title Patchmanager Documentation: Startup Dialog
+ \page index.html overview
+ \indexpage Patchmanager Documentation
+
+ This is a very simple Sailfish OS application that upon start checks the state of the Patchmanager Daemon to see whether it needs to launch a GUI.
+
+ \section1 User Interface: Dialog
+
+ At start it shows a \l {https://sailfishos.org/develop/docs/silica/qml-sailfishsilica-sailfish-silica-remorseitem.html/}{RemorseItem}
+ with a timeout of 10 seconds. If the user cancels this dialog, the PM deamon
+ will not activate any patches (with the side-effect of marking all as
+ disabled.)
+
+ If the Remorse timer runs out, the PM daemon will activate all Patches marked
+ as enabled, and the Dialog shows a little progress bar while it's
+ doing that.
+
+ Patches failing to apply will be logged, and reported.
+
+ After ending any of the above operations, a \uicontrol "Quit" button is
+ activated which will close the application.
+
+ This dialog will only be shown if the option \uicontrol{"Apply on Boot"} is \c off.
+
+
+ \section1 Application Startup
+
+ Upon launch, the binary will check the following:
+
+ \list
+ \li whether \l {PatchManager::applyOnBoot}{applyOnBoot} is set in \c /etc/patchmanager2.conf.
+ \li the result of a call to the \l {PatchManagerObject::getLoaded}{getLoaded} D-Bus method on the Daemon.
+ \endlist
+
+ If the first is set to \c true, it will exit. (Because with this setting on, all patches will be activate at boot, without the need of a Startup Dialog.)
+
+ If the reply indicates that PM has not been initialized, it will launch the QML UI. Otherwise it will exit.
+
+ \section2 D-Bus interface
+
+ The dialog implements a D-Bus method \c show i on the root path of the \c org.SfietKonstantin.patchmanager service to invoke the UI:
+
+ \badcode
+ <interface name="org.SfietKonstantin.patchmanager">
+ <method name="show">
+ <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
+ </method>
+ </interface>
+ \endcode
+
+ This is used by \l {PatchManagerObject::lipstickChanged} to open the dialog once it has initialized.
+
+ \sa {Patchmanager Services}, {Patchmanager Configuration Files}
+*/
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/bin/patchmanager-daemon/daemon.qdoc
^
|
| @@ -0,0 +1,24 @@
+/*!
+ \page index.html
+
+ \title Patchmanager Documentation: Daemon
+ \indexpage Patchmanager Documentation
+
+ \section1 Overview
+
+ A D-Bus activated background service which manages patch un/installation,
+ listing, de/actvation, and communication with the preload library.
+
+ Patchmanager is usually launched by its DBus service.
+
+ If the \c patchmanager binary is called from command line, it
+ can also serve as a simple CLI to a running daemon.
+ See the output of \c{patchmanager --help} and
+ PatchManagerObject::process() for more information.
+
+ \section2 Documentation:
+ \generatelist {classesbymodule PatchManagerDaemon}
+
+
+*/
+
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/bin/patchmanager-daemon/inotifywatcher.cpp
^
|
| @@ -69,6 +69,20 @@
connect(notifier, &QSocketNotifier::activated, this, &INotifyWatcher::readFromInotify);
}
+/*! \class INotifyWatcher
+ \inmodule PatchManagerDaemon
+ \inherits QSocketNotifier
+ \brief watches a list of files or directories for changes
+*/
+/*! \fn void INotifyWatcher::directoryChanged(const QString &path, bool removed);
+ \fn void INotifyWatcher::fileChanged(const QString &path, bool removed);
+ This signal is emitted when a file or directory has changed.
+ Parameters are the \a path and whether it was \a removed.
+ */
+/*! \fn void INotifyWatcher::contentChanged(const QString &path, bool created);
+ This signal is emitted when directory content has changed
+ Parameters are the \a path and whether something was \a created.
+ */
INotifyWatcher::~INotifyWatcher()
{
notifier->setEnabled(false);
@@ -78,6 +92,7 @@
::close(inotifyFd);
}
+/*! Add \a paths to the list of paths to be watched. */
QStringList INotifyWatcher::addPaths(const QStringList &paths)
{
QStringList p = paths;
@@ -127,6 +142,7 @@
return p;
}
+/*! Removes \a paths from the list of paths to be watched. */
QStringList INotifyWatcher::removePaths(const QStringList &paths)
{
QStringList p = paths;
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/bin/patchmanager-daemon/journal.cpp
^
|
| @@ -4,6 +4,12 @@
#include <QDebug>
#include <stdio.h>
+/*! \class Journal
+ \inmodule PatchManagerDaemon
+*/
+/*! \fn Journal::matchFound()
+ Emitted when the fileters found a log entry that matched.
+*/
Journal::Journal(QObject *parent)
: QObject(parent)
{
@@ -39,6 +45,7 @@
thread->start();
}
+/*! Attaches itself to the Journal, filetering for \e Lipstick and \e jolla-settings executables. */
void Journal::init()
{
qDebug() << Q_FUNC_INFO;
@@ -60,6 +67,16 @@
wait();
}
+/*! Read the message from the Journal, look got certain strings, and emit the matchFound signal if found.
+
+ Strings looked for are:
+
+ \list
+ \li "Type X unavailable"
+ \li "is not a type" AND "Error while loading page"
+ \endlist
+
+*/
void Journal::process()
{
int next_ret = sd_journal_next(m_sdj);
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/bin/patchmanager-daemon/patchmanagerobject.cpp
^
|
| @@ -147,6 +147,40 @@
static const QString SETTINGS_CODE = QStringLiteral("settings");
static const QString KEYBOARD_CODE = QStringLiteral("keyboard");
+/*!
+ \class PatchManagerObject
+ \inmodule PatchManagerDaemon
+
+ \brief The Patchmanager Daemon.
+
+ A D-Bus activated background service which manages patch un/installation,
+ listing, de/actvation, and communication with the preload library.
+
+ PatchManager is usually launched by its DBus service.
+ The binary can also serve as a simple command-line client to a running
+ daemon. See the output of \c{patchmanager --help} for more information.
+
+*/
+
+/*!
+ \enum PatchManagerObject::NotifyAction
+ \relates PatchManagerObject::notify()
+
+ This enum specifies the type of notification to emit through \c
+ PatchManagerObject::notify()
+
+ \value NotifyActionSuccessApply
+ applying was successful
+ \value NotifyActionSuccessUnapply
+ unapplying was successful
+ \value NotifyActionFailedApply
+ applying was not successful
+ \value NotifyActionFailedUnapply
+ unapplying was not successful
+ \value NotifyActionUpdateAvailable
+ one of the patches has an update
+*/
+
QString getLang()
{
QString lang = QStringLiteral("en_US.utf8");
@@ -224,6 +258,10 @@
return true;
}
+/*!
+ Sends a notification to the user. \a patch is the patch name, \a action one of:
+ \sa PatchManagerObject::NotifyAction
+*/
void PatchManagerObject::notify(const QString &patch, NotifyAction action)
{
qDebug() << Q_FUNC_INFO << patch << action;
@@ -303,11 +341,19 @@
qDebug() << Q_FUNC_INFO << notification.replacesId();
}
+/*!
+ Returns the list of applied patches via getSettings().
+ \sa getSettings(), getSettings(), setAppliedPatches()
+*/
QSet<QString> PatchManagerObject::getAppliedPatches() const
{
return getSettings(QStringLiteral("applied"), QStringList()).toStringList().toSet();
}
+/*!
+ Saves the list of applied \a patches via \c putSettings().
+ \sa getSettings(), getSettings(), getAppliedPatches()
+*/
void PatchManagerObject::setAppliedPatches(const QSet<QString> &patches)
{
putSettings(QStringLiteral("applied"), QStringList(patches.toList()));
@@ -324,6 +370,12 @@
return m_mangleCandidates;
}
+/*!
+ Reads operating system (\c{VERSION_ID}) version from \c /etc/os-release and sets \c m_osRelease to its value.
+ Calls lateInitialize() afterwards.
+
+ \sa lateInitialize()
+*/
void PatchManagerObject::getVersion()
{
qDebug() << Q_FUNC_INFO;
@@ -546,6 +598,13 @@
}
}
+/*!
+ \fn void PatchManagerObject::doPrepareCache(const QString &patchName, bool apply = true)
+ \fn void PatchManagerObject::prepareCacheRoot()
+
+ Creates the cache directory where patched files will be stored
+ and read from when passed to the preload library
+*/
void PatchManagerObject::doPrepareCache(const QString &patchName, bool apply)
{
qDebug() << Q_FUNC_INFO << patchName << apply;
@@ -627,6 +686,13 @@
}
}
+/*!
+ \fn void PatchManagerObject::doStartLocalServer()
+ \fn void PatchManagerObject::startLocalServer()
+
+ Starts the internal Server thread if not already started.
+ Emits \c loadedChanged if successful.
+*/
void PatchManagerObject::doStartLocalServer()
{
qDebug() << Q_FUNC_INFO;
@@ -639,6 +705,19 @@
}
}
+/*!
+ \fn void PatchManagerObject::initialize()
+ \fn void PatchManagerObject::lateInitialize()
+
+ Initialize the engines.
+
+ The initialization sequence consists of:
+
+ - setting up the patch translator
+ - checking configuration constants and environment
+ - setting up DBus connections to Lipstick and the Store client
+
+*/
void PatchManagerObject::initialize()
{
qInfo() << Q_FUNC_INFO << "Patchmanager version" << qApp->applicationVersion();
@@ -779,6 +858,7 @@
getVersion();
}
+/*! Returns a pretty name (the \c display_name field) from the metadata of \a patch. */
QString PatchManagerObject::getPatchName(const QString patch) const
{
if (!m_metadata.contains(patch)) {
@@ -789,6 +869,14 @@
return (patchData.contains("display_name") ? patchData["display_name"] : patchData[NAME_KEY]).toString();
}
+/*!
+ \fn void PatchManagerObject::restartLipstick()
+ \fn void PatchManagerObject::doRestartLipstick()
+
+ Invokes PatchManagerObject::doRestartLipstick() to restart Lipstick
+
+ \sa PatchManagerObject::restartService(const QString &serviceName)
+*/
void PatchManagerObject::restartLipstick()
{
qDebug() << Q_FUNC_INFO;
@@ -803,6 +891,11 @@
restartService(QStringLiteral("lipstick.service"));
}
+/*!
+ Invokes ManagerObject::doRestartKeyboard() to restart Maliit
+
+ \sa PatchManagerObject::doRestartKeyboard()
+*/
void PatchManagerObject::restartKeyboard()
{
qDebug() << Q_FUNC_INFO;
@@ -817,6 +910,15 @@
restartService(QStringLiteral("maliit-server.service"));
}
+/*!
+ Stops, restarts, or kills running processes belonging to a category which
+ has been marked as to-be-restarted.
+
+ For regular processes, \c killall will be performed on them.
+
+ For SystemD services, they will be restarted via D-Bus call, or if that fails, via \c systemctl-user.
+
+*/
void PatchManagerObject::restartService(const QString &serviceName)
{
qDebug() << Q_FUNC_INFO << serviceName;
@@ -932,6 +1034,9 @@
QDir::root().mkpath(s_patchmanagerCacheRoot);
}
+/*!
+ retrieve the RPM name from a full package string
+*/
QString PatchManagerObject::getRpmName(const QString &rpm) const
{
const QString info = rpm.section('-', -2);
@@ -939,6 +1044,35 @@
return name;
}
+/*!
+
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/bin/patchmanager-daemon/patchmanagerobject.h
^
|
| @@ -114,10 +114,10 @@
QVariantMap getUpdates() const;
bool putSettings(const QString & name, const QDBusVariant & value);
- QDBusVariant getSettings(const QString & name, const QDBusVariant & def);
-
bool putSettings(const QString & name, const QVariant & value);
+
QVariant getSettings(const QString & name, const QVariant & def) const;
+ QDBusVariant getSettings(const QString & name, const QDBusVariant & def);
static QString maxVersion(const QString &version1, const QString &version2);
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/index.qdoc
^
|
| @@ -0,0 +1,349 @@
+/*!
+
+ \page index.html overview
+
+ \title Patchmanager Documentation
+
+ For User documentation, see \l {https://github.com/sailfishos-patches/patchmanager/#information-for-users}{User Documentation}.
+
+ For Patch Developer documentation, see \l {https://github.com/sailfishos-patches/patchmanager/#information-for-patch-developers}{Developer Documentation}.
+
+ \section1 Internals
+
+ For information on how PM operates internally, see:
+
+ \list
+ \li \l {Patchmanager Overview}
+ \li \l {Patchmanager Services}
+ \li \l {Patchmanager Configuration Files}
+ \endlist
+
+ \section1 Applications
+
+ The Patchmanager project includes the following applications:
+
+ \section2 GUI Applications
+ \list
+ \li \l {Patchmanager Documentation: Settings Plugin}{Patchmanager Settings Plugin}, a plugin for the Jolla Settings to launch the application
+ \li \l {Patchmanager Documentation: QML Plugin}{Patchmanager QML Plugin}, the main UI Application
+ \li \l {Patchmanager Documentation: Startup Dialog}{Patchmanager Startup Dialog}, a UI shown at Lipstick startup.
+ \endlist
+
+ \section2 Infrastructure Applications
+ \list
+ \li \l {Patchmanager Documentation: Daemon}{Patchmanager Daemon}
+ \li \l {Patchmanager Documentation: Preload Library}{Preload Library}
+ \li \l {Patchmanager Web Catalog}{Web Catalog}
+ \endlist
+
+*/
+
+/****** Overview page *******/
+/*!
+ \title Patchmanager Overview
+
+ \page pmoverview.html overview
+ \indexpage Patchmanager Documentation
+ \nextpage {Patchmanager Services}
+
+ So the current mode of operation of Patchmanager is something like this:
+
+ \section1 Operation Flow
+
+ \section2 1. A Patch is "activated"
+
+ When a user activates a patch via the App, a signal is sent to the daemon.
+
+ The daemon will then:
+
+ For each file the patch manipulates, a copy of the original file is put into
+ a cache dir in \c /tmp, and the changes are applied there instead of on the
+ original file.
+
+ If there are paths or files involved in the patch which do not exist yet
+ in the filesystem, they will be created in the cache dir, and a symlink
+ pointing to them is placed in the original filesystem.
+ \section2 2. A patched application is launched.
+
+ Through library preloading, the \c libpreloadpatchmanager.so library is
+ injected into the launching binary.
+
+ \section2 3. The Preload Library:
+
+ \list
+ \li Intercepts calls to \l {https://www.man7.org/linux/man-pages/man2/open.2.html}{\c{open()} (or \c{open64()})},
+ \li analyzes which files the call was meant to open
+ \li asks the Patchmanager daemon (via socket) whether it knows of a patched version.
+ \endlist
+
+ If yes, the daemon will return a path to its cachedir, and the library
+ redirects the call to that file instead of the original. Otherwise, the
+ \c{open()} is executed on the original file.
+
+ Certain paths are blacklisted for these operations to reduce the risk of
+ critical services, or PM itself, choking on these redirections.
+
+ \note After activating a Patch , the daemon may also inform the UI that some
+ apps or services need restart. The UI client is expected to issue the command
+ to restart these soon.
+ As long as the corresponding preocesses are not restarted, the effect of the
+ applied patch will not show, or may only show partially, depending on the "patch
+ history" of the respective process.
+
+ \section1 Patch Installation
+ There are three ways a Patch can end up on the system:
+
+ \list
+ \li Web Catalog
+ \li RPM package
+ \li TAR package
+ \li manual installation
+ \endlist
+
+ \section2 Patch folder structure
+
+ All Patches managed by PM are installed under \c /usr/share/patchmanager/patches/NAME,
+ where NAME is a directory having a unique name.
+
+ That directory must contain at least two files: a \c JSON file called
+ \c patch.json containing metadata, and a \c diff file called \c{unified_diff.patch}.
+
+ It may optionally also contain:
+ \list
+ \li Qt translation (.qm) files
+ \li icon files in PNG format
+ \li a QML file called \c main.qml (whose root element is a Sailfish Silica \c{Page}).
+ \li other QML-compatible files which are referenced/loaded from \c main.qml
+ \endlist
+
+ \note the directory NAME is usually and by convention the same as the patch
+ metadata field \c name, but that is not a requirement. NAME should be
+ reasonably unique though, to avoid name clashes with Patches from others.
+
+ \section2 Web Catalog
+
+ Installation via the Patchmanager Web Catalog is the most common and recomended way of installing a patch.
+ This is done through the Patchmanager UI, by selecting \uicontrol install on the \l {WebPatchPage}{Patch Page}.
+
+ PM will download metadata and a tarball from the Web Catalog, extract the
+ tarball into the patch storage location, and generate the necessary JSON file
+ from the metadata.
+
+ \section2 RPM package
+
+ Patches may be distributed as RPM files, which assure the placement of files
+ according to the structure explained above. RPM also provides advanced
+ features like dependencies and scriptlets which may be necessary for correct
+ operation or installation of a Patch.
+
+ \section2 TAR package
+
+ Patch developers may sometimes distribute Patches in \c tar format. Usually
+ they also contain the necessary files, but the contents of the tarball may
+ differ, and recipients of them must assure the layout given above is set up
+ correctly.
+
+ \section2 manual installation
+
+ Patch developers or users may want to quickly place a Patch under PM's
+ supervision without going through the hassle of packaging and installing.
+ This can be done easily, as long as the formats given above are followed.
+
+ \e{to be continued...}
+
+*/
+/****** Web Catalog page *******/
+/*!
+ \title Patchmanager Web Catalog
+
+ \page pmwc.html
+
+ The Web Catalog is currently not maintained by the Patchmanager project, and
+ is documented here briefly for sake of completeness.
+
+ \e{to be continued...}
+
+*/
+
+/****** Services Documentation page *******/
+/*!
+ \title Patchmanager Services
+ \previouspage {Patchmanager Overview}
+ \nextpage {Patchmanager Configuration Files}
+
+ \page pmservices.html overview
+
+ \section1 Installation and Configuration
+
+ \section2 D-Bus System Service
+ \target dbus-sys
+ The D-Bus services reserve the bus name \c org.SfietKonstantin.patchmanager
+
+ It is defined as follows:
+
+ \quotefile dbus/org.SfietKonstantin.patchmanager.xml
+
+ Calls can be issued e.g. like this:
+
+ \badcode
+ dbus-send --print-reply --system --dest=org.SfietKonstantin.patchmanager /org/SfietKonstantin/patchmanager org.SfietKonstantin.patchmanager.checkforUpdates
+ \endcode
+
+ \section2 Systemd System Units
+
+ \table
+ \header
+ \li Name
+ \li Type
+ \li Component
+ \li Description
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/plugin/patchmanager.qml
^
|
| @@ -1,3 +1,11 @@
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype patchmanager
+ \inqmlmodule patchmanager
+ \brief Jolla Settings Plugin Page
+ \inherits \l {Page}
+
+ This loads the main Patchmanager UI from Jolla Settings.
+*/
+
PatchManagerPage {}
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/plugin/plugin.qdoc
^
|
| @@ -0,0 +1,40 @@
+/*!
+ \page index.html
+ \title Patchmanager Documentation: Settings Plugin
+ \indexpage Patchmanager Documentation
+
+ \section1 Overview
+
+ The Settings Plugin makes up the main Patchmanager GUI Application.
+
+ Jolla Settings loads this page which in turn loads
+ PatchManagerPage, a part of \l {Patchmanager Documentation: QML Plugin}{Patchmanager QML Plugin}.
+
+ \section2 Configuration
+
+ The Jolla Settings plugin configuration looks like this:
+
+ \badcode
+ {
+ "translation_catalog": "settings-patchmanager",
+ "entries": [
+ {
+ "path": "system_settings/look_and_feel/patchmanager",
+ "type": "page",
+ "title": "Patchmanager",
+ "translation_id": "Patchmanager",
+ "icon": "image://theme/icon-m-patchmanager2",
+ "order": 2000,
+ "params": {
+ "source": "/usr/share/jolla-settings/pages/patchmanager/patchmanager.qml"
+ }
+ }
+ ]
+ }
+ \endcode
+
+ \section2 Types
+
+ This plugin provides no types.
+*/
+
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/preload/src/preloadpatchmanager.qdoc
^
|
| @@ -0,0 +1,100 @@
+/*!
+ \page index.html
+
+ \title Patchmanager Documentation: Preload Library
+
+ \indexpage Patchmanager Documentation
+
+ \section1 Overview
+
+ This library
+
+ \list
+ \li Intercepts calls to \l {https://www.man7.org/linux/man-pages/man2/open.2.html}{\c{open()} (or \c{open64()})},
+ \li analyzes which files the call was meant to open
+ \li asks the Patchmanager Daemon (via socket) whether it knows of a patched version.
+ \endlist
+
+ If yes, the daemon will return a path to its cachedir, and the library
+ redirects the call to that file instead of the original. Otherwise, the
+ \c{open()} is executed on the original file.
+
+ Certain paths are blacklisted for these operations to reduce the risk of
+ critical services, or PM itself, choking on these redirections.
+
+ \e{to be continued...}
+
+ \section1 Implementation
+
+ \e{to be continued...}
+ \section3 Blacklists:
+
+ The following two "blacklists" cause the lib to back off redirecting calls for paths matching one of the entries in the list:
+
+ \quotefromfile preloadpatchmanager.c
+ Paths that start with one of these patterns are skipped
+ \skipto static const char *blacklist_paths_startswith[]
+ \printuntil };
+ Paths that match exactly one of these patterns are skipped
+ \skipto static const char *blacklist_paths_equal[]
+ \printuntil };
+
+ \section2 Building
+
+ The following \c{#defines} can be used to alter the library behaviour at compile-time
+
+ \table
+ \header
+ \li Define
+ \li Default
+ \li Description
+ \row
+ \li NO_INTERCEPT
+ \li undefined
+ \li Compiles out all of the actual redirection code, leaving the rest in place. Can be used in extreme debugging cases te track what is going on without affecting applications.
+ \row
+ \li ALLOW_ALL_USERS
+ \li defined
+ \li Only allow preloading for users with an UID >= \c UID_MIN, default 100000
+ \endtable
+
+ \section1 Running
+ \section2 Installation
+
+ Once the library is installed in one of the standard library paths, the following is added to the file \c /etc/ld.so.preload
+
+ \badcode
+ /usr/lib/libpreloadpatchmanager.so
+ \endcode
+ \badcode
+ /usr/lib64/libpreloadpatchmanager.so
+ \endcode
+
+ which causes it to be loaded into any binary process that is launched.
+
+ \section2 Environment
+
+ The library reacts on the following environment variables:
+
+ \table
+ \header
+ \li Variable
+ \li Default
+ \li Description
+ \row
+ \li NO_PM_PRELOAD
+ \li undefined
+ \li Makes the lib skip finding files to redirect to, effectively diabling it ofr practical purposes. Intended to be set for processes which should operate on unpatched original files.
+ \row
+ \li PM_PRELOAD_DEBUG
+ \li undefined
+ \li Enables debugging output; messages are prefixed with \c{[pm_name]}, \c{[open]}, or \c{[open64]} depending on operation.
+ \endtable
+
+ Set them to any value to make them take effect
+
+ \section2 Socket
+
+ The library will try to open a socket at \c{/tmp/patchmanager-socket} in order to communicate with the Patchmanager Daemon
+
+*/
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/AboutPage.qml
^
|
| @@ -39,6 +39,13 @@
import Sailfish.Silica 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype AboutPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+ \brief Shows brief information about the app, with links to Credits, Attributions etc.
+*/
+
Page {
SilicaFlickable {
id: flick
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/DevelopersPage.qml
^
|
| @@ -38,6 +38,13 @@
import QtQuick 2.0
import Sailfish.Silica 1.0
+/*! \qmltype DevelopersPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+ \brief Shows detailed information about the present and past developers of the App.
+*/
+
Page {
id: container
ListModel {
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/ItemErrorComponent.qml
^
|
| @@ -33,11 +33,25 @@
import QtQuick 2.0
import Sailfish.Silica 1.0
+/*! \qmltype ItemErrorComponent
+
+ \ingroup qml-plugin-components
+ \brief Shows an error message.
+*/
+
Rectangle {
id: errorMessage
anchors.fill: parent
color: Theme.rgba(Theme.highlightBackgroundColor, Theme.highlightBackgroundOpacity)
+ /*! \qmlproperty string text
+ This property holds the text for the error message.
+ */
property alias text: titleLabel.text
+ /*! \qmlproperty int timeout
+ This property specifies how long the message is shown (in milliseconds)
+
+ \sa {https://doc.qt.io/qt-5/qml-qtqml-timer.html#interval-prop}{Timer::interval}
+ */
property alias timeout: destroyTimer.interval
Component.onCompleted: {
if (parent.contentItem) {
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/PatchManagerPage.qml
^
|
| @@ -40,6 +40,27 @@
import Nemo.Configuration 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype PatchManagerPage
+
+ \ingroup qml-plugin-components
+ \brief The main Patchmanager GUI
+
+ Page shown through the Jolla Settings Plugin from the Settings Application.
+
+ It is a both a front-end to the Daemon and a Patch management application.
+
+ It allows to:
+
+ \list
+ \li View the list of installed and activated Patches.
+ \li Configure the Application and Daemon settings.
+ \li Activate or deactivate Patches
+ \li Install Patches from the \l {Patchmanager Web Catalog}{Web Catalog}
+ \li Uninstall installed Patches
+ \endlist
+
+*/
+
Page {
id: container
@@ -57,6 +78,10 @@
}
Component.onCompleted: migrateDevModeSettings()
+ /*! \qmlmethod migrateDevModeSettings()
+ Manages migration from legacy \e developerMode setting to the new \e patchDevelMode and \e sfosVersionCheck settings, then sets \e developerMode to \e false.
+ \internal
+ */
function migrateDevModeSettings() {
if (PatchManager.developerMode === true) {
console.info("Migrating settings from deprecated developerMode setting.")
@@ -98,6 +123,12 @@
}
}
+ /*! \qmlmethod function showUpdates(manual)
+
+ Flashes the Pulley Menu if updates are available and \a manual is \c false.
+ Does nothing if \a manual is \c true.
+
+ */
function showUpdates(manual) {
if (pageStack.busy) {
return
@@ -109,6 +140,12 @@
pulleyAnimation.start()
}
+ /*! \qmlproperty real PatchManagerPage::pullDownDistance
+ \internal
+ Amount of space the pulley "pops down" when it's showing a hint, e.g the result of showUpdates().
+
+ \warning This is probably broken in recent SFOS versions (?).
+ */
property real pullDownDistance: Theme.itemSizeLarge
SequentialAnimation {
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/PatchObject.cpp
^
|
| @@ -42,6 +42,21 @@
#include <QDBusPendingReply>
#include <QJSEngine>
+/*! \qmltype PatchObject
+ \instantiates PatchObject
+ \inqmlmodule org.SfietKonstantin.patchmanager
+ \brief An element to be used as content of an \l {PatchManagerModel}
+*/
+/*! \fn void PatchObject::toBeDestroyed(PatchObject *object);
+ This signal is emitted when \a object is about to be destroyed. (Duh.)
+ */
+/*! \qmlsignal PatchObject::toBeDestroyed(PatchObject object);
+ This signal is emitted when \a object is about to be destroyed. (Duh.)
+*/
+/*! \qmlsignal PatchObject::busyChanged();
+ \internal
+*/
+
PatchObject::PatchObject(const QVariantMap &data, QObject *parent)
: QObject(parent)
, m_details(new QQmlPropertyMap(parent))
@@ -60,22 +75,49 @@
setObjectName(m_details->value(QStringLiteral("patch")).toString());
}
+/*! \class PatchObject
+ \inmodule org.SfietKonstantin.patchmanager
+ \brief An element to be used as content of an \l {PatchManagerModel}
+*/
PatchObject::~PatchObject()
{
qDebug() << Q_FUNC_INFO;
emit toBeDestroyed(this);
}
+/*! \qmlproperty var PatchObject::details
+
+ Holds the Patch metadata.
+*/
+/*! \property PatchObject::details
+ \inheaderfile PatchObject.hpp
+
+ \sa {https://doc.qt.io/qt-5/qqmlpropertymap.html}{QQmlPropertyMap}
+ */
QQmlPropertyMap *PatchObject::details()
{
return m_details;
}
-bool PatchObject:: busy() const
+/*! \qmlproperty bool PatchObject::busy
+
+ \c true when an internal operation is in progress.
+*/
+/*! \property PatchObject::busy
+ \inheaderfile PatchObject.hpp
+ \c true when an internal operation is in progress.
+ */
+/*! Returns \c true when an internal operation is in progress. */
+bool PatchObject::busy() const
{
return m_busy;
}
+/*!
+ Fills the PatchObject's properties from \a data.
+
+ \note If there is a "display_name" field in \a data, it is used. Otherwise, patch name is used.
+*/
void PatchObject::setData(const QVariantMap &data)
{
for (const QString &key : data.keys()) {
@@ -90,6 +132,12 @@
}
}
+/*!
+ Calls PatchManager::applyPatch with the patch name. If \a callback is callable, calls it afterwards.
+ Does nothing if the \c "patched" property is \c true.
+
+ \sa PatchManager::applyPatch
+*/
void PatchObject::apply(QJSValue callback)
{
qDebug() << Q_FUNC_INFO;
@@ -127,6 +175,12 @@
});
}
+/*!
+ Calls PatchManager::unapplyPatch() with the patch name. If \a callback is callable, calls it afterwards.
+ Does nothing if the \c "patched" property is \c false.
+
+ \sa PatchManager::unapplyPatch
+*/
void PatchObject::unapply(QJSValue callback)
{
qDebug() << Q_FUNC_INFO;
@@ -164,6 +218,7 @@
});
}
+/*! Calls PatchManager::uninstallPatch with the patch name. */
void PatchObject::uninstall()
{
qDebug() << Q_FUNC_INFO;
@@ -185,6 +240,7 @@
});
}
+/*! Calls PatchManager::resetState. */
void PatchObject::resetState()
{
qDebug() << Q_FUNC_INFO;
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/RestartServicesDialog.qml
^
|
| @@ -39,6 +39,19 @@
import Sailfish.Silica 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype RestartServicesDialog
+
+ \ingroup qml-plugin-components
+ \brief Service restart confirmation dialog
+
+ This Dialog is shown to the user to confirm restarting of "Services", i.e.
+ anything that has been affected by activated patches.
+
+ If accepted, these programs will be killed.
+
+ The services to kill are selected via the \c category field of Patch metadata.
+
+*/
Dialog {
id: container
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/ScreenshotsPage.qml
^
|
| @@ -34,9 +34,28 @@
import Sailfish.Silica 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype ScreenshotsPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+ \brief Shows Screenshots available for a Patch from \l {Patchmanager Web Catalog}{Web Catalog} in a full-screen view.
+
+ \sa {https://sailfishos.org/develop/docs/silica/qml-sailfishsilica-sailfish-silica-slideshowview.html}{SlideshowView}
+*/
+
Page {
id: page
+
+ /*! \qmlproperty model model
+ This property holds the model providing data for the slideshow.
+ \sa {https://sailfishos.org/develop/docs/silica/qml-sailfishsilica-sailfish-silica-slideshowview.html#model}{SlideshowView}
+ */
property alias model: view.model
+
+ /*! \qmlproperty int currentIndex
+ The \c index of the currently shown Item
+ \sa {https://sailfishos.org/develop/docs/silica/qml-sailfishsilica-sailfish-silica-slideshowview.html#model}{SlideshowView}
+ */
property alias currentIndex: view.currentIndex
showNavigationIndicator: !view.interactive
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/SettingsPage.qml
^
|
| @@ -41,13 +41,27 @@
import Nemo.Configuration 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype SettingsPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+
+ \brief Manages Application Settings, both global and user-specific ones
+
+ The usual, system-wide configuration values are set via D-Bus plugin by the
+ Patchmanager daemon, which stores them in \c{/etc/patchmanager2.conf}
+ The configuration group \c uisettings is for settings which \e solely affect
+ the PM GUI application and consequently also are per-user settings.
+
+*/
Page {
- /*
- * The usual, system-wide configuration values are set via D-Bus plugin by the
- * Patchmanager daemon, which stores them in /etc/patchmanager2.conf
- * This configuration group "uisettings" is for settings which *solely* affect
- * the PM GUI application and consequently also are per-user settings.
+ /*! \qmlproperty ConfigurationGroup uisettings
+
+ Manages user-specific properties.
+
+ The DConf path for these is \c /org/SfietKonstantin/patchmanager/uisettings
+
*/
ConfigurationGroup {
id: uisettings
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/UnifiedPatchPage.qml
^
|
| @@ -40,11 +40,34 @@
import Nemo.Notifications 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype UnifiedPatchPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+ \brief Shows details about an installed Patch.
+*/
Page {
id: container
+ /*! \qmlproperty var modelData
+ The model date whose contents are to be displayed.
+ */
property var modelData
+
+ /*! \qmlproperty var delegate
+ The delegate Component to use to display modelData
+ */
property var delegate
+
+ /*! \qmlproperty bool legacyPatch
+ \c true if the Patch uses the legacy metadata format
+
+ Legacy Patches have less and different properties to display.
+ */
property bool legacyPatch: !modelData.isNewPatch
+
+ /*! \qmlsignal doPatch
+ This signal is emitted when the user chooses to activate the Patch.
+ */
signal doPatch
Notification {
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/WebCatalogPage.qml
^
|
| @@ -40,12 +40,54 @@
import org.nemomobile.dbus 2.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype WebCatalogPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+ \brief Shows the list of Patches available in the Web Catalog.
+
+ It also provides a search interface, and can order the list by either
+ date, or category.
+
+ Per default, displays all Patches. If author is set, displays only Patches
+ by one author/Patch Developer.
+
+ \sa {Patchmanager Web Catalog}{Web Catalog}, author
+*/
+
Page {
id: container
+ /*! \qmlproperty string author
+ This property holds the name of the Patch developer, if WebPatchPage is in "author-only" mode.
+
+ \sa {https://github.com/sailfishos-patches/patchmanager/blob/master/README.md#the-json-metadata-file}{Patch JSON metadata file}
+ */
property string author
+
+ /*! \qmlproperty var versions
+ This property holds the versions of all the patches in the list.
+ It is used for update checking.
+ \warning exact function of this needs to be researched
+ */
property var versions
+
+ /*! \qmlproperty string search
+ This property holds the user-supplied search string
+ */
property string search
+
+ /*! \qmlproperty bool searchVisible
+ If \c true shows the search field
+ */
property bool searchVisible
+
+ /*! \qmlproperty bool sortByDate
+ If \c true, the list is sorted by Patch \c updated_date. Otherwise it is sorted by \c category.
+
+ Default \c true
+
+ \sa {https://github.com/sailfishos-patches/patchmanager/blob/master/README.md#the-json-metadata-file}{Patch JSON metadata file}
+ */
property bool sortByDate: true
onStatusChanged: {
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/WebPatchPage.qml
^
|
| @@ -39,18 +39,72 @@
import Sailfish.Silica 1.0
import org.SfietKonstantin.patchmanager 2.0
+/*! \qmltype WebPatchPage
+
+ \ingroup qml-plugin-components
+ \inherits Page
+ \brief Shows details about a Patch from the Web Catalog
+
+ \sa {Patchmanager Web Catalog}{Web Catalog}, {https://github.com/sailfishos-patches/patchmanager/blob/master/README.md#the-json-metadata-file}{Patch JSON metadata file}
+*/
+
+
Page {
id: container
objectName: "WebPatchPage"
+ /*! \qmlproperty var modelData
+ This property holds the metadata from the model
+
+ \sa PatchManagerModel, PatchObject
+ */
property var modelData
+ /*! \qmlproperty var versions
+ This property holds a map of patch \c{[name, [versions]]}
+ */
property var versions
+
+ /*! \qmlproperty int voteAction
+ State of the like/dislike voting action
+
+ \table
+ \header
+ \li Meaning
+ \li Value
+ \row
+ \li Like
+ \li 2
+ \row
+ \li Dislike
+ \li 1
+ \row
+ \li Not Voted
+ \li 0
+ \endtable
+
+ \sa PatchManager::checkVote
+ */
property int voteAction
+ /*! \qmlproperty bool isInstalled
+ \c true if a version of the patch is currently installed
+ */
property bool isInstalled: !!container.versions && typeof(container.versions[modelData.name]) != "undefined"
+ /*! \qmlproperty var patchData
+ This property holds the metadata downloaded from the Web Catalog
+
+ \sa modelData
+ */
property var patchData
+
+ /*! \qmlproperty bool fetching
+
+ Indicates whether data is currently being downloaded. The WebPatchPage will show a ViewPlaceholder if true.
+
+ Default \c true
+ */
property bool fetching: true
onStatusChanged: {
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/patchmanager.cpp
^
|
| @@ -69,6 +69,13 @@
QT_TRANSLATE_NOOP("Sections", "keyboard"),
};
+/*! \class PatchManager
+ \inheaderfile patchmanager.h
+ \inmodule org.SfietKonstantin.patchmanager
+
+ \brief Patchmanager QML Plugin
+*/
+
PatchManager::PatchManager(QObject *parent)
: QObject(parent)
, m_nam(new QNetworkAccessManager(this))
@@ -172,6 +179,8 @@
m_osVersion = QSettings("/etc/os-release", QSettings::IniFormat).value("VERSION_ID").toString();
}
+/*! Returns a singleton instance of \e PatchManager, constructing it using \a parent if necessary.
+ */
PatchManager *PatchManager::GetInstance(QObject *parent)
{
static PatchManager* lsSingleton = nullptr;
@@ -224,11 +233,18 @@
}
}
+/*! \property PatchManager::applyOnBoot
+ Whether to apply patches on boot or not.
+*/
bool PatchManager::applyOnBoot() const
{
return getSettingsSync(QStringLiteral("applyOnBoot"), false).toBool();
}
+
+/*! \property PatchManager::mangleCandidates
+ List of mangle candidates from the config
+*/
QStringList PatchManager::mangleCandidates() const
{
QDBusPendingReply<QStringList> reply = m_interface->getMangleCandidates();
@@ -240,6 +256,10 @@
return QStringList();
}
+/*!
+ Saves the \e applyOnBoot settings value to \a applyOnBoot
+ \sa applyOnBootChanged(bool value)
+*/
void PatchManager::setApplyOnBoot(bool applyOnBoot)
{
if (putSettingsSync(QStringLiteral("applyOnBoot"), applyOnBoot)) {
@@ -247,6 +267,21 @@
}
}
+/* \property PatchManager::appsNeedRestart
+ \inheaderfile: patchmanager.h
+ Whether services need to be restarted
+*/
+/* \qmlproperty bool PatchManager::appsNeedRestart
+ \inheaderfile: patchmanager.h
+ Whether services need to be restarted
+*/
+/*! \property PatchManager::notifyOnSuccess
+ Whether to show a popup on successful actions
+*/
+/*! \qmlproperty bool PatchManager::notifyOnSuccess
+ \inheaderfile: patchmanager.h
+ Whether to show a popup on successful actions
+*/
bool PatchManager::notifyOnSuccess() const
{
return getSettingsSync(QStringLiteral("notifyOnSuccess"), true).toBool();
@@ -259,6 +294,10 @@
}
}
+/*! \property PatchManager::bitnessMangle
+*/
+/*! \qmlproperty bool PatchManager::bitnessMangle
+*/
bool PatchManager::bitnessMangle() const
{
return getSettingsSync(QStringLiteral("bitnessMangle"), false).toBool();
@@ -276,6 +315,11 @@
return m_installedModel;
}
+/*!
+ Helper for SectionHeader titles. Looks up translations for \a category.
+ Returns the translated string.
+ \sa {https://sailfishos.org/develop/docs/silica/qml-sailfishsilica-sailfish-silica-sectionheader.html/}
+*/
QString PatchManager::trCategory(const QString &category) const
{
const QString section = qApp->translate("Sections", category.toLatin1().constData());
@@ -324,11 +368,16 @@
return m_failed;
}
+/*! \property PatchManager::loaded
+*/
+/*! \qmlproperty bool PatchManager::loaded
+*/
bool PatchManager::loaded() const
{
return m_loaded;
}
+/*! Calls \a call via D-Bus */
void PatchManager::call(QDBusPendingCallWatcher *call)
{
connect(call,
@@ -359,6 +408,7 @@
});
}
+/*! Request daemon to apply (activate) the Patch named \a patch */
QDBusPendingCallWatcher* PatchManager::applyPatch(const QString &patch)
{
qDebug() << Q_FUNC_INFO;
@@ -366,6 +416,7 @@
return new QDBusPendingCallWatcher(m_interface->applyPatch(patch), this);
}
+/*! Request daemon to unapply (deactivate) the Patch named \a patch */
QDBusPendingCallWatcher* PatchManager::unapplyPatch(const QString &patch)
{
qDebug() << Q_FUNC_INFO;
@@ -373,6 +424,11 @@
return new QDBusPendingCallWatcher(m_interface->unapplyPatch(patch), this);
}
+/*!
+ Request daemon to download and install the Patch named \a patch, version \a version from \a url
+
+ \sa {} {PatchManagerInterface::installPatch(const QString &patch, const QString &version, const QString &url)}
+*/
QDBusPendingCallWatcher *PatchManager::installPatch(const QString &patch, const QString &version, const QString &url)
{
qDebug() << Q_FUNC_INFO;
@@ -380,6 +436,7 @@
return new QDBusPendingCallWatcher(m_interface->installPatch(patch, version, url), this);
}
+/*! Request daemon to uninstall the Patch named \a patch */
QDBusPendingCallWatcher *PatchManager::uninstallPatch(const QString &patch)
{
qDebug() << Q_FUNC_INFO;
@@ -387,6 +444,9 @@
return new QDBusPendingCallWatcher(m_interface->uninstallPatch(patch), this);
}
+/*! Request the daemon to do ... with \a patch
+ \warning method not investigated, need documentation
+*/
QDBusPendingCallWatcher *PatchManager::resetState(const QString &patch)
{
qDebug() << Q_FUNC_INFO;
@@ -394,6 +454,10 @@
return new QDBusPendingCallWatcher(m_interface->resetState(patch), this);
}
+/*!
+ Request daemon to retrieve the \l {Patchmanager Web Catalog}{Web Catalog}.
+ Can be configred by \a params
+*/
QDBusPendingCallWatcher *PatchManager::downloadCatalog(const QVariantMap ¶ms)
{
qDebug() << Q_FUNC_INFO;
@@ -401,6 +465,7 @@
return new QDBusPendingCallWatcher(m_interface->downloadCatalog(params), this);
}
+/*! Request daemon to download patch info for patch \a name */
QDBusPendingCallWatcher *PatchManager::downloadPatchInfo(const QString &name)
{
qDebug() << Q_FUNC_INFO;
@@ -408,6 +473,11 @@
return new QDBusPendingCallWatcher(m_interface->downloadPatchInfo(name), this);
}
+/*!
+ Request daemon to list patch versions.
+
+ \sa PatchManagerObject::listVersions()
+*/
QDBusPendingCallWatcher *PatchManager::listVersions()
{
qDebug() << Q_FUNC_INFO;
@@ -415,6 +485,7 @@
return new QDBusPendingCallWatcher(m_interface->listVersions(), this);
}
+/*! Request daemon to unapply (deactivate) all active patches. */
QDBusPendingCallWatcher *PatchManager::unapplyAllPatches()
{
qDebug() << Q_FUNC_INFO;
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/patchmanager.h
^
|
| @@ -66,7 +66,7 @@
enum CheckMode {
Strict,
NoCheck,
- //Relaxed, // TODO, Issue #322, also see https://github.com/sailfishos-patches/patchmanager/issues/333#issuecomment-1374118045
+ //Relaxed, // TODO, see issue #322, also see https://github.com/sailfishos-patches/patchmanager/issues/333#issuecomment-1374118045
};
Q_ENUM(CheckMode)
private:
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/patchmanagermodel.cpp
^
|
| @@ -37,11 +37,39 @@
#include <QDBusPendingReply>
#include <QDebug>
+/*! \qmltype PatchManagerModel
+ \instantiates PatchManagerModel
+ \inqmlmodule org.SfietKonstantin.patchmanager
+ \brief A ListModel containing the metadata of Patches.
+*/
PatchManagerModel::PatchManagerModel(QObject *parent)
: QAbstractListModel(parent)
{
}
+/*! \class PatchManagerModel
+ \inheaderfile patchmanagermodel.h
+ \inmodule org.SfietKonstantin.patchmanager
+ \brief A ListModel containing the metadata of Patches.
+
+ Currently it defines the following Roles:
+ \table
+ \header
+ \li Qt Role
+ \li QML Role Name
+ \row
+ \li \l{https://doc.qt.io/qt-5/qt.html#ItemDataRole-enum}{Qt::DisplayRole}
+ \li name
+ \row
+ \li \l{https://doc.qt.io/qt-5/qt.html#ItemDataRole-enum}{Qt::DecorationRole}
+ \li section
+ \row
+ \li \l{https://doc.qt.io/qt-5/qt.html#ItemDataRole-enum}{Qt::EditRole}
+ \li patchObject
+ \endtable
+
+ \sa {https://doc.qt.io/qt-5/qabstractitemmodel.html}{Qt::QAbstractItemModel}
+*/
PatchManagerModel::PatchManagerModel(const QList<PatchObject *> &data, QObject *parent)
: QAbstractListModel(parent)
, m_modelData(data)
@@ -78,11 +106,16 @@
return r;
}
+// /*! \qmlproperty var PatchManagerModel::patches
+// Contains the list of patches
+// */
+/*! Returns the list of patches */
QList<PatchObject *> PatchManagerModel::patches() const
{
return m_modelData;
}
+/*! clears the model data and sets \a patches as new model data. */
void PatchManagerModel::setPatches(const QList<PatchObject *> &patches)
{
qDebug() << Q_FUNC_INFO << patches.length();
@@ -102,6 +135,22 @@
endResetModel();
}
+/*!
+ Does nothing if both \a data and \a patch are empty.
+
+ If \a patch is empty, and we have \a data, extracts the patch name from \a
+ data and adds the metadata to the model.
+
+ If we have \a patch and \a data, and \a installed is \c true, add the data
+ to the model.
+
+ If we have \a patch and \a data, and \a installed is \c false, just create
+ a PatchObject from \a data.
+
+ \warning that last part is not yet documented.
+
+ \sa saveLayout()
+*/
void PatchManagerModel::populateData(const QVariantList &data, const QString &patch, bool installed)
{
qDebug() << Q_FUNC_INFO << data.length();
@@ -190,6 +239,7 @@
saveLayout();
}
+/*! removes the patch with the name \a patch from the model. */
void PatchManagerModel::removePatch(const QString &patch)
{
qDebug() << Q_FUNC_INFO << patch;
@@ -210,6 +260,7 @@
saveLayout();
}
+/*! Moves an entry from index \a from to index \a to */
void PatchManagerModel::move(int from, int to)
{
if (from == to) {
@@ -220,6 +271,7 @@
endMoveRows();
}
+/*! Saves the current order of patch names to Settings. */
void PatchManagerModel::saveLayout()
{
QStringList patches;
@@ -230,6 +282,7 @@
PatchManager::GetInstance()->putSettingsAsync(QStringLiteral("order"), patches);
}
+/*! Returns the \e display_name of \a patch. */
QString PatchManagerModel::patchName(const QString &patch) const
{
if (!m_patchMap.contains(patch)) {
@@ -239,6 +292,7 @@
return m_patchMap[patch]->details()->value(QStringLiteral("display_name")).toString();
}
+/*! Returns /c true if patch \a name is in the list of applied (activated) patches. */
bool PatchManagerModel::isApplied(const QString &name) const
{
// FIXME: there certainly is a more efficient way, e.g. std::find_if?
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/plugin.cpp
^
|
| @@ -54,6 +54,92 @@
return PatchManagerTranslator::GetInstance(engine);
}
+/***** PatchManager ******/
+/*! \qmltype PatchManager
+ \instantiates PatchManager
+ \inqmlmodule org.SfietKonstantin.patchmanager
+
+ \brief Singleton providing access to the \l [C++]{PatchManager} methods and properties.
+*/
+/*! \qmlproperty string PatchManager::appsToRestart
+ List of applications and services that should be restarted after a patch has been activated.
+ \sa PatchManager::toggleServicesList
+*/
+/*! \qmlproperty bool PatchManager::developerMode
+ \deprecated
+ \sa {Patchmanager Configuration Files}, inifile
+*/
+/*! \qmlproperty bool PatchManager::failure
+ If \c true, PM is in Failure Mode.
+*/
+/*! \qmlproperty string PatchManager::osVersion
+ This property holds the Operating System version. This is used for version checking.
+*/
+/*! \qmlproperty bool PatchManager::patchDevelMode
+ \sa {Patchmanager Configuration Files}, inifile
+*/
+/*! \qmlproperty string PatchManager::patchmanagerVersion
+ This property holds our own version
+*/
+/*! \qmlproperty string PatchManager::serverMediaUrl
+ This poperty holds the URL to download screenshots from.
+*/
+/*! \qmlproperty int PatchManager::sfosVersionCheck
+ This property keeps the setting of VersionCheck
+ \sa PatchManagerVersionCheck::CheckMode
+*/
+/*! \qmlproperty var PatchManager::updates
+ Map of internal names and metadata of patches which can be updated.
+ \sa PatchManagerObject::getUpdates, dbus-sys
+*/
+/*! \qmlproperty var PatchManager::updatesNames
+ List of display names of patches which can be updated.
+ \sa PatchManagerObject::getUpdates, dbus-sys
+*/
+
+/***** PatchManagerTranslator ******/
+/*! \qmltype PatchManagerTranslator
+ \instantiates PatchManagerTranslator
+ \inqmlmodule org.SfietKonstantin.patchmanager
+
+ \brief This Singleton allows patches to include localizations in their shipped QML files.
+
+ To use, add:
+
+ \code
+ import org.SfietKonstantin.patchmanager 2.0
+ \endcode
+
+ In the root item add:
+
+ \code
+ property bool pmTranslationLoaded: PatchManagerTranslator ? PatchManagerTranslator.installTranslator("my-patch-name") : false}
+ \endcode
+
+ In the first visible text item replace text with following:
+
+ \code
+ pmTranslationLoaded ? qsTr("Translated text") : "Please update patchmanager!"
+ \endcode
+
+ If translation is not loaded try using qsTranslate() strings instead:
+
+ \code
+ pmTranslationLoaded ? qsTranslate("pm", "Translated text") : "Please update patchmanager!"
+ \endcode
+
+*/
+/*! \qmlproperty bool PatchManagerTranslator::pmTranslationLoaded
+ \c true when the PatchManagerTranslator has been loaded/initialized successfully.
+*/
+
+/***** WebPatchesModel ******/
+/*! \qmltype WebPatchesModel
+ \instantiates WebPatchesModel
+ \inqmlmodule org.SfietKonstantin.patchmanager
+
+ \brief Holds elements from the \l {Patchmanager Web Catalog}{Web Catalog}.
+*/
class PatchManagerPlugin : public QQmlExtensionPlugin
{
Q_OBJECT
|
|
[-]
[+]
|
Added |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/qmlplugin.qdoc
^
|
| @@ -0,0 +1,44 @@
+/*!
+ \page index.html
+ \title Patchmanager Documentation: QML Plugin
+ \indexpage Patchmanager Documentation
+
+ \section1 Overview
+
+ The QML Plugin makes up the main Patchmanager GUI Application.
+
+ Jolla Settings loads PatchManagerPage from the QML Plugin.
+
+ It is a both a front-end to the Daemon and a Patch management application.
+
+ It allows to:
+
+ \list
+ \li View the list of installed and activated Patches.
+ \li Configure the Application and Daemon settings.
+ \li Activate or deactivate Patches
+ \li Install Patches from the Web Catalog
+ \li Uninstall installed Patches
+ \endlist
+
+ \section2 QML Components:
+
+ \generatelist{overviews}
+
+ \section2 QML types:
+
+ \generatelist{qmltypesbymodule org.SfietKonstantin.patchmanager}
+
+ \section2 C++ classes:
+
+ \generatelist{classesbymodule org.SfietKonstantin.patchmanager}
+
+*/
+
+/*!
+ \group qml-plugin-components
+ \title QML Components
+
+ \brief Pages and other components shipped with the QML Plugin
+
+*/
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/webdownloader.cpp
^
|
| @@ -33,12 +33,34 @@
#include "webdownloader.h"
#include "webcatalog.h"
+/*! \qmltype WebDownloader
+ \instantiates WebDownloader
+ \inqmlmodule org.SfietKonstantin.patchmanager
+ \brief Downloads Patch archives from the \l {Patchmanager Web Catalog}{Web Catalog}
+*/
+/*! \qmlsignal WebDownloader::downloadFinished(const QString & patch, const QString & fileName)
+ This signal is emitted when \a patch has finished downloading, resulting in \a fileName.
+*/
+/*! \qmlsignal WebDownloader::downloadError()
+ This signal is emitted when a download failed.
+*/
+/*! \class WebDownloader
+ \inmodule org.SfietKonstantin.patchmanager
+ \brief Downloads Patch archives from the \l {Patchmanager Web Catalog}{Web Catalog}
+*/
+/*! \fn void WebDownloader::downloadError()
+ This signal is emitted when a download failed.
+*/
+/*! \fn void WebDownloader::downloadFinished(const QString &patch, const QString &fileName)
+ This signal is emitted when \a patch has finished downloading, resulting in \a fileName.
+*/
WebDownloader::WebDownloader(QObject *parent) : QObject(parent)
{
_nam = new QNetworkAccessManager(this);
_file = new QFile(this);
}
+/*! starts the download, using compile-time variable \e MEDIA_URL as source. */
void WebDownloader::start()
{
_file->setFileName(destination);
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/qml/webpatchesmodel.cpp
^
|
| @@ -38,6 +38,48 @@
#include <algorithm>
+/*! \class WebPatchesModel
+ \inmodule org.SfietKonstantin.patchmanager
+ \brief The WebPatchesModel holds elements from the \l {Patchmanager Web Catalog}{Web Catalog}.
+
+ Roles follow the Patch JSON format, hence the following are defined:
+
+ \table
+ \header
+ \li Qt Role
+ \li QML Role Name
+ \row
+ \li {Qt::UserRole}
+ \li description
+ \row
+ \li {Qt::UserRole}
+ \li last_updated
+ \row
+ \li {Qt::UserRole}
+ \li name
+ \row
+ \li {Qt::UserRole}
+ \li display_name
+ \row
+ \li {Qt::UserRole}
+ \li category
+ \row
+ \li {Qt::UserRole}
+ \li author
+ \row
+ \li {Qt::UserRole}
+ \li rating
+ \row
+ \li {Qt::UserRole}
+ \li total_activations
+ \endtable
+
+ \sa {https://doc.qt.io/qt-5/qabstractitemmodel.html}{Qt::QAbstractItemModel}
+*/
+/*! \fn virtual QHash<int, QByteArray> WebPatchesModel::roleNames() const
+ Returns the model's role names.
+
+*/
WebPatchesModel::WebPatchesModel(QObject * parent)
: QAbstractListModel(parent)
{
@@ -63,6 +105,27 @@
{
}
+/*! \property WebPatchesModel::sorted
+ \c true when the model is sorted
+*/
+/*! \qmlproperty bool WebPatchesModel::sorted
+ \c true when the model is sorted
+
+ The corresponding signal is sortedChanged
+*/
+/*! \qmlsignal WebPatchesModel::sortedChanged()
+ Emitted when \c sorted changed
+*/
+
+/*! \property WebPatchesModel::queryParams
+ Query parameters
+*/
+/*! \qmlproperty var WebPatchesModel::queryParams
+ Query parameters
+*/
+/*! \qmlsignal WebPatchesModel::queryParamsChanged()
+ Emitted when query parameters change
+*/
QVariantMap WebPatchesModel::queryParams() const
{
return _queryParams;
@@ -89,6 +152,7 @@
}
}
+/*! \warning need to investigate what this is for... */
void WebPatchesModel::classBegin()
{
@@ -104,6 +168,12 @@
return a.compare(b, Qt::CaseInsensitive) < 0;
}
+/*!
+ Retrieves the list of patches from the \l {Patchmanager Web Catalog}{Web Catalog}, and populates the model
+ with its contents, sorting them if necessary.
+
+ \sa setSorted()
+*/
void WebPatchesModel::componentComplete()
{
if (_modelData.size() > 0) {
@@ -158,12 +228,14 @@
});
}
+/*! Returns the row count. \note \a parent is unused */
int WebPatchesModel::rowCount(const QModelIndex & parent) const
{
Q_UNUSED(parent);
return _modelData.count();
}
+/*! Returns the data stored under the given \a role for the item referred to by the \a index. */
QVariant WebPatchesModel::data(const QModelIndex & index, int role) const
{
int row = index.row();
@@ -171,3 +243,4 @@
return QVariant();
return _modelData[index.row()].toMap()[_roles[role]];
}
+
|
|
[-]
[+]
|
Changed |
_service:tar_git:patchmanager-3.2.11.tar.gz/src/tools/patchmanager-tool
^
|
| @@ -11,21 +11,21 @@
function surplus() {
if [ -n "$*" ]; then
printf 'Too many parameters: %s\n' "$*" >&2
- printf 'Call "%s -h" for a help page.\n' "$called" >&2
+ printf 'Call "%s -?" for a help page.\n' "$called" >&2
exit 1
fi
}
function usage() {
printf "Patchmanager tool is a front-end for the patchmanager executable.\n"
- printf "USAGE: %s [-a|-A|-d|-D|-e|-h] [<patchlist>|-f <filepath>]\n" "$called"
+ printf "USAGE: %s [-a|-A|-d|-D|-e|-?] [<patchlist>|-f <filepath>]\n" "$called"
printf "\t-a | --activate\t\t\tActivate / apply Patches from list or file (via -f).\n"
printf "\t-A | --activate-all\t\tActivate / apply all Patches formerly marked as active.\n"
printf "\t-d | --deactivate\t\tDeactivate / unapply Patches from list or file (via -f).\n"
printf "\t-D | --deactivate-all\t\tDeactivate / unapply all Patches.\n"
printf "\t-f | --file <filepath>\t\tUse <filepath> for the list of Patches.\n"
printf "\t-e | --export\t\t\tExport list of Patches marked as active either to STDout or (via -f) to a file.\n"
- printf "\t-h | --help\t\t\tPrint this help.\n"
+ printf "\t-? | --help\t\t\tPrint this help.\n"
printf "* The <patchlist> must be comprised of (internal) names of Patches, separated by white-spaces, commas or both.\n"
printf "* For writing to <filepath>, it must not already exist and must be in a writable directory.\n"
printf "* For reading from <filepath>, it must be a plain text file containing the (internal) names of Patches, separated by white-spaces, commas or both.\n"
@@ -63,19 +63,16 @@
operation="-a"
shift
surplus "$*"
+ if [ -r $PM_CONF ] && [ -s $PM_CONF ] && [ -f $PM_CONF ]; then
+ patchlist="$(grep '^applied=' $PM_CONF | cut -s -d "=" -f 2- | tr ',[:blank:]' ' ' | tr -s ' ')"
else
- if [ -r $PM_CONF ] && [ -s $PM_CONF ] && [ -f $PM_CONF ]; then
- patchlist="$(grep '^applied=' $PM_CONF | cut -s -d "=" -f 2- | tr ',[:blank:]' ' ' | tr -s ' ')"
- else
- printf 'File "%s" does not exist, is empty, not readable or not a regular file!\n' $PM_CONF >&2
- exit 2
- fi
+ printf 'File "%s" does not exist, is empty, not readable or not a regular file!\n' $PM_CONF >&2
+ exit 2
fi
;;
-d|-u|--deactivate)
operation="-u"
shift
- shift
if [ "$1" = "-f" ] || [ "$1" = "--file" ]; then
shift
filepath="$1"
@@ -103,39 +100,46 @@
;;
-e|--export)
shift
- if [ "$1" = "-f" ] || [ "$1" = "--file" ]; then
- shift
- filepath="$1"
- shift
- surplus "$*"
- if [ ! -w $(dirname "$filepath") ]; then
- printf 'Cannot write to given directory: %s\n' "$filepath" >&2
- exit 2
- elif [ -e "$filepath" ]; then
- printf 'File %s exists, will not overwrite.\n' "$filepath" >&2
- exit 2
+ if [ $# -ge 1 ]; then
+ if [ "$1" = "-f" ] || [ "$1" = "--file" ]; then
+ shift
+ filepath="$1"
+ shift
+ surplus "$*"
+ if [ ! -w $(dirname "$filepath") ]; then
+ printf 'Cannot write to given directory: %s\n' "$filepath" >&2
+ exit 2
+ elif [ -e "$filepath" ]; then
+ printf 'File %s exists, will not overwrite.\n' "$filepath" >&2
+ exit 2
+ else
+ grep '^applied=' $PM_CONF | cut -s -d "=" -f 2- > "$filepath"
+ exit 0
+ fi
else
- grep '^applied=' $PM_CONF | cut -s -d "=" -f 2- > "$filepath"
- exit 0
+ printf 'Unknown parameter: %s.\nIf you meant to export to a file, use "--export --file %s"\n' "$1" "$1" >&2
+ exit 1
fi
- surplus "$*"
- printf '%s\n' "$(grep '^applied=' $PM_CONF | cut -s -d "=" -f 2-)"
- exit 0
+ else
+ surplus "$*"
+ printf '%s\n' "$(grep '^applied=' $PM_CONF | cut -s -d "=" -f 2-)"
+ exit 0
+ fi
;;
- -h|--help)
+ -\?|--help)
usage
exit 0
;;
*)
printf 'Missing or wrong parameters!\n' >&2
- printf 'Call "%s -h" for a help page.\n' "$called" >&2
+ printf 'Call "%s -?" for a help page.\n' "$called" >&2
exit 1
;;
esac
if [ -z "$patchlist" ] || printf %s "$patchlist" | grep -q '[$&();<>|]'; then
printf 'Patchlist is empty or contains illegal characters!\n' >&2
- printf 'Call "%s -h" for a help page.\n' "$called" >&2
+ printf 'Call "%s -?" for a help page.\n' "$called" >&2
exit 1
fi
|
