src/Model/Post.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Model;
  23
  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;
  31
  32 class Post
  33 {
  34         /**
  35          * Insert a new post entry
  36          *
  37          * @param integer $uri_id
  38          * @param array   $fields
  39          * @return int    ID of inserted post
  40          * @throws \Exception
  41          */
  42         public static function insert(int $uri_id, array $data = [])
  43         {
  44                 if (empty($uri_id)) {
  45                         throw new BadMethodCallException('Empty URI_id');
  46                 }
  47
  48                 $fields = DBStructure::getFieldsForTable('post', $data);
  49
  50                 // Additionally assign the key fields
  51                 $fields['uri-id'] = $uri_id;
  52
  53                 if (!DBA::insert('post', $fields, Database::INSERT_IGNORE)) {
  54                         return 0;
  55                 }
  56
  57                 return DBA::lastInsertId();
  58         }
  59
  60         /**
  61          * Fetch a single post row
  62          *
  63          * @param mixed $stmt statement object
  64          * @return array|false current row or false
  65          * @throws \Exception
  66          */
  67         public static function fetch($stmt)
  68         {
  69                 $row = DBA::fetch($stmt);
  70
  71                 if (!is_array($row)) {
  72                         return $row;
  73                 }
  74
  75                 if (array_key_exists('verb', $row)) {
  76                         if (in_array($row['verb'], Item::ACTIVITIES)) {
  77                                 if (array_key_exists('title', $row)) {
  78                                         $row['title'] = '';
  79                                 }
  80                                 if (array_key_exists('body', $row)) {
  81                                         $row['body'] = $row['verb'];
  82                                 }
  83                                 if (array_key_exists('object', $row)) {
  84                                         $row['object'] = '';
  85                                 }
  86                                 if (array_key_exists('object-type', $row)) {
  87                                         $row['object-type'] = Activity\ObjectType::NOTE;
  88                                 }
  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)) {
  92                                         $row['target'] = '';
  93                                 }
  94                         }
  95                 }
  96
  97                 if (array_key_exists('extid', $row) && is_null($row['extid'])) {
  98                         $row['extid'] = '';
  99                 }
 100
 101                 return $row;
 102         }
 103
 104         /**
 105          * Fills an array with data from an post query
 106          *
 107          * @param object $stmt statement object
 108          * @param bool   $do_close
 109          * @return array Data array
 110          */
 111         public static function toArray($stmt, $do_close = true) {
 112                 if (is_bool($stmt)) {
 113                         return $stmt;
 114                 }
 115
 116                 $data = [];
 117                 while ($row = self::fetch($stmt)) {
 118                         $data[] = $row;
 119                 }
 120                 if ($do_close) {
 121                         DBA::close($stmt);
 122                 }
 123                 return $data;
 124         }
 125
 126         /**
 127          * Check if post data exists
 128          *
 129          * @param array $condition array of fields for condition
 130          *
 131          * @return boolean Are there rows for that condition?
 132          * @throws \Exception
 133          */
 134         public static function exists($condition) {
 135                 return DBA::exists('post-view', $condition);
 136         }
 137
 138         /**
 139          * Counts the posts satisfying the provided condition
 140          *
 141          * @param array        $condition array of fields for condition
 142          * @param array        $params    Array of several parameters
 143          *
 144          * @return int
 145          *
 146          * Example:
 147          * $condition = ["uid" => 1, "network" => 'dspr'];
 148          * or:
 149          * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
 150          *
 151          * $count = Post::count($condition);
 152          * @throws \Exception
 153          */
 154         public static function count(array $condition = [], array $params = [])
 155         {
 156                 return DBA::count('post-view', $condition, $params);
 157         }
 158
 159         /**
 160          * Retrieve a single record from the post table and returns it in an associative array
 161          *
 162          * @param array $fields
 163          * @param array $condition
 164          * @param array $params
 165          * @return bool|array
 166          * @throws \Exception
 167          * @see   DBA::select
 168          */
 169         public static function selectFirst(array $fields = [], array $condition = [], $params = [])
 170         {
 171                 $params['limit'] = 1;
 172
 173                 $result = self::select($fields, $condition, $params);
 174
 175                 if (is_bool($result)) {
 176                         return $result;
 177                 } else {
 178                         $row = self::fetch($result);
 179                         DBA::close($result);
 180                         return $row;
 181                 }
 182         }
 183
 184         /**
 185          * Select rows from the post table and returns them as an array
 186          *
 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
 190          *
 191          * @return array
 192          * @throws \Exception
 193          */
 194         public static function selectToArray(array $fields = [], array $condition = [], $params = [])
 195         {
 196                 $result = self::select($fields, $condition, $params);
 197
 198                 if (is_bool($result)) {
 199                         return [];
 200                 }
 201
 202                 $data = [];
 203                 while ($row = self::fetch($result)) {
 204                         $data[] = $row;
 205                 }
 206                 DBA::close($result);
 207
 208                 return $data;
 209         }
 210
 211         /**
 212          * Select rows from the given view
 213          *
 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
 218          *
 219          * @return boolean|object
 220          * @throws \Exception
 221          */
 222         private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
 223         {
 224                 if (empty($selected)) {
 225                         $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
 226
 227                         if ($view == 'post-thread-view') {
 228                                 $selected = array_merge($selected, ['ignored', 'iid']);
 229                         }
 230                 }
 231
 232                 $selected = array_unique($selected);
 233
 234                 return DBA::select($view, $selected, $condition, $params);
 235         }
 236
 237         /**
 238          * Select rows from the post table
 239          *
 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
 243          *
 244          * @return boolean|object
 245          * @throws \Exception
 246          */
 247         public static function select(array $selected = [], array $condition = [], $params = [])
 248         {
 249                 $timestamp = microtime(true);
 250                 $data = self::selectView('post-view', $selected, $condition, $params);
 251
 252                 $duration = microtime(true) - $timestamp;;
 253                 if ($duration > 0.1)
 254                         Logger::info('Blubb', ['duration' => $duration, 'selected' => $selected, 'condition' => $condition, 'params' => $params, 'callstack' => System::callstack(20)]);
 255                 return $data;
 256         }
 257
 258         /**
 259          * Select rows from the post table
 260          *
 261          * @param array $selected  Array of selected fields, empty for all
 262          * @param array $condition Array of fields for condition
 263          * @param array $params    Array of several parameters
 264          *
 265          * @return boolean|object
 266          * @throws \Exception
 267          */
 268         public static function selectThread(array $selected = [], array $condition = [], $params = [])
 269         {
 270                 return self::selectView('post-thread-view', $selected, $condition, $params);
 271         }
 272
 273         /**
 274          * Select rows from the given view for a given user
 275          *
 276          * @param string  $view      View (post-view or post-thread-view)
 277          * @param integer $uid       User ID
 278          * @param array   $selected  Array of selected fields, empty for all
 279          * @param array   $condition Array of fields for condition
 280          * @param array   $params    Array of several parameters
 281          *
 282          * @return boolean|object
 283          * @throws \Exception
 284          */
 285         private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
 286         {
 287                 if (empty($selected)) {
 288                         $selected = Item::DISPLAY_FIELDLIST;
 289                 }
 290
 291                 $condition = DBA::mergeConditions($condition,
 292                         ["`visible` AND NOT `deleted`
 293                         AND NOT `author-blocked` AND NOT `owner-blocked`
 294                         AND (NOT `causer-blocked` OR `causer-id` = ?) AND NOT `contact-blocked`
 295                         AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
 296                                 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
 297                         AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `hidden` AND `uri-id` = `" . $view . "`.`uri-id` AND `uid` = ?)
 298                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
 299                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
 300                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
 301                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
 302                         0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
 303
 304                 $select_string = '';
 305
 306                 if (in_array('pinned', $selected)) {
 307                         $selected = array_flip($selected);
 308                         unset($selected['pinned']);
 309                         $selected = array_flip($selected);
 310
 311                         $select_string = "(SELECT `pinned` FROM `post-thread-user` WHERE `uri-id` = `" . $view . "`.`uri-id` AND uid=`" . $view . "`.`uid`) AS `pinned`, ";
 312                 }
 313
 314                 $select_string .= implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
 315
 316                 $condition_string = DBA::buildCondition($condition);
 317                 $param_string = DBA::buildParameter($params);
 318
 319                 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
 320                 $sql = DBA::cleanQuery($sql);
 321
 322                 return DBA::p($sql, $condition);
 323         }
 324
 325         /**
 326          * Select rows from the post view for a given user
 327          *
 328          * @param integer $uid       User ID
 329          * @param array   $selected  Array of selected fields, empty for all
 330          * @param array   $condition Array of fields for condition
 331          * @param array   $params    Array of several parameters
 332          *
 333          * @return boolean|object
 334          * @throws \Exception
 335          */
 336         public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
 337         {
 338                 //Logger::info('Blubb', ['uid' => $uid, 'selected' => $selected, 'condition' => $condition, 'params' => $params]);
 339                 return self::selectViewForUser('post-view', $uid, $selected, $condition, $params);
 340         }
 341
 342                 /**
 343          * Select rows from the post view for a given user
 344          *
 345          * @param integer $uid       User ID
 346          * @param array   $selected  Array of selected fields, empty for all
 347          * @param array   $condition Array of fields for condition
 348          * @param array   $params    Array of several parameters
 349          *
 350          * @return boolean|object
 351          * @throws \Exception
 352          */
 353         public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
 354         {
 355                 return self::selectViewForUser('post-thread-view', $uid, $selected, $condition, $params);
 356         }
 357
 358         /**
 359          * Retrieve a single record from the post view for a given user and returns it in an associative array
 360          *
 361          * @param integer $uid User ID
 362          * @param array   $selected
 363          * @param array   $condition
 364          * @param array   $params
 365          * @return bool|array
 366          * @throws \Exception
 367          * @see   DBA::select
 368          */
 369         public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
 370         {
 371                 $params['limit'] = 1;
 372
 373                 $result = self::selectForUser($uid, $selected, $condition, $params);
 374
 375                 if (is_bool($result)) {
 376                         return $result;
 377                 } else {
 378                         $row = self::fetch($result);
 379                         DBA::close($result);
 380                         return $row;
 381                 }
 382         }
 383
 384         /**
 385          * Select pinned rows from the item table for a given user
 386          *
 387          * @param integer $uid       User ID
 388          * @param array   $selected  Array of selected fields, empty for all
 389          * @param array   $condition Array of fields for condition
 390          * @param array   $params    Array of several parameters
 391          *
 392          * @return boolean|object
 393          * @throws \Exception
 394          */
 395         public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
 396         {
 397                 $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
 398                 if (!DBA::isResult($postthreaduser)) {
 399                         return $postthreaduser;
 400                 }
 401
 402                 $pinned = [];
 403                 while ($useritem = DBA::fetch($postthreaduser)) {
 404                         $pinned[] = $useritem['uri-id'];
 405                 }
 406                 DBA::close($postthreaduser);
 407
 408                 if (empty($pinned)) {
 409                         return [];
 410                 }
 411
 412                 $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
 413
 414                 return self::selectForUser($uid, $selected, $condition, $params);
 415         }
 416
 417         /**
 418          * Update existing post entries
 419          *
 420          * @param array $fields    The fields that are to be changed
 421          * @param array $condition The condition for finding the item entries
 422          *
 423          * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
 424          *
 425          * @return integer|boolean number of affected rows - or "false" if there was an error
 426          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 427          */
 428         public static function update(array $fields, array $condition)
 429         {
 430                 $affected = 0;
 431
 432                 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition]);
 433
 434                 // Don't allow changes to fields that are responsible for the relation between the records
 435                 unset($fields['id']);
 436                 unset($fields['parent']);
 437                 unset($fields['uid']);
 438                 unset($fields['uri']);
 439                 unset($fields['uri-id']);
 440                 unset($fields['thr-parent']);
 441                 unset($fields['thr-parent-id']);
 442                 unset($fields['parent-uri']);
 443                 unset($fields['parent-uri-id']);
 444
 445                 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
 446
 447                 // To ensure the data integrity we do it in an transaction
 448                 DBA::transaction();
 449
 450                 $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
 451                 if (!empty($update_fields)) {
 452                         $rows = DBA::selectToArray('post-view', ['post-user-id'], $condition);
 453                         $puids = array_column($rows, 'post-user-id');
 454                         if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
 455                                 DBA::rollback();
 456                                 Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
 457                                 return false;
 458                         }
 459                         $affected = DBA::affectedRows();
 460                 }
 461
 462                 $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
 463                 if (!empty($update_fields)) {
 464                         $rows = DBA::selectToArray('post-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
 465                         $uriids = array_column($rows, 'uri-id');
 466                         if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
 467                                 DBA::rollback();
 468                                 Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
 469                                 return false;
 470                         }
 471                         $affected = max($affected, DBA::affectedRows());
 472                 }
 473
 474                 $update_fields = DBStructure::getFieldsForTable('post', $fields);
 475                 if (!empty($update_fields)) {
 476                         if (empty($uriids)) {
 477                                 $rows = DBA::selectToArray('post-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
 478                                 $uriids = array_column($rows, 'uri-id');
 479                         }
 480                         if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
 481                                 DBA::rollback();
 482                                 Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
 483                                 return false;
 484                         }
 485                         $affected = max($affected, DBA::affectedRows());
 486                 }
 487
 488                 $update_fields = Post\DeliveryData::extractFields($fields);
 489                 if (!empty($update_fields)) {
 490                         if (empty($uriids)) {
 491                                 $rows = DBA::selectToArray('post-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
 492                                 $uriids = array_column($rows, 'uri-id');
 493                         }
 494                         if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
 495                                 DBA::rollback();
 496                                 Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
 497                                 return false;
 498                         }
 499                         $affected = max($affected, DBA::affectedRows());
 500                 }
 501
 502                 $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
 503                 if (!empty($update_fields)) {
 504                         $rows = DBA::selectToArray('post-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
 505                         $uriids = array_column($rows, 'uri-id');
 506                         if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
 507                                 DBA::rollback();
 508                                 Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
 509                                 return false;
 510                         }
 511                         $affected = max($affected, DBA::affectedRows());
 512                 }
 513
 514                 $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
 515                 if (!empty($update_fields)) {
 516                         $rows = DBA::selectToArray('post-view', ['post-user-id'], $thread_condition);
 517                         $thread_puids = array_column($rows, 'post-user-id');
 518                         if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
 519                                 DBA::rollback();
 520                                 Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
 521                                 return false;
 522                         }
 523                         $affected = max($affected, DBA::affectedRows());
 524                 }
 525
 526                 $update_fields = [];
 527                 foreach (Item::USED_FIELDLIST as $field) {
 528                         if (array_key_exists($field, $fields)) {
 529                                 $update_fields[$field] = $fields[$field];
 530                         }
 531                 }
 532                 if (!empty($update_fields)) {
 533                         $rows = DBA::selectToArray('post-view', ['item-id'], $condition, []);
 534                         $ids = array_column($rows, 'item-id');
 535                         if (!DBA::update('item', $update_fields, ['id' => $ids])) {
 536                                 DBA::rollback();
 537                                 Logger::notice('Updating item failed', ['fields' => $update_fields, 'condition' => $condition]);
 538                                 return false;
 539                         }
 540                         $affected = max($affected, DBA::affectedRows());
 541                 }
 542
 543                 DBA::commit();
 544
 545                 Logger::info('Updated posts', ['rows' => $affected]);
 546                 return $affected;
 547         }
 548
 549         /**
 550          * Delete a row from the post table
 551          *
 552          * @param array        $conditions Field condition(s)
 553          * @param array        $options
 554          *                           - cascade: If true we delete records in other tables that depend on the one we're deleting through
 555          *                           relations (default: true)
 556          *
 557          * @return boolean was the delete successful?
 558          * @throws \Exception
 559          */
 560         public static function delete(array $conditions, array $options = [])
 561         {
 562                 return DBA::delete('post', $conditions, $options);
 563         }
 564 }