Add code, Readme and LICENSE
This commit is contained in:
commit
e2ff08d1fb
GPG key ID:
9D9CE43650FF2BAA
8 changed files with 2176 additions and 0 deletions
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
{one line to give the program's name and a brief idea of what it does.}
|
||||
Copyright (C) {year} {name of author}
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://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:
|
||||
|
||||
{project} Copyright (C) {year} {fullname}
|
||||
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
|
||||
<http://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
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
13
README.md
Normal file
13
README.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# mau_mau_bot_bot
|
||||
[](./LICENSE)
|
||||
|
||||
This user bot can play uno with other humans. (Python3 only)
|
||||
|
||||
## Telethon
|
||||
The bot uses [Telethon](https://github.com/LonamiWebs/Telethon), a Pure Python 3 MTProto API Telegram client library.
|
||||
Please follow [this](https://telethon.readthedocs.io/en/stable/extra/basic/installation.html#installation) guide to install Telethon, and [create your api id and hash](https://telethon.readthedocs.io/en/stable/extra/basic/creating-a-client.html).
|
||||
Then place your settings in config.py.
|
||||
Run the bot with python3 bot.py.
|
||||
|
||||
## Contributing
|
||||
* Copyright © 2018 JerryXiao
|
||||
550
bot.py
Executable file
550
bot.py
Executable file
|
|
@ -0,0 +1,550 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
from telethon.sync import TelegramClient
|
||||
from telethon import events
|
||||
import re
|
||||
import logging
|
||||
import time
|
||||
import sys
|
||||
from telethon.tl.functions.messages import GetInlineBotResultsRequest, SendInlineBotResultRequest, SendMessageRequest, SetTypingRequest
|
||||
from telethon.tl.types import SendMessageTypingAction, SendMessageCancelAction
|
||||
from telethon.tl.types import PeerUser, PeerChat, PeerChannel, User as _User, Chat as _Chat, Channel as _Channel
|
||||
from telethon.errors.rpcbaseerrors import RPCError
|
||||
import asyncio
|
||||
|
||||
from game import Game
|
||||
from card import GREY_SET_ID
|
||||
|
||||
game = Game()
|
||||
|
||||
from config import api_id, api_hash, PHONE, session_name, unobot_username, default_delay, print_cards, disable_all_commands, game_autostart, unogroup_chatname, game_consts
|
||||
|
||||
game.delay = default_delay
|
||||
|
||||
SAFE_MODE = False
|
||||
|
||||
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
client = TelegramClient(session_name, api_id, api_hash, sequential_updates=True, use_ipv6=False)
|
||||
while not client.start(phone=PHONE):
|
||||
logger.info("Start failed. Retrying...")
|
||||
time.sleep(5)
|
||||
logger.info("Started!")
|
||||
|
||||
my_username = client.get_me().username
|
||||
my_firstname = client.get_me().first_name
|
||||
|
||||
# parse game_consts
|
||||
for key in game_consts:
|
||||
game_consts[key] = game_consts[key].replace('%username%', my_username)
|
||||
game_consts[key] = game_consts[key].replace('%firstname%', my_firstname)
|
||||
|
||||
|
||||
def _print(*args, **kwargs):
|
||||
print(*args, **kwargs)
|
||||
sys.stdout.flush()
|
||||
|
||||
logger.info("Getting dialogs")
|
||||
for dialog in client.iter_dialogs():
|
||||
pass
|
||||
#_print(dialog)
|
||||
logger.info("Done getting dialogs")
|
||||
|
||||
unobot = client.get_input_entity(unobot_username)
|
||||
unochat = None
|
||||
if unogroup_chatname:
|
||||
unochat = client.get_input_entity(unogroup_chatname)
|
||||
|
||||
|
||||
async def startgame_task():
|
||||
logger.info("startgame_task run")
|
||||
if not game.is_playing:
|
||||
await client(SendMessageRequest(unochat, "/new@{}".format(unobot_username)))
|
||||
await asyncio.sleep(60)
|
||||
game.delay = 8
|
||||
#try starting the game
|
||||
await client(SendMessageRequest(unochat, "/start@{}".format(unobot_username)))
|
||||
logger.info("startgame_task game started")
|
||||
|
||||
async def task_run():
|
||||
import schedule_async as schedule
|
||||
""" To start game automatically
|
||||
"""
|
||||
at_times = ("9:00", "12:00", "16:00", "18:00", "19:00", "20:00", "21:30")
|
||||
logger.info("Coroutine task_run started")
|
||||
for at_time in at_times:
|
||||
schedule.every().day.at(at_time).do(startgame_task)
|
||||
# for debug only
|
||||
#schedule.every(20).seconds.do(testjob)
|
||||
while True:
|
||||
await schedule.run_pending()
|
||||
await asyncio.sleep(60)
|
||||
|
||||
async def inline_query(fail=None):
|
||||
""" This part handles interaction with unobot.
|
||||
"""
|
||||
# typing @unobot and a space :)
|
||||
async def set_typing(cancel=False):
|
||||
'''let others see you are typing'''
|
||||
if cancel:
|
||||
try:
|
||||
await client(SetTypingRequest(
|
||||
peer = unochat,
|
||||
action = SendMessageCancelAction()
|
||||
))
|
||||
except Exception as err:
|
||||
print(err)
|
||||
else:
|
||||
try:
|
||||
await client(SetTypingRequest(
|
||||
peer = unochat,
|
||||
action = SendMessageTypingAction()
|
||||
))
|
||||
except Exception as err:
|
||||
print(err)
|
||||
async def typing_sleep(seconds):
|
||||
''' Telegram cancels your typing notification in several secs
|
||||
we also call set_typing in the beginning
|
||||
'''
|
||||
INTERVAL = 5
|
||||
seconds = int(seconds)
|
||||
if seconds <= 0:
|
||||
await set_typing()
|
||||
else:
|
||||
if seconds <= INTERVAL:
|
||||
await set_typing()
|
||||
await asyncio.sleep(INTERVAL)
|
||||
else:
|
||||
rounds = int(seconds/INTERVAL)
|
||||
for i in range(rounds):
|
||||
await asyncio.sleep(INTERVAL)
|
||||
await set_typing()
|
||||
assert (seconds - rounds * INTERVAL) > 0
|
||||
await asyncio.sleep(int(seconds - rounds * INTERVAL))
|
||||
await set_typing()
|
||||
for tries in range(10):
|
||||
try:
|
||||
bot_results = await client(GetInlineBotResultsRequest(
|
||||
unobot, unochat, '', ''
|
||||
))
|
||||
except RPCError:
|
||||
await asyncio.sleep(1)
|
||||
else:
|
||||
break
|
||||
if bot_results.results:
|
||||
query_id = bot_results.query_id
|
||||
for result in bot_results.results:
|
||||
# is it a grey card? if so, get it.
|
||||
try:
|
||||
if hasattr(result.document.attributes[1], 'stickerset'):
|
||||
try:
|
||||
(result_id, anti_cheat) = result.id.split(':')
|
||||
except:
|
||||
pass
|
||||
else:
|
||||
if len(result_id) == 36:
|
||||
# uuid result for grey cards
|
||||
sset = result.document.attributes[1].stickerset
|
||||
if str(sset.id) == GREY_SET_ID:
|
||||
game.add_grey_card(result.document.id)
|
||||
continue
|
||||
except (AttributeError, IndexError):
|
||||
pass
|
||||
except Exception as err:
|
||||
logger.critical('Exception while getting grey cards, {}'.format(str(err)))
|
||||
# get ordinary cards
|
||||
try:
|
||||
(result_id, anti_cheat) = result.id.split(':')
|
||||
except ValueError:
|
||||
if fail is None:
|
||||
fail = 1
|
||||
await asyncio.sleep(1)
|
||||
await inline_query(fail=fail)
|
||||
return
|
||||
elif fail < 5:
|
||||
fail += 1
|
||||
await asyncio.sleep(1)
|
||||
await inline_query(fail=fail)
|
||||
return
|
||||
else:
|
||||
return
|
||||
game.add_card(result_id, anti_cheat)
|
||||
if game.delay:
|
||||
await typing_sleep(game.delay)
|
||||
if print_cards:
|
||||
_print(game.print_cards())
|
||||
callback_id = game.play_card()
|
||||
if not callback_id:
|
||||
callback_id = 'draw'
|
||||
await client(SendMessageRequest(unochat, 'Error: No card can be played. Leaving game'))
|
||||
await client(SendMessageRequest(unochat, "/leave@{}".format(unobot_username)))
|
||||
return
|
||||
for tries in range(6):
|
||||
try:
|
||||
await client(SendInlineBotResultRequest(
|
||||
unochat,
|
||||
query_id,
|
||||
"{}:{}".format(callback_id, game.anti_cheat)
|
||||
))
|
||||
except Exception as err:
|
||||
logger.critical('Exception: {}'.format(err))
|
||||
#await client(SendMessageRequest(unochat, 'Exception: {}'.format(err)))
|
||||
else:
|
||||
break
|
||||
await set_typing(cancel=True)
|
||||
game.rotate_deck()
|
||||
return True
|
||||
else:
|
||||
logger.critical('Bad inline result from bot')
|
||||
_print(bot_results)
|
||||
return None
|
||||
|
||||
|
||||
def safety_check(chat_id, force=False):
|
||||
if SAFE_MODE or force:
|
||||
safe_ids = [-1001000100100, ]
|
||||
if chat_id in safe_ids:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
else:
|
||||
return True
|
||||
|
||||
def commandify(text, my_commands=True, wild_card=True):
|
||||
args = text.split()
|
||||
if not args:
|
||||
return [None]
|
||||
match = re.match(r'/([^@]+$)', args[0])
|
||||
if match:
|
||||
command = match.group(1)
|
||||
if not wild_card:
|
||||
return [None]
|
||||
username = my_username
|
||||
args = args[1:]
|
||||
return [command, username, args]
|
||||
else:
|
||||
match = re.match(r'/([^@]+)@([^@]+)$', args[0])
|
||||
if match:
|
||||
username = match.group(2)
|
||||
command = match.group(1)
|
||||
args = args[1:]
|
||||
if username != my_username and my_commands == True:
|
||||
return [None]
|
||||
else:
|
||||
return [command, username, args]
|
||||
else:
|
||||
return [None]
|
||||
|
||||
def get_peer_id(peer, reverse=False):
|
||||
'''
|
||||
reverse = False:
|
||||
peer: telethon.tl.types.PeerUser, PeerChat, PeerChannel / User, Chat, Channel
|
||||
return int (-100xxxx)
|
||||
reverse = True:
|
||||
peer: int (-100xxxx)
|
||||
return int (xxxx)
|
||||
'''
|
||||
if reverse:
|
||||
str_peer = str(peer)
|
||||
if str_peer.startswith("-100"):
|
||||
orig_id = str_peer[4:]
|
||||
return orig_id
|
||||
else:
|
||||
return peer
|
||||
else:
|
||||
peerid = None
|
||||
if type(peer) is PeerChannel:
|
||||
peerid = getattr(peer, 'channel_id')
|
||||
peerid = int('-100{}'.format(peerid))
|
||||
elif type(peer) in [ _Channel, _Chat]:
|
||||
peerid = getattr(peer, 'id')
|
||||
peerid = int('-100{}'.format(peerid))
|
||||
elif type(peer) is PeerChat:
|
||||
peerid = getattr(peer, 'chat_id')
|
||||
peerid = int('-100{}'.format(peerid))
|
||||
elif type(peer) is PeerUser:
|
||||
peerid = getattr(peer, 'user_id')
|
||||
elif type(peer) is _User:
|
||||
peerid = getattr(peer, 'id')
|
||||
else:
|
||||
_print("Error: ", peer)
|
||||
if not peerid:
|
||||
_print('W: Peer_id is none')
|
||||
return peerid
|
||||
|
||||
|
||||
class EmptyChat:
|
||||
def __init__(self, title=None):
|
||||
self.title = title
|
||||
|
||||
class EmptyUser:
|
||||
def __init__(self, first_name="None", last_name=None, username=None):
|
||||
self.first_name = first_name
|
||||
self.last_name = last_name
|
||||
self.username = username
|
||||
|
||||
def display_username(user, atuser=False, shorten=False):
|
||||
if user.first_name and user.last_name:
|
||||
name = "{} {}".format(user.first_name, user.last_name)
|
||||
else:
|
||||
name = user.first_name
|
||||
if shorten:
|
||||
return name
|
||||
if user.username:
|
||||
if atuser:
|
||||
name += " (@{})".format(user.username)
|
||||
else:
|
||||
name += " ({})".format(user.username)
|
||||
return name
|
||||
|
||||
|
||||
max_items = 10000
|
||||
cached_ids = list()
|
||||
cached_entity = list()
|
||||
# It's a mess, but works
|
||||
# Welcome to pr
|
||||
async def mwt_get_entity(entity_type, client, peer, retry=0, from_group=None):
|
||||
global max_items, cached_ids, cached_entity
|
||||
def get(unique_id):
|
||||
global cached_ids, cached_entity
|
||||
try:
|
||||
my_index = cached_ids.index(unique_id)
|
||||
entity = cached_entity[my_index]
|
||||
return entity
|
||||
except ValueError:
|
||||
return None
|
||||
def store(unique_id, entity):
|
||||
global cached_ids, cached_entity
|
||||
cached_ids.append(unique_id)
|
||||
cached_entity.append(entity)
|
||||
|
||||
while len(cached_ids) > max_items:
|
||||
cached_ids.pop(0)
|
||||
cached_entity.pop(0)
|
||||
|
||||
try:
|
||||
if entity_type == 'group':
|
||||
unique_id = get_peer_id(peer)
|
||||
entity = get(unique_id)
|
||||
#_print("cache")
|
||||
if not entity:
|
||||
#_print("new")
|
||||
entity = await client.get_entity(peer)
|
||||
elif entity_type == 'user':
|
||||
unique_id = peer
|
||||
entity = get(unique_id)
|
||||
#_print("cache")
|
||||
if not entity:
|
||||
#_print("new")
|
||||
entity = await client.get_entity(PeerUser(user_id=peer))
|
||||
else:
|
||||
return None
|
||||
store(unique_id, entity)
|
||||
return entity
|
||||
except (ValueError, KeyError) as err:
|
||||
if retry < 1:
|
||||
retry += 1
|
||||
if entity_type == 'group':
|
||||
sys.stdout.write("[Fetching user from group] Error while getting chat: {}".format(err))
|
||||
sys.stdout.flush()
|
||||
elif entity_type == 'user':
|
||||
sys.stdout.write("[Fetching user from group] Error while getting user: {}".format(err))
|
||||
sys.stdout.flush()
|
||||
if from_group:
|
||||
for user in await client.get_participants(from_group):
|
||||
unique_id = user.id
|
||||
entity = user
|
||||
if unique_id not in cached_ids:
|
||||
store(unique_id, entity)
|
||||
entity = await mwt_get_entity(entity_type, client, peer, retry=retry)
|
||||
store(unique_id, entity)
|
||||
return entity
|
||||
else:
|
||||
if entity_type == 'group':
|
||||
sys.stdout.write("[Give up] Error while getting chat: {}".format(err))
|
||||
sys.stdout.flush()
|
||||
entity = EmptyChat(str(id))
|
||||
elif entity_type == 'user':
|
||||
sys.stdout.write("[Give up] Error while getting user: {}".format(err))
|
||||
sys.stdout.flush()
|
||||
entity = EmptyUser(first_name="PeerUser(user_id={})".format(peer))
|
||||
store(unique_id, entity)
|
||||
return entity
|
||||
|
||||
|
||||
async def get_full_info(event):
|
||||
'''
|
||||
# full_user = client(GetFullUserRequest(id=PeerUser(user_id=msg.from_id)))
|
||||
# full_chat = client(GetFullChatRequest(chat_id=chat_id))
|
||||
# full_channel = client(GetFullChannelRequest(channel=PeerChannel(channel_id=None)))
|
||||
# first_name = full_user.user.first_name
|
||||
# last_name = full_user.user.last_name
|
||||
# username = full_user.user.username
|
||||
# title = full_chat.chats[0].title
|
||||
# title = full_channel.chats[0].title
|
||||
'''
|
||||
orig_user_id = event.message.from_id
|
||||
user_id = get_peer_id(PeerUser(user_id=orig_user_id))
|
||||
if event.is_channel:
|
||||
#channel = client.get_entity(event.message.to_id)
|
||||
#user = client.get_entity(PeerUser(user_id=event.message.from_id))
|
||||
channel = await mwt_get_entity('group', client, event.message.to_id)
|
||||
user = await mwt_get_entity('user', client, event.message.from_id, from_group=event.message.to_id)
|
||||
channel_id = get_peer_id(channel)
|
||||
full_info = ['Channel', channel, user, channel_id, user_id]
|
||||
elif event.is_group:
|
||||
group = await mwt_get_entity('group', client, event.message.to_id)
|
||||
group_id = get_peer_id(group)
|
||||
user = await mwt_get_entity('user', client, event.message.from_id, from_group=event.message.to_id)
|
||||
full_info = ['Group', group, user, group_id, user_id]
|
||||
elif event.is_private:
|
||||
user = await mwt_get_entity('user', client, event.message.from_id)
|
||||
full_info = ['User', EmptyChat(), user, user_id, user_id]
|
||||
else:
|
||||
return None
|
||||
|
||||
return full_info
|
||||
|
||||
|
||||
|
||||
@client.on(events.NewMessage)
|
||||
async def new_msg_handler(event):
|
||||
global unochat
|
||||
#print(event)
|
||||
#sys.stdout.flush()
|
||||
full_info = await get_full_info(event)
|
||||
msg = event.message
|
||||
if msg.message and (not msg.media):
|
||||
# Text handler
|
||||
logger.info("{} - {} - {}: {}".format(full_info[0], full_info[1].title, display_username(full_info[2]), msg.message))
|
||||
if not safety_check(get_peer_id(msg.to_id)):
|
||||
return
|
||||
# react to commands
|
||||
if not disable_all_commands:
|
||||
c = commandify(event.raw_text, wild_card=False)
|
||||
if c[0]:
|
||||
if c[0] == 'hello':
|
||||
await event.reply('hi!')
|
||||
if c[0] in ['startgame', 'start', 'join'] and full_info[0] == "Channel":
|
||||
if game.is_playing:
|
||||
await event.reply("I'm playing right now.")
|
||||
else:
|
||||
unochat = msg.to_id
|
||||
game.join_game(get_peer_id(unochat))
|
||||
await client(SendMessageRequest(unochat, "/join@{}".format(unobot_username)))
|
||||
elif c[0] in ['stopgame', 'stop', 'leave'] and full_info[0] == "Channel":
|
||||
if game.is_playing:
|
||||
game.leave_game(get_peer_id(unochat))
|
||||
game.stop_game()
|
||||
await client(SendMessageRequest(unochat, "/leave@{}".format(unobot_username)))
|
||||
elif game.joined and get_peer_id(unochat) in game.joined:
|
||||
game.leave_game(get_peer_id(unochat))
|
||||
await client(SendMessageRequest(unochat, "/leave@{}".format(unobot_username)))
|
||||
else:
|
||||
await event.reply("I'm not playing right now.")
|
||||
elif c[0] in ['wait', 'delay'] and full_info[0] == "Channel":
|
||||
if game.delay or (not game.is_playing):
|
||||
await event.reply("Nothing to do.")
|
||||
else:
|
||||
game.delay = 8
|
||||
await event.reply("OK. {} seconds of delay has been set.".format(game.delay))
|
||||
elif c[0] in ['nowait', 'nodelay'] and full_info[0] == "Channel":
|
||||
if game.delay and game.is_playing:
|
||||
myreply = "OK. {} seconds of delay has been removed.".format(game.delay)
|
||||
game.delay = None
|
||||
await event.reply(myreply)
|
||||
else:
|
||||
await event.reply("Nothing to do.")
|
||||
return
|
||||
# react to unobot
|
||||
if full_info[2].username and full_info[2].username == unobot_username:
|
||||
if re.search(game_consts['myturn'], msg.message):
|
||||
if re.search(game_consts['start'], msg.message):
|
||||
# I'm the first player
|
||||
if not game.is_playing:
|
||||
unochat = msg.to_id
|
||||
if game.joined and get_peer_id(unochat) in game.joined:
|
||||
logger.info('Bot: Game started. I\'m the first player.')
|
||||
game.start_game()
|
||||
logger.info('Bot: It\'s my turn.')
|
||||
if game.is_playing and game.joined and get_peer_id(unochat) in game.joined:
|
||||
await inline_query()
|
||||
else:
|
||||
logger.info('I\'m not playing in {} - {}'.format(full_info[1].title, get_peer_id(unochat)))
|
||||
await client(SendMessageRequest(unochat, "/leave@{}".format(unobot_username)))
|
||||
elif re.search(game_consts['end'], msg.message):
|
||||
if game.is_playing:
|
||||
logger.info('Bot: Game ended.')
|
||||
game.clear_deck()
|
||||
game.leave_game(get_peer_id(unochat))
|
||||
game.stop_game()
|
||||
game.delay = default_delay
|
||||
elif re.search(game_consts['create'], msg.message):
|
||||
if not game.is_playing:
|
||||
logger.info('Bot: New game created.')
|
||||
if default_delay:
|
||||
await asyncio.sleep(default_delay)
|
||||
unochat = msg.to_id
|
||||
game.join_game(get_peer_id(unochat))
|
||||
await client(SendMessageRequest(unochat, "/join@{}".format(unobot_username)))
|
||||
elif re.search(game_consts['start'], msg.message):
|
||||
if not game.is_playing:
|
||||
unochat = msg.to_id
|
||||
if game.joined and get_peer_id(unochat) in game.joined:
|
||||
logger.info('Bot: Game started.')
|
||||
game.start_game()
|
||||
else:
|
||||
await client(SendMessageRequest(unochat, "/leave@{}".format(unobot_username)))
|
||||
elif re.search(game_consts['win'], msg.message):
|
||||
if game.is_playing:
|
||||
logger.info('Bot: I win.')
|
||||
game.clear_deck()
|
||||
game.leave_game(get_peer_id(unochat))
|
||||
game.stop_game()
|
||||
|
||||
elif msg.media:
|
||||
# Has media, interesting.
|
||||
media = msg.media
|
||||
type = None
|
||||
if hasattr(media, 'photo'):
|
||||
type = "photo"
|
||||
logger.info("{} - {} - {}: [Photo]".format(full_info[0], full_info[1].title, display_username(full_info[2])))
|
||||
elif hasattr(media, 'document'):
|
||||
try:
|
||||
if hasattr(media.document.attributes[1], 'stickerset'):
|
||||
type = "Sticker"
|
||||
logger.info("{} - {} - {}: [Sticker]:{}".format(full_info[0], full_info[1].title, display_username(full_info[2]), media.document.attributes[1].alt))
|
||||
else:
|
||||
type = "Document (file)"
|
||||
logger.info("{} - {} - {}: [Document (file)]".format(full_info[0], full_info[1].title, display_username(full_info[2])))
|
||||
except (AttributeError, IndexError):
|
||||
type = "Document"
|
||||
logger.info("{} - {} - {}: [Document]".format(full_info[0], full_info[1].title, display_username(full_info[2])))
|
||||
else:
|
||||
type = "Unknown media"
|
||||
logger.info("{} - {} - {}: [Unknown media]".format(full_info[0], full_info[1].title, display_username(full_info[2])))
|
||||
logger.debug("Media Type: {}".format(type))
|
||||
# Handler complete
|
||||
|
||||
|
||||
# for debug only
|
||||
async def testjob():
|
||||
print('aaa')
|
||||
|
||||
|
||||
async def main():
|
||||
# requires python 3.7 +
|
||||
#if game_autostart:
|
||||
#asyncio.create_task(task_run())
|
||||
await client.run_until_disconnected()
|
||||
#await client.disconnected
|
||||
|
||||
loop = asyncio.get_event_loop()
|
||||
# this can run on python 3.5
|
||||
if game_autostart:
|
||||
loop.create_task(task_run())
|
||||
try:
|
||||
loop.run_until_complete(main())
|
||||
except KeyboardInterrupt:
|
||||
client.disconnect()
|
||||
207
card.py
Normal file
207
card.py
Normal file
|
|
@ -0,0 +1,207 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
RED = 'r'
|
||||
BLUE = 'b'
|
||||
GREEN = 'g'
|
||||
YELLOW = 'y'
|
||||
COLORS = (RED, BLUE, GREEN, YELLOW)
|
||||
|
||||
# Special cards
|
||||
CHOOSE = 'colorchooser'
|
||||
DRAW_FOUR = 'draw_four'
|
||||
SPECIALS = (CHOOSE, DRAW_FOUR)
|
||||
|
||||
|
||||
|
||||
# those stickers below are only used for grey cards.
|
||||
|
||||
# NOGREY is not used now
|
||||
# can't be used for userbot
|
||||
NOGREY = {
|
||||
'BQADBAAD-AIAAl9XmQABxEjEcFM-VHIC': 'option_draw',
|
||||
'BQADBAAD-gIAAl9XmQABcEkAAbaZ4SicAg': 'option_pass',
|
||||
'BQADBAADygIAAl9XmQABJoLfB9ntI2UC': 'option_bluff',
|
||||
'BQADBAADxAIAAl9XmQABC5v3Z77VLfEC': 'option_info'
|
||||
}
|
||||
|
||||
# STICKERS is not used now
|
||||
# can't be used for userbot
|
||||
STICKERS = {
|
||||
'BQADBAAD2QEAAl9XmQAB--inQsYcLTsC': 'b_0',
|
||||
'BQADBAAD2wEAAl9XmQABBzh4U-rFicEC': 'b_1',
|
||||
'BQADBAAD3QEAAl9XmQABo3l6TT0MzKwC': 'b_2',
|
||||
'BQADBAAD3wEAAl9XmQAB2y-3TSapRtIC': 'b_3',
|
||||
'BQADBAAD4QEAAl9XmQABT6nhOuolqKYC': 'b_4',
|
||||
'BQADBAAD4wEAAl9XmQABwRfmekGnpn0C': 'b_5',
|
||||
'BQADBAAD5QEAAl9XmQABQITgUsEsqxsC': 'b_6',
|
||||
'BQADBAAD5wEAAl9XmQABVhPF6EcfWjEC': 'b_7',
|
||||
'BQADBAAD6QEAAl9XmQABP6baig0pIvYC': 'b_8',
|
||||
'BQADBAAD6wEAAl9XmQAB0CQdsQs_pXIC': 'b_9',
|
||||
'BQADBAAD7QEAAl9XmQAB00Wii7R3gDUC': 'b_draw',
|
||||
'BQADBAAD8QEAAl9XmQAB_RJHYKqlc-wC': 'b_skip',
|
||||
'BQADBAAD7wEAAl9XmQABo7D0B9NUPmYC': 'b_reverse',
|
||||
'BQADBAAD9wEAAl9XmQABb8CaxxsQ-Y8C': 'g_0',
|
||||
'BQADBAAD-QEAAl9XmQAB9B6ti_j6UB0C': 'g_1',
|
||||
'BQADBAAD-wEAAl9XmQABYpLjOzbRz8EC': 'g_2',
|
||||
'BQADBAAD_QEAAl9XmQABKvc2ZCiY-D8C': 'g_3',
|
||||
'BQADBAAD_wEAAl9XmQABJB52wzPdHssC': 'g_4',
|
||||
'BQADBAADAQIAAl9XmQABp_Ep1I4GA2cC': 'g_5',
|
||||
'BQADBAADAwIAAl9XmQABaaMxxa4MihwC': 'g_6',
|
||||
'BQADBAADBQIAAl9XmQABv5Q264Crz8gC': 'g_7',
|
||||
'BQADBAADBwIAAl9XmQABjMH-X9UHh8sC': 'g_8',
|
||||
'BQADBAADCQIAAl9XmQAB26fZ2fW7vM0C': 'g_9',
|
||||
'BQADBAADCwIAAl9XmQAB64jIZrgXrQUC': 'g_draw',
|
||||
'BQADBAADDwIAAl9XmQAB17yhhnh46VQC': 'g_skip',
|
||||
'BQADBAADDQIAAl9XmQAB_xcaab0DkegC': 'g_reverse',
|
||||
'BQADBAADEQIAAl9XmQABiUfr1hz-zT8C': 'r_0',
|
||||
'BQADBAADEwIAAl9XmQAB5bWfwJGs6Q0C': 'r_1',
|
||||
'BQADBAADFQIAAl9XmQABHR4mg9Ifjw0C': 'r_2',
|
||||
'BQADBAADFwIAAl9XmQABYBx5O_PG2QIC': 'r_3',
|
||||
'BQADBAADGQIAAl9XmQABTQpGrlvet3cC': 'r_4',
|
||||
'BQADBAADGwIAAl9XmQABbdLt4gdntBQC': 'r_5',
|
||||
'BQADBAADHQIAAl9XmQABqEI274p3lSoC': 'r_6',
|
||||
'BQADBAADHwIAAl9XmQABCw8u67Q4EK4C': 'r_7',
|
||||
'BQADBAADIQIAAl9XmQAB8iDJmLxp8ogC': 'r_8',
|
||||
'BQADBAADIwIAAl9XmQAB_HCAww1kNGYC': 'r_9',
|
||||
'BQADBAADJQIAAl9XmQABuz0OZ4l3k6MC': 'r_draw',
|
||||
'BQADBAADKQIAAl9XmQAC2AL5Ok_ULwI': 'r_skip',
|
||||
'BQADBAADJwIAAl9XmQABu2tIeQTpDvUC': 'r_reverse',
|
||||
'BQADBAADKwIAAl9XmQAB_nWoNKe8DOQC': 'y_0',
|
||||
'BQADBAADLQIAAl9XmQABVprAGUDKgOQC': 'y_1',
|
||||
'BQADBAADLwIAAl9XmQABqyT4_YTm54EC': 'y_2',
|
||||
'BQADBAADMQIAAl9XmQABGC-Xxg_N6fIC': 'y_3',
|
||||
'BQADBAADMwIAAl9XmQABbc-ZGL8kApAC': 'y_4',
|
||||
'BQADBAADNQIAAl9XmQAB67QJZIF6XAcC': 'y_5',
|
||||
'BQADBAADNwIAAl9XmQABJg_7XXoITsoC': 'y_6',
|
||||
'BQADBAADOQIAAl9XmQABVrd7OcS2k34C': 'y_7',
|
||||
'BQADBAADOwIAAl9XmQABRpJSahBWk3EC': 'y_8',
|
||||
'BQADBAADPQIAAl9XmQAB9MwJWKLJogYC': 'y_9',
|
||||
'BQADBAADPwIAAl9XmQABaPYK8oYg84cC': 'y_draw',
|
||||
'BQADBAADQwIAAl9XmQABO_AZKtxY6IMC': 'y_skip',
|
||||
'BQADBAADQQIAAl9XmQABZdQFahGG6UQC': 'y_reverse',
|
||||
'BQADBAAD9QEAAl9XmQABVlkSNfhn76cC': 'draw_four',
|
||||
'BQADBAAD8wEAAl9XmQABl9rUOPqx4E4C': 'colorchooser',
|
||||
'BQADBAAD-AIAAl9XmQABxEjEcFM-VHIC': 'option_draw',
|
||||
'BQADBAAD-gIAAl9XmQABcEkAAbaZ4SicAg': 'option_pass',
|
||||
'BQADBAADygIAAl9XmQABJoLfB9ntI2UC': 'option_bluff',
|
||||
'BQADBAADxAIAAl9XmQABC5v3Z77VLfEC': 'option_info'
|
||||
}
|
||||
|
||||
# can't be used for userbot
|
||||
STICKERS_GREY = {
|
||||
'BQADBAADRQIAAl9XmQAB1IfkQ5xAiK4C': 'b_0',
|
||||
'BQADBAADRwIAAl9XmQABbWvhTeKBii4C': 'b_1',
|
||||
'BQADBAADSQIAAl9XmQABS1djHgyQokMC': 'b_2',
|
||||
'BQADBAADSwIAAl9XmQABwQ6VTbgY-MIC': 'b_3',
|
||||
'BQADBAADTQIAAl9XmQABAlKUYha8YccC': 'b_4',
|
||||
'BQADBAADTwIAAl9XmQABMvx8xVDnhUEC': 'b_5',
|
||||
'BQADBAADUQIAAl9XmQABDEbhP1Zd31kC': 'b_6',
|
||||
'BQADBAADUwIAAl9XmQABXb5XQBBaAnIC': 'b_7',
|
||||
'BQADBAADVQIAAl9XmQABgL5HRDLvrjgC': 'b_8',
|
||||
'BQADBAADVwIAAl9XmQABtO3XDQWZLtYC': 'b_9',
|
||||
'BQADBAADWQIAAl9XmQAB2kk__6_2IhMC': 'b_draw',
|
||||
'BQADBAADXQIAAl9XmQABEGJI6CaH3vcC': 'b_skip',
|
||||
'BQADBAADWwIAAl9XmQAB_kZA6UdHXU8C': 'b_reverse',
|
||||
'BQADBAADYwIAAl9XmQABGD5a9oG7Yg4C': 'g_0',
|
||||
'BQADBAADZQIAAl9XmQABqwABZHAXZIg0Ag': 'g_1',
|
||||
'BQADBAADZwIAAl9XmQABTI3mrEhojRkC': 'g_2',
|
||||
'BQADBAADaQIAAl9XmQABVi3rUyzWS3YC': 'g_3',
|
||||
'BQADBAADawIAAl9XmQABZIf5ThaXnpUC': 'g_4',
|
||||
'BQADBAADbQIAAl9XmQABNndVJSQCenIC': 'g_5',
|
||||
'BQADBAADbwIAAl9XmQABpoy1c4ZkrvwC': 'g_6',
|
||||
'BQADBAADcQIAAl9XmQABDeaT5fzxwREC': 'g_7',
|
||||
'BQADBAADcwIAAl9XmQABLIQ06ZM5NnAC': 'g_8',
|
||||
'BQADBAADdQIAAl9XmQABel-mC7eXGsMC': 'g_9',
|
||||
'BQADBAADdwIAAl9XmQABOHEpxSztCf8C': 'g_draw',
|
||||
'BQADBAADewIAAl9XmQABDaQdMxjjPsoC': 'g_skip',
|
||||
'BQADBAADeQIAAl9XmQABek1lGz7SJNAC': 'g_reverse',
|
||||
'BQADBAADfQIAAl9XmQABWrxoiXcsg0EC': 'r_0',
|
||||
'BQADBAADfwIAAl9XmQABlav-bkgSgRcC': 'r_1',
|
||||
'BQADBAADgQIAAl9XmQABDjZkqfJ4AdAC': 'r_2',
|
||||
'BQADBAADgwIAAl9XmQABT7lH7VVcy3MC': 'r_3',
|
||||
'BQADBAADhQIAAl9XmQAB1arPC5x0LrwC': 'r_4',
|
||||
'BQADBAADhwIAAl9XmQABWvs7xkCDldkC': 'r_5',
|
||||
'BQADBAADiQIAAl9XmQABjwABH5ZonWn8Ag': 'r_6',
|
||||
'BQADBAADiwIAAl9XmQABjekJfm4fBDIC': 'r_7',
|
||||
'BQADBAADjQIAAl9XmQABqFjchpsJeEkC': 'r_8',
|
||||
'BQADBAADjwIAAl9XmQAB-sKdcgABdNKDAg': 'r_9',
|
||||
'BQADBAADkQIAAl9XmQABtw9RPVDHZOQC': 'r_draw',
|
||||
'BQADBAADlQIAAl9XmQABtG2GixCxtX4C': 'r_skip',
|
||||
'BQADBAADkwIAAl9XmQABz2qyEbabnVsC': 'r_reverse',
|
||||
'BQADBAADlwIAAl9XmQABAb3ZwTGS1lMC': 'y_0',
|
||||
'BQADBAADmQIAAl9XmQAB9v5qJk9R0x8C': 'y_1',
|
||||
'BQADBAADmwIAAl9XmQABCsgpRHC2g-cC': 'y_2',
|
||||
'BQADBAADnQIAAl9XmQAB3kLLXCv-qY0C': 'y_3',
|
||||
'BQADBAADnwIAAl9XmQAB7R_y-NexNLIC': 'y_4',
|
||||
'BQADBAADoQIAAl9XmQABl-7mwsjD-cMC': 'y_5',
|
||||
'BQADBAADowIAAl9XmQABwbVsyv2MfPkC': 'y_6',
|
||||
'BQADBAADpQIAAl9XmQABoBqC0JsemVwC': 'y_7',
|
||||
'BQADBAADpwIAAl9XmQABpkwAAeh9ldlHAg': 'y_8',
|
||||
'BQADBAADqQIAAl9XmQABpSBEUfd4IM8C': 'y_9',
|
||||
'BQADBAADqwIAAl9XmQABMt-2zW0VYb4C': 'y_draw',
|
||||
'BQADBAADrwIAAl9XmQABIDf-_TuuxtEC': 'y_skip',
|
||||
'BQADBAADrQIAAl9XmQABm9M0Zh-_UwkC': 'y_reverse',
|
||||
'BQADBAADYQIAAl9XmQAB_HWlvZIscDEC': 'draw_four',
|
||||
'BQADBAADXwIAAl9XmQABY_ksDdMex-wC': 'colorchooser'
|
||||
}
|
||||
|
||||
# sticker_id
|
||||
#sticker_id = [['b_0', '43161736970240581'], ['b_1', '43161736970240583'], ['b_2', '43161736970240585'], ['b_3', '43161736970240587'], ['b_4', '43161736970240589'], ['b_5', '43161736970240591'], ['b_6', '43161736970240593'], ['b_7', '43161736970240595'], ['b_8', '43161736970240597'], ['b_9', '43161736970240599'], ['b_draw', '43161736970240601'], ['b_skip', '43161736970240605'], ['b_reverse', '43161736970240603'], ['g_0', '43161736970240611'], ['g_1', '43161736970240613'], ['g_2', '43161736970240615'], ['g_3', '43161736970240617'], ['g_4', '43161736970240619'], ['g_5', '43161736970240621'], ['g_6', '43161736970240623'], ['g_7', '43161736970240625'], ['g_8', '43161736970240627'], ['g_9', '43161736970240629'], ['g_draw', '43161736970240631'], ['g_skip', '43161736970240635'], ['g_reverse', '43161736970240633'], ['r_0', '43161736970240637'], ['r_1', '43161736970240639'], ['r_2', '43161736970240641'], ['r_3', '43161736970240643'], ['r_4', '43161736970240645'], ['r_5', '43161736970240647'], ['r_6', '43161736970240649'], ['r_7', '43161736970240651'], ['r_8', '43161736970240653'], ['r_9', '43161736970240655'], ['r_draw', '43161736970240657'], ['r_skip', '43161736970240661'], ['r_reverse', '43161736970240659'], ['y_0', '43161736970240663'], ['y_1', '43161736970240665'], ['y_2', '43161736970240667'], ['y_3', '43161736970240669'], ['y_4', '43161736970240671'], ['y_5', '43161736970240673'], ['y_6', '43161736970240675'], ['y_7', '43161736970240677'], ['y_8', '43161736970240679'], ['y_9', '43161736970240681'], ['y_draw', '43161736970240683'], ['y_skip', '43161736970240687'], ['y_reverse', '43161736970240685'], ['draw_four', '43161736970240609'], ['colorchooser', '43161736970240607']]
|
||||
|
||||
GREY_SET_ID = '43161736970240002'
|
||||
|
||||
# only grey ordinary cards are useful
|
||||
GREY_ID = {
|
||||
'43161736970240581': 'b_0',
|
||||
'43161736970240583': 'b_1',
|
||||
'43161736970240585': 'b_2',
|
||||
'43161736970240587': 'b_3',
|
||||
'43161736970240589': 'b_4',
|
||||
'43161736970240591': 'b_5',
|
||||
'43161736970240593': 'b_6',
|
||||
'43161736970240595': 'b_7',
|
||||
'43161736970240597': 'b_8',
|
||||
'43161736970240599': 'b_9',
|
||||
'43161736970240601': 'b_draw',
|
||||
'43161736970240605': 'b_skip',
|
||||
'43161736970240603': 'b_reverse',
|
||||
'43161736970240611': 'g_0',
|
||||
'43161736970240613': 'g_1',
|
||||
'43161736970240615': 'g_2',
|
||||
'43161736970240617': 'g_3',
|
||||
'43161736970240619': 'g_4',
|
||||
'43161736970240621': 'g_5',
|
||||
'43161736970240623': 'g_6',
|
||||
'43161736970240625': 'g_7',
|
||||
'43161736970240627': 'g_8',
|
||||
'43161736970240629': 'g_9',
|
||||
'43161736970240631': 'g_draw',
|
||||
'43161736970240635': 'g_skip',
|
||||
'43161736970240633': 'g_reverse',
|
||||
'43161736970240637': 'r_0',
|
||||
'43161736970240639': 'r_1',
|
||||
'43161736970240641': 'r_2',
|
||||
'43161736970240643': 'r_3',
|
||||
'43161736970240645': 'r_4',
|
||||
'43161736970240647': 'r_5',
|
||||
'43161736970240649': 'r_6',
|
||||
'43161736970240651': 'r_7',
|
||||
'43161736970240653': 'r_8',
|
||||
'43161736970240655': 'r_9',
|
||||
'43161736970240657': 'r_draw',
|
||||
'43161736970240661': 'r_skip',
|
||||
'43161736970240659': 'r_reverse',
|
||||
'43161736970240663': 'y_0',
|
||||
'43161736970240665': 'y_1',
|
||||
'43161736970240667': 'y_2',
|
||||
'43161736970240669': 'y_3',
|
||||
'43161736970240671': 'y_4',
|
||||
'43161736970240673': 'y_5',
|
||||
'43161736970240675': 'y_6',
|
||||
'43161736970240677': 'y_7',
|
||||
'43161736970240679': 'y_8',
|
||||
'43161736970240681': 'y_9',
|
||||
'43161736970240683': 'y_draw',
|
||||
'43161736970240687': 'y_skip',
|
||||
'43161736970240685': 'y_reverse'
|
||||
}
|
||||
28
config.py
Normal file
28
config.py
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
api_id = 123456
|
||||
api_hash = 'ffffffffffffffffffffffffffffff'
|
||||
PHONE = '+10001000000'
|
||||
session_name = 'session1'
|
||||
|
||||
unobot_username = 'unobot'
|
||||
# should be a int or None
|
||||
default_delay = None
|
||||
# print all of the bot's cards
|
||||
print_cards = True
|
||||
# if true, the bot will not react to any command-like things
|
||||
disable_all_commands = False
|
||||
|
||||
game_autostart = False
|
||||
# if game_autostart is True, the following fields are needed
|
||||
# can also be a link
|
||||
unogroup_chatname = None
|
||||
#unogroup_chatname = 'https://t.me/xxxx'
|
||||
|
||||
# %username% %firstname% is available
|
||||
game_consts = {
|
||||
'create' : 'Created a new game!', # do not enable translation!!! anyone who has choosed a different language will be ignored
|
||||
#'create': 'Created a new game!|on_game_created', # this is defined for @unounofficialbot, a workaround for the problem above
|
||||
'end' : 'Game ended',
|
||||
'start' : 'First player:',
|
||||
'win' : '%firstname% won!',
|
||||
'myturn' : '(@%username%)'
|
||||
}
|
||||
174
game.py
Normal file
174
game.py
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
from card import COLORS, SPECIALS
|
||||
from card import RED, BLUE, GREEN, YELLOW
|
||||
from card import GREY_ID
|
||||
from random import choice, random
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger('card')
|
||||
|
||||
def color_from_str(string):
|
||||
"""Decodes a Card object from a string"""
|
||||
# Actuall it should't be "in special"
|
||||
if string not in SPECIALS:
|
||||
color, value = string.split('_')
|
||||
del value
|
||||
return color
|
||||
|
||||
def cards_sum(deck):
|
||||
"""How many cards do we have in each color?"""
|
||||
# r, b, g, y
|
||||
card_count = {RED: 0, BLUE: 0, GREEN: 0, YELLOW: 0}
|
||||
for card in deck:
|
||||
card_count[color_from_str(card)] += 1
|
||||
return card_count
|
||||
|
||||
def color_choice(deck, greydeck):
|
||||
"""Now that we are doing a color choice, which color should we choose?"""
|
||||
full_deck = deck + greydeck
|
||||
sum = cards_sum(full_deck)
|
||||
chosen_color = None
|
||||
chosen_number = 0
|
||||
for color in (RED, BLUE, GREEN, YELLOW):
|
||||
if chosen_number <= sum[color]:
|
||||
chosen_number = sum[color]
|
||||
chosen_color = color
|
||||
if chosen_number == 0 or chosen_color is None:
|
||||
chosen_color = choice((RED, BLUE, GREEN, YELLOW))
|
||||
return chosen_color
|
||||
|
||||
def randchance(chance=0.5):
|
||||
""" make simple random choice
|
||||
chance can be any number between 0,1
|
||||
"""
|
||||
if chance > random():
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
class Game():
|
||||
def __init__(self):
|
||||
self.deck = list()
|
||||
self.greydeck = list()
|
||||
self.old_deck = list()
|
||||
self.old_greydeck = list()
|
||||
self.special = list()
|
||||
self.functional = list()
|
||||
# functional = draw, call_bluff, pass
|
||||
# call_bluff > draw
|
||||
self.choose_color = list()
|
||||
self.joined = None #may be None or a a list of group entity
|
||||
self.is_playing = False
|
||||
self.anti_cheat = ''
|
||||
self.delay = None
|
||||
def join_game(self, group):
|
||||
if self.joined is None:
|
||||
self.joined = list()
|
||||
if group in self.joined:
|
||||
return True
|
||||
self.joined.append(group)
|
||||
def leave_game(self, group):
|
||||
try:
|
||||
if self.joined:
|
||||
self.joined.remove(group)
|
||||
except ValueError:
|
||||
returnValue = False
|
||||
else:
|
||||
returnValue = True
|
||||
if (self.joined is not None) and (not self.joined):
|
||||
self.joined = None
|
||||
return returnValue
|
||||
def start_game(self):
|
||||
self.is_playing = True
|
||||
def stop_game(self):
|
||||
self.is_playing = False
|
||||
# delay is set in bot.py
|
||||
#self.delay = None
|
||||
def rotate_deck(self):
|
||||
"""Memorize deck for for 1 round in case of color choose"""
|
||||
if len(self.choose_color):
|
||||
# when choosing color, the bot cannot get any ordinary card. (deck and greydeck are all empty)
|
||||
if len(self.deck) != 0 or len(self.greydeck) != 0:
|
||||
logger.critical('Unexpected behavior: there\'s cards in deck while choosing color.')
|
||||
else:
|
||||
self.old_deck = self.deck
|
||||
self.old_greydeck = self.greydeck
|
||||
self.clear_deck(rotate=True)
|
||||
def clear_deck(self, rotate=False):
|
||||
if not rotate:
|
||||
self.old_deck = list()
|
||||
self.old_greydeck = list()
|
||||
self.deck = list()
|
||||
self.greydeck = list()
|
||||
self.special = list()
|
||||
self.functional = list()
|
||||
self.choose_color = list()
|
||||
self.anti_cheat = ''
|
||||
def print_cards(self):
|
||||
""" print all of my cards
|
||||
returns a string that is printable
|
||||
note that currently the bot just ignores unplayable special cards
|
||||
"""
|
||||
if len(self.choose_color):
|
||||
return str(self.choose_color + self.old_deck + ["[u]" + s for s in self.old_greydeck] + self.special + self.functional)
|
||||
else:
|
||||
return str(self.deck + ["[u]" + s for s in self.greydeck] + self.special + self.functional)
|
||||
def add_grey_card(self, card_id):
|
||||
"""get grey_cards from id, and add them"""
|
||||
grey_card = GREY_ID.get(str(card_id), None)
|
||||
if grey_card:
|
||||
self.greydeck.append(grey_card)
|
||||
else:
|
||||
logger.info('Can\'t get any card from the given id {}'.format(card_id))
|
||||
def add_card(self, result_id, anti_cheat):
|
||||
"""add card to deck, refer to the code of unobot for more info"""
|
||||
self.anti_cheat = anti_cheat
|
||||
if result_id in ('hand', 'gameinfo', 'nogame'):
|
||||
return
|
||||
elif result_id.startswith('mode_'):
|
||||
return
|
||||
elif len(result_id) == 36:
|
||||
return
|
||||
elif result_id == 'call_bluff':
|
||||
self.functional.append(result_id)
|
||||
elif result_id == 'draw':
|
||||
self.functional.append(result_id)
|
||||
elif result_id == 'pass':
|
||||
self.functional.append(result_id)
|
||||
elif result_id in COLORS:
|
||||
self.choose_color.append(result_id)
|
||||
elif result_id in SPECIALS:
|
||||
self.special.append(result_id)
|
||||
else:
|
||||
self.deck.append(result_id)
|
||||
def play_card(self):
|
||||
''' The bot plays its card.
|
||||
The deck is refreshed every round,
|
||||
currently the bot is unable to know its previously played cards.
|
||||
'''
|
||||
# in case we are choosing color
|
||||
if len(self.choose_color):
|
||||
return color_choice(self.old_deck, self.old_greydeck)
|
||||
# play ordinary cards
|
||||
# and always take special cards into account
|
||||
elif len(self.deck):
|
||||
if len(self.special) and randchance(0.1):
|
||||
return choice(self.special)
|
||||
else:
|
||||
return choice(self.deck)
|
||||
# if we don't have any ordinary cards to play
|
||||
# maybe there's a plus four?
|
||||
elif len(self.special):
|
||||
return choice(self.special)
|
||||
elif len(self.functional):
|
||||
# or maybe there's a pass?
|
||||
if 'pass' in self.functional:
|
||||
return 'pass'
|
||||
# still no? call his bluff!
|
||||
else:
|
||||
if 'call_bluff' in self.functional and randchance(0.4):
|
||||
return 'call_bluff'
|
||||
# what is left? probably draw(
|
||||
else:
|
||||
return choice(self.functional)
|
||||
1
requirements.txt
Normal file
1
requirements.txt
Normal file
|
|
@ -0,0 +1 @@
|
|||
telethon>=1.4.3
|
||||
529
schedule_async.py
Normal file
529
schedule_async.py
Normal file
|
|
@ -0,0 +1,529 @@
|
|||
"""
|
||||
Modified to work with asyncio by Jerry Xiao <jerry at mail.jerryxiao.cc>
|
||||
Don't tell me there's aiocron. I don't know.
|
||||
|
||||
Python job scheduling for humans.
|
||||
|
||||
github.com/dbader/schedule
|
||||
|
||||
An in-process scheduler for periodic jobs that uses the builder pattern
|
||||
for configuration. Schedule lets you run Python functions (or any other
|
||||
callable) periodically at pre-determined intervals using a simple,
|
||||
human-friendly syntax.
|
||||
|
||||
Inspired by Addam Wiggins' article "Rethinking Cron" [1] and the
|
||||
"clockwork" Ruby module [2][3].
|
||||
|
||||
Features:
|
||||
- A simple to use API for scheduling jobs.
|
||||
- Very lightweight and no external dependencies.
|
||||
- Excellent test coverage.
|
||||
- Tested on Python 2.7, 3.5 to 3.7
|
||||
|
||||
Usage:
|
||||
>>> import schedule_async
|
||||
>>> import time
|
||||
|
||||
>>> def job(message='stuff'):
|
||||
>>> print("I'm working on:", message)
|
||||
|
||||
>>> schedule.every(10).minutes.do(job)
|
||||
>>> schedule.every(5).to(10).days.do(job)
|
||||
>>> schedule.every().hour.do(job, message='things')
|
||||
>>> schedule.every().day.at("10:30").do(job)
|
||||
|
||||
>>> while True:
|
||||
>>> await schedule.run_pending()
|
||||
>>> await asyncio.sleep(1)
|
||||
|
||||
[1] https://adam.herokuapp.com/past/2010/4/13/rethinking_cron/
|
||||
[2] https://github.com/Rykian/clockwork
|
||||
[3] https://adam.herokuapp.com/past/2010/6/30/replace_cron_with_clockwork/
|
||||
"""
|
||||
import collections
|
||||
import datetime
|
||||
import functools
|
||||
import logging
|
||||
import random
|
||||
import time
|
||||
import asyncio
|
||||
|
||||
logger = logging.getLogger('schedule')
|
||||
|
||||
|
||||
class CancelJob(object):
|
||||
"""
|
||||
Can be returned from a job to unschedule itself.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
class Scheduler(object):
|
||||
"""
|
||||
Objects instantiated by the :class:`Scheduler <Scheduler>` are
|
||||
factories to create jobs, keep record of scheduled jobs and
|
||||
handle their execution.
|
||||
"""
|
||||
def __init__(self):
|
||||
self.jobs = []
|
||||
|
||||
async def run_pending(self):
|
||||
"""
|
||||
Run all jobs that are scheduled to run.
|
||||
|
||||
Please note that it is *intended behavior that run_pending()
|
||||
does not run missed jobs*. For example, if you've registered a job
|
||||
that should run every minute and you only call run_pending()
|
||||
in one hour increments then your job won't be run 60 times in
|
||||
between but only once.
|
||||
"""
|
||||
runnable_jobs = (job for job in self.jobs if job.should_run)
|
||||
for job in sorted(runnable_jobs):
|
||||
await self._run_job(job)
|
||||
|
||||
async def run_all(self, delay_seconds=0):
|
||||
"""
|
||||
Run all jobs regardless if they are scheduled to run or not.
|
||||
|
||||
A delay of `delay` seconds is added between each job. This helps
|
||||
distribute system load generated by the jobs more evenly
|
||||
over time.
|
||||
|
||||
:param delay_seconds: A delay added between every executed job
|
||||
"""
|
||||
logger.info('Running *all* %i jobs with %is delay inbetween',
|
||||
len(self.jobs), delay_seconds)
|
||||
for job in self.jobs[:]:
|
||||
await self._run_job(job)
|
||||
await asyncio.sleep(delay_seconds)
|
||||
|
||||
def clear(self, tag=None):
|
||||
"""
|
||||
Deletes scheduled jobs marked with the given tag, or all jobs
|
||||
if tag is omitted.
|
||||
|
||||
:param tag: An identifier used to identify a subset of
|
||||
jobs to delete
|
||||
"""
|
||||
if tag is None:
|
||||
del self.jobs[:]
|
||||
else:
|
||||
self.jobs[:] = (job for job in self.jobs if tag not in job.tags)
|
||||
|
||||
def cancel_job(self, job):
|
||||
"""
|
||||
Delete a scheduled job.
|
||||
|
||||
:param job: The job to be unscheduled
|
||||
"""
|
||||
try:
|
||||
self.jobs.remove(job)
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
def every(self, interval=1):
|
||||
"""
|
||||
Schedule a new periodic job.
|
||||
|
||||
:param interval: A quantity of a certain time unit
|
||||
:return: An unconfigured :class:`Job <Job>`
|
||||
"""
|
||||
job = Job(interval, self)
|
||||
return job
|
||||
|
||||
async def _run_job(self, job):
|
||||
ret = await job.run()
|
||||
if isinstance(ret, CancelJob) or ret is CancelJob:
|
||||
self.cancel_job(job)
|
||||
|
||||
@property
|
||||
def next_run(self):
|
||||
"""
|
||||
Datetime when the next job should run.
|
||||
|
||||
:return: A :class:`~datetime.datetime` object
|
||||
"""
|
||||
if not self.jobs:
|
||||
return None
|
||||
return min(self.jobs).next_run
|
||||
|
||||
@property
|
||||
def idle_seconds(self):
|
||||
"""
|
||||
:return: Number of seconds until
|
||||
:meth:`next_run <Scheduler.next_run>`.
|
||||
"""
|
||||
return (self.next_run - datetime.datetime.now()).total_seconds()
|
||||
|
||||
|
||||
class Job(object):
|
||||
"""
|
||||
A periodic job as used by :class:`Scheduler`.
|
||||
|
||||
:param interval: A quantity of a certain time unit
|
||||
:param scheduler: The :class:`Scheduler <Scheduler>` instance that
|
||||
this job will register itself with once it has
|
||||
been fully configured in :meth:`Job.do()`.
|
||||
|
||||
Every job runs at a given fixed time interval that is defined by:
|
||||
|
||||
* a :meth:`time unit <Job.second>`
|
||||
* a quantity of `time units` defined by `interval`
|
||||
|
||||
A job is usually created and returned by :meth:`Scheduler.every`
|
||||
method, which also defines its `interval`.
|
||||
"""
|
||||
def __init__(self, interval, scheduler=None):
|
||||
self.interval = interval # pause interval * unit between runs
|
||||
self.latest = None # upper limit to the interval
|
||||
self.job_func = None # the job job_func to run
|
||||
self.unit = None # time units, e.g. 'minutes', 'hours', ...
|
||||
self.at_time = None # optional time at which this job runs
|
||||
self.last_run = None # datetime of the last run
|
||||
self.next_run = None # datetime of the next run
|
||||
self.period = None # timedelta between runs, only valid for
|
||||
self.start_day = None # Specific day of the week to start on
|
||||
self.tags = set() # unique set of tags for the job
|
||||
self.scheduler = scheduler # scheduler to register with
|
||||
|
||||
def __lt__(self, other):
|
||||
"""
|
||||
PeriodicJobs are sortable based on the scheduled time they
|
||||
run next.
|
||||
"""
|
||||
return self.next_run < other.next_run
|
||||
|
||||
def __repr__(self):
|
||||
def format_time(t):
|
||||
return t.strftime('%Y-%m-%d %H:%M:%S') if t else '[never]'
|
||||
|
||||
timestats = '(last run: %s, next run: %s)' % (
|
||||
format_time(self.last_run), format_time(self.next_run))
|
||||
|
||||
if hasattr(self.job_func, '__name__'):
|
||||
job_func_name = self.job_func.__name__
|
||||
else:
|
||||
job_func_name = repr(self.job_func)
|
||||
args = [repr(x) for x in self.job_func.args]
|
||||
kwargs = ['%s=%s' % (k, repr(v))
|
||||
for k, v in self.job_func.keywords.items()]
|
||||
call_repr = job_func_name + '(' + ', '.join(args + kwargs) + ')'
|
||||
|
||||
if self.at_time is not None:
|
||||
return 'Every %s %s at %s do %s %s' % (
|
||||
self.interval,
|
||||
self.unit[:-1] if self.interval == 1 else self.unit,
|
||||
self.at_time, call_repr, timestats)
|
||||
else:
|
||||
fmt = (
|
||||
'Every %(interval)s ' +
|
||||
('to %(latest)s ' if self.latest is not None else '') +
|
||||
'%(unit)s do %(call_repr)s %(timestats)s'
|
||||
)
|
||||
|
||||
return fmt % dict(
|
||||
interval=self.interval,
|
||||
latest=self.latest,
|
||||
unit=(self.unit[:-1] if self.interval == 1 else self.unit),
|
||||
call_repr=call_repr,
|
||||
timestats=timestats
|
||||
)
|
||||
|
||||
@property
|
||||
def second(self):
|
||||
assert self.interval == 1, 'Use seconds instead of second'
|
||||
return self.seconds
|
||||
|
||||
@property
|
||||
def seconds(self):
|
||||
self.unit = 'seconds'
|
||||
return self
|
||||
|
||||
@property
|
||||
def minute(self):
|
||||
assert self.interval == 1, 'Use minutes instead of minute'
|
||||
return self.minutes
|
||||
|
||||
@property
|
||||
def minutes(self):
|
||||
self.unit = 'minutes'
|
||||
return self
|
||||
|
||||
@property
|
||||
def hour(self):
|
||||
assert self.interval == 1, 'Use hours instead of hour'
|
||||
return self.hours
|
||||
|
||||
@property
|
||||
def hours(self):
|
||||
self.unit = 'hours'
|
||||
return self
|
||||
|
||||
@property
|
||||
def day(self):
|
||||
assert self.interval == 1, 'Use days instead of day'
|
||||
return self.days
|
||||
|
||||
@property
|
||||
def days(self):
|
||||
self.unit = 'days'
|
||||
return self
|
||||
|
||||
@property
|
||||
def week(self):
|
||||
assert self.interval == 1, 'Use weeks instead of week'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def weeks(self):
|
||||
self.unit = 'weeks'
|
||||
return self
|
||||
|
||||
@property
|
||||
def monday(self):
|
||||
assert self.interval == 1, 'Use mondays instead of monday'
|
||||
self.start_day = 'monday'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def tuesday(self):
|
||||
assert self.interval == 1, 'Use tuesdays instead of tuesday'
|
||||
self.start_day = 'tuesday'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def wednesday(self):
|
||||
assert self.interval == 1, 'Use wedesdays instead of wednesday'
|
||||
self.start_day = 'wednesday'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def thursday(self):
|
||||
assert self.interval == 1, 'Use thursdays instead of thursday'
|
||||
self.start_day = 'thursday'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def friday(self):
|
||||
assert self.interval == 1, 'Use fridays instead of friday'
|
||||
self.start_day = 'friday'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def saturday(self):
|
||||
assert self.interval == 1, 'Use saturdays instead of saturday'
|
||||
self.start_day = 'saturday'
|
||||
return self.weeks
|
||||
|
||||
@property
|
||||
def sunday(self):
|
||||
assert self.interval == 1, 'Use sundays instead of sunday'
|
||||
self.start_day = 'sunday'
|
||||
return self.weeks
|
||||
|
||||
def tag(self, *tags):
|
||||
"""
|
||||
Tags the job with one or more unique indentifiers.
|
||||
|
||||
Tags must be hashable. Duplicate tags are discarded.
|
||||
|
||||
:param tags: A unique list of ``Hashable`` tags.
|
||||
:return: The invoked job instance
|
||||
"""
|
||||
if not all(isinstance(tag, collections.Hashable) for tag in tags):
|
||||
raise TypeError('Tags must be hashable')
|
||||
self.tags.update(tags)
|
||||
return self
|
||||
|
||||
def at(self, time_str):
|
||||
"""
|
||||
Schedule the job every day at a specific time.
|
||||
|
||||
Calling this is only valid for jobs scheduled to run
|
||||
every N day(s).
|
||||
|
||||
:param time_str: A string in `XX:YY` format.
|
||||
:return: The invoked job instance
|
||||
"""
|
||||
assert self.unit in ('days', 'hours') or self.start_day
|
||||
hour, minute = time_str.split(':')
|
||||
minute = int(minute)
|
||||
if self.unit == 'days' or self.start_day:
|
||||
hour = int(hour)
|
||||
assert 0 <= hour <= 23
|
||||
elif self.unit == 'hours':
|
||||
hour = 0
|
||||
assert 0 <= minute <= 59
|
||||
self.at_time = datetime.time(hour, minute)
|
||||
return self
|
||||
|
||||
def to(self, latest):
|
||||
"""
|
||||
Schedule the job to run at an irregular (randomized) interval.
|
||||
|
||||
The job's interval will randomly vary from the value given
|
||||
to `every` to `latest`. The range defined is inclusive on
|
||||
both ends. For example, `every(A).to(B).seconds` executes
|
||||
the job function every N seconds such that A <= N <= B.
|
||||
|
||||
:param latest: Maximum interval between randomized job runs
|
||||
:return: The invoked job instance
|
||||
"""
|
||||
self.latest = latest
|
||||
return self
|
||||
|
||||
def do(self, job_func, *args, **kwargs):
|
||||
"""
|
||||
Specifies the job_func that should be called every time the
|
||||
job runs.
|
||||
|
||||
Any additional arguments are passed on to job_func when
|
||||
the job runs.
|
||||
|
||||
:param job_func: The function to be scheduled
|
||||
:return: The invoked job instance
|
||||
"""
|
||||
self.job_func = functools.partial(job_func, *args, **kwargs)
|
||||
try:
|
||||
functools.update_wrapper(self.job_func, job_func)
|
||||
except AttributeError:
|
||||
# job_funcs already wrapped by functools.partial won't have
|
||||
# __name__, __module__ or __doc__ and the update_wrapper()
|
||||
# call will fail.
|
||||
pass
|
||||
self._schedule_next_run()
|
||||
self.scheduler.jobs.append(self)
|
||||
return self
|
||||
|
||||
@property
|
||||
def should_run(self):
|
||||
"""
|
||||
:return: ``True`` if the job should be run now.
|
||||
"""
|
||||
return datetime.datetime.now() >= self.next_run
|
||||
|
||||
async def run(self):
|
||||
"""
|
||||
Run the job and immediately reschedule it.
|
||||
|
||||
:return: The return value returned by the `job_func`
|
||||
"""
|
||||
logger.info('Running job %s', self)
|
||||
ret = await self.job_func()
|
||||
self.last_run = datetime.datetime.now()
|
||||
self._schedule_next_run()
|
||||
return ret
|
||||
|
||||
def _schedule_next_run(self):
|
||||
"""
|
||||
Compute the instant when this job should run next.
|
||||
"""
|
||||
assert self.unit in ('seconds', 'minutes', 'hours', 'days', 'weeks')
|
||||
|
||||
if self.latest is not None:
|
||||
assert self.latest >= self.interval
|
||||
interval = random.randint(self.interval, self.latest)
|
||||
else:
|
||||
interval = self.interval
|
||||
|
||||
self.period = datetime.timedelta(**{self.unit: interval})
|
||||
self.next_run = datetime.datetime.now() + self.period
|
||||
if self.start_day is not None:
|
||||
assert self.unit == 'weeks'
|
||||
weekdays = (
|
||||
'monday',
|
||||
'tuesday',
|
||||
'wednesday',
|
||||
'thursday',
|
||||
'friday',
|
||||
'saturday',
|
||||
'sunday'
|
||||
)
|
||||
assert self.start_day in weekdays
|
||||
weekday = weekdays.index(self.start_day)
|
||||
days_ahead = weekday - self.next_run.weekday()
|
||||
if days_ahead <= 0: # Target day already happened this week
|
||||
days_ahead += 7
|
||||
self.next_run += datetime.timedelta(days_ahead) - self.period
|
||||
if self.at_time is not None:
|
||||
assert self.unit in ('days', 'hours') or self.start_day is not None
|
||||
kwargs = {
|
||||
'minute': self.at_time.minute,
|
||||
'second': self.at_time.second,
|
||||
'microsecond': 0
|
||||
}
|
||||
if self.unit == 'days' or self.start_day is not None:
|
||||
kwargs['hour'] = self.at_time.hour
|
||||
self.next_run = self.next_run.replace(**kwargs)
|
||||
# If we are running for the first time, make sure we run
|
||||
# at the specified time *today* (or *this hour*) as well
|
||||
if not self.last_run:
|
||||
now = datetime.datetime.now()
|
||||
if (self.unit == 'days' and self.at_time > now.time() and
|
||||
self.interval == 1):
|
||||
self.next_run = self.next_run - datetime.timedelta(days=1)
|
||||
elif self.unit == 'hours' and self.at_time.minute > now.minute:
|
||||
self.next_run = self.next_run - datetime.timedelta(hours=1)
|
||||
if self.start_day is not None and self.at_time is not None:
|
||||
# Let's see if we will still make that time we specified today
|
||||
if (self.next_run - datetime.datetime.now()).days >= 7:
|
||||
self.next_run -= self.period
|
||||
|
||||
|
||||
# The following methods are shortcuts for not having to
|
||||
# create a Scheduler instance:
|
||||
|
||||
#: Default :class:`Scheduler <Scheduler>` object
|
||||
default_scheduler = Scheduler()
|
||||
|
||||
#: Default :class:`Jobs <Job>` list
|
||||
jobs = default_scheduler.jobs # todo: should this be a copy, e.g. jobs()?
|
||||
|
||||
|
||||
def every(interval=1):
|
||||
"""Calls :meth:`every <Scheduler.every>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
return default_scheduler.every(interval)
|
||||
|
||||
|
||||
async def run_pending():
|
||||
"""Calls :meth:`run_pending <Scheduler.run_pending>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
await default_scheduler.run_pending()
|
||||
|
||||
|
||||
def run_all(delay_seconds=0):
|
||||
"""Calls :meth:`run_all <Scheduler.run_all>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
default_scheduler.run_all(delay_seconds=delay_seconds)
|
||||
|
||||
|
||||
def clear(tag=None):
|
||||
"""Calls :meth:`clear <Scheduler.clear>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
default_scheduler.clear(tag)
|
||||
|
||||
|
||||
def cancel_job(job):
|
||||
"""Calls :meth:`cancel_job <Scheduler.cancel_job>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
default_scheduler.cancel_job(job)
|
||||
|
||||
|
||||
def next_run():
|
||||
"""Calls :meth:`next_run <Scheduler.next_run>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
return default_scheduler.next_run
|
||||
|
||||
|
||||
def idle_seconds():
|
||||
"""Calls :meth:`idle_seconds <Scheduler.idle_seconds>` on the
|
||||
:data:`default scheduler instance <default_scheduler>`.
|
||||
"""
|
||||
return default_scheduler.idle_seconds
|
||||
Loading…
Reference in a new issue