Validate the input into Event already

Signed-off-by: Joas Schilling <coding@schilljs.com>

diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php
index af0605d82c899401c27f5705f23ba4760cf770cb..299199766ced845ead51728c7244f5a55339ef7a 100644 (file)
--- a/lib/private/Activity/Event.php
+++ b/lib/private/Activity/Event.php
@@ -26,227 +26,330 @@ namespace OC\Activity;
 use OCP\Activity\IEvent;
 
 class Event implements IEvent {
+
+       /** @var string */
+       protected $app = '';
+       /** @var string */
+       protected $type = '';
+       /** @var string */
+       protected $affectedUser = '';
+       /** @var string */
+       protected $author = '';
+       /** @var int */
+       protected $timestamp = 0;
+       /** @var string */
+       protected $subject = '';
+       /** @var array */
+       protected $subjectParameters = [];
+       /** @var string */
+       protected $message = '';
        /** @var array */
-       protected $data = [
-               'app' => null,
-               'type' => null,
-               'affected_user' => null,
-               'author' => null,
-               'timestamp' => null,
-               'subject' => null,
-               'subject_parameters' => null,
-               'message' => '',
-               'message_parameters' => [],
-               'object_type' => '',
-               'object_id' => 0,
-               'object_name' => '',
-               'link' => '',
-       ];
+       protected $messageParameters = [];
+       /** @var string */
+       protected $objectType = '';
+       /** @var int */
+       protected $objectId = 0;
+       /** @var string */
+       protected $objectName = '';
+       /** @var string */
+       protected $link = '';
 
        /**
         * Set the app of the activity
         *
         * @param string $app
         * @return IEvent
+        * @throws \InvalidArgumentException if the app id is invalid
         * @since 8.2.0
         */
        public function setApp($app) {
-               $this->data['app'] = (string) $app;
+               if (!is_string($app) || $app === '' || isset($app[32])) {
+                       throw new \InvalidArgumentException('The given app is invalid');
+               }
+               $this->app = (string) $app;
                return $this;
        }
 
+       /**
+        * @return string
+        */
+       public function getApp() {
+               return $this->app;
+       }
+
        /**
         * Set the type of the activity
         *
         * @param string $type
         * @return IEvent
+        * @throws \InvalidArgumentException if the type is invalid
         * @since 8.2.0
         */
        public function setType($type) {
-               $this->data['type'] = (string) $type;
+               if (!is_string($type) || $type === '' || isset($type[255])) {
+                       throw new \InvalidArgumentException('The given type is invalid');
+               }
+               $this->type = (string) $type;
                return $this;
        }
 
+       /**
+        * @return string
+        */
+       public function getType() {
+               return $this->type;
+       }
+
        /**
         * Set the affected user of the activity
         *
         * @param string $affectedUser
         * @return IEvent
+        * @throws \InvalidArgumentException if the affected user is invalid
         * @since 8.2.0
         */
        public function setAffectedUser($affectedUser) {
-               $this->data['affected_user'] = (string) $affectedUser;
+               if (!is_string($affectedUser) || $affectedUser === '' || isset($affectedUser[64])) {
+                       throw new \InvalidArgumentException('The given affected user is invalid');
+               }
+               $this->affectedUser = (string) $affectedUser;
                return $this;
        }
 
+       /**
+        * @return string
+        */
+       public function getAffectedUser() {
+               return $this->affectedUser;
+       }
+
        /**
         * Set the author of the activity
         *
         * @param string $author
         * @return IEvent
+        * @throws \InvalidArgumentException if the author is invalid
         * @since 8.2.0
         */
        public function setAuthor($author) {
-               $this->data['author'] = (string) $author;
+               if (!is_string($author) || $author === '' || isset($author[64])) {
+                       throw new \InvalidArgumentException('The given author user is invalid');
+               }
+               $this->author = (string) $author;
                return $this;
        }
 
+       /**
+        * @return string
+        */
+       public function getAuthor() {
+               return $this->author;
+       }
+
        /**
         * Set the timestamp of the activity
         *
         * @param int $timestamp
         * @return IEvent
+        * @throws \InvalidArgumentException if the timestamp is invalid
         * @since 8.2.0
         */
        public function setTimestamp($timestamp) {
-               $this->data['timestamp'] = (int) $timestamp;
+               if (!is_int($timestamp)) {
+                       throw new \InvalidArgumentException('The given timestamp is invalid');
+               }
+               $this->timestamp = (int) $timestamp;
                return $this;
        }
 
+       /**
+        * @return int
+        */
+       public function getTimestamp() {
+               return $this->timestamp;
+       }
+
        /**
         * Set the subject of the activity
         *
         * @param string $subject
         * @param array $parameters
         * @return IEvent
+        * @throws \InvalidArgumentException if the subject or parameters are invalid
         * @since 8.2.0
         */
        public function setSubject($subject, array $parameters = []) {
-               $this->data['subject'] = (string) $subject;
-               $this->data['subject_parameters'] = $parameters;
+               if (!is_string($subject) || $subject === '' || isset($subject[255])) {
+                       throw new \InvalidArgumentException('The given subject is invalid');
+               }
+               $this->subject = (string) $subject;
+               $this->subjectParameters = $parameters;
                return $this;
        }
 
        /**
-        * Set the message of the activity
-        *
-        * @param string $message
-        * @param array $parameters
-        * @return IEvent
-        * @since 8.2.0
+        * @return string
         */
-       public function setMessage($message, array $parameters = []) {
-               $this->data['message'] = (string) $message;
-               $this->data['message_parameters'] = $parameters;
-               return $this;
+       public function getSubject() {
+               return $this->subject;
        }
 
        /**
-        * Set the object of the activity
-        *
-        * @param string $objectType
-        * @param int $objectId
-        * @param string $objectName
-        * @return IEvent
-        * @since 8.2.0
+        * @return array
         */
-       public function setObject($objectType, $objectId, $objectName = '') {
-               $this->data['object_type'] = (string) $objectType;
-               $this->data['object_id'] = (int) $objectId;
-               $this->data['object_name'] = (string) $objectName;
-               return $this;
+       public function getSubjectParameters() {
+               return $this->subjectParameters;
        }
 
        /**
-        * Set the link of the activity
+        * Set the message of the activity
         *
-        * @param string $link
+        * @param string $message
+        * @param array $parameters
         * @return IEvent
+        * @throws \InvalidArgumentException if the message or parameters are invalid
         * @since 8.2.0
         */
-       public function setLink($link) {
-               $this->data['link'] = (string) $link;
+       public function setMessage($message, array $parameters = []) {
+               if (!is_string($message) || $message === '' || isset($message[255])) {
+                       throw new \InvalidArgumentException('The given message is invalid');
+               }
+               $this->message = (string) $message;
+               $this->messageParameters = $parameters;
                return $this;
        }
 
        /**
         * @return string
         */
-       public function getApp() {
-               return $this->data['app'];
+       public function getMessage() {
+               return $this->message;
        }
 
        /**
-        * @return string
+        * @return array
         */
-       public function getType() {
-               return $this->data['type'];
+       public function getMessageParameters() {
+               return $this->messageParameters;
        }
 
        /**
-        * @return string
+        * Set the object of the activity
+        *
+        * @param string $objectType
+        * @param int $objectId
+        * @param string $objectName
+        * @return IEvent
+        * @throws \InvalidArgumentException if the object is invalid
+        * @since 8.2.0
         */
-       public function getAffectedUser() {
-               return $this->data['affected_user'];
+       public function setObject($objectType, $objectId, $objectName = '') {
+               if (!is_string($objectType) || $objectType === '' || isset($objectType[255])) {
+                       throw new \InvalidArgumentException('The given object type is invalid');
+               }
+               if (!is_int($objectId)) {
+                       throw new \InvalidArgumentException('The given object id is invalid');
+               }
+               if (!is_string($objectName) || isset($objectName[4000])) {
+                       throw new \InvalidArgumentException('The given object name is invalid');
+               }
+               $this->objectType = (string) $objectType;
+               $this->objectId = (int) $objectId;
+               $this->objectName = (string) $objectName;
+               return $this;
        }
 
        /**
         * @return string
         */
-       public function getAuthor() {
-               return $this->data['author'];
-       }
-
-       /**
-        * @return int
-        */
-       public function getTimestamp() {
-               return $this->data['timestamp'];
+       public function getObjectType() {
+               return $this->objectType;
        }
 
        /**
         * @return string
         */
-       public function getSubject() {
-               return $this->data['subject'];
-       }
-
-       /**
-        * @return array
-        */
-       public function getSubjectParameters() {
-               return $this->data['subject_parameters'];
+       public function getObjectId() {
+               return $this->objectId;
        }
 
        /**
         * @return string
         */
-       public function getMessage() {
-               return $this->data['message'];
+       public function getObjectName() {
+               return $this->objectName;
        }
 
        /**
-        * @return array
+        * Set the link of the activity
+        *
+        * @param string $link
+        * @return IEvent
+        * @throws \InvalidArgumentException if the link is invalid
+        * @since 8.2.0
         */
-       public function getMessageParameters() {
-               return $this->data['message_parameters'];
+       public function setLink($link) {
+               if (!is_string($link) || $link === '' || isset($link[4000])) {
+                       throw new \InvalidArgumentException('The given link is invalid');
+               }
+               $this->link = (string) $link;
+               return $this;
        }
 
        /**
         * @return string
         */
-       public function getObjectType() {
-               return $this->data['object_type'];
+       public function getLink() {
+               return $this->link;
        }
-
        /**
-        * @return string
+        * @return bool
+        * @since 8.2.0
         */
-       public function getObjectId() {
-               return $this->data['object_id'];
+       public function isValid() {
+               return
+                       $this->isValidCommon()
+                       &&
+                       $this->getSubject() !== ''
+               ;
        }
 
        /**
-        * @return string
+        * @return bool
+        * @since 8.2.0
         */
-       public function getObjectName() {
-               return $this->data['object_name'];
+       public function isValidParsed() {
+//             if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
+//                     try {
+//                             $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
+//                     } catch (InvalidObjectExeption $e) {
+//                             return false;
+//                     }
+//             }
+
+               return
+                       $this->isValidCommon()
+//                     &&
+//                     $this->getParsedSubject() !== ''
+               ;
        }
 
        /**
-        * @return string
+        * @return bool
         */
-       public function getLink() {
-               return $this->data['link'];
+       protected function isValidCommon() {
+               return
+                       $this->getApp() !== ''
+                       &&
+                       $this->getType() !== ''
+                       &&
+                       $this->getAffectedUser() !== ''
+                       &&
+                       $this->getTimestamp() !== 0
+                       &&
+                       $this->getObjectType() !== ''
+                       &&
+                       $this->getObjectId() !== ''
+               ;
        }
 }

diff --git a/lib/public/Activity/IEvent.php b/lib/public/Activity/IEvent.php
index 0d4966e617efb89fa41c7d4fc723b6105aebeda5..3af8a8b8277686ea0800a4b2a498b34d73f079f6 100644 (file)
--- a/lib/public/Activity/IEvent.php
+++ b/lib/public/Activity/IEvent.php
@@ -41,6 +41,7 @@ interface IEvent {
         *
         * @param string $app
         * @return IEvent
+        * @throws \InvalidArgumentException if the app id is invalid
         * @since 8.2.0
         */
        public function setApp($app);
@@ -50,6 +51,7 @@ interface IEvent {
         *
         * @param string $type
         * @return IEvent
+        * @throws \InvalidArgumentException if the type is invalid
         * @since 8.2.0
         */
        public function setType($type);
@@ -59,6 +61,7 @@ interface IEvent {
         *
         * @param string $user
         * @return IEvent
+        * @throws \InvalidArgumentException if the affected user is invalid
         * @since 8.2.0
         */
        public function setAffectedUser($user);
@@ -68,6 +71,7 @@ interface IEvent {
         *
         * @param string $author
         * @return IEvent
+        * @throws \InvalidArgumentException if the author is invalid
         * @since 8.2.0
         */
        public function setAuthor($author);
@@ -77,6 +81,7 @@ interface IEvent {
         *
         * @param int $timestamp
         * @return IEvent
+        * @throws \InvalidArgumentException if the timestamp is invalid
         * @since 8.2.0
         */
        public function setTimestamp($timestamp);
@@ -87,6 +92,7 @@ interface IEvent {
         * @param string $subject
         * @param array $parameters
         * @return IEvent
+        * @throws \InvalidArgumentException if the subject or parameters are invalid
         * @since 8.2.0
         */
        public function setSubject($subject, array $parameters = []);
@@ -97,6 +103,7 @@ interface IEvent {
         * @param string $message
         * @param array $parameters
         * @return IEvent
+        * @throws \InvalidArgumentException if the message or parameters are invalid
         * @since 8.2.0
         */
        public function setMessage($message, array $parameters = []);
@@ -108,6 +115,7 @@ interface IEvent {
         * @param int $objectId
         * @param string $objectName
         * @return IEvent
+        * @throws \InvalidArgumentException if the object is invalid
         * @since 8.2.0
         */
        public function setObject($objectType, $objectId, $objectName = '');
@@ -117,6 +125,7 @@ interface IEvent {
         *
         * @param string $link
         * @return IEvent
+        * @throws \InvalidArgumentException if the link is invalid
         * @since 8.2.0
         */
        public function setLink($link);
@@ -198,4 +207,16 @@ interface IEvent {
         * @since 8.2.0
         */
        public function getLink();
+
+       /**
+        * @return bool
+        * @since 9.2.0
+        */
+       public function isValid();
+
+       /**
+        * @return bool
+        * @since 9.2.0
+        */
+       public function isValidParsed();
 }