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.misc import GetClassImporter

    16

    17

from PLCControler import PLCControler, LOCATION_CONFNODE

    18

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

    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

    43

    EditorType = ConfTreeNodeEditor

    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 GetIconName(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

            if new_value != value:

   140

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

   141

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

   142

            return new_value, True

   143

        elif path == "BaseParams.Name":

   144

            res = self.FindNewName(value)

   145

            self.CTNRequestSave()

   146

            return res, True

   147

   148

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

   149

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

   150

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

   151

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

   152

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

   153

        return value, False

   154

   155

    def CTNMakeDir(self):

   156

        os.mkdir(self.CTNPath())

   157

   158

    def CTNRequestSave(self):

   159

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

   160

            # If confnode do not have corresponding directory

   161

            ctnpath = self.CTNPath()

   162

            if not os.path.isdir(ctnpath):

   163

                # Create it

   164

                os.mkdir(ctnpath)

   165

   166

            # generate XML for base XML parameters controller of the confnode

   167

            if self.MandatoryParams:

   168

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

   169

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

   170

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

   171

                BaseXMLFile.close()

   172

   173

            # generate XML for XML parameters controller of the confnode

   174

            if self.CTNParams:

   175

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

   176

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

   177

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

   178

                XMLFile.close()

   179

   180

            # Call the confnode specific OnCTNSave method

   181

            result = self.OnCTNSave()

   182

            if not result:

   183

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

   184

   185

            # mark confnode as saved

   186

            self.ChangesToSave = False

   187

            # go through all children and do the same

   188

            for CTNChild in self.IterChildren():

   189

                result = CTNChild.CTNRequestSave()

   190

                if result:

   191

                    return result

   192

        return None

   193

   194

    def CTNImport(self, src_CTNPath):

   195

        shutil.copytree(src_CTNPath, self.CTNPath)

   196

        return True

   197

   210

    def CTNGenerate_C(self, buildpath, locations):

   211

        """

   212

        Generate C code

   213

        @param locations: List of complete variables locations \

   214

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

   215

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

   216

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

   217

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

   218

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

   219

            }, ...]

   220

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

   221

        """

   222

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

   223

        return [],"",False

   224

   225

    def _Generate_C(self, buildpath, locations):

   226

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

   227

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

   228

        gen_result = self.CTNGenerate_C(buildpath, locations)

   229

        CTNCFilesAndCFLAGS, CTNLDFLAGS, DoCalls = gen_result[:3]

   230

        extra_files = gen_result[3:]

   231

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

   232

        if CTNCFilesAndCFLAGS:

   233

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

   234

        else:

   235

            LocationCFilesAndCFLAGS = []

   236

   237

        # confnode asks for some LDFLAGS

   238

        if CTNLDFLAGS:

   239

            # LDFLAGS can be either string

   240

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

   241

                LDFLAGS=[CTNLDFLAGS]

   242

            #or list of strings

   243

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

   244

                LDFLAGS=CTNLDFLAGS[:]

   245

        else:

   246

            LDFLAGS=[]

   247

   248

        # recurse through all children, and stack their results

   249

        for CTNChild in self.IECSortedChildren():

   250

            new_location = CTNChild.GetCurrentLocation()

   251

            # How deep are we in the tree ?

   252

            depth=len(new_location)

   253

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   254

                CTNChild._Generate_C(

   255

                    #keep the same path

   256

                    buildpath,

   257

                    # filter locations that start with current IEC location

   258

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

   259

            # stack the result

   260

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   261

            LDFLAGS += _LDFLAGS

   262

            extra_files += _extra_files

   263

   264

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   265

   266

    def IterChildren(self):

   267

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

   268

            for CTNInstance in Children:

   269

                yield CTNInstance

   270

   271

    def IECSortedChildren(self):

   272

        # reorder children by IEC_channels

   273

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

   274

        if ordered:

   275

            ordered.sort()

   276

            return zip(*ordered)[1]

   277

        else:

   278

            return []

   279

   280

    def _GetChildBySomething(self, something, toks):

   281

        for CTNInstance in self.IterChildren():

   282

            # if match component of the name

   283

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

   284

                # if Name have other components

   285

                if len(toks) >= 2:

   286

                    # Recurse in order to find the latest object

   287

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

   288

                # No sub name -> found

   289

                return CTNInstance

   290

        # Not found

   291

        return None

   292

   293

    def GetChildByName(self, Name):

   294

        if Name:

   295

            toks = Name.split('.')

   296

            return self._GetChildBySomething("Name", toks)

   297

        else:

   298

            return self

   299

   300

    def GetChildByIECLocation(self, Location):

   301

        if Location:

   302

            return self._GetChildBySomething("IEC_Channel", Location)

   303

        else:

   304

            return self

   305

   306

    def GetCurrentLocation(self):

   307

        """

   308

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

   309

        """

   310

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

   311

   312

    def GetCurrentName(self):

   313

        """

   314

        @return:  String "ParentParentName.ParentName.Name"

   315

        """

   316

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

   317

   318

    def _GetCurrentName(self):

   319

        """

   320

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

   321

        """

   322

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

   323

   324

    def GetCTRoot(self):

   325

        return self.CTNParent.GetCTRoot()

   326

   327

    def GetFullIEC_Channel(self):

   328

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

   329

   330

    def GetLocations(self):

   331

        location = self.GetCurrentLocation()

   332

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

   333

   334

    def GetVariableLocationTree(self):

   335

        '''

   336

        This function is meant to be overridden by confnodes.

   337

   338

        It should returns an list of dictionaries

   339

   340

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

   341

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

   342

        '''

   343

        children = []

   344

        for child in self.IECSortedChildren():

   345

            children.append(child.GetVariableLocationTree())

   346

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

   347

                "type": LOCATION_CONFNODE,

   348

                "location": self.GetFullIEC_Channel(),

   349

                "children": children}

   350

   351

    def FindNewName(self, DesiredName):

   352

        """

   353

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

   354

        @param DesiredName: The desired Name (string)

   355

        """

   356

        # Get Current Name

   357

        CurrentName = self.BaseParams.getName()

   358

        # Do nothing if no change

   359

        #if CurrentName == DesiredName: return CurrentName

   360

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

   361

        AllNames=[]

   362

        for CTNInstance in self.CTNParent.IterChildren():

   363

            if CTNInstance != self:

   364

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

   365

   366

        # Find a free name, eventually appending digit

   367

        res = DesiredName

   368

        if DesiredName.endswith("_0"):

   369

            BaseDesiredName = DesiredName[:-2]

   370

        else:

   371

            BaseDesiredName = DesiredName

   372

        suffix = 1

   373

        while res in AllNames:

   374

            res = "%s_%d"%(BaseDesiredName, suffix)

   375

            suffix += 1

   376

   377

        # Get old path

   378

        oldname = self.CTNPath()

   379

        # Check previous confnode existance

   380

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

   381

        # Set the new name

   382

        self.BaseParams.setName(res)

   383

        # Rename confnode dir if exist

   384

        if not dontexist:

   385

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

   386

        # warn user he has two left hands

   387

        if DesiredName != res:

   388

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

   389

        return res

   390

   391

    def GetAllChannels(self):

   392

        AllChannels=[]

   393

        for CTNInstance in self.CTNParent.IterChildren():

   394

            if CTNInstance != self:

   395

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

   396

        AllChannels.sort()

   397

        return AllChannels

   398

   399

    def FindNewIEC_Channel(self, DesiredChannel):

   400

        """

   401

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

   402

        @param DesiredChannel: The desired IEC channel (int)

   403

        """

   404

        # Get Current IEC channel

   405

        CurrentChannel = self.BaseParams.getIEC_Channel()

   406

        # Do nothing if no change

   407

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   408

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

   409

        AllChannels = self.GetAllChannels()

   410

   411

        # Now, try to guess the nearest available channel

   412

        res = DesiredChannel

   413

        while res in AllChannels: # While channel not free

   414

            if res < CurrentChannel: # Want to go down ?

   415

                res -=  1 # Test for n-1

   416

                if res < 0 :

   417

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

   418

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

   419

            else : # Want to go up ?

   420

                res +=  1 # Test for n-1

   421

        # Finally set IEC Channel

   422

        self.BaseParams.setIEC_Channel(res)

   423

        return res

   424

   425

    def _OpenView(self, name=None, onlyopened=False):

   426

        if self.EditorType is not None:

   427

            app_frame = self.GetCTRoot().AppFrame

   428

            if self._View is None and not onlyopened:

   429

   430

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

   431

   432

            if self._View is not None:

   433

                if name is None:

   434

                    name = self.CTNFullName()

   435

                app_frame.EditProjectElement(self._View, name)

   436

   437

            return self._View

   438

        return None

   439

   440

    def _CloseView(self, view):

   441

        app_frame = self.GetCTRoot().AppFrame

   442

        if app_frame is not None:

   443

            app_frame.DeletePage(view)

   444

   445

    def OnCloseEditor(self, view):

   446

        if self._View == view:

   447

            self._View = None

   448

   449

    def OnCTNClose(self):

   450

        if self._View is not None:

   451

            self._CloseView(self._View)

   452

            self._View = None

   453

        return True

   454

   455

    def _doRemoveChild(self, CTNInstance):

   456

        # Remove all children of child

   457

        for SubCTNInstance in CTNInstance.IterChildren():

   458

            CTNInstance._doRemoveChild(SubCTNInstance)

   459

        # Call the OnCloseMethod

   460

        CTNInstance.OnCTNClose()

   461

        # Delete confnode dir

   462

        shutil.rmtree(CTNInstance.CTNPath())

   463

        # Remove child of Children

   464

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

   465

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

   466

   467

    def CTNRemove(self):

   468

        # Fetch the confnode

   469

        #CTNInstance = self.GetChildByName(CTNName)

   470

        # Ask to his parent to remove it

   471

        self.CTNParent._doRemoveChild(self)

   472

   473

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

   474

        """

   475

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

   476

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

   477

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

   478

        """

   479

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

   480

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