Compare commits

...

23 commits

Author SHA1 Message Date
Noi
dfb47846e2
Merge pull request #11 from NoiTheCat/dev/dotnet8
Switch license to GPLv3
2024-07-03 23:16:28 -07:00
Noi
96bf3a2d94 Switch license to GPLv3 2024-07-03 22:59:14 -07:00
Noi
0c24c36da2
Merge pull request #10 from NoiTheCat/dev/dotnet8
Upgrade to .NET 8
2024-06-23 20:21:55 -07:00
Noi
986d9e4ff3 Implement suggestions; minor command refactoring 2024-06-08 21:08:03 -07:00
Noi
cc148d5257 Implement style suggestions 2024-06-08 21:07:35 -07:00
Noi
7668c82cf9 Switch to .NET 8
* Bump version
* Update dependencies
* Copy .editorconfig from BirthdayBot
  * Still want to properly look over it some time
* Set up dotnet-ef as project tool
2024-06-08 19:00:10 -07:00
Noi
ae9851d26f
Merge pull request #8 from NoiTheCat/features/text-processing
Rudimentary text processing for kicks, etc
2024-04-21 12:11:13 -07:00
Noi
c64dab9874
Merge branch 'main' into features/text-processing 2024-04-21 12:09:12 -07:00
Noi
e3bf767c25
Merge pull request #7 from NoiTheCat/dev/new-usernames
New username system support
2024-01-07 15:43:18 -08:00
Noi
db0a1e391c Rudimentary text processing for kicks, etc 2023-11-16 10:19:10 -08:00
Noi
0bc04a20d1
Merge pull request #6 from NoiTheCat/fixes/no-bot-updates
Prevent logging and reporting of bot messages
2023-11-16 09:12:40 -08:00
Noi
97654a6f29 Use new extension method for displaying username 2023-11-14 21:09:21 -08:00
Noi
aad54f9fa7 Recognize display names in username cache 2023-11-14 19:24:46 -08:00
Noi
a6c6ba9550 Don't send update events for messages not logged 2023-07-17 10:46:41 -07:00
Noi
ddfc2fc612 Do not log message edits from bots 2023-04-28 12:50:11 -07:00
Noi
8de34d743c
Update copyright date / contact email 2023-02-19 10:20:40 -08:00
Noi
7d18e1f498
Bump version to 3.2.0 2022-12-16 22:11:52 -08:00
Noi
6af72ea518
Merge pull request #5 from NoiTheCat/format-custom-msgs
Implement success message formatting
2022-12-16 22:11:05 -08:00
Noi
634bc26951 Implement success message formatting
Imported from `legacy` branch:
RegexBot/RegexBot/Module/AutoMod/ResponseBase.cs:161
2022-12-16 22:10:08 -08:00
Noi
495636baec
Merge pull request #4 from NoiTheCat/consolidate-config
Consolidate bot and guild configuration into one file
2022-12-16 21:58:45 -08:00
Noi
fe72cd2cdb
Merge pull request #3 from NoiTheCat/dev
v3.1.1 updates and fixes
2022-12-16 21:54:00 -08:00
Noi
6323134285 Update config schema and example 2022-12-04 17:09:41 -08:00
Noi
681e702406 Merve instance and guild configs into single file
Previous method only really made sense when plans for this bot were far
more ambitious than they are now.
2022-12-04 16:30:50 -08:00
52 changed files with 1289 additions and 363 deletions

12
.config/dotnet-tools.json Normal file
View file

@ -0,0 +1,12 @@
{
"version": 1,
"isRoot": true,
"tools": {
"dotnet-ef": {
"version": "8.0.6",
"commands": [
"dotnet-ef"
]
}
}
}

View file

@ -13,13 +13,13 @@ tab_width = 4
# New line preferences # New line preferences
end_of_line = crlf end_of_line = crlf
insert_final_newline = false insert_final_newline = true
#### .NET Coding Conventions #### #### .NET Coding Conventions ####
# Organize usings # Organize usings
dotnet_separate_import_directive_groups = false dotnet_separate_import_directive_groups = false
dotnet_sort_system_directives_first = false dotnet_sort_system_directives_first = true
file_header_template = unset file_header_template = unset
# this. and Me. preferences # this. and Me. preferences
@ -63,7 +63,7 @@ dotnet_style_prefer_simplified_interpolation = true
dotnet_style_readonly_field = true dotnet_style_readonly_field = true
# Parameter preferences # Parameter preferences
dotnet_code_quality_unused_parameters = all dotnet_code_quality_unused_parameters = true
# Suppression preferences # Suppression preferences
dotnet_remove_unnecessary_suppression_exclusions = none dotnet_remove_unnecessary_suppression_exclusions = none
@ -77,7 +77,7 @@ dotnet_style_allow_statement_immediately_after_block_experimental = true
# var preferences # var preferences
csharp_style_var_elsewhere = false:silent csharp_style_var_elsewhere = false:silent
csharp_style_var_for_built_in_types = true:suggestion csharp_style_var_for_built_in_types = true:suggestion
csharp_style_var_when_type_is_apparent = false:silent csharp_style_var_when_type_is_apparent = true:suggestion
# Expression-bodied members # Expression-bodied members
csharp_style_expression_bodied_accessors = true:silent csharp_style_expression_bodied_accessors = true:silent
@ -101,7 +101,6 @@ csharp_style_conditional_delegate_call = true:suggestion
# Modifier preferences # Modifier preferences
csharp_prefer_static_local_function = true:suggestion csharp_prefer_static_local_function = true:suggestion
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
# Code-block preferences # Code-block preferences
csharp_prefer_braces = when_multiline:silent csharp_prefer_braces = when_multiline:silent
@ -221,38 +220,4 @@ csharp_style_prefer_local_over_anonymous_function = true:suggestion
csharp_style_prefer_tuple_swap = true:suggestion csharp_style_prefer_tuple_swap = true:suggestion
csharp_style_prefer_extended_property_pattern = true:suggestion csharp_style_prefer_extended_property_pattern = true:suggestion
[*.{cs,vb}] csharp_style_prefer_primary_constructors = true:suggestion
dotnet_style_operator_placement_when_wrapping = beginning_of_line
tab_width = 4
indent_size = 4
end_of_line = crlf
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
dotnet_style_prefer_auto_properties = true:suggestion
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_namespace_match_folder = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_simplified_interpolation = true:suggestion
dotnet_style_readonly_field = true:suggestion
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
dotnet_style_allow_multiple_blank_lines_experimental = false:suggestion
dotnet_style_allow_statement_immediately_after_block_experimental = true:silent
dotnet_code_quality_unused_parameters = all:suggestion
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_property = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_event = false:silent

4
.vscode/launch.json vendored
View file

@ -10,8 +10,8 @@
"request": "launch", "request": "launch",
"preLaunchTask": "build", "preLaunchTask": "build",
// If you have changed target frameworks, make sure to update the program path. // If you have changed target frameworks, make sure to update the program path.
"program": "${workspaceFolder}/bin/Debug/net6.0/RegexBot.dll", "program": "${workspaceFolder}/bin/Debug/net8.0/RegexBot.dll",
"args": [], "args": [ "-c", "${workspaceFolder}/bin/Debug/config.json" ],
"cwd": "${workspaceFolder}", "cwd": "${workspaceFolder}",
// For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
"console": "internalConsole", "console": "internalConsole",

674
COPYING Normal file
View file

@ -0,0 +1,674 @@
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
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

View file

