3 * Data class for group direct messages
9 * @author Evan Prodromou <evan@status.net>
10 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11 * @link http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2009, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
37 * Data class for group direct messages
39 * @category GroupPrivateMessage
41 * @author Evan Prodromou <evan@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
43 * @link http://status.net/
47 class Group_message extends Memcached_DataObject
49 public $__table = 'group_message'; // table name
50 public $id; // char(36) primary_key not_null
51 public $uri; // varchar(255)
52 public $from_profile; // int
53 public $to_group; // int
60 * Get an instance by key
62 * This is a utility method to get a single instance with a given key value.
64 * @param string $k Key to use to lookup (usually 'user_id' for this class)
65 * @param mixed $v Value to lookup
67 * @return Group_message object found, or null for no hits
69 function staticGet($k, $v=null)
71 return Memcached_DataObject::staticGet('Group_message', $k, $v);
75 * return table definition for DB_DataObject
77 * DB_DataObject needs to know something about the table to manipulate
78 * instances. This method provides all the DB_DataObject needs to know.
80 * @return array array of column definitions
84 return array('id' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
85 'uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
86 'from_profile' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
87 'to_group' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
88 'content' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
89 'rendered' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
90 'url' => DB_DATAOBJECT_STR,
91 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
95 * return key definitions for DB_DataObject
97 * DB_DataObject needs to know about keys that the table has, since it
98 * won't appear in StatusNet's own keys list. In most cases, this will
99 * simply reference your keyTypes() function.
101 * @return array list of key field names
105 return array_keys($this->keyTypes());
109 * return key definitions for Memcached_DataObject
111 * @return array associative array of key definitions, field name to type:
112 * 'K' for primary key: for compound keys, add an entry for each component;
113 * 'U' for unique keys: compound keys are not well supported here.
117 return array('id' => 'K', 'uri' => 'U');
120 static function send($user, $group, $text)
122 if (!$user->hasRight(Right::NEWMESSAGE)) {
123 // XXX: maybe break this out into a separate right
124 // TRANS: Exception thrown when trying to send group private message without having the right to do that.
125 // TRANS: %s is a user nickname.
126 throw new Exception(sprintf(_m('User %s is not allowed to send private messages.'),
130 Group_privacy_settings::ensurePost($user, $group);
132 $text = $user->shortenLinks($text);
134 // We use the same limits as for 'regular' private messages.
136 if (Message::contentTooLong($text)) {
137 // TRANS: Exception thrown when trying to send group private message that is too long.
138 // TRANS: %d is the maximum meggage length.
139 throw new Exception(sprintf(_m('That\'s too long. Maximum message size is %d character.',
140 'That\'s too long. Maximum message size is %d characters.',
141 Message::maxContent()),
142 Message::maxContent()));
145 // Valid! Let's do this thing!
147 $gm = new Group_message();
149 $gm->id = UUID::gen();
150 $gm->uri = common_local_url('showgroupmessage', array('id' => $gm->id));
151 $gm->from_profile = $user->id;
152 $gm->to_group = $group->id;
153 $gm->content = $text; // XXX: is this cool?!
154 $gm->rendered = common_render_text($text);
156 $gm->created = common_sql_now();
158 // This throws a conniption if there's a problem
167 function distribute()
169 $group = User_group::staticGet('id', $this->to_group);
171 $member = $group->getMembers();
173 while ($member->fetch()) {
174 Group_message_profile::send($this, $member);
180 $group = User_group::staticGet('id', $this->to_group);
182 // TRANS: Exception thrown when trying to send group private message to a non-existing group.
183 throw new ServerException(_m('No group for group message.'));
190 $sender = Profile::staticGet('id', $this->from_profile);
191 if (empty($sender)) {
192 // TRANS: Exception thrown when trying to send group private message without having a sender.
193 throw new ServerException(_m('No sender for group message.'));
198 static function forGroup($group, $offset, $limit)
201 $gm = new Group_message();
203 $gm->to_group = $group->id;
204 $gm->orderBy('created DESC');
205 $gm->limit($offset, $limit);