qbfrt 0.3.2

Command line tool for working with qBittorrent's fastresume data
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

//! qbfrt database module
//!
//! Mediates interactions with the experimental qB torrents.db fastresume database. Includes
//! functionality to modify torrent and fastresume information within the database.
//!
//! ## Examples and Usage
//! ### Connecting to a database
//! ```rs
//! let conn = DB::connect(&config).unwrap_or_else(|err| {
//!     println!("Could not connect to database: {err}");
//!     process::exit(1);
//! });
//! ```
//! ### Backing up a database
//! ```rs
//! DB::backup(&config).unwrap_or_else(|err| {
//!     println!("Could not backup database: {err}");
//!     process::exit(1);
//! });

use crate::config::Config;
use rusqlite::{Connection, OpenFlags, Result};
use std::error::Error;
use std::fs;
use std::path::Path;

pub mod dump_db;
pub mod query;
pub mod save_path;
pub mod tracker_url;

/// qB torrents.db struct
pub struct DB {}
impl DB {
    /// Creates a timestamped backup of the torrents.db file before modification
    ///
    /// ## Examples
    /// ```rs
    /// DB::backup(&config).unwrap_or_else(|err| {
    ///     println!("Could not backup database: {err}");
    ///     process::exit(1);
    /// });
    ///```
    /// ## Disabling
    /// Automatic backups can be disabled by passing `--disable-backup` or `-d`
    /// ```bash
    /// qbfrt --disable-backup
    /// ```
    ///
    /// ## Verbose output
    /// If verbose output is enabled with `--verbose` or `-v` it will then output the path to the backup.
    /// In the case where backup is disabled it will output that instead.
    pub fn backup(config: &Config) -> Result<(), Box<dyn Error>> {
        if !config.disable_backup {
            println!("Creating database backup...");

            let datetime = chrono::offset::Local::now().format("%Y%m%d%H%M%S");
            let backup_file =
                Path::new(&config.qb_directory).join(format!("torrents.db-{datetime}.bak"));
            fs::copy(&config.db_file, &backup_file)?;

            if config.verbose {
                println!("Backup saved to: {:?}", backup_file.display());
            }
        } else if config.verbose {
            println!("Database backup disabled");
        }

        Ok(())
    }

    /// Opens the torrents.db SQLite database and returns the connection
    ///
    /// ## Example
    /// ```rs
    /// let conn = DB::connect(&config).unwrap_or_else(|err| {
    ///     println!("Could not connect to database: {err}");
    ///     process::exit(1);
    /// });
    /// ```
    pub fn connect(config: &Config) -> Result<Connection, Box<dyn Error>> {
        println!("Opening database...");

        Ok(Connection::open_with_flags(
            &config.db_file,
            OpenFlags::SQLITE_OPEN_READ_WRITE
                | OpenFlags::SQLITE_OPEN_URI
                | OpenFlags::SQLITE_OPEN_NO_MUTEX,
        )?)
    }
}