- added fix for dangling commentrefs

desjarlais · Mar 10, 2021 · 9ffccb8 · 9ffccb8
1 parent 50abed5
commit 9ffccb8
Show file tree

Hide file tree

Showing 14 changed files with 127 additions and 9 deletions.
diff --git a/WinForms/FrmFixDocument.Designer.cs b/WinForms/FrmFixDocument.Designer.cs
diff --git a/WinForms/FrmFixDocument.cs b/WinForms/FrmFixDocument.cs
@@ -39,6 +39,7 @@ public void ResetCheckboxes()
             RdoNotes.Checked = false;
             RdoFixNotesPageWithFile.Checked = false;
             RdoTblGrid.Checked = false;
+            RdoFixComments.Checked = false;
         }
 
         /// <summary>
@@ -52,6 +53,7 @@ public void EnableWordUI()
             RdoRev.Enabled = true;
             RdoEndnotes.Enabled = true;
             RdoTblGrid.Enabled = true;
+            RdoFixComments.Enabled = true;
         }
 
         /// <summary>
@@ -94,6 +96,10 @@ private void BtnOk_Click(object sender, EventArgs e)
             {
                 OptionSelected = "NotesWithFile";
             }
+            else if (RdoFixComments.Checked)
+            {
+                OptionSelected = "FixComments";
+            }
 
             DialogResult = DialogResult.OK;
             Close();

diff --git a/WinForms/FrmMain.cs b/WinForms/FrmMain.cs
@@ -4266,6 +4266,103 @@ public void FixBookmarks()
             }
         }
 
