Unexpected file order

[lufcmattylad]

When I list several files, e.g
1 2 3 4

then the output format is in this order
1 4 3 2

I expected the files to be concatenated in the order listed

[csant]

I can confirm this - but at least it is consequent, in so far as the order seems to always be 1432.

[titanix]

This happens because the insertion point in the document is the last paragraph, regardless of the number for altChunk added. The first document is the basis of the merge so its content is always the first, then subsequent documents are added after the last paragraph of the doc... with doesn't move place. So the other docs are added in what appears to be reverse order.

This fix is akin to (amusing no other altChunk are present already in the first document):

using (WordprocessingDocument doc = WordprocessingDocument.Open(output, true))
{
    foreach (var filepath in inputFiles.Skip(1))
    {
      // skipping the beginning of the loop

        using (FileStream fileStream = File.Open(filepath, FileMode.Open))
            chunk.FeedData(fileStream);                        

        OpenXmlCompositeElement target = null;
        
        try 
        {
            target = mainPart.Document.Body.Elements<AltChunk>().Last();
        }
        catch
        {
            target = mainPart.Document.Body.Elements<Paragraph>().Last();
        }

        AltChunk altChunk = new AltChunk();
        altChunk.Id = altChuckId;
        
        mainPart.Document
            .Body
            .InsertAfter(altChunk, target);  
        mainPart.Document.Save();        
    }
}

[yozhic]

@titanix
Could you please clarify your fix? What should be done to avoid these errors:

Error: D:\a\DocxMerge\DocxMerge\Program.cs(68,21): error CS0246: The type or namespace name 'OpenXmlCompositeElement' could not be found (are you missing a using directive or an assembly reference?) [D:\a\DocxMerge\DocxMerge\DocxMerge.csproj]
Error: D:\a\DocxMerge\DocxMerge\Program.cs(72,66): error CS0246: The type or namespace name 'AltChunk' could not be found (are you missing a using directive or an assembly reference?) [D:\a\DocxMerge\DocxMerge\DocxMerge.csproj]
Error: D:\a\DocxMerge\DocxMerge\Program.cs(76,66): error CS0246: The type or namespace name 'Paragraph' could not be found (are you missing a using directive or an assembly reference?) [D:\a\DocxMerge\DocxMerge\DocxMerge.csproj]
Error: D:\a\DocxMerge\DocxMerge\Program.cs(79,21): error CS0246: The type or namespace name 'AltChunk' could not be found (are you missing a using directive or an assembly reference?) [D:\a\DocxMerge\DocxMerge\DocxMerge.csproj]
Error: D:\a\DocxMerge\DocxMerge\Program.cs(79,45): error CS0246: The type or namespace name 'AltChunk' could not be found (are you missing a using directive or an assembly reference?) [D:\a\DocxMerge\DocxMerge\DocxMerge.csproj]

[titanix]

You need an additional using: using DocumentFormat.OpenXml.Wordprocessing;

[yozhic]

Thanks for the response. Sorry, I'm not a programmer, but I really need this utility ☺️
Now the build has failed with:

