lib/private/Notification/Notification.php
<?php
/**
* @author Joas Schilling <coding@schilljs.com>
* @author Morris Jobke <hey@morrisjobke.de>
*
* @copyright Copyright (c) 2018, ownCloud GmbH
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Notification;
use OCP\Notification\IAction;
use OCP\Notification\INotification;
class Notification implements INotification {
/** @var string */
protected $app;
/** @var string */
protected $user;
/** @var \DateTime */
protected $dateTime;
/** @var string */
protected $objectType;
/** @var string */
protected $objectId;
/** @var string */
protected $subject;
/** @var array */
protected $subjectParameters;
/** @var string */
protected $subjectParsed;
/** @var string */
protected $message;
/** @var array */
protected $messageParameters;
/** @var string */
protected $messageParsed;
/** @var string */
protected $link;
/** @var string */
protected $icon;
/** @var array */
protected $actions;
/** @var array */
protected $actionsParsed;
/** @var bool */
protected $hasPrimaryAction;
/** @var bool */
protected $hasPrimaryParsedAction;
/**
* Constructor
*/
public function __construct() {
$this->app = '';
$this->user = '';
$this->dateTime = new \DateTime();
$this->dateTime->setTimestamp(0);
$this->objectType = '';
$this->objectId = '';
$this->subject = '';
$this->subjectParameters = [];
$this->subjectParsed = '';
$this->message = '';
$this->messageParameters = [];
$this->messageParsed = '';
$this->link = '';
$this->icon = '';
$this->actions = [];
$this->actionsParsed = [];
}
/**
* @param string $app
* @return $this
* @throws \InvalidArgumentException if the app id is invalid
* @since 8.2.0
*/
public function setApp($app) {
if (!\is_string($app) || $app === '' || isset($app[32])) {
throw new \InvalidArgumentException('The given app name is invalid');
}
$this->app = $app;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getApp() {
return $this->app;
}
/**
* @param string $user
* @return $this
* @throws \InvalidArgumentException if the user id is invalid
* @since 8.2.0
*/
public function setUser($user) {
if (!\is_string($user) || $user === '' || isset($user[64])) {
throw new \InvalidArgumentException('The given user id is invalid');
}
$this->user = $user;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getUser() {
return $this->user;
}
/**
* @param \DateTime $dateTime
* @return $this
* @throws \InvalidArgumentException if the $dateTime is invalid
* @since 9.0.0
*/
public function setDateTime(\DateTime $dateTime) {
if ($dateTime->getTimestamp() === 0) {
throw new \InvalidArgumentException('The given date time is invalid');
}
$this->dateTime = $dateTime;
return $this;
}
/**
* @return \DateTime
* @since 9.0.0
*/
public function getDateTime() {
return $this->dateTime;
}
/**
* @param string $type
* @param string $id
* @return $this
* @throws \InvalidArgumentException if the object type or id is invalid
* @since 8.2.0 - 9.0.0: Type of $id changed to string
*/
public function setObject($type, $id) {
if (!\is_string($type) || $type === '' || isset($type[64])) {
throw new \InvalidArgumentException('The given object type is invalid');
}
$this->objectType = $type;
if (!\is_int($id) && (!\is_string($id) || $id === '' || isset($id[64]))) {
throw new \InvalidArgumentException('The given object id is invalid');
}
$this->objectId = (string) $id;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getObjectType() {
return $this->objectType;
}
/**
* @return string
* @since 8.2.0 - 9.0.0: Return type changed to string
*/
public function getObjectId() {
return $this->objectId;
}
/**
* @param string $subject
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
* @since 8.2.0
*/
public function setSubject($subject, array $parameters = []) {
if (!\is_string($subject) || $subject === '' || isset($subject[64])) {
throw new \InvalidArgumentException('The given subject is invalid');
}
$this->subject = $subject;
if (!\is_array($parameters)) {
throw new \InvalidArgumentException('The given subject parameters are invalid');
}
$this->subjectParameters = $parameters;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getSubject() {
return $this->subject;
}
/**
* @return string[]
* @since 8.2.0
*/
public function getSubjectParameters() {
return $this->subjectParameters;
}
/**
* @param string $subject
* @return $this
* @throws \InvalidArgumentException if the subject are invalid
* @since 8.2.0
*/
public function setParsedSubject($subject) {
if (!\is_string($subject) || $subject === '') {
throw new \InvalidArgumentException('The given parsed subject is invalid');
}
$this->subjectParsed = $subject;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getParsedSubject() {
return $this->subjectParsed;
}
/**
* @param string $message
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
* @since 8.2.0
*/
public function setMessage($message, array $parameters = []) {
if (!\is_string($message) || $message === '' || isset($message[64])) {
throw new \InvalidArgumentException('The given message is invalid');
}
$this->message = $message;
if (!\is_array($parameters)) {
throw new \InvalidArgumentException('The given message parameters are invalid');
}
$this->messageParameters = $parameters;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getMessage() {
return $this->message;
}
/**
* @return string[]
* @since 8.2.0
*/
public function getMessageParameters() {
return $this->messageParameters;
}
/**
* @param string $message
* @return $this
* @throws \InvalidArgumentException if the message are invalid
* @since 8.2.0
*/
public function setParsedMessage($message) {
if (!\is_string($message) || $message === '') {
throw new \InvalidArgumentException('The given parsed message is invalid');
}
$this->messageParsed = $message;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getParsedMessage() {
return $this->messageParsed;
}
/**
* @param string $link
* @return $this
* @throws \InvalidArgumentException if the link are invalid
* @since 8.2.0
*/
public function setLink($link) {
if (!\is_string($link) || $link === '' || isset($link[4000])) {
throw new \InvalidArgumentException('The given link is invalid');
}
$this->link = $link;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getLink() {
return $this->link;
}
/**
* @return IAction
* @since 8.2.0
*/
public function createAction() {
return new Action();
}
/**
* @param IAction $action
* @return $this
* @throws \InvalidArgumentException if the action are invalid
* @since 8.2.0
*/
public function addAction(IAction $action) {
if (!$action->isValid()) {
throw new \InvalidArgumentException('The given action is invalid');
}
if ($action->isPrimary()) {
if ($this->hasPrimaryAction) {
throw new \InvalidArgumentException('The notification already has a primary action');
}
$this->hasPrimaryAction = true;
}
$this->actions[] = $action;
return $this;
}
/**
* @return IAction[]
* @since 8.2.0
*/
public function getActions() {
return $this->actions;
}
/**
* @param IAction $action
* @return $this
* @throws \InvalidArgumentException if the action are invalid
* @since 8.2.0
*/
public function addParsedAction(IAction $action) {
if (!$action->isValidParsed()) {
throw new \InvalidArgumentException('The given parsed action is invalid');
}
if ($action->isPrimary()) {
if ($this->hasPrimaryParsedAction) {
throw new \InvalidArgumentException('The notification already has a primary action');
}
$this->hasPrimaryParsedAction = true;
}
$this->actionsParsed[] = $action;
return $this;
}
/**
* @return IAction[]
* @since 8.2.0
*/
public function getParsedActions() {
return $this->actionsParsed;
}
/**
* @return bool
* @since 8.2.0
*/
public function isValid() {
return
$this->isValidCommon()
&&
$this->getSubject() !== ''
;
}
/**
* @return bool
* @since 8.2.0
*/
public function isValidParsed() {
return
$this->isValidCommon()
&&
$this->getParsedSubject() !== ''
;
}
/**
* @return bool
*/
protected function isValidCommon() {
return
$this->getApp() !== ''
&&
$this->getUser() !== ''
&&
$this->getDateTime()->getTimestamp() !== 0
&&
$this->getObjectType() !== ''
&&
$this->getObjectId() !== ''
;
}
/**
* Icon is an absolute URL to an image to be displayed in the notifications
*
* @return string
* @since 10.0.3
*/
public function getIcon() {
return $this->icon;
}
/**
* @param string $icon
* @since 10.0.3
*/
public function setIcon($icon) {
if (!\is_string($icon)) {
throw new \InvalidArgumentException('$icon has an invalid value');
}
$this->icon = $icon;
}
}