+        public void FixCorruptComments()
+        {
+            try
+            {
+                LstDisplay.Items.Clear();
+                Cursor = Cursors.WaitCursor;
+
+                using (WordprocessingDocument document = WordprocessingDocument.Open(TxtFileName.Text, true))
+                {
+                    // TODO
+                    // loop each comment in comments.xml and get a list of comment ref #'s
+                    // loop each comment in document, compare id to commentRef
+                    // if the id does not exist, it needs to be deleted
+                    WordprocessingCommentsPart commentsPart = document.MainDocumentPart.WordprocessingCommentsPart;
+                    IEnumerable<OpenXmlUnknownElement> unknownList = document.MainDocumentPart.Document.Descendants<OpenXmlUnknownElement>();
+                    bool saveFile = false;
+                    bool cRefIdExists = false;
+
+                    if (commentsPart == null)
+                    {
+                        LogInformation(LogType.EmptyCount, StringResources.wComments, string.Empty);
+                    }
+                    else
+                    {
+                        foreach (OpenXmlUnknownElement uk in unknownList)
+                        {
+                            // for some reason these dangling refs are considered unknown types, not commentrefs
+                            // convert to an openxmlelement then type it to a commentref to get the id
+                            if (uk.LocalName == "commentReference")
+                            {
+                                // so far I only see the id in the outerxml
+                                XmlDocument xDoc = new XmlDocument();
+                                xDoc.LoadXml(uk.OuterXml);
+
+                                // traverse the outerxml until we get to the id
+                                if (xDoc.ChildNodes.Count > 0)
+                                {
+                                    foreach (XmlNode xNode in xDoc.ChildNodes)
+                                    {
+                                        if (xNode.Attributes.Count > 0)
+                                        {
+                                            foreach (XmlAttribute xa in xNode.Attributes)
+                                            {
+                                                if (xa.LocalName == "id")
+                                                {
+                                                    // now that we have the id number, we can use it to compare with the comment part
+                                                    // if the id exists in commentref but not the commentpart, it can be deleted
+                                                    foreach (O.Wordprocessing.Comment cm in commentsPart.Comments)
+                                                    {
+                                                        int cId = Convert.ToInt32(cm.Id);
+                                                        int cRefId = Convert.ToInt32(xa.Value);
+
+                                                        if (cId == cRefId)
+                                                        {
+                                                            cRefIdExists = true;
+                                                        }
+                                                    }
+
+                                                    if (cRefIdExists == false)
+                                                    {
+                                                        uk.Remove();
+                                                        saveFile = true;
+                                                    }
+                                                    else
+                                                    {
+                                                        cRefIdExists = false;
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+
+                        if (saveFile)
+                        {
+                            document.MainDocumentPart.Document.Save();
+                            LstDisplay.Items.Add("** Corrupt Comment Fixed **");
+                        }
+                        else
+                        {
+                            LstDisplay.Items.Add("** No Corrupt Comment Found **");
+                        }
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                LogInformation(LogType.LogException, "BtnFixCorruptComments", ex.Message);
+            }
+            finally
+            {
+                Cursor = Cursors.Default;
+            }
+        }
+
         /// <summary>
         /// this fix is for a known issue where files contain a table
         /// with a tblGrid element before the first table row, that is not valid per the schema
@@ -4674,6 +4771,9 @@ private void BtnFixDocument_Click(object sender, EventArgs e)
                         case "TblGrid":
                             FixTblGrid();
                             break;
+                        case "FixComments":
+                            FixCorruptComments();
+                            break;
                         default:
                             LstDisplay.Items.Add("No Option Selected");
                             LoggingHelper.Log("BtnFixDocument - No Option Selected");

diff --git a/WinForms/FrmParagraphs.cs b/WinForms/FrmParagraphs.cs
@@ -8,8 +8,6 @@
 using System;
 using System.Collections.Generic;
 using System.Windows.Forms;
-using System.Runtime.InteropServices;
-using System.Drawing;
 using System.Xml.Linq;
 using Office_File_Explorer.Word_Helpers;
 using System.Linq;

diff --git a/bin/Debug/Office File Explorer.application b/bin/Debug/Office File Explorer.application
@@ -21,7 +21,7 @@
           <dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity" />
         </dsig:Transforms>
         <dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha256" />
-        <dsig:DigestValue>LTgOozYHdAhmC9UgGJdXCQj6Vd2e+dLa5ft6K2N4Aj8=</dsig:DigestValue>
+        <dsig:DigestValue>VYhkgUaxjAfs1M+0e1cm38oXTIHUy3Zzb/Gmxiv9yYk=</dsig:DigestValue>
       </hash>
     </dependentAssembly>
   </dependency>

diff --git a/bin/Debug/Office File Explorer.exe b/bin/Debug/Office File Explorer.exe
diff --git a/bin/Debug/Office File Explorer.exe.manifest b/bin/Debug/Office File Explorer.exe.manifest
@@ -55,14 +55,14 @@
     </dependentAssembly>
   </dependency>
   <dependency>
-    <dependentAssembly dependencyType="install" allowDelayedBinding="true" codebase="Office File Explorer.exe" size="4488704">
+    <dependentAssembly dependencyType="install" allowDelayedBinding="true" codebase="Office File Explorer.exe" size="4490752">
       <assemblyIdentity name="Office File Explorer" version="1.0.2.50" language="neutral" processorArchitecture="msil" />
       <hash>
         <dsig:Transforms>
           <dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity" />
         </dsig:Transforms>
         <dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha256" />
-        <dsig:DigestValue>EJR/AvBYx4uImKsS4Qxy20Ae8u8lTcCrEnCKDAuDNag=</dsig:DigestValue>
+        <dsig:DigestValue>JUI6X+y6cXWa7XqzBbBD0R0OK6QGToJxmHh7FDob+c8=</dsig:DigestValue>
       </hash>
     </dependentAssembly>
   </dependency>

diff --git a/bin/Debug/Office File Explorer.pdb b/bin/Debug/Office File Explorer.pdb
diff --git a/bin/Debug/app.publish/Office File Explorer.exe b/bin/Debug/app.publish/Office File Explorer.exe
diff --git a/obj/Debug/Office File Explorer.application b/obj/Debug/Office File Explorer.application
@@ -21,7 +21,7 @@
           <dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity" />
         </dsig:Transforms>
         <dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha256" />
-        <dsig:DigestValue>LTgOozYHdAhmC9UgGJdXCQj6Vd2e+dLa5ft6K2N4Aj8=</dsig:DigestValue>
+        <dsig:DigestValue>VYhkgUaxjAfs1M+0e1cm38oXTIHUy3Zzb/Gmxiv9yYk=</dsig:DigestValue>
       </hash>
     </dependentAssembly>
   </dependency>

diff --git a/obj/Debug/Office File Explorer.csproj.GenerateResource.cache b/obj/Debug/Office File Explorer.csproj.GenerateResource.cache
diff --git a/obj/Debug/Office File Explorer.exe b/obj/Debug/Office File Explorer.exe
diff --git a/obj/Debug/Office File Explorer.exe.manifest b/obj/Debug/Office File Explorer.exe.manifest
@@ -55,14 +55,14 @@
     </dependentAssembly>
   </dependency>
   <dependency>
-    <dependentAssembly dependencyType="install" allowDelayedBinding="true" codebase="Office File Explorer.exe" size="4488704">
+    <dependentAssembly dependencyType="install" allowDelayedBinding="true" codebase="Office File Explorer.exe" size="4490752">
       <assemblyIdentity name="Office File Explorer" version="1.0.2.50" language="neutral" processorArchitecture="msil" />
       <hash>
         <dsig:Transforms>
           <dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity" />
         </dsig:Transforms>
         <dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha256" />
-        <dsig:DigestValue>EJR/AvBYx4uImKsS4Qxy20Ae8u8lTcCrEnCKDAuDNag=</dsig:DigestValue>
+        <dsig:DigestValue>JUI6X+y6cXWa7XqzBbBD0R0OK6QGToJxmHh7FDob+c8=</dsig:DigestValue>
       </hash>
     </dependentAssembly>
   </dependency>

diff --git a/obj/Debug/Office File Explorer.pdb b/obj/Debug/Office File Explorer.pdb