nginx-cache-purge 0.3.0

An alternative way to do `proxy_cache_purge` or `fastcgi_cache_purge` for Nginx.
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

use std::path::PathBuf;

use clap::{CommandFactory, FromArgMatches, Parser, Subcommand};
use concat_with::concat_line;
use terminal_size::terminal_size;

const APP_NAME: &str = "Nginx Cache Purge";
const CARGO_PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
const CARGO_PKG_AUTHORS: &str = env!("CARGO_PKG_AUTHORS");

const AFTER_HELP: &str = "Enjoy it! https://magiclen.org";

const APP_ABOUT: &str = concat!(
    "An alternative way to do proxy_cache_purge or fastcgi_cache_purge for Nginx.\n\nEXAMPLES:\n",
    concat_line!(prefix "nginx-cache-purge ",
        "purge /path/to/cache 1:2 http/blog/    # Purge the cache with the key \"http/blog/\" in the \"cache zone\" whose \"path\" is /path/to/cache, \"levels\" is 1:2",
        "purge /path/to/cache 1:1:1 http/blog*  # Purge the caches with the key which has \"http/blog\" as its prefix in the \"cache zone\" whose \"path\" is /path/to/cache, \"levels\" is 1:1:1",
        "purge /path/to/cache 1 */help*         # Purge the caches with the key which contains the substring \"/help\" in the \"cache zone\" whose \"path\" is /path/to/cache, \"levels\" is 1",
        "purge /path/to/cache 2 *               # Purge all caches in the \"cache zone\" whose \"path\" is /path/to/cache, \"levels\" is 2",
        "start                                  # Start a server which listens on \"/tmp/nginx-cache-purge.sock\" to handle purge requests",
        "start /run/nginx-cache-purge.sock      # Start a server which listens on \"/run/nginx-cache-purge.sock\" to handle purge requests",
    )
);

#[derive(Debug, Parser)]
#[command(name = APP_NAME)]
#[command(term_width = terminal_size().map(|(width, _)| width.0 as usize).unwrap_or(0))]
#[command(version = CARGO_PKG_VERSION)]
#[command(author = CARGO_PKG_AUTHORS)]
#[command(after_help = AFTER_HELP)]
pub struct CLIArgs {
    #[command(subcommand)]
    pub command: CLICommands,
}

#[derive(Debug, Subcommand)]
pub enum CLICommands {
    #[command(visible_alias = "p")]
    #[command(about = "Purge the cache immediately")]
    #[command(after_help = AFTER_HELP)]
    Purge {
        #[arg(value_hint = clap::ValueHint::DirPath)]
        #[arg(help = "Assign the path set by proxy_cache_path or fastcgi_cache_path")]
        cache_path: PathBuf,

        #[arg(help = "Assign the levels set by proxy_cache_path or fastcgi_cache_path")]
        levels: String,

        #[arg(help = "Assign the key set by proxy_cache_key or fastcgi_cache_key")]
        key: String,
    },
    #[cfg(feature = "service")]
    #[command(visible_alias = "s")]
    #[command(about = "Start a server to handle purge requests")]
    #[command(after_help = AFTER_HELP)]
    Start {
        #[arg(default_value = "/tmp/nginx-cache-purge.sock")]
        #[arg(value_hint = clap::ValueHint::FilePath)]
        socket_file_path: PathBuf,
    },
}

pub fn get_args() -> CLIArgs {
    let args = CLIArgs::command();

    let about = format!("{APP_NAME} {CARGO_PKG_VERSION}\n{CARGO_PKG_AUTHORS}\n{APP_ABOUT}");

    let args = args.about(about);

    let matches = args.get_matches();

    match CLIArgs::from_arg_matches(&matches) {
        Ok(args) => args,
        Err(err) => {
            err.exit();
        },
    }
}