Differential D20266 Diff 55471 applets/notifications/package/contents/ui/global/Globals.qml

Changeset View

Standalone View

applets/notifications/package/contents/ui/global/Globals.qml

This file was added.

		1		/*
		2		* Copyright 2019 Kai Uwe Broulik <kde@privat.broulik.de>
		3		*
		4		* This program is free software; you can redistribute it and/or
		5		* modify it under the terms of the GNU General Public License as
		6		* published by the Free Software Foundation; either version 2 of
		7		* the License or (at your option) version 3 or any later version
		8		* accepted by the membership of KDE e.V. (or its successor approved
		9		* by the membership of KDE e.V.), which shall act as a proxy
		10		* defined in Section 14 of version 3 of the license.
		11		*
		12		* This program is distributed in the hope that it will be useful,
		13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
		14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		15		* GNU General Public License for more details.
		16		*
		17		* You should have received a copy of the GNU General Public License
		18		* along with this program. If not, see <http://www.gnu.org/licenses/>
		19		*/
		20
		21		pragma Singleton
		22		import QtQuick 2.8
		23		import QtQuick.Layouts 1.1
		24
		25		import org.kde.plasma.plasmoid 2.0
		26		import org.kde.plasma.core 2.0 as PlasmaCore
		27		import org.kde.plasma.components 2.0 as Components
		28		import org.kde.kquickcontrolsaddons 2.0
		29
		30		import org.kde.notificationmanager 1.0 as NotificationManager
		31
		32		import ".."
		33
		34		// This singleton object contains stuff shared between all notification plasmoids, namely:
		35		// - Popup creation and placement
		36		// - Do not disturb mode
		37		QtObject {
		38		id: globals
		39
		40		// Listened to by "ago" label in NotificationHeader to update all of them in unison
		41		signal timeChanged
		42
		43		property bool inhibited: false
		44
		45		// Some parts of the code rely on plasmoid.nativeInterface and since we're in a singleton here
		46		// this is named "plasmoid"
		47		property QtObject plasmoid: plasmoids[0]
		48
		49		// HACK When a plasmoid is destroyed, QML sets its value to "null" in the Array
		50		// so we then remove it so we have a working "plasmoid" again
		51		onPlasmoidChanged: {
		52		if (!plasmoid) {
		53		// this doesn't emit a change, only in ratePlasmoids() it will detect the change
		54		plasmoids.splice(0, 1); // remove first
		55		ratePlasmoids();
		56		}
		57		}
		58
		59		// all notification plasmoids
		60		property var plasmoids: []
		61
		62		property int popupLocation: {
		63		switch (notificationSettings.popupPosition) {
		64		// Auto-determine location based on plasmoid location
		65		case NotificationManager.Settings.NearWidget:
		66		if (!plasmoid) {
		67		return Qt.AlignBottom \| Qt.AlignRight; // just in case
		68		}
		69
		70		var alignment = 0;
		71		if (plasmoid.location === PlasmaCore.Types.LeftEdge) {
		72		alignment \|= Qt.AlignLeft;
		73		} else if (plasmoid.location === PlasmaCore.Types.RightEdge) {
		74		alignment \|= Qt.AlignRight;
		75		} else {
		76		// would be nice to do plasmoid.compactRepresentationItem.mapToItem(null) and then
		77		// position the popups depending on the relative position within the panel
		78		alignment \|= Qt.application.layoutDirection === Qt.RightToLeft ? Qt.AlignLeft : Qt.AlignRight;
		79		}
		80		if (plasmoid.location === PlasmaCore.Types.TopEdge) {
		81		alignment \|= Qt.AlignTop;
		82		} else {
		83		alignment \|= Qt.AlignBottom;
		84		}
		85		return alignment;
		86
		87		case NotificationManager.Settings.TopLeft:
		88		return Qt.AlignTop \| Qt.AlignLeft;
		89		case NotificationManager.Settings.TopCenter:
		90		return Qt.AlignTop \| Qt.AlignHCenter;
		91		case NotificationManager.Settings.TopRight:
		92		return Qt.AlignTop \| Qt.AlignRight;
		93		case NotificationManager.Settings.BottomLeft:
		94		return Qt.AlignBottom \| Qt.AlignLeft;
		95		case NotificationManager.Settings.BottomCenter:
		96		return Qt.AlignBottom \| Qt.AlignHCenter;
		97		case NotificationManager.Settings.BottomRight:
		98		return Qt.AlignBottom \| Qt.AlignRight;
		99		}
		100		}
		101
		102		// The raw width of the popup's content item, the Dialog itself adds some margins
		103		property int popupWidth: units.gridUnit * 18
		104		property int popupEdgeDistance: units.largeSpacing
		105		property int popupSpacing: units.largeSpacing
		106
		107		// How much vertical screen real estate the notification popups may consume
		108		readonly property real popupMaximumScreenFill: 0.75
		109
		110		property var screenRect: plasmoid ? plasmoid.availableScreenRect : undefined
		111
		112		onPopupLocationChanged: Qt.callLater(positionPopups)
		113		onScreenRectChanged: Qt.callLater(positionPopups)
		114
		115		Component.onCompleted: checkInhibition()
		116
		117		function adopt(plasmoid) {
		118		// this doesn't emit a change, only in ratePlasmoids() it will detect the change
		119		globals.plasmoids.push(plasmoid);
		120		ratePlasmoids();
		121		}
		122
		123		// Sorts plasmoids based on a heuristic to find a suitable plasmoid to follow when placing popups
		124		function ratePlasmoids() {
		125		var plasmoidScore = function(plasmoid) {
		126		if (!plasmoid) {
		127		return 0;
		128		}
		129
		130		var score = 0;
		131
		132		// Prefer plasmoids in a panel, prefer horizontal panels over vertical ones
		133		if (plasmoid.location === PlasmaCore.Types.LeftEdge
		134		\|\| plasmoid.location === PlasmaCore.Types.RightEdge) {
		135		score += 1;
		136		} else if (plasmoid.location === PlasmaCore.Types.TopEdge
		137		\|\| plasmoid.location === PlasmaCore.Types.BottomEdge) {
		138		score += 2;
		139		}
		140
		141		// Prefer iconified plasmoids
		142		if (!plasmoid.expanded) {
		143		++score;
		144		}
		145
		146		// Prefer plasmoids on primary screen
		147		if (plasmoid.nativeInterface && plasmoid.nativeInterface.isPrimaryScreen(plasmoid.screenGeometry)) {
		148		++score;
		149		}
		150
		151		return score;
		152		}
		153
		154		var newPlasmoids = plasmoids;
		155		newPlasmoids.sort(function (a, b) {
		156		var scoreA = plasmoidScore(a);
		157		var scoreB = plasmoidScore(b);
		158		// Sort descending by score
		159		if (scoreA < scoreB) {
		160		return 1;
		161		} else if (scoreA > scoreB) {
		162		return -1;
		163		} else {
		164		return 0;
		165		}
		166		});
		167		globals.plasmoids = newPlasmoids;
		168		}
		169
		170		function checkInhibition() {
		171		globals.inhibited = Qt.binding(function() {
		172		var inhibited = false;
		173
		174		var inhibitedUntil = notificationSettings.notificationsInhibitedUntil;
		175		if (!isNaN(inhibitedUntil.getTime())) {
		176		inhibited \|= (new Date().getTime() < inhibitedUntil.getTime());
		177		}
		178
		179		if (notificationSettings.notificationsInhibitedByApplication) {
		180		inhibited \|= true;
		181		}
		182
		183		return inhibited;
		184		});
		185		}
		186
		187		function positionPopups() {
		188		var rect = screenRect;
		189		if (!rect \|\| rect.width <= 0 \|\| rect.height <= 0) {
		190		return;
		191		}
		192
		193		var y = screenRect.y;
		194		if (popupLocation & Qt.AlignBottom) {
		195		y += screenRect.height;
		196		} else {
		197		y += popupEdgeDistance;
		198		}
		199
		200		var x = screenRect.x;
		201		if (popupLocation & Qt.AlignLeft) {
		202		x += popupEdgeDistance;
		203		}
		204
		205		for (var i = 0; i < popupInstantiator.count; ++i) {
		206		var popup = popupInstantiator.objectAt(i);
		207
		208		if (popupLocation & Qt.AlignHCenter) {
		209		popup.x = x + (screenRect.width - popup.width) / 2;
		210		} else if (popupLocation & Qt.AlignRight) {
		211		popup.x = screenRect.width - popupEdgeDistance - popup.width;
		212		} else {
		213		popup.x = x;
		214		}
		215
		216		var delta = popupSpacing + popup.height;
		217
		218		if (popupLocation & Qt.AlignTop) {
		219		popup.y = y;
		220		y += delta;
		221		} else {
		222		y -= delta;
		223		popup.y = y;
		224		}
		225
		226		// don't let notifications take more than popupMaximumScreenFill of the screen
		227		var visible = true;
		228		if (i > 0) { // however always show at least one popup
		229		if (popupLocation & Qt.AlignTop) {
		230		visible = (popup.y + popup.height < screenRect.y + (screenRect.height * popupMaximumScreenFill));
		231		} else {
		232		visible = (popup.y > screenRect.y + (screenRect.height * (1 - popupMaximumScreenFill)));
		233		}
		234		}
		235
		236		// TODO would be nice to hide popups when systray or panel controller is open
		237		popup.visible = visible;
		238		}
		239		}
		240
		241		property QtObject popupNotificationsModel: NotificationManager.Notifications {
		242		limit: globals.screenRect ? (Math.ceil(globals.screenRect.height / (theme.mSize(theme.defaultFont).height * 4))) : 0
		243		showExpired: false
		244		showDismissed: false
		245		blacklistedDesktopEntries: notificationSettings.popupBlacklistedApplications
		246		blacklistedNotifyRcNames: notificationSettings.popupBlacklistedServices
		247		whitelistedDesktopEntries: globals.inhibited ? notificationSettings.doNotDisturbPopupWhitelistedApplications : []
		248		whitelistedNotifyRcNames: globals.inhibited ? notificationSettings.doNotDisturbPopupWhitelistedServices : []
		249		showJobs: notificationSettings.jobsInNotifications
		250		sortMode: NotificationManager.Notifications.SortByTypeAndUrgency
		251		groupMode: NotificationManager.Notifications.GroupDisabled
		252		urgencies: {
		253		var urgencies = 0;
		254
		255		// Critical always except in do not disturb mode when disabled in settings
		256		if (!globals.inhibited \|\| notificationSettings.criticalPopupsInDoNotDisturbMode) {
		257		urgencies \|= NotificationManager.Notifications.CriticalUrgency;
		258		}
		259
		260		// Normal only when not in do not disturb mode
		261		if (!globals.inhibited) {
		262		urgencies \|= NotificationManager.Notifications.NormalUrgency;
		263		}
		264
		265		// Low only when enabled in settings
		266		if (notificationSettings.lowPriorityPopups) {
		267		urgencies \|=NotificationManager.Notifications.LowUrgency;
		268		}
		269
		270		return urgencies;
		271		}
		272		}
		273
		274		property QtObject notificationSettings: NotificationManager.Settings {
		275		notificationSoundsInhibited: globals.inhibited
		276
		277		onNotificationsInhibitedUntilChanged: globals.checkInhibition()
		278		}
		279
		280		// This periodically checks whether do not disturb mode timed out
		281		property QtObject timeSource: PlasmaCore.DataSource {
		282		engine: "time"
		283		connectedSources: ["Local"]
		284		interval: 60000 // 1 min
		285		intervalAlignment: PlasmaCore.Types.AlignToMinute
		286		onDataChanged: {
		287		checkInhibition();
		288		globals.timeChanged();
		289		}
		290		}
		291
		292		property Instantiator popupInstantiator: Instantiator {
		293		model: popupNotificationsModel
		294		delegate: NotificationPopup {
		295		// so Instantiator can access that after the model row is gone
		296		readonly property var notificationId: model.notificationId
		297
		298		popupWidth: globals.popupWidth
		299
		300		notificationType: model.type
		301
		302		applicationName: model.applicationName
		303		applicationIconSource: model.applicationIconName
		304		deviceName: model.deviceName \|\| ""
		305
		306		time: model.updated \|\| model.created
		307
		308		configurable: model.configurable
		309		// For running jobs instead of offering a "close" button that might lead the user to
		310		// think that will cancel the job, we offer a "dismiss" button that hides it in the history
		311		dismissable: model.type === NotificationManager.Notifications.JobType
		312		&& model.jobState !== NotificationManager.Notifications.JobStateStopped
		313		// TODO would be nice to be able to "pin" jobs when they autohide
		314		&& notificationSettings.permanentJobPopups
		315		closable: model.closable
		316
		317		summary: model.summary
		318		body: model.body \|\| ""
		319		icon: model.image \|\| model.iconName
		320		hasDefaultAction: model.hasDefaultAction \|\| false
		321		timeout: model.timeout
		322		defaultTimeout: notificationSettings.popupTimeout
		323		// When configured to not keep jobs open permanently, we autodismiss them after the standard timeout
		324		dismissTimeout: !notificationSettings.permanentJobPopups
		325		&& model.type === NotificationManager.Notifications.JobType
		326		&& model.jobState !== NotificationManager.Notifications.JobStateStopped
		327		? defaultTimeout : 0
		328
		329		urls: model.urls \|\| []
		330		urgency: model.urgency \|\| NotificationManager.Notifications.NormalUrgency
		331
		332		jobState: model.jobState \|\| 0
		333		percentage: model.percentage \|\| 0
		334		error: model.error \|\| 0
		335		errorText: model.errorText \|\| ""
		336		suspendable: !!model.suspendable
		337		killable: !!model.killable
		338		jobDetails: model.jobDetails \|\| null
		339
		340		configureActionLabel: model.configureActionLabel \|\| ""
		341		actionNames: model.actionNames
		342		actionLabels: model.actionLabels
		343
		344		onExpired: popupNotificationsModel.expire(popupNotificationsModel.index(index, 0))
		345		onCloseClicked: popupNotificationsModel.close(popupNotificationsModel.index(index, 0))
		346		onDismissClicked: model.dismissed = true
		347		onConfigureClicked: popupNotificationsModel.configure(popupNotificationsModel.index(index, 0))
		348		onDefaultActionInvoked: {
		349		popupNotificationsModel.invokeDefaultAction(popupNotificationsModel.index(index, 0))
		350		popupNotificationsModel.close(popupNotificationsModel.index(index, 0))
		351		}
		352		onActionInvoked: {
		353		popupNotificationsModel.invokeAction(popupNotificationsModel.index(index, 0), actionName)
		354		popupNotificationsModel.close(popupNotificationsModel.index(index, 0))
		355		}
		356		onOpenUrl: {
		357		Qt.openUrlExternally(url);
		358		popupNotificationsModel.close(popupNotificationsModel.index(index, 0))
		359		}
		360		onFileActionInvoked: popupNotificationsModel.close(popupNotificationsModel.index(index, 0))
		361
		362		onSuspendJobClicked: popupNotificationsModel.suspendJob(popupNotificationsModel.index(index, 0))
		363		onResumeJobClicked: popupNotificationsModel.resumeJob(popupNotificationsModel.index(index, 0))
		364		onKillJobClicked: popupNotificationsModel.killJob(popupNotificationsModel.index(index, 0))
		365
		366		onHeightChanged: Qt.callLater(positionPopups)
		367		onWidthChanged: Qt.callLater(positionPopups)
		368
		369		Component.onCompleted: {
		370		// Register apps that were seen spawning a popup so they can be configured later
		371		// Apps with notifyrc can already be configured anyway
		372		if (model.desktopEntry && !model.notifyRcName) {
		373		notificationSettings.registerKnownApplication(model.desktopEntry);
		374		notificationSettings.save();
		375		}
		376
		377		// Tell the model that we're handling the timeout now
		378		popupNotificationsModel.stopTimeout(popupNotificationsModel.index(index, 0));
		379		}
		380		}
		381		onObjectAdded: {
		382		// also needed for it to correctly layout its contents
		383		object.visible = true;
		384		Qt.callLater(positionPopups);
		385		}
		386		onObjectRemoved: {
		387		var notificationId = object.notificationId
		388		// Popup might have been destroyed because of a filter change, tell the model to do the timeout work for us again
		389		// cannot use QModelIndex here as the model row is already gone
		390		popupNotificationsModel.startTimeout(notificationId);
		391
		392		Qt.callLater(positionPopups);
		393		}
		394		}
		395		}