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;
29 use Friendica\Database\DBStructure;
31 use Friendica\Model\Item;
32 use Friendica\Protocol\Activity;
37 * Insert a new post entry
39 * @param integer $uri_id
40 * @param array $fields
41 * @return int ID of inserted post
44 public static function insert(int $uri_id, array $data = []): int
47 throw new BadMethodCallException('Empty URI_id');
50 $fields = DI::dbaDefinition()->truncateFieldsForTable('post', $data);
52 // Additionally assign the key fields
53 $fields['uri-id'] = $uri_id;
55 if (!DBA::insert('post', $fields, Database::INSERT_IGNORE)) {
59 return DBA::lastInsertId();
63 * Fetch a single post row
65 * @param mixed $stmt statement object
66 * @return array|false current row or false
69 public static function fetch($stmt)
71 $row = DBA::fetch($stmt);
73 if (!is_array($row)) {
77 if (array_key_exists('verb', $row)) {
78 if (in_array($row['verb'], Item::ACTIVITIES)) {
79 if (array_key_exists('title', $row)) {
82 if (array_key_exists('body', $row)) {
83 $row['body'] = $row['verb'];
85 if (array_key_exists('object', $row)) {
88 if (array_key_exists('object-type', $row)) {
89 $row['object-type'] = Activity\ObjectType::NOTE;
91 } elseif (in_array($row['verb'], ['', Activity::POST, Activity::SHARE])) {
92 // Posts don't have a target - but having tags or files.
93 if (array_key_exists('target', $row)) {
99 if (array_key_exists('extid', $row) && is_null($row['extid'])) {
107 * Fills an array with data from an post query
109 * @param object $stmt statement object
110 * @param bool $do_close
111 * @return array Data array
112 * @todo Find proper type-hint for $stmt and maybe avoid boolean
114 public static function toArray($stmt, bool $do_close = true)
116 if (is_bool($stmt)) {
121 while ($row = self::fetch($stmt)) {
131 * Check if post-user-view records exists
133 * @param array $condition array of fields for condition
135 * @return boolean Are there rows for that condition?
138 public static function exists(array $condition): bool
140 return DBA::exists('post-user-view', $condition);
144 * Counts the post-user-view records satisfying the provided condition
146 * @param array $condition array of fields for condition
147 * @param array $params Array of several parameters
152 * $condition = ["uid" => 1, "network" => 'dspr'];
154 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
156 * $count = Post::count($condition);
159 public static function count(array $condition = [], array $params = []): int
161 return DBA::count('post-user-view', $condition, $params);
165 * Counts the post-thread-user-view records satisfying the provided condition
167 * @param array $condition array of fields for condition
168 * @param array $params Array of several parameters
173 * $condition = ["uid" => 1, "network" => 'dspr'];
175 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
177 * $count = Post::count($condition);
180 public static function countThread(array $condition = [], array $params = []): int
182 return DBA::count('post-thread-user-view', $condition, $params);
186 * Counts the post-view records satisfying the provided condition
188 * @param array $condition array of fields for condition
189 * @param array $params Array of several parameters
194 * $condition = ["network" => 'dspr'];
196 * $condition = ["`network` IN (?, ?)", 1, 'dfrn', 'dspr'];
198 * $count = Post::count($condition);
201 public static function countPosts(array $condition = [], array $params = []): int
203 return DBA::count('post-view', $condition, $params);
207 * Retrieve a single record from the post-user-view view and returns it in an associative array
209 * @param array $fields
210 * @param array $condition
211 * @param array $params
212 * @param bool $user_mode true = post-user-view, false = post-view
217 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
219 $params['limit'] = 1;
221 $result = self::select($fields, $condition, $params);
223 if (is_bool($result)) {
226 $row = self::fetch($result);
233 * Retrieve a single record from the post-view view and returns it in an associative array
235 * @param array $fields
236 * @param array $condition
237 * @param array $params
242 public static function selectFirstPost(array $fields = [], array $condition = [], array $params = [])
244 $params['limit'] = 1;
246 $result = self::selectPosts($fields, $condition, $params);
248 if (is_bool($result)) {
251 $row = self::fetch($result);
258 * Retrieve a single record from the post-thread-user-view view and returns it in an associative array
260 * @param array $fields
261 * @param array $condition
262 * @param array $params
267 public static function selectFirstThread(array $fields = [], array $condition = [], array $params = [])
269 $params['limit'] = 1;
271 $result = self::selectThread($fields, $condition, $params);
273 if (is_bool($result)) {
276 $row = self::fetch($result);
283 * Select rows from the post-user-view view and returns them as an array
285 * @param array $selected Array of selected fields, empty for all
286 * @param array $condition Array of fields for condition
287 * @param array $params Array of several parameters
292 public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
294 $result = self::select($fields, $condition, $params);
296 if (is_bool($result)) {
301 while ($row = self::fetch($result)) {
310 * Select rows from the given view
312 * @param string $view View (post-user-view or post-thread-user-view)
313 * @param array $selected Array of selected fields, empty for all
314 * @param array $condition Array of fields for condition
315 * @param array $params Array of several parameters
317 * @return boolean|object
320 private static function selectView(string $view, array $selected = [], array $condition = [], array $params = [])
322 if (empty($selected)) {
323 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
325 if ($view == 'post-thread-user-view') {
326 $selected = array_merge($selected, ['ignored']);
330 $selected = array_unique($selected);
332 return DBA::select($view, $selected, $condition, $params);
336 * Select rows from the post-user-view view
338 * @param array $selected Array of selected fields, empty for all
339 * @param array $condition Array of fields for condition
340 * @param array $params Array of several parameters
342 * @return boolean|object
345 public static function select(array $selected = [], array $condition = [], array $params = [])
347 return self::selectView('post-user-view', $selected, $condition, $params);
351 * Select rows from the post-view view
353 * @param array $selected Array of selected fields, empty for all
354 * @param array $condition Array of fields for condition
355 * @param array $params Array of several parameters
357 * @return boolean|object
360 public static function selectPosts(array $selected = [], array $condition = [], array $params = [])
362 return self::selectView('post-view', $selected, $condition, $params);
366 * Select rows from the post-thread-user-view view
368 * @param array $selected Array of selected fields, empty for all
369 * @param array $condition Array of fields for condition
370 * @param array $params Array of several parameters
372 * @return boolean|object
375 public static function selectThread(array $selected = [], array $condition = [], array $params = [])
377 return self::selectView('post-thread-user-view', $selected, $condition, $params);
381 * Select rows from the given view for a given user
383 * @param string $view View (post-user-view or post-thread-user-view)
384 * @param integer $uid User ID
385 * @param array $selected Array of selected fields, empty for all
386 * @param array $condition Array of fields for condition
387 * @param array $params Array of several parameters
389 * @return boolean|object
392 private static function selectViewForUser(string $view, int $uid, array $selected = [], array $condition = [], array $params = [])
394 if (empty($selected)) {
395 $selected = Item::DISPLAY_FIELDLIST;
398 $condition = DBA::mergeConditions($condition,
399 ["`visible` AND NOT `deleted`
400 AND NOT `author-blocked` AND NOT `owner-blocked`
401 AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
402 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
403 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
404 AND NOT `" . $view . "`.`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `hidden`)
405 AND NOT `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `blocked`)
406 AND NOT `owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `blocked`)
407 AND NOT (`gravity` = ? AND `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `ignored`))
408 AND NOT (`gravity` = ? AND `owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `ignored`))",
409 0, Contact::SHARING, Contact::FRIEND, Item::GRAVITY_PARENT, 0, $uid, $uid, $uid, Item::GRAVITY_PARENT, $uid, Item::GRAVITY_PARENT, $uid]);
411 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
413 $condition_string = DBA::buildCondition($condition);
414 $param_string = DBA::buildParameter($params);
416 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
417 $sql = DBA::cleanQuery($sql);
419 return DBA::p($sql, $condition);
423 * Select rows from the post-user-view view for a given user
425 * @param integer $uid User ID
426 * @param array $selected Array of selected fields, empty for all
427 * @param array $condition Array of fields for condition
428 * @param array $params Array of several parameters
430 * @return boolean|object
433 public static function selectForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
435 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
439 * Select rows from the post-view view for a given user
441 * @param integer $uid User ID
442 * @param array $selected Array of selected fields, empty for all
443 * @param array $condition Array of fields for condition
444 * @param array $params Array of several parameters
446 * @return boolean|object
449 public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
451 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
455 * Select rows from the post-thread-user-view view for a given user
457 * @param integer $uid User ID
458 * @param array $selected Array of selected fields, empty for all
459 * @param array $condition Array of fields for condition
460 * @param array $params Array of several parameters
462 * @return boolean|object
465 public static function selectThreadForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
467 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
471 * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
473 * @param integer $uid User ID
474 * @param array $selected
475 * @param array $condition
476 * @param array $params
481 public static function selectFirstForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
483 $params['limit'] = 1;
485 $result = self::selectForUser($uid, $selected, $condition, $params);
487 if (is_bool($result)) {
490 $row = self::fetch($result);
497 * Update existing post entries
499 * @param array $fields The fields that are to be changed
500 * @param array $condition The condition for finding the item entries
502 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
504 * @return integer|boolean number of affected rows - or "false" if there was an error
505 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
507 public static function update(array $fields, array $condition)
511 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => DI::userSession()->getLocalUserId(),'callstack' => System::callstack(10)]);
513 // Don't allow changes to fields that are responsible for the relation between the records
514 unset($fields['id']);
515 unset($fields['parent']);
516 unset($fields['uid']);
517 unset($fields['uri']);
518 unset($fields['uri-id']);
519 unset($fields['thr-parent']);
520 unset($fields['thr-parent-id']);
521 unset($fields['parent-uri']);
522 unset($fields['parent-uri-id']);
524 $thread_condition = DBA::mergeConditions($condition, ['gravity' => Item::GRAVITY_PARENT]);
526 // To ensure the data integrity we do it in an transaction
529 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-user', $fields);
530 if (!empty($update_fields)) {
532 $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
533 while ($rows = DBA::toArray($posts, false, 100)) {
534 $puids = array_column($rows, 'post-user-id');
535 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
537 Logger::warning('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
540 $affected_count += DBA::affectedRows();
543 $affected = $affected_count;
546 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-content', $fields);
547 if (!empty($update_fields)) {
549 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
550 while ($rows = DBA::toArray($posts, false, 100)) {
551 $uriids = array_column($rows, 'uri-id');
552 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
554 Logger::warning('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
557 $affected_count += DBA::affectedRows();
560 $affected = max($affected, $affected_count);
563 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post', $fields);
564 if (!empty($update_fields)) {
566 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
567 while ($rows = DBA::toArray($posts, false, 100)) {
568 $uriids = array_column($rows, 'uri-id');
570 // Only delete the "post" entry when all "post-user" entries are deleted
571 if (!empty($update_fields['deleted']) && DBA::exists('post-user', ['uri-id' => $uriids, 'deleted' => false])) {
572 unset($update_fields['deleted']);
575 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
577 Logger::warning('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
580 $affected_count += DBA::affectedRows();
583 $affected = max($affected, $affected_count);
586 $update_fields = Post\DeliveryData::extractFields($fields);
587 if (!empty($update_fields)) {
589 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
590 while ($rows = DBA::toArray($posts, false, 100)) {
591 $uriids = array_column($rows, 'uri-id');
592 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
594 Logger::warning('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
597 $affected_count += DBA::affectedRows();
600 $affected = max($affected, $affected_count);
603 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread', $fields);
604 if (!empty($update_fields)) {
606 $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
607 while ($rows = DBA::toArray($posts, false, 100)) {
608 $uriids = array_column($rows, 'uri-id');
609 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
611 Logger::warning('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
614 $affected_count += DBA::affectedRows();
617 $affected = max($affected, $affected_count);
620 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread-user', $fields);
621 if (!empty($update_fields)) {
623 $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
624 while ($rows = DBA::toArray($posts, false, 100)) {
625 $thread_puids = array_column($rows, 'post-user-id');
626 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
628 Logger::warning('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
631 $affected_count += DBA::affectedRows();
634 $affected = max($affected, $affected_count);
639 Logger::info('Updated posts', ['rows' => $affected]);
644 * Delete a row from the post table
646 * @param array $conditions Field condition(s)
647 * @param array $options
648 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
649 * relations (default: true)
651 * @return boolean was the delete successful?
654 public static function delete(array $conditions, array $options = []): bool
656 return DBA::delete('post', $conditions, $options);