utils

package
v2.11.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2018 License: BSD-3-Clause, BSD-3-Clause Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ChatTopicIDLen    = 16
	ChatTopicIDSuffix = 0x20
)

Variables

This section is empty.

Functions

func AddUserToTLFName 

func AddUserToTLFName(g *globals.Context, tlfName string, vis keybase1.TLFVisibility,
	membersType chat1.ConversationMembersType) string

func AggRateLimits 

func AggRateLimits(rlimits []chat1.RateLimit) (res []chat1.RateLimit)

func AggRateLimitsP 

func AggRateLimitsP(rlimits []*chat1.RateLimit) (res []chat1.RateLimit)

AggRateLimitsP takes a list of rate limit responses and dedups them to the last one received of each category

func AllChatConversationStatuses added in v1.0.19 

func AllChatConversationStatuses() (res []chat1.ConversationStatus)

func AssertLoggedInUID 

func AssertLoggedInUID(ctx context.Context, g *globals.Context) (uid gregor1.UID, err error)

func AssetsForMessage 

func AssetsForMessage(g *globals.Context, msgBody chat1.MessageBody) (assets []chat1.Asset)

assetsForMessage gathers all assets on a message

func Collar 

func Collar(lower int, ideal int, upper int) int

upper bounds takes higher priority

func CreateHiddenPlaceholder 

func CreateHiddenPlaceholder(msgID chat1.MessageID) chat1.MessageUnboxed

func CreateTopicNameState added in v1.0.27 

func CreateTopicNameState(cmp chat1.ConversationIDMessageIDPairs) (chat1.TopicNameState, error)

func DecodeBase64 added in v1.0.29 

func DecodeBase64(enc []byte) ([]byte, error)

func DecodePagination added in v1.0.29 

func DecodePagination(p *chat1.UIPagination) (res *chat1.Pagination, err error)

func FilterByType 

func FilterByType(msgs []chat1.MessageUnboxed, query *chat1.GetThreadQuery, includeAllErrors bool) (res []chat1.MessageUnboxed)

FilterByType filters messages based on a query. If includeAllErrors then MessageUnboxedError are all returned. Otherwise, they are filtered based on type. Messages whose type cannot be determined are considered errors.

func FilterExploded added in v1.0.48 

func FilterExploded(conv types.UnboxConversationInfo, msgs []chat1.MessageUnboxed, now time.Time) (res []chat1.MessageUnboxed)

Filter messages that are both exploded that are no longer shown in the GUI (as ash lines)

func ForceReloadUPAKsForUIDs 

func ForceReloadUPAKsForUIDs(ctx context.Context, g *globals.Context, uids []keybase1.UID) error

func GetConvMtime added in v1.0.28 

func GetConvMtime(conv chat1.Conversation) gregor1.Time

func GetConvMtimeLocal added in v1.0.28 

func GetConvMtimeLocal(conv chat1.ConversationLocal) gregor1.Time

func GetConvSnippet added in v1.0.28 

func GetConvSnippet(conv chat1.ConversationLocal, currentUsername string) (snippet, decoration string)

func GetDesktopNotificationSnippet 

func GetDesktopNotificationSnippet(conv *chat1.ConversationLocal, currentUsername string) string

We don't want to display the contents of an exploding message in notifications

func GetGregorConn 

func GetGregorConn(ctx context.Context, g *globals.Context, log DebugLabeler,
	handler func(nist *libkb.NIST) rpc.ConnectionHandler) (conn *rpc.Connection, token gregor1.SessionToken, err error)

func GetHeadline added in v1.0.29 

func GetHeadline(conv chat1.ConversationLocal) string

func GetMsgSnippet added in v1.0.33 

func GetMsgSnippet(msg chat1.MessageUnboxed, conv chat1.ConversationLocal, currentUsername string) (snippet, decoration string)

func GetMsgSummaryByType added in v1.0.40 

func GetMsgSummaryByType(msgs []chat1.MessageSummary, typ chat1.MessageType) (chat1.MessageSummary, error)

func GetQueryRe 

func GetQueryRe(query string) (*regexp.Regexp, error)

GetQueryRe returns a regex to match the query string on message text. This is used for result highlighting.

func GetReaction 

func GetReaction(msg chat1.MessageUnboxed) (string, error)

func GetSupersedes added in v1.0.19 

func GetSupersedes(msg chat1.MessageUnboxed) ([]chat1.MessageID, error)

GetSupersedes must be called with a valid msg

func GetTopicName added in v1.0.27 

func GetTopicName(conv chat1.ConversationLocal) string

func IsConvEmpty added in v1.0.21 

func IsConvEmpty(conv chat1.Conversation) bool

func IsNotifiableChatMessageType added in v1.0.34 

