Project

General

Profile

1 13 aaronmk
# XML-database conversion
2
3 2418 aaronmk
import copy
4 16 aaronmk
import re
5 13 aaronmk
from xml.dom import Node
6
7 446 aaronmk
import exc
8 2436 aaronmk
import Parser
9 46 aaronmk
import sql
10 2268 aaronmk
import sql_gen
11 84 aaronmk
import strings
12 133 aaronmk
import util
13 46 aaronmk
import xml_dom
14 2113 aaronmk
import xml_func
15 2436 aaronmk
import xpath
16 13 aaronmk
17 139 aaronmk
def name_of(node): return re.sub(r'^.*\.', r'', node.tagName)
18 16 aaronmk
19 13 aaronmk
ptr_suffix = '_id'
20
21 138 aaronmk
def is_ptr(node_name): return node_name.lower().endswith(ptr_suffix)
22 13 aaronmk
23 172 aaronmk
def ptr_type_guess(node_name):
24 13 aaronmk
    assert is_ptr(node_name)
25
    return node_name[:-len(ptr_suffix)]
26
27
def ptr_target(node):
28
    assert is_ptr(name_of(node))
29 2113 aaronmk
    return xml_dom.value_node(node)
30 13 aaronmk
31
def find_by_name(node, name):
32 46 aaronmk
    for parent in xml_dom.NodeParentIter(node):
33 13 aaronmk
        if name_of(parent) == name: return parent
34
        else:
35 46 aaronmk
            for child in xml_dom.NodeElemIter(parent):
36 16 aaronmk
                child_name = name_of(child)
37 13 aaronmk
                if is_ptr(child_name):
38 172 aaronmk
                    target = ptr_target(child)
39
                    if target.tagName == name: return target
40 13 aaronmk
                elif child_name == name: return child
41
    return None
42
43 1850 aaronmk
def get(db, node, limit=None, start=None):
44
    def pkey(table): return sql.pkey(db, table)
45 126 aaronmk
46 141 aaronmk
    node = node.firstChild
47 135 aaronmk
    table = name_of(node)
48
    pkey_ = pkey(table)
49
50
    fields = []
51
    conds = {}
52 133 aaronmk
    for child in xml_dom.NodeElemIter(node):
53 135 aaronmk
        child_name = name_of(child)
54
        if xml_dom.is_empty(child): fields.append(child_name)
55
        elif xml_dom.is_text(child): conds[child_name] = xml_dom.value(child)
56
        else: raise Exception('Joins not supported yet')
57
    id_ = xml_dom.get_id(node)
58 1836 aaronmk
    if id_ != None: conds[pkey(table)] = id_ # replace any existing pkey value
59 135 aaronmk
    if fields == []: fields.append(pkey_)
60 133 aaronmk
61 864 aaronmk
    return sql.select(db, table, fields, conds, limit, start)
62 126 aaronmk
63 1864 aaronmk
def put(db, node, row_ct_ref=None, on_error=exc.raise_, pool=None,
64
    store_ids=False, parent_id=None):
65 138 aaronmk
    '''store_ids enables searching the tree for missing fields'''
66 1850 aaronmk
    def pkey(table): return sql.pkey(db, table, True)
67 15 aaronmk
68 461 aaronmk
    def put_(node, parent_id=None):
69 1874 aaronmk
        args = (db, node, row_ct_ref, on_error, pool, store_ids, parent_id)
70
        if parent_id != None and pool != None: pool.apply_async(put, args)
71
        else: return put(*args)
72 461 aaronmk
73
    def on_error_(e):
74 446 aaronmk
        exc.add_msg(e, 'node:\n'+str(node))
75 461 aaronmk
        on_error(e)
76 446 aaronmk
77 48 aaronmk
    table = name_of(node)
78 446 aaronmk
    try: pkey_ = pkey(table)
79 461 aaronmk
    except sql.DatabaseErrors, e: on_error_(e); return None
80 48 aaronmk
    row = {}
