feed-to-muc/feed-to-muc.go

328 lines
8.5 KiB
Go
Raw Normal View History

2018-07-13 22:53:22 +02:00
/* Copyright 2018 Martin Dosch
Licensed under the "MIT License" */
package main
import (
"encoding/json"
"flag"
2018-07-13 22:53:22 +02:00
"log"
"os"
"os/user"
"strings"
"time"
"github.com/chilts/sid"
2019-02-01 19:55:06 +01:00
"github.com/mattn/go-xmpp"
2018-07-13 22:53:22 +02:00
)
// Variables defined globally as they are used by functions pingMUC
// and processStanzas.
var (
id string
err error
pingSent time.Time
pingReceived bool
)
2018-07-13 22:53:22 +02:00
func main() {
var configPath, configFile string
2018-07-13 22:53:22 +02:00
type configuration struct {
ServerAddress string
BotJid string
Password string
Muc string
MucNick string
MaxArticles int
RefreshTime time.Duration
NoExcerpt bool
2018-07-13 22:53:22 +02:00
Feeds []string
}
// Read path to config from command line option.
configFilePtr := flag.String("config", "none", "path to configuration file")
flag.Parse()
if *configFilePtr != "none" {
configFile = *configFilePtr
} else {
// Get systems user config path.
osConfigDir := os.Getenv("$XDG_CONFIG_HOME")
if osConfigDir != "" {
// Create configPath if not yet existing.
configPath = osConfigDir + "/.config/feed-to-muc/"
if _, err := os.Stat(configPath); os.IsNotExist(err) {
err = os.MkdirAll(configPath, 0700)
if err != nil {
log.Fatal("Error: ", err)
}
}
} else { // Get the current user.
curUser, err := user.Current()
2018-07-13 22:53:22 +02:00
if err != nil {
log.Fatal("Error: ", err)
return
2018-07-13 22:53:22 +02:00
}
// Get home directory.
home := curUser.HomeDir
2018-07-13 22:53:22 +02:00
if home == "" {
log.Fatal("Error: No home directory available.")
return
}
2018-07-13 22:53:22 +02:00
// Create configPath if not yet existing.
configPath = home + "/.config/feed-to-muc/"
if _, err := os.Stat(configPath + "config.json"); os.IsNotExist(err) {
err = os.MkdirAll(configPath, 0700)
if err != nil {
log.Fatal("Error: ", err)
}
2018-07-13 22:53:22 +02:00
}
}
configFile = configPath + "config.json"
2018-07-13 22:53:22 +02:00
}
// Check that config file is existing.
if _, err := os.Stat(configFile); os.IsNotExist(err) {
2018-07-13 22:53:22 +02:00
log.Fatal("Error: ", err)
}
// Read configuration file into variable config.
file, _ := os.Open(configFile)
2018-07-13 22:53:22 +02:00
defer file.Close()
decoder := json.NewDecoder(file)
config := configuration{}
if err := decoder.Decode(&config); err != nil {
log.Fatal("Error: ", err)
}
if _, err := os.Stat(configFile); os.IsNotExist(err) {
2018-07-13 22:53:22 +02:00
err = os.MkdirAll(configPath, 0700)
if err != nil {
log.Fatal("Error: ", err)
}
}
var client *xmpp.Client
options := xmpp.Options{
Host: config.ServerAddress,
User: config.BotJid,
Password: config.Password,
NoTLS: true,
StartTLS: true,
Debug: false,
}
// Connect to server.
2018-07-13 22:53:22 +02:00
client, err = options.NewClient()
if err != nil {
log.Fatal(err)
}
// Join the MUC
_, err := client.JoinMUCNoHistory(config.Muc, config.MucNick)
2018-07-13 22:53:22 +02:00
if err != nil {
log.Fatal(err)
}
// Starting goroutine to ping the server every 30 seconds.
go pingServer(client, config.ServerAddress, config.BotJid)
// Starting goroutine to ping the MUC every 30 seconds.
go pingMUC(client, config.BotJid, config.Muc, config.MucNick)
// Starting goroutine to process received stanzas.
go processStanzas(client, config.Muc, config.MucNick, config.Feeds)
// Set RefreshTime to 30 seconds if not defined.
if config.RefreshTime == 0 {
config.RefreshTime = 30
}
2018-07-13 22:53:22 +02:00
for {
2018-08-02 09:33:19 +02:00
// Check all configured feeds for new articles and send
// new articles to configured MUC.
2018-07-13 22:53:22 +02:00
for i := 0; i < len(config.Feeds); i++ {
output, err := getArticles(config.Feeds[i], config.MaxArticles, config.NoExcerpt)
2018-07-13 22:53:22 +02:00
if err != nil {
2018-08-02 09:33:19 +02:00
// Exit if an error occurs checking the feeds.
2018-07-13 22:53:22 +02:00
log.Fatal(err)
}
if output != "" {
2018-08-02 09:33:19 +02:00
_, err = client.Send(xmpp.Chat{Remote: config.Muc,
Type: "groupchat", Text: output})
if err != nil {
// ToDo: Save message for resend.
2018-08-02 09:33:19 +02:00
// Exit if message can not be sent.
log.Fatal(err)
}
2018-07-13 22:53:22 +02:00
}
}
2018-08-02 09:33:19 +02:00
// Wait 30 seconds before checking feeds again.
time.Sleep(config.RefreshTime * time.Second)
2018-07-13 22:53:22 +02:00
}
}
// Send a ping every 30 seconds after last successful ping to check if the MUC is still available.
func pingMUC(client *xmpp.Client, botJid string, muc string, mucNick string) {
for {
time.Sleep(30 * time.Second)
// Send ping to own MUC participant to check we are still joined.
id, err = client.RawInformation(botJid, muc+"/"+mucNick, sid.Id(),
2018-08-02 09:33:19 +02:00
"get", "<ping xmlns='urn:xmpp:ping'/>")
if err != nil {
log.Fatal(err)
}
pingSent = time.Now()
pingReceived = false
// Check for result IQ as long as there was no reply yet.
for (time.Since(pingSent).Seconds() < 10.0) && (pingReceived == false) {
time.Sleep(1 * time.Second)
if pingReceived == true {
break
}
}
// Quit if no ping reply was received.
if pingReceived == false {
log.Fatal("MUC not available.")
}
}
}
// Send a ping to the server every 30 seconds to check if the connection is still alive.
func pingServer(client *xmpp.Client, server string, botJid string) {
2018-07-13 22:53:22 +02:00
for {
time.Sleep(30 * time.Second)
// Send ping to server to check if connection still exists.
2018-07-13 22:53:22 +02:00
err := client.PingC2S(botJid, strings.Split(server, ":")[0])
if err != nil {
log.Fatal(err)
}
}
}
func processStanzas(client *xmpp.Client, muc string, mucNick string, feeds []string) {
for { // Receive stanzas. ToDo: Receive stanzas continiously without 30s delay.
stanza, err := client.Recv()
if err != nil {
log.Fatal(err)
}
// Check stanzas, maybe we want to reply.
switch v := stanza.(type) {
// Reply to requests for source and feeds.
case xmpp.Chat:
// Get first word of the message and transform it to lower case.
var mention string
mention = strings.ToLower(strings.Split(v.Text, " ")[0])
// If it is not the bots nick remove one trailing character as
// a lot of clients append `:` or `,` to mentions.
if mention != strings.ToLower(mucNick) {
mentionLength := len(mention)
// Leave if mentionLength is <= 0
if mentionLength <= 0 {
break
}
mention = mention[:mentionLength-1]
// Leave if the message is not addressed to the bot.
if mention != strings.ToLower(mucNick) {
break
}
}
// Check for the second word (command).
switch strings.ToLower(strings.Split(v.Text, " ")[1]) {
// Reply with a short summary of available commands for `help`.
case "help":
_, err = client.Send(xmpp.Chat{Remote: muc,
Type: "groupchat", Text: strings.Split(v.Remote, "/")[1] +
": The following commands are available:\n" +
"\"feeds\": List feeds I'm following.\n" +
"\"source\": Show source code URL."})
if err != nil {
log.Fatal(err)
}
// Reply with repo address for `source`.
case "source":
_, err = client.Send(xmpp.Chat{Remote: muc,
Type: "groupchat", Text: strings.Split(v.Remote, "/")[1] +
": My source can be found at " +
"https://salsa.debian.org/mdosch-guest/feed-to-muc"})
if err != nil {
log.Fatal(err)
}
// Reply with the list of monitored feeds for `feeds`.
case "feeds":
var feedList string
for _, feed := range feeds {
// Add next feed element and a newline.
feedList = feedList + feed + "\n"
}
_, err = client.Send(xmpp.Chat{Remote: muc,
Type: "groupchat", Text: strings.Split(v.Remote, "/")[1] +
": Feeds I'm following:\n" + feedList})
if err != nil {
log.Fatal(err)
}
}
// Reply to pings and disco queries.
case xmpp.IQ:
if (v.Type == "error") && (v.ID == id) {
log.Fatal("MUC not available.")
}
if (v.Type == "result") && (v.ID == id) {
pingReceived = true
}
if v.Type == "get" {
// Reply to disco#info requests according to https://xmpp.org/extensions/xep-0030.html.
if strings.Contains(string(v.Query),
"<query xmlns='http://jabber.org/protocol/disco#info'/>") == true {
_, err := client.RawInformation(client.JID(), v.From, v.ID,
"result", "<query xmlns='http://jabber.org/protocol/disco#info'>"+
"<identity category='client' type='bot' name='feedbot'/>"+
"<feature var='http://jabber.org/protocol/disco#info'/></query>")
if err != nil {
log.Fatal(err)
}
} else if strings.Contains(string(v.Query), "<ping xmlns='urn:xmpp:ping'/>") == true {
// Reply to pings.
_, err := client.RawInformation(client.JID(), v.From, v.ID, "result", "")
if err != nil {
log.Fatal(err)
}
} else {
// Send error replies for all other IQs.
_, err := client.RawInformation(client.JID(), v.From, v.ID, "error",
"<error type='cancel'><service-unavailable "+
"xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/></error>")
if err != nil {
log.Fatal(err)
}
}
}
default:
break
}
}
}