[icon] showing icons in emacs

Author: fuyu0425

Cargo.lock

@@ -21,6 +21,7 @@ keepass = { path = "../libkeepass-rs" }
 lexpr = "0.2.6"
 libreauth = "0.15.0"
 log = "0.4.17"
+once_cell = "1.16.0"
 rpassword = "7.1.0"
 rustyline = "10.0.0"
 shadow-rs = "0.17.1"

Cargo.toml

@@ -12,6 +12,9 @@ Can be a proxy to call =keepassxc-cli= by the provided password.
 * TODO TOTP generation
 only some types are supported now (SHA1/6-digit code)
 
+* TODO Tag search
+Need to modify =keepass-rs= to decrypt =Tags=
+
 * TODO Emacs integration
 
 ** DONE hydra/transient
@@ -21,7 +24,8 @@ CLOSED: [2022-11-25 Fri 16:03]
 CLOSED: [2022-11-25 Fri 16:03]
 use built-in completing-read
 
-** TODO SVG icon?
+** DONE SVG icon?
+CLOSED: [2022-12-01 Thu 17:14]
 Is it possible to render SVG icons in =completing-read= buffer?
 
 ** TODO Clear kill-ring

TODOs.org

@@ -23,7 +23,17 @@
  "Face for title."
  :group 'keepass-faces)
 
-(cl-defstruct keepass-entry "Keepass Entry without password" id title username url note has-otp)
+(defcustom keepass-icon-width 16
+ "icon width"
+ :type 'number
+ :group 'keepass)
+
+(defcustom keepass-icon-height 16
+ "icon height"
+ :type 'number
+ :group 'keepass)
+
+(cl-defstruct keepass-entry "Keepass Entry without password" id title username url note has-otp icon)
 
 (defvar keepass~all-entries nil "All entries (served as a cache)")
 
@@ -229,7 +239,7 @@ debuggable (backtrace) error."
  (db-pw (password-read
  (format "Password for %s: " keepass-database)
  keepass-database))
- )
+ (args (cons "--icon" args)))
  (keepass-log 'misc "%S" args)
  (setq keepass~all-entries nil)
  (clrhash keepass~entry-map)
@@ -330,7 +340,7 @@ debuggable (backtrace) error."
 (defun keepass-list ()
  "List all entries and cache them in `keepass~all-entries'"
  (interactive)
- (unless keepass~all-entries (keepass~call "ls -f id title username url note has-otp")))
+ (unless keepass~all-entries (keepass~call "ls -f id title username url note has-otp icon")))
 
 
 (defun keepass--get (id field &optional show copy)
@@ -350,6 +360,29 @@ debuggable (backtrace) error."
  (interactive)
  (keepass--get keepass-current-selected-id field show copy))
 
