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
//!
//! An aria2 websocket jsonrpc in Rust.
//!
//! [aria2 RPC docs](https://aria2.github.io/manual/en/html/aria2c.html#methods)
//!
//! ## Features
//!
//! - Almost all methods and structed responses
//! - Auto reconnect
//! - Ensures `on_complete` and `on_error` hook to be executed even after reconnected.
//! - Supports notifications
//!
//! ## Example
//!
//! ```no_run
//! use std::sync::Arc;
//!
//! use aria2_ws::{Client, TaskHooks, TaskOptions};
//! use futures::FutureExt;
//! use serde_json::json;
//! use tokio::{spawn, sync::Semaphore};
//!
//! #[tokio::main]
//! async fn main() {
//! let client = Client::connect("ws://127.0.0.1:6800/jsonrpc", None)
//! .await
//! .unwrap();
//! let options = TaskOptions {
//! split: Some(2),
//! header: Some(vec!["Referer: https://www.pixiv.net/".to_string()]),
//! all_proxy: Some("http://127.0.0.1:10809".to_string()),
//! // Add extra options which are not included in TaskOptions.
//! extra_options: json!({"max-download-limit": "200K"})
//! .as_object()
//! .unwrap()
//! .clone(),
//! ..Default::default()
//! };
//!
//! // use `tokio::sync::Semaphore` to wait for all tasks to finish.
//! let semaphore = Arc::new(Semaphore::new(0));
//! client
//! .add_uri(
//! vec![
//! "https://i.pximg.net/img-original/img/2020/05/15/06/56/03/81572512_p0.png"
//! .to_string(),
//! ],
//! Some(options.clone()),
//! None,
//! Some(TaskHooks {
//! on_complete: Some({
//! let s = semaphore.clone();
//! async move {
//! s.add_permits(1);
//! println!("Task 1 completed!");
//! }
//! .boxed()
//! }),
//! on_error: Some({
//! let s = semaphore.clone();
//! async move {
//! s.add_permits(1);
//! println!("Task 1 error!");
//! }
//! .boxed()
//! }),
//! }),
//! )
//! .await
//! .unwrap();
//!
//! // Will 404
//! client
//! .add_uri(
//! vec![
//! "https://i.pximg.net/img-original/img/2022/01/05/23/32/16/95326322_p0.pngxxxx"
//! .to_string(),
//! ],
//! Some(options.clone()),
//! None,
//! Some(TaskHooks {
//! on_complete: Some({
//! let s = semaphore.clone();
//! async move {
//! s.add_permits(1);
//! println!("Task 2 completed!");
//! }
//! .boxed()
//! }),
//! on_error: Some({
//! let s = semaphore.clone();
//! async move {
//! s.add_permits(1);
//! println!("Task 2 error!");
//! }
//! .boxed()
//! }),
//! }),
//! )
//! .await
//! .unwrap();
//!
//! let mut not = client.subscribe_notifications();
//!
//! spawn(async move {
//! while let Ok(msg) = not.recv().await {
//! println!("Received notification {:?}", &msg);
//! }
//! });
//!
//! // Wait for 2 tasks to finish.
//! let _ = semaphore.acquire_many(2).await.unwrap();
//!
//! client.shutdown().await.unwrap();
//! }
//!
//! ```
mod client;
mod error;
mod method;
pub mod response;
mod utils;
pub use error::Error;
use std::collections::{HashMap, HashSet};
use std::sync::atomic::AtomicU64;
use std::sync::{Arc, Mutex};
use std::time::Duration;
use futures::future::BoxFuture;
use response::Event;
use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};
use tokio::sync::{broadcast, Notify};
use tokio::sync::{mpsc, oneshot};
use tokio_tungstenite::tungstenite::Message;
use utils::serde_option_from_str;
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct RpcRequest {
pub id: Option<u64>,
pub jsonrpc: String,
pub method: String,
#[serde(default)]
pub params: Vec<Value>,
}
/// Error returned by RPC calls.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Aria2Error {
pub code: i32,
pub message: String,
}
impl std::fmt::Display for Aria2Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"aria2 responsed error: code {}: {}",
self.code, self.message
)
}
}
impl std::error::Error for Aria2Error {}
#[derive(Deserialize, Debug, Clone)]
pub struct RpcResponse {
pub id: Option<u64>,
pub jsonrpc: String,
pub result: Option<Value>,
pub error: Option<Aria2Error>,
}
/// Regular options of aria2 download tasks.
///
/// For more options, add them to `extra_options` field, which is Object in `serde_json`.
///
/// You can find all options in <https://aria2.github.io/manual/en/html/aria2c.html#input-file>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub struct TaskOptions {
#[serde(skip_serializing_if = "Option::is_none")]
pub header: Option<Vec<String>>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub split: Option<i32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub all_proxy: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub dir: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub out: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub gid: Option<String>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub r#continue: Option<bool>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub auto_file_renaming: Option<bool>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub check_integrity: Option<bool>,
/// Close connection if download speed is lower than or equal to this value(bytes per sec).
///
/// 0 means aria2 does not have a lowest speed limit.
///
/// You can append K or M (1K = 1024, 1M = 1024K).
///
/// This option does not affect BitTorrent downloads.
///
/// Default: 0
#[serde(skip_serializing_if = "Option::is_none")]
pub lowest_speed_limit: Option<String>,
/// Set max download speed per each download in bytes/sec. 0 means unrestricted.
///
/// You can append K or M (1K = 1024, 1M = 1024K).
///
/// To limit the overall download speed, use --max-overall-download-limit option.
///
/// Default: 0
#[serde(skip_serializing_if = "Option::is_none")]
pub max_download_limit: Option<String>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub max_connection_per_server: Option<i32>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub max_tries: Option<i32>,
#[serde(
with = "serde_option_from_str",
skip_serializing_if = "Option::is_none",
default
)]
pub timeout: Option<i32>,
#[serde(flatten)]
pub extra_options: Map<String, Value>,
}
/// Hooks that will be executed on notifications.
///
/// If the connection lost, all hooks will be checked whether they need to be executed once reconnected.
#[derive(Default)]
pub struct TaskHooks {
// pub on_start: Option<BoxFuture<'static, ()>>,
// pub on_pause: Option<BoxFuture<'static, ()>>,
// pub on_stop: Option<BoxFuture<'static, ()>>,
pub on_complete: Option<BoxFuture<'static, ()>>,
pub on_error: Option<BoxFuture<'static, ()>>,
// pub on_bt_complete: Option<BoxFuture<'static, ()>>,
}
impl TaskHooks {
pub fn is_some(&self) -> bool {
self.on_complete.is_some() || self.on_error.is_some()
}
}
type Hooks = Arc<Mutex<(HashMap<String, TaskHooks>, HashMap<String, HashSet<Event>>)>>;
struct InnerClient {
token: Option<String>,
tx_write: mpsc::Sender<Message>,
id: AtomicU64,
subscriptions: Arc<Mutex<HashMap<u64, oneshot::Sender<RpcResponse>>>>,
shutdown: Arc<Notify>,
// hooks and pending events
hooks: Hooks,
default_timeout: Duration,
extended_timeout: Duration,
tx_not: broadcast::Sender<response::Notification>,
}
/// An aria2 websocket rpc client.
///
/// The client contains an `Arc<InnerClient>)` and can be cloned.
///
/// # Example
///
/// ```
/// use aria2_ws::Client;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("ws://127.0.0.1:6800/jsonrpc", None)
/// .await
/// .unwrap();
/// let version = client.get_version().await.unwrap();
/// println!("{:?}", version);
/// }
/// ```
#[derive(Clone)]
pub struct Client(Arc<InnerClient>);
impl Drop for InnerClient {
fn drop(&mut self) {
// notify all spawned tasks to shutdown
self.shutdown.notify_waiters();
}
}