Skip to content

Commit

Permalink
Move files to trash instead of deleting them
Browse files Browse the repository at this point in the history
Add an option to have the client not delete files when they are removed
on the remote side, but to move them into the trash bin.

Fixes: #9001
  • Loading branch information
erikjv committed Nov 6, 2023
1 parent aa3ae4d commit a81f454
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 81 deletions.
75 changes: 0 additions & 75 deletions src/common/filesystembase.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -418,81 +418,6 @@ bool FileSystem::remove(const QString &fileName, QString *errorString)
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", "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", "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
}

#ifdef Q_OS_WIN

namespace {
Expand Down
5 changes: 0 additions & 5 deletions src/common/filesystembase.h
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,6 @@ namespace FileSystem {
*/
bool OCSYNC_EXPORT remove(const QString &fileName, QString *errorString = nullptr);

/**
* Move the specified file or folder to the trash. (Only implemented on linux)
*/
bool OCSYNC_EXPORT moveToTrash(const QString &filename, QString *errorString);

/**
* Replacement for QFile::open(ReadOnly) followed by a seek().
* This version sets a more permissive sharing mode on Windows.
Expand Down
5 changes: 5 additions & 0 deletions src/gui/folder.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1007,6 +1007,11 @@ void Folder::setDirtyNetworkLimits()
_engine->setNetworkLimits(uploadLimit, downloadLimit);
}

void Folder::reloadSyncOptions()
{
_engine->setSyncOptions(loadSyncOptions());
}

void Folder::slotSyncError(const QString &message, ErrorCategory category)
{
_syncResult.appendErrorString(message);
Expand Down
2 changes: 2 additions & 0 deletions src/gui/folder.h
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ class Folder : public QObject

void setDirtyNetworkLimits();

void reloadSyncOptions();

/**
* Ignore syncing of hidden files or not. This is defined in the
* folder definition
Expand Down
9 changes: 9 additions & 0 deletions src/gui/folderman.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,15 @@ Result<void, QString> FolderMan::unsupportedConfiguration(const QString &path) c
return *it;
}

void FolderMan::reloadSyncOptions()
{
for (auto *f : qAsConst(_folders)) {
if (f) {
f->reloadSyncOptions();
}
}
}

bool FolderMan::checkVfsAvailability(const QString &path, Vfs::Mode mode) const
{
return unsupportedConfiguration(path) && Vfs::checkAvailability(path, mode);
Expand Down
3 changes: 3 additions & 0 deletions src/gui/folderman.h
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,9 @@ class FolderMan : public QObject
/** If the folder configuration is no longer supported this will return an error string */
Result<void, QString> unsupportedConfiguration(const QString &path) const;

/// This method will tell all sync engines to reload the sync options.
void reloadSyncOptions();

signals:
/**
* signal to indicate a folder has changed its sync state.
Expand Down
6 changes: 6 additions & 0 deletions src/gui/generalsettings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ GeneralSettings::GeneralSettings(QWidget *parent)

_ui->crashreporterCheckBox->setVisible(Theme::instance()->withCrashReporter());

connect(_ui->moveToTrashCheckBox, &QCheckBox::toggled, this, [](bool checked) {
ConfigFile().setMoveToTrash(checked);
FolderMan::instance()->reloadSyncOptions();
});

/* Set the left contents margin of the layout to zero to make the checkboxes
* align properly vertically , fixes bug #3758
*/
Expand Down Expand Up @@ -287,6 +292,7 @@ void GeneralSettings::slotIgnoreFilesEditor()
void GeneralSettings::reloadConfig()
{
_ui->syncHiddenFilesCheckBox->setChecked(!FolderMan::instance()->ignoreHiddenFiles());
_ui->moveToTrashCheckBox->setChecked(ConfigFile().moveToTrash());
if (Utility::hasSystemLaunchOnStartup(Theme::instance()->appName())) {
_ui->autostartCheckBox->setChecked(true);
_ui->autostartCheckBox->setDisabled(true);
Expand Down
7 changes: 7 additions & 0 deletions src/gui/generalsettings.ui
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,13 @@
</property>
</widget>
</item>
<item>
<widget class="QCheckBox" name="moveToTrashCheckBox">
<property name="text">
<string>Move remotely deleted files to the local trash bin instead of deleting them</string>
</property>
</widget>
</item>
<item>
<layout class="QHBoxLayout" name="horizontalLayout_4">
<item>
Expand Down
5 changes: 4 additions & 1 deletion src/libsync/propagatorjobs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,10 @@ void PropagateLocalRemove::start()
bool ok = false;
QString removeError;
if (_moveToTrash) {
ok = FileSystem::moveToTrash(filename, &removeError);
ok = QFile(filename).moveToTrash();
if (!ok) {
removeError = tr("Could not move '%1' to the trash bin").arg(filename);
}
} else {
if (_item->isDirectory()) {
// removeRecursively will call done on error
Expand Down

0 comments on commit a81f454

Please sign in to comment.