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

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

# vim: set fileencoding=utf-8 : 

# 

# (C) 2011 Guido Günther <agx@sigxcpu.org> 

#    This program 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; either version 2 of the License, or 

#    (at your option) any later version. 

# 

#    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

"""A Debian Changelog""" 

 

import email 

import os 

import subprocess 

 

class NoChangeLogError(Exception): 

    """No changelog found""" 

    pass 

 

class ParseChangeLogError(Exception): 

    """Problem parsing changelog""" 

    pass 

 

 

class ChangeLogSection(object): 

    """A section in the changelog describing one particular version""" 

    def __init__(self, package, version): 

        self._package = package 

        self._version = version 

 

    @property 

    def package(self): 

        return self._package 

 

    @property 

    def version(self): 

        return self._version 

 

    @classmethod 

    def parse(klass, section): 

        """ 

        Parse one changelog section 

 

        @param section: a changelog section 

        @type section: C{str} 

        @returns: the parse changelog section 

        @rtype: L{ChangeLogSection} 

        """ 

        header = section.split('\n')[0] 

        package = header.split()[0] 

        version = header.split()[1][1:-1] 

        return klass(package, version) 

 

 

class ChangeLog(object): 

    """A Debian changelog""" 

 

    def __init__(self, contents=None, filename=None): 

        """ 

        @param contents: the contents of the changelog 

        @type contents: C{str} 

        @param filename: the filename of the changelog 

        @param filename: C{str} 

        """ 

        self._contents = '' 

        self._cp = None 

        self._filename = filename 

 

        # Check that either contents or filename is passed (but not both) 

        if (not filename and not contents) or (filename and contents): 

            raise Exception("Either filename or contents must be passed") 

 

        if filename and not os.access(filename, os.F_OK): 

            raise NoChangeLogError("Changelog %s not found" % (filename, )) 

 

        if contents: 

            self._contents = contents[:] 

        else: 

            self._read() 

        self._parse() 

 

    def _parse(self): 

        """Parse a changelog based on the already read contents.""" 

        cmd = subprocess.Popen(['dpkg-parsechangelog', '-l-'], 

                                stdin=subprocess.PIPE, 

                                stdout=subprocess.PIPE, 

                                stderr=subprocess.PIPE) 

        (output, errors) = cmd.communicate(self._contents) 

        if cmd.returncode: 

            raise ParseChangeLogError("Failed to parse changelog. " 

                                      "dpkg-parsechangelog said:\n%s" % (errors, )) 

        # Parse the result of dpkg-parsechangelog (which looks like 

        # email headers) 

        cp = email.message_from_string(output) 

        try: 

            if ':' in cp['Version']: 

                cp['Epoch'], cp['NoEpoch-Version'] = cp['Version'].split(':', 1) 

            else: 

                cp['NoEpoch-Version'] = cp['Version'] 

            if '-' in cp['NoEpoch-Version']: 

                cp['Upstream-Version'], cp['Debian-Version'] = cp['NoEpoch-Version'].rsplit('-', 1) 

            else: 

                cp['Debian-Version'] = cp['NoEpoch-Version'] 

        except TypeError: 

            raise ParseChangeLogError(output.split('\n')[0]) 

 

        self._cp = cp 

 

    def _read(self): 

            with file(self.filename) as f: 

                self._contents = f.read() 

 

    def __getitem__(self, item): 

        return self._cp[item] 

 

    def __setitem__(self, item, value): 

        self._cp[item] = value 

 

    @property 

    def filename(self): 

        """The filename (path) of the changelog""" 

        return self._filename 

 

    @property 

    def name(self): 

        """The packges name""" 

        return self._cp['Source'] 

 

    @property 

    def version(self): 

       """The full version string""" 

       return self._cp['Version'] 

 

    @property 

    def upstream_version(self): 

        """The upstream version""" 

        return self._cp['Upstream-Version'] 

 

    @property 

    def debian_version(self): 

        """The Debian part of the version number""" 

        return self._cp['Debian-Version'] 

 

    @property 

    def epoch(self): 

        """The package's epoch""" 

        return self._cp['Epoch'] 

 

    @property 

    def noepoch(self): 

        """The version string without the epoch""" 

        return self._cp['NoEpoch-Version'] 

 

    def has_epoch(self): 

        """ 

        Whether the version has an epoch 

 

        @return: C{True} if the version has an epoch, C{False} otherwise 

        @rtype: C{bool} 

        """ 

        return self._cp.has_key('Epoch') 

 

    def is_native(self): 

        """ 

        Whether this is a native Debian package 

        """ 

        return not '-' in self.version 

 

    @property 

    def author(self): 

        """ 

        The author of the last modification 

        """ 

        return email.Utils.parseaddr(self._cp['Maintainer'])[0] 

 

    @property 

    def email(self): 

        """ 

        The author's email 

        """ 

        return email.Utils.parseaddr(self._cp['Maintainer'])[1] 

 

    @property 

    def date(self): 

        """ 

        The date of the last modification as rfc822 date 

        """ 

        return self._cp['Date'] 

 

    @property 

    def sections_iter(self): 

        """ 

        Iterate over sections in the changelog 

        """ 

        section = '' 

        for line in self._contents.split('\n'): 

            if line and line[0] not in [ ' ', '\t' ]: 

                section += line 

            else: 

                if section: 

                    yield ChangeLogSection.parse(section) 

                    section = '' 

 

    @property 

    def sections(self): 

        """ 

        Get sections in the changelog 

        """ 

        return list(self.sections_iter)