Skip to content

Commit

Permalink
#156: Throw Exception if PdfWriter.close() is called directly
Browse files Browse the repository at this point in the history 
- Codacy Issues
  • Loading branch information
@asturio
asturio committed Feb 23, 2024
1 parent 102cb6c commit a530578
Showing 1 changed file with 128 additions and 136 deletions.
264 changes: 128 additions & 136 deletions openpdf/src/main/java/com/lowagie/text/pdf/PdfWriter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,138 +130,8 @@ public class PdfWriter extends DocWriter implements
* @see PdfObject
* @see PdfIndirectObject
*/

public static class PdfBody {

// inner classes

/**
* <CODE>PdfCrossReference</CODE> is an entry in the PDF Cross-Reference table.
*/

public static class PdfCrossReference implements Comparable<PdfCrossReference> {

/**
* String template for cross-reference entry PDF representation.
*
* @see Formatter
*/
private static final String CROSS_REFERENCE_ENTRY_FORMAT = "%010d %05d %c \n";

// membervariables
private final int type;

/**
* Byte offset in the PDF file.
*/
private final long offset;

private final int refnum;
/**
* generation of the object.
*/
private final int generation;

// constructors

/**
* Constructs a cross-reference element for a PdfIndirectObject.
*
* @param refnum the reference number
* @param offset byte offset of the object
* @param generation generation number of the object
*/

public PdfCrossReference(int refnum, long offset, int generation) {
type = 0;
this.offset = offset;
this.refnum = refnum;
this.generation = generation;
}

/**
* Constructs a cross-reference element for a PdfIndirectObject.
*
* @param refnum the reference number
* @param offset byte offset of the object
*/

public PdfCrossReference(int refnum, long offset) {
type = 1;
this.offset = offset;
this.refnum = refnum;
this.generation = 0;
}

public PdfCrossReference(int type, int refnum, long offset, int generation) {
this.type = type;
this.offset = offset;
this.refnum = refnum;
this.generation = generation;
}

int getRefnum() {
return refnum;
}

/**
* Writes PDF representation of cross-reference entry to passed output stream.
*
* @param os Output stream this entry to write to
* @throws IOException If any I/O error occurs
*/
public void toPdf(OutputStream os) throws IOException {
// TODO: are generation number and 'In use' keyword bound that way?
final char inUse = generation == GENERATION_MAX ? 'f' : 'n';
os.write(getISOBytes(String.format(CROSS_REFERENCE_ENTRY_FORMAT, offset, generation, inUse)));
}

/**
* Writes PDF syntax to the OutputStream
*
* @param midSize the mid size
* @param os the OutputStream
* @throws IOException on error
*/
public void toPdf(int midSize, OutputStream os) throws IOException {
os.write((byte) type);
while (--midSize >= 0) {
os.write((byte) ((offset >>> (8 * midSize)) & 0xff));
}
os.write((byte) ((generation >>> 8) & 0xff));
os.write((byte) (generation & 0xff));
}

/**
* Compares current {@link PdfCrossReference entry} with passed {@code reference} by PDF object number.
*/
@Override
public int compareTo(final PdfCrossReference reference) {
return Integer.compare(refnum, reference.refnum);
}

/**
* Checks if two entries are equal if their PDF object numbers are equal.
*
* @param obj Another cross-reference entry
* @return If null, not of type {@link PdfCrossReference} or object numbers are not equal, returns false;
* true otherwise
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof PdfCrossReference other)) {
return false;
}

return refnum == other.refnum;
}

@Override
public int hashCode() {
return refnum;
}
}

private static final int OBJSINSTREAM = 200;

// membervariables
Expand Down Expand Up @@ -351,7 +221,6 @@ private void flushObjStm() throws IOException {
* @return a <CODE>PdfIndirectObject</CODE>
* @throws IOException
*/

PdfIndirectObject add(PdfObject object) throws IOException {
return add(object, getIndirectReferenceNumber());
}
Expand All @@ -365,7 +234,6 @@ PdfIndirectObject add(PdfObject object, boolean inObjStm) throws IOException {
*
* @return a PdfIndirectReference
*/

PdfIndirectReference getPdfIndirectReference() {
return new PdfIndirectReference(0, getIndirectReferenceNumber());
}
Expand All @@ -389,7 +257,6 @@ int getIndirectReferenceNumber() {
* @return a <CODE>PdfIndirectObject</CODE>
* @throws IOException
*/

PdfIndirectObject add(PdfObject object, PdfIndirectReference ref) throws IOException {
return add(object, ref.getNumber());
}
Expand Down Expand Up @@ -429,7 +296,6 @@ PdfIndirectObject add(PdfObject object, int refNumber, boolean inObjStm) throws
*
* @return an offset
*/

long offset() {
return position;
}
Expand All @@ -439,7 +305,6 @@ long offset() {
*
* @return a number of objects
*/

int size() {
return Math.max((xrefs.last()).getRefnum() + 1, refnum);
}
Expand Down Expand Up @@ -526,6 +391,133 @@ void writeCrossReferenceTable(OutputStream os, PdfIndirectReference root, PdfInd
trailer.toPdf(writer, os);
}
}

// inner classes

/**
* <CODE>PdfCrossReference</CODE> is an entry in the PDF Cross-Reference table.
*/
public static class PdfCrossReference implements Comparable<PdfCrossReference> {

/**
* String template for cross-reference entry PDF representation.
*
* @see Formatter
*/
private static final String CROSS_REFERENCE_ENTRY_FORMAT = "%010d %05d %c \n";

// membervariables
private final int type;

/**
* Byte offset in the PDF file.
*/
private final long offset;

private final int refnum;
/**
* generation of the object.
*/
private final int generation;

// constructors

/**
* Constructs a cross-reference element for a PdfIndirectObject.
*
* @param refnum the reference number
* @param offset byte offset of the object
* @param generation generation number of the object
*/
public PdfCrossReference(int refnum, long offset, int generation) {
type = 0;
this.offset = offset;
this.refnum = refnum;
this.generation = generation;
}

/**
* Constructs a cross-reference element for a PdfIndirectObject.
*
* @param refnum the reference number
* @param offset byte offset of the object
*/
public PdfCrossReference(int refnum, long offset) {
type = 1;
this.offset = offset;
this.refnum = refnum;
this.generation = 0;
}

public PdfCrossReference(int type, int refnum, long offset, int generation) {
this.type = type;
this.offset = offset;
this.refnum = refnum;
this.generation = generation;
}

int getRefnum() {
return refnum;
}

/**
* Writes PDF representation of cross-reference entry to passed output stream.
*
* @param os Output stream this entry to write to
* @throws IOException If any I/O error occurs
*/
public void toPdf(OutputStream os) throws IOException {
// TODO: are generation number and 'In use' keyword bound that way?
final char inUse = generation == GENERATION_MAX ? 'f' : 'n';
os.write(getISOBytes(String.format(CROSS_REFERENCE_ENTRY_FORMAT, offset, generation, inUse)));
}

/**
* Writes PDF syntax to the OutputStream
*
* @param midSize the mid size
* @param os the OutputStream
* @throws IOException on error
*/
public void toPdf(int midSize, OutputStream os) throws IOException {
os.write((byte) type);
int thisMidSize = midSize;
while (--thisMidSize >= 0) {
os.write((byte) ((offset >>> (8 * thisMidSize)) & 0xff));
}
os.write((byte) ((generation >>> 8) & 0xff));
os.write((byte) (generation & 0xff));
}

/**
* Compares current {@link PdfCrossReference entry} with passed {@code reference} by PDF object number.
*/
@Override
public int compareTo(final PdfCrossReference reference) {
return Integer.compare(refnum, reference.refnum);
}

/**
* Checks if two entries are equal if their PDF object numbers are equal.
*
* @param obj Another cross-reference entry
* @return If null, not of type {@link PdfCrossReference} or object numbers are not equal, returns false;
* true otherwise
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof PdfCrossReference other)) {
return false;
}

return refnum == other.refnum;
}

@Override
public int hashCode() {
return refnum;
}
}
}

/**
Expand Down Expand Up @@ -1194,7 +1186,7 @@ public void open() {
* <p>
* The pages-tree is built and written to the outputstream. A Catalog is constructed, as well as an Info-object, the
* reference table is composed and everything is written to the outputstream embedded in a Trailer.
*gg
*
* @see com.lowagie.text.DocWriter#close()
*/
@Override
Expand Down

0 comments on commit a530578

Please sign in to comment.