]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/shownotice.php
i18n/L10n review, extension credits added.
[quix0rs-gnu-social.git] / actions / shownotice.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show a single 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  Personal
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @copyright 2008-2009 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
31     exit(1);
32 }
33
34 require_once INSTALLDIR.'/lib/personalgroupnav.php';
35 require_once INSTALLDIR.'/lib/noticelist.php';
36 require_once INSTALLDIR.'/lib/feedlist.php';
37
38 /**
39  * Show a single notice
40  *
41  * @category Personal
42  * @package  StatusNet
43  * @author   Evan Prodromou <evan@status.net>
44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45  * @link     http://status.net/
46  */
47
48 class ShownoticeAction extends OwnerDesignAction
49 {
50     /**
51      * Notice object to show
52      */
53
54     var $notice = null;
55
56     /**
57      * Profile of the notice object
58      */
59
60     var $profile = null;
61
62     /**
63      * Avatar of the profile of the notice object
64      */
65
66     var $avatar = null;
67
68     /**
69      * Load attributes based on database arguments
70      *
71      * Loads all the DB stuff
72      *
73      * @param array $args $_REQUEST array
74      *
75      * @return success flag
76      */
77
78     function prepare($args)
79     {
80         parent::prepare($args);
81
82         $id = $this->arg('notice');
83
84         $this->notice = Notice::staticGet($id);
85
86         if (empty($this->notice)) {
87             // Did we used to have it, and it got deleted?
88             $deleted = Deleted_notice::staticGet($id);
89             if (!empty($deleted)) {
90                 $this->clientError(_('Notice deleted.'), 410);
91             } else {
92                 $this->clientError(_('No such notice.'), 404);
93             }
94             return false;
95         }
96
97         $this->profile = $this->notice->getProfile();
98
99         if (empty($this->profile)) {
100             $this->serverError(_('Notice has no profile.'), 500);
101             return false;
102         }
103
104         $this->user = User::staticGet('id', $this->profile->id);
105
106         $this->avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
107
108         return true;
109     }
110
111     /**
112      * Is this action read-only?
113      *
114      * @return boolean true
115      */
116
117     function isReadOnly($args)
118     {
119         return true;
120     }
121
122     /**
123      * Last-modified date for page
124      *
125      * When was the content of this page last modified? Based on notice,
126      * profile, avatar.
127      *
128      * @return int last-modified date as unix timestamp
129      */
130
131     function lastModified()
132     {
133         return max(strtotime($this->notice->modified),
134                    strtotime($this->profile->modified),
135                    ($this->avatar) ? strtotime($this->avatar->modified) : 0);
136     }
137
138     /**
139      * An entity tag for this page
140      *
141      * Shows the ETag for the page, based on the notice ID and timestamps
142      * for the notice, profile, and avatar. It's weak, since we change
143      * the date text "one hour ago", etc.
144      *
145      * @return string etag
146      */
147
148     function etag()
149     {
150         $avtime = ($this->avatar) ?
151           strtotime($this->avatar->modified) : 0;
152
153         return 'W/"' . implode(':', array($this->arg('action'),
154                                           common_user_cache_hash(),
155                                           common_language(),
156                                           $this->notice->id,
157                                           strtotime($this->notice->created),
158                                           strtotime($this->profile->modified),
159                                           $avtime)) . '"';
160     }
161
162     /**
163      * Title of the page
164      *
165      * @return string title of the page
166      */
167
168     function title()
169     {
170         if (!empty($this->profile->fullname)) {
171             $base = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
172         } else {
173             $base = $this->profile->nickname;
174         }
175
176         return sprintf(_('%1$s\'s status on %2$s'),
177                        $base,
178                        common_exact_date($this->notice->created));
179     }
180
181     /**
182      * Handle input
183      *
184      * Only handles get, so just show the page.
185      *
186      * @param array $args $_REQUEST data (unused)
187      *
188      * @return void
189      */
190
191     function handle($args)
192     {
193         parent::handle($args);
194
195         if ($this->notice->is_local == Notice::REMOTE_OMB) {
196             if (!empty($this->notice->url)) {
197                 $target = $this->notice->url;
198             } else if (!empty($this->notice->uri) && preg_match('/^https?:/', $this->notice->uri)) {
199                 // Old OMB posts saved the remote URL only into the URI field.
200                 $target = $this->notice->uri;
201             } else {
202                 // Shouldn't happen.
203                 $target = false;
204             }
205             if ($target && $target != $this->selfUrl()) {
206                 common_redirect($target, 301);
207                 return false;
208             }
209         }
210         $this->showPage();
211     }
212
213     /**
214      * Don't show local navigation
215      *
216      * @return void
217      */
218
219     function showLocalNavBlock()
220     {
221     }
222
223     /**
224      * Fill the content area of the page
225      *
226      * Shows a single notice list item.
227      *
228      * @return void
229      */
230
231     function showContent()
232     {
233         $this->elementStart('ol', array('class' => 'notices xoxo'));
234         $nli = new SingleNoticeItem($this->notice, $this);
235         $nli->show();
236         $this->elementEnd('ol');
237     }
238
239     /**
240      * Don't show page notice
241      *
242      * @return void
243      */
244
245     function showPageNoticeBlock()
246     {
247     }
248
249     /**
250      * Don't show aside
251      *
252      * @return void
253      */
254
255     function showAside() {
256     }
257
258     /**
259      * Extra <head> content
260      *
261      * We show the microid(s) for the author, if any.
262      *
263      * @return void
264      */
265
266     function extraHead()
267     {
268         $user = User::staticGet($this->profile->id);
269
270         if (!$user) {
271             return;
272         }
273
274         if ($user->emailmicroid && $user->email && $this->notice->uri) {
275             $id = new Microid('mailto:'. $user->email,
276                               $this->notice->uri);
277             $this->element('meta', array('name' => 'microid',
278                                          'content' => $id->toString()));
279         }
280
281         if ($user->jabbermicroid && $user->jabber && $this->notice->uri) {
282             $id = new Microid('xmpp:', $user->jabber,
283                               $this->notice->uri);
284             $this->element('meta', array('name' => 'microid',
285                                          'content' => $id->toString()));
286         }
287         $this->element('link',array('rel'=>'alternate',
288             'type'=>'application/json+oembed',
289             'href'=>common_local_url(
290                 'oembed',
291                 array(),
292                 array('format'=>'json','url'=>$this->notice->uri)),
293             'title'=>'oEmbed'),null);
294         $this->element('link',array('rel'=>'alternate',
295             'type'=>'text/xml+oembed',
296             'href'=>common_local_url(
297                 'oembed',
298                 array(),
299                 array('format'=>'xml','url'=>$this->notice->uri)),
300             'title'=>'oEmbed'),null);
301
302         // Extras to aid in sharing notices to Facebook
303         $avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
304         $avatarUrl = ($avatar) ?
305                      $avatar->displayUrl() :
306                      Avatar::defaultImage($avatar_size);
307         $this->element('meta', array('property' => 'og:image',
308                                      'content' => $avatarUrl));
309         $this->element('meta', array('property' => 'og:description',
310                                      'content' => $this->notice->content));
311     }
312 }
313
314 class SingleNoticeItem extends NoticeListItem
315 {
316     /**
317      * recipe function for displaying a single notice.
318      *
319      * We overload to show attachments.
320      *
321      * @return void
322      */
323
324     function show()
325     {
326         $this->showStart();
327         if (Event::handle('StartShowNoticeItem', array($this))) {
328             $this->showNotice();
329             $this->showNoticeAttachments();
330             $this->showNoticeInfo();
331             $this->showNoticeOptions();
332             Event::handle('EndShowNoticeItem', array($this));
333         }
334
335         $this->showEnd();
336     }
337
338     function showNoticeAttachments() {
339         $al = new AttachmentList($this->notice, $this->out);
340         $al->show();
341     }
342 }