mirror of https://github.com/nextcloud/desktop
529 lines
16 KiB
C++
529 lines
16 KiB
C++
/*
|
|
* Copyright (C) by Daniel Molkentin <danimo@owncloud.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#include "filesystembase.h"
|
|
#include "utility.h"
|
|
#include "common/asserts.h"
|
|
|
|
#include <QDateTime>
|
|
#include <QDir>
|
|
#include <QUrl>
|
|
#include <QFile>
|
|
#include <QCoreApplication>
|
|
|
|
#include <sys/stat.h>
|
|
#include <sys/types.h>
|
|
|
|
#ifdef Q_OS_WIN
|
|
#include <windows.h>
|
|
#include <windef.h>
|
|
#include <winbase.h>
|
|
#include <fcntl.h>
|
|
#include <io.h>
|
|
#endif
|
|
|
|
namespace OCC {
|
|
|
|
Q_LOGGING_CATEGORY(lcFileSystem, "nextcloud.sync.filesystem", QtInfoMsg)
|
|
|
|
QString FileSystem::longWinPath(const QString &inpath)
|
|
{
|
|
#ifdef Q_OS_WIN
|
|
return pathtoUNC(inpath);
|
|
#else
|
|
return inpath;
|
|
#endif
|
|
}
|
|
|
|
void FileSystem::setFileHidden(const QString &filename, bool hidden)
|
|
{
|
|
#ifdef _WIN32
|
|
QString fName = longWinPath(filename);
|
|
DWORD dwAttrs = 0;
|
|
|
|
dwAttrs = GetFileAttributesW((wchar_t *)fName.utf16());
|
|
|
|
if (dwAttrs != INVALID_FILE_ATTRIBUTES) {
|
|
if (hidden && !(dwAttrs & FILE_ATTRIBUTE_HIDDEN)) {
|
|
SetFileAttributesW((wchar_t *)fName.utf16(), dwAttrs | FILE_ATTRIBUTE_HIDDEN);
|
|
} else if (!hidden && (dwAttrs & FILE_ATTRIBUTE_HIDDEN)) {
|
|
SetFileAttributesW((wchar_t *)fName.utf16(), dwAttrs & ~FILE_ATTRIBUTE_HIDDEN);
|
|
}
|
|
}
|
|
#else
|
|
Q_UNUSED(filename);
|
|
Q_UNUSED(hidden);
|
|
#endif
|
|
}
|
|
|
|
static QFile::Permissions getDefaultWritePermissions()
|
|
{
|
|
QFile::Permissions result = QFile::WriteUser;
|
|
#ifndef Q_OS_WIN
|
|
mode_t mask = umask(0);
|
|
umask(mask);
|
|
if (!(mask & S_IWGRP)) {
|
|
result |= QFile::WriteGroup;
|
|
}
|
|
if (!(mask & S_IWOTH)) {
|
|
result |= QFile::WriteOther;
|
|
}
|
|
#endif
|
|
return result;
|
|
}
|
|
|
|
void FileSystem::setFileReadOnly(const QString &filename, bool readonly)
|
|
{
|
|
QFile file(filename);
|
|
QFile::Permissions permissions = file.permissions();
|
|
|
|
QFile::Permissions allWritePermissions =
|
|
QFile::WriteUser | QFile::WriteGroup | QFile::WriteOther | QFile::WriteOwner;
|
|
static QFile::Permissions defaultWritePermissions = getDefaultWritePermissions();
|
|
|
|
permissions &= ~allWritePermissions;
|
|
if (!readonly) {
|
|
permissions |= defaultWritePermissions;
|
|
}
|
|
file.setPermissions(permissions);
|
|
}
|
|
|
|
void FileSystem::setFolderMinimumPermissions(const QString &filename)
|
|
{
|
|
#ifdef Q_OS_MAC
|
|
QFile::Permissions perm = QFile::ReadOwner | QFile::WriteOwner | QFile::ExeOwner;
|
|
QFile file(filename);
|
|
file.setPermissions(perm);
|
|
#else
|
|
Q_UNUSED(filename);
|
|
#endif
|
|
}
|
|
|
|
|
|
void FileSystem::setFileReadOnlyWeak(const QString &filename, bool readonly)
|
|
{
|
|
QFile file(filename);
|
|
QFile::Permissions permissions = file.permissions();
|
|
|
|
if (!readonly && (permissions & QFile::WriteOwner)) {
|
|
return; // already writable enough
|
|
}
|
|
|
|
setFileReadOnly(filename, readonly);
|
|
}
|
|
|
|
bool FileSystem::rename(const QString &originFileName,
|
|
const QString &destinationFileName,
|
|
QString *errorString)
|
|
{
|
|
bool success = false;
|
|
QString error;
|
|
#ifdef Q_OS_WIN
|
|
QString orig = longWinPath(originFileName);
|
|
QString dest = longWinPath(destinationFileName);
|
|
|
|
if (isLnkFile(originFileName) || isLnkFile(destinationFileName)) {
|
|
success = MoveFileEx((wchar_t *)orig.utf16(),
|
|
(wchar_t *)dest.utf16(),
|
|
MOVEFILE_COPY_ALLOWED | MOVEFILE_WRITE_THROUGH);
|
|
if (!success) {
|
|
error = Utility::formatWinError(GetLastError());
|
|
}
|
|
} else
|
|
#endif
|
|
{
|
|
QFile orig(originFileName);
|
|
success = orig.rename(destinationFileName);
|
|
if (!success) {
|
|
error = orig.errorString();
|
|
}
|
|
}
|
|
|
|
if (!success) {
|
|
qCWarning(lcFileSystem) << "Error renaming file" << originFileName
|
|
<< "to" << destinationFileName
|
|
<< "failed: " << error;
|
|
if (errorString) {
|
|
*errorString = error;
|
|
}
|
|
}
|
|
return success;
|
|
}
|
|
|
|
bool FileSystem::uncheckedRenameReplace(const QString &originFileName,
|
|
const QString &destinationFileName,
|
|
QString *errorString)
|
|
{
|
|
#ifndef Q_OS_WIN
|
|
bool success = false;
|
|
QFile orig(originFileName);
|
|
// We want a rename that also overwrites. QFile::rename does not overwrite.
|
|
// Qt 5.1 has QSaveFile::renameOverwrite we could use.
|
|
// ### FIXME
|
|
success = true;
|
|
bool destExists = fileExists(destinationFileName);
|
|
if (destExists && !QFile::remove(destinationFileName)) {
|
|
*errorString = orig.errorString();
|
|
qCWarning(lcFileSystem) << "Target file could not be removed.";
|
|
success = false;
|
|
}
|
|
if (success) {
|
|
success = orig.rename(destinationFileName);
|
|
}
|
|
if (!success) {
|
|
*errorString = orig.errorString();
|
|
qCWarning(lcFileSystem) << "Renaming temp file to final failed: " << *errorString;
|
|
return false;
|
|
}
|
|
|
|
#else //Q_OS_WIN
|
|
// You can not overwrite a read-only file on windows.
|
|
if (!QFileInfo(destinationFileName).isWritable()) {
|
|
setFileReadOnly(destinationFileName, false);
|
|
}
|
|
|
|
BOOL ok = 0;
|
|
QString orig = longWinPath(originFileName);
|
|
QString dest = longWinPath(destinationFileName);
|
|
|
|
ok = MoveFileEx((wchar_t *)orig.utf16(),
|
|
(wchar_t *)dest.utf16(),
|
|
MOVEFILE_REPLACE_EXISTING + MOVEFILE_COPY_ALLOWED + MOVEFILE_WRITE_THROUGH);
|
|
if (!ok) {
|
|
*errorString = Utility::formatWinError(GetLastError());
|
|
qCWarning(lcFileSystem) << "Renaming temp file to final failed: " << *errorString;
|
|
return false;
|
|
}
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
bool FileSystem::openAndSeekFileSharedRead(QFile *file, QString *errorOrNull, qint64 seek)
|
|
{
|
|
QString errorDummy;
|
|
// avoid many if (errorOrNull) later.
|
|
QString &error = errorOrNull ? *errorOrNull : errorDummy;
|
|
error.clear();
|
|
|
|
#ifdef Q_OS_WIN
|
|
//
|
|
// The following code is adapted from Qt's QFSFileEnginePrivate::nativeOpen()
|
|
// by including the FILE_SHARE_DELETE share mode.
|
|
//
|
|
|
|
// Enable full sharing.
|
|
DWORD shareMode = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE;
|
|
|
|
int accessRights = GENERIC_READ;
|
|
DWORD creationDisp = OPEN_EXISTING;
|
|
|
|
// Create the file handle.
|
|
SECURITY_ATTRIBUTES securityAtts = { sizeof(SECURITY_ATTRIBUTES), nullptr, FALSE };
|
|
QString fName = longWinPath(file->fileName());
|
|
|
|
HANDLE fileHandle = CreateFileW(
|
|
(const wchar_t *)fName.utf16(),
|
|
accessRights,
|
|
shareMode,
|
|
&securityAtts,
|
|
creationDisp,
|
|
FILE_ATTRIBUTE_NORMAL,
|
|
nullptr);
|
|
|
|
// Bail out on error.
|
|
if (fileHandle == INVALID_HANDLE_VALUE) {
|
|
error = qt_error_string();
|
|
return false;
|
|
}
|
|
|
|
// Convert the HANDLE to an fd and pass it to QFile's foreign-open
|
|
// function. The fd owns the handle, so when QFile later closes
|
|
// the fd the handle will be closed too.
|
|
int fd = _open_osfhandle((intptr_t)fileHandle, _O_RDONLY);
|
|
if (fd == -1) {
|
|
error = QStringLiteral("could not make fd from handle");
|
|
CloseHandle(fileHandle);
|
|
return false;
|
|
}
|
|
if (!file->open(fd, QIODevice::ReadOnly, QFile::AutoCloseHandle)) {
|
|
error = file->errorString();
|
|
_close(fd); // implicitly closes fileHandle
|
|
return false;
|
|
}
|
|
|
|
// Seek to the right spot
|
|
auto li = reinterpret_cast<LARGE_INTEGER *>(&seek);
|
|
DWORD newFilePointer = SetFilePointer(fileHandle, li->LowPart, &li->HighPart, FILE_BEGIN);
|
|
if (newFilePointer == 0xFFFFFFFF && GetLastError() != NO_ERROR) {
|
|
error = qt_error_string();
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
#else
|
|
if (!file->open(QFile::ReadOnly)) {
|
|
error = file->errorString();
|
|
return false;
|
|
}
|
|
if (!file->seek(seek)) {
|
|
error = file->errorString();
|
|
return false;
|
|
}
|
|
return true;
|
|
#endif
|
|
}
|
|
|
|
#ifdef Q_OS_WIN
|
|
static bool fileExistsWin(const QString &filename)
|
|
{
|
|
WIN32_FIND_DATA FindFileData;
|
|
HANDLE hFind = nullptr;
|
|
QString fName = FileSystem::longWinPath(filename);
|
|
|
|
hFind = FindFirstFileW((wchar_t *)fName.utf16(), &FindFileData);
|
|
if (hFind == INVALID_HANDLE_VALUE) {
|
|
return false;
|
|
}
|
|
FindClose(hFind);
|
|
return true;
|
|
}
|
|
#endif
|
|
|
|
bool FileSystem::fileExists(const QString &filename, const QFileInfo &fileInfo)
|
|
{
|
|
#ifdef Q_OS_WIN
|
|
if (isLnkFile(filename)) {
|
|
// Use a native check.
|
|
return fileExistsWin(filename);
|
|
}
|
|
#endif
|
|
bool re = fileInfo.exists();
|
|
// if the filename is different from the filename in fileInfo, the fileInfo is
|
|
// not valid. There needs to be one initialised here. Otherwise the incoming
|
|
// fileInfo is re-used.
|
|
if (fileInfo.filePath() != filename) {
|
|
QFileInfo myFI(filename);
|
|
re = myFI.exists();
|
|
}
|
|
return re;
|
|
}
|
|
|
|
#ifdef Q_OS_WIN
|
|
QString FileSystem::fileSystemForPath(const QString &path)
|
|
{
|
|
// See also QStorageInfo (Qt >=5.4) and GetVolumeInformationByHandleW (>= Vista)
|
|
QString drive = path.left(2);
|
|
if (!drive.endsWith(QLatin1Char(':')))
|
|
return QString();
|
|
drive.append(QLatin1Char('\\'));
|
|
|
|
const size_t fileSystemBufferSize = 4096;
|
|
TCHAR fileSystemBuffer[fileSystemBufferSize];
|
|
|
|
if (!GetVolumeInformationW(
|
|
reinterpret_cast<LPCWSTR>(drive.utf16()),
|
|
nullptr, 0,
|
|
nullptr, nullptr, nullptr,
|
|
fileSystemBuffer, fileSystemBufferSize)) {
|
|
return QString();
|
|
}
|
|
return QString::fromUtf16(reinterpret_cast<const ushort *>(fileSystemBuffer));
|
|
}
|
|
#endif
|
|
|
|
bool FileSystem::remove(const QString &fileName, QString *errorString)
|
|
{
|
|
#ifdef Q_OS_WIN
|
|
// You cannot delete a read-only file on windows, but we want to
|
|
// allow that.
|
|
if (!QFileInfo(fileName).isWritable()) {
|
|
setFileReadOnly(fileName, false);
|
|
}
|
|
#endif
|
|
QFile f(fileName);
|
|
if (!f.remove()) {
|
|
if (errorString) {
|
|
*errorString = f.errorString();
|
|
}
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool FileSystem::moveToTrash(const QString &fileName, QString *errorString)
|
|
{
|
|
// TODO: Qt 5.15 bool QFile::moveToTrash()
|
|
#if defined Q_OS_UNIX && !defined Q_OS_MAC
|
|
QString trashPath, trashFilePath, trashInfoPath;
|
|
QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
|
|
if (xdgDataHome.isEmpty()) {
|
|
trashPath = QDir::homePath() + QStringLiteral("/.local/share/Trash/"); // trash path that should exist
|
|
} else {
|
|
trashPath = xdgDataHome + QStringLiteral("/Trash/");
|
|
}
|
|
|
|
trashFilePath = trashPath + QStringLiteral("files/"); // trash file path contain delete files
|
|
trashInfoPath = trashPath + QStringLiteral("info/"); // trash info path contain delete files information
|
|
|
|
if (!(QDir().mkpath(trashFilePath) && QDir().mkpath(trashInfoPath))) {
|
|
*errorString = QCoreApplication::translate("FileSystem", "Could not make directories in trash");
|
|
return false; //mkpath will return true if path exists
|
|
}
|
|
|
|
QFileInfo f(fileName);
|
|
|
|
QDir file;
|
|
int suffix_number = 1;
|
|
if (file.exists(trashFilePath + f.fileName())) { //file in trash already exists, move to "filename.1"
|
|
QString path = trashFilePath + f.fileName() + QLatin1Char('.');
|
|
while (file.exists(path + QString::number(suffix_number))) { //or to "filename.2" if "filename.1" exists, etc
|
|
suffix_number++;
|
|
}
|
|
if (!file.rename(f.absoluteFilePath(), path + QString::number(suffix_number))) { // rename(file old path, file trash path)
|
|
*errorString = QCoreApplication::translate("FileSystem", R"(Could not move "%1" to "%2")")
|
|
.arg(f.absoluteFilePath(), path + QString::number(suffix_number));
|
|
return false;
|
|
}
|
|
} else {
|
|
if (!file.rename(f.absoluteFilePath(), trashFilePath + f.fileName())) { // rename(file old path, file trash path)
|
|
*errorString = QCoreApplication::translate("FileSystem", R"(Could not move "%1" to "%2")")
|
|
.arg(f.absoluteFilePath(), trashFilePath + f.fileName());
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// create file format for trash info file----- START
|
|
QFile infoFile;
|
|
if (file.exists(trashInfoPath + f.fileName() + QStringLiteral(".trashinfo"))) { //TrashInfo file already exists, create "filename.1.trashinfo"
|
|
QString filename = trashInfoPath + f.fileName() + QLatin1Char('.') + QString::number(suffix_number) + QStringLiteral(".trashinfo");
|
|
infoFile.setFileName(filename); //filename+.trashinfo // create file information file in /.local/share/Trash/info/ folder
|
|
} else {
|
|
QString filename = trashInfoPath + f.fileName() + QStringLiteral(".trashinfo");
|
|
infoFile.setFileName(filename); //filename+.trashinfo // create file information file in /.local/share/Trash/info/ folder
|
|
}
|
|
|
|
infoFile.open(QIODevice::ReadWrite);
|
|
|
|
QTextStream stream(&infoFile); // for write data on open file
|
|
|
|
stream << "[Trash Info]\n"
|
|
<< "Path="
|
|
<< QUrl::toPercentEncoding(f.absoluteFilePath(), "~_-./")
|
|
<< "\n"
|
|
<< "DeletionDate="
|
|
<< QDateTime::currentDateTime().toString(Qt::ISODate)
|
|
<< '\n';
|
|
infoFile.close();
|
|
|
|
// create info file format of trash file----- END
|
|
|
|
return true;
|
|
#else
|
|
Q_UNUSED(fileName)
|
|
*errorString = QCoreApplication::translate("FileSystem", "Moving to the trash is not implemented on this platform");
|
|
return false;
|
|
#endif
|
|
}
|
|
|
|
bool FileSystem::isFileLocked(const QString &fileName)
|
|
{
|
|
#ifdef Q_OS_WIN
|
|
// Check if file exists
|
|
const QString fName = longWinPath(fileName);
|
|
DWORD attr = GetFileAttributesW(reinterpret_cast<const wchar_t *>(fName.utf16()));
|
|
if (attr != INVALID_FILE_ATTRIBUTES) {
|
|
// Try to open the file with as much access as possible..
|
|
HANDLE win_h = CreateFileW(
|
|
reinterpret_cast<const wchar_t *>(fName.utf16()),
|
|
GENERIC_READ | GENERIC_WRITE,
|
|
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
|
|
nullptr, OPEN_EXISTING,
|
|
FILE_ATTRIBUTE_NORMAL | FILE_FLAG_BACKUP_SEMANTICS,
|
|
nullptr);
|
|
|
|
if (win_h == INVALID_HANDLE_VALUE) {
|
|
/* could not be opened, so locked? */
|
|
/* 32 == ERROR_SHARING_VIOLATION */
|
|
return true;
|
|
} else {
|
|
CloseHandle(win_h);
|
|
}
|
|
}
|
|
#else
|
|
Q_UNUSED(fileName);
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
bool FileSystem::isLnkFile(const QString &filename)
|
|
{
|
|
return filename.endsWith(QLatin1String(".lnk"));
|
|
}
|
|
|
|
bool FileSystem::isExcludeFile(const QString &filename)
|
|
{
|
|
return filename.compare(QStringLiteral(".sync-exclude.lst"), Qt::CaseInsensitive) == 0
|
|
|| filename.compare(QStringLiteral("exclude.lst"), Qt::CaseInsensitive) == 0
|
|
|| filename.endsWith(QStringLiteral("/.sync-exclude.lst"), Qt::CaseInsensitive)
|
|
|| filename.endsWith(QStringLiteral("/exclude.lst"), Qt::CaseInsensitive);
|
|
}
|
|
|
|
bool FileSystem::isJunction(const QString &filename)
|
|
{
|
|
#ifdef Q_OS_WIN
|
|
WIN32_FIND_DATA findData;
|
|
HANDLE hFind = FindFirstFileEx(reinterpret_cast<const wchar_t *>(longWinPath(filename).utf16()), FindExInfoBasic, &findData, FindExSearchNameMatch, nullptr, 0);
|
|
if (hFind != INVALID_HANDLE_VALUE) {
|
|
FindClose(hFind);
|
|
return false;
|
|
}
|
|
return findData.dwFileAttributes != INVALID_FILE_ATTRIBUTES
|
|
&& findData.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT
|
|
&& findData.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
|
|
#else
|
|
Q_UNUSED(filename);
|
|
return false;
|
|
#endif
|
|
}
|
|
|
|
#ifdef Q_OS_WIN
|
|
QString FileSystem::pathtoUNC(const QString &_str)
|
|
{
|
|
Q_ASSERT(QFileInfo(_str).isAbsolute());
|
|
if (_str.isEmpty()) {
|
|
return _str;
|
|
}
|
|
const QString str = QDir::toNativeSeparators(_str);
|
|
const QLatin1Char sep('\\');
|
|
|
|
// we already have a unc path
|
|
if (str.startsWith(sep + sep)) {
|
|
return str;
|
|
}
|
|
// prepend \\?\ and to support long names
|
|
|
|
if (str.at(0) == sep) {
|
|
// should not happen as we require the path to be absolute
|
|
return QStringLiteral(R"(\\?)") + str;
|
|
}
|
|
return QStringLiteral(R"(\\?\)") + str;
|
|
}
|
|
#endif
|
|
|
|
} // namespace OCC
|