Eos/eos/core/objects/__init__.py

#   Eos - Verifiable elections
#   Copyright © 2017-2019  RunasSudo (Yingtong Li)
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU Affero General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   This program 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 Affero General Public License for more details.
#
#   You should have received a copy of the GNU Affero General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.

try:
	__pragma__ = __pragma__
	is_python = False
except:
	is_python = True
	def __pragma__(*args):
		pass

# Libraries
# =========

import eos.core.db

if is_python:
	__pragma__('skip')
	import eos.core.db.mongodb
	import eos.core.db.postgresql
	
	from bson.binary import UUIDLegacy
	
	import base64
	from datetime import datetime
	import hashlib
	import importlib
	import json
	import pytz
	import uuid
	__pragma__('noskip')
else:
	# Load json.js
	lib = __pragma__('js', '''
	(function() {{
		{}
		var exports = {{}};
		exports.stringify = stringify_main;
		return exports;
	}})()''', __include__('eos/core/objects/json.js'))

# Database
# ========

class DBInfo:
	def __init__(self):
		self.provider = eos.core.db.DummyProvider(None, None)

dbinfo = DBInfo()

def db_connect(db_name, db_uri='mongodb://localhost:27017/', db_type='mongodb'):
	if is_python:
		dbinfo.provider = eos.core.db.db_providers[db_type](db_name, db_uri)
		dbinfo.provider.connect()

# Fields
# ======

class Field:
	def __init__(self, *args, **kwargs):
		self.default = kwargs['default'] if 'default' in kwargs else kwargs['py_default'] if 'py_default' in kwargs else None
		self.is_protected = kwargs['is_protected'] if 'is_protected' in kwargs else False
		self.is_hashed = kwargs['is_hashed'] if 'is_hashed' in kwargs else not self.is_protected
	
	def object_get(self, obj):
		return obj._field_values[self.real_name]
	
	def object_set(self, obj, value):
		obj._field_values[self.real_name] = value
		
		if isinstance(value, EosObject):
			value._instance = (obj, self.real_name)
			if not value._inited:
				value.post_init()
	
	def object_init(self, obj, value):
		self.object_set(obj, value)

class SerialiseOptions:
	def __init__(self, for_hash=False, should_protect=False, combine_related=False):
		self.for_hash = for_hash
		self.should_protect = should_protect
		self.combine_related = combine_related

SerialiseOptions.DEFAULT = SerialiseOptions()

class PrimitiveField(Field):
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		return value
	
	def deserialise(self, value):
		return value

DictField = PrimitiveField
IntField = PrimitiveField
StringField = PrimitiveField
BooleanField = PrimitiveField
BlobField = PrimitiveField

class EmbeddedObjectField(Field):
	def __init__(self, object_type=None, *args, **kwargs):
		super().__init__(*args, **kwargs)
		self.object_type = object_type
	
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		return EosObject.serialise_and_wrap(value, self.object_type, options)
	
	def deserialise(self, value):
		return EosObject.deserialise_and_unwrap(value, self.object_type)

class ListField(Field):
	def __init__(self, element_field=None, *args, **kwargs):
		super().__init__(default=EosList, *args, **kwargs)
		self.element_field = element_field
	
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		return [self.element_field.serialise(x, options) for x in (value.impl if isinstance(value, EosList) else value)]
	
	def deserialise(self, value):
		return EosList([self.element_field.deserialise(x) for x in value])

class EmbeddedObjectListField(Field):
	def __init__(self, object_type=None, *args, **kwargs):
		super().__init__(default=EosList, *args, **kwargs)
		self.object_type = object_type
	
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		# TNYI: Doesn't know how to deal with iterators like EosList
		if value is None:
			return None
		return [EosObject.serialise_and_wrap(x, self.object_type, options) for x in (value.impl if isinstance(value, EosList) else value)]
	
	def deserialise(self, value):
		if value is None:
			return None
		return EosList([EosObject.deserialise_and_unwrap(x, self.object_type) for x in value])

class RelatedObjectListManager:
	def __init__(self, field, obj):
		self.field = field
		self.obj = obj
	
	def get_all(self):
		query = {self.field.related_field: getattr(self.obj, self.field.this_field)}
		return self.field.related_type.get_all_by_fields(**query)

