SPIP - Contrib

[ar] [en] [es] [fr] [it]



Accueil du site > Outils pour plugins > Tutoriaux pour Plugins

Ajouter une tache CRON dans un plugin SPIP

Comment générer l’exécution d’un traitement régulier en tâche de fond

samedi 1er décembre 2007, par chryjs. Dernier ajout jeudi 31 janvier 2008


Vous avez rêvé de savoir comment, je vais essayer d’expliquer ce que j’en ai compris :-)


Mots-clés

La documentation ci-dessous est faite à partir de mon analyse du code de SPIP et n’est donc pas la doc officielle... réalisée pour le Plugin Forum SpipBB.

Pour ajouter une tâche de CRON exécutée, par exemple toutes les 60x10 secondes (soit toutes les 10 minutes) pour le plugin SpipBB.

1. Créer la tâche

NB : Pour notre exemple, j’ai choisi comme tâche de faire une ligne de log avec la fonction spip_log(). Vous pouvez bien entendu remplacer cela par toutes les actions que vous voulez réaliser !

Une tâche c’est une série d’actions à réaliser, que vous aurez programmé en PHP (a priori) pour s’intégrer dans SPIP. Vous pourrez regarder par exemple ce qui est fait dans le noyau pour le traitement des statistiques.

Appelons donc, pour l’exemple, la tâche "une ligne de log" : montravail

Il existe deux mécanismes légèrement différents à ce jour, dépendant de la version de SPIP :

Où et comment stocker la tâche planifiée selon la version de SPIP
SPIP 1.9.2 SPIP 1.9.3
Fichier inc/montravail.php genie/montravail.php
Code
cron_montravail($time)  {
        // exemple de tâche possible
        spip_log("Mon travail c est juste une ligne de log....");
}
genie_montravail($time)  {
        // exemple de tâche possible
        spip_log("Mon travail c est juste une ligne de log....");
}

Donc selon la version de SPIP pour laquelle vous rédigez votre plugin il vous faudra créer un fichier contenant la fonction idoine.

NB : Vous pouvez envisager de créer une compatibilité entre les deux soit en dupliquant les entrées soit en créant un appel de l’un par l’autre.

2. Ajout d’une entrée dans la liste des tâche à exécuter

Une fois la tâche existante, il faut qu’elle soit « planifiée », c’est-à-dire ajoutée à la liste des tâches planifiées que SPIP réalise déjà.

Dans le fichier plugin.xml on ajoute l’entrée :

Attention, dans cet exemple : SpipBB est le <prefix> (au sens plugin.xml) de mon plugin.

Dans le ficher spipbb_pipelines.php (qu’il faut créer s’il n’existe pas), on ajoute la partie suivante :

Mise en œuvre

Il ne faut pas oublier que le lancement de la tâche dépendra de la fréquentation de la page qui contient la balise #SPIP_CRON (par défaut la page sommaire).

Dans cet exemple, on pourra vérifier que dans tmp/spip.log je trouve régulièrement une ligne avec « Mon travail c’est juste une ligne de log »...

Informations complémentaires

