1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz

     5

# Copyright (C) 2021: Edouard TISSERANT

     6

#

     7

# See COPYING file for copyrights details.

     8

     9

from __future__ import absolute_import

    10

import os

    11

import shutil

    12

import hashlib

    13

import shlex

    14

import time

    15

    16

import wx

    17

    18

from lxml import etree

    19

from lxml.etree import XSLTApplyError

    20

    21

import util.paths as paths

    22

from POULibrary import POULibrary

    23

from docutil import open_svg, get_inkscape_path

    24

    25

from util.ProcessLogger import ProcessLogger

    26

from runtime.typemapping import DebugTypesSize

    27

import targets

    28

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

    29

from XSLTransform import XSLTransform

    30

from svghmi.i18n import EtreeToMessages, SaveCatalog, ReadTranslations,\

    31

                        MatchTranslations, TranslationToEtree, open_pofile,\

    32

                        GetPoFiles

    33

from svghmi.hmi_tree import HMI_TYPES, HMITreeNode, SPECIAL_NODES 

    34

from svghmi.ui import SVGHMI_UI

    35

from svghmi.fonts import GetFontTypeAndFamilyName, GetCSSFontFaceFromFontFile

    36

    37

    38

ScriptDirectory = paths.AbsDir(__file__)

    39

    40

    41

# module scope for HMITree root

    42

# so that CTN can use HMITree deduced in Library

    43

# note: this only works because library's Generate_C is

    44

#       systematicaly invoked before CTN's CTNGenerate_C

    45

    46

hmi_tree_root = None

    47

    48

on_hmitree_update = None

    49

    52

