chore: run formatter

Author: cvanloo

cmd/mentionee/main.go

@@ -8,22 +8,22 @@
 // Configuration is read from a .env file (or just the OS env vars directly).
 // An .env file must be present in either the process working directory
 // `$PWD/.env`, or in `/etc/webmention/mentionee.env`.
-// 
+//
 // Configurable values are:
 //   - SHUTDOWN_TIMEOUT=Seconds: How long to wait for a clean shutdown after SIGINT or SIGTERM (default 120)
 //   - ENDPOINT=URL Path: On which path to listen for Webmentions (default /api/webmention)
 //   - LISTEN_ADDR=Domain with Port: Bind listener to this domain:port (default :8080)
 //   - ACCEPT_DOMAIN=Domain: Accept mentions if they point to this domain (e.g., the domain of your blog, required, no default)
 //   - NOTIFY_BY_MAIL=external, internal or no: Whether or not to enable notifications by mail (default no)
-//                    external: use an external (relay) SMTP server
-//                    internal: use builtin SMTP (deliver mail directly to the recipient)
+//
 // Options for external SMTP server:
 //   - MAIL_HOST=Domain: Domain of the outgoing mail server (no default, required)
 //   - MAIL_PORT=Port: Port of the outgoing mail server (no default, required)
 //   - MAIL_USER=Username: User to authenticate to the outgoing mail server (no default, required)
 //   - MAIL_PASS=Password: Password to authenticate to the outgoing mail server (no default, required)
 //   - MAIL_FROM=E-Mail address: Address used in the FROM header (default same as MAIL_USER)
 //   - MAIL_TO=E-Mail address: Address used in the TO header (default same as MAIL_FROM, or MAIL_USER if MAIL_FROM not set)
+//
 // Options for internal SMPT server:
 //   - MAIL_FROM=E-Mail address: Send emails from this address (required)
 //   - MAIL_TO=E-Mail address: Send emails to this email address (required)
