plugins/GroupPrivateMessage/classes/Group_message.php

   1 <?php
   2 /**
   3  * Data class for group direct messages
   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) 2009, 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 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
  35
  36 /**
  37  * Data class for group direct messages
  38  *
  39  * @category GroupPrivateMessage
  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_message extends Managed_DataObject
  48 {
  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
  54     public $content;
  55     public $rendered;
  56     public $url;
  57     public $created;                   // datetime()   not_null
  58     public $modified;                  // timestamp()   not_null default_CURRENT_TIMESTAMP
  59
  60     public static function schemaDef()
  61     {
  62         return array(
  63             'fields' => array(
  64                 'id' => array('type' => 'char', 'not null' => true, 'length' => 36, 'description' => 'message uuid'),
  65                 'uri' => array('type' => 'varchar', 'not null' => true, 'length' => 255, 'description' => 'message uri'),
  66                 'url' => array('type' => 'varchar', 'not null' => true, 'length' => 255, 'description' => 'representation url'),
  67                 'from_profile' => array('type' => 'int', 'not null' => true, 'description' => 'sending profile ID'),
  68                 'to_group' => array('type' => 'int', 'not null' => true, 'description' => 'receiving group ID'),
  69                 'content' => array('type' => 'text', 'not null' => true, 'description' => 'message content'),
  70                 'rendered' => array('type' => 'text', 'not null' => true, 'description' => 'rendered message'),
  71                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  72                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  73             ),
  74             'primary key' => array('id'),
  75             'unique keys' => array(
  76                 'group_message_uri_key' => array('uri'),
  77             ),
  78             'foreign keys' => array(
  79                 'group_message_from_profile_fkey' => array('profile', array('from_profile' => 'id')),
  80                 'group_message_to_group_fkey' => array('user_group', array('to_group' => 'id')),
  81             ),
  82             'indexes' => array(
  83                 'group_message_from_profile_idx' => array('from_profile'),
  84                 'group_message_to_group_idx' => array('to_group'),
  85                 'group_message_url_idx' => array('url'),
  86             ),
  87         );
  88     }
  89
  90     static function send($user, $group, $text)
  91     {
  92         if (!$user->hasRight(Right::NEWMESSAGE)) {
  93             // XXX: maybe break this out into a separate right
  94             // TRANS: Exception thrown when trying to send group private message without having the right to do that.
  95             // TRANS: %s is a user nickname.
  96             throw new Exception(sprintf(_m('User %s is not allowed to send private messages.'),
  97                                         $user->nickname));
  98         }
  99
 100         Group_privacy_settings::ensurePost($user, $group);
 101
 102         $text = $user->shortenLinks($text);
 103
 104         // We use the same limits as for 'regular' private messages.
 105
 106         if (Message::contentTooLong($text)) {
 107             // TRANS: Exception thrown when trying to send group private message that is too long.
 108             // TRANS: %d is the maximum meggage length.
 109             throw new Exception(sprintf(_m('That\'s too long. Maximum message size is %d character.',
 110                                            'That\'s too long. Maximum message size is %d characters.',
 111                                            Message::maxContent()),
 112                                         Message::maxContent()));
 113         }
 114
 115         // Valid! Let's do this thing!
 116
 117         $gm = new Group_message();
 118
 119         $gm->id           = UUID::gen();
 120         $gm->uri          = common_local_url('showgroupmessage', array('id' => $gm->id));
 121         $gm->from_profile = $user->id;
 122         $gm->to_group     = $group->id;
 123         $gm->content      = $text; // XXX: is this cool?!
 124         $gm->rendered     = common_render_text($text);
 125         $gm->url          = $gm->uri;
 126         $gm->created      = common_sql_now();
 127
 128         // This throws a conniption if there's a problem
 129
 130         $gm->insert();
 131
 132         $gm->distribute();
 133
 134         return $gm;
 135     }
 136
 137     function distribute()
 138     {
 139         $group = User_group::getKV('id', $this->to_group);
 140
 141         $member = $group->getMembers();
 142
 143         while ($member->fetch()) {
 144             Group_message_profile::send($this, $member);
 145         }
 146     }
 147
 148     function getGroup()
 149     {
 150         $group = User_group::getKV('id', $this->to_group);
 151         if (empty($group)) {
 152             // TRANS: Exception thrown when trying to send group private message to a non-existing group.
 153             throw new ServerException(_m('No group for group message.'));
 154         }
 155         return $group;
 156     }
 157
 158     function getSender()
 159     {
 160         $sender = Profile::getKV('id', $this->from_profile);
 161         if (empty($sender)) {
 162             // TRANS: Exception thrown when trying to send group private message without having a sender.
 163             throw new ServerException(_m('No sender for group message.'));
 164         }
 165         return $sender;
 166     }
 167
 168     static function forGroup($group, $offset, $limit)
 169     {
 170         // XXX: cache
 171         $gm = new Group_message();
 172
 173         $gm->to_group = $group->id;
 174         $gm->orderBy('created DESC');
 175         $gm->limit($offset, $limit);
 176
 177         $gm->find();
 178
 179         return $gm;
 180     }
 181 }