gajim3/gajim/common/storage/cache.py

265 lines
7.9 KiB
Python

# This file is part of Gajim.
#
# Gajim is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation; version 3 only.
#
# Gajim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Gajim. If not, see <http://www.gnu.org/licenses/>.
import json
import time
import sqlite3
import logging
from collections import namedtuple
from gajim.common import configpaths
from gajim.common.storage.base import SqliteStorage
from gajim.common.storage.base import timeit
CURRENT_USER_VERSION = 6
CACHE_SQL_STATEMENT = '''
CREATE TABLE caps_cache (
hash_method TEXT,
hash TEXT,
data TEXT,
last_seen INTEGER
);
CREATE TABLE last_seen_disco_info(
jid TEXT PRIMARY KEY UNIQUE,
disco_info TEXT,
last_seen INTEGER
);
CREATE TABLE roster(
account TEXT PRIMARY KEY UNIQUE,
roster TEXT
);
CREATE TABLE muc_avatars(
jid TEXT PRIMARY KEY UNIQUE,
avatar_sha TEXT
);
PRAGMA user_version=%s;
''' % CURRENT_USER_VERSION
log = logging.getLogger('gajim.c.storage.cache')
class CacheStorage(SqliteStorage):
def __init__(self):
SqliteStorage.__init__(self,
log,
configpaths.get('CACHE_DB'),
CACHE_SQL_STATEMENT)
self._entity_caps_cache = {}
self._disco_info_cache = {}
self._muc_avatar_sha_cache = {}
def init(self, **kwargs):
SqliteStorage.init(self,
detect_types=sqlite3.PARSE_COLNAMES)
self._set_journal_mode('WAL')
self._con.row_factory = self._namedtuple_factory
self._fill_disco_info_cache()
self._fill_muc_avatar_sha_cache()
self._clean_caps_table()
self._load_caps_data()
@staticmethod
def _namedtuple_factory(cursor, row):
fields = [col[0] for col in cursor.description]
Row = namedtuple("Row", fields)
return Row(*row)
def _migrate(self):
user_version = self.user_version
if user_version > CURRENT_USER_VERSION:
# Gajim was downgraded, reinit the storage
self._reinit_storage()
return
if user_version < 6:
self._reinit_storage()
@timeit
def _load_caps_data(self):
rows = self._con.execute(
'SELECT hash_method, hash, data as "data [disco_info]" '
'FROM caps_cache')
for row in rows:
self._entity_caps_cache[(row.hash_method, row.hash)] = row.data
@timeit
def add_caps_entry(self, jid, hash_method, hash_, caps_data):
self._entity_caps_cache[(hash_method, hash_)] = caps_data
self._disco_info_cache[jid] = caps_data
self._con.execute('''
INSERT INTO caps_cache (hash_method, hash, data, last_seen)
VALUES (?, ?, ?, ?)
''', (hash_method, hash_, caps_data, int(time.time())))
self._delayed_commit()
def get_caps_entry(self, hash_method, hash_):
return self._entity_caps_cache.get((hash_method, hash_))
@timeit
def update_caps_time(self, method, hash_):
sql = '''UPDATE caps_cache SET last_seen = ?
WHERE hash_method = ? and hash = ?'''
self._con.execute(sql, (int(time.time()), method, hash_))
self._delayed_commit()
@timeit
def _clean_caps_table(self):
"""
Remove caps which was not seen for 3 months
"""
timestamp = int(time.time()) - 3 * 30 * 24 * 3600
self._con.execute('DELETE FROM caps_cache WHERE last_seen < ?',
(timestamp,))
self._delayed_commit()
@timeit
def _fill_disco_info_cache(self):
sql = '''SELECT disco_info as "disco_info [disco_info]",
jid, last_seen FROM
last_seen_disco_info'''
rows = self._con.execute(sql).fetchall()
for row in rows:
disco_info = row.disco_info._replace(timestamp=row.last_seen)
self._disco_info_cache[row.jid] = disco_info
log.info('%d DiscoInfo entries loaded', len(rows))
def get_last_disco_info(self, jid, max_age=0):
"""
Get last disco info from jid
:param jid: The jid
:param max_age: max age in seconds of the DiscoInfo record
"""
disco_info = self._disco_info_cache.get(jid)
if disco_info is not None:
max_timestamp = time.time() - max_age if max_age else 0
if max_timestamp > disco_info.timestamp:
return None
return disco_info
@timeit
def set_last_disco_info(self, jid, disco_info, cache_only=False):
"""
Get last disco info from jid
:param jid: The jid
:param disco_info: A DiscoInfo object
"""
log.info('Save disco info from %s', jid)
if cache_only:
self._disco_info_cache[jid] = disco_info
return
disco_exists = self.get_last_disco_info(jid) is not None
if disco_exists:
sql = '''UPDATE last_seen_disco_info SET
disco_info = ?, last_seen = ?
WHERE jid = ?'''
self._con.execute(sql, (disco_info, disco_info.timestamp, str(jid)))
else:
sql = '''INSERT INTO last_seen_disco_info
(jid, disco_info, last_seen)
VALUES (?, ?, ?)'''
self._con.execute(sql, (str(jid), disco_info, disco_info.timestamp))
self._disco_info_cache[jid] = disco_info
self._delayed_commit()
@timeit
def store_roster(self, account, roster):
serialized = json.dumps(roster)
insert_sql = 'INSERT INTO roster(account, roster) VALUES(?, ?)'
update_sql = 'UPDATE roster SET roster = ? WHERE account = ?'
try:
self._con.execute(insert_sql, (account, serialized))
except sqlite3.IntegrityError:
self._con.execute(update_sql, (serialized, account))
self._delayed_commit()
@timeit
def load_roster(self, account):
select_sql = 'SELECT roster FROM roster WHERE account = ?'
result = self._con.execute(select_sql, (account,)).fetchone()
if result is None:
return None
return json.loads(result.roster)
@timeit
def remove_roster(self, account):
delete_sql = 'DELETE FROM roster WHERE account = ?'
self._con.execute(delete_sql, (account,))
self._commit()
@timeit
def _fill_muc_avatar_sha_cache(self):
sql = '''SELECT jid, avatar_sha FROM muc_avatars'''
rows = self._con.execute(sql).fetchall()
for row in rows:
self._muc_avatar_sha_cache[row.jid] = row.avatar_sha
log.info('%d Avatar SHA entries loaded', len(rows))
@timeit
def set_muc_avatar_sha(self, jid, sha=None):
"""
Set the avatar sha of a MUC
:param jid: The MUC jid that belongs to the avatar
:param sha: The sha of the avatar
"""
sql = '''INSERT INTO muc_avatars (jid, avatar_sha)
VALUES (?, ?)'''
try:
self._con.execute(sql, (jid, sha))
except sqlite3.IntegrityError:
sql = 'UPDATE muc_avatars SET avatar_sha = ? WHERE jid = ?'
self._con.execute(sql, (sha, jid))
self._muc_avatar_sha_cache[jid] = sha
self._delayed_commit()
def get_muc_avatar_sha(self, jid):
"""
Get the avatar sha of a MUC
:param jid: The MUC jid that belongs to the avatar
"""
return self._muc_avatar_sha_cache.get(jid)