form_field.h

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_FORM_FIELD_H_INCLUDED_
#define PDFSDK_CXX_PDF_FORM_FIELD_H_INCLUDED_
 
#include <string>
#include <vector>
 
#include <pdfsdk/core/acroform.h>
#include <pdfsdk/cxx/bytes.h>
 
#include "forward_declarations.h"
#include "ltv_handler.h"
#include "timestamp_handler.h"
#include "wrapper_base.h"
 
namespace PDF {

enum class SigChainStatus {
    Ok,
    Untrusted,
    Incomplete,
    Expired,
    Error
};

enum class SigRevocationStatus {
    Good,
    Revoked,
    Unknown,
    Error
};

enum class SigTimeSource {
    DocTimestamp,
    ClaimedM,
    None
};

struct SignValidationOptions {
    std::vector<std::vector<Byte>> trustAnchors;   
    bool requireRevocation = true;                 
};

struct SignValidationResult {
    bool                integrityValid = false;   
    bool                documentCovered = false;  
    SigChainStatus      chain = SigChainStatus::Error;
    SigRevocationStatus revocation = SigRevocationStatus::Unknown;
    SigTimeSource       timeSource = SigTimeSource::None;
    PDDateTime          referenceTime = {};
    bool                ltvEnabled = false;        

    bool IsValidLTV() const {
        return integrityValid && documentCovered &&
               chain == SigChainStatus::Ok &&
               revocation == SigRevocationStatus::Good;
    }
};

class SignHandler
{
public:
    virtual ~SignHandler() = default;

    virtual std::string GetFilter() = 0;

    virtual std::string GetSubFilter() = 0;

    virtual void CustomizeSigDict(Object dict) = 0;

    virtual size_t GetNumCerts() = 0;

    virtual std::vector<Byte> GetCertData(size_t index) = 0;

    virtual size_t EstimateMaxSize() = 0;

    virtual std::vector<Byte> Sign(std::span<const Byte> data) = 0;
};

class FormField : public detail::RefCountedHandle<PDField> {
public:
    static FormField CreateFromPdfObject(const Object& object);

    Object GetPdfObject() const;

    PDAtom GetFieldType() const;

    bool IsTerminal() const;

    PDFieldFlags GetFlags() const;

    std::wstring GetFullName() const;

    std::wstring GetValue() const;

    std::wstring GetDefaultValue() const;

    void SetDefaultValue(std::wstring_view value);

    void SetValue(std::wstring_view value);
 
#ifndef SWIG
    void SetValue(const wchar_t* value);
#endif

    size_t GetNumWidgets() const;

    Annot GetWidget(size_t index) const;

    size_t GetChoiceNumOptions() const;

    std::wstring GetChoiceOption(size_t index) const;

    int GetMaxLen() const;

    void SetMaxLen(int maxLen);

    bool IsSignBlank() const;

    void SetSignLock(PDAtom action, Object fields, PDSignLockPerms perms);

    PDAtom GetSignLockAction() const;

    Object GetSignLockFields() const;

    PDSignLockPerms GetSignLockPerms() const;

    void SignApprove(std::shared_ptr<SignHandler> signer, const std::wstring& reason);

    void SignCertify(std::shared_ptr<SignHandler> signer, const std::wstring& reason, PDSignLockPerms perms = kPDSignLockPermsAllowFormFill);

    void SignClear();

    bool SignVerify() const;

    bool SignDocModifiedAfterSign() const;

    std::wstring GetSignReason() const;

    PDDateTime GetSignDate() const;

    size_t GetNumSignCertificates() const;

    std::vector<Byte> GetSignCertificate(size_t index) const;

    int GetSignRevision() const;

    bool IsSignCertification() const;
 
    
    bool IsDocumentTimestamp() const;

    void AddDocumentTimestamp(std::shared_ptr<TimestampHandler> handler);

    void AddLTVData(LTVHandler& handler);

    SignValidationResult ValidateLTV(const SignValidationOptions& options) const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(FormField, PDField)
};
 
}  // namespace PDF
 
#include "form_field_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_FORM_FIELD_H_INCLUDED_