├── .gitignore ├── tests ├── data │ ├── t2m_a1@mamot.fr_creds.txt │ ├── t2m_a2@mamot.fr_creds.txt │ ├── media1.txt │ ├── media2.txt │ └── conf.yaml └── test_t2m.py ├── dev-requirements.txt ├── setup.cfg ├── t2m ├── retweet.tmpl └── __init__.py ├── .travis.yml ├── tox.ini ├── setup.py ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .tox/ 2 | -------------------------------------------------------------------------------- /tests/data/t2m_a1@mamot.fr_creds.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/data/t2m_a2@mamot.fr_creds.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /dev-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest 2 | mock 3 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [bdist_wheel] 2 | universal=1 3 | -------------------------------------------------------------------------------- /tests/data/media1.txt: -------------------------------------------------------------------------------- 1 | media1 content 2 | -------------------------------------------------------------------------------- /tests/data/media2.txt: -------------------------------------------------------------------------------- 1 | media2 content 2 | -------------------------------------------------------------------------------- /t2m/retweet.tmpl: -------------------------------------------------------------------------------- 1 | « %(text)s » 2 | 3 | — Retweet https://twitter.com/%(user)s/status/%(id)s -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: python 3 | python: 4 | - 2.7 5 | - 3.4 6 | - 3.5 7 | - 3.6 8 | install: pip install tox-travis 9 | script: tox 10 | -------------------------------------------------------------------------------- /tests/data/conf.yaml: -------------------------------------------------------------------------------- 1 | consumer_key: fake_consumer_key 2 | consumer_secret: fake_consumer_secret 3 | access_token_key: fake_access_token_key 4 | access_token_secret: fake_access_token_secret 5 | 6 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27,py34,py35,py36,flake8 3 | skip_missing_interpreters=true 4 | 5 | [testenv] 6 | deps = -rdev-requirements.txt 7 | commands = pytest 8 | 9 | [testenv:flake8] 10 | skip_install = true 11 | whitelist_externals = flake8 12 | deps = 13 | flake8 14 | commands = flake8 --exclude=ve,ve3,.tox 15 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """A setuptools based setup module for t2m 2 | 3 | See: 4 | https://packaging.python.org/en/latest/distributing.html 5 | https://github.com/pypa/sampleproject 6 | """ 7 | 8 | # Always prefer setuptools over distutils 9 | from setuptools import setup, find_packages 10 | # To use a consistent encoding 11 | from codecs import open 12 | from os import path 13 | 14 | here = path.abspath(path.dirname(__file__)) 15 | 16 | # Get the long description from the README file 17 | with open(path.join(here, 'README.md'), encoding='utf-8') as f: 18 | long_description = f.read() 19 | 20 | setup( 21 | name='t2m', 22 | 23 | # Versions should comply with PEP440. For a discussion on single-sourcing 24 | # the version across setup.py and the project code, see 25 | # https://packaging.python.org/en/latest/single_source_version.html 26 | version='0.1.0', 27 | 28 | description='Twitter to Mastodon timeline forwarding tool', 29 | long_description=long_description, 30 | 31 | # The project's main homepage. 32 | url='https://github.com/Psycojoker/t2m', 33 | 34 | # Author details 35 | author='Laurent Peuch and al.', 36 | author_email='cortex@worlddomination.be', 37 | 38 | # Choose your license 39 | license='GPLv3', 40 | 41 | # See https://pypi.python.org/pypi?%3Aaction=list_classifiers 42 | classifiers=[ 43 | 'Development Status :: 3 - Alpha', 44 | 'Intended Audience :: Other Audience', 45 | 'Environment :: Console', 46 | 'Topic :: Communications', 47 | 'Topic :: Utilities', 48 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 49 | 'Programming Language :: Python :: 2', 50 | 'Programming Language :: Python :: 2.7', 51 | 'Programming Language :: Python :: 3', 52 | 'Programming Language :: Python :: 3.5', 53 | ], 54 | 55 | # What does your project relate to? 56 | keywords='mastodon twitter bot robot', 57 | 58 | # You can just specify the packages manually here if your project is 59 | # simple. Or you can use find_packages(). 60 | packages=find_packages(exclude=['tests']), 61 | 62 | # Alternatively, if you want to distribute just a my_module.py, uncomment 63 | # this: 64 | # py_modules=["my_module"], 65 | 66 | # List run-time dependencies here. These will be installed by pip when 67 | # your project is installed. For an analysis of "install_requires" vs pip's 68 | # requirements files see: 69 | # https://packaging.python.org/en/latest/requirements.html 70 | install_requires=[ 71 | 'Mastodon.py', 72 | 'python-twitter', 73 | 'requests', 74 | 'pyyaml', 75 | 'argh', 76 | ], 77 | 78 | # List additional groups of dependencies here (e.g. development 79 | # dependencies). You can install these using the following syntax, 80 | # for example: 81 | # $ pip install -e .[dev,test] 82 | extras_require={ 83 | }, 84 | 85 | # If there are data files included in your packages that need to be 86 | # installed, specify them here. If using Python 2.6 or less, then these 87 | # have to be included in MANIFEST.in as well. 88 | package_data={ 89 | 't2m': ['retweet.tmpl'], 90 | }, 91 | 92 | # Although 'package_data' is the preferred approach, in some case you may 93 | # need to place data files outside of your packages. See: 94 | # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa 95 | # In this case, 'data_file' will be installed into '/my_data' 96 | data_files=[ # ('my_data', ['data/data_file'])], 97 | ('', ['LICENSE', 'README.md']), 98 | ], 99 | 100 | # To provide executable scripts, use entry points in preference to the 101 | # "scripts" keyword. Entry points provide cross-platform support and allow 102 | # pip to create the appropriate form of executable for the target platform. 103 | entry_points={ 104 | 'console_scripts': [ 105 | 't2m=t2m:main', 106 | ], 107 | }, 108 | ) 109 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # t2m - Twitter 2 Mastodon 2 | 3 | A script to manage the forwarding of tweets from Twitter accounts to a Mastodon one. 4 | 5 | [![Build Status](https://travis-ci.org/YoloSwagTeam/t2m.svg)](https://travis-ci.org/YoloSwagTeam/t2m) 6 | 7 | # Installation 8 | 9 | Using pip: 10 | 11 | pip install t2m 12 | 13 | Alternatively from source, on debian/ubuntu: 14 | 15 | sudo apt-get install python-virtualenv 16 | 17 | virtualenv ve 18 | source ve/bin/activate 19 | 20 | # if you run with an old version of python 2.7 (Ubuntu 14.04 for example) 21 | # you'll need to run those, otherwise requests will break because it won't 22 | # be able to correctly verify the host of the https issuer 23 | # if you use python 3 you can ignore that 24 | pip install pyopenssl ndg-httpsclient pyasn1 25 | 26 | python setup.py develop 27 | 28 | Then you need twitter API credentials. Following this tutorial https://python-twitter.readthedocs.io/en/latest/getting_started.html then create a `conf.yaml` file of this format: 29 | 30 | consumer_key: "..." 31 | consumer_secret: "..." 32 | access_token_key: "..." 33 | access_token_secret: "..." 34 | 35 | The credentials for Mastodon are automatically generated at the first startup. 36 | 37 | # Python 2/3 and one known bug 38 | 39 | Compatible with both. 40 | 41 | There is a known bug if you run python2 coming for the STL lib `mimetypes`: 42 | JPEG images will be uploaded with the `.jpe` extension, this will break "going 43 | on the exact url of the image" (will cause a download instead of a display). 44 | 45 | This bug is fixed in python 3 so I would recommend running t2m with it. 46 | 47 | # Usage 48 | 49 | ## One account 50 | 51 | Forward for one account: 52 | 53 | t2m one twitter_account -m mastodon_account 54 | 55 | This will forward all not already forwarded tweet (this can be up to 200) while 56 | waiting 30 seconds between each toot. This will also remember the mastodon account (so you don't need to specify it again). 57 | 58 | Tweets that starts with a "@" won't be forwarded. Retweets won't be forwarded unless the `-r` option is specified. 59 | 60 | You might want a finer control on your action, so you can do: 61 | 62 | t2m one twitter_account -m mastodon_account -n 10 63 | 64 | To forward only 10 tweet (be careful: if you relaunch the command this will forward 10 other tweets that weren't already forwarded). 65 | 66 | You can also mark the whole available tweet as "already seen" without forwarding them so they'll never be forwarded in the future by using this command: 67 | 68 | t2m one twitter_account -m mastodon_account -o 69 | 70 | If you want to test your commands without forwarding you can simply uses the `-d` (or `--debug`) option: 71 | 72 | t2m one twitter_account -m mastodon_account -d 73 | t2m one twitter_account -m mastodon_account -n 10 -d 74 | 75 | ## Recommendation 76 | 77 | In general, when I had a new account I look at its timeline, read how many tweets make sens then do: 78 | 79 | t2m one twitter_account -m mastodon_account -n 80 | t2m one twitter_account -m mastodon_account -o 81 | 82 | ## Several accounts 83 | 84 | To forward tweets for all accounts, simply run: 85 | 86 | t2m all 87 | 88 | This is a good command to put inside a crontab. 89 | 90 | To check all accounts that will be forwarded, do a: 91 | 92 | t2m list 93 | 94 | You can also add an account directly without using the `one` command using: 95 | 96 | t2m add twitter_account mastodon_account 97 | 98 | ## Retweets 99 | 100 | When enabled, retweets are forwarded using the `retweet.tmpl` file as a template, feel free to edit it to suit your needs. The following tokens will be replaced in the template: 101 | 102 | * `%(text)s`: the retweeted text 103 | * `%(user)s`: the original tweet author username 104 | * `%(id)s`: the original tweet id 105 | 106 | To create a link to the original tweet, use `https://twitter.com/%(user)s/status/%(id)s`. To link to the original author profile, use `https://twitter.com/%(user)s`. 107 | 108 | 109 | ## Content Warnings 110 | 111 | Content warnings can be added automatically to toots based on regular 112 | expressions. These are configured by creating a file named cw.json. 113 | 114 | For example, simple patterns can be used to match any tweet mentioning specific 115 | keywords: 116 | 117 | ```json 118 | { 119 | "coding": [ 120 | "code", "coding", "pull request", "github", "git", "json", "regex" 121 | ], 122 | "coffee": [ 123 | "#coffee", "coffee", "caffeine" 124 | ] 125 | } 126 | ``` 127 | 128 | If a regex pattern contains a group then that group will be used as the content 129 | warning text. This allows rules such as using the first hashtag of a tweet as 130 | the CW warning: 131 | 132 | ```json 133 | { 134 | "hashtag-prefix": [ 135 | "^(#[^\\s]*)\\s" 136 | ] 137 | } 138 | ``` 139 | 140 | This also allows using a prefix such as CW to specify that the first line of a 141 | tweet should be used as the content warning: 142 | 143 | ```json 144 | { 145 | "cw-prefix": [ 146 | "^CW (.*)\\n" 147 | ] 148 | } 149 | ``` 150 | 151 | Note that the regex is matched after the `retweet.tmpl` file is applied as a 152 | template, so this can be used to automatically apply a content warning to all 153 | RTs, or RTs from specific people, etc. 154 | 155 | # Licence 156 | 157 | Copyright (C) 2017-2018 Laurent Peuch and [Contributors](https://github.com/Psycojoker/t2m/graphs/contributors) 158 | 159 | This program is free software: you can redistribute it and/or modify 160 | it under the terms of the GNU General Public License as published by 161 | the Free Software Foundation, either version 3 of the License, or 162 | (at your option) any later version. 163 | 164 | This program is distributed in the hope that it will be useful, 165 | but WITHOUT ANY WARRANTY; without even the implied warranty of 166 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 167 | GNU General Public License for more details. 168 | 169 | You should have received a copy of the GNU General Public License 170 | along with this program. If not, see . 171 | -------------------------------------------------------------------------------- /tests/test_t2m.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from __future__ import print_function 4 | 5 | import os 6 | import os.path as osp 7 | import tempfile 8 | import shutil 9 | import unittest 10 | from contextlib import contextmanager 11 | 12 | try: 13 | # Python >= 3.3 14 | import unittest.mock as mock 15 | except ImportError: 16 | import mock 17 | 18 | import twitter # flake8: noqa 19 | 20 | import t2m 21 | 22 | 23 | HERE = osp.abspath(osp.dirname(__file__)) 24 | 25 | 26 | def _fake_tweet(**kwargs): 27 | kwargs.setdefault('id', 1) 28 | kwargs.setdefault('retweeted_status', False) 29 | kwargs.setdefault('quoted_status', False) 30 | kwargs.setdefault('full_text', 'Tweet %s textual content' % kwargs['id']) 31 | kwargs.setdefault('urls', []) 32 | kwargs.setdefault('media', []) 33 | return mock.Mock(**kwargs) 34 | 35 | 36 | def _fake_twitter_client(configuration=None): 37 | fake_client = mock.Mock() 38 | if configuration is None: 39 | configuration = { 40 | 'GetUserTimeline.return_value': [ 41 | _fake_tweet(id=id) for id in range(10)], 42 | } 43 | if configuration: 44 | fake_client.configure_mock(**configuration) 45 | return fake_client 46 | 47 | 48 | def _media_post(fpath): 49 | with open(fpath) as fobj: 50 | return {'id': fobj.read()} 51 | 52 | 53 | @contextmanager 54 | def _all_mocked(tweets=None): 55 | if tweets is None: 56 | tweets = [_fake_tweet(id=id) for id in range(10)] 57 | conf = {'GetUserTimeline.return_value': tweets} 58 | with mock.patch('twitter.Api', return_value=_fake_twitter_client(conf)): 59 | with mock.patch('mastodon.Mastodon.status_post', 60 | return_value={}) as status_post: 61 | with mock.patch('mastodon.Mastodon.media_post', 62 | side_effect=_media_post) as media_post: 63 | yield status_post, media_post 64 | 65 | 66 | class Twitter2MastodonTC(unittest.TestCase): 67 | 68 | def setUp(self): 69 | self._tmpdir = tempfile.mkdtemp() 70 | for fname in os.listdir(osp.join(HERE, 'data')): 71 | shutil.copy(osp.join(HERE, 'data', fname), 72 | osp.join(self._tmpdir, fname)) 73 | self._olddir = osp.abspath(os.getcwd()) 74 | os.chdir(self._tmpdir) 75 | self.new_db() 76 | self.data_url = 'file://%s/' % osp.join(HERE, 'data') 77 | 78 | def tearDown(self): 79 | shutil.rmtree(self._tmpdir) 80 | os.chdir(self._olddir) 81 | 82 | def new_db(self, db=None): 83 | if db is None: 84 | db = { 85 | 'tw1': {'mastodon': 'a1@mamot.fr', 'done': [1, 4]}, 86 | 'tw2': {'mastodon': 'a2@mamot.fr'}, 87 | } 88 | t2m._save_db(db, path=osp.join(self._tmpdir, 'db.json')) 89 | 90 | def read_db(self): 91 | return t2m._get_db(osp.join(self._tmpdir, 'db.json')) 92 | 93 | def test_all(self): 94 | with _all_mocked() as (status_post, media_post): 95 | t2m.all(wait_seconds=0) 96 | self.assertEqual(18, status_post.call_count) 97 | text = 'Tweet %s textual content' 98 | self.assertEqual(sorted( # last call appears first 99 | ([(text % i,) for i in range(10) if i not in {1, 4}]) + # tw1 100 | [(text % i,) for i in range(10)]), # tw2 101 | sorted([args for args, kwargs in status_post.call_args_list])) 102 | db = self.read_db() 103 | self.assertEqual(set(range(10)), set(db['tw1']['done'])) 104 | self.assertEqual(set(range(10)), set(db['tw2']['done'])) 105 | 106 | def test_one_mark_1(self): 107 | "Marking tweets as seen adds them to the db" 108 | with _all_mocked() as (status_post, media_post): 109 | t2m.one('tw1', only_mark_as_seen=True) 110 | self.assertEqual(0, status_post.call_count) 111 | db = self.read_db() 112 | self.assertEqual(set(range(10)), set(db['tw1']['done'])) 113 | self.assertNotIn('done', db['tw2']) # check unchanged 114 | 115 | def test_one_mark_2(self): 116 | "Marking tweets as seen adds the missing ones to the db" 117 | with _all_mocked(): 118 | t2m.one('tw2', only_mark_as_seen=True) 119 | db = self.read_db() 120 | self.assertEqual(set(range(10)), set(db['tw2']['done'])) 121 | self.assertEqual({1, 4}, set(db['tw1']['done'])) # check unchanged 122 | 123 | def test_one_send_4_toots(self): 124 | self.new_db() 125 | with _all_mocked() as (status_post, media_post): 126 | t2m.one('tw1', wait_seconds=0, number=4) 127 | self.assertEqual(4, status_post.call_count) 128 | # 1 and 4 were already there and 0, 2, 3, 5 have just been sent: 129 | self.assertEqual({1, 4, 0, 2, 3, 5}, 130 | set(self.read_db()['tw1']['done'])) 131 | 132 | def test_retweet(self): 133 | tweet = _fake_tweet(retweeted_status=mock.Mock( 134 | id='retweeted', full_text='retweeted text', urls=(), media=(), 135 | user=mock.Mock(screen_name='retweeted_user')), 136 | ) 137 | with _all_mocked([tweet]) as (status_post, media_post): 138 | t2m.one('tw2', wait_seconds=0) 139 | self.assertEqual(0, status_post.call_count) 140 | with _all_mocked([tweet]) as (status_post, media_post): 141 | t2m.one('tw2', wait_seconds=0, retweets=True) 142 | self.assertEqual(1, status_post.call_count) 143 | args, kwargs = status_post.call_args 144 | self.assertEqual( 145 | (u'« retweeted text »\n\n— Retweet ' 146 | u'https://twitter.com/retweeted_user/status/retweeted',), args) 147 | 148 | def test_quoted(self): 149 | tweet = _fake_tweet( 150 | full_text='I quote this:', 151 | quoted_status=mock.Mock( 152 | id='quoted', full_text='quoted full', urls=(), media=(), 153 | user=mock.Mock(screen_name='quoted_user')), 154 | ) 155 | with _all_mocked([tweet]) as (status_post, media_post): 156 | t2m.one('tw2', wait_seconds=0) 157 | self.assertEqual(0, status_post.call_count) 158 | with _all_mocked([tweet]) as (status_post, media_post): 159 | t2m.one('tw2', wait_seconds=0, retweets=True) 160 | self.assertEqual(1, status_post.call_count) 161 | args, kwargs = status_post.call_args 162 | self.assertEqual( 163 | (u'I quote this:\n\n« quoted full »\n\n— Retweet ' 164 | u'https://twitter.com/quoted_user/status/quoted',), args) 165 | 166 | def test_private_tweet(self): 167 | tweet = _fake_tweet(full_text='@private_response') 168 | with _all_mocked([tweet]) as (status_post, media_post): 169 | t2m.one('tw2', wait_seconds=0) 170 | self.assertEqual(0, status_post.call_count) 171 | 172 | def test_complete_tweet(self): 173 | tweet = _fake_tweet( 174 | full_text='normal with urls and medias', 175 | urls=[mock.Mock(url='http://short_url/index.html', 176 | expanded_url='http://expanded_url/index.html')], 177 | media=[mock.Mock(media_url=self.data_url + 'media1.txt'), 178 | mock.Mock(media_url=self.data_url + 'media2.txt')] 179 | ) 180 | with _all_mocked([tweet]) as (status_post, media_post): 181 | t2m.one('tw2', wait_seconds=0) 182 | self.assertEqual(1, status_post.call_count) 183 | args, kwargs = status_post.call_args 184 | self.assertEqual(('normal with urls and medias',), args) 185 | self.assertEqual( 186 | {'media_ids': ['media1 content\n', 'media2 content\n'], 'spoiler_text': None}, 187 | kwargs) 188 | 189 | def test_strip(self): 190 | tweet = _fake_tweet( 191 | full_text=('Tweet with a normal short url https://t.co/dummy' 192 | ' and an extra at the end, to be stripped:' 193 | ' https://t.co/0123456789'), 194 | urls=[mock.Mock(url='https://t.co/dummy', 195 | expanded_url='https://example.com/dummy')], 196 | ) 197 | with _all_mocked([tweet]) as (status_post, media_post): 198 | t2m.one('tw2', wait_seconds=0, strip_trailing_url=True) 199 | self.assertEqual(1, status_post.call_count) 200 | args, kwargs = status_post.call_args 201 | expected = ('Tweet with a normal short url https://example.com/dummy' 202 | ' and an extra at the end, to be stripped:') 203 | self.assertEqual((expected,), args) 204 | 205 | 206 | if __name__ == "__main__": 207 | unittest.main() 208 | -------------------------------------------------------------------------------- /t2m/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | import os 4 | import re 5 | import sys 6 | import json 7 | import time 8 | import shutil 9 | import tempfile 10 | import codecs 11 | 12 | try: 13 | from urllib import urlretrieve 14 | except ImportError: 15 | from urllib.request import urlretrieve 16 | 17 | from getpass import getpass 18 | 19 | import yaml 20 | import argh 21 | import twitter 22 | 23 | from mastodon import Mastodon 24 | 25 | try: 26 | from HTMLParser import HTMLParser 27 | except ImportError: 28 | from html.parser import HTMLParser 29 | 30 | 31 | HERE = os.path.abspath(os.path.dirname(__file__)) 32 | 33 | ENDS_WITH_TCO_URL_REGEX = re.compile( 34 | '.*(?P https://t\.co/[^/ ]{10})$') 35 | 36 | 37 | def _get_content_warnings_db(): 38 | if os.path.exists("cw.json"): 39 | return json.load(open("cw.json", "r")) 40 | 41 | return {} 42 | 43 | 44 | def _get_db(path="db.json"): 45 | """Return the database content from `path` (defaults to "db.json"). 46 | 47 | It is stored on disk in the json format and as the following 48 | model: 49 | 50 | { 51 | : { 52 | "mastodon": , 53 | "done": [] 54 | } 55 | } 56 | 57 | """ 58 | if os.path.isfile(path): 59 | with open(path) as fobj: 60 | return json.load(fobj) 61 | return {} 62 | 63 | 64 | def _save_db(db, path="db.json"): 65 | """Save given `db` python structure to a json file at `path` (defaults 66 | to "db.json") 67 | 68 | """ 69 | with open(path, "w") as fobj: 70 | json.dump(db, fobj, indent=4) 71 | 72 | 73 | def _ensure_client_exists_for_instance(instance): 74 | "Create the client creds file if it does not exist, and return its path." 75 | client_id = "t2m_%s_clientcred.txt" % instance 76 | if not os.path.exists(client_id): 77 | Mastodon.create_app('t2m', to_file=client_id, 78 | api_base_url='https://%s' % instance, 79 | ) 80 | return client_id 81 | 82 | 83 | def _find_potential_content_warning(toot_text): 84 | "Based on cw.json, find a potential automatic content warning based on the toot content." 85 | warning = None 86 | 87 | for content_warning, patterns in _get_content_warnings_db().items(): 88 | for pattern in patterns: 89 | match = re.search(pattern=pattern, string=toot_text) 90 | if not match: 91 | continue 92 | 93 | # If there is a group in the re then use it for the cw text 94 | if match.groups(): 95 | warning = match.group(1) 96 | toot_text = re.sub(pattern, "", toot_text) 97 | 98 | else: 99 | # If no group then use the key from the json for the cw text 100 | warning = content_warning 101 | 102 | # once we get our first content warning, stop 103 | return warning, toot_text 104 | 105 | return warning, toot_text 106 | 107 | 108 | def _check_complete_mastodon_handle(mastodon_handle, twitter_handle): 109 | """Print an error and exit if the given mastodon handle does not contain 110 | the instance name. 111 | 112 | The `twitter_handle` parameter is also required to display a user- 113 | understandable message. 114 | 115 | """ 116 | if "@" not in mastodon_handle: 117 | msg = ("ERROR: multiple instances are now handled, but your mastodon" 118 | " handle %(mastodon)r needs the instance name. Please add it" 119 | " using:\n%(exe)s add %(twitter)s %(mastodon)s@theinstance.com") 120 | ctx = {"exe": sys.argv[0], 121 | "twitter": twitter_handle, 122 | "mastodon": mastodon_handle} 123 | print(msg % ctx, file=sys.stderr) 124 | sys.exit(1) 125 | 126 | 127 | def _collect_toots(twitter_client, twitter_handle, done=(), retweets=False, 128 | max_tweets=200, strip_trailing_url=False): 129 | """Return a list of dicts describing toots to be sent. 130 | 131 | Given `twitter_handle` and the `done` list of already sent tweet 132 | ids (defaults to the empty list), `twitter_client` is used to 133 | fetch tweets' textual content and medias. The last `max_tweets` are 134 | fetched (defaults to 200), and retweets are ignored unless the 135 | `retweets` parameter is set to a truthy value. 136 | 137 | An item of the return list as the following model: 138 | 139 | { 140 | "text": , 141 | "id": , 142 | "medias": 143 | } 144 | 145 | """ 146 | toots = [] 147 | 148 | if retweets: 149 | with codecs.open(os.path.join(HERE, "retweet.tmpl"), 150 | encoding="utf-8") as fobj: 151 | retweet_template = fobj.read() 152 | 153 | h = HTMLParser() 154 | 155 | # "i" is a status http://python-twitter.readthedocs.io/en/latest/_modules/twitter/models.html#Status 156 | for i in reversed(twitter_client.GetUserTimeline( 157 | screen_name=twitter_handle, count=max_tweets)): 158 | 159 | quoted_status = getattr(i, "quoted_status", None) 160 | retweeted_status = i.retweeted_status or quoted_status 161 | 162 | if retweeted_status: 163 | if retweets: 164 | text = retweet_template % { 165 | "text": retweeted_status.full_text, 166 | "user": retweeted_status.user.screen_name, 167 | "id": retweeted_status.id 168 | } 169 | 170 | # can only be greater than 500 chars if it's a quoted tweet so checking here 171 | # delete the text of the quoted tweet from the toot end replace it with a much shorter string 172 | if quoted_status and len(text) > 500: 173 | text = retweet_template % { 174 | "text": "Quoted tweet's link below", 175 | "user": retweeted_status.user.screen_name, 176 | "id": retweeted_status.id 177 | } 178 | text = i.full_text + "\n\n" + text 179 | 180 | if quoted_status: 181 | text = i.full_text + "\n\n" + text 182 | 183 | urls = retweeted_status.urls 184 | media = retweeted_status.media 185 | else: 186 | continue 187 | else: 188 | # do not forward pseudo-private answer for now 189 | if i.full_text.startswith("@"): 190 | continue 191 | 192 | text = i.full_text 193 | urls = i.urls 194 | media = i.media 195 | 196 | # do not forward already forwarded tweets 197 | if i.id in done: 198 | continue 199 | 200 | # remove this t.co crap 201 | for url in urls: 202 | text = text.replace(url.url, url.expanded_url) 203 | 204 | # strip last t.co URL, which is a reference to the tweet 205 | # itself (other URLs were expanded above, so there is no risk 206 | # to remove an important, part of the text, URL) 207 | if strip_trailing_url: 208 | match = ENDS_WITH_TCO_URL_REGEX.search(text) 209 | if match is not None: 210 | text = text[:-len(match.group('stripme'))] 211 | 212 | toot_text = h.unescape(text) 213 | warning, toot_text = _find_potential_content_warning(toot_text) 214 | 215 | toots.append({ 216 | "text": toot_text, 217 | "content_warning": warning, 218 | "id": i.id, 219 | "medias": [x.media_url for x in media] if media else [] 220 | }) 221 | 222 | return toots 223 | 224 | 225 | def _send_toot(mastodon, toot): 226 | """Send a toot given its description in the `toot` parameter. 227 | 228 | See the `_collect_toots` function for the expected description 229 | format. 230 | 231 | This function fetches all media URLs of `toot` in a temporary 232 | directory (removed afterwards) and uses the given Mastodon client 233 | `mastodon` to send them along with the toot's textual content. 234 | 235 | It may raise an AssertionError if the client does not succeed to 236 | send to given toot. 237 | 238 | """ 239 | tmp_dir = tempfile.mkdtemp() 240 | try: 241 | medias = [] 242 | for number, media_url in enumerate(toot["medias"]): 243 | dl_file_path = os.path.join(tmp_dir, str(number) + "." + 244 | media_url.split(".")[-1]) 245 | urlretrieve(media_url, dl_file_path) 246 | medias.append(mastodon.media_post(dl_file_path)["id"]) 247 | 248 | response = mastodon.status_post(toot["text"], 249 | media_ids=medias, 250 | spoiler_text=toot["content_warning"]) 251 | assert not response.get("error"), response 252 | finally: 253 | shutil.rmtree(tmp_dir, ignore_errors=True) 254 | 255 | 256 | def _get_mastodon_client(mastodon_handle): 257 | " Return a Mastodon client for the given handle. " 258 | instance = mastodon_handle.split("@", 1)[1] 259 | 260 | client_id, access_token = _login_to_mastodon(mastodon_handle) 261 | 262 | return Mastodon(client_id=client_id, 263 | access_token=access_token, 264 | api_base_url='https://%s' % instance) 265 | 266 | 267 | def _forward(db, twitter_handle, mastodon_handle, number=None, 268 | only_mark_as_seen=False, retweets=False, debug=False, 269 | wait_seconds=30, strip_trailing_url=False): 270 | """Internal function that does the actual tweet forwarding job. 271 | 272 | This function modifies the given `db` parameter. 273 | 274 | See the `one` function doc for more information about its 275 | parameters. 276 | 277 | The `wait_seconds` parameter is the time between we wait between 278 | two sendings. 279 | 280 | """ 281 | with open("conf.yaml") as fobj: 282 | twitter_client = twitter.Api( 283 | tweet_mode='extended', **yaml.safe_load(fobj)) 284 | 285 | done = db.setdefault(twitter_handle, {}).setdefault("done", []) 286 | 287 | to_toot = _collect_toots(twitter_client, twitter_handle, 288 | done=done, retweets=retweets, 289 | strip_trailing_url=strip_trailing_url) 290 | if only_mark_as_seen: 291 | done.extend([t["id"] for t in to_toot]) 292 | print("Marked all available tweets as seen (%s tweets marked)" 293 | % len(to_toot)) 294 | return 295 | 296 | # slices selected tweets if specified 297 | if number is not None: 298 | to_toot = to_toot[-int(number):] 299 | 300 | # actually forward 301 | forwarded = 0 302 | _check_complete_mastodon_handle(mastodon_handle, twitter_handle) 303 | mastodon = _get_mastodon_client(mastodon_handle) 304 | 305 | for num, toot in enumerate(to_toot): 306 | if debug: 307 | print(">>", toot["text"].encode("utf-8"), 308 | " ".join(toot["medias"])) 309 | continue 310 | if wait_seconds and num > 0: 311 | time.sleep(wait_seconds) 312 | try: 313 | _send_toot(mastodon, toot) 314 | except Exception as e: 315 | import traceback 316 | traceback.print_exc() 317 | print("ERROR: could not forward the tweet [%s] '%s' " 318 | "because '%s', skipping for now" 319 | % (toot["id"], toot["text"], e), file=sys.stderr) 320 | continue 321 | 322 | forwarded += 1 323 | print("[forwarding] >>", 324 | toot["text"].encode("utf-8"), 325 | " ".join(toot["medias"])) 326 | done.append(toot["id"]) 327 | _save_db(db) 328 | 329 | if not to_toot: 330 | print("Nothing to do for %s" % twitter_handle) 331 | else: 332 | print("Forwarded %s tweets from %s to %s" 333 | % (forwarded, twitter_handle, mastodon_handle)) 334 | 335 | return 336 | 337 | 338 | def one(twitter_handle, mastodon_handle=None, number=None, 339 | only_mark_as_seen=False, retweets=False, debug=False, 340 | wait_seconds=30, strip_trailing_url=False): 341 | """Forward tweets of *one* twitter account to Mastodon. 342 | 343 | If the `mastodon_handle` parameter is not specified, the given 344 | `twitter_handle` must be present in the database, and the 345 | corresponding Mastodon account is used. 346 | 347 | When the `number` parameter is passed, it is used as the maximum 348 | number of tweets to be forwarded at once. Note the last tweets are 349 | kept, not the first. 350 | 351 | If `only_mark_as_seen` is set to True (default is False), then the 352 | selected tweets not actually forwarded but marked as if they had 353 | already been. 354 | 355 | If `retweets` is set to True (default is False), also the retweets 356 | (and quotes) will be forwarded. 357 | 358 | If `strip_trailing_url` is True, the https://t.co/... at the end 359 | of some tweets is removed. Note that all other t.co shortened URLs 360 | identified by Twitter and are expanded beforehand, so there should 361 | be no risk to remove an URL that was part of the tweet when 362 | activating this option. 363 | 364 | The `debug` parameter, if set, is used to display what tweets 365 | would be forwarded if unset (the default), but does not actually 366 | forward any tweet. 367 | 368 | """ 369 | 370 | db = _get_db() 371 | 372 | if mastodon_handle is None: 373 | if twitter_handle not in db: 374 | print("ERROR: No associated mastodon account for twitter account" 375 | " %r. Use the '-m' option to provide one." % twitter_handle, 376 | file=sys.stderr) 377 | sys.exit(1) 378 | else: 379 | mastodon_handle = db[twitter_handle]["mastodon"] 380 | 381 | _check_complete_mastodon_handle(mastodon_handle, twitter_handle) 382 | 383 | # force set new mastodon handle 384 | db.setdefault(twitter_handle, {})["mastodon"] = mastodon_handle 385 | 386 | _forward(db, twitter_handle, mastodon_handle, number=number, 387 | only_mark_as_seen=only_mark_as_seen, retweets=retweets, 388 | debug=debug, wait_seconds=wait_seconds, 389 | strip_trailing_url=strip_trailing_url) 390 | 391 | _save_db(db) 392 | 393 | 394 | def all(retweets=False, debug=False, wait_seconds=30, 395 | strip_trailing_url=False): 396 | """Forward the tweets of all known twitter accounts to Mastodon. 397 | 398 | Only not already forwarded tweets are forwarded. Note that you 399 | must preserve your "db.json" file as this is where the list of 400 | already forwarded tweets is stored: no comparison between Twitter 401 | and Mastodon posts is performed to determine the posts to be 402 | forwarded, only the database. Use `t2m forward -o` to avoid 403 | forwarding old tweets, by marking them already forwarded. 404 | 405 | When optional `retweets` parameter is True (it is False by 406 | default), the retweets are also forwarded to Mastodon. 407 | 408 | """ 409 | db = _get_db() 410 | 411 | for twitter_handle in db: 412 | if not db[twitter_handle].get("mastodon"): 413 | print("WARNING: no mastodon handle for twitter account %r, " 414 | "add one using the 't2m add' command. Skipped." 415 | % twitter_handle) 416 | continue 417 | 418 | _forward(db, twitter_handle, db[twitter_handle]["mastodon"], 419 | retweets=retweets, debug=debug, wait_seconds=wait_seconds, 420 | strip_trailing_url=strip_trailing_url) 421 | 422 | _save_db(db) 423 | 424 | 425 | def _login_to_mastodon(mastodon_handle): 426 | """Login to given Mastodon account, returning client id and access token. 427 | 428 | The client id file for this Mastodon account must pre-exist (named 429 | "t2m__creds.txt"). 430 | 431 | The access token file (named "t2m__creds.txt") is written. 432 | after the Mastodon email and password are interactively input. 433 | """ 434 | instance = mastodon_handle.split("@", 1)[1] 435 | client_id = _ensure_client_exists_for_instance(instance) 436 | access_token = "t2m_%s_creds.txt" % mastodon_handle 437 | if not os.path.exists(access_token): 438 | mastodon = Mastodon(client_id=client_id, 439 | api_base_url="https://%s" % instance) 440 | 441 | print("No credential file found for mastodon account %r, " 442 | "creating it (the password will NOT be saved)" % mastodon_handle) 443 | mastodon.log_in( 444 | argh.io.safe_input( 445 | "Email for mastodon account %r: " % mastodon_handle).strip(), 446 | getpass("Password for mastodon account of '%s' (won't be stored): " 447 | % mastodon_handle), 448 | to_file=access_token, 449 | ) 450 | return client_id, access_token 451 | 452 | 453 | def add(twitter_handle, mastodon_handle): 454 | "Add the link between given twitter and mastodon handles in the database." 455 | db = _get_db() 456 | 457 | _check_complete_mastodon_handle(mastodon_handle, twitter_handle) 458 | 459 | # retrocompatibility 460 | access_token = "t2m_%s_creds.txt" % mastodon_handle 461 | if os.path.exists("t2m_%s_creds.txt" % mastodon_handle.split("@")[0]): 462 | shutil.move("t2m_%s_creds.txt" % mastodon_handle.split("@")[0], 463 | access_token) 464 | 465 | _login_to_mastodon(mastodon_handle) 466 | 467 | db.setdefault(twitter_handle, {})["mastodon"] = mastodon_handle 468 | 469 | _save_db(db) 470 | print("done") 471 | 472 | 473 | def list(): 474 | "List known twitter accounts, which tweets can be forwarded to Mastodon." 475 | db = _get_db() 476 | for i in db: 477 | print(" *", i) 478 | 479 | 480 | def main(): 481 | if not os.path.exists("conf.yaml"): 482 | print("You need to have a conf.yaml file containing twitter connection" 483 | " informations, please read the documentation" 484 | " https://github.com/Psycojoker/t2m#installation") 485 | sys.exit(1) 486 | 487 | parser = argh.ArghParser() 488 | parser.add_commands([one, all, add, list]) 489 | parser.dispatch() 490 | 491 | 492 | if __name__ == '__main__': 493 | main() 494 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------