fenix/PDF4QT
1
0
Fork 0
mirror of https://github.com/JakubMelka/PDF4QT.git synced 2025-03-03 10:57:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Form actions - definition and parsing

Browse Source
This commit is contained in:
Jakub Melka 2020-05-26 19:38:16 +02:00
parent 00e141129a
commit 6c43e92bc0
2 changed files with 198 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
PdfForQtLib/sources/pdfaction.cpp
View File

@ -294,6 +294,41 @@ PDFActionPtr PDFAction::parseImpl(const PDFObjectStorage* storage, PDFObject obj
}
return PDFActionPtr(new PDFActionJavaScript(PDFEncoding::convertTextString(textJavaScript)));
}
else if (name == "SubmitForm")
{
PDFFormAction::FieldScope fieldScope = PDFFormAction::FieldScope::All;
PDFFileSpecification url = PDFFileSpecification::parse(storage, dictionary->get("F"));
PDFFormAction::FieldList fieldList = PDFFormAction::parseFieldList(storage, dictionary->get("Fields"), fieldScope);
PDFActionSubmitForm::SubmitFlags flags = static_cast<PDFActionSubmitForm::SubmitFlags>(loader.readIntegerFromDictionary(dictionary, "Flags", 0));
QByteArray charset = loader.readStringFromDictionary(dictionary, "CharSet");
if (fieldScope == PDFFormAction::FieldScope::Include &&
flags.testFlag(PDFActionSubmitForm::IncludeExclude))
{
fieldScope = PDFFormAction::FieldScope::Exclude;
}
return PDFActionPtr(new PDFActionSubmitForm(fieldScope, qMove(fieldList), qMove(url), qMove(charset), flags));
}
else if (name == "ResetForm")
{
PDFFormAction::FieldScope fieldScope = PDFFormAction::FieldScope::All;
PDFFormAction::FieldList fieldList = PDFFormAction::parseFieldList(storage, dictionary->get("Fields"), fieldScope);
PDFActionResetForm::ResetFlags flags = static_cast<PDFActionResetForm::ResetFlags>(loader.readIntegerFromDictionary(dictionary, "Flags", 0));
if (fieldScope == PDFFormAction::FieldScope::Include &&
flags.testFlag(PDFActionResetForm::IncludeExclude))
{
fieldScope = PDFFormAction::FieldScope::Exclude;
}
return PDFActionPtr(new PDFActionResetForm(fieldScope, qMove(fieldList), flags));
}
else if (name == "ImportData")
{
PDFFileSpecification file = PDFFileSpecification::parse(storage, dictionary->get("F"));
return PDFActionPtr(new PDFActionImportDataForm(qMove(file)));
}
return PDFActionPtr();
}
@ -411,4 +446,36 @@ PDFDestination PDFDestination::parse(const PDFObjectStorage* storage, PDFObject
return result;
}
PDFFormAction::FieldList PDFFormAction::parseFieldList(const PDFObjectStorage* storage, PDFObject object, FieldScope& fieldScope)
{
FieldList result;
object = storage->getObject(object);
if (object.isArray())
{
PDFDocumentDataLoaderDecorator loader(storage);
const PDFArray* fieldsArray = object.getArray();
for (size_t i = 0, count = fieldsArray->getCount(); i < count; ++i)
{
PDFObject fieldObject = fieldsArray->getItem(i);
if (fieldObject.isReference())
{
result.fieldReferences.push_back(fieldObject.getReference());
}
else if (fieldObject.isString())
{
result.qualifiedNames.push_back(loader.readTextString(fieldObject, QString()));
}
}
}
if (!result.isEmpty())
{
fieldScope = FieldScope::Include;
}
return result;
}
} // namespace pdf

132
PdfForQtLib/sources/pdfaction.h
View File

@ -52,7 +52,10 @@ enum class ActionType
Rendition,
Transition,
GoTo3DView,
JavaScript
JavaScript,
SubmitForm,
ResetForm,
ImportDataForm
};
enum class DestinationType
@ -514,6 +517,133 @@ private:
QString m_javaScript;
};
class PDFFormAction : public PDFAction
{
public:
enum FieldScope
{
All, ///< Perform action for all form fields
Include, ///< Perform action only on fields listed in the list
Exclude ///< Perform action on all fields except those in the list
};
struct FieldList
{
std::vector<PDFObjectReference> fieldReferences;
QStringList qualifiedNames;
bool isEmpty() const { return fieldReferences.empty() && qualifiedNames.isEmpty(); }
};
explicit inline PDFFormAction(FieldScope fieldScope, FieldList fieldList) :
m_fieldScope(fieldScope),
m_fieldList(qMove(fieldList))
{
}
FieldScope getFieldScope() const { return m_fieldScope; }
const FieldList& getFieldList() const { return m_fieldList; }
/// Parses the field list from the object. If object contains invalid field list,
/// then empty field list is returned. If object is empty, empty field list is returned.
/// \param storage Object storage
/// \param object Field list array object
/// \param[out] fieldScope Result field scope
static FieldList parseFieldList(const PDFObjectStorage* storage, PDFObject object, FieldScope& fieldScope);
protected:
FieldScope m_fieldScope = FieldScope::All;
FieldList m_fieldList;
};
class PDFActionSubmitForm : public PDFFormAction
{
public:
enum SubmitFlag
{
None = 0,
IncludeExclude = 1 << 0,
IncludeNoValueFields = 1 << 1,
ExportFormat = 1 << 2,
GetMethod = 1 << 3,
SubmitCoordinates = 1 << 4,
XFDF = 1 << 5,
IncludeAppendSaves = 1 << 6,
IncludeAnnotations = 1 << 7,
SubmitPDF = 1 << 8,
CanonicalFormat = 1 << 9,
ExclNonUseAnnots = 1 << 10,
ExclFKey = 1 << 11,
EmbedForm = 1 << 13
};
Q_DECLARE_FLAGS(SubmitFlags, SubmitFlag)
explicit inline PDFActionSubmitForm(FieldScope fieldScope, FieldList fieldList, PDFFileSpecification url, QByteArray charset, SubmitFlags flags) :
PDFFormAction(fieldScope, qMove(fieldList)),
m_url(qMove(url)),
m_charset(qMove(charset)),
m_flags(flags)
{
}
virtual ActionType getType() const override { return ActionType::SubmitForm; }
const PDFFileSpecification& getUrl() const { return m_url; }
const QByteArray& getCharset() const { return m_charset; }
SubmitFlags getFlags() const { return m_flags; }
private:
PDFFileSpecification m_url;
QByteArray m_charset;
SubmitFlags m_flags = None;
};
class PDFActionResetForm : public PDFFormAction
{
public:
enum ResetFlag
{
None = 0,
IncludeExclude = 1 << 0,
};
Q_DECLARE_FLAGS(ResetFlags, ResetFlag)
explicit inline PDFActionResetForm(FieldScope fieldScope, FieldList fieldList, ResetFlags flags) :
PDFFormAction(fieldScope, qMove(fieldList)),
m_flags(flags)
{
}
virtual ActionType getType() const override { return ActionType::ResetForm; }
ResetFlags getFlags() const { return m_flags; }
private:
ResetFlags m_flags = None;
};
class PDFActionImportDataForm : public PDFAction
{
public:
explicit inline PDFActionImportDataForm(PDFFileSpecification file) :
m_file(qMove(file))
{
}
virtual ActionType getType() const override { return ActionType::ImportDataForm; }
const PDFFileSpecification& getFile() const { return m_file; }
private:
PDFFileSpecification m_file;
};
} // namespace pdf
#endif // PDFACTION_H