nextcloud-swarm-plugin/lib/Notification/Notifier.php
2024-11-22 15:50:33 +01:00

117 lines
3.9 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2024, MetaProvide Holding EKF
*
* @author Ron Trevor <ecoron@proton.me>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Files_External_Ethswarm\Notification;
use OCA\Files_External_Ethswarm\AppInfo\AppConstants;
class Notifier implements \OCP\Notification\INotifier {
protected $factory;
protected $url;
public function __construct(\OCP\L10N\IFactory $factory,
\OCP\IURLGenerator $urlGenerator) {
$this->factory = $factory;
$this->url = $urlGenerator;
}
/**
* Identifier of the notifier, only use [a-z0-9_]
* @return string
*/
public function getID(): string {
return AppConstants::APP_NAME;
}
/**
* Human-readable name describing the notifier
* @return string
*/
public function getName(): string {
return $this->factory->get(AppConstants::APP_NAME)->t('Hejbit External Storage');
}
/**
* @param \OCP\Notification\INotification $notification
* @param string $languageCode The code of the language that should be used to prepare the notification
*/
public function prepare(\OCP\Notification\INotification $notification, string $languageCode): \OCP\Notification\INotification {
if ($notification->getApp() !== AppConstants::APP_NAME) {
// Not my app => throw
throw new \InvalidArgumentException();
}
// Read the language from the notification
$l = $this->factory->get(AppConstants::APP_NAME, $languageCode);
// Deal with known subjects
switch ($notification->getSubject()) {
// Set the parsed subject, message and action labels
case 'swarm-fileupload':
// Set rich subject, see https://github.com/nextcloud/server/issues/1706 for more information
// and https://github.com/nextcloud/server/blob/master/lib/public/RichObjectStrings/Definitions.php
// for a list of defined objects and their parameters.
$parameters = $notification->getSubjectParameters();
$notification->setRichSubject($l->t('Your file \'{filename}\' was decentralized.'),
[
'filename' => [
'type' => 'file',
'id' => '',
'name' => basename($parameters['path']),
'path' => $parameters['path'],
],
]);
// Set the plain text subject automatically
$this->setParsedSubjectFromRichSubject($notification);
return $notification;
default:
// Unknown subject => Unknown notification => throw
throw new \InvalidArgumentException();
}
}
/**
* This is a little helper function which automatically sets the simple parsed subject
* based on the rich subject you set. This is also the default behaviour of the API
* since Nextcloud 26, but in case you would like to return simpler or other strings,
* this function allows you to take over.
*
* @param \OCP\Notification\INotification $notification
*/
protected function setParsedSubjectFromRichSubject(\OCP\Notification\INotification $notification): void {
$placeholders = $replacements = [];
foreach ($notification->getRichSubjectParameters() as $placeholder => $parameter) {
$placeholders[] = '{' . $placeholder . '}';
if ($parameter['type'] === 'file') {
$replacements[] = $parameter['path'];
} else {
$replacements[] = $parameter['name'];
}
}
$notification->setParsedSubject(str_replace($placeholders, $replacements, $notification->getRichSubject()));
}
}