AttachmentAction extends to ManagedAction

Also moved AttachmentListItem and its extended class Attachment are moved
into separate files (autoloaded from lib/).
This commit is contained in:
Mikael Nordfeldth 2014-05-18 12:57:46 +02:00
parent c6ba545697
commit b48e3a22bf
5 changed files with 329 additions and 278 deletions

View File

@ -27,11 +27,7 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('STATUSNET') && !defined('LACONICA')) { if (!defined('GNUSOCIAL')) { exit(1); }
exit(1);
}
require_once INSTALLDIR.'/lib/attachmentlist.php';
/** /**
* Show notice attachments * Show notice attachments
@ -42,7 +38,7 @@ require_once INSTALLDIR.'/lib/attachmentlist.php';
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/ * @link http://status.net/
*/ */
class AttachmentAction extends Action class AttachmentAction extends ManagedAction
{ {
/** /**
* Attachment object to show * Attachment object to show
@ -68,7 +64,7 @@ class AttachmentAction extends Action
$this->attachment = File::getKV($id); $this->attachment = File::getKV($id);
} }
if (empty($this->attachment)) { if (!$this->attachment instanceof File) {
// TRANS: Client error displayed trying to get a non-existing attachment. // TRANS: Client error displayed trying to get a non-existing attachment.
$this->clientError(_('No such attachment.'), 404); $this->clientError(_('No such attachment.'), 404);
} }
@ -105,14 +101,12 @@ class AttachmentAction extends Action
*/ */
protected function handle() protected function handle()
{ {
parent::handle();
if (empty($this->attachment->filename)) { if (empty($this->attachment->filename)) {
// if it's not a local file, gtfo // if it's not a local file, gtfo
common_redirect($this->attachment->url, 303); common_redirect($this->attachment->url, 303);
} }
$this->showPage(); parent::handle();
} }
/** /**

View File

@ -27,7 +27,7 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); } if (!defined('GNUSOCIAL')) { exit(1); }
/** /**
* Show notice attachments * Show notice attachments
@ -55,11 +55,6 @@ class Attachment_thumbnailAction extends AttachmentAction
return true; return true;
} }
/**
* Show page, a template method.
*
* @return nothing
*/
function showPage() function showPage()
{ {
// Returns a File_thumbnail object or throws exception if not available // Returns a File_thumbnail object or throws exception if not available

185
lib/attachment.php Normal file
View File

@ -0,0 +1,185 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* widget for displaying a list of notice attachments
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category UI
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2008 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* used for one-off attachment action
*/
class Attachment extends AttachmentListItem
{
function showLink() {
if (Event::handle('StartShowAttachmentLink', array($this->out, $this->attachment))) {
$this->out->elementStart('div', array('id' => 'attachment_view',
'class' => 'hentry'));
$this->out->elementStart('div', 'entry-title');
$this->out->element('a', $this->linkAttr(), $this->linkTitle());
$this->out->elementEnd('div');
$this->out->elementStart('div', 'entry-content');
$this->showRepresentation();
$this->out->elementEnd('div');
Event::handle('EndShowAttachmentLink', array($this->out, $this->attachment));
$this->out->elementEnd('div');
}
}
function show() {
$this->showNoticeAttachment();
}
function linkAttr() {
return array('rel' => 'external', 'href' => $this->attachment->url);
}
function linkTitle() {
return $this->attachment->url;
}
function showRepresentation() {
if (Event::handle('StartShowAttachmentRepresentation', array($this->out, $this->attachment))) {
if (!empty($this->attachment->mimetype)) {
switch ($this->attachment->mimetype) {
case 'image/gif':
case 'image/png':
case 'image/jpg':
case 'image/jpeg':
$this->out->element('img', array('src' => $this->attachment->url, 'alt' => 'alt'));
break;
case 'application/ogg':
$arr = array('type' => $this->attachment->mimetype,
'data' => $this->attachment->url,
'width' => 320,
'height' => 240
);
$this->out->elementStart('object', $arr);
$this->out->element('param', array('name' => 'src', 'value' => $this->attachment->url));
$this->out->element('param', array('name' => 'autoStart', 'value' => 1));
$this->out->elementEnd('object');
break;
case 'audio/ogg':
case 'audio/x-speex':
case 'video/mpeg':
case 'audio/mpeg':
case 'video/mp4':
case 'video/ogg':
case 'video/quicktime':
case 'video/webm':
$mediatype = common_get_mime_media($this->attachment->mimetype);
try {
$thumb = $this->attachment->getThumbnail();
$poster = $thumb->getUrl();
unset ($thumb);
} catch (Exception $e) {
$poster = null;
}
$this->out->elementStart($mediatype,
array('class'=>'attachment_player',
'poster'=>$poster,
'controls'=>'controls'));
$this->out->element('source',
array('src'=>$this->attachment->url,
'type'=>$this->attachment->mimetype));
$this->out->elementEnd($mediatype);
break;
case 'text/html':
if ($this->attachment->filename) {
// Locally-uploaded HTML. Scrub and display inline.
$this->showHtmlFile($this->attachment);
break;
}
// Fall through to default.
default:
Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
}
} else {
Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
}
}
Event::handle('EndShowAttachmentRepresentation', array($this->out, $this->attachment));
}
protected function showHtmlFile(File $attachment)
{
$body = $this->scrubHtmlFile($attachment);
if ($body) {
$this->out->raw($body);
}
}
/**
* @return mixed false on failure, HTML fragment string on success
*/
protected function scrubHtmlFile(File $attachment)
{
$path = File::path($attachment->filename);
if (!file_exists($path) || !is_readable($path)) {
common_log(LOG_ERR, "Missing local HTML attachment $path");
return false;
}
$raw = file_get_contents($path);
// Normalize...
$dom = new DOMDocument();
if(!$dom->loadHTML($raw)) {
common_log(LOG_ERR, "Bad HTML in local HTML attachment $path");
return false;
}
// Remove <script>s or htmlawed will dump their contents into output!
// Note: removing child nodes while iterating seems to mess things up,
// hence the double loop.
$scripts = array();
foreach ($dom->getElementsByTagName('script') as $script) {
$scripts[] = $script;
}
foreach ($scripts as $script) {
common_log(LOG_DEBUG, $script->textContent);
$script->parentNode->removeChild($script);
}
// Trim out everything outside the body...
$body = $dom->saveHTML();
$body = preg_replace('/^.*<body[^>]*>/is', '', $body);
$body = preg_replace('/<\/body[^>]*>.*$/is', '', $body);
require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
$config = array('safe' => 1,
'deny_attribute' => 'id,style,on*',
'comment' => 1); // remove comments
$scrubbed = htmLawed($body, $config);
return $scrubbed;
}
}

View File

@ -110,265 +110,3 @@ class AttachmentList extends Widget
return new AttachmentListItem($attachment, $this->out); return new AttachmentListItem($attachment, $this->out);
} }
} }
/**
* widget for displaying a single notice
*
* This widget has the core smarts for showing a single notice: what to display,
* where, and under which circumstances. Its key method is show(); this is a recipe
* that calls all the other show*() methods to build up a single notice. The
* ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
* author info (since that's implicit by the data in the page).
*
* @category UI
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
* @see NoticeList
* @see ProfileNoticeListItem
*/
class AttachmentListItem extends Widget
{
/** The attachment this item will show. */
var $attachment = null;
/**
* @param File $attachment the attachment we will display
*/
function __construct(File $attachment, $out=null)
{
parent::__construct($out);
$this->attachment = $attachment;
}
function title() {
return $this->attachment->title ?: $this->attachment->filename;
}
function linkTitle() {
return $this->title();
}
/**
* recipe function for displaying a single notice.
*
* This uses all the other methods to correctly display a notice. Override
* it or one of the others to fine-tune the output.
*
* @return void
*/
function show()
{
$this->showStart();
$this->showNoticeAttachment();
$this->showEnd();
}
function linkAttr() {
return array('class' => 'attachment',
'href' => $this->attachment->url,
'id' => 'attachment-' . $this->attachment->id,
'title' => $this->linkTitle());
}
function showLink() {
$this->out->elementStart('a', $this->linkAttr());
$this->out->element('span', null, $this->linkTitle());
$this->showRepresentation();
$this->out->elementEnd('a');
}
function showNoticeAttachment()
{
$this->showLink();
}
function showRepresentation() {
try {
$thumb = $this->attachment->getThumbnail();
$this->out->element('img', array('alt' => '', 'src' => $thumb->getUrl(), 'width' => $thumb->width, 'height' => $thumb->height));
} catch (UnsupportedMediaException $e) {
// Image representation unavailable
}
}
/**
* start a single notice.
*
* @return void
*/
function showStart()
{
// XXX: RDFa
// TODO: add notice_type class e.g., notice_video, notice_image
$this->out->elementStart('li');
}
/**
* finish the notice
*
* Close the last elements in the notice list item
*
* @return void
*/
function showEnd()
{
$this->out->elementEnd('li');
}
}
/**
* used for one-off attachment action
*/
class Attachment extends AttachmentListItem
{
function showLink() {
if (Event::handle('StartShowAttachmentLink', array($this->out, $this->attachment))) {
$this->out->elementStart('div', array('id' => 'attachment_view',
'class' => 'hentry'));
$this->out->elementStart('div', 'entry-title');
$this->out->element('a', $this->linkAttr(), $this->linkTitle());
$this->out->elementEnd('div');
$this->out->elementStart('div', 'entry-content');
$this->showRepresentation();
$this->out->elementEnd('div');
Event::handle('EndShowAttachmentLink', array($this->out, $this->attachment));
$this->out->elementEnd('div');
}
}
function show() {
$this->showNoticeAttachment();
}
function linkAttr() {
return array('rel' => 'external', 'href' => $this->attachment->url);
}
function linkTitle() {
return $this->attachment->url;
}
function showRepresentation() {
if (Event::handle('StartShowAttachmentRepresentation', array($this->out, $this->attachment))) {
if (!empty($this->attachment->mimetype)) {
switch ($this->attachment->mimetype) {
case 'image/gif':
case 'image/png':
case 'image/jpg':
case 'image/jpeg':
$this->out->element('img', array('src' => $this->attachment->url, 'alt' => 'alt'));
break;
case 'application/ogg':
$arr = array('type' => $this->attachment->mimetype,
'data' => $this->attachment->url,
'width' => 320,
'height' => 240
);
$this->out->elementStart('object', $arr);
$this->out->element('param', array('name' => 'src', 'value' => $this->attachment->url));
$this->out->element('param', array('name' => 'autoStart', 'value' => 1));
$this->out->elementEnd('object');
break;
case 'audio/ogg':
case 'audio/x-speex':
case 'video/mpeg':
case 'audio/mpeg':
case 'video/mp4':
case 'video/ogg':
case 'video/quicktime':
case 'video/webm':
$mediatype = common_get_mime_media($this->attachment->mimetype);
try {
$thumb = $this->attachment->getThumbnail();
$poster = $thumb->getUrl();
unset ($thumb);
} catch (Exception $e) {
$poster = null;
}
$this->out->elementStart($mediatype,
array('class'=>'attachment_player',
'poster'=>$poster,
'controls'=>'controls'));
$this->out->element('source',
array('src'=>$this->attachment->url,
'type'=>$this->attachment->mimetype));
$this->out->elementEnd($mediatype);
break;
case 'text/html':
if ($this->attachment->filename) {
// Locally-uploaded HTML. Scrub and display inline.
$this->showHtmlFile($this->attachment);
break;
}
// Fall through to default.
default:
Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
}
} else {
Event::handle('ShowUnsupportedAttachmentRepresentation', array($this->out, $this->attachment));
}
}
Event::handle('EndShowAttachmentRepresentation', array($this->out, $this->attachment));
}
protected function showHtmlFile(File $attachment)
{
$body = $this->scrubHtmlFile($attachment);
if ($body) {
$this->out->raw($body);
}
}
/**
* @return mixed false on failure, HTML fragment string on success
*/
protected function scrubHtmlFile(File $attachment)
{
$path = File::path($attachment->filename);
if (!file_exists($path) || !is_readable($path)) {
common_log(LOG_ERR, "Missing local HTML attachment $path");
return false;
}
$raw = file_get_contents($path);
// Normalize...
$dom = new DOMDocument();
if(!$dom->loadHTML($raw)) {
common_log(LOG_ERR, "Bad HTML in local HTML attachment $path");
return false;
}
// Remove <script>s or htmlawed will dump their contents into output!
// Note: removing child nodes while iterating seems to mess things up,
// hence the double loop.
$scripts = array();
foreach ($dom->getElementsByTagName('script') as $script) {
$scripts[] = $script;
}
foreach ($scripts as $script) {
common_log(LOG_DEBUG, $script->textContent);
$script->parentNode->removeChild($script);
}
// Trim out everything outside the body...
$body = $dom->saveHTML();
$body = preg_replace('/^.*<body[^>]*>/is', '', $body);
$body = preg_replace('/<\/body[^>]*>.*$/is', '', $body);
require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
$config = array('safe' => 1,
'deny_attribute' => 'id,style,on*',
'comment' => 1); // remove comments
$scrubbed = htmLawed($body, $config);
return $scrubbed;
}
}

