diaspy/models.py

   1 #!/usr/bin/env python3
   2
   3
   4 """This module is only imported in other diaspy modules and
   5 MUST NOT import anything.
   6 """
   7
   8
   9 import json
  10 import re
  11
  12 from diaspy import errors
  13
  14
  15 class Aspect():
  16     """This class represents an aspect.
  17
  18     Class can be initialized by passing either an id and/or name as
  19     parameters.
  20     If both are missing, an exception will be raised.
  21     """
  22     def __init__(self, connection, id=None, name=None):
  23         self._connection = connection
  24         self.id, self.name = id, name
  25         if id and not name:
  26             self.name = self._findname()
  27         elif name and not id:
  28             self.id = self._findid()
  29         elif not id and not name:
  30             raise Exception('Aspect must be initialized with either an id or name')
  31
  32     def _findname(self):
  33         """Finds name for aspect.
  34         """
  35         name = None
  36         aspects = self._connection.getUserData()['aspects']
  37         for a in aspects:
  38             if a['id'] == self.id:
  39                 name = a['name']
  40                 break
  41         return name
  42
  43     def _findid(self):
  44         """Finds id for aspect.
  45         """
  46         id = None
  47         aspects = self._connection.getUserData()['aspects']
  48         for a in aspects:
  49             if a['name'] == self.name:
  50                 id = a['id']
  51                 break
  52         return id
  53
  54     def _getajax(self):
  55         """Returns HTML returned when editing aspects via web UI.
  56         """
  57         start_regexp = re.compile('<ul +class=["\']contacts["\'] *>')
  58         ajax = self._connection.get('aspects/{0}/edit'.format(self.id)).text
  59
  60         begin = ajax.find(start_regexp.search(ajax).group(0))
  61         end = ajax.find('</ul>')
  62         return ajax[begin:end]
  63
  64     def _extractusernames(self, ajax):
  65         """Extracts usernames and GUIDs from ajax returned by Diaspora*.
  66         Returns list of two-tuples: (guid, diaspora_name).
  67         """
  68         userline_regexp = re.compile('<a href=["\']/people/[a-z0-9]{16,16}["\']>[\w()*@. -]+</a>')
  69         return [(line[17:33], re.escape(line[35:-4])) for line in userline_regexp.findall(ajax)]
  70
  71     def _extractpersonids(self, ajax, usernames):
  72         """Extracts `person_id`s and usernames from ajax and list of usernames.
  73         Returns list of two-tuples: (username, id)
  74         """
  75         personid_regexp = 'alt=["\']{0}["\'] class=["\']avatar["\'] data-person_id=["\'][0-9]+["\']'
  76         personids = [re.compile(personid_regexp.format(name)).search(ajax).group(0) for guid, name in usernames]
  77         for n, line in enumerate(personids):
  78             i, id = -2, ''
  79             while line[i].isdigit():
  80                 id = line[i] + id
  81                 i -= 1
  82             personids[n] = (usernames[n][1], id)
  83         return personids
  84
  85     def _defineusers(self, ajax, personids):
  86         """Gets users contained in this aspect by getting users who have `delete` method.
  87         """
  88         method_regexp = 'data-method="delete" data-person_id="{0}"'
  89         users = []
  90         for name, id in personids:
  91             if re.compile(method_regexp.format(id)).search(ajax): users.append(name)
  92         return users
  93
  94     def _getguids(self, users_in_aspect, usernames):
  95         """Defines users contained in this aspect.
  96         """
  97         guids = []
  98         for guid, name in usernames:
  99             if name in users_in_aspect: guids.append(guid)
 100         return guids
 101
 102     def getUsers(self):
 103         """Returns list of GUIDs of users who are listed in this aspect.
 104         """
 105         ajax = self._getajax()
 106         usernames = self._extractusernames(ajax)
 107         personids = self._extractpersonids(ajax, usernames)
 108         users_in_aspect = self._defineusers(ajax, personids)
 109         return self._getguids(users_in_aspect, usernames)
 110
 111     def addUser(self, user_id):
 112         """Add user to current aspect.
 113
 114         :param user_id: user to add to aspect
 115         :type user_id: int
 116         :returns: JSON from request
 117         """
 118         data = {'authenticity_token': repr(self._connection),
 119                 'aspect_id': self.id,
 120                 'person_id': user_id}
 121
 122         request = self._connection.post('aspect_memberships.json', data=data)
 123
 124         if request.status_code == 400:
 125             raise errors.AspectError('duplicate record, user already exists in aspect: {0}'.format(request.status_code))
 126         elif request.status_code == 404:
 127             raise errors.AspectError('user not found from this pod: {0}'.format(request.status_code))
 128         elif request.status_code != 200:
 129             raise errors.AspectError('wrong status code: {0}'.format(request.status_code))
 130         return request.json()
 131
 132     def removeUser(self, user_id):
 133         """Remove user from current aspect.
 134
 135         :param user_id: user to remove from aspect
 136         :type user: int
 137         """
 138         data = {'authenticity_token': repr(self._connection),
 139                 'aspect_id': self.id,
 140                 'person_id': user_id}
 141         request = self.connection.delete('aspect_memberships/{0}.json'.format(self.id), data=data)
 142
 143         if request.status_code != 200:
 144             raise errors.AspectError('cannot remove user from aspect: {0}'.format(request.status_code))
 145         return request.json()
 146
 147
 148 class Notification():
 149     """This class represents single notification.
 150     """
 151     _who_regexp = re.compile(r'/people/[0-9a-f]+" class=\'hovercardable')
 152     _when_regexp = re.compile(r'[0-9]{4,4}(-[0-9]{2,2}){2,2} [0-9]{2,2}(:[0-9]{2,2}){2,2} UTC')
 153     _aboutid_regexp = re.compile(r'/posts/[0-9a-f]+')
 154     _htmltag_regexp = re.compile('</?[a-z]+( *[a-z_-]+=["\'].*?["\'])* */?>')
 155
 156     def __init__(self, connection, data):
 157         self._connection = connection
 158         self.type = list(data.keys())[0]
 159         self._data = data[self.type]
 160         self.id = self._data['id']
 161         self.unread = self._data['unread']
 162
 163     def __getitem__(self, key):
 164         """Returns a key from notification data.
 165         """
 166         return self._data[key]
 167
 168     def __str__(self):
 169         """Returns notification note.
 170         """
 171         string = re.sub(self._htmltag_regexp, '', self._data['note_html'])
 172         string = string.strip().split('\n')[0]
 173         while '  ' in string: string = string.replace('  ', ' ')
 174         return string
 175
 176     def __repr__(self):
 177         """Returns notification note with more details.
 178         """
 179         return '{0}: {1}'.format(self.when(), str(self))
 180
 181     def about(self):
 182         """Returns id of post about which the notification is informing OR:
 183         If the id is None it means that it's about user so .who() is called.
 184         """
 185         about = self._aboutid_regexp.search(self._data['note_html'])
 186         if about is None: about = self.who()
 187         else: about = int(about.group(0)[7:])
 188         return about
 189
 190     def who(self):
 191         """Returns list of guids of the users who caused you to get the notification.
 192         """
 193         return [who[8:24] for who in self._who_regexp.findall(self._data['note_html'])]
 194
 195     def when(self):
 196         """Returns UTC time as found in note_html.
 197         """
 198         return self._when_regexp.search(self._data['note_html']).group(0)
 199
 200     def mark(self, unread=False):
 201         """Marks notification to read/unread.
 202         Marks notification to read if `unread` is False.
 203         Marks notification to unread if `unread` is True.
 204
 205         :param unread: which state set for notification
 206         :type unread: bool
 207         """
 208         headers = {'x-csrf-token': repr(self._connection)}
 209         params = {'set_unread': json.dumps(unread)}
 210         self._connection.put('notifications/{0}'.format(self['id']), params=params, headers=headers)
 211         self._data['unread'] = unread
 212
 213
 214 class Conversation():
 215     """This class represents a conversation.
 216
 217     .. note::
 218         Remember that you need to have access to the conversation.
 219     """
 220     def __init__(self, connection, id, fetch=True):
 221         """
 222         :param conv_id: id of the post and not the guid!
 223         :type conv_id: str
 224         :param connection: connection object used to authenticate
 225         :type connection: connection.Connection
 226         """
 227         self._connection = connection
 228         self.id = id
 229         self._data = {}
 230         if fetch: self._fetch()
 231
 232     def _fetch(self):
 233         """Fetches JSON data representing conversation.
 234         """
 235         request = self._connection.get('conversations/{}.json'.format(self.id))
 236         if request.status_code == 200:
 237             self._data = request.json()['conversation']
 238         else:
 239             raise errors.ConversationError('cannot download conversation data: {0}'.format(request.status_code))
 240
 241     def answer(self, text):
 242         """Answer that conversation
 243
 244         :param text: text to answer.
 245         :type text: str
 246         """
 247         data = {'message[text]': text,
 248                 'utf8': '&#x2713;',
 249                 'authenticity_token': repr(self._connection)}
 250
 251         request = self._connection.post('conversations/{}/messages'.format(self.id),
 252                                         data=data,
 253                                         headers={'accept': 'application/json'})
 254         if request.status_code != 200:
 255             raise errors.ConversationError('{0}: Answer could not be posted.'
 256                                            .format(request.status_code))
 257         return request.json()
 258
 259     def delete(self):
 260         """Delete this conversation.
 261         Has to be implemented.
 262         """
 263         data = {'authenticity_token': repr(self._connection)}
 264
 265         request = self._connection.delete('conversations/{0}/visibility/'
 266                                           .format(self.id),
 267                                           data=data,
 268                                           headers={'accept': 'application/json'})
 269
 270         if request.status_code != 404:
 271             raise errors.ConversationError('{0}: Conversation could not be deleted.'
 272                                            .format(request.status_code))
 273
 274     def get_subject(self):
 275         """Returns the subject of this conversation
 276         """
 277         return self._data['subject']
 278
 279
 280 class Comment():
 281     """Represents comment on post.
 282
 283     Does not require Connection() object. Note that you should not manually
 284     create `Comment()` objects -- they are designed to be created automatically
 285     by `Post()` objects.
 286     """
 287     def __init__(self, data):
 288         self._data = data
 289
 290     def __str__(self):
 291         """Returns comment's text.
 292         """
 293         return self._data['text']
 294
 295     def __repr__(self):
 296         """Returns comments text and author.
 297         Format: AUTHOR (AUTHOR'S GUID): COMMENT
 298         """
 299         return '{0} ({1}): {2}'.format(self.author(), self.author('guid'), str(self))
 300
 301     def when(self):
 302         """Returns time when the comment had been created.
 303         """
 304         return self._data['created_at']
 305
 306     def author(self, key='name'):
 307         """Returns author of the comment.
 308         """
 309         return self._data['author'][key]
 310
 311
 312 class Post():
 313     """This class represents a post.
 314
 315     .. note::
 316         Remember that you need to have access to the post.
 317     """
 318     def __init__(self, connection, id=0, guid='', fetch=True, comments=True):
 319         """
 320         :param id: id of the post (GUID is recommended)
 321         :type id: int
 322         :param guid: GUID of the post
 323         :type guid: str
 324         :param connection: connection object used to authenticate
 325         :type connection: connection.Connection
 326         :param fetch: defines whether to fetch post's data or not
 327         :type fetch: bool
 328         :param comments: defines whether to fetch post's comments or not (if True also data will be fetched)
 329         :type comments: bool
 330         """
 331         if not (guid or id): raise TypeError('neither guid nor id was provided')
 332         self._connection = connection
 333         self.id = id
 334         self.guid = guid
 335         self._data = {}
 336         self.comments = []
 337         if fetch: self._fetchdata()
 338         if comments:
 339             if not self._data: self._fetchdata()
 340             self._fetchcomments()
 341
 342     def __repr__(self):
 343         """Returns string containing more information then str().
 344         """
 345         return '{0} ({1}): {2}'.format(self._data['author']['name'], self._data['author']['guid'], self._data['text'])
 346
 347     def __str__(self):
 348         """Returns text of a post.
 349         """
 350         return self._data['text']
 351
 352     def __getitem__(self, key):
 353         return self._data[key]
 354
 355     def __dict__(self):
 356         """Returns dictionary of posts data.
 357         """
 358         return self._data
 359
 360     def _fetchdata(self):
 361         """This function retrieves data of the post.
 362
 363         :returns: guid of post whose data was fetched
 364         """
 365         if self.id: id = self.id
 366         if self.guid: id = self.guid
 367         request = self._connection.get('posts/{0}.json'.format(id))
 368         if request.status_code != 200:
 369             raise errors.PostError('{0}: could not fetch data for post: {1}'.format(request.status_code, id))
 370         else:
 371             self._data = request.json()
 372         return self['guid']
 373
 374     def _fetchcomments(self):
 375         """Retreives comments for this post.
 376         Retrieving comments via GUID will result in 404 error.
 377         DIASPORA* does not supply comments through /posts/:guid/ endpoint.
 378         """
 379         id = self._data['id']
 380         if self['interactions']['comments_count']:
 381             request = self._connection.get('posts/{0}/comments.json'.format(id))
 382             if request.status_code != 200:
 383                 raise errors.PostError('{0}: could not fetch comments for post: {1}'.format(request.status_code, id))
 384             else:
 385                 self.comments = [Comment(c) for c in request.json()]
 386
 387     def update(self):
 388         """Updates post data.
 389         """
 390         self._fetchdata()
 391         self._fetchcomments()
 392
 393     def like(self):
 394         """This function likes a post.
 395         It abstracts the 'Like' functionality.
 396
 397         :returns: dict -- json formatted like object.
 398         """
 399         data = {'authenticity_token': repr(self._connection)}
 400
 401         request = self._connection.post('posts/{0}/likes'.format(self.id),
 402                                         data=data,
 403                                         headers={'accept': 'application/json'})
 404
 405         if request.status_code != 201:
 406             raise errors.PostError('{0}: Post could not be liked.'
 407                                    .format(request.status_code))
 408         return request.json()
 409
 410     def reshare(self):
 411         """This function reshares a post
 412         """
 413         data = {'root_guid': self._data['guid'],
 414                 'authenticity_token': repr(self._connection)}
 415
 416         request = self._connection.post('reshares',
 417                                         data=data,
 418                                         headers={'accept': 'application/json'})
 419         if request.status_code != 201:
 420             raise Exception('{0}: Post could not be reshared'.format(request.status_code))
 421         return request.json()
 422
 423     def comment(self, text):
 424         """This function comments on a post
 425
 426         :param text: text to comment.
 427         :type text: str
 428         """
 429         data = {'text': text,
 430                 'authenticity_token': repr(self._connection)}
 431         request = self._connection.post('posts/{0}/comments'.format(self.id),
 432                                         data=data,
 433                                         headers={'accept': 'application/json'})
 434
 435         if request.status_code != 201:
 436             raise Exception('{0}: Comment could not be posted.'
 437                             .format(request.status_code))
 438         return request.json()
 439
 440     def delete(self):
 441         """ This function deletes this post
 442         """
 443         data = {'authenticity_token': repr(self._connection)}
 444         request = self._connection.delete('posts/{0}'.format(self.id),
 445                                           data=data,
 446                                           headers={'accept': 'application/json'})
 447         if request.status_code != 204:
 448             raise errors.PostError('{0}: Post could not be deleted'.format(request.status_code))
 449
 450     def delete_comment(self, comment_id):
 451         """This function removes a comment from a post
 452
 453         :param comment_id: id of the comment to remove.
 454         :type comment_id: str
 455         """
 456         data = {'authenticity_token': repr(self._connection)}
 457         request = self._connection.delete('posts/{0}/comments/{1}'
 458                                           .format(self.id, comment_id),
 459                                           data=data,
 460                                           headers={'accept': 'application/json'})
 461
 462         if request.status_code != 204:
 463             raise errors.PostError('{0}: Comment could not be deleted'
 464                                    .format(request.status_code))
 465
 466     def delete_like(self):
 467         """This function removes a like from a post
 468         """
 469         data = {'authenticity_token': repr(self._connection)}
 470         url = 'posts/{0}/likes/{1}'.format(self.id, self._data['interactions']['likes'][0]['id'])
 471         request = self._connection.delete(url, data=data)
 472         if request.status_code != 204:
 473             raise errors.PostError('{0}: Like could not be removed.'
 474                                    .format(request.status_code))
 475
 476     def author(self, key='name'):
 477         """Returns author of the post.
 478         :param key: all keys available in data['author']
 479         """
 480         return self._data['author'][key]