Documentation Wcal 2.7

Configurer Wcal

wcal.conf contient les données de configuration pour wcald, le démon de Wcal. Quelques paramètres ne sont configurables qu'en éditant des variables au début du code de wcald lui-même, mais la plupart des utilisateurs n'ont pas à y toucher. Wcal est livré avec un exemple de fichier de configuration qui liste tous les paramètres possibles et leurs valeurs par défaut avec un bref commentaire.

Si vous changez wcal.conf, il sera rechargé à la prochaine requête faite à wcald. Il est inutile de relancer ou d'envoyer un signal à wcald.

Si vous voulez placer wcal.conf ailleurs, vous devez changer la variable correspondante au début des fichiers index.c et wcald.

Format du fichier

Les lignes ne contenant rien ou seulement des espaces et les lignes commençant pas # sont ignorées. Toutes les autres lignes contiennent une définition de paramètre. Les espaces sont autorisés (mais non nécessaires) au début de la ligne et entre les mots-clés (mais pas au sein de mots-clés comportant plusieurs mots comme access file).

La plupart des définitions utilisent un format sur une seule ligne. Elle commence avec le nom du paramètre (qui peut être constitué de plusieurs mots), suivi du signe égal (=), le reste de la ligne constituant la valeur du paramètre. Les commentaires ne sont pas autorisé en fin de ligne.

Le fichier de configuration est implicitement divisé en trois sections : la section globale la section groupe et la section de définition des utilisateurs. La section groupe peut contenir des définitions d'utilisateurs ou de groupes (sous-groupes). La section globale commence au début du fichier de configuration et se termine à la définition du premier utilisateur ou groupe. La section globale contient aussi bien les paramètres généraux non liés aux utilisateurs que les paramètres par défaut pour les utilisateurs. Les paramètres spécifiés à l'intérieur de la définition d'un groupe n'affectent que les utilisateurs du groupe. Les paramètres spécifiés à l'intérieur de la définition d'un utilisateur n'affectent que l'utilisateur seul. Les paramètres qui peuvent être définis dans la section globale sont suivis d'un Global ci-dessous. Les paramètres qui peuvent être définis dans la section groupe sont suivis d'un Groupe ci-dessous. Les paramètres qui peuvent être définis dans la section utilisateur sont suivis d'un Utilisateur ci-dessous.

La définition des utilisateurs et des groupes et du fichier d'accès se fait sur plusieurs lignes. La définition d'un fichier d'accès definit le texte qui sera écrit par Wcal dans chaque répertoire utilisateur ou groupe de Wcal (qui n'ont rien à voir avec les utilisateurs Unix) dans un fichier .htaccess. Ce mécanisme est défini par Apache. Apache lit le fichier .htaccess dans chaque répertoire qu'il accède, et le fichier doit contenir les directives définissant qui est autorisé à accéder au répertoire. La définition du fichier d'accès peut se faire dans la section globale, dans la définition du groupe ou dans la définition de l'utilisateur (voir le paragraphe suivant). La définition du fichier d'accès dans la section globale est la définition par défaut pour les utilisateurs qui ne possède pas de fichier d'accès spécifique. La définition du fichier d'accès débute avec une ligne contenant la chaine access file et se termine par la ligne end access file. Entre les deux, se trouvent les lignes formant le contenu du fichier d'accès. Un exemple de définition du fichier d'accès est donné dans le fichier d'exemple de configuration livré avec la distribution de Wcal.

La définition d'utilisateurs commence avec une ligne user = value, où value est un nom d'utilisateur alphanuméerique. Les espaces ne sont pas autorisés dans le nom de l'utilisateur. La définition d'utilisateurs se termine avec une ligne contenant seulement end user. Entre les deux, se trouvent les lignes contenant des définitions de paramètres sur une ligne et également une définition de fichier d'accès. Tous les paramètres dans la définition d'utilisateurs s'appliquent seulement à l'utilisateur courant. Si certains paramètres ne sont pas définis dans la définition d'utilisateurs (ce qui est le cas général), la valeur par défaut est utilisée.