class SVGHMILibrary(POULibrary):

    53

    def GetLibraryPath(self):

    54

         return paths.AbsNeighbourFile(__file__, "pous.xml")

    55

    56

    def Generate_C(self, buildpath, varlist, IECCFLAGS):

    58

    59

        """

    60

        PLC Instance Tree:

    61

          prog0

    62

           +->v1 HMI_INT

    63

           +->v2 HMI_INT

    64

           +->fb0 (type mhoo)

    65

           |   +->va HMI_NODE

    66

           |   +->v3 HMI_INT

    67

           |   +->v4 HMI_INT

    68

           |

    69

           +->fb1 (type mhoo)

    70

           |   +->va HMI_NODE

    71

           |   +->v3 HMI_INT

    72

           |   +->v4 HMI_INT

    73

           |

    74

           +->fb2

    75

               +->v5 HMI_IN

    76

    77

        HMI tree:

    78

          hmi0

    79

           +->v1

    80

           +->v2

    81

           +->fb0 class:va

    82

           |   +-> v3

    83

           |   +-> v4

    84

           |

    85

           +->fb1 class:va

    86

           |   +-> v3

    87

           |   +-> v4

    88

           |

    89

           +->v5

    90

    91

        """

    92

    93

        # Filter known HMI types

    94

        hmi_types_instances = [v for v in varlist if v["derived"] in HMI_TYPES]

    95

    96

        hmi_tree_root = None

    97

    98

        # take first HMI_NODE (placed as special node), make it root

    99

        for i,v in enumerate(hmi_types_instances):

   100

            path = v["IEC_path"].split(".")

   101

            derived = v["derived"]

   102

            if derived == "HMI_NODE":

   103

                hmi_tree_root = HMITreeNode(path, "", derived, v["type"], v["vartype"], v["C_path"])

   104

                hmi_types_instances.pop(i)

   105

                break

   106

   107

        if hmi_tree_root is None:

   108

            self.FatalError("SVGHMI : Library is selected but not used. Please either deselect it in project config or add a SVGHMI node to project.")

   109

   110

        # deduce HMI tree from PLC HMI_* instances

   111

        for v in hmi_types_instances:

   112

            path = v["IEC_path"].split(".")

   113

            # ignores variables starting with _TMP_

   114

            if path[-1].startswith("_TMP_"):

   115

                continue

   116

            derived = v["derived"]

   117

            kwargs={}

   118

            if derived == "HMI_NODE":

   119

                # TODO : make problem if HMI_NODE used in CONFIG or RESOURCE

   120

                name = path[-2]

   121

                kwargs['hmiclass'] = path[-1]

   122

            else:

   123

                name = path[-1]

   124

            new_node = HMITreeNode(path, name, derived, v["type"], v["vartype"], v["C_path"], **kwargs)

   125

            placement_result = hmi_tree_root.place_node(new_node)

   126

            if placement_result is not None:

   127

                cause, problematic_node = placement_result

   128

                if cause == "Non_Unique":

   129

                    message = _("HMI tree nodes paths are not unique.\nConflicting variable: {} {}").format(

   130

                        ".".join(problematic_node.path),

   131

                        ".".join(new_node.path))

   132

   133

                    last_FB = None 

   134

                    for v in varlist:

   135

                        if v["vartype"] == "FB":

   136

                            last_FB = v 

   137

                        if v["C_path"] == problematic_node:

   138

                            break

   139

                    if last_FB is not None:

   140

                        failing_parent = last_FB["type"]

   141

                        message += "\n"

   142

                        message += _("Solution: Add HMI_NODE at beginning of {}").format(failing_parent)

   143

   144

                elif cause in ["Late_HMI_NODE", "Duplicate_HMI_NODE"]:

   145

                    cause, problematic_node = placement_result

   146

                    message = _("There must be only one occurrence of HMI_NODE before any HMI_* variable in POU.\nConflicting variable: {} {}").format(

   147

                        ".".join(problematic_node.path),

   148

                        ".".join(new_node.path))

   149

   150

                self.FatalError("SVGHMI : " + message)

   151

   152

        if on_hmitree_update is not None:

   153

            on_hmitree_update(hmi_tree_root)

   154

   155

        variable_decl_array = []

   156

        extern_variables_declarations = []

   157

        buf_index = 0

   158

        item_count = 0

   159

        found_heartbeat = False

   160

   161

        hearbeat_IEC_path = ['CONFIG', 'HEARTBEAT']

   162

   163

        for node in hmi_tree_root.traverse():

   164

            if not found_heartbeat and node.path == hearbeat_IEC_path:

   165

                hmi_tree_hearbeat_index = item_count

   166

                found_heartbeat = True

   167

                extern_variables_declarations += [

   168

                    "#define heartbeat_index "+str(hmi_tree_hearbeat_index)

   169

                ]

   170

            if hasattr(node, "iectype"):

   171

                sz = DebugTypesSize.get(node.iectype, 0)

   172

                variable_decl_array += [

   173

                    "{&(" + node.cpath + "), " + node.iectype + {

   174

                        "EXT": "_P_ENUM",

   175

                        "IN":  "_P_ENUM",

   176

                        "MEM": "_O_ENUM",

   177

                        "OUT": "_O_ENUM",

   178

                        "VAR": "_ENUM"

   179

                    }[node.vartype] + ", " +

   180

                    str(buf_index) + ", 0, }"]

   181

                buf_index += sz

   182

                item_count += 1

   183

                if len(node.path) == 1:

   184

                    extern_variables_declarations += [

   185

                        "extern __IEC_" + node.iectype + "_" +

   186

                        "t" if node.vartype is "VAR" else "p"

   187

                        + node.cpath + ";"]

   188

   189

        assert(found_heartbeat)

   190

   191

        # TODO : filter only requiered external declarations

   192

        for v in varlist:

   193

            if v["C_path"].find('.') < 0:

   194

                extern_variables_declarations += [

   195

                    "extern %(type)s %(C_path)s;" % v]

   196

   197

        # TODO check if programs need to be declared separately

   198

        # "programs_declarations": "\n".join(["extern %(type)s %(C_path)s;" %

   199

        #                                     p for p in self._ProgramList]),

   200

   206

        # C code to observe/access HMI tree variables

   207

        svghmi_c_filepath = paths.AbsNeighbourFile(__file__, "svghmi.c")

   208

        svghmi_c_file = open(svghmi_c_filepath, 'r')

   209

        svghmi_c_code = svghmi_c_file.read()

   210

        svghmi_c_file.close()

   211

        svghmi_c_code = svghmi_c_code % {

   212

            "variable_decl_array": ",\n".join(variable_decl_array),

   213

            "extern_variables_declarations": "\n".join(extern_variables_declarations),

   214

            "buffer_size": buf_index,

   215

            "item_count": item_count,

   216

            "var_access_code": targets.GetCode("var_access.c"),

   217

            "PLC_ticktime": self.GetCTR().GetTicktime(),

   220

            }

   221

   222

        gen_svghmi_c_path = os.path.join(buildpath, "svghmi.c")

   223

        gen_svghmi_c = open(gen_svghmi_c_path, 'w')

   224

        gen_svghmi_c.write(svghmi_c_code)

   225

        gen_svghmi_c.close()

   226

   227

        # Python based WebSocket HMITree Server

   228

        svghmiserverfile = open(paths.AbsNeighbourFile(__file__, "svghmi_server.py"), 'r')

   229

        svghmiservercode = svghmiserverfile.read()

   230

        svghmiserverfile.close()

   231

   232

        runtimefile_path = os.path.join(buildpath, "runtime_00_svghmi.py")

   233

        runtimefile = open(runtimefile_path, 'w')

   234

        runtimefile.write(svghmiservercode)

   235

        runtimefile.close()

   236

   237

        # Backup HMI Tree in XML form so that it can be loaded without building

   238

        hmitree_backup_path = os.path.join(buildpath, "hmitree.xml")

   239

        hmitree_backup_file = open(hmitree_backup_path, 'wb')

   240

        hmitree_backup_file.write(etree.tostring(hmi_tree_root.etree()))

   241

        hmitree_backup_file.close()

   242

   243

        return ((["svghmi"], [(gen_svghmi_c_path, IECCFLAGS)], True), "",

   244

                ("runtime_00_svghmi.py", open(runtimefile_path, "rb")))

   245

                #         ^

   246

                # note the double zero after "runtime_", 

   247

                # to ensure placement before other CTN generated code in execution order

   248

   249

    def GlobalInstances(self):

   250

        """ Adds HMI tree root and hearbeat to PLC Configuration's globals """

   251

        return [(name, iec_type, "") for name, iec_type in SPECIAL_NODES]

   252

   253

   254

   255

