Linea21

h1. CronJobs

Depuis la version 1.8, Linea21 permet de planifier l’exécution de tâches de manière automatique (par exemple pour l'envoi d'emails, ou la réalisation d'une sauvegarde, ...)

h2. Configurer l’exécution de tâches automatiques

La première étape est de configurer l'appel au script fourni par Linea21. Il se situe dans le répertoire /admin/.

Vous devez pour cela créer un nouveau cronjob. Référez-vous à la "documentation":http://doc.ubuntu-fr.org/cron.

Ajoutez l'une des deux instructions suivantes :

<pre>

<code>

* * * * * /usr/bin/php /var/www/linea21/admin/cron.php token=your_token_id

</code>

</pre>

ou (au cas où la première ne fonctionnerait pas) :

<pre>

<code>

* * * * * /usr/bin/curl http://www.mondomaine.tld/admin/cron.php?token=your_token_id

</code>

</pre>

*Le token correspond à la valeur de la constante SECRET_KEY disponible dans votre fichier de configuration (/config/config.ini).*

L'instruction @* * * * * @ indique que le script est exécuté par cron chaque minute. Vous pouvez changer cette caractéristiques en modifiant la valeur. Par exemple, @*/10 * * * * @ exécutera le script chaque 10 minutes. Pour en savoir plus sur la syntaxe CRON, consultez la page Wikipedia : http://en.wikipedia.org/wiki/Cron ou encore Crontab Guru (https://crontab.guru).

*Remarque :* Assurez-vous de la cohérence de la fréquence d'appel avec les différents cronjobs mise à disposition de l'application, sans quoi, ils ne seront pas exécutés.

h2. Cronjobs par défaut

Par défaut, l'application exécute 2 cronjobs :

* l'envoi de la newsletter (chaque nuit, à 00h00)

* le traitement de la queue d'emails (chaque 10 minutes)

<pre>

<code>

@daily ../newsletter/send.php

*/10 * * * * ../mail/process_queue.php

</code>

</pre>

h2. Localisation des Cronjobs

Le script _/admin/cron.php_ exécute les cronjobs situés dans le répertoire '/config/cron/'.

Nous vous recommandons de ne pas modifier le fichier '/config/cron/1_default' qui comporte les tâches à exécuter par défaut et qui sera écrasé en cas de mise à jour de l'application.

Si vous souhaitez ajouter des cronjobs, il est recommandé de créer un (ou plusieurs) nouveau(x) fichier(s).

L'application s'assure qu'un cronjob n'est exécuté qu'une seule fois seulement par appel. Vous pouvez donc modifier le comportement d'un cronjob fourni par défaut par l'application en le dupliquant dans un fichier dont le nom commence par '0' (l'exécution se fait par ordre alphabétique).

Exemple d'un fichier nommé '/config/cron/0_user' :

<pre>

<code>

*/30 * * * * ../mail/process_queue.php

</code>

</pre>

Dans cette configuration, l'application traitera la queue d'emails non plus chaque 10 minutes (comportement par défaut) mais chaque demi-heure comme défini par l'utilisateur.

h2. Cronjobs et override

L'exécution des tâches planifiées supporte l'override. Cela signifie que vous pouvez créer votre propre script pour modifier le comportement d'une tâche existante.

Par exemple, l'instruction @*/10 * * * * ../mail/process_queue.php@ exécutera le script '_/templates/admin/montheme/override/mail/process_queue.php_' s'il est défini.

h2. Créer de nouveaux cronjob

Dans le cadre de la création de nouveaux cronjobs, vous pouvez tester vos scripts de 2 façons :

* directement depuis votre navigateur, en appelant la page  http://www.mondomaine.tld/admin/cron.php?token=your_token_id

* ou bien en appelant le script depuis un terminal :

<pre>

<code>

/usr/bin/curl http://www.mondomaine.tld/admin/cron.php?token=your_token_id

</code>

</pre>

h2. Cronjobs et contraintes liées à l'hébergement, une nécessaire adaptation

Certains hébergeurs ne permettent qu'un appel limité aux cronjobs. A titre d'illustration, *OVH exécutera le script cron qu'une fois par heure seulement.*

Par ailleurs, OVH lui-même ne permettra pas de choisir à quelle minute précise se fait l'envoi. Il attribuera une valeur aléatoire. Aussi, il est nécessaire de reprendre le script par défaut :

Si OVH exécute l'instruction : `53 * * * * www/admin/cron.php`, il sera nécessaire d'adapter / dupliquer le script par défaut.

Dans ce cas, copiez-collez cron/1_default vers le fichier cron/0_default en modifiant la valeur de la fréquence d'appel : 

Version originale : 

<pre>

@daily ../newsletter/send.php

@daily ../project/task-reminder.php

*/10 * * * * ../mail/process_queue.php

</pre>

Version modifiée : 

<pre>

53 2 * * * ../newsletter/send.php

53 7 * * * ../project/task-reminder.php

53 * * * * ../mail/process_queue.php

</pre>

* Première ligne : envoi de la newsletter (si nécessaire) chaque nuit à 2h53

* Deuxième ligne : envoi des rappels de tâches chaque matin à 7h53

* Troisème ligne : traitement de la queue d'emails à une fréquence de une - toujours effectué à la minute 53

*Besoin d'aide ? Voir https://crontab.guru*