fix typo in Makefile

.gitignore

@@ -0,0 +1 @@
+tglistbot*

Makefile

@@ -0,0 +1,12 @@
+
+VERSION = $(shell git describe --tags --abbrev=0)
+
+build_release:
+	CGO_ENABLED=0 go build -buildmode=pie -ldflags "-X main.Version=$(VERSION)" -o tglistbot-$(VERSION)
+
+release_check:
+	go list -m go.balki.me/tglistbot@$(VERSION)
+
+clean:
+	rm -i tglistbot* || true
+

README.md

@@ -0,0 +1,28 @@
+## Grocery list bot
+Bot shows the list as buttons that can be clicked to mark the item as done
+
+## Quick start
+
+### Single user
+
+Send your list of items to [@grocery_guy_bot](https://t.me/grocery_guy_bot)
+
+### Multiple users (Shared list)
+
+1. Create a group with all the members
+2. Add [@grocery_guy_bot](https://t.me/grocery_guy_bot) to the group
+3. Make the bot admin to read all the messages
+4. Send your list of items.
+
+Note: Everything sent to the group is considered a list item, so the group cannot be used to for any other text messages
+
+
+## TODO
+1. Write doc, screenshots, video, gif
+2. Done button for finish one list and start another
+3. Show list contents when done
+4. Show date time
+5. Multiple lists for same chat
+6. Sort button to move checked items to top
+7. systemd socket activation
+8. Add tests

glist/glist.go

@@ -1,3 +1,4 @@
+// Package glist handles the list processing
 package glist
 
 import (
@@ -34,16 +35,17 @@ func NewGList(chatID int, items ...string) *GList {
 	return &g
 }
 
-var PersistReqC chan<- *GList
+var persistReqC chan<- *GList
 
 func startPersistenceGoR() {
 	reqs := make(chan *GList, 50)
-	PersistReqC = reqs
+	persistReqC = reqs
 	go func() {
-		lists := map[*GList]struct{}{}
 		for g := range reqs {
-			lists[g] = struct{}{}
+			lists := map[*GList]struct{}{
-			time.Sleep(5 * time.Second)
+				g: struct{}{},
+			}
+			time.Sleep(5 * time.Second) // Collect all persist requests for 5 seconds
 			for len(reqs) > 0 {
 				g := <-reqs
 				lists[g] = struct{}{}
@@ -51,7 +53,6 @@ func startPersistenceGoR() {
 			for g := range lists {
 				g.persist()
 			}
-			lists = make(map[*GList]struct{}, len(lists))
 		}
 	}()
 }
@@ -83,18 +84,18 @@ outer:
 		}
 		g.Items = append(g.Items, Entry{text, false})
 	}
-	PersistReqC <- g
+	persistReqC <- g
 }
 
-func (g *GList) Toggle(text string) error {
+func (g *GList) Toggle(text string) {
 	for i, item := range g.Items {
 		if item.Text == text {
 			g.Items[i].Checked = !g.Items[i].Checked
-			PersistReqC <- g
+			persistReqC <- g
-			return nil
+			return
 		}
 	}
-	return fmt.Errorf("not found:%s", text)
+	log.Printf("item not found in toggle, chat: %d, item: %s\n", g.ChatID, text)
 }
 
 func (g *GList) ClearChecked() {
@@ -105,9 +106,16 @@ func (g *GList) ClearChecked() {
 		}
 	}
 	g.Items = remaining
-	PersistReqC <- g
+	persistReqC <- g
 }
 
+type SendMethod string
+
+var (
+	NEWLIST  SendMethod = "sendMessage"
+	EDITLIST SendMethod = "editMessageText"
+)
+
 type button struct {
 	Text         string `json:"text"`
 	CallbackData string `json:"callback_data"`
@@ -117,6 +125,7 @@ type newListReq struct {
 	ChatID              int    `json:"chat_id"`
 	MessageID           *int   `json:"message_id,omitempty"`
 	Text                string `json:"text"`
+	DisableNotification *bool  `json:"disable_notification,omitempty"`
 	ReplyMarkup         struct {
 		InlineKeyboard [][]button `json:"inline_keyboard"`
 	} `json:"reply_markup"`
@@ -146,8 +155,12 @@ func makeButtons(items []Entry) [][]button {
 	return buttons
 }
 
-func (g *GList) GenSendListReq() ([]byte, error) {
+func (g *GList) GenSendListReq(method SendMethod) ([]byte, error) {
 	req := newListReq{ChatID: g.ChatID, MessageID: g.MessageID, Text: "List:"}
+	if method == NEWLIST {
+		disableNotification := true
+		req.DisableNotification = &disableNotification
+	}
 	itemButtons := makeButtons(g.Items)
 	controlButtons := []button{{"clear checked", "clear"}}
 	req.ReplyMarkup.InlineKeyboard = append(itemButtons, controlButtons)

glist/glist_test.go

@@ -2,34 +2,32 @@ package glist
 
 import (
 	"fmt"
-	"sync"
 	"testing"
 )
 
 func TestGList(t *testing.T) {
-	var ti int
+	g := NewGList(4342, "foo")
-	var m sync.Mutex
+	data, err := g.GenSendListReq(NEWLIST)
-	g := GList{ti, m, 4342, nil, []Entry{{"foo", true}}}
-	data, err := g.GenSendListReq()
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	expected := `{"chat_id":4342,"text":"List:","reply_markup":{"inline_keyboard":[[{"text":"✓ foo","callback_data":"foo"}],[{"text":"clear checked","callback_data":"clear"}]]}}`
+	expected := `{"chat_id":4342,"text":"List:","disable_notification":true,"reply_markup":{"inline_keyboard":[[{"text":"foo","callback_data":"foo"}],[{"text":"clear checked","callback_data":"clear"}]]}}`
 	if expected != string(data) {
 		t.Fatalf("expected: %s\n got:%s\n", expected, string(data))
 	}
 }
 
 func TestSplit(t *testing.T) {
-	g := GList{}
+	g := &GList{}
 	//This resets the channel, so test does not try to persist
-	PersistReqC = make(chan *GList, 50)
+	persistReqC = make(chan *GList, 50)
 	g.Add("foo")
 	g.Add("bar\nfoo\nblah")
 	g.Add("foo")
 	g.Add("lskfj")
-	expected := `{0 {0 0} 0 <nil> [{foo false} {bar false} {blah false} {lskfj false}]}`
+	g.Toggle("foo")
+	expected := `&{0 {0 0} 0 <nil> [{foo true} {bar false} {blah false} {lskfj false}]}`
 	actual := fmt.Sprintf("%v", g)
 	if expected != actual {
 		t.Fatalf("expected: %s\n got:%s\n", expected, actual)

go.mod

@@ -1,3 +1,3 @@
-module gitea.balki.me/telegram-msgchkbox
+module go.balki.me/tglistbot
 
-go 1.19
+go 1.20

main.go

@@ -4,9 +4,12 @@ package main
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"log"
+	"net"
 	"net/http"
 	"os"
 	"path"
@@ -16,55 +19,92 @@ import (
 	"sync"
 	"time"
 
-	"gitea.balki.me/telegram-msgchkbox/glist"
+	"go.balki.me/tglistbot/glist"
 )
 
+// Version will be set from build commandline
+var Version string
 var apiToken string
 
+var usage string = `Telegram List bot
+Environment variables:
+TGLB_API_TOKEN (required): See https://core.telegram.org/bots#how-do-i-create-a-bot
+TGLB_PORT (default 28923): Set numerical port or unix//run/path.sock for unix socket
+TGLB_DATA_PATH (default .): Directory path where list data is stored
+`
+
 func main() {
 
-	apiToken = os.Getenv("CHKBOT_API_TOKEN")
+	apiToken = os.Getenv("TGLB_API_TOKEN")
 
 	if apiToken == "" {
-		log.Panicln("CHKBOT_API_TOKEN is empty")
+		log.Print(usage)
+		log.Panicln("TGLB_API_TOKEN is empty")
 	}
 
-	port := func() int {
+	port, unixSocketPath := func() (int, string) {
-		portStr := os.Getenv("CHKBOT_PORT")
+		portStr := os.Getenv("TGLB_PORT")
-		port, err := strconv.Atoi(portStr)
+
-		if err == nil {
+		defaultPort := 28923
-			return port
+
+		if strings.HasPrefix(portStr, "unix/") {
+			return defaultPort, strings.TrimPrefix(portStr, "unix/")
 		}
-		return 28923
+
+		if port, err := strconv.Atoi(portStr); err == nil {
+			return port, ""
+		}
+		return defaultPort, ""
 	}()
 
 	dataPath := func() string {
-		dataPath := os.Getenv("CHKBOT_DATA_PATH")
+		dataPath := os.Getenv("TGLB_DATA_PATH")
 		if dataPath == "" {
-			dataPath = "."
+			return "."
 		}
-		err := os.MkdirAll(dataPath, 0755)
+
-		if err != nil {
+		if err := os.MkdirAll(dataPath, 0755); err != nil {
-			log.Panicf("Failed to create datapath, path: %s, err: %s", dataPath, err)
+			log.Panicf("Failed to create datapath, path: %q, err: %s\n", dataPath, err)
 		}
 		return dataPath
 	}()
 
 	glist.DataPath = dataPath
 
-	if bi, ok := debug.ReadBuildInfo(); ok {
+	version := func() string {
-		log.Println(bi.String())
+		if Version != "" {
+			return Version
 		}
+		if bi, ok := debug.ReadBuildInfo(); ok {
+			for _, s := range bi.Settings {
+				if s.Key == "vcs.revision" {
+					return s.Value[:8]
+				}
+			}
+		}
+		return "unknown"
+	}()
 
-	log.Printf("Grocery List bot starting with datapath:%s, port:%d\n", dataPath, port)
+	listeningOn := func() string {
+		if unixSocketPath != "" {
+			return fmt.Sprintf("socket: %q", unixSocketPath)
+		}
+		return fmt.Sprintf("port: %v", port)
+	}()
+
+	log.Printf("List bot (%s) starting with datapath: %q, %s\n", version, dataPath, listeningOn)
 
 	var chats sync.Map
 	if err := loadData(dataPath, &chats); err != nil {
-		log.Panicf("failed to load data, err: %s", err)
+		log.Panicf("failed to load data, err: %s\n", err)
 	}
 	botPath := fmt.Sprintf("/bot%s", apiToken)
 	http.HandleFunc(botPath, func(w http.ResponseWriter, r *http.Request) {
-		w.Write([]byte("ok"))
+		defer func() {
+			if _, err := w.Write([]byte("ok")); err != nil {
+				log.Println(err)
+			}
+		}()
 		body, err := io.ReadAll(r.Body)
 		if err != nil {
 			log.Println(err)
@@ -97,7 +137,8 @@ func main() {
 			return
 		}
 
-		if update.Message != nil && update.Message.Text != "" {
+		// Ignore if Text is empty or is a command
+		if update.Message != nil && update.Message.Text != "" && update.Message.Text[0] != '/' {
 
 			chatID := update.Message.Chat.ID
 			g, _ := chats.LoadOrStore(chatID, glist.NewGList(chatID))
@@ -111,7 +152,7 @@ func main() {
 			chatID := update.CallbackQuery.Message.Chat.ID
 			g, ok := chats.Load(chatID)
 			if !ok {
-				log.Println("Chat not found: %s", chatID)
+				log.Printf("Chat not found: %v\n", chatID)
 				return
 			}
 			gl := g.(*glist.GList)
@@ -119,7 +160,24 @@ func main() {
 
 		}
 	})
-	log.Panic(http.ListenAndServe(fmt.Sprintf(":%v", port), nil))
+	if unixSocketPath != "" {
+		// Remove old one
+		if err := os.Remove(unixSocketPath); err != nil && !errors.Is(err, fs.ErrNotExist) {
+			log.Panicf("Failed to remove unix socket : %q err: %v\n", unixSocketPath, err)
+		}
+
+		l, err := net.Listen("unix", unixSocketPath)
+		if err != nil {
+			log.Panicf("Unable to listen to unix socket : %q err: %v\n", unixSocketPath, err)
+		}
+
+		if err = os.Chmod(unixSocketPath, 0666); err != nil {
+			log.Panicf("Failed to set permission of unix socket %q err: %v\n", unixSocketPath, err)
+		}
+
+		log.Panicln(http.Serve(l, nil))
+	}
+	log.Panicln(http.ListenAndServe(fmt.Sprintf(":%v", port), nil))
 }
 
 func handleTextAdded(gl *glist.GList, text string) {
@@ -132,7 +190,29 @@ func handleTextAdded(gl *glist.GList, text string) {
 		gl.Mutex.Lock()
 		defer gl.Mutex.Unlock()
 		if count == gl.AllMsgCounter {
-			sendList(gl, "sendMessage")
+			resp := sendList(gl, glist.NEWLIST)
+			if resp == nil {
+				return
+			}
+			response := struct {
+				Ok     bool `json:"ok"`
+				Result struct {
+					MessageID int `json:"message_id"`
+				} `json:"result"`
+			}{}
+			if err := json.Unmarshal(resp, &response); err != nil {
+				log.Println(err)
+				return
+			}
+			if !response.Ok {
+				log.Println("not ok")
+				return
+			}
+
+			if gl.MessageID != nil {
+				deleteMessage(gl.ChatID, *gl.MessageID)
+			}
+			gl.MessageID = &response.Result.MessageID
 		}
 	})
 }
@@ -140,11 +220,6 @@ func handleTextAdded(gl *glist.GList, text string) {
 func handleButtonClick(gl *glist.GList, messageID int, text string) {
 	gl.Mutex.Lock()
 	defer gl.Mutex.Unlock()
-	if gl.MessageID != nil {
-		if messageID != *gl.MessageID {
-			go deleteMessage(gl.ChatID, *gl.MessageID)
-		}
-	}
 	gl.MessageID = &messageID
 	if text == "clear" {
 		gl.ClearChecked()
@@ -155,24 +230,25 @@ func handleButtonClick(gl *glist.GList, messageID int, text string) {
 
 	if len(gl.Items) == 0 {
 		deleteMessage(gl.ChatID, messageID)
+		gl.MessageID = nil
 	} else {
-		sendList(gl, "editMessageText")
+		sendList(gl, glist.EDITLIST)
 	}
 }
 
-func sendList(gl *glist.GList, method string) {
+func sendList(gl *glist.GList, method glist.SendMethod) []byte {
 	url := fmt.Sprintf("https://api.telegram.org/bot%s/%s", apiToken, method)
-	sendMsgReq, err := gl.GenSendListReq()
+	sendMsgReq, err := gl.GenSendListReq(method)
 	if err != nil {
 		log.Println(err)
-		return
+		return nil
 	}
 	resp, err := http.Post(url, "application/json", bytes.NewReader(sendMsgReq))
 	if err != nil {
 		log.Println(err)
-		return
+		return nil
 	}
-	logBody(resp.Body)
+	return logBody(resp.Body)
 }
 
 func answerCallbackQuery(callbackQueryID string) {
@@ -192,10 +268,29 @@ func deleteMessage(chatID int, messageID int) {
 		log.Println(err)
 		return
 	}
+	body := logBody(resp.Body)
+	ok := struct {
+		Ok bool `json:"ok"`
+	}{}
+
+	if err := json.Unmarshal(body, &ok); err != nil {
+		log.Println(err)
+		return
+	}
+	//Old messages can't be deleted, so edit text instead
+	if !ok.Ok {
+		updateURL := fmt.Sprintf("https://api.telegram.org/bot%s/editMessageText?chat_id=%d&message_id=%d&text=%s", apiToken, chatID, messageID, "<list updated>")
+		resp, err := http.Get(updateURL)
+		if err != nil {
+			log.Println(err)
+			return
+		}
 		logBody(resp.Body)
+	}
+
 }
 
-func logBody(respBody io.ReadCloser) {
+func logBody(respBody io.ReadCloser) []byte {
 	defer func() {
 		err := respBody.Close()
 		if err != nil {
@@ -205,9 +300,10 @@ func logBody(respBody io.ReadCloser) {
 	body, err := io.ReadAll(respBody)
 	if err != nil {
 		log.Println(err)
-		return
+		return nil
 	}
 	log.Println(string(body))
+	return body
 }
 
 func loadData(dataPath string, chats *sync.Map) error {
@@ -226,11 +322,11 @@ func loadData(dataPath string, chats *sync.Map) error {
 		var gl glist.GList
 		data, err := os.ReadFile(path.Join(dataPath, name))
 		if err != nil {
-			return fmt.Errorf("failed read file, name: %s, err:%w", name, err)
+			return fmt.Errorf("failed read file, name: %q, err:%w", name, err)
 		}
 		err = json.Unmarshal(data, &gl)
 		if err != nil {
-			return fmt.Errorf("failed to parse data, data:%s, err:%w", data, err)
+			return fmt.Errorf("failed to parse data, data:%q, err:%w", data, err)
 		}
 		chats.Store(gl.ChatID, &gl)
 	}