contrastellar/raid-callouts
1
0
Fork 0
Code Issues Pull Requests Actions Wiki Activity

Add the rest
All checks were successful
test and deploy / test (3.11.5) (push) Successful in 1m23s
Details
test and deploy / push-and-build (push) Successful in 59s
Details
Test Helper Module / test (3.11.5) (push) Successful in 1m28s
Details

Browse Source
This commit is contained in:
Gabriella Agathon
2025-10-16 14:04:02 -06:00
parent ab860b8cab
commit 3032210a85
18 changed files with 2319 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
.github/workflows/deploy.yaml vendored Normal file
View File

@@ -0,0 +1,113 @@
name: test and deploy
on:
push:
branches: [ main ]
# Set up for manual running, just in case. Can be removed later
workflow_dispatch:
jobs:
# test locally on the runner, using miniconda
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.11.5]
steps:
- uses: https://github.com/actions/checkout@v4.1.1
- name: Set up conda /w python version 3.11.5
uses: https://github.com/conda-incubator/setup-miniconda@v3.0.2
with:
miniconda-version: "latest"
activate-environment: raid-callouts
environment-file: environment.yml
python-version: 3.11.5
- name: Install dependencies
shell: bash -l {0}
run: |
conda env create --file environment.yml -n test-helper-module
conda init
conda activate test-helper-module
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: add database.ini
shell: bash -l {0}
run: |
cd $GITHUB_WORKSPACE/
touch database.ini
echo "${{ secrets.DATABASE_INI }}" >> xiv-database.ini
- name: Run tests
shell: bash -l {0}
run: |
conda activate test-helper-module
python -m pytest src/py/db_helper_tests.py
# Checkout the repo, add the dependency files, push to host, build + run (via docker compose up)
push-and-build:
runs-on: ubuntu-latest
needs: "test"
steps:
- uses: https://github.com/actions/checkout@v4
- uses: https://github.com/shimataro/ssh-key-action@v2.7.0
with:
key: ${{ secrets.HOST_PRIVATEKEY }}
known_hosts: ${{ secrets.SSH_HOST }}
- name: install rsync
run: |
apt-get update
apt-get install rsync -y
- name: add xiv database.ini
run: |
cd $GITHUB_WORKSPACE/
touch database.ini
echo "${{ secrets.DATABASE_INI }}" >> xiv-database.ini
- name: add ffxiv discord token
run: |
cd $GITHUB_WORKSPACE/
echo "${{ secrets.DISCORD_TOKEN }}" >> xiv-discord.token
- name: add dnd database.ini
run: |
cd $GITHUB_WORKSPACE/
touch database.ini
echo "${{ secrets.DND_DATABASE_INI }}" >> dnd-database.ini
- name: add dnd discord token
run: |
cd $GITHUB_WORKSPACE/
echo "${{ secrets.DND_DISCORD_TOKEN }}" >> dnd-discord.token
- name: add known hosts to runner
run: |
ssh-keyscan -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts
# This is set to continue even w/ error, because there is a chance that docker compose down doesn't completely work
- name: remove old image from host
run: |
ssh -v ${{ secrets.HOST_USER }}@${{ secrets.SSH_HOST }} "cd /home/${{ secrets.HOST_USER }}/runner/raid-callouts && docker compose down"
continue-on-error: true
- name: clean build directory on host
run: |
ssh ${{ secrets.HOST_USER }}@${{ secrets.SSH_HOST }} "rm -rdf /home/${{ secrets.HOST_USER }}/runner/raid-callouts"
continue-on-error: true
- name: deploy /w rsync to host
run: |
sudo rsync -avz $GITHUB_WORKSPACE ${{ secrets.HOST_USER }}@${{ secrets.SSH_HOST }}:/home/${{ secrets.HOST_USER }}/runner/
- name: build docker image on host + run it
run: |
ssh ${{ secrets.HOST_USER }}@${{ secrets.SSH_HOST }} "cd /home/${{ secrets.HOST_USER }}/runner/raid-callouts && docker compose up --build -d"

54
.github/workflows/test.yaml vendored Normal file
View File

@@ -0,0 +1,54 @@
name: "Test Helper Module"
on:
push:
branches:
- gabby-dev
- josh-dev
pull_request:
types: [opened]
workflow_dispatch:
jobs:
test:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
strategy:
matrix:
python-version: [3.11.5]
steps:
- uses: https://github.com/actions/checkout@v4.1.1
- name: Set up conda /w python version 3.11.5
uses: https://github.com/conda-incubator/setup-miniconda@v3.0.4
with:
miniconda-version: "latest"
activate-environment: raid-callouts
environment-file: environment.yml
python-version: 3.11.5
- name: Install dependencies
shell: bash -l {0}
run: |
conda env create --file environment.yml -n test-helper-module
conda init
conda activate test-helper-module
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: add database.ini
shell: bash -l {0}
run: |
cd $GITHUB_WORKSPACE/
touch database.ini
echo "${{ secrets.DATABASE_INI }}" >> xiv-database.ini
- name: Run tests
shell: bash -l {0}
run: |
cd $GITHUB_WORKSPACE
conda activate test-helper-module
python -m pytest ./src/py/db_helper_tests.py

