Commit | Line | Data |
---|---|---|
beaa09fb MM |
1 | import re |
2 | from diaspy.streams import Outer | |
d589deff | 3 | from diaspy.models import Aspect |
65b1f099 | 4 | from diaspy import errors |
7c6fbe5b | 5 | from diaspy import search |
beaa09fb MM |
6 | |
7 | ||
6d8d47ce MM |
8 | def sephandle(handle): |
9 | """Separate Diaspora* handle into pod pod and user. | |
10 | ||
11 | :returns: two-tuple (pod, user) | |
12 | """ | |
13 | if re.match('^[a-zA-Z]+[a-zA-Z0-9_-]*@[a-z0-9.]+\.[a-z]+$', handle) is None: | |
615edb73 | 14 | raise errors.InvalidHandleError('{0}'.format(handle)) |
6d8d47ce MM |
15 | handle = handle.split('@') |
16 | pod, user = handle[1], handle[0] | |
17 | return (pod, user) | |
18 | ||
19 | ||
488d7ff6 | 20 | class User(): |
beaa09fb MM |
21 | """This class abstracts a D* user. |
22 | This object goes around the limitations of current D* API and will | |
23 | extract user data using black magic. | |
24 | However, no chickens are harmed when you use it. | |
17d8f406 | 25 | |
7b99bf75 JR |
26 | The parameter fetch should be either 'posts', 'data' or 'none'. By |
27 | default it is 'posts' which means in addition to user data, stream | |
3cf4514e MM |
28 | will be fetched. If user has not posted yet diaspy will not be able |
29 | to extract the information from his/her posts. Since there is no official | |
30 | way to do it we rely on user posts. If this will be the case user | |
7b99bf75 | 31 | will be notified with appropriate exception message. |
3cf4514e | 32 | |
7b99bf75 JR |
33 | If fetch is 'data', only user data will be fetched. If the user is |
34 | not found, no exception will be returned. | |
35 | ||
36 | When creating new User() one can pass either guid, handle and/or id as | |
37 | optional parameters. GUID takes precedence over handle when fetching | |
38 | user stream. When fetching user data, handle is required. | |
beaa09fb | 39 | """ |
7b99bf75 | 40 | def __init__(self, connection, guid='', handle='', fetch='posts', id=0): |
beaa09fb | 41 | self._connection = connection |
6cd1bae0 | 42 | self.stream = [] |
9aa1c960 MM |
43 | self.handle = handle |
44 | self.guid = guid | |
b9fb4030 JR |
45 | self.data = { |
46 | 'guid': guid, | |
47 | 'handle': handle, | |
1e192d06 | 48 | 'id': id, |
b9fb4030 | 49 | } |
9aa1c960 | 50 | self._fetch(fetch) |
beaa09fb MM |
51 | |
52 | def __getitem__(self, key): | |
53 | return self.data[key] | |
54 | ||
1e192d06 MM |
55 | def __str__(self): |
56 | return self['guid'] | |
57 | ||
58 | def __repr__(self): | |
59 | return '{0} ({1})'.format(self['diaspora_name'], self['guid']) | |
60 | ||
9aa1c960 MM |
61 | def _fetch(self, fetch): |
62 | """Fetch user posts or data. | |
63 | """ | |
b9fb4030 | 64 | if fetch == 'posts': |
9aa1c960 MM |
65 | if self.handle and not self.guid: self.fetchhandle() |
66 | else: self.fetchguid() | |
67 | elif fetch == 'data' and self.handle: | |
1f779f83 | 68 | self.fetchprofile() |
b9fb4030 | 69 | |
7c6fbe5b | 70 | def _finalize_data(self, data): |
6d8d47ce MM |
71 | """Adjustments are needed to have similar results returned |
72 | by search feature and fetchguid/handle(). | |
73 | """ | |
74 | names = [ ('id', 'id'), | |
75 | ('guid', 'guid'), | |
76 | ('name', 'name'), | |
77 | ('avatar', 'avatar'), | |
78 | ('handle', 'diaspora_id'), | |
79 | ] | |
7b99bf75 | 80 | final = {} |
6d8d47ce | 81 | for f, d in names: |
7b99bf75 JR |
82 | final[f] = data[d] |
83 | return final | |
beaa09fb | 84 | |
a8fdc14a MM |
85 | def _postproc(self, request): |
86 | """Makes necessary modifications to user data and | |
87 | sets up a stream. | |
88 | ||
89 | :param request: request object | |
90 | :type request: request | |
beaa09fb | 91 | """ |
6d8d47ce MM |
92 | if request.status_code != 200: raise Exception('wrong error code: {0}'.format(request.status_code)) |
93 | else: request = request.json() | |
65b1f099 | 94 | if not len(request): raise errors.UserError('cannot extract user data: no posts to analyze') |
7c6fbe5b | 95 | self.data = self._finalize_data(request[0]['author']) |
1f779f83 | 96 | self.stream = Outer(self._connection, location='people/{0}.json'.format(self['guid'])) |
beaa09fb | 97 | |
1f779f83 | 98 | def fetchhandle(self, protocol='https'): |
7b99bf75 | 99 | """Fetch user data and posts using Diaspora handle. |
beaa09fb | 100 | """ |
6d8d47ce | 101 | pod, user = sephandle(self.handle) |
a8fdc14a MM |
102 | request = self._connection.session.get('{0}://{1}/u/{2}.json'.format(protocol, pod, user)) |
103 | self._postproc(request) | |
beaa09fb | 104 | |
1f779f83 | 105 | def fetchguid(self): |
7b99bf75 | 106 | """Fetch user data and posts using guid. |
beaa09fb | 107 | """ |
9aa1c960 | 108 | request = self._connection.get('people/{0}.json'.format(self.guid)) |
17d8f406 | 109 | self._postproc(request) |
3cf4514e | 110 | |
5131bd9e MM |
111 | def fetchprofile(self): |
112 | """Fetches user data. | |
113 | """ | |
6d8d47ce MM |
114 | data = search.Search(self._connection).user(self.handle)[0] |
115 | self.data = data | |
5131bd9e | 116 | |
dd0a4d9f MM |
117 | |
118 | class Contacts(): | |
119 | """This class represents user's list of contacts. | |
120 | """ | |
121 | def __init__(self, connection): | |
122 | self._connection = connection | |
123 | ||
d589deff MM |
124 | def add(self, user_id, aspect_ids): |
125 | """Add user to aspects of given ids. | |
dd0a4d9f | 126 | |
d589deff MM |
127 | :param user_id: user guid |
128 | :type user_id: str | |
129 | :param aspect_ids: list of aspect ids | |
130 | :type aspect_ids: list | |
dd0a4d9f | 131 | """ |
7a818fdb | 132 | for aid in aspect_ids: Aspect(self._connection, aid).addUser(user_id) |
27f09973 | 133 | |
d589deff MM |
134 | def remove(self, user_id, aspect_ids): |
135 | """Remove user from aspects of given ids. | |
27f09973 | 136 | |
d589deff MM |
137 | :param user_id: user guid |
138 | :type user_id: str | |
139 | :param aspect_ids: list of aspect ids | |
140 | :type aspect_ids: list | |
27f09973 | 141 | """ |
7a818fdb | 142 | for aid in aspect_ids: Aspect(self._connection, aid).removeUser(user_id) |
27f09973 | 143 | |
d589deff | 144 | def get(self, set=''): |
27f09973 | 145 | """Returns list of user contacts. |
d589deff MM |
146 | Contact is a User() who is in one or more of user's |
147 | aspects. | |
148 | ||
7a818fdb MM |
149 | By default, it will return list of users who are in |
150 | user's aspects. | |
151 | ||
d589deff MM |
152 | If `set` is `all` it will also include users who only share |
153 | with logged user and are not in his/hers aspects. | |
7a818fdb | 154 | |
d589deff MM |
155 | If `set` is `only_sharing` it will return users who are only |
156 | sharing with logged user and ARE NOT in his/hers aspects. | |
157 | ||
158 | :param set: if passed could be 'all' or 'only_sharing' | |
159 | :type set: str | |
27f09973 | 160 | """ |
d589deff MM |
161 | params = {} |
162 | if set: params['set'] = set | |
163 | ||
164 | request = self._connection.get('contacts.json', params=params) | |
27f09973 MM |
165 | if request.status_code != 200: |
166 | raise Exception('status code {0}: cannot get contacts'.format(request.status_code)) | |
ec27a0a1 | 167 | contacts = [User(self._connection, guid=user['guid'], handle=user['handle'], fetch=None, id=user['id']) for user in request.json()] |
27f09973 | 168 | return contacts |