MediaEmbed: fixed PeerTube helper

Author: JoshyPHP

docs/Plugins/MediaEmbed/Federated_sites.md

@@ -51,6 +51,29 @@ echo $html;
 ```
 
 
+### PeerTube
+
+```php
+$configurator = new s9e\TextFormatter\Configurator;
+
+// Use the PeerTube helper to add 'neat.tube' as a supported instance
+$peertubeHelper = $configurator->MediaEmbed->getSiteHelper('peertube');
+$peertubeHelper->addHost('neat.tube');
+
+// Get an instance of the parser and the renderer
+extract($configurator->finalize());
+
+$text = 'https://neat.tube/w/3PWC7CoQnqfZ4AkupAcVGB';
+$xml  = $parser->parse($text);
+$html = $renderer->render($xml);
+
+echo $html;
+```
+```html
+<span data-s9e-mediaembed="peertube" style="display:inline-block;width:100%;max-width:640px"><span style="display:block;overflow:hidden;position:relative;padding-bottom:56.25%"><iframe allowfullscreen="" loading="lazy" scrolling="no" style="border:0;height:100%;left:0;position:absolute;width:100%" src="https://neat.tube/videos/embed/3PWC7CoQnqfZ4AkupAcVGB"></iframe></span></span>
+```
+
+
 ### XenForo 2.3+
 
 While not technically a federated platform, XenForo 2.3+ allows embedding content from one forum into another. In the following example, we use the `XenForoHelper` class to allow embedding content from `xenforo.com`.

docs/testdox.txt

@@ -7310,6 +7310,7 @@ Parser (s9e\TextFormatter\Tests\Plugins\MediaEmbed\Parser)
  [x] Parsing tests with data set #345
  [x] Parsing tests with data set #346
  [x] Parsing tests with data set #347
+ [x] Parsing tests with data set #348
  [x] Parsing tests (JavaScript) with data set #0
  [x] Parsing tests (JavaScript) with data set #1
  [x] Parsing tests (JavaScript) with data set #2
@@ -7658,6 +7659,7 @@ Parser (s9e\TextFormatter\Tests\Plugins\MediaEmbed\Parser)
  [x] Parsing tests (JavaScript) with data set #345
  [x] Parsing tests (JavaScript) with data set #346
  [x] Parsing tests (JavaScript) with data set #347
+ [x] Parsing tests (JavaScript) with data set #348
  [x] Parsing+rendering tests with data set #0
  [x] Parsing+rendering tests with data set #1
  [x] Parsing+rendering tests with data set #2

src/Plugins/MediaEmbed/Configurator/Collections/CachedDefinitionCollection.php

@@ -92,7 +92,7 @@ class CachedDefinitionCollection extends SiteDefinitionCollection
 		'on3'=>['attributes'=>[],'example'=>['https://www.on3.com/rivals/darion-jones-240802/','https://www.on3.com/db/christian-jones-150372/industry-comparison/'],'extract'=>['!/db/(?:[-\\w]*-)?(?\'id\'[0-9]+)/industry-comparison/!','!/rivals/(?:[-\\w]*-)?(?\'id\'[0-9]+)/!'],'homepage'=>'https://www.on3.com/db/','host'=>['on3.com'],'iframe'=>['data-s9e-livepreview-ignore-attrs'=>'style','height'=>476,'onload'=>'let b=this.contentWindow;window.addEventListener(\'message\',a=>{{a.source===b&&a.data.height&&(this.style.height=+a.data.height+20+\'px\')}});b.postMessage(\'\',\'*\')','src'=>'https://embed.on3.com/db/{@id}/industry-comparison/','width'=>600],'name'=>'On3 DB','scrape'=>[],'tags'=>['sports']],
 		'orfium'=>['attributes'=>[],'example'=>['https://www.orfium.com/album/24371/everybody-loves-kanye-totom/','https://www.orfium.com/live-set/614763/foof-no-lights-5-foof/','https://www.orfium.com/playlist/511651/electronic-live-sessions-creamtronic/','https://www.orfium.com/track/625367/the-ambience-of-the-goss-vistas/'],'extract'=>['@album/(?\'album_id\'\\d+)@','@playlist/(?\'playlist_id\'\\d+)@','@live-set/(?\'set_id\'\\d+)@','@track/(?\'track_id\'\\d+)@'],'homepage'=>'https://www.orfium.com/','host'=>['orfium.com'],'iframe'=>['height'=>'<xsl:choose><xsl:when test="@album_id">550</xsl:when><xsl:otherwise>275</xsl:otherwise></xsl:choose>','max-width'=>900,'src'=>'https://www.orfium.com/embedded/<xsl:choose><xsl:when test="@album_id">album/<xsl:value-of select="@album_id"/></xsl:when><xsl:when test="@playlist_id">playlist/<xsl:value-of select="@playlist_id"/></xsl:when><xsl:when test="@set_id">live-set/<xsl:value-of select="@set_id"/></xsl:when><xsl:otherwise>track/<xsl:value-of select="@track_id"/></xsl:otherwise></xsl:choose>','width'=>'100%'],'name'=>'Orfium','scrape'=>[],'tags'=>['music']],
 		'pastebin'=>['attributes'=>[],'example'=>'https://pastebin.com/9jEf44nc','extract'=>['@pastebin\\.com/(?!u/)(?:\\w+(?:\\.php\\?i=|/))?(?\'id\'\\w+)@'],'homepage'=>'https://pastebin.com/','host'=>['pastebin.com'],'iframe'=>['height'=>300,'scrolling'=>'','src'=>'//pastebin.com/embed_iframe/{@id}','style'=>['resize'=>'vertical'],'width'=>'100%'],'name'=>'Pastebin','scrape'=>[]],
-		'peertube'=>['attributes'=>['host'=>['required'=>true],'id'=>['filterChain'=>['#identifier'],'required'=>true],'start'=>['filterChain'=>['#timestamp'],'required'=>false]],'example'=>'https://peertube.tv/w/5JHc2MW1LS4HjDExModcwo','extract'=>['!^https://(?\'host\'[-.\\w]+)/(?:videos/embed|w)/(?\'id\'[-\\w]+)(?:\\?start=(?\'start\'\\d[\\dhms]*))?!'],'homepage'=>'https://joinpeertube.org/','host'=>['peertube.tv'],'iframe'=>['src'=>'https://<xsl:value-of select="@host"/>/videos/embed/<xsl:value-of select="@id"/><xsl:if test="@start">?start=<xsl:value-of select="@start"/></xsl:if>'],'name'=>'PeerTube','scrape'=>[['extract'=>['!https://(?\'host\'[-.\\w]+)/videos/embed/(?\'id\'[-\\w]+)(?:\\?start=(?\'start\'\\d[\\dhms]*))?!'],'match'=>['!^https://(?\'host\'[-.\\w]+)/w/(?\'id\'\\w+)!'],'url'=>'https://{@host}/services/oembed?url=https%3A%2F%2F{@host}%2Fw%2F%2F{@id}']],'tags'=>['videos']],
+		'peertube'=>['attributes'=>['host'=>['required'=>true],'id'=>['filterChain'=>['#identifier'],'required'=>true],'start'=>['filterChain'=>['#timestamp'],'required'=>false]],'example'=>'https://peertube.tv/w/5JHc2MW1LS4HjDExModcwo','extract'=>['!^https://(?\'host\'[-.\\w]+)/(?:videos/embed|w)/(?\'id\'[-\\w]+)(?:\\?start=(?\'start\'\\d[\\dhms]*))?!'],'helper'=>'s9e\\TextFormatter\\Plugins\\MediaEmbed\\Configurator\\SiteHelpers\\PeerTubeHelper','homepage'=>'https://joinpeertube.org/','host'=>['peertube.tv'],'iframe'=>['src'=>'https://<xsl:value-of select="@host"/>/videos/embed/<xsl:value-of select="@id"/><xsl:if test="@start">?start=<xsl:value-of select="@start"/></xsl:if>'],'name'=>'PeerTube','scrape'=>[['extract'=>['!https://(?\'host\'[-.\\w]+)/videos/embed/(?\'id\'[-\\w]+)(?:\\?start=(?\'start\'\\d[\\dhms]*))?!'],'match'=>['!^https://(?\'host\'[-.\\w]+)/w/(?\'id\'\\w+)!'],'url'=>'https://{@host}/services/oembed?url=https%3A%2F%2F{@host}%2Fw%2F%2F{@id}']],'tags'=>['videos']],
 		'pinterest'=>['amp'=>['custom-element'=>'amp-pinterest','src'=>'https://cdn.ampproject.org/v0/amp-pinterest-0.1.js','template'=>'<amp-pinterest width="245" height="330" data-do="embedPin" data-url="https://www.pinterest.com/pin/{@id}/"/>'],'attributes'=>[],'example'=>['https://www.pinterest.com/pin/99360735500167749/','https://www.pinterest.com/pinterest/official-news/'],'extract'=>['@pinterest.com/pin/(?\'id\'\\d+)@','@pinterest.com/(?!_/|discover/|explore/|news_hub/|pin/|search/)(?\'id\'[-\\w]+/[-\\w]+)@'],'homepage'=>'https://www.pinterest.com/','host'=>['pinterest.com'],'iframe'=>['data-s9e-livepreview-ignore-attrs'=>'style','height'=>360,'onload'=>'let c=new MessageChannel;c.port1.onmessage=e=>this.style.height=e.data+\'px\';this.contentWindow.postMessage(\'s9e:init\',\'*\',[c.port2])','src'=>'https://s9e.github.io/iframe/2/pinterest.min.html#{@id}','width'=>'<xsl:choose><xsl:when test="contains(@id,\'/\')">730</xsl:when><xsl:otherwise>345</xsl:otherwise></xsl:choose>'],'name'=>'Pinterest','scrape'=>[],'source'=>'https://developers.pinterest.com/tools/widget-builder/','tags'=>['social']],
 		'podbean'=>['attributes'=>[],'example'=>['https://dialhforheroclix.podbean.com/e/dial-h-for-heroclix-episode-46-all-ya-need-is-love/','https://www.podbean.com/ew/pb-gmyyz-d6e065'],'extract'=>['!podbean\\.com/(?:[-\\w]+/)*(?:player[-\\w]*/|\\w+/pb-)(?\'id\'[-\\w]+)!'],'homepage'=>'https://www.podbean.com/','host'=>['podbean.com'],'iframe'=>['height'=>150,'max-width'=>900,'src'=>'https://www.podbean.com/player-v2/?i={@id}','width'=>'100%'],'name'=>'Podbean','scrape'=>[['extract'=>['!podbean\\.com/player[^/]*/\\?i=(?\'id\'[-\\w]+)!'],'header'=>'User-agent: PHP (not Mozilla)','match'=>['@podbean\\.com/(?:media/shar)?e/(?!pb-)@']]],'tags'=>['podcasts']],
 		'prezi'=>['attributes'=>[],'example'=>'https://prezi.com/5ye8po_hmikp/10-most-common-rookie-presentation-mistakes/','extract'=>['#//prezi\\.com/(?!(?:a(?:bout|mbassadors)|c(?:o(?:llaborate|mmunity|ntact)|reate)|exp(?:erts|lore)|ip(?:ad|hone)|jobs|l(?:ear|ogi)n|m(?:ac|obility)|pr(?:es(?:s|ent)|icing)|recommend|support|user|windows|your)/)(?\'id\'\\w+)/#'],'homepage'=>'https://prezi.com/','host'=>['prezi.com'],'iframe'=>['height'=>400,'src'=>'//prezi.com/embed/{@id}/','width'=>550],'name'=>'Prezi','scrape'=>[],'tags'=>['presentations']],

…diaEmbed/Configurator/PeerTubeHelper.php …figurator/SiteHelpers/PeerTubeHelper.phpsrc/Plugins/MediaEmbed/Configurator/PeerTubeHelper.php renamed to src/Plugins/MediaEmbed/Configurator/SiteHelpers/PeerTubeHelper.php src/Plugins/MediaEmbed/Configurator/PeerTubeHelper.php renamed to src/Plugins/MediaEmbed/Configurator/SiteHelpers/PeerTubeHelper.php

@@ -5,7 +5,7 @@
 * @copyright Copyright (c) The s9e authors
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
 */
-namespace s9e\TextFormatter\Plugins\MediaEmbed\Configurator;
+namespace s9e\TextFormatter\Plugins\MediaEmbed\Configurator\SiteHelpers;
 
 class PeerTubeHelper extends AbstractConfigurableHostHelper
 {

src/Plugins/MediaEmbed/Configurator/sites/peertube.xml

@@ -1,4 +1,4 @@
-<site name="PeerTube" homepage="https://joinpeertube.org/">
+<site name="PeerTube" homepage="https://joinpeertube.org/" helper="s9e\TextFormatter\Plugins\MediaEmbed\Configurator\SiteHelpers\PeerTubeHelper">
 	<example>https://peertube.tv/w/5JHc2MW1LS4HjDExModcwo</example>
 
 	<tags><tag>videos</tag></tags>

tests/Plugins/MediaEmbed/ParserTest.php

@@ -990,7 +990,7 @@ function ($configurator)
 				{
 					$configurator->registeredVars['cacheDir'] = __DIR__ . '/../../.cache';
 
-					$peertubeHelper = new PeerTubeHelper($configurator);
+					$peertubeHelper = $configurator->MediaEmbed->getSiteHelper('peertube');
 					$peertubeHelper->addHost('neat.tube');
 				}
 			],
@@ -3136,6 +3136,15 @@ function ($configurator)
 					$configurator->MediaEmbed->add('pastebin');
 				}
 			],
+			[
+				'https://peertube.test/w/5JHc2MW1LS4HjDExModcwo',
+				'<t>https://peertube.test/w/5JHc2MW1LS4HjDExModcwo</t>',
+				[],
+				function ($configurator)
+				{
+					$configurator->MediaEmbed->add('peertube');
+				}
+			],
 			[
 				'https://www.pinterest.com/pin/99360735500167749/',
 				'<r><PINTEREST id="99360735500167749">https://www.pinterest.com/pin/99360735500167749/</PINTEREST></r>',