classes/Conversation.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Data class for Conversations
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Data
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @author    Mikael Nordfeldth <mmn@hethane.se>
  26  * @copyright 2010 StatusNet Inc.
  27  * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('GNUSOCIAL')) { exit(1); }
  33
  34 class Conversation extends Managed_DataObject
  35 {
  36     public $__table = 'conversation';        // table name
  37     public $id;                              // int(4)  primary_key not_null auto_increment
  38     public $uri;                             // varchar(191)  unique_key   not 255 because utf8mb4 takes more space
  39     public $created;                         // datetime   not_null
  40     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  41
  42     public static function schemaDef()
  43     {
  44         return array(
  45             'fields' => array(
  46                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'Unique identifier, (again) unrelated to notice id since 2016-01-06'),
  47                 'uri' => array('type' => 'varchar', 'not null'=>true, 'length' => 191, 'description' => 'URI of the conversation'),
  48                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  49                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  50             ),
  51             'primary key' => array('id'),
  52             'unique keys' => array(
  53                 'conversation_uri_key' => array('uri'),
  54             ),
  55         );
  56     }
  57
  58     static public function beforeSchemaUpdate()
  59     {
  60         $table = strtolower(get_called_class());
  61         $schema = Schema::get();
  62         $schemadef = $schema->getTableDef($table);
  63
  64         // 2016-01-06 We have to make sure there is no conversation with id==0 since it will screw up auto increment resequencing
  65         if ($schemadef['fields']['id']['auto_increment']) {
  66             // since we already have auto incrementing ('serial') we can continue
  67             return;
  68         }
  69
  70         // The conversation will be recreated in upgrade.php, which will
  71         // generate a new URI, but that's collateral damage for you.
  72         $conv = new Conversation();
  73         $conv->id = 0;
  74         if ($conv->find()) {
  75             while ($conv->fetch()) {
  76                 // Since we have filtered on 0 this only deletes such entries
  77                 // which I have been afraid wouldn't work, but apparently does!
  78                 // (I thought it would act as null or something and find _all_ conversation entries)
  79                 $conv->delete();
  80             }
  81         }
  82     }
  83
  84     /**
  85      * Factory method for creating a new conversation.
  86      *
  87      * Use this for locally initiated conversations. Remote notices should
  88      * preferrably supply their own conversation URIs in the OStatus feed.
  89      *
  90      * @return Conversation the new conversation DO
  91      */
  92     static function create($uri=null, $created=null)
  93     {
  94         // Be aware that the Notice does not have an id yet since it's not inserted!
  95         $conv = new Conversation();
  96         $conv->created = $created ?: common_sql_now();
  97         $conv->uri = $uri ?: sprintf('%s%s=%s:%s=%s',
  98                              TagURI::mint(),
  99                              'objectType', 'thread',
 100                              'nonce', common_random_hexstr(8));
 101         // This insert throws exceptions on failure
 102         $conv->insert();
 103
 104         return $conv;
 105     }
 106
 107     static function noticeCount($id)
 108     {
 109         $keypart = sprintf('conversation:notice_count:%d', $id);
 110
 111         $cnt = self::cacheGet($keypart);
 112
 113         if ($cnt !== false) {
 114             return $cnt;
 115         }
 116
 117         $notice               = new Notice();
 118         $notice->conversation = $id;
 119         $notice->whereAddIn('verb', array(ActivityVerb::POST, ActivityUtils::resolveUri(ActivityVerb::POST, true)), $notice->columnType('verb'));
 120         $cnt                  = $notice->count();
 121
 122         self::cacheSet($keypart, $cnt);
 123
 124         return $cnt;
 125     }
 126
 127     static public function getUrlFromNotice(Notice $notice, $anchor=true)
 128     {
 129         $conv = Conversation::getByID($notice->conversation);
 130         return $conv->getUrl($anchor ? $notice->getID() : null);
 131     }
 132
 133     public function getUri()
 134     {
 135         return $this->uri;
 136     }
 137
 138     public function getUrl($noticeId=null)
 139     {
 140         // FIXME: the URL router should take notice-id as an argument...
 141         return common_local_url('conversation', array('id' => $this->getID())) .
 142                 ($noticeId===null ? '' : "#notice-{$noticeId}");
 143     }
 144
 145     // FIXME: ...will 500 ever be too low? Taken from ConversationAction::MAX_NOTICES
 146     public function getNotices(Profile $scoped=null, $offset=0, $limit=500)
 147     {
 148         $stream = new ConversationNoticeStream($this->getID(), $scoped);
 149         $notices = $stream->getNotices($offset, $limit);
 150         return $notices;
 151     }
 152
 153     public function insert()
 154     {
 155         $result = parent::insert();
 156         if ($result === false) {
 157             common_log_db_error($this, 'INSERT', __FILE__);
 158             throw new ServerException(_('Failed to insert Conversation into database'));
 159         }
 160         return $result;
 161     }
 162 }