class RelatedObjectListField(Field):
	def __init__(self, object_type=None, *args, **kwargs):
		super().__init__(*args, **kwargs)
		self.related_type = kwargs['related_type']
		self.object_type = kwargs['object_type'] if 'object_type' in kwargs else None
		self.this_field = kwargs['this_field'] if 'this_field' in kwargs else '_id'
		self.related_field = kwargs['related_field']
	
	def object_get(self, obj):
		return RelatedObjectListManager(self, obj)
	
	def object_set(self, obj, value):
		raise Exception('Cannot directly set related field')
	
	def object_init(self, obj, value):
		pass
	
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		if not options.combine_related:
			return None
		return EmbeddedObjectListField(object_type=self.object_type).serialise(value.get_all(), options)
	
	def deserialise(self, value):
		if value is None:
			return None
		return EosList([EosObject.deserialise_and_unwrap(x, self.object_type) for x in value])

class UUIDField(Field):
	def __init__(self, *args, **kwargs):
		if is_python:
			super().__init__(default=uuid.uuid4, *args, **kwargs)
		else:
			super().__init__(*args, **kwargs)
	
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		return str(value)
	
	def deserialise(self, value):
		if is_python:
			return uuid.UUID(value)
		else:
			return value

class DateTimeField(Field):
	def pad(self, number):
		if number < 10:
			return '0' + str(number)
		return str(number)
	
	def serialise(self, value, options=SerialiseOptions.DEFAULT):
		if value is None:
			return None
		
		if is_python:
			return value.strftime('%Y-%m-%dT%H:%M:%SZ')
		else:
			return value.getUTCFullYear() + '-' + self.pad(value.getUTCMonth() + 1) + '-' + self.pad(value.getUTCDate()) + 'T' + self.pad(value.getUTCHours()) + ':' + self.pad(value.getUTCMinutes()) + ':' + self.pad(value.getUTCSeconds()) + 'Z'
	
	def deserialise(self, value):
		if value is None:
			return None
		
		if is_python:
			return pytz.utc.localize(datetime.strptime(value, '%Y-%m-%dT%H:%M:%SZ'))
		else:
			return __pragma__('js', '{}', 'new Date(value)')
	
	@staticmethod
	def now():
		if is_python:
			return pytz.utc.localize(datetime.utcnow())
		else:
			return __pragma__('js', '{}', 'new Date()')

# Objects
# =======

class EosObjectType(type):
	def __new__(meta, name, bases, attrs):
		cls = type.__new__(meta, name, bases, attrs)
		cls._name = (cls.__module__ + '.' + cls.__name__).replace('.js.', '.').replace('.python.', '.') #TNYI: qualname
		if name != 'EosObject':
			EosObject.objects[cls._name] = cls
		return cls

class EosObject(metaclass=EosObjectType):
	objects = {}
	
	def __init__(self):
		self._instance = (None, None)
		self._inited = False
	
	def post_init(self):
		self._inited = True
	
	def recurse_parents(self, cls):
		#if not isinstance(cls, type):
		if isinstance(cls, str):
			cls = EosObject.lookup(cls)
		
		if isinstance(self, cls):
			return self
		if self._instance[0]:
			return self._instance[0].recurse_parents(cls)
		return None
	
	def __eq__(self, other):
		if not isinstance(other, EosObject):
			return False
		return EosObject.serialise_and_wrap(self) == EosObject.serialise_and_wrap(other)
	
	@staticmethod
	def lookup(name):
		if name in EosObject.objects:
			return EosObject.objects[name]
		importlib.import_module(name[:name.rindex('.')])
		return EosObject.objects[name]
	
	@staticmethod
	def serialise_and_wrap(value, object_type=None, options=SerialiseOptions.DEFAULT):
		if object_type:
			if value:
				return value.serialise(options)
		if value:
			return {'type': value._name, 'value': (value.serialise(options) if value else None)}
		return None
	
	@staticmethod
	def deserialise_and_unwrap(value, object_type=None):
		if object_type:
			return object_type.deserialise(value)
		if value:
			return EosObject.lookup(value['type']).deserialise(value['value'])
		return None
	
	@staticmethod
	def to_json(value):
		if is_python:
			return json.dumps(value, sort_keys=True, separators=(',', ':'))
		else:
			return lib.stringify(value)
	
	@staticmethod
	def from_json(value):
		if is_python:
			return json.loads(value)
		else:
			return JSON.parse(value)