+(defun keepass--format-icon (icon-path)
+ (if icon-path (propertize "<"
+ 'display
+ `(image
+ :type imagemagick
+ :file ,icon-path
+ ;; :scale 1
+ :width ,keepass-icon-width
+ :height ,keepass-icon-height
+ :format nil
+ :transform-smoothing t
+ ;; :relief 1
+ :ascent center
+ )
+ ;; 'rear-nonsticky
+ ;; '(display)
+ ;; 'front-sticky
+ ;; '(read-only)
+ ;; 'fontified
+ ;; t
+ )
+ " "))
+
 (defun keepass--format-entry (entry)
  (let* (
  (id (keepass-entry-id entry))
@@ -358,10 +391,12 @@ debuggable (backtrace) error."
  (url (keepass-entry-url entry))
  (note (keepass-entry-note entry))
  (has-otp (keepass-entry-has-otp entry))
- (item-str (format "Title: %s\nUsername: %s\nURL: %s\nNote: %s\nHas-OTP: %s"
+ (icon (keepass-entry-icon entry))
+ (item-str (format "Title: %s\nUsername: %s\nURL: %s%2s\nNote: %s\nHas-OTP: %s"
  (propertize title 'face 'font-lock-type-face)
  (propertize username 'face 'font-lock-function-name-face)
  (propertize url 'face 'font-lock-variable-name-face)
+ (keepass--format-icon icon)
  note
  (propertize (if has-otp "Yes" "No") 'face 'font-lock-warning-face)
  )))
@@ -384,7 +419,9 @@ debuggable (backtrace) error."
  (url (keepass-entry-url entry))
  (url (truncate-string-to-width url 20 0 ?\s t))
  (note (keepass-entry-note entry))
- (item-str (format "%-20s\t%-20s\t%-20s\t%s"
+ (icon (keepass-entry-icon entry))
+ (item-str (format "%s %-20s\t%-20s\t%-20s\t%s"
+ (keepass--format-icon icon)
  (propertize title 'face 'font-lock-type-face)
  ;; title
  (propertize username 'face 'font-lock-function-name-face)

keepass.el

@@ -3,29 +3,69 @@
 use anyhow::{anyhow, bail, Result};
 use clap::Parser;
 use clap_verbosity_flag::Verbosity;
+use directories::{BaseDirs, ProjectDirs, UserDirs};
 use is_terminal::IsTerminal;
-use keepass::{Database, Entry, NodeRef};
+use keepass::{Database, Entry, Icon, NodeRef};
 use lexpr::{print, sexp, Value};
 use libreauth::oath::TOTPBuilder;
+use once_cell::sync::OnceCell;
 use rustyline::error::ReadlineError;
 use rustyline::Editor;
 use std::char;
 use std::collections::BTreeMap;
+use std::fs;
 use std::fs::File;
 use std::io::Read;
 use std::io::{self, Write};
-use std::path::Path;
+use std::path::{Path, PathBuf};
 use std::time::SystemTime;
 use tracing::{debug, info};
 use tracing_core::Level;
 use tracing_subscriber::{filter, prelude::*};
 use tracing_subscriber::{fmt, prelude::*, EnvFilter};
+
 use url::Url;
 shadow_rs::shadow!(build);
 
 const COOKIE_PRE: char = 254 as char;
 const COOKIE_POST: char = 255 as char;
 
+/// project directories
+static PROJECT_DIRS: OnceCell<ProjectDirs> = OnceCell::new();
+
+fn get_project_dirs() -> &'static ProjectDirs {
+ &PROJECT_DIRS.get().unwrap()
+}
+
+fn get_data_dir() -> &'static Path {
+ &PROJECT_DIRS.get().unwrap().data_dir()
+}
+
+fn get_custom_icon_dir() -> PathBuf {
+ let data_dir = get_data_dir();
+ let custom_icon_path = data_dir.join("custom_icons");
+ custom_icon_path
+}
+
+fn get_custom_icon_path(uuid: &String) -> PathBuf {
+ let custom_icon_dir = get_custom_icon_dir();
+ let bytes = base64::decode(uuid).unwrap();
+ let new_id = base58::ToBase58::to_base58(bytes.as_slice());
+ custom_icon_dir.join(new_id)
+}
+
+fn get_builtin_icon_dir() -> PathBuf {
+ let data_dir = get_data_dir();
+ let icon_path = data_dir.join("icons");
+ icon_path
+}
+
+fn get_builtin_icon_path(id: u8) -> PathBuf {
+ let builtin_icon_dir = get_builtin_icon_dir();
+ let icon_file = format!("{:02}.{}", id, "svg");
+ builtin_icon_dir.join(icon_file)
+}
+
 #[derive(Parser, Debug, Clone)]
 #[clap(author, version, about)]
 pub struct Args {
@@ -51,6 +91,10 @@ pub struct Args {
  #[clap(long = "database", short = 'd')]
  database: Option<String>,
 
+ /// icons
+ #[clap(long = "icon", short = 'i', default_value = "false", global = true)]
+ icon: bool,
+
  #[clap(flatten)]
  verbose: clap_verbosity_flag::Verbosity,
 }
@@ -140,6 +184,7 @@ pub struct ParsedEntry {
  pub id: u64,
  pub fields: BTreeMap<String, Field>,
  pub has_otp: bool,
+ pub icon: Icon,
 }
 
 impl ParsedEntry {
@@ -154,6 +199,20 @@ impl ParsedEntry {
  values.push(Value::string(self.get_otp_code()?));
  } else if field == "has-otp" {
  values.push(Value::Bool(self.has_otp));
+ } else if field == "icon" {
+ let value = match &self.icon {
+ Icon::IconID(id) => {
+ Value::string(get_builtin_icon_path(*id).display().to_string())
+ }
+ Icon::CustomIcon(uuid) => {
+ Value::string(get_custom_icon_path(uuid).display().to_string())
+ }
+ Icon::None => {
+ // NOTE: 0 as default icon for keepassxc
+ Value::string(get_builtin_icon_path(0).display().to_string())
+ }
+ };
+ values.push(value);
  } else {
  let val = self.fields.get(field);
  if let Some(v) = val {
@@ -290,9 +349,11 @@ impl TryFrom<&Entry> for ParsedEntry {
  fields.insert(f.index(), f);
  }
  }
+ let mut icon = e.icon.clone();
  Ok(Self {
  fields,
  has_otp,
+ icon,
  ..Default::default()
  })
  }
@@ -384,6 +445,25 @@ impl<'a, 'b> KPClient<'a> {
  }
  }
 
+ pub fn load_icons(&'a self) -> Result<()> {
+ let custom_icon_path = get_custom_icon_dir();
+ debug!("cicon {custom_icon_path:#?}");
+ fs::create_dir_all(&custom_icon_path)?;
+ for (uuid, icon_data) in self.db_manager.db.meta.custom_icons.iter() {
+ // uuid is base64, which is not good!
+ // transform it to base58 instead; can also be base62
+ let bytes = base64::decode(uuid).unwrap();
+ let new_id = base58::ToBase58::to_base58(bytes.as_slice());
+ debug!("old {uuid} new {new_id}");
+ let image_path = custom_icon_path.join(&new_id);
+ if !image_path.try_exists()? {
+ let icon_bytes = base64::decode(icon_data).unwrap();
+ fs::write(image_path, icon_bytes);
+ }
+ }
+ Ok(())
+ }
+
  pub fn do_list(
  &'a self,
  fields: &Option<Vec<String>>,
@@ -445,7 +525,7 @@ pub struct DatabaseManager<'a> {
 impl<'a> DatabaseManager<'a> {
  pub fn new(path: &'a Path, password: String) -> Result<Self> {
  let db = Database::open(&mut File::open(path)?, Some(password.as_str()), None)?;
- debug!("{:#?}", &db);
+ // debug!("{:#?}", &db);
  // std::process::exit(0);
  Ok(Self { path, password, db })
  }
@@ -462,6 +542,10 @@ impl<'a> DatabaseManager<'a> {
 }
 
 fn main() -> Result<()> {
+ if let Some(proj_dirs) = ProjectDirs::from("", "", "keepass-cli") {
+ PROJECT_DIRS.set(proj_dirs).unwrap();
+ }
+
  let args = Args::parse();
 
  let filter = filter::Targets::new()
@@ -499,6 +583,11 @@ fn main() -> Result<()> {
  db_manager.reload();
  let mut kp_client = KPClient::new(&db_manager)?;
 
+ if args.icon {
+ kp_client.load_icons();
+ // return Ok(());
+ }
+
  match &args.action {
  Action::List { fields } => {
  kp_client.reload();