Use file dialog filter extension on file save

[embarc-gabriel]

Resolves: audacity/audacity#8166

The file dialog is ignoring the selected filter extension on file save.

• I signed the CLA
• The title of the PR describes the problem it addresses
• Each commit's message describes its purpose and effects, and references the issue it resolves
• If changes are extensive, there is a sequence of easily reviewable commits
• The code in the PR follows the coding rules
• There are no unnecessary changes
• The code compiles and runs on my machine, preferably after each commit individually
• I created a unit test or vtest to verify the changes I made (if applicable)

[embarc-gabriel]

@cbjeukendrup can you kindly take a look on this new attempt?
If there is something I need to adjust please let me know.
It is based on you previous work: #18645

[cbjeukendrup]

Shouldn't extension be initialised to muse::io::suffix(path)?
Or is the muse::io::suffix(path).empty() condition maybe not necessary?
Or what is the intended logic?

[embarc-gabriel]

Yeah! Probably it was not a nice code and it is hard to get the intention.
The user can fill the filename with the extension. On that specific case I won´t add the extension once the selectedPath already contains one. Maybe I can check if there is already an extension on selectedPath and extract from it. What do you think?

[cbjeukendrup]

Perhaps InteractiveProvider::openFileDialog should just be "dumb", and just return the path that the user entered, and the extension that was selected. Like this:

io::path_t selectedPath = QUrl::fromUserInput(resultMap["path"].toString()).toLocalFile();
std::string extension = resultMap["extension"].toString().toStdString();
result.val = { selectedPath, extension };

Then the post processing can happen in InteractiveProvider::selectSavingFile.
I would think the logic should be something like this:

• Look at the extension of fileInfo.val.path
• If it matches one of the allowed extensions of the selected filter, then just return that path
• If it does not match one of the allowed extensions, first allowed extension of the selected filter, and append it to the path, and return that.

(One filter can namely have multiple extensions, for example for MIDI files, the allowed extensions are *.mid and *.midi.)

And of course, we need to have special handling for the * filter, and I seem to recall that on Windows, there is a special filter for "no extension", namely *.. We use that for MSCX files.

[embarc-gabriel]

Done!
Is there anything else I should do to support the MSCX files?

[embarc-gabriel]

@cbjeukendrup

[cbjeukendrup]

@embarc-gabriel Sorry for the delay, it was not entirely like what I was thinking of, so I pushed a commit with what I had in mind. Could you please check if this works for you?
I'll also ask our QA team to double-check that it works well on all OS.

[cbjeukendrup]

@DmitryArefiev Could you please help testing the following:

• there should be no regressions for saving MSCZ and MSCX files
• there might be some improvement with regard to
  • When saving uncompressed MuseScore folder format, MU doesn't remove an extension and saves the score as mscz file on Linux (occurs on Windows/Mac if file extensions are not hidden) #11615
  • Saving a score without file extension saves the file as a folder, not as a mscz file. #17563
  • When saving score, adding period (.) at the end of file name creates mscx file instead of mscz (uncompressed MuseScore folder) on Windows #18321

[DmitryArefiev]

@embarc-gabriel @cbjeukendrup Tested on Win10, Mac13.7.2, LinuxUbuntu24.04.2 LTS

On Linux it crashes on save for new scores (when file browser appears to indicate the location)

Screencast.from.2025-05-06.18-33-36.webm

[embarc-gabriel]

@cbjeukendrup the problem is converting the extensions on FileDialog to RetVal.
There error is this one on toRetVal

Val::fromQVariant | Not supported type: QStringList

[embarc-gabriel]

@cbjeukendrup we can do something like this, for example:

root.ret = { "errcode": 0, "value": { "path": root.currentFile.toString(), "extensions": root.selectedNameFilter.extensions.map(function (ext) { return ext; }), } }

We can also update the val.cpp file.
What do you think?

[cbjeukendrup]

First of all, apologies, I thought I had tested this, but forgot that the code in question runs only on Linux (even though it is also compiled on other OSs).

Yet another option would be to change the type of QMap<QString, RetVal<Val> > m_retvals to QMap<QString, RetVal<QVariant> >, and only convert to Val where really needed, i.e. in methods that return RetVal<Val>.

But if that's too complicated, modifying val.cpp to handle QStringList in the same way as QVariantList is also okay.

[embarc-gabriel]

@cbjeukendrup I have added a new commit with your first suggestion.
The code worked as expected on my Linux machine.
Feel free to request further changes.
Thank you!
FYI @DmitryArefiev

[cbjeukendrup]

@DmitryArefiev Ready for second round :)

[DmitryArefiev]

@cbjeukendrup There is a kind of regression (comparing with #11615) on Linux

Screencast.from.2025-05-08.15-15-52.webm

[embarc-gabriel]

@DmitryArefiev @cbjeukendrup I didn´t understand the issue just watching the video.
Can you give some steps and what is expected?
Is there a way to test it on Au4 code?

[cbjeukendrup]

The problem is that the word "experimental" gets picked up as if it is the extension specification, because it is between parentheses... easiest workaround would be to change the parentheses around that word to square brackets.

[embarc-gabriel]

@cbjeukendrup should I change it on the selectScoreOpeningFile function, right? I am a little bit lost where this change should take place.

[cbjeukendrup]

Yes, and also OpenSaveProjectScenario::askLocalPath.

Actually, in ProjectActionsController::selectScoreOpeningFile, it would be good to update all 5 cases, also for other file types, because they would have the same problem.

[embarc-gabriel]

Fixed! Can we test it again @cbjeukendrup @DmitryArefiev ?

[DmitryArefiev]

On Linux, when saving Untitled score.mscz , it adds one period (at the end) in folder name, and two periods in file name.

Screencast.from.2025-05-14.17-04-35.webm

@cbjeukendrup With folder name it's probably fine.. but can we remove one period in file name (Untitled score.mscz..mscx) ?

[cbjeukendrup]

Perhaps we made a mistake here: instead of a filter, we will see an extension. So maybe the logic should be muse::contains(fileInfo.val.allowedExtensions, std::string()), to check if an empty extension is one of the allowed extensions. Because in that case, we should not add an extra ..