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         parent::__construct($action);
 103
 104         // When creating a notice form we don't want to collide with
 105         // possibly existing HTML elements, as naming conventions are similar.
 106         $this->id_suffix = rand();
 107
 108         if (is_null($options)) {
 109             $options = array();
 110         }
 111
 112         $this->actionName  = $action->trimmed('action');
 113
 114         $prefill = array('content', 'inreplyto', 'lat',
 115                          'lon', 'location_id', 'location_ns',
 116                          'to_group', 'to_profile', 'private');
 117
 118         foreach ($prefill as $fieldName) {
 119             if (array_key_exists($fieldName, $options)) {
 120                 $this->$fieldName = $options[$fieldName];
 121             }
 122         }
 123
 124         // Prefill the profile if we're replying
 125
 126         if (empty($this->to_profile) &&
 127             !empty($this->inreplyto)) {
 128             $notice = Notice::getKV('id', $this->inreplyto);
 129             if (!empty($notice)) {
 130                 $this->to_profile = $notice->getProfile();
 131             }
 132         }
 133
 134         if (array_key_exists('user', $options)) {
 135             $this->user = $options['user'];
 136         } else {
 137             $this->user = common_current_user();
 138         }
 139
 140         $this->profile = $this->user->getProfile();
 141
 142         if (common_config('attachments', 'uploads')) {
 143             $this->enctype = 'multipart/form-data';
 144         }
 145     }
 146
 147     /**
 148      * ID of the form
 149      *
 150      * @return string ID of the form
 151      */
 152
 153     function id()
 154     {
 155         return 'form_notice_' . $this->id_suffix;
 156     }
 157
 158    /**
 159      * Class of the form
 160      *
 161      * @return string class of the form
 162      */
 163
 164     function formClass()
 165     {
 166         return 'form_notice ajax-notice';
 167     }
 168
 169     /**
 170      * Action of the form
 171      *
 172      * @return string URL of the action
 173      */
 174
 175     function action()
 176     {
 177         return common_local_url('newnotice');
 178     }
 179
 180     /**
 181      * Legend of the Form
 182      *
 183      * @return void
 184      */
 185     function formLegend()
 186     {
 187         // TRANS: Form legend for notice form.
 188         $this->out->element('legend', null, _('Send a notice'));
 189     }
 190
 191     protected function placeholderText()
 192     {
 193         if ($this->inreplyto) {
 194             return _('Write a reply...');
 195         }
 196
 197         return _('Share your status...');
 198     }
 199
 200     /**
 201      * Data elements
 202      *
 203      * @return void
 204      */
 205     function formData()
 206     {
 207         if (Event::handle('StartShowNoticeFormData', array($this))) {
 208             $this->out->element('label', array('for' => 'notice_data-text',
 209                                                'id' => 'notice_data-text-label'),
 210                                 // TRANS: Title for notice label. %s is the user's nickname.
 211                                 sprintf(_('What\'s up, %s?'), $this->user->nickname));
 212             // XXX: vary by defined max size
 213             $this->out->element('textarea', array('class' => 'notice_data-text',
 214                                                   'required' => 'required',
 215                                                   'placeholder' => $this->placeholderText(),
 216                                                   'cols' => 35,
 217                                                   'rows' => 4,
 218                                                   'name' => 'status_textarea'),
 219                                 ($this->content) ? $this->content : '');
 220
 221             $contentLimit = Notice::maxContent();
 222
 223             if ($contentLimit > 0) {
 224                 $this->out->element('span',
 225                                     array('class' => 'count'),
 226                                     $contentLimit);
 227             }
 228
 229             if (common_config('attachments', 'uploads')) {
 230                 $this->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
 231                 $this->out->element('label', array('class' => 'notice_data-attach',
 232                                                    'for'   => $this->id().'-notice_data-attach'),
 233                                     // TRANS: Input label in notice form for adding an attachment.
 234                                     _('Attach'));
 235                 // The actual input element tends to be hidden with CSS.
 236                 $this->out->element('input', array('class' => 'notice_data-attach',
 237                                                    'type' => 'file',
 238                                                    'name' => 'attach',
 239                                                    'id' => $this->id().'-notice_data-attach',
 240                                                    // TRANS: Title for input field to attach a file to a notice.
 241                                                    'title' => _('Attach a file.')));
 242             }
 243             if (!empty($this->actionName)) {
 244                 $this->out->hidden('notice_return-to', $this->actionName, 'returnto');
 245             }
 246             $this->out->hidden('notice_in-reply-to', $this->inreplyto, 'inreplyto');
 247
 248             $this->out->elementStart('div', 'to-selector');
 249             $toWidget = new ToSelector($this->out,
 250                                        $this->user,
 251                                        (!empty($this->to_group) ? $this->to_group : $this->to_profile));
 252
 253             $toWidget->show();
 254             $this->out->elementEnd('div');
 255
 256             if ($this->profile->shareLocation()) {
 257                 $this->out->hidden('notice_data-lat', empty($this->lat) ? (empty($this->profile->lat) ? null : $this->profile->lat) : $this->lat, 'lat');
 258                 $this->out->hidden('notice_data-lon', empty($this->lon) ? (empty($this->profile->lon) ? null : $this->profile->lon) : $this->lon, 'lon');
 259                 $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');
 260                 $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');
 261
 262                 $this->out->elementStart('div', array('class' => 'notice_data-geo_wrap',
 263                                                       'data-api' => common_local_url('geocode')));
 264
 265                 // @fixme checkbox method allows no way to change the id without changing the name
 266                 //$this->out->checkbox('notice_data-geo', _('Share my location'), true);
 267                 $this->out->element('input', array(
 268                     'name' => 'notice_data-geo',
 269                     'type' => 'checkbox',
 270                     'class' => 'checkbox',
 271                     'id' => $this->id() . '-notice_data-geo',
 272                     'checked' => true, // ?
 273                 ));
 274                 $this->out->element('label', array('class' => 'notice_data-geo',
 275                                                    'for'   => $this->id().'-notice_data-geo'),
 276                                     // TRANS: Checkbox label to allow sharing geo location in notices.
 277                                     _('Share my location'));
 278
 279                 $this->out->elementEnd('div');
 280                 // TRANS: Text to not share location for a notice in notice form.
 281                 $share_disable_text = _('Do not share my location');
 282                 // TRANS: Timeout error text for location retrieval in notice form.
 283                 $error_timeout_text = _('Sorry, retrieving your geo location is taking longer than expected, please try again later');
 284                 $this->out->inlineScript(' var NoticeDataGeo_text = {'.
 285                     'ShareDisable: ' .json_encode($share_disable_text).','.
 286                     'ErrorTimeout: ' .json_encode($error_timeout_text).
 287                     '}');
 288             }
 289
 290             Event::handle('EndShowNoticeFormData', array($this));
 291         }
 292     }
 293
 294     /**
 295      * Action elements
 296      *
 297      * @return void
 298      */
 299
 300     function formActions()
 301     {
 302         $this->out->element('input', array('id' => 'notice_action-submit',
 303                                            'class' => 'submit',
 304                                            'name' => 'status_submit',
 305                                            'type' => 'submit',
 306                                            // TRANS: Button text for sending notice.
 307                                            'value' => _m('BUTTON', 'Send')));
 308     }
 309 }