commit fdfefe7d55542ff69e3ac90e02e750482383f318 Author: Henrik Hautakoski Date: Tue Apr 20 20:38:50 2010 +0200 Initial commit diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e214abb --- /dev/null +++ b/Makefile @@ -0,0 +1,30 @@ +# +# Archive Makefile +# + +DEFS := -D__DEBUG__ +LIBS := `mysql_config --libs` +CFLAGS := -Werror -g $(LIBS) $(DEFS) +CC := gcc + +SOURCES := \ + src/arch.c \ + src/arch/mysql.c \ + src/indexer.c \ + src/common/path.c \ + src/common/rbtree.c \ + src/fs/notify_inotify.c \ + src/fs/notify_event.c \ + src/fs/tree.c + +BUILD := ./build + +all : + make me + +me : + mkdir -p $(BUILD) + $(CC) $(CFLAGS) $(SOURCES) -o $(BUILD)/arch + +clean : + rm -fr $(BUILD) diff --git a/TODO b/TODO new file mode 100644 index 0000000..9bf14b4 --- /dev/null +++ b/TODO @@ -0,0 +1,18 @@ + +################## + TODO LIST +################## + +* ref list always first ;) +* config parser +* support for networked broadcasting? + + +################## + Reference list +################## + +References are tagged in source files by the string 'REF:' + +1: refactor to string api +2: group path handling into one interface (also consider move:ing related stuff from REF:1) \ No newline at end of file diff --git a/src/arch.c b/src/arch.c new file mode 100644 index 0000000..52036f7 --- /dev/null +++ b/src/arch.c @@ -0,0 +1,139 @@ +#include +#include +#include +#include +#include "arch/db.h" +#include "fs/notify.h" + +/* only way to exit the application properly + when in main loop is by signal */ +static void clean_exit(int excode) { + + time_t t = time(NULL); + + notify_cleanup(); + arch_db_close(); + + printf("\nprocess exit at: %s", ctime(&t)); + exit(excode); +} + +/* signal handler */ +static void sighandl(int sig) { + + switch(sig) { + /* normal exit signals */ + case SIGTERM : + case SIGKILL : + case SIGQUIT : + case SIGINT : + clean_exit(EXIT_SUCCESS); + /* segmentation violation, let user now */ + case SIGSEGV : + fprintf(stderr, "SEGFAULT: o no he didn't\n"); + clean_exit(EXIT_FAILURE); + case SIGUSR1 : + case SIGUSR2 : + printf("notify stat:\n"); + notify_stat(); + /* don't know why, but everything goes bananas if we keep executing */ + clean_exit(EXIT_SUCCESS); + } +} + +void arch_loop() { + + notify_event *event; + + for(;;) { + + if (indexer_pending() && !notify_is_ready()) { +#ifdef __DEBUG__ + printf("sched: running indexer\n"); +#endif + indexer_run(15); + continue; + } + +#ifdef __DEBUG__ + printf("sched: notify block\n"); +#endif + + event = notify_read(-1); + + if (event == NULL) + continue; + +#ifdef __DEBUG__ + printf("-- EVENT --\n" + " TYPE: %s\n" + " DIR: %i\n" + " PATH: %s%s\n" + "---------------\n", notify_event_typetostr(event), event->dir, event->path, event->filename); +#endif + + switch(event->type) { + + case NOTIFY_MOVE_TO : + + if (event->dir) + indexer_register(event->path, event->filename); + case NOTIFY_CREATE : + arch_db_insert(event->path, event->filename, event->dir); + break; + case NOTIFY_MOVE_FROM : + case NOTIFY_DELETE : + arch_db_delete(event->path, event->filename); + break; + } + +#ifdef __DEBUG__ + notify_stat(); +#endif + } +} + +int main(int argc, char **argv) { + + /* Validate arguments */ + if (argc != 5) { + + printf("Usage: %s .\n" + "Root Directory - Path to indexroot. All subdirectories will be indexed.\n" + "Db user - Database user\n" + "Db pass - Database password\n" + "Db name - Database to use for indexing\n", argv[0]); + + return EXIT_FAILURE; + } + + /* setup signal handlers */ + signal(SIGTERM, sighandl); + signal(SIGKILL, sighandl); + signal(SIGQUIT, sighandl); + signal(SIGINT, sighandl); + signal(SIGSEGV, sighandl); + signal(SIGUSR1, sighandl); + signal(SIGUSR2, sighandl); + + /* connect to database */ + if (!arch_db_init("localhost", argv[2], argv[3], argv[4], "fs")) + return EXIT_FAILURE; + + /* clean database */ + if (arch_db_truncate() == -1) + return EXIT_FAILURE; + + notify_init(); + + if(notify_add_watch(argv[1]) == -1) { + fprintf(stderr, "Invalid path: %s\n", argv[1]); + return EXIT_FAILURE; + } + + indexer_register(argv[1], NULL); + + arch_loop(); + + return EXIT_SUCCESS; +} diff --git a/src/arch/db.h b/src/arch/db.h new file mode 100644 index 0000000..5b0a41e --- /dev/null +++ b/src/arch/db.h @@ -0,0 +1,33 @@ + +/* + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#ifndef _ARCH_DB_H + +#define _ARCH_DB_H + +int arch_db_init(char *host, char *username, char *password, char *database, char *table); + +int arch_db_insert(const char *path, const char *filename, const int isdir); + +int arch_db_delete(const char *path, const char *filename); + +int arch_db_truncate(); + +void arch_db_close(); + +#endif /* _DB_DATABASE_H */ diff --git a/src/arch/mysql.c b/src/arch/mysql.c new file mode 100644 index 0000000..0d663fb --- /dev/null +++ b/src/arch/mysql.c @@ -0,0 +1,285 @@ +/** + * Archived - Inotify based filesystem mirror daemon + * + * @authors: pnx, tritomI + * + * + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#include +#include +#include +#include +#include +#include + +#include "db.h" + +#define STRSZ(s) (sizeof(char) * strlen(s)) + +static MYSQL* dbconn; +static unsigned long dbthread_id; +static char *dbtable = NULL; + +/* + * Initialize database connection and connect to database + */ +int arch_db_init(char *host, char *username, char *password, char *database, char *table) { + + my_bool reconnect = 1; + + /* Keep tablename for querys */ + dbtable = malloc(sizeof(table)); + strcpy(dbtable,table); + + /* Init. database */ + dbconn = mysql_init(NULL); + + /* Set mysql options */ + mysql_options(dbconn, MYSQL_OPT_RECONNECT, &reconnect); + + /* Connect to database */ + if (!mysql_real_connect(dbconn, host, username, password, database, 0, NULL, 0)) { + fprintf(stderr, "%s\n", mysql_error(dbconn)); + return 0; + } + + /* Fix for mysql versions prior to 5.0.19 */ + mysql_options(dbconn, MYSQL_OPT_RECONNECT, &reconnect); + + + /* Save mysql thread id */ + dbthread_id = mysql_thread_id(dbconn); + +#ifdef DB_DEBUG + fprintf(stderr, "Mysql init: %li\n", dbthread_id); +#endif + + return 1; +} + +/* + * Close database connection + */ +void arch_db_close() { + + /* dbtable never free'd */ + if (dbtable != NULL) { + free(dbtable); + dbtable = NULL; + } + + mysql_close(dbconn); + + /* another leak fix */ + mysql_library_end(); +} + +/* + * Truncate database table + */ +int arch_db_truncate() { + + int ret; + + /* Allocate memory big enough for query */ + char *stmt = (char *) malloc((sizeof(char) * strlen(dbtable)) + 20); + + /* Create mysql query */ + if(sprintf(stmt, "TRUNCATE TABLE `%s`", dbtable) < 0) { + fprintf(stderr, "Could not create sql statement in notify_db_truncate()\n"); + return -1; + } + + /* Run mysql query */ + ret = mysql_query(dbconn, stmt); + + /* Clean up */ + free(stmt); + + /* Make sure query was successfull */ + if(ret != 0) { + fprintf(stderr, "%s\n", mysql_error(dbconn)); + return -1; + } + + return 0; +} + +/* + * Insert into database + */ +int arch_db_insert(const char *path, const char *filename, const int isdir) { + + int ret; + char *esc_path; + char *esc_filename; + long stmt_size; + long esc_path_size; + long esc_filename_size; + + char date[25]; + time_t curtime; + struct tm *loctime; + + /* + * Allocate memory big enough for query + * dbtable + path + filename + date + 100 (for base query) + */ + stmt_size = sizeof(char) * (strlen(dbtable)+ + strlen(path)+strlen(filename)+sizeof(date)+100); + + char *stmt = malloc(stmt_size); + + /* Allocate memory for escaped path / filename */ + esc_path_size = (sizeof(char) * strlen(path) * 2) + 1; + esc_path = malloc(esc_path_size); + + esc_filename_size = (sizeof(char) * strlen(filename) * 2) + 1; + esc_filename = malloc(esc_filename_size); + + /* For debuging, prints allocated size for malloc's */ +#ifdef DB_DEBUG + fprintf(stderr, "==============================================\n"); + fprintf(stderr, "Dynamic allocated memory in notify_db_insert()\n"); + fprintf(stderr, "Stmt: %li\n", stmt_size); + fprintf(stderr, "Path: %li\n", esc_path_size); + fprintf(stderr, "Filename: %li\n", esc_filename_size); + fprintf(stderr, "==============================================\n"); +#endif + + + /* Get date */ + curtime = time(NULL); + loctime = localtime(&curtime); + strftime(date, 25, "%Y-%m-%d %H:%M:%S", loctime); + + /* Make sure we got a connection + * This is prob. not needed. + */ + if(mysql_ping(dbconn) != 0) { + fprintf(stderr, "Lost connection to database. Could not reconnect.\n"); + return -1; + } + + mysql_real_escape_string(dbconn, esc_path, path, strlen(path)); + mysql_real_escape_string(dbconn, esc_filename, filename, strlen(filename)); + + /* Create mysql query */ + sprintf(stmt, "INSERT INTO `%s` (`Path`, `Base`, `Type`, `Status`, `Date`) VALUES('%s','%s','%i','0', '%s')", dbtable, esc_path, esc_filename, isdir, date); + + /* Run mysql query */ + ret = mysql_query(dbconn, stmt); + + /* Clean up */ + free(stmt); + free(esc_path); + free(esc_filename); + + /* Make sure query was successfull */ + if(ret != 0) { + fprintf(stderr, "%s\n", mysql_error(dbconn)); + return -1; + } + +#ifdef DB_DEBUG + + if(dbthread_id != mysql_thread_id(dbconn)) { + fprintf(stderr, "Connection was lost. Reconnected. Old_Thread: %li, New_Thread: %li\n", dbthread_id, mysql_thread_id(dbconn)); + } + +#endif + + return 0; +} + +/* + * Delete row in database + */ +int arch_db_delete(const char *path, const char *filename) { + + int ret; + char *esc_path; + char *esc_filename; + size_t stmt_size; + size_t esc_path_size; + size_t esc_filename_size; + + /* + * Allocate memory big enough for query + * dbtable + path + filename + date + 100 (for base query) + */ + stmt_size = STRSZ(dbtable) + + STRSZ(path) + STRSZ(filename) + 100; + + char *stmt = malloc(stmt_size); + + /* Allocate memory for escaped path / filename */ + esc_path_size = (sizeof(char) * strlen(path) * 2) + 1; + esc_path = malloc(esc_path_size); + + esc_filename_size = (sizeof(char) * strlen(filename) * 2) + 1; + esc_filename = malloc(esc_filename_size); + + /* For debuging, prints allocated size for malloc's */ +#ifdef DB_DEBUG + fprintf(stderr, "==============================================\n"); + fprintf(stderr, "Dynamic allocated memory in notify_db_delete()\n"); + fprintf(stderr, "Stmt: %i\n", (int)stmt_size); + fprintf(stderr, "Path: %i\n", (int)esc_path_size); + fprintf(stderr, "Filename: %i\n", (int)esc_filename_size); + fprintf(stderr, "==============================================\n"); +#endif + + /* Make sure we got a connection + * This is prob. not needed. + */ + if(mysql_ping(dbconn) != 0) { + fprintf(stderr, "Lost connection to database. Did reconnection work?\n"); + return -1; + } + + mysql_real_escape_string(dbconn, esc_path, path, strlen(path)); + mysql_real_escape_string(dbconn, esc_filename, filename, strlen(filename)); + + /* Create mysql query */ + sprintf(stmt, "DELETE FROM `%s` WHERE `Path` LIKE '%s%s%%' OR (`Path` = '%s' AND `Base` = '%s');", dbtable, esc_path, esc_filename, esc_path, esc_filename); + + /* Run mysql query */ + ret = mysql_query(dbconn, stmt); + + /* Clean up */ + free(stmt); + free(esc_path); + free(esc_filename); + + /* Make sure query was successfull */ + if(ret != 0) { + fprintf(stderr, "%s\n", mysql_error(dbconn)); + return -1; + } + +#ifdef DB_DEBUG + + if(dbthread_id != mysql_thread_id(dbconn)) { + fprintf(stderr, "Connection was lost. Reconnected. Old_Thread: %li, New_Thread: %li\n", dbthread_id, mysql_thread_id(dbconn)); + } + +#endif + + return 0; +} diff --git a/src/common/debug.h b/src/common/debug.h new file mode 100644 index 0000000..9b04bb0 --- /dev/null +++ b/src/common/debug.h @@ -0,0 +1,48 @@ +/* + * Common Debugging macros and definitions + * + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#ifndef _COMMON_DEBUG_H + +#define _COMMON_DEBUG_H + +#define __perror(...) fprintf(stderr, __VA_ARGS__) + +#define die(...) \ + __perror("DIE: " __VA_ARGS__); \ + exit(1) + +#ifdef __DEBUG__ + +#include +#include + +#define dassert(expr) \ + ((expr) ? \ + (void) 0 : \ + __perror("ASSERT: \"" #expr "\" at %s:%i\n", __FILE__, __LINE__)) + +#define dprint(...) \ + __perror("DEBUG: " __VA_ARGS__) + +#else +#define dassert(expr) +#define dprint(...) +#endif + +#endif /* _COMMON_DEBUG_H */ diff --git a/src/common/mem.h b/src/common/mem.h new file mode 100644 index 0000000..b1e491f --- /dev/null +++ b/src/common/mem.h @@ -0,0 +1,12 @@ + +#ifndef _COMMON_MEM_H + +#define _COMMON_MEM_H + +#include + +#define sfree(x) \ + if (x != NULL) \ + free(x) + +#endif /* _COMMON_MEM_H */ diff --git a/src/common/path.c b/src/common/path.c new file mode 100644 index 0000000..2d8055e --- /dev/null +++ b/src/common/path.c @@ -0,0 +1,169 @@ + +/* + * Copyright (C) 2010 Archived + * + * 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 . + */ + +/* + * the design goal here is to not use buffers because + * path's can be extremely long (slightly overexaggerated but extreme cases are extreme). + * so we use funky heap memory based algorithms instead :) + */ + +#include +#include + +#include "debug.h" +#include "path.h" + +/* + * allocates and initilizes a path + */ +static char* alloc_path(size_t s) { + + char *ptr; + + if (s < 1) + return NULL; + + if ((ptr = malloc(s+1)) == NULL) + return NULL; + + *ptr = '/'; + memset(ptr+1, 0, s); + + return ptr; +} + +static const char* path_clear(const char *path) { + + while(*path == '/') + path++; + + return path; +} + +static inline int has_delim(const char *str) { + + if (str == NULL) + return 0; + + return strchr(str, '/') != NULL; +} + +/* + * copy a clean path to buf + * NOTE: buffer should be atleast of size pathlen(path) + */ +static char* cpy_path(char *buf, const char *path) { + + if(!*path) + return buf; + + while(*path) { + + *(buf++) = *path; + + if (*path == '/') + path = path_clear(path); + else + path++; + } + + if (*(buf-1) != '/') + *(buf++) = '/'; + + dassert(*buf == 0); + + return buf; +} + +int abspath(const char *path) { + + if (*path != '/') + return 0; + + return strstr(path, "/./") == NULL && + strstr(path, "/../") == NULL; +} + +size_t pathlen(const char *path) { + + size_t size = 0; + + while(*path != 0) { + + size++; + + if (*path == '/') + path = path_clear(path); + else if (*(++path) == 0) + size++; + } + + return size; +} + +char* fmt_path(const char *base, const char *name, unsigned char dir) { + + char *ptr, *ret; + size_t size; + + if (base == NULL || !abspath(base) || has_delim(name)) + return NULL; + + size = pathlen(base); + + if (name != NULL) { + size += strlen(name); + if (dir) size++; + } + + if((ptr = alloc_path(size)) == NULL) + return NULL; + + ret = ptr; + + ptr = cpy_path(ptr, base); + + dassert((ptr-ret) == pathlen(base)); + + if (name != NULL) { + memcpy(ptr, name, strlen(name)); + if (dir) *(ptr+strlen(name)) = '/'; + } + + return ret; +} + +char* split_path(const char *path) { + return NULL; +} + +const char* basename(const char *path) { + + const char *last = path+strlen(path); + + if (*last == '/') + last--; + + while(path != last) { + if(*last == '/') + break; + last--; + } + + return last; +} diff --git a/src/common/path.h b/src/common/path.h new file mode 100644 index 0000000..f5942ba --- /dev/null +++ b/src/common/path.h @@ -0,0 +1,40 @@ +/* + * -- path.h + * + * common path handling routines + * + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#ifndef _COMMON_PATH_H + +#define _COMMON_PATH_H + +#include +#include +#include + +#ifndef PATH_MAX +#define PATH_MAX 4096 +#endif + +size_t pathlen(const char *path); + +char* fmt_path(const char *base, const char *name, unsigned char dir); + +const char* basename(const char *path); + +#endif /* _COMMON_PATH_H */ diff --git a/src/common/rbtree.c b/src/common/rbtree.c new file mode 100644 index 0000000..81a3845 --- /dev/null +++ b/src/common/rbtree.c @@ -0,0 +1,355 @@ +/* + * Modified version of Julienne Walker's implementation + * http://www.eternallyconfuzzled.com/tuts/datastructures/jsw_tut_rbtree.aspx + * + * Copyright (C) 2010 Archived + * + * 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 . + * + * Do not touch anything in this file. it's perfect ;) + */ +#include + +#include "debug.h" +#include "rbtree.h" + +#define is_red(n) (n != NULL && n->color == RB_RED) +#define swap(n,d,q) n->child[n->child[d] == q] + +#ifdef __DEBUG__ +int rb_assert(rbnode *node) { + + int rh, lh; + rbnode *ln; + rbnode *rn; + + if (node == NULL) { + return 1; + } + + ln = node->child[0]; + rn = node->child[1]; + + if (is_red(node)) { + if (is_red(ln) || is_red(rn)) { + die("Double red"); + return 0; + } + } + + lh = rb_assert(ln); + rh = rb_assert(rn); + + if ( (ln != NULL && ln->key >= node->key) && + (rn != NULL && rn->key <= node->key) ) { + die("BST violation"); + return 0; + } + + if (rh != 0 && lh != 0) { + + if (rh != lh) { + die("Black height violation"); + return 0; + } + + return (is_red(node)) ? lh : lh+1; + } + + return 0; +} +#endif + +static rbnode* node_alloc(uint key, void *ptr) { + + rbnode *n = malloc(sizeof(rbnode)); + + if (n == NULL) + return NULL; + + n->key = key; + n->data = ptr; + n->color = RB_RED; + n->child[0] = NULL; + n->child[1] = NULL; + + return n; +} + +static void node_dealloc(rbnode *n, void (*a)(rbnode *)) { + + if (n == NULL) + return; + + if (a != NULL) + a(n); + else + free(n->data); + + node_dealloc(n->child[0], a); + node_dealloc(n->child[1], a); + + free(n); +} + +static void _rbwalk(rbnode *n, void (*a)(rbnode *)) { + + if (n == NULL) + return; + + a(n); + + _rbwalk(n->child[0], a); + _rbwalk(n->child[1], a); +} + +static rbnode* _rbcmp(rbnode *n, void *d, size_t l) { + + rbnode* r; + + if (n == NULL) + return NULL; + + if (memcmp(n->data, d, l) == 0) + return n; + + r = _rbcmp(n->child[0], d, l); + + if (r == NULL) + r = _rbcmp(n->child[1], d, l); + + return r; +} + +static rbnode* rotate_single(rbnode *root, unsigned char dir) { + + rbnode *save = root->child[!dir]; + + root->child[!dir] = save->child[dir]; + save->child[dir] = root; + + root->color = RB_RED; + save->color = RB_BLACK; + + return save; +} + +static rbnode* rotate_double(rbnode *root, unsigned char dir) { + root->child[!dir] = rotate_single(root->child[!dir], !dir); + return rotate_single(root, dir); +} + +int rbtree_insert(rbtree *tree, uint key, void *data) { + + rbnode head = {0}; + + /* grandparent and parent */ + rbnode *g, *t; + + /* iterator and parent */ + rbnode *p, *q; + + unsigned char dir = 0, dir2, last; + + /* somewhere in here, there should be dragons */ + + if (tree->root == NULL) { + tree->root = node_alloc(key, data); + if (tree->root == NULL) + return 0; + } else { + + t = &head; + g = p = NULL; + q = t->child[1] = tree->root; + + for(;;) { + if (q == NULL) { + p->child[dir] = q = node_alloc(key, data); + if (q == NULL) + return 0; + } else if (is_red(q->child[0]) && is_red(q->child[1])) { + /* color flip case */ + q->color = RB_RED; + q->child[0]->color = RB_BLACK; + q->child[1]->color = RB_BLACK; + } + + /* fix red validation */ + if (is_red(q) && is_red(p)) { + dir2 = (t->child[1] == g); + if (q == p->child[last]) + t->child[dir2] = rotate_single(g, !last); + else + t->child[dir2] = rotate_double(g, !last); + } + + if (q->key == key) + break; + + last = dir; + dir = q->key < key; + + if (g != NULL) + t = g; + g = p, p = q; + q = q->child[dir]; + } + + tree->root = head.child[1]; + } + + /* root should be black */ + tree->root->color = RB_BLACK; + + return 1; +} + +void* rbtree_delete(rbtree *tree, uint key) { + + rbnode head = {0}; + + /* helpers*/ + rbnode *q, *p, *g, *s; + + /* found item */ + rbnode *f = NULL; + + /* pointer to the data member of the node we delete */ + void *ret = NULL; + + unsigned char dir = 1, dir2, last; + + if (rbtree_is_empty(tree)) + return NULL; + + q = &head; + g = p = NULL; + q->child[1] = tree->root; + + /* more dragons */ + + while(q->child[dir] != NULL) { + last = dir; + + g = p, p = q; + q = q->child[dir]; + dir = q->key < key; + + if (q->key == key) + f = q; + + if (!is_red(q) && !is_red(q->child[dir])) { + if (is_red(q->child[!dir])) + p = p->child[last] = rotate_single(q, dir); + else if (!is_red(q->child[!dir])) { + s = p->child[!last]; + + if (s != NULL) { + /* swap color if both child's are black */ + if (!is_red(s->child[!last]) && !is_red(s->child[last])) { + p->color = RB_BLACK; + s->color = q->color = RB_RED; + } else { + dir2 = (g->child[1] == p); + + if (is_red(s->child[last])) + g->child[dir2] = rotate_double(p, last); + else if (is_red(s->child[!last])) + g->child[dir2] = rotate_single(p, last); + + q->color = g->child[dir2]->color = RB_RED; + g->child[dir2]->child[0]->color = RB_BLACK; + g->child[dir2]->child[1]->color = RB_BLACK; + } + } + } + } + } + + tree->root = head.child[1]; + if (tree->root != NULL) + tree->root->color = RB_BLACK; + + /* remove if found */ + if (f != NULL) { + ret = q->data; + if (q == tree->root) { + tree->root = NULL; + } else { + if (f != q) { + f->key = q->key; + f->data = q->data; + } + swap(p,1,q) = swap(q, 0, NULL); + } + free(q); + } + + return ret; +} + +rbnode* rbtree_search(rbtree *tree, uint key) { + + rbnode *n; + + if (tree == NULL || tree->root == NULL) + return NULL; + + n = tree->root; + + while(n != NULL) { + +#ifdef __DEBUG__ + printf("SEARCH: check %u\n", n->key); +#endif + + if (n->key == key) + break; + + n = n->child[n->key < key]; + } + + return n; +} + +rbnode* rbtree_cmp_search(rbtree *tree, void *cmpdata, size_t len) { + + if (tree == NULL) + return NULL; + + return _rbcmp(tree->root, cmpdata, len); +} + +void rbtree_walk(rbtree *tree, void (*action)(rbnode *)) { + + if (tree == NULL) + return; + + _rbwalk(tree->root, action); +} + +void rbtree_free(rbtree *tree, void (*action)(rbnode *)) { + + if (tree == NULL) + return; + + node_dealloc(tree->root, action); + tree->root = NULL; +} + +inline int rbtree_is_empty(rbtree *tree) { + + return tree == NULL || tree->root == NULL; +} diff --git a/src/common/rbtree.h b/src/common/rbtree.h new file mode 100644 index 0000000..749cfc2 --- /dev/null +++ b/src/common/rbtree.h @@ -0,0 +1,59 @@ + +/* + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#ifndef _COMMON_RBTREE_H + +#define _COMMON_RBTREE_H + +#define RB_RED 0 +#define RB_BLACK 1 + +typedef unsigned char color_t; +typedef unsigned int uint; + +/* node definition */ +typedef struct _rbn { + uint key; + void *data; + struct _rbn *child[2]; + color_t color; +} rbnode; + +typedef struct { + rbnode *root; +} rbtree; + +#ifdef RB_DEBUG +int rb_assert(rbnode *node); +#endif + +int rbtree_insert(rbtree *tree, uint key, void *data); + +void* rbtree_delete(rbtree *tree, uint key); + +rbnode* rbtree_search(rbtree *tree, uint key); + +rbnode* rbtree_cmp_search(rbtree *tree, void *cmpdata, size_t len); + +void rbtree_walk(rbtree *tree, void (*action)(rbnode *)); + +void rbtree_free(rbtree *tree, void (*action)(rbnode *)); + +inline int rbtree_is_empty(rbtree *tree); + +#endif /* _COMMON_RBTREE_H */ diff --git a/src/fs/notify.h b/src/fs/notify.h new file mode 100644 index 0000000..d290673 --- /dev/null +++ b/src/fs/notify.h @@ -0,0 +1,46 @@ + +/* + * Archived file-system notification + * + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#ifndef _FS_NOTIFY_H + +#define _FS_NOTIFY_H + +/* notify event def's and operations */ +#include "notify_event.h" + +int notify_init(); + +void notify_cleanup(); + +int notify_add_watch(const char *path); + +void notify_rm_watch(unsigned int wd); + +void notify_rm_watch_path(const char *path); + +void notify_print_stat(); + +notify_event* notify_read(); + +void notify_stat(); + +int notify_is_ready(); + +#endif /* _FS_NOTIFY_H */ diff --git a/src/fs/notify_event.c b/src/fs/notify_event.c new file mode 100644 index 0000000..728faff --- /dev/null +++ b/src/fs/notify_event.c @@ -0,0 +1,155 @@ +/* + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#include +#include +#include + +#include "notify_event.h" +#include "../common/path.h" + +#define dealloc_data(ev) \ + if (ev->path != NULL) \ + free(ev->path); \ + if (ev->filename != NULL) \ + free(ev->filename) + +static void init_event(notify_event* ev) { + + ev->filename = NULL; + ev->path = NULL; + ev->type = 0; + ev->dir = 0; +} + +/* + * Create event + */ +notify_event* notify_event_new() { + + notify_event *ev = malloc(sizeof(notify_event)); + + if(ev == NULL) + return NULL; + + init_event(ev); + + return ev; +} + +/* + * Destroy event + */ +void notify_event_del(notify_event *event) { + + if(event != NULL) + return; + + dealloc_data(event); + free(event); +} + +/* + * dealloc memory and set default values + */ +void notify_event_clear(notify_event *event) { + + if(event == NULL) + return; + + dealloc_data(event); + + // set init values + init_event(event); +} + +/* + * Set event path + */ +void notify_event_set_path(notify_event *event, const char *path) { + + char *ptr; + + if(event == NULL || path == NULL) + return; + + ptr = realloc(event->path, sizeof(char) * (strlen(path)+1)); + + if (ptr == NULL) + return; + + memcpy(ptr, path, strlen(path)+1); + + event->path = ptr; +} + +/* + * Set event filename + */ +void notify_event_set_filename(notify_event *event, const char *filename) { + + char *tmp; + + if(event == NULL || filename == NULL) + return; + + + tmp = realloc(event->filename, sizeof(char) * (strlen(filename)+1)); + + if(tmp == NULL) + return; + + memcpy(tmp, filename, strlen(filename)+1); + + event->filename = tmp; +} + +/* set directory */ +void notify_event_set_dir(notify_event *event, uint8_t dir) { + + if(event == NULL) + return; + + event->dir = dir; +} + +void notify_event_set_type(notify_event *event, uint8_t type) { + + if(event == NULL) + return; + + event->type = type; +} + +const char* notify_event_typetostr(notify_event *event) { + + switch(event->type) { + case NOTIFY_CREATE : + return "CREATE"; + case NOTIFY_DELETE : + return "DELETE"; + break; + case NOTIFY_MOVE_FROM : + return "MOVE_FROM"; + break; + case NOTIFY_MOVE_TO : + return "MOVE_TO"; + break; + default: + return "UNKNOWN"; + } +} diff --git a/src/fs/notify_event.h b/src/fs/notify_event.h new file mode 100644 index 0000000..ee91aad --- /dev/null +++ b/src/fs/notify_event.h @@ -0,0 +1,56 @@ +/* + * event data-structure and operation's for notify API + * + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#ifndef _NOTIFY_EVENT_H + +#define _NOTIFY_EVENT_H + +#include + +/* event types */ +#define NOTIFY_UNKNOWN (1 << 0) +#define NOTIFY_CREATE (1 << 1) +#define NOTIFY_DELETE (1 << 2) +#define NOTIFY_MOVE_FROM (1 << 3) +#define NOTIFY_MOVE_TO (1 << 4) + +typedef struct { + uint8_t type; /* type of event */ + uint8_t dir; /* non zero if event is triggered on a directory */ + char *path; /* path of the triggered event */ + char *filename; /* the filename event was triggered on */ +} notify_event; + +notify_event* notify_event_new(); + +void notify_event_del(notify_event *event); + +void notify_event_clear(notify_event *event); + +void notify_event_set_path(notify_event *event, const char *path); + +void notify_event_set_filename(notify_event *event, const char *filename); + +void notify_event_set_dir(notify_event *event, uint8_t dir); + +void notify_event_set_type(notify_event *event, uint8_t type); + +const char* notify_event_typetostr(notify_event *event); + +#endif /* _NOTIFY_EVENT_H */ diff --git a/src/fs/notify_inotify.c b/src/fs/notify_inotify.c new file mode 100644 index 0000000..c808469 --- /dev/null +++ b/src/fs/notify_inotify.c @@ -0,0 +1,307 @@ +/* + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +/* red black tree for watch descriptors */ +#include "../common/rbtree.h" +#include "../common/debug.h" +#include "../common/path.h" +#include "notify.h" + +typedef struct inotify_event inoev; + +#define MAXEVENT 0x200 +#define PADEVSIZE (sizeof(inoev) + 0x40) +#define INOBUFSIZE (MAXEVENT*PADEVSIZE) + +#define WATCH_MASK (IN_MOVE | IN_CREATE | IN_DELETE | IN_ONLYDIR) + +/* Inotify file descriptor */ +static int fd = 0; + +/* Available bytes on file descriptor */ +static unsigned int fd_bytes = 0; + +/* redblack tree */ +static rbtree tree; + +/* inotify queue buffer */ +static char *inobuf = NULL; + +/* current event */ +static notify_event event; + +static int rmwatch(unsigned int wd) { + + void *data = rbtree_delete(&tree, wd); + + if (data == NULL) + return 0; + + dprint("remove watch: %i %s\n", wd, (char*) data); + free(data); + return 1; +} + +static int addwatch(const char *path, const char *name) { + + rbnode *node; + char *cpath; + int wd; + + cpath = fmt_path(path, name, 1); + + if (cpath == NULL) + return -1; + + wd = inotify_add_watch(fd, cpath, WATCH_MASK); + + if (wd < 0) { + perror("NOTIFY ADD"); + dprint("%i path %s\n", errno == EBADF, cpath); + return -errno; + } + + /* we must update to not introduce duplicated wd's (keys) */ + node = rbtree_search(&tree, wd); + + if (node == NULL) { + dprint("added wd = %i on %s\n", wd, cpath); + rbtree_insert(&tree, wd, (void*)cpath); + } else { + dprint("updated wd = %i from %s to %s\n", wd, (char*)node->data, cpath); + free(node->data); + node->data = (void*) cpath; + } + + return wd; +} + +/* REF:1 */ +static int proc_event(inoev *iev) { + + rbnode *node; + char buf[4096]; + uint8_t type = NOTIFY_UNKNOWN; + + if (iev == NULL) + return 0; + + //notify_event_clear(&event); + +#ifdef __DEBUG__ + fprintf(stderr, "RAW EVENT: %i, %x", iev->wd, iev->mask); + if (iev->len) + fprintf(stderr, ", %s\n", iev->name); + else + fprintf(stderr, "\n"); +#endif + + /* lookup the watch descriptor in rbtree */ + node = rbtree_search(&tree, iev->wd); + + if (node == NULL) { +#ifdef __DEBUG__ + fprintf(stderr, "-- IGNORING EVENT -- invalid watchdescriptor %i\n", iev->wd); + rb_assert(tree.root); +#endif + return 0; + } + + notify_event_set_dir(&event, (iev->mask & IN_ISDIR) != 0); + + /* set path, this is stored in void* node->data */ + notify_event_set_path(&event, (char*)node->data); + notify_event_set_filename(&event, iev->name); + + iev->mask &= ~IN_ISDIR; + + switch (iev->mask) { + + case IN_CREATE : + + if (event.dir) { + dprint("IN_CREATE on directory, adding\n"); + addwatch(event.path, event.filename); + } + + type = NOTIFY_CREATE; + break; + case IN_MOVED_TO : + + if (event.dir) { + dprint("IN_CREATE on directory, adding\n"); + addwatch(event.path, event.filename); + } + + type = NOTIFY_MOVE_TO; + break; + case IN_MOVED_FROM : + /* TODO: clean this */ + sprintf(buf, "%s%s/", event.path, event.filename); + notify_rm_watch_path(buf); + case IN_DELETE : + type = NOTIFY_DELETE; + break; + case IN_IGNORED : + rmwatch(iev->wd); + return 0; + } + + notify_event_set_type(&event, type); + + return 1; +} + +int notify_init() { + + if (fd > 0) { + fprintf(stderr, "inotify already instantiated."); + return 0; + } + + fd = inotify_init(); + + if (fd < 1) { + perror("NOTIFY INIT"); + return -1; + } + + dprint("inotify descriptor = %i\n", fd); + + inobuf = malloc(INOBUFSIZE); + + if (inobuf == NULL) { + perror("NOTIFY BUFFER"); + return -1; + } + + return 1; +} + +void notify_cleanup() { + + /* free rbtree */ + rbtree_free(&tree, NULL); + + if (inobuf != NULL) + free(inobuf); + + fd = 0; +} + +/* + * Add inotify watch on path + */ +int notify_add_watch(const char *path) { + + return addwatch(path, NULL); +} + +void notify_rm_watch(unsigned int wd) { + inotify_rm_watch(fd, wd); +} + +void notify_rm_watch_path(const char *path) { + + rbnode *node = rbtree_cmp_search(&tree, (void*)path, strlen(path)); + + if (node == NULL) { + dprint("remove watch by path: can't find %s\n", path); + return; + } + + dprint("remove watch by path: %i %s\n", node->key, (char*) node->data); + notify_rm_watch(node->key); +} + +/* + * Get next inotify event + */ +notify_event* notify_read() { + + int rc; + inoev *rev = NULL; + static int offset; + + while(! proc_event(rev)) { + + if (fd_bytes < 1) { + + offset = 0; + + fd_bytes = read(fd, inobuf, INOBUFSIZE); + + if (fd_bytes < 1) { + + if (fd_bytes == 0) { + fprintf(stderr, "NOTIFY READ: EOF\n"); + } + /* EINTR = call interrupted, silent ignore */ + else if (errno != EINTR) { + perror("NOTIFY READ"); + } + + return NULL; + } + } + + rev = (inoev *) &inobuf[offset]; + offset += sizeof(inoev) + rev->len; + + if (offset >= fd_bytes) + fd_bytes = 0; + } + + return &event; +} + +static void print_node(rbnode *node) { + printf("%i: %s\n", node->key, (char*) node->data); +} + +void notify_stat() { + +#ifdef __DEBUG__ + rbtree_walk(&tree, print_node); +#endif +} + +int notify_is_ready() { + + unsigned int bytes; + + if (fd_bytes > 1) + return 1; + + if (ioctl(fd, FIONREAD, &bytes) == -1) + return 0; + + dprint("%i bytes ready!\n", bytes); + + return bytes > 512; +} + + diff --git a/src/fs/tree.c b/src/fs/tree.c new file mode 100644 index 0000000..303746e --- /dev/null +++ b/src/fs/tree.c @@ -0,0 +1,206 @@ + +/* + * -- tree.c + * + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#include +#include +#include +#include +#include +#include + +#include "../common/mem.h" +#include "../common/path.h" +#include "tree.h" + +#if 0 + #define pdebug(...) fprintf(stderr, __VA_ARGS__) +#else + #define pdebug(...) 0 +#endif + +#define isrefdir(x) (!strcmp(x->d_name, ".") || !strcmp(x->d_name, "..")) + +/* REF:1 */ +static int have_perm(const char *base, const char *name) { + + char buf[1024]; + + sprintf(buf, "%s%s", base, name); + + return access(buf, R_OK | X_OK) == 0; +} + +struct tree* tree_new(const char *path) { + + int i; + struct tree *t = malloc(sizeof(struct tree)); + + if (t == NULL) + return NULL; + + t->path = fmt_path(path, NULL, 0); + + if (t->path == NULL) { + free(t); + return NULL; + } + + t->depth = 0; + + t->dirs[0] = opendir(t->path); + + if (!t->dirs[0]) { + free(t->path); + free(t); + return NULL; + } + + t->ent.name = NULL; + t->ent.base = NULL; + t->ent.dir = 0; + + return t; +} + +void tree_del(struct tree *tree) { + + int i; + + for(i=0; i < tree->depth; i++) + closedir(tree->dirs[i]); + + if (tree->path != NULL) + free(tree->path); + + free(tree); +} + +/* REF:1 */ +int tree_mvup(struct tree *tree) { + + char *slash; + + if (closedir(tree->dirs[tree->depth]) == -1) { + perror("TREE"); + return -1; + } + + if (tree->depth == 0) + return 0; +#if __DEBUG__ + printf("tree_next_ent: tree depth is: %i \n", tree->depth); +#endif + tree->depth--; + + slash = tree->path + strlen(tree->path)-1; + if (*slash == '/') + *slash = 0; + + slash = strrchr(tree->path, '/'); + *(slash+1) = 0; + + tree->path = realloc(tree->path, sizeof(char) * (strlen(tree->path)+1)); + + return 1; +} + +/* REF:1 */ +int tree_mvdown(struct tree *tree, const char *dir) { + + char buf[PATH_MAX]; + DIR *ds; + + if (tree->depth >= MAX_DEPTH-1) + return 0; + + sprintf(buf, "%s%s/\0", tree->path, dir); + + if ((ds = opendir(buf)) == NULL) { + if (errno != EACCES) + perror("DIROPEN"); + return 0; + } + + tree->path = realloc(tree->path, sizeof(char) * (strlen(buf)+1)); + memcpy(tree->path, buf, strlen(buf)+1); + + tree->dirs[++tree->depth] = ds; + + return 1; +} + +struct entry* tree_cpy_ent(struct entry *ent) { + + struct entry *ptr = malloc(sizeof(struct entry)); + + if (ptr == NULL) + return NULL; + + memcpy(ptr, ent, sizeof(struct entry)); + + return ptr; +} + +/* + * NOTE: only read from the struct returned and DO NOT free it. + * use tree_cpy_ent() if you need to store it. + */ +struct entry* tree_next_ent(struct tree *tree) { + + struct dirent *ent = NULL; + + if (tree == NULL) + return NULL; + + if (tree->ent.dir) + tree_mvdown(tree, tree->ent.name); + + for(;;) { + + ent = readdir(tree->dirs[tree->depth]); + + if (ent == NULL) { + + if (tree_mvup(tree)) + continue; + + tree_del(tree); + return NULL; + } else if (isrefdir(ent)) { + continue; + + } else if (ent->d_type == 4) { + + if (have_perm(tree->path, ent->d_name)) + break; + + } else { + break; + } + + } + + tree->ent.dir = ent->d_type == 4; + tree->ent.base = tree->path; + tree->ent.name = &ent->d_name[0]; + + + return &tree->ent; +} diff --git a/src/fs/tree.h b/src/fs/tree.h new file mode 100644 index 0000000..f7801a5 --- /dev/null +++ b/src/fs/tree.h @@ -0,0 +1,34 @@ + +#ifndef _FS_TREE_H + +#define _FS_TREE_H + +#define MAX_DEPTH 0x20 + +#include + +struct tree { + char *path; + DIR *dirs[MAX_DEPTH]; + unsigned char depth; + /* REF:2 */ + struct entry { + char *name; + char *base; + unsigned char dir; + } ent; +}; + +struct tree* tree_new(const char *path); + +void tree_del(struct tree *tree); + +int tree_mvup(struct tree *tree); + +int tree_mvdown(struct tree *tree, const char *dir); + +struct entry* tree_cpy_ent(struct entry *ent); + +struct entry* tree_next_ent(struct tree *tree); + +#endif /* _FS_TREE_H */ diff --git a/src/indexer.c b/src/indexer.c new file mode 100644 index 0000000..adb5b74 --- /dev/null +++ b/src/indexer.c @@ -0,0 +1,139 @@ + +/* + * Copyright (C) 2010 Archived + * + * 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 . + */ + +#include +#include +#include "common/debug.h" +#include "common/path.h" +#include "arch/db.h" +#include "fs/notify.h" +#include "fs/tree.h" +#include "indexer.h" + +static char *stack[256]; +static unsigned char st_size = 0; +static struct tree *current = NULL; + +/* REF:1 */ +static void index_entry(struct entry *ent) { + + static char buf[1024]; + + arch_db_insert(ent->base, ent->name, ent->dir); + + if (ent->dir) { + memcpy(buf, ent->base, strlen(ent->base)); + memcpy(buf + strlen(ent->base), ent->name, strlen(ent->name)+1); + notify_add_watch(buf); + } + +#ifdef __DEBUG__ + printf("Index: %s%s\n", ent->base, ent->name); +#endif +} + +static void add(const char *path) { + + char *newstr; + + if (st_size >= 255) + return; + + newstr = malloc(sizeof(char) * (strlen(path)+1)); + + if (newstr == NULL) + return; + + memcpy(newstr, path, strlen(path)+1); + + stack[st_size] = newstr; + + st_size++; +} + +/* we only shift the stack when getting the + * next tree, so this will do for now. */ +static int rm() { + + int i; + + current = NULL; + + while(current == NULL) { + + if (st_size == 0) + return 0; + + current = tree_new(stack[0]); + + free(stack[0]); + + st_size--; + + for(i=0; i < st_size; i++) + stack[i] = stack[i+1]; + } + + return 1; +} + +void indexer_register(const char *base, const char *name) { + + char *fullpath = fmt_path(base, name, 1); + + if (!indexer_pending()) { +#if __DEBUG__ + printf("sched: adding current index: %s\n", fullpath); +#endif + current = tree_new(fullpath); + free(fullpath); + return; + } + +#if __DEBUG__ + printf("sched: scheduling index: %s\n", fullpath); +#endif + + add(fullpath); +} + +void indexer_run(unsigned int num) { + + struct entry *ent; + + int i; + + for(i=0; i < num; i++) { + + ent = tree_next_ent(current); + + if (ent == NULL) { + + if (rm()) + continue; + + return; + } + + index_entry(ent); + } +} + +inline int indexer_pending() { + return current != NULL || st_size; +} diff --git a/src/indexer.h b/src/indexer.h new file mode 100644 index 0000000..07476f3 --- /dev/null +++ b/src/indexer.h @@ -0,0 +1,12 @@ + +#ifndef _INDEXER_H + +#define _INDEXER_H + +void indexer_register(const char *base, const char *name); + +void indexer_run(); + +inline int indexer_pending(); + +#endif /* _INDEXER_H */ diff --git a/test/Makefile b/test/Makefile new file mode 100644 index 0000000..4f24065 --- /dev/null +++ b/test/Makefile @@ -0,0 +1,37 @@ +# Test makefile +DEFS= -D__DEBUG__ +CC=gcc +CFLAGS=-g + +all : + make rbtree + make inotify + make mysql + +raw_inotify : + $(CC) -linotifytools raw_inotify.c -o raw_inotify + +path : + $(CC) -D__DEBUG__ $(CFLAGS) ../src/common/path.c t_path.c -o test_path + +rbtree : + $(CC) -D RB_DEBUG $(CFLAGS) ../src/common/rbtree.c t_rbtree.c -o test_rbtree + +inotify : + $(CC) -lpthread -D INOTIFY_DEBUG -D RB_DEBUG $(CFLAGS) \ + ../src/common/rbtree.c \ + ../src/common/path.c \ + ../src/fs/scan.c \ + ../src/fs/notify_event.c \ + ../src/fs/inotify.c \ + t_inotify.c -o test_inotify + +tree : + $(CC) $(CFLAGS) $(DEFS) ../src/common/path.c ../src/fs/tree.c t_tree.c -o test_tree + +indexer : + $(CC) $(CFLAGS) -D__DEBUG__ ../src/common/path.c ../src/fs/tree.c ../src/indexer.c t_indexer.c -o test_indexer + +mysql : + $(CC) -D DB_DEBUG $(CFLAGS) ../src/mysql_db.c -L/usr/lib64/mysql \ + -lmysqlclient -lz -lcrypt -lnsl -lm -L/usr/lib64 -lssl -lcrypto t_mysql.c -o test_mysql diff --git a/test/raw_inotify.c b/test/raw_inotify.c new file mode 100644 index 0000000..e8c59a1 --- /dev/null +++ b/test/raw_inotify.c @@ -0,0 +1,31 @@ + +#include +#include +#include +#include +// (IN_MOVE | IN_CREATE | IN_DELETE | IN_ONLYDIR) +#define WMASK (IN_MOVE | IN_MOVE_SELF | IN_CREATE | IN_DELETE | IN_ONLYDIR) + +int main(int argc, char **argv) { + + struct inotify_event *ev; + + if (argc < 2) + return 1; + + if ( !inotifytools_initialize() + || !inotifytools_watch_recursively(argv[1], WMASK) ) { + fprintf(stderr, "%s\n", strerror(inotifytools_error()) ); + return 1; + } + + for(;;) { + + ev = inotifytools_next_event(-1); + + printf("%u: ", ev->wd); + inotifytools_printf(ev, "%w:%f %e\n"); + } + + return 0; +} diff --git a/test/t_indexer.c b/test/t_indexer.c new file mode 100644 index 0000000..ec21770 --- /dev/null +++ b/test/t_indexer.c @@ -0,0 +1,29 @@ + +#include +#include +#include "../src/indexer.h" + +int main() { + + indexer_register("/home/pnx/", "tmptree"); + indexer_register("/home/pnx/", "tmptree"); + indexer_register("/home/pnx/", "tmptree"); + + while(indexer_pending()) { + indexer_run(5); + sleep(1); + } + + printf("---\n"); + + indexer_register("/home/pnx/", "tmptree"); + + while(indexer_pending()) { + indexer_run(5); + sleep(1); + } + + printf("done\n"); + + return 0; +} diff --git a/test/t_inotify.c b/test/t_inotify.c new file mode 100644 index 0000000..de90e51 --- /dev/null +++ b/test/t_inotify.c @@ -0,0 +1,40 @@ + +#include +#include "../src/fs/notify.h" + +PROT_SCAN_CALLBACK(my_callback) { + //printf("FROM THREAD -- path: %s; is_dir = %i\n", path, dir); +} + +int main(int argc, char *argv[]) { + + notify_event *event; + + if (argc < 2) + return 1; + + notify_init(); + + if (!notify_add_watch(argv[1])) + return 1; + + printf("begin watching on: %s\n", argv[1]); + + for (;;) { + + event = notify_read(3); + + if (event == NULL) + continue; + + printf("====================\n" + "Type: %s\n" + "Path: %s\n" + "Filename: %s\n" + "Directory: %u\n" + "====================\n" + , notify_event_masktostr(event), event->path, event->filename, event->dir); + } + + return 0; +} diff --git a/test/t_mysql.c b/test/t_mysql.c new file mode 100644 index 0000000..2cfb85d --- /dev/null +++ b/test/t_mysql.c @@ -0,0 +1,33 @@ + +#ifndef INOTIFY_DEBUG + #define INOTIFY_DEBUG +#endif + +#include +#include "../src/notify_db.h" + +int main(int argc, char *argv[]) { + + // Keep me safe + printf("Run!\n"); + + // Connect + notify_db_init("localhost", "warez", "elebobo", "filesystem", "filesystem"); + + // Truncate + //notify_db_truncate(); + + sleep(10); + + // Insert + notify_db_insert("/this/is/my/path/to/", "myfile", 0); + + // Delete + //notify_db_delete("/this/is/my/path/to/", "myfile"); + + // Close + notify_db_close(); + + // Kill me + return 0; +} \ No newline at end of file diff --git a/test/t_path.c b/test/t_path.c new file mode 100644 index 0000000..c5a3312 --- /dev/null +++ b/test/t_path.c @@ -0,0 +1,82 @@ + +#include +#include +#include "../src/common/path.h" + +/* test data */ + +char string[8][128] = { + "usr/include/", + "/usr/src/linux", + "/segment1/segment2/segment3/", + "//double///tripple", + "/stuff/with/ahell/lot/of/slashes/at/the/end/////////", + "~/myhome/", + "/", + "///////////////////////////////////////////////////////////" +}; + +char split[8][2][64] = { + {"usr/", "include/" }, + {"/usr/src/", "linux" }, + {"/segment1/segment2/", "segment3/" }, + {"//double//", "/tripple" }, + {"/stuff/with/ahell/lot/of/slashes/at/the/", "end/////////" }, + {"~/", "myhome/" }, + {"/mnt/cdrom", "keff" }, + {"//////////////////////////////", "/////////////////////////////" } +}; + +int main(int argc, char *argv[]) { + + int i; + char *ptr = NULL; + + for(i=0; i < 8; i++) { + //printf("adding: %s\n", string[i]); + ptr = fmt_path(string[i], NULL, 0); + printf("str %i is: %s\n", i, ptr); + + if (ptr != NULL) { + free(ptr); + ptr = NULL; + } + } + + for(i=0; i < 8; i++) { + //printf("adding: %s%s\n", split[i][0], split[i][1]); + ptr = fmt_path(split[i][0], split[i][1], 0); + printf("str %i is: %s\n", i, ptr); + + if (ptr != NULL) { + free(ptr); + ptr = NULL; + } + } + + for(i=0; i < 8; i++) { + //printf("adding: %s%s\n", split[i][0], split[i][1]); + ptr = fmt_path(split[i][0], split[i][1], 1); + printf("str %i is: %s\n", i, ptr); + + if (ptr != NULL) { + free(ptr); + ptr = NULL; + } + } + + if(argc < 2) + return 0; + else if(argc == 2) + ptr = fmt_path(argv[1], NULL, 0); + else if(argc > 2) { + ptr = fmt_path(argv[1], argv[2], 0); + } + + printf("%s\n", ptr); + + if (ptr != NULL) + free(ptr); + + return 0; +} diff --git a/test/t_rbtree.c b/test/t_rbtree.c new file mode 100644 index 0000000..c5a1b78 --- /dev/null +++ b/test/t_rbtree.c @@ -0,0 +1,91 @@ +#ifndef RB_DEBUG + #define RB_DEBUG 1 +#endif + +#include +#include +#include +#include +#include "../src/common/rbtree.h" + +#define MAX_VAL 12500 +#define NODES 5000 + +uint get_random_key(uint m) { + return (uint) (rand() % m); +} + +void printer(rbnode *node) { + + printf("node: %u (%p)\n", node->key, node); +} + +int main(int argc, char **argv) { + + uint keyref[NODES]; + uint i, spos, search_key, ckey; + rbtree tree; + rbnode *snode; + + tree.root = NULL; + + srand(time(NULL)); + + /* rbtree should be empty */ + assert(rbtree_is_empty(&tree) == 1); + + /* get a random node position */ + spos = get_random_key(NODES); + + /* insert values */ + for(i=0; i < NODES; i++) { + + ckey = get_random_key(MAX_VAL); + + if(i == spos) + search_key = ckey; + + //printf("insert: %u\n", ckey); + rbtree_insert(&tree, ckey, NULL); + keyref[i] = ckey; + } + + /* validate tree */ + rb_assert(tree.root); + + /* search the random key */ + snode = rbtree_search(&tree, search_key); + + assert(snode->key == search_key); + + /* remove some values */ + for(i=0; i < NODES; i++) { + + //printf("removing: %u\n", ckey); + + rbtree_delete(&tree, ckey); + + ckey = get_random_key(MAX_VAL); + } + + /* assert again */ + rb_assert(tree.root); + + if(argc == 1) { + /* free the tree */ + rbtree_free(&tree, NULL); + } else { + printf("---\n"); + for(i=0; i < NODES; i++) { + //printf("removing: %u\n", keyref[i]); + rbtree_delete(&tree, keyref[i]); + } + } + + rbtree_walk(&tree, printer); + + /* tree should now be empty */ + assert(rbtree_is_empty(&tree) == 1); + + return 0; +} diff --git a/test/t_tree.c b/test/t_tree.c new file mode 100644 index 0000000..81a8905 --- /dev/null +++ b/test/t_tree.c @@ -0,0 +1,36 @@ + +#include +#include "../src/fs/tree.h" + +int main(int argc, char *argv[]) { + + struct entry *ent; + struct tree *tree; + unsigned int c_ent = 0; + + if (argc < 2) + return 1; + + tree = tree_new(argv[1]); + + if (tree == NULL) { + printf("error\n"); + return 1; + } + + for(;;) { + + ent = tree_next_ent(tree); + + if (ent == NULL) + break; + + printf("%s%s\n", ent->base, ent->name); + + c_ent++; + } + + printf("%i Entries\n", c_ent); + + return 0; +} diff --git a/test/unit.c b/test/unit.c new file mode 100644 index 0000000..6dcd878 --- /dev/null +++ b/test/unit.c @@ -0,0 +1,16 @@ + +#include "unit.h" + +int utest_string(const char *a, const char *b) { + + while(*a == *b) { + + if (*a == 0) + return 1; + + a++; + b++; + } + + return 0; +} diff --git a/test/unit.h b/test/unit.h new file mode 100644 index 0000000..edff615 --- /dev/null +++ b/test/unit.h @@ -0,0 +1,21 @@ + +#ifndef _UNIT_H + +#define _UNIT_H + +#include +#include +#include +#include + +#define utest_exit(fmt, ...) \ + fprintf(stderr, fmt, __VA_ARGS__); \ + exit(1) + +#define utest_string(a, b) \ + (strcmp(a, b) == 0 ? \ + (void) 0 : \ + utest_exit("ASSERT: \"" #expr "\" at %s:%i\n", __FILE__, __LINE__)) + + +#endif /* _UNIT_H */ diff --git a/test/unit_path.c b/test/unit_path.c new file mode 100644 index 0000000..0b0272a --- /dev/null +++ b/test/unit_path.c @@ -0,0 +1,9 @@ + +#include +#include +#include + +void unit_fmt_path() { + + assert(); +}