Differential D14631 Diff 44938 src/widgets/rename/batchrenamedialog.cpp

Changeset View

Standalone View

View Options

src/widgets/rename/batchrenamedialog.cpp

  • This file was added.
1​/***************************************************************************
2​ * Copyright (C) 2018 by Emirald Mateli <aldo.mateli@gmail.com> *
3​ * *
4​ * This program is free software; you can redistribute it and/or modify *
5​ * it under the terms of the GNU General Public License as published by *
6​ * the Free Software Foundation; either version 2 of the License, or *
7​ * (at your option) any later version. *
8​ * *
9​ * This program is distributed in the hope that it will be useful, *
10​ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12​ * GNU General Public License for more details. *
13​ * *
14​ * You should have received a copy of the GNU General Public License *
15​ * along with this program; if not, write to the *
16​ * Free Software Foundation, Inc., *
17​ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
18​ ***************************************************************************/
19​
20​#include "batchrenamedialog.h"
21​#include "filenameutils_p.h"
22​#include "batchrenamevar_p.h"
23​
24​#include <QDialogButtonBox>
25​#include <QDir>
26​#include <QLabel>
27​#include <QLineEdit>
28​#include <QPushButton>
29​#include <QHeaderView>
30​#include <QPushButton>
31​#include <QHBoxLayout>
32​#include <QVBoxLayout>
33​#include <QMenu>
34​#include <QActionEvent>
35​
36​#include <KGuiItem>
37​#include <KI18n/KLocalizedString>
38​#include <KIOCore/KIO/Job>
dfaureUnsubmitted
Done

Remove all the framework prefixes. E.g. this should be <KIO/Job>.

This way, it fails to find the include if the include path (which comes from linking to an imported target, in cmake) for the dependency is missing.

dfaure: Remove all the framework prefixes. E.g. this should be <KIO/Job>. This way, it fails to find…
39​#include <KIOCore/KIO/CopyJob>
40​#include <KIOWidgets/KIO/FileUndoManager>
41​#include <KJobWidgets/KJobWidgets>
mlaurentUnsubmitted
Done

remove QtWidget

mlaurent: remove QtWidget
42​
mlaurentUnsubmitted
Done

remove QtGui prefix

