SPIP

#_n:BALISE

Suske — 2022-08-23T05:36:39Z

Il est parfois utile de vouloir récupérer le contenu d'une boucle parente de celle en cours, à travers une balise. SPIP dispose d'une écriture pour cela (n étant l'identifiant de la boucle voulue) :

#_n:BALISE

Exemple

Afficher systématiquement le titre de la rubrique en même temps que le titre de l'article :

   #_rubs:TITRE - #TITRE

Migration d'un SPIP 3.2.19 vers SPIP 4.4

Suske — 2014-06-08T15:54:34Z

Cette documentation concerne le passage à la dernière version stable de SPIP : SPIP 4.4.15 à ce jour.

Si votre site utilise une version antérieur à SPIP 3.2.19, on vous recommande de suivre ce premier article Migration d'un SPIP 1 ou 2 vers SPIP 3.2.19

La méthode proposée permet de partir sur des bases saines en effectuant un grand ménage dans les fichiers de SPIP et de repartir à zéro sur de nouveaux plugins (SPIP permet d'installer des plugins très rapidement).

Sommaire

Sauvegarde avant la migration

Sauvegarde de la base de données
- Si vous en avez la possibilité, il est sage de faire une sauvegarde de la base MySQL via PHPMyAdmin, disponible sur beaucoup d'hébergements, en faisant le choix d'une sauvegarde compressée.
- SPIP propose aussi un système de sauvegarde (récupérez par ftp le fichier généré dans tmp/dump)

Sauvegarde des dossiers personnels
- Récupérez par ftp les répertoires :

IMG
config
squelettes si son contenu doit être réutilisé

Avec la sauvegarde de votre base de données et le dossier IMG (qui contient tous les documents et images joints de votre site), vos contenus sont sauvegardés. config contient les infos de connexion à la base de données et squelettes vos personnalisations de squelette. Notez éventuellement la version précise de SPIP utilisée avant cette migration.

Mise à jour des plugins

Penser à mettre à jour vos plugins pour limiter les incompatibilités.

Les plugins non compatibles seront désactivés lors de l'installation de la nouvelle version.

Préparation de la migration

Vérifiez la version de PHP qui est exécutée sur votre serveur via https://example.com/ecrire/?exec=info.
SPIP 3 fonctionne avec les version PHP 5.4 à 7.4 et SPIP 4.4 nécessite PHP en version 7.4 minimum.

Ensuite vous aurez 2 possibilités pour la migration :

Solution manuelle

Téléchargez la dernière version de SPIP (Télécharger SPIP) puis décompressez l'archive dans un dossier spip de votre ordinateur
Créez par ftp le répertoire à la racine de votre site, sur le serveur : /ancienSpip
Déplacez dans celui-ci tous les dossiers plugins plugins-dist prive ecrire squelettes squelettes-dist local tmp et fichiers spip.php index.php, mais pas les dossiers config IMG
Transférer par ftp les répertoires et fichiers contenus dans le dossier local spip de votre ordinateur vers le dossier distant

Solution recommandée avec spip_loader.php

Récupérez le fichier spip_loader.php (ou copiez juste son contenu) sur votre ordinateur à partir de la page Télécharger SPIP
Déposez ce fichier à la racine de votre site, par FTP en mode binaire
Visitez votre site avec votre navigateur habituel et lancer la page spip_loader.php, en vous rendant à l'adresse du style : https://example.com/spip_loader.php et suivez les indications.

Mise à niveau de la base

En fonction du type de mise à jour, une procédure de mise à niveau de la base de données vous sera proposé en accédant à l'espace privé. Suivez les indications.

Consulter votre site. Normalement, il devrait s'afficher (sous l'apparence des squelettes par défaut de SPIP)
Se connecter sur l'interface privé de SPIP avec un compte administrateur (en cas de difficulté, se rendre à l'url /ecrire du site).
Suivre la procédure de maintenance proposée.
Se rendre ensuite sur la page de gestion des plugins (dans configuration)
Vérifier que le site fonctionne.

En cas de problème

