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 data exists
129 * @param array $condition array of fields for condition
130 * @param bool $user_mode true = post-user-view, false = post-view
132 * @return boolean Are there rows for that condition?
135 public static function exists($condition, bool $user_mode = true) {
136 return DBA::exists($user_mode ? 'post-user-view' : 'post-view', $condition);
140 * Counts the posts satisfying the provided condition
142 * @param array $condition array of fields for condition
143 * @param array $params Array of several parameters
144 * @param bool $user_mode true = post-user-view, false = post-view
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 = [], bool $user_mode = true)
158 return DBA::count($user_mode ? 'post-user-view' : 'post-view', $condition, $params);
162 * Retrieve a single record from the post table and returns it in an associative array
164 * @param array $fields
165 * @param array $condition
166 * @param array $params
167 * @param bool $user_mode true = post-user-view, false = post-view
172 public static function selectFirst(array $fields = [], array $condition = [], $params = [], bool $user_mode = true)
174 $params['limit'] = 1;
176 $result = self::select($fields, $condition, $params, $user_mode);
178 if (is_bool($result)) {
181 $row = self::fetch($result);
188 * Retrieve a single record from the post-thread table and returns it in an associative array
190 * @param array $fields
191 * @param array $condition
192 * @param array $params
197 public static function selectFirstThread(array $fields = [], array $condition = [], $params = [])
199 $params['limit'] = 1;
201 $result = self::selectThread($fields, $condition, $params);
203 if (is_bool($result)) {
206 $row = self::fetch($result);
213 * Select rows from the post table and returns them as an array
215 * @param array $selected Array of selected fields, empty for all
216 * @param array $condition Array of fields for condition
217 * @param array $params Array of several parameters
222 public static function selectToArray(array $fields = [], array $condition = [], $params = [])
224 $result = self::select($fields, $condition, $params);
226 if (is_bool($result)) {
231 while ($row = self::fetch($result)) {
240 * Select rows from the given view
242 * @param string $view View (post-user-view or post-thread-user-view)
243 * @param array $selected Array of selected fields, empty for all
244 * @param array $condition Array of fields for condition
245 * @param array $params Array of several parameters
247 * @return boolean|object
250 private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
252 if (empty($selected)) {
253 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
255 if ($view == 'post-thread-user-view') {
256 $selected = array_merge($selected, ['ignored']);
260 $selected = array_unique($selected);
262 return DBA::select($view, $selected, $condition, $params);
266 * Select rows from the post table
268 * @param array $selected Array of selected fields, empty for all
269 * @param array $condition Array of fields for condition
270 * @param array $params Array of several parameters
271 * @param bool $user_mode true = post-user-view, false = post-view
273 * @return boolean|object
276 public static function select(array $selected = [], array $condition = [], $params = [], bool $user_mode = true)
278 return self::selectView($user_mode ? 'post-user-view' : 'post-view', $selected, $condition, $params);
282 * Select rows from the post table
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
288 * @return boolean|object
291 public static function selectThread(array $selected = [], array $condition = [], $params = [])
293 return self::selectView('post-thread-user-view', $selected, $condition, $params);
297 * Select rows from the given view for a given user
299 * @param string $view View (post-user-view or post-thread-user-view)
300 * @param integer $uid User ID
301 * @param array $selected Array of selected fields, empty for all
302 * @param array $condition Array of fields for condition
303 * @param array $params Array of several parameters
305 * @return boolean|object
308 private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
310 if (empty($selected)) {
311 $selected = Item::DISPLAY_FIELDLIST;
314 $condition = DBA::mergeConditions($condition,
315 ["`visible` AND NOT `deleted`
316 AND NOT `author-blocked` AND NOT `owner-blocked`
317 AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
318 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
319 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
320 AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `uri-id` = `" . $view . "`.`uri-id` AND `hidden`)
321 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
322 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
323 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
324 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
325 0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
327 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
329 $condition_string = DBA::buildCondition($condition);
330 $param_string = DBA::buildParameter($params);
332 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
333 $sql = DBA::cleanQuery($sql);
335 return DBA::p($sql, $condition);
339 * Select rows from the post view for a given user
341 * @param integer $uid User ID
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
345 * @param bool $user_mode true = post-user-view, false = post-view
347 * @return boolean|object
350 public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [], bool $user_mode = true)
352 return self::selectViewForUser($user_mode ? 'post-user-view' : 'post-view', $uid, $selected, $condition, $params);
356 * Select rows from the post view for a given user
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 public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
368 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
372 * Retrieve a single record from the post view for a given user and returns it in an associative array
374 * @param integer $uid User ID
375 * @param array $selected
376 * @param array $condition
377 * @param array $params
382 public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
384 $params['limit'] = 1;
386 $result = self::selectForUser($uid, $selected, $condition, $params);
388 if (is_bool($result)) {
391 $row = self::fetch($result);
398 * Select pinned rows from the item table for a given user
400 * @param integer $uid User ID
401 * @param array $selected Array of selected fields, empty for all
402 * @param array $condition Array of fields for condition
403 * @param array $params Array of several parameters
405 * @return boolean|object
408 public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
410 $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
411 if (!DBA::isResult($postthreaduser)) {
412 return $postthreaduser;
416 while ($useritem = DBA::fetch($postthreaduser)) {
417 $pinned[] = $useritem['uri-id'];
419 DBA::close($postthreaduser);
421 if (empty($pinned)) {
425 $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
427 return self::selectForUser($uid, $selected, $condition, $params);
431 * Update existing post entries
433 * @param array $fields The fields that are to be changed
434 * @param array $condition The condition for finding the item entries
436 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
438 * @return integer|boolean number of affected rows - or "false" if there was an error
439 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
441 public static function update(array $fields, array $condition)
445 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => local_user(),'callstack' => System::callstack(10)]);
447 // Don't allow changes to fields that are responsible for the relation between the records
448 unset($fields['id']);
449 unset($fields['parent']);
450 unset($fields['uid']);
451 unset($fields['uri']);
452 unset($fields['uri-id']);
453 unset($fields['thr-parent']);
454 unset($fields['thr-parent-id']);
455 unset($fields['parent-uri']);
456 unset($fields['parent-uri-id']);
458 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
460 // To ensure the data integrity we do it in an transaction
463 $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
464 if (!empty($update_fields)) {
466 $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
467 while ($rows = DBA::toArray($posts, false, 100)) {
468 $puids = array_column($rows, 'post-user-id');
469 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
471 Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
474 $affected_count += DBA::affectedRows();
477 $affected = $affected_count;
480 $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
481 if (!empty($update_fields)) {
483 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
484 while ($rows = DBA::toArray($posts, false, 100)) {
485 $uriids = array_column($rows, 'uri-id');
486 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
488 Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
491 $affected_count += DBA::affectedRows();
494 $affected = max($affected, $affected_count);
497 $update_fields = DBStructure::getFieldsForTable('post', $fields);
498 if (!empty($update_fields)) {
500 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
501 while ($rows = DBA::toArray($posts, false, 100)) {
502 $uriids = array_column($rows, 'uri-id');
503 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
505 Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
508 $affected_count += DBA::affectedRows();
511 $affected = max($affected, $affected_count);
514 $update_fields = Post\DeliveryData::extractFields($fields);
515 if (!empty($update_fields)) {
517 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
518 while ($rows = DBA::toArray($posts, false, 100)) {
519 $uriids = array_column($rows, 'uri-id');
520 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
522 Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
525 $affected_count += DBA::affectedRows();
528 $affected = max($affected, $affected_count);
531 $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
532 if (!empty($update_fields)) {
534 $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
535 while ($rows = DBA::toArray($posts, false, 100)) {
536 $uriids = array_column($rows, 'uri-id');
537 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
539 Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
542 $affected_count += DBA::affectedRows();
545 $affected = max($affected, $affected_count);
548 $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
549 if (!empty($update_fields)) {
551 $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
552 while ($rows = DBA::toArray($posts, false, 100)) {
553 $thread_puids = array_column($rows, 'post-user-id');
554 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
556 Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
559 $affected_count += DBA::affectedRows();
562 $affected = max($affected, $affected_count);
567 Logger::info('Updated posts', ['rows' => $affected]);
572 * Delete a row from the post table
574 * @param array $conditions Field condition(s)
575 * @param array $options
576 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
577 * relations (default: true)
579 * @return boolean was the delete successful?
582 public static function delete(array $conditions, array $options = [])
584 return DBA::delete('post', $conditions, $options);