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
/*
 * Copyright 2019-2020 Garrett Powell
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#![cfg(feature = "store-sqlite")]

use std::path::{Path, PathBuf};

use rusqlite::{params, Connection, OptionalExtension};
use uuid::Uuid;

use lazy_static::lazy_static;

use crate::store::common::{DataStore, Open, OpenOption};

lazy_static! {
    /// A UUID which acts as the version ID of the store format.
    static ref CURRENT_VERSION: Uuid =
        Uuid::parse_str("08d14eb8-4156-11ea-8ec7-a31cc3dfe2e4").unwrap();
}

/// A `DataStore` which stores data in a SQLite database.
pub struct SqliteStore {
    /// The connection to the SQLite database.
    connection: Connection,
}

impl SqliteStore {
    /// Create a new `SqliteStore` at the given `path`.
    fn create_new(path: impl AsRef<Path>) -> crate::Result<Self> {
        if path.as_ref().exists() {
            return Err(crate::Error::AlreadyExists);
        }

        let connection = Connection::open(&path).map_err(anyhow::Error::from)?;

        connection
            .execute_batch(
                r#"
                    CREATE TABLE Blocks (
                        uuid BLOB PRIMARY KEY,
                        data BLOB NOT NULL
                    );
                    
                    CREATE TABLE Metadata (
                        key TEXT PRIMARY KEY,
                        value BLOB NOT NULL
                    );
                "#,
            )
            .map_err(anyhow::Error::from)?;

        connection
            .execute(
                r#"
                    INSERT INTO Metadata (key, value)
                    VALUES ('version', ?1);
                "#,
                params![&CURRENT_VERSION.as_bytes()[..]],
            )
            .map_err(anyhow::Error::from)?;

        Ok(SqliteStore { connection })
    }

    /// Open an existing `SqliteStore` at the given `path`.
    fn open_existing(path: impl AsRef<Path>) -> crate::Result<Self> {
        if !path.as_ref().is_file() {
            return Err(crate::Error::NotFound);
        }

        let connection = Connection::open(&path).map_err(anyhow::Error::from)?;

        let version_bytes: Vec<u8> = connection
            .query_row(
                r#"
                    SELECT value FROM Metadata
                    WHERE key = 'version';
                "#,
                params![],
                |row| row.get(0),
            )
            .map_err(|_| crate::Error::UnsupportedFormat)?;
        let version = Uuid::from_slice(version_bytes.as_slice())
            .map_err(|_| crate::Error::UnsupportedFormat)?;

        if version != *CURRENT_VERSION {
            return Err(crate::Error::UnsupportedFormat);
        }

        Ok(SqliteStore { connection })
    }
}

impl Open for SqliteStore {
    type Config = PathBuf;

    fn open(config: Self::Config, options: OpenOption) -> crate::Result<Self>
    where
        Self: Sized,
    {
        if options.contains(OpenOption::CREATE_NEW) {
            Self::create_new(config)
        } else if options.contains(OpenOption::CREATE) && !config.exists() {
            Self::create_new(config)
        } else {
            let store = Self::open_existing(config)?;

            if options.contains(OpenOption::TRUNCATE) {
                store
                    .connection
                    .execute_batch(
                        r#"
                            DROP TABLE Blocks;
                            DROP TABLE Metadata;
                        "#,
                    )
                    .map_err(anyhow::Error::from)?;
            }

            Ok(store)
        }
    }
}

impl DataStore for SqliteStore {
    type Error = rusqlite::Error;

    fn write_block(&mut self, id: Uuid, data: &[u8]) -> Result<(), Self::Error> {
        self.connection.execute(
            r#"
                REPLACE INTO Blocks (uuid, data)
                VALUES (?1, ?2);
            "#,
            params![&id.as_bytes()[..], data],
        )?;

        Ok(())
    }

    fn read_block(&mut self, id: Uuid) -> Result<Option<Vec<u8>>, Self::Error> {
        self.connection
            .query_row(
                r#"
                    SELECT data FROM Blocks
                    WHERE uuid = ?1;
                "#,
                params![&id.as_bytes()[..]],
                |row| row.get(0),
            )
            .optional()
    }

    fn remove_block(&mut self, id: Uuid) -> Result<(), Self::Error> {
        self.connection.execute(
            r#"
                DELETE FROM Blocks
                WHERE uuid = ?1;
            "#,
            params![&id.as_bytes()[..]],
        )?;

        Ok(())
    }

    fn list_blocks(&mut self) -> Result<Vec<Uuid>, Self::Error> {
        let mut statement = self.connection.prepare(r#"SELECT uuid FROM Blocks;"#)?;

        let result = statement
            .query_map(params![], |row| {
                row.get(0).map(|bytes: Vec<u8>| {
                    Uuid::from_slice(bytes.as_slice()).expect("Could not parse UUID.")
                })
            })?
            .collect::<Result<Vec<Uuid>, _>>()?;

        Ok(result)
    }
}