Le plugin saveauto : sauvegarde automatique de la base de données de SPIP

Le plugin saveauto permet de réaliser automatiquement une sauvegarde de la base de données de SPIP selon une fréquence et des paramètres configurables.

Un des soucis récurrent du webmestre d’un site sous SPIP c’est d’avoir la certitude qu’en cas de « crash » de son site (serveur planté, mauvaise manip...) il puisse récupérer l’ensemble des données de la base MySQL afin de pouvoir rétablir son site « à l’identique ».

Cela implique d’avoir une sauvegarde de cette base de données qui inclut tous les éléments saisis par les utilisateurs (articles, brèves, sites référencés, auteurs...) au fur et à mesure que ceux-ci enrichissent le contenu du site.

Alors si votre site est actif, à moins que vous ne soyez un forcené de la sauvegarde manuelle en utilisant l’outil intégré dans l’administration de SPIP, il y a fortes chances que votre dernière sauvegarde ne soit pas à jour...

Ce plugin, reprise d’une « vieille » contrib de Silicium (publiée à l’époque sur le site japanim.net), permet d’automatiser le processus de sauvegarde de votre base de données afin que vous n’ayez jamais à annoncer à vos rédacteurs que « ...le serveur à planté, il va falloir refaire la saisie de vos n derniers articles... ».

1. Ce plugin permet :

  • de réaliser une sauvegarde complète de la base de données du SPIP selon une fréquence déterminée. Cette sauvegarde est au format .sql (ou gzippé si votre serveur le permet). Elle est totalement compatible avec le format des fichiers sql utilisés par votre phpmyadmin.
  • de paramétrer les tables à sauvegarder (ou au contraire à ne pas sauvegarder) : la sauvegarde étant réalisée au niveau de la base, par défaut elle comprend l’ensemble des tables (pas seulement celles de SPIP) mais vous pouvez configurer précisément les tables que vous désirez inclure dedans.
  • de stocker ces sauvegardes dans un répertoire de votre choix
  • d’envoyer les fichier de sauvegarde par mail à une adresse de votre choix
  • de configurer la « durée de vie » des fichiers de sauvegarde stockés

2. Installation du plugin saveauto :

En fonction de votre SPIP récupérez le zip correspondant sur https://plugins.spip.net/saveauto/, décompactez le et placez le dossier « saveauto_X_Y » obtenu dans votre répertoire /plugins (à créer à la racine de votre spip si nécessaire), rendez vous sur l’interface de gestion des plugins (menu Configuration > Gestion des plugins), cochez le plugin « saveauto » et validez.

Ce plugin ne modifie pas les tables de la base données de SPIP, il n’en crée pas de nouvelles : pour sa désinstallation complète, il suffira d’effacer le répertoire /plugins/saveauto.

3. Versions

Ce plugin existe en 4 versions : saveauto_1_9_2 pour spip 1.9.2, saveauto_2_0 pour spip 2.0.*, saveauto_2_1 pour spip 2.1.* et saveauto_3_0 pour spip 3.0.*.

[ v. 1_9_1 ]
Lorsque la configuration du plugin est modifiée (via l’interface d’administration) le fichier /plugins/saveauto/inc/saveauto_conf.php qui stocke le paramétrage des sauvegarde est réécrit : selon la configuration du serveur qui vous héberge, il sera peut être nécessaire de modifier ses droits afin que cette réécriture soit possible (en cas de problème vous en serez averti lors de la validation d’une nouvelle config par l’interface d’administration).


[ v. 1_9_2]
L’enregistrement de la configuration et l’interface de gestion de celle-ci est basé sur le plugin config (cfg). Ce plugin doit être installé et activé pour que saveauto_1_9_2 fonctionne. Ce plugin permet la sérialisation des données de configuration et leur enregistrement dans la table spip_meta (de cette façon il n’est plus nécessaire de gérer un répertoire à accès en écriture pour le serveur comme le fait la version saveauto_1_9_1).

[ v. 2_0]
Passage en version compatible SPIP 2.0.*. L’interface de configuration est désormais accessible via le menu Configuration > CFG > Saveauto (le bouton dans le menu à été supprimé vu s le peu de fois où il était utilisé dans la vie du site)

Pour l’instant pas d’incompatibilités repérées avec d’autres plugins (pas de surcharge des fichiers du core de spip).

[ v. 3_0]
Passage en version compatible SPIP 3.0.*.
L’interface de configuration est désormais accessible via le menu Configuration > Sauvegarde automatique avec de nombreuses nouvelles options (en particulier pour l’envoi par mail des sauvegardes).
Désormais dans la page Maintenance > Sauvegarder la base (ecrire/ ?exec=sauvegarder) il est possible de déclencher « manuellement » une sauvegarde et l’outil propose aussi :

  • une possibilité de déclenchement manuel
  • la liste des sauvegardes disponibles, téléchargeables

