diff options
Diffstat (limited to '')
| -rw-r--r-- | src/VBox/Runtime/r3/fs.cpp | 274 |
1 files changed, 274 insertions, 0 deletions
diff --git a/src/VBox/Runtime/r3/fs.cpp b/src/VBox/Runtime/r3/fs.cpp new file mode 100644 index 00000000..41f7de8d --- /dev/null +++ b/src/VBox/Runtime/r3/fs.cpp @@ -0,0 +1,274 @@ +/* $Id: fs.cpp $ */ +/** @file + * IPRT - File System. + */ + +/* + * Copyright (C) 2006-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/fs.h> +#include "internal/iprt.h" + +#include <iprt/asm.h> +#include <iprt/assert.h> +#include <iprt/ctype.h> +#include <iprt/path.h> +#include <iprt/string.h> +#include <iprt/time.h> +#include "internal/fs.h" + + +/** + * Converts dos-style attributes to Unix attributes. + * + * @returns Normalized mode mask. + * @param fMode The mode mask containing dos-style attributes only. + * @param pszName The filename which this applies to (exe check). + * @param cbName The length of that filename. (optional, set 0) + * @param uReparseTag The reparse tag if RTFS_DOS_NT_REPARSE_POINT is set. + * @param fType RTFS_TYPE_XXX to normalize against, 0 if not known. + */ +RTFMODE rtFsModeFromDos(RTFMODE fMode, const char *pszName, size_t cbName, uint32_t uReparseTag, RTFMODE fType) +{ + Assert(!(fType & ~RTFS_TYPE_MASK)); + + fMode &= ~((1 << RTFS_DOS_SHIFT) - 1); + + /* Forcibly set the directory attribute if caller desires it. */ + if (fType == RTFS_TYPE_DIRECTORY) + fMode |= RTFS_DOS_DIRECTORY; + + /* Everything is readable. */ + fMode |= RTFS_UNIX_IRUSR | RTFS_UNIX_IRGRP | RTFS_UNIX_IROTH; + if (fMode & RTFS_DOS_DIRECTORY) + /* Directories are executable. */ + fMode |= RTFS_TYPE_DIRECTORY | RTFS_UNIX_IXUSR | RTFS_UNIX_IXGRP | RTFS_UNIX_IXOTH; + else + { + fMode |= RTFS_TYPE_FILE; + if (!cbName && pszName) + cbName = strlen(pszName); + if (cbName >= 4 && pszName[cbName - 4] == '.') + { + /* check for executable extension. */ + const char *pszExt = &pszName[cbName - 3]; + char szExt[4]; + szExt[0] = RT_C_TO_LOWER(pszExt[0]); + szExt[1] = RT_C_TO_LOWER(pszExt[1]); + szExt[2] = RT_C_TO_LOWER(pszExt[2]); + szExt[3] = '\0'; + if ( !memcmp(szExt, "exe", 4) + || !memcmp(szExt, "bat", 4) + || !memcmp(szExt, "com", 4) + || !memcmp(szExt, "cmd", 4) + || !memcmp(szExt, "btm", 4) + ) + fMode |= RTFS_UNIX_IXUSR | RTFS_UNIX_IXGRP | RTFS_UNIX_IXOTH; + } + } + + /* Is it really a symbolic link? */ + if ((fMode & RTFS_DOS_NT_REPARSE_POINT) && uReparseTag == RTFSMODE_SYMLINK_REPARSE_TAG) + fMode = (fMode & ~RTFS_TYPE_MASK) | RTFS_TYPE_SYMLINK; + + /* + * Writable? + * + * Note! We ignore the read-only flag on directories as windows seems to + * use it for purposes other than writability (@ticketref{18345}): + * https://support.microsoft.com/en-gb/help/326549/you-cannot-view-or-change-the-read-only-or-the-system-attributes-of-fo + * + */ + if ((fMode & (RTFS_DOS_DIRECTORY | RTFS_DOS_READONLY)) != RTFS_DOS_READONLY) + fMode |= RTFS_UNIX_IWUSR | RTFS_UNIX_IWGRP | RTFS_UNIX_IWOTH; + return fMode; +} + + +/** + * Converts Unix attributes to Dos-style attributes. + * + * @returns File mode mask. + * @param fMode The mode mask containing dos-style attributes only. + * @param pszName The filename which this applies to (hidden check). + * @param cbName The length of that filename. (optional, set 0) + * @param fType RTFS_TYPE_XXX to normalize against, 0 if not known. + */ +RTFMODE rtFsModeFromUnix(RTFMODE fMode, const char *pszName, size_t cbName, RTFMODE fType) +{ + Assert(!(fType & ~RTFS_TYPE_MASK)); + NOREF(cbName); + + fMode &= RTFS_UNIX_MASK; + + if (!(fType & RTFS_TYPE_MASK) && fType) + fMode |= fType; + + if (!(fMode & (RTFS_UNIX_IWUSR | RTFS_UNIX_IWGRP | RTFS_UNIX_IWOTH))) + fMode |= RTFS_DOS_READONLY; + if (RTFS_IS_DIRECTORY(fMode)) + fMode |= RTFS_DOS_DIRECTORY; + if (!(fMode & RTFS_DOS_MASK)) + fMode |= RTFS_DOS_NT_NORMAL; + if (!(fMode & RTFS_DOS_HIDDEN) && pszName) + { + pszName = RTPathFilename(pszName); + if ( pszName + && pszName[0] == '.' + && pszName[1] != '\0' /* exclude "." */ + && (pszName[1] != '.' || pszName[2] != '\0')) /* exclude ".." */ + fMode |= RTFS_DOS_HIDDEN; + } + return fMode; +} + + +/** + * Normalizes the give mode mask. + * + * It will create the missing unix or dos mask from the other (one + * of them is required by all APIs), and guess the file type if that's + * missing. + * + * @returns Normalized file mode. + * @param fMode The mode mask that may contain a partial/incomplete mask. + * @param pszName The filename which this applies to (exe check). + * @param cbName The length of that filename. (optional, set 0) + * @param fType RTFS_TYPE_XXX to normalize against, 0 if not known. + */ +RTFMODE rtFsModeNormalize(RTFMODE fMode, const char *pszName, size_t cbName, RTFMODE fType) +{ + Assert(!(fType & ~RTFS_TYPE_MASK)); + + if (!(fMode & RTFS_UNIX_MASK)) + fMode = rtFsModeFromDos(fMode, pszName, cbName, RTFSMODE_SYMLINK_REPARSE_TAG, fType); + else if (!(fMode & RTFS_DOS_MASK)) + fMode = rtFsModeFromUnix(fMode, pszName, cbName, fType); + else if (!(fMode & RTFS_TYPE_MASK)) + fMode |= fMode & RTFS_DOS_DIRECTORY ? RTFS_TYPE_DIRECTORY : RTFS_TYPE_FILE; + else if (RTFS_IS_DIRECTORY(fMode)) + fMode |= RTFS_DOS_DIRECTORY; + return fMode; +} + + +/** + * Checks if the file mode is valid or not. + * + * @return true if valid. + * @return false if invalid, done bitching. + * @param fMode The file mode. + */ +bool rtFsModeIsValid(RTFMODE fMode) +{ + AssertMsgReturn( (!RTFS_IS_DIRECTORY(fMode) && !(fMode & RTFS_DOS_DIRECTORY)) + || (RTFS_IS_DIRECTORY(fMode) && (fMode & RTFS_DOS_DIRECTORY)), + ("%RTfmode\n", fMode), false); + AssertMsgReturn(RTFS_TYPE_MASK & fMode, + ("%RTfmode\n", fMode), false); + /** @todo more checks! */ + return true; +} + + +/** + * Checks if the file mode is valid as a permission mask or not. + * + * @return true if valid. + * @return false if invalid, done bitching. + * @param fMode The file mode. + */ +bool rtFsModeIsValidPermissions(RTFMODE fMode) +{ + AssertMsgReturn( (!RTFS_IS_DIRECTORY(fMode) && !(fMode & RTFS_DOS_DIRECTORY)) + || (RTFS_IS_DIRECTORY(fMode) && (fMode & RTFS_DOS_DIRECTORY)), + ("%RTfmode\n", fMode), false); + /** @todo more checks! */ + return true; +} + + +RTDECL(const char *) RTFsTypeName(RTFSTYPE enmType) +{ + switch (enmType) + { + case RTFSTYPE_UNKNOWN: return "unknown"; + case RTFSTYPE_UDF: return "udf"; + case RTFSTYPE_ISO9660: return "iso9660"; + case RTFSTYPE_FUSE: return "fuse"; + case RTFSTYPE_VBOXSHF: return "vboxshf"; + + case RTFSTYPE_EXT: return "ext"; + case RTFSTYPE_EXT2: return "ext2"; + case RTFSTYPE_EXT3: return "ext3"; + case RTFSTYPE_EXT4: return "ext4"; + case RTFSTYPE_XFS: return "xfs"; + case RTFSTYPE_CIFS: return "cifs"; + case RTFSTYPE_SMBFS: return "smbfs"; + case RTFSTYPE_TMPFS: return "tmpfs"; + case RTFSTYPE_SYSFS: return "sysfs"; + case RTFSTYPE_PROC: return "proc"; + case RTFSTYPE_OCFS2: return "ocfs2"; + case RTFSTYPE_BTRFS: return "btrfs"; + + case RTFSTYPE_NTFS: return "ntfs"; + case RTFSTYPE_FAT: return "fat"; + case RTFSTYPE_EXFAT: return "exfat"; + case RTFSTYPE_REFS: return "refs"; + + case RTFSTYPE_ZFS: return "zfs"; + case RTFSTYPE_UFS: return "ufs"; + case RTFSTYPE_NFS: return "nfs"; + + case RTFSTYPE_HFS: return "hfs"; + case RTFSTYPE_APFS: return "apfs"; + case RTFSTYPE_AUTOFS: return "autofs"; + case RTFSTYPE_DEVFS: return "devfs"; + + case RTFSTYPE_HPFS: return "hpfs"; + case RTFSTYPE_JFS: return "jfs"; + + case RTFSTYPE_END: return "end"; + case RTFSTYPE_32BIT_HACK: break; + } + + /* Don't put this in as 'default:', we wish GCC to warn about missing cases. */ + static char s_asz[4][64]; + static uint32_t volatile s_i = 0; + uint32_t i = ASMAtomicIncU32(&s_i) % RT_ELEMENTS(s_asz); + RTStrPrintf(s_asz[i], sizeof(s_asz[i]), "type=%d", enmType); + return s_asz[i]; +} + |