Skip to content

Модуль от начала до конца

Соберём модуль Notes: сохранить заметку, показать список, удалить одну. Здесь задействовано хранилище, аргументы, алиасы, фильтры и переводы — почти всё, что нужно настоящему модулю.

1. Сгенерировать

.newmod Notes

2. Форма хранения

Заметки привязаны к чату, поэтому одна карта по ID чата со списком заметок:

go
package modules

import (
	"fmt"
	"strconv"
	"strings"

	"goroku/goroku"
	"goroku/goroku/utils"
)

type Notes struct {
	goroku.Base
}

func (m *Notes) Name() string { return "Notes" }

// notesFor возвращает заметки, сохранённые в одном чате.
func (m *Notes) notesFor(chatID int64) []string {
	all := m.DB.GetStringMapStringSlice(m.Name(), "notes", nil)
	if all == nil {
		return nil
	}
	return all[strconv.FormatInt(chatID, 10)]
}

// saveNotes заменяет заметки одного чата.
func (m *Notes) saveNotes(chatID int64, notes []string) error {
	all := m.DB.GetStringMapStringSlice(m.Name(), "notes", nil)
	if all == nil {
		all = map[string][]string{}
	}
	all[strconv.FormatInt(chatID, 10)] = notes
	if err := m.DB.SetStringMapStringSlice(m.Name(), "notes", all); err != nil {
		return fmt.Errorf("сохранение заметок: %w", err)
	}
	return nil
}

Геттер возвращает копию, поэтому читаем, меняем и записываем обратно.

3. Строки

go
func (m *Notes) Strings() map[string]string {
	return map[string]string{
		"name":            "Notes",
		"_cls_doc":        "Заметки по чатам",
		"_cmd_doc_note":   "[текст] — сохранить заметку или ответить на сообщение",
		"_cmd_doc_notes":  "Показать сохранённые заметки",
		"_cmd_doc_delnote": "[номер] — удалить заметку",

		"saved":     "📝 <b>Сохранено под #{n}</b>",
		"empty":     "📭 <b>Заметок пока нет</b>",
		"no_text":   "❌ <b>Пришлите текст или ответьте на сообщение</b>",
		"bad_index": "❌ <b>Укажите номер заметки, см. .notes</b>",
		"deleted":   "🗑 <b>Удалена #{n}</b>",
	}
}

4. Команды

go
func (m *Notes) Commands() map[string]goroku.CommandHandler {
	return map[string]goroku.CommandHandler{
		"note":    m.NoteCmd,
		"notes":   m.NotesCmd,
		"delnote": m.DelNoteCmd,
	}
}

func (m *Notes) CommandMetas() map[string]goroku.CommandMeta {
	return map[string]goroku.CommandMeta{
		"note":    {Aliases: []string{"n"}, OnlyOwner: true},
		"notes":   {OnlyOwner: true},
		"delnote": {Aliases: []string{"dn"}, OnlyOwner: true},
	}
}

Только владельцу: команды работают с вашим собственным хранилищем.

5. Сохранение

go
func (m *Notes) NoteCmd(msg *goroku.Message) error {
	text := msg.ArgsOrReply()
	if text == "" {
		return msg.Answer(m.T("no_text", "❌ <b>Пришлите текст или ответьте на сообщение</b>"))
	}

	notes := append(m.notesFor(msg.ChatID), text)
	if err := m.saveNotes(msg.ChatID, notes); err != nil {
		return err
	}

	tpl := m.T("saved", "📝 <b>Сохранено под #{n}</b>")
	return msg.Answer(strings.Replace(tpl, "{n}", strconv.Itoa(len(notes)), 1))
}

ArgsOrReply бесплатно даёт и .note купить молоко, и .note в ответ на сообщение.

6. Список

go
func (m *Notes) NotesCmd(msg *goroku.Message) error {
	notes := m.notesFor(msg.ChatID)
	if len(notes) == 0 {
		return msg.Answer(m.T("empty", "📭 <b>Заметок пока нет</b>"))
	}

	var b strings.Builder
	b.WriteString("📝 <b>Заметки</b>\n\n")
	for i, note := range notes {
		fmt.Fprintf(&b, "%d. %s\n", i+1, utils.EscapeHTML(note))
	}
	return msg.Answer(b.String())
}

EscapeHTML здесь важен: заметка с < иначе сломала бы сообщение.

7. Удаление

go
func (m *Notes) DelNoteCmd(msg *goroku.Message) error {
	notes := m.notesFor(msg.ChatID)
	if len(notes) == 0 {
		return msg.Answer(m.T("empty", "📭 <b>Заметок пока нет</b>"))
	}

	n, err := strconv.Atoi(msg.Arg(0))
	if err != nil || n < 1 || n > len(notes) {
		return msg.Answer(m.T("bad_index", "❌ <b>Укажите номер заметки, см. .notes</b>"))
	}

	notes = append(notes[:n-1], notes[n:]...)
	if err := m.saveNotes(msg.ChatID, notes); err != nil {
		return err
	}

	tpl := m.T("deleted", "🗑 <b>Удалена #{n}</b>")
	return msg.Answer(strings.Replace(tpl, "{n}", strconv.Itoa(n), 1))
}

msg.Arg(0) не выходит за границы — .delnote без аргумента даёт "", что Atoi отвергнет, и пользователь получит понятное сообщение.

8. Установить

Отправьте файл, ответьте на него, .loadmod. Затем:

.note купить молоко
.note      (в ответ на что-нибудь)
.notes
.delnote 1

Что здесь было

ВозможностьГде
Хранилище с чтением-изменением-записьюnotesFor / saveNotes
Аргументы или текст ответаArgsOrReply
Аргументы без выхода за границыArg(0)
Алиасы и «только владелец»CommandMetas
Переводимый текст со значением по умолчаниюm.T
Экранирование пользовательских данныхutils.EscapeHTML
Оборачивание ошибокfmt.Errorf("...: %w", err)

Дальше

Released under the GNU AGPL v3 License.