aboutsummaryrefslogtreecommitdiffstats
path: root/main.py
blob: 2fcb83d9814804377489fd8b0bff30c47ebc63af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# workflow
# start options main.py --dry-run --outfile file
import requests
import os
import sys
import argparse
from ruamel.yaml import YAML, scalarstring


class BlacklistImporter:
	def __init__(self, args):
		self.outfile = args.outfile
		self.dryrun = args.dryrun
		self.url = "https://raw.githubusercontent.com/JabberSPAM/blacklist/master/blacklist.txt"
		self.blacklist = ""
		self.change = False

	def request(self):
		"""
		determine if the download is required
		"""
		# check if etag header is present if not set local_etag to ""
		if os.path.isfile(".etag"):
			# catch special case were etag file is present and blacklist.txt is not
			if not os.path.isfile("blacklist.txt"):
				local_etag = ""
			else:
				# if both files are present continue normally
				with open(".etag", "r") as file:
					local_etag = file.read()
		else:
			local_etag = ""

		with requests.Session() as s:
			# head request to check etag
			head = s.head(self.url)
			etag = head.headers['etag']

			# if etags match up or if the connection is not possible fall back to local cache
			if local_etag == etag or head.status_code != 200:
				# if local cache is present overwrite blacklist var
				if os.path.isfile("blacklist.txt"):
					with open("blacklist.txt", "r", encoding="utf-8") as file:
						self.blacklist = file.read()

			# in any other case request a new file
			else:
				r = s.get(self.url)
				r.encoding = 'utf-8'
				local_etag = head.headers['etag']
				self.blacklist = r.content.decode()

				with open("blacklist.txt", "w") as file:
					file.write(self.blacklist)

				with open('.etag', 'w') as file:
					file.write(local_etag)

	def main(self):
		# first check if blacklist is updated
		self.request()

		if self.dryrun:
			# only output the selected software and outfile
			print("outfile selected: %s" % self.outfile)

		# select ejabberd processing
		self.process()

		# reload config if changes have been applied
		if self.change:
			os.system("ejabberdctl reload_config")

	def process(self):
		"""
		function to build and compare the local yaml file to the remote file
		if the remote file is different, the local file gets overwritten
		"""
		# init new YAML variable
		local_file = YAML(typ="safe")

		# prevent None errors
		if self.outfile is not None:
			# prevent FileNotFoundError on first run or file missing
			if os.path.isfile(self.outfile):
				local_file = local_file.load(open(self.outfile, "r", encoding="utf-8"))

		# blacklist frame
		remote_file = {
			"acl": {
				"spamblacklist": {
					"server": []
				}
			}
		}

		# build the blacklist with the given frame to compare to local blacklist
		for entry in self.blacklist.split():
			entry = scalarstring.DoubleQuotedScalarString(entry)
			remote_file["acl"]["spamblacklist"]["server"].append(entry)

		yml = YAML()
		yml.indent(offset=2)
		yml.default_flow_style = False

		if self.dryrun:
			# if dryrun true print expected content
			yml.dump(remote_file, sys.stdout)

		elif local_file != remote_file:
			self.change = True
			# only if the local_file and remote_file are unequal write new file
			yml.dump(remote_file, open(self.outfile, "w"))


if __name__ == "__main__":
	parser = argparse.ArgumentParser()
	parser.add_argument('-o', '--outfile', help='set path to output file', dest='outfile', default=None)
	parser.add_argument('-dr', '--dry-run', help='perform a dry run', action='store_true', dest='dryrun', default=False)
	args = parser.parse_args()

	# run
	BlacklistImporter(args).main()