oEmbed

C’est quoi ce truc ?

oEmbed est un protocole ouvert qui permet d’insérer le contenu d’une page web dans une autre page. Le contenu inséré peut être de plusieurs types : photo, vidéo, URL ou extrait HTML.

L’échange d’information a lieu entre un site client et un site serveur. Par exemple, le site client peut afficher une représentation d’une page web telle qu’une image ou une vidéo. Le serveur doit disposer d’un service utilisant l’API oEmbed pour permettre aux clients de récupérer les informations de la représentation à afficher.

Comment ça marche ?

Du côté client, l’utilisation du plugin est simple. Par défaut le plugin transforme automatiquement :

  • les URL entre < et > n’importe où dans le texte : <https://www.flickr.com/photos/romytetue/4651342894/>
  • les URL toutes seules dans un paragraphe : deux retours à la ligne, URL, puis deux retours à la ligne.

Si le site vers lequel pointe l’URL implémente l’API oEmbed, celle-ci est complétée par un extrait du contenu fourni par le site. Par exemple, si on insère l’URL suivante dans le texte d’un article :

https://www.flickr.com/photos/romytetue/4651342894/

Celle-ci sera automatiquement remplacée par le contenu suivant :

L'estafette SPIP

Avec SPIP 3, le plugin insère aussi ces traitements dans le formulaire d’ajout de documents de SPIP (dans la partie documents distants). Il suffit d’ajouter un document distant dont l’URL est celle de la page où se trouve le contenu à récupérer. Voir la vidéo ci-dessous pour une petite démonstration.

https://medias.spip.net/medias/r-d/plugins-26/multimedia/article/demo-du-plugin-oembed

Une fois le document ajouté, vous pouvez l’insérer dans le contenu de votre article comme n’importe quel document.

  • si le document est une image, vous pouvez l’insérer avec le raccourci <imgXX>
  • si le document est une vidéo, vous pouvez l’insérer avec le raccourci <embXX>

Et je peux faire ça avec n’importe quel site ?

Non, pour des raisons de sécurité le plugin utilise une liste blanche de sites autorisées. Par défaut, cette liste contient les sites suivants : youtube, blip.tv, vimeo, dailymotion, flickr, soundcloud, slideshare, yfrog, instagram, rdio, huffduffer, nfb, dotsub, clikthrough, kinomap, photobucket, smugmug, meetup, wordpress, blogs.cnn, techcrunch, my.opera, viddler et collegehumor (consulter la liste complète).

Pour ajouter un nouveau site serveur (ou provider) à la liste blanche il vous faudra deux informations :

  • scheme : schéma d’URL correspondant au site (vous pouvez utiliser * comme wildcard)
  • endpoint : URL à laquelle le service oEmbed du site est disponible

Par exemple, pour ajouter le site deviantART à la liste blanche il suffit d’ajouter un provider avec les paramètres suivants :

  • scheme : http://*.deviantart.com/art/*
  • endpoint : http://backend.deviantart.com/oembed

L’ajout peut se faire à l’aide du pipeline oembed_lister_providers ou en personnalisant le contenu de la variable globale $GLOBALS['oembed_providers'].

Par exemple, dans un plugin de préfixe monplugin en déclarant le pipeline suivant dans plugins/monplugin/monplugins_pipelines.php :

function monplugin_oembed_lister_providers($providers){
 
	$providers['http://*.deviantart.com/art/*'] = 'http://backend.deviantart.com/oembed';
 
	return $providers;
}

Ou sans utiliser de plugin, directement dans votre fichier config/mes_options.php :

$GLOBALS['oembed_providers'] = array(
	'http://*.deviantart.com/art/*' => 'http://backend.deviantart.com/oembed',
);

Voici une liste non exhaustive de providers supplémentaires au format JSON.

Traitements automatiques

La page de configuration vous permet aussi de paramétrer les automatismes du plugin :

  • largeur/hauteur par défaut des blocs d’embed
  • activer/désactiver la transformation automatique des URLs dans le texte : cela concerne les URLs toutes seules dans un paragraphes, car les URLs entre < et > seront toujours converties ;
  • activer/désactiver la détection automatique des providers sans tenir compte de la liste blanche (attention aux failles XSS).

