nbr 0.4.3

CLI for NoneBot2 - A Rust implementation
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
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
use crate::config::get_cache_dir;
use crate::log::StyledText;
use crate::pyproject::{Adapter, NbTomlEditor, PyProjectConfig};
use crate::utils::terminal_utils;
use crate::uv;
use anyhow::{Context, Result};
use clap::Subcommand;
use dialoguer::theme::ColorfulTheme;
use dialoguer::{Confirm, MultiSelect};
use reqwest::Client;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, HashSet};
use std::path::{Path, PathBuf};
use std::sync::OnceLock;
use std::time::Duration;
use tracing::{debug, error, info, warn};

// {
// "module_name": "nonebot.adapters.onebot.v11",
// "project_link": "nonebot-adapter-onebot",
// "name": "OneBot V11",
// "desc": "OneBot V11 协议",
// "author": "yanyongyu",
// "homepage": "https://onebot.adapters.nonebot.dev/",
// "tags": [],
// "is_official": true,
// "time": "2024-10-24T07:34:56.115315Z",
// "version": "2.4.6"
// },
/// Adapter registry information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RegistryAdapter {
    /// Adapter name
    pub module_name: String,
    pub project_link: String,
    pub name: String,
    pub desc: String,
    pub author: String,
    pub homepage: Option<String>,
    pub tags: Vec<HashMap<String, String>>,
    pub is_official: bool,
    pub time: String,
    pub version: String,
}

// registry adapter into adapter
impl From<&RegistryAdapter> for Adapter {
    fn from(adapter: &RegistryAdapter) -> Self {
        Self {
            name: adapter.name.clone(),
            module_name: adapter.module_name.clone(),
        }
    }
}

/// Adapter manager
pub struct AdapterManager {
    /// HTTP client for registry requests
    client: Client,
    /// Working directory
    work_dir: PathBuf,
    /// Registry adapters
    registry_adapters: OnceLock<HashMap<String, RegistryAdapter>>,
    /// Installed adapters
    installed_adapters: OnceLock<Vec<Adapter>>,
}

impl Default for AdapterManager {
    fn default() -> Self {
        Self::new(None).unwrap()
    }
}

impl AdapterManager {
    /// Create a new adapter manager
    pub fn new(work_dir: Option<PathBuf>) -> Result<Self> {
        let work_dir = work_dir.unwrap_or_else(|| Path::new(".").to_path_buf());

        let client = Client::builder()
            .timeout(Duration::from_secs(15))
            .user_agent("nbr")
            .build()?;

        Ok(Self {
            client,
            work_dir,
            registry_adapters: OnceLock::new(),
            installed_adapters: OnceLock::new(),
        })
    }

    fn get_cache_file(&self) -> Result<PathBuf> {
        let cache_dir = get_cache_dir()?;
        Ok(cache_dir.join("adapters.json"))
    }

    fn set_registry_adapters(&self, adapters: HashMap<String, RegistryAdapter>) -> Result<()> {
        self.registry_adapters
            .set(adapters)
            .map_err(|_| anyhow::anyhow!("Failed to set cached adapters"))
    }

    pub fn get_registry_adapters(&self) -> Result<&HashMap<String, RegistryAdapter>> {
        self.registry_adapters
            .get()
            .context("Registry adapters not initialized")
    }

    /// Fetch registry adapters from registry.nonebot.dev
    pub async fn fetch_registry_adapters(
        &self,
        fetch_remote: bool,
    ) -> Result<&HashMap<String, RegistryAdapter>> {
        if let Some(adapters) = self.registry_adapters.get() {
            return Ok(adapters);
        }

        // 从缓存中获取
        let cache_file = self.get_cache_file()?;
        if !fetch_remote && cache_file.exists() {
            debug!("Loading adapters from cache: {}", cache_file.display());
            let registry_adapters: HashMap<String, RegistryAdapter> =
                serde_json::from_slice(&std::fs::read(&cache_file)?)?;
            self.set_registry_adapters(registry_adapters)?;
            return self.get_registry_adapters();
        }

        // 从 registry 获取
        let spinner = terminal_utils::create_spinner("Fetching adapters from registry...");
        let adapters_json_url = "https://registry.nonebot.dev/adapters.json";
        let response = self.client.get(adapters_json_url).send().await?;

        let adapters: Vec<RegistryAdapter> = response
            .json()
            .await
            .context("Failed to parse adapter info")?;

        // 解析成功后,结束 spinner
        spinner.finish_and_clear();

        let registry_adapters = adapters
            .iter()
            .map(|a| (a.name.to_owned(), a.clone()))
            .collect::<HashMap<String, RegistryAdapter>>();

        // 缓存到文件
        std::fs::write(cache_file, serde_json::to_string(&registry_adapters)?)?;
        self.set_registry_adapters(registry_adapters)?;
        self.get_registry_adapters()
    }

