Use BatchRenameJob to rename multiple files in Dolphin

[dolphin.git] / src / views / renamedialog.cpp

diff --git a/src/views/renamedialog.cpp b/src/views/renamedialog.cpp
index 39e61c4640f8fc3d4a26059d2f16c4ac5ce3732e..2e1fa863444a228a0e705b76a423e963b88fb447 100644 (file)
--- a/src/views/renamedialog.cpp
+++ b/src/views/renamedialog.cpp
@@ -1,5 +1,5 @@
 /***************************************************************************
 /***************************************************************************

- *   Copyright (C) 2006 by Peter Penz (peter.penz@gmx.at)                  *
+ *   Copyright (C) 2006-2010 by Peter Penz (peter.penz@gmx.at)             *

  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *


@@ -19,16 +19,31 @@
 
 #include "renamedialog.h"
 
 
 #include "renamedialog.h"
 

-#include <kfileitem.h>
-#include <klineedit.h>
-#include <klocale.h>
-
-#include <QtGui/QLabel>
-#include <QtGui/QBoxLayout>
+#include <KLocalizedString>
+#include <KJobWidgets>
+#include <KIO/CopyJob>
+#include <KIO/FileUndoManager>
+#include <KJobUiDelegate>
+#include <KIO/BatchRenameJob>
+
+#include <QHBoxLayout>
+#include <QLabel>
+#include <QVBoxLayout>
+#include <QMimeDatabase>
+#include <QDialogButtonBox>
+#include <QPushButton>
+#include <QLineEdit>
+#include <QSpinBox>
+#include <KGuiItem>

 
 RenameDialog::RenameDialog(QWidget *parent, const KFileItemList& items) :
 
 RenameDialog::RenameDialog(QWidget *parent, const KFileItemList& items) :

-    KDialog(parent),
-    m_renameOneItem(false)
+    QDialog(parent),
+    m_renameOneItem(false),
+    m_newName(),
+    m_lineEdit(nullptr),
+    m_items(items),
+    m_allExtensionsDifferent(true),
+    m_spinBox(nullptr)

 {
     const QSize minSize = minimumSize();
     setMinimumSize(QSize(320, minSize.height()));
 {
     const QSize minSize = minimumSize();
     setMinimumSize(QSize(320, minSize.height()));


@@ -37,24 +52,33 @@ RenameDialog::RenameDialog(QWidget *parent, const KFileItemList& items) :
     Q_ASSERT(itemCount >= 1);
     m_renameOneItem = (itemCount == 1);
 
     Q_ASSERT(itemCount >= 1);
     m_renameOneItem = (itemCount == 1);
 

-    setCaption(m_renameOneItem ?
+    setWindowTitle(m_renameOneItem ?

                i18nc("@title:window", "Rename Item") :
                i18nc("@title:window", "Rename Items"));
                i18nc("@title:window", "Rename Item") :
                i18nc("@title:window", "Rename Items"));

-    setButtons(Ok | Cancel);
-    setDefaultButton(Ok);
-
-    setButtonGuiItem(Ok, KGuiItem(i18nc("@action:button", "&Rename"), "dialog-ok-apply"));
+    QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok|QDialogButtonBox::Cancel);
+    QVBoxLayout *mainLayout = new QVBoxLayout;
+    setLayout(mainLayout);
+    m_okButton = buttonBox->button(QDialogButtonBox::Ok);
+    m_okButton->setDefault(true);
+    m_okButton->setShortcut(Qt::CTRL | Qt::Key_Return);
+    connect(buttonBox, &QDialogButtonBox::accepted, this, &RenameDialog::slotAccepted);
+    connect(buttonBox, &QDialogButtonBox::rejected, this, &RenameDialog::reject);
+    m_okButton->setDefault(true);
+
+    KGuiItem::assign(m_okButton, KGuiItem(i18nc("@action:button", "&Rename"), QStringLiteral("dialog-ok-apply")));

 
     QWidget* page = new QWidget(this);
 
     QWidget* page = new QWidget(this);

-    setMainWidget(page);
+    mainLayout->addWidget(page);
+    mainLayout->addWidget(buttonBox);

 
     QVBoxLayout* topLayout = new QVBoxLayout(page);
 
 
     QVBoxLayout* topLayout = new QVBoxLayout(page);
 

-    QLabel* editLabel = 0;
+    QLabel* editLabel = nullptr;

     if (m_renameOneItem) {
         m_newName = items.first().name();
     if (m_renameOneItem) {
         m_newName = items.first().name();

-        editLabel = new QLabel(i18nc("@label:textbox", "Rename the item <filename>%1</filename> to:", m_newName),
+        editLabel = new QLabel(xi18nc("@label:textbox", "Rename the item <filename>%1</filename> to:", m_newName),

                                page);
                                page);

+        editLabel->setTextFormat(Qt::PlainText);

     } else {
         m_newName = i18nc("@info:status", "New name #");
         editLabel = new QLabel(i18ncp("@label:textbox",
     } else {
         m_newName = i18nc("@info:status", "New name #");
         editLabel = new QLabel(i18ncp("@label:textbox",


@@ -63,49 +87,61 @@ RenameDialog::RenameDialog(QWidget *parent, const KFileItemList& items) :
                                page);
     }
 
                                page);
     }
 

-    m_lineEdit = new KLineEdit(page);
-
-    QString fileName = items[0].url().prettyUrl();
-    QString extension = KMimeType::extractKnownExtension(fileName.toLower());
-    if (!extension.isEmpty()) {
-        extension.insert(0, '.');
-        // The first item seems to have a extension (e. g. '.jpg' or '.txt'). Now
-        // check whether all other URLs have the same extension. If this is the
-        // case, add this extension to the name suggestion.
-        for (int i = 1; i < itemCount; ++i) {
-            fileName = items[i].url().prettyUrl().toLower();
-            if (!fileName.endsWith(extension)) {
-                // at least one item does not have the same extension
-                extension.truncate(0);
-                break;
-            }
-        }
-    }
+    m_lineEdit = new QLineEdit(page);
+    mainLayout->addWidget(m_lineEdit);
+    connect(m_lineEdit, &QLineEdit::textChanged, this, &RenameDialog::slotTextChanged);

 
     int selectionLength = m_newName.length();
 
     int selectionLength = m_newName.length();

-    if (!m_renameOneItem) {
-        --selectionLength; // don't select the # character
-    }
-
-    const int extensionLength = extension.length();
-    if (extensionLength > 0) {
-        if (m_renameOneItem) {
-            selectionLength -= extensionLength;
-        } else {
-            m_newName.append(extension);
+    if (m_renameOneItem) {
+        const QString fileName = items.first().url().toDisplayString();
+        QMimeDatabase db;
+        const QString extension = db.suffixForFileName(fileName.toLower());
+
+        // If the current item is a directory, select the whole file name.
+        if ((extension.length() > 0) && !items.first().isDir()) {
+            // Don't select the extension
+            selectionLength -= extension.length() + 1;

         }
         }

+    } else {
+         // Don't select the # character
+        --selectionLength;

     }
 
     m_lineEdit->setText(m_newName);
     m_lineEdit->setSelection(0, selectionLength);
     }
 
     m_lineEdit->setText(m_newName);
     m_lineEdit->setSelection(0, selectionLength);

-    m_lineEdit->setFocus();

 
     topLayout->addWidget(editLabel);
     topLayout->addWidget(m_lineEdit);
 
     if (!m_renameOneItem) {
 
     topLayout->addWidget(editLabel);
     topLayout->addWidget(m_lineEdit);
 
     if (!m_renameOneItem) {

-        QLabel* infoLabel = new QLabel(i18nc("@info", "(# will be replaced by ascending numbers)"), page);
-        topLayout->addWidget(infoLabel);
+        QSet<QString> extensions;
+        foreach (const KFileItem& item, m_items) {
+            QMimeDatabase db;
+            const QString extension = db.suffixForFileName(item.url().toDisplayString().toLower());
+
+            if (extensions.contains(extension)) {
+                m_allExtensionsDifferent = false;
+                break;
+            }
+
+            extensions.insert(extension);
+        }
+
+        QLabel* infoLabel = new QLabel(i18nc("@info", "# will be replaced by ascending numbers starting with:"), page);
+        mainLayout->addWidget(infoLabel);
+        m_spinBox = new QSpinBox(page);
+        m_spinBox->setMaximum(10000);
+        m_spinBox->setMinimum(0);
+        m_spinBox->setSingleStep(1);
+        m_spinBox->setValue(1);
+        m_spinBox->setDisplayIntegerBase(10);
+
+        QHBoxLayout* horizontalLayout = new QHBoxLayout(page);
+        horizontalLayout->setMargin(0);
+        horizontalLayout->addWidget(infoLabel);
+        horizontalLayout->addWidget(m_spinBox);
+
+        topLayout->addLayout(horizontalLayout);

     }
 }
 
     }
 }
 


@@ -113,20 +149,69 @@ RenameDialog::~RenameDialog()
 {
 }
 
 {
 }
 

-void RenameDialog::slotButtonClicked(int button)
+void RenameDialog::slotAccepted()
+{
+    QWidget* widget = parentWidget();
+    if (!widget) {
+        widget = this;
+    }
+
+    KIO::FileUndoManager::CommandType cmdType;
+    if (m_renameOneItem) {
+        Q_ASSERT(m_items.count() == 1);
+        cmdType = KIO::FileUndoManager::Rename;
+    } else {
+        cmdType = KIO::FileUndoManager::BatchRename;
+    }
+
+    const QList<QUrl> srcList = m_items.urlList();
+    KIO::BatchRenameJob* job = KIO::batchRename(srcList, m_lineEdit->text(), m_spinBox->value(), QLatin1Char('#'));
+    KJobWidgets::setWindow(job, widget);
+    const QUrl parentUrl = srcList.first().adjusted(QUrl::RemoveFilename | QUrl::StripTrailingSlash);
+    KIO::FileUndoManager::self()->recordJob(cmdType, srcList, parentUrl, job);
+
+    connect(job, &KIO::BatchRenameJob::fileRenamed, this, &RenameDialog::slotFileRenamed);
+    connect(job, &KIO::BatchRenameJob::result, this, &RenameDialog::slotResult);
+
+    job->uiDelegate()->setAutoErrorHandlingEnabled(true);
+
+    accept();
+}
+
+void RenameDialog::slotTextChanged(const QString& newName)

 {
 {

-    if (button == Ok) {
-        m_newName = m_lineEdit->text();
-        if (m_newName.isEmpty()) {
-            m_errorString = i18nc("@info:status",
-                                  "The new name is empty. A name with at least one character must be entered.");
-        } else if (!m_renameOneItem && (m_newName.count('#') == 0)) {
-            m_newName.truncate(0);
-            m_errorString = i18nc("@info:status", "The name must contain at least one # character.");
+    bool enable = !newName.isEmpty() && (newName != QLatin1String("..")) && (newName != QLatin1String("."));
+    if (enable && !m_renameOneItem) {
+        const int count = newName.count(QLatin1Char('#'));
+        if (count == 0) {
+            // Renaming multiple files without '#' will only work if all extensions are different.
+            enable = m_allExtensionsDifferent;
+        } else {
+            // Assure that the new name contains exactly one # (or a connected sequence of #'s)
+            const int first = newName.indexOf(QLatin1Char('#'));
+            const int last = newName.lastIndexOf(QLatin1Char('#'));
+            enable = (last - first + 1 == count);

         }
     }
         }
     }

+    m_okButton->setEnabled(enable);
+}

 
 

-    KDialog::slotButtonClicked(button);
+void RenameDialog::slotFileRenamed(const QUrl &oldUrl, const QUrl &newUrl)
+{
+    Q_UNUSED(oldUrl)
+    m_renamedItems << newUrl;
+}
+
+void RenameDialog::slotResult(KJob *job)
+{
+    if (!job->error()) {
+        emit renamingFinished(m_renamedItems);
+    }

 }
 
 }
 

-#include "renamedialog.moc"
+void RenameDialog::showEvent(QShowEvent* event)
+{
+    m_lineEdit->setFocus();
+
+    QDialog::showEvent(event);
+}