status-go/protocol/messenger_identity.go

272 lines
6.3 KiB
Go
Raw Normal View History

2022-02-17 15:13:10 +00:00
package protocol
import (
"context"
2022-02-17 15:13:10 +00:00
"errors"
2022-11-24 20:48:26 +00:00
"fmt"
2022-02-17 15:13:10 +00:00
"regexp"
2023-03-08 14:04:02 +00:00
"runtime"
2022-02-17 15:13:10 +00:00
"strings"
Sync Settings (#2478) * Sync Settings * Added valueHandlers and Database singleton Some issues remain, need a way to comparing incoming sql.DB to check if the connection is to a different file or not. Maybe make singleton instance per filename * Added functionality to check the sqlite filename * Refactor of Database.SaveSyncSettings to be used as a handler * Implemented inteface for setting sync protobuf factories * Refactored and completed adhoc send setting sync * Tidying up * Immutability refactor * Refactor settings into dedicated package * Breakout structs * Tidy up * Refactor of bulk settings sync * Bug fixes * Addressing feedback * Fix code dropped during rebase * Fix for db closed * Fix for node config related crashes * Provisional fix for type assertion - issue 2 * Adding robust type assertion checks * Partial fix for null literal db storage and json encoding * Fix for passively handling nil sql.DB, and checking if elem has len and if len is 0 * Added test for preferred name behaviour * Adding saved sync settings to MessengerResponse * Completed granular initial sync and clock from network on save * add Settings to isEmpty * Refactor of protobufs, partially done * Added syncSetting receiver handling, some bug fixes * Fix for sticker packs * Implement inactive flag on sync protobuf factory * Refactor of types and structs * Added SettingField.CanSync functionality * Addressing rebase artifact * Refactor of Setting SELECT queries * Refactor of string return queries * VERSION bump and migration index bump * Deactiveate Sync Settings * Deactiveated preferred_name and send_status_updates Co-authored-by: Andrea Maria Piana <andrea.maria.piana@gmail.com>
2022-03-23 18:47:00 +00:00
"github.com/status-im/status-go/multiaccounts/settings"
2023-06-05 11:10:26 +00:00
sociallinkssettings "github.com/status-im/status-go/multiaccounts/settings_social_links"
2022-11-24 20:48:26 +00:00
"github.com/status-im/status-go/protocol/encryption/multidevice"
2022-08-05 11:22:35 +00:00
"github.com/status-im/status-go/protocol/identity"
2022-02-17 15:13:10 +00:00
"github.com/status-im/status-go/protocol/identity/alias"
2022-11-24 20:48:26 +00:00
"github.com/status-im/status-go/server"
2022-02-17 15:13:10 +00:00
)
const (
maxBioLength = 240
maxSocialLinkTextLength = 24
)
2022-02-17 15:13:10 +00:00
var ErrInvalidDisplayNameRegExp = errors.New("only letters, numbers, underscores and hyphens allowed")
var ErrInvalidDisplayNameEthSuffix = errors.New(`usernames ending with "eth" are not allowed`)
var ErrInvalidDisplayNameNotAllowed = errors.New("name is not allowed")
var ErrInvalidBioLength = errors.New("invalid bio length")
var ErrInvalidSocialLinkTextLength = errors.New("invalid social link text length")
2022-02-17 15:13:10 +00:00
func ValidateDisplayName(displayName *string) error {
name := strings.TrimSpace(*displayName)
*displayName = name
if name == "" {
return nil
}
// ^[\\w-\\s]{5,24}$ to allow spaces
if match, _ := regexp.MatchString("^[\\w-\\s]{5,24}$", name); !match {
return ErrInvalidDisplayNameRegExp
}
// .eth should not happen due to the regexp above, but let's keep it here in case the regexp is changed in the future
if strings.HasSuffix(name, "_eth") || strings.HasSuffix(name, ".eth") || strings.HasSuffix(name, "-eth") {
return ErrInvalidDisplayNameEthSuffix
}
if alias.IsAlias(name) {
return ErrInvalidDisplayNameNotAllowed
}
return nil
}
func (m *Messenger) SetDisplayName(displayName string) error {
2022-02-17 15:13:10 +00:00
currDisplayName, err := m.settings.DisplayName()
if err != nil {
return err
}
if currDisplayName == displayName {
return nil // Do nothing
}
if err = ValidateDisplayName(&displayName); err != nil {
return err
}
m.account.Name = displayName
2024-02-01 15:43:41 +00:00
err = m.multiAccounts.UpdateDisplayName(m.account.KeyUID, displayName)
2022-02-17 15:13:10 +00:00
if err != nil {
return err
}
Sync Settings (#2478) * Sync Settings * Added valueHandlers and Database singleton Some issues remain, need a way to comparing incoming sql.DB to check if the connection is to a different file or not. Maybe make singleton instance per filename * Added functionality to check the sqlite filename * Refactor of Database.SaveSyncSettings to be used as a handler * Implemented inteface for setting sync protobuf factories * Refactored and completed adhoc send setting sync * Tidying up * Immutability refactor * Refactor settings into dedicated package * Breakout structs * Tidy up * Refactor of bulk settings sync * Bug fixes * Addressing feedback * Fix code dropped during rebase * Fix for db closed * Fix for node config related crashes * Provisional fix for type assertion - issue 2 * Adding robust type assertion checks * Partial fix for null literal db storage and json encoding * Fix for passively handling nil sql.DB, and checking if elem has len and if len is 0 * Added test for preferred name behaviour * Adding saved sync settings to MessengerResponse * Completed granular initial sync and clock from network on save * add Settings to isEmpty * Refactor of protobufs, partially done * Added syncSetting receiver handling, some bug fixes * Fix for sticker packs * Implement inactive flag on sync protobuf factory * Refactor of types and structs * Added SettingField.CanSync functionality * Addressing rebase artifact * Refactor of Setting SELECT queries * Refactor of string return queries * VERSION bump and migration index bump * Deactiveate Sync Settings * Deactiveated preferred_name and send_status_updates Co-authored-by: Andrea Maria Piana <andrea.maria.piana@gmail.com>
2022-03-23 18:47:00 +00:00
err = m.settings.SaveSettingField(settings.DisplayName, displayName)
2022-02-17 15:13:10 +00:00
if err != nil {
return err
}
err = m.UpdateKeypairName(m.account.KeyUID, displayName)
if err != nil {
return err
}
err = m.resetLastPublishedTimeForChatIdentity()
if err != nil {
return err
}
return m.publishContactCode()
}
func (m *Messenger) SaveSyncDisplayName(displayName string, clock uint64) error {
err := m.settings.SaveSyncSetting(settings.DisplayName, displayName, clock)
if err != nil {
return err
2022-02-17 15:13:10 +00:00
}
preferredNameClock, err := m.settings.GetSettingLastSynced(settings.PreferredName)
if err != nil {
return err
}
// check clock of preferred name to avoid override account name
if preferredNameClock < clock {
m.account.Name = displayName
return m.multiAccounts.SaveAccount(*m.account)
}
return nil
2022-02-17 15:13:10 +00:00
}
2022-08-05 11:22:35 +00:00
func ValidateBio(bio *string) error {
if len(*bio) > maxBioLength {
return ErrInvalidBioLength
}
return nil
}
2022-08-05 11:22:35 +00:00
func (m *Messenger) SetBio(bio string) error {
currentBio, err := m.settings.Bio()
if err != nil {
return err
}
if currentBio == bio {
return nil // Do nothing
}
if err = ValidateBio(&bio); err != nil {
return err
}
2022-08-05 11:22:35 +00:00
if err = m.settings.SaveSettingField(settings.Bio, bio); err != nil {
2022-08-05 11:22:35 +00:00
return err
}
if err = m.resetLastPublishedTimeForChatIdentity(); err != nil {
2022-08-05 11:22:35 +00:00
return err
}
return m.publishContactCode()
}
2023-06-05 11:10:26 +00:00
func ValidateSocialLinks(socialLinks identity.SocialLinks) error {
for _, link := range socialLinks {
l := link
2023-06-05 11:10:26 +00:00
if err := ValidateSocialLink(l); err != nil {
return err
}
}
return nil
}
func ValidateSocialLink(link *identity.SocialLink) error {
if len(link.Text) > maxSocialLinkTextLength {
return ErrInvalidSocialLinkTextLength
}
return nil
}
2023-06-05 11:10:26 +00:00
func (m *Messenger) AddOrReplaceSocialLinks(socialLinks identity.SocialLinks) error {
if len(socialLinks) > sociallinkssettings.MaxNumOfSocialLinks {
return errors.New("exceeded maximum number of social links")
}
2022-08-05 11:22:35 +00:00
currentSocialLinks, err := m.settings.GetSocialLinks()
if err != nil {
return err
}
2023-06-05 11:10:26 +00:00
if currentSocialLinks.Equal(socialLinks) {
2022-08-05 11:22:35 +00:00
return nil // Do nothing
}
2023-06-05 11:10:26 +00:00
err = ValidateSocialLinks(socialLinks)
if err != nil {
return err
}
2022-08-05 11:22:35 +00:00
err = m.withChatClock(func(chatID string, clock uint64) error {
2023-06-05 11:10:26 +00:00
err = m.settings.AddOrReplaceSocialLinksIfNewer(socialLinks, clock)
if err != nil {
return err
}
m.selfContact.SocialLinks = socialLinks
m.publishSelfContactSubscriptions(&SelfContactChangeEvent{
SocialLinksChanged: true,
})
2023-06-05 11:10:26 +00:00
err = m.syncSocialLinks(context.Background(), m.dispatchMessage)
return err
})
if err != nil {
return err
}
if err = m.resetLastPublishedTimeForChatIdentity(); err != nil {
2022-08-05 11:22:35 +00:00
return err
}
2023-06-05 11:10:26 +00:00
return m.publishContactCode()
}
2023-06-05 11:10:26 +00:00
func (m *Messenger) GetSocialLinks() (identity.SocialLinks, error) {
return m.settings.GetSocialLinks()
2022-08-05 11:22:35 +00:00
}
2022-11-24 20:48:26 +00:00
func (m *Messenger) setInstallationHostname() error {
imd, err := m.getOurInstallationMetadata()
if err != nil {
return err
2022-11-24 20:48:26 +00:00
}
2023-03-08 14:04:02 +00:00
// If the name and device are already set, don't do anything
if len(imd.Name) != 0 && len(imd.DeviceType) != 0 {
2022-11-24 20:48:26 +00:00
return nil
}
2023-03-08 14:04:02 +00:00
if len(imd.Name) == 0 {
deviceName, err := m.settings.DeviceName()
2023-03-08 14:04:02 +00:00
if err != nil {
return err
}
if deviceName != "" {
imd.Name = deviceName
} else {
hn, err := server.GetDeviceName()
if err != nil {
return err
}
imd.Name = fmt.Sprintf("%s %s", hn, imd.Name)
}
2023-03-08 14:04:02 +00:00
}
if len(imd.DeviceType) == 0 {
imd.DeviceType = runtime.GOOS
2022-11-24 20:48:26 +00:00
}
2023-03-08 14:04:02 +00:00
2022-11-24 20:48:26 +00:00
return m.setInstallationMetadata(m.installationID, imd)
2023-03-08 14:04:02 +00:00
2022-11-24 20:48:26 +00:00
}
func (m *Messenger) getOurInstallationMetadata() (*multidevice.InstallationMetadata, error) {
ourInstallation, ok := m.allInstallations.Load(m.installationID)
if !ok {
return nil, fmt.Errorf("messenger's installationID is not set or not loadable")
}
if ourInstallation.InstallationMetadata == nil {
return new(multidevice.InstallationMetadata), nil
}
return ourInstallation.InstallationMetadata, nil
}
func (m *Messenger) SetInstallationDeviceType(deviceType string) error {
if strings.TrimSpace(deviceType) == "" {
return errors.New("device type is empty")
}
imd, err := m.getOurInstallationMetadata()
if err != nil {
return err
}
// If the name is already set, don't do anything
if len(imd.DeviceType) != 0 {
return nil
}
imd.DeviceType = deviceType
return m.setInstallationMetadata(m.installationID, imd)
}