TP1 Powershell
TP1 - Script PowerShell de Sauvegarde
Présentation
Ce laboratoire vise à mettre en pratique les éléments du langage de scriptage PowerShell.
Vous aurez à réaliser un script complet permettant de réaliser la sauvegarde de répertoires en respectant les étapes présentées. Ce script est destiné à être utilisé par l'administrateur du système pour sauvegarder un ou plusieurs dossiers personnels d'utilisateur.
Livrable : Un script PowerShell nommé tp1.ps1 (pas de rapport)
Travail à faire
Partie principale
1. Shebang PowerShell
Assurez-vous que le script utilise PowerShell pour son exécution.
2. En-tête du script
Créez un en-tête (bloc de commentaires <#...#>) comprenant :
- Votre identification
- Le rôle du script
- Son utilisation
3. Gestion des paramètres
La partie principale du programme vérifiera tout d'abord si on a appelé le script avec -h ou --help.
a) Si aide demandée :
- Le script affichera un message d'aide classique sur l'utilisation du script (similaire à ceux trouvés dans les commandes PowerShell habituelles avec
Get-Help).
b) Sinon :
- Le script effectuera une boucle et utilisera chaque élément reçu en paramètre comme un utilisateur dont le répertoire personnel est à sauvegarder
- Appellera la fonction
Sauvegardeavec cet utilisateur en paramètre à chaque itération de la boucle
4. Affichage du grand total
Par la suite, à la fin, le script affichera le grand total des fichiers et répertoires traités.
Cas de figure de tests
Figure 1 - Aide
Si le script est appelé avec -h ou --help :
.\tp1.ps1 -h
Figure 2 - Sans paramètre
Si le script est appelé sans paramètre :
.\tp1.ps1
Figure 3 - Plusieurs utilisateurs
Si le script est appelé avec le nom de plusieurs usagers du système :
.\tp1.ps1 user1 user2 user3
Fonctions secondaires
5. Fonction Nombre-Fichiers
En fonction du paramètre reçu, elle trouvera tous les fichiers réguliers inclus et en donnera le nombre.
Paramètre : Chemin du dossier
Retour : Nombre de fichiers
6. Fonction Nombre-Dossiers
En fonction du paramètre reçu, elle trouvera tous les dossiers inclus et en donnera le nombre.
Paramètre : Chemin du dossier
Retour : Nombre de dossiers
7. Fonction Nombre-Fichiers-Archive
En fonction du nom d'archive reçu, comptez le nombre de fichiers (uniquement) dans l'archive.
Paramètre : Chemin de l'archive ZIP
Retour : Nombre de fichiers
Utilisation : System.IO.Compression.ZipFile
8. Fonction Nombre-Dossiers-Archive
En fonction du nom d'archive reçu, comptez le nombre de dossiers (uniquement) dans l'archive.
Paramètre : Chemin de l'archive ZIP
Retour : Nombre de dossiers
9. Fonction Dossier-Personnel
Si la fonction est appelée avec un paramètre, la fonction retournera le chemin complet du dossier personnel de cet utilisateur (simplement ajouter C:\Users\ au début).
Paramètre : Nom d'utilisateur
Retour : Chemin complet du dossier personnel
Vérification importante :
Avant de terminer son travail, la fonction vérifiera si le dossier qu'elle s'apprête à retourner existe. Si tel n'est pas le cas, le script affichera une erreur et se terminera (exit 1).
10. Fonction Log-Automatique
Cette fonction est appelée par défaut et permet de 'loguer' les manipulations de l'utilisateur ainsi que de 'loguer' les différentes fonctions appelées et les résultats de celles-ci.
Fonctionnalité : La fonction crée un fichier log.txt qui se trouve dans le répertoire C:\Temp\log.txt
Fonction Sauvegarde
10. Créez la fonction Sauvegarde
11. Déterminer « utilisateur »
- Si la fonction est appelée sans paramètre (paramètre vide ou null) alors la fonction utilisera l'utilisateur ayant appelé le script (
$env:USERNAME). - Sinon, utiliser le paramètre reçu comme étant le nom de l'utilisateur.
12. Déterminer le dossier « source »
Déterminez le dossier « source » au moyen de la fonction Dossier-Personnel en lui passant le paramètre reçu.
13. Déterminer l'archive de « destination »
Déterminez l'archive de « destination » au moyen de la structure suivante :
$env:TEMP\utilisateur_home_date.zip
Où :
- utilisateur provient de l'étape 11
- date provient de la fonction
Get-Dateet doit ressembler à :2020-12-06_125959
Exemple de résultat :
C:\Users\ppardo\AppData\Local\Temp\ppardo_home_2020-12-06_125959.zip
Format de la date :
Get-Date -Format "yyyy-MM-dd_HHmmss"
14. Effectuer l'archivage
Effectuez l'archivage du dossier « source » dans l'archive « destination », en utilisant la compression ZIP.
Important : Gérez les erreurs potentielles avec try/catch.
15. Afficher les informations
Affichez l'information suivante de manière claire et pratique :
- Le nom de l'utilisateur
- Le nombre de fichiers à archiver
- Le nombre de dossiers à archiver
- Le nombre de fichiers effectivement archivés
- Le nombre de dossiers effectivement archivés
16. Vérification et message final
Si le nombre de fichiers à archiver est égal au nombre de fichiers archivés :
- Affichez que le processus a fonctionné correctement
- Indiquez également où se trouve le fichier d'archive final
Sinon :
- Indiquez qu'il y a une erreur
Récapitulatif des fonctions à créer
| Fonction | Description | Paramètre(s) | Retour |
|---|---|---|---|
Nombre-Fichiers |
Compte les fichiers dans un dossier | Chemin du dossier | Nombre entier |
Nombre-Dossiers |
Compte les dossiers dans un dossier | Chemin du dossier | Nombre entier |
Nombre-Fichiers-Archive |
Compte les fichiers dans une archive ZIP | Chemin de l'archive | Nombre entier |
Nombre-Dossiers-Archive |
Compte les dossiers dans une archive ZIP | Chemin de l'archive | Nombre entier |
Dossier-Personnel |
Retourne le chemin du dossier personnel | Nom d'utilisateur | Chemin complet |
Log-Automatique |
Enregistre les opérations dans un fichier log | Messages à logger | Aucun |
Sauvegarde |
Fonction principale de sauvegarde | Nom d'utilisateur (optionnel) | Aucun |
Points importants à retenir
Gestion des erreurs
- Utiliser
try/catchlors de l'archivage - Vérifier l'existence des dossiers
- Utiliser
exit 1en cas d'erreur critique
Variables globales
- Maintenir des compteurs pour le grand total
- Additionner après chaque sauvegarde
Logging
- Créer le dossier
C:\Temps'il n'existe pas - Écrire les logs dans
C:\Temp\log.txt - Logger chaque fonction appelée et son résultat
Archivage ZIP
Utiliser les classes .NET :
Add-Type -AssemblyName System.IO.Compression.FileSystem
[System.IO.Compression.ZipFile]::CreateFromDirectory($source, $destination)
Format de sortie
Les informations doivent être affichées de manière claire et pratique. Utilisez :
Write-Hostavec des couleurs pour améliorer la lisibilité- Des séparateurs visuels (lignes, espaces)
- Un formatage cohérent
Conseils pour la réalisation
1. Commencez par les fonctions simples
Testez chaque fonction individuellement avant de les intégrer dans le script principal.
2. Utilisez des messages de débogage
Pendant le développement, ajoutez des Write-Host pour voir le flux d'exécution.
3. Testez avec différents scénarios
- Utilisateur qui n'existe pas
- Dossier vide
- Dossier avec beaucoup de fichiers
- Plusieurs utilisateurs dont certains n'existent pas
4. Gérez les permissions
Assurez-vous que le script a les droits nécessaires pour :
- Lire les dossiers personnels
- Créer des archives dans
$env:TEMP - Écrire dans
C:\Temp\
5. Documentation
Commentez votre code pour expliquer les parties complexes.
Bon travail ! 🚀
Schématisation du Script PowerShell tp1.ps1
Schéma général du script tp1.ps1
┌─────────────────────────────────────────────────────────────┐
│ DÉMARRAGE DU SCRIPT │
│ tp1.ps1 │
└────────────────────┬────────────────────────────────────────┘
│
▼
┌────────────────────────────┐
│ Vérification paramètres │
└────────────┬───────────────┘
│
┌────────────┴────────────┐
│ │
▼ ▼
[-h] ou [--help] ? Autres cas
│ │
│ │
▼ ▼
┌───────────────┐ ┌──────────────────┐
│ FIGURE 1 │ │ FIGURE 2 & 3 │
│ Aide │ │ Sauvegarde │
└───────────────┘ └──────────────────┘
FIGURE 1 : Affichage de l'aide
Commande : .\tp1.ps1 -h ou .\tp1.ps1 --help
┌─────────────────────────────────────────┐
│ DÉTECTION -h / --help │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Affichage du message d'aide │
│ │
│ - Nom du script │
│ - Description │
│ - Syntaxe d'utilisation │
│ - Exemples │
│ - Paramètres acceptés │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ FIN DU SCRIPT │
└─────────────────────────────────────────┘
FIGURE 2 : Sans paramètre (utilisateur courant)
Commande : .\tp1.ps1
┌─────────────────────────────────────────┐
│ AUCUN PARAMÈTRE FOURNI │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Appel fonction Sauvegarde() │
│ sans paramètre │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Utilisation de $env:USERNAME │
│ (utilisateur qui exécute le script)│
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Fonction Dossier-Personnel() │
│ → C:\Users\[utilisateur_courant]\ │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Archivage du dossier personnel │
│ → $env:TEMP\user_home_date.zip │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Affichage des statistiques │
│ - Nombre fichiers source/archivés │
│ - Nombre dossiers source/archivés │
│ - Chemin de l'archive │
└────────────────┬────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Affichage GRAND TOTAL │
└─────────────────────────────────────────┘
FIGURE 3 : Avec plusieurs utilisateurs
Commande : .\tp1.ps1 user1 user2 user3
┌────────────────────────────────────────────┐
│ PARAMÈTRES REÇUS : user1 user2 user3 │
└────────────────┬───────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ BOUCLE SUR CHAQUE UTILISATEUR │
└─────────────────────────────────────────┘
│ │ │
┌────┴────┐ ┌────┴────┐ ┌────┴────┐
│ user1 │ │ user2 │ │ user3 │
└────┬────┘ └────┬────┘ └────┬────┘
│ │ │
▼ ▼ ▼
┌─────────────┐┌─────────────┐┌─────────────┐
│ Sauvegarde ││ Sauvegarde ││ Sauvegarde │
│ (user1) ││ (user2) ││ (user3) │
└──────┬──────┘└──────┬──────┘└──────┬──────┘
│ │ │
▼ ▼ ▼
┌─────────────────────────────────────────┐
│ Dossier-Personnel(user1) │
│ → C:\Users\user1\ │
└──────┬──────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Nombre-Fichiers(C:\Users\user1\) │
│ Nombre-Dossiers(C:\Users\user1\) │
└──────┬──────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Archivage ZIP │
│ → $env:TEMP\user1_home_date.zip │
└──────┬──────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Nombre-Fichiers-Archive() │
│ Nombre-Dossiers-Archive() │
└──────┬──────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Affichage statistiques user1 │
└─────────────────────────────────────────┘
│
│ (Même processus pour user2 et user3)
│
▼
┌─────────────────────────────────────────┐
│ CUMUL DES TOTAUX │
│ - Total fichiers traités │
│ - Total dossiers traités │
└──────┬──────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ Affichage GRAND TOTAL │
└─────────────────────────────────────────┘
Schéma détaillé de la fonction Sauvegarde()
┌─────────────────────────────────────────┐
│ Fonction Sauvegarde([string]$user) │
└────────────────┬────────────────────────┘
│
▼
┌────────────────────┐
│ Paramètre vide ? │
└────┬──────────┬────┘
│ │
OUI │ │ NON
│ │
▼ ▼
┌──────────────┐ ┌──────────────┐
│$env:USERNAME│ │ Utiliser │
│ │ │ paramètre │
└────────┬─────┘ └──────┬───────┘
│ │
└────────┬───────┘
│
▼
┌───────────────────────────────────┐
│ Appel Dossier-Personnel($user) │
│ → Vérification existence dossier │
└────────────┬──────────────────────┘
│
┌────┴────┐
│ │
Existe N'existe pas
│ │
│ ▼
│ ┌─────────────┐
│ │ Erreur │
│ │ Exit 1 │
│ └─────────────┘
│
▼
┌──────────────────────────────────────┐
│ Compter fichiers/dossiers SOURCE │
│ - Nombre-Fichiers() │
│ - Nombre-Dossiers() │
└────────────┬─────────────────────────┘
│
▼
┌───────────────────────────────────┐
│ Création archive ZIP │
│ Try/Catch pour gérer erreurs │
│ → $env:TEMP\user_home_date.zip │
└────────────┬──────────────────────┘
│
▼
┌──────────────────────────────────────┐
│ Compter fichiers/dossiers ARCHIVE │
│ - Nombre-Fichiers-Archive() │
│ - Nombre-Dossiers-Archive() │
└────────────┬─────────────────────────┘
│
▼
┌───────────────────────────────────┐
│ Comparaison Source vs Archive │
└────┬──────────────────────────┬───┘
│ │
Égal │ │ Différent
│ │
▼ ▼
┌──────────┐ ┌───────────┐
│ SUCCÈS │ │ ERREUR │
│ Afficher│ │ Afficher │
│ chemin │ │ message │
└──────────┘ └───────────┘
Fonctions auxiliaires
┌────────────────────────────────────────────────┐
│ FONCTIONS AUXILIAIRES │
└────────────────────────────────────────────────┘
┌─────────────────────────────────────┐
│ Nombre-Fichiers($chemin) │
│ → Compte fichiers dans dossier │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ Nombre-Dossiers($chemin) │
│ → Compte dossiers dans dossier │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ Nombre-Fichiers-Archive($archive)│
│ → Compte fichiers dans ZIP │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ Nombre-Dossiers-Archive($archive)│
│ → Compte dossiers dans ZIP │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ Dossier-Personnel($user) │
│ → Retourne C:\Users\$user\ │
│ → Vérifie existence │
└─────────────────────────────────────┘
┌─────────────────────────────────────┐
│ Log-Automatique() │
│ → Écrit dans C:\Temp\log.txt │
└─────────────────────────────────────┘
Checklist de validation
- Le script commence par un en-tête de commentaires complet
- L'aide s'affiche avec
-hou--help - Le script fonctionne sans paramètre (utilisateur courant)
- Le script fonctionne avec un utilisateur
- Le script fonctionne avec plusieurs utilisateurs
- La fonction
Nombre-Fichiersest implémentée - La fonction
Nombre-Dossiersest implémentée - La fonction
Nombre-Fichiers-Archiveest implémentée - La fonction
Nombre-Dossiers-Archiveest implémentée - La fonction
Dossier-Personnelest implémentée et vérifie l'existence - La fonction
Log-Automatiqueest implémentée - La fonction
Sauvegardeest complète - Le format de date est correct (
yyyy-MM-dd_HHmmss) - Le chemin de l'archive suit la structure demandée
- L'archivage utilise la compression ZIP
- Les erreurs sont gérées avec
try/catch - Les statistiques s'affichent clairement
- La comparaison source vs archive fonctionne
- Le message de succès/erreur s'affiche correctement
- Le grand total s'affiche à la fin
- Le fichier de log est créé
- Le fichier de log est lisible et utilisable
- Le fichier se nomme exactement
tp1.ps1