Replace "q" calls
[friendica.git/.git] / src / Core / NotificationsManager.php
index d11fea0..d54492f 100644 (file)
@@ -9,8 +9,6 @@ namespace Friendica\Core;
 use Friendica\BaseObject;
 use Friendica\Content\Text\BBCode;
 use Friendica\Content\Text\HTML;
-use Friendica\Core\Logger;
-use Friendica\Core\Protocol;
 use Friendica\Database\DBA;
 use Friendica\Model\Contact;
 use Friendica\Model\Item;
@@ -19,8 +17,6 @@ use Friendica\Util\Proxy as ProxyUtils;
 use Friendica\Util\Temporal;
 use Friendica\Util\XML;
 
-require_once 'include/dba.php';
-
 /**
  * @brief Methods for read and write notifications from/to database
  *  or for formatting notifications
@@ -38,6 +34,7 @@ class NotificationsManager extends BaseObject
         *  - date_rel : relative date string
         *  - msg_html: message as html string
         *  - msg_plain: message as plain text string
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private function _set_extra($notes)
        {
@@ -58,46 +55,25 @@ class NotificationsManager extends BaseObject
         * @brief Get all notifications for local_user()
         *
         * @param array  $filter optional Array "column name"=>value: filter query by columns values
-        * @param string $order  optional Space separated list of column to sort by.
-        *                       Prepend name with "+" to sort ASC, "-" to sort DESC. Default to "-date"
+        * @param array  $order  optional Array to order by
         * @param string $limit  optional Query limits
         *
-        * @return array of results or false on errors
+        * @return array|bool of results or false on errors
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public function getAll($filter = [], $order = "-date", $limit = "")
+       public function getAll($filter = [], $order = ['date' => 'DESC'], $limit = "")
        {
-               $filter_str = [];
-               $filter_sql = "";
-               foreach ($filter as $column => $value) {
-                       $filter_str[] = sprintf("`%s` = '%s'", $column, DBA::escape($value));
-               }
-               if (count($filter_str) > 0) {
-                       $filter_sql = "AND " . implode(" AND ", $filter_str);
-               }
+               $params = [];
 
-               $aOrder = explode(" ", $order);
-               $asOrder = [];
-               foreach ($aOrder as $o) {
-                       $dir = "asc";
-                       if ($o[0] === "-") {
-                               $dir = "desc";
-                               $o = substr($o, 1);
-                       }
-                       if ($o[0] === "+") {
-                               $dir = "asc";
-                               $o = substr($o, 1);
-                       }
-                       $asOrder[] = "$o $dir";
-               }
-               $order_sql = implode(", ", $asOrder);
+               $params['order'] = $order;
 
-               if ($limit != "") {
-                       $limit = " LIMIT " . $limit;
+               if (!empty($limit)) {
+                       $params['limit'] = $limit;
                }
-               $r = q(
-                       "SELECT * FROM `notify` WHERE `uid` = %d $filter_sql ORDER BY $order_sql $limit",
-                       intval(local_user())
-               );
+
+               $dbFilter = array_merge($filter, ['uid' => local_user()]);
+
+               $r = DBA::select('notify', [], $dbFilter, $order, $params);
 
                if (DBA::isResult($r)) {
                        return $this->_set_extra($r);
@@ -111,14 +87,11 @@ class NotificationsManager extends BaseObject
         *
         * @param int $id identity
         * @return array note values or null if not found
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function getByID($id)
        {
-               $r = q(
-                       "SELECT * FROM `notify` WHERE `id` = %d AND `uid` = %d LIMIT 1",
-                       intval($id),
-                       intval(local_user())
-               );
+               $r = DBA::selectFirst('notify', ['id' => $id, 'uid' => local_user()]);
                if (DBA::isResult($r)) {
                        return $this->_set_extra($r)[0];
                }
@@ -131,17 +104,11 @@ class NotificationsManager extends BaseObject
         * @param array $note note array
         * @param bool  $seen optional true or false, default true
         * @return bool true on success, false on errors
+        * @throws \Exception
         */
        public function setSeen($note, $seen = true)
        {
-               return q(
-                       "UPDATE `notify` SET `seen` = %d WHERE (`link` = '%s' OR (`parent` != 0 AND `parent` = %d AND `otype` = '%s')) AND `uid` = %d",
-                       intval($seen),
-                       DBA::escape($note['link']),
-                       intval($note['parent']),
-                       DBA::escape($note['otype']),
-                       intval(local_user())
-               );
+               return DBA::update('notify', ['seen' => $seen], ['link' => $note['link'], 'parent' => $note['parent'], 'otype' => $note['otype'], 'uid' => local_user()]);
        }
 
        /**
@@ -149,20 +116,18 @@ class NotificationsManager extends BaseObject
         *
         * @param bool $seen optional true or false. default true
         * @return bool true on success, false on error
+        * @throws \Exception
         */
        public function setAllSeen($seen = true)
        {
-               return q(
-                       "UPDATE `notify` SET `seen` = %d WHERE `uid` = %d",
-                       intval($seen),
-                       intval(local_user())
-               );
+               return DBA::update('notify', ['seen' => $seen], ['uid' => local_user()]);
        }
 
        /**
         * @brief List of pages for the Notifications TabBar
         *
         * @return array with with notifications TabBar data
+        * @throws \Exception
         */
        public function getTabs()
        {
@@ -215,18 +180,18 @@ class NotificationsManager extends BaseObject
         * @param array  $notifs The array from the db query
         * @param string $ident  The notifications identifier (e.g. network)
         * @return array
-        *      string 'label' => The type of the notification
-        *      string 'link' => URL to the source
-        *      string 'image' => The avatar image
-        *      string 'url' => The profile url of the contact
-        *      string 'text' => The notification text
-        *      string 'when' => The date of the notification
-        *      string 'ago' => T relative date of the notification
-        *      bool 'seen' => Is the notification marked as "seen"
+        *                       string 'label' => The type of the notification
+        *                       string 'link' => URL to the source
+        *                       string 'image' => The avatar image
+        *                       string 'url' => The profile url of the contact
+        *                       string 'text' => The notification text
+        *                       string 'when' => The date of the notification
+        *                       string 'ago' => T relative date of the notification
+        *                       bool 'seen' => Is the notification marked as "seen"
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private function formatNotifs(array $notifs, $ident = "")
        {
-               $notif = [];
                $arr = [];
 
                if (DBA::isResult($notifs)) {
@@ -400,14 +365,15 @@ class NotificationsManager extends BaseObject
        /**
         * @brief Get network notifications
         *
-        * @param int|string $seen  If 0 only include notifications into the query
-        *                              which aren't marked as "seen"
-        * @param int        $start Start the query at this point
-        * @param int        $limit Maximum number of query results
+        * @param int|string $seen    If 0 only include notifications into the query
+        *                            which aren't marked as "seen"
+        * @param int        $start   Start the query at this point
+        * @param int        $limit   Maximum number of query results
         *
         * @return array with
-        *      string 'ident' => Notification identifier
-        *      array 'notifications' => Network notifications
+        *    string 'ident' => Notification identifier
+        *    array 'notifications' => Network notifications
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function networkNotifs($seen = 0, $start = 0, $limit = 80)
        {
@@ -441,14 +407,15 @@ class NotificationsManager extends BaseObject
        /**
         * @brief Get system notifications
         *
-        * @param int|string $seen  If 0 only include notifications into the query
-        *                              which aren't marked as "seen"
-        * @param int        $start Start the query at this point
-        * @param int        $limit Maximum number of query results
+        * @param int|string $seen    If 0 only include notifications into the query
+        *                            which aren't marked as "seen"
+        * @param int        $start   Start the query at this point
+        * @param int        $limit   Maximum number of query results
         *
         * @return array with
-        *      string 'ident' => Notification identifier
-        *      array 'notifications' => System notifications
+        *    string 'ident' => Notification identifier
+        *    array 'notifications' => System notifications
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function systemNotifs($seen = 0, $start = 0, $limit = 80)
        {
@@ -457,19 +424,21 @@ class NotificationsManager extends BaseObject
                $sql_seen = "";
 
                if ($seen === 0) {
-                       $sql_seen = " AND NOT `seen` ";
+                       $filter = ['`uid` = ? AND NOT `seen`', local_user()];
+               } else {
+                       $filter = ['uid' => local_user()];
                }
 
-               $r = q(
-                       "SELECT `id`, `url`, `photo`, `msg`, `date`, `seen`, `verb` FROM `notify`
-                               WHERE `uid` = %d $sql_seen ORDER BY `date` DESC LIMIT %d, %d ",
-                       intval(local_user()),
-                       intval($start),
-                       intval($limit)
-               );
+               $params = [];
+               $params['limit'] = [$start, $limit];
+
+               $r = DBA::select('notify',
+                       ['id', 'url', 'photo', 'msg', 'date', 'seen', 'verb'],
+                       $filter,
+                       $params);
 
                if (DBA::isResult($r)) {
-                       $notifs = $this->formatNotifs($r, $ident);
+                       $notifs = $this->formatNotifs(DBA::toArray($r), $ident);
                }
 
                $arr = [
@@ -483,14 +452,15 @@ class NotificationsManager extends BaseObject
        /**
         * @brief Get personal notifications
         *
-        * @param int|string $seen  If 0 only include notifications into the query
-        *                              which aren't marked as "seen"
-        * @param int        $start Start the query at this point
-        * @param int        $limit Maximum number of query results
+        * @param int|string $seen    If 0 only include notifications into the query
+        *                            which aren't marked as "seen"
+        * @param int        $start   Start the query at this point
+        * @param int        $limit   Maximum number of query results
         *
         * @return array with
-        *      string 'ident' => Notification identifier
-        *      array 'notifications' => Personal notifications
+        *    string 'ident' => Notification identifier
+        *    array 'notifications' => Personal notifications
+        * @throws \Exception
         */
        public function personalNotifs($seen = 0, $start = 0, $limit = 80)
        {
@@ -528,14 +498,15 @@ class NotificationsManager extends BaseObject
        /**
         * @brief Get home notifications
         *
-        * @param int|string $seen  If 0 only include notifications into the query
-        *                              which aren't marked as "seen"
-        * @param int        $start Start the query at this point
-        * @param int        $limit Maximum number of query results
+        * @param int|string $seen    If 0 only include notifications into the query
+        *                            which aren't marked as "seen"
+        * @param int        $start   Start the query at this point
+        * @param int        $limit   Maximum number of query results
         *
         * @return array with
-        *      string 'ident' => Notification identifier
-        *      array 'notifications' => Home notifications
+        *    string 'ident' => Notification identifier
+        *    array 'notifications' => Home notifications
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function homeNotifs($seen = 0, $start = 0, $limit = 80)
        {
@@ -568,14 +539,16 @@ class NotificationsManager extends BaseObject
        /**
         * @brief Get introductions
         *
-        * @param bool $all   If false only include introductions into the query
-        *                        which aren't marked as ignored
-        * @param int  $start Start the query at this point
-        * @param int  $limit Maximum number of query results
+        * @param bool $all     If false only include introductions into the query
+        *                      which aren't marked as ignored
+        * @param int  $start   Start the query at this point
+        * @param int  $limit   Maximum number of query results
         *
         * @return array with
-        *      string 'ident' => Notification identifier
-        *      array 'notifications' => Introductions
+        *    string 'ident' => Notification identifier
+        *    array 'notifications' => Introductions
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public function introNotifs($all = false, $start = 0, $limit = 80)
        {
@@ -588,7 +561,7 @@ class NotificationsManager extends BaseObject
                }
 
                /// @todo Fetch contact details by "Contact::getDetailsByUrl" instead of queries to contact, fcontact and gcontact
-               $r = q(
+               $r = DBA::p(
                        "SELECT `intro`.`id` AS `intro_id`, `intro`.*, `contact`.*,
                                `fcontact`.`name` AS `fname`, `fcontact`.`url` AS `furl`, `fcontact`.`addr` AS `faddr`,
                                `fcontact`.`photo` AS `fphoto`, `fcontact`.`request` AS `frequest`,
@@ -606,7 +579,7 @@ class NotificationsManager extends BaseObject
                        intval($limit)
                );
                if (DBA::isResult($r)) {
-                       $notifs = $this->formatIntros($r);
+                       $notifs = $this->formatIntros(DBA::toArray($r));
                }
 
                $arr = [
@@ -622,11 +595,15 @@ class NotificationsManager extends BaseObject
         *
         * @param array $intros The array from the db query
         * @return array with the introductions
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        private function formatIntros($intros)
        {
                $knowyou = '';
 
+               $arr = [];
+
                foreach ($intros as $it) {
                        // There are two kind of introduction. Contacts suggested by other contacts and normal connection requests.
                        // We have to distinguish between these two because they use different data.
@@ -705,6 +682,7 @@ class NotificationsManager extends BaseObject
         * @param array $arr The input array with the intro data
         *
         * @return array The array with the intro data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private function getMissingIntroData($arr)
        {