Error: D:\a\DocxMerge\DocxMerge\Program.cs(69,21): error CS0246: The type or namespace name 'OpenXmlCompositeElement' could not be found (are you missing a using directive or an assembly reference?) [D:\a\DocxMerge\DocxMerge\DocxMerge.csproj

Here is the full code of the fixed fragment:

using CommandLine;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing; // <= This is the last addition.
using System.Text.RegularExpressions;
using System.Xml;
using System.Xml.Linq;

// skipping lines 8-46

using (WordprocessingDocument doc = WordprocessingDocument.Open(output, true))
{
    int fileId = 0;
    foreach (var filepath in inputFiles.Skip(1))
    {
        if (verbose) Console.WriteLine("Adding {0} to {1}", filepath, output);
        fileId++;
        XNamespace w = "http://schemas.openxmlformats.org/wordprocessingml/2006/main";
        XNamespace r = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";

        string altChuckId = string.Format("AltChuckId{0}", fileId);
        var mainPart = doc.MainDocumentPart;
        var chunk = mainPart.AddAlternativeFormatImportPart(
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml",
            altChuckId);

        if (repairSpacing)
            RepairSentenceSpacing(filepath);

        using (FileStream fileStream = File.Open(filepath, FileMode.Open))
            chunk.FeedData(fileStream);

        OpenXmlCompositeElement target = null; // The error is citing this line.

        try 
        {
            target = mainPart.Document.Body.Elements<AltChunk>().Last();
        }
        catch
        {
            target = mainPart.Document.Body.Elements<Paragraph>().Last();
        }

        AltChunk altChunk = new AltChunk();
        altChunk.Id = altChuckId;
        
        mainPart.Document
            .Body
            .InsertAfter(altChunk, target);  
        mainPart.Document.Save();        
    }
}

Any chance to make it work?

[titanix]

Ah, you need an additional package that I added, but I also modernized the project a bit. You'll need .net 8.0 (https://dotnet.microsoft.com/en-us/download/dotnet/8.0). You can find all my code here: https://github.com/titanix/DocxMerge If it's still not working sorry I can't do more for you.

[yozhic]

You just made my day. The using DocumentFormat.OpenXml; did the trick. Now the utility merges docs in the correct order, the issue can be considered fixed. Thank you very much.

I'm leaving the complete fixed file for this fork here

Program.cs

using CommandLine;
using DocumentFormat.OpenXml;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using System.Text.RegularExpressions;
using System.Xml;
using System.Xml.Linq;

namespace DocxMerge;

static partial class Program
{
    static void Main(string[] args)
    {
        IEnumerable<string> inputFiles = null;
        string output = null;
        bool verbose = false;
        bool force = false;
        bool repairSpacing = false;

        var results = Parser.Default.ParseArguments<Options>(args);
        results.MapResult(options =>
        {
            inputFiles = options.InputFiles;
            output = options.Output ?? "output.docx";
            verbose = options.Verbose;
            force = options.Force;
            repairSpacing = options.RepairSpacing;
            return 0;
        }, _ =>
        {
            Environment.Exit(1);
            return 1; // ._.
        });

        if (inputFiles.Count() < 2) ExitWithError("There must be at least two input files");
        foreach (var file in inputFiles)
        {
            if (!File.Exists(file))
                ExitWithError("Unable to find {0}", file);
        }

        try {
            if (verbose) Console.WriteLine("Creating initial document");
            File.Copy(inputFiles.First(), output, force);

            if (verbose) Console.WriteLine("Opening {0} for writing", output);
            using (WordprocessingDocument doc = WordprocessingDocument.Open(output, true))
            {
                int fileId = 0;
                foreach (var filepath in inputFiles.Skip(1))
                {
                    if (verbose) Console.WriteLine("Adding {0} to {1}", filepath, output);
                    fileId++;
                    XNamespace w = "http://schemas.openxmlformats.org/wordprocessingml/2006/main";
                    XNamespace r = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";

                    string altChuckId = string.Format("AltChuckId{0}", fileId);
                    var mainPart = doc.MainDocumentPart;
                    var chunk = mainPart.AddAlternativeFormatImportPart(
                        "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml",
                        altChuckId);

                    if (repairSpacing)
                        RepairSentenceSpacing(filepath);

                    using (FileStream fileStream = File.Open(filepath, FileMode.Open))
                        chunk.FeedData(fileStream);

                    OpenXmlCompositeElement target = null;

                    try 
                    {
                        target = mainPart.Document.Body.Elements<AltChunk>().Last();
                    }
                    catch
                    {
                        target = mainPart.Document.Body.Elements<Paragraph>().Last();
                    }

                    AltChunk altChunk = new AltChunk();
                    altChunk.Id = altChuckId;
                    
                    mainPart.Document
                        .Body
                        .InsertAfter(altChunk, target);  
                    mainPart.Document.Save();        
                }
            }

            if (verbose) Console.WriteLine("Successfully merged all documents");
        }
        catch (Exception ex)
        {
            if (verbose) ExitWithError(ex.ToString());
            else ExitWithError("DocxMerge failed to process the files: {0}", ex.Message);
        }
    }

    private static void RepairSentenceSpacing(string filepath)
    {
        using WordprocessingDocument wordDoc = WordprocessingDocument.Open(filepath, true);
        string docText = null;
        using (StreamReader sr = new(wordDoc.MainDocumentPart.GetStream()))
        {
            docText = sr.ReadToEnd();
        }

        Regex regexText = RegexText();
        var refIndex = docText.IndexOf("References");
        if (refIndex > 0)
        {
            var bodyText = docText[..refIndex];
            var references = docText[bodyText.Length..];
            docText = regexText.Replace(bodyText, ".  ${a}") + references;
        }
        else
        {
            docText = regexText.Replace(docText, ".  ${a}");
        }

        using StreamWriter sw = new(wordDoc.MainDocumentPart.GetStream(FileMode.Create));
        sw.Write(docText);
    }

    private static XDocument GetXDocument(WordprocessingDocument myDoc)
    {
        // Load the main document part into an XDocument
        XDocument mainDocumentXDoc;
        using (Stream str = myDoc.MainDocumentPart.GetStream())
        using (XmlReader xr = XmlReader.Create(str))
            mainDocumentXDoc = XDocument.Load(xr);
        return mainDocumentXDoc;
    }

    private static void SaveXDocument(WordprocessingDocument myDoc, XDocument mainDocumentXDoc)
    {
        // Serialize the XDocument back into the part
        using Stream str = myDoc.MainDocumentPart.GetStream(
            FileMode.Create, FileAccess.Write);
        using XmlWriter xw = XmlWriter.Create(str);
        mainDocumentXDoc.Save(xw);
    }

    private static void ExitWithError(string message, params object[] args)
    {
        var defaultColor = Console.ForegroundColor;
        Console.ForegroundColor = ConsoleColor.Red;
        if (args.Length != 0)
            Console.WriteLine(message, args);
        else
            Console.WriteLine(message);
        Console.ForegroundColor = defaultColor;
        Environment.Exit(1);
    }

    [GeneratedRegex(@"\. (?<a>[A-Z])")]
    private static partial Regex RegexText();
}

Also thanks for the link to your fork, will definitely look into it later.