/src/qpdf/libqpdf/QPDFFormFieldObjectHelper.cc

Source
#include <qpdf/QPDFFormFieldObjectHelper.hh>

#include <qpdf/FormField.hh>

#include <qpdf/Pl_QPDFTokenizer.hh>
#include <qpdf/QIntC.hh>
#include <qpdf/QPDFAcroFormDocumentHelper.hh>
#include <qpdf/QPDFAnnotationObjectHelper.hh>
#include <qpdf/QPDFObjectHandle_private.hh>
#include <qpdf/QPDF_private.hh>
#include <qpdf/QTC.hh>
#include <qpdf/QUtil.hh>
#include <cstdlib>

#include <memory>

using namespace qpdf;

using FormField = qpdf::impl::FormField;

class QPDFFormFieldObjectHelper::Members: public FormField
{
  public:
    Members(QPDFObjectHandle const& oh) :
        FormField(oh)
    {
    }
};

QPDFFormFieldObjectHelper::QPDFFormFieldObjectHelper(QPDFObjectHandle o) :
    QPDFObjectHelper(o),
    m(std::make_shared<Members>(oh()))
{
}

QPDFFormFieldObjectHelper::QPDFFormFieldObjectHelper() :
    QPDFObjectHelper(Null::temp()),
    m(std::make_shared<Members>(QPDFObjectHandle()))
{
}

bool
QPDFFormFieldObjectHelper::isNull()
{
    return m->null();
}

QPDFFormFieldObjectHelper
QPDFFormFieldObjectHelper::getParent()
{
    return {Null::if_null(m->getParent().oh())};
}

FormField
FormField::getParent()
{
    return {oh()["/Parent"]}; // maybe null
}

QPDFFormFieldObjectHelper
QPDFFormFieldObjectHelper::getTopLevelField(bool* is_different)
{
    return Null::if_null(m->getTopLevelField(is_different).oh());
}

FormField
FormField::getTopLevelField(bool* is_different)
{
    if (!obj) {
        return {};
    }
    auto top_field = oh();
    QPDFObjGen::set seen;
    while (seen.add(top_field) && !top_field.getKeyIfDict("/Parent").null()) {
        top_field = top_field.getKey("/Parent");
        if (is_different) {
            *is_different = true;
        }
    }
    return {top_field};
}

QPDFObjectHandle
FormField::getFieldFromAcroForm(std::string const& name)
{
    QPDFObjectHandle result = QPDFObjectHandle::newNull();
    // Fields are supposed to be indirect, so this should work.
    QPDF* q = oh().getOwningQPDF();
    if (!q) {
        return result;
    }
    auto acroform = q->getRoot().getKey("/AcroForm");
    if (!acroform.isDictionary()) {
        return result;
    }
    return acroform.getKey(name);
}

QPDFObjectHandle
QPDFFormFieldObjectHelper::getInheritableFieldValue(std::string const& name)
{
    return m->getInheritableFieldValue(name);
}

QPDFObjectHandle
FormField::getInheritableFieldValue(std::string const& name)
{
    QPDFObjectHandle node = oh();
    if (!node.isDictionary()) {
        return QPDFObjectHandle::newNull();
    }
    QPDFObjectHandle result(node.getKey(name));
    if (result.null()) {
        QPDFObjGen::set seen;
        while (seen.add(node) && node.hasKey("/Parent")) {
            node = node.getKey("/Parent");
            result = node.getKey(name);
            if (!result.null()) {
                return result;
            }
        }
    }
    return result;
}

std::string
QPDFFormFieldObjectHelper::getInheritableFieldValueAsString(std::string const& name)
{
    return m->getInheritableFieldValueAsString(name);
}

std::string
FormField::getInheritableFieldValueAsString(std::string const& name)
{
    auto fv = getInheritableFieldValue(name);
    if (fv.isString()) {
        return fv.getUTF8Value();
    }
    return {};
}

std::string
QPDFFormFieldObjectHelper::getInheritableFieldValueAsName(std::string const& name)
{
    return m->getInheritableFieldValueAsName(name);
}

std::string
FormField::getInheritableFieldValueAsName(std::string const& name)
{
    if (Name fv = getInheritableFieldValue(name)) {
        return fv;
    }
    return {};
}

