mwbot 0.7.1

A MediaWiki bot framework
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

// SPDX-FileCopyrightText: 2023 Misato Kano <me@mirror-kt.dev>
// SPDX-License-Identifier: GPL-3.0-or-later
//! Generators related to file usage
//!
//! See the [`FileUsage`] and [`FilesInPage`] type documentation
//! for specifics.

use super::{Generator, ParamValue, SortDirection};

/// Get all pages that use the given files.
///
/// See [API documentation](https://www.mediawiki.org/wiki/API:Fileusage) for more details.
#[derive(Generator)]
#[params(generator = "fileusage", gfulimit = "max")]
pub struct FileUsage {
    #[param("titles")]
    titles: Vec<String>,
    #[param("gfunamespaces")]
    namespaces: Option<Vec<u32>>,
    #[param("gfushow")]
    filter: Option<Filter>,
}

pub enum Filter {
    Redirect,
    NonRedirect,
}

impl ParamValue for Filter {
    fn stringify(&self) -> String {
        match self {
            Self::Redirect => "redirect",
            Self::NonRedirect => "!redirect",
        }
        .to_string()
    }
}

/// Get all embedded media files on provided pages.
///
/// See [API documentation](https://www.mediawiki.org/wiki/API:Images) for more details.
#[derive(Generator)]
#[params(generator = "images", gimlimit = "max")]
pub struct FilesInPage {
    #[param("titles")]
    titles: Vec<String>,
    #[param("gimimages")]
    images: Option<Vec<String>>,
    #[param("gimdir")]
    dir: Option<SortDirection>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::tests::testwp;

    #[tokio::test]
    async fn test_file_usage() {
        let bot = testwp().await;
        let gen = FileUsage::new(vec!["File:A_keyboard.jpg".to_string()]);
        dbg!(gen.params());
        let mut pages = gen.generate(&bot);

        let mut found = Vec::new();

        while let Some(page) = pages.recv().await {
            let page = page.unwrap();
            dbg!(page.title());

            found.push(page.title().to_string());
        }

        assert!(found.contains(&"Mwbot-rs/FileUsage".to_string()));
    }

    #[tokio::test]
    async fn test_files_in_page() {
        let bot = testwp().await;
        let gen = FilesInPage::new(vec!["Mwbot-rs/FileUsage".to_string()]);
        dbg!(gen.params());
        let mut pages = gen.generate(&bot);

        let mut found = Vec::new();

        while let Some(page) = pages.recv().await {
            let page = page.unwrap();
            dbg!(page.title());

            found.push(page.title().to_string());
        }

        assert_eq!(found, ["File:A keyboard.jpg".to_string()]);
    }
}