pongo 0.1.7

Intelligent Dorsal admin interface
Documentation
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
use std::collections::HashMap;

use crate::model::{Document, DocumentCreate, PongoError};

use dorsal::query as sqlquery;
use dorsal::utility;
use serde::{de::DeserializeOwned, Serialize};

pub type Result<T> = std::result::Result<T, PongoError>;

#[derive(Clone, Debug)]
pub struct ServerOptions {
    /// If [`Document`] storage is allowed
    pub document_store: bool,
}

impl ServerOptions {
    /// Enable all options
    pub fn truthy() -> Self {
        Self {
            document_store: true,
        }
    }
}

impl Default for ServerOptions {
    fn default() -> Self {
        Self {
            document_store: false,
        }
    }
}

/// Database connector
#[derive(Clone)]
pub struct Database {
    pub base: dorsal::StarterDatabase,
    pub auth: starstraw::Database,
    pub config: ServerOptions,
}

impl Database {
    /// Create a new [`Database`]
    pub async fn new(
        database_options: dorsal::DatabaseOpts,
        server_options: ServerOptions,
    ) -> Self {
        Self {
            base: dorsal::StarterDatabase::new(database_options).await,
            auth: starstraw::Database::new(
                starstraw::Database::env_options(),
                starstraw::ServerOptions::truthy(),
            )
            .await,
            config: server_options,
        }
    }

    /// Pull [`dorsal::DatabaseOpts`] from env
    pub fn env_options() -> dorsal::DatabaseOpts {
        use std::env::var;
        dorsal::DatabaseOpts {
            _type: match var("DB_TYPE") {
                Ok(v) => Option::Some(v),
                Err(_) => Option::None,
            },
            host: match var("DB_HOST") {
                Ok(v) => Option::Some(v),
                Err(_) => Option::None,
            },
            user: var("DB_USER").unwrap_or(String::new()),
            pass: var("DB_PASS").unwrap_or(String::new()),
            name: var("DB_NAME").unwrap_or(String::new()),
        }
    }

