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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/form.php';
  36
  37 /**
  38  * Form for posting a notice
  39  *
  40  * Frequently-used form for posting a notice
  41  *
  42  * @category Form
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Sarven Capadisli <csarven@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  *
  49  * @see      HTMLOutputter
  50  */
  51 class NoticeForm extends Form
  52 {
  53     /**
  54      * Current action, used for returning to this page.
  55      */
  56     var $actionName = null;
  57
  58     /**
  59      * Pre-filled content of the form
  60      */
  61     var $content = null;
  62
  63     /**
  64      * The current user
  65      */
  66     var $user = null;
  67
  68     /**
  69      * The notice being replied to
  70      */
  71     var $inreplyto = null;
  72
  73     /**
  74      * Pre-filled location content of the form
  75      */
  76
  77     var $lat;
  78     var $lon;
  79     var $location_id;
  80     var $location_ns;
  81
  82     /** select this group from the drop-down by default. */
  83     var $to_group;
  84
  85     /** select this user from the drop-down by default. */
  86     var $to_profile;
  87
  88     /** Pre-click the private checkbox. */
  89     var $private;
  90
  91     /**
  92      * Constructor
  93      *
  94      * @param Action $action  Action we're being embedded into
  95      * @param array  $options Array of optional parameters
  96      *                        'user' a user instead of current
  97      *                        'content' notice content
  98      *                        'inreplyto' ID of notice to reply to
  99      *                        'lat' Latitude
 100      *                        'lon' Longitude
 101      *                        'location_id' ID of location
 102      *                        'location_ns' Namespace of location
 103      */
 104     function __construct(Action $action, array $options = array())
 105     {
 106         // XXX: ??? Is this to keep notice forms distinct?
 107         // Do we have to worry about sub-second race conditions?
 108         // XXX: Needs to be above the parent::__construct() call...?
 109
 110         $this->id_suffix = rand();
 111
 112         parent::__construct($action);
 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                                                   'cols' => 35,
 209                                                   'rows' => 4,
 210                                                   'name' => 'status_textarea'),
 211                                 ($this->content) ? $this->content : '');
 212
 213             $contentLimit = Notice::maxContent();
 214
 215             if ($contentLimit > 0) {
 216                 $this->out->element('span',
 217                                     array('class' => 'count'),
 218                                     $contentLimit);
 219             }
 220
 221             if (common_config('attachments', 'uploads')) {
 222                 $this->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
 223                 $this->out->elementStart('label', array('class' => 'notice_data-attach'));
 224                 // TRANS: Input label in notice form for adding an attachment.
 225                 $this->out->text(_('Attach'));
 226                 $this->out->element('input', array('class' => 'notice_data-attach',
 227                                                    'type' => 'file',
 228                                                    'name' => 'attach',
 229                                                    // TRANS: Title for input field to attach a file to a notice.
 230                                                    'title' => _('Attach a file.')));
 231                 $this->out->elementEnd('label');
 232             }
 233             if (!empty($this->actionName)) {
 234                 $this->out->hidden('notice_return-to', $this->actionName, 'returnto');
 235             }
 236             $this->out->hidden('notice_in-reply-to', $this->inreplyto, 'inreplyto');
 237
 238             $this->out->elementStart('div', 'to-selector');
 239             $toWidget = new ToSelector($this->out,
 240                                        $this->user,
 241                                        (!empty($this->to_group) ? $this->to_group : $this->to_profile));
 242
 243             $toWidget->show();
 244             $this->out->elementEnd('div');
 245
 246             if ($this->profile->shareLocation()) {
 247                 $this->out->hidden('notice_data-lat', empty($this->lat) ? (empty($this->profile->lat) ? null : $this->profile->lat) : $this->lat, 'lat');
 248                 $this->out->hidden('notice_data-lon', empty($this->lon) ? (empty($this->profile->lon) ? null : $this->profile->lon) : $this->lon, 'lon');
 249                 $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');
 250                 $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');
 251
 252                 $this->out->elementStart('div', array('class' => 'notice_data-geo_wrap',
 253                                                       'data-api' => common_local_url('geocode')));
 254
 255                 // @fixme checkbox method allows no way to change the id without changing the name
 256                 //// TRANS: Checkbox label to allow sharing geo location in notices.
 257                 //$this->out->checkbox('notice_data-geo', _('Share my location'), true);
 258                 $this->out->elementStart('label', 'notice_data-geo');
 259                 $this->out->element('input', array(
 260                     'name' => 'notice_data-geo',
 261                     'type' => 'checkbox',
 262                     'class' => 'checkbox',
 263                     'id' => $this->id() . '-notice_data-geo',
 264                     'checked' => true, // ?
 265                 ));
 266                 $this->out->text(' ');
 267                 // TRANS: Field label to add location to a notice.
 268                 $this->out->text(_('Share my location'));
 269                 $this->out->elementEnd('label');
 270
 271                 $this->out->elementEnd('div');
 272                 // TRANS: Text to not share location for a notice in notice form.
 273                 $share_disable_text = _('Do not share my location');
 274                 // TRANS: Timeout error text for location retrieval in notice form.
 275                 $error_timeout_text = _('Sorry, retrieving your geo location is taking longer than expected, please try again later');
 276                 $this->out->inlineScript(' var NoticeDataGeo_text = {'.
 277                     'ShareDisable: ' .json_encode($share_disable_text).','.
 278                     'ErrorTimeout: ' .json_encode($error_timeout_text).
 279                     '}');
 280             }
 281
 282             Event::handle('EndShowNoticeFormData', array($this));
 283         }
 284     }
 285
 286     /**
 287      * Action elements
 288      *
 289      * @return void
 290      */
 291
 292     function formActions()
 293     {
 294         $this->out->element('input', array('id' => 'notice_action-submit',
 295                                            'class' => 'submit',
 296                                            'name' => 'status_submit',
 297                                            'type' => 'submit',
 298                                            // TRANS: Button text for sending notice.
 299                                            'value' => _m('BUTTON', 'Send')));
 300     }
 301 }