4. Fonctionnement obtenu lorsque l’on intègre ce plugin :

Les sauvegardes ne sont PAS déclenchées par un « programmateur » (spip_cron) mais sont lancées lorsqu’un utilisateur (auteur ou administrateur selon le paramètre « Sauvegarde déclenchée lors de la connexion d’un auteur ») se connecte dans l’espace privé. De cette façon tant qu’il n’y a pas d’accès à l’espace privé (cad que le contenu du SPIP ne change pas) il n’y a pas de création d’éventuels « doublons » des sauvegardes.

Interface de configuration et d’administration du plugin saveauto

En revanche à chaque connexion à l’espace privé, le script est lancé : il vérifie si le temps écoulé depuis la dernière sauvegarde est supérieur à la fréquence déterminée dans la configuration (paramètre « Fréquence de la sauvegarde »), et , si c’est le cas, crée un nouveau fichier de sauvegarde dans le répertoire indiqué par le paramètre « Répertoire de stockage » de l’interface d’admin.
Si l’option « Zipper le fichier de sauvegarde » est activée, le fichier sql généré est zippé (version 0.5.2 minimum).

Par défaut ces sauvegardes sont stockées dans le répertoire /tmp de votre SPIP, si vous modifiez ce paramètre vous devez vous assurer que le répertoire utilisé est autorisé en écriture pour le serveur (777 avec votre client FTP en général) et que le chemin (relatif à la racine de votre spip) indiqué se termine bien par un « / » (par ex. : /tmp/sauvegardes/).
Si vous utilisez un répertoire différent de celui par défaut, gardez à l’esprit que celui-ci devrait être sécurisé pour qu’il ne puisse pas être accessible depuis internet : les fichiers de sauvegardes contiennent l’ensemble des données des articles, rubriques, brèves publiés ou non (et là, pas question « d’accès restreint »...)

Si la configuration le précise (paramètre « Sauvegardes envoyées à l’adresse ») et si votre hébergement autorise la fonction mail() de php, le fichier de sauvegarde obtenu sera envoyé à l’adresse mail de votre choix. Il est conseillé d’installer le plugin Facteur pour ajouter le fichier de sauvegarde en pièce jointe.

En fonction du nombre de jours configuré dans le paramètre « Sauvegardes considérées obsolètes après », le script va effacer les fichiers de sauvegardes dont l’âge est supérieur au nombre de jours configuré.

Les tables à sauvegarder (ou non) sont déterminées par les paramètres « Tables acceptées » et « Données ignorées » : par défaut le plugin sauvegarde toutes les tables (y compris celles qui n’appartiennent pas à SPIP) sauf celles dont le nom comprend « _index », « _temp » ou « _cache » (qui sont utilisées par SPIP pour stocker des données volumineuses mais non-indispensables pour rétablir son intégrité : leur structure seule est sauvegardée).
De la même manière, le paramètre « Eléments à sauvegarder » permet de choisir (de façon globale) si vous voulez sauvegarder la structure et/ou les données des tables (option réservée aux administrateurs maitrisant ces concepts : si cela ne vous parle pas, choisissez « oui » pour les 2 choix proposés dans ce paramètre !).

Pour finir avec les options configurables vous pourrez également préciser :

  • le nom de la base de données de votre SPIP : ce paramètre ne sert qu’à composer le nom des fichiers de sauvegarde (par défaut de la forme : « nom_base_spip_2006 »). De façon complémentaire le paramètre optionnel « Préfixe pour les sauvegardes » permet de composer des noms de fichiers encore plus complets : ce qui peut donner des noms de la forme « prefixe_nom_base_spip_2006 ».
  • si vous souhaitez qu’un message s’affiche lorsque la sauvegarde à été effectuée (à éviter si vous choisissez de faire déclencher la sauvegarde lors de la connexion des auteurs...)

5. Restauration des sauvegardes à partir des fichiers générés par le plugin :

[*Attention !!!*] les sauvegardes réalisées ne sont pas au format de celles de SPIP : Inutile d’essayer de les utiliser avec l’outil d’administration de Spip.

Pour toute restauration il faut utiliser l’interface phpmyadmin de votre serveur de base de données : dans l’onglet « SQL » utiliser le bouton « Emplacement du fichier texte » pour sélectionner le fichier de sauvegarde (cocher l’option « gzippé » si nécessaire) puis valider.