Fonctions de post-traitement

Il est possible de déclarer des fonctions de post-traitement qui agiront sur les données renvoyées par le site source (ou provider). Le nommage de ces fonctions suit la convention suivante oembed_posttraite_{$provider_name}_$type[_dist] afin de permettre de déclarer un post-traitement en fonction de la source de données.

Par exemple, le plugin fournit une fonction de post-traitement pour soundcloud :

function oembed_input_posttraite_soundcloud_rich_dist($data){
 
	$data['media'] = 'sound';
	$data['html'] = preg_replace(",width=['\"][0-9]+['\"],i",'width="100%"',$data['html']);
 
	if (!isset($data['thumbnail_url'])){
		$data['thumbnail_url'] = find_in_path("oembed/input/vignettes/soundcloud.png");
	}
 
	return $data;
}

Cette fonction définit que le contenu renvoyé est du son, puis elle modifie la largeur du lecteur audio, et pour finir elle définit une vignette par défaut si celle-ci n’est pas présente.

Voir la source sur la zone.

Côté serveur

Le plugin ajoute des liens de déclaration oEmbed dans l’entête des pages du site. Ces liens permettent aux autres sites de découvrir que votre site est « compatible » oEmbed et qu’il peut donc être utilisé en tant que fournisseur de contenu (ou provider).

Les paramètres à fournir pour permettre à un autre site d’ajouter le votre à sa liste blanche de providers sont les suivants :

Pour que l’adresse du service fonctionne il faut avoir activé le fichier .htaccess fourni par défaut dans SPIP.

Le contenu renvoyé lors d’une requête oembed est généré par les squelettes situés dans le répertoire plugins/oembed/oembed/output/modeles. Ces squelettes sont personnalisables, vous pouvez y insérer des boucles et balises afin de renvoyer le code d’embed d’un document audio/vidéo, une image tirée du portfolio d’un article, etc.

Par exemple, pour une requête depuis l’URL http://contrib.spip.net/GIS-4 le contenu renvoyé est le suivant :

{
    "version": "1.0",
    "type": "rich",
    "provider_name": "SPIP-Contrib",
    "provider_url": "http://contrib.spip.net",
    "title": "GIS 4",
    "author_name": "b_b",
    "width": "480",
    "height": "295",
    "url": "http://contrib.spip.net/GIS-4",
    "html": "<h4 class='title'><a href='http://contrib.spip.net/GIS-4'>GIS 4</a></h4><blockquote class='spip'>\n<p>Présentation et nouveautés <br class='autobr' />\nLa version 4 de GIS abandonne la libraire Mapstraction au profit de Leaflet. Cette librairie permet de s’affranchir des librairies propriétaires tout en gardant les mêmes fonctionnalités, elle propose même de nouvelles fonctions.<br class='autobr' />\nCette nouvelle version de GIS permet d’utiliser différents fonds de carte sans avoir à charger des scripts externes, seuls les scripts locaux de Leaflet et des plugins nécessaires sont chargés dans vos pages. À ce jour, le plugin propose plus de&amp;amp;amp;amp;nbsp;(...)</p>\n</blockquote>\n"
}

Voir le code en ligne.

Et voici ce que donne l’affichage depuis le site SPIP client :

Dernière modification de cette page le 13 février 2019

Discussion

