common/path/RTPathRmCmd.cpp

	RTPathRmCmd.cpp revision 8502773207230763deba3e622495f2099398dcb0
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync/* $Id$ */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync/** @file
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * IPRT - TAR Command.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync/*
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * Copyright (C) 2013 Oracle Corporation
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * available from http://www.virtualbox.org. This file is free software;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * you can redistribute it and/or modify it under the terms of the GNU
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * General Public License (GPL) as published by the Free Software
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * The contents of this file may alternatively be used under the terms
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * of the Common Development and Distribution License Version 1.0
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * VirtualBox OSE distribution, in which case the provisions of the
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * CDDL are applicable instead of those of the GPL.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * You may elect to license modified versions of this file under the
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * terms and conditions of either the GPL or the CDDL or both.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync/*******************************************************************************
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync*   Header Files                                                               *
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync*******************************************************************************/
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync#include <iprt/path.h>
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync#include <iprt/buildconfig.h>
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#include <iprt/ctype.h>
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#include <iprt/file.h>
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#include <iprt/dir.h>
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync#include <iprt/getopt.h>
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#include <iprt/initterm.h>
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#include <iprt/message.h>
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#include <iprt/stream.h>
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync#include <iprt/string.h>
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync#include <iprt/symlink.h>
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/*******************************************************************************
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync*   Defined Constants And Macros                                               *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync*******************************************************************************/
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#define RTPATHRMCMD_OPT_INTERACTIVE         1000
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#define RTPATHRMCMD_OPT_ONE_FILE_SYSTEM     1001
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#define RTPATHRMCMD_OPT_PRESERVE_ROOT       1002
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#define RTPATHRMCMD_OPT_NO_PRESERVE_ROOT    1003
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#define RTPATHRMCMD_OPT_MACHINE_READABLE    1004
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/** The max directory entry size. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync#define RTPATHRM_DIR_MAX_ENTRY_SIZE         4096
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/*******************************************************************************
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync*   Structures and Typedefs                                                    *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync*******************************************************************************/
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/** Interactive option. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsynctypedef enum
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    RTPATHRMCMDINTERACTIVE_NONE = 1,
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    RTPATHRMCMDINTERACTIVE_ALL,
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    RTPATHRMCMDINTERACTIVE_ONCE
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    /** @todo possible that we should by default prompt if removing read-only
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     *        files or files owned by someone else. We currently don't. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync} RTPATHRMCMDINTERACTIVE;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/**
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * IPRT rm option structure.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsynctypedef struct RTPATHRMCMDOPTS
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Whether to delete recursively. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    bool                    fRecursive;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Whether to delete directories as well as other kinds of files. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    bool                    fDirsAndOther;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Whether to remove files without prompting and ignoring non-existing
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * files.  */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    bool                    fForce;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Machine readable output. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    bool                    fMachineReadable;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Don't try remove root ('/') if set, otherwise don't treat root specially. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    bool                    fPreserveRoot;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Whether to keep to one file system. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    bool                    fOneFileSystem;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** Whether to safely delete files (overwrite 3x before unlinking). */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    bool                    fSafeDelete;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    /** Whether to be verbose about the operation. */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    bool                    fVerbose;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /** The interactive setting. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    RTPATHRMCMDINTERACTIVE  enmInteractive;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync} RTPATHRMCMDOPTS;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync/** Pointer to the IPRT rm options. */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsynctypedef RTPATHRMCMDOPTS *PRTPATHRMCMDOPTS;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/*******************************************************************************
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync*   Global Variables                                                           *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync*******************************************************************************/
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync/** A bunch of zeros. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic uint8_t const    g_abZeros[16384] = { 0 };
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/** A bunch of 0xFF bytes. (lazy init) */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic uint8_t          g_ab0xFF[16384];
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsyncstatic void rtPathRmVerbose(PRTPATHRMCMDOPTS pOpts, const char *pszPath)
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync{
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    if (!pOpts->fMachineReadable)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        RTPrintf("%s\n", pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync}
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic int rtPathRmError(PRTPATHRMCMDOPTS pOpts, const char *pszPath, int rc,
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                         const char *pszFormat, ...)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (pOpts->fMachineReadable)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        RTPrintf("fname=%s%crc=%d%c", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    else
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        va_list va;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        va_start(va, pszFormat);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        RTMsgErrorV(pszFormat, va);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        va_end(va);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    }
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    return rc;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync}
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
ee994aafbbf90369e5381e7c81b82a3462b32923vboxsync
ee994aafbbf90369e5381e7c81b82a3462b32923vboxsync/**
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * Worker that removes a symbolic link.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @returns IPRT status code, errors go via rtPathRmError.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * @param   pOpts               The RM options.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pszPath             The path to the symbolic link.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic int rtPathRmOneSymlink(PRTPATHRMCMDOPTS pOpts, const char *pszPath)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (pOpts->fVerbose)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rtPathRmVerbose(pOpts, pszPath);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    int rc = RTSymlinkDelete(pszPath, 0);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return rtPathRmError(pOpts, pszPath, rc, "Error removing symbolic link '%s': %Rrc\n", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    return rc;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync}
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/**
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * Worker that removes a file.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * Currently used to delete both regular and special files.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @returns IPRT status code, errors go via rtPathRmError.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pOpts               The RM options.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pszPath             The path to the file.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pObjInfo            The FS object info for the file.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic int rtPathRmOneFile(PRTPATHRMCMDOPTS pOpts, const char *pszPath, PRTFSOBJINFO pObjInfo)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    int rc;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (pOpts->fVerbose)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rtPathRmVerbose(pOpts, pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Wipe the file if requested and possible.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync     */
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync    if (pOpts->fSafeDelete && RTFS_IS_FILE(pObjInfo->Attr.fMode))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        /* Lazy init of the 0xff buffer. */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (g_ab0xFF[0] != 0xff || g_ab0xFF[sizeof(g_ab0xFF) - 1] != 0xff)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            memset(g_ab0xFF, 0xff, sizeof(g_ab0xFF));
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        RTFILE hFile;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = RTFileOpen(&hFile, pszPath, RTFILE_O_WRITE);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rtPathRmError(pOpts, pszPath, rc, "Opening '%s' for overwriting: %Rrc\n", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        for (unsigned iPass = 0; iPass < 3; iPass++)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        {
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            uint8_t const *pabFiller = iPass == 1 ? g_abZeros         : g_ab0xFF;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            size_t const   cbFiller  = iPass == 1 ? sizeof(g_abZeros) : sizeof(g_ab0xFF);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            rc = RTFileSeek(hFile, 0, RTFILE_SEEK_BEGIN, NULL);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            if (RT_FAILURE(rc))
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                rc = rtPathRmError(pOpts, pszPath, rc, "Error seeking to start of '%s': %Rrc\n", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            for (RTFOFF cbLeft = pObjInfo->cbObject; cbLeft > 0; cbLeft -= cbFiller)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            {
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                size_t cbToWrite = cbFiller;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                if (cbLeft < (RTFOFF)cbToWrite)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                    cbToWrite = (size_t)cbLeft;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                rc = RTFileWrite(hFile, pabFiller, cbToWrite, NULL);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                if (RT_FAILURE(rc))
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                    rc = rtPathRmError(pOpts, pszPath, rc, "Error writing to '%s': %Rrc\n", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                    break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        int rc2 = RTFileClose(hFile);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rtPathRmError(pOpts, pszPath, rc2, "Closing '%s' failed: %Rrc\n", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rc;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Remove the file.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    rc = RTFileDelete(pszPath);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return rtPathRmError(pOpts, pszPath, rc,
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                             RTFS_IS_FILE(pObjInfo->Attr.fMode)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                             ? "Error removing regular file '%s': %Rrc\n"
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                             : "Error removing special file '%s': %Rrc\n",
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                             pszPath, rc);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    return rc;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync}
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/**
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * Deletes one directory (if it's empty).
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @returns IPRT status code, errors go via rtPathRmError.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pOpts               The RM options.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pszPath             The path to the directory.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic int rtPathRmOneDir(PRTPATHRMCMDOPTS pOpts, const char *pszPath)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (pOpts->fVerbose)
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        rtPathRmVerbose(pOpts, pszPath);
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync    int rc = RTDirRemove(pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return rtPathRmError(pOpts, pszPath, rc, "Error removing directory '%s': %Rrc", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    return rc;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync}
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync/**
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * Recursively delete a directory.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @returns IPRT status code, errors go via rtPathRmError.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pOpts               The RM options.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pszPath             Pointer to a writable buffer holding the path to
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *                              the directory.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   cchPath             The length of the path (avoid strlen).
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pDirEntry           Pointer to a directory entry buffer that is
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync *                              RTPATHRM_DIR_MAX_ENTRY_SIZE bytes big.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync * @param   pObjInfo            Pointer the FS object info for the directory.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync *                              This will be modified.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic int rtPathRmRecursive(PRTPATHRMCMDOPTS pOpts, char *pszPath, size_t cchPath, PRTDIRENTRY pDirEntry, PRTFSOBJINFO pObjInfo)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Make sure the path ends with a slash.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (!cchPath || !RTPATH_IS_SLASH(pszPath[cchPath - 1]))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        if (cchPath + 1 >= RTPATH_MAX)
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            return rtPathRmError(pOpts, pszPath, VERR_BUFFER_OVERFLOW, "Buffer overflow fixing up '%s'.\n", pszPath);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        pszPath[cchPath++] = RTPATH_SLASH;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        pszPath[cchPath]   = '\0';
a9b1e67691cff873b2d9c1120a748dfd786d97ffvboxsync    }
a9b1e67691cff873b2d9c1120a748dfd786d97ffvboxsync
a9b1e67691cff873b2d9c1120a748dfd786d97ffvboxsync    /*
a9b1e67691cff873b2d9c1120a748dfd786d97ffvboxsync     * Traverse the directory.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    PRTDIR hDir;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    int rc = RTDirOpen(&hDir, pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return rtPathRmError(pOpts, pszPath, rc, "Error opening directory '%s': %Rrc", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    int rcRet = VINF_SUCCESS;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    for (;;)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        /*
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync         * Read the next entry, constructing an full path for it.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync         */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        size_t cbEntry = RTPATHRM_DIR_MAX_ENTRY_SIZE;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = RTDirRead(hDir, pDirEntry, &cbEntry);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (rc == VERR_NO_MORE_FILES)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            pszPath[cchPath] = '\0';
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            rc = RTDirClose(hDir);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                return rtPathRmError(pOpts, pszPath, rc, "Error closing directory '%s': %Rrc", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            /* Delete the directory. */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            int rc2 = rtPathRmOneDir(pOpts, pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            if (RT_FAILURE(rc2) && RT_SUCCESS(rcRet))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                return rc2;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rcRet;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc))
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            rc = rtPathRmError(pOpts, pszPath, rc, "Error reading directory '%s': %Rrc", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        if (cchPath + pDirEntry->cbName > RTPATH_MAX)
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        {
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            pszPath[cchPath] = '\0';
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            rc = rtPathRmError(pOpts, pszPath, VERR_BUFFER_OVERFLOW, "Path buffer overflow in directory '%s'.", pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            break;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        }
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        memcpy(pszPath + cchPath, pDirEntry->szName, pDirEntry->cbName + 1);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync         * Just query the full path info as we'll need it.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync         */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = RTPathQueryInfoEx(pszPath, pObjInfo, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            rc = rtPathRmError(pOpts, pszPath, rc, "RTPathQueryInfoEx failed on '%s': %Rrc", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            if (RT_SUCCESS(rcRet))
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                rcRet = rc;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        }
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync         * Take action according to the type.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync         */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        switch (pObjInfo->Attr.fMode & RTFS_TYPE_MASK)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            case RTFS_TYPE_FILE:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                rc = rtPathRmOneFile(pOpts, pszPath, pObjInfo);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            case RTFS_TYPE_DIRECTORY:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                rc = rtPathRmRecursive(pOpts, pszPath, cchPath, pDirEntry, pObjInfo);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            case RTFS_TYPE_SYMLINK:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                rc = rtPathRmOneSymlink(pOpts, pszPath);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                break;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            case RTFS_TYPE_FIFO:
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            case RTFS_TYPE_DEV_CHAR:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            case RTFS_TYPE_DEV_BLOCK:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            case RTFS_TYPE_SOCKET:
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                rc = rtPathRmOneFile(pOpts, pszPath, pObjInfo);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync                break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            case RTFS_TYPE_WHITEOUT:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            default:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                rc = rtPathRmError(pOpts, pszPath, VERR_UNEXPECTED_FS_OBJ_TYPE,
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                                   "Object '%s' has an unknown file type: %o\n", pszPath, pObjInfo->Attr.fMode & RTFS_TYPE_MASK);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                break;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc) && RT_SUCCESS(rcRet))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            rcRet = rc;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    RTDirClose(hDir);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    return rc;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync}
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync/**
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * Remove one user specified file or directory.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync *
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @returns IPRT status code, errors go via rtPathRmError.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pOpts               The RM options.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync * @param   pszPath             The path to the file, directory, whatever.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsyncstatic int rtPathRmOne(PRTPATHRMCMDOPTS pOpts, const char *pszPath)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync{
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Refuse to remove '.' and '..'.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    const char *pszFilename = RTPathFilename(pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (   pszFilename[0] == '.'
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        && (   pszFilename[1] == '\0'
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            || (pszFilename[1] == '.' && pszFilename[2] == '\0')))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return rtPathRmError(pOpts, pszPath, VERR_CANT_DELETE_DIRECTORY, "Cannot remove directory '%s'.\n", pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Query file system object info.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    RTFSOBJINFO ObjInfo;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    int rc = RTPathQueryInfoEx(pszPath, &ObjInfo, RTFSOBJATTRADD_UNIX, RTPATH_F_ON_LINK);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (pOpts->fForce && (rc == VERR_FILE_NOT_FOUND || rc == VERR_PATH_NOT_FOUND))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return VINF_SUCCESS;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return rtPathRmError(pOpts, pszPath, rc, "Error deleting '%s': %Rrc", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Take type specific action.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    switch (ObjInfo.Attr.fMode & RTFS_TYPE_MASK)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        case RTFS_TYPE_FILE:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rtPathRmOneFile(pOpts, pszPath, &ObjInfo);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        case RTFS_TYPE_DIRECTORY:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            if (pOpts->fRecursive)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                char szPath[RTPATH_MAX];
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                rc = RTPathAbs(pszPath, szPath, sizeof(szPath));
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                    return rtPathRmError(pOpts, pszPath, rc, "RTPathAbs failed on '%s': %Rrc\n", pszPath, rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                union
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                    RTDIRENTRY  Core;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                    uint8_t     abPadding[RTPATHRM_DIR_MAX_ENTRY_SIZE];
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                } DirEntry;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                return rtPathRmRecursive(pOpts, szPath, strlen(szPath), &DirEntry.Core, &ObjInfo);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            if (pOpts->fDirsAndOther)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync                return rtPathRmOneDir(pOpts, pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rtPathRmError(pOpts, pszPath, VERR_IS_A_DIRECTORY, "Cannot remove '%s': %Rrc\n", pszPath, VERR_IS_A_DIRECTORY);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        case RTFS_TYPE_SYMLINK:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return rtPathRmOneSymlink(pOpts, pszPath);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        case RTFS_TYPE_FIFO:
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        case RTFS_TYPE_DEV_CHAR:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        case RTFS_TYPE_DEV_BLOCK:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        case RTFS_TYPE_SOCKET:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            return rtPathRmOneFile(pOpts, pszPath, &ObjInfo);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync        case RTFS_TYPE_WHITEOUT:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        default:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            return rtPathRmError(pOpts, pszPath, VERR_UNEXPECTED_FS_OBJ_TYPE,
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                                 "Object '%s' has an unknown file type: %o\n", pszPath, ObjInfo.Attr.fMode & RTFS_TYPE_MASK);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    }
af4f17cef2a9025fd52d548565055c179914fbfavboxsync}
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsyncRTDECL(RTEXITCODE) RTPathRmCmd(unsigned cArgs, char **papszArgs)
af4f17cef2a9025fd52d548565055c179914fbfavboxsync{
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    /*
af4f17cef2a9025fd52d548565055c179914fbfavboxsync     * Parse the command line.
af4f17cef2a9025fd52d548565055c179914fbfavboxsync     */
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    static const RTGETOPTDEF s_aOptions[] =
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    {
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        /* operations */
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--dirs-and-more",        'd', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--force",                'f', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--prompt",               'i', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--prompt-once",          'I', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--interactive",      RTPATHRMCMD_OPT_INTERACTIVE, RTGETOPT_REQ_STRING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--one-file-system",  RTPATHRMCMD_OPT_ONE_FILE_SYSTEM, RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--preserve-root",    RTPATHRMCMD_OPT_PRESERVE_ROOT, RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--no-preserve-root", RTPATHRMCMD_OPT_NO_PRESERVE_ROOT, RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--recursive",            'R', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--recursive",            'r', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--safe-delete",          'P', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--verbose",              'v', RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        /* IPRT extensions */
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--machine-readable", RTPATHRMCMD_OPT_MACHINE_READABLE, RTGETOPT_REQ_NOTHING },
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        { "--machinereadable",  RTPATHRMCMD_OPT_MACHINE_READABLE, RTGETOPT_REQ_NOTHING }, /* bad long option style */
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    };
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    RTGETOPTSTATE GetState;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    int rc = RTGetOptInit(&GetState, cArgs, papszArgs, s_aOptions, RT_ELEMENTS(s_aOptions), 1,
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                          RTGETOPTINIT_FLAGS_OPTS_FIRST);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    if (RT_FAILURE(rc))
af4f17cef2a9025fd52d548565055c179914fbfavboxsync        return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTGetOpt failed: %Rrc", rc);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    RTPATHRMCMDOPTS Opts;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    RT_ZERO(Opts);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    Opts.fPreserveRoot  = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    Opts.enmInteractive = RTPATHRMCMDINTERACTIVE_NONE;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync    RTGETOPTUNION   ValueUnion;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync    while (   (rc = RTGetOpt(&GetState, &ValueUnion)) != 0
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync           && rc != VINF_GETOPT_NOT_OPTION)
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync    {
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync        switch (rc)
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync        {
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync            case 'd':
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync                Opts.fDirsAndOther = true;
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync                break;
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'f':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fForce = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.enmInteractive = RTPATHRMCMDINTERACTIVE_NONE;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'i':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.enmInteractive = RTPATHRMCMDINTERACTIVE_ALL;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'I':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.enmInteractive = RTPATHRMCMDINTERACTIVE_ONCE;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case RTPATHRMCMD_OPT_INTERACTIVE:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                if (!strcmp(ValueUnion.psz, "always"))
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                    Opts.enmInteractive = RTPATHRMCMDINTERACTIVE_ALL;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                else if (!strcmp(ValueUnion.psz, "once"))
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                    Opts.enmInteractive = RTPATHRMCMDINTERACTIVE_ONCE;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                else
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                    return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown --interactive option value: '%s'\n", ValueUnion.psz);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case RTPATHRMCMD_OPT_ONE_FILE_SYSTEM:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fOneFileSystem = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case RTPATHRMCMD_OPT_PRESERVE_ROOT:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fPreserveRoot = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case RTPATHRMCMD_OPT_NO_PRESERVE_ROOT:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fPreserveRoot = false;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'R':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'r':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fRecursive = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fDirsAndOther = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'P':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fSafeDelete = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'v':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fVerbose = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case RTPATHRMCMD_OPT_MACHINE_READABLE:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                Opts.fMachineReadable = true;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                break;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'h':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                RTPrintf("Usage: to be written\nOption dump:\n");
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                for (unsigned i = 0; i < RT_ELEMENTS(s_aOptions); i++)
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                    if (RT_C_IS_PRINT(s_aOptions[i].iShort))
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                        RTPrintf(" -%c,%s\n", s_aOptions[i].iShort, s_aOptions[i].pszLong);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                    else
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                        RTPrintf(" %s\n", s_aOptions[i].pszLong);
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                return RTEXITCODE_SUCCESS;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            case 'V':
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                RTPrintf("%sr%d\n", RTBldCfgVersion(), RTBldCfgRevision());
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                return RTEXITCODE_SUCCESS;
af4f17cef2a9025fd52d548565055c179914fbfavboxsync
af4f17cef2a9025fd52d548565055c179914fbfavboxsync            default:
af4f17cef2a9025fd52d548565055c179914fbfavboxsync                return RTGetOptPrintError(rc, &ValueUnion);
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync        }
a796d19cd138035efa1811d1c270f81d039f1f24vboxsync    }
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Options we don't support.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync     */
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    if (Opts.fOneFileSystem)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return RTMsgErrorExit(RTEXITCODE_FAILURE, "The --one-file-system option is not yet implemented.\n");
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (Opts.enmInteractive != RTPATHRMCMDINTERACTIVE_NONE)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return RTMsgErrorExit(RTEXITCODE_FAILURE, "The -i, -I and --interactive options are not implemented yet.\n");
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * No files means error.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (rc != VINF_GETOPT_NOT_OPTION && !Opts.fForce)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        return RTMsgErrorExit(RTEXITCODE_FAILURE, "No files or directories specified.\n");
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Machine readable init + header.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (Opts.fMachineReadable)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = RTStrmSetMode(g_pStdOut, true /*fBinary*/, false /*fCurrentCodeSet*/);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc))
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTStrmSetMode failed: %Rrc.\n", rc);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        static const char s_achHeader[] = "hdr_id=rm\0hdr_ver=1";
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        RTStrmWrite(g_pStdOut, s_achHeader, sizeof(s_achHeader));
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    }
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    /*
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     * Delete the specified files/dirs/whatever.
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync     */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    while (rc == VINF_GETOPT_NOT_OPTION)
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    {
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = rtPathRmOne(&Opts, ValueUnion.psz);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        if (RT_FAILURE(rc))
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync            rcExit = RTEXITCODE_FAILURE;
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync        /* next */
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = RTGetOpt(&GetState, &ValueUnion);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    if (rc != 0)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rcExit = RTGetOptPrintError(rc, &ValueUnion);
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync    /*
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync     * Terminate the machine readable stuff.
6728a36898fd2be125a28e84d2115d19aa4923edvboxsync     */
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync    if (Opts.fMachineReadable)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    {
ac153c99053f1edf42b00bf3a13475923bc4fcf1vboxsync        RTStrmWrite(g_pStdOut, "\0\0\0", 4);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        rc = RTStrmFlush(g_pStdOut);
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync        if (RT_FAILURE(rc) && rcExit == RTEXITCODE_SUCCESS)
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync            rcExit = RTEXITCODE_FAILURE;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    }
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync    return rcExit;
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync}
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync
9562e2d410460d8fae06fa24297f172fee1d1995vboxsync