Comment vérifier l’existence de fichiers et de dossiers de façon automatisée dans macOS ?

Dans le monde informatique, l’automatisation des tâches répétitives permet de gagner du temps et de réduire les erreurs. L’une de ces tâches consiste à vérifier l’existence de fichiers ou de dossiers spécifiques dans plusieurs répertoires. Qu’il s’agisse de conformité, de surveillance du système ou de dépannage, disposer d’un moyen automatisé de vérifier la présence de fichiers peut s’avérer inestimable pour les professionnels de l’informatique et les fournisseurs de services gérés (MSP). Cet article présente un script Bash conçu pour rationaliser ce processus et garantir l’efficacité et la fiabilité de la gestion des fichiers.

Contexte

Ce script est particulièrement utile pour les professionnels de l’informatique qui doivent vérifier régulièrement l’existence de fichiers ou de dossiers critiques. Il fournit une solution automatisée pour effectuer des recherches dans les répertoires, en s’assurant que les fichiers importants sont présents ou en identifiant leur absence. Cette capacité est cruciale dans divers scénarios, tels que la validation des emplacements de sauvegarde, la garantie de la présence de fichiers de configuration ou la confirmation du déploiement d’applications critiques.

Le script

#!/usr/bin/env bash

# Description: Alert if a specified file or folder is found in a directory or subdirectory you specify.
#
# Release Notes: Initial Release
# By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/terms-of-use.
# Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
# Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
# Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
# Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
# Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
# Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).
#
# Below are all the (case sensitive) valid parameters for this script.
# Only the path to search and name of file or folder are required!
#
# Parameter: --path "/opt/NinjaRMM/programdata"
#   Required
#   Base path to search for files or folders.
#
# Parameter: --name "ninjarmm-cli"
#   Required
#   Name of the file or folder to search for.
#   Notes:
#       If the name is not provided, the script will search for the path only.
#       This is case sensitive and accepts wildcards.
#
# Parameter: --type "Files Or Folders"
#   Required
#   Search for files or folders.
#
# Parameter: --type "Files Only"
#   Required
#   Searches for files only.
#
# Parameter: --type "Folders Only"
#   Required
#   Searches for folder only.
#
# Parameter: --timeout 10
#   Optional and defaults to 30 minutes
#   Time in minutes to wait for the search to complete before timing out.
#
# Parameter: --customfield "myCustomField"
#   Optional
#   Custom Field to save the search results to.

die() {
    local _ret="${2:-1}"
    test "${_PRINT_HELP:-no}" = yes && print_help >&2
    echo "$1" >&2
    exit "${_ret}"
}

begins_with_short_option() {
    local first_option all_short_options='h'
    first_option="${1:0:1}"
    test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
}

# Initize arguments
_arg_path=
_arg_name=
_arg_type=
_arg_timeout=30
_arg_customfield=

print_help() {
    printf '%s\n' "Check existence of a file or folder"
    printf 'Usage: %s [--path <arg>] [--name <arg>] [--type <"Files Only"|"Folders Only"|"Files Or Folders">] [--timeout <30>] [--customfield <arg>] [-h|--help]\n' "$0"
    printf '\t%s\n' "-h, --help: Prints help"
}

parse_commandline() {
    while test $# -gt 0; do
        _key="$1"
        case "$_key" in
        --path)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_path="$2"
            shift
            ;;
        --path=*)
            _arg_path="${_key##--path=}"
            ;;
        --name)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_name="$2"
            shift
            ;;
        --name=*)
            _arg_name="${_key##--name=}"
            ;;
        --type)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_type="$2"
            shift
            ;;
        --type=*)
            _arg_type="${_key##--type=}"
            ;;
        --timeout)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_timeout="$2"
            shift
            ;;
        --timeout=*)
            _arg_timeout="${_key##--timeout=}"
            ;;
        --customfield)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_customfield="$2"
            shift
            ;;
        --customfield=*)
            _arg_customfield="${_key##--customfield=}"
            ;;
        -h | --help)
            print_help
            exit 0
            ;;
        -h*)
            print_help
            exit 0
            ;;
        *)
            _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
            ;;
        esac
        shift
    done
}

parse_commandline "$@"

