Update musicxml_massage_export.lua

Implemented standalone menu for "Single File" and removed other options so FOLDER extraction always uses the source directory and appends to the output filename. Now using lfs in place of osutils.

Author: cv-on-hub

src/musicxml_massage_export.lua

@@ -4,19 +4,32 @@ function plugindef()
     finaleplugin.NoStore = true
     finaleplugin.Author = "Robert Patterson (folder scanning added by Carl Vine)"
     finaleplugin.Copyright = "CC0 https://creativecommons.org/publicdomain/zero/1.0/"
-    finaleplugin.Version = "1.0.4"
-    finaleplugin.Date = "October 1, 2024"
+    finaleplugin.Version = "1.0.5"
+    finaleplugin.Date = "October 2, 2024"
     finaleplugin.LoadLuaOSUtils = true
     finaleplugin.CategoryTags = "Document"
     finaleplugin.MinJWLuaVersion = 0.74
+    finaleplugin.AdditionalMenuOptions = [[
+        Massage MusicXML Single File
+    ]]
+    finaleplugin.AdditionalUndoText = [[
+        Massage MusicXML Single File
+    ]]
+    finaleplugin.AdditionalDescriptions = [[
+        Massage a MusicXML file to improve importing to Dorico and MuseScore
+    ]]
+    finaleplugin.AdditionalPrefixes = [[
+        do_single_file = true
+    ]]
+    finaleplugin.ScriptGroupName = "Staff Explode"
     finaleplugin.Notes = [[
-        This script reads a musicxml file exported from Finale and modifies it to
-        improve the importing into Dorico or MuseScore. The best process is as follows:
+        This script reads musicxml files exported from Finale and modifies them to
+        improve importing into Dorico or MuseScore. The best process is as follows:
 
         1. Export your document as uncompressed MusicXML.
         2. Run this plugin on the output *.musicxml document.
         3. The massaged file name has " massaged" appended to the file name.
-        3. Import the massaged *.musicxml into Dorico or MuseScore.
+        3. Import the massaged *.musicxml file into Dorico or MuseScore.
 
         Here is a list of some of the changes the script makes:
 
@@ -25,13 +38,14 @@ function plugindef()
         Due to a limitation in the xml parser, all xml processing instructions are removed. These are metadata that neither
         Dorico nor MuseScore use, so their removal should not affect importing into those programs.
     ]]
-    return "Massage MusicXML...",
-        "Massage MusicXML",
-        "Massages MusicXML to make it easier to import to Dorico and MuseScore."
+    return "Massage MusicXML Folder",
+        "Massage MusicXML Folder",
+        "Massage a folder of MusicXML files to improve importing to Dorico and MuseScore."
 end
 
+do_single_file = do_single_file or false
 local xml_extension = ".musicxml"
