]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/newnotice.php
change Notice::saveNew() to use named arguments for little-used options
[quix0rs-gnu-social.git] / actions / newnotice.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Handler for posting new notices
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  Personal
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @author    Zach Copley <zach@status.net>
26  * @author    Sarven Capadisli <csarven@status.net>
27  * @copyright 2008-2009 StatusNet, Inc.
28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29  * @link      http://status.net/
30  */
31
32 if (!defined('STATUSNET') && !defined('LACONICA')) {
33     exit(1);
34 }
35
36 require_once INSTALLDIR . '/lib/noticelist.php';
37 require_once INSTALLDIR . '/lib/mediafile.php';
38
39 /**
40  * Action for posting new notices
41  *
42  * @category Personal
43  * @package  StatusNet
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Zach Copley <zach@status.net>
46  * @author   Sarven Capadisli <csarven@status.net>
47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48  * @link     http://status.net/
49  */
50
51 class NewnoticeAction extends Action
52 {
53     /**
54      * Error message, if any
55      */
56
57     var $msg = null;
58
59     /**
60      * Title of the page
61      *
62      * Note that this usually doesn't get called unless something went wrong
63      *
64      * @return string page title
65      */
66
67     function title()
68     {
69         return _('New notice');
70     }
71
72     /**
73      * Handle input, produce output
74      *
75      * Switches based on GET or POST method. On GET, shows a form
76      * for posting a notice. On POST, saves the results of that form.
77      *
78      * Results may be a full page, or just a single notice list item,
79      * depending on whether AJAX was requested.
80      *
81      * @param array $args $_REQUEST contents
82      *
83      * @return void
84      */
85
86     function handle($args)
87     {
88         if (!common_logged_in()) {
89             $this->clientError(_('Not logged in.'));
90         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
91             // check for this before token since all POST and FILES data
92             // is losts when size is exceeded
93             if (empty($_POST) && $_SERVER['CONTENT_LENGTH']) {
94                 $this->clientError(sprintf(_('The server was unable to handle ' .
95                                              'that much POST data (%s bytes) due to its current configuration.'),
96                                            $_SERVER['CONTENT_LENGTH']));
97             }
98             parent::handle($args);
99
100             // CSRF protection
101             $token = $this->trimmed('token');
102             if (!$token || $token != common_session_token()) {
103                 $this->clientError(_('There was a problem with your session token. '.
104                                      'Try again, please.'));
105             }
106             try {
107                 $this->saveNewNotice();
108             } catch (Exception $e) {
109                 $this->showForm($e->getMessage());
110                 return;
111             }
112         } else {
113             $this->showForm();
114         }
115     }
116
117     /**
118      * Save a new notice, based on arguments
119      *
120      * If successful, will show the notice, or return an Ajax-y result.
121      * If not, it will show an error message -- possibly Ajax-y.
122      *
123      * Also, if the notice input looks like a command, it will run the
124      * command and show the results -- again, possibly ajaxy.
125      *
126      * @return void
127      */
128
129     function saveNewNotice()
130     {
131         $user = common_current_user();
132         assert($user); // XXX: maybe an error instead...
133         $content = $this->trimmed('status_textarea');
134
135         if (!$content) {
136             $this->clientError(_('No content!'));
137             return;
138         }
139
140         $inter = new CommandInterpreter();
141
142         $cmd = $inter->handle_command($user, $content);
143
144         if ($cmd) {
145             if ($this->boolean('ajax')) {
146                 $cmd->execute(new AjaxWebChannel($this));
147             } else {
148                 $cmd->execute(new WebChannel($this));
149             }
150             return;
151         }
152
153         $content_shortened = common_shorten_links($content);
154         if (Notice::contentTooLong($content_shortened)) {
155             $this->clientError(sprintf(_('That\'s too long. '.
156                                          'Max notice size is %d chars.'),
157                                        Notice::maxContent()));
158         }
159
160         $replyto = $this->trimmed('inreplyto');
161         #If an ID of 0 is wrongly passed here, it will cause a database error,
162         #so override it...
163         if ($replyto == 0) {
164             $replyto = 'false';
165         }
166
167         $lat = $this->trimmed('lat');
168         $lon = $this->trimmed('lon');
169         $location_id = $this->trimmed('location_id');
170         $location_ns = $this->trimmed('location_ns');
171
172         $upload = null;
173         $upload = MediaFile::fromUpload('attach');
174
175         if (isset($upload)) {
176
177             $content_shortened .= ' ' . $upload->shortUrl();
178
179             if (Notice::contentTooLong($content_shortened)) {
180                 $upload->delete();
181                 $this->clientError(
182                     sprintf(
183                         _('Max notice size is %d chars, including attachment URL.'),
184                           Notice::maxContent()
185                     )
186                 );
187             }
188         }
189
190         $notice = Notice::saveNew($user->id, $content_shortened, 'web',
191                                   array('reply_to' => ($replyto == 'false') ? null : $replyto,
192                                         'lat' => $lat,
193                                         'lon' => $lon,
194                                         'location_id' => $location_id,
195                                         'location_ns' => $location_ns));
196
197         if (isset($upload)) {
198             $upload->attachToNotice($notice);
199         }
200
201         common_broadcast_notice($notice);
202
203         if ($this->boolean('ajax')) {
204             header('Content-Type: text/xml;charset=utf-8');
205             $this->xw->startDocument('1.0', 'UTF-8');
206             $this->elementStart('html');
207             $this->elementStart('head');
208             $this->element('title', null, _('Notice posted'));
209             $this->elementEnd('head');
210             $this->elementStart('body');
211             $this->showNotice($notice);
212             $this->elementEnd('body');
213             $this->elementEnd('html');
214         } else {
215             $returnto = $this->trimmed('returnto');
216
217             if ($returnto) {
218                 $url = common_local_url($returnto,
219                                         array('nickname' => $user->nickname));
220             } else {
221                 $url = common_local_url('shownotice',
222                                         array('notice' => $notice->id));
223             }
224             common_redirect($url, 303);
225         }
226     }
227
228     /**
229      * Show an Ajax-y error message
230      *
231      * Goes back to the browser, where it's shown in a popup.
232      *
233      * @param string $msg Message to show
234      *
235      * @return void
236      */
237
238     function ajaxErrorMsg($msg)
239     {
240         $this->startHTML('text/xml;charset=utf-8', true);
241         $this->elementStart('head');
242         $this->element('title', null, _('Ajax Error'));
243         $this->elementEnd('head');
244         $this->elementStart('body');
245         $this->element('p', array('id' => 'error'), $msg);
246         $this->elementEnd('body');
247         $this->elementEnd('html');
248     }
249
250     /**
251      * Formerly page output
252      *
253      * This used to be the whole page output; now that's been largely
254      * subsumed by showPage. So this just stores an error message, if
255      * it was passed, and calls showPage.
256      *
257      * Note that since we started doing Ajax output, this page is rarely
258      * seen.
259      *
260      * @param string $msg An error message, if any
261      *
262      * @return void
263      */
264
265     function showForm($msg=null)
266     {
267         if ($msg && $this->boolean('ajax')) {
268             $this->ajaxErrorMsg($msg);
269             return;
270         }
271
272         $this->msg = $msg;
273         $this->showPage();
274     }
275
276     /**
277      * Overload for replies or bad results
278      *
279      * We show content in the notice form if there were replies or results.
280      *
281      * @return void
282      */
283
284     function showNoticeForm()
285     {
286         $content = $this->trimmed('status_textarea');
287         if (!$content) {
288             $replyto = $this->trimmed('replyto');
289             $inreplyto = $this->trimmed('inreplyto');
290             $profile = Profile::staticGet('nickname', $replyto);
291             if ($profile) {
292                 $content = '@' . $profile->nickname . ' ';
293             }
294         }
295
296         $notice_form = new NoticeForm($this, '', $content, null, $inreplyto);
297         $notice_form->show();
298     }
299
300     /**
301      * Show an error message
302      *
303      * Shows an error message if there is one.
304      *
305      * @return void
306      *
307      * @todo maybe show some instructions?
308      */
309
310     function showPageNotice()
311     {
312         if ($this->msg) {
313             $this->element('p', array('id' => 'error'), $this->msg);
314         }
315     }
316
317     /**
318      * Output a notice
319      *
320      * Used to generate the notice code for Ajax results.
321      *
322      * @param Notice $notice Notice that was saved
323      *
324      * @return void
325      */
326
327     function showNotice($notice)
328     {
329         $nli = new NoticeListItem($notice, $this);
330         $nli->show();
331     }
332 }
333