std::string
QPDFFormFieldObjectHelper::getFieldType()
{
    return m->getFieldType();
}

std::string
FormField::getFieldType()
{
    return getInheritableFieldValueAsName("/FT");
}

std::string
QPDFFormFieldObjectHelper::getFullyQualifiedName()
{
    return m->getFullyQualifiedName();
}

std::string
FormField::getFullyQualifiedName()
{
    std::string result;
    QPDFObjectHandle node = oh();
    QPDFObjGen::set seen;
    while (!node.null() && seen.add(node)) {
        if (node.getKey("/T").isString()) {
            if (!result.empty()) {
                result = "." + result;
            }
            result = node.getKey("/T").getUTF8Value() + result;
        }
        node = node.getKey("/Parent");
    }
    return result;
}

std::string
QPDFFormFieldObjectHelper::getPartialName()
{
    return m->getPartialName();
}

std::string
FormField::getPartialName()
{
    std::string result;
    if (oh().getKey("/T").isString()) {
        result = oh().getKey("/T").getUTF8Value();
    }
    return result;
}

std::string
QPDFFormFieldObjectHelper::getAlternativeName()
{
    return m->getAlternativeName();
}

std::string
FormField::getAlternativeName()
{
    if (oh().getKey("/TU").isString()) {
        QTC::TC("qpdf", "QPDFFormFieldObjectHelper TU present");
        return oh().getKey("/TU").getUTF8Value();
    }
    QTC::TC("qpdf", "QPDFFormFieldObjectHelper TU absent");
    return getFullyQualifiedName();
}

std::string
QPDFFormFieldObjectHelper::getMappingName()
{
    return m->getMappingName();
}

std::string
FormField::getMappingName()
{
    if (oh().getKey("/TM").isString()) {
        QTC::TC("qpdf", "QPDFFormFieldObjectHelper TM present");
        return oh().getKey("/TM").getUTF8Value();
    }
    QTC::TC("qpdf", "QPDFFormFieldObjectHelper TM absent");
    return getAlternativeName();
}

QPDFObjectHandle
QPDFFormFieldObjectHelper::getValue()
{
    return m->getValue();
}

QPDFObjectHandle
FormField::getValue()
{
    return getInheritableFieldValue("/V");
}

std::string
QPDFFormFieldObjectHelper::getValueAsString()
{
    return getInheritableFieldValueAsString("/V");
}

std::string
FormField::getValueAsString()
{
    return getInheritableFieldValueAsString("/V");
}

QPDFObjectHandle
QPDFFormFieldObjectHelper::getDefaultValue()
{
    return m->getDefaultValue();
}

QPDFObjectHandle
FormField::getDefaultValue()
{
    return getInheritableFieldValue("/DV");
}

std::string
QPDFFormFieldObjectHelper::getDefaultValueAsString()
{
    return m->getDefaultValueAsString();
}

std::string
FormField::getDefaultValueAsString()
{
    return getInheritableFieldValueAsString("/DV");
}

QPDFObjectHandle
QPDFFormFieldObjectHelper::getDefaultResources()
{
    return m->getDefaultResources();
}

QPDFObjectHandle
FormField::getDefaultResources()
{
    return getFieldFromAcroForm("/DR");
}

std::string
QPDFFormFieldObjectHelper::getDefaultAppearance()
{
    return m->getDefaultAppearance();
}

std::string
FormField::getDefaultAppearance()
{
    auto value = getInheritableFieldValue("/DA");
    bool looked_in_acroform = false;
    if (!value.isString()) {
        value = getFieldFromAcroForm("/DA");
        looked_in_acroform = true;
    }
    if (value.isString()) {
        QTC::TC("qpdf", "QPDFFormFieldObjectHelper DA present", looked_in_acroform ? 0 : 1);
        return value.getUTF8Value();
    }
    return {};
}

int
QPDFFormFieldObjectHelper::getQuadding()
{
    return m->getQuadding();
}

int
FormField::getQuadding()
{
    QPDFObjectHandle fv = getInheritableFieldValue("/Q");
    bool looked_in_acroform = false;
    if (!fv.isInteger()) {
        fv = getFieldFromAcroForm("/Q");
        looked_in_acroform = true;
    }
    if (fv.isInteger()) {
        QTC::TC("qpdf", "QPDFFormFieldObjectHelper Q present", looked_in_acroform ? 0 : 1);
        return QIntC::to_int(fv.getIntValue());
    }
    return 0;
}

