lib/toselector.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Widget showing a drop-down of potential addressees
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Widget
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Widget showing a drop-down of potential addressees
  39  *
  40  * @category  Widget
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class ToSelector extends Widget
  48 {
  49     protected $user;
  50     protected $to;
  51     protected $id;
  52     protected $name;
  53     protected $private;
  54
  55     /**
  56      * Constructor
  57      *
  58      * @param HTMLOutputter $out  output context
  59      * @param User          $user Current user
  60      * @param mixed         $to   Default selection for addressee
  61      */
  62     function __construct($out, $user, $to, $private=false, $id='notice_to', $name='notice_to')
  63     {
  64         parent::__construct($out);
  65
  66         $this->user    = $user;
  67         $this->to      = $to;
  68         $this->private = $private;
  69         $this->id      = $id;
  70         $this->name    = $name;
  71     }
  72
  73     /**
  74      * Constructor
  75      *
  76      * @param HTMLOutputter $out  output context
  77      * @param User          $user Current user
  78      * @param mixed         $to   Default selection for addressee
  79      */
  80     function show()
  81     {
  82         $choices = array();
  83         $default = 'public:site';
  84
  85         if (!common_config('site', 'private')) {
  86             // TRANS: Option in drop-down of potential addressees.
  87             $choices['public:everyone'] = _m('SENDTO','Everyone');
  88             $default = 'public:everyone';
  89         }
  90         // TRANS: Option in drop-down of potential addressees.
  91         // TRANS: %s is a StatusNet sitename.
  92         $choices['public:site'] = sprintf(_('Everyone at %s'), common_config('site', 'name'));
  93
  94         $groups = $this->user->getGroups();
  95
  96         while ($groups instanceof User_group && $groups->fetch()) {
  97             $value = 'group:'.$groups->id;
  98             if (($this->to instanceof User_group) && $this->to->id == $groups->id) {
  99                 $default = $value;
 100             }
 101             $choices[$value] = $groups->getBestName();
 102         }
 103
 104         // Add subscribed users to dropdown menu
 105         $users = $this->user->getSubscribed();
 106         while ($users->fetch()) {
 107             $value = 'profile:'.$users->id;
 108             if ($this->user->streamNicknames()) {
 109                 $choices[$value] = $users->getNickname();
 110             } else {
 111                 $choices[$value] = $users->getBestName();
 112             }
 113         }
 114
 115         if ($this->to instanceof Profile) {
 116             $value = 'profile:'.$this->to->id;
 117             $default = $value;
 118             $choices[$value] = $this->to->getBestName();
 119         }
 120
 121         $this->out->dropdown($this->id,
 122                              // TRANS: Label for drop-down of potential addressees.
 123                              _m('LABEL','To:'),
 124                              $choices,
 125                              null,
 126                              false,
 127                              $default);
 128
 129         $this->out->elementStart('span', 'checkbox-wrapper');
 130         if (common_config('notice', 'allowprivate')) {
 131             $this->out->checkbox('notice_private',
 132                                  // TRANS: Checkbox label in widget for selecting potential addressees to mark the notice private.
 133                                  _('Private?'),
 134                                  $this->private);
 135         }
 136         $this->out->elementEnd('span');
 137     }
 138
 139     static function fillActivity(Action $action, Activity $act, array &$options)
 140     {
 141         if (!$act->context instanceof ActivityContext) {
 142             $act->context = new ActivityContext();
 143         }
 144         self::fillOptions($action, $options);
 145         if (isset($options['groups'])) {
 146             foreach ($options['groups'] as $group_id) {
 147                 $group = User_group::getByID($group_id);
 148                 $act->context->attention[$group->getUri()] = $group->getObjectType();
 149             }
 150         }
 151         if (isset($options['replies'])) {
 152             foreach ($options['replies'] as $profile_uri) {
 153                 $profile = Profile::fromUri($profile_uri);
 154                 $act->context->attention[$profile->getUri()] = $profile->getObjectType();
 155             }
 156         }
 157     }
 158
 159     static function fillOptions($action, &$options)
 160     {
 161         // XXX: make arg name selectable
 162         $toArg = $action->trimmed('notice_to');
 163         $private = common_config('notice', 'allowprivate') ? $action->boolean('notice_private') : false;
 164
 165         if (empty($toArg)) {
 166             return;
 167         }
 168
 169         list($prefix, $value) = explode(':', $toArg);
 170         switch ($prefix) {
 171         case 'group':
 172             $options['groups'] = array($value);
 173             if ($private) {
 174                 $options['scope'] = Notice::GROUP_SCOPE;
 175             }
 176             break;
 177         case 'profile':
 178             $profile = Profile::getKV('id', $value);
 179             $options['replies'] = array($profile->getUri());
 180             if ($private) {
 181                 $options['scope'] = Notice::ADDRESSEE_SCOPE;
 182             }
 183             break;
 184         case 'public':
 185             if ($value == 'everyone' && !common_config('site', 'private')) {
 186                 $options['scope'] = 0;
 187             } else if ($value == 'site') {
 188                 $options['scope'] = Notice::SITE_SCOPE;
 189             }
 190             break;
 191         default:
 192             // TRANS: Client exception thrown in widget for selecting potential addressees when an invalid fill option was received.
 193             throw new ClientException(sprintf(_('Unknown to value: "%s".'),$toArg));
 194             break;
 195         }
 196     }
 197 }