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(),
  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         if (Event::handle('StartShowAttachmentRepresentation', array($this->out, $this->attachment))) {
 109             if (!empty($this->attachment->mimetype)) {
 110                 $mediatype = common_get_mime_media($this->attachment->mimetype);
 111                 switch ($mediatype) {
 112                 // Anything we understand as an image, if we need special treatment, do it in StartShowAttachmentRepresentation
 113                 case 'image':
 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                         $this->out->element('img', array('class'=>'u-photo', 'src' => $thumb->getUrl(), 'alt' => ''));
 118                     } catch (UseFileAsThumbnailException $e) {
 119                         $this->out->element('img', array('class'=>'u-photo', 'src' => $e->file->getUrl(), 'alt' => $e->file->title));
 120                     } catch (UnsupportedMediaException $e) {
 121                         // FIXME: Show a good representation of unsupported/unshowable images
 122                     }
 123                     break;
 124
 125                 // HTML5 media elements
 126                 case 'audio':
 127                 case 'video':
 128                     try {
 129                         $thumb = $this->attachment->getThumbnail();
 130                         $poster = $thumb->getUrl();
 131                         unset ($thumb);
 132                     } catch (Exception $e) {
 133                         $poster = null;
 134                     }
 135                     $this->out->elementStart($mediatype,
 136                                         array('class'=>"attachment_player u-{$mediatype}",
 137                                             'poster'=>$poster,
 138                                             'controls'=>'controls'));
 139                     $this->out->element('source',
 140                                         array('src'=>$this->attachment->getUrl(),
 141                                             'type'=>$this->attachment->mimetype));
 142                     $this->out->elementEnd($mediatype);
 143                     break;
 144
 145                 default:
 146                     switch ($this->attachment->mimetype) {
 147                     // Ogg media that we're not really sure what it is...
 148                     case 'application/ogg':
 149                         $arr  = array('type' => $this->attachment->mimetype,
 150                             'data' => $this->attachment->getUrl(),
 151                             'width' => 320,
 152                             'height' => 240
 153                         );
 154                         $this->out->elementStart('object', $arr);
 155                         $this->out->element('param', array('name' => 'src', 'value' => $this->attachment->getUrl()));
 156                         $this->out->element('param', array('name' => 'autoStart', 'value' => 1));
 157                         $this->out->elementEnd('object');
 158                         break;
 159                     case 'text/html':
 160                         if (!empty($this->attachment->filename)
 161                                 && (GNUsocial::isAjax() || common_config('attachments', 'show_html'))) {
 162                             // Locally-uploaded HTML. Scrub and display inline.
 163                             $this->showHtmlFile($this->attachment);
 164                             break;
 165                         }
 166                         // Fall through to default if it wasn't a _local_ text/html File object
 167                     default:
 168                         Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
 169                     }
 170                 }
 171             } else {
 172                 Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
 173             }
 174         }
 175         Event::handle('EndShowAttachmentRepresentation', array($this->out, $this->attachment));
 176     }
 177
 178     protected function showHtmlFile(File $attachment)
 179     {
 180         $body = $this->scrubHtmlFile($attachment);
 181         if ($body) {
 182             $this->out->raw($body);
 183         }
 184     }
 185
 186     /**
 187      * @return mixed false on failure, HTML fragment string on success
 188      */
 189     protected function scrubHtmlFile(File $attachment)
 190     {
 191         $path = File::path($attachment->filename);
 192         if (!file_exists($path) || !is_readable($path)) {
 193             common_log(LOG_ERR, "Missing local HTML attachment $path");
 194             return false;
 195         }
 196         $raw = file_get_contents($path);
 197
 198         // Normalize...
 199         $dom = new DOMDocument();
 200         if(!$dom->loadHTML($raw)) {
 201             common_log(LOG_ERR, "Bad HTML in local HTML attachment $path");
 202             return false;
 203         }
 204
 205         // Remove <script>s or htmlawed will dump their contents into output!
 206         // Note: removing child nodes while iterating seems to mess things up,
 207         // hence the double loop.
 208         $scripts = array();
 209         foreach ($dom->getElementsByTagName('script') as $script) {
 210             $scripts[] = $script;
 211         }
 212         foreach ($scripts as $script) {
 213             common_log(LOG_DEBUG, $script->textContent);
 214             $script->parentNode->removeChild($script);
 215         }
 216
 217         // Trim out everything outside the body...
 218         $body = $dom->saveHTML();
 219         $body = preg_replace('/^.*<body[^>]*>/is', '', $body);
 220         $body = preg_replace('/<\/body[^>]*>.*$/is', '', $body);
 221
 222         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 223         $config = array('safe' => 1,
 224                         'deny_attribute' => 'id,style,on*',
 225                         'comment' => 1); // remove comments
 226         $scrubbed = htmLawed($body, $config);
 227
 228         return $scrubbed;
 229     }
 230
 231     /**
 232      * start a single notice.
 233      *
 234      * @return void
 235      */
 236     function showStart()
 237     {
 238         // XXX: RDFa
 239         // TODO: add notice_type class e.g., notice_video, notice_image
 240         $this->out->elementStart('li');
 241     }
 242
 243     /**
 244      * finish the notice
 245      *
 246      * Close the last elements in the notice list item
 247      *
 248      * @return void
 249      */
 250     function showEnd()
 251     {
 252         $this->out->elementEnd('li');
 253     }
 254 }