moved filerenamer to its own .cpp/.h pair

1 files changed, 189 insertions, 0 deletions

diff --git a/src/filerenamer.cpp b/src/filerenamer.cpp
new file mode 100644
index 00000000..c5c6782b
--- /dev/null
+++ b/src/filerenamer.cpp
@@ -0,0 +1,189 @@
+#include "filerenamer.h"
+#include <QMessageBox>
+#include <QFileInfo>
+
+FileRenamer::FileRenamer(QWidget* parent, QFlags<RenameFlags> flags)
+  : m_parent(parent), m_flags(flags)
+{
+  // sanity check for flags
+  if ((m_flags & (HIDE|UNHIDE)) == 0) {
+    qCritical("renameFile() missing hide flag");
+    // doesn't really matter, it's just for text
+    m_flags = HIDE;
+  }
+}
+
+FileRenamer::RenameResults FileRenamer::rename(const QString& oldName, const QString& newName)
+{
+  qDebug().nospace() << "renaming " << oldName << " to " << newName;
+
+  if (QFileInfo(newName).exists()) {
+    qDebug().nospace() << newName << " already exists";
+
+    // target file already exists, confirm replacement
+    auto answer = confirmReplace(newName);
+
+    switch (answer) {
+      case DECISION_SKIP: {
+        // user wants to skip this file
+        qDebug().nospace() << "skipping " << oldName;
+        return RESULT_SKIP;
+      }
+
+      case DECISION_REPLACE: {
+        qDebug().nospace() << "removing " << newName;
+        // user wants to replace the file, so remove it
+        if (!QFile(newName).remove()) {
+          qWarning().nospace() << "failed to remove " << newName;
+          // removal failed, warn the user and allow canceling
+          if (!removeFailed(newName)) {
+            qDebug().nospace() << "canceling " << oldName;
+            // user wants to cancel
+            return RESULT_CANCEL;
+          }
+
+          // ignore this file and continue on
+          qDebug().nospace() << "skipping " << oldName;
+          return RESULT_SKIP;
+        }
+
+        break;
+      }
+
+      case DECISION_CANCEL:  // fall-through
+      default: {
+        // user wants to stop
+        qDebug().nospace() << "canceling";
+        return RESULT_CANCEL;
+      }
+    }
+  }
+
+  // target either didn't exist or was removed correctly
+
+  if (!QFile::rename(oldName, newName)) {
+    qWarning().nospace() << "failed to rename " << oldName << " to " << newName;
+
+    // renaming failed, warn the user and allow canceling
+    if (!renameFailed(oldName, newName)) {
+      // user wants to cancel
+      qDebug().nospace() << "canceling";
+      return RESULT_CANCEL;
+    }
+
+    // ignore this file and continue on
+    qDebug().nospace() << "skipping " << oldName;
+    return RESULT_SKIP;
+  }
+
+  // everything worked
+  qDebug().nospace() << "successfully renamed " << oldName << " to " << newName;
+  return RESULT_OK;
+}
+
+FileRenamer::RenameDecision FileRenamer::confirmReplace(const QString& newName)
+{
+  if (m_flags & REPLACE_ALL) {
+    // user wants to silently replace all
+    qDebug().nospace() << "user has selected replace all";
+    return DECISION_REPLACE;
+  }
+  else if (m_flags & REPLACE_NONE) {
+    // user wants to silently skip all
+    qDebug().nospace() << "user has selected replace none";
+    return DECISION_SKIP;
+  }
+
+  QString text;
+
+  if (m_flags & HIDE) {
+    text = QObject::tr("The hidden file \"%1\" already exists. Replace it?").arg(newName);
+  }
+  else if (m_flags & UNHIDE) {
+    text = QObject::tr("The visible file \"%1\" already exists. Replace it?").arg(newName);
+  }
+
+  auto buttons = QMessageBox::Yes | QMessageBox::No;
+  if (m_flags & MULTIPLE) {
+    // only show these buttons when there are multiple files to replace
+    buttons |= QMessageBox::YesToAll | QMessageBox::NoToAll | QMessageBox::Cancel;
+  }
+
+  const auto answer = QMessageBox::question(
+    m_parent, QObject::tr("Replace file?"), text, buttons);
+
+  switch (answer) {
+    case QMessageBox::Yes:
+      qDebug().nospace() << "user wants to replace";
+      return DECISION_REPLACE;
+
+    case QMessageBox::No:
+      qDebug().nospace() << "user wants to skip";
+      return DECISION_SKIP;
+
+    case QMessageBox::YesToAll:
+      qDebug().nospace() << "user wants to replace all";
+      // remember the answer
+      m_flags |= REPLACE_ALL;
+      return DECISION_REPLACE;
+
+    case QMessageBox::NoToAll:
+      qDebug().nospace() << "user wants to replace none";
+      // remember the answer
+      m_flags |= REPLACE_NONE;
+      return DECISION_SKIP;
+
+    case QMessageBox::Cancel:  // fall-through
+    default:
+      qDebug().nospace() << "user wants to cancel";
+      return DECISION_CANCEL;
+  }
+}
+
+bool FileRenamer::removeFailed(const QString& name)
+{
+  QMessageBox::StandardButtons buttons = QMessageBox::Ok;
+  if (m_flags & MULTIPLE) {
+    // only show cancel for multiple files
+    buttons |= QMessageBox::Cancel;
+  }
+
+  const auto answer = QMessageBox::critical(
+    m_parent, QObject::tr("File operation failed"),
+    QObject::tr("Failed to remove \"%1\". Maybe you lack the required file permissions?").arg(name),
+    buttons);
+
+  if (answer == QMessageBox::Cancel) {
+    // user wants to stop
+    qDebug().nospace() << "user wants to cancel";
+    return false;
+  }
+
+  // skip this one and continue
+  qDebug().nospace() << "user wants to skip";
+  return true;
+}
+
+bool FileRenamer::renameFailed(const QString& oldName, const QString& newName)
+{
+  QMessageBox::StandardButtons buttons = QMessageBox::Ok;
+  if (m_flags & MULTIPLE) {
+    // only show cancel for multiple files
+    buttons |= QMessageBox::Cancel;
+  }
+
+  const auto answer = QMessageBox::critical(
+    m_parent, QObject::tr("File operation failed"),
+    QObject::tr("failed to rename %1 to %2").arg(oldName).arg(QDir::toNativeSeparators(newName)),
+    buttons);
+
+  if (answer == QMessageBox::Cancel) {
+    // user wants to stop
+    qDebug().nospace() << "user wants to cancel";
+    return false;
+  }
+
+  // skip this one and continue
+  qDebug().nospace() << "user wants to skip";
+  return true;
+}