octoleo/qpdf
2
1
Fork 0
mirror of https://github.com/qpdf/qpdf.git synced 2024-12-22 19:08:59 +00:00
Code Issues Releases Wiki Activity
28c13f5492
qpdf/libqpdf/QPDFJob.cc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

3119 lines
117 KiB
C++
Raw Normal View History

QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
#include <qpdf/QPDFJob.hh>
#include <cstring>
#include <iostream>
#include <memory>
#include <qpdf/ClosedFileInputSource.hh>
#include <qpdf/FileInputSource.hh>
#include <qpdf/Pl_Count.hh>
#include <qpdf/Pl_DCT.hh>
#include <qpdf/Pl_Discard.hh>
#include <qpdf/Pl_Flate.hh>
#include <qpdf/Pl_StdioFile.hh>
Test json against schema only on demand Testing json against schema requires an in-memory copy, so do it only when requested by the test suite.
2022-05-06 21:49:28 +00:00
#include <qpdf/Pl_String.hh>
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
#include <qpdf/QIntC.hh>
#include <qpdf/QPDFAcroFormDocumentHelper.hh>
#include <qpdf/QPDFCryptoProvider.hh>
#include <qpdf/QPDFEmbeddedFileDocumentHelper.hh>
#include <qpdf/QPDFExc.hh>
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
#include <qpdf/QPDFLogger.hh>
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
#include <qpdf/QPDFOutlineDocumentHelper.hh>
#include <qpdf/QPDFPageDocumentHelper.hh>
#include <qpdf/QPDFPageLabelDocumentHelper.hh>
#include <qpdf/QPDFPageObjectHelper.hh>
#include <qpdf/QPDFSystemError.hh>
Use QPDFUsage exception for cli, json, and QPDFJob errors
2022-01-28 12:46:04 +00:00
#include <qpdf/QPDFUsage.hh>
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
#include <qpdf/QPDFWriter.hh>
Move QPDF inner class definitions to new QPDF_private.hh
2024-07-05 13:09:43 +00:00
#include <qpdf/QPDF_private.hh>
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
#include <qpdf/QTC.hh>
#include <qpdf/QUtil.hh>
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFJob: move placeholder json to a separate source file
2022-01-26 21:48:18 +00:00
#include <qpdf/auto_job_schema.hh> // JOB_SCHEMA_DATA
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
namespace
{
class ImageOptimizer: public QPDFObjectHandle::StreamDataProvider
{
public:
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
ImageOptimizer(
QPDFJob& o,
size_t oi_min_width,
size_t oi_min_height,
size_t oi_min_area,
QPDFObjectHandle& image);
Replace 'virtual' specifier with 'override'
2023-05-20 13:25:46 +00:00
~ImageOptimizer() override = default;
void provideStreamData(QPDFObjGen const&, Pipeline* pipeline) override;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::shared_ptr<Pipeline> makePipeline(std::string const& description, Pipeline* next);
bool evaluate(std::string const& description);
private:
QPDFJob& o;
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
size_t oi_min_width;
size_t oi_min_height;
size_t oi_min_area;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFObjectHandle image;
};
class DiscardContents: public QPDFObjectHandle::ParserCallbacks
{
public:
Replace 'virtual' specifier with 'override'
2023-05-20 13:25:46 +00:00
~DiscardContents() override = default;
void
handleObject(QPDFObjectHandle) override
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
}
Replace 'virtual' specifier with 'override'
2023-05-20 13:25:46 +00:00
void
handleEOF() override
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
}
};
struct QPDFPageData
{
QPDFJob: convert PageSpec to used shared pointer
2022-01-22 23:43:05 +00:00
QPDFPageData(std::string const& filename, QPDF* qpdf, std::string const& range);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageData(QPDFPageData const& other, int page);
std::string filename;
QPDF* qpdf;
std::vector<QPDFObjectHandle> orig_pages;
std::vector<int> selected_pages;
};
class ProgressReporter: public QPDFWriter::ProgressReporter
{
public:
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
ProgressReporter(Pipeline& p, std::string const& prefix, char const* filename) :
p(p),
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
prefix(prefix),
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
filename(filename)
{
}
Replace 'virtual' specifier with 'override'
2023-05-20 13:25:46 +00:00
~ProgressReporter() override = default;
void reportProgress(int) override;
Programmatically apply new formatting to code Run this: for i in **/*.cc **/*.c **/*.h **/*.hh; do clang-format < $i >| $i.new && mv $i.new $i done
2022-04-02 21:14:10 +00:00
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
private:
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
Pipeline& p;
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
std::string prefix;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::string filename;
};
} // namespace
Programmatically apply new formatting to code Run this: for i in **/*.cc **/*.c **/*.h **/*.hh; do clang-format < $i >| $i.new && mv $i.new $i done
2022-04-02 21:14:10 +00:00
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
ImageOptimizer::ImageOptimizer(
QPDFJob& o,
size_t oi_min_width,
size_t oi_min_height,
size_t oi_min_area,
QPDFObjectHandle& image) :
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
o(o),
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
oi_min_width(oi_min_width),
oi_min_height(oi_min_height),
oi_min_area(oi_min_area),
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
image(image)
{
}
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::shared_ptr<Pipeline>
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
ImageOptimizer::makePipeline(std::string const& description, Pipeline* next)
{
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::shared_ptr<Pipeline> result;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
QPDFObjectHandle dict = image.getDict();
QPDFObjectHandle w_obj = dict.getKey("/Width");
QPDFObjectHandle h_obj = dict.getKey("/Height");
QPDFObjectHandle colorspace_obj = dict.getKey("/ColorSpace");
if (!(w_obj.isNumber() && h_obj.isNumber())) {
if (!description.empty()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description
<< ": not optimizing because image dictionary is missing required keys\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
}
return result;
}
QPDFObjectHandle components_obj = dict.getKey("/BitsPerComponent");
if (!(components_obj.isInteger() && (components_obj.getIntValue() == 8))) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob image optimize bits per component");
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
if (!description.empty()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description
<< ": not optimizing because image has other than 8 bits per component\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
}
return result;
}
// Files have been seen in the wild whose width and height are floating point, which is goofy,
// but we can deal with it.
JDIMENSION w = 0;
if (w_obj.isInteger()) {
w = w_obj.getUIntValueAsUInt();
} else {
w = static_cast<JDIMENSION>(w_obj.getNumericValue());
}
JDIMENSION h = 0;
if (h_obj.isInteger()) {
h = h_obj.getUIntValueAsUInt();
} else {
h = static_cast<JDIMENSION>(h_obj.getNumericValue());
}
std::string colorspace = (colorspace_obj.isName() ? colorspace_obj.getName() : std::string());
int components = 0;
J_COLOR_SPACE cs = JCS_UNKNOWN;
if (colorspace == "/DeviceRGB") {
components = 3;
cs = JCS_RGB;
} else if (colorspace == "/DeviceGray") {
components = 1;
cs = JCS_GRAYSCALE;
} else if (colorspace == "/DeviceCMYK") {
components = 4;
cs = JCS_CMYK;
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob image optimize colorspace");
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
if (!description.empty()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description
<< ": not optimizing because qpdf can't optimize images with this colorspace\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
}
return result;
}
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
if (((this->oi_min_width > 0) && (w <= this->oi_min_width)) ||
((this->oi_min_height > 0) && (h <= this->oi_min_height)) ||
((this->oi_min_area > 0) && ((w * h) <= this->oi_min_area))) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob image optimize too small");
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
if (!description.empty()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description
<< ": not optimizing because image is smaller than requested minimum "
"dimensions\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
}
return result;
}
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
result = std::make_shared<Pl_DCT>("jpg", next, w, h, components, cs);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
return result;
}
bool
ImageOptimizer::evaluate(std::string const& description)
{
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
if (!image.pipeStreamData(nullptr, 0, qpdf_dl_specialized, true)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob image optimize no pipeline");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description
<< ": not optimizing because unable to decode data or data already uses DCT\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
return false;
}
Pl_Discard d;
Pl_Count c("count", &d);
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::shared_ptr<Pipeline> p = makePipeline(description, &c);
Code tidy: remove redundant calls to smart_ptrs get() method
2022-08-07 09:33:25 +00:00
if (p == nullptr) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
// message issued by makePipeline
return false;
}
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
if (!image.pipeStreamData(p.get(), 0, qpdf_dl_specialized)) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
return false;
}
long long orig_length = image.getDict().getKey("/Length").getIntValue();
if (c.getCount() >= orig_length) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob image optimize no shrink");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description
<< ": not optimizing because DCT compression does not reduce image size\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
return false;
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
o.doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << description << ": optimizing image reduces size from " << orig_length
<< " to " << c.getCount() << "\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
});
return true;
}
void
Overload StreamDataProvider::provideStreamData Use 'QPDFObjGen const&' instead of 'int, int' in signature.
2022-07-24 13:16:37 +00:00
ImageOptimizer::provideStreamData(QPDFObjGen const&, Pipeline* pipeline)
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
{
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::shared_ptr<Pipeline> p = makePipeline("", pipeline);
Code tidy: remove redundant calls to smart_ptrs get() method
2022-08-07 09:33:25 +00:00
if (p == nullptr) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
// Should not be possible
image.warnIfPossible(
"unable to create pipeline after previous success; image data will be lost");
pipeline->finish();
return;
}
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
image.pipeStreamData(p.get(), 0, qpdf_dl_specialized, false, false);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
QPDFJob: convert PageSpec to used shared pointer
2022-01-22 23:43:05 +00:00
QPDFJob::PageSpec::PageSpec(
std::string const& filename, char const* password, std::string const& range) :
filename(filename),
range(range)
{
if (password) {
this->password = QUtil::make_shared_cstr(password);
}
}
QPDFPageData::QPDFPageData(std::string const& filename, QPDF* qpdf, std::string const& range) :
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
filename(filename),
qpdf(qpdf),
orig_pages(qpdf->getAllPages())
{
try {
QPDFJob: convert PageSpec to used shared pointer
2022-01-22 23:43:05 +00:00
this->selected_pages =
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QUtil::parse_numrange(range.c_str(), QIntC::to_int(this->orig_pages.size()));
} catch (std::runtime_error& e) {
throw std::runtime_error("parsing numeric range for " + filename + ": " + e.what());
}
}
QPDFPageData::QPDFPageData(QPDFPageData const& other, int page) :
filename(other.filename),
qpdf(other.qpdf),
orig_pages(other.orig_pages)
{
this->selected_pages.push_back(page);
}
void
ProgressReporter::reportProgress(int percentage)
{
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
this->p << prefix << ": " << filename << ": write progress: " << percentage << "%\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob::Members::Members() :
QPDFJob: switch to C++11-style field initializers
2023-01-28 18:23:18 +00:00
log(QPDFLogger::defaultLogger())
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
{
}
QPDFJob::QPDFJob() :
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
m(new Members())
{
}
Use QPDFUsage exception for cli, json, and QPDFJob errors
2022-01-28 12:46:04 +00:00
void
QPDFJob::usage(std::string const& msg)
{
throw QPDFUsage(msg);
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
void
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
QPDFJob::setMessagePrefix(std::string const& message_prefix)
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
{
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
m->message_prefix = message_prefix;
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
}
Add more flexible funtions to qpdfjob C API
2022-06-19 12:20:43 +00:00
std::string
QPDFJob::getMessagePrefix() const
{
return m->message_prefix;
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
std::shared_ptr<QPDFLogger>
QPDFJob::getLogger()
{
return m->log;
}
void
QPDFJob::setLogger(std::shared_ptr<QPDFLogger> l)
{
m->log = l;
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
void
QPDFJob::setOutputStreams(std::ostream* out, std::ostream* err)
{
Make QPDFLogger() private and provide create method
2022-09-09 11:03:29 +00:00
setLogger(QPDFLogger::create());
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
m->log->setOutputStreams(out, err);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Add QPDFJob::registerProgressReporter
2022-06-19 00:44:44 +00:00
void
Reformat code
2022-06-25 12:29:07 +00:00
QPDFJob::registerProgressReporter(std::function<void(int)> handler)
{
Add QPDFJob::registerProgressReporter
2022-06-19 00:44:44 +00:00
m->progress_handler = handler;
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
void
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
QPDFJob::doIfVerbose(std::function<void(Pipeline&, std::string const& prefix)> fn)
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
{
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
if (m->verbose) {
fn(*m->log->getInfo(), m->message_prefix);
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
}
}
QPDFJob: convert a flag in other than the main table
2022-01-25 16:07:53 +00:00
std::shared_ptr<QPDFJob::Config>
QPDFJob: begin configuration API with verbose
2022-01-24 00:29:18 +00:00
QPDFJob::config()
{
QPDFJob: convert a flag in other than the main table
2022-01-25 16:07:53 +00:00
return std::shared_ptr<Config>(new Config(*this));
QPDFJob: begin configuration API with verbose
2022-01-24 00:29:18 +00:00
}
QPDFJob: move placeholder json to a separate source file
2022-01-26 21:48:18 +00:00
std::string
QPDFJob: rename function that returns job schema
2022-01-31 12:32:19 +00:00
QPDFJob::job_json_schema_v1()
QPDFJob: move placeholder json to a separate source file
2022-01-26 21:48:18 +00:00
{
Fix --json-help to take a version parameter
2022-07-31 12:03:18 +00:00
return job_json_schema(1);
}
std::string
QPDFJob::job_json_schema(int version)
{
if (version != LATEST_JOB_JSON) {
throw std::runtime_error("job_json_schema: version must be 1");
}
QPDFJob: move placeholder json to a separate source file
2022-01-26 21:48:18 +00:00
return JOB_SCHEMA_DATA;
}
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
void
QPDFJob::parseRotationParameter(std::string const& parameter)
{
std::string angle_str;
std::string range;
size_t colon = parameter.find(':');
int relative = 0;
if (colon != std::string::npos) {
if (colon > 0) {
angle_str = parameter.substr(0, colon);
}
if (colon + 1 < parameter.length()) {
range = parameter.substr(colon + 1);
}
} else {
angle_str = parameter;
}
if (angle_str.length() > 0) {
char first = angle_str.at(0);
if ((first == '+') || (first == '-')) {
relative = ((first == '+') ? 1 : -1);
angle_str = angle_str.substr(1);
} else if (!QUtil::is_digit(angle_str.at(0))) {
angle_str = "";
}
}
if (range.empty()) {
range = "1-z";
}
bool range_valid = false;
try {
QPDFJob: convert under/overlay and rotate
2022-01-26 14:38:34 +00:00
QUtil::parse_numrange(range.c_str(), 0);
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
range_valid = true;
} catch (std::runtime_error const&) {
// ignore
}
if (range_valid &&
((angle_str == "0") || (angle_str == "90") || (angle_str == "180") ||
(angle_str == "270"))) {
int angle = QUtil::string_to_int(angle_str.c_str());
if (relative == -1) {
angle = -angle;
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->rotations[range] = RotationSpec(angle, (relative != 0));
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
} else {
Use QPDFUsage exception for cli, json, and QPDFJob errors
2022-01-28 12:46:04 +00:00
usage("invalid parameter to rotate: " + parameter);
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
}
}
std::vector<int>
QPDFJob: convert under/overlay and rotate
2022-01-26 14:38:34 +00:00
QPDFJob::parseNumrange(char const* range, int max)
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
{
try {
return QUtil::parse_numrange(range, max);
} catch (std::runtime_error& e) {
Use QPDFUsage exception for cli, json, and QPDFJob errors
2022-01-28 12:46:04 +00:00
usage(e.what());
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
}
Code tidy - Clang-Tidy rule modernize-return-braced-init-list
2023-05-27 20:04:32 +00:00
return {};
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
}
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF>
QPDFJob::createQPDF()
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Minor cleanup
2022-01-26 20:46:02 +00:00
checkConfiguration();
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF> pdf_sp;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
try {
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
processFile(pdf_sp, m->infilename.get(), m->password.get(), true, true);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
} catch (QPDFExc& e) {
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
if (e.getErrorCode() == qpdf_e_password) {
// Allow certain operations to work when an incorrect password is supplied.
if (m->check_is_encrypted || m->check_requires_password) {
m->encryption_status = qpdf_es_encrypted | qpdf_es_password_incorrect;
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
return nullptr;
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
}
if (m->show_encryption && pdf_sp) {
m->log->info("Incorrect password supplied\n");
showEncryption(*pdf_sp);
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
return nullptr;
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
}
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
Code tidy re-throwing of exceptions Avoid copying exceptions.
2023-03-19 16:57:27 +00:00
throw;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
QPDF& pdf = *pdf_sp;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
if (pdf.isEncrypted()) {
m->encryption_status = qpdf_es_encrypted;
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->check_is_encrypted || m->check_requires_password) {
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
return nullptr;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
Add --create-from-json and --update-from-json arguments Also add stubs for top-level QPDF methods (createFromJSON, updateFromJSON)
2022-05-08 17:42:16 +00:00
// If we are updating from JSON, this has to be done first before other options may cause
// transformations to the input.
if (!m->update_from_json.empty()) {
pdf.updateFromJSON(m->update_from_json);
}
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::vector<std::unique_ptr<QPDF>> page_heap;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->page_specs.empty()) {
Remove redundant parameter from QPDFJob::handlePageSpecs and doSplitPages
2023-03-05 12:44:02 +00:00
handlePageSpecs(pdf, page_heap);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->rotations.empty()) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
handleRotations(pdf);
}
handleUnderOverlay(pdf);
handleTransformations(pdf);
Fix exit code when an input other than the primary input generates warnings
2023-09-03 11:27:23 +00:00
for (auto& foreign: page_heap) {
if (foreign->anyWarnings()) {
m->warnings = true;
}
}
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
return pdf_sp;
}
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
void
QPDFJob::writeQPDF(QPDF& pdf)
{
QPDFJob: make createsOutput callable before run()
2022-01-23 18:04:08 +00:00
if (!createsOutput()) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
doInspection(pdf);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
} else if (m->split_pages) {
Remove redundant parameter from QPDFJob::handlePageSpecs and doSplitPages
2023-03-05 12:44:02 +00:00
doSplitPages(pdf);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
} else {
writeOutfile(pdf);
}
if (!pdf.getWarnings().empty()) {
m->warnings = true;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
if (m->warnings && (!m->suppress_warnings)) {
if (createsOutput()) {
*m->log->getWarn()
<< m->message_prefix
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
<< ": operation succeeded with warnings; resulting file may have some problems\n";
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getWarn() << m->message_prefix << ": operation succeeded with warnings\n";
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
}
}
Add --report-mem-usage option for debugging/testing
2022-08-31 17:51:58 +00:00
if (m->report_mem_usage) {
// Call get_max_memory_usage before generating output. When debugging, it's easier if print
// statements from get_max_memory_usage are not interleaved with the output.
auto mem_usage = QUtil::get_max_memory_usage();
*m->log->getWarn() << "qpdf-max-memory-usage " << mem_usage << "\n";
}
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
void
QPDFJob::run()
{
auto pdf = createQPDF();
if (pdf) {
writeQPDF(*pdf);
}
}
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
bool
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
QPDFJob::hasWarnings() const
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
{
return m->warnings;
}
bool
QPDFJob: make createsOutput callable before run()
2022-01-23 18:04:08 +00:00
QPDFJob::createsOutput() const
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
{
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
return ((m->outfilename != nullptr) || m->replace_input);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
int
QPDFJob::getExitCode() const
{
if (m->check_is_encrypted) {
if (m->encryption_status & qpdf_es_encrypted) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob check encrypted encrypted");
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
return 0;
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob check encrypted not encrypted");
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
return EXIT_IS_NOT_ENCRYPTED;
}
} else if (m->check_requires_password) {
if (m->encryption_status & qpdf_es_encrypted) {
if (m->encryption_status & qpdf_es_password_incorrect) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob check password password incorrect");
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
return 0;
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob check password password correct");
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
return EXIT_CORRECT_PASSWORD;
}
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob check password not encrypted");
Move more code from qpdf.cc into QPDFJob
2022-02-01 12:28:26 +00:00
return EXIT_IS_NOT_ENCRYPTED;
}
}
if (m->warnings && (!m->warnings_exit_zero)) {
return EXIT_WARNING;
}
return 0;
}
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
void
QPDFJob::checkConfiguration()
{
Disallow --empty with --replace-input (fixes #728)
2022-09-02 13:37:17 +00:00
// Do final checks for command-line consistency. (I always think this is called doFinalChecks,
// so I'm putting that in a comment.)
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->replace_input) {
Disallow --empty with --replace-input (fixes #728)
2022-09-02 13:37:17 +00:00
// Check for --empty appears later after we have checked m->infilename.
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->outfilename) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("--replace-input may not be used when an output file is specified");
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
} else if (m->split_pages) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("--split-pages may not be used with --replace-input");
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
} else if (m->json_version) {
usage("--json may not be used with --replace-input");
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
}
}
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (m->json_version && (m->outfilename == nullptr)) {
// The output file is optional with --json for backward compatibility and defaults to
// standard output.
m->outfilename = QUtil::make_shared_cstr("-");
}
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
if (m->infilename == nullptr) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("an input file name is required");
Disallow --empty with --replace-input (fixes #728)
2022-09-02 13:37:17 +00:00
} else if (m->replace_input && (strlen(m->infilename.get()) == 0)) {
usage("--replace-input may not be used with --empty");
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
} else if (m->require_outfile && (m->outfilename == nullptr) && (!m->replace_input)) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("an output file name is required; use - for standard output");
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
} else if ((!m->require_outfile) && ((m->outfilename != nullptr) || m->replace_input)) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("no output file may be given for this option");
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->check_requires_password && m->check_is_encrypted) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("--requires-password and --is-encrypted may not be given"
" together");
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->encrypt && (!m->allow_insecure) &&
(m->owner_password.empty() && (!m->user_password.empty()) && (m->keylen == 256))) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
// Note that empty owner passwords for R < 5 are copied from the user password, so this lack
// of security is not an issue for those files. Also we are consider only the ability to
// open the file without a password to be insecure. We are not concerned about whether the
// viewer enforces security settings when the user and owner password match.
usage(
"A PDF with a non-empty user password and an empty owner password encrypted with a "
"256-bit key is insecure as it can be opened without a password. If you really want to"
" do this, you must also give the --allow-insecure option before the -- that follows "
"--encrypt.");
}
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
bool save_to_stdout = false;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->require_outfile && m->outfilename && (strcmp(m->outfilename.get(), "-") == 0)) {
if (m->split_pages) {
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("--split-pages may not be used when writing to standard output");
}
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
save_to_stdout = true;
}
if (!m->attachment_to_show.empty()) {
save_to_stdout = true;
}
if (save_to_stdout) {
Add C API to QPDFLogger
2022-06-18 17:38:36 +00:00
m->log->saveToStandardOutput(true);
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if ((!m->split_pages) && QUtil::same_file(m->infilename.get(), m->outfilename.get())) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob same file error");
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
usage("input file and output file are the same; use --replace-input to intentionally "
QPDFJob: documentation
2022-02-01 12:18:23 +00:00
"overwrite the input file");
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
}
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
if (m->json_version == 1) {
if (m->json_keys.count("qpdf")) {
usage("json key \"qpdf\" is only valid for json version > 1");
}
} else {
if (m->json_keys.count("objectinfo") || m->json_keys.count("objects")) {
usage("json keys \"objects\" and \"objectinfo\" are only valid for json version 1");
}
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
}
Move doFinalChecks to QPDFJob::checkConfiguration
2022-01-23 18:11:46 +00:00
}
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
unsigned long
QPDFJob::getEncryptionStatus()
{
return m->encryption_status;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
QPDFJob::setQPDFOptions(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
pdf.setLogger(m->log);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->ignore_xref_streams) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
pdf.setIgnoreXRefStreams(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->suppress_recovery) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
pdf.setAttemptRecovery(false);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->password_is_hex_key) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
pdf.setPasswordIsHexKey(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->suppress_warnings) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
pdf.setSuppressWarnings(true);
}
}
static std::string
show_bool(bool v)
{
return v ? "allowed" : "not allowed";
}
static std::string
show_encryption_method(QPDF::encryption_method_e method)
{
std::string result = "unknown";
switch (method) {
case QPDF::e_none:
result = "none";
break;
case QPDF::e_unknown:
result = "unknown";
break;
case QPDF::e_rc4:
result = "RC4";
break;
case QPDF::e_aes:
result = "AESv2";
break;
case QPDF::e_aesv3:
result = "AESv3";
break;
// no default so gcc will warn for missing case
}
return result;
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
void
QPDFJob::showEncryption(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
// Extract /P from /Encrypt
int R = 0;
int P = 0;
int V = 0;
QPDF::encryption_method_e stream_method = QPDF::e_unknown;
QPDF::encryption_method_e string_method = QPDF::e_unknown;
QPDF::encryption_method_e file_method = QPDF::e_unknown;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
auto& cout = *m->log->getInfo();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (!pdf.isEncrypted(R, P, V, stream_method, string_method, file_method)) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "File is not encrypted\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "R = " << R << "\n";
cout << "P = " << P << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::string user_password = pdf.getTrimmedUserPassword();
std::string encryption_key = pdf.getEncryptionKey();
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "User password = " << user_password << "\n";
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_encryption_key) {
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << "Encryption key = " << QUtil::hex_encode(encryption_key) << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (pdf.ownerPasswordMatched()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "Supplied password is owner password\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (pdf.userPasswordMatched()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "Supplied password is user password\n";
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "extract for accessibility: " << show_bool(pdf.allowAccessibility()) << "\n"
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
<< "extract for any purpose: " << show_bool(pdf.allowExtractAll()) << "\n"
<< "print low resolution: " << show_bool(pdf.allowPrintLowRes()) << "\n"
<< "print high resolution: " << show_bool(pdf.allowPrintHighRes()) << "\n"
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
<< "modify document assembly: " << show_bool(pdf.allowModifyAssembly()) << "\n"
<< "modify forms: " << show_bool(pdf.allowModifyForm()) << "\n"
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
<< "modify annotations: " << show_bool(pdf.allowModifyAnnotation()) << "\n"
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
<< "modify other: " << show_bool(pdf.allowModifyOther()) << "\n"
<< "modify anything: " << show_bool(pdf.allowModifyAll()) << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (V >= 4) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "stream encryption method: " << show_encryption_method(stream_method) << "\n"
<< "string encryption method: " << show_encryption_method(string_method) << "\n"
<< "file encryption method: " << show_encryption_method(file_method) << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
void
QPDFJob::doCheck(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
// Code below may set okay to false but not to true. We assume okay until we prove otherwise but
// may continue to perform additional checks after finding errors.
bool okay = true;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
auto& cout = *m->log->getInfo();
cout << "checking " << m->infilename.get() << "\n";
Warn if catalog type entry is invalid (fixes #810)
2022-11-12 18:10:16 +00:00
QPDF::JobSetter::setCheckMode(pdf, true);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
try {
int extension_level = pdf.getExtensionLevel();
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << "PDF Version: " << pdf.getPDFVersion();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (extension_level > 0) {
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << " extension level " << pdf.getExtensionLevel();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
showEncryption(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (pdf.isLinearized()) {
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << "File is linearized\n";
Handle linearization warnings as proper warning (fixes #851)
2023-02-19 00:37:38 +00:00
pdf.checkLinearization();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << "File is not linearized\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
// Write the file to nowhere, uncompressing streams. This causes full file traversal and
// decoding of all streams we can decode.
QPDFWriter w(pdf);
Pl_Discard discard;
w.setOutputPipeline(&discard);
w.setDecodeLevel(qpdf_dl_all);
w.write();
// Parse all content streams
DiscardContents discard_contents;
int pageno = 0;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& page: QPDFPageDocumentHelper(pdf).getAllPages()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
++pageno;
try {
page.parseContents(&discard_contents);
} catch (QPDFExc& e) {
okay = false;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getError() << "ERROR: page " << pageno << ": " << e.what() << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
} catch (std::exception& e) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getError() << "ERROR: " << e.what() << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
okay = false;
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
if (!okay) {
throw std::runtime_error("errors detected");
}
Handle linearization warnings as proper warning (fixes #851)
2023-02-19 00:37:38 +00:00
if (!pdf.getWarnings().empty()) {
QPDFJob: TRUE -> true
2022-01-23 18:13:18 +00:00
m->warnings = true;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getInfo()
<< "No syntax or stream encoding errors found; the file may still contain\n"
<< "errors that qpdf cannot detect\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
void
QPDFJob::doShowObj(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFObjectHandle obj;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_trailer) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
obj = pdf.getTrailer();
} else {
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
obj = pdf.getObjectByID(m->show_obj, m->show_gen);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
bool error = false;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (obj.isStream()) {
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_raw_stream_data || m->show_filtered_stream_data) {
bool filter = m->show_filtered_stream_data;
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
if (filter && (!obj.pipeStreamData(nullptr, 0, qpdf_dl_all))) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob unable to filter");
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
obj.warnIfPossible("unable to filter stream data");
error = true;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
// If anything has been written to standard output, this will fail.
Add C API to QPDFLogger
2022-06-18 17:38:36 +00:00
m->log->saveToStandardOutput(true);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
obj.pipeStreamData(
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
m->log->getSave().get(),
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
(filter && m->normalize) ? qpdf_ef_normalize : 0,
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
filter ? qpdf_dl_all : qpdf_dl_none);
}
Programmatically apply new formatting to code Run this: for i in **/*.cc **/*.c **/*.h **/*.hh; do clang-format < $i >| $i.new && mv $i.new $i done
2022-04-02 21:14:10 +00:00
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getInfo() << "Object is stream. Dictionary:\n"
<< obj.getDict().unparseResolved() << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getInfo() << obj.unparseResolved() << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
if (error) {
Add optional parameter separator to QPDFObjGen::unparse Also, revert inlining of unparse and operator << from commit 4c6640c in order to avoid exposing QUtil.
2022-07-16 10:21:11 +00:00
throw std::runtime_error("unable to get object " + obj.getObjGen().unparse(','));
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
void
QPDFJob::doShowPages(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
int pageno = 0;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
auto& cout = *m->log->getInfo();
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& ph: QPDFPageDocumentHelper(pdf).getAllPages()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFObjectHandle page = ph.getObjectHandle();
++pageno;
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << "page " << pageno << ": " << page.getObjectID() << " " << page.getGeneration()
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
<< " R\n";
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_page_images) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::map<std::string, QPDFObjectHandle> images = ph.getImages();
if (!images.empty()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << " images:\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
for (auto const& iter2: images) {
std::string const& name = iter2.first;
QPDFObjectHandle image = iter2.second;
QPDFObjectHandle dict = image.getDict();
int width = dict.getKey("/Width").getIntValueAsInt();
int height = dict.getKey("/Height").getIntValueAsInt();
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
cout << " " << name << ": " << image.unparse() << ", " << width << " x "
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
<< height << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << " content:\n";
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& iter2: ph.getPageContents()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << " " << iter2.unparse() << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
void
QPDFJob::doListAttachments(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFEmbeddedFileDocumentHelper efdh(pdf);
if (efdh.hasEmbeddedFiles()) {
for (auto const& i: efdh.getEmbeddedFiles()) {
std::string const& key = i.first;
auto efoh = i.second;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getInfo() << key << " -> "
Add optional parameter separator to QPDFObjGen::unparse Also, revert inlining of unparse and operator << from commit 4c6640c in order to avoid exposing QUtil.
2022-07-16 10:21:11 +00:00
<< efoh->getEmbeddedFileStream().getObjGen().unparse(',') << "\n";
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto desc = efoh->getDescription();
if (!desc.empty()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
v << " description: " << desc << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
v << " preferred name: " << efoh->getFilename() << "\n";
v << " all names:\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
for (auto const& i2: efoh->getFilenames()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
v << " " << i2.first << " -> " << i2.second << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
v << " all data streams:\n";
Code tidy - Clang-Tidy rule performance-for-range-copy
2023-06-01 15:16:21 +00:00
for (auto const& i2: efoh->getEmbeddedFileStreams().ditems()) {
Add additional information when listing attachments
2022-05-30 13:23:48 +00:00
auto efs = QPDFEFStreamObjectHelper(i2.second);
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
v << " " << i2.first << " -> "
Add optional parameter separator to QPDFObjGen::unparse Also, revert inlining of unparse and operator << from commit 4c6640c in order to avoid exposing QUtil.
2022-07-16 10:21:11 +00:00
<< efs.getObjectHandle().getObjGen().unparse(',') << "\n";
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
v << " creation date: " << efs.getCreationDate() << "\n"
<< " modification date: " << efs.getModDate() << "\n"
<< " mime type: " << efs.getSubtype() << "\n"
<< " checksum: " << QUtil::hex_encode(efs.getChecksum()) << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getInfo() << m->infilename.get() << " has no embedded files\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
QPDFJob::doShowAttachment(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFEmbeddedFileDocumentHelper efdh(pdf);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
auto fs = efdh.getEmbeddedFile(m->attachment_to_show);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (!fs) {
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
throw std::runtime_error("attachment " + m->attachment_to_show + " not found");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
auto efs = fs->getEmbeddedFileStream();
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
// saveToStandardOutput has already been called, but it's harmless to call it again, so do as
// defensive coding.
Add C API to QPDFLogger
2022-06-18 17:38:36 +00:00
m->log->saveToStandardOutput(true);
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
efs.pipeStreamData(m->log->getSave().get(), 0, qpdf_dl_all);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
void
QPDFJob::parse_object_id(std::string const& objspec, bool& trailer, int& obj, int& gen)
{
if (objspec == "trailer") {
trailer = true;
} else {
trailer = false;
obj = QUtil::string_to_int(objspec.c_str());
size_t comma = objspec.find(',');
if ((comma != std::string::npos) && (comma + 1 < objspec.length())) {
gen = QUtil::string_to_int(objspec.substr(1 + comma, std::string::npos).c_str());
}
}
}
Use QPDFObjGen::set in QPDFJob::getWantedJSONObjects
2023-05-18 13:42:27 +00:00
QPDFObjGen::set
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
QPDFJob::getWantedJSONObjects()
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Use QPDFObjGen::set in QPDFJob::getWantedJSONObjects
2023-05-18 13:42:27 +00:00
QPDFObjGen::set wanted_og;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
for (auto const& iter: m->json_objects) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
bool trailer;
int obj = 0;
int gen = 0;
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
parse_object_id(iter, trailer, obj, gen);
Use QPDFObjGen::set in QPDFJob::getWantedJSONObjects
2023-05-18 13:42:27 +00:00
wanted_og.add(QPDFObjGen(obj, gen));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
return wanted_og;
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONObjects(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (m->json_version == 1) {
JSON::writeDictionaryKey(p, first, "objects", 1);
bool first_object = true;
JSON::writeDictionaryOpen(p, first_object, 1);
bool all_objects = m->json_objects.empty();
Tidy QPDFJob::doJSONObjects
2023-05-18 14:18:39 +00:00
auto wanted_og = getWantedJSONObjects();
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
for (auto& obj: pdf.getAllObjects()) {
std::string key = obj.unparse();
Refactor QPDFJob::doJSONObjects
2024-02-16 15:50:30 +00:00
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (all_objects || wanted_og.count(obj.getObjGen())) {
Refactor QPDFJob::doJSONObjects
2024-02-16 15:50:30 +00:00
JSON::writeDictionaryKey(p, first_object, obj.unparse(), 2);
obj.writeJSON(1, p, true, 2);
first_object = false;
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
}
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
}
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (all_objects || m->json_objects.count("trailer")) {
Refactor QPDFJob::doJSONObjects
2024-02-16 15:50:30 +00:00
JSON::writeDictionaryKey(p, first_object, "trailer", 2);
pdf.getTrailer().writeJSON(1, p, true, 2);
first_object = false;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
JSON::writeDictionaryClose(p, first_object, 1);
} else {
std::set<std::string> json_objects;
if (m->json_objects.count("trailer")) {
json_objects.insert("trailer");
}
Tidy QPDFJob::doJSONObjects
2023-05-18 14:18:39 +00:00
for (auto og: getWantedJSONObjects()) {
json_objects.emplace("obj:" + og.unparse(' ') + " R");
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
}
pdf.writeJSON(
m->json_version,
p,
false,
first,
m->decode_level,
m->json_stream_data,
m->json_stream_prefix,
json_objects);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONObjectinfo(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryKey(p, first, "objectinfo", 1);
Objectinfo json: write incrementally and in numeric order This script was used on test data: ---------- #!/usr/bin/env python3 import json import sys import re def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) if 'objectinfo' not in data: continue trailer = None to_sort = [] for k, v in data['objectinfo'].items(): if k == 'trailer': trailer = v else: m = re.match(r'^(\d+) \d+ R', k) if m: to_sort.append([int(m.group(1)), k, v]) newobjectinfo = {x[1]: x[2] for x in sorted(to_sort)} if trailer is not None: newobjectinfo['trailer'] = trailer data['objectinfo'] = newobjectinfo print(json_dumps(data)) ----------
2022-05-06 23:08:31 +00:00
bool first_object = true;
JSON::writeDictionaryOpen(p, first_object, 1);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
bool all_objects = m->json_objects.empty();
Tidy QPDFJob::doJSONObjects
2023-05-18 14:18:39 +00:00
auto wanted_og = getWantedJSONObjects();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
for (auto& obj: pdf.getAllObjects()) {
if (all_objects || wanted_og.count(obj.getObjGen())) {
Objectinfo json: write incrementally and in numeric order This script was used on test data: ---------- #!/usr/bin/env python3 import json import sys import re def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) if 'objectinfo' not in data: continue trailer = None to_sort = [] for k, v in data['objectinfo'].items(): if k == 'trailer': trailer = v else: m = re.match(r'^(\d+) \d+ R', k) if m: to_sort.append([int(m.group(1)), k, v]) newobjectinfo = {x[1]: x[2] for x in sorted(to_sort)} if trailer is not None: newobjectinfo['trailer'] = trailer data['objectinfo'] = newobjectinfo print(json_dumps(data)) ----------
2022-05-06 23:08:31 +00:00
auto j_details = JSON::makeDictionary();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto j_stream = j_details.addDictionaryMember("stream", JSON::makeDictionary());
bool is_stream = obj.isStream();
j_stream.addDictionaryMember("is", JSON::makeBool(is_stream));
j_stream.addDictionaryMember(
"length",
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
(is_stream ? obj.getDict().getKey("/Length").getJSON(m->json_version, true)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
: JSON::makeNull()));
j_stream.addDictionaryMember(
"filter",
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
(is_stream ? obj.getDict().getKey("/Filter").getJSON(m->json_version, true)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
: JSON::makeNull()));
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryItem(p, first_object, obj.unparse(), j_details, 2);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
Objectinfo json: write incrementally and in numeric order This script was used on test data: ---------- #!/usr/bin/env python3 import json import sys import re def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) if 'objectinfo' not in data: continue trailer = None to_sort = [] for k, v in data['objectinfo'].items(): if k == 'trailer': trailer = v else: m = re.match(r'^(\d+) \d+ R', k) if m: to_sort.append([int(m.group(1)), k, v]) newobjectinfo = {x[1]: x[2] for x in sorted(to_sort)} if trailer is not None: newobjectinfo['trailer'] = trailer data['objectinfo'] = newobjectinfo print(json_dumps(data)) ----------
2022-05-06 23:08:31 +00:00
JSON::writeDictionaryClose(p, first_object, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONPages(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryKey(p, first, "pages", 1);
Pages json: write each page incrementally
2022-05-06 22:46:38 +00:00
bool first_page = true;
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeArrayOpen(p, first_page, 2);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageLabelDocumentHelper pldh(pdf);
QPDFOutlineDocumentHelper odh(pdf);
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
int pageno = -1;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& ph: QPDFPageDocumentHelper(pdf).getAllPages()) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
++pageno;
Pages json: write each page incrementally
2022-05-06 22:46:38 +00:00
JSON j_page = JSON::makeDictionary();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFObjectHandle page = ph.getObjectHandle();
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_page.addDictionaryMember("object", page.getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON j_images = j_page.addDictionaryMember("images", JSON::makeArray());
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto const& iter2: ph.getImages()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON j_image = j_images.addArrayElement(JSON::makeDictionary());
j_image.addDictionaryMember("name", JSON::makeString(iter2.first));
QPDFObjectHandle image = iter2.second;
QPDFObjectHandle dict = image.getDict();
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_image.addDictionaryMember("object", image.getJSON(m->json_version));
j_image.addDictionaryMember("width", dict.getKey("/Width").getJSON(m->json_version));
j_image.addDictionaryMember("height", dict.getKey("/Height").getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_image.addDictionaryMember(
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
"colorspace", dict.getKey("/ColorSpace").getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_image.addDictionaryMember(
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
"bitspercomponent", dict.getKey("/BitsPerComponent").getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFObjectHandle filters = dict.getKey("/Filter").wrapInArray();
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_image.addDictionaryMember("filter", filters.getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFObjectHandle decode_parms = dict.getKey("/DecodeParms");
QPDFObjectHandle dp_array;
if (decode_parms.isArray()) {
dp_array = decode_parms;
} else {
dp_array = QPDFObjectHandle::newArray();
for (int i = 0; i < filters.getArrayNItems(); ++i) {
dp_array.appendItem(decode_parms);
}
}
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_image.addDictionaryMember("decodeparms", dp_array.getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_image.addDictionaryMember(
"filterable",
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
JSON::makeBool(image.pipeStreamData(nullptr, 0, m->decode_level, true)));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
j_page.addDictionaryMember("images", j_images);
JSON j_contents = j_page.addDictionaryMember("contents", JSON::makeArray());
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& iter2: ph.getPageContents()) {
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_contents.addArrayElement(iter2.getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_page.addDictionaryMember("label", pldh.getLabelForPage(pageno).getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON j_outlines = j_page.addDictionaryMember("outlines", JSON::makeArray());
std::vector<QPDFOutlineObjectHelper> outlines = odh.getOutlinesForPage(page.getObjGen());
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto& oiter: outlines) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON j_outline = j_outlines.addArrayElement(JSON::makeDictionary());
j_outline.addDictionaryMember(
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
"object", oiter.getObjectHandle().getJSON(m->json_version));
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
j_outline.addDictionaryMember("title", JSON::makeString(oiter.getTitle()));
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_outline.addDictionaryMember("dest", oiter.getDest().getJSON(m->json_version, true));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
j_page.addDictionaryMember("pageposfrom1", JSON::makeInt(1 + pageno));
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeArrayItem(p, first_page, j_page, 2);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Pages json: write each page incrementally
2022-05-06 22:46:38 +00:00
JSON::writeArrayClose(p, first_page, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONPageLabels(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
JSON j_labels = JSON::makeArray();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageLabelDocumentHelper pldh(pdf);
Reformat code
2022-06-25 12:29:07 +00:00
long long npages = QIntC::to_longlong(QPDFPageDocumentHelper(pdf).getAllPages().size());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (pldh.hasPageLabels()) {
std::vector<QPDFObjectHandle> labels;
Code tidy: QPDFJob::doJSONPageLabels Remove redundant variables pages and next.
2022-06-23 09:32:32 +00:00
pldh.getLabelsForPageRange(0, npages - 1, 0, labels);
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto iter = labels.begin(); iter != labels.end(); ++iter) {
Code tidy: QPDFJob::doJSONPageLabels Remove redundant variables pages and next.
2022-06-23 09:32:32 +00:00
if ((iter + 1) == labels.end()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// This can't happen, so ignore it. This could only happen if getLabelsForPageRange
// somehow returned an odd number of items.
break;
}
JSON j_label = j_labels.addArrayElement(JSON::makeDictionary());
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_label.addDictionaryMember("index", (*iter).getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
++iter;
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_label.addDictionaryMember("label", (*iter).getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryItem(p, first, "pagelabels", j_labels, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
void
QPDFJob::addOutlinesToJson(
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::vector<QPDFOutlineObjectHelper> outlines, JSON& j, std::map<QPDFObjGen, int>& page_numbers)
{
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto& ol: outlines) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON jo = j.addArrayElement(JSON::makeDictionary());
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
jo.addDictionaryMember("object", ol.getObjectHandle().getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
jo.addDictionaryMember("title", JSON::makeString(ol.getTitle()));
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
jo.addDictionaryMember("dest", ol.getDest().getJSON(m->json_version, true));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
jo.addDictionaryMember("open", JSON::makeBool(ol.getCount() >= 0));
QPDFObjectHandle page = ol.getDestPage();
JSON j_destpage = JSON::makeNull();
if (page.isIndirect()) {
QPDFObjGen og = page.getObjGen();
if (page_numbers.count(og)) {
j_destpage = JSON::makeInt(page_numbers[og]);
}
}
jo.addDictionaryMember("destpageposfrom1", j_destpage);
JSON j_kids = jo.addDictionaryMember("kids", JSON::makeArray());
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
addOutlinesToJson(ol.getKids(), j_kids, page_numbers);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONOutlines(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
std::map<QPDFObjGen, int> page_numbers;
int n = 0;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto const& ph: QPDFPageDocumentHelper(pdf).getAllPages()) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
QPDFObjectHandle oh = ph.getObjectHandle();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
page_numbers[oh.getObjGen()] = ++n;
}
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
JSON j_outlines = JSON::makeArray();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFOutlineDocumentHelper odh(pdf);
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
addOutlinesToJson(odh.getTopLevelOutlines(), j_outlines, page_numbers);
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryItem(p, first, "outlines", j_outlines, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONAcroform(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
JSON j_acroform = JSON::makeDictionary();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFAcroFormDocumentHelper afdh(pdf);
j_acroform.addDictionaryMember("hasacroform", JSON::makeBool(afdh.hasAcroForm()));
j_acroform.addDictionaryMember("needappearances", JSON::makeBool(afdh.getNeedAppearances()));
JSON j_fields = j_acroform.addDictionaryMember("fields", JSON::makeArray());
int pagepos1 = 0;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto const& page: QPDFPageDocumentHelper(pdf).getAllPages()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
++pagepos1;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& aoh: afdh.getWidgetAnnotationsForPage(page)) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFFormFieldObjectHelper ffh = afdh.getFieldForAnnotation(aoh);
Handle null form field from annotation (fixes #1189) A file that has Widget annotations that can't be mapped back to form fields would crash qpdf json.
2024-06-18 12:47:14 +00:00
if (!ffh.getObjectHandle().isDictionary()) {
continue;
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON j_field = j_fields.addArrayElement(JSON::makeDictionary());
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_field.addDictionaryMember("object", ffh.getObjectHandle().getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_field.addDictionaryMember(
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
"parent", ffh.getObjectHandle().getKey("/Parent").getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_field.addDictionaryMember("pageposfrom1", JSON::makeInt(pagepos1));
j_field.addDictionaryMember("fieldtype", JSON::makeString(ffh.getFieldType()));
j_field.addDictionaryMember("fieldflags", JSON::makeInt(ffh.getFlags()));
j_field.addDictionaryMember("fullname", JSON::makeString(ffh.getFullyQualifiedName()));
j_field.addDictionaryMember("partialname", JSON::makeString(ffh.getPartialName()));
j_field.addDictionaryMember(
"alternativename", JSON::makeString(ffh.getAlternativeName()));
j_field.addDictionaryMember("mappingname", JSON::makeString(ffh.getMappingName()));
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_field.addDictionaryMember("value", ffh.getValue().getJSON(m->json_version));
j_field.addDictionaryMember(
"defaultvalue", ffh.getDefaultValue().getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_field.addDictionaryMember("quadding", JSON::makeInt(ffh.getQuadding()));
j_field.addDictionaryMember("ischeckbox", JSON::makeBool(ffh.isCheckbox()));
j_field.addDictionaryMember("isradiobutton", JSON::makeBool(ffh.isRadioButton()));
j_field.addDictionaryMember("ischoice", JSON::makeBool(ffh.isChoice()));
j_field.addDictionaryMember("istext", JSON::makeBool(ffh.isText()));
JSON j_choices = j_field.addDictionaryMember("choices", JSON::makeArray());
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto const& choice: ffh.getChoices()) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
j_choices.addArrayElement(JSON::makeString(choice));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
JSON j_annot = j_field.addDictionaryMember("annotation", JSON::makeDictionary());
Prepare code for JSON v2 Update getJSON() methods and calls to them
2022-05-07 11:53:45 +00:00
j_annot.addDictionaryMember("object", aoh.getObjectHandle().getJSON(m->json_version));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_annot.addDictionaryMember(
"appearancestate", JSON::makeString(aoh.getAppearanceState()));
j_annot.addDictionaryMember("annotationflags", JSON::makeInt(aoh.getFlags()));
}
}
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryItem(p, first, "acroform", j_acroform, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONEncrypt(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
int R = 0;
int P = 0;
int V = 0;
QPDF::encryption_method_e stream_method = QPDF::e_none;
QPDF::encryption_method_e string_method = QPDF::e_none;
QPDF::encryption_method_e file_method = QPDF::e_none;
bool is_encrypted = pdf.isEncrypted(R, P, V, stream_method, string_method, file_method);
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
JSON j_encrypt = JSON::makeDictionary();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_encrypt.addDictionaryMember("encrypted", JSON::makeBool(is_encrypted));
j_encrypt.addDictionaryMember(
"userpasswordmatched", JSON::makeBool(is_encrypted && pdf.userPasswordMatched()));
j_encrypt.addDictionaryMember(
"ownerpasswordmatched", JSON::makeBool(is_encrypted && pdf.ownerPasswordMatched()));
In json mode, reveal recovered user password when otherwise unavailable
2022-05-30 14:55:07 +00:00
if (is_encrypted && (V < 5) && pdf.ownerPasswordMatched() && (!pdf.userPasswordMatched())) {
std::string user_password = pdf.getTrimmedUserPassword();
j_encrypt.addDictionaryMember("recovereduserpassword", JSON::makeString(user_password));
} else {
j_encrypt.addDictionaryMember("recovereduserpassword", JSON::makeNull());
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
JSON j_capabilities = j_encrypt.addDictionaryMember("capabilities", JSON::makeDictionary());
j_capabilities.addDictionaryMember("accessibility", JSON::makeBool(pdf.allowAccessibility()));
j_capabilities.addDictionaryMember("extract", JSON::makeBool(pdf.allowExtractAll()));
j_capabilities.addDictionaryMember("printlow", JSON::makeBool(pdf.allowPrintLowRes()));
j_capabilities.addDictionaryMember("printhigh", JSON::makeBool(pdf.allowPrintHighRes()));
j_capabilities.addDictionaryMember("modifyassembly", JSON::makeBool(pdf.allowModifyAssembly()));
j_capabilities.addDictionaryMember("modifyforms", JSON::makeBool(pdf.allowModifyForm()));
Spell check
2022-05-01 15:48:41 +00:00
/* cSpell:ignore moddifyannotations */
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
std::string MODIFY_ANNOTATIONS =
(m->json_version == 1 ? "moddifyannotations" : "modifyannotations");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_capabilities.addDictionaryMember(
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
MODIFY_ANNOTATIONS, JSON::makeBool(pdf.allowModifyAnnotation()));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
j_capabilities.addDictionaryMember("modifyother", JSON::makeBool(pdf.allowModifyOther()));
j_capabilities.addDictionaryMember("modify", JSON::makeBool(pdf.allowModifyAll()));
JSON j_parameters = j_encrypt.addDictionaryMember("parameters", JSON::makeDictionary());
j_parameters.addDictionaryMember("R", JSON::makeInt(R));
j_parameters.addDictionaryMember("V", JSON::makeInt(V));
j_parameters.addDictionaryMember("P", JSON::makeInt(P));
int bits = 0;
JSON key = JSON::makeNull();
if (is_encrypted) {
std::string encryption_key = pdf.getEncryptionKey();
bits = QIntC::to_int(encryption_key.length() * 8);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_encryption_key) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
key = JSON::makeString(QUtil::hex_encode(encryption_key));
}
}
j_parameters.addDictionaryMember("bits", JSON::makeInt(bits));
j_parameters.addDictionaryMember("key", key);
Fix a few things found by CLion
2023-09-03 12:02:05 +00:00
auto fix_method = [is_encrypted](QPDF::encryption_method_e& method) {
if (is_encrypted && method == QPDF::e_none) {
method = QPDF::e_rc4;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
}
};
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
fix_method(stream_method);
fix_method(string_method);
fix_method(file_method);
std::string s_stream_method = show_encryption_method(stream_method);
std::string s_string_method = show_encryption_method(string_method);
std::string s_file_method = show_encryption_method(file_method);
std::string s_overall_method;
if ((stream_method == string_method) && (stream_method == file_method)) {
s_overall_method = s_stream_method;
} else {
s_overall_method = "mixed";
}
j_parameters.addDictionaryMember("method", JSON::makeString(s_overall_method));
j_parameters.addDictionaryMember("streammethod", JSON::makeString(s_stream_method));
j_parameters.addDictionaryMember("stringmethod", JSON::makeString(s_string_method));
j_parameters.addDictionaryMember("filemethod", JSON::makeString(s_file_method));
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryItem(p, first, "encrypt", j_encrypt, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
QPDFJob::doJSONAttachments(Pipeline* p, bool& first, QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Add additional information when listing attachments
2022-05-30 13:23:48 +00:00
auto to_iso8601 = [](std::string const& d) {
// Convert PDF date to iso8601 if not empty; if empty, return
// empty.
std::string iso8601;
QUtil::pdf_time_to_iso8601(d, iso8601);
return iso8601;
};
auto null_or_string = [](std::string const& s) {
if (s.empty()) {
return JSON::makeNull();
} else {
return JSON::makeString(s);
}
};
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
JSON j_attachments = JSON::makeDictionary();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFEmbeddedFileDocumentHelper efdh(pdf);
for (auto const& iter: efdh.getEmbeddedFiles()) {
std::string const& key = iter.first;
auto fsoh = iter.second;
auto j_details = j_attachments.addDictionaryMember(key, JSON::makeDictionary());
j_details.addDictionaryMember(
"filespec", JSON::makeString(fsoh->getObjectHandle().unparse()));
j_details.addDictionaryMember("preferredname", JSON::makeString(fsoh->getFilename()));
j_details.addDictionaryMember(
"preferredcontents", JSON::makeString(fsoh->getEmbeddedFileStream().unparse()));
Add additional information when listing attachments
2022-05-30 13:23:48 +00:00
j_details.addDictionaryMember("description", null_or_string(fsoh->getDescription()));
auto j_names = j_details.addDictionaryMember("names", JSON::makeDictionary());
for (auto const& i2: fsoh->getFilenames()) {
j_names.addDictionaryMember(i2.first, JSON::makeString(i2.second));
}
auto j_streams = j_details.addDictionaryMember("streams", JSON::makeDictionary());
Code tidy - Clang-Tidy rule performance-for-range-copy
2023-06-01 15:16:21 +00:00
for (auto const& i2: fsoh->getEmbeddedFileStreams().ditems()) {
Add additional information when listing attachments
2022-05-30 13:23:48 +00:00
auto efs = QPDFEFStreamObjectHelper(i2.second);
auto j_stream = j_streams.addDictionaryMember(i2.first, JSON::makeDictionary());
j_stream.addDictionaryMember(
"creationdate", null_or_string(to_iso8601(efs.getCreationDate())));
j_stream.addDictionaryMember(
"modificationdate", null_or_string(to_iso8601(efs.getCreationDate())));
j_stream.addDictionaryMember("mimetype", null_or_string(efs.getSubtype()));
j_stream.addDictionaryMember(
"checksum", null_or_string(QUtil::hex_encode(efs.getChecksum())));
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Fix/clarify meaning of depth parameter to json write methods
2022-07-30 17:32:59 +00:00
JSON::writeDictionaryItem(p, first, "attachments", j_attachments, 1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
JSON
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
QPDFJob::json_schema(int json_version, std::set<std::string>* keys)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
// Style: use all lower-case keys with no dashes or underscores. Choose array or dictionary
// based on indexing. For example, we use a dictionary for objects because we want to index by
// object ID and an array for pages because we want to index by position. The pages in the pages
// array contain references back to the original object, which can be resolved in the objects
// dictionary. When a PDF construct that maps back to an original object is represented
// separately, use "object" as the key that references the original object.
Code tidy - reflow comments and strings
2023-05-24 15:28:17 +00:00
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// This JSON object doubles as a schema and as documentation for our JSON output. Any schema
// mismatch is a bug in qpdf. This helps to enforce our policy of consistently providing a known
// structure where every documented key will always be present, which makes it easier to consume
// our JSON. This is discussed in more depth in the manual.
JSON schema = JSON::makeDictionary();
schema.addDictionaryMember(
"version",
JSON::makeString("JSON format serial number; increased for non-compatible changes"));
JSON j_params = schema.addDictionaryMember("parameters", JSON::parse(R"({
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"decodelevel": "decode level used to determine stream filterability"
})"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
bool all_keys = ((keys == nullptr) || keys->empty());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
Fix comment on duplicated top-level json keys
2022-01-07 22:15:15 +00:00
// The list of selectable top-level keys id duplicated in the following places: job.yml,
// QPDFJob::json_schema, and QPDFJob::doJSON.
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
if (json_version == 1) {
if (all_keys || keys->count("objects")) {
schema.addDictionaryMember("objects", JSON::parse(R"({
Fix json schema for objects to include dictionary key
2022-01-19 16:41:23 +00:00
"<n n R|trailer>": "json representation of object"
})"));
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
}
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
if (all_keys || keys->count("objectinfo")) {
JSON objectinfo = schema.addDictionaryMember("objectinfo", JSON::parse(R"({
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"<object-id>": {
"stream": {
"filter": "if stream, its filters, otherwise null",
"is": "whether the object is a stream",
"length": "if stream, its length, otherwise null"
}
}
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
})"));
}
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
} else {
if (all_keys || keys->count("qpdf")) {
schema.addDictionaryMember("qpdf", JSON::parse(R"([{
"jsonversion": "numeric JSON version",
"pdfversion": "PDF version as x.y",
"pushedinheritedpageresources": "whether inherited attributes were pushed to the page level",
"calledgetallpages": "whether getAllPages was called",
"maxobjectid": "highest object ID in output, ignored on input"
},
{
"<obj:n n R|trailer>": "json representation of object"
}])"));
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (all_keys || keys->count("pages")) {
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
JSON page = schema.addDictionaryMember("pages", JSON::parse(R"([
{
"contents": [
"reference to each content stream"
],
"images": [
{
"bitspercomponent": "bits per component",
"colorspace": "color space",
"decodeparms": [
"decode parameters for image data"
],
"filter": [
"filters applied to image data"
],
"filterable": "whether image data can be decoded using the decode level qpdf was invoked with",
"height": "image height",
"name": "name of image in XObject table",
"object": "reference to image stream",
"width": "image width"
}
],
"label": "page label dictionary, or null if none",
"object": "reference to original page object",
"outlines": [
{
"dest": "outline destination dictionary",
"object": "reference to outline that targets this page",
"title": "outline title"
}
],
"pageposfrom1": "position of page in document numbering from 1"
}
])"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (all_keys || keys->count("pagelabels")) {
JSON labels = schema.addDictionaryMember("pagelabels", JSON::parse(R"([
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
{
"index": "starting page position starting from zero",
"label": "page label dictionary"
}
])"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (all_keys || keys->count("outlines")) {
JSON outlines = schema.addDictionaryMember("outlines", JSON::parse(R"([
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
{
"dest": "outline destination dictionary",
"destpageposfrom1": "position of destination page in document numbered from 1; null if not known",
"kids": "array of descendent outlines",
"object": "reference to this outline",
"open": "whether the outline is displayed expanded",
"title": "outline title"
}
])"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (all_keys || keys->count("acroform")) {
JSON acroform = schema.addDictionaryMember("acroform", JSON::parse(R"({
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"fields": [
{
"alternativename": "alternative name of field -- this is the one usually shown to users",
"annotation": {
"annotationflags": "annotation flags from /F -- see pdf_annotation_flag_e in qpdf/Constants.h",
"appearancestate": "appearance state -- can be used to determine value for checkboxes and radio buttons",
"object": "reference to the annotation object"
},
"choices": "for choices fields, the list of choices presented to the user",
"defaultvalue": "default value of field",
"fieldflags": "form field flags from /Ff -- see pdf_form_field_flag_e in qpdf/Constants.h",
"fieldtype": "field type",
"fullname": "full name of field",
"ischeckbox": "whether field is a checkbox",
"ischoice": "whether field is a list, combo, or dropdown",
"isradiobutton": "whether field is a radio button -- buttons in a single group share a parent",
"istext": "whether field is a text field",
"mappingname": "mapping name of field",
"object": "reference to this form field",
"pageposfrom1": "position of containing page numbered from 1",
"parent": "reference to this field's parent",
"partialname": "partial name of field",
"quadding": "field quadding -- number indicating left, center, or right",
"value": "value of field"
}
],
"hasacroform": "whether the document has interactive forms",
"needappearances": "whether the form fields' appearance streams need to be regenerated"
})"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
std::string MODIFY_ANNOTATIONS =
(json_version == 1 ? "moddifyannotations" : "modifyannotations");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (all_keys || keys->count("encrypt")) {
JSON encrypt = schema.addDictionaryMember("encrypt", JSON::parse(R"({
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"capabilities": {
"accessibility": "allow extraction for accessibility?",
"extract": "allow extraction?",
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
")" + MODIFY_ANNOTATIONS + R"(": "allow modifying annotations?",
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"modify": "allow all modifications?",
"modifyassembly": "allow modifying document assembly?",
"modifyforms": "allow modifying forms?",
"modifyother": "allow other modifications?",
"printhigh": "allow high resolution printing?",
"printlow": "allow low resolution printing?"
},
"encrypted": "whether the document is encrypted",
"ownerpasswordmatched": "whether supplied password matched owner password; always false for non-encrypted files",
In json mode, reveal recovered user password when otherwise unavailable
2022-05-30 14:55:07 +00:00
"recovereduserpassword": "If the owner password was used to recover the user password, reveal user password; otherwise null",
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"parameters": {
"P": "P value from Encrypt dictionary",
"R": "R value from Encrypt dictionary",
"V": "V value from Encrypt dictionary",
"bits": "encryption key bit length",
"filemethod": "encryption method for attachments",
"key": "encryption key; will be null unless --show-encryption-key was specified",
"method": "overall encryption method: none, mixed, RC4, AESv2, AESv3",
"streammethod": "encryption method for streams",
"stringmethod": "encryption method for string"
},
"userpasswordmatched": "whether supplied password matched user password; always false for non-encrypted files"
})"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (all_keys || keys->count("attachments")) {
JSON attachments = schema.addDictionaryMember("attachments", JSON::parse(R"({
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
"<attachment-key>": {
"filespec": "object containing the file spec",
"preferredcontents": "most preferred embedded file stream",
Add additional information when listing attachments
2022-05-30 13:23:48 +00:00
"preferredname": "most preferred file name",
"description": "description of attachment",
"names": {
"<name-key>": "file name for key"
},
"streams": {
"<stream-key>": {
"creationdate": "ISO-8601 creation date or null",
"modificationdate": "ISO-8601 modification date or null",
"mimetype": "mime type or null",
"checksum": "MD5 checksum or null"
}
}
Use JSON::parse to initialize schema for json mode
2022-01-19 16:21:48 +00:00
}
})"));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
return schema;
}
Fix --json-help to take a version parameter
2022-07-31 12:03:18 +00:00
std::string
QPDFJob::json_out_schema(int version)
{
return json_schema(version).unparse();
}
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
std::string
QPDFJob::json_out_schema_v1()
{
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
return json_schema(1).unparse();
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
void
QPDFJob: have doJSON write to a pipeline
2022-05-06 20:37:37 +00:00
QPDFJob::doJSON(QPDF& pdf, Pipeline* p)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Change --json-output format from "qpdf-v2" to "qpdf": [..., ...]
2022-07-30 23:29:55 +00:00
// qpdf guarantees that no new top-level keys whose names start with "x-" will be added. These
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
// are reserved for users.
Change --json-output format from "qpdf-v2" to "qpdf": [..., ...]
2022-07-30 23:29:55 +00:00
Test json against schema only on demand Testing json against schema requires an in-memory copy, so do it only when requested by the test suite.
2022-05-06 21:49:28 +00:00
std::string captured_json;
std::shared_ptr<Pl_String> pl_str;
if (m->test_json_schema) {
pl_str = std::make_shared<Pl_String>("capture json", p, captured_json);
p = pl_str.get();
}
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
bool first = true;
JSON::writeDictionaryOpen(p, first, 0);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (m->json_output) {
// Exclude version and parameters to keep the output file minimal. The JSON version is
// inside the "qpdf" key for version 2.
} else {
// This version is updated every time a non-backward-compatible change is made to the JSON
// format. Clients of the JSON are to ignore unrecognized keys, so we only update the
// version of a key disappears or if its value changes meaning.
JSON::writeDictionaryItem(p, first, "version", JSON::makeInt(m->json_version), 1);
JSON j_params = JSON::makeDictionary();
std::string decode_level_str;
switch (m->decode_level) {
case qpdf_dl_none:
decode_level_str = "none";
break;
case qpdf_dl_generalized:
decode_level_str = "generalized";
break;
case qpdf_dl_specialized:
decode_level_str = "specialized";
break;
case qpdf_dl_all:
decode_level_str = "all";
break;
}
j_params.addDictionaryMember("decodelevel", JSON::makeString(decode_level_str));
JSON::writeDictionaryItem(p, first, "parameters", j_params, 1);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
bool all_keys = m->json_keys.empty();
Fix comment on duplicated top-level json keys
2022-01-07 22:15:15 +00:00
// The list of selectable top-level keys id duplicated in the following places: job.yml,
// QPDFJob::json_schema, and QPDFJob::doJSON.
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
// We do pages and pagelabels first since they have the side effect of repairing the pages tree,
// which could potentially impact object references in remaining items.
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (all_keys || m->json_keys.count("pages")) {
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
doJSONPages(p, first, pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (all_keys || m->json_keys.count("pagelabels")) {
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
doJSONPageLabels(p, first, pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
// The non-special keys are output in alphabetical order, but the order doesn't actually matter.
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (all_keys || m->json_keys.count("acroform")) {
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
doJSONAcroform(p, first, pdf);
}
if (all_keys || m->json_keys.count("attachments")) {
doJSONAttachments(p, first, pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (all_keys || m->json_keys.count("encrypt")) {
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
doJSONEncrypt(p, first, pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
if (all_keys || m->json_keys.count("outlines")) {
doJSONOutlines(p, first, pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
// We do objects last so their information is consistent with repairing the page tree. To see
// the original file with any page tree problems and the page tree not flattened, select
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
// qpdf/objects/objectinfo without other keys.
if (all_keys || m->json_keys.count("objects") || m->json_keys.count("qpdf")) {
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
doJSONObjects(p, first, pdf);
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
}
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
if (m->json_version == 1) {
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
// "objectinfo" is not needed for version >1 since you can tell streams from other objects
// in "objects".
Implement JSON v2 output
2022-05-07 17:33:45 +00:00
if (all_keys || m->json_keys.count("objectinfo")) {
doJSONObjectinfo(p, first, pdf);
}
Make "objects" and "pages" consistent in JSON output
2022-05-04 11:32:30 +00:00
}
Top-level json: write incrementally This commit just changes the order in which fields are written to the json without changing their content. All the json files in the test suite were modified with this script to ensure that we didn't get any changes other than ordering. ---------- #!/usr/bin/env python3 import json import sys def json_dumps(data): return json.dumps(data, ensure_ascii=False, indent=2, separators=(',', ': ')) for filename in sys.argv[1:]: with open(filename, 'r') as f: data = json.loads(f.read()) newdata = {} for i in ('version', 'parameters', 'pages', 'pagelabels', 'acroform', 'attachments', 'encrypt', 'outlines', 'objects', 'objectinfo'): if i in data: newdata[i] = data[i] print(json_dumps(newdata)) ----------
2022-05-06 22:25:59 +00:00
JSON::writeDictionaryClose(p, first, 0);
*p << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
Test json against schema only on demand Testing json against schema requires an in-memory copy, so do it only when requested by the test suite.
2022-05-06 21:49:28 +00:00
if (m->test_json_schema) {
// Check against schema
Fix typo in json output key name moddify -> modify. Also carefully spell checked all remaining keys by splitting them into words and running a spell checker, not just relying on visual proofreading. That was the only one.
2022-05-07 15:38:04 +00:00
JSON schema = json_schema(m->json_version, &m->json_keys);
Test json against schema only on demand Testing json against schema requires an in-memory copy, so do it only when requested by the test suite.
2022-05-06 21:49:28 +00:00
std::list<std::string> errors;
JSON captured = JSON::parse(captured_json);
if (!captured.checkSchema(schema, errors)) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
m->log->error("QPDFJob didn't create JSON that complies with its own rules.\n");
Test json against schema only on demand Testing json against schema requires an in-memory copy, so do it only when requested by the test suite.
2022-05-06 21:49:28 +00:00
for (auto const& error: errors) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getError() << error << "\n";
Test json against schema only on demand Testing json against schema requires an in-memory copy, so do it only when requested by the test suite.
2022-05-06 21:49:28 +00:00
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
void
QPDFJob::doInspection(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
auto& cout = *m->log->getInfo();
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->check) {
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
doCheck(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_npages) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob npages");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << pdf.getRoot().getKey("/Pages").getKey("/Count").getIntValue() << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_encryption) {
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
showEncryption(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->check_linearization) {
Fix --check-linearization of non-linearized files (fixes #615)
2022-02-04 00:02:05 +00:00
if (!pdf.isLinearized()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << m->infilename.get() << " is not linearized\n";
Fix --check-linearization of non-linearized files (fixes #615)
2022-02-04 00:02:05 +00:00
} else if (pdf.checkLinearization()) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << m->infilename.get() << ": no linearization errors\n";
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
} else {
m->warnings = true;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_linearization) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
if (pdf.isLinearized()) {
pdf.showLinearizationData();
} else {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
cout << m->infilename.get() << " is not linearized\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_xref) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
pdf.showXRefTable();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if ((m->show_obj > 0) || m->show_trailer) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
doShowObj(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->show_pages) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
doShowPages(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->list_attachments) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
doListAttachments(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->attachment_to_show.empty()) {
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
doShowAttachment(pdf);
}
if (!pdf.getWarnings().empty()) {
m->warnings = true;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
void
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
QPDFJob::doProcessOnce(
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF>& pdf,
QPDFJob: de-templatize do_process and do_process_once
2022-01-05 21:06:10 +00:00
std::function<void(QPDF*, char const*)> fn,
Only update output version from files used as input If we're opening a PDF file to copy its encryption information or attachments, its version doesn't need to influence the output version.
2022-02-08 18:38:03 +00:00
char const* password,
bool empty,
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
bool used_for_input,
bool main_input)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
pdf = std::make_unique<QPDF>();
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
setQPDFOptions(*pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (empty) {
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
pdf->emptyPDF();
} else if (main_input && m->json_input) {
pdf->createFromJSON(m->infilename.get());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
fn(pdf.get(), password);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Only update output version from files used as input If we're opening a PDF file to copy its encryption information or attachments, its version doesn't need to influence the output version.
2022-02-08 18:38:03 +00:00
if (used_for_input) {
m->max_input_version.updateIfGreater(pdf->getVersionAsPDFVersion());
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
void
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
QPDFJob::doProcess(
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF>& pdf,
QPDFJob: de-templatize do_process and do_process_once
2022-01-05 21:06:10 +00:00
std::function<void(QPDF*, char const*)> fn,
Only update output version from files used as input If we're opening a PDF file to copy its encryption information or attachments, its version doesn't need to influence the output version.
2022-02-08 18:38:03 +00:00
char const* password,
bool empty,
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
bool used_for_input,
bool main_input)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
// If a password has been specified but doesn't work, try other passwords that are equivalent in
// different character encodings. This makes it possible to open PDF files that were encrypted
// using incorrect string encodings. For example, if someone used a password encoded in PDF Doc
// encoding or Windows code page 1252 for an AES-encrypted file or a UTF-8-encoded password on
// an RC4-encrypted file, or if the password was properly encoded but the password given here
Fix doc typos caught by m-holger -- thanks
2022-01-06 20:33:29 +00:00
// was incorrectly encoded, there's a good chance we'd succeed here.
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::string ptemp;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (password && (!m->password_is_hex_key)) {
if (m->password_mode == QPDFJob::pm_hex_bytes) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// Special case: handle --password-mode=hex-bytes for input password as well as output
// password
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob input password hex-bytes");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
ptemp = QUtil::hex_decode(password);
password = ptemp.c_str();
}
}
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
if ((password == nullptr) || empty || m->password_is_hex_key || m->suppress_password_recovery) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// There is no password, or we're not doing recovery, so just do the normal processing with
// the supplied password.
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
doProcessOnce(pdf, fn, password, empty, used_for_input, main_input);
return;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
// Get a list of otherwise encoded strings. Keep in scope for this method.
std::vector<std::string> passwords_str = QUtil::possible_repaired_encodings(password);
// Represent to char const*, as required by the QPDF class.
std::vector<char const*> passwords;
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto const& iter: passwords_str) {
passwords.push_back(iter.c_str());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
// We always try the supplied password first because it is the first string returned by
// possible_repaired_encodings. If there is more than one option, go ahead and put the supplied
// password at the end so that it's that decoding attempt whose exception is thrown.
if (passwords.size() > 1) {
passwords.push_back(password);
}
// Try each password. If one works, return the resulting object. If they all fail, throw the
// exception thrown by the final attempt, which, like the first attempt, will be with the
// supplied password.
bool warned = false;
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto iter = passwords.begin(); iter != passwords.end(); ++iter) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
try {
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
doProcessOnce(pdf, fn, *iter, empty, used_for_input, main_input);
return;
Code tidy re-throwing of exceptions Avoid copying exceptions.
2023-03-19 16:57:27 +00:00
} catch (QPDFExc&) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
auto next = iter;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
++next;
if (next == passwords.end()) {
Code tidy re-throwing of exceptions Avoid copying exceptions.
2023-03-19 16:57:27 +00:00
throw;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
if (!warned) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
warned = true;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix
<< ": supplied password didn't work; trying other passwords based on "
"interpreting password with different string encodings\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
// Should not be reachable
throw std::logic_error("do_process returned");
}
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
void
Only update output version from files used as input If we're opening a PDF file to copy its encryption information or attachments, its version doesn't need to influence the output version.
2022-02-08 18:38:03 +00:00
QPDFJob::processFile(
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF>& pdf,
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
char const* filename,
char const* password,
bool used_for_input,
bool main_input)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFJob: de-templatize do_process and do_process_once
2022-01-05 21:06:10 +00:00
auto f1 = std::mem_fn<void(char const*, char const*)>(&QPDF::processFile);
auto fn = std::bind(f1, std::placeholders::_1, filename, std::placeholders::_2);
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
doProcess(pdf, fn, password, strcmp(filename, "") == 0, used_for_input, main_input);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
void
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
QPDFJob::processInputSource(
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF>& pdf,
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
std::shared_ptr<InputSource> is,
char const* password,
bool used_for_input)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFJob: de-templatize do_process and do_process_once
2022-01-05 21:06:10 +00:00
auto f1 = std::mem_fn(&QPDF::processInputSource);
auto fn = std::bind(f1, std::placeholders::_1, is, std::placeholders::_2);
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
doProcess(pdf, fn, password, false, used_for_input, false);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
void
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
QPDFJob::validateUnderOverlay(QPDF& pdf, UnderOverlay* uo)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFPageDocumentHelper main_pdh(pdf);
int main_npages = QIntC::to_int(main_pdh.getAllPages().size());
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
processFile(uo->pdf, uo->filename.c_str(), uo->password.get(), true, false);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageDocumentHelper uo_pdh(*(uo->pdf));
int uo_npages = QIntC::to_int(uo_pdh.getAllPages().size());
try {
QPDFJob: convert Under/Overlay ranges to strings
2022-01-22 23:46:46 +00:00
uo->to_pagenos = QUtil::parse_numrange(uo->to_nr.c_str(), main_npages);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} catch (std::runtime_error& e) {
throw std::runtime_error(
"parsing numeric range for " + uo->which + " \"to\" pages: " + e.what());
}
try {
QPDFJob: convert Under/Overlay ranges to strings
2022-01-22 23:46:46 +00:00
if (uo->from_nr.empty()) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob from_nr from repeat_nr");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
uo->from_nr = uo->repeat_nr;
}
QPDFJob: convert Under/Overlay ranges to strings
2022-01-22 23:46:46 +00:00
uo->from_pagenos = QUtil::parse_numrange(uo->from_nr.c_str(), uo_npages);
if (!uo->repeat_nr.empty()) {
uo->repeat_pagenos = QUtil::parse_numrange(uo->repeat_nr.c_str(), uo_npages);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
} catch (std::runtime_error& e) {
throw std::runtime_error(
"parsing numeric range for " + uo->which + " file " + uo->filename + ": " + e.what());
}
}
static QPDFAcroFormDocumentHelper*
get_afdh_for_qpdf(
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
std::map<unsigned long long, std::shared_ptr<QPDFAcroFormDocumentHelper>>& afdh_map, QPDF* q)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
auto uid = q->getUniqueId();
if (!afdh_map.count(uid)) {
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
afdh_map[uid] = std::make_shared<QPDFAcroFormDocumentHelper>(*q);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
return afdh_map[uid].get();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Refactor overlay/underlay in preparation for change
2023-02-25 16:13:45 +00:00
std::string
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
QPDFJob::doUnderOverlayForPage(
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDF& pdf,
QPDFJob: move some helpers from ArgParser to QPDFJob
2022-01-26 14:09:29 +00:00
UnderOverlay& uo,
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
std::map<int, std::map<size_t, std::vector<int>>>& pagenos,
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
size_t page_idx,
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
size_t uo_idx,
std::map<int, std::map<size_t, QPDFObjectHandle>>& fo,
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::vector<QPDFPageObjectHelper>& pages,
Refactor overlay/underlay in preparation for change
2023-02-25 16:13:45 +00:00
QPDFPageObjectHelper& dest_page)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
int pageno = 1 + QIntC::to_int(page_idx);
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
if (!(pagenos.count(pageno) && pagenos[pageno].count(uo_idx))) {
Refactor overlay/underlay in preparation for change
2023-02-25 16:13:45 +00:00
return "";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::map<unsigned long long, std::shared_ptr<QPDFAcroFormDocumentHelper>> afdh;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto make_afdh = [&](QPDFPageObjectHelper& ph) {
Revert getOwningQPDF, and add getQPDF that returns a reference
2022-09-07 15:29:17 +00:00
QPDF& q = ph.getObjectHandle().getQPDF();
return get_afdh_for_qpdf(afdh, &q);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
};
auto dest_afdh = make_afdh(dest_page);
std::string content;
int min_suffix = 1;
QPDFObjectHandle resources = dest_page.getAttribute("/Resources", true);
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
for (int from_pageno: pagenos[pageno][uo_idx]) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
Include filename in verbose output for overlay/underlay
2024-01-10 21:24:37 +00:00
v << " " << uo.filename << " " << uo.which << " " << from_pageno << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto from_page = pages.at(QIntC::to_size(from_pageno - 1));
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
if (fo[from_pageno].count(uo_idx) == 0) {
fo[from_pageno][uo_idx] = pdf.copyForeignObject(from_page.getFormXObjectForPage());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
// If the same page is overlaid or underlaid multiple times, we'll generate multiple names
// for it, but that's harmless and also a pretty goofy case that's not worth coding around.
std::string name = resources.getUniqueResourceName("/Fx", min_suffix);
QPDFMatrix cm;
std::string new_content = dest_page.placeFormXObject(
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
fo[from_pageno][uo_idx], name, dest_page.getTrimBox().getArrayAsRectangle(), cm);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
dest_page.copyAnnotations(from_page, cm, dest_afdh, make_afdh(from_page));
if (!new_content.empty()) {
Add operator ""_qpdf for creating QPDFObjectHandle literals
2022-02-05 14:18:58 +00:00
resources.mergeResources("<< /XObject << >> >>"_qpdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto xobject = resources.getKey("/XObject");
if (xobject.isDictionary()) {
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
xobject.replaceKey(name, fo[from_pageno][uo_idx]);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
++min_suffix;
content += new_content;
}
}
Refactor overlay/underlay in preparation for change
2023-02-25 16:13:45 +00:00
return content;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: make remaining members private
2022-01-26 21:40:14 +00:00
void
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
QPDFJob::getUOPagenos(
std::vector<QPDFJob::UnderOverlay>& uos,
std::map<int, std::map<size_t, std::vector<int>>>& pagenos)
{
size_t uo_idx = 0;
for (auto const& uo: uos) {
size_t page_idx = 0;
size_t from_size = uo.from_pagenos.size();
size_t repeat_size = uo.repeat_pagenos.size();
for (int to_pageno: uo.to_pagenos) {
if (page_idx < from_size) {
pagenos[to_pageno][uo_idx].push_back(uo.from_pagenos.at(page_idx));
} else if (repeat_size) {
pagenos[to_pageno][uo_idx].push_back(
uo.repeat_pagenos.at((page_idx - from_size) % repeat_size));
}
++page_idx;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
++uo_idx;
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
}
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
void
QPDFJob::handleUnderOverlay(QPDF& pdf)
{
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
if (m->underlay.empty() && m->overlay.empty()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return;
}
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
for (auto& uo: m->underlay) {
validateUnderOverlay(pdf, &uo);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
for (auto& uo: m->overlay) {
validateUnderOverlay(pdf, &uo);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
// First map key is 1-based page number. Second is index into the overlay/underlay vector. Watch
// out to not reverse the keys or be off by one.
std::map<int, std::map<size_t, std::vector<int>>> underlay_pagenos;
std::map<int, std::map<size_t, std::vector<int>>> overlay_pagenos;
getUOPagenos(m->underlay, underlay_pagenos);
getUOPagenos(m->overlay, overlay_pagenos);
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": processing underlay/overlay\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
auto get_pages = [](std::vector<UnderOverlay>& v,
std::vector<std::vector<QPDFPageObjectHelper>>& v_out) {
for (auto const& uo: v) {
if (uo.pdf) {
v_out.push_back(QPDFPageDocumentHelper(*(uo.pdf)).getAllPages());
}
}
};
std::vector<std::vector<QPDFPageObjectHelper>> upages;
get_pages(m->underlay, upages);
std::vector<std::vector<QPDFPageObjectHelper>> opages;
get_pages(m->overlay, opages);
std::map<int, std::map<size_t, QPDFObjectHandle>> underlay_fo;
std::map<int, std::map<size_t, QPDFObjectHandle>> overlay_fo;
QPDFPageDocumentHelper main_pdh(pdf);
auto main_pages = main_pdh.getAllPages();
size_t main_npages = main_pages.size();
for (size_t page_idx = 0; page_idx < main_npages; ++page_idx) {
auto pageno = QIntC::to_int(page_idx) + 1;
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose(
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
[&](Pipeline& v, std::string const& prefix) { v << " page " << pageno << "\n"; });
if (underlay_pagenos[pageno].empty() && overlay_pagenos[pageno].empty()) {
Refactor overlay/underlay in preparation for change
2023-02-25 16:13:45 +00:00
continue;
}
Overlay/underlay: capture origial page as form XObject (fixes #904)
2023-02-25 17:55:47 +00:00
// This code converts the original page, any underlays, and any overlays to form XObjects.
// Then it concatenates display of all underlays, the original page, and all overlays. Prior
// to 11.3.0, the original page contents were wrapped in q/Q, but this didn't work if the
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
// original page had unbalanced q/Q operators. See GitHub issue #904.
auto& dest_page = main_pages.at(page_idx);
Overlay/underlay: capture origial page as form XObject (fixes #904)
2023-02-25 17:55:47 +00:00
auto dest_page_oh = dest_page.getObjectHandle();
auto this_page_fo = dest_page.getFormXObjectForPage();
// The resulting form xobject lazily reads the content from the original page, which we are
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
// going to replace. Therefore, we have to explicitly copy it.
Overlay/underlay: capture origial page as form XObject (fixes #904)
2023-02-25 17:55:47 +00:00
auto content_data = this_page_fo.getRawStreamData();
this_page_fo.replaceStreamData(content_data, QPDFObjectHandle(), QPDFObjectHandle());
auto resources =
dest_page_oh.replaceKeyAndGetNew("/Resources", "<< /XObject << >> >>"_qpdf);
resources.getKey("/XObject").replaceKeyAndGetNew("/Fx0", this_page_fo);
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
size_t uo_idx{0};
std::string content;
for (auto& underlay: m->underlay) {
content += doUnderOverlayForPage(
pdf,
underlay,
underlay_pagenos,
page_idx,
uo_idx,
underlay_fo,
upages[uo_idx],
dest_page);
++uo_idx;
}
Overlay/underlay: capture origial page as form XObject (fixes #904)
2023-02-25 17:55:47 +00:00
content += dest_page.placeFormXObject(
this_page_fo,
"/Fx0",
dest_page.getMediaBox().getArrayAsRectangle(),
true,
false,
false);
Honor repeated overlay/underlay
2024-01-10 21:07:47 +00:00
uo_idx = 0;
for (auto& overlay: m->overlay) {
content += doUnderOverlayForPage(
pdf,
overlay,
overlay_pagenos,
page_idx,
uo_idx,
overlay_fo,
opages[uo_idx],
dest_page);
++uo_idx;
}
Overlay/underlay: capture origial page as form XObject (fixes #904)
2023-02-25 17:55:47 +00:00
dest_page_oh.replaceKey("/Contents", pdf.newStream(content));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Programmatically apply new formatting to code Run this: for i in **/*.cc **/*.c **/*.h **/*.hh; do clang-format < $i >| $i.new && mv $i.new $i done
2022-04-02 21:14:10 +00:00
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
static void
maybe_set_pagemode(QPDF& pdf, std::string const& pagemode)
{
auto root = pdf.getRoot();
if (root.getKey("/PageMode").isNull()) {
root.replaceKey("/PageMode", QPDFObjectHandle::newName(pagemode));
}
}
void
QPDFJob::addAttachments(QPDF& pdf)
{
maybe_set_pagemode(pdf, "/UseAttachments");
QPDFEmbeddedFileDocumentHelper efdh(pdf);
std::vector<std::string> duplicated_keys;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
for (auto const& to_add: m->attachments_to_add) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if ((!to_add.replace) && efdh.getEmbeddedFile(to_add.key)) {
duplicated_keys.push_back(to_add.key);
continue;
}
auto fs = QPDFFileSpecObjectHelper::createFileSpec(pdf, to_add.filename, to_add.path);
if (!to_add.description.empty()) {
fs.setDescription(to_add.description);
}
auto efs = QPDFEFStreamObjectHelper(fs.getEmbeddedFileStream());
efs.setCreationDate(to_add.creationdate).setModDate(to_add.moddate);
if (!to_add.mimetype.empty()) {
efs.setSubtype(to_add.mimetype);
}
efdh.replaceEmbeddedFile(to_add.key, fs);
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": attached " << to_add.path << " as " << to_add.filename << " with key "
<< to_add.key << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (!duplicated_keys.empty()) {
std::string message;
for (auto const& k: duplicated_keys) {
if (!message.empty()) {
message += ", ";
}
message += k;
}
message = pdf.getFilename() +
" already has attachments with the following keys: " + message +
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
"; use --replace to replace or --key to specify a different key";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
throw std::runtime_error(message);
}
}
void
QPDFJob::copyAttachments(QPDF& pdf)
{
maybe_set_pagemode(pdf, "/UseAttachments");
QPDFEmbeddedFileDocumentHelper efdh(pdf);
std::vector<std::string> duplicates;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
for (auto const& to_copy: m->attachments_to_copy) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": copying attachments from " << to_copy.path << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF> other;
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
processFile(other, to_copy.path.c_str(), to_copy.password.c_str(), false, false);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFEmbeddedFileDocumentHelper other_efdh(*other);
auto other_attachments = other_efdh.getEmbeddedFiles();
for (auto const& iter: other_attachments) {
std::string new_key = to_copy.prefix + iter.first;
if (efdh.getEmbeddedFile(new_key)) {
duplicates.push_back("file: " + to_copy.path + ", key: " + new_key);
} else {
auto new_fs_oh = pdf.copyForeignObject(iter.second->getObjectHandle());
efdh.replaceEmbeddedFile(new_key, QPDFFileSpecObjectHelper(new_fs_oh));
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << " " << iter.first << " -> " << new_key << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
if (other->anyWarnings()) {
m->warnings = true;
}
}
if (!duplicates.empty()) {
std::string message;
for (auto const& i: duplicates) {
if (!message.empty()) {
message += "; ";
}
message += i;
}
message = pdf.getFilename() +
" already has attachments with keys that conflict with attachments from other files: " +
message +
". Use --prefix with --copy-attachments-from or manually copy individual attachments.";
throw std::runtime_error(message);
}
}
void
QPDFJob::handleTransformations(QPDF& pdf)
{
QPDFPageDocumentHelper dh(pdf);
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::shared_ptr<QPDFAcroFormDocumentHelper> afdh;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto make_afdh = [&]() {
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
if (!afdh.get()) {
afdh = std::make_shared<QPDFAcroFormDocumentHelper>(pdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
};
Implement --remove-restrictions (fixes #833)
2023-01-28 18:41:58 +00:00
if (m->remove_restrictions) {
Implement --disable-signatures (fixes #1015)
2023-12-23 13:44:42 +00:00
make_afdh();
afdh->disableDigitalSignatures();
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->externalize_inline_images || (m->optimize_images && (!m->keep_inline_images))) {
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& ph: dh.getAllPages()) {
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
ph.externalizeInlineImages(m->ii_min_bytes);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->optimize_images) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
int pageno = 0;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& ph: dh.getAllPages()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
++pageno;
Improve --optimize-images to find images nested within XObjects
2023-03-13 16:57:00 +00:00
ph.forEachImage(
true,
[this, pageno, &pdf](
QPDFObjectHandle& obj, QPDFObjectHandle& xobj_dict, std::string const& key) {
auto io = std::make_unique<ImageOptimizer>(
*this, m->oi_min_width, m->oi_min_height, m->oi_min_area, obj);
if (io->evaluate("image " + key + " on page " + std::to_string(pageno))) {
QPDFObjectHandle new_image = pdf.newStream();
new_image.replaceDict(obj.getDict().shallowCopy());
new_image.replaceStreamData(
std::move(io),
QPDFObjectHandle::newName("/DCTDecode"),
QPDFObjectHandle::newNull());
xobj_dict.replaceKey(key, new_image);
}
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->generate_appearances) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
make_afdh();
afdh->generateAppearancesIfNeeded();
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->flatten_annotations) {
dh.flattenAnnotations(m->flatten_annotations_required, m->flatten_annotations_forbidden);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->coalesce_contents) {
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& page: dh.getAllPages()) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
page.coalesceContentStreams();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->flatten_rotation) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
make_afdh();
for (auto& page: dh.getAllPages()) {
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
page.flattenRotation(afdh.get());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->remove_page_labels) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
pdf.getRoot().removeKey("/PageLabels");
}
Implement --set-page-labels and supporting API (fixes #939)
2024-01-05 21:11:09 +00:00
if (!m->page_label_specs.empty()) {
auto nums = QPDFObjectHandle::newArray();
auto n_pages = QIntC::to_int(dh.getAllPages().size());
int last_page_seen{0};
for (auto& spec: m->page_label_specs) {
if (spec.first_page < 0) {
spec.first_page = n_pages + 1 + spec.first_page;
}
if (last_page_seen == 0) {
if (spec.first_page != 1) {
throw std::runtime_error(
"the first page label specification must start with page 1");
}
} else if (spec.first_page <= last_page_seen) {
throw std::runtime_error(
"page label specifications must be in order by first page");
}
if (spec.first_page > n_pages) {
throw std::runtime_error(
"page label spec: page " + std::to_string(spec.first_page) +
" is more than the total number of pages (" + std::to_string(n_pages) + ")");
}
last_page_seen = spec.first_page;
nums.appendItem(QPDFObjectHandle::newInteger(spec.first_page - 1));
nums.appendItem(QPDFPageLabelDocumentHelper::pageLabelDict(
spec.label_type, spec.start_num, spec.prefix));
}
auto page_labels = QPDFObjectHandle::newDictionary();
page_labels.replaceKey("/Nums", nums);
pdf.getRoot().replaceKey("/PageLabels", page_labels);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->attachments_to_remove.empty()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFEmbeddedFileDocumentHelper efdh(pdf);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
for (auto const& key: m->attachments_to_remove) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (efdh.removeEmbeddedFile(key)) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": removed attachment " << key << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
throw std::runtime_error("attachment " + key + " not found");
}
}
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->attachments_to_add.empty()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
addAttachments(pdf);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->attachments_to_copy.empty()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
copyAttachments(pdf);
}
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
bool
QPDFJob::shouldRemoveUnreferencedResources(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->remove_unreferenced_page_resources == QPDFJob::re_no) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return false;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
} else if (m->remove_unreferenced_page_resources == QPDFJob::re_yes) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return true;
}
// Unreferenced resources are common in files where resources dictionaries are shared across
// pages. As a heuristic, we look in the file for shared resources dictionaries or shared
// XObject subkeys of resources dictionaries either on pages or on form XObjects in pages. If we
// find any, then there is a higher likelihood that the expensive process of finding
// unreferenced resources is worth it.
// Return true as soon as we find any shared resources.
Use QPDFObjGen::set in QPDFJob::shouldRemoveUnreferencedResources
2023-04-02 15:56:42 +00:00
QPDFObjGen::set resources_seen; // shared resources detection
QPDFObjGen::set nodes_seen; // loop detection
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": " << pdf.getFilename() << ": checking for shared resources\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::list<QPDFObjectHandle> queue;
queue.push_back(pdf.getRoot().getKey("/Pages"));
while (!queue.empty()) {
QPDFObjectHandle node = *queue.begin();
queue.pop_front();
QPDFObjGen og = node.getObjGen();
Use QPDFObjGen::set in QPDFJob::shouldRemoveUnreferencedResources
2023-04-02 15:56:42 +00:00
if (!nodes_seen.add(og)) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
continue;
}
QPDFObjectHandle dict = node.isStream() ? node.getDict() : node;
QPDFObjectHandle kids = dict.getKey("/Kids");
if (kids.isArray()) {
// This is a non-leaf node.
if (dict.hasKey("/Resources")) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob found resources in non-leaf");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << " found resources in non-leaf page node " << og.unparse(' ') << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return true;
}
int n = kids.getArrayNItems();
for (int i = 0; i < n; ++i) {
queue.push_back(kids.getArrayItem(i));
}
} else {
// This is a leaf node or a form XObject.
QPDFObjectHandle resources = dict.getKey("/Resources");
if (resources.isIndirect()) {
Use QPDFObjGen::set in QPDFJob::shouldRemoveUnreferencedResources
2023-04-02 15:56:42 +00:00
if (!resources_seen.add(resources)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob found shared resources in leaf");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << " found shared resources in leaf node " << og.unparse(' ') << ": "
Use QPDFObjGen::set in QPDFJob::shouldRemoveUnreferencedResources
2023-04-02 15:56:42 +00:00
<< resources.getObjGen().unparse(' ') << "\n";
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return true;
}
}
QPDFObjectHandle xobject =
(resources.isDictionary() ? resources.getKey("/XObject")
: QPDFObjectHandle::newNull());
if (xobject.isIndirect()) {
Use QPDFObjGen::set in QPDFJob::shouldRemoveUnreferencedResources
2023-04-02 15:56:42 +00:00
if (!resources_seen.add(xobject)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob found shared xobject in leaf");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << " found shared xobject in leaf node " << og.unparse(' ') << ": "
Use QPDFObjGen::set in QPDFJob::shouldRemoveUnreferencedResources
2023-04-02 15:56:42 +00:00
<< xobject.getObjGen().unparse(' ') << "\n";
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return true;
}
}
if (xobject.isDictionary()) {
for (auto const& k: xobject.getKeys()) {
QPDFObjectHandle xobj = xobject.getKey(k);
Fix tests for Form XObjects Remove test for type == /XObject in QPDFObjectHandle::isFormXObject as type value is optional (as per spec 8.10.2). Replace code to test for /Form in QPDFJob::shouldRemoveUnreferencedResources with a call to isFormXObject.
2022-02-09 13:54:33 +00:00
if (xobj.isFormXObject()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
queue.push_back(xobj);
}
}
}
}
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": no shared resources found\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
return false;
}
static QPDFObjectHandle
added_page(QPDF& pdf, QPDFObjectHandle page)
{
QPDFObjectHandle result = page;
Revert getOwningQPDF, and add getQPDF that returns a reference
2022-09-07 15:29:17 +00:00
if (&page.getQPDF() != &pdf) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// Calling copyForeignObject on an object we already copied will give us the already
// existing copy.
result = pdf.copyForeignObject(page);
}
return result;
}
static QPDFObjectHandle
added_page(QPDF& pdf, QPDFPageObjectHelper page)
{
return added_page(pdf, page.getObjectHandle());
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
QPDFJob::handlePageSpecs(QPDF& pdf, std::vector<std::unique_ptr<QPDF>>& page_heap)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
// Parse all page specifications and translate them into lists of actual pages.
// Handle "." as a shortcut for the input file
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto& page_spec: m->page_specs) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (page_spec.filename == ".") {
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
page_spec.filename = m->infilename.get();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Allow --file and --range with --pages Accept --file and --range as named parameters in additional to allowing positional arguments. This is in preparation for adding additional flags.
2024-01-09 16:41:18 +00:00
if (page_spec.range.empty()) {
page_spec.range = "1-z";
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->keep_files_open_set) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// Count the number of distinct files to determine whether we should keep files open or not.
// Rather than trying to code some portable heuristic based on OS limits, just hard-code
// this at a given number and allow users to override.
std::set<std::string> filenames;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
for (auto& page_spec: m->page_specs) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
filenames.insert(page_spec.filename);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->keep_files_open = (filenames.size() <= m->keep_files_open_threshold);
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob automatically set keep files open", m->keep_files_open ? 0 : 1);
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": selecting --keep-open-files=" << (m->keep_files_open ? "y" : "n")
<< "\n";
Minor code cleanup
2022-01-07 12:29:53 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
// Create a QPDF object for each file that we may take pages from.
std::map<std::string, QPDF*> page_spec_qpdfs;
std::map<std::string, ClosedFileInputSource*> page_spec_cfis;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
page_spec_qpdfs[m->infilename.get()] = &pdf;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::vector<QPDFPageData> parsed_specs;
std::map<unsigned long long, std::set<QPDFObjGen>> copied_pages;
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto& page_spec: m->page_specs) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (page_spec_qpdfs.count(page_spec.filename) == 0) {
// Open the PDF file and store the QPDF object. Throw a std::shared_ptr to the qpdf into
// a heap so that it survives through copying to the output but gets cleaned up
// automatically at the end. Do not canonicalize the file name. Using two different
Fix doc typos caught by m-holger -- thanks
2022-01-06 20:33:29 +00:00
// paths to refer to the same file is a documented workaround for duplicating a page. If
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// you are using this an example of how to do this with the API, you can just create two
// different QPDF objects to the same underlying file with the same path to achieve the
Fix a few things found by CLion
2023-09-03 12:02:05 +00:00
// same effect.
QPDFJob: convert PageSpec to used shared pointer
2022-01-22 23:43:05 +00:00
char const* password = page_spec.password.get();
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
if ((!m->encryption_file.empty()) && (password == nullptr) &&
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
(page_spec.filename == m->encryption_file)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob pages encryption password");
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
password = m->encryption_file_password.get();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": processing " << page_spec.filename << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
Replace PointerHolder with std::shared_ptr in library sources only (patrepl and cleanpatch are my own utilities) patrepl s/PointerHolder/std::shared_ptr/g {include,libqpdf}/qpdf/*.hh patrepl s/PointerHolder/std::shared_ptr/g libqpdf/*.cc patrepl s/make_pointer_holder/std::make_shared/g libqpdf/*.cc patrepl s/make_array_pointer_holder/QUtil::make_shared_array/g libqpdf/*.cc patrepl s,qpdf/std::shared_ptr,qpdf/PointerHolder, **/*.cc **/*.hh git restore include/qpdf/PointerHolder.hh cleanpatch ./format-code
2022-04-09 18:35:56 +00:00
std::shared_ptr<InputSource> is;
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
ClosedFileInputSource* cis = nullptr;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->keep_files_open) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob keep files open n");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
cis = new ClosedFileInputSource(page_spec.filename.c_str());
Replace PointerHolder with std::shared_ptr in library sources only (patrepl and cleanpatch are my own utilities) patrepl s/PointerHolder/std::shared_ptr/g {include,libqpdf}/qpdf/*.hh patrepl s/PointerHolder/std::shared_ptr/g libqpdf/*.cc patrepl s/make_pointer_holder/std::make_shared/g libqpdf/*.cc patrepl s/make_array_pointer_holder/QUtil::make_shared_array/g libqpdf/*.cc patrepl s,qpdf/std::shared_ptr,qpdf/PointerHolder, **/*.cc **/*.hh git restore include/qpdf/PointerHolder.hh cleanpatch ./format-code
2022-04-09 18:35:56 +00:00
is = std::shared_ptr<InputSource>(cis);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
cis->stayOpen(true);
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob keep files open y");
Add new FileInputSource constructors
2022-05-04 16:02:39 +00:00
FileInputSource* fis = new FileInputSource(page_spec.filename.c_str());
Replace PointerHolder with std::shared_ptr in library sources only (patrepl and cleanpatch are my own utilities) patrepl s/PointerHolder/std::shared_ptr/g {include,libqpdf}/qpdf/*.hh patrepl s/PointerHolder/std::shared_ptr/g libqpdf/*.cc patrepl s/make_pointer_holder/std::make_shared/g libqpdf/*.cc patrepl s/make_array_pointer_holder/QUtil::make_shared_array/g libqpdf/*.cc patrepl s,qpdf/std::shared_ptr,qpdf/PointerHolder, **/*.cc **/*.hh git restore include/qpdf/PointerHolder.hh cleanpatch ./format-code
2022-04-09 18:35:56 +00:00
is = std::shared_ptr<InputSource>(fis);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF> qpdf_sp;
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
processInputSource(qpdf_sp, is, password, true);
page_spec_qpdfs[page_spec.filename] = qpdf_sp.get();
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
page_heap.push_back(std::move(qpdf_sp));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (cis) {
cis->stayOpen(false);
page_spec_cfis[page_spec.filename] = cis;
}
}
// Read original pages from the PDF, and parse the page range associated with this
// occurrence of the file.
Code tidy - Clang-Tidy rule modernize-use-emplace
2023-05-27 22:49:18 +00:00
parsed_specs.emplace_back(
page_spec.filename, page_spec_qpdfs[page_spec.filename], page_spec.range);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
std::map<unsigned long long, bool> remove_unreferenced;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->remove_unreferenced_page_resources != QPDFJob::re_no) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto const& iter: page_spec_qpdfs) {
std::string const& filename = iter.first;
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
ClosedFileInputSource* cis = nullptr;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (page_spec_cfis.count(filename)) {
cis = page_spec_cfis[filename];
cis->stayOpen(true);
}
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
QPDF& other(*(iter.second));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto other_uuid = other.getUniqueId();
if (remove_unreferenced.count(other_uuid) == 0) {
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
remove_unreferenced[other_uuid] = shouldRemoveUnreferencedResources(other);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
if (cis) {
cis->stayOpen(false);
}
}
}
// Clear all pages out of the primary QPDF's pages tree but leave the objects in place in the
// file so they can be re-added without changing their object numbers. This enables other things
// in the original file, such as outlines, to continue to work.
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": removing unreferenced pages from primary input\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageDocumentHelper dh(pdf);
std::vector<QPDFPageObjectHelper> orig_pages = dh.getAllPages();
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto const& page: orig_pages) {
dh.removePage(page);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
auto n_collate = m->collate.size();
auto n_specs = parsed_specs.size();
Fix arg parsing check with --collate The check for the number of items was in the wrong place.
2024-01-09 13:35:10 +00:00
if (!(n_collate == 0 || n_collate == 1 || n_collate == n_specs)) {
usage("--pages: if --collate has more than one value, it must have one value per page "
"specification");
}
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
if (n_collate > 0 && n_specs > 1) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// Collate the pages by selecting one page from each spec in order. When a spec runs out of
// pages, stop selecting from it.
std::vector<QPDFPageData> new_parsed_specs;
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
// Make sure we have a collate value for each spec. We have already checked that a non-empty
// collate has either one value or one value per spec.
for (auto i = n_collate; i < n_specs; ++i) {
m->collate.push_back(m->collate.at(0));
}
std::vector<size_t> cur_page(n_specs, 0);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
bool got_pages = true;
while (got_pages) {
got_pages = false;
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
for (size_t i = 0; i < n_specs; ++i) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageData& page_data = parsed_specs.at(i);
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
for (size_t j = 0; j < m->collate.at(i); ++j) {
if (cur_page.at(i) + j < page_data.selected_pages.size()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
got_pages = true;
Code tidy - Clang-Tidy rule modernize-use-emplace
2023-05-27 22:49:18 +00:00
new_parsed_specs.emplace_back(
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
page_data, page_data.selected_pages.at(cur_page.at(i) + j));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
Support comma-separated numeric values with --collate (fixes #505)
2024-01-01 23:55:45 +00:00
cur_page.at(i) += m->collate.at(i);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
parsed_specs = new_parsed_specs;
}
// Add all the pages from all the files in the order specified. Keep track of any pages from the
// original file that we are selecting.
std::set<int> selected_from_orig;
std::vector<QPDFObjectHandle> new_labels;
bool any_page_labels = false;
int out_pageno = 0;
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::map<unsigned long long, std::shared_ptr<QPDFAcroFormDocumentHelper>> afdh_map;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
auto this_afdh = get_afdh_for_qpdf(afdh_map, &pdf);
std::set<QPDFObjGen> referenced_fields;
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto& page_data: parsed_specs) {
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
ClosedFileInputSource* cis = nullptr;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (page_spec_cfis.count(page_data.filename)) {
cis = page_spec_cfis[page_data.filename];
cis->stayOpen(true);
}
QPDFPageLabelDocumentHelper pldh(*page_data.qpdf);
auto other_afdh = get_afdh_for_qpdf(afdh_map, page_data.qpdf);
if (pldh.hasPageLabels()) {
any_page_labels = true;
}
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": adding pages from " << page_data.filename << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto pageno_iter: page_data.selected_pages) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// Pages are specified from 1 but numbered from 0 in the vector
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
int pageno = pageno_iter - 1;
pldh.getLabelsForPageRange(pageno, pageno, out_pageno++, new_labels);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageObjectHelper to_copy = page_data.orig_pages.at(QIntC::to_size(pageno));
QPDFObjGen to_copy_og = to_copy.getObjectHandle().getObjGen();
unsigned long long from_uuid = page_data.qpdf->getUniqueId();
if (copied_pages[from_uuid].count(to_copy_og)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC(
"qpdf",
"QPDFJob copy same page more than once",
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
(page_data.qpdf == &pdf) ? 0 : 1);
to_copy = to_copy.shallowCopyPage();
} else {
copied_pages[from_uuid].insert(to_copy_og);
if (remove_unreferenced[from_uuid]) {
to_copy.removeUnreferencedResources();
}
}
dh.addPage(to_copy, false);
bool first_copy_from_orig = false;
bool this_file = (page_data.qpdf == &pdf);
if (this_file) {
// This is a page from the original file. Keep track of the fact that we are using
// it.
first_copy_from_orig = (selected_from_orig.count(pageno) == 0);
selected_from_orig.insert(pageno);
}
auto new_page = added_page(pdf, to_copy);
// Try to avoid gratuitously renaming fields. In the case of where we're just extracting
// a bunch of pages from the original file and not copying any page more than once,
// there's no reason to do anything with the fields. Since we don't remove fields from
// the original file until all copy operations are completed, any foreign pages that
// conflict with original pages will be adjusted. If we copy any page from the original
// file more than once, that page would be in conflict with the previous copy of itself.
Ensure copied annotations are fixed (fixes #600) Case where pages from a main input without /AcroForm key were duplicated was omitted
2023-06-15 13:58:14 +00:00
if ((!this_file && other_afdh->hasAcroForm()) || !first_copy_from_orig) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (!this_file) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob copy fields not this file");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else if (!first_copy_from_orig) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob copy fields non-first from orig");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
try {
this_afdh->fixCopiedAnnotations(
new_page, to_copy.getObjectHandle(), *other_afdh, &referenced_fields);
} catch (std::exception& e) {
Add new QPDF::warn that takes most of QPDFExc's arguments
2022-04-23 22:03:44 +00:00
pdf.warn(
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
qpdf_e_damaged_pdf,
"",
0,
Update some code manually to get better formatting results Add comments to force line breaks, parenthesize function arguments that are contatenated strings, etc. -- these kinds of changes improve clang-format's results and also cause emacs cc-mode to match clang-format. After this type of change, most of the time, when clang-format and emacs disagree, clang-format is better.
2022-04-03 20:10:27 +00:00
("Exception caught while fixing copied annotations. This may be a qpdf "
"bug. " +
Add new QPDF::warn that takes most of QPDFExc's arguments
2022-04-23 22:03:44 +00:00
std::string("Exception: ") + e.what()));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
if (cis) {
cis->stayOpen(false);
}
}
if (any_page_labels) {
QPDFObjectHandle page_labels = QPDFObjectHandle::newDictionary();
page_labels.replaceKey("/Nums", QPDFObjectHandle::newArray(new_labels));
pdf.getRoot().replaceKey("/PageLabels", page_labels);
}
// Delete page objects for unused page in primary. This prevents those objects from being
// preserved by being referred to from other places, such as the outlines dictionary. Also make
// sure we keep form fields from pages we preserved.
for (size_t pageno = 0; pageno < orig_pages.size(); ++pageno) {
auto page = orig_pages.at(pageno);
if (selected_from_orig.count(QIntC::to_int(pageno))) {
for (auto field: this_afdh->getFormFieldsForPage(page)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob pages keeping field from original");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
referenced_fields.insert(field.getObjectHandle().getObjGen());
}
} else {
pdf.replaceObject(page.getObjectHandle().getObjGen(), QPDFObjectHandle::newNull());
}
}
// Remove unreferenced form fields
if (this_afdh->hasAcroForm()) {
auto acroform = pdf.getRoot().getKey("/AcroForm");
auto fields = acroform.getKey("/Fields");
if (fields.isArray()) {
auto new_fields = QPDFObjectHandle::newArray();
if (fields.isIndirect()) {
new_fields = pdf.makeIndirectObject(new_fields);
}
for (auto const& field: fields.aitems()) {
if (referenced_fields.count(field.getObjGen())) {
new_fields.appendItem(field);
}
}
if (new_fields.getArrayNItems() > 0) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob keep some fields in pages");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
acroform.replaceKey("/Fields", new_fields);
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob no more fields in pages");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
pdf.getRoot().removeKey("/AcroForm");
}
}
}
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
void
QPDFJob::handleRotations(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFPageDocumentHelper dh(pdf);
std::vector<QPDFPageObjectHelper> pages = dh.getAllPages();
int npages = QIntC::to_int(pages.size());
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto const& iter: m->rotations) {
std::string const& range = iter.first;
QPDFJob::RotationSpec const& rspec = iter.second;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// range has been previously validated
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (int pageno_iter: QUtil::parse_numrange(range.c_str(), npages)) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
int pageno = pageno_iter - 1;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if ((pageno >= 0) && (pageno < npages)) {
pages.at(QIntC::to_size(pageno)).rotatePage(rspec.angle, rspec.relative);
}
}
}
}
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
void
QPDFJob::maybeFixWritePassword(int R, std::string& password)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
switch (m->password_mode) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
case QPDFJob::pm_bytes:
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob password mode bytes");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
break;
case QPDFJob::pm_hex_bytes:
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob password mode hex-bytes");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
password = QUtil::hex_decode(password);
break;
case QPDFJob::pm_unicode:
case QPDFJob::pm_auto:
{
bool has_8bit_chars;
bool is_valid_utf8;
bool is_utf16;
QUtil::analyze_encoding(password, has_8bit_chars, is_valid_utf8, is_utf16);
if (!has_8bit_chars) {
return;
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->password_mode == QPDFJob::pm_unicode) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (!is_valid_utf8) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob password not unicode");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
throw std::runtime_error("supplied password is not valid UTF-8");
}
if (R < 5) {
std::string encoded;
if (!QUtil::utf8_to_pdf_doc(password, encoded)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob password not encodable");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
throw std::runtime_error("supplied password cannot be encoded for 40-bit "
"or 128-bit encryption formats");
}
password = encoded;
}
} else {
if ((R < 5) && is_valid_utf8) {
std::string encoded;
if (QUtil::utf8_to_pdf_doc(password, encoded)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob auto-encode password");
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix
<< ": automatically converting Unicode password to single-byte "
"encoding as required for 40-bit or 128-bit encryption\n";
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
password = encoded;
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob bytes fallback warning");
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
*m->log->getError()
<< m->message_prefix
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
<< ": WARNING: supplied password looks like a Unicode password with "
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
"characters not allowed in passwords for 40-bit and 128-bit "
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
"encryption; most readers will not be able to open this file with "
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
"the supplied password. (Use --password-mode=bytes to suppress this "
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
"warning and use the password anyway.)\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
} else if ((R >= 5) && (!is_valid_utf8)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob invalid utf-8 in auto");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
throw std::runtime_error(
"supplied password is not a valid Unicode password, which is required for "
"256-bit encryption; to really use this password, rerun with the "
"--password-mode=bytes option");
}
}
}
break;
}
}
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
void
Remove unused argument in private setWriterOptions method
2024-01-04 12:16:47 +00:00
QPDFJob::setEncryptionOptions(QPDFWriter& w)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
int R = 0;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->keylen == 40) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
R = 2;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
} else if (m->keylen == 128) {
if (m->force_V4 || m->cleartext_metadata || m->use_aes) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
R = 4;
} else {
R = 3;
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
} else if (m->keylen == 256) {
if (m->force_R5) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
R = 5;
} else {
R = 6;
}
} else {
throw std::logic_error("bad encryption keylen");
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if ((R > 3) && (m->r3_accessibility == false)) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getError() << m->message_prefix << ": -accessibility=n is ignored for modern"
<< " encryption formats\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
maybeFixWritePassword(R, m->user_password);
maybeFixWritePassword(R, m->owner_password);
if ((R < 4) || ((R == 4) && (!m->use_aes))) {
if (!m->allow_weak_crypto) {
Using insecure crytpo from the CLI is now an error by default
2022-04-30 19:41:14 +00:00
QTC::TC("qpdf", "QPDFJob weak crypto error");
QPDFJob increment: remove std::cout, std::cerr, whoami Remove remaining temporary duplication of hard-coded values and direct access to std::cout, std::cerr, and whoami in favor of parameters in QPDFJob. This moves a few more static methods into QPDFJob member functions.
2022-01-05 20:01:35 +00:00
*m->log->getError()
<< m->message_prefix
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
<< ": refusing to write a file with RC4, a weak cryptographic algorithm\n"
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
"Please use 256-bit keys for better security.\n"
"Pass --allow-weak-crypto to enable writing insecure files.\n"
Change the output of --json to use "qpdf" instead of "objects"
2022-07-31 00:53:30 +00:00
"See also https://qpdf.readthedocs.io/en/stable/weak-crypto.html\n";
Mark weak encryption with API changes (fixes #576)
2022-04-30 20:05:28 +00:00
throw std::runtime_error("refusing to write a file with weak crypto");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
switch (R) {
case 2:
Mark weak encryption with API changes (fixes #576)
2022-04-30 20:05:28 +00:00
w.setR2EncryptionParametersInsecure(
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->user_password.c_str(),
m->owner_password.c_str(),
m->r2_print,
m->r2_modify,
m->r2_extract,
m->r2_annotate);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
break;
case 3:
Mark weak encryption with API changes (fixes #576)
2022-04-30 20:05:28 +00:00
w.setR3EncryptionParametersInsecure(
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->user_password.c_str(),
m->owner_password.c_str(),
m->r3_accessibility,
m->r3_extract,
m->r3_assemble,
m->r3_annotate_and_form,
m->r3_form_filling,
m->r3_modify_other,
m->r3_print);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
break;
case 4:
Mark weak encryption with API changes (fixes #576)
2022-04-30 20:05:28 +00:00
w.setR4EncryptionParametersInsecure(
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->user_password.c_str(),
m->owner_password.c_str(),
m->r3_accessibility,
m->r3_extract,
m->r3_assemble,
m->r3_annotate_and_form,
m->r3_form_filling,
m->r3_modify_other,
m->r3_print,
!m->cleartext_metadata,
m->use_aes);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
break;
case 5:
w.setR5EncryptionParameters(
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->user_password.c_str(),
m->owner_password.c_str(),
m->r3_accessibility,
m->r3_extract,
m->r3_assemble,
m->r3_annotate_and_form,
m->r3_form_filling,
m->r3_modify_other,
m->r3_print,
!m->cleartext_metadata);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
break;
case 6:
w.setR6EncryptionParameters(
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->user_password.c_str(),
m->owner_password.c_str(),
m->r3_accessibility,
m->r3_extract,
m->r3_assemble,
m->r3_annotate_and_form,
m->r3_form_filling,
m->r3_modify_other,
m->r3_print,
!m->cleartext_metadata);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
break;
default:
throw std::logic_error("bad encryption R value");
break;
}
}
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
static void
parse_version(std::string const& full_version_string, std::string& version, int& extension_level)
{
Improve use of std::unique_ptr * Use unique_ptr in place of shared_ptr in some cases * unique_ptr for arrays does not require a custom deleter * use std::make_unique (c++14) where possible
2022-02-05 13:15:07 +00:00
auto vp = QUtil::make_unique_cstr(full_version_string);
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
char* v = vp.get();
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
char* p1 = strchr(v, '.');
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
char* p2 = (p1 ? strchr(1 + p1, '.') : nullptr);
QPDFJob: reorder functions, no other changes
2022-01-05 21:50:18 +00:00
if (p2 && *(p2 + 1)) {
*p2++ = '\0';
extension_level = QUtil::string_to_int(p2);
}
version = v;
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
void
Remove unused argument in private setWriterOptions method
2024-01-04 12:16:47 +00:00
QPDFJob::setWriterOptions(QPDFWriter& w)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->compression_level >= 0) {
Pl_Flate::setCompressionLevel(m->compression_level);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->qdf_mode) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setQDFMode(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->preserve_unreferenced_objects) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setPreserveUnreferencedObjects(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->newline_before_endstream) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setNewlineBeforeEndstream(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->normalize_set) {
w.setContentNormalization(m->normalize);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->stream_data_set) {
w.setStreamDataMode(m->stream_data_mode);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->compress_streams_set) {
w.setCompressStreams(m->compress_streams);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->recompress_flate_set) {
w.setRecompressFlate(m->recompress_flate);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->decode_level_set) {
w.setDecodeLevel(m->decode_level);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->decrypt) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setPreserveEncryption(false);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->deterministic_id) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setDeterministicID(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->static_id) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setStaticID(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->static_aes_iv) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setStaticAesIV(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->suppress_original_object_id) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setSuppressOriginalObjectIDs(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->copy_encryption) {
Split QPDFJob::run into createQPDF and writeQPDF Also, change QPDFJob to use unique_ptr<QPDF> instead of shared pointers.
2023-03-05 12:27:15 +00:00
std::unique_ptr<QPDF> encryption_pdf;
Support --show-encryption without a valid password (fixes #598)
2022-09-06 15:18:56 +00:00
processFile(
encryption_pdf,
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
m->encryption_file.c_str(),
Only update output version from files used as input If we're opening a PDF file to copy its encryption information or attachments, its version doesn't need to influence the output version.
2022-02-08 18:38:03 +00:00
m->encryption_file_password.get(),
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
false,
Only update output version from files used as input If we're opening a PDF file to copy its encryption information or attachments, its version doesn't need to influence the output version.
2022-02-08 18:38:03 +00:00
false);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.copyEncryptionParameters(*encryption_pdf);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->encrypt) {
Remove unused argument in private setWriterOptions method
2024-01-04 12:16:47 +00:00
setEncryptionOptions(w);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->linearize) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setLinearization(true);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->linearize_pass1.empty()) {
w.setLinearizationPass1Filename(m->linearize_pass1);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->object_stream_set) {
w.setObjectStreamMode(m->object_stream_mode);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Preserve input PDF version on pages/split-pages (fixes #610)
2022-02-08 16:27:38 +00:00
w.setMinimumPDFVersion(m->max_input_version);
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->min_version.empty()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::string version;
int extension_level = 0;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
parse_version(m->min_version, version, extension_level);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.setMinimumPDFVersion(version, extension_level);
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (!m->force_version.empty()) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
std::string version;
int extension_level = 0;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
parse_version(m->force_version, version, extension_level);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.forcePDFVersion(version, extension_level);
}
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
if (m->progress) {
Add QPDFJob::registerProgressReporter
2022-06-19 00:44:44 +00:00
if (m->progress_handler) {
w.registerProgressReporter(std::shared_ptr<QPDFWriter::ProgressReporter>(
new QPDFWriter::FunctionProgressReporter(m->progress_handler)));
} else {
char const* outfilename = m->outfilename ? m->outfilename.get() : "standard output";
w.registerProgressReporter(std::shared_ptr<QPDFWriter::ProgressReporter>(
// line-break
new ProgressReporter(*m->log->getInfo(), m->message_prefix, outfilename)));
}
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
void
Remove redundant parameter from QPDFJob::handlePageSpecs and doSplitPages
2023-03-05 12:44:02 +00:00
QPDFJob::doSplitPages(QPDF& pdf)
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
{
// Generate output file pattern
std::string before;
std::string after;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
size_t len = strlen(m->outfilename.get());
char* num_spot = strstr(const_cast<char*>(m->outfilename.get()), "%d");
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
if (num_spot != nullptr) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob split-pages %d");
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
before = std::string(m->outfilename.get(), QIntC::to_size(num_spot - m->outfilename.get()));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
after = num_spot + 2;
} else if (
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
(len >= 4) && (QUtil::str_compare_nocase(m->outfilename.get() + len - 4, ".pdf") == 0)) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob split-pages .pdf");
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
before = std::string(m->outfilename.get(), len - 4) + "-";
after = m->outfilename.get() + len - 4;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob split-pages other");
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
before = std::string(m->outfilename.get()) + "-";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob increment: static functions to member functions Convert remaining static functions that take QPDFJob& as a parameter to member functions. Utility functions that don't take QPDFJob& remain static functions and can probably just stay that way since the keep extra complexity out of QPDFJob.hh.
2022-01-05 21:13:43 +00:00
if (shouldRemoveUnreferencedResources(pdf)) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
QPDFPageDocumentHelper dh(pdf);
dh.removeUnreferencedResources();
}
QPDFPageLabelDocumentHelper pldh(pdf);
QPDFAcroFormDocumentHelper afdh(pdf);
std::vector<QPDFObjectHandle> const& pages = pdf.getAllPages();
Replace calls to QUtil::int_to_string with std::to_string
2022-09-21 16:49:21 +00:00
size_t pageno_len = std::to_string(pages.size()).length();
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
size_t num_pages = pages.size();
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
for (size_t i = 0; i < num_pages; i += QIntC::to_size(m->split_pages)) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
size_t first = i + 1;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
size_t last = i + QIntC::to_size(m->split_pages);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (last > num_pages) {
last = num_pages;
}
QPDF outpdf;
outpdf.emptyPDF();
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
std::shared_ptr<QPDFAcroFormDocumentHelper> out_afdh;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (afdh.hasAcroForm()) {
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
out_afdh = std::make_shared<QPDFAcroFormDocumentHelper>(outpdf);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->suppress_warnings) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
outpdf.setSuppressWarnings(true);
}
for (size_t pageno = first; pageno <= last; ++pageno) {
QPDFObjectHandle page = pages.at(pageno - 1);
outpdf.addPage(page, false);
auto new_page = added_page(outpdf, page);
QPDFJob: use std::shared_ptr over PointerHolder where possible Also fix QPDFArgParser
2022-01-22 22:37:51 +00:00
if (out_afdh.get()) {
Move QTC::TC for qpdf to QPDFJob All the coverage cases that used to be in qpdf.cc are now in QPDFJob*.cc. It doesn't really matter, but better to follow the convention of starting with the class that includes the coverage call.
2022-02-01 12:49:00 +00:00
QTC::TC("qpdf", "QPDFJob copy form fields in split_pages");
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
try {
out_afdh->fixCopiedAnnotations(new_page, page, afdh);
} catch (std::exception& e) {
Add new QPDF::warn that takes most of QPDFExc's arguments
2022-04-23 22:03:44 +00:00
pdf.warn(
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
qpdf_e_damaged_pdf,
"",
0,
Add new QPDF::warn that takes most of QPDFExc's arguments
2022-04-23 22:03:44 +00:00
("Exception caught while fixing copied annotations. This may be a qpdf "
"bug." +
std::string("Exception: ") + e.what()));
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
if (pldh.hasPageLabels()) {
std::vector<QPDFObjectHandle> labels;
pldh.getLabelsForPageRange(
QIntC::to_longlong(first - 1), QIntC::to_longlong(last - 1), 0, labels);
QPDFObjectHandle page_labels = QPDFObjectHandle::newDictionary();
page_labels.replaceKey("/Nums", QPDFObjectHandle::newArray(labels));
outpdf.getRoot().replaceKey("/PageLabels", page_labels);
}
std::string page_range = QUtil::uint_to_string(first, QIntC::to_int(pageno_len));
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->split_pages > 1) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
page_range += "-" + QUtil::uint_to_string(last, QIntC::to_int(pageno_len));
}
std::string outfile = before + page_range + after;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (QUtil::same_file(m->infilename.get(), outfile.c_str())) {
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
throw std::runtime_error("split pages would overwrite input file with " + outfile);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFWriter w(outpdf, outfile.c_str());
Remove unused argument in private setWriterOptions method
2024-01-04 12:16:47 +00:00
setWriterOptions(w);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.write();
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": wrote file " << outfile << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
void
QPDFJob::writeOutfile(QPDF& pdf)
{
QPDFJob: convert outfilename to shared pointer
2022-01-22 23:30:39 +00:00
std::shared_ptr<char> temp_out;
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->replace_input) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// Append but don't prepend to the path to generate a temporary name. This saves us from
// having to split the path by directory and non-directory.
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
temp_out = QUtil::make_shared_cstr(std::string(m->infilename.get()) + ".~qpdf-temp#");
// m->outfilename will be restored to 0 before temp_out goes out of scope.
m->outfilename = temp_out;
} else if (strcmp(m->outfilename.get(), "-") == 0) {
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
m->outfilename = nullptr;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (m->json_version) {
writeJSON(pdf);
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
} else {
// QPDFWriter must have block scope so the output file will be closed after write()
// finishes.
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
QPDFWriter w(pdf);
if (m->outfilename) {
w.setOutputFilename(m->outfilename.get());
} else {
// saveToStandardOutput has already been called, but calling it again is defensive and
// harmless.
Add C API to QPDFLogger
2022-06-18 17:38:36 +00:00
m->log->saveToStandardOutput(true);
Use "save" logger when saving data to standard output This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
2022-06-18 13:40:41 +00:00
w.setOutputPipeline(m->log->getSave().get());
}
Remove unused argument in private setWriterOptions method
2024-01-04 12:16:47 +00:00
setWriterOptions(w);
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
w.write();
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->outfilename) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
doIfVerbose([&](Pipeline& v, std::string const& prefix) {
v << prefix << ": wrote file " << m->outfilename.get() << "\n";
QPDFJob increment: get rid of exit, handle verbose Remove all calls to exit() from QPDFJob. Handle code that runs in verbose mode to enable it to make use of output streams and message prefix (whoami) from QPDFJob. This removes temporarily duplicated exit code logic and most access to whoami/std::cout outside of QPDFJob proper.
2022-01-03 17:16:16 +00:00
});
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->replace_input) {
Code tidy : replace 0 with nullptr or true
2022-07-26 11:37:50 +00:00
m->outfilename = nullptr;
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
if (m->replace_input) {
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
// We must close the input before we can rename files
pdf.closeInputSource();
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
std::string backup = std::string(m->infilename.get()) + ".~qpdf-orig";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
bool warnings = pdf.anyWarnings();
if (!warnings) {
backup.append(1, '#');
}
QPDFJob: move private members into Members
2022-01-26 19:56:24 +00:00
QUtil::rename_file(m->infilename.get(), backup.c_str());
QUtil::rename_file(temp_out.get(), m->infilename.get());
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
if (warnings) {
QPDF, QPDFJob: use QPDFLogger instead of custom output streams
2022-06-05 17:30:42 +00:00
*m->log->getError() << m->message_prefix
<< ": there are warnings; original file kept in " << backup << "\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
} else {
try {
QUtil::remove_file(backup.c_str());
} catch (QPDFSystemError& e) {
Format code
2024-06-07 12:07:51 +00:00
*m->log->getError() << m->message_prefix << ": unable to delete original file ("
<< e.what() << ");" << " original file left in " << backup
<< ", but the input was successfully replaced\n";
QPDFJob increment: basic QPDFJob structure Move most of the methods called from qpdf.cc after argument parsing into QPDFJob. In this increment, enough QPDFJob API has been added to handle the branch of QPDFJob::run() that creates output with an appropriate division between qpdf.cc and QPDFJob. There are temporary bits of code to enable everything to compile and pass the test suite, including some duplication and hard-coded values.
2022-01-03 15:16:28 +00:00
}
}
}
}
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
void
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
QPDFJob::writeJSON(QPDF& pdf)
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
{
// File pipeline must have block scope so it will be closed after write.
std::shared_ptr<QUtil::FileCloser> fc;
std::shared_ptr<Pipeline> fp;
if (m->outfilename.get()) {
QTC::TC("qpdf", "QPDFJob write json to file");
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
if (m->json_stream_prefix.empty()) {
m->json_stream_prefix = m->outfilename.get();
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
}
fc = std::make_shared<QUtil::FileCloser>(QUtil::safe_fopen(m->outfilename.get(), "w"));
fp = std::make_shared<Pl_StdioFile>("json output", fc->f);
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
} else if ((m->json_stream_data == qpdf_sj_file) && m->json_stream_prefix.empty()) {
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
QTC::TC("qpdf", "QPDFJob need json-stream-prefix for stdout");
usage("please specify --json-stream-prefix since the input file "
"name is unknown");
} else {
QTC::TC("qpdf", "QPDFJob write json to stdout");
Simplify --json-output Now --json-output just changes defaults. Allow output file with --json.
2022-07-31 14:34:05 +00:00
m->log->saveToStandardOutput(true);
fp = m->log->getSave();
}
doJSON(pdf, fp.get());
Major rework -- see long comments * Replace --create-from-json=file with --json-input, which causes the regular input to be treated as json. * Eliminate --to-json * In --json=2, bring back "objects" and eliminate "objectinfo". Stream data is never present. * In --json-output=2, write "qpdf-v2" with "objects" and include stream data.
2022-05-18 22:22:57 +00:00
}
Copy Permalink