]> git.mxchange.org Git - friendica.git/blob - src/Model/Post.php
Merge branch 'friendica:develop' into bug-noLocalPosts
[friendica.git] / src / Model / Post.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2022, the Friendica project
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 BadMethodCallException;
25 use Friendica\Core\Logger;
26 use Friendica\Core\System;
27 use Friendica\Database\Database;
28 use Friendica\Database\DBA;
29 use Friendica\DI;
30 use Friendica\Protocol\Activity;
31
32 class Post
33 {
34         /**
35          * Insert a new post entry
36          *
37          * @param integer $uri_id
38          * @param array   $fields
39          * @return int    ID of inserted post
40          * @throws \Exception
41          */
42         public static function insert(int $uri_id, array $data = []): int
43         {
44                 if (empty($uri_id)) {
45                         throw new BadMethodCallException('Empty URI_id');
46                 }
47
48                 $fields = DI::dbaDefinition()->truncateFieldsForTable('post', $data);
49
50                 // Additionally assign the key fields
51                 $fields['uri-id'] = $uri_id;
52
53                 if (!DBA::insert('post', $fields, Database::INSERT_IGNORE)) {
54                         return 0;
55                 }
56
57                 return DBA::lastInsertId();
58         }
59
60         /**
61          * Fetch a single post row
62          *
63          * @param mixed $stmt statement object
64          * @return array|false current row or false
65          * @throws \Exception
66          */
67         public static function fetch($stmt)
68         {
69                 $row = DBA::fetch($stmt);
70
71                 if (!is_array($row)) {
72                         return $row;
73                 }
74
75                 if (array_key_exists('verb', $row)) {
76                         if (in_array($row['verb'], Item::ACTIVITIES)) {
77                                 if (array_key_exists('title', $row)) {
78                                         $row['title'] = '';
79                                 }
80                                 if (array_key_exists('body', $row)) {
81                                         $row['body'] = $row['verb'];
82                                 }
83                                 if (array_key_exists('object', $row)) {
84                                         $row['object'] = '';
85                                 }
86                                 if (array_key_exists('object-type', $row)) {
87                                         $row['object-type'] = Activity\ObjectType::NOTE;
88                                 }
89                         } elseif (in_array($row['verb'], ['', Activity::POST, Activity::SHARE])) {
90                                 // Posts don't have a target - but having tags or files.
91                                 if (array_key_exists('target', $row)) {
92                                         $row['target'] = '';
93                                 }
94                         }
95                 }
96
97                 if (array_key_exists('extid', $row) && is_null($row['extid'])) {
98                         $row['extid'] = '';
99                 }
100
101                 return $row;
102         }
103
104         /**
105          * Fills an array with data from a post query
106          *
107          * @param object|bool $stmt Return value from Database->select
108          * @return array Data array
109          * @throws \Exception
110          */
111         public static function toArray($stmt): array
112         {
113                 if (is_bool($stmt)) {
114                         return [];
115                 }
116
117                 $data = [];
118                 while ($row = self::fetch($stmt)) {
119                         $data[] = $row;
120                 }
121
122                 DBA::close($stmt);
123
124                 return $data;
125         }
126
127         /**
128          * Check if post-user-view records exists
129          *
130          * @param array $condition array of fields for condition
131          *
132          * @return boolean Are there rows for that condition?
133          * @throws \Exception
134          */
135         public static function exists(array $condition): bool
136         {
137                 return DBA::exists('post-user-view', $condition);
138         }
139
140         /**
141          * Counts the post-user-view records satisfying the provided condition
142          *
143          * @param array        $condition array of fields for condition
144          * @param array        $params    Array of several parameters
145          *
146          * @return int
147          *
148          * Example:
149          * $condition = ["uid" => 1, "network" => 'dspr'];
150          * or:
151          * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
152          *
153          * $count = Post::count($condition);
154          * @throws \Exception
155          */
156         public static function count(array $condition = [], array $params = []): int
157         {
158                 return DBA::count('post-user-view', $condition, $params);
159         }
160
161         /**
162          * Counts the post-thread-user-view records satisfying the provided condition
163          *
164          * @param array        $condition array of fields for condition
165          * @param array        $params    Array of several parameters
166          *
167          * @return int
168          *
169          * Example:
170          * $condition = ["uid" => 1, "network" => 'dspr'];
171          * or:
172          * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
173          *
174          * $count = Post::count($condition);
175          * @throws \Exception
176          */
177         public static function countThread(array $condition = [], array $params = []): int
178         {
179                 return DBA::count('post-thread-user-view', $condition, $params);
180         }
181
182         /**
183          * Counts the post-view records satisfying the provided condition
184          *
185          * @param array        $condition array of fields for condition
186          * @param array        $params    Array of several parameters
187          *
188          * @return int
189          *
190          * Example:
191          * $condition = ["network" => 'dspr'];
192          * or:
193          * $condition = ["`network` IN (?, ?)", 1, 'dfrn', 'dspr'];
194          *
195          * $count = Post::count($condition);
196          * @throws \Exception
197          */
198         public static function countPosts(array $condition = [], array $params = []): int
199         {
200                 return DBA::count('post-view', $condition, $params);
201         }
202
203         /**
204          * Retrieve a single record from the post-user-view view and returns it in an associative array
205          *
206          * @param array $fields
207          * @param array $condition
208          * @param array $params
209          * @param bool  $user_mode true = post-user-view, false = post-view
210          * @return bool|array
211          * @throws \Exception
212          * @see   DBA::select
213          */
214         public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
215         {
216                 $params['limit'] = 1;
217
218                 $result = self::select($fields, $condition, $params);
219
220                 if (is_bool($result)) {
221                         return $result;
222                 } else {
223                         $row = self::fetch($result);
224                         DBA::close($result);
225                         return $row;
226                 }
227         }
228
229         /**
230          * Retrieve a single record from the post-view view and returns it in an associative array
231          *
232          * @param array $fields
233          * @param array $condition
234          * @param array $params
235          * @return bool|array
236          * @throws \Exception
237          * @see   DBA::select
238          */
239         public static function selectFirstPost(array $fields = [], array $condition = [], array $params = [])
240         {
241                 $params['limit'] = 1;
242
243                 $result = self::selectPosts($fields, $condition, $params);
244
245                 if (is_bool($result)) {
246                         return $result;
247                 } else {
248                         $row = self::fetch($result);
249                         DBA::close($result);
250                         return $row;
251                 }
252         }
253
254         /**
255          * Retrieve a single record from the post-thread-user-view view and returns it in an associative array
256          *
257          * @param array $fields
258          * @param array $condition
259          * @param array $params
260          * @return bool|array
261          * @throws \Exception
262          * @see   DBA::select
263          */
264         public static function selectFirstThread(array $fields = [], array $condition = [], array $params = [])
265         {
266                 $params['limit'] = 1;
267
268                 $result = self::selectThread($fields, $condition, $params);
269
270                 if (is_bool($result)) {
271                         return $result;
272                 } else {
273                         $row = self::fetch($result);
274                         DBA::close($result);
275                         return $row;
276                 }
277         }
278
279         /**
280          * Select rows from the post-user-view view and returns them as an array
281          *
282          * @param array $selected  Array of selected fields, empty for all
283          * @param array $condition Array of fields for condition
284          * @param array $params    Array of several parameters
285          *
286          * @return array
287          * @throws \Exception
288          */
289         public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
290         {
291                 $result = self::select($fields, $condition, $params);
292
293                 if (is_bool($result)) {
294                         return [];
295                 }
296
297                 $data = [];
298                 while ($row = self::fetch($result)) {
299                         $data[] = $row;
300                 }
301                 DBA::close($result);
302
303                 return $data;
304         }
305
306         /**
307          * Select rows from the given view
308          *
309          * @param string $view      View (post-user-view or post-thread-user-view)
310          * @param array  $selected  Array of selected fields, empty for all
311          * @param array  $condition Array of fields for condition
312          * @param array  $params    Array of several parameters
313          *
314          * @return boolean|object
315          * @throws \Exception
316          */
317         private static function selectView(string $view, array $selected = [], array $condition = [], array $params = [])
318         {
319                 if (empty($selected)) {
320                         $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
321
322                         if ($view == 'post-thread-user-view') {
323                                 $selected = array_merge($selected, ['ignored']);
324                         }
325                 }
326
327                 $selected = array_unique($selected);
328
329                 return DBA::select($view, $selected, $condition, $params);
330         }
331
332         /**
333          * Select rows from the post-user-view view
334          *
335          * @param array $selected  Array of selected fields, empty for all
336          * @param array $condition Array of fields for condition
337          * @param array $params    Array of several parameters
338          *
339          * @return boolean|object
340          * @throws \Exception
341          */
342         public static function select(array $selected = [], array $condition = [], array $params = [])
343         {
344                 return self::selectView('post-user-view', $selected, $condition, $params);
345         }
346
347         /**
348          * Select rows from the post-view view
349          *
350          * @param array $selected  Array of selected fields, empty for all
351          * @param array $condition Array of fields for condition
352          * @param array $params    Array of several parameters
353          *
354          * @return boolean|object
355          * @throws \Exception
356          */
357         public static function selectPosts(array $selected = [], array $condition = [], array $params = [])
358         {
359                 return self::selectView('post-view', $selected, $condition, $params);
360         }
361
362         /**
363          * Select rows from the post-thread-user-view view
364          *
365          * @param array $selected  Array of selected fields, empty for all
366          * @param array $condition Array of fields for condition
367          * @param array $params    Array of several parameters
368          *
369          * @return boolean|object
370          * @throws \Exception
371          */
372         public static function selectThread(array $selected = [], array $condition = [], array $params = [])
373         {
374                 return self::selectView('post-thread-user-view', $selected, $condition, $params);
375         }
376
377         /**
378          * Select rows from the post-thread-view view
379          *
380          * @param array $selected  Array of selected fields, empty for all
381          * @param array $condition Array of fields for condition
382          * @param array $params    Array of several parameters
383          *
384          * @return boolean|object
385          * @throws \Exception
386          */
387         public static function selectPostThread(array $selected = [], array $condition = [], array $params = [])
388         {
389                 return self::selectView('post-thread-view', $selected, $condition, $params);
390         }
391
392         /**
393          * Select rows from the given view for a given user
394          *
395          * @param string  $view      View (post-user-view or post-thread-user-view)
396          * @param integer $uid       User ID
397          * @param array   $selected  Array of selected fields, empty for all
398          * @param array   $condition Array of fields for condition
399          * @param array   $params    Array of several parameters
400          *
401          * @return boolean|object
402          * @throws \Exception
403          */
404         private static function selectViewForUser(string $view, int $uid, array $selected = [], array $condition = [], array $params = [])
405         {
406                 if (empty($selected)) {
407                         $selected = Item::DISPLAY_FIELDLIST;
408                 }
409
410                 $condition = DBA::mergeConditions($condition,
411                         ["`visible` AND NOT `deleted`
412                         AND NOT `author-blocked` AND NOT `owner-blocked`
413                         AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
414                         AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
415                                 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
416                         AND NOT `" . $view . "`.`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `hidden`)
417                         AND NOT `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `blocked` AND `cid` = `author-id`)
418                         AND NOT `owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `blocked` AND `cid` = `owner-id`)
419                         AND NOT (`gravity` = ? AND `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `ignored` AND `cid` = `author-id`))
420                         AND NOT (`gravity` = ? AND `owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `ignored` AND `cid` = `owner-id`))",
421                                 0, Contact::SHARING, Contact::FRIEND, Item::GRAVITY_PARENT, 0, $uid, $uid, $uid, Item::GRAVITY_PARENT, $uid, Item::GRAVITY_PARENT, $uid]);
422
423                 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
424
425                 $condition_string = DBA::buildCondition($condition);
426                 $param_string     = DBA::buildParameter($params);
427
428                 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
429                 $sql = DBA::cleanQuery($sql);
430
431                 return DBA::p($sql, $condition);
432         }
433
434         /**
435          * Select rows from the post-user-view view for a given user
436          *
437          * @param integer $uid       User ID
438          * @param array   $selected  Array of selected fields, empty for all
439          * @param array   $condition Array of fields for condition
440          * @param array   $params    Array of several parameters
441          *
442          * @return boolean|object
443          * @throws \Exception
444          */
445         public static function selectForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
446         {
447                 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
448         }
449
450         /**
451          * Select rows from the post-view view for a given user
452          *
453          * @param integer $uid       User ID
454          * @param array   $selected  Array of selected fields, empty for all
455          * @param array   $condition Array of fields for condition
456          * @param array   $params    Array of several parameters
457          *
458          * @return boolean|object
459          * @throws \Exception
460          */
461         public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
462         {
463                 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
464         }
465
466         /**
467          * Select rows from the post-thread-user-view view for a given user
468          *
469          * @param integer $uid       User ID
470          * @param array   $selected  Array of selected fields, empty for all
471          * @param array   $condition Array of fields for condition
472          * @param array   $params    Array of several parameters
473          *
474          * @return boolean|object
475          * @throws \Exception
476          */
477         public static function selectThreadForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
478         {
479                 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
480         }
481
482         /**
483          * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
484          *
485          * @param integer $uid User ID
486          * @param array   $selected
487          * @param array   $condition
488          * @param array   $params
489          * @return bool|array
490          * @throws \Exception
491          * @see   DBA::select
492          */
493         public static function selectFirstForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
494         {
495                 $params['limit'] = 1;
496
497                 $result = self::selectForUser($uid, $selected, $condition, $params);
498
499                 if (is_bool($result)) {
500                         return $result;
501                 } else {
502                         $row = self::fetch($result);
503                         DBA::close($result);
504                         return $row;
505                 }
506         }
507
508         /**
509          * Update existing post entries
510          *
511          * @param array $fields    The fields that are to be changed
512          * @param array $condition The condition for finding the item entries
513          *
514          * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
515          *
516          * @return integer|boolean number of affected rows - or "false" if there was an error
517          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
518          */
519         public static function update(array $fields, array $condition)
520         {
521                 $affected = 0;
522
523                 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => DI::userSession()->getLocalUserId(),'callstack' => System::callstack(10)]);
524
525                 // Don't allow changes to fields that are responsible for the relation between the records
526                 unset($fields['id']);
527                 unset($fields['parent']);
528                 unset($fields['uid']);
529                 unset($fields['uri']);
530                 unset($fields['uri-id']);
531                 unset($fields['thr-parent']);
532                 unset($fields['thr-parent-id']);
533                 unset($fields['parent-uri']);
534                 unset($fields['parent-uri-id']);
535
536                 $thread_condition = DBA::mergeConditions($condition, ['gravity' => Item::GRAVITY_PARENT]);
537
538                 // To ensure the data integrity we do it in an transaction
539                 DBA::transaction();
540
541                 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-user', $fields);
542                 if (!empty($update_fields)) {
543                         $affected_count = 0;
544                         $posts          = DBA::select('post-user-view', ['post-user-id'], $condition);
545                         while ($rows = DBA::toArray($posts, false, 100)) {
546                                 $puids = array_column($rows, 'post-user-id');
547                                 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
548                                         DBA::rollback();
549                                         Logger::warning('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
550                                         return false;
551                                 }
552                                 $affected_count += DBA::affectedRows();
553                         }
554                         DBA::close($posts);
555                         $affected = $affected_count;
556                 }
557
558                 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-content', $fields);
559                 if (!empty($update_fields)) {
560                         $affected_count = 0;
561                         $posts          = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
562                         while ($rows = DBA::toArray($posts, false, 100)) {
563                                 $uriids = array_column($rows, 'uri-id');
564                                 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
565                                         DBA::rollback();
566                                         Logger::warning('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
567                                         return false;
568                                 }
569                                 $affected_count += DBA::affectedRows();
570                         }
571                         DBA::close($posts);
572                         $affected = max($affected, $affected_count);
573                 }
574
575                 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post', $fields);
576                 if (!empty($update_fields)) {
577                         $affected_count = 0;
578                         $posts          = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
579                         while ($rows = DBA::toArray($posts, false, 100)) {
580                                 $uriids = array_column($rows, 'uri-id');
581
582                                 // Only delete the "post" entry when all "post-user" entries are deleted
583                                 if (!empty($update_fields['deleted']) && DBA::exists('post-user', ['uri-id' => $uriids, 'deleted' => false])) {
584                                         unset($update_fields['deleted']);
585                                 }
586
587                                 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
588                                         DBA::rollback();
589                                         Logger::warning('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
590                                         return false;
591                                 }
592                                 $affected_count += DBA::affectedRows();
593                         }
594                         DBA::close($posts);
595                         $affected = max($affected, $affected_count);
596                 }
597
598                 $update_fields = Post\DeliveryData::extractFields($fields);
599                 if (!empty($update_fields)) {
600                         $affected_count = 0;
601                         $posts          = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
602                         while ($rows = DBA::toArray($posts, false, 100)) {
603                                 $uriids = array_column($rows, 'uri-id');
604                                 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
605                                         DBA::rollback();
606                                         Logger::warning('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
607                                         return false;
608                                 }
609                                 $affected_count += DBA::affectedRows();
610                         }
611                         DBA::close($posts);
612                         $affected = max($affected, $affected_count);
613                 }
614
615                 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread', $fields);
616                 if (!empty($update_fields)) {
617                         $affected_count = 0;
618                         $posts          = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
619                         while ($rows = DBA::toArray($posts, false, 100)) {
620                                 $uriids = array_column($rows, 'uri-id');
621                                 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
622                                         DBA::rollback();
623                                         Logger::warning('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
624                                         return false;
625                                 }
626                                 $affected_count += DBA::affectedRows();
627                         }
628                         DBA::close($posts);
629                         $affected = max($affected, $affected_count);
630                 }
631
632                 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread-user', $fields);
633                 if (!empty($update_fields)) {
634                         $affected_count = 0;
635                         $posts          = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
636                         while ($rows = DBA::toArray($posts, false, 100)) {
637                                 $thread_puids = array_column($rows, 'post-user-id');
638                                 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
639                                         DBA::rollback();
640                                         Logger::warning('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
641                                         return false;
642                                 }
643                                 $affected_count += DBA::affectedRows();
644                         }
645                         DBA::close($posts);
646                         $affected = max($affected, $affected_count);
647                 }
648
649                 DBA::commit();
650
651                 Logger::info('Updated posts', ['rows' => $affected]);
652                 return $affected;
653         }
654
655         /**
656          * Delete a row from the post table
657          *
658          * @param array        $conditions Field condition(s)
659          * @param array        $options
660          *                           - cascade: If true we delete records in other tables that depend on the one we're deleting through
661          *                           relations (default: true)
662          *
663          * @return boolean was the delete successful?
664          * @throws \Exception
665          */
666         public static function delete(array $conditions, array $options = []): bool
667         {
668                 return DBA::delete('post', $conditions, $options);
669         }
670 }