class EosList(EosObject):
	def __init__(self, *args):
		super().__init__()
		
		self.impl = list(*args)
	
	def post_init(self):
		for i in range(len(self.impl)):
			val = self.impl[i]
			# Check if object has writeable attributes
			if is_python and hasattr(val, '__dict__'):
				val._instance = (self, i)
				if not val._inited:
					val.post_init()
	
	def __repr__(self):
		return '<EosList {}>'.format(repr(self.impl))
	
	# Lists in JS are implemented as native Arrays, so no cheating here :(
	def __len__(self):
		return len(self.impl)
	def __getitem__(self, idx):
		return self.impl[idx]
	def __setitem__(self, idx, val):
		self.impl[idx] = val
		val._instance = (self, idx)
		if not val._inited:
			val.post_init()
	def __contains__(self, val):
		return val in self.impl
	
	# For sorting, etc.
	def __eq__(self, other):
		if isinstance(other, EosList):
			other = other.impl
		return self.impl == other
	def __lt__(self, other):
		if isinstance(other, EosList):
			other = other.impl
		return self.impl < other
	
	def append(self, value):
		if isinstance(value, EosObject):
			value._instance = (self, len(self))
			if not value._inited:
				value.post_init()
		return self.impl.append(value)

class DocumentObjectType(EosObjectType):
	def __new__(meta, name, bases, attrs):
		cls = EosObjectType.__new__(meta, name, bases, attrs)
		
		# Process fields
		fields = {}
		if hasattr(cls, '_fields'):
			fields = cls._fields.copy() if is_python else Object.create(cls._fields)
		
		if is_python:
			attrs = list(dir(cls))
		else:
			# We want the raw Javascript name for getOwnPropertyDescriptor
			__pragma__('jsiter')
			attrs = [x for x in cls]
			__pragma__('nojsiter')
		
		for attr in attrs:
			if not is_python:
				# We must skip things with getters or else they will be called here (too soon)
				if Object.getOwnPropertyDescriptor(cls, attr).js_get:
					continue
			
			val = getattr(cls, attr)
			if isinstance(val, Field):
				val._instance = (cls, name)
				
				# Transcrypt does funky things with aliases, which are usually helpful, but not here
				if not is_python and attr.startswith('py_'):
					real_attr = attr[3:]
				else:
					real_attr = attr
				
				val.real_name = real_attr # The JSON/Python name
				val.internal_name = attr # The name that gets passed in as kwargs in Javascript
				
				fields[real_attr] = val
				delattr(cls, attr)
		cls._fields = fields
		
		# Make properties
		if is_python:
			def make_property(name, field):
				def field_getter(self):
					return field.object_get(self)
				def field_setter(self, value):
					field.object_set(self, value)
				return property(field_getter, field_setter)
			
			for attr, val in fields.items():
				setattr(cls, val.real_name, make_property(val.real_name, val))
				#if val.real_name != val.internal_name:
				#	setattr(cls, val.internal_name, make_property(val.real_name, val))
		else:
			# Handled at instance level
			pass
		
		return cls

class DocumentObject(EosObject, metaclass=DocumentObjectType):
	_ver = StringField(default='0.3')
	
	def __init__(self, *args, **kwargs):
		super().__init__()
		
		self._json = None
		
		self._field_values = {}
		
		# Different to Python
		for attr, val in self._fields.items():
			if is_python:
				# Properties handled above
				pass
			else:
				def make_property(name, field):
					# TNYI: Transcrypt doesn't pass self
					def field_getter():
						return field.object_get(self)
					def field_setter(value):
						field.object_set(self, value)
					return (field_getter, field_setter)
				prop = make_property(val.real_name, val)
				# TNYI: No support for property()
				Object.defineProperty(self, val.real_name, {
					'get': prop[0],
					'set': prop[1]
				})
				if val.real_name != val.internal_name:
					# Allow reference as e.g. both obj.py_name (from Python code) and obj.name (from JS templates)
					Object.defineProperty(self, val.internal_name, {
						'get': prop[0],
						'set': prop[1]
					})
			
			if val.internal_name in kwargs:
				val.object_init(self, kwargs[val.internal_name])
			else:
				default = val.default
				if default is not None and callable(default):
					default = default()
				val.object_init(self, default)
	
	def serialise(self, options=SerialiseOptions.DEFAULT):
		if self._ver != self._fields['_ver'].default:
			# Different version, use stored JSON
			return self._json
		
		return {val.real_name: val.serialise(getattr(self, val.real_name), options) for attr, val in self._fields.items() if ((val.is_hashed or not options.for_hash) and (not options.should_protect or not val.is_protected))}
	
	@classmethod
	def deserialise(cls, value):
		if value is None:
			return None
		
		attrs = {}
		for attr, val in cls._fields.items():
			if attr in value:
				attrs[val.internal_name] = val.deserialise(value[val.real_name])
		inst = cls(**attrs)
		
		inst._json = value
		
		return inst