func IsNotifiableChatMessageType(messageType chat1.MessageType, atMentions []gregor1.UID,
	chanMention chat1.ChannelMention) bool

func IsPermanentErr 

func IsPermanentErr(err error) bool

func IsVisibleChatMessageType added in v1.0.19 

func IsVisibleChatMessageType(messageType chat1.MessageType) bool

func NewChatTopicID added in v1.0.19 

func NewChatTopicID() (id []byte, err error)

func NotificationInfoSet added in v1.0.27 

func NotificationInfoSet(settings *chat1.ConversationNotificationInfo,
	apptype keybase1.DeviceType,
	kind chat1.NotificationKind, enabled bool)

func ParseAndDecorateAtMentionedUIDs added in v1.0.27 

func ParseAndDecorateAtMentionedUIDs(ctx context.Context, body string, upak libkb.UPAKLoader, debug *DebugLabeler) (newBody string, atRes []gregor1.UID, chanRes chat1.ChannelMention)

func ParseAtMentionedUIDs added in v1.0.27 

func ParseAtMentionedUIDs(ctx context.Context, body string, upak libkb.UPAKLoader, debug *DebugLabeler) (atRes []gregor1.UID, chanRes chat1.ChannelMention)

func ParseAtMentionsNames added in v1.0.27 

func ParseAtMentionsNames(ctx context.Context, body string) (res []string)

func ParseChannelNameMentions added in v1.0.34 

func ParseChannelNameMentions(ctx context.Context, body string, uid gregor1.UID, teamID chat1.TLFID,
	ts types.TeamChannelSource) (res []chat1.ChannelNameMention)

func ParseDurationExtended 

func ParseDurationExtended(s string) (d time.Duration, err error)

parseDurationExtended is like time.ParseDuration, but adds "d" unit. "1d" is one day, defined as 24*time.Hour. Only whole days are supported for "d" unit, but it can be followed by smaller units, e.g., "1d1h".

func ParseTimeFromRFC3339OrDurationFromPast 

func ParseTimeFromRFC3339OrDurationFromPast(g *globals.Context, s string) (t time.Time, err error)

func PickLatestMessageSummary 

func PickLatestMessageSummary(conv chat1.Conversation, typs []chat1.MessageType) (res chat1.MessageSummary, err error)

func PickLatestMessageUnboxed added in v1.0.28 

func PickLatestMessageUnboxed(conv chat1.ConversationLocal, typs []chat1.MessageType) (res chat1.MessageUnboxed, err error)

PickLatestMessageUnboxed gets the latest message with one `typs`. This method can return deleted messages which have a blank body.

func PluckConvIDs added in v1.0.27 

func PluckConvIDs(convs []chat1.Conversation) (res []chat1.ConversationID)

func PluckConvIDsLocal added in v1.0.27 

func PluckConvIDsLocal(convs []chat1.ConversationLocal) (res []chat1.ConversationID)

func PluckConvIDsRC 

func PluckConvIDsRC(convs []types.RemoteConversation) (res []chat1.ConversationID)

func PluckConvs added in v1.0.33 

func PluckConvs(rcs []types.RemoteConversation) (res []chat1.Conversation)

func PluckMUMessageIDs 

func PluckMUMessageIDs(msgs []chat1.MessageUnboxed) (res []chat1.MessageID)

func PluckMessageIDs added in v1.0.21 

func PluckMessageIDs(msgs []chat1.MessageSummary) []chat1.MessageID

func PluckUIMessageIDs added in v1.0.48 

func PluckUIMessageIDs(msgs []chat1.UIMessage) (res []chat1.MessageID)

func PresentChannelNameMentions 

func PresentChannelNameMentions(ctx context.Context, crs []chat1.ChannelNameMention) (res []chat1.UIChannelNameMention)

func PresentConversationErrorLocal added in v1.0.46 

func PresentConversationErrorLocal(rawConv chat1.ConversationErrorLocal) (res chat1.InboxUIItemError)

func PresentConversationLocal added in v1.0.28 

func PresentConversationLocal(rawConv chat1.ConversationLocal, currentUsername string) (res chat1.InboxUIItem)

func PresentConversationLocals added in v1.0.29 

func PresentConversationLocals(convs []chat1.ConversationLocal, currentUsername string) (res []chat1.InboxUIItem)

func PresentMessageUnboxed added in v1.0.29 

func PresentMessageUnboxed(ctx context.Context, g *globals.Context, rawMsg chat1.MessageUnboxed,
	uid gregor1.UID, convID chat1.ConversationID) (res chat1.UIMessage)

func PresentPagination added in v1.0.29 

func PresentPagination(p *chat1.Pagination) (res *chat1.UIPagination)

func PresentRemoteConversation added in v1.0.33 

func PresentRemoteConversation(rc types.RemoteConversation) (res chat1.UnverifiedInboxUIItem)

