src/Model/Post.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   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          * @param bool  $user_mode true = post-user-view, false = post-view
 131          *
 132          * @return boolean Are there rows for that condition?
 133          * @throws \Exception
 134          */
 135         public static function exists($condition, bool $user_mode = true) {
 136                 return DBA::exists($user_mode ? 'post-user-view' : 'post-view', $condition);
 137         }
 138
 139         /**
 140          * Counts the posts satisfying the provided condition
 141          *
 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
 145          *
 146          * @return int
 147          *
 148          * Example:
 149          * $condition = ["uid" => 1, "network" => 'dspr'];
 150          * or:
 151          * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
 152          *
 153          * $count = Post::count($condition);
 154          * @throws \Exception
 155          */
 156         public static function count(array $condition = [], array $params = [], bool $user_mode = true)
 157         {
 158                 return DBA::count($user_mode ? 'post-user-view' : 'post-view', $condition, $params);
 159         }
 160
 161         /**
 162          * Retrieve a single record from the post table and returns it in an associative array
 163          *
 164          * @param array $fields
 165          * @param array $condition
 166          * @param array $params
 167          * @return bool|array
 168          * @throws \Exception
 169          * @see   DBA::select
 170          */
 171         public static function selectFirst(array $fields = [], array $condition = [], $params = [])
 172         {
 173                 $params['limit'] = 1;
 174
 175                 $result = self::select($fields, $condition, $params);
 176
 177                 if (is_bool($result)) {
 178                         return $result;
 179                 } else {
 180                         $row = self::fetch($result);
 181                         DBA::close($result);
 182                         return $row;
 183                 }
 184         }
 185
 186         /**
 187          * Retrieve a single record from the post-thread table and returns it in an associative array
 188          *
 189          * @param array $fields
 190          * @param array $condition
 191          * @param array $params
 192          * @return bool|array
 193          * @throws \Exception
 194          * @see   DBA::select
 195          */
 196         public static function selectFirstThread(array $fields = [], array $condition = [], $params = [])
 197         {
 198                 $params['limit'] = 1;
 199
 200                 $result = self::selectThread($fields, $condition, $params);
 201
 202                 if (is_bool($result)) {
 203                         return $result;
 204                 } else {
 205                         $row = self::fetch($result);
 206                         DBA::close($result);
 207                         return $row;
 208                 }
 209         }
 210
 211         /**
 212          * Select rows from the post table and returns them as an array
 213          *
 214          * @param array $selected  Array of selected fields, empty for all
 215          * @param array $condition Array of fields for condition
 216          * @param array $params    Array of several parameters
 217          *
 218          * @return array
 219          * @throws \Exception
 220          */
 221         public static function selectToArray(array $fields = [], array $condition = [], $params = [])
 222         {
 223                 $result = self::select($fields, $condition, $params);
 224
 225                 if (is_bool($result)) {
 226                         return [];
 227                 }
 228
 229                 $data = [];
 230                 while ($row = self::fetch($result)) {
 231                         $data[] = $row;
 232                 }
 233                 DBA::close($result);
 234
 235                 return $data;
 236         }
 237
 238         /**
 239          * Select rows from the given view
 240          *
 241          * @param string $view      View (post-user-view or post-thread-user-view)
 242          * @param array  $selected  Array of selected fields, empty for all
 243          * @param array  $condition Array of fields for condition
 244          * @param array  $params    Array of several parameters
 245          *
 246          * @return boolean|object
 247          * @throws \Exception
 248          */
 249         private static function selectView(string $view, array $selected = [], array $condition = [], $params = [])
 250         {
 251                 if (empty($selected)) {
 252                         $selected = array_merge(Item::DISPLAY_FIELDLIST, Item::ITEM_FIELDLIST);
 253
 254                         if ($view == 'post-thread-user-view') {
 255                                 $selected = array_merge($selected, ['ignored']);
 256                         }
 257                 }
 258
 259                 $selected = array_unique($selected);
 260
 261                 return DBA::select($view, $selected, $condition, $params);
 262         }
 263
 264         /**
 265          * Select rows from the post table
 266          *
 267          * @param array $selected  Array of selected fields, empty for all
 268          * @param array $condition Array of fields for condition
 269          * @param array $params    Array of several parameters
 270          *
 271          * @return boolean|object
 272          * @throws \Exception
 273          */
 274         public static function select(array $selected = [], array $condition = [], $params = [])
 275         {
 276                 return self::selectView('post-user-view', $selected, $condition, $params);
 277         }
 278
 279         /**
 280          * Select rows from the post table
 281          *
 282          * @param array $selected  Array of selected fields, empty for all
 283          * @param array $condition Array of fields for condition
 284          * @param array $params    Array of several parameters
 285          *
 286          * @return boolean|object
 287          * @throws \Exception
 288          */
 289         public static function selectThread(array $selected = [], array $condition = [], $params = [])
 290         {
 291                 return self::selectView('post-thread-user-view', $selected, $condition, $params);
 292         }
 293
 294         /**
 295          * Select rows from the given view for a given user
 296          *
 297          * @param string  $view      View (post-user-view or post-thread-user-view)
 298          * @param integer $uid       User ID
 299          * @param array   $selected  Array of selected fields, empty for all
 300          * @param array   $condition Array of fields for condition
 301          * @param array   $params    Array of several parameters
 302          *
 303          * @return boolean|object
 304          * @throws \Exception
 305          */
 306         private static function selectViewForUser(string $view, $uid, array $selected = [], array $condition = [], $params = [])
 307         {
 308                 if (empty($selected)) {
 309                         $selected = Item::DISPLAY_FIELDLIST;
 310                 }
 311
 312                 $condition = DBA::mergeConditions($condition,
 313                         ["`visible` AND NOT `deleted`
 314                         AND NOT `author-blocked` AND NOT `owner-blocked`
 315                         AND (NOT `causer-blocked` OR `causer-id` = ? OR `causer-id` IS NULL) AND NOT `contact-blocked`
 316                         AND ((NOT `contact-readonly` AND NOT `contact-pending` AND (`contact-rel` IN (?, ?)))
 317                                 OR `self` OR `gravity` != ? OR `contact-uid` = ?)
 318                         AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `uid` = ? AND `uri-id` = `" . $view . "`.`uri-id` AND `hidden`)
 319                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `blocked`)
 320                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `blocked`)
 321                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `author-id` AND `ignored` AND `gravity` = ?)
 322                         AND NOT EXISTS (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `owner-id` AND `ignored` AND `gravity` = ?)",
 323                         0, Contact::SHARING, Contact::FRIEND, GRAVITY_PARENT, 0, $uid, $uid, $uid, $uid, GRAVITY_PARENT, $uid, GRAVITY_PARENT]);
 324
 325                 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $selected));
 326
 327                 $condition_string = DBA::buildCondition($condition);
 328                 $param_string = DBA::buildParameter($params);
 329
 330                 $sql = "SELECT " . $select_string . " FROM `" . $view . "` " . $condition_string . $param_string;
 331                 $sql = DBA::cleanQuery($sql);
 332
 333                 return DBA::p($sql, $condition);
 334         }
 335
 336         /**
 337          * Select rows from the post view for a given user
 338          *
 339          * @param integer $uid       User ID
 340          * @param array   $selected  Array of selected fields, empty for all
 341          * @param array   $condition Array of fields for condition
 342          * @param array   $params    Array of several parameters
 343          *
 344          * @return boolean|object
 345          * @throws \Exception
 346          */
 347         public static function selectForUser($uid, array $selected = [], array $condition = [], $params = [])
 348         {
 349                 return self::selectViewForUser('post-user-view', $uid, $selected, $condition, $params);
 350         }
 351
 352                 /**
 353          * Select rows from the post view for a given user
 354          *
 355          * @param integer $uid       User ID
 356          * @param array   $selected  Array of selected fields, empty for all
 357          * @param array   $condition Array of fields for condition
 358          * @param array   $params    Array of several parameters
 359          *
 360          * @return boolean|object
 361          * @throws \Exception
 362          */
 363         public static function selectThreadForUser($uid, array $selected = [], array $condition = [], $params = [])
 364         {
 365                 return self::selectViewForUser('post-thread-user-view', $uid, $selected, $condition, $params);
 366         }
 367
 368         /**
 369          * Retrieve a single record from the post view for a given user and returns it in an associative array
 370          *
 371          * @param integer $uid User ID
 372          * @param array   $selected
 373          * @param array   $condition
 374          * @param array   $params
 375          * @return bool|array
 376          * @throws \Exception
 377          * @see   DBA::select
 378          */
 379         public static function selectFirstForUser($uid, array $selected = [], array $condition = [], $params = [])
 380         {
 381                 $params['limit'] = 1;
 382
 383                 $result = self::selectForUser($uid, $selected, $condition, $params);
 384
 385                 if (is_bool($result)) {
 386                         return $result;
 387                 } else {
 388                         $row = self::fetch($result);
 389                         DBA::close($result);
 390                         return $row;
 391                 }
 392         }
 393
 394         /**
 395          * Select pinned rows from the item table for a given user
 396          *
 397          * @param integer $uid       User ID
 398          * @param array   $selected  Array of selected fields, empty for all
 399          * @param array   $condition Array of fields for condition
 400          * @param array   $params    Array of several parameters
 401          *
 402          * @return boolean|object
 403          * @throws \Exception
 404          */
 405         public static function selectPinned(int $uid, array $selected = [], array $condition = [], $params = [])
 406         {
 407                 $postthreaduser = DBA::select('post-thread-user', ['uri-id'], ['uid' => $uid, 'pinned' => true]);
 408                 if (!DBA::isResult($postthreaduser)) {
 409                         return $postthreaduser;
 410                 }
 411
 412                 $pinned = [];
 413                 while ($useritem = DBA::fetch($postthreaduser)) {
 414                         $pinned[] = $useritem['uri-id'];
 415                 }
 416                 DBA::close($postthreaduser);
 417
 418                 if (empty($pinned)) {
 419                         return [];
 420                 }
 421
 422                 $condition = DBA::mergeConditions(['uri-id' => $pinned, 'uid' => $uid, 'gravity' => GRAVITY_PARENT], $condition);
 423
 424                 return self::selectForUser($uid, $selected, $condition, $params);
 425         }
 426
 427         /**
 428          * Update existing post entries
 429          *
 430          * @param array $fields    The fields that are to be changed
 431          * @param array $condition The condition for finding the item entries
 432          *
 433          * A return value of "0" doesn't mean an error - but that 0 rows had been changed.
 434          *
 435          * @return integer|boolean number of affected rows - or "false" if there was an error
 436          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 437          */
 438         public static function update(array $fields, array $condition)
 439         {
 440                 $affected = 0;
 441
 442                 Logger::info('Start Update', ['fields' => $fields, 'condition' => $condition, 'uid' => local_user(),'callstack' => System::callstack(10)]);
 443
 444                 // Don't allow changes to fields that are responsible for the relation between the records
 445                 unset($fields['id']);
 446                 unset($fields['parent']);
 447                 unset($fields['uid']);
 448                 unset($fields['uri']);
 449                 unset($fields['uri-id']);
 450                 unset($fields['thr-parent']);
 451                 unset($fields['thr-parent-id']);
 452                 unset($fields['parent-uri']);
 453                 unset($fields['parent-uri-id']);
 454
 455                 $thread_condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
 456
 457                 // To ensure the data integrity we do it in an transaction
 458                 DBA::transaction();
 459
 460                 $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
 461                 if (!empty($update_fields)) {
 462                         $affected_count = 0;
 463                         $posts = DBA::select('post-user-view', ['post-user-id'], $condition);
 464                         while ($rows = DBA::toArray($posts, false, 100)) {
 465                                 $puids = array_column($rows, 'post-user-id');
 466                                 if (!DBA::update('post-user', $update_fields, ['id' => $puids])) {
 467                                         DBA::rollback();
 468                                         Logger::notice('Updating post-user failed', ['fields' => $update_fields, 'condition' => $condition]);
 469                                         return false;
 470                                 }
 471                                 $affected_count += DBA::affectedRows();
 472                         }
 473                         DBA::close($posts);
 474                         $affected = $affected_count;
 475                 }
 476
 477                 $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
 478                 if (!empty($update_fields)) {
 479                         $affected_count = 0;
 480                         $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
 481                         while ($rows = DBA::toArray($posts, false, 100)) {
 482                                 $uriids = array_column($rows, 'uri-id');
 483                                 if (!DBA::update('post-content', $update_fields, ['uri-id' => $uriids])) {
 484                                         DBA::rollback();
 485                                         Logger::notice('Updating post-content failed', ['fields' => $update_fields, 'condition' => $condition]);
 486                                         return false;
 487                                 }
 488                                 $affected_count += DBA::affectedRows();
 489                         }
 490                         DBA::close($posts);
 491                         $affected = max($affected, $affected_count);
 492                 }
 493
 494                 $update_fields = DBStructure::getFieldsForTable('post', $fields);
 495                 if (!empty($update_fields)) {
 496                         $affected_count = 0;
 497                         $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
 498                         while ($rows = DBA::toArray($posts, false, 100)) {
 499                                 $uriids = array_column($rows, 'uri-id');
 500                                 if (!DBA::update('post', $update_fields, ['uri-id' => $uriids])) {
 501                                         DBA::rollback();
 502                                         Logger::notice('Updating post failed', ['fields' => $update_fields, 'condition' => $condition]);
 503                                         return false;
 504                                 }
 505                                 $affected_count += DBA::affectedRows();
 506                         }
 507                         DBA::close($posts);
 508                         $affected = max($affected, $affected_count);
 509                 }
 510
 511                 $update_fields = Post\DeliveryData::extractFields($fields);
 512                 if (!empty($update_fields)) {
 513                         $affected_count = 0;
 514                         $posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
 515                         while ($rows = DBA::toArray($posts, false, 100)) {
 516                                 $uriids = array_column($rows, 'uri-id');
 517                                 if (!DBA::update('post-delivery-data', $update_fields, ['uri-id' => $uriids])) {
 518                                         DBA::rollback();
 519                                         Logger::notice('Updating post-delivery-data failed', ['fields' => $update_fields, 'condition' => $condition]);
 520                                         return false;
 521                                 }
 522                                 $affected_count += DBA::affectedRows();
 523                         }
 524                         DBA::close($posts);
 525                         $affected = max($affected, $affected_count);
 526                 }
 527
 528                 $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
 529                 if (!empty($update_fields)) {
 530                         $affected_count = 0;
 531                         $posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
 532                         while ($rows = DBA::toArray($posts, false, 100)) {
 533                                 $uriids = array_column($rows, 'uri-id');
 534                                 if (!DBA::update('post-thread', $update_fields, ['uri-id' => $uriids])) {
 535                                         DBA::rollback();
 536                                         Logger::notice('Updating post-thread failed', ['fields' => $update_fields, 'condition' => $condition]);
 537                                         return false;
 538                                 }
 539                                 $affected_count += DBA::affectedRows();
 540                         }
 541                         DBA::close($posts);
 542                         $affected = max($affected, $affected_count);
 543                 }
 544
 545                 $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
 546                 if (!empty($update_fields)) {
 547                         $affected_count = 0;
 548                         $posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
 549                         while ($rows = DBA::toArray($posts, false, 100)) {
 550                                 $thread_puids = array_column($rows, 'post-user-id');
 551                                 if (!DBA::update('post-thread-user', $update_fields, ['post-user-id' => $thread_puids])) {
 552                                         DBA::rollback();
 553                                         Logger::notice('Updating post-thread-user failed', ['fields' => $update_fields, 'condition' => $condition]);
 554                                         return false;
 555                                 }
 556                                 $affected_count += DBA::affectedRows();
 557                         }
 558                         DBA::close($posts);
 559                         $affected = max($affected, $affected_count);
 560                 }
 561
 562                 DBA::commit();
 563
 564                 Logger::info('Updated posts', ['rows' => $affected]);
 565                 return $affected;
 566         }
 567
 568         /**
 569          * Delete a row from the post table
 570          *
 571          * @param array        $conditions Field condition(s)
 572          * @param array        $options
 573          *                           - cascade: If true we delete records in other tables that depend on the one we're deleting through
 574          *                           relations (default: true)
 575          *
 576          * @return boolean was the delete successful?
 577          * @throws \Exception
 578          */
 579         public static function delete(array $conditions, array $options = [])
 580         {
 581                 return DBA::delete('post', $conditions, $options);
 582         }
 583 }