I was not aware that SPDX-FileContributor existed before.

This should fix #61 and #56.

Please consult https://reuse.software/ for more information.

Particular caution was exercised with the files in
`OnionSproutsBot/plugins`, which mostly contain excerpts taken
from other files so as to make the source code appear cleaner.

There is a non-negligible chance that I may have missed something,
despite taking at least one hour cross-examining the original sources
of different files and their contents. If this is the case, I will
try my best to amend that in a later commit.

A simple `git blame` cannot properly attribute code in these
situations, which goes on to highlight the necessity of this change,
as people are borrowing excerpts of this codebase and incorporating
it into their own projects.

Being able to figure out who generated each line of code is, in my
honest opinion, of paramount importance.

Expire cache entries after 10minutes

Closes #53

See merge request !31

And make the cache path configurable.

Closes: #53

* Add support for iOS, Android apps
* Improve documentation
* Improve code formatting
* Improve user-facing strings
* Use Pyrogram plugin system
* Use new JSON files for additional architectures
* Include additional configuration options
* Include metadata in onionsproutsbot.file
* Removed aiologger

The command used in this script now matches with the command mentioned
in CONTRIBUTING.md. It includes additional parameters, like metadata or
that option that removes line number comments, as the line numbers
change way too frequently.

A few merge requests changing some of the strings were recently
approved and merged without any further remarks, so as to not slow
down the review process, which contained many other changes that
were much more important.

We now document how a contributor is supposed to work without our
locale system, so a manual update like that should not happen again,
hopefully.

Refactoring chat functions into smart plugins

See merge request !29

Iain Learmonth authored Jan 23, 2023 and n0toose committed Apr 22, 2023

The various chat callback functions have been refactored into
three smart plugin modules: welcome, dialogue and tor_browser.

Additionally, there are no longer global variables for the
SQLite3 connection and cursor. There are no more long-lived
cursor objects and the connection object is stored in a
singleton Database class.

The configuration data has also been moved to its own module
to avoid circular imports.

typo

See merge request !30

Rollback to f4501d0a because aiologger
is giving problems communicating with journald:
https://github.com/async-worker/aiologger/issues/3.7

Closes: #47

Refactor dialogue.py

See merge request !27

The contents of this commit were generated automatically and tested.

- Apply changes from the Black code formatter
- Remove all HTML tags and other formatting options from strings
- Create new submenu for an FAQ section
- Make user-facing strings simpler and more clear
- Split certain, long strings so that changes can be made more easily
  in the future.
- Update onionsproutsbot.pot
- Alter some function names (mildly)

We do not need to run conn.commit() in `bot.py`, as we already execute
that in `database.py`.

Despite acting as a maintainer, I believe that removing the names and
keeping only my own makes it seem like I somehow declared some of these
contributions as (relatively) insignificant, which is absolutely not
the case.

The header was originally condensed because it was getting way too big
to manage and contributor(s) were insisting on not being added there,
as their contributions 'seemed too minor'.

Adding the copyright header consistently to every file, with every
name, also came across as a burden to everyone involved.

It might be best to separate buttons that are 'functional' and the
buttons that are meant to answer hypothetical questions that the user
may have.

The former two terms have been deprecated and are not used anymore.
That makes the text 'macos' show up instead. The good news is that the
bot can indeed survive the addition or the removal of platforms without
breaking.

A few merge requests changing some of the strings were recently
approved without any further comments as to not make the review process
too exhausting. This file is monitored by an external translation
service -- any updates to the file will be mirrored to that said
service.

improvement: make "Mirrors" word localizable

See merge request !25

improvement: simplify success messages

See merge request !24

This change is temporary and meant to provide some guarantees that the
bot will work right now with the default configuration. Right now, that
is, "before the release of Tor Browser 12.0 as of the time of this
writing".

After its release, this commit should be succeeded by yet another
change that uses the stable endpoint instead.

I also found it a good idea to remove the extra variable that included
a second endpoint. I had the following reasons in mind:

- It was not used.
- My plans to distribute both the stable and the alpha versions did
  not move forward, as that would worsen the user experience.
- Its initial purpose was to document the existence of the endpoint,
  but that really isn't a good way to write documentation.

This change aims to make the picture (and the hyperlink) for the photo
shown in the language menu configurable. That way, future versions of
the bot should not require additional patches when a rebrand occurs or
necessarily depend on external, cosmetic web resources to function.

The bot should still work if the user forgets to upload the .yaml file,
but, more importantly, it should also work if the hyperlink we use ever
goes down. Still, please make sure to update your .yaml file.

"Which hyperlink should I use?" is a question that I asked myself when
I included it in the first place. I found that using a permalink of a
commit on GitLab was a better idea than using the hyperlink to the
image on the website itself. I made the following assumptions to reach
that conclusion:

- The website is going to be changed and updated more often than the
  software used to host source code repositories.
- Nobody will think about this project before updating the website.
  And understandably so. We should act that way.
- I do not expect the picture in the repository to change, but I expect
  it to be replaced or moved someday.
- Using the Internet Archive to store a .png would be a bit overkill.