lib/attachmentlistitem.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * widget for displaying a list of notice attachments
   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  UI
  23  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * widget for displaying a single notice
  35  *
  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).
  41  *
  42  * @category UI
  43  * @package  StatusNet
  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/
  47  * @see      NoticeList
  48  * @see      ProfileNoticeListItem
  49  */
  50 class AttachmentListItem extends Widget
  51 {
  52     /** The attachment this item will show. */
  53
  54     var $attachment = null;
  55
  56     /**
  57      * @param File $attachment the attachment we will display
  58      */
  59     function __construct(File $attachment, $out=null)
  60     {
  61         parent::__construct($out);
  62         $this->attachment  = $attachment;
  63     }
  64
  65     function title() {
  66         return $this->attachment->getTitle();
  67     }
  68
  69     function linkTitle() {
  70         return $this->title();
  71     }
  72
  73     /**
  74      * recipe function for displaying a single notice.
  75      *
  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.
  78      *
  79      * @return void
  80      */
  81     function show()
  82     {
  83         $this->showStart();
  84         $this->showNoticeAttachment();
  85         $this->showEnd();
  86     }
  87
  88     function linkAttr() {
  89         return array('class' => 'attachment',
  90                      'href' => $this->attachment->getUrl(false),
  91                      'id' => 'attachment-' . $this->attachment->id,
  92                      'title' => $this->linkTitle());
  93     }
  94
  95     function showLink() {
  96         $this->out->elementStart('a', $this->linkAttr());
  97         $this->out->element('span', null, $this->linkTitle());
  98         $this->showRepresentation();
  99         $this->out->elementEnd('a');
 100     }
 101
 102     function showNoticeAttachment()
 103     {
 104         $this->showLink();
 105     }
 106
 107     function showRepresentation() {
 108         $enclosure = $this->attachment->getEnclosure();
 109
 110         if (Event::handle('StartShowAttachmentRepresentation', array($this->out, $this->attachment))) {
 111             if (!empty($enclosure->mimetype)) {
 112                 // First, prepare a thumbnail if it exists.
 113                 $thumb = null;
 114                 try {
 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) {
 118                     $thumb = null;
 119                 } catch (UnsupportedMediaException $e) {
 120                     // FIXME: Show a good representation of unsupported/unshowable images
 121                     $thumb = null;
 122                 }
 123
 124                 // Then get the kind of mediatype we're dealing with
 125                 $mediatype = common_get_mime_media($enclosure->mimetype);
 126
 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
 131                 }
 132                 switch ($mediatype) {
 133                 // Anything we understand as an image, if we need special treatment, do it in StartShowAttachmentRepresentation
 134                 case 'image':
 135                     if ($thumb instanceof File_thumbnail) {
 136                         $this->out->element('img', $thumb->getHtmlAttrs(['class'=>'u-photo', 'alt' => '']));
 137                     } else {
 138                         $this->out->element('img', array('class'=>'u-photo', 'src' => $this->attachment->getUrl(), 'alt' => $this->attachment->getTitle()));
 139                     }
 140                     unset($thumb);  // there's no need carrying this along after this
 141                     break;
 142
 143                 // HTML5 media elements
 144                 case 'audio':
 145                 case 'video':
 146                     if ($thumb instanceof File_thumbnail) {
 147                         $poster = $thumb->getUrl();
 148                         unset($thumb);  // there's no need carrying this along after this
 149                     }
 150
 151                     $this->out->elementStart($mediatype,
 152                                         array('class'=>"attachment_player u-{$mediatype}",
 153                                             'poster'=>$poster,
 154                                             'controls'=>'controls'));
 155                     $this->out->element('source',
 156                                         array('src'=>$this->attachment->getUrl(),
 157                                             'type'=>$this->attachment->mimetype));
 158                     $this->out->elementEnd($mediatype);
 159                     break;
 160
 161                 default:
 162                     unset($thumb);  // there's no need carrying this along
 163                     switch ($this->attachment->mimetype) {
 164                     case 'text/html':
 165                         if (!empty($this->attachment->filename)
 166                                 && (GNUsocial::isAjax() || common_config('attachments', 'show_html'))) {
 167                             // Locally-uploaded HTML. Scrub and display inline.
 168                             $this->showHtmlFile($this->attachment);
 169                             break;
 170                         }
 171                         // Fall through to default if it wasn't a _local_ text/html File object
 172                     default:
 173                         Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
 174                     }
 175                 }
 176             } else {
 177                 Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
 178             }
 179         }
 180         Event::handle('EndShowAttachmentRepresentation', array($this->out, $this->attachment));
 181     }
 182
 183     protected function showHtmlFile(File $attachment)
 184     {
 185         $body = $this->scrubHtmlFile($attachment);
 186         if ($body) {
 187             $this->out->raw($body);
 188         }
 189     }
 190
 191     /**
 192      * @return mixed false on failure, HTML fragment string on success
 193      */
 194     protected function scrubHtmlFile(File $attachment)
 195     {
 196         $path = File::path($attachment->filename);
 197         if (!file_exists($path) || !is_readable($path)) {
 198             common_log(LOG_ERR, "Missing local HTML attachment $path");
 199             return false;
 200         }
 201         $raw = file_get_contents($path);
 202
 203         // Normalize...
 204         $dom = new DOMDocument();
 205         if(!$dom->loadHTML($raw)) {
 206             common_log(LOG_ERR, "Bad HTML in local HTML attachment $path");
 207             return false;
 208         }
 209
 210         // Remove <script>s or htmlawed will dump their contents into output!
 211         // Note: removing child nodes while iterating seems to mess things up,
 212         // hence the double loop.
 213         $scripts = array();
 214         foreach ($dom->getElementsByTagName('script') as $script) {
 215             $scripts[] = $script;
 216         }
 217         foreach ($scripts as $script) {
 218             common_log(LOG_DEBUG, $script->textContent);
 219             $script->parentNode->removeChild($script);
 220         }
 221
 222         // Trim out everything outside the body...
 223         $body = $dom->saveHTML();
 224         $body = preg_replace('/^.*<body[^>]*>/is', '', $body);
 225         $body = preg_replace('/<\/body[^>]*>.*$/is', '', $body);
 226
 227         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 228         $config = array('safe' => 1,
 229                         'deny_attribute' => 'id,style,on*',
 230                         'comment' => 1); // remove comments
 231         $scrubbed = htmLawed($body, $config);
 232
 233         return $scrubbed;
 234     }
 235
 236     /**
 237      * start a single notice.
 238      *
 239      * @return void
 240      */
 241     function showStart()
 242     {
 243         // XXX: RDFa
 244         // TODO: add notice_type class e.g., notice_video, notice_image
 245         $this->out->elementStart('li');
 246     }
 247
 248     /**
 249      * finish the notice
 250      *
 251      * Close the last elements in the notice list item
 252      *
 253      * @return void
 254      */
 255     function showEnd()
 256     {
 257         $this->out->elementEnd('li');
 258     }
 259 }