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 :
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.
http://medias.spip.net/medias/r-d/plugins/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 :
- '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['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.
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 :
- scheme : http://urldevotresite.net/*
- endpoint : http://urldevotresite.net/oembed.api/
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;nbsp;(...)</p>\n</blockquote>\n"
}Et voici ce que donne l’affichage depuis le site SPIP client :
Version 1.6.12
oembed-encoded.mp4
Premiers pas avec Spip
RSS 2.0
Vos commentaires
# Le 16 mai à 12:02, par RealET
En réponse à : oEmbed
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
# Le 16 mai à 13:37, par b_b
En réponse à : oEmbed
Je confirme, c’est du au fait que par défaut le plugin ne propose pas de modèle pour les rubriques, mais certains peuvent en fournir. Donc amha, il ne faut pas retirer ces liens du head pour les rubriques, mais plutôt fournir un modèle de base pour celles-ci afin que le lien ne pointe pas sur une 404.
# Le 16 mai à 16:55, par RealET
En réponse à : oEmbed
C’est donc ici https://zone.spip.org/trac/spip-zone/browser/_plugins_/oembed/oembed/output/modeles/article.json.html qu’il faudrait un équivalent rubrique.json.html
Et vu les traitements qui sont fait ici https://zone.spip.org/trac/spip-zone/browser/_plugins_/oembed/action/api_oembed.php#L40 il n’est absolument pas question de conditionner le lien à l’existence du modele.
Par contre, pour éviter des 404, je proposerais bien de rajouter un fallback.json.html qui se contenterait de donner les infos du site (nom site, slogan, descriptif).
Répondre à ce message
# Le 14 mars à 20:52, par SoirBleu
En réponse à : oEmbed
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
# Le 11 mars à 23:55, par Yohooo
En réponse à : oEmbed
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
# Le 27 février à 10:26, par baloo
En réponse à : oEmbed
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
# Le 18 décembre 2017 à 19:12, par philooo
En réponse à : oEmbed
j’ai un truc etrange quand j’insere via Oembed, le code source de ma page contient une balise qui ne devrait pas etre la, genre :
{ <html><figure class=’spip_documents spip_documents_center ressourceest ce que quelqu’un a deja eu ce problems ? debalise HTML qui s’insere de facon bizarre ?
pour info je suis en version SPIP 3.2 et dernier plugin oEmbed.
# Le 4 janvier à 02:33, par goony
En réponse à : oEmbed
En effet, le plugin semble intentionellement inserer son code dans un tag « html », qui ne passe pas la validation w3c. Quelle est la raison pour utiliser ce tag ?
# Le 4 janvier à 11:02, par b_b
En réponse à : oEmbed
Salut, comme in peut le voir dans le bloc « Dernières modifications » de cette page, cela vient de cette révision :
https://zone.spip.org/trac/spip-zone/changeset/107159
En résumé, le plugin utilise des balises HTML5 à partir de la version 2. Cela pose problème pour les sites qui sont encore en XHTML et non en HTML5, car insérer du XHTML dans du HTML5 est valide, mais pas l’inverse. En conclusion, restez sur la version 1 si votre site n’est pas en HTML5.
# Le 4 janvier à 11:25, par Cerdic
En réponse à : oEmbed
la balise
<html>est un raccourci de SPIP qui indique que ce qui suit ne doit pas être modifié par le moteur de raccourcis de SPIP. Cette balise est supprimée par le passage danspropre()et n’apparait normalement pas in fine# Le 8 janvier à 09:40, par goony
En réponse à : oEmbed
Pour philooo et moi-meme le filtre propre() ne semble pas s’appliquer, ou alors pas a la bonne etape. En tous cas on a toujours les balises « html » dans nos pages finales. J’ai essaye de remonter a la source pour voir la raison mais c’est assez complique le code a ce niveau.
# Le 21 février à 12:59, par Fred
En réponse à : oEmbed
Idem chez moi. Par contre forcer le passage par le filtre via
[(#TEXTE|propre)]supprime effectivement la balise<html>superfétatoire.Répondre à ce message
# Le 16 février à 18:32, par goony
En réponse à : oEmbed
J’ai constate que les videos de type « live » sur Facebook ne fonctionnent pas pour moi. Une video Facebook « normale » fonctionne en tous cas. Mais si c’est une video « live », que cela soit durant la diffusion, ou meme apres la diffusion (archive de la video), le plugin ne semble pas reccuperer le contenu oembed de la part de Facebook.
Voici un exemple de video live (archive) :
Le retour cURL du lien oembed est vide, d’apres le plugin. Pourtant, j’arrive a voir le retour en entrant l’URL dans un browser, ou bien meme en utilisant la ligne de commande curl du serveur :
https://www.facebook.com/plugins/video/oembed.json/?url=https%3A%2F%2Fwww.facebook.com%2Fcanterarealmadrid%2Fvideos%2F1672630512793157%2F&maxwidth=600&maxheight=400&format=json
Je ne comprends pas pourquoi l’appel cURL dans le code PHP du plugin ne trouve rien.
# Le 19 février à 15:28, par Cerdic
En réponse à : oEmbed
Le problème ne vient pas du plugin car si je teste dans une instance de SPIP locale ça marche très bien. Je soupçonne plutôt que l’IP du serveur en question a été bloquée par FB car faisant trop de requêtes ou quelque chose comme ça.
Il faut tester le curl depuis la même adresse IP que celle qui héberge le site par exemple.
Répondre à ce message
# Le 29 novembre 2017 à 16:50, par nicod_
En réponse à : oEmbed
Pour info, les embed Twitter et Mastodon ne sont plus compatibles SPIP 3.0 (à cause de recuperer_url).
# Le 14 décembre 2017 à 20:58, par philooo
En réponse à : oEmbed
pour info, je viens de tester, 14 decembre 2017, avec mon install 3.2 et la derniere version du plugin, youtube et twitter marche comme il se doit
# Le 14 décembre 2017 à 21:02, par nicod_
En réponse à : oEmbed
Je parlais bien de SPIP 3.0, pas 3.2.
Répondre à ce message
# Le 25 octobre 2017 à 19:24, par emma
En réponse à : oEmbed
franchement, merci ! c’est parfait !
juste un petit soucis de style pour le sous titre (figcaption) qui va me chercher un truc (style=width:120px ;) que je me demande où il a bien pu trouver ça !
en attendant, pour l’affichage public, je lui ai demandé de ne pas s’afficher ... reste à voir les conséquences car ce sont des class SPIP (.spip_doc_caption .spip_doc_titre) si quelqu’un a une idée ...
Répondre à ce message
# Le 11 octobre 2017 à 14:19, par ari
En réponse à : oEmbed
Bonjour,
je teste l’intégration de ce super plugin, mais je n’arrive pas à afficher les images incluses dans des tweets. Seul le lien vers l’image s’affiche (ainsi que le reste du tweet).
J’ai vérifié sur http://oembed.nursit.com, mais l’inclusion de tweets n’y fonctionne plus.
Une idée de piste ? Merci !
# Le 12 octobre 2017 à 21:02, par Cerdic
En réponse à : oEmbed
C’est pas un bug c’est une feature : on a choisit de ne surtout pas afficher l’iframe que twitter envoie car c’est un vrai mouchard et une plaie en performance.
Du coup on affiche en blockquote le contenu texte du tweet, mais on a pas de metadata pour afficher l’image.
Cela dit la version 1.9.0 du plugin ruse pour récuperer l’information de l’image principale du tweet dans le HTML de son URL et l’afficher en tête du blockquote comme dans la twitter card.
Je ne suis pas sur que ce sera robuste dans le temps car on ne maitrise pas ce que fait twitter et ça n’affiche qu’une image même si le tweet en avait plusieurs, mais c’est une amélioration :)
# Le 13 octobre 2017 à 14:16, par ari
En réponse à : oEmbed
Trop bien, merci ! La récupération d’image fonctionne nickel.
# Le 16 octobre 2017 à 11:16, par RastaPopoulos
En réponse à : oEmbed
Hello Cédric, l’autre jour tu me parlais effectivement de « iframe » mais du coup je suis allé voir la documentation, et apparemment ce n’est plus le cas.
https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-oembed
Si tu vas sur
https://publish.twitter.com/oembed?url=https%3A%2F%2Ftwitter.com%2FInterior%2Fstatus%2F507185938620219395
Dans « html » tu reçois désormais directement un « blockquote » avec un JS (mais le JS peut être désactivé avec une option lors de l’appel).
Donc leur code a-t-il changé depuis que tu as codé la récupération dans le plugin ? Et si ça n’utilise plus d’iframe, il faudrait plutôt repasser sur leur code officiel généré par défaut, pour être plus robuste et pérenne, non ? Surtout que leur serveur oembed gère pour tweet unique mais pour tout et n’importe quoi aussi (timeline complète, fiche utilisateur, etc, etc).
# Le 16 octobre 2017 à 11:50, par Cerdic
En réponse à : oEmbed
Non en effet c’est un JS chez twitter, pas une iframe, mais le principe est le même : on le vire pour ne garder que le blockquote statique, qui lui ne contient pas d’image. Mais j’ai amélioré le plugin pour récupérer l’image principale du tweet si il y en a une et l’afficher comme dans la card générée par le JS de twitter
# Le 16 octobre 2017 à 12:55, par RastaPopoulos
En réponse à : oEmbed
Ah ok je comprends mieux, je pensais que précédemment ils envoyaient une iframe et que donc tu avais fait un code proxy pour générer autre chose, mais qu’entre temps ils avaient changé ce qu’ils envoyaient. Donc là les images etc chez eux sont de toute façon récupéré en JS avec une requête supplémentaire ? Du coup ça ne change pas grand chose pour ça. Mais par contre oui pour la pérennité on ne sait pas si ça continuera toujours à bien la trouver par rapport à ce qu’ils font eux.
Je ne sais pas si quelqu’un a déjà réussi à faire un reverse du JS pour en proposer une version sans mouchardage, un truc comme ça… Même pas sûr que ce soit possible.
Répondre à ce message
# Le 4 juillet 2017 à 14:08, par kent1
En réponse à : oEmbed
Dans la dernière version (1.8.8), j’ai pas mal amélioré l’intégration de vidéos Facebook notamment.
Juste un petit message pour être notifié des fois que
# Le 5 juillet 2017 à 09:18, par b_b
En réponse à : oEmbed
Vu, merci mignon :)
Répondre à ce message