function SetCustomField() {
    customfieldName=$1
    customfieldValue=$2
    if [ -f "${NINJA_DATA_PATH}/ninjarmm-cli" ]; then
        if [ -x "${NINJA_DATA_PATH}/ninjarmm-cli" ]; then
            if "$NINJA_DATA_PATH"/ninjarmm-cli get "$customfieldName" >/dev/null; then
                # check if the value is greater than 10000 characters
                if [ ${#customfieldValue} -gt 10000 ]; then
                    echo "[Warn] Custom field value is greater than 10000 characters"
                fi
                if ! echo "${customfieldValue::10000}" | "$NINJA_DATA_PATH"/ninjarmm-cli set --stdin "$customfieldName"; then
                    echo "[Warn] Failed to set custom field"
                else
                    echo "[Info] Custom field value set successfully"
                fi
            else
                echo "[Warn] Custom Field ($customfieldName) does not exist or agent does not have permission to access it"
            fi
        else
            echo "[Warn] ninjarmm-cli is not executable"
        fi
    else
        echo "[Warn] ninjarmm-cli does not exist"
    fi
}

if [ ! "$(command -v timeout)" ]; then
    notimeout=true
    # If the timeout command does not exist, create a function to mimic the timeout command
    function timeout() { perl -e 'alarm shift; exec @ARGV' "$@"; }
fi

parentSearchPath=$_arg_path
leafSearchName=$_arg_name
searchType=$_arg_type
timeout=$_arg_timeout
customField=$_arg_customfield

# Get values from Script Variables
if [[ -n "${pathToSearch}" ]]; then
    parentSearchPath="${pathToSearch}"
fi
if [[ -n "${nameOfFileOrFolder}" ]]; then
    leafSearchName="${nameOfFileOrFolder}"
fi
if [[ -n "${filesOrFolders}" && "${filesOrFolders}" != "null" ]]; then
    searchType="${filesOrFolders}"
fi
if [[ -n "${searchTimeout}" && "${searchTimeout}" != "null" ]]; then
    timeout="${searchTimeout}"
fi
if [[ -n "${customFieldName}" && "${customFieldName}" != "null" ]]; then
    customField="${customFieldName}"
fi

# Check if parentSearchPath is a link and replace it with the resolved path
if [ -L "${parentSearchPath}" ]; then
    echo "[Info] Path to Search is a link: ${parentSearchPath} -> $(readlink -f "${parentSearchPath}")"
    echo "[Info] Will use the resolved path to search"
    parentSearchPath=$(readlink -f "${parentSearchPath}")
fi

if [[ -z "${parentSearchPath}" ]]; then
    echo "[Error] Path to Search is empty"
    exit 1
fi

# Check if path exists
if [ -e "${parentSearchPath}" ]; then
    echo "[Info] Path ${parentSearchPath} exists"
else
    echo "[Error] Path to Search ${parentSearchPath} does not exist or is an invalid path"
    exit 1
fi

# Check if timeout is a number
if ! [[ "${timeout}" =~ ^[0-9]+$ ]]; then
    echo "[Error] Timeout is not a number"
    exit 1
fi
# Check if timeout is not in the range of 1 to 120
if [[ "${timeout}" -lt 1 || "${timeout}" -gt 120 ]]; then
    echo "[Error] Timeout is not in the range of 1 to 120"
    exit 1
fi

# Check if search type is valid

if $notimeout; then
    # If the timeout command does not exist, convert the timeout to minutes
    timeout=$((timeout * 60))
else
    # If the timeout command does exist, add m to the end of the string
    timeout="${timeout}m"
fi

if [[ $OSTYPE == 'darwin'* ]]; then
    if ! plutil -lint /Library/Preferences/com.apple.TimeMachine.plist >/dev/null; then
        echo "This script requires ninjarmm-macagent to have Full Disk Access."
        echo "Add ninjarmm-macagent to the Full Disk Access list in System Preferences > Security & Privacy, quit the app, and re-run this script."
        exit 1
    fi
fi

# Search for files or folders
if [[ -n "${leafSearchName}" && "${leafSearchName}" != "null" ]]; then
    if [[ "${searchType}" == *"Files"* && "${searchType}" == *"Only"* ]]; then
        echo "[Info] Searching for files only"
        # Search for files only
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}" find "$parentSearchPath" -type f -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    elif [[ "${searchType}" == *"Folders"* && "${searchType}" == *"Only"* ]]; then
        echo "[Info] Searching for folders only"
        # Search for folders only
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}" find "$parentSearchPath" -type d -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    elif [[ "${searchType}" == *"Files"* && "${searchType}" == *"Folders"* ]]; then
        echo "[Info] Searching for files or folders"
        # Search for files or folders
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}" find "$parentSearchPath" -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    else
        echo "[Error] Invalid search type"
        echo "Valid search types: Files Only, Folders Only, Files Or Folders"
        exit 1
    fi
