go/contacts/interface.go - master - githubmirror/client

go/contacts/interface.go
75 строк2 KB
zoom-ua
gofumpt (#28710)
17 дек 2025, 17:16
17 дек 2025, 17:16cda510b
// Copyright 2019 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package contacts

import (
	"fmt"
	"time"

	"github.com/keybase/client/go/libkb"
	"github.com/keybase/client/go/protocol/keybase1"
)

type ContactLookupResult struct {
	UID     keybase1.UID `json:"uid,omitempty"`
	Coerced string       `json:"coerced,omitempty"`
	Error   string       `json:"err,omitempty"`
}

type (
	ContactLookupKey     string
	ContactLookupResults struct {
		Results map[ContactLookupKey]ContactLookupResult
		// Results provided - or not provided - by this provider
		// should are valid for the following amount of time:
		ResolvedFreshness   time.Duration
		UnresolvedFreshness time.Duration
		Token               Token
	}
)

func NewContactLookupResults() ContactLookupResults {
	return ContactLookupResults{
		Results: make(map[ContactLookupKey]ContactLookupResult),
	}
}

func (r *ContactLookupResults) FindComponent(component keybase1.ContactComponent) (res ContactLookupResult, found bool) {
	var key ContactLookupKey
	switch {
	case component.Email != nil:
		key = MakeEmailLookupKey(*component.Email)
	case component.PhoneNumber != nil:
		key = MakePhoneLookupKey(*component.PhoneNumber)
	default:
		return res, false
	}
	res, found = r.Results[key]
	return res, found
}

func MakeEmailLookupKey(e keybase1.EmailAddress) ContactLookupKey {
	return ContactLookupKey(fmt.Sprintf("e:%s", string(e)))
}

func MakePhoneLookupKey(p keybase1.RawPhoneNumber) ContactLookupKey {
	return ContactLookupKey(fmt.Sprintf("p:%s", string(p)))
}

type ContactUsernameAndFullName struct {
	Username string
	Fullname string
}

type Token string

const NoneToken Token = ""

type ContactsProvider interface {
	LookupAllWithToken(libkb.MetaContext, []keybase1.EmailAddress, []keybase1.RawPhoneNumber, Token) (ContactLookupResults, error)
	LookupAll(libkb.MetaContext, []keybase1.EmailAddress, []keybase1.RawPhoneNumber) (ContactLookupResults, error)
	FindUsernames(libkb.MetaContext, []keybase1.UID) (map[keybase1.UID]ContactUsernameAndFullName, error)
	FindFollowing(libkb.MetaContext, []keybase1.UID) (map[keybase1.UID]bool, error)
	FindServiceMaps(libkb.MetaContext, []keybase1.UID) (map[keybase1.UID]libkb.UserServiceSummary, error)
}