1 files changed, 291 insertions, 0 deletions
diff --git a/src/VBox/Runtime/generic/createtemp-generic.cpp b/src/VBox/Runtime/generic/createtemp-generic.cpp
new file mode 100644
index 00000000..6630e249
--- /dev/null
+++ b/src/VBox/Runtime/generic/createtemp-generic.cpp
@@ -0,0 +1,291 @@
+/* $Id: createtemp-generic.cpp $ */
+/** @file
+ * IPRT - temporary file and directory creation, generic implementation.
+ */
+
+/*
+ * Copyright (C) 2009-2023 Oracle and/or its affiliates.
+ *
+ * This file is part of VirtualBox base platform packages, as
+ * available from https://www.virtualbox.org.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, in version 3 of the
+ * License.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses>.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
+ * in the VirtualBox distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
+ */
+
+
+/*********************************************************************************************************************************
+*   Header Files                                                                                                                 *
+*********************************************************************************************************************************/
+#include <iprt/dir.h>
+#include "internal/iprt.h"
+
+#include <iprt/assert.h>
+#include <iprt/err.h>
+#include <iprt/file.h>
+#include <iprt/path.h>
+#include <iprt/rand.h>
+#include <iprt/string.h>
+
+
+/**
+ * The X'es may be trailing, or they may be a cluster of 3 or more inside
+ * the file name.
+ */
+static int rtCreateTempValidateTemplate(char *pszTemplate, char **ppszX, unsigned *pcXes)
+{
+    AssertPtr(pszTemplate);
+    AssertPtr(ppszX);
+    AssertPtr(pcXes);
+
+    unsigned    cXes = 0;
+    char       *pszX = strchr(pszTemplate, '\0');
+    if (   pszX != pszTemplate
+        && pszX[-1] != 'X')
+    {
+        /* look inside the file name. */
+        char *pszFilename = RTPathFilename(pszTemplate);
+        if (   pszFilename
+            && (size_t)(pszX - pszFilename) > 3)
+        {
+            char *pszXEnd = pszX - 1;
+            pszFilename += 3;
+            do
+            {
+                if (   pszXEnd[-1] == 'X'
+                    && pszXEnd[-2] == 'X'
+                    && pszXEnd[-3] == 'X')
+                {
+                    pszX = pszXEnd - 3;
+                    cXes = 3;
+                    break;
+                }
+            } while (pszXEnd-- != pszFilename);
+        }
+    }
+
+    /* count them */
+    while (   pszX != pszTemplate
+           && pszX[-1] == 'X')
+    {
+        pszX--;
+        cXes++;
+    }
+
+    /* fail if none found. */
+    *ppszX = pszX;
+    *pcXes = cXes;
+    AssertReturn(cXes > 0, VERR_INVALID_PARAMETER);
+    return VINF_SUCCESS;
+}
+
+
+static void rtCreateTempFillTemplate(char *pszX, unsigned cXes)
+{
+    static char const s_sz[] = "0123456789abcdefghijklmnopqrstuvwxyz";
+    unsigned j = cXes;
+    while (j-- > 0)
+        pszX[j] = s_sz[RTRandU32Ex(0, RT_ELEMENTS(s_sz) - 2)];
+}
+
+
+RTDECL(int) RTDirCreateTemp(char *pszTemplate, RTFMODE fMode)
+{
+    char       *pszX = NULL;
+    unsigned    cXes = 0;
+    int rc = rtCreateTempValidateTemplate(pszTemplate, &pszX, &cXes);
+    if (RT_FAILURE(rc))
+    {
+        *pszTemplate = '\0';
+        return rc;
+    }
+    /*
+     * Try ten thousand times.
+     */
+    int i = 10000;
+    while (i-- > 0)
+    {
+        rtCreateTempFillTemplate(pszX, cXes);
+        rc = RTDirCreate(pszTemplate, fMode, 0);
+        if (RT_SUCCESS(rc))
+            return rc;
+        if (rc != VERR_ALREADY_EXISTS)
+        {
+            *pszTemplate = '\0';
+            return rc;
+        }
+    }
+
+    /* we've given up. */
+    *pszTemplate = '\0';
+    return VERR_ALREADY_EXISTS;
+}
+RT_EXPORT_SYMBOL(RTDirCreateTemp);
+
+
+/** @todo Test case for this once it is implemented. */
+RTDECL(int) RTDirCreateTempSecure(char *pszTemplate)
+{
+    /* bool fSafe; */
+
+    /* Temporarily convert pszTemplate to a path. */
+    size_t cchDir = 0;
+    RTPathParseSimple(pszTemplate, &cchDir, NULL, NULL);
+    char chOld = pszTemplate[cchDir];
+    pszTemplate[cchDir] = '\0';
+    /** @todo Implement this. */
+    int rc = /* RTPathIsSecure(pszTemplate, &fSafe) */ VERR_NOT_SUPPORTED;
+    pszTemplate[cchDir] = chOld;
+    if (RT_SUCCESS(rc) /* && fSafe */)
+        return RTDirCreateTemp(pszTemplate, 0700);
+
+    *pszTemplate = '\0';
+    /** @todo Replace VERR_PERMISSION_DENIED.  VERR_INSECURE? */
+    return RT_FAILURE(rc) ? rc : VERR_PERMISSION_DENIED;
+}
+RT_EXPORT_SYMBOL(RTDirCreateTempSecure);
+
+
+RTDECL(int) RTFileCreateUnique(PRTFILE phFile, char *pszTemplate, uint64_t fOpen)
+{
+    /*
+     * Validate input.
+     */
+    *phFile = NIL_RTFILE;
+    AssertReturn((fOpen & RTFILE_O_ACTION_MASK) == RTFILE_O_CREATE, VERR_INVALID_FLAGS);
+    char       *pszX = NULL;
+    unsigned    cXes = 0;
+    int rc = rtCreateTempValidateTemplate(pszTemplate, &pszX, &cXes);
+    if (RT_SUCCESS(rc))
+    {
+        /*
+         * Try ten thousand times.
+         */
+        int i = 10000;
+        while (i-- > 0)
+        {
+            rtCreateTempFillTemplate(pszX, cXes);
+            RTFILE hFile = NIL_RTFILE;
+            rc = RTFileOpen(&hFile, pszTemplate, fOpen);
+            if (RT_SUCCESS(rc))
+            {
+                *phFile = hFile;
+                return rc;
+            }
+            /** @todo Anything else to consider? */
+            if (rc != VERR_ALREADY_EXISTS)
+            {
+                *pszTemplate = '\0';
+                return rc;
+            }
+        }
+
+        /* we've given up. */
+        rc = VERR_ALREADY_EXISTS;
+    }
+    *pszTemplate = '\0';
+    return rc;
+}
+RT_EXPORT_SYMBOL(RTFileCreateUnique);
+
+
+RTDECL(int) RTFileCreateTemp(char *pszTemplate, RTFMODE fMode)
+{
+    RTFILE hFile = NIL_RTFILE;
+    int rc = RTFileCreateUnique(&hFile, pszTemplate,
+                                RTFILE_O_WRITE | RTFILE_O_DENY_ALL | RTFILE_O_CREATE | RTFILE_O_NOT_CONTENT_INDEXED
+                                | fMode << RTFILE_O_CREATE_MODE_SHIFT);
+    if (RT_SUCCESS(rc))
+        RTFileClose(hFile);
+    return rc;
+}
+RT_EXPORT_SYMBOL(RTFileCreateTemp);
+
+
+/** @todo Test case for this once it is implemented. */
+RTDECL(int) RTFileCreateTempSecure(char *pszTemplate)
+{
+    /* bool fSafe; */
+
+    /* Temporarily convert pszTemplate to a path. */
+    size_t cchDir = 0;
+    RTPathParseSimple(pszTemplate, &cchDir, NULL, NULL);
+    char chOld = pszTemplate[cchDir];
+    pszTemplate[cchDir] = '\0';
+    /** @todo Implement this. */
+    int rc = /* RTPathIsSecure(pszTemplate, &fSafe) */ VERR_NOT_SUPPORTED;
+    pszTemplate[cchDir] = chOld;
+    if (RT_SUCCESS(rc) /* && fSafe */)
+        return RTFileCreateTemp(pszTemplate, 0600);
+
+    *pszTemplate = '\0';
+    /** @todo Replace VERR_PERMISSION_DENIED.  VERR_INSECURE? */
+    return RT_FAILURE(rc) ? rc : VERR_PERMISSION_DENIED;
+}
+RT_EXPORT_SYMBOL(RTFileCreateTempSecure);
+
+
+RTDECL(int) RTFileOpenTemp(PRTFILE phFile, char *pszFilename, size_t cbFilename, uint64_t fOpen)
+{
+    AssertReturn((fOpen & RTFILE_O_ACTION_MASK) == RTFILE_O_CREATE, VERR_INVALID_FLAGS);
+    AssertReturn(fOpen & RTFILE_O_WRITE, VERR_INVALID_FLAGS);
+
+    /*
+     * Start by obtaining the path to the temporary directory.
+     */
+    int rc = RTPathTemp(pszFilename, cbFilename);
+    if (RT_SUCCESS(rc))
+    {
+        /*
+         * Add a filename pattern.
+         */
+        static char const s_szTemplate[] = "IPRT-XXXXXXXXXXXX.tmp";
+        rc = RTPathAppend(pszFilename, cbFilename, s_szTemplate);
+        if (RT_SUCCESS(rc))
+        {
+            char * const pszX = RTStrEnd(pszFilename, cbFilename) - (sizeof(s_szTemplate) - 1) + 5;
+            unsigned     cXes = sizeof(s_szTemplate) - 1 - 4 - 5;
+            Assert(pszX[0] == 'X'); Assert(pszX[-1] == '-'); Assert(pszX[cXes] == '.');
+
+            /*
+             * Try 10000 times with random names.
+             */
+            unsigned cTriesLeft = 10000;
+            while (cTriesLeft-- > 0)
+            {
+                rtCreateTempFillTemplate(pszX, cXes);
+                rc = RTFileOpen(phFile, pszFilename, fOpen);
+                if (RT_SUCCESS(rc))
+                    return rc;
+            }
+        }
+    }
+
+    if (cbFilename)
+        *pszFilename = '\0';
+    *phFile = NIL_RTFILE;
+    return rc;
+}
+RT_EXPORT_SYMBOL(RTFileOpenTemp);
+