func PresentRemoteConversations added in v1.0.34 

func PresentRemoteConversations(rcs []types.RemoteConversation) (res []chat1.UnverifiedInboxUIItem)

func PresentThreadView added in v1.0.34 

func PresentThreadView(ctx context.Context, g *globals.Context, uid gregor1.UID, tv chat1.ThreadView,
	convID chat1.ConversationID) (res chat1.UIMessages)

func PresentUnfurl 

func PresentUnfurl(ctx context.Context, g *globals.Context, convID chat1.ConversationID, u chat1.Unfurl) *chat1.UnfurlDisplay

func PresentUnfurls 

func PresentUnfurls(ctx context.Context, g *globals.Context, convID chat1.ConversationID,
	unfurls map[chat1.MessageID]chat1.UnfurlResult) (res []chat1.UIMessageUnfurlInfo)

func RemoteConvs added in v1.0.33 

func RemoteConvs(convs []chat1.Conversation) (res []types.RemoteConversation)

func RemoveUnfurl 

func RemoveUnfurl(mvalid *chat1.MessageUnboxedValid, unfurlMessageID chat1.MessageID)

func ReorderParticipants 

func ReorderParticipants(mctx libkb.MetaContext, g libkb.UIDMapperContext, umapper libkb.UIDMapper,
	tlfname string, activeList []gregor1.UID) (writerNames []chat1.ConversationLocalParticipant, err error)

ReorderParticipants based on the order in activeList. Only allows usernames from tlfname in the output. This never fails, worse comes to worst it just returns the split of tlfname.

func SanitizeTopicName added in v1.0.27 

func SanitizeTopicName(topicName string) string

func SetUnfurl 

func SetUnfurl(mvalid *chat1.MessageUnboxedValid, unfurlMessageID chat1.MessageID,
	unfurl chat1.UnfurlResult)

func SplitTLFName added in v1.0.34 

func SplitTLFName(tlfName string) []string

func SuspendComponent 

func SuspendComponent(ctx context.Context, g *globals.Context, suspendable types.Suspendable) func()

SuspendComponent will suspend a Suspendable type until the return function is called. This allows a succinct call like defer SuspendComponent(ctx, g, g.ConvLoader)() in RPC handlers wishing to lock out the conv loader.

func SystemMessageMentions added in v1.0.34 

func SystemMessageMentions(ctx context.Context, body chat1.MessageSystem, upak SystemMessageUIDSource) (atMentions []gregor1.UID, chanMention chat1.ChannelMention)

func UsernamePackageToParticipant added in v1.0.34 

func UsernamePackageToParticipant(p libkb.UsernamePackage) chat1.ConversationLocalParticipant

func VisibleChatConversationStatuses added in v1.0.19 

func VisibleChatConversationStatuses() (res []chat1.ConversationStatus)

Which convs show in the inbox.

func XlateMessageIDControlToPagination added in v1.0.34 

func XlateMessageIDControlToPagination(control *chat1.MessageIDControl) (res *chat1.Pagination)

Types

type ByConvID added in v1.0.27 

type ByConvID []chat1.ConversationID

func (ByConvID) Len added in v1.0.27 

func (c ByConvID) Len() int

func (ByConvID) Less added in v1.0.27 

func (c ByConvID) Less(i, j int) bool

func (ByConvID) Swap added in v1.0.27 

func (c ByConvID) Swap(i, j int)

type ByMsgID 

type ByMsgID []chat1.MessageID

func (ByMsgID) Len 

func (m ByMsgID) Len() int

func (ByMsgID) Less 

func (m ByMsgID) Less(i, j int) bool

func (ByMsgID) Swap 

func (m ByMsgID) Swap(i, j int)

type ByMsgSummaryCtime added in v1.0.28 

type ByMsgSummaryCtime []chat1.MessageSummary

func (ByMsgSummaryCtime) Len added in v1.0.28 

func (c ByMsgSummaryCtime) Len() int

func (ByMsgSummaryCtime) Less added in v1.0.28 

func (c ByMsgSummaryCtime) Less(i, j int) bool

func (ByMsgSummaryCtime) Swap added in v1.0.28 

func (c ByMsgSummaryCtime) Swap(i, j int)

type ByMsgUnboxedCtime added in v1.0.28 

type ByMsgUnboxedCtime []chat1.MessageUnboxed

func (ByMsgUnboxedCtime) Len added in v1.0.28 

func (c ByMsgUnboxedCtime) Len() int

func (ByMsgUnboxedCtime) Less added in v1.0.28 

func (c ByMsgUnboxedCtime) Less(i, j int) bool

func (ByMsgUnboxedCtime) Swap added in v1.0.28 

func (c ByMsgUnboxedCtime) Swap(i, j int)

