===== Modules standards W =====
==== Fonctions communes ====

Tous les modules possèdent obligatoirement 4 fonctions :

  - ''init''  ⇒ pour initialiser l'état interne du module (allocation mémoire si besoin, etc.). Appelé automatiquement au premier appel de fonction du module
  - ''end''  ⇒ pour libérer les ressources allouées dans ''init''. Appelé automatiquement à la terminaison du programme
  - ''vers(version)''  ⇒ renvoi la version en cours du module (variable ''version'' Number ou Dynamic)
  - ''error(modError)''  ⇒ renvoi la dernière erreur spécifique au module (variable ''modError'' Number)
Le pseudo module //template//  permet de tester ces 4 fonctions.


==== cipher ====

Module de chiffrement et déchiffrement de données.

  * ''toAES128(key, plaintext, encrypted)''  : chiffrement AES 128 bits de ''plaintext'' en utilisant la clé ''key'' (16 octets). Résultat chiffré dans ''encrypted''
  * ''fromAES128(key, encrypted, plaintext)''  : déchiffrement AES 128 bits de ''encrypted'' en utilisant la clé ''key'' (16 octets). Résultat en clair dans ''plaintext''
  * ''toAES192(key, plaintext, encrypted)''  : chiffrement AES 192 bits de ''plaintext'' en utilisant la clé ''key'' (16 octets). Résultat chiffré dans ''encrypted''
  * ''fromAES192(key, encrypted, plaintext)''  : déchiffrement AES 192 bits de ''encrypted'' en utilisant la clé ''key'' (24 octets). Résultat en clair dans ''plaintext''
  * ''toAES256(key, plaintext, encrypted)''  : chiffrement AES 256 bits de ''plaintext'' en utilisant la clé ''key'' (16 octets). Résultat chiffré dans ''encrypted''
  * ''fromAES256(key, encrypted, plaintext)''  : déchiffrement AES 256 bits de ''encrypted'' en utilisant la clé ''key'' (32 octets). Résultat en clair dans ''plaintext''


==== conv ====

Module permettant de faire des conversions de texte en hexadécimal et Base64.

  * ''toHexa(plaintext, hexadecimal)''  : convertit le texte en clair ''plaintext'' en une chaine hexadécimale ''hexadecimal''
  * ''fromHexa(heaxdecimal, plaintext)''  : convertit la chaine en hexadécimal ''hexadecimal'' en son équivalent en texte clair ''plaintext''
  * ''toBase64(plaintext, base64encoded)''  : convertit le texte en clair ''plaintext'' en une chaine codée en Base64 ''base64encoded''
  * ''fromBase64(base64encoded, plaintext)'' : convertit la chaine en Base64 ''base64encoded'' en son équivalent en texte clair ''plaintext''


==== file ====

Module permettant de gérer les fichiers de l'OS de l'hôte exécutant le programme en cours.

  * ''get(path, content)''  : lit le fichier, dont le chemin complet est donné dans ''path'', et renvoi son contenu dans ''content''. Renvoi //vide//  si le fichier est inconnu.
  * ''set(path, content)''  : écrit la variable Dynamic ''content''  dans le fichier dont le chemin complet est donné dans ''path''. Génère une exception si le chemin est inconnu, inaccessible, ou si les données ne peuvent pas être écrites (droits,…)
  * ''size(path, lentgh)''  : renvoi la taille, dans la variable Number ''length''  du fichier dont le chemin complet est donné par ''path''
  * ''delete(path)''  : supprimer le fichier dont le chemin complet est donné dans ''path''. Génère une exception si le fichier ne peut pas être supprimé.
  * ''rename(oldPath, newPath)''  : renomme/déplace le fichier ''oldPath''  en ''newPath''. Génère une exception en cas d'erreur (droits, FS différents, chemin cible inexistant).
  * ''append(path, content)''  : écrit la variable Dynamic ''content''  à la fin du fichier dont le chemin complet est donné dans ''path''. S'il n'existait pas, le fichier est créé. Génère une exception en cas d'erreur.
  * ''dir(path, fileList)''  : prend en compte le chemin donné par ''path'' et renvoi, dans la variable ''fileList''  , la liste des fichiers et répertoires trouvés dans le répertoire indiqué, en multi-champs. Les fichiers //spéciaux//  ne sont pas retournés (Unix seulement), ni les pseudo fichiers ''.''  et ''..''


