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,project_path=None):

    77

        if not CTNName:

    78

            CTNName = self.CTNName()

    79

        if not project_path:

    80

            project_path = self.CTNParent.CTNPath()

    81

        return os.path.join(project_path,

    82

                            CTNName + NameTypeSeparator + self.CTNType)

    83

    84

    def CTNName(self):

    85

        return self.BaseParams.getName()

    86

    87

    def CTNEnabled(self):

    88

        return self.BaseParams.getEnabled()

    89

    90

    def CTNFullName(self):

    91

        parent = self.CTNParent.CTNFullName()

    92

        if parent != "":

    93

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

    94

        return self.BaseParams.getName()

    95

    96

    def GetIconName(self):

    97

        return None

    98

    99

    def CTNTestModified(self):

   100

        return self.ChangesToSave

   101

   102

    def ProjectTestModified(self):

   103

        """

   104

        recursively check modified status

   105

        """

   106

        if self.CTNTestModified():

   107

            return True

   108

   109

        for CTNChild in self.IterChildren():

   110

            if CTNChild.ProjectTestModified():

   111

                return True

   112

   113

        return False

   114

   115

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

   116

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

   117

   118

    def OnCTNSave(self, from_project_path=None):

   119

        #Default, do nothing and return success

   120

        return True

   121

   122

    def GetParamsAttributes(self, path = None):

   123

        if path:

   124

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

   125

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

   126

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

   127

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

   128

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

   129

        else:

   130

            params = []

   131

            if self.CTNParams:

   132

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

   133

            return params

   134

   135

    def SetParamsAttribute(self, path, value):

   136

        self.ChangesToSave = True

   137

        # Filter IEC_Channel and Name, that have specific behavior

   138

        if path == "BaseParams.IEC_Channel":

   139

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

   140

            new_value = self.FindNewIEC_Channel(value)

   141

            if new_value != value:

   142

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

   143

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

   144

            return new_value, True

   145

        elif path == "BaseParams.Name":

   146

            res = self.FindNewName(value)

   147

            self.CTNRequestSave()

   148

            return res, True

   149

   150

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

   151

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

   152

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

   153

            value = self.MandatoryParams[1].getElementInfos(parts[0], parts[1])["value"]

   154

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

   155

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

   156

            value = self.CTNParams[1].getElementInfos(parts[0], parts[1])["value"]

   157

        return value, False

   158

   159

    def CTNMakeDir(self):

   160

        os.mkdir(self.CTNPath())

   161

   162

    def CTNRequestSave(self, from_project_path=None):

   163

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

   164

            # If confnode do not have corresponding directory

   165

            ctnpath = self.CTNPath()

   166

            if not os.path.isdir(ctnpath):

   167

                # Create it

   168

                os.mkdir(ctnpath)

   169

   170

            # generate XML for base XML parameters controller of the confnode

   171

            if self.MandatoryParams:

   172

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

   173

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

   174

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

   175

                BaseXMLFile.close()

   176

   177

            # generate XML for XML parameters controller of the confnode

   178

            if self.CTNParams:

   179

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

   180

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

   181

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

   182

                XMLFile.close()

   183

   184

            # Call the confnode specific OnCTNSave method

   185

            result = self.OnCTNSave(from_project_path)

   186

            if not result:

   187

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

   188

   189

            # mark confnode as saved

   190

            self.ChangesToSave = False

   191

            # go through all children and do the same

   192

            for CTNChild in self.IterChildren():

   193

                CTNChildPath = None

   194

                if from_project_path is not None:

   195

                    CTNChildPath = CTNChild.CTNPath(project_path=from_project_path)

   196

                result = CTNChild.CTNRequestSave(CTNChildPath)

   197

                if result:

   198

                    return result

   199

        return None

   200

   201

    def CTNImport(self, src_CTNPath):

   202

        shutil.copytree(src_CTNPath, self.CTNPath)

   203

        return True

   204

   205

    def CTNGlobalInstances(self):

   206

        """

   207

        @return: [(instance_name, instance_type),...]

   208

        """

   209

        return []

   210

   211

    def _GlobalInstances(self):

   212

        instances = self.CTNGlobalInstances()

   213

        for CTNChild in self.IECSortedChildren():

   214

            instances.extend(CTNChild._GlobalInstances())

   215

        return instances

   216

   217

    def CTNGenerate_C(self, buildpath, locations):

   218

        """

   219

        Generate C code

   220

        @param locations: List of complete variables locations \

   221

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

   222

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

   223

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

   224

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

   225

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

   226

            }, ...]

   227

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

   228

        """

   229

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

   230

        return [],"",False

   231

   232

    def _Generate_C(self, buildpath, locations):

   233

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

   234

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

   235

        gen_result = self.CTNGenerate_C(buildpath, locations)

   236

        CTNCFilesAndCFLAGS, CTNLDFLAGS, DoCalls = gen_result[:3]

   237

        extra_files = gen_result[3:]

   238

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

   239

        if CTNCFilesAndCFLAGS:

   240

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

   241

        else:

   242

            LocationCFilesAndCFLAGS = []

   243

   244

        # confnode asks for some LDFLAGS

   245

        if CTNLDFLAGS:

   246

            # LDFLAGS can be either string

   247

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

   248

                LDFLAGS=[CTNLDFLAGS]

   249

            #or list of strings

   250

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

   251

                LDFLAGS=CTNLDFLAGS[:]

   252

        else:

   253

            LDFLAGS=[]

   254

   255

        # recurse through all children, and stack their results

   256

        for CTNChild in self.IECSortedChildren():

   257

            new_location = CTNChild.GetCurrentLocation()

   258

            # How deep are we in the tree ?

   259

            depth=len(new_location)

   260

            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \

   261

                CTNChild._Generate_C(

   262

                    #keep the same path

   263

                    buildpath,

   264

                    # filter locations that start with current IEC location

   265

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

   266

            # stack the result

   267

            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS

   268

            LDFLAGS += _LDFLAGS

   269

            extra_files += _extra_files

   270

   271

        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files

   272

   273

    def IterChildren(self):

   274

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

   275

            for CTNInstance in Children:

   276

                yield CTNInstance

   277

   278

    def IECSortedChildren(self):

   279

        # reorder children by IEC_channels

   280

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

   281

        if ordered:

   282

            ordered.sort()

   283

            return zip(*ordered)[1]

   284

        else:

   285

            return []

   286

   287

    def _GetChildBySomething(self, something, toks):

   288

        for CTNInstance in self.IterChildren():

   289

            # if match component of the name

   290

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

   291

                # if Name have other components

   292

                if len(toks) >= 2:

   293

                    # Recurse in order to find the latest object

   294

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

   295

                # No sub name -> found

   296

                return CTNInstance

   297

        # Not found

   298

        return None

   299

   300

    def GetChildByName(self, Name):

   301

        if Name:

   302

            toks = Name.split('.')

   303

            return self._GetChildBySomething("Name", toks)

   304

        else:

   305

            return self

   306

   307

    def GetChildByIECLocation(self, Location):

   308

        if Location:

   309

            return self._GetChildBySomething("IEC_Channel", Location)

   310

        else:

   311

            return self

   312

   313

    def GetCurrentLocation(self):

   314

        """

   315

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

   316

        """

   317

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

   318

   319

    def GetCurrentName(self):

   320

        """

   321

        @return:  String "ParentParentName.ParentName.Name"

   322

        """

   323

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

   324

   325

    def _GetCurrentName(self):

   326

        """

   327

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

   328

        """

   329

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

   330

   331

    def GetCTRoot(self):

   332

        return self.CTNParent.GetCTRoot()

   333

   334

    def GetFullIEC_Channel(self):

   335

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

   336

   337

    def GetLocations(self):

   338

        location = self.GetCurrentLocation()

   339

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

   340

   341

    def GetVariableLocationTree(self):

   342

        '''

   343

        This function is meant to be overridden by confnodes.

   344

   345

        It should returns an list of dictionaries

   346

   347

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

   348

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

   349

        '''

   350

        children = []

   351

        for child in self.IECSortedChildren():

   352

            children.append(child.GetVariableLocationTree())

   353

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

   354

                "type": LOCATION_CONFNODE,

   355

                "location": self.GetFullIEC_Channel(),

   356

                "children": children}

   357

   358

    def FindNewName(self, DesiredName):

   359

        """

   360

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

   361

        @param DesiredName: The desired Name (string)

   362

        """

   363

        # Get Current Name

   364

        CurrentName = self.BaseParams.getName()

   365

        # Do nothing if no change

   366

        #if CurrentName == DesiredName: return CurrentName

   367

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

   368

        AllNames=[]

   369

        for CTNInstance in self.CTNParent.IterChildren():

   370

            if CTNInstance != self:

   371

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

   372

   373

        # Find a free name, eventually appending digit

   374

        res = DesiredName

   375

        if DesiredName.endswith("_0"):

   376

            BaseDesiredName = DesiredName[:-2]

   377

        else:

   378

            BaseDesiredName = DesiredName

   379

        suffix = 1

   380

        while res in AllNames:

   381

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

   382

            suffix += 1

   383

   384

        # Get old path

   385

        oldname = self.CTNPath()

   386

        # Check previous confnode existance

   387

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

   388

        # Set the new name

   389

        self.BaseParams.setName(res)

   390

        # Rename confnode dir if exist

   391

        if not dontexist:

   392

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

   393

        # warn user he has two left hands

   394

        if DesiredName != res:

   395

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

   396

        return res

   397

   398

    def GetAllChannels(self):

   399

        AllChannels=[]

   400

        for CTNInstance in self.CTNParent.IterChildren():

   401

            if CTNInstance != self:

   402

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

   403

        AllChannels.sort()

   404

        return AllChannels

   405

   406

    def FindNewIEC_Channel(self, DesiredChannel):

   407

        """

   408

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

   409

        @param DesiredChannel: The desired IEC channel (int)

   410

        """

   411

        # Get Current IEC channel

   412

        CurrentChannel = self.BaseParams.getIEC_Channel()

   413

        # Do nothing if no change

   414

        #if CurrentChannel == DesiredChannel: return CurrentChannel

   415

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

   416

        AllChannels = self.GetAllChannels()

   417

   418

        # Now, try to guess the nearest available channel

   419

        res = DesiredChannel

   420

        while res in AllChannels: # While channel not free

   421

            if res < CurrentChannel: # Want to go down ?

   422

                res -=  1 # Test for n-1

   423

                if res < 0 :

   424

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

   425

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

   426

            else : # Want to go up ?

   427

                res +=  1 # Test for n-1

   428

        # Finally set IEC Channel

   429

        self.BaseParams.setIEC_Channel(res)

   430

        return res

   431

   432

    def GetContextualMenuItems(self):

   433

        return None

   434

   435

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

   436

        if self.EditorType is not None:

   437

            app_frame = self.GetCTRoot().AppFrame

   438

            if self._View is None and not onlyopened:

   439

   440

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

   441

   442

            if self._View is not None:

   443

                if name is None:

   444

                    name = self.CTNFullName()

   445

                app_frame.EditProjectElement(self._View, name)

   446

   447

            return self._View

   448

        return None

   449

   450

    def _CloseView(self, view):

   451

        app_frame = self.GetCTRoot().AppFrame

   452

        if app_frame is not None:

   453

            app_frame.DeletePage(view)

   454

   455

    def OnCloseEditor(self, view):

   456

        if self._View == view:

   457

            self._View = None

   458

   459

    def OnCTNClose(self):

   460

        if self._View is not None:

   461

            self._CloseView(self._View)

   462

            self._View = None

   463

        return True

   464

   465

    def _doRemoveChild(self, CTNInstance):

   466

        # Remove all children of child

   467

        for SubCTNInstance in CTNInstance.IterChildren():

   468

            CTNInstance._doRemoveChild(SubCTNInstance)

   469

        # Call the OnCloseMethod

   470

        CTNInstance.OnCTNClose()

   471

        # Delete confnode dir

   472

        shutil.rmtree(CTNInstance.CTNPath())

   473

        # Remove child of Children

   474

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

   475

        if len(self.Children[CTNInstance.CTNType]) == 0:

   476

            self.Children.pop(CTNInstance.CTNType)

   477

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

   478

   479

    def CTNRemove(self):

   480

        # Fetch the confnode