You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@pdfbox.apache.org by David Hill <DH...@StudentLoan.org> on 2016/07/29 13:09:30 UTC
upgrading to 2.x - package private class PDFieldFactory?
I am upgrading a project from 1.8.6 to the 2.0.2 version of PDFBox and everything went reasonably well except that we made use of PDFieldFactory
PDField destField = PDFieldFactory.createField
Everything in PDFieldFactory used to be public but now it is all package private.
I tried to copy the code for that method into our project and found that all of the various PDField objects being created were also package private.
It looks like the code we have came from overriding and copying PDFMergerUtility.appendDocument to fix an apparent bug. PDFMergerUtility.appendDocument makes a call to PDFieldFactory.createField.
I could continue to force my way around this issue but I have to wonder if this was intentional.
Dave
________________________________
This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
RE: {External} Re: upgrading to 2.x - package private class
PDFieldFactory?
Posted by David Hill <DH...@StudentLoan.org>.
Maruan,
I have tested the tags and it is a bug. I will try to correct the problem in the latest version and publish an in-house binary to our maven repository. If I am successful I will supply a patch back to the mailing group.
Dave
________________________________________
From: Maruan Sahyoun [sahyoun@fileaffairs.de]
Sent: Wednesday, August 03, 2016 2:27 PM
To: users@pdfbox.apache.org
Subject: Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Hi David,
> Am 03.08.2016 um 18:09 schrieb David Hill <DH...@StudentLoan.org>:
>
> Maruan,
>
> were you able to test merging a PDF with no tags with one with tags?
>
I didn't test that as I was under the impression that you will do it. I only wanted to make sure that there is no issue around AcroForms as you mentioned you had to change the code but with the current version there are no failing tests.
BR
Maruan
> Dave
>
> ________________________________________
> From: Maruan Sahyoun [sahyoun@fileaffairs.de]
> Sent: Tuesday, August 02, 2016 2:18 PM
> To: users@pdfbox.apache.org
> Subject: Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
>
> Hi David,
>
>> Am 01.08.2016 um 16:14 schrieb David Hill <DH...@StudentLoan.org>:
>>
>>
>> Mauran, unfortunately I do not have that information, my only failing tests (so far) were tag related. It is possible the forms issue was fixed in 2.0.2 and that is why I don't have failing tests. I will try to get back to you once I have corrected the tag issue in the current code.
>
> I did a quick test merging a PDF with no AcroForm and one with an AcroForm and the result is fine. If during your tests you find a different behaviour please open an issue at JIRA https://issues.apache.org/jira/browse/PDFBOX. And of course patches are welcome.
>
> BR
> Maruan
>
>
>
>>
>>> Hi,
>>>
>>> from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
>>>
>>> BR
>>> Maruan
>>
>>
>> ________________________________
>>
>> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
>
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
________________________________
This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
Hi David,
> Am 03.08.2016 um 18:09 schrieb David Hill <DH...@StudentLoan.org>:
>
> Maruan,
>
> were you able to test merging a PDF with no tags with one with tags?
>
I didn't test that as I was under the impression that you will do it. I only wanted to make sure that there is no issue around AcroForms as you mentioned you had to change the code but with the current version there are no failing tests.
BR
Maruan
> Dave
>
> ________________________________________
> From: Maruan Sahyoun [sahyoun@fileaffairs.de]
> Sent: Tuesday, August 02, 2016 2:18 PM
> To: users@pdfbox.apache.org
> Subject: Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
>
> Hi David,
>
>> Am 01.08.2016 um 16:14 schrieb David Hill <DH...@StudentLoan.org>:
>>
>>
>> Mauran, unfortunately I do not have that information, my only failing tests (so far) were tag related. It is possible the forms issue was fixed in 2.0.2 and that is why I don't have failing tests. I will try to get back to you once I have corrected the tag issue in the current code.
>
> I did a quick test merging a PDF with no AcroForm and one with an AcroForm and the result is fine. If during your tests you find a different behaviour please open an issue at JIRA https://issues.apache.org/jira/browse/PDFBOX. And of course patches are welcome.
>
> BR
> Maruan
>
>
>
>>
>>> Hi,
>>>
>>> from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
>>>
>>> BR
>>> Maruan
>>
>>
>> ________________________________
>>
>> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
>
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
RE: {External} Re: upgrading to 2.x - package private class
PDFieldFactory?
Posted by David Hill <DH...@StudentLoan.org>.
Maruan,
were you able to test merging a PDF with no tags with one with tags?
Dave
________________________________________
From: Maruan Sahyoun [sahyoun@fileaffairs.de]
Sent: Tuesday, August 02, 2016 2:18 PM
To: users@pdfbox.apache.org
Subject: Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Hi David,
> Am 01.08.2016 um 16:14 schrieb David Hill <DH...@StudentLoan.org>:
>
>
> Mauran, unfortunately I do not have that information, my only failing tests (so far) were tag related. It is possible the forms issue was fixed in 2.0.2 and that is why I don't have failing tests. I will try to get back to you once I have corrected the tag issue in the current code.
I did a quick test merging a PDF with no AcroForm and one with an AcroForm and the result is fine. If during your tests you find a different behaviour please open an issue at JIRA https://issues.apache.org/jira/browse/PDFBOX. And of course patches are welcome.
BR
Maruan
>
>> Hi,
>>
>> from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
>>
>> BR
>> Maruan
>
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
________________________________
This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
Hi David,
> Am 01.08.2016 um 16:14 schrieb David Hill <DH...@StudentLoan.org>:
>
>
> Mauran, unfortunately I do not have that information, my only failing tests (so far) were tag related. It is possible the forms issue was fixed in 2.0.2 and that is why I don't have failing tests. I will try to get back to you once I have corrected the tag issue in the current code.
I did a quick test merging a PDF with no AcroForm and one with an AcroForm and the result is fine. If during your tests you find a different behaviour please open an issue at JIRA https://issues.apache.org/jira/browse/PDFBOX. And of course patches are welcome.
BR
Maruan
>
>> Hi,
>>
>> from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
>>
>> BR
>> Maruan
>
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
> Am 01.08.2016 um 16:14 schrieb David Hill <DH...@StudentLoan.org>:
>
>
> Mauran, unfortunately I do not have that information, my only failing tests (so far) were tag related. It is possible the forms issue was fixed in 2.0.2 and that is why I don't have failing tests. I will try to get back to you once I have corrected the tag issue in the current code.
>
I'll create a unit test for the forms merging based on your changes to see if it works fine.
BR
Maruan
>> Hi,
>>
>> from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
>>
>> BR
>> Maruan
>
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
RE: {External} Re: upgrading to 2.x - package private class
PDFieldFactory?
Posted by David Hill <DH...@StudentLoan.org>.
Mauran, unfortunately I do not have that information, my only failing tests (so far) were tag related. It is possible the forms issue was fixed in 2.0.2 and that is why I don't have failing tests. I will try to get back to you once I have corrected the tag issue in the current code.
>Hi,
>
>from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
>
>BR
>Maruan
________________________________
This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
Hi,
> Am 01.08.2016 um 15:54 schrieb David Hill <DH...@StudentLoan.org>:
>
> John,
>
> The bug does still exist, hence my continued need to override the class in question.
>
> "Subclassing huge swathes of internal code" gets the job done without waiting for a future release. Making it harder for users to work around issues might increase patch submission but doesn't sound like the best overall solution.
>
> The bug is that when merging two PDFs, if the first PDF doesn't have any tags and the second one does, tags are lost. Tags are a critical feature for 508 compliance.
>
from your description you have issues when merging tags. But you are also changing the code to merge AcroForms. So are you having issues with both parts?
BR
Maruan
> I don't have a patch, and I haven't fixed the latest version yet, but from version 1.8.6 your code from PDFMergerUtility.appendDocument line 327 that looks like this
>
> PDAcroForm destAcroForm = destCatalog.getAcroForm();
> PDAcroForm srcAcroForm = srcCatalog.getAcroForm();
> if (destAcroForm == null)
> {
> cloner.cloneForNewDocument(srcAcroForm);
> destCatalog.setAcroForm(srcAcroForm);
> }
>
> we changed to this
>
> PDAcroForm destAcroForm = destCatalog.getAcroForm();
> PDAcroForm srcAcroForm = srcCatalog.getAcroForm();
> if (srcAcroForm != null && destAcroForm == null)
> {
> destAcroForm = new PDAcroForm(destination);
> PDResources res = new PDResources();
> destAcroForm.setDefaultResources(res);
> destination.getDocumentCatalog().setAcroForm(destAcroForm);
>
> cloner.cloneForNewDocument(srcAcroForm);
> mergeAcroForm(cloner, destAcroForm, srcAcroForm);
> }
>
>
> and line 554 which was
>
> kDictLevel0.setItem(COSName.K, newKArray);
> kDictLevel0.setItem(COSName.P, destStructTree);
> kDictLevel0.setItem(COSName.S, new COSString(STRUCTURETYPE_DOCUMENT));
> destStructTree.setK(kDictLevel0);
>
> we apparently changed to
>
> //Kids of source document (insert)
> List<Object> addKids = srcStructTree.getKids();
> for (Object k : addKids) {
> ((PDStructureElement) k).setParent(destStructTree);
> destStructTree.appendKid((PDStructureElement) k);
> }
>
>
> I did not make the original changes and I have not yet attempted to correct version 2.0.2 but without these changes we have failing tests looking for tags and have verified the output files are missing tags.
>
> Thank you.
> Dave
>
> _____________________
>
> ___________________
> From: John Hewson [john@jahewson.com]
> Sent: Saturday, July 30, 2016 2:47 AM
> To: users@pdfbox.apache.org
> Subject: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
>
>> On 29 Jul 2016, at 06:09, David Hill <DH...@StudentLoan.org> wrote:
>>
>>
>> I am upgrading a project from 1.8.6 to the 2.0.2 version of PDFBox and everything went reasonably well except that we made use of PDFieldFactory
>>
>> PDField destField = PDFieldFactory.createField
>>
>> Everything in PDFieldFactory used to be public but now it is all package private.
>>
>> I tried to copy the code for that method into our project and found that all of the various PDField objects being created were also package private.
>>
>> It looks like the code we have came from overriding and copying PDFMergerUtility.appendDocument to fix an apparent bug. PDFMergerUtility.appendDocument makes a call to PDFieldFactory.createField.
>>
>> I could continue to force my way around this issue but I have to wonder if this was intentional.
>
> Yep. Subclassing huge swathes of internal code isn't a great solution to fixing a bug in an open source project. We'd happily take a patch for the bug if it still exists.
>
> -- John
>
>>
>> Dave
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
Posted by John Hewson <jo...@jahewson.com>.
> On 1 Aug 2016, at 06:54, David Hill <DH...@StudentLoan.org> wrote:
>
> John,
>
> The bug does still exist, hence my continued need to override the class in question.
>
> "Subclassing huge swathes of internal code" gets the job done without waiting for a future release. Making it harder for users to work around issues might increase patch submission but doesn't sound like the best overall solution.
Subclassing is an extensibility mechanism, not a bug fixing mechanism. Just fetch the PDFBox source and make your fix:
1) svn checkout http://svn.apache.org/repos/asf/pdfbox/trunk/
cd trunk
2) [fix bug]
mvn clean install
3) set <systemPath> in your project’s pom.xml to point to the new .jar files
you can use this private build of PDFBox in production too if you really like
4) make an SVN patch and attach it to a JIRA ticket so that we can let everyone else have this fix
> The bug is that when merging two PDFs, if the first PDF doesn't have any tags and the second one does, tags are lost. Tags are a critical feature for 508 compliance.
>
> I don't have a patch, and I haven't fixed the latest version yet, but from version 1.8.6 your code from PDFMergerUtility.appendDocument line 327 that looks like this
>
> PDAcroForm destAcroForm = destCatalog.getAcroForm();
> PDAcroForm srcAcroForm = srcCatalog.getAcroForm();
> if (destAcroForm == null)
> {
> cloner.cloneForNewDocument(srcAcroForm);
> destCatalog.setAcroForm(srcAcroForm);
> }
>
> we changed to this
>
> PDAcroForm destAcroForm = destCatalog.getAcroForm();
> PDAcroForm srcAcroForm = srcCatalog.getAcroForm();
> if (srcAcroForm != null && destAcroForm == null)
> {
> destAcroForm = new PDAcroForm(destination);
> PDResources res = new PDResources();
> destAcroForm.setDefaultResources(res);
> destination.getDocumentCatalog().setAcroForm(destAcroForm);
>
> cloner.cloneForNewDocument(srcAcroForm);
> mergeAcroForm(cloner, destAcroForm, srcAcroForm);
> }
>
>
> and line 554 which was
>
> kDictLevel0.setItem(COSName.K, newKArray);
> kDictLevel0.setItem(COSName.P, destStructTree);
> kDictLevel0.setItem(COSName.S, new COSString(STRUCTURETYPE_DOCUMENT));
> destStructTree.setK(kDictLevel0);
>
> we apparently changed to
>
> //Kids of source document (insert)
> List<Object> addKids = srcStructTree.getKids();
> for (Object k : addKids) {
> ((PDStructureElement) k).setParent(destStructTree);
> destStructTree.appendKid((PDStructureElement) k);
> }
>
>
> I did not make the original changes and I have not yet attempted to correct version 2.0.2 but without these changes we have failing tests looking for tags and have verified the output files are missing tags.
Yep, that’s a bug. Lets open a JIRA issue for this and move the conversation there.
> Thank you.
> Dave
>
> _____________________
>
> ___________________
> From: John Hewson [john@jahewson.com]
> Sent: Saturday, July 30, 2016 2:47 AM
> To: users@pdfbox.apache.org
> Subject: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
>
>> On 29 Jul 2016, at 06:09, David Hill <DH...@StudentLoan.org> wrote:
>>
>>
>> I am upgrading a project from 1.8.6 to the 2.0.2 version of PDFBox and everything went reasonably well except that we made use of PDFieldFactory
>>
>> PDField destField = PDFieldFactory.createField
>>
>> Everything in PDFieldFactory used to be public but now it is all package private.
>>
>> I tried to copy the code for that method into our project and found that all of the various PDField objects being created were also package private.
>>
>> It looks like the code we have came from overriding and copying PDFMergerUtility.appendDocument to fix an apparent bug. PDFMergerUtility.appendDocument makes a call to PDFieldFactory.createField.
>>
>> I could continue to force my way around this issue but I have to wonder if this was intentional.
>
> Yep. Subclassing huge swathes of internal code isn't a great solution to fixing a bug in an open source project. We'd happily take a patch for the bug if it still exists.
>
> -- John
>
>>
>> Dave
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
RE: {External} Re: upgrading to 2.x - package private class
PDFieldFactory?
Posted by David Hill <DH...@StudentLoan.org>.
John,
The bug does still exist, hence my continued need to override the class in question.
"Subclassing huge swathes of internal code" gets the job done without waiting for a future release. Making it harder for users to work around issues might increase patch submission but doesn't sound like the best overall solution.
The bug is that when merging two PDFs, if the first PDF doesn't have any tags and the second one does, tags are lost. Tags are a critical feature for 508 compliance.
I don't have a patch, and I haven't fixed the latest version yet, but from version 1.8.6 your code from PDFMergerUtility.appendDocument line 327 that looks like this
PDAcroForm destAcroForm = destCatalog.getAcroForm();
PDAcroForm srcAcroForm = srcCatalog.getAcroForm();
if (destAcroForm == null)
{
cloner.cloneForNewDocument(srcAcroForm);
destCatalog.setAcroForm(srcAcroForm);
}
we changed to this
PDAcroForm destAcroForm = destCatalog.getAcroForm();
PDAcroForm srcAcroForm = srcCatalog.getAcroForm();
if (srcAcroForm != null && destAcroForm == null)
{
destAcroForm = new PDAcroForm(destination);
PDResources res = new PDResources();
destAcroForm.setDefaultResources(res);
destination.getDocumentCatalog().setAcroForm(destAcroForm);
cloner.cloneForNewDocument(srcAcroForm);
mergeAcroForm(cloner, destAcroForm, srcAcroForm);
}
and line 554 which was
kDictLevel0.setItem(COSName.K, newKArray);
kDictLevel0.setItem(COSName.P, destStructTree);
kDictLevel0.setItem(COSName.S, new COSString(STRUCTURETYPE_DOCUMENT));
destStructTree.setK(kDictLevel0);
we apparently changed to
//Kids of source document (insert)
List<Object> addKids = srcStructTree.getKids();
for (Object k : addKids) {
((PDStructureElement) k).setParent(destStructTree);
destStructTree.appendKid((PDStructureElement) k);
}
I did not make the original changes and I have not yet attempted to correct version 2.0.2 but without these changes we have failing tests looking for tags and have verified the output files are missing tags.
Thank you.
Dave
_____________________
___________________
From: John Hewson [john@jahewson.com]
Sent: Saturday, July 30, 2016 2:47 AM
To: users@pdfbox.apache.org
Subject: {External} Re: upgrading to 2.x - package private class PDFieldFactory?
> On 29 Jul 2016, at 06:09, David Hill <DH...@StudentLoan.org> wrote:
>
>
> I am upgrading a project from 1.8.6 to the 2.0.2 version of PDFBox and everything went reasonably well except that we made use of PDFieldFactory
>
> PDField destField = PDFieldFactory.createField
>
> Everything in PDFieldFactory used to be public but now it is all package private.
>
> I tried to copy the code for that method into our project and found that all of the various PDField objects being created were also package private.
>
> It looks like the code we have came from overriding and copying PDFMergerUtility.appendDocument to fix an apparent bug. PDFMergerUtility.appendDocument makes a call to PDFieldFactory.createField.
>
> I could continue to force my way around this issue but I have to wonder if this was intentional.
Yep. Subclassing huge swathes of internal code isn't a great solution to fixing a bug in an open source project. We'd happily take a patch for the bug if it still exists.
-- John
>
> Dave
________________________________
This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: upgrading to 2.x - package private class PDFieldFactory?
Posted by John Hewson <jo...@jahewson.com>.
> On 29 Jul 2016, at 06:09, David Hill <DH...@StudentLoan.org> wrote:
>
>
> I am upgrading a project from 1.8.6 to the 2.0.2 version of PDFBox and everything went reasonably well except that we made use of PDFieldFactory
>
> PDField destField = PDFieldFactory.createField
>
> Everything in PDFieldFactory used to be public but now it is all package private.
>
> I tried to copy the code for that method into our project and found that all of the various PDField objects being created were also package private.
>
> It looks like the code we have came from overriding and copying PDFMergerUtility.appendDocument to fix an apparent bug. PDFMergerUtility.appendDocument makes a call to PDFieldFactory.createField.
>
> I could continue to force my way around this issue but I have to wonder if this was intentional.
Yep. Subclassing huge swathes of internal code isn't a great solution to fixing a bug in an open source project. We'd happily take a patch for the bug if it still exists.
-- John
>
> Dave
>
>
> ________________________________
>
> This e-mail and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this e-mail in error please notify the originator of the message. This footer also confirms that this e-mail message has been scanned for the presence of computer viruses. Any views expressed in this message are those of the individual sender, except where the sender specifies and with authority, states them to be the views of Iowa Student Loan.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org