pagesift-html 0.50.0

Fast HTML parser for content extraction: zero-copy arena DOM with the HTML5 tree-building rules that matter for text.
Documentation
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
use crate::Tag;
use crate::dom::{Attr, Data, NONE, Node, Span};
use crate::entity::decode_into;

use super::{Builder, MAX_DEPTH, Ns, Open, Scope, is_ws, marker, table_context, void};

impl<'a> Builder<'a> {
    // ---- 节点操作

    pub(super) fn new_node(&mut self, data: Data) -> u32 {
        let id = self.nodes.len() as u32;
        self.nodes.push(Node::new(data));
        id
    }

    pub(super) fn append(&mut self, parent: u32, child: u32) {
        let last = self.nodes[parent as usize].last_child;
        {
            let c = &mut self.nodes[child as usize];
            c.parent = parent;
            c.prev = last;
        }
        if last == NONE {
            self.nodes[parent as usize].first_child = child;
        } else {
            self.nodes[last as usize].next = child;
        }
        self.nodes[parent as usize].last_child = child;
    }

    pub(super) fn insert_before(&mut self, parent: u32, child: u32, before: u32) {
        let prev = self.nodes[before as usize].prev;
        {
            let c = &mut self.nodes[child as usize];
            c.parent = parent;
            c.prev = prev;
            c.next = before;
        }
        self.nodes[before as usize].prev = child;
        if prev == NONE {
            self.nodes[parent as usize].first_child = child;
        } else {
            self.nodes[prev as usize].next = child;
        }
    }

    /// 插入位置:当前节点;表格上下文里的非表格内容放到最近那个表格的前面。
    pub(super) fn place(&mut self, child: u32, foster: bool) {
        let Some(cur) = self.current() else {
            let parent = if self.html != NONE { self.html } else { 0 };
            self.append(parent, child);
            return;
        };
        if foster && cur.ns == Ns::Html && table_context(cur.tag) {
            self.foster(child, self.stack.len());
        } else {
            self.append(cur.id, child);
        }
    }

    /// Foster parenting:放到栈里 `stack[..below]` 范围内最后一个表格的前面。
    pub(super) fn foster(&mut self, child: u32, below: usize) {
        let Some(i) = self.stack[..below]
            .iter()
            .rposition(|o| o.tag == Tag::Table && o.ns == Ns::Html)
        else {
            let parent = self.stack.first().map_or(0, |o| o.id);
            self.append(parent, child);
            return;
        };
        let table = self.stack[i].id;
        let parent = self.nodes[table as usize].parent;
        if parent != NONE {
            self.insert_before(parent, child, table);
        } else {
            let below = self.stack[i.saturating_sub(1)].id;
            self.append(below, child);
        }
    }

    /// 文本插到 `parent` 的最后(或 `before` 之前),和相邻的文本节点合并。
    pub(super) fn add_text(&mut self, span: Span, foster: bool) {
        // 先确定落点和落点前面的兄弟
        let (parent, before) = match self.current() {
            None => (if self.html != NONE { self.html } else { 0 }, NONE),
            Some(cur) => {
                let fostered = foster
                    && cur.ns == Ns::Html
                    && table_context(cur.tag)
                    && !self.str(span).bytes().all(is_ws);
                match fostered
                    .then(|| {
                        self.stack
                            .iter()
                            .rposition(|o| o.tag == Tag::Table && o.ns == Ns::Html)
                    })
                    .flatten()
                {
                    Some(i) => {
                        let table = self.stack[i].id;
                        let p = self.nodes[table as usize].parent;
                        if p != NONE {
                            (p, table)
                        } else {
                            (self.stack[i.saturating_sub(1)].id, NONE)
                        }
                    }
                    None => (cur.id, NONE),
                }
            }
        };
        let prev = if before == NONE {
            self.nodes[parent as usize].last_child
        } else {
            self.nodes[before as usize].prev
        };
        if prev != NONE
            && let Data::Text(old) = self.nodes[prev as usize].data
        {
            let merged = self.concat(old, span);
            self.nodes[prev as usize].data = Data::Text(merged);
            return;
        }
        let id = self.new_node(Data::Text(span));
        if before == NONE {
            self.append(parent, id);
        } else {
            self.insert_before(parent, id, before);
        }
    }