-local add_to_filename = "massaged"
+local add_to_filename = " massaged"
 
 local function alert_error(file_list)
     local msg = (#file_list > 1 and "These files do not " or "This file does not ")
@@ -62,56 +76,6 @@ local function remove_processing_instructions(input_name, output_name)
     output_file:close()
 end
 
-local function choose_extraction_method()
-    local fs = finale.FCString
-    local dialog = finale.FCCustomLuaWindow()
-    dialog:SetTitle(fs(plugindef()))
-    local stat = dialog:CreateStatic(0, 0)
-        stat:SetText(fs("Massage the MusicXML for:"))
-        stat:SetWidth(150)
-    local labels = finale.FCStrings()
-    labels:CopyFromStringTable{ "one MusicXML file", "a folder of MusicXML files" }
-    local method = dialog:CreateRadioButtonGroup(0, 20, 2)
-        method:SetText(labels)
-        method:SetWidth(160)
-        method:SetSelectedItem(1) -- assume "folder"
-    dialog:CreateOkButton()
-    dialog:CreateCancelButton()
-    local ok = (dialog:ExecuteModal(nil) == finale.EXECMODAL_OK)
-    return ok, (method:GetSelectedItem() == 1)
-end
-
-local function choose_new_folder_dialog()
-    local fs = finale.FCString
-    local dialog = finale.FCCustomLuaWindow()
-    dialog:SetTitle(fs(plugindef()))
-    local stat = dialog:CreateStatic(0, 0)
-        stat:SetText(fs("Select a Different Folder"))
-        stat:SetWidth(150)
-    stat = dialog:CreateStatic(0, 15)
-        stat:SetText(fs("for the Massaged Files:"))
-        stat:SetWidth(150)
-    local labels = finale.FCStrings()
-    labels:CopyFromStringTable{ "YES", "NO" }
-    local new_folder = dialog:CreateRadioButtonGroup(0, 35, 2)
-        new_folder:SetText(labels)
-        new_folder:SetWidth(80)
-        new_folder:SetSelectedItem(0)
-    local add = dialog:CreateCheckbox(0, 85)
-        add:SetText(fs("Don't Add \"" .. add_to_filename .. "\" to Filenames"))
-        add:SetWidth(210)
-        add:SetCheck(1)
-    stat = dialog:CreateStatic(15, 100)
-        stat:SetText(fs("When Using a Different Folder"))
-        stat:SetWidth(180)
-    dialog:CreateOkButton()
-    dialog:CreateCancelButton()
-    local ok = (dialog:ExecuteModal(nil) == finale.EXECMODAL_OK)
-    local do_change_filename = (add:GetCheck() == 0)
-    local select_new_folder = (new_folder:GetSelectedItem() == 0)
-    return ok, select_new_folder, do_change_filename
-end
-
 function fix_octave_shift(xml_measure)
     for xml_direction in xmlelements(xml_measure, "direction") do
         local xml_direction_type = xml_direction:FirstChildElement("direction-type")
@@ -167,14 +131,12 @@ function process_xml(score_partwise)
     end
 end
 
-function process_one_file(input_file, output_file, do_change_filename)
-    if do_change_filename then -- add "massaged" to output_file
-        local path, filename, extension = output_file:match("^(.-)([^\\/]-)%.([^\\/%.]+)$")
-        if not path or not filename or not extension then
-            error("Invalid file path format")
-        end
-        output_file = path .. filename .. " " .. add_to_filename .. "." .. extension
+function process_one_file(input_file)
+    local path, filename, extension = input_file:match("^(.-)([^\\/]-)%.([^\\/%.]+)$")
+    if not path or not filename or not extension then
+        error("Invalid file path format")
     end
+    local output_file = path .. filename .. add_to_filename .. xml_extension
 
     remove_processing_instructions(input_file, output_file)
     local musicxml = tinyxml2.XMLDocument()
@@ -193,73 +155,39 @@ function process_one_file(input_file, output_file, do_change_filename)
     return ""
 end
 
-function do_open_directory()
-    local src_dialog = finale.FCFolderBrowseDialog(finenv.UI())
-    src_dialog:SetWindowTitle(finale.FCString("Open Folder of MusicXML Files:"))
-    if not src_dialog:Execute() then
+function process_directory(path_name)
+    local folder_dialog = finale.FCFolderBrowseDialog(finenv.UI())
+    folder_dialog:SetWindowTitle(finale.FCString("Select Folder of MusicXML Files:"))
+    folder_dialog:SetFolderPath(path_name)
+    if not folder_dialog:Execute() then
         return nil -- user cancelled
     end
     local selected_directory = finale.FCString()
-    src_dialog:GetFolderPath(selected_directory)
+    folder_dialog:GetFolderPath(selected_directory)
     local src_dir = selected_directory.LuaString
-    local out_dir = src_dir -- duplicate source to output (for now)
-
-    local ok, select_new_folder, do_change_filename = choose_new_folder_dialog()
-    if not ok then return end -- cancelled
-    if select_new_folder then -- choose alternate destination dir
-        local out_dialog = finale.FCFolderBrowseDialog(finenv.UI())
-        out_dialog:SetWindowTitle(finale.FCString("Choose Folder for Massaged Files:"))
-        if not out_dialog:Execute() then return end  -- user cancelled
 
-        out_dialog:GetFolderPath(selected_directory)
-        out_dir = selected_directory.LuaString
-    end
-    if out_dir == src_dir then -- user might "choose" same folder as original
-        do_change_filename = true -- always change filenames in same directory
-    end
-    local osutils = finenv.EmbeddedLuaOSUtils and require("luaosutils")
-    if not osutils then return end -- can't get a directory listing
-    local options = finenv.UI():IsOnWindows() and "/b /ad" or "-1"
-    local file_list = osutils.process.list_dir(src_dir, options)
-    if file_list == "" then return end -- empty directory
-
-    -- run through the file list, identifying valid candidates
+    -- scan the directory, identifying valid candidate files
     local error_list = {}
-    for x_file in file_list:gmatch("([^\r\n]*)[\r\n]?") do
-        if x_file:sub(-xml_extension:len()) == xml_extension then
-            local src_file = src_dir .. "/" .. x_file
-            local dest_file = out_dir .. "/" .. x_file
-            local file_error = process_one_file(src_file, dest_file, do_change_filename)
+    local lfs = require("lfs")
+    for file in lfs.dir(src_dir) do
+        if file ~= "." and file ~= ".." and file:sub(-xml_extension:len()) == xml_extension then
+            local file_error = process_one_file(src_dir .. "/" .. file)
             if file_error ~= "" then
                 table.insert(error_list, file_error)
             end
+
         end
     end
     if #error_list > 0 then
         alert_error(error_list)
     end
 end
 
-function do_open_dialog(document)
-    local path_name = finale.FCString()
-    local file_name = finale.FCString()
-    local file_path = finale.FCString()
-    if document then
-        document:GetPath(file_path)
-        file_path:SplitToPathAndFile(path_name, file_name)
-    end
-    local full_file_name = file_name.LuaString
-    local extension = finale.FCString(file_name.LuaString)
-    extension:ExtractFileExtension()
-    if extension.Length > 0 then
-        file_name:TruncateAt(file_name:FindLast("." .. extension.LuaString))
-    end
-    file_name:AppendLuaString(xml_extension)
+function do_open_dialog(path_name)
     local open_dialog = finale.FCFileOpenDialog(finenv.UI())
-    open_dialog:SetWindowTitle(finale.FCString("Open MusicXML for " .. full_file_name))
+    open_dialog:SetWindowTitle(finale.FCString("Select a MusicXML File:"))
     open_dialog:AddFilter(finale.FCString("*" .. xml_extension), finale.FCString("MusicXML File"))
     open_dialog:SetInitFolder(path_name)
-    open_dialog:SetFileName(file_name)
     open_dialog:AssureFileExtension(xml_extension)
     if not open_dialog:Execute() then
         return nil
@@ -270,22 +198,25 @@ function do_open_dialog(document)
 end
 
 function music_xml_massage_export()
-    local ok, full_directory = choose_extraction_method()
-    if not ok then return end -- user cancelled
+    local documents = finale.FCDocuments()
+    documents:LoadAll()
+    local document = documents:FindCurrent()
+    local path_name = finale.FCString()
+    if document then -- extract active pathname
+        document:GetPath(path_name)
+        path_name:SplitToPathAndFile(path_name, nil)
+    end
 
-    if full_directory then
-        do_open_directory()
-    else -- only one file
-        local documents = finale.FCDocuments()
-        documents:LoadAll()
-        local document = documents:FindCurrent()
-        local xml_file = do_open_dialog(document)
+    if do_single_file then
+        local xml_file = do_open_dialog(path_name)
         if xml_file then
-            local file_error = process_one_file(xml_file, xml_file, true)
+            local file_error = process_one_file(xml_file)
             if file_error ~= "" then
                 alert_error{file_error}
             end
         end
+    else
+        process_directory(path_name)
     end
 end