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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
#!/usr/bin/python
import logging
import json
import util
import os
import neo4j_util
import argparse
import db_controller as dbc
import rhizi_api
import flask
import crypt_util
from flask import session
from flask import redirect
from flask import url_for
class Config(object):
"""
rhizi-server configuration
TODO: config option documentation
htpasswd_path
listen_address
listen_port
neo4j_url
root_path
"""
@staticmethod
def init_from_file(file_path):
if False == os.path.exists(file_path):
raise Exception('config file not found: ' + file_path)
# apply defaults
cfg = {}
cfg['access_control'] = True
cfg['config_dir'] = os.path.abspath(os.path.dirname(file_path)) # bypass prop restriction
cfg['development_mode'] = False
cfg['listen_address'] = '127.0.0.1'
cfg['listen_port'] = 8080
cfg['root_path'] = os.getcwd()
cfg['static_url_path'] = '/static'
# Flask keys
cfg['SECRET_KEY'] = ''
with open(file_path, 'r') as f:
for line in f:
if re.match('(^#)|(\s+$)', line):
continue
kv_arr = line.split('=')
if 2 != len(kv_arr):
raise Exception('failed to parse config line: ' + line)
k, v = map(str.strip, kv_arr)
if None != cfg.get(k):
# apply type conversion based on default value type
type_f = type(cfg[k])
if bool == type_f:
v = v in ("True", "true") # workaround bool('false') = True
else:
v = type_f(v)
# [!] we can't use k.lower() as we are loading Flask configuration
# keys which are expected to be capitalized
cfg[k] = v
ret = Config()
ret.__dict__ = cfg # allows setting of @property attributes
return ret
def __str__(self):
return '\n'.join('%s: %s' % (k, v) for k, v in self.__dict__.items())
@property
def db_base_url(self):
return self.neo4j_url
@property
def tx_api_path(self):
return '/db/data/transaction'
@property
def config_dir_path(self):
return self.config_dir
@property
def secret_key(self):
return self.SECRET_KEY
class FlaskExt(Flask):
"""
Flask server customization
"""
def __init__(self, import_name, *args, **kwargs):
"""
reserved for future use
"""
super(FlaskExt, self).__init__(import_name, *args, **kwargs)
def before_request(self, *args, **kwargs):
# TODO impl
pass
def make_default_options_response(self):
ret = Flask.make_default_options_response(self)
ret.headers['Access-Control-Allow-Origin'] = 'http://rhizi.net'
ret.headers['Access-Control-Allow-Headers'] = "Accept, Authorization, Content-Type, Origin"
ret.headers['Access-Control-Allow-Credentials'] = 'true'
# ret.headers['Access-Control-Allow-Methods'] = ', '.join(m_list)
return ret
log = logging.getLogger('rhizi')
log.setLevel(logging.DEBUG)
log_handler_c = logging.StreamHandler()
log_handler_f = logging.FileHandler('/var/log/rhizi/rhizi-server.log')
log.addHandler(log_handler_c)
log.addHandler(log_handler_f)
return log
def init_rest_api(flask_webapp):
"""
map REST API calls
"""
def rest_entry(path, f, flask_args={'methods': ['POST']}):
return (path, f, flask_args)
def login_decorator(f):
"""
[!] security boundary: asserd logged-in user before executing REST api call
"""
@wraps(f)
def wrapped_function(*args, **kw):
if not 'username' in session:
return redirect('/login')
return f(*args, **kw)
return wrapped_function
rest_entry_set = [
rest_entry('/add/node-set' , rhizi_api.add_node_set),
rest_entry('/graph/clone', rhizi_api.rz_clone),
rest_entry('/graph/diff-commit-set', rhizi_api.diff_commit_set),
rest_entry('/graph/diff-commit-topo', rhizi_api.diff_commit_topo),
rest_entry('/graph/diff-commit-attr', rhizi_api.diff_commit_attr),
rest_entry('/graph/diff-commit-vis', rhizi_api.diff_commit_vis),
rest_entry('/index', rhizi_api.index, {'methods': ['GET']}),
rest_entry('/load/node-set-by-id', rhizi_api.load_node_set_by_id_attr),
rest_entry('/load/link-set/by_link_ptr_set', rhizi_api.load_link_set_by_link_ptr_set),
rest_entry('/login', rhizi_api.login, {'methods': ['GET', 'POST']}),
rest_entry('/logout', rhizi_api.logout, {'methods': ['GET', 'POST']}),
rest_entry('/match/node-set', rhizi_api.match_node_set_by_attr_filter_map),
rest_entry('/monitor/server-info', rhizi_api.monitor__server_info),
]
for re_entry in rest_entry_set:
rest_path, f, flask_args = re_entry
if '/login' != rest_path:
# currently require login on all but /login paths
f = login_decorator(f)
# [!] order seems important - apply route decorator last
route_dec = flask_webapp.route(rest_path, **flask_args)
f = route_dec(f)
flask_webapp.f = f # assign decorated function
def init_webapp(cfg):
root_path = cfg.root_path
webapp = rhizi_api.FlaskExt(__name__,
static_folder='static',
template_folder=os.path.join(root_path, 'templates'),
static_url_path='')
webapp.config.from_object(cfg)
webapp.root_path = root_path # for some reason calling config.from_pyfile()
db_ctl = dbc.DB_Controller(cfg)
rhizi_api.db_ctl = db_ctl
webapp.rz_config = cfg
return webapp
def init_config(cfg_dir):
cfg_path = os.path.join(cfg_dir, 'rhizi-server.conf')
cfg = Config.init_from_file(cfg_path)
return cfg
if __name__ == "__main__":
p = argparse.ArgumentParser(description='rhizi-server')
p.add_argument('--config-dir', help='path to Rhizi config dir', default='res/etc')
p.add_argument('--init-htpasswd-db', help='init login htpasswd db', action='store_const', const=True)
args = p.parse_args()
log = init_logging()
cfg = init_config(args.config_dir)
webapp = init_webapp(cfg)
init_rest_api(webapp)
log.info('launching webapp via Flusk development server')
webapp.run(host=cfg.listen_address,
port=cfg.listen_port)
|
