# XML "function" nodes that transform their contents

import datetime

import re

import sre_constants

import warnings

import angles

import dates

import exc

import format

import maps

import sql_io

import strings

import term

import units

import util

import xml_dom

import xpath

##### Exceptions

class SyntaxError(exc.ExceptionWithCause):

    def __init__(self, cause):

        exc.ExceptionWithCause.__init__(self, 'Invalid XML function syntax',

            cause)

class FormatException(exc.ExceptionWithCause):

    def __init__(self, cause):

        exc.ExceptionWithCause.__init__(self, 'Invalid input value', cause)

##### Helper functions

def map_items(func, items):

    return [(name, func(value)) for name, value in items]

def cast(type_, val):

    '''Throws FormatException if can't cast'''

    try: return type_(val)

    except ValueError, e: raise FormatException(e)

def conv_items(type_, items):

    return map_items(lambda val: cast(type_, val),

        xml_dom.TextEntryOnlyIter(items))

def pop_value(items, name='value'):

    '''@param name Name of value param, or None to accept any name'''

    try: last = items.pop() # last entry contains value

    except IndexError: return None # input is empty and no actions

    if name != None and last[0] != name: return None # input is empty

    return last[1]

def merge_tagged(root):

    '''Merges siblings in root that are marked as mergeable.

    Used to recombine pieces of nodes that were split apart in the mappings.

    '''

    for name in set((c.tagName for c in xpath.get(root, '*[@merge=1]'))):

        xml_dom.merge_by_name(root, name)

    # Recurse

    for child in xml_dom.NodeElemIter(root): merge_tagged(child)

funcs = {}

structural_funcs = set()

##### Public functions

def is_func_name(name):

    return name.startswith('_') and name != '_' # '_' is default root node name

def is_func(node): return is_func_name(node.tagName)

def is_xml_func_name(name): return is_func_name(name) and name in funcs

def is_xml_func(node): return is_xml_func_name(node.tagName)

def process(node, on_error=exc.reraise, is_rel_func=None, db=None):

    '''Evaluates the XML functions in an XML tree.

    @param is_rel_func None|f(str) Tests if a name is a relational function.

        * If != None: Non-relational functions are removed, or relational

          functions are treated specially, depending on the db param (below).

    @param db

        * If None: Non-relational functions other than structural functions are

          replaced with their last parameter (usually the value), not evaluated.

          This is used in column-based mode to remove XML-only functions.

        * If != None: Relational functions are evaluated directly. This is used

          in row-based mode to combine relational and XML functions.

    '''

    has_rel_funcs = is_rel_func != None

    assert db == None or has_rel_funcs # rel_funcs required if db set

    for child in xml_dom.NodeElemIter(node):

        process(child, on_error, is_rel_func, db)

    merge_tagged(node)

    name = node.tagName

    if not is_func_name(name): return node # not any kind of function

    row_mode = has_rel_funcs and db != None

    column_mode = has_rel_funcs and db == None

    func = funcs.get(name, None)

    items = list(xml_dom.NodeTextEntryIter(node))

    # Parse function

    if len(items) == 1 and items[0][0].isdigit(): # has single numeric param

        # pass-through optimization for aggregating functions with one arg

        value = items[0][1] # pass through first arg

    elif row_mode and (is_rel_func(name) or func == None): # row-based mode

        value = sql_io.put(db, name, dict(items)) # evaluate using DB

    elif (column_mode and not name in structural_funcs) or func == None:

        # local XML function can't be used or does not exist

        if column_mode and is_rel_func(name): return # preserve relational funcs

        # otherwise XML-only in column mode, or DB-only in XML output mode

        value = pop_value(items, None) # just replace with last param

    else: # local XML function

        try: value = func(items, node)

        except Exception, e: # also catch non-wrapped exceptions (XML func bugs)

            # Save in case another exception raised, overwriting sys.exc_info()

            exc.add_traceback(e)

            str_ = strings.ustr(node)

            exc.add_msg(e, 'function:\n'+str_)

            xml_dom.replace(node, xml_dom.mk_comment(node.ownerDocument,

                '\n'+term.emph_multiline(str_)))

            on_error(e)

            return # in case on_error() returns

    xml_dom.replace_with_text(node, value)

##### XML functions

# Function names must start with _ to avoid collisions with real tags

# Functions take arguments (items)

#### Structural

def _ignore(items, node):

    '''Used to "comment out" an XML subtree'''

    return None

funcs['_ignore'] = _ignore

structural_funcs.add('_ignore')

def _ref(items, node):

    '''Used to retrieve a value from another XML node

    @param items

        addr=<path> XPath to value, relative to the XML func's parent node

    '''

    items = dict(items)

    try: addr = items['addr']

    except KeyError, e: raise SyntaxError(e)

    value = xpath.get_value(node.parentNode, addr)

    if value == None:

        warnings.warn(UserWarning('_ref: XPath reference target missing: '

            +str(addr)))

    return value

funcs['_ref'] = _ref

structural_funcs.add('_ref')

#### Conditionals

def _eq(items, node):

    items = dict(items)

    try:

        left = items['left']

        right = items['right']

    except KeyError: return '' # a value was None

    return util.bool2str(left == right)

funcs['_eq'] = _eq

def _if(items, node):

    items = dict(items)

    try:

        cond = items['cond']

        then = items['then']

    except KeyError, e: raise SyntaxError(e)

    else_ = items.get('else', None)

    cond = bool(cast(strings.ustr, cond))

    if cond: return then

    else: return else_

funcs['_if'] = _if

#### Transforming values

