Homec4science
Diffusion py-licenser (master) Browse

py-licenser/LicenserDB.py
9f2960d072demaster

Last Change
Raw File

LicenserDB.py
View Options

#!/usr/bin/env python
# -*- coding: utf-8 -*-
__all__ = ["LicenserDB"]
import sqlite3 as lite
from collections import namedtuple
from datetime import datetime as dt
import os
Author = namedtuple('Author', 'user_name, e_mail, last_name, first_name')
CopyRight = namedtuple('CopyRight', ['lid', 'on_modifications_txt', 'start', 'end', 'text' ])
SQLITE = 0
CSV = 1
def licenser_ask_question(question, possible_answer = { 'y': True, 'n': False}, default = 'y'):
answers = '/'.join( [ k if not k == default else k.upper() for k in possible_answer.keys() ])
answer = None
while answer not in possible_answer.keys():
answer = raw_input('{0} ({1})? '.format(question, answers))
answer = answer.lower()
if answer == '':
return possible_answer[default]
#if answer in possible_answer.keys():
return possible_answer[answer]
#raise(Exception("\'{0}\' is not a valid answer to the question!".format(answer)))
class LicenserDB(object):
_project = ""
_versioning_backend = "svn"
_configs = {
'project': "",
'versioning_backend': 'svn',
'date_format': "%a %b %d %H:%M:%S %Y",
'date_sytle': 'last_modification',
'copyright_policy': 'creation_date'
}
def __new__(cls, filename, backend = None):
"""
Factory constructor depending on the choosen backend
"""
if backend == 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):
return super(LicenserDB, cls).__new__(LicenserSQLITEDB, filename)
elif(backend == CSV):
return super(LicenserDB, cls).__new__(LicenserCSVDB, filename)
else:
raise(Exception("Not a known backend"))
def getAuthors(self): return None
def getCopyRights(self): return None
def getProject(self): return self._configs['project']
def getVersioningBackend(self): return self._configs['versioning_backend']
def getConfig(self, conf): return self._configs[conf] if conf in self._configs else None
def findFile(self, name): return None
def isAuthorInIgnoreList(self): return False
class LicenserSQLITEDB(LicenserDB):
def __init__(self, filename, **kwargs):
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, 'last_name' TEXT, 'first_name' TEXT, 'email' TEXT)''');
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:
self._configs[prop['property']] = prop['value']
def getAuthors(self):
with self.__connection:
self.__cursor.execute(
'''SELECT a.'uid', a.'email', a.'last_name', a.'first_name' ''' +
''' FROM 'authors' AS a''')
authors = self.__cursor.fetchall()
return [ Author(*[ str(e.encode('utf-8')) for e in author ]) for author in authors ]
return None
def isAuthorInIgnoreList(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)
return False
def getAuthor(self, uid):
with self.__connection:
self.__cursor.execute(
'''SELECT a.'fullname', a.'email' ''' +
''' FROM 'authors' AS a WHERE a.'uid'=:uid''',
{'uid', uid})
res = self.__cursor.fetchone()
if not res == None:
return [ Author(*author) ]
return None
def addAuthor(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' : unicode(author.user_name .decode('utf-8')),
'last_name' : unicode(author.last_name .decode('utf-8')),
'first_name': unicode(author.first_name.decode('utf-8')),
'email' : unicode(author.e_mail .decode('utf-8')) })
def getCopyRights(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'].encode('utf-8')),
dt.strptime(copy['from'], "%Y-%m-%d").date(),
dt.strptime(copy['to'], "%Y-%m-%d").date(),
str(copy['text'].encode('utf-8'))) for copy in copyrights ]
return None
def findFile(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 not res == None:
return [ dt.strptime(res['last_modif'], "%Y-%m-%d"), res['license_id'] ]
return None
def updateFile(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()
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() ]
def getAuthors(self):
with open(self.__author_file) as fh:
next(fh)
split_lines = [line.strip().split(';') for line in fh]
return [Author._make((token.strip('"') for token in line)) for line in split_lines]
return None
def addAuthor(self, author):
with open(self.__author_file, 'a') as fh:
fh.write(';'.join([ '\"{0}\"'.format(val) for val in author ]) + '\n')
def findFile(self, filename):
if filename in self.__treated_files:
return self.__treated_files[filename]
return None
def updateFile(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 ]))
def getCopyRights(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]
return None
c4science · Help