several updates

only send messages with private-api if necessary
add refresh-contacts bot command
contacts cache no longer updates automatically to reduce load on bb

Author: trek-boldly-go

commands.go

@@ -25,7 +25,7 @@ import (
 )
 
 var (
-	HelpSectionCreatingPortals = commands.HelpSection{Name: "Creating portals", Order: 15}
+	HelpSectionManagingPortals = commands.HelpSection{Name: "Managing portals", Order: 15}
 )
 
 type WrappedCommandEvent struct {
@@ -40,6 +40,7 @@ func (br *IMBridge) RegisterCommands() {
 	proc.AddHandlers(
 		cmdPM,
 		cmdSearchContacts,
+		cmdRefreshContacts,
 	)
 }
 
@@ -59,7 +60,7 @@ var cmdPM = &commands.FullHandler{
 	Func: wrapCommand(fnPM),
 	Name: "pm",
 	Help: commands.HelpMeta{
-		Section:     HelpSectionCreatingPortals,
+		Section:     HelpSectionManagingPortals,
 		Description: "Creates a new PM with the specified number or address.",
 	},
 	RequiresPortal: false,
@@ -91,8 +92,8 @@ var cmdSearchContacts = &commands.FullHandler{
 	Func: wrapCommand(fnSearchContacts),
 	Name: "search-contacts",
 	Help: commands.HelpMeta{
-		Section:     HelpSectionCreatingPortals,
-		Description: "Searches contacts based on name, phone, and email.",
+		Section:     HelpSectionManagingPortals,
+		Description: "Searches contacts based on name, phone, and email (only for BlueBubbles mode).",
 	},
 	RequiresPortal: false,
 	RequiresLogin:  false,
@@ -152,5 +153,24 @@ func buildContactString(contact *imessage.Contact) string {
 	return contactInfo
 }
 
-// TODO: potentially add the following commands
-// start-group-chat
+var cmdRefreshContacts = &commands.FullHandler{
+	Func: wrapCommand(fnRefreshContacts),
+	Name: "refresh-contacts",
+	Help: commands.HelpMeta{
+		Section:     HelpSectionManagingPortals,
+		Description: "Request that the bridge reload cached contacts (only for BlueBubbles mode).",
+	},
+	RequiresPortal: false,
+	RequiresLogin:  false,
+}
+
+func fnRefreshContacts(ce *WrappedCommandEvent) {
+	ce.Bridge.ZLog.Trace().Interface("args", ce.Args).Str("cmd", ce.Command).Msg("fnSearchContacts")
+
+	err := ce.Bridge.IM.RefreshContactList()
+	if err != nil {
+		ce.Reply("Failed to search contacts: %s", err)
+	} else {
+		ce.Reply("Contacts List updated!")
+	}
+}

imessage/bluebubbles/api.go

@@ -93,8 +93,11 @@ func (bb *blueBubbles) Start(readyCallback func()) error {
 
 	go bb.PollForWebsocketMessages()
 
+	// Preload some caches
 	bb.usingPrivateApi = bb.isPrivateApi()
+	bb.RefreshContactList()
 
+	// Notify main this API is fully loaded
 	readyCallback()
 
 	return nil
@@ -709,11 +712,9 @@ func (bb *blueBubbles) matchHandleToContact(address string) *Contact {
 
 	var contact *Contact
 
-	contacts := bb.getContactList()
-
 	numericAddress := numericOnly(address)
 
-	for _, c := range contacts {
+	for _, c := range bb.contacts {
 		// extract only the numbers of every phone (removes `-` and `+`)
 		var numericPhones []string
 		for _, e := range c.PhoneNumbers {
@@ -754,9 +755,7 @@ func (bb *blueBubbles) SearchContactList(input string) ([]*imessage.Contact, err
 
 	var matchedContacts []*imessage.Contact
 
-	contacts := bb.getContactList()
-
-	for _, contact := range contacts {
+	for _, contact := range bb.contacts {
 
 		contactFields := []string{
 			strings.ToLower(contact.FirstName + " " + contact.LastName),
@@ -804,28 +803,15 @@ func (bb *blueBubbles) GetContactInfo(identifier string) (resp *imessage.Contact
 func (bb *blueBubbles) GetContactList() (resp []*imessage.Contact, err error) {
 	bb.log.Trace().Msg("GetContactList")
 
-	contactResponse := bb.getContactList()
-
-	for _, contact := range contactResponse {
+	for _, contact := range bb.contacts {
 		imessageContact, _ := bb.convertBBContactToiMessageContact(&contact)
 		resp = append(resp, imessageContact)
 	}
 
 	return resp, nil
 }
 
-// Updates the cache if necessary, and returns the list
-func (bb *blueBubbles) getContactList() []Contact {
-
-	if bb.contacts == nil ||
-		bb.contactsLastRefresh.Add(1*time.Hour).Compare(time.Now()) < 0 {
-		bb.refreshContactsList()
-	}
-
-	return bb.contacts
-}
-
-func (bb *blueBubbles) refreshContactsList() error {
+func (bb *blueBubbles) RefreshContactList() error {
 	bb.log.Trace().Msg("refreshContactsList")
 
 	var contactResponse ContactResponse
@@ -945,7 +931,7 @@ func (bb *blueBubbles) SendMessage(chatID, text string, replyTo string, replyToP
 	bb.log.Trace().Str("chatID", chatID).Str("text", text).Str("replyTo", replyTo).Int("replyToPart", replyToPart).Any("richLink", richLink).Interface("metadata", metadata).Msg("SendMessage")
 
 	var method string
-	if replyTo != "" || bb.usingPrivateApi {
+	if replyTo != "" {
 		method = "private-api"
 	} else {
 		// we have to use apple-script and send a second message

imessage/bluebubbles/interface.go

@@ -231,14 +231,14 @@ type Handle struct {
 }
 
 type SendTextRequest struct {
-	ChatGUID            string      `json:"chatGuid"`
-	Method              string      `json:"method"`
-	Message             string      `json:"message"`
-	EffectId            interface{} `json:"effectId"`
-	Subject             string      `json:"subject"`
-	TempGuid            string      `json:"tempGuid"`
-	SelectedMessageGuid string      `json:"selectedMessageGuid"`
-	PartIndex           int         `json:"partIndex"`
+	ChatGUID            string `json:"chatGuid"`
+	TempGuid            string `json:"tempGuid"`
+	Method              string `json:"method"`
+	Message             string `json:"message"`
+	EffectId            string `json:"effectId,omitempty"`
+	Subject             string `json:"subject,omitempty"`
+	SelectedMessageGuid string `json:"selectedMessageGuid,omitempty"`
+	PartIndex           int    `json:"partIndex,omitempty"`
 }
 
 type SendTextResponse struct {

imessage/interface.go

@@ -39,6 +39,7 @@ type ContactAPI interface {
 	GetContactInfo(identifier string) (*Contact, error)
 	GetContactList() ([]*Contact, error)
 	SearchContactList(searchTerms string) ([]*Contact, error)
+	RefreshContactList() error
 }
 
 type ChatInfoAPI interface {

imessage/ios/ipc.go

@@ -481,6 +481,10 @@ func (ios *iOSConnector) SearchContactList(searchTerms string) ([]*imessage.Cont
 	return nil, errors.New("not implemented")
 }
 
+func (ios *iOSConnector) RefreshContactList() error {
+	return errors.New("not implemented")
+}
+
 func (ios *iOSConnector) GetChatInfo(chatID, threadID string) (*imessage.ChatInfo, error) {
 	var resp imessage.ChatInfo
 	err := ios.IPC.Request(context.Background(), ReqGetChat, &GetChatRequest{ChatGUID: chatID, ThreadID: threadID}, &resp)

imessage/mac-nosip/nosip.go

@@ -71,6 +71,10 @@ func (n NoopContacts) SearchContactList(searchTerms string) ([]*imessage.Contact
 	return nil, errors.New("not implemented")
 }
 
+func (n NoopContacts) RefreshContactList() error {
+	return errors.New("not implemented")
+}
+
 func NewMacNoSIPConnector(bridge imessage.Bridge) (imessage.API, error) {
 	logger := bridge.GetLog().Sub("iMessage").Sub("Mac-noSIP")
 	processLogger := bridge.GetLog().Sub("iMessage").Sub("Barcelona")

imessage/mac/contacts.go

@@ -163,3 +163,7 @@ func (cs *ContactStore) GetContactList() ([]*imessage.Contact, error) {
 func (cs ContactStore) SearchContactList(searchTerms string) ([]*imessage.Contact, error) {
 	return nil, errors.New("not implemented")
 }
+
+func (cs ContactStore) RefreshContactList() error {
+	return errors.New("not implemented")
+}