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
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/store/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/store)
//!
//! Simple, persistent key-value store.

#![doc(
    html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png",
    html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png"
)]

pub use error::{Error, Result};
use log::warn;
use serde::Serialize;
pub use serde_json::Value as JsonValue;
use std::{
    collections::HashMap,
    path::{Path, PathBuf},
    sync::Mutex,
};
pub use store::{Store, StoreBuilder};
use tauri::{
    plugin::{self, TauriPlugin},
    AppHandle, Manager, RunEvent, Runtime, State,
};

mod error;
mod store;

#[cfg(mobile)]
mod mobile;
#[cfg(mobile)]
use crate::plugin::PluginHandle;
#[cfg(target_os = "android")]
const PLUGIN_IDENTIFIER: &str = "app.tauri.store";
#[cfg(target_os = "ios")]
tauri::ios_plugin_binding!(init_plugin_store);

#[cfg(desktop)]
mod desktop;

#[derive(Serialize, Clone)]
struct ChangePayload<'a> {
    path: &'a Path,
    key: &'a str,
    value: &'a JsonValue,
}

pub struct StoreCollection<R: Runtime> {
    stores: Mutex<HashMap<PathBuf, Store<R>>>,
    frozen: bool,

    #[cfg(mobile)]
    mobile_plugin_handle: PluginHandle<R>,
}

pub fn with_store<R: Runtime, T, F: FnOnce(&mut Store<R>) -> Result<T>>(
    app: AppHandle<R>,
    collection: State<'_, StoreCollection<R>>,
    path: impl AsRef<Path>,
    f: F,
) -> Result<T> {
    let mut stores = collection.stores.lock().expect("mutex poisoned");

    let path = path.as_ref();
    if !stores.contains_key(path) {
        if collection.frozen {
            return Err(Error::NotFound(path.to_path_buf()));
        }

        #[allow(unused_mut)]
        let mut builder = StoreBuilder::new(path);

        #[cfg(mobile)]
        {
            builder = builder.mobile_plugin_handle(collection.mobile_plugin_handle.clone());
        }

        let mut store = builder.build(app);

        // ignore loading errors, just use the default
        if let Err(err) = store.load() {
            warn!(
                "Failed to load store {:?} from disk: {}. Falling back to default values.",
                path, err
            );
        }
        stores.insert(path.to_path_buf(), store);
    }

    f(stores
        .get_mut(path)
        .expect("failed to retrieve store. This is a bug!"))
}

#[tauri::command]
async fn set<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
    key: String,
    value: JsonValue,
) -> Result<()> {
    with_store(app, stores, path, |store| store.insert(key, value))
}

#[tauri::command]
async fn get<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
    key: String,
) -> Result<Option<JsonValue>> {
    with_store(app, stores, path, |store| Ok(store.get(key).cloned()))
}

#[tauri::command]
async fn has<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
    key: String,
) -> Result<bool> {
    with_store(app, stores, path, |store| Ok(store.has(key)))
}

#[tauri::command]
async fn delete<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
    key: String,
) -> Result<bool> {
    with_store(app, stores, path, |store| store.delete(key))
}

#[tauri::command]
async fn clear<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<()> {
    with_store(app, stores, path, |store| store.clear())
}