int
QPDFFormFieldObjectHelper::getFlags()
{
    return m->getFlags();
}

int
FormField::getFlags()
{
    QPDFObjectHandle f = getInheritableFieldValue("/Ff");
    return f.isInteger() ? f.getIntValueAsInt() : 0;
}

bool
QPDFFormFieldObjectHelper::isText()
{
    return m->isText();
}

bool
FormField::isText()
{
    return getFieldType() == "/Tx";
}

bool
QPDFFormFieldObjectHelper::isCheckbox()
{
    return m->isCheckbox();
}

bool
FormField::isCheckbox()
{
    return getFieldType() == "/Btn" && (getFlags() & (ff_btn_radio | ff_btn_pushbutton)) == 0;
}

bool
QPDFFormFieldObjectHelper::isChecked()
{
    return m->isChecked();
}

bool
FormField::isChecked()
{
    return isCheckbox() && Name(getValue()) != "/Off";
}

bool
QPDFFormFieldObjectHelper::isRadioButton()
{
    return m->isRadioButton();
}

bool
FormField::isRadioButton()
{
    return getFieldType() == "/Btn" && (getFlags() & ff_btn_radio) == ff_btn_radio;
}

bool
QPDFFormFieldObjectHelper::isPushbutton()
{
    return m->isPushbutton();
}

bool
FormField::isPushbutton()
{
    return getFieldType() == "/Btn" && (getFlags() & ff_btn_pushbutton) == ff_btn_pushbutton;
}

bool
QPDFFormFieldObjectHelper::isChoice()
{
    return m->isChoice();
}

bool
FormField::isChoice()
{
    return getFieldType() == "/Ch";
}

std::vector<std::string>
QPDFFormFieldObjectHelper::getChoices()
{
    return m->getChoices();
}

std::vector<std::string>
FormField::getChoices()
{
    if (!isChoice()) {
        return {};
    }
    std::vector<std::string> result;
    for (auto const& item: getInheritableFieldValue("/Opt").as_array()) {
        if (item.isString()) {
            result.emplace_back(item.getUTF8Value());
        } else if (item.size() == 2) {
            auto display = item.getArrayItem(1);
            if (display.isString()) {
                result.emplace_back(display.getUTF8Value());
            }
        }
    }
    return result;
}

void
QPDFFormFieldObjectHelper::setFieldAttribute(std::string const& key, QPDFObjectHandle value)
{
    m->setFieldAttribute(key, value);
}

void
FormField::setFieldAttribute(std::string const& key, QPDFObjectHandle value)
{
    oh().replaceKey(key, value);
}

void
QPDFFormFieldObjectHelper::setFieldAttribute(std::string const& key, std::string const& utf8_value)
{
    m->setFieldAttribute(key, utf8_value);
}

void
FormField::setFieldAttribute(std::string const& key, std::string const& utf8_value)
{
    oh().replaceKey(key, QPDFObjectHandle::newUnicodeString(utf8_value));
}

void
QPDFFormFieldObjectHelper::setV(QPDFObjectHandle value, bool need_appearances)
{
    m->setV(value, need_appearances);
}

void
FormField::setV(QPDFObjectHandle value, bool need_appearances)
{
    Name name = value;
    if (getFieldType() == "/Btn") {
        if (isCheckbox()) {
            if (!name) {
                warn("ignoring attempt to set a checkbox field to a value whose type is not name");
                return;
            }
            // Accept any value other than /Off to mean checked. Files have been seen that use
            // /1 or other values.
            setCheckBoxValue(name != "/Off");
            return;
        }
        if (isRadioButton()) {
            if (!name) {
                warn(
                    "ignoring attempt to set a radio button field to an object that is not a name");
                return;
            }
            setRadioButtonValue(name);
            return;
        }
        if (isPushbutton()) {
            warn("ignoring attempt set the value of a pushbutton field");
        }
        return;
    }
    if (value.isString()) {
        setFieldAttribute("/V", QPDFObjectHandle::newUnicodeString(value.getUTF8Value()));
    } else {
        setFieldAttribute("/V", value);
    }
    if (need_appearances) {
        QPDF& qpdf = oh().getQPDF(
            "QPDFFormFieldObjectHelper::setV called with need_appearances = "
            "true on an object that is not associated with an owning QPDF");
        qpdf.doc().acroform().setNeedAppearances(true);
    }
}

