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 library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

    26

import time

    27

import wx

    28

import subprocess, ctypes

    29

from threading import Timer, Lock, Thread, Semaphore

    30

import os, sys

    31

if os.name == 'posix':

    32

    from signal import SIGTERM, SIGKILL

    33

    34

    35

class outputThread(Thread):

    36

    """

    37

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

    38

    """

    39

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

    40

        Thread.__init__(self)

    41

        self.killed = False

    42

        self.finished = False

    43

        self.retval = None

    44

        self.Proc = Proc

    45

        self.callback = callback

    46

        self.endcallback = endcallback

    47

        self.fd = fd

    48

    49

    def run(self):

    50

        outchunk = None

    51

        self.retval = None

    52

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

    53

            if self.endcallback:

    54

                self.retval = self.Proc.poll()

    55

            else:

    56

                self.retval = self.Proc.returncode

    57

    58

            outchunk = self.fd.readline()

    59

            if self.callback : self.callback(outchunk)

    60

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

    61

            outchunk = self.fd.readline()

    62

            if self.callback : self.callback(outchunk)

    63

        if self.endcallback:

    64

            try:

    65

                err = self.Proc.wait()

    66

            except:

    67

                err = self.retval

    68

            self.finished = True

    69

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

    70

    71

class ProcessLogger:

    72

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

    73

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

    74

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

    75

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

    76

                 encoding = None):

    77

        self.logger = logger

    78

        if not isinstance(Command, list):

    79

            self.Command_str = Command

    80

            self.Command = []

    81

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

    82

                if i % 2 == 0:

    83

                    word = word.strip()

    84

                    if len(word) > 0:

    85

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

    86

                else:

    87

                    self.Command.append(word)

    88

        else:

    89

            self.Command = Command

    90

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

    91

    92

        fsencoding = sys.getfilesystemencoding()

    93

    94

        if encoding is None:

    95

            encoding = fsencoding

    96

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

    97

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

    98

    99

        self.finish_callback = finish_callback

   100

        self.no_stdout = no_stdout

   101

        self.no_stderr = no_stderr

   102

        self.startupinfo = None

   103

        self.errlen = 0

   104

        self.outlen = 0

   105

        self.errlimit = errlimit

   106

        self.outlimit = outlimit

   107

        self.exitcode = None

   108

        self.outdata = []

   109

        self.errdata = []

   110

        self.keyword = keyword

   111

        self.kill_it = kill_it

   113

        self.finishsem = Semaphore(0)

   114

        self.endlock = Lock()

   115

   116

        popenargs= {

   117

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

   118

               "stdin":subprocess.PIPE,

   119

               "stdout":subprocess.PIPE,

   120

               "stderr":subprocess.PIPE}

   121

   122

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

   123

            self.startupinfo = subprocess.STARTUPINFO()

   124

            self.startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW

   125

            popenargs["startupinfo"] = self.startupinfo

   126

        elif wx.Platform == '__WXGTK__':

   127

            popenargs["shell"] = False

   128

   129

        if timeout:

   130

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

   131

            self.timeout.start()

   132

        else:

   133

            self.timeout = None

   134

   135

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

   136

   137

        self.outt = outputThread(

   138

                      self.Proc,

   139

                      self.Proc.stdout,

   140

                      self.output,

   141

                      self.finish)

   142

        self.outt.start()

   143

   144

        self.errt = outputThread(

   145

                      self.Proc,

   146

                      self.Proc.stderr,

   147

                      self.errors)

   148

        self.errt.start()

   150

   151

   152

    def output(self,v):

   153

        self.outdata.append(v)

   154

        self.outlen += 1

   155

        if not self.no_stdout:

   156

            self.logger.write(v)

   157

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

   158

            self.endlog()

   159

   160

    def errors(self,v):

   161

        self.errdata.append(v)

   162

        self.errlen += 1

   163

        if not self.no_stderr:

   164

            self.logger.write_warning(v)

   165

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

   166

            self.endlog()

   167

   168

    def log_the_end(self,ecode,pid):

   169

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

   170

        self.logger.write_warning(_("exited with status %s (pid %s)\n")%(str(ecode),str(pid)))

   171

   172

    def finish(self, pid,ecode):

   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):

   186

        self.outt.killed = True

   187

        self.errt.killed = True

   188

        if wx.Platform == '__WXMSW__':

   189

            PROCESS_TERMINATE = 1

   190

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

   191

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

   192

            ctypes.windll.kernel32.CloseHandle(handle)

   193

        else:

   194

            if gently:

   195

                sig=SIGTERM

   196

            else:

   197

                sig=SIGKILL

   198

            try:

   199

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

   200

            except:

   201

                pass

   202

        self.outt.join()

   203

        self.errt.join()

   204

   205

    def endlog(self):

   206

        if self.endlock.acquire(False):

   207

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

   208

               self.kill()

   209

            self.finishsem.release()

   210

   211

   212

    def spin(self):

   213

        self.finishsem.acquire()

   214

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

   215