GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[Oembed] Refactoring and some improvements (namely documentation)

Browse Source 
Imported some changes from postActiv
This commit is contained in:
Diogo Cordeiro 2018-07-18 05:31:24 +01:00
parent d705bcbd98
commit 01b5118c6f
9 changed files with 536 additions and 237 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

266
plugins/Oembed/OembedPlugin.php
View File

@ -1,7 +1,40 @@
<?php <?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
if (!defined('GNUSOCIAL')) { exit(1); } /**
* OembedPlugin implementation for GNU social
*
* @package GNUsocial
* @author Stephen Paul Weber
* @author hannes
* @author Mikael Nordfeldth
* @author Diogo Cordeiro <diogo@fc.up.pt>
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/**
* Base class for the oEmbed plugin that does most of the heavy lifting to get
* and display representations for remote content.
*
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class OembedPlugin extends Plugin class OembedPlugin extends Plugin
{ {
const PLUGIN_VERSION = '2.0.0'; const PLUGIN_VERSION = '2.0.0';
@ -17,7 +50,11 @@ class OembedPlugin extends Plugin
protected $imgData = array(); protected $imgData = array();
// these should be declared protected everywhere /**
* Initialize the oEmbed plugin and set up the environment it needs for it.
* Returns true if it initialized properly, the exception object if it
* doesn't.
*/
public function initialize() public function initialize()
{ {
parent::initialize(); parent::initialize();
@ -25,6 +62,12 @@ class OembedPlugin extends Plugin
$this->domain_whitelist = array_merge($this->domain_whitelist, $this->append_whitelist); $this->domain_whitelist = array_merge($this->domain_whitelist, $this->append_whitelist);
} }
/**
* The code executed on GNU social checking the database schema, which in
* this case is to make sure we have the plugin table we need.
*
* @return bool true if it ran successfully, the exception object if it doesn't.
*/
public function onCheckSchema() public function onCheckSchema()
{ {
$schema = Schema::get(); $schema = Schema::get();
@ -32,11 +75,28 @@ class OembedPlugin extends Plugin
return true; return true;
} }
/**
* This code executes when GNU social creates the page routing, and we hook
* on this event to add our action handler for oEmbed.
*
* @param $m URLMapper the router that was initialized.
* @return bool true if successful, the exception object if it isn't.
*/
public function onRouterInitialized(URLMapper $m) public function onRouterInitialized(URLMapper $m)
{ {
$m->connect('main/oembed', array('action' => 'oembed')); $m->connect('main/oembed', array('action' => 'oembed'));
} }
/**
* This event executes when GNU social encounters a remote URL we then decide
* to interrogate for metadata. oEmbed gloms onto it to see if we have an
* oEmbed endpoint or image to try to represent in the post.
*
* @param $url string the remote URL we're looking at
* @param $dom DOMDocument the document we're getting metadata from
* @param $metadata stdClass class representing the metadata
* @return bool true if successful, the exception object if it isn't.
*/
public function onGetRemoteUrlMetadataFromDom($url, DOMDocument $dom, stdClass &$metadata) public function onGetRemoteUrlMetadataFromDom($url, DOMDocument $dom, stdClass &$metadata)
{ {
try { try {
@ -70,6 +130,7 @@ class OembedPlugin extends Plugin
} }
} }
} catch (Exception $e) { } catch (Exception $e) {
// FIXME - make sure the error was because we couldn't get metadata, not something else! -mb
common_log(LOG_INFO, 'Could not find an oEmbed endpoint using link headers, trying OpenGraph from HTML.'); common_log(LOG_INFO, 'Could not find an oEmbed endpoint using link headers, trying OpenGraph from HTML.');
// Just ignore it! // Just ignore it!
$metadata = OpenGraphHelper::ogFromHtml($dom); $metadata = OpenGraphHelper::ogFromHtml($dom);
@ -89,8 +150,10 @@ class OembedPlugin extends Plugin
if ($metadata->thumbnail_url == 'https://s0.wp.com/i/blank.jpg') { if ($metadata->thumbnail_url == 'https://s0.wp.com/i/blank.jpg') {
unset($metadata->thumbnail_url); unset($metadata->thumbnail_url);
} }
}
// FIXME: this is also true of locally-installed wordpress so we should watch out for that.
}
return true;
} }
public function onEndShowHeadElements(Action $action) public function onEndShowHeadElements(Action $action)
@ -103,8 +166,11 @@ class OembedPlugin extends Plugin
'oembed', 'oembed',
array(), array(),
array('format'=>'json', 'url'=> array('format'=>'json', 'url'=>
common_local_url('attachment', common_local_url(
array('attachment' => $action->attachment->getID())))), 'attachment',
array('attachment' => $action->attachment->getID())
))
),
'title'=>'oEmbed')); 'title'=>'oEmbed'));
$action->element('link', array('rel'=>'alternate', $action->element('link', array('rel'=>'alternate',
'type'=>'text/xml+oembed', 'type'=>'text/xml+oembed',
@ -112,8 +178,11 @@ class OembedPlugin extends Plugin
'oembed', 'oembed',
array(), array(),
array('format'=>'xml','url'=> array('format'=>'xml','url'=>
common_local_url('attachment', common_local_url(
array('attachment' => $action->attachment->getID())))), 'attachment',
array('attachment' => $action->attachment->getID())
))
),
'title'=>'oEmbed')); 'title'=>'oEmbed'));
break; break;
case 'shownotice': case 'shownotice':
@ -126,14 +195,16 @@ class OembedPlugin extends Plugin
'href'=>common_local_url( 'href'=>common_local_url(
'oembed', 'oembed',
array(), array(),
array('format'=>'json','url'=>$action->notice->getUrl())), array('format'=>'json','url'=>$action->notice->getUrl())
),
'title'=>'oEmbed')); 'title'=>'oEmbed'));
$action->element('link', array('rel'=>'alternate', $action->element('link', array('rel'=>'alternate',
'type'=>'text/xml+oembed', 'type'=>'text/xml+oembed',
'href'=>common_local_url( 'href'=>common_local_url(
'oembed', 'oembed',
array(), array(),
array('format'=>'xml','url'=>$action->notice->getUrl())), array('format'=>'xml','url'=>$action->notice->getUrl())
),
'title'=>'oEmbed')); 'title'=>'oEmbed'));
} catch (InvalidUrlException $e) { } catch (InvalidUrlException $e) {
// The notice is probably a share or similar, which don't // The notice is probably a share or similar, which don't
@ -145,7 +216,8 @@ class OembedPlugin extends Plugin
return true; return true;
} }
public function onEndShowStylesheets(Action $action) { public function onEndShowStylesheets(Action $action)
{
$action->cssLink($this->path('css/oembed.css')); $action->cssLink($this->path('css/oembed.css'));
return true; return true;
} }
@ -170,7 +242,6 @@ class OembedPlugin extends Plugin
if (isset($file->mimetype) if (isset($file->mimetype)
&& (('text/html' === substr($file->mimetype, 0, 9) && (('text/html' === substr($file->mimetype, 0, 9)
|| 'application/xhtml+xml' === substr($file->mimetype, 0, 21)))) { || 'application/xhtml+xml' === substr($file->mimetype, 0, 21)))) {
try { try {
$oembed_data = File_oembed::_getOembed($file->url); $oembed_data = File_oembed::_getOembed($file->url);
if ($oembed_data === false) { if ($oembed_data === false) {
@ -199,9 +270,12 @@ class OembedPlugin extends Plugin
if (empty($oembed->author_url)) { if (empty($oembed->author_url)) {
$out->text($oembed->author_name); $out->text($oembed->author_name);
} else { } else {
$out->element('a', array('href' => $oembed->author_url, $out->element(
'a',
array('href' => $oembed->author_url,
'class' => 'url'), 'class' => 'url'),
$oembed->author_name); $oembed->author_name
);
} }
} }
if (!empty($oembed->provider)) { if (!empty($oembed->provider)) {
@ -209,9 +283,12 @@ class OembedPlugin extends Plugin
if (empty($oembed->provider_url)) { if (empty($oembed->provider_url)) {
$out->text($oembed->provider); $out->text($oembed->provider);
} else { } else {
$out->element('a', array('href' => $oembed->provider_url, $out->element(
'a',
array('href' => $oembed->provider_url,
'class' => 'url'), 'class' => 'url'),
$oembed->provider); $oembed->provider
);
} }
} }
$out->elementEnd('div'); $out->elementEnd('div');
@ -318,13 +395,23 @@ class OembedPlugin extends Plugin
$out->raw($purifier->purify($oembed->html)); $out->raw($purifier->purify($oembed->html));
} }
return false; return false;
break;
} }
return true; return true;
} }
public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null) /**
* This event executes when GNU social is creating a file thumbnail entry in
* the database. We glom onto this to create proper information for oEmbed
* object thumbnails.
*
* @param $file File the file of the created thumbnail
* @param &$imgPath string = the path to the created thumbnail
* @return bool true if it succeeds (including non-action
* states where it isn't oEmbed data, so it doesn't mess up the event handle
* for other things hooked into it), or the exception if it fails.
*/
public function onCreateFileImageThumbnailSource(File $file, &$imgPath)
{ {
// If we are on a private node, we won't do any remote calls (just as a precaution until // If we are on a private node, we won't do any remote calls (just as a precaution until
// we can configure this from config.php for the private nodes) // we can configure this from config.php for the private nodes)
@ -341,7 +428,6 @@ class OembedPlugin extends Plugin
try { try {
// If we have proper oEmbed data, there should be an entry in the File_oembed // If we have proper oEmbed data, there should be an entry in the File_oembed
// and File_thumbnail tables respectively. If not, we're not going to do anything. // and File_thumbnail tables respectively. If not, we're not going to do anything.
$file_oembed = File_oembed::getByFile($file);
$thumbnail = File_thumbnail::byFile($file); $thumbnail = File_thumbnail::byFile($file);
} catch (NoResultException $e) { } catch (NoResultException $e) {
// Not Oembed data, or at least nothing we either can or want to use. // Not Oembed data, or at least nothing we either can or want to use.
@ -364,7 +450,7 @@ class OembedPlugin extends Plugin
} }
/** /**
* @return boolean false on no check made, provider name on success * @return bool false on no check made, provider name on success
* @throws ServerException if check is made but fails * @throws ServerException if check is made but fails
*/ */
protected function checkWhitelist($url) protected function checkWhitelist($url)
@ -383,64 +469,130 @@ class OembedPlugin extends Plugin
throw new ServerException(sprintf(_('Domain not in remote thumbnail source whitelist: %s'), $host)); throw new ServerException(sprintf(_('Domain not in remote thumbnail source whitelist: %s'), $host));
} }
/**
* Check the file size of a remote file using a HEAD request and checking
* the content-length variable returned. This isn't 100% foolproof but is
* reliable enough for our purposes.
*
* @return string|bool the file size if it succeeds, false otherwise.
*/
private function getRemoteFileSize($url)
{
try {
if (empty($url)) {
return false;
}
stream_context_set_default(array('http' => array('method' => 'HEAD')));
$head = @get_headers($url, 1);
if (gettype($head)=="array") {
$head = array_change_key_case($head);
$size = isset($head['content-length']) ? $head['content-length'] : 0;
if (!$size) {
return false;
}
} else {
return false;
}
return $size; // return formatted size
} catch (Exception $err) {
common_log(LOG_ERR, __CLASS__.': getRemoteFileSize on URL : '._ve($url).' threw exception: '.$err->getMessage());
return false;
}
}
/**
* A private helper function that uses a CURL lookup to check the mime type
* of a remote URL to see it it's an image.
*
* @return bool true if the remote URL is an image, or false otherwise.
*/
private function isRemoteImage($url)
{
if (!filter_var($url, FILTER_VALIDATE_URL)) {
common_log(LOG_ERR, "Invalid URL in OEmbed::isRemoteImage()");
return false;
}
if ($url==null) {
common_log(LOG_ERR, "URL not specified in OEmbed::isRemoteImage()");
return false;
}
try {
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_NOBODY, true);
curl_exec($curl);
$type = curl_getinfo($curl, CURLINFO_CONTENT_TYPE);
if (strpos($type, 'image') !== false) {
return true;
} else {
return false;
}
} finally {
return false;
}
}
/**
* Function to create and store a thumbnail representation of a remote image
*
* @param $thumbnail File_thumbnail object containing the file thumbnail
* @return bool true if it succeeded, the exception if it fails, or false if it
* is limited by system limits (ie the file is too large.)
*/
protected function storeRemoteFileThumbnail(File_thumbnail $thumbnail) protected function storeRemoteFileThumbnail(File_thumbnail $thumbnail)
{ {
if (!empty($thumbnail->filename) && file_exists($thumbnail->getPath())) { if (!empty($thumbnail->filename) && file_exists($thumbnail->getPath())) {
throw new AlreadyFulfilledException(sprintf('A thumbnail seems to already exist for remote file with id==%u', $thumbnail->getFileId())); throw new AlreadyFulfilledException(sprintf('A thumbnail seems to already exist for remote file with id==%u', $thumbnail->file_id));
} }
$remoteUrl = $thumbnail->getUrl(); $url = $thumbnail->getUrl();
$this->checkWhitelist($remoteUrl); $this->checkWhitelist($url);
$http = new HTTPClient(); try {
// First see if it's too large for us $isImage = $this->isRemoteImage($url);
common_debug(__METHOD__ . ': '.sprintf('Performing HEAD request for remote file id==%u to avoid unnecessarily downloading too large files. URL: %s', $thumbnail->getFileId(), $remoteUrl)); if ($isImage==true) {
$head = $http->head($remoteUrl); $max_size = common_get_preferred_php_upload_limit();
if (!$head->isOk()) { $file_size = $this->getRemoteFileSize($url);
common_log(LOG_WARNING, 'HEAD request returned HTTP failure, so we will abort now and delete the thumbnail object.'); if (($file_size!=false) && ($file_size > $max_size)) {
$thumbnail->delete(); common_debug("Went to store remote thumbnail of size " . $file_size . " but the upload limit is " . $max_size . " so we aborted.");
return false; return false;
} else {
common_debug('HEAD request returned HTTP success, so we will continue.');
} }
$remoteUrl = $head->getEffectiveUrl(); // to avoid going through redirects again }
} catch (Exception $err) {
$headers = $head->getHeader(); common_debug("Could not determine size of remote image, aborted local storage.");
$filesize = isset($headers['content-length']) ? $headers['content-length'] : null; return $err;
// FIXME: I just copied some checks from StoreRemoteMedia, maybe we should have other checks for thumbnails? Or at least embed into some class somewhere.
if (empty($filesize)) {
// file size not specified on remote server
common_debug(sprintf('%s: Ignoring remote thumbnail because we did not get a content length for thumbnail for file id==%u', __CLASS__, $thumbnail->getFileId()));
return true;
} elseif ($filesize > common_config('attachments', 'file_quota')) {
// file too big according to site configuration
common_debug(sprintf('%s: Skip downloading remote thumbnail because content length (%u) is larger than file_quota (%u) for file id==%u', __CLASS__, intval($filesize), common_config('attachments', 'file_quota'), $thumbnail->getFileId()));
return true;
} }
// Then we download the file to memory and test whether it's actually an image file // First we download the file to memory and test whether it's actually an image file
// FIXME: To support remote video/whatever files, this needs reworking. // FIXME: To support remote video/whatever files, this needs reworking.
common_debug(sprintf('Downloading remote thumbnail for file id==%u (should be size %u) with effective URL: %s', $thumbnail->getFileId(), $filesize, _ve($remoteUrl))); common_debug(sprintf('Downloading remote thumbnail for file id==%u with thumbnail URL: %s', $thumbnail->file_id, $url));
$imgData = HTTPClient::quickGet($remoteUrl); $imgData = HTTPClient::quickGet($url);
$info = @getimagesizefromstring($imgData); $info = @getimagesizefromstring($imgData);
if ($info === false) { if ($info === false) {
throw new UnsupportedMediaException(_('Remote file format was not identified as an image.'), $remoteUrl); throw new UnsupportedMediaException(_('Remote file format was not identified as an image.'), $url);
} elseif (!$info[0] || !$info[1]) { } elseif (!$info[0] || !$info[1]) {
throw new UnsupportedMediaException(_('Image file had impossible geometry (0 width or height)')); throw new UnsupportedMediaException(_('Image file had impossible geometry (0 width or height)'));
} }
$ext = File::guessMimeExtension($info['mime']); $ext = File::guessMimeExtension($info['mime']);
try {
$filename = sprintf('oembed-%d.%s', $thumbnail->getFileId(), $ext); $filename = sprintf('oembed-%d.%s', $thumbnail->getFileId(), $ext);
$fullpath = File_thumbnail::path($filename); $fullpath = File_thumbnail::path($filename);
// Write the file to disk. Throw Exception on failure // Write the file to disk. Throw Exception on failure
if (!file_exists($fullpath) && file_put_contents($fullpath, $imgData) === false) { if (!file_exists($fullpath) && file_put_contents($fullpath, $imgData) === false) {
throw new ServerException(_('Could not write downloaded file to disk.')); throw new ServerException(_('Could not write downloaded file to disk.'));
} }
// Get rid of the file from memory } catch (Exception $err) {
common_log(LOG_ERROR, "Went to write a thumbnail to disk in OembedPlugin::storeRemoteThumbnail but encountered error: {$err}");
return $err;
} finally {
unset($imgData); unset($imgData);
}
try {
// Updated our database for the file record // Updated our database for the file record
$orig = clone($thumbnail); $orig = clone($thumbnail);
$thumbnail->filename = $filename; $thumbnail->filename = $filename;
@ -448,14 +600,26 @@ class OembedPlugin extends Plugin
$thumbnail->height = $info[1]; // https://php.net/manual/en/function.getimagesize.php $thumbnail->height = $info[1]; // https://php.net/manual/en/function.getimagesize.php
// Throws exception on failure. // Throws exception on failure.
$thumbnail->updateWithKeys($orig); $thumbnail->updateWithKeys($orig);
} catch (exception $err) {
common_log(LOG_ERROR, "Went to write a thumbnail entry to the database in OembedPlugin::storeRemoteThumbnail but encountered error: ".$err);
return $err;
}
return true;
} }
/**
* Event raised when GNU social polls the plugin for information about it.
* Adds this plugin's version information to $versions array
*
* @param &$versions array inherited from parent
* @return bool true hook value
*/
public function onPluginVersion(array &$versions) public function onPluginVersion(array &$versions)
{ {
$versions[] = array('name' => 'Oembed', $versions[] = array('name' => 'Oembed',
'version' => self::PLUGIN_VERSION, 'version' => self::PLUGIN_VERSION,
'author' => 'Mikael Nordfeldth', 'author' => 'Mikael Nordfeldth',
'homepage' => 'http://gnu.io/', 'homepage' => 'http://gnu.io/social/',
'description' => 'description' =>
// TRANS: Plugin description. // TRANS: Plugin description.
_m('Plugin for using and representing Oembed data.')); _m('Plugin for using and representing Oembed data.'));

67
plugins/Oembed/actions/oembed.php
View File

@ -1,42 +1,41 @@
<?php <?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/** /**
* StatusNet, the distributed open-source microblogging tool * OembedPlugin implementation for GNU social
* *
* oEmbed data action for /main/oembed(.xml|.json) requests * @package GNUsocial
* * @author Craig Andrews <candrews@integralblue.com>
* PHP version 5 * @author Mikael Nordfeldth <mmn@hethane.se>
* * @author hannes
* LICENCE: This program is free software: you can redistribute it and/or modify * @author Diogo Cordeiro <diogo@fc.up.pt>
* it under the terms of the GNU Affero General Public License as published by * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* the Free Software Foundation, either version 3 of the License, or * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
* (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/>.
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } defined('GNUSOCIAL') || die();
/** /**
* Oembed provider implementation * Oembed provider implementation
* *
* This class handles all /main/oembed(.xml|.json)/ requests. * This class handles all /main/oembed(.xml|.json)/ requests.
* *
* @category oEmbed * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @package GNUsocial * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
* @author Craig Andrews <candrews@integralblue.com>
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2008 StatusNet, Inc.
* @copyright 2014 Free Software Foundation, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/ */
class OembedAction extends Action class OembedAction extends Action
{ {
protected function handle() protected function handle()
@ -75,9 +74,11 @@ class OembedAction extends Action
$profile = $notice->getProfile(); $profile = $notice->getProfile();
$authorname = $profile->getFancyName(); $authorname = $profile->getFancyName();
// TRANS: oEmbed title. %1$s is the author name, %2$s is the creation date. // TRANS: oEmbed title. %1$s is the author name, %2$s is the creation date.
$oembed['title'] = sprintf(_('%1$s\'s status on %2$s'), $oembed['title'] = sprintf(
_('%1$s\'s status on %2$s'),
$authorname, $authorname,
common_exact_date($notice->created)); common_exact_date($notice->created)
);
$oembed['author_name']=$authorname; $oembed['author_name']=$authorname;
$oembed['author_url']=$profile->profileurl; $oembed['author_url']=$profile->profileurl;
$oembed['url']=$notice->getUrl(); $oembed['url']=$notice->getUrl();
@ -149,8 +150,10 @@ class OembedAction extends Action
} }
} else { } else {
$oembed['type']='link'; $oembed['type']='link';
$oembed['url']=common_local_url('attachment', $oembed['url']=common_local_url(
array('attachment' => $attachment->id)); 'attachment',
array('attachment' => $attachment->id)
);
} }
if ($attachment->title) { if ($attachment->title) {
$oembed['title']=$attachment->title; $oembed['title']=$attachment->title;
@ -244,7 +247,7 @@ class OembedAction extends Action
* *
* @return boolean is read only action? * @return boolean is read only action?
*/ */
function isReadOnly($args) public function isReadOnly($args)
{ {
return true; return true;
} }

96
plugins/Oembed/classes/File_oembed.php
View File

@ -1,28 +1,38 @@
<?php <?php
/* // This file is part of GNU social - https://www.gnu.org/software/social
* StatusNet - the distributed open-source microblogging tool //
* Copyright (C) 2008, 2009, StatusNet, Inc. // GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* OembedPlugin implementation for GNU social
* *
* This program is free software: you can redistribute it and/or modify * @package GNUsocial
* it under the terms of the GNU Affero General Public License as published by * @author Stephen Paul Weber
* the Free Software Foundation, either version 3 of the License, or * @author Mikael Nordfeldth
* (at your option) any later version. * @author Diogo Cordeiro <diogo@fc.up.pt>
* * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* This program is distributed in the hope that it will be useful, * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
* 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/>.
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } defined('GNUSOCIAL') || die();
/** /**
* Table Definition for file_oembed * Table Definition for file_oembed
*
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/ */
class File_oembed extends Managed_DataObject class File_oembed extends Managed_DataObject
{ {
public $__table = 'file_oembed'; // table name public $__table = 'file_oembed'; // table name
@ -67,7 +77,8 @@ class File_oembed extends Managed_DataObject
); );
} }
static function _getOembed($url) { public static function _getOembed($url)
{
try { try {
return oEmbedHelper::getObject($url); return oEmbedHelper::getObject($url);
} catch (Exception $e) { } catch (Exception $e) {
@ -79,7 +90,8 @@ class File_oembed extends Managed_DataObject
/** /**
* Fetch an entry by using a File's id * Fetch an entry by using a File's id
*/ */
static function getByFile(File $file) { public static function getByFile(File $file)
{
$fo = new File_oembed(); $fo = new File_oembed();
$fo->file_id = $file->id; $fo->file_id = $file->id;
if (!$fo->find(true)) { if (!$fo->find(true)) {
@ -99,7 +111,8 @@ class File_oembed extends Managed_DataObject
* @param object $data Services_oEmbed_Object_* * @param object $data Services_oEmbed_Object_*
* @param int $file_id * @param int $file_id
*/ */
public static function saveNew($data, $file_id) { public static function saveNew($data, $file_id)
{
$file_oembed = new File_oembed; $file_oembed = new File_oembed;
$file_oembed->file_id = $file_id; $file_oembed->file_id = $file_id;
if (!isset($data->version)) { if (!isset($data->version)) {
@ -107,15 +120,33 @@ class File_oembed extends Managed_DataObject
} }
$file_oembed->version = $data->version; $file_oembed->version = $data->version;
$file_oembed->type = $data->type; $file_oembed->type = $data->type;
if (!empty($data->provider_name)) $file_oembed->provider = $data->provider_name; if (!empty($data->provider_name)) {
if (!empty($data->provider)) $file_oembed->provider = $data->provider; $file_oembed->provider = $data->provider_name;
if (!empty($data->provider_url)) $file_oembed->provider_url = $data->provider_url; }
if (!empty($data->width)) $file_oembed->width = intval($data->width); if (!empty($data->provider)) {
if (!empty($data->height)) $file_oembed->height = intval($data->height); $file_oembed->provider = $data->provider;
if (!empty($data->html)) $file_oembed->html = $data->html; }
if (!empty($data->title)) $file_oembed->title = $data->title; if (!empty($data->provider_url)) {
if (!empty($data->author_name)) $file_oembed->author_name = $data->author_name; $file_oembed->provider_url = $data->provider_url;
if (!empty($data->author_url)) $file_oembed->author_url = $data->author_url; }
if (!empty($data->width)) {
$file_oembed->width = intval($data->width);
}
if (!empty($data->height)) {
$file_oembed->height = intval($data->height);
}
if (!empty($data->html)) {
$file_oembed->html = $data->html;
}
if (!empty($data->title)) {
$file_oembed->title = $data->title;
}
if (!empty($data->author_name)) {
$file_oembed->author_name = $data->author_name;
}
if (!empty($data->author_url)) {
$file_oembed->author_url = $data->author_url;
}
if (!empty($data->url)) { if (!empty($data->url)) {
$file_oembed->url = $data->url; $file_oembed->url = $data->url;
$given_url = File_redirection::_canonUrl($file_oembed->url); $given_url = File_redirection::_canonUrl($file_oembed->url);
@ -139,8 +170,11 @@ class File_oembed extends Managed_DataObject
if (!empty($data->thumbnail_url) || ($data->type == 'photo')) { if (!empty($data->thumbnail_url) || ($data->type == 'photo')) {
$ft = File_thumbnail::getKV('file_id', $file_id); $ft = File_thumbnail::getKV('file_id', $file_id);
if ($ft instanceof File_thumbnail) { if ($ft instanceof File_thumbnail) {
common_log(LOG_WARNING, "Strangely, a File_thumbnail object exists for new file $file_id", common_log(
__FILE__); LOG_WARNING,
"Strangely, a File_thumbnail object exists for new file $file_id",
__FILE__
);
} else { } else {
File_thumbnail::saveNew($data, $file_id); File_thumbnail::saveNew($data, $file_id);
} }

58
plugins/Oembed/lib/oembedhelper.php
View File

@ -1,24 +1,31 @@
<?php <?php
/* // This file is part of GNU social - https://www.gnu.org/software/social
* StatusNet - the distributed open-source microblogging tool //
* Copyright (C) 2008-2010, StatusNet, Inc. // GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* OembedPlugin implementation for GNU social
* *
* This program is free software: you can redistribute it and/or modify * @package GNUsocial
* it under the terms of the GNU Affero General Public License as published by * @author Mikael Nordfeldth
* the Free Software Foundation, either version 3 of the License, or * @author hannes
* (at your option) any later version. * @author Diogo Cordeiro <diogo@fc.up.pt>
* * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* This program is distributed in the hope that it will be useful, * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
* 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/>.
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } defined('GNUSOCIAL') || die();
/** /**
* Utility class to wrap basic oEmbed lookups. * Utility class to wrap basic oEmbed lookups.
@ -35,6 +42,9 @@ if (!defined('GNUSOCIAL')) { exit(1); }
* Others will fall back to oohembed (unless disabled). * Others will fall back to oohembed (unless disabled).
* The API endpoint can be configured or disabled through config * The API endpoint can be configured or disabled through config
* as 'oohembed'/'endpoint'. * as 'oohembed'/'endpoint'.
*
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/ */
class oEmbedHelper class oEmbedHelper
{ {
@ -93,7 +103,9 @@ class oEmbedHelper
$utf8_evidence = false; $utf8_evidence = false;
$unicode_check_dom = new DOMDocument(); $unicode_check_dom = new DOMDocument();
$ok = $unicode_check_dom->loadHTML($body); $ok = $unicode_check_dom->loadHTML($body);
if (!$ok) throw new oEmbedHelper_BadHtmlException(); if (!$ok) {
throw new oEmbedHelper_BadHtmlException();
}
$metaNodes = $unicode_check_dom->getElementsByTagName('meta'); $metaNodes = $unicode_check_dom->getElementsByTagName('meta');
foreach ($metaNodes as $metaNode) { foreach ($metaNodes as $metaNode) {
// case in-sensitive since Content-type and utf-8 can be written in many ways // case in-sensitive since Content-type and utf-8 can be written in many ways
@ -139,7 +151,7 @@ class oEmbedHelper
* @param string $body HTML body text * @param string $body HTML body text
* @return mixed string with URL or false if no target found * @return mixed string with URL or false if no target found
*/ */
static function oEmbedEndpointFromHTML(DOMDocument $dom) public static function oEmbedEndpointFromHTML(DOMDocument $dom)
{ {
// Ok... now on to the links! // Ok... now on to the links!
$feeds = array( $feeds = array(
@ -184,7 +196,7 @@ class oEmbedHelper
* @param array $params * @param array $params
* @return object * @return object
*/ */
static function getOembedFrom($api, $url, $params=array()) public static function getOembedFrom($api, $url, $params=array())
{ {
if (empty($api)) { if (empty($api)) {
// TRANS: Server exception thrown in oEmbed action if no API endpoint is available. // TRANS: Server exception thrown in oEmbed action if no API endpoint is available.
@ -211,7 +223,7 @@ class oEmbedHelper
* @param object $orig * @param object $orig
* @return object * @return object
*/ */
static function normalize(stdClass $data) public static function normalize(stdClass $data)
{ {
if (empty($data->type)) { if (empty($data->type)) {
throw new Exception('Invalid oEmbed data: no type field.'); throw new Exception('Invalid oEmbed data: no type field.');
@ -243,7 +255,7 @@ class oEmbedHelper_Exception extends Exception
class oEmbedHelper_BadHtmlException extends oEmbedHelper_Exception class oEmbedHelper_BadHtmlException extends oEmbedHelper_Exception
{ {
function __construct($previous=null) public function __construct($previous=null)
{ {
return parent::__construct('Bad HTML in discovery data.', 0, $previous); return parent::__construct('Bad HTML in discovery data.', 0, $previous);
} }
@ -251,7 +263,7 @@ class oEmbedHelper_BadHtmlException extends oEmbedHelper_Exception
class oEmbedHelper_DiscoveryException extends oEmbedHelper_Exception class oEmbedHelper_DiscoveryException extends oEmbedHelper_Exception
{ {
function __construct($previous=null) public function __construct($previous=null)
{ {
return parent::__construct('No oEmbed discovery data.', 0, $previous); return parent::__construct('No oEmbed discovery data.', 0, $previous);
} }

31
plugins/Oembed/lib/opengraphhelper.php
View File

@ -1,10 +1,36 @@
<?php <?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
if (!defined('GNUSOCIAL')) { exit(1); } /**
* OembedPlugin implementation for GNU social
*
* @package GNUsocial
* @author Mikael Nordfeldth
* @author Diogo Cordeiro <diogo@fc.up.pt>
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/** /**
* Utility class to get OpenGraph data from HTML DOMs etc. * Utility class to get OpenGraph data from HTML DOMs etc.
*
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/ */
class OpenGraphHelper class OpenGraphHelper
{ {
@ -26,7 +52,8 @@ class OpenGraphHelper
'/^image/' => 'photo', '/^image/' => 'photo',
]; ];
static function ogFromHtml(DOMDocument $dom) { public static function ogFromHtml(DOMDocument $dom)
{
$obj = new stdClass(); $obj = new stdClass();
$obj->version = '1.0'; // fake it til u make it $obj->version = '1.0'; // fake it til u make it

6
plugins/Oembed/locale/Oembed.pot
View File

@ -8,7 +8,7 @@ msgid ""
msgstr "" msgstr ""
"Project-Id-Version: PACKAGE VERSION\n" "Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n" "Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2019-06-08 18:20+0100\n" "POT-Creation-Date: 2019-06-10 00:39+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n" "Language-Team: LANGUAGE <LL@li.org>\n"
@ -18,12 +18,12 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n" "Content-Transfer-Encoding: 8bit\n"
#. TRANS: Plugin description. #. TRANS: Plugin description.
#: OembedPlugin.php:461 #: OembedPlugin.php:721
msgid "Plugin for using and representing Oembed data." msgid "Plugin for using and representing Oembed data."
msgstr "" msgstr ""
#. TRANS: Exception. %s is the URL we tried to GET. #. TRANS: Exception. %s is the URL we tried to GET.
#: lib/oembedhelper.php:83 #: lib/oembedhelper.php:93
#, php-format #, php-format
msgid "Could not GET URL %s." msgid "Could not GET URL %s."
msgstr "" msgstr ""

48
plugins/Oembed/scripts/fixup_files.php
View File

@ -1,24 +1,33 @@
#!/usr/bin/env php #!/usr/bin/env php
<?php <?php
/* // This file is part of GNU social - https://www.gnu.org/software/social
* StatusNet - a distributed open-source microblogging tool //
* Copyright (C) 2010 StatusNet, Inc. // GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* OembedPlugin implementation for GNU social
* *
* This program is free software: you can redistribute it and/or modify * @package GNUsocial
* it under the terms of the GNU Affero General Public License as published by * @author Mikael Nordfeldth
* the Free Software Foundation, either version 3 of the License, or * @author Diogo Cordeiro <diogo@fc.up.pt>
* (at your option) any later version. * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
* 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/>.
*/ */
define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..')); defined('GNUSOCIAL') || die();
define('INSTALLDIR', realpath(__DIR__ . '/../../..'));
$longoptions = array('dry-run'); $longoptions = array('dry-run');
@ -54,10 +63,12 @@ while ($f->fetch()) {
} }
} else { } else {
// NULL out the mime/title/size/protected fields // NULL out the mime/title/size/protected fields
$sql = sprintf("UPDATE file " . $sql = sprintf(
"UPDATE file " .
"SET mimetype=null,title=null,size=null,protected=null " . "SET mimetype=null,title=null,size=null,protected=null " .
"WHERE id=%d", "WHERE id=%d",
$f->id); $f->id
);
$f->query($sql); $f->query($sql);
$f->decache(); $f->decache();
@ -71,4 +82,3 @@ while ($f->fetch()) {
} }
echo "done.\n"; echo "done.\n";

28
plugins/Oembed/scripts/poll_oembed.php
View File

@ -1,7 +1,33 @@
#!/usr/bin/env php #!/usr/bin/env php
<?php <?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..')); /**
* OembedPlugin implementation for GNU social
*
* @package GNUsocial
* @author Mikael Nordfeldth
* @author Diogo Cordeiro <diogo@fc.up.pt>
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
define('INSTALLDIR', realpath(__DIR__ . '/../../..'));
$shortoptions = 'u:'; $shortoptions = 'u:';
$longoptions = array('url='); $longoptions = array('url=');

41
plugins/Oembed/tests/oEmbedTest.php
View File

@ -1,11 +1,35 @@
<?php <?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* OembedPlugin implementation for GNU social
*
* @package GNUsocial
* @author Mikael Nordfeldth
* @author Diogo Cordeiro <diogo@fc.up.pt>
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) { if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
print "This script must be run from the command line\n"; print "This script must be run from the command line\n";
exit(); exit();
} }
define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..')); define('INSTALLDIR', realpath(__DIR__ . '/../../..'));
define('GNUSOCIAL', true); define('GNUSOCIAL', true);
define('STATUSNET', true); // compatibility define('STATUSNET', true); // compatibility
@ -13,7 +37,6 @@ require_once INSTALLDIR . '/lib/common.php';
class oEmbedTest extends PHPUnit_Framework_TestCase class oEmbedTest extends PHPUnit_Framework_TestCase
{ {
public function setup() public function setup()
{ {
$this->old_ohembed = common_config('ohembed', 'endpoint'); $this->old_ohembed = common_config('ohembed', 'endpoint');
@ -51,10 +74,11 @@ class oEmbedTest extends PHPUnit_Framework_TestCase
* *
* @return string * @return string
*/ */
function _endpoint() public function _endpoint()
{ {
$default = array(); $default = array();
$_server = 'localhost'; $_path = ''; $_server = 'localhost';
$_path = '';
require INSTALLDIR . '/lib/default.php'; require INSTALLDIR . '/lib/default.php';
return $default['oembed']['endpoint']; return $default['oembed']['endpoint'];
} }
@ -65,7 +89,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase
* @param string $url * @param string $url
* @param string $expectedType * @param string $expectedType
*/ */
function _doTest($url, $expectedType) public function _doTest($url, $expectedType)
{ {
try { try {
$data = oEmbedHelper::getObject($url); $data = oEmbedHelper::getObject($url);
@ -95,7 +119,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase
* Sample oEmbed targets for sites we know ourselves... * Sample oEmbed targets for sites we know ourselves...
* @return array * @return array
*/ */
static public function knownSources() public static function knownSources()
{ {
$sources = array( $sources = array(
array('https://www.flickr.com/photos/brionv/5172500179/', 'photo'), array('https://www.flickr.com/photos/brionv/5172500179/', 'photo'),
@ -109,7 +133,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase
* *
* @return array * @return array
*/ */
static public function discoverableSources() public static function discoverableSources()
{ {
$sources = array( $sources = array(
@ -128,9 +152,8 @@ class oEmbedTest extends PHPUnit_Framework_TestCase
* *
* @return array * @return array
*/ */
static public function fallbackSources() public static function fallbackSources()
{ {
$sources = array( $sources = array(
array('https://github.com/git/git/commit/85e9c7e1d42849c5c3084a9da748608468310c0e', 'Github Commit'), // @fixme in future there may be a native provider -- will change to 'photo' array('https://github.com/git/git/commit/85e9c7e1d42849c5c3084a9da748608468310c0e', 'Github Commit'), // @fixme in future there may be a native provider -- will change to 'photo'
); );