"selectForUser" and "" selectFirstForUser" is now moved to Post
[friendica.git/.git] / src / Model / Post.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2020, Friendica
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Model;
23
24 use Friendica\Database\DBA;
25 use Friendica\Protocol\Activity;
26
27 class Post
28 {
29         /**
30          * Fetch a single post row
31          *
32          * @param mixed $stmt statement object
33          * @return array|false current row or false
34          * @throws \Exception
35          */
36         public static function fetch($stmt)
37         {
38                 $row = DBA::fetch($stmt);
39
40                 if (!is_array($row)) {
41                         return $row;
42                 }
43
44                 if (array_key_exists('verb', $row)) {
45                         if (in_array($row['verb'], Item::ACTIVITIES)) {
46                                 if (array_key_exists('title', $row)) {
47                                         $row['title'] = '';
48                                 }
49                                 if (array_key_exists('body', $row)) {
50                                         $row['body'] = $row['verb'];
51                                 }
52                                 if (array_key_exists('object', $row)) {
53                                         $row['object'] = '';
54                                 }
55                                 if (array_key_exists('object-type', $row)) {
56                                         $row['object-type'] = Activity\ObjectType::NOTE;
57                                 }
58                         } elseif (in_array($row['verb'], ['', Activity::POST, Activity::SHARE])) {
59                                 // Posts don't have a target - but having tags or files.
60                                 if (array_key_exists('target', $row)) {
61                                         $row['target'] = '';
62                                 }
63                         }
64                 }
65
66                 if (!array_key_exists('verb', $row) || in_array($row['verb'], ['', Activity::POST, Activity::SHARE])) {
67                         // Build the file string out of the term entries
68                         if (array_key_exists('file', $row)) {
69                                 if ($row['internal-file-count'] > 0) {
70                                         $row['file'] = Post\Category::getTextByURIId($row['internal-uri-id'], $row['internal-uid']);
71                                 } else {
72                                         $row['file'] = '';
73                                 }
74                         }
75                 }
76
77                 // Remove internal fields
78                 unset($row['internal-file-count']);
79                 unset($row['internal-uri-id']);
80                 unset($row['internal-uid']);
81
82                 return $row;
83         }
84
85         /**
86          * Fills an array with data from an post query
87          *
88          * @param object $stmt statement object
89          * @param bool   $do_close
90          * @return array Data array
91          */
92         public static function toArray($stmt, $do_close = true) {
93                 if (is_bool($stmt)) {
94                         return $stmt;
95                 }
96
97                 $data = [];
98                 while ($row = self::fetch($stmt)) {
99                         $data[] = $row;
100                 }
101                 if ($do_close) {
102                         DBA::close($stmt);
103                 }
104                 return $data;
105         }
106
107         /**
108          * Check if post data exists
109          *
110          * @param array $condition array of fields for condition
111          *
112          * @return boolean Are there rows for that condition?
113          * @throws \Exception
114          */
115         public static function exists($condition) {
116                 return DBA::exists('post-view', $condition);
117         }
118
119         /**
120          * Counts the posts satisfying the provided condition
121          *
122          * @param array        $condition array of fields for condition
123          * @param array        $params    Array of several parameters
124          *
125          * @return int
126          *
127          * Example:
128          * $condition = ["uid" => 1, "network" => 'dspr'];
129          * or:
130          * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
131          *
132          * $count = Post::count($condition);
133          * @throws \Exception
134          */
135         public static function count(array $condition = [], array $params = [])
136         {
137                 return DBA::count('post-view', $condition, $params);
138         }
139
140         /**
141          * Retrieve a single record from the post table and returns it in an associative array
142          *
143          * @param array $fields
144          * @param array $condition
145          * @param array $params
146          * @return bool|array
147          * @throws \Exception
148          * @see   DBA::select
149          */
150         public static function selectFirst(array $fields = [], array $condition = [], $params = [])
151         {
152                 $params['limit'] = 1;
153
154                 $result = self::select($fields, $condition, $params);
155
156                 if (is_bool($result)) {
157                         return $result;
158                 } else {
159                         $row = self::fetch($result);
160                         DBA::close($result);
161                         return $row;
162                 }
163         }
164
165         /**
166          * Select rows from the post table and returns them as an array
167          *
168          * @param array $selected  Array of selected fields, empty for all
169          * @param array $condition Array of fields for condition
170          * @param array $params    Array of several parameters
171          *
172          * @return array
173          * @throws \Exception
174          */
175         public static function selectToArray(array $fields = [], array $condition = [], $params = [])
176         {
177                 $result = self::select($fields, $condition, $params);
178
179                 if (is_bool($result)) {
180                         return [];
181                 }
182
183                 $data = [];
184                 while ($row = self::fetch($result)) {
185                         $data[] = $row;
186                 }
187                 DBA::close($result);
188
189                 return $data;
190         }
191
192         /**
193          * Select rows from the post table
194          *
195          * @param array $selected  Array of selected fields, empty for all
196          * @param array $condition Array of fields for condition
197          * @param array $params    Array of several parameters
198          *
199          * @return boolean|object
200          * @throws \Exception
201          */
202         public static function select(array $selected = [], array $condition = [], $params = [])
203         {
204                 if (empty($selected)) {
205                         $selected = array_merge(['author-addr', 'author-nick', 'owner-addr', 'owner-nick', 'causer-addr', 'causer-nick',
206                                 'causer-network', 'photo', 'name-date', 'uri-date', 'avatar-date', 'thumb', 'dfrn-id',
207                                 'parent-guid', 'parent-network', 'parent-author-id', 'parent-author-link', 'parent-author-name',
208                                 'parent-author-network', 'signed_text'], Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST, Item::CONTENT_FIELDLIST);
209                 }
210
211                 $selected = array_merge($selected, ['internal-uri-id', 'internal-uid', 'internal-file-count']);
212                 $selected = array_unique($selected);
213
214                 return DBA::select('post-view', $selected, $condition, $params);
215         }
216
217         /**
218          * Select rows from the post view for a given user
219          *
220          * @param integer $uid       User ID
221          * @param array   $selected  Array of selected fields, empty for all
222          * @param array   $condition Array of fields for condition
223          * @param array   $params    Array of several parameters
224          *
225          * @return boolean|object
226          * @throws \Exception
227          */
228         public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
229         {
230                 if (empty($selected)) {
231                         $selected = Item::DISPLAY_FIELDLIST;
232                 }
233
234                 $selected = array_unique(array_merge($selected, ['internal-uri-id', 'internal-uid', 'internal-file-count']));
235
236                 $condition = DBA::mergeConditions($condition,
237                         ["`visible` AND NOT `deleted` AND NOT `moderated`
238                         AND NOT `author-blocked` AND NOT `owner-blocked`
239                         AND (NOT `causer-blocked` OR `causer-id` = ?) AND NOT `contact-blocked`
240                         AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
241                                 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
242                         AND NOT EXISTS (SELECT `iid` FROM `user-item` WHERE `hidden` AND `iid` = `id` AND `uid` = ?)
243                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
244                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
245                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
246                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
247                         0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
248
249                 $select_string = '';
250
251                 if (in_array('pinned', $selected)) {
252                         $selected = array_flip($selected);
253                         unset($selected['pinned']);
254                         $selected = array_flip($selected);      
255
256                         $select_string = '(SELECT `pinned` FROM `user-item` WHERE `iid` = `post-view`.`id` AND uid=`post-view`.`uid`) AS `pinned`, ';
257                 }
258
259                 $select_string .= implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
260
261                 $condition_string = DBA::buildCondition($condition);
262                 $param_string = DBA::buildParameter($params);
263
264                 $sql = "SELECT " . $select_string . " FROM `post-view` " . $condition_string . $param_string;
265                 $sql = DBA::cleanQuery($sql);
266
267                 return DBA::p($sql, $condition);
268         }
269
270         /**
271          * Retrieve a single record from the post view for a given user and returns it in an associative array
272          *
273          * @param integer $uid User ID
274          * @param array   $selected
275          * @param array   $condition
276          * @param array   $params
277          * @return bool|array
278          * @throws \Exception
279          * @see   DBA::select
280          */
281         public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
282         {
283                 $params['limit'] = 1;
284
285                 $result = self::selectForUser($uid, $selected, $condition, $params);
286
287                 if (is_bool($result)) {
288                         return $result;
289                 } else {
290                         $row = self::fetch($result);
291                         DBA::close($result);
292                         return $row;
293                 }
294         }
295 }