type ByMsgUnboxedMsgID added in v1.0.42 

type ByMsgUnboxedMsgID []chat1.MessageUnboxed

func (ByMsgUnboxedMsgID) Len added in v1.0.42 

func (c ByMsgUnboxedMsgID) Len() int

func (ByMsgUnboxedMsgID) Less added in v1.0.42 

func (c ByMsgUnboxedMsgID) Less(i, j int) bool

func (ByMsgUnboxedMsgID) Swap added in v1.0.42 

func (c ByMsgUnboxedMsgID) Swap(i, j int)

type ConvByConvID added in v1.0.27 

type ConvByConvID []chat1.Conversation

func (ConvByConvID) Len added in v1.0.27 

func (c ConvByConvID) Len() int

func (ConvByConvID) Less added in v1.0.27 

func (c ConvByConvID) Less(i, j int) bool

func (ConvByConvID) Swap added in v1.0.27 

func (c ConvByConvID) Swap(i, j int)

type ConvLocalByConvID added in v1.0.27 

type ConvLocalByConvID []chat1.ConversationLocal

func (ConvLocalByConvID) Len added in v1.0.27 

func (c ConvLocalByConvID) Len() int

func (ConvLocalByConvID) Less added in v1.0.27 

func (c ConvLocalByConvID) Less(i, j int) bool

func (ConvLocalByConvID) Swap added in v1.0.27 

func (c ConvLocalByConvID) Swap(i, j int)

type ConvLocalByTopicName added in v1.0.27 

type ConvLocalByTopicName []chat1.ConversationLocal

func (ConvLocalByTopicName) Len added in v1.0.27 

func (c ConvLocalByTopicName) Len() int

func (ConvLocalByTopicName) Less added in v1.0.27 

func (c ConvLocalByTopicName) Less(i, j int) bool

func (ConvLocalByTopicName) Swap added in v1.0.27 

func (c ConvLocalByTopicName) Swap(i, j int)

type ConversationMemberStatusBehavior added in v1.0.40 

type ConversationMemberStatusBehavior struct {
	// Whether to show the conv in the inbox
	ShowInInbox bool
	// Whether to show desktop notifications
	DesktopNotifications bool
	// Whether to send push notifications
	PushNotifications bool
	// Whether to show as part of badging
	ShowBadges bool
}

ConversationMemberStatusBehavior describes how a ConversationMemberStatus behaves

func GetConversationMemberStatusBehavior added in v1.0.40 

func GetConversationMemberStatusBehavior(s chat1.ConversationMemberStatus) ConversationMemberStatusBehavior

type ConversationStatusBehavior added in v1.0.19 

type ConversationStatusBehavior struct {
	// Whether to show the conv in the inbox
	ShowInInbox bool
	// Whether sending to this conv sets it back to UNFILED
	SendingRemovesStatus bool
	// Whether any incoming activity sets it back to UNFILED
	ActivityRemovesStatus bool
	// Whether to show desktop notifications
	DesktopNotifications bool
	// Whether to send push notifications
	PushNotifications bool
	// Whether to show as part of badging
	ShowBadges bool
}

ConversationStatusBehavior describes how a ConversationStatus behaves

func GetConversationStatusBehavior added in v1.0.19 

func GetConversationStatusBehavior(s chat1.ConversationStatus) ConversationStatusBehavior

GetConversationStatusBehavior gives information about what is allowed for a conversation status. When changing these, be sure to update gregor's postMessage as well

type DebugLabeler added in v1.0.19 

type DebugLabeler struct {
	// contains filtered or unexported fields
}

func NewDebugLabeler added in v1.0.19 

func NewDebugLabeler(log logger.Logger, label string, verbose bool) DebugLabeler

func (DebugLabeler) Debug added in v1.0.19 

func (d DebugLabeler) Debug(ctx context.Context, msg string, args ...interface{})

func (DebugLabeler) GetLog 

func (d DebugLabeler) GetLog() logger.Logger

func (DebugLabeler) Trace added in v1.0.19 

func (d DebugLabeler) Trace(ctx context.Context, f func() error, format string, args ...interface{}) func()

type RemoteConvByConvID added in v1.0.33 

type RemoteConvByConvID []types.RemoteConversation

func (RemoteConvByConvID) Len added in v1.0.33 

func (c RemoteConvByConvID) Len() int

func (RemoteConvByConvID) Less added in v1.0.33 

func (c RemoteConvByConvID) Less(i, j int) bool

func (RemoteConvByConvID) Swap added in v1.0.33 

func (c RemoteConvByConvID) Swap(i, j int)

type SystemMessageUIDSource added in v1.0.34 

type SystemMessageUIDSource interface {
	LookupUID(ctx context.Context, un libkb.NormalizedUsername) (keybase1.UID, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.