class TopLevelObjectType(DocumentObjectType):
	def __new__(meta, name, bases, attrs):
		cls = DocumentObjectType.__new__(meta, name, bases, attrs)
		
		# TopLevelObject obviously has no _db_name
		if cls._name == 'eos.core.objects.TopLevelObject':
			pass
		else:
			if '_db_name' not in attrs:
				cls._db_name = cls._name
				# If _db_name is False, then explicitly use the _name. Otherwise, inherit.
				if cls._db_name is not False:
					for base in bases:
						if hasattr(base, '_db_name'):
							cls._db_name = base._db_name
							break
		return cls

class TopLevelObject(DocumentObject, metaclass=TopLevelObjectType):
	def save(self):
		if self._ver != self._fields['_ver'].default:
			# Different version, unable to save
			raise Exception('Attempted to save older vesion object')
		
		dbinfo.provider.update_by_id(self._db_name, self._fields['_id'].serialise(self._id), EosObject.serialise_and_wrap(self))
	
	def delete(self):
		dbinfo.provider.delete_by_id(self._db_name, self._fields['_id'].serialise(self._id))
	
	@classmethod
	def get_all(cls):
		return [EosObject.deserialise_and_unwrap(x) for x in dbinfo.provider.get_all(cls._db_name)]
	
	@classmethod
	def get_all_by_fields(cls, **fields):
		for field in fields:
			if not isinstance(fields[field], str):
				fields[field] = str(fields[field])
		return [EosObject.deserialise_and_unwrap(x) for x in dbinfo.provider.get_all_by_fields(cls._db_name, fields)]
	
	@classmethod
	def get_by_id(cls, _id):
		if not isinstance(_id, str):
			_id = str(_id)
		return EosObject.deserialise_and_unwrap(dbinfo.provider.get_by_id(cls._db_name, _id))

class EmbeddedObject(DocumentObject):
	pass

# Enums
# =====

class EosEnumType(EosObjectType):
	def __new__(meta, name, bases, attrs):
		cls = EosObjectType.__new__(meta, name, bases, attrs)
		
		cls._values = {}
		
		for attr in list(dir(cls)):
			val = getattr(cls, attr);
			if isinstance(val, int):
				instance = cls(attr, val)
				setattr(cls, attr, instance)
				cls._values[val] = instance
		
		return cls

class EosEnum(EosObject, metaclass=EosEnumType):
	def __init__(self, name, value):
		super().__init__()
		self.name = name
		self.value = value
	
	def __eq__(self, other):
		if not isinstance(other, self.__class__):
			return False
		return self.value == other.value
	def __ne__(self, other):
		if not isinstance(other, self.__class__):
			return True
		return self.value != other.value
	def __gt__(self, other):
		if not isinstance(other, self.__class__):
			raise TypeError
		return self.value > other.value
	def __lt__(self, other):
		if not isinstance(other, self.__class__):
			raise TypeError
		return self.value < other.value
	def __ge__(self, other):
		if not isinstance(other, self.__class__):
			raise TypeError
		return self.value >= other.value
	def __le__(self, other):
		if not isinstance(other, self.__class__):
			raise TypeError
		return self.value <= other.value
	
	def serialise(self, options=SerialiseOptions.DEFAULT):
		return self.value
	
	@classmethod
	def deserialise(cls, value):
		return cls._values[value]

EnumField = EmbeddedObjectField