    pub(super) fn concat(&mut self, a: Span, b: Span) -> Span {
        if !a.is_owned() && !b.is_owned() && a.end() == b.offset() {
            return Span::source(a.offset(), b.end());
        }
        let start = if a.is_owned() && a.end() == self.buf.len() {
            a.offset()
        } else {
            let s = self.str(a).to_string();
            let start = self.buf.len();
            self.buf.push_str(&s);
            start
        };
        let s = self.str(b).to_string();
        self.buf.push_str(&s);
        Span::owned(start, self.buf.len())
    }

    /// 名字小写化:源里已经是小写就直接引用,否则写进缓冲区。
    pub(super) fn lower_span(&mut self, (s, e): (usize, usize)) -> Span {
        let raw = &self.src[s..e];
        if !raw.bytes().any(|c| c.is_ascii_uppercase()) {
            return Span::source(s, e);
        }
        let start = self.buf.len();
        for c in raw.chars() {
            self.buf.push(c.to_ascii_lowercase());
        }
        Span::owned(start, self.buf.len())
    }

    pub(super) fn value_span(&mut self, (s, e): (usize, usize)) -> Span {
        let raw = &self.src[s..e];
        if memchr::memchr(b'&', raw.as_bytes()).is_none() {
            return Span::source(s, e);
        }
        let start = self.buf.len();
        decode_into(&mut self.buf, raw, true);
        Span::owned(start, self.buf.len())
    }

    /// 把分词器暂存的属性写进属性表,同名的只留第一个。
    pub(super) fn take_attrs(&mut self) -> (u32, u32) {
        let start = self.attrs.len() as u32;
        let scratch = std::mem::take(&mut self.scratch);
        for &(n, v) in &scratch {
            let name = self.lower_span(n);
            let dup = self.attrs[start as usize..]
                .iter()
                .any(|a| self.str(a.name) == self.str(name));
            if dup {
                continue;
            }
            let value = self.value_span(v);
            self.attrs.push(Attr { name, value });
        }
        self.scratch = scratch;
        (start, self.attrs.len() as u32 - start)
    }

    pub(super) fn create(&mut self, tag: Tag, name: (usize, usize)) -> u32 {
        let name = if tag == Tag::Other {
            self.lower_span(name)
        } else {
            Span::default()
        };
        let (attrs, attrs_len) = self.take_attrs();
        self.new_node(Data::Element {
            tag,
            name,
            attrs,
            attrs_len,
        })
    }

    /// 创建元素、放进树里,需要时入栈。
    pub(super) fn insert(
        &mut self,
        tag: Tag,
        name: (usize, usize),
        ns: Ns,
        push: bool,
        foster: bool,
    ) -> u32 {
        let id = self.create(tag, name);
        self.place(id, foster);
        if push && self.stack.len() < MAX_DEPTH {
            self.stack.push(Open { id, tag, ns });
            if ns == Ns::Html && marker(tag) {
                self.afe.push(NONE);
            }
        }
        id
    }

    pub(super) fn insert_html(&mut self, tag: Tag, name: (usize, usize)) {
        let push = !void(tag);
        let foster = !matches!(
            tag,
            Tag::Script | Tag::Style | Tag::Template | Tag::Form | Tag::Input
        );
        self.insert(tag, name, Ns::Html, push, foster);
    }

    /// 重复出现的 `<html>`、`<body>`:把还没有的属性补到已有元素上。
    pub(super) fn merge_attrs(&mut self, target: u32) {
        if target == NONE {
            return;
        }
        let Data::Element {
            tag,
            name,
            attrs,
            attrs_len,
        } = self.nodes[target as usize].data
        else {
            return;
        };
        let (new_start, new_len) = self.take_attrs();
        if new_len == 0 {
            return;
        }
        let old: Vec<Attr> = self.attrs[attrs as usize..(attrs + attrs_len) as usize].to_vec();
        let added: Vec<Attr> = self.attrs[new_start as usize..]
            .iter()
            .copied()
            .filter(|a| !old.iter().any(|o| self.str(o.name) == self.str(a.name)))
            .collect();
        self.attrs.truncate(new_start as usize);
        if added.is_empty() {
            return;
        }
        let start = self.attrs.len() as u32;
        self.attrs.extend(old);
        self.attrs.extend(added);
        self.nodes[target as usize].data = Data::Element {
            tag,
            name,
            attrs: start,
            attrs_len: self.attrs.len() as u32 - start,
        };
    }

