~didrocks/unity/altf10 : revision 35.1.1

6

urlencode,

7

)

8

9

from grackle.error import (

10

MessageIdNotFound,

11

UnparsableDateRange,

12

UnsupportedDisplayType,

13

UnsupportedOrder,

14

)

9

10

class UnsupportedOrder(Exception):

11

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

15

12

16

13

17

14

class GrackleClient:

27

24

self.port = port

28

25

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

29

26

30

def archive_url(self, path, query):

27

def archive_url(self, archive_id, query):

31

28

"""Return the URL for an archive

32

29

33

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

34

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

30

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

35

31

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

36

32

"""

37

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

33

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

38

34

query_string = urlencode(query)

39

35

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

40

36

41

37

def _get_connection(self):

42

38

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

43

39

44

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

40

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

45

41

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

46

url = self.archive_url(path, query)

42

url = self.archive_url(archive_id, query)

47

43

connection = self._get_connection()

48

44

connection.request(method, url, body)

49

45

return connection.getresponse()

50

46

51

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

52

"""Create an archive.

53

54

:param archive_id: The archive id.

55

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

56

"""

57

response = self._method_archive(

58

'POST', '', {'archive_id': archive_id}, None)

59

response.read()

60

if response.status == httplib.BAD_REQUEST:

61

raise Exception('wtf')

62

elif response.status == httplib.CREATED:

63

return

64

else:

65

raise Exception('!!')

66

67

47

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

68

48

"""Put a message into an archive.

69

49

72

52

the message.

73

53

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

74

54

"""

75

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

76

55

response = self._method_archive(

77

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

56

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

78

57

response.read()

79

58

if response.status == httplib.BAD_REQUEST:

80

59

raise Exception('wtf')

83

62

else:

84

63

raise Exception('!!')

85

64

86

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

87

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

88

include_hidden=False, max_body_length=None,

89

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

90

68

"""Retrieve specified messages.

91

69

92

70

:param archive_id: The archive to retrieve messages from.

93

71

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

94

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

95

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

96

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

97

and 31.

98

72

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

99

73

may, at its discretion, return fewer.

100

74

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

113

87

bodies.

114

88

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

115

89

flagged "hidden" in the results.

116

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

117

the intended display. Valid values are:

118

all: (the default) include all message content.

119

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

120

headers-only: include only the message headers.

121

90

"""

122

91

parameters = {}

123

92

if message_ids is not None:

124

93

parameters['message_ids'] = message_ids

125

if date_range is not None:

126

parameters['date_range'] = date_range

127

94

if limit is not None:

128

95

parameters['limit'] = limit

129

96

if memo is not None:

134

101

parameters['headers'] = headers

135

102

if max_body_length is not None:

136

103

parameters['max_body_length'] = max_body_length

137

parameters['display_type'] = display_type

138

104

parameters['include_hidden'] = include_hidden

139

105

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

140

106

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

141

107

if response.status == httplib.BAD_REQUEST:

142

if response.reason == UnsupportedOrder.__doc__:

143

raise UnsupportedOrder

144

elif response.reason == UnsupportedDisplayType.__doc__:

145

raise UnsupportedDisplayType

146

elif response.reason == UnparsableDateRange.__doc__:

147

raise UnparsableDateRange

148

else:

149

raise ValueError('Bad request')

150

data = response.read()

151

return simplejson.loads(data)

152

153

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

154

parameters = {

155

'hidden': hidden,

156

}

157

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

158

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

159

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

160

if response.status == httplib.BAD_REQUEST:

161

if response.reason == MessageIdNotFound.__doc__:

162

raise MessageIdNotFound

108

raise UnsupportedOrder

163

109

data = response.read()

164

110

return simplejson.loads(data)