La définition de groupes commence avec une ligne group = value, où value est un nom de groupe alphanuméerique. Les espaces ne sont pas autorisés dans le nom du groupe. La définition du groupe se termine avec une ligne contenant seulement end group. Entre les deux, se trouvent les lignes contenant des définitions de paramètres sur une ligne et également une définition de fichier d'accès. Tous les paramètres dans la définition de groupe s'appliquent seulement au groupe courant. Si certains paramètres ne sont pas définis dans la définition du groupe (ce qui est le cas général), la valeur par défaut est utilisée.

Parametres configurables

access file name Global
Si vous utilisez Apache, vous pouvez conserver la valeur par défaut .htaccess. La valeur de ce paramètre est le nom du fichier d'accès qui sera écrit dans chaque répertoire utilisateur. Le contenu du fichier est donné dans la définition du fichier d'accès sur plusieurs lignes.

address Global

Adresse (adresse IP ou nom de domain) de la machine sur laquelle wcald tourne. La valeur par défaut est 127.0.0.1 c'est à dire localhost (la même machine où se trouve index.cgi). Généralement vous n'avez pas à changer ce paramètre.

base url Global

Il s'agit de l'URL sous laquelle vous avez installé Wcal. Par exemple si la racine HTML de votre serveur web est /home/httpd/html, et que vous avez installé Wcal sous le répertoire home/httpd/html/wcal, positionnez le paramètre à /wcal. La valeur par défaut est /wcal.

clock Global Groupe Utilisateur

You pouvez choisir d'afficher les heures au format 24 heures ou 12 heures. Les valeurs possibles sont:

data id Utilisateur

Ce paramètre permet de donner plusieurs noms pour un "utilisateur". Ceci est utile combiné avec le paramètre read only, puisqu'il vous permet de définir deux (ou plus) vues pour un agenda, une en lecture écriture et une autre en lecture seule. Voir Créer des agendas pour plus de détail.

database directory Global

Entrez le chemin absolu du répertoire où vous voulez que Wcal créé sa base de données. Wcal doit avoir le droit de créer ce répertoire (ou il doit déjà exister). La valeur par défaut est /var/wcal.

date format Global Groupe Utilisateur

La date est affiché dans différents formats suivant le pays. Wcal permet 5 formats différent pour afficher les dates. Ils sont numérotés de 1 à 5. La valeur par défaut est 1 qui est jour.mois.année. Les valeurs possibles sont :

  1. jour.mois.année
  2. mois/jour/année
  3. jour/mois/année
  4. année/mois/jour
  5. année-mois-jour
  6. YYYYMMDD where Y = année, M = mois and D = jour of mois

Si vous avez besoin d'autres formats, faites-en par à l'auteur.

day precision Global Groupe Utilisateur

Permet de fixer la précision utilisée dans la vue à la journée. Les valeurs possibles sont 1 (1 heure), 2 (30 minutes) ou 4 (15 minutes). Par exemple, si la ressource est positionnée à 4, la vue à la journée affichera 4 lignes par heure (10:00, 10:15, 10:30, 10:45). La valeur par défaut est 1 (1 heure).

default lock Global Groupe Utilisateur

Permet de préciser si une nouvelle tâche est verrouillée par défaut par l'utilisateur apache. Les valeurs possibles sont true et false. Si la ressource est positionnée à true, la case à cocher de verrouillage est cochée par défaut. La valeur par défaut est false.

Cette ressource n'est utilisé que pour les calendriers à accès restreint.

default priv Global Groupe Utilisateur

Permet de préciser si une nouvelle tâche est privée par défaut pour l'utilisateur apache. Les valeurs possibles sont true et false. Si la ressource est positionnée à true, la case à cocher privée (oeil) est cochée par défaut. La valeur par défaut est false.

