/
main.go
655 lines (568 loc) · 15.6 KB
/
main.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
package main
import (
"context"
"encoding/json"
"flag"
"fmt"
"io/ioutil"
"log"
"net/url"
"os"
"os/signal"
"regexp"
"sort"
"strings"
"sync"
"syscall"
"time"
cid "github.com/ipfs/go-cid"
"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/api/rest/client"
multiaddr "github.com/multiformats/go-multiaddr"
"github.com/dghubble/go-twitter/twitter"
"github.com/dghubble/oauth1"
)
// ConfigFile is the path of the default configuration file
var ConfigFile = "config.json"
// Gateway
var IPFSGateway = "https://ipfs.io"
const twittercom = "twitter.com"
type Action string
// Variables containing the different available actions
var (
// (spaces)(action)whitespaces(arguments)
actionRegexp = regexp.MustCompile(`^\s*([[:graph:]]+)\s+(.+)`)
// (cid)whitespaces(name with whitespaces). [:graph:] does not
// match line breaks or spaces.
pinRegexp = regexp.MustCompile(`([[:graph:]]+)\s+([[:graph:]\s]+)`)
PinAction Action = "!pin"
UnpinAction Action = "!unpin"
AddAction Action = "!add"
HelpAction Action = "!help"
)
func (a Action) Valid() bool {
switch a {
case PinAction, UnpinAction, AddAction, HelpAction:
return true
}
return false
}
func (a Action) String() string {
return string(a)
}
// Config is the configuration format for the Twitter Pinbot
type Config struct {
TwitterID string `json:"twitter_id"`
TwitterName string `json:"twitter_name"`
AccessKey string `json:"access_key"`
AccessSecret string `json:"access_secret"`
ConsumerKey string `json:"consumer_key"`
ConsumerSecret string `json:"consumer_secret"`
ClusterPeerAddr string `json:"cluster_peer_addr"`
ClusterUsername string `json:"cluster_username"`
ClusterPassword string `json:"cluster_password"`
}
func readConfig(path string) *Config {
cfg := &Config{}
cfgFile, err := ioutil.ReadFile(path)
if err != nil {
log.Fatal(err)
}
err = json.Unmarshal(cfgFile, &cfg)
if err != nil {
log.Fatal(err)
}
return cfg
}
// Bot is a twitter bot which reads a user's timeline
// and performs actions on IPFS Cluster if the tweets
// match, i.e. a tweet with: "@bothandle pin <cid> name"
// will pin something. The users with pin permissions are
// those followed by the bot. Retweets by users followed
// by the bot should also work. The bot will answer
// the tweet with a result.
type Bot struct {
ctx context.Context
cancel context.CancelFunc
name string
id string
twClient *twitter.Client
clusterClient client.Client
follows sync.Map
die chan struct{}
}
// New creates a new Bot with the Config.
func New(cfg *Config) (*Bot, error) {
ctx, cancel := context.WithCancel(context.Background())
// Twitter client
ocfg := oauth1.NewConfig(cfg.ConsumerKey, cfg.ConsumerSecret)
token := oauth1.NewToken(cfg.AccessKey, cfg.AccessSecret)
httpClient := ocfg.Client(ctx, token)
twClient := twitter.NewClient(httpClient)
// IPFS Cluster client
peerAddr, err := multiaddr.NewMultiaddr(cfg.ClusterPeerAddr)
if err != nil {
cancel()
return nil, err
}
clusterClient, err := client.NewDefaultClient(&client.Config{
APIAddr: peerAddr,
Username: cfg.ClusterUsername,
Password: cfg.ClusterPassword,
LogLevel: "info",
})
if err != nil {
cancel()
return nil, err
}
bot := &Bot{
ctx: ctx,
cancel: cancel,
twClient: twClient,
clusterClient: clusterClient,
name: cfg.TwitterName,
id: cfg.TwitterID,
die: make(chan struct{}, 1),
}
bot.fetchFollowing()
go bot.watchFollowing()
go bot.watchTweets()
return bot, nil
}
// Kill destroys this bot.
func (b *Bot) Kill() {
b.cancel()
}
// Name returns the twitter handle used by the bot
func (b *Bot) Name() string {
return b.name
}
// ID returns the twitter user ID used by the bot
func (b *Bot) ID() string {
return b.id
}
func (b *Bot) fetchFollowing() {
var nextCursor int64 = -1
includeEntities := false
for nextCursor != 0 {
following, _, err := b.twClient.Friends.List(
&twitter.FriendListParams{
Count: 200,
IncludeUserEntities: &includeEntities,
})
if err != nil {
log.Println(err)
}
for _, u := range following.Users {
_, old := b.follows.LoadOrStore(u.ID, struct{}{})
if !old {
log.Println("Friend: ", u.ScreenName)
}
}
nextCursor = following.NextCursor
time.Sleep(2 * time.Second)
}
}
func (b *Bot) watchFollowing() {
for {
time.Sleep(90 * time.Second)
select {
case <-b.ctx.Done():
default:
b.fetchFollowing()
}
}
}
func (b *Bot) processTweet(tweet *twitter.Tweet, srcTweet *twitter.Tweet) {
if tweet == nil {
return
}
if srcTweet == nil {
srcTweet = tweet
}
// Skip processing our own tweets (written by us)
// and quotes or retweets we've made (origUser is us)
// (avoid potential loops)
if tweet.User.IDStr == b.ID() || srcTweet.User.IDStr == b.ID() {
return
}
action, arguments, urls, err := b.parseTweet(tweet)
if err != nil {
b.tweet(err.Error(), tweet, srcTweet, false)
return
}
log.Printf("Parsed: %s, %s, %s\n", action, arguments, urls)
_, ok := b.follows.Load(srcTweet.User.ID)
if !ok && action.Valid() {
b.tweet("Sorry but I don't follow you yet", tweet, srcTweet, false)
return
}
if !ok {
return
}
// We follow the user. We do stuff.
// Process actions
switch action {
case PinAction:
b.pin(arguments, tweet, srcTweet)
case UnpinAction:
b.unpin(arguments, tweet, srcTweet)
case AddAction:
b.add(arguments, tweet, srcTweet)
case HelpAction:
b.tweetHelp(tweet, srcTweet)
default:
log.Println("no handled action for this tweet")
}
// Add any media urls
if len(urls) > 0 {
log.Println("adding media: ", urls)
out := make(chan *api.AddedOutput, 1)
go func() {
cids := []cid.Cid{}
for added := range out {
log.Printf("added %s\n", added.Cid)
cids = append(cids, added.Cid)
}
if len(cids) > 0 {
b.tweetAdded(cids, tweet, srcTweet)
}
}()
params := api.DefaultAddParams()
params.Wrap = true
params.Name = "Tweet-" + tweet.IDStr
err := b.clusterClient.Add(context.Background(), urls, params, out)
if err != nil {
log.Println(err)
}
}
// If the tweet has retweets, process them as if they were
// from this user.
retweets := []*twitter.Tweet{tweet.QuotedStatus, tweet.RetweetedStatus}
for _, rt := range retweets {
b.processTweet(rt, srcTweet)
}
}
// parseTweet returns Action, arguments, media urls, and error
func (b *Bot) parseTweet(tweet *twitter.Tweet) (Action, string, []string, error) {
// Extended tweet? let's use the entities from the extended tweet then.
if tweet.ExtendedTweet != nil {
tweet.Entities = tweet.ExtendedTweet.Entities
tweet.ExtendedEntities = tweet.ExtendedTweet.ExtendedEntities
tweet.FullText = tweet.ExtendedTweet.FullText
}
text := tweet.FullText
if text == "" {
text = tweet.Text
}
log.Println("Parsing:", text)
// remote our username if they started with it
text = strings.TrimPrefix(text, b.name)
var action Action
var arguments string
if text == " "+string(HelpAction) {
return HelpAction, "", []string{}, nil
}
// match to see if any action
matches := actionRegexp.FindAllStringSubmatch(text, -1)
if len(matches) > 0 {
firstMatch := matches[0]
action = Action(firstMatch[1]) // first group match
arguments = firstMatch[2] // second group match
}
urls := extractMediaURLs(tweet)
return action, arguments, urls, nil
}
func tweetFile(tweet *twitter.Tweet) {
}
// takes *Entities or *MediaEntities
func media(ent interface{}) []twitter.MediaEntity {
if ent == nil {
return nil
}
switch ent.(type) {
case *twitter.Entities:
e := ent.(*twitter.Entities)
if e != nil {
return e.Media
}
case *twitter.ExtendedEntity:
e := ent.(*twitter.ExtendedEntity)
if e != nil {
return e.Media
}
}
return nil
}
func extractMediaURLs(tweet *twitter.Tweet) []string {
var urls []string
// Grab any media entities from the tweet
for _, m := range media(tweet.ExtendedEntities) {
urls = append(urls, extractMediaURL(&m))
}
if len(urls) == 0 {
// If no extended entitites, try with traditional.
for _, m := range media(tweet.Entities) {
urls = append(urls, extractMediaURL(&m))
}
}
return urls
}
type byBitrate []twitter.VideoVariant
func (vv byBitrate) Len() int { return len(vv) }
func (vv byBitrate) Swap(i, j int) { vv[i], vv[j] = vv[j], vv[i] }
func (vv byBitrate) Less(i, j int) bool { return vv[i].Bitrate < vv[j].Bitrate }
func extractMediaURL(me *twitter.MediaEntity) string {
switch me.Type {
case "video", "animated_gif":
variants := me.VideoInfo.Variants
sort.Sort(byBitrate(variants))
// pick video with highest bitrate
last := variants[len(variants)-1]
return last.URL
default:
return me.MediaURL
}
}
func (b *Bot) watchTweets() {
log.Println("watching tweets")
params := &twitter.StreamFilterParams{
Follow: []string{b.id},
Track: []string{
PinAction.String(),
UnpinAction.String(),
HelpAction.String(),
AddAction.String(),
b.Name(),
},
StallWarnings: twitter.Bool(true),
}
stream, err := b.twClient.Streams.Filter(params)
if err != nil {
log.Println(err)
}
demux := twitter.NewSwitchDemux()
demux.Tweet = func(t *twitter.Tweet) {
b.processTweet(t, t)
}
for {
select {
case <-b.ctx.Done():
return
case msg := <-stream.Messages:
//log.Println("handling message", msg)
go demux.Handle(msg)
}
}
}
func (b *Bot) pin(args string, tweet, srcTweet *twitter.Tweet) {
log.Println("pin with ", args)
pinUsage := fmt.Sprintf("Usage: '%s <cid> <name>'", PinAction)
matches := pinRegexp.FindAllStringSubmatch(args, -1)
if len(matches) == 0 {
b.tweet(pinUsage, srcTweet, nil, false)
return
}
firstMatch := matches[0]
cidStr := firstMatch[1]
name := firstMatch[2]
c, err := cid.Decode(cidStr)
if err != nil {
b.tweet(pinUsage+". Make sure your CID is valid.", tweet, srcTweet, false)
return
}
_, err = b.clusterClient.Pin(context.Background(), c, api.PinOptions{Name: name})
if err != nil {
log.Println(err)
b.tweet("An error happened pinning. I will re-start myself. Please retry in a bit.", srcTweet, nil, false)
b.die <- struct{}{}
return
}
waitParams := client.StatusFilterParams{
Cid: c,
Local: false,
Target: api.TrackerStatusPinned,
CheckFreq: 10 * time.Second,
}
ctx, cancel := context.WithTimeout(b.ctx, 10*time.Minute)
defer cancel()
_, err = client.WaitFor(ctx, b.clusterClient, waitParams)
if err != nil {
log.Println(err)
b.tweet("IPFS Cluster has been pinning this for 10 mins. This is normal for big files. Otherwise, make sure there are providers for it. Don't worry, Cluster will keep at it for a week before giving up.", srcTweet, nil, false)
return
}
b.tweet(fmt.Sprintf("Pinned! Check it out at %s/ipfs/%s", IPFSGateway, cidStr), tweet, srcTweet, true)
}
func (b *Bot) unpin(args string, tweet, srcTweet *twitter.Tweet) {
log.Println("unpin with ", args)
unpinUsage := fmt.Sprintf("Usage: '%s <cid>'", UnpinAction)
c, err := cid.Decode(args)
if err != nil {
b.tweet(unpinUsage+". Make sure your CID is valid.", tweet, srcTweet, false)
return
}
_, err = b.clusterClient.Unpin(context.Background(), c)
if err != nil && !strings.Contains(err.Error(), "uncommited to state") {
log.Println(err)
b.tweet("An error happened unpinning. I will re-start myself. Please retry in a bit.", srcTweet, nil, false)
b.die <- struct{}{}
return
}
waitParams := client.StatusFilterParams{
Cid: c,
Local: false,
Target: api.TrackerStatusUnpinned,
CheckFreq: 10 * time.Second,
}
ctx, cancel := context.WithTimeout(b.ctx, time.Minute)
defer cancel()
_, err = client.WaitFor(ctx, b.clusterClient, waitParams)
if err != nil {
log.Println(err)
b.tweet("IPFS Cluster did not manage to unpin the item, but it's trying...", srcTweet, nil, false)
return
}
b.tweet(fmt.Sprintf("Unpinned %s! :'(", args), tweet, srcTweet, false)
}
func (b *Bot) add(arg string, tweet, srcTweet *twitter.Tweet) {
log.Println("add with ", arg)
addUsage := fmt.Sprintf("Usage: '%s <http-or-https-url>'")
url, err := url.Parse(arg)
if err != nil {
b.tweet(addUsage+". Make sure you gave a valid url!", srcTweet, nil, false)
return
}
if url.Scheme != "http" && url.Scheme != "https" {
b.tweet(addUsage+". Not an HTTP(s) url!", srcTweet, nil, false)
return
}
if url.Host == "localhost" || url.Host == "127.0.0.1" || url.Host == "::1" {
b.tweet("ehem ehem...", srcTweet, nil, false)
return
}
out := make(chan *api.AddedOutput, 1)
go func() {
cids := []cid.Cid{}
for added := range out {
cids = append(cids, added.Cid)
}
if len(cids) > 0 {
b.tweetAdded(cids, tweet, srcTweet)
}
}()
params := api.DefaultAddParams()
params.Wrap = true
params.Name = "Tweet-" + tweet.IDStr
err = b.clusterClient.Add(context.Background(), []string{arg}, params, out)
if err != nil {
log.Println(err)
b.tweet("An error happened adding. I will re-start myself. Please retry in a bit.", srcTweet, nil, false)
b.die <- struct{}{}
return
}
}
func (b *Bot) tweetAdded(cids []cid.Cid, tweet, srcTweet *twitter.Tweet) {
msg := "Just added this to #IPFS Cluster!\n\n"
for i, c := range cids {
if i != len(cids)-1 {
msg += fmt.Sprintf("• File: %s/ipfs/%s\n", IPFSGateway, c)
} else { // last
msg += fmt.Sprintf("• Folder-wrap: %s/ipfs/%s\n", IPFSGateway, c)
}
}
b.tweet(msg, tweet, srcTweet, true)
}
func (b *Bot) tweetHelp(tweet, srcTweet *twitter.Tweet) {
help := fmt.Sprintf(`Hi! Here's what I can do:
!pin <cid> <name>
!unpin <cid>
!add <url-to-single-file>
!help
You can always prepend these commands mentioning me (%s).
Happy pinning!
`, b.name)
b.tweet(help, srcTweet, nil, false)
}
// tweets sends a tweet quoting or replying to the given tweets. srcTweet might
// be nil.
// Otherwise it just posts the message.
func (b *Bot) tweet(msg string, inReplyTo, srcTweet *twitter.Tweet, quote bool) {
tweetMsg := ""
params := &twitter.StatusUpdateParams{}
sameTweets := false
if inReplyTo == nil {
tweetMsg = msg
goto TWEET
}
sameTweets = srcTweet == nil || inReplyTo.ID == srcTweet.ID
params.InReplyToStatusID = inReplyTo.ID
switch {
case sameTweets && !quote:
// @user msg (reply thread)
tweetMsg = fmt.Sprintf("@%s %s", inReplyTo.User.ScreenName, msg)
case sameTweets && quote:
// @user msg <permalink> (quote RT)
tweetMsg = fmt.Sprintf(".@%s %s %s",
inReplyTo.User.ScreenName,
msg,
permaLink(inReplyTo),
)
case !sameTweets && !quote:
// @user @srcUser msg (reply thread)
tweetMsg = fmt.Sprintf("@%s @%s %s",
inReplyTo.User.ScreenName,
srcTweet.User.ScreenName,
msg,
)
case !sameTweets && quote:
// @srcuser <replyPermalink> (quote RT mentioning src user)
tweetMsg = fmt.Sprintf(".@%s %s %s",
srcTweet.User.ScreenName,
msg,
permaLink(inReplyTo),
)
}
TWEET:
log.Println("tweeting:", tweetMsg)
newTweet, _, err := b.twClient.Statuses.Update(tweetMsg, params)
if err != nil {
log.Println(err)
return
}
_ = newTweet
// if quote { // then retweet my tweet after a minute
// go func() {
// time.Sleep(time.Minute)
// _, _, err := b.twClient.Statuses.Retweet(newTweet.ID, nil)
// log.Println("retweeted: ", tweetMsg)
// if err != nil {
// log.Println(err)
// return
// }
// }()
// }
return
}
func permaLink(tweet *twitter.Tweet) string {
return fmt.Sprintf("https://%s/%s/status/%s", twittercom, tweet.User.ScreenName, tweet.IDStr)
}
func main() {
path := flag.String("config", ConfigFile, "path to config file")
flag.Parse()
cfg := readConfig(*path)
bot, err := New(cfg)
if err != nil {
log.Fatal(err)
}
log.Println("Bot created:", bot.Name(), bot.ID())
// Wait for SIGINT and SIGTERM (HIT CTRL-C)
ch := make(chan os.Signal)
signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM)
select {
case sig := <-ch:
log.Println(sig)
case <-bot.die:
}
bot.Kill()
}