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
use std::collections::VecDeque;
use std::time::Duration;

use clap::Subcommand;
use futures_util::Stream;
use percent_encoding::{utf8_percent_encode, NON_ALPHANUMERIC};
use reqwest::header::COOKIE;
use reqwest::{Client, StatusCode};
use typed_builder::TypedBuilder;

use crate::error::NitterError;
use crate::parse::{parse_nitter_html, parse_nitter_single};
use crate::tweet::Tweet;

#[derive(TypedBuilder)]
pub struct NitterScraper<'a> {
    client: &'a Client,

    #[builder(setter(into))]
    instance: String,

    query: NitterQuery,

    #[builder(default)]
    limit: Option<usize>,

    #[builder(default)]
    reorder_pinned: bool,

    #[builder(default)]
    skip_retweets: bool,

    #[builder(default)]
    min_id: Option<u128>,

    #[builder(setter(skip), default)]
    state: NitterSearchState,
}

#[derive(Debug, Default)]
struct NitterSearchState {
    tweets: VecDeque<Tweet>,
    cursor: NitterCursor,
    count: usize,
    errored: bool,
    pinned: Option<Tweet>,
}

#[derive(Debug)]
pub enum NitterCursor {
    Initial,
    More(String),
    End,
}

impl Default for NitterCursor {
    fn default() -> Self {
        Self::Initial
    }
}

#[derive(Subcommand)]
pub enum NitterQuery {
    Search { query: String },
    User { user: String },
    UserWithReplies { user: String },
    UserMedia { user: String },
    UserSearch { user: String, query: String },
    Status { id: u64 },
}

impl NitterQuery {
    fn encode_get_params(&self) -> String {
        match self {
            Self::Search { query } => {
                let encoded = utf8_percent_encode(query, NON_ALPHANUMERIC);
                format!("?f=tweets&q={}", encoded)
            }
            Self::User { .. } => "".into(),
            Self::UserWithReplies { .. } => "".into(),
            Self::UserMedia { .. } => "".into(),
            Self::UserSearch { query, .. } => {
                let encoded = utf8_percent_encode(query, NON_ALPHANUMERIC);
                format!("?f=tweets&q={}", encoded)
            }
            Self::Status { .. } => "".into(),
        }
    }

    fn url_path(&self) -> String {
        match self {
            Self::Search { .. } => "/search".into(),
            Self::User { user } => format!("/{}", user),
            Self::UserWithReplies { user } => format!("/{}/with_replies", user),
            Self::UserMedia { user } => format!("/{}/media", user),
            Self::UserSearch { user, .. } => format!("/{}/search", user),
            Self::Status { id } => format!("/i/status/{}", id),
        }
    }

    fn is_single(&self) -> bool {
        matches!(self, Self::Status { .. })
    }
}

enum ReturnedTweet {
    Pinned,
    Normal,
    None,
}

