configurationengine/source/plugins/symbian/ConeGenconfmlPlugin/genconfmlplugin/confflattener.py
author m2lahtel
Wed, 08 Sep 2010 12:20:56 +0300
changeset 4 0951727b8815
parent 3 e7e0ae78773e
permissions -rw-r--r--
Updated to 1.2.13 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
# All rights reserved.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
# This component and the accompanying materials are made available
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
# under the terms of "Eclipse Public License v1.0"
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
# which accompanies this distribution, and is available
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
# Initial Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
# Nokia Corporation - initial contribution.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
# Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
# Description: 
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
Configuration flattener
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
'''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
import re
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
import os
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
import sys
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
import logging
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
import xml.parsers.expat
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
try:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
    from cElementTree import ElementTree
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
except ImportError:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
    try:    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
        from elementtree import ElementTree
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
    except ImportError:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
        try:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
            from xml.etree import cElementTree as ElementTree
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
        except ImportError:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
            from xml.etree import ElementTree
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
import __init__
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
from cone.public import exceptions,plugin,utils,api
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
import copy
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
class ConfigurationFlattener():
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
    Configuration flattener
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
    def _init(self):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
        self.logger = logging.getLogger('cone.gcfml(%s)' % self.ref)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
        pass
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
        
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
    def flat(self, conf_from_org, settings, to_config):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
        Flats configuration to one element xml element
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    58
        """ 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
        Get the default view
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
        Create the new flat configuration 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
         """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
        dview_from = conf_from_org.get_default_view()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63
        
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
        """ Go through the required settings """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
        for setting in settings:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
            setting_name = setting.replace('/', '.')
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
            try:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
                for fea in dview_from.get_features(setting_name):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
                    """ Add the given feature ref and its children """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
                    newfea = copy.copy(fea._obj)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
                    to_config.add_feature(newfea, fea.namespace)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
                    for subfeaname in fea.list_features():
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
                        subfea = fea.get_feature(subfeaname)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
                        newfea = copy.copy(subfea._obj)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
                        to_config.add_feature(newfea, subfea.namespace)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    76
            except exceptions.NotFound, e:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
                logging.getLogger('cone.gcfml').warning('Failed to get feature: %s , %s %s' % (setting_name, type(e), e) )
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    78
            except Exception, e:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
                logging.getLogger('cone.gcfml').warning('Failed to flat feature: %s , %s %s' % (setting_name, type(e), e) )
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
                
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
        """ Copy all data values from the existing configuration to the new configuration """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    82
        toview = to_config.get_default_view()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    83
        for fea in toview.get_features('**'):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    84
            fromfea = dview_from.get_feature(fea.fqr)
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    85
            # If the value is an empty list, don't add it.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    86
            # This is because an empty list means that we have
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    87
            # a sequence setting or sequence sub-setting that doesn't have
4
0951727b8815 Updated to 1.2.13 release
m2lahtel
parents: 3
diff changeset
    88
            # any contents, and calling set_value() would create an empty
0951727b8815 Updated to 1.2.13 release
m2lahtel
parents: 3
diff changeset
    89
            # data element to mark the sequence as empty, as the
0951727b8815 Updated to 1.2.13 release
m2lahtel
parents: 3
diff changeset
    90
            # ConfML specification says
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    91
            val = fromfea.get_value()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    92
            if val not in (None, []):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    93
                fea.set_value(val)
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    94
        return to_config
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    95
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    96
    def create_configuration(self, conf_from_org, settings, path="tempfile.confml"):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    97
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    98
        Flats configuration to one feature and data confml
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    99
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   100
        """ 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   101
        Get the default view
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   102
        Create the new flat configuration 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   103
         """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   104
        prj = conf_from_org.get_project()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   105
        flat = prj.create_configuration(path)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   106
        (root,ext) = os.path.splitext(path)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   107
        dataname = "%s_data%s" % (root,ext)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   108
        flat.create_configuration(dataname)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   109
        self.flat(conf_from_org, settings, flat)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   110
        flat.close()