26
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,26 @@
# How to contribute!
Hello! I'm glad you're reading this because hopefully it means you're going to help us create a better discord bot!
This is primarily open-source so that others can implement the code that we've written for their own use cases!
## Testing
Currently, we use GitHub actions to test the database portion of the codebase. It's a bit harder to test the Discord-centric commands otherwise.
## Submitting changes
Please send a [new GitHub Pull Request](https://github.com/contrastellar/raid-callouts/compare) with a clear list of what's been done!
When you send in a Pull Request (PR), we'll be super happy if you've made tests or otherwise commented your code clearly with what it does, and what libraries it uses in addition to our base libraries!
Please always write a clear commit message for your commits. One-line messages are fine for smaller changes, but bigger changes should be more details!
## Coding conventions
* Please take a look at our code base either on main or in the dev-branches! Once you get an idea of how we do things (generally [PEP 8](https://peps.python.org/pep-0008/)), but please feel free to fork + make any changes that fit in with our coding practices!
* There is a pretty big discrepency between the *goal* of hitting PEP 8 standards, and what we have going on, so style changes are also welcome!
* We prefer you to use `conda` for your environment management, but `pip` files for *most* things are included if you prefer! If you make edits to the base `conda` environment, please update the `environment.yml` and `requirements.txt` files accordingly!
* This is open source software, please consider writing code that is readable to people other than yourself!
## Issues and discussions on issues/PRs
Please be civil! The core contributers (contrastellar, DatJoshLife) reserve the right to remove any comments deemed inapproriate.
## Wiki contributions
The wiki for this repo serves as the main source of information with regards to onboarding anyone wishing to contribute! Please take a look at our explanation of our Postgresql back-end when writing new queries!
Any major edits that need to be made, can be brought up in ths issues tab!

621
LICENSE Normal file
View File

@@ -0,0 +1,621 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS

53
aux_Dockerfile Normal file
View File

@@ -0,0 +1,53 @@
# syntax=docker/dockerfile:1
# Comments are provided throughout this file to help you get started.
# If you need more help, visit the Dockerfile reference guide at
# https://docs.docker.com/go/dockerfile-reference/
# Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7
ARG PYTHON_VERSION=3.11.5
FROM python:${PYTHON_VERSION}-slim as base
# Prevents Python from writing pyc files.
ENV PYTHONDONTWRITEBYTECODE=1
# Keeps Python from buffering stdout and stderr to avoid situations where
# the application crashes without emitting any logs due to buffering.
ENV PYTHONUNBUFFERED=1
# Set timezone in the container
ENV TZ="America/Detroit"
WORKDIR /app
# Create a non-privileged user that the app will run under.
# See https://docs.docker.com/go/dockerfile-user-best-practices/
ARG UID=10001
RUN adduser \
--disabled-password \
--gecos "" \
--home "/nonexistent" \
--shell "/sbin/nologin" \
--no-create-home \
--uid "${UID}" \
appuser
# Download dependencies as a separate step to take advantage of Docker's caching.
# Leverage a cache mount to /root/.cache/pip to speed up subsequent builds.
# Leverage a bind mount to requirements.txt to avoid having to copy them into
# into this layer.
RUN --mount=type=cache,target=/root/.cache/pip \
--mount=type=bind,source=requirements.txt,target=requirements.txt \
python -m pip install -r requirements.txt
# Switch to the non-privileged user to run the application.
USER appuser
# Copy the source code into the container.
COPY . .
# Expose the port that the application listens on.
EXPOSE 8000
CMD ["python3", "src/py/bot_aux.py", "xiv-database.ini", "xiv-discord.token", "865781604881530940", "888844785274724362"]

10
compose.yaml Normal file
View File

@@ -0,0 +1,10 @@
services:
xiv-listener:
build:
context: .
dockerfile: core_Dockerfile
xiv-poster:
build:
context: .
dockerfile: aux_Dockerfile

53
core_Dockerfile Normal file
View File

@@ -0,0 +1,53 @@
# syntax=docker/dockerfile:1
# Comments are provided throughout this file to help you get started.
# If you need more help, visit the Dockerfile reference guide at
# https://docs.docker.com/go/dockerfile-reference/
# Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7
ARG PYTHON_VERSION=3.11.5
FROM python:${PYTHON_VERSION}-slim as base
# Prevents Python from writing pyc files.
ENV PYTHONDONTWRITEBYTECODE=1
# Keeps Python from buffering stdout and stderr to avoid situations where
# the application crashes without emitting any logs due to buffering.
ENV PYTHONUNBUFFERED=1
# Set timezone in the container
ENV TZ="America/Detroit"
WORKDIR /app
# Create a non-privileged user that the app will run under.
# See https://docs.docker.com/go/dockerfile-user-best-practices/
ARG UID=10001
RUN adduser \
--disabled-password \
--gecos "" \
--home "/nonexistent" \
--shell "/sbin/nologin" \
--no-create-home \
--uid "${UID}" \
appuser
# Download dependencies as a separate step to take advantage of Docker's caching.
# Leverage a cache mount to /root/.cache/pip to speed up subsequent builds.
# Leverage a bind mount to requirements.txt to avoid having to copy them into
# into this layer.
RUN --mount=type=cache,target=/root/.cache/pip \
--mount=type=bind,source=requirements.txt,target=requirements.txt \
python -m pip install -r requirements.txt
# Switch to the non-privileged user to run the application.
USER appuser
# Copy the source code into the container.
COPY . .
# Expose the port that the application listens on.
EXPOSE 8000
CMD ["python3", "src/py/bot_core.py", "xiv-database.ini", "xiv-discord.token", "865781604881530940", "888844785274724362"]

49
environment.yml Normal file
View File

@@ -0,0 +1,49 @@
name: raid-callouts
channels:
- defaults
dependencies:
- astroid=3.2.4
- brotli-python=1.0.9
- bzip2=1.0.8
- ca-certificates=2025.9.9
- charset-normalizer=2.0.4
- dill=0.3.8
- idna=3.7
- isort=5.13.2
- libcxx=14.0.6
- libffi=3.4.4
- mccabe=0.7.0
- ncurses=6.4
- openssl=3.0.17
- pip=23.3.1
- pysocks=1.7.1
- python=3.11.5
- readline=8.2
- sqlite=3.41.2
- tk=8.6.12
- tomlkit=0.13.2
- tzdata=2024a
- wheel=0.41.2
- xz=5.4.6
- zlib=1.2.13
- pip:
- aiohappyeyeballs==2.4.4
- aiohttp==3.11.11
- aiosignal==1.3.1
- attrs==23.2.0
- certifi==2024.12.14
- discord-py==2.4.0
- frozenlist==1.4.1
- iniconfig==2.0.0
- multidict==6.0.5
- packaging==24.1
- platformdirs==4.2.2
- pluggy==1.5.0
- propcache==0.2.1
- psycopg2-binary==2.9.9
- pylint==3.2.6
- pytest==8.2.2
- requests==2.32.5
- setuptools==80.9.0
- urllib3==2.5.0
- yarl==1.18.3

25
makefile Normal file
View File

@@ -0,0 +1,25 @@
core_path = src/py/bot_core.py
aux_path = src/py/bot_aux.py
db_helper_path = src/py/helper/db_helper.py
db_tests_path = src/py/db_helper_tests.py
compose_up:
docker compose up --build
compose_up_dev:
docker compose --file "dev-compose.yaml" up --build
clean:
docker compose down
run_listener:
python $(core_path) xiv-database.ini xiv-discord.token 477298331777761280 927271992216920146
run_linter:
pylint --rcfile pylint.toml $(core_path) $(aux_path) $(db_helper_path)
run_tests:
pytest $(db_tests_path)
generate_backup:
tar cvf backups/"backup-"$$(date -Idate).tar .

547
pylint.toml Normal file
View File

@@ -0,0 +1,547 @@
[tool.pylint.main]
# Analyse import fallback blocks. This can be used to support both Python 2 and 3
# compatible code, which means that the block might have code that exists only in
# one or another interpreter, leading to false positives when analysed.
# analyse-fallback-blocks =
# Clear in-memory caches upon conclusion of linting. Useful if running pylint in
# a server-like mode.
# clear-cache-post-run =
# Always return a 0 (non-error) status code, even if lint errors are found. This
# is primarily useful in continuous integration scripts.
# exit-zero =
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code.
# extension-pkg-allow-list =
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
# for backward compatibility.)
# extension-pkg-whitelist =
# Return non-zero exit code if any of these messages/categories are detected,
# even if score is above --fail-under value. Syntax same as enable. Messages
# specified are enabled, while categories only check already-enabled messages.
# fail-on =
# Specify a score threshold under which the program will exit with error.
fail-under = 10
# Interpret the stdin as a python script, whose filename needs to be passed as
# the module_or_package argument.
# from-stdin =
# Files or directories to be skipped. They should be base names, not paths.
ignore = ["CVS"]
# Add files or directories matching the regular expressions patterns to the
# ignore-list. The regex matches against paths and can be in Posix or Windows
# format. Because '\\' represents the directory delimiter on Windows systems, it
# can't be used as an escape character.
# ignore-paths =
# Files or directories matching the regular expression patterns are skipped. The
# regex matches against base names, not paths. The default value ignores Emacs
# file locks
ignore-patterns = ["^\\.#"]
# List of module names for which member attributes should not be checked and will
# not be imported (useful for modules/projects where namespaces are manipulated
# during runtime and thus existing member attributes cannot be deduced by static
# analysis). It supports qualified module names, as well as Unix pattern
# matching.
# ignored-modules =
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
# init-hook =
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
# number of processors available to use, and will cap the count on Windows to
# avoid hangs.
jobs = 1
# Control the amount of potential inferred values when inferring a single object.
# This can help the performance when dealing with large functions or complex,
# nested conditions.
limit-inference-results = 100
# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
# load-plugins =
# Pickle collected data for later comparisons.
persistent = true
# Resolve imports to .pyi stubs if available. May reduce no-member messages and
# increase not-an-iterable messages.
# prefer-stubs =
# Minimum Python version to use for version dependent checks. Will default to the
# version used to run pylint.
py-version = "3.11.5"
# Discover python modules and packages in the file system subtree.
# recursive =
# Add paths to the list of the source roots. Supports globbing patterns. The
# source root is an absolute path or a path relative to the current working
# directory used to determine a package namespace for modules located under the
# source root.
# source-roots =
# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
suggestion-mode = true
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
# unsafe-load-any-extension =
[tool.pylint.basic]
# Naming style matching correct argument names.
argument-naming-style = "snake_case"
# Regular expression matching correct argument names. Overrides argument-naming-
# style. If left empty, argument names will be checked with the set naming style.
# argument-rgx =
# Naming style matching correct attribute names.
attr-naming-style = "snake_case"
# Regular expression matching correct attribute names. Overrides attr-naming-
# style. If left empty, attribute names will be checked with the set naming
# style.
# attr-rgx =
# Bad variable names which should always be refused, separated by a comma.
bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata"]
# Bad variable names regexes, separated by a comma. If names match any regex,
# they will always be refused
# bad-names-rgxs =
# Naming style matching correct class attribute names.
class-attribute-naming-style = "any"
# Regular expression matching correct class attribute names. Overrides class-
# attribute-naming-style. If left empty, class attribute names will be checked
# with the set naming style.
# class-attribute-rgx =
# Naming style matching correct class constant names.
class-const-naming-style = "UPPER_CASE"
# Regular expression matching correct class constant names. Overrides class-
# const-naming-style. If left empty, class constant names will be checked with
# the set naming style.
# class-const-rgx =
# Naming style matching correct class names.
class-naming-style = "PascalCase"
# Regular expression matching correct class names. Overrides class-naming-style.
# If left empty, class names will be checked with the set naming style.
# class-rgx =
# Naming style matching correct constant names.
const-naming-style = "UPPER_CASE"
# Regular expression matching correct constant names. Overrides const-naming-
# style. If left empty, constant names will be checked with the set naming style.
# const-rgx =
# Minimum line length for functions/classes that require docstrings, shorter ones
# are exempt.
docstring-min-length = -1
# Naming style matching correct function names.
function-naming-style = "snake_case"
# Regular expression matching correct function names. Overrides function-naming-
# style. If left empty, function names will be checked with the set naming style.
# function-rgx =
# Good variable names which should always be accepted, separated by a comma.
good-names = ["i", "j", "k", "ex", "Run", "_"]
# Good variable names regexes, separated by a comma. If names match any regex,
# they will always be accepted
# good-names-rgxs =
# Include a hint for the correct naming format with invalid-name.
# include-naming-hint =
# Naming style matching correct inline iteration names.
inlinevar-naming-style = "any"
# Regular expression matching correct inline iteration names. Overrides
# inlinevar-naming-style. If left empty, inline iteration names will be checked
# with the set naming style.
# inlinevar-rgx =
# Naming style matching correct method names.
method-naming-style = "snake_case"
# Regular expression matching correct method names. Overrides method-naming-
# style. If left empty, method names will be checked with the set naming style.
# method-rgx =
# Naming style matching correct module names.
module-naming-style = "snake_case"
# Regular expression matching correct module names. Overrides module-naming-
# style. If left empty, module names will be checked with the set naming style.
# module-rgx =
# Colon-delimited sets of names that determine each other's naming style when the
# name regexes allow several styles.
# name-group =
# Regular expression which should only match function or class names that do not
# require a docstring.
no-docstring-rgx = "^_"
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties. These
# decorators are taken in consideration only for invalid-name.
property-classes = ["abc.abstractproperty"]
# Regular expression matching correct type alias names. If left empty, type alias
# names will be checked with the set naming style.
# typealias-rgx =
# Regular expression matching correct type variable names. If left empty, type
# variable names will be checked with the set naming style.
# typevar-rgx =
# Naming style matching correct variable names.
variable-naming-style = "snake_case"
# Regular expression matching correct variable names. Overrides variable-naming-
# style. If left empty, variable names will be checked with the set naming style.
# variable-rgx =
[tool.pylint.classes]
# Warn about protected attribute access inside special methods
# check-protected-access-in-special-methods =
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods = ["__init__", "__new__", "setUp", "asyncSetUp", "__post_init__"]
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected = ["_asdict", "_fields", "_replace", "_source", "_make", "os._exit"]
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg = ["cls"]
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg = ["mcs"]
[tool.pylint.design]
# List of regular expressions of class ancestor names to ignore when counting
# public methods (see R0903)
# exclude-too-few-public-methods =
# List of qualified class names to ignore when counting class parents (see R0901)
# ignored-parents =
# Maximum number of arguments for function / method.
max-args = 5
# Maximum number of attributes for a class (see R0902).
max-attributes = 7
# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr = 5
# Maximum number of branch for function / method body.
max-branches = 12
# Maximum number of locals for function / method body.
max-locals = 15
# Maximum number of parents for a class (see R0901).
max-parents = 7
# Maximum number of public methods for a class (see R0904).
max-public-methods = 20
# Maximum number of return / yield for function / method body.
max-returns = 6
# Maximum number of statements in function / method body.
max-statements = 50
# Minimum number of public methods for a class (see R0903).
min-public-methods = 2
[tool.pylint.exceptions]
# Exceptions that will emit a warning when caught.
overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]
[tool.pylint.format]
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
# expected-line-ending-format =
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines = "^\\s*(# )?<?https?://\\S+>?$"
# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren = 4
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string = " "
# Maximum number of characters on a single line.
max-line-length = 512
# Maximum number of lines in a module.
max-module-lines = 1000
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
# single-line-class-stmt =
# Allow the body of an if to be on the same line as the test if there is no else.
# single-line-if-stmt =
[tool.pylint.imports]
# List of modules that can be imported at any level, not just the top level one.
# allow-any-import-level =
# Allow explicit reexports by alias from a package __init__.
# allow-reexport-from-package =
# Allow wildcard imports from modules that define __all__.
# allow-wildcard-with-all =
# Deprecated modules which should not be used, separated by a comma.
# deprecated-modules =
# Output a graph (.gv or any supported image format) of external dependencies to
# the given file (report RP0402 must not be disabled).
# ext-import-graph =
# Output a graph (.gv or any supported image format) of all (i.e. internal and
# external) dependencies to the given file (report RP0402 must not be disabled).
# import-graph =
# Output a graph (.gv or any supported image format) of internal dependencies to
# the given file (report RP0402 must not be disabled).
# int-import-graph =
# Force import order to recognize a module as part of the standard compatibility
# libraries.
# known-standard-library =
# Force import order to recognize a module as part of a third party library.
known-third-party = ["enchant"]
# Couples of modules and preferred modules, separated by a comma.
# preferred-modules =
[tool.pylint.logging]
# The type of string formatting that logging methods do. `old` means using %
# formatting, `new` is for `{}` formatting.
logging-format-style = "old"
# Logging modules to check that the string format arguments are in logging
# function parameter format.
logging-modules = ["logging"]
[tool.pylint."messages control"]
# Only show warnings with the listed confidence levels. Leave empty to show all.
# Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
confidence = ["HIGH", "CONTROL_FLOW", "INFERENCE", "INFERENCE_FAILURE", "UNDEFINED"]
# Disable the message, report, category or checker with the given id(s). You can
# either give multiple identifiers separated by comma (,) or put this option
# multiple times (only on the command line, not in the configuration file where
# it should appear only once). You can also use "--disable=all" to disable
# everything first and then re-enable specific checks. For example, if you want
# to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use "--disable=all --enable=classes
# --disable=W".
disable = ["raw-checker-failed", "bad-inline-option", "locally-disabled", "file-ignored", "suppressed-message", "useless-suppression", "deprecated-pragma", "use-symbolic-message-instead", "use-implicit-booleaness-not-comparison-to-string", "use-implicit-booleaness-not-comparison-to-zero"]
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where it
# should appear only once). See also the "--disable" option for examples.
# enable =
[tool.pylint.method_args]
# List of qualified names (i.e., library.method) which require a timeout
# parameter e.g. 'requests.api.get,requests.api.post'
timeout-methods = ["requests.api.delete", "requests.api.get", "requests.api.head", "requests.api.options", "requests.api.patch", "requests.api.post", "requests.api.put", "requests.api.request"]
[tool.pylint.miscellaneous]
# List of note tags to take in consideration, separated by a comma.
notes = ["FIXME", "XXX", "TODO"]
# Regular expression of note tags to take in consideration.
# notes-rgx =
[tool.pylint.refactoring]
# Maximum number of nested blocks for function / method body
max-nested-blocks = 5
# Complete name of functions that never returns. When checking for inconsistent-
# return-statements if a never returning function is called then it will be
# considered as an explicit return statement and no message will be printed.
never-returning-functions = ["sys.exit", "argparse.parse_error"]
# Let 'consider-using-join' be raised when the separator to join on would be non-
# empty (resulting in expected fixes of the type: ``"- " + " - ".join(items)``)
suggest-join-with-non-empty-separator = true
[tool.pylint.reports]
# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'fatal', 'error', 'warning', 'refactor',
# 'convention', and 'info' which contain the number of messages in each category,
# as well as 'statement' which is the total number of statements analyzed. This
# score is used by the global evaluation report (RP0004).
evaluation = "max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))"
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details.
# msg-template =
# Set the output format. Available formats are: text, parseable, colorized, json2
# (improved json format), json (old json format) and msvs (visual studio). You
# can also give a reporter class, e.g. mypackage.mymodule.MyReporterClass.
# output-format =
# Tells whether to display a full report or only the messages.
# reports =
# Activate the evaluation score.
score = true
[tool.pylint.similarities]
# Comments are removed from the similarity computation
ignore-comments = true
# Docstrings are removed from the similarity computation
ignore-docstrings = true
# Imports are removed from the similarity computation
ignore-imports = true
# Signatures are removed from the similarity computation
ignore-signatures = true
# Minimum lines number of a similarity.
min-similarity-lines = 4
[tool.pylint.spelling]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions = 4
# Spelling dictionary name. No available dictionaries : You need to install both
# the python package and the system dependency for enchant to work.
# spelling-dict =
# List of comma separated words that should be considered directives if they
# appear at the beginning of a comment and should not be checked.
spelling-ignore-comment-directives = "fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:"
# List of comma separated words that should not be checked.
# spelling-ignore-words =
# A path to a file that contains the private dictionary; one word per line.
# spelling-private-dict-file =
# Tells whether to store unknown words to the private dictionary (see the
# --spelling-private-dict-file option) instead of raising a message.
# spelling-store-unknown-words =
[tool.pylint.typecheck]
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators = ["contextlib.contextmanager"]
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
# generated-members =
# Tells whether missing members accessed in mixin class should be ignored. A
# class is considered mixin if its name matches the mixin-class-rgx option.
# Tells whether to warn about missing members when the owner of the attribute is
# inferred to be None.
ignore-none = true
# This flag controls whether pylint should warn about no-member and similar
# checks whenever an opaque object is returned when inferring. The inference can
# return multiple potential results while evaluating a Python object, but some
# branches might not be evaluated, which results in partial inference. In that
# case, it might be useful to still emit no-member and other checks for the rest
# of the inferred objects.
ignore-on-opaque-inference = true
# List of symbolic message names to ignore for Mixin members.
ignored-checks-for-mixins = ["no-member", "not-async-context-manager", "not-context-manager", "attribute-defined-outside-init"]
# List of class names for which member attributes should not be checked (useful
# for classes with dynamically set attributes). This supports the use of
# qualified names.
ignored-classes = ["optparse.Values", "thread._local", "_thread._local", "argparse.Namespace"]
# Show a hint with possible names when a member name was not found. The aspect of
# finding the hint is based on edit distance.
missing-member-hint = true
# The minimum edit distance a name should have in order to be considered a
# similar match for a missing member name.
missing-member-hint-distance = 1
# The total number of similar names that should be taken in consideration when
# showing a hint for a missing member.
missing-member-max-choices = 1
# Regex pattern to define which classes are considered mixins.
mixin-class-rgx = ".*[Mm]ixin"
# List of decorators that change the signature of a decorated function.
# signature-mutators =
[tool.pylint.variables]
# List of additional names supposed to be defined in builtins. Remember that you
# should avoid defining new builtins when possible.
# additional-builtins =
# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables = true
# List of names allowed to shadow builtins
# allowed-redefined-builtins =
# List of strings which can identify a callback function by name. A callback name
# must start or end with one of those strings.
callbacks = ["cb_", "_cb"]
# A regular expression matching the name of dummy variables (i.e. expected to not
# be used).
dummy-variables-rgx = "_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_"
# Argument names that match this expression will be ignored.
ignored-argument-names = "_.*|^ignored_|^unused_"
# Tells whether we should check for unused import in __init__ files.
# init-import =
# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules = ["six.moves", "past.builtins", "future.builtins", "builtins", "io"]

31
requirements.txt Normal file
View File

@@ -0,0 +1,31 @@
aiohappyeyeballs==2.4.4
aiohttp==3.11.11
aiosignal==1.3.1
astroid==3.2.4
attrs==23.2.0
Brotli==1.0.9
certifi==2024.12.14
charset-normalizer==2.0.4
dill==0.3.8
discord.py==2.4.0
frozenlist==1.4.1
idna==3.7
iniconfig==2.0.0
isort==5.13.2
mccabe==0.7.0
multidict==6.0.5
packaging==24.1
pip==23.3.1
platformdirs==4.2.2
pluggy==1.5.0
propcache==0.2.1
psycopg2-binary==2.9.9
pylint==3.2.6
PySocks==1.7.1
pytest==8.2.2
requests>=2.32.4
setuptools>=78.1.1
tomlkit==0.13.2
urllib3==2.5.0
wheel==0.41.2
yarl==1.18.3

51
src/py/bot_aux.py Normal file
View File

@@ -0,0 +1,51 @@
"""
This module is the automated poster to discord.
This module will post to the discord whenever the script is run, detailing the callouts for the current raid for the next seven days.
This automation will be run on a daily basis, through a cron job + docker.
@author: Gabriella 'contrastellar' Agathon
"""
import argparse
import os
import discord
import helper.db_helper
DATABASE_CONN = None
intents = discord.Intents.default()
intents.message_content = True
intents.guild_messages = True
intents.presences = False
client = discord.Client(intents=intents)
NUMBER_OF_DAYS = 7
parser: argparse.ArgumentParser = argparse.ArgumentParser(prog='callouts aux',
description='The poster for the callouts bot functionality')
parser.add_argument('database')
parser.add_argument('token')
parser.add_argument('guild_id', type=int)
parser.add_argument('channel_id', type=int)
args: argparse.Namespace = parser.parse_args()
@client.event
async def on_ready():
print(f'{client.user} has connected.')
print(args.guild_id)
guild: discord.Guild = client.get_guild(args.guild_id)
channel: discord.TextChannel = guild.get_channel(args.channel_id)
callouts = DATABASE_CONN.query_callouts(NUMBER_OF_DAYS)
formatted_callouts = DATABASE_CONN.formatted_list_of_callouts(callouts)
output = f'Callouts for the next {NUMBER_OF_DAYS} days:\n' + formatted_callouts
await channel.send(output)
await client.close() # Another way to exit, a little bit cleaner than exit(0)
return
DATABASE_CONN = helper.db_helper.DBHelper(args.database)
TOKEN = open(args.token, encoding='utf-8').read()
client.run(TOKEN)

295
src/py/bot_core.py Normal file
View File

@@ -0,0 +1,295 @@
# pylint: disable=consider-using-with, no-member
"""
This module is the listener to discord.
This module will listen to the discord server for two things:
1. the /schedule command -- which will report the current callouts for the next X days, where X is either supplied or is the default of 7
2. the /callout command -- which will allow users to add a new scheduled callout
3. a /ping command, to test the bot's current status!
4. a /registercharacter command, to allow users to register their character's name independently of their server nickname
5. a /checkcharname command, to allow users to verify their character's name
6. a /remove_callout command, to allow users to remove callouts that are no longer necessary
7. a /help command, to direct users to the github for this bot!
@author: Gabriella 'contrastellar' Agathon
"""
import datetime
import argparse
import os
import discord
import psycopg2
from discord.ext import commands
import helper.db_helper
# module constants
DAYS_FOR_CALLOUTS = 7
CONTRASTELLAR = 181187505448681472
DATABASE_CONN: helper.db_helper.DBHelper = None
# psycopg2 'imports'
UNIQUEVIOLATION: psycopg2.Error = psycopg2.errors.UniqueViolation
INVALIDDATETIMEFORMAT: psycopg2.Error = psycopg2.errors.InvalidDatetimeFormat
FOREIGNKEYVIOLATION: psycopg2.Error = psycopg2.errors.ForeignKeyViolation
# discord variables
intents = discord.Intents.default()
intents.message_content = True
intents.guild_messages = True
intents.presences = False
# client declaration
client = commands.Bot(command_prefix='!', intents=intents)
# parser declaration
parser: argparse.ArgumentParser = argparse.ArgumentParser(prog='callouts core',
description='The listener for the callouts bot functionality')
parser.add_argument('database')
parser.add_argument('token')
parser.add_argument('guild_id', type=int)
parser.add_argument('channel_id', type=int)
# utility methods
def cleanup_invalidate() -> None:
DATABASE_CONN.is_procedure_queued = False
def delete_invalidate() -> None:
DATABASE_CONN.is_unregister_queued = False
# discord commands
@client.event
async def on_ready() -> None:
await client.tree.sync()
print(f'{client.user} has connected to Discord!')
print(args.guild_id)
if 'RAID_CALLOUTS_DEV' in os.environ:
return
guild: discord.Guild = client.get_guild(args.guild_id)
channel: discord.TextChannel = guild.get_channel(args.channel_id)
output = f'The bot is now running!\nPlease message <@{CONTRASTELLAR}> with any errors!'
await channel.send(output)
return
@client.event
async def on_error(interaction: discord.Interaction) -> None:
delete_invalidate()
cleanup_invalidate()
output = "Something awful has happened. In all honesty you should never see this message. Reporting to <@{CONTRASTELLAR}>."
await interaction.response.send_message(output)
return
# === slash commands are below here
@client.tree.command()
async def registercharacter(interaction: discord.Interaction, character_name: str) -> None:
delete_invalidate()
cleanup_invalidate()
user_id = interaction.user.id
user_nick = interaction.user.display_name
try:
DATABASE_CONN.register_char_name(user_id, character_name)
except psycopg2.Error as e:
char_name = DATABASE_CONN.return_char_name(user_id)
await interaction.response.send_message(f'User {char_name} -- you have already registered a character!\n{e}')
else:
await interaction.response.send_message(f'{user_nick} -- you have registered your discord account with {character_name}!')
return
@client.tree.command()
async def check_char_name(interaction: discord.Interaction) -> None:
delete_invalidate()
cleanup_invalidate()
charname: str = DATABASE_CONN.return_char_name(interaction.user.id)
if charname == "":
await interaction.response.send_message("You have not registered! Please do with `/registercharacter`")
return
if interaction.user.id == 151162055142014976:
await interaction.response.send_message("You are: " + charname + "... in case you forgot.")
return
await interaction.response.send_message("You are: " + charname)
return
@client.tree.command()
async def remove_registration(interaction: discord.Interaction) -> None:
delete_invalidate()
cleanup_invalidate()
await interaction.response.send_message("To remove your registration with the boss, please run the `/confirm_unregister` command\nPlease be aware that this will also remove all of your callouts from the bot! ***This is in an irreversable action!***")
DATABASE_CONN.is_unregister_queued = True
return
@client.tree.command()
async def validate_unregister(interaction: discord.Interaction) -> None:
cleanup_invalidate()
user_id = interaction.user.id
user_nick = interaction.user.nick
await interaction.response.defer(thinking=True)
print(f"Removing {user_id} from the database!")
DATABASE_CONN.remove_registration(user_id, DATABASE_CONN.is_unregister_queued)
await interaction.followup.send(f"{user_nick}, you have been unregistered!")
delete_invalidate()
@client.tree.command()
async def invalidate_unregister(interaction: discord.Interaction) -> None:
cleanup_invalidate()
delete_invalidate()
print("User deletion has been invalidated! Aborting process!")
await interaction.response.send_message("Unregister has been invalidated!")
return
@client.tree.command()
async def ping(interaction: discord.Interaction) -> None:
delete_invalidate()
cleanup_invalidate()
user_id = interaction.user.id
await interaction.response.send_message(f'Pong! {user_id} -- the bot is active, please message contrastellar with issues!')
return
@client.tree.command()
async def cleanup(interaction: discord.Interaction) -> None:
delete_invalidate()
cleanup_invalidate()
number_to_be_affected: int = DATABASE_CONN.number_affected_in_cleanup()
await interaction.response.send_message(f"Is the bot being weird or slow? You can try the `/validate_cleanup` command to clear out old database entries!\nBe warned that this is an admin-level command, and may have unintended side effects!\n{number_to_be_affected} rows will be affected by the `/validate_cleanup` command!\nThese entries are all in the past.")
DATABASE_CONN.is_procedure_queued = True
print("Bot has been primed for cleanup!")
return
@client.tree.command()
async def validate_cleanup(interaction: discord.Interaction) -> None:
delete_invalidate()
user_nickname = interaction.user.nick
await interaction.response.defer(thinking=True)
print(f"{user_nickname} has called validate_cleanup!\n\nCalling now.")
number_rows_affected: int
try:
number_rows_affected = DATABASE_CONN.call_cleanup(DATABASE_CONN.is_procedure_queued)
except psycopg2.Error as e:
print(e)
await interaction.followup.send(f"Something happened! This message is to inform <@{CONTRASTELLAR}> of this error!\n`{e}`")
return
print("cleanup should be complete. Setting queue variable to False")
DATABASE_CONN.is_procedure_queued = False
await interaction.followup.send(f"Database has been cleaned!\n\n{number_rows_affected} rows have been purged!")
return
@client.tree.command()
async def invalidate_cleanup(interaction: discord.Interaction) -> None:
delete_invalidate()
cleanup_invalidate()
await interaction.response.defer(thinking=True)
print(f"{interaction.user.id} has called the invalidate command!")
print("Cleanup has been invalidated!")
await interaction.followup.send("The queued action has been cancelled!")
return
@client.tree.command()
async def callout(interaction: discord.Interaction, day: int, month: int, year: int, reason: str = '', fill: str = '') -> None:
delete_invalidate()
cleanup_invalidate()
user_id = interaction.user.id
user_nick = interaction.user.display_name
user_char_name = DATABASE_CONN.return_char_name(user_id)
today: datetime.date = datetime.date.today()
callout_date: datetime.date = datetime.date(year=year, month=month, day=day)
if today > callout_date:
await interaction.response.send_message(f'{user_char_name}, date in the past given. Please give a date for today or in the future!')
return
if len(reason) > 512:
await interaction.response.send_message(f'{user_char_name}, your reason was too long. Keep it to 512 characters or less.')
return
try:
DATABASE_CONN.add_callout(user_id=user_id, callout=callout_date, reason=reason, nickname=user_nick, char_name=user_char_name, potential_fill=fill)
except UNIQUEVIOLATION:
await interaction.response.send_message(f'{user_char_name} -- you have already added a callout for {callout_date} with reason: {reason}')
except INVALIDDATETIMEFORMAT:
await interaction.response.send_message(f'{user_char_name} -- please format the date as the following format: MM/DD/YYYY')
except FOREIGNKEYVIOLATION:
await interaction.response.send_message(f'{user_nick} -- please register with the bot using the following command!\n`/registercharacter`\n Please use your in-game name!')
except helper.db_helper.DateTimeError:
await interaction.response.send_message(f'{user_nick}, you\'re trying to submit a callout for a time in the past! Please verify that this is what you want to do!')
except psycopg2.Error as e:
await interaction.response.send_message(f'{user_nick} -- an error has occured!\nNotifying <@{CONTRASTELLAR}> of this error. Error is as follows --\n{e}')
else:
await interaction.response.send_message(f'{user_char_name} -- you added a callout for {callout_date} with reason: {reason}')
await interaction.followup.send(f'{DATABASE_CONN.format_list_of_callouts(DATABASE_CONN.query_callouts(7))}')
@client.tree.command()
async def remove_callout(interaction: discord.Interaction, day: int, month: int, year: int) -> None:
delete_invalidate()
cleanup_invalidate()
user_id = interaction.user.id
user_char_name = DATABASE_CONN.return_char_name(user_id)
callout_date: datetime.date = datetime.date(year=year, month=month, day=day)
try:
DATABASE_CONN.remove_callout(user_id=user_id, callout=callout_date)
except psycopg2.Error:
await interaction.response.send_message(f'{user_char_name} -- you have not added a callout for {callout_date}')
else:
await interaction.response.send_message(f'{user_char_name} removed a callout for {callout_date}')
@client.tree.command()
async def schedule(interaction: discord.Interaction, days: int = DAYS_FOR_CALLOUTS) -> None:
delete_invalidate()
cleanup_invalidate()
await interaction.response.defer(thinking=True)
callouts: list = DATABASE_CONN.query_callouts(days=days)
callouts: str = DATABASE_CONN.formatted_list_of_callouts(callouts)
await interaction.followup.send(f'Callouts for the next {days} days:\n{callouts}')
return
@client.tree.command()
async def self_callouts(interaction: discord.Interaction, days: int = 365) -> None:
delete_invalidate()
cleanup_invalidate()
uid = interaction.user.id
await interaction.response.defer(thinking=True)
callouts: list = DATABASE_CONN.query_self_callouts(user_id=uid, days=days)
callouts: str = DATABASE_CONN.formatted_list_of_callouts(callouts)
await interaction.followup.send(f'Callouts for the next **{days}** for user **{DATABASE_CONN.return_char_name(uid)}**:\n{callouts}')
args: argparse.Namespace = parser.parse_args()
# To be used for reading/writing to the database
# #will not handle the parsing of the returns from the db
DATABASE_CONN = helper.db_helper.DBHelper(args.database)
TOKEN: str = open(args.token, encoding='utf-8').read()
client.run(TOKEN)

59
src/py/db_helper_tests.py Normal file
View File

@@ -0,0 +1,59 @@
"""
Database functionality tests.
@author: Gabriella "Contrastellar" Agathon
"""
import datetime
import helper.db_helper
class TestClass():
"""
Test class for the database functionality.
These tests should only be assertions of type, not of return values.
"""
DATABASE_CONN = helper.db_helper.DBHelper("xiv-database.ini")
def test_add_registration(self) -> None:
registration = self.DATABASE_CONN.register_char_name(uid=1, char_name="test")
assert registration is None
def test_query_callouts(self) -> None:
callouts = self.DATABASE_CONN.query_callouts(7)
assert type(callouts) is list
def test_add_callout(self) -> None:
callout = self.DATABASE_CONN.add_callout(user_id=1, callout=datetime.date.today(), reason='test', nickname='test', char_name='test', potential_fill='test')
assert callout is None
def test_self_query_callouts(self) -> None:
self_callouts = self.DATABASE_CONN.query_self_callouts(user_id=1, days=365)
assert self_callouts is not None
def test_callouts(self) -> None:
callout = self.DATABASE_CONN.query_callouts(days=7)
assert callout is not None
def test_remove_callout(self) -> None:
remove_callout = self.DATABASE_CONN.remove_callout(user_id=1, callout=datetime.date.today())
assert remove_callout is None
def test_char_name(self) -> None:
char_name = self.DATABASE_CONN.return_char_name(uid=1)
assert type(char_name) is str
assert char_name == "test"
def test_remove_registration(self) -> None:
registration = self.DATABASE_CONN.remove_registration(uid=1, isOkay=True)
assert registration is None
def test_format_list_of_callouts(self) -> None:
callouts = self.DATABASE_CONN.query_callouts(days=7)
formatted_callouts = self.DATABASE_CONN.format_list_of_callouts(callouts=callouts)
assert formatted_callouts.__class__ is str

295
src/py/helper/db_helper.py Normal file
View File

@@ -0,0 +1,295 @@
"""
The helper core of the raid-callouts bot.
This module(s) will contain all of the helper functions for the bot
@author: Gabriella 'contrastellar' Agathon
"""
import psycopg2
import psycopg2.extensions
from configparser import ConfigParser
import datetime
def load_config(filename='database.ini', section='postgresql'):
"""
Args:
filename (str, optional): filename for the ini file. Defaults to 'database.ini'.
section (str, optional): defines the section for the ini file to read from. Defaults to 'postgresql'.
Raises:
Exception: Will raise an exception if the postgresql section is not found in the ini file.
Returns:
dict: A dictionary containing the parsed values from the ini file, to be used for the database connection.
"""
parser = ConfigParser()
parser.read(filename)
# get section, default is postgresql
config = {}
if parser.has_section(section):
params = parser.items(section)
for param in params:
config[param[0]] = param[1]
else:
raise Exception('Section {0} not found in the {1} file'.format(section, filename))
return config
def connect_config(config) -> psycopg2.extensions.connection:
""" Connect to the PostgreSQL database server """
try:
# connecting to the PostgreSQL server
with psycopg2.connect(**config) as conn:
print('Connected to the PostgreSQL server.')
return conn
except (psycopg2.DatabaseError, Exception) as error:
print(error)
finally:
if conn is None:
raise psycopg2.DatabaseError('Failed to connect to the PostgreSQL database')
class DateTimeError(Exception):
def __init__(self, *args):
super().__init__(*args)
class DBHelper():
"""
The helper class for the raid-callouts bot.
This class will contain all of the helper functions for the bot
"""
_config: dict
__CONN: psycopg2.extensions.connection = None
is_procedure_queued: bool = False
is_unregister_queued: bool = False
def __init__(self, filename = 'database.ini', section = 'postgresql') -> None:
self._config = load_config(filename=filename, section=section)
def __del__(self):
"""
Destructor for the DBHelper class
No need to do anything here
"""
# self.__CONN.close()
pass
def query_callouts(self, days: int) -> list:
"""This function will query the database for the callouts for the next X days, where X is defined by the days parameter.
Args:
days int: number of days in the future to query for callouts
Returns:
list: list of users + their callouts for the next X days
"""
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
# Weird query, but it grabs the callouts from the last day to the next X days.
cursor.execute(f"SELECT * FROM newcallouts WHERE date >= NOW() - INTERVAL '1 day' AND date <= NOW() + INTERVAL '{days} days' ORDER BY date ASC;")
self.__CONN.commit()
return cursor.fetchall()
def query_self_callouts(self, user_id: int, days: int = 365):
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
cursor.execute(f"SELECT * FROM newcallouts WHERE date >= NOW() - INTERVAL '1 day' AND date <= NOW() + INTERVAL '{days} days' AND user_id = {user_id} ORDER BY date ASC;")
self.__CONN.commit()
return cursor.fetchall()
def add_callout(self, user_id: int, callout: datetime.date, reason: str, nickname: str, char_name: str, potential_fill: str) -> None:
"""Add a callout to the database
Args:
user_id (int): the Discord UUID of the user adding things to the db
callout (datetime.date): The day of the callout
reason (str): The reason of the callout
nickname (str): The server(guild) nickname of the user who is making the callout
char_name (str): The character name (as supplied from registration) of the user inserting a callout
"""
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
cursor.execute("INSERT INTO newcallouts (user_id, date, reason, nickname, charname, fill) VALUES (%s, %s, %s, %s, %s, %s)", (user_id, callout, reason, nickname, char_name, potential_fill))
self.__CONN.commit()
return
def remove_callout(self, user_id: int, callout: datetime.date) -> None:
"""Remove a callout based on user + date, which form the primary key in the db
Args:
user_id (int): The Discord UUID of the user removing something from the db
callout (datetime.datetime): The date of the callout
"""
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
cursor.execute("DELETE FROM newcallouts WHERE user_id = %s AND date = %s", (user_id, callout))
self.__CONN.commit()
return
def formatted_list_of_callouts(self, callouts: list) -> str:
"""Format the python list of callouts.
Args:
callouts (list): The list that needs to be formatted
Returns:
str: The formatted list
"""
length = len(callouts)
output: str = ''
# Quick and dirty way to say that there were no callouts found during the query
if length == 0:
return 'No callouts found for the requested timeframe'
for entry in callouts:
# this is a bit wonky, but we take the known constant width of each entry (4 columns)
# then we use python's range function to turn "item" into an interator
# Then we do some funky logic on the entry that we're iterating over
# in order to get the proper formatting
for item in range(5):
if item == 0:
# skip discord user ID always
continue
elif item == 1:
# handles the date displaying logic
if datetime.date.today() == entry[1]:
output += '**TODAY** • '
else:
output += f'**{entry[1]}** • '
elif item == 2:
# in the database, this is actually the "reason" place
# instead of doing that, we call the last column's value
# which is the char name
# this was requested by Yasu
output += "**" + entry[4] + '** • '
elif item == 3:
# Finally add the reason for the user's callout
# two line breaks as Yasu requested
output += entry[2] + ' '
elif item == 4:
if entry[5] is not None:
output += f'• potential fill -- {entry[5]}\n--\n'
else:
output += '\n--\n'
output += "END OF MESSAGE"
return output
def format_list_of_callouts(self, callouts: list) -> str:
"""Format the python list of callouts.
Args:
callouts (list): The list that needs to be formatted
Returns:
str: The formatted list
"""
return self.formatted_list_of_callouts(callouts=callouts)
def register_char_name(self, uid: int, char_name: str) -> None:
""" allows users to register their character name with the bot, allowing silly nicknames to be used independent of their
character's name
Arguments:
uid -- Discord User ID of the user to be registered
char_name -- User-supplied character name, to be inserted into the table
"""
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
cursor.execute("INSERT INTO charnames (uid, charname) VALUES (%s, %s)", (uid, char_name))
self.__CONN.commit()
return
def return_char_name(self, uid: int) -> str:
"""Utility method to return the character name based on a specific discord ID
Arguments:
uid -- Discord User ID of the user to be queried
Returns:
String; either character name or empty.
"""
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
# was getting weird index error on this line due to tuples, so we're using an f-string
cursor.execute(f"SELECT charname FROM charnames WHERE uid = {uid}")
output: str = ""
try:
output = cursor.fetchone()[0]
except TypeError:
return ""
else:
return output
def remove_registration(self, uid: int, isOkay: bool) -> None:
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
# need to remove all callouts!
cursor.execute(f"DELETE FROM newcallouts WHERE user_id = {uid}")
cursor.execute(f"DELETE FROM charnames WHERE uid = {uid}")
return
def number_affected_in_cleanup(self) -> int:
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
cursor.execute(f"SELECT count(*) FROM newcallouts WHERE date < NOW();")
return cursor.fetchone()[0]
def call_cleanup(self, is_okay: bool) -> int:
number_to_be_affected = self.number_affected_in_cleanup()
if not is_okay:
raise Exception("Not queued properly!")
self.__CONN = connect_config(self._config)
self.__CONN.autocommit = True
cursor = self.__CONN.cursor()
cursor.execute(f"CALL cleanup();")
print("Cleanup was called!")
return number_to_be_affected

17
src/sql/current-table.sql Normal file
View File

@@ -0,0 +1,17 @@
-- Table: public.callouts
-- DROP TABLE IF EXISTS public.callouts;
CREATE TABLE IF NOT EXISTS public.callouts
(
user_id bigint NOT NULL,
date date NOT NULL,
reason text COLLATE pg_catalog."default",
nickname text COLLATE pg_catalog."default",
CONSTRAINT callouts_pkey PRIMARY KEY (user_id, date)
)
TABLESPACE pg_default;
ALTER TABLE IF EXISTS public.callouts
OWNER to opossumbot;

7
src/sql/initial-table.sql Normal file
View File

@@ -0,0 +1,7 @@
create table absent_players (
user_id int NOT NULL,
user_name varchar(20) NOT NULL,
date_ab date NOT NULL,
reason_ab varchar(200),
has_passed int DEFAULT 0);
/

13
src/sql/sqlscripts.sql Normal file
View File

@@ -0,0 +1,13 @@
-- These are scripts that are formatted for accesing the table, more comments can be provided as needed
select count(user_id) from absent_players where user_id = 000000 and has_passed = 1;
-- Select the number of times a user has been absent so far(replace user_ID)
select user_name, reason_ab from absent_players where date_ab = SYSDATE;
-- select users name, reason they're absent today (reoplace date with today's date)
select user_name, date_ab, reason_ab from absent_players where has_passed = 0;
-- selects all future players who are absent, the reason they are, and when they are.
delete from absent_players where user_ID = 00000 and date_ab = date and has_passed = 0;
-- deletes a future absence from the table, cannot remove older absences.