Cette ressource n'est utilisé que pour les calendriers à accès restreint.

default todo Global Groupe Utilisateur

Permet de préciser si une nouvelle tâche sans heure possède ou no l'option persistant par défaut. Les valeurs possibles sont true et false. Si la ressource est positionnée à false, l'option persistant n'est pas sélectionnée par défaut. La valeur par défaut est true.

demo Global

Permet de configurer Wcal en mode déemonstration. Les valeurs possible sont yes ou no. Si la ressource est positionnée à yes, Wcal est en mode demonstration. Dans ce cas, l'écriture est désactivée. Vous ne pouvez pas ajouter, modifier ou supprimer des tâches dans les agendas . La valeur par défaut est no.

detailed week Global Groupe Utilisateur

Permet de contrôler si la vue à la semaine affiche les tâches de manière compacte ou non. Les valeurs possibles sont yes ou no. Si la ressource est positionnée à yes, la vue à la semaine ressemble à la vue à la journée avec un ligne pour chaque heure. Si la ressource est positionnée à no, les tâches sont compactées (am./pm.). La valeur par défaut est no.

disable fusion Global Groupe

Permet de contrôler l'usage de la fusion. Les valeurs possibles sont true et false. Si la ressource est positionnée à true, les boutons de fusion sont inaccessibles. La valeur par défaut est false.

disable purge Global Groupe Utilisateur

Permet de contrôler l'usage de la purge d'agenda. Les valeurs possibles sont true et false. Si la ressource est positionnée à true, le lien de purge est inaccessible pour l'agenda. La resource peut être positionnée pour tous les agendas (section global) ou pour seulement certains agenda (section utilisateur). La valeur par défaut est false.

event length Global

La ressource correspond à taille par défaut d'une tâche. Elle est exprimée en nombre d'unités de base. La valeur par défaut est 4 qui fixe la taille des tâches par défaut à une heure (4 x 15 minutes).

event precision Global

La ressource correspond à l'unité de base pour exprimer la taille d'une tâche. Elle est exprimée en minutes. La valeur par défaut est 15 qui permet de créer des tâches tous les quarts d'heure.

first day Global

Ceci définit quel jour commence la semaine. Les valeurs permises sont monday (lundi) ou sunday (dimanche). La valeur par défaut est monday.

ATTENTION : Vous ne pouvez fixer ce paramètre qu'avant d'accéder aux agendas pour la première fois. Ce paramètre conditionne la structure de la base de données Wcal. C'est pour cela que vous ne pouvez pas changer sa valeur après avoir créé la base. J'écrivrai peut-être un script de conservion d'une base monday vers une base sunday et vice-versa.

first hour Global

Ceci définit la première heure affichée dans la vue à la journée. Les valeurs possibles sont 0 à 23. La valeur par défaut est 8.

footer Global

Code HTML affiché en bas de toutes les vues. Par exemple vous pouvez ajouter un copyright :
footer = © 2003
Si la valeur de footer commence par un "/", elle est interprêtée comme un script. Le script est executé et la sortie est insérée dans le code HTML de la page. L'URL de la vue courante est passée en paramètre du script. Ce paramètre peut être utilisé pour construire le code HTML correspondant à insérer.

frame height Global Groupe Utilisateur

Cette ressource permet de définir la hauteur du cadre du haut (vue à la semaine) dans la vue standard de l'agenda. La hauteur peut être exprimée en pixels ou en pourcentage de la fenêtre de votre navigateur.

Exemple:

frame height = 50%
Si la hauteur du cadre n'est pas definie, la hauteur est définie par la ressource obsolète screen resolution :

frame width Global Groupe Utilisateur

Cette ressource permet de définir la largeur du cadre de gauche (vue à la journée) dans la vue standard de l'agenda. La largeur peut être exprimée en pixels ou en pourcentage de la fenêtre de votre navigateur.

Exemple:

frame width = 40%
Si la largeur du cadre n'est pas definie, la largeur est définie par la ressource obsolète screen resolution :

