123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465 |
- <?php
- if (!defined('GNUSOCIAL')) { exit(1); }
- class OembedPlugin extends Plugin
- {
- const PLUGIN_VERSION = '2.0.0';
-
-
- public $domain_whitelist = array(
- '^i\d*\.ytimg\.com$' => 'YouTube',
- '^i\d*\.vimeocdn\.com$' => 'Vimeo',
- );
- public $append_whitelist = array();
- public $check_whitelist = false;
- protected $imgData = array();
-
- public function initialize()
- {
- parent::initialize();
- $this->domain_whitelist = array_merge($this->domain_whitelist, $this->append_whitelist);
- }
- public function onCheckSchema()
- {
- $schema = Schema::get();
- $schema->ensureTable('file_oembed', File_oembed::schemaDef());
- return true;
- }
- public function onRouterInitialized(URLMapper $m)
- {
- $m->connect('main/oembed', array('action' => 'oembed'));
- }
- public function onGetRemoteUrlMetadataFromDom($url, DOMDocument $dom, stdClass &$metadata)
- {
- try {
- common_log(LOG_INFO, 'Trying to discover an oEmbed endpoint using link headers.');
- $api = oEmbedHelper::oEmbedEndpointFromHTML($dom);
- common_log(LOG_INFO, 'Found oEmbed API endpoint ' . $api . ' for URL ' . $url);
- $params = array(
- 'maxwidth' => common_config('thumbnail', 'width'),
- 'maxheight' => common_config('thumbnail', 'height'),
- );
- $metadata = oEmbedHelper::getOembedFrom($api, $url, $params);
-
-
-
- if(strpos($url,'https://www.facebook.com/') === 0) {
- $metadata->html = @$dom->getElementsByTagName('title')->item(0)->nodeValue;
- }
-
-
- $xpath = new DomXpath($dom);
- $generatorNode = @$xpath->query('//meta[@name="generator"][1]')->item(0);
- if ($generatorNode instanceof DomElement) {
-
-
- 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) {
- $metadata->html = $propertyNode->getAttribute('content');
- }
- }
- }
- } catch (Exception $e) {
- common_log(LOG_INFO, 'Could not find an oEmbed endpoint using link headers, trying OpenGraph from HTML.');
-
- $metadata = OpenGraphHelper::ogFromHtml($dom);
- }
- if (isset($metadata->thumbnail_url)) {
-
-
-
- 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;
- }
-
-
-
- if($metadata->thumbnail_url == 'https://s0.wp.com/i/blank.jpg') {
- unset($metadata->thumbnail_url);
- }
- }
- }
- public function onEndShowHeadElements(Action $action)
- {
- switch ($action->getActionName()) {
- case 'attachment':
- $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())))),
- 'title'=>'oEmbed'));
- $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())))),
- 'title'=>'oEmbed'));
- break;
- case 'shownotice':
- if (!$action->notice->isLocal()) {
- break;
- }
- try {
- $action->element('link',array('rel'=>'alternate',
- 'type'=>'application/json+oembed',
- 'href'=>common_local_url(
- 'oembed',
- array(),
- array('format'=>'json','url'=>$action->notice->getUrl())),
- 'title'=>'oEmbed'));
- $action->element('link',array('rel'=>'alternate',
- 'type'=>'text/xml+oembed',
- 'href'=>common_local_url(
- 'oembed',
- array(),
- array('format'=>'xml','url'=>$action->notice->getUrl())),
- 'title'=>'oEmbed'));
- } catch (InvalidUrlException $e) {
-
-
- }
- break;
- }
- return true;
- }
- public function onEndShowStylesheets(Action $action) {
- $action->cssLink($this->path('css/oembed.css'));
- return true;
- }
-
- public function onEndFileSaveNew(File $file)
- {
- $fo = File_oembed::getKV('file_id', $file->getID());
- if ($fo instanceof File_oembed) {
- common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file {$file->getID()}", __FILE__);
- return true;
- }
- 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) {
- throw new Exception('Did not get oEmbed data from URL');
- }
- $file->setTitle($oembed_data->title);
- } catch (Exception $e) {
- common_log(LOG_WARNING, sprintf(__METHOD__.': %s thrown when getting oEmbed data: %s', get_class($e), _ve($e->getMessage())));
- return true;
- }
- File_oembed::saveNew($oembed_data, $file->getID());
- }
- return true;
- }
- public function onEndShowAttachmentLink(HTMLOutputter $out, File $file)
- {
- $oembed = File_oembed::getKV('file_id', $file->getID());
- if (empty($oembed->author_name) && empty($oembed->provider)) {
- return true;
- }
- $out->elementStart('div', array('id'=>'oembed_info', 'class'=>'e-content'));
- if (!empty($oembed->author_name)) {
- $out->elementStart('div', 'fn vcard author');
- if (empty($oembed->author_url)) {
- $out->text($oembed->author_name);
- } else {
- $out->element('a', array('href' => $oembed->author_url,
- 'class' => 'url'),
- $oembed->author_name);
- }
- }
- if (!empty($oembed->provider)) {
- $out->elementStart('div', 'fn vcard');
- if (empty($oembed->provider_url)) {
- $out->text($oembed->provider);
- } else {
- $out->element('a', array('href' => $oembed->provider_url,
- 'class' => 'url'),
- $oembed->provider);
- }
- }
- $out->elementEnd('div');
- }
- public function onFileEnclosureMetadata(File $file, &$enclosure)
- {
-
-
- $oembed = File_oembed::getKV('file_id', $file->getID());
- if (!$oembed instanceof File_oembed || !in_array($oembed->type, array('photo', 'video'))) {
- return true;
- }
- foreach (array('mimetype', 'url', 'title', 'modified', 'width', 'height') as $key) {
- if (isset($oembed->{$key}) && !empty($oembed->{$key})) {
- $enclosure->{$key} = $oembed->{$key};
- }
- }
- return true;
- }
- public function onStartShowAttachmentRepresentation(HTMLOutputter $out, File $file)
- {
- try {
- $oembed = File_oembed::getByFile($file);
- } catch (NoResultException $e) {
- return true;
- }
-
- if ($oembed->type === 'photo') {
- return true;
- }
- $out->elementStart('article', ['class'=>'h-entry oembed']);
- $out->elementStart('header');
- try {
- $thumb = $file->getThumbnail(128, 128);
- $out->element('img', $thumb->getHtmlAttrs(['class'=>'u-photo oembed']));
- unset($thumb);
- } catch (Exception $e) {
- $out->element('div', ['class'=>'error'], $e->getMessage());
- }
- $out->elementStart('h5', ['class'=>'p-name oembed']);
- $out->element('a', ['class'=>'u-url', 'href'=>$file->getUrl()], common_strip_html($oembed->title));
- $out->elementEnd('h5');
- $out->elementStart('div', ['class'=>'p-author oembed']);
- if (!empty($oembed->author_name)) {
-
-
- $out->text(_('By '));
- $attrs = ['class'=>'h-card p-author'];
- if (!empty($oembed->author_url)) {
- $attrs['href'] = $oembed->author_url;
- $tag = 'a';
- } else {
- $tag = 'span';
- }
- $out->element($tag, $attrs, $oembed->author_name);
- }
- if (!empty($oembed->provider)) {
-
-
- $out->text(_(' from '));
- $attrs = ['class'=>'h-card'];
- if (!empty($oembed->provider_url)) {
- $attrs['href'] = $oembed->provider_url;
- $tag = 'a';
- } else {
- $tag = 'span';
- }
- $out->element($tag, $attrs, $oembed->provider);
- }
- $out->elementEnd('div');
- $out->elementEnd('header');
- $out->elementStart('div', ['class'=>'p-summary oembed']);
- $out->raw(common_purify($oembed->html));
- $out->elementEnd('div');
- $out->elementStart('footer');
- $out->elementEnd('footer');
- $out->elementEnd('article');
- return false;
- }
-
- public function onShowUnsupportedAttachmentRepresentation(HTMLOutputter $out, File $file)
- {
- try {
- $oembed = File_oembed::getByFile($file);
- } catch (NoResultException $e) {
- return true;
- }
-
- switch ($oembed->type) {
- case 'video':
- case 'link':
- if (!empty($oembed->html)
- && (GNUsocial::isAjax() || common_config('attachments', 'show_html'))) {
- require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
- $purifier = new HTMLPurifier();
-
- $out->raw($purifier->purify($oembed->html));
- }
- return false;
- break;
- }
- return true;
- }
- public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null)
- {
-
-
- if (common_config('site', 'private')) {
- return true;
- }
-
- if (!is_null($file->filename)) {
- common_debug(sprintf('Filename of file id==%d is not null (%s), so nothing oEmbed should handle.', $file->getID(), _ve($file->filename)));
- return true;
- }
- try {
-
-
- $file_oembed = File_oembed::getByFile($file);
- $thumbnail = File_thumbnail::byFile($file);
- } catch (NoResultException $e) {
-
- common_debug('No oEmbed data found for file id=='.$file->getID());
- return true;
- }
- try {
- $this->storeRemoteFileThumbnail($thumbnail);
- } catch (AlreadyFulfilledException $e) {
-
- } catch (Exception $e) {
- common_debug(sprintf('oEmbed encountered an exception (%s) for file id==%d: %s', get_class($e), $file->getID(), _ve($e->getMessage())));
- throw $e;
- }
- $imgPath = $thumbnail->getPath();
- return false;
- }
-
- protected function checkWhitelist($url)
- {
- if (!$this->check_whitelist) {
- return false;
- }
- $host = parse_url($url, PHP_URL_HOST);
- foreach ($this->domain_whitelist as $regex => $provider) {
- if (preg_match("/$regex/", $host)) {
- return $provider;
- }
- }
- throw new ServerException(sprintf(_('Domain not in remote thumbnail source whitelist: %s'), $host));
- }
- 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()));
- }
- $remoteUrl = $thumbnail->getUrl();
- $this->checkWhitelist($remoteUrl);
- $http = new HTTPClient();
-
- 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();
- $headers = $head->getHeader();
- $filesize = isset($headers['content-length']) ? $headers['content-length'] : null;
-
- if (empty($filesize)) {
-
- 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')) {
-
- 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;
- }
-
-
- 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);
- $info = @getimagesizefromstring($imgData);
- if ($info === false) {
- throw new UnsupportedMediaException(_('Remote file format was not identified as an image.'), $remoteUrl);
- } 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);
-
- if (!file_exists($fullpath) && file_put_contents($fullpath, $imgData) === false) {
- throw new ServerException(_('Could not write downloaded file to disk.'));
- }
-
- unset($imgData);
-
- $orig = clone($thumbnail);
- $thumbnail->filename = $filename;
- $thumbnail->width = $info[0];
- $thumbnail->height = $info[1];
-
- $thumbnail->updateWithKeys($orig);
- }
- public function onPluginVersion(array &$versions)
- {
- $versions[] = array('name' => 'Oembed',
- 'version' => self::PLUGIN_VERSION,
- 'author' => 'Mikael Nordfeldth',
- 'homepage' => 'http://gnu.io/',
- 'description' =>
-
- _m('Plugin for using and representing Oembed data.'));
- return true;
- }
- }
|