MessageHistory - Code Metrics - Inspection of "Added message history" - Deathangel908/pychat - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 03af23...349398 )

by Andrew

created 2018-04-22 13:23 UTC

MessageHistory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	5
Duplicated Lines	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	10
wmc	0

import datetime
import json
import time
from enum import Enum
from time import mktime

from django.contrib.auth.models import BaseUserManager, AbstractBaseUser
from django.db import models
from django.db.models import CharField, DateField, FileField, BooleanField, URLField

from chat.log_filters import id_generator
from chat.settings import GENDERS, DEFAULT_PROFILE_ID, JS_CONSOLE_LOGS


def get_random_path(instance, filename):
	"""
	:param filename base string for generated name
	:return: a unique string filename
	"""
	return "{}_{}".format(id_generator(8), filename)

def myoverridenmeta(name, bases, adict):
	newClass = type(name, bases, adict)
	for field in newClass._meta.fields:
		if field.attname == 'password':
			field.blank = True
	return newClass


class User(AbstractBaseUser):
	def get_short_name(self):
		return self.username

	def get_full_name(self):
		return self.username

	@property
	def is_staff(self):
		# every registered user can edit database
		return self.pk == DEFAULT_PROFILE_ID

	def has_perm(self, perm, obj=None):
		return self.is_staff

	def has_perms(self, perm, obj=None):
		return True

	def has_module_perms(self, app_label):
		return self.is_staff

	USERNAME_FIELD = 'username'
	username = CharField(max_length=30, null=False, unique=True)

	# specifies auth, create email, etc methods
	objects = BaseUserManager()

	# ISO/IEC 5218 1 male, 2 - female
	sex = models.SmallIntegerField(null=False, default=0)

	@property
	def sex_str(self):
		return GENDERS[self.sex]

	@sex_str.setter
	def sex_str(self, sex):
		if sex == 'Male':
			self.sex = 1
		elif sex == 'Female':
			self.sex = 2
		else:
			self.sex = 0

	__metaclass__ = myoverridenmeta


class Subscription(models.Model):
	user = models.ForeignKey(User, null=False)
	inactive = BooleanField(default=False, null=False)
	registration_id = models.CharField(null=False, max_length=191, unique=True)
	created = models.DateTimeField(default=datetime.datetime.now)
	updated = models.DateTimeField(default=datetime.datetime.now)
	agent = models.CharField(max_length=64, null=True, blank=True)
	is_mobile = BooleanField(default=False, null=False, blank=True)
	ip = models.ForeignKey('IpAddress', null=True, blank=True)

	def __unicode__(self):
		return self.__str__()

	def __str__(self):
		return str(self.id)


class Verification(models.Model):

	class TypeChoices(Enum):
		register = 'r'
		password = 'p'
		email = 'e'
		confirm_email = 'c'

	# a - account activation, r - recover
	type = models.CharField(null=False, max_length=1)
	token = models.CharField(max_length=17, null=False, default=id_generator)
	user = models.ForeignKey(User, null=False)
	time = models.DateTimeField(default=datetime.datetime.now)
	verified = BooleanField(default=False)
	email = models.EmailField(null=True, unique=False, blank=True, max_length=190)

	def __unicode__(self):
		return self.__str__()

	def __str__(self):
		return str(self.id)

	@property
	def type_enum(self):
		return self.TypeChoices(self.type)

	@type_enum.setter
	def type_enum(self, p_type):
		"""
		:type p_type: Verification.TypeChoices
		"""
		self.type = p_type.value