@@ -41,6 +41,9 @@ package main
 
 import (
 	"context"
+	"crypto/rsa"
+	"crypto/x509"
+	"encoding/pem"
 	"errors"
 	"fmt"
 	"log/slog"
@@ -50,14 +53,11 @@ import (
 	"os/signal"
 	"syscall"
 	"time"
-	"crypto/x509"
-	"crypto/rsa"
-	"encoding/pem"
 
-	"gopkg.in/gomail.v2"
-	"github.com/joho/godotenv"
-	"github.com/emersion/go-msgauth/dkim"
 	"github.com/cvanloo/parsenv"
+	"github.com/emersion/go-msgauth/dkim"
+	"github.com/joho/godotenv"
+	"gopkg.in/gomail.v2"
 
 	webmention "github.com/cvanloo/gowebmention"
 	"github.com/cvanloo/gowebmention/listener"
@@ -88,34 +88,34 @@ var ConfigMailExternal struct {
 // For this, it needs to be authorized to send emails from the MAIL_FROM_ADDR
 // domain. The following DNS entries are required:
 //
-// 	- A   | mail.example.com   | 11.22.33.44
-// 	- MX  | example.com        | mail.example.com
-// 	- TXT | example.com        | v=spf1 mx -all
-// 	- TXT | _dmarc.example.com | v=DMARC1; p=quarantine;
+//   - A   | mail.example.com   | 11.22.33.44
+//   - MX  | example.com        | mail.example.com
+//   - TXT | example.com        | v=spf1 mx -all
+//   - TXT | _dmarc.example.com | v=DMARC1; p=quarantine;
 //
 // Replace example.com with your own domain, and 11.22.33.44 with the IP of the
 // server on which mentionee runs.
 //
 // For DKIM refer to the documentation on ConfigMailDkim.
 var ConfigMailInternal struct {
-	MailFrom         string `cfg:"required"`
-	MailTo           string `cfg:"required"`
-	MailFromAddr     string `cfg:"required"`
-	MailToAddr       string `cfg:"required"`
-	MailDkimPriv     string
+	MailFrom     string `cfg:"required"`
+	MailTo       string `cfg:"required"`
+	MailFromAddr string `cfg:"required"`
+	MailToAddr   string `cfg:"required"`
+	MailDkimPriv string
 }
 
 // In addition to the DNS entries explained in ConfigMailInternal, you'll have
 // to setup another DNS entry for DKIM verification to work.
 //
-// 	- TXT | default._domainkey.example.com | v=DKIM1; k=rsa; p=YOUR_PUBLIC_KEY_HERE
+//   - TXT | default._domainkey.example.com | v=DKIM1; k=rsa; p=YOUR_PUBLIC_KEY_HERE
 //
 // "default" must be the same as in MAIL_DKIM_SELECTOR.
 // You can create a pub/priv key pair using the commands:
 //
-// 	openssl genrsa -out private 1024
-// 	openssl rsa -in private -pubout -out public
-// 	sed '1d;$d' public | tr -d '\n' > spublic; echo "" >> spublic
+//	openssl genrsa -out private 1024
+//	openssl rsa -in private -pubout -out public
+//	sed '1d;$d' public | tr -d '\n' > spublic; echo "" >> spublic
 //
 // MAIL_DKIM_PRIV must point to the 'private' file.
 // As YOUR_PUBLIC_KEY_HERE in the above DNS entry, you must use the contents
@@ -126,19 +126,19 @@ var ConfigMailInternal struct {
 // Since mentionee can only send, not receive emails, you might want to setup
 // 'rua' and 'ruf' to point to a different email address:
 //
-// 	- TXT | _dmarc.example.com | v=DMARC1; p=quarantine; rua=mailto:dmarc@whatever.else; ruf=mailto:dmarc-forensics@whatever.else;
+//   - TXT | _dmarc.example.com | v=DMARC1; p=quarantine; rua=mailto:dmarc@whatever.else; ruf=mailto:dmarc-forensics@whatever.else;
 //
 // For this to work, you also need an entry on the whatever.else domain:
 //
-// 	- TXT | example.com._report._dmarc | v=DMARC1
+//   - TXT | example.com._report._dmarc | v=DMARC1
 var ConfigMailDkim struct {
 	MailDkimSelector string `cfg:"default=default"`
 	MailDkimHost     string `cfg:"required"`
 }
 
 const (
-	ExitSuccess = 0
-	ExitFailure = 1
+	ExitSuccess     = 0
+	ExitFailure     = 1
 	ExitConfigError = -1
 )
 
@@ -174,15 +174,15 @@ func loadConfig() (opts []webmention.ReceiverOption, listenAddr, endpoint string
 		}
 		mailer := listener.ExternalMailer{
 			SubjectLine: listener.DefaultSubjectLine,
-			Body: listener.DefaultBody,
-			From: from,
-			To: to,
-			Dialer: dialer,
+			Body:        listener.DefaultBody,
+			From:        from,
+			To:          to,
+			Dialer:      dialer,
 		}
 		aggregator := &listener.ReportAggregator{
-			SendAfterTime: 12*time.Hour,
+			SendAfterTime:  12 * time.Hour,
 			SendAfterCount: -1,
-			Sender: mailer,
+			Sender:         mailer,
 		}
 		opts = append(opts, webmention.WithNotifier(listener.Mailer{aggregator}))
 		agg = aggregator
@@ -213,38 +213,38 @@ func loadConfig() (opts []webmention.ReceiverOption, listenAddr, endpoint string
 			mailer := listener.InternalDKIMMailer{
 				InternalMailer: listener.InternalMailer{
 					SubjectLine: listener.DefaultSubjectLine,
-					Body: listener.DefaultBody,
-					FromAddr: ConfigMailInternal.MailFromAddr,
-					ToAddr: ConfigMailInternal.MailToAddr,
-					From: ConfigMailInternal.MailFrom,
-					To: ConfigMailInternal.MailTo,
+					Body:        listener.DefaultBody,
+					FromAddr:    ConfigMailInternal.MailFromAddr,
+					ToAddr:      ConfigMailInternal.MailToAddr,
+					From:        ConfigMailInternal.MailFrom,
+					To:          ConfigMailInternal.MailTo,
 				},
 				DkimSignOpts: &dkim.SignOptions{
-					Domain: ConfigMailDkim.MailDkimHost,
+					Domain:   ConfigMailDkim.MailDkimHost,
 					Selector: ConfigMailDkim.MailDkimSelector,
-					Signer: pk,
+					Signer:   pk,
 				},
 			}
 			aggregator := &listener.ReportAggregator{
-				SendAfterTime: 12*time.Hour,
+				SendAfterTime:  12 * time.Hour,
 				SendAfterCount: -1,
-				Sender: mailer,
+				Sender:         mailer,
 			}
 			opts = append(opts, webmention.WithNotifier(listener.Mailer{aggregator}))
 			agg = aggregator
 		} else {
 			mailer := listener.InternalMailer{
 				SubjectLine: listener.DefaultSubjectLine,
-				Body: listener.DefaultBody,
-				FromAddr: ConfigMailInternal.MailFromAddr,
-				ToAddr: ConfigMailInternal.MailToAddr,
-				From: ConfigMailInternal.MailFrom,
-				To: ConfigMailInternal.MailTo,
+				Body:        listener.DefaultBody,
+				FromAddr:    ConfigMailInternal.MailFromAddr,
+				ToAddr:      ConfigMailInternal.MailToAddr,
+				From:        ConfigMailInternal.MailFrom,
+				To:          ConfigMailInternal.MailTo,
 			}
 			aggregator := &listener.ReportAggregator{
-				SendAfterTime: 12*time.Hour,
+				SendAfterTime:  12 * time.Hour,
 				SendAfterCount: -1,
-				Sender: mailer,
+				Sender:         mailer,
 			}
 			opts = append(opts, webmention.WithNotifier(listener.Mailer{aggregator}))
 			agg = aggregator

listener/mail.go

@@ -1,14 +1,14 @@
 package listener
 
 import (
+	"bytes"
 	"fmt"
 	"gopkg.in/gomail.v2"
 	"log/slog"
-	"bytes"
 	"net/smtp"
+	"strings"
 	"sync"
 	"time"
-	"strings"
 
 	"github.com/emersion/go-msgauth/dkim"
 
@@ -38,7 +38,7 @@ type (
 	}
 	InternalDKIMMailer struct {
 		InternalMailer
-		DkimSignOpts     *dkim.SignOptions
+		DkimSignOpts *dkim.SignOptions
 	}
 	ExternalMailer struct {
 		SubjectLine func([]webmention.Mention) string

receiver.go

@@ -1,18 +1,18 @@
 package webmention
 
 import (
-	"fmt"
 	"context"
+	"fmt"
 	"golang.org/x/net/html"
 	"io"
 	"log/slog"
+	mimelib "mime"
 	"net/http"
 	"net/url"
-	"strings"
-	"strconv"
 	"slices"
+	"strconv"
+	"strings"
 	"time"
-	mimelib "mime"
 )
 
 type (
@@ -35,7 +35,7 @@ type (
 	}
 
 	mediaRegister []mediaHandler
-	mediaHandler struct {
+	mediaHandler  struct {
 		name    string
 		handler MediaHandler
 		qweight float64
@@ -46,13 +46,13 @@ type (
 	// If no (exact) match is found, a status of StatusNoLink and a nil error must be returned.
 	// If error is non-nil, it is treated as an internal error and the value of status is ignored.
 	// On error, no listeners will be invoked.
-	MediaHandler    func(sourceData io.Reader, target URL) (Status, error)
-	ReceiverOption  func(*Receiver)
-	Mention struct {
+	MediaHandler   func(sourceData io.Reader, target URL) (Status, error)
+	ReceiverOption func(*Receiver)
+	Mention        struct {
 		Source, Target URL
 		Status         Status
 	}
-	Status string
+	Status            string
 	TargetAcceptsFunc func(source, target URL) bool
 
 	// A registered Notifier is informed of any valid webmentions.
@@ -121,9 +121,9 @@ func NewReceiver(opts ...ReceiverOption) *Receiver {
 		targetAccepts: func(URL, URL) bool {
 			return false
 		},
-		userAgent:  "Webmention (github.com/cvanloo/gowebmention)",
+		userAgent:    "Webmention (github.com/cvanloo/gowebmention)",
 		mentionCache: map[mentionCacheEntry]time.Time{},
-		cacheTimeout: 3*time.Hour,
+		cacheTimeout: 3 * time.Hour,
 	}
 	receiver.mediaHandler = mediaRegister{
 		{name: "text/html", qweight: 1.0, handler: HtmlHandler},
@@ -182,7 +182,7 @@ func WithMediaHandler(mime string, qweight float64, handler MediaHandler) Receiv
 			}
 		} else {
 			r.mediaHandler = append(r.mediaHandler, mediaHandler{
-				name: mime,
+				name:    mime,
 				qweight: qweight,
 				handler: handler,
 			})

receiver_test.go

@@ -1,23 +1,23 @@
 package webmention_test
 
 import (
+	"context"
 	"errors"
-	"strconv"
-	"io"
 	"fmt"
-	"net/url"
-	"testing"
+	webmention "github.com/cvanloo/gowebmention"
+	"io"
+	"log"
 	"net/http"
 	"net/http/httptest"
+	"net/url"
+	"strconv"
 	"sync"
-	"log"
-	"context"
+	"testing"
 	"time"
-	webmention "github.com/cvanloo/gowebmention"
 )
 
 func ExampleReceiver() {
-	acceptForTargetUrl  := must(url.Parse("https://example.com"))
+	acceptForTargetUrl := must(url.Parse("https://example.com"))
 	webmentionee := webmention.NewReceiver(
 		webmention.WithAcceptsFunc(func(source, target *url.URL) bool {
 			return acceptForTargetUrl.Scheme == target.Scheme && acceptForTargetUrl.Host == target.Host
@@ -29,7 +29,7 @@ func ExampleReceiver() {
 	mux := &http.ServeMux{}
 	mux.Handle("/api/webmention", webmentionee)
 	srv := http.Server{
-		Addr: ":8080",
+		Addr:    ":8080",
 		Handler: mux,
 	}
 
@@ -63,11 +63,11 @@ func accepts(source, target *url.URL) bool {
 }
 
 type TestCase struct {
-	Comment string
-	SourceHandler func(ts **httptest.Server) func(w http.ResponseWriter, r *http.Request)
-	ExpectedHttpStatus int
+	Comment               string
+	SourceHandler         func(ts **httptest.Server) func(w http.ResponseWriter, r *http.Request)
+	ExpectedHttpStatus    int
 	ExpectedMentionStatus webmention.Status
-	ExpectedError error
+	ExpectedError         error
 }
 
 var TestCases = []TestCase{
@@ -79,7 +79,7 @@ var TestCases = []TestCase{
 				w.Write([]byte(body))
 			}
 		},
-		ExpectedHttpStatus: 202,
+		ExpectedHttpStatus:    202,
 		ExpectedMentionStatus: webmention.StatusLink,
 	},
 	{
@@ -89,7 +89,7 @@ var TestCases = []TestCase{
 				w.Write([]byte("<p>I'm not linking to anything. ;-(</p>"))
 			}
 		},
-		ExpectedHttpStatus: 202, // this type of validation happens async
+		ExpectedHttpStatus:    202, // this type of validation happens async
 		ExpectedMentionStatus: webmention.StatusNoLink,
 	},
 	{
@@ -100,7 +100,7 @@ var TestCases = []TestCase{
 				w.Write([]byte(`<p>This post was deleted</p>`))
 			}
 		},
-		ExpectedHttpStatus: 202,
+		ExpectedHttpStatus:    202,
 		ExpectedMentionStatus: webmention.StatusDeleted,
 	},
 	{