def Register_SVGHMI_UI_for_HMI_tree_updates(ref):

   256

    global on_hmitree_update

   257

    def HMITreeUpdate(_hmi_tree_root):

   258

        obj = ref()

   259

        if obj is not None:

   260

            obj.HMITreeUpdate(_hmi_tree_root)

   261

   262

    on_hmitree_update = HMITreeUpdate

   263

   264

   265

class SVGHMIEditor(ConfTreeNodeEditor):

   266

    CONFNODEEDITOR_TABS = [

   267

        (_("HMI Tree"), "CreateSVGHMI_UI")]

   268

   269

    def CreateSVGHMI_UI(self, parent):

   270

        global hmi_tree_root

   271

   272

        if hmi_tree_root is None:

   273

            buildpath = self.Controler.GetCTRoot()._getBuildPath()

   274

            hmitree_backup_path = os.path.join(buildpath, "hmitree.xml")

   275

            if os.path.exists(hmitree_backup_path):

   276

                hmitree_backup_file = open(hmitree_backup_path, 'rb')

   277

                hmi_tree_root = HMITreeNode.from_etree(etree.parse(hmitree_backup_file).getroot())

   278

   279

        ret = SVGHMI_UI(parent, Register_SVGHMI_UI_for_HMI_tree_updates)

   280

   281

        on_hmitree_update(hmi_tree_root)

   282

   283

        return ret

   284

   285

