diff --git a/.gitignore b/.gitignore index 867ccf5..688a10d 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ config.yaml # Output of the go coverage tool, specifically when used with LiteIDE *.out kiki +redis_data # Dependency directories (remove the comment below to include it) # vendor/ diff --git a/Dockerfile b/Dockerfile index 0ade8a6..777570e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,6 @@ -FROM golang:1.24 +FROM golang:1.24-alpine AS build + +RUN apk add --no-cache make WORKDIR /app/kiki @@ -14,4 +16,12 @@ COPY Makefile /app/kiki/ RUN make +FROM alpine:latest + +WORKDIR /app/kiki/ + +COPY --from=build /app/kiki/kiki /app/kiki/kiki + +RUN chmod +x /app/kiki/kiki + CMD [ "/app/kiki/kiki", "run" ] \ No newline at end of file diff --git a/README.md b/README.md index 3edeb29..daabdb8 100644 --- a/README.md +++ b/README.md @@ -10,33 +10,25 @@ * golang 1.24.2+ * redis +* gnu make -Далее надо пройтись по всем папкам и сделать ```go mod tidy```: - +После необходимо произвести сборку утилиты с помощью команды ```make```: ``` -cd config -go mod tidy -cd ../stacker -go mod tidy -cd ../tooter -go mod tidy -cd ../service -go mod tidy -cd ../ -``` - -После уже собрать саму программу: -``` -go build -C service -o ../kiki +make ``` В папке с проектом появится исполняемый файл kiki. Перед запуском необходимо заполнить конфигурационный файл config.yaml (пример заполнения представлен в файле config.example.yaml) ``` -instance: https://pleroma.catgirls.asia #Инстанс, на котором находится аккаунт, в который будет происходить постинг -rss_url: https://4pda.to/feed #Новостная лента -sensitive: true #Ставить ли плашку NSFW +instance: https://pleroma.catgirls.asia #Адрес инстанса +rss_urls: #YAML массив лент + - url: https://habr.com/ru/rss/flows/admin/articles/?fl=ru #Адрес ленты + sensitive: false #Нужно ли ставить NSFW плашку + visibility: "unlisted" #Режим отображения постов. Есть public, unlisted, private, direct + - url: https://4pda.to/feed + sensitive: false + visibility: "unlisted" redis: - address: localhost:6379 #Адрес Redis + address: localhost:6379 #Адрес Redis, в случае использования Docker Compose необходимо написать redis:6379 ``` После чего необходимо провести инициализацию для получения секретов аккаунта. **СЕКРЕТЫ ХРАНЯТСЯ В ОТКРЫТОМ ВИДЕ, ТАК ЧТО БУДЬТЕ ОСТОРОЖНЫ!** @@ -47,6 +39,11 @@ redis: После этого программу можно запустить командой ```./kiki run```. Перед запуском убедитесь что Redis запущен. +Если вам надо удалить утилиту и почистить все go.sum файлы, то можно выполнить следующую команду: +``` +make clean +``` + # Запуск в Docker Для запуска программы в Docker необходимо создать два файла: secret.conf и config.yaml: @@ -78,9 +75,13 @@ docker compose up -d * [x] Добавление картинок в пост * [x] Добавление поддержки Redis * [x] Упаковка в Docker образ -* [ ] Создание Makefile для более удобной сборки -* [ ] Поддержка обновления данных из конфига "на лету" -* [ ] Добавление поддержки нескольких лент +* [x] Создание Makefile для более удобной сборки +* [x] Поддержка обновления данных из конфига "на лету" +* [x] Добавление поддержки нескольких лент +* [ ] Добавить поддержку шаблонов +* [ ] Добавить сбор информации о инстансе, кол-ве поддерживаемых символов и кол-ве поддерживаемых медиа в одном посте. Сделать обработку этой информации и формирование постов с учетом инстансоспецифичных факторов +* [ ] Некоторые RSS-ленты содержат видео. Добавить поддержку видео в постах +* [ ] Дополнительные флаги для команды чтобы указывать где лежит конфиг # Отказ от ответственности diff --git a/config.example.yaml b/config.example.yaml index 10cff5e..ce83de1 100644 --- a/config.example.yaml +++ b/config.example.yaml @@ -1,5 +1,10 @@ instance: https://pleroma.catgirls.asia -rss_url: https://4pda.to/feed -sensitive: true +rss_urls: + - url: https://habr.com/ru/rss/flows/admin/articles/?fl=ru + sensitive: false + visibility: "unlisted" + - url: https://4pda.to/feed + sensitive: false + visibility: "unlisted" redis: address: localhost:6379 \ No newline at end of file diff --git a/config/config.go b/config/config.go index b84cd21..4d5e72b 100644 --- a/config/config.go +++ b/config/config.go @@ -8,15 +8,20 @@ import ( "gopkg.in/yaml.v2" ) +// Сруктура config.yaml type KikiSettings struct { - Instance string `yaml:"instance,omitempty"` - RSSUri string `yaml:"rss_url,omitempty"` - Sensitive bool `yaml:"sensitive,omitempty"` - Redis struct { + Instance string `yaml:"instance,omitempty"` + RSSURLs []struct { + Url string `yaml:"url,omitempty"` + Sensitive bool `yaml:"sensitive,omitempty"` + Visibility string `yaml:"visibility"` + } `yaml:"rss_urls,omitempty"` + Redis struct { Address string `yaml:"address"` } `yaml:"redis"` } +// Структура secret.conf type MastodonClientData struct { ClientID string `yaml:"clientID,omitempty"` ClientSecret string `yaml:"clientSecret,omitempty"` @@ -24,6 +29,7 @@ type MastodonClientData struct { Instance string `yaml:"instance,omitempty"` } +// Получение данных из конфига config.yaml func GetKikiConfig(path string) KikiSettings { var kikiSettings KikiSettings @@ -40,6 +46,7 @@ func GetKikiConfig(path string) KikiSettings { return kikiSettings } +// Получение данных из конфига secret.conf func GetSecrets(path string) *mastodon.Config { var clientData MastodonClientData diff --git a/docker-compose.yml b/docker-compose.yml index 3e8a0af..f348f4a 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,6 +1,6 @@ services: kiki: - build: ./ + image: git.catgirls.asia/b4d_us3r/kiki:latest restart: always volumes: - ./config.yaml:/app/kiki/config.yaml @@ -10,4 +10,5 @@ services: redis: image: redis restart: always - \ No newline at end of file + volumes: + - ./redis_data:/data \ No newline at end of file diff --git a/file_watcher/file_watcher.go b/file_watcher/file_watcher.go index 52b8a98..35d2311 100644 --- a/file_watcher/file_watcher.go +++ b/file_watcher/file_watcher.go @@ -5,6 +5,7 @@ import ( "time" ) +// Проверка на изменение в файле filename func IsFileChange(lastMod *time.Time, filename string) bool { fileStat, err := os.Stat(filename) @@ -20,6 +21,7 @@ func IsFileChange(lastMod *time.Time, filename string) bool { } } +// Получение информации о том, когда файл изменился func GetFileModTime(filename string) (time.Time, error) { fileStat, err := os.Stat(filename) diff --git a/service/kiki.go b/service/kiki.go index bb462ce..e1d4ed1 100644 --- a/service/kiki.go +++ b/service/kiki.go @@ -6,6 +6,7 @@ import ( "net/url" "os" "path/filepath" + "slices" "time" "kiki/config" @@ -24,7 +25,7 @@ func main() { Commands: []*cli.Command{ { Name: "init", - Usage: "Инициализировать клиента", + Usage: "Инициализировать клиента и создать secret.conf, в котором будут храниться данные для доступа к учетной записи", Action: func(ctx context.Context, cmd *cli.Command) error { confFile, err := filepath.Abs("config.yaml") kikiConfig := config.GetKikiConfig(confFile) @@ -74,28 +75,30 @@ func main() { if file_watcher.IsFileChange(&lastFileMod, confFile) { log.Println(lastFileMod) log.Println("RSS ленты перечитаны") - kikiConfig.RSSUri = config.GetKikiConfig(confFile).RSSUri + kikiConfig.RSSURLs = config.GetKikiConfig(confFile).RSSURLs } - newPosts := tooter.NewsText(kikiConfig.RSSUri) + for _, rssUrl := range kikiConfig.RSSURLs { + newPost := tooter.NewsText(rssUrl.Url) - for _, post := range newPosts { - inStack, err := stacker.CheckInRedis(rdb, post.GUID) - if err != nil { - log.Println(err) - } - - if !inStack { - log.Println(post.Description) - - toot, err := tooter.CreateToot(*mastoClient, post, kikiConfig.Sensitive) + for _, post := range slices.Backward(newPost) { + inStack, err := stacker.CheckInRedis(rdb, post.GUID) if err != nil { log.Println(err) } - tooter.CreatePost(*mastoClient, toot) + if !inStack { + log.Println(post.Description) - stacker.SetToRedis(rdb, post.GUID, post.Description) + toot, err := tooter.CreateToot(*mastoClient, post, rssUrl.Sensitive, rssUrl.Visibility) + if err != nil { + log.Println(err) + } + + tooter.CreatePost(*mastoClient, toot) + + stacker.SetToRedis(rdb, post.GUID, post.Description) + } } } } diff --git a/stacker/stacker.go b/stacker/stacker.go index 8f3de73..28d2933 100644 --- a/stacker/stacker.go +++ b/stacker/stacker.go @@ -6,6 +6,7 @@ import ( "github.com/redis/go-redis/v9" ) +// Создание подключения к Redis func ConnectToRedis(addr string) redis.Client { rdb := redis.NewClient(&redis.Options{ Addr: addr, @@ -16,6 +17,7 @@ func ConnectToRedis(addr string) redis.Client { return *rdb } +// Создание записи в Redis о том, что этот пост отправлен func SetToRedis(rdb redis.Client, key string, val interface{}) error { err := rdb.Set(context.Background(), key, val, 0).Err() if err != nil { @@ -24,6 +26,7 @@ func SetToRedis(rdb redis.Client, key string, val interface{}) error { return nil } +// Проверка есть ли пост в Redis или нет func CheckInRedis(rdb redis.Client, key string) (bool, error) { _, err := rdb.Get(context.Background(), key).Result() if err == redis.Nil { @@ -34,6 +37,7 @@ func CheckInRedis(rdb redis.Client, key string) (bool, error) { return true, nil } +// Сохранение базы данных Redis func SaveRedis(rdb redis.Client) error { err := rdb.Save(context.Background()).Err() if err != nil { diff --git a/tooter/tooter.go b/tooter/tooter.go index 69fbb60..3ae99f3 100644 --- a/tooter/tooter.go +++ b/tooter/tooter.go @@ -5,6 +5,7 @@ import ( "fmt" "io" "log" + "net" "net/http" "net/url" "os" @@ -18,6 +19,7 @@ import ( "gopkg.in/yaml.v2" ) +// Функция создает файл secret.conf, в котором хранятся данные для доступа к аккаунту func ClientConfiguration(Instance string) { appConfig := &mastodon.AppConfig{ Server: Instance, @@ -37,7 +39,7 @@ func ClientConfiguration(Instance string) { log.Println(err) } var userToken string - //fmt.Println(u) + fmt.Printf("Перейдите по ссылке\n%s\nИ введите user token ниже:\n", u) fmt.Scanln(&userToken) @@ -67,24 +69,38 @@ func ClientConfiguration(Instance string) { } log.Println(string(marshaledYaml)) + secretConfig, err := os.OpenFile("secret.conf", os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0o644) if err != nil { log.Println(err) } + secretConfig.Write(marshaledYaml) + defer secretConfig.Close() } +// Возвращает срез новостей, полученных из RSS ленты func NewsText(url string) []*gofeed.Item { fp := gofeed.NewParser() feed, err := fp.ParseURL(url) + if err != nil { - log.Println(err) + if netErr, ok := err.(net.Error); ok && netErr.Timeout() { + log.Println("Timeout Error:", err) + return []*gofeed.Item{} + } else { + log.Println(err) + return []*gofeed.Item{} + } } + log.Println("RSS лента получена") + return feed.Items } +// Отправляет созданный пост func CreatePost(mastoClient mastodon.Client, toot mastodon.Toot) { _, err := mastoClient.PostStatus(context.Background(), &toot) if err != nil { @@ -92,25 +108,34 @@ func CreatePost(mastoClient mastodon.Client, toot mastodon.Toot) { } } +// Обходит срез ссылок на изображения и возвращает срез, состоящий из представления картинок в виде срезов байтов func PicBytesArray(picturesArray []string) [][]byte { var picturesBytes [][]byte + for _, picture := range picturesArray { resp, err := http.Get(picture) + if err != nil { log.Println(err) return picturesBytes } + defer resp.Body.Close() + picBytes, err := io.ReadAll(resp.Body) + if err != nil { log.Println(err) return picturesBytes } + picturesBytes = append(picturesBytes, picBytes) } + return picturesBytes } +// Загружает на инстанс изображения, после чего возвращает массив прикрепленных медиа в Mastodon. Необходимо для получения MediaID для каждого изображения func UploadPictures(mastoClient mastodon.Client, filesBytes [][]byte) []*mastodon.Attachment { var attachments []*mastodon.Attachment @@ -128,14 +153,15 @@ func UploadPictures(mastoClient mastodon.Client, filesBytes [][]byte) []*mastodo return attachments } -func CreateToot(mastoClient mastodon.Client, newsDesc *gofeed.Item, sensitive bool) (mastodon.Toot, error) { +// Формирование тела статуса +func CreateToot(mastoClient mastodon.Client, newsDesc *gofeed.Item, sensitive bool, visibility string) (mastodon.Toot, error) { var imgArray []string var attachments []*mastodon.Attachment var tootText string = fmt.Sprintf("src: %s\n\n", newsDesc.Link) toot := mastodon.Toot{ - Visibility: "unlisted", + Visibility: visibility, Sensitive: sensitive, }