aaribaud
/
mastoboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial release 

This is the initial release of mastoboost.

Average complexity: B (5.153846153846154)
This commit is contained in:
Albert ARIBAUD 2023-06-11 20:39:03 +02:00
parent 509d1e2a4d
commit 37da97d88d
5 changed files with 1822 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

171
LICENSE Normal file
View File

@ -0,0 +1,171 @@
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
Section 1 – Definitions.
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
c. BY-NC-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution, NonCommercial, and ShareAlike.
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
k. NonCommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange.
l. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
m. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
n. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
Section 2 – Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and
B. produce, reproduce, and Share Adapted Material for NonCommercial purposes only.
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
3. Term. The term of this Public License is specified in Section 6(a).
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
5. Downstream recipients.
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this Public License.
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes.
Section 3 – License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified form), You must:
A. retain the following if it is supplied by the Licensor with the Licensed Material:
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of warranties;
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-NC-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
Section 4 – Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only;
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
Section 5 – Disclaimer of Warranties and Limitation of Liability.
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
Section 6 – Term and Termination.
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
Section 7 – Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
Section 8 – Interpretation.
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
Creative Commons may be contacted at creativecommons.org.

26
Pipfile Normal file
View File

@ -0,0 +1,26 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
pytz = "*"
click = "*"
"mastodon.py" = "*"
lingua-language-detector = "*"
html2text = "*"
[dev-packages]
mypy = "*"
black = "*"
prospector = "*"
bandit = "*"
coverage = "*"
pytest = "*"
pytest-mock = "*"
radon = "*"
pytest-vulture = "*"
types-pytz = "*"
[requires]
python_version = "3.9"

1045
Pipfile.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

125
README.md Normal file
View File

@ -0,0 +1,125 @@
# Mastoboost
![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)
Mastoboost is licensed under CC-BY-NC-SA 4.0. See LICENSE file for details.
## Introduction
Mastoboost is a specialized Mastodon bot which favourites and reblogs statuses which contain
a given hashtag.
As this is a bot, do make sure that bot accounts are allowed by Mastodon instance which
Mastoboost will use, and that the account it uses clearly states that it is a bot account.
## Restrictions
### Time restriction
Mastoboost is designed to be run in batches rather than as a daemon. As hashtag timelines
may grow indefinitely long, a single Mastoboost execution could run indefinitely too.
In order to avoid this, Mastoboost has the `--hours` option, which restricts how far back in
hours it can go back on the timeline; statuses older that this many hours will be ignored.
By default Mastoboost has a 24 hours limit. It may or may not be appropriate for your use
case, but remember that as it crawls further back in time, it will run longer and use more
resources from the instance it queries. This may lead to the instance throttling Mastoboost,
or even disabling the accout it uses!
### Self-restriction
If Mastoboost sees a status that the account has already favourited and reblogged, it
will stop there even if the time restriction has not been met. This allows Mastoboost
to detect when it has already processed a status, thus when
it can confidently stop.
You can bypass this behavior explicitly with `--diligent`.
### Language restriction
By default Mastoboost does not care about languages.
However, it is possible to restrict it to some specific language(s) by specifying
at least one `--lang LL` option where LL is the language's two-letter designation, such
as en or fr.
It is also possible to exclude one or more languages, instead of restricting, by specifying
option `--lang-exclude` alongside `--lang` option(s).
There is no way to both specify some languages and exclude others, as it amounts to
specifying the difference between the two lists of languages.
## Reverse run
You can run Mastoboost with its usual arguments plus `--reverse`.
This will make it unfavourite and unreblog instead of favouriting and reblogging. It is
intended for instance to correct a wrong run.
*NOTE: when under `--reverse`, language restrictions do not apply, so that a previous run
with wrong language settings can be undone.*
## Dry run
You can run Mastoboost with its usual arguments (including `--reverse`) plus `--dry-run`.
This will prevent Mastodon from actually favouriting and reblogging (or, if under
`--reverse`, from unfavouriting and unblogging).
Together with `--log-level`, it can be used to analyze the decisions of Mastoboost and
assess which statuses it would actually operate on.
## Requirements
To use this bot, you'll need a computer which:
- is connected to the Internet
- runs Python 3 (3.9 tested, might work with earlier versions)
- can run periodic tasks (e.g., a Linux machine with a cron daemon)
- has pipenv installed, or lets you install it
If you need to install pipenv yourself, run
pip install pipenv
## Installation
You can either clone this repository or simply create an empty directory and copy the
following files in it:
Pipfile
Pipfile.lock
src/mastoboost.py
In either case, go to the directory which contains `Pipfile` and run
`pipenv sync`
This will guarantee that your installation uses the versions of the dependencies that
the project uses.
If you want to try the newest dependencies, instead of `pipenv sync` you can run
`pipenv install`
## Development
The Pipfile lists the development dependencies. You can `pipenv sync -d` (or
`pipenv install -d`) to install them.
Before committing, the code should be run through
`pipenv run black src/*.py`
`pipenv run prospector -w bandit -w vulture -w mypy src/*.py`
It should show 0 messages found.
The code should also be run through
`pipenv run radon cc -s --total-average src/*.py`
New commits should always have an average complexity at most equal to that of their
parent commit.
## END OF THIS README

