├── accounts.example.json ├── requirements.txt ├── tests ├── __init__.py ├── typeahead.py ├── ghostban.py ├── profile.py └── reply_deboosting.py ├── Dockerfile ├── .env.example ├── docker-compose.yaml ├── .gitignore ├── log.py ├── docker-entry.sh ├── util.py ├── database.py ├── README.md ├── backend.py ├── twitter_session.py └── LICENSE.md /accounts.example.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "username": "example_account", 4 | "password": "example_account_password" 5 | } 6 | ] -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp==3.7.3 2 | async-timeout==3.0.1 3 | attrs==20.3.0 4 | beautifulsoup4==4.9.3 5 | bs4==0.0.1 6 | chardet==3.0.4 7 | daemon==1.2 8 | idna==2.10 9 | memory-profiler==0.58.0 10 | multidict==5.1.0 11 | psutil==5.7.3 12 | pymongo==3.11.2 13 | soupsieve==2.1 14 | typing-extensions==3.7.4.3 15 | yarl==1.6.3 16 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | from tests.typeahead import test as test_typeahead 3 | from tests.ghostban import test as test_ghost_ban 4 | from tests.reply_deboosting import test as test_reply_deboosting 5 | from tests.profile import test as test_profile 6 | 7 | __all__ = ['test_typeahead', 'test_ghost_ban', 'test_reply_deboosting', 'test_profile'] 8 | -------------------------------------------------------------------------------- /tests/typeahead.py: -------------------------------------------------------------------------------- 1 | 2 | import urllib.parse 3 | 4 | async def test(session, screen_name): 5 | query = "@" + screen_name 6 | suggestions = await session.get("https://api.twitter.com/1.1/search/typeahead.json?src=search_box&result_type=users&q=" + urllib.parse.quote(query)) 7 | try: 8 | result = len([1 for user in suggestions["users"] if user["screen_name"].lower() == screen_name.lower()]) > 0 9 | except: 10 | result = False 11 | 12 | return result 13 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | 2 | # Use Python 3.9 as a base image 3 | FROM python:3.9-slim-buster 4 | 5 | # Package installation 6 | RUN apt-get update -y && apt-get upgrade -y 7 | RUN apt-get install gcc python3-dev -y 8 | 9 | # Dependencies installation 10 | COPY requirements.txt /tmp/ 11 | RUN pip install --no-cache-dir -r /tmp/requirements.txt && rm /tmp/requirements.txt 12 | 13 | # Working directory 14 | WORKDIR /app/ 15 | 16 | # entry point 17 | ENTRYPOINT /bin/bash docker-entry.sh .env 18 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | 2 | # Show debug log messages (0 or 1) 3 | DEBUG=1 4 | 5 | # JSON file with reference account credentials 6 | ACCOUNT_FILE=./accounts.json 7 | 8 | # Directory for session cookies 9 | COOKIE_DIR=./cookies 10 | 11 | # File to write logs to 12 | LOG_FILE=./logs/results.log 13 | 14 | # host/port which to listen on 15 | HOST=0.0.0.0 16 | PORT=9100 17 | 18 | # Auth key for Twitter guest session 19 | TWITTER_AUTH_KEY=AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA 20 | 21 | # Value for Access-Control-Allow-Origin header 22 | CORS_ALLOW=http://localhost:9000 23 | 24 | # Number of Twitter guest sessions to use 25 | GUEST_SESSIONS=10 26 | 27 | # MongoDB Connection 28 | MONGO_HOST=localhost 29 | MONGO_PORT=27017 30 | MONGO_DB=tester 31 | MONGO_USERNAME=root 32 | MONGO_PASSWORD=5X-rl[(EMdJKll1|qMDU}5xY 0 and tweets_replies["globalObjects"]["tweets"][tid]["user_id_str"] == user_id: 14 | replied_ids.append(tid) 15 | 16 | for tid in replied_ids: 17 | tweet = await session.tweet_raw(tid) 18 | for reply_id, reply_obj in tweet["globalObjects"]["tweets"].items(): 19 | if reply_id == tid or reply_obj.get("in_reply_to_status_id_str", None) != tid: 20 | continue 21 | reply_tweet = await session.tweet_raw(reply_id) 22 | if reply_id not in reply_tweet["globalObjects"]["tweets"]: 23 | continue 24 | obj = {"tweet": tid, "reply": reply_id} 25 | if tid in reply_tweet["globalObjects"]["tweets"]: 26 | obj["ban"] = False 27 | else: 28 | obj["ban"] = True 29 | return obj 30 | except: 31 | log.error('Unexpected Exception:') 32 | log.error(traceback.format_exc()) 33 | return { "error": "EUNKNOWN" } 34 | -------------------------------------------------------------------------------- /util.py: -------------------------------------------------------------------------------- 1 | 2 | def get_nested(obj, path, default=None): 3 | for p in path: 4 | if obj is None or not p in obj: 5 | return default 6 | obj = obj[p] 7 | return obj 8 | 9 | def is_error(result, code=None): 10 | return isinstance(result.get("errors", None), list) and (len([x for x in result["errors"] if x.get("code", None) == code]) > 0 or code is None and len(result["errors"] > 0)) 11 | 12 | def is_generic_error(result, codes): 13 | return isinstance(result.get("errors", None), list) and len([x for x in result["errors"] if x.get("code", None) not in codes]) > 0 14 | 15 | def flatten_timeline(timeline_items): 16 | result = [] 17 | for item in timeline_items: 18 | if get_nested(item, ["content", "item", "content", "tweet", "id"]) is not None: 19 | result.append(item["content"]["item"]["content"]["tweet"]["id"]) 20 | elif get_nested(item, ["content", "timelineModule", "items"]) is not None: 21 | timeline_items = item["content"]["timelineModule"]["items"] 22 | titems = [get_nested(x, ["item", "content", "tweet", "id"]) for x in timeline_items] 23 | result += [x for x in titems if x is not None] 24 | return result 25 | 26 | def get_ordered_tweet_ids(obj, filtered=True): 27 | try: 28 | entries = [x for x in obj["timeline"]["instructions"] if "addEntries" in x][0]["addEntries"]["entries"] 29 | except (IndexError, KeyError): 30 | return [] 31 | entries.sort(key=lambda x: -int(x["sortIndex"])) 32 | flat = flatten_timeline(entries) 33 | return [x for x in flat if not filtered or x in obj["globalObjects"]["tweets"]] 34 | 35 | class UnexpectedApiError(Exception): 36 | pass 37 | -------------------------------------------------------------------------------- /database.py: -------------------------------------------------------------------------------- 1 | 2 | import copy 3 | from pymongo import MongoClient 4 | from time import sleep 5 | 6 | from log import log 7 | 8 | class Database: 9 | def __init__(self, host=None, port=27017, db='tester', username=None, password=None): 10 | # collection name definitions 11 | RESULTS_COLLECTION = 'results' 12 | RATELIMIT_COLLECTION = 'rate-limits' 13 | 14 | log.info('Connecting to %s:%d', host, port) 15 | log.info('Using Database `%s`', db) 16 | # client and DB 17 | self.client = MongoClient(host, port, serverSelectionTimeoutMS=3, username=username, password=password) 18 | self.db = self.client[db] 19 | 20 | # collections 21 | self.results = self.db[RESULTS_COLLECTION] 22 | self.rate_limits = self.db[RATELIMIT_COLLECTION] 23 | 24 | # Test connection immediately, instead of 25 | # when trying to write in a request, later. 26 | self.client.admin.command('ismaster') 27 | 28 | def write_result(self, result): 29 | # copy.deepcopy; otherwise mongo ObjectId (_id) would be added, 30 | # screwing up later JSON serialisation of results 31 | self.results.insert_one(copy.deepcopy(result)) 32 | 33 | def write_rate_limit(self, data): 34 | self.rate_limits.insert_one(data) 35 | 36 | def close(self): 37 | self.client.close() 38 | 39 | def connect(host=None, port=27017, db='tester', username=None, password=None): 40 | if host is None: 41 | raise ValueError('Database constructor needs a `host`name or ip!') 42 | 43 | attempt = 0 44 | max_attempts = 7 45 | mongo_client = None 46 | 47 | while (mongo_client is None): 48 | try: 49 | mongo_client = Database(host=host, port=port, db=db, username=username, password=password) 50 | except Exception as e: 51 | if attempt is max_attempts: 52 | raise e 53 | 54 | sleep(attempt) 55 | attempt += 1 56 | log.warn('Retrying connection, %s/%s', attempt, max_attempts) 57 | 58 | return mongo_client 59 | -------------------------------------------------------------------------------- /tests/profile.py: -------------------------------------------------------------------------------- 1 | 2 | import pathlib 3 | import sys 4 | from typing import Any, Tuple, Dict 5 | 6 | sys.path.insert(0, str(pathlib.Path(__file__).parent)) 7 | 8 | from log import log 9 | from util import is_error, is_generic_error, UnexpectedApiError 10 | 11 | # Count amount of "possibly_sensitive_editable" and "possibly_sensitive" 12 | # flagged tweets in user's timeline 13 | async def count_sensitives(session, user_id): 14 | profile_timeline = await session.get_profile_tweets_raw(user_id) 15 | profile_tweets = profile_timeline["globalObjects"]["tweets"].values() 16 | 17 | counted = len(profile_tweets) 18 | possibly_sensitive = len([1 for tweet in profile_tweets if "possibly_sensitive" in tweet.keys()]) 19 | possibly_sensitive_editable = len([1 for tweet in profile_tweets if "possibly_sensitive_editable" in tweet.keys()]) 20 | 21 | result = { 22 | "counted": counted, 23 | "possibly_sensitive": possibly_sensitive, 24 | "possibly_sensitive_editable": possibly_sensitive_editable 25 | } 26 | 27 | return result 28 | 29 | async def test(session, username: str) -> Tuple[str, Dict[str, Any]]: 30 | profile: dict[str, Any] = {} 31 | profile_raw = await session.profile_raw(username) 32 | log.info('Testing ' + str(username)) 33 | if is_generic_error(profile_raw, [50, 63]): 34 | log.debug("Other error:" + str(username)) 35 | raise UnexpectedApiError 36 | 37 | try: 38 | user_id = str(profile_raw["id"]) 39 | except KeyError: 40 | user_id = '' 41 | 42 | try: 43 | profile["screen_name"] = profile_raw["screen_name"] 44 | except KeyError: 45 | profile["screen_name"] = username 46 | 47 | try: 48 | if profile_raw["profile_interstitial_type"] != "": 49 | profile["restriction"] = profile_raw["profile_interstitial_type"] 50 | except KeyError: 51 | pass 52 | 53 | try: 54 | profile["protected"] = profile_raw["protected"] 55 | except KeyError: 56 | pass 57 | 58 | profile["exists"] = not is_error(profile_raw, 50) 59 | 60 | suspended = is_error(profile_raw, 63) 61 | if suspended: 62 | profile["suspended"] = suspended 63 | 64 | try: 65 | profile["has_tweets"] = int(profile_raw["statuses_count"]) > 0 66 | except KeyError: 67 | profile["has_tweets"] = False 68 | 69 | 70 | log.debug(profile) 71 | if profile["exists"] and not profile.get("protected", False) and not profile.get("suspended", False): 72 | profile["sensitives"] = await count_sensitives(session, user_id) 73 | 74 | return user_id, profile 75 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Twitter ShadowBan Test (Backend) 3 | 4 | Frontend: 5 | [tsukumijima/shadowban-eu-frontend](https://github.com/tsukumijima/shadowban-eu-frontend) 6 | 7 | Backend (this repository): 8 | [tsukumijima/shadowban-eu-backend](https://github.com/tsukumijima/shadowban-eu-backend) 9 | 10 | ## About this fork 11 | 12 | In this fork, we have made various improvements, including tidying up the code, incorporating other branches, and updating dependencies. 13 | 14 | Python has been updated to Python 3.9. Also, the miscellaneous shell scripts have been tidy up and put into docker-entry.sh. 15 | In addition, the unmerged [dev branch](https://github.com/shadowban-eu/shadowban-eu-backend/tree/dev) and the code from the [testing repository](https://github.com/shadowban-eu/testing/tree/dev), which is being developed as a future version and has been heavily refactored, have been merged and the code has been tidy up. 16 | 17 | In addition, the Dockerfile has been improved and Docker Compose is now supported. 18 | With support for Docker Compose, which is very useful as it allows you to run the server with just `docker-compose up` without having to build an environment. 19 | 20 | ## Setup 21 | 22 | Beforehand, Python 3.9 and MongoDB must be installed. 23 | 24 | Run the following commands in order. 25 | 26 | ```bash 27 | # Clone this repository 28 | $ git@github.com:tsukumijima/shadowban-eu-frontend.git 29 | $ cd shadowban-eu-backend 30 | 31 | # Copy .env.example to .env 32 | $ cp .env.example .env 33 | 34 | # Dependencies installation 35 | $ pip install --no-cache-dir -r requirements.txt 36 | ``` 37 | 38 | You need to modify `MONGO_DB`, `MONGO_USERNAME`, `MONGO_PASSWORD` in the .env file to suit your environment. 39 | Please edit the .env file in an editor. 40 | 41 | Run the api server with the following command. 42 | By default, the API server is listening on port 9100. 43 | 44 | ```bash 45 | # Specify the name of the .env file as an argument 46 | $ ./docker-entry.sh .env 47 | ``` 48 | 49 | ## Setup with Docker 50 | 51 | Beforehand, Docker and Docker-Compose must be installed. 52 | 53 | Run the following commands in order. 54 | 55 | ```bash 56 | # Clone this repository 57 | $ git@github.com:tsukumijima/shadowban-eu-frontend.git 58 | $ cd shadowban-eu-backend 59 | 60 | # Copy .env.example to .env 61 | $ cp .env.example .env 62 | ``` 63 | 64 | If you use Docker, you need to modify `MONGO_HOST` in the .env file from `localhost` to `mongo` . 65 | Please edit the .env file in an editor. 66 | 67 | Run the api server with the following command. 68 | By default, the API server is listening on port 9100. 69 | 70 | ```bash 71 | # The first time you run it, the container will be created automatically 72 | $ docker-compose up -d 73 | ``` 74 | 75 | ## Notes 76 | 77 | The default is to test without login. 78 | 79 | You can also test with login. Copy accounts.example.json to accounts.json and set the username (screen name) and password. 80 | But, doesn't work at this time because the login API for the Twitter Web App has changed. 81 | -------------------------------------------------------------------------------- /tests/reply_deboosting.py: -------------------------------------------------------------------------------- 1 | 2 | import traceback 3 | 4 | from log import log 5 | from util import get_nested, get_ordered_tweet_ids 6 | 7 | async def test(session, user_id, screen_name): 8 | try: 9 | tweets_replies = await session.get_profile_tweets_raw(user_id) 10 | tweet_ids = get_ordered_tweet_ids(tweets_replies) 11 | 12 | reply_tweet_ids = [] 13 | 14 | for tid in tweet_ids: 15 | tweet = tweets_replies["globalObjects"]["tweets"][tid] 16 | if "in_reply_to_status_id_str" not in tweet or tweet["in_reply_to_user_id_str"] == user_id or tweet["user_id_str"] != user_id: 17 | continue 18 | conversation_tweet = get_nested(tweets_replies, ["globalObjects", "tweets", tweet["conversation_id_str"]]) 19 | if conversation_tweet is not None and conversation_tweet.get("user_id_str") == user_id: 20 | continue 21 | reply_tweet_ids.append(tid) 22 | 23 | # return error message, when user has not made any reply tweets 24 | if not reply_tweet_ids: 25 | return {"error": "ENOREPLIES"} 26 | 27 | for tid in reply_tweet_ids: 28 | replied_to_id = tweets_replies["globalObjects"]["tweets"][tid].get("in_reply_to_status_id_str", None) 29 | if replied_to_id is None: 30 | continue 31 | replied_tweet_obj = await session.tweet_raw(replied_to_id, 50) 32 | if "globalObjects" not in replied_tweet_obj: 33 | continue 34 | if replied_to_id not in replied_tweet_obj["globalObjects"]["tweets"]: 35 | continue 36 | replied_tweet = replied_tweet_obj["globalObjects"]["tweets"][replied_to_id] 37 | if not replied_tweet["conversation_id_str"] in replied_tweet_obj["globalObjects"]["tweets"]: 38 | continue 39 | conversation_tweet = replied_tweet_obj["globalObjects"]["tweets"][replied_tweet["conversation_id_str"]] 40 | if conversation_tweet["user_id_str"] == user_id: 41 | continue 42 | if replied_tweet["reply_count"] > 500: 43 | continue 44 | 45 | log.debug('[' + screen_name + '] Barrier Test: ') 46 | log.debug('[' + screen_name + '] Found:' + tid) 47 | log.debug('[' + screen_name + '] In reply to:' + replied_to_id) 48 | 49 | if session is None: 50 | log.critical('No reference session') 51 | return 52 | 53 | # Importing TwitterSession directly creates circular import 54 | session.__class__.account_index += 1 55 | 56 | before_barrier = await session.tweet_raw(replied_to_id, 1000) 57 | if get_nested(before_barrier, ["globalObjects", "tweets"]) is None: 58 | log.error('notweets') 59 | return 60 | 61 | if tid in get_ordered_tweet_ids(before_barrier): 62 | return {"ban": False, "tweet": tid, "in_reply_to": replied_to_id} 63 | 64 | cursors = ["ShowMoreThreads", "ShowMoreThreadsPrompt"] 65 | last_result = before_barrier 66 | 67 | for stage in range(0, 2): 68 | entries = [x for x in last_result["timeline"]["instructions"] if "addEntries" in x][0]["addEntries"]["entries"] 69 | 70 | try: 71 | cursor = [x["content"]["operation"]["cursor"]["value"] for x in entries if get_nested(x, ["content", "operation", "cursor", "cursorType"]) == cursors[stage]][0] 72 | except (KeyError, IndexError): 73 | continue 74 | 75 | after_barrier = await session.tweet_raw(replied_to_id, 1000, cursor=cursor) 76 | 77 | if get_nested(after_barrier, ["globalObjects", "tweets"]) is None: 78 | log.error('retinloop') 79 | return 80 | ids_after_barrier = get_ordered_tweet_ids(after_barrier) 81 | if tid in get_ordered_tweet_ids(after_barrier): 82 | return {"ban": True, "tweet": tid, "stage": stage, "in_reply_to": replied_to_id} 83 | last_result = after_barrier 84 | 85 | # happens when replied_to_id tweet has been deleted 86 | log.error('[' + screen_name + '] outer loop return') 87 | return { "error": "EUNKNOWN" } 88 | except: 89 | log.error('Unexpected Exception in test_barrier:') 90 | log.error(traceback.format_exc()) 91 | return { "error": "EUNKNOWN" } 92 | -------------------------------------------------------------------------------- /backend.py: -------------------------------------------------------------------------------- 1 | 2 | import argparse 3 | import asyncio 4 | import json 5 | import os 6 | import time 7 | 8 | from aiohttp import web 9 | import daemon 10 | 11 | from database import connect, Database 12 | from log import log, add_file_handler, set_log_level, shutdown_logging 13 | from twitter_session import TwitterSession 14 | 15 | LOG_FILE = None 16 | DEBUG_FILE = None 17 | DB: Database 18 | 19 | # This is a public value from the Twitter source code. 20 | TWITTER_AUTH_KEY = 'AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA' 21 | 22 | routes = web.RouteTableDef() 23 | 24 | def log_session_info(sessions): 25 | text = "" 26 | for session in sessions: 27 | text += "\n%6d %5d %9d %5d" % (int(session.locked), session.limit, session.remaining, session.reset - int(time.time())) 28 | return text 29 | 30 | @routes.get('/.stats') 31 | async def stats(request): 32 | text = "--- GUEST SESSIONS ---\n\nLocked Limit Remaining Reset" 33 | text += log_session_info(TwitterSession.guest_sessions) 34 | text += "\n\n\n--- ACCOUNTS ---\n\nLocked Limit Remaining Reset" 35 | text += log_session_info(TwitterSession.account_sessions) 36 | return web.Response(text=text) 37 | 38 | @routes.get('/.unlocked/{screen_name}') 39 | async def unlocked(request): 40 | screen_name = request.match_info['screen_name'] 41 | text = "Not unlocked" 42 | for session in TwitterSession.account_sessions: 43 | if session.username.lower() != screen_name.lower(): 44 | continue 45 | session.locked = False 46 | text = "Unlocked" 47 | return web.Response(text=text) 48 | 49 | 50 | @routes.get('/{screen_name}') 51 | async def api(request): 52 | screen_name = request.match_info['screen_name'] 53 | session = TwitterSession.guest_sessions[TwitterSession.test_index % len(TwitterSession.guest_sessions)] 54 | TwitterSession.test_index += 1 55 | result = await session.test(screen_name) 56 | DB.write_result(result) 57 | log.debug('\n %s', json.dumps(result)) 58 | if args.cors_allow is not None: 59 | return web.json_response(result, headers={"Access-Control-Allow-Origin": args.cors_allow}) 60 | 61 | return web.json_response(result) 62 | 63 | async def login_accounts(accounts, cookie_dir=None): 64 | if cookie_dir is not None and not os.path.isdir(cookie_dir): 65 | os.mkdir(cookie_dir, 0o700) 66 | coroutines = [] 67 | for acc in accounts: 68 | session = TwitterSession() 69 | coroutines.append(session.login(**acc, cookie_dir=cookie_dir)) 70 | TwitterSession.account_sessions.append(session) 71 | await asyncio.gather(*coroutines) 72 | 73 | async def login_guests(): 74 | for _ in range(0, guest_session_pool_size): 75 | session = TwitterSession() 76 | TwitterSession.guest_sessions.append(session) 77 | await asyncio.gather(*[s.login() for s in TwitterSession.guest_sessions]) 78 | log.info("%d guest sessions created", len(TwitterSession.guest_sessions)) 79 | 80 | def ensure_dir(path): 81 | if os.path.isdir(path) is False: 82 | log.info('Creating directory %s', path) 83 | os.mkdir(path) 84 | 85 | parser = argparse.ArgumentParser(description='Twitter Shadowban Tester') 86 | parser.add_argument('--account-file', type=str, default='./accounts.json', help='json file with reference account credentials') 87 | parser.add_argument('--cookie-dir', type=str, default='./cookies', help='directory for session cookies') 88 | parser.add_argument('--log', type=str, default='./logs/backend.log', help='file to write logs to (default: ./logs/backend.log)') 89 | parser.add_argument('--daemon', action='store_true', help='run in background') 90 | parser.add_argument('--debug', action='store_true', help='show debug log messages') 91 | parser.add_argument('--host', type=str, default='localhost', help='hostname/ip which to listen on (default:localhost)') 92 | parser.add_argument('--port', type=int, default=9100, help='port which to listen on (default: 9100)') 93 | parser.add_argument('--mongo-host', type=str, default='localhost', help='hostname or IP of mongoDB service to connect to (default: localhost)') 94 | parser.add_argument('--mongo-port', type=int, default=27017, help='port of mongoDB service to connect to (default: 27017)') 95 | parser.add_argument('--mongo-db', type=str, default='tester', help='name of mongo database to use (default: tester)') 96 | parser.add_argument('--mongo-username', type=str, default=None, help='user with read/write permissions to --mongo-DB') 97 | parser.add_argument('--mongo-password', type=str, default=None, help='password for --mongo-username') 98 | parser.add_argument('--twitter-auth-key', type=str, default=TWITTER_AUTH_KEY, help='auth key for twitter guest session') 99 | parser.add_argument('--cors-allow', type=str, default=None, help='value for Access-Control-Allow-Origin header') 100 | parser.add_argument('--guest-sessions', type=int, default=10, help='number of Twitter guest sessions to use (default: 10)') 101 | args = parser.parse_args() 102 | 103 | TwitterSession.twitter_auth_key = args.twitter_auth_key 104 | guest_session_pool_size = args.guest_sessions 105 | 106 | if args.cors_allow is None: 107 | log.warning('[CORS] Running without CORS headers') 108 | else: 109 | log.info('[CORS] Allowing requests from: %s', args.cors_allow) 110 | 111 | ensure_dir(args.cookie_dir) 112 | 113 | log_dir = os.path.dirname(args.log) 114 | ensure_dir(log_dir) 115 | add_file_handler(args.log) 116 | 117 | try: 118 | with open(args.account_file, "r") as f: 119 | TwitterSession.accounts = json.loads(f.read()) 120 | except: 121 | pass 122 | 123 | if args.debug is True: 124 | set_log_level('debug') 125 | else: 126 | set_log_level('info') 127 | 128 | async def shut_down(app): 129 | log.info("Closing %d guest sessions", len(TwitterSession.guest_sessions)) 130 | for session in TwitterSession.guest_sessions: 131 | await session.close() 132 | 133 | async def clean_up(app): 134 | global DB 135 | log.info("Closing database connection") 136 | DB.close() 137 | 138 | shutdown_logging() 139 | 140 | def run(): 141 | global DB 142 | DB = None 143 | if args.mongo_host is not None: 144 | DB = connect( 145 | host=args.mongo_host, 146 | port=args.mongo_port, 147 | db=args.mongo_db, 148 | username=args.mongo_username, 149 | password=args.mongo_password, 150 | ) 151 | loop = asyncio.get_event_loop() 152 | loop.run_until_complete(login_accounts(TwitterSession.accounts, args.cookie_dir)) 153 | loop.run_until_complete(login_guests()) 154 | 155 | app = web.Application() 156 | app.add_routes(routes) 157 | app.on_shutdown.append(shut_down) 158 | app.on_cleanup.append(clean_up) 159 | 160 | web.run_app(app, host=args.host, port=args.port) 161 | 162 | if args.daemon: 163 | with daemon.DaemonContext(): 164 | run() 165 | else: 166 | run() 167 | -------------------------------------------------------------------------------- /twitter_session.py: -------------------------------------------------------------------------------- 1 | 2 | import os 3 | import time 4 | import urllib, urllib.parse 5 | from typing import Any 6 | 7 | import aiohttp 8 | from bs4 import BeautifulSoup 9 | from yarl import URL 10 | 11 | from log import log 12 | from tests import * 13 | from util import get_nested, is_error, UnexpectedApiError 14 | 15 | class TwitterSession: 16 | twitter_auth_key = '' 17 | account_sessions = [] 18 | account_index = 0 19 | guest_sessions = [] 20 | test_index = 0 21 | accounts = [] 22 | 23 | def __init__(self): 24 | self._guest_token = '' 25 | self._csrf_token = '' 26 | 27 | # aiohttp ClientSession 28 | self._session = None 29 | 30 | # rate limit monitoring 31 | self.remaining = 180 32 | self.reset = -1 33 | self.locked = False 34 | self.next_refresh = None 35 | 36 | # session user's @username 37 | # this stays `None` for guest sessions 38 | self.username = None 39 | 40 | self._headers = { 41 | "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36" 42 | } 43 | # sets self._headers 44 | self.reset_headers() 45 | 46 | def set_csrf_header(self): 47 | cookies = self._session.cookie_jar.filter_cookies(URL('https://twitter.com/')) 48 | for _, cookie in cookies.items(): 49 | if cookie.key == 'ct0': 50 | self._headers['X-Csrf-Token'] = cookie.value 51 | 52 | async def get_guest_token(self): 53 | self._headers['Authorization'] = 'Bearer ' + self.twitter_auth_key 54 | async with self._session.post("https://api.twitter.com/1.1/guest/activate.json", headers=self._headers) as r: 55 | response = await r.json() 56 | guest_token = response.get("guest_token", None) 57 | if guest_token is None: 58 | log.error("Failed to fetch guest token") 59 | log.error(str(response)) 60 | log.error(str(self._headers)) 61 | return guest_token 62 | 63 | def reset_headers(self): 64 | self._headers = { 65 | "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36" 66 | } 67 | 68 | async def renew_session(self): 69 | await self.try_close() 70 | self._session = aiohttp.ClientSession() 71 | self.reset_headers() 72 | 73 | async def refresh_old_token(self): 74 | if self.username is not None or self.next_refresh is None or time.time() < self.next_refresh: 75 | return 76 | log.debug("Refreshing token: " + str(self._guest_token)) 77 | await self.login_guest() 78 | log.debug("New token: " + str(self._guest_token)) 79 | 80 | async def try_close(self): 81 | if self._session is not None: 82 | try: 83 | await self._session.close() 84 | except: 85 | pass 86 | 87 | async def login_guest(self): 88 | await self.renew_session() 89 | self.set_csrf_header() 90 | old_token = self._guest_token 91 | new_token = await self.get_guest_token() 92 | self._guest_token = new_token if new_token is not None else old_token 93 | if new_token is not None: 94 | self.next_refresh = time.time() + 3600 95 | self._headers['X-Guest-Token'] = self._guest_token 96 | 97 | async def login(self, username=None, password=None, cookie_dir=None): 98 | self._session = aiohttp.ClientSession() 99 | 100 | if password is not None: 101 | login_required = True 102 | cookie_file = None 103 | if cookie_dir is not None: 104 | cookie_file = os.path.join(cookie_dir, username) 105 | if os.path.isfile(cookie_file): 106 | log.info("Use cookie file for %s" % username) 107 | # satisfy linter; https://github.com/aio-libs/aiohttp/issues/4043#issuecomment-529085744 108 | assert isinstance(self._session.cookie_jar, aiohttp.CookieJar) 109 | self._session.cookie_jar.load(cookie_file) 110 | login_required = False 111 | 112 | store_cookies = True 113 | 114 | if login_required: 115 | async with self._session.get("https://twitter.com/login", headers=self._headers) as r: 116 | login_page = await r.text() 117 | form_data = {} 118 | soup = BeautifulSoup(login_page, 'html.parser') 119 | form_data["authenticity_token"] = soup.find('input', {'name': 'authenticity_token'}).get('value') 120 | form_data["session[username_or_email]"] = username 121 | form_data["session[password]"] = password 122 | form_data["remember_me"] = "1" 123 | async with self._session.post('https://twitter.com/sessions', data=form_data, headers=self._headers) as r: 124 | response = await r.text() 125 | if str(r.url) == "https://twitter.com/": 126 | log.info("Login of %s successful" % username) 127 | else: 128 | store_cookies = False 129 | log.info("Error logging in %s (%s)" % (username, r.url)) 130 | log.debug("ERROR PAGE\n" + response) 131 | else: 132 | async with self._session.get('https://twitter.com', headers=self._headers) as r: 133 | await r.text() 134 | 135 | self.set_csrf_header() 136 | self.username = username 137 | 138 | if cookie_file is not None and store_cookies: 139 | # satisfy linter; https://github.com/aio-libs/aiohttp/issues/4043#issuecomment-529085744 140 | assert isinstance(self._session.cookie_jar, aiohttp.CookieJar) 141 | self._session.cookie_jar.save(cookie_file) 142 | 143 | else: 144 | await self.login_guest() 145 | 146 | self._headers['Authorization'] = 'Bearer ' + self.twitter_auth_key 147 | 148 | async def get(self, url, retries=0): 149 | self.set_csrf_header() 150 | await self.refresh_old_token() 151 | try: 152 | async with self._session.get(url, headers=self._headers) as r: 153 | result = await r.json() 154 | except Exception as e: 155 | log.error("EXCEPTION: %s", str(type(e))) 156 | if self.username is None: 157 | await self.login_guest() 158 | raise e 159 | if self.username is None and self.remaining < 10 or is_error(result, 88) or is_error(result, 239): 160 | await self.login_guest() 161 | if retries > 0 and is_error(result, 353): 162 | return await self.get(url, retries - 1) 163 | if is_error(result, 326): 164 | self.locked = True 165 | return result 166 | 167 | async def search_raw(self, query, live=True): 168 | additional_query = "" 169 | if live: 170 | additional_query = "&tweet_search_mode=live" 171 | return await self.get("https://api.twitter.com/2/search/adaptive.json?q="+urllib.parse.quote(query)+"&count=20&spelling_corrections=0" + additional_query) 172 | 173 | async def profile_raw(self, username): 174 | return await self.get("https://api.twitter.com/1.1/users/show.json?screen_name=" + urllib.parse.quote(username)) 175 | 176 | async def get_profile_tweets_raw(self, user_id): 177 | return await self.get("https://api.twitter.com/2/timeline/profile/" + str(user_id) +".json?include_tweet_replies=1&include_want_retweets=0&include_reply_count=1&count=1000") 178 | 179 | async def tweet_raw(self, tweet_id, count=20, cursor=None): 180 | if cursor is None: 181 | cursor = "" 182 | else: 183 | cursor = "&cursor=" + urllib.parse.quote(cursor) 184 | return await self.get("https://api.twitter.com/2/timeline/conversation/" + tweet_id + ".json?include_reply_count=1&send_error_codes=true&count="+str(count)+ cursor) 185 | 186 | async def test(self, username): 187 | result: dict[str, Any] = {"timestamp": time.time()} 188 | user_id, profile = await test_profile(self, username) 189 | result["profile"] = profile 190 | 191 | if not profile["exists"] or profile.get("suspended", False) or profile.get("protected", False) or not profile.get('has_tweets'): 192 | return result 193 | 194 | result["tests"] = {} 195 | 196 | search_raw = await self.search_raw("from:@" + username) 197 | 198 | result["tests"]["search"] = False 199 | try: 200 | tweets = search_raw["globalObjects"]["tweets"] 201 | for tweet_id, _ in sorted(tweets.items(), key=lambda t: t[1]["id"], reverse=True): 202 | result["tests"]["search"] = str(tweet_id) 203 | break 204 | 205 | except (KeyError, IndexError): 206 | pass 207 | 208 | result["tests"]["typeahead"] = await test_typeahead(self, username) 209 | 210 | if "search" in result["tests"] and result["tests"]["search"] == False: 211 | result["tests"]["ghost"] = await test_ghost_ban(self, user_id) 212 | else: 213 | result["tests"]["ghost"] = {"ban": False} 214 | 215 | if not get_nested(result, ["tests", "ghost", "ban"], False): 216 | result["tests"]["more_replies"] = await test_reply_deboosting(self, user_id, profile['screen_name']) 217 | else: 218 | result["tests"]["more_replies"] = { "error": "EISGHOSTED"} 219 | 220 | log.debug('[' + profile['screen_name'] + '] Writing result to DB') 221 | return result 222 | 223 | 224 | async def close(self): 225 | await self._session.close() 226 | 227 | # unused 228 | def next_session(): 229 | def key(s): 230 | remaining_time = s.reset - time.time() 231 | if s.remaining <= 3 and remaining_time > 0: 232 | return 900 233 | return remaining_time 234 | sessions = sorted([s for s in TwitterSession.account_sessions if not s.locked], key=key) 235 | if len(sessions) > 0: 236 | return sessions[0] 237 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Defintions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . 676 | --------------------------------------------------------------------------------