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/
48 class Group_privacy_settings extends Memcached_DataObject
50 public $__table = 'group_privacy_settings';
51 /** ID of the group. */
53 /** When to allow privacy: always, sometimes, or never. */
54 public $allow_privacy;
55 /** Who can send private messages: everyone, member, admin */
57 /** row creation timestamp */
59 /** Last-modified timestamp */
68 /** These are bit-mappy, as a hedge against the future. */
75 * Get an instance by key
77 * This is a utility method to get a single instance with a given key value.
79 * @param string $k Key to use to lookup (usually 'user_id' for this class)
80 * @param mixed $v Value to lookup
82 * @return User_greeting_count object found, or null for no hits
85 function staticGet($k, $v=null)
87 return Memcached_DataObject::staticGet('Group_privacy_settings', $k, $v);
91 * return table definition for DB_DataObject
93 * DB_DataObject needs to know something about the table to manipulate
94 * instances. This method provides all the DB_DataObject needs to know.
96 * @return array array of column definitions
101 return array('group_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
102 'allow_privacy' => DB_DATAOBJECT_INT,
103 'allow_sender' => DB_DATAOBJECT_INT,
104 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
105 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
110 * return key definitions for DB_DataObject
112 * DB_DataObject needs to know about keys that the table has, since it
113 * won't appear in StatusNet's own keys list. In most cases, this will
114 * simply reference your keyTypes() function.
116 * @return array list of key field names
121 return array_keys($this->keyTypes());
125 * return key definitions for Memcached_DataObject
127 * @return array associative array of key definitions, field name to type:
128 * 'K' for primary key: for compound keys, add an entry for each component;
129 * 'U' for unique keys: compound keys are not well supported here.
134 return array('group_id' => 'K');
138 * Magic formula for non-autoincrementing integer primary keys
140 * @return array magic three-false array that stops auto-incrementing.
143 function sequenceKey()
145 return array(false, false, false);
148 function forGroup($group)
150 $gps = Group_privacy_settings::staticGet('group_id', $group->id);
153 // make a fake one with defaults
154 $gps = new Group_privacy_settings();
155 $gps->allow_privacy = Group_privacy_settings::SOMETIMES;
156 $gps->allow_sender = Group_privacy_settings::MEMBER;
162 function ensurePost($user, $group)
164 $gps = self::forGroup($group);
166 if ($gps->allow_privacy == Group_privacy_settings::NEVER) {
167 throw new Exception(sprintf(_('Group %s does not allow private messages.'),
171 switch ($gps->allow_sender) {
172 case Group_privacy_settings::EVERYONE:
173 $profile = $user->getProfile();
174 if (Group_block::isBlocked($group, $profile)) {
175 throw new Exception(sprintf(_('User %s is blocked from group %s.'),
180 case Group_privacy_settings::MEMBER:
181 if (!$user->isMember($group)) {
182 throw new Exception(sprintf(_('User %s is not a member of group %s.'),
187 case Group_privacy_settings::ADMIN:
188 if (!$user->isAdmin($group)) {
189 throw new Exception(sprintf(_('User %s is not an administrator of group %s.'),
195 throw new Exception(sprintf(_('Unknown privacy settings for group %s.'),