81
    children = []
82 13 aaronmk
83 48 aaronmk
    # Divide children into fields and children with fkeys to parent
84
    for child in xml_dom.NodeElemIter(node):
85
        child_name = name_of(child)
86 463 aaronmk
        if xml_dom.is_empty(child): row[child_name] = None
87 454 aaronmk
        elif xml_dom.is_text(child):
88 84 aaronmk
            row[child_name] = strings.to_unicode(xml_dom.value(child))
89 461 aaronmk
        elif is_ptr(child_name): row[child_name] = put_(ptr_target(child))
90 48 aaronmk
        else: children.append(child)
91
    try: del row[pkey_]
92
    except KeyError: pass
93
94
    # Add fkey to parent
95 59 aaronmk
    if parent_id != None:
96
        parent_ptr = node.getAttribute('fkey')
97
        if parent_ptr == '': parent_ptr = pkey(name_of(node.parentNode))
98
        row[parent_ptr] = parent_id
99 48 aaronmk
100
    # Insert node
101 446 aaronmk
    try:
102
        for try_num in xrange(2):
103
            try:
104 472 aaronmk
                id_ = sql.put(db, table, row, pkey_, row_ct_ref)
105 446 aaronmk
                if store_ids: xml_dom.set_id(node, id_)
106
                break
107
            except sql.NullValueException, e:
108 468 aaronmk
                col = e.cols[0]
109 446 aaronmk
                if try_num > 0: raise # exception still raised after retry
110 468 aaronmk
                if store_ids and is_ptr(col):
111 446 aaronmk
                    # Search for required column in ancestors and their children
112 468 aaronmk
                    target = find_by_name(node, ptr_type_guess(col))
113 446 aaronmk
                    if target == None: raise
114 468 aaronmk
                    row[col] = xml_dom.get_id(target)
115 446 aaronmk
                else: raise
116 461 aaronmk
    except sql.DatabaseErrors, e: on_error_(e); return None
117 48 aaronmk
118
    # Insert children with fkeys to parent
119 1874 aaronmk
    for child in children: put_(child, id_)
120 48 aaronmk
121
    return id_
122 1996 aaronmk
123 2039 aaronmk
class ColRef:
124
    '''A reference to a table column'''
125
    def __init__(self, name, idx):
126
        self.name = name
127
        self.idx = idx
128
129
    def __str__(self): return self.name
130
131 2177 aaronmk
input_col_prefix = '$'
132
133 2422 aaronmk
def put_table(db, node, in_table, commit=False, in_row_ct_ref=None,
134
    row_ins_ct_ref=None, limit=None, start=0, parent_ids_loc=None):
135 1996 aaronmk
    '''
136 1998 aaronmk
    @param node The XML tree that transforms the input to the output. Similar to
137 2177 aaronmk
        put()'s node param, but with the input column name prefixed by
138
        input_col_prefix in place of the column value.
139 1998 aaronmk
    @param commit Whether to commit after each query
140 2133 aaronmk
    @return (table, col) Where the pkeys (from INSERT RETURNING) are made
141 2067 aaronmk
        available
142 1998 aaronmk
    '''
143 2418 aaronmk
    in_table = sql_gen.as_Table(in_table)
144
145 2423 aaronmk
    # Subset in_table
146 2418 aaronmk
    if limit != None or start != 0:
147
        in_table = copy.copy(in_table) # don't modify input!
148
        sql.run_query_into(db, *sql.mk_select(db, in_table, limit=limit,
149
            start=start, order_by=None), into=in_table)
150
            # in_table won't be overwritten because of automatic versioning
151
152 2005 aaronmk
    def pkey(table): return sql.pkey(db, table, True)
153
154 2177 aaronmk
    def put_table_(node, parent_ids_loc=None):
155 2437 aaronmk
        return put_table(db, node, in_table, commit,
156
            row_ins_ct_ref=row_ins_ct_ref, parent_ids_loc=parent_ids_loc)