class UserProfile(User):
	name = CharField(max_length=30, null=True, blank=True)
	surname = CharField(max_length=30, null=True, blank=True)
	# tho email max length is 254 characted mysql supports unique keys only 767 bytes long (utf8 4 bytes = 767/4 = 191)
	email = models.EmailField(null=True, unique=True, blank=True, max_length=190)
	city = CharField(max_length=50, null=True, blank=True)

	birthday = DateField(null=True, blank=True)
	contacts = CharField(max_length=100, null=True, blank=True)
	# fileField + <img instead of ImageField (removes preview link)
	photo = FileField(upload_to=get_random_path, null=True, blank=True)
	suggestions = BooleanField(null=False, default=True)
	embedded_youtube = BooleanField(null=False, default=True)
	highlight_code = BooleanField(null=False, default=False)
	logs = BooleanField(null=False, default=JS_CONSOLE_LOGS)
	theme = CharField(max_length=16, null=False, default='color-reg')
	online_change_sound = BooleanField(null=False, default=True)
	incoming_file_call_sound = BooleanField(null=False, default=True)
	message_sound = BooleanField(null=False, default=True)

	email_verification = models.ForeignKey(Verification, null=True, blank=True)

	def save(self, *args, **kwargs):
		"""
		http://stackoverflow.com/questions/15422606/django-model-email-field-unique-if-not-null-blank
		"""
		if self.email is not None:
			self.email.lower().strip()  # Hopefully reduces junk to ""
			if self.email == "":
				self.email = None
		super(UserProfile, self).save(*args, **kwargs)


class Room(models.Model):
	name = CharField(max_length=16, null=True, blank=True)
	users = models.ManyToManyField(User, related_name='rooms', through='RoomUsers')
	disabled = BooleanField(default=False, null=False)

	@property
	def is_private(self):
		return self.name is None

	def __unicode__(self):
		return self.__str__()

	def __str__(self):
		return "{}/{}".format(self.id, self.name)


def get_milliseconds(dt=None):
	if dt is None:
		return int(time.time()*1000)
	if dt.time.timestamp:
		return int(dt.time.timestamp()*1000)
	else:
		return mktime(dt.time.timetuple()) * 1000 + int(dt.time.microsecond / 1000)


class MessageHistory(models.Model):
	time = models.BigIntegerField(default=get_milliseconds)
	message = models.ForeignKey('Message', null=False)
	content = models.TextField(null=True, blank=True)
	giphy = URLField(null=True, blank=True)


class Message(models.Model):
	"""
	Contains all public messages
	"""
	sender = models.ForeignKey(User, related_name='sender')
	room = models.ForeignKey(Room, null=True)
	# DateField.auto_now
	time = models.BigIntegerField(default=get_milliseconds)
	content = models.TextField(null=True, blank=True)
	# if symbol = null - no images refers this row
	# symbol is the same as "select max(symbol) from images where message_id = message.id
	# we store symbol in this table in case if user edits message
	# - images that refers same message always have unique symbols
	symbol = models.CharField(null=True, max_length=1, blank=True)
	deleted = BooleanField(default=False)
	giphy = URLField(null=True, blank=True)
	edited_times = models.IntegerField(default=0, null=False)

	def __unicode__(self):
		return self.__str__()

	def __str__(self):

		if self.content is None:
			v = ''
		elif len(self.content) > 50:
			v = self.content[:50]
		else:
			v = self.content
		v = json.dumps(v)
		return "{}/{}".format(self.id, v)


class Image(models.Model):
	# character in Message.content that will be replaced with this image
	symbol = models.CharField(null=False, max_length=1)
	message = models.ForeignKey(Message, related_name='message', null=True)
	img = FileField(upload_to=get_random_path, null=True)

	class Meta:
		unique_together = ('symbol', 'message')


class RoomUsers(models.Model):
	room = models.ForeignKey(Room, null=False)
	user = models.ForeignKey(User, null=False)
	last_read_message = models.ForeignKey(Message, null=True)
	volume = models.IntegerField(default=2, null=False)
	notifications = BooleanField(null=False, default=True)

	class Meta:  # pylint: disable=C1001
		unique_together = ("user", "room")
		db_table = ''.join((User._meta.app_label, '_room_users'))


class SubscriptionMessages(models.Model):
	message = models.ForeignKey(Message, null=False)
	subscription = models.ForeignKey(Subscription, null=False)
	received = BooleanField(null=False, default=False)

	class Meta:  # pylint: disable=C1001
		unique_together = ("message", "subscription")
		db_table = ''.join((User._meta.app_label, '_subscription_message'))


class Issue(models.Model):
	content = models.TextField(null=False)  # unique = true, but mysql doesnt allow unique fields for unspecified size

	def __str__(self):
		return self.content


