From 0c313565f2b649366f7382dc1b3f28a3e80f4ffc Mon Sep 17 00:00:00 2001
From: nico <nico@magicbroccoli.de>
Date: Tue, 6 Nov 2018 23:43:11 +0100
Subject: simplification and major rework

* updated gitignore file
* partly reworked servercontact implementation
* complete rework of uptime, version
* part rework of xep requests
+ added more comments to xep requests
+ added opt_arg to version, xep and contact
* complete rework of validate function
* updated HandleError function
* part rework of StaticStrings function
+ implemented data dictionary to hold all data in main bot
+ added message_ids
* complete rework of queue building and deduplication
---
 common/misc.py    | 76 +++++++++++++++++++++++++++++++------------------------
 common/strings.py | 13 +++++-----
 2 files changed, 49 insertions(+), 40 deletions(-)

(limited to 'common')

diff --git a/common/misc.py b/common/misc.py
index 3961b8d..bbf9c55 100755
--- a/common/misc.py
+++ b/common/misc.py
@@ -17,43 +17,53 @@ def deduplicate(reply):
 	return reply_dedup
 
 
-def validate(wordlist, index):
+def validate(keyword, target):
 	"""
 	validation method to reduce malformed querys and unnecessary connection attempts
-	:param wordlist: words separated by " " from the message
-	:param index: keyword index inside the message
+	:param keyword: used keyword
+	:param target: provided target
 	:return: true if valid
 	"""
-	# keyword inside the message
-	argument = wordlist[index]
-
-	# check if argument is in the argument list
-	if argument in StaticAnswers().keys(arg='list'):
-		# if argument uses a domain check for occurrence in list and check domain
-		if argument in StaticAnswers().keys(arg='list', keyword='domain_keywords'):
-			try:
-				target = wordlist[index + 1]
-				if validators.domain(target):
-					return True
-				elif validators.email(target):
-					return True
-
-			except IndexError:
-				# except an IndexError if a keywords is the last word in the message
-				return False
-
-		# check if number keyword is used if true check if target is assignable
-		elif argument in StaticAnswers().keys(arg='list', keyword='number_keywords'):
-			try:
-				if wordlist[index + 1]:
-					return True
-			except IndexError:
-				# except an IndexError if target is not assignable
-				return False
-		# check if argument is inside no_arg list
-		elif argument in StaticAnswers().keys(arg='list', keyword="no_arg_keywords"):
+	# check if keyword is in the argument list
+	if keyword in StaticAnswers().keys():
+
+		# if keyword in domain_keywords list
+		if keyword in StaticAnswers().keys('domain_keywords'):
+			# if target is a domain / email return True
+			if validators.domain(target):
+				return True
+			elif validators.email(target):
+				return True
+
+		# check if keyword is in number_keyword list
+		elif keyword in StaticAnswers().keys('number_keywords'):
+			# if target only consists of digits return True
+			if target.isdigit():
+				return True
+
+		# if keyword is in no_arg_keywords list return True
+		elif keyword in StaticAnswers().keys("no_arg_keywords"):
 			return True
-		else:
-			return False
+
+	# if the target could not be validated until this return False
 	else:
 		return False
+
+
+#
+class HandleError:
+	"""
+	simple XMPP error / exception class formating the error condition
+	"""
+	def __init__(self, error, key, target):
+		# init all necessary variables
+		self.error = error
+		self.key = key
+		self.target = target
+
+	def report(self):
+		# return the formatted result string to the user
+		condition = self.error.condition
+		text = "There was an error requesting %s's %s : %s" % (self.target, self.key, condition)
+
+		return text
diff --git a/common/strings.py b/common/strings.py
index 6866a31..faac65c 100644
--- a/common/strings.py
+++ b/common/strings.py
@@ -29,14 +29,13 @@ class StaticAnswers:
 			"number_keywords": ["!xep"]
 		}
 
-	def keys(self, arg="", keyword='keywords'):
-		if arg == 'list':
-			try:
-				return self.keywords[keyword]
-			except KeyError:
-				return self.keywords['keywords']
+	def keys(self, key=""):
+		# if specific keyword in referenced return that
+		if key in self.keywords.keys():
+			return self.keywords[key]
+		# in any other case return the whole dict
 		else:
-			return self.keywords
+			return self.keywords["keywords"]
 
 	def gen_help(self):
 		helpdoc = "\n".join(['%s' % value for (_, value) in self.helpfile.items()])
-- 
cgit v1.2.3-54-g00ecf