3 * Data class for group privacy settings
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) 2011, 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')) {
35 * Data class for group privacy
37 * Stores admin preferences about the group.
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_privacy_settings extends Memcached_DataObject
49 public $__table = 'group_privacy_settings';
50 /** ID of the group. */
52 /** When to allow privacy: always, sometimes, or never. */
53 public $allow_privacy;
54 /** Who can send private messages: everyone, member, admin */
56 /** row creation timestamp */
58 /** Last-modified timestamp */
67 /** These are bit-mappy, as a hedge against the future. */
74 * Get an instance by key
76 * This is a utility method to get a single instance with a given key value.
78 * @param string $k Key to use to lookup (usually 'user_id' for this class)
79 * @param mixed $v Value to lookup
81 * @return User_greeting_count object found, or null for no hits
83 function staticGet($k, $v=null)
85 return Memcached_DataObject::staticGet('Group_privacy_settings', $k, $v);
89 * return table definition for DB_DataObject
91 * DB_DataObject needs to know something about the table to manipulate
92 * instances. This method provides all the DB_DataObject needs to know.
94 * @return array array of column definitions
98 return array('group_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
99 'allow_privacy' => DB_DATAOBJECT_INT,
100 'allow_sender' => DB_DATAOBJECT_INT,
101 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
102 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
107 * return key definitions for DB_DataObject
109 * DB_DataObject needs to know about keys that the table has, since it
110 * won't appear in StatusNet's own keys list. In most cases, this will
111 * simply reference your keyTypes() function.
113 * @return array list of key field names
117 return array_keys($this->keyTypes());
121 * return key definitions for Memcached_DataObject
123 * @return array associative array of key definitions, field name to type:
124 * 'K' for primary key: for compound keys, add an entry for each component;
125 * 'U' for unique keys: compound keys are not well supported here.
129 return array('group_id' => 'K');
133 * Magic formula for non-autoincrementing integer primary keys
135 * @return array magic three-false array that stops auto-incrementing.
137 function sequenceKey()
139 return array(false, false, false);
142 function forGroup($group)
144 $gps = Group_privacy_settings::staticGet('group_id', $group->id);
147 // make a fake one with defaults
148 $gps = new Group_privacy_settings();
149 $gps->allow_privacy = Group_privacy_settings::SOMETIMES;
150 $gps->allow_sender = Group_privacy_settings::MEMBER;
156 function ensurePost($user, $group)
158 $gps = self::forGroup($group);
160 if ($gps->allow_privacy == Group_privacy_settings::NEVER) {
161 // TRANS: Exception thrown when trying to set group privacy setting if group %s does not allow private messages.
162 throw new Exception(sprintf(_m('Group %s does not allow private messages.'),
166 switch ($gps->allow_sender) {
167 case Group_privacy_settings::EVERYONE:
168 $profile = $user->getProfile();
169 if (Group_block::isBlocked($group, $profile)) {
170 // TRANS: Exception thrown when trying to send group private message while blocked from that group.
171 // TRANS: %1$s is a user nickname, %2$s is a group nickname.
172 throw new Exception(sprintf(_m('User %1$s is blocked from group %2$s.'),
177 case Group_privacy_settings::MEMBER:
178 if (!$user->isMember($group)) {
179 // TRANS: Exception thrown when trying to send group private message while not a member.
180 // TRANS: %1$s is a user nickname, %2$s is a group nickname.
181 throw new Exception(sprintf(_m('User %1$s is not a member of group %2$s.'),
186 case Group_privacy_settings::ADMIN:
187 if (!$user->isAdmin($group)) {
188 // TRANS: Exception thrown when trying to send group private message while not a group administrator.
189 // TRANS: %1$s is a user nickname, %2$s is a group nickname.
190 throw new Exception(sprintf(_m('User %1$s is not an administrator of group %2$s.'),
196 // TRANS: Exception thrown when encountering undefined group privacy settings.
197 // TRANS: %s is a group nickname.
198 throw new Exception(sprintf(_m('Unknown privacy settings for group %s.'),