1

"""

     2

Config Tree Node base class.

     3

     4

- A Beremiz project is organized in a tree each node derivate from ConfigTreeNode

     5

- Project tree organization match filesystem organization of project directory.

     6

- Each node of the tree have its own xml configuration, whose grammar is defined for each node type, as XSD

     7

- ... TODO : document

     8

"""

     9

    10

import os,traceback,types

    11

import shutil

    12

from xml.dom import minidom

    13

    14

from xmlclass import GenerateClassesFromXSDstring

    15

from util import GetClassImporter

    16

    17

from PLCControler import PLCControler, LOCATION_CONFNODE

    19

    20

_BaseParamsClass = GenerateClassesFromXSDstring("""<?xml version="1.0" encoding="ISO-8859-1" ?>

    21

        <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    22

          <xsd:element name="BaseParams">

    23

            <xsd:complexType>

    24

              <xsd:attribute name="Name" type="xsd:string" use="optional" default="__unnamed__"/>

    25

              <xsd:attribute name="IEC_Channel" type="xsd:integer" use="required"/>

    26

              <xsd:attribute name="Enabled" type="xsd:boolean" use="optional" default="true"/>

    27

            </xsd:complexType>

    28

          </xsd:element>

    29

        </xsd:schema>""")["BaseParams"]

    30

    31

NameTypeSeparator = '@'

    32

    33