157 2088 aaronmk
158 2005 aaronmk
    out_table = name_of(node)
159 2434 aaronmk
    special_funcs = set(['_simplifyPath'])
160
    is_func = out_table in special_funcs
161 2432 aaronmk
162
    # Divide children into fields and children with fkeys to parent
163 2005 aaronmk
    row = {}
164
    children = []
165
    for child in xml_dom.NodeElemIter(node):
166
        child_name = name_of(child)
167
        if xml_dom.is_empty(child): row[child_name] = None
168
        elif xml_dom.is_text(child):
169
            row[child_name] = strings.to_unicode(xml_dom.value(child))
170 2113 aaronmk
        else:
171
            child_value = xml_dom.value_node(child)
172 2434 aaronmk
            if is_func or is_ptr(child_name) or xml_func.is_func(child_value):
173 2432 aaronmk
                row[child_name] = child_value
174 2113 aaronmk
            else: children.append(child)
175 2434 aaronmk
176
    # Special handling for structural XML functions
177
    if out_table == '_simplifyPath':
178 2436 aaronmk
        # Parse args
179
        def wrap_e(e): raise xml_func.SyntaxError(e)
180 2434 aaronmk
        try:
181
            next = row['next']
182
            require = row['require']
183
            path = row['path']
184 2436 aaronmk
        except KeyError, e: wrap_e(e)
185
        try: next = xpath.parse(next)
186
        except Parser.SyntaxError, e: wrap_e(e)
187
        try: next = next[0].name
188
        except IndexError, e: wrap_e(e)
189 2434 aaronmk
190
        # For now, just skip XML func
191
        return put_table_(path, parent_ids_loc)
192
193
    # Remove any explicit pkey
194 2133 aaronmk
    try: del row[pkey(out_table)]
195 2005 aaronmk
    except KeyError: pass
196
197 2177 aaronmk
    # Add fkey to parent
198
    if parent_ids_loc != None:
199
        parent_ptr = node.getAttribute('fkey')
200
        if parent_ptr == '': parent_ptr = pkey(name_of(node.parentNode))
201
        row[parent_ptr] = parent_ids_loc
202
203 2060 aaronmk
    # Divide fields into input columns and literal values
204 2313 aaronmk
    in_tables = [in_table]
205 2060 aaronmk
    for out_col, value in row.iteritems():
206 2432 aaronmk
        # Handle forward pointers
207
        if xml_dom.is_node(value): row[out_col] = value = put_table_(value)
208
209
        # Translate values
210 2268 aaronmk
        if isinstance(value, sql_gen.Col): # value is temp table column
211
            in_tables.append(value.table)
212 2177 aaronmk
        elif util.is_str(value) and value.startswith(input_col_prefix):
213
            # value is input column
214 2272 aaronmk
            row[out_col] = sql_gen.Col(strings.remove_prefix(input_col_prefix,
215 2313 aaronmk
                value), in_table)
216 2177 aaronmk
        else: # value is literal value; should only be string or None
217
            assert util.is_str(value) or value == None
218 2323 aaronmk
            row[out_col] = sql_gen.NamedCol(out_col, value)
219 2060 aaronmk
220
    # Insert node
221 2459 aaronmk
    db.log_debug('Putting columns: '+str(row), level=1.5)
222 2422 aaronmk
    pkeys_loc = sql.put_table(db, out_table, in_tables, row, row_ins_ct_ref)
223 2182 aaronmk
    if commit: db.db.commit()
224 2060 aaronmk
225 2177 aaronmk
    # Insert children with fkeys to parent
226
    for child in children: put_table_(child, pkeys_loc)
227
228 2423 aaronmk
    # Count # rows and update in_row_ct_ref once all columns have been processed
229
    if in_row_ct_ref != None:
230 2427 aaronmk
        in_row_ct_ref[0] += sql.table_row_count(db, in_table)
231 2423 aaronmk
232 2133 aaronmk
    return pkeys_loc