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 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
|
use clap::ArgMatches;
use clap_complete::Shell::*;
use regex::Regex;
use rusqlite::Error;
use crate::config::ConfigOptions;
use crate::graph::{vizk, zk_graph_dot_output, zk_graph_json_output};
use crate::zettel::strip_multiple_whitespace;
use crate::Database;
use crate::Zettel;
use crate::cli;
use crate::io::{abs_path, file_exists};
/// A printer that prints. Because it's convenient.
struct Printer
{
zettel: Vec<Zettel>,
additional: Vec<String>,
// Print according to a certain format, replacing the following placeholder tokens
//
// %t - title
// %p - project
// %P - path
// %l - (forward) links
// %b - backlinks
// %a - contents of the `additional` field (--text flag fills this with the matched pattern)
format: String,
link_separator: String,
}
impl Printer
{
fn set_zettelkasten(&mut self, new_zettel: Vec<Zettel>)
{
self.zettel = new_zettel;
}
fn set_additional(&mut self, new_additional: Vec<String>)
{
self.additional = new_additional;
}
fn set_format(&mut self, new_format: String)
{
self.format = new_format;
}
fn set_link_separator(&mut self, new_separator: String)
{
self.link_separator = new_separator;
}
fn print_one(&mut self, cfg: &ConfigOptions, zettel: Zettel)
{
self.zettel = vec![zettel];
self.print(cfg);
}
/// Abracadabra, yadda yadda. Print everything properly.
fn print(&mut self, cfg: &ConfigOptions)
{
// basically. since there's a `zip()` call, if the `additional` vector is smaller in length
// than the `zettel` vector, then some things won't get printed.
// this really only makes sure that everything gets printed
let len_diff = self.zettel.len() - self.additional.len();
let mut empty_diff = vec!["".to_string(); len_diff];
self.additional.append(&mut empty_diff);
let mut zip = self.zettel.iter().zip(&self.additional).collect::<Vec<_>>();
zip.sort_by(|a, b| a.partial_cmp(b).unwrap());
for (z, a) in zip {
let mut result = self.format.to_string();
result = result.replace("%t", &z.title);
result = result.replace("%p", &z.project);
result = result.replace("%P", &z.filename(cfg));
result = result.replace("%l", &z.links.join(&self.link_separator));
result = result.replace("%a", a);
result = result.replace("%b", &z.backlinks.join(&self.link_separator));
println!("{}", result);
}
}
}
impl Default for Printer
{
fn default() -> Printer
{
Printer {
zettel: vec![],
additional: vec![],
format: "[%p] %t".to_string(),
link_separator: "|".to_string(),
}
}
}
pub fn sync(matches: &ArgMatches, cfg: &ConfigOptions) -> Result<(), Error>
{
Database::new(&cfg.db_file())?.init()?;
let project = realproject(if let Some(p) = matches.get_one::<String>("PROJECT") {
p
} else {
""
});
if let Some(title) = matches.get_one::<String>("CREATE") {
create(cfg, title, project)?;
} else if let Some(path) = matches.get_one::<String>("UPDATE") {
update(cfg, path)?;
} else if let Some(title) = matches.get_one::<String>("MOVE") {
mv(cfg, title, project)?;
} else if matches.contains_id("RENAME") {
let args = matches
.get_many::<String>("RENAME")
.unwrap_or_default()
.map(|a| a.to_string())
.collect::<Vec<String>>();
rename(cfg, &args[0], &args[1])?;
} else if matches.get_flag("GENERATE") {
generate(cfg)?;
}
Ok(())
}
/// Query the database, applying various filters if proivded
pub fn query(matches: &ArgMatches, cfg: &ConfigOptions) -> Result<(), Error>
{
let db = Database::new(&cfg.db_file())?;
db.init()?;
let mut zs: Vec<Zettel> = db.all()?;
let mut printer = Printer::default();
let exact = matches.get_flag("EXACT_MATCH");
if let Some(title) = matches.get_one::<String>("TITLE") {
zs = filter_title(zs, title, exact);
}
if let Some(project) = matches.get_one::<String>("PROJECT") {
zs = filter_project(zs, realproject(project), exact);
}
if let Some(tag) = matches.get_one::<String>("TAG") {
zs = filter_tag(zs, tag, exact);
}
if let Some(linked_from) = matches.get_one::<String>("LINKS") {
zs = intersect(&zs, &fwlinks(&db.all()?, linked_from, exact));
}
if let Some(links_to) = matches.get_one::<String>("BACKLINKS") {
zs = intersect(&zs, &backlinks(&zs, links_to, exact));
}
if let Some(text) = matches.get_one::<String>("TEXT_REGEX") {
let vs = filter_text(zs.clone(), text, cfg);
let mut texts: Vec<String> = vec![];
let mut found = vec![];
// maybe speed this up by using unzip? I digress
for (z, t) in vs {
found.push(z);
texts.push(t);
}
printer.set_additional(texts);
zs = intersect(&zs, &found);
}
if matches.get_flag("LONERS") {
zs = filter_isolated(zs);
}
if let Some(graph) = matches.get_one::<String>("GRAPH") {
match graph.as_str() {
"vizk" => vizk(&zs),
"dot" => zk_graph_dot_output(&zs),
"json" => zk_graph_json_output(&zs),
_ => {
eprintln!(
"error: expected one of 'json', 'dot', 'vizk' (got: '{}')",
graph
);
}
}
return Ok(());
}
if let Some(format) = matches.get_one::<String>("FORMAT") {
let link_sep = matches.get_one::<&str>("LINK_SEP").unwrap_or(&" | ");
printer.set_format(replace_literals(format));
printer.set_link_separator(replace_literals(link_sep));
}
printer.set_zettelkasten(zs);
printer.print(cfg);
Ok(())
}
fn replace_literals(s: &str) -> String
{
s.replace(r"\n", "\n").replace(r"\t", "\t")
}
/// Print things that aren't directly related to notes.
pub fn ls(matches: &ArgMatches, cfg: &ConfigOptions) -> Result<(), Error>
{
let db = Database::new(&cfg.db_file())?;
db.init()?;
let obj = if let Some(m) = matches.get_one::<String>("OBJECT") {
m
} else {
""
};
// TODO: maybe implement word suggestion? actually, that'd be quite useless
match obj {
"tags" => print_list_of_strings(&db.list_tags()?),
"ghosts" => print_list_of_strings(&db.zettel_not_yet_created()?),
"projects" => print_list_of_strings(&db.list_projects()?),
"path" => println!("{}", cfg.zettelkasten),
_ => eprintln!(
"error: expected one of: 'tags', 'ghosts', 'projects', 'path'; got '{}'",
obj
),
}
Ok(())
}
/// Generate completions for a shell
pub fn compl(matches: &ArgMatches) -> Result<(), Error>
{
let shell = matches.get_one::<String>("SHELL").unwrap();
let sh = match shell.as_str() {
"zsh" => Some(Zsh),
"bash" => Some(Bash),
"fish" => Some(Fish),
_ => None,
// Note that Nushell is handled separately since the Enum types don't match
};
if let Some(sh) = sh {
let app = &mut cli::build();
clap_complete::generate(sh, app, app.get_name().to_string(), &mut std::io::stdout());
} else {
eprintln!("error: '{}' isn't a (supported) shell", shell);
}
Ok(())
}
/// Print every element in the list of Strings on an individual line
fn print_list_of_strings(elems: &[String])
{
let mut sorted = elems.to_vec();
sorted.sort();
sorted.iter().for_each(|e| {
println!("{}", e);
})
}
/// Keep only those Zettel whose title matches the provided regex
fn filter_title(zs: Vec<Zettel>, pattern: &str, exact: bool) -> Vec<Zettel>
{
let re = Regex::new(&format!("^{}$", pattern)).unwrap();
zs.into_iter()
.filter(|z| {
if exact {
pattern == z.title
} else {
re.is_match(&z.title)
}
})
.collect()
}
/// Keep only those Zettel whose project matches the provided regex
fn filter_project(zs: Vec<Zettel>, pattern: &str, exact: bool) -> Vec<Zettel>
{
let re = Regex::new(&format!("^{}$", pattern)).unwrap();
zs.into_iter()
.filter(|z| {
if exact {
pattern == z.project
} else {
re.is_match(&z.project)
}
})
.collect()
}
/// Keep only those Zettel that contain the pattern in their text
fn filter_text(zs: Vec<Zettel>, pattern: &str, cfg: &ConfigOptions) -> Vec<(Zettel, String)>
{
zs.into_iter()
.map(|z| (z.clone(), z.find_pattern(cfg, pattern)))
.filter(|(_, t)| !t.is_empty())
.collect()
}
/// Keep only those Zettel that have at least one tag (or subtag) that matches the regex
fn filter_tag(zs: Vec<Zettel>, pattern: &str, exact: bool) -> Vec<Zettel>
{
let re = Regex::new(&format!("^{}(/.*)?$", pattern)).unwrap();
zs.into_iter()
.filter(|z| {
for tag in &z.tags {
if pattern == tag || (!exact && re.is_match(tag)) {
return true;
};
}
false
})
.collect()
}
/// Keep only those Zettel that neither link to other notes, nor have links pointing to them
fn filter_isolated(zs: Vec<Zettel>) -> Vec<Zettel>
{
zs.into_iter()
.filter(|z| z.links.is_empty() && z.backlinks.is_empty())
.collect()
}
/// Keep only the Zettel that are both in A and B
fn intersect<T: Eq + Clone>(a: &[T], b: &[T]) -> Vec<T>
{
a.to_owned()
.iter()
.cloned()
.filter(|z| b.contains(z))
.collect::<Vec<_>>()
}
/// Return all the Zettel that are linked to by the pattern-matched zettel
fn fwlinks(all: &[Zettel], linked_from: &str, exact: bool) -> Vec<Zettel>
{
// first find the Zettel that match the query, then find the notes that have been linked to by
// them
let fwlinks = &filter_title(all.to_owned(), linked_from, exact);
all.iter()
.cloned()
.filter(|z| {
for fw in fwlinks {
if fw.links.contains(&z.title) {
return true;
}
}
false
})
.collect()
}
/// Return all the Zettel that link to the given title/pattern, within the provided list of Zettel
fn backlinks(all: &[Zettel], links_to: &str, exact: bool) -> Vec<Zettel>
{
let re = Regex::new(&format!("^{}$", links_to)).unwrap();
all.iter()
.cloned()
.filter(|z| {
for l in z.links.clone() {
if links_to == l || (!exact && re.is_match(&l)) {
return true;
};
}
false
})
.collect()
}
/// Based on the CLI arguments and the config options, *maybe* add a new entry to the database
fn create(cfg: &ConfigOptions, title: &str, project: &str) -> Result<(), Error>
{
let db = Database::new(&cfg.db_file())?;
let actual_title = strip_multiple_whitespace(title);
let zettel = Zettel::new(&actual_title, project);
if actual_title != title {
eprintln!("warning: truncating newlines, tabs and/or multiple consecutive whitespaces");
}
// reject bad formats
if zettel.title.is_empty() || zettel.title.starts_with('.') {
eprintln!("error: empty/dotfile titles are not accepted");
return Ok(());
}
let exists_in_fs = file_exists(&zettel.filename(cfg));
let exists_in_db = db.find_by_title(&zettel.title)?.len() == 1;
// If the corresponding file exists and there's an entry in the database, abort.
// If there's an entry in the database but no corresponding file, replace the database entry
// If there's a file but there's no entry in the database, create an entry.
// Otherwise, create a new file from template and add a database entry.
if exists_in_fs && exists_in_db {
eprintln!("error: couldn't create new Zettel: one with the same title already exists");
return Ok(());
} else if !exists_in_fs && exists_in_db {
eprintln!("Zettel exists in the database but not on the filesystem; replaced entry");
db.delete(&zettel)?;
// saved outside of the loop
} else if exists_in_fs && !exists_in_db {
eprintln!("Zettel exists on the filesystem but not in the database; added entry");
// saved outside of the loop
} else {
zettel.create(cfg);
Printer::default().print_one(cfg, zettel.clone());
}
db.save(&zettel)?;
Ok(())
}
/// Rename a note, but keep it in the same project
fn rename(cfg: &ConfigOptions, old_title: &str, new_title: &str) -> Result<(), Error>
{
let db = Database::new(&cfg.db_file())?;
if old_title == new_title {
eprintln!(
"error: old title is the same as the new title ('{}'), so no rename",
old_title
);
return Ok(());
}
let results = db.find_by_title(old_title)?;
let old_zettel = if results.first().is_none() {
eprintln!("error: no Zettel with that title");
return Ok(());
} else {
results.first().unwrap()
};
let new_zettel = Zettel::new(new_title, &old_zettel.project);
if !file_exists(&old_zettel.filename(cfg)) {
eprintln!("error: the Zettel does not exist on the filesystem");
db.delete(&old_zettel)?;
return Ok(());
}
let exists_in_db = db.find_by_title(new_title)?.first().is_some();
let exists_in_fs = file_exists(&new_zettel.filename(cfg));
if exists_in_db || exists_in_fs {
eprintln!("error: a note with the new title already exists: won't overwrite");
return Ok(());
}
let mut dial = dialoguer::Confirm::new();
let prompt = dial.with_prompt(format!("{} --> {}", old_title, new_title));
// If the user confirms, change the note's title, and update the links to this Zettel
if prompt.interact().unwrap_or_default() {
crate::io::rename(&old_zettel.filename(cfg), &new_zettel.filename(cfg));
db.change_title(old_zettel, new_title).unwrap();
// It's not enough that we renamed the file. We need to update all references to it!
let backlinks = backlinks(&db.all()?, old_title, true);
backlinks.iter().for_each(|bl| {
let contents = crate::io::file_to_string(&bl.filename(cfg));
// The link might span over multiple lines. We must account for that
let regex_string = &format!(r"\[\[{}\]\]", old_title).replace(' ', r"[\n\t ]");
let old_title_reg = Regex::new(regex_string).unwrap();
let new_contents = old_title_reg.replace_all(&contents, format!(r"[[{}]]", new_title));
crate::io::write_to_file(&bl.filename(cfg), &new_contents);
db.update(cfg, bl).unwrap();
})
}
Ok(())
}
/// Move all matching notes into a project
fn mv(cfg: &ConfigOptions, pattern: &str, project: &str) -> Result<(), Error>
{
let db = Database::new(&cfg.db_file())?;
let re = Regex::new(pattern).unwrap();
let zs: Vec<Zettel> = db
.all()?
.into_iter()
.filter(|z| re.is_match(&z.title))
.collect();
let mut printer = Printer::default();
printer.set_zettelkasten(zs.clone());
printer.print(cfg);
let mut dial = dialoguer::Confirm::new();
let prompt = dial.with_prompt(format!(
">> These notes will be transferred to the {}. Proceed?",
if project.is_empty() {
"main zettelkasten".to_string()
} else {
format!("'{}' project", project)
}
));
// If the user confirms, change the notes' projects, both the system path and in database
if prompt.interact().unwrap_or_default() {
crate::io::mkdir(&format!("{}/{}", cfg.zettelkasten, project));
let new_notes = zs.iter().map(|z| Zettel {
title: z.title.clone(),
project: project.to_string(),
links: z.links.clone(),
backlinks: z.backlinks.clone(),
tags: z.tags.clone(),
});
let pairs = zs.iter().zip(new_notes);
pairs.for_each(|(old, new)| {
crate::io::rename(&old.filename(cfg), &new.filename(cfg));
db.change_project(old, project).unwrap();
});
}
Ok(())
}
/// Update the metadata of a file
fn update(cfg: &ConfigOptions, path: &str) -> Result<(), Error>
{
let db = Database::new(&cfg.db_file())?;
let path_abs = abs_path(path);
if file_exists(&path_abs) {
let zettel = Zettel::from_file(cfg, &path_abs);
if file_exists(&zettel.filename(cfg)) {
db.update(cfg, &zettel)?;
} else {
eprintln!("error: file is not in the Zettelkasten");
}
} else {
eprintln!("error: provided path isn't a file");
}
Ok(())
}
/// (Re)generate the database file
fn generate(cfg: &ConfigOptions) -> Result<(), Error>
{
let start = std::time::Instant::now();
let mem_db = Database::new_in_memory(&cfg.db_file())?;
mem_db.init()?;
mem_db.generate(cfg)?;
mem_db.write_to(&cfg.db_file())?;
println!(
"database generated successfully, took {}ms",
start.elapsed().as_millis()
);
Ok(())
}
/// Given a project name-alias, return the real project's name
/// Note how `main` is an alias for the main Zettelkasten, whose real project is `` (empty string)
fn realproject(project: &str) -> &str
{
match project {
"main" | "" => "", // main project
any => any, // any other project
}
}
|