class ConfigTreeNode:

    34

    """

    35

    This class is the one that define confnodes.

    36

    """

    37

    38

    XSD = None

    39

    CTNChildrenTypes = []

    40

    CTNMaxCount = None

    41

    ConfNodeMethods = []

    42

    LibraryControler = None

    44

    IconPath = None

    45

    46

    def _AddParamsMembers(self):

    47

        self.CTNParams = None

    48

        if self.XSD:

    49

            self.Classes = GenerateClassesFromXSDstring(self.XSD)

    50

            Classes = [(name, XSDclass) for name, XSDclass in self.Classes.items() if XSDclass.IsBaseClass]

    51

            if len(Classes) == 1:

    52

                name, XSDclass = Classes[0]

    53

                obj = XSDclass()

    54

                self.CTNParams = (name, obj)

    55

                setattr(self, name, obj)

    56

    57

    def __init__(self):

    58

        # Create BaseParam 

    59

        self.BaseParams = _BaseParamsClass()

    60

        self.MandatoryParams = ("BaseParams", self.BaseParams)

    61

        self._AddParamsMembers()

    62

        self.Children = {}

    63

        self._View = None

    64

        # copy ConfNodeMethods so that it can be later customized

    65

        self.ConfNodeMethods = [dic.copy() for dic in self.ConfNodeMethods]

    66

    67

    def ConfNodeBaseXmlFilePath(self, CTNName=None):

    68

        return os.path.join(self.CTNPath(CTNName), "baseconfnode.xml")

    69

    70

    def ConfNodeXmlFilePath(self, CTNName=None):

    71

        return os.path.join(self.CTNPath(CTNName), "confnode.xml")

    72

    73

    def ConfNodePath(self):

    74

        return os.path.join(self.CTNParent.ConfNodePath(), self.CTNType)

    75

    76

    def CTNPath(self,CTNName=None):

    77

        if not CTNName:

    78

            CTNName = self.CTNName()

    79

        return os.path.join(self.CTNParent.CTNPath(),

    80

                            CTNName + NameTypeSeparator + self.CTNType)

    81

    82

    def CTNName(self):

    83

        return self.BaseParams.getName()

    84

    85

    def CTNEnabled(self):

    86

        return self.BaseParams.getEnabled()

    87

    88

    def CTNFullName(self):

    89

        parent = self.CTNParent.CTNFullName()

    90

        if parent != "":

    91

            return parent + "." + self.CTNName()

    92

        return self.BaseParams.getName()

    93

    94

    def GetIconPath(self):

    95

        return None

    96

    97

    def CTNTestModified(self):

    98

        return self.ChangesToSave

    99

   100

    def ProjectTestModified(self):

   101

        """

   102

        recursively check modified status

   103

        """

   104

        if self.CTNTestModified():

   105

            return True

   106

   107

        for CTNChild in self.IterChildren():

   108

            if CTNChild.ProjectTestModified():

   109

                return True

   110

   111

        return False

   112

   113

    def RemoteExec(self, script, **kwargs):

   114

        return self.CTNParent.RemoteExec(script, **kwargs)

   115

   116

    def OnCTNSave(self):

   117

        #Default, do nothing and return success

   118

        return True

   119

   120

    def GetParamsAttributes(self, path = None):

   121

        if path:

   122

            parts = path.split(".", 1)

   123

            if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:

   124

                return self.MandatoryParams[1].getElementInfos(parts[0], parts[1])

   125

            elif self.CTNParams and parts[0] == self.CTNParams[0]:

   126

                return self.CTNParams[1].getElementInfos(parts[0], parts[1])

   127

        else:

   128

            params = []

   129

            if self.CTNParams:

   130

                params.append(self.CTNParams[1].getElementInfos(self.CTNParams[0]))

   131

            return params

   132

   133

    def SetParamsAttribute(self, path, value):

   134

        self.ChangesToSave = True

   135

        # Filter IEC_Channel and Name, that have specific behavior

   136

        if path == "BaseParams.IEC_Channel":

   137

            old_leading = ".".join(map(str, self.GetCurrentLocation()))

   138

            new_value = self.FindNewIEC_Channel(value)

   139

            new_leading = ".".join(map(str, self.CTNParent.GetCurrentLocation() + (new_value,)))

   140

            self.GetCTRoot().UpdateProjectVariableLocation(old_leading, new_leading)

   141

            return new_value, True

   142

        elif path == "BaseParams.Name":

   143

            res = self.FindNewName(value)

   144

            self.CTNRequestSave()

   145

            return res, True

   146

   147

        parts = path.split(".", 1)

   148

        if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:

   149

            self.MandatoryParams[1].setElementValue(parts[1], value)

   150

        elif self.CTNParams and parts[0] == self.CTNParams[0]:

   151

            self.CTNParams[1].setElementValue(parts[1], value)

   152

        return value, False

   153

   154

    def CTNMakeDir(self):

   155

        os.mkdir(self.CTNPath())

   156

   157

    def CTNRequestSave(self):

   158

        if self.GetCTRoot().CheckProjectPathPerm(False):

   159

            # If confnode do not have corresponding directory

   160

            ctnpath = self.CTNPath()

   161

            if not os.path.isdir(ctnpath):

   162

                # Create it

   163

                os.mkdir(ctnpath)

   164

   165

            # generate XML for base XML parameters controller of the confnode

   166

            if self.MandatoryParams:

   167

                BaseXMLFile = open(self.ConfNodeBaseXmlFilePath(),'w')

   168

                BaseXMLFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")

   169

                BaseXMLFile.write(self.MandatoryParams[1].generateXMLText(self.MandatoryParams[0], 0).encode("utf-8"))

   170

                BaseXMLFile.close()

   171

   172

            # generate XML for XML parameters controller of the confnode

   173

            if self.CTNParams:

   174

                XMLFile = open(self.ConfNodeXmlFilePath(),'w')

   175

                XMLFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")

   176

                XMLFile.write(self.CTNParams[1].generateXMLText(self.CTNParams[0], 0).encode("utf-8"))

   177

                XMLFile.close()

   178

   179

            # Call the confnode specific OnCTNSave method

   180

            result = self.OnCTNSave()

   181

            if not result:

   182

                return _("Error while saving \"%s\"\n")%self.CTNPath()

   183

   184

            # mark confnode as saved

   185

            self.ChangesToSave = False

   186

            # go through all children and do the same

   187

            for CTNChild in self.IterChildren():

   188

                result = CTNChild.CTNRequestSave()

   189

                if result:

   190

                    return result

   191

        return None

   192

   193

    def CTNImport(self, src_CTNPath):

   194

        shutil.copytree(src_CTNPath, self.CTNPath)

   195

        return True

   196

   197

    def CTNGenerate_C(self, buildpath, locations):

   198

        """

   199

        Generate C code

   200

        @param locations: List of complete variables locations \

   201

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   202

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   203

            "DIR" : direction "Q","I" or "M"

   204

            "SIZE" : size "X", "B", "W", "D", "L"

   205

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   206

            }, ...]

   207

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   208

        """

   209

        self.GetCTRoot().logger.write_warning(".".join(map(lambda x:str(x), self.GetCurrentLocation())) + " -> Nothing to do\n")

   210

        return [],"",False

   211

   212

    def _Generate_C(self, buildpath, locations):

   213

        # Generate confnodes [(Cfiles, CFLAGS)], LDFLAGS, DoCalls, extra_files

   214

        # extra_files = [(fname,fobject), ...]

   215

        gen_result = self.CTNGenerate_C(buildpath, locations)

   216

        CTNCFilesAndCFLAGS, CTNLDFLAGS, DoCalls = gen_result[:3]

   217

        extra_files = gen_result[3:]

   218

        # if some files have been generated put them in the list with their location

   219

        if CTNCFilesAndCFLAGS:

   220

            LocationCFilesAndCFLAGS = [(self.GetCurrentLocation(), CTNCFilesAndCFLAGS, DoCalls)]

   221

        else:

   222

            LocationCFilesAndCFLAGS = []

   223

   224

        # confnode asks for some LDFLAGS

   225

        if CTNLDFLAGS:

   226

            # LDFLAGS can be either string

   227

            if type(CTNLDFLAGS)==type(str()):

   228

                LDFLAGS=[CTNLDFLAGS]

   229

            #or list of strings

   230

            elif type(CTNLDFLAGS)==type(list()):

   231

                LDFLAGS=CTNLDFLAGS[:]

   232

        else:

   233

            LDFLAGS=[]

   234

   235

        # recurse through all children, and stack their results

   236

        for CTNChild in self.IECSortedChildren():

   237

            new_location = CTNChild.GetCurrentLocation()

   238

            # How deep are we in the tree ?

   239

            depth=len(new_location)

   240

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   241

                CTNChild._Generate_C(

   242

                    #keep the same path

   243

                    buildpath,

   244

                    # filter locations that start with current IEC location

   245

                    [loc for loc in locations if loc["LOC"][0:depth] == new_location ])

   246

            # stack the result

   247

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   248

            LDFLAGS += _LDFLAGS

   249

            extra_files += _extra_files

   250

   251

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   252

   253

    def IterChildren(self):

   254

        for CTNType, Children in self.Children.items():

   255

            for CTNInstance in Children:

   256

                yield CTNInstance

   257

   258

    def IECSortedChildren(self):

   259

        # reorder children by IEC_channels

   260

        ordered = [(chld.BaseParams.getIEC_Channel(),chld) for chld in self.IterChildren()]

   261

        if ordered:

   262

            ordered.sort()

   263

            return zip(*ordered)[1]

   264

        else:

   265

            return []

   266

   267

    def _GetChildBySomething(self, something, toks):

   268

        for CTNInstance in self.IterChildren():

   269

            # if match component of the name

   270

            if getattr(CTNInstance.BaseParams, something) == toks[0]:

   271

                # if Name have other components

   272

                if len(toks) >= 2:

   273

                    # Recurse in order to find the latest object

   274

                    return CTNInstance._GetChildBySomething( something, toks[1:])

   275

                # No sub name -> found

   276

                return CTNInstance

   277

        # Not found

   278

        return None

   279

   280

    def GetChildByName(self, Name):

   281

        if Name:

   282

            toks = Name.split('.')

   283

            return self._GetChildBySomething("Name", toks)

   284

        else:

   285

            return self

   286

   287

    def GetChildByIECLocation(self, Location):

   288

        if Location:

   289

            return self._GetChildBySomething("IEC_Channel", Location)

   290

        else:

   291

            return self

   292

   293

    def GetCurrentLocation(self):

   294

        """

   295

        @return:  Tupple containing confnode IEC location of current confnode : %I0.0.4.5 => (0,0,4,5)

   296

        """

   297

        return self.CTNParent.GetCurrentLocation() + (self.BaseParams.getIEC_Channel(),)

   298

   299

    def GetCurrentName(self):

   300

        """

   301

        @return:  String "ParentParentName.ParentName.Name"

   302

        """

   303

        return  self.CTNParent._GetCurrentName() + self.BaseParams.getName()

   304

   305

    def _GetCurrentName(self):

   306

        """

   307

        @return:  String "ParentParentName.ParentName.Name."

   308

        """

   309

        return  self.CTNParent._GetCurrentName() + self.BaseParams.getName() + "."

   310

   311

    def GetCTRoot(self):

   312

        return self.CTNParent.GetCTRoot()

   313

   314

    def GetFullIEC_Channel(self):

   315

        return ".".join([str(i) for i in self.GetCurrentLocation()]) + ".x"

   316

   317

    def GetLocations(self):

   318

        location = self.GetCurrentLocation()

   319

        return [loc for loc in self.CTNParent.GetLocations() if loc["LOC"][0:len(location)] == location]

   320

   321

    def GetVariableLocationTree(self):

   322

        '''

   323

        This function is meant to be overridden by confnodes.

   324

   325

        It should returns an list of dictionaries

   326

   327

        - IEC_type is an IEC type like BOOL/BYTE/SINT/...

   328

        - location is a string of this variable's location, like "%IX0.0.0"

   329

        '''

   330

        children = []

   331

        for child in self.IECSortedChildren():

   332

            children.append(child.GetVariableLocationTree())

   333

        return {"name": self.BaseParams.getName(),

   334

                "type": LOCATION_CONFNODE,

   335

                "location": self.GetFullIEC_Channel(),

   336

                "children": children}

   337

   338

    def FindNewName(self, DesiredName):

   339

        """

   340

        Changes Name to DesiredName if available, Name-N if not.

   341

        @param DesiredName: The desired Name (string)

   342

        """

   343

        # Get Current Name

   344

        CurrentName = self.BaseParams.getName()

   345

        # Do nothing if no change

   346

        #if CurrentName == DesiredName: return CurrentName

   347

        # Build a list of used Name out of parent's Children

   348

        AllNames=[]

   349

        for CTNInstance in self.CTNParent.IterChildren():

   350

            if CTNInstance != self:

   351

                AllNames.append(CTNInstance.BaseParams.getName())

   352

   353

        # Find a free name, eventually appending digit

   354

        res = DesiredName

   355

        suffix = 1

   356

        while res in AllNames:

   357

            res = "%s-%d"%(DesiredName, suffix)

   358

            suffix += 1

   359

   360

        # Get old path

   361

        oldname = self.CTNPath()

   362

        # Check previous confnode existance

   363

        dontexist = self.BaseParams.getName() == "__unnamed__"

   364

        # Set the new name

   365

        self.BaseParams.setName(res)

   366

        # Rename confnode dir if exist

   367

        if not dontexist:

   368

            shutil.move(oldname, self.CTNPath())

   369

        # warn user he has two left hands

   370

        if DesiredName != res:

   371

            self.GetCTRoot().logger.write_warning(_("A child names \"%s\" already exist -> \"%s\"\n")%(DesiredName,res))

   372

        return res

   373

   374

    def GetAllChannels(self):

   375

        AllChannels=[]

   376

        for CTNInstance in self.CTNParent.IterChildren():

   377

            if CTNInstance != self:

   378

                AllChannels.append(CTNInstance.BaseParams.getIEC_Channel())

   379

        AllChannels.sort()

   380

        return AllChannels

   381

   382

    def FindNewIEC_Channel(self, DesiredChannel):

   383

        """

   384

        Changes IEC Channel number to DesiredChannel if available, nearest available if not.

   385

        @param DesiredChannel: The desired IEC channel (int)

   386

        """

   387

        # Get Current IEC channel

   388

        CurrentChannel = self.BaseParams.getIEC_Channel()

   389

        # Do nothing if no change

   390

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   391

        # Build a list of used Channels out of parent's Children

   392

        AllChannels = self.GetAllChannels()

   393

   394

        # Now, try to guess the nearest available channel

   395

        res = DesiredChannel

   396

        while res in AllChannels: # While channel not free

   397

            if res < CurrentChannel: # Want to go down ?

   398

                res -=  1 # Test for n-1

   399

                if res < 0 :

   400

                    self.GetCTRoot().logger.write_warning(_("Cannot find lower free IEC channel than %d\n")%CurrentChannel)

   401

                    return CurrentChannel # Can't go bellow 0, do nothing

   402

            else : # Want to go up ?

   403

                res +=  1 # Test for n-1

   404

        # Finally set IEC Channel

   405

        self.BaseParams.setIEC_Channel(res)

   406

        return res

   407

   408

    def _OpenView(self, name=None):

   409

        if self.EditorType is not None and self._View is None:

   410

            app_frame = self.GetCTRoot().AppFrame

   411

   412

            self._View = self.EditorType(app_frame.TabsOpened, self, app_frame)

   413

   414

            app_frame.EditProjectElement(self._View, self.CTNName())

   415

   416

            return self._View

   417

        return None

   418

   419

    def OnCloseEditor(self, view):

   420

        if self._View == view:

   421

            self._View = None

   422

   423

    def OnCTNClose(self):

   424

        if self._View is not None:

   425

            app_frame = self.GetCTRoot().AppFrame

   426

            if app_frame is not None:

   427

                app_frame.DeletePage(self._View)

   428

        return True

   429

   430

    def _doRemoveChild(self, CTNInstance):

   431

        # Remove all children of child

   432

        for SubCTNInstance in CTNInstance.IterChildren():

   433

            CTNInstance._doRemoveChild(SubCTNInstance)

   434

        # Call the OnCloseMethod

   435

        CTNInstance.OnCTNClose()

   436

        # Delete confnode dir

   437

        shutil.rmtree(CTNInstance.CTNPath())

   438

        # Remove child of Children

   439

        self.Children[CTNInstance.CTNType].remove(CTNInstance)

   440

        # Forget it... (View have to refresh)

   441

   442

    def CTNRemove(self):

   443

        # Fetch the confnode

   444

        #CTNInstance = self.GetChildByName(CTNName)

   445

        # Ask to his parent to remove it

   446

        self.CTNParent._doRemoveChild(self)

   447

   448

    def CTNAddChild(self, CTNName, CTNType, IEC_Channel=0):

   449

        """

   450

        Create the confnodes that may be added as child to this node self

   451

        @param CTNType: string desining the confnode class name (get name from CTNChildrenTypes)

   452

        @param CTNName: string for the name of the confnode instance

   453

        """

   454

        # reorganize self.CTNChildrenTypes tuples from (name, CTNClass, Help)

   455

        # to ( name, (CTNClass, Help)), an make a dict

   456

        transpose = zip(*self.CTNChildrenTypes)

   457

        CTNChildrenTypes = dict(zip(transpose[0],zip(transpose[1],transpose[2])))

   458

        # Check that adding this confnode is allowed

   459

        try:

   460

            CTNClass, CTNHelp = CTNChildrenTypes[CTNType]

   461

        except KeyError:

   462

            raise Exception, _("Cannot create child %s of type %s ")%(CTNName, CTNType)

   463

   464

        # if CTNClass is a class factory, call it. (prevent unneeded imports)

   465

        if type(CTNClass) == types.FunctionType:

   466

            CTNClass = CTNClass()

   467

   468

        # Eventualy Initialize child instance list for this class of confnode

   469

        ChildrenWithSameClass = self.Children.setdefault(CTNType, list())

   470

        # Check count

   471

        if getattr(CTNClass, "CTNMaxCount", None) and len(ChildrenWithSameClass) >= CTNClass.CTNMaxCount:

   472

            raise Exception, _("Max count (%d) reached for this confnode of type %s ")%(CTNClass.CTNMaxCount, CTNType)

   473

   474

        # create the final class, derived of provided confnode and template

   475

        class FinalCTNClass(CTNClass, ConfigTreeNode):

   476

            """

   477

            ConfNode class is derivated into FinalCTNClass before being instanciated

   478

            This way __init__ is overloaded to ensure ConfigTreeNode.__init__ is called 

   479

            before CTNClass.__init__, and to do the file related stuff.

   480

            """