1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import time

    26

import wx

    27

import subprocess, ctypes

    28

from threading import Timer, Lock, Thread, Semaphore

    29

import os, sys

    30

if os.name == 'posix':

    31

    from signal import SIGTERM, SIGKILL

    32

    33

    34

class outputThread(Thread):

    35

    """

    36

    Thread is used to print the output of a command to the stdout

    37

    """

    38

    def __init__(self, Proc, fd, callback=None, endcallback=None):

    39

        Thread.__init__(self)

    40

        self.killed = False

    41

        self.finished = False

    42

        self.retval = None

    43

        self.Proc = Proc

    44

        self.callback = callback

    45

        self.endcallback = endcallback

    46

        self.fd = fd

    47

    48

    def run(self):

    49

        outchunk = None

    50

        self.retval = None

    51

        while self.retval is None and not self.killed :

    52

            if self.endcallback:

    53

                self.retval = self.Proc.poll()

    54

            else:

    55

                self.retval = self.Proc.returncode

    56

    57

            outchunk = self.fd.readline()

    58

            if self.callback : self.callback(outchunk)

    59

        while outchunk != '' and not self.killed :

    60

            outchunk = self.fd.readline()

    61

            if self.callback : self.callback(outchunk)

    62

        if self.endcallback:

    63

            try:

    64

                err = self.Proc.wait()

    65

            except:

    66

                err = self.retval

    67

            self.finished = True

    68

            self.endcallback(self.Proc.pid, err)

    69

    70

class ProcessLogger:

    71

    def __init__(self, logger, Command, finish_callback = None,

    72

                 no_stdout = False, no_stderr = False, no_gui = True,

    73

                 timeout = None, outlimit = None, errlimit = None,

    74

                 endlog = None, keyword = None, kill_it = False, cwd = None,

    75

                 encoding = None):

    76

        self.logger = logger

    77

        if not isinstance(Command, list):

    78

            self.Command_str = Command

    79

            self.Command = []

    80

            for i,word in enumerate(Command.replace("'",'"').split('"')):

    81

                if i % 2 == 0:

    82

                    word = word.strip()

    83

                    if len(word) > 0:

    84

                        self.Command.extend(word.split())

    85

                else:

    86

                    self.Command.append(word)

    87

        else:

    88

            self.Command = Command

    89

            self.Command_str = subprocess.list2cmdline(self.Command)

    90

    91

        fsencoding = sys.getfilesystemencoding()

    92

    93

        if encoding is None:

    94

            encoding = fsencoding

    95

        self.Command = [self.Command[0].encode(fsencoding)]+map(

    96

            lambda x: x.encode(encoding), self.Command[1:])

    97

    98

        self.finish_callback = finish_callback

    99

        self.no_stdout = no_stdout

   100

        self.no_stderr = no_stderr

   101

        self.startupinfo = None

   102

        self.errlen = 0

   103

        self.outlen = 0

   104

        self.errlimit = errlimit

   105

        self.outlimit = outlimit

   106

        self.exitcode = None

   107

        self.outdata = []

   108

        self.errdata = []

   109

        self.keyword = keyword

   110

        self.kill_it = kill_it

   111

        self.startsem = Semaphore(0)        

   112

        self.finishsem = Semaphore(0)

   113

        self.endlock = Lock()

   114

   115

        popenargs= {

   116

               "cwd":os.getcwd() if cwd is None else cwd,

   117

               "stdin":subprocess.PIPE,

   118

               "stdout":subprocess.PIPE,

   119

               "stderr":subprocess.PIPE}

   120

   121

        if no_gui == True and wx.Platform == '__WXMSW__':

   122

            self.startupinfo = subprocess.STARTUPINFO()

   123

            self.startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW

   124

            popenargs["startupinfo"] = self.startupinfo

   125

        elif wx.Platform == '__WXGTK__':

   126

            popenargs["shell"] = False

   127

   128

        if timeout:

   129

            self.timeout = Timer(timeout,self.endlog)

   130

            self.timeout.start()

   131

        else:

   132

            self.timeout = None

   133

   134

        self.Proc = subprocess.Popen( self.Command, **popenargs )

   135

   136

        self.outt = outputThread(

   137

                      self.Proc,

   138

                      self.Proc.stdout,

   139

                      self.output,

   140

                      self.finish)

   141

        self.outt.start()

   142

   143

        self.errt = outputThread(

   144

                      self.Proc,

   145

                      self.Proc.stderr,

   146

                      self.errors)

   147

        self.errt.start()

   148

        self.startsem.release()

   149

   150

   151

    def output(self,v):

   152

        self.outdata.append(v)

   153

        self.outlen += 1

   154

        if not self.no_stdout:

   155

            self.logger.write(v)

   156

        if (self.keyword and v.find(self.keyword)!=-1) or (self.outlimit and self.outlen > self.outlimit):

   157

            self.endlog()

   158

   159

    def errors(self,v):

   160

        self.errdata.append(v)

   161

        self.errlen += 1

   162

        if not self.no_stderr:

   163

            self.logger.write_warning(v)

   164

        if self.errlimit and self.errlen > self.errlimit:

   165

            self.endlog()

   166

   167

    def log_the_end(self,ecode,pid):

   168

        self.logger.write(self.Command_str + "\n")

   169

        self.logger.write_warning(_("exited with status {a1} (pid {a2})\n").format(a1 = str(ecode), a2 = str(pid)))

   170

   171

    def finish(self, pid,ecode):

   172

        # avoid running function before start is finished        

   173

        self.startsem.acquire()

   174

        if self.timeout:

   175

            self.timeout.cancel()

   176

        self.exitcode = ecode

   177

        if self.exitcode != 0:

   178

            self.log_the_end(ecode,pid)

   179

        if self.finish_callback is not None:

   180

            self.finish_callback(self,ecode,pid)

   181

        self.errt.join()

   182

        self.finishsem.release()

   183

   184

    def kill(self,gently=True):

   185

        # avoid running kill before start is finished

   186

        self.startsem.acquire()

   187

        self.startsem.release()

   188

   189

        self.outt.killed = True

   190

        self.errt.killed = True

   191

        if wx.Platform == '__WXMSW__':

   192

            PROCESS_TERMINATE = 1

   193

            handle = ctypes.windll.kernel32.OpenProcess(PROCESS_TERMINATE, False, self.Proc.pid)

   194

            ctypes.windll.kernel32.TerminateProcess(handle, -1)

   195

            ctypes.windll.kernel32.CloseHandle(handle)

   196

        else:

   197

            if gently:

   198

                sig=SIGTERM

   199

            else:

   200

                sig=SIGKILL

   201

            try:

   202

                os.kill(self.Proc.pid, sig)

   203

            except:

   204

                pass

   205

        self.outt.join()

   206

        self.errt.join()

   207

   208

    def endlog(self):

   209

        if self.endlock.acquire(False):

   210

            if not self.outt.finished and self.kill_it:

   211

               self.kill()

   212

            self.finishsem.release()

   213

   214

   215

    def spin(self):

   216

        self.finishsem.acquire()

   217

        return [self.exitcode, "".join(self.outdata), "".join(self.errdata)]

   218