wip

Author: 1673beta

Cargo.lock

@@ -11,8 +11,9 @@ clap = { version = "4.5.22", features = ["derive", "env"] }
 futures = "0.3.31"
 lazy_static = "1.5.0"
 log = "0.4.22"
-meilisearch-sdk = "0.28.0"
+meilisearch-sdk = "0.29.1"
 nanoid = "0.4.0"
+once_cell = "1.21.3"
 openssl = "0.10.70"
 rand = { version = "0.8.5", features = ["serde"] }
 redis = { version = "0.27.6", features = ["tokio-rustls-comp", "cluster", "json", "r2d2"] }
@@ -21,6 +22,7 @@ sea-orm = { version = "1.1.6", features = ["sqlx-postgres", "runtime-tokio-rustl
 serde = { version = "1.0.215", features = ["derive", "serde_derive"] }
 serde_json = "1.0.133"
 serde_yml = "0.0.12"
+syn = "2.0.106"
 syntect = "5.2.0"
 thiserror = "2.0.11"
 tokio = { version = "1.43.0", features = ["full"] }

Cargo.toml

@@ -0,0 +1,11 @@
+# For 0.3.0
+- [ ] `.config/default.yml`の読み込み方の改善(バージョン・ソフトウェアによる差異の考慮、~~staticなload~~)
+- [ ] 各CLI機能の共通部分をservices以下に切り出し
+- [ ] cfgによるバージョンとソフトウェアによる挙動の違いを考慮
+- [ ] docs整備
+- [ ] notectl自体のconfigを設定できる機能(あるいは環境変数？)
+- [ ] testを書く
+- [ ] cfgを利用した条件付きコンパイル
+- [ ] entitiesのバージョン管理のマクロ
+- [ ] パスワード強制変更コマンド (要sudo/doas) <-docker環境下でどうする?
+- [ ] 2025.7.0以前でのCaptchaリセット機能(2025.8.0でも使えるようにするけどその場合非推奨を出す)

TODO.md

@@ -7,12 +7,16 @@ use crate::cli::note::NoteCommand;
 use crate::cli::remote::RemoteCommand;
 use crate::cli::search::SearchCommand;
 use crate::cli::user::UserCommand;
+use crate::configs::server::ServerConfig;
 
+// TODO: globalな引数にconfig_pathを追加する
 #[derive(Debug, Parser)]
 #[command(name = "notectl", about = "A CLI tool for managing misskey", color = ColorChoice::Always, styles = super::style::style())]
 pub struct Cli {
   #[clap(subcommand)]
   pub cmd: Commands,
+  #[arg(short = 'c', long = "config", global = true)]
+  pub config_path: String,
 }
 
 #[derive(Debug, Subcommand)]
@@ -35,6 +39,7 @@ pub enum Commands {
 
 pub async fn exec() -> Result<(), Box<dyn std::error::Error>> {
   let args = Cli::parse();
+  ServerConfig::init(&args.config_path)?;
   match args.cmd {
     Commands::Webpush(cmd) => {
       if let Err(e) = cmd.exec() {

src/cli/command.rs

@@ -1,10 +1,13 @@
 use serde::{Deserialize, Serialize};
+use std::sync::RwLock;
 use std::{fs, path::Path};
 use syntect::easy::HighlightLines;
 use syntect::highlighting::{Style, ThemeSet};
 use syntect::parsing::SyntaxSet;
 use syntect::util::{as_24_bit_terminal_escaped, LinesWithEndings};
 
+static CONFIG: once_cell::sync::OnceCell<RwLock<MisskeyConfig>> = once_cell::sync::OnceCell::new();
+
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct MisskeyConfig {

src/config.rs

@@ -0,0 +1,5 @@
+pub mod notectl;
+pub mod server;
+
+// TODO?: 両方のinitializeを同時に行える関数を追加する？
+// 要検討

src/configs/mod.rs

@@ -0,0 +1,8 @@
+// TODO
+
+// ログ出力レベルの変更
+// SeaORMのmin_connections, max_connectionsの変更
+// SeaORMのtimeoutの設定(あれば)
+// DB接続のリトライ回数・間隔設定
+// DB接続のSSL設定
+// Redis周りも将来的にやる

src/configs/notectl.rs

@@ -0,0 +1,242 @@
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+use std::sync::RwLock;
+use std::{fs, path::Path};
+use thiserror::Error;
+use clap::ValueEnum;
+
+static CONFIG: once_cell::sync::OnceCell<RwLock<MisskeyConfig>> = once_cell::sync::OnceCell::new();
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct MisskeyConfig {
+  pub publish_tarball_instead_of_provide_repository_url: Option<bool>,
+  pub setup_password: Option<String>,
+  pub url: String,
+  pub port: u64,
+  pub db: DbConfig,
+  pub db_replications: bool,
+  pub db_slaves: Option<Vec<DbConfig>>,
+  pub redis: RedisConfig,
+  pub redis_for_pubsub: Option<RedisConfig>,
+  pub redis_for_job_queue: Option<RedisConfig>,
+  pub redis_for_timelines: Option<RedisConfig>,
+  pub redis_for_reactions: Option<RedisConfig>,
+  #[serde(rename = "fulltextSearch")]
+  pub full_text_search: Option<FullTextSearch>,
+  pub meilisearch: Option<MeilisearchConfig>,
+  pub id: IdMethod,
+  pub serde_for_backend: Option<SentryForBackendConfig>,
+  pub serde_for_frontend: Option<SentryForFrontendConfig>,
+  pub disable_hsts: Option<bool>,
+  pub cluster_limit: Option<u64>,
+  pub deliver_job_concurrency: Option<u64>,
+  pub inbox_job_concurrency: Option<u64>,
+  pub relationship_job_concurrency: Option<u64>,
+  pub deliver_job_per_sec: Option<u64>,
+  pub inbox_job_per_sec: Option<u64>,
+  pub relationship_job_per_sec: Option<u64>,
+  pub deliver_job_max_attempts: Option<u64>,
+  pub inbox_job_max_attempts: Option<u64>,
+  pub outgoing_address: Option<String>,
+  pub outgoing_address_family: Option<OutgoingAddressFamily>,
+  pub proxy: Option<String>,
+  pub proxy_bypass_hosts: Option<Vec<String>>,
+  pub proxy_smtp: Option<String>,
+  pub media_proxy: Option<String>,
+  pub proxy_remote_files: bool,
+  pub video_thumbnail_generator: Option<String>,
+  pub sign_to_activity_pub_get: bool,
+  pub allowed_private_networks: Option<Vec<String>>,
+  pub max_file_size: Option<u64>,
+  pub pid_file: Option<String>,
+  pub per_channel_max_note_cache_count: Option<u64>,
+  pub per_user_notifications_max_count: Option<u64>,
+  pub deactivate_antenna_threshold: Option<u64>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct DbConfig {
+  pub host: String,
+  pub port: u64,
+  pub db: String,
+  pub user: String,
+  pub pass: String,
+  pub disable_cache: Option<bool>,
+  pub extra: Option<DbExtraConfig>,
+}
+
+// TODO: pgのextraオプションへの追加対応 https://github.com/misskey-dev/misskey/issues/15108
+#[derive(Debug, Serialize, Deserialize)]
+pub struct DbExtraConfig {
+  pub ssl: bool,
+  pub statement_timeout: Option<u64>,
+  pub query_timeout: Option<u64>,
+  pub lock_timeout: Option<u64>,
+  #[serde(flatten)]
+  #[serde(skip_serializing)]
+  _ignored: HashMap<String, serde_yml::Value>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct RedisConfig {
+  pub host: String,
+  pub port: u64,
+  pub family: Option<RedisFamily>,
+  pub pass: Option<String>,
+  pub prefix: Option<String>,
+  pub db: Option<u64>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub enum RedisFamily {
+  Both = 0,
+  IPv4 = 4,
+  IPv6 = 6,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
+pub struct FullTextSearch {
+  pub provider: FullTextSearchProvider,
+}
+
+// TODO: サメがtsvectorを使う場合の設定も追加
+#[derive(Debug, Serialize, Deserialize, Clone, Copy, ValueEnum)]
+#[serde(rename_all = "camelCase")]
+pub enum FullTextSearchProvider {
+  #[serde(rename = "sqlLike")]
+  SqlLike,
+  #[serde(rename = "sqlPgroonga")]
+  SqlPgroonga,
+  #[serde(rename = "meilisearch")]
+  Meilisearch,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct MeilisearchConfig {
+  pub host: String,
+  pub port: u64,
+  pub api_key: String,
+  pub ssl: bool,
+  pub index: String,
+  pub scope: Option<MeilisearchScope>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(rename_all = "lowercase")]
+pub enum MeilisearchScope {
+  Local,
+  Global,
+  Custom(Vec<String>),
+}
+
+#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy, ValueEnum)]
+#[serde(rename_all = "lowercase")]
+pub enum IdMethod {
+  Aid,
+  #[default]
+  Aidx,
+  Meid,
+  Ulid,
+  ObjectId,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SentryForBackendConfig {
+  pub enable_node_profiling: bool,
+  pub options: Option<SentryOptions>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SentryForFrontendConfig {
+  pub options: Option<SentryOptions>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct SentryOptions {
+  pub dsn: String,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "lowercase")]
+pub enum OutgoingAddressFamily {
+  IPv4,
+  IPv6,
+  Dual,
+}
+
+#[derive(Debug, Error)]
+pub enum ConfigError {
+  #[error("Config not initialized")]
+  ConfigNotInitialized,
+
+  #[error("File not found: {path}")]
+  ConfigFileNotFound { path: String },
+
+  #[error("Failed to read config file: {0}")]
+  ConfigFileReadError(#[from] std::io::Error),
+
+  #[error("Failed to parse config file: {0}")]
+  ConfigFileParseError(#[from] serde_yml::Error),
+
+  #[error("Validation error: {0}")]
+  ConfigValidationError(String),
+
+  #[error("Initialization error")]
+  ConfigInitializationError,
+}
+
+pub struct ServerConfig;
+
+impl ServerConfig {
+  pub fn init(config_path: &str) -> Result<(), ConfigError> {
+    let config = Self::load_from_file(config_path)?;
+
+    CONFIG
+      .set(RwLock::new(config))
+      .map_err(|_| ConfigError::ConfigInitializationError);
+
+    Ok(())
+  }
+
+  fn load_from_file(config_path: &str) -> Result<MisskeyConfig, ConfigError> {
+    let path = Path::new(config_path);
+
+    if !path.exists() {
+      return Err(ConfigError::ConfigFileNotFound {
+        path: config_path.to_string(),
+      });
+    }
+
+    let config_content = match fs::read_to_string(path) {
+      Ok(content) => content,
+      Err(e) => return Err(ConfigError::ConfigFileReadError(e)),
+    };
+    let config: MisskeyConfig = match serde_yml::from_str(&config_content) {
+      Ok(cfg) => cfg,
+      Err(e) => return Err(ConfigError::ConfigFileParseError(e)),
+    };
+
+    Ok(config)
+  }
+
+  pub fn get() -> Result<std::sync::RwLockReadGuard<'static, MisskeyConfig>, ConfigError> {
+    let config = CONFIG.get().ok_or(ConfigError::ConfigNotInitialized)?;
+    config.read().map_err(|_| ConfigError::ConfigNotInitialized)
+  }
+
+  pub fn get_id_method() -> Result<IdMethod, ConfigError> {
+    Self::get().map(|cfg| cfg.id)
+  }
+
+  pub fn get_search_provider() -> Result<Option<FullTextSearchProvider>, ConfigError> {
+    Self::get().map(|cfg| cfg.full_text_search.map(|provider| provider.provider))
+  }
+
+  pub fn get_meilisearch_config() -> Result<Option<MeilisearchConfig>, ConfigError> {
+    Self::get().map(|cfg| cfg.meilisearch.clone())
+  }
+}

src/configs/server.rs

@@ -1,8 +1,10 @@
 mod cli;
-mod config;
+mod config; // TODO: 消す
+mod configs; // TODO: rename
 mod consts;
 mod db;
 mod entities;
+mod services;
 mod util;
 
 #[tokio::main]

src/main.rs

@@ -0,0 +1,56 @@
+use crate::util::id::*;
+use thiserror::Error;
+use crate::configs::server::{ServerConfig, IdMethod};
+
+#[derive(Error, Debug)]
+pub enum IdServiceError {
+  #[error("Invalid ID format")]
+  InvalidIdFormat,
+
+  #[error("ID generation error. {reason} ")]
+  IdGenerationError { reason: String },
+
+  #[error("Unsafe ID detected")]
+  UnsafeIdError,
+
+  #[error("Parsing error: {0}")]
+  ParseError(#[from] std::num::ParseIntError),
+}
+
+pub struct IdService {
+  pub method: IdMethod,
+}
+
+impl IdService {
+  pub fn new(method: IdMethod) -> Self {
+    Self { method }
+  }
+
+  pub fn gen(&self, time: u64) -> Result<String, IdServiceError> {
+    let result = match self.method {
+      IdMethod::Aid => aid::gen_aid(time),
+      IdMethod::Aidx => aidx::gen_aidx(time),
+      IdMethod::Meid => meid::gen_meid(time),
+      IdMethod::ObjectId => objectid::gen_object_id(time),
+      IdMethod::Ulid => ulid::gen_ulid(time),
+    };
+
+    result.map_err(|reason| IdServiceError::IdGenerationError {
+      reason: reason.to_string(),
+    })
+  }
+
+  pub fn parse(&self, id: &str) -> Result<std::time::SystemTime, IdServiceError> {
+    let result = match self.method {
+      IdMethod::Aid => aid::parse(id),
+      IdMethod::Aidx => aidx::parse(id),
+      IdMethod::Meid => meid::parse(id),
+      IdMethod::ObjectId => objectid::parse(id),
+      IdMethod::Ulid => ulid::parse(id),
+    };
+
+    result.map_err(|e| IdServiceError::ParseError(e))
+  }
+
+  // TODO: validation
+}