Notez bien que vous pouvez donner le nom que vous souhaitez à votre tâche (par ex : nomdelatache et même en créer plusieurs. Mais il faudra bien respecter le fait d’associer le nom de la tâche à la fonction cron_nomdelatache (ou genie_nomdelatache), ainsi que le nom du fichier dans inc/ : inc/nomdelatache.php, et aussi la référence dans la table des tâches $taches_generales['nomdelatache'] .


Répondre à cet article

  • Ajouter une tache CRON dans un plugin SPIP

    3 avril 2008 00:34, par Bernard

    Si j’ai bien compris, c’est la fréquentation sur le site public qui active le cron placé dans le plugin.

    Si la tache cron est prévue toutes les 6 heures par exemple dans une entreprise ; cela veut-il dire que la tache prévue à minuit, ne se fera pas ( à moins que le veilleur de nuit...) ? Est-il possible de provoquer un cron sans aller surfer sur les pages ?

    Répondre à ce message

    • Ajouter une tache CRON dans un plugin SPIP 3 avril 2008 09:38, par chryjs

      Pour la documentation des motivations de #SPIP_CRON et de son principe, je te renvoie vers la documentation officielle de SPIP : Les balises propres au site .

      Attention toutefois, je note un risque de confusion : avec cette balise il s’agit d’intervalles souhaités, pas d’horaires programmés, car ce n’est pas sérieusement possible par l’intermédiaire d’un site web.

      Pour « déclencher » un programme sans surfer sur les pages, comme toujours il n’y qu’une réponse possible : comment fait l’ordinateur pour démarrer ce fameux programme ? Forcément un être humain est l’auteur de ce démarrage. Quelques solutions classiques :

      • soit tu as la main en direct sur l’ordinateur en question : exécution classique d’un logiciel, ou alors via une tâche programmée gérée par un programmateur [1] (ie : crontab).
      • ton hébergeur te fourni un accès plus ou moins direct à un programmateur (parfois via web) et dans ce cas... suivre sa documentation !
      • soit tu n’as pas accès direct sur l’ordinateur en question et là pas de solution autre que l’astuce de SPIP (ou similaire).

      Répondre à ce message

      • Ajouter une tache CRON dans un plugin SPIP 3 avril 2008 14:08, par Bernard

        Oui c’est bien ce que j’avais compris, sauf que tu précises très bien la notion de programmation d’une tache et l’exécution à intervalle x d’un script.. (effectivement j’admets la confusion ;) )

        Maintenant une autre question à moins que sa place soit plutôt sur spip dèv :

        1. Comment faire un bouton dans un plugin permettant d’activer la tache de fond ou pas ?
        2. Est-ce possible ?

        Merci et je le trouve très bien et très clair cet article là !

        Répondre à ce message

    Retour au début des forums

  • Ajouter une tache CRON dans un plugin SPIP

    30 janvier 2008 13:46, par danou9

    bonjour,

    bonne idée de faire un tuto, mais je suis décu

    tu parles de plugin (faut-il créer un plugin?)

    tu écris : $taches_generales[’montravail’]

    pourquoi ’montravail’ et pas autre chose ?

    je suppose que ca fait référence au prog dans inc/

    A quoi sert spip_log( dans inc/montravail.php

    Je travaille depuis 2 ans sur Spip et j’ai réalisé plusieurs plugins sans être expert en spip, je maîtrise bien et je voulais comprendre les taches avec la balise #SPIP_CRON

    ton tuto est insuffisant

    je vais être obligé de me plonger moi-même dans l’étude de cas, de plugins ayant déjà utilisé les taches de fonds

    Dommage !

    Répondre à ce message

    • Ajouter une tache CRON dans un plugin SPIP 4 février 2008 11:10, par chryjs

      Il y a beaucoup de points dans ton message. Je vais essayer de répondre au fur et à mesure :

      • "Faut-il créer un plugin ?" : je n’en suis pas sûr mais comme il faut ajouter une tâche comme indiqué au paragraphe 1 , il me semble que cela n’est possible qu’en réalisant un plugin.
      • Pourquoi "montravail" ? Un petit manque au niveau de l’explication de cette doc (que je vais actualiser donc). C’est un nom "générique" que j’ai choisi pour faire cet exemple. On peut l’appeler comme on veut à condition de bien reprendre le même nom dans le nom de la tâche (cf paragraphe 1) ex : tachebidule -> cron_tachebidule / genie_tachebidule .
      • A quoi sert "spip_log..." ? A rien ! C’est juste un exemple de tâche réalisée. En l’occurence j’ai choisi de générer une ligne de log. A toi de programmer (en php) ce que tu veux que la tâche réalise !

      Je prend bonne note de tes remarques et vais faire quelques ajouts pour l’améliorer :)

      Répondre à ce message

    Retour au début des forums



Suivre la vie du site RSS 2.0 | Plan du site | Espace privé | Charte et vie SPIP-Contrib | SPIP | L'autre.net