summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2009-05-15 13:47:25 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2009-05-15 13:47:25 (GMT)
commit168463b46dd58dd24009f2aacef604bab01300a5 (patch) (side-by-side diff)
tree903b5dcd23037c04ad255b188f92a033a025f0c2
downloadgrot-168463b46dd58dd24009f2aacef604bab01300a5.tar.gz
grot-168463b46dd58dd24009f2aacef604bab01300a5.tar.bz2
Initial commit
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--.gitignore7
-rw-r--r--AUTHORS1
-rw-r--r--COPYING676
-rw-r--r--INSTALL79
-rw-r--r--Makefile114
-rw-r--r--NEWS36
-rw-r--r--README57
-rw-r--r--cmdline.opt108
-rw-r--r--getopt.m4547
-rw-r--r--grot.1118
-rw-r--r--grot.c414
-rw-r--r--grot.cfg23
-rw-r--r--grot.cfg.594
-rw-r--r--grot.h48
14 files changed, 2322 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4cb4153
--- a/dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+*.o
+.emacs*
+.gdbinit
+*.tar
+*.tar.gz
+cmdline.c
+grot
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..89f81e3
--- a/dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+Sergey Poznyakoff gray@gnu.org
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..4432540
--- a/dev/null
+++ b/COPYING
@@ -0,0 +1,676 @@
+
+ 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:
+
+ <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
+<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>.
+
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..4923913
--- a/dev/null
+++ b/INSTALL
@@ -0,0 +1,79 @@
+* Generic installation instructions
+
+To compile the binary, run make. If the make fails due to not finding
+MySQL headers or libraries, see `MySQL Location', below.
+
+To install the package, run make install. By default, make will
+install the grot binary to /usr/bin, and the man pages to their
+corresponding directories under /usr/man. To change that, see
+`Installation Location'.
+
+* MySQL Location
+
+The default make process looks for MySQL headers in
+/usr/include/mysql or /usr/local/include/mysql and for MySQL libraries
+in /usr/lib/mysql or /usr/local/lib/mysql. This seems to match most
+existing installations. If, however, this fails for your
+installation, use CPPFLAGS and LDFLAGS variables to point to the right
+directories as described below.
+
+- CPPFLAGS
+
+The value of this variable is -I immediately followed by the name of
+the directory where MySQL headers are located. E.g.:
+
+ make CPPFLAGS=-I/some/special/dir
+
+This variable can contain several -Idir options separated by
+whitespace. Be sure to enclose the entire value in quotes, in that
+case.
+
+- LDFLAGS
+
+The value of this variable is -L immediately followed by the name of
+the directory where MySQL libraries are located. E.g.:
+
+ make LDFLAGS=-L/some/special/dir
+
+Several -L options (or other linker flags) can be given, provided that
+the entire value is properly quoted.
+
+* Installation Location
+
+The following make variables control the installation locations:
+
+- prefix
+
+Common installation prefix. Default is /usr.
+
+- bindir
+
+The directory where to install binary files. Default is /usr/bin.
+
+- mandir
+
+The directory where to install man pages. Default is /usr/man.
+
+For example, running:
+
+ make install prefix=/usr/local
+
+will install the binary to /usr/local/bin/ and the man pages to
+/usr/local/man.
+
+* Other Make Variables
+
+- CFLAGS
+
+Compilator flags. Default is -O2 -g.
+
+- LIBS
+
+Libraries to link with. Default is -lmysqlclient. This library is
+required.
+
+
+Local variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+end:
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..1647555
--- a/dev/null
+++ b/Makefile
@@ -0,0 +1,114 @@
+# This file is part of Grot.
+# Copyright (C) 2009 Sergey Poznyakoff
+#
+# Grot 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, or (at your option)
+# any later version.
+#
+# Grot 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 grot. If not, see <http://www.gnu.org/licenses/>.
+
+CFLAGS = -O2 -g
+CPPFLAGS = -I/usr/include/mysql -I/usr/local/include/mysql
+LDFLAGS = -L/usr/lib/mysql -L/usr/local/lib/mysql
+LIBS = -lmysqlclient
+
+prefix = /usr
+distdir = $(PROJECT)-$(VERSION)
+bindir = $(prefix)/bin
+mandir = $(prefix)/man
+
+##
+
+PROJECT = grot
+VERSION = 1.0
+
+ALLDEFS = -DPACKAGE="\"$(PROJECT)\"" -DVERSION="\"$(VERSION)\""
+
+.c.o:
+ $(CC) $(CFLAGS) $(CPPFLAGS) $(ALLDEFS) $(DEFS) -c -o $@ $<
+
+all: grot
+
+grot_SOURCES = \
+ grot.c\
+ cmdline.c
+
+grot_HEADERS = grot.h
+
+grot_MANS = grot.1 grot.cfg.5
+
+grot_OBJECTS = $(grot_SOURCES:.c=.o)
+
+EXTRA_DIST = cmdline.opt getopt.m4 grot.cfg
+
+grot.o: grot.h grot.c
+
+cmdline.c: cmdline.opt
+ m4 -s getopt.m4 $< | sed '1d' > $@
+
+grot: $(grot_OBJECTS)
+ $(CC) -ogrot $(grot_OBJECTS) $(LDFLAGS) $(LIBS)
+
+clean:
+ rm -f $(grot_OBJECTS) grot
+
+install: install-bin install-man
+
+install-bin: grot
+ test -d $(DESTDIR)/$(bindir) || mkdir -p $(DESTDIR)/$(bindir)
+ cp grot $(DESTDIR)/$(bindir)
+
+install-man: $(grot_MANS)
+ for file in $(grot_MANS); \
+ do \
+ num=`expr "$$file" : '.*\.\([0-9]\)'`; \
+ dir=$(DESTDIR)/$(mandir)/man$$num; \
+ test -d $$dir || mkdir -p $$dir; \
+ cp $$file $$dir; \
+ done
+
+distfiles = \
+ AUTHORS\
+ COPYING\
+ INSTALL\
+ README\
+ NEWS\
+ Makefile\
+ $(grot_SOURCES)\
+ $(grot_HEADERS)\
+ $(grot_MANS)\
+ $(EXTRA_DIST)
+
+distdir:
+ rm -rf $(distdir)
+ test -d $(distdir) || mkdir -p $(distdir)
+ for file in $(distfiles); \
+ do \
+ cp $$file $(distdir); \
+ done
+
+dist:
+ make distdir
+ tar -c -f - $(distdir) | gzip -c - > $(distdir).tar.gz
+ rm -rf $(distdir)
+
+distcheck:
+ make dist
+ gzip -c -d $(distdir).tar.gz | tar -x -f -
+ mkdir $(distdir)/_inst
+ cd $(distdir) && make && \
+ make install DESTDIR=_inst && \
+ make clean
+ rm -rf $(distdir)
+
+
+
+
+
diff --git a/NEWS b/NEWS
new file mode 100644
index 0000000..1d61162
--- a/dev/null
+++ b/NEWS
@@ -0,0 +1,36 @@
+Grot NEWS -- history of user-visible changes. 2009-05-15
+Copyright (C) 2009 Sergey Poznyakoff
+See the end of file for copying conditions.
+
+Please send Grot bug reports to <gray@gnu.org.ua>
+
+
+Version 1.0 (Git)
+
+Initial release.
+
+
+=========================================================================
+Copyright information:
+
+Copyright (C) 2009 Sergey Poznyakoff
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+Local variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+eval: (add-hook 'write-file-hooks 'time-stamp)
+time-stamp-start: "changes. "
+time-stamp-format: "%:y-%02m-%02d"
+time-stamp-end: "\n"
+end:
+
diff --git a/README b/README
new file mode 100644
index 0000000..ae10d7f
--- a/dev/null
+++ b/README
@@ -0,0 +1,57 @@
+Grot README
+Copyright (C) 2009 Sergey Poznyakoff
+See the end of file for copying conditions.
+
+* Introduction
+
+This file contains brief information about configuring, testing
+and running Grot. It is *not* intended as a replacement for
+documentation. The Grot documentation is available in manpage format.
+After installation, run `man grot', for information about the grot
+program, and `man grot.cfg' for a description of grot configuration
+file format.
+
+* Overview
+
+Grot is Gray's Rotation Tool for MySQL Binary Logs. These are special
+files that the MySQL server creates in order to replicate its data to
+slave servers. These files tend to occupy a lot of disk space, but
+cannot be easily rotated using the usual tools (e.g. logrotate),
+because it is unknown which of them is in use by which slave. Grot is
+designed to fill this gap. It polls each slave and determines the
+oldest log among ones used by them. Then it instructs the server to
+delete all logs that precede it.
+
+* Configuring and Installing
+
+See the INSTALL file for instructions.
+
+* Example
+
+See grot.cfg for an example of run-time configuration file.
+
+* Bug reporting.
+
+Send bug reports to <gray@gnu.org.ua>.
+
+
+* Copyright information:
+
+Copyright (C) 2009 Sergey Poznyakoff
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:
diff --git a/cmdline.opt b/cmdline.opt
new file mode 100644
index 0000000..16956d7
--- a/dev/null
+++ b/cmdline.opt
@@ -0,0 +1,108 @@
+/* This file is part of Grot. -*- c -*-
+ Copyright (C) 2009 Sergey Poznyakoff
+
+ Grot 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, or (at your option)
+ any later version.
+
+ Grot 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 grot. If not, see <http://www.gnu.org/licenses/>. */
+
+#include "grot.h"
+#include <getopt.h>
+
+#define gettext(s) s
+#define _(s) gettext(s)
+#define N_(s) s
+
+char *grot_host;
+char *grot_password;
+int password_option;
+unsigned grot_port;
+char *grot_socket;
+char *grot_user;
+int verbose;
+int dry_run_option;
+int flush_logs_option = 1;
+size_t keep_count;
+
+OPTIONS_BEGIN(gnu, "grot",
+ [<Gray's Rotation Tool for MySQL binary logs>])
+
+OPTION(host,H,[NAME],
+ [<server host>])
+BEGIN
+ grot_host = optarg;
+END
+
+OPTION(password,p,[PASS],
+ [<MySQL user password>])
+BEGIN
+ grot_password = optarg;
+ password_option = 1;
+END
+
+OPTION(port,P,NUMBER,
+ [<port number>])
+BEGIN
+ char *p;
+ grot_port = strtoul(optarg, &p, 10);
+ if (!grot_port || *p)
+ terror(1, NULL, "invalid port number: %s", optarg);
+END
+
+OPTION(socket,S,STRING,
+ [<socket file name>])
+BEGIN
+ grot_socket = optarg;
+END
+
+
+OPTION(user,u,NAME,
+ [<user name>])
+BEGIN
+ grot_user = optarg;
+END
+
+OPTION(verbose,v,,
+ [<increase verbosity level>])
+BEGIN
+ verbose++;
+END
+
+OPTION(dry-run,n,,
+ [<do not actually rotate the logs>])
+BEGIN
+ dry_run_option = 1;
+ verbose++;
+END
+
+OPTION(no-flush,,,
+ [<do not flush logs after rotating>])
+BEGIN
+ flush_logs_option = 0;
+END
+
+OPTION(keep,k,NUMBER,
+ [<keep NUMBER of files before oldest>])
+BEGIN
+ char *p;
+ keep_count = strtoul(optarg, &p, 0);
+ if (*p)
+ terror(1, NULL, "invalid number: %s", optarg);
+END
+
+OPTIONS_END
+
+void
+read_options(int argc, char *argv[])
+{
+ GETOPT(argc, argv)
+}
+
diff --git a/getopt.m4 b/getopt.m4
new file mode 100644
index 0000000..98c11bd
--- a/dev/null
+++ b/getopt.m4
@@ -0,0 +1,547 @@
+dnl This file is part of GNU Rush.
+dnl Copyright (C) 2007, 2008, 2009 Sergey Poznyakoff.
+dnl
+dnl GNU Rush is free software; you can redistribute it and/or modify
+dnl it under the terms of the GNU General Public License as published by
+dnl the Free Software Foundation; either version 3, or (at your option)
+dnl any later version.
+dnl
+dnl GNU Rush is distributed in the hope that it will be useful,
+dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
+dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+dnl GNU General Public License for more details.
+dnl
+dnl You should have received a copy of the GNU General Public License
+dnl along with GNU Rush. If not, see <http://www.gnu.org/licenses/>.
+divert(-1)
+changequote([<,>])
+changecom(/*,*/)
+
+dnl upcase(ARGS...)
+dnl Concatenate and convert ARGS to upper case.
+dnl
+define([<upcase>], [<translit([<$*>], [<a-z>], [<A-Z>])>])
+
+dnl concat(ARGS...)
+dnl Concatenate arguments, inserting ", " between each of pair of them.
+dnl
+define([<concat>],[<ifelse([<$#>],1,[<$1>],[<$1, concat(shift($@))>])>])
+
+dnl flushleft(ARGS...)
+dnl Concatenate ARGS and remove any leading whitespace
+dnl
+define([<flushleft>],
+ [<patsubst([<concat($*)>], [<^[ ]+>])>])
+
+dnl chop(ARGS...)
+dnl Concatenate ARGS and remove any trailing whitespace
+dnl
+define([<chop>],
+ [<patsubst([<$*>], [<[ ]+$>])>])
+
+dnl escape(ARGS...)
+dnl Concatenate ARGS and escape any occurrences of double-quotes with
+dnl backslashes.
+dnl
+define([<escape>],
+[<patsubst([<concat($*)>],[<[\"]>],[<\\\&>])>])
+
+dnl prep(ARG)
+dnl Prepare ARG for including in C strings: replace newlines with any amount
+dnl of preceding and following whitespace by a single space character, remove
+dnl leading whitespace, and escape double-quotes.
+dnl
+define([<prep>],
+ [<escape(flushleft(patsubst([<$1>],[<[ ]*
++[ ]*>],[< >])))>])
+
+dnl SHORT_OPTS
+dnl Accumulator for the 3rd argument of getopt_long
+dnl
+define([<SHORT_OPTS>],[<>])
+
+dnl GROUP(STRING)
+dnl Begin a named group of options
+dnl
+define([<GROUP>],[<dnl
+divert(3)ifdef([<IFCOND>],[<
+#ifdef IFCOND>])
+ { NULL, NULL, 0, N_("prep([<$1>])") },dnl
+ifdef([<IFCOND>],[<
+#endif>])
+divert(-1)>])
+
+define([<__GATHER_OPTIONS>],[<
+define([<KEY>],ifelse([<$2>],,[<OPTION_>]upcase(patsubst($1,-,_)),'$2'))
+ifelse([<$2>],,[<
+divert(1)ifdef([<IFCOND>],[<
+#ifdef IFCOND>])
+ KEY,dnl
+ifdef([<IFCOND>],[<
+#endif>])
+divert(-1)
+>])
+define([<SELECTOR>],ifdef([<SELECTOR>],SELECTOR) case KEY:)
+ifelse([<$1>],,,[<
+divert(2)ifdef([<IFCOND>],[<
+#ifdef IFCOND>])
+ { "$1", ARGTYPE, 0, KEY },dnl
+ifdef([<IFCOND>],[<
+#endif>])
+divert(-1)>])
+dnl
+define([<SHORT_OPTS>],SHORT_OPTS[<>]dnl
+ifelse([<$2>],,,dnl
+ifdef([<IFCOND>],[<
+#ifdef IFCOND>])
+"$2[<>]ifelse(ARGTYPE,[<no_argument>],,ARGTYPE,[<required_argument>],:,ARGTYPE,[<optional_argument>],::)"dnl
+ifdef([<IFCOND>],[<
+#endif
+>])))
+dnl
+ifelse([<$1>],,,dnl
+[<define([<LONG_TAG>],ifelse(LONG_TAG,,[<--$1>],[<LONG_TAG; --$1>]))>])
+ifelse([<$2>],,,dnl
+[<define([<SHORT_TAG>],ifelse(SHORT_TAG,,[<-$2>],[<SHORT_TAG; -$2>]))>])
+>])
+
+dnl OPTION(long-opt, short-opt, [arg], [descr])
+dnl Introduce a command line option. Arguments:
+dnl long-opt Long option.
+dnl short-opt Short option (a single char)
+dnl (At least one of long-opt or short-opt must be present)
+dnl
+dnl Optional arguments:
+dnl arg Option argument.
+dnl descr Option description
+dnl
+dnl If arg is absent, the option does not take any arguments. If arg is
+dnl enclosed in square brackets, the option takes an optional argument.
+dnl Otherwise, the argument is required.
+dnl
+dnl If descr is not given the option will not appear in the --help and
+dnl --usage outputs.
+dnl
+define([<OPTION>],[<
+pushdef([<LONG_TAG>])
+pushdef([<SHORT_TAG>])
+pushdef([<ARGNAME>],[<$3>])
+pushdef([<DOCSTRING>],[<prep([<$4>])>])
+pushdef([<ARGTYPE>],[<ifelse([<$3>],,[<no_argument>],dnl
+patsubst([<$3>],[<\[.*\]>]),,[<optional_argument>],dnl
+[<required_argument>])>])
+__GATHER_OPTIONS($@)
+>])
+
+define([<IFDEF>],[<
+pushdef([<IFCOND>],[<$1>])
+$2
+popdef([<IFCOND>])
+>])
+
+dnl ALIAS(long-opt, short-opt)
+dnl Declare aliases for the previous OPTION statement.
+dnl long-opt Long option.
+dnl short-opt Short option (a single char)
+dnl (At least one of long-opt or short-opt must be present)
+dnl An OPTION statement may be followed by any number of ALIAS statements.
+dnl
+define([<ALIAS>],[<
+__GATHER_OPTIONS($1,$2)
+>])
+
+dnl BEGIN
+dnl Start an action associated with the declared option. Must follow OPTION
+dnl statement, with optional ALIAS statements in between.
+dnl
+define([<BEGIN>],[<
+ifelse([<DOCSTRING>],,,[<
+divert(3)dnl
+ifdef([<IFCOND>],[<
+#ifdef IFCOND>])
+ { "translit(dnl
+ifelse(SHORT_TAG,,LONG_TAG,[<SHORT_TAG[<>]ifelse(LONG_TAG,,,; LONG_TAG)>]),
+ [<;>],[<,>])", ifelse(ARGNAME,,[<NULL, 0>],
+[<ifelse(ARGTYPE,[<optional_argument>],
+[<patsubst(ARGNAME,[<\[\(.*\)\]>],[<N_("\1"), 1>])>],[<N_("ARGNAME"), 0>])>]), N_("DOCSTRING") },dnl
+ifdef([<IFCOND>],[<
+#endif>])
+divert(-1)>])
+popdef([<ARGTYPE>])
+popdef([<ARGNAME>])
+popdef([<DOCSTRING>])
+divert(4)dnl
+popdef([<LONG_TAG>])dnl
+popdef([<SHORT_TAG>])dnl
+ifdef([<IFCOND>],[<
+#ifdef IFCOND>])
+ SELECTOR
+ {
+>])
+
+dnl END
+dnl Finish the associated action
+dnl
+define([<END>],[<
+ break;
+ }dnl
+ifdef([<IFCOND>],[<
+#endif>])
+divert(-1)
+undefine([<SELECTOR>])>])
+
+dnl GETOPT(argc, argv, [default])
+dnl Emit option parsing code. Arguments:
+dnl
+dnl argc Name of the 1st argument to getopt_long.
+dnl argv Name of the 2nd argument to getopt_long.
+dnl default Code for the default branch
+dnl
+define([<GETOPT>],[<
+ {
+ int c;
+
+dnl ifelse([<$#>],3,opterr = 0;)
+ while ((c = getopt_long($1, $2, SHORT_OPTS,
+ long_options, NULL)) != EOF)
+ {
+ switch (c)
+ {
+ default:
+ ifelse([<$#>],3,$3,[<exit(1)>]);
+
+ undivert(4)
+ }
+ }
+ }
+>])
+
+define([<STDFUNC>],[<
+divert(0)
+void print_help(void);
+void print_usage(void);
+divert(5)
+#include <ctype.h>
+const char *program_version = [<$1>];
+static char doc[] = N_("[<$3>]");
+static char args_doc[] = N_("[<$4>]");
+const char *program_bug_address = "<" PACKAGE_BUGREPORT ">";
+
+#define DESCRCOLUMN 30
+#define RMARGIN 79
+#define GROUPCOLUMN 2
+#define USAGECOLUMN 13
+
+static void
+indent (size_t start, size_t col)
+{
+ for (; start < col; start++)
+ putchar (' ');
+}
+
+static void
+print_option_descr (const char *descr, size_t lmargin, size_t rmargin)
+{
+ while (*descr)
+ {
+ size_t s = 0;
+ size_t i;
+ size_t width = rmargin - lmargin;
+
+ for (i = 0; ; i++)
+ {
+ if (descr[i] == 0 || isspace (descr[i]))
+ {
+ if (i > width)
+ break;
+ s = i;
+ if (descr[i] == 0)
+ break;
+ }
+ }
+ printf ("%*.*s\n", s, s, descr);
+ descr += s;
+ if (*descr)
+ {
+ indent (0, lmargin);
+ descr++;
+ }
+ }
+}
+
+void
+print_help(void)
+{
+ unsigned i;
+
+ printf ("%s %s [%s]... %s\n", _("Usage:"), [<$2>], _("[<OPTION>]"),
+ gettext (args_doc));
+ if (doc && doc[0])
+ print_option_descr(gettext (doc), 0, RMARGIN);
+ putchar ('\n');
+
+ for (i = 0; i < sizeof (opthelp) / sizeof (opthelp[0]); i++)
+ {
+ unsigned n;
+ if (opthelp[i].opt)
+ {
+ n = printf (" %s", opthelp[i].opt);
+ if (opthelp[i].arg)
+ {
+ char *cb, *ce, *sep = "";
+ if (opthelp[i].is_optional)
+ {
+ cb = "[";
+ ce = "]";
+ }
+ else
+ cb = ce = "";
+
+ if (strlen (opthelp[i].opt) == 2)
+ {
+ if (!opthelp[i].is_optional)
+ sep = " ";
+ }
+ else
+ sep = "=";
+ n += printf ("%s%s%s%s", cb, sep, gettext (opthelp[i].arg), ce);
+ }
+ if (n >= DESCRCOLUMN)
+ {
+ putchar ('\n');
+ n = 0;
+ }
+ indent (n, DESCRCOLUMN);
+ print_option_descr (gettext (opthelp[i].descr), DESCRCOLUMN, RMARGIN);
+ }
+ else
+ {
+ if (i)
+ putchar ('\n');
+ indent (0, GROUPCOLUMN);
+ print_option_descr (gettext (opthelp[i].descr),
+ GROUPCOLUMN, RMARGIN);
+ putchar ('\n');
+ }
+ }
+
+ putchar ('\n');
+dnl **************************************************************************
+dnl This string cannot be split over several lines, because this would trigger
+dnl a bug in GNU M4 (version 1.4.9 and 1.4.10), which would insert #line
+dnl directives between the lines.
+dnl **************************************************************************
+ print_option_descr (_("Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options."), 0, RMARGIN);
+ putchar ('\n');
+ printf (_("Report bugs to %s.\n"), program_bug_address);
+}
+
+void
+print_usage(void)
+{
+ unsigned i;
+ int f = 0;
+ unsigned n;
+ char buf[RMARGIN+1];
+
+#define FLUSH dnl
+ do dnl
+ { dnl
+ buf[n] = 0; dnl
+ printf ("%s\n", buf); dnl
+ n = USAGECOLUMN; dnl
+ memset (buf, ' ', n); dnl
+ } dnl
+ while (0)
+#define ADDC(c) dnl
+ do { if (n == RMARGIN) FLUSH; buf[n++] = c; } while (0)
+
+ n = snprintf (buf, sizeof buf, "%s %s ", _("Usage:"), [<$2>]);
+
+ /* Print a list of short options without arguments. */
+ for (i = 0; i < sizeof (opthelp) / sizeof (opthelp[0]); i++)
+ {
+ if (opthelp[i].opt && opthelp[i].descr && opthelp[i].opt[1] != '-'
+ && opthelp[i].arg == NULL)
+ {
+ if (f == 0)
+ {
+ ADDC('[');
+ ADDC('-');
+ f = 1;
+ }
+ ADDC(opthelp[i].opt[1]);
+ }
+ }
+ if (f)
+ ADDC(']');
+
+ /* Print a list of short options with arguments. */
+ for (i = 0; i < sizeof (opthelp) / sizeof (opthelp[0]); i++)
+ {
+ if (opthelp[i].opt && opthelp[i].descr && opthelp[i].opt[1] != '-'
+ && opthelp[i].arg)
+ {
+ size_t len = 5
+ + strlen (opthelp[i].arg)
+ + (opthelp[i].is_optional ? 2 : 1);
+ if (n + len > RMARGIN) FLUSH;
+ buf[n++] = ' ';
+ buf[n++] = '[';
+ buf[n++] = '-';
+ buf[n++] = opthelp[i].opt[1];
+ if (opthelp[i].is_optional)
+ {
+ buf[n++] = '[';
+ strcpy (&buf[n], opthelp[i].arg);
+ n += strlen (opthelp[i].arg);
+ buf[n++] = ']';
+ }
+ else
+ {
+ buf[n++] = ' ';
+ strcpy (&buf[n], opthelp[i].arg);
+ n += strlen (opthelp[i].arg);
+ }
+ buf[n++] = ']';
+ }
+ }
+
+ /* Print a list of long options */
+ for (i = 0; i < sizeof (opthelp) / sizeof (opthelp[0]); i++)
+ {
+ if (opthelp[i].opt && opthelp[i].descr)
+ {
+ size_t len;
+ const char *longopt;
+
+ if (opthelp[i].opt[1] == '-')
+ longopt = opthelp[i].opt;
+ else if (opthelp[i].opt[2] == ',')
+ longopt = opthelp[i].opt + 4;
+ else
+ continue;
+
+ len = 3 + strlen (longopt)
+ + (opthelp[i].arg ? 1 + strlen (opthelp[i].arg)
+ + (opthelp[i].is_optional ? 2 : 0) : 0);
+ if (n + len > RMARGIN) FLUSH;
+ buf[n++] = ' ';
+ buf[n++] = '[';
+ strcpy (&buf[n], longopt);
+ n += strlen (longopt);
+ if (opthelp[i].arg)
+ {
+ buf[n++] = '=';
+ if (opthelp[i].is_optional)
+ {
+ buf[n++] = '[';
+ strcpy (&buf[n], opthelp[i].arg);
+ n += strlen (opthelp[i].arg);
+ buf[n++] = ']';
+ }
+ else
+ {
+ strcpy (&buf[n], opthelp[i].arg);
+ n += strlen (opthelp[i].arg);
+ }
+ }
+ buf[n++] = ']';
+ }
+ }
+ FLUSH;
+
+}
+
+const char version_etc_copyright[] =
+ /* Do *not* mark this string for translation. %s is a copyright
+ symbol suitable for this locale, and %d is the copyright
+ year. */
+ "Copyright %s 2009 Sergey Poznyakoff";
+
+void
+print_version_only(const char *program_version, FILE *stream)
+{
+ fprintf (stream, "%s\n", program_version);
+ /* TRANSLATORS: Translate "(C)" to the copyright symbol
+ (C-in-a-circle), if this symbol is available in the user's
+ locale. Otherwise, do not translate "(C)"; leave it as-is. */
+ fprintf (stream, version_etc_copyright, _("(C)"));
+ fputc ('\n', stream);
+}
+
+void
+print_version(const char *program_version, FILE *stream)
+{
+ print_version_only(program_version, stream);
+
+dnl **************************************************************************
+dnl This string cannot be split over serveal lines, because this would trigger
+dnl a bug in GNU M4 (version 1.4.9 and 1.4.10), which would insert #line
+dnl directives between the lines.
+dnl **************************************************************************
+ fputs (_("License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\nThis is free software: you are free to change and redistribute it.\nThere is NO WARRANTY, to the extent permitted by law.\n\n"),
+ stream);
+
+dnl /* TRANSLATORS: %s denotes an author name. */
+dnl fprintf (stream, _("Written by %s.\n"), "Sergey Poznyakoff");
+}
+
+divert(-1)
+popdef([<ADDC>])
+popdef([<FLUSH>])
+>])
+
+define([<OPTIONS_BEGIN>],
+ [<divert(-1)
+ define([<GETOPT_STYLE>],[<$1>])
+ ifelse([<$1>],[<gnu>],
+ [<STDFUNC([<$2 " (" PACKAGE_STRING ")">], [<$2>], [<$3>], [<$4>])>])
+>])
+
+define([<OPTIONS_END>],[<
+ifelse(GETOPT_STYLE,[<gnu>],[<
+ GROUP([<Other options>])
+ OPTION([<help>],h,,[<Give this help list>])
+ BEGIN
+ print_help ();
+ exit (0);
+ END
+ OPTION([<usage>],,,[<Give a short usage message>])
+ BEGIN
+ print_usage ();
+ exit (0);
+ END
+ OPTION([<version>],,,[<Print program version>])
+ BEGIN
+ /* Give version */
+ print_version(program_version, stdout);
+ exit (0);
+ END>])
+divert
+/* Option codes */
+enum {
+ _OPTION_INIT=255,
+ undivert(1)
+ MAX_OPTION
+};
+static struct option long_options[] = {
+ undivert(2)
+ {0, 0, 0, 0}
+};
+static struct opthelp {
+ const char *opt;
+ const char *arg;
+ int is_optional;
+ const char *descr;
+} opthelp[] = {
+ undivert(3)
+};
+undivert(5)
+>])
+
+divert(0)dnl
+/* -*- buffer-read-only: t -*- vi: set ro:
+ THIS FILE IS GENERATED AUTOMATICALLY. PLEASE DO NOT EDIT.
+*/
+
diff --git a/grot.1 b/grot.1
new file mode 100644
index 0000000..95e1d4f
--- a/dev/null
+++ b/grot.1
@@ -0,0 +1,118 @@
+.\" This file is part of Grot.
+.\" Copyright (C) 2009 Sergey Poznyakoff
+.\"
+.\" Grot 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, or (at your option)
+.\" any later version.
+.\"
+.\" Grot 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 grot. If not, see <http://www.gnu.org/licenses/>.
+.TH grot "1" "May 15, 2009" "grot (grot 1.0)" "User Commands"
+.SH NAME
+grot \- Gray's Rotation Tool for MySQL binary logs
+
+.SH SYNOPSIS
+\fBgrot\fR
+[\fB-vnh\fR]
+[\fB-H\fR[NAME]]
+[\fB-p\fR[PASS]]
+[\fB-P\fR NUMBER]
+[\fB-S\fR STRING]
+[\fB-u\fR NAME]
+[\fB--host\fR=[NAME]]
+[\fB--password\fR=[PASS]]
+[\fB--port\fR=NUMBER]
+[\fB--socket\fR=STRING]
+[\fB--user\fR=NAME]
+[\fB--verbose\fR]
+[\fB--dry-run\fR]
+[\fB--no-flush\fR]
+[\fB--keep\fR=NUMBER]
+[\fB--help\fR]
+[\fB--usage\fR]
+[\fB--version\fR]
+
+.SH DESCRIPTION
+\fBGrot\fR rotates MySQL binary log files.
+
+.SH OPTIONS
+.TP
+\fB\-H\fR, \fB\-\-host\fR[=\fINAME\fR]
+Set host name or IP address of the master MySQL server.
+.TP
+\fB\-p\fR, \fB\-\-password\fR[=\fIPASS\fR]
+Set password of the MySQL user.
+.TP
+\fB\-P\fR, \fB\-\-port\fR=\fINUMBER\fR
+Set port number of the master MySQL server, if it differs from the
+default 3306.
+.TP
+\fB\-S\fR, \fB\-\-socket\fR=\fISTRING\fR
+Set socket file name.
+.TP
+\fB\-u\fR, \fB\-\-user\fR=\fINAME\fR
+Set MySQL user name. This user must have the following
+privileges: PROCESS, SUPER.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Increase verbosity level. Multiple instances of this option are
+allowed.
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Do not actually rotate the logs, only print what would have been done.
+.TP
+\fB\-\-no\-flush\fR
+Do not flush logs after rotating.
+.TP
+\fB\-\-keep\fR=NUMBER
+Keep NUMBER logs before the oldest one.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Give a concise help list.
+.TP
+\fB\-\-usage\fR
+Give a short usage message.
+.TP
+\fB\-\-version\fR
+Print program version.
+
+.SH CONFIGURATION FILES
+\fBGrot\fR reads its configuration from the following files:
+.TP
+\fB/etc/my.cnf\fR
+Default MySQL configuration file. \fBGrot\fR attempts to read master server
+configuration from sections \fBgrot\fR and \fBclient\fR.
+.TP
+\fB/etc/grot.cnf\fR
+Site-wide \fBgrot\fR configuration file. See grot.cfg(5).
+.TP
+\fB~/.grot\fR
+Per-user configuration file. The tilde (\fB~\fR) here stands for the
+user home directory. See grot.cfg(5).
+
+.SH "REPORTING BUGS"
+Report bugs to <gray@gnu.org.ua>.
+
+.SH "SEE ALSO"
+grot.cfg(5)
+
+.SH COPYRIGHT
+Copyright \(co 2009 Sergey Poznyakoff
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH grot \"1\" \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 16
+.\" end:
+
diff --git a/grot.c b/grot.c
new file mode 100644
index 0000000..cc58a74
--- a/dev/null
+++ b/grot.c
@@ -0,0 +1,414 @@
+/* This file is part of Grot.
+ Copyright (C) 2009 Sergey Poznyakoff
+
+ Grot 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, or (at your option)
+ any later version.
+
+ Grot 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 grot. If not, see <http://www.gnu.org/licenses/>. */
+
+#include "grot.h"
+#include <sys/types.h>
+#include <pwd.h>
+
+char *progname;
+
+#define DEBUG_QUERY(host, query) \
+ do \
+ if (verbose > 1) \
+ printf("%s: query: %s\n", \
+ host, query); \
+ while (0)
+
+void
+verror(MYSQL *mysql, char *fmt, va_list ap)
+{
+ fprintf(stderr, "%s: ", progname);
+ vfprintf(stderr, fmt, ap);
+ if (mysql)
+ fprintf(stderr, ": %s", mysql_error(mysql));
+ fprintf(stderr, "\n");
+}
+
+void
+terror(int code, MYSQL *mysql, char *fmt, ...)
+{
+ va_list ap;
+
+ va_start(ap, fmt);
+ verror(mysql, fmt, ap);
+ va_end(ap);
+ if (code)
+ exit(code);
+}
+
+void *
+xmalloc(size_t size)
+{
+ void *p = malloc(size);
+ if (!p)
+ terror(1, NULL, "not enough memory");
+ return p;
+}
+
+void *
+xzalloc(size_t size)
+{
+ void *p = xmalloc(size);
+ memset(p, 0, size);
+ return p;
+}
+
+char *
+xstrdup(char *str)
+{
+ char *p;
+
+ if (!str)
+ return NULL;
+ p = xmalloc(strlen(str) + 1);
+ return strcpy(p, str);
+}
+
+MYSQL mysql;
+
+struct config_file {
+ char *file;
+ char *group;
+};
+struct config_file slave_files[] = {
+ { DEFAULT_USER_CONFIG, NULL }, /* group will be replaced by
+ the host name */
+ { DEFAULT_USER_CONFIG, "slave" },
+ { DEFAULT_SYSTEM_CONFIG, NULL }, /* likewise */
+ { DEFAULT_SYSTEM_CONFIG, "slave" },
+};
+struct config_file master_files[] = {
+ { DEFAULT_USER_CONFIG, "grot" },
+ { DEFAULT_SYSTEM_CONFIG, "grot" },
+ { NULL, "grot" },
+};
+
+#define NITEMS(a) sizeof(a)/sizeof((a)[0])
+
+MYSQL *
+try_connect(MYSQL *mp, struct config_file *cfg, int ncfg,
+ char *host, char *user, char *pass,
+ unsigned port, char *socket)
+{
+ int i;
+ MYSQL *ret;
+
+ for (i = 0; i < ncfg; i++, cfg++) {
+ mysql_init(mp);
+ if (cfg->file)
+ mysql_options(mp, MYSQL_READ_DEFAULT_FILE, cfg->file);
+ if (cfg->group)
+ mysql_options(mp, MYSQL_READ_DEFAULT_GROUP,
+ cfg->group);
+ ret = mysql_real_connect(mp, host, user, pass, NULL, port,
+ socket, 0);
+ if (ret)
+ break;
+ mysql_close(mp);
+ }
+ return ret;
+}
+
+
+static void
+do_connect()
+{
+ if (!try_connect(&mysql, master_files, NITEMS(master_files),
+ grot_host,
+ grot_user,
+ grot_password,
+ grot_port,
+ grot_socket))
+ terror(1, &mysql, "cannot connect to master SQL server");
+}
+
+struct slave {
+ struct slave *next;
+ char *host;
+
+ char *logfile;
+};
+
+unsigned long slave_count;
+struct slave *slave_head, *slave_tail;
+
+void
+add_slave(char *name, size_t len)
+{
+ struct slave *sp = xzalloc(sizeof(*sp));
+ sp->host = xmalloc(len+1);
+ memcpy(sp->host, name, len);
+ sp->next = NULL;
+ sp->host[len] = 0;
+ if (slave_tail)
+ slave_tail->next = sp;
+ else
+ slave_head = sp;
+ slave_tail = sp;
+ slave_count++;
+}
+
+/*
+ 0 1 2 3 4
+ 401230 bind ns1.farlep.net:60446 (null) Binlog Dump 3837405 Has sent all binlog
+ to slave; waiting for binlog to be updated (null)
+*/
+void
+collect_slaves()
+{
+ MYSQL_RES *res;
+ size_t nrows, ncols, i;
+
+ DEBUG_QUERY("master", "SHOW PROCESS LIST");
+ res = mysql_list_processes(&mysql);
+ if (!res)
+ terror(1, &mysql, "cannot list processes");
+ nrows = mysql_num_rows (res);
+ ncols = mysql_num_fields (res);
+ for (i = 0; i < nrows; i++) {
+ MYSQL_ROW row;
+
+ mysql_data_seek (res, i);
+ row = mysql_fetch_row (res);
+ if (strcmp(row[4], "Binlog Dump") == 0) {
+ size_t len = strcspn(row[2], ":");
+ add_slave(row[2], len);
+ }
+ }
+ mysql_free_result (res);
+}
+
+void
+list_slaves()
+{
+ unsigned long i;
+ struct slave *sp;
+ printf("No. of slaves: %lu\n", slave_count);
+ printf("Slave servers:\n");
+ for (sp = slave_head, i = 0; sp; sp = sp->next, i++)
+ printf("%4ld: %s\n", i, sp->host);
+}
+
+void
+process_slave(struct slave *sp)
+{
+ MYSQL sm;
+ MYSQL_RES *res;
+ MYSQL_ROW row;
+
+ if (verbose)
+ printf("Processing host %s\n", sp->host);
+ slave_files[0].group = slave_files[2].group = sp->host;
+ if (!try_connect(&sm, slave_files, NITEMS(slave_files),
+ sp->host, NULL, NULL, 0, NULL))
+ terror(1, &sm, "cannot connect to slave server");
+
+ DEBUG_QUERY(sp->host, "SHOW SLAVE STATUS");
+
+ if (mysql_query(&sm, "SHOW SLAVE STATUS"))
+ terror(1, &sm, "%s: cannot get slave status",
+ sp->host);
+ res = mysql_store_result(&sm);
+ if (mysql_num_rows(res) < 1)
+ terror(1, NULL, "%s: empty slave status",
+ sp->host);
+ row = mysql_fetch_row (res);
+ if (verbose)
+ printf("%s: %s\n", sp->host, row[5]);
+ sp->logfile = xstrdup(row[5]);
+ mysql_free_result(res);
+
+ mysql_close(&sm);
+}
+
+void
+collect_slave_logs()
+{
+ struct slave *sp;
+
+ for (sp = slave_head; sp; sp = sp->next)
+ process_slave(sp);
+}
+
+static char *log_prefix;
+static size_t log_prefix_len;
+static char *earliest_log;
+
+static char **server_log_table;
+static size_t server_log_count;
+
+int
+comp_log(const void *a, const void *b)
+{
+ return strcmp(*(char**)a, *(char**)b);
+}
+
+char **
+find_server_log(char *log)
+{
+ return bsearch(&log, server_log_table, server_log_count,
+ sizeof(server_log_table[0]), comp_log);
+}
+
+void
+set_log_prefix()
+{
+ MYSQL_RES *res;
+ MYSQL_ROW row;
+ char *p;
+ size_t count, i;
+
+ DEBUG_QUERY("master", "SHOW BINARY LOGS");
+ if (mysql_query(&mysql, "SHOW BINARY LOGS"))
+ terror(1, &mysql, "cannot list binary logs on master");
+ res = mysql_store_result(&mysql);
+ if (!res)
+ terror(1, &mysql, "cannot get result");
+ count = mysql_num_rows(res);
+ row = mysql_fetch_row(res);
+
+ p = strchr(row[0], '.');
+ if (!p)
+ terror(1, NULL,
+ "unexpected binary log name: %s", row[0]);
+ log_prefix_len = p - row[0] + 1;
+ log_prefix = xmalloc(log_prefix_len + 1);
+ memcpy(log_prefix, row[0], log_prefix_len);
+ log_prefix[log_prefix_len] = 0;
+ if (verbose)
+ printf("Log prefix: %s\n", log_prefix);
+
+ server_log_table = xmalloc(count*sizeof(server_log_table[0]));
+ server_log_count = count;
+ for (i = 0; i < count; i++) {
+ server_log_table[i] = xstrdup(row[0]);
+ row = mysql_fetch_row(res);
+ }
+
+ qsort(server_log_table, server_log_count, sizeof(server_log_table[0]),
+ comp_log);
+ mysql_free_result(res);
+}
+
+
+
+static int
+logcmp(char *a, char *b)
+{
+ unsigned long na, nb;
+
+ na = strtoul(a + log_prefix_len, NULL, 10);
+ nb = strtoul(b + log_prefix_len, NULL, 10);
+ if (na < nb)
+ return -1;
+ else if (na > nb)
+ return 1;
+ return 0;
+}
+
+void
+find_earliest_log()
+{
+ struct slave *sp;
+
+ for (sp = slave_head; sp; sp = sp->next) {
+ if (strlen(sp->logfile) < log_prefix_len
+ || memcmp(sp->logfile, log_prefix, log_prefix_len)) {
+ terror(0, NULL,
+ "%s: logfile does not match base prefix: %s",
+ sp->host, sp->logfile);
+ continue;
+ }
+ if (!find_server_log(sp->logfile)) {
+ terror(0, NULL,
+ "Log %s is used by %s, but is absent on master",
+ sp->logfile, sp->host);
+ continue;
+ }
+ if (!earliest_log
+ || logcmp(sp->logfile, earliest_log) < 0)
+ earliest_log = sp->logfile;
+ }
+}
+
+#define PURGE_TO_COMMAND "PURGE MASTER LOGS TO "
+
+void
+purge_logs_to(char *logfile)
+{
+ char *buf = xmalloc(sizeof(PURGE_TO_COMMAND) + 2 + strlen(logfile));
+ strcpy(buf, PURGE_TO_COMMAND);
+ strcat(buf, "'");
+ strcat(buf, logfile);
+ strcat(buf, "'");
+ DEBUG_QUERY("master", buf);
+ if (!dry_run_option && mysql_query(&mysql, buf))
+ terror(1, &mysql, "failed to purge logs");
+ free(buf);
+}
+
+void
+flush_logs()
+{
+ DEBUG_QUERY("master", "FLUSH LOGS");
+
+ if (!dry_run_option && mysql_query(&mysql, "FLUSH LOGS"))
+ terror(1, &mysql, "failed to purge logs");
+}
+
+int
+main(int argc, char **argv)
+{
+ progname = argv[0];
+ read_options(argc, argv);
+
+ do_connect();
+ set_log_prefix();
+ collect_slaves();
+ if (!slave_head)
+ terror(1, NULL, "No slaves");
+ if (verbose)
+ list_slaves();
+ collect_slave_logs();
+ find_earliest_log();
+ if (earliest_log) {
+ if (verbose)
+ printf("earliest common log: %s\n", earliest_log);
+ if (keep_count) {
+ char **p = find_server_log(earliest_log);
+ if (!p)
+ abort(); /* should not happen */
+ p -= keep_count;
+ if (p < server_log_table)
+ earliest_log = NULL;
+ else
+ earliest_log = p[0];
+ }
+ }
+
+ if (earliest_log) {
+ purge_logs_to(earliest_log);
+ if (flush_logs_option)
+ flush_logs();
+ } else {
+ if (verbose)
+ printf("Nothing to do\n");
+ }
+
+ mysql_close(&mysql);
+ exit(0);
+}
+
diff --git a/grot.cfg b/grot.cfg
new file mode 100644
index 0000000..532e30e
--- a/dev/null
+++ b/grot.cfg
@@ -0,0 +1,23 @@
+# A sample configuration file for Grot.
+# Edit it to your liking at copy to /etc/grot.cfg
+
+# Configure master SQL server.
+[grot]
+host = master.host.name
+port = 3306
+user = root
+pass = guessme
+
+# Configure slave servers.
+[slave]
+user = grot
+port = 3306
+pass =
+
+# Any slaves that do not match the [slave] section above
+# must have their own section. The section is named after
+# the host name. For example
+[slave.example.com]
+user = mbrt
+port = 3306
+pass = 1234
diff --git a/grot.cfg.5 b/grot.cfg.5
new file mode 100644
index 0000000..56e12eb
--- a/dev/null
+++ b/grot.cfg.5
@@ -0,0 +1,94 @@
+.\" This file is part of Grot.
+.\" Copyright (C) 2009 Sergey Poznyakoff
+.\"
+.\" Grot 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, or (at your option)
+.\" any later version.
+.\"
+.\" Grot 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 grot. If not, see <http://www.gnu.org/licenses/>.
+.TH grot.cfg "5" "May 15, 2009" "grot (grot 1.0)"
+.SH NAME
+grot.cfg \- grot configuration file
+
+.SH DESCRIPTION
+The \fBgrot\fR configuration file contains information about master and
+slave MySQL servers. Its format is the same as of any \fBmy.cfg\fR file,
+i.e. it consists of sections, which contain variable assignments. A section
+begins with a section header enclosed in square brackets. A variable
+assignement occupies a separate line and consists of variable name and value
+separated by equals sign with arbitrary amount of white space around it.
+
+\fBGrot\fR uses the sections named \fBgrot\fR, \fBslave\fR and, additionally
+any sections whose names coincide with existing slave host names.
+
+.SH THE GROT SECTION
+
+This section defines the master server parameters. Allowed variables are:
+
+.TP
+\fBhost\fR
+Defines the host name or IP address of the master SQL server.
+.TP
+\fBport\fR
+Specifies the port the server listens to. Use this variable if the port
+differs from the default 3306.
+.TP
+\fBsocket\fR
+Specifies the UNIX socket name, if the server listens on a UNIX socket.
+.TP
+\fBuser\fR
+Sets the MySQL user name. This user must be granted the \fBPROCESS\fR,
+\fBSUPER\fR and \fBRELOAD\fR global privileges. The latter is optional,
+if \fBgrot\fR is run with the \fB\-\-no\-flush\fR option.
+.TP
+\fBpassword\fR
+Password for that user.
+
+.SH THE SLAVE SECTION
+
+The \fBslave\fR section configures the settings needed to connect to
+the host servers, such as user credentials, port number etc. If all
+slaves use the same set of these settings, this section is enough for
+\fBgrot\fR to work. Otherwise, you may specify the credentials for each
+particular slave in a separate section, named after that slave host
+name.
+
+.TP
+\fBport\fR
+Specifies the port the server listens to. Use this variable if the port
+differs from the default 3306.
+.TP
+\fBsocket\fR
+Specifies the UNIX socket name, if the server listens on a UNIX socket.
+.TP
+\fBuser\fR
+Sets the MySQL user name. This user must be granted the \fBREPLICATION CLIENT\fR
+global privilege.
+.TP
+\fBpassword\fR
+Password for that user.
+
+.SH "SEE ALSO"
+grot(1)
+
+.SH COPYRIGHT
+Copyright \(co 2009 Sergey Poznyakoff
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH grot.cfg \"5\" \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 16
+.\" end:
+
diff --git a/grot.h b/grot.h
new file mode 100644
index 0000000..45c53c7
--- a/dev/null
+++ b/grot.h
@@ -0,0 +1,48 @@
+/* This file is part of Grot.
+ Copyright (C) 2009 Sergey Poznyakoff
+
+ Grot 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, or (at your option)
+ any later version.
+
+ Grot 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 grot. If not, see <http://www.gnu.org/licenses/>. */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdarg.h>
+#include <unistd.h>
+#include <string.h>
+#include <errno.h>
+#include <mysql.h>
+
+extern char *grot_host;
+extern char *grot_password;
+extern int password_option;
+extern unsigned grot_port;
+extern char *grot_socket;
+extern char *grot_user;
+extern int verbose;
+extern int dry_run_option;
+extern int flush_logs_option;
+extern size_t keep_count;
+
+void verror(MYSQL *mysql, char *fmt, va_list ap);
+void terror(int code, MYSQL *mysql, char *fmt, ...);
+void read_options(int argc, char *argv[]);
+
+#ifndef SYSCONFDIR
+# define SYSCONFDIR "/etc"
+#endif
+#define DEFAULT_SYSTEM_CONFIG SYSCONFDIR "/grot.cfg"
+#define DEFAULT_USER_CONFIG "~/.grot"
+
+#define PACKAGE_STRING PACKAGE " " VERSION
+#define PACKAGE_BUGREPORT "gray@gnu.org.ua"
+

Return to:

Send suggestions and report system problems to the System administrator.