elif [[ -z "${leafSearchName}" ]]; then
    echo "[Info] Searching in path only"
    # Search in path only
    # Use timeout to prevent the find command from running indefinitely
    foundPath=$(timeout "${timeout}" find "$parentSearchPath")
    exitcode=$?
    if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
        if [[ -n $foundPath ]]; then
            echo "[Alert] File Found"
        fi
    fi
fi

# Check exit code
if [[ -n $foundPath ]]; then
    # Split the string into an array
    IFS=$'\n' read -rd '' -a foundPathArray <<<"${foundPath}"
    # Print each element of the array
    for element in "${foundPathArray[@]}"; do
        echo "[Alert] ${element} exists"
    done
elif [[ -z $foundPath ]]; then
    echo "[Warn] Could not find a file or folder"
    exit 1
else
    # If the find command fails to find the file or folder

    # Figure out the grammer for the search type
    if [[ "${searchType}" == *"Only"* ]]; then
        if [[ "${searchType}" == *"Files"* ]]; then
            searchTypeInfo="file"
        elif [[ "${searchType}" == *"Folders"* ]]; then
            searchTypeInfo="folder"
        fi
    elif [[ "${searchType}" == *"Files"* && "${searchType}" == *"Folders"* ]]; then
        searchTypeInfo="file or folder"
    fi
    echo "[Info] Could not find a ${searchTypeInfo} in the path ${parentSearchPath} with the name containing: ${leafSearchName}"
fi

