summaryrefslogtreecommitdiff
path: root/src/server/rz_api.py
blob: 40d305c4aec6bd1cd23ba2270a578c95cbd100b2 (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
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
"""
Rhizi web API

@deprecated: destined to split into rz_api_rest & rz_api_websocket
"""
from flask import current_app
from flask import escape
from flask import render_template
from flask import request
from flask import session
import logging
import traceback

from db_op import DBO_diff_commit__topo
from db_op import DBO_load_link_set
from db_op import DBO_match_node_id_set
from db_op import DBO_match_node_set_by_id_attribute
from db_op import DBO_rz_clone
from model.graph import Topo_Diff
from model.model import Link
from rz_api_common import __sanitize_input, map_rzdoc_name_to_rzdoc_id
from rz_api_common import sanitize_input__topo_diff
from rz_api_rest import common_resp_handle
from neo4j_cypher import QT_Node_Filter__Doc_ID_Label


log = logging.getLogger('rhizi')

db_ctl = None  # injected: DB controller

def __common_exec(op, on_success=common_resp_handle, on_error=common_resp_handle):
    """
    @param on_success: should return a Flask Response object
    @param on_error: should return a Flask Response object
    """
    try:
        op_ret = db_ctl.exec_op(op)
        return on_success(op_ret)
    except Exception as e:
        log.error(e.message)
        log.error(traceback.print_exc())
        return on_error(error='error occurred')

def load_node_set_by_id_attr():
    """
    load node-set by ID attribute
    
    @param id_set: list of node ids to match id attribute against
    @return: a list of nodes whose id attribute matches 'id' or
            an empty list if the requested node is not found
    @raise exception: on error
    """
    req_json = request.get_json()
    id_set = req_json['id_set']

    __sanitize_input(id_set)

    return __load_node_set_by_id_attr_common(id_set)

def __load_node_set_by_id_attr_common(id_set):
    """
    @param f_k: optional attribute filter key
    @param f_vset: possible key values to match against
    """
    op = DBO_match_node_set_by_id_attribute(id_set=id_set)
    try:
        n_set = db_ctl.exec_op(op)
        return common_resp_handle(data=n_set)
    except Exception as e:
        log.exception(e)
        return common_resp_handle(error='unable to load node with ids: {0}'.format(id_set))

def match_node_set_by_attr_filter_map(attr_filter_map):
    """
    @param attr_filter_map
    
    @return: a set of node DB id's
    """
    op = DBO_match_node_id_set(attr_filter_map)
    return __common_exec(op)

def load_link_set_by_link_ptr_set():

    def deserialize_param_set(param_json):
        l_ptr_set_raw = param_json['link_ptr_set']

        __sanitize_input(l_ptr_set_raw)

        l_ptr_set = []
        for lptr_dict in l_ptr_set_raw:
            src_id = lptr_dict.get('__src_id')
            dst_id = lptr_dict.get('__dst_id')
            l_ptr_set += [Link.Link_Ptr(src_id=src_id, dst_id=dst_id) ]

        return l_ptr_set

    l_ptr_set = deserialize_param_set(request.get_json())

    op = DBO_load_link_set.init_from_link_ptr_set(l_ptr_set)
    return __common_exec(op)

def rz_clone():

    def sanitize_input(req):
        rzdoc_name = req.get_json().get('rzdoc_name')
        return rzdoc_name

    def on_success(topo_diff):
        # serialize Topo_Diff before including in response
        topo_diff_json = topo_diff.to_json_dict()
        return common_resp_handle(topo_diff_json)

    rzdoc_name = sanitize_input(request)
    if None == rzdoc_name: # load welcome doc by default
        rzdoc_name = current_app.rz_config.rzdoc_name__mainpage

    rzdoc_id = map_rzdoc_name_to_rzdoc_id(rzdoc_name)

    op = DBO_rz_clone()
    op = QT_Node_Filter__Doc_ID_Label(rzdoc_id)(op)
    return __common_exec(op, on_success=on_success)

def diff_commit__set():
    """
    commit a diff set
    """
    def sanitize_input(req):
        diff_set_dict = req.get_json()['diff_set']
        topo_diff_dict = diff_set_dict['__diff_set_topo'][0]
        topo_diff = Topo_Diff.from_json_dict(topo_diff_dict)

        sanitize_input__topo_diff(topo_diff)
        return topo_diff;

    topo_diff = sanitize_input(request)

    op = DBO_diff_commit__topo(topo_diff)
    return __common_exec(op)

def index():

    # fetch rz_username for welcome message
    email_address = session.get('username')
    rz_username = "Anonymous Stranger"
    role_set = []
    if None != email_address:  # session cookie passed & contains uid (email_address)
        try:
            uid, u_account = current_app.user_db.lookup_user__by_email_address(email_address)
            role_set = u_account.role_set
            rz_username = escape(u_account.rz_username)
        except Exception as e:
            # may occur on user_db reset or malicious cookie != stale cookie,
            # for which the user would at least be known to the user_db
            log.exception(e)

    # establish rz_config template values
    client_POV_server_name = request.headers.get('X-Forwarded-Host')  # first probe for reverse proxy headers
    if None == client_POV_server_name:
        client_POV_server_name = request.headers.get('Host')  # otherwise use Host: header
    assert None != client_POV_server_name, 'failed to establish hostname, unable to construct rz_config'

    hostname = client_POV_server_name
    port = 80
    if ':' in client_POV_server_name:
        hostname = client_POV_server_name.split(':')[0]
        port = client_POV_server_name.split(':')[1]

    return render_template('index.html',
                           rz_username=rz_username,
                           rz_config__hostname=hostname,
                           rz_config__port=port,
                           rz_config__optimized_main='true' if current_app.rz_config.optimized_main else 'false',
                           rz_config__role_set=role_set)