Compare commits
110 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
b44758a195 | ||
|
f1c20d490e | ||
|
04372d498e | ||
|
63ea899605 | ||
|
4fdd145d1e | ||
|
57ee68b0e0 | ||
|
99c6884681 | ||
|
1c1438e9bc | ||
|
22f1b3e489 | ||
|
fb1ad5800c | ||
|
4dd15b05ef | ||
|
d7cdb644c4 | ||
|
bfcf4950b3 | ||
|
6612c97f05 | ||
|
b92cf62726 | ||
|
a53ba33a81 | ||
|
c04d38cf63 | ||
|
a051adcbc0 | ||
|
900a9cdf72 | ||
|
611b329934 | ||
|
2642788bc1 | ||
|
8268445f0b | ||
|
c12dcd9263 | ||
|
3142524809 | ||
|
4c9d3bd9d7 | ||
|
ba103066b8 | ||
|
0b0d6179a2 | ||
|
e8806d4ef8 | ||
|
c96e5f174c | ||
|
315242e069 | ||
|
a94fa5fbe3 | ||
|
90203afdd0 | ||
|
2c0d098852 | ||
|
e4290cd465 | ||
|
46b85dec5c | ||
|
bbc34bd009 | ||
|
c495317e65 | ||
|
a946050228 | ||
|
83789dcefa | ||
|
4f1f9bf1ce | ||
|
32c72c2f35 | ||
|
42ae0035af | ||
|
96e28fdbe6 | ||
|
0f889f50cf | ||
|
478eaebdec | ||
|
7ecf229db5 | ||
|
dda75c6099 | ||
|
28d5ac9f90 | ||
|
52acfb4636 | ||
|
2a64bad385 | ||
|
1a73699f1a | ||
|
1b5a7a0063 | ||
|
4b3eb440cf | ||
|
d1f457866b | ||
|
6f29aa82cb | ||
|
b1a2ff7d84 | ||
|
883b16e251 | ||
|
116b39cf6a | ||
|
eae1db9c7d | ||
|
730bab5d40 | ||
|
d52dac233e | ||
|
1f37277a8d | ||
|
15014d7055 | ||
|
7a35ca05b1 | ||
|
be6b6909d9 | ||
|
42c1d26b2e | ||
|
d38f8ad2ec | ||
|
023fd58f05 | ||
|
ad10a8f07f | ||
|
7d6cf039d4 | ||
|
f0271e17b0 | ||
|
57954816b2 | ||
|
3e4e1f9bb9 | ||
|
7340918209 | ||
|
707df4f941 | ||
|
8eb6b83411 | ||
|
e0aedd617b | ||
|
ee81620c14 | ||
|
2d027af71a | ||
|
9d5f06b810 | ||
|
b8fdcda2fb | ||
|
0dac7b7b81 | ||
|
b750e753d6 | ||
|
ee33e92bed | ||
|
7413a643f6 | ||
|
34452f9220 | ||
|
24831b2462 | ||
|
cd4a18cb5a | ||
|
c00b3df8b2 | ||
|
1beb821b2c | ||
|
a58791048a | ||
|
f0c6e8612f | ||
|
1cebbf92e6 | ||
|
a64982583b | ||
|
cb8b0915de | ||
|
1d2576b06d | ||
|
ead9a3c0e9 | ||
|
59ba418faa | ||
|
c51a332560 | ||
|
a73d2feed6 | ||
|
6929193e9d | ||
|
fea4ad9e89 | ||
|
68099049d4 | ||
|
44cf08bdfd | ||
|
9e32cf17a4 | ||
|
0661367ebb | ||
|
3c07e42ba2 | ||
|
2cd6376818 | ||
|
2a223ec6db | ||
|
637319ec2c |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -24,7 +24,8 @@ develop-eggs
|
|||||||
# Sphinx documentation
|
# Sphinx documentation
|
||||||
docs/_build/
|
docs/_build/
|
||||||
|
|
||||||
# Data for tests
|
# Scripts and data for tests
|
||||||
|
my_tests.py
|
||||||
my_test_data.json
|
my_test_data.json
|
||||||
my_data.json
|
my_data.json
|
||||||
tests.data
|
tests.data
|
||||||
|
@@ -27,4 +27,8 @@ Installation:
|
|||||||
|
|
||||||
$ pip install fbchat
|
$ pip install fbchat
|
||||||
|
|
||||||
© Copyright 2015 - 2017 by Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__
|
Maintainer
|
||||||
|
----------
|
||||||
|
|
||||||
|
- Mads Marquart / `@madsmtm <https://github.com/madsmtm>`__
|
||||||
|
- Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__
|
||||||
|
@@ -70,8 +70,8 @@ The same method can be applied to some user accounts, though if they've set a cu
|
|||||||
Here's an snippet showing the usage of thread IDs and thread types, where ``<user id>`` and ``<group id>``
|
Here's an snippet showing the usage of thread IDs and thread types, where ``<user id>`` and ``<group id>``
|
||||||
corresponds to the ID of a single user, and the ID of a group respectively::
|
corresponds to the ID of a single user, and the ID of a group respectively::
|
||||||
|
|
||||||
client.sendMessage('<message>', thread_id='<user id>', thread_type=ThreadType.USER)
|
client.send(Message(text='<message>'), thread_id='<user id>', thread_type=ThreadType.USER)
|
||||||
client.sendMessage('<message>', thread_id='<group id>', thread_type=ThreadType.GROUP)
|
client.send(Message(text='<message>'), thread_id='<group id>', thread_type=ThreadType.GROUP)
|
||||||
|
|
||||||
Some functions (e.g. :func:`Client.changeThreadColor`) don't require a thread type, so in these cases you just provide the thread ID::
|
Some functions (e.g. :func:`Client.changeThreadColor`) don't require a thread type, so in these cases you just provide the thread ID::
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ Some of `fbchat`'s functions require these ID's, like :func:`Client.reactToMessa
|
|||||||
and some of then provide this ID, like :func:`Client.sendMessage`.
|
and some of then provide this ID, like :func:`Client.sendMessage`.
|
||||||
This snippet shows how to send a message, and then use the returned ID to react to that message with a 😍 emoji::
|
This snippet shows how to send a message, and then use the returned ID to react to that message with a 😍 emoji::
|
||||||
|
|
||||||
message_id = client.sendMessage('message', thread_id=thread_id, thread_type=thread_type)
|
message_id = client.send(Message(text='message'), thread_id=thread_id, thread_type=thread_type)
|
||||||
client.reactToMessage(message_id, MessageReaction.LOVE)
|
client.reactToMessage(message_id, MessageReaction.LOVE)
|
||||||
|
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ like adding users to and removing users from a group chat, logically only works
|
|||||||
The simplest way of using `fbchat` is to send a message.
|
The simplest way of using `fbchat` is to send a message.
|
||||||
The following snippet will, as you've probably already figured out, send the message `test message` to your account::
|
The following snippet will, as you've probably already figured out, send the message `test message` to your account::
|
||||||
|
|
||||||
message_id = client.sendMessage('test message', thread_id=client.uid, thread_type=ThreadType.USER)
|
message_id = client.send(Message(text='test message'), thread_id=client.uid, thread_type=ThreadType.USER)
|
||||||
|
|
||||||
You can see a full example showing all the possible thread interactions with `fbchat` by going to :ref:`examples`
|
You can see a full example showing all the possible thread interactions with `fbchat` by going to :ref:`examples`
|
||||||
|
|
||||||
@@ -175,8 +175,8 @@ meaning it will simply print information to the console when an event happens
|
|||||||
The event actions can be changed by subclassing the :class:`Client`, and then overwriting the event methods::
|
The event actions can be changed by subclassing the :class:`Client`, and then overwriting the event methods::
|
||||||
|
|
||||||
class CustomClient(Client):
|
class CustomClient(Client):
|
||||||
def onMessage(self, mid, author_id, message, thread_id, thread_type, ts, metadata, msg, **kwargs):
|
def onMessage(self, mid, author_id, message_object, thread_id, thread_type, ts, metadata, msg, **kwargs):
|
||||||
# Do something with the message here
|
# Do something with message_object here
|
||||||
pass
|
pass
|
||||||
|
|
||||||
client = CustomClient('<email>', '<password>')
|
client = CustomClient('<email>', '<password>')
|
||||||
@@ -184,13 +184,13 @@ The event actions can be changed by subclassing the :class:`Client`, and then ov
|
|||||||
**Notice:** The following snippet is as equally valid as the previous one::
|
**Notice:** The following snippet is as equally valid as the previous one::
|
||||||
|
|
||||||
class CustomClient(Client):
|
class CustomClient(Client):
|
||||||
def onMessage(self, message, author_id, thread_id, thread_type, **kwargs):
|
def onMessage(self, message_object, author_id, thread_id, thread_type, **kwargs):
|
||||||
# Do something with the message here
|
# Do something with message_object here
|
||||||
pass
|
pass
|
||||||
|
|
||||||
client = CustomClient('<email>', '<password>')
|
client = CustomClient('<email>', '<password>')
|
||||||
|
|
||||||
The change was in the parameters that our `onMessage` method took: ``message`` and ``author_id`` got swapped,
|
The change was in the parameters that our `onMessage` method took: ``message_object`` and ``author_id`` got swapped,
|
||||||
and ``mid``, ``ts``, ``metadata`` and ``msg`` got removed, but the function still works, since we included ``**kwargs``
|
and ``mid``, ``ts``, ``metadata`` and ``msg`` got removed, but the function still works, since we included ``**kwargs``
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@@ -7,6 +7,6 @@ client = Client('<email>', '<password>')
|
|||||||
|
|
||||||
print('Own id: {}'.format(client.uid))
|
print('Own id: {}'.format(client.uid))
|
||||||
|
|
||||||
client.sendMessage('Hi me!', thread_id=client.uid, thread_type=ThreadType.USER)
|
client.send(Message(text='Hi me!'), thread_id=client.uid, thread_type=ThreadType.USER)
|
||||||
|
|
||||||
client.logout()
|
client.logout()
|
||||||
|
@@ -4,15 +4,15 @@ from fbchat import log, Client
|
|||||||
|
|
||||||
# Subclass fbchat.Client and override required methods
|
# Subclass fbchat.Client and override required methods
|
||||||
class EchoBot(Client):
|
class EchoBot(Client):
|
||||||
def onMessage(self, author_id, message, thread_id, thread_type, **kwargs):
|
def onMessage(self, author_id, message_object, thread_id, thread_type, **kwargs):
|
||||||
self.markAsDelivered(author_id, thread_id)
|
self.markAsDelivered(author_id, thread_id)
|
||||||
self.markAsRead(author_id)
|
self.markAsRead(author_id)
|
||||||
|
|
||||||
log.info("Message from {} in {} ({}): {}".format(author_id, thread_id, thread_type.name, message))
|
log.info("{} from {} in {}".format(message_object, thread_id, thread_type.name))
|
||||||
|
|
||||||
# If you're not the author, echo
|
# If you're not the author, echo
|
||||||
if author_id != self.uid:
|
if author_id != self.uid:
|
||||||
self.sendMessage(message, thread_id=thread_id, thread_type=thread_type)
|
self.send(message_object, thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
client = EchoBot("<email>", "<password>")
|
client = EchoBot("<email>", "<password>")
|
||||||
client.listen()
|
client.listen()
|
||||||
|
@@ -9,19 +9,25 @@ thread_id = '1234567890'
|
|||||||
thread_type = ThreadType.GROUP
|
thread_type = ThreadType.GROUP
|
||||||
|
|
||||||
# Will send a message to the thread
|
# Will send a message to the thread
|
||||||
client.sendMessage('<message>', thread_id=thread_id, thread_type=thread_type)
|
client.send(Message(text='<message>'), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
# Will send the default `like` emoji
|
# Will send the default `like` emoji
|
||||||
client.sendEmoji(emoji=None, size=EmojiSize.LARGE, thread_id=thread_id, thread_type=thread_type)
|
client.send(Message(emoji_size=EmojiSize.LARGE), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
# Will send the emoji `👍`
|
# Will send the emoji `👍`
|
||||||
client.sendEmoji(emoji='👍', size=EmojiSize.LARGE, thread_id=thread_id, thread_type=thread_type)
|
client.send(Message(text='👍', emoji_size=EmojiSize.LARGE), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
|
# Will send the sticker with ID `767334476626295`
|
||||||
|
client.send(Message(sticker=Sticker('767334476626295')), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
|
# Will send a message with a mention
|
||||||
|
client.send(Message(text='This is a @mention', mentions=[Mention(thread_id, offset=10, length=8)]), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
# Will send the image located at `<image path>`
|
# Will send the image located at `<image path>`
|
||||||
client.sendLocalImage('<image path>', message='This is a local image', thread_id=thread_id, thread_type=thread_type)
|
client.sendLocalImage('<image path>', message=Message(text='This is a local image'), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
# Will download the image at the url `<image url>`, and then send it
|
# Will download the image at the url `<image url>`, and then send it
|
||||||
client.sendRemoteImage('<image url>', message='This is a remote image', thread_id=thread_id, thread_type=thread_type)
|
client.sendRemoteImage('<image url>', message=Message(text='This is a remote image'), thread_id=thread_id, thread_type=thread_type)
|
||||||
|
|
||||||
|
|
||||||
# Only do these actions if the thread is a group
|
# Only do these actions if the thread is a group
|
||||||
|
@@ -4,14 +4,14 @@ from fbchat import log, Client
|
|||||||
from fbchat.models import *
|
from fbchat.models import *
|
||||||
|
|
||||||
class RemoveBot(Client):
|
class RemoveBot(Client):
|
||||||
def onMessage(self, author_id, message, thread_id, thread_type, **kwargs):
|
def onMessage(self, author_id, message_object, thread_id, thread_type, **kwargs):
|
||||||
# We can only kick people from group chats, so no need to try if it's a user chat
|
# We can only kick people from group chats, so no need to try if it's a user chat
|
||||||
if message == 'Remove me!' and thread_type == ThreadType.GROUP:
|
if message_object.text == 'Remove me!' and thread_type == ThreadType.GROUP:
|
||||||
log.info('{} will be removed from {}'.format(author_id, thread_id))
|
log.info('{} will be removed from {}'.format(author_id, thread_id))
|
||||||
self.removeUserFromGroup(author_id, thread_id=thread_id)
|
self.removeUserFromGroup(author_id, thread_id=thread_id)
|
||||||
else:
|
else:
|
||||||
# Sends the data to the inherited onMessage, so that we can still see when a message is recieved
|
# Sends the data to the inherited onMessage, so that we can still see when a message is recieved
|
||||||
super(type(self), self).onMessage(author_id=author_id, message=message, thread_id=thread_id, thread_type=thread_type, **kwargs)
|
super(RemoveBot, self).onMessage(author_id=author_id, message_object=message_object, thread_id=thread_id, thread_type=thread_type, **kwargs)
|
||||||
|
|
||||||
client = RemoveBot("<email>", "<password>")
|
client = RemoveBot("<email>", "<password>")
|
||||||
client.listen()
|
client.listen()
|
||||||
|
@@ -17,7 +17,7 @@ from .client import *
|
|||||||
|
|
||||||
|
|
||||||
__copyright__ = 'Copyright 2015 - {} by Taehoon Kim'.format(datetime.now().year)
|
__copyright__ = 'Copyright 2015 - {} by Taehoon Kim'.format(datetime.now().year)
|
||||||
__version__ = '1.0.15'
|
__version__ = '1.3.5'
|
||||||
__license__ = 'BSD'
|
__license__ = 'BSD'
|
||||||
__author__ = 'Taehoon Kim; Moreels Pieter-Jan; Mads Marquart'
|
__author__ = 'Taehoon Kim; Moreels Pieter-Jan; Mads Marquart'
|
||||||
__email__ = 'carpedm20@gmail.com'
|
__email__ = 'carpedm20@gmail.com'
|
||||||
|
713
fbchat/client.py
713
fbchat/client.py
File diff suppressed because it is too large
Load Diff
@@ -31,7 +31,7 @@ def graphql_color_to_enum(color):
|
|||||||
try:
|
try:
|
||||||
return ThreadColor('#{}'.format(color[2:].lower()))
|
return ThreadColor('#{}'.format(color[2:].lower()))
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise Exception('Could not get ThreadColor from color: {}'.format(color))
|
raise FBchatException('Could not get ThreadColor from color: {}'.format(color))
|
||||||
|
|
||||||
def get_customization_info(thread):
|
def get_customization_info(thread):
|
||||||
if thread is None or thread.get('customization_info') is None:
|
if thread is None or thread.get('customization_info') is None:
|
||||||
@@ -42,44 +42,114 @@ def get_customization_info(thread):
|
|||||||
'emoji': info.get('emoji'),
|
'emoji': info.get('emoji'),
|
||||||
'color': graphql_color_to_enum(info.get('outgoing_bubble_color'))
|
'color': graphql_color_to_enum(info.get('outgoing_bubble_color'))
|
||||||
}
|
}
|
||||||
if thread.get('thread_type') == 'GROUP' or thread.get('is_group_thread') or thread.get('thread_key', {}).get('thread_fbid'):
|
if thread.get('thread_type') in ('GROUP', 'ROOM') or thread.get('is_group_thread') or thread.get('thread_key', {}).get('thread_fbid'):
|
||||||
rtn['nicknames'] = {}
|
rtn['nicknames'] = {}
|
||||||
for k in info.get('participant_customizations', []):
|
for k in info.get('participant_customizations', []):
|
||||||
rtn['nicknames'][k['participant_id']] = k.get('nickname')
|
rtn['nicknames'][k['participant_id']] = k.get('nickname')
|
||||||
elif info.get('participant_customizations'):
|
elif info.get('participant_customizations'):
|
||||||
_id = thread.get('thread_key', {}).get('other_user_id') or thread.get('id')
|
uid = thread.get('thread_key', {}).get('other_user_id') or thread.get('id')
|
||||||
if info['participant_customizations'][0]['participant_id'] == _id:
|
pc = info['participant_customizations']
|
||||||
rtn['nickname'] = info['participant_customizations'][0]
|
if len(pc) > 0:
|
||||||
if len(info['participant_customizations']) > 1:
|
if pc[0].get('participant_id') == uid:
|
||||||
rtn['own_nickname'] = info['participant_customizations'][1]
|
rtn['nickname'] = pc[0].get('nickname')
|
||||||
elif info['participant_customizations'][1]['participant_id'] == _id:
|
else:
|
||||||
rtn['nickname'] = info['participant_customizations'][1]
|
rtn['own_nickname'] = pc[0].get('nickname')
|
||||||
if len(info['participant_customizations']) > 1:
|
if len(pc) > 1:
|
||||||
rtn['own_nickname'] = info['participant_customizations'][0]
|
if pc[1].get('participant_id') == uid:
|
||||||
else:
|
rtn['nickname'] = pc[1].get('nickname')
|
||||||
raise Exception('No participant matching the user {} found: {}'.format(_id, info['participant_customizations']))
|
else:
|
||||||
|
rtn['own_nickname'] = pc[1].get('nickname')
|
||||||
return rtn
|
return rtn
|
||||||
|
|
||||||
|
|
||||||
|
def graphql_to_sticker(s):
|
||||||
|
if not s:
|
||||||
|
return None
|
||||||
|
sticker = Sticker(
|
||||||
|
uid=s['id']
|
||||||
|
)
|
||||||
|
if s.get('pack'):
|
||||||
|
sticker.pack = s['pack'].get('id')
|
||||||
|
if s.get('sprite_image'):
|
||||||
|
sticker.is_animated = True
|
||||||
|
sticker.medium_sprite_image = s['sprite_image'].get('uri')
|
||||||
|
sticker.large_sprite_image = s['sprite_image_2x'].get('uri')
|
||||||
|
sticker.frames_per_row = s.get('frames_per_row')
|
||||||
|
sticker.frames_per_col = s.get('frames_per_column')
|
||||||
|
sticker.frame_rate = s.get('frame_rate')
|
||||||
|
sticker.url = s.get('url')
|
||||||
|
sticker.width = s.get('width')
|
||||||
|
sticker.height = s.get('height')
|
||||||
|
if s.get('label'):
|
||||||
|
sticker.label = s['label']
|
||||||
|
return sticker
|
||||||
|
|
||||||
|
def graphql_to_attachment(a):
|
||||||
|
_type = a['__typename']
|
||||||
|
if _type in ['MessageImage', 'MessageAnimatedImage']:
|
||||||
|
return ImageAttachment(
|
||||||
|
original_extension=a.get('original_extension') or (a['filename'].split('-')[0] if a.get('filename') else None),
|
||||||
|
width=a.get('original_dimensions', {}).get('width'),
|
||||||
|
height=a.get('original_dimensions', {}).get('height'),
|
||||||
|
is_animated=_type=='MessageAnimatedImage',
|
||||||
|
thumbnail_url=a.get('thumbnail', {}).get('uri'),
|
||||||
|
preview=a.get('preview') or a.get('preview_image'),
|
||||||
|
large_preview=a.get('large_preview'),
|
||||||
|
animated_preview=a.get('animated_image'),
|
||||||
|
uid=a.get('legacy_attachment_id')
|
||||||
|
)
|
||||||
|
elif _type == 'MessageVideo':
|
||||||
|
return VideoAttachment(
|
||||||
|
width=a.get('original_dimensions', {}).get('width'),
|
||||||
|
height=a.get('original_dimensions', {}).get('height'),
|
||||||
|
duration=a.get('playable_duration_in_ms'),
|
||||||
|
preview_url=a.get('playable_url'),
|
||||||
|
small_image=a.get('chat_image'),
|
||||||
|
medium_image=a.get('inbox_image'),
|
||||||
|
large_image=a.get('large_image'),
|
||||||
|
uid=a.get('legacy_attachment_id')
|
||||||
|
)
|
||||||
|
elif _type == 'MessageAudio':
|
||||||
|
return AudioAttachment(
|
||||||
|
filename=a.get('filename'),
|
||||||
|
url=a.get('playable_url'),
|
||||||
|
duration=a.get('playable_duration_in_ms'),
|
||||||
|
audio_type=a.get('audio_type')
|
||||||
|
)
|
||||||
|
elif _type == 'MessageFile':
|
||||||
|
return FileAttachment(
|
||||||
|
url=a.get('url'),
|
||||||
|
name=a.get('filename'),
|
||||||
|
is_malicious=a.get('is_malicious'),
|
||||||
|
uid=a.get('message_file_fbid')
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
return Attachment(
|
||||||
|
uid=a.get('legacy_attachment_id')
|
||||||
|
)
|
||||||
|
|
||||||
def graphql_to_message(message):
|
def graphql_to_message(message):
|
||||||
if message.get('message_sender') is None:
|
if message.get('message_sender') is None:
|
||||||
message['message_sender'] = {}
|
message['message_sender'] = {}
|
||||||
if message.get('message') is None:
|
if message.get('message') is None:
|
||||||
message['message'] = {}
|
message['message'] = {}
|
||||||
is_read = None
|
rtn = Message(
|
||||||
if message.get('unread') is not None:
|
|
||||||
is_read = not message['unread']
|
|
||||||
return Message(
|
|
||||||
message.get('message_id'),
|
|
||||||
author=message.get('message_sender').get('id'),
|
|
||||||
timestamp=message.get('timestamp_precise'),
|
|
||||||
is_read=is_read,
|
|
||||||
reactions=message.get('message_reactions'),
|
|
||||||
text=message.get('message').get('text'),
|
text=message.get('message').get('text'),
|
||||||
mentions=[Mention(m.get('entity', {}).get('id'), offset=m.get('offset'), length=m.get('length')) for m in message.get('message').get('ranges', [])],
|
mentions=[Mention(m.get('entity', {}).get('id'), offset=m.get('offset'), length=m.get('length')) for m in message.get('message').get('ranges', [])],
|
||||||
sticker=message.get('sticker'),
|
emoji_size=get_emojisize_from_tags(message.get('tags_list')),
|
||||||
attachments=message.get('blob_attachments'),
|
sticker=graphql_to_sticker(message.get('sticker'))
|
||||||
extensible_attachment=message.get('extensible_attachment')
|
|
||||||
)
|
)
|
||||||
|
rtn.uid = str(message.get('message_id'))
|
||||||
|
rtn.author = str(message.get('message_sender').get('id'))
|
||||||
|
rtn.timestamp = message.get('timestamp_precise')
|
||||||
|
if message.get('unread') is not None:
|
||||||
|
rtn.is_read = not message['unread']
|
||||||
|
rtn.reactions = {str(r['user']['id']):MessageReaction(r['reaction']) for r in message.get('message_reactions')}
|
||||||
|
if message.get('blob_attachments') is not None:
|
||||||
|
rtn.attachments = [graphql_to_attachment(attachment) for attachment in message['blob_attachments']]
|
||||||
|
# TODO: This is still missing parsing:
|
||||||
|
# message.get('extensible_attachment')
|
||||||
|
return rtn
|
||||||
|
|
||||||
def graphql_to_user(user):
|
def graphql_to_user(user):
|
||||||
if user.get('profile_picture') is None:
|
if user.get('profile_picture') is None:
|
||||||
@@ -91,20 +161,57 @@ def graphql_to_user(user):
|
|||||||
first_name=user.get('first_name'),
|
first_name=user.get('first_name'),
|
||||||
last_name=user.get('last_name'),
|
last_name=user.get('last_name'),
|
||||||
is_friend=user.get('is_viewer_friend'),
|
is_friend=user.get('is_viewer_friend'),
|
||||||
gender=GENDERS[user.get('gender')],
|
gender=GENDERS.get(user.get('gender')),
|
||||||
affinity=user.get('affinity'),
|
affinity=user.get('affinity'),
|
||||||
nickname=c_info.get('nickname'),
|
nickname=c_info.get('nickname'),
|
||||||
color=c_info.get('color'),
|
color=c_info.get('color'),
|
||||||
emoji=c_info.get('emoji'),
|
emoji=c_info.get('emoji'),
|
||||||
own_nickname=c_info.get('own_nickname'),
|
own_nickname=c_info.get('own_nickname'),
|
||||||
photo=user['profile_picture'].get('uri'),
|
photo=user['profile_picture'].get('uri'),
|
||||||
name=user.get('name')
|
name=user.get('name'),
|
||||||
|
message_count=user.get('messages_count')
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def graphql_to_thread(thread):
|
||||||
|
if thread['thread_type'] == 'GROUP':
|
||||||
|
return graphql_to_group(thread)
|
||||||
|
elif thread['thread_type'] == 'ONE_TO_ONE':
|
||||||
|
if thread.get('big_image_src') is None:
|
||||||
|
thread['big_image_src'] = {}
|
||||||
|
c_info = get_customization_info(thread)
|
||||||
|
participants = [node['messaging_actor'] for node in thread['all_participants']['nodes']]
|
||||||
|
user = next(p for p in participants if p['id'] == thread['thread_key']['other_user_id'])
|
||||||
|
last_message_timestamp = None
|
||||||
|
if 'last_message' in thread:
|
||||||
|
last_message_timestamp = thread['last_message']['nodes'][0]['timestamp_precise']
|
||||||
|
|
||||||
|
return User(
|
||||||
|
user['id'],
|
||||||
|
url=user.get('url'),
|
||||||
|
name=user.get('name'),
|
||||||
|
first_name=user.get('short_name'),
|
||||||
|
last_name=user.get('name').split(user.get('short_name'),1)[1].strip(),
|
||||||
|
is_friend=user.get('is_viewer_friend'),
|
||||||
|
gender=GENDERS.get(user.get('gender')),
|
||||||
|
affinity=user.get('affinity'),
|
||||||
|
nickname=c_info.get('nickname'),
|
||||||
|
color=c_info.get('color'),
|
||||||
|
emoji=c_info.get('emoji'),
|
||||||
|
own_nickname=c_info.get('own_nickname'),
|
||||||
|
photo=user['big_image_src'].get('uri'),
|
||||||
|
message_count=thread.get('messages_count'),
|
||||||
|
last_message_timestamp=last_message_timestamp
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
raise FBchatException('Unknown thread type: {}, with data: {}'.format(thread.get('thread_type'), thread))
|
||||||
|
|
||||||
def graphql_to_group(group):
|
def graphql_to_group(group):
|
||||||
if group.get('image') is None:
|
if group.get('image') is None:
|
||||||
group['image'] = {}
|
group['image'] = {}
|
||||||
c_info = get_customization_info(group)
|
c_info = get_customization_info(group)
|
||||||
|
last_message_timestamp = None
|
||||||
|
if 'last_message' in group:
|
||||||
|
last_message_timestamp = group['last_message']['nodes'][0]['timestamp_precise']
|
||||||
return Group(
|
return Group(
|
||||||
group['thread_key']['thread_fbid'],
|
group['thread_key']['thread_fbid'],
|
||||||
participants=set([node['messaging_actor']['id'] for node in group['all_participants']['nodes']]),
|
participants=set([node['messaging_actor']['id'] for node in group['all_participants']['nodes']]),
|
||||||
@@ -112,7 +219,29 @@ def graphql_to_group(group):
|
|||||||
color=c_info.get('color'),
|
color=c_info.get('color'),
|
||||||
emoji=c_info.get('emoji'),
|
emoji=c_info.get('emoji'),
|
||||||
photo=group['image'].get('uri'),
|
photo=group['image'].get('uri'),
|
||||||
name=group.get('name')
|
name=group.get('name'),
|
||||||
|
message_count=group.get('messages_count'),
|
||||||
|
last_message_timestamp=last_message_timestamp
|
||||||
|
)
|
||||||
|
|
||||||
|
def graphql_to_room(room):
|
||||||
|
if room.get('image') is None:
|
||||||
|
room['image'] = {}
|
||||||
|
c_info = get_customization_info(room)
|
||||||
|
return Room(
|
||||||
|
room['thread_key']['thread_fbid'],
|
||||||
|
participants=set([node['messaging_actor']['id'] for node in room['all_participants']['nodes']]),
|
||||||
|
nicknames=c_info.get('nicknames'),
|
||||||
|
color=c_info.get('color'),
|
||||||
|
emoji=c_info.get('emoji'),
|
||||||
|
photo=room['image'].get('uri'),
|
||||||
|
name=room.get('name'),
|
||||||
|
message_count=room.get('messages_count'),
|
||||||
|
admins = set([node.get('id') for node in room.get('thread_admins')]),
|
||||||
|
approval_mode = bool(room.get('approval_mode')),
|
||||||
|
approval_requests = set(node.get('id') for node in room['thread_queue_metadata'].get('approval_requests', {}).get('nodes')),
|
||||||
|
join_link = room['joinable_mode'].get('link'),
|
||||||
|
privacy_mode = bool(room.get('privacy_mode')),
|
||||||
)
|
)
|
||||||
|
|
||||||
def graphql_to_page(page):
|
def graphql_to_page(page):
|
||||||
@@ -126,7 +255,8 @@ def graphql_to_page(page):
|
|||||||
city=page.get('city').get('name'),
|
city=page.get('city').get('name'),
|
||||||
category=page.get('category_type'),
|
category=page.get('category_type'),
|
||||||
photo=page['profile_picture'].get('uri'),
|
photo=page['profile_picture'].get('uri'),
|
||||||
name=page.get('name')
|
name=page.get('name'),
|
||||||
|
message_count=page.get('messages_count')
|
||||||
)
|
)
|
||||||
|
|
||||||
def graphql_queries_to_json(*queries):
|
def graphql_queries_to_json(*queries):
|
||||||
@@ -139,7 +269,11 @@ def graphql_queries_to_json(*queries):
|
|||||||
return json.dumps(rtn)
|
return json.dumps(rtn)
|
||||||
|
|
||||||
def graphql_response_to_json(content):
|
def graphql_response_to_json(content):
|
||||||
j = json.loads(content, cls=ConcatJSONDecoder)
|
content = strip_to_json(content) # Usually only needed in some error cases
|
||||||
|
try:
|
||||||
|
j = json.loads(content, cls=ConcatJSONDecoder)
|
||||||
|
except Exception:
|
||||||
|
raise FBchatException('Error while parsing JSON: {}'.format(repr(content)))
|
||||||
|
|
||||||
rtn = [None]*(len(j))
|
rtn = [None]*(len(j))
|
||||||
for x in j:
|
for x in j:
|
||||||
@@ -159,7 +293,9 @@ def graphql_response_to_json(content):
|
|||||||
return rtn
|
return rtn
|
||||||
|
|
||||||
class GraphQL(object):
|
class GraphQL(object):
|
||||||
def __init__(self, query=None, doc_id=None, params={}):
|
def __init__(self, query=None, doc_id=None, params=None):
|
||||||
|
if params is None:
|
||||||
|
params = {}
|
||||||
if query is not None:
|
if query is not None:
|
||||||
self.value = {
|
self.value = {
|
||||||
'priority': 0,
|
'priority': 0,
|
||||||
@@ -172,7 +308,7 @@ class GraphQL(object):
|
|||||||
'query_params': params
|
'query_params': params
|
||||||
}
|
}
|
||||||
else:
|
else:
|
||||||
raise Exception('A query or doc_id must be specified')
|
raise FBchatUserError('A query or doc_id must be specified')
|
||||||
|
|
||||||
|
|
||||||
FRAGMENT_USER = """
|
FRAGMENT_USER = """
|
||||||
|
416
fbchat/models.py
416
fbchat/models.py
@@ -4,25 +4,47 @@ from __future__ import unicode_literals
|
|||||||
import enum
|
import enum
|
||||||
|
|
||||||
|
|
||||||
|
class FBchatException(Exception):
|
||||||
|
"""Custom exception thrown by fbchat. All exceptions in the fbchat module inherits this"""
|
||||||
|
|
||||||
|
class FBchatFacebookError(FBchatException):
|
||||||
|
#: The error code that Facebook returned
|
||||||
|
fb_error_code = None
|
||||||
|
#: The error message that Facebook returned (In the user's own language)
|
||||||
|
fb_error_message = None
|
||||||
|
#: The status code that was sent in the http response (eg. 404) (Usually only set if not successful, aka. not 200)
|
||||||
|
request_status_code = None
|
||||||
|
def __init__(self, message, fb_error_code=None, fb_error_message=None, request_status_code=None):
|
||||||
|
super(FBchatFacebookError, self).__init__(message)
|
||||||
|
"""Thrown by fbchat when Facebook returns an error"""
|
||||||
|
self.fb_error_code = str(fb_error_code)
|
||||||
|
self.fb_error_message = fb_error_message
|
||||||
|
self.request_status_code = request_status_code
|
||||||
|
|
||||||
|
class FBchatUserError(FBchatException):
|
||||||
|
"""Thrown by fbchat when wrong values are entered"""
|
||||||
|
|
||||||
class Thread(object):
|
class Thread(object):
|
||||||
#: The unique identifier of the thread. Can be used a `thread_id`. See :ref:`intro_threads` for more info
|
#: The unique identifier of the thread. Can be used a `thread_id`. See :ref:`intro_threads` for more info
|
||||||
uid = str
|
uid = None
|
||||||
#: Specifies the type of thread. Can be used a `thread_type`. See :ref:`intro_threads` for more info
|
#: Specifies the type of thread. Can be used a `thread_type`. See :ref:`intro_threads` for more info
|
||||||
type = None
|
type = None
|
||||||
#: The thread's picture
|
#: A url to the thread's picture
|
||||||
photo = str
|
photo = None
|
||||||
#: The name of the thread
|
#: The name of the thread
|
||||||
name = str
|
name = None
|
||||||
#: Timestamp of last message
|
#: Timestamp of last message
|
||||||
last_message_timestamp = str
|
last_message_timestamp = None
|
||||||
|
#: Number of messages in the thread
|
||||||
def __init__(self, _type, uid, photo=None, name=None, last_message_timestamp=None):
|
message_count = None
|
||||||
|
def __init__(self, _type, uid, photo=None, name=None, last_message_timestamp=None, message_count=None):
|
||||||
"""Represents a Facebook thread"""
|
"""Represents a Facebook thread"""
|
||||||
self.uid = str(uid)
|
self.uid = str(uid)
|
||||||
self.type = _type
|
self.type = _type
|
||||||
self.photo = photo
|
self.photo = photo
|
||||||
self.name = name
|
self.name = name
|
||||||
self.last_message_timestamp = last_message_timestamp
|
self.last_message_timestamp = last_message_timestamp
|
||||||
|
self.message_count = message_count
|
||||||
|
|
||||||
def __repr__(self):
|
def __repr__(self):
|
||||||
return self.__unicode__()
|
return self.__unicode__()
|
||||||
@@ -33,25 +55,25 @@ class Thread(object):
|
|||||||
|
|
||||||
class User(Thread):
|
class User(Thread):
|
||||||
#: The profile url
|
#: The profile url
|
||||||
url = str
|
url = None
|
||||||
#: The users first name
|
#: The users first name
|
||||||
first_name = str
|
first_name = None
|
||||||
#: The users last name
|
#: The users last name
|
||||||
last_name = str
|
last_name = None
|
||||||
#: Whether the user and the client are friends
|
#: Whether the user and the client are friends
|
||||||
is_friend = bool
|
is_friend = None
|
||||||
#: The user's gender
|
#: The user's gender
|
||||||
gender = str
|
gender = None
|
||||||
#: From 0 to 1. How close the client is to the user
|
#: From 0 to 1. How close the client is to the user
|
||||||
affinity = float
|
affinity = None
|
||||||
#: The user's nickname
|
#: The user's nickname
|
||||||
nickname = str
|
nickname = None
|
||||||
#: The clients nickname, as seen by the user
|
#: The clients nickname, as seen by the user
|
||||||
own_nickname = str
|
own_nickname = None
|
||||||
#: A :class:`ThreadColor`. The message color
|
#: A :class:`ThreadColor`. The message color
|
||||||
color = None
|
color = None
|
||||||
#: The default emoji
|
#: The default emoji
|
||||||
emoji = str
|
emoji = None
|
||||||
|
|
||||||
def __init__(self, uid, url=None, first_name=None, last_name=None, is_friend=None, gender=None, affinity=None, nickname=None, own_nickname=None, color=None, emoji=None, **kwargs):
|
def __init__(self, uid, url=None, first_name=None, last_name=None, is_friend=None, gender=None, affinity=None, nickname=None, own_nickname=None, color=None, emoji=None, **kwargs):
|
||||||
"""Represents a Facebook user. Inherits `Thread`"""
|
"""Represents a Facebook user. Inherits `Thread`"""
|
||||||
@@ -70,34 +92,65 @@ class User(Thread):
|
|||||||
|
|
||||||
class Group(Thread):
|
class Group(Thread):
|
||||||
#: Unique list (set) of the group thread's participant user IDs
|
#: Unique list (set) of the group thread's participant user IDs
|
||||||
participants = set
|
participants = None
|
||||||
#: Dict, containing user nicknames mapped to their IDs
|
#: A dict, containing user nicknames mapped to their IDs
|
||||||
nicknames = dict
|
nicknames = None
|
||||||
#: A :class:`ThreadColor`. The groups's message color
|
#: A :class:`ThreadColor`. The groups's message color
|
||||||
color = None
|
color = None
|
||||||
#: The groups's default emoji
|
#: The groups's default emoji
|
||||||
emoji = str
|
emoji = None
|
||||||
|
|
||||||
def __init__(self, uid, participants=set(), nicknames=[], color=None, emoji=None, **kwargs):
|
def __init__(self, uid, participants=None, nicknames=None, color=None, emoji=None, **kwargs):
|
||||||
"""Represents a Facebook group. Inherits `Thread`"""
|
"""Represents a Facebook group. Inherits `Thread`"""
|
||||||
super(Group, self).__init__(ThreadType.GROUP, uid, **kwargs)
|
super(Group, self).__init__(ThreadType.GROUP, uid, **kwargs)
|
||||||
|
if participants is None:
|
||||||
|
participants = set()
|
||||||
self.participants = participants
|
self.participants = participants
|
||||||
|
if nicknames is None:
|
||||||
|
nicknames = []
|
||||||
self.nicknames = nicknames
|
self.nicknames = nicknames
|
||||||
self.color = color
|
self.color = color
|
||||||
self.emoji = emoji
|
self.emoji = emoji
|
||||||
|
|
||||||
|
|
||||||
|
class Room(Group):
|
||||||
|
# Set containing user IDs of thread admins
|
||||||
|
admins = None
|
||||||
|
# True if users need approval to join
|
||||||
|
approval_mode = None
|
||||||
|
# Set containing user IDs requesting to join
|
||||||
|
approval_requests = None
|
||||||
|
# Link for joining room
|
||||||
|
join_link = None
|
||||||
|
# True is room is not discoverable
|
||||||
|
privacy_mode = None
|
||||||
|
|
||||||
|
def __init__(self, uid, admins=None, approval_mode=None, approval_requests=None, join_link=None, privacy_mode=None, **kwargs):
|
||||||
|
"""Represents a Facebook room. Inherits `Group`"""
|
||||||
|
super(Room, self).__init__(uid, **kwargs)
|
||||||
|
self.type = ThreadType.ROOM
|
||||||
|
if admins is None:
|
||||||
|
admins = set()
|
||||||
|
self.admins = admins
|
||||||
|
self.approval_mode = approval_mode
|
||||||
|
if approval_requests is None:
|
||||||
|
approval_requests = set()
|
||||||
|
self.approval_requests = approval_requests
|
||||||
|
self.join_link = join_link
|
||||||
|
self.privacy_mode = privacy_mode
|
||||||
|
|
||||||
|
|
||||||
class Page(Thread):
|
class Page(Thread):
|
||||||
#: The page's custom url
|
#: The page's custom url
|
||||||
url = str
|
url = None
|
||||||
#: The name of the page's location city
|
#: The name of the page's location city
|
||||||
city = str
|
city = None
|
||||||
#: Amount of likes the page has
|
#: Amount of likes the page has
|
||||||
likes = int
|
likes = None
|
||||||
#: Some extra information about the page
|
#: Some extra information about the page
|
||||||
sub_title = str
|
sub_title = None
|
||||||
#: The page's category
|
#: The page's category
|
||||||
category = str
|
category = None
|
||||||
|
|
||||||
def __init__(self, uid, url=None, city=None, likes=None, sub_title=None, category=None, **kwargs):
|
def __init__(self, uid, url=None, city=None, likes=None, sub_title=None, category=None, **kwargs):
|
||||||
"""Represents a Facebook page. Inherits `Thread`"""
|
"""Represents a Facebook page. Inherits `Thread`"""
|
||||||
@@ -110,55 +163,279 @@ class Page(Thread):
|
|||||||
|
|
||||||
|
|
||||||
class Message(object):
|
class Message(object):
|
||||||
#: The message ID
|
|
||||||
uid = str
|
|
||||||
#: ID of the sender
|
|
||||||
author = int
|
|
||||||
#: Timestamp of when the message was sent
|
|
||||||
timestamp = str
|
|
||||||
#: Whether the message is read
|
|
||||||
is_read = bool
|
|
||||||
#: A list of message reactions
|
|
||||||
reactions = list
|
|
||||||
#: The actual message
|
#: The actual message
|
||||||
text = str
|
text = None
|
||||||
#: A list of :class:`Mention` objects
|
#: A list of :class:`Mention` objects
|
||||||
mentions = list
|
mentions = None
|
||||||
#: An ID of a sent sticker
|
#: A :class:`EmojiSize`. Size of a sent emoji
|
||||||
sticker = str
|
emoji_size = None
|
||||||
|
#: The message ID
|
||||||
|
uid = None
|
||||||
|
#: ID of the sender
|
||||||
|
author = None
|
||||||
|
#: Timestamp of when the message was sent
|
||||||
|
timestamp = None
|
||||||
|
#: Whether the message is read
|
||||||
|
is_read = None
|
||||||
|
#: A dict with user's IDs as keys, and their :class:`MessageReaction` as values
|
||||||
|
reactions = None
|
||||||
|
#: The actual message
|
||||||
|
text = None
|
||||||
|
#: A :class:`Sticker`
|
||||||
|
sticker = None
|
||||||
#: A list of attachments
|
#: A list of attachments
|
||||||
attachments = list
|
attachments = None
|
||||||
#: An extensible attachment, e.g. share object
|
|
||||||
extensible_attachment = dict
|
|
||||||
|
|
||||||
def __init__(self, uid, author=None, timestamp=None, is_read=None, reactions=[], text=None, mentions=[], sticker=None, attachments=[], extensible_attachment={}):
|
def __init__(self, text=None, mentions=None, emoji_size=None, sticker=None, attachments=None):
|
||||||
"""Represents a Facebook message"""
|
"""Represents a Facebook message"""
|
||||||
self.uid = uid
|
|
||||||
self.author = author
|
|
||||||
self.timestamp = timestamp
|
|
||||||
self.is_read = is_read
|
|
||||||
self.reactions = reactions
|
|
||||||
self.text = text
|
self.text = text
|
||||||
|
if mentions is None:
|
||||||
|
mentions = []
|
||||||
self.mentions = mentions
|
self.mentions = mentions
|
||||||
|
self.emoji_size = emoji_size
|
||||||
self.sticker = sticker
|
self.sticker = sticker
|
||||||
|
if attachments is None:
|
||||||
|
attachments = []
|
||||||
self.attachments = attachments
|
self.attachments = attachments
|
||||||
self.extensible_attachment = extensible_attachment
|
self.reactions = {}
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return self.__unicode__()
|
||||||
|
|
||||||
|
def __unicode__(self):
|
||||||
|
return '<Message ({}): {}, mentions={} emoji_size={} attachments={}>'.format(self.uid, repr(self.text), self.mentions, self.emoji_size, self.attachments)
|
||||||
|
|
||||||
|
class Attachment(object):
|
||||||
|
#: The attachment ID
|
||||||
|
uid = None
|
||||||
|
|
||||||
|
def __init__(self, uid=None):
|
||||||
|
"""Represents a Facebook attachment"""
|
||||||
|
self.uid = uid
|
||||||
|
|
||||||
|
class Sticker(Attachment):
|
||||||
|
#: The sticker-pack's ID
|
||||||
|
pack = None
|
||||||
|
#: Whether the sticker is animated
|
||||||
|
is_animated = False
|
||||||
|
|
||||||
|
# If the sticker is animated, the following should be present
|
||||||
|
#: URL to a medium spritemap
|
||||||
|
medium_sprite_image = None
|
||||||
|
#: URL to a large spritemap
|
||||||
|
large_sprite_image = None
|
||||||
|
#: The amount of frames present in the spritemap pr. row
|
||||||
|
frames_per_row = None
|
||||||
|
#: The amount of frames present in the spritemap pr. coloumn
|
||||||
|
frames_per_col = None
|
||||||
|
#: The frame rate the spritemap is intended to be played in
|
||||||
|
frame_rate = None
|
||||||
|
|
||||||
|
#: URL to the sticker's image
|
||||||
|
url = None
|
||||||
|
#: Width of the sticker
|
||||||
|
width = None
|
||||||
|
#: Height of the sticker
|
||||||
|
height = None
|
||||||
|
#: The sticker's label/name
|
||||||
|
label = None
|
||||||
|
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
"""Represents a Facebook sticker that has been sent to a Facebook thread as an attachment"""
|
||||||
|
super(Sticker, self).__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
class ShareAttachment(Attachment):
|
||||||
|
def __init__(self, **kwargs):
|
||||||
|
"""Represents a shared item (eg. URL) that has been sent as a Facebook attachment - *Currently Incomplete!*"""
|
||||||
|
super(ShareAttachment, self).__init__(**kwargs)
|
||||||
|
|
||||||
|
class FileAttachment(Attachment):
|
||||||
|
#: Url where you can download the file
|
||||||
|
url = None
|
||||||
|
#: Size of the file in bytes
|
||||||
|
size = None
|
||||||
|
#: Name of the file
|
||||||
|
name = None
|
||||||
|
#: Whether Facebook determines that this file may be harmful
|
||||||
|
is_malicious = None
|
||||||
|
|
||||||
|
def __init__(self, url=None, size=None, name=None, is_malicious=None, **kwargs):
|
||||||
|
"""Represents a file that has been sent as a Facebook attachment"""
|
||||||
|
super(FileAttachment, self).__init__(**kwargs)
|
||||||
|
self.url = url
|
||||||
|
self.size = size
|
||||||
|
self.name = name
|
||||||
|
self.is_malicious = is_malicious
|
||||||
|
|
||||||
|
class AudioAttachment(Attachment):
|
||||||
|
#: Name of the file
|
||||||
|
filename = None
|
||||||
|
#: Url of the audio file
|
||||||
|
url = None
|
||||||
|
#: Duration of the audioclip in milliseconds
|
||||||
|
duration = None
|
||||||
|
#: Audio type
|
||||||
|
audio_type = None
|
||||||
|
|
||||||
|
def __init__(self, filename=None, url=None, duration=None, audio_type=None, **kwargs):
|
||||||
|
"""Represents an audio file that has been sent as a Facebook attachment"""
|
||||||
|
super(AudioAttachment, self).__init__(**kwargs)
|
||||||
|
self.filename = filename
|
||||||
|
self.url = url
|
||||||
|
self.duration = duration
|
||||||
|
self.audio_type = audio_type
|
||||||
|
|
||||||
|
class ImageAttachment(Attachment):
|
||||||
|
#: The extension of the original image (eg. 'png')
|
||||||
|
original_extension = None
|
||||||
|
#: Width of original image
|
||||||
|
width = None
|
||||||
|
#: Height of original image
|
||||||
|
height = None
|
||||||
|
|
||||||
|
#: Whether the image is animated
|
||||||
|
is_animated = None
|
||||||
|
|
||||||
|
#: URL to a thumbnail of the image
|
||||||
|
thumbnail_url = None
|
||||||
|
|
||||||
|
#: URL to a medium preview of the image
|
||||||
|
preview_url = None
|
||||||
|
#: Width of the medium preview image
|
||||||
|
preview_width = None
|
||||||
|
#: Height of the medium preview image
|
||||||
|
preview_height = None
|
||||||
|
|
||||||
|
#: URL to a large preview of the image
|
||||||
|
large_preview_url = None
|
||||||
|
#: Width of the large preview image
|
||||||
|
large_preview_width = None
|
||||||
|
#: Height of the large preview image
|
||||||
|
large_preview_height = None
|
||||||
|
|
||||||
|
#: URL to an animated preview of the image (eg. for gifs)
|
||||||
|
animated_preview_url = None
|
||||||
|
#: Width of the animated preview image
|
||||||
|
animated_preview_width = None
|
||||||
|
#: Height of the animated preview image
|
||||||
|
animated_preview_height = None
|
||||||
|
|
||||||
|
def __init__(self, original_extension=None, width=None, height=None, is_animated=None, thumbnail_url=None, preview=None, large_preview=None, animated_preview=None, **kwargs):
|
||||||
|
"""
|
||||||
|
Represents an image that has been sent as a Facebook attachment
|
||||||
|
To retrieve the full image url, use: :func:`fbchat.Client.fetchImageUrl`,
|
||||||
|
and pass it the uid of the image attachment
|
||||||
|
"""
|
||||||
|
super(ImageAttachment, self).__init__(**kwargs)
|
||||||
|
self.original_extension = original_extension
|
||||||
|
if width is not None:
|
||||||
|
width = int(width)
|
||||||
|
self.width = width
|
||||||
|
if height is not None:
|
||||||
|
height = int(height)
|
||||||
|
self.height = height
|
||||||
|
self.is_animated = is_animated
|
||||||
|
self.thumbnail_url = thumbnail_url
|
||||||
|
|
||||||
|
if preview is None:
|
||||||
|
preview = {}
|
||||||
|
self.preview_url = preview.get('uri')
|
||||||
|
self.preview_width = preview.get('width')
|
||||||
|
self.preview_height = preview.get('height')
|
||||||
|
|
||||||
|
if large_preview is None:
|
||||||
|
large_preview = {}
|
||||||
|
self.large_preview_url = large_preview.get('uri')
|
||||||
|
self.large_preview_width = large_preview.get('width')
|
||||||
|
self.large_preview_height = large_preview.get('height')
|
||||||
|
|
||||||
|
if animated_preview is None:
|
||||||
|
animated_preview = {}
|
||||||
|
self.animated_preview_url = animated_preview.get('uri')
|
||||||
|
self.animated_preview_width = animated_preview.get('width')
|
||||||
|
self.animated_preview_height = animated_preview.get('height')
|
||||||
|
|
||||||
|
class VideoAttachment(Attachment):
|
||||||
|
#: Size of the original video in bytes
|
||||||
|
size = None
|
||||||
|
#: Width of original video
|
||||||
|
width = None
|
||||||
|
#: Height of original video
|
||||||
|
height = None
|
||||||
|
#: Length of video in milliseconds
|
||||||
|
duration = None
|
||||||
|
#: URL to very compressed preview video
|
||||||
|
preview_url = None
|
||||||
|
|
||||||
|
#: URL to a small preview image of the video
|
||||||
|
small_image_url = None
|
||||||
|
#: Width of the small preview image
|
||||||
|
small_image_width = None
|
||||||
|
#: Height of the small preview image
|
||||||
|
small_image_height = None
|
||||||
|
|
||||||
|
#: URL to a medium preview image of the video
|
||||||
|
medium_image_url = None
|
||||||
|
#: Width of the medium preview image
|
||||||
|
medium_image_width = None
|
||||||
|
#: Height of the medium preview image
|
||||||
|
medium_image_height = None
|
||||||
|
|
||||||
|
#: URL to a large preview image of the video
|
||||||
|
large_image_url = None
|
||||||
|
#: Width of the large preview image
|
||||||
|
large_image_width = None
|
||||||
|
#: Height of the large preview image
|
||||||
|
large_image_height = None
|
||||||
|
|
||||||
|
def __init__(self, size=None, width=None, height=None, duration=None, preview_url=None, small_image=None, medium_image=None, large_image=None, **kwargs):
|
||||||
|
"""Represents a video that has been sent as a Facebook attachment"""
|
||||||
|
super(VideoAttachment, self).__init__(**kwargs)
|
||||||
|
self.size = size
|
||||||
|
self.width = width
|
||||||
|
self.height = height
|
||||||
|
self.duration = duration
|
||||||
|
self.preview_url = preview_url
|
||||||
|
|
||||||
|
if small_image is None:
|
||||||
|
small_image = {}
|
||||||
|
self.small_image_url = small_image.get('uri')
|
||||||
|
self.small_image_width = small_image.get('width')
|
||||||
|
self.small_image_height = small_image.get('height')
|
||||||
|
|
||||||
|
if medium_image is None:
|
||||||
|
medium_image = {}
|
||||||
|
self.medium_image_url = medium_image.get('uri')
|
||||||
|
self.medium_image_width = medium_image.get('width')
|
||||||
|
self.medium_image_height = medium_image.get('height')
|
||||||
|
|
||||||
|
if large_image is None:
|
||||||
|
large_image = {}
|
||||||
|
self.large_image_url = large_image.get('uri')
|
||||||
|
self.large_image_width = large_image.get('width')
|
||||||
|
self.large_image_height = large_image.get('height')
|
||||||
|
|
||||||
|
|
||||||
class Mention(object):
|
class Mention(object):
|
||||||
#: The user ID the mention is pointing at
|
#: The thread ID the mention is pointing at
|
||||||
user_id = str
|
thread_id = None
|
||||||
#: The character where the mention starts
|
#: The character where the mention starts
|
||||||
offset = int
|
offset = None
|
||||||
#: The length of the mention
|
#: The length of the mention
|
||||||
length = int
|
length = None
|
||||||
|
|
||||||
def __init__(self, user_id, offset=0, length=10):
|
def __init__(self, thread_id, offset=0, length=10):
|
||||||
"""Represents a @mention"""
|
"""Represents a @mention"""
|
||||||
self.user_id = user_id
|
self.thread_id = thread_id
|
||||||
self.offset = offset
|
self.offset = offset
|
||||||
self.length = length
|
self.length = length
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return self.__unicode__()
|
||||||
|
|
||||||
|
def __unicode__(self):
|
||||||
|
return '<Mention {}: offset={} length={}>'.format(self.thread_id, self.offset, self.length)
|
||||||
|
|
||||||
class Enum(enum.Enum):
|
class Enum(enum.Enum):
|
||||||
"""Used internally by fbchat to support enumerations"""
|
"""Used internally by fbchat to support enumerations"""
|
||||||
def __repr__(self):
|
def __repr__(self):
|
||||||
@@ -170,6 +447,14 @@ class ThreadType(Enum):
|
|||||||
USER = 1
|
USER = 1
|
||||||
GROUP = 2
|
GROUP = 2
|
||||||
PAGE = 3
|
PAGE = 3
|
||||||
|
ROOM = 4
|
||||||
|
|
||||||
|
class ThreadLocation(Enum):
|
||||||
|
"""Used to specify where a thread is located (inbox, pending, archived, other)."""
|
||||||
|
INBOX = 'INBOX'
|
||||||
|
PENDING = 'PENDING'
|
||||||
|
ARCHIVED = 'ARCHIVED'
|
||||||
|
OTHER = 'OTHER'
|
||||||
|
|
||||||
class TypingStatus(Enum):
|
class TypingStatus(Enum):
|
||||||
"""Used to specify whether the user is typing or has stopped typing"""
|
"""Used to specify whether the user is typing or has stopped typing"""
|
||||||
@@ -209,22 +494,3 @@ class MessageReaction(Enum):
|
|||||||
ANGRY = '😠'
|
ANGRY = '😠'
|
||||||
YES = '👍'
|
YES = '👍'
|
||||||
NO = '👎'
|
NO = '👎'
|
||||||
|
|
||||||
LIKES = {
|
|
||||||
'large': EmojiSize.LARGE,
|
|
||||||
'medium': EmojiSize.MEDIUM,
|
|
||||||
'small': EmojiSize.SMALL,
|
|
||||||
'l': EmojiSize.LARGE,
|
|
||||||
'm': EmojiSize.MEDIUM,
|
|
||||||
's': EmojiSize.SMALL
|
|
||||||
}
|
|
||||||
|
|
||||||
MessageReactionFix = {
|
|
||||||
'😍': ('0001f60d', '%F0%9F%98%8D'),
|
|
||||||
'😆': ('0001f606', '%F0%9F%98%86'),
|
|
||||||
'😮': ('0001f62e', '%F0%9F%98%AE'),
|
|
||||||
'😢': ('0001f622', '%F0%9F%98%A2'),
|
|
||||||
'😠': ('0001f620', '%F0%9F%98%A0'),
|
|
||||||
'👍': ('0001f44d', '%F0%9F%91%8D'),
|
|
||||||
'👎': ('0001f44e', '%F0%9F%91%8E')
|
|
||||||
}
|
|
||||||
|
100
fbchat/utils.py
100
fbchat/utils.py
@@ -9,6 +9,13 @@ import warnings
|
|||||||
import logging
|
import logging
|
||||||
from .models import *
|
from .models import *
|
||||||
|
|
||||||
|
try:
|
||||||
|
from urllib.parse import urlencode
|
||||||
|
basestring = (str, bytes)
|
||||||
|
except ImportError:
|
||||||
|
from urllib import urlencode
|
||||||
|
basestring = basestring
|
||||||
|
|
||||||
# Python 2's `input` executes the input, whereas `raw_input` just returns the input
|
# Python 2's `input` executes the input, whereas `raw_input` just returns the input
|
||||||
try:
|
try:
|
||||||
input = raw_input
|
input = raw_input
|
||||||
@@ -32,6 +39,26 @@ USER_AGENTS = [
|
|||||||
"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.6 (KHTML, like Gecko) Chrome/20.0.1092.0 Safari/536.6"
|
"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.6 (KHTML, like Gecko) Chrome/20.0.1092.0 Safari/536.6"
|
||||||
]
|
]
|
||||||
|
|
||||||
|
LIKES = {
|
||||||
|
'large': EmojiSize.LARGE,
|
||||||
|
'medium': EmojiSize.MEDIUM,
|
||||||
|
'small': EmojiSize.SMALL,
|
||||||
|
'l': EmojiSize.LARGE,
|
||||||
|
'm': EmojiSize.MEDIUM,
|
||||||
|
's': EmojiSize.SMALL
|
||||||
|
}
|
||||||
|
|
||||||
|
MessageReactionFix = {
|
||||||
|
'😍': ('0001f60d', '%F0%9F%98%8D'),
|
||||||
|
'😆': ('0001f606', '%F0%9F%98%86'),
|
||||||
|
'😮': ('0001f62e', '%F0%9F%98%AE'),
|
||||||
|
'😢': ('0001f622', '%F0%9F%98%A2'),
|
||||||
|
'😠': ('0001f620', '%F0%9F%98%A0'),
|
||||||
|
'👍': ('0001f44d', '%F0%9F%91%8D'),
|
||||||
|
'👎': ('0001f44e', '%F0%9F%91%8E')
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
GENDERS = {
|
GENDERS = {
|
||||||
# For standard requests
|
# For standard requests
|
||||||
0: 'unknown',
|
0: 'unknown',
|
||||||
@@ -48,19 +75,18 @@ GENDERS = {
|
|||||||
11: 'unknown_plural',
|
11: 'unknown_plural',
|
||||||
|
|
||||||
# For graphql requests
|
# For graphql requests
|
||||||
#'': 'unknown',
|
'UNKNOWN': 'unknown',
|
||||||
'FEMALE': 'female_singular',
|
'FEMALE': 'female_singular',
|
||||||
'MALE': 'male_singular',
|
'MALE': 'male_singular',
|
||||||
#'': 'female_singular_guess',
|
#'': 'female_singular_guess',
|
||||||
#'': 'male_singular_guess',
|
#'': 'male_singular_guess',
|
||||||
#'': 'mixed',
|
#'': 'mixed',
|
||||||
#'': 'neuter_singular',
|
'NEUTER': 'neuter_singular',
|
||||||
#'': 'unknown_singular',
|
#'': 'unknown_singular',
|
||||||
#'': 'female_plural',
|
#'': 'female_plural',
|
||||||
#'': 'male_plural',
|
#'': 'male_plural',
|
||||||
#'': 'neuter_plural',
|
#'': 'neuter_plural',
|
||||||
#'': 'unknown_plural',
|
#'': 'unknown_plural',
|
||||||
None: None
|
|
||||||
}
|
}
|
||||||
|
|
||||||
class ReqUrl(object):
|
class ReqUrl(object):
|
||||||
@@ -68,7 +94,8 @@ class ReqUrl(object):
|
|||||||
SEARCH = "https://www.facebook.com/ajax/typeahead/search.php"
|
SEARCH = "https://www.facebook.com/ajax/typeahead/search.php"
|
||||||
LOGIN = "https://m.facebook.com/login.php?login_attempt=1"
|
LOGIN = "https://m.facebook.com/login.php?login_attempt=1"
|
||||||
SEND = "https://www.facebook.com/messaging/send/"
|
SEND = "https://www.facebook.com/messaging/send/"
|
||||||
THREAD_SYNC = "https://www.facebook.com/ajax/mercury/thread_sync.php"
|
UNREAD_THREADS = "https://www.facebook.com/ajax/mercury/unread_threads.php"
|
||||||
|
UNSEEN_THREADS = "https://www.facebook.com/mercury/unseen_thread_ids/"
|
||||||
THREADS = "https://www.facebook.com/ajax/mercury/threadlist_info.php"
|
THREADS = "https://www.facebook.com/ajax/mercury/threadlist_info.php"
|
||||||
MESSAGES = "https://www.facebook.com/ajax/mercury/thread_info.php"
|
MESSAGES = "https://www.facebook.com/ajax/mercury/thread_info.php"
|
||||||
READ_STATUS = "https://www.facebook.com/ajax/mercury/change_read_status.php"
|
READ_STATUS = "https://www.facebook.com/ajax/mercury/change_read_status.php"
|
||||||
@@ -92,6 +119,18 @@ class ReqUrl(object):
|
|||||||
MESSAGE_REACTION = "https://www.facebook.com/webgraphql/mutation"
|
MESSAGE_REACTION = "https://www.facebook.com/webgraphql/mutation"
|
||||||
TYPING = "https://www.facebook.com/ajax/messaging/typ.php"
|
TYPING = "https://www.facebook.com/ajax/messaging/typ.php"
|
||||||
GRAPHQL = "https://www.facebook.com/api/graphqlbatch/"
|
GRAPHQL = "https://www.facebook.com/api/graphqlbatch/"
|
||||||
|
ATTACHMENT_PHOTO = "https://www.facebook.com/mercury/attachments/photo/"
|
||||||
|
EVENT_REMINDER = "https://www.facebook.com/ajax/eventreminder/create"
|
||||||
|
|
||||||
|
pull_channel = 0
|
||||||
|
|
||||||
|
def change_pull_channel(self, channel=None):
|
||||||
|
if channel is None:
|
||||||
|
self.pull_channel = (self.pull_channel + 1) % 5 # Pull channel will be 0-4
|
||||||
|
else:
|
||||||
|
self.pull_channel = channel
|
||||||
|
self.STICKY = "https://{}-edge-chat.facebook.com/pull".format(self.pull_channel)
|
||||||
|
self.PING = "https://{}-edge-chat.facebook.com/active_ping".format(self.pull_channel)
|
||||||
|
|
||||||
|
|
||||||
facebookEncoding = 'UTF-8'
|
facebookEncoding = 'UTF-8'
|
||||||
@@ -103,7 +142,7 @@ def strip_to_json(text):
|
|||||||
try:
|
try:
|
||||||
return text[text.index('{'):]
|
return text[text.index('{'):]
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise Exception('No JSON object found: {}, {}'.format(repr(text), text.index('{')))
|
raise FBchatException('No JSON object found: {}, {}'.format(repr(text), text.index('{')))
|
||||||
|
|
||||||
def get_decoded_r(r):
|
def get_decoded_r(r):
|
||||||
return get_decoded(r._content)
|
return get_decoded(r._content)
|
||||||
@@ -111,6 +150,9 @@ def get_decoded_r(r):
|
|||||||
def get_decoded(content):
|
def get_decoded(content):
|
||||||
return content.decode(facebookEncoding)
|
return content.decode(facebookEncoding)
|
||||||
|
|
||||||
|
def parse_json(content):
|
||||||
|
return json.loads(content)
|
||||||
|
|
||||||
def get_json(r):
|
def get_json(r):
|
||||||
return json.loads(strip_to_json(get_decoded_r(r)))
|
return json.loads(strip_to_json(get_decoded_r(r)))
|
||||||
|
|
||||||
@@ -143,31 +185,51 @@ def generateOfflineThreadingID():
|
|||||||
return str(int(msgs, 2))
|
return str(int(msgs, 2))
|
||||||
|
|
||||||
def check_json(j):
|
def check_json(j):
|
||||||
if 'error' in j and j['error'] is not None:
|
if j.get('error') is None:
|
||||||
if 'errorDescription' in j:
|
return
|
||||||
# 'errorDescription' is in the users own language!
|
if 'errorDescription' in j:
|
||||||
raise Exception('Error #{} when sending request: {}'.format(j['error'], j['errorDescription']))
|
# 'errorDescription' is in the users own language!
|
||||||
elif 'debug_info' in j['error']:
|
raise FBchatFacebookError('Error #{} when sending request: {}'.format(j['error'], j['errorDescription']), fb_error_code=j['error'], fb_error_message=j['errorDescription'])
|
||||||
raise Exception('Error #{} when sending request: {}'.format(j['error']['code'], repr(j['error']['debug_info'])))
|
elif 'debug_info' in j['error'] and 'code' in j['error']:
|
||||||
else:
|
raise FBchatFacebookError('Error #{} when sending request: {}'.format(j['error']['code'], repr(j['error']['debug_info'])), fb_error_code=j['error']['code'], fb_error_message=j['error']['debug_info'])
|
||||||
raise Exception('Error {} when sending request'.format(j['error']))
|
else:
|
||||||
|
raise FBchatFacebookError('Error {} when sending request'.format(j['error']), fb_error_code=j['error'])
|
||||||
|
|
||||||
def checkRequest(r, do_json_check=True):
|
def check_request(r, as_json=True):
|
||||||
if not r.ok:
|
if not r.ok:
|
||||||
raise Exception('Error when sending request: Got {} response'.format(r.status_code))
|
raise FBchatFacebookError('Error when sending request: Got {} response'.format(r.status_code), request_status_code=r.status_code)
|
||||||
|
|
||||||
content = get_decoded_r(r)
|
content = get_decoded_r(r)
|
||||||
|
|
||||||
if content is None or len(content) == 0:
|
if content is None or len(content) == 0:
|
||||||
raise Exception('Error when sending request: Got empty response')
|
raise FBchatFacebookError('Error when sending request: Got empty response')
|
||||||
|
|
||||||
if do_json_check:
|
if as_json:
|
||||||
content = strip_to_json(content)
|
content = strip_to_json(content)
|
||||||
try:
|
try:
|
||||||
j = json.loads(content)
|
j = json.loads(content)
|
||||||
except Exception as e:
|
except ValueError:
|
||||||
raise Exception('Error while parsing JSON: {}'.format(repr(content)), e)
|
raise FBchatFacebookError('Error while parsing JSON: {}'.format(repr(content)))
|
||||||
check_json(j)
|
check_json(j)
|
||||||
return j
|
return j
|
||||||
else:
|
else:
|
||||||
return content
|
return content
|
||||||
|
|
||||||
|
def get_jsmods_require(j, index):
|
||||||
|
if j.get('jsmods') and j['jsmods'].get('require'):
|
||||||
|
try:
|
||||||
|
return j['jsmods']['require'][0][index][0]
|
||||||
|
except (KeyError, IndexError) as e:
|
||||||
|
log.warning('Error when getting jsmods_require: {}. Facebook might have changed protocol'.format(j))
|
||||||
|
return None
|
||||||
|
|
||||||
|
def get_emojisize_from_tags(tags):
|
||||||
|
if tags is None:
|
||||||
|
return None
|
||||||
|
tmp = [tag for tag in tags if tag.startswith('hot_emoji_size:')]
|
||||||
|
if len(tmp) > 0:
|
||||||
|
try:
|
||||||
|
return LIKES[tmp[0].split(':')[1]]
|
||||||
|
except (KeyError, IndexError):
|
||||||
|
log.exception('Could not determine emoji size from {} - {}'.format(tags, tmp))
|
||||||
|
return None
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
requests
|
requests
|
||||||
lxml
|
lxml
|
||||||
beautifulsoup4
|
beautifulsoup4
|
||||||
enum34
|
enum34; python_version < '3.4'
|
||||||
|
19
setup.py
19
setup.py
@@ -4,22 +4,24 @@
|
|||||||
"""
|
"""
|
||||||
Setup script for fbchat
|
Setup script for fbchat
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
import os
|
import os
|
||||||
try:
|
try:
|
||||||
from setuptools import setup
|
from setuptools import setup
|
||||||
except ImportError:
|
except ImportError:
|
||||||
from distutils.core import setup
|
from distutils.core import setup
|
||||||
|
|
||||||
|
|
||||||
with open('README.rst') as f:
|
with open('README.rst') as f:
|
||||||
readme_content = f.read().strip()
|
readme_content = f.read().strip()
|
||||||
|
|
||||||
try:
|
requirements = [
|
||||||
requirements = [line.rstrip('\n') for line in open(os.path.join('fbchat.egg-info', 'requires.txt'))]
|
'requests',
|
||||||
except IOError:
|
'lxml',
|
||||||
requirements = [line.rstrip('\n') for line in open('requirements.txt')]
|
'beautifulsoup4'
|
||||||
|
]
|
||||||
|
|
||||||
|
extras_requirements = {
|
||||||
|
':python_version < "3.4"': ['enum34']
|
||||||
|
}
|
||||||
|
|
||||||
version = None
|
version = None
|
||||||
author = None
|
author = None
|
||||||
@@ -52,10 +54,8 @@ setup(
|
|||||||
classifiers=[
|
classifiers=[
|
||||||
'Development Status :: 2 - Pre-Alpha',
|
'Development Status :: 2 - Pre-Alpha',
|
||||||
'Intended Audience :: Developers',
|
'Intended Audience :: Developers',
|
||||||
'Intended Audience :: Developers',
|
|
||||||
'Intended Audience :: Information Technology',
|
'Intended Audience :: Information Technology',
|
||||||
'License :: OSI Approved :: BSD License',
|
'License :: OSI Approved :: BSD License',
|
||||||
'License :: OSI Approved :: BSD License',
|
|
||||||
'Operating System :: OS Independent',
|
'Operating System :: OS Independent',
|
||||||
'Programming Language :: Python :: 2.6',
|
'Programming Language :: Python :: 2.6',
|
||||||
'Programming Language :: Python :: 2.7',
|
'Programming Language :: Python :: 2.7',
|
||||||
@@ -75,6 +75,7 @@ setup(
|
|||||||
include_package_data=True,
|
include_package_data=True,
|
||||||
packages=['fbchat'],
|
packages=['fbchat'],
|
||||||
install_requires=requirements,
|
install_requires=requirements,
|
||||||
|
extras_require=extras_requirements,
|
||||||
url=source,
|
url=source,
|
||||||
version=version,
|
version=version,
|
||||||
zip_safe=True,
|
zip_safe=True,
|
||||||
|
153
tests.py
153
tests.py
@@ -22,6 +22,8 @@ Full documentation on https://fbchat.readthedocs.io/
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
test_sticker_id = '767334476626295'
|
||||||
|
|
||||||
class CustomClient(Client):
|
class CustomClient(Client):
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
self.got_qprimer = False
|
self.got_qprimer = False
|
||||||
@@ -64,16 +66,14 @@ class TestFbchat(unittest.TestCase):
|
|||||||
|
|
||||||
def test_defaultThread(self):
|
def test_defaultThread(self):
|
||||||
# setDefaultThread
|
# setDefaultThread
|
||||||
client.setDefaultThread(group_id, ThreadType.GROUP)
|
for thread in threads:
|
||||||
self.assertTrue(client.sendMessage('test_default_recipient★'))
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
|
self.assertTrue(client.send(Message(text='test_default_recipient★')))
|
||||||
client.setDefaultThread(user_id, ThreadType.USER)
|
|
||||||
self.assertTrue(client.sendMessage('test_default_recipient★'))
|
|
||||||
|
|
||||||
# resetDefaultThread
|
# resetDefaultThread
|
||||||
client.resetDefaultThread()
|
client.resetDefaultThread()
|
||||||
with self.assertRaises(ValueError):
|
with self.assertRaises(ValueError):
|
||||||
client.sendMessage('should_not_send')
|
client.send(Message(text='should_not_send'))
|
||||||
|
|
||||||
def test_fetchAllUsers(self):
|
def test_fetchAllUsers(self):
|
||||||
users = client.fetchAllUsers()
|
users = client.fetchAllUsers()
|
||||||
@@ -96,46 +96,44 @@ class TestFbchat(unittest.TestCase):
|
|||||||
groups = client.searchForGroups('té')
|
groups = client.searchForGroups('té')
|
||||||
self.assertGreater(len(groups), 0)
|
self.assertGreater(len(groups), 0)
|
||||||
|
|
||||||
def test_sendEmoji(self):
|
def test_send(self):
|
||||||
self.assertIsNotNone(client.sendEmoji(size=EmojiSize.SMALL, thread_id=user_id, thread_type=ThreadType.USER))
|
for thread in threads:
|
||||||
self.assertIsNotNone(client.sendEmoji(size=EmojiSize.MEDIUM, thread_id=user_id, thread_type=ThreadType.USER))
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
self.assertIsNotNone(client.sendEmoji('😆', EmojiSize.LARGE, user_id, ThreadType.USER))
|
|
||||||
|
|
||||||
self.assertIsNotNone(client.sendEmoji(size=EmojiSize.SMALL, thread_id=group_id, thread_type=ThreadType.GROUP))
|
self.assertIsNotNone(client.send(Message(emoji_size=EmojiSize.SMALL)))
|
||||||
self.assertIsNotNone(client.sendEmoji(size=EmojiSize.MEDIUM, thread_id=group_id, thread_type=ThreadType.GROUP))
|
self.assertIsNotNone(client.send(Message(emoji_size=EmojiSize.MEDIUM)))
|
||||||
self.assertIsNotNone(client.sendEmoji('😆', EmojiSize.LARGE, group_id, ThreadType.GROUP))
|
self.assertIsNotNone(client.send(Message(text='😆', emoji_size=EmojiSize.LARGE)))
|
||||||
|
|
||||||
def test_sendMessage(self):
|
self.assertIsNotNone(client.send(Message(text='test_send★')))
|
||||||
self.assertIsNotNone(client.sendMessage('test_send_user★', user_id, ThreadType.USER))
|
with self.assertRaises(FBchatFacebookError):
|
||||||
self.assertIsNotNone(client.sendMessage('test_send_group★', group_id, ThreadType.GROUP))
|
self.assertIsNotNone(client.send(Message(text='test_send_should_fail★'), thread_id=thread['id'], thread_type=(ThreadType.GROUP if thread['type'] == ThreadType.USER else ThreadType.USER)))
|
||||||
with self.assertRaises(Exception):
|
|
||||||
client.sendMessage('test_send_user_should_fail★', user_id, ThreadType.GROUP)
|
self.assertIsNotNone(client.send(Message(text='Hi there @user', mentions=[Mention(user_id, offset=9, length=5)])))
|
||||||
with self.assertRaises(Exception):
|
self.assertIsNotNone(client.send(Message(text='Hi there @group', mentions=[Mention(group_id, offset=9, length=6)])))
|
||||||
client.sendMessage('test_send_group_should_fail★', group_id, ThreadType.USER)
|
|
||||||
|
self.assertIsNotNone(client.send(Message(sticker=Sticker(test_sticker_id))))
|
||||||
|
|
||||||
def test_sendImages(self):
|
def test_sendImages(self):
|
||||||
image_url = 'https://cdn4.iconfinder.com/data/icons/ionicons/512/icon-image-128.png'
|
image_url = 'https://cdn4.iconfinder.com/data/icons/ionicons/512/icon-image-128.png'
|
||||||
image_local_url = path.join(path.dirname(__file__), 'tests/image.png')
|
image_local_url = path.join(path.dirname(__file__), 'tests/image.png')
|
||||||
self.assertTrue(client.sendRemoteImage(image_url, 'test_send_user_images_remote★', user_id, ThreadType.USER))
|
for thread in threads:
|
||||||
self.assertTrue(client.sendRemoteImage(image_url, 'test_send_group_images_remote★', group_id, ThreadType.GROUP))
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
self.assertTrue(client.sendLocalImage(image_local_url, 'test_send_group_images_local★', user_id, ThreadType.USER))
|
mentions = [Mention(thread['id'], offset=26, length=4)]
|
||||||
self.assertTrue(client.sendLocalImage(image_local_url, 'test_send_group_images_local★', group_id, ThreadType.GROUP))
|
self.assertTrue(client.sendRemoteImage(image_url, Message(text='test_send_image_remote_to_@you★', mentions=mentions)))
|
||||||
|
self.assertTrue(client.sendLocalImage(image_local_url, Message(text='test_send_image_local_to__@you★', mentions=mentions)))
|
||||||
|
|
||||||
def test_fetchThreadList(self):
|
def test_fetchThreadList(self):
|
||||||
client.fetchThreadList(offset=0, limit=20)
|
threads = client.fetchThreadList(limit=2)
|
||||||
|
self.assertEqual(len(threads), 2)
|
||||||
|
|
||||||
def test_fetchThreadMessages(self):
|
def test_fetchThreadMessages(self):
|
||||||
client.sendMessage('test_user_getThreadInfo★', thread_id=user_id, thread_type=ThreadType.USER)
|
for thread in threads:
|
||||||
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
|
client.send(Message(text='test_getThreadInfo★'))
|
||||||
|
|
||||||
messages = client.fetchThreadMessages(thread_id=user_id, limit=1)
|
messages = client.fetchThreadMessages(limit=1)
|
||||||
self.assertEqual(messages[0].author, client.uid)
|
self.assertEqual(messages[0].author, client.uid)
|
||||||
self.assertEqual(messages[0].text, 'test_user_getThreadInfo★')
|
self.assertEqual(messages[0].text, 'test_getThreadInfo★')
|
||||||
|
|
||||||
client.sendMessage('test_group_getThreadInfo★', thread_id=group_id, thread_type=ThreadType.GROUP)
|
|
||||||
|
|
||||||
messages = client.fetchThreadMessages(thread_id=group_id, limit=1)
|
|
||||||
self.assertEqual(messages[0].author, client.uid)
|
|
||||||
self.assertEqual(messages[0].text, 'test_group_getThreadInfo★')
|
|
||||||
|
|
||||||
def test_listen(self):
|
def test_listen(self):
|
||||||
client.startListening()
|
client.startListening()
|
||||||
@@ -156,48 +154,48 @@ class TestFbchat(unittest.TestCase):
|
|||||||
client.addUsersToGroup(user_id, thread_id=group_id)
|
client.addUsersToGroup(user_id, thread_id=group_id)
|
||||||
|
|
||||||
def test_changeThreadTitle(self):
|
def test_changeThreadTitle(self):
|
||||||
client.changeThreadTitle('test_changeThreadTitle★', thread_id=group_id, thread_type=ThreadType.GROUP)
|
for thread in threads:
|
||||||
client.changeThreadTitle('test_changeThreadTitle★', thread_id=user_id, thread_type=ThreadType.USER)
|
client.changeThreadTitle('test_changeThreadTitle★', thread_id=thread['id'], thread_type=thread['type'])
|
||||||
|
|
||||||
def test_changeNickname(self):
|
def test_changeNickname(self):
|
||||||
client.changeNickname('test_changeNicknameSelf★', client.uid, thread_id=user_id, thread_type=ThreadType.USER)
|
for thread in threads:
|
||||||
client.changeNickname('test_changeNicknameOther★', user_id, thread_id=user_id, thread_type=ThreadType.USER)
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
client.changeNickname('test_changeNicknameSelf★', client.uid, thread_id=group_id, thread_type=ThreadType.GROUP)
|
client.changeNickname('test_changeNicknameSelf★', client.uid)
|
||||||
client.changeNickname('test_changeNicknameOther★', user_id, thread_id=group_id, thread_type=ThreadType.GROUP)
|
client.changeNickname('test_changeNicknameOther★', user_id)
|
||||||
|
|
||||||
def test_changeThreadEmoji(self):
|
def test_changeThreadEmoji(self):
|
||||||
client.changeThreadEmoji('😀', group_id)
|
for thread in threads:
|
||||||
client.changeThreadEmoji('😀', user_id)
|
client.changeThreadEmoji('😀', thread_id=thread['id'])
|
||||||
client.changeThreadEmoji('😆', group_id)
|
client.changeThreadEmoji('😀', thread_id=thread['id'])
|
||||||
client.changeThreadEmoji('😆', user_id)
|
|
||||||
|
|
||||||
def test_changeThreadColor(self):
|
def test_changeThreadColor(self):
|
||||||
client.changeThreadColor(ThreadColor.BRILLIANT_ROSE, group_id)
|
for thread in threads:
|
||||||
client.changeThreadColor(ThreadColor.MESSENGER_BLUE, group_id)
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
client.changeThreadColor(ThreadColor.BRILLIANT_ROSE, user_id)
|
client.changeThreadColor(ThreadColor.BRILLIANT_ROSE)
|
||||||
client.changeThreadColor(ThreadColor.MESSENGER_BLUE, user_id)
|
client.changeThreadColor(ThreadColor.MESSENGER_BLUE)
|
||||||
|
|
||||||
def test_reactToMessage(self):
|
def test_reactToMessage(self):
|
||||||
mid = client.sendMessage('test_reactToMessage★', user_id, ThreadType.USER)
|
for thread in threads:
|
||||||
client.reactToMessage(mid, MessageReaction.LOVE)
|
mid = client.send(Message(text='test_reactToMessage★'), thread_id=thread['id'], thread_type=thread['type'])
|
||||||
mid = client.sendMessage('test_reactToMessage★', group_id, ThreadType.GROUP)
|
client.reactToMessage(mid, MessageReaction.LOVE)
|
||||||
client.reactToMessage(mid, MessageReaction.LOVE)
|
|
||||||
|
|
||||||
def test_setTypingStatus(self):
|
def test_setTypingStatus(self):
|
||||||
client.setTypingStatus(TypingStatus.TYPING, thread_id=user_id, thread_type=ThreadType.USER)
|
for thread in threads:
|
||||||
client.setTypingStatus(TypingStatus.STOPPED, thread_id=user_id, thread_type=ThreadType.USER)
|
client.setDefaultThread(thread_id=thread['id'], thread_type=thread['type'])
|
||||||
client.setTypingStatus(TypingStatus.TYPING, thread_id=group_id, thread_type=ThreadType.GROUP)
|
client.setTypingStatus(TypingStatus.TYPING)
|
||||||
client.setTypingStatus(TypingStatus.STOPPED, thread_id=group_id, thread_type=ThreadType.GROUP)
|
client.setTypingStatus(TypingStatus.STOPPED)
|
||||||
|
|
||||||
|
|
||||||
def start_test(param_client, param_group_id, param_user_id, tests=[]):
|
def start_test(param_client, param_group_id, param_user_id, param_threads, tests=[]):
|
||||||
global client
|
global client
|
||||||
global group_id
|
global group_id
|
||||||
global user_id
|
global user_id
|
||||||
|
global threads
|
||||||
|
|
||||||
client = param_client
|
client = param_client
|
||||||
group_id = param_group_id
|
group_id = param_group_id
|
||||||
user_id = param_user_id
|
user_id = param_user_id
|
||||||
|
threads = param_threads
|
||||||
|
|
||||||
tests = ['test_' + test if 'test_' != test[:5] else test for test in tests]
|
tests = ['test_' + test if 'test_' != test[:5] else test for test in tests]
|
||||||
|
|
||||||
@@ -220,19 +218,44 @@ if __name__ == '__main__':
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
with open(path.join(path.dirname(__file__), 'tests/my_data.json'), 'r') as f:
|
with open(path.join(path.dirname(__file__), 'tests/my_data.json'), 'r') as f:
|
||||||
json = json.load(f)
|
j = json.load(f)
|
||||||
email = json['email']
|
email = j['email']
|
||||||
password = json['password']
|
password = j['password']
|
||||||
user_id = json['user_thread_id']
|
user_id = j['user_thread_id']
|
||||||
group_id = json['group_thread_id']
|
group_id = j['group_thread_id']
|
||||||
|
session = j.get('session')
|
||||||
except (IOError, IndexError) as e:
|
except (IOError, IndexError) as e:
|
||||||
email = input('Email: ')
|
email = input('Email: ')
|
||||||
password = getpass()
|
password = getpass()
|
||||||
group_id = input('Please enter a group thread id (To test group functionality): ')
|
group_id = input('Please enter a group thread id (To test group functionality): ')
|
||||||
user_id = input('Please enter a user thread id (To test kicking/adding functionality): ')
|
user_id = input('Please enter a user thread id (To test kicking/adding functionality): ')
|
||||||
|
threads = [
|
||||||
|
{
|
||||||
|
'id': user_id,
|
||||||
|
'type': ThreadType.USER
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'id': group_id,
|
||||||
|
'type': ThreadType.GROUP
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
print('Logging in...')
|
print('Logging in...')
|
||||||
client = CustomClient(email, password, logging_level=logging_level)
|
client = CustomClient(email, password, logging_level=logging_level, session_cookies=session)
|
||||||
|
|
||||||
# Warning! Taking user input directly like this could be dangerous! Use only for testing purposes!
|
# Warning! Taking user input directly like this could be dangerous! Use only for testing purposes!
|
||||||
start_test(client, group_id, user_id, argv[1:])
|
start_test(client, group_id, user_id, threads, argv[1:])
|
||||||
|
|
||||||
|
with open(path.join(path.dirname(__file__), 'tests/my_data.json'), 'w') as f:
|
||||||
|
session = None
|
||||||
|
try:
|
||||||
|
session = client.getSession()
|
||||||
|
except Exception:
|
||||||
|
print('Unable to fetch client session!')
|
||||||
|
json.dump({
|
||||||
|
'email': email,
|
||||||
|
'password': password,
|
||||||
|
'user_thread_id': user_id,
|
||||||
|
'group_thread_id': group_id,
|
||||||
|
'session': session
|
||||||
|
}, f)
|
||||||
|
Reference in New Issue
Block a user