Hyperlinks in word documents cause exception on mono

[danielrh]

When I try to apply the simple paragraph adding test to a word docx file in mono http://msdn.microsoft.com/en-us/library/ee945362(v=office.11).aspx
I get the following exception (it works fine on windows with the current .NET runtime)

Unhandled Exception:
DocumentFormat.OpenXml.Packaging.OpenXmlPackageException: Invalid Hyperlink: Malformed URI is embedded as a hyperlink in the document.
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.Load () [0x00000] in <filename unknown>:0
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.OpenCore (System.IO.Stream stream, Boolean readWriteMode) [0x00000] in <filename unknown>:0
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable, DocumentFormat.OpenXml.Packaging.OpenSettings openSettings) [0x00000] in <filename unknown>:0
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable) [0x00000] in <filename unknown>:0
  at DocumentModifier.Program.Main (System.String[] args) [0x00000] in <filename unknown>:0
[ERROR] FATAL UNHANDLED EXCEPTION: DocumentFormat.OpenXml.Packaging.OpenXmlPackageException: Invalid
 Hyperlink: Malformed URI is embedded as a hyperlink in the document.
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.Load () [0x00000] in <filename unknown>:0
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.OpenCore (System.IO.Stream stream, Boolean read
WriteMode) [0x00000] in <filename unknown>:0
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable, DocumentFormat.OpenXml.Packaging.OpenSettings openSettings) [0x00000] in <filename unknown>:0
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable) [0x00000] in <filename unknown>:0
  at DocumentModifier.Program.Main (System.String[] args) [0x00000] in <filename unknown>:0

[danielrh]

The above was with a binary compiled on a windows box with .NET
Below is a stack trace compiled with mono-3.4

Unhandled Exception:
DocumentFormat.OpenXml.Packaging.OpenXmlPackageException: Invalid Hyperlink: Malformed URI is embedded as a hyperlink in the document.
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.Load () [0x0011d] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:475 
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.OpenCore (System.IO.Stream stream, Boolean readWriteMode) [0x0004f] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:337 
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable, DocumentFormat.OpenXml.Packaging.OpenSettings openSettings) [0x000b2] in /home/daniel/dev/Open-Xml-Sdk/src/ofapi/PackageDocument.cs:328 
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable) [0x00000] in /home/daniel/dev/Open-Xml-Sdk/src/ofapi/PackageDocument.cs:270 
  at Program.Main (System.String[] args) [0x00019] in /home/daniel/dev/writedoc/para.cs:12 
[ERROR] FATAL UNHANDLED EXCEPTION: DocumentFormat.OpenXml.Packaging.OpenXmlPackageException: Invalid Hyperlink: Malformed URI is embedded as a hyperlink in the document.
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.Load () [0x0011d] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:475 
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.OpenCore (System.IO.Stream stream, Boolean readWriteMode) [0x0004f] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:337 
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable, DocumentFormat.OpenXml.Packaging.OpenSettings openSettings) [0x000b2] in /home/daniel/dev/Open-Xml-Sdk/src/ofapi/PackageDocument.cs:328 
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable) [0x00000] in /home/daniel/dev/Open-Xml-Sdk/src/ofapi/PackageDocument.cs:270 
  at Program.Main (System.String[] args) [0x00019] in /home/daniel/dev/writedoc/para.cs:12 

The document in question is contained at http://graphics.stanford.edu/~danielrh/hyperlinks.docx

[danielrh]

When I unwrap the exception it looks like

System.UriFormatException: Absolute URI when we expected a relative one
  at System.Uri.Parse (UriKind kind, System.String uriString) [0x00020] in /home/daniel/dev/mono/mcs/class/System/System/Uri.cs:1352 
  at System.Uri.ParseUri (UriKind kind) [0x00000] in /home/daniel/dev/mono/mcs/class/System/System/Uri.cs:1214 
  at System.Uri..ctor (System.String uriString, UriKind uriKind) [0x00052] in /home/daniel/dev/mono/mcs/class/System/System/Uri.cs:156 
  at System.IO.Packaging.PackagePart.LoadRelationships (System.Collections.Generic.Dictionary`2 relationships, System.IO.Stream stream) [0x0008f] in /home/daniel/dev/mono/mcs/class/WindowsBase/System.IO.Packaging/PackagePart.cs:168 
  at System.IO.Packaging.PackagePart.get_Relationships () [0x00048] in /home/daniel/dev/mono/mcs/class/WindowsBase/System.IO.Packaging/PackagePart.cs:50 
  at System.IO.Packaging.PackagePart.GetRelationships () [0x00016] in /home/daniel/dev/mono/mcs/class/WindowsBase/System.IO.Packaging/PackagePart.cs:192 
  at DocumentFormat.OpenXml.Packaging.PackagePartRelationshipPropertyCollection..ctor (System.IO.Packaging.PackagePart packagePart) [0x00023] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:192 
  at DocumentFormat.OpenXml.Packaging.OpenXmlPart.Load (DocumentFormat.OpenXml.Packaging.OpenXmlPackage openXmlPackage, DocumentFormat.OpenXml.Packaging.OpenXmlPart parent, System.Uri uriTarget, System.String id, System.Collections.Generic.Dictionary`2 loadedParts) [0x00115] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlBasePart.cs:110 
  at DocumentFormat.OpenXml.Packaging.OpenXmlPartContainer.LoadReferencedPartsAndRelationships (DocumentFormat.OpenXml.Packaging.OpenXmlPackage openXmlPackage, DocumentFormat.OpenXml.Packaging.OpenXmlPart sourcePart, DocumentFormat.OpenXml.Packaging.RelationshipCollection relationshipCollection, System.Collections.Generic.Dictionary`2 loadedParts) [0x001a8] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/PartContainer.cs:2089 
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.Load () [0x00101] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:463 
  at DocumentFormat.OpenXml.Packaging.OpenXmlPackage.OpenCore (System.IO.Stream stream, Boolean readWriteMode) [0x0004f] in /home/daniel/dev/Open-Xml-Sdk/src/Framework/OpenXmlPackage.cs:337 
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable, DocumentFormat.OpenXml.Packaging.OpenSettings openSettings) [0x000b2] in /home/daniel/dev/Open-Xml-Sdk/src/ofapi/PackageDocument.cs:328 
  at DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open (System.IO.Stream stream, Boolean isEditable) [0x00000] in /home/daniel/dev/Open-Xml-Sdk/src/ofapi/PackageDocument.cs:270 
  at Program.Main (System.String[] args) [0x00019] in /home/daniel/dev/writedoc/para.cs:12 

[danielrh]

One hack that "fixes" this is to set uriKind = UriKind.RelativeOrAbsolute; in Uri.cs line 156 in the Uri constructor, but that clearly isn't a fix that can be shipped. It's also a change to the mono runtime

In the given doc, the error was thrown for the first hyperlink in the document (which is an absolute URI)

System.UriFormatException: Absolute URI when we expected a relative one https://drupal.org/

[danielrh]

Another less intrusive hack to work around the problem seems to be to make sure System.dll's PackagePart.cs in mcs/class/WindowsBase/System.IO.Packaging

void LoadRelationships (Dictionary<string, PackageRelationship> relationships, Stream stream) {
    XmlDocument doc = new XmlDocument ();
    doc.Load (stream);
    XmlNamespaceManager manager = new XmlNamespaceManager (doc.NameTable);
    manager.AddNamespace ("rel", Package.RelationshipNamespace);
    foreach (XmlNode node in doc.SelectNodes ("/rel:Relationships/*", manager))
    {
        TargetMode mode = TargetMode.Internal;
        if (node.Attributes["TargetMode"] != null)
            mode = (TargetMode) Enum.Parse (typeof(TargetMode), node.Attributes ["TargetMode"].Value);

        CreateRelationship (new Uri (node.Attributes["Target"].Value.ToString(), UriKind.Relative),  // <- FIXME: this should be RelativeOrAbsolute to support hyperlinks in word docs
                            mode,
                            node.Attributes["Type"].Value.ToString (),
                            node.Attributes["Id"].Value.ToString (),
                            true);
    }
}

[EricWhiteDev]

@danielrh - have you submitted a pull request for changing UriKind.Relative to RelativeOrAbsolute yet? BTW, thanks for taking care of the issue of improper date formatting in the core props part. (mono/mono@ceb092e)

[EricWhiteDev]

Hi Steve,

Do you know the status of this? Any chance of Mono taking the pull request to fix this?

[akoeplinger]

@EricWhiteDev I think the PR for this was already merged into Mono in July: mono/mono#1152