3 * StatusNet, the distributed open-source microblogging tool
5 * widget for displaying a list of notice attachments
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.
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.
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/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @copyright 2008 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/
31 if (!defined('GNUSOCIAL')) { exit(1); }
34 * widget for displaying a single notice
36 * This widget has the core smarts for showing a single notice: what to display,
37 * where, and under which circumstances. Its key method is show(); this is a recipe
38 * that calls all the other show*() methods to build up a single notice. The
39 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
40 * author info (since that's implicit by the data in the page).
44 * @author Evan Prodromou <evan@status.net>
45 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
46 * @link http://status.net/
48 * @see ProfileNoticeListItem
50 class AttachmentListItem extends Widget
52 /** The attachment this item will show. */
54 var $attachment = null;
57 * @param File $attachment the attachment we will display
59 function __construct(File $attachment, $out=null)
61 parent::__construct($out);
62 $this->attachment = $attachment;
66 return $this->attachment->getTitle() ?: _('Untitled attachment');
69 function linkTitle() {
70 return $this->title();
74 * recipe function for displaying a single notice.
76 * This uses all the other methods to correctly display a notice. Override
77 * it or one of the others to fine-tune the output.
84 $this->showNoticeAttachment();
89 return array('class' => 'attachment',
90 'href' => $this->attachment->getAttachmentUrl(),
91 'id' => 'attachment-' . $this->attachment->getID(),
92 'title' => $this->linkTitle());
96 $this->out->elementStart('a', $this->linkAttr());
97 $this->out->element('span', null, $this->linkTitle());
98 $this->showRepresentation();
99 $this->out->elementEnd('a');
102 function showNoticeAttachment()
107 function showRepresentation() {
108 $enclosure = $this->attachment->getEnclosure();
110 if (Event::handle('StartShowAttachmentRepresentation', array($this->out, $this->attachment))) {
111 if (!empty($enclosure->mimetype)) {
112 // First, prepare a thumbnail if it exists.
115 // Tell getThumbnail that we can show an animated image if it has one (4th arg, "force_still")
116 $thumb = $this->attachment->getThumbnail(null, null, false, false);
117 } catch (UseFileAsThumbnailException $e) {
119 } catch (UnsupportedMediaException $e) {
120 // FIXME: Show a good representation of unsupported/unshowable images
124 // Then get the kind of mediatype we're dealing with
125 $mediatype = common_get_mime_media($enclosure->mimetype);
127 // FIXME: Get proper mime recognition of Ogg files! If system has 'mediainfo', this should do it:
128 // $ mediainfo --inform='General;%InternetMediaType%'
129 if ($this->attachment->mimetype === 'application/ogg') {
130 $mediatype = 'video'; // because this element can handle Ogg/Vorbis etc. on its own
133 // Ugly hack to show text/html links which have a thumbnail (such as from oEmbed/OpenGraph image URLs)
134 if (!in_array($mediatype, ['image','audio','video']) && $thumb instanceof File_thumbnail) {
135 $mediatype = 'image';
138 switch ($mediatype) {
139 // Anything we understand as an image, if we need special treatment, do it in StartShowAttachmentRepresentation
141 if ($thumb instanceof File_thumbnail) {
142 $this->out->element('img', $thumb->getHtmlAttrs(['class'=>'u-photo', 'alt' => '']));
145 // getUrl(true) because we don't want to hotlink, could be made configurable
146 $this->out->element('img', ['class'=>'u-photo', 'src'=>$this->attachment->getUrl(true), 'alt' => $this->attachment->getTitle()]);
147 } catch (FileNotStoredLocallyException $e) {
148 $url = $e->file->getUrl(false);
149 $this->out->element('a', ['href'=>$url, 'rel'=>'external'], $url);
152 unset($thumb); // there's no need carrying this along after this
155 // HTML5 media elements
158 if ($thumb instanceof File_thumbnail) {
159 $poster = $thumb->getUrl();
160 unset($thumb); // there's no need carrying this along after this
165 $this->out->elementStart($mediatype,
166 array('class'=>"attachment_player u-{$mediatype}",
168 'controls'=>'controls'));
169 $this->out->element('source',
170 array('src'=>$this->attachment->getUrl(),
171 'type'=>$this->attachment->mimetype));
172 $this->out->elementEnd($mediatype);
176 unset($thumb); // there's no need carrying this along
177 switch ($this->attachment->mimetype) {
179 $this->element('div', ['class'=>'e-content plaintext'], file_get_contents($this->attachment->getPath()));
182 if (!empty($this->attachment->filename)
183 && (GNUsocial::isAjax() || common_config('attachments', 'show_html'))) {
184 // Locally-uploaded HTML. Scrub and display inline.
185 $this->showHtmlFile($this->attachment);
188 // Fall through to default if it wasn't a _local_ text/html File object
190 Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
194 Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
197 Event::handle('EndShowAttachmentRepresentation', array($this->out, $this->attachment));
200 protected function showHtmlFile(File $attachment)
202 $body = $this->scrubHtmlFile($attachment);
204 $this->out->raw($body);
209 * @return mixed false on failure, HTML fragment string on success
211 protected function scrubHtmlFile(File $attachment)
213 $path = $attachment->getPath();
214 $raw = file_get_contents($path);
217 $dom = new DOMDocument();
218 if(!$dom->loadHTML($raw)) {
219 common_log(LOG_ERR, "Bad HTML in local HTML attachment $path");
223 // Remove <script>s or htmlawed will dump their contents into output!
224 // Note: removing child nodes while iterating seems to mess things up,
225 // hence the double loop.
227 foreach ($dom->getElementsByTagName('script') as $script) {
228 $scripts[] = $script;
230 foreach ($scripts as $script) {
231 common_log(LOG_DEBUG, $script->textContent);
232 $script->parentNode->removeChild($script);
235 // Trim out everything outside the body...
236 $body = $dom->saveHTML();
237 $body = preg_replace('/^.*<body[^>]*>/is', '', $body);
238 $body = preg_replace('/<\/body[^>]*>.*$/is', '', $body);
240 require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
241 $purifier = new HTMLPurifier();
242 return $purifier->purify($body);
246 * start a single notice.
253 // TODO: add notice_type class e.g., notice_video, notice_image
254 $this->out->elementStart('li');
260 * Close the last elements in the notice list item
266 $this->out->elementEnd('li');