void
QPDFFormFieldObjectHelper::setV(std::string const& utf8_value, bool need_appearances)
{
    m->setV(utf8_value, need_appearances);
}

void
FormField::setV(std::string const& utf8_value, bool need_appearances)
{
    setV(QPDFObjectHandle::newUnicodeString(utf8_value), need_appearances);
}

void
FormField::setRadioButtonValue(QPDFObjectHandle name)
{
    // Set the value of a radio button field. This has the following specific behavior:
    // * If this is a radio button field that has a parent that is also a radio button field and has
    //   no explicit /V, call itself on the parent
    // * If this is a radio button field with children, set /V to the given value. Then, for each
    //   child, if the child has the specified value as one of its keys in the /N subdictionary of
    //   its /AP (i.e. its normal appearance stream dictionary), set /AS to name; otherwise, if /Off
    //   is a member, set /AS to /Off.
    // Note that we never turn on /NeedAppearances when setting a radio button field.
    QPDFObjectHandle parent = oh().getKey("/Parent");
    if (parent.isDictionary() && parent.getKey("/Parent").null()) {
        FormField ph(parent);
        if (ph.isRadioButton()) {
            // This is most likely one of the individual buttons. Try calling on the parent.
            ph.setRadioButtonValue(name);
            return;
        }
    }

    QPDFObjectHandle kids = oh().getKey("/Kids");
    if (!(isRadioButton() && parent.null() && kids.isArray())) {
        warn("don't know how to set the value of this field as a radio button");
        return;
    }
    setFieldAttribute("/V", name);
    for (auto const& kid: kids.as_array()) {
        QPDFObjectHandle AP = kid.getKey("/AP");
        QPDFObjectHandle annot;
        if (AP.null()) {
            // The widget may be below. If there is more than one, just find the first one.
            for (auto const& grandkid: kid.getKey("/Kids").as_array()) {
                AP = grandkid.getKey("/AP");
                if (!AP.null()) {
                    annot = grandkid;
                    break;
                }
            }
        } else {
            annot = kid;
        }
        if (!annot) {
            warn("unable to set the value of this radio button");
            continue;
        }
        if (AP.isDictionary() && AP.getKey("/N").isDictionary() &&
            AP.getKey("/N").hasKey(name.getName())) {
            annot.replaceKey("/AS", name);
        } else {
            annot.replaceKey("/AS", QPDFObjectHandle::newName("/Off"));
        }
    }
}

void
FormField::setCheckBoxValue(bool value)
{
    QPDFObjectHandle AP = oh().getKey("/AP");
    QPDFObjectHandle annot;
    if (AP.null()) {
        // The widget may be below. If there is more than one, just
        // find the first one.
        QPDFObjectHandle kids = oh().getKey("/Kids");
        for (auto const& kid: oh().getKey("/Kids").as_array(qpdf::strict)) {
            AP = kid.getKey("/AP");
            if (!AP.null()) {
                QTC::TC("qpdf", "QPDFFormFieldObjectHelper checkbox kid widget");
                annot = kid;
                break;
            }
        }
    } else {
        annot = oh();
    }
    std::string on_value;
    if (value) {
        // Set the "on" value to the first value in the appearance stream's normal state dictionary
        // that isn't /Off. If not found, fall back to /Yes.
        if (AP.isDictionary()) {
            for (auto const& item: AP.getKey("/N").as_dictionary()) {
                if (item.first != "/Off") {
                    on_value = item.first;
                    break;
                }
            }
        }
        if (on_value.empty()) {
            on_value = "/Yes";
        }
    }

    // Set /AS to the on value or /Off in addition to setting /V.
    QPDFObjectHandle name = QPDFObjectHandle::newName(value ? on_value : "/Off");
    setFieldAttribute("/V", name);
    if (!annot) {
        QTC::TC("qpdf", "QPDFObjectHandle broken checkbox");
        warn("unable to set the value of this checkbox");
        return;
    }
    QTC::TC("qpdf", "QPDFFormFieldObjectHelper set checkbox AS");
    annot.replaceKey("/AS", name);
}

