-
Notifications
You must be signed in to change notification settings - Fork 29
/
shared.ts
656 lines (610 loc) · 18.6 KB
/
shared.ts
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
656
import { BlockCounter } from './models/block_counter';
import { BlockQueue } from './models/block_queue';
import { QueueConsumer } from './models/queue_consumer';
import {
api,
DefaultOptions,
logstr,
Headers,
ReasonBlueVerified,
ReasonNftAvatar,
ReasonBusinessVerified,
ReasonMap,
SoupcanExtensionId,
ErrorEvent,
EventKey,
MessageEvent,
ReasonTransphobia,
ReasonPromoted,
HistoryStateGone,
} from './constants';
import {
commafy,
AddUserBlockHistory,
EscapeHtml,
FormatLegacyName,
IsUserLegacyVerified,
MakeToast,
RemoveUserBlockHistory,
} from './utilities';
// TODO: tbh this file shouldn't even exist anymore and should be
// split between content/startup.ts and utilities.ts
// Define constants that shouldn't be exported to the rest of the addon
const queue = new BlockQueue(api.storage.local);
const blockCounter = new BlockCounter(api.storage.local);
const blockCache: Set<string> = new Set();
export const UnblockCache: Set<string> = new Set();
export function SetHeaders(headers: { [k: string]: string }) {
api.storage.local.get({ headers: {} }).then((items) => {
// so basically we want to only update items that have values
for (const [header, value] of Object.entries(headers)) {
items.headers[header.toLowerCase()] = value;
}
api.storage.local.set(items);
});
}
setInterval(blockCache.clear, 10 * 60e3); // clear the cache every 10 minutes
// this is just here so we don't double add users unnecessarily (and also overwrite name)
setInterval(UnblockCache.clear, 10 * 60e3);
function unblockUser(
user: { name: string; screen_name: string },
user_id: string,
reason: number,
attempt: number = 1,
) {
UnblockCache.add(user_id);
api.storage.sync.get({ unblocked: {} }).then((items) => {
items.unblocked[String(user_id)] = user.screen_name;
api.storage.sync.set(items);
});
const match = window.location.href.match(/^https?:\/\/(?:\w+\.)?twitter.com(?=$|\/)/);
if (!match) {
throw new Error('unexpected or incorrectly formatted url');
}
const root: string = match[0];
let url: string = '';
if (root.includes('tweetdeck')) {
url = 'https://api.twitter.com/1.1/';
} else {
url = `${root}/i/api/1.1/`;
}
api.storage.sync.get(DefaultOptions).then((_config) => {
const config = _config as Config;
if (config.mute) {
url += 'mutes/users/destroy.json';
} else {
url += 'blocks/destroy.json';
}
api.storage.local
.get({ headers: null })
.then((items) => items.headers as { [k: string]: string })
.then((req_headers: { [k: string]: string }) => {
const body = `user_id=${user_id}`;
const headers: { [k: string]: string } = {
'content-length': body.length.toString(),
'content-type': 'application/x-www-form-urlencoded',
};
for (const header of Headers) {
if (req_headers[header]) {
headers[header] = req_headers[header];
}
}
// attempt to manually set the csrf token to the current active cookie
const csrf = CsrfTokenRegex.exec(document.cookie);
if (csrf) {
headers['x-csrf-token'] = csrf[1];
} else {
// default to the request's csrf token
headers['x-csrf-token'] = req_headers['x-csrf-token'];
}
const options: {
body: string;
headers: { [k: string]: string };
method: string;
credentials: RequestCredentials;
} = {
body,
headers,
method: 'POST',
credentials: 'include',
};
fetch(url, options)
.then((response) => {
if (response.status === 403) {
// user has been logged out, we need to stop queue and re-add
MakeToast(
`could not un${config.mute ? 'mute' : 'block'} @${
user.screen_name
}, you may have been logged out.`,
config,
);
console.log(
logstr,
`user is logged out, failed to un${
config.mute ? 'mute' : 'block'
} user.`,
);
} else if (response.status === 404) {
// notice the wording here is different than the blocked 404. the difference is that if the user
// is unbanned, they will still be blocked and we want the user to know about that
MakeToast(
`could not un${config.mute ? 'mute' : 'block'} @${
user.screen_name
}, user has been suspended or no longer exists.`,
config,
);
console.log(
logstr,
`failed to un${config.mute ? 'mute' : 'block'} ${FormatLegacyName(
user,
)}, user no longer exists`,
);
} else if (response.status >= 300) {
MakeToast(
`could not un${config.mute ? 'mute' : 'block'} @${
user.screen_name
}, twitter gave an unfamiliar response code.`,
config,
);
console.error(
logstr,
`failed to un${config.mute ? 'mute' : 'block'} ${FormatLegacyName(
user,
)}:`,
user,
response,
);
} else {
RemoveUserBlockHistory(user_id).catch((e) => console.error(logstr, e));
console.log(
logstr,
`un${config.mute ? 'mut' : 'block'}ed ${FormatLegacyName(user)}`,
);
MakeToast(
`un${config.mute ? 'mut' : 'block'}ed @${
user.screen_name
}, they won't be ${config.mute ? 'mut' : 'block'}ed again.`,
config,
);
}
})
.catch((error) => {
if (attempt < 3) {
unblockUser(user, user_id, reason, attempt + 1);
} else {
console.error(
logstr,
`failed to un${config.mute ? 'mute' : 'block'} ${FormatLegacyName(
user,
)}:`,
user,
error,
);
}
});
});
});
}
const UserBlockedEvent = 'UserBlockedEvent';
const UserLogoutEvent = 'UserLogoutEvent';
api.storage.local.onChanged.addListener((items) => {
// we're using local storage as a really dirty event driver
// TODO: replace this with chrome.tabs.sendmessage at some point. (requires adding tabs permission)
if (!items.hasOwnProperty(EventKey)) {
return;
}
const e = items[EventKey].newValue;
console.debug(logstr, 'received multi-tab event:', e);
api.storage.sync.get(DefaultOptions).then((options) => {
const config = options as Config;
switch (e.type) {
case MessageEvent:
if (config.showBlockPopups) {
MakeToast(e.message, config);
}
break;
case UserBlockedEvent:
if (config.showBlockPopups) {
const event = e as BlockUser;
const { user, user_id, reason } = event;
const name =
user.name.length > 25
? user.name.substring(0, 23).trim() + '...'
: user.name;
const b = document.createElement('button');
b.innerText = 'undo';
b.onclick = () => {
unblockUser(user, user_id, reason);
const parent = b.parentNode as ParentNode;
parent.removeChild(b);
};
const screen_name = EscapeHtml(user.screen_name); // this shouldn't really do anything, but can't be too careful
MakeToast(
`${config.mute ? 'mut' : 'block'}ed ${EscapeHtml(
name,
)} (<a href="/${screen_name}">@${screen_name}</a>)`,
config,
{ html: true, elements: [b] },
);
}
break;
case UserLogoutEvent:
if (config.showBlockPopups) {
MakeToast(
`You have been logged out, and ${
config.mute ? 'mut' : 'block'
}ing has been paused.`,
config,
{
warn: true,
},
);
}
break;
case ErrorEvent:
// skip checking options, since errors should always be shown
if (e.message) {
console.error(logstr, e.message, e);
}
MakeToast(
`<p>an error occurred! check the console and create an issue on <a href="https://github.com/kheina-com/Blue-Blocker/issues" target="_blank">GitHub</a></p>`,
config,
{ html: true, error: true },
);
break;
default:
console.error(logstr, 'unknown multitab event occurred:', e);
}
});
});
function queueBlockUser(user: BlueBlockerUser, user_id: string, reason: number) {
if (blockCache.has(user_id)) {
return;
}
blockCache.add(user_id);
queue.push({
user_id,
reason,
user: { name: user.legacy.name, screen_name: user.legacy.screen_name },
});
api.storage.sync.get(DefaultOptions).then((_config) => {
const config = _config as Config;
console.log(
logstr,
`queued ${FormatLegacyName(user.legacy)} for a ${
config.mute ? 'mute' : 'block'
} due to ${ReasonMap[reason]}.`,
);
});
consumer.start();
}
function checkBlockQueue(): Promise<void> {
return new Promise<void>((resolve) => {
queue
.shift()
.then((_item) => {
const item = _item as BlockUser;
if (item === undefined) {
consumer.stop();
return;
}
const { user, user_id, reason } = item;
// required for users enqueued before 0.3.0
if (user.hasOwnProperty('legacy')) {
// @ts-ignore
for (const [key, value] of Object.entries(user.legacy)) {
// @ts-ignore
user[key] = value;
}
}
blockUser(user, user_id, reason);
resolve();
})
.catch((error) => {
console.error(
logstr,
'unexpected error occurred while processing block queue',
error,
);
api.storage.local.set({
[EventKey]: {
type: ErrorEvent,
message: 'unexpected error occurred while processing block queue',
detail: { error, event: null },
},
});
resolve();
});
});
}
const consumer = new QueueConsumer(api.storage.local, checkBlockQueue, async () => {
const items = await api.storage.sync.get({ blockInterval: DefaultOptions.blockInterval });
return items.blockInterval * 1000;
});
consumer.start();
const CsrfTokenRegex = /ct0=\s*(\w+);/;
function blockUser(
user: { name: string; screen_name: string },
user_id: string,
reason: number,
attempt = 1,
) {
const match = window.location.href.match(/^https?:\/\/(?:\w+\.)?twitter.com(?=$|\/)/);
if (!match) {
throw new Error('unexpected or incorrectly formatted url');
}
const root: string = match[0];
let url: string = '';
if (root.includes('tweetdeck')) {
url = 'https://api.twitter.com/1.1/';
} else {
url = `${root}/i/api/1.1/`;
}
api.storage.sync.get(DefaultOptions).then((_config) => {
const config = _config as Config;
if (config.mute) {
url += 'mutes/users/create.json';
} else {
url += 'blocks/create.json';
}
api.storage.local
.get({ headers: null })
.then((items) => items.headers as { [k: string]: string })
.then((req_headers: { [k: string]: string }) => {
const body = `user_id=${user_id}`;
const headers: { [k: string]: string } = {
'content-length': body.length.toString(),
'content-type': 'application/x-www-form-urlencoded',
};
for (const header of Headers) {
if (req_headers[header]) {
headers[header] = req_headers[header];
}
}
// attempt to manually set the csrf token to the current active cookie
const csrf = CsrfTokenRegex.exec(document.cookie);
if (csrf) {
headers['x-csrf-token'] = csrf[1];
} else {
// default to the request's csrf token
headers['x-csrf-token'] = req_headers['x-csrf-token'];
}
const options: {
body: string;
headers: { [k: string]: string };
method: string;
credentials: RequestCredentials;
} = {
body,
headers,
method: 'POST',
credentials: 'include',
};
fetch(url, options)
.then((response) => {
console.debug(
logstr,
`${config.mute ? 'mute' : 'block'} response:`,
response,
);
if (response.status === 403 || response.status === 401) {
// user has been logged out, we need to stop queue and re-add
consumer.stop();
queue.push({ user, user_id, reason });
api.storage.local.set({ [EventKey]: { type: UserLogoutEvent } });
console.log(
logstr,
'user is logged out, queue consumer has been halted.',
);
} else if (response.status === 404) {
AddUserBlockHistory({ user_id, user, reason }, HistoryStateGone).catch(
(e) => console.error(logstr, e),
);
console.log(
logstr,
`could not ${config.mute ? 'mute' : 'block'} ${FormatLegacyName(
user,
)}, user no longer exists`,
);
} else if (response.status >= 300) {
consumer.stop();
queue.push({ user, user_id, reason });
console.error(
logstr,
`failed to ${config.mute ? 'mute' : 'block'} ${FormatLegacyName(
user,
)}, consumer stopped just in case.`,
response,
);
} else {
blockCounter.increment();
AddUserBlockHistory({ user_id, user, reason }).catch((e) =>
console.error(logstr, e),
);
console.log(
logstr,
`${config.mute ? 'mut' : 'block'}ed ${FormatLegacyName(
user,
)} due to ${ReasonMap[reason]}.`,
);
api.storage.local.set({
[EventKey]: { type: UserBlockedEvent, user, user_id, reason },
});
}
})
.catch((error) => {
if (attempt < 3) {
blockUser(user, user_id, reason, attempt + 1);
} else {
queue.push({ user, user_id, reason });
console.error(
logstr,
`failed to ${config.mute ? 'mute' : 'block'} ${FormatLegacyName(
user,
)}:`,
user,
error,
);
}
});
});
});
}
const blockableAffiliateLabels: Set<string> = new Set([]);
const blockableVerifiedTypes: Set<string> = new Set(['Business']);
export async function BlockBlueVerified(user: BlueBlockerUser, config: Config) {
// We're not currently adding anything to the queue so give up.
if (config.suspendedBlockCollection) {
return;
}
try {
if (
user?.rest_id === undefined ||
user?.legacy?.name === undefined ||
user?.legacy?.screen_name === undefined
) {
throw new Error('invalid user object passed to BlockBlueVerified');
}
const formattedUserName = FormatLegacyName(user.legacy);
const hasBlockableVerifiedTypes = blockableVerifiedTypes.has(
user.legacy?.verified_type || '',
);
const hasBlockableAffiliateLabels = blockableAffiliateLabels.has(
user.affiliates_highlighted_label?.label?.userLabelType || '',
);
// since we can be fairly certain all user objects will be the same, break this into a separate function
if (user.legacy?.verified_type && !blockableVerifiedTypes.has(user.legacy.verified_type)) {
return;
}
if (user.legacy?.blocking || (config.mute && user.legacy?.muting)) {
return;
}
// some unified logic so it's not copied in a bunch of places. log everything as debug because it'll be noisy
if (
// group for if the user has unblocked them previously
// you cannot store sets in sync memory, so this will be a janky object
config.unblocked.hasOwnProperty(String(user.rest_id))
) {
console.debug(
logstr,
`skipped user ${formattedUserName} because you un${
config.mute ? 'mut' : 'block'
}ed them previously.`,
);
return;
} else if (
// group for block-following option
!config.blockFollowing &&
(user.legacy?.following || user.super_following)
) {
console.debug(logstr, `skipped user ${formattedUserName} because you follow them.`);
return;
} else if (
// group for block-followers option
!config.blockFollowers &&
user.legacy?.followed_by
) {
console.debug(logstr, `skipped user ${formattedUserName} because they follow you.`);
return;
}
const legacyDbRejectMessage =
'could not access the legacy verified database, skip legacy has been disabled.';
// step 1: is user verified
if (user.is_blue_verified || hasBlockableVerifiedTypes || hasBlockableAffiliateLabels) {
if (
// group for skip-verified option
config.skipVerified &&
(await new Promise((resolve, reject) => {
// basically, we're wrapping a promise around a promise to set a timeout on it
// in case the user's device was unable to set up the legacy db
function disableSkipLegacy() {
api.storage.sync.set({ skipVerified: false });
reject(legacyDbRejectMessage);
}
const timeout = setTimeout(disableSkipLegacy, 1000); // 1 second. indexed db is crazy fast (<10ms), this should be plenty
IsUserLegacyVerified(user.rest_id, user.legacy.screen_name)
.then(resolve)
.catch(disableSkipLegacy)
.finally(() => clearTimeout(timeout));
}))
) {
console.log(
logstr,
`did not ${
config.mute ? 'mute' : 'block'
} Twitter Blue verified user ${formattedUserName} because they are legacy verified.`,
);
} else if (
// verified via an affiliated organization instead of blue
config.skipAffiliated &&
(hasBlockableAffiliateLabels || hasBlockableVerifiedTypes)
) {
console.log(
logstr,
`did not ${
config.mute ? 'mute' : 'block'
} Twitter Blue verified user ${formattedUserName} because they are verified through an affiliated organization.`,
);
} else if (
// verified by follower count
config.skip1Mplus &&
user.legacy?.followers_count > config.skipFollowerCount
) {
console.log(
logstr,
`did not ${
config.mute ? 'mute' : 'block'
} Twitter Blue verified user ${formattedUserName} because they have over ${commafy(
config.skipFollowerCount,
)} followers and Elon is an idiot.`,
);
} else {
let reason = ReasonBlueVerified;
if (hasBlockableVerifiedTypes) {
reason = ReasonBusinessVerified;
}
queueBlockUser(user, String(user.rest_id), reason);
return;
}
}
// step 2: is user an nft bro
if (
config.blockNftAvatars &&
(user.has_nft_avatar || user.profile_image_shape === 'Hexagon')
) {
queueBlockUser(user, String(user.rest_id), ReasonNftAvatar);
return;
}
// step 3: promoted tweets
if (config.blockPromoted && user.promoted_tweet) {
queueBlockUser(user, String(user.rest_id), ReasonPromoted);
return;
}
} catch (e) {
console.error(logstr, e);
}
// external integrations always come last and have their own error handling
if (config.soupcanIntegration) {
// fire an event here to soupcan and check for transphobia
try {
const response = await api.runtime.sendMessage(SoupcanExtensionId, {
action: 'check_twitter_user',
screen_name: user.legacy.screen_name,
});
console.debug(logstr, `soupcan response for @${user.legacy.screen_name}:`, response);
if (response?.status === 'transphobic') {
queueBlockUser(user, String(user.rest_id), ReasonTransphobia);
return;
}
} catch (_e) {
const e = _e as Error;
console.debug(logstr, `soupcan error for @${user.legacy.screen_name}:`, e);
if (e.message === 'Could not establish connection. Receiving end does not exist.') {
api.storage.sync.set({ soupcanIntegration: false });
console.log(logstr, 'looks like soupcan was uninstalled, disabling integration.');
} else {
console.error(logstr, 'an unknown error occurred while messaging soupcan:', e);
}
}
}
}