lib/attachmentlist.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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * widget for displaying a list of notice attachments
  37  *
  38  * There are a number of actions that display a list of notices, in
  39  * reverse chronological order. This widget abstracts out most of the
  40  * code for UI for notice lists. It's overridden to hide some
  41  * data for e.g. the profile page.
  42  *
  43  * @category UI
  44  * @package  StatusNet
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  * @see      Notice
  49  * @see      NoticeListItem
  50  * @see      ProfileNoticeList
  51  */
  52 class AttachmentList extends Widget
  53 {
  54     /** the current stream of notices being displayed. */
  55
  56     var $notice = null;
  57
  58     /**
  59      * constructor
  60      *
  61      * @param Notice $notice stream of notices from DB_DataObject
  62      */
  63     function __construct($notice, $out=null)
  64     {
  65         parent::__construct($out);
  66         $this->notice = $notice;
  67     }
  68
  69     /**
  70      * show the list of notices
  71      *
  72      * "Uses up" the stream by looping through it. So, probably can't
  73      * be called twice on the same list.
  74      *
  75      * @return int count of notices listed.
  76      */
  77     function show()
  78     {
  79         $atts = new File;
  80         $att = $atts->getAttachments($this->notice->id);
  81         if (empty($att)) return 0;
  82         $this->out->elementStart('dl', array('id' =>'attachments',
  83                                              'class' => 'entry-content'));
  84         // TRANS: DT element label in attachment list.
  85         $this->out->element('dt', null, _('Attachments'));
  86         $this->out->elementStart('dd');
  87         $this->out->elementStart('ol', array('class' => 'attachments'));
  88
  89         foreach ($att as $n=>$attachment) {
  90             $item = $this->newListItem($attachment);
  91             $item->show();
  92         }
  93
  94         $this->out->elementEnd('dd');
  95         $this->out->elementEnd('ol');
  96         $this->out->elementEnd('dl');
  97
  98         return count($att);
  99     }
 100
 101     /**
 102      * returns a new list item for the current notice
 103      *
 104      * Recipe (factory?) method; overridden by sub-classes to give
 105      * a different list item class.
 106      *
 107      * @param Notice $notice the current notice
 108      *
 109      * @return NoticeListItem a list item for displaying the notice
 110      */
 111     function newListItem($attachment)
 112     {
 113         return new AttachmentListItem($attachment, $this->out);
 114     }
 115 }
 116
 117 /**
 118  * widget for displaying a single notice
 119  *
 120  * This widget has the core smarts for showing a single notice: what to display,
 121  * where, and under which circumstances. Its key method is show(); this is a recipe
 122  * that calls all the other show*() methods to build up a single notice. The
 123  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 124  * author info (since that's implicit by the data in the page).
 125  *
 126  * @category UI
 127  * @package  StatusNet
 128  * @author   Evan Prodromou <evan@status.net>
 129  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 130  * @link     http://status.net/
 131  * @see      NoticeList
 132  * @see      ProfileNoticeListItem
 133  */
 134 class AttachmentListItem extends Widget
 135 {
 136     /** The attachment this item will show. */
 137
 138     var $attachment = null;
 139
 140     var $oembed = null;
 141
 142     /**
 143      * constructor
 144      *
 145      * Also initializes the profile attribute.
 146      *
 147      * @param Notice $notice The notice we'll display
 148      */
 149     function __construct($attachment, $out=null)
 150     {
 151         parent::__construct($out);
 152         $this->attachment  = $attachment;
 153         $this->oembed = File_oembed::staticGet('file_id', $this->attachment->id);
 154     }
 155
 156     function title() {
 157         if (empty($this->attachment->title)) {
 158             if (empty($this->oembed->title)) {
 159                 $title = $this->attachment->url;
 160             } else {
 161                 $title = $this->oembed->title;
 162             }
 163         } else {
 164             $title = $this->attachment->title;
 165         }
 166
 167         return $title;
 168     }
 169
 170     function linkTitle() {
 171         return $this->title();
 172     }
 173
 174     /**
 175      * recipe function for displaying a single notice.
 176      *
 177      * This uses all the other methods to correctly display a notice. Override
 178      * it or one of the others to fine-tune the output.
 179      *
 180      * @return void
 181      */
 182     function show()
 183     {
 184         if ($this->attachment->isEnclosure()) {
 185             $this->showStart();
 186             $this->showNoticeAttachment();
 187             $this->showEnd();
 188         }
 189     }
 190
 191     function linkAttr() {
 192         return array('class' => 'attachment', 'href' => $this->attachment->url, 'id' => 'attachment-' . $this->attachment->id);
 193     }
 194
 195     function showLink() {
 196         $this->out->elementStart('a', $this->linkAttr());
 197         $this->out->element('span', null, $this->linkTitle());
 198         $this->showRepresentation();
 199         $this->out->elementEnd('a');
 200     }
 201
 202     function showNoticeAttachment()
 203     {
 204         $this->showLink();
 205     }
 206
 207     function showRepresentation() {
 208         $thumb = $this->getThumbInfo();
 209         if ($thumb) {
 210             $thumb = $this->sizeThumb($thumb);
 211             $this->out->element('img', array('alt' => '', 'src' => $thumb->url, 'width' => $thumb->width, 'height' => $thumb->height));
 212         }
 213     }
 214
 215     function getThumbInfo()
 216     {
 217         $thumbnail = File_thumbnail::staticGet('file_id', $this->attachment->id);
 218         if ($thumbnail) {
 219             return $thumbnail;
 220         } else {
 221             switch ($this->attachment->mimetype) {
 222                 case 'image/gif':
 223                 case 'image/png':
 224                 case 'image/jpg':
 225                 case 'image/jpeg':
 226                     $thumb = (object)array();
 227                     $thumb->url = $this->attachment->url;
 228                     $thumb->width = 100;
 229                     $thumb->height = 75; // @fixme
 230                     return $thumb;
 231             }
 232         }
 233         return false;
 234     }
 235
 236     function sizeThumb($thumbnail) {
 237         $maxWidth = 100;
 238         $maxHeight = 75;
 239         if ($thumbnail->width > $maxWidth) {
 240             $thumb = clone($thumbnail);
 241             $thumb->width = $maxWidth;
 242             $thumb->height = intval($thumbnail->height * $maxWidth / $thumbnail->width);
 243             return $thumb;
 244         } else {
 245             return $thumbnail;
 246         }
 247     }
 248
 249     /**
 250      * start a single notice.
 251      *
 252      * @return void
 253      */
 254     function showStart()
 255     {
 256         // XXX: RDFa
 257         // TODO: add notice_type class e.g., notice_video, notice_image
 258         $this->out->elementStart('li');
 259     }
 260
 261     /**
 262      * finish the notice
 263      *
 264      * Close the last elements in the notice list item
 265      *
 266      * @return void
 267      */
 268     function showEnd()
 269     {
 270         $this->out->elementEnd('li');
 271     }
 272 }
 273
 274 /**
 275  * used for one-off attachment action
 276  */
 277 class Attachment extends AttachmentListItem
 278 {
 279     function showLink() {
 280         $this->out->elementStart('div', array('id' => 'attachment_view',
 281                                               'class' => 'hentry'));
 282         $this->out->elementStart('div', 'entry-title');
 283         $this->out->element('a', $this->linkAttr(), $this->linkTitle());
 284         $this->out->elementEnd('div');
 285
 286         $this->out->elementStart('div', 'entry-content');
 287         $this->showRepresentation();
 288         $this->out->elementEnd('div');
 289
 290         if (!empty($this->oembed->author_name) || !empty($this->oembed->provider)) {
 291             $this->out->elementStart('div', array('id' => 'oembed_info',
 292                                                   'class' => 'entry-content'));
 293             if (!empty($this->oembed->author_name)) {
 294                 $this->out->elementStart('dl', 'vcard author');
 295                 // TRANS: DT element label in attachment list item.
 296                 $this->out->element('dt', null, _('Author'));
 297                 $this->out->elementStart('dd', 'fn');
 298                 if (empty($this->oembed->author_url)) {
 299                     $this->out->text($this->oembed->author_name);
 300                 } else {
 301                     $this->out->element('a', array('href' => $this->oembed->author_url,
 302                                                    'class' => 'url'), $this->oembed->author_name);
 303                 }
 304                 $this->out->elementEnd('dd');
 305                 $this->out->elementEnd('dl');
 306             }
 307             if (!empty($this->oembed->provider)) {
 308                 $this->out->elementStart('dl', 'vcard');
 309                 // TRANS: DT element label in attachment list item.
 310                 $this->out->element('dt', null, _('Provider'));
 311                 $this->out->elementStart('dd', 'fn');
 312                 if (empty($this->oembed->provider_url)) {
 313                     $this->out->text($this->oembed->provider);
 314                 } else {
 315                     $this->out->element('a', array('href' => $this->oembed->provider_url,
 316                                                    'class' => 'url'), $this->oembed->provider);
 317                 }
 318                 $this->out->elementEnd('dd');
 319                 $this->out->elementEnd('dl');
 320             }
 321             $this->out->elementEnd('div');
 322         }
 323         $this->out->elementEnd('div');
 324     }
 325
 326     function show() {
 327         $this->showNoticeAttachment();
 328     }
 329
 330     function linkAttr() {
 331         return array('rel' => 'external', 'href' => $this->attachment->url);
 332     }
 333
 334     function linkTitle() {
 335         return $this->attachment->url;
 336     }
 337
 338     function showRepresentation() {
 339         if (empty($this->oembed->type)) {
 340             if (empty($this->attachment->mimetype)) {
 341                 $this->showFallback();
 342             } else {
 343                 switch ($this->attachment->mimetype) {
 344                 case 'image/gif':
 345                 case 'image/png':
 346                 case 'image/jpg':
 347                 case 'image/jpeg':
 348                     $this->out->element('img', array('src' => $this->attachment->url, 'alt' => 'alt'));
 349                     break;
 350
 351                 case 'application/ogg':
 352                 case 'audio/x-speex':
 353                 case 'video/mpeg':
 354                 case 'audio/mpeg':
 355                 case 'video/mp4':
 356                 case 'video/quicktime':
 357                     $arr  = array('type' => $this->attachment->mimetype,
 358                         'data' => $this->attachment->url,
 359                         'width' => 320,
 360                         'height' => 240
 361                     );
 362                     $this->out->elementStart('object', $arr);
 363                     $this->out->element('param', array('name' => 'src', 'value' => $this->attachment->url));
 364                     $this->out->element('param', array('name' => 'autoStart', 'value' => 1));
 365                     $this->out->elementEnd('object');
 366                     break;
 367
 368                 case 'text/html':
 369                     if ($this->attachment->filename) {
 370                         // Locally-uploaded HTML. Scrub and display inline.
 371                         $this->showHtmlFile($this->attachment);
 372                         break;
 373                     }
 374                     // Fall through to default.
 375
 376                 default:
 377                     $this->showFallback();
 378                 }
 379             }
 380         } else {
 381             switch ($this->oembed->type) {
 382             case 'rich':
 383             case 'video':
 384             case 'link':
 385                 if (!empty($this->oembed->html)) {
 386                     require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 387                     $config = array(
 388                         'safe'=>1,
 389                         'elements'=>'*+object+embed');
 390                     $this->out->raw(htmLawed($this->oembed->html,$config));
 391                     //$this->out->raw($this->oembed->html);
 392                 }
 393                 break;
 394
 395             case 'photo':
 396                 $this->out->element('img', array('src' => $this->oembed->url, 'width' => $this->oembed->width, 'height' => $this->oembed->height, 'alt' => 'alt'));
 397                 break;
 398
 399             default:
 400                 $this->showFallback();
 401             }
 402         }
 403     }
 404
 405     protected function showHtmlFile(File $attachment)
 406     {
 407         $body = $this->scrubHtmlFile($attachment);
 408         if ($body) {
 409             $this->out->raw($body);
 410         }
 411     }
 412
 413     /**
 414      * @return mixed false on failure, HTML fragment string on success
 415      */
 416     protected function scrubHtmlFile(File $attachment)
 417     {
 418         $path = File::path($attachment->filename);
 419         if (!file_exists($path) || !is_readable($path)) {
 420             common_log(LOG_ERR, "Missing local HTML attachment $path");
 421             return false;
 422         }
 423         $raw = file_get_contents($path);
 424
 425         // Normalize...
 426         $dom = new DOMDocument();
 427         if(!$dom->loadHTML($raw)) {
 428             common_log(LOG_ERR, "Bad HTML in local HTML attachment $path");
 429             return false;
 430         }
 431
 432         // Remove <script>s or htmlawed will dump their contents into output!
 433         // Note: removing child nodes while iterating seems to mess things up,
 434         // hence the double loop.
 435         $scripts = array();
 436         foreach ($dom->getElementsByTagName('script') as $script) {
 437             $scripts[] = $script;
 438         }
 439         foreach ($scripts as $script) {
 440             common_log(LOG_DEBUG, $script->textContent);
 441             $script->parentNode->removeChild($script);
 442         }
 443
 444         // Trim out everything outside the body...
 445         $body = $dom->saveHTML();
 446         $body = preg_replace('/^.*<body[^>]*>/is', '', $body);
 447         $body = preg_replace('/<\/body[^>]*>.*$/is', '', $body);
 448
 449         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 450         $config = array('safe' => 1,
 451                         'deny_attribute' => 'id,style,on*',
 452                         'comment' => 1); // remove comments
 453         $scrubbed = htmLawed($body, $config);
 454
 455         return $scrubbed;
 456     }
 457 }