]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Conversation.php
Merge branch 'master' of gitorious.org:social/mainline
[quix0rs-gnu-social.git] / 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
38     public $uri;                             // varchar(255)  unique_key
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' => 'int', 'not null' => true, 'description' => 'should be set from root notice id (since 2014-03-01 commit)'),
47                 'uri' => array('type' => 'varchar', 'not null'=>true, 'length' => 255, '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     /**
59      * Factory method for creating a new conversation.
60      *
61      * Use this for locally initiated conversations. Remote notices should
62      * preferrably supply their own conversation URIs in the OStatus feed.
63      *
64      * @return Conversation the new conversation DO
65      */
66     static function create(Notice $notice, $uri=null)
67     {
68         if (empty($notice->id)) {
69             throw new ServerException(_('Tried to create conversation for not yet inserted notice'));
70         }
71         $conv = new Conversation();
72         $conv->created = common_sql_now();
73         $conv->id = $notice->id;
74         $conv->uri = $uri ?: sprintf('%s%s=%d:%s=%s:%s=%x',
75                              TagURI::mint(),
76                              'noticeId', $notice->id,
77                              'objectType', 'thread',
78                              'crc32', crc32($notice->content));
79         $result = $conv->insert();
80
81         if ($result === false) {
82             common_log_db_error($conv, 'INSERT', __FILE__);
83             throw new ServerException(_('Failed to create conversation for notice'));
84         }
85
86         return $conv;
87     }
88
89     static function noticeCount($id)
90     {
91         $keypart = sprintf('conversation:notice_count:%d', $id);
92
93         $cnt = self::cacheGet($keypart);
94
95         if ($cnt !== false) {
96             return $cnt;
97         }
98
99         $notice               = new Notice();
100         $notice->conversation = $id;
101         $notice->whereAddIn('verb', array(ActivityVerb::POST, ActivityUtils::resolveUri(ActivityVerb::POST, true)), $notice->columnType('verb'));
102         $cnt                  = $notice->count();
103
104         self::cacheSet($keypart, $cnt);
105
106         return $cnt;
107     }
108
109     static public function getUrlFromNotice(Notice $notice, $anchor=true)
110     {
111         $conv = self::getKV('id', $notice->conversation);
112         return $conv->getUrl($anchor ? $notice->id : null);
113     }
114
115     public function getUri()
116     {
117         return $this->uri;
118     }
119
120     public function getUrl($noticeId=null)
121     {
122         // FIXME: the URL router should take notice-id as an argument...
123         return common_local_url('conversation', array('id' => $this->id)) .
124                 ($noticeId===null ? '' : "#notice-{$noticeId}");
125     }
126
127     // FIXME: ...will 500 ever be too low? Taken from ConversationAction::MAX_NOTICES
128     public function getNotices($offset=0, $limit=500, Profile $scoped=null)
129     {
130         if ($scoped === null) {
131             $scoped = Profile::current();
132         }
133         $stream = new ConversationNoticeStream($this->id, $scoped);
134         $notices = $stream->getNotices($offset, $limit);
135         return $notices;
136     }
137 }