void
QPDFFormFieldObjectHelper::generateAppearance(QPDFAnnotationObjectHelper& aoh)
{
    m->generateAppearance(aoh);
}

void
FormField::generateAppearance(QPDFAnnotationObjectHelper& aoh)
{
    std::string ft = getFieldType();
    // Ignore field types we don't know how to generate appearances for. Button fields don't really
    // need them -- see code in QPDFAcroFormDocumentHelper::generateAppearancesIfNeeded.
    if ((ft == "/Tx") || (ft == "/Ch")) {
        generateTextAppearance(aoh);
    }
}

namespace
{
    class ValueSetter: public QPDFObjectHandle::TokenFilter
    {
      public:
        ValueSetter(
            std::string const& DA,
            std::string const& V,
            std::vector<std::string> const& opt,
            double tf,
            QPDFObjectHandle::Rectangle const& bbox);
        ~ValueSetter() override = default;
        void handleToken(QPDFTokenizer::Token const&) override;
        void handleEOF() override;
        void writeAppearance();

      private:
        std::string DA;
        std::string V;
        std::vector<std::string> opt;
        double tf;
        QPDFObjectHandle::Rectangle bbox;
        enum { st_top, st_bmc, st_emc, st_end } state{st_top};
        bool replaced{false};
    };
} // namespace

ValueSetter::ValueSetter(
    std::string const& DA,
    std::string const& V,
    std::vector<std::string> const& opt,
    double tf,
    QPDFObjectHandle::Rectangle const& bbox) :
    DA(DA),
    V(V),
    opt(opt),
    tf(tf),
    bbox(bbox)
{
}

void
ValueSetter::handleToken(QPDFTokenizer::Token const& token)
{
    QPDFTokenizer::token_type_e ttype = token.getType();
    std::string value = token.getValue();
    bool do_replace = false;
    switch (state) {
    case st_top:
        writeToken(token);
        if (token.isWord("BMC")) {
            state = st_bmc;
        }
        break;

    case st_bmc:
        if ((ttype == QPDFTokenizer::tt_space) || (ttype == QPDFTokenizer::tt_comment)) {
            writeToken(token);
        } else {
            state = st_emc;
        }
        // fall through to emc

    case st_emc:
        if (token.isWord("EMC")) {
            do_replace = true;
            state = st_end;
        }
        break;

    case st_end:
        writeToken(token);
        break;
    }
    if (do_replace) {
        writeAppearance();
    }
}

void
ValueSetter::handleEOF()
{
    if (!replaced) {
        QTC::TC("qpdf", "QPDFFormFieldObjectHelper replaced BMC at EOF");
        write("/Tx BMC\n");
        writeAppearance();
    }
}

