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 given view for a given user
380 * @param string $view View (post-user-view or post-thread-user-view)
381 * @param integer $uid User ID
382 * @param array $selected Array of selected fields, empty for all
383 * @param array $condition Array of fields for condition
384 * @param array $params Array of several parameters
386 * @return boolean|object
389 private static function selectViewForUser(string $view, int $uid, array $selected = [], array $condition = [], array $params = [])
391 if (empty($selected)) {
392 $selected = Item::DISPLAY_FIELDLIST;
395 $condition = DBA::mergeConditions($condition,
396 ["`visible` AND NOT `deleted`
397 AND NOT `author-blocked` AND NOT `owner-blocked`
398 AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
399 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
400 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
401 AND NOT `" . $view . "`.`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `hidden`)
402 AND NOT `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `blocked` AND `cid` = `author-id`)
403 AND NOT `owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `blocked` AND `cid` = `owner-id`)
404 AND NOT (`gravity` = ? AND `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `ignored` AND `cid` = `author-id`))
405 AND NOT (`gravity` = ? AND `owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `ignored` AND `cid` = `owner-id`))",
406 0, Contact::SHARING, Contact::FRIEND, Item::GRAVITY_PARENT, 0, $uid, $uid, $uid, Item::GRAVITY_PARENT, $uid, Item::GRAVITY_PARENT, $uid]);
408 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
410 $condition_string = DBA::buildCondition($condition);
411 $param_string = DBA::buildParameter($params);
413 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
414 $sql = DBA::cleanQuery($sql);
416 return DBA::p($sql, $condition);
420 * Select rows from the post-user-view view for a given user
422 * @param integer $uid User ID
423 * @param array $selected Array of selected fields, empty for all
424 * @param array $condition Array of fields for condition
425 * @param array $params Array of several parameters
427 * @return boolean|object
430 public static function selectForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
432 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
436 * Select rows from the post-view view for a given user
438 * @param integer $uid User ID
439 * @param array $selected Array of selected fields, empty for all
440 * @param array $condition Array of fields for condition
441 * @param array $params Array of several parameters
443 * @return boolean|object
446 public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
448 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
452 * Select rows from the post-thread-user-view view for a given user
454 * @param integer $uid User ID
455 * @param array $selected Array of selected fields, empty for all
456 * @param array $condition Array of fields for condition
457 * @param array $params Array of several parameters
459 * @return boolean|object
462 public static function selectThreadForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
464 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
468 * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
470 * @param integer $uid User ID
471 * @param array $selected
472 * @param array $condition
473 * @param array $params
478 public static function selectFirstForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
480 $params['limit'] = 1;
482 $result = self::selectForUser($uid, $selected, $condition, $params);
484 if (is_bool($result)) {
487 $row = self::fetch($result);
494 * Update existing post entries
496 * @param array $fields The fields that are to be changed
497 * @param array $condition The condition for finding the item entries
499 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
501 * @return integer|boolean number of affected rows - or "false" if there was an error
502 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
504 public static function update(array $fields, array $condition)
508 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => DI::userSession()->getLocalUserId(),'callstack' => System::callstack(10)]);
510 // Don't allow changes to fields that are responsible for the relation between the records
511 unset($fields['id']);
512 unset($fields['parent']);
513 unset($fields['uid']);
514 unset($fields['uri']);
515 unset($fields['uri-id']);
516 unset($fields['thr-parent']);
517 unset($fields['thr-parent-id']);
518 unset($fields['parent-uri']);
519 unset($fields['parent-uri-id']);
521 $thread_condition = DBA::mergeConditions($condition, ['gravity' => Item::GRAVITY_PARENT]);
523 // To ensure the data integrity we do it in an transaction
526 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-user', $fields);
527 if (!empty($update_fields)) {
529 $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
530 while ($rows = DBA::toArray($posts, false, 100)) {
531 $puids = array_column($rows, 'post-user-id');
532 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
534 Logger::warning('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
537 $affected_count += DBA::affectedRows();
540 $affected = $affected_count;
543 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-content', $fields);
544 if (!empty($update_fields)) {
546 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
547 while ($rows = DBA::toArray($posts, false, 100)) {
548 $uriids = array_column($rows, 'uri-id');
549 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
551 Logger::warning('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
554 $affected_count += DBA::affectedRows();
557 $affected = max($affected, $affected_count);
560 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post', $fields);
561 if (!empty($update_fields)) {
563 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
564 while ($rows = DBA::toArray($posts, false, 100)) {
565 $uriids = array_column($rows, 'uri-id');
567 // Only delete the "post" entry when all "post-user" entries are deleted
568 if (!empty($update_fields['deleted']) && DBA::exists('post-user', ['uri-id' => $uriids, 'deleted' => false])) {
569 unset($update_fields['deleted']);
572 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
574 Logger::warning('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
577 $affected_count += DBA::affectedRows();
580 $affected = max($affected, $affected_count);
583 $update_fields = Post\DeliveryData::extractFields($fields);
584 if (!empty($update_fields)) {
586 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
587 while ($rows = DBA::toArray($posts, false, 100)) {
588 $uriids = array_column($rows, 'uri-id');
589 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
591 Logger::warning('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
594 $affected_count += DBA::affectedRows();
597 $affected = max($affected, $affected_count);
600 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread', $fields);
601 if (!empty($update_fields)) {
603 $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
604 while ($rows = DBA::toArray($posts, false, 100)) {
605 $uriids = array_column($rows, 'uri-id');
606 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
608 Logger::warning('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
611 $affected_count += DBA::affectedRows();
614 $affected = max($affected, $affected_count);
617 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread-user', $fields);
618 if (!empty($update_fields)) {
620 $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
621 while ($rows = DBA::toArray($posts, false, 100)) {
622 $thread_puids = array_column($rows, 'post-user-id');
623 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
625 Logger::warning('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
628 $affected_count += DBA::affectedRows();
631 $affected = max($affected, $affected_count);
636 Logger::info('Updated posts', ['rows' => $affected]);
641 * Delete a row from the post table
643 * @param array $conditions Field condition(s)
644 * @param array $options
645 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
646 * relations (default: true)
648 * @return boolean was the delete successful?
651 public static function delete(array $conditions, array $options = []): bool
653 return DBA::delete('post', $conditions, $options);