configurationengine/source/plugins/common/ConeRulePlugin/ruleplugin/evals/layer_utils.py
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
# All rights reserved.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
# This component and the accompanying materials are made available
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     4
# under the terms of the License "Symbian Foundation License v1.0"
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
# which accompanies this distribution, and is available
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     6
# at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
# Initial Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
# Nokia Corporation - initial contribution.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
# Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
# Description: 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
'''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
Ruleml eval extension to check is passed ref changed on given layer(range).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
'''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    20
from cone.public import api, plugin
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
import logging
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    23
import re
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
logger = logging.getLogger('cone.ruleplugin.evals.layer_utils')
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    27
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    28
def layers_used(config, layers_or_regex, impl_tags):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    29
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    30
    Return True if matching layers are used by any implementation with given tag.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    31
    @param config: The configuration.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    32
    @param layers_or_regex: List of layer objects to check against, or regular
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    33
        expression (string) for resolving the list of layers.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    34
    @param impl_tags: Implementation tags to use.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    35
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    36
    # Resolve layer list
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    37
    if isinstance(layers_or_regex, basestring):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    38
        layers = []
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    39
        for lay in config.list_configurations():
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    40
            if re.search(layers_or_regex, lay):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    41
                layers.append(config.get_configuration(lay))
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    42
    else:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    43
        layers = layers_or_regex
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    44
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    45
    impls = plugin.filtered_impl_set(config).filter_implementations(tags=impl_tags)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    46
    context = plugin.GenerationContext(tags=impl_tags,
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    47
                                       configuration=config)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    48
    for impl in impls:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    49
        if impl.uses_layers(layers, context) == True:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    50
            return True
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    51
    return False
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    52
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    53
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    54
def get_all_layers(feat):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    55
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    56
    Returns all layers.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    57
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    58
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    59
    root_conf = feat.get_root_configuration()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    60
    result = []
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    61
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    62
    for i in range(0, len(root_conf.list_configurations())):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    63
        result.append(root_conf.get_configuration_by_index(i))
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    64
    return result
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    65
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
def give_changed_layers(feat):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
    Returns a list of booleans where True means that feature is changed in that layer. Index is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
    same than in configuration root's get_configuration_by_index(). 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
    logger.debug('Checking feature: %s' % feat.fqr)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
    root_conf = feat.get_root_configuration()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
    nro_of_layers = len(root_conf.list_configurations())
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    76
    result = []
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
    for i in range(0, nro_of_layers):
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    78
        result.append(_changed_on_layer(feat, root_conf.get_configuration_by_index(i)))
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
    return result
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
def changed_on_last_layer(feat):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    82
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    83
    Returns True if feature is changed in the last layer.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    84
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    85
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    86
    root_conf = feat.get_root_configuration()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    87
    conf = root_conf.get_configuration_by_index(-2)#autoconfig layer is ignored 
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    88
    return _changed_on_layer(feat, conf)
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    89
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    90
def changed_on_autoconfig_layer(feat):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    91
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    92
    Returns True if feature is changed in the autoconfig layer.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    93
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    94
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    95
    root_conf = feat.get_root_configuration()
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    96
    conf = root_conf.get_configuration_by_index(-1)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    97
    return _changed_on_layer(feat, conf)
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    98
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    99
def changed_on_layer(feat, layer):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   100
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   101
    Returns True if feature is changed in the given layer.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   102
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   103
    try:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   104
        return give_changed_layers(feat)[layer]
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   105
    except IndexError:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   106
        logger.warning("Given layer is not found: %s" % (layer))
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   107
        return False
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   108
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   109
def _changed_on_layer(feature, layer_obj):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   110
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   111
    Return whether the given feature is changed on the given layer.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   112
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   113
    # Check recursively if the layer contains any data objects with
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   114
    # the same FQR as the feature
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   115
    def check(node):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   116
        if isinstance(node, api.Data) and node.fqr == feature.fqr:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   117
            return True
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   118
        for obj in node._objects():
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   119
            if check(obj):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   120
                return True
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   121
        return False
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   122
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   123
    return check(layer_obj)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   124
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   125
def changed_on_layers(feat, findex, tindex):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   126
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   127
    Returns True if feature is changed in layer of given range.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   128
    """
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   129
    root_conf = feat.get_root_configuration()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   130
    nro_of_layers = len(root_conf.list_configurations())
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   131
    
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   132
    # Convert negative indices to positive
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   133
    def neg_index_to_pos(index):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   134
        if index < 0:   return nro_of_layers + index
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   135
        else:           return index
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   136
    begin = neg_index_to_pos(findex)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   137
    end = neg_index_to_pos(tindex)
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   138
    
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   139
    if end == begin:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   140
        return changed_on_layer(feat, begin)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   141
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   142
    # Check the layers inside the range
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   143
    if end > begin: index_range = xrange(begin, end)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   144
    else:           index_range = xrange(end, begin)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   145
    for i in index_range:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   146
        if i < 0 or i >= nro_of_layers:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   147
            continue
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   148
        
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   149
        layer = root_conf.get_configuration_by_index(i)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   150
        if _changed_on_layer(feat, layer):
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   151
            return True
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   152
    return False
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   153
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   154
def changed_on_layers_regex(feat, regex):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   155
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   156
    Return whether the given feature is changed on any layer that matches
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   157
    the given regular expression.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   158
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   159
    pattern = re.compile(regex)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   160
    root_conf = feat.get_root_configuration()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   161
    for config_path in root_conf.list_configurations():
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   162
        if pattern.search(config_path):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   163
            layer = root_conf.get_configuration(config_path)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   164
            if _changed_on_layer(feat, layer):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   165
                return True
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   166
    return False
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   167
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   168
def changed_on_custvariant_layer(feat):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   169
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   170
    Return whether the given feature is changed on any of the custvariant layers
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   171
    (layers that match the regex '/custvariant(_.*)?/').
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   172
    """
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   173
    return changed_on_layers_regex(feat, r'/custvariant(_.*)?/')