Updated kodi settings on Lenovo
This commit is contained in:
201
Kodi/Lenovo/addons/script.module.simplecache/LICENSE
Normal file
201
Kodi/Lenovo/addons/script.module.simplecache/LICENSE
Normal file
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
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.
|
||||
103
Kodi/Lenovo/addons/script.module.simplecache/README.md
Normal file
103
Kodi/Lenovo/addons/script.module.simplecache/README.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# script.module.simplecache
|
||||
|
||||
[](https://www.codacy.com/app/m-vanderveldt/script-module-simplecache?utm_source=github.com&utm_medium=referral&utm_content=marcelveldt/script.module.simplecache&utm_campaign=badger)
|
||||
|
||||
A simple object cache for Kodi addons
|
||||
|
||||
|
||||
## Help needed with maintaining !
|
||||
I am very busy currently so I do not have a lot of time to work on this project or watch the forums.
|
||||
Be aware that this is a community driven project, so feel free to submit PR's yourself to improve the code and/or help others with support on the forums etc. If you're willing to really participate in the development, please contact me so I can give you write access to the repo. I do my best to maintain the project every once in a while, when I have some spare time left.
|
||||
Thanks for understanding!
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
You can use this python library as module within your own Kodi scripts/addons.
|
||||
Just make sure to import it within your addon.xml:
|
||||
|
||||
```xml
|
||||
<requires>
|
||||
<import addon="script.module.simplecache" version="1.0.14" />
|
||||
</requires>
|
||||
```
|
||||
|
||||
Now, to use it in your Kodi addon/script, make sure to import it and you can access its methods.
|
||||
|
||||
```python
|
||||
import simplecache
|
||||
|
||||
# instantiate the cache
|
||||
_cache = simplecache.SimpleCache()
|
||||
|
||||
# get data from cache
|
||||
mycache = _cache.get("MyAddon.MyChunkOfData")
|
||||
if mycache:
|
||||
my_objects = mycache
|
||||
else:
|
||||
# do stuff here
|
||||
my_objects = mymethod()
|
||||
|
||||
# write results in cache
|
||||
_cache.set( "MyAddon.MyChunkOfData", my_objects, expiration=datetime.timedelta(hours=12))
|
||||
```
|
||||
|
||||
The above example will check the cache for the key "MyAddon.MyChunkOfData". If there is any data (and the cache is not expired) it will be returned as the original object.
|
||||
|
||||
If the cache is empty, you perform the usual stuff to get the data and save that to the cache
|
||||
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
## Available methods
|
||||
|
||||
### get(endpoint, checksum="", json=False)
|
||||
```
|
||||
Returns the data from the cache for the specified endpoint. Will return None if there is no cache.
|
||||
|
||||
parameters:
|
||||
endpoint --> Your unique reference/key for the cache object. TIP: To prevent clashes with other addons, prefix with your addon ID.
|
||||
checksum --> Optional argument to check for a checksum in the file (Will only work if you store the checksum with the set method). Can be any python object which can be serialized with eval.
|
||||
json --> Optional argument. Default is False. For JSON data it is recommended to switch it to True to avoid Memomy Error exceptions or other issues. If you set the global "data_is_json" bool to True, it will always handle your data as JSON.
|
||||
|
||||
|
||||
Example: _cache.get("MyAddon.MyChunkOfData", checksum=len(myvideos))
|
||||
|
||||
This example will return the data in the cache but only if the length of the list myvideos is the same as whatever is stored as checksum in the cache.
|
||||
|
||||
```
|
||||
|
||||
### set(endpoint, data, checksum="", expiration=timedelta(days=30), json=False)
|
||||
```
|
||||
Stores the data in the cache for the specified endpoint.
|
||||
|
||||
parameters:
|
||||
endpoint --> Your unique reference/key for the cache object. TIP: To prevent clashes with other addons, prefix with your addon ID.
|
||||
data --> Your objectdata. Can be any python object which can be serialized with eval.
|
||||
checksum --> Optional argument to store as checksum in the file. Can be any python object which can be serialized with eval.
|
||||
expiration --> Optional argument to specify the amount of time the data may be cached as python timedelta object. Defaults to 30 days if ommitted.
|
||||
json --> Optional argument. Default is False. For JSON data it is recommended to switch it to True to avoid Memomy Error exceptions or other issues. If you set the global "data_is_json" bool to True, it will always handle your data as JSON.
|
||||
|
||||
Example: _cache.set("MyAddon.MyGreatChunkOfData", my_objects, checksum=len(myvideos), expiration=timedelta(hours=1))
|
||||
|
||||
This example will store the data in the cache which will expire after 1 hours. Additionally a checksum is stored in the cache object.
|
||||
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
1) By default objects will be stored both in memory and on disk, it is however possible to override that:
|
||||
```
|
||||
_cache.enable_mem_cache = False
|
||||
```
|
||||
In that case, objects will only be stored on disk (database)
|
||||
|
||||
|
||||
2) Cache objects are auto cleaned from memory after 2 hours to prevent unused objects loaded in memory.
|
||||
|
||||
|
||||
3) Cache objects on disk are stored in a self-maintaining sqllite database. Expired objects will be auto cleaned from the database.
|
||||
|
||||
4) If your data is only JSON you can set a global bool to handle all input/ouput requests as JSON. This is recommended to avoid problems and issues on slower devices.
|
||||
```
|
||||
_cache.data_is_json = True
|
||||
```
|
||||
18
Kodi/Lenovo/addons/script.module.simplecache/addon.xml
Normal file
18
Kodi/Lenovo/addons/script.module.simplecache/addon.xml
Normal file
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
||||
<addon id="script.module.simplecache" name="Simple Cache Module" version="2.0.2" provider-name="sualfred">
|
||||
<requires>
|
||||
<import addon="xbmc.python" version="3.0.0"/>
|
||||
</requires>
|
||||
<extension point="xbmc.python.module" library="lib" />
|
||||
<extension point="xbmc.addon.metadata">
|
||||
<summary lang="en_GB">Provides a simple file- and memory based cache for Kodi addons</summary>
|
||||
<description lang="en_GB">Provides a simple file- and memory based cache for Kodi addons. Based on the original work of Marcelveldt.</description>
|
||||
<platform>all</platform>
|
||||
<license>Apache 2.0</license>
|
||||
<forum/>
|
||||
<source>https://github.com/sualfred/script.module.simplecache</source>
|
||||
<assets>
|
||||
<icon>resources/icon.png</icon>
|
||||
</assets>
|
||||
</extension>
|
||||
</addon>
|
||||
Binary file not shown.
308
Kodi/Lenovo/addons/script.module.simplecache/lib/simplecache.py
Normal file
308
Kodi/Lenovo/addons/script.module.simplecache/lib/simplecache.py
Normal file
@@ -0,0 +1,308 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
'''provides a simple stateless caching system for Kodi addons and plugins'''
|
||||
|
||||
import sys
|
||||
import xbmcvfs
|
||||
import xbmcgui
|
||||
import xbmc
|
||||
import xbmcaddon
|
||||
import datetime
|
||||
import time
|
||||
import sqlite3
|
||||
import json
|
||||
from functools import reduce
|
||||
|
||||
ADDON_ID = "script.module.simplecache"
|
||||
|
||||
class SimpleCache(object):
|
||||
'''simple stateless caching system for Kodi'''
|
||||
enable_mem_cache = True
|
||||
data_is_json = False
|
||||
global_checksum = None
|
||||
_exit = False
|
||||
_auto_clean_interval = datetime.timedelta(hours=4)
|
||||
_win = None
|
||||
_busy_tasks = []
|
||||
_database = None
|
||||
|
||||
def __init__(self):
|
||||
'''Initialize our caching class'''
|
||||
self._win = xbmcgui.Window(10000)
|
||||
self._monitor = xbmc.Monitor()
|
||||
self.check_cleanup()
|
||||
self._log_msg("Initialized")
|
||||
|
||||
def close(self):
|
||||
'''tell any tasks to stop immediately (as we can be called multithreaded) and cleanup objects'''
|
||||
self._exit = True
|
||||
# wait for all tasks to complete
|
||||
while self._busy_tasks and not self._monitor.abortRequested():
|
||||
xbmc.sleep(25)
|
||||
del self._win
|
||||
del self._monitor
|
||||
self._log_msg("Closed")
|
||||
|
||||
def __del__(self):
|
||||
'''make sure close is called'''
|
||||
if not self._exit:
|
||||
self.close()
|
||||
|
||||
def get(self, endpoint, checksum="", json_data=False):
|
||||
'''
|
||||
get object from cache and return the results
|
||||
endpoint: the (unique) name of the cache object as reference
|
||||
checkum: optional argument to check if the checksum in the cacheobject matches the checkum provided
|
||||
'''
|
||||
checksum = self._get_checksum(checksum)
|
||||
cur_time = self._get_timestamp(datetime.datetime.now())
|
||||
result = None
|
||||
# 1: try memory cache first
|
||||
if self.enable_mem_cache:
|
||||
result = self._get_mem_cache(endpoint, checksum, cur_time, json_data)
|
||||
|
||||
# 2: fallback to _database cache
|
||||
if result is None:
|
||||
result = self._get_db_cache(endpoint, checksum, cur_time, json_data)
|
||||
|
||||
return result
|
||||
|
||||
def set(self, endpoint, data, checksum="", expiration=datetime.timedelta(days=30), json_data=False):
|
||||
'''
|
||||
set data in cache
|
||||
'''
|
||||
task_name = "set.%s" % endpoint
|
||||
self._busy_tasks.append(task_name)
|
||||
checksum = self._get_checksum(checksum)
|
||||
expires = self._get_timestamp(datetime.datetime.now() + expiration)
|
||||
|
||||
# memory cache: write to window property
|
||||
if self.enable_mem_cache and not self._exit:
|
||||
self._set_mem_cache(endpoint, checksum, expires, data, json_data)
|
||||
|
||||
# db cache
|
||||
if not self._exit:
|
||||
self._set_db_cache(endpoint, checksum, expires, data, json_data)
|
||||
|
||||
# remove this task from list
|
||||
self._busy_tasks.remove(task_name)
|
||||
|
||||
def check_cleanup(self):
|
||||
'''check if cleanup is needed - public method, may be called by calling addon'''
|
||||
cur_time = datetime.datetime.now()
|
||||
lastexecuted = self._win.getProperty("simplecache.clean.lastexecuted")
|
||||
if not lastexecuted:
|
||||
self._win.setProperty("simplecache.clean.lastexecuted", repr(cur_time))
|
||||
elif (eval(lastexecuted) + self._auto_clean_interval) < cur_time:
|
||||
# cleanup needed...
|
||||
self._do_cleanup()
|
||||
|
||||
def _get_mem_cache(self, endpoint, checksum, cur_time, json_data):
|
||||
'''
|
||||
get cache data from memory cache
|
||||
we use window properties because we need to be stateless
|
||||
'''
|
||||
result = None
|
||||
cachedata = self._win.getProperty(endpoint)
|
||||
|
||||
if cachedata:
|
||||
if json_data or self.data_is_json:
|
||||
cachedata = json.loads(cachedata)
|
||||
else:
|
||||
cachedata = eval(cachedata)
|
||||
if cachedata[0] > cur_time:
|
||||
if not checksum or checksum == cachedata[2]:
|
||||
result = cachedata[1]
|
||||
return result
|
||||
|
||||
def _set_mem_cache(self, endpoint, checksum, expires, data, json_data):
|
||||
'''
|
||||
window property cache as alternative for memory cache
|
||||
usefull for (stateless) plugins
|
||||
'''
|
||||
cachedata = (expires, data, checksum)
|
||||
if json_data or self.data_is_json:
|
||||
cachedata_str = json.dumps(cachedata)
|
||||
else:
|
||||
cachedata_str = repr(cachedata)
|
||||
self._win.setProperty(endpoint, cachedata_str)
|
||||
|
||||
|
||||
def _get_db_cache(self, endpoint, checksum, cur_time, json_data):
|
||||
'''get cache data from sqllite _database'''
|
||||
result = None
|
||||
query = "SELECT expires, data, checksum FROM simplecache WHERE id = ?"
|
||||
cache_data = self._execute_sql(query, (endpoint,))
|
||||
if cache_data:
|
||||
cache_data = cache_data.fetchone()
|
||||
if cache_data and cache_data[0] > cur_time:
|
||||
if not checksum or cache_data[2] == checksum:
|
||||
if json_data or self.data_is_json:
|
||||
result = json.loads(cache_data[1])
|
||||
else:
|
||||
result = eval(cache_data[1])
|
||||
# also set result in memory cache for further access
|
||||
if self.enable_mem_cache:
|
||||
self._set_mem_cache(endpoint, checksum, cache_data[0], result, json_data)
|
||||
return result
|
||||
|
||||
def _set_db_cache(self, endpoint, checksum, expires, data, json_data):
|
||||
''' store cache data in _database '''
|
||||
query = "INSERT OR REPLACE INTO simplecache( id, expires, data, checksum) VALUES (?, ?, ?, ?)"
|
||||
if json_data or self.data_is_json:
|
||||
data = json.dumps(data)
|
||||
else:
|
||||
data = repr(data)
|
||||
self._execute_sql(query, (endpoint, expires, data, checksum))
|
||||
|
||||
def _do_cleanup(self):
|
||||
'''perform cleanup task'''
|
||||
if self._exit or self._monitor.abortRequested():
|
||||
return
|
||||
self._busy_tasks.append(__name__)
|
||||
cur_time = datetime.datetime.now()
|
||||
cur_timestamp = self._get_timestamp(cur_time)
|
||||
self._log_msg("Running cleanup...")
|
||||
if self._win.getProperty("simplecachecleanbusy"):
|
||||
return
|
||||
self._win.setProperty("simplecachecleanbusy", "busy")
|
||||
|
||||
query = "SELECT id, expires FROM simplecache"
|
||||
for cache_data in self._execute_sql(query).fetchall():
|
||||
cache_id = cache_data[0]
|
||||
cache_expires = cache_data[1]
|
||||
|
||||
if self._exit or self._monitor.abortRequested():
|
||||
return
|
||||
|
||||
# always cleanup all memory objects on each interval
|
||||
self._win.clearProperty(cache_id)
|
||||
|
||||
# clean up db cache object only if expired
|
||||
if cache_expires < cur_timestamp:
|
||||
query = 'DELETE FROM simplecache WHERE id = ?'
|
||||
self._execute_sql(query, (cache_id,))
|
||||
self._log_msg("delete from db %s" % cache_id)
|
||||
|
||||
# compact db
|
||||
self._execute_sql("VACUUM")
|
||||
|
||||
# remove task from list
|
||||
self._busy_tasks.remove(__name__)
|
||||
self._win.setProperty("simplecache.clean.lastexecuted", repr(cur_time))
|
||||
self._win.clearProperty("simplecachecleanbusy")
|
||||
self._log_msg("Auto cleanup done")
|
||||
|
||||
def _get_database(self):
|
||||
'''get reference to our sqllite _database - performs basic integrity check'''
|
||||
addon = xbmcaddon.Addon(ADDON_ID)
|
||||
dbpath = addon.getAddonInfo('profile')
|
||||
dbfile = xbmcvfs.translatePath("%s/simplecache.db" % dbpath)
|
||||
|
||||
if not xbmcvfs.exists(dbpath):
|
||||
xbmcvfs.mkdirs(dbpath)
|
||||
del addon
|
||||
try:
|
||||
connection = sqlite3.connect(dbfile, timeout=30, isolation_level=None)
|
||||
connection.execute('SELECT * FROM simplecache LIMIT 1')
|
||||
return connection
|
||||
except Exception as error:
|
||||
# our _database is corrupt or doesn't exist yet, we simply try to recreate it
|
||||
if xbmcvfs.exists(dbfile):
|
||||
xbmcvfs.delete(dbfile)
|
||||
try:
|
||||
connection = sqlite3.connect(dbfile, timeout=30, isolation_level=None)
|
||||
connection.execute(
|
||||
"""CREATE TABLE IF NOT EXISTS simplecache(
|
||||
id TEXT UNIQUE, expires INTEGER, data TEXT, checksum INTEGER)""")
|
||||
return connection
|
||||
except Exception as error:
|
||||
self._log_msg("Exception while initializing _database: %s" % str(error), xbmc.LOGWARNING)
|
||||
self.close()
|
||||
return None
|
||||
|
||||
def _execute_sql(self, query, data=None):
|
||||
'''little wrapper around execute and executemany to just retry a db command if db is locked'''
|
||||
retries = 0
|
||||
result = None
|
||||
error = None
|
||||
# always use new db object because we need to be sure that data is available for other simplecache instances
|
||||
with self._get_database() as _database:
|
||||
while not retries == 10 and not self._monitor.abortRequested():
|
||||
if self._exit:
|
||||
return None
|
||||
try:
|
||||
if isinstance(data, list):
|
||||
result = _database.executemany(query, data)
|
||||
elif data:
|
||||
result = _database.execute(query, data)
|
||||
else:
|
||||
result = _database.execute(query)
|
||||
return result
|
||||
except sqlite3.OperationalError as error:
|
||||
if "_database is locked" in error:
|
||||
self._log_msg("retrying DB commit...")
|
||||
retries += 1
|
||||
self._monitor.waitForAbort(0.5)
|
||||
else:
|
||||
break
|
||||
except Exception as error:
|
||||
break
|
||||
self._log_msg("_database ERROR ! -- %s" % str(error), xbmc.LOGWARNING)
|
||||
return None
|
||||
|
||||
@staticmethod
|
||||
def _log_msg(msg, loglevel=xbmc.LOGDEBUG):
|
||||
'''helper to send a message to the kodi log'''
|
||||
xbmc.log("Skin Helper Simplecache --> %s" % msg, level=loglevel)
|
||||
|
||||
@staticmethod
|
||||
def _get_timestamp(date_time):
|
||||
'''Converts a datetime object to unix timestamp'''
|
||||
return int(time.mktime(date_time.timetuple()))
|
||||
|
||||
def _get_checksum(self, stringinput):
|
||||
'''get int checksum from string'''
|
||||
if not stringinput and not self.global_checksum:
|
||||
return 0
|
||||
if self.global_checksum:
|
||||
stringinput = "%s-%s" %(self.global_checksum, stringinput)
|
||||
else:
|
||||
stringinput = str(stringinput)
|
||||
return reduce(lambda x, y: x + y, map(ord, stringinput))
|
||||
|
||||
|
||||
def use_cache(cache_days=14):
|
||||
'''
|
||||
wrapper around our simple cache to use as decorator
|
||||
Usage: define an instance of SimpleCache with name "cache" (self.cache) in your class
|
||||
Any method that needs caching just add @use_cache as decorator
|
||||
NOTE: use unnamed arguments for calling the method and named arguments for optional settings
|
||||
'''
|
||||
def decorator(func):
|
||||
'''our decorator'''
|
||||
def decorated(*args, **kwargs):
|
||||
'''process the original method and apply caching of the results'''
|
||||
method_class = args[0]
|
||||
method_class_name = method_class.__class__.__name__
|
||||
cache_str = "%s.%s" % (method_class_name, func.__name__)
|
||||
# cache identifier is based on positional args only
|
||||
# named args are considered optional and ignored
|
||||
for item in args[1:]:
|
||||
cache_str += u".%s" % item
|
||||
cache_str = cache_str.lower()
|
||||
cachedata = method_class.cache.get(cache_str)
|
||||
global_cache_ignore = False
|
||||
try:
|
||||
global_cache_ignore = method_class.ignore_cache
|
||||
except Exception:
|
||||
pass
|
||||
if cachedata is not None and not kwargs.get("ignore_cache", False) and not global_cache_ignore:
|
||||
return cachedata
|
||||
else:
|
||||
result = func(*args, **kwargs)
|
||||
method_class.cache.set(cache_str, result, expiration=datetime.timedelta(days=cache_days))
|
||||
return result
|
||||
return decorated
|
||||
return decorator
|
||||
BIN
Kodi/Lenovo/addons/script.module.simplecache/resources/icon.png
Normal file
BIN
Kodi/Lenovo/addons/script.module.simplecache/resources/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.1 KiB |
Reference in New Issue
Block a user