139
lib/attachmentlistitem.php Normal file
View File

@ -0,0 +1,139 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* widget for displaying a list of notice attachments
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category UI
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2008 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* widget for displaying a single notice
*
* This widget has the core smarts for showing a single notice: what to display,
* where, and under which circumstances. Its key method is show(); this is a recipe
* that calls all the other show*() methods to build up a single notice. The
* ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
* author info (since that's implicit by the data in the page).
*
* @category UI
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
* @see NoticeList
* @see ProfileNoticeListItem
*/
class AttachmentListItem extends Widget
{
/** The attachment this item will show. */
var $attachment = null;
/**
* @param File $attachment the attachment we will display
*/
function __construct(File $attachment, $out=null)
{
parent::__construct($out);
$this->attachment = $attachment;
}
function title() {
return $this->attachment->title ?: $this->attachment->filename;
}
function linkTitle() {
return $this->title();
}
/**
* recipe function for displaying a single notice.
*
* This uses all the other methods to correctly display a notice. Override
* it or one of the others to fine-tune the output.
*
* @return void
*/
function show()
{
$this->showStart();
$this->showNoticeAttachment();
$this->showEnd();
}
function linkAttr() {
return array('class' => 'attachment',
'href' => $this->attachment->url,
'id' => 'attachment-' . $this->attachment->id,
'title' => $this->linkTitle());
}
function showLink() {
$this->out->elementStart('a', $this->linkAttr());
$this->out->element('span', null, $this->linkTitle());
$this->showRepresentation();
$this->out->elementEnd('a');
}
function showNoticeAttachment()
{
$this->showLink();
}
function showRepresentation() {
try {
$thumb = $this->attachment->getThumbnail();
$this->out->element('img', array('alt' => '', 'src' => $thumb->getUrl(), 'width' => $thumb->width, 'height' => $thumb->height));
} catch (UnsupportedMediaException $e) {
// Image representation unavailable
}
}
/**
* start a single notice.
*
* @return void
*/
function showStart()
{
// XXX: RDFa
// TODO: add notice_type class e.g., notice_video, notice_image
$this->out->elementStart('li');
}
/**
* finish the notice
*
* Close the last elements in the notice list item
*
* @return void
*/
function showEnd()
{
$this->out->elementEnd('li');
}
}