class SVGHMI(object):

   286

    XSD = """<?xml version="1.0" encoding="utf-8" ?>

   287

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

   288

      <xsd:element name="SVGHMI">

   289

        <xsd:complexType>

   290

          <xsd:attribute name="OnStart" type="xsd:string" use="optional" default="chromium {url}"/>

   291

          <xsd:attribute name="OnStop" type="xsd:string" use="optional" default="echo 'please close chromium window at {url}'"/>

   292

          <xsd:attribute name="EnableWatchdog" type="xsd:boolean" use="optional" default="false"/>

   293

          <xsd:attribute name="OnWatchdog" type="xsd:string" use="optional" default="chromium {url}"/>

   294

          <xsd:attribute name="WatchdogInitial" type="xsd:integer" use="optional" default="30"/>

   295

          <xsd:attribute name="WatchdogInterval" type="xsd:integer" use="optional" default="5"/>

   296

          <xsd:attribute name="Port" type="xsd:integer" use="optional" default="8008"/>

   297

          <xsd:attribute name="Interface" type="xsd:string" use="optional" default="localhost"/>

   300

        </xsd:complexType>

   301

      </xsd:element>

   302

    </xsd:schema>

   303

    """

   304

   305

    EditorType = SVGHMIEditor

   306

   307

    ConfNodeMethods = [

   308

        {

   309

            "bitmap":    "ImportSVG",

   310

            "name":    _("Import SVG"),

   311

            "tooltip": _("Import SVG"),

   312

            "method":   "_ImportSVG"

   313

        },

   314

        {

   315

            "bitmap":    "EditSVG",

   316

            "name":    _("Inkscape"),

   317

            "tooltip": _("Edit HMI"),

   318

            "method":   "_StartInkscape"

   319

        },

   320

        {

   321

            "bitmap":    "OpenPOT",

   322

            "name":    _("New lang"),

   323

            "tooltip": _("Open non translated message catalog (POT) to start new language"),

   324

            "method":   "_OpenPOT"

   325

        },

   326

        {

   327

            "bitmap":    "EditPO",

   328

            "name":    _("Edit lang"),

   329

            "tooltip": _("Edit existing message catalog (PO) for specific language"),

   330

            "method":   "_EditPO"

   331

        },

   332

        {

   333

            "bitmap":    "AddFont",

   334

            "name":    _("Add Font"),

   335

            "tooltip": _("Add TTF, OTF or WOFF font to be embedded in HMI"),

   336

            "method":   "_AddFont"

   337

        },

   338

        {

   339

            "bitmap":    "DelFont",

   340

            "name":    _("Delete Font"),

   341

            "tooltip": _("Remove font previously added to HMI"),

   342

            "method":   "_DelFont"

   343

        },

   344

    ]

   345

   346

    def _getSVGpath(self, project_path=None):

   347

        if project_path is None:

   348

            project_path = self.CTNPath()

   349

        return os.path.join(project_path, "svghmi.svg")

   350

   351

    def _getPOTpath(self, project_path=None):

   352

        if project_path is None:

   353

            project_path = self.CTNPath()

   354

        return os.path.join(project_path, "messages.pot")

   355

   356

    def OnCTNSave(self, from_project_path=None):

   357

        if from_project_path is not None:

   358

            shutil.copyfile(self._getSVGpath(from_project_path),

   359

                            self._getSVGpath())

   360

            shutil.copyfile(self._getPOTpath(from_project_path),

   361

                            self._getPOTpath())

   362

            # XXX TODO copy .PO files

   363

        return True

   364

   365

    def GetSVGGeometry(self):

   366

        self.ProgressStart("inkscape", "collecting SVG geometry (Inkscape)")

   367

        # invoke inskscape -S, csv-parse output, produce elements

   368

        InkscapeGeomColumns = ["Id", "x", "y", "w", "h"]

   369

   370

        inkpath = get_inkscape_path()

   371

   372

        if inkpath is None:

   373

            self.FatalError("SVGHMI: inkscape is not installed.")

   374

   375

        svgpath = self._getSVGpath()

   376

        status, result, _err_result = ProcessLogger(self.GetCTRoot().logger,

   377

                                                     '"' + inkpath + '" -S "' + svgpath + '"',

   378

                                                     no_stdout=True,

   379

                                                     no_stderr=True).spin()

   380

        if status != 0:

   381

            self.FatalError("SVGHMI: inkscape couldn't extract geometry from given SVG.")

   382

   383

        res = []

   384

        for line in result.split():

   385

            strippedline = line.strip()

   386

            attrs = dict(

   387

                zip(InkscapeGeomColumns, line.strip().split(',')))

   388

   389

            res.append(etree.Element("bbox", **attrs))

   390

   391

        self.ProgressEnd("inkscape")

   392

        return res

   393

   394

    def GetHMITree(self):

   395

        global hmi_tree_root

   396

        self.ProgressStart("hmitree", "getting HMI tree")

   397

        res = [hmi_tree_root.etree(add_hash=True)]

   398

        self.ProgressEnd("hmitree")

   399

        return res

   400

   401

    def GetTranslations(self, _context, msgs):

   402

        self.ProgressStart("i18n", "getting Translations")

   403

        messages = EtreeToMessages(msgs)

   404

   405

        if len(messages) == 0:

   406

            self.ProgressEnd("i18n")

   407

            return

   408

   409

        SaveCatalog(self._getPOTpath(), messages)

   410

   411

        translations = ReadTranslations(self.CTNPath())

   412

   413

        langs,translated_messages = MatchTranslations(translations, messages, 

   414

            errcallback=self.GetCTRoot().logger.write_warning)

   415

   416

        ret = TranslationToEtree(langs,translated_messages)

   417

   418

        self.ProgressEnd("i18n")

   419

   420

        return ret

   421

   422

    def GetFontsFiles(self):

   423

        project_path = self.CTNPath()

   424

        fontdir = os.path.join(project_path, "fonts") 

   425

        if os.path.isdir(fontdir):

   426

            return [os.path.join(fontdir,f) for f in sorted(os.listdir(fontdir))]

   427

        return []

   428

   429

    def GetFonts(self, _context):

   430

        css_parts = []

   431

   432

        for fontfile in self.GetFontsFiles():

   433

            if os.path.isfile(fontfile):

   434

                css_parts.append(GetCSSFontFaceFromFontFile(fontfile))

   435

   436

        return "".join(css_parts)

   437

   438

    times_msgs = {}

   439

    indent = 1

   440

    def ProgressStart(self, k, m):

   441

        self.times_msgs[k] = (time.time(), m)

   442

        self.GetCTRoot().logger.write("    "*self.indent + "Start %s...\n"%m)

   443

        self.indent = self.indent + 1

   444

   445

    def ProgressEnd(self, k):

   446

        t = time.time()

   447

        oldt, m = self.times_msgs[k]

   448

        self.indent = self.indent - 1

   449

        self.GetCTRoot().logger.write("    "*self.indent + "... finished in %.3fs\n"%(t - oldt))

   450

   451

    def CTNGenerate_C(self, buildpath, locations):

   452

   453

        location_str = "_".join(map(str, self.GetCurrentLocation()))

   454

        view_name = self.BaseParams.getName()

   455

   456

        svgfile = self._getSVGpath()

   457

   458

        res = ([], "", False)

   459

   460

        target_fname = "svghmi_"+location_str+".xhtml"

   461

   462

        build_path = self._getBuildPath()

   463

        target_path = os.path.join(build_path, target_fname)

   464

        hash_path = os.path.join(build_path, "svghmi.md5")

   465

   466

        self.GetCTRoot().logger.write("SVGHMI:\n")

   467

   468

        if os.path.exists(svgfile):

   469

   470

            hasher = hashlib.md5()

   471

            hmi_tree_root._hash(hasher)

   472

            pofiles = GetPoFiles(self.CTNPath())

   473

            filestocheck = [svgfile] + \

   474

                           (list(zip(*pofiles)[1]) if pofiles else []) + \

   475

                           self.GetFontsFiles()

   476

   477

            for filetocheck in filestocheck:

   478

                with open(filetocheck, 'rb') as afile:

   479

                    while True:

   480

                        buf = afile.read(65536)

   481

                        if len(buf) > 0:

   482

                            hasher.update(buf)

   483

                        else:

   484

                            break

   485

            digest = hasher.hexdigest()

   486

   487

            if os.path.exists(hash_path):

   488