aboutsummaryrefslogtreecommitdiffstats
path: root/cms-fsd/src/db_cache.rs
blob: c260868f9c0d165d9e8ac769bd27eff2cfce6ccf (plain)
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
// -*- coding: utf-8 -*-
//
// Simple CMS
//
// Copyright (C) 2011-2024 Michael Büsch <m@bues.ch>
//
// Licensed under the Apache License version 2.0
// or the MIT license, at your option.
// SPDX-License-Identifier: Apache-2.0 OR MIT

use crate::db_fsintf::{DbFsIntf, PageInfo};
use cms_ident::{CheckedIdent, CheckedIdentElem, Ident};
use inotify::{Inotify, Watches};
use lru::LruCache;
use tokio::sync::Mutex;

#[derive(Clone, PartialEq, Eq, Hash, Debug)]
enum CacheKey {
    Page(Ident),
    PageRedirect(Ident),
    PageTitle(Ident),
    PageStamp(Ident),
    Subpages(Ident),
    Macro(Ident, Ident),
    String(Ident),
    Image(Ident),
    Headers(Ident),
}

#[derive(Debug)]
enum CacheValue {
    Blob(Vec<u8>),
    PageInfoList(Vec<PageInfo>),
    U64(u64),
}

pub struct DbCache {
    fs_intf: DbFsIntf,
    inotify: Mutex<Inotify>,
    inotify_watches: Watches,
    cache: Option<Mutex<LruCache<CacheKey, CacheValue>>>,
}

macro_rules! get_cached {
    (
        $self:ident,
        $key:ident,
        $value_type:ident,
        $getter:ident ( $( $getter_args:ident ),* )
    ) => {
        {
            let unpack = |data: &CacheValue| {
                if let CacheValue::$value_type(data) = data {
                    data.clone()
                } else {
                    panic!("CacheValue: Not a valid type.");
                }
            };

            // Query the cache.
            if let Some(cache) = &$self.cache {
                let mut cache = cache.lock().await;
                if let Some(data) = cache.get(&$key) {
                    return unpack(data);
                }
                // The cache does not contain the value.
            }

            let data = {
                // Get an inotify handle for adding watches.
                let mut watches = $self.inotify_watches.clone();
                // Access the DB without holding any lock.
                $self.fs_intf.$getter( $( $getter_args ),* , &mut watches ).await
            };

            // Insert it into the cache.
            if let Some(cache) = &$self.cache {
                let mut cache = cache.lock().await;
                unpack(cache.try_get_or_insert::<_, ()>(
                    $key,
                    || Ok(CacheValue::$value_type(data))
                ).unwrap())
            } else {
                data
            }
        }
    }
}

impl DbCache {
    pub fn new(fs_intf: DbFsIntf, cache_size: usize) -> Self {
        let cache = if cache_size == 0 {
            None
        } else {
            let cache_size = cache_size.try_into().unwrap();
            Some(Mutex::new(LruCache::new(cache_size)))
        };
        let inotify = Inotify::init().expect("Inotify initialization failed");
        let watches = inotify.watches();
        Self {
            fs_intf,
            inotify: Mutex::new(inotify),
            inotify_watches: watches,
            cache,
        }
    }

    pub async fn clear(&self) {
        if let Some(cache) = &self.cache {
            let mut cache = cache.lock().await;
            if !cache.is_empty() {
                cache.clear();
                println!("DB cache cleared.");
            }
        }
    }

    pub async fn check_inotify(&self) {
        let mut inotify = self.inotify.lock().await;
        let mut buffer = [0; 4096];
        loop {
            match inotify.read_events(&mut buffer) {
                Ok(events) => {
                    if events.count() > 0 {
                        self.clear().await;
                    } else {
                        return;
                    }
                }
                Err(_) => {
                    return;
                }
            }
        }
    }

    pub async fn get_page(&self, page: &CheckedIdent) -> Vec<u8> {
        let key = CacheKey::Page(page.downgrade_clone());
        get_cached!(self, key, Blob, get_page(page))
    }

    pub async fn get_page_redirect(&self, page: &CheckedIdent) -> Vec<u8> {
        let key = CacheKey::PageRedirect(page.downgrade_clone());
        get_cached!(self, key, Blob, get_page_redirect(page))
    }

    pub async fn get_page_title(&self, page: &CheckedIdent) -> Vec<u8> {
        let key = CacheKey::PageTitle(page.downgrade_clone());
        get_cached!(self, key, Blob, get_page_title(page))
    }

    pub async fn get_page_stamp(&self, page: &CheckedIdent) -> u64 {
        let key = CacheKey::PageStamp(page.downgrade_clone());
        get_cached!(self, key, U64, get_page_stamp(page))
    }

    pub async fn get_subpages(&self, page: &CheckedIdent) -> Vec<PageInfo> {
        let key = CacheKey::Subpages(page.downgrade_clone());
        get_cached!(self, key, PageInfoList, get_subpages(page))
    }

    pub async fn get_macro(&self, page: &CheckedIdent, name: &CheckedIdentElem) -> Vec<u8> {
        let key = CacheKey::Macro(page.downgrade_clone(), name.downgrade_clone());
        get_cached!(self, key, Blob, get_macro(page, name))
    }

    pub async fn get_string(&self, name: &CheckedIdentElem) -> Vec<u8> {
        let key = CacheKey::String(name.downgrade_clone());
        get_cached!(self, key, Blob, get_string(name))
    }

    pub async fn get_image(&self, name: &CheckedIdentElem) -> Vec<u8> {
        let key = CacheKey::Image(name.downgrade_clone());
        get_cached!(self, key, Blob, get_image(name))
    }

    pub async fn get_headers(&self, page: &CheckedIdent) -> Vec<u8> {
        let key = CacheKey::Headers(page.downgrade_clone());
        get_cached!(self, key, Blob, get_headers(page))
    }
}

// vim: ts=4 sw=4 expandtab
bues.ch cgit interface