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
  52 class NoticeForm extends Form
  53 {
  54     /**
  55      * Current action, used for returning to this page.
  56      */
  57
  58     var $action = null;
  59
  60     /**
  61      * Pre-filled content of the form
  62      */
  63
  64     var $content = null;
  65
  66     /**
  67      * The current user
  68      */
  69
  70     var $user = null;
  71
  72     /**
  73      * The notice being replied to
  74      */
  75
  76     var $inreplyto = null;
  77
  78     /**
  79      * Pre-filled location content of the form
  80      */
  81
  82     var $lat;
  83     var $lon;
  84     var $location_id;
  85     var $location_ns;
  86
  87     /**
  88      * Constructor
  89      *
  90      * @param HTMLOutputter $out     output channel
  91      * @param string        $action  action to return to, if any
  92      * @param string        $content content to pre-fill
  93      */
  94
  95     function __construct($out=null, $action=null, $content=null, $user=null, $inreplyto=null, $lat=null, $lon=null, $location_id=null, $location_ns=null)
  96     {
  97         parent::__construct($out);
  98
  99         $this->action  = $action;
 100         $this->content = $content;
 101         $this->inreplyto = $inreplyto;
 102         $this->lat = $lat;
 103         $this->lon = $lon;
 104         $this->location_id = $location_id;
 105         $this->location_ns = $location_ns;
 106
 107         if ($user) {
 108             $this->user = $user;
 109         } else {
 110             $this->user = common_current_user();
 111         }
 112
 113         $this->profile = $this->user->getProfile();
 114
 115         if (common_config('attachments', 'uploads')) {
 116             $this->enctype = 'multipart/form-data';
 117         }
 118     }
 119
 120     /**
 121      * ID of the form
 122      *
 123      * @return string ID of the form
 124      */
 125
 126     function id()
 127     {
 128         return 'form_notice';
 129     }
 130
 131    /**
 132      * Class of the form
 133      *
 134      * @return string class of the form
 135      */
 136
 137     function formClass()
 138     {
 139         return 'form_notice';
 140     }
 141
 142     /**
 143      * Action of the form
 144      *
 145      * @return string URL of the action
 146      */
 147
 148     function action()
 149     {
 150         return common_local_url('newnotice');
 151     }
 152
 153     /**
 154      * Legend of the Form
 155      *
 156      * @return void
 157      */
 158     function formLegend()
 159     {
 160         $this->out->element('legend', null, _('Send a notice'));
 161     }
 162
 163     /**
 164      * Data elements
 165      *
 166      * @return void
 167      */
 168
 169     function formData()
 170     {
 171         if (Event::handle('StartShowNoticeFormData', array($this))) {
 172             $this->out->element('label', array('for' => 'notice_data-text',
 173                                                'id' => 'notice_data-text-label'),
 174                                 sprintf(_('What\'s up, %s?'), $this->user->nickname));
 175             // XXX: vary by defined max size
 176             $this->out->element('textarea', array('id' => 'notice_data-text',
 177                                                   'cols' => 35,
 178                                                   'rows' => 4,
 179                                                   'name' => 'status_textarea'),
 180                                 ($this->content) ? $this->content : '');
 181
 182             $contentLimit = Notice::maxContent();
 183
 184             if ($contentLimit > 0) {
 185                 $this->out->elementStart('dl', 'form_note');
 186                 $this->out->element('dt', null, _('Available characters'));
 187                 $this->out->element('dd', array('id' => 'notice_text-count'),
 188                                     $contentLimit);
 189                 $this->out->elementEnd('dl');
 190             }
 191
 192             if (common_config('attachments', 'uploads')) {
 193                 $this->out->element('label', array('for' => 'notice_data-attach'),_('Attach'));
 194                 $this->out->element('input', array('id' => 'notice_data-attach',
 195                                                    'type' => 'file',
 196                                                    'name' => 'attach',
 197                                                    'title' => _('Attach a file')));
 198                 $this->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
 199             }
 200             if ($this->action) {
 201                 $this->out->hidden('notice_return-to', $this->action, 'returnto');
 202             }
 203             $this->out->hidden('notice_in-reply-to', $this->inreplyto, 'inreplyto');
 204
 205             if ($this->user->shareLocation()) {
 206                 $this->out->hidden('notice_data-lat', empty($this->lat) ? (empty($this->profile->lat) ? null : $this->profile->lat) : $this->lat, 'lat');
 207                 $this->out->hidden('notice_data-lon', empty($this->lon) ? (empty($this->profile->lon) ? null : $this->profile->lon) : $this->lon, 'lon');
 208                 $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');
 209                 $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');
 210
 211                 $this->out->elementStart('div', array('id' => 'notice_data-geo_wrap',
 212                                                       'title' => common_local_url('geocode')));
 213                 $this->out->checkbox('notice_data-geo', _('Share my location'), true);
 214                 $this->out->elementEnd('div');
 215                 $this->out->inlineScript(' var NoticeDataGeo_text = {'.
 216                     'ShareDisable: ' .json_encode(_('Do not share my location')).','.
 217                     'ErrorTimeout: ' .json_encode(_('Sorry, retrieving your geo location is taking longer than expected, please try again later')).
 218                     '}');
 219             }
 220
 221             Event::handle('EndShowNoticeFormData', array($this));
 222         }
 223     }
 224
 225     /**
 226      * Action elements
 227      *
 228      * @return void
 229      */
 230
 231     function formActions()
 232     {
 233         $this->out->element('input', array('id' => 'notice_action-submit',
 234                                            'class' => 'submit',
 235                                            'name' => 'status_submit',
 236                                            'type' => 'submit',
 237                                            'value' => _m('Send button for sending notice', 'Send')));
 238     }
 239 }