    /// Parse installed adapters from pyproject.toml
    pub fn parse_installed_adapters(&self) -> Option<&Vec<Adapter>> {
        if let Some(adapters) = self.installed_adapters.get() {
            return Some(adapters);
        }

        let config = PyProjectConfig::parse(Some(&self.work_dir)).ok()?;
        let adapters = config.nonebot()?.adapters.to_owned()?;
        self.installed_adapters.set(adapters).ok()?;
        self.installed_adapters.get()
    }

    /// Get installed adapters names from pyproject.toml
    pub fn get_installed_adapters_names(&self) -> Vec<&str> {
        let installed_adapters = self.parse_installed_adapters();
        if let Some(adapters) = installed_adapters {
            adapters
                .iter()
                .map(|a| a.name.as_str())
                .collect::<Vec<&str>>()
        } else {
            vec![]
        }
    }

    /// Select adapters from registry
    pub async fn select_adapters(
        &self,
        fetch_remote: bool,
        filter_installed: bool,
    ) -> Result<Vec<&RegistryAdapter>> {
        // 获取 registry 中的 adapters
        let registry_adapters = self.fetch_registry_adapters(fetch_remote).await?;
        let mut adapter_names: Vec<String> = registry_adapters.keys().cloned().collect();

        // 过滤已安装的 adapters
        if filter_installed {
            let installed_adapters = self.get_installed_adapters_names();
            adapter_names.retain(|name| !installed_adapters.contains(&name.as_str()));
        }

        // 排序
        adapter_names.sort();

        let selected_adapters = if !adapter_names.is_empty() {
            let selections = MultiSelect::with_theme(&ColorfulTheme::default())
                .with_prompt("Which adapter(s) would you like to use")
                .items(&adapter_names)
                .interact()?;

            selections
                .into_iter()
                .map(|i| adapter_names[i].to_string())
                .collect()
        } else {
            vec!["OneBot V11".to_string()] // Default adapter
        };

        Ok(selected_adapters
            .iter()
            .filter_map(|name| registry_adapters.get(name))
            .collect())
    }

    /// Install an adapter
    pub async fn install_adapters(&self, fetch_remote: bool) -> Result<()> {
        let selected_adapters = self.select_adapters(fetch_remote, true).await?;

        if selected_adapters.is_empty() {
            warn!("You haven't selected any adapters to install");
            return Ok(());
        }
        let selected_adapters_names = selected_adapters
            .iter()
            .map(|a| a.name.clone())
            .collect::<Vec<String>>()
            .join(", ");
        let prompt = StyledText::new(" ")
            .white_bold("Would you like to install")
            .cyan_bold(format!("[{}]", selected_adapters_names).as_str())
            .to_string();

        if !Confirm::with_theme(&ColorfulTheme::default())
            .with_prompt(&prompt)
            .default(true)
            .interact()?
        {
            error!("{}", "Installation operation cancelled.");
            return Ok(());
        }

        // Install the adapter
        let adapter_packages = selected_adapters
            .iter()
            .map(|a| a.project_link.as_str())
            .collect::<HashSet<&str>>() // 🐶 ob
            .into_iter()
            .collect::<Vec<&str>>();

        uv::add(adapter_packages)
            .working_dir(&self.work_dir)
            .run()?;
        // Add to configuration
        let adapters = selected_adapters
            .iter()
            .map(|a| (*a).into())
            .collect::<Vec<Adapter>>();

        // Add adapters to configuration
        NbTomlEditor::with_work_dir(Some(&self.work_dir))?.add_adapters(adapters)?;

        StyledText::new(" ")
            .green_bold("✓ Successfully installed adapters:")
            .cyan_bold(&selected_adapters_names)
            .println();

        // Show configuration instructions
        // if let Some(ref adapter) = adapter_info {
        //     if let Some(ref config_template) = adapter.config_template {
        //         self.show_configuration_instructions(adapter, config_template);
        //     }
        // }

        Ok(())
    }

    /// Get installed adapters from virtual environment
    #[allow(dead_code)]
    pub async fn get_installed_adapters_from_venv(&self) -> Result<HashSet<String>> {
        let installed_adapters = uv::list(false).await?;
        let installed_adapters_set = installed_adapters
            .into_iter()
            .filter(|a| a.name.contains("nonebot-adapter-"))
            .map(|a| a.name)
            .collect::<HashSet<String>>();
        debug!("Installed adapters: {:?}", installed_adapters_set);
        Ok(installed_adapters_set)
    }

