lib/noticeform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for posting a notice
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Form
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Form for posting a notice
  35  *
  36  * Frequently-used form for posting a notice
  37  *
  38  * @category Form
  39  * @package  StatusNet
  40  * @author   Evan Prodromou <evan@status.net>
  41  * @author   Sarven Capadisli <csarven@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  *
  45  * @see      HTMLOutputter
  46  */
  47 class NoticeForm extends Form
  48 {
  49     /**
  50      * Current action, used for returning to this page.
  51      */
  52     var $actionName = null;
  53
  54     /**
  55      * Pre-filled content of the form
  56      */
  57     var $content = null;
  58
  59     /**
  60      * The current user
  61      */
  62     var $user = null;
  63
  64     /**
  65      * The notice being replied to
  66      */
  67     var $inreplyto = null;
  68
  69     /**
  70      * Pre-filled location content of the form
  71      */
  72
  73     var $lat;
  74     var $lon;
  75     var $location_id;
  76     var $location_ns;
  77
  78     /** select this group from the drop-down by default. */
  79     var $to_group;
  80
  81     /** select this user from the drop-down by default. */
  82     var $to_profile;
  83
  84     /** Pre-click the private checkbox. */
  85     var $private;
  86
  87     /**
  88      * Constructor
  89      *
  90      * @param Action $action  Action we're being embedded into
  91      * @param array  $options Array of optional parameters
  92      *                        'user' a user instead of current
  93      *                        'content' notice content
  94      *                        'inreplyto' ID of notice to reply to
  95      *                        'lat' Latitude
  96      *                        'lon' Longitude
  97      *                        'location_id' ID of location
  98      *                        'location_ns' Namespace of location
  99      */
 100     function __construct($action, $options=null)
 101     {
 102         // XXX: ??? Is this to keep notice forms distinct?
 103         // Do we have to worry about sub-second race conditions?
 104         // XXX: Needs to be above the parent::__construct() call...?
 105
 106         $this->id_suffix = rand();
 107
 108         parent::__construct($action);
 109
 110         if (is_null($options)) {
 111             $options = array();
 112         }
 113
 114         $this->actionName  = $action->trimmed('action');
 115
 116         $prefill = array('content', 'inreplyto', 'lat',
 117                          'lon', 'location_id', 'location_ns',
 118                          'to_group', 'to_profile', 'private');
 119
 120         foreach ($prefill as $fieldName) {
 121             if (array_key_exists($fieldName, $options)) {
 122                 $this->$fieldName = $options[$fieldName];
 123             }
 124         }
 125
 126         // Prefill the profile if we're replying
 127
 128         if (empty($this->to_profile) &&
 129             !empty($this->inreplyto)) {
 130             $notice = Notice::getKV('id', $this->inreplyto);
 131             if (!empty($notice)) {
 132                 $this->to_profile = $notice->getProfile();
 133             }
 134         }
 135
 136         if (array_key_exists('user', $options)) {
 137             $this->user = $options['user'];
 138         } else {
 139             $this->user = common_current_user();
 140         }
 141
 142         $this->profile = $this->user->getProfile();
 143
 144         if (common_config('attachments', 'uploads')) {
 145             $this->enctype = 'multipart/form-data';
 146         }
 147     }
 148
 149     /**
 150      * ID of the form
 151      *
 152      * @return string ID of the form
 153      */
 154
 155     function id()
 156     {
 157         return 'form_notice_' . $this->id_suffix;
 158     }
 159
 160    /**
 161      * Class of the form
 162      *
 163      * @return string class of the form
 164      */
 165
 166     function formClass()
 167     {
 168         return 'form_notice ajax-notice';
 169     }
 170
 171     /**
 172      * Action of the form
 173      *
 174      * @return string URL of the action
 175      */
 176
 177     function action()
 178     {
 179         return common_local_url('newnotice');
 180     }
 181
 182     /**
 183      * Legend of the Form
 184      *
 185      * @return void
 186      */
 187     function formLegend()
 188     {
 189         // TRANS: Form legend for notice form.
 190         $this->out->element('legend', null, _('Send a notice'));
 191     }
 192
 193     /**
 194      * Data elements
 195      *
 196      * @return void
 197      */
 198     function formData()
 199     {
 200         if (Event::handle('StartShowNoticeFormData', array($this))) {
 201             $this->out->element('label', array('for' => 'notice_data-text',
 202                                                'id' => 'notice_data-text-label'),
 203                                 // TRANS: Title for notice label. %s is the user's nickname.
 204                                 sprintf(_('What\'s up, %s?'), $this->user->nickname));
 205             // XXX: vary by defined max size
 206             $this->out->element('textarea', array('class' => 'notice_data-text',
 207                                                   'required' => 'required',
 208                                                   'placeholder' => _('Share your status...'),
 209                                                   'cols' => 35,
 210                                                   'rows' => 4,
 211                                                   'name' => 'status_textarea'),
 212                                 ($this->content) ? $this->content : '');
 213
 214             $contentLimit = Notice::maxContent();
 215
 216             if ($contentLimit > 0) {
 217                 $this->out->element('span',
 218                                     array('class' => 'count'),
 219                                     $contentLimit);
 220             }
 221
 222             if (common_config('attachments', 'uploads')) {
 223                 $this->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
 224                 $this->out->elementStart('label', array('class' => 'notice_data-attach'));
 225                 // TRANS: Input label in notice form for adding an attachment.
 226                 $this->out->text(_('Attach'));
 227                 $this->out->element('input', array('class' => 'notice_data-attach',
 228                                                    'type' => 'file',
 229                                                    'name' => 'attach',
 230                                                    // TRANS: Title for input field to attach a file to a notice.
 231                                                    'title' => _('Attach a file.')));
 232                 $this->out->elementEnd('label');
 233             }
 234             if (!empty($this->actionName)) {
 235                 $this->out->hidden('notice_return-to', $this->actionName, 'returnto');
 236             }
 237             $this->out->hidden('notice_in-reply-to', $this->inreplyto, 'inreplyto');
 238
 239             $this->out->elementStart('div', 'to-selector');
 240             $toWidget = new ToSelector($this->out,
 241                                        $this->user,
 242                                        (!empty($this->to_group) ? $this->to_group : $this->to_profile));
 243
 244             $toWidget->show();
 245             $this->out->elementEnd('div');
 246
 247             if ($this->profile->shareLocation()) {
 248                 $this->out->hidden('notice_data-lat', empty($this->lat) ? (empty($this->profile->lat) ? null : $this->profile->lat) : $this->lat, 'lat');
 249                 $this->out->hidden('notice_data-lon', empty($this->lon) ? (empty($this->profile->lon) ? null : $this->profile->lon) : $this->lon, 'lon');
 250                 $this->out->hidden('notice_data-location_id', empty($this->location_id) ? (empty($this->profile->location_id) ? null : $this->profile->location_id) : $this->location_id, 'location_id');
 251                 $this->out->hidden('notice_data-location_ns', empty($this->location_ns) ? (empty($this->profile->location_ns) ? null : $this->profile->location_ns) : $this->location_ns, 'location_ns');
 252
 253                 $this->out->elementStart('div', array('class' => 'notice_data-geo_wrap',
 254                                                       'data-api' => common_local_url('geocode')));
 255
 256                 // @fixme checkbox method allows no way to change the id without changing the name
 257                 //// TRANS: Checkbox label to allow sharing geo location in notices.
 258                 //$this->out->checkbox('notice_data-geo', _('Share my location'), true);
 259                 $this->out->elementStart('label', 'notice_data-geo');
 260                 $this->out->element('input', array(
 261                     'name' => 'notice_data-geo',
 262                     'type' => 'checkbox',
 263                     'class' => 'checkbox',
 264                     'id' => $this->id() . '-notice_data-geo',
 265                     'checked' => true, // ?
 266                 ));
 267                 $this->out->text(' ');
 268                 // TRANS: Field label to add location to a notice.
 269                 $this->out->text(_('Share my location'));
 270                 $this->out->elementEnd('label');
 271
 272                 $this->out->elementEnd('div');
 273                 // TRANS: Text to not share location for a notice in notice form.
 274                 $share_disable_text = _('Do not share my location');
 275                 // TRANS: Timeout error text for location retrieval in notice form.
 276                 $error_timeout_text = _('Sorry, retrieving your geo location is taking longer than expected, please try again later');
 277                 $this->out->inlineScript(' var NoticeDataGeo_text = {'.
 278                     'ShareDisable: ' .json_encode($share_disable_text).','.
 279                     'ErrorTimeout: ' .json_encode($error_timeout_text).
 280                     '}');
 281             }
 282
 283             Event::handle('EndShowNoticeFormData', array($this));
 284         }
 285     }
 286
 287     /**
 288      * Action elements
 289      *
 290      * @return void
 291      */
 292
 293     function formActions()
 294     {
 295         $this->out->element('input', array('id' => 'notice_action-submit',
 296                                            'class' => 'submit',
 297                                            'name' => 'status_submit',
 298                                            'type' => 'submit',
 299                                            // TRANS: Button text for sending notice.
 300                                            'value' => _m('BUTTON', 'Send')));
 301     }
 302 }