gryf/slack-backup
1
0
Fork 0
mirror of https://github.com/gryf/slack-backup.git synced 2025-12-17 11:30:25 +01:00
Code Issues Projects Releases Wiki Activity

Small fixes, version bump, alpha stage, added emoji map.

Browse Source
This commit is contained in:
gryf
2016-11-26 17:55:33 +01:00
parent 832b76fc84
commit c79d8ae0e1
6 changed files with 1914 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.rst
View File

@@ -4,9 +4,9 @@ Slack backup
.. image:: https://travis-ci.org/gryf/slack-backup.svg?branch=master
:target: https://travis-ci.org/gryf/slack-backup
This simple project which aim is to collect conversations from Slack using its
API and optionally user account information, and provides convenient way to
represent as a log.
This project aim is to collect conversations from Slack using its API and
optionally user account information, and provides convenient way to represent
as a log.
Requirements
------------
@@ -111,6 +111,33 @@ where:
The rest of the options (``-d`` and ``-v``) have same meaning as in ``fetch``
command.
See help for the ``slack-backup`` command for complete list of options.
Details
-------
During first run, database with provided name is generated. For ease of use
sqlite database is used, although it is easy to switch the engine, since there
is an ORM (SQLAlchemy) used.
Slack users, channels and messages are mapped to SQLAlchemy models, as well as
other information, like:
- user profiles
- channel topic
- channel purpose
- message reactions
- message attachments
- and files
Channels and users are always synchronized in every run, so every modification
to the user or channels are overwriting old data. During first run, all messages
are retrieved for all/selected channels. Every other run will only fetch those
messages, which are older then newest message in the database - so that we don't
loose any old messages, which might be automatically removed from Slack servers.
The drawback of this behaviour is that all past messages which was altered in
the meantime will not be updated.
License
-------

4
setup.py
View File

