#!/usr/bin/python import argparse from flask import Flask from flask import Response from flask import redirect from flask import request from flask import send_from_directory from flask import session import flask from functools import wraps import logging import os import re import db_controller as dbc import rz_api import rz_api_rest import rz_feedback from rz_kernel import RZ_Kernel from rz_mesh import init_ws_interface 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' cfg['htpasswd_path'] = os.path.join(cfg['config_dir'], 'htpasswd') # Mail settings cfg['mail_hostname'] = 'localhost' cfg['mail_port'] = 25 # User feedback settings cfg['feedback_recipient'] = 'feedback@localhost' # 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 # validate config if False == os.path.isabs(ret.root_path): ret.root_path = os.path.abspath(ret.root_path) return ret def __str__(self): kv_item_set = [] for k, v in self.__dict__.items(): if k == 'SECRET_KEY': # exclude key from logs v = v[:3] + '...' kv_item_set.append('%s: %s' % (k, v)) kv_item_set.sort() return '\n'.join(kv_item_set) @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 def init_log(cfg): """ init log file, location derived from configuration """ log = logging.getLogger('rhizi') log.setLevel(logging.DEBUG) log_handler_c = logging.StreamHandler() log_handler_f = logging.FileHandler(cfg.log_path) log.addHandler(log_handler_c) log.addHandler(log_handler_f) return log def init_rest_interface(cfg, flask_webapp): """ Initialize REST interface """ def rest_entry(path, f, flask_args={'methods': ['POST']}): return (path, f, flask_args) def redirect_entry(path, path_to, flask_args): def redirector(): return redirect(path_to, code=302) redirector.func_name = 'redirector_%s' % path.replace('/', '_') return (path, redirector, 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 = [ redirect_entry('/', '/index', {'methods': ['GET']}), redirect_entry('/index.html', '/index', {'methods': ['GET']}), rest_entry('/graph/clone', rz_api.rz_clone), rest_entry('/graph/diff-commit-set', rz_api.diff_commit__set), rest_entry('/graph/diff-commit-topo', rz_api_rest.diff_commit__topo), rest_entry('/graph/diff-commit-attr', rz_api_rest.diff_commit__attr), rest_entry('/graph/diff-commit-vis', rz_api_rest.diff_commit__vis), rest_entry('/index', rz_api.index, {'methods': ['GET']}), rest_entry('/load/node-set-by-id', rz_api.load_node_set_by_id_attr), rest_entry('/load/link-set/by_link_ptr_set', rz_api.load_link_set_by_link_ptr_set), rest_entry('/login', rz_api.login, {'methods': ['GET', 'POST']}), rest_entry('/logout', rz_api.logout, {'methods': ['GET', 'POST']}), rest_entry('/match/node-set', rz_api.match_node_set_by_attr_filter_map), rest_entry('/monitor/server-info', rz_api.monitor__server_info), rest_entry('/feedback', rz_feedback.send_user_feedback__email), ] # FIXME: but should be rate limited (everything should be, regardless of login) no_login_paths = ['/login', '/feedback'] for re_entry in rest_entry_set: rest_path, f, flask_args = re_entry if cfg.access_control and rest_path not in no_login_paths: # 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 # install 404 handler to redirect to root - which redirects further to login (index if access disabled) @flask_webapp.errorhandler(404) def page_not_found(e): # FIXME: template for 404 which redirects (html, not http) log.debug("failed redirection: request = %s" % request) return redirect('/') def init_webapp(cfg, kernel, db_ctl=None): """ Initialize webapp: - call init_rest_interface() """ root_path = cfg.root_path webapp = FlaskExt(__name__, static_folder='static', template_folder=os.path.join(root_path, 'templates'), static_url_path=cfg.static_url_path) webapp.config.from_object(cfg) webapp.root_path = root_path # for some reason calling config.from_xxx() does not have effect if None == db_ctl: db_ctl = dbc.DB_Controller(cfg) rz_api.db_ctl = db_ctl rz_api_rest.db_ctl = db_ctl kernel.db_ctl = db_ctl webapp.rz_config = cfg webapp.kernel = kernel init_rest_interface(cfg, webapp) 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') args = p.parse_args() cfg = init_config(args.config_dir) log = init_log(cfg) cfg_indent_str = ' ' + str(cfg).replace('\n', '\n ') log.debug('loaded configuration:\n%s' % cfg_indent_str) # print indented if False == cfg.access_control: log.warn('access control disabled, all-granted access set on all URLs') kernel = RZ_Kernel() webapp = init_webapp(cfg, kernel) ws_srv = init_ws_interface(cfg, kernel, webapp) ws_srv.serve_forever()