class IssueDetails(models.Model):
	sender = models.ForeignKey(User, null=False)
	browser = models.CharField(null=False, max_length=32, blank=True)
	time = models.DateField(default=datetime.datetime.now, blank=True)
	issue = models.ForeignKey(Issue, related_name='issue')
	log = models.TextField(null=True, blank=True)

	class Meta:  # pylint: disable=C1001
		db_table = ''.join((User._meta.app_label, '_issue_detail'))


class IpAddress(models.Model):
	ip = models.CharField(null=False, max_length=32, unique=True)
	isp = models.CharField(null=True, max_length=32, blank=True)
	country_code = models.CharField(null=True, max_length=16, blank=True)
	country = models.CharField(null=True, max_length=32, blank=True)
	region = models.CharField(null=True, max_length=32, blank=True)
	city = models.CharField(null=True, max_length=32, blank=True)

	def __str__(self):
		return self.ip

	@property
	def info(self):
		if self.country is not None:
			return "{} {} ({})".format(self.country, self.city, self.isp)
		else:
			return ""


	class Meta:  # pylint: disable=C1001
		db_table = ''.join((User._meta.app_label, '_ip_address'))


class UserJoinedInfo(models.Model):
	ip = models.ForeignKey(IpAddress, null=True)
	user = models.ForeignKey(User, null=True)
	time = models.DateField(default=datetime.datetime.now)

	class Meta:  # pylint: disable=C1001
		db_table = ''.join((User._meta.app_label, '_user_joined_info'))
		unique_together = ("user", "ip")


