Merge lp:~sergiusens/account-polld/facebook_tweaks into lp:~ubuntu-push-hackers/account-polld/trunk

[Sergio Schvezov]

Facebook pretty notifications, persistence (with multiple account support)

This is not just facebook tweaks, but also some changes to have multi account logging and persistance per plugin

[lp:~sergiusens/account-polld/facebook_tweaks]

59. By Sergio Schvezov on 2014-08-08

Updated translation template

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:59
http://jenkins.qa.ubuntu.com/job/account-polld-ci/62/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/account-polld-utopic-amd64-ci/62
    SUCCESS: http://jenkins.qa.ubuntu.com/job/account-polld-utopic-armhf-ci/62
        deb: http://jenkins.qa.ubuntu.com/job/account-polld-utopic-armhf-ci/62/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/account-polld-utopic-i386-ci/62

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/account-polld-ci/62/rebuild

review: Approve (continuous-integration)

[Roberto Alsina (ralsina)]

review: Approve

[lp:~sergiusens/account-polld/facebook_tweaks]

60. By Sergio Schvezov on 2014-08-11

Filter notifications for facebook at start, don't do a consolidated message if no usernames where collected log more for facebook for now

61. By Sergio Schvezov on 2014-08-11

Updated translation template

=== modified file 'cmd/account-polld/main.go'
--- cmd/account-polld/main.go	2014-08-01 19:27:53 +0000
+++ cmd/account-polld/main.go	2014-08-11 18:35:47 +0000
@@ -94,11 +94,11 @@
 			switch data.ServiceName {
 			case SERVICENAME_GMAIL:
 				log.Println("Creating account with id", data.AccountId, "for", data.ServiceName)
-				plugin = gmail.New()
+				plugin = gmail.New(data.AccountId)
 			case SERVICENAME_FACEBOOK:
 				// This is just stubbed until the plugin exists.
 				log.Println("Creating account with id", data.AccountId, "for", data.ServiceName)
-				plugin = facebook.New()
+				plugin = facebook.New(data.AccountId)
 			case SERVICENAME_TWITTER:
 				// This is just stubbed until the plugin exists.
 				log.Println("Creating account with id", data.AccountId, "for", data.ServiceName)

=== modified file 'plugins/facebook/facebook.go'
--- plugins/facebook/facebook.go	2014-08-01 20:30:06 +0000
+++ plugins/facebook/facebook.go	2014-08-11 18:35:47 +0000
@@ -1,6 +1,7 @@
 /*
  Copyright 2014 Canonical Ltd.
  Authors: James Henstridge <[e-mail]>
+          Sergio Schvezov <[e-mail]>
 
  This program is free software: you can redistribute it and/or modify it
  under the terms of the GNU General Public License version 3, as published
@@ -19,24 +20,63 @@
 
 import (
 	"encoding/json"
+	"fmt"
 	"net/http"
 	"net/url"
+	"os"
+	"strings"
 	"time"
 
+	"log"
+
 	"launchpad.net/account-polld/accounts"
+	"launchpad.net/account-polld/gettext"
 	"launchpad.net/account-polld/plugins"
 )
 
-const facebookTime = "2006-01-02T15:04:05-0700"
+const (
+	facebookTime                        = "2006-01-02T15:04:05-0700"
+	maxIndividualNotifications          = 4
+	consolidatedNotificationsIndexStart = maxIndividualNotifications
+	pluginName                          = "facebook"
+)
 
 var baseUrl, _ = url.Parse("https://graph.facebook.com/v2.0/")
 
+type timeStamp string
+
+func (stamp timeStamp) persist(accountId uint) (err error) {
+	err = plugins.Persist(pluginName, accountId, stamp)
+	if err != nil {
+		log.Print("facebook plugin", accountId, ": failed to save state: ", err)
+	}
+	return nil
+}
+
+func timeStampFromStorage(accountId uint) (stamp timeStamp, err error) {
+	err = plugins.FromPersist(pluginName, accountId, &stamp)
+	if err != nil {
+		return stamp, err
+	}
+	if _, err := time.Parse(facebookTime, string(stamp)); err == nil {
+		return stamp, err
+	}
+	return stamp, nil
+}
+
 type fbPlugin struct {
-	lastUpdate string
+	lastUpdate timeStamp
+	accountId  uint
 }
 
-func New() plugins.Plugin {
-	return &fbPlugin{}
+func New(accountId uint) plugins.Plugin {
+	stamp, err := timeStampFromStorage(accountId)
+	if err != nil {
+		log.Print("facebook plugin ", accountId, ": cannot load previous state from storage: ", err)
+	} else {
+		log.Print("facebook plugin ", accountId, ": last state loaded from storage")
+	}
+	return &fbPlugin{lastUpdate: stamp, accountId: accountId}
 }
 
 func (p *fbPlugin) ApplicationId() plugins.ApplicationId {
@@ -75,29 +115,75 @@
 	// page full of notifications.  The default limit seems to be
 	// 5000 though, which we are unlikely to hit, since
 	// notifications are deleted once read.
+	// TODO filter out of date messages before operating
 	var result notificationDoc
 	if err := decoder.Decode(&result); err != nil {
 		return nil, err
 	}
-	pushMsg := []plugins.PushMessage{}
-	latestUpdate := ""
+
+	var validNotifications []notification
+	latestUpdate := p.lastUpdate
 	for _, n := range result.Data {
 		if n.UpdatedTime <= p.lastUpdate {
-			continue
+			log.Println("facebook plugin: skipping notification", n.Id, "as", n.UpdatedTime, "is older than", p.lastUpdate)
+		} else if n.Unread != 1 {
+			log.Println("facebook plugin: skipping notification", n.Id, "as it's read:", n.Unread)
+		} else {
+			log.Println("facebook plugin: valid notification", n.Id, "dated:", n.UpdatedTime, "and read status:", n.Unread)
+			validNotifications = append(validNotifications, n)
+			if n.UpdatedTime > latestUpdate {
+				latestUpdate = n.UpdatedTime
+			}
 		}
-		// TODO proper action needed
-		action := "https://m.facebook.com"
+	}
+	p.lastUpdate = latestUpdate
+	p.lastUpdate.persist(p.accountId)
+
+	pushMsg := []plugins.PushMessage{}
+	for _, n := range validNotifications {
 		epoch := toEpoch(n.UpdatedTime)
-		pushMsg = append(pushMsg, *plugins.NewStandardPushMessage(n.Title, "", action, "", epoch))
-		if n.UpdatedTime > latestUpdate {
-			latestUpdate = n.UpdatedTime
-		}
-	}
-	p.lastUpdate = latestUpdate
+		pushMsg = append(pushMsg, *plugins.NewStandardPushMessage(n.From.Name, n.Title, n.Link, n.picture(), epoch))
+		if len(pushMsg) == maxIndividualNotifications {
+			break
+		}
+	}
+
+	// Now we consolidate the remaining statuses
+	if len(validNotifications) > len(pushMsg) && len(validNotifications) >= consolidatedNotificationsIndexStart {
+		usernamesMap := make(map[string]bool)
+		for _, n := range result.Data[consolidatedNotificationsIndexStart:] {
+			if _, ok := usernamesMap[n.From.Name]; !ok {
+				usernamesMap[n.From.Name] = true
+			}
+		}
+		usernames := []string{}
+		for k, _ := range usernamesMap {
+			usernames = append(usernames, k)
+			// we don't too many usernames listed, this is a hard number
+			if len(usernames) > 10 {
+				usernames = append(usernames, "...")
+				break
+			}
+		}
+		if len(usernames) > 0 {
+			// TRANSLATORS: This represents a notification summary about more facebook notifications
+			summary := gettext.Gettext("Multiple more notifications")
+			// TRANSLATORS: This represents a notification body with the comma separated facebook usernames
+			body := fmt.Sprintf(gettext.Gettext("From %s"), strings.Join(usernames, ", "))
+			action := "https://m.facebook.com"
+			epoch := time.Now().Unix()
+			pushMsg = append(pushMsg, *plugins.NewStandardPushMessage(summary, body, action, "", epoch))
+		}
+	}
+
 	return pushMsg, nil
 }
 
 func (p *fbPlugin) Poll(authData *accounts.AuthData) ([]plugins.PushMessage, error) {
+	// This envvar check is to ease testing.
+	if token := os.Getenv("ACCOUNT_POLLD_TOKEN_FACEBOOK"); token != "" {
+		authData.AccessToken = token
+	}
 	resp, err := p.request(authData, "me/notifications")
 	if err != nil {
 		return nil, err
@@ -105,8 +191,8 @@
 	return p.parseResponse(resp)
 }
 
-func toEpoch(timestamp string) int64 {
-	if t, err := time.Parse(facebookTime, timestamp); err == nil {
+func toEpoch(stamp timeStamp) int64 {
+	if t, err := time.Parse(facebookTime, string(stamp)); err == nil {
 		return t.Unix()
 	}
 	return time.Now().Unix()
@@ -123,16 +209,28 @@
 }
 
 type notification struct {
-	Id          string `json:"id"`
-	From        object `json:"from"`
-	To          object `json:"to"`
-	CreatedTime string `json:"created_time"`
-	UpdatedTime string `json:"updated_time"`
-	Title       string `json:"title"`
-	Link        string `json:"link"`
-	Application object `json:"application"`
-	Unread      int    `json:"unread"`
-	Object      object `json:"object"`
+	Id          string    `json:"id"`
+	From        object    `json:"from"`
+	To          object    `json:"to"`
+	CreatedTime timeStamp `json:"created_time"`
+	UpdatedTime timeStamp `json:"updated_time"`
+	Title       string    `json:"title"`
+	Link        string    `json:"link"`
+	Application object    `json:"application"`
+	Unread      int       `json:"unread"`
+	Object      object    `json:"object"`
+}
+
+func (n notification) picture() string {
+	u, err := baseUrl.Parse(fmt.Sprintf("%s/picture", n.From.Id))
+	if err != nil {
+		log.Println("facebook plugin: cannot get picture for", n.Id)
+		return ""
+	}
+	query := u.Query()
+	query.Add("redirect", "true")
+	u.RawQuery = query.Encode()
+	return u.String()
 }
 
 type object struct {

=== modified file 'plugins/facebook/facebook_test.go'
--- plugins/facebook/facebook_test.go	2014-07-23 10:45:24 +0000
+++ plugins/facebook/facebook_test.go	2014-08-11 18:35:47 +0000
@@ -133,9 +133,11 @@
 	messages, err := p.parseResponse(resp)
 	c.Assert(err, IsNil)
 	c.Assert(len(messages), Equals, 2)
-	c.Check(messages[0].Notification.Card.Summary, Equals, "Sender posted on your timeline: \"The message...\"")
-	c.Check(messages[1].Notification.Card.Summary, Equals, "Sender2's birthday was on July 7.")
-	c.Check(p.lastUpdate, Equals, "2014-07-12T09:51:57+0000")
+	c.Check(messages[0].Notification.Card.Summary, Equals, "Sender")
+	c.Check(messages[0].Notification.Card.Body, Equals, "Sender posted on your timeline: \"The message...\"")
+	c.Check(messages[1].Notification.Card.Summary, Equals, "Sender2")
+	c.Check(messages[1].Notification.Card.Body, Equals, "Sender2's birthday was on July 7.")
+	c.Check(p.lastUpdate, Equals, timeStamp("2014-07-12T09:51:57+0000"))
 }
 
 func (s S) TestIgnoreOldNotifications(c *C) {
@@ -147,8 +149,9 @@
 	messages, err := p.parseResponse(resp)
 	c.Assert(err, IsNil)
 	c.Assert(len(messages), Equals, 1)
-	c.Check(messages[0].Notification.Card.Summary, Equals, "Sender posted on your timeline: \"The message...\"")
-	c.Check(p.lastUpdate, Equals, "2014-07-12T09:51:57+0000")
+	c.Check(messages[0].Notification.Card.Summary, Equals, "Sender")
+	c.Check(messages[0].Notification.Card.Body, Equals, "Sender posted on your timeline: \"The message...\"")
+	c.Check(p.lastUpdate, Equals, timeStamp("2014-07-12T09:51:57+0000"))
 }
 
 func (s S) TestErrorResponse(c *C) {

=== modified file 'plugins/gmail/gmail.go'
--- plugins/gmail/gmail.go	2014-08-11 18:35:47 +0000
+++ plugins/gmail/gmail.go	2014-08-11 18:35:47 +0000
@@ -18,14 +18,12 @@
 package gmail
 
 import (
-	"bufio"
 	"encoding/json"
 	"fmt"
 	"net/http"
 	"net/mail"
 	"net/url"
 	"os"
-	"path/filepath"
 	"sort"
 	"time"
 
@@ -41,6 +39,7 @@
 	gmailDispatchUrl = "https://mail.google.com/mail/mu/mp/#cv/priority/^smartlabel_%s/%s"
 	// this means 3 individual messages + 1 bundled notification.
 	individualNotificationsLimit = 2
+	pluginName                   = "gmail"
 )
 
 type reportedIdMap map[string]time.Time
@@ -53,87 +52,47 @@
 // trackDelta defines how old messages can be before removed from tracking
 var trackDelta = time.Duration(time.Hour * 24 * 7)
 
-var idStoreSubPath = filepath.Join("gmail", "reportedIds.json")
-
 type GmailPlugin struct {
 	// reportedIds holds the messages that have already been notified. This
 	// approach is taken against timestamps as it avoids needing to call
 	// get on the message.
 	reportedIds reportedIdMap
+	accountId   uint
 }
 
-func idsFromStorage() (ids reportedIdMap, err error) {
-	var p string
-	defer func() {
-		if err != nil {
-			if p != "" {
-				os.Remove(p)
-			}
-		}
-	}()
-	p, err = plugins.DataFind(idStoreSubPath)
-	if err != nil {
-		return nil, err
-	}
-	file, err := os.Open(p)
-	if err != nil {
-		return nil, err
-	}
-	defer file.Close()
-	jsonReader := json.NewDecoder(file)
-	if err := jsonReader.Decode(&ids); err != nil {
-		return nil, err
-	}
-
+func idsFromPersist(accountId uint) (ids reportedIdMap, err error) {
+	err = plugins.FromPersist(pluginName, accountId, &ids)
+	if err != nil {
+		return nil, err
+	}
 	// discard old ids
 	timestamp := time.Now()
 	for k, v := range ids {
 		delta := timestamp.Sub(v)
 		if delta > trackDelta {
-			log.Println("gmail plugin: deleting", k, "as", delta, "is greater than", trackDelta)
+			log.Print("gmail plugin ", accountId, ": deleting ", k, " as ", delta, " is greater than ", trackDelta)
 			delete(ids, k)
 		}
 	}
 	return ids, nil
 }
 
-func (ids reportedIdMap) persist() (err error) {
-	var p string
-	defer func() {
-		if err != nil {
-			log.Println("gmail plugin: failed to save state:", err)
-			if p != "" {
-				os.Remove(p)
-			}
-		}
-	}()
-	p, err = plugins.DataEnsure(idStoreSubPath)
-	if err != nil {
-		return err
-	}
-	file, err := os.Create(p)
-	if err != nil {
-		return err
-	}
-	defer file.Close()
-	w := bufio.NewWriter(file)
-	defer w.Flush()
-	jsonWriter := json.NewEncoder(w)
-	if err := jsonWriter.Encode(ids); err != nil {
-		return err
-	}
-
+func (ids reportedIdMap) persist(accountId uint) (err error) {
+	err = plugins.Persist(pluginName, accountId, ids)
+	if err != nil {
+		log.Print("gmail plugin ", accountId, ": failed to save state: ", err)
+	}
 	return nil
 }
 
-func New() *GmailPlugin {
-	reportedIds, err := idsFromStorage()
+func New(accountId uint) *GmailPlugin {
+	reportedIds, err := idsFromPersist(accountId)
 	if err != nil {
-		log.Println("gmail plugin: cannot load previous state from storage:", err)
+		log.Print("gmail plugin ", accountId, ": cannot load previous state from storage: ", err)
 	} else {
-		log.Println("gmail plugin: report state loaded from storage")
+		log.Print("gmail plugin ", accountId, ": last state loaded from storage")
 	}
-	return &GmailPlugin{reportedIds}
+	return &GmailPlugin{reportedIds: reportedIds, accountId: accountId}
 }
 
 func (p *GmailPlugin) ApplicationId() plugins.ApplicationId {
@@ -202,7 +161,7 @@
 			epoch := hdr.getEpoch()
 			pushMsgMap[msg.ThreadId] = *plugins.NewStandardPushMessage(summary, body, action, "", epoch)
 		} else {
-			log.Println("gmail: skipping message id", msg.Id, "with date", msgStamp, "older than", timeDelta)
+			log.Print("gmail plugin ", p.accountId, ": skipping message id ", msg.Id, " with date ", msgStamp, " older than ", timeDelta)
 		}
 	}
 	var pushMsg []plugins.PushMessage
@@ -268,7 +227,7 @@
 		ids[msg.Id] = time.Now()
 	}
 	p.reportedIds = ids
-	p.reportedIds.persist()
+	p.reportedIds.persist(p.accountId)
 	return reportMsg
 }
 

=== modified file 'plugins/plugins.go'
--- plugins/plugins.go	2014-08-11 18:35:47 +0000
+++ plugins/plugins.go	2014-08-11 18:35:47 +0000
@@ -18,9 +18,13 @@
 package plugins
 
 import (
+	"bufio"
+	"encoding/json"
 	"errors"
+	"fmt"
 	"os"
 	"path/filepath"
+	"reflect"
 
 	"launchpad.net/account-polld/accounts"
 	"launchpad.net/go-xdg/v0"
@@ -166,12 +170,62 @@
 
 var cmdName string
 
-func DataFind(path string) (string, error) {
-	return xdg.Data.Find(filepath.Join(cmdName, path))
+// Persist stores the plugins data in a common location to a json file
+// from which it can recover later
+func Persist(pluginName string, accountId uint, data interface{}) (err error) {
+	var p string
+	defer func() {
+		if err != nil && p != "" {
+			os.Remove(p)
+		}
+	}()
+	p, err = xdg.Data.Ensure(filepath.Join(cmdName, fmt.Sprintf("%s-%d.json", pluginName, accountId)))
+	if err != nil {
+		return err
+	}
+	file, err := os.Create(p)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+	w := bufio.NewWriter(file)
+	defer w.Flush()
+	jsonWriter := json.NewEncoder(w)
+	if err := jsonWriter.Encode(data); err != nil {
+		return err
+	}
+	return nil
 }
 
-func DataEnsure(path string) (string, error) {
-	return xdg.Data.Ensure(filepath.Join(cmdName, path))
+// FromPersist restores the plugins data from a common location which
+// was stored in a json file
+func FromPersist(pluginName string, accountId uint, data interface{}) (err error) {
+	if reflect.ValueOf(data).Kind() != reflect.Ptr {
+		return errors.New("decode target is not a pointer")
+	}
+	var p string
+	defer func() {
+		if err != nil {
+			if p != "" {
+				os.Remove(p)
+			}
+		}
+	}()
+	p, err = xdg.Data.Find(filepath.Join(cmdName, fmt.Sprintf("%s-%d.json", pluginName, accountId)))
+	if err != nil {
+		return err
+	}
+	file, err := os.Open(p)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+	jsonReader := json.NewDecoder(file)
+	if err := jsonReader.Decode(&data); err != nil {
+		return err
+	}
+
+	return nil
 }
 
 // DefaultSound returns the path to the default sound for a Notification

=== modified file 'po/account-polld.pot'
--- po/account-polld.pot	2014-08-06 13:04:18 +0000
+++ po/account-polld.pot	2014-08-11 18:35:47 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: account-polld\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-08-06 10:04-0300\n"
+"POT-Creation-Date: 2014-08-11 15:35-0300\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -29,7 +29,9 @@
 msgstr ""
 
 #. TRANSLATORS: This represents a notification body with the comma separated twitter usernames
+#. TRANSLATORS: This represents a notification body with the comma separated facebook usernames
 #: plugins/twitter/twitter.go:130 plugins/twitter/twitter.go:187
+#: plugins/facebook/facebook.go:172
 #, c-format
 msgid "From %s"
 msgstr ""
@@ -40,19 +42,19 @@
 msgstr ""
 
 #. TRANSLATORS: the %s is an appended "from" corresponding to an specific email thread
-#: plugins/gmail/gmail.go:116
+#: plugins/gmail/gmail.go:153
 #, c-format
 msgid ", %s"
 msgstr ""
 
 #. TRANSLATORS: the %s is the "from" header corresponding to a specific email
-#: plugins/gmail/gmail.go:119
+#: plugins/gmail/gmail.go:156
 #, c-format
 msgid "%s"
 msgstr ""
 
 #. TRANSLATORS: the first %s refers to the email "subject", the second %s refers "from"
-#: plugins/gmail/gmail.go:121
+#: plugins/gmail/gmail.go:158
 #, c-format
 msgid ""
 "%s\n"
@@ -60,16 +62,21 @@
 msgstr ""
 
 #. TRANSLATORS: This represents a notification summary about more unread emails
-#: plugins/gmail/gmail.go:139
+#: plugins/gmail/gmail.go:176
 msgid "More unread emails available"
 msgstr ""
 
 #. TRANSLATORS: the first %d refers to approximate additionl email message count
-#: plugins/gmail/gmail.go:143
+#: plugins/gmail/gmail.go:180
 #, c-format
 msgid "You have an approximate of %d additional unread messages"
 msgstr ""
 
+#. TRANSLATORS: This represents a notification summary about more facebook notifications
+#: plugins/facebook/facebook.go:170
+msgid "Multiple more notifications"
+msgstr ""
+
 #: data/account-polld.desktop.tr.h:1
 msgid "Notifications"
 msgstr ""