# If foundPath contains "Alarm clock:" then the command timed out
if [[ "${foundPath}" == *"Alarm clock:"* ]]; then
    echo "[Alert] Timed out searching for file or folder"
    # Remove "Alarm clock: *" from the string
    foundPath=${foundPath/Alarm clock: [0-9]*//}
fi

# If command times out
if [[ $exitcode -ge 124 && $exitcode -le 127 || $exitcode -eq 137 ]]; then
    echo "[Alert] Timed out searching for file or folder"
    echo "timeout exit code: $exitcode"
    echo "  124  if COMMAND times out, and --preserve-status is not specified"
    echo "  125  if the timeout command itself fails"
    echo "  126  if COMMAND is found but cannot be invoked"
    echo "  127  if COMMAND cannot be found"
    echo "  137  if COMMAND (or timeout itself) is sent the KILL (9) signal (128+9)"
    echo "find command result: $foundPath"
    exit 1
fi

# Save to custom field
if [[ -n "${customField}" && "${customField}" != "null" ]]; then
    SetCustomField "${customField}" "${foundPath}"
fi

 

Description détaillée

Le script fonctionne en prenant plusieurs paramètres pour personnaliser le processus de recherche. Voici une description détaillée de ses fonctionnalités :

1. Paramètres et initialisation:

• –path: Spécifie le répertoire de base dans lequel la recherche doit être effectuée.

• –name: Définit le nom du fichier ou du dossier à rechercher, avec des caractères génériques.

• –type: Détermine si la recherche doit porter sur les fichiers, les dossiers ou les deux.

• –timeout: Définit la durée maximale de l’opération de recherche, fixée par défaut à 30 minutes.

• –customfield: Permet d’enregistrer le résultat de la recherche dans un champ personnalisé.

2. Analyse des arguments: Le script analyse les arguments de la ligne de commande pour initialiser les paramètres de recherche. Si l’un des paramètres requis est manquant, il envoie un message d’erreur et quitte le système.

3. Exécution de la recherche:

• Le script résout tous les liens symboliques dans le chemin de recherche.

• Il vérifie que le chemin spécifié existe et qu’il est valide.

• Il s’assure que le délai d’attente se situe dans la plage acceptable (1 à 120 minutes).

4. Recherche de fichiers ou de dossiers: En fonction du type spécifié (fichiers, dossiers ou les deux), le script utilise la commande find avec un délai d’attente pour localiser les éléments souhaités. S’il est trouvé, il alerte l’utilisateur et enregistre éventuellement le résultat dans un champ personnalisé.

5. Gestion des erreurs et rapports: Le script comprend une gestion complète des erreurs, garantissant que les problèmes tels que les chemins d’accès non valides, les valeurs de délai d’attente incorrectes ou les fichiers/dossiers inexistants sont clairement signalés à l’utilisateur.

Cas d’utilisation potentiels

Étude de cas : Vérification de la conformité des technologies de l’information

Un professionnel de l’informatique est chargé de veiller à ce que les fichiers de configuration de sécurité essentiels soient présents sur tous les serveurs. Grâce à ce script, ils peuvent automatiser le processus de vérification :

1. Setup:

• –-chemin: /etc/security

• —nom: security.conf

• –type: Fichiers uniquement

• –timeout: 10

2. Exécution : Le script recherche le fichier security.conf dans le chemin spécifié pendant le délai fixé. S’il est détecté, il enregistre une alerte ; s’il ne l’est pas, il avertit le professionnel de l’informatique, ce qui permet de remédier rapidement à la situation.

Comparaisons

Par rapport à une vérification manuelle ou à l’utilisation de commandes shell de base, ce script présente plusieurs avantages :

• Automatisation : Réduit la nécessité d’effectuer des contrôles manuels.

• Gestion des délais: Empêche les recherches prolongées en imposant un délai d’attente.

• Rapports personnalisés: Permet d’enregistrer les résultats dans des champs personnalisés en vue d’un traitement ultérieur ou d’un rapport de conformité.

D’autres méthodes, comme l’utilisation des commandes ls ou test dans Bash, ne disposent pas de ces fonctionnalités avancées, ce qui fait de ce script une solution plus robuste et plus efficace.

FAQ

1. Que se passe-t-il si le script n’aboutit pas ?
   Le script signale un dépassement de délai et se termine avec un code d’erreur approprié, ce qui permet à l’utilisateur de savoir que la recherche était incomplète.
2. Puis-je rechercher plusieurs types de fichiers simultanément ?
   Non, le script prend actuellement en charge la recherche de fichiers ou de dossiers sur la base d’un seul modèle de nom à la fois.
3. Comment gérer les liens symboliques dans le chemin de recherche ?
   Le script résout automatiquement les liens symboliques, ce qui garantit que la recherche est effectuée dans le bon répertoire.

Implications

L’utilisation de ce script peut améliorer considérablement la sécurité informatique en garantissant la présence des fichiers et dossiers critiques. La vérification automatisée contribue à maintenir la conformité avec les politiques de sécurité et réduit le risque de manquer des fichiers importants, ce qui pourrait entraîner des vulnérabilités ou des défaillances du système.

Recommandations

• Audits réguliers: Planifiez l’exécution régulière du script afin de maintenir à jour la vérification des fichiers critiques.

• Utilisation de champs personnalisés: Tirez parti de l’option des champs personnalisés pour suivre les résultats de la recherche et en rendre compte de manière systématique.

• Paramètres du délai d’attente: Ajustez le paramètre de délai d’attente en fonction de la taille prévue du répertoire et des performances du système afin d’éviter les retards inutiles.

Conclusion

Ce script Bash est un outil puissant pour les professionnels de l’informatique. Il fournit une méthode automatisée et fiable pour vérifier l’existence de fichiers et de dossiers. En intégrant ce script dans les contrôles de routine, les MSP peuvent garantir une efficacité et une sécurité accrues dans leurs opérations. Des outils tels que NinjaOne peuvent encore améliorer ce processus en offrant des solutions de gestion informatique complètes, facilitant le déploiement, la surveillance et la gestion des scripts sur plusieurs systèmes.

L’automatisation de la gestion des dossiers permet non seulement de gagner du temps, mais aussi d’améliorer la précision, en veillant à ce que les dossiers essentiels se trouvent toujours là où ils doivent être.