✅ Instructions pour créer son propre module avec le module PERSONNEL

[Coccinelle]

Créer son module PERSONNEL

Introduction

Il existe 2 modules PERSONNEL sur le cocci-kit : PERSONNEL et PERSONNEL 2. Ils sont strictement identiques et s'utilisent de la même façon. Le fait qu'ils soient 2 n'est que pour apporter un confort supplémentaire, pour éviter de surcharger les scripts. Par exemple le premier module peut s'occuper d'installer des programmes, pendant que l'autre sera consacré aux réglages des programmes et du système.

Le module

PERSONNEL

est un module un peu à part. Il ne se télécharge pas, mais existe en local à côté des autres modules. Et c'est à vous qu'il appartient de construire le script d'installation/désinstallation afin que le module soit commandable depuis le cocci-kit. Il est d'ailleurs structuré de la même façon que les autres modules :

Un fichier batch  PERSONNEL.cmd  dans lequel figureront vos instructions d'installation/désinstallation.
Un fichier batch  PERSONNEL_instructions.cmd  régulièrement actualisé dans lequel vous retrouverez toutes les instructions dont vous avez besoin.
Un dossier  PERSONNEL  qui contient les fichiers utilisés pour le module.

Pour le module PERSONNEL2, vous retrouverez donc le fichier  PERSONNEL2.cmd  et le dossier  PERSONNEL2  (depuis le cocci-kit vous pouvez virtuellement renommer ces deux modules).

Depuis le cocci-kit, un clic pour installer, un clic pour désinstaller. En revanche, afin de garantir que votre travail ne soit pas supprimé par inadvertance, il n'a pas été prévu de pouvoir supprimer le module PERSONNEL depuis le cocci-kit via le clic droit sur le bouton d'installation.

Instructions d'utilisation

Vous n'avez que deux parties à compléter, chacune bien balisée pour ne pas vous perdre :

<---------------- ICI COMMENCE LA PARTIE À PERSONNALISER POUR *INSTALLER* VOTRE MODULE ----------------> 
Votre script d'installation
<----------------- ICI SE TERMINE LA PARTIE À PERSONNALISER POUR *INSTALLER* VOTRE MODULE -----------------> 


<----------------- ICI COMMENCE LA PARTIE À PERSONNALISER POUR *DESINSTALLER* VOTRE MODULE -----------------> 
Votre script de désinstallation
<---------------- ICI SE TERMINE LA PARTIE À PERSONNALISER POUR *DESINSTALLER* VOTRE MODULE ----------------> 

Le script est automatiquement lancé avec des DROITS ADMINISTRATEUR.
Le script est lancé en mode CACHÉ, la commande ECHO n'aura donc aucun effet visible. Pour afficher des informations, vous devrez lancer un script/programme supplémentaire (peu importe son langage).
La variable

%NOM%

retourne la valeur « PERSONNEL », qui est en fait le nom du module et aussi le nom du dossier conteneur pour ce module.
La variable

%CHEMIN_OUTILS%

retourne le chemin complet du dossier « PERSONNEL » dans lequel doivent être présents vos fichiers utilisé par le module. Ainsi, pour inscrire des informations du fichier "C:\COCCI10\modules\PERSONNEL\PERSONNEL.reg" dans le registre, vous pouvez utiliser une commande telle que (note : préférez toujours la commande REG IMPORT à REGEDIT pour une intégration pleine):

Code : Tout sélectionner

IF EXIST "%PROGRAMFILES(X86)%" (
	REG IMPORT "%CHEMIN_OUTILS%\%NOM%_INSTALLER.reg" /reg:64
	) ELSE (
	REG IMPORT "%CHEMIN_OUTILS%\%NOM%_INSTALLER.reg" /reg:32
)

Le chemin d'accès au dossier du module ne contient aucun espace. les guillemets ne sont donc pas nécessaires si aucun fichier ou dossier auquel vous souhaitez accéder au sein du module ne contient lui non plus d'espace.
Le cocci-kit étant un programme compilé en 32 bits, cela impacte la valeur renvoyée par certaines variables système. Ainsi, la variable

%ProgramFiles%

retournera toujours la valeur « C:\Program Files », mais si vous l'intégrez comme donnée d'une clé de registre, sa valeur deviendra « C:\Program Files (x86) ». jetez un œil au script du module DEMARRAGE pour voir comment cette contrainte a été contournée (avec la v ariable %ProgramW6432%).
Si vous souhaitez adapter votre script selon que Windows est en édition HOME ou PRO, vous pouvez vérifier la présence des fichiers

PRO

