Add AdditionalFields functionality to PollBuilder

Author: jamescowens

src/gridcoin/voting/builders.cpp

@@ -1095,6 +1095,62 @@ PollBuilder PollBuilder::AddChoice(std::string label)
     return std::move(*this);
 }
 
+PollBuilder PollBuilder::SetAdditionalFields(std::vector<Poll::AdditionalField> fields)
+{
+    m_poll->m_additional_fields = Poll::AdditionalFieldList();
+
+    return AddAdditionalFields(std::move(fields));
+}
+
+PollBuilder PollBuilder::AddAdditionalFields(std::vector<Poll::AdditionalField> fields)
+{
+    for (auto& field : fields) {
+        *this = AddAdditionalField(std::move(field));
+    }
+
+    return std::move(*this);
+}
+
+PollBuilder PollBuilder::AddAdditionalField(Poll::AdditionalField field)
+{
+    // Make sure there are no leading and trailing spaces.
+    field.m_name = TrimString(field.m_name);
+    field.m_value = TrimString(field.m_value);
+
+    if (!field.WellFormed()) {
+        throw VotingError(_("The field is not well-formed."));
+    }
+
+    if (m_poll->m_additional_fields.size() + 1 > POLL_MAX_ADDITIONAL_FIELDS_SIZE) {
+        throw VotingError(strprintf(
+                              _("Poll cannot contain more than %s additional fields"),
+                              ToString(POLL_MAX_ADDITIONAL_FIELDS_SIZE)));
+    }
+
+    if (field.m_name.size() > Poll::AdditionalField::MAX_N_OR_V_SIZE) {
+        throw VotingError(strprintf(
+                              _("Poll additional field name \"%s\" exceeds %s characters."),
+                              field.m_name,
+                              ToString(Poll::AdditionalField::MAX_N_OR_V_SIZE)));
+    }
+
+    if (field.m_value.size() > Poll::AdditionalField::MAX_N_OR_V_SIZE) {
+        throw VotingError(strprintf(
+                              _("Poll additional field value \"%s\" for field name \"%s\" exceeds %s characters."),
+                              field.m_value,
+                              field.m_name,
+                              ToString(Poll::AdditionalField::MAX_N_OR_V_SIZE)));
+    }
+
+    if (m_poll->m_additional_fields.FieldExists(field.m_name)) {
+        throw VotingError(strprintf(_("Duplicate poll additional field: %s"), field.m_name));
+    }
+
+    m_poll->m_additional_fields.Add(std::move(field));
+
+    return std::move(*this);
+}
+
 CWalletTx PollBuilder::BuildContractTx(CWallet* const pwallet)
 {
     if (!pwallet) {

src/gridcoin/voting/builders.h

@@ -5,7 +5,7 @@
 #ifndef GRIDCOIN_VOTING_BUILDERS_H
 #define GRIDCOIN_VOTING_BUILDERS_H
 
-#include "gridcoin/voting/fwd.h"
+#include "gridcoin/voting/poll.h"
 
 #include <memory>
 #include <vector>
@@ -166,6 +166,36 @@ class PollBuilder
     //!
     PollBuilder AddChoice(std::string label);
 
+    //!
+    //! \brief Set the set of additional fields for the poll.
+    //!
+    //! \param labels A set of AdditionalFields to set.
+    //!
+    //! \throws VotingError If any of the fields are malformed, or if the set of fields
+    //! contains a duplicate label.
+    //!
+    PollBuilder SetAdditionalFields(std::vector<Poll::AdditionalField> fields);
+
+    //!
+    //! \brief Add a set of additional fields for the poll.
+    //!
+    //! \param labels A set of AdditionalFields to add.
+    //!
+    //! \throws VotingError If any of the fields are malformed, or if the set of fields
+    //! contains a duplicate label.
+    //!
+    PollBuilder AddAdditionalFields(std::vector<Poll::AdditionalField> fields);
+
+    //!
+    //! \brief Add an additional field for the poll.
+    //!
+    //! \param AdditionalField The additional field name-value to add.
+    //!
+    //! \throws VotingError If the field is malformed, or if the set of fields
+    //! contains a duplicate label.
+    //!
+    PollBuilder AddAdditionalField(Poll::AdditionalField field);
+
     //!
     //! \brief Generate a poll contract transaction with the constructed poll.
     //!

src/gridcoin/voting/fwd.h

@@ -29,6 +29,11 @@ constexpr CAmount POLL_REQUIRED_BALANCE = 100000 * COIN;
 //!
 constexpr size_t POLL_MAX_CHOICES_SIZE = 20;
 
+//!
+//! \brief The maximum number of additional fields that a poll can contain.
+//!
+constexpr size_t POLL_MAX_ADDITIONAL_FIELDS_SIZE = 16;
+
 //!
 //! \brief Describes the poll types.
 //!

src/gridcoin/voting/poll.cpp

@@ -422,6 +422,11 @@ void AdditionalFieldList::Add(std::string name, std::string value, bool required
     m_additional_fields.emplace_back(std::move(additional_field));
 }
 
+void AdditionalFieldList::Add(AdditionalField field)
+{
+    m_additional_fields.emplace_back(std::move(field));
+}
+
 // -----------------------------------------------------------------------------
 // Class: Poll::ChoiceList
 // -----------------------------------------------------------------------------

src/gridcoin/voting/poll.h

@@ -334,6 +334,11 @@ class Poll
         //!
         void Add(std::string name, std::string value, bool required);
 
+        //!
+        //! \brief Add an additional field to the poll.
+        //!
+        void Add(AdditionalField field);
+
         ADD_SERIALIZE_METHODS;
 
         template <typename Stream, typename Operation>