mlaurent: remove QtGui prefix
43​namespace KIO
44​{
dfaureUnsubmitted
Not Done

remove KI18n prefix, this isn't a namespaced header

dfaure: remove KI18n prefix, this isn't a namespaced header
45​
46​BatchRenameDialog::BatchRenameDialog(QWidget *parent, const KFileItemList &items)
47​ : QDialog(parent)
mlaurentUnsubmitted
Done

new line before ": QDialog"

mlaurent: new line before ": QDialog"
48​{
49​ auto *mainLayout = new QVBoxLayout(this);
mlaurentUnsubmitted
Done

new QVBoxLayout(this);
and remove setLayout(mainLayout);

mlaurent: new QVBoxLayout(this); and remove setLayout(mainLayout);
50​ setWindowTitle(i18nc("@title:window", "Rename Items"));
51​ setMinimumWidth(500);
52​
53​ model = new BatchRenameDialogModel(this, items);
54​
dfaureUnsubmitted
Not Done

This is very unusual. Any reason why the public class isn't the one that inherits from QDialog?

This would allow the caller to call show(), instead of show() happening automatically. Just for consistency with all other dialogs.

dfaure: This is very unusual. Any reason why the public class isn't the one that inherits from QDialog?
55​ m_timer = new QTimer(this);
56​ m_timer->setSingleShot(true);
57​ m_timer->setInterval(500);
58​ connect(m_timer, &QTimer::timeout, this, &BatchRenameDialog::updatePreview);
59​
60​ m_previewTable = new QTableView(this);
61​ m_previewTable->setModel(model);
mlaurentUnsubmitted
Done

add parent ?

mlaurent: add parent ?
62​ m_previewTable->horizontalHeader()->setStretchLastSection(true);
63​ m_previewTable->horizontalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents);
64​ m_previewTable->verticalHeader()->hide();
65​ m_previewTable->setColumnHidden(BatchRenameDialogModel::Valid, true);
66​ m_previewTable->setSelectionBehavior(QAbstractItemView::SelectRows);
67​ mainLayout->addWidget(m_previewTable);
68​
69​ const auto valueChangedIntCallback = [this](int) {
70​ onEditValueChanged(QString());
71​ };
72​
73​ // Create tab widget
74​ m_tabs = new QTabWidget(this);
75​
76​ QWidget *tabRenameSequential = new QWidget(m_tabs);
77​ auto layoutRenameSequential = new QVBoxLayout;
dfaureUnsubmitted
Not Done

QVector

dfaure: QVector
78​ layoutRenameSequential->setAlignment(Qt::AlignTop);
79​ tabRenameSequential->setLayout(layoutRenameSequential);
80​ m_tabs->addTab(tabRenameSequential, i18nc("@label", "Rename"));
81​
82​ QWidget *tabRenameFindReplace = new QWidget(m_tabs);
83​ m_tabs->addTab(tabRenameFindReplace, i18nc("@label", "Find && Replace"));
84​ auto layoutRenameFindReplace = new QVBoxLayout;
85​ layoutRenameFindReplace->setAlignment(Qt::AlignTop);
86​ tabRenameFindReplace->setLayout(layoutRenameFindReplace);
87​
88​ QWidget *tabNewNameFromMatches = new QWidget(m_tabs);
89​ m_tabs->addTab(tabNewNameFromMatches, i18nc("@label", "Capture groups"));
90​ auto layoutNewNameFromMatches = new QVBoxLayout;
91​ layoutNewNameFromMatches->setAlignment(Qt::AlignTop);
92​ tabNewNameFromMatches->setLayout(layoutNewNameFromMatches);
93​
94​ mainLayout->addWidget(m_tabs);
95​
96​ // Rename Sequential
97​ m_macroReplaceEdit = createLineEdit();
98​ m_macroReplaceEdit->setText(i18nc("@label:button", "New Name {index}"));
99​
100​ createInsertTokenMenu();
101​ auto btnInsertToken = new QPushButton(this);
102​ btnInsertToken->setText(i18nc("@label", "Insert token"));
103​ btnInsertToken->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
104​ connect(btnInsertToken, &QPushButton::clicked, [this]() {
105​ m_insertTokenMenu->exec(QCursor::pos());
106​ });
107​
108​ auto layoutEditInsertToken = new QHBoxLayout(this);
109​ layoutEditInsertToken->addWidget(m_macroReplaceEdit);
110​ layoutEditInsertToken->addWidget(btnInsertToken);
111​
112​ layoutRenameSequential->addWidget(new QLabel(i18ncp("@label:textbox", "Rename the %1 selected item to:",
113​ "Rename the %1 selected items to:", items.count()), this));
114​ layoutRenameSequential->addLayout(layoutEditInsertToken);
115​
116​
117​ m_IdStartFrom = new QSpinBox(this);
118​ m_IdStartFrom->setKeyboardTracking(true);
119​ connect(m_IdStartFrom, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged), valueChangedIntCallback);
120​ m_IdStartFrom->setRange(1, 1000000);
121​
122​ layoutRenameSequential->addWidget(
123​ new QLabel(i18nc("@info", "{index} will be replaced by ascending numbers starting with:"), this));
124​ layoutRenameSequential->addWidget(m_IdStartFrom);
125​
126​ m_IdPaddingLength = new QSpinBox(this);
127​ m_IdPaddingLength->setKeyboardTracking(true);
128​ connect(m_IdPaddingLength, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged), valueChangedIntCallback);
129​ m_IdPaddingLength->setRange(1, 1000000);
130​
131​ layoutRenameSequential->addWidget(new QLabel(i18nc("@info", "Pad numbers using a length of:"), this));
132​ layoutRenameSequential->addWidget(m_IdPaddingLength);
133​
134​ // Find & Replace tab
135​ m_findEdit = createLineEdit();
136​ m_replaceEdit = createLineEdit();
137​ m_useRegex = new QCheckBox(i18nc("@label", "Use Regular Expressions"), this);
138​ connect(m_useRegex, &QCheckBox::stateChanged, valueChangedIntCallback);
139​ m_caseInsensitive = new QCheckBox(i18nc("@label", "Case insensitive"), this);
140​ connect(m_caseInsensitive, &QCheckBox::stateChanged, valueChangedIntCallback);
141​
142​ layoutRenameFindReplace->addWidget(new QLabel(i18nc("@label", "Find:"), this));
143​ layoutRenameFindReplace->addWidget(m_findEdit);
144​
145​ layoutRenameFindReplace->addWidget(new QLabel(i18nc("@label", "Replace:"), this));
146​ layoutRenameFindReplace->addWidget(m_replaceEdit);
147​
148​ layoutRenameFindReplace->addItem(new QSpacerItem(0, 10));
149​ layoutRenameFindReplace->addWidget(m_useRegex);
150​ layoutRenameFindReplace->addWidget(m_caseInsensitive);
151​
152​ // New name from matches
153​ m_patternFind = createLineEdit();
154​ m_newNameFromMatches = createLineEdit();
155​
156​ layoutNewNameFromMatches->addWidget(new QLabel(i18nc("@label", "Find patterns:"), this));
157​ layoutNewNameFromMatches->addWidget(m_patternFind);
158​
159​ layoutNewNameFromMatches->addWidget(new QLabel(i18nc("@label", "New name:"), this));
160​ layoutNewNameFromMatches->addWidget(m_newNameFromMatches);
161​
162​ m_capturedGroupsText = new QLabel(this);
163​ m_capturedGroupsText->setWordWrap(true);
164​ layoutNewNameFromMatches->addWidget(m_capturedGroupsText);
165​
166​ m_messageWidget = new KMessageWidget(this);
167​ m_messageWidget->setCloseButtonVisible(false); // hiding,showing of the message will be handled by this form.
168​ m_messageWidget->hide();
169​ mainLayout->addWidget(m_messageWidget);
170​
171​ // Button Bar
172​ auto *buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help, this);
173​ m_btnOk = buttonBox->button(QDialogButtonBox::Ok);
mlaurentUnsubmitted
Done