#[tauri::command]
async fn reset<R: Runtime>(
    app: AppHandle<R>,
    collection: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<()> {
    with_store(app, collection, path, |store| store.reset())
}

#[tauri::command]
async fn keys<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<Vec<String>> {
    with_store(app, stores, path, |store| {
        Ok(store.keys().cloned().collect())
    })
}

#[tauri::command]
async fn values<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<Vec<JsonValue>> {
    with_store(app, stores, path, |store| {
        Ok(store.values().cloned().collect())
    })
}

#[tauri::command]
async fn entries<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<Vec<(String, JsonValue)>> {
    with_store(app, stores, path, |store| {
        Ok(store
            .entries()
            .map(|(k, v)| (k.to_owned(), v.to_owned()))
            .collect())
    })
}

#[tauri::command]
async fn length<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<usize> {
    with_store(app, stores, path, |store| Ok(store.len()))
}

#[tauri::command]
async fn load<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<()> {
    with_store(app, stores, path, |store| store.load())
}

#[tauri::command]
async fn save<R: Runtime>(
    app: AppHandle<R>,
    stores: State<'_, StoreCollection<R>>,
    path: PathBuf,
) -> Result<()> {
    with_store(app, stores, path, |store| store.save())
}

// #[derive(Default)]
pub struct Builder<R: Runtime> {
    stores: HashMap<PathBuf, Store<R>>,
    frozen: bool,
}

impl<R: Runtime> Default for Builder<R> {
    fn default() -> Self {
        Self {
            stores: Default::default(),
            frozen: false,
        }
    }
}

impl<R: Runtime> Builder<R> {
    pub fn new() -> Self {
        Self::default()
    }

    /// Registers a store with the plugin.
    ///
    /// # Examples
    ///
    /// ```
    /// use tauri_plugin_store::{StoreBuilder, Builder};
    ///
    /// tauri::Builder::default()
    ///   .setup(|app| {
    ///     let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    ///     let builder = Builder::default().store(store);
    ///     Ok(())
    ///   });
    /// ```
    pub fn store(mut self, store: Store<R>) -> Self {
        self.stores.insert(store.path.clone(), store);
        self
    }

    /// Registers multiple stores with the plugin.
    ///
    /// # Examples
    ///
    /// ```
    /// use tauri_plugin_store::{StoreBuilder, Builder};
    ///
    /// tauri::Builder::default()
    ///   .setup(|app| {
    ///     let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    ///     let builder = Builder::default().stores([store]);
    ///     Ok(())
    ///   });
    /// ```
    pub fn stores<T: IntoIterator<Item = Store<R>>>(mut self, stores: T) -> Self {
        self.stores = stores
            .into_iter()
            .map(|store| (store.path.clone(), store))
            .collect();
        self
    }

    /// Freezes the collection.
    ///
    /// This causes requests for plugins that haven't been registered to fail
    ///
    /// # Examples
    ///
    /// ```
    /// use tauri_plugin_store::{StoreBuilder, Builder};
    ///
    /// tauri::Builder::default()
    ///   .setup(|app| {
    ///     let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    ///     app.handle().plugin(Builder::default().freeze().build());
    ///     Ok(())
    ///   });
    /// ```
    pub fn freeze(mut self) -> Self {
        self.frozen = true;
        self
    }

    /// Builds the plugin.
    ///
    /// # Examples
    ///
    /// ```
    /// use tauri_plugin_store::{StoreBuilder, Builder};
    ///
    /// tauri::Builder::default()
    ///   .setup(|app| {
    ///     let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    ///     app.handle().plugin(Builder::default().build());
    ///     Ok(())
    ///   });
    /// ```
    pub fn build(mut self) -> TauriPlugin<R> {
        plugin::Builder::new("store")
            .invoke_handler(tauri::generate_handler![
                set, get, has, delete, clear, reset, keys, values, length, entries, load, save
            ])
            .setup(move |app_handle, _api| {
                for (path, store) in self.stores.iter_mut() {
                    // ignore loading errors, just use the default
                    if let Err(err) = store.load() {
                        warn!(
              "Failed to load store {:?} from disk: {}. Falling back to default values.",
              path, err
            );
                    }
                }

                #[cfg(target_os = "android")]
                let handle = _api.register_android_plugin(PLUGIN_IDENTIFIER, "StorePlugin")?;
                #[cfg(target_os = "ios")]
                let handle = _api.register_ios_plugin(init_plugin_store)?;

                app_handle.manage(StoreCollection {
                    stores: Mutex::new(self.stores),
                    frozen: self.frozen,

                    #[cfg(mobile)]
                    mobile_plugin_handle: handle,
                });

                Ok(())
            })
            .on_event(|app_handle, event| {
                if let RunEvent::Exit = event {
                    let collection = app_handle.state::<StoreCollection<R>>();

                    for store in collection.stores.lock().expect("mutex poisoned").values() {
                        if let Err(err) = store.save() {
                            eprintln!("failed to save store {:?} with error {:?}", store.path, err);
                        }
                    }
                }
            })
            .build()
    }
}