@@ -7,7 +7,7 @@ from distutils.core import setup
setup(name="slack-backup",
packages=["slack_backup"],
version="0.1",
version="0.2",
description="Make copy of slack converstaions",
author="Roman Dobosz",
author_email="gryf73@gmail.com",
@@ -18,7 +18,7 @@ setup(name="slack-backup",
scripts=["scripts/slack-backup"],
classifiers=["Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.4",
"Development Status :: 2 - Pre-Alpha",
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Intended Audience :: End Users/Desktop",
"License :: OSI Approved :: BSD License",

11
slack_backup/client.py
View File

@@ -146,10 +146,17 @@ class Client(object):
Create message with corresponding possible metadata, like reactions,
files etc.
"""
message = o.Message(data)
message.user = self.q(o.User).\
user = self.q(o.User).\
filter(o.User.slackid == data['user']).one()
if data['type'] == 'message' and not data['text'].strip():
logging.info("Skipping message from `%s' since it's empty",
user.name)
return
message = o.Message(data)
message.channel = channel
message.user = user
if data.get('is_starred'):
message.is_starred = True

2
slack_backup/download.py
View File

@@ -78,7 +78,7 @@ class Download(object):
path = os.path.join(path, fname)
count = 1
while os.path.exists(path):
while filetype != 'avatar' and os.path.exists(path):
base, ext = os.path.splitext(path)
path = base + "%0.3d" % count + ext

1822
slack_backup/emoji.py Normal file
View File

File diff suppressed because it is too large Load Diff

74
slack_backup/reporters.py
View File

@@ -10,9 +10,14 @@ import os
import errno
import logging
import re
try:
from html.parser import HTMLParser
except ImportError:
from HTMLParser import HTMLParser
from slack_backup import objects as o
from slack_backup import utils
from slack_backup import emoji
class Reporter(object):
@@ -40,16 +45,18 @@ class Reporter(object):
'file': '📂',
'topic': '🟅',
'separator': '│'}}
self.emoji = emoji.EMOJI.get(args.theme, {})
self.channels = self._get_channels(args.channels)
self.users = self.q(o.User).all()
self._re_first_idnick = re.compile(r'^(?P<replace>'
r'<@(?P<slackid>U[A-Z,0-9]+)\|.+>)')
self._re_first_id = re.compile('^(?P<replace>'
'<@(?P<slackid>U[A-Z,0-9]+)>)')
self._re_idnick = re.compile(r'.*(?P<replace>'
r'<@(?P<slackid>U[A-Z,0-9]+)\|.+>)')
self._re_id = re.compile('.*(?P<replace><@(?P<slackid>U[A-Z,0-9]+)>)')
self._slackid_pat = [re.compile(r'^(?P<replace>'
r'<@(?P<slackid>U[A-Z,0-9]+)\|.+>)'),
re.compile('^(?P<replace>'
'<@(?P<slackid>U[A-Z,0-9]+)>)'),
re.compile(r'.*(?P<replace>'
r'<@(?P<slackid>U[A-Z,0-9]+)\|.+>)'),
re.compile('.*(?P<replace><@(?P<slackid>'
'U[A-Z,0-9]+)>)')]
def generate(self):
"""Generate raport it's a dummmy one - for use with none reporter"""
@@ -154,11 +161,9 @@ class TextReporter(Reporter):
"""
msg_txt = self._filter_slackid(msg.text)
msg_txt = self._fix_newlines(msg_txt)
for emoticon in self.emoji:
msg_txt = msg_txt.replace(emoticon, self.emoji[emoticon])
formatter = self.types.get(msg.type, self._msg)
if not msg_txt.strip():
logging.info("Skipping message from `%s' since it's empty",
msg.user.name)
return ''
return formatter(msg, msg_txt)
@@ -202,8 +207,9 @@ class TextReporter(Reporter):
def _msg_file(self, msg, text):
"""return formatter for file"""
groups = self._re_first_idnick.match(msg.text).groupdict()
groups = self._slackid_pat[0].match(msg.text).groupdict()
text = msg.text.replace(groups['replace'], '')
text = self._filter_slackid(msg.text)
filename = msg.file.filepath
if filename:
filename = os.path.relpath(msg.file.filepath, start=self.out)
@@ -211,14 +217,18 @@ class TextReporter(Reporter):
filename = msg.file.url
if not filename:
logging.warning("Dude, we have a file object, but nothing has "
"found. Name of the file object is `i%s'",
logging.warning("There is have a file object, but nothing has "
"found. Name of the file object is `%s'",
msg.file.name)
filename = msg.file.name
text = self._filter_slackid(text)
text = self._remove_entities(text)
text = self._fix_newlines(text)
for emoticon in self.emoji:
text = text.replace(emoticon, self.emoji[emoticon])
data = {'date': msg.datetime().strftime("%Y-%m-%d %H:%M:%S"),
'msg': text,
'max_len': self._max_len,
@@ -230,24 +240,40 @@ class TextReporter(Reporter):
'shared file "{filename}"{msg}\n'.format(**data))
def _msg(self, msg, text):
"""return formatter for /me"""
"""return formatter for all other message types"""
data = {'date': msg.datetime().strftime("%Y-%m-%d %H:%M:%S"),
'msg': text,
'max_len': self._max_len,
'separator': self._get_symbol('separator'),
'nick': msg.user.name}
return '{date} {nick:>{max_len}} {separator} {msg}\n'.format(**data)
result = '{date} {nick:>{max_len}} {separator} {msg}\n'.format(**data)
if msg.attachments:
for att in msg.attachments:
if att.title:
att_text = "\n" + att.title + '\n'
else:
att_text = "\n" + self._fix_newlines(att.fallback) + '\n'
if att.text:
att_text += att.text
att_text = self._fix_newlines(att_text)
# remove first newline
att_text = att_text[1:]
result += att_text + '\n'
return result
def _remove_entities(self, text):
"""replace html entites into appropriate chars"""
text = HTMLParser().unescape(text)
def _filter_slackid(self, text):
"""filter out all of the id from slack"""
for pat in (self._re_first_idnick, self._re_first_id):
while pat.search(text):
groups = pat.search(text).groupdict('slackid')
user = [u for u in self.users
if u.slackid == groups['slackid']][0]
text = text.replace(groups['replace'], user.name + ":")
for pat in (self._re_idnick, self._re_id):
for pat in self._slackid_pat:
while pat.search(text):
groups = pat.search(text).groupdict('slackid')
user = [u for u in self.users