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
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 posts 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 * Retrieve a single record from the post table and returns it in an associative array
162 * @param array $fields
163 * @param array $condition
164 * @param array $params
169 public static function selectFirst(array $fields = [], array $condition = [], $params = [])
171 $params['limit'] = 1;
173 $result = self::select($fields, $condition, $params);
175 if (is_bool($result)) {
178 $row = self::fetch($result);
185 * Retrieve a single record from the post-thread table and returns it in an associative array
187 * @param array $fields
188 * @param array $condition
189 * @param array $params
194 public static function selectFirstThread(array $fields = [], array $condition = [], $params = [])
196 $params['limit'] = 1;
198 $result = self::selectThread($fields, $condition, $params);
200 if (is_bool($result)) {
203 $row = self::fetch($result);
210 * Select rows from the post table and returns them as an array
212 * @param array $selected Array of selected fields, empty for all
213 * @param array $condition Array of fields for condition
214 * @param array $params Array of several parameters
219 public static function selectToArray(array $fields = [], array $condition = [], $params = [])
221 $result = self::select($fields, $condition, $params);
223 if (is_bool($result)) {
228 while ($row = self::fetch($result)) {
237 * Select rows from the given view
239 * @param string $view View (post-user-view or post-thread-user-view)
240 * @param array $selected Array of selected fields, empty for all
241 * @param array $condition Array of fields for condition
242 * @param array $params Array of several parameters
244 * @return boolean|object
247 private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
249 if (empty($selected)) {
250 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
252 if ($view == 'post-thread-user-view') {
253 $selected = array_merge($selected, ['ignored']);
257 $selected = array_unique($selected);
259 return DBA::select($view, $selected, $condition, $params);
263 * Select rows from the post table
265 * @param array $selected Array of selected fields, empty for all
266 * @param array $condition Array of fields for condition
267 * @param array $params Array of several parameters
269 * @return boolean|object
272 public static function select(array $selected = [], array $condition = [], $params = [])
274 return self::selectView('post-user-view', $selected, $condition, $params);
278 * Select rows from the post table
280 * @param array $selected Array of selected fields, empty for all
281 * @param array $condition Array of fields for condition
282 * @param array $params Array of several parameters
284 * @return boolean|object
287 public static function selectThread(array $selected = [], array $condition = [], $params = [])
289 return self::selectView('post-thread-user-view', $selected, $condition, $params);
293 * Select rows from the given view for a given user
295 * @param string $view View (post-user-view or post-thread-user-view)
296 * @param integer $uid User ID
297 * @param array $selected Array of selected fields, empty for all
298 * @param array $condition Array of fields for condition
299 * @param array $params Array of several parameters
301 * @return boolean|object
304 private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
306 if (empty($selected)) {
307 $selected = Item::DISPLAY_FIELDLIST;
310 $condition = DBA::mergeConditions($condition,
311 ["`visible` AND NOT `deleted`
312 AND NOT `author-blocked` AND NOT `owner-blocked`
313 AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
314 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
315 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
316 AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `uri-id` = `" . $view . "`.`uri-id` AND `hidden`)
317 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
318 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
319 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
320 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
321 0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
323 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
325 $condition_string = DBA::buildCondition($condition);
326 $param_string = DBA::buildParameter($params);
328 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
329 $sql = DBA::cleanQuery($sql);
331 return DBA::p($sql, $condition);
335 * Select rows from the post view for a given user
337 * @param integer $uid User ID
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 selectForUser($uid, array $selected = [], array $condition = [], $params = [])
347 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
351 * Select rows from the post view for a given user
353 * @param integer $uid User ID
354 * @param array $selected Array of selected fields, empty for all
355 * @param array $condition Array of fields for condition
356 * @param array $params Array of several parameters
358 * @return boolean|object
361 public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
363 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
367 * Retrieve a single record from the post view for a given user and returns it in an associative array
369 * @param integer $uid User ID
370 * @param array $selected
371 * @param array $condition
372 * @param array $params
377 public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
379 $params['limit'] = 1;
381 $result = self::selectForUser($uid, $selected, $condition, $params);
383 if (is_bool($result)) {
386 $row = self::fetch($result);
393 * Select pinned rows from the item table for a given user
395 * @param integer $uid User ID
396 * @param array $selected Array of selected fields, empty for all
397 * @param array $condition Array of fields for condition
398 * @param array $params Array of several parameters
400 * @return boolean|object
403 public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
405 $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
406 if (!DBA::isResult($postthreaduser)) {
407 return $postthreaduser;
411 while ($useritem = DBA::fetch($postthreaduser)) {
412 $pinned[] = $useritem['uri-id'];
414 DBA::close($postthreaduser);
416 if (empty($pinned)) {
420 $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
422 return self::selectForUser($uid, $selected, $condition, $params);
426 * Update existing post entries
428 * @param array $fields The fields that are to be changed
429 * @param array $condition The condition for finding the item entries
431 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
433 * @return integer|boolean number of affected rows - or "false" if there was an error
434 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
436 public static function update(array $fields, array $condition)
440 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => local_user(),'callstack' => System::callstack(10)]);
442 // Don't allow changes to fields that are responsible for the relation between the records
443 unset($fields['id']);
444 unset($fields['parent']);
445 unset($fields['uid']);
446 unset($fields['uri']);
447 unset($fields['uri-id']);
448 unset($fields['thr-parent']);
449 unset($fields['thr-parent-id']);
450 unset($fields['parent-uri']);
451 unset($fields['parent-uri-id']);
453 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
455 // To ensure the data integrity we do it in an transaction
458 $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
459 if (!empty($update_fields)) {
461 $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
462 while ($rows = DBA::toArray($posts, false, 100)) {
463 $puids = array_column($rows, 'post-user-id');
464 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
466 Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
469 $affected_count += DBA::affectedRows();
472 $affected = $affected_count;
475 $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
476 if (!empty($update_fields)) {
478 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
479 while ($rows = DBA::toArray($posts, false, 100)) {
480 $uriids = array_column($rows, 'uri-id');
481 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
483 Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
486 $affected_count += DBA::affectedRows();
489 $affected = max($affected, $affected_count);
492 $update_fields = DBStructure::getFieldsForTable('post', $fields);
493 if (!empty($update_fields)) {
495 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
496 while ($rows = DBA::toArray($posts, false, 100)) {
497 $uriids = array_column($rows, 'uri-id');
498 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
500 Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
503 $affected_count += DBA::affectedRows();
506 $affected = max($affected, $affected_count);
509 $update_fields = Post\DeliveryData::extractFields($fields);
510 if (!empty($update_fields)) {
512 $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
513 while ($rows = DBA::toArray($posts, false, 100)) {
514 $uriids = array_column($rows, 'uri-id');
515 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
517 Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
520 $affected_count += DBA::affectedRows();
523 $affected = max($affected, $affected_count);
526 $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
527 if (!empty($update_fields)) {
529 $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
530 while ($rows = DBA::toArray($posts, false, 100)) {
531 $uriids = array_column($rows, 'uri-id');
532 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
534 Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
537 $affected_count += DBA::affectedRows();
540 $affected = max($affected, $affected_count);
543 $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
544 if (!empty($update_fields)) {
546 $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
547 while ($rows = DBA::toArray($posts, false, 100)) {
548 $thread_puids = array_column($rows, 'post-user-id');
549 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
551 Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
554 $affected_count += DBA::affectedRows();
557 $affected = max($affected, $affected_count);
562 Logger::info('Updated posts', ['rows' => $affected]);
567 * Delete a row from the post table
569 * @param array $conditions Field condition(s)
570 * @param array $options
571 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
572 * relations (default: true)
574 * @return boolean was the delete successful?
577 public static function delete(array $conditions, array $options = [])
579 return DBA::delete('post', $conditions, $options);