3 * @copyright Copyright (C) 2010-2021, 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;
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 = [])
45 throw new BadMethodCallException('Empty URI_id');
48 $fields = DBStructure::getFieldsForTable('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 an post query
107 * @param object $stmt statement object
108 * @param bool $do_close
109 * @return array Data array
111 public static function toArray($stmt, $do_close = true) {
112 if (is_bool($stmt)) {
117 while ($row = self::fetch($stmt)) {
127 * Check if post-user-view records exists
129 * @param array $condition array of fields for condition
131 * @return boolean Are there rows for that condition?
134 public static function exists($condition) {
135 return DBA::exists('post-user-view', $condition);
139 * Counts the post-user-view records satisfying the provided condition
141 * @param array $condition array of fields for condition
142 * @param array $params Array of several parameters
147 * $condition = ["uid" => 1, "network" => 'dspr'];
149 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
151 * $count = Post::count($condition);
154 public static function count(array $condition = [], array $params = [])
156 return DBA::count('post-user-view', $condition, $params);
160 * Counts the post-view records satisfying the provided condition
162 * @param array $condition array of fields for condition
163 * @param array $params Array of several parameters
168 * $condition = ["network" => 'dspr'];
170 * $condition = ["`network` IN (?, ?)", 1, 'dfrn', 'dspr'];
172 * $count = Post::count($condition);
175 public static function countPosts(array $condition = [], array $params = [])
177 return DBA::count('post-view', $condition, $params);
181 * Retrieve a single record from the post-user-view view and returns it in an associative array
183 * @param array $fields
184 * @param array $condition
185 * @param array $params
186 * @param bool $user_mode true = post-user-view, false = post-view
191 public static function selectFirst(array $fields = [], array $condition = [], $params = [])
193 $params['limit'] = 1;
195 $result = self::select($fields, $condition, $params);
197 if (is_bool($result)) {
200 $row = self::fetch($result);
207 * Retrieve a single record from the post-view view and returns it in an associative array
209 * @param array $fields
210 * @param array $condition
211 * @param array $params
216 public static function selectFirstPost(array $fields = [], array $condition = [], $params = [])
218 $params['limit'] = 1;
220 $result = self::selectPosts($fields, $condition, $params);
222 if (is_bool($result)) {
225 $row = self::fetch($result);
232 * Retrieve a single record from the post-thread-user-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 selectFirstThread(array $fields = [], array $condition = [], $params = [])
243 $params['limit'] = 1;
245 $result = self::selectThread($fields, $condition, $params);
247 if (is_bool($result)) {
250 $row = self::fetch($result);
257 * Select rows from the post-user-view view and returns them as an array
259 * @param array $selected Array of selected fields, empty for all
260 * @param array $condition Array of fields for condition
261 * @param array $params Array of several parameters
266 public static function selectToArray(array $fields = [], array $condition = [], $params = [])
268 $result = self::select($fields, $condition, $params);
270 if (is_bool($result)) {
275 while ($row = self::fetch($result)) {
284 * Select rows from the given view
286 * @param string $view View (post-user-view or post-thread-user-view)
287 * @param array $selected Array of selected fields, empty for all
288 * @param array $condition Array of fields for condition
289 * @param array $params Array of several parameters
291 * @return boolean|object
294 private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
296 if (empty($selected)) {
297 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
299 if ($view == 'post-thread-user-view') {
300 $selected = array_merge($selected, ['ignored']);
304 $selected = array_unique($selected);
306 return DBA::select($view, $selected, $condition, $params);
310 * Select rows from the post-user-view 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 public static function select(array $selected = [], array $condition = [], $params = [])
321 return self::selectView('post-user-view', $selected, $condition, $params);
325 * Select rows from the post-view view
327 * @param array $selected Array of selected fields, empty for all
328 * @param array $condition Array of fields for condition
329 * @param array $params Array of several parameters
331 * @return boolean|object
334 public static function selectPosts(array $selected = [], array $condition = [], $params = [])
336 return self::selectView('post-view', $selected, $condition, $params);
340 * Select rows from the post-thread-user-view view
342 * @param array $selected Array of selected fields, empty for all
343 * @param array $condition Array of fields for condition
344 * @param array $params Array of several parameters
346 * @return boolean|object
349 public static function selectThread(array $selected = [], array $condition = [], $params = [])
351 return self::selectView('post-thread-user-view', $selected, $condition, $params);
355 * Select rows from the given view for a given user
357 * @param string $view View (post-user-view or post-thread-user-view)
358 * @param integer $uid User ID
359 * @param array $selected Array of selected fields, empty for all
360 * @param array $condition Array of fields for condition
361 * @param array $params Array of several parameters
363 * @return boolean|object
366 private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
368 if (empty($selected)) {
369 $selected = Item::DISPLAY_FIELDLIST;
372 $condition = DBA::mergeConditions($condition,
373 ["`visible` AND NOT `deleted`
374 AND NOT `author-blocked` AND NOT `owner-blocked`
375 AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
376 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
377 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
378 AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `uri-id` = `" . $view . "`.`uri-id` AND `hidden`)
379 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
380 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
381 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
382 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
383 0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
385 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
387 $condition_string = DBA::buildCondition($condition);
388 $param_string = DBA::buildParameter($params);
390 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
391 $sql = DBA::cleanQuery($sql);
393 return DBA::p($sql, $condition);
397 * Select rows from the post-user-view view for a given user
399 * @param integer $uid User ID
400 * @param array $selected Array of selected fields, empty for all
401 * @param array $condition Array of fields for condition
402 * @param array $params Array of several parameters
404 * @return boolean|object
407 public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
409 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
413 * Select rows from the post-view view for a given user
415 * @param integer $uid User ID
416 * @param array $selected Array of selected fields, empty for all
417 * @param array $condition Array of fields for condition
418 * @param array $params Array of several parameters
420 * @return boolean|object
423 public static function selectPostsForUser($uid, array $selected = [], array $condition = [], $params = [])
425 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
429 * Select rows from the post-thread-user-view view for a given user
431 * @param integer $uid User ID
432 * @param array $selected Array of selected fields, empty for all
433 * @param array $condition Array of fields for condition
434 * @param array $params Array of several parameters
436 * @return boolean|object
439 public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
441 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
445 * Retrieve a single record from the post-user-view view for a given user and returns it in an associative array
447 * @param integer $uid User ID
448 * @param array $selected
449 * @param array $condition
450 * @param array $params
455 public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
457 $params['limit'] = 1;
459 $result = self::selectForUser($uid, $selected, $condition, $params);
461 if (is_bool($result)) {
464 $row = self::fetch($result);
471 * Select pinned rows from the post-thread-user table for a given user
473 * @param integer $uid User ID
474 * @param array $selected Array of selected fields, empty for all
475 * @param array $condition Array of fields for condition
476 * @param array $params Array of several parameters
478 * @return boolean|object
481 public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
483 $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
484 if (!DBA::isResult($postthreaduser)) {
485 return $postthreaduser;
489 while ($useritem = DBA::fetch($postthreaduser)) {
490 $pinned[] = $useritem['uri-id'];
492 DBA::close($postthreaduser);
494 if (empty($pinned)) {
498 $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
500 return self::selectForUser($uid, $selected, $condition, $params);
504 * Update existing post entries
506 * @param array $fields The fields that are to be changed
507 * @param array $condition The condition for finding the item entries
509 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
511 * @return integer|boolean number of affected rows - or "false" if there was an error
512 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
514 public static function update(array $fields, array $condition)
518 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => local_user(),'callstack' => System::callstack(10)]);
520 // Don't allow changes to fields that are responsible for the relation between the records
521 unset($fields['id']);
522 unset($fields['parent']);
523 unset($fields['uid']);
524 unset($fields['uri']);
525 unset($fields['uri-id']);
526 unset($fields['thr-parent']);
527 unset($fields['thr-parent-id']);
528 unset($fields['parent-uri']);
529 unset($fields['parent-uri-id']);
531 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
533 // To ensure the data integrity we do it in an transaction
536 $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
537 if (!empty($update_fields)) {
539 $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
540 while ($rows = DBA::toArray($posts, false, 100)) {
541 $puids = array_column($rows, 'post-user-id');
542 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
544 Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
547 $affected_count += DBA::affectedRows();
550 $affected = $affected_count;
553 $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
554 if (!empty($update_fields)) {
556 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
557 while ($rows = DBA::toArray($posts, false, 100)) {
558 $uriids = array_column($rows, 'uri-id');
559 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
561 Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
564 $affected_count += DBA::affectedRows();
567 $affected = max($affected, $affected_count);
570 $update_fields = DBStructure::getFieldsForTable('post', $fields);
571 if (!empty($update_fields)) {
573 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
574 while ($rows = DBA::toArray($posts, false, 100)) {
575 $uriids = array_column($rows, 'uri-id');
576 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
578 Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
581 $affected_count += DBA::affectedRows();
584 $affected = max($affected, $affected_count);
587 $update_fields = Post\DeliveryData::extractFields($fields);
588 if (!empty($update_fields)) {
590 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
591 while ($rows = DBA::toArray($posts, false, 100)) {
592 $uriids = array_column($rows, 'uri-id');
593 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
595 Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
598 $affected_count += DBA::affectedRows();
601 $affected = max($affected, $affected_count);
604 $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
605 if (!empty($update_fields)) {
607 $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
608 while ($rows = DBA::toArray($posts, false, 100)) {
609 $uriids = array_column($rows, 'uri-id');
610 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
612 Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
615 $affected_count += DBA::affectedRows();
618 $affected = max($affected, $affected_count);
621 $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
622 if (!empty($update_fields)) {
624 $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
625 while ($rows = DBA::toArray($posts, false, 100)) {
626 $thread_puids = array_column($rows, 'post-user-id');
627 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
629 Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
632 $affected_count += DBA::affectedRows();
635 $affected = max($affected, $affected_count);
640 Logger::info('Updated posts', ['rows' => $affected]);
645 * Delete a row from the post table
647 * @param array $conditions Field condition(s)
648 * @param array $options
649 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
650 * relations (default: true)
652 * @return boolean was the delete successful?
655 public static function delete(array $conditions, array $options = [])
657 return DBA::delete('post', $conditions, $options);