This is more text" 20 | "And this is the final text" 21 | ) 22 | document.write_html(5, html) 23 | 24 | path = Path(__file__) / "test_fpdf_ext.pdf" 25 | document.output(str(path)) 26 | 27 | 28 | if __name__ == "__main__": 29 | main() 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Erik Kalkoken 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: 4 | - push 5 | - pull_request 6 | 7 | jobs: 8 | pre-commit: 9 | name: Pre Commit Checks 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@main 15 | 16 | - name: Set up Python 17 | uses: actions/setup-python@v4 18 | with: 19 | python-version: '3.10' 20 | 21 | - name: Run Pre Commit Checks 22 | uses: pre-commit/action@v3.0.0 23 | 24 | pylint: 25 | name: Pylint check 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - name: Checkout 30 | uses: actions/checkout@main 31 | 32 | - name: Set up Python 33 | uses: actions/setup-python@v4 34 | with: 35 | python-version: '3.10' 36 | 37 | - name: Install dependencies 38 | run: | 39 | python -m pip install tox 40 | - name: Test with tox 41 | run: tox -e pylint 42 | 43 | test: 44 | runs-on: ubuntu-latest 45 | strategy: 46 | matrix: 47 | python-version: ['3.8', '3.9', '3.10', '3.11'] 48 | 49 | steps: 50 | - uses: actions/checkout@v3 51 | - name: Set up Python ${{ matrix.python-version }} 52 | uses: actions/setup-python@v4 53 | with: 54 | python-version: ${{ matrix.python-version }} 55 | - name: Install dependencies 56 | run: | 57 | python -m pip install tox tox-gh-actions 58 | - name: Test with tox 59 | run: tox 60 | - name: Upload coverage reports to Codecov 61 | uses: codecov/codecov-action@v3 62 | -------------------------------------------------------------------------------- /slackchannel2pdf/helpers.py: -------------------------------------------------------------------------------- 1 | """Helpers for slackchannel2pdf.""" 2 | 3 | import html 4 | import json 5 | import logging 6 | from pathlib import Path 7 | 8 | logger = logging.getLogger(__name__) 9 | 10 | 11 | def transform_encoding(text: str) -> str: 12 | """adjust encoding to latin-1 and transform HTML entities""" 13 | text2 = html.unescape(text) 14 | text2 = text2.encode("utf-8", "replace").decode("utf-8") 15 | text2 = text2.replace("\t", " ") 16 | return text2 17 | 18 | 19 | def read_array_from_json_file(filepath: Path, quiet=False) -> list: 20 | """reads a json file and returns its contents as array""" 21 | my_file = filepath.parent / (filepath.name + ".json") 22 | if not my_file.is_file: 23 | if quiet is False: 24 | logger.warning("file does not exist: %s", filepath) 25 | arr = [] 26 | else: 27 | try: 28 | with my_file.open("r", encoding="utf-8") as file: 29 | arr = json.load(file) 30 | except IOError: 31 | if quiet is False: 32 | logger.warning("failed to read from %s: ", my_file, exc_info=True) 33 | arr = [] 34 | 35 | return arr 36 | 37 | 38 | def write_array_to_json_file(arr, filepath: Path) -> None: 39 | """writes array to a json file""" 40 | my_file = filepath.parent / (filepath.name + ".json") 41 | logger.info("Writing file: %s", filepath) 42 | try: 43 | with my_file.open("w", encoding="utf-8") as file: 44 | json.dump(arr, file, sort_keys=True, indent=4, ensure_ascii=False) 45 | except IOError: 46 | logger.error("failed to write to %s", my_file, exc_info=True) 47 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["flit_core >=3.2,<4"] 3 | build-backend = "flit_core.buildapi" 4 | 5 | [project] 6 | name = "slackchannel2pdf" 7 | dynamic = ["version", "description"] 8 | readme = "README.md" 9 | license = { file = "LICENSE" } 10 | requires-python = ">=3.8" 11 | authors = [{ name = "Erik Kalkoken", email = "kalkoken87@gmail.com" }] 12 | classifiers = [ 13 | "Environment :: Console", 14 | "Intended Audience :: End Users/Desktop", 15 | "License :: OSI Approved :: MIT License", 16 | "Operating System :: OS Independent", 17 | "Programming Language :: Python", 18 | "Programming Language :: Python :: 3.8", 19 | "Programming Language :: Python :: 3.9", 20 | "Programming Language :: Python :: 3.10", 21 | "Programming Language :: Python :: 3.11", 22 | ] 23 | dependencies = [ 24 | "Babel>=2.9.1", 25 | "python-dateutil>=2.8.0", 26 | "pytz>=2019.1", 27 | "slack_sdk>=3.15.2", 28 | "tzlocal>=2.0.0", 29 | ] 30 | 31 | [project.scripts] 32 | slackchannel2pdf = "slackchannel2pdf.cli:main" 33 | 34 | [project.urls] 35 | Homepage = "https://github.com/ErikKalkoken/slackchannel2pdf" 36 | 37 | [tool.flit.module] 38 | name = "slackchannel2pdf" 39 | 40 | [tool.isort] 41 | profile = "black" 42 | multi_line_output = 3 43 | 44 | [tool.pylint.'MASTER'] 45 | ignore-patterns = ["__init__.py"] 46 | ignore-paths = ["^.*/tests/.*$", "^.*/fpdf_mod/.*$"] 47 | 48 | [tool.pylint.'BASIC'] 49 | good-names = ["i", "j", "k", "ex", "x1", "x2", "x3", "x4", "y1", "y2"] 50 | 51 | [tool.pylint.'FORMAT'] 52 | max-line-length = 120 53 | 54 | 55 | [tool.pylint.'MESSAGES CONTROL'] 56 | disable = [ 57 | "too-many-arguments", 58 | "too-few-public-methods", 59 | "too-many-instance-attributes", 60 | ] 61 | -------------------------------------------------------------------------------- /slackchannel2pdf/fpdf_mod/php.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: latin-1 -*- 3 | 4 | from .py3k import PY3K, basestring, unicode 5 | 6 | # fpdf php helpers: 7 | 8 | 9 | def substr(s, start, length=-1): 10 | if length < 0: 11 | length = len(s) - start 12 | return s[start : start + length] 13 | 14 | 15 | def sprintf(fmt, *args): 16 | return fmt % args 17 | 18 | 19 | def print_r(array): 20 | if not isinstance(array, dict): 21 | array = dict([(k, k) for k in array]) 22 | for k, v in array.items(): 23 | print("[%s] => %s " % (k, v)) 24 | 25 | 26 | def UTF8ToUTF16BE(instr, setbom=True): 27 | "Converts UTF-8 strings to UTF16-BE." 28 | outstr = "".encode() 29 | if setbom: 30 | outstr += "\xFE\xFF".encode("latin1") 31 | if not isinstance(instr, unicode): 32 | instr = instr.decode("UTF-8") 33 | outstr += instr.encode("UTF-16BE") 34 | # convert bytes back to fake unicode string until PEP461-like is implemented 35 | if PY3K: 36 | outstr = outstr.decode("latin1") 37 | return outstr 38 | 39 | 40 | def UTF8StringToArray(instr): 41 | "Converts UTF-8 strings to codepoints array" 42 | return [ord(c) for c in instr] 43 | 44 | 45 | # ttfints php helpers: 46 | 47 | 48 | def die(msg): 49 | raise RuntimeError(msg) 50 | 51 | 52 | def str_repeat(s, count): 53 | return s * count 54 | 55 | 56 | def str_pad(s, pad_length=0, pad_char=" ", pad_type=+1): 57 | if pad_type < 0: # pad left 58 | return s.rjust(pad_length, pad_char) 59 | elif pad_type > 0: # pad right 60 | return s.ljust(pad_length, pad_char) 61 | else: # pad both 62 | return s.center(pad_length, pad_char) 63 | 64 | 65 | strlen = count = lambda s: len(s) 66 | -------------------------------------------------------------------------------- /slackchannel2pdf/slackchannel2pdf.ini: -------------------------------------------------------------------------------- 1 | ;============================================================================== 2 | ; slackchannel2pdf.ini 3 | ;============================================================================== 4 | ; Master configuration file for slackchannel2pdf 5 | ; 6 | ; All setttings in this files are used as defaults unless they are overwritten 7 | ; by a similar configuration file in home or the current working directory 8 | ;============================================================================== 9 | 10 | [pdf] 11 | ; page_orientation can be "portrait" or "landscape" 12 | page_orientation = "portrait" 13 | ; page_format can be "a3", "a4", "a5", "letter" or "legal" 14 | page_format = "a4" 15 | font_size_normal = 12 16 | font_size_large = 14 17 | font_size_small = 10 18 | line_height_default = 6 19 | line_height_small = 2 20 | margin_left = 10 21 | tab_width = 4 22 | 23 | [locale] 24 | ; fallback_locale can be any legal language code 25 | ; will only be used if the app can not determine any default locale from the system 26 | fallback_locale = "en-US" 27 | 28 | [slack] 29 | ; posts from the same user that appear within given minutes will be shown under the 30 | ; header (with user & time) of the first post (same as Slack client) 31 | ; set to 0 to turn off 32 | minutes_until_username_repeats = 10 33 | ; maximum number of messages retrieved from a channel 34 | max_messages_per_channel = 10000 35 | ; max number of items returned from the Slack API per request when paging 36 | ; slack_page_limit must by <= 1000 37 | slack_page_limit = 200 38 | 39 | [logging] 40 | ; log level can be "INFO", "WARN", "ERROR", "CRITICAL" 41 | console_log_level = "WARN" 42 | log_file_enabled = False 43 | ; log file file be written in the current working directory, unless path is defined 44 | # log_file_path = "/path/to" 45 | file_log_level = "INFO" 46 | -------------------------------------------------------------------------------- /slackchannel2pdf/fpdf_mod/py3k.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | "Special module to handle differences between Python 2 and 3 versions" 5 | 6 | import sys 7 | 8 | PY3K = sys.version_info >= (3, 0) 9 | 10 | try: 11 | import cPickle as pickle 12 | except ImportError: 13 | import pickle 14 | 15 | try: 16 | from urllib import urlopen 17 | except ImportError: 18 | from urllib.request import urlopen 19 | 20 | try: 21 | from io import BytesIO 22 | except ImportError: 23 | try: 24 | from cStringIO import StringIO as BytesIO 25 | except ImportError: 26 | from StringIO import StringIO as BytesIO 27 | 28 | try: 29 | from hashlib import md5 30 | except ImportError: 31 | try: 32 | from md5 import md5 33 | except ImportError: 34 | md5 = None 35 | 36 | 37 | def hashpath(fn): 38 | h = md5() 39 | if PY3K: 40 | h.update(fn.encode("UTF-8")) 41 | else: 42 | h.update(fn) 43 | return h.hexdigest() 44 | 45 | 46 | # Check if PIL is available (tries importing both pypi version and corrected or manually installed versions). 47 | # Necessary for JPEG and GIF support. 48 | # TODO: Pillow support 49 | try: 50 | from PIL import Image 51 | except ImportError: 52 | try: 53 | import Image 54 | except ImportError: 55 | Image = None 56 | 57 | try: 58 | from HTMLParser import HTMLParser 59 | except ImportError: 60 | from html.parser import HTMLParser 61 | 62 | if PY3K: 63 | basestring = str 64 | unicode = str 65 | ord = lambda x: x 66 | else: 67 | basestring = basestring 68 | unicode = unicode 69 | ord = ord 70 | 71 | 72 | # shortcut to bytes conversion (b prefix) 73 | def b(s): 74 | if isinstance(s, basestring): 75 | return s.encode("latin1") 76 | elif isinstance(s, int): 77 | if PY3K: 78 | return bytes([s]) # http://bugs.python.org/issue4588 79 | else: 80 | return chr(s) 81 | 82 | 83 | def exception(): 84 | "Return the current the exception instance currently being handled" 85 | # this is needed to support Python 2.5 that lacks "as" syntax 86 | return sys.exc_info()[1] 87 | -------------------------------------------------------------------------------- /tests/test_locales.py: -------------------------------------------------------------------------------- 1 | from unittest import TestCase 2 | from unittest.mock import patch 3 | 4 | from babel import Locale 5 | 6 | from slackchannel2pdf.locales import LocaleHelper 7 | 8 | MODULE_PATH = "slackchannel2pdf.locales" 9 | 10 | 11 | class TestDetermineLocale(TestCase): 12 | def test_should_use_locale_when_provided_1(self): 13 | # given 14 | locale = Locale("en", "US") 15 | # when 16 | result = LocaleHelper._determine_locale(locale) 17 | # then 18 | self.assertEqual(result, locale) 19 | 20 | def test_should_use_locale_when_provided_2(self): 21 | # given 22 | locale = Locale("en", "US") 23 | author_info = {"locale": "de-DE"} 24 | # when 25 | result = LocaleHelper._determine_locale(locale, author_info) 26 | # then 27 | self.assertEqual(result, locale) 28 | 29 | def test_should_use_auth_info(self): 30 | # given 31 | author_info = {"locale": "de-DE"} 32 | # when 33 | result = LocaleHelper._determine_locale(None, author_info) 34 | # then 35 | self.assertEqual(result, Locale("de", "DE")) 36 | 37 | def test_should_return_default_when_nothing_provided(self): 38 | # when 39 | with patch(MODULE_PATH + ".Locale", wraps=Locale) as spy: 40 | LocaleHelper._determine_locale() 41 | # then 42 | self.assertTrue(spy.default.called) 43 | 44 | def test_should_return_default_when_parsing_fails(self): 45 | # given 46 | author_info = {"locale": "xx-yy"} 47 | # when 48 | with patch(MODULE_PATH + ".Locale", wraps=Locale) as spy: 49 | LocaleHelper._determine_locale(None, author_info) 50 | # then 51 | self.assertTrue(spy.default.called) 52 | 53 | def test_should_return_fallback_when_default_fails(self): 54 | # when 55 | with patch(MODULE_PATH + ".settings") as mock_settings: 56 | mock_settings.FALLBACK_LOCALE = "de-DE" 57 | with patch(MODULE_PATH + ".Locale.default") as mock: 58 | mock.side_effect = RuntimeError 59 | result = LocaleHelper._determine_locale() 60 | # then 61 | self.assertEqual(result, Locale("de", "DE")) 62 | -------------------------------------------------------------------------------- /tests/test_helpers.py: -------------------------------------------------------------------------------- 1 | import datetime as dt 2 | import unittest 3 | from unittest.mock import patch 4 | 5 | import babel 6 | import pytz 7 | from tzlocal import get_localzone 8 | 9 | from slackchannel2pdf import helpers 10 | from slackchannel2pdf.locales import LocaleHelper 11 | 12 | 13 | class TestTransformEncoding(unittest.TestCase): 14 | def test_should_transform_special_chars(self): 15 | self.assertEqual(helpers.transform_encoding("special char ✓"), "special char ✓") 16 | self.assertEqual(helpers.transform_encoding("<"), "<") 17 | self.assertEqual(helpers.transform_encoding("<"), "<") 18 | 19 | 20 | class TestLocaleHelper(unittest.TestCase): 21 | def test_should_init_with_defaults(self): 22 | # when 23 | locale_helper = LocaleHelper() 24 | # then 25 | self.assertEqual(locale_helper.locale, babel.Locale.default()) 26 | self.assertEqual(locale_helper.timezone, get_localzone()) 27 | 28 | def test_should_use_given_locale_and_timezone(self): 29 | # given 30 | my_locale = babel.Locale.parse("es-MX", sep="-") 31 | my_tz = pytz.timezone("Asia/Bangkok") 32 | # when 33 | locale_helper = LocaleHelper(my_locale=my_locale, my_tz=my_tz) 34 | # then 35 | self.assertEqual(locale_helper.locale, my_locale) 36 | self.assertEqual(locale_helper.timezone, my_tz) 37 | 38 | def test_should_use_locale_and_timezone_from_slack(self): 39 | # given 40 | author_info = {"locale": "es-MX", "tz": "Asia/Bangkok"} 41 | # when 42 | locale_helper = LocaleHelper(author_info=author_info) 43 | # then 44 | self.assertEqual(locale_helper.locale, babel.Locale.parse("es-MX", sep="-")) 45 | self.assertEqual(locale_helper.timezone, pytz.timezone("Asia/Bangkok")) 46 | 47 | def test_should_use_fallback_timezone_if_none_can_be_determined(self): 48 | # when 49 | with patch("slackchannel2pdf.locales.get_localzone") as mock_get_localzone: 50 | mock_get_localzone.return_value = None 51 | locale_helper = LocaleHelper() 52 | # then 53 | self.assertEqual(locale_helper.timezone, pytz.UTC) 54 | 55 | def test_should_convert_epoch_to_datetime(self): 56 | # given 57 | locale_helper = LocaleHelper() 58 | ts = 1006300923 59 | # when 60 | my_datetime = locale_helper.get_datetime_from_ts(ts) 61 | # then 62 | self.assertEqual(my_datetime.timestamp(), ts) 63 | 64 | def test_should_format_datetime(self): 65 | # given 66 | locale_helper = LocaleHelper(my_locale=babel.Locale.parse("de-DE", sep="-")) 67 | # when 68 | my_datetime = dt.datetime(2021, 2, 3, 18, 10) 69 | result = locale_helper.format_datetime_str(my_datetime) 70 | # then 71 | self.assertEqual(result, "03.02.21, 18:10") 72 | 73 | def test_should_format_epoch(self): 74 | # given 75 | locale_helper = LocaleHelper(my_locale=babel.Locale.parse("de-DE", sep="-")) 76 | # when 77 | my_datetime = dt.datetime(2021, 2, 3, 18, 10) 78 | result = locale_helper.get_datetime_formatted_str(my_datetime.timestamp()) 79 | # then 80 | self.assertEqual(result, "03.02.21, 18:10") 81 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](http://keepachangelog.com/) 6 | and this project adheres to [Semantic Versioning](http://semver.org/). 7 | 8 | ## [Unreleased] - yyyy-mm-dd 9 | 10 | ## [1.5.2] - 2023-09-06 11 | 12 | ### Fixed 13 | 14 | - ModuleNotFoundError: No module named 'fpdf_mod' (#25) 15 | 16 | ## [1.5.1] - 2023-09-03 17 | 18 | ### Fixed 19 | 20 | - Locale.default() breaks with exception on Windows (#20) 21 | - Typo in latin-1 encoding (#18) 22 | - KeyError: 'team' (#17) 23 | 24 | ## [1.5.0] - 2023-09-03 25 | 26 | ### Added 27 | 28 | - Added support for Python 3.11 29 | - Add GH actions for test and release 30 | - Add pylint checks to CI pipeline 31 | 32 | ### Changed 33 | 34 | - Consolidated tests.helper package into module 35 | - Migrate build process to PEP 621 36 | - Removed support for Python 3.7 37 | - Remove TEST mode 38 | 39 | ## [1.4.0] - 2022-04-04 40 | 41 | ### Changed 42 | 43 | - Upgraded to new Slack library (slack_sdk) 44 | - Removed Python 3.7 from CI pipeline 45 | - Added Python 3.10 to CI pipeline 46 | - Rate limits are now handled by the slack_sdk library (#7) 47 | - Include tests in distribution package on PyPI 48 | 49 | ## [1.3.1] - 2021-02-21 50 | 51 | ### Fixed 52 | 53 | - Security issue with outdated Babel version 54 | 55 | ## [1.3.0] - 2021-02-21 56 | 57 | ### Added 58 | 59 | - Configuration files now allow users to configure defaults (e.g. page format) 60 | - New command line argument "quiet" to turn off console output 61 | - A log file will now be written in the current working directory (can be disabled by through configuration) 62 | - Now officially supports Python 3.8 & Python 3.9 63 | 64 | ### Changed 65 | 66 | - Console will no longer show detailed infos by default (but can be re-enabled by setting console log level to INFO) 67 | - Console output streamlined to better work with console logger 68 | - Program now exists with a non zero value if an error occurred 69 | - API errors returned from Slack now shown in a more user friendly format 70 | - Now logs an error instead of aborting when failing to generate a message due to nested S-tags 71 | 72 | ## [1.2.4] - 2021-02-04 73 | 74 | ### Fixed 75 | 76 | - Shows date & time on thread replies 77 | 78 | ## [1.2.3] - 2021-02-04 79 | 80 | ### Added 81 | 82 | - Ability to add a logfile 83 | 84 | ### Changed 85 | 86 | - Replaced print statements with logger 87 | - No uses `Pathlib` for better cross platform compatibility 88 | 89 | ### Fixed 90 | 91 | - 'NoneType' object has no attribute 'decimal_formats' 92 | 93 | ## [1.2.2] - 2021-02-03 94 | 95 | ### Fixed 96 | 97 | - 'NoneType' object has no attribute 'get_display_name' 98 | 99 | ## [1.2.1] - 2021-02-03 100 | 101 | ### Fixed 102 | 103 | - Missing timestamp for posts in thread [#5](https://github.com/ErikKalkoken/slackchannel2pdf/issues/5) 104 | 105 | ## [1.2.0] - 2021-02-02 106 | 107 | ### Changed 108 | 109 | - Major refactoring 110 | - Now also uses paging to fetch list of users 111 | 112 | ### Fixed 113 | 114 | - Works with general and random but not other channels [#4](https://github.com/ErikKalkoken/slackchannel2pdf/issues/4) 115 | 116 | ## [1.1.4] - 2020-12-07 117 | 118 | ### Changed 119 | 120 | - Improved test coverage 121 | 122 | ### Fixed 123 | 124 | - Error 'pretty type' - cant' export slack channel to pdf [#3](https://github.com/ErikKalkoken/slackchannel2pdf/issues/3) 125 | 126 | ## [1.1.3] - 2020-11-27 127 | 128 | ### Changed 129 | 130 | - Now using Black for code styling 131 | 132 | ### Fixed 133 | 134 | - Can not create PDF file on windows if team name contains characters not valid for file names, i.e. `<>:"/\|?*` 135 | 136 | ## [1.1.2] - 2020-04-01 137 | 138 | ### Fixed 139 | 140 | - Installation from PyPI does not work probably 141 | 142 | ## [1.1.1] - 2020-04-01 143 | 144 | ### Added 145 | 146 | - Technical improvements (flake8 compliance) 147 | 148 | ## [1.1.0] - 2020-04-01 149 | 150 | ### Added 151 | 152 | - You can now run the tool from shell after pip install 153 | - Added description of installation options 154 | 155 | ## [1.0.0] - 2019-08-05 156 | 157 | ### Added 158 | 159 | - Initial release 160 | -------------------------------------------------------------------------------- /slackchannel2pdf/locales.py: -------------------------------------------------------------------------------- 1 | """Locales for slackchannel2pdf.""" 2 | 3 | import datetime as dt 4 | import logging 5 | from typing import Optional 6 | 7 | import pytz 8 | from babel import Locale, UnknownLocaleError 9 | from babel.dates import format_date, format_datetime, format_time 10 | from tzlocal import get_localzone 11 | 12 | from . import settings 13 | 14 | logger = logging.getLogger(__name__) 15 | 16 | 17 | class LocaleHelper: 18 | """Helpers for converting date & time according to current locale and timezone""" 19 | 20 | def __init__( 21 | self, 22 | my_locale: Optional[Locale] = None, 23 | my_tz: Optional[pytz.BaseTzInfo] = None, 24 | author_info: Optional[dict] = None, 25 | ) -> None: 26 | """ 27 | Args: 28 | - my_locale: Primary locale to use 29 | - my_tz: Primary timezone to use 30 | - author_info: locale and timezone to use from this Slack response 31 | if my_locale and/or my_tz are not given 32 | """ 33 | self._locale = self._determine_locale(my_locale, author_info) 34 | self._timezone = self._determine_timezone(my_tz, author_info) 35 | 36 | @staticmethod 37 | def _determine_locale( 38 | my_locale: Optional[Locale] = None, author_info: Optional[dict] = None 39 | ) -> Locale: 40 | if my_locale: 41 | if not isinstance(my_locale, Locale): 42 | raise TypeError("my_locale must be a babel Locale object") 43 | return my_locale 44 | 45 | if author_info: 46 | try: 47 | return Locale.parse(author_info["locale"], sep="-") 48 | except UnknownLocaleError: 49 | logger.warning("Could not use locale info from Slack.") 50 | my_locale = None 51 | 52 | try: 53 | return Locale.default() 54 | except Exception: # pylint: disable = broad-exception-caught 55 | return Locale.parse(settings.FALLBACK_LOCALE, sep="-") 56 | 57 | @staticmethod 58 | def _determine_timezone( 59 | my_tz: Optional[pytz.BaseTzInfo] = None, author_info: Optional[dict] = None 60 | ) -> pytz.BaseTzInfo: 61 | if my_tz: 62 | if not isinstance(my_tz, pytz.BaseTzInfo): 63 | raise TypeError("my_tz must be of type pytz") 64 | else: 65 | if author_info: 66 | try: 67 | my_tz = pytz.timezone(author_info["tz"]) 68 | except pytz.exceptions.UnknownTimeZoneError: 69 | logger.warning("Could not use timezone info from Slack") 70 | my_tz = get_localzone() 71 | else: 72 | my_tz = get_localzone() 73 | if not my_tz: 74 | my_tz = pytz.UTC 75 | return my_tz 76 | 77 | @property 78 | def locale(self) -> Locale: 79 | """Return locale.""" 80 | return self._locale 81 | 82 | @property 83 | def timezone(self) -> pytz.BaseTzInfo: 84 | """Return timezone.""" 85 | return self._timezone 86 | 87 | def format_date_full_str(self, my_datetime: dt.datetime) -> str: 88 | """Return all full formatted date.""" 89 | return format_date(my_datetime, format="full", locale=self.locale) 90 | 91 | def format_datetime_str(self, my_datetime: dt.datetime) -> str: 92 | """Return formatted datetime string for given dt using locale.""" 93 | return format_datetime(my_datetime, format="short", locale=self.locale) 94 | 95 | def get_datetime_formatted_str(self, timestamp: float) -> str: 96 | """Return given timestamp as formatted datetime string using locale.""" 97 | my_datetime = self.get_datetime_from_ts(timestamp) 98 | return format_datetime(my_datetime, format="short", locale=self.locale) 99 | 100 | def get_time_formatted_str(self, timestamp: float) -> str: 101 | """Return given timestamp as formatted datetime string using locale.""" 102 | my_datetime = self.get_datetime_from_ts(timestamp) 103 | return format_time(my_datetime, format="short", locale=self.locale) 104 | 105 | def get_datetime_from_ts(self, timestamp: float) -> dt.datetime: 106 | """Return datetime object of a unix timestamp with local timezone.""" 107 | my_datetime = dt.datetime.fromtimestamp(float(timestamp), pytz.UTC) 108 | return my_datetime.astimezone(self.timezone) 109 | -------------------------------------------------------------------------------- /slackchannel2pdf/settings.py: -------------------------------------------------------------------------------- 1 | """Global settings incl. from configuration files for slackchannel2pdf.""" 2 | 3 | # pylint: disable = no-member 4 | 5 | import configparser 6 | from ast import literal_eval 7 | from pathlib import Path 8 | from typing import Optional 9 | 10 | _FILE_NAME_BASE = "slackchannel2pdf" 11 | _CONF_FILE_NAME = f"{_FILE_NAME_BASE}.ini" 12 | _LOG_FILE_NAME = f"{_FILE_NAME_BASE}.log" 13 | 14 | _DEFAULTS_PATH = Path(__file__).parent 15 | 16 | 17 | def _configparser_convert_str(value): 18 | result = literal_eval(value) 19 | if not isinstance(result, str): 20 | raise configparser.ParsingError(f"Needs to be a string type: {value}") 21 | return result 22 | 23 | 24 | def config_parser( 25 | defaults_path: Path, 26 | home_path: Optional[Path] = None, 27 | cwd_path: Optional[Path] = None, 28 | ) -> configparser.ConfigParser: 29 | """Load and parse config from file and return it.""" 30 | parser = configparser.ConfigParser(converters={"str": _configparser_convert_str}) 31 | config_file_paths = [defaults_path / _CONF_FILE_NAME] 32 | if home_path: 33 | config_file_paths.append(home_path / _CONF_FILE_NAME) 34 | if cwd_path: 35 | config_file_paths.append(cwd_path / _CONF_FILE_NAME) 36 | found = parser.read(config_file_paths) 37 | if not found: 38 | raise RuntimeError("Can not find a configuration file anywhere") 39 | return parser 40 | 41 | 42 | _my_config = config_parser( 43 | defaults_path=_DEFAULTS_PATH, home_path=Path.home(), cwd_path=Path.cwd() 44 | ) 45 | 46 | # style and layout settings for PDF 47 | PAGE_UNITS_DEFAULT = "mm" 48 | FONT_FAMILY_DEFAULT = "NotoSans" 49 | FONT_FAMILY_MONO_DEFAULT = "NotoSansMono" 50 | 51 | PAGE_ORIENTATION_DEFAULT = _my_config.getstr("pdf", "page_orientation") # type: ignore 52 | PAGE_FORMAT_DEFAULT = _my_config.getstr("pdf", "page_format") # type: ignore 53 | FONT_SIZE_NORMAL = _my_config.getint("pdf", "font_size_normal") 54 | FONT_SIZE_LARGE = _my_config.getint("pdf", "font_size_large") 55 | FONT_SIZE_SMALL = _my_config.getint("pdf", "font_size_small") 56 | LINE_HEIGHT_DEFAULT = _my_config.getint("pdf", "line_height_default") 57 | LINE_HEIGHT_SMALL = _my_config.getint("pdf", "line_height_small") 58 | MARGIN_LEFT = _my_config.getint("pdf", "margin_left") 59 | TAB_WIDTH = _my_config.getint("pdf", "tab_width") 60 | 61 | # locale 62 | FALLBACK_LOCALE = _my_config.getstr("locale", "fallback_locale") # type: ignore 63 | 64 | # slack 65 | MINUTES_UNTIL_USERNAME_REPEATS = _my_config.getint( 66 | "slack", "minutes_until_username_repeats" 67 | ) 68 | MAX_MESSAGES_PER_CHANNEL = _my_config.getint("slack", "max_messages_per_channel") 69 | SLACK_PAGE_LIMIT = _my_config.getint("slack", "slack_page_limit") 70 | 71 | 72 | def _setup_logging(config: configparser.ConfigParser) -> dict: 73 | config_logging = { 74 | "version": 1, 75 | "disable_existing_loggers": False, 76 | "formatters": { 77 | "console": {"format": "[%(levelname)s] %(message)s"}, 78 | "file": {"format": "%(asctime)s [%(levelname)s] %(name)s: %(message)s"}, 79 | }, 80 | "handlers": { 81 | "console": { 82 | "level": config.getstr("logging", "console_log_level"), # type: ignore 83 | "formatter": "console", 84 | "class": "logging.StreamHandler", 85 | "stream": "ext://sys.stdout", # Default is stderr 86 | } 87 | }, 88 | "loggers": { 89 | "": { # root logger 90 | "handlers": ["console"], 91 | "level": "DEBUG", 92 | "propagate": False, 93 | }, 94 | }, 95 | } 96 | 97 | # add log file if configured 98 | log_file_enabled = config.getboolean("logging", "log_file_enabled", fallback=False) 99 | if log_file_enabled: 100 | file_log_path_full = config.getstr("logging", "log_file_path", fallback=None) # type: ignore 101 | filename = ( 102 | Path(file_log_path_full) / _LOG_FILE_NAME 103 | if file_log_path_full 104 | else _LOG_FILE_NAME 105 | ) 106 | config_logging["handlers"]["file"] = { 107 | "level": config.getstr("logging", "file_log_level"), # type: ignore 108 | "formatter": "file", 109 | "class": "logging.FileHandler", 110 | "filename": filename, 111 | "mode": "a", 112 | } 113 | config_logging["loggers"][""]["handlers"].append("file") 114 | return config_logging 115 | 116 | 117 | DEFAULT_LOGGING = _setup_logging(_my_config) 118 | -------------------------------------------------------------------------------- /slackchannel2pdf/fonts/LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2018 The Noto Project Authors (github.com/googlei18n/noto-fonts) 2 | 3 | This Font Software is licensed under the SIL Open Font License, 4 | Version 1.1. 5 | 6 | This license is copied below, and is also available with a FAQ at: 7 | http://scripts.sil.org/OFL 8 | 9 | ----------------------------------------------------------- 10 | SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 11 | ----------------------------------------------------------- 12 | 13 | PREAMBLE 14 | The goals of the Open Font License (OFL) are to stimulate worldwide 15 | development of collaborative font projects, to support the font 16 | creation efforts of academic and linguistic communities, and to 17 | provide a free and open framework in which fonts may be shared and 18 | improved in partnership with others. 19 | 20 | The OFL allows the licensed fonts to be used, studied, modified and 21 | redistributed freely as long as they are not sold by themselves. The 22 | fonts, including any derivative works, can be bundled, embedded, 23 | redistributed and/or sold with any software provided that any reserved 24 | names are not used by derivative works. The fonts and derivatives, 25 | however, cannot be released under any other type of license. The 26 | requirement for fonts to remain under this license does not apply to 27 | any document created using the fonts or their derivatives. 28 | 29 | DEFINITIONS 30 | "Font Software" refers to the set of files released by the Copyright 31 | Holder(s) under this license and clearly marked as such. This may 32 | include source files, build scripts and documentation. 33 | 34 | "Reserved Font Name" refers to any names specified as such after the 35 | copyright statement(s). 36 | 37 | "Original Version" refers to the collection of Font Software 38 | components as distributed by the Copyright Holder(s). 39 | 40 | "Modified Version" refers to any derivative made by adding to, 41 | deleting, or substituting -- in part or in whole -- any of the 42 | components of the Original Version, by changing formats or by porting 43 | the Font Software to a new environment. 44 | 45 | "Author" refers to any designer, engineer, programmer, technical 46 | writer or other person who contributed to the Font Software. 47 | 48 | PERMISSION & CONDITIONS 49 | Permission is hereby granted, free of charge, to any person obtaining 50 | a copy of the Font Software, to use, study, copy, merge, embed, 51 | modify, redistribute, and sell modified and unmodified copies of the 52 | Font Software, subject to the following conditions: 53 | 54 | 1) Neither the Font Software nor any of its individual components, in 55 | Original or Modified Versions, may be sold by itself. 56 | 57 | 2) Original or Modified Versions of the Font Software may be bundled, 58 | redistributed and/or sold with any software, provided that each copy 59 | contains the above copyright notice and this license. These can be 60 | included either as stand-alone text files, human-readable headers or 61 | in the appropriate machine-readable metadata fields within text or 62 | binary files as long as those fields can be easily viewed by the user. 63 | 64 | 3) No Modified Version of the Font Software may use the Reserved Font 65 | Name(s) unless explicit written permission is granted by the 66 | corresponding Copyright Holder. This restriction only applies to the 67 | primary font name as presented to the users. 68 | 69 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font 70 | Software shall not be used to promote, endorse or advertise any 71 | Modified Version, except to acknowledge the contribution(s) of the 72 | Copyright Holder(s) and the Author(s) or with their explicit written 73 | permission. 74 | 75 | 5) The Font Software, modified or unmodified, in part or in whole, 76 | must be distributed entirely under this license, and must not be 77 | distributed under any other license. The requirement for fonts to 78 | remain under this license does not apply to any document created using 79 | the Font Software. 80 | 81 | TERMINATION 82 | This license becomes null and void if any of the above conditions are 83 | not met. 84 | 85 | DISCLAIMER 86 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 87 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF 88 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 89 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE 90 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 91 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL 92 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 93 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM 94 | OTHER DEALINGS IN THE FONT SOFTWARE. 95 | -------------------------------------------------------------------------------- /tests/helpers.py: -------------------------------------------------------------------------------- 1 | import json 2 | import socket 3 | from pathlib import Path 4 | from unittest import TestCase 5 | 6 | 7 | class SocketAccessError(Exception): 8 | pass 9 | 10 | 11 | class NoSocketsTestCase(TestCase): 12 | """Enhancement of TestCase class that prevents any use of sockets 13 | 14 | Will throw the exception SocketAccessError when any code tries to 15 | access network sockets 16 | """ 17 | 18 | @classmethod 19 | def setUpClass(cls): 20 | cls.socket_original = socket.socket 21 | socket.socket = cls.guard 22 | return super().setUpClass() 23 | 24 | @classmethod 25 | def tearDownClass(cls): 26 | socket.socket = cls.socket_original 27 | return super().tearDownClass() 28 | 29 | @staticmethod 30 | def guard(*args, **kwargs): 31 | raise SocketAccessError("Attempted to access network") 32 | 33 | 34 | def chunks(lst, size): 35 | """Yield successive sized chunks from lst.""" 36 | for i in range(0, len(lst), size): 37 | yield lst[i : i + size] 38 | 39 | 40 | def slack_response(data: dict, ok: bool = True, error: str = None) -> str: 41 | if not ok: 42 | return {"ok": False, **{"error": error}} 43 | else: 44 | return {"ok": True, **data} 45 | 46 | 47 | class SlackResponseStub: 48 | def __init__(self, data, ok=True) -> None: 49 | self.data = slack_response(data, ok) 50 | 51 | 52 | class SlackClientStub: 53 | def __init__(self, team: str, page_size: int = None) -> None: 54 | self._team = str(team) 55 | self._page_size = int(page_size) if page_size else None 56 | self._page_counts = {"conversations_list": 0} 57 | path = Path(__file__).parent / "slack_data.json" 58 | with path.open("r", encoding="utf-8") as f: 59 | self._slack_data = json.load(f) 60 | 61 | def _paging(self, data, key, cursor=None) -> str: 62 | if not self._page_size: 63 | return slack_response({key: data}) 64 | else: 65 | data_chunks = list(chunks(data, self._page_size)) 66 | if cursor is None: 67 | cursor = 0 68 | 69 | response = {key: data_chunks[cursor]} 70 | if len(data_chunks) > cursor + 1: 71 | response["response_metadata"] = {"next_cursor": cursor + 1} 72 | 73 | return slack_response(response) 74 | 75 | def auth_test(self) -> str: 76 | return SlackResponseStub(self._slack_data[self._team]["auth_test"]) 77 | 78 | def bots_info(self, bot) -> str: 79 | return slack_response({}, ok=False) 80 | 81 | def conversations_replies( 82 | self, channel, ts, limit=None, oldest=None, latest=None, cursor=None 83 | ) -> str: 84 | if ( 85 | channel in self._slack_data[self._team]["conversations_replies"] 86 | and ts in self._slack_data[self._team]["conversations_replies"][channel] 87 | ): 88 | messages = self._slack_data[self._team]["conversations_replies"][channel][ 89 | ts 90 | ] 91 | return slack_response(self._messages_to_response(messages)) 92 | else: 93 | return slack_response(None, ok=False, error="Thread not found") 94 | 95 | def conversations_history( 96 | self, channel, limit=None, oldest=None, latest=None, cursor=None 97 | ) -> str: 98 | if channel in self._slack_data[self._team]["conversations_history"]: 99 | messages = self._slack_data[self._team]["conversations_history"][channel] 100 | return self._paging(messages, "messages", cursor) 101 | else: 102 | return slack_response(None, ok=False, error="Channel not found") 103 | 104 | @staticmethod 105 | def _messages_to_response(messages: list) -> dict: 106 | return {"messages": messages, "has_more": False} 107 | 108 | def conversations_list(self, types, limit=None, cursor=None) -> str: 109 | return self._paging( 110 | self._slack_data[self._team]["conversations_list"]["channels"], 111 | "channels", 112 | cursor, 113 | ) 114 | 115 | def users_info(self, user, include_locale=None) -> str: 116 | users = { 117 | obj["id"]: obj 118 | for obj in self._slack_data[self._team]["users_list"]["members"] 119 | } 120 | if user in users: 121 | return slack_response({"user": users[user]}) 122 | else: 123 | return slack_response(None, ok=False, error="User not found") 124 | 125 | def users_list(self, limit=None) -> str: 126 | return slack_response(self._slack_data[self._team]["users_list"]) 127 | 128 | def usergroups_list(self) -> str: 129 | return slack_response(self._slack_data[self._team]["usergroups_list"]) 130 | -------------------------------------------------------------------------------- /slackchannel2pdf/message_transformer.py: -------------------------------------------------------------------------------- 1 | """Slack message transformers for slackchannel2pdf.""" 2 | 3 | import re 4 | 5 | from .helpers import transform_encoding 6 | from .locales import LocaleHelper 7 | from .slack_service import SlackService 8 | 9 | 10 | class MessageTransformer: 11 | """A class for parsing and transforming Slack messages.""" 12 | 13 | def __init__( 14 | self, 15 | slack_service: SlackService, 16 | locale_helper: LocaleHelper, 17 | font_family_mono_default: str, 18 | ) -> None: 19 | self._slack_service = slack_service 20 | self._locale_helper = locale_helper 21 | self._font_family_mono_default = font_family_mono_default 22 | 23 | def transform_text(self, text: str, use_mrkdwn: bool = False) -> str: 24 | """Transform mrkdwn text into HTML text for PDF output. 25 | 26 | Main method to resolve all mrkdwn, e.g.
\1", result, 0, re.MULTILINE 61 | ) 62 | result = result.replace("