void
ValueSetter::writeAppearance()
{
    replaced = true;

    // This code does not take quadding into consideration because doing so requires font metric
    // information, which we don't have in many cases.

    double tfh = 1.2 * tf;
    int dx = 1;

    // Write one or more lines, centered vertically, possibly with one row highlighted.

    auto max_rows = static_cast<size_t>((bbox.ury - bbox.lly) / tfh);
    bool highlight = false;
    size_t highlight_idx = 0;

    std::vector<std::string> lines;
    if (opt.empty() || (max_rows < 2)) {
        lines.push_back(V);
    } else {
        // Figure out what rows to write
        size_t nopt = opt.size();
        size_t found_idx = 0;
        bool found = false;
        for (found_idx = 0; found_idx < nopt; ++found_idx) {
            if (opt.at(found_idx) == V) {
                found = true;
                break;
            }
        }
        if (found) {
            // Try to make the found item the second one, but adjust for under/overflow.
            int wanted_first = QIntC::to_int(found_idx) - 1;
            int wanted_last = QIntC::to_int(found_idx + max_rows) - 2;
            QTC::TC("qpdf", "QPDFFormFieldObjectHelper list found");
            if (wanted_first < 0) {
                QTC::TC("qpdf", "QPDFFormFieldObjectHelper list first too low");
                wanted_last -= wanted_first;
                wanted_first = 0;
            }
            if (wanted_last >= QIntC::to_int(nopt)) {
                QTC::TC("qpdf", "QPDFFormFieldObjectHelper list last too high");
                auto diff = wanted_last - QIntC::to_int(nopt) + 1;
                wanted_first = std::max(0, wanted_first - diff);
                wanted_last -= diff;
            }
            highlight = true;
            highlight_idx = found_idx - QIntC::to_size(wanted_first);
            for (size_t i = QIntC::to_size(wanted_first); i <= QIntC::to_size(wanted_last); ++i) {
                lines.push_back(opt.at(i));
            }
        } else {
            QTC::TC("qpdf", "QPDFFormFieldObjectHelper list not found");
            // include our value and the first n-1 rows
            highlight_idx = 0;
            highlight = true;
            lines.push_back(V);
            for (size_t i = 0; ((i < nopt) && (i < (max_rows - 1))); ++i) {
                lines.push_back(opt.at(i));
            }
        }
    }

    // Write the lines centered vertically, highlighting if needed
    size_t nlines = lines.size();
    double dy = bbox.ury - ((bbox.ury - bbox.lly - (static_cast<double>(nlines) * tfh)) / 2.0);
    if (highlight) {
        write(
            "q\n0.85 0.85 0.85 rg\n" + QUtil::double_to_string(bbox.llx) + " " +
            QUtil::double_to_string(
                bbox.lly + dy - (tfh * (static_cast<double>(highlight_idx + 1)))) +
            " " + QUtil::double_to_string(bbox.urx - bbox.llx) + " " +
            QUtil::double_to_string(tfh) + " re f\nQ\n");
    }
    dy -= tf;
    write("q\nBT\n" + DA + "\n");
    for (size_t i = 0; i < nlines; ++i) {
        // We could adjust Tm to translate to the beginning the first line, set TL to tfh, and use
        // T* for each subsequent line, but doing this would require extracting any Tm from DA,
        // which doesn't seem really worth the effort.
        if (i == 0) {
            write(
                QUtil::double_to_string(bbox.llx + static_cast<double>(dx)) + " " +
                QUtil::double_to_string(bbox.lly + static_cast<double>(dy)) + " Td\n");
        } else {
            write("0 " + QUtil::double_to_string(-tfh) + " Td\n");
        }
        write(QPDFObjectHandle::newString(lines.at(i)).unparse() + " Tj\n");
    }
    write("ET\nQ\nEMC");
}

namespace
{
    class TfFinder final: public QPDFObjectHandle::TokenFilter
    {
      public:
        TfFinder() = default;
        ~TfFinder() final = default;

        void
        handleToken(QPDFTokenizer::Token const& token) final
        {
            auto ttype = token.getType();
            auto const& value = token.getValue();
            DA.emplace_back(token.getRawValue());
            switch (ttype) {
            case QPDFTokenizer::tt_integer:
            case QPDFTokenizer::tt_real:
                last_num = strtod(value.c_str(), nullptr);
                last_num_idx = QIntC::to_int(DA.size() - 1);
                break;

            case QPDFTokenizer::tt_name:
                last_name = value;
                break;

            case QPDFTokenizer::tt_word:
                if (token.isWord("Tf")) {
                    if ((last_num > 1.0) && (last_num < 1000.0)) {
                        // These ranges are arbitrary but keep us from doing insane things or
                        // suffering from over/underflow
                        tf = last_num;
                    }
                    tf_idx = last_num_idx;
                    font_name = last_name;
                }
                break;

            default:
                break;
            }
        }

        double
        getTf() const
        {
            return tf;
        }
        std::string
        getFontName() const
        {
            return font_name;
        }

        std::string
        getDA()
        {
            std::string result;
            int i = -1;
            for (auto const& cur: DA) {
                if (++i == tf_idx) {
                    double delta = strtod(cur.c_str(), nullptr) - tf;
                    if (delta > 0.001 || delta < -0.001) {
                        // tf doesn't match the font size passed to Tf, so substitute.
                        QTC::TC("qpdf", "QPDFFormFieldObjectHelper fallback Tf");
                        result += QUtil::double_to_string(tf);
                        continue;
                    }
                }
                result += cur;
            }
            return result;
        }

