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

  • 5

    Bonsoir,
    Ce plugin fonctionne bien (au moins pour l’install et la 1re sauvegarde).

    Juste une question : en le configurant j’ai systématiquement le message :
    Attention : la sauvegarde ne pourra pas être compressée car cette fonctionnalité n’est pas disponible sur votre serveur (support de Zlib pas activé dans php.ini)

    cela m’étonnait donc j’ai été voir le phpinfo et voici ce qu’il dit :
    ZLib Support enabled

    Compiled Version 1.2.2

    Linked Version 1.2.2

    Directive Local Value Master Value

    zlib.output_compression Off Off

    zlib.output_compression_level -1 -1

    zlib.output_handler no value no value

    merci en tout cas
    catherine

    • pour que la génération « à la volée » des fichiers .gz soit possible, il faut l’option zlib.output_compression à On (voir : http://fr.php.net/manual/fr/ref.zlib.php pour plus de détails)

    • En fait, la génération de fichiers compressés peut se faire si les fonctions gzopen, gzwrite etc sont dispo, au lieu de tester zlib_get_coding_type(). J’ai modifié pour mon utilisation les fichiers saveauto_fonctions.php et saveauto_admin.php pour en tenir compte, dans la version pour spip 1.9.1.

      Dans saveauto_fonctions.php/saveauto_sauvegarde() (Vers 109) :
      $gz = $gz && function_exists(’gzopen’) ;

      Dans saveauto_admin.php/exec_saveauto_admin() (vers 142) :
      if ($gz && !function_exists(’gzopen’))

      De plus, pour bien réagir à l’ouverture, le nom du fichier gz doit etre ’.sql.gz’.

      Dans saveauto_fonctions.php/saveauto_sauvegarde() (Vers 160) :
      $nom_fichier = $prefixe_save . $base . « _ » . $annee. « _ » . $mois. « _ » . $jour . ($gz ? ’.sql.gz’ : ’.sql’) ;

    • marabbeh

      Moi aussi, mon hébergeur (OVH) met lib.output_compression à Off, mais ça n’empêche pas de sauvegarder des bases compressées.

      J’ai modifié saveauto_1.9.2 en utilisant les indications de Fil. Ce serait pas mal que le plugin (1.9.1 et 1.9.2) soit mis à jour, car la compression n’est pas un luxe si on a une base assez grosse...

    • marabbeh

      J’ai créé 2 tickets sur spip.zone #595 et #596

    • Jean-Pierre

      J’ai essayé la modification avec 1.9.1 chez Free, aussi
      -  soit j’ai pas bien modifié (quand j’ai pas remplacer “abc” par “rst”, je me gourre,
      -  soit la modif marche pas sous 1.9.1 (snip).

    Répondre à ce message

  • 2

    Bonjour,

    Peut-être que je n’ai pas compris comment faire, mais ma base de donnée sauvegardée dépasse largement la taille fatidique admise des 2 Mo admise par MySql pour l’importation des fichiers .sql (compressé ou non) ?

    En gros comment faire une sauvegarde partitionnée des mes bases de données ?

    En remerciant les réalisateurs de ce plugin des plus utiles pour les désordonnés comme moi, qui oublient les sauvegardes régulières.

    • Cette limite ne s’applique pas lors de la création des fichiers de sauvegarde puisqu’il n’y à rien à importer dans cette étape (pour info j’utilise ce plugin pour des bases qui me donnent des fichiers sauvegardes jusqu’a 25 Mo...).

      En revanche c’est dans le cas d’une restauration par phpmyadmin à partir de ces fichiers > 2 Mo que se pose le problème... Et jusque là la seule solution simple est de « tronçonner » le fichier trop gros en fichiers < 2 Mo et de les envoyer les uns après les autres (pas très ergonomique mais une restauration à partir de sauvegardes est une opération peu fréquente !)

    • Il y a une autre solution pour réinstaller la base de données à partir de fichiers de plus de Mo ... c’est de ne *pas* utiliser phpmyadmin.

      Cette soluce n’est pas accessible à tout le monde car il faut pouvoir intervenir en ligne de commande sur le serveur (généralement avec ssh). Mais pour ceux qui ont une base de donnée de plus de 2Mo, le choix d’un bon service d’hébergement avec cette possibilité se justifie peut être, même si ce n’est pas tout à fait gratuit.

      La commande ’mysql’ n’est pas limitée à 2Mo, elle passera toutes les commandes du fichier dans la base désigné :

      $ mysql dbname < fichiersql

    Répondre à ce message

  • 3

    Ca ne semble pas fonctionner avec Spip 1.9.2. J’ai eu la page de configuration, puis à la suite de la validation, page blanche.

    J’utilise encore l’outil de Japanim, (avec une petite correction car il faisait parfois de multiples sauvegardes quotidiennes) et il m’a permis de faire redémarrer un site après plantage de la base, avec seulement 24h de pertes de données. Donc ce plugin est bien venu.

    Reste évidemment le problème des documents à sauvegarder. Je ne sais pas par quel bout le prendre, car sur un site j’ai 250 Mo de données, ce qui me prend une heure à la main...

    • Pour l’instant ce plugin n’a pas encore été adapté pour spip 1.9.2 : en principe il doit pas y avoir grand chose à modifier mais là j’ai pas trop le temps...

      Si tu te sens de faire l’adaptation, pas de problème pour moi : soit tu bosse directement sur le SVN de la zone (svn ://zone.spip.org/spip-zone/_plugins_/_test_/saveauto) soit tu peux m’envoyer un zip avec les fichiers modifiés, je m’occuperais de la mise à jour sur spip-zone.

      Sinon, pour le problème de la sauvegarde des documents, c’est un sujet qui à déja été abordé plusieurs fois sur la liste de spip-zone et il y a plusieurs solutions envisageables (mirroir vers un autre serveur par FTP par ex).

      A priori la plus grosse difficulté en ce moment c’est de trouver quelqu’un qui ait le temps de s’en occuper... Alors une fois encoe, si tu veux t’investir là-dessus tu es le bienvenu et à coup sûr tu ne manquera pas de testeurs !

    • la version pour spip 1.9.2 est sortie : http://files.spip.org/spip-zone/sav...

    • quentic

      pour la récupération du dossier IMG sous Windows, j’utilise un outil externe à SPIP : syncback.
      Il permet de synchroniser un dossier de sauvegarde local avec le dossier IMG chez ton hébergeur via FTP.

      Tu peux planifier la périodicité des sauvegardes toujours avec le même outil.

      Ca fonctionne très bien.

    Répondre à ce message

  • Bravo et merci pour ce super plugin...
    juste une petite difficuluté. La sauvegarde se fait très bien mais l’envoi par mail ne marche pas...
    cela aurait été pratique en cas de crash complet du serveur.
    quel peut etre le problème ?
    merci
    nb : la base fait 9 MO (une limite dans l’envoi des mails ?)

    Répondre à ce message

  • 2

    Erreur...
    Fichier exec/cfg introuvable

    voilà ce que j’obtien ! pas génial.
    SPIP 1.9.2 [8782]
    QUelqu’un sait ce qui ne va pas ?

    • Alors comme d’habitude : RTFM !

      En effet si tu avais lu ce paragraphe de la doc, tu saurais qu’il FAUT que le plugin cfg soit installé et activé pour que la version saveauto_1_9_2 fonctionne...

    • oui ca marche maintenant,
      merci infiniment.
      L’envoi par mail ne fonctionne pas, peut etre parce que la base fait mo !
      Merci

    Répondre à ce message

  • 2

    Salut !
    Super plugin que j’ai installé sur 3 sites...
    Problèmes sur un site, je reçois plusieurs savegardes par jours, et aujourd’hui, carrément 57 d’un coup !

    Une idée ?

    Liste des derniers plugins installés (qui correspondrait en date de début des problèmes) :
    -  Squelette editeur
    -  Target
    -  En travaux
    Tiens... alors que j’ai désactivé le plug il y a 20 minutes, je viens de recevoir encore 6 sauvegardes...

    • Oh oh... 27 sauvegardes sur un autre site, sur lequel il n’y a eu aucun ajout de plugin...
      Y aurait-il un rapport avec la date 11/02/07 ? étrange autant que bizarre...

    • Jacques83300

      Bonjour,

      Je rencontre le même problème que Chris depuis que je suis passé sous Spip 1.9.2 : dès que je rentre dans la partie privée du site (administration), des sauvegardes sont exécutées en permanences et envoyées par mail. Cela s’arrête dès que je reviens dans la partie pubique du site. Ce matin j’ai installé la toute dernière version du plugin sans amélioration du problème.

      Si quelqu’un a une idée ?

      Liste des plugins installés :
      -  Article_PDF
      -  Barre Typo Enrichie Ecologique
      -  Config
      -  Crayons
      -  Suivi des Forums
      -  MailCrypt
      -  Spip-listes
      -  sauvegarde automatique

    Répondre à ce message

  • 1

    Super ce plugin,

    Un petit bug concernant la fréquence de sauvegarde (envois de mails à répétition).
    Le problème vient du tri par rsort($entree) ; pour les dates du 1er au 9 du mois ;
    je m’explique :
    Ma première sauvegarde date du 9 du mois donc le fichier :
    saveauto_nom_base_SPIP_2007_02_9.sql
    Mais ce fichier une fois comparé à saveauto_nom_base_SPIP_2007_02_14.sql (celle d’aujourd’hui) reste en première position avec rsort => éternel problème du tri alphanumérique

    La parade :
    ligne 157 fichier saveauto_fonctions.php remplacer
    $jour = date(« j », $temps) ; //format numerique : 1->31
    par
    $jour = date(« d », $temps) ; //format numerique : 01->31
    pour avoir les dates 01 02 ....

    Et renommer par ftp les fichiers :
    saveauto_nom_base_SPIP_2007_02_9.sql doit devenir saveauto_nom_base_SPIP_2007_02_09.sql
    pour éviter le spam involontaire.

    Encore merci pour ce super plugin.

    Répondre à ce message

  • Je n’arrive pas à configurer le plugin saveauto sous spip 1.9.1 (sous linux apache)

    Une fois installé, je vais cocher le plugin save auto via l’icone configuration

    La page d’écran se rafraichit et reste blanche.

    Je n’ai plus accès à la page privée tant que je ne supprime pas le répertoire de save auto.

    Une piste ...

    j’ai réinstallé une 2e instance de spip sans squelette personnalisé et j’ai le même problème.

    J’arrive à faire marché le même plugin sur un serveur windows (XAMPP + spip 1.9.1)

    Merci d’avance

    Répondre à ce message

  • Ahou ! Ça c’est bonne idée, bon greffon et explications claires.

    Merci beaucoup. ;-)

    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