add parent here too

mlaurent: add parent here too
174​
175​ KGuiItem::assign(m_btnOk, KGuiItem(i18nc("@action:button", "&Rename"), QStringLiteral("dialog-ok-apply")));
176​
177​ m_btnOk->setEnabled(false);
178​ connect(m_btnOk, &QPushButton::clicked, this, &BatchRenameDialog::btnOkClicked);
179​ connect(buttonBox, &QDialogButtonBox::rejected, this, &BatchRenameDialog::reject);
180​
181​ mainLayout->addWidget(buttonBox);
182​
183​ m_macroReplaceEdit->setFocus();
184​ updatePreview();
185​ connect(m_tabs, &QTabWidget::currentChanged, valueChangedIntCallback);
186​}
187​
188​void BatchRenameDialog::performPreviewRename(RenamerFunction *callback)
189​{
190​ QStringList generatedNames;
191​ QHash<QString, QVariant> params;
192​ bool allItemsOk = true;
193​ m_itemsToBeRenamed.clear();
194​
dfaureUnsubmitted
Done

params.insert(key, value) is faster than params[key] = value, see the book Effective C++ (or was it Effective STL?)

dfaure: params.insert(key, value) is faster than params[key] = value, see the book Effective C++ (or…
195​ params.insert(QStringLiteral("timestamp"), QDateTime::currentDateTime());
196​
197​ params.insert(QStringLiteral("macroReplace.text"), m_macroReplaceEdit->text());
198​ params.insert(QStringLiteral("macroReplace.padding"), m_IdPaddingLength->value());
199​
200​ params.insert(QStringLiteral("findReplace.find"), m_findEdit->text());
201​ params.insert(QStringLiteral("findReplace.replace"), m_replaceEdit->text());
202​ params.insert(QStringLiteral("findReplace.useRegex"), m_useRegex->isChecked());
203​ params.insert(QStringLiteral("findReplace.caseInsensitive"), m_caseInsensitive->isChecked());
204​
205​ params.insert(QStringLiteral("newName.find"), m_patternFind->text());
206​ params.insert(QStringLiteral("newName.replace"), m_newNameFromMatches->text());
207​
208​
209​ for (int i = 0; i < model->rowCount(); i++) {
210​ const QString itemName = model->data(model->index(i, BatchRenameDialogModel::Name), Qt::DisplayRole).toString();
211​ const KFileItem itemModel = model->fileItem(i);
212​ const QDir itemDir(itemModel.url().adjusted(QUrl::RemoveFilename).adjusted(QUrl::RemoveScheme).toString());
213​
214​ params.insert(QStringLiteral("name"), itemName);
215​ params.insert(QStringLiteral("baseName"), KIO::FileNameUtils::getName(itemName));
216​ params.insert(QStringLiteral("extension"), KIO::FileNameUtils::getSuffix(itemName));
217​ params.insert(QStringLiteral("macroReplace.sequence"), i + m_IdStartFrom->value());
218​
219​ const QString newName = KIO::encodeFileName(callback(params));
220​
221​ bool exists = (itemDir.exists(newName) || generatedNames.contains(newName));
222​ bool valid = (newName == itemName) || !(newName.isEmpty() || exists);
dfaureUnsubmitted
Done

bitfield operation on booleans can lead to unexpected behaviour.
Use allItemsOk = allItemsOk && valid instead, or if (!valid) allItemsOk = false;

dfaure: bitfield operation on booleans can lead to unexpected behaviour. Use `allItemsOk = allItemsOk…
223​ allItemsOk = allItemsOk && valid;
224​ generatedNames.append(newName);
225​
226​ if (newName != itemName && !exists) {
227​ m_itemsToBeRenamed.append(QPair<KFileItem, QString>(itemModel, newName));
228​ }
229​
230​ model->setData(model->index(i, BatchRenameDialogModel::Valid), valid, Qt::DisplayRole);
231​ model->setData(model->index(i, BatchRenameDialogModel::NewName), newName, Qt::DisplayRole);
232​ }
233​
234​ const int itemsToBeRenamed = m_itemsToBeRenamed.length();
235​ m_btnOk->setEnabled(allItemsOk && itemsToBeRenamed > 0);
236​ m_previewTable->repaint();
237​
238​ if (!allItemsOk) {
239​ updateStatus(i18nc("@info:status", "Renaming cannot continue while there are file name clashes"),
240​ KMessageWidget::Error);
241​ }
242​
243​ if (itemsToBeRenamed == 0) {
244​ updateStatus(i18nc("@info:status", "No items to be renamed"), KMessageWidget::Information);
245​ }
246​
247​ if (allItemsOk && itemsToBeRenamed > 0) {
248​ updateStatus(QString());
249​ }
250​}
251​
252​void BatchRenameDialog::renameItem(const KFileItem &item, const QString &newName)
253​{
254​ const QUrl newUrl = QUrl::fromLocalFile(item.url().adjusted(QUrl::RemoveFilename).path() + newName);
255​
256​ auto *job = KIO::moveAs(item.url(), newUrl, KIO::HideProgressInfo);
257​ KIO::FileUndoManager::self()->recordJob(KIO::FileUndoManager::Rename, {item.url()}, newUrl, job);
258​
dfaureUnsubmitted
Done

This makes no sense, you can't test for a job error before the job is done.
Connect to the result signal and do that in the slot (e.g. lambda) if it should really only be done on success -- after the move happened.

dfaure: This makes no sense, you can't test for a job error before the job is done. Connect to the…
259​ if (!job->error()) {
dfaureUnsubmitted
Not Done

My comment still stands: it makes no sense to test for error() before the job's result signal is emitted.

The comment was marked as done, but there's still no connect to result

dfaure: My comment still stands: it makes no sense to test for error() before the job's `result` signal…
260​ m_renamedItems << newUrl;
261​ }
262​}
263​
264​void BatchRenameDialog::performItemsRename()
265​{
dfaureUnsubmitted
Done

qAsConst(m_itemsToBeRenamed)

dfaure: qAsConst(m_itemsToBeRenamed)
266​ for (const auto &pair: qAsConst(m_itemsToBeRenamed)) {
267​ renameItem(pair.first, pair.second);
268​ }
269​}
270​
271​void BatchRenameDialog::updatePreview()
272​{
273​ switch (m_tabs->currentIndex()) {
274​ case 1:
275​ performPreviewRename(BatchRenameTypes::findReplaceRenamer);
276​ break;
277​ case 2:
278​ performPreviewRename(BatchRenameTypes::captureRegexGroups);
279​ updateCapturedGroupsLabel();
280​ break;
281​
282​ default:
283​ performPreviewRename(BatchRenameTypes::macroRenamer);
284​ }
285​}
286​
287​void BatchRenameDialog::btnOkClicked()
288​{
dfaureUnsubmitted
Done

Just remove the argument from the slot then.

dfaure: Just remove the argument from the slot then.
289​ performItemsRename();
290​ emit renamingFinished(m_renamedItems);
291​ accept();
292​}
293​
294​void BatchRenameDialog::onEditValueChanged(const QString &value)
295​{
296​ Q_UNUSED(value);
297​
298​ m_timer->start();
299​}
300​
301​QLineEdit *BatchRenameDialog::createLineEdit()
302​{
303​ auto edit = new QLineEdit(this);
304​ connect(edit, &QLineEdit::textChanged, this, &BatchRenameDialog::onEditValueChanged);
305​
306​ return edit;
307​}
308​
309​void BatchRenameDialog::updateStatus(const QString &message, KMessageWidget::MessageType messageType)
310​{
311​ // no actual status update.
312​ if (m_messageWidget->isVisible() && m_messageWidget->text() == message) {
313​ return;
314​ }
315​
316​ // if the message is empty, hide the widget
317​ if (message.isEmpty()) {
318​ m_messageWidget->animatedHide();
319​
320​ return;
321​ }
322​
323​ m_messageWidget->setMessageType(messageType);
324​ m_messageWidget->setText(message);
325​ m_messageWidget->animatedShow();
326​}
327​
328​QAction *BatchRenameDialog::createInsertTokenAction(const QString &text, const QString &token)
329​{
330​ auto result = new QAction(text, this);
331​ connect(result, &QAction::triggered, [this, token]() {
332​ m_macroReplaceEdit->setText(m_macroReplaceEdit->text() + token);
333​ });
334​
335​ return result;
336​}
337​
338​void BatchRenameDialog::createInsertTokenMenu()
339​{
340​ m_insertTokenMenu = new QMenu(this);
dfaureUnsubmitted
Not Done

Better connect to the result() signal of the job and do the rest of btnOkClicked in the slot (or lambda) connected to that signal.
exec() opens many potential issues (re-entrancy).

dfaure: Better connect to the result() signal of the job and do the rest of btnOkClicked in the slot…
341​
342​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Index"), BatchRenameVar::index()));
343​ m_insertTokenMenu->addSeparator();
344​
345​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "File name"), BatchRenameVar::fullName()));
346​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Base name"), BatchRenameVar::baseName()));
347​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Extension"), BatchRenameVar::suffix()));
348​ m_insertTokenMenu->addSeparator();
349​
350​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Year (4 digits)"), BatchRenameVar::dateYear4Digit()));
351​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Year (2 digits)"), BatchRenameVar::dateYear2Digit()));
352​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Month"), BatchRenameVar::dateMonth()));
353​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Day"), BatchRenameVar::dateDay()));
354​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Hour"), BatchRenameVar::dateHour()));
355​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Minute"), BatchRenameVar::dateMinute()));
356​ m_insertTokenMenu->addAction(createInsertTokenAction(i18nc("@label", "Second"), BatchRenameVar::dateSecond()));
357​}
358​
359​void BatchRenameDialog::updateCapturedGroupsLabel()
360​{
361​ QString groups;
362​ const auto capturedGroups = BatchRenameTypes::firstCapturedGroups();
363​
364​ for (int i = 0; i < capturedGroups.length(); i++) {
365​ if (capturedGroups[i].isEmpty()) {
366​ continue;
dfaureUnsubmitted
Done

use .isEmpty()

dfaure: use .isEmpty()
367​ }
368​
369​ groups.append(QStringLiteral("<tt>\\%1: </tt> %2<br>").arg(i).arg(capturedGroups[i]));
370​ }
371​
372​ m_capturedGroupsText->setText(QStringLiteral("<html>%1:<br><br>%2</html>")
373​ .arg(i18nc("@label", "Captured groups from the first row")).arg(groups));
374​ BatchRenameTypes::clearCapturedGroups();
375​}
376​}
dfaureUnsubmitted
Done

Please configure your text editor to add newlines at the end of files. Surprising that it doesn't do that, most do.

dfaure: Please configure your text editor to add newlines at the end of files. Surprising that it…