    /// Init database
    pub async fn init(&self) {
        // create tables
        let c = &self.base.db.client;

        if self.config.document_store == true {
            // create table to store documents
            let _ = sqlquery(
                "CREATE TABLE IF NOT EXISTS \"po_documents\" (
                    id        TEXT,
                    namespace TEXT,
                    content   TEXT,
                    timestamp TEXT,
                    metadata  TEXT
                )",
            )
            .execute(c)
            .await;
        }
    }

    // admin
    /// Fetch all results from the database for the given `query`
    pub async fn sql_fetch_all(&self, query: String) -> Result<Vec<HashMap<String, String>>> {
        let c = &self.base.db.client;
        match sqlquery(&query).fetch_all(c).await {
            Ok(r) => {
                let mut res = Vec::new();

                for row in r {
                    res.push(self.base.textify_row(row).data)
                }

                Ok(res)
            }
            Err(_) => Err(PongoError::Other),
        }
    }

    /// Execute the given `query` and return nothing
    pub async fn sql_execute(&self, query: String) -> Result<()> {
        let c = &self.base.db.client;
        match sqlquery(&query).execute(c).await {
            Ok(_) => Ok(()),
            Err(_) => Err(PongoError::Other),
        }
    }

    // documents

    /// Pull an existing document by `id`
    ///
    /// ## Arguments:
    /// * `id` - [`String`] of the document's `id` field
    /// * `namespace` - [`String`] of the namespace the document belongs to
    pub async fn pull<
        T: Serialize + DeserializeOwned + From<String>,
        M: Serialize + DeserializeOwned,
    >(
        &self,
        id: String,
        namespace: String,
    ) -> Result<Document<T, M>> {
        if self.config.document_store == false {
            return Err(PongoError::Other);
        }

        // check in cache
        match self.base.cachedb.get(format!("se_document:{}", id)).await {
            Some(c) => return Ok(serde_json::from_str::<Document<T, M>>(c.as_str()).unwrap()),
            None => (),
        };

        // pull from database
        let query: &str = if (self.base.db._type == "sqlite") | (self.base.db._type == "mysql") {
            "SELECT * FROM \"se_documents\" WHERE \"id\" = ? AND \"namespace\" = ?"
        } else {
            "SELECT * FROM \"se_documents\" WHERE \"id\" = $1 AND \"namespace\" = $2"
        };

        let c = &self.base.db.client;
        let res = match sqlquery(query)
            .bind::<&String>(&id)
            .bind::<&String>(&namespace)
            .fetch_one(c)
            .await
        {
            Ok(p) => self.base.textify_row(p).data,
            Err(_) => return Err(PongoError::NotFound),
        };

        // return
        let doc = Document {
            id: res.get("id").unwrap().to_string(),
            namespace: res.get("namespace").unwrap().to_string(),
            content: res.get("content").unwrap().to_string().into(),
            timestamp: res.get("date_published").unwrap().parse::<u128>().unwrap(),
            metadata: match serde_json::from_str(res.get("metadata").unwrap()) {
                Ok(m) => m,
                Err(_) => return Err(PongoError::ValueError),
            },
        };

        // store in cache
        self.base
            .cachedb
            .set(
                format!("se_document:{}:{}", namespace, id),
                serde_json::to_string::<Document<T, M>>(&doc).unwrap(),
            )
            .await;

        // return
        Ok(doc)
    }

    /// Create a a new document
    ///
    /// Making sure values are unique should be done before calling `push`.
    ///
    /// ## Arguments:
    /// * `props` - [`DocumentCreate`]
    ///
    /// ## Returns:
    /// * Full [`Document`]
    pub async fn push<T: ToString, M: Serialize>(
        &self,
        props: DocumentCreate<T, M>,
    ) -> Result<Document<T, M>> {
        if self.config.document_store == false {
            return Err(PongoError::Other);
        }

        // ...
        let doc = Document {
            id: utility::random_id(),
            namespace: props.namespace,
            content: props.content,
            timestamp: utility::unix_epoch_timestamp(),
            metadata: props.metadata,
        };

        // create paste
        let query: &str = if (self.base.db._type == "sqlite") | (self.base.db._type == "mysql") {
            "INSERT INTO \"se_documents\" VALUES (?, ?, ?, ?, ?)"
        } else {
            "INSERT INTO \"se_documents\" VALEUS ($1, $2, $3, $4, $5)"
        };

        let c = &self.base.db.client;
        match sqlquery(query)
            .bind::<&String>(&doc.id)
            .bind::<&String>(&doc.namespace)
            .bind::<&String>(&doc.content.to_string())
            .bind::<&String>(&doc.timestamp.to_string())
            .bind::<&String>(match serde_json::to_string(&doc.metadata) {
                Ok(ref s) => s,
                Err(_) => return Err(PongoError::ValueError),
            })
            .execute(c)
            .await
        {
            Ok(_) => return Ok(doc),
            Err(_) => return Err(PongoError::Other),
        };
    }

    /// Delete an existing document by `id`
    ///
    /// Permission checks should be done before calling `drop`.
    ///
    /// ## Arguments:
    /// * `id` - the document to delete
    /// * `namespace` - the namespace the document belongs to
    pub async fn drop<
        T: Serialize + DeserializeOwned + From<String>,
        M: Serialize + DeserializeOwned,
    >(
        &self,
        id: String,
        namespace: String,
    ) -> Result<()> {
        if self.config.document_store == false {
            return Err(PongoError::Other);
        }

        // make sure document exists
        if let Err(e) = self.pull::<T, M>(id.clone(), namespace.clone()).await {
            return Err(e);
        };

        // delete document
        let query: &str = if (self.base.db._type == "sqlite") | (self.base.db._type == "mysql") {
            "DELETE FROM \"se_documents\" WHERE \"id\" = ? AND \"namespace\" = ?"
        } else {
            "DELETE FROM \"se_documents\" WHERE \"id\" = $1 AND \"namespace\" = $2"
        };

        let c = &self.base.db.client;
        match sqlquery(query)
            .bind::<&String>(&id)
            .bind::<&String>(&namespace)
            .execute(c)
            .await
        {
            Ok(_) => {
                // remove from cache
                self.base
                    .cachedb
                    .remove(format!("se_document:{}:{}", namespace, id))
                    .await;

                // return
                return Ok(());
            }
            Err(_) => return Err(PongoError::Other),
        };
    }

    /// Edit an existing document by `id`
    ///
    /// Permission checks should be done before calling `update`.
    ///
    /// ## Arguments:
    /// * `id` - the document to edit
    /// * `namespace` - the namespace the document belongs to
    /// * `new_content` - the new content of the paste
    pub async fn update<
        T: Serialize + DeserializeOwned + From<String> + ToString,
        M: Serialize + DeserializeOwned,
    >(
        &self,
        id: String,
        namespace: String,
        new_content: String,
    ) -> Result<()> {
        if self.config.document_store == false {
            return Err(PongoError::Other);
        }

        // make sure document exists
        if let Err(e) = self.pull::<T, M>(id.clone(), namespace.clone()).await {
            return Err(e);
        };

        // edit document
        let query: &str = if (self.base.db._type == "sqlite") | (self.base.db._type == "mysql") {
            "UPDATE \"se_pastes\" SET \"content\" = ? WHERE \"url\" = ? AND \"namespace\" = ?"
        } else {
            "UPDATE \"se_pastes\" SET \"content\" = $1 WHERE \"url\" = $2 AND \"namespace\" = $3"
        };

        let c = &self.base.db.client;
        match sqlquery(query)
            .bind::<&String>(&new_content.to_string())
            .bind::<&String>(&id)
            .bind::<&String>(&namespace)
            .execute(c)
            .await
        {
            Ok(_) => {
                // remove from cache
                self.base
                    .cachedb
                    .remove(format!("se_document:{}:{}", namespace, id))
                    .await;

                // return
                return Ok(());
            }
            Err(_) => return Err(PongoError::Other),
        };
    }

    /// Edit an existing paste's metadata by `url`
    ///
    /// Permission checks should be done before calling `update`.
    ///
    /// ## Arguments:
    /// * `id` - the document to edit
    /// * `namespace` - the namespace the document belongs to    
    /// * `metadata` - the new metadata of the document
    pub async fn update_metadata<
        T: Serialize + DeserializeOwned + From<String> + ToString,
        M: Serialize + DeserializeOwned,
    >(
        &self,
        id: String,
        namespace: String,
        metadata: M,
    ) -> Result<()> {
        if self.config.document_store == false {
            return Err(PongoError::Other);
        }

        // make sure document exists
        if let Err(e) = self.pull::<T, M>(id.clone(), namespace.clone()).await {
            return Err(e);
        };

        // edit document
        let query: &str = if (self.base.db._type == "sqlite") | (self.base.db._type == "mysql") {
            "UPDATE \"se_documents\" SET \"metadata\" = ? WHERE \"url\" = ? AND \"namespace\" = ?"
        } else {
            "UPDATE \"se_documents\" SET \"metadata\" = $1 WHERE \"url\" = $2 AND \"namespace\" = $3"
        };

        let c = &self.base.db.client;
        match sqlquery(query)
            .bind::<&String>(match serde_json::to_string(&metadata) {
                Ok(ref m) => m,
                Err(_) => return Err(PongoError::ValueError),
            })
            .bind::<&String>(&id)
            .bind::<&String>(&namespace)
            .execute(c)
            .await
        {
            Ok(_) => {
                // remove from cache
                self.base
                    .cachedb
                    .remove(format!("se_document:{}:{}", namespace, id))
                    .await;

                // return
                return Ok(());
            }
            Err(_) => return Err(PongoError::Other),
        };
    }
}