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

/*
Copyright (C) 2021 Kunal Mehta <legoktm@debian.org>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

//! A MediaWiki API client library.
//!
//! `mwapi` is a low-level library for the [MediaWiki Action API](https://www.mediawiki.org/wiki/API:Main_page).
//! If you intend to edit pages or want a higher-level interface, it's recommended to use [`mwbot`](https://docs.rs/mwbot/),
//! which builds on top of this crate.
//!
//! ## Goals
//! * generic to fit any application, whether for interactive usage
//!   or writing a bot
//! * fully compatible with concurrent use cases
//! * turns MediaWiki errors into Rust errors for you
//! * logging (using the `tracing` crate) for visiblity into errors
//! * follow all [best practices](https://www.mediawiki.org/wiki/API:Etiquette)
//!
//! ## Quick start
//! ```
//! # #[tokio::main]
//! # async fn main() -> mwapi::Result<()> {
//! let client = mwapi::Client::builder("https://en.wikipedia.org/w/api.php")
//!     .set_user_agent("mwapi demo")
//!     // Provide credentials for login:
//!     // .set_botpassword("username", "password")
//!     .build().await?;
//! let resp = client.get_value(&[
//!     ("action", "query"),
//!     ("prop", "info"),
//!     ("titles", "Taylor Swift"),
//! ]).await?;
//! let info = resp["query"]["pages"][0].clone();
//! assert_eq!(info["ns"].as_u64().unwrap(), 0);
//! assert_eq!(info["title"].as_str().unwrap(), "Taylor Swift");
//! # Ok(())
//! # }
//!
//! ```
//!
//! ## Functionality
//! * authentication, using [OAuth2](https://www.mediawiki.org/wiki/OAuth/Owner-only_consumers#OAuth_2) (recommended) or BotPasswords
//! * error handling, transforming MediaWiki errors into Rust ones
//! * CSRF [token](https://www.mediawiki.org/wiki/API:Tokens) handling with `post_with_token`
//! * rate limiting and concurrency controls
//! * file uploads (needs `upload` feature)
//!
//! ## See also
//! * [`mwbot`](https://docs.rs/mwbot/) provides a higher level interface to
//!   interacting with MediaWiki
//! * [`mwapi_responses`](https://docs.rs/mwapi_responses/) is a macro to
//!   generate strict types for dynamic API queries
//!
//! ## Contributing
//! `mwapi` is a part of the [`mwbot-rs` project](https://www.mediawiki.org/wiki/Mwbot-rs).
//! We're always looking for new contributors, please [reach out](https://www.mediawiki.org/wiki/Mwbot-rs#Contributing)
//! if you're interested!
#![deny(clippy::all)]
#![deny(rustdoc::all)]
#![cfg_attr(docs, feature(doc_cfg))]

mod client;
mod error;
mod params;
mod responses;
mod time;
mod tokens;
#[cfg(feature = "upload")]
mod upload;

const VERSION: &str = env!("CARGO_PKG_VERSION");

pub use client::{Builder, Client};
pub use error::{ApiError, Error};
pub use params::Params;
use std::fmt::{Display, Formatter};

pub type Result<T> = std::result::Result<T, Error>;

/// Assert that your account has the specified login state, see
/// [API:Assert](https://www.mediawiki.org/wiki/API:Assert) for more details.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum Assert {
    /// Not logged in, aka anonymous
    Anonymous,
    /// Logged in to a bot account
    Bot,
    /// Logged in (to any account)
    User,
    /// Do not add any assert
    None,
}

impl Assert {
    fn value(&self) -> Option<&'static str> {
        match self {
            Assert::Anonymous => Some("anon"),
            Assert::Bot => Some("bot"),
            Assert::User => Some("user"),
            Assert::None => None,
        }
    }
}

impl Default for Assert {
    fn default() -> Self {
        Self::None
    }
}

#[derive(Clone, Copy, Debug)]
pub enum ErrorFormat {
    Html,
    Wikitext,
    Plaintext,
}

impl Display for ErrorFormat {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let val = match &self {
            ErrorFormat::Html => "html",
            ErrorFormat::Wikitext => "wikitext",
            ErrorFormat::Plaintext => "plaintext",
        };
        write!(f, "{val}")
    }
}

impl Default for ErrorFormat {
    fn default() -> Self {
        Self::Plaintext
    }
}

#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub(crate) enum Method {
    Get,
    Post,
}