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\Protocol\Activity;
36 * Insert a new post entry
38 * @param integer $uri_id
39 * @param array $fields
40 * @return int ID of inserted post
43 public static function insert(int $uri_id, array $data = []): int
46 throw new BadMethodCallException('Empty URI_id');
49 $fields = DI::dbaDefinition()->truncateFieldsForTable('post', $data);
51 // Additionally assign the key fields
52 $fields['uri-id'] = $uri_id;
54 if (!DBA::insert('post', $fields, Database::INSERT_IGNORE)) {
58 return DBA::lastInsertId();
62 * Fetch a single post row
64 * @param mixed $stmt statement object
65 * @return array|false current row or false
68 public static function fetch($stmt)
70 $row = DBA::fetch($stmt);
72 if (!is_array($row)) {
76 if (array_key_exists('verb', $row)) {
77 if (in_array($row['verb'], Item::ACTIVITIES)) {
78 if (array_key_exists('title', $row)) {
81 if (array_key_exists('body', $row)) {
82 $row['body'] = $row['verb'];
84 if (array_key_exists('object', $row)) {
87 if (array_key_exists('object-type', $row)) {
88 $row['object-type'] = Activity\ObjectType::NOTE;
90 } elseif (in_array($row['verb'], ['', Activity::POST, Activity::SHARE])) {
91 // Posts don't have a target - but having tags or files.
92 if (array_key_exists('target', $row)) {
98 if (array_key_exists('extid', $row) && is_null($row['extid'])) {
106 * Fills an array with data from an post query
108 * @param object $stmt statement object
109 * @param bool $do_close
110 * @return array Data array
111 * @todo Find proper type-hint for $stmt and maybe avoid boolean
113 public static function toArray($stmt, bool $do_close = true)
115 if (is_bool($stmt)) {
120 while ($row = self::fetch($stmt)) {
130 * Check if post-user-view records exists
132 * @param array $condition array of fields for condition
134 * @return boolean Are there rows for that condition?
137 public static function exists(array $condition): bool
139 return DBA::exists('post-user-view', $condition);
143 * Counts the post-user-view records satisfying the provided condition
145 * @param array $condition array of fields for condition
146 * @param array $params Array of several parameters
151 * $condition = ["uid" => 1, "network" => 'dspr'];
153 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
155 * $count = Post::count($condition);
158 public static function count(array $condition = [], array $params = []): int
160 return DBA::count('post-user-view', $condition, $params);
164 * Counts the post-thread-user-view records satisfying the provided condition
166 * @param array $condition array of fields for condition
167 * @param array $params Array of several parameters
172 * $condition = ["uid" => 1, "network" => 'dspr'];
174 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
176 * $count = Post::count($condition);
179 public static function countThread(array $condition = [], array $params = []): int
181 return DBA::count('post-thread-user-view', $condition, $params);
185 * Counts the post-view records satisfying the provided condition
187 * @param array $condition array of fields for condition
188 * @param array $params Array of several parameters
193 * $condition = ["network" => 'dspr'];
195 * $condition = ["`network` IN (?, ?)", 1, 'dfrn', 'dspr'];
197 * $count = Post::count($condition);
200 public static function countPosts(array $condition = [], array $params = []): int
202 return DBA::count('post-view', $condition, $params);
206 * Retrieve a single record from the post-user-view view and returns it in an associative array
208 * @param array $fields
209 * @param array $condition
210 * @param array $params
211 * @param bool $user_mode true = post-user-view, false = post-view
216 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
218 $params['limit'] = 1;
220 $result = self::select($fields, $condition, $params);
222 if (is_bool($result)) {
225 $row = self::fetch($result);
232 * Retrieve a single record from the post-view view and returns it in an associative array
234 * @param array $fields
235 * @param array $condition
236 * @param array $params
241 public static function selectFirstPost(array $fields = [], array $condition = [], array $params = [])
243 $params['limit'] = 1;
245 $result = self::selectPosts($fields, $condition, $params);
247 if (is_bool($result)) {
250 $row = self::fetch($result);
257 * Retrieve a single record from the post-thread-user-view view and returns it in an associative array
259 * @param array $fields
260 * @param array $condition
261 * @param array $params
266 public static function selectFirstThread(array $fields = [], array $condition = [], array $params = [])
268 $params['limit'] = 1;
270 $result = self::selectThread($fields, $condition, $params);
272 if (is_bool($result)) {
275 $row = self::fetch($result);
282 * Select rows from the post-user-view view and returns them as an array
284 * @param array $selected Array of selected fields, empty for all
285 * @param array $condition Array of fields for condition
286 * @param array $params Array of several parameters
291 public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
293 $result = self::select($fields, $condition, $params);
295 if (is_bool($result)) {
300 while ($row = self::fetch($result)) {
309 * Select rows from the given view
311 * @param string $view View (post-user-view or post-thread-user-view)
312 * @param array $selected Array of selected fields, empty for all
313 * @param array $condition Array of fields for condition
314 * @param array $params Array of several parameters
316 * @return boolean|object
319 private static function selectView(string $view, array $selected = [], array $condition = [], array $params = [])
321 if (empty($selected)) {
322 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
324 if ($view == 'post-thread-user-view') {
325 $selected = array_merge($selected, ['ignored']);
329 $selected = array_unique($selected);
331 return DBA::select($view, $selected, $condition, $params);
335 * Select rows from the post-user-view view
337 * @param array $selected Array of selected fields, empty for all
338 * @param array $condition Array of fields for condition
339 * @param array $params Array of several parameters
341 * @return boolean|object
344 public static function select(array $selected = [], array $condition = [], array $params = [])
346 return self::selectView('post-user-view', $selected, $condition, $params);
350 * Select rows from the post-view view
352 * @param array $selected Array of selected fields, empty for all
353 * @param array $condition Array of fields for condition
354 * @param array $params Array of several parameters
356 * @return boolean|object
359 public static function selectPosts(array $selected = [], array $condition = [], array $params = [])
361 return self::selectView('post-view', $selected, $condition, $params);
365 * Select rows from the post-thread-user-view view
367 * @param array $selected Array of selected fields, empty for all
368 * @param array $condition Array of fields for condition
369 * @param array $params Array of several parameters
371 * @return boolean|object
374 public static function selectThread(array $selected = [], array $condition = [], array $params = [])
376 return self::selectView('post-thread-user-view', $selected, $condition, $params);
380 * Select rows from the given view for a given user
382 * @param string $view View (post-user-view or post-thread-user-view)
383 * @param integer $uid User ID
384 * @param array $selected Array of selected fields, empty for all
385 * @param array $condition Array of fields for condition
386 * @param array $params Array of several parameters
388 * @return boolean|object
391 private static function selectViewForUser(string $view, int $uid, array $selected = [], array $condition = [], array $params = [])
393 if (empty($selected)) {
394 $selected = Item::DISPLAY_FIELDLIST;
397 $condition = DBA::mergeConditions($condition,
398 ["`visible` AND NOT `deleted`
399 AND NOT `author-blocked` AND NOT `owner-blocked`
400 AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
401 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
402 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
403 AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `uri-id` = `" . $view . "`.`uri-id` AND `hidden`)
404 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
405 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
406 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
407 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
408 0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
410 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
412 $condition_string = DBA::buildCondition($condition);
413 $param_string = DBA::buildParameter($params);
415 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
416 $sql = DBA::cleanQuery($sql);
418 return DBA::p($sql, $condition);
422 * Select rows from the post-user-view view for a given user
424 * @param integer $uid User ID
425 * @param array $selected Array of selected fields, empty for all
426 * @param array $condition Array of fields for condition
427 * @param array $params Array of several parameters
429 * @return boolean|object
432 public static function selectForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
434 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
438 * Select rows from the post-view view for a given user
440 * @param integer $uid User ID
441 * @param array $selected Array of selected fields, empty for all
442 * @param array $condition Array of fields for condition
443 * @param array $params Array of several parameters
445 * @return boolean|object
448 public static function selectPostsForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
450 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
454 * Select rows from the post-thread-user-view view for a given user
456 * @param integer $uid User ID
457 * @param array $selected Array of selected fields, empty for all
458 * @param array $condition Array of fields for condition
459 * @param array $params Array of several parameters
461 * @return boolean|object
464 public static function selectThreadForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
466 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
470 * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
472 * @param integer $uid User ID
473 * @param array $selected
474 * @param array $condition
475 * @param array $params
480 public static function selectFirstForUser(int $uid, array $selected = [], array $condition = [], array $params = [])
482 $params['limit'] = 1;
484 $result = self::selectForUser($uid, $selected, $condition, $params);
486 if (is_bool($result)) {
489 $row = self::fetch($result);
496 * Update existing post entries
498 * @param array $fields The fields that are to be changed
499 * @param array $condition The condition for finding the item entries
501 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
503 * @return integer|boolean number of affected rows - or "false" if there was an error
504 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
506 public static function update(array $fields, array $condition)
510 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => local_user(),'callstack' => System::callstack(10)]);
512 // Don't allow changes to fields that are responsible for the relation between the records
513 unset($fields['id']);
514 unset($fields['parent']);
515 unset($fields['uid']);
516 unset($fields['uri']);
517 unset($fields['uri-id']);
518 unset($fields['thr-parent']);
519 unset($fields['thr-parent-id']);
520 unset($fields['parent-uri']);
521 unset($fields['parent-uri-id']);
523 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
525 // To ensure the data integrity we do it in an transaction
528 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-user', $fields);
529 if (!empty($update_fields)) {
531 $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
532 while ($rows = DBA::toArray($posts, false, 100)) {
533 $puids = array_column($rows, 'post-user-id');
534 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
536 Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
539 $affected_count += DBA::affectedRows();
542 $affected = $affected_count;
545 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-content', $fields);
546 if (!empty($update_fields)) {
548 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
549 while ($rows = DBA::toArray($posts, false, 100)) {
550 $uriids = array_column($rows, 'uri-id');
551 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
553 Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
556 $affected_count += DBA::affectedRows();
559 $affected = max($affected, $affected_count);
562 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post', $fields);
563 if (!empty($update_fields)) {
565 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
566 while ($rows = DBA::toArray($posts, false, 100)) {
567 $uriids = array_column($rows, 'uri-id');
568 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
570 Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
573 $affected_count += DBA::affectedRows();
576 $affected = max($affected, $affected_count);
579 $update_fields = Post\DeliveryData::extractFields($fields);
580 if (!empty($update_fields)) {
582 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
583 while ($rows = DBA::toArray($posts, false, 100)) {
584 $uriids = array_column($rows, 'uri-id');
585 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
587 Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
590 $affected_count += DBA::affectedRows();
593 $affected = max($affected, $affected_count);
596 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread', $fields);
597 if (!empty($update_fields)) {
599 $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
600 while ($rows = DBA::toArray($posts, false, 100)) {
601 $uriids = array_column($rows, 'uri-id');
602 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
604 Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
607 $affected_count += DBA::affectedRows();
610 $affected = max($affected, $affected_count);
613 $update_fields = DI::dbaDefinition()->truncateFieldsForTable('post-thread-user', $fields);
614 if (!empty($update_fields)) {
616 $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
617 while ($rows = DBA::toArray($posts, false, 100)) {
618 $thread_puids = array_column($rows, 'post-user-id');
619 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
621 Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
624 $affected_count += DBA::affectedRows();
627 $affected = max($affected, $affected_count);
632 Logger::info('Updated posts', ['rows' => $affected]);
637 * Delete a row from the post table
639 * @param array $conditions Field condition(s)
640 * @param array $options
641 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
642 * relations (default: true)
644 * @return boolean was the delete successful?
647 public static function delete(array $conditions, array $options = []): bool
649 return DBA::delete('post', $conditions, $options);