michael@0: // Copyright (c) 2012 The Chromium Authors. All rights reserved. michael@0: // Use of this source code is governed by a BSD-style license that can be michael@0: // found in the LICENSE file. michael@0: michael@0: // This file contains utility functions for dealing with the local michael@0: // filesystem. michael@0: michael@0: #ifndef BASE_FILE_UTIL_H_ michael@0: #define BASE_FILE_UTIL_H_ michael@0: michael@0: #include "build/build_config.h" michael@0: michael@0: #if defined(OS_WIN) michael@0: #include michael@0: #elif defined(OS_POSIX) michael@0: #include michael@0: #include michael@0: #endif michael@0: michael@0: #include michael@0: michael@0: #include michael@0: #include michael@0: #include michael@0: michael@0: #include "base/base_export.h" michael@0: #include "base/basictypes.h" michael@0: #include "base/files/file_path.h" michael@0: #include "base/memory/scoped_ptr.h" michael@0: #include "base/platform_file.h" michael@0: #include "base/strings/string16.h" michael@0: michael@0: #if defined(OS_POSIX) michael@0: #include "base/file_descriptor_posix.h" michael@0: #include "base/logging.h" michael@0: #include "base/posix/eintr_wrapper.h" michael@0: #endif michael@0: michael@0: namespace base { michael@0: michael@0: class Time; michael@0: michael@0: extern bool g_bug108724_debug; michael@0: michael@0: //----------------------------------------------------------------------------- michael@0: // Functions that involve filesystem access or modification: michael@0: michael@0: // Returns an absolute version of a relative path. Returns an empty path on michael@0: // error. On POSIX, this function fails if the path does not exist. This michael@0: // function can result in I/O so it can be slow. michael@0: BASE_EXPORT FilePath MakeAbsoluteFilePath(const FilePath& input); michael@0: michael@0: // Returns the total number of bytes used by all the files under |root_path|. michael@0: // If the path does not exist the function returns 0. michael@0: // michael@0: // This function is implemented using the FileEnumerator class so it is not michael@0: // particularly speedy in any platform. michael@0: BASE_EXPORT int64 ComputeDirectorySize(const FilePath& root_path); michael@0: michael@0: // Deletes the given path, whether it's a file or a directory. michael@0: // If it's a directory, it's perfectly happy to delete all of the michael@0: // directory's contents. Passing true to recursive deletes michael@0: // subdirectories and their contents as well. michael@0: // Returns true if successful, false otherwise. It is considered successful michael@0: // to attempt to delete a file that does not exist. michael@0: // michael@0: // In posix environment and if |path| is a symbolic link, this deletes only michael@0: // the symlink. (even if the symlink points to a non-existent file) michael@0: // michael@0: // WARNING: USING THIS WITH recursive==true IS EQUIVALENT michael@0: // TO "rm -rf", SO USE WITH CAUTION. michael@0: BASE_EXPORT bool DeleteFile(const FilePath& path, bool recursive); michael@0: michael@0: #if defined(OS_WIN) michael@0: // Schedules to delete the given path, whether it's a file or a directory, until michael@0: // the operating system is restarted. michael@0: // Note: michael@0: // 1) The file/directory to be deleted should exist in a temp folder. michael@0: // 2) The directory to be deleted must be empty. michael@0: BASE_EXPORT bool DeleteFileAfterReboot(const FilePath& path); michael@0: #endif michael@0: michael@0: // Moves the given path, whether it's a file or a directory. michael@0: // If a simple rename is not possible, such as in the case where the paths are michael@0: // on different volumes, this will attempt to copy and delete. Returns michael@0: // true for success. michael@0: // This function fails if either path contains traversal components ('..'). michael@0: BASE_EXPORT bool Move(const FilePath& from_path, const FilePath& to_path); michael@0: michael@0: // Renames file |from_path| to |to_path|. Both paths must be on the same michael@0: // volume, or the function will fail. Destination file will be created michael@0: // if it doesn't exist. Prefer this function over Move when dealing with michael@0: // temporary files. On Windows it preserves attributes of the target file. michael@0: // Returns true on success, leaving *error unchanged. michael@0: // Returns false on failure and sets *error appropriately, if it is non-NULL. michael@0: BASE_EXPORT bool ReplaceFile(const FilePath& from_path, michael@0: const FilePath& to_path, michael@0: PlatformFileError* error); michael@0: michael@0: // Copies a single file. Use CopyDirectory to copy directories. michael@0: // This function fails if either path contains traversal components ('..'). michael@0: BASE_EXPORT bool CopyFile(const FilePath& from_path, const FilePath& to_path); michael@0: michael@0: // Copies the given path, and optionally all subdirectories and their contents michael@0: // as well. michael@0: // michael@0: // If there are files existing under to_path, always overwrite. Returns true michael@0: // if successful, false otherwise. Wildcards on the names are not supported. michael@0: // michael@0: // If you only need to copy a file use CopyFile, it's faster. michael@0: BASE_EXPORT bool CopyDirectory(const FilePath& from_path, michael@0: const FilePath& to_path, michael@0: bool recursive); michael@0: michael@0: // Returns true if the given path exists on the local filesystem, michael@0: // false otherwise. michael@0: BASE_EXPORT bool PathExists(const FilePath& path); michael@0: michael@0: // Returns true if the given path is writable by the user, false otherwise. michael@0: BASE_EXPORT bool PathIsWritable(const FilePath& path); michael@0: michael@0: // Returns true if the given path exists and is a directory, false otherwise. michael@0: BASE_EXPORT bool DirectoryExists(const FilePath& path); michael@0: michael@0: // Returns true if the contents of the two files given are equal, false michael@0: // otherwise. If either file can't be read, returns false. michael@0: BASE_EXPORT bool ContentsEqual(const FilePath& filename1, michael@0: const FilePath& filename2); michael@0: michael@0: // Returns true if the contents of the two text files given are equal, false michael@0: // otherwise. This routine treats "\r\n" and "\n" as equivalent. michael@0: BASE_EXPORT bool TextContentsEqual(const FilePath& filename1, michael@0: const FilePath& filename2); michael@0: michael@0: // Read the file at |path| into |contents|, returning true on success. michael@0: // This function fails if the |path| contains path traversal components ('..'). michael@0: // |contents| may be NULL, in which case this function is useful for its michael@0: // side effect of priming the disk cache. michael@0: // Useful for unit tests. michael@0: BASE_EXPORT bool ReadFileToString(const FilePath& path, std::string* contents); michael@0: michael@0: } // namespace base michael@0: michael@0: // ----------------------------------------------------------------------------- michael@0: michael@0: namespace file_util { michael@0: michael@0: #if defined(OS_POSIX) michael@0: // Read exactly |bytes| bytes from file descriptor |fd|, storing the result michael@0: // in |buffer|. This function is protected against EINTR and partial reads. michael@0: // Returns true iff |bytes| bytes have been successfully read from |fd|. michael@0: BASE_EXPORT bool ReadFromFD(int fd, char* buffer, size_t bytes); michael@0: michael@0: // Creates a symbolic link at |symlink| pointing to |target|. Returns michael@0: // false on failure. michael@0: BASE_EXPORT bool CreateSymbolicLink(const base::FilePath& target, michael@0: const base::FilePath& symlink); michael@0: michael@0: // Reads the given |symlink| and returns where it points to in |target|. michael@0: // Returns false upon failure. michael@0: BASE_EXPORT bool ReadSymbolicLink(const base::FilePath& symlink, michael@0: base::FilePath* target); michael@0: michael@0: // Bits ans masks of the file permission. michael@0: enum FilePermissionBits { michael@0: FILE_PERMISSION_MASK = S_IRWXU | S_IRWXG | S_IRWXO, michael@0: FILE_PERMISSION_USER_MASK = S_IRWXU, michael@0: FILE_PERMISSION_GROUP_MASK = S_IRWXG, michael@0: FILE_PERMISSION_OTHERS_MASK = S_IRWXO, michael@0: michael@0: FILE_PERMISSION_READ_BY_USER = S_IRUSR, michael@0: FILE_PERMISSION_WRITE_BY_USER = S_IWUSR, michael@0: FILE_PERMISSION_EXECUTE_BY_USER = S_IXUSR, michael@0: FILE_PERMISSION_READ_BY_GROUP = S_IRGRP, michael@0: FILE_PERMISSION_WRITE_BY_GROUP = S_IWGRP, michael@0: FILE_PERMISSION_EXECUTE_BY_GROUP = S_IXGRP, michael@0: FILE_PERMISSION_READ_BY_OTHERS = S_IROTH, michael@0: FILE_PERMISSION_WRITE_BY_OTHERS = S_IWOTH, michael@0: FILE_PERMISSION_EXECUTE_BY_OTHERS = S_IXOTH, michael@0: }; michael@0: michael@0: // Reads the permission of the given |path|, storing the file permission michael@0: // bits in |mode|. If |path| is symbolic link, |mode| is the permission of michael@0: // a file which the symlink points to. michael@0: BASE_EXPORT bool GetPosixFilePermissions(const base::FilePath& path, michael@0: int* mode); michael@0: // Sets the permission of the given |path|. If |path| is symbolic link, sets michael@0: // the permission of a file which the symlink points to. michael@0: BASE_EXPORT bool SetPosixFilePermissions(const base::FilePath& path, michael@0: int mode); michael@0: #endif // defined(OS_POSIX) michael@0: michael@0: // Return true if the given directory is empty michael@0: BASE_EXPORT bool IsDirectoryEmpty(const base::FilePath& dir_path); michael@0: michael@0: // Get the temporary directory provided by the system. michael@0: // WARNING: DON'T USE THIS. If you want to create a temporary file, use one of michael@0: // the functions below. michael@0: BASE_EXPORT bool GetTempDir(base::FilePath* path); michael@0: // Get a temporary directory for shared memory files. michael@0: // Only useful on POSIX; redirects to GetTempDir() on Windows. michael@0: BASE_EXPORT bool GetShmemTempDir(base::FilePath* path, bool executable); michael@0: michael@0: // Get the home directory. This is more complicated than just getenv("HOME") michael@0: // as it knows to fall back on getpwent() etc. michael@0: BASE_EXPORT base::FilePath GetHomeDir(); michael@0: michael@0: // Creates a temporary file. The full path is placed in |path|, and the michael@0: // function returns true if was successful in creating the file. The file will michael@0: // be empty and all handles closed after this function returns. michael@0: BASE_EXPORT bool CreateTemporaryFile(base::FilePath* path); michael@0: michael@0: // Same as CreateTemporaryFile but the file is created in |dir|. michael@0: BASE_EXPORT bool CreateTemporaryFileInDir(const base::FilePath& dir, michael@0: base::FilePath* temp_file); michael@0: michael@0: // Create and open a temporary file. File is opened for read/write. michael@0: // The full path is placed in |path|. michael@0: // Returns a handle to the opened file or NULL if an error occurred. michael@0: BASE_EXPORT FILE* CreateAndOpenTemporaryFile(base::FilePath* path); michael@0: // Like above but for shmem files. Only useful for POSIX. michael@0: // The executable flag says the file needs to support using michael@0: // mprotect with PROT_EXEC after mapping. michael@0: BASE_EXPORT FILE* CreateAndOpenTemporaryShmemFile(base::FilePath* path, michael@0: bool executable); michael@0: // Similar to CreateAndOpenTemporaryFile, but the file is created in |dir|. michael@0: BASE_EXPORT FILE* CreateAndOpenTemporaryFileInDir(const base::FilePath& dir, michael@0: base::FilePath* path); michael@0: michael@0: // Create a new directory. If prefix is provided, the new directory name is in michael@0: // the format of prefixyyyy. michael@0: // NOTE: prefix is ignored in the POSIX implementation. michael@0: // If success, return true and output the full path of the directory created. michael@0: BASE_EXPORT bool CreateNewTempDirectory( michael@0: const base::FilePath::StringType& prefix, michael@0: base::FilePath* new_temp_path); michael@0: michael@0: // Create a directory within another directory. michael@0: // Extra characters will be appended to |prefix| to ensure that the michael@0: // new directory does not have the same name as an existing directory. michael@0: BASE_EXPORT bool CreateTemporaryDirInDir( michael@0: const base::FilePath& base_dir, michael@0: const base::FilePath::StringType& prefix, michael@0: base::FilePath* new_dir); michael@0: michael@0: // Creates a directory, as well as creating any parent directories, if they michael@0: // don't exist. Returns 'true' on successful creation, or if the directory michael@0: // already exists. The directory is only readable by the current user. michael@0: // Returns true on success, leaving *error unchanged. michael@0: // Returns false on failure and sets *error appropriately, if it is non-NULL. michael@0: BASE_EXPORT bool CreateDirectoryAndGetError(const base::FilePath& full_path, michael@0: base::PlatformFileError* error); michael@0: michael@0: // Backward-compatible convenience method for the above. michael@0: BASE_EXPORT bool CreateDirectory(const base::FilePath& full_path); michael@0: michael@0: // Returns the file size. Returns true on success. michael@0: BASE_EXPORT bool GetFileSize(const base::FilePath& file_path, int64* file_size); michael@0: michael@0: // Sets |real_path| to |path| with symbolic links and junctions expanded. michael@0: // On windows, make sure the path starts with a lettered drive. michael@0: // |path| must reference a file. Function will fail if |path| points to michael@0: // a directory or to a nonexistent path. On windows, this function will michael@0: // fail if |path| is a junction or symlink that points to an empty file, michael@0: // or if |real_path| would be longer than MAX_PATH characters. michael@0: BASE_EXPORT bool NormalizeFilePath(const base::FilePath& path, michael@0: base::FilePath* real_path); michael@0: michael@0: #if defined(OS_WIN) michael@0: michael@0: // Given a path in NT native form ("\Device\HarddiskVolumeXX\..."), michael@0: // return in |drive_letter_path| the equivalent path that starts with michael@0: // a drive letter ("C:\..."). Return false if no such path exists. michael@0: BASE_EXPORT bool DevicePathToDriveLetterPath(const base::FilePath& device_path, michael@0: base::FilePath* drive_letter_path); michael@0: michael@0: // Given an existing file in |path|, set |real_path| to the path michael@0: // in native NT format, of the form "\Device\HarddiskVolumeXX\..". michael@0: // Returns false if the path can not be found. Empty files cannot michael@0: // be resolved with this function. michael@0: BASE_EXPORT bool NormalizeToNativeFilePath(const base::FilePath& path, michael@0: base::FilePath* nt_path); michael@0: #endif michael@0: michael@0: // This function will return if the given file is a symlink or not. michael@0: BASE_EXPORT bool IsLink(const base::FilePath& file_path); michael@0: michael@0: // Returns information about the given file path. michael@0: BASE_EXPORT bool GetFileInfo(const base::FilePath& file_path, michael@0: base::PlatformFileInfo* info); michael@0: michael@0: // Sets the time of the last access and the time of the last modification. michael@0: BASE_EXPORT bool TouchFile(const base::FilePath& path, michael@0: const base::Time& last_accessed, michael@0: const base::Time& last_modified); michael@0: michael@0: // Set the time of the last modification. Useful for unit tests. michael@0: BASE_EXPORT bool SetLastModifiedTime(const base::FilePath& path, michael@0: const base::Time& last_modified); michael@0: michael@0: #if defined(OS_POSIX) michael@0: // Store inode number of |path| in |inode|. Return true on success. michael@0: BASE_EXPORT bool GetInode(const base::FilePath& path, ino_t* inode); michael@0: #endif michael@0: michael@0: // Wrapper for fopen-like calls. Returns non-NULL FILE* on success. michael@0: BASE_EXPORT FILE* OpenFile(const base::FilePath& filename, const char* mode); michael@0: michael@0: // Closes file opened by OpenFile. Returns true on success. michael@0: BASE_EXPORT bool CloseFile(FILE* file); michael@0: michael@0: // Truncates an open file to end at the location of the current file pointer. michael@0: // This is a cross-platform analog to Windows' SetEndOfFile() function. michael@0: BASE_EXPORT bool TruncateFile(FILE* file); michael@0: michael@0: // Reads the given number of bytes from the file into the buffer. Returns michael@0: // the number of read bytes, or -1 on error. michael@0: BASE_EXPORT int ReadFile(const base::FilePath& filename, char* data, int size); michael@0: michael@0: // Writes the given buffer into the file, overwriting any data that was michael@0: // previously there. Returns the number of bytes written, or -1 on error. michael@0: BASE_EXPORT int WriteFile(const base::FilePath& filename, const char* data, michael@0: int size); michael@0: #if defined(OS_POSIX) michael@0: // Append the data to |fd|. Does not close |fd| when done. michael@0: BASE_EXPORT int WriteFileDescriptor(const int fd, const char* data, int size); michael@0: #endif michael@0: // Append the given buffer into the file. Returns the number of bytes written, michael@0: // or -1 on error. michael@0: BASE_EXPORT int AppendToFile(const base::FilePath& filename, michael@0: const char* data, int size); michael@0: michael@0: // Gets the current working directory for the process. michael@0: BASE_EXPORT bool GetCurrentDirectory(base::FilePath* path); michael@0: michael@0: // Sets the current working directory for the process. michael@0: BASE_EXPORT bool SetCurrentDirectory(const base::FilePath& path); michael@0: michael@0: // Attempts to find a number that can be appended to the |path| to make it michael@0: // unique. If |path| does not exist, 0 is returned. If it fails to find such michael@0: // a number, -1 is returned. If |suffix| is not empty, also checks the michael@0: // existence of it with the given suffix. michael@0: BASE_EXPORT int GetUniquePathNumber(const base::FilePath& path, michael@0: const base::FilePath::StringType& suffix); michael@0: michael@0: #if defined(OS_POSIX) michael@0: // Creates a directory with a guaranteed unique name based on |path|, returning michael@0: // the pathname if successful, or an empty path if there was an error creating michael@0: // the directory. Does not create parent directories. michael@0: BASE_EXPORT base::FilePath MakeUniqueDirectory(const base::FilePath& path); michael@0: #endif michael@0: michael@0: #if defined(OS_POSIX) michael@0: // Test that |path| can only be changed by a given user and members of michael@0: // a given set of groups. michael@0: // Specifically, test that all parts of |path| under (and including) |base|: michael@0: // * Exist. michael@0: // * Are owned by a specific user. michael@0: // * Are not writable by all users. michael@0: // * Are owned by a member of a given set of groups, or are not writable by michael@0: // their group. michael@0: // * Are not symbolic links. michael@0: // This is useful for checking that a config file is administrator-controlled. michael@0: // |base| must contain |path|. michael@0: BASE_EXPORT bool VerifyPathControlledByUser(const base::FilePath& base, michael@0: const base::FilePath& path, michael@0: uid_t owner_uid, michael@0: const std::set& group_gids); michael@0: #endif // defined(OS_POSIX) michael@0: michael@0: #if defined(OS_MACOSX) && !defined(OS_IOS) michael@0: // Is |path| writable only by a user with administrator privileges? michael@0: // This function uses Mac OS conventions. The super user is assumed to have michael@0: // uid 0, and the administrator group is assumed to be named "admin". michael@0: // Testing that |path|, and every parent directory including the root of michael@0: // the filesystem, are owned by the superuser, controlled by the group michael@0: // "admin", are not writable by all users, and contain no symbolic links. michael@0: // Will return false if |path| does not exist. michael@0: BASE_EXPORT bool VerifyPathControlledByAdmin(const base::FilePath& path); michael@0: #endif // defined(OS_MACOSX) && !defined(OS_IOS) michael@0: michael@0: // Returns the maximum length of path component on the volume containing michael@0: // the directory |path|, in the number of FilePath::CharType, or -1 on failure. michael@0: BASE_EXPORT int GetMaximumPathComponentLength(const base::FilePath& path); michael@0: michael@0: // A class to handle auto-closing of FILE*'s. michael@0: class ScopedFILEClose { michael@0: public: michael@0: inline void operator()(FILE* x) const { michael@0: if (x) { michael@0: fclose(x); michael@0: } michael@0: } michael@0: }; michael@0: michael@0: typedef scoped_ptr_malloc ScopedFILE; michael@0: michael@0: #if defined(OS_POSIX) michael@0: // A class to handle auto-closing of FDs. michael@0: class ScopedFDClose { michael@0: public: michael@0: inline void operator()(int* x) const { michael@0: if (x && *x >= 0) { michael@0: if (HANDLE_EINTR(close(*x)) < 0) michael@0: DPLOG(ERROR) << "close"; michael@0: } michael@0: } michael@0: }; michael@0: michael@0: typedef scoped_ptr_malloc ScopedFD; michael@0: #endif // OS_POSIX michael@0: michael@0: #if defined(OS_LINUX) michael@0: // Broad categories of file systems as returned by statfs() on Linux. michael@0: enum FileSystemType { michael@0: FILE_SYSTEM_UNKNOWN, // statfs failed. michael@0: FILE_SYSTEM_0, // statfs.f_type == 0 means unknown, may indicate AFS. michael@0: FILE_SYSTEM_ORDINARY, // on-disk filesystem like ext2 michael@0: FILE_SYSTEM_NFS, michael@0: FILE_SYSTEM_SMB, michael@0: FILE_SYSTEM_CODA, michael@0: FILE_SYSTEM_MEMORY, // in-memory file system michael@0: FILE_SYSTEM_CGROUP, // cgroup control. michael@0: FILE_SYSTEM_OTHER, // any other value. michael@0: FILE_SYSTEM_TYPE_COUNT michael@0: }; michael@0: michael@0: // Attempts determine the FileSystemType for |path|. michael@0: // Returns false if |path| doesn't exist. michael@0: BASE_EXPORT bool GetFileSystemType(const base::FilePath& path, michael@0: FileSystemType* type); michael@0: #endif michael@0: michael@0: } // namespace file_util michael@0: michael@0: // Internal -------------------------------------------------------------------- michael@0: michael@0: namespace base { michael@0: namespace internal { michael@0: michael@0: // Same as Move but allows paths with traversal components. michael@0: // Use only with extreme care. michael@0: BASE_EXPORT bool MoveUnsafe(const FilePath& from_path, michael@0: const FilePath& to_path); michael@0: michael@0: // Same as CopyFile but allows paths with traversal components. michael@0: // Use only with extreme care. michael@0: BASE_EXPORT bool CopyFileUnsafe(const FilePath& from_path, michael@0: const FilePath& to_path); michael@0: michael@0: #if defined(OS_WIN) michael@0: // Copy from_path to to_path recursively and then delete from_path recursively. michael@0: // Returns true if all operations succeed. michael@0: // This function simulates Move(), but unlike Move() it works across volumes. michael@0: // This function is not transactional. michael@0: BASE_EXPORT bool CopyAndDeleteDirectory(const FilePath& from_path, michael@0: const FilePath& to_path); michael@0: #endif // defined(OS_WIN) michael@0: michael@0: } // namespace internal michael@0: } // namespace base michael@0: michael@0: #endif // BASE_FILE_UTIL_H_