455
src/mastoboost.py Normal file
View File

@ -0,0 +1,455 @@
"""
A simple bot that favs and reblogs Mastodon statuses which contain a given tag.
The simplest way to use it is to run a cron job that executes:
`pipenv run python src/mastoboost.py BASE_URL TOKEN USERNAME HASHTAG`
Where
BASE_URL is the base URL of the Mastodon instance of the account used by the bot
TOKEN is the application token provided by the account used by the bot
USERNAME is the username of the account used by the bot
HASHTAG is the hashtag (without the '#' sign) which the bot must watch
HOURS determines how far back in time the bot will look for statuses
Options are:
--hours H: stop fetching when a status is met which is more that H hours old
--lang LL: select only statuses written in the LL language (LL=en, fr, etc.).
Example: --lang en
Can be repeated, e.g. --lang en --lang fr
--lang-exclude: instead of requesting languages, --lang excludes exclude them.
--guess-lang: try to guess the status language from its content rather than trust
its language attribute.
--reverse: actually unfavourite and unreblog (do not care about language then).
(otherwise favourite and reblog if not already done)
--dry-run: do not actually (un)favourite or (un)reblog
--log-level: set the logging level (DEBUG, INFO, WARNING, etc)
An additional level is provided: NOTICE, which is between INFO and DEBUG
"""
import logging
from datetime import datetime
import click
from mastodon import Mastodon # type: ignore
from pytz import utc
from lingua import Language, LanguageDetectorBuilder
from html2text import html2text
def _logging_setup(log_level_name):
"""
Set up logging and return the new NOTICE log level.
"""
# Add the "NOTICE" level in between INFO and DEBUG, as we want a level that is more
# verbose than INFO but will not let other modules display their own logs.
log_level_notice = (logging.INFO + logging.DEBUG) // 2
logging.addLevelName(log_level_notice, "NOTICE")
# See which level we were asked.
# Yes, despite the name, getLevelName actually also converts string to int!
log_level_int = logging.getLevelName(log_level_name)
# Customize the logging format and level.
logging.basicConfig(format="%(levelname)s: %(message)s", level=log_level_int)
if log_level_int != logging.INFO:
logging.log(log_level_notice, "Set log level to %s", log_level_name)
# Return the NOTICE log level
return log_level_notice
def get_status_language(status, detector, log_level_notice):
"""
Get the status language, using the lingua detector if provided.
"""
# If asked to guess...
if detector:
# Extract the status content
content = status["content"]
# Remove HTML
content_text = html2text(content)
# Detect language
lingua_language = detector.detect_language_of(content_text)
# Override
if lingua_language == Language.ENGLISH:
language = "en"
elif lingua_language == Language.FRENCH:
language = "fr"
else:
language = "unknown"
logging.log(
log_level_notice,
"Guessing language %s for %s",
language,
status["url"],
)
else:
# Check the status language attribute (although it may be wrong...)
language = status["language"]
logging.log(
log_level_notice,
"Taking language %s from %s",
language,
status["url"],
)
return language
def status_age_in_hours(reference, status):
"""
Return the age of a status in hours relative to the reference datetime passed.
"""
return int((reference - status["created_at"]).total_seconds() // 3600)
def fetch_recent_statuses(session, hashtag, hours, lazy, log_level_notice):
"""
Query a session for statuses with hashtag, hours old at most, or less if lazy.
"""
# Keep track of selected statuses
fetched_statuses = []
fetched_total = 0
# Get the first page of the hashtag's timeline, from newer to older.
statuses = session.timeline_hashtag(hashtag)
# While we have statuses in the current page.
while statuses:
# Process next status, from newer to older.
status = statuses.pop(0)
# Break when reaching an old enough status
if status_age_in_hours(datetime.now(utc), status) > hours:
logging.log(
log_level_notice,
"Stopping at %s dated %s",
status["url"],
status["created_at"],
)
break
# Unless told to be diligent, we can stop at the first status which is already
# favourited and reblogged.
if lazy:
if status["favourited"] and status["reblogged"]:
logging.log(
log_level_notice,
"Stopping at %s%s%s.",
status["url"],
", favourited" if status["favourited"] else "",
", reblogged" if status["favourited"] else "",
)
break
# We will keep this status
fetched_statuses.append(status)
fetched_total += 1
# If we have reached the last status of this page...
if getattr(status, "_pagination_next", None):
# ... then we refresh the status list with the next page
# Using _pagination_next is the way to go, but Pylint complains about it, so...
next_page = status._pagination_next # pylint: disable=protected-access
statuses = session.fetch_next(next_page)
# Log our work, at NOTICE level to avoid being to noisy.
logging.log(
log_level_notice,
"Fetched %d status%s",
fetched_total,
"es" if fetched_total != 1 else "",
)
# Return fetched statuses (newer first)
return fetched_statuses
def filter_statuses_by_language(
statuses, lang, lang_exclude, guess_lang, log_level_notice
):
"""
Filter statuses based on language(s) required or forbidden
"""
# If we are to guess languages, then we need lingua (but it'll use more resources)
if guess_lang:
languages = [Language.ENGLISH, Language.FRENCH]
detector = LanguageDetectorBuilder.from_languages(*languages).build()
else:
detector = None
# Keep track of selected statuses
filtered_statuses = []
# Keep count of how many statuses we considered.
statuses_considered = 0
statuses_filtered = 0
# While we have statuses...
while statuses:
# Process next status, from newer to older.
status = statuses.pop(0)
# One more status considered.
statuses_considered += 1
# Determine status language.
status_language = get_status_language(status, detector, log_level_notice)
# Were any languages specified?
if lang:
# Do we look to restrict to, or exclude, some languages?
if lang_exclude:
# Looking to exclude some languages.
if status_language in lang:
# Status is one of the excluded languages, so skip it.
continue
else:
# Looking to restrict to some languages
if status_language not in lang:
# Status is not in any of the restricted languages, so skip it.
continue
# If we've come this far, then the status should be kept
filtered_statuses.append(status)
statuses_filtered += 1
# Log a tally of what we found, at notice level because we will also log actual
# statuses processed later.
logging.log(
log_level_notice,
"Filtered %d status%s by language out of %d",
statuses_filtered,
"es" if statuses_filtered != 1 else "",
statuses_considered,
)
# Return selected statuses (newer first)
return filtered_statuses
def status_should_be_processed(status, reverse):
"""
Check if status should be (un)favourited or un(reblogged) or both.
"""
should_be_processed = False
# Extract the status attributes we will need (content is not always needed!)
favourited = status["favourited"]
reblogged = status["reblogged"]
# Are we looking to reverse past actions?
if reverse:
# If we favourited or reblogged a status -- regardless of language!
if favourited or reblogged:
# Select it for unva/unreblog
should_be_processed = True
# Are we looking to act on recent statuses?
else:
# Select this status if it needs favouriting or reblogging
if (not favourited) or (not reblogged):
should_be_processed = True
# Return whether status should be processed
return should_be_processed
def eligible_statuses(statuses, reverse, log_level_notice):
"""
Return sublist of statuses which are elegibile on lang_en and reverse criteria.
"""
# Keep track of selected statuses
selected_statuses = []
# Keep count of how many statuses we considered.
statuses_considered = 0
statuses_selected = 0
# While we have statuses...
while statuses:
# Process next status, from newer to older.
status = statuses.pop(0)
# One more status considered
statuses_considered += 1
# Should we (un)favourite or (un)reblog this status?
if status_should_be_processed(status, reverse):
# ... then select it
selected_statuses.append(status)
statuses_selected += 1
# Log a tally of what we found, at notice level because we will also log actual
# statuses processed later.
logging.log(
log_level_notice,
"Found %d eligible status%s out of %d",
statuses_selected,
"es" if statuses_selected != 1 else "",
statuses_considered,
)
# Return selected statuses (newer first)
return selected_statuses
def favourite_and_reblog_status(session, status, dry_run):
# Favourite status if it was not
do_favourite = not status["favourited"]
if do_favourite:
logging.info(
"%s %s", "Would favourite" if dry_run else "Favouriting", status["url"]
)
if not dry_run:
session.status_favourite(status["id"])
# Reblog status if it was not
do_reblog = not status["reblogged"]
if do_reblog:
logging.info(
"%s %s", "Would reblog" if dry_run else "Reblogging", status["url"]
)
if not dry_run:
session.status_reblog(status["id"])
return (do_favourite, do_reblog)
def unfavourite_and_unreblog_status(session, status, dry_run):
# Unfavourite status if it was
do_unfavourite = status["favorited"]
if do_unfavourite:
logging.info(
"%s %s", "Would unfavourite" if dry_run else "Unfavouriting", status["url"]
)
if not dry_run:
session.status_unfavourite(status["id"])
# Unreblog status if it was
do_unreblog = status["reblogged"]
if do_unreblog:
logging.info(
"%s %s", "Would unreblog" if dry_run else "Unreblogging", status["url"]
)
if not dry_run:
session.status_unreblog(status["id"])
return (do_unfavourite, do_unreblog)
def process_single_status(session, status, reverse, dry_run):
"""
Favourite and reblog (or the reverse) a status from a session.
Return a pair of booleans to indicate what was done
"""
# Are we looking to undo past actions?
if reverse:
# Return whether we unfavourited or unreblogged (or would have done if dry_run)
return unfavourite_and_unreblog_status(session, status, dry_run)
# We are not undoing a past action.
# Return whether we favourited or reblogged (or would have done if dry_run)
return favourite_and_reblog_status(session, status, dry_run)
def process_statuses(session, statuses, reverse, dry_run):
"""
Favourite and reblog (or the reverse) a list of statuses from a session.
"""
# Keep tallies of what we do.
total_un_favourites = 0
total_un_reblogs = 0
statuses_processed = 0
# As long as there are statuses left to process...
while statuses:
# Extract the oldest status.
status = statuses.pop()
# Process the status.
(favourite, reblog) = process_single_status(session, status, reverse, dry_run)
# We handled one more status.
statuses_processed += 1
if favourite:
total_un_favourites += 1
if reblog:
total_un_reblogs += 1
# Log tallies
logging.info(
"%s %d status%s, %d %s, %d %s.",
"Would process" if dry_run else "Processed",
statuses_processed,
"es" if statuses_processed != 1 else "",
total_un_favourites,
"unfavourited" if reverse else "favourited",
total_un_reblogs,
"unreblogged" if reverse else "reblogged",
)
def _start_session(base_url, token, username):
"""
Create a bot, checking the actual session unsername against the provided one.
"""
# Create the session as a Mastodon class instance
session = Mastodon(access_token=token, api_base_url=base_url)
# Abort if the session username does not match the specified username
token_username = session.me()["username"]
if username != token_username:
raise ValueError(
f"Username '{username}' does not match token username '{token_username}'!"
)
# Return the session
return session
# Main command and its options.
@click.command()
# The base URL of the instance the bot should talk to.
@click.argument("base-url")
# The application token, and the username as a double identity check.
@click.argument("token")
@click.argument("username")
# The hashtag, hours past, language selection and language detection modes.
@click.argument("hashtag")
@click.option(
"--hours", help="Ignore statuses older than this in hours", type=int, default=24
)
@click.option(
"--diligent",
is_flag=True,
help="Do not stop at apparently already processed statuses",
)
@click.option(
"--lang",
help="Restrict Mastodon to some specific language(es)",
multiple=True,
)
@click.option(
"--lang-exclude",
is_flag=True,
help="Make --lang exclude, rather than include, languages",
)
@click.option(
"--guess-lang", is_flag=True, help="Guess the status language from its text"
)
# To unfavoutite / unreblog rather than favourite / reblog.
@click.option("--reverse", is_flag=True, help="Unfav/unreglob rather than fav/reblog")
# To refrain from (un)favouriting / (un)reblogging.
@click.option("--dry-run", is_flag=True, help="Do not actually (un)fav or (un)reblog")
# To change the log level.
@click.option(
"--log-level", help="Log level (logging module, plus NOTICE)", default="INFO"
)
# Click requires the function to have as many arguments as there are options,
# but pylint does not know that and complains, so...
def main( # pylint: disable=too-many-arguments
base_url,
token,
username,
hashtag,
hours,
diligent,
lang,
lang_exclude,
guess_lang,
reverse,
dry_run,
log_level,
):
"""
The main mastoboost command.
"""
# Check contradictory options
if lang_exclude and not lang:
raise ValueError(
"Option --lang-exclude is meaningless without at least one --lang option",
)
# Set up logging with the requested logging level
log_level_notice = _logging_setup(log_level)
# Start the Mastodon session
session = _start_session(base_url, token, username)
# Fetch the statuses we might process
statuses = fetch_recent_statuses(
session, hashtag, hours, diligent and not reverse, log_level_notice
)
# Filter status by language if requested
if lang and not reverse:
statuses = filter_statuses_by_language(
statuses, lang, lang_exclude, guess_lang, log_level_notice
)
# Keep only the eligible ones
statuses = eligible_statuses(statuses, reverse, log_level_notice)
# Process eligible statuses unless told not to.
process_statuses(session, statuses, reverse, dry_run)
if __name__ == "__main__":
# Click provides the parameters, but pylint does not know that, so...
main() # pylint: disable=no-value-for-parameter