init imap oauth2 support

Cargo.toml

@@ -48,7 +48,7 @@ dialoguer = "0.10.2"
 email_address = "0.2.4"
 env_logger = "0.8"
 erased-serde = "0.3"
-pimalaya-email = "0.7.1"
+pimalaya-email = { git = "https://git.sr.ht/~soywod/pimalaya" }
 indicatif = "0.17"
 log = "0.4"
 once_cell = "1.16.0"

flake.lock

@@ -21,6 +21,22 @@
         "type": "github"
       }
     },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
     "flake-utils": {
       "inputs": {
         "systems": "systems"
@@ -98,6 +114,7 @@
     "root": {
       "inputs": {
         "fenix": "fenix",
+        "flake-compat": "flake-compat",
         "flake-utils": "flake-utils",
         "gitignore": "gitignore",
         "naersk": "naersk",

flake.nix

@@ -16,9 +16,13 @@
       url = "github:nix-community/naersk";
       inputs.nixpkgs.follows = "nixpkgs";
     };
+    flake-compat = {
+      url = "github:edolstra/flake-compat";
+      flake = false;
+    };
   };
 
-  outputs = { self, nixpkgs, flake-utils, gitignore, fenix, naersk }:
+  outputs = { self, nixpkgs, flake-utils, gitignore, fenix, naersk, ... }:
     let
       inherit (gitignore.lib) gitignoreSource;
 

src/config/mod.rs

@@ -1,6 +1,6 @@
 pub mod args;
 pub mod config;
 pub mod prelude;
-mod wizard;
+pub(crate) mod wizard;
 
 pub use config::*;

src/config/prelude.rs

@@ -1,6 +1,7 @@
 use pimalaya_email::{
     folder::sync::Strategy as SyncFoldersStrategy, EmailHooks, EmailSender, EmailTextPlainFormat,
-    MaildirConfig, SendmailConfig, SmtpConfig,
+    ImapAuthConfig, MaildirConfig, OAuth2ClientSecret, OAuth2Config, OAuth2Method, OAuth2Scopes,
+    SendmailConfig, SmtpConfig,
 };
 use serde::{Deserialize, Serialize};
 use std::{collections::HashSet, path::PathBuf};
@@ -46,8 +47,8 @@ pub struct ImapConfigDef {
     pub insecure: Option<bool>,
     #[serde(rename = "imap-login")]
     pub login: String,
-    #[serde(rename = "imap-passwd-cmd")]
-    pub passwd_cmd: String,
+    #[serde(rename = "imap-auth", with = "ImapAuthConfigDef")]
+    pub auth: ImapAuthConfig,
     #[serde(rename = "imap-notify-cmd")]
     pub notify_cmd: Option<String>,
     #[serde(rename = "imap-notify-query")]
@@ -56,6 +57,55 @@ pub struct ImapConfigDef {
     pub watch_cmds: Option<Vec<String>>,
 }
 
+#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
+#[serde(remote = "ImapAuthConfig", rename_all = "kebab-case")]
+pub enum ImapAuthConfigDef {
+    #[serde(skip)]
+    None,
+    RawPasswd(String),
+    PasswdCmd(String),
+    #[serde(with = "OAuth2ConfigDef", rename = "oauth2")]
+    OAuth2(OAuth2Config),
+}
+
+#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
+#[serde(remote = "OAuth2Config", rename_all = "kebab-case")]
+pub struct OAuth2ConfigDef {
+    #[serde(with = "OAuth2MethodDef")]
+    pub method: OAuth2Method,
+    pub client_id: String,
+    #[serde(with = "OAuth2ClientSecretDef")]
+    pub client_secret: OAuth2ClientSecret,
+    pub auth_url: String,
+    pub token_url: String,
+    #[serde(flatten, with = "OAuth2ScopesDef")]
+    pub scopes: OAuth2Scopes,
+    #[serde(default)]
+    pub pkce: bool,
+}
+
+#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
+#[serde(remote = "OAuth2ClientSecret", rename_all = "kebab-case")]
+pub enum OAuth2ClientSecretDef {
+    Raw(String),
+    Cmd(String),
+    Keyring,
+}
+
+#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
+#[serde(remote = "OAuth2Method", rename_all = "lowercase")]
+pub enum OAuth2MethodDef {
+    XOAuth2,
+    OAuthBearer,
+}
+
+#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
+#[serde(remote = "OAuth2Scopes", rename_all = "kebab-case")]
+pub enum OAuth2ScopesDef {
+    Scope(String),
+    Scopes(Vec<String>),
+}
+
 #[derive(Clone, Debug, Default, Eq, PartialEq, Deserialize, Serialize)]
 #[serde(remote = "MaildirConfig", rename_all = "kebab-case")]
 pub struct MaildirConfigDef {

src/config/wizard/imap.rs

@@ -1,10 +1,13 @@
-use super::{SECURITY_PROTOCOLS, THEME};
-use crate::account::{
-    DeserializedAccountConfig, DeserializedBaseAccountConfig, DeserializedImapAccountConfig,
-};
 use anyhow::Result;
 use dialoguer::{Input, Select};
 use pimalaya_email::ImapConfig;
+use std::io;
+
+use crate::account::{
+    DeserializedAccountConfig, DeserializedBaseAccountConfig, DeserializedImapAccountConfig,
+};
+
+use super::{SECURITY_PROTOCOLS, THEME};
 
 #[cfg(feature = "imap-backend")]
 pub(crate) fn configure(base: DeserializedBaseAccountConfig) -> Result<DeserializedAccountConfig> {
@@ -46,12 +49,21 @@ pub(crate) fn configure(base: DeserializedBaseAccountConfig) -> Result<Deseriali
         .default(base.email.clone())
         .interact()?;
 
-    backend.passwd_cmd = Input::with_theme(&*THEME)
-        .with_prompt("What shell command should we run to get your password?")
-        .default(format!("pass show {}", &base.email))
-        .interact()?;
+    // FIXME: add all variants: password, password command and oauth2
+    // backend.passwd_cmd = Input::with_theme(&*THEME)
+    //     .with_prompt("What shell command should we run to get your password?")
+    //     .default(format!("pass show {}", &base.email))
+    //     .interact()?;
 
     Ok(DeserializedAccountConfig::Imap(
         DeserializedImapAccountConfig { base, backend },
     ))
 }
+
+#[cfg(feature = "imap-backend")]
+pub(crate) fn configure_oauth2_client_secret() -> io::Result<String> {
+    Input::with_theme(&*THEME)
+        .with_prompt("Enter your OAuth 2.0 client secret:")
+        .report(false)
+        .interact()
+}

src/config/wizard/mod.rs

@@ -1,5 +1,5 @@
 #[cfg(feature = "imap-backend")]
-mod imap;
+pub(crate) mod imap;
 mod maildir;
 #[cfg(feature = "notmuch-backend")]
 mod notmuch;

src/domain/account/args.rs

@@ -10,11 +10,14 @@ use crate::{folder, ui::table};
 
 const ARG_ACCOUNT: &str = "account";
 const ARG_DRY_RUN: &str = "dry-run";
+const ARG_RESET: &str = "reset";
 const CMD_ACCOUNTS: &str = "accounts";
+const CMD_CONFIGURE: &str = "configure";
 const CMD_LIST: &str = "list";
 const CMD_SYNC: &str = "sync";
 
 type DryRun = bool;
+type Reset = bool;
 
 /// Represents the account commands.
 #[derive(Debug, PartialEq, Eq)]
@@ -23,6 +26,8 @@ pub enum Cmd {
     List(table::args::MaxTableWidth),
     /// Represents the sync account command.
     Sync(Option<SyncFoldersStrategy>, DryRun),
+    /// Configure the current selected account.
+    Configure(Reset),
 }
 
 /// Represents the account command matcher.
@@ -51,6 +56,10 @@ pub fn matches(m: &ArgMatches) -> Result<Option<Cmd>> {
             info!("list accounts subcommand matched");
             let max_table_width = table::args::parse_max_width(m);
             Some(Cmd::List(max_table_width))
+        } else if let Some(m) = m.subcommand_matches(CMD_CONFIGURE) {
+            info!("configure account subcommand matched");
+            let reset = parse_reset_flag(m);
+            Some(Cmd::Configure(reset))
         } else {
             info!("no account subcommand matched, falling back to subcommand list");
             Some(Cmd::List(None))
@@ -80,6 +89,10 @@ pub fn subcmd() -> Command {
                     "Synchronize all folders except the given ones",
                 ))
                 .arg(dry_run()),
+            Command::new(CMD_CONFIGURE)
+                .about("Configure the current selected account")
+                .aliases(["config", "conf", "cfg"])
+                .arg(reset_flag()),
         ])
 }
 
@@ -117,3 +130,15 @@ Changes can be visualized with the RUST_LOG=trace environment variable.",
 pub fn parse_dry_run_arg(m: &ArgMatches) -> bool {
     m.get_flag(ARG_DRY_RUN)
 }
+
+pub fn reset_flag() -> Arg {
+    Arg::new(ARG_RESET)
+        .help("Reset the configuration")
+        .short('r')
+        .long("reset")
+        .action(ArgAction::SetTrue)
+}
+
+pub fn parse_reset_flag(m: &ArgMatches) -> bool {
+    m.get_flag(ARG_RESET)
+}

src/domain/account/handlers.rs

@@ -6,16 +6,41 @@ use anyhow::Result;
 use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
 use log::{info, trace};
 use pimalaya_email::{
-    folder::sync::Strategy as SyncFoldersStrategy, AccountConfig, Backend, BackendSyncBuilder,
-    BackendSyncProgressEvent,
+    folder::sync::Strategy as SyncFoldersStrategy, AccountConfig, Backend, BackendConfig,
+    BackendSyncBuilder, BackendSyncProgressEvent,
 };
 
 use crate::{
-    config::DeserializedConfig,
+    config::{wizard::imap::configure_oauth2_client_secret, DeserializedConfig},
     printer::{PrintTableOpts, Printer},
     Accounts,
 };
 
+/// Configure the current selected account
+pub fn configure(
+    account_config: &AccountConfig,
+    backend_config: &BackendConfig,
+    reset: bool,
+) -> Result<()> {
+    info!("entering the configure account handler");
+    match backend_config {
+        BackendConfig::None => (),
+        BackendConfig::Maildir(_) => (),
+        #[cfg(feature = "imap-backend")]
+        BackendConfig::Imap(imap_config) => {
+            imap_config.auth.configure(
+                &account_config.name,
+                reset,
+                configure_oauth2_client_secret,
+            )?;
+        }
+        #[cfg(feature = "notmuch-backend")]
+        BackendConfig::Notmuch(config) => (),
+    };
+    println!("Account {} configured!", account_config.name);
+    Ok(())
+}
+
 /// Lists all accounts.
 pub fn list<'a, P: Printer>(
     max_width: Option<usize>,

src/main.rs

@@ -137,6 +137,9 @@ fn main() -> Result<()> {
             backend.close()?;
             return Ok(());
         }
+        Some(account::args::Cmd::Configure(reset)) => {
+            return account::handlers::configure(&account_config, &backend_config, reset);
+        }
         _ => (),
     }