Homec4science
Diffusion py-licenser (licence_header_only) Browse

py-licenser/pylicenser/licenser_db.py
c6810ef3ebdclicence_header_only

Last Change
Raw File

licenser_db.py
View Options

# -*- coding: utf-8 -*-
__author__ = "Guillaume Anciaux, and Nicolas Richart"
__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
"(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
__license__ = "GPL"
__version__ = "1.0"
__maintainer__ = "Nicolas Richart"
__email__ = "nicolas.richart@epfl.ch"
from . import export
from . import author_db as adb
import sqlite3 as lite
from collections import namedtuple
from datetime import datetime as dt
import os
CopyRight = namedtuple('CopyRight', ['lid', 'on_modifications_txt', 'start', 'end', 'text'])
SQLITE = 0
CSV = 1
@export
class LicenserDB:
_project = ""
_versioning_backend = "svn"
_configs = {
'project': "",
'versioning_backend': 'svn',
'date_format': "%a %b %d %H:%M:%S %Y",
'date_style': 'last_modification',
'copyright_policy': 'creation_date'
}
def __new__(cls, filename, backend=None):
"""
Factory constructor depending on the chosen backend
"""
if backend is None:
_filepath = os.path.expanduser(filename)
garbage, ext = os.path.splitext(os.path.basename(_filepath))
if ext == ".csv":
backend = CSV
elif ext == ".db":
backend = SQLITE
else:
raise (Exception("Unknown file format"))
if backend == SQLITE:
obj = super().__new__(LicenserSQLITEDB)
elif backend == CSV:
obj = super().__new__(LicenserCSVDB)
else:
raise (Exception("Not a known backend"))
return obj
@property
def authors(self):
return None
def add_author(self, author):
pass
@property
def copyrights(self):
return None
@property
def project(self):
return self._configs['project']
@property
def versioning_backend(self):
return self._configs['versioning_backend']
def get_config(self, conf):
return self._configs[conf] if conf in self._configs else None
def find_file(self, name):
return None
def update_file(self, filename, license_id, update=dt.now().date()):
pass
def is_author_in_ignore_list(self, author):
return False
@export
class LicenserSQLITEDB(LicenserDB):
# noinspection PyTypeChecker
def __init__(self, filename):
self.__connection = lite.connect(filename)
self.__connection.row_factory = lite.Row
self.__cursor = self.__connection.cursor()
with self.__connection:
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'config' ''' +
''' ('property' TEXT, 'value' TEXT)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'authors' ''' +
''' ('uid' TEXT NOT NULL, 'last_name' TEXT NOT NULL, 'first_name' TEXT NOT NULL,''' +
''' 'email' TEXT NOT NULL, 'real_email' TEXT DEFAULT '')''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'authors_ignore_list' ''' +
''' ('uid' TEXT)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'copyrights' ''' +
''' ('lid' TEXT, 'from' TEXT, 'to' TEXT, 'on_modifications_txt', 'text' BLOB)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'files' ''' +
''' ('filename' TEXT, 'last_modif' TEXT, 'license_id' TEXT,''' +
''' PRIMARY KEY('filename'))''')
self.__cursor.execute('''SELECT * FROM 'config' AS c''')
properties = self.__cursor.fetchall()
for prop in properties:
_property = prop['property']
self._configs[_property] = prop['value']
@property
def authors(self):
with self.__connection:
self.__cursor.execute(
'''SELECT a.'uid', a.'email', a.'last_name', a.'first_name', a.'real_email' ''' +
''' FROM 'authors' AS a''')
authors = self.__cursor.fetchall()
return [adb.Author(*[str(e) if e is not None else e for e in author]) for author in authors]
def is_author_in_ignore_list(self, author):
with self.__connection:
self.__cursor.execute(
'''SELECT a.'uid' ''' +
''' FROM 'authors_ignore_list' AS a''' +
''' WHERE a.'uid' = :uid''',
{"uid": author.user_name})
authors = self.__cursor.fetchall()
return len(authors) > 0
def add_author(self, author):
with self.__connection:
self.__cursor.execute(
'''INSERT INTO 'authors' ('uid', 'first_name', 'last_name', 'email')''' +
'''VALUES (:uid, :first_name, :last_name, :email)''',
{'uid': str(author.user_name),
'last_name': str(author.last_name),
'first_name': str(author.first_name),
'email': str(author.e_mail)})
# noinspection PyTypeChecker
@property
def copyrights(self):
with self.__connection:
self.__cursor.execute(
'''SELECT c.'lid', c.'on_modifications_txt', c.'from', c.'to', c.'text' ''' +
''' FROM 'copyrights' AS c''')
copyrights = self.__cursor.fetchall()
return [CopyRight(copy['lid'],
str(copy['on_modifications_txt']),
dt.strptime(copy['from'], "%Y-%m-%d").date(),
dt.strptime(copy['to'], "%Y-%m-%d").date(),
str(copy['text'])) for copy in copyrights]
# noinspection PyTypeChecker
def find_file(self, filename):
with self.__connection:
self.__cursor.execute(
'''SELECT f.'last_modif', f.'license_id' ''' +
''' FROM 'files' AS f WHERE f.'filename'=:filename''',
{'filename': filename})
res = self.__cursor.fetchone()
if res is not None:
return [dt.strptime(res['last_modif'], "%Y-%m-%d"), res['license_id']]
def update_file(self, filename, license_id, update=dt.now().date()):
with self.__connection:
self.__cursor.execute(
'''INSERT OR REPLACE INTO 'files' ('filename', 'last_modif', 'license_id') ''' +
''' VALUES (:filename, :update, :license_id)''',
{'filename': filename,
'license_id': license_id,
'update': update.strftime("%Y-%m-%d")})
class LicenserCSVDB(LicenserDB):
__author_file = ''
__copyright_file = ''
__treated_files = dict()
# noinspection PyUnusedLocal
def __init__(self, filename, **kwargs):
self.__config_file = filename
with open(self.__config_file) as fh:
split_lines = [line.strip().split(';') for line in fh]
if len(split_lines) > 1:
raise (Exception("Too many lines in the configuration file"))
self._configs['project'], self.__author_file, self.__copyright_file, self._configs['versioning_backend'] = [
token.strip('"') for token in split_lines[0]]
with open('treated_files.list', 'r') as f:
for l in f:
f, date, lid = l.split(";")
f = f.strip()
date = dt.strptime(date, "%Y-%m-%d")
self.__treated_files[f] = [date, lid.strip()]
@property
def authors(self):
with open(self.__author_file) as fh:
next(fh)
split_lines = [line.strip().split(';') for line in fh]
return [adb.Author._make((token.strip('"') for token in line)) for line in split_lines]
def add_author(self, author):
with open(self.__author_file, 'a') as fh:
fh.write(';'.join(['\"{0}\"'.format(val) for val in author]) + '\n')
def find_file(self, filename):
if filename in self.__treated_files:
return self.__treated_files[filename]
return None
def update_file(self, filename, license_id, update=dt.now().date()):
self.__treated_files[filename] = [update.strftime("%Y-%m-%d"), license_id]
with open('treated_files.list', 'w') as f:
f.write("\n".join([";".join(f) for f in self.__treated_files.items]))
@property
def copyrights(self):
with open(self.__copyright_file) as fh:
split_lines = [line.strip().split(';') for line in fh]
tab = ([[token.strip('"') for token in line] for line in split_lines])
return [CopyRight._make([lid,
on_modif,
dt.strptime(start, "%d-%m-%Y").date(),
dt.strptime(end, "%d-%m-%Y").date(),
"".join([line for line in open(license_file)])]) for
lid, on_modif, start, end, license_file in tab]
c4science · Help