Merge pull request #7 from Doy-lee/doyle-split-pro-bitset

Split the bitset into separate profile/message bitsets

Author: Doy-lee

README.md

@@ -25,6 +25,9 @@
 #
 cmake -G Ninja -S . -B Build
 
+# Regenerate protobuf files
+cmake --build Build --target regen-protobuf --parallel --verbose
+
 # Build
 cmake --build Build --parallel --verbose
 ```

include/session/config/base.hpp

@@ -434,12 +434,16 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- This will be assigned to the dict if it is missing
-        void insert_if_missing(config::scalar&& value) {
+        //
+        /// Ouputs:
+        /// - `bool` -- True if the value was inserted, false otherwise
+        bool insert_if_missing(config::scalar&& value) {
             if (!_conf.is_dirty())
                 if (auto current = get_clean<config::set>(); current && current->count(value))
-                    return;
+                    return false;
 
             get_dirty<config::set>().insert(std::move(value));
+            return true;
         }
 
         /// API: base/ConfigBase::DictFieldProxy::set_erase_impl
@@ -448,28 +452,35 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- This will be deleted from the dict
-        void set_erase_impl(const config::scalar& value) {
+        ///
+        /// Outputs:
+        /// - `bool` -- True if an element was erased, false otherwise
+        bool set_erase_impl(const config::scalar& value) {
             if (!_conf.is_dirty())
                 if (auto current = get_clean<config::set>(); current && !current->count(value))
-                    return;
+                    return false;
 
             config::dict* data = &_conf.dirty().data();
 
             for (const auto& key : _inter_keys) {
                 auto it = data->find(key);
                 data = it != data->end() ? std::get_if<config::dict>(&it->second) : nullptr;
                 if (!data)
-                    return;
+                    return false;
             }
 
             auto it = data->find(_last_key);
             if (it == data->end())
-                return;
+                return false;
             auto& val = it->second;
-            if (auto* current = std::get_if<config::set>(&val))
+            bool result = false;
+            if (auto* current = std::get_if<config::set>(&val)) {
                 current->erase(value);
-            else
+                result = true;
+            } else {
                 val.emplace<config::set>();
+            }
+            return result;
         }
 
       public:
@@ -795,8 +806,8 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_insert(std::string_view value) {
-            insert_if_missing(config::scalar{std::string{value}});
+        bool set_insert(std::string_view value) {
+            return insert_if_missing(config::scalar{std::string{value}});
         }
 
         /// API: base/ConfigBase::DictFieldProxy::set_insert(int64_t)
@@ -806,7 +817,7 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_insert(int64_t value) { insert_if_missing(config::scalar{value}); }
+        bool set_insert(int64_t value) { return insert_if_missing(config::scalar{value}); }
 
         /// API: base/ConfigBase::DictFieldProxy::set_erase(std::string_view)
         ///
@@ -816,8 +827,11 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_erase(std::string_view value) {
-            set_erase_impl(config::scalar{std::string{value}});
+        ///
+        /// Outputs:
+        /// - `bool` -- True if an element was erased, false otherwise
+        bool set_erase(std::string_view value) {
+            return set_erase_impl(config::scalar{std::string{value}});
         }
 
         /// API: base/ConfigBase::DictFieldProxy::set_erase(int64_t)
@@ -828,7 +842,10 @@ class ConfigBase : public ConfigSig {
         ///
         /// Inputs:
         /// - `value` -- The value to be set
-        void set_erase(int64_t value) { set_erase_impl(scalar{value}); }
+        ///
+        /// Outputs:
+        /// - `bool` -- True if an element was erased, false otherwise
+        bool set_erase(int64_t value) { return set_erase_impl(scalar{value}); }
 
         /// API: base/ConfigBase::DictFieldProxy::emplace
         ///

include/session/config/contacts.h

@@ -36,7 +36,7 @@ typedef struct contacts_contact {
 
     int64_t created;  // unix timestamp (seconds)
 
-    SESSION_PROTOCOL_PRO_FEATURES pro_features;
+    session_protocol_pro_profile_bitset profile_bitset = {};
 
 } contacts_contact;
 
@@ -55,7 +55,7 @@ typedef struct contacts_blinded_contact {
     bool legacy_blinding;
     int64_t created;  // unix timestamp (seconds)
 
-    SESSION_PROTOCOL_PRO_FEATURES pro_features;
+    session_protocol_pro_profile_bitset profile_bitset = {};
 
 } contacts_blinded_contact;
 

include/session/config/contacts.hpp

@@ -48,7 +48,7 @@ namespace session::config {
 ///     j - Unix timestamp (seconds) when the contact was created ("j" to match user_groups
 ///         equivalent "j"oined field). Omitted if 0.
 ///     t - The `profile_updated` unix timestamp (seconds) for this contacts profile information.
-///     f - session pro features bitset for this contact
+///     f - session pro profile features bitset for this contact
 ///
 /// b - dict of blinded contacts.  This is a nested dict where the outer keys are the BASE_URL of
 ///     the community the blinded contact originated from and the outer value is a dict containing:
@@ -70,7 +70,7 @@ namespace session::config {
 ///       j - Unix timestamp (seconds) when the contact was created ("j" to match user_groups
 ///           equivalent "j"oined field). Omitted if 0.
 ///       y - flag indicating whether the blinded message request is using legac"y" blinding.
-///       f - session pro features bitset for this blinded contact
+///       f - session pro profile features bitset for this blinded contact
 
 struct contact_info {
     static constexpr size_t MAX_NAME_LENGTH = 100;
@@ -96,7 +96,7 @@ struct contact_info {
     std::chrono::seconds exp_timer{0};                 // The expiration timer (in seconds)
     int64_t created = 0;  // Unix timestamp (seconds) when this contact was added
 
-    SESSION_PROTOCOL_PRO_FEATURES pro_features = SESSION_PROTOCOL_PRO_FEATURES_NIL;
+    ProProfileBitset profile_bitset = {};
 
     explicit contact_info(std::string sid);
 
@@ -122,25 +122,6 @@ struct contact_info {
     void set_nickname(std::string nickname);
     void set_nickname_truncated(std::string nickname);
 
-    /// API: contacts/contact_info::get_pro_features
-    ///
-    /// Retrieves the bitset indicating which pro features the user currently has enabled.
-    ///
-    /// Inputs: None
-    ///
-    /// Outputs:
-    /// - `SESSION_PROTOCOL_PRO_FEATURES` - bitset indicating which pro features are enabled.
-    SESSION_PROTOCOL_PRO_FEATURES get_pro_features() const;
-
-    /// API: contacts/contact_info::set_pro_features
-    ///
-    /// Updates the pro features bitset for this contact. Note: If the bitset provided contains the
-    /// '10K_CHARACTER_LIMIT' feature then it will be removed.
-    ///
-    /// Inputs:
-    /// - `features` -- The updated pro features bitset to use.
-    void set_pro_features(SESSION_PROTOCOL_PRO_FEATURES features);
-
   private:
     friend class Contacts;
     void load(const dict& info_dict);
@@ -160,7 +141,7 @@ struct blinded_contact_info {
     bool legacy_blinding;
     std::chrono::sys_seconds created{};  // Unix timestamp (seconds) when this contact was added
 
-    SESSION_PROTOCOL_PRO_FEATURES pro_features = SESSION_PROTOCOL_PRO_FEATURES_NIL;
+    ProProfileBitset profile_bitset = {};
 
     blinded_contact_info() = default;
     explicit blinded_contact_info(
@@ -219,25 +200,6 @@ struct blinded_contact_info {
     /// - `std::string` -- Returns the pubkey
     std::string community_pubkey_hex() const { return comm.pubkey_hex(); }
 
-    /// API: contacts/blinded_contact_info::get_pro_features
-    ///
-    /// Retrieves the bitset indicating which pro features the user currently has enabled.
-    ///
-    /// Inputs: None
-    ///
-    /// Outputs:
-    /// - `SESSION_PROTOCOL_PRO_FEATURES` - bitset indicating which pro features are enabled.
-    SESSION_PROTOCOL_PRO_FEATURES get_pro_features() const;
-
-    /// API: contacts/blinded_contact_info::set_pro_features
-    ///
-    /// Updates the pro features bitset for this contact. Note: If the bitset provided contains the
-    /// '10K_CHARACTER_LIMIT' feature then it will be removed.
-    ///
-    /// Inputs:
-    /// - `features` -- The updated pro features bitset to use.
-    void set_pro_features(SESSION_PROTOCOL_PRO_FEATURES features);
-
   private:
     friend class Contacts;
     friend struct session::config::comm_iterator_helper;
@@ -480,9 +442,8 @@ class Contacts : public ConfigBase {
     ///
     /// Inputs:
     /// - `session_id` -- hex string of the session id
-    /// - `features` -- The updated pro features bitset to use. Note: If the bitset provided
-    /// contains the '10K_CHARACTER_LIMIT' feature then it will be removed.
-    void set_pro_features(std::string_view session_id, SESSION_PROTOCOL_PRO_FEATURES features);
+    /// - `features` -- The updated profile features to use
+    void set_pro_features(std::string_view session_id, ProProfileBitset features);
 
     /// API: contacts/contacts::erase
     ///

include/session/config/user_profile.h

@@ -348,8 +348,8 @@ LIBSESSION_EXPORT bool user_profile_remove_pro_config(config_object* conf);
 /// - `conf` -- [in] Pointer to the config object
 ///
 /// Outputs:
-/// - `SESSION_PROTOCOL_PRO_FEATURES` - bitset indicating which pro features are enabled.
-LIBSESSION_EXPORT SESSION_PROTOCOL_PRO_FEATURES
+/// - `session_protocol_pro_profile_bitset` - bitset indicating which profile features are enabled.
+LIBSESSION_EXPORT session_protocol_pro_profile_bitset
 user_profile_get_pro_features(const config_object* conf);
 
 /// API: user_profile/user_profile_set_pro_badge

include/session/config/user_profile.hpp

@@ -285,8 +285,11 @@ class UserProfile : public ConfigBase {
     /// Inputs: None
     ///
     /// Outputs:
-    /// - `SESSION_PROTOCOL_PRO_FEATURES` - bitset indicating which pro features are enabled.
-    SESSION_PROTOCOL_PRO_FEATURES get_pro_features() const;
+    /// - Bitset with individual bits set on it corresponding to
+    /// SESSION_PROTOCOL_PRO_PROFILE_FEATURES_BITSET. It is possible to receive bits set that don't
+    /// have a corresponding enum value if you are receiving a bitset from a newer client with newer
+    /// features enabled. These flags should be ignored by clients that do not recognise them.
+    ProProfileBitset get_profile_bitset() const;
 
     /// API: user_profile/UserProfile::set_pro_badge
     ///