1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

# This file is part of Buildbot.  Buildbot is free software: you can 

# redistribute it and/or modify it under the terms of the GNU General Public 

# License as published by the Free Software Foundation, version 2. 

# 

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

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 

# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 

# details. 

# 

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

# this program; if not, write to the Free Software Foundation, Inc., 51 

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

# 

# Copyright Buildbot Team Members 

 

from twisted.protocols import basic 

from zope.interface import implements 

from twisted.internet.interfaces import IAddress, ITransport 

 

class NullAddress(object): 

    "an address for NullTransport" 

    implements(IAddress) 

 

class NullTransport(object): 

    "a do-nothing transport to make NetstringReceiver happy" 

    implements(ITransport) 

    def write(self, data): raise NotImplementedError 

    def writeSequence(self, data): raise NotImplementedError 

    def loseConnection(self): pass 

    def getPeer(self): 

        return NullAddress 

    def getHost(self): 

        return NullAddress 

 

class NetstringParser(basic.NetstringReceiver): 

    """ 

    Adapts the Twisted netstring support (which assumes it is on a socket) to 

    work on simple strings, too.  Call the C{feed} method with arbitrary blocks 

    of data, and override the C{stringReceived} method to get called for each 

    embedded netstring.  The default implementation collects the netstrings in 

    the list C{self.strings}. 

    """ 

 

    def __init__(self): 

        # most of the complexity here is stubbing out the transport code so 

        # that Twisted-10.2.0 and higher believes that this is a valid protocol 

        self.makeConnection(NullTransport()) 

        self.strings = [] 

 

    def feed(self, data): 

        """ 

        """ 

        self.dataReceived(data) 

        # dataReceived handles errors unusually quietly! 

        if self.brokenPeer: 

            raise basic.NetstringParseError 

 

    def stringReceived(self, string): 

        self.strings.append(string)