ou

HOME

créés automatiquement à chaque lancement du cocci-kit et que vous pouvez alors utiliser comme jetons :

Code : Tout sélectionner

IF EXIST "PRO" (
	votre script
)

IF EXIST "HOME" (
	votre script
)		

Si vous souhaitez adapter votre script selon que Windows est une édition 32 ou 64 bits, vous pouvez vérifier la présence des jetons

32

ou

64

:

Code : Tout sélectionner

IF EXIST "32" (
	Instructions exécutées uniquement sur une édition 32 bits
)

IF EXIST "64" (
	Instructions exécutées uniquement sur une édition 64 bits
)		

Si vous souhaitez adapter votre script selon que Windows est en version 10 ou 11, vous pouvez vérifier la présence des jetons

W10

et

W11

. Exemple :

Code : Tout sélectionner

IF EXIST "W10" (
	Instructions exécutées uniquement sur Windows 10
	)

IF EXIST "W11" (
	Instructions exécutées uniquement sur Windows 11
	)

Si vous souhaitez adapter votre script si votre écran est en résolution 4K, vous pouvez vérifier la présence du jeton

4K

:

Code : Tout sélectionner

IF EXIST "4K" (
	Instructions exécutées uniquement si la résolution du moniteur est en 4K
)

Le script doit impérativement rester encodé en ANSI (comme il l'est déjà). Vous pouvez ainsi utiliser les caractères accentués tant que vous laissez la commande « CHCP 1252 » (déjà présente) en début de fichier.
Lors du lancement du cocci-kit, si le dossier « PERSONNEL » est absent, il sera créé avec à l'intérieur les fichiers module_installe.vbs et module_desinstalle.vbs (voir ci-dessous contenu du fichier bach par défaut). Le fichier « PERSONNEL.cmd » sera également recréé au cas où il serait supprimé, mais en aucun cas il ne sera écrasé s'il existe déjà. Quand au fichier « PERSONNEL_instructions.cmd », il restera en permanence dans le dossier des modules et sera actualisé si besoin.
Détail qui tue : préférez les deux points « :: » au « REM » pour intégrer vos commentaires. REM est une commande, et à ce titre prend du temps de traitement... même si son but est de ne rien faire. En revanche, COMMAND.COM ne traitant pas les étiquettes, en convertissant une étiquette en commentaire avec un double-point pour éviter l'utilisation accidentelle de vrais labels permet de gagner en temps de traitement. Si vous avez envie de creuser le sujet : https://www.robvanderwoude.com/comments.php .
Facultatif, mais vivement conseillé, il est possible d'afficher un pourcentage évalué de progression de l'installation/désinstallation du module. Ajouter simplement la ligne suivante à chaque endroit où le pourcentage doit être modifié sur le cocci-kit :

Code : Tout sélectionner

ECHO|SET /p=Nombre entier de 0 à 100>>PROGRESSION

Exemple :

Code : Tout sélectionner

ECHO|SET /p=30>PROGRESSION
instructions
ECHO|SET /p=60>PROGRESSION
instructions
ECHO|SET /p=90>PROGRESSION
instructions

Si le script s'installe "trop" rapidement, vous pouvez le ponctuer de TIMEOUT <nb de scondes> entre chaque instruction afin que le pourcentage ait le temps de s'afficher. Exemple :

Code : Tout sélectionner

ECHO|SET /p=40>PROGRESSION
TIMEOUT 1
instructions
ECHO|SET /p=80>PROGRESSION
TIMEOUT 1
instructions

Toujours facultatif mais conseillé, il est possible d'afficher sur le cocci-kit le nom de l'élément en cours de traitement lors de l'installation/désinstallation du module. Ajouter simplement la ligne suivante à chaque phase où le nouveau texte doit apparaître sur le cocci-kit :

Code : Tout sélectionner

ECHO|SET /p=Chaîne de caractères>PROGRESSION_ELEMENT

Exemple incluant le pourcentage de progression :

Code : Tout sélectionner

ECHO|SET /p=10>PROGRESSION
ECHO|SET /p=Enregistrement dans le Registre des paramètres>PROGRESSION_ELEMENT
instructions
ECHO|SET /p=20>PROGRESSION
ECHO|SET /p=Suppression des fichiers obsolètes>PROGRESSION_ELEMENT
instructions

Le mot de la fin

Ne soyez surtout pas effrayés par la longueur de fichier batch par défaut : l'essentiel est rempli par des commentaires explicatifs. Prenez simplement le temps de l'éplucher, et vous constaterez à quel point un script personnel est facile à réaliser.