1			import datetime
2			import json
3			import time
4			from enum import Enum
5			from time import mktime
6
7			from django.contrib.auth.models import BaseUserManager, AbstractBaseUser
8			from django.db import models
9			from django.db.models import CharField, DateField, FileField, BooleanField, URLField
10
11			from chat.log_filters import id_generator
12			from chat.settings import GENDERS, DEFAULT_PROFILE_ID, JS_CONSOLE_LOGS
13
14
15			def get_random_path(instance, filename):
16			"""
17			:param filename base string for generated name
18			:return: a unique string filename
19			"""
20			return "{}_{}".format(id_generator(8), filename)
21
22			def myoverridenmeta(name, bases, adict):
23			newClass = type(name, bases, adict)
24			for field in newClass._meta.fields:
25			if field.attname == 'password':
26			field.blank = True
27			return newClass
28
29
30			class User(AbstractBaseUser):
31			def get_short_name(self):
32			return self.username
33
34			def get_full_name(self):
35			return self.username
36
37			@property
38			def is_staff(self):
39			# every registered user can edit database
40			return self.pk == DEFAULT_PROFILE_ID
41
42			def has_perm(self, perm, obj=None):
43			return self.is_staff
44
45			def has_perms(self, perm, obj=None):
46			return True
47
48			def has_module_perms(self, app_label):
49			return self.is_staff
50
51			USERNAME_FIELD = 'username'
52			username = CharField(max_length=30, null=False, unique=True)
53
54			# specifies auth, create email, etc methods
55			objects = BaseUserManager()
56
57			# ISO/IEC 5218 1 male, 2 - female
58			sex = models.SmallIntegerField(null=False, default=0)
59
60			@property
61			def sex_str(self):
62			return GENDERS[self.sex]
63
64			@sex_str.setter
65			def sex_str(self, sex):
66			if sex == 'Male':
67			self.sex = 1
68			elif sex == 'Female':
69			self.sex = 2
70			else:
71			self.sex = 0
72
73			__metaclass__ = myoverridenmeta
74
75
76			class Subscription(models.Model):
77			user = models.ForeignKey(User, null=False)
78			inactive = BooleanField(default=False, null=False)
79			registration_id = models.CharField(null=False, max_length=191, unique=True)
80			created = models.DateTimeField(default=datetime.datetime.now)
81			updated = models.DateTimeField(default=datetime.datetime.now)
82			agent = models.CharField(max_length=64, null=True, blank=True)
83			is_mobile = BooleanField(default=False, null=False, blank=True)
84			ip = models.ForeignKey('IpAddress', null=True, blank=True)
85
86			def __unicode__(self):
87			return self.__str__()
88
89			def __str__(self):
90			return str(self.id)
91
92
93			class Verification(models.Model):
94
95			class TypeChoices(Enum):
96			register = 'r'
97			password = 'p'
98			email = 'e'
99			confirm_email = 'c'
100
101			# a - account activation, r - recover
102			type = models.CharField(null=False, max_length=1)
103			token = models.CharField(max_length=17, null=False, default=id_generator)
104			user = models.ForeignKey(User, null=False)
105			time = models.DateTimeField(default=datetime.datetime.now)
106			verified = BooleanField(default=False)
107			email = models.EmailField(null=True, unique=False, blank=True, max_length=190)
108
109			def __unicode__(self):
110			return self.__str__()
111
112			def __str__(self):
113			return str(self.id)
114
115			@property
116			def type_enum(self):
117			return self.TypeChoices(self.type)
118
119			@type_enum.setter
120			def type_enum(self, p_type):
121			"""
122			:type p_type: Verification.TypeChoices
123			"""
124			self.type = p_type.value
125
126
127			class UserProfile(User):
128			name = CharField(max_length=30, null=True, blank=True)
129			surname = CharField(max_length=30, null=True, blank=True)
130			# tho email max length is 254 characted mysql supports unique keys only 767 bytes long (utf8 4 bytes = 767/4 = 191)
131			email = models.EmailField(null=True, unique=True, blank=True, max_length=190)
132			city = CharField(max_length=50, null=True, blank=True)
133
134			birthday = DateField(null=True, blank=True)
135			contacts = CharField(max_length=100, null=True, blank=True)
136			# fileField + <img instead of ImageField (removes preview link)
137			photo = FileField(upload_to=get_random_path, null=True, blank=True)
138			suggestions = BooleanField(null=False, default=True)
139			embedded_youtube = BooleanField(null=False, default=True)
140			highlight_code = BooleanField(null=False, default=False)
141			logs = BooleanField(null=False, default=JS_CONSOLE_LOGS)
142			theme = CharField(max_length=16, null=False, default='color-reg')
143			online_change_sound = BooleanField(null=False, default=True)
144			incoming_file_call_sound = BooleanField(null=False, default=True)
145			message_sound = BooleanField(null=False, default=True)
146
147			email_verification = models.ForeignKey(Verification, null=True, blank=True)
148
149			def save(self, args, *kwargs):
150			"""
151			http://stackoverflow.com/questions/15422606/django-model-email-field-unique-if-not-null-blank
152			"""
153			if self.email is not None:
154			self.email.lower().strip() # Hopefully reduces junk to ""
155			if self.email == "":
156			self.email = None
157			super(UserProfile, self).save(args, *kwargs)
158
159
160			class Room(models.Model):
161			name = CharField(max_length=16, null=True, blank=True)
162			users = models.ManyToManyField(User, related_name='rooms', through='RoomUsers')
163			disabled = BooleanField(default=False, null=False)
164
165			@property
166			def is_private(self):
167			return self.name is None
168
169			def __unicode__(self):
170			return self.__str__()
171
172			def __str__(self):
173			return "{}/{}".format(self.id, self.name)
174
175
176			def get_milliseconds(dt=None):
177			if dt is None:
178			return int(time.time()*1000)
179			if dt.time.timestamp:
180			return int(dt.time.timestamp()*1000)
181			else:
182			return mktime(dt.time.timetuple()) * 1000 + int(dt.time.microsecond / 1000)
183
184
185			class MessageHistory(models.Model):
186			time = models.BigIntegerField(default=get_milliseconds)
187			message = models.ForeignKey('Message', null=False)
188			content = models.TextField(null=True, blank=True)
189			giphy = URLField(null=True, blank=True)
190
191
192			class Message(models.Model):
193			"""
194			Contains all public messages
195			"""
196			sender = models.ForeignKey(User, related_name='sender')
197			room = models.ForeignKey(Room, null=True)
198			# DateField.auto_now
199			time = models.BigIntegerField(default=get_milliseconds)
200			content = models.TextField(null=True, blank=True)
201			# if symbol = null - no images refers this row
202			# symbol is the same as "select max(symbol) from images where message_id = message.id
203			# we store symbol in this table in case if user edits message
204			# - images that refers same message always have unique symbols
205			symbol = models.CharField(null=True, max_length=1, blank=True)
206			deleted = BooleanField(default=False)
207			giphy = URLField(null=True, blank=True)
208			edited_times = models.IntegerField(default=0, null=False)
209
210			def __unicode__(self):
211			return self.__str__()
212
213			def __str__(self):
214
215			if self.content is None:
216			v = ''
217			elif len(self.content) > 50:
218			v = self.content[:50]
219			else:
220			v = self.content
221			v = json.dumps(v)
222			return "{}/{}".format(self.id, v)
223
224
225			class Image(models.Model):
226			# character in Message.content that will be replaced with this image
227			symbol = models.CharField(null=False, max_length=1)
228			message = models.ForeignKey(Message, related_name='message', null=True)
229			img = FileField(upload_to=get_random_path, null=True)
230
231			class Meta:
232			unique_together = ('symbol', 'message')
233
234
235			class RoomUsers(models.Model):
236			room = models.ForeignKey(Room, null=False)
237			user = models.ForeignKey(User, null=False)
238			last_read_message = models.ForeignKey(Message, null=True)
239			volume = models.IntegerField(default=2, null=False)
240			notifications = BooleanField(null=False, default=True)
241
242			class Meta: # pylint: disable=C1001
243			unique_together = ("user", "room")
244			db_table = ''.join((User._meta.app_label, '_room_users'))
245
246
247			class SubscriptionMessages(models.Model):
248			message = models.ForeignKey(Message, null=False)
249			subscription = models.ForeignKey(Subscription, null=False)
250			received = BooleanField(null=False, default=False)
251
252			class Meta: # pylint: disable=C1001
253			unique_together = ("message", "subscription")
254			db_table = ''.join((User._meta.app_label, '_subscription_message'))
255
256
257			class Issue(models.Model):
258			content = models.TextField(null=False) # unique = true, but mysql doesnt allow unique fields for unspecified size
259
260			def __str__(self):
261			return self.content
262
263
264			class IssueDetails(models.Model):
265			sender = models.ForeignKey(User, null=False)
266			browser = models.CharField(null=False, max_length=32, blank=True)
267			time = models.DateField(default=datetime.datetime.now, blank=True)
268			issue = models.ForeignKey(Issue, related_name='issue')
269			log = models.TextField(null=True, blank=True)
270
271			class Meta: # pylint: disable=C1001
272			db_table = ''.join((User._meta.app_label, '_issue_detail'))
273
274
275			class IpAddress(models.Model):
276			ip = models.CharField(null=False, max_length=32, unique=True)
277			isp = models.CharField(null=True, max_length=32, blank=True)
278			country_code = models.CharField(null=True, max_length=16, blank=True)
279			country = models.CharField(null=True, max_length=32, blank=True)
280			region = models.CharField(null=True, max_length=32, blank=True)
281			city = models.CharField(null=True, max_length=32, blank=True)
282
283			def __str__(self):
284			return self.ip
285
286			@property
287			def info(self):
288			if self.country is not None:
289			return "{} {} ({})".format(self.country, self.city, self.isp)
290			else:
291			return ""
292
293
294			class Meta: # pylint: disable=C1001
295			db_table = ''.join((User._meta.app_label, '_ip_address'))
296
297
298			class UserJoinedInfo(models.Model):
299			ip = models.ForeignKey(IpAddress, null=True)
300			user = models.ForeignKey(User, null=True)
301			time = models.DateField(default=datetime.datetime.now)
302
303			class Meta: # pylint: disable=C1001
304			db_table = ''.join((User._meta.app_label, '_user_joined_info'))
305			unique_together = ("user", "ip")
306

Deathangel908 / pychat

Push — master ( 03af23...349398 )

MessageHistory A

Complexity

Size/Duplication

Importance

Duplication Side-by-Side

Filter issues like