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         // XXX: better name...?
  91         // TRANS: Option in drop-down of potential addressees.
  92         // TRANS: %s is a StatusNet sitename.
  93         $choices['public:site'] = sprintf(_('My colleagues at %s'), common_config('site', 'name'));
  94
  95         $groups = $this->user->getGroups();
  96
  97         while ($groups instanceof User_group && $groups->fetch()) {
  98             $value = 'group:'.$groups->id;
  99             if (($this->to instanceof User_group) && $this->to->id == $groups->id) {
 100                 $default = $value;
 101             }
 102             $choices[$value] = $groups->getBestName();
 103         }
 104
 105         // XXX: add users...?
 106
 107         if ($this->to instanceof Profile) {
 108             $value = 'profile:'.$this->to->id;
 109             $default = $value;
 110             $choices[$value] = $this->to->getBestName();
 111         }
 112
 113         $this->out->dropdown($this->id,
 114                              // TRANS: Label for drop-down of potential addressees.
 115                              _m('LABEL','To:'),
 116                              $choices,
 117                              null,
 118                              false,
 119                              $default);
 120
 121         $this->out->elementStart('span', 'checkbox-wrapper');
 122         $this->out->checkbox('notice_private',
 123                              // TRANS: Checkbox label in widget for selecting potential addressees to mark the notice private.
 124                              _('Private?'),
 125                              $this->private);
 126         $this->out->elementEnd('span');
 127     }
 128
 129     static function fillOptions($action, &$options)
 130     {
 131         // XXX: make arg name selectable
 132         $toArg = $action->trimmed('notice_to');
 133         $private = $action->boolean('notice_private');
 134
 135         if (empty($toArg)) {
 136             return;
 137         }
 138
 139         list($prefix, $value) = explode(':', $toArg);
 140         switch ($prefix) {
 141         case 'group':
 142             $options['groups'] = array($value);
 143             if ($private) {
 144                 $options['scope'] = Notice::GROUP_SCOPE;
 145             }
 146             break;
 147         case 'profile':
 148             $profile = Profile::getKV('id', $value);
 149             $options['replies'] = array($profile->getUri());
 150             if ($private) {
 151                 $options['scope'] = Notice::ADDRESSEE_SCOPE;
 152             }
 153             break;
 154         case 'public':
 155             if ($value == 'everyone' && !common_config('site', 'private')) {
 156                 $options['scope'] = 0;
 157             } else if ($value == 'site') {
 158                 $options['scope'] = Notice::SITE_SCOPE;
 159             }
 160             break;
 161         default:
 162             // TRANS: Client exception thrown in widget for selecting potential addressees when an invalid fill option was received.
 163             throw new ClientException(sprintf(_('Unknown to value: "%s".'),$toArg));
 164             break;
 165         }
 166     }
 167 }