Il y a 6 ans(!) presque jour pour jour, j'avais lancé le Planet eZ Publish.org.fr, ze French corner avec eZ Publish 4.0.1 apparemment ! J'avoue que je ne me souviens plus trop des détails mais je vois en relisant les différents posts que j'ai expérimenté pas mal de trucs avec ce site.

Mais pour être honnête, depuis la migration vers eZ Publish 5.0, le site est en roue libre sans une grande motivation de ma part pour le maintenir et ni le faire vivre. D'ailleurs, il faudrait le renommer Planet eZ Platform maintenant :-) Aussi, une très large partie des sources sont mortes ou les liens pointent dans le vide… Hé Cool URIs don't change ou au moins redirigent vers une ressource correspondante ! </râlage>

Du coup, d'ici quelques jours, je vais arrêter le script de mise à jour et faire un export statique du site pour le garder en ligne en mode zéro maintenance. Si quelqu'un veut reprendre le flambeau, je suis prêt à donner un petit coup de main, mais en attendant clap, rideau !

eZ Platform 15.12 est sorti le 15 décembre ! La sortie d'une nouvelle version est toujours au moins un petit évènement mais celle-ci représente un peu plus que ça. En effet, il s'agit de la première version stable d'eZ Platform, techniquement il s'agit de la 1.0.1, eh oui 1.0.x !

Au dela de ce numéro symbolique, quelque part eZ Publish est en train de tirer sa révérence après un bon paquet d'années de service. Et je dois dire que ce changement signifie quelque chose pour moi, je suis utilisateur d'eZ Publish depuis plus de 10 ans maintenant (!) et ce blog était même à l'origine une expérimentation autour de ce CMS qui s'appelait alors "eZ publish" :) Bon après, si on gratte un peu, on peut voir qu'eZ Platform dépend notamment d'un (gros) paquet appelé ezpublish-kernel, la bête est encore vivante ;-)

Plus sérieusement, eZ Platform est la réécriture d'eZ Publish, en gros on a gardé les concepts mais ils sont mis en œuvre avec du code moderne, de bien meilleur qualité, mieux découpé, testé et basé notamment sur l'excellent Symfony.

Une nouvelle version est toujours qu'une étape vers les suivantes. Les Fast-Track Releases vont maintenant se succèder tous les 2 mois. En toute logique la prochaine sera la 16.02 et évidemment on travaille déjà dessus notamment dans le but d'améliorer l'éditeur de texte riche, de donner accès à la corbeille, de permettre la migration de XmlText vers RichText (de l'ancien Field Type de texte riche vers le nouveau) et de permettre la modification les droits des utilisateurs. Attention : cette liste n'est ni exhaustive, ni une promesse. Aussi, eZ Platform est un logiciel libre, toutes les contributions (sur ces sujets comme sur d'autres) sont comme toujours les bienvenues que ce soit par un rapport de bug, un bout de code dans une pull request ou simplement du feedback sur la documentation, les rapports de bug existants par exemple. Alors, à vos claviers.

Pour rappel, les slides et le code associé (il y a un tag par étape) sont disponibles en ligne, ce qui facilitera aussi le suivi de la conférence vue la taille réduite des écrans dans cette salle et les quelques problèmes de son avec le micro de Patrick :(

Si vous étiez présent ou même à partir de cette vidéo, il est encore temps de noter et commenter notre présentation sur joind.in.

Les vidéos des autres conférences arrivent progressivement sur le compte Youtube de l'AFUP, je ne peux que vous conseillez de suivre les mises en lignes, certaines méritent vraiment d'être vues.

Les slides sont disponibles en ligne avec le code associé, le ForumPhp2013DemoBundle sur GitHub. L'idée était de présenter quelques uns des principaux concepts du CMS eZ Publish 5 (au passage la version 5.2 est sortie cette semaine):

• les types de contenu
• eZ Publish 5 est une application Symfony2
• la flexibilité du CMS et la manière de construire un vrai site

Dans la partie pratique, nous avons construit le site d'une conférence PHP comme le Forum PHP pour montrer les fonctionnalités suivantes: (les liens pointent vers la diff correspondant sur GitHub)

1. Comment écrire une règle d'override pour la vue full pour utilisé un template spécifique
2. Comment en plus utilisé un controller spécifique pour injecter des données supplémentaires
3. Comment organiser les templates en utilisant des sub-views
4. Exemple d'utilisation des sub-views et de controllers spécifiques

Après ces étapes, nous avons aussi modifié un type de contenu pendant la conférence et adapté le template pour prendre en compte le nouvel attribut (Un fichier à télécharger).

Si vous étiez présent, merci de noter et commenter notre présentation sur joind.in et dans le cas contraire, la vidéo devrait bientôt être disponible en ligne la vidéo de la conférence est disponible.

L'application

Le code de cette application est disponible sur GitHub dans le dépôt eZunConf2013-REST-API-demo et elle est installable sur n'importe quel eZ Publish 5 suffisament récent. Avec un navigateur moderne supportant l'API getUserMedia/Stream, elle permet de prendre une photo avec la webcam de votre ordinateur et de créer un objet Image à partir de celle-ci dans eZ Publish ! Voici un rapide screencast de l'application en action:

Ce genre de fonctionnalité aurait typiquement sa place sur n'importe quel site où les utilisateurs devraient avoir une vraie photo sur leur profil comme un réseau social, un intranet d'entreprise, un site communitaire, …

Quelques détails techniques

• Dans le screencast, le navigateur demande à l'utilisateur de s'identifier car l'application utilise l'authentification Basic (la méthode d'authenfication par défault de l'API REST). Avec quelques modifications mineures, l'authenfication par session est aussi utilisable.
• 6 requêtes HTTP sont nécessaires à la création du contenu et à la récupération de son URI. Ce chiffre relativement important est dû à la division fine des ressources (il s'agit d'une bonne pratique dans le design d'une API REST). Autre point sur les ressources, les URIs ne devraient jamais être construites par le client REST, mais toujours récupérées depuis une réponse précédente. Des API clientes (en PHP et en JavaScript) sont en cours d'écriture et elles devraient permettre de largement simplifier le code en évitant d'avoir à travailler au niveau requêtes HTTP.
• L'application doit être sur le même domaine qu'eZ Publish. Il s'agit d'une limitation imposée par les navigateurs. Il est possible de contourner ce problème mais je n'ai juste pas eu le temps de me pencher en détail là dessus.

Pour de plus amples détails, je vous laisse examiner le code JavaScript. Merci d'être indulgent sur la qualité du code, cet exemple a vraiment été écrit rapidement et dans le but d'être très simple à comprendre. J'espère avoir le temps d'écrire une version plus propre et plus avancée prochainement.

Ressources au sujet de l'API REST v2 d'eZ Publish

• Les spécfications de l'API REST v2
• createcontent.sh par Bertrand Dunogier
• Un ensemble de scripts de test par Edi Modrić
• Using the eZ Publish REST API v2 with cURL publié ici-même il y'a quelques temps

Pour commencer, la version initiale a été ajoutée par Joe Kepley via une pull request. Il mérite un grand bravo pour ça :-)

Ensuite, en travaillant sur une amélioration, j'ai ajouté la possibilité de définir ce pagelayout par siteaccess ou groupe de siteaccess. Il n'y a pas de configuration sémantique, donc pour configurer le pagelayout à utiliser avec les modules legacy, il faut écrire la configuration suivante dans ezpublish.yml :

parameters:
  ezpublish_legacy.planete.module_default_layout: PlanetBundle::pagelayout.html.twig

Dans cet exemple, planete est le nom du siteaccess et la valeur est évidemment le chemin vers le template.

Enfin, avec quelques changements, le même pagelayout peut être utilisé pour les modules legacy comme pour le reste du site. Le principal changement et potentiellement le seul à apporter concerne le block content pour qu'il tienne compte de l'éxécution d'un module legacy. Une simple condition sur la variable module_result permet de détecter le contexte :

<!DOCTYPE html>
<html lang="fr-FR">
<!-- ... -->

<body>
{% block content %}
    {% if module_result %}
        {# we are in a legacy rendered module #}
        {{ module_result.content|raw }}
    {% endif %}
{% endblock %}
</body>
</html>

Rien de compliqué, non ? Il s'agit là d'un des nombreux ponts entre eZ Publish legacy et la nouvelle stack eZ Publish 5. Vous voulez en apprendre plus ? Si j'étais vous, je m'inscrirais à la prochaine eZ UnConference #2. Sans conteste, le moyen le plus rapide de tout apprendre ou presque sur eZ Publish 5!

Mise à jour à 14h30: cette fonctionnalité est documentée avec un exemple utilisant l'héritage de template Twig.

Nouvelle stack vs. legacy

Au final, il reste 3 fonctionnalités basées sur la partie legacy :

• Le formulaire de contact, les attributs collecteur d'information n'étant pas pris en charge pour le moment
• Le moteur de recherche, là encore l'intégration de Solr est incomplete
• Un script de nettoyage de la partie planétarium, pour ce dernier point, j'avoue que c'est par pure flemme :-)

À l'inverse, le reste du site n'utilise que les nouvelles API et le moteur de template Twig:

• Les différentes vuesdes contenus (règles d'override)
• Le flux RSS sur mesure est une simple action d'un contrôleur derrière la route adhoc
• Le script d'import utilise l'API publique pour créer et mettre à jour les contenus à partir des flux RSS

Bugs et difficultés diverses

Sans surprise, il y a quelques bugs dans cette nouvelle version; pour une version majeure en point 0, le contraire aurait été très étonnant, mais il y a aussi des manques plus globaux.

D'une manière générale, l'API publique est très verbeuse. J'ai publié un gist qui compare le code nécessaire pour récupérer une liste de nœuds triée par priorité dans l'ancienne et la nouvelle API. Je crois que le constat est assez clair. Pour éviter de répéter encore et encore, les mêmes bouts de code, j'ai 2 méthodes utilitaires dans une surcharge du Location service. Avec le recul, ce n'est probablement pas la meilleure manière de faire, mais en tout cas, cette petite addition m'évite de me répéter.

Les templates eZ Publish 5 sont radicalement différents des templates eZ Publish 4.x. Et c'est pas uniquement une question de langage. Le point le plus impactant est la disparition de nos bonnes vieilles fonctions fetch. Il s'agit d'une excellente chose en terme d'architecture technique mais en l'état elle complexifie un peu l'écriture de template. Il est en effet assez rare de pouvoir se contenter du contenu et de l'emplacement de ce contenu pour générer la vue d'objet. Dans ce cas, une solution est d'appeler dans une sous requête une action d'un controller custom (voir par exemple la vue full correspondant à la page d'accueil). Une autre solution consiste à utiliser l'évènement ezpublish.pre_content_view mais cet évènement est générique ce qui oblige à détecter d'une manière ou d'une autre dans quel cas l'évènement est lancé ce qui n'est pas forcément évident (voir par exemple PlanetBundle/EventListener/PreContentViewListener.php). Bref, pour moi il manque quelque chose ici qui permette de facilement injecter des paramètres dans les templates de vue.

En tant qu'ancien intégrateur, j'espère qu'on pourra remédier à ces deux points pour rendre le au jour le jour développement un peu plus facile.

Performances

Qu'en est il des performances ? Contrasté est probablement le terme le plus adapté. En effet, sur un site sans identification et peu d'évolution dans le contenu, il est relativement facile de maximiser l'utilisation du cache HTTP et de finalement atteindre les performances du reverse proxy Symfony 2. Dans ce cas eZ Publish 5 est assez nettement supérieur à eZ Publish 4.x qui servirait une page complètement cachée et optimisée (cache-block + viewcache)! Si, le reverse proxy de Symfony se révèle trop lent, il est bien sûr possible de le remplacer par un reverse proxy dédié; dans ce domaine Varnish est un candidat de choix qui apportera de bien meilleures performances encore!

En revanche, lorsque des parties de la page doivent être recalculées, les performances s'effondrent rapidement. Un chantier est en cours pour améliorer les performances des API et cela devrait durer quelques temps.

Conclusion

ÇA FONCTIONNE! À vrai dire plutôt mieux que je ne l'aurai cru il y a quelques mois! Bien sûr il reste bien des bugs à corriger et des choses à améliorer, mais clairement eZ Publish 5 est utilisables dans pas mal de cas et pour tout le reste il y a le legacy fallback :-)

On most of my sites, I tend to adopt the following folder layout:

/web/sites/planet-ezpublish.fr$ find . -maxdepth 2 -name www\* -o -name var -ls | tr -s ' ' | cut -d ' ' -f 11-14
./wwwnewdesign/var -> ../var/
./www44/var -> ../var
./var
./www2012.5/var -> ../var
./www -> wwwnewdesign

As you can see, www (the Apache document root) and www<version>/var are symlinks. The main idea behind this organization is to ease upgrades from an eZ Publish version to another, after upgrading on my developer machine and uploading the code to /web/sites/mywebsite.com/www<version> , I just have to change the symlinks on the disk and I'm done!

Cache issues

I know that some others are using a quite similar setup but Nicolas and Arnaud seem to encounter caching issues with it. At first, I answered that this is working as expected for me, but a while after, I discovered that I also have some cache issues on Planet eZ Publish.fr (mainly cache-block not being expired) while the same setup on pwet.fr/t-ka.net does not seem to be affected.

Actually, this comes from the configured file handler. pwet.fr/t-ka.net eZ Publish instance is configured with the eZFS2FileHandler while Planet eZ Publish.fr was configured with eZFSFileHandler . And there is a big difference between those file handlers: when a cache file is outdated, eZFSFileHandler will try to remove it while eZFS2FileHandler just sets a specific last modified time to mark it as expired (this is the base of the stale cache mechanism). In addition, a protection had been added in eZ Publish (and it's enabled by default) to not let it remove files that are outside of the eZ Publish directory, and of course, this is the case with the symlink layout above. So the cache issue is not a bug, it's a feature ;-)

So if you want to use this kind of setup, you have to configure your eZ Publish instance with the eZFS2FileHandler. But keep in mind, that eZFS2FileHandler is still a bit experimental and that 2012.4 and 2012.5 community releases were affected by this bug, so you'd better apply this patch to keep your images!

Attention, la peinture est toute fraîche sur le Planet eZ Publish.fr! Après la migration du code sur GitHub et la mise à jour d'eZ Publish 4.4 vers eZ Publish Community Project 2012.5 il y a une dizaine de jours, j'ai donné un gros coup de frais au design du site. Ce nouveau design se veut évidemment plus sympa et est aussi responsive pour une mise en page optimisée en fonction des capacités de la plate-forme utilisée. En principe, il ne devrait pas y avoir de problèmes d'affichage sur les navigateurs modernes et même avec Internet Explorer 8 et supérieur mais je ne suis pas maso, j'ai pas cherché la compatibilité avec les versions 6 et 7 même si ça ne doit pas être si terrible :-)

J'en ai aussi profité pour intégrer eZ Find et Solr ce qui m'a donné l'occasion de mettre en place le nouveau mécanisme de plugin lors de l'indexation permettant notamment d'ajouter des champs spécifique dans l'index Solr ce qui est utile dans mon cas pour générer les facets par auteur (qui ne sont pas des auteurs au sens eZ Publish du terme).

Comme d'habitude, les commentaires, inscriptions, rapports de bug ou même les pull requests sont les bienvenues !

En plus de cela, plusieurs améliorations du formulaire d'édition dans l'interface d'administration avaient déjà été ajoutées dans les dernières versions:

• le mode plein écran a été supprimé pour être remplacé par un barre d'outil fixe en haut de l'écran pour avoir à disposition les principaux boutons;
• le menu de gauche peut être caché, son état est stocké dans une préférence pour le conserver après un rafraîchissement de page;
• dès que vous scrollez vers le bas, un lien pour retourner en haut du formulaire fait son apparition;
• l'extension ezautosave fait en sorte de sauvegarder automatiquement le brouillon en cours pendant l'édition;
• l'extension ajoute aussi le lien de prévisualisation mentionné ci-dessus dans la barre d'outil fixe

Une image vaut mille mots, qu'en est il d'une vidéo ? ;-)

(Visualisation en HD fortement conseillée)