Si besoin (si on n'arrive plus à accéder à l'espace privé du site, si des erreurs récurrentes s'affichent), il peut aussi être utile de réinitialiser certains fichiers temporaires de SPIP.

Il s'agit de vider le répertoire tmp sauf éventuellement les sous-répertoires dump, sessions et visites.

Pour cette opération : aller dans le dossier tmp et effacer tout sauf les dossiers dump et visites. Il vous faudra ensuite vous reconnecter.

Si un problème persiste, venez poser vos question sur le forum : https://discuter.spip.net/c/spip/6

Installation des plugins et squelettes

Créer les dossier suivant à la racine de votre site :

/plugins (puis dans ce dossier, créer le dossier auto)
/lib
/squelettes

Adaptez les droits de ces dossiers pour que le serveur puisse y écrire.

Se rendre dans l'interface de gestion des plugins et, dans « dépôts », utiliser le dépôt proposé - (important pour la mise en œuvre de la nouvelle gestion des plugins).

Installez les plugins nécessaires (les rechercher dans le moteur de recherche) au fonctionnement de votre site. Vérifiez que le site public fonctionne (éventuellement, vider le cache ou le répertoire tmp comme expliqué ci-dessus). Repassez en revue les réglages des plugins (cliquez sur l'icône de configuration après les avoir activés).

Rétablissez enfin si besoin vos personnalisations de squelettes en remettant progressivement les fichiers html dans votre dossier squelettes. Vérifiez que chacun produit bien le résultat souhaité.

Ménage

Quand tout est terminé :

vérifiez que les autres applications installées sur l'hébergement fonctionnent.
vérifiez le contenu du dossier /ancienSpip. Celui-ci ne devrait contenir que des dossiers et fichiers issus de votre ancien SPIP (ecrire, local, tmp, squelettes-dist ou dist, extensions et quelques fichiers)
supprimez finalement le dossier /ancienSpip.

À propos de cette documentation

Auteurs

Michel Suquet
Johan Pustoch

Adaptations

Collectif SPIP

_TEST_EMAIL_DEST

b_b, Suske — 2010-12-26T17:15:45Z

Pour ne plus spammer en période de test... SPIP vous propose de rediriger tous les e-mails envoyés par le site vers une adresse déterminée à l'avance.

La constante _TEST_EMAIL_DEST permet de tester les envois de mails en remplaçant tout destinataire par l'adresse définie dans la constante. Par exemple, si on définit dans mes_options.php (voir Le fichier mes_options.php) :

define('_TEST_EMAIL_DEST', 'utilisateur@domaine.tld');

C'est "utilisateur" qui reçoit tous les mails expédiés par SPIP (mails d'inscription, de notification, etc).

Pour que personne ne reçoive de mail :

define('_TEST_EMAIL_DEST', '');

Vous pouvez aussi indiquer plusieurs adresses en les séparant par une virgule.

Utiliser dans les pages publiques les formulaires CVT de l'espace privé

b_b, Suske — 2010-12-08T23:48:18Z

Les formulaires CVT de l'espace privé de SPIP sont aussi utilisables dans les squelettes publics. Ils permettent de créer ou de modifier des éléments comme les articles, les rubriques, etc.

Ces formulaires sont construits à partir des fichiers disponibles dans le répertoire /prive/formulaires où, pour chaque formulaire, on dispose d'un couple de fichiers du type :

editer_xxx.html
editer_xxx.php

Pour plus d'informations sur le fonctionnement de ces balises lisez l'article Les formulaires CVT de SPIP.

Remarque : certains des formulaires présentés dans cet article utilisent le script /prive/javascript/layer.js, pensez à insérer celui-ci dans vos squelettes.

FORMULAIRE_EDITER_ARTICLE

#FORMULAIRE_EDITER_ARTICLE{id_article, id_rubrique, retour, lier_trad}

Paramètres de la balise :

id_article détermine l'identifiant de l'article à modifier. S'il vaut « oui » le formulaire va créer un nouvel article.
id_rubrique détermine l'identifiant de la rubrique contenant l'article à éditer.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.
lier_trad permet d'indiquer que l'article créé est une traduction de celui passé dans le contexte.

FORMULAIRE_EDITER_RUBRIQUE

#FORMULAIRE_EDITER_RUBRIQUE{id_rubrique, id_parent, retour, lier_trad}

Paramètres de la balise :

id_rubrique détermine l'identifiant de la rubrique à modifier. S'il vaut « oui » le formulaire va créer une nouvelle rubrique.
id_parent détermine l'identifiant de la rubrique contenant la rubrique à éditer.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.
lier_trad permet d'indiquer que la rubrique créée est une traduction de celle passée dans le contexte.

Par exemple, pour créer une rubrique depuis une page rubrique :

[(#FORMULAIRE_EDITER_RUBRIQUE{oui, #ID_RUBRIQUE, [(#SELF|parametre_url{id_rubrique, #ID_RUBRIQUE})]})]

FORMULAIRE_EDITER_AUTEUR

#FORMULAIRE_EDITER_AUTEUR{id_auteur, retour, lier_id_article}

Paramètres de la balise :

id_auteur détermine l'identifiant de l'auteur à modifier. S'il vaut « oui » le formulaire va créer un nouvel auteur.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.
lier_id_article permet d'attacher l'auteur à un article lors de la création.

FORMULAIRE_EDITER_GROUPE_MOT

#FORMULAIRE_EDITER_GROUPE_MOT{id_groupe, retour}

Paramètres de la balise :

id_groupe détermine l'identifiant du groupe de mots à modifier. S'il vaut « oui » le formulaire va créer un nouveau groupe.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.

FORMULAIRE_EDITER_MOT

#FORMULAIRE_EDITER_MOT{id_mot, id_groupe, retour, ajouter_id_article, table, table_id}

Paramètres de la balise :

id_mot détermine l'identifiant du mot à modifier. S'il vaut « oui » le formulaire va créer un nouveau mot.
id_groupe détermine l'identifiant du groupe contenant le mot à éditer.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.
ajouter_id_article permet d'attacher le mot à un objet lors de la création.
table permet d'indiquer le type d'objet auquel on va lier le mot lors de la création (« articles » pour un article).
table_id permet d'indiquer le nom du champ représentant l'id de l'objet auquel on va lier le mot lors de la création (« id_article » pour un article).

FORMULAIRE_EDITER_SITE

#FORMULAIRE_EDITER_SITE{id_syndic, id_rubrique, retour, lier_trad}

Paramètres de la balise :

id_syndic détermine l'identifiant du site à modifier. S'il vaut « oui » le formulaire va créer un nouveau site.
id_rubrique détermine l'identifiant de la rubrique contenant le site à éditer.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.
lier_trad permet d'indiquer que le site créé est une traduction de celui passé dans le contexte.

FORMULAIRE_EDITER_BREVE

#FORMULAIRE_EDITER_BREVE{id_breve, id_rubrique, retour, lier_trad}

Paramètres de la balise :

id_breve détermine l'identifiant de la brève à modifier. S'il vaut « oui » le formulaire va créer une nouvelle brève.
id_rubrique détermine l'identifiant de la rubrique contenant la brève à éditer.
retour permet de définir l'URL vers laquelle l'utilisateur sera redirigé une fois le formulaire validé.
lier_trad permet d'indiquer que la brève créée est une traduction de celle passée dans le contexte.

Restreindre l'affichage des formulaires

Si les actions appelées lors du traitement du formulaire sont sécurisées par les mécanismes internes de SPIP, il est important de noter que ces formulaires sont accessibles à tout le monde à partir du moment où vous les placez dans un squelette public.

Pour restreindre l'affichage d'un formulaire dans un squelette vous pouvez utiliser les balises #AUTORISER ou #SESSION.

Par exemple, pour afficher un formulaire de création d'article uniquement aux administrateurs du site :

[(#SESSION{statut}|=={0minirezo}|oui) #FORMULAIRE_EDITER_ARTICLE{oui, #ID_RUBRIQUE} ]

Personnalisation

Il est possible de personnaliser un formulaire par deux mécanismes :

Surcharge il faut créer une copie des fichiers…

editer_xxx.html
editer_xxx.php

…dans un répertoire /squelettes/formulaires/ et procéder aux changements voulus.

Attention toutefois : les formulaires ainsi surchargés seront désormais utilisés dans l'espace privé où ils remplaceront les originaux.

Pipeline : un pipeline permet de modifier le contenu du fichier editer_xxx.html ou le résultat par défaut des fonctions contenu dans editer_xxx.php de n'importe quel formulaire CVT.

C'est la méthode qu'il faut privilégier dans un plugin.

La fonction test_espace_prive() qui indique si l'on est dans l'espace privé ou pas peut aussi vous être utile.

Voir aussi

Dans l'idée de personnaliser un formulaire existant, la lecture des trois articles suivants et plus particulièrement du paragraphe "Champs particuliers" vous sera très utile.

Sur Programmer.spip.net

la rubrique sur le fonctionnement des pipelines

puis au cas par cas…

le pipeline formulaire_fond qui permet de personnaliser le code HTML d'un formulaire ;
le pipeline formulaire_charger ;
le pipeline formulaire_verifier ;
le pipeline formulaire_traiter.

_MAX_MOTS_LISTE

Suske — 2010-12-06T14:40:12Z

Au-delà d'un certain nombres de mots clés, parcourir une liste simple devient fastidieux. SPIP propose un système déclenchant l'apparition d'un champ de recherche au lieu de la liste de mots clefs.

Par défaut, cet affichage alternatif se déclenche à partir du 50e mot-clé. Comme il se doit, cette valeur est une constante que vous pouvez donc modifier pour coller à vos personnalisations : _MAX_MOTS_LISTE

Il est possible de définir cette constante dans votre fichier config/mes_options.php (voir Le fichier mes_options.php)

Exemple :

// afficher le champ de recherche de mots-cles dès qu'il y en a plus de 10 define('_MAX_MOTS_LISTE', 10);

|is_null

Suske — 2010-11-23T17:19:15Z

Une fonction PHP utilisée comme filtre et qui s'applique à la balise #ENV. Elle permet de tester l'existence ou non d'une variable dans l'environnement SPIP.

Il est parfois nécessaire de différencier une variable de « contenu vide » d'une variable « inexistante ». Ce filtre est là pour vous y aider. Il s'applique à la balise #ENV{blabla} et permet donc de tester l'existence ou non de la variable "blabla" dans l'environnement du squelette.

[(#ENV{blabla}|is_null)]

Ce code retourne "1" si la variable "blabla" est nulle (inexistante) ou rien si elle est non nulle (présente) [1].

Ce filtre ne s'applique pas aux variables déclarées avec #SET dont la valeur n'est pas présente dans l'environnement mais uniquement dans le squelette.

[1] Attention : ne pas confondre « variable nulle », c'est à dire inexistante, et « variable vide », c'est à dire présente dans l'environnement mais sans valeur affectée.