44 discussions

  • 1

    Chers amis b_b et Cerdic, depuis peu je retrouve des difficultés pour ajouter des documents dans un article depuis une URL. Toutes les tentatives aboutissent dans le message suivant : « Oups. Une erreur inattendue a empêché de soumettre le formulaire. Vous pouvez essayer à nouveau. ». Je ne sais pas si c’est un problème avec le merveilleux plugin oEmbed ou c’est lié avec un autre plugin.

    • C’est en général une erreur fatale, probablement liée à du code personnel, ou à l’un des plugins, mais ça peut-être n’importe lequel. Il faut regarder dans les logs du serveur (apache ou php selon la configuration) pour voir qui cause cette erreur

    Répondre à ce message

  • Hop, je pose ça là. Pour une instance peertube j’ai mis ça dans mes_fonctions.php et ça roule :

    $GLOBALS['oembed_providers'] = array(
      'https://peertube.fr/videos/watch/*' => 'https://peertube.fr/services/oembed',
    );

    Répondre à ce message

  • 2

    Bonjour,

    J’ai decouvert que mon spip.log est innonde par cette erreur :

    "Erreur - 'tw_post_typo' non definie !".

    Je me suis apercu dans un premier temps que cette erreur disparaissait si je desactivais un de mes plugins, qui utilise le pipeline « post_typo ». Je ne pense tout de meme pas que le probleme vienne de mon plugin qui est tres basique.

    Je pense que le probleme est que le plugin « oembed » surcharge le fichier inc/ressource.php tout en retirant les fonctions « tw_pre_typo » et « tw_post_typo » de ce fichier. Les pipelines utilisant ces fonctions sont toujours dans le fichier textwheel/paquet.xml, donc il est comprehensible que le systeme cherche a utiliser ces fonctions.

    Est-ce que vous pensez que quelque chose m’echappe, ou bien que c’etait une erreur de retirer les fonctions « tw_pre_typo » et « tw_post_typo » de la surcharge de ressource.php ?

    Répondre à ce message

  • 1

    Bonjour,
    Je cherche un moyen d’integrer une balise #MODELE dans un squelette pour afficher les vidéos youtube dans les articles... le modele par defaut de spip #MODELE emb affiche bien la vidéo mais essayer d’embeder les autres doc distant
    Merci

    Répondre à ce message

  • 3

    Hello !

    Afin d’augmenter la confidentialité, l’embed de Youtube ne pourrait-il pas être sous la forme youtube-nocookie.com (avec un choix dans l’interface de configuration) ?

    (Au fait, y a-t-il d’autres services qui proposent un truc semblable à ce que fait Youtube avec son nocookie ?)

    Répondre à ce message

  • 1

    Bonjour,

    Merci pour ce plugin mais j’ai un problème (spip 3.1 / plugin 2.0.6) le tout sur serveur free.

    Lorsque je cherche à inclure un document (issu de youtube ou autre) j’ai systématiquement le même message d’erreur : Le fichier distant *************** n’a pas pu être trouvé

    Si vous avez une solution, je suis preneur.

    Je précise que j’ai aussi essayé avec un spip 3.2.

    Merci pour votre aide.

    • Salut, c’est certainement un problème de restriction réseau chez ton hébergeur. Cela fait un bon moment que la communauté recommande de ne plus utiliser free comme héberger à cause des multiples problèmes qu’y rencontres les gens depuis pas mal de temps.

      Sinon, essaye peut-être du côté de cette doc : https://contrib.spip.net/SPIP-chez-Free-fr

    Répondre à ce message

  • 2

    Bonjour,

    Je constate que le plugin rajoute dans toutes les pages :

    Sauf que pour les rubriques, ça donne une 404.
    Exemple : la rubrique de cet article : https://contrib.spip.net/oembed.api/?format=json&url=https%3A%2F%2Fcontrib.spip.net%2FoEmbed

    Répondre à ce message

  • Bonjour,

    Bravo pour ce plugin. Pour information, j’ai réussi à intégrer des timelines JS dans les articles.

    Par contre une petite question : comment faire pour ne plus avoir l’url ou un titre qui s’affiche sous le doc intégré à l’article ?

    Merci

    Répondre à ce message

  • Serait-il possible de remplacer la class spip_document_center par la class spip_documents_[(#ENValign,center)] dans le modele text_oembed ?

    Répondre à ce message

  • Bonjour,
    je commence a utiliser ce plugin qui effectivement facilite la vie des rédacteurs et permet d’insérer facilement des vidéos distante dans des sliders, galerie etc
    Je voudrais sécuriser le code et pour cela dans mes modeles je teste la présence ou non du plugin. Cela est ok.
    Par contre si je désactive le plugin et que le rédacteur insère le document html créé avec le plugin (doc ou emb) qui apparait toujours dans les documents ... la rubrique est anormale dans l’espace privé : on ne voit plus ni mot clé , ni sous rurbrique, ni articles.
    problème aussi dans espace public
    y a t-il un moyen d’éviter cela ..
    merci

    Répondre à ce message

Ajouter un commentaire

Qui êtes-vous ?

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom