From 01b5118c6f61f5cd38776b91feff931a0b7a32e9 Mon Sep 17 00:00:00 2001 From: Diogo Cordeiro Date: Wed, 18 Jul 2018 05:31:24 +0100 Subject: [PATCH] [Oembed] Refactoring and some improvements (namely documentation) Imported some changes from postActiv --- plugins/Oembed/OembedPlugin.php | 330 ++++++++++++++++++------- plugins/Oembed/actions/oembed.php | 83 ++++--- plugins/Oembed/classes/File_oembed.php | 100 +++++--- plugins/Oembed/lib/oembedhelper.php | 102 ++++---- plugins/Oembed/lib/opengraphhelper.php | 31 ++- plugins/Oembed/locale/Oembed.pot | 6 +- plugins/Oembed/scripts/fixup_files.php | 50 ++-- plugins/Oembed/scripts/poll_oembed.php | 28 ++- plugins/Oembed/tests/oEmbedTest.php | 43 +++- 9 files changed, 536 insertions(+), 237 deletions(-) diff --git a/plugins/Oembed/OembedPlugin.php b/plugins/Oembed/OembedPlugin.php index d70f79e59f..9230abdb01 100644 --- a/plugins/Oembed/OembedPlugin.php +++ b/plugins/Oembed/OembedPlugin.php @@ -1,7 +1,40 @@ . -if (!defined('GNUSOCIAL')) { exit(1); } +/** + * OembedPlugin implementation for GNU social + * + * @package GNUsocial + * @author Stephen Paul Weber + * @author hannes + * @author Mikael Nordfeldth + * @author Diogo Cordeiro + * @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 { const PLUGIN_VERSION = '2.0.0'; @@ -12,12 +45,16 @@ class OembedPlugin extends Plugin '^i\d*\.ytimg\.com$' => 'YouTube', '^i\d*\.vimeocdn\.com$' => 'Vimeo', ); - public $append_whitelist = array(); // fill this array as domain_whitelist to add more trusted sources + public $append_whitelist = array(); // fill this array as domain_whitelist to add more trusted sources public $check_whitelist = false; // security/abuse precaution 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() { parent::initialize(); @@ -25,6 +62,12 @@ class OembedPlugin extends Plugin $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() { $schema = Schema::get(); @@ -32,11 +75,28 @@ class OembedPlugin extends Plugin 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) { $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) { try { @@ -48,20 +108,20 @@ class OembedPlugin extends Plugin 'maxheight' => common_config('thumbnail', 'height'), ); $metadata = oEmbedHelper::getOembedFrom($api, $url, $params); - - // Facebook just gives us javascript in its oembed html, + + // Facebook just gives us javascript in its oembed html, // so use the content of the title element instead - if(strpos($url,'https://www.facebook.com/') === 0) { - $metadata->html = @$dom->getElementsByTagName('title')->item(0)->nodeValue; + if (strpos($url, 'https://www.facebook.com/') === 0) { + $metadata->html = @$dom->getElementsByTagName('title')->item(0)->nodeValue; } - + // Wordpress sometimes also just gives us javascript, use og:description if it is available $xpath = new DomXpath($dom); $generatorNode = @$xpath->query('//meta[@name="generator"][1]')->item(0); if ($generatorNode instanceof DomElement) { // when wordpress only gives us javascript, the html stripped from tags // is the same as the title, so this helps us to identify this (common) case - if(strpos($generatorNode->getAttribute('content'),'WordPress') === 0 + if (strpos($generatorNode->getAttribute('content'), 'WordPress') === 0 && trim(strip_tags($metadata->html)) == trim($metadata->title)) { $propertyNode = @$xpath->query('//meta[@property="og:description"][1]')->item(0); if ($propertyNode instanceof DomElement) { @@ -70,6 +130,7 @@ class OembedPlugin extends Plugin } } } 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.'); // Just ignore it! $metadata = OpenGraphHelper::ogFromHtml($dom); @@ -79,41 +140,49 @@ class OembedPlugin extends Plugin // sometimes sites serve the path, not the full URL, for images // let's "be liberal in what you accept from others"! // add protocol and host if the thumbnail_url starts with / - if(substr($metadata->thumbnail_url,0,1) == '/') { + if (substr($metadata->thumbnail_url, 0, 1) == '/') { $thumbnail_url_parsed = parse_url($metadata->url); $metadata->thumbnail_url = $thumbnail_url_parsed['scheme']."://".$thumbnail_url_parsed['host'].$metadata->thumbnail_url; } - + // some wordpress opengraph implementations sometimes return a white blank image // no need for us to save that! - 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); } - } + // FIXME: this is also true of locally-installed wordpress so we should watch out for that. + } + return true; } public function onEndShowHeadElements(Action $action) { switch ($action->getActionName()) { case 'attachment': - $action->element('link',array('rel'=>'alternate', + $action->element('link', array('rel'=>'alternate', 'type'=>'application/json+oembed', 'href'=>common_local_url( 'oembed', array(), array('format'=>'json', 'url'=> - common_local_url('attachment', - array('attachment' => $action->attachment->getID())))), + common_local_url( + 'attachment', + array('attachment' => $action->attachment->getID()) + )) + ), 'title'=>'oEmbed')); - $action->element('link',array('rel'=>'alternate', + $action->element('link', array('rel'=>'alternate', 'type'=>'text/xml+oembed', 'href'=>common_local_url( 'oembed', array(), array('format'=>'xml','url'=> - common_local_url('attachment', - array('attachment' => $action->attachment->getID())))), + common_local_url( + 'attachment', + array('attachment' => $action->attachment->getID()) + )) + ), 'title'=>'oEmbed')); break; case 'shownotice': @@ -121,19 +190,21 @@ class OembedPlugin extends Plugin break; } try { - $action->element('link',array('rel'=>'alternate', + $action->element('link', array('rel'=>'alternate', 'type'=>'application/json+oembed', 'href'=>common_local_url( 'oembed', array(), - array('format'=>'json','url'=>$action->notice->getUrl())), + array('format'=>'json','url'=>$action->notice->getUrl()) + ), 'title'=>'oEmbed')); - $action->element('link',array('rel'=>'alternate', + $action->element('link', array('rel'=>'alternate', 'type'=>'text/xml+oembed', 'href'=>common_local_url( 'oembed', array(), - array('format'=>'xml','url'=>$action->notice->getUrl())), + array('format'=>'xml','url'=>$action->notice->getUrl()) + ), 'title'=>'oEmbed')); } catch (InvalidUrlException $e) { // The notice is probably a share or similar, which don't @@ -145,7 +216,8 @@ class OembedPlugin extends Plugin return true; } - public function onEndShowStylesheets(Action $action) { + public function onEndShowStylesheets(Action $action) + { $action->cssLink($this->path('css/oembed.css')); return true; } @@ -170,7 +242,6 @@ class OembedPlugin extends Plugin if (isset($file->mimetype) && (('text/html' === substr($file->mimetype, 0, 9) || 'application/xhtml+xml' === substr($file->mimetype, 0, 21)))) { - try { $oembed_data = File_oembed::_getOembed($file->url); if ($oembed_data === false) { @@ -199,9 +270,12 @@ class OembedPlugin extends Plugin if (empty($oembed->author_url)) { $out->text($oembed->author_name); } else { - $out->element('a', array('href' => $oembed->author_url, + $out->element( + 'a', + array('href' => $oembed->author_url, 'class' => 'url'), - $oembed->author_name); + $oembed->author_name + ); } } if (!empty($oembed->provider)) { @@ -209,9 +283,12 @@ class OembedPlugin extends Plugin if (empty($oembed->provider_url)) { $out->text($oembed->provider); } else { - $out->element('a', array('href' => $oembed->provider_url, + $out->element( + 'a', + array('href' => $oembed->provider_url, 'class' => 'url'), - $oembed->provider); + $oembed->provider + ); } } $out->elementEnd('div'); @@ -249,7 +326,7 @@ class OembedPlugin extends Plugin $out->elementStart('article', ['class'=>'h-entry oembed']); $out->elementStart('header'); - try { + try { $thumb = $file->getThumbnail(128, 128); $out->element('img', $thumb->getHtmlAttrs(['class'=>'u-photo oembed'])); unset($thumb); @@ -297,7 +374,7 @@ class OembedPlugin extends Plugin return false; } - + public function onShowUnsupportedAttachmentRepresentation(HTMLOutputter $out, File $file) { try { @@ -318,13 +395,23 @@ class OembedPlugin extends Plugin $out->raw($purifier->purify($oembed->html)); } return false; - break; } 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 // we can configure this from config.php for the private nodes) @@ -341,8 +428,7 @@ class OembedPlugin extends Plugin try { // 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. - $file_oembed = File_oembed::getByFile($file); - $thumbnail = File_thumbnail::byFile($file); + $thumbnail = File_thumbnail::byFile($file); } catch (NoResultException $e) { // Not Oembed data, or at least nothing we either can or want to use. common_debug('No oEmbed data found for file id=='.$file->getID()); @@ -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 */ protected function checkWhitelist($url) @@ -383,79 +469,157 @@ class OembedPlugin extends Plugin 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) { 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(); - $this->checkWhitelist($remoteUrl); + $url = $thumbnail->getUrl(); + $this->checkWhitelist($url); - $http = new HTTPClient(); - // First see if it's too large for us - common_debug(__METHOD__ . ': '.sprintf('Performing HEAD request for remote file id==%u to avoid unnecessarily downloading too large files. URL: %s', $thumbnail->getFileId(), $remoteUrl)); - $head = $http->head($remoteUrl); - if (!$head->isOk()) { - common_log(LOG_WARNING, 'HEAD request returned HTTP failure, so we will abort now and delete the thumbnail object.'); - $thumbnail->delete(); - return false; - } else { - common_debug('HEAD request returned HTTP success, so we will continue.'); - } - $remoteUrl = $head->getEffectiveUrl(); // to avoid going through redirects again - - $headers = $head->getHeader(); - $filesize = isset($headers['content-length']) ? $headers['content-length'] : null; - - // 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; + try { + $isImage = $this->isRemoteImage($url); + if ($isImage==true) { + $max_size = common_get_preferred_php_upload_limit(); + $file_size = $this->getRemoteFileSize($url); + if (($file_size!=false) && ($file_size > $max_size)) { + common_debug("Went to store remote thumbnail of size " . $file_size . " but the upload limit is " . $max_size . " so we aborted."); + return false; + } + } + } catch (Exception $err) { + common_debug("Could not determine size of remote image, aborted local storage."); + return $err; } - // 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. - common_debug(sprintf('Downloading remote thumbnail for file id==%u (should be size %u) with effective URL: %s', $thumbnail->getFileId(), $filesize, _ve($remoteUrl))); - $imgData = HTTPClient::quickGet($remoteUrl); + common_debug(sprintf('Downloading remote thumbnail for file id==%u with thumbnail URL: %s', $thumbnail->file_id, $url)); + $imgData = HTTPClient::quickGet($url); $info = @getimagesizefromstring($imgData); 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]) { throw new UnsupportedMediaException(_('Image file had impossible geometry (0 width or height)')); } $ext = File::guessMimeExtension($info['mime']); - $filename = sprintf('oembed-%d.%s', $thumbnail->getFileId(), $ext); - $fullpath = File_thumbnail::path($filename); - // Write the file to disk. Throw Exception on failure - if (!file_exists($fullpath) && file_put_contents($fullpath, $imgData) === false) { - throw new ServerException(_('Could not write downloaded file to disk.')); + try { + $filename = sprintf('oembed-%d.%s', $thumbnail->getFileId(), $ext); + $fullpath = File_thumbnail::path($filename); + // Write the file to disk. Throw Exception on failure + if (!file_exists($fullpath) && file_put_contents($fullpath, $imgData) === false) { + throw new ServerException(_('Could not write downloaded file to disk.')); + } + } 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); } - // Get rid of the file from memory - unset($imgData); - // Updated our database for the file record - $orig = clone($thumbnail); - $thumbnail->filename = $filename; - $thumbnail->width = $info[0]; // array indexes documented on php.net: - $thumbnail->height = $info[1]; // https://php.net/manual/en/function.getimagesize.php - // Throws exception on failure. - $thumbnail->updateWithKeys($orig); + try { + // Updated our database for the file record + $orig = clone($thumbnail); + $thumbnail->filename = $filename; + $thumbnail->width = $info[0]; // array indexes documented on php.net: + $thumbnail->height = $info[1]; // https://php.net/manual/en/function.getimagesize.php + // Throws exception on failure. + $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) { $versions[] = array('name' => 'Oembed', 'version' => self::PLUGIN_VERSION, 'author' => 'Mikael Nordfeldth', - 'homepage' => 'http://gnu.io/', + 'homepage' => 'http://gnu.io/social/', 'description' => // TRANS: Plugin description. _m('Plugin for using and representing Oembed data.')); diff --git a/plugins/Oembed/actions/oembed.php b/plugins/Oembed/actions/oembed.php index 564e492e4a..7108545c79 100644 --- a/plugins/Oembed/actions/oembed.php +++ b/plugins/Oembed/actions/oembed.php @@ -1,42 +1,41 @@ . + /** - * StatusNet, the distributed open-source microblogging tool + * OembedPlugin implementation for GNU social * - * oEmbed data action for /main/oembed(.xml|.json) requests - * - * 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 . + * @package GNUsocial + * @author Craig Andrews + * @author Mikael Nordfeldth + * @author hannes + * @author Diogo Cordeiro + * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ -if (!defined('GNUSOCIAL')) { exit(1); } +defined('GNUSOCIAL') || die(); /** * Oembed provider implementation * * This class handles all /main/oembed(.xml|.json)/ requests. * - * @category oEmbed - * @package GNUsocial - * @author Craig Andrews - * @author Mikael Nordfeldth - * @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/ + * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ - class OembedAction extends Action { protected function handle() @@ -47,12 +46,12 @@ class OembedAction extends Action $tls = parse_url($url, PHP_URL_SCHEME) == 'https'; $root_url = common_root_url($tls); - if (substr(strtolower($url),0,mb_strlen($root_url)) !== strtolower($root_url)) { + if (substr(strtolower($url), 0, mb_strlen($root_url)) !== strtolower($root_url)) { // TRANS: Error message displaying attachments. %s is the site's base URL. throw new ClientException(sprintf(_('oEmbed data will only be provided for %s URLs.'), $root_url)); } - $path = substr($url,strlen($root_url)); + $path = substr($url, strlen($root_url)); $r = Router::get(); @@ -75,15 +74,17 @@ class OembedAction extends Action $profile = $notice->getProfile(); $authorname = $profile->getFancyName(); // 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, - common_exact_date($notice->created)); + common_exact_date($notice->created) + ); $oembed['author_name']=$authorname; $oembed['author_url']=$profile->profileurl; $oembed['url']=$notice->getUrl(); $oembed['html']=$notice->getRendered(); - // maybe add thumbnail + // maybe add thumbnail foreach ($notice->attachments() as $attachment) { if (!$attachment instanceof File) { common_debug('ATTACHMENTS array entry from notice id=='._ve($notice->getID()).' is something else than a File dataobject: '._ve($attachment)); @@ -108,10 +109,10 @@ class OembedAction extends Action case 'attachment': $id = $proxy_args['attachment']; $attachment = File::getKV($id); - if(empty($attachment)){ + if (empty($attachment)) { // TRANS: Client error displayed in oEmbed action when attachment not found. // TRANS: %d is an attachment ID. - $this->clientError(sprintf(_('Attachment %s not found.'),$id), 404); + $this->clientError(sprintf(_('Attachment %s not found.'), $id), 404); } if (empty($attachment->filename) && $file_oembed = File_oembed::getKV('file_id', $attachment->id)) { // Proxy the existing oembed information @@ -125,7 +126,7 @@ class OembedAction extends Action $oembed['author_name']=$file_oembed->author_name; $oembed['author_url']=$file_oembed->author_url; $oembed['url']=$file_oembed->getUrl(); - } elseif (substr($attachment->mimetype,0,strlen('image/'))==='image/') { + } elseif (substr($attachment->mimetype, 0, strlen('image/'))==='image/') { $oembed['type']='photo'; if ($attachment->filename) { $filepath = File::path($attachment->filename); @@ -149,8 +150,10 @@ class OembedAction extends Action } } else { $oembed['type']='link'; - $oembed['url']=common_local_url('attachment', - array('attachment' => $attachment->id)); + $oembed['url']=common_local_url( + 'attachment', + array('attachment' => $attachment->id) + ); } if ($attachment->title) { $oembed['title']=$attachment->title; @@ -159,14 +162,14 @@ class OembedAction extends Action default: // TRANS: Server error displayed in oEmbed request when a path is not supported. // TRANS: %s is a path. - $this->serverError(sprintf(_('"%s" not supported for oembed requests.'),$path), 501); + $this->serverError(sprintf(_('"%s" not supported for oembed requests.'), $path), 501); } switch ($this->trimmed('format')) { case 'xml': $this->init_document('xml'); $this->elementStart('oembed'); - foreach(array( + foreach (array( 'version', 'type', 'provider_name', 'provider_url', 'title', 'author_name', 'author_url', 'url', 'html', 'width', @@ -244,7 +247,7 @@ class OembedAction extends Action * * @return boolean is read only action? */ - function isReadOnly($args) + public function isReadOnly($args) { return true; } diff --git a/plugins/Oembed/classes/File_oembed.php b/plugins/Oembed/classes/File_oembed.php index e47fee6abe..dcfc5f6401 100644 --- a/plugins/Oembed/classes/File_oembed.php +++ b/plugins/Oembed/classes/File_oembed.php @@ -1,28 +1,38 @@ . + +/** + * OembedPlugin implementation for GNU social * - * 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 . + * @package GNUsocial + * @author Stephen Paul Weber + * @author Mikael Nordfeldth + * @author Diogo Cordeiro + * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ -if (!defined('GNUSOCIAL')) { exit(1); } +defined('GNUSOCIAL') || die(); /** * 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 { 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 { return oEmbedHelper::getObject($url); } catch (Exception $e) { @@ -79,7 +90,8 @@ class File_oembed extends Managed_DataObject /** * 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->file_id = $file->id; if (!$fo->find(true)) { @@ -99,7 +111,8 @@ class File_oembed extends Managed_DataObject * @param object $data Services_oEmbed_Object_* * @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->file_id = $file_id; if (!isset($data->version)) { @@ -107,19 +120,37 @@ class File_oembed extends Managed_DataObject } $file_oembed->version = $data->version; $file_oembed->type = $data->type; - if (!empty($data->provider_name)) $file_oembed->provider = $data->provider_name; - if (!empty($data->provider)) $file_oembed->provider = $data->provider; - 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->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->provider_name)) { + $file_oembed->provider = $data->provider_name; + } + if (!empty($data->provider)) { + $file_oembed->provider = $data->provider; + } + 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->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)) { $file_oembed->url = $data->url; $given_url = File_redirection::_canonUrl($file_oembed->url); - if (! empty($given_url)){ + if (! empty($given_url)) { try { $file = File::getByUrl($given_url); $file_oembed->mimetype = $file->mimetype; @@ -139,8 +170,11 @@ class File_oembed extends Managed_DataObject if (!empty($data->thumbnail_url) || ($data->type == 'photo')) { $ft = File_thumbnail::getKV('file_id', $file_id); if ($ft instanceof File_thumbnail) { - common_log(LOG_WARNING, "Strangely, a File_thumbnail object exists for new file $file_id", - __FILE__); + common_log( + LOG_WARNING, + "Strangely, a File_thumbnail object exists for new file $file_id", + __FILE__ + ); } else { File_thumbnail::saveNew($data, $file_id); } diff --git a/plugins/Oembed/lib/oembedhelper.php b/plugins/Oembed/lib/oembedhelper.php index 2a76ac0f7b..2d56f4bab2 100644 --- a/plugins/Oembed/lib/oembedhelper.php +++ b/plugins/Oembed/lib/oembedhelper.php @@ -1,24 +1,31 @@ . + +/** + * OembedPlugin implementation for GNU social * - * 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 . + * @package GNUsocial + * @author Mikael Nordfeldth + * @author hannes + * @author Diogo Cordeiro + * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ -if (!defined('GNUSOCIAL')) { exit(1); } - +defined('GNUSOCIAL') || die(); /** * Utility class to wrap basic oEmbed lookups. @@ -35,6 +42,9 @@ if (!defined('GNUSOCIAL')) { exit(1); } * Others will fall back to oohembed (unless disabled). * The API endpoint can be configured or disabled through config * 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 { @@ -87,36 +97,38 @@ class oEmbedHelper // DOMDocument::loadHTML may throw warnings on unrecognized elements, // and notices on unrecognized namespaces. $old = error_reporting(error_reporting() & ~(E_WARNING | E_NOTICE)); - + // DOMDocument assumes ISO-8859-1 per HTML spec // use UTF-8 if we find any evidence of that encoding $utf8_evidence = false; $unicode_check_dom = new DOMDocument(); $ok = $unicode_check_dom->loadHTML($body); - if (!$ok) throw new oEmbedHelper_BadHtmlException(); + if (!$ok) { + throw new oEmbedHelper_BadHtmlException(); + } $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 - if(stristr($metaNode->getAttribute('http-equiv'),'content-type') - && stristr($metaNode->getAttribute('content'),'utf-8')) { - $utf8_evidence = true; - break; - } elseif(stristr($metaNode->getAttribute('charset'),'utf-8')) { - $utf8_evidence = true; + if (stristr($metaNode->getAttribute('http-equiv'), 'content-type') + && stristr($metaNode->getAttribute('content'), 'utf-8')) { + $utf8_evidence = true; + break; + } elseif (stristr($metaNode->getAttribute('charset'), 'utf-8')) { + $utf8_evidence = true; break; } } unset($unicode_check_dom); - + // The Content-Type HTTP response header overrides encoding metatags in DOM - if(stristr($response->getHeader('Content-Type'),'utf-8')) { - $utf8_evidence = true; + if (stristr($response->getHeader('Content-Type'), 'utf-8')) { + $utf8_evidence = true; } - - // add utf-8 encoding prolog if we have reason to believe this is utf-8 content - // DOMDocument('1.0', 'UTF-8') does not work! - $utf8_tag = $utf8_evidence ? '' : ''; - + + // add utf-8 encoding prolog if we have reason to believe this is utf-8 content + // DOMDocument('1.0', 'UTF-8') does not work! + $utf8_tag = $utf8_evidence ? '' : ''; + $dom = new DOMDocument(); $ok = $dom->loadHTML($utf8_tag.$body); unset($body); // storing the DOM in memory is enough... @@ -125,7 +137,7 @@ class oEmbedHelper if (!$ok) { throw new oEmbedHelper_BadHtmlException(); } - + Event::handle('GetRemoteUrlMetadataFromDom', array($url, $dom, &$metadata)); } @@ -139,7 +151,7 @@ class oEmbedHelper * @param string $body HTML body text * @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! $feeds = array( @@ -184,7 +196,7 @@ class oEmbedHelper * @param array $params * @return object */ - static function getOembedFrom($api, $url, $params=array()) + public static function getOembedFrom($api, $url, $params=array()) { if (empty($api)) { // TRANS: Server exception thrown in oEmbed action if no API endpoint is available. @@ -192,16 +204,16 @@ class oEmbedHelper } $params['url'] = $url; $params['format'] = 'json'; - $key=common_config('oembed','apikey'); - if(isset($key)) { - $params['key'] = common_config('oembed','apikey'); + $key=common_config('oembed', 'apikey'); + if (isset($key)) { + $params['key'] = common_config('oembed', 'apikey'); } - + $oembed_data = HTTPClient::quickGetJson($api, $params); if (isset($oembed_data->html)) { $oembed_data->html = common_purify($oembed_data->html); } - + return $oembed_data; } @@ -211,7 +223,7 @@ class oEmbedHelper * @param object $orig * @return object */ - static function normalize(stdClass $data) + public static function normalize(stdClass $data) { if (empty($data->type)) { throw new Exception('Invalid oEmbed data: no type field.'); @@ -243,7 +255,7 @@ class oEmbedHelper_Exception extends 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); } @@ -251,7 +263,7 @@ class oEmbedHelper_BadHtmlException 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); } diff --git a/plugins/Oembed/lib/opengraphhelper.php b/plugins/Oembed/lib/opengraphhelper.php index 402f4b6a9f..1764c01f06 100644 --- a/plugins/Oembed/lib/opengraphhelper.php +++ b/plugins/Oembed/lib/opengraphhelper.php @@ -1,10 +1,36 @@ . -if (!defined('GNUSOCIAL')) { exit(1); } +/** + * OembedPlugin implementation for GNU social + * + * @package GNUsocial + * @author Mikael Nordfeldth + * @author Diogo Cordeiro + * @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. + * + * @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 { @@ -26,7 +52,8 @@ class OpenGraphHelper '/^image/' => 'photo', ]; - static function ogFromHtml(DOMDocument $dom) { + public static function ogFromHtml(DOMDocument $dom) + { $obj = new stdClass(); $obj->version = '1.0'; // fake it til u make it diff --git a/plugins/Oembed/locale/Oembed.pot b/plugins/Oembed/locale/Oembed.pot index bb2fe50f10..168b4a637b 100644 --- a/plugins/Oembed/locale/Oembed.pot +++ b/plugins/Oembed/locale/Oembed.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\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" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -18,12 +18,12 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" #. TRANS: Plugin description. -#: OembedPlugin.php:461 +#: OembedPlugin.php:721 msgid "Plugin for using and representing Oembed data." msgstr "" #. TRANS: Exception. %s is the URL we tried to GET. -#: lib/oembedhelper.php:83 +#: lib/oembedhelper.php:93 #, php-format msgid "Could not GET URL %s." msgstr "" diff --git a/plugins/Oembed/scripts/fixup_files.php b/plugins/Oembed/scripts/fixup_files.php index 50ddc8a994..cee01ccb5c 100755 --- a/plugins/Oembed/scripts/fixup_files.php +++ b/plugins/Oembed/scripts/fixup_files.php @@ -1,24 +1,33 @@ #!/usr/bin/env php . + +/** + * OembedPlugin implementation for GNU social * - * 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 . + * @package GNUsocial + * @author Mikael Nordfeldth + * @author Diogo Cordeiro + * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ -define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..')); +defined('GNUSOCIAL') || die(); + +define('INSTALLDIR', realpath(__DIR__ . '/../../..')); $longoptions = array('dry-run'); @@ -54,13 +63,15 @@ while ($f->fetch()) { } } else { // 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 " . "WHERE id=%d", - $f->id); + $f->id + ); $f->query($sql); $f->decache(); - + if (is_array($data)) { Event::handle('EndFileSaveNew', array($f, $data, $f->url)); echo " (ok)\n"; @@ -71,4 +82,3 @@ while ($f->fetch()) { } echo "done.\n"; - diff --git a/plugins/Oembed/scripts/poll_oembed.php b/plugins/Oembed/scripts/poll_oembed.php index a7e8c9bbc1..135f88cf15 100755 --- a/plugins/Oembed/scripts/poll_oembed.php +++ b/plugins/Oembed/scripts/poll_oembed.php @@ -1,7 +1,33 @@ #!/usr/bin/env php . -define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..')); +/** + * OembedPlugin implementation for GNU social + * + * @package GNUsocial + * @author Mikael Nordfeldth + * @author Diogo Cordeiro + * @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:'; $longoptions = array('url='); diff --git a/plugins/Oembed/tests/oEmbedTest.php b/plugins/Oembed/tests/oEmbedTest.php index a50328c91c..bdd01504d1 100644 --- a/plugins/Oembed/tests/oEmbedTest.php +++ b/plugins/Oembed/tests/oEmbedTest.php @@ -1,11 +1,35 @@ . + +/** + * OembedPlugin implementation for GNU social + * + * @package GNUsocial + * @author Mikael Nordfeldth + * @author Diogo Cordeiro + * @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)) { print "This script must be run from the command line\n"; exit(); } -define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..')); +define('INSTALLDIR', realpath(__DIR__ . '/../../..')); define('GNUSOCIAL', true); define('STATUSNET', true); // compatibility @@ -13,7 +37,6 @@ require_once INSTALLDIR . '/lib/common.php'; class oEmbedTest extends PHPUnit_Framework_TestCase { - public function setup() { $this->old_ohembed = common_config('ohembed', 'endpoint'); @@ -51,10 +74,11 @@ class oEmbedTest extends PHPUnit_Framework_TestCase * * @return string */ - function _endpoint() + public function _endpoint() { $default = array(); - $_server = 'localhost'; $_path = ''; + $_server = 'localhost'; + $_path = ''; require INSTALLDIR . '/lib/default.php'; return $default['oembed']['endpoint']; } @@ -65,7 +89,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase * @param string $url * @param string $expectedType */ - function _doTest($url, $expectedType) + public function _doTest($url, $expectedType) { try { $data = oEmbedHelper::getObject($url); @@ -74,7 +98,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase $this->assertTrue(!empty($data->url), 'Photo must have a URL.'); $this->assertTrue(!empty($data->width), 'Photo must have a width.'); $this->assertTrue(!empty($data->height), 'Photo must have a height.'); - } else if ($data->type == 'video') { + } elseif ($data->type == 'video') { $this->assertTrue(!empty($data->html), 'Video must have embedding HTML.'); $this->assertTrue(!empty($data->thumbnail_url), 'Video should have a thumbnail.'); } @@ -95,7 +119,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase * Sample oEmbed targets for sites we know ourselves... * @return array */ - static public function knownSources() + public static function knownSources() { $sources = array( array('https://www.flickr.com/photos/brionv/5172500179/', 'photo'), @@ -109,7 +133,7 @@ class oEmbedTest extends PHPUnit_Framework_TestCase * * @return array */ - static public function discoverableSources() + public static function discoverableSources() { $sources = array( @@ -128,9 +152,8 @@ class oEmbedTest extends PHPUnit_Framework_TestCase * * @return array */ - static public function fallbackSources() + public static function fallbackSources() { - $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' );