groups order Global Groupe

Controle l'ordre d'apparitions des groupes dans la page principale de Wcal. Par défaut (si la ressource n'est pas renseignée), les groupes apparaissent dans l'ordre dans lequel ils sont définis dans le fichier wcal.conf.

Exemple:

groups order = group2 group4 group1
Si des groupes déclarés dans wcal.conf ne sont pas présents dans la liste groups order, ils apparaissent après ceux présents dans la liste groups order.

last hour Global

Ceci définit la dernière heure affichée dans la vue à la journée. Les valeurs possibles sont 0 à 23. La valeur par défaut est 18.

long name Utilisateur Groupe

Si vous voulez une version plus détaillée du nom d'utilisateur ou de groupe, vous pouvez utiliser ce paramètre. La valeur de ce paramètre n'est utilisée que pour l'affichage.

mail command Global Groupe Utilisateur

Permet d'utiliser sa propre commande pour la vérification des alarmes à la place de la commande standard mail -s. Ceci est utile si votre OS ne possède pas de commande mail ou si vous souhaitez faire autre chose que simplement envoyer un mail sur alarme.

Le script appelé prend deux paramètres: le sujet et le destinataire du mail. Le corps du mail peut être récupéré en lisant l'entrée standard (stdin). Par exemple, pour tracer les alarmes, vous pouvez ajouter dans votre fichier wcal.conf :

mail command = /usr/local/bin/mymail
où mymail est quelque chose comme :
#!/usr/bin/perl

open(FILE, ">>/tmp/checkalarm.log");
print FILE "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n";
print FILE "subject: $ARGV[0]\n";
print FILE "to: $ARGV[1]\n";
print FILE "body:\n";
while ($line = <STDIN>)
{
    print FILE $line;
}
print FILE "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv\n";
Vous pouvez avoir des scripts différents pour plusieurs agendas.

organization Global

Tapez ici le nom de votre organisation ou toute autre chaine qui décrit l'instance de Wcal. Cette chaine apparait dans la page principale de Wcal.

overlap Global Groupe Utilisateur

Permet de contrôler si l'on peut avoir des plusieurs tâches sur la même zône (par exemple deux tâches qui commence en même temps. Les valeurs possibles sont true ou false. Si la ressource est positionnée à false, cela signifie qu'un message d'erreur apparaîtra si l'on essaie d'ajouter une tâche qui en chevauche une autre. Ceci est utile pour gérer un planning de réservation. La valeur par défaut est true.

password Global

Il s'agit d'une chaine pseudo-aléatoire. Vous devez la changer pour empêcher des accès non autorisés. index.cgi et wcald lisent tous les deux ce paramètre pour s'assurer que la requête ne provient pas d'un pirate. La valeur par défaut n'est pas pertinente.

port Global

Le port sur lequel wcald est en attente de requêtes et sur lequel se connecte index.cgi. Vous n'avez probablement pas besoin de changer ce paramètre.

read only Utilisateur

Les valeurs valides sont true et false. Si la valeur est true, l'utilisateur ne sera pas autorisé à modifier les données de l'agenda. Ce paramètre est utilisé en conjonction avec le paramètre data id. Voir Créer des agendas pour plus de détail.

refresh delay Global

Définit la fréquence de rafraichissement pour les vues à la semaine, au mois et à l'année. refresh delay est exprimé en secondes. Par exemple:
refresh delay = 900
signifie que les vues sont rafraichies toutes les 15 minutes. La valeur par défaut 0 signifie que les vues ne sont pas rafraichies.

remote cal Global

Agenda vérifié par checkalarm quand il est lancé sans argument. all signifie que checkalarm vérifiera tous les agendas. Voir Utiliser checkalarm pour plus de détail.

remote lang Global Groupe Utilisateur

Langue utilisée par Wcal. Les langues disponibles sont : Les bonnes volontés sont les bienvenues pour d'autres traductions. Voir /etc/wcald.msg.

remote mail Global Groupe Utilisateur

Adresse mail avertie par checkalarm quand il est lancé sans argument. Voir Utiliser checkalarm pour plus de détail.

show day time Global Groupe Utilisateur

Permet d'afficher ou non l'heure de début et de fin des tâches dans la vue à la journée. Les valeurs possibles sont yes ou no. La valeur par défaut est no.

show weekend Global Groupe Utilisateur

Permet d'afficher ou non les jours du weekend. Les valeurs possibles sont yes ou no. La valeur par défaut est yes.

ATTENTION : Quand ce paramètre est positionné à no, vous ne devez pas positionner le paramètre first day à sunday.

superuser Global Groupe Utilisateur

Definit l'utilisateur apache autorisé à modifier des tâches verrouillées. Par défaut, seul l'utilisateur qui a verrouillé la tâche peut la modifier. Le superuser peut modifier toutes les tâches verrouillées, même celles qui le sont par un autre utilisateur. Le superuser peut être défini dans la section globale (superuser pour tous les agendas), dans la section groupe (superuser pour tous les agendas du groupe) ou dans la section utilisateur (superuser pour un seul agenda).

Cette ressource n'est utilisé que pour les calendriers à accès restreint.

theme Global

Définit le thème graphique utilisé par Wcal. Si aucun thème n'est positionné, Wcal utilise le look par défaut. Voir le répertoire /var/www/html/wcal/themes pour plus d'informations.

Par exemple:

theme = mozilla

top left corner Global

Code HTML affiché dans le coin supérieur gauche des vues à la semaine, au mois et à l'année. Par exemple vous pouvez ajouter un lien sur la page principale du site web :
top left corner = <a href="/"><img src="/img/home.gif" border=0 alt="Page principale"></a>
Si la valeur de top left corner commence par un "/", elle est interprêtée comme un script. Le script est executé et la sortie est insérée dans le code HTML de la page. Des paramètres sont passés au script : Ces paramètres peuvent être utilisés pour construire le code HTML correspondant à insérer. Par exemple, vous pouvez ajouter un lien sur la page principale de l'utilisateur correspondant à l'agenda :
top left corner = /usr/local/bin/adduserlink.pl
Avec adduserlink.pl défini comme suit :
#!/usr/bin/perl

if ($ARGV[0] ne "wcal")
{
  print "<a href=\"/~$ARGV[0]\"><img src=\"/img/userhome.gif\" border=0 alt=\"Page principale de $ARGV[0]\"></a>";
} 

users order Global Groupe

Controle l'ordre d'apparitions des utilisateurs (agendas) dans la page principale de Wcal. Par défaut (si la ressource n'est pas renseignée), les utilisateurs apparaissent dans l'ordre dans lequel ils sont définis dans le fichier wcal.conf.

Exemple:

users order = savignon production commercial
Si des utilisateurs déclarés dans wcal.conf ne sont pas présents dans la liste users order, ils apparaissent après ceux présents dans la liste users order.

webserver name Global

Le nom du serveur serveur web. Cette ressource est utile pour construire une URL correcte dans les messages envoyés par checkalarm.

Par exemple :

webserver name = monserveurweb.org

webserver port Global

Le port qu'utilise le serveur web. Cette ressource est utile si vous avez utilisez Apache avec mod_perl sur un port redirigé. Par exemple, la configuration d'Apache de Mandrake utilise le port 8200 pour les requêtes utilisant mod_perl. Sur ajout de tâche, wcal va rediriger vers une URL contenant explicitement le port 8200. Pour éviter celà, vous pouvez positionner la ressource au véritable port à utiliser.

Par exemple :

webserver port = 80

week copy Global Groupe Utilisateur

Permet de préciser si la copie de semaine est oui ou non possible pour l'agenda. Les valeurs possibles sont yes ou no. La valeur par défaut est no.

Retour à la page principale de Wcal