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).
  • désactiver l’insertion des entêtes qui déclarent le site comme provider

Youtube

Pour les vidéos issues de Youtube, le plugin ajoute automatiquement deux options:

  • pour ne pas lister les vidéos liées en fin de lecture
  • les vidéos sont intégrées depuis le nom de domaine youtube-nocookies.com pour ne pas déposer de cookies supplémentaires à l’internaute (respect de la vie privée).

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 spip-contrib-extensions/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 :

Discussion

59 discussions

  • 1

    Bonjour,

    J’utilise cet excellent plug-in depuis quelques temps déjà sur quelques sites. Passée à SPIP 3.1 tout récemment, j’ai donc voulu y intégrer la dernière version de Oembed, et je me suis heurtée à un problème, sur les pages publiques uniquement, le bouton play ne fonctionne pas et j’ai ce message par dessus la vidéo :

    onclick="if (jQuery(this).is(’.oe-play-button’))jQuery(this).removeClass(’oe-play-button’).addClass(’loading’).html(decodeURIComponent(’%3Ciframe%20width%3D%22500%22%20height%3D%22281%22%20src%3D%22https%3A%2F%2Fwww.youtube.com%2Fembed%2Fw5UwkdH2dPU%3Ffeature%3Doembed%26autoplay%3D1%22%20frameborder%3D%220%22%20allowfullscreen%3E%3C%2Fiframe%3E’));"
    >

    Je précise que ça fonctionne en partie privée… Et que j’ai désactivé tous les autres plugins pour éliminer les pistes. Enfin, ne sachant plus quoi tester, j’ai mis une ancienne version de Oembed, version 1.2.3, et là tout fonctionne parfaitement.

    Je me pose donc la question : y a-t-il un bug sur cette version, une incompatibilité avec spip 3.1 ? Suis-je la seule à avoir ce problème ?

    D’avance merci pour vos réponses,
    Karen

    • Bonjour,

      Je me réponds à moi-même et je n’avais pas assez bien cherché, ça venait de mon squelette, un filtre |propre qui traînait sur mon appel #TEXTE, là où je croyais avoir tout remis à zéro… Ô fatigue ennemie !

      Tout fonctionne parfaitement, et je trouve toujours ce plugin absolument génial ! Merci encore à ses créateurs :-)

      Bonne journée

    Reply to this message

  • 5

    Hello !

    lorsque j’insère l’url d’une vidéo dans un article, j’ai ce message d’erreur si je recalcule la page (var_mode=recalcul) :
    Warning: curl_setopt() [function.curl-setopt]: Invalid curl configuration option in /*CHEMIN_DEPUIS_RACINE*/plugins/oembed/inc/oembed_recuperer_url.php on line 38

    Par contre, l’erreur n’apparait pas en l’affichage “normal” ni en ?var_mode=calcul

    La page en question : http://www.lesreportagesdufourneau.com/Cie-G-BISTAKI-Cooperatzia-le-chemin.html

    Pour info : SPIP 3.0.21 / oEmbed 1.6.0 / PHP 5.2.17 (l’hébergement ne date pas d’hier !)

    Merci,

    jean marie

    Reply to this message

  • 1

    Savez vous si il est possible de lancer automatiquement la lecture d’une vidéo inétgrer via oembed ?
    Merci.

    Reply to this message

  • 1

    Bonjour,

    En cas d’utilisation de youtube et d’un proxy, le plugin ne fonctionne plus car il ne prend pas les paramètres proxy de SPIP.

    Cela se corrige facilement en ajoutant ces lignes dans le fichier inc/oembed_recuperer_url.php

    $http_proxy = isset($GLOBALS['meta']["http_proxy"]) ? $GLOBALS['meta']["http_proxy"] : null;
    $http_noproxy = isset($GLOBALS['meta']["http_noproxy"]) ? $GLOBALS['meta']["http_proxy"] : null;
    curl_setopt($c, CURLOPT_PROXY, $http_proxy);
    curl_setopt($c, CURLOPT_NOPROXY, $http_noproxy);

    juste avant la ligne “// the real trick for Youtube :”

    Reply to this message

  • 2

    bonjour,

    super plugin, vraiment, mais je galère pour un utilisateur qui me demande de ne pas afficher les propositions de vidéos à la fin, exactement comme quand on mets &rel=0 dans le code embed proposé par youtube. j’ai essayé de faire suivre l’url de youtube de &rel=0 mais ça ne fonctionne pas.
    en regardant le code, pour ce que j’y comprends, il semble que le cas de &rel=0 soit pris en compte, mais apparemment ça ne passe pas.

    le fichier en question est “posttraite_youtube.php”. voici un extrait du code (ligne 17 à 20)

    // On regarde si l’attribut rel est placé dans l’URL
    // pour éviter l’affichage des vidéo liées à la fin de la vidéo
    if (strpos($url_orig,“&rel=0”) OR strpos($url_orig, “?rel=0”))
    $data[’html’] = str_replace(’feature=oembed’, ’feature=oembed&rel=0’, $data[’html’]);

    comme c’était un échec, j’ai essayé de placer un css dans le head.

    .ytp-endscreen-content
    display:none;

    mais comme youtube charge son propre css dans son petit iframe, ma définition de la class est ignorée... en plus ce n’est pas très propre comme méthode, n’est-ce pas ?

    j’aimerais donc, dans la mesure du possible, que :
    -  il tienne compte de &rel=0
    -  que je puisse éventuellement forcer ça de telle sorte que l’admin ne soit pas obligé d’ajouter &rel=0 à la main à la fin de chaque url. il colle l’url et à la fin de sa vidéo, pas de propositions d’autres vidéos.

    quelqu’un pour m’aider ?

    d’avance merci à toutes et tous.

    • Salut, la version 1.5.2 devrait corriger ce problème et rétablir la prise en compte du rel=0 dans les url youtube, cf :

      http://zone.spip.org/trac/spip-zone/changeset/93342

      Si tu veux le forcer de manière globale, tu peux surcharger la fonction oembed_input_posttraite_youtube_video() pour y appliquer le rel=0 tout le temps.

      ++

    • extra !
      un super grand merci.
      je vais essayer de surcharger le code pour forcer le rel=0... je tiens au courant.

    Reply to this message

  • 1

    En spip 3.1 la syntaxe avec chevrons ne fonctionne pas

    <https://www.youtube.com/watch?v=2OosbvghhoE> appelle le modèle IMG mais pas oembed/modeles/oembed.html ni oembed/modeles/oembed_video.html

    Sans les chevrons avec juste l’url https://www.youtube.com/watch?v=2OosbvghhoE c’est bien les modèles d’oembed qui sont appelés.

    Une idée pour conserver la compatibilité avec la syntaxe avec chevrons ?

    Merci beaucoup

    • Salut Alex, je confirme le bug, mais avec un résultat différent, <url_video_viemo> génère le html suivant :

      <span class="ressource spip_out">&lt;<a rel="external" class="spip_url spip_out" href="http://vimeo.com/14524019">url_video_viemo</a>&gt;</span>

    Reply to this message

  • 4

    Bonjour,

    J’essaie d’empêcher la vidéo de se lancer automatiquement mais <embxx|autostart=0>
    <embxx|autostart=false>
    n’ont aucun effet.
    Y-a-t-il un autre moyen ?

    Merci
    dd

    PS c’est un jeu en flash / html5 avec du son, pas top

    • Salut, c’est quoi l’url de la ressource en question ?

    • Un truc du genre

      site.com/story_html5.html

      dd

    • Heu oui... mais en fait je suis pas très motivé pour jouer aux devinettes aujourd’hui ^^

      Je répète, c’est quoi la vraie url de la ressource en question ?

    • Hello,

      Je t’enverrai l’URL lorsqu’il sera publié (si je n’ai pas résolu le problème d’ici là)

      merci
      dd

    Reply to this message

  • 1
    ashledombos

    Bonjour, je voulais savoir quelle ligne de htaccess permet d’interpréter correctement l’api car j’utilise nginx, et j’ai des erreurs 404 sur les retours api...
    merci :)

    Reply to this message

  • 1

    Les tweets avec des images et les publications Instagram ne s’affichent pas correctement, a priori à cause des traitements CSS. L’un de vous peut y regarder ? Je n’ai pas bien compris toutes les subtilités de la feuille de style.

    Reply to this message

  • 2

    Bonjour,

    En SPIP 3.0.17 j’ai le message suivant dans l’espace privé :

    Erreur dans les plugins : /*********/plugins/auto/oembed/v1».4.3/oembed_pipelines.php

    Tout semble fonctionner cependant

    Valéry

    • Salut Valéry, l’erreur en question est-elle toujours présente ?

    • Non, le message ne s’affiche plus à présent (sans action particulière de ma part).

    Reply to this message

Add a comment

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite / PostgreSQL
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparait.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Who are you?
[Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom