Skip to content

Only unload part when saving part if it is not the same element #1828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Only unload part when saving part if it is not the same element #1828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c7ba0f
Only unload part when saving part if it is not the same element
twsouthwick Nov 19, 2024
d5c1772
Merge branch 'main' into save-part
twsouthwick Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Open-XML-SDK.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,9 @@ Global
{890B74DD-6316-4D56-B42A-5D66F10F88C6} = {C5AE39F0-A152-471A-B90E-B8F4E94AA6C2}
{5DE9FB8F-A7C2-4038-A4A8-1622CDB6821A} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
{F48B7D50-16CB-4BEF-A614-2DED9960AF09} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
{C91489AB-FF14-4FAD-BA51-35371ADD7E1C} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
{BB5DF535-E849-42AC-852A-A6D4815347C0} = {3653266D-2C88-4487-8977-839CB3E78A0A}
{5241BCF2-331D-428E-A9C4-F8DF92C8F726} = {A4DF60EB-3AA5-48F0-B4D2-3F94B8E62F03}
{C91489AB-FF14-4FAD-BA51-35371ADD7E1C} = {3653266D-2C88-4487-8977-839CB3E78A0A}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the folder structure of the sln got messed up at some point. This just puts things back in the order we expect

{BB5DF535-E849-42AC-852A-A6D4815347C0} = {A4DF60EB-3AA5-48F0-B4D2-3F94B8E62F03}
{5241BCF2-331D-428E-A9C4-F8DF92C8F726} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
{3ECC7570-3501-479D-9CD9-64799C2AD149} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
{BADAC0CC-F3E6-440E-B322-DA2B97625F26} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
{8EE9F34E-EAA1-4F03-B388-8076CE44DD7B} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentFormat.OpenXml.Framework/Framework/Metadata/ElementFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

namespace DocumentFormat.OpenXml.Framework.Metadata
{
[DebuggerDisplay("{Namespace}:{Name}")]
[DebuggerDisplay("{QName,nq}")]
internal sealed class ElementFactory
{
private readonly Func<OpenXmlElement> _factory;
Expand Down
8 changes: 4 additions & 4 deletions src/DocumentFormat.OpenXml.Framework/OpenXmlPartRootElement.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,10 @@ internal void SaveToPart(OpenXmlPart openXmlPart)
throw new ArgumentNullException(nameof(openXmlPart));
}

using (Stream partStream = openXmlPart.GetStream(FileMode.Create))
{
Save(partStream);
}
// If we're saving the existing root to the the part, we don't need to unload the root as they're already equal
using var partStream = openXmlPart.GetStream(FileMode.Create, unloadRootOnChange: !ReferenceEquals(this, openXmlPart.PartRootElement));

Save(partStream);
}

/// <summary>
Expand Down
27 changes: 17 additions & 10 deletions src/DocumentFormat.OpenXml.Framework/Packaging/OpenXmlPart.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,9 +236,10 @@ public IEnumerable<OpenXmlPart> GetParentParts()
/// <param name="mode">The I/O mode to be used to open the content stream.</param>
/// <returns>The content stream of the part. </returns>
public Stream GetStream(FileMode mode)
{
return GetStream(mode, Features.GetRequired<IPackageFeature>().Package.FileOpenAccess);
}
=> GetStream(mode, unloadRootOnChange: true);

internal Stream GetStream(FileMode mode, bool unloadRootOnChange)
=> GetStream(mode, Features.GetRequired<IPackageFeature>().Package.FileOpenAccess, unloadRootOnChange);

/// <summary>
/// Returns the part content stream that was opened using a specified FileMode and FileAccess.
Expand All @@ -247,20 +248,26 @@ public Stream GetStream(FileMode mode)
/// <param name="access">The access permissions to be used to open the content stream.</param>
/// <returns>The content stream of the part. </returns>
public Stream GetStream(FileMode mode, FileAccess access)
=> GetStream(mode, access, true);

internal Stream GetStream(FileMode mode, FileAccess access, bool unloadRootOnChange)
{
ThrowIfObjectDisposed();

var stream = PackagePart.GetStream(mode, access);

if (mode is FileMode.Create || stream.Length == 0)
if (unloadRootOnChange)
{
UnloadRootElement();
return new UnloadingRootElementStream(this, stream);
}
if (mode is FileMode.Create || stream.Length == 0)
{
UnloadRootElement();
return new UnloadingRootElementStream(this, stream);
}

if (stream.CanWrite)
{
return new UnloadingRootElementStream(this, stream);
if (stream.CanWrite)
{
return new UnloadingRootElementStream(this, stream);
}
}

return stream;
Expand Down
21 changes: 21 additions & 0 deletions test/DocumentFormat.OpenXml.Tests/ofapiTest/OpenXmlPartTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,5 +321,26 @@ public void UnloadRootElementTest()
}
}
}

[Fact]
public void SavingPartDoesNotUnloadRoot()
{
// Arrange
using Stream stream = new MemoryStream();
using var testDocument = WordprocessingDocument.Create(stream, WordprocessingDocumentType.Document);

var mainPart = testDocument.AddMainDocumentPart();
mainPart.Document = new Document();
mainPart.Document.AppendChild(new Body());

var rootElement = mainPart.RootElement;
Assert.NotNull(rootElement);

// Act
mainPart.RootElement.Save();

// Assert
Assert.Same(rootElement, mainPart.RootElement);
}
}
}
Loading