/* * libjingle * Copyright 2004--2006, Google Inc. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "talk/base/unixfilesystem.h" #include #include #include #include #include #ifdef OSX #include #include #include #include "talk/base/macutils.h" #endif // OSX #if defined(POSIX) && !defined(OSX) #include #ifdef ANDROID #include #else #include #endif // ANDROID #include #include #include #endif // POSIX && !OSX #ifdef LINUX #include #include #endif #include "talk/base/fileutils.h" #include "talk/base/pathutils.h" #include "talk/base/stream.h" #include "talk/base/stringutils.h" namespace talk_base { #if !defined(ANDROID) && !defined(IOS) char* UnixFilesystem::app_temp_path_ = NULL; #else char* UnixFilesystem::provided_app_data_folder_ = NULL; char* UnixFilesystem::provided_app_temp_folder_ = NULL; void UnixFilesystem::SetAppDataFolder(const std::string& folder) { delete [] provided_app_data_folder_; provided_app_data_folder_ = CopyString(folder); } void UnixFilesystem::SetAppTempFolder(const std::string& folder) { delete [] provided_app_temp_folder_; provided_app_temp_folder_ = CopyString(folder); } #endif bool UnixFilesystem::CreateFolder(const Pathname &path, mode_t mode) { std::string pathname(path.pathname()); int len = pathname.length(); if ((len == 0) || (pathname[len - 1] != '/')) return false; struct stat st; int res = ::stat(pathname.c_str(), &st); if (res == 0) { // Something exists at this location, check if it is a directory return S_ISDIR(st.st_mode) != 0; } else if (errno != ENOENT) { // Unexpected error return false; } // Directory doesn't exist, look up one directory level do { --len; } while ((len > 0) && (pathname[len - 1] != '/')); if (!CreateFolder(Pathname(pathname.substr(0, len)), mode)) { return false; } LOG(LS_INFO) << "Creating folder: " << pathname; return (0 == ::mkdir(pathname.c_str(), mode)); } bool UnixFilesystem::CreateFolder(const Pathname &path) { return CreateFolder(path, 0755); } FileStream *UnixFilesystem::OpenFile(const Pathname &filename, const std::string &mode) { FileStream *fs = new FileStream(); if (fs && !fs->Open(filename.pathname().c_str(), mode.c_str(), NULL)) { delete fs; fs = NULL; } return fs; } bool UnixFilesystem::CreatePrivateFile(const Pathname &filename) { int fd = open(filename.pathname().c_str(), O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR); if (fd < 0) { LOG_ERR(LS_ERROR) << "open() failed."; return false; } // Don't need to keep the file descriptor. if (close(fd) < 0) { LOG_ERR(LS_ERROR) << "close() failed."; // Continue. } return true; } bool UnixFilesystem::DeleteFile(const Pathname &filename) { LOG(LS_INFO) << "Deleting file:" << filename.pathname(); if (!IsFile(filename)) { ASSERT(IsFile(filename)); return false; } return ::unlink(filename.pathname().c_str()) == 0; } bool UnixFilesystem::DeleteEmptyFolder(const Pathname &folder) { LOG(LS_INFO) << "Deleting folder" << folder.pathname(); if (!IsFolder(folder)) { ASSERT(IsFolder(folder)); return false; } std::string no_slash(folder.pathname(), 0, folder.pathname().length()-1); return ::rmdir(no_slash.c_str()) == 0; } bool UnixFilesystem::GetTemporaryFolder(Pathname &pathname, bool create, const std::string *append) { #ifdef OSX FSRef fr; if (0 != FSFindFolder(kOnAppropriateDisk, kTemporaryFolderType, kCreateFolder, &fr)) return false; unsigned char buffer[NAME_MAX+1]; if (0 != FSRefMakePath(&fr, buffer, ARRAY_SIZE(buffer))) return false; pathname.SetPathname(reinterpret_cast(buffer), ""); #elif defined(ANDROID) || defined(IOS) ASSERT(provided_app_temp_folder_ != NULL); pathname.SetPathname(provided_app_temp_folder_, ""); #else // !OSX && !ANDROID if (const char* tmpdir = getenv("TMPDIR")) { pathname.SetPathname(tmpdir, ""); } else if (const char* tmp = getenv("TMP")) { pathname.SetPathname(tmp, ""); } else { #ifdef P_tmpdir pathname.SetPathname(P_tmpdir, ""); #else // !P_tmpdir pathname.SetPathname("/tmp/", ""); #endif // !P_tmpdir } #endif // !OSX && !ANDROID if (append) { ASSERT(!append->empty()); pathname.AppendFolder(*append); } return !create || CreateFolder(pathname); } std::string UnixFilesystem::TempFilename(const Pathname &dir, const std::string &prefix) { int len = dir.pathname().size() + prefix.size() + 2 + 6; char *tempname = new char[len]; snprintf(tempname, len, "%s/%sXXXXXX", dir.pathname().c_str(), prefix.c_str()); int fd = ::mkstemp(tempname); if (fd != -1) ::close(fd); std::string ret(tempname); delete[] tempname; return ret; } bool UnixFilesystem::MoveFile(const Pathname &old_path, const Pathname &new_path) { if (!IsFile(old_path)) { ASSERT(IsFile(old_path)); return false; } LOG(LS_VERBOSE) << "Moving " << old_path.pathname() << " to " << new_path.pathname(); if (rename(old_path.pathname().c_str(), new_path.pathname().c_str()) != 0) { if (errno != EXDEV) return false; if (!CopyFile(old_path, new_path)) return false; if (!DeleteFile(old_path)) return false; } return true; } bool UnixFilesystem::MoveFolder(const Pathname &old_path, const Pathname &new_path) { if (!IsFolder(old_path)) { ASSERT(IsFolder(old_path)); return false; } LOG(LS_VERBOSE) << "Moving " << old_path.pathname() << " to " << new_path.pathname(); if (rename(old_path.pathname().c_str(), new_path.pathname().c_str()) != 0) { if (errno != EXDEV) return false; if (!CopyFolder(old_path, new_path)) return false; if (!DeleteFolderAndContents(old_path)) return false; } return true; } bool UnixFilesystem::IsFolder(const Pathname &path) { struct stat st; if (stat(path.pathname().c_str(), &st) < 0) return false; return S_ISDIR(st.st_mode); } bool UnixFilesystem::CopyFile(const Pathname &old_path, const Pathname &new_path) { LOG(LS_VERBOSE) << "Copying " << old_path.pathname() << " to " << new_path.pathname(); char buf[256]; size_t len; StreamInterface *source = OpenFile(old_path, "rb"); if (!source) return false; StreamInterface *dest = OpenFile(new_path, "wb"); if (!dest) { delete source; return false; } while (source->Read(buf, sizeof(buf), &len, NULL) == SR_SUCCESS) dest->Write(buf, len, NULL, NULL); delete source; delete dest; return true; } bool UnixFilesystem::IsTemporaryPath(const Pathname& pathname) { #if defined(ANDROID) || defined(IOS) ASSERT(provided_app_temp_folder_ != NULL); #endif const char* const kTempPrefixes[] = { #if defined(ANDROID) || defined(IOS) provided_app_temp_folder_, #else "/tmp/", "/var/tmp/", #ifdef OSX "/private/tmp/", "/private/var/tmp/", "/private/var/folders/", #endif // OSX #endif // ANDROID || IOS }; for (size_t i = 0; i < ARRAY_SIZE(kTempPrefixes); ++i) { if (0 == strncmp(pathname.pathname().c_str(), kTempPrefixes[i], strlen(kTempPrefixes[i]))) return true; } return false; } bool UnixFilesystem::IsFile(const Pathname& pathname) { struct stat st; int res = ::stat(pathname.pathname().c_str(), &st); // Treat symlinks, named pipes, etc. all as files. return res == 0 && !S_ISDIR(st.st_mode); } bool UnixFilesystem::IsAbsent(const Pathname& pathname) { struct stat st; int res = ::stat(pathname.pathname().c_str(), &st); // Note: we specifically maintain ENOTDIR as an error, because that implies // that you could not call CreateFolder(pathname). return res != 0 && ENOENT == errno; } bool UnixFilesystem::GetFileSize(const Pathname& pathname, size_t *size) { struct stat st; if (::stat(pathname.pathname().c_str(), &st) != 0) return false; *size = st.st_size; return true; } bool UnixFilesystem::GetFileTime(const Pathname& path, FileTimeType which, time_t* time) { struct stat st; if (::stat(path.pathname().c_str(), &st) != 0) return false; switch (which) { case FTT_CREATED: *time = st.st_ctime; break; case FTT_MODIFIED: *time = st.st_mtime; break; case FTT_ACCESSED: *time = st.st_atime; break; default: return false; } return true; } bool UnixFilesystem::GetAppPathname(Pathname* path) { #ifdef OSX ProcessSerialNumber psn = { 0, kCurrentProcess }; CFDictionaryRef procinfo = ProcessInformationCopyDictionary(&psn, kProcessDictionaryIncludeAllInformationMask); if (NULL == procinfo) return false; CFStringRef cfpath = (CFStringRef) CFDictionaryGetValue(procinfo, kIOBundleExecutableKey); std::string path8; bool success = ToUtf8(cfpath, &path8); CFRelease(procinfo); if (success) path->SetPathname(path8); return success; #else // OSX char buffer[NAME_MAX+1]; size_t len = readlink("/proc/self/exe", buffer, ARRAY_SIZE(buffer) - 1); if (len <= 0) return false; buffer[len] = '\0'; path->SetPathname(buffer); return true; #endif // OSX } bool UnixFilesystem::GetAppDataFolder(Pathname* path, bool per_user) { ASSERT(!organization_name_.empty()); ASSERT(!application_name_.empty()); // First get the base directory for app data. #ifdef OSX if (per_user) { // Use ~/Library/Application Support/// FSRef fr; if (0 != FSFindFolder(kUserDomain, kApplicationSupportFolderType, kCreateFolder, &fr)) return false; unsigned char buffer[NAME_MAX+1]; if (0 != FSRefMakePath(&fr, buffer, ARRAY_SIZE(buffer))) return false; path->SetPathname(reinterpret_cast(buffer), ""); } else { // TODO return false; } #elif defined(ANDROID) || defined(IOS) // && !OSX ASSERT(provided_app_data_folder_ != NULL); path->SetPathname(provided_app_data_folder_, ""); #elif defined(LINUX) // && !OSX && !defined(ANDROID) && !defined(IOS) if (per_user) { // We follow the recommendations in // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html // It specifies separate directories for data and config files, but // GetAppDataFolder() does not distinguish. We just return the config dir // path. const char* xdg_config_home = getenv("XDG_CONFIG_HOME"); if (xdg_config_home) { path->SetPathname(xdg_config_home, ""); } else { // XDG says to default to $HOME/.config. We also support falling back to // other synonyms for HOME if for some reason it is not defined. const char* homedir; if (const char* home = getenv("HOME")) { homedir = home; } else if (const char* dotdir = getenv("DOTDIR")) { homedir = dotdir; } else if (passwd* pw = getpwuid(geteuid())) { homedir = pw->pw_dir; } else { return false; } path->SetPathname(homedir, ""); path->AppendFolder(".config"); } } else { // XDG does not define a standard directory for writable global data. Let's // just use this. path->SetPathname("/var/cache/", ""); } #endif // !OSX && !defined(ANDROID) && !defined(LINUX) // Now add on a sub-path for our app. #if defined(OSX) || defined(ANDROID) || defined(IOS) path->AppendFolder(organization_name_); path->AppendFolder(application_name_); #elif defined(LINUX) // XDG says to use a single directory level, so we concatenate the org and app // name with a hyphen. We also do the Linuxy thing and convert to all // lowercase with no spaces. std::string subdir(organization_name_); subdir.append("-"); subdir.append(application_name_); replace_substrs(" ", 1, "", 0, &subdir); std::transform(subdir.begin(), subdir.end(), subdir.begin(), ::tolower); path->AppendFolder(subdir); #endif if (!CreateFolder(*path, 0700)) { return false; } // If the folder already exists, it may have the wrong mode or be owned by // someone else, both of which are security problems. Setting the mode // avoids both issues since it will fail if the path is not owned by us. if (0 != ::chmod(path->pathname().c_str(), 0700)) { LOG_ERR(LS_ERROR) << "Can't set mode on " << path; return false; } return true; } bool UnixFilesystem::GetAppTempFolder(Pathname* path) { #if defined(ANDROID) || defined(IOS) ASSERT(provided_app_temp_folder_ != NULL); path->SetPathname(provided_app_temp_folder_); return true; #else ASSERT(!application_name_.empty()); // TODO: Consider whether we are worried about thread safety. if (app_temp_path_ != NULL && strlen(app_temp_path_) > 0) { path->SetPathname(app_temp_path_); return true; } // Create a random directory as /tmp/-- char buffer[128]; sprintfn(buffer, ARRAY_SIZE(buffer), "-%d-%d", static_cast(getpid()), static_cast(time(0))); std::string folder(application_name_); folder.append(buffer); if (!GetTemporaryFolder(*path, true, &folder)) return false; delete [] app_temp_path_; app_temp_path_ = CopyString(path->pathname()); // TODO: atexit(DeleteFolderAndContents(app_temp_path_)); return true; #endif } bool UnixFilesystem::GetDiskFreeSpace(const Pathname& path, int64 *freebytes) { ASSERT(NULL != freebytes); // TODO: Consider making relative paths absolute using cwd. // TODO: When popping off a symlink, push back on the components of the // symlink, so we don't jump out of the target disk inadvertently. Pathname existing_path(path.folder(), ""); while (!existing_path.folder().empty() && IsAbsent(existing_path)) { existing_path.SetFolder(existing_path.parent_folder()); } #ifdef ANDROID struct statfs vfs; memset(&vfs, 0, sizeof(vfs)); if (0 != statfs(existing_path.pathname().c_str(), &vfs)) return false; #else struct statvfs vfs; memset(&vfs, 0, sizeof(vfs)); if (0 != statvfs(existing_path.pathname().c_str(), &vfs)) return false; #endif // ANDROID #if defined(LINUX) || defined(ANDROID) *freebytes = static_cast(vfs.f_bsize) * vfs.f_bavail; #elif defined(OSX) *freebytes = static_cast(vfs.f_frsize) * vfs.f_bavail; #endif return true; } Pathname UnixFilesystem::GetCurrentDirectory() { Pathname cwd; char buffer[PATH_MAX]; char *path = getcwd(buffer, PATH_MAX); if (!path) { LOG_ERR(LS_ERROR) << "getcwd() failed"; return cwd; // returns empty pathname } cwd.SetFolder(std::string(path)); return cwd; } char* UnixFilesystem::CopyString(const std::string& str) { size_t size = str.length() + 1; char* buf = new char[size]; if (!buf) { return NULL; } strcpyn(buf, size, str.c_str()); return buf; } } // namespace talk_base