Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e9569545d8 | |||
| 39f9abd9de | |||
| 6453e42d06 | |||
| 9901077213 | |||
| 96b3241716 | |||
| 5433a2de0d | |||
| 0e0a280308 | |||
| aba9cf4037 | |||
| 06a021de49 | |||
| 89b4f2db92 | |||
| 468022ae0e | |||
| cb024e52ff | |||
| 5dbf7f4073 | |||
| d4a5d3d6ee | |||
| 233a67f2b0 | |||
| ba772f3f7c | |||
| ee78703cd1 | |||
| 3d2d21f6c0 | |||
| 0dedd3c0f4 | |||
| 79d5df8291 | |||
| 899243c62b |
@@ -1,674 +1,7 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
Copyright (c) 2026 RikitavTimur
|
||||
|
||||
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.
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
Preamble
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
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>.
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -8,6 +8,14 @@ Telegrator is a modern C# framework for building Telegram bots, inspired by AOP
|
||||
|
||||
---
|
||||
|
||||
## Learn and Docs
|
||||
|
||||
Learn Telegrator on [Official documentation site](https://rikitav.github.io/telegrator.docs).
|
||||
|
||||
The documentation may not be completely transparent, informative or even actual to latest version, so if you have any questions or problems, please write them in the [Telegram.Bot](https://t.me/joinchat/B35YY0QbLfd034CFnvCtCA) group. I am a member of this group and will notice you! If you have any suggestions or want to participate in building documentation, make push requests and open issues on this repository!
|
||||
|
||||
---
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
- **Aspect-oriented approach**: Handlers and filters are "aspects" of the bot, easily composable and extendable.
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
<Project Path="src/Telegrator.Analyzers/Telegrator.Analyzers.csproj" />
|
||||
<Project Path="src/Telegrator.Hosting.Web/Telegrator.Hosting.Web.csproj" />
|
||||
<Project Path="src/Telegrator.Hosting/Telegrator.Hosting.csproj" />
|
||||
<Project Path="src/Telegrator.Hosting.WideBot/Telegrator.Hosting.WideBot.csproj" />
|
||||
<Project Path="src/Telegrator.Localized/Telegrator.Localized.csproj" />
|
||||
<Project Path="src/Telegrator/Telegrator.csproj" />
|
||||
<Project Path="tests/Telegrator.Tests/Telegrator.Tests.csproj" />
|
||||
|
||||
@@ -6,3 +6,4 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
[assembly: SuppressMessage("Style", "IDE0090")]
|
||||
[assembly: SuppressMessage("Roslynator", "RCS1037")]
|
||||
|
||||
@@ -112,7 +112,7 @@ public class ImplicitHandlerBuilderExtensionsGenerator : IIncrementalGenerator
|
||||
{
|
||||
try
|
||||
{
|
||||
PrimaryConstructorBaseTypeSyntax primaryConstructor = (PrimaryConstructorBaseTypeSyntax)classDeclaration.BaseList.Types.ElementAt(0);
|
||||
PrimaryConstructorBaseTypeSyntax primaryConstructor = (PrimaryConstructorBaseTypeSyntax)classDeclaration.BaseList.Types[0];
|
||||
MethodDeclarationSyntax genExtension = GeneratedExtensionsMethod(classDeclaration, classDeclaration.ParameterList, primaryConstructor.ArgumentList, targeter);
|
||||
extensions.Add(genExtension);
|
||||
}
|
||||
@@ -148,6 +148,7 @@ public class ImplicitHandlerBuilderExtensionsGenerator : IIncrementalGenerator
|
||||
.AddMembers([.. targetters.Values, .. extensions]);
|
||||
|
||||
NamespaceDeclarationSyntax namespaceDeclaration = SyntaxFactory.NamespaceDeclaration(SyntaxFactory.ParseName("Telegrator"))
|
||||
.WithLeadingTrivia(SyntaxFactory.ParseLeadingTrivia("#pragma warning disable CS1591"))
|
||||
.WithMembers([extensionsClass]);
|
||||
|
||||
CompilationUnitSyntax compilationUnit = SyntaxFactory.CompilationUnit()
|
||||
@@ -238,7 +239,7 @@ public class ImplicitHandlerBuilderExtensionsGenerator : IIncrementalGenerator
|
||||
if (targeters.TryGetValue(classDeclaration.Identifier.ValueText, out MethodDeclarationSyntax targeter))
|
||||
return targeter;
|
||||
|
||||
if (classDeclaration.BaseList != null && targeters.TryGetValue(classDeclaration.BaseList.Types.ElementAt(0).Type.ToString(), out targeter))
|
||||
if (classDeclaration.BaseList != null && targeters.TryGetValue(classDeclaration.BaseList.Types[0].Type.ToString(), out targeter))
|
||||
return targeter;
|
||||
|
||||
return null;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace Telegrator.RoslynGenerators.RoslynExtensions
|
||||
namespace Telegrator.RoslynGenerators.RoslynExtensions;
|
||||
|
||||
public static class CollectionsExtensions
|
||||
{
|
||||
public static class CollectionsExtensions
|
||||
{
|
||||
public static IEnumerable<TSource> Combine<TSource>(params IEnumerable<TSource>[] collections)
|
||||
=> collections.SelectMany(x => x);
|
||||
|
||||
@@ -60,5 +60,4 @@
|
||||
|
||||
public static IEnumerable<T> Repeat<T>(this T item, int times)
|
||||
=> Enumerable.Range(0, times).Select(_ => item);
|
||||
}
|
||||
}
|
||||
|
||||
+94
-190
@@ -4,188 +4,15 @@
|
||||
<name>Telegrator.Hosting.Web</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Telegrator.Hosting.Web.TelegramBotWebHost">
|
||||
<summary>
|
||||
Represents a web hosted telegram bot
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.Services">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.UpdateRouter">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.DataSources">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.Lifetime">
|
||||
<summary>
|
||||
Allows consumers to be notified of application lifetime events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.Logger">
|
||||
<summary>
|
||||
This application's logger
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Builder.WebApplicationBuilder"/> class.
|
||||
</summary>
|
||||
<param name="webApplicationBuilder">The proxied instance of host builder.</param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateBuilder(Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Creates new <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default services and webhook update receiving scheme
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateSlimBuilder(Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Creates new SLIM <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default services and webhook update receiving scheme
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateEmptyBuilder(Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Creates new EMPTY <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.StartAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.StopAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateApplicationBuilder">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.Use(System.Func{Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.AspNetCore.Http.RequestDelegate})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.New">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.Build">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.DisposeAsync">
|
||||
<summary>
|
||||
Disposes the host.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.Dispose">
|
||||
<summary>
|
||||
Disposes the host.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder">
|
||||
<summary>
|
||||
Represents a web hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Handlers">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Configuration">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Logging">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Services">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Environment">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Properties">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Metrics">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="webApplicationBuilder"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Telegrator.TelegratorOptions,Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="webApplicationBuilder"></param>
|
||||
<param name="options"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Telegrator.Core.IHandlersCollection,Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="webApplicationBuilder"></param>
|
||||
<param name="handlers"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Telegrator.Core.IHandlersCollection,Telegrator.TelegratorOptions,Microsoft.AspNetCore.Builder.WebApplicationOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="webApplicationBuilder"></param>
|
||||
<param name="handlers"></param>
|
||||
<param name="options"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Build">
|
||||
<summary>
|
||||
Builds the host.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.ConfigureContainer``1(Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0},System.Action{``0})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.Hosting.Web.WebhookerOptions">
|
||||
<summary>
|
||||
Configuration options for Telegram bot behavior and execution settings.
|
||||
Controls various aspects of bot operation including concurrency, routing, webhook receiving, and execution policies.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.WebhookerOptions.WebhookUri">
|
||||
<summary>
|
||||
Gets or sets HTTPS URL to send updates to. Use an empty string to remove webhook integration
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.WebhookerOptions.SecretToken">
|
||||
<summary>
|
||||
A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
|
||||
Only characters A-Z, a-z, 0-9, _ and - are allowed.
|
||||
The header is useful to ensure that the request comes from a webhook set by you.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.WebhookerOptions.MaxConnections">
|
||||
<summary>
|
||||
The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40.
|
||||
Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.Web.WebhookerOptions.DropPendingUpdates">
|
||||
<summary>
|
||||
Pass true to drop all pending updates
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.Mediation.HostedUpdateWebhooker">
|
||||
<summary>
|
||||
Service for receiving updates for Hosted telegram bots via Webhooks
|
||||
Service for receiving updates for Hosted telegram bots via Webhooks and queuing them to router
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.#ctor(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegrator.Hosting.Web.WebhookerOptions})">
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.#ctor(Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegrator.WebhookerOptions})">
|
||||
<summary>
|
||||
Initiallizes new instance of <see cref="T:Telegrator.Mediation.HostedUpdateWebhooker"/>
|
||||
</summary>
|
||||
<param name="botHost"></param>
|
||||
<param name="botClient"></param>
|
||||
<param name="updateRouter"></param>
|
||||
<param name="options"></param>
|
||||
@@ -197,41 +24,118 @@
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.StopAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.ServicesCollectionExtensions">
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.RemapWebhook(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Allows to remap receiving webhook endpoint and map new route to webhost.
|
||||
</summary>
|
||||
<param name="routeBuilder"></param>
|
||||
<param name="webhookUri"></param>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
<exception cref="T:System.ArgumentException"></exception>
|
||||
</member>
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.MapWebhook(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder)">
|
||||
<summary>
|
||||
Maps bot webhook to application builder
|
||||
</summary>
|
||||
<param name="routeBuilder"></param>
|
||||
</member>
|
||||
<member name="T:Telegrator.WebHostBuilderExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostApplicationBuilder"/> to configure Telegrator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WebHostBuilderExtensions.AddTelegratorWeb(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WebHostBuilderExtensions.AddTelegratorWeb(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection,System.Action{Telegrator.Hosting.ITelegramBotHostBuilder})">
|
||||
<summary>
|
||||
Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WebHostBuilderExtensions.AddTelegratorWebInternal(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Collections.Generic.IDictionary{System.Object,System.Object},Telegrator.Core.IHandlersCollection@,Telegrator.TelegratorOptions)">
|
||||
<summary>
|
||||
Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.WebServicesCollectionExtensions">
|
||||
<summary>
|
||||
Contains extensions for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
|
||||
Provides method to configure Telegram Bot WebHost
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Telegrator.ServicesCollectionExtensions.HandlersCollectionPropertyKey">
|
||||
<member name="M:Telegrator.WebServicesCollectionExtensions.ConfigureWebhooker(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegrator.WebhookerOptions)">
|
||||
<summary>
|
||||
The key used to store the <see cref="T:Telegrator.Core.IHandlersCollection"/> in the builder properties.
|
||||
Adds WebhookerOptions to services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="options"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.WebServicesCollectionExtensions.TryFindWebhooker(System.IServiceProvider,Telegrator.Mediation.HostedUpdateWebhooker@)">
|
||||
<summary>
|
||||
Searchs for <see cref="T:Telegrator.Mediation.HostedUpdateWebhooker"/> hosted service inside hosts services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="webhooker"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Telegrator.WebTelegramBotHostExtensions">
|
||||
<summary>
|
||||
Provides useful methods to adjust Telegram bot Host
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.get_Handlers(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
|
||||
<inheritdoc cref="P:Telegrator.ServicesCollectionExtensions.<G>$41F16C2D39AF52899E745C9C9F42FF83.Handlers"/>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.AddTelegratorWeb(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.UseTelegratorWeb(Microsoft.AspNetCore.Builder.WebApplication)">
|
||||
<member name="M:Telegrator.WebTelegramBotHostExtensions.UseTelegratorWeb``1(``0,System.Boolean)">
|
||||
<summary>
|
||||
Replaces the initialization logic from TelegramBotWebHost constructor.
|
||||
Initializes the bot and logs handlers on application startup.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.AddTelegramWebhook(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<member name="M:Telegrator.WebTelegramBotHostExtensions.RemapWebhook``1(``0,System.String)">
|
||||
<summary>
|
||||
Allows to remap receiving webhook endpoint and map new route to webhost.
|
||||
</summary>
|
||||
<param name="app"></param>
|
||||
<param name="webhookUri"></param>
|
||||
<returns></returns>
|
||||
<exception cref="T:System.ArgumentException"></exception>
|
||||
</member>
|
||||
<member name="M:Telegrator.WebTelegramBotHostExtensions.AddTelegramWebhook(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Registers <see cref="T:Telegram.Bot.ITelegramBotClient"/> service with <see cref="T:Telegrator.Mediation.HostedUpdateWebhooker"/> to receive updates using webhook
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="P:Telegrator.ServicesCollectionExtensions.<G>$41F16C2D39AF52899E745C9C9F42FF83.Handlers">
|
||||
<member name="T:Telegrator.WebhookerOptions">
|
||||
<summary>
|
||||
Gets the <see cref="T:Telegrator.Core.IHandlersCollection"/> from the builder properties.
|
||||
Configuration options for Telegram bot behavior and execution settings.
|
||||
Controls various aspects of bot operation including concurrency, routing, webhook receiving, and execution policies.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.WebhookerOptions.WebhookUri">
|
||||
<summary>
|
||||
Gets or sets HTTPS URL to send updates to. Use an empty string to remove webhook integration
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.WebhookerOptions.SecretToken">
|
||||
<summary>
|
||||
A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
|
||||
Only characters A-Z, a-z, 0-9, _ and - are allowed.
|
||||
The header is useful to ensure that the request comes from a webhook set by you.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.WebhookerOptions.MaxConnections">
|
||||
<summary>
|
||||
The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40.
|
||||
Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.WebhookerOptions.DropPendingUpdates">
|
||||
<summary>
|
||||
Pass true to drop all pending updates
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
|
||||
@@ -0,0 +1,205 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Telegrator.Hosting.WideBot</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Telegrator.Mediation.HostedWideBotUpdateReceiver">
|
||||
<summary>
|
||||
Service for receiving updates for Hosted wide telegram bots and queuing them to router
|
||||
</summary>
|
||||
<param name="logger"></param>
|
||||
<param name="botClient"></param>
|
||||
<param name="updateRouter"></param>
|
||||
<param name="options"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Mediation.HostedWideBotUpdateReceiver.#ctor(Microsoft.Extensions.Logging.ILogger{Telegrator.Mediation.HostedWideBotUpdateReceiver},Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegrator.WideBotOptions})">
|
||||
<summary>
|
||||
Service for receiving updates for Hosted wide telegram bots and queuing them to router
|
||||
</summary>
|
||||
<param name="logger"></param>
|
||||
<param name="botClient"></param>
|
||||
<param name="updateRouter"></param>
|
||||
<param name="options"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Mediation.HostedWideBotUpdateReceiver.ExecuteAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.Mediation.WideUpdateReceiver">
|
||||
<summary>
|
||||
Reactive implementation of <see cref="T:Telegrator.Core.IUpdateReceiver"/> for polling updates from Telegram.
|
||||
Provides custom update receiving logic with error handling and configuration options.
|
||||
</summary>
|
||||
<param name="client">The Telegram bot client for making API requests.</param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Mediation.WideUpdateReceiver.#ctor(Telegram.Bot.WTelegramBotClient)">
|
||||
<summary>
|
||||
Reactive implementation of <see cref="T:Telegrator.Core.IUpdateReceiver"/> for polling updates from Telegram.
|
||||
Provides custom update receiving logic with error handling and configuration options.
|
||||
</summary>
|
||||
<param name="client">The Telegram bot client for making API requests.</param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Mediation.WideUpdateReceiver.ReceiveAsync(Telegram.Bot.Polling.IUpdateHandler,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.TelegratorWClient">
|
||||
<summary>
|
||||
Client class for the Telegrator library with Wider functionality, provided by WTelegramBotClient.
|
||||
Extends TelegramBotClient with reactive capabilities for handling updates.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.TelegratorWClient.Options">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.TelegratorWClient.Handlers">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.TelegratorWClient.BotInfo">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.TelegratorWClient.UpdateRouter">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.TelegratorWClient.#ctor(Telegram.Bot.WTelegramBotClientOptions,Telegrator.TelegratorOptions,System.Net.Http.HttpClient,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Initializes new instance of <see cref="T:Telegrator.TelegratorWClient"/>
|
||||
</summary>
|
||||
<param name="wOptions"></param>
|
||||
<param name="telegratorOptions"></param>
|
||||
<param name="httpClient"></param>
|
||||
<param name="cancellationToken"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.TelegratorWClient.StartReceiving(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.TelegratorWClient.StartReceivingAsync(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.HandlersExtensions">
|
||||
<summary>
|
||||
Provides extensions memebrs for <see cref="T:Telegrator.Core.Handlers.UpdateHandlerBase"/> for easy access to Wider bot functions and update
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersExtensions.get_WClient``1(Telegrator.Core.Handlers.AbstractUpdateHandler{``0})">
|
||||
<inheritdoc cref="P:Telegrator.HandlersExtensions.<G>$F89AF16C011F73161937A1614DCDDD7A`1.WClient"/>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersExtensions.get_WideUpdate``1(Telegrator.Core.Handlers.AbstractUpdateHandler{``0})">
|
||||
<inheritdoc cref="P:Telegrator.HandlersExtensions.<G>$F89AF16C011F73161937A1614DCDDD7A`1.WideUpdate"/>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersExtensions.get_TLUpdate``1(Telegrator.Core.Handlers.AbstractUpdateHandler{``0})">
|
||||
<inheritdoc cref="P:Telegrator.HandlersExtensions.<G>$F89AF16C011F73161937A1614DCDDD7A`1.TLUpdate"/>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersExtensions.AsWClient(Telegram.Bot.ITelegramBotClient)">
|
||||
<summary>
|
||||
Casts Update to <see cref="T:Telegram.Bot.WTelegramBotClient"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersExtensions.AsWUpdate(Telegram.Bot.Types.Update)">
|
||||
<summary>
|
||||
Casts Update to <see cref="T:WTelegram.Types.Update"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.HandlersExtensions.<G>$F89AF16C011F73161937A1614DCDDD7A`1.WClient">
|
||||
<summary>
|
||||
Casts Update to <see cref="T:Telegram.Bot.WTelegramBotClient"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.HandlersExtensions.<G>$F89AF16C011F73161937A1614DCDDD7A`1.WideUpdate">
|
||||
<summary>
|
||||
Casts Update to <see cref="T:WTelegram.Types.Update"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.HandlersExtensions.<G>$F89AF16C011F73161937A1614DCDDD7A`1.TLUpdate">
|
||||
<summary>
|
||||
Casts Update to <see cref="T:TL.Update"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.WideHostBuilderExtensions">
|
||||
<summary>
|
||||
Provides extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostApplicationBuilder"/> to configure Telegrator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideHostBuilderExtensions.AddWideTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.Func{System.IServiceProvider,System.Data.Common.DbConnection},System.Action{Telegrator.Hosting.ITelegramBotHostBuilder},Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideHostBuilderExtensions.AddWideTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.Func{System.IServiceProvider,System.Data.Common.DbConnection},Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideHostBuilderExtensions.AddWideTelegratorInternal(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Collections.Generic.IDictionary{System.Object,System.Object},System.Func{System.IServiceProvider,System.Data.Common.DbConnection},Telegrator.Core.IHandlersCollection@,Telegrator.TelegratorOptions)">
|
||||
<summary>
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.WideBotServiceCollectionExtensions">
|
||||
<summary>
|
||||
Contains extensions for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
|
||||
Provides method to configure Telegram Bot WebHost
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideBotServiceCollectionExtensions.ConfigureWideTelegram(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegram.Bot.WTelegramBotClientOptions)">
|
||||
<summary>
|
||||
Adds WTelegramBotClientOptions to services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="options"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideBotServiceCollectionExtensions.ConfigureWideBot(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegrator.WideBotOptions)">
|
||||
<summary>
|
||||
Adds WTelegramBotClientOptions to services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="options"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideBotServiceCollectionExtensions.AddMTProtoUpdateReceiver(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Boolean)">
|
||||
<summary>
|
||||
Adds WTelegramBotClient
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="useHttp"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Telegrator.WideTelegramBotHostExtensions">
|
||||
<summary>
|
||||
Provides useful methods to adjust Telegram bot Host
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.WideTelegramBotHostExtensions.UseWideTelegrator(Microsoft.Extensions.Hosting.IHost)">
|
||||
<summary>
|
||||
Replaces the initialization logic from TelegramBotWebHost constructor.
|
||||
Initializes the bot and logs handlers on application startup.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.WideBotOptions">
|
||||
<summary>
|
||||
Represents configuration options for initializing and customizing the behavior of a WideBot instance.
|
||||
</summary>
|
||||
<remarks>Use this class to specify required API credentials, optional proxy settings, update handling
|
||||
preferences, and SQL command detection for WideBot. All required properties must be set before using the options
|
||||
with a WideBot instance.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Telegrator.WideBotOptions.ApiId">
|
||||
<inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.ApiId"/>
|
||||
</member>
|
||||
<member name="P:Telegrator.WideBotOptions.ApiHash">
|
||||
<inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.ApiHash"/>
|
||||
</member>
|
||||
<member name="P:Telegrator.WideBotOptions.MTProxy">
|
||||
<inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.MTProxy"/>
|
||||
</member>
|
||||
<member name="P:Telegrator.WideBotOptions.SqlCommands">
|
||||
<inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.SqlCommands"/>
|
||||
</member>
|
||||
<member name="P:Telegrator.WideBotOptions.DropPendingUpdates">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether pending updates should be discarded.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
+65
-108
@@ -35,68 +35,14 @@
|
||||
Provides access to configuration of this Hosted telegram bot
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.Hosting.TelegramBotHost">
|
||||
<summary>
|
||||
Represents a hosted telegram bot
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.TelegramBotHost.Services">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.TelegramBotHost.UpdateRouter">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.TelegramBotHost.Logger">
|
||||
<summary>
|
||||
This application's logger
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHost"/> class.
|
||||
</summary>
|
||||
<param name="hostApplicationBuilder">The proxied instance of host builder.</param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.CreateBuilder">
|
||||
<summary>
|
||||
Creates new <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default configuration, services and long-polling update receiving scheme
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.CreateBuilder(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
|
||||
<summary>
|
||||
Creates new <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default services and long-polling update receiving scheme
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.CreateEmptyBuilder">
|
||||
<summary>
|
||||
Creates new EMPTY <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.CreateEmptyBuilder(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
|
||||
<summary>
|
||||
Creates new EMPTY <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.StartAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.StopAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHost.Dispose">
|
||||
<summary>
|
||||
Disposes the host.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.Hosting.TelegramBotHostBuilder">
|
||||
<member name="T:Telegrator.Hosting.ITelegramBotHostBuilder">
|
||||
<summary>
|
||||
Represents a hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.Hosting.TelegramBotHostBuilder">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Handlers">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
@@ -118,43 +64,18 @@
|
||||
<member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Metrics">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.IHostApplicationBuilder)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="hostApplicationBuilder"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.TelegratorOptions,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="hostApplicationBuilder"></param>
|
||||
<param name="options"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Core.IHandlersCollection,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="hostApplicationBuilder"></param>
|
||||
<param name="handlers"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Core.IHandlersCollection,Telegrator.TelegratorOptions,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
|
||||
</summary>
|
||||
<param name="hostApplicationBuilder"></param>
|
||||
<param name="handlers"></param>
|
||||
<param name="options"></param>
|
||||
<param name="settings"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.Build">
|
||||
<summary>
|
||||
Builds the host.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Hosting.TelegramBotHostBuilder.ConfigureContainer``1(Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0},System.Action{``0})">
|
||||
<inheritdoc/>
|
||||
@@ -174,42 +95,42 @@
|
||||
<member name="M:Telegrator.Logging.MicrosoftLoggingAdapter.Log(Telegrator.Logging.LogLevel,System.String,System.Exception)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.Polling.HostedUpdateReceiver">
|
||||
<member name="T:Telegrator.Mediation.HostedUpdateReceiver">
|
||||
<summary>
|
||||
Service for receiving updates for Hosted telegram bots
|
||||
Service for receiving updates for Hosted telegram botsand queuing them to router
|
||||
</summary>
|
||||
<param name="botClient"></param>
|
||||
<param name="updateRouter"></param>
|
||||
<param name="options"></param>
|
||||
<param name="logger"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Polling.HostedUpdateReceiver.#ctor(Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegram.Bot.Polling.ReceiverOptions},Microsoft.Extensions.Logging.ILogger{Telegrator.Polling.HostedUpdateReceiver})">
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateReceiver.#ctor(Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegram.Bot.Polling.ReceiverOptions},Microsoft.Extensions.Logging.ILogger{Telegrator.Mediation.HostedUpdateReceiver})">
|
||||
<summary>
|
||||
Service for receiving updates for Hosted telegram bots
|
||||
Service for receiving updates for Hosted telegram botsand queuing them to router
|
||||
</summary>
|
||||
<param name="botClient"></param>
|
||||
<param name="updateRouter"></param>
|
||||
<param name="options"></param>
|
||||
<param name="logger"></param>
|
||||
</member>
|
||||
<member name="M:Telegrator.Polling.HostedUpdateReceiver.ExecuteAsync(System.Threading.CancellationToken)">
|
||||
<member name="M:Telegrator.Mediation.HostedUpdateReceiver.ExecuteAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.Polling.HostUpdateRouter">
|
||||
<member name="T:Telegrator.Mediation.HostUpdateRouter">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="F:Telegrator.Polling.HostUpdateRouter.Logger">
|
||||
<member name="F:Telegrator.Mediation.HostUpdateRouter.Logger">
|
||||
<summary>
|
||||
<see cref="T:Microsoft.Extensions.Logging.ILogger"/> of this router
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.Polling.HostUpdateRouter.#ctor(Telegrator.Core.IHandlersProvider,Telegrator.Core.IAwaitingProvider,Telegrator.Core.States.IStateStorage,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},Telegrator.Core.ITelegramBotInfo,Microsoft.Extensions.Logging.ILogger{Telegrator.Polling.HostUpdateRouter})">
|
||||
<member name="M:Telegrator.Mediation.HostUpdateRouter.#ctor(Telegrator.Core.IHandlersProvider,Telegrator.Core.IAwaitingProvider,Telegrator.Core.States.IStateStorage,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},Telegrator.Core.ITelegramBotInfo,Microsoft.Extensions.Logging.ILogger{Telegrator.Mediation.HostUpdateRouter})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Polling.HostUpdateRouter.HandleUpdateAsync(Telegram.Bot.ITelegramBotClient,Telegram.Bot.Types.Update,System.Threading.CancellationToken)">
|
||||
<member name="M:Telegrator.Mediation.HostUpdateRouter.HandleUpdateAsync(Telegram.Bot.ITelegramBotClient,Telegram.Bot.Types.Update,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Polling.HostUpdateRouter.HandleException(Telegram.Bot.ITelegramBotClient,System.Exception,Telegram.Bot.Polling.HandleErrorSource,System.Threading.CancellationToken)">
|
||||
<member name="M:Telegrator.Mediation.HostUpdateRouter.HandleException(Telegram.Bot.ITelegramBotClient,System.Exception,Telegram.Bot.Polling.HandleErrorSource,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Default exception handler of this router
|
||||
</summary>
|
||||
@@ -221,7 +142,7 @@
|
||||
<member name="T:Telegrator.Providers.HostAwaitingProvider">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Providers.HostAwaitingProvider.#ctor(Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},Microsoft.Extensions.Logging.ILogger{Telegrator.Providers.HostAwaitingProvider})">
|
||||
<member name="M:Telegrator.Providers.HostAwaitingProvider.#ctor(Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.Providers.HostHandlersCollection">
|
||||
@@ -239,7 +160,7 @@
|
||||
<member name="T:Telegrator.Providers.HostHandlersProvider">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Providers.HostHandlersProvider.#ctor(Telegrator.Core.IHandlersCollection,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},System.IServiceProvider,Microsoft.Extensions.Logging.ILogger{Telegrator.Providers.HostHandlersProvider})">
|
||||
<member name="M:Telegrator.Providers.HostHandlersProvider.#ctor(Telegrator.Core.IHandlersCollection,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},System.IServiceProvider)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.Providers.HostHandlersProvider.GetHandlerInstance(Telegrator.Core.Descriptors.HandlerDescriptor,System.Threading.CancellationToken)">
|
||||
@@ -255,40 +176,76 @@
|
||||
The key used to store the <see cref="T:Telegrator.Core.IHandlersCollection"/> in the builder properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.HostBuilderExtensions.get_Handlers(Microsoft.Extensions.Hosting.IHostApplicationBuilder)">
|
||||
<inheritdoc cref="P:Telegrator.HostBuilderExtensions.<G>$605D8CCF64349EA050C790D67C500BD9.Handlers"/>
|
||||
<member name="M:Telegrator.HostBuilderExtensions.AddTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection,System.Action{Telegrator.Hosting.ITelegramBotHostBuilder})">
|
||||
<summary>
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.HostBuilderExtensions.AddTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.HostBuilderExtensions.<G>$605D8CCF64349EA050C790D67C500BD9.Handlers">
|
||||
<member name="M:Telegrator.HostBuilderExtensions.AddTelegrator(Microsoft.Extensions.Hosting.IHostBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Gets the <see cref="T:Telegrator.Core.IHandlersCollection"/> from the builder properties.
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.ServicesCollectionExtensions">
|
||||
<member name="M:Telegrator.HostBuilderExtensions.AddTelegrator(Microsoft.Extensions.Hosting.IHostBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection,System.Action{Telegrator.Core.IHandlersCollection})">
|
||||
<summary>
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.HostBuilderExtensions.AddTelegratorInternal(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Collections.Generic.IDictionary{System.Object,System.Object},Telegrator.Core.IHandlersCollection@,Telegrator.TelegratorOptions)">
|
||||
<summary>
|
||||
Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.HostServicesCollectionExtensions">
|
||||
<summary>
|
||||
Contains extensions for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
|
||||
Provides method to configure Telegram Bot Host
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.AddTelegramBotHostDefaults(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<member name="M:Telegrator.HostServicesCollectionExtensions.ConfigureTelegram(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegram.Bot.TelegramBotClientOptions)">
|
||||
<summary>
|
||||
Registers <see cref="T:Telegrator.Hosting.TelegramBotHost"/> default services
|
||||
Adds TelegramBotClientOptions to services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="options"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.HostServicesCollectionExtensions.ConfigureReceiver(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegram.Bot.Polling.ReceiverOptions)">
|
||||
<summary>
|
||||
Adds ReceiverOptions to services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="options"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.HostServicesCollectionExtensions.AddStateStorage``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Registers <see cref="T:Telegrator.Core.States.IStateStorage"/> service
|
||||
</summary>
|
||||
<typeparam name="TStorage"></typeparam>
|
||||
<param name="services"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.HostServicesCollectionExtensions.AddTelegramBotHostDefaults(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Registers <see cref="N:Telegrator"/> default services
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.AddTelegramReceiver(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<member name="M:Telegrator.HostServicesCollectionExtensions.AddTelegramReceiver(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Registers <see cref="T:Telegram.Bot.ITelegramBotClient"/> service with <see cref="T:Telegrator.Polling.HostedUpdateReceiver"/> to receive updates using long polling
|
||||
Registers <see cref="T:Telegram.Bot.ITelegramBotClient"/> service with <see cref="T:Telegrator.Mediation.HostedUpdateReceiver"/> to receive updates using long polling
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ServicesCollectionExtensions.TypedTelegramBotClientFactory(System.Net.Http.HttpClient,System.IServiceProvider)">
|
||||
<member name="M:Telegrator.HostServicesCollectionExtensions.TypedTelegramBotClientFactory(System.Net.Http.HttpClient,System.IServiceProvider)">
|
||||
<summary>
|
||||
<see cref="T:Telegram.Bot.ITelegramBotClient"/> factory method
|
||||
</summary>
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Telegrator.Localized</name>
|
||||
</assembly>
|
||||
<members>
|
||||
</members>
|
||||
</doc>
|
||||
+85
-19
@@ -2226,7 +2226,7 @@
|
||||
</member>
|
||||
<member name="F:Telegrator.Core.Handlers.Building.HandlerBuilderBase.HandlerCollection">
|
||||
<summary>
|
||||
<see cref="T:Telegrator.Core.IHandlersCollection"/> to ehich new builded handlers is adding
|
||||
<see cref="T:Telegrator.Core.IHandlersCollection"/> to which new builded handlers is adding
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Telegrator.Core.Handlers.Building.HandlerBuilderBase.UpdateType">
|
||||
@@ -2749,6 +2749,14 @@
|
||||
<param name="updateType">The update type key.</param>
|
||||
<returns>The handler descriptor list for the given update type.</returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Core.IHandlersCollection.TryGetDescriptorList(Telegram.Bot.Types.Enums.UpdateType,Telegrator.Core.Descriptors.HandlerDescriptorList@)">
|
||||
<summary>
|
||||
Tryes to get the <see cref="T:Telegrator.Core.Descriptors.HandlerDescriptorList"/> for the specified <see cref="T:Telegram.Bot.Types.Enums.UpdateType"/>.
|
||||
</summary>
|
||||
<param name="updateType"></param>
|
||||
<param name="list"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.Core.IHandlersCollection.AddDescriptor(Telegrator.Core.Descriptors.HandlerDescriptor)">
|
||||
<summary>
|
||||
Adds a <see cref="T:Telegrator.Core.Descriptors.HandlerDescriptor"/> to the collection and returns the updated collection.
|
||||
@@ -2774,7 +2782,7 @@
|
||||
</member>
|
||||
<member name="M:Telegrator.Core.IHandlersProvider.TryGetDescriptorList(Telegram.Bot.Types.Enums.UpdateType,Telegrator.Core.Descriptors.HandlerDescriptorList@)">
|
||||
<summary>
|
||||
|
||||
Gets the collection of <see cref="T:Telegram.Bot.Types.Enums.UpdateType"/> keys for the handler lists.
|
||||
</summary>
|
||||
<param name="updateType"></param>
|
||||
<param name="list"></param>
|
||||
@@ -4529,7 +4537,7 @@
|
||||
Gets the update that triggered this awaiter handler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.Handlers.Building.AwaiterHandler.Wait(System.Threading.CancellationToken)">
|
||||
<member name="M:Telegrator.Handlers.Building.AwaiterHandler.Await(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Waits for the specified update type to be received.
|
||||
</summary>
|
||||
@@ -5475,6 +5483,14 @@
|
||||
Gets the update router for handling incoming updates.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.ITelegratorBot.StartReceivingAsync(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Initializes the update router and begins polling for updates asynchronously.
|
||||
</summary>
|
||||
<param name="receiverOptions">Optional receiver options for configuring update polling.</param>
|
||||
<param name="cancellationToken">The cancellation token to stop receiving updates.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Telegrator.Logging.ConsoleLogger">
|
||||
<summary>
|
||||
Console logger implementation that writes to System.Console.
|
||||
@@ -6019,6 +6035,9 @@
|
||||
Manages the distribution of updates between regular handlers and awaiting handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Mediation.UpdateRouter.Options">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Mediation.UpdateRouter.HandlersProvider">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
@@ -6028,9 +6047,6 @@
|
||||
<member name="P:Telegrator.Mediation.UpdateRouter.StateStorage">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Mediation.UpdateRouter.Options">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Telegrator.Mediation.UpdateRouter.HandlersPool">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
@@ -6237,6 +6253,9 @@
|
||||
<param name="descriptor">The handler descriptor to check for command aliases.</param>
|
||||
<exception cref="T:System.Exception">Thrown when intersecting command aliases are found and ExceptIntersectingCommandAliases is enabled.</exception>
|
||||
</member>
|
||||
<member name="M:Telegrator.Providers.HandlersCollection.TryGetDescriptorList(Telegram.Bot.Types.Enums.UpdateType,Telegrator.Core.Descriptors.HandlerDescriptorList@)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Telegrator.Providers.HandlersManagerBase">
|
||||
<summary>
|
||||
Provides functionality of incrementally collecting, organizing and resolving handlers instances.
|
||||
@@ -6366,14 +6385,14 @@
|
||||
Represents handler results, allowing to communicate with router and control aspect execution
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Result.Positive">
|
||||
<member name="P:Telegrator.Result.Success">
|
||||
<summary>
|
||||
Is result positive
|
||||
Tell router to stop describing
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Result.RouteNext">
|
||||
<summary>
|
||||
Should router search for next matching handler
|
||||
Tell router to continue describing
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Telegrator.Result.NextType">
|
||||
@@ -6438,6 +6457,14 @@
|
||||
<param name="keySelector"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ColletionsExtensions.Squeeze``1(System.Collections.Generic.IEnumerable{``0})">
|
||||
<summary>
|
||||
Remove all <see langword="null"/> values and returns collection without nullable type.
|
||||
</summary>
|
||||
<typeparam name="T"></typeparam>
|
||||
<param name="source"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ColletionsExtensions.ForEach``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
|
||||
<summary>
|
||||
Enumerates objects in a <paramref name="source"/> and executes an <paramref name="action"/> on each one
|
||||
@@ -6502,7 +6529,7 @@
|
||||
<param name="predicate"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ColletionsExtensions.SingleSafe``1(System.Collections.Generic.IEnumerable{``0})">
|
||||
<member name="M:Telegrator.ColletionsExtensions.SingleOrNothing``1(System.Collections.Generic.IEnumerable{``0})">
|
||||
<summary>
|
||||
Returns the only element of a sequence, or a default value if the sequence is empty.
|
||||
This method returns default if there is more than one element in the sequence.
|
||||
@@ -6511,7 +6538,7 @@
|
||||
<param name="source"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ColletionsExtensions.SingleSafe``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Boolean})">
|
||||
<member name="M:Telegrator.ColletionsExtensions.SingleOrNothing``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Boolean})">
|
||||
<summary>
|
||||
Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists.
|
||||
This method return default if more than one element satisfies the condition.
|
||||
@@ -6547,7 +6574,7 @@
|
||||
<param name="type"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.ReflectionExtensions.IsHandlerRealization(System.Type)">
|
||||
<member name="M:Telegrator.ReflectionExtensions.IsHandlerImplementation(System.Type)">
|
||||
<summary>
|
||||
Checks if <paramref name="type"/> is an implementation of <see cref="T:Telegrator.Core.Handlers.UpdateHandlerBase"/> class or its descendants
|
||||
</summary>
|
||||
@@ -6785,13 +6812,8 @@
|
||||
<param name="httpClient">Optional HTTP client for making requests.</param>
|
||||
<param name="cancellationToken">The cancellation token.</param>
|
||||
</member>
|
||||
<member name="M:Telegrator.TelegratorClient.StartReceiving(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Starts receiving updates from Telegram.
|
||||
Initializes the update router and begins polling for updates.
|
||||
</summary>
|
||||
<param name="receiverOptions">Optional receiver options for configuring update polling.</param>
|
||||
<param name="cancellationToken">The cancellation token to stop receiving updates.</param>
|
||||
<member name="M:Telegrator.TelegratorClient.StartReceivingAsync(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Telegrator.TelegratorClient.StartReceivingInternal(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
@@ -6852,6 +6874,19 @@
|
||||
Gets or sets the global cancellation token for all bot operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Telegrator.TelegratorBotExtensions">
|
||||
<summary>
|
||||
Provides usefull helper methods for TelegratorBot
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.TelegratorBotExtensions.StartReceiving(Telegrator.ITelegratorBot,Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Initializes the update router and begins polling for updates synchronously (Blocking calling thread).
|
||||
</summary>
|
||||
<param name="bot"></param>
|
||||
<param name="receiverOptions">Optional receiver options for configuring update polling.</param>
|
||||
<param name="cancellationToken">The cancellation token to stop receiving updates.</param>
|
||||
</member>
|
||||
<member name="T:Telegrator.MessageExtensions">
|
||||
<summary>
|
||||
Provides usefull helper methods for messages
|
||||
@@ -6976,6 +7011,16 @@
|
||||
<param name="handlingUpdate">The update that triggered the awaiter creation.</param>
|
||||
<returns>An awaiter handler builder for the specified update type.</returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.AwaitingProviderExtensions.CreateDeleting``1(Telegrator.Core.IAwaitingProvider,Telegram.Bot.Types.Enums.UpdateType,Telegram.Bot.Types.Update)">
|
||||
<summary>
|
||||
Creates an awaiter handler builder for a specific update type that will delete the awaiting handler after awaiting is completed.
|
||||
</summary>
|
||||
<typeparam name="TUpdate"></typeparam>
|
||||
<param name="awaitingProvider"></param>
|
||||
<param name="updateType"></param>
|
||||
<param name="handlingUpdate"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.AwaitingProviderExtensions.AwaitAny(Telegrator.Core.IAwaitingProvider,Telegram.Bot.Types.Update)">
|
||||
<summary>
|
||||
Creates an awaiter builder for any update type.
|
||||
@@ -7000,6 +7045,14 @@
|
||||
<param name="handlingUpdate"></param>
|
||||
<returns>An awaiter builder for callback query updates.</returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.AwaitingProviderExtensions.CancellAllCallbacks(Telegrator.Core.IAwaitingProvider,Telegram.Bot.Types.Update)">
|
||||
<summary>
|
||||
Deletes all awaiting handlers for callback query updates.
|
||||
</summary>
|
||||
<param name="awaitingProvider"></param>
|
||||
<param name="handlingUpdate"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Telegrator.HandlersProviderExtensions">
|
||||
<summary>
|
||||
Extesions method for handlers providers
|
||||
@@ -7084,6 +7137,14 @@
|
||||
Provides convenient methods for creating implicit handlers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersCollectionExtensions.CollectHandlers(Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Collects all handlers from current app domain.
|
||||
Scans for handlers exported by analyzer into class `Telegrator.Analyzers.AnalyzerExport` in each assembly and registers them to the collection.
|
||||
</summary>
|
||||
<param name="handlers"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Telegrator.HandlersCollectionExtensions.CollectHandlersDomainWide(Telegrator.Core.IHandlersCollection)">
|
||||
<summary>
|
||||
Collects all public handlers from the current app domain.
|
||||
@@ -7161,6 +7222,11 @@
|
||||
Provides extension methods for working with Telegram Update objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.UpdateExtensions.GetUserLanguageCode(Telegram.Bot.Types.Update)">
|
||||
<summary>
|
||||
Extracts the IETF language tag of the user's client from the update.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Telegrator.UpdateExtensions.GetSenderId(Telegram.Bot.Types.Update)">
|
||||
<summary>
|
||||
Selects from Update an object from which you can get the sender's ID
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<TargetFramework>netstandard2.0</TargetFramework>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
<LangVersion>latest</LangVersion>
|
||||
@@ -13,9 +13,12 @@
|
||||
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||
<EnableNETAnalyzers>True</EnableNETAnalyzers>
|
||||
<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
|
||||
<IncludeSymbols>True</IncludeSymbols>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<SignAssembly>False</SignAssembly>
|
||||
|
||||
<Title>Telegrator.RedisStateStorage</Title>
|
||||
<Version>1.16.4</Version>
|
||||
<Version>1.16.6</Version>
|
||||
<Authors>Rikitav Tim4ik</Authors>
|
||||
<Company>Rikitav Tim4ik</Company>
|
||||
<RepositoryUrl>https://github.com/Rikitav/Telegrator</RepositoryUrl>
|
||||
@@ -31,7 +34,7 @@
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="StackExchange.Redis" Version="2.11.8 " />
|
||||
<PackageReference Include="StackExchange.Redis" Version="2.12.14" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
@@ -10,6 +10,8 @@ namespace Telegrator.Analyzers;
|
||||
[Generator(LanguageNames.CSharp)]
|
||||
public class DeveloperHelperAnalyzer : IIncrementalGenerator
|
||||
{
|
||||
internal record class HandlerDeclarationModel(string ClassName, string NamespaceName, string? AttributeName, string? BaseClassName, Location Location);
|
||||
|
||||
private static readonly DiagnosticDescriptor MissingBaseClassWarning = new(
|
||||
id: "TLG101",
|
||||
title: "Missing handlers base class",
|
||||
@@ -131,9 +133,8 @@ public class DeveloperHelperAnalyzer : IIncrementalGenerator
|
||||
|
||||
private static FieldDeclarationSyntax GenerateTypeField(HandlerDeclarationModel handler)
|
||||
{
|
||||
string fullTypeName = handler.Namespace == "Global"
|
||||
? handler.ClassName
|
||||
: $"{handler.Namespace}.{handler.ClassName}";
|
||||
string fullTypeName = handler.NamespaceName == "Global"
|
||||
? handler.ClassName : $"{handler.NamespaceName}.{handler.ClassName}";
|
||||
|
||||
TypeOfExpressionSyntax typeofExpression = SyntaxFactory.TypeOfExpression(SyntaxFactory.ParseTypeName(fullTypeName));
|
||||
VariableDeclaratorSyntax variableDeclarator = SyntaxFactory.VariableDeclarator(SyntaxFactory.Identifier($"{handler.ClassName}Type"))
|
||||
@@ -149,15 +150,6 @@ public class DeveloperHelperAnalyzer : IIncrementalGenerator
|
||||
}
|
||||
}
|
||||
|
||||
internal class HandlerDeclarationModel(string className, string namespaceName, string? attributeName, string? baseClassName, Location location)
|
||||
{
|
||||
public readonly string ClassName = className;
|
||||
public readonly string Namespace = namespaceName;
|
||||
public readonly string? AttributeName = attributeName;
|
||||
public readonly string? BaseClassName = baseClassName;
|
||||
public readonly Location Location = location;
|
||||
}
|
||||
|
||||
internal static class DeveloperHelperAnalyzerExtensions
|
||||
{
|
||||
private static readonly string[] HandlersNames =
|
||||
|
||||
+5
-27
@@ -8,8 +8,12 @@ using System.Text;
|
||||
namespace Telegrator.Analyzers;
|
||||
|
||||
[Generator(LanguageNames.CSharp)]
|
||||
public class GeneratedKeyboardMarkupGenerator : IIncrementalGenerator
|
||||
public class KeyboardMarkupGenerator : IIncrementalGenerator
|
||||
{
|
||||
// Records
|
||||
private record class GeneratedMarkupMethodModel(MethodDeclarationSyntax OriginalMethod, FieldDeclarationSyntax GeneratedField, MethodDeclarationSyntax GeneratedMethod);
|
||||
private record class GeneratedMarkupPropertyModel(PropertyDeclarationSyntax OriginalProperty, PropertyDeclarationSyntax GeneratedProperty);
|
||||
|
||||
// Return types
|
||||
private const string InlineReturnType = "InlineKeyboardMarkup";
|
||||
private const string ReplyReturnType = "ReplyKeyboardMarkup";
|
||||
@@ -459,30 +463,4 @@ public class GeneratedKeyboardMarkupGenerator : IIncrementalGenerator
|
||||
SyntaxFactory.IdentifierName(className),
|
||||
SyntaxFactory.IdentifierName(methodName));
|
||||
}
|
||||
|
||||
private class GeneratedMarkupMethodModel
|
||||
{
|
||||
public MethodDeclarationSyntax OriginalMethod { get; }
|
||||
public FieldDeclarationSyntax GeneratedField { get; }
|
||||
public MethodDeclarationSyntax GeneratedMethod { get; }
|
||||
|
||||
public GeneratedMarkupMethodModel(MethodDeclarationSyntax originalMethod, FieldDeclarationSyntax generatedField, MethodDeclarationSyntax generatedMethod)
|
||||
{
|
||||
OriginalMethod = originalMethod;
|
||||
GeneratedField = generatedField;
|
||||
GeneratedMethod = generatedMethod;
|
||||
}
|
||||
}
|
||||
|
||||
private class GeneratedMarkupPropertyModel
|
||||
{
|
||||
public PropertyDeclarationSyntax OriginalProperty { get; }
|
||||
public PropertyDeclarationSyntax GeneratedProperty { get; }
|
||||
|
||||
public GeneratedMarkupPropertyModel(PropertyDeclarationSyntax originalProperty, PropertyDeclarationSyntax generatedProperty)
|
||||
{
|
||||
OriginalProperty = originalProperty;
|
||||
GeneratedProperty = generatedProperty;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace Telegrator.Analyzers.RoslynExtensions;
|
||||
|
||||
public class TargteterNotFoundException() : Exception() { }
|
||||
|
||||
public class BaseClassTypeNotFoundException() : Exception() { }
|
||||
|
||||
public class AncestorNotFoundException : Exception { }
|
||||
#pragma warning disable RCS1194 // Implement exception constructors
|
||||
public class TargteterNotFoundException() : Exception();
|
||||
public class BaseClassTypeNotFoundException() : Exception();
|
||||
public class AncestorNotFoundException() : Exception();
|
||||
#pragma warning restore RCS1194 // Implement exception constructors
|
||||
|
||||
@@ -9,3 +9,6 @@ using System.Diagnostics.CodeAnalysis;
|
||||
[assembly: SuppressMessage("Style", "IDE0090")]
|
||||
[assembly: SuppressMessage("Usage", "CA2254")]
|
||||
[assembly: SuppressMessage("Maintainability", "CA1510")]
|
||||
[assembly: SuppressMessage("Style", "IDE0270")]
|
||||
[assembly: SuppressMessage("Roslynator", "RCS1037")]
|
||||
[assembly: SuppressMessage("Roslynator", "RCS1224")]
|
||||
|
||||
@@ -1,160 +0,0 @@
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Http.Features;
|
||||
using Microsoft.AspNetCore.Routing;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Telegrator.Core;
|
||||
|
||||
namespace Telegrator.Hosting.Web
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a web hosted telegram bot
|
||||
/// </summary>
|
||||
public class TelegramBotWebHost : IHost, IApplicationBuilder, IEndpointRouteBuilder, IAsyncDisposable
|
||||
{
|
||||
private readonly WebApplication _innerApp;
|
||||
private readonly IUpdateRouter _updateRouter;
|
||||
private readonly ILogger<TelegramBotWebHost> _logger;
|
||||
|
||||
private bool _disposed;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IServiceProvider Services => _innerApp.Services;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IUpdateRouter UpdateRouter => _updateRouter;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public ICollection<EndpointDataSource> DataSources => ((IEndpointRouteBuilder)_innerApp).DataSources;
|
||||
|
||||
/// <summary>
|
||||
/// Allows consumers to be notified of application lifetime events.
|
||||
/// </summary>
|
||||
public IHostApplicationLifetime Lifetime => _innerApp.Lifetime;
|
||||
|
||||
/// <summary>
|
||||
/// This application's logger
|
||||
/// </summary>
|
||||
public ILogger<TelegramBotWebHost> Logger => _logger;
|
||||
|
||||
// Private interface fields
|
||||
IServiceProvider IEndpointRouteBuilder.ServiceProvider => Services;
|
||||
IServiceProvider IApplicationBuilder.ApplicationServices { get => Services; set => throw new NotImplementedException(); }
|
||||
IFeatureCollection IApplicationBuilder.ServerFeatures => ((IApplicationBuilder)_innerApp).ServerFeatures;
|
||||
IDictionary<string, object?> IApplicationBuilder.Properties => ((IApplicationBuilder)_innerApp).Properties;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="WebApplicationBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="webApplicationBuilder">The proxied instance of host builder.</param>
|
||||
public TelegramBotWebHost(WebApplicationBuilder webApplicationBuilder)
|
||||
{
|
||||
// Building proxy application
|
||||
_innerApp = webApplicationBuilder.Build();
|
||||
|
||||
// Reruesting services for this host
|
||||
_updateRouter = Services.GetRequiredService<IUpdateRouter>();
|
||||
_logger = Services.GetRequiredService<ILogger<TelegramBotWebHost>>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new <see cref="TelegramBotHostBuilder"/> with default services and webhook update receiving scheme
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotWebHostBuilder CreateBuilder(WebApplicationOptions settings)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(settings, nameof(settings));
|
||||
WebApplicationBuilder innerApp = WebApplication.CreateBuilder(settings);
|
||||
TelegramBotWebHostBuilder builder = new TelegramBotWebHostBuilder(innerApp, settings);
|
||||
|
||||
builder.Services.AddTelegramBotHostDefaults();
|
||||
builder.Services.AddTelegramWebhook();
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new SLIM <see cref="TelegramBotHostBuilder"/> with default services and webhook update receiving scheme
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotWebHostBuilder CreateSlimBuilder(WebApplicationOptions settings)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(settings, nameof(settings));
|
||||
WebApplicationBuilder innerApp = WebApplication.CreateSlimBuilder(settings);
|
||||
TelegramBotWebHostBuilder builder = new TelegramBotWebHostBuilder(innerApp, settings);
|
||||
|
||||
builder.Services.AddTelegramBotHostDefaults();
|
||||
builder.Services.AddTelegramWebhook();
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new EMPTY <see cref="TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotWebHostBuilder CreateEmptyBuilder(WebApplicationOptions settings)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(settings, nameof(settings));
|
||||
WebApplicationBuilder innerApp = WebApplication.CreateEmptyBuilder(settings);
|
||||
return new TelegramBotWebHostBuilder(innerApp, settings);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task StartAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
await _innerApp.StartAsync(cancellationToken);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task StopAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
await _innerApp.StopAsync(cancellationToken);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IApplicationBuilder CreateApplicationBuilder()
|
||||
=> ((IEndpointRouteBuilder)_innerApp).CreateApplicationBuilder();
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate> middleware)
|
||||
=> _innerApp.Use(middleware);
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IApplicationBuilder New()
|
||||
=> ((IApplicationBuilder)_innerApp).New();
|
||||
|
||||
/// <inheritdoc/>
|
||||
public RequestDelegate Build()
|
||||
=> ((IApplicationBuilder)_innerApp).Build();
|
||||
|
||||
/// <summary>
|
||||
/// Disposes the host.
|
||||
/// </summary>
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
if (_disposed)
|
||||
return;
|
||||
|
||||
await _innerApp.DisposeAsync();
|
||||
|
||||
GC.SuppressFinalize(this);
|
||||
_disposed = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Disposes the host.
|
||||
/// </summary>
|
||||
public void Dispose()
|
||||
{
|
||||
if (_disposed)
|
||||
return;
|
||||
|
||||
ValueTask disposeTask = _innerApp.DisposeAsync();
|
||||
disposeTask.AsTask().Wait();
|
||||
|
||||
GC.SuppressFinalize(this);
|
||||
_disposed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,115 +0,0 @@
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Diagnostics.Metrics;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Telegrator.Core;
|
||||
|
||||
#pragma warning disable IDE0001
|
||||
namespace Telegrator.Hosting.Web
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a web hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
|
||||
/// </summary>
|
||||
public class TelegramBotWebHostBuilder : IHostApplicationBuilder, ICollectingProvider
|
||||
{
|
||||
private readonly WebApplicationBuilder _innerBuilder;
|
||||
private readonly WebApplicationOptions _settings;
|
||||
internal IHandlersCollection _handlers = null!;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IHandlersCollection Handlers => _handlers;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IConfigurationManager Configuration => _innerBuilder.Configuration;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public ILoggingBuilder Logging => _innerBuilder.Logging;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IServiceCollection Services => _innerBuilder.Services;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IHostEnvironment Environment => _innerBuilder.Environment;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IDictionary<object, object> Properties => ((IHostApplicationBuilder)_innerBuilder).Properties;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IMetricsBuilder Metrics => _innerBuilder.Metrics;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotWebHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="webApplicationBuilder"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotWebHostBuilder(WebApplicationBuilder webApplicationBuilder, WebApplicationOptions? settings = null)
|
||||
{
|
||||
_innerBuilder = webApplicationBuilder ?? throw new ArgumentNullException(nameof(webApplicationBuilder));
|
||||
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
|
||||
|
||||
this.AddTelegratorWeb();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotWebHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="webApplicationBuilder"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotWebHostBuilder(WebApplicationBuilder webApplicationBuilder, TelegratorOptions? options, WebApplicationOptions? settings)
|
||||
{
|
||||
_innerBuilder = webApplicationBuilder ?? throw new ArgumentNullException(nameof(webApplicationBuilder));
|
||||
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
|
||||
|
||||
this.AddTelegratorWeb(options, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotWebHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="webApplicationBuilder"></param>
|
||||
/// <param name="handlers"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotWebHostBuilder(WebApplicationBuilder webApplicationBuilder, IHandlersCollection handlers, WebApplicationOptions settings)
|
||||
{
|
||||
_innerBuilder = webApplicationBuilder ?? throw new ArgumentNullException(nameof(webApplicationBuilder));
|
||||
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
|
||||
|
||||
this.AddTelegratorWeb(null, handlers);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotWebHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="webApplicationBuilder"></param>
|
||||
/// <param name="handlers"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotWebHostBuilder(WebApplicationBuilder webApplicationBuilder, IHandlersCollection handlers, TelegratorOptions? options, WebApplicationOptions settings)
|
||||
{
|
||||
_innerBuilder = webApplicationBuilder ?? throw new ArgumentNullException(nameof(webApplicationBuilder));
|
||||
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
|
||||
|
||||
this.AddTelegratorWeb(options, handlers);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Builds the host.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public TelegramBotWebHost Build()
|
||||
{
|
||||
TelegramBotWebHost host = new TelegramBotWebHost(_innerBuilder);
|
||||
host.UseTelegrator();
|
||||
return host;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void ConfigureContainer<TContainerBuilder>(IServiceProviderFactory<TContainerBuilder> factory, Action<TContainerBuilder>? configure = null) where TContainerBuilder : notnull
|
||||
{
|
||||
((IHostApplicationBuilder)_innerBuilder).ConfigureContainer(factory, configure);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace Telegrator.Hosting.Web
|
||||
{
|
||||
/// <summary>
|
||||
/// Configuration options for Telegram bot behavior and execution settings.
|
||||
/// Controls various aspects of bot operation including concurrency, routing, webhook receiving, and execution policies.
|
||||
/// </summary>
|
||||
public class WebhookerOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets HTTPS URL to send updates to. Use an empty string to remove webhook integration
|
||||
/// </summary>
|
||||
[StringSyntax(StringSyntaxAttribute.Uri)]
|
||||
public string WebhookUri { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
|
||||
/// Only characters A-Z, a-z, 0-9, _ and - are allowed.
|
||||
/// The header is useful to ensure that the request comes from a webhook set by you.
|
||||
/// </summary>
|
||||
public string? SecretToken { get; set; } = null;
|
||||
|
||||
/// <summary>
|
||||
/// The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40.
|
||||
/// Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
|
||||
/// </summary>
|
||||
public int MaxConnections { get; set; } = 40;
|
||||
|
||||
/// <summary>
|
||||
/// Pass true to drop all pending updates
|
||||
/// </summary>
|
||||
public bool DropPendingUpdates { get; set; } = false;
|
||||
}
|
||||
}
|
||||
@@ -8,18 +8,16 @@ using System.Text.Json;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Hosting.Web;
|
||||
|
||||
namespace Telegrator.Mediation
|
||||
namespace Telegrator.Mediation;
|
||||
|
||||
/// <summary>
|
||||
/// Service for receiving updates for Hosted telegram bots via Webhooks and queuing them to router
|
||||
/// </summary>
|
||||
public class HostedUpdateWebhooker : IHostedService
|
||||
{
|
||||
/// <summary>
|
||||
/// Service for receiving updates for Hosted telegram bots via Webhooks
|
||||
/// </summary>
|
||||
public class HostedUpdateWebhooker : IHostedService
|
||||
{
|
||||
private const string SecretTokenHeader = "X-Telegram-Bot-Api-Secret-Token";
|
||||
|
||||
private readonly IEndpointRouteBuilder _botHost;
|
||||
private readonly ITelegramBotClient _botClient;
|
||||
private readonly IUpdateRouter _updateRouter;
|
||||
private readonly WebhookerOptions _options;
|
||||
@@ -27,17 +25,15 @@ namespace Telegrator.Mediation
|
||||
/// <summary>
|
||||
/// Initiallizes new instance of <see cref="HostedUpdateWebhooker"/>
|
||||
/// </summary>
|
||||
/// <param name="botHost"></param>
|
||||
/// <param name="botClient"></param>
|
||||
/// <param name="updateRouter"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <exception cref="ArgumentNullException"></exception>
|
||||
public HostedUpdateWebhooker(IEndpointRouteBuilder botHost, ITelegramBotClient botClient, IUpdateRouter updateRouter, IOptions<WebhookerOptions> options)
|
||||
public HostedUpdateWebhooker(ITelegramBotClient botClient, IUpdateRouter updateRouter, IOptions<WebhookerOptions> options)
|
||||
{
|
||||
if (string.IsNullOrEmpty(options.Value.WebhookUri))
|
||||
throw new ArgumentNullException(nameof(options), "Option \"WebhookUrl\" must be set to subscribe for update recieving");
|
||||
|
||||
_botHost = botHost;
|
||||
_botClient = botClient;
|
||||
_updateRouter = updateRouter;
|
||||
_options = options.Value;
|
||||
@@ -50,11 +46,48 @@ namespace Telegrator.Mediation
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
private async void StartInternal(CancellationToken cancellationToken)
|
||||
/// <inheritdoc/>
|
||||
public Task StopAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
_botClient.DeleteWebhook(_options.DropPendingUpdates, cancellationToken);
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Allows to remap receiving webhook endpoint and map new route to webhost.
|
||||
/// </summary>
|
||||
/// <param name="routeBuilder"></param>
|
||||
/// <param name="webhookUri"></param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
/// <exception cref="ArgumentException"></exception>
|
||||
public async Task RemapWebhook(IEndpointRouteBuilder routeBuilder, string webhookUri, CancellationToken cancellationToken = default)
|
||||
{
|
||||
if (!Uri.TryCreate(webhookUri, UriKind.Absolute, out Uri? result))
|
||||
throw new ArgumentException("invalid URL");
|
||||
|
||||
_options.WebhookUri = result.ToString();
|
||||
await SetWebhook(cancellationToken);
|
||||
MapWebhook(routeBuilder);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Maps bot webhook to application builder
|
||||
/// </summary>
|
||||
/// <param name="routeBuilder"></param>
|
||||
internal void MapWebhook(IEndpointRouteBuilder routeBuilder)
|
||||
{
|
||||
string pattern = new UriBuilder(_options.WebhookUri).Path;
|
||||
_botHost.MapPost(pattern, (Delegate)ReceiveUpdate);
|
||||
routeBuilder.MapPost(pattern, (Delegate)ReceiveUpdate);
|
||||
}
|
||||
|
||||
private async void StartInternal(CancellationToken cancellationToken)
|
||||
{
|
||||
await SetWebhook(cancellationToken);
|
||||
}
|
||||
|
||||
private async Task SetWebhook(CancellationToken cancellationToken)
|
||||
{
|
||||
await _botClient.SetWebhook(
|
||||
url: _options.WebhookUri,
|
||||
maxConnections: _options.MaxConnections,
|
||||
@@ -64,13 +97,6 @@ namespace Telegrator.Mediation
|
||||
cancellationToken: cancellationToken);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public Task StopAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
_botClient.DeleteWebhook(_options.DropPendingUpdates, cancellationToken);
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
private async Task<IResult> ReceiveUpdate(HttpContext ctx)
|
||||
{
|
||||
if (_options.SecretToken != null)
|
||||
@@ -93,5 +119,4 @@ namespace Telegrator.Mediation
|
||||
await _updateRouter.HandleUpdateAsync(_botClient, update, ctx.RequestAborted);
|
||||
return Results.Ok();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,82 +0,0 @@
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Telegrator.Hosting;
|
||||
using Telegrator.Hosting.Web;
|
||||
|
||||
namespace Telegrator;
|
||||
|
||||
internal class Program
|
||||
{
|
||||
public static void TelegramBotWebHostBuilder_Example(string[] args)
|
||||
{
|
||||
TelegramBotWebHostBuilder builder = TelegramBotWebHost.CreateBuilder(new WebApplicationOptions()
|
||||
{
|
||||
Args = args,
|
||||
ApplicationName = "TelegramBotWebHost example",
|
||||
});
|
||||
|
||||
builder.Handlers.CollectHandlersAssemblyWide();
|
||||
|
||||
builder.Build()
|
||||
.AddLoggingAdapter()
|
||||
.SetBotCommands()
|
||||
.Run();
|
||||
}
|
||||
|
||||
public static void WebApplicationBuilder_Example(string[] args)
|
||||
{
|
||||
WebApplicationBuilder builder = WebApplication.CreateBuilder(new WebApplicationOptions()
|
||||
{
|
||||
Args = args,
|
||||
ApplicationName = "WebApplication example",
|
||||
});
|
||||
|
||||
builder.AddTelegratorWeb();
|
||||
builder.Handlers.CollectHandlersAssemblyWide();
|
||||
|
||||
builder.Build()
|
||||
.UseTelegratorWeb()
|
||||
.AddLoggingAdapter()
|
||||
.SetBotCommands()
|
||||
.Run();
|
||||
}
|
||||
|
||||
public static void TelegramBotHostBuilder_Example(string[] args)
|
||||
{
|
||||
ConfigurationManager configuration = new ConfigurationManager();
|
||||
configuration.AddJsonFile("appsettings.json");
|
||||
|
||||
TelegramBotHostBuilder builder = TelegramBotHost.CreateBuilder(new HostApplicationBuilderSettings()
|
||||
{
|
||||
Args = args,
|
||||
ApplicationName = "TelegramBotHost example",
|
||||
Configuration = configuration
|
||||
});
|
||||
|
||||
builder.Handlers.CollectHandlersAssemblyWide();
|
||||
|
||||
builder.Build()
|
||||
.AddLoggingAdapter()
|
||||
.SetBotCommands()
|
||||
.Run();
|
||||
}
|
||||
|
||||
public static void HostApplicationBuilder_Example(string[] args)
|
||||
{
|
||||
HostApplicationBuilder builder = Host.CreateApplicationBuilder(new HostApplicationBuilderSettings()
|
||||
{
|
||||
Args = args,
|
||||
ApplicationName = "Host example",
|
||||
});
|
||||
|
||||
builder.AddTelegrator();
|
||||
builder.Handlers.CollectHandlersAssemblyWide();
|
||||
|
||||
builder.Build()
|
||||
.UseTelegrator()
|
||||
.AddLoggingAdapter()
|
||||
.SetBotCommands()
|
||||
.Run();
|
||||
}
|
||||
}
|
||||
@@ -13,9 +13,12 @@
|
||||
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||
<EnableNETAnalyzers>True</EnableNETAnalyzers>
|
||||
<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
|
||||
<IncludeSymbols>True</IncludeSymbols>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<SignAssembly>False</SignAssembly>
|
||||
|
||||
<Title>Telegrator.Hosting.Web</Title>
|
||||
<Version>1.16.4</Version>
|
||||
<Version>1.17.1</Version>
|
||||
<Authors>Rikitav Tim4ik</Authors>
|
||||
<Company>Rikitav Tim4ik</Company>
|
||||
<RepositoryUrl>https://github.com/Rikitav/Telegrator</RepositoryUrl>
|
||||
@@ -40,4 +43,5 @@
|
||||
<None Include="..\..\LICENSE" Pack="True" PackagePath="\" />
|
||||
<None Include="..\..\resources\telegrator_nuget.png" Pack="True" PackagePath="\" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
|
||||
@@ -1,57 +1,56 @@
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.AspNetCore.Routing;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.DependencyInjection.Extensions;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using Telegram.Bot;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Hosting;
|
||||
using Telegrator.Hosting.Web;
|
||||
using Telegrator.Mediation;
|
||||
using Telegrator.Providers;
|
||||
|
||||
namespace Telegrator
|
||||
namespace Telegrator;
|
||||
|
||||
/// <summary>
|
||||
/// Provides extension methods for <see cref="IHostApplicationBuilder"/> to configure Telegrator.
|
||||
/// </summary>
|
||||
public static class WebHostBuilderExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Contains extensions for <see cref="IServiceCollection"/>
|
||||
/// Provides method to configure Telegram Bot WebHost
|
||||
/// </summary>
|
||||
public static class ServicesCollectionExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// The key used to store the <see cref="IHandlersCollection"/> in the builder properties.
|
||||
/// </summary>
|
||||
public const string HandlersCollectionPropertyKey = nameof(IHandlersCollection);
|
||||
|
||||
extension(WebApplicationBuilder builder)
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the <see cref="IHandlersCollection"/> from the builder properties.
|
||||
/// </summary>
|
||||
public IHandlersCollection Handlers
|
||||
{
|
||||
get
|
||||
{
|
||||
return (IHandlersCollection)builder.Host.Properties[HandlersCollectionPropertyKey];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostApplicationBuilder AddTelegratorWeb(this IHostApplicationBuilder builder, TelegratorOptions? options = null, IHandlersCollection? handlers = null)
|
||||
{
|
||||
IServiceCollection services = builder.Services;
|
||||
IConfigurationManager configuration = builder.Configuration;
|
||||
AddTelegratorWebInternal(builder.Services, builder.Configuration, builder.Properties, ref handlers, options);
|
||||
return builder;
|
||||
}
|
||||
|
||||
if (options == null)
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostApplicationBuilder AddTelegratorWeb(this IHostApplicationBuilder builder, TelegratorOptions? options = null, IHandlersCollection? handlers = null, Action<ITelegramBotHostBuilder>? action = null)
|
||||
{
|
||||
AddTelegratorWebInternal(builder.Services, builder.Configuration, builder.Properties, ref handlers, options);
|
||||
action?.Invoke(new TelegramBotHostBuilder(builder, handlers));
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
internal static void AddTelegratorWebInternal(IServiceCollection services, IConfiguration configuration, IDictionary<object, object> properties, [NotNull] ref IHandlersCollection? handlers, TelegratorOptions? options = null)
|
||||
{
|
||||
if (services.Any(srvc => srvc.ServiceType == typeof(HostedUpdateReceiver)))
|
||||
throw new InvalidOperationException("`HostedUpdateReceiver` found in services. WebHost extension is not compatible with long-polling receiving. Please, remove `AddTelegrator` invocation from your WebApp configuration.");
|
||||
|
||||
if (options is null)
|
||||
{
|
||||
options = configuration.GetSection(nameof(TelegratorOptions)).Get<TelegratorOptions>();
|
||||
if (options == null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'TelegratorOptions' wasn't registered. This configuration is runtime required!");
|
||||
if (options is null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'TelegratorOptions' was registered. This configuration is runtime required!");
|
||||
}
|
||||
|
||||
CancellationTokenSource globallCancell = new CancellationTokenSource();
|
||||
@@ -59,28 +58,22 @@ namespace Telegrator
|
||||
services.AddSingleton(Options.Create(options));
|
||||
services.AddKeyedSingleton("cancell", globallCancell);
|
||||
|
||||
if (handlers != null)
|
||||
{
|
||||
if (handlers is IHandlersManager manager)
|
||||
if (handlers is not null && handlers is IHandlersManager manager)
|
||||
{
|
||||
ServiceDescriptor descriptor = new ServiceDescriptor(typeof(IHandlersProvider), manager);
|
||||
services.Replace(descriptor);
|
||||
services.AddSingleton(manager);
|
||||
}
|
||||
}
|
||||
|
||||
handlers ??= new HostHandlersCollection(services, options);
|
||||
services.AddSingleton(handlers);
|
||||
properties.Add(HostBuilderExtensions.HandlersCollectionPropertyKey, handlers);
|
||||
|
||||
builder.Properties.Add(HandlersCollectionPropertyKey, handlers);
|
||||
if (builder is TelegramBotWebHostBuilder botHostBuilder)
|
||||
botHostBuilder._handlers = handlers;
|
||||
|
||||
if (!services.Any(srvc => srvc.ImplementationType == typeof(IOptions<WebhookerOptions>)))
|
||||
if (!services.Any(srvc => srvc.ServiceType == typeof(IOptions<WebhookerOptions>)))
|
||||
{
|
||||
WebhookerOptions? webhookerOptions = configuration.GetSection(nameof(WebhookerOptions)).Get<WebhookerOptions>();
|
||||
if (webhookerOptions == null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'WebhookerOptions' wasn't registered. This configuration is runtime required!");
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'WebhookerOptions' was registered. This configuration is runtime required!");
|
||||
|
||||
services.AddSingleton(Options.Create(webhookerOptions));
|
||||
}
|
||||
@@ -96,27 +89,89 @@ namespace Telegrator
|
||||
|
||||
services.AddTelegramBotHostDefaults();
|
||||
services.AddTelegramWebhook();
|
||||
return builder;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Contains extensions for <see cref="IServiceCollection"/>
|
||||
/// Provides method to configure Telegram Bot WebHost
|
||||
/// </summary>
|
||||
public static class WebServicesCollectionExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Adds WebhookerOptions to services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection ConfigureWebhooker(this IServiceCollection services, WebhookerOptions options)
|
||||
{
|
||||
services.RemoveAll<IOptions<WebhookerOptions>>();
|
||||
services.AddSingleton(Options.Create(options));
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Searchs for <see cref="HostedUpdateWebhooker"/> hosted service inside hosts services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="webhooker"></param>
|
||||
/// <returns></returns>
|
||||
public static bool TryFindWebhooker(this IServiceProvider services, [NotNullWhen(true)] out HostedUpdateWebhooker? webhooker)
|
||||
{
|
||||
webhooker = services.GetServices<IHostedService>().FirstOrDefault(s => s is HostedUpdateWebhooker) as HostedUpdateWebhooker;
|
||||
return webhooker != null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Provides useful methods to adjust Telegram bot Host
|
||||
/// </summary>
|
||||
public static class WebTelegramBotHostExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Replaces the initialization logic from TelegramBotWebHost constructor.
|
||||
/// Initializes the bot and logs handlers on application startup.
|
||||
/// </summary>
|
||||
public static WebApplication UseTelegratorWeb(this WebApplication app)
|
||||
public static T UseTelegratorWeb<T>(this T botHost, bool dontMap = false) where T : IEndpointRouteBuilder, IHost
|
||||
{
|
||||
ITelegramBotInfo info = app.Services.GetRequiredService<ITelegramBotInfo>();
|
||||
IHandlersCollection handlers = app.Services.GetRequiredService<IHandlersCollection>();
|
||||
ILoggerFactory loggerFactory = app.Services.GetRequiredService<ILoggerFactory>();
|
||||
if (!botHost.ServiceProvider.TryFindWebhooker(out HostedUpdateWebhooker? webhooker))
|
||||
throw new InvalidOperationException("No service for type 'Telegrator.Mediation.HostedUpdateWebhooker' has been registered.");
|
||||
|
||||
ITelegramBotInfo info = botHost.ServiceProvider.GetRequiredService<ITelegramBotInfo>();
|
||||
IHandlersCollection handlers = botHost.ServiceProvider.GetRequiredService<IHandlersCollection>();
|
||||
ILoggerFactory loggerFactory = botHost.ServiceProvider.GetRequiredService<ILoggerFactory>();
|
||||
ILogger logger = loggerFactory.CreateLogger("Telegrator.Hosting.Web.TelegratorHost");
|
||||
|
||||
if (logger.IsEnabled(LogLevel.Information))
|
||||
{
|
||||
logger.LogInformation("Telegrator Bot ASP.NET WebHost started");
|
||||
logger.LogInformation("Telegrator Bot Host started (ASP.NET WebHost)");
|
||||
logger.LogInformation("Receiving mode : WEB-HOOKING");
|
||||
logger.LogInformation("Telegram Bot : {firstname}, @{usrname}, id:{id},", info.User.FirstName ?? "[NULL]", info.User.Username ?? "[NULL]", info.User.Id);
|
||||
logger.LogHandlers(handlers);
|
||||
}
|
||||
|
||||
if (!dontMap)
|
||||
webhooker.MapWebhook(botHost);
|
||||
|
||||
botHost.AddLoggingAdapter();
|
||||
botHost.SetBotCommands();
|
||||
return botHost;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Allows to remap receiving webhook endpoint and map new route to webhost.
|
||||
/// </summary>
|
||||
/// <param name="app"></param>
|
||||
/// <param name="webhookUri"></param>
|
||||
/// <returns></returns>
|
||||
/// <exception cref="ArgumentException"></exception>
|
||||
public static T RemapWebhook<T>(this T app, string webhookUri) where T : IEndpointRouteBuilder, IHost
|
||||
{
|
||||
if (!app.ServiceProvider.TryFindWebhooker(out HostedUpdateWebhooker? webhooker))
|
||||
throw new InvalidOperationException("No service for type 'Telegrator.Mediation.HostedUpdateWebhooker' has been registered.");
|
||||
|
||||
webhooker.RemapWebhook(app, webhookUri, default).GetAwaiter().GetResult();
|
||||
return app;
|
||||
}
|
||||
|
||||
@@ -127,6 +182,9 @@ namespace Telegrator
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddTelegramWebhook(this IServiceCollection services)
|
||||
{
|
||||
services.RemoveAll<IOptions<HostedUpdateWebhooker>>();
|
||||
services.RemoveAll<ITelegramBotClient>();
|
||||
|
||||
services.AddHttpClient<ITelegramBotClient>("tgwebhook").RemoveAllLoggers().AddTypedClient(TypedTelegramBotClientFactory);
|
||||
services.AddHostedService<HostedUpdateWebhooker>();
|
||||
return services;
|
||||
@@ -134,5 +192,4 @@ namespace Telegrator
|
||||
|
||||
private static ITelegramBotClient TypedTelegramBotClientFactory(HttpClient httpClient, IServiceProvider provider)
|
||||
=> new TelegramBotClient(provider.GetRequiredService<IOptions<TelegramBotClientOptions>>().Value, httpClient);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace Telegrator;
|
||||
|
||||
/// <summary>
|
||||
/// Configuration options for Telegram bot behavior and execution settings.
|
||||
/// Controls various aspects of bot operation including concurrency, routing, webhook receiving, and execution policies.
|
||||
/// </summary>
|
||||
public class WebhookerOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets HTTPS URL to send updates to. Use an empty string to remove webhook integration
|
||||
/// </summary>
|
||||
[StringSyntax(StringSyntaxAttribute.Uri)]
|
||||
public string WebhookUri { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
|
||||
/// Only characters A-Z, a-z, 0-9, _ and - are allowed.
|
||||
/// The header is useful to ensure that the request comes from a webhook set by you.
|
||||
/// </summary>
|
||||
public string? SecretToken { get; set; } = null;
|
||||
|
||||
/// <summary>
|
||||
/// The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40.
|
||||
/// Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
|
||||
/// </summary>
|
||||
public int MaxConnections { get; set; } = 40;
|
||||
|
||||
/// <summary>
|
||||
/// Pass true to drop all pending updates
|
||||
/// </summary>
|
||||
public bool DropPendingUpdates { get; set; } = false;
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
// This file is used by Code Analysis to maintain SuppressMessage
|
||||
// attributes that are applied to this project.
|
||||
// Project-level suppressions either have no target or are given
|
||||
// a specific target and scoped to a namespace, type, member, etc.
|
||||
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
[assembly: SuppressMessage("Roslynator", "RCS1037")]
|
||||
[assembly: SuppressMessage("Style", "IDE0090")]
|
||||
[assembly: SuppressMessage("Style", "IDE0270")]
|
||||
@@ -0,0 +1,39 @@
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegrator.Core;
|
||||
|
||||
namespace Telegrator.Mediation;
|
||||
|
||||
/// <summary>
|
||||
/// Service for receiving updates for Hosted wide telegram bots and queuing them to router
|
||||
/// </summary>
|
||||
/// <param name="logger"></param>
|
||||
/// <param name="botClient"></param>
|
||||
/// <param name="updateRouter"></param>
|
||||
/// <param name="options"></param>
|
||||
public class HostedWideBotUpdateReceiver(ILogger<HostedWideBotUpdateReceiver> logger, ITelegramBotClient botClient, IUpdateRouter updateRouter, IOptions<WideBotOptions>? options) : BackgroundService
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
if (botClient is not WTelegramBotClient wideBotClient)
|
||||
throw new Exception("Registered ITelegramBotClient was not a wide client (WTelegramBotClient)! Please, use `AddWideTelegrator` instead.");
|
||||
|
||||
if (options?.Value.DropPendingUpdates is true)
|
||||
await wideBotClient.DropPendingUpdates();
|
||||
|
||||
logger.LogInformation("Starting receiving updates via MTProto");
|
||||
|
||||
// UIP (understanding in progress)
|
||||
//_receiverOptions.AllowedUpdates = updateRouter.HandlersProvider.AllowedTypes.ToArray();
|
||||
|
||||
botClient.DeleteWebhook(options?.Value.DropPendingUpdates ?? false, cancellationToken: stoppingToken)
|
||||
.ConfigureAwait(false).GetAwaiter().GetResult();
|
||||
|
||||
WideUpdateReceiver updateReceiver = new WideUpdateReceiver(wideBotClient);
|
||||
await updateReceiver.ReceiveAsync(updateRouter, stoppingToken).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
using System;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegrator.Core;
|
||||
using WUpdate = WTelegram.Types.Update;
|
||||
|
||||
namespace Telegrator.Mediation;
|
||||
|
||||
/// <summary>
|
||||
/// Reactive implementation of <see cref="IUpdateReceiver"/> for polling updates from Telegram.
|
||||
/// Provides custom update receiving logic with error handling and configuration options.
|
||||
/// </summary>
|
||||
/// <param name="client">The Telegram bot client for making API requests.</param>
|
||||
// <param name="options">Optional receiver options for configuring update polling behavior.</param>
|
||||
public class WideUpdateReceiver(WTelegramBotClient client) : IUpdateReceiver
|
||||
{
|
||||
private readonly WTelegramBotClient _client = client;
|
||||
private IUpdateHandler? _updateHandler = null;
|
||||
private CancellationToken _cancellation = default;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task ReceiveAsync(IUpdateHandler updateHandler, CancellationToken cancellationToken = default)
|
||||
{
|
||||
_updateHandler = updateHandler;
|
||||
_cancellation = cancellationToken;
|
||||
|
||||
TaskCompletionSource<object> tcs = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
||||
await using CancellationTokenRegistration registration = cancellationToken.Register(() => tcs.TrySetResult(null!));
|
||||
|
||||
try
|
||||
{
|
||||
_client.OnUpdate += OnUpdate;
|
||||
await tcs.Task.ConfigureAwait(false);
|
||||
}
|
||||
finally
|
||||
{
|
||||
_client.OnUpdate -= OnUpdate;
|
||||
}
|
||||
}
|
||||
|
||||
private async Task OnUpdate(WUpdate update)
|
||||
{
|
||||
if (_updateHandler == null)
|
||||
throw new Exception("Router not initialized (got null)");
|
||||
|
||||
try
|
||||
{
|
||||
await _updateHandler.HandleUpdateAsync(_client, update, _cancellation).ConfigureAwait(false);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
await _updateHandler.HandleErrorAsync(_client, ex, HandleErrorSource.HandleUpdateError, _cancellation).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net10.0</TargetFramework>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
<LangVersion>latest</LangVersion>
|
||||
<RootNamespace>Telegrator</RootNamespace>
|
||||
<BaseOutputPath>..\..\bin</BaseOutputPath>
|
||||
<DocumentationFile>..\..\docs\$(AssemblyName).xml</DocumentationFile>
|
||||
|
||||
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
|
||||
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||
<EnableNETAnalyzers>True</EnableNETAnalyzers>
|
||||
<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
|
||||
<IncludeSymbols>True</IncludeSymbols>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<SignAssembly>False</SignAssembly>
|
||||
|
||||
<Title>Telegrator.Hosting.WideBot</Title>
|
||||
<Version>1.17.1</Version>
|
||||
<Authors>Rikitav Tim4ik</Authors>
|
||||
<Company>Rikitav Tim4ik</Company>
|
||||
<RepositoryUrl>https://github.com/Rikitav/Telegrator</RepositoryUrl>
|
||||
<PackageTags>telegram;bot;mediator;attributes;aspect;hosting;host;framework;easy;simple;handlers;wtelegrambot;userbot</PackageTags>
|
||||
|
||||
<PackageIcon>telegrator_nuget.png</PackageIcon>
|
||||
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||
<PackageLicenseFile>LICENSE</PackageLicenseFile>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="WTelegramBot" Version="9.5.1" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\src\Telegrator.Hosting\Telegrator.Hosting.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include=".\README.md" Pack="True" PackagePath="\" />
|
||||
<None Include="..\..\LICENSE" Pack="True" PackagePath="\" />
|
||||
<None Include="..\..\resources\telegrator_nuget.png" Pack="True" PackagePath="\" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,107 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using System;
|
||||
using System.Net.Http;
|
||||
using System.Threading;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Logging;
|
||||
using Telegrator.Mediation;
|
||||
using Telegrator.Providers;
|
||||
using Telegrator.States;
|
||||
|
||||
namespace Telegrator;
|
||||
|
||||
/// <summary>
|
||||
/// Client class for the Telegrator library with Wider functionality, provided by WTelegramBotClient.
|
||||
/// Extends TelegramBotClient with reactive capabilities for handling updates.
|
||||
/// </summary>
|
||||
public class TelegratorWClient : WTelegramBotClient, ITelegratorBot, ICollectingProvider
|
||||
{
|
||||
private IUpdateRouter? _updateRouter = null;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public TelegratorOptions Options { get; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IHandlersCollection Handlers { get; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public ITelegramBotInfo BotInfo { get; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IUpdateRouter UpdateRouter => _updateRouter ?? throw new InvalidOperationException("Router's not created yet. Invoke `StartReceiving` to initialize this property.");
|
||||
|
||||
/// <summary>
|
||||
/// Initializes new instance of <see cref="TelegratorWClient"/>
|
||||
/// </summary>
|
||||
/// <param name="wOptions"></param>
|
||||
/// <param name="telegratorOptions"></param>
|
||||
/// <param name="httpClient"></param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
public TelegratorWClient(WTelegramBotClientOptions wOptions, TelegratorOptions? telegratorOptions = null, HttpClient? httpClient = null, CancellationToken cancellationToken = default)
|
||||
: base(wOptions, httpClient, cancellationToken)
|
||||
{
|
||||
Options = telegratorOptions ?? new TelegratorOptions();
|
||||
Handlers = new HandlersCollection(default);
|
||||
BotInfo = new TelegramBotInfo(GetMe(cancellationToken).Result);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void StartReceiving(ReceiverOptions? _, CancellationToken cancellationToken = default)
|
||||
{
|
||||
if (Options.GlobalCancellationToken == CancellationToken.None)
|
||||
Options.GlobalCancellationToken = cancellationToken;
|
||||
|
||||
HandlersProvider handlerProvider = new HandlersProvider(Handlers, Options);
|
||||
AwaitingProvider awaitingProvider = new AwaitingProvider(Options);
|
||||
DefaultStateStorage stateStorage = new DefaultStateStorage();
|
||||
|
||||
_updateRouter = new UpdateRouter(handlerProvider, awaitingProvider, stateStorage, Options, BotInfo);
|
||||
TelegratorLogging.LogInformation($"TelegratorW bot starting up - BotId: {BotInfo.User.Id}, Username: {BotInfo.User.Username}");
|
||||
|
||||
StartReceivingInternal(Options.GlobalCancellationToken)
|
||||
.ConfigureAwait(false).GetAwaiter().GetResult();
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task StartReceivingAsync(ReceiverOptions? receiverOptions = null,CancellationToken cancellationToken = default)
|
||||
{
|
||||
if (Options.GlobalCancellationToken == CancellationToken.None)
|
||||
Options.GlobalCancellationToken = cancellationToken;
|
||||
|
||||
HandlersProvider handlerProvider = new HandlersProvider(Handlers, Options);
|
||||
AwaitingProvider awaitingProvider = new AwaitingProvider(Options);
|
||||
DefaultStateStorage stateStorage = new DefaultStateStorage();
|
||||
|
||||
_updateRouter = new UpdateRouter(handlerProvider, awaitingProvider, stateStorage, Options, BotInfo);
|
||||
TelegratorLogging.LogInformation($"TelegratorW bot starting up - BotId: {BotInfo.User.Id}, Username: {BotInfo.User.Username}");
|
||||
|
||||
await StartReceivingInternal(Options.GlobalCancellationToken);
|
||||
}
|
||||
|
||||
private async Task StartReceivingInternal(CancellationToken cancellationToken)
|
||||
{
|
||||
try
|
||||
{
|
||||
try
|
||||
{
|
||||
await new HostedWideBotUpdateReceiver(NullLoggerFactory.Instance.CreateLogger<HostedWideBotUpdateReceiver>(), this, UpdateRouter, null)
|
||||
.StartAsync(cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
await UpdateRouter
|
||||
.HandleErrorAsync(this, exception, HandleErrorSource.FatalError, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
// Cancelled
|
||||
TelegratorLogging.LogInformation("Telegrator bot stopped (cancelled)");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,298 @@
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.DependencyInjection.Extensions;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Core.Handlers;
|
||||
using Telegrator.Hosting;
|
||||
using Telegrator.Mediation;
|
||||
using Telegrator.Providers;
|
||||
|
||||
using WUpdate = WTelegram.Types.Update;
|
||||
using TLUpdate = TL.Update;
|
||||
using System.Data.Common;
|
||||
|
||||
namespace Telegrator;
|
||||
|
||||
/// <summary>
|
||||
/// Provides extensions memebrs for <see cref="UpdateHandlerBase"/> for easy access to Wider bot functions and update
|
||||
/// </summary>
|
||||
public static class HandlersExtensions
|
||||
{
|
||||
extension<TUpdate>(AbstractUpdateHandler<TUpdate> handler) where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Casts Update to <see cref="WTelegramBotClient"/>
|
||||
/// </summary>
|
||||
public WTelegramBotClient WClient
|
||||
{
|
||||
get
|
||||
{
|
||||
object? client = handler.GetType().GetField("Client")?.GetValue(handler);
|
||||
if (client is not WTelegramBotClient wideClient)
|
||||
throw new InvalidCastException("Client is not assignable to `WTelegram.Bot.WTelegramBotClient`");
|
||||
|
||||
return wideClient;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Casts Update to <see cref="WUpdate"/>
|
||||
/// </summary>
|
||||
public WUpdate WideUpdate
|
||||
{
|
||||
get
|
||||
{
|
||||
object? update = handler.GetType().GetField("HandlingUpdate")?.GetValue(handler);
|
||||
if (update is not WUpdate wUpdate)
|
||||
throw new InvalidCastException("Update is not assignable to `WTelegram.Types.Update`");
|
||||
|
||||
return wUpdate;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Casts Update to <see cref="TLUpdate"/>
|
||||
/// </summary>
|
||||
public TLUpdate? TLUpdate
|
||||
{
|
||||
get => handler.WideUpdate.TLUpdate;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Casts Update to <see cref="WTelegramBotClient"/>
|
||||
/// </summary>
|
||||
public static WTelegramBotClient AsWClient(this ITelegramBotClient client)
|
||||
{
|
||||
return client as WTelegramBotClient
|
||||
?? throw new InvalidCastException("Client is not assignable to `WTelegram.Bot.WTelegramBotClient`");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Casts Update to <see cref="WUpdate"/>
|
||||
/// </summary>
|
||||
public static WUpdate AsWUpdate(this Update update)
|
||||
{
|
||||
return update as WUpdate
|
||||
?? throw new InvalidCastException("Update is not assignable to `WTelegram.Types.Update`");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Provides extension methods for <see cref="IHostApplicationBuilder"/> to configure Telegrator.
|
||||
/// </summary>
|
||||
public static class WideHostBuilderExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostApplicationBuilder AddWideTelegrator(this IHostApplicationBuilder builder, Func<IServiceProvider, DbConnection> dbConnectionFactory, Action<ITelegramBotHostBuilder>? action = null, TelegratorOptions? options = null, IHandlersCollection? handlers = null)
|
||||
{
|
||||
AddWideTelegratorInternal(builder.Services, builder.Configuration, builder.Properties, dbConnectionFactory, ref handlers, options);
|
||||
action?.Invoke(new TelegramBotHostBuilder(builder, handlers));
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostApplicationBuilder AddWideTelegrator(this IHostApplicationBuilder builder, Func<IServiceProvider, DbConnection> dbConnectionFactory, TelegratorOptions? options = null, IHandlersCollection? handlers = null)
|
||||
{
|
||||
AddWideTelegratorInternal(builder.Services, builder.Configuration, builder.Properties, dbConnectionFactory, ref handlers, options);
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
internal static void AddWideTelegratorInternal(IServiceCollection services, IConfiguration configuration, IDictionary<object, object> properties, Func<IServiceProvider, DbConnection> dbConnectionFactory, [NotNull] ref IHandlersCollection? handlers, TelegratorOptions? options = null)
|
||||
{
|
||||
if (services.Any(srvc => srvc.ServiceType == typeof(HostedUpdateReceiver)))
|
||||
throw new InvalidOperationException("`HostedUpdateReceiver` found in services. WideHost extension is not compatible with default long-polling receiver. Please, remove `AddTelegrator` invocation from your Host configuration.");
|
||||
|
||||
if (services.Any(srvc => srvc.ServiceType.Name == "HostedUpdateWebhooker"))
|
||||
throw new InvalidOperationException("`HostedUpdateWebhooker` found in services. WideHost extension is not compatible with webhooking yet. Please, remove `AddWebTelegrator` invocation from your Host configuration.");
|
||||
|
||||
if (options == null)
|
||||
{
|
||||
options = configuration.GetSection(nameof(TelegratorOptions)).Get<TelegratorOptions>();
|
||||
if (options == null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'TelegratorOptions' was registered. This configuration is runtime required!");
|
||||
}
|
||||
|
||||
CancellationTokenSource globallCancell = new CancellationTokenSource();
|
||||
options.GlobalCancellationToken = globallCancell.Token;
|
||||
services.AddSingleton(Options.Create(options));
|
||||
services.AddKeyedSingleton("cancell", globallCancell);
|
||||
|
||||
if (handlers != null)
|
||||
{
|
||||
if (handlers is IHandlersManager manager)
|
||||
{
|
||||
ServiceDescriptor descriptor = new ServiceDescriptor(typeof(IHandlersProvider), manager);
|
||||
services.Replace(descriptor);
|
||||
services.AddSingleton(manager);
|
||||
}
|
||||
}
|
||||
|
||||
handlers ??= new HostHandlersCollection(services, options);
|
||||
services.AddSingleton(handlers);
|
||||
properties.Add(HostBuilderExtensions.HandlersCollectionPropertyKey, handlers);
|
||||
|
||||
if (!services.Any(srvc => srvc.ServiceType == typeof(IOptions<WTelegramBotClientOptions>)))
|
||||
{
|
||||
WideBotOptions? wideBotOptions = configuration.GetSection(nameof(WideBotOptions)).Get<WideBotOptions>();
|
||||
if (wideBotOptions == null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'WideBotOptions' was registered. This configuration is runtime required!");
|
||||
|
||||
services.AddSingleton(provider =>
|
||||
{
|
||||
IHostApplicationLifetime lifetime = provider.GetRequiredService<IHostApplicationLifetime>();
|
||||
|
||||
DbConnection dbConnection = dbConnectionFactory.Invoke(provider);
|
||||
lifetime.ApplicationStopping.Register(() => dbConnection.Dispose());
|
||||
|
||||
WTelegramBotClientOptions wideOptions = new WTelegramBotClientOptions(
|
||||
token: options.Token,
|
||||
apiId: wideBotOptions.ApiId,
|
||||
apiHash: wideBotOptions.ApiHash,
|
||||
dbConnection: dbConnection,
|
||||
sqlCommands: wideBotOptions.SqlCommands,
|
||||
useTestEnvironment: options.UseTestEnvironment,
|
||||
mtproxy: wideBotOptions.MTProxy)
|
||||
{
|
||||
RetryCount = options.RetryCount,
|
||||
RetryThreshold = options.RetryThreshold
|
||||
};
|
||||
|
||||
return Options.Create(wideOptions);
|
||||
});
|
||||
}
|
||||
|
||||
services.AddTelegramBotHostDefaults();
|
||||
services.AddMTProtoUpdateReceiver();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Contains extensions for <see cref="IServiceCollection"/>
|
||||
/// Provides method to configure Telegram Bot WebHost
|
||||
/// </summary>
|
||||
public static class WideBotServiceCollectionExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Adds WTelegramBotClientOptions to services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection ConfigureWideTelegram(this IServiceCollection services, WTelegramBotClientOptions options)
|
||||
{
|
||||
services.RemoveAll<IOptions<WTelegramBotClientOptions>>();
|
||||
services.AddSingleton(Options.Create(options));
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds WTelegramBotClientOptions to services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection ConfigureWideBot(this IServiceCollection services, WideBotOptions options)
|
||||
{
|
||||
services.RemoveAll<IOptions<WideBotOptions>>();
|
||||
services.AddSingleton(Options.Create(options));
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds WTelegramBotClient
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="useHttp"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddMTProtoUpdateReceiver(this IServiceCollection services, bool useHttp = false)
|
||||
{
|
||||
services.RemoveAll<ITelegramBotClient>();
|
||||
services.RemoveAll<HostedWideBotUpdateReceiver>();
|
||||
|
||||
if (useHttp)
|
||||
{
|
||||
services.AddHttpClient<WTelegramBotClient>("tgmtproto").RemoveAllLoggers().AddTypedClient(TypedTelegramBotClientFactory);
|
||||
}
|
||||
else
|
||||
{
|
||||
services.AddSingleton(TypedTelegramBotClientFactory);
|
||||
}
|
||||
|
||||
services.AddSingleton<ITelegramBotClient>(sp => sp.GetRequiredService<WTelegramBotClient>());
|
||||
services.AddHostedService<HostedWideBotUpdateReceiver>();
|
||||
return services;
|
||||
}
|
||||
|
||||
#pragma warning disable CA2254
|
||||
private static WTelegramBotClient TypedTelegramBotClientFactory(HttpClient httpClient, IServiceProvider provider)
|
||||
{
|
||||
ILogger<WTelegramBotClient> logger = provider.GetRequiredService<ILogger<WTelegramBotClient>>();
|
||||
WTelegramBotClient client = new WTelegramBotClient(provider.GetRequiredService<IOptions<WTelegramBotClientOptions>>().Value, httpClient);
|
||||
|
||||
WTelegram.Helpers.Log = (lvl, str) => logger.Log((LogLevel)lvl, str);
|
||||
return client;
|
||||
}
|
||||
|
||||
private static WTelegramBotClient TypedTelegramBotClientFactory(IServiceProvider provider)
|
||||
{
|
||||
ILogger<WTelegramBotClient> logger = provider.GetRequiredService<ILogger<WTelegramBotClient>>();
|
||||
WTelegramBotClient client = new WTelegramBotClient(provider.GetRequiredService<IOptions<WTelegramBotClientOptions>>().Value);
|
||||
|
||||
WTelegram.Helpers.Log = (lvl, str) => logger.Log((LogLevel)lvl, str);
|
||||
return client;
|
||||
}
|
||||
#pragma warning restore CA2254
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Provides useful methods to adjust Telegram bot Host
|
||||
/// </summary>
|
||||
public static class WideTelegramBotHostExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Replaces the initialization logic from TelegramBotWebHost constructor.
|
||||
/// Initializes the bot and logs handlers on application startup.
|
||||
/// </summary>
|
||||
public static IHost UseWideTelegrator(this IHost botHost)
|
||||
{
|
||||
if (!botHost.Services.TryFindWTelegramBotClient())
|
||||
throw new InvalidOperationException("No service for type 'Telegram.Bot.WTelegramBotClient' has been registered. Invoke `AddWideTelegrator`");
|
||||
|
||||
ITelegramBotInfo info = botHost.Services.GetRequiredService<ITelegramBotInfo>();
|
||||
IHandlersCollection handlers = botHost.Services.GetRequiredService<IHandlersCollection>();
|
||||
ILoggerFactory loggerFactory = botHost.Services.GetRequiredService<ILoggerFactory>();
|
||||
ILogger logger = loggerFactory.CreateLogger("Telegrator.Hosting.Web.TelegratorHost");
|
||||
|
||||
if (logger.IsEnabled(LogLevel.Information))
|
||||
{
|
||||
logger.LogInformation("Telegrator WIDE Bot Host started (Generic Host)");
|
||||
logger.LogInformation("Receiving mode : MTProto");
|
||||
logger.LogInformation("Telegram Bot : {firstname}, @{usrname}, id:{id},", info.User.FirstName ?? "[NULL]", info.User.Username ?? "[NULL]", info.User.Id);
|
||||
logger.LogHandlers(handlers);
|
||||
}
|
||||
|
||||
botHost.AddLoggingAdapter();
|
||||
botHost.SetBotCommands();
|
||||
return botHost;
|
||||
}
|
||||
|
||||
private static bool TryFindWTelegramBotClient(this IServiceProvider services)
|
||||
{
|
||||
return services.GetServices<IHostedService>().Any(s => s is HostedWideBotUpdateReceiver);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
using Telegram.Bot;
|
||||
using WTelegram;
|
||||
|
||||
namespace Telegrator;
|
||||
|
||||
/// <summary>
|
||||
/// Represents configuration options for initializing and customizing the behavior of a WideBot instance.
|
||||
/// </summary>
|
||||
/// <remarks>Use this class to specify required API credentials, optional proxy settings, update handling
|
||||
/// preferences, and SQL command detection for WideBot. All required properties must be set before using the options
|
||||
/// with a WideBot instance.
|
||||
/// </remarks>
|
||||
public class WideBotOptions
|
||||
{
|
||||
/// <inheritdoc cref="WTelegramBotClientOptions.ApiId"/>
|
||||
public required int ApiId { get; set; }
|
||||
|
||||
/// <inheritdoc cref="WTelegramBotClientOptions.ApiHash"/>
|
||||
public required string ApiHash { get; set; }
|
||||
|
||||
/// <inheritdoc cref="WTelegramBotClientOptions.MTProxy"/>
|
||||
public string? MTProxy { get; set; }
|
||||
|
||||
/// <inheritdoc cref="WTelegramBotClientOptions.SqlCommands"/>
|
||||
public SqlCommands SqlCommands { get; set; } = WTelegram.SqlCommands.Detect;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether pending updates should be discarded.
|
||||
/// </summary>
|
||||
public bool DropPendingUpdates { get; set; }
|
||||
}
|
||||
@@ -9,3 +9,5 @@ using System.Diagnostics.CodeAnalysis;
|
||||
[assembly: SuppressMessage("Style", "IDE0090")]
|
||||
[assembly: SuppressMessage("Usage", "CA2254")]
|
||||
[assembly: SuppressMessage("Maintainability", "CA1510")]
|
||||
[assembly: SuppressMessage("Style", "IDE0270")]
|
||||
[assembly: SuppressMessage("Roslynator", "RCS1037")]
|
||||
|
||||
@@ -3,17 +3,17 @@ using Telegram.Bot;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Core;
|
||||
|
||||
namespace Telegrator.Hosting
|
||||
namespace Telegrator.Hosting;
|
||||
|
||||
/// <summary>
|
||||
/// Implementation of <see cref="ITelegramBotInfo"/> that provides bot information.
|
||||
/// Contains metadata about the Telegram bot including user details and service provider for wider filterring abilities
|
||||
/// </summary>
|
||||
/// <param name="client"></param>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="configuration"></param>
|
||||
public class HostedTelegramBotInfo(ITelegramBotClient client, IServiceProvider services, IConfiguration configuration) : ITelegramBotInfo
|
||||
{
|
||||
/// <summary>
|
||||
/// Implementation of <see cref="ITelegramBotInfo"/> that provides bot information.
|
||||
/// Contains metadata about the Telegram bot including user details and service provider for wider filterring abilities
|
||||
/// </summary>
|
||||
/// <param name="client"></param>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="configuration"></param>
|
||||
public class HostedTelegramBotInfo(ITelegramBotClient client, IServiceProvider services, IConfiguration configuration) : ITelegramBotInfo
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public User User { get; } = client.GetMe().Result;
|
||||
|
||||
@@ -26,5 +26,4 @@ namespace Telegrator.Hosting
|
||||
/// Provides access to configuration of this Hosted telegram bot
|
||||
/// </summary>
|
||||
public IConfiguration Configuration { get; } = configuration;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Telegrator.Core;
|
||||
|
||||
namespace Telegrator.Hosting;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
|
||||
/// </summary>
|
||||
public interface ITelegramBotHostBuilder : IHostApplicationBuilder, ICollectingProvider;
|
||||
@@ -1,115 +0,0 @@
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Telegrator.Core;
|
||||
|
||||
namespace Telegrator.Hosting
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a hosted telegram bot
|
||||
/// </summary>
|
||||
public class TelegramBotHost : IHost, ITelegratorBot
|
||||
{
|
||||
private readonly IHost _innerHost;
|
||||
private readonly IUpdateRouter _updateRouter;
|
||||
private readonly ILogger<TelegramBotHost> _logger;
|
||||
|
||||
private bool _disposed;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IServiceProvider Services => _innerHost.Services;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IUpdateRouter UpdateRouter => _updateRouter;
|
||||
|
||||
/// <summary>
|
||||
/// This application's logger
|
||||
/// </summary>
|
||||
public ILogger<TelegramBotHost> Logger => _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotHost"/> class.
|
||||
/// </summary>
|
||||
/// <param name="hostApplicationBuilder">The proxied instance of host builder.</param>
|
||||
public TelegramBotHost(HostApplicationBuilder hostApplicationBuilder)
|
||||
{
|
||||
// Registering this host in services for easy access
|
||||
hostApplicationBuilder.Services.AddSingleton<ITelegratorBot>(this);
|
||||
|
||||
// Building proxy hoster
|
||||
_innerHost = hostApplicationBuilder.Build();
|
||||
|
||||
// Reruesting services for this host
|
||||
_updateRouter = Services.GetRequiredService<IUpdateRouter>();
|
||||
_logger = Services.GetRequiredService<ILogger<TelegramBotHost>>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new <see cref="TelegramBotHostBuilder"/> with default configuration, services and long-polling update receiving scheme
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotHostBuilder CreateBuilder()
|
||||
{
|
||||
HostApplicationBuilder innerBuilder = new HostApplicationBuilder(settings: null);
|
||||
TelegramBotHostBuilder builder = new TelegramBotHostBuilder(innerBuilder, null);
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new <see cref="TelegramBotHostBuilder"/> with default services and long-polling update receiving scheme
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotHostBuilder CreateBuilder(HostApplicationBuilderSettings? settings)
|
||||
{
|
||||
HostApplicationBuilder innerBuilder = new HostApplicationBuilder(settings);
|
||||
TelegramBotHostBuilder builder = new TelegramBotHostBuilder(innerBuilder, settings);
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new EMPTY <see cref="TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotHostBuilder CreateEmptyBuilder()
|
||||
{
|
||||
HostApplicationBuilder innerBuilder = Host.CreateEmptyApplicationBuilder(null);
|
||||
return new TelegramBotHostBuilder(innerBuilder, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates new EMPTY <see cref="TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static TelegramBotHostBuilder CreateEmptyBuilder(HostApplicationBuilderSettings? settings)
|
||||
{
|
||||
HostApplicationBuilder innerBuilder = Host.CreateEmptyApplicationBuilder(null);
|
||||
return new TelegramBotHostBuilder(innerBuilder, settings);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task StartAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
await _innerHost.StartAsync(cancellationToken);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task StopAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
await _innerHost.StopAsync(cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Disposes the host.
|
||||
/// </summary>
|
||||
public void Dispose()
|
||||
{
|
||||
if (_disposed)
|
||||
return;
|
||||
|
||||
_innerHost.Dispose();
|
||||
|
||||
GC.SuppressFinalize(this);
|
||||
_disposed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,20 +3,15 @@ using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Diagnostics.Metrics;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Providers;
|
||||
|
||||
#pragma warning disable IDE0001
|
||||
namespace Telegrator.Hosting
|
||||
namespace Telegrator.Hosting;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public class TelegramBotHostBuilder : ITelegramBotHostBuilder
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
|
||||
/// </summary>
|
||||
public class TelegramBotHostBuilder : IHostApplicationBuilder, ICollectingProvider
|
||||
{
|
||||
private readonly HostApplicationBuilder _innerBuilder;
|
||||
private readonly HostApplicationBuilderSettings _settings;
|
||||
private readonly IHostApplicationBuilder _innerBuilder;
|
||||
internal IHandlersCollection _handlers = null!;
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -35,7 +30,7 @@ namespace Telegrator.Hosting
|
||||
public IHostEnvironment Environment => _innerBuilder.Environment;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IDictionary<object, object> Properties => ((IHostApplicationBuilder)_innerBuilder).Properties;
|
||||
public IDictionary<object, object> Properties => _innerBuilder.Properties;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IMetricsBuilder Metrics => _innerBuilder.Metrics;
|
||||
@@ -44,27 +39,9 @@ namespace Telegrator.Hosting
|
||||
/// Initializes a new instance of the <see cref="TelegramBotHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="hostApplicationBuilder"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotHostBuilder(HostApplicationBuilder hostApplicationBuilder, HostApplicationBuilderSettings? settings = null)
|
||||
public TelegramBotHostBuilder(IHostApplicationBuilder hostApplicationBuilder)
|
||||
{
|
||||
_innerBuilder = hostApplicationBuilder ?? throw new ArgumentNullException(nameof(hostApplicationBuilder));
|
||||
_settings = settings ?? new HostApplicationBuilderSettings();
|
||||
|
||||
this.AddTelegrator();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="hostApplicationBuilder"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotHostBuilder(HostApplicationBuilder hostApplicationBuilder, TelegratorOptions? options, HostApplicationBuilderSettings? settings)
|
||||
{
|
||||
_innerBuilder = hostApplicationBuilder ?? throw new ArgumentNullException(nameof(hostApplicationBuilder));
|
||||
_settings = settings ?? new HostApplicationBuilderSettings();
|
||||
|
||||
this.AddTelegrator(options, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -72,45 +49,15 @@ namespace Telegrator.Hosting
|
||||
/// </summary>
|
||||
/// <param name="hostApplicationBuilder"></param>
|
||||
/// <param name="handlers"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotHostBuilder(HostApplicationBuilder hostApplicationBuilder, IHandlersCollection handlers, HostApplicationBuilderSettings? settings)
|
||||
public TelegramBotHostBuilder(IHostApplicationBuilder hostApplicationBuilder, IHandlersCollection handlers)
|
||||
{
|
||||
_innerBuilder = hostApplicationBuilder ?? throw new ArgumentNullException(nameof(hostApplicationBuilder));
|
||||
_settings = settings ?? new HostApplicationBuilderSettings();
|
||||
|
||||
this.AddTelegrator(null, handlers);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TelegramBotHostBuilder"/> class.
|
||||
/// </summary>
|
||||
/// <param name="hostApplicationBuilder"></param>
|
||||
/// <param name="handlers"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <param name="settings"></param>
|
||||
public TelegramBotHostBuilder(HostApplicationBuilder hostApplicationBuilder, IHandlersCollection handlers, TelegratorOptions? options, HostApplicationBuilderSettings? settings)
|
||||
{
|
||||
_innerBuilder = hostApplicationBuilder ?? throw new ArgumentNullException(nameof(hostApplicationBuilder));
|
||||
_settings = settings ?? new HostApplicationBuilderSettings();
|
||||
|
||||
this.AddTelegrator(options, handlers);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Builds the host.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public TelegramBotHost Build()
|
||||
{
|
||||
TelegramBotHost host = new TelegramBotHost(_innerBuilder);
|
||||
host.UseTelegrator();
|
||||
return host;
|
||||
_handlers = handlers ?? throw new ArgumentNullException(nameof(handlers));
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void ConfigureContainer<TContainerBuilder>(IServiceProviderFactory<TContainerBuilder> factory, Action<TContainerBuilder>? configure = null) where TContainerBuilder : notnull
|
||||
{
|
||||
this.ConfigureContainer(factory, configure);
|
||||
}
|
||||
_innerBuilder.ConfigureContainer(factory, configure);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,20 +1,18 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
namespace Telegrator.Logging;
|
||||
|
||||
namespace Telegrator.Logging
|
||||
/// <summary>
|
||||
/// Adapter for Microsoft.Extensions.Logging to work with Telegrator logging system.
|
||||
/// This allows seamless integration with ASP.NET Core logging infrastructure.
|
||||
/// </summary>
|
||||
public class MicrosoftLoggingAdapter : ITelegratorLogger
|
||||
{
|
||||
/// <summary>
|
||||
/// Adapter for Microsoft.Extensions.Logging to work with Telegrator logging system.
|
||||
/// This allows seamless integration with ASP.NET Core logging infrastructure.
|
||||
/// </summary>
|
||||
public class MicrosoftLoggingAdapter : ITelegratorLogger
|
||||
{
|
||||
private readonly ILogger _logger;
|
||||
private readonly Microsoft.Extensions.Logging.ILogger _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of MicrosoftLoggingAdapter.
|
||||
/// </summary>
|
||||
/// <param name="logger">The Microsoft.Extensions.Logging logger instance.</param>
|
||||
public MicrosoftLoggingAdapter(ILogger logger)
|
||||
public MicrosoftLoggingAdapter(Microsoft.Extensions.Logging.ILogger logger)
|
||||
{
|
||||
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
|
||||
}
|
||||
@@ -24,22 +22,23 @@ namespace Telegrator.Logging
|
||||
{
|
||||
var msLogLevel = level switch
|
||||
{
|
||||
Telegrator.Logging.LogLevel.Trace => Microsoft.Extensions.Logging.LogLevel.Trace,
|
||||
Telegrator.Logging.LogLevel.Debug => Microsoft.Extensions.Logging.LogLevel.Debug,
|
||||
Telegrator.Logging.LogLevel.Information => Microsoft.Extensions.Logging.LogLevel.Information,
|
||||
Telegrator.Logging.LogLevel.Warning => Microsoft.Extensions.Logging.LogLevel.Warning,
|
||||
Telegrator.Logging.LogLevel.Error => Microsoft.Extensions.Logging.LogLevel.Error,
|
||||
LogLevel.Trace => Microsoft.Extensions.Logging.LogLevel.Trace,
|
||||
LogLevel.Debug => Microsoft.Extensions.Logging.LogLevel.Debug,
|
||||
LogLevel.Information => Microsoft.Extensions.Logging.LogLevel.Information,
|
||||
LogLevel.Warning => Microsoft.Extensions.Logging.LogLevel.Warning,
|
||||
LogLevel.Error => Microsoft.Extensions.Logging.LogLevel.Error,
|
||||
_ => Microsoft.Extensions.Logging.LogLevel.Information
|
||||
};
|
||||
|
||||
if (exception != null)
|
||||
{
|
||||
_logger.Log(msLogLevel, default, message, exception, (str, exc) => string.Format("{0} : {1}", str, exc));
|
||||
_logger.Log(msLogLevel, default, message, exception,
|
||||
(str, exc) => string.Format("{0} : {1}", str, exc));
|
||||
}
|
||||
else
|
||||
{
|
||||
_logger.Log(msLogLevel, default, message, null, (str, _) => str);
|
||||
}
|
||||
_logger.Log(msLogLevel, default, message, null,
|
||||
(str, _) => str);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Core.States;
|
||||
|
||||
namespace Telegrator.Mediation;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public class HostUpdateRouter : UpdateRouter
|
||||
{
|
||||
/// <summary>
|
||||
/// <see cref="ILogger"/> of this router
|
||||
/// </summary>
|
||||
protected readonly ILogger<HostUpdateRouter> Logger;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public HostUpdateRouter(
|
||||
IHandlersProvider handlersProvider,
|
||||
IAwaitingProvider awaitingProvider,
|
||||
IStateStorage stateStorage,
|
||||
IOptions<TelegratorOptions> options,
|
||||
ITelegramBotInfo botInfo,
|
||||
ILogger<HostUpdateRouter> logger) : base(handlersProvider, awaitingProvider, stateStorage, options.Value, botInfo)
|
||||
{
|
||||
Logger = logger;
|
||||
ExceptionHandler = new DefaultRouterExceptionHandler(HandleException);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override Task HandleUpdateAsync(ITelegramBotClient botClient, Update update, CancellationToken cancellationToken)
|
||||
{
|
||||
//Logger.LogInformation("Received update of type \"{type}\"", update.Type);
|
||||
return base.HandleUpdateAsync(botClient, update, cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Default exception handler of this router
|
||||
/// </summary>
|
||||
/// <param name="botClient"></param>
|
||||
/// <param name="exception"></param>
|
||||
/// <param name="source"></param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
public void HandleException(ITelegramBotClient botClient, Exception exception, HandleErrorSource source, CancellationToken cancellationToken)
|
||||
{
|
||||
if (exception is HandlerFaultedException handlerFaultedException)
|
||||
{
|
||||
Logger.LogError("\"{handler}\" handler's execution was faulted :\n{exception}",
|
||||
handlerFaultedException.HandlerInfo.ToString(),
|
||||
handlerFaultedException.InnerException?.ToString() ?? "No inner exception");
|
||||
return;
|
||||
}
|
||||
|
||||
Logger.LogError("Exception was thrown during update routing faulted :\n{exception}", exception.ToString());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegrator.Core;
|
||||
|
||||
namespace Telegrator.Mediation;
|
||||
|
||||
/// <summary>
|
||||
/// Service for receiving updates for Hosted telegram botsand queuing them to router
|
||||
/// </summary>
|
||||
/// <param name="botClient"></param>
|
||||
/// <param name="updateRouter"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <param name="logger"></param>
|
||||
public class HostedUpdateReceiver(ITelegramBotClient botClient, IUpdateRouter updateRouter, IOptions<ReceiverOptions> options, ILogger<HostedUpdateReceiver> logger) : BackgroundService
|
||||
{
|
||||
private readonly ReceiverOptions _receiverOptions = options.Value;
|
||||
private readonly IUpdateRouter _updateRouter = updateRouter;
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
logger.LogInformation("Starting receiving updates via long-polling");
|
||||
_receiverOptions.AllowedUpdates = _updateRouter.HandlersProvider.AllowedTypes.ToArray();
|
||||
|
||||
botClient.DeleteWebhook(options.Value.DropPendingUpdates, cancellationToken: stoppingToken)
|
||||
.ConfigureAwait(false).GetAwaiter().GetResult();
|
||||
|
||||
DefaultUpdateReceiver updateReceiver = new DefaultUpdateReceiver(botClient, _receiverOptions);
|
||||
await updateReceiver.ReceiveAsync(_updateRouter, stoppingToken).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
@@ -1,60 +0,0 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Core.States;
|
||||
using Telegrator.Mediation;
|
||||
|
||||
namespace Telegrator.Polling
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public class HostUpdateRouter : UpdateRouter
|
||||
{
|
||||
/// <summary>
|
||||
/// <see cref="ILogger"/> of this router
|
||||
/// </summary>
|
||||
protected readonly ILogger<HostUpdateRouter> Logger;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public HostUpdateRouter(
|
||||
IHandlersProvider handlersProvider,
|
||||
IAwaitingProvider awaitingProvider,
|
||||
IStateStorage stateStorage,
|
||||
IOptions<TelegratorOptions> options,
|
||||
ITelegramBotInfo botInfo,
|
||||
ILogger<HostUpdateRouter> logger) : base(handlersProvider, awaitingProvider, stateStorage, options.Value, botInfo)
|
||||
{
|
||||
Logger = logger;
|
||||
ExceptionHandler = new DefaultRouterExceptionHandler(HandleException);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override Task HandleUpdateAsync(ITelegramBotClient botClient, Update update, CancellationToken cancellationToken)
|
||||
{
|
||||
//Logger.LogInformation("Received update of type \"{type}\"", update.Type);
|
||||
return base.HandleUpdateAsync(botClient, update, cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Default exception handler of this router
|
||||
/// </summary>
|
||||
/// <param name="botClient"></param>
|
||||
/// <param name="exception"></param>
|
||||
/// <param name="source"></param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
public void HandleException(ITelegramBotClient botClient, Exception exception, HandleErrorSource source, CancellationToken cancellationToken)
|
||||
{
|
||||
if (exception is HandlerFaultedException handlerFaultedException)
|
||||
{
|
||||
Logger.LogError("\"{handler}\" handler's execution was faulted :\n{exception}",
|
||||
handlerFaultedException.HandlerInfo.ToString(),
|
||||
handlerFaultedException.InnerException?.ToString() ?? "No inner exception");
|
||||
return;
|
||||
}
|
||||
|
||||
Logger.LogError("Exception was thrown during update routing faulted :\n{exception}", exception.ToString());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,32 +0,0 @@
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Mediation;
|
||||
|
||||
namespace Telegrator.Polling
|
||||
{
|
||||
/// <summary>
|
||||
/// Service for receiving updates for Hosted telegram bots
|
||||
/// </summary>
|
||||
/// <param name="botClient"></param>
|
||||
/// <param name="updateRouter"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <param name="logger"></param>
|
||||
public class HostedUpdateReceiver(ITelegramBotClient botClient, IUpdateRouter updateRouter, IOptions<ReceiverOptions> options, ILogger<HostedUpdateReceiver> logger) : BackgroundService
|
||||
{
|
||||
private readonly ReceiverOptions _receiverOptions = options.Value;
|
||||
private readonly IUpdateRouter _updateRouter = updateRouter;
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
logger.LogInformation("Starting receiving updates via long-polling");
|
||||
_receiverOptions.AllowedUpdates = _updateRouter.HandlersProvider.AllowedTypes.ToArray();
|
||||
DefaultUpdateReceiver updateReceiver = new DefaultUpdateReceiver(botClient, _receiverOptions);
|
||||
await updateReceiver.ReceiveAsync(_updateRouter, stoppingToken).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,11 +1,9 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
namespace Telegrator.Providers
|
||||
namespace Telegrator.Providers;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public class HostAwaitingProvider(IOptions<TelegratorOptions> options) : AwaitingProvider(options.Value)
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public class HostAwaitingProvider(IOptions<TelegratorOptions> options, ILogger<HostAwaitingProvider> logger) : AwaitingProvider(options.Value)
|
||||
{
|
||||
private readonly ILogger<HostAwaitingProvider> _logger = logger;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Core.Descriptors;
|
||||
|
||||
namespace Telegrator.Providers
|
||||
namespace Telegrator.Providers;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public class HostHandlersCollection(IServiceCollection hostServiceColletion, TelegratorOptions options) : HandlersCollection(options)
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public class HostHandlersCollection(IServiceCollection hostServiceColletion, TelegratorOptions options) : HandlersCollection(options)
|
||||
{
|
||||
private readonly IServiceCollection Services = hostServiceColletion;
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -17,46 +17,64 @@ namespace Telegrator.Providers
|
||||
{
|
||||
switch (descriptor.Type)
|
||||
{
|
||||
default:
|
||||
throw new Exception("Unknown descriptor type");
|
||||
|
||||
case DescriptorType.General:
|
||||
{
|
||||
if (descriptor.InstanceFactory != null)
|
||||
{
|
||||
Services.AddScoped(descriptor.HandlerType, _ => descriptor.InstanceFactory.Invoke());
|
||||
else
|
||||
Services.AddScoped(descriptor.HandlerType);
|
||||
break;
|
||||
}
|
||||
|
||||
Services.AddScoped(descriptor.HandlerType);
|
||||
break;
|
||||
}
|
||||
|
||||
case DescriptorType.Keyed:
|
||||
{
|
||||
if (descriptor.InstanceFactory != null)
|
||||
{
|
||||
Services.AddKeyedScoped(descriptor.HandlerType, descriptor.ServiceKey, (_, _) => descriptor.InstanceFactory.Invoke());
|
||||
else
|
||||
Services.AddKeyedScoped(descriptor.HandlerType, descriptor.ServiceKey);
|
||||
break;
|
||||
}
|
||||
|
||||
Services.AddKeyedScoped(descriptor.HandlerType, descriptor.ServiceKey);
|
||||
break;
|
||||
}
|
||||
|
||||
case DescriptorType.Singleton:
|
||||
{
|
||||
Services.AddSingleton(descriptor.HandlerType, descriptor.SingletonInstance ?? (descriptor.InstanceFactory != null
|
||||
? descriptor.InstanceFactory.Invoke()
|
||||
: throw new Exception()));
|
||||
if (descriptor.SingletonInstance != null)
|
||||
{
|
||||
Services.AddSingleton(descriptor.HandlerType, descriptor.SingletonInstance);
|
||||
break;
|
||||
}
|
||||
|
||||
if (descriptor.InstanceFactory == null)
|
||||
throw new InvalidOperationException("Singleton handler descriptor without singleton instance should implement `InstanceFactory`");
|
||||
|
||||
Services.AddSingleton(descriptor.HandlerType, descriptor.InstanceFactory.Invoke());
|
||||
break;
|
||||
}
|
||||
|
||||
case DescriptorType.Implicit:
|
||||
{
|
||||
Services.AddKeyedSingleton(descriptor.HandlerType, descriptor.ServiceKey, descriptor.SingletonInstance ?? (descriptor.InstanceFactory != null
|
||||
? descriptor.InstanceFactory.Invoke()
|
||||
: throw new Exception()));
|
||||
if (descriptor.SingletonInstance != null)
|
||||
{
|
||||
Services.AddKeyedSingleton(descriptor.HandlerType, descriptor.ServiceKey, descriptor.SingletonInstance);
|
||||
break;
|
||||
}
|
||||
|
||||
if (descriptor.InstanceFactory == null)
|
||||
throw new InvalidOperationException("Implicit handler descriptor without singleton instance should implement `InstanceFactory`");
|
||||
|
||||
Services.AddKeyedSingleton(descriptor.HandlerType, descriptor.ServiceKey, descriptor.InstanceFactory.Invoke());
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return base.AddDescriptor(descriptor);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,27 +1,23 @@
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Core.Descriptors;
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Providers
|
||||
namespace Telegrator.Providers;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public class HostHandlersProvider : HandlersProvider
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public class HostHandlersProvider : HandlersProvider
|
||||
{
|
||||
private readonly IServiceProvider Services;
|
||||
private readonly ILogger<HostHandlersProvider> Logger;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public HostHandlersProvider(
|
||||
IHandlersCollection handlers,
|
||||
IOptions<TelegratorOptions> options,
|
||||
IServiceProvider serviceProvider,
|
||||
ILogger<HostHandlersProvider> logger) : base(handlers, options.Value)
|
||||
IServiceProvider serviceProvider) : base(handlers, options.Value)
|
||||
{
|
||||
Services = serviceProvider;
|
||||
Logger = logger;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -41,5 +37,4 @@ namespace Telegrator.Providers
|
||||
updateHandler.LifetimeToken.OnLifetimeEnded += _ => scope.Dispose();
|
||||
return updateHandler;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,9 +13,12 @@
|
||||
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||
<EnableNETAnalyzers>True</EnableNETAnalyzers>
|
||||
<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
|
||||
<IncludeSymbols>True</IncludeSymbols>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<SignAssembly>False</SignAssembly>
|
||||
|
||||
<Title>Telegrator.Hosting</Title>
|
||||
<Version>1.16.4</Version>
|
||||
<Version>1.17.1</Version>
|
||||
<Authors>Rikitav Tim4ik</Authors>
|
||||
<Company>Rikitav Tim4ik</Company>
|
||||
<RepositoryUrl>https://github.com/Rikitav/Telegrator</RepositoryUrl>
|
||||
@@ -31,8 +34,8 @@
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.3" />
|
||||
<PackageReference Include="Microsoft.Extensions.Http" Version="10.0.3" />
|
||||
<PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.7" />
|
||||
<PackageReference Include="Microsoft.Extensions.Http" Version="10.0.7" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
@@ -4,6 +4,7 @@ using Microsoft.Extensions.DependencyInjection.Extensions;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Text;
|
||||
using Telegram.Bot;
|
||||
using Telegram.Bot.Polling;
|
||||
@@ -11,10 +12,12 @@ using Telegram.Bot.Types;
|
||||
using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Core;
|
||||
using Telegrator.Core.Descriptors;
|
||||
using Telegrator.Core.States;
|
||||
using Telegrator.Hosting;
|
||||
using Telegrator.Logging;
|
||||
using Telegrator.Polling;
|
||||
using Telegrator.Mediation;
|
||||
using Telegrator.Providers;
|
||||
using Telegrator.States;
|
||||
|
||||
namespace Telegrator;
|
||||
|
||||
@@ -28,36 +31,54 @@ public static class HostBuilderExtensions
|
||||
/// </summary>
|
||||
public const string HandlersCollectionPropertyKey = nameof(IHandlersCollection);
|
||||
|
||||
extension (IHostApplicationBuilder builder)
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the <see cref="IHandlersCollection"/> from the builder properties.
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public IHandlersCollection Handlers
|
||||
public static IHostApplicationBuilder AddTelegrator(this IHostApplicationBuilder builder, TelegratorOptions? options = null, IHandlersCollection? handlers = null, Action<ITelegramBotHostBuilder>? action = null)
|
||||
{
|
||||
get
|
||||
{
|
||||
if (builder is TelegramBotHostBuilder botHostBuilder)
|
||||
return botHostBuilder.Handlers;
|
||||
|
||||
return (IHandlersCollection)builder.Properties[HandlersCollectionPropertyKey];
|
||||
}
|
||||
}
|
||||
AddTelegratorInternal(builder.Services, builder.Configuration, ((IHostApplicationBuilder)builder).Properties, ref handlers, options);
|
||||
action?.Invoke(new TelegramBotHostBuilder(builder, handlers));
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostApplicationBuilder AddTelegrator(this IHostApplicationBuilder builder, TelegratorOptions? options = null, IHandlersCollection? handlers = null)
|
||||
{
|
||||
IServiceCollection services = builder.Services;
|
||||
IConfigurationManager configuration = builder.Configuration;
|
||||
AddTelegratorInternal(builder.Services, builder.Configuration, builder.Properties, ref handlers, options);
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostBuilder AddTelegrator(this IHostBuilder builder, TelegratorOptions? options = null, IHandlersCollection? handlers = null)
|
||||
{
|
||||
builder.ConfigureServices((ctx, sp) => AddTelegratorInternal(sp, ctx.Configuration, builder.Properties, ref handlers, options));
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
public static IHostBuilder AddTelegrator(this IHostBuilder builder, TelegratorOptions? options = null, IHandlersCollection? handlers = null, Action<IHandlersCollection>? action = null)
|
||||
{
|
||||
builder.ConfigureServices((ctx, sp) => AddTelegratorInternal(sp, ctx.Configuration, builder.Properties, ref handlers, options));
|
||||
action?.Invoke(handlers!); // AddTelegratorInternal initializes `handlers`
|
||||
return builder;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
|
||||
/// </summary>
|
||||
internal static void AddTelegratorInternal(IServiceCollection services, IConfiguration configuration, IDictionary<object, object> properties, [NotNull] ref IHandlersCollection? handlers, TelegratorOptions? options = null)
|
||||
{
|
||||
if (options == null)
|
||||
{
|
||||
options = configuration.GetSection(nameof(TelegratorOptions)).Get<TelegratorOptions>();
|
||||
if (options == null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'TelegratorOptions' wasn't registered. This configuration is runtime required!");
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'TelegratorOptions' was registered. This configuration is runtime required!");
|
||||
}
|
||||
|
||||
CancellationTokenSource globallCancell = new CancellationTokenSource();
|
||||
@@ -77,16 +98,13 @@ public static class HostBuilderExtensions
|
||||
|
||||
handlers ??= new HostHandlersCollection(services, options);
|
||||
services.AddSingleton(handlers);
|
||||
properties.Add(HandlersCollectionPropertyKey, handlers);
|
||||
|
||||
builder.Properties.Add(HandlersCollectionPropertyKey, handlers);
|
||||
if (builder is TelegramBotHostBuilder botHostBuilder)
|
||||
botHostBuilder._handlers = handlers;
|
||||
|
||||
if (!services.Any(srvc => srvc.ImplementationType == typeof(IOptions<ReceiverOptions>)))
|
||||
if (!services.Any(srvc => srvc.ServiceType == typeof(IOptions<ReceiverOptions>)))
|
||||
{
|
||||
ReceiverOptions? receiverOptions = configuration.GetSection(nameof(ReceiverOptions)).Get<ReceiverOptions>();
|
||||
if (receiverOptions == null)
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'ReceiverOptions' wasn't registered. This configuration is runtime required!");
|
||||
throw new MissingMemberException("Auto configuration disabled, yet no options of type 'ReceiverOptions' was registered. This configuration is runtime required!");
|
||||
|
||||
services.AddSingleton(Options.Create(receiverOptions));
|
||||
}
|
||||
@@ -100,9 +118,8 @@ public static class HostBuilderExtensions
|
||||
}));
|
||||
}
|
||||
|
||||
services.AddTelegramReceiver();
|
||||
services.AddTelegramBotHostDefaults();
|
||||
return builder;
|
||||
services.AddTelegramReceiver();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -110,20 +127,58 @@ public static class HostBuilderExtensions
|
||||
/// Contains extensions for <see cref="IServiceCollection"/>
|
||||
/// Provides method to configure Telegram Bot Host
|
||||
/// </summary>
|
||||
public static class ServicesCollectionExtensions
|
||||
public static class HostServicesCollectionExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Registers <see cref="TelegramBotHost"/> default services
|
||||
/// Adds TelegramBotClientOptions to services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection ConfigureTelegram(this IServiceCollection services, TelegramBotClientOptions options)
|
||||
{
|
||||
services.RemoveAll<IOptions<TelegramBotClientOptions>>();
|
||||
services.AddSingleton(Options.Create(options));
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds ReceiverOptions to services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <param name="options"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection ConfigureReceiver(this IServiceCollection services, ReceiverOptions options)
|
||||
{
|
||||
services.RemoveAll<IOptions<ReceiverOptions>>();
|
||||
services.AddSingleton(Options.Create(options));
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Registers <see cref="IStateStorage"/> service
|
||||
/// </summary>
|
||||
/// <typeparam name="TStorage"></typeparam>
|
||||
/// <param name="services"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddStateStorage<TStorage>(this IServiceCollection services) where TStorage : IStateStorage
|
||||
{
|
||||
services.Replace(new ServiceDescriptor(typeof(IStateStorage), typeof(TStorage), ServiceLifetime.Singleton));
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Registers <see cref="Telegrator"/> default services
|
||||
/// </summary>
|
||||
/// <param name="services"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddTelegramBotHostDefaults(this IServiceCollection services)
|
||||
{
|
||||
services.AddLogging(builder => builder.AddConsole().AddDebug());
|
||||
services.AddSingleton<IAwaitingProvider, HostAwaitingProvider>();
|
||||
services.AddSingleton<IHandlersProvider, HostHandlersProvider>();
|
||||
services.AddSingleton<IUpdateRouter, HostUpdateRouter>();
|
||||
services.AddSingleton<ITelegramBotInfo, HostedTelegramBotInfo>();
|
||||
services.AddSingleton<IStateStorage, DefaultStateStorage>();
|
||||
|
||||
return services;
|
||||
}
|
||||
@@ -135,6 +190,9 @@ public static class ServicesCollectionExtensions
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddTelegramReceiver(this IServiceCollection services)
|
||||
{
|
||||
services.RemoveAll<ITelegramBotClient>();
|
||||
services.RemoveAll<HostedUpdateReceiver>();
|
||||
|
||||
services.AddHttpClient<ITelegramBotClient>("tgreceiver").RemoveAllLoggers().AddTypedClient(TypedTelegramBotClientFactory);
|
||||
services.AddHostedService<HostedUpdateReceiver>();
|
||||
return services;
|
||||
@@ -168,11 +226,14 @@ public static class TelegramBotHostExtensions
|
||||
|
||||
if (logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
|
||||
{
|
||||
logger.LogInformation("Telegrator Bot .NET Host started");
|
||||
logger.LogInformation("Telegrator Bot Host started (Generic Host)");
|
||||
logger.LogInformation("Receiving mode : LONG-POLLING");
|
||||
logger.LogInformation("Telegram Bot : {firstname}, @{usrname}, id:{id},", info.User.FirstName ?? "[NULL]", info.User.Username ?? "[NULL]", info.User.Id);
|
||||
logger.LogHandlers(handlers);
|
||||
}
|
||||
|
||||
botHost.AddLoggingAdapter();
|
||||
botHost.SetBotCommands();
|
||||
return botHost;
|
||||
}
|
||||
|
||||
@@ -187,7 +248,12 @@ public static class TelegramBotHostExtensions
|
||||
IUpdateRouter router = botHost.Services.GetRequiredService<IUpdateRouter>();
|
||||
|
||||
IEnumerable<BotCommand> aliases = router.HandlersProvider.GetBotCommands();
|
||||
client.SetMyCommands(aliases).Wait();
|
||||
if (aliases.Any())
|
||||
{
|
||||
client.SetMyCommands(aliases)
|
||||
.ConfigureAwait(false).GetAwaiter().GetResult();
|
||||
}
|
||||
|
||||
return botHost;
|
||||
}
|
||||
|
||||
@@ -223,7 +289,7 @@ public static class LoggerExtensions
|
||||
|
||||
StringBuilder logBuilder = new StringBuilder("Registered handlers : ");
|
||||
if (!handlers.Keys.Any())
|
||||
throw new Exception();
|
||||
throw new Exception("No update types were registered");
|
||||
|
||||
foreach (UpdateType updateType in handlers.Keys)
|
||||
{
|
||||
|
||||
@@ -4,14 +4,13 @@ using System.Threading.Tasks;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Handlers;
|
||||
|
||||
namespace Telegrator.Localized
|
||||
namespace Telegrator.Localized;
|
||||
|
||||
public static class LocalizedMessageHandlerExtensions
|
||||
{
|
||||
public static class LocalizedMessageHandlerExtensions
|
||||
{
|
||||
public static async Task<Message> ResponseLocalized(this ILocalizedHandler<Message> localizedHandler, string localizedReplyIdentifier, params IEnumerable<string> formatArgs)
|
||||
{
|
||||
LocalizedString localizedString = localizedHandler.LocalizationProvider[localizedReplyIdentifier, formatArgs];
|
||||
return await localizedHandler.Container.Responce(localizedString.Value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,15 +2,45 @@
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
<LangVersion>latest</LangVersion>
|
||||
<RootNamespace>Telegrator</RootNamespace>
|
||||
<BaseOutputPath>..\..\bin</BaseOutputPath>
|
||||
<DocumentationFile>..\..\docs\$(AssemblyName).xml</DocumentationFile>
|
||||
|
||||
<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
|
||||
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||
<EnableNETAnalyzers>True</EnableNETAnalyzers>
|
||||
<EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
|
||||
<IncludeSymbols>True</IncludeSymbols>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<SignAssembly>False</SignAssembly>
|
||||
|
||||
<Title>Telegrator.Localized</Title>
|
||||
<Version>1.17.1</Version>
|
||||
<Authors>Rikitav Tim4ik</Authors>
|
||||
<Company>Rikitav Tim4ik</Company>
|
||||
<RepositoryUrl>https://github.com/Rikitav/Telegrator</RepositoryUrl>
|
||||
<PackageTags>telegram;bot;mediator;attributes;aspect;hosting;host;framework;easy;simple;handlers</PackageTags>
|
||||
|
||||
<PackageIcon>telegrator_nuget.png</PackageIcon>
|
||||
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||
<PackageLicenseFile>LICENSE</PackageLicenseFile>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="10.0.2" />
|
||||
<PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="10.0.7" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\Telegrator\Telegrator.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include=".\README.md" Pack="True" PackagePath="\" />
|
||||
<None Include="..\..\LICENSE" Pack="True" PackagePath="\" />
|
||||
<None Include="..\..\resources\telegrator_nuget.png" Pack="True" PackagePath="\" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
|
||||
@@ -4,15 +4,15 @@ using Telegrator.Attributes;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract base attribute for filtering callback-based updates.
|
||||
/// Supports various message types including regular messages, edited messages, channel posts, and business messages.
|
||||
/// </summary>
|
||||
/// <param name="filters">The filters to apply to messages</param>
|
||||
public abstract class CallbackQueryAttribute(params IFilter<CallbackQuery>[] filters) : UpdateFilterAttribute<CallbackQuery>(filters)
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract base attribute for filtering callback-based updates.
|
||||
/// Supports various message types including regular messages, edited messages, channel posts, and business messages.
|
||||
/// </summary>
|
||||
/// <param name="filters">The filters to apply to messages</param>
|
||||
public abstract class CallbackQueryAttribute(params IFilter<CallbackQuery>[] filters) : UpdateFilterAttribute<CallbackQuery>(filters)
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the allowed update types that this filter can process.
|
||||
/// </summary>
|
||||
@@ -25,20 +25,19 @@ namespace Telegrator.Annotations
|
||||
/// <returns>The message from the update, or null if not present</returns>
|
||||
public override CallbackQuery? GetFilterringTarget(Update update)
|
||||
=> update.CallbackQuery;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering <see cref="CallbackQuery"/>'s data
|
||||
/// </summary>
|
||||
/// <param name="data"></param>
|
||||
public class CallbackDataAttribute(string data)
|
||||
: CallbackQueryAttribute(new CallbackDataFilter(data))
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute to check if <see cref="CallbackQuery"/> belongs to a specific message by its ID
|
||||
/// </summary>
|
||||
public class CallbackInlineIdAttribute(string inlineMessageId)
|
||||
: CallbackQueryAttribute(new CallbackInlineIdFilter(inlineMessageId))
|
||||
{ }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering <see cref="CallbackQuery"/>'s data
|
||||
/// </summary>
|
||||
/// <param name="data"></param>
|
||||
public class CallbackDataAttribute(string data)
|
||||
: CallbackQueryAttribute(new CallbackDataFilter(data))
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute to check if <see cref="CallbackQuery"/> belongs to a specific message by its ID
|
||||
/// </summary>
|
||||
public class CallbackInlineIdAttribute(string inlineMessageId)
|
||||
: CallbackQueryAttribute(new CallbackInlineIdFilter(inlineMessageId))
|
||||
{ }
|
||||
|
||||
@@ -3,14 +3,14 @@ using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Filters;
|
||||
using Telegrator.Attributes;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on command aliases.
|
||||
/// Allows handlers to respond to multiple command variations using a single attribute.
|
||||
/// </summary>
|
||||
public class CommandAlliasAttribute : UpdateFilterAttribute<Message>
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on command aliases.
|
||||
/// Allows handlers to respond to multiple command variations using a single attribute.
|
||||
/// </summary>
|
||||
public class CommandAlliasAttribute : UpdateFilterAttribute<Message>
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the allowed update types for this filter.
|
||||
/// </summary>
|
||||
@@ -56,5 +56,4 @@ namespace Telegrator.Annotations
|
||||
/// <param name="update">The Telegram update.</param>
|
||||
/// <returns>The message from the update, or null if not present.</returns>
|
||||
public override Message? GetFilterringTarget(Update update) => update.Message;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,63 +1,62 @@
|
||||
using System.Text.RegularExpressions;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command has arguments count >= <paramref name="count"/>.
|
||||
/// </summary>
|
||||
/// <param name="count"></param>
|
||||
public class ArgumentCountAttribute(int count)
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command has arguments count >= <paramref name="count"/>.
|
||||
/// </summary>
|
||||
/// <param name="count"></param>
|
||||
public class ArgumentCountAttribute(int count)
|
||||
: MessageFilterAttribute(new ArgumentCountFilter(count))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument starts with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should start with.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentStartsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument starts with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should start with.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentStartsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
: MessageFilterAttribute(new ArgumentStartsWithFilter(content, comparison, index))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument ends with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should end with.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentEndsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument ends with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should end with.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentEndsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
: MessageFilterAttribute(new ArgumentEndsWithFilter(content, comparison, index))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument contains the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should contain.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentContainsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument contains the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should contain.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentContainsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
: MessageFilterAttribute(new ArgumentContainsFilter(content, comparison, index))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument equals the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should equal.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentEqualsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument equals the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The content that the command argument should equal.</param>
|
||||
/// <param name="comparison">The string comparison type to use for the check.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentEqualsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture, int index = 0)
|
||||
: MessageFilterAttribute(new ArgumentEqualsFilter(content, comparison, index))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument matches a regular expression pattern.
|
||||
/// </summary>
|
||||
/// <param name="pattern">The regular expression pattern to match against the command argument.</param>
|
||||
/// <param name="options">The regex options to use for the pattern matching.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentRegexAttribute(string pattern, RegexOptions options = RegexOptions.None, int index = 0)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where a command argument matches a regular expression pattern.
|
||||
/// </summary>
|
||||
/// <param name="pattern">The regular expression pattern to match against the command argument.</param>
|
||||
/// <param name="options">The regex options to use for the pattern matching.</param>
|
||||
/// <param name="index">The index of the argument to check (0-based).</param>
|
||||
public class ArgumentRegexAttribute(string pattern, RegexOptions options = RegexOptions.None, int index = 0)
|
||||
: MessageFilterAttribute(new ArgumentRegexFilter(pattern, options, index: index))
|
||||
{ }
|
||||
}
|
||||
{ }
|
||||
|
||||
@@ -1,12 +1,11 @@
|
||||
namespace Telegrator.Annotations
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute that prevents a class from being automatically collected by the handler collection system.
|
||||
/// When applied to a class, it will be excluded from domain-wide handler collection operations.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
|
||||
public class DontCollectAttribute : Attribute
|
||||
{
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute that prevents a class from being automatically collected by the handler collection system.
|
||||
/// When applied to a class, it will be excluded from domain-wide handler collection operations.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
|
||||
public class DontCollectAttribute : Attribute
|
||||
{
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,15 +4,15 @@ using Telegrator.Filters;
|
||||
using Telegrator.Attributes;
|
||||
using Telegrator.Core.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract base attribute for filtering updates based on environment conditions.
|
||||
/// Can process all types of updates and provides environment-specific filtering logic.
|
||||
/// </summary>
|
||||
/// <param name="filters">The environment filters to apply</param>
|
||||
public abstract class EnvironmentFilterAttribute(params IFilter<Update>[] filters) : UpdateFilterAttribute<Update>(filters)
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract base attribute for filtering updates based on environment conditions.
|
||||
/// Can process all types of updates and provides environment-specific filtering logic.
|
||||
/// </summary>
|
||||
/// <param name="filters">The environment filters to apply</param>
|
||||
public abstract class EnvironmentFilterAttribute(params IFilter<Update>[] filters) : UpdateFilterAttribute<Update>(filters)
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the allowed update types that this filter can process.
|
||||
/// Environment filters can process all update types.
|
||||
@@ -27,29 +27,29 @@ namespace Telegrator.Annotations
|
||||
/// <returns>The update object itself</returns>
|
||||
public override Update? GetFilterringTarget(Update update)
|
||||
=> update;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering updates that occur in debug environment.
|
||||
/// Only allows updates when the application is running in debug mode.
|
||||
/// </summary>
|
||||
public class IsDebugEnvironmentAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering updates that occur in debug environment.
|
||||
/// Only allows updates when the application is running in debug mode.
|
||||
/// </summary>
|
||||
public class IsDebugEnvironmentAttribute()
|
||||
: EnvironmentFilterAttribute(new IsDebugEnvironmentFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering updates that occur in release environment.
|
||||
/// Only allows updates when the application is running in release mode.
|
||||
/// </summary>
|
||||
public class IsReleaseEnvironmentAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering updates that occur in release environment.
|
||||
/// Only allows updates when the application is running in release mode.
|
||||
/// </summary>
|
||||
public class IsReleaseEnvironmentAttribute()
|
||||
: EnvironmentFilterAttribute(new IsReleaseEnvironmentFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering updates based on environment variable values.
|
||||
/// </summary>
|
||||
public class EnvironmentVariableAttribute : EnvironmentFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering updates based on environment variable values.
|
||||
/// </summary>
|
||||
public class EnvironmentVariableAttribute : EnvironmentFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter based on an environment variable with a specific value and comparison method.
|
||||
/// </summary>
|
||||
@@ -81,5 +81,4 @@ namespace Telegrator.Annotations
|
||||
/// <param name="comparison">The string comparison method</param>
|
||||
public EnvironmentVariableAttribute(string variable, StringComparison comparison)
|
||||
: base(new EnvironmentVariableFilter(variable, comparison)) { }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that contain mentions.
|
||||
/// Allows handlers to respond only to messages that mention the bot or specific users.
|
||||
/// </summary>
|
||||
public class MentionedAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that contain mentions.
|
||||
/// Allows handlers to respond only to messages that mention the bot or specific users.
|
||||
/// </summary>
|
||||
public class MentionedAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the MentionedAttribute that matches any mention.
|
||||
/// </summary>
|
||||
@@ -36,5 +36,4 @@ namespace Telegrator.Annotations
|
||||
/// <param name="offset">The offset position where the mention should occur.</param>
|
||||
public MentionedAttribute(string mention, int offset)
|
||||
: base(new MessageHasEntityFilter(MessageEntityType.Mention, offset, null), new MentionedFilter(mention)) { }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent in forum chats.
|
||||
/// </summary>
|
||||
public class ChatIsForumAttribute()
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent in forum chats.
|
||||
/// </summary>
|
||||
public class ChatIsForumAttribute()
|
||||
: MessageFilterAttribute(new MessageChatIsForumFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent in a specific chat by ID.
|
||||
/// </summary>
|
||||
/// <param name="id">The chat ID to match</param>
|
||||
public class ChatIdAttribute(long id)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent in a specific chat by ID.
|
||||
/// </summary>
|
||||
/// <param name="id">The chat ID to match</param>
|
||||
public class ChatIdAttribute(long id)
|
||||
: MessageFilterAttribute(new MessageChatIdFilter(id))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent in chats of a specific type.
|
||||
/// </summary>
|
||||
public class ChatTypeAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent in chats of a specific type.
|
||||
/// </summary>
|
||||
public class ChatTypeAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initialize new instance of <see cref="ChatTypeAttribute"/> to filter messages from chat from specific chats
|
||||
/// </summary>
|
||||
@@ -36,13 +36,13 @@ namespace Telegrator.Annotations
|
||||
/// <param name="flags"></param>
|
||||
public ChatTypeAttribute(ChatTypeFlags flags)
|
||||
: base(new MessageChatTypeFilter(flags)) { }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the chat title.
|
||||
/// </summary>
|
||||
public class ChatTitleAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the chat title.
|
||||
/// </summary>
|
||||
public class ChatTitleAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter messages from chats with a specific title and comparison method.
|
||||
/// </summary>
|
||||
@@ -57,13 +57,13 @@ namespace Telegrator.Annotations
|
||||
/// <param name="title">The chat title to match</param>
|
||||
public ChatTitleAttribute(string? title)
|
||||
: base(new MessageChatTitleFilter(title)) { }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the chat username.
|
||||
/// </summary>
|
||||
public class ChatUsernameAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the chat username.
|
||||
/// </summary>
|
||||
public class ChatUsernameAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter messages from chats with a specific username and comparison method.
|
||||
/// </summary>
|
||||
@@ -78,13 +78,13 @@ namespace Telegrator.Annotations
|
||||
/// <param name="userName">The chat username to match</param>
|
||||
public ChatUsernameAttribute(string? userName)
|
||||
: base(new MessageChatUsernameFilter(userName, StringComparison.InvariantCulture)) { }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the chat name (first name and optionally last name).
|
||||
/// </summary>
|
||||
public class ChatNameAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the chat name (first name and optionally last name).
|
||||
/// </summary>
|
||||
public class ChatNameAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter messages from chats with specific first and last names.
|
||||
/// </summary>
|
||||
@@ -101,5 +101,4 @@ namespace Telegrator.Annotations
|
||||
/// <param name="lastName">The last name to match (optional)</param>
|
||||
public ChatNameAttribute(string? firstName, string? lastName)
|
||||
: base(new MessageChatNameFilter(firstName, lastName)) { }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,15 +5,15 @@ using Telegrator.Filters;
|
||||
using Telegrator.Attributes;
|
||||
using Telegrator.Core.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract base attribute for filtering message-based updates.
|
||||
/// Supports various message types including regular messages, edited messages, channel posts, and business messages.
|
||||
/// </summary>
|
||||
/// <param name="filters">The filters to apply to messages</param>
|
||||
public abstract class MessageFilterAttribute(params IFilter<Message>[] filters) : UpdateFilterAttribute<Message>(filters)
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract base attribute for filtering message-based updates.
|
||||
/// Supports various message types including regular messages, edited messages, channel posts, and business messages.
|
||||
/// </summary>
|
||||
/// <param name="filters">The filters to apply to messages</param>
|
||||
public abstract class MessageFilterAttribute(params IFilter<Message>[] filters) : UpdateFilterAttribute<Message>(filters)
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the allowed update types that this filter can process.
|
||||
/// </summary>
|
||||
@@ -45,13 +45,13 @@ namespace Telegrator.Annotations
|
||||
_ => null
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on regular expression patterns.
|
||||
/// </summary>
|
||||
public class MessageRegexAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on regular expression patterns.
|
||||
/// </summary>
|
||||
public class MessageRegexAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute with a regex pattern and options.
|
||||
/// </summary>
|
||||
@@ -66,13 +66,13 @@ namespace Telegrator.Annotations
|
||||
/// <param name="regex">The precompiled regular expression</param>
|
||||
public MessageRegexAttribute(Regex regex)
|
||||
: base(new MessageRegexFilter(regex)) { }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that contain dice throws with specific values.
|
||||
/// </summary>
|
||||
public class DiceThrowedAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that contain dice throws with specific values.
|
||||
/// </summary>
|
||||
public class DiceThrowedAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter dice throws with a specific value.
|
||||
/// </summary>
|
||||
@@ -87,41 +87,41 @@ namespace Telegrator.Annotations
|
||||
/// <param name="value">The dice value to match</param>
|
||||
public DiceThrowedAttribute(DiceType diceType, int value)
|
||||
: base(new DiceThrowedFilter(diceType, value)) { }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that are automatically forwarded.
|
||||
/// </summary>
|
||||
public class IsAutomaticFormwardMessageAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that are automatically forwarded.
|
||||
/// </summary>
|
||||
public class IsAutomaticFormwardMessageAttribute()
|
||||
: MessageFilterAttribute(new IsAutomaticFormwardMessageFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent while the user was offline.
|
||||
/// </summary>
|
||||
public class IsFromOfflineMessageAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent while the user was offline.
|
||||
/// </summary>
|
||||
public class IsFromOfflineMessageAttribute()
|
||||
: MessageFilterAttribute(new IsFromOfflineMessageFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering service messages (e.g., user joined, left, etc.).
|
||||
/// </summary>
|
||||
public class IsServiceMessageMessageAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering service messages (e.g., user joined, left, etc.).
|
||||
/// </summary>
|
||||
public class IsServiceMessageMessageAttribute()
|
||||
: MessageFilterAttribute(new IsServiceMessageMessageFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering topic messages in forum chats.
|
||||
/// </summary>
|
||||
public class IsTopicMessageMessageAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering topic messages in forum chats.
|
||||
/// </summary>
|
||||
public class IsTopicMessageMessageAttribute()
|
||||
: MessageFilterAttribute(new IsServiceMessageMessageFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on their entities (mentions, links, etc.).
|
||||
/// </summary>
|
||||
public class MessageHasEntityAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on their entities (mentions, links, etc.).
|
||||
/// </summary>
|
||||
public class MessageHasEntityAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter messages with a specific entity type.
|
||||
/// </summary>
|
||||
@@ -157,5 +157,4 @@ namespace Telegrator.Annotations
|
||||
/// <param name="stringComparison">The string comparison method</param>
|
||||
public MessageHasEntityAttribute(MessageEntityType type, int offset, int? length, string content, StringComparison stringComparison = StringComparison.CurrentCulture)
|
||||
: base(new MessageHasEntityFilter(type, offset, length, content, stringComparison)) { }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,27 +1,26 @@
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages with reply to messages of this bot.
|
||||
/// </summary>
|
||||
public class MeRepliedAttribute()
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages with reply to messages of this bot.
|
||||
/// </summary>
|
||||
public class MeRepliedAttribute()
|
||||
: MessageFilterAttribute(new MeRepliedFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for checking message's reply chain.
|
||||
/// </summary>
|
||||
public class HasReplyAttribute(int replyDepth = 1)
|
||||
/// <summary>
|
||||
/// Attribute for checking message's reply chain.
|
||||
/// </summary>
|
||||
public class HasReplyAttribute(int replyDepth = 1)
|
||||
: MessageFilterAttribute(new MessageHasReplyFilter(replyDepth))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Helper filter class for filters that operate on replied messages.
|
||||
/// Provides functionality to traverse reply chains and access replied message content.
|
||||
/// </summary>
|
||||
/// <param name="replyDepth"></param>
|
||||
public class FromReplyChainAttribute(int replyDepth = 1)
|
||||
/// <summary>
|
||||
/// Helper filter class for filters that operate on replied messages.
|
||||
/// Provides functionality to traverse reply chains and access replied message content.
|
||||
/// </summary>
|
||||
/// <param name="replyDepth"></param>
|
||||
public class FromReplyChainAttribute(int replyDepth = 1)
|
||||
: MessageFilterAttribute(new FromReplyChainFilter(replyDepth))
|
||||
{ }
|
||||
}
|
||||
{ }
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the sender's username.
|
||||
/// </summary>
|
||||
public class FromUsernameAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the sender's username.
|
||||
/// </summary>
|
||||
public class FromUsernameAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter messages from a specific username.
|
||||
/// </summary>
|
||||
@@ -21,13 +21,13 @@ namespace Telegrator.Annotations
|
||||
/// <param name="comparison">The string comparison method</param>
|
||||
public FromUsernameAttribute(string username, StringComparison comparison)
|
||||
: base(new FromUsernameFilter(username, comparison)) { }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the sender's name (first name and optionally last name).
|
||||
/// </summary>
|
||||
public class FromUserAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages based on the sender's name (first name and optionally last name).
|
||||
/// </summary>
|
||||
public class FromUserAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes the attribute to filter messages from a user with specific first and last names.
|
||||
/// </summary>
|
||||
@@ -59,34 +59,33 @@ namespace Telegrator.Annotations
|
||||
/// <param name="comparison">The string comparison method</param>
|
||||
public FromUserAttribute(string firstName, StringComparison comparison)
|
||||
: base(new FromUserFilter(firstName, null, comparison)) { }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages from a specific user ID.
|
||||
/// </summary>
|
||||
/// <param name="userId">The user ID to match</param>
|
||||
public class FromUserIdAttribute(long userId)
|
||||
: MessageFilterAttribute(new FromUserIdFilter(userId))
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent by not bots (users).
|
||||
/// </summary>
|
||||
public class NotFromBotAttribute()
|
||||
: MessageFilterAttribute(new FromBotFilter().Not())
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent by bots.
|
||||
/// </summary>
|
||||
public class FromBotAttribute()
|
||||
: MessageFilterAttribute(new FromBotFilter())
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent by premium users.
|
||||
/// </summary>
|
||||
public class FromPremiumUserAttribute()
|
||||
: MessageFilterAttribute(new FromPremiumUserFilter())
|
||||
{ }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages from a specific user ID.
|
||||
/// </summary>
|
||||
/// <param name="userId">The user ID to match</param>
|
||||
public class FromUserIdAttribute(long userId)
|
||||
: MessageFilterAttribute(new FromUserIdFilter(userId))
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent by not bots (users).
|
||||
/// </summary>
|
||||
public class NotFromBotAttribute()
|
||||
: MessageFilterAttribute(new FromBotFilter().Not())
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent by bots.
|
||||
/// </summary>
|
||||
public class FromBotAttribute()
|
||||
: MessageFilterAttribute(new FromBotFilter())
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages sent by premium users.
|
||||
/// </summary>
|
||||
public class FromPremiumUserAttribute()
|
||||
: MessageFilterAttribute(new FromPremiumUserFilter())
|
||||
{ }
|
||||
|
||||
@@ -1,58 +1,57 @@
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text starts with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should start with</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextStartsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text starts with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should start with</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextStartsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
: MessageFilterAttribute(new TextStartsWithFilter(content, comparison))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text ends with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should end with</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextEndsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text ends with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should end with</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextEndsWithAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
: MessageFilterAttribute(new TextEndsWithFilter(content, comparison))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text contains the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should contain</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextContainsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text contains the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should contain</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextContainsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
: MessageFilterAttribute(new TextContainsFilter(content, comparison))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text equals the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should equal</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextEqualsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text equals the specified content.
|
||||
/// </summary>
|
||||
/// <param name="content">The string that the message text should equal</param>
|
||||
/// <param name="comparison">The string comparison type</param>
|
||||
public class TextEqualsAttribute(string content, StringComparison comparison = StringComparison.InvariantCulture)
|
||||
: MessageFilterAttribute(new TextEqualsFilter(content, comparison))
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that contain any non-empty text.
|
||||
/// </summary>
|
||||
public class HasTextAttribute()
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages that contain any non-empty text.
|
||||
/// </summary>
|
||||
public class HasTextAttribute()
|
||||
: MessageFilterAttribute(new TextNotNullOrEmptyFilter())
|
||||
{ }
|
||||
{ }
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text contains a 'word'.
|
||||
/// 'Word' must be a separate member of the text, and not have any alphabetic characters next to it.
|
||||
/// </summary>
|
||||
/// <param name="word"></param>
|
||||
/// <param name="comparison"></param>
|
||||
/// <param name="startIndex"></param>
|
||||
public class TextContainsWordAttribute(string word, StringComparison comparison = StringComparison.InvariantCulture, int startIndex = 0)
|
||||
/// <summary>
|
||||
/// Attribute for filtering messages where the text contains a 'word'.
|
||||
/// 'Word' must be a separate member of the text, and not have any alphabetic characters next to it.
|
||||
/// </summary>
|
||||
/// <param name="word"></param>
|
||||
/// <param name="comparison"></param>
|
||||
/// <param name="startIndex"></param>
|
||||
public class TextContainsWordAttribute(string word, StringComparison comparison = StringComparison.InvariantCulture, int startIndex = 0)
|
||||
: MessageFilterAttribute(new TextContainsWordFilter(word, comparison, startIndex))
|
||||
{ }
|
||||
}
|
||||
{ }
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
using Telegram.Bot.Types.Enums;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute that says if this handler can await some of await types, that is not listed by its handler base.
|
||||
/// Used for automatic collecting allowed to receiving <see cref="UpdateType"/>'s.
|
||||
/// If you don't use it, you won't be able to await the updates inside handler.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
|
||||
public class MightAwaitAttribute : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute that says if this handler can await some of await types, that is not listed by its handler base.
|
||||
/// Used for automatic collecting allowed to receiving <see cref="UpdateType"/>'s.
|
||||
/// If you don't use it, you won't be able to await the updates inside handler.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
|
||||
public class MightAwaitAttribute : Attribute
|
||||
{
|
||||
private readonly UpdateType[] _updateTypes;
|
||||
|
||||
/// <summary>
|
||||
@@ -23,5 +23,4 @@ namespace Telegrator.Annotations
|
||||
/// <param name="updateTypes"></param>
|
||||
public MightAwaitAttribute(params UpdateType[] updateTypes)
|
||||
=> _updateTypes = updateTypes;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Annotations
|
||||
namespace Telegrator.Annotations;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute for filtering message with command "start" in bot's private chats.
|
||||
/// Allows handlers to respond to "welcome" bot commands.
|
||||
/// </summary>
|
||||
public class WelcomeAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute for filtering message with command "start" in bot's private chats.
|
||||
/// Allows handlers to respond to "welcome" bot commands.
|
||||
/// </summary>
|
||||
public class WelcomeAttribute : MessageFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates new instance of <see cref="WelcomeAttribute"/>
|
||||
/// </summary>
|
||||
@@ -19,5 +19,4 @@ namespace Telegrator.Annotations
|
||||
new CommandAlliasFilter("start"),
|
||||
Filter<Message>.If(ctx => !onlyFirst || ctx.Input.Id == 0))
|
||||
{ }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,16 +1,15 @@
|
||||
namespace Telegrator.Aspects
|
||||
namespace Telegrator.Aspects;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute that specifies a post-execution processor to be executed after the handler.
|
||||
/// The processor type must implement <see cref="IPostProcessor"/> interface.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the post-processor that implements <see cref="IPostProcessor"/>.</typeparam>
|
||||
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
|
||||
public class AfterExecutionAttribute<T> : Attribute where T : IPostProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute that specifies a post-execution processor to be executed after the handler.
|
||||
/// The processor type must implement <see cref="IPostProcessor"/> interface.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the post-processor that implements <see cref="IPostProcessor"/>.</typeparam>
|
||||
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
|
||||
public class AfterExecutionAttribute<T> : Attribute where T : IPostProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the type of the post-processor.
|
||||
/// </summary>
|
||||
public Type ProcessorType => typeof(T);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,16 +1,15 @@
|
||||
namespace Telegrator.Aspects
|
||||
namespace Telegrator.Aspects;
|
||||
|
||||
/// <summary>
|
||||
/// Attribute that specifies a pre-execution processor to be executed before the handler.
|
||||
/// The processor type must implement <see cref="IPreProcessor"/> interface.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the pre-processor that implements <see cref="IPreProcessor"/>.</typeparam>
|
||||
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
|
||||
public class BeforeExecutionAttribute<T> : Attribute where T : IPreProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Attribute that specifies a pre-execution processor to be executed before the handler.
|
||||
/// The processor type must implement <see cref="IPreProcessor"/> interface.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the pre-processor that implements <see cref="IPreProcessor"/>.</typeparam>
|
||||
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
|
||||
public class BeforeExecutionAttribute<T> : Attribute where T : IPreProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the type of the pre-processor.
|
||||
/// </summary>
|
||||
public Type ProcessorType => typeof(T);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Aspects
|
||||
namespace Telegrator.Aspects;
|
||||
|
||||
/// <summary>
|
||||
/// Interface for post-execution processors that are executed after handler execution.
|
||||
/// Implement this interface to add cross-cutting concerns like logging, cleanup, or metrics collection.
|
||||
/// </summary>
|
||||
public interface IPostProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface for post-execution processors that are executed after handler execution.
|
||||
/// Implement this interface to add cross-cutting concerns like logging, cleanup, or metrics collection.
|
||||
/// </summary>
|
||||
public interface IPostProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Executes after the handler's main execution logic.
|
||||
/// </summary>
|
||||
@@ -15,5 +15,4 @@ namespace Telegrator.Aspects
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns>A <see cref="Result"/> indicating the final execution result.</returns>
|
||||
public Task<Result> AfterExecution(IHandlerContainer container, CancellationToken cancellationToken);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Aspects
|
||||
namespace Telegrator.Aspects;
|
||||
|
||||
/// <summary>
|
||||
/// Interface for pre-execution processors that are executed before handler execution.
|
||||
/// Implement this interface to add cross-cutting concerns like validation, logging, or authorization.
|
||||
/// </summary>
|
||||
public interface IPreProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface for pre-execution processors that are executed before handler execution.
|
||||
/// Implement this interface to add cross-cutting concerns like validation, logging, or authorization.
|
||||
/// </summary>
|
||||
public interface IPreProcessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Executes before the handler's main execution logic.
|
||||
/// </summary>
|
||||
@@ -15,5 +15,4 @@ namespace Telegrator.Aspects
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns>A <see cref="Result"/> indicating whether execution should continue or be stopped.</returns>
|
||||
public Task<Result> BeforeExecution(IHandlerContainer container, CancellationToken cancellationToken = default);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,14 +3,14 @@ using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Attributes
|
||||
namespace Telegrator.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// Reactive way to implement a new <see cref="UpdateFilterAttribute{T}"/> of type <typeparamref name="T"/>
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public abstract class FilterAnnotation<T> : UpdateFilterAttribute<T>, IFilter<T>, INamedFilter where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Reactive way to implement a new <see cref="UpdateFilterAttribute{T}"/> of type <typeparamref name="T"/>
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public abstract class FilterAnnotation<T> : UpdateFilterAttribute<T>, IFilter<T>, INamedFilter where T : class
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public virtual bool IsCollectible { get; } = false;
|
||||
|
||||
@@ -35,5 +35,4 @@ namespace Telegrator.Attributes
|
||||
|
||||
/// <inheritdoc/>
|
||||
public abstract bool CanPass(FilterExecutionContext<T> context);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
namespace Telegrator.Attributes
|
||||
namespace Telegrator.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// Enumeration of filter modifiers that can be applied to update filters.
|
||||
/// Defines how filters should be combined and applied in filter chains.
|
||||
/// </summary>
|
||||
[Flags]
|
||||
public enum FilterModifier
|
||||
{
|
||||
/// <summary>
|
||||
/// Enumeration of filter modifiers that can be applied to update filters.
|
||||
/// Defines how filters should be combined and applied in filter chains.
|
||||
/// </summary>
|
||||
[Flags]
|
||||
public enum FilterModifier
|
||||
{
|
||||
/// <summary>
|
||||
/// No modifier applied. Filter is applied as-is.
|
||||
/// </summary>
|
||||
@@ -21,5 +21,4 @@
|
||||
/// NOT modifier. The inverse of this filter should match.
|
||||
/// </summary>
|
||||
Not = 4,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,15 +3,15 @@ using Telegrator.Core.Attributes;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Attributes
|
||||
namespace Telegrator.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract base attribute for defining update filters for a specific type of update target.
|
||||
/// Provides logic for filter composition, modifier processing, and target extraction.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the update target to filter (e.g., Message, Update).</typeparam>
|
||||
public abstract class UpdateFilterAttribute<T> : UpdateFilterAttributeBase where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract base attribute for defining update filters for a specific type of update target.
|
||||
/// Provides logic for filter composition, modifier processing, and target extraction.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the update target to filter (e.g., Message, Update).</typeparam>
|
||||
public abstract class UpdateFilterAttribute<T> : UpdateFilterAttributeBase where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the compiled anonymous filter for this attribute.
|
||||
/// </summary>
|
||||
@@ -81,5 +81,4 @@ namespace Telegrator.Attributes
|
||||
/// <param name="update">The Telegram update</param>
|
||||
/// <returns>The target object to filter, or null if not applicable</returns>
|
||||
public abstract T? GetFilterringTarget(Update update);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
using Telegrator.Core.Attributes;
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Attributes
|
||||
namespace Telegrator.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract base attribute for marking update handler classes.
|
||||
/// Provides a type-safe way to associate handler types with specific update types and importance settings.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the update handler that this attribute is applied to.</typeparam>
|
||||
public abstract class UpdateHandlerAttribute<T> : UpdateHandlerAttributeBase where T : UpdateHandlerBase
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract base attribute for marking update handler classes.
|
||||
/// Provides a type-safe way to associate handler types with specific update types and importance settings.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the update handler that this attribute is applied to.</typeparam>
|
||||
public abstract class UpdateHandlerAttribute<T> : UpdateHandlerAttributeBase where T : UpdateHandlerBase
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes new instance of <see cref="UpdateHandlerAttribute{T}"/>
|
||||
/// </summary>
|
||||
@@ -42,5 +42,4 @@ namespace Telegrator.Attributes
|
||||
/// <param name="importance">The importance level for this handler</param>
|
||||
protected UpdateHandlerAttribute(Type[] types, UpdateType updateType, int importance)
|
||||
: base([.. types, typeof(T)], updateType, importance) { }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,14 +5,14 @@ using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.Handlers;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Core.Attributes
|
||||
namespace Telegrator.Core.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// Defines the <see cref="IFilter{T}"/> to <see cref="Update"/> validation for entry into execution of the <see cref="UpdateHandlerBase"/>
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
|
||||
public abstract class UpdateFilterAttributeBase : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines the <see cref="IFilter{T}"/> to <see cref="Update"/> validation for entry into execution of the <see cref="UpdateHandlerBase"/>
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
|
||||
public abstract class UpdateFilterAttributeBase : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the <see cref="UpdateType"/>'s that <see cref="UpdateHandlerBase"/> processing
|
||||
/// </summary>
|
||||
@@ -43,5 +43,4 @@ namespace Telegrator.Core.Attributes
|
||||
/// <param name="previous"></param>
|
||||
/// <returns></returns>
|
||||
public abstract bool ProcessModifiers(UpdateFilterAttributeBase? previous);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,14 +4,14 @@ using Telegrator.Core.Descriptors;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Core.Attributes
|
||||
namespace Telegrator.Core.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// Defines the <see cref="UpdateType"/>'s and validator (<see cref="IFilter{T}"/>) of the <see cref="Update"/> that <see cref="UpdateHandlerBase"/> will process
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
|
||||
public abstract class UpdateHandlerAttributeBase : Attribute, IFilter<Update>
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines the <see cref="UpdateType"/>'s and validator (<see cref="IFilter{T}"/>) of the <see cref="Update"/> that <see cref="UpdateHandlerBase"/> will process
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
|
||||
public abstract class UpdateHandlerAttributeBase : Attribute, IFilter<Update>
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public bool IsCollectible => GetType().HasPublicProperties();
|
||||
|
||||
@@ -78,5 +78,4 @@ namespace Telegrator.Core.Attributes
|
||||
/// <param name="context">The filter execution context containing the update to validate.</param>
|
||||
/// <returns>True if the update passes validation; otherwise, false.</returns>
|
||||
public abstract bool CanPass(FilterExecutionContext<Update> context);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,14 +7,14 @@ using Telegrator.Core.Handlers;
|
||||
using Telegrator.Handlers;
|
||||
using Telegrator.Handlers.Building;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Descriptor for creating handlers from methods
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate"></typeparam>
|
||||
public class MethodHandlerDescriptor<TUpdate> : HandlerDescriptor where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Descriptor for creating handlers from methods
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate"></typeparam>
|
||||
public class MethodHandlerDescriptor<TUpdate> : HandlerDescriptor where TUpdate : class
|
||||
{
|
||||
private readonly MethodInfo Method;
|
||||
|
||||
/// <summary>
|
||||
@@ -66,5 +66,4 @@ namespace Telegrator.Core.Descriptors
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,13 +4,13 @@ using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.Handlers;
|
||||
using Telegrator.Core.States;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Contains information about a described handler, including its context, client, and execution logic.
|
||||
/// </summary>
|
||||
public class DescribedHandlerDescriptor
|
||||
{
|
||||
/// <summary>
|
||||
/// Contains information about a described handler, including its context, client, and execution logic.
|
||||
/// </summary>
|
||||
public class DescribedHandlerDescriptor
|
||||
{
|
||||
private readonly ManualResetEventSlim ResetEvent = new ManualResetEventSlim(false);
|
||||
|
||||
/// <summary>
|
||||
@@ -133,5 +133,4 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <inheritdoc/>
|
||||
public override string ToString()
|
||||
=> DisplayString ?? From.HandlerType.Name;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
using Telegrator.Aspects;
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Manages the execution of pre and post-execution aspects for a handler.
|
||||
/// This class coordinates between self-processing (handler implements interfaces)
|
||||
/// and typed processing (external processor classes).
|
||||
/// </summary>
|
||||
public sealed class DescriptorAspectsSet
|
||||
{
|
||||
/// <summary>
|
||||
/// Manages the execution of pre and post-execution aspects for a handler.
|
||||
/// This class coordinates between self-processing (handler implements interfaces)
|
||||
/// and typed processing (external processor classes).
|
||||
/// </summary>
|
||||
public sealed class DescriptorAspectsSet
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the type of the external pre-processor, if specified via <see cref="BeforeExecutionAttribute{T}"/>.
|
||||
/// </summary>
|
||||
@@ -76,5 +76,4 @@ namespace Telegrator.Core.Descriptors
|
||||
|
||||
return Result.Ok();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,13 +3,13 @@ using Telegrator.Core.Filters;
|
||||
using Telegrator.Handlers.Diagnostics;
|
||||
using Telegrator.Logging;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a set of filters for a handler descriptor, including update and state keeper validators.
|
||||
/// </summary>
|
||||
public sealed class DescriptorFiltersSet
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a set of filters for a handler descriptor, including update and state keeper validators.
|
||||
/// </summary>
|
||||
public sealed class DescriptorFiltersSet
|
||||
{
|
||||
/// <summary>
|
||||
/// Validator for the update object.
|
||||
/// </summary>
|
||||
@@ -125,7 +125,8 @@ namespace Telegrator.Core.Descriptors
|
||||
if (!anyErrors)
|
||||
return Result.Ok();
|
||||
|
||||
return formReport ? Result.Next() : Result.Fault();
|
||||
return formReport
|
||||
? Result.Next() : Result.Fault();
|
||||
}
|
||||
|
||||
private static bool ExecuteFilter<T>(IFilter<T> filter, FilterExecutionContext<T> context, out Exception? exception) where T : class
|
||||
@@ -141,5 +142,4 @@ namespace Telegrator.Core.Descriptors
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
using Telegrator.Core.Attributes;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Represents an indexer for handler descriptors, containing importance and priority information.
|
||||
/// </summary>
|
||||
public readonly struct DescriptorIndexer(int routerIndex, int importance, int priority) : IComparable<DescriptorIndexer>
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents an indexer for handler descriptors, containing importance and priority information.
|
||||
/// </summary>
|
||||
public readonly struct DescriptorIndexer(int routerIndex, int importance, int priority) : IComparable<DescriptorIndexer>
|
||||
{
|
||||
/// <summary>
|
||||
/// Index of this descriptor when it was added to router
|
||||
/// </summary>
|
||||
@@ -84,5 +84,4 @@ namespace Telegrator.Core.Descriptors
|
||||
{
|
||||
return string.Format("(Ix: {0,2}, Im: {1,2}, Pr: {2,2})", RouterIndex, Importance, Priority);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,13 +4,13 @@ using Telegrator.Core.Attributes;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.Handlers;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Specifies the type of handler descriptor.
|
||||
/// </summary>
|
||||
public enum DescriptorType
|
||||
{
|
||||
/// <summary>
|
||||
/// Specifies the type of handler descriptor.
|
||||
/// </summary>
|
||||
public enum DescriptorType
|
||||
{
|
||||
/// <summary>
|
||||
/// General handler descriptor.
|
||||
/// </summary>
|
||||
@@ -30,20 +30,19 @@ namespace Telegrator.Core.Descriptors
|
||||
/// Singleton handler descriptor (single instance).
|
||||
/// </summary>
|
||||
Singleton
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Describes a handler, its type, filters, and instantiation logic.
|
||||
/// </summary>
|
||||
public class HandlerDescriptor
|
||||
{
|
||||
/// <summary>
|
||||
/// Describes a handler, its type, filters, and instantiation logic.
|
||||
/// </summary>
|
||||
public class HandlerDescriptor
|
||||
{
|
||||
/// <summary>
|
||||
/// The type of the descriptor.
|
||||
/// </summary>
|
||||
public DescriptorType Type
|
||||
{
|
||||
get;
|
||||
private set;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -52,7 +51,6 @@ namespace Telegrator.Core.Descriptors
|
||||
public Type HandlerType
|
||||
{
|
||||
get;
|
||||
private set;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -164,7 +162,7 @@ namespace Telegrator.Core.Descriptors
|
||||
return;
|
||||
|
||||
UpdateHandlerAttributeBase handlerAttribute = HandlerInspector.GetHandlerAttribute(handlerType);
|
||||
if (handlerAttribute.ExpectingHandlerType != null && !handlerAttribute.ExpectingHandlerType.Contains(handlerType.BaseType))
|
||||
if (handlerAttribute.ExpectingHandlerType?.Contains(handlerType.BaseType) == false)
|
||||
throw new ArgumentException(string.Format("This handler attribute cannot be attached to this class. Attribute can be attached on next handlers : {0}", string.Join(", ", handlerAttribute.ExpectingHandlerType.AsEnumerable())));
|
||||
|
||||
IFilter<Update>? stateKeeperAttribute = HandlerInspector.GetStateKeeperAttribute(handlerType);
|
||||
@@ -471,5 +469,4 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <inheritdoc/>
|
||||
public override string ToString()
|
||||
=> DisplayString ?? HandlerType.Name;
|
||||
}
|
||||
}
|
||||
@@ -2,13 +2,13 @@
|
||||
using Telegram.Bot.Types;
|
||||
using Telegram.Bot.Types.Enums;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// The collection containing the <see cref="HandlerDescriptor"/>'s. Used to route <see cref="Update"/>'s in <see cref="IHandlersProvider"/>
|
||||
/// </summary>
|
||||
public sealed class HandlerDescriptorList : IEnumerable<HandlerDescriptor>
|
||||
{
|
||||
/// <summary>
|
||||
/// The collection containing the <see cref="HandlerDescriptor"/>'s. Used to route <see cref="Update"/>'s in <see cref="IHandlersProvider"/>
|
||||
/// </summary>
|
||||
public sealed class HandlerDescriptorList : IEnumerable<HandlerDescriptor>
|
||||
{
|
||||
private readonly object _lock = new object();
|
||||
private readonly SortedList<DescriptorIndexer, HandlerDescriptor> _innerCollection;
|
||||
private readonly TelegratorOptions? _options;
|
||||
@@ -155,5 +155,4 @@ namespace Telegrator.Core.Descriptors
|
||||
{
|
||||
return _innerCollection.Values.GetEnumerator();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
using System.ComponentModel;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.ComponentModel;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using Telegram.Bot.Types;
|
||||
using Telegram.Bot.Types.Enums;
|
||||
@@ -7,13 +10,13 @@ using Telegrator.Aspects;
|
||||
using Telegrator.Core.Attributes;
|
||||
using Telegrator.Core.Filters;
|
||||
|
||||
namespace Telegrator.Core.Descriptors
|
||||
namespace Telegrator.Core.Descriptors;
|
||||
|
||||
/// <summary>
|
||||
/// Provides methods for inspecting handler types and retrieving their attributes and filters.
|
||||
/// </summary>
|
||||
public static class HandlerInspector
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides methods for inspecting handler types and retrieving their attributes and filters.
|
||||
/// </summary>
|
||||
public static class HandlerInspector
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets handler's display name
|
||||
/// </summary>
|
||||
@@ -21,6 +24,11 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <returns></returns>
|
||||
public static string? GetDisplayName(MemberInfo handlerType)
|
||||
{
|
||||
if (handlerType == null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(handlerType));
|
||||
}
|
||||
|
||||
return handlerType.GetCustomAttribute<DisplayNameAttribute>()?.DisplayName;
|
||||
}
|
||||
|
||||
@@ -31,11 +39,26 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <returns>The handler attribute.</returns>
|
||||
public static UpdateHandlerAttributeBase GetHandlerAttribute(MemberInfo handlerType)
|
||||
{
|
||||
// Getting polling handler attribute
|
||||
IEnumerable<UpdateHandlerAttributeBase> handlerAttrs = handlerType.GetCustomAttributes<UpdateHandlerAttributeBase>();
|
||||
if (handlerType == null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(handlerType));
|
||||
}
|
||||
|
||||
//
|
||||
return handlerAttrs.Single();
|
||||
List<UpdateHandlerAttributeBase> handlerAttrs = handlerType.GetCustomAttributes<UpdateHandlerAttributeBase>().ToList();
|
||||
|
||||
if (handlerAttrs.Count == 0)
|
||||
{
|
||||
throw new InvalidOperationException(
|
||||
$"Failed to register handler '{handlerType.Name}': Missing required attribute derived from '{nameof(UpdateHandlerAttributeBase)}'.");
|
||||
}
|
||||
|
||||
if (handlerAttrs.Count > 1)
|
||||
{
|
||||
throw new InvalidOperationException(
|
||||
$"Failed to register handler '{handlerType.Name}': Multiple handler attributes found. A handler must have exactly one attribute derived from '{nameof(UpdateHandlerAttributeBase)}'.");
|
||||
}
|
||||
|
||||
return handlerAttrs[0];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -45,10 +68,16 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <returns>The state keeper attribute, or null if not present.</returns>
|
||||
public static IFilter<Update>? GetStateKeeperAttribute(MemberInfo handlerType)
|
||||
{
|
||||
// Getting polling handler attribute
|
||||
Attribute stateAttr = handlerType.GetCustomAttribute(typeof(StateAttribute<,>));
|
||||
if (handlerType == null)
|
||||
throw new ArgumentNullException(nameof(handlerType));
|
||||
|
||||
Attribute? stateAttr = handlerType.GetCustomAttributes()
|
||||
.FirstOrDefault(attr =>
|
||||
{
|
||||
Type type = attr.GetType();
|
||||
return type.IsGenericType && type.GetGenericTypeDefinition() == typeof(StateAttribute<,>);
|
||||
});
|
||||
|
||||
//
|
||||
return stateAttr as IFilter<Update>;
|
||||
}
|
||||
|
||||
@@ -60,12 +89,19 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <returns>An enumerable of filter attributes.</returns>
|
||||
public static IEnumerable<IFilter<Update>> GetFilterAttributes(MemberInfo handlerType, UpdateType validUpdType)
|
||||
{
|
||||
//
|
||||
IEnumerable<UpdateFilterAttributeBase> filters = handlerType.GetCustomAttributes<UpdateFilterAttributeBase>();
|
||||
if (handlerType == null)
|
||||
throw new ArgumentNullException(nameof(handlerType));
|
||||
|
||||
//
|
||||
if (filters.Any(filterAttr => !filterAttr.AllowedTypes.Contains(validUpdType)))
|
||||
throw new InvalidOperationException();
|
||||
List<UpdateFilterAttributeBase> filters = handlerType.GetCustomAttributes<UpdateFilterAttributeBase>().ToList();
|
||||
|
||||
UpdateFilterAttributeBase? invalidFilter = filters.FirstOrDefault(f => !f.AllowedTypes.Contains(validUpdType));
|
||||
if (invalidFilter != null)
|
||||
{
|
||||
string allowedTypesStr = string.Join(", ", invalidFilter.AllowedTypes);
|
||||
throw new InvalidOperationException(
|
||||
$"Filter conflict on handler '{handlerType.Name}': The filter '{invalidFilter.GetType().Name}' " +
|
||||
$"does not support update type '{validUpdType}'. Allowed types: [{allowedTypesStr}].");
|
||||
}
|
||||
|
||||
UpdateFilterAttributeBase? lastFilterAttribute = null;
|
||||
foreach (UpdateFilterAttributeBase filterAttribute in filters)
|
||||
@@ -78,7 +114,6 @@ namespace Telegrator.Core.Descriptors
|
||||
else
|
||||
{
|
||||
lastFilterAttribute = filterAttribute;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -91,9 +126,24 @@ namespace Telegrator.Core.Descriptors
|
||||
/// <returns>A <see cref="DescriptorAspectsSet"/> containing the aspects configuration.</returns>
|
||||
public static DescriptorAspectsSet GetAspects(Type handlerType)
|
||||
{
|
||||
Type? typedPre = handlerType.GetCustomAttribute(typeof(BeforeExecutionAttribute<>))?.GetType().GetGenericArguments()[0];
|
||||
Type? typedPost = handlerType.GetCustomAttribute(typeof(AfterExecutionAttribute<>))?.GetType().GetGenericArguments()[0];
|
||||
if (handlerType == null)
|
||||
throw new ArgumentNullException(nameof(handlerType));
|
||||
|
||||
Type? typedPre = GetGenericArgumentFromOpenGenericAttribute(handlerType, typeof(BeforeExecutionAttribute<>));
|
||||
Type? typedPost = GetGenericArgumentFromOpenGenericAttribute(handlerType, typeof(AfterExecutionAttribute<>));
|
||||
|
||||
return new DescriptorAspectsSet(typedPre, typedPost);
|
||||
}
|
||||
|
||||
private static Type? GetGenericArgumentFromOpenGenericAttribute(Type handlerType, Type openGenericAttributeType)
|
||||
{
|
||||
Attribute? attribute = handlerType.GetCustomAttributes()
|
||||
.FirstOrDefault(attr =>
|
||||
{
|
||||
Type type = attr.GetType();
|
||||
return type.IsGenericType && type.GetGenericTypeDefinition() == openGenericAttributeType;
|
||||
});
|
||||
|
||||
return attribute?.GetType().GetGenericArguments().FirstOrDefault();
|
||||
}
|
||||
}
|
||||
@@ -2,13 +2,13 @@
|
||||
using Telegrator.Filters;
|
||||
using Telegrator.Logging;
|
||||
|
||||
namespace Telegrator.Core.Filters
|
||||
namespace Telegrator.Core.Filters;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a compiled filter that applies a set of filters to an anonymous target type.
|
||||
/// </summary>
|
||||
public class AnonymousCompiledFilter : Filter<Update>, INamedFilter
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a compiled filter that applies a set of filters to an anonymous target type.
|
||||
/// </summary>
|
||||
public class AnonymousCompiledFilter : Filter<Update>, INamedFilter
|
||||
{
|
||||
private readonly Func<FilterExecutionContext<Update>, object, bool> FilterAction;
|
||||
private readonly Func<Update, object?> GetFilterringTarget;
|
||||
private readonly string _name;
|
||||
@@ -105,5 +105,4 @@ namespace Telegrator.Core.Filters
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
using Telegrator.Filters;
|
||||
using Telegrator.Logging;
|
||||
|
||||
namespace Telegrator.Core.Filters
|
||||
namespace Telegrator.Core.Filters;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a filter that applies a filter action to an anonymous target type extracted from an update.
|
||||
/// </summary>
|
||||
public class AnonymousTypeFilter : Filter<Update>, INamedFilter
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a filter that applies a filter action to an anonymous target type extracted from an update.
|
||||
/// </summary>
|
||||
public class AnonymousTypeFilter : Filter<Update>, INamedFilter
|
||||
{
|
||||
private static readonly Type[] IgnoreLog = [typeof(CompiledFilter<>), typeof(AnonymousCompiledFilter), typeof(AnonymousTypeFilter)];
|
||||
|
||||
private readonly Func<FilterExecutionContext<Update>, object, bool> FilterAction;
|
||||
@@ -106,5 +106,4 @@ namespace Telegrator.Core.Filters
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
using Telegrator.Filters;
|
||||
using Telegrator.Logging;
|
||||
|
||||
namespace Telegrator.Core.Filters
|
||||
namespace Telegrator.Core.Filters;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a filter that composes multiple filters and passes only if all of them pass.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the input for the filter.</typeparam>
|
||||
public class CompiledFilter<T> : Filter<T>, INamedFilter where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a filter that composes multiple filters and passes only if all of them pass.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the input for the filter.</typeparam>
|
||||
public class CompiledFilter<T> : Filter<T>, INamedFilter where T : class
|
||||
{
|
||||
private readonly IFilter<T>[] Filters;
|
||||
private readonly string _name;
|
||||
|
||||
@@ -60,5 +60,4 @@ namespace Telegrator.Core.Filters
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
using System.Collections;
|
||||
|
||||
namespace Telegrator.Core.Filters
|
||||
namespace Telegrator.Core.Filters;
|
||||
|
||||
/// <summary>
|
||||
/// The list containing filters worked out during Polling to further obtain additional filtering information
|
||||
/// </summary>
|
||||
public class CompletedFiltersList : IEnumerable<IFilterCollectable>
|
||||
{
|
||||
/// <summary>
|
||||
/// The list containing filters worked out during Polling to further obtain additional filtering information
|
||||
/// </summary>
|
||||
public class CompletedFiltersList : IEnumerable<IFilterCollectable>
|
||||
{
|
||||
private readonly List<IFilterCollectable> CompletedFilters = [];
|
||||
|
||||
/// <summary>
|
||||
@@ -82,5 +82,4 @@ namespace Telegrator.Core.Filters
|
||||
|
||||
/// <inheritdoc/>
|
||||
IEnumerator IEnumerable.GetEnumerator() => CompletedFilters.GetEnumerator();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
using Telegram.Bot.Types;
|
||||
using Telegram.Bot.Types.Enums;
|
||||
|
||||
namespace Telegrator.Core.Filters
|
||||
namespace Telegrator.Core.Filters;
|
||||
|
||||
/// <summary>
|
||||
/// Represents the context for filter execution, including update, input, and additional data.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the input for the filter.</typeparam>
|
||||
public class FilterExecutionContext<T> where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents the context for filter execution, including update, input, and additional data.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the input for the filter.</typeparam>
|
||||
public class FilterExecutionContext<T> where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the <see cref="ITelegramBotInfo"/> for the current context.
|
||||
/// </summary>
|
||||
@@ -82,5 +82,4 @@ namespace Telegrator.Core.Filters
|
||||
/// <returns>A new <see cref="FilterExecutionContext{C}"/> instance.</returns>
|
||||
public FilterExecutionContext<C> CreateChild<C>(C input) where C : class
|
||||
=> new FilterExecutionContext<C>(UpdateRouter, BotInfo, Update, input, Data, CompletedFilters);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,39 +1,50 @@
|
||||
namespace Telegrator.Core.Filters
|
||||
namespace Telegrator.Core.Filters;
|
||||
|
||||
/// <summary>
|
||||
/// Interface for filters that have a name for identification and debugging purposes.
|
||||
/// </summary>
|
||||
public interface INamedFilter
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface for filters that have a name for identification and debugging purposes.
|
||||
/// </summary>
|
||||
public interface INamedFilter
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the name of the filter.
|
||||
/// </summary>
|
||||
public string Name { get; }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Interface for filters that can be collected into a completed filters list.
|
||||
/// Provides information about whether a filter should be tracked during execution.
|
||||
/// </summary>
|
||||
public interface IFilterCollectable
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface for filters that can be collected into a completed filters list.
|
||||
/// Provides information about whether a filter should be tracked during execution.
|
||||
/// </summary>
|
||||
public interface IFilterCollectable
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets if filter can be collected to <see cref="CompletedFiltersList"/>
|
||||
/// </summary>
|
||||
public bool IsCollectible { get; }
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a filter for a specific update type.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the update to filter.</typeparam>
|
||||
public interface IFilter<T> : IFilterCollectable where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a filter for a specific update type.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the update to filter.</typeparam>
|
||||
public interface IFilter<T> : IFilterCollectable where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Determines whether the filter can pass for the given context.
|
||||
/// </summary>
|
||||
/// <param name="info">The filter execution context.</param>
|
||||
/// <returns>True if the filter passes; otherwise, false.</returns>
|
||||
public bool CanPass(FilterExecutionContext<T> info);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a filter that joins multiple filters together.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the input for the filter.</typeparam>
|
||||
public interface IJoinedFilter<T> : IFilter<T> where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the array of joined filters.
|
||||
/// </summary>
|
||||
public IFilter<T>[] Filters { get; }
|
||||
}
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
namespace Telegrator.Core.Filters
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a filter that joins multiple filters together.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the input for the filter.</typeparam>
|
||||
public interface IJoinedFilter<T> : IFilter<T> where T : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the array of joined filters.
|
||||
/// </summary>
|
||||
public IFilter<T>[] Filters { get; }
|
||||
}
|
||||
}
|
||||
@@ -6,13 +6,13 @@ using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.States;
|
||||
using Telegrator.Handlers;
|
||||
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract handler for Telegram updates of type <typeparamref name="TUpdate"/>.
|
||||
/// </summary>
|
||||
public abstract class AbstractUpdateHandler<TUpdate> : UpdateHandlerBase, IHandlerContainerFactory, IAbstractUpdateHandler<TUpdate> where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract handler for Telegram updates of type <typeparamref name="TUpdate"/>.
|
||||
/// </summary>
|
||||
public abstract class AbstractUpdateHandler<TUpdate> : UpdateHandlerBase, IHandlerContainerFactory, IAbstractUpdateHandler<TUpdate> where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Handler container for the current update.
|
||||
/// </summary>
|
||||
@@ -92,5 +92,4 @@ namespace Telegrator.Core.Handlers
|
||||
/// <param name="cancellation">Cancellation token.</param>
|
||||
/// <returns>A task representing the asynchronous operation.</returns>
|
||||
public abstract Task<Result> Execute(IHandlerContainer<TUpdate> container, CancellationToken cancellation);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,15 +6,15 @@ using Telegrator.Core.Descriptors;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Handlers;
|
||||
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Abstract base class for handlers that support branching execution based on different methods.
|
||||
/// Allows multiple handler methods to be defined in a single class, each with its own filters.
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate">The type of update being handled.</typeparam>
|
||||
public abstract class BranchingUpdateHandler<TUpdate> : AbstractUpdateHandler<TUpdate>, IHandlerContainerFactory, ICustomDescriptorsProvider where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Abstract base class for handlers that support branching execution based on different methods.
|
||||
/// Allows multiple handler methods to be defined in a single class, each with its own filters.
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate">The type of update being handled.</typeparam>
|
||||
public abstract class BranchingUpdateHandler<TUpdate> : AbstractUpdateHandler<TUpdate>, IHandlerContainerFactory, ICustomDescriptorsProvider where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// The method info for the current branch being executed.
|
||||
/// </summary>
|
||||
@@ -161,5 +161,4 @@ namespace Telegrator.Core.Handlers
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,17 +5,17 @@ using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.States;
|
||||
using Telegrator.Filters;
|
||||
|
||||
namespace Telegrator.Core.Handlers.Building
|
||||
namespace Telegrator.Core.Handlers.Building;
|
||||
|
||||
/// <summary>
|
||||
/// Base class for building handler descriptors and managing handler filters.
|
||||
/// </summary>
|
||||
public abstract class HandlerBuilderBase(Type buildingHandlerType, UpdateType updateType, IHandlersCollection? handlerCollection) : IHandlerBuilder
|
||||
{
|
||||
/// <summary>
|
||||
/// Base class for building handler descriptors and managing handler filters.
|
||||
/// </summary>
|
||||
public abstract class HandlerBuilderBase(Type buildingHandlerType, UpdateType updateType, IHandlersCollection? handlerCollection) : IHandlerBuilder
|
||||
{
|
||||
private static int HandlerServiceKeyIndex = 0;
|
||||
|
||||
/// <summary>
|
||||
/// <see cref="IHandlersCollection"/> to ehich new builded handlers is adding
|
||||
/// <see cref="IHandlersCollection"/> to which new builded handlers is adding
|
||||
/// </summary>
|
||||
protected readonly IHandlersCollection? HandlerCollection = handlerCollection;
|
||||
|
||||
@@ -176,5 +176,4 @@ namespace Telegrator.Core.Handlers.Building
|
||||
AnonymousCompiledFilter compiledPollingFilter = AnonymousCompiledFilter.Compile(filters, getFilterringTarget);
|
||||
Filters.Add(compiledPollingFilter);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
using Telegrator.Core.States;
|
||||
|
||||
namespace Telegrator.Core.Handlers.Building
|
||||
namespace Telegrator.Core.Handlers.Building;
|
||||
|
||||
/// <summary>
|
||||
/// Defines a builder for awaiting handler logic for a specific update type.
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate">The type of update to await.</typeparam>
|
||||
public interface IAwaiterHandlerBuilder<TUpdate> : IHandlerBuilder where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines a builder for awaiting handler logic for a specific update type.
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate">The type of update to await.</typeparam>
|
||||
public interface IAwaiterHandlerBuilder<TUpdate> : IHandlerBuilder where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Awaits an update using the specified key resolver and cancellation token.
|
||||
/// </summary>
|
||||
@@ -15,5 +15,4 @@ namespace Telegrator.Core.Handlers.Building
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
/// <returns>A <see cref="Task{TUpdate}"/> representing the awaited update.</returns>
|
||||
public Task<TUpdate> Await(IStateKeyResolver keyResolver, CancellationToken cancellationToken = default);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.States;
|
||||
|
||||
namespace Telegrator.Core.Handlers.Building
|
||||
namespace Telegrator.Core.Handlers.Building;
|
||||
|
||||
/// <summary>
|
||||
/// Defines builder actions for configuring handler builders.
|
||||
/// </summary>
|
||||
public interface IHandlerBuilder
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines builder actions for configuring handler builders.
|
||||
/// </summary>
|
||||
public interface IHandlerBuilder
|
||||
{
|
||||
/// <summary>
|
||||
/// Sets the update validating action for the handler.
|
||||
/// </summary>
|
||||
@@ -82,5 +82,4 @@ namespace Telegrator.Core.Handlers.Building
|
||||
/// <returns>The builder instance.</returns>
|
||||
public void AddTargetedFilters<TFilterTarget>(Func<Update, TFilterTarget?> getFilterringTarget, params IFilter<TFilterTarget>[] filters)
|
||||
where TFilterTarget : class;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,17 +1,16 @@
|
||||
using Telegrator.Handlers.Building;
|
||||
|
||||
namespace Telegrator.Core.Handlers.Building
|
||||
namespace Telegrator.Core.Handlers.Building;
|
||||
|
||||
/// <summary>
|
||||
/// Defines a builder for regular handler logic for a specific update type.
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate">The type of update to handle.</typeparam>
|
||||
public interface IRegularHandlerBuilder<TUpdate> : IHandlerBuilder where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines a builder for regular handler logic for a specific update type.
|
||||
/// </summary>
|
||||
/// <typeparam name="TUpdate">The type of update to handle.</typeparam>
|
||||
public interface IRegularHandlerBuilder<TUpdate> : IHandlerBuilder where TUpdate : class
|
||||
{
|
||||
/// <summary>
|
||||
/// Builds the handler logic using the specified execution delegate.
|
||||
/// </summary>
|
||||
/// <param name="executeHandler">The delegate to execute the handler logic.</param>
|
||||
public IHandlersCollection Build(AbstractHandlerAction<TUpdate> executeHandler);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
using Telegram.Bot.Types;
|
||||
using Telegrator.Core.Filters;
|
||||
|
||||
namespace Telegrator.Core.Handlers.Building
|
||||
{
|
||||
/// <summary>
|
||||
/// Delegate for validating an update in a filter context.
|
||||
/// </summary>
|
||||
/// <param name="context">The filter execution context.</param>
|
||||
/// <returns>True if the update is valid; otherwise, false.</returns>
|
||||
public delegate bool UpdateValidateAction(FilterExecutionContext<Update> context);
|
||||
namespace Telegrator.Core.Handlers.Building;
|
||||
|
||||
/// <summary>
|
||||
/// Filter that uses a delegate to validate updates.
|
||||
/// </summary>
|
||||
public class UpdateValidateFilter : IFilter<Update>
|
||||
{
|
||||
/// <summary>
|
||||
/// Delegate for validating an update in a filter context.
|
||||
/// </summary>
|
||||
/// <param name="context">The filter execution context.</param>
|
||||
/// <returns>True if the update is valid; otherwise, false.</returns>
|
||||
public delegate bool UpdateValidateAction(FilterExecutionContext<Update> context);
|
||||
|
||||
/// <summary>
|
||||
/// Filter that uses a delegate to validate updates.
|
||||
/// </summary>
|
||||
public class UpdateValidateFilter : IFilter<Update>
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether this filter is collectable. Always false for this filter.
|
||||
/// </summary>
|
||||
@@ -37,5 +37,4 @@ namespace Telegrator.Core.Handlers.Building
|
||||
/// <returns>True if the filter passes; otherwise, false.</returns>
|
||||
public bool CanPass(FilterExecutionContext<Update> info)
|
||||
=> UpdateValidateAction.Invoke(info);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,13 +3,13 @@ using Telegram.Bot.Types;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.States;
|
||||
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Represents an empty handler container that throws <see cref="NotImplementedException"/> for all members.
|
||||
/// </summary>
|
||||
public class EmptyHandlerContainer : IHandlerContainer
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents an empty handler container that throws <see cref="NotImplementedException"/> for all members.
|
||||
/// </summary>
|
||||
public class EmptyHandlerContainer : IHandlerContainer
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public Update HandlingUpdate => throw new NotImplementedException();
|
||||
|
||||
@@ -27,5 +27,4 @@ namespace Telegrator.Core.Handlers
|
||||
|
||||
/// <inheritdoc/>
|
||||
public IStateStorage StateStorage => throw new NotImplementedException();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a token that tracks the lifetime of a handler instance.
|
||||
/// </summary>
|
||||
public class HandlerLifetimeToken
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a token that tracks the lifetime of a handler instance.
|
||||
/// </summary>
|
||||
public class HandlerLifetimeToken
|
||||
{
|
||||
/// <summary>
|
||||
/// Event triggered when the handler's lifetime has ended.
|
||||
/// </summary>
|
||||
@@ -23,5 +23,4 @@
|
||||
IsEnded = true;
|
||||
OnLifetimeEnded?.Invoke(this);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,14 +3,14 @@ using Telegram.Bot.Types;
|
||||
using Telegrator.Core.Filters;
|
||||
using Telegrator.Core.States;
|
||||
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Interface for handler containers that provide context and resources for update handlers.
|
||||
/// Contains all necessary information and services that handlers need during execution.
|
||||
/// </summary>
|
||||
public interface IHandlerContainer
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface for handler containers that provide context and resources for update handlers.
|
||||
/// Contains all necessary information and services that handlers need during execution.
|
||||
/// </summary>
|
||||
public interface IHandlerContainer
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the <see cref="Update"/> being handled.
|
||||
/// </summary>
|
||||
@@ -40,5 +40,4 @@ namespace Telegrator.Core.Handlers
|
||||
/// Gets the <see cref="IStateStorage"/> for state managment.
|
||||
/// </summary>
|
||||
public IStateStorage StateStorage { get; }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,18 +1,17 @@
|
||||
using Telegrator.Core.Descriptors;
|
||||
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Factory interface for creating handler containers.
|
||||
/// Provides a way to create handler containers with specific providers and handler information.
|
||||
/// </summary>
|
||||
public interface IHandlerContainerFactory
|
||||
{
|
||||
/// <summary>
|
||||
/// Factory interface for creating handler containers.
|
||||
/// Provides a way to create handler containers with specific providers and handler information.
|
||||
/// </summary>
|
||||
public interface IHandlerContainerFactory
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates a new <see cref="IHandlerContainer"/> for the specified awaiting provider and handler info.
|
||||
/// </summary>
|
||||
/// <param name="handlerInfo">The <see cref="DescribedHandlerDescriptor"/> for the handler.</param>
|
||||
/// <returns>A new <see cref="IHandlerContainer"/> instance.</returns>
|
||||
public IHandlerContainer CreateContainer(DescribedHandlerDescriptor handlerInfo);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,13 +4,13 @@ using Telegram.Bot.Types.Enums;
|
||||
using Telegrator.Core.Descriptors;
|
||||
using Telegrator.Handlers.Diagnostics;
|
||||
|
||||
namespace Telegrator.Core.Handlers
|
||||
namespace Telegrator.Core.Handlers;
|
||||
|
||||
/// <summary>
|
||||
/// Base class for update handlers, providing execution and lifetime management for Telegram updates.
|
||||
/// </summary>
|
||||
public abstract class UpdateHandlerBase(UpdateType handlingUpdateType) : IUpdateHandlerBase
|
||||
{
|
||||
/// <summary>
|
||||
/// Base class for update handlers, providing execution and lifetime management for Telegram updates.
|
||||
/// </summary>
|
||||
public abstract class UpdateHandlerBase(UpdateType handlingUpdateType) : IUpdateHandlerBase
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the <see cref="UpdateType"/> that this handler processes.
|
||||
/// </summary>
|
||||
@@ -56,7 +56,7 @@ namespace Telegrator.Core.Handlers
|
||||
.ExecutePre(this, container, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
if (!preResult.Positive)
|
||||
if (!preResult.Success)
|
||||
return preResult;
|
||||
}
|
||||
catch (NotImplementedException)
|
||||
@@ -69,7 +69,7 @@ namespace Telegrator.Core.Handlers
|
||||
{
|
||||
// Executing handler
|
||||
Result execResult = await ExecuteInternal(container, cancellationToken).ConfigureAwait(false);
|
||||
if (!execResult.Positive)
|
||||
if (!execResult.Success)
|
||||
return execResult;
|
||||
}
|
||||
catch (NotImplementedException)
|
||||
@@ -86,7 +86,7 @@ namespace Telegrator.Core.Handlers
|
||||
.ExecutePost(this, container, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
if (!postResult.Positive)
|
||||
if (!postResult.Success)
|
||||
return postResult;
|
||||
}
|
||||
}
|
||||
@@ -166,7 +166,7 @@ namespace Telegrator.Core.Handlers
|
||||
/// <returns></returns>
|
||||
public virtual Task<Result> FiltersFallback(FiltersFallbackReport report, ITelegramBotClient client, CancellationToken cancellationToken = default)
|
||||
{
|
||||
return Task.FromResult(Result.Ok());
|
||||
return Task.FromResult(Result.Next());
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -178,5 +178,4 @@ namespace Telegrator.Core.Handlers
|
||||
if (Dispose(true))
|
||||
GC.SuppressFinalize(this);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user