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
use rusqlite::{named_params, Connection, DatabaseName, Error, Result, Row};
use crate::{config::ConfigOptions, str_to_vec, zettel::Zettel};
use rayon::prelude::*;
impl Zettel
{
/// Construct a Zettel from an entry in the database metadata
/// Return an Error if the `row` was invalid
fn from_db(row: &Row) -> Result<Zettel, rusqlite::Error>
{
let title: String = row.get(0)?;
let project: String = row.get(1)?;
let links: String = row.get(2)?;
let tags: String = row.get(3)?;
let mut z = Zettel::new(&title, &project);
z.links = str_to_vec(&links);
z.tags = str_to_vec(&tags);
Ok(z)
}
}
pub struct Database
{
name: String,
conn: Connection,
}
impl Database
{
/// Create a `Database` interface to an SQLite database
/// Return an Error if the connection couldn't be made
pub fn new(name: &str) -> Result<Self, Error>
{
Ok(Database { name: name.to_string(),
conn: Connection::open(name)? })
}
/// Create a `Database` interface to a named SQLite database, opened in memory
/// Return an Error if the connection couldn't be made
pub fn in_memory(name: &str) -> Result<Self, Error>
{
let uri = &format!("file:{}?mode=memory&cache=shared", name);
Ok(Database { name: name.to_string(),
conn: Connection::open(uri)? })
}
/// Initialise the current Database with a `zettelkasten` table that holds the properties of
/// `Zettel`s, if it doesn't exist already
/// Return an Error if this wasn't possible
pub fn init(&self) -> Result<(), Error>
{
self.conn.execute(
"CREATE TABLE IF NOT EXISTS zettelkasten (
title TEXT NOT NULL,
project TEXT,
links TEXT,
tags TEXT,
UNIQUE(title, project)
)",
[],
)?;
Ok(())
}
/// Save current Database to `path`
/// Return an Error if this wasn't possible
pub fn write_to(&self, path: &str) -> Result<(), Error>
{
self.conn.backup(DatabaseName::Main, path, None)?;
Ok(())
}
/// Save a Zettel's metadata to the database
pub fn save(&self, zettel: &Zettel) -> Result<(), Error>
{
let links = crate::vec_to_str(&zettel.links);
let tags = crate::vec_to_str(&zettel.tags);
self.conn.execute(
"INSERT INTO zettelkasten (title, project, links, tags) values (?1, ?2, ?3, ?4)",
&[&zettel.title, &zettel.project, &links, &tags],
)?;
Ok(())
}
/// Delete a Zettel's metadata from the database
pub fn delete(&self, zettel: &Zettel) -> Result<(), Error>
{
self.conn
.execute("DELETE FROM zettelkasten WHERE title=?1 AND project=?2",
&[&zettel.title, &zettel.project])?;
Ok(())
}
/// Return all Zettel in the database
/// Return an Error if the data in a row couldn't be accessed or if the database was
/// unreachable
pub fn all(&self) -> Result<Vec<Zettel>, Error>
{
let mut stmt = self.conn.prepare("SELECT * FROM zettelkasten")?;
let mut rows = stmt.query([])?;
let mut results: Vec<Zettel> = Vec::new();
while let Some(row) = rows.next()? {
let zettel = Zettel::from_db(row)?;
results.push(zettel);
}
Ok(results)
}
/// Search in the database for the Zettels whose `title` property matches `pattern`, and return
/// them
/// Return an Error if the databases was unreachable.
///
/// `pattern` uses SQL pattern syntax, e.g. `%` to match zero or more characters.
pub fn find_by_title(&self, pattern: &str) -> Result<Vec<Zettel>, Error>
{
let mut stmt = self.conn
.prepare("SELECT * FROM zettelkasten WHERE title LIKE :pattern")?;
let mut rows = stmt.query(named_params! {":pattern": pattern})?;
let mut results: Vec<Zettel> = Vec::new();
while let Some(row) = rows.next()? {
let zettel = Zettel::from_db(row)?;
results.push(zettel);
}
Ok(results)
}
/// Return a list of all unique tags found in the database
///
/// Return an Error if the database was unreachable
pub fn list_tags(&self) -> Result<Vec<String>, Error>
{
let mut stmt = self.conn.prepare("SELECT tags FROM zettelkasten")?;
let mut rows = stmt.query([])?;
let mut results: Vec<String> = Vec::new();
while let Some(row) = rows.next()? {
let tags: String = row.get(0)?;
for tag in str_to_vec(&tags) {
results.push(tag);
}
}
results.par_sort();
results.dedup();
Ok(results)
}
/// Return a list of all unique project names found in the database
///
/// Return an Error if the database was unreachable
pub fn list_projects(&self) -> Result<Vec<String>, Error>
{
let mut stmt = self.conn.prepare("SELECT project FROM zettelkasten")?;
let mut rows = stmt.query([])?;
let mut results: Vec<String> = Vec::new();
while let Some(row) = rows.next()? {
let project: String = row.get(0)?;
if !project.is_empty() {
results.push(project);
}
}
results.par_sort();
results.dedup();
Ok(results)
}
/// Search in the database for Zettel that have been linked to, but don't yet exist
/// Return an Error if the database was unreachable or if the data in a Row couldn't have been
/// accessed
pub fn zettel_not_yet_created(&self) -> Result<Vec<String>>
{
let mut stmt = self.conn.prepare("SELECT links FROM zettelkasten")?;
let mut rows = stmt.query([])?;
let mut unique_links: Vec<String> = Vec::new();
while let Some(row) = rows.next()? {
let links_str: String = row.get(0)?;
let links = str_to_vec(&links_str);
unique_links.extend(links);
}
unique_links.par_sort();
unique_links.dedup();
Ok(unique_links.into_iter()
.filter(|link| {
// if the response was empty, then nothing has been found, meaning it doesn't exist
// in the database
self.find_by_title(link).unwrap().is_empty()
})
.collect())
}
/// Look for Markdown files in the Zettelkasten directory and populate the database with their
/// metadata
pub fn generate(&self, cfg: &ConfigOptions)
{
let db_name = &self.name;
let mut directories = crate::io::list_subdirectories(&cfg.zettelkasten);
directories.push(cfg.zettelkasten.clone());
directories.par_iter().for_each(|dir| {
let notes: Vec<String> =
// don't add markdown file that starts with a dot (which
// includes the empty title file, the '.md')
crate::io::list_md_files(dir).into_iter()
.filter(|f| {
!crate::io::basename(f).starts_with('.')
})
.collect();
notes.par_iter().for_each(|note| {
let thread_db =
Self::in_memory(db_name).unwrap();
let thread_zettel =
Zettel::from_file(cfg, note);
thread_db.save(&thread_zettel).unwrap();
});
});
}
/// Update the metadata for a given Zettel. The specified path *must* exist
/// Not practical for a bunch of Zettel. Use `generate` instead.
pub fn update(&self, cfg: &ConfigOptions, zettel: &Zettel) -> Result<(), Error>
{
self.delete(zettel)?;
let z = &Zettel::from_file(cfg, &zettel.filename(cfg));
self.save(z)?;
Ok(())
}
/// Change the project of the given Zettel within the database
pub fn change_project(&self, zettel: &Zettel, new_project: &str) -> Result<(), Error>
{
self.conn
.execute("UPDATE zettelkasten SET project=?1 WHERE title=?2 AND project=?3",
&[new_project, &zettel.title, &zettel.project])?;
Ok(())
}
/// Change the title of the given Zettel within the database
pub fn change_title(&self, zettel: &Zettel, new_title: &str) -> Result<(), Error>
{
self.conn
.execute("UPDATE zettelkasten SET title=?1 WHERE title=?2 AND project=?3",
&[new_title, &zettel.title, &zettel.project])?;
Ok(())
}
}