You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2025/04/20 15:42:06 UTC
svn commit: r1925175 - in /pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox: pdmodel/DefaultResourceCache.java pdmodel/PDPage.java pdmodel/ResourceCache.java text/PDFTextStripper.java
Author: lehmi
Date: Sun Apr 20 15:42:05 2025
New Revision: 1925175
URL: http://svn.apache.org/viewvc?rev=1925175&view=rev
Log:
PDFBOX-5943: extend ResourceCache to support the removal of cached objects
Modified:
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/DefaultResourceCache.java
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java
Modified: pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/DefaultResourceCache.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/DefaultResourceCache.java?rev=1925175&r1=1925174&r2=1925175&view=diff
==============================================================================
--- pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/DefaultResourceCache.java (original)
+++ pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/DefaultResourceCache.java Sun Apr 20 15:42:05 2025
@@ -19,7 +19,10 @@ package org.apache.pdfbox.pdmodel;
import java.lang.ref.SoftReference;
import java.util.HashMap;
+import java.util.HashSet;
import java.util.Map;
+import java.util.Set;
+
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList;
import org.apache.pdfbox.pdmodel.font.PDFont;
@@ -30,33 +33,76 @@ import org.apache.pdfbox.pdmodel.graphic
import org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState;
/**
- * A resource cached based on SoftReference, retains resources until memory pressure causes them
- * to be garbage collected.
+ * A resource cached based on SoftReference, retains resources until memory pressure causes them to be garbage
+ * collected.
*
+ * Cached resources may be removed pro actively.
+ *
+ * Resources which are removed and added several times, can't be removed after hitting the threshold of
+ * {@value #maxRemovals}. This may happen if resources are shared among several pages. This kind of stable caching is
+ * enabled by default and can be deactivated.
+ *
* @author John Hewson
*/
public class DefaultResourceCache implements ResourceCache
{
+ private static final int maxRemovals = 3;
+
+ private final boolean stableCacheEnabled;
+
private final Map<COSObject, SoftReference<PDFont>> fonts =
new HashMap<>();
+ private final Map<Long, Integer> removedFonts = new HashMap<>();
+ private final Set<Long> stableFonts = new HashSet<>();
private final Map<COSObject, SoftReference<PDColorSpace>> colorSpaces =
new HashMap<>();
+ private final Map<Long, Integer> removedColorSpaces = new HashMap<>();
+ private final Set<Long> stableColorSpaces = new HashSet<>();
private final Map<COSObject, SoftReference<PDXObject>> xobjects =
new HashMap<>();
+ private final Map<Long, Integer> removedXObjects = new HashMap<>();
+ private final Set<Long> stableXObject = new HashSet<>();
private final Map<COSObject, SoftReference<PDExtendedGraphicsState>> extGStates =
new HashMap<>();
+ private final Map<Long, Integer> removedExtGStates = new HashMap<>();
+ private final Set<Long> stableExtGStates = new HashSet<>();
private final Map<COSObject, SoftReference<PDShading>> shadings =
new HashMap<>();
+ private final Map<Long, Integer> removedShadings = new HashMap<>();
+ private final Set<Long> stableShadings = new HashSet<>();
private final Map<COSObject, SoftReference<PDAbstractPattern>> patterns =
new HashMap<>();
+ private final Map<Long, Integer> removedPatterns = new HashMap<>();
+ private final Set<Long> stablePatterns = new HashSet<>();
private final Map<COSObject, SoftReference<PDPropertyList>> properties =
new HashMap<>();
+ private final Map<Long, Integer> removedProperties = new HashMap<>();
+ private final Set<Long> stableProperties = new HashSet<>();
+
+ /**
+ * Default constructor.
+ */
+ public DefaultResourceCache()
+ {
+ this(true);
+ }
+
+ /**
+ * Constructor providing a parameter to enable/disable the stable object cache.
+ *
+ * @param enableStableCache enables/disables the stable object cache
+ *
+ */
+ public DefaultResourceCache(boolean enableStableCache)
+ {
+ stableCacheEnabled = enableStableCache;
+ }
@Override
public PDFont getFont(COSObject indirect)
@@ -76,6 +122,33 @@ public class DefaultResourceCache implem
}
@Override
+ public PDFont removeFont(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+ if (stableFonts.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedFonts.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedFonts.put(objectKey, ++counter);
+ }
+ else
+ {
+ stableFonts.add(objectKey);
+ removedFonts.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDFont> font = fonts.remove(indirect);
+ return font != null ? font.get() : null;
+ }
+
+ @Override
public PDColorSpace getColorSpace(COSObject indirect)
{
SoftReference<PDColorSpace> colorSpace = colorSpaces.get(indirect);
@@ -93,6 +166,33 @@ public class DefaultResourceCache implem
}
@Override
+ public PDColorSpace removeColorSpace(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+ if (stableColorSpaces.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedColorSpaces.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedColorSpaces.put(objectKey, ++counter);
+ }
+ else
+ {
+ stableColorSpaces.add(objectKey);
+ removedColorSpaces.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDColorSpace> colorSpace = colorSpaces.remove(indirect);
+ return colorSpace != null ? colorSpace.get() : null;
+ }
+
+ @Override
public PDExtendedGraphicsState getExtGState(COSObject indirect)
{
SoftReference<PDExtendedGraphicsState> extGState = extGStates.get(indirect);
@@ -110,6 +210,33 @@ public class DefaultResourceCache implem
}
@Override
+ public PDExtendedGraphicsState removeExtState(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+ if (stableExtGStates.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedExtGStates.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedExtGStates.put(objectKey, ++counter);
+ }
+ else
+ {
+ stableExtGStates.add(objectKey);
+ removedExtGStates.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDExtendedGraphicsState> extGState = extGStates.remove(indirect);
+ return extGState != null ? extGState.get() : null;
+ }
+
+ @Override
public PDShading getShading(COSObject indirect)
{
SoftReference<PDShading> shading = shadings.get(indirect);
@@ -127,6 +254,33 @@ public class DefaultResourceCache implem
}
@Override
+ public PDShading removeShading(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+ if (stableShadings.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedShadings.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedShadings.put(objectKey, ++counter);
+ }
+ else
+ {
+ stableShadings.add(objectKey);
+ removedShadings.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDShading> shading = shadings.remove(indirect);
+ return shading != null ? shading.get() : null;
+ }
+
+ @Override
public PDAbstractPattern getPattern(COSObject indirect)
{
SoftReference<PDAbstractPattern> pattern = patterns.get(indirect);
@@ -144,6 +298,33 @@ public class DefaultResourceCache implem
}
@Override
+ public PDAbstractPattern removePattern(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+ if (stablePatterns.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedPatterns.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedPatterns.put(objectKey, ++counter);
+ }
+ else
+ {
+ stablePatterns.add(objectKey);
+ removedPatterns.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDAbstractPattern> pattern = patterns.remove(indirect);
+ return pattern != null ? pattern.get() : null;
+ }
+
+ @Override
public PDPropertyList getProperties(COSObject indirect)
{
SoftReference<PDPropertyList> propertyList = properties.get(indirect);
@@ -161,6 +342,33 @@ public class DefaultResourceCache implem
}
@Override
+ public PDPropertyList removeProperties(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+ if (stableProperties.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedProperties.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedProperties.put(objectKey, ++counter);
+ }
+ else
+ {
+ stableProperties.add(objectKey);
+ removedProperties.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDPropertyList> propertyList = properties.remove(indirect);
+ return propertyList != null ? propertyList.get() : null;
+ }
+
+ @Override
public PDXObject getXObject(COSObject indirect)
{
SoftReference<PDXObject> xobject = xobjects.get(indirect);
@@ -176,4 +384,33 @@ public class DefaultResourceCache implem
{
xobjects.put(indirect, new SoftReference<>(xobject));
}
+
+ @Override
+ public PDXObject removeXObject(COSObject indirect)
+ {
+ Long objectKey = stableCacheEnabled && indirect.getKey() != null
+ ? indirect.getKey().getInternalHash() : null;
+ if (objectKey != null)
+ {
+
+ if (stableXObject.contains(objectKey))
+ {
+ return null;
+ }
+ Integer counter = removedXObjects.computeIfAbsent(objectKey, v -> 1);
+ if (counter < maxRemovals)
+ {
+ removedXObjects.put(objectKey, ++counter);
+ }
+ else
+ {
+ stableXObject.add(objectKey);
+ removedXObjects.remove(objectKey);
+ return null;
+ }
+ }
+ SoftReference<PDXObject> xobject = xobjects.remove(indirect);
+ return xobject != null ? xobject.get() : null;
+ }
+
}
Modified: pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java?rev=1925175&r1=1925174&r2=1925175&view=diff
==============================================================================
--- pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java (original)
+++ pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java Sun Apr 20 15:42:05 2025
@@ -20,6 +20,7 @@ import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
+import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.stream.Collectors;
@@ -46,6 +47,8 @@ import org.apache.pdfbox.pdmodel.common.
import org.apache.pdfbox.pdmodel.common.PDMetadata;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.common.PDStream;
+import org.apache.pdfbox.pdmodel.graphics.PDXObject;
+import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
import org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions;
import org.apache.pdfbox.pdmodel.interactive.annotation.AnnotationFilter;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
@@ -115,6 +118,64 @@ public class PDPage implements COSObject
}
/**
+ * Remove all page resources from the cache to avoid relying on the implementation of the Cache. Does make sense
+ * after processing a page.
+ */
+ public void removePageResourceFromCache()
+ {
+ if (resourceCache == null)
+ {
+ return;
+ }
+ // limit purge operation to page resources, don't remove inherited resources
+ removeResources(page.getCOSDictionary(COSName.RESOURCES));
+ }
+
+ private void removeResources(COSDictionary resources)
+ {
+ if (resources == null)
+ {
+ return;
+ }
+ getIndirectResourceObjects(resources, COSName.COLORSPACE)
+ .forEach(resourceCache::removeColorSpace);
+ getIndirectResourceObjects(resources, COSName.EXT_G_STATE)
+ .forEach(resourceCache::removeExtState);
+ getIndirectResourceObjects(resources, COSName.FONT)
+ .forEach(resourceCache::removeFont);
+ getIndirectResourceObjects(resources, COSName.PATTERN)
+ .forEach(resourceCache::removePattern);
+ getIndirectResourceObjects(resources, COSName.PROPERTIES)
+ .forEach(resourceCache::removeProperties);
+ getIndirectResourceObjects(resources, COSName.SHADING)
+ .forEach(resourceCache::removeShading);
+ for (COSObject cosObject : getIndirectResourceObjects(resources, COSName.XOBJECT))
+ {
+ PDXObject removedXObject = resourceCache.removeXObject(cosObject);
+ // clean up the resources of the XFormObject
+ if (removedXObject instanceof PDFormXObject)
+ {
+ COSStream cosStream = removedXObject.getCOSObject();
+ removeResources(cosStream.getCOSDictionary(COSName.RESOURCES));
+ }
+ }
+ }
+
+ private List<COSObject> getIndirectResourceObjects(COSDictionary pageResources, COSName kind)
+ {
+ COSDictionary resourcesDictionary = pageResources.getCOSDictionary(kind);
+ if (resourcesDictionary == null)
+ {
+ return Collections.emptyList();
+ }
+ return resourcesDictionary.getValues().stream() //
+ .filter(COSObject.class::isInstance) //
+ .map(COSObject.class::cast) //
+ .filter(COSObject::isDereferenced) //
+ .collect(Collectors.toList());
+ }
+
+ /**
* Convert this standard java object to a COS object.
*
* @return The cos object that matches this Java object.
Modified: pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java?rev=1925175&r1=1925174&r2=1925175&view=diff
==============================================================================
--- pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java (original)
+++ pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/ResourceCache.java Sun Apr 20 15:42:05 2025
@@ -144,4 +144,89 @@ public interface ResourceCache
* @param xobject the XObject to be cached
*/
void put(COSObject indirect, PDXObject xobject);
+
+ /**
+ * Removes the given indirect color space resource from the cache.
+ *
+ * @param indirect the indirect reference of the color space to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDColorSpace removeColorSpace(COSObject indirect)
+ {
+ return null;
+ }
+
+ /**
+ * Removes the given indirect extended graphics state resource from the cache.
+ *
+ * @param indirect the indirect reference of the extended graphics state to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDExtendedGraphicsState removeExtState(COSObject indirect)
+ {
+ return null;
+ }
+
+ /**
+ * Removes the given indirect font resource from the cache.
+ *
+ * @param indirect the indirect reference of the font to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDFont removeFont(COSObject indirect)
+ {
+ return null;
+ }
+
+ /**
+ * Removes the given indirect shading resource from the cache.
+ *
+ * @param indirect the indirect reference of the shading to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDShading removeShading(COSObject indirect)
+ {
+ return null;
+ }
+
+ /**
+ * Removes the given indirect pattern resource from the cache.
+ *
+ * @param indirect the indirect reference of the pattern to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDAbstractPattern removePattern(COSObject indirect)
+ {
+ return null;
+ }
+
+ /**
+ * Removes the given indirect property list resource from the cache.
+ *
+ * @param indirect the indirect reference of the property list to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDPropertyList removeProperties(COSObject indirect)
+ {
+ return null;
+ }
+
+ /**
+ * Removes the given indirect XObject resource from the cache.
+ *
+ * @param indirect the indirect reference of the XObject to be removed
+ *
+ * @return the removed resource if present
+ */
+ default PDXObject removeXObject(COSObject indirect)
+ {
+ return null;
+ }
+
}
Modified: pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java?rev=1925175&r1=1925174&r2=1925175&view=diff
==============================================================================
--- pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java (original)
+++ pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripper.java Sun Apr 20 15:42:05 2025
@@ -379,6 +379,7 @@ public class PDFTextStripper extends Leg
super.processPage(page);
writePage();
endPage(page);
+ page.removePageResourceFromCache();
}
}