Feature Request - Enable Case-Sensitive Renaming

[DiapDealer]

Works for me on Windows. OPF properly updated.

[KevinH]

Great!

So if this works on Linux too, I can try to track down where else in "move" and "restructure code" changes might also be needed.

[DiapDealer]

I'm afraid I'm getting no joy on Linux with the same patch. I've double-checked that the patch has been applied and that I'm running the version of Sigil I just rebuilt.

[KevinH]

Oh well! Time to rethink that approach then. I really do not want to get into testing filesystems for case insensitive or not.

Let me think about how that routine should work on a true case sensitive filesystem.

[KevinH]

I think that this logic must be changed depending on filesystem type:

if (existing_bookpaths.contains(proposed_bookpath, Qt::CaseInsensitive))

But that would require knowing both source and destination filesystem case sensitivities which I do not want to do.

So maybe just a simple file exists() test would be better than a case insensitive search of existing bookpaths.

On a case sensitive filesystem, file exists() should return false for just a case change (assuming another file did not already exist with that case variant).

On a case insensitive filesystem, file exists() should return true for just a case change (and other case variants can not co-exist).

Yes, that should work on all filesystems without having to know which we are on

I will play around more tomorrow to test that approach.

[AlanHK]

I do like to have consistent filenames. Mostly all lower case as removes case issues. I learnt to make case changes in two steps, add a letter, change case and delete the letter.

I had a few problems previously when the epub had a file "image.jpg" and I import a better one "Image.jpg" that replaces the old version. This displays fine in Windows and in Sigil. Convert to AZW3 is fine. But sending the file to an iPad, no image.

Eventually did an epubcheck and it told me "image.jpg" was missing. Perplexed until I finally noticed the case. Now aware of this and compulsively do epubchecks on my files, especially before sending anywhere.

Probably impossible, but would be nice if Sigil was strict about name cases regardless of OS. e.g. did not display an image if the filename case does not match the code.

[KevinH]

Unfortunately, on a case insensitive filesystem all img src urls with just case variants will show the file as being there. There is no way to prevent that on systems like Windows.

That is why epubcheck is needed to check that the exact case of the manifest url for that file matches in a case sensitive manner with the url.

[KevinH]

Okay, here is an updated version that tries to be as fast (accessing file info on filesystems can be quite slow) as possible, but still work on Linux, MacOS, and Windows.

diff --git a/src/MainUI/OPFModel.cpp b/src/MainUI/OPFModel.cpp
index 3e9e7715f..59988d6a0 100644
--- a/src/MainUI/OPFModel.cpp
+++ b/src/MainUI/OPFModel.cpp
@@ -765,10 +765,21 @@ bool OPFModel::FilenameIsValid(const QString &old_bookpath, const QString &new_f
     QString sdir = Utility::startingDir(old_bookpath);
     QString proposed_bookpath = sdir.isEmpty() ? new_filename : sdir + "/" + new_filename;
     const QStringList existing_bookpaths = m_Book->GetFolderKeeper()->GetAllBookPaths();
+    // Using QFileInfo is slow so pretest with a much faster method before using it
     if (existing_bookpaths.contains(proposed_bookpath, Qt::CaseInsensitive)) {
-        Utility::DisplayStdErrorDialog(
-            tr("The filename \"%1\" is already in use.\n").arg(new_filename));
-        return false;
+        // potential issue on filesystems that are case insensitive
+        QString FullPathToMainFolder = m_Book->GetFolderKeeper()->GetFullPathToMainFolder();
+        QString orig_full_path = FullPathToMainFolder + "/" + old_bookpath;
+        QString proposed_full_path = FullPathToMainFolder + "/" + proposed_bookpath;
+        if (QFileInfo::exists(proposed_full_path)) {
+            // return false if orig_full_path and proposed_full_path are different files
+            // but allow through case only variationss from case insensitive filesystems
+            if (QFileInfo(orig_full_path) != QFileInfo(proposed_full_path)) {
+                Utility::DisplayStdErrorDialog(
+                    tr("The filename \"%1\" is already in use.\n").arg(new_filename));
+                return false;
+            }
+        }
     }
     return true;
 }

Please someone give this new version a try on Linux and Windows. It works on MacOS.

Thanks

[BeckyEbook]

Works on Windows.
Changes Cover.xhtml to cover.xhtml without any problems
However, if I already have the name Cover.xhtml then the other file cannot be named cover.xhtml

[KevinH]

Update:

I was able to get my Manjaro linux box up and ran this test and now it works on Linux.

If this works on Windows, then I can try to track down where else changes are needed.

Thanks,

[KevinH]

Originally Posted by BeckyEbook

Works on Windows.
Changes Cover.xhtml to cover.xhtml without any problems
However, if I already have the name Cover.xhtml then the other file cannot be named cover.xhtml

I am not sure I understand.

You can change Cover.xhtml to cover.xhtml but can not then change cover.xhtml back to Cover.xhtml?

Or do you mean you have two files named "Cover.xhtml" but in different folders?

On Windows you can not have two files in the same folder that are just variants in case. But renaming a single file should now work even if just a case variant.

So I am confused.

The problem is Linux will allow two case variants of the same name in the same folder, but this is a horrible idea for epubs to do since many e-reader filesystems use FAT and desktop users use MacOS and Windows which are case insensitive.

Our earlier code explicitly prevented that and still should even after this change.

[BeckyEbook]

No, no...
I have a file named cover.xhtml and when ANOTHER file I want rename to Cover.xhtml – then I can't do it and VERY well.

[BeckyEbook]

This is possible:

[KevinH]

Okay that is good!

My problem is going to be when renames are done in large groups and two different files try to end up with differnt names but that are case variants only.

As long as I do the renaming one file at a time, this new approach will work since the QFileInfo.exists(path) will work but to pre-approve a group of files to be renamed (without renaming them one by one for speed reasons) I must now change things to make sure that in a case insensitive manner no collisions will occur in the complete set.

[KevinH]

Originally Posted by BeckyEbook

This is possible:

Yes, and that should always work as the bookpaths are unique.

Good to know.