3 * @copyright Copyright (C) 2020, Friendica
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-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-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 * Select rows from the post table and returns them as an array
187 * @param array $selected Array of selected fields, empty for all
188 * @param array $condition Array of fields for condition
189 * @param array $params Array of several parameters
194 public static function selectToArray(array $fields = [], array $condition = [], $params = [])
196 $result = self::select($fields, $condition, $params);
198 if (is_bool($result)) {
203 while ($row = self::fetch($result)) {
212 * Select rows from the given view
214 * @param string $view View (post-view or post-thread-view)
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
219 * @return boolean|object
222 private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
224 if (empty($selected)) {
225 $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
227 if ($view == 'post-thread-view') {
228 $selected = array_merge($selected, ['ignored']);
232 $selected = array_unique($selected);
234 return DBA::select($view, $selected, $condition, $params);
238 * Select rows from the post table
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 public static function select(array $selected = [], array $condition = [], $params = [])
249 return self::selectView('post-view', $selected, $condition, $params);
253 * Select rows from the post table
255 * @param array $selected Array of selected fields, empty for all
256 * @param array $condition Array of fields for condition
257 * @param array $params Array of several parameters
259 * @return boolean|object
262 public static function selectThread(array $selected = [], array $condition = [], $params = [])
264 return self::selectView('post-thread-view', $selected, $condition, $params);
268 * Select rows from the given view for a given user
270 * @param string $view View (post-view or post-thread-view)
271 * @param integer $uid User ID
272 * @param array $selected Array of selected fields, empty for all
273 * @param array $condition Array of fields for condition
274 * @param array $params Array of several parameters
276 * @return boolean|object
279 private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
281 if (empty($selected)) {
282 $selected = Item::DISPLAY_FIELDLIST;
285 $condition = DBA::mergeConditions($condition,
286 ["`visible` AND NOT `deleted`
287 AND NOT `author-blocked` AND NOT `owner-blocked`
288 AND (NOT `causer-blocked` OR `causer-id` = ?) AND NOT `contact-blocked`
289 AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
290 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
291 AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `hidden` AND `uri-id` = `" . $view . "`.`uri-id` AND `uid` = ?)
292 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
293 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
294 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
295 AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
296 0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
300 if (in_array('pinned', $selected)) {
301 $selected = array_flip($selected);
302 unset($selected['pinned']);
303 $selected = array_flip($selected);
305 $select_string = "(SELECT `pinned` FROM `post-thread-user` WHERE `uri-id` = `" . $view . "`.`uri-id` AND uid=`" . $view . "`.`uid`) AS `pinned`, ";
308 $select_string .= implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
310 $condition_string = DBA::buildCondition($condition);
311 $param_string = DBA::buildParameter($params);
313 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
314 $sql = DBA::cleanQuery($sql);
316 return DBA::p($sql, $condition);
320 * Select rows from the post view for a given user
322 * @param integer $uid User ID
323 * @param array $selected Array of selected fields, empty for all
324 * @param array $condition Array of fields for condition
325 * @param array $params Array of several parameters
327 * @return boolean|object
330 public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
332 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
336 * Select rows from the post view for a given user
338 * @param integer $uid User ID
339 * @param array $selected Array of selected fields, empty for all
340 * @param array $condition Array of fields for condition
341 * @param array $params Array of several parameters
343 * @return boolean|object
346 public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
348 return self::selectViewForUser('post-thread-view', $uid, $selected, $condition, $params);
352 * Retrieve a single record from the post view for a given user and returns it in an associative array
354 * @param integer $uid User ID
355 * @param array $selected
356 * @param array $condition
357 * @param array $params
362 public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
364 $params['limit'] = 1;
366 $result = self::selectForUser($uid, $selected, $condition, $params);
368 if (is_bool($result)) {
371 $row = self::fetch($result);
378 * Select pinned rows from the item table for a given user
380 * @param integer $uid User ID
381 * @param array $selected Array of selected fields, empty for all
382 * @param array $condition Array of fields for condition
383 * @param array $params Array of several parameters
385 * @return boolean|object
388 public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
390 $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
391 if (!DBA::isResult($postthreaduser)) {
392 return $postthreaduser;
396 while ($useritem = DBA::fetch($postthreaduser)) {
397 $pinned[] = $useritem['uri-id'];
399 DBA::close($postthreaduser);
401 if (empty($pinned)) {
405 $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
407 return self::selectForUser($uid, $selected, $condition, $params);
411 * Update existing post entries
413 * @param array $fields The fields that are to be changed
414 * @param array $condition The condition for finding the item entries
416 * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
418 * @return integer|boolean number of affected rows - or "false" if there was an error
419 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
421 public static function update(array $fields, array $condition)
425 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => local_user(),'callstack' => System::callstack(10)]);
427 // Don't allow changes to fields that are responsible for the relation between the records
428 unset($fields['id']);
429 unset($fields['parent']);
430 unset($fields['uid']);
431 unset($fields['uri']);
432 unset($fields['uri-id']);
433 unset($fields['thr-parent']);
434 unset($fields['thr-parent-id']);
435 unset($fields['parent-uri']);
436 unset($fields['parent-uri-id']);
438 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
440 // To ensure the data integrity we do it in an transaction
443 $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
444 if (!empty($update_fields)) {
446 $posts = DBA::select('post-view', ['post-user-id'], $condition);
447 while ($rows = DBA::toArray($posts, false, 100)) {
448 $puids = array_column($rows, 'post-user-id');
449 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
451 Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
454 $affected_count += DBA::affectedRows();
457 $affected = $affected_count;
460 $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
461 if (!empty($update_fields)) {
463 $rows = DBA::selectToArray('post-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
464 $uriids = array_column($rows, 'uri-id');
466 while (!empty($elements)) {
467 $segment = array_splice($elements, 0, 100);
468 if (!DBA::update('post-content', $update_fields, ['uri-id' => $segment])) {
470 Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
473 $affected_count += DBA::affectedRows();
475 $affected = max($affected, $affected_count);
478 $update_fields = DBStructure::getFieldsForTable('post', $fields);
479 if (!empty($update_fields)) {
481 if (empty($uriids)) {
482 $rows = DBA::selectToArray('post-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
483 $uriids = array_column($rows, 'uri-id');
486 while (!empty($elements)) {
487 $segment = array_splice($elements, 0, 100);
488 if (!DBA::update('post', $update_fields, ['uri-id' => $segment])) {
490 Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
493 $affected_count += DBA::affectedRows();
495 $affected = max($affected, $affected_count);
498 $update_fields = Post\DeliveryData::extractFields($fields);
499 if (!empty($update_fields)) {
501 if (empty($uriids)) {
502 $rows = DBA::selectToArray('post-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
503 $uriids = array_column($rows, 'uri-id');
506 while (!empty($elements)) {
507 $segment = array_splice($elements, 0, 100);
508 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $segment])) {
510 Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
513 $affected_count += DBA::affectedRows();
515 $affected = max($affected, $affected_count);
518 $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
519 if (!empty($update_fields)) {
521 $rows = DBA::selectToArray('post-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
522 $uriids = array_column($rows, 'uri-id');
523 while (!empty($uriids)) {
524 $segment = array_splice($uriids, 0, 100);
525 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $segment])) {
527 Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
530 $affected_count += DBA::affectedRows();
532 $affected = max($affected, $affected_count);
535 $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
536 if (!empty($update_fields)) {
538 $rows = DBA::selectToArray('post-view', ['post-user-id'], $thread_condition);
539 $thread_puids = array_column($rows, 'post-user-id');
540 while (!empty($thread_puids)) {
541 $segment = array_splice($thread_puids, 0, 100);
542 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $segment])) {
544 Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
547 $affected_count += DBA::affectedRows();
549 $affected = max($affected, $affected_count);
554 Logger::info('Updated posts', ['rows' => $affected]);
559 * Delete a row from the post table
561 * @param array $conditions Field condition(s)
562 * @param array $options
563 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
564 * relations (default: true)
566 * @return boolean was the delete successful?
569 public static function delete(array $conditions, array $options = [])
571 return DBA::delete('post', $conditions, $options);