==== hash ====

Module permettant de calculer différents //hash// de données, selon divers algorithmes.

   * ''MD2(plaintext, hashedText)''  : calcul le hash selon l'algorithme MD2 des données fournies dans ''plaintext'' et renvoi le résultat dans la variable ''hashedText''
  * ''MD4(plaintext, hashedText)''  : calcul le hash selon l'algorithme MD4 des données fournies dans ''plaintext'' et renvoi le résultat dans la variable ''hashedText''
  * ''MD5(plaintext, hashedText)''  : calcul le hash selon l'algorithme MD5 des données fournies dans ''plaintext''  et renvoi le résultat dans la variable ''hashedText''
  * ''Sha1(plaintext, hashedText)''  : calcul le hash selon l'algorithme Sha1 des données fournies dans ''plaintext'' et renvoi le résultat dans la variable ''hashedText''


==== json ====

NOTA : module/doc à revoir (treefetch et print)

  * ''decode(jsonText, extractedKey, extractedValue)''  : réalise le décodage du contenu json présent dans la variable chaîne ''jsonText'', et renvoie l'ensemble des clés/valeurs décodées dans les chaînes ''extractedKey''  et ''extractedValue''. Les informations globales liées au contenu json qui vient d'être décodé restent mémorisées dans le module.
  * ''print(extractedKey, extractedValue, prettyPrint)''  : restitue de manière lisible dans la variable chaîne ''prettyPrint''  le contenu json déjà décodé dans les 2 chaines ''extractedKey''  et ''extractedValue''.
  * ''treeFetch(fetchParameters, done)''  : récupère une série de clés, en utilisant les informations données par la hashtable ''fetchParameters''. La variable Numeric ''done''  renvoie ''@true''  quand la récupération est terminée, ''@false''  sinon. La hashtable ''fetchParameters''  doit contenir en entrée les deux chaines issues du décodage json. ''fetchParameters.DecodedKey''  doit recevoir ''extractedKey''  et ''fetchParameters.DecodedValue''  doit recevoir ''extractedValue''.


==== lex ====

