~didrocks/unity/altf10 : revision 35.1.2

1

__metaclass__ = type

2

3

1

import httplib

4

2

import simplejson

5

3

from urlparse import urlunparse

8

6

urlencode,

9

7

)

10

8

11

from grackle.error import (

12

ArchiveIdExists,

13

MessageIdNotFound,

14

UnparsableDateRange,

15

UnsupportedDisplayType,

16

UnsupportedOrder,

17

)

9

10

class UnsupportedOrder(Exception):

11

"""Raised when an Unsupported order is requested."""

18

12

19

13

20

14

class GrackleClient:

30

24

self.port = port

31

25

self.netloc = '%s:%d' % (host, port)

32

26

33

def archive_url(self, path, query):

27

def archive_url(self, archive_id, query):

34

28

"""Return the URL for an archive

35

29

36

:param path: The path to generate the URL for.

37

Maybe be '', 'archive_id', or 'archive_id/message_id'

30

:param archive_id: The id of the archive to generate the URL for.

38

31

:param query: The query to use in the URL, as a dict.

39

32

"""

40

path = '/archive/%s' % quote(path)

33

path = '/archive/%s' % quote(archive_id)

41

34

query_string = urlencode(query)

42

35

return urlunparse(('http', self.netloc, path, '', query_string, ''))

43

36

44

37

def _get_connection(self):

45

38

return httplib.HTTPConnection(self.host, self.port)

46

39

47

def _method_archive(self, method, path, query, body=None):

40

def _method_archive(self, method, archive_id, query, body=None):

48

41

"""Perform an HTTP method on an archive's URL."""

49

url = self.archive_url(path, query)

42

url = self.archive_url(archive_id, query)

50

43

connection = self._get_connection()

51

44

connection.request(method, url, body)

52

45

return connection.getresponse()

53

46

54

def put_archive(self, archive_id, mbox=None):

55

"""Create an archive.

56

57

:param archive_id: The archive id.

58

:param mbox: An optional mbox with messages to add to the new archive.

59

"""

60

response = self._method_archive(

61

'PUT', archive_id, {}, None)

62

response.read()

63

if response.status == httplib.BAD_REQUEST:

64

if response.reason == ArchiveIdExists.__doc__:

65

raise ArchiveIdExists

66

raise Exception('wtf')

67

elif response.status == httplib.CREATED:

68

return

69

else:

70

raise Exception('!!')

71

72

47

def put_message(self, archive_id, key, file_obj):

73

48

"""Put a message into an archive.

74

49

77

52

the message.

78

53

:param file_obj: The raw text of the message, as a file.

79

54

"""

80

path = '%s/%s' % (archive_id, key)

81

55

response = self._method_archive(

82

'PUT', path, {}, file_obj.read())

56

'POST', archive_id, {'key': key}, file_obj.read())

83

57

response.read()

84

58

if response.status == httplib.BAD_REQUEST:

85

if response.reason == ArchiveIdExists.__doc__:

86

raise ArchiveIdExists

87

59

raise Exception('wtf')

88

60

elif response.status == httplib.CREATED:

89

61

return

90

62

else:

91

63

raise Exception('!!')

92

64

93

def get_messages(self, archive_id, message_ids=None, date_range=None,

94

limit=None, memo=None, order=None, headers=None,

95

include_hidden=False, max_body_length=None,

96

display_type='all'):

65

def get_messages(self, archive_id, message_ids=None, limit=None,

66

memo=None, order=None, headers=None,

67

max_body_length=None, include_hidden=False):

97

68

"""Retrieve specified messages.

98

69

99

70

:param archive_id: The archive to retrieve messages from.

100

71

:param message_ids: (optional) Retrieve only messages with these ids.

101

:param date_range: Retrieve the messages from or between a range of

102

dates. Example: 2012-01-01..2012-01-31 retrieve all the messages

103

between the 01 and 31 of January, including message from 01

104

and 31.

105

72

:param limit: The maximum number of messages to return. The server

106

73

may, at its discretion, return fewer.

107

74

:param memo: (optional) Opaque identifier describing the position in

120

87

bodies.

121

88

:param include_hidden: If true, include messages that have been

122

89

flagged "hidden" in the results.

123

:param display_type: Adjust the message content to meet the needs of

124

the intended display. Valid values are:

125

all: (the default) include all message content.

126

text-only: include only plain/text parts; exclude all other parts.

127

headers-only: include only the message headers.

128

90

"""

129

91

parameters = {}

130

92

if message_ids is not None:

131

93

parameters['message_ids'] = message_ids

132

if date_range is not None:

133

parameters['date_range'] = date_range

134

94

if limit is not None:

135

95

parameters['limit'] = limit

136

96

if memo is not None:

141

101

parameters['headers'] = headers

142

102

if max_body_length is not None:

143

103

parameters['max_body_length'] = max_body_length

144

parameters['display_type'] = display_type

145

104

parameters['include_hidden'] = include_hidden

146

105

query = {'parameters': simplejson.dumps(parameters)}

147

106

response = self._method_archive('GET', archive_id, query)

148

107

if response.status == httplib.BAD_REQUEST:

149

if response.reason == UnsupportedOrder.__doc__:

150

raise UnsupportedOrder

151

elif response.reason == UnsupportedDisplayType.__doc__:

152

raise UnsupportedDisplayType

153

elif response.reason == UnparsableDateRange.__doc__:

154

raise UnparsableDateRange

155

else:

156

raise ValueError('Bad request')

157

data = response.read()

158

return simplejson.loads(data)

159

160

def hide_message(self, archive_id, message_id, hidden):

161

parameters = {

162

'hidden': hidden,

163

}

164

query = {'parameters': simplejson.dumps(parameters)}

165

path = '%s/%s' % (archive_id, message_id)

166

response = self._method_archive('POST', path, query)

167

if response.status == httplib.BAD_REQUEST:

168

if response.reason == MessageIdNotFound.__doc__:

169

raise MessageIdNotFound

108

raise UnsupportedOrder

170

109

data = response.read()

171

110

return simplejson.loads(data)