impl<'a> NitterScraper<'a> {
    pub async fn search(&'a mut self) -> impl Stream<Item = Result<Tweet, NitterError>> + '_ {
        // Reset internal state
        self.state = Default::default();

        futures_util::stream::unfold(self, |state| async {
            // Stop if previously errored
            if state.state.errored {
                return None;
            }

            // Stop if limit reached
            if let Some(limit) = state.limit {
                if state.state.count >= limit {
                    return None;
                }
            }

            // Since skip-retweets may cause entire page to be empty, loop until cursor doesn't
            // exist anymore
            loop {
                // Return tweet if available
                if let Some(tweet) = state.state.tweets.iter().next() {
                    match Self::should_return_tweet(
                        tweet,
                        &state.state.pinned,
                        state.min_id,
                        state.reorder_pinned,
                    ) {
                        ReturnedTweet::Normal => {
                            state.state.count += 1;
                            return Some((Ok(state.state.tweets.pop_front().unwrap()), state));
                        }
                        ReturnedTweet::Pinned => {
                            state.state.count += 1;
                            return Some((Ok(state.state.pinned.take().unwrap()), state));
                        }
                        ReturnedTweet::None => break,
                    }
                }

                if let NitterCursor::End = state.state.cursor {
                    break;
                }

                // Scrape nitter
                match state.scrape_page().await {
                    Ok(tweets) => {
                        state.state.tweets.extend(tweets.into_iter());
                    }
                    Err(e) => {
                        state.state.errored = true;
                        return Some((Err(e), state));
                    }
                }
            }

            // Return pinned tweet if needed
            if let Some(t) = state.state.pinned.take() {
                return Some((Ok(t), state));
            }

            None
        })
    }

    fn should_return_tweet(
        tweet: &Tweet,
        pinned: &Option<Tweet>,
        min_id: Option<u128>,
        reorder_pinned: bool,
    ) -> ReturnedTweet {
        if reorder_pinned {
            if let Some(p) = pinned {
                // Should use tweet id here but nitter doesn't expose it for retweets
                if p.created_at_ts > tweet.created_at_ts {
                    return ReturnedTweet::Pinned;
                }
            }
        }

        // Stop if minimum tweet id reached
        if let Some(min_id) = min_id {
            if tweet.id < min_id {
                return ReturnedTweet::None;
            }
        }

        // Return next tweet
        ReturnedTweet::Normal
    }

    async fn scrape_page(&mut self) -> Result<Vec<Tweet>, NitterError> {
        // Use cursor if it exists
        let get_params = match self.state.cursor {
            NitterCursor::Initial => self.query.encode_get_params(),
            NitterCursor::More(ref c) => c.clone(),
            NitterCursor::End => return Ok(vec![]),
        };

        let mut nitter_retry = 0;
        let tweets = loop {
            // Send request
            let url = format!("{}{}{}", self.instance, self.query.url_path(), get_params);
            let mut i = 0;
            let response = loop {
                let response = self
                    .client
                    .get(&url)
                    .header(COOKIE, "replaceTwitter=; replaceYouTube=; replaceReddit=")
                    .send()
                    .await
                    .map_err(|e| NitterError::Network(e.to_string()))?;

                if response.status() == StatusCode::TOO_MANY_REQUESTS {
                    // Retry if 429
                    if i < 25 {
                        i += 1;
                        let sleep_s = 1 << std::cmp::min(i, 8);
                        eprintln!(
                            "Received status code {}, sleeping for {} seconds",
                            response.status().as_u16(),
                            sleep_s
                        );
                        tokio::time::sleep(Duration::from_secs(sleep_s)).await;
                        continue;
                    } else {
                        return Err(NitterError::Network(format!(
                            "received status code {}",
                            response.status().as_u16()
                        )));
                    }
                } else if response.status() == StatusCode::NOT_FOUND {
                    // Return nothing on 404
                    return Err(NitterError::NotFound);
                } else if !response.status().is_success() {
                    // Error if bad status code
                    return Err(NitterError::Network(format!(
                        "received status code {}",
                        response.status().as_u16()
                    )));
                }

                break response;
            };

            let text = response.text().await.unwrap();

            // Parse html and update cursor
            let (tweets, cursor) = if self.query.is_single() {
                let (tweet, cursor) = parse_nitter_single(text)?;
                (vec![tweet], cursor)
            } else {
                parse_nitter_html(text)?
            };

            let tweets = if self.reorder_pinned {
                // Extract pinned tweet
                let (mut pinned, unpinned): (Vec<_>, Vec<_>) =
                    tweets.into_iter().partition(|t| t.pinned);
                if let Some(t) = pinned.pop() {
                    if let Some(min_id) = self.min_id {
                        if t.id >= min_id {
                            self.state.pinned = Some(t);
                        }
                    } else {
                        self.state.pinned = Some(t);
                    }
                }
                unpinned
            } else {
                tweets
            };

            // Sometimes nitter will return nothing, retry a few times to make sure it's correct
            if !tweets.is_empty() || nitter_retry > 10 {
                self.state.cursor = cursor;
                break tweets;
            }

            tokio::time::sleep(Duration::from_secs(1)).await;
            nitter_retry += 1;
        };

        let tweets = if self.skip_retweets {
            // Filter out retweets
            tweets.into_iter().filter(|t| !t.retweet).collect()
        } else {
            tweets
        };

        Ok(tweets)
    }
}