    /// Uninstall an adapter
    pub async fn uninstall_adapters(&self) -> Result<()> {
        // get installed adapters from configuration
        let mut installed_adapters = self.get_installed_adapters_names();
        if installed_adapters.is_empty() {
            warn!("You haven't installed any adapters");
            return Ok(());
        }

        // select adapters to uninstall
        let selected_adapters: Vec<&str> = {
            let selections = MultiSelect::with_theme(&ColorfulTheme::default())
                .with_prompt("Select installed adapter(s) to uninstall")
                .items(&installed_adapters)
                .interact()?;

            selections
                .into_iter()
                .map(|i| installed_adapters[i])
                .collect()
        };

        // Remove from configuration
        NbTomlEditor::with_work_dir(Some(&self.work_dir))?
            .remove_adapters(selected_adapters.to_vec())?;

        // Uninstall the package
        let registry_adapters = self.fetch_registry_adapters(false).await?;

        let mut adapter_packages = selected_adapters
            .iter()
            .filter_map(|name| {
                registry_adapters
                    .get(*name)
                    .map(|a| a.project_link.as_str())
            })
            .collect::<HashSet<&str>>() // 🐶 ob
            .into_iter()
            .collect::<Vec<&str>>();
        // 特判 ob,沟槽的 ob,Onebot V11 和 Onebot V12 是同一个包
        // 剩下的 installed_adapters 中,如果包含 ob,则不删除
        installed_adapters.retain(|name| !selected_adapters.contains(name));
        if installed_adapters
            .iter()
            .any(|name| name.starts_with("OneBot"))
        {
            adapter_packages.retain(|name| *name != "nonebot-adapter-onebot");
        }

        if !adapter_packages.is_empty() {
            uv::remove(adapter_packages)
                .working_dir(&self.work_dir)
                .run()?;
        }

        StyledText::new(" ")
            .green_bold("✓ Successfully uninstalled adapters:")
            .cyan_bold(selected_adapters.join(", "))
            .println();

        Ok(())
    }

    /// List available and installed adapters
    pub async fn list_adapters(&self, show_all: bool) -> Result<()> {
        let installed_adapters = self.get_installed_adapters_names();
        let adapters_map = self.fetch_registry_adapters(show_all).await?;

        if show_all {
            info!("All Adapters:");
            adapters_map.iter().for_each(|(_, adapter)| {
                self.display_adapter(adapter);
            });
        } else {
            if installed_adapters.is_empty() {
                warn!("No adapters installed.");
                return Ok(());
            }

            info!("Installed Adapters:");
            installed_adapters.iter().for_each(|name| {
                if let Some(adapter) = adapters_map.get(*name) {
                    self.display_adapter(adapter);
                }
            });
        }

        Ok(())
    }

    pub fn display_adapter(&self, adapter: &RegistryAdapter) {
        StyledText::new(" ")
            .cyan_bold("")
            .cyan_bold(&adapter.name)
            .text(format!("({})", adapter.project_link).as_str())
            .green(format!("v{}", adapter.version).as_str())
            .println();
    }

    /// Display adapter information
    #[allow(dead_code)]
    fn display_adapter_info(&self, adapter: &RegistryAdapter) {
        StyledText::new("").cyan_bold(&adapter.name).println();
        StyledText::new(" ")
            .text("  Package:")
            .text(&adapter.project_link)
            .println();
        StyledText::new(" ")
            .text("  Module:")
            .text(&adapter.module_name)
            .println();
        StyledText::new(" ")
            .text("  Desc:")
            .text(&adapter.desc)
            .println();
        StyledText::new(" ")
            .text("  Version:")
            .text(&adapter.version)
            .println();
        StyledText::new(" ")
            .text("  Author:")
            .text(&adapter.author)
            .println();
        if let Some(ref homepage) = adapter.homepage {
            StyledText::new(" ")
                .text("  Homepage:")
                .text(homepage)
                .println();
        }
    }
}

#[derive(Subcommand)]
pub enum AdapterCommands {
    #[clap(about = "Install adapters")]
    Install {
        #[clap(short, long, help = "Fetch adapters from remote")]
        fetch_remote: bool,
    },
    #[clap(about = "Uninstall adapters")]
    Uninstall,
    #[clap(about = "List installed adapters, show all adapters if --all is set")]
    List {
        #[clap(short, long, help = "Show all adapters")]
        all: bool,
    },
}

/// Handle the adapter command
pub async fn handle(commands: &AdapterCommands) -> Result<()> {
    let adapter_manager = AdapterManager::new(None)?;

    match commands {
        AdapterCommands::Install { fetch_remote } => {
            adapter_manager.install_adapters(*fetch_remote).await?
        }
        AdapterCommands::Uninstall => adapter_manager.uninstall_adapters().await?,
        AdapterCommands::List { all } => adapter_manager.list_adapters(*all).await?,
    }
    Ok(())
}