small fix (#26)

* updated README

* improved %words command

* new words scanner

* fix test

* concurrent fast analysis

* fast analysis if fresh

* better memory handling

* fix "stuck" bug

* updated README

* improved %words command

* small fix

.gitignore

@@ -5,3 +5,4 @@ __pycache__
 error_*
 *.log
 /logs/
+.vscode

LICENSE

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

README.md

@@ -1,3 +1,4 @@
+![Python Version >= 3.7](https://img.shields.io/badge/python-%3E=3.7%20-blue)
 [![Scc Count Badge](https://sloc.xyz/github/klemek/discord-analyst/?category=code)](https://github.com/boyter/scc/#badges-beta)
 [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/Klemek/discord-analyst.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Klemek/discord-analyst/context:python)
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/Klemek/discord-analyst.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Klemek/discord-analyst/alerts/)
@@ -5,8 +6,11 @@
 
 # Discord Analyst
 
-When you need statistics about your discord server
+#### 📈 Gives you precisions you never asked for.
 
+![preview](https://user-images.githubusercontent.com/12103162/111427226-1823ac80-86f6-11eb-9581-fada2db43143.png)
+
+## All commands
 ```
 * %help (command) - info about commands
 * %info - version and uptime
@@ -14,6 +18,9 @@ When you need statistics about your discord server
 * %freq - frequency analysis
 * %compo - composition analysis
 * %pres - presence analysis
+* %first - read first message
+* %rand - read a random message
+* %last - read last message
 * %emojis - rank emotes by their usage
   * arguments:
     * <n> - top <n> emojis, default is 20
@@ -36,7 +43,11 @@ When you need statistics about your discord server
 * %react - rank users by their reactions
   * arguments:
     * <n> - top <n> messages, default is 10
-* %cancel - cancel current analysis
+* %words - rank words by their usage
+  * arguments:
+    * <n> - words containings <n> or more letters, default is 3
+    * <n2> - top <n2> words, default is 10
+* %cancel - cancel current analysis (not launched with fast)
 
 * Common arguments:
     * @member/me: filter for one or more member
@@ -93,6 +104,15 @@ python3 src/main.py
 
 ## Changelog
 
+* **v1.12**
+  * more scans: `%words`
+  * concurrent `fast` analysis
+  * assume `fast` if last analysis is fresh
+  * better memory handling
+  * bug fix
+* **v1.11**
+  * more scans: `%first`, `%rand`, `%last`
+  * streak computing in `%pres`
 * **v1.10**
   * multithreading for queries
   * bug fix

src/data_types/__init__.py

@@ -3,3 +3,4 @@ from .frequency import Frequency
 from .composition import Composition
 from .presence import Presence
 from .counter import Counter
+from .history import History

src/data_types/counter.py

@@ -49,7 +49,7 @@ class Counter:
         else:
             output += f"**#{i + 1}**"
         sum = val_sum(self.usages)
-        output += f" {name} - {plural(sum, counted)} ({percent(sum/total_usage)}) (last {from_now(self.last_used)})"
+        output += f" {name} - {plural(sum, counted)} ({percent(sum/total_usage)}, last {from_now(self.last_used)})"
         top_item = top_key(self.usages)
         if top_item != 0 and transform is not None:
             if self.usages[top_item] == sum:

src/data_types/frequency.py

@@ -2,7 +2,16 @@ from typing import List
 from datetime import timedelta
 import calendar
 
-from utils import str_date, str_datetime, from_now, plural, percent, precise, top_key
+from utils import (
+    str_date,
+    str_datetime,
+    from_now,
+    plural,
+    percent,
+    precise,
+    top_key,
+    mention,
+)
 
 
 class Frequency:
@@ -16,8 +25,19 @@ class Frequency:
         self.busiest_day_count = 0
         self.busiest_hour = None
         self.busiest_hour_count = 0
+        self.streaks = []
+        self.last_author = None
+        self.last_streak_start = None
+        self.last_streak_author = None
+        self.longest_streak = None
+        self.longest_streak_start = None
+        self.longest_streak_author = None
 
-    def to_string(self) -> List[str]:
+    def to_string(
+        self,
+        *,
+        member_specific: bool,
+    ) -> List[str]:
         delta = self.dates[-1] - self.dates[0]
         total_msg = len(self.dates)
         busiest_weekday = top_key(self.week)
@@ -31,14 +51,24 @@ class Frequency:
         n_hours = delta.days
         if self.dates[0].hour <= busiest_hour and self.dates[-1].hour >= busiest_hour:
             n_hours += 1
-        return [
+        ret = [
             f"- **earliest message**: {str_datetime(self.dates[0])} ({from_now(self.dates[0])})",
             f"- **latest message**: {str_datetime(self.dates[-1])} ({from_now(self.dates[-1])})",
             f"- **messages/day**: {precise(total_msg/delta.days, precision=3)}",
             f"- **busiest day of week**: {calendar.day_name[busiest_weekday]} (~{precise(self.week[busiest_weekday]/n_weekdays, precision=3)} msg, {percent(self.week[busiest_weekday]/total_msg)})",
-            f"- **busiest day ever**: {str_date(self.busiest_day)} ({from_now(self.busiest_day)}) ({self.busiest_day_count} msg)",
+            f"- **busiest day ever**: {str_date(self.busiest_day)} ({from_now(self.busiest_day)}, {self.busiest_day_count} msg)",
             f"- **messages/hour**: {precise(total_msg*3600/delta.total_seconds(), precision=3)}",
             f"- **busiest hour of day**: {busiest_hour:0>2}:00 (~{precise(self.day[busiest_hour]/n_hours, precision=3)} msg, {percent(self.day[busiest_hour]/total_msg)})",
-            f"- **busiest hour ever**: {str_datetime(self.busiest_hour)} ({from_now(self.busiest_hour)}) ({self.busiest_hour_count} msg)",
+            f"- **busiest hour ever**: {str_datetime(self.busiest_hour)} ({from_now(self.busiest_hour)}, {self.busiest_hour_count} msg)",
             f"- **longest break**: {plural(round(self.longest_break.total_seconds()/3600), 'hour')} ({plural(self.longest_break.days,'day')}) from {str_datetime(self.longest_break_start)} ({from_now(self.longest_break_start)})",
+            f"- **avg. streak**: {precise(sum(self.streaks)/len(self.streaks), precision=3)} msg",
         ]
+        if member_specific:
+            ret += [
+                f"- **longest streak**: {self.longest_streak:,} msg from {str_datetime(self.longest_streak_start)} ({from_now(self.longest_streak_start)})"
+            ]
+        else:
+            ret += [
+                f"- **longest streak**: {mention(self.longest_streak_author)} ({self.longest_streak:,} msg from {str_datetime(self.longest_streak_start)}, {from_now(self.longest_streak_start)})"
+            ]
+        return ret

src/data_types/history.py

@@ -0,0 +1,39 @@
+from typing import List
+import random
+
+# Custom libs
+
+from utils import mention, from_now, str_datetime, message_link
+
+
+class History:
+    def __init__(self):
+        self.messages = []
+
+    def to_string(self, *, type: str) -> List[str]:
+        if len(self.messages) == 0:
+            return ["There was no messages matching your filters"]
+        message = None
+        intro = None
+        if type == "first":
+            self.messages.sort(key=lambda m: m.created_at)
+            message = self.messages[0]
+            intro = f"First message out of {len(self.messages):,}"
+        elif type == "last":
+            self.messages.sort(key=lambda m: m.created_at, reverse=True)
+            message = self.messages[0]
+            intro = f"Last message out of {len(self.messages):,}"
+        elif type == "random":
+            message = random.choice(self.messages)
+            intro = f"Random message out of {len(self.messages):,}"
+
+        text = ["> " + line for line in message.content.splitlines()]
+        if message.attachment:
+            text += ["> <image>" if message.image else "> <attachment>"]
+
+        return [
+            intro,
+            f"{str_datetime(message.created_at)} ({from_now(message.created_at)}) {mention(message.author)} said:",
+            *text,
+            f"<{message_link(message)}>",
+        ]

src/logs/channel_logs.py

@@ -1,4 +1,4 @@
-from typing import Union, Tuple
+from typing import Union, Tuple, Any
 import discord
 
 from . import MessageLog
@@ -9,7 +9,8 @@ FORMAT = 3
 
 
 class ChannelLogs:
-    def __init__(self, channel: Union[discord.TextChannel, dict]):
+    def __init__(self, channel: Union[discord.TextChannel, dict], guild: Any):
+        self.guild = guild
         if isinstance(channel, discord.TextChannel):
             self.id = channel.id
             self.name = channel.name
@@ -27,7 +28,9 @@ class ChannelLogs:
                 if channel["last_message_id"] is not None
                 else None
             )
-            self.messages = [MessageLog(message) for message in channel["messages"]]
+            self.messages = [
+                MessageLog(message, self) for message in channel["messages"]
+            ]
 
     def is_format(self):
         return self.format == FORMAT
@@ -37,14 +40,19 @@ class ChannelLogs:
         self.channel = channel
         try:
             if self.last_message_id is not None:  # append
-                while self.last_message_id != channel.last_message_id:
+                tmp_message_id = None
+                while (
+                    self.last_message_id != channel.last_message_id
+                    and self.last_message_id != tmp_message_id
+                ):
+                    tmp_message_id = self.last_message_id
                     async for message in channel.history(
                         limit=CHUNK_SIZE,
                         after=FakeMessage(self.last_message_id),
                         oldest_first=True,
                     ):
                         self.last_message_id = message.id
-                        m = MessageLog(message)
+                        m = MessageLog(message, self)
                         await m.load(message)
                         self.messages.insert(0, m)
                     yield len(self.messages), False
@@ -64,7 +72,7 @@ class ChannelLogs:
                         ):
                             done += 1
                             last_message_id = message.id
-                            m = MessageLog(message)
+                            m = MessageLog(message, self)
                             await m.load(message)
                             self.messages += [m]
                         yield len(self.messages), False
@@ -77,5 +85,6 @@ class ChannelLogs:
     def dict(self) -> dict:
         channel = dict(self.__dict__)
         channel.pop("channel", None)
+        channel.pop("guild", None)
         channel["messages"] = [message.dict() for message in self.messages]
         return channel

src/logs/guild_logs.py

@@ -4,8 +4,10 @@ import discord
 import json
 import gzip
 from datetime import datetime
+import time
 import logging
 import asyncio
+import threading
 
 
 from . import ChannelLogs
@@ -15,11 +17,14 @@ from utils import code_message, delta, deltas
 LOG_DIR = "logs"
 
 current_analysis = []
+current_analysis_lock = threading.Lock()
 
 
 ALREADY_RUNNING = -100
 CANCELLED = -200
 
+MIN_MODIFICATION_TIME = 5 * 60
+
 
 class Worker:
     def __init__(self, channel_log: ChannelLogs, channel: discord.TextChannel):
@@ -47,15 +52,43 @@ class Worker:
 
 class GuildLogs:
     def __init__(self, guild: discord.Guild):
+        self.id = guild.id
         self.guild = guild
         self.log_file = os.path.join(LOG_DIR, f"{guild.id}.logz")
         self.channels = {}
+        self.locked = False
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, tb):
+        del self.channels
+        del self.guild
+        if self.locked:
+            self.unlock()
 
     def dict(self) -> dict:
         return {id: self.channels[id].dict() for id in self.channels}
 
     def check_cancelled(self) -> bool:
-        return self.log_file not in current_analysis
+        return self.locked and self.log_file not in current_analysis
+
+    def lock(self) -> bool:
+        self.locked = True
+        current_analysis_lock.acquire()
+        if self.log_file in current_analysis:
+            current_analysis_lock.release()
+            return False
+        current_analysis.append(self.log_file)
+        current_analysis_lock.release()
+        return True
+
+    def unlock(self):
+        self.locked = False
+        current_analysis_lock.acquire()
+        if self.log_file in current_analysis:
+            current_analysis.remove(self.log_file)
+        current_analysis_lock.release()
 
     async def load(
         self,
@@ -65,17 +98,18 @@ class GuildLogs:
         fast: bool,
         fresh: bool,
     ) -> Tuple[int, int]:
-        global current_analysis
-        if self.log_file in current_analysis:
+        self.locked = False
+        if not fast and not self.lock():
             return ALREADY_RUNNING, 0
-        current_analysis += [self.log_file]
         t00 = datetime.now()
         # read logs
         if not os.path.exists(LOG_DIR):
             os.mkdir(LOG_DIR)
+        last_time = None
         if os.path.exists(self.log_file):
             channels = {}
             try:
+                last_time = os.path.getmtime(self.log_file)
                 gziped_data = None
                 await code_message(progress, "Reading saved history (1/4)...")
                 t0 = datetime.now()
@@ -87,6 +121,7 @@ class GuildLogs:
                 await code_message(progress, "Reading saved history (2/4)...")
                 t0 = datetime.now()
                 json_data = gzip.decompress(gziped_data)
+                del gziped_data
                 logging.info(
                     f"log {self.guild.id} > gzip decompress in {delta(t0):,}ms"
                 )
@@ -95,12 +130,15 @@ class GuildLogs:
                 await code_message(progress, "Reading saved history (3/4)...")
                 t0 = datetime.now()
                 channels = json.loads(json_data)
+                del json_data
                 logging.info(f"log {self.guild.id} > json parse in {delta(t0):,}ms")
                 if self.check_cancelled():
                     return CANCELLED, 0
                 await code_message(progress, "Reading saved history (4/4)...")
                 t0 = datetime.now()
-                self.channels = {int(id): ChannelLogs(channels[id]) for id in channels}
+                self.channels = {
+                    int(id): ChannelLogs(channels[id], self) for id in channels
+                }
                 # remove invalid format
                 self.channels = {
                     id: self.channels[id]
@@ -115,31 +153,54 @@ class GuildLogs:
         else:
             fast = False
 
+        if len(target_channels) == 0:
+            target_channels = (
+                self.channels.values() if fast else self.guild.text_channels
+            )
+        elif fast:
+            # select already loaded channels only
+            target_channels_tmp = [
+                channel for channel in target_channels if channel.id in self.channels
+            ]
+            if len(target_channels_tmp) == 0:
+                fast = False
+            else:
+                target_channels = target_channels_tmp
+
+        # assume fast if file is fresh
+        if (
+            not fast
+            and not fresh
+            and last_time is not None
+            and (time.time() - last_time) < MIN_MODIFICATION_TIME
+        ):
+            invalid_target_channels = [
+                channel
+                for channel in target_channels
+                if channel.id not in self.channels
+            ]
+            if len(invalid_target_channels) == 0:
+                fast = True
+                if self.locked:
+                    self.unlock()
+
         total_msg = 0
         total_chan = 0
         if fast:
-            if len(target_channels) == 0:
-                total_msg = sum(
-                    [len(channel.messages) for channel in self.channels.values()]
-                )
-                total_chan = len(self.channels)
-            else:
-                target_channels_id = [channel.id for channel in target_channels]
-                total_msg = sum(
-                    [
-                        len(channel.messages)
-                        for channel in self.channels.values()
-                        if channel.id in target_channels_id
-                    ]
-                )
-                total_chan = len(target_channels)
+            target_channels_id = [channel.id for channel in target_channels]
+            total_msg = sum(
+                [
+                    len(channel.messages)
+                    for channel in self.channels.values()
+                    if channel.id in target_channels_id
+                ]
+            )
+            total_chan = len(target_channels)
         else:
+            if not self.locked and not self.lock():
+                return ALREADY_RUNNING, 0
             # load channels
             t0 = datetime.now()
-            if len(target_channels) == 0:
-                target_channels = (
-                    self.guild.text_channels if not fast else self.channels.keys()
-                )
             loading_new = 0
             queried_msg = 0
             total_chan = 0
@@ -150,7 +211,7 @@ class GuildLogs:
             for channel in target_channels:
                 if channel.id not in self.channels or fresh:
                     loading_new += 1
-                    self.channels[channel.id] = ChannelLogs(channel)
+                    self.channels[channel.id] = ChannelLogs(channel, self)
                 workers += [Worker(self.channels[channel.id], channel)]
             warning_msg = "(this might take a while)"
             if len(target_channels) > 5 and loading_new > 5:
@@ -218,6 +279,7 @@ class GuildLogs:
             )
             t0 = datetime.now()
             gziped_data = gzip.compress(json_data)
+            del json_data
             logging.info(
                 f"log {self.guild.id} > gzip in {delta(t0):,}ms -> {real_total_msg / deltas(t0):,.3f} m/s"
             )
@@ -230,6 +292,7 @@ class GuildLogs:
             t0 = datetime.now()
             with open(self.log_file, mode="wb") as f:
                 f.write(gziped_data)
+            del gziped_data
             logging.info(
                 f"log {self.guild.id} > saved in {delta(t0):,}ms -> {real_total_msg / deltas(t0):,.3f} m/s"
             )
@@ -240,15 +303,22 @@ class GuildLogs:
             f"Analysing...\n{total_msg:,} messages in {total_chan:,} channels",
         )
         logging.info(f"log {self.guild.id} > TOTAL TIME: {delta(t00):,}ms")
-        current_analysis.remove(self.log_file)
+        if self.locked:
+            current_analysis_lock.acquire()
+            current_analysis.remove(self.log_file)
+            current_analysis_lock.release()
         return total_msg, total_chan
 
     @staticmethod
     async def cancel(client: discord.client, message: discord.Message, *args: str):
         logs = GuildLogs(message.guild)
+        current_analysis_lock.acquire()
         if logs.log_file in current_analysis:
             current_analysis.remove(logs.log_file)
+            current_analysis_lock.release()
         else:
+            current_analysis_lock.release()
             await message.channel.send(
-                f"No analysis are currently running on this server", reference=message
+                f"No cancellable analysis are currently running on this server",
+                reference=message,
             )

src/logs/message_log.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Any
 import discord
 from datetime import datetime
 
@@ -9,7 +9,8 @@ EMBED_IMAGES = ["image", "gifv"]
 
 
 class MessageLog:
-    def __init__(self, message: Union[discord.Message, dict]):
+    def __init__(self, message: Union[discord.Message, dict], channel: Any):
+        self.channel = channel
         if isinstance(message, discord.Message):
             self.id = message.id
             self.created_at = message.created_at
@@ -78,6 +79,7 @@ class MessageLog:
 
     def dict(self) -> dict:
         message = dict(self.__dict__)
+        message.pop("channel", None)
         message["created_at"] = self.created_at.isoformat()
         message["edited_at"] = (
             self.edited_at.isoformat() if self.edited_at is not None else None

src/main.py

@@ -1,6 +1,11 @@
+import sys
 from miniscord import Bot
 import logging
 
+if sys.version_info < (3, 7):
+    print("Please upgrade your Python version to 3.7.0 or higher")
+    sys.exit(1)
+
 from utils import emojis
 from scanners import (
     EmotesScanner,
@@ -13,6 +18,10 @@ from scanners import (
     MessagesScanner,
     ChannelsScanner,
     ReactionsScanner,
+    FirstScanner,
+    RandomScanner,
+    LastScanner,
+    WordsScanner,
 )
 from logs import GuildLogs
 
@@ -24,7 +33,7 @@ emojis.load_emojis()
 
 bot = Bot(
     "Discord Analyst",
-    "1.10",
+    "1.12",
     alias="%",
 )
 
@@ -33,8 +42,32 @@ bot.log_calls = True
 bot.register_command(
     "(cancel|stop)",
     GuildLogs.cancel,
-    "cancel: stop current analysis",
-    "```\n" + "%cancel: Stop current analysis\n" + "```",
+    "cancel: stop current analysis (not launched with fast)",
+    "```\n" + "%cancel: Stop current analysis (not launched with fast)\n" + "```",
+)
+bot.register_command(
+    "last",
+    lambda *args: LastScanner().compute(*args),
+    "last: read last message",
+    LastScanner.help(),
+)
+bot.register_command(
+    "rand(om)?",
+    lambda *args: RandomScanner().compute(*args),
+    "rand: read a random message",
+    RandomScanner.help(),
+)
+bot.register_command(
+    "first",
+    lambda *args: FirstScanner().compute(*args),
+    "first: read first message",
+    FirstScanner.help(),
+)
+bot.register_command(
+    "words",
+    lambda *args: WordsScanner().compute(*args),
+    "words: rank words by their usage",
+    WordsScanner.help(),
 )
 bot.register_command(
     "mentioned",

src/scanners/__init__.py

@@ -8,3 +8,7 @@ from .mentioned_scanner import MentionedScanner
 from .messages_scanner import MessagesScanner
 from .channels_scanner import ChannelsScanner
 from .reactions_scanner import ReactionsScanner
+from .first_scanner import FirstScanner
+from .last_scanner import LastScanner
+from .random_scanner import RandomScanner
+from .words_scanner import WordsScanner

src/scanners/first_scanner.py

@@ -0,0 +1,19 @@
+from typing import List
+
+# Custom libs
+
+from .history_scanner import HistoryScanner
+
+
+class FirstScanner(HistoryScanner):
+    @staticmethod
+    def help() -> str:
+        return super(FirstScanner, FirstScanner).help(
+            cmd="first", text="Read first message"
+        )
+
+    def __init__(self):
+        super().__init__(help=FirstScanner.help())
+
+    def get_results(self, intro: str) -> List[str]:
+        return self.history.to_string(type="first")

src/scanners/frequency_scanner.py

@@ -44,7 +44,9 @@ class FrequencyScanner(Scanner):
     def get_results(self, intro: str) -> List[str]:
         FrequencyScanner.compute_results(self.freq)
         res = [intro]
-        res += self.freq.to_string()
+        res += self.freq.to_string(
+            member_specific=self.member_specific,
+        )
         return res
 
     @staticmethod
@@ -64,6 +66,20 @@ class FrequencyScanner(Scanner):
         ):
             impacted = True
             freq.dates += [message.created_at]
+            if message.author == freq.last_author:
+                freq.streaks[-1] += 1
+            else:
+                if len(freq.streaks) > 0 and (
+                    freq.longest_streak is None
+                    or freq.streaks[-1] > freq.longest_streak
+                ):
+                    freq.longest_streak = freq.streaks[-1]
+                    freq.longest_streak_start = freq.last_streak_start
+                    freq.longest_streak_author = freq.last_streak_author
+                freq.streaks += [1]
+                freq.last_streak_start = message.created_at
+                freq.last_streak_author = message.author
+        freq.last_author = message.author
         return impacted
 
     @staticmethod

src/scanners/full_scanner.py

@@ -63,7 +63,7 @@ class FullScanner(Scanner):
         FrequencyScanner.compute_results(self.freq)
         res = [intro]
         res += ["__Frequency__:"]
-        res += self.freq.to_string()
+        res += self.freq.to_string(member_specific=self.member_specific)
         res += ["__Composition__:"]
         res += self.compo.to_string(self.msg_count)
         res += ["__Presence__:"]

src/scanners/history_scanner.py

@@ -0,0 +1,70 @@
+from abc import ABC, abstractmethod
+from typing import List
+import discord
+
+# Custom libs
+
+from .scanner import Scanner
+from data_types import History
+from logs import ChannelLogs, MessageLog
+from utils import COMMON_HELP_ARGS
+
+
+class HistoryScanner(Scanner, ABC):
+    @staticmethod
+    def help(*, cmd: str, text: str) -> str:
+        return (
+            "```\n"
+            + f"%{cmd}: {text}\n"
+            + "arguments:\n"
+            + COMMON_HELP_ARGS
+            + "* all/everyone - include bots\n"
+            + "Example: %{cmd} #mychannel1 @user\n"
+            + "```"
+        )
+
+    def __init__(self, *, help: str):
+        super().__init__(
+            has_digit_args=True,
+            valid_args=["all", "everyone"],
+            help=help,
+            intro_context="",
+        )
+
+    async def init(self, message: discord.Message, *args: str) -> bool:
+        self.history = History()
+        self.all_messages = "all" in args or "everyone" in args
+        return True
+
+    def compute_message(self, channel: ChannelLogs, message: MessageLog):
+        return HistoryScanner.analyse_message(
+            channel,
+            message,
+            self.history,
+            self.raw_members,
+            all_messages=self.all_messages,
+        )
+
+    @abstractmethod
+    def get_results(self, intro: str):
+        pass
+
+    @staticmethod
+    def analyse_message(
+        channel: ChannelLogs,
+        message: MessageLog,
+        history: History,
+        raw_members: List[int],
+        *,
+        all_messages: bool,
+    ) -> bool:
+        impacted = False
+        # If author is included in the selection (empty list is all)
+        if (
+            (not message.bot or all_messages)
+            and len(raw_members) == 0
+            or message.author in raw_members
+        ) and (message.content or message.attachment):
+            impacted = True
+            history.messages += [message]
+        return impacted

src/scanners/last_scanner.py

@@ -0,0 +1,19 @@
+from typing import List
+
+# Custom libs
+
+from .history_scanner import HistoryScanner
+
+
+class LastScanner(HistoryScanner):
+    @staticmethod
+    def help() -> str:
+        return super(LastScanner, LastScanner).help(
+            cmd="last", text="Read last message"
+        )
+
+    def __init__(self):
+        super().__init__(help=LastScanner.help())
+
+    def get_results(self, intro: str) -> List[str]:
+        return self.history.to_string(type="last")

src/scanners/random_scanner.py

@@ -0,0 +1,19 @@
+from typing import List
+
+# Custom libs
+
+from .history_scanner import HistoryScanner
+
+
+class RandomScanner(HistoryScanner):
+    @staticmethod
+    def help() -> str:
+        return super(RandomScanner, RandomScanner).help(
+            cmd="rand", text="Read a random message"
+        )
+
+    def __init__(self):
+        super().__init__(help=RandomScanner.help())
+
+    def get_results(self, intro: str) -> List[str]:
+        return self.history.to_string(type="random")

src/scanners/scanner.py

@@ -5,7 +5,7 @@ import logging
 import re
 import discord
 
-from utils import no_duplicate, get_intro, delta, deltas, mention, channel_mention
+from utils import no_duplicate, get_intro, delta
 from logs import GuildLogs, ChannelLogs, MessageLog, ALREADY_RUNNING, CANCELLED
 
 
@@ -36,133 +36,134 @@ class Scanner(ABC):
     ):
         args = list(args)
         guild = message.guild
-        logs = GuildLogs(guild)
-
-        # If "%cmd help" redirect to "%help cmd"
-        if "help" in args:
-            await client.bot.help(client, message, "help", args[0])
-            return
-
-        # check args validity
-        str_channel_mentions = [str(channel.id) for channel in message.channel_mentions]
-        str_mentions = [str(member.id) for member in message.mentions]
-        for i, arg in enumerate(args[1:]):
-            if re.match(r"^<@!?\d+>$", arg):
-                arg = arg[3:-1] if "!" in arg else arg[2:-1]
-            elif re.match(r"^<#!?\d+>$", arg):
-                arg = arg[3:-1] if "!" in arg else arg[2:-1]
-            if (
-                arg not in self.valid_args + ["me", "here", "fast", "fresh"]
-                and (not arg.isdigit() or not self.has_digit_args)
-                and arg not in str_channel_mentions
-                and arg not in str_mentions
-            ):
-                await message.channel.send(
-                    f"Unrecognized argument: `{arg}`", reference=message
-                )
+        with GuildLogs(guild) as logs:
+            # If "%cmd help" redirect to "%help cmd"
+            if "help" in args:
+                await client.bot.help(client, message, "help", args[0])
                 return
 
-        # Get selected channels or all of them if no channel arguments
-        self.channels = no_duplicate(message.channel_mentions)
-
-        # transform the "here" arg
-        if "here" in args:
-            self.channels += [message.channel]
-
-        self.full = len(self.channels) == 0
-        if self.full:
-            self.channels = guild.text_channels
-
-        # Get selected members
-        self.members = no_duplicate(message.mentions)
-        self.raw_members = no_duplicate(message.raw_mentions)
-
-        # transform the "me" arg
-        if "me" in args:
-            self.members += [message.author]
-            self.raw_members += [message.author.id]
-
-        if not await self.init(message, *args):
-            return
-
-        # Start computing data
-        async with message.channel.typing():
-            progress = await message.channel.send(
-                "```Starting analysis...```",
-                reference=message,
-                allowed_mentions=discord.AllowedMentions.none(),
-            )
-            total_msg, total_chan = await logs.load(
-                progress, self.channels, fast="fast" in args, fresh="fresh" in args
-            )
-            if total_msg == CANCELLED:
-                await message.channel.send(
-                    "Operation cancelled by user",
-                    reference=message,
-                )
-            elif total_msg == ALREADY_RUNNING:
-                await message.channel.send(
-                    "An analysis is already running on this server, please be patient.",
-                    reference=message,
-                )
-            else:
-                self.msg_count = 0
-                self.total_msg = 0
-                self.chan_count = 0
-                t0 = datetime.now()
-                for channel in self.channels:
-                    if channel.id in logs.channels:
-                        channel_logs = logs.channels[channel.id]
-                        count = sum(
-                            [
-                                self.compute_message(channel_logs, message_log)
-                                for message_log in channel_logs.messages
-                            ]
-                        )
-                        self.total_msg += len(channel_logs.messages)
-                        self.msg_count += count
-                        self.chan_count += 1 if count > 0 else 0
-                logging.info(f"scan {guild.id} > scanned in {delta(t0):,}ms")
-                if self.total_msg == 0:
+            # check args validity
+            str_channel_mentions = [
+                str(channel.id) for channel in message.channel_mentions
+            ]
+            str_mentions = [str(member.id) for member in message.mentions]
+            for i, arg in enumerate(args[1:]):
+                if re.match(r"^<@!?\d+>$", arg):
+                    arg = arg[3:-1] if "!" in arg else arg[2:-1]
+                elif re.match(r"^<#!?\d+>$", arg):
+                    arg = arg[3:-1] if "!" in arg else arg[2:-1]
+                if (
+                    arg not in self.valid_args + ["me", "here", "fast", "fresh"]
+                    and (not arg.isdigit() or not self.has_digit_args)
+                    and arg not in str_channel_mentions
+                    and arg not in str_mentions
+                ):
                     await message.channel.send(
-                        "There are no messages found matching the filters",
+                        f"Unrecognized argument: `{arg}`", reference=message
+                    )
+                    return
+
+            # Get selected channels or all of them if no channel arguments
+            self.channels = no_duplicate(message.channel_mentions)
+
+            # transform the "here" arg
+            if "here" in args:
+                self.channels += [message.channel]
+
+            self.full = len(self.channels) == 0
+            if self.full:
+                self.channels = guild.text_channels
+
+            # Get selected members
+            self.members = no_duplicate(message.mentions)
+            self.raw_members = no_duplicate(message.raw_mentions)
+
+            # transform the "me" arg
+            if "me" in args:
+                self.members += [message.author]
+                self.raw_members += [message.author.id]
+
+            if not await self.init(message, *args):
+                return
+
+            # Start computing data
+            async with message.channel.typing():
+                progress = await message.channel.send(
+                    "```Starting analysis...```",
+                    reference=message,
+                    allowed_mentions=discord.AllowedMentions.none(),
+                )
+                total_msg, total_chan = await logs.load(
+                    progress, self.channels, fast="fast" in args, fresh="fresh" in args
+                )
+                if total_msg == CANCELLED:
+                    await message.channel.send(
+                        "Operation cancelled by user",
+                        reference=message,
+                    )
+                elif total_msg == ALREADY_RUNNING:
+                    await message.channel.send(
+                        "An analysis is already running on this server, please be patient.",
                         reference=message,
                     )
                 else:
-                    await progress.edit(content="```Computing results...```")
-                    # Display results
+                    self.msg_count = 0
+                    self.total_msg = 0
+                    self.chan_count = 0
                     t0 = datetime.now()
-                    results = self.get_results(
-                        get_intro(
-                            self.intro_context,
-                            self.full,
-                            self.channels,
-                            self.members,
-                            self.msg_count,
-                            self.chan_count,
+                    for channel in self.channels:
+                        if channel.id in logs.channels:
+                            channel_logs = logs.channels[channel.id]
+                            count = sum(
+                                [
+                                    self.compute_message(channel_logs, message_log)
+                                    for message_log in channel_logs.messages
+                                ]
+                            )
+                            self.total_msg += len(channel_logs.messages)
+                            self.msg_count += count
+                            self.chan_count += 1 if count > 0 else 0
+                    logging.info(f"scan {guild.id} > scanned in {delta(t0):,}ms")
+                    if self.total_msg == 0:
+                        await message.channel.send(
+                            "There are no messages found matching the filters",
+                            reference=message,
                         )
-                    )
-                    logging.info(f"scan {guild.id} > results in {delta(t0):,}ms")
-                    response = ""
-                    first = True
-                    for r in results:
-                        if len(response + "\n" + r) > 2000:
+                    else:
+                        await progress.edit(content="```Computing results...```")
+                        # Display results
+                        t0 = datetime.now()
+                        results = self.get_results(
+                            get_intro(
+                                self.intro_context,
+                                self.full,
+                                self.channels,
+                                self.members,
+                                self.msg_count,
+                                self.chan_count,
+                            )
+                        )
+                        logging.info(f"scan {guild.id} > results in {delta(t0):,}ms")
+                        response = ""
+                        first = True
+                        for r in results:
+                            if len(response + "\n" + r) > 2000:
+                                await message.channel.send(
+                                    response,
+                                    reference=message if first else None,
+                                    allowed_mentions=discord.AllowedMentions.none(),
+                                )
+                                first = False
+                                response = ""
+                            response += "\n" + r
+                        if len(response) > 0:
                             await message.channel.send(
                                 response,
                                 reference=message if first else None,
                                 allowed_mentions=discord.AllowedMentions.none(),
                             )
-                            first = False
-                            response = ""
-                        response += "\n" + r
-                    if len(response) > 0:
-                        await message.channel.send(
-                            response,
-                            reference=message if first else None,
-                            allowed_mentions=discord.AllowedMentions.none(),
-                        )
-            # Delete custom progress message
-            await progress.delete()
+                # Delete custom progress message
+                await progress.delete()
 
     @abstractmethod
     async def init(self, message: discord.Message, *args: str) -> bool:
@@ -173,5 +174,5 @@ class Scanner(ABC):
         pass
 
     @abstractmethod
-    def get_results(self, intro: str):
+    def get_results(self, intro: str) -> List[str]:
         pass

src/scanners/words_scanner.py

@@ -0,0 +1,132 @@
+from typing import Dict, List
+from collections import defaultdict
+import discord
+import re
+
+# Custom libs
+
+from logs import ChannelLogs, MessageLog
+from .scanner import Scanner
+from data_types import Counter
+from utils import (
+    COMMON_HELP_ARGS,
+    plural,
+    precise,
+)
+
+
+class WordsScanner(Scanner):
+    @staticmethod
+    def help() -> str:
+        return (
+            "```\n"
+            + "%words: Rank words by their usage\n"
+            + "arguments:\n"
+            + COMMON_HELP_ARGS
+            + "* <n> - words containings <n> or more letters, default is 3\n"
+            + "* <n2> - top <n2> words, default is 10\n"
+            + "* everyone - include bots\n"
+            + "Example: %words 5 10 #mychannel1 #mychannel2 @user\n"
+            + "```"
+        )
+
+    def __init__(self):
+        super().__init__(
+            has_digit_args=True,
+            valid_args=["all", "everyone"],
+            help=WordsScanner.help(),
+            intro_context="Words ({}+ letters)",
+        )
+
+    async def init(self, message: discord.Message, *args: str) -> bool:
+        self.letters = None
+        self.top = None
+        for arg in args:
+            if arg.isdigit():
+                if self.letters is None:
+                    self.letters = int(arg)
+                elif self.top is None:
+                    self.top = int(arg)
+        if self.letters is None:
+            self.letters = 3
+        if self.top is None:
+            self.top = 10
+        self.words = defaultdict(Counter)
+        self.all_messages = "all" in args or "everyone" in args
+        return True
+
+    def compute_message(self, channel: ChannelLogs, message: MessageLog):
+        return WordsScanner.analyse_message(
+            message,
+            self.words,
+            self.raw_members,
+            all_messages=self.all_messages,
+            letters_threshold=self.letters,
+        )
+
+    def get_results(self, intro: str) -> List[str]:
+        words = [word for word in self.words]
+        words.sort(key=lambda word: self.words[word].score(), reverse=True)
+        words = words[: self.top]
+        # Get the total of all emotes used
+        usage_count = Counter.total(self.words)
+        print(len(self.words))
+        res = [intro.format(self.letters)]
+        res += [
+            self.words[word].to_string(
+                words.index(word),
+                f"`{word}`",
+                total_usage=usage_count,
+            )
+            for word in words
+        ]
+        res += [
+            f"Total: {plural(usage_count,'time')} ({precise(usage_count/self.msg_count)}/msg)"
+        ]
+        return res
+
+    special_cases = ["'s", "s"]
+
+    @staticmethod
+    def analyse_message(
+        message: MessageLog,
+        words: Dict[str, Counter],
+        raw_members: List[int],
+        *,
+        all_messages: bool,
+        letters_threshold: int,
+    ) -> bool:
+        impacted = False
+        # If author is included in the selection (empty list is all)
+        if (
+            (not message.bot or all_messages)
+            and len(raw_members) == 0
+            or message.author in raw_members
+        ):
+            impacted = True
+            content = " ".join(
+                [
+                    block
+                    for block in message.content.split()
+                    if not re.match(r"^\w+:\/\/", block)
+                ]
+            )
+            for word in re.split("[^\w\-':]", content):
+                m = re.match(
+                    r"(?!^:\w+:$)^[^\w]*((?![\d_])\w.*(?![\d_])\w)[^\w]*$", word
+                )
+                if m:
+                    word = m[1].lower()
+                    if len(word) >= letters_threshold:
+                        for case in WordsScanner.special_cases:
+                            if word.endswith(case) and word[: -len(case)] in words:
+                                word = word[: -len(case)]
+                                break
+                            if word + case in words:
+                                words[word] = words[word + case]
+                                del words[word + case]
+                                break
+                        words[word].update_use(
+                            message.content.count(word), message.created_at
+                        )
+        return impacted

src/utils/utils.py

@@ -51,6 +51,10 @@ def channel_mention(channel_id: int) -> str:
     return f"<#{channel_id}>"
 
 
+def message_link(message: discord.Message) -> str:
+    return f"https://discord.com/channels/{message.channel.guild.id}/{message.channel.id}/{message.id}"
+
+
 class FakeMessage:
     def __init__(self, id: int):
         self.id = id