]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Item.php
Merge pull request #5238 from annando/more-abstraction
[friendica.git] / src / Model / Item.php
index be6462eb629925fc30cf4fc03d1a2c2aa4791a26..c3b759f65b347ee1d6129e78f30b94cb53b01589 100644 (file)
@@ -33,38 +33,421 @@ require_once 'include/text.php';
 
 class Item extends BaseObject
 {
-       public static function select(array $fields = [], array $condition = [], $params = [], $uid = null)
+       // Field list that is used to display the items
+       const DISPLAY_FIELDLIST = ['uid', 'id', 'parent', 'uri', 'thr-parent', 'parent-uri', 'guid',
+                       'commented', 'created', 'edited', 'received', 'verb', 'object-type', 'postopts', 'plink',
+                       'wall', 'private', 'starred', 'origin', 'title', 'body', 'file', 'attach',
+                       'content-warning', 'location', 'coord', 'app', 'rendered-hash', 'rendered-html', 'object',
+                       'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'item_id',
+                       'author-id', 'author-link', 'author-name', 'author-avatar', 'author-network',
+                       'owner-id', 'owner-link', 'owner-name', 'owner-avatar',
+                       'contact-id', 'contact-link', 'contact-name', 'contact-avatar',
+                       'network', 'url', 'name', 'writable', 'self', 'cid', 'alias',
+                       'event-id', 'event-created', 'event-edited', 'event-start', 'event-finish',
+                       'event-summary', 'event-desc', 'event-location', 'event-type',
+                       'event-nofinish', 'event-adjust', 'event-ignore', 'event-id'];
+
+       // Field list that is used to deliver items via the protocols
+       const DELIVER_FIELDLIST = ['uid', 'id', 'parent', 'uri', 'thr-parent', 'parent-uri', 'guid',
+                       'created', 'edited', 'verb', 'object-type', 'object', 'target',
+                       'private', 'title', 'body', 'location', 'coord', 'app',
+                       'attach', 'tag', 'bookmark', 'deleted', 'extid',
+                       'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
+                       'author-id', 'author-link', 'owner-link', 'contact-uid',
+                       'signed_text', 'signature', 'signer'];
+
+       /**
+        * Retrieve a single record from the item table for a given user and returns it in an associative array
+        *
+        * @brief Retrieve a single record from a table
+        * @param integer $uid User ID
+        * @param array  $fields
+        * @param array  $condition
+        * @param array  $params
+        * @return bool|array
+        * @see dba::select
+        */
+       public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
+       {
+               $params['uid'] = $uid;
+
+               if (empty($selected)) {
+                       $selected = Item::DISPLAY_FIELDLIST;
+               }
+
+               return self::selectFirst($selected, $condition, $params);
+       }
+
+       /**
+        * @brief Select rows from the item table for a given user
+        *
+        * @param integer $uid User ID
+        * @param array  $selected  Array of selected fields, empty for all
+        * @param array  $condition Array of fields for condition
+        * @param array  $params    Array of several parameters
+        *
+        * @return boolean|object
+        */
+       public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
+       {
+               $params['uid'] = $uid;
+
+               if (empty($selected)) {
+                       $selected = Item::DISPLAY_FIELDLIST;
+               }
+
+               return self::select($selected, $condition, $params);
+       }
+
+       /**
+        * Retrieve a single record from the item table and returns it in an associative array
+        *
+        * @brief Retrieve a single record from a table
+        * @param array  $fields
+        * @param array  $condition
+        * @param array  $params
+        * @return bool|array
+        * @see dba::select
+        */
+       public static function selectFirst(array $fields = [], array $condition = [], $params = [])
        {
-               require_once 'include/conversation.php';
+               $params['limit'] = 1;
+
+               $result = self::select($fields, $condition, $params);
 
-               $item_fields = ['id', 'guid'];
+               if (is_bool($result)) {
+                       return $result;
+               } else {
+                       $row = dba::fetch($result);
+                       dba::close($result);
+                       return $row;
+               }
+       }
 
-               $select_fields = item_fieldlists();
+       /**
+        * @brief Select rows from the item table
+        *
+        * @param array  $selected  Array of selected fields, empty for all
+        * @param array  $condition Array of fields for condition
+        * @param array  $params    Array of several parameters
+        *
+        * @return boolean|object
+        */
+       public static function select(array $selected = [], array $condition = [], $params = [])
+       {
+               $uid = 0;
+               $usermode = false;
+
+               if (isset($params['uid'])) {
+                       $uid = $params['uid'];
+                       $usermode = true;
+               }
+
+               $fields = self::fieldlist($selected);
+
+               $select_fields = self::constructSelectFields($fields, $selected);
 
                $condition_string = dba::buildCondition($condition);
 
-               foreach ($item_fields as $field) {
-                       $search = [" `" . $field . "`", "(`" . $field . "`"];
-                       $replace = [" `item`.`" . $field . "`", "(`item`.`" . $field . "`"];
-                       $condition_string = str_replace($search, $replace, $condition_string);
+               $condition_string = self::addTablesToFields($condition_string, $fields);
+
+               if ($usermode) {
+                       $condition_string = $condition_string . ' AND ' . self::condition(false);
+               }
+
+               $param_string = self::addTablesToFields(dba::buildParameter($params), $fields);
+
+               $table = "`item` " . self::constructJoins($uid, $select_fields . $condition_string . $param_string, false);
+
+               $sql = "SELECT " . $select_fields . " FROM " . $table . $condition_string . $param_string;
+
+               return dba::p($sql, $condition);
+       }
+
+       /**
+        * @brief Select rows from the starting post in the item table
+        *
+        * @param integer $uid User ID
+        * @param array  $fields    Array of selected fields, empty for all
+        * @param array  $condition Array of fields for condition
+        * @param array  $params    Array of several parameters
+        *
+        * @return boolean|object
+        */
+       public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
+       {
+               $params['uid'] = $uid;
+
+               if (empty($selected)) {
+                       $selected = Item::DISPLAY_FIELDLIST;
+               }
+
+               return self::selectThread($selected, $condition, $params);
+       }
+
+       /**
+        * Retrieve a single record from the starting post in the item table and returns it in an associative array
+        *
+        * @brief Retrieve a single record from a table
+        * @param integer $uid User ID
+        * @param array  $selected
+        * @param array  $condition
+        * @param array  $params
+        * @return bool|array
+        * @see dba::select
+        */
+       public static function selectFirstThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
+       {
+               $params['uid'] = $uid;
+
+               if (empty($selected)) {
+                       $selected = Item::DISPLAY_FIELDLIST;
+               }
+
+               return self::selectFirstThread($selected, $condition, $params);
+       }
+
+       /**
+        * Retrieve a single record from the starting post in the item table and returns it in an associative array
+        *
+        * @brief Retrieve a single record from a table
+        * @param array  $fields
+        * @param array  $condition
+        * @param array  $params
+        * @return bool|array
+        * @see dba::select
+        */
+       public static function selectFirstThread(array $fields = [], array $condition = [], $params = [])
+       {
+               $params['limit'] = 1;
+               $result = self::selectThread($fields, $condition, $params);
+
+               if (is_bool($result)) {
+                       return $result;
+               } else {
+                       $row = dba::fetch($result);
+                       dba::close($result);
+                       return $row;
                }
+       }
+
+       /**
+        * @brief Select rows from the starting post in the item table
+        *
+        * @param array  $selected  Array of selected fields, empty for all
+        * @param array  $condition Array of fields for condition
+        * @param array  $params    Array of several parameters
+        *
+        * @return boolean|object
+        */
+       public static function selectThread(array $selected = [], array $condition = [], $params = [])
+       {
+               $uid = 0;
+               $usermode = false;
+
+               if (isset($params['uid'])) {
+                       $uid = $params['uid'];
+                       $usermode = true;
+               }
+
+               $fields = self::fieldlist($selected);
+
+               $threadfields = ['thread' => ['iid', 'uid', 'contact-id', 'owner-id', 'author-id',
+                       'created', 'edited', 'commented', 'received', 'changed', 'wall', 'private',
+                       'pubmail', 'moderated', 'visible', 'starred', 'ignored', 'bookmark',
+                       'unseen', 'deleted', 'origin', 'forum_mode', 'mention', 'network']];
+
+               $select_fields = self::constructSelectFields($fields, $selected);
+
+               $condition_string = dba::buildCondition($condition);
 
-               $condition_string = $condition_string . ' AND ' . item_condition();
+               $condition_string = self::addTablesToFields($condition_string, $threadfields);
+               $condition_string = self::addTablesToFields($condition_string, $fields);
 
-               if (!empty($uid)) {
-                       $condition_string .= " AND `item`.`uid` = ?";
-                       $condition['uid'] = $uid;
+               if ($usermode) {
+                       $condition_string = $condition_string . ' AND ' . self::condition(true);
                }
 
                $param_string = dba::buildParameter($params);
+               $param_string = self::addTablesToFields($param_string, $threadfields);
+               $param_string = self::addTablesToFields($param_string, $fields);
 
-               $table = "`item` " . item_joins($uid);
+               $table = "`thread` " . self::constructJoins($uid, $select_fields . $condition_string . $param_string, true);
 
                $sql = "SELECT " . $select_fields . " FROM " . $table . $condition_string . $param_string;
-echo $sql;
-               $result = dba::p($sql, $condition);
 
-               return dba::inArray($result);
+               return dba::p($sql, $condition);
+       }
+
+       /**
+        * @brief Returns a list of fields that are associated with the item table
+        *
+        * @return array field list
+        */
+       private static function fieldlist($selected)
+       {
+               $fields = [];
+
+               $fields['item'] = ['id', 'uid', 'parent', 'uri', 'parent-uri', 'thr-parent', 'guid',
+                       'contact-id', 'owner-id', 'author-id', 'type', 'wall', 'gravity', 'extid',
+                       'created', 'edited', 'commented', 'received', 'changed',
+                       'title', 'body', 'app', 'verb', 'object-type', 'object', 'target-type', 'target',
+                       'postopts', 'plink', 'resource-id', 'event-id', 'tag', 'attach', 'inform',
+                       'file', 'location', 'coord', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
+                       'private', 'pubmail', 'moderated', 'visible', 'starred', 'bookmark',
+                       'unseen', 'deleted', 'origin', 'forum_mode', 'mention',
+                       'rendered-hash', 'rendered-html', 'global', 'shadow', 'content-warning',
+                       'id' => 'item_id', 'network'];
+
+               $fields['author'] = ['url' => 'author-link', 'name' => 'author-name',
+                       'thumb' => 'author-avatar', 'nick' => 'author-nick', 'network' => 'author-network'];
+
+               $fields['owner'] = ['url' => 'owner-link', 'name' => 'owner-name',
+                       'thumb' => 'owner-avatar', 'nick' => 'owner-nick', 'network' => 'owner-network'];
+
+               $fields['contact'] = ['url' => 'contact-link', 'name' => 'contact-name', 'thumb' => 'contact-avatar',
+                       'network', 'url', 'name', 'writable', 'self', 'id' => 'cid', 'alias', 'uid' => 'contact-uid',
+                       'photo', 'name-date', 'uri-date', 'avatar-date', 'thumb', 'dfrn-id', 'network' => 'contact-network'];
+
+               $fields['parent-item'] = ['guid' => 'parent-guid', 'network' => 'parent-network'];
+
+               $fields['parent-item-author'] = ['url' => 'parent-author-link', 'name' => 'parent-author-name'];
+
+               $fields['event'] = ['created' => 'event-created', 'edited' => 'event-edited',
+                       'start' => 'event-start','finish' => 'event-finish',
+                       'summary' => 'event-summary','desc' => 'event-desc',
+                       'location' => 'event-location', 'type' => 'event-type',
+                       'nofinish' => 'event-nofinish','adjust' => 'event-adjust',
+                       'ignore' => 'event-ignore', 'id' => 'event-id'];
+
+               $fields['sign'] = ['signed_text', 'signature', 'signer'];
+
+               return $fields;
+       }
+
+       /**
+        * @brief Returns SQL condition for the "select" functions
+        *
+        * @param boolean $thread_mode Called for the items (false) or for the threads (true)
+        *
+        * @return string SQL condition
+        */
+       private static function condition($thread_mode)
+       {
+               if ($thread_mode) {
+                       $master_table = "`thread`";
+               } else {
+                       $master_table = "`item`";
+               }
+               return "$master_table.`visible` AND NOT $master_table.`deleted` AND NOT $master_table.`moderated` AND (`user-item`.`hidden` IS NULL OR NOT `user-item`.`hidden`) ";
+       }
+
+       /**
+        * @brief Returns all needed "JOIN" commands for the "select" functions
+        *
+        * @param integer $uid User ID
+        * @param string $sql_commands The parts of the built SQL commands in the "select" functions
+        * @param boolean $thread_mode Called for the items (false) or for the threads (true)
+        *
+        * @return string The SQL joins for the "select" functions
+        */
+       private static function constructJoins($uid, $sql_commands, $thread_mode)
+       {
+               if ($thread_mode) {
+                       $master_table = "`thread`";
+                       $master_table_key = "`thread`.`iid`";
+                       $joins = "STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid` ";
+               } else {
+                       $master_table = "`item`";
+                       $master_table_key = "`item`.`id`";
+                       $joins = '';
+               }
+
+               $joins .= sprintf("STRAIGHT_JOIN `contact` ON `contact`.`id` = $master_table.`contact-id`
+                       AND NOT `contact`.`blocked`
+                       AND ((NOT `contact`.`readonly` AND NOT `contact`.`pending` AND (`contact`.`rel` IN (%s, %s)))
+                       OR `contact`.`self` OR (`item`.`id` != `item`.`parent`) OR `contact`.`uid` = 0)
+                       STRAIGHT_JOIN `contact` AS `author` ON `author`.`id` = $master_table.`author-id` AND NOT `author`.`blocked`
+                       STRAIGHT_JOIN `contact` AS `owner` ON `owner`.`id` = $master_table.`owner-id` AND NOT `owner`.`blocked`
+                       LEFT JOIN `user-item` ON `user-item`.`iid` = $master_table_key AND `user-item`.`uid` = %d",
+                       CONTACT_IS_SHARING, CONTACT_IS_FRIEND, intval($uid));
+
+               if (strpos($sql_commands, "`group_member`.") !== false) {
+                       $joins .= " STRAIGHT_JOIN `group_member` ON `group_member`.`contact-id` = $master_table.`contact-id`";
+               }
+
+               if (strpos($sql_commands, "`user`.") !== false) {
+                       $joins .= " STRAIGHT_JOIN `user` ON `user`.`uid` = $master_table.`uid`";
+               }
+
+               if (strpos($sql_commands, "`event`.") !== false) {
+                       $joins .= " LEFT JOIN `event` ON `event-id` = `event`.`id`";
+               }
+
+               if (strpos($sql_commands, "`sign`.") !== false) {
+                       $joins .= " LEFT JOIN `sign` ON `sign`.`iid` = `item`.`id`";
+               }
+
+               if ((strpos($sql_commands, "`parent-item`.") !== false) || (strpos($sql_commands, "`parent-author`.") !== false)) {
+                       $joins .= " STRAIGHT_JOIN `item` AS `parent-item` ON `parent-item`.`id` = `item`.`parent`";
+               }
+
+               if (strpos($sql_commands, "`parent-item-author`.") !== false) {
+                       $joins .= " STRAIGHT_JOIN `contact` AS `parent-item-author` ON `parent-item-author`.`id` = `parent-item`.`author-id`";
+               }
+
+               return $joins;
+       }
+
+       /**
+        * @brief Add the field list for the "select" functions
+        *
+        * @param array $fields The field definition array
+        * @param array $selected The array with the selected fields from the "select" functions
+        *
+        * @return string The field list
+        */
+       private static function constructSelectFields($fields, $selected)
+       {
+               $selection = [];
+               foreach ($fields as $table => $table_fields) {
+                       foreach ($table_fields as $field => $select) {
+                               if (empty($selected) || in_array($select, $selected)) {
+                                       if (is_int($field)) {
+                                               $selection[] = "`" . $table . "`.`".$select."`";
+                                       } else {
+                                               $selection[] = "`" . $table . "`.`" . $field . "` AS `".$select ."`";
+                                       }
+                               }
+                       }
+               }
+               return implode(", ", $selection);
+       }
+
+       /**
+        * @brief add table definition to fields in an SQL query
+        *
+        * @param string $query SQL query
+        * @param array $fields The field definition array
+        *
+        * @return string the changed SQL query
+        */
+       private static function addTablesToFields($query, $fields)
+       {
+               foreach ($fields as $table => $table_fields) {
+                       foreach ($table_fields as $alias => $field) {
+                               if (is_int($alias)) {
+                                       $replace_field = $field;
+                               } else {
+                                       $replace_field = $alias;
+                               }
+
+                               $search = "/([^\.])`" . $field . "`/i";
+                               $replace = "$1`" . $table . "`.`" . $replace_field . "`";
+                               $query = preg_replace($search, $replace, $query);
+                       }
+               }
+               return $query;
        }
 
        /**
@@ -423,7 +806,7 @@ echo $sql;
                }
 
                $item['guid'] = self::guid($item, $notify);
-               $item['uri'] = notags(trim(defaults($item, 'uri', item_new_uri($a->get_hostname(), $item['uid'], $item['guid']))));
+               $item['uri'] = notags(trim(defaults($item, 'uri', self::newURI($item['uid'], $item['guid']))));
 
                // Store conversation data
                $item = Conversation::insert($item);
@@ -601,8 +984,8 @@ echo $sql;
                }
 
                //unset($item['author-link']);
-               //unset($item['author-name']);
-               //unset($item['author-avatar']);
+               unset($item['author-name']);
+               unset($item['author-avatar']);
 
                //unset($item['owner-link']);
                unset($item['owner-name']);
@@ -1276,6 +1659,29 @@ echo $sql;
                return $guid_prefix.$host_hash;
        }
 
+       /**
+        * generate an unique URI
+        *
+        * @param integer $uid User id
+        * @param string $guid An existing GUID (Otherwise it will be generated)
+        *
+        * @return string
+        */
+       public static function newURI($uid, $guid = "")
+       {
+               if ($guid == "") {
+                       $guid = get_guid(32);
+               }
+
+               $hostname = self::getApp()->get_hostname();
+
+               $user = dba::selectFirst('user', ['nickname'], ['uid' => $uid]);
+
+               $uri = "urn:X-dfrn:" . $hostname . ':' . $user['nickname'] . ':' . $guid;
+
+               return $uri;
+       }
+
        /**
         * @brief Set "success_update" and "last-item" to the date of the last time we heard from this contact
         *
@@ -1592,7 +1998,7 @@ echo $sql;
                        if ($contact['network'] != NETWORK_FEED) {
                                $datarray["guid"] = get_guid(32);
                                unset($datarray["plink"]);
-                               $datarray["uri"] = item_new_uri($a->get_hostname(), $contact['uid'], $datarray["guid"]);
+                               $datarray["uri"] = self::newURI($contact['uid'], $datarray["guid"]);
                                $datarray["parent-uri"] = $datarray["uri"];
                                $datarray["thr-parent"] = $datarray["uri"];
                                $datarray["extid"] = NETWORK_DFRN;
@@ -2064,7 +2470,7 @@ EOT;
 
                $new_item = [
                        'guid'          => get_guid(32),
-                       'uri'           => item_new_uri(self::getApp()->get_hostname(), $item['uid']),
+                       'uri'           => self::newURI($item['uid']),
                        'uid'           => $item['uid'],
                        'contact-id'    => $item_contact_id,
                        'type'          => 'activity',