Add support for specified spoiler text (#526)

* Add support for specified spoiler text

* go fmt

* Fix duplicate response when URL is missing

config/config_test.go

@@ -1093,6 +1093,60 @@ func TestMastodon(t *testing.T) {
 			},
 			want: "foo",
 		},
+		{
+			name: "default mastodon cw",
+			envs: map[string]string{
+				"WAYBACK_MASTODON_CW": "true",
+			},
+			call: func(t *testing.T, opts *Options, want string) {
+				called := strconv.FormatBool(opts.MastodonCW())
+				if called != want {
+					t.Errorf(`Unexpected get the mastodon cw status, got %v instead of %s`, called, want)
+				}
+			},
+			want: "true",
+		},
+		{
+			name: "specified mastodon cw",
+			envs: map[string]string{
+				"WAYBACK_MASTODON_CW": "false",
+			},
+			call: func(t *testing.T, opts *Options, want string) {
+				called := strconv.FormatBool(opts.MastodonCW())
+				if called != want {
+					t.Errorf(`Unexpected get the mastodon cw status, got %v instead of %s`, called, want)
+				}
+			},
+			want: "false",
+		},
+		{
+			name: "default mastodon cw text",
+			envs: map[string]string{
+				"WAYBACK_MASTODON_CWTEXT": "",
+			},
+			call: func(t *testing.T, opts *Options, want string) {
+				opts.mastodon.cw = true
+				called := opts.MastodonCWText()
+				if called != want {
+					t.Errorf(`Unexpected get the mastodon cw text, got %v instead of %s`, called, want)
+				}
+			},
+			want: defMastodonCWText,
+		},
+		{
+			name: "specified mastodon cw text",
+			envs: map[string]string{
+				"WAYBACK_MASTODON_CWTEXT": "foo",
+			},
+			call: func(t *testing.T, opts *Options, want string) {
+				opts.mastodon.cw = true
+				called := opts.MastodonCWText()
+				if called != want {
+					t.Errorf(`Unexpected get the mastodon cw text, got %v instead of %s`, called, want)
+				}
+			},
+			want: "foo",
+		},
 		{
 			name: "publish to mastodon enabled",
 			envs: map[string]string{

config/options.go

@@ -48,6 +48,8 @@ const (
 	defMastodonClientKey     = ""
 	defMastodonClientSecret  = ""
 	defMastodonAccessToken   = ""
+	defMastodonCW            = false
+	defMastodonCWText        = "Wayback archive links"
 	defTwitterConsumerKey    = ""
 	defTwitterConsumerSecret = ""
 	defTwitterAccessToken    = ""
@@ -177,6 +179,8 @@ type mastodon struct {
 	clientKey    string
 	clientSecret string
 	accessToken  string
+	cw           bool
+	cwText       string
 }
 
 type discord struct {
@@ -293,6 +297,8 @@ func NewOptions() *Options {
 			clientKey:    defMastodonClientKey,
 			clientSecret: defMastodonClientSecret,
 			accessToken:  defMastodonAccessToken,
+			cw:           defMastodonCW,
+			cwText:       defMastodonCWText,
 		},
 		discord: &discord{
 			appID:    defDiscordBotToken,
@@ -529,6 +535,19 @@ func (o *Options) MastodonAccessToken() string {
 	return o.mastodon.accessToken
 }
 
+// MastodonCW returns whether to enable content warning for publish to Mastodon.
+func (o *Options) MastodonCW() bool {
+	return o.mastodon.cw
+}
+
+// MastodonCWText returns the CW text for publish to Mastodon.
+func (o *Options) MastodonCWText() string {
+	if o.MastodonCW() {
+		return o.mastodon.cwText
+	}
+	return ""
+}
+
 // PublishToMastodon returns whether to publish result to Mastodon.
 func (o *Options) PublishToMastodon() bool {
 	return o.MastodonServer() != "" &&

config/parser.go

@@ -131,6 +131,10 @@ func (p *Parser) parseLines(lines []string) (err error) {
 			p.opts.mastodon.clientSecret = parseString(val, defMastodonClientSecret)
 		case "WAYBACK_MASTODON_TOKEN":
 			p.opts.mastodon.accessToken = parseString(val, defMastodonAccessToken)
+		case "WAYBACK_MASTODON_CW":
+			p.opts.mastodon.cw = parseBool(val, defMastodonCW)
+		case "WAYBACK_MASTODON_CWTEXT":
+			p.opts.mastodon.cwText = parseString(val, defMastodonCWText)
 		case "WAYBACK_TWITTER_CONSUMER_KEY":
 			p.opts.twitter.consumerKey = parseString(val, defTwitterConsumerKey)
 		case "WAYBACK_TWITTER_CONSUMER_SECRET":

docs/environment.md

@@ -63,6 +63,8 @@ Use the `-c` / `--config` option to specify the build definition file to use.
 | -                   | `WAYBACK_MASTODON_KEY`            | -                          | The client key of your Mastodon application                  |
 | -                   | `WAYBACK_MASTODON_SECRET`         | -                          | The client secret of your Mastodon application               |
 | -                   | `WAYBACK_MASTODON_TOKEN`          | -                          | The access token of your Mastodon application                |
+| -                   | `WAYBACK_MASTODON_CW`             | `false`                    | Whether specified content warning                            |
+| -                   | `WAYBACK_MASTODON_CWTEXT`         | `Wayback archive links`    | The text of content warning                                  |
 | -                   | `WAYBACK_TWITTER_CONSUMER_KEY`    | -                          | The customer key of your Twitter application                 |
 | -                   | `WAYBACK_TWITTER_CONSUMER_SECRET` | -                          | The customer secret of your Twitter application              |
 | -                   | `WAYBACK_TWITTER_ACCESS_TOKEN`    | -                          | The access token of your Twitter application                 |

publish/mastodon/mastodon.go

@@ -84,8 +84,9 @@ func (m *Mastodon) toMastodon(ctx context.Context, text, id string) bool {
 	}
 
 	toot := &mastodon.Toot{
-		Status:     text,
-		Visibility: mastodon.VisibilityPublic,
+		Status:      text,
+		SpoilerText: m.opts.MastodonCWText(),
+		Visibility:  mastodon.VisibilityPublic,
 	}
 	if id != "" {
 		toot.InReplyToID = mastodon.ID(id)

service/mastodon/mastodon.go

@@ -43,7 +43,8 @@ type Mastodon struct {
 	store  *storage.Storage
 	pub    *publish.Publish
 
-	archiving map[mastodon.ID]bool
+	archiving  map[mastodon.ID]bool
+	processing map[mastodon.ID]int
 
 	clearTick *time.Ticker
 	fetchTick *time.Ticker
@@ -104,6 +105,7 @@ func (m *Mastodon) Serve() error {
 
 	go func() {
 		m.archiving = make(map[mastodon.ID]bool)
+		m.processing = make(map[mastodon.ID]int)
 		for {
 			select {
 			case <-m.clearTick.C:
@@ -139,6 +141,9 @@ func (m *Mastodon) Serve() error {
 						metrics.IncrementWayback(metrics.ServiceMastodon, metrics.StatusRequest)
 						bucket := pooling.Bucket{
 							Request: func(ctx context.Context) error {
+								m.Lock()
+								m.processing[n.Status.ID] += 1
+								m.Unlock()
 								if err := m.process(ctx, n.ID, n.Status); err != nil {
 									logger.Error("process failure, notification: %#v, error: %v", n, err)
 									return err
@@ -155,6 +160,7 @@ func (m *Mastodon) Serve() error {
 						m.pool.Put(bucket)
 						m.Lock()
 						delete(m.archiving, n.ID)
+						delete(m.processing, n.ID)
 						m.Unlock()
 					}()
 				}
@@ -206,7 +212,10 @@ func (m *Mastodon) process(ctx context.Context, id mastodon.ID, status *mastodon
 	urls := service.MatchURL(m.opts, text)
 	if len(urls) == 0 {
 		logger.Warn("archives failure, URL no found.")
-		m.ToMastodon(ctx, "URL no found", string(status.ID))
+		// Ensure response once
+		if m.processing[status.ID] == m.opts.PoolingSize() {
+			m.ToMastodon(ctx, "URL no found", string(status.ID))
+		}
 		return errors.New("Mastodon: URL no found")
 	}
 

wayback.1

@@ -225,6 +225,12 @@ The client secret of your Mastodon application\&.
 .B WAYBACK_MASTODON_TOKEN
 The access token of your Mastodon application\&.
 .TP
+.B WAYBACK_MASTODON_CW
+Whether specified content warning\&.
+.TP
+.B WAYBACK_MASTODON_CWTEXT
+The text of content warning\&.
+.TP
 .B WAYBACK_TWITTER_CONSUMER_KEY
 The customer key of your Twitter application\&.
 .TP

wayback.conf

@@ -22,6 +22,8 @@ WAYBACK_MASTODON_SERVER=
 WAYBACK_MASTODON_KEY=
 WAYBACK_MASTODON_SECRET=
 WAYBACK_MASTODON_TOKEN=
+WAYBACK_MASTODON_CW=false
+WAYBACK_MASTODON_CWTEXT=Wayback archive links
 WAYBACK_TWITTER_CONSUMER_KEY=
 WAYBACK_TWITTER_CONSUMER_SECRE=
 WAYBACK_TWITTER_ACCESS_TOKEN=