plugins/GroupPrivateMessage/Group_privacy_settings.php

   1 <?php
   2 /**
   3  * Data class for group privacy settings
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2011, StatusNet, Inc.
  15  *
  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.
  20  *
  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.
  25  *
  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/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Data class for group privacy
  36  *
  37  * Stores admin preferences about the group.
  38  *
  39  * @category Action
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  43  * @link     http://status.net/
  44  *
  45  * @see      DB_DataObject
  46  */
  47 class Group_privacy_settings extends Managed_DataObject
  48 {
  49     public $__table = 'group_privacy_settings';
  50     /** ID of the group. */
  51     public $group_id;
  52     /** When to allow privacy: always, sometimes, or never. */
  53     public $allow_privacy;
  54     /** Who can send private messages: everyone, member, admin */
  55     public $allow_sender;
  56     /** row creation timestamp */
  57     public $created;
  58     /** Last-modified timestamp */
  59     public $modified;
  60
  61     /** NEVER is */
  62
  63     const SOMETIMES = -1;
  64     const NEVER  = 0;
  65     const ALWAYS = 1;
  66
  67     /** These are bit-mappy, as a hedge against the future. */
  68
  69     const EVERYONE = 1;
  70     const MEMBER   = 2;
  71     const ADMIN    = 4;
  72
  73     /**
  74      * return table definition for DB_DataObject
  75      *
  76      * DB_DataObject needs to know something about the table to manipulate
  77      * instances. This method provides all the DB_DataObject needs to know.
  78      *
  79      * @return array array of column definitions
  80      */
  81     function table()
  82     {
  83         return array('group_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  84                      'allow_privacy' => DB_DATAOBJECT_INT,
  85                      'allow_sender' => DB_DATAOBJECT_INT,
  86                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
  87                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  88
  89     }
  90
  91     /**
  92      * return key definitions for DB_DataObject
  93      *
  94      * DB_DataObject needs to know about keys that the table has, since it
  95      * won't appear in StatusNet's own keys list. In most cases, this will
  96      * simply reference your keyTypes() function.
  97      *
  98      * @return array list of key field names
  99      */
 100     function keys()
 101     {
 102         return array_keys($this->keyTypes());
 103     }
 104
 105     /**
 106      * return key definitions for Memcached_DataObject
 107      *
 108      * @return array associative array of key definitions, field name to type:
 109      *         'K' for primary key: for compound keys, add an entry for each component;
 110      *         'U' for unique keys: compound keys are not well supported here.
 111      */
 112     function keyTypes()
 113     {
 114         return array('group_id' => 'K');
 115     }
 116
 117     /**
 118      * Magic formula for non-autoincrementing integer primary keys
 119      *
 120      * @return array magic three-false array that stops auto-incrementing.
 121      */
 122     function sequenceKey()
 123     {
 124         return array(false, false, false);
 125     }
 126
 127     function forGroup($group)
 128     {
 129         $gps = Group_privacy_settings::staticGet('group_id', $group->id);
 130
 131         if (empty($gps)) {
 132             // make a fake one with defaults
 133             $gps = new Group_privacy_settings();
 134             $gps->allow_privacy = Group_privacy_settings::SOMETIMES;
 135             $gps->allow_sender  = Group_privacy_settings::MEMBER;
 136         }
 137
 138         return $gps;
 139     }
 140
 141     function ensurePost($user, $group)
 142     {
 143         $gps = self::forGroup($group);
 144
 145         if ($gps->allow_privacy == Group_privacy_settings::NEVER) {
 146             // TRANS: Exception thrown when trying to set group privacy setting if group %s does not allow private messages.
 147             throw new Exception(sprintf(_m('Group %s does not allow private messages.'),
 148                                         $group->nickname));
 149         }
 150
 151         switch ($gps->allow_sender) {
 152         case Group_privacy_settings::EVERYONE:
 153             $profile = $user->getProfile();
 154             if (Group_block::isBlocked($group, $profile)) {
 155                 // TRANS: Exception thrown when trying to send group private message while blocked from that group.
 156                 // TRANS: %1$s is a user nickname, %2$s is a group nickname.
 157                 throw new Exception(sprintf(_m('User %1$s is blocked from group %2$s.'),
 158                                             $user->nickname,
 159                                             $group->nickname));
 160             }
 161             break;
 162         case Group_privacy_settings::MEMBER:
 163             if (!$user->isMember($group)) {
 164                 // TRANS: Exception thrown when trying to send group private message while not a member.
 165                 // TRANS: %1$s is a user nickname, %2$s is a group nickname.
 166                 throw new Exception(sprintf(_m('User %1$s is not a member of group %2$s.'),
 167                                             $user->nickname,
 168                                             $group->nickname));
 169             }
 170             break;
 171         case Group_privacy_settings::ADMIN:
 172             if (!$user->isAdmin($group)) {
 173                 // TRANS: Exception thrown when trying to send group private message while not a group administrator.
 174                 // TRANS: %1$s is a user nickname, %2$s is a group nickname.
 175                 throw new Exception(sprintf(_m('User %1$s is not an administrator of group %2$s.'),
 176                                             $user->nickname,
 177                                             $group->nickname));
 178             }
 179             break;
 180         default:
 181             // TRANS: Exception thrown when encountering undefined group privacy settings.
 182             // TRANS: %s is a group nickname.
 183             throw new Exception(sprintf(_m('Unknown privacy settings for group %s.'),
 184                                         $group->nickname));
 185         }
 186
 187         return true;
 188     }
 189 }