3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Model;
24 use BadMethodCallException;
25 use Friendica\Core\Logger;
26 use Friendica\Core\System;
27 use Friendica\Database\Database;
28 use Friendica\Database\DBA;
30 use Friendica\Protocol\Activity;
35 * Insert a new post entry
37 * @param integer $uri_id
38 * @param array $fields
39 * @return int ID of inserted post
42 public static function insert(int $uri_id, array $data = []): int
45 throw new BadMethodCallException('Empty URI_id');
48 $fields = DI::dbaDefinition()->truncateFieldsForTable('post', $data);
50 // Additionally assign the key fields
51 $fields['uri-id'] = $uri_id;
53 if (!DBA::insert('post', $fields, Database::INSERT_IGNORE)) {
57 return DBA::lastInsertId();
61 * Fetch a single post row
63 * @param mixed $stmt statement object
64 * @return array|false current row or false
67 public static function fetch($stmt)
69 $row = DBA::fetch($stmt);
71 if (!is_array($row)) {
75 if (array_key_exists('verb', $row)) {
76 if (in_array($row['verb'], Item::ACTIVITIES)) {
77 if (array_key_exists('title', $row)) {
80 if (array_key_exists('body', $row)) {
81 $row['body'] = $row['verb'];
83 if (array_key_exists('object', $row)) {
86 if (array_key_exists('object-type', $row)) {
87 $row['object-type'] = Activity\ObjectType::NOTE;
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)) {
97 if (array_key_exists('extid', $row) && is_null($row['extid'])) {
105 * Fills an array with data from a post query
107 * @param object|bool $stmt Return value from Database->select
108 * @return array Data array
111 public static function toArray($stmt): array
113 if (is_bool($stmt)) {
118 while ($row = self::fetch($stmt)) {
128 * Check if post-user-view records exists
130 * @param array $condition array of fields for condition
132 * @return boolean Are there rows for that condition?
135 public static function exists(array $condition): bool
137 return DBA::exists('post-user-view', $condition);
141 * Counts the post-user-view records satisfying the provided condition
143 * @param array $condition array of fields for condition
144 * @param array $params Array of several parameters
149 * $condition = ["uid" => 1, "network" => 'dspr'];
151 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
153 * $count = Post::count($condition);
156 public static function count(array $condition = [], array $params = []): int
158 return DBA::count('post-user-view', $condition, $params);
162 * Counts the post-thread-user-view records satisfying the provided condition
164 * @param array $condition array of fields for condition
165 * @param array $params Array of several parameters
170 * $condition = ["uid" => 1, "network" => 'dspr'];
172 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
174 * $count = Post::count($condition);
177 public static function countThread(array $condition = [], array $params = []): int
179 return DBA::count('post-thread-user-view', $condition, $params);
183 * Counts the post-view records satisfying the provided condition
185 * @param array $condition array of fields for condition
186 * @param array $params Array of several parameters
191 * $condition = ["network" => 'dspr'];
193 * $condition = ["`network` IN (?, ?)", 1, 'dfrn', 'dspr'];
195 * $count = Post::count($condition);
198 public static function countPosts(array $condition = [], array $params = []): int
200 return DBA::count('post-view', $condition, $params);
204 * Retrieve a single record from the post-user-view view and returns it in an associative array
206 * @param array $fields
207 * @param array $condition
208 * @param array $params
209 * @param bool $user_mode true = post-user-view, false = post-view
214 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
216 $params['limit'] = 1;
218 $result = self::select($fields, $condition, $params);
220 if (is_bool($result)) {
223 $row = self::fetch($result);
230 * Retrieve a single record from the post-view view and returns it in an associative array
232 * @param array $fields
233 * @param array $condition
234 * @param array $params
239 public static function selectFirstPost(array $fields = [], array $condition = [], array $params = [])
241 $params['limit'] = 1;
243 $result = self::selectPosts($fields, $condition, $params);
245 if (is_bool($result)) {
248 $row = self::fetch($result);
255 * Retrieve a single record from the post-thread-user-view view and returns it in an associative array
257 * @param array $fields
258 * @param array $condition
259 * @param array $params
264 public static function selectFirstThread(array $fields = [], array $condition = [], array $params = [])
266 $params['limit'] = 1;
268 $result = self::selectThread($fields, $condition, $params);
270 if (is_bool($result)) {
273 $row = self::fetch($result);
280 * Select rows from the post-user-view view and returns them as an array
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
289 public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
291 $result = self::select($fields, $condition, $params);
293 if (is_bool($result)) {
298 while ($row = self::fetch($result)) {
307 * Select rows from the given view
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
314 * @return boolean|object
317 private static function selectView(string $view, array $selected = [], array $condition = [], array $params = [])
319 if (empty($selected)) {
320 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
322 if ($view == 'post-thread-user-view') {
323 $selected = array_merge($selected, ['ignored']);
327 $selected = array_unique($selected);
329 return DBA::select($view, $selected, $condition, $params);
333 * Select rows from the post-user-view view
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
339 * @return boolean|object
342 public static function select(array $selected = [], array $condition = [], array $params = [])
344 return self::selectView('post-user-view', $selected, $condition, $params);
348 * Select rows from the post-view view
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
354 * @return boolean|object
357 public static function selectPosts(array $selected = [], array $condition = [], array $params = [])
359 return self::selectView('post-view', $selected, $condition, $params);
363 * Select rows from the post-thread-user-view view
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
369 * @return boolean|object
372 public static function selectThread(array $selected = [], array $condition = [], array $params = [])
374 return self::selectView('post-thread-user-view', $selected, $condition, $params);
378 * Select rows from the post-thread-view view
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
384 * @return boolean|object
387 public static function selectPostThread(array $selected = [], array $condition = [], array $params = [])
389 return self::selectView('post-thread-view', $selected, $condition, $params);
393 * Select rows from the given view for a given user
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
401 * @return boolean|object
404 private static function selectViewForUser(string $view, int $uid, array $selected = [], array $condition = [], array $params = [])
406 if (empty($selected)) {
407 $selected = Item::DISPLAY_FIELDLIST;
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]);
423 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
425 $condition_string = DBA::buildCondition($condition);
426 $param_string = DBA::buildParameter($params);
428 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
429 $sql = DBA::cleanQuery($sql);
431 return DBA::p($sql, $condition);
435 * Select rows from the post-user-view view for a given user
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
442 * @return boolean|object
445 public static function selectForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
447 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
451 * Select rows from the post-view view for a given user
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
458 * @return boolean|object
461 public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
463 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
467 * Select rows from the post-thread-user-view view for a given user
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
474 * @return boolean|object
477 public static function selectThreadForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
479 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
483 * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
485 * @param integer $uid User ID
486 * @param array $selected
487 * @param array $condition
488 * @param array $params
493 public static function selectFirstForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
495 $params['limit'] = 1;
497 $result = self::selectForUser($uid, $selected, $condition, $params);
499 if (is_bool($result)) {
502 $row = self::fetch($result);
509 * Update existing post entries
511 * @param array $fields The fields that are to be changed
512 * @param array $condition The condition for finding the item entries
514 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
516 * @return integer|boolean number of affected rows - or "false" if there was an error
517 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
519 public static function update(array $fields, array $condition)
523 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => DI::userSession()->getLocalUserId(),'callstack' => System::callstack(10)]);
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']);
536 $thread_condition = DBA::mergeConditions($condition, ['gravity' => Item::GRAVITY_PARENT]);
538 // To ensure the data integrity we do it in an transaction
541 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-user', $fields);
542 if (!empty($update_fields)) {
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])) {
549 Logger::warning('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
552 $affected_count += DBA::affectedRows();
555 $affected = $affected_count;
558 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-content', $fields);
559 if (!empty($update_fields)) {
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])) {
566 Logger::warning('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
569 $affected_count += DBA::affectedRows();
572 $affected = max($affected, $affected_count);
575 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post', $fields);
576 if (!empty($update_fields)) {
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');
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']);
587 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
589 Logger::warning('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
592 $affected_count += DBA::affectedRows();
595 $affected = max($affected, $affected_count);
598 $update_fields = Post\DeliveryData::extractFields($fields);
599 if (!empty($update_fields)) {
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])) {
606 Logger::warning('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
609 $affected_count += DBA::affectedRows();
612 $affected = max($affected, $affected_count);
615 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread', $fields);
616 if (!empty($update_fields)) {
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])) {
623 Logger::warning('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
626 $affected_count += DBA::affectedRows();
629 $affected = max($affected, $affected_count);
632 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread-user', $fields);
633 if (!empty($update_fields)) {
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])) {
640 Logger::warning('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
643 $affected_count += DBA::affectedRows();
646 $affected = max($affected, $affected_count);
651 Logger::info('Updated posts', ['rows' => $affected]);
656 * Delete a row from the post table
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)
663 * @return boolean was the delete successful?
666 public static function delete(array $conditions, array $options = []): bool
668 return DBA::delete('post', $conditions, $options);