Compare commits
33
Commits
4d6ba9b715
...
0.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c728a612bb
|
||
|
|
5df0d734dc
|
||
|
|
101761bade
|
||
|
|
521dc00757
|
||
|
|
cc0719a061
|
||
|
|
7c65309d99
|
||
|
|
95b27aa0af
|
||
|
|
1599a20583
|
||
|
|
4368315657
|
||
|
|
8611ebb1ea
|
||
|
|
becc871f52
|
||
|
|
1b0246075e
|
||
|
|
8953c096c1
|
||
|
|
48615181f3
|
||
|
|
4f533b8211
|
||
|
|
d0f0c28d29
|
||
|
|
2b33093ef2
|
||
|
|
e8abfd8f52
|
||
|
|
e8fc28a239
|
||
|
|
aa1e862201
|
||
|
|
9b5df85bf2
|
||
|
|
d5397f99a3
|
||
|
|
3bf9d83450
|
||
|
|
207c460b85
|
||
|
|
59c96e48be
|
||
|
|
973a6fa11b
|
||
|
|
ab88896b01
|
||
|
|
7384642a6d
|
||
|
|
e0194d5c0a
|
||
|
|
d52b1085f9
|
||
|
|
3ad2740dd2
|
||
|
|
398fe1ef4e
|
||
|
|
d8e89775f5
|
@@ -0,0 +1,10 @@
|
|||||||
|
[*.{kt,kts}]
|
||||||
|
ktlint_standard_class-naming = disabled # don't enforce capitalisation of classes
|
||||||
|
ktlint_standard_when-entry-bracing = disabled
|
||||||
|
ktlint_standard_blank-line-between-when-conditions = disabled
|
||||||
|
ktlint_standard_blank-line-before-declaration = disabled
|
||||||
|
ktlint_standard_multiline-expression-wrapping = disabled
|
||||||
|
ktlint_standard_multiline-loop = disabled
|
||||||
|
ktlint_function_signature_body_expression_wrapping = default
|
||||||
|
ktlint_standard_property-naming = disabled
|
||||||
|
ktlint_standard_function-signature = disabled
|
||||||
+1
-1
@@ -44,6 +44,6 @@ bin/
|
|||||||
### Mac OS ###
|
### Mac OS ###
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|
||||||
src/test/resources/logs/ngircd.log
|
src/test/resources/logs/*.log
|
||||||
!src/test/resources/logs/.gitkeep
|
!src/test/resources/logs/.gitkeep
|
||||||
.idea
|
.idea
|
||||||
|
|||||||
@@ -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>.
|
||||||
+14
-9
@@ -1,12 +1,13 @@
|
|||||||
import org.gradle.kotlin.dsl.provideDelegate
|
|
||||||
|
|
||||||
plugins {
|
plugins {
|
||||||
kotlin("jvm") version "2.4.0"
|
kotlin("jvm") version "2.4.0"
|
||||||
|
id("org.jlleitschuh.gradle.ktlint") version "12.3.0"
|
||||||
|
id("dev.detekt") version "2.0.0-alpha.6"
|
||||||
|
id("org.jetbrains.dokka") version "2.2.0"
|
||||||
}
|
}
|
||||||
|
|
||||||
group = "com.shr4pnel"
|
group = "com.shr4pnel"
|
||||||
version = "1.0-SNAPSHOT"
|
version = "0.1.0"
|
||||||
val ktor_version = "3.5.2"
|
val ktorVersion = "3.5.2"
|
||||||
|
|
||||||
repositories {
|
repositories {
|
||||||
mavenCentral()
|
mavenCentral()
|
||||||
@@ -14,12 +15,14 @@ repositories {
|
|||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
testImplementation(kotlin("test"))
|
testImplementation(kotlin("test"))
|
||||||
implementation ("io.ktor:ktor-client-core:${ktor_version}")
|
testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.11.0")
|
||||||
implementation("io.ktor:ktor-client-cio:${ktor_version}")
|
implementation("io.ktor:ktor-client-core:$ktorVersion")
|
||||||
implementation("io.ktor:ktor-network:${ktor_version}")
|
implementation("io.ktor:ktor-client-cio:$ktorVersion")
|
||||||
implementation("io.ktor:ktor-network-tls:${ktor_version}")
|
implementation("io.ktor:ktor-network:$ktorVersion")
|
||||||
|
implementation("io.ktor:ktor-network-tls:$ktorVersion")
|
||||||
implementation("io.github.oshai:kotlin-logging-jvm:8.0.4")
|
implementation("io.github.oshai:kotlin-logging-jvm:8.0.4")
|
||||||
implementation("ch.qos.logback:logback-classic:1.6.1")
|
implementation("ch.qos.logback:logback-classic:1.6.3")
|
||||||
|
testImplementation("org.jline:jansi-core:4.4.3")
|
||||||
}
|
}
|
||||||
|
|
||||||
kotlin {
|
kotlin {
|
||||||
@@ -28,4 +31,6 @@ kotlin {
|
|||||||
|
|
||||||
tasks.test {
|
tasks.test {
|
||||||
useJUnitPlatform()
|
useJUnitPlatform()
|
||||||
|
val logDir = layout.projectDirectory.dir("src/test/resources/logs").toString()
|
||||||
|
systemProperty("TEST_LOG_DIR", logDir)
|
||||||
}
|
}
|
||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
#Tue Aug 04 23:49:39 BST 2026
|
#Tue Aug 04 23:49:39 BST 2026
|
||||||
distributionBase=GRADLE_USER_HOME
|
distributionBase=GRADLE_USER_HOME
|
||||||
distributionPath=wrapper/dists
|
distributionPath=wrapper/dists
|
||||||
distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip
|
distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip
|
||||||
zipStoreBase=GRADLE_USER_HOME
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
zipStorePath=wrapper/dists
|
zipStorePath=wrapper/dists
|
||||||
|
|||||||
@@ -1,58 +1,124 @@
|
|||||||
package com.shr4pnel.ferretirc
|
package com.shr4pnel.ferretirc
|
||||||
|
|
||||||
import com.shr4pnel.ferretirc.net.messages.ClientMessage
|
import com.shr4pnel.ferretirc.irc.Server
|
||||||
|
import com.shr4pnel.ferretirc.irc.User
|
||||||
import com.shr4pnel.ferretirc.net.Connection
|
import com.shr4pnel.ferretirc.net.Connection
|
||||||
|
import com.shr4pnel.ferretirc.net.messages.ClientMessage
|
||||||
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
||||||
|
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||||
import io.github.oshai.kotlinlogging.KotlinLoggingConfiguration
|
import io.github.oshai.kotlinlogging.KotlinLoggingConfiguration
|
||||||
|
import io.github.oshai.kotlinlogging.slf4j.logger
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
import kotlinx.coroutines.Dispatchers
|
import kotlinx.coroutines.Dispatchers
|
||||||
import kotlinx.coroutines.SupervisorJob
|
import kotlinx.coroutines.SupervisorJob
|
||||||
import kotlinx.coroutines.cancel
|
import kotlinx.coroutines.cancel
|
||||||
|
import org.slf4j.helpers.NOPLogger
|
||||||
|
|
||||||
class IrcClient(hostname: String, port: Int) {
|
class IrcClient(
|
||||||
|
hostname: String,
|
||||||
|
port: Int,
|
||||||
|
var enableLogging: Boolean = false,
|
||||||
|
) {
|
||||||
init {
|
init {
|
||||||
KotlinLoggingConfiguration.logStartupMessage = false
|
KotlinLoggingConfiguration.logStartupMessage = false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private val logger = if (enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
|
||||||
val scope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
|
val scope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
|
||||||
|
|
||||||
@PublishedApi
|
lateinit var server: Server
|
||||||
internal val connection = Connection(hostname, port, scope)
|
private set
|
||||||
|
|
||||||
|
lateinit var currentUser: User
|
||||||
|
private set
|
||||||
|
|
||||||
|
@PublishedApi
|
||||||
|
internal val connection = Connection(hostname, port, scope, enableLogging)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Connect to the socket
|
||||||
|
*/
|
||||||
suspend fun connect() {
|
suspend fun connect() {
|
||||||
connection.connect()
|
server = connection.connect()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to the IRC server writer
|
||||||
|
* This is asynchronous and ordered
|
||||||
|
* @param message The client message to send to the server
|
||||||
|
*/
|
||||||
suspend fun queueMessage(message: ClientMessage) {
|
suspend fun queueMessage(message: ClientMessage) {
|
||||||
connection.writer.outgoingMessages.send(message)
|
connection.writer.outgoingMessages.send(message)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to the IRC server writer
|
||||||
|
* This is asynchronous and ordered
|
||||||
|
* @param messages The client messages to send to the server
|
||||||
|
*/
|
||||||
suspend fun queueMessages(vararg messages: ClientMessage) {
|
suspend fun queueMessages(vararg messages: ClientMessage) {
|
||||||
messages.forEach {
|
messages.forEach {
|
||||||
connection.writer.outgoingMessages.send(it)
|
connection.writer.outgoingMessages.send(it)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Close the coroutine scope controlling listeners, readers, writers etc
|
||||||
|
*/
|
||||||
fun close() {
|
fun close() {
|
||||||
scope.cancel()
|
scope.cancel()
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the next Server Message meeting condition
|
* Return the next Server Message meeting given condition "predicate"
|
||||||
* @param predicate A function to filter a message based on its parameters
|
* @param predicate A function to filter a message based on its parameters
|
||||||
|
* @param T A ServerMessage inheritor
|
||||||
|
* @return An instance of ServerMessage
|
||||||
|
* @see com.shr4pnel.ferretirc.irc.Server.waitForNext
|
||||||
|
* @see com.shr4pnel.ferretirc.net.messages.ServerMessage
|
||||||
*/
|
*/
|
||||||
suspend inline fun <reified T : ServerMessage> waitForNext(noinline predicate: (T) -> Boolean = { true }): T =
|
suspend inline fun <reified T : ServerMessage> waitForNext(noinline predicate: (T) -> Boolean = { true }): T =
|
||||||
connection.reader.waitForNext(T::class, predicate)
|
server.waitForNext(T::class, predicate)
|
||||||
|
|
||||||
suspend fun register(nick: String, realName: String? = null, password: String? = null) {
|
/**
|
||||||
val messages = buildList {
|
* Queue a client message, and wait for the next server message meeting condition (predicate)
|
||||||
|
* @param predicate A function to filter a message based on its parameters
|
||||||
|
* @see com.shr4pnel.ferretirc.IrcClient.waitForNext
|
||||||
|
*/
|
||||||
|
suspend inline fun <reified T : ServerMessage> queueAndWaitForNext(
|
||||||
|
message: ClientMessage,
|
||||||
|
noinline predicate: (T) -> Boolean = { true },
|
||||||
|
): T = server.waitForNext(T::class, predicate) { queueMessage(message) }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a subscription to the server message buffer, after performing an action
|
||||||
|
* @param predicate A function to filter the message buffer flow
|
||||||
|
* @param action A function to execute after message buffer flow collection has begun
|
||||||
|
* @see com.shr4pnel.ferretirc.IrcClient.waitForNext
|
||||||
|
*/
|
||||||
|
suspend inline fun <reified T : ServerMessage> waitForNextAfterAction(
|
||||||
|
noinline predicate: (T) -> Boolean = { true },
|
||||||
|
noinline action: suspend () -> Unit,
|
||||||
|
): T = server.waitForNext(T::class, predicate, action)
|
||||||
|
|
||||||
|
suspend fun register(
|
||||||
|
nick: String,
|
||||||
|
realName: String? = null,
|
||||||
|
password: String? = null,
|
||||||
|
) {
|
||||||
|
currentUser = User(nick, "") // TODO TEMP USER ASSIGNMENT
|
||||||
|
val messages =
|
||||||
|
buildList {
|
||||||
if (!password.isNullOrEmpty()) add(ClientMessage.Pass(password))
|
if (!password.isNullOrEmpty()) add(ClientMessage.Pass(password))
|
||||||
add(ClientMessage.Cap.LS())
|
add(ClientMessage.Cap.LS())
|
||||||
add(ClientMessage.Nick(nick))
|
add(ClientMessage.Nick(nick))
|
||||||
if (!realName.isNullOrEmpty()) add(ClientMessage.User(nick, realName))
|
if (!realName.isNullOrEmpty()) {
|
||||||
else add(ClientMessage.User(nick, nick))
|
add(ClientMessage.User(nick, realName))
|
||||||
add(ClientMessage.Cap.END())
|
} else {
|
||||||
|
add(ClientMessage.User(nick, nick))
|
||||||
}
|
}
|
||||||
queueMessages(*messages.toTypedArray())
|
add(ClientMessage.Cap.END())
|
||||||
|
}.toTypedArray()
|
||||||
|
queueMessages(*messages)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
package com.shr4pnel.ferretirc.irc
|
||||||
|
|
||||||
|
class IRCChannel(val chanName: String, val clientCount: Int, val topic: String)
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
package com.shr4pnel.ferretirc.irc
|
||||||
|
|
||||||
|
data class ISupportFeatures(val capabilities: List<Feature>)
|
||||||
|
|
||||||
|
sealed class Feature(key: String) {
|
||||||
|
// Indicates the maximum number of online nicknames a user may have in their accept list. First introduced in ircd-ratbox-3.0.9(r28737).
|
||||||
|
data class ACCEPT(val max: Int) : Feature("ACCEPT")
|
||||||
|
|
||||||
|
// Indicates the maximum length of an away message. If "number" is not defined, there is no limit.
|
||||||
|
data class AWAYLEN(val max: Int) : Feature("AWAYLEN")
|
||||||
|
|
||||||
|
// Indicates the character to be used as a user mode to let clients mark themselves as bots by setting it
|
||||||
|
data class BOT(val letter: Char) : Feature("BOT")
|
||||||
|
|
||||||
|
// Indicates that the "caller-id" user mode is supported, which rejects messages from unauthorized users. "letter" defines the mode character, which is used for this feature. If the value is not given, it defaults to the mode "g".
|
||||||
|
data class CALLERID(val letter: Char) : Feature("CALLERID")
|
||||||
|
|
||||||
|
// Indicates the method that’s used to compare equality of case-insensitive strings (such as nick/channel names). Typical values include "ascii" and "rfc1459". "rfc3454" is a proposed value that refers to the stringprep method described in RFC3454 (typically used for UTF-8 casefolding).
|
||||||
|
data class CASEMAPPING(val method: String) : Feature("CASEMAPPING")
|
||||||
|
|
||||||
|
// Indicates the maximum length of a nickname that a client may use. Other clients on the network may have nicknames longer than this.
|
||||||
|
data class MAXNICKLEN(val max: Int) : Feature("MAXNICKLEN")
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
package com.shr4pnel.ferretirc.irc
|
||||||
|
|
||||||
|
import com.shr4pnel.ferretirc.net.messages.ClientMessage
|
||||||
|
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
||||||
|
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||||
|
import io.github.oshai.kotlinlogging.slf4j.logger
|
||||||
|
import kotlinx.coroutines.channels.Channel
|
||||||
|
import kotlinx.coroutines.flow.SharedFlow
|
||||||
|
import kotlinx.coroutines.flow.filter
|
||||||
|
import kotlinx.coroutines.flow.filterIsInstance
|
||||||
|
import kotlinx.coroutines.flow.first
|
||||||
|
import kotlinx.coroutines.flow.map
|
||||||
|
import kotlinx.coroutines.flow.onSubscription
|
||||||
|
import kotlinx.coroutines.flow.takeWhile
|
||||||
|
import org.slf4j.helpers.NOPLogger
|
||||||
|
import kotlin.reflect.KClass
|
||||||
|
import kotlin.reflect.cast
|
||||||
|
|
||||||
|
class Server(
|
||||||
|
private val msgBuffer: SharedFlow<ServerMessage>,
|
||||||
|
private val outgoingMessages: Channel<ClientMessage>,
|
||||||
|
enableLogging: Boolean = false,
|
||||||
|
) {
|
||||||
|
private val logger = if (enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
|
||||||
|
|
||||||
|
lateinit var features: ISupportFeatures
|
||||||
|
private set
|
||||||
|
|
||||||
|
var channels: Set<IRCChannel> = setOf()
|
||||||
|
private set
|
||||||
|
|
||||||
|
val users = mutableListOf<User>()
|
||||||
|
|
||||||
|
suspend fun fetchChannels(): Set<IRCChannel> {
|
||||||
|
logger.debug { "Fetching IRC channels" }
|
||||||
|
val buffer = mutableSetOf<IRCChannel>()
|
||||||
|
msgBuffer
|
||||||
|
.onSubscription { outgoingMessages.send(ClientMessage.List()) }
|
||||||
|
.filterIsInstance<ServerMessage.Numeric>()
|
||||||
|
.takeWhile { it !is ServerMessage.Numeric.RPL_LISTEND }
|
||||||
|
.filterIsInstance<ServerMessage.Numeric.RPL_LIST>()
|
||||||
|
.collect { buffer.add(IRCChannel(it.chanName, it.clientCount, it.topic)) }
|
||||||
|
channels = buffer.toSortedSet(compareBy { it.chanName })
|
||||||
|
return channels
|
||||||
|
}
|
||||||
|
|
||||||
|
fun fetchFeatures() {
|
||||||
|
}
|
||||||
|
|
||||||
|
suspend fun <T : ServerMessage> waitForNext(
|
||||||
|
kClass: KClass<T>,
|
||||||
|
predicate: (T) -> Boolean = { true },
|
||||||
|
onSuscribedLambda: suspend () -> Unit = {},
|
||||||
|
): T =
|
||||||
|
msgBuffer
|
||||||
|
.onSubscription { onSuscribedLambda() }
|
||||||
|
.filter { kClass.isInstance(it) }
|
||||||
|
.map { kClass.cast(it) }
|
||||||
|
.first(predicate)
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
package com.shr4pnel.ferretirc.irc
|
||||||
|
|
||||||
|
class User(val nick: String, var mask: String?)
|
||||||
@@ -1,21 +1,30 @@
|
|||||||
package com.shr4pnel.ferretirc.net
|
package com.shr4pnel.ferretirc.net
|
||||||
|
|
||||||
import com.shr4pnel.ferretirc.net.messages.ClientMessage
|
import com.shr4pnel.ferretirc.irc.Server
|
||||||
|
import io.ktor.network.selector.SelectorManager
|
||||||
import io.ktor.network.sockets.Socket
|
import io.ktor.network.sockets.Socket
|
||||||
import io.ktor.network.sockets.aSocket
|
import io.ktor.network.sockets.aSocket
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
|
import kotlinx.coroutines.Dispatchers
|
||||||
|
|
||||||
class Connection(val hostname: String, val port: Int, val scope: CoroutineScope) {
|
class Connection(
|
||||||
private val socketBuilder = aSocket(ClientMessage.selectorManager).tcp()
|
val hostname: String,
|
||||||
|
val port: Int,
|
||||||
|
val scope: CoroutineScope,
|
||||||
|
val enableLogging: Boolean = false,
|
||||||
|
) {
|
||||||
|
private val selectorManager = SelectorManager(Dispatchers.IO)
|
||||||
|
private val socketBuilder = aSocket(selectorManager).tcp()
|
||||||
lateinit var socket: Socket
|
lateinit var socket: Socket
|
||||||
lateinit var reader: MessageReader
|
lateinit var reader: MessageReader
|
||||||
lateinit var writer: MessageWriter
|
lateinit var writer: MessageWriter
|
||||||
|
|
||||||
suspend fun connect() {
|
suspend fun connect(): Server {
|
||||||
socket = socketBuilder.connect(hostname, port)
|
socket = socketBuilder.connect(hostname, port)
|
||||||
reader = MessageReader(socket, scope)
|
reader = MessageReader(socket, scope, enableLogging)
|
||||||
writer = MessageWriter(socket, scope)
|
writer = MessageWriter(socket, scope, enableLogging)
|
||||||
reader.start()
|
reader.start()
|
||||||
writer.start()
|
writer.start()
|
||||||
|
return Server(reader.sharedMessageBuffer, writer.outgoingMessages, enableLogging)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,74 +2,96 @@ package com.shr4pnel.ferretirc.net
|
|||||||
|
|
||||||
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
||||||
import io.github.oshai.kotlinlogging.KotlinLogging
|
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||||
import io.ktor.http.parameters
|
import io.github.oshai.kotlinlogging.slf4j.logger
|
||||||
import io.ktor.network.selector.SelectInterest
|
|
||||||
import io.ktor.util.toUpperCasePreservingASCIIRules
|
|
||||||
import kotlinx.coroutines.channels.Channel
|
import kotlinx.coroutines.channels.Channel
|
||||||
|
import org.slf4j.helpers.NOPLogger
|
||||||
|
|
||||||
class MessageParser(val incoming: Channel<String>) {
|
class MessageParser(val incoming: Channel<String>, enableLogging: Boolean = false) {
|
||||||
private val logger = KotlinLogging.logger("MessageParser")
|
|
||||||
val incomingParsedMessages = Channel<ServerMessage>()
|
val incomingParsedMessages = Channel<ServerMessage>()
|
||||||
|
private val logger = if (enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
|
||||||
|
|
||||||
private companion object MessageBuilder {
|
class MessageBuilder {
|
||||||
val logger = KotlinLogging.logger("MessageParser.MessageBuilder")
|
|
||||||
fun getTrailingParameterIndex(params: List<String>) = params.indexOfLast { it.startsWith(":") }
|
|
||||||
|
|
||||||
sealed interface Command {
|
|
||||||
fun toServerMessage(): ServerMessage
|
|
||||||
|
|
||||||
class NamedCommand(val name: String, val parameters: List<String>) : Command {
|
|
||||||
override fun toServerMessage(): ServerMessage {
|
|
||||||
logger.debug { "Parsing ${name.toUpperCasePreservingASCIIRules()}, with params $parameters" }
|
|
||||||
|
|
||||||
return when (name.toUpperCasePreservingASCIIRules()) {
|
|
||||||
// PONG :PREFIX COMMAND HOSTNAME :TOKEN
|
|
||||||
"PONG" -> {
|
|
||||||
val tokenIndex = getTrailingParameterIndex(parameters)
|
|
||||||
if (tokenIndex != -1) ServerMessage.Pong(
|
|
||||||
parameters.subList(tokenIndex, parameters.size).joinToString(" ").removePrefix(":")
|
|
||||||
)
|
|
||||||
else ServerMessage.Pong()
|
|
||||||
}
|
|
||||||
// MODE :PREFIX NICK :MODES
|
|
||||||
"MODE" -> {
|
|
||||||
ServerMessage.Mode(parameters.first(), parameters.last().removePrefix(":")) // TODO MODE, CHANMODE, LOCALMODE
|
|
||||||
}
|
|
||||||
|
|
||||||
"NOTICE", "PRIVMSG" -> {
|
|
||||||
val cmd = name.toUpperCasePreservingASCIIRules()
|
|
||||||
val trailingIndex = getTrailingParameterIndex(parameters)
|
|
||||||
if (trailingIndex < 1) {
|
|
||||||
logger.warn { "Received malformed $cmd. Returning unimplemented as fallback." }
|
|
||||||
return ServerMessage.UNIMPLEMENTED("$cmd ${parameters.joinToString(" ")}")
|
|
||||||
}
|
|
||||||
val targets = parameters.subList(0, trailingIndex - 1)
|
|
||||||
if (cmd == "NOTICE")
|
|
||||||
ServerMessage.Notice(targets, "")
|
|
||||||
else
|
|
||||||
ServerMessage.PrivMsg(targets, "")
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
else -> {
|
|
||||||
logger.warn { "$name left unparsed" }
|
|
||||||
ServerMessage.UNIMPLEMENTED("$name ${parameters.joinToString(" ")}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class NumericCommand(val number: Int, val parameters: List<String>?) : Command {
|
|
||||||
override fun toServerMessage(): ServerMessage {
|
|
||||||
return ServerMessage.UNIMPLEMENTED("$number ${parameters?.joinToString(" ")}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private var tags: String? = null
|
private var tags: String? = null
|
||||||
private var prefix: String? = null
|
private var prefix: String? = null
|
||||||
private lateinit var command: Command
|
private lateinit var command: Command
|
||||||
|
|
||||||
|
abstract class Command(open val command: String, open val parameters: List<String>) {
|
||||||
|
abstract fun toServerMessage(): ServerMessage
|
||||||
|
|
||||||
|
fun getTrailingParameterIndex() = parameters.indexOfFirst { it.startsWith(":") }
|
||||||
|
|
||||||
|
fun getTrailingParameterString() =
|
||||||
|
parameters
|
||||||
|
.subList(getTrailingParameterIndex(), parameters.size)
|
||||||
|
.joinToString(" ")
|
||||||
|
.removePrefix(":")
|
||||||
|
|
||||||
|
fun getNonTrailingParameterString() =
|
||||||
|
parameters
|
||||||
|
.subList(0, getTrailingParameterIndex())
|
||||||
|
.joinToString(" ")
|
||||||
|
.removePrefix(":")
|
||||||
|
|
||||||
|
fun getNonTrailingParameters() = getNonTrailingParameterString().split(" ")
|
||||||
|
|
||||||
|
class NamedCommand(override val command: String, override val parameters: List<String>) : Command(command, parameters) {
|
||||||
|
override fun toServerMessage() =
|
||||||
|
when (command.uppercase()) {
|
||||||
|
"PONG" -> ServerMessage.Pong(getTrailingParameterString().removePrefix(":"))
|
||||||
|
|
||||||
|
// TODO MODE, CHANMODE, LOCALMODE
|
||||||
|
"MODE" ->
|
||||||
|
ServerMessage.Mode(
|
||||||
|
parameters.first(),
|
||||||
|
parameters.last().removePrefix(":"),
|
||||||
|
)
|
||||||
|
|
||||||
|
"NOTICE" ->
|
||||||
|
ServerMessage.Notice(
|
||||||
|
getNonTrailingParameters(),
|
||||||
|
getTrailingParameterString(),
|
||||||
|
)
|
||||||
|
|
||||||
|
"PRIVMSG" ->
|
||||||
|
ServerMessage.PrivMsg(
|
||||||
|
getNonTrailingParameters(),
|
||||||
|
getTrailingParameterString(),
|
||||||
|
)
|
||||||
|
|
||||||
|
else -> ServerMessage.UNIMPLEMENTED("$command ${parameters.joinToString(" ")}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class NumericCommand(override val command: String, override val parameters: List<String>) : Command(command, parameters) {
|
||||||
|
private enum class RPL(val underlying: Int) {
|
||||||
|
ISUPPORT(5),
|
||||||
|
LISTSTART(321),
|
||||||
|
LIST(322),
|
||||||
|
LISTEND(323),
|
||||||
|
NONE(0xbeef), ;
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
val rplMap = RPL.entries.associateBy { it.underlying }
|
||||||
|
infix fun from(value: Int) = rplMap[value] ?: NONE
|
||||||
|
infix fun from(value: String) = from(value.toInt())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun toServerMessage() =
|
||||||
|
when (RPL from command) {
|
||||||
|
RPL.ISUPPORT -> ServerMessage.Numeric.RPL_ISUPPORT(getNonTrailingParameterString())
|
||||||
|
RPL.LISTSTART -> ServerMessage.Numeric.RPL_LISTSTART()
|
||||||
|
RPL.LIST -> ServerMessage.Numeric.RPL_LIST(
|
||||||
|
parameters[1],
|
||||||
|
parameters[2].toInt(),
|
||||||
|
getTrailingParameterString(),
|
||||||
|
)
|
||||||
|
RPL.LISTEND -> ServerMessage.Numeric.RPL_LISTEND()
|
||||||
|
RPL.NONE -> ServerMessage.UNIMPLEMENTED(parameters.toString())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Messages have this format, as rough ABNF:
|
* Messages have this format, as rough ABNF:
|
||||||
*
|
*
|
||||||
@@ -87,15 +109,40 @@ class MessageParser(val incoming: Channel<String>) {
|
|||||||
*
|
*
|
||||||
* parameters: If it exists, data relevant to this specific command.
|
* parameters: If it exists, data relevant to this specific command.
|
||||||
*
|
*
|
||||||
* ignoring tags for now ;-;.. still making space for them
|
* ===================
|
||||||
|
*
|
||||||
|
* Convert line from server into tokens split on strings and remove elements that belong
|
||||||
|
* to different segments of the IRC message e.g. tags, prefixes etc
|
||||||
*/
|
*/
|
||||||
fun build(commandList: List<String>): ServerMessage {
|
fun build(commandList: List<String>): ServerMessage {
|
||||||
val tokens = commandList.toMutableList()
|
val tokens = commandList.toMutableList()
|
||||||
tags = if (tokens.first().startsWith("@")) tokens.removeFirst() else null
|
|
||||||
prefix = if (tokens.first().startsWith(":")) tokens.removeFirst() else null
|
// remove tags from strlist if present
|
||||||
|
tags =
|
||||||
|
if (tokens.first().startsWith("@")) {
|
||||||
|
tokens.removeFirst()
|
||||||
|
} else {
|
||||||
|
null
|
||||||
|
}
|
||||||
|
|
||||||
|
// remove client prefix (nick&opt hostname) if present
|
||||||
|
prefix =
|
||||||
|
if (tokens.first().startsWith(":")) {
|
||||||
|
tokens.removeFirst()
|
||||||
|
} else {
|
||||||
|
null
|
||||||
|
}
|
||||||
|
|
||||||
|
// get command e.g. PING
|
||||||
val commandStr = tokens.removeFirst()
|
val commandStr = tokens.removeFirst()
|
||||||
command = if (commandStr.toIntOrNull() != null) Command.NumericCommand(commandStr.toInt(), tokens)
|
|
||||||
else Command.NamedCommand(commandStr, tokens)
|
// Check if command is a numeric (RPL/ERR) or named
|
||||||
|
command =
|
||||||
|
if (commandStr.toIntOrNull() == null) {
|
||||||
|
Command.NamedCommand(commandStr, tokens)
|
||||||
|
} else {
|
||||||
|
Command.NumericCommand(commandStr, tokens)
|
||||||
|
}
|
||||||
|
|
||||||
return command.toServerMessage()
|
return command.toServerMessage()
|
||||||
}
|
}
|
||||||
@@ -104,8 +151,10 @@ class MessageParser(val incoming: Channel<String>) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
suspend fun start() {
|
suspend fun start() {
|
||||||
|
val builder = MessageBuilder()
|
||||||
for (msg in incoming) {
|
for (msg in incoming) {
|
||||||
incomingParsedMessages.send(build(msg))
|
logger.debug { "Receiving: $msg" }
|
||||||
|
incomingParsedMessages.send(builder.build(msg))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,48 +2,42 @@ package com.shr4pnel.ferretirc.net
|
|||||||
|
|
||||||
import com.shr4pnel.ferretirc.net.messages.MessageIO
|
import com.shr4pnel.ferretirc.net.messages.MessageIO
|
||||||
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
||||||
|
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||||
|
import io.github.oshai.kotlinlogging.slf4j.logger
|
||||||
import io.ktor.network.sockets.Socket
|
import io.ktor.network.sockets.Socket
|
||||||
import io.ktor.network.sockets.openReadChannel
|
import io.ktor.network.sockets.openReadChannel
|
||||||
import io.ktor.utils.io.ByteReadChannel
|
import io.ktor.utils.io.ByteReadChannel
|
||||||
import io.ktor.utils.io.readLineStrict
|
import io.ktor.utils.io.readLineStrict
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
import kotlinx.coroutines.flow.MutableSharedFlow
|
import kotlinx.coroutines.flow.MutableSharedFlow
|
||||||
import kotlinx.coroutines.flow.filter
|
import kotlinx.coroutines.flow.asSharedFlow
|
||||||
import kotlinx.coroutines.flow.first
|
|
||||||
import kotlinx.coroutines.flow.map
|
|
||||||
import kotlinx.coroutines.launch
|
import kotlinx.coroutines.launch
|
||||||
import kotlin.reflect.KClass
|
import org.slf4j.helpers.NOPLogger
|
||||||
import kotlin.reflect.cast
|
|
||||||
|
|
||||||
class MessageReader(socket: Socket, scope: CoroutineScope) : MessageIO(socket, scope) {
|
class MessageReader(socket: Socket, scope: CoroutineScope, enableLogging: Boolean = false) : MessageIO(socket, scope) {
|
||||||
private lateinit var receive: ByteReadChannel
|
private lateinit var receive: ByteReadChannel
|
||||||
private val listenedMessages = mutableListOf<ServerMessage>()
|
private val messageBuffer = MutableSharedFlow<ServerMessage>(0, 64)
|
||||||
val messageBuffer = MutableSharedFlow<ServerMessage>(16, 64)
|
val sharedMessageBuffer = messageBuffer.asSharedFlow()
|
||||||
val parser = MessageParser(incomingMessages)
|
val parser = MessageParser(incomingMessages, enableLogging)
|
||||||
|
private val logger = if (enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
|
||||||
|
|
||||||
init {
|
init {
|
||||||
scope.launch {
|
scope.launch {
|
||||||
parser.start()
|
parser.start()
|
||||||
}
|
}
|
||||||
scope.launch {
|
scope.launch {
|
||||||
for (msg in parser.incomingParsedMessages) messageBuffer.emit(msg)
|
for (msg in parser.incomingParsedMessages) // receive parsed messages
|
||||||
|
messageBuffer.emit(msg) // send messages down shared flow
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
override fun start() = scope.launch {
|
override fun start() {
|
||||||
|
scope.launch {
|
||||||
receive = socket.openReadChannel()
|
receive = socket.openReadChannel()
|
||||||
while (true) {
|
while (true) {
|
||||||
val line = receive.readLineStrict() ?: break // >:( no LineEnding option for just CRLF? charlatans...
|
val line = receive.readLineStrict() ?: break // >:( no LineEnding option for just CRLF? charlatans...
|
||||||
incomingMessages.send(line)
|
incomingMessages.send(line) // send raw messages to parser
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
suspend fun <T : ServerMessage> waitForNext(kClass: KClass<T>, predicate: (T) -> Boolean = { true }): T {
|
|
||||||
return messageBuffer
|
|
||||||
.filter {
|
|
||||||
kClass.isInstance(it)
|
|
||||||
}.map {
|
|
||||||
kClass.cast(it)
|
|
||||||
}.first(predicate)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,18 +2,21 @@ package com.shr4pnel.ferretirc.net
|
|||||||
|
|
||||||
import com.shr4pnel.ferretirc.net.messages.MessageIO
|
import com.shr4pnel.ferretirc.net.messages.MessageIO
|
||||||
import io.github.oshai.kotlinlogging.KotlinLogging
|
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||||
|
import io.github.oshai.kotlinlogging.slf4j.logger
|
||||||
import io.ktor.network.sockets.Socket
|
import io.ktor.network.sockets.Socket
|
||||||
import io.ktor.network.sockets.openWriteChannel
|
import io.ktor.network.sockets.openWriteChannel
|
||||||
import io.ktor.utils.io.ByteWriteChannel
|
import io.ktor.utils.io.ByteWriteChannel
|
||||||
import io.ktor.utils.io.writeFully
|
import io.ktor.utils.io.writeFully
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
import kotlinx.coroutines.launch
|
import kotlinx.coroutines.launch
|
||||||
|
import org.slf4j.helpers.NOPLogger
|
||||||
|
|
||||||
class MessageWriter(socket: Socket, scope: CoroutineScope) : MessageIO(socket, scope) {
|
class MessageWriter(socket: Socket, scope: CoroutineScope, enableLogging: Boolean = false) : MessageIO(socket, scope) {
|
||||||
private lateinit var send: ByteWriteChannel
|
private lateinit var send: ByteWriteChannel
|
||||||
private val logger = KotlinLogging.logger("MessageWriter")
|
private val logger = if (enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
|
||||||
|
|
||||||
override fun start() = scope.launch {
|
override fun start() =
|
||||||
|
scope.launch {
|
||||||
send = socket.openWriteChannel()
|
send = socket.openWriteChannel()
|
||||||
|
|
||||||
for (msg in outgoingMessages) {
|
for (msg in outgoingMessages) {
|
||||||
|
|||||||
@@ -1,18 +1,25 @@
|
|||||||
package com.shr4pnel.ferretirc.net.messages
|
package com.shr4pnel.ferretirc.net.messages
|
||||||
|
|
||||||
import io.ktor.network.selector.SelectorManager
|
import com.shr4pnel.ferretirc.irc.IRCChannel
|
||||||
import kotlinx.coroutines.Dispatchers
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* IRC Messages sent by the client
|
* IRC Messages sent by the client
|
||||||
*/
|
*/
|
||||||
sealed class ClientMessage(val strName: String) {
|
sealed class ClientMessage(val strName: String) {
|
||||||
abstract fun toWireIntermediate(): String
|
|
||||||
fun toWire() = "${toWireIntermediate()}\r\n".encodeToByteArray()
|
fun toWire() = "${toWireIntermediate()}\r\n".encodeToByteArray()
|
||||||
|
|
||||||
companion object Util {
|
protected open val params = emptyList<String>()
|
||||||
val selectorManager = SelectorManager(Dispatchers.IO)
|
protected open val trailing: String? = null
|
||||||
|
|
||||||
|
fun toWireIntermediate(): String {
|
||||||
|
return buildString {
|
||||||
|
append(strName)
|
||||||
|
params.forEach { append(" $it") }
|
||||||
|
trailing?.let { append(" :$it") }
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun toString() = "$strName[params=$params trailing=:$trailing]"
|
||||||
|
|
||||||
class Ping(val token: String? = null) : ClientMessage("PING") {
|
class Ping(val token: String? = null) : ClientMessage("PING") {
|
||||||
init {
|
init {
|
||||||
@@ -21,33 +28,43 @@ sealed class ClientMessage(val strName: String) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
override fun toWireIntermediate() = "$strName ${token.orEmpty()}"
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOfNotNull(token)
|
||||||
}
|
}
|
||||||
|
|
||||||
sealed class Cap : ClientMessage("CAP") {
|
sealed class Cap : ClientMessage("CAP") {
|
||||||
val validSubcommands = listOf("LS", "LIST", "REQ", "END")
|
class LS(val version: Int = 302) : Cap() {
|
||||||
|
override val params: kotlin.collections.List<String>
|
||||||
override fun toWireIntermediate() = when (this) {
|
get() = listOf("LS", version.toString())
|
||||||
is LS -> "CAP LS $version"
|
|
||||||
is REQ -> TODO()
|
|
||||||
is END -> "CAP END"
|
|
||||||
is LIST -> TODO()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
class LS(val version: Int = 302) : Cap()
|
class LIST : Cap() {
|
||||||
class LIST : Cap()
|
override val params: kotlin.collections.List<String>
|
||||||
class REQ(val version: Int?) : Cap()
|
get() = TODO("IMPLEMENT CAP LIST")
|
||||||
class END : Cap()
|
}
|
||||||
|
|
||||||
|
class REQ(val version: Int?) : Cap() {
|
||||||
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = TODO("IMPL CAP REQ")
|
||||||
|
}
|
||||||
|
|
||||||
|
class END : Cap() {
|
||||||
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOf("END")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class Nick(val nickname: String) : ClientMessage("NICK") {
|
class Nick(val nickname: String) : ClientMessage("NICK") {
|
||||||
override fun toWireIntermediate() = "NICK $nickname"
|
|
||||||
|
|
||||||
init {
|
init {
|
||||||
require(nickname.length < 10) { "\"$nickname\" exceeds IRCs maximum nickname length of 9" }
|
require(nickname.length < 10) { "\"$nickname\" exceeds IRCs maximum nickname length of 9" }
|
||||||
require(!nickname.startsWith(":") && !nickname.startsWith("#")) { "\"$nickname\" may not begin with : or #" } // TODO THIS SHOULD BLACKLIST ALL PREFIXES NAMED IN CHANTYPES PARAMETER
|
require(!nickname.startsWith(":") && !nickname.startsWith("#")) {
|
||||||
|
"\"$nickname\" may not begin with : or #"
|
||||||
|
} // TODO THIS SHOULD BLACKLIST ALL PREFIXES NAMED IN CHANTYPES PARAMETER
|
||||||
require(!nickname.contains(" ")) { "$nickname may not contain a space" }
|
require(!nickname.contains(" ")) { "$nickname may not contain a space" }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOf(nickname)
|
||||||
}
|
}
|
||||||
|
|
||||||
class User(val username: String, val realName: String) : ClientMessage("USER") {
|
class User(val username: String, val realName: String) : ClientMessage("USER") {
|
||||||
@@ -56,27 +73,41 @@ sealed class ClientMessage(val strName: String) {
|
|||||||
require(username.isNotEmpty()) { "Username may not be blank" }
|
require(username.isNotEmpty()) { "Username may not be blank" }
|
||||||
}
|
}
|
||||||
|
|
||||||
override fun toWireIntermediate() = "USER $username 0 * :$realName"
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOf(username, "0", "*")
|
||||||
|
|
||||||
|
override val trailing: String
|
||||||
|
get() = realName
|
||||||
}
|
}
|
||||||
|
|
||||||
class Pass(val password: String) : ClientMessage("PASS") {
|
class Pass(val password: String) : ClientMessage("PASS") {
|
||||||
override fun toWireIntermediate() = "PASS $password"
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOf(password)
|
||||||
}
|
}
|
||||||
|
|
||||||
class Oper(val name: String, val password: String): ClientMessage("OPER") {
|
class Oper(val name: String, val password: String) : ClientMessage("OPER") {
|
||||||
override fun toWireIntermediate() = "OPER $name $password"
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOf(name, password)
|
||||||
}
|
}
|
||||||
|
|
||||||
class Die(): ClientMessage("DIE") {
|
class Die : ClientMessage("DIE")
|
||||||
override fun toWireIntermediate() = "DIE"
|
|
||||||
|
class List : ClientMessage("LIST")
|
||||||
|
|
||||||
|
class Join(val channel: IRCChannel) : ClientMessage("JOIN") {
|
||||||
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() = listOf(channel.chanName)
|
||||||
}
|
}
|
||||||
|
|
||||||
class List(): ClientMessage("LIST") {
|
// TODO RPL_ISUPPORT REQUIREMENTS IN FUN EG LINELEN STATUSMSG - ALSO ADD FUCKING STUPID STATUSMSG & SUPPORT FOR MASKS. FUCK ME
|
||||||
override fun toWireIntermediate() = "LIST"
|
class PrivMsg(val target: IRCChannel, val message: String) : ClientMessage("PRIVMSG") {
|
||||||
}
|
override val params: kotlin.collections.List<String>
|
||||||
|
get() =
|
||||||
|
listOf(
|
||||||
|
target.chanName,
|
||||||
|
)
|
||||||
|
|
||||||
class UNIMPLEMENTED() : ClientMessage("") {
|
override val trailing: String
|
||||||
override fun toWireIntermediate() = ""
|
get() = message
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,11 +2,11 @@ package com.shr4pnel.ferretirc.net.messages
|
|||||||
|
|
||||||
import io.ktor.network.sockets.Socket
|
import io.ktor.network.sockets.Socket
|
||||||
import kotlinx.coroutines.CoroutineScope
|
import kotlinx.coroutines.CoroutineScope
|
||||||
import kotlinx.coroutines.Job
|
|
||||||
import kotlinx.coroutines.channels.Channel
|
import kotlinx.coroutines.channels.Channel
|
||||||
|
|
||||||
abstract class MessageIO(val socket: Socket, val scope: CoroutineScope) {
|
abstract class MessageIO(val socket: Socket, val scope: CoroutineScope) {
|
||||||
val incomingMessages = Channel<String>(Channel.BUFFERED)
|
val incomingMessages = Channel<String>(Channel.BUFFERED)
|
||||||
val outgoingMessages = Channel<ClientMessage>(Channel.BUFFERED)
|
val outgoingMessages = Channel<ClientMessage>(Channel.BUFFERED)
|
||||||
abstract fun start(): Job
|
|
||||||
|
abstract fun start(): Any
|
||||||
}
|
}
|
||||||
@@ -1,10 +1,28 @@
|
|||||||
package com.shr4pnel.ferretirc.net.messages
|
package com.shr4pnel.ferretirc.net.messages
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Representation of responses from the IRC server
|
||||||
|
*/
|
||||||
sealed class ServerMessage {
|
sealed class ServerMessage {
|
||||||
class Cap() : ServerMessage()
|
data class Cap(val placeholder: String? = null) : ServerMessage()
|
||||||
class Pong(val token: String? = null) : ServerMessage()
|
|
||||||
class Mode(val operatorName: String, val pMask: String): ServerMessage()
|
data class Pong(val token: String? = null) : ServerMessage()
|
||||||
class PrivMsg(val targets: List<String>, message: String): ServerMessage()
|
|
||||||
class Notice(val targets: List<String>, message: String): ServerMessage()
|
data class Mode(val operatorName: String, val pMask: String) : ServerMessage()
|
||||||
class UNIMPLEMENTED(val msg: String) : ServerMessage()
|
|
||||||
|
data class PrivMsg(val targets: List<String>, val message: String) : ServerMessage()
|
||||||
|
|
||||||
|
data class Notice(val targets: List<String>, val message: String) : ServerMessage()
|
||||||
|
|
||||||
|
data class UNIMPLEMENTED(val msg: String) : ServerMessage()
|
||||||
|
|
||||||
|
sealed class Numeric(val number: Short) : ServerMessage() {
|
||||||
|
data class RPL_ISUPPORT(val keypairs: String) : Numeric(5)
|
||||||
|
|
||||||
|
class RPL_LISTSTART : Numeric(321)
|
||||||
|
|
||||||
|
data class RPL_LIST(val chanName: String, val clientCount: Int, val topic: String) : Numeric(322)
|
||||||
|
|
||||||
|
class RPL_LISTEND : Numeric(323)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
package com.shr4pnel.ferretirc.util
|
||||||
|
|
||||||
|
import ch.qos.logback.classic.Level
|
||||||
|
import ch.qos.logback.classic.spi.ILoggingEvent
|
||||||
|
import ch.qos.logback.core.pattern.CompositeConverter
|
||||||
|
import ch.qos.logback.core.pattern.color.BoldWhiteCompositeConverter
|
||||||
|
import ch.qos.logback.core.pattern.color.ForegroundCompositeConverterBase
|
||||||
|
import ch.qos.logback.core.pattern.color.ANSIConstants as ANSI
|
||||||
|
|
||||||
|
private fun center(severity: String, width: Int = 7): String {
|
||||||
|
val pad = width - severity.length
|
||||||
|
if (pad <= 0) return severity
|
||||||
|
val leading = pad / 2
|
||||||
|
return buildString {
|
||||||
|
repeat(leading) { append(" ") }
|
||||||
|
append(severity)
|
||||||
|
repeat(pad - leading) { append(" ") }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 8 bit ANSI codes (logback uses 3/4 bit which isn't always equivalent) */
|
||||||
|
object Codes {
|
||||||
|
const val SET_DEFAULT_COLOR = ANSI.ESC_START + ANSI.RESET + ANSI.DEFAULT_FG + ANSI.ESC_END
|
||||||
|
const val FG_START = ANSI.ESC_START + "38;5;"
|
||||||
|
const val FG_BOLD_START = ANSI.ESC_START + ANSI.BOLD + "38;5;"
|
||||||
|
const val BG_START = ANSI.ESC_START + "48;5;"
|
||||||
|
const val RED = "9"
|
||||||
|
const val BLACK = "16"
|
||||||
|
const val GREEN = "22"
|
||||||
|
const val BLUE = "27"
|
||||||
|
const val ORANGE = "202"
|
||||||
|
const val DIMMED_WHITE = "250"
|
||||||
|
const val WHITE = "255"
|
||||||
|
const val UNSET = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface of HighlightingCompositeConverterExt, used to colour the background and foreground of log messages
|
||||||
|
* depending on their severity.
|
||||||
|
*
|
||||||
|
* Inheritor of ForegroundCompositeConverterBase, the implementation controlling colour-based transformations of
|
||||||
|
* log events
|
||||||
|
*
|
||||||
|
* @see HighlightingCompositeConverterExt
|
||||||
|
* @see CompositeConverter
|
||||||
|
*/
|
||||||
|
abstract class ForegroundBackgroundCompositeConverter<E : ILoggingEvent> : ForegroundCompositeConverterBase<E>() {
|
||||||
|
override fun transform(event: E, `in`: String) = buildString {
|
||||||
|
val fg = getForegroundColorCode(event)
|
||||||
|
val bg = getBackgroundColourCode(event)
|
||||||
|
val severity = center(`in`.trim())
|
||||||
|
if (fg.isNotEmpty()) {
|
||||||
|
append(Codes.FG_BOLD_START)
|
||||||
|
append(fg)
|
||||||
|
append(ANSI.ESC_END)
|
||||||
|
}
|
||||||
|
if (bg.isNotEmpty()) {
|
||||||
|
append(Codes.BG_START)
|
||||||
|
append(getBackgroundColourCode(event))
|
||||||
|
append(ANSI.ESC_END)
|
||||||
|
}
|
||||||
|
append(severity)
|
||||||
|
append(Codes.SET_DEFAULT_COLOR)
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract fun getBackgroundColourCode(event: ILoggingEvent): String
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converter class extension for control over backgrounds and foregrounds<
|
||||||
|
*
|
||||||
|
* Overrides methods of ForegroundBackgroundCompositeConverter to specify the bg/fg colours depending on severity
|
||||||
|
*
|
||||||
|
* Adapted from [shuwada/logback-custom-color](https://github.com/shuwada/logback-custom-color)
|
||||||
|
*/
|
||||||
|
class HighlightingCompositeConverterExt : ForegroundBackgroundCompositeConverter<ILoggingEvent>() {
|
||||||
|
override fun getForegroundColorCode(event: ILoggingEvent) = when (event.level) {
|
||||||
|
Level.TRACE -> Codes.WHITE
|
||||||
|
Level.DEBUG -> Codes.WHITE
|
||||||
|
Level.WARN -> Codes.WHITE
|
||||||
|
Level.INFO -> Codes.WHITE
|
||||||
|
Level.ERROR -> Codes.WHITE
|
||||||
|
else -> Codes.UNSET
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getBackgroundColourCode(event: ILoggingEvent) = when (event.level) {
|
||||||
|
Level.TRACE -> Codes.BLACK
|
||||||
|
Level.DEBUG -> Codes.GREEN
|
||||||
|
Level.WARN -> Codes.ORANGE
|
||||||
|
Level.INFO -> Codes.BLUE
|
||||||
|
Level.ERROR -> Codes.RED
|
||||||
|
else -> Codes.UNSET
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converter rule which pulls out the last string of the thread split by spaces
|
||||||
|
*/
|
||||||
|
class ThreadConverter<E> : CompositeConverter<E>() {
|
||||||
|
override fun transform(event: E, `in`: String) = `in`.split(" ").last()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converter rule which converts text to bold white
|
||||||
|
*/
|
||||||
|
class BoldWhiteCompositeConverterExt<E> : BoldWhiteCompositeConverter<E>() {
|
||||||
|
override fun transform(event: E, `in`: String) =
|
||||||
|
Codes.FG_BOLD_START + Codes.DIMMED_WHITE + ANSI.ESC_END + `in` + Codes.SET_DEFAULT_COLOR
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
<included>
|
||||||
|
<import class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"/>
|
||||||
|
<import class="ch.qos.logback.core.ConsoleAppender"/>
|
||||||
|
<import class="ch.qos.logback.core.FileAppender"/>
|
||||||
|
<import class="com.shr4pnel.ferretirc.util.HighlightingCompositeConverterExt"/>
|
||||||
|
<import class="com.shr4pnel.ferretirc.util.ThreadConverter"/>
|
||||||
|
<import class="com.shr4pnel.ferretirc.util.BoldWhiteCompositeConverterExt"/>
|
||||||
|
<import class="ch.qos.logback.classic.filter.ThresholdFilter"/>
|
||||||
|
<!-- https://logback.qos.ch/manual/layouts.html#formatModifiers -->
|
||||||
|
<conversionRule conversionWord="highlightext" class="HighlightingCompositeConverterExt" />
|
||||||
|
<conversionRule conversionWord="boldwhiteext" class="BoldWhiteCompositeConverterExt" />
|
||||||
|
<conversionRule conversionWord="threadconvert" class="ThreadConverter" />
|
||||||
|
<appender name="STDOUT" class="ConsoleAppender">
|
||||||
|
<filter class="ThresholdFilter">
|
||||||
|
<level>${STDOUT_LEVEL:-debug}</level>
|
||||||
|
</filter>
|
||||||
|
<encoder class="PatternLayoutEncoder">
|
||||||
|
<pattern>%d{HH:mm:ss.SSS} %highlightext(%level) %-13.13threadconvert(%t) %-36.36logger %boldwhiteext(%msg) %n</pattern>
|
||||||
|
</encoder>
|
||||||
|
</appender>
|
||||||
|
<appender name="FILE" class="FileAppender">
|
||||||
|
<file>${TEST_LOG_DIR}/libferretirc.log</file>
|
||||||
|
<immediateFlush>true</immediateFlush>
|
||||||
|
<append>false</append>
|
||||||
|
<encoder class="PatternLayoutEncoder">
|
||||||
|
<pattern>%d{HH:mm:ss.SSS} [%.16t/%-5level] %logger %msg%n</pattern>
|
||||||
|
</encoder>
|
||||||
|
</appender>
|
||||||
|
</included>
|
||||||
@@ -2,14 +2,8 @@
|
|||||||
<!DOCTYPE configuration>
|
<!DOCTYPE configuration>
|
||||||
<!-- From https://logback.qos.ch/manual/configuration.html -->
|
<!-- From https://logback.qos.ch/manual/configuration.html -->
|
||||||
<configuration>
|
<configuration>
|
||||||
<import class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"/>
|
<include resource="logback-base.xml"/>
|
||||||
<import class="ch.qos.logback.core.ConsoleAppender"/>
|
<root level="info">
|
||||||
<appender name="STDOUT" class="ConsoleAppender">
|
|
||||||
<encoder class="PatternLayoutEncoder">
|
|
||||||
<pattern>%d{mm:ss.SSS} [%-5level] %logger{36}: %msg%n</pattern>
|
|
||||||
</encoder>
|
|
||||||
</appender>
|
|
||||||
<root level="debug">
|
|
||||||
<appender-ref ref="STDOUT"/>
|
<appender-ref ref="STDOUT"/>
|
||||||
</root>
|
</root>
|
||||||
</configuration>
|
</configuration>
|
||||||
@@ -2,54 +2,54 @@ package com.shr4pnel.ferretirc
|
|||||||
|
|
||||||
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
import com.shr4pnel.ferretirc.net.messages.ServerMessage
|
||||||
import io.github.oshai.kotlinlogging.KotlinLogging
|
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||||
import kotlinx.coroutines.delay
|
|
||||||
import kotlinx.coroutines.launch
|
|
||||||
import kotlinx.coroutines.runBlocking
|
import kotlinx.coroutines.runBlocking
|
||||||
import kotlinx.coroutines.withTimeoutOrNull
|
import kotlinx.coroutines.test.runTest
|
||||||
import com.shr4pnel.ferretirc.net.messages.ClientMessage as Message
|
|
||||||
import org.junit.jupiter.api.AfterAll
|
import org.junit.jupiter.api.AfterAll
|
||||||
import org.junit.jupiter.api.BeforeAll
|
import org.junit.jupiter.api.BeforeAll
|
||||||
import org.junit.jupiter.api.Test
|
import org.junit.jupiter.api.Test
|
||||||
import java.io.File
|
import java.io.File
|
||||||
import java.lang.ProcessBuilder
|
import java.lang.ProcessBuilder
|
||||||
import kotlin.test.assertEquals
|
import kotlin.test.assertEquals
|
||||||
import kotlin.test.assertNotNull
|
import com.shr4pnel.ferretirc.net.messages.ClientMessage as Message
|
||||||
import kotlin.time.Duration.Companion.seconds
|
|
||||||
|
|
||||||
class IrcClientTest {
|
class IrcClientTest {
|
||||||
|
private val logger = KotlinLogging.logger {}
|
||||||
|
|
||||||
companion object {
|
companion object {
|
||||||
lateinit var processes: MutableList<Process>
|
lateinit var processes: MutableList<Process>
|
||||||
val client = IrcClient("localhost", 6667)
|
val client = IrcClient("localhost", 6667, enableLogging = true)
|
||||||
private val logger = KotlinLogging.logger("IrcClientTest")
|
private val logger = KotlinLogging.logger {}
|
||||||
|
val guestUser = IrcClient("localhost", 6667)
|
||||||
|
|
||||||
@JvmStatic
|
@JvmStatic
|
||||||
@BeforeAll
|
@BeforeAll
|
||||||
fun setup() {
|
fun setup(): Unit =
|
||||||
|
runBlocking {
|
||||||
val logFile = File("src/test/resources/logs/ngircd.log")
|
val logFile = File("src/test/resources/logs/ngircd.log")
|
||||||
val ngircdConfigPath = javaClass.classLoader.getResource("ngircd.conf")!!.path
|
val ngircdConfigPath = javaClass.classLoader.getResource("ngircd.conf")!!.path
|
||||||
logFile.createNewFile()
|
logFile.createNewFile()
|
||||||
processes = ProcessBuilder.startPipeline(
|
processes =
|
||||||
|
ProcessBuilder.startPipeline(
|
||||||
listOf<ProcessBuilder>(
|
listOf<ProcessBuilder>(
|
||||||
// Run IRC server in [-d] debug log mode, with [-n] no daemon, using config [-f] file at path
|
// Run IRC server in [-d] debug log mode, with [-n] no daemon, using config [-f] file at path
|
||||||
ProcessBuilder("ngircd", "-dnf", ngircdConfigPath).redirectErrorStream(true),
|
ProcessBuilder("ngircd", "-dnf", ngircdConfigPath).redirectErrorStream(true),
|
||||||
// Remove unhelpful default ngircd info [PID. relative time, GID?]
|
// Remove unhelpful default ngircd info [PID. relative time, GID?]
|
||||||
ProcessBuilder("sed", "-ue", "s/\\[[^][]*\\]//g"),
|
ProcessBuilder("sed", "-ue", "s/\\[[^][]*\\]//g"),
|
||||||
// Add relative timestamp
|
// Add relative timestamp
|
||||||
ProcessBuilder("ts", "-s", "%H:%M:%.S").redirectOutput(logFile)
|
ProcessBuilder("ts", "-s", "%H:%M:%.S").redirectOutput(logFile),
|
||||||
|
),
|
||||||
)
|
)
|
||||||
)
|
|
||||||
client.scope.launch {
|
|
||||||
client.connect()
|
client.connect()
|
||||||
client.register("shr4p", "password")
|
client.register("shr4p", "Tyler Fullname", "password")
|
||||||
}
|
guestUser.connect()
|
||||||
runBlocking {
|
guestUser.register("guest", "guest", "pass")
|
||||||
delay(0.5.seconds)
|
client.server
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@JvmStatic
|
@JvmStatic
|
||||||
@AfterAll
|
@AfterAll
|
||||||
fun shutdown() = runBlocking {
|
fun shutdown() =
|
||||||
|
runBlocking {
|
||||||
logger.info { "Closing server." }
|
logger.info { "Closing server." }
|
||||||
client.queueMessage(Message.Die())
|
client.queueMessage(Message.Die())
|
||||||
client.waitForNext<ServerMessage.Notice>()
|
client.waitForNext<ServerMessage.Notice>()
|
||||||
@@ -58,42 +58,60 @@ class IrcClientTest {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
fun sample() {
|
fun pingGetsPong() =
|
||||||
client.scope.launch {
|
runTest {
|
||||||
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@Test
|
|
||||||
fun pingGetsPong() = runBlocking {
|
|
||||||
val token = "ACK"
|
val token = "ACK"
|
||||||
logger.info { "Sending PING $token" }
|
val msg = Message.Ping(token)
|
||||||
client.queueMessage(Message.Ping(token))
|
val pong = client.queueAndWaitForNext<ServerMessage.Pong>(msg)
|
||||||
|
|
||||||
logger.info { "Waiting to receive PONG" }
|
|
||||||
val pong = withTimeoutOrNull(1.seconds) {
|
|
||||||
client.waitForNext<ServerMessage.Pong> { it.token.equals(token) }
|
|
||||||
}
|
|
||||||
assertNotNull(pong, "Reached timeout while waiting for PONG")
|
|
||||||
assertEquals(token, pong.token, "Token in PING did not match PONG")
|
assertEquals(token, pong.token, "Token in PING did not match PONG")
|
||||||
logger.info { "Received PING" }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
fun oper() = runBlocking {
|
fun oper() =
|
||||||
|
runTest {
|
||||||
client.queueMessage(Message.Oper("shr4p", "password"))
|
client.queueMessage(Message.Oper("shr4p", "password"))
|
||||||
val mode = withTimeoutOrNull(1.seconds) {
|
val mode = client.waitForNext<ServerMessage.Mode>()
|
||||||
client.waitForNext<ServerMessage.Mode>()
|
|
||||||
}
|
|
||||||
assertNotNull(mode, "Timed out waiting for OPER MODE response")
|
|
||||||
assertEquals("shr4p", mode.operatorName, "Received incorrect operator name in MODE")
|
assertEquals("shr4p", mode.operatorName, "Received incorrect operator name in MODE")
|
||||||
assertEquals("+o", mode.pMask, "Received unexpected mask in MODE")
|
assertEquals("+o", mode.pMask, "Received unexpected mask in MODE")
|
||||||
logger.info { "Received MODE with mask ${mode.pMask}" }
|
logger.info { "Received MODE with mask ${mode.pMask}" }
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
fun listChannels() = runBlocking {
|
fun listChannels() =
|
||||||
client.queueMessage(Message.List())
|
runTest {
|
||||||
delay(1.seconds)
|
val channels = client.server.fetchChannels()
|
||||||
|
assert(channels.isNotEmpty())
|
||||||
|
client.queueMessage(Message.Join(channels.first()))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun messageLands() =
|
||||||
|
runTest {
|
||||||
|
val channels = client.server.fetchChannels()
|
||||||
|
val message = Message.PrivMsg(channels.first(), "bring me to life")
|
||||||
|
guestUser.queueMessage(message)
|
||||||
|
val receivedMessage = client.waitForNext<ServerMessage.PrivMsg>()
|
||||||
|
logger.debug { "Message: $message, Received: $receivedMessage" }
|
||||||
|
assertEquals(message.message, receivedMessage.message)
|
||||||
|
assertEquals(message.target.chanName, receivedMessage.targets.first())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun manyMessagesLand() =
|
||||||
|
runTest {
|
||||||
|
val channels = client.server.fetchChannels()
|
||||||
|
val channel = channels.first()
|
||||||
|
val max = 100
|
||||||
|
|
||||||
|
val messages = mutableListOf<Message.PrivMsg>()
|
||||||
|
val receivedMessages = mutableListOf<ServerMessage.PrivMsg>()
|
||||||
|
|
||||||
|
for (i in 1..max) messages.add(Message.PrivMsg(channel, "$i: bring me to life"))
|
||||||
|
|
||||||
|
for (i in 0..<max) {
|
||||||
|
val msg = client.waitForNextAfterAction<ServerMessage.PrivMsg> { guestUser.queueMessage(messages[i]) }
|
||||||
|
receivedMessages.add(msg)
|
||||||
|
}
|
||||||
|
for (i in 0..<max) assertEquals(messages[i].message, receivedMessages[i].message)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
<!DOCTYPE configuration>
|
||||||
|
<!-- From https://logback.qos.ch/manual/configuration.html -->
|
||||||
|
<configuration>
|
||||||
|
<import class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"/>
|
||||||
|
<import class="ch.qos.logback.core.ConsoleAppender"/>
|
||||||
|
<include resource="logback-base.xml"/>
|
||||||
|
<logger name="com.shr4pnel" level="trace" additivity="false">
|
||||||
|
<appender-ref ref="STDOUT"/>
|
||||||
|
<appender-ref ref="FILE"/>
|
||||||
|
</logger>
|
||||||
|
<root level="warn">
|
||||||
|
<appender-ref ref="STDOUT"/>
|
||||||
|
</root>
|
||||||
|
</configuration>
|
||||||
@@ -57,3 +57,8 @@
|
|||||||
[OPERATOR]
|
[OPERATOR]
|
||||||
Name = shr4p
|
Name = shr4p
|
||||||
Password = password
|
Password = password
|
||||||
|
|
||||||
|
[CHANNEL]
|
||||||
|
Name = #Default
|
||||||
|
Topic = Awesome fukin channel topic
|
||||||
|
Modes = P
|
||||||
Reference in New Issue
Block a user