      private:
        double tf{11.0};
        int tf_idx{-1};
        std::string font_name;
        double last_num{0.0};
        int last_num_idx{-1};
        std::string last_name;
        std::vector<std::string> DA;
    };
} // namespace

QPDFObjectHandle
FormField::getFontFromResource(QPDFObjectHandle resources, std::string const& name)
{
    QPDFObjectHandle result;
    if (resources.isDictionary() && resources.getKey("/Font").isDictionary() &&
        resources.getKey("/Font").hasKey(name)) {
        result = resources.getKey("/Font").getKey(name);
    }
    return result;
}

void
FormField::generateTextAppearance(QPDFAnnotationObjectHelper& aoh)
{
    QPDFObjectHandle AS = aoh.getAppearanceStream("/N");
    if (AS.null()) {
        QPDFObjectHandle::Rectangle rect = aoh.getRect();
        QPDFObjectHandle::Rectangle bbox(0, 0, rect.urx - rect.llx, rect.ury - rect.lly);
        auto dict = Dictionary(
            {{"/BBox", QPDFObjectHandle::newFromRectangle(bbox)},
             {"/Resources", Dictionary({{"/ProcSet", Array({Name("/PDF"), Name("/Text")})}})},
             {"/Type", Name("/XObject")},
             {"/Subtype", Name("/Form")}});
        AS = QPDFObjectHandle::newStream(oh().getOwningQPDF(), "/Tx BMC\nEMC\n");
        AS.replaceDict(dict);
        Dictionary AP = aoh.getAppearanceDictionary();
        if (!AP) {
            aoh.getObjectHandle().replaceKey("/AP", Dictionary::empty());
            AP = aoh.getAppearanceDictionary();
        }
        AP.replaceKey("/N", AS);
    }
    if (!AS.isStream()) {
        aoh.warn("unable to get normal appearance stream for update");
        return;
    }

    if (AS.obj_sp().use_count() > 3) {
        aoh.warn("unable to generate text appearance from shared appearance stream for update");
        return;
    }
    QPDFObjectHandle bbox_obj = AS.getDict().getKey("/BBox");
    if (!bbox_obj.isRectangle()) {
        aoh.warn("unable to get appearance stream bounding box");
        return;
    }
    QPDFObjectHandle::Rectangle bbox = bbox_obj.getArrayAsRectangle();
    std::string DA = getDefaultAppearance();
    std::string V = getValueAsString();
    std::vector<std::string> opt;
    if (isChoice() && (getFlags() & ff_ch_combo) == 0) {
        opt = getChoices();
    }

    TfFinder tff;
    Pl_QPDFTokenizer tok("tf", &tff);
    tok.writeString(DA);
    tok.finish();
    double tf = tff.getTf();
    DA = tff.getDA();

    std::string (*encoder)(std::string const&, char) = &QUtil::utf8_to_ascii;
    std::string font_name = tff.getFontName();
    if (!font_name.empty()) {
        // See if the font is encoded with something we know about.
        Dictionary resources = AS.getDict()["/Resources"];
        Dictionary font = getFontFromResource(resources, font_name);
        if (!font) {
            font = getFontFromResource(getDefaultResources(), font_name);
            if (resources) {
                if (resources.indirect()) {
                    resources = resources.qpdf()->makeIndirectObject(resources.copy());
                    AS.getDict().replaceKey("/Resources", resources);
                }
                // Use mergeResources to force /Font to be local
                QPDFObjectHandle res = resources;
                res.mergeResources(Dictionary({{"/Font", Dictionary::empty()}}));
                res.getKey("/Font").replaceKey(font_name, font);
            }
        }

        if (Name Encoding = font["/Encoding"]) {
            if (Encoding == "/WinAnsiEncoding") {
                encoder = &QUtil::utf8_to_win_ansi;
            } else if (Encoding == "/MacRomanEncoding") {
                encoder = &QUtil::utf8_to_mac_roman;
            }
        }
    }

    V = (*encoder)(V, '?');
    for (size_t i = 0; i < opt.size(); ++i) {
        opt.at(i) = (*encoder)(opt.at(i), '?');
    }
    AS.addTokenFilter(
        std::shared_ptr<QPDFObjectHandle::TokenFilter>(new ValueSetter(DA, V, opt, tf, bbox)));
}

Coverage Report

Created: 2025-11-11 07:06