def _collapse(items, node):

    '''Collapses a subtree if the "value" element in it is NULL'''

    items = dict(items)

    try: require = cast(strings.ustr, items['require'])

    except KeyError, e: raise SyntaxError(e)

    value = items.get('value', None)

    if xpath.get_value(value, require, allow_rooted=False) == None: return None

    else: return value

funcs['_collapse'] = _collapse

def repl(repls, value):

    '''Raises error if value not in map and no special '*' entry

    @param repls dict repl:with

        repl "*" means all other input values

        with "*" means keep input value the same

        with "" means ignore input value

    '''

    try: new_value = repls[value]

    except KeyError, e:

        # Save traceback right away in case another exception raised

        fe = FormatException(e)

        try: new_value = repls['*']

        except KeyError: raise fe

    if new_value == '*': new_value = value # '*' means keep input value the same

    return new_value

def _map(items, node):

    '''See repl()

    @param items

        <last_entry> Value

        <other_entries> name=value Mappings. Special values: See repl() repls.

    '''

    items = conv_items(strings.ustr, items) # get *once* from iter, check types

    value = pop_value(items)

    if value == None: return None # input is empty

    return util.none_if(repl(dict(items), value), u'') # empty value means None

funcs['_map'] = _map

def _replace(items, node):

    items = conv_items(strings.ustr, items) # get *once* from iter, check types

    value = pop_value(items)

    if value == None: return None # input is empty

    try:

        for repl, with_ in items:

            if re.match(r'^\w+$', repl):

                repl = r'(?<![^\W_])'+repl+r'(?![^\W_])' # match whole word

            value = re.sub(repl, with_, value)

    except sre_constants.error, e: raise SyntaxError(e)

    return util.none_if(value.strip(), u'') # empty strings always mean None

funcs['_replace'] = _replace

#### Quantities

def _units(items, node):

    items = conv_items(strings.ustr, items) # get *once* from iter, check types

    value = pop_value(items)

    if value == None: return None # input is empty

    quantity = units.str2quantity(value)

    try:

        for action, units_ in items:

            units_ = util.none_if(units_, u'')

            if action == 'default': units.set_default_units(quantity, units_)

            elif action == 'to':

                try: quantity = units.convert(quantity, units_)

                except ValueError, e: raise FormatException(e)

            else: raise SyntaxError(ValueError('Invalid action: '+action))

    except units.MissingUnitsException, e: raise FormatException(e)

    return units.quantity2str(quantity)

funcs['_units'] = _units

def parse_range(str_, range_sep='-'):

    default = (str_, None)

    start, sep, end = str_.partition(range_sep)

    if sep == '': return default # not a range

    if start == '' and range_sep == '-': return default # negative number

    return tuple(d.strip() for d in (start, end))

def _rangeStart(items, node):

    items = dict(conv_items(strings.ustr, items))

    try: value = items['value']

    except KeyError: return None # input is empty

    return parse_range(value)[0]

funcs['_rangeStart'] = _rangeStart

def _rangeEnd(items, node):

    items = dict(conv_items(strings.ustr, items))

    try: value = items['value']

    except KeyError: return None # input is empty

    return parse_range(value)[1]

funcs['_rangeEnd'] = _rangeEnd

def _range(items, node):

    items = dict(conv_items(float, items))

    from_ = items.get('from', None)

    to = items.get('to', None)

    if from_ == None or to == None: return None

    return str(to - from_)

funcs['_range'] = _range

def _avg(items, node):

    count = 0

    sum_ = 0.

    for name, value in conv_items(float, items):

        count += 1

        sum_ += value

    if count == 0: return None # input is empty

    else: return str(sum_/count)

funcs['_avg'] = _avg

class CvException(Exception):

    def __init__(self):

        Exception.__init__(self, 'CV (coefficient of variation) values are only'

            ' allowed for ratio scale data '

            '(see <http://en.wikipedia.org/wiki/Coefficient_of_variation>)')

def _noCV(items, node):

    items = list(conv_items(strings.ustr, items))

    try: name, value = items.pop() # last entry contains value

    except IndexError: return None # input is empty

    if re.match('^(?i)CV *\d+$', value): raise FormatException(CvException())

    return value

funcs['_noCV'] = _noCV

#### Names

_name_parts_slices_items = [

    ('first', slice(None, 1)),

    ('middle', slice(1, -1)),

    ('last', slice(-1, None)),

]

name_parts_slices = dict(_name_parts_slices_items)

name_parts = [name for name, slice_ in _name_parts_slices_items]

def _name(items, node):

    items = dict(list(conv_items(strings.ustr, items)))

    parts = []

    for part in name_parts:

        if part in items: parts.append(items[part])

    return ' '.join(parts)

funcs['_name'] = _name

#### Angles

def _compass(items, node):

    '''Converts a compass direction (N, NE, NNE, etc.) into a degree heading'''

    items = dict(conv_items(strings.ustr, items))

    try: value = items['value']

    except KeyError: return None # input is empty

    if not value.isupper(): return value # pass through other coordinate formats

    try: return util.cast(str, angles.compass2heading(value)) # ignore None

    except KeyError, e: raise FormatException(e)

funcs['_compass'] = _compass

#### Paths

def _simplifyPath(items, node):

    items = dict(items)

    try:

        next = cast(strings.ustr, items['next'])

        require = cast(strings.ustr, items['require'])

        root = items['path']

    except KeyError, e: raise SyntaxError(e)

    node = root

    while node != None:

        new_node = xpath.get_1(node, next, allow_rooted=False)

        if xpath.get_value(node, require, allow_rooted=False) == None: # empty

            xml_dom.replace(node, new_node) # remove current elem

            if node is root: root = new_node # also update root

        node = new_node

    return root

funcs['_simplifyPath'] = _simplifyPath