Les sauvegardes xxxx.sql.zip ou xxx.sql sont au format SQL c’est à dire qu’ils contiennent les commandes permettant d’effacer les tables existantes du SPIP et de les remplacer par les données archivées. Les données plus récentes que celles de la sauvegarde seront donc PERDUES !

6. Ce qu’il reste à faire :

  • la sauvegarde des données de la base est une chose, mais de plus en plus les sites sous SPIP ont toute une partie de leur contenu sous forme de fichiers « annexes » (images, pdf, sons, images...) qui sont stockés dans le répertoire /IMG : il serait donc intéressant d’avoir la possibilité de faire une sauvegarde de ceux-ci sous forme d’un fichier compressé qui serait transféré par FTP sur un autre serveur (je n’imagine pas l’envoi par mail vu le volume que cela représente !)
  • les fichiers de langues pour les utilisateurs ne causant pas le french

Comme pour beaucoup d’autres plugins, afin de faciliter le developpement collaboratif, vous trouverez l’ensemble des fichiers en cours sur le SVN de spip-zone : avis aux motivés !

Discussion

79 discussions

  • 1
    Pierre Roger

    Re-Bonjour,

    Je continue mes essais.

    1) Pour la version 1.9.2, donner les droits sur le répertoire : plugins/saveauto/inc (chmod 777)

    2) Les accents ne sont pas tous perdus malgré l’apparence dans le fichier SQL.
    Seuls les mots avec accents dans les listes pointant sur une ancre perdent leurs accents


    -  Pr�sentation
    -  Organisation du suivi
    -  Examens - Modalit�s particuli�res
    -  Demande de suivi ARIEDA

    Quand il s’agit d’une liste sans lien sur une ancre, les accents sont retranscrits correctement :

    * libéral pour les séances en cabinet

    * salarié pour les séances à l’école.

    Pour les autres accents, la restauration s’est bien passée :

    Selon le décret du 22 avril 1988, il est agréé en tant que Service d’Accompagnement Familial et d’Education Précoce (SAFEP) ainsi qu’en tant que Service d’Education Familiale et d’Intégration Scolaire (SEFIS). Les prises en charge sont financées par les caisses d’assurance maladie.

    Bizarre que dans le cas des listes pointant sur une ancre, il y ait une mauvaise interprétation !

    • 1) Pour la version 1.9.2, donner les droits sur le répertoire : plugins/saveauto/inc (chmod 777)

      heu... je ne vois pas à quoi peut bien servir ce chmod sur un répertoire à priori non utilisé en écriture... si tu as une raison précise je suis preneur !

      Seuls les mots avec accents dans les listes pointant sur une ancre perdent leurs accents

      peux tu préciser ce qu tu entends par « dans les listes pointant sur une ancre » ?

      Par ailleurs, pour plus de précisions :
      -  la restauration est elle faite sur le même SPIP (même serveur + même installation de SPIP) que celui où a été fait la sauvegarde ?
      -  le SPIP est il en UTF8 ou en ISO8859-1 ?

    Répondre à ce message

  • Pierre Roger

    Bonjour,

    Très bonne idée que ce plugin !!!

    J’ai installé la version 1.9.2 pour un site en Spip 1.9.2h,

    Tous les accents sont perdus dans la sauvegarde et elle devien donc inutilisable.

    Voici ce que cela donne :

    Selon le décret du 22 avril 1988, il est agréé en tant que Service d\’Accompagnement Familial et d\’Education Précoce (SAFEP) ainsi qu\’en tant que Service d\’Education Familiale et d\’Intégration Scolaire (SEFIS). Les prises en charge sont financées par les caisses d\’assurance maladie.

    Je n’ai pas encore fait les essais pour la version 2.

    Répondre à ce message

  • 2
    Perline

    Une toute petite erreur : dans le mail d’envoi : Sauvegarde de la base effectuée avec succès !
    une petite réparation des accents ?

    • heu... je dois être une vraie quiche en orthographe : je ne vois pas quel est le problème d’accents... tu ne veux pas préciser ?(ou commiter directement la modif dans le fichier de langue ?)

    • Après suppression de la base puis restauration via phpadmin j’ai perdu aussi les accents.
      Ai-je loupé une marche ou une démarche dans l’installation de saveauto ?

    Répondre à ce message

  • oui : sur la page de téléchargement des plugins de http://files.spip.org/spip-zone/ tu pourra choisir entre la version 1.9.1 (!), la 1.9.2 et la 2.0.* qui est celle en lien dans l’article.

    Génial, trop cool, mortel, je l’installe tout de suite.

    Répondre à ce message

  • 1

    Bonjour, tout est dans le titre. Voilà le plugin dont je rêve (j’ai perdu 6 mois d’articles sur un site récemment !) mais j’ai spip 2... Merci de vos réponses (même si elle ssont négatives :-)

    Répondre à ce message

  • 1
    Perline

    Comme je n’ai pas les codes pour commiter...
    C’est vrai, SPIP a transcris mon message, je l’ai pas vu, je suis nouille.
    Bon, donc je reçois les accents en html :
    Sauvegarde de la base effectuée avec succès !.
    Désolée pour le message précédent peu explicite.

    Répondre à ce message

  • 1

    Bonjour,

    le plugin fait bien les sauvegarde, mais ne les envois pas par mail.

    Une idée ? d’autant qu’il le faisait auparavent ...

    • le plugin fait bien les sauvegarde, mais ne les envois pas par mail

      Peut être elles sont trop grosses ? As tu vérifié la taille de la bdd ?

    Répondre à ce message

  • 2

    Ce plugin est super - merci pour ses créateurs.
    Tellement que j’en voudrais plusieurs !
    Le but serait d’en installer plusieurs instances, avec des réglages différents, sur un même site.

    Par exemple, une instance pour sauver les tables spip (avec le paramétrage adéquat) et une instance pour sauver et expédier les tables non spip (avec un autre paramétrage). Quand les tables sont grosses, c’est utiles de fractionner ainsi, en pouvant spécifier aussi, du coup, des périodicité différentes...

    Merci

    Est-ce que c’est possible sans que toutes les configurations s’emmêlent les pinceaux ?

    • Est-ce que c’est possible sans que toutes les configurations s’emmêlent les pinceaux

      à priori ce plugin n’est pas prévu pour ça...

      Néanmoins, il semble possible qu’en utilisant plusieurs installations en parallèle (ce qui veut dire bidouiller pour utiliser un préfixe de plugin différent : i.e. un gros rechercher/remplacer « saveauto » par « saveauto_bis » par ex) cela serait possible (quoiqu’un peu « bourrin ») => merci de nous tenir au courant si tu essaie et que ça fonctionne !

      Si par hasard tu te sentais le courage de faire les quelques modifs pour que cela puisse tourner « proprement » tu es le bienvenu et le SVN t’es ouvert :-)

    • ok.

      L’idéal en passant à un multiconfig serait de farder l’absolue simplicité ergonomique de ce plugin.

      A défaut d’une interface dédiée multiconfig, il serait possible de tout garder et juste détecter un format spécial de données dans les champs déjà présents, qui déclancherait un mode multiconfig.
      Genre, un pipe pour passer d’une config à l’autre. Si ya pas de pipe, c’est monoconfig, sinon, les pipes séparent les données de chaque config. ça donnerait par exemple, pour les tables exclues : spec1 ;spec2 ;spec3|spec21 ;spec22 ;spec23...

    Répondre à ce message

  • 1

    Hello,

    Je ne cessais sans savoir pourquoi de recevoir des mails de message d’erreur de mauvaise adresse de mail envoyé, dont l’expéditeur était toto@truc.net

    ça pouvait être du spam ou bien un trace que j’aurais malencontreusement oublié dans un script.

    Aujourd’hui j’ai pris le taureau par les cornes et trouvé que le coupable était saveauto !!!!

    Dans inc/saveauto_fonctions.php, la fonction saveauto_mail_attachement envoie ce mail (j’imagine que c’est juste pour tester si tout va bien du côté de l’envoi des mails).

    J’ai donc commenté ce test ...

    Pour d’autres qui voudraient se débarasser de ces mails encombrants, il suffit de remplacer le début de la fonction par :

    function saveauto_mail_attachement($to , $sujet , $message , $fichier, $nom, $reply="", $from="") {
    /*   if (! @mail('toto@truc.net', 'test envoi mail', 'le message de test')) {
    	 		echo _T('saveauto:config_inadaptee').' '._T('saveauto:mail_absent').'<br>';
    			return false;
    	 }*/
    	 $limite = "_parties_".md5(uniqid (rand()));
       ...
    • Peut être qu’un appel à function_exists remplacerait efficacement ce test ?

    Répondre à ce message

  • Après un bon fonctionnement durant un an, je ne reçois plus de sauvegarde depuis le 20 décembre, si je vais configurer le plugin, j’ai plusieurs fois le message suivant :

    Warning : in_array() [function.in-array] : Wrong datatype for second argument in www/ecrire/public/composer.php(48) : eval()’d code on line 115

    Il y a également la ligne 56

    Version SPIP : SPIP 1.9.2e [12624]

    Répondre à ce message

Ajouter un commentaire

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
  • 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 apparaît.

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.

Qui êtes-vous ?
[Se connecter]

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