@ -1,11 +1,12 @@
using System.Collections; using System.Collections;
using System.Collections.ObjectModel;
namespace RegexBot.Common; namespace RegexBot.Common;
/// <summary> /// <summary>
/// Represents a commonly-used configuration structure: an array of strings consisting of <see cref="EntityName"/> values. /// Represents a commonly-used configuration structure: an array of strings consisting of <see cref="EntityName"/> values.
/// </summary> /// </summary>
public class EntityList : IEnumerable<EntityName> { public class EntityList : IEnumerable<EntityName> {
private readonly IReadOnlyCollection<EntityName> _innerList; private readonly ReadOnlyCollection<EntityName> _innerList;
/// <summary>Gets an enumerable collection of all role names defined in this list.</summary> /// <summary>Gets an enumerable collection of all role names defined in this list.</summary>
public IEnumerable<EntityName> Roles public IEnumerable<EntityName> Roles

View file

@ -11,7 +11,7 @@ public class RateLimit<T> where T : notnull {
/// Time until an entry within this instance expires, in seconds. /// Time until an entry within this instance expires, in seconds.
/// </summary> /// </summary>
public int Timeout { get; } public int Timeout { get; }
private Dictionary<T, DateTime> Entries { get; } = new Dictionary<T, DateTime>(); private Dictionary<T, DateTime> Entries { get; } = [];
/// <summary> /// <summary>
/// Creates a new <see cref="RateLimit&lt;T&gt;"/> instance with the default timeout value. /// Creates a new <see cref="RateLimit&lt;T&gt;"/> instance with the default timeout value.

View file

@ -1,4 +1,5 @@
using Discord; using Discord;
using RegexBot.Data;
using System.Diagnostics.CodeAnalysis; using System.Diagnostics.CodeAnalysis;
using System.Text; using System.Text;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
@ -7,26 +8,30 @@ namespace RegexBot.Common;
/// <summary> /// <summary>
/// Miscellaneous utility methods useful for the bot and modules. /// Miscellaneous utility methods useful for the bot and modules.
/// </summary> /// </summary>
public static class Utilities { public static partial class Utilities {
/// <summary> /// <summary>
/// Gets a compiled regex that matches a channel tag and pulls its snowflake value. /// Gets a precompiled regex that matches a channel tag and pulls its snowflake value.
/// </summary> /// </summary>
public static Regex ChannelMention { get; } = new(@"<#(?<snowflake>\d+)>", RegexOptions.Compiled); [GeneratedRegex(@"<#(?<snowflake>\d+)>")]
public static partial Regex ChannelMentionRegex();
/// <summary> /// <summary>
/// Gets a compiled regex that matches a custom emoji and pulls its name and ID. /// Gets a precompiled regex that matches a custom emoji and pulls its name and ID.
/// </summary> /// </summary>
public static Regex CustomEmoji { get; } = new(@"<:(?<name>[A-Za-z0-9_]{2,}):(?<ID>\d+)>", RegexOptions.Compiled); [GeneratedRegex(@"<:(?<name>[A-Za-z0-9_]{2,}):(?<ID>\d+)>")]
public static partial Regex CustomEmojiRegex();
/// <summary> /// <summary>
/// Gets a compiled regex that matches a fully formed Discord handle, extracting the name and discriminator. /// Gets a precompiled regex that matches a fully formed Discord handle, extracting the name and discriminator.
/// </summary> /// </summary>
public static Regex DiscriminatorSearch { get; } = new(@"(.+)#(\d{4}(?!\d))", RegexOptions.Compiled); [GeneratedRegex(@"(.+)#(\d{4}(?!\d))")]
public static partial Regex DiscriminatorSearchRegex();
/// <summary> /// <summary>
/// Gets a compiled regex that matches a user tag and pulls its snowflake value. /// Gets a precompiled regex that matches a user tag and pulls its snowflake value.
/// </summary> /// </summary>
public static Regex UserMention { get; } = new(@"<@!?(?<snowflake>\d+)>", RegexOptions.Compiled); [GeneratedRegex(@"<@!?(?<snowflake>\d+)>")]
public static partial Regex UserMentionRegex();
/// <summary> /// <summary>
/// Performs common checks on the specified message to see if it fits all the criteria of a /// Performs common checks on the specified message to see if it fits all the criteria of a
@ -75,15 +80,59 @@ public static class Utilities {
/// If given string is in an EntityName format, returns a displayable representation of it based on /// If given string is in an EntityName format, returns a displayable representation of it based on
/// a cache query. Otherwise, returns the input string as-is. /// a cache query. Otherwise, returns the input string as-is.
/// </summary> /// </summary>
[return: NotNullIfNotNull("input")] [return: NotNullIfNotNull(nameof(input))]
public static string? TryFromEntityNameString(string? input, RegexbotClient bot) { public static string? TryFromEntityNameString(string? input, RegexbotClient bot) {
string? result = null; string? result = null;
try { try {
var entityTry = new EntityName(input!, EntityType.User); var entityTry = new EntityName(input!, EntityType.User);
var issueq = bot.EcQueryUser(entityTry.Id!.Value.ToString()); var issueq = bot.EcQueryUser(entityTry.Id!.Value.ToString());
if (issueq != null) result = $"<@{issueq.UserId}> - {issueq.Username}#{issueq.Discriminator} `{issueq.UserId}`"; if (issueq != null) result = $"<@{issueq.UserId}> - {issueq.GetDisplayableUsername()} `{issueq.UserId}`";
else result = $"Unknown user with ID `{entityTry.Id!.Value}`"; else result = $"Unknown user with ID `{entityTry.Id!.Value}`";
} catch (Exception) { } } catch (Exception) { }
return result ?? input; return result ?? input;
} }
/// <summary>
/// Given an input string, replaces certain special character combinations with information
/// from the specified message.
/// </summary>
public static string ProcessTextTokens(string input, SocketMessage m) {
// TODO elaborate on this
// For now, replaces all instances of @_ with the message sender.
return input
.Replace("@_", m.Author.Mention)
.Replace("@\\_", "@_");
}
/// <inheritdoc cref="GetDisplayableUsernameCommon"/>
public static string GetDisplayableUsername(this SocketUser user)
=> GetDisplayableUsernameCommon(user.Username, user.Discriminator, user.GlobalName);
/// <inheritdoc cref="GetDisplayableUsernameCommon"/>
public static string GetDisplayableUsername(this CachedUser user)
=> GetDisplayableUsernameCommon(user.Username, user.Discriminator, user.GlobalName);
/// <summary>
/// Returns a string representation of the user's username suitable for display purposes.
/// For the sake of consistency, it is preferable using this instead of any other means, including Discord.Net's ToString.
/// </summary>
private static string GetDisplayableUsernameCommon(string username, string discriminator, string? global) {
static string escapeFormattingCharacters(string input) {
var result = new StringBuilder();
foreach (var c in input) {
if (c is '\\' or '_' or '~' or '*' or '@' or '`') {
result.Append('\\');
}
result.Append(c);
}
return result.ToString();
}
if (discriminator == "0000") {
if (global != null) return $"{escapeFormattingCharacters(global)} ({username})";
return username;
} else {
return $"{escapeFormattingCharacters(username)}#{discriminator}";
}
}
} }

View file

@ -1,14 +1,9 @@
using CommandLine; using CommandLine;
using Newtonsoft.Json; using Newtonsoft.Json;
using System.Diagnostics.CodeAnalysis; using System.Diagnostics.CodeAnalysis;
using System.Reflection;
namespace RegexBot; namespace RegexBot;
/// <summary> class Configuration {
/// Contains essential instance configuration for this bot including Discord connection settings, service configuration,
/// and command-line options.
/// </summary>
class InstanceConfig {
/// <summary> /// <summary>
/// Token used for Discord authentication. /// Token used for Discord authentication.
/// </summary> /// </summary>
@ -19,18 +14,20 @@ class InstanceConfig {
/// </summary> /// </summary>
internal IReadOnlyList<string> Assemblies { get; } internal IReadOnlyList<string> Assemblies { get; }
public string? SqlHost { get; } public JObject ServerConfigs { get; }
public string? SqlDatabase { get; }
public string SqlUsername { get; } // SQL properties:
public string SqlPassword { get; } public string? Host { get; }
public string? Database { get; }
public string Username { get; }
public string Password { get; }
/// <summary> /// <summary>
/// Sets up instance configuration object from file and command line parameters. /// Sets up instance configuration object from file and command line parameters.
/// </summary> /// </summary>
internal InstanceConfig() { internal Configuration() {
var args = CommandLineParameters.Parse(Environment.GetCommandLineArgs()); var args = CommandLineParameters.Parse(Environment.GetCommandLineArgs());
var path = args?.ConfigFile ?? Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location) var path = args?.ConfigFile!;
+ Path.DirectorySeparatorChar + "." + Path.DirectorySeparatorChar + "instance.json";
JObject conf; JObject conf;
try { try {
@ -54,10 +51,15 @@ class InstanceConfig {
throw new Exception($"'{nameof(Assemblies)}' is not properly specified in configuration."); throw new Exception($"'{nameof(Assemblies)}' is not properly specified in configuration.");
} }
SqlHost = ReadConfKey<string>(conf, nameof(SqlHost), false); var dbconf = (conf["DatabaseOptions"]?.Value<JObject>())
SqlDatabase = ReadConfKey<string?>(conf, nameof(SqlDatabase), false); ?? throw new Exception("Database settings were not specified in configuration.");
SqlUsername = ReadConfKey<string>(conf, nameof(SqlUsername), true); Host = ReadConfKey<string>(dbconf, nameof(Host), false);
SqlPassword = ReadConfKey<string>(conf, nameof(SqlPassword), true); Database = ReadConfKey<string?>(dbconf, nameof(Database), false);
Username = ReadConfKey<string>(dbconf, nameof(Username), true);
Password = ReadConfKey<string>(dbconf, nameof(Password), true);
ServerConfigs = conf["Servers"]?.Value<JObject>();
if (ServerConfigs == null) throw new Exception("No server configurations were specified.");
} }
private static T? ReadConfKey<T>(JObject jc, string key, [DoesNotReturnIf(true)] bool failOnEmpty) { private static T? ReadConfKey<T>(JObject jc, string key, [DoesNotReturnIf(true)] bool failOnEmpty) {
@ -67,8 +69,8 @@ class InstanceConfig {
} }
class CommandLineParameters { class CommandLineParameters {
[Option('c', "config", Default = null)] [Option('c', "config", Default = "config.json")]
public string? ConfigFile { get; set; } = null!; public string? ConfigFile { get; set; } = null;
public static CommandLineParameters? Parse(string[] args) { public static CommandLineParameters? Parse(string[] args) {
CommandLineParameters? result = null; CommandLineParameters? result = null;

44
ConfigurationSchema.json Normal file
View file

@ -0,0 +1,44 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"BotToken": {
"type": "string",
"description": "The token used by the bot to connect to Discord."
},
"Assemblies": {
"type": "array",
"description": "A list of additional files to be loaded to extend the bot's functionality.",
"default": [ "RegexBot.dll" ]
},
"DatabaseOptions": {
"type": "object",
"description": "A set of options for the SQL database connection.",
"properties": {
"Host": {
"type": "string",
"description": "The SQL host, whether a hostname, IP address, or path to a socket."
},
"Database": {
"type": "string",
"description": "The target SQL database name to connect to, if different from the default."
},
"Username": {
"type": "string",
"description": "The username used for SQL server authentication."
},
"Password": {
"type": "string",
"description": "The password used for SQL server authentication."
}
},
"required": [ "Username", "Password" ]
},
"Servers": {
"type": "object",
"description": "A collection of server configurations with keys representing server IDs and values containing the respective server's configuration."
/* TODO unfinished */
}
},
"required": [ "BotToken", "DatabaseOptions", "Servers" ]
}

View file

@ -10,15 +10,16 @@ public class BotDatabaseContext : DbContext {
static BotDatabaseContext() { static BotDatabaseContext() {
// Get our own config loaded just for the SQL stuff // Get our own config loaded just for the SQL stuff
var conf = new InstanceConfig(); // TODO this should probably be cached, or otherwise loaded in a better way
var conf = new Configuration();
_connectionString = new NpgsqlConnectionStringBuilder() { _connectionString = new NpgsqlConnectionStringBuilder() {
#if DEBUG #if DEBUG
IncludeErrorDetail = true, IncludeErrorDetail = true,
#endif #endif
Host = conf.SqlHost ?? "localhost", // default to localhost Host = conf.Host ?? "localhost", // default to localhost
Database = conf.SqlDatabase, Database = conf.Database,
Username = conf.SqlUsername, Username = conf.Username,
Password = conf.SqlPassword Password = conf.Password
}.ToString(); }.ToString();
} }

View file

@ -25,10 +25,15 @@ public class CachedUser {
public string Username { get; set; } = null!; public string Username { get; set; } = null!;
/// <summary> /// <summary>
/// Gets the user's discriminator value. /// Gets the user's discriminator value. A value of "0000" means the user is on the new username system.
/// </summary> /// </summary>
public string Discriminator { get; set; } = null!; public string Discriminator { get; set; } = null!;
/// <summary>
/// Gets the user's display name. A user <em>may</em> have a global name if they are on the new username system.
/// </summary>
public string? GlobalName { get; set; } = null!;
/// <summary> /// <summary>
/// Gets the avatar URL, if any, for the associated user. /// Gets the avatar URL, if any, for the associated user.
/// </summary> /// </summary>

View file

@ -0,0 +1,239 @@
// <auto-generated />
using System;
using System.Collections.Generic;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
using RegexBot.Data;
#nullable disable
namespace RegexBot.Data.Migrations
{
[DbContext(typeof(BotDatabaseContext))]
[Migration("20231115032040_NewUsernames")]
partial class NewUsernames
{
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "6.0.7")
.HasAnnotation("Relational:MaxIdentifierLength", 63);
NpgsqlModelBuilderExtensions.HasPostgresEnum(modelBuilder, "mod_log_type", new[] { "other", "note", "warn", "timeout", "kick", "ban" });
NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b =>
{
b.Property<long>("MessageId")
.HasColumnType("bigint")
.HasColumnName("message_id");
b.Property<List<string>>("AttachmentNames")
.IsRequired()
.HasColumnType("text[]")
.HasColumnName("attachment_names");
b.Property<long>("AuthorId")
.HasColumnType("bigint")
.HasColumnName("author_id");
b.Property<long>("ChannelId")
.HasColumnType("bigint")
.HasColumnName("channel_id");
b.Property<string>("Content")
.HasColumnType("text")
.HasColumnName("content");
b.Property<DateTimeOffset>("CreatedAt")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasColumnName("created_at")
.HasDefaultValueSql("now()");
b.Property<DateTimeOffset?>("EditedAt")
.HasColumnType("timestamp with time zone")
.HasColumnName("edited_at");
b.Property<long>("GuildId")
.HasColumnType("bigint")
.HasColumnName("guild_id");
b.HasKey("MessageId")
.HasName("pk_cache_guildmessages");
b.HasIndex("AuthorId")
.HasDatabaseName("ix_cache_guildmessages_author_id");
b.ToTable("cache_guildmessages", (string)null);
});
modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
{
b.Property<long>("GuildId")
.HasColumnType("bigint")
.HasColumnName("guild_id");
b.Property<long>("UserId")
.HasColumnType("bigint")
.HasColumnName("user_id");
b.Property<DateTimeOffset>("FirstSeenTime")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasColumnName("first_seen_time")
.HasDefaultValueSql("now()");
b.Property<DateTimeOffset>("GULastUpdateTime")
.HasColumnType("timestamp with time zone")
.HasColumnName("gu_last_update_time");
b.Property<string>("Nickname")
.HasColumnType("text")
.HasColumnName("nickname");
b.HasKey("GuildId", "UserId")
.HasName("pk_cache_usersinguild");
b.HasIndex("UserId")
.HasDatabaseName("ix_cache_usersinguild_user_id");
b.ToTable("cache_usersinguild", (string)null);
});
modelBuilder.Entity("RegexBot.Data.CachedUser", b =>
{
b.Property<long>("UserId")
.HasColumnType("bigint")
.HasColumnName("user_id");
b.Property<string>("AvatarUrl")
.HasColumnType("text")
.HasColumnName("avatar_url");
b.Property<string>("Discriminator")
.IsRequired()
.HasMaxLength(4)
.HasColumnType("character(4)")
.HasColumnName("discriminator")
.IsFixedLength();
b.Property<string>("GlobalName")
.HasColumnType("text")
.HasColumnName("global_name");
b.Property<DateTimeOffset>("ULastUpdateTime")
.HasColumnType("timestamp with time zone")
.HasColumnName("u_last_update_time");
b.Property<string>("Username")
.IsRequired()
.HasColumnType("text")
.HasColumnName("username");
b.HasKey("UserId")
.HasName("pk_cache_users");
b.ToTable("cache_users", (string)null);
});
modelBuilder.Entity("RegexBot.Data.ModLogEntry", b =>
{
b.Property<int>("LogId")
.ValueGeneratedOnAdd()
.HasColumnType("integer")
.HasColumnName("log_id");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("LogId"));
b.Property<long>("GuildId")
.HasColumnType("bigint")
.HasColumnName("guild_id");
b.Property<string>("IssuedBy")
.IsRequired()
.HasColumnType("text")
.HasColumnName("issued_by");
b.Property<int>("LogType")
.HasColumnType("integer")
.HasColumnName("log_type");
b.Property<string>("Message")
.HasColumnType("text")
.HasColumnName("message");
b.Property<DateTimeOffset>("Timestamp")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasColumnName("timestamp")
.HasDefaultValueSql("now()");
b.Property<long>("UserId")
.HasColumnType("bigint")
.HasColumnName("user_id");
b.HasKey("LogId")
.HasName("pk_modlogs");
b.HasIndex("GuildId", "UserId")
.HasDatabaseName("ix_modlogs_guild_id_user_id");
b.ToTable("modlogs", (string)null);
});
modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b =>
{
b.HasOne("RegexBot.Data.CachedUser", "Author")
.WithMany("GuildMessages")
.HasForeignKey("AuthorId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_cache_guildmessages_cache_users_author_id");
b.Navigation("Author");
});
modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
{
b.HasOne("RegexBot.Data.CachedUser", "User")
.WithMany("Guilds")
.HasForeignKey("UserId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_cache_usersinguild_cache_users_user_id");
b.Navigation("User");
});
modelBuilder.Entity("RegexBot.Data.ModLogEntry", b =>
{
b.HasOne("RegexBot.Data.CachedGuildUser", "User")
.WithMany("Logs")
.HasForeignKey("GuildId", "UserId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_modlogs_cache_usersinguild_user_temp_id");
b.Navigation("User");
});
modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b =>
{
b.Navigation("Logs");
});
modelBuilder.Entity("RegexBot.Data.CachedUser", b =>
{
b.Navigation("GuildMessages");
b.Navigation("Guilds");
});
#pragma warning restore 612, 618
}
}
}

View file

@ -0,0 +1,25 @@
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace RegexBot.Data.Migrations
{
public partial class NewUsernames : Migration
{
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.AddColumn<string>(
name: "global_name",
table: "cache_users",
type: "text",
nullable: true);
}
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropColumn(
name: "global_name",
table: "cache_users");
}
}
}

View file

@ -120,6 +120,10 @@ namespace RegexBot.Data.Migrations
.HasColumnName("discriminator") .HasColumnName("discriminator")
.IsFixedLength(); .IsFixedLength();
b.Property<string>("GlobalName")
.HasColumnType("text")
.HasColumnName("global_name");
b.Property<DateTimeOffset>("ULastUpdateTime") b.Property<DateTimeOffset>("ULastUpdateTime")
.HasColumnType("timestamp with time zone") .HasColumnType("timestamp with time zone")
.HasColumnName("u_last_update_time"); .HasColumnName("u_last_update_time");

View file

@ -1,45 +0,0 @@
{
"$schema": "https://raw.githubusercontent.com/NoiTheCat/RegexBot/main/ServerConfigSchema.json",
"Name": "SERVER NAME", // Server name is optional, but useful as a reference
"Moderators": [
// Users and roles are accepted here.
"MODERATOR"
],
/*
The following configuration is provided as a sample for commonly-used features.
For a detailed reference which includes all possible configuration settings, see:
(TODO put documentation link here)
*/
"RegexModerator": [
{
"Label": "No cheese",
"Regex": "cheese",
"Response": [
"say #_ You can't say that, that's illegal",
"delete"
]
},
{
"Label": "Secret club initiation",
"Regex": "my name is .* and I dislike cheese",
"Response": [
"say @_ We welcome you.",
"addrole &00000::Secret Club member"
]
}
],
"AutoResponder": [
{
"Label": "Infinite no u",
"Regex": "no u",
"Reply": "no u"
},
{
"Label": "Acknowledge praise",
"Regex": "yes u",
"Reply": ":blush:"
}
]
}

View file

@ -1,21 +0,0 @@
MIT License
Copyright (c) 2018-2022 Noi <noithecat AT protonmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View file

@ -4,9 +4,4 @@
/// Represents an error occurring when a module attempts to create a new guild state object /// Represents an error occurring when a module attempts to create a new guild state object
/// (that is, read or refresh its configuration). /// (that is, read or refresh its configuration).
/// </summary> /// </summary>
public class ModuleLoadException : Exception { public class ModuleLoadException(string message) : Exception(message) { }
/// <summary>
/// Initializes this exception class with the specified error message.
/// </summary>
public ModuleLoadException(string message) : base(message) { }
}

View file

@ -7,7 +7,7 @@ static class ModuleLoader {
/// <summary> /// <summary>
/// Given the instance configuration, loads all appropriate types from file specified in it. /// Given the instance configuration, loads all appropriate types from file specified in it.
/// </summary> /// </summary>
internal static ReadOnlyCollection<RegexbotModule> Load(InstanceConfig conf, RegexbotClient rb) { internal static ReadOnlyCollection<RegexbotModule> Load(Configuration conf, RegexbotClient rb) {
var path = Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location) + Path.DirectorySeparatorChar; var path = Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location) + Path.DirectorySeparatorChar;
var modules = new List<RegexbotModule>(); var modules = new List<RegexbotModule>();
@ -38,7 +38,7 @@ static class ModuleLoader {
return modules.AsReadOnly(); return modules.AsReadOnly();
} }
static IEnumerable<RegexbotModule> LoadModulesFromAssembly(Assembly asm, RegexbotClient rb) { static List<RegexbotModule> LoadModulesFromAssembly(Assembly asm, RegexbotClient rb) {
var eligibleTypes = from type in asm.GetTypes() var eligibleTypes = from type in asm.GetTypes()
where !type.IsAssignableFrom(typeof(RegexbotModule)) where !type.IsAssignableFrom(typeof(RegexbotModule))
where type.GetCustomAttribute<RegexbotModuleAttribute>() != null where type.GetCustomAttribute<RegexbotModuleAttribute>() != null

View file

@ -45,7 +45,7 @@ internal class AutoResponder : RegexbotModule {
if (def.Command == null) { if (def.Command == null) {
await msg.Channel.SendMessageAsync(def.GetResponse()); await msg.Channel.SendMessageAsync(def.GetResponse());
} else { } else {
var cmdline = def.Command.Split(new char[] { ' ' }, 2); var cmdline = def.Command.Split([' '], 2);
var ps = new ProcessStartInfo() { var ps = new ProcessStartInfo() {
FileName = cmdline[0], FileName = cmdline[0],

View file

@ -1,7 +1,7 @@
using System.Text; using RegexBot.Common;
using System.Text;
namespace RegexBot.Modules.EntryRole; namespace RegexBot.Modules.EntryRole;
/// <summary> /// <summary>
/// Automatically sets a role onto users entering the guild after a predefined amount of time. /// Automatically sets a role onto users entering the guild after a predefined amount of time.
/// </summary> /// </summary>
@ -83,7 +83,7 @@ internal sealed class EntryRole : RegexbotModule, IDisposable {
foreach (var g in DiscordClient.Guilds) { foreach (var g in DiscordClient.Guilds) {
subworkers.Add(RoleApplyGuildSubWorker(g)); subworkers.Add(RoleApplyGuildSubWorker(g));
} }
Task.WaitAll(subworkers.ToArray()); Task.WaitAll([.. subworkers]);
} }
} }
@ -138,7 +138,7 @@ internal sealed class EntryRole : RegexbotModule, IDisposable {
var failList = new StringBuilder(); var failList = new StringBuilder();
var count = 0; var count = 0;
foreach (var item in failedUserList) { foreach (var item in failedUserList) {
failList.Append($", {item.Username}#{item.Discriminator}"); failList.Append($", {item.GetDisplayableUsername()}");
count++; count++;
if (count > 5) { if (count > 5) {
failList.Append($"and {count} other(s)."); failList.Append($"and {count} other(s).");

View file

@ -21,7 +21,7 @@ class GuildData {
const int WaitTimeMax = 600; // 10 minutes const int WaitTimeMax = 600; // 10 minutes
public GuildData(JObject conf) : this(conf, new Dictionary<ulong, DateTimeOffset>()) { } public GuildData(JObject conf) : this(conf, []) { }
public GuildData(JObject conf, Dictionary<ulong, DateTimeOffset> _waitingList) { public GuildData(JObject conf, Dictionary<ulong, DateTimeOffset> _waitingList) {
WaitingList = _waitingList; WaitingList = _waitingList;

View file

@ -14,17 +14,15 @@ class Ban : BanKick {
// Ban: Unlike kick, the minimum required is just the target ID // Ban: Unlike kick, the minimum required is just the target ID
var result = await Module.Bot.BanAsync(g, msg.Author.ToString(), targetId, PurgeDays, reason, SendNotify); var result = await Module.Bot.BanAsync(g, msg.Author.ToString(), targetId, PurgeDays, reason, SendNotify);
if (result.OperationSuccess && SuccessMessage != null) { if (result.OperationSuccess && SuccessMessage != null) {
// TODO string replacement, formatting, etc var success = Utilities.ProcessTextTokens(SuccessMessage, msg);
await msg.Channel.SendMessageAsync($"{SuccessMessage}\n{result.GetResultString(Module.Bot)}"); await msg.Channel.SendMessageAsync($"{success}\n{result.GetResultString(Module.Bot)}");
} else { } else {
await msg.Channel.SendMessageAsync(result.GetResultString(Module.Bot)); await msg.Channel.SendMessageAsync(result.GetResultString(Module.Bot));
} }
} }
} }
class Kick : BanKick { class Kick(ModCommands module, JObject config) : BanKick(module, config, false) {
public Kick(ModCommands module, JObject config) : base(module, config, false) { }
protected override async Task ContinueInvoke(SocketGuild g, SocketMessage msg, string? reason, protected override async Task ContinueInvoke(SocketGuild g, SocketMessage msg, string? reason,
ulong targetId, CachedGuildUser? targetQuery, SocketUser? targetUser) { ulong targetId, CachedGuildUser? targetQuery, SocketUser? targetUser) {
// Kick: Unlike ban, must find the guild user in order to proceed // Kick: Unlike ban, must find the guild user in order to proceed
@ -35,8 +33,8 @@ class Kick : BanKick {
var result = await Module.Bot.KickAsync(g, msg.Author.ToString(), targetId, reason, SendNotify); var result = await Module.Bot.KickAsync(g, msg.Author.ToString(), targetId, reason, SendNotify);
if (result.OperationSuccess && SuccessMessage != null) { if (result.OperationSuccess && SuccessMessage != null) {
// TODO string replacement, formatting, etc var success = Utilities.ProcessTextTokens(SuccessMessage, msg);
await msg.Channel.SendMessageAsync($"{SuccessMessage}\n{result.GetResultString(Module.Bot)}"); await msg.Channel.SendMessageAsync($"{success}\n{result.GetResultString(Module.Bot)}");
} else { } else {
await msg.Channel.SendMessageAsync(result.GetResultString(Module.Bot)); await msg.Channel.SendMessageAsync(result.GetResultString(Module.Bot));
} }
@ -76,7 +74,7 @@ abstract class BanKick : CommandConfig {
// Usage: (command) (user) (reason) // Usage: (command) (user) (reason)
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
string targetstr; string targetstr;
string? reason; string? reason;
if (line.Length < 2) { if (line.Length < 2) {

View file

@ -3,16 +3,10 @@ using System.Diagnostics;
namespace RegexBot.Modules.ModCommands.Commands; namespace RegexBot.Modules.ModCommands.Commands;
[DebuggerDisplay("Command definition '{Label}'")] [DebuggerDisplay("Command definition '{Label}'")]
abstract class CommandConfig { abstract class CommandConfig(ModCommands module, JObject config) {
public string Label { get; } public string Label { get; } = config[nameof(Label)]!.Value<string>()!;
public string Command { get; } public string Command { get; } = config[nameof(Command)]!.Value<string>()!;
protected ModCommands Module { get; } protected ModCommands Module { get; } = module;
protected CommandConfig(ModCommands module, JObject config) {
Module = module;
Label = config[nameof(Label)]!.Value<string>()!;
Command = config[nameof(Command)]!.Value<string>()!;
}
public abstract Task Invoke(SocketGuild g, SocketMessage msg); public abstract Task Invoke(SocketGuild g, SocketMessage msg);
@ -20,6 +14,7 @@ abstract class CommandConfig {
protected const string TargetNotFound = ":x: **Unable to find the given user.**"; protected const string TargetNotFound = ":x: **Unable to find the given user.**";
protected abstract string DefaultUsageMsg { get; } protected abstract string DefaultUsageMsg { get; }
/// <summary> /// <summary>
/// Sends out the default usage message (<see cref="DefaultUsageMsg"/>) within an embed. /// Sends out the default usage message (<see cref="DefaultUsageMsg"/>) within an embed.
/// An optional message can be included, for uses such as notifying users of incorrect usage. /// An optional message can be included, for uses such as notifying users of incorrect usage.
@ -36,4 +31,15 @@ abstract class CommandConfig {
}; };
await target.SendMessageAsync(message ?? "", embed: usageEmbed.Build()); await target.SendMessageAsync(message ?? "", embed: usageEmbed.Build());
} }
internal static readonly char[] separator = [' '];
/// <summary>
/// For the given message's content, assumes its message is a command and returns its parameters
/// as an array of substrings.
/// </summary>
/// <param name="msg">The incoming message to process.</param>
/// <param name="maxParams">The number of parameters to expect.</param>
/// <returns>A string array with 0 to maxParams - 1 elements.</returns>
protected static string[] SplitToParams(SocketMessage msg, int maxParams)
=> msg.Content.Split(separator, maxParams, StringSplitOptions.RemoveEmptyEntries);
} }

View file

@ -1,10 +1,7 @@
namespace RegexBot.Modules.ModCommands.Commands; namespace RegexBot.Modules.ModCommands.Commands;
class ConfReload : CommandConfig { class ConfReload(ModCommands module, JObject config) : CommandConfig(module, config) {
protected override string DefaultUsageMsg => null!; protected override string DefaultUsageMsg => null!;
// No configuration.
public ConfReload(ModCommands module, JObject config) : base(module, config) { }
// Usage: (command) // Usage: (command)
public override Task Invoke(SocketGuild g, SocketMessage msg) { public override Task Invoke(SocketGuild g, SocketMessage msg) {
throw new NotImplementedException(); throw new NotImplementedException();

View file

@ -2,9 +2,7 @@ using RegexBot.Common;
namespace RegexBot.Modules.ModCommands.Commands; namespace RegexBot.Modules.ModCommands.Commands;
// Note and Warn commands are highly similar in implementnation, and thus are handled in a single class. // Note and Warn commands are highly similar in implementnation, and thus are handled in a single class.
class Note : NoteWarn { class Note(ModCommands module, JObject config) : NoteWarn(module, config) {
public Note(ModCommands module, JObject config) : base(module, config) { }
protected override string DefaultUsageMsg => string.Format(_usageHeader, Command) protected override string DefaultUsageMsg => string.Format(_usageHeader, Command)
+ "Appends a note to the moderation log for the given user."; + "Appends a note to the moderation log for the given user.";
protected override async Task ContinueInvoke(SocketGuild g, SocketMessage msg, string logMessage, SocketUser targetUser) { protected override async Task ContinueInvoke(SocketGuild g, SocketMessage msg, string logMessage, SocketUser targetUser) {
@ -13,9 +11,7 @@ class Note : NoteWarn {
} }
} }
class Warn : NoteWarn { class Warn(ModCommands module, JObject config) : NoteWarn(module, config) {
public Warn(ModCommands module, JObject config) : base(module, config) { }
protected override string DefaultUsageMsg => string.Format(_usageHeader, Command) protected override string DefaultUsageMsg => string.Format(_usageHeader, Command)
+ "Issues a warning to the given user, logging the instance to this bot's moderation log " + "Issues a warning to the given user, logging the instance to this bot's moderation log "
+ "and notifying the offending user over DM of the issued warning."; + "and notifying the offending user over DM of the issued warning.";
@ -45,7 +41,7 @@ abstract class NoteWarn : CommandConfig {
// Usage: (command) (user) (message) // Usage: (command) (user) (message)
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
if (line.Length != 3) { if (line.Length != 3) {
await SendUsageMessageAsync(msg.Channel, ":x: Not all required parameters were specified."); await SendUsageMessageAsync(msg.Channel, ":x: Not all required parameters were specified.");
return; return;

View file

@ -1,17 +1,15 @@
using RegexBot.Common; using RegexBot.Common;
namespace RegexBot.Modules.ModCommands.Commands; namespace RegexBot.Modules.ModCommands.Commands;
class RoleAdd : RoleManipulation { class RoleAdd(ModCommands module, JObject config) : RoleManipulation(module, config) {
protected override (string, string) String1 => ("Adds", "to"); protected override (string, string) String1 => ("Adds", "to");
protected override string String2 => "set"; protected override string String2 => "set";
public RoleAdd(ModCommands module, JObject config) : base(module, config) { }
protected override async Task ContinueInvoke(SocketGuildUser target, SocketRole role) => await target.AddRoleAsync(role); protected override async Task ContinueInvoke(SocketGuildUser target, SocketRole role) => await target.AddRoleAsync(role);
} }
class RoleDel : RoleManipulation { class RoleDel(ModCommands module, JObject config) : RoleManipulation(module, config) {
protected override (string, string) String1 => ("Removes", "from"); protected override (string, string) String1 => ("Removes", "from");
protected override string String2 => "unset"; protected override string String2 => "unset";
public RoleDel(ModCommands module, JObject config) : base(module, config) { }
protected override async Task ContinueInvoke(SocketGuildUser target, SocketRole role) => await target.RemoveRoleAsync(role); protected override async Task ContinueInvoke(SocketGuildUser target, SocketRole role) => await target.RemoveRoleAsync(role);
} }
@ -46,7 +44,7 @@ abstract class RoleManipulation : CommandConfig {
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
// TODO reason in further parameters? // TODO reason in further parameters?
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
string targetstr; string targetstr;
if (line.Length < 2) { if (line.Length < 2) {
await SendUsageMessageAsync(msg.Channel, null); await SendUsageMessageAsync(msg.Channel, null);

View file

@ -13,7 +13,7 @@ class Say : CommandConfig {
} }
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
if (line.Length <= 1) { if (line.Length <= 1) {
await SendUsageMessageAsync(msg.Channel, ":x: You must specify a channel."); await SendUsageMessageAsync(msg.Channel, ":x: You must specify a channel.");
return; return;
@ -23,7 +23,7 @@ class Say : CommandConfig {
return; return;
} }
var getCh = Utilities.ChannelMention.Match(line[1]); var getCh = Utilities.ChannelMentionRegex().Match(line[1]);
if (!getCh.Success) { if (!getCh.Success) {
await SendUsageMessageAsync(msg.Channel, ":x: Unable to find given channel."); await SendUsageMessageAsync(msg.Channel, ":x: Unable to find given channel.");
return; return;

View file

@ -20,7 +20,7 @@ class ShowModLogs : CommandConfig {
// Usage: (command) (query) [page] // Usage: (command) (query) [page]
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
if (line.Length < 2) { if (line.Length < 2) {
await SendUsageMessageAsync(msg.Channel, null); await SendUsageMessageAsync(msg.Channel, null);
return; return;
@ -47,18 +47,17 @@ class ShowModLogs : CommandConfig {
.Where(l => l.GuildId == query.GuildId && l.UserId == query.UserId) .Where(l => l.GuildId == query.GuildId && l.UserId == query.UserId)
.Count(); .Count();
totalPages = (int)Math.Ceiling((double)totalEntries / LogEntriesPerMessage); totalPages = (int)Math.Ceiling((double)totalEntries / LogEntriesPerMessage);
results = db.ModLogs results = [.. db.ModLogs
.Where(l => l.GuildId == query.GuildId && l.UserId == query.UserId) .Where(l => l.GuildId == query.GuildId && l.UserId == query.UserId)
.OrderByDescending(l => l.LogId) .OrderByDescending(l => l.LogId)
.Skip((pagenum - 1) * LogEntriesPerMessage) .Skip((pagenum - 1) * LogEntriesPerMessage)
.Take(LogEntriesPerMessage) .Take(LogEntriesPerMessage)
.AsNoTracking() .AsNoTracking()];
.ToList();
} }
var resultList = new EmbedBuilder() { var resultList = new EmbedBuilder() {
Author = new EmbedAuthorBuilder() { Author = new EmbedAuthorBuilder() {
Name = $"{query.User.Username}#{query.User.Discriminator}", Name = $"{query.User.GetDisplayableUsername()}",
IconUrl = query.User.AvatarUrl IconUrl = query.User.AvatarUrl
}, },
Footer = new EmbedFooterBuilder() { Footer = new EmbedFooterBuilder() {

View file

@ -26,7 +26,7 @@ class Timeout : CommandConfig {
// Usage: (command) (user) (duration) (reason) // Usage: (command) (user) (duration) (reason)
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 4, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 4);
string targetstr; string targetstr;
string? reason; string? reason;
if (line.Length < 3) { if (line.Length < 3) {
@ -64,8 +64,8 @@ class Timeout : CommandConfig {
var result = await Module.Bot.SetTimeoutAsync(g, msg.Author.AsEntityNameString(), targetUser, var result = await Module.Bot.SetTimeoutAsync(g, msg.Author.AsEntityNameString(), targetUser,
TimeSpan.FromMinutes(timeParam), reason, SendNotify); TimeSpan.FromMinutes(timeParam), reason, SendNotify);
if (result.Success && SuccessMessage != null) { if (result.Success && SuccessMessage != null) {
// TODO string replacement, formatting, etc var success = Utilities.ProcessTextTokens(SuccessMessage, msg);
await msg.Channel.SendMessageAsync($"{SuccessMessage}\n{result.ToResultString()}"); await msg.Channel.SendMessageAsync($"{success}\n{result.ToResultString()}");
} else { } else {
await msg.Channel.SendMessageAsync(result.ToResultString()); await msg.Channel.SendMessageAsync(result.ToResultString());
} }

View file

@ -16,7 +16,7 @@ class Unban : CommandConfig {
// Usage: (command) (user query) // Usage: (command) (user query)
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
string targetstr; string targetstr;
if (line.Length < 2) { if (line.Length < 2) {
await SendUsageMessageAsync(msg.Channel, null); await SendUsageMessageAsync(msg.Channel, null);
@ -29,13 +29,13 @@ class Unban : CommandConfig {
var query = Module.Bot.EcQueryUser(targetstr); var query = Module.Bot.EcQueryUser(targetstr);
if (query != null) { if (query != null) {
targetId = (ulong)query.UserId; targetId = (ulong)query.UserId;
targetDisplay = $"{query.Username}#{query.Discriminator}"; targetDisplay = $"**{query.GetDisplayableUsername()}**";
} else { } else {
if (!ulong.TryParse(targetstr, out targetId)) { if (!ulong.TryParse(targetstr, out targetId)) {
await SendUsageMessageAsync(msg.Channel, TargetNotFound); await SendUsageMessageAsync(msg.Channel, TargetNotFound);
return; return;
} }
targetDisplay = $"with ID {targetId}"; targetDisplay = $"with ID **{targetId}**";
} }
// Do the action // Do the action

View file

@ -16,7 +16,7 @@ class Untimeout : CommandConfig {
// Usage: (command) (user query) // Usage: (command) (user query)
public override async Task Invoke(SocketGuild g, SocketMessage msg) { public override async Task Invoke(SocketGuild g, SocketMessage msg) {
var line = msg.Content.Split(new char[] { ' ' }, 3, StringSplitOptions.RemoveEmptyEntries); var line = SplitToParams(msg, 3);
string targetstr; string targetstr;
if (line.Length < 2) { if (line.Length < 2) {
await SendUsageMessageAsync(msg.Channel, null); await SendUsageMessageAsync(msg.Channel, null);

View file

@ -17,9 +17,9 @@ class ModuleConfig {
Label = def[nameof(Label)]?.Value<string>() Label = def[nameof(Label)]?.Value<string>()
?? throw new ModuleLoadException($"'{nameof(Label)}' was not defined in a command definition."); ?? throw new ModuleLoadException($"'{nameof(Label)}' was not defined in a command definition.");
var cmd = CreateCommandInstance(instance, def); var cmd = CreateCommandInstance(instance, def);
if (commands.ContainsKey(cmd.Command)) { if (commands.TryGetValue(cmd.Command, out CommandConfig? existing)) {
throw new ModuleLoadException( throw new ModuleLoadException(
$"{Label}: The command name '{cmd.Command}' is already in use by '{commands[cmd.Command].Label}'."); $"{Label}: The command name '{cmd.Command}' is already in use by '{existing.Label}'.");
} }
commands.Add(cmd.Command, cmd); commands.Add(cmd.Command, cmd);
} }

View file

@ -24,7 +24,7 @@ internal partial class ModLogs {
var issuedDisplay = Utilities.TryFromEntityNameString(entry.IssuedBy, Bot); var issuedDisplay = Utilities.TryFromEntityNameString(entry.IssuedBy, Bot);
string targetDisplay; string targetDisplay;
var targetq = Bot.EcQueryUser(entry.UserId.ToString()); var targetq = Bot.EcQueryUser(entry.UserId.ToString());
if (targetq != null) targetDisplay = $"<@{targetq.UserId}> - {targetq.Username}#{targetq.Discriminator} `{targetq.UserId}`"; if (targetq != null) targetDisplay = $"<@{targetq.UserId}> - {targetq.GetDisplayableUsername()} `{targetq.UserId}`";
else targetDisplay = $"User with ID `{entry.UserId}`"; else targetDisplay = $"User with ID `{entry.UserId}`";
var logEmbed = new EmbedBuilder() var logEmbed = new EmbedBuilder()

View file

@ -1,5 +1,6 @@
using Discord; using Discord;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
using RegexBot.Common;
using RegexBot.Data; using RegexBot.Data;
using System.Text; using System.Text;
@ -13,6 +14,7 @@ internal partial class ModLogs {
private async Task HandleDelete(Cacheable<IMessage, ulong> argMsg, Cacheable<IMessageChannel, ulong> argChannel) { private async Task HandleDelete(Cacheable<IMessage, ulong> argMsg, Cacheable<IMessageChannel, ulong> argChannel) {
const int MaxPreviewLength = 750; const int MaxPreviewLength = 750;
if (argChannel.Value is not SocketTextChannel channel) return; if (argChannel.Value is not SocketTextChannel channel) return;
var conf = GetGuildState<ModuleConfig>(channel.Guild.Id); var conf = GetGuildState<ModuleConfig>(channel.Guild.Id);
if ((conf?.LogMessageDeletions ?? false) == false) return; if ((conf?.LogMessageDeletions ?? false) == false) return;
var reportChannel = conf?.ReportingChannel?.FindChannelIn(channel.Guild, true); var reportChannel = conf?.ReportingChannel?.FindChannelIn(channel.Guild, true);
@ -50,7 +52,7 @@ internal partial class ModLogs {
}; };
} else { } else {
reportEmbed.Author = new EmbedAuthorBuilder() { reportEmbed.Author = new EmbedAuthorBuilder() {
Name = $"{cachedMsg.Author.Username}#{cachedMsg.Author.Discriminator}", Name = $"{cachedMsg.Author.GetDisplayableUsername()}",
IconUrl = cachedMsg.Author.AvatarUrl ?? GetDefaultAvatarUrl(cachedMsg.Author.Discriminator) IconUrl = cachedMsg.Author.AvatarUrl ?? GetDefaultAvatarUrl(cachedMsg.Author.Discriminator)
}; };
} }
@ -71,6 +73,7 @@ internal partial class ModLogs {
var channel = (SocketTextChannel)newMsg.Channel; var channel = (SocketTextChannel)newMsg.Channel;
var conf = GetGuildState<ModuleConfig>(channel.Guild.Id); var conf = GetGuildState<ModuleConfig>(channel.Guild.Id);
if (newMsg.Author.IsBot || newMsg.Author.IsWebhook) return;
var reportChannel = conf?.ReportingChannel?.FindChannelIn(channel.Guild, true); var reportChannel = conf?.ReportingChannel?.FindChannelIn(channel.Guild, true);
if (reportChannel == null) return; if (reportChannel == null) return;
if (reportChannel.Id == channel.Id) { if (reportChannel.Id == channel.Id) {
@ -85,7 +88,7 @@ internal partial class ModLogs {
.WithFooter($"Message ID: {newMsg.Id}"); .WithFooter($"Message ID: {newMsg.Id}");
reportEmbed.Author = new EmbedAuthorBuilder() { reportEmbed.Author = new EmbedAuthorBuilder() {
Name = $"{newMsg.Author.Username}#{newMsg.Author.Discriminator}", Name = $"{newMsg.Author.GetDisplayableUsername()}",
IconUrl = newMsg.Author.GetAvatarUrl() ?? newMsg.Author.GetDefaultAvatarUrl() IconUrl = newMsg.Author.GetAvatarUrl() ?? newMsg.Author.GetDefaultAvatarUrl()
}; };
@ -130,7 +133,7 @@ internal partial class ModLogs {
string userDisplay; string userDisplay;
if (userId.HasValue) { if (userId.HasValue) {
var q = Bot.EcQueryUser(userId.Value.ToString()); var q = Bot.EcQueryUser(userId.Value.ToString());
if (q != null) userDisplay = $"<@{q.UserId}> - {q.Username}#{q.Discriminator} `{q.UserId}`"; if (q != null) userDisplay = $"<@{q.UserId}> - {q.GetDisplayableUsername()} `{q.UserId}`";
else userDisplay = $"Unknown user with ID `{userId}`"; else userDisplay = $"Unknown user with ID `{userId}`";
} else { } else {
userDisplay = "Unknown"; userDisplay = "Unknown";

View file

@ -12,6 +12,5 @@ class ModuleConfig {
} catch (FormatException) { } catch (FormatException) {
throw new ModuleLoadException("Name specified in configuration is not a role."); throw new ModuleLoadException("Name specified in configuration is not a role.");
} }
} }
} }

View file

@ -33,7 +33,7 @@ class ResponseExecutor {
_user = (SocketGuildUser)msg.Author; _user = (SocketGuildUser)msg.Author;
_guild = _user.Guild; _guild = _user.Guild;
_reports = new(); _reports = [];
Log = logger; Log = logger;
} }
@ -113,8 +113,8 @@ class ResponseExecutor {
} }
) )
.WithAuthor( .WithAuthor(
name: $"{_msg.Author.Username}#{_msg.Author.Discriminator} said:", name: $"{_user.GetDisplayableUsername()} said:",
iconUrl: _msg.Author.GetAvatarUrl(), iconUrl: _user.GetAvatarUrl(),
url: _msg.GetJumpUrl() url: _msg.GetJumpUrl()
) )
.WithDescription(invokingLine) .WithDescription(invokingLine)
@ -127,7 +127,7 @@ class ResponseExecutor {
try { try {
await reportTarget.SendMessageAsync(embed: resultEmbed); await reportTarget.SendMessageAsync(embed: resultEmbed);
} catch (Discord.Net.HttpException ex) when (ex.HttpCode == System.Net.HttpStatusCode.Forbidden) { } catch (Discord.Net.HttpException ex) when (ex.HttpCode == System.Net.HttpStatusCode.Forbidden) {
Log("Encountered 403 error when attempting to send report."); Log("Encountered error 403 when attempting to send report.");
} }
} }
} }
@ -218,7 +218,7 @@ class ResponseExecutor {
if (targetCh == null) return FromError($"Unable to find channel '{name.Name}'."); if (targetCh == null) return FromError($"Unable to find channel '{name.Name}'.");
isUser = false; isUser = false;
} else if (name.Type == EntityType.User) { } else if (name.Type == EntityType.User) {
if (name.Name == "_") targetCh = await _msg.Author.CreateDMChannelAsync(); if (name.Name == "_") targetCh = await _user.CreateDMChannelAsync();
else { else {
var searchedUser = name.FindUserIn(_guild); var searchedUser = name.FindUserIn(_guild);
if (searchedUser == null) return FromError($"Unable to find user '{name.Name}'."); if (searchedUser == null) return FromError($"Unable to find user '{name.Name}'.");
@ -229,7 +229,7 @@ class ResponseExecutor {
return FromError("Channel or user were not correctly set in configuration."); return FromError("Channel or user were not correctly set in configuration.");
} }
if (targetCh == null) return FromError("Could not acquire target channel."); if (targetCh == null) return FromError("Could not acquire target channel.");
await targetCh.SendMessageAsync(param[1]); await targetCh.SendMessageAsync(Utilities.ProcessTextTokens(param[1], _msg));
return FromSuccess($"Sent to {(isUser ? "user DM" : $"<#{targetCh.Id}>")}."); return FromSuccess($"Sent to {(isUser ? "user DM" : $"<#{targetCh.Id}>")}.");
} }

View file

@ -23,9 +23,7 @@ class ModuleConfig {
} catch (FormatException) { } catch (FormatException) {
throw new ModuleLoadException($"'{item.Name}' is not specified as a role."); throw new ModuleLoadException($"'{item.Name}' is not specified as a role.");
} }
var role = name.FindRoleIn(g); var role = name.FindRoleIn(g) ?? throw new ModuleLoadException($"Unable to find role '{name}'.");
if (role == null) throw new ModuleLoadException($"Unable to find role '{name}'.");
var channels = Utilities.LoadStringOrStringArray(item.Value); var channels = Utilities.LoadStringOrStringArray(item.Value);
if (channels.Count == 0) throw new ModuleLoadException($"One or more channels must be defined under '{name}'."); if (channels.Count == 0) throw new ModuleLoadException($"One or more channels must be defined under '{name}'.");
foreach (var id in channels) { foreach (var id in channels) {

View file

@ -15,9 +15,9 @@ class Program {
StartTime = DateTimeOffset.UtcNow; StartTime = DateTimeOffset.UtcNow;
Console.WriteLine("Bot start time: " + StartTime.ToString("u")); Console.WriteLine("Bot start time: " + StartTime.ToString("u"));
InstanceConfig cfg; Configuration cfg;
try { try {
cfg = new InstanceConfig(); // Program may exit within here. cfg = new Configuration(); // Program may exit within here.
} catch (Exception ex) { } catch (Exception ex) {
Console.WriteLine(ex.Message); Console.WriteLine(ex.Message);
Environment.ExitCode = 1; Environment.ExitCode = 1;

View file

@ -1,37 +1,31 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <Version>3.2.1</Version>
<TargetFramework>net6.0</TargetFramework>
<Authors>NoiTheCat</Authors> <Authors>NoiTheCat</Authors>
<Description>Advanced and flexible Discord moderation bot.</Description> <Description>Advanced and flexible Discord moderation bot.</Description>
<Version>3.1.1</Version>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings> <ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
<GenerateDocumentationFile>True</GenerateDocumentationFile> <GenerateDocumentationFile>True</GenerateDocumentationFile>
<SatelliteResourceLanguages>en</SatelliteResourceLanguages>
</PropertyGroup> </PropertyGroup>
<ItemGroup>
<None Remove="DefaultGuildConfig.json" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="DefaultGuildConfig.json" />
</ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="CommandLineParser" Version="2.9.1" /> <PackageReference Include="CommandLineParser" Version="2.9.1" />
<PackageReference Include="Discord.Net" Version="3.8.1" /> <PackageReference Include="Discord.Net" Version="3.15.0" />
<PackageReference Include="EFCore.NamingConventions" Version="6.0.0" /> <PackageReference Include="EFCore.NamingConventions" Version="8.0.3" />
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="6.0.7" /> <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.6" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="6.0.7"> <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.6">
<PrivateAssets>all</PrivateAssets> <PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference> </PackageReference>
<PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="6.0.7" /> <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="8.0.6" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.2" /> <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="Npgsql" Version="6.0.7" /> <PackageReference Include="Npgsql" Version="8.0.3" />
<PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="6.0.7" /> <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.4" />
<PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL.Design" Version="1.1.0" /> <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL.Design" Version="1.1.0" />
</ItemGroup> </ItemGroup>

View file

@ -8,7 +8,7 @@ public partial class RegexbotClient {
/// <summary> /// <summary>
/// Gets application instance configuration. /// Gets application instance configuration.
/// </summary> /// </summary>
internal InstanceConfig Config { get; } internal Configuration Config { get; }
/// <summary> /// <summary>
/// Gets the Discord client instance. /// Gets the Discord client instance.
@ -20,14 +20,14 @@ public partial class RegexbotClient {
/// </summary> /// </summary>
internal IReadOnlyCollection<RegexbotModule> Modules { get; } internal IReadOnlyCollection<RegexbotModule> Modules { get; }
internal RegexbotClient(InstanceConfig conf, DiscordSocketClient client) { internal RegexbotClient(Configuration conf, DiscordSocketClient client) {
Config = conf; Config = conf;
DiscordClient = client; DiscordClient = client;
// Get all services started up // Get all services started up
_svcLogging = new Services.Logging.LoggingService(this); _svcLogging = new Services.Logging.LoggingService(this);
_svcSharedEvents = new Services.SharedEventService.SharedEventService(this); _svcSharedEvents = new Services.SharedEventService.SharedEventService(this);
_svcGuildState = new Services.ModuleState.ModuleStateService(this); _svcGuildState = new Services.ModuleState.ModuleStateService(this, conf.ServerConfigs);
_svcCommonFunctions = new Services.CommonFunctions.CommonFunctionsService(this); _svcCommonFunctions = new Services.CommonFunctions.CommonFunctionsService(this);
_svcEntityCache = new Services.EntityCache.EntityCacheService(this); _svcEntityCache = new Services.EntityCache.EntityCacheService(this);

View file

@ -10,24 +10,20 @@ namespace RegexBot;
/// <remarks> /// <remarks>
/// Implementing classes should not rely on local variables to store runtime or state data for guilds. /// Implementing classes should not rely on local variables to store runtime or state data for guilds.
/// Instead, use <see cref="CreateGuildStateAsync"/> and <see cref="GetGuildState"/>. /// Instead, use <see cref="CreateGuildStateAsync"/> and <see cref="GetGuildState"/>.
/// <br/><br/>
/// Additionally, do not assume that <see cref="DiscordClient"/> is available during the constructor.
/// </remarks> /// </remarks>
public abstract class RegexbotModule { public abstract class RegexbotModule(RegexbotClient bot) {
/// <summary> /// <summary>
/// Retrieves the bot instance. /// Retrieves the bot instance.
/// </summary> /// </summary>
public RegexbotClient Bot { get; } public RegexbotClient Bot { get; } = bot;
/// <summary> /// <summary>
/// Retrieves the Discord client instance. /// Retrieves the Discord client instance.
/// </summary> /// </summary>
public DiscordSocketClient DiscordClient { get => Bot.DiscordClient; } public DiscordSocketClient DiscordClient { get => Bot.DiscordClient; }
/// <summary>
/// Called when a module is being loaded.
/// At this point, all bot services are available, but Discord is not. Do not use <see cref="DiscordClient"/>.
/// </summary>
public RegexbotModule(RegexbotClient bot) => Bot = bot;
/// <summary> /// <summary>
/// Gets the name of this module. /// Gets the name of this module.
/// </summary> /// </summary>

57
SampleConfiguration.json Normal file
View file

@ -0,0 +1,57 @@
{
"$schema": "https://raw.githubusercontent.com/NoiTheCat/RegexBot/main/ConfigurationSchema.json",
"BotToken": "12345678901234567890qwertyuiop.1234567890",
//"Assemblies": [ "RegexBot.dll" ],
"DatabaseOptions": {
"Username": "regexbot",
"Password": "regexbot"
},
"Servers": {
"00000000": { // Place server ID here
"Name": "SERVER NAME", // Server name is unused by the bot, but is useful as a reference.
"Moderators": [
// Users and roles are accepted here.
"MODERATOR"
],
/*
The following configuration is provided as a sample for commonly-used features.
For a detailed reference which includes all possible configuration settings, see
this project's documentation.
*/
"RegexModerator": [
{
"Label": "No cheese",
"Regex": "cheese",
"Response": [
"say #_ You can't say that, that's illegal",
"delete"
]
},
{
"Label": "Secret club initiation",
"Regex": "my name is .* and I (hate|dislike) cheese",
"Response": [
"say @_ We welcome you.",
"addrole &00000::Secret Club member"
]
}
],
"AutoResponder": [
{
"Label": "Infinite no u",
"Regex": "no u",
"Reply": "no u"
},
{
"Label": "Acknowledge praise",
"Regex": "yes u",
"Reply": ":blush:"
}
]
}
}
}

View file

@ -1,21 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The server's name. The value is unused by the application and is only for user reference."
},
"Moderators": {
"type": "array",
"description": "A list of entities which the bot should recognize as moderators.",
"items": {
"type": "string"
}
}
/* schema still a work in progress */
},
"required": [
"Moderators"
]
}

View file

@ -98,8 +98,7 @@ public class BanKickResult {
if (_rptTargetId != 0) { if (_rptTargetId != 0) {
var user = bot.EcQueryUser(_rptTargetId.ToString()); var user = bot.EcQueryUser(_rptTargetId.ToString());
if (user != null) { if (user != null) {
// TODO sanitize possible formatting characters in display name msg += $" user **{user.GetDisplayableUsername()}**";
msg += $" user **{user.Username}#{user.Discriminator}**";
} else { } else {
msg += $" user with ID **{_rptTargetId}**"; msg += $" user with ID **{_rptTargetId}**";
} }

View file

@ -68,7 +68,7 @@ partial class RegexbotClient {
// Attempt warning message // Attempt warning message
var userSearch = _svcEntityCache.QueryUserCache(targetUser.ToString()); var userSearch = _svcEntityCache.QueryUserCache(targetUser.ToString());
var userDisp = userSearch != null var userDisp = userSearch != null
? $"**{userSearch.Username}#{userSearch.Discriminator}**" ? $"**{userSearch.GetDisplayableUsername()}**"
: $"user with ID **{targetUser}**"; : $"user with ID **{targetUser}**";
var targetGuildUser = guild.GetUser(targetUser); var targetGuildUser = guild.GetUser(targetUser);
if (targetGuildUser == null) return (entry, new LogAppendResult( if (targetGuildUser == null) return (entry, new LogAppendResult(

View file

@ -6,10 +6,9 @@ namespace RegexBot.Services.CommonFunctions {
/// functions may help enforce a sense of consistency across modules when performing common actions, and may /// functions may help enforce a sense of consistency across modules when performing common actions, and may
/// inform services which provide any additional features the ability to respond to those actions ahead of time. /// inform services which provide any additional features the ability to respond to those actions ahead of time.
/// </summary> /// </summary>
internal partial class CommonFunctionsService : Service { internal partial class CommonFunctionsService(RegexbotClient bot) : Service(bot) {
// Note: Several classes within this service created by its hooks are meant to be sent to modules, // Note: Several classes within this service created by its hooks are meant to be sent to modules,
// therefore those public classes are placed into the root RegexBot namespace for the developer's convenience. // therefore those public classes are placed into the root RegexBot namespace for the developer's convenience.
public CommonFunctionsService(RegexbotClient bot) : base(bot) { }
} }
} }

View file

@ -15,10 +15,10 @@ public class TimeoutSetResult : IOperationResult {
public Exception? Error { get; } public Exception? Error { get; }
/// <inheritdoc/> /// <inheritdoc/>
public bool ErrorNotFound => (_target == null) || ((Error as HttpException)?.HttpCode == System.Net.HttpStatusCode.NotFound); public bool ErrorNotFound => (_target == null) || Error is HttpException { HttpCode: System.Net.HttpStatusCode.NotFound };
/// <inheritdoc/> /// <inheritdoc/>
public bool ErrorForbidden => (Error as HttpException)?.HttpCode == System.Net.HttpStatusCode.Forbidden; public bool ErrorForbidden => Error is HttpException { HttpCode: System.Net.HttpStatusCode.Forbidden };
/// <inheritdoc/> /// <inheritdoc/>
public bool NotificationSuccess { get; } public bool NotificationSuccess { get; }
@ -32,7 +32,7 @@ public class TimeoutSetResult : IOperationResult {
/// <inheritdoc/> /// <inheritdoc/>
public string ToResultString() { public string ToResultString() {
if (Success) { if (Success) {
var msg = $":white_check_mark: Timeout set for **{_target!.Username}#{_target.Discriminator}**."; var msg = $":white_check_mark: Timeout set for **{_target!.GetDisplayableUsername()}**.";
if (!NotificationSuccess) msg += "\n(User was unable to receive notification message.)"; if (!NotificationSuccess) msg += "\n(User was unable to receive notification message.)";
return msg; return msg;
} else { } else {

View file

@ -17,13 +17,14 @@ class MessageCachingSubservice {
// This event is fired also when a link preview embed is added to a message. In those situations, the message's edited timestamp // This event is fired also when a link preview embed is added to a message. In those situations, the message's edited timestamp
// remains null, in addition to having other unusual and unexpected properties. We are not interested in these. // remains null, in addition to having other unusual and unexpected properties. We are not interested in these.
if (!arg2.EditedTimestamp.HasValue) return Task.CompletedTask; if (!arg2.EditedTimestamp.HasValue) return Task.CompletedTask;
if (arg2.Author.IsBot || arg2.Author.IsWebhook) return Task.CompletedTask; // we don't log these anyway, so don't pass them on
return AddOrUpdateCacheItemAsync(arg2, true); return AddOrUpdateCacheItemAsync(arg2, true);
} }
private async Task AddOrUpdateCacheItemAsync(SocketMessage arg, bool isUpdate) { private async Task AddOrUpdateCacheItemAsync(SocketMessage arg, bool isUpdate) {
//if (!Common.Utilities.IsValidUserMessage(arg, out _)) return; //if (!Common.Utilities.IsValidUserMessage(arg, out _)) return;
if (arg.Channel is not SocketTextChannel) return; if (arg.Channel is not SocketTextChannel) return;
if (arg.Author.IsWebhook) return; // do get bot messages, don't get webhooks if (arg.Author.IsBot || arg.Author.IsWebhook) return; // do not get messages from an automated source
if (((IMessage)arg).Type != MessageType.Default) return; if (((IMessage)arg).Type != MessageType.Default) return;
if (arg is SocketSystemMessage) return; if (arg is SocketSystemMessage) return;

View file

@ -60,6 +60,7 @@ class UserCachingSubservice {
uinfo.Username = user.Username; uinfo.Username = user.Username;
uinfo.Discriminator = user.Discriminator; uinfo.Discriminator = user.Discriminator;
uinfo.GlobalName = user.GlobalName;
uinfo.AvatarUrl = user.GetAvatarUrl(size: 512); uinfo.AvatarUrl = user.GetAvatarUrl(size: 512);
uinfo.ULastUpdateTime = DateTimeOffset.UtcNow; uinfo.ULastUpdateTime = DateTimeOffset.UtcNow;
} }
@ -85,7 +86,7 @@ class UserCachingSubservice {
if (sID.HasValue) if (sID.HasValue)
query = query.Where(c => c.UserId == (long)sID.Value); query = query.Where(c => c.UserId == (long)sID.Value);
if (nameSearch != null) { if (nameSearch != null) {
query = query.Where(c => c.Username.ToLower() == nameSearch.Value.name.ToLower()); query = query.Where(c => c.Username.Equals(nameSearch.Value.name, StringComparison.OrdinalIgnoreCase));
if (nameSearch.Value.disc != null) query = query.Where(c => c.Discriminator == nameSearch.Value.disc); if (nameSearch.Value.disc != null) query = query.Where(c => c.Discriminator == nameSearch.Value.disc);
} }
query = query.OrderByDescending(e => e.ULastUpdateTime); query = query.OrderByDescending(e => e.ULastUpdateTime);
@ -94,7 +95,7 @@ class UserCachingSubservice {
} }
// Is search actually a ping? Extract ID. // Is search actually a ping? Extract ID.
var m = Utilities.UserMention.Match(search); var m = Utilities.UserMentionRegex().Match(search);
if (m.Success) search = m.Groups["snowflake"].Value; if (m.Success) search = m.Groups["snowflake"].Value;
// Is search a number? Assume ID, proceed to query. // Is search a number? Assume ID, proceed to query.
@ -116,8 +117,9 @@ class UserCachingSubservice {
if (sID.HasValue) if (sID.HasValue)
query = query.Where(c => c.UserId == (long)sID.Value); query = query.Where(c => c.UserId == (long)sID.Value);
if (nameSearch != null) { if (nameSearch != null) {
query = query.Where(c => (c.Nickname != null && c.Nickname.ToLower() == nameSearch.Value.name.ToLower()) || query = query.Where(c => (c.Nickname != null
c.User.Username.ToLower() == nameSearch.Value.name.ToLower()); && c.Nickname.Equals(nameSearch.Value.name, StringComparison.OrdinalIgnoreCase))
|| c.User.Username.Equals(nameSearch.Value.name, StringComparison.OrdinalIgnoreCase));
if (nameSearch.Value.disc != null) query = query.Where(c => c.User.Discriminator == nameSearch.Value.disc); if (nameSearch.Value.disc != null) query = query.Where(c => c.User.Discriminator == nameSearch.Value.disc);
} }
query = query.OrderByDescending(e => e.GULastUpdateTime); query = query.OrderByDescending(e => e.GULastUpdateTime);
@ -126,7 +128,7 @@ class UserCachingSubservice {
} }
// Is search actually a ping? Extract ID. // Is search actually a ping? Extract ID.
var m = Utilities.UserMention.Match(search); var m = Utilities.UserMentionRegex().Match(search);
if (m.Success) search = m.Groups["snowflake"].Value; if (m.Success) search = m.Groups["snowflake"].Value;
// Is search a number? Assume ID, proceed to query. // Is search a number? Assume ID, proceed to query.
@ -143,7 +145,7 @@ class UserCachingSubservice {
private static (string, string?) SplitNameAndDiscriminator(string input) { private static (string, string?) SplitNameAndDiscriminator(string input) {
string name; string name;
string? disc = null; string? disc = null;
var split = Utilities.DiscriminatorSearch.Match(input); var split = Utilities.DiscriminatorSearchRegex().Match(input);
if (split.Success) { if (split.Success) {
name = split.Groups[1].Value; name = split.Groups[1].Value;
disc = split.Groups[2].Value; disc = split.Groups[2].Value;

View file

@ -52,7 +52,7 @@ class LoggingService : Service {
var now = DateTimeOffset.Now; var now = DateTimeOffset.Now;
var output = new StringBuilder(); var output = new StringBuilder();
var prefix = $"[{now:s}] [{source}] "; var prefix = $"[{now:s}] [{source}] ";
foreach (var line in message.Split(new string[] { "\r\n", "\n" }, StringSplitOptions.None)) { foreach (var line in message.Split(["\r\n", "\n"], StringSplitOptions.None)) {
output.Append(prefix).AppendLine(line); output.Append(prefix).AppendLine(line);
} }
var outstr = output.ToString(); var outstr = output.ToString();

View file

@ -1,20 +1,18 @@
using Newtonsoft.Json; using RegexBot.Common;
using RegexBot.Common;
using System.Reflection;
namespace RegexBot.Services.ModuleState; namespace RegexBot.Services.ModuleState;
/// <summary> /// <summary>
/// Implements per-module storage and retrieval of guild-specific state data, most typically but not limited to configuration data. /// Implements per-module storage and retrieval of guild-specific state data, most typically but not limited to configuration data.
/// To that end, this service handles loading and validation of per-guild configuration files.
/// </summary> /// </summary>
class ModuleStateService : Service { class ModuleStateService : Service {
private readonly object _storageLock = new();
private readonly Dictionary<ulong, EntityList> _moderators; private readonly Dictionary<ulong, EntityList> _moderators;
private readonly Dictionary<ulong, Dictionary<Type, object?>> _stateData; private readonly Dictionary<ulong, Dictionary<Type, object?>> _guildStates;
private readonly JObject _serverConfs;
public ModuleStateService(RegexbotClient bot) : base(bot) { public ModuleStateService(RegexbotClient bot, JObject servers) : base(bot) {
_moderators = new(); _moderators = [];
_stateData = new(); _guildStates = [];
_serverConfs = servers;
bot.DiscordClient.GuildAvailable += RefreshGuildState; bot.DiscordClient.GuildAvailable += RefreshGuildState;
bot.DiscordClient.JoinedGuild += RefreshGuildState; bot.DiscordClient.JoinedGuild += RefreshGuildState;
@ -27,45 +25,34 @@ class ModuleStateService : Service {
} }
private Task RemoveGuildData(SocketGuild arg) { private Task RemoveGuildData(SocketGuild arg) {
lock (_storageLock) { _guildStates.Remove(arg.Id);
_stateData.Remove(arg.Id);
_moderators.Remove(arg.Id); _moderators.Remove(arg.Id);
}
return Task.CompletedTask; return Task.CompletedTask;
} }
// Hooked // Hooked
public T? DoGetStateObj<T>(ulong guildId, Type t) { public T? DoGetStateObj<T>(ulong guildId, Type t) {
lock (_storageLock) { if (_guildStates.TryGetValue(guildId, out var guildConfs)) {
if (_stateData.ContainsKey(guildId) && _stateData[guildId].ContainsKey(t)) { if (guildConfs.TryGetValue(t, out var moduleConf)) {
// Leave handling of potential InvalidCastException to caller. // Leave handling of potential InvalidCastException to caller.
return (T?)_stateData[guildId][t]; return (T?)moduleConf;
} }
}
return default; return default;
} }
}
// Hooked // Hooked
public EntityList DoGetModlist(ulong guildId) { public EntityList DoGetModlist(ulong guildId) {
lock (_storageLock) {
if (_moderators.TryGetValue(guildId, out var mods)) return mods; if (_moderators.TryGetValue(guildId, out var mods)) return mods;
else return new EntityList(); else return new EntityList();
} }
}
private async Task<bool> ProcessConfiguration(SocketGuild guild) { private async Task<bool> ProcessConfiguration(SocketGuild guild) {
var jstr = await LoadConfigFile(guild); var guildConf = _serverConfs[guild.Id.ToString()]?.Value<JObject>();
JObject guildConf; if (guildConf == null) {
try { Log($"{guild.Name} ({guild.Id}) has no configuration. Add config or consider removing bot from server.");
var tok = JToken.Parse(jstr); return true;
if (tok.Type == JTokenType.Object) {
guildConf = (JObject)tok;
} else {
throw new InvalidCastException("Configuration is not valid JSON.");
}
} catch (Exception ex) when (ex is JsonReaderException or InvalidCastException) {
Log($"Error loading configuration for server ID {guild.Id}: {ex.Message}");
return false;
} }
// Load moderator list // Load moderator list
@ -86,38 +73,8 @@ class ModuleStateService : Service {
return false; return false;
} }
} }
lock (_storageLock) {
_moderators[guild.Id] = mods; _moderators[guild.Id] = mods;
_stateData[guild.Id] = newStates; _guildStates[guild.Id] = newStates;
}
return true; return true;
} }
private async Task<string> LoadConfigFile(SocketGuild guild) {
// Per-guild configuration exists under `config/(guild ID).json`
var basePath = Path.GetDirectoryName(Assembly.GetExecutingAssembly()!.Location) +
Path.DirectorySeparatorChar + "config" + Path.DirectorySeparatorChar;
if (!Directory.Exists(basePath)) Directory.CreateDirectory(basePath);
var path = basePath + guild.Id + ".json";
if (File.Exists(path)) {
return await File.ReadAllTextAsync(path);
} else { // Write default configuration to new file
string fileContents;
using (var resStream = Assembly.GetExecutingAssembly()
.GetManifestResourceStream($"{nameof(RegexBot)}.DefaultGuildConfig.json")!) {
using var readin = new StreamReader(resStream, encoding: System.Text.Encoding.UTF8);
fileContents = readin.ReadToEnd();
}
var userex = BotClient.DiscordClient.CurrentUser;
fileContents = fileContents.Replace("SERVER NAME", guild.Name).Replace("MODERATOR", $"@{userex.Id}::{userex.Username}");
using (var newFile = File.OpenWrite(path)) {
var w = new StreamWriter(newFile);
w.Write(fileContents);
w.Flush();
w.Close();
}
Log($"Created initial configuration file in config{Path.DirectorySeparatorChar}{guild.Id}.json");
return await LoadConfigFile(guild);
}
}
} }

View file

@ -6,13 +6,11 @@
/// Services provide core and shared functionality for this program. Modules are expected to call into services /// Services provide core and shared functionality for this program. Modules are expected to call into services
/// directly or indirectly in order to access bot features. /// directly or indirectly in order to access bot features.
/// </remarks> /// </remarks>
internal abstract class Service { internal abstract class Service(RegexbotClient bot) {
public RegexbotClient BotClient { get; } public RegexbotClient BotClient { get; } = bot;
public string Name => GetType().Name; public string Name => GetType().Name;
public Service(RegexbotClient bot) => BotClient = bot;
/// <summary> /// <summary>
/// Emits a log message. /// Emits a log message.
/// </summary> /// </summary>