Module permettant de faire des analyses syntaxiques sur des chaines, selon des règles données en paramètre.

  * ''compile(lexRules, compiledRules, [rulesNameSet])''  : à partir des règles lex, paramètre ''lexRules'', génère le format interne utilisé par le module, paramètre ''compiledRules'', pour les analyses de chaines en entrée. Si le paramètre ''rulesNameSet''  est présent, de type //hashtable//, il est rempli avec les constantes correspondant aux numéros de chaque règle
  * ''analyze(compiledRules, value, tokenList)''  : à partir des règles au format interne, paramètre ''compiledRules''  fourni par la fonction ''compile'', lit la chaine paramètre ''value''  et génère le résultat de l'analyse syntaxique dans le paramètre ''tokenList''. Le résultat contient les tokens trouvés, selon 3 champs en multi-champs ; chaque sous-champ donne l'élément trouvé, dans l'ordre :
      - ''token{1, x}''  : valeur du token en hexa (à décoder avec [[:refmodule#conv|conv&fromHexa]])
      - ''token{2, x}''  : numéro de la regle trouvée pour le token, à comparer avec les constantes créées suite à l'appel de la fonction // compile// (''rulesNameSet'')
      - ''token{3, x}''  : position du token trouvé dans la chaine source ''value''
  * ''getToken(tokenList, tokenIndex, tokenSet)''  : renvoie dans la //hashtable//  paramètre ''tokenSet''  le token trouvé (''.tokenNumber''''.tokenValue''''.tokenLocation''), indice dans le paramètre ''tokenIndex'', à partir de la liste de tous les tokens trouvés depuis le dernier //analyze//  (paramètre ''tokenList''). Si l'indice du token demandé n'est pas présent dans le résultat, ''.ruleNumber''  est renvoyé à 0.


==== lzw ====

Module permettant de compresser et décompresser des données, algorithme //LZW// compatible au format lzw utilisé dans les fichiers PDF.

   * ''set(plaintextThenCompressed)''  : compresse les données contenues dans la variable Dynamic ''plaintextThenCompressed'', et renvoi dans la même variable les données compressées, compatibles Lzw-PDF.
  * ''get(compressedThenPlaintext, reverse)''  : décompresse les données fournies dans la variable Dynamic ''compressedThenPlaintext'', et renvoi dans la même variable les données en clair. Mettre le paramètre ''reverse''  à ''@true''  pour décompresser des données spécifiquement au format GIF ; par défaut à ''@false'' (compatible Lzw-PDF).


==== pdf ====

NOTA : revoir la gestion des numéros des images (del_image change les numéros)

  * ''beginDoc(pdfParameterSet)''  : démarre un nouveau document Pdf. ''parameterSet''  est une hashtable qui doit contenir les champs suivants, permettant d'initialiser le document :
      * ''.Title''  : titre du document (string)
      * ''.Fonts''  : liste des fontes qui seront utilisées dans le document, chaîne contenant les noms des fontes en multi-champs (cf. tableau)
      * ''.Pages''  : nombre total de pages du document
      * ''.Format''  : nombre donnant la taille de chaque page - A4P A4L A3P A3L (1 2 3 4)
  * ''endDoc(pdfContent)''  : clôture le document Pdf en cours, et renvoie tout son contenu dans la chaine ''pdfContent''
  * ''addPage()''  : valide l'ajout d'une page au document Pdf en cours, à appeler après avoir ajouter les éléments de la page grâce aux fonctions qui suivent. Les pages sont toutes compactées avec l'algorithme Lzw.
  * ''addText(pdfParameterSet, string)''  : ajoute à la page courante la chaine ''string''  selon le formatage décrit dans la hashtable ''pdfParameterSet''  qui doit contenir les champs suivants :
      * ''.X'', ''.Y'', ''.W'', ''.H''  : position x,y et dimension w,h du cadre englobant la chaîne
      * ''.Font''  : nombre donnant la police à utiliser pour le rendu de la chaîne, indice dans la liste des polices envoyée à la fonction ''beginDoc''
      * ''.Size''  : taille de la police pour la fonte
      * ''.Color''  : couleur du texte, format RGB (R * 65536 + G * 256 + B)
  * ''addGraph(pdfParameterSet)''  : ajoute à la page courante un élément graphique décrit dans la hashtable <input> qui doit contenir les champs suivants :
      * ''.X'', ''.Y'', ''.W'', ''.H''  : position x,y et dimension w,h du cadre englobant l'élément
      * ''.StrokeColor''  : couleur des lignes, si affichées, de l'élément
      * ''.FillColor''  : couleur de remplissage de l'élément
      * ''.LineThickness''  : nombre donnant l'épaisseur des traits, de 0 à 9
      * ''.Dotted''  : nombre indiquant le type de ligne pointillé à utiliser, ou aucun, de 0 à 9
      * ''.Type''  : chaîne indiquant le type d'élément graphique à insérer :
        * ''L''  ligne
        * ''C''  cadre sans remplissage
        * ''R''  remplissage de la zone sans cadre
        * ''D''  cadre avec remplissage
  * ''addCab128(pdfParameterSet, string)''  : ajoute à la page la chaîne ''string''  transformée en code à barre EAN128, ''pdfParameterSet''  doit contenir les éléments suivants :
      * ''.X'', ''.Y'', ''.H''  : position x,y et hauteur h des barres
  * ''addImage(pdfParameterSet)''  : ajoute à la page courante une image déjà chargée au préalable, selon les informations décrites dans la hashtable ''pdfParameterSet''  qui doit contenir les champs suivants :
      * ''.X'', ''.Y''  : coordonnées x,y du coin haut/gauche de l'image dans la page
      * ''.ImageIndex''  : numéro de l'image
  * ''loadImage(image, format)''  : charge dans le module, pour un usage ultérieur, l'image dont le contenu est passé dans la chaîne ''image''. La première image chargée porte le numéro 1, etc. Formats supportés, chaîne ''format''  : //BMP//  (32bpp) et //GIF//.
  * ''delImage(imageIndex)''  : supprime l'image numéro ''imageIndex''  du module ; elle ne pourra plus être utilisée par la suite (NOTA pbm de numéro avec suppression)
  * ''listing(pdfParameterSet, textThenPdfContent)''  : créé un document Pdf, de type //listing//, avec les données textuelle de ''textThenPdfContent''  et renvoie le contenu du Pdf généré dans ''textThenPdfContent''. Les éléments permettant de créer le listing sont donnés par la hashtable ''pdfParameterSet''  qui doit contenir les champs suivants :
      * ''.Title''  : titre du listing (texte)
      * ''.Format''  : nombre donnant le format de la page à utiliser : A4P A4L (1 2)
Liste des fontes ⇒

|Courier|1|
|Courier_Bold|2|
|Courier_BoldOblique|3|
|Courier_Oblique|4|
|Helvetica|5|
|Helvetica_Bold|6|
|Helvetica_BoldOblique|7|
|Helvetica_Oblique|8|
|Times_Roman|9|
|Times_Bold|10|
|Times_Italic|11|
|Times_BoldItalic|12|
|Symbol|13|
|ZapfDingbats|14|


==== random ====

Module permettant de générer des nombres pseudo-aléatoires, algorithme //Mersenne twister//.

   * ''setSeed(seedValue)''  : utilise le nombre ''seedValue'' donné, pour initialiser le générateur de nombres pseudo-aléatoires
  * ''get(nextRandomNumber)''  : renvoi dans ''nextRandomNumber''  le prochain nombre pseudo-aléatoire calculé par le générateur (nombre entier)


==== shm ====

//NOTA// : module à finir, revoir doc (newprocessshmreader/writer) Module gérant la communication inter-processus, basée sur des messages textes. Chaque processus possède une //queue// qui permet de recevoir les messages émis par les autres processus.

   * ''get(content)''  : renvoi dans ''content''  le prochain message reçu depuis la queue interne du processus en cours. S'il n'y a pas de message à lire, renvoi //vide//.
  * ''set(textMessage, processName)''  : envoi le message texte ''textMessage''  au processus identifié par ''processName''. L'identifiant d'un process est le nom donné au module principal dans l'instruction ''begin''  ou ''background''  du programme W.


==== sock ====

Module gérant la communication sockets, côté //serveur// et côté //client//. Les données transitent __en clair__.

   * ''server(portNumber)''  : créé un point d'entrée //serveur//  sur le n° de ''portNumber''  indiqué (n° autorisés : 1024 à 65535 uniquement). Le module ne gère qu'un seul serveur actif au même moment.
  * ''wait(timeout, clientSock)''  : attend une demande de connexion entrante depuis un client. Si une demande de connexion est acceptée, ''clientSock''  contient en retour un id de connexion, à mémoriser car il servira a identifier la connexion à utiliser lors des lectures ''get''  et écritures ''set''  entre ce client et le serveur. Si aucune connexion n'est demandée au bout du délai ''timeout''  (en secondes), l'id renvoyé dans ''clientSock''  est négatif, confirmant qu'aucune de demande de connexion n'est arrivée dans le délai indiqué. Le module gère plusieurs connexions entrantes simultanées.
  * ''stopServer''  : supprime le point d'entrée serveur créé avec ''server''.
  * ''connect(host, portNumber, socket)''  : initie une connexion socket au serveur ''host''  sur le n° de ''portNumber''  (sans limitation de numéro). ''host''  peut contenir un nom de serveur, mais aussi une adresse IP v4. Quand la demande est acceptée par le serveur, ''socket''  contient en retour un id de connexion, à mémoriser car il servira a identifier la connexion à utiliser lors des lectures ''get''  / écritures ''set''  entre ce client et le serveur. Quand la demande est refusée, une exception est générée. Le module gère plusieurs connexions sortantes simultanées.
  * ''stop(socket)''  : arrête la connexion identifiée par l'id ''socket'', que ce soit la partie cliente donnée par ''connect''  aussi bien que la partie serveur donnée par ''wait''.
  * ''get(socket, data, timeout)''  : lit les données venant de l'autre côté de la connexion identifiée par l'id ''socket''. Les données lues sont renvoyées dans la chaîne ''data''. Si aucune donnée d'est disponible au bout du délai ''timeout''  donné, (en secondes), la chaîne ''data''  est renvoyée //vide//.
  * ''set(socket, data)''  : écrit les données de ''data''  sur la connexion identifiée par l'id ''socket''.
  * ''getHostname(name, ip)''  : renvoi le nom (dans ''name'') et l'addresse ip (dans ''ip'') de l'hôte qui exécute le programme en cours.


==== wssh ====

Module basé sur ''lib_ssh'' permettant l'accès sécurisé à un serveur.

   * ''openSession(host, username, password)''  : ouvre une connexion sécurisée vers le serveur ''host''  (nom ou adresse IP), en utilisant l'authentification ''username''  /''password''
  * ''endSession''  : ferme la connexion courante
  * ''execChannel(command, response, timeout)''  : exécute la commande ''command''  sur le serveur distant, et lit la réponse dans ''response'', en utilisant la paramètre ''timeout''  comme délai de lecture (en seconde).
  * ''openChannel''  : ouvre un //pseudo terminal//  sur le serveur distant.
  * ''closeChannel''  : termine le //pseudo terminal//  distant.
  * ''readChannel(response, timeout)''  : lit la réponse du serveur distant dans ''response'', en utilisant ''timeout''  comme délai de lecture (en seconde).
  * ''writeChannel(command)''  : exécute la commande ''command''  sur le serveur distant
  * ''openSftp''  : ouvre un canal de type //transfer//  avec le serveur distant.
  * ''closeSftp''  : ferme le canal de type //transfert//  mais laisse la connexion au serveur ouverte.
  * //to be continued…//
Pour l'exécution de commandes ponctuelles, le worflow typique d'exécution est le suivant :

<code wlang>
;
invoke wssh&openSession(host, user, pwd)
;
; do something
;
invoke wssh&execChannel(cmd, res, timeout)
;
; do another thing
;
invoke wssh&execChannel(cmd, res, timeout)
;
; terminate
invoke wssh&endSession
;


</code>

Pour l'exécution de plusieurs commandes à la suite les unes des autres, tel une émulation de terminal distant, voici le workflow à utiliser :

<code wlang>
;
invoke wssh&openSession(host, user, pwd)
invoke wssh&openChannel
;
; read login information
invoke wssh&readChannel(res, timeout)
;
loop
   ;
   invoke wssh&writeChannel(cmd)
   ;
   invoke wssh&readChannel(res, timeout)
   ;
endloop
;
; terminate
invoke wssh&endSession
;


</code>


==== system ====

Module gérant les liens avec le shell et l'OS hôte.

  * ''execute(command, returnCode, [capturing])''  : execute la commande OS ''command''  dans un shell. Renvoi le code retour de la commande dans ''returnCode''. SI le 3ème paramètre ''capturing''  est fourni, il contient en retour la sortie générée par la commande dans le terminal (sortie standard)
  * ''getEnv(varName, value)''  : renvoi dans ''value''  le contenu de la variable d'environnement (dans la session courante) nommée ''varName''. Génère l'exception EXMOD_SYSTEM_UNKNOWNVARENV si la variable d'environnement est inconnue
  * ''createEnv(varName, value)''  : créé la variable d'environnement nommée ''varName''  dans la session courante, avec la valeur ''value''. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est déjà présente (utiliser ''updateEnv''  dans ce cas)
  * ''updateEnv(varName, value)''  : met à jour la variable d'environnement ''varName''  avec la valeur ''value''. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est inconnue de la session en cours.
  * ''deleteEnv(varName)''  : supprime la variable d'environnement nommée ''varName''  de la session courante. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est inconnue
  * ''getOS(OScode)''  : renvoi un code, dans le paramètre ''OScode'', indiquant le type de l'OS hôte du programme en cours (de type chaîne) : //Windows//, //Linux//
  * ''sendSignal(pid, signalNumber)''  : envoi le signal numéro ''signalNumber''  au processus identifié par son numéro ''pid''. Seuls les 3 signaux SIGTERM, SIGINT, SIGUSR1 sont pris en charge. Les autres sont ignorés. Fonction compatible Unix/Windows mais sous Windows, ce sont des évènements qui sont générés, pas des signaux ; SIGTERM et SIGINT génèrent un évènement ''Global\\wterm<pid>''  et SIGUSR1 génère un évènement ''Global\\wdebug<pid>''
  * ''sleep(duration)''  : endort le process en cours, pour une durée de ''duration''  secondes


==== time ====

Module permettant de manipuler des horodates, en TU et temps local, de mesurer le temps passé (chrono) et de gérer des alarmes temporelles.

  * ''startChrono''  : démarre le chronomètre, pour mesurer une durée
  * ''lapChrono(duration)''  : donne le temps passé en secondes depuis le dernier appel de start ou lap (variable Number ''duration'')
  * ''setUTC(timeParameterSet, format, date)''  : mémorise dans la hashtable ''timeParameterSet''  la date UTC passée dans ''date''  selon le format ''format''. Le résultat est stocké dans ''.timestamp''  et ''.offset''
  * ''setLocal(timeParameterSet, format, date)''  : idem setUTC ci-dessus mais sur une date fournie dans le fuseau local
  * ''setNowLocal(timeParameterSet)''  : mémorise la date locale en cours, résultat dans la hashtable ''timeParameterSet''  idem ci-dessus
  * ''setNowUTC(timeParameterSet)''  : idem setNowLocal ci-dessus maus sur une date fournie en UTC
  * ''set(timeParameterSet, format, date)''  : mémorise dans la hashtable ''timeParameterSet''  la date passée dans ''date''  selon le format ''format'', format qui indique le fuseau de la date fournie, selon la norme ISO8601
  * ''getUTC(timeParameterSet, format, date)''  : renvoi dans ''date''  la date mémorisée dans la hashtable ''timeParameterSet'', selon le format défini dans ''format''  et en UTC
  * ''getLocal(timeParameterSet, format, date)''  : idem getUTC ci-dessus mais renvoi la date dans le fuseau local
  * ''get(timeParameterSet, format, date)''  : idem ci-dessus, mais c'est le format qui indique si la date retournée est en UTC ou dans un fuseau local, format à la norme ISO8601
  * ''alarmUTCHM(hhmm, endTime, duration)''  : déclare une alarme quotidienne, à déclencher à l'heure ''hhmm''  en heure UTC. Renvoi le timestamp de fin dans ''endTime''  et le delai entre chaque alarme dans ''duration''
  * ''alarmLocalHM(hhmm, endTime, duration)''  : idem alarmUTCHM ci-dessus, mais l'heure donnée est dans le fuseau local