    // ---- 栈操作

    pub(super) fn in_scope(&self, target: Tag, scope: Scope) -> Option<usize> {
        self.find_in_scope(|t| t == target, scope)
    }

    pub(super) fn find_in_scope(&self, pred: impl Fn(Tag) -> bool, scope: Scope) -> Option<usize> {
        for (i, &o) in self.stack.iter().enumerate().rev() {
            if o.ns == Ns::Html && pred(o.tag) {
                return Some(i);
            }
            if self.boundary(o, scope) {
                return None;
            }
        }
        None
    }

    pub(super) fn boundary(&self, o: Open, scope: Scope) -> bool {
        use Tag::*;
        match o.ns {
            Ns::Integration => true,
            Ns::Foreign => false,
            Ns::Html => match scope {
                Scope::Table => matches!(o.tag, Html | Table | Template),
                _ => {
                    matches!(
                        o.tag,
                        Applet | Caption | Html | Table | Td | Th | Marquee | Object | Template
                    ) || (scope == Scope::ListItem && matches!(o.tag, Ol | Ul))
                        || (scope == Scope::Button && o.tag == Button)
                }
            },
        }
    }

    pub(super) fn pop_to(&mut self, i: usize) {
        for k in i..self.stack.len() {
            let o = self.stack[k];
            if o.ns == Ns::Html && marker(o.tag) {
                while let Some(e) = self.afe.pop() {
                    if e == NONE {
                        break;
                    }
                }
            }
        }
        self.stack.truncate(i);
    }

    pub(super) fn pop(&mut self) {
        if let Some(n) = self.stack.len().checked_sub(1) {
            self.pop_to(n);
        }
    }

    pub(super) fn on_stack(&self, id: u32) -> Option<usize> {
        self.stack.iter().rposition(|o| o.id == id)
    }

    pub(super) fn node_tag(&self, id: u32) -> Tag {
        match self.nodes[id as usize].data {
            Data::Element { tag, .. } => tag,
            _ => Tag::Other,
        }
    }

    pub(super) fn clone_element(&mut self, id: u32) -> u32 {
        let data = self.nodes[id as usize].data;
        self.new_node(data)
    }

    pub(super) fn detach(&mut self, id: u32) {
        let Node {
            parent, prev, next, ..
        } = self.nodes[id as usize];
        if parent == NONE {
            return;
        }
        if prev == NONE {
            self.nodes[parent as usize].first_child = next;
        } else {
            self.nodes[prev as usize].next = next;
        }
        if next == NONE {
            self.nodes[parent as usize].last_child = prev;
        } else {
            self.nodes[next as usize].prev = prev;
        }
        let n = &mut self.nodes[id as usize];
        n.parent = NONE;
        n.prev = NONE;
        n.next = NONE;
    }

    pub(super) fn move_children(&mut self, from: u32, to: u32) {
        let mut c = self.nodes[from as usize].first_child;
        while c != NONE {
            let next = self.nodes[c as usize].next;
            self.detach(c);
            self.append(to, c);
            c = next;
        }
    }

    /// 两个元素标签、名字和属性都相同(Noah's Ark 规则用)。
    pub(super) fn same_element(&self, a: u32, b: u32) -> bool {
        let (
            Data::Element {
                tag: ta,
                name: na,
                attrs: aa,
                attrs_len: la,
            },
            Data::Element {
                tag: tb,
                name: nb,
                attrs: ab,
                attrs_len: lb,
            },
        ) = (self.nodes[a as usize].data, self.nodes[b as usize].data)
        else {
            return false;
        };
        if ta != tb || la != lb || self.str(na) != self.str(nb) {
            return false;
        }
        let xs = &self.attrs[aa as usize..(aa + la) as usize];
        let ys = &self.attrs[ab as usize..(ab + lb) as usize];
        xs.iter().all(|x| {
            ys.iter().any(|y| {
                self.str(x.name) == self.str(y.name) && self.str(x.value) == self.str(y.value)
            })
        })
    }
}