From: Andrea Zagli Date: Sun, 21 Jul 2019 06:19:46 +0000 (+0200) Subject: First import (from libzakconfi). X-Git-Url: https://saetta.ns0.it/gitweb?a=commitdiff_plain;h=6a0c238b206fb86e361e8d5002aeb8a3447a8254;p=zakbookmarks%2Flibzakbookmarks First import (from libzakconfi). --- 6a0c238b206fb86e361e8d5002aeb8a3447a8254 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..010c263 --- /dev/null +++ b/.gitignore @@ -0,0 +1,60 @@ +compile +*~ +*.rpath +*.pot +*.mo +*.gmo +*.o +*.lo +*.la +*.bak +*.stamp +*.tar.gz +*.pc +*.sed +*.sin +*.header +.libs +.deps +ABOUT-NLS +INSTALL +Makefile +Makefile.in +Makefile.in.in +Makevars +aclocal.m4 +autom4te.cache/ +config.guess +config.log +config.sub +config.h.in +configure +depcomp +gtk-doc.make +install-sh +ltmain.sh +m4/ +missing +config.h +config.status +docs/reference/version.xml +docs/reference/html/ +docs/reference/xml/ +libtool +stamp-h1 +POTFILES +mkinstalldirs +stamp-it +intltool-* +Rules-quot +*.exe +tests/test +tests/test_get_configs_list +tests/test_get_tree +tests/test_add_config +tests/test_set_config +tools/add_config_from_confi +*.csv +gtk-doc.m4 +*.gir +*.typelib diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..948556f --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Andrea Zagli 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.am b/Makefile.am new file mode 100644 index 0000000..cb25222 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,8 @@ +DISTCHECK_CONFIGURE_FLAGS = --enable-introspection + +SUBDIRS = src plugins + +EXTRA_DIST = libzakbookmarks.pc.in + +pkgconfigdir = $(libdir)/pkgconfig +pkgconfig_DATA = libzakbookmarks.pc diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..e69de29 diff --git a/README b/README new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/README @@ -0,0 +1 @@ + diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..4429a4f --- /dev/null +++ b/autogen.sh @@ -0,0 +1,23 @@ +#!/bin/bash +# Run this to generate all the initial makefiles, etc. + +srcdir=`dirname $0` +test -z "$srcdir" && srcdir=. + +PKG_NAME="libzakbookmarks" + +(test -f $srcdir/configure.ac \ + && test -d $srcdir/src \ + && test -f $srcdir/src/libzakbookmarks.h) || { + echo -n "**Error**: Directory "\`$srcdir\'" does not look like the" + echo " top-level libzakbookmarks directory" + exit 1 +} + +which gnome-autogen.sh || { + echo "You need to install gnome-common from GNOME and make" + echo "sure the gnome-autogen.sh script is in your \$PATH." + exit 1 +} + +USE_GNOME2_MACROS=1 . gnome-autogen.sh diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..373e802 --- /dev/null +++ b/configure.ac @@ -0,0 +1,65 @@ +# -*- Autoconf -*- +# Process this file with autoconf to produce a configure script. + +AC_PREREQ(2.59) +AC_INIT([libzakbookmarks], [0.0.1], [azagli@libero.it]) +AC_CONFIG_SRCDIR([src/libzakbookmarks.h]) +AC_CONFIG_HEADER([config.h]) + +AM_INIT_AUTOMAKE(-Wall) + +m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])]) + +AM_MAINTAINER_MODE() + +AC_CANONICAL_SYSTEM + +AC_LIBTOOL_WIN32_DLL + +# Checks for programs. +AC_PROG_CC +AC_PROG_LIBTOOL +GTK_DOC_CHECK(1.0) + +GOBJECT_INTROSPECTION_CHECK([1.30.0]) + +# Checks for libraries. +PKG_CHECK_MODULES(LIBZAKBOOKMARKS, [libgdaex >= 0.5.0 + libpeas-1.0 >= 1.12.0]) + +AC_SUBST(LIBZAKBOOKMARKS_CFLAGS) +AC_SUBST(LIBZAKBOOKMARKS_LIBS) + +# Checks for header files. + +# Checks for typedefs, structures, and compiler characteristics. +AC_C_CONST + +# Checks for library functions. + +PLUGIN_LIBTOOL_FLAGS="-module -avoid-version -no-undefined" +AC_SUBST(PLUGIN_LIBTOOL_FLAGS) + +dnl ****************************** +dnl Check for Operating System +dnl ****************************** + +platform_win32=no + +case "$host" in +*-mingw*) + platform_win32=yes + ;; +esac + +AM_CONDITIONAL(PLATFORM_WIN32, [test $platform_win32 = yes]) + +AC_CONFIG_FILES([ + libzakbookmarks.pc + Makefile + src/Makefile + plugins/Makefile + plugins/db/Makefile +]) + +AC_OUTPUT diff --git a/libzakbookmarks.pc.in b/libzakbookmarks.pc.in new file mode 100644 index 0000000..916e92f --- /dev/null +++ b/libzakbookmarks.pc.in @@ -0,0 +1,12 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ +pluginsdir=@libdir@/@PACKAGE@/plugins + +Name: @PACKAGE_NAME@ +Description: Library to manage bookmarks based on plugins (db, file, etc.) +Version: @PACKAGE_VERSION@ +Requires: libgdaex libpeas-1.0 +Libs: -L${libdir} -lzakbookmarks +Cflags: -I${includedir} diff --git a/plugins/Makefile.am b/plugins/Makefile.am new file mode 100644 index 0000000..3708d61 --- /dev/null +++ b/plugins/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = db diff --git a/plugins/db/Makefile.am b/plugins/db/Makefile.am new file mode 100644 index 0000000..b1ddff1 --- /dev/null +++ b/plugins/db/Makefile.am @@ -0,0 +1,19 @@ +pluginsdir = $(libdir)/$(PACKAGE)/plugins + +AM_CPPFLAGS = \ + -I$(top_srcdir) \ + $(LIBZAKBOOKMARKS_CFLAGS) \ + -DG_LOG_DOMAIN=\"ZakBookmakrsDB\" + +plugins_LTLIBRARIES = libdb.la + +libdb_la_SOURCES = \ + plgdb.h \ + plgdb.c + +libdb_la_LDFLAGS = $(PLUGIN_LIBTOOL_FLAGS) +libdb_la_LIBADD = \ + $(top_builddir)/src/libzakbookmarks.la \ + $(LIBZAKBOOKMARKS_LIBS) + +plugins_DATA = db.plugin diff --git a/plugins/db/db.plugin b/plugins/db/db.plugin new file mode 100644 index 0000000..0b23d8b --- /dev/null +++ b/plugins/db/db.plugin @@ -0,0 +1,8 @@ +[Plugin] +Module=db +Name=DB +Description=Read bookmakrs from a database, based on libgda (via libgdaex). +Authors=Andrea Zagli +Copyright=Copyright © 2019 Andrea Zagli +Website=http://saetta.ns0.it/ +Help=http://saetta.ns0.it/ diff --git a/plugins/db/plgdb.c b/plugins/db/plgdb.c new file mode 100644 index 0000000..8861126 --- /dev/null +++ b/plugins/db/plgdb.c @@ -0,0 +1,974 @@ +/* + * plgdb.c + * This file is part of libzakbookmarks + * + * Copyright (C) 2019 Andrea Zagli + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Library General Public License as published by + * the Free Software Foundation; either version 2 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 Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#ifdef HAVE_CONFIG_H +#include +#endif + +#include + +#include +#include +#include + +#include + +#include + +#include "../../src/libzakconfi.h" +#include "../../src/confipluggable.h" + +#include "plgdb.h" + +static void zak_confi_pluggable_iface_init (ZakConfiPluggableInterface *iface); + +static gboolean zak_confi_db_plugin_initialize (ZakConfiPluggable *pluggable, const gchar *cnc_string); + +static GdaDataModel *zak_confi_db_plugin_path_get_data_model (ZakConfiPluggable *pluggable, const gchar *path); +static gchar *zak_confi_db_plugin_path_get_value_from_db (ZakConfiPluggable *pluggable, const gchar *path); +static void zak_confi_db_plugin_get_children (ZakConfiPluggable *pluggable, GNode *parentNode, gint idParent, gchar *path); + +#define ZAK_CONFI_DB_PLUGIN_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), ZAK_CONFI_TYPE_DB_PLUGIN, ZakConfiDBPluginPrivate)) + +typedef struct _ZakConfiDBPluginPrivate ZakConfiDBPluginPrivate; +struct _ZakConfiDBPluginPrivate + { + gchar *cnc_string; + + GdaEx *gdaex; + + gint id_config; + gchar *name; + gchar *description; + gchar *root; + + gchar chrquot; + }; + +G_DEFINE_DYNAMIC_TYPE_EXTENDED (ZakConfiDBPlugin, + zak_confi_db_plugin, + PEAS_TYPE_EXTENSION_BASE, + 0, + G_IMPLEMENT_INTERFACE_DYNAMIC (ZAK_CONFI_TYPE_PLUGGABLE, + zak_confi_pluggable_iface_init)) + +enum { + PROP_0, + PROP_CNC_STRING, + PROP_NAME, + PROP_DESCRIPTION, + PROP_ROOT +}; + +static void +zak_confi_db_plugin_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + gchar *sql; + + ZakConfiDBPlugin *plugin = ZAK_CONFI_DB_PLUGIN (object); + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (plugin); + + switch (prop_id) + { + case PROP_CNC_STRING: + zak_confi_db_plugin_initialize ((ZakConfiPluggable *)plugin, g_value_get_string (value)); + break; + + case PROP_NAME: + break; + + case PROP_DESCRIPTION: + break; + + case PROP_ROOT: + priv->root = zak_confi_normalize_root (g_value_get_string (value)); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + break; + } +} + +static void +zak_confi_db_plugin_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + ZakConfiDBPlugin *plugin = ZAK_CONFI_DB_PLUGIN (object); + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (plugin); + + switch (prop_id) + { + case PROP_CNC_STRING: + g_value_set_string (value, priv->cnc_string); + break; + + case PROP_NAME: + g_value_set_string (value, priv->name); + break; + + case PROP_DESCRIPTION: + g_value_set_string (value, priv->description); + break; + + case PROP_ROOT: + g_value_set_string (value, priv->root); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + break; + } +} + +static void +zak_confi_db_plugin_init (ZakConfiDBPlugin *plugin) +{ + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (plugin); + + priv->cnc_string = NULL; + priv->gdaex = NULL; + priv->name = NULL; + priv->description = NULL; +} + +static void +zak_confi_db_plugin_finalize (GObject *object) +{ + ZakConfiDBPlugin *plugin = ZAK_CONFI_DB_PLUGIN (object); + + G_OBJECT_CLASS (zak_confi_db_plugin_parent_class)->finalize (object); +} + +static gboolean +zak_confi_db_plugin_initialize (ZakConfiPluggable *pluggable, const gchar *cnc_string) +{ + ZakConfiDBPlugin *plugin = ZAK_CONFI_DB_PLUGIN (pluggable); + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (plugin); + + GString *gstr_cnc_string; + gchar **strs; + guint i; + guint l; + + gchar *sql; + GdaDataModel *dm; + + gchar *cnc_string_; + + cnc_string_ = g_strdup_printf ("%s;", cnc_string); + strs = g_strsplit (cnc_string_, ";", -1); + g_free (cnc_string_); + + gstr_cnc_string = g_string_new (""); + + l = g_strv_length (strs); + for (i = 0; i < l; i++) + { + if (g_str_has_prefix (strs[i], "CONFI_NAME=")) + { + priv->name = g_strdup (strs[i] + strlen ("CONFI_NAME=")); + if (priv->name[strlen (priv->name)] == ';') + { + priv->name[strlen (priv->name)] = '\0'; + } + } + else + { + g_string_append (gstr_cnc_string, strs[i]); + g_string_append (gstr_cnc_string, ";"); + } + } + if (priv->cnc_string != NULL) + { + g_free (priv->cnc_string); + } + priv->cnc_string = g_strdup (gstr_cnc_string->str); + + g_string_free (gstr_cnc_string, TRUE); + g_strfreev (strs); + + if (priv->name == NULL) + { + priv->name = g_strdup ("Default"); + } + + priv->gdaex = gdaex_new_from_string (priv->cnc_string); + priv->chrquot = gdaex_get_chr_quoting (priv->gdaex); + + /* check if config exists */ + sql = g_strdup_printf ("SELECT id, name" + " FROM configs" + " WHERE name = '%s'", + gdaex_strescape (priv->name, NULL)); + dm = gdaex_query (priv->gdaex, sql); + g_free (sql); + if (dm != NULL || gda_data_model_get_n_rows (dm) > 0) + { + priv->id_config = gdaex_data_model_get_value_integer_at (dm, 0, 0); + } + if (dm != NULL) + { + g_object_unref (dm); + } + + return (priv->gdaex != NULL && priv->name != NULL ? TRUE : FALSE); +} + +static GdaDataModel +*zak_confi_db_plugin_path_get_data_model (ZakConfiPluggable *pluggable, const gchar *path) +{ + gchar **tokens; + gchar *sql; + gchar *token; + guint i; + guint id_parent; + GdaDataModel *dm; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + if (path == NULL) return NULL; + + dm = NULL; + + tokens = g_strsplit (path, "/", 0); + if (tokens == NULL) return NULL; + + i = 0; + id_parent = 0; + while (tokens[i] != NULL) + { + token = g_strstrip (g_strdup (tokens[i])); + if (strcmp (token, "") != 0) + { + sql = g_strdup_printf ("SELECT *" + " FROM %cvalues%c" + " WHERE id_configs = %d" + " AND id_parent = %d" + " AND %ckey%c = '%s'", + priv->chrquot, priv->chrquot, + priv->id_config, + id_parent, + priv->chrquot, priv->chrquot, + gdaex_strescape (token, NULL)); + dm = gdaex_query (priv->gdaex, sql); + g_free (sql); + if (dm == NULL || gda_data_model_get_n_rows (dm) != 1) + { + /* TO DO */ + g_warning ("Unable to find key «%s».", token); + if (dm != NULL) + { + g_object_unref (dm); + dm = NULL; + } + break; + } + id_parent = gdaex_data_model_get_field_value_integer_at (dm, 0, "id"); + } + g_free (token); + + i++; + } + g_strfreev (tokens); + + return dm; +} + +static gchar +*zak_confi_db_plugin_path_get_value_from_db (ZakConfiPluggable *pluggable, const gchar *path) +{ + gchar *ret; + GdaDataModel *dm; + + ret = NULL; + + dm = zak_confi_db_plugin_path_get_data_model (pluggable, path); + if (dm != NULL) + { + ret = gdaex_data_model_get_field_value_stringify_at (dm, 0, "value"); + g_object_unref (dm); + } + + return ret; +} + +static void +zak_confi_db_plugin_get_children (ZakConfiPluggable *pluggable, GNode *parentNode, gint idParent, gchar *path) +{ + gchar *sql; + GdaDataModel *dm; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + sql = g_strdup_printf ("SELECT *" + " FROM %cvalues%c" + " WHERE id_configs = %d" + " AND id_parent = %d", + priv->chrquot, priv->chrquot, + priv->id_config, + idParent); + + dm = gdaex_query (priv->gdaex, sql); + g_free (sql); + if (dm != NULL) + { + guint i; + guint rows; + + rows = gda_data_model_get_n_rows (dm); + for (i = 0; i < rows; i++) + { + GNode *newNode; + ZakConfiKey *ck = g_new0 (ZakConfiKey, 1); + + ck->config = g_strdup (priv->name); + ck->key = g_strdup (gdaex_data_model_get_field_value_stringify_at (dm, i, "key")); + ck->value = g_strdup (gdaex_data_model_get_field_value_stringify_at (dm, i, "value")); + ck->description = g_strdup (gdaex_data_model_get_field_value_stringify_at (dm, i, "description")); + ck->path = g_strdup (path); + + newNode = g_node_append_data (parentNode, ck); + + zak_confi_db_plugin_get_children (pluggable, + newNode, + gdaex_data_model_get_field_value_integer_at (dm, i, "id"), + g_strconcat (path, (g_strcmp0 (path, "") == 0 ? "" : "/"), ck->key, NULL)); + } + g_object_unref (dm); + } +} + +static GList +*zak_confi_db_plugin_get_configs_list (ZakConfiPluggable *pluggable, + const gchar *filter) +{ + GList *lst; + + GdaDataModel *dmZakConfigs; + + gchar *sql; + gchar *where; + + guint row; + guint rows; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + lst = NULL; + + if (priv->gdaex == NULL) + { + return NULL; + } + + if (filter != NULL && strcmp (g_strstrip (g_strdup (filter)), "") != 0) + { + where = g_strdup_printf (" WHERE name LIKE '%s'", filter); + } + else + { + where = g_strdup (""); + } + + sql = g_strdup_printf ("SELECT * FROM configs%s", where); + g_free (where); + + dmZakConfigs = gdaex_query (priv->gdaex, sql); + g_free (sql); + if (dmZakConfigs != NULL) + { + rows = gda_data_model_get_n_rows (dmZakConfigs); + if (rows > 0) + { + for (row = 0; row < rows; row++) + { + ZakConfiConfi *confi; + confi = g_new0 (ZakConfiConfi, 1); + confi->name = gdaex_data_model_get_field_value_stringify_at (dmZakConfigs, row, "name"); + confi->description = gdaex_data_model_get_field_value_stringify_at (dmZakConfigs, row, "description"); + lst = g_list_append (lst, confi); + } + } + else + { + lst = g_list_append (lst, NULL); + } + } + + return lst; +} + +static gchar +*zak_confi_db_plugin_path_get_value (ZakConfiPluggable *pluggable, const gchar *path) +{ + gchar *ret; + gchar *path_; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + ret = NULL; + + path_ = zak_confi_path_normalize (pluggable, path); + if (path_ == NULL) + { + return NULL; + } + + ret = zak_confi_db_plugin_path_get_value_from_db (pluggable, path_); + + return ret; +} + +static gboolean +zak_confi_db_plugin_path_set_value (ZakConfiPluggable *pluggable, const gchar *path, const gchar *value) +{ + GdaDataModel *dm; + gchar *sql; + gboolean ret; + + dm = zak_confi_db_plugin_path_get_data_model (pluggable, zak_confi_path_normalize (pluggable, path)); + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + ret = FALSE; + if (dm != NULL && gda_data_model_get_n_rows (dm) > 0) + { + sql = g_strdup_printf ("UPDATE %cvalues%c" + " SET value = '%s'" + " WHERE id_configs = %d" + " AND id = %d", + priv->chrquot, priv->chrquot, + gdaex_strescape (value, NULL), + priv->id_config, + gdaex_data_model_get_field_value_integer_at (dm, 0, "id")); + ret = (gdaex_execute (priv->gdaex, sql) >= 0); + g_free (sql); + } + else + { + g_warning ("Path %s doesn't exists.", path); + } + if (dm != NULL) + { + g_object_unref (dm); + } + + return ret; +} + +GNode +*zak_confi_db_plugin_get_tree (ZakConfiPluggable *pluggable) +{ + gchar *path; + GNode *node; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + path = g_strdup (""); + + ZakConfiKey *ck = g_new0 (ZakConfiKey, 1); + + ck->config = g_strdup (priv->name); + ck->path = ""; + ck->key = g_strdup ("/"); + ck->value = ""; + ck->description = ""; + + node = g_node_new (ck); + + zak_confi_db_plugin_get_children (pluggable, node, 0, path); + + return node; +} + +static ZakConfiConfi +*zak_confi_db_plugin_add_config (ZakConfiPluggable *pluggable, const gchar *name, const gchar *description) +{ + ZakConfiConfi *cc; + + gchar *sql; + gint id; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + cc = NULL; + + id = gdaex_get_new_id (priv->gdaex, "configs", "id", NULL); + + sql = g_strdup_printf ("INSERT INTO configs" + " VALUES (%d, '%s', '%s')", + id, + gdaex_strescape (name, NULL), + gdaex_strescape (description, NULL)); + if (gdaex_execute (priv->gdaex, sql) > 0) + { + cc = g_new0 (ZakConfiConfi, 1); + cc->name = g_strdup (name); + cc->description = g_strdup (description); + } + + g_free (sql); + + return cc; +} + +static gboolean +zak_confi_db_plugin_set_config (ZakConfiPluggable *pluggable, + const gchar *name, + const gchar *description) +{ + gboolean ret; + gchar *sql; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + g_return_val_if_fail (name != NULL, FALSE); + + ret = TRUE; + + sql = g_strdup_printf ("UPDATE configs" + " SET name = '%s'" + " WHERE id = %d", + gdaex_strescape (name, NULL), + priv->id_config); + if (gdaex_execute (priv->gdaex, sql) < 1) + { + ret = FALSE; + } + g_free (sql); + priv->name = g_strdup (name); + + if (description != NULL) + { + sql = g_strdup_printf ("UPDATE configs" + " SET description = '%s'" + " WHERE id = %d", + gdaex_strescape (description, NULL), + priv->id_config); + if (gdaex_execute (priv->gdaex, sql) < 1) + { + ret = FALSE; + } + g_free (sql); + priv->description = g_strdup (description); + } + + return ret; +} + +static ZakConfiKey +*zak_confi_db_plugin_add_key (ZakConfiPluggable *pluggable, const gchar *parent, const gchar *key, const gchar *value) +{ + ZakConfiKey *ck; + GdaDataModel *dmParent; + + gchar *sql; + gint id; + GdaDataModel *dm; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + gint id_parent; + gchar *parent_; + gchar *key_; + + gchar *path; + + ck = NULL; + if (parent == NULL) + { + id_parent = 0; + } + else + { + parent_ = g_strstrip (g_strdup (parent)); + if (strcmp (parent_, "") == 0) + { + id_parent = 0; + } + else + { + dmParent = zak_confi_db_plugin_path_get_data_model (pluggable, zak_confi_path_normalize (pluggable, parent_)); + if (dmParent == NULL) + { + id_parent = -1; + } + else + { + id_parent = gdaex_data_model_get_field_value_integer_at (dmParent, 0, "id"); + } + } + } + + if (id_parent > -1) + { + key_ = g_strdup (key); + g_strstrip (key_); + + /* find if key exists */ + sql = g_strdup_printf ("SELECT id" + " FROM %cvalues%c" + " WHERE id_configs = %d" + " AND id_parent = %d" + " AND key = '%s'", + priv->chrquot, priv->chrquot, + priv->id_config, + id_parent, + gdaex_strescape (key_, NULL)); + dm = gdaex_query (priv->gdaex, sql); + g_free (sql); + if (dm == NULL + || gda_data_model_get_n_rows (dm) < 1) + { + id = 0; + + /* find new id */ + sql = g_strdup_printf ("SELECT MAX(id)" + " FROM %cvalues%c" + " WHERE id_configs = %d", + priv->chrquot, priv->chrquot, + priv->id_config); + dm = gdaex_query (priv->gdaex, sql); + g_free (sql); + if (dm != NULL) + { + id = gdaex_data_model_get_value_integer_at (dm, 0, 0); + g_object_unref (dm); + } + id++; + + sql = g_strdup_printf ("INSERT INTO %cvalues%c" + " (id_configs, id, id_parent, %ckey%c, value)" + " VALUES (%d, %d, %d, '%s', '%s')", + priv->chrquot, priv->chrquot, + priv->chrquot, priv->chrquot, + priv->id_config, + id, + id_parent, + gdaex_strescape (key_, NULL), + ""); + if (gdaex_execute (priv->gdaex, sql) == -1) + { + /* TO DO */ + g_free (sql); + return NULL; + } + g_free (sql); + } + + ck = g_new0 (ZakConfiKey, 1); + ck->config = g_strdup (priv->name); + if (id_parent == 0) + { + ck->path = g_strdup (""); + } + else + { + ck->path = g_strdup (parent_); + } + ck->key = g_strdup (key_); + ck->value = g_strdup (""); + ck->description = g_strdup (""); + + g_free (key_); + } + g_free (parent_); + + if (ck != NULL) + { + if (g_strcmp0 (ck->path, "") != 0) + { + path = g_strconcat (ck->path, "/", key, NULL); + } + else + { + path = g_strdup (ck->key); + } + + if (!zak_confi_db_plugin_path_set_value (pluggable, path, value)) + { + ck = NULL; + } + else + { + ck->value = g_strdup (value); + } + g_free (path); + } + + return ck; +} + +static gboolean +zak_confi_db_plugin_key_set_key (ZakConfiPluggable *pluggable, + ZakConfiKey *ck) +{ + gboolean ret; + gchar *sql; + + GdaDataModel *dm; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + dm = zak_confi_db_plugin_path_get_data_model (pluggable, g_strdup_printf ("%s/%s", ck->path, ck->key)); + if (dm == NULL) + { + return FALSE; + } + + sql = g_strdup_printf ("UPDATE %cvalues%c" + " SET %ckey%c = '%s'," + " value = '%s'," + " description = '%s'" + " WHERE id_configs = %d" + " AND id = %d", + priv->chrquot, priv->chrquot, + priv->chrquot, priv->chrquot, + gdaex_strescape (ck->key, NULL), + gdaex_strescape (ck->value, NULL), + gdaex_strescape (ck->description, NULL), + priv->id_config, + gdaex_data_model_get_field_value_integer_at (dm, 0, "id")); + + ret = (gdaex_execute (priv->gdaex, sql) >= 0); + g_free (sql); + + return ret; +} + +static ZakConfiKey +*zak_confi_db_plugin_path_get_confi_key (ZakConfiPluggable *pluggable, const gchar *path) +{ + GdaDataModel *dm; + gchar *path_; + ZakConfiKey *ck; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + path_ = zak_confi_path_normalize (pluggable, path); + if (path_ == NULL) + { + return NULL; + } + + dm = zak_confi_db_plugin_path_get_data_model (pluggable, path_); + if (dm == NULL || gda_data_model_get_n_rows (dm) <= 0) + { + if (dm != NULL) + { + g_object_unref (dm); + } + return NULL; + } + + ck = g_new0 (ZakConfiKey, 1); + ck->config = g_strdup (priv->name); + ck->path = g_strdup (path_); + ck->key = gdaex_data_model_get_field_value_stringify_at (dm, 0, "key"); + ck->value = gdaex_data_model_get_field_value_stringify_at (dm, 0, "value"); + ck->description = gdaex_data_model_get_field_value_stringify_at (dm, 0, "description"); + + if (dm != NULL) + { + g_object_unref (dm); + } + + return ck; +} + +static gboolean +zak_confi_db_plugin_delete_id_from_db_values (ZakConfiPluggable *pluggable, gint id) +{ + gboolean ret; + gchar *sql; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + sql = g_strdup_printf ("DELETE FROM %cvalues%c" + " WHERE id_configs = %d" + " AND id = %d", + priv->chrquot, priv->chrquot, + priv->id_config, + id); + + if (gdaex_execute (priv->gdaex, sql) >= 0) + { + ret = TRUE; + } + else + { + ret = FALSE; + } + g_free (sql); + + return ret; +} + +static gboolean +zak_confi_db_plugin_remove_path_traverse_func (GNode *node, gpointer data) +{ + GdaDataModel *dm; + ZakConfiPluggable* pluggable; + + pluggable = (ZakConfiPluggable *)data; + ZakConfiKey *ck = (ZakConfiKey *)node->data; + if (g_strcmp0 (ck->value, "") != 0) + { + dm = zak_confi_db_plugin_path_get_data_model (pluggable, g_strdup_printf ("%s/%s", ck->path, ck->key)); + zak_confi_db_plugin_delete_id_from_db_values (pluggable, gdaex_data_model_get_field_value_integer_at (dm, 0, "id")); + } + + return FALSE; +} + +static gboolean +zak_confi_db_plugin_remove_path (ZakConfiPluggable *pluggable, const gchar *path) +{ + gboolean ret = FALSE; + GdaDataModel *dm; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + dm = zak_confi_db_plugin_path_get_data_model (pluggable, zak_confi_path_normalize (pluggable, path)); + + if (dm != NULL && gda_data_model_get_n_rows (dm) > 0) + { + gchar *path_ = g_strdup (path); + + /* removing every child key */ + GNode *node; + gint id = gdaex_data_model_get_field_value_integer_at (dm, 0, "id"); + + ZakConfiKey *ck = g_new0 (ZakConfiKey, 1); + + ck->config = g_strdup (priv->name); + ck->path = path_; + ck->key = gdaex_data_model_get_field_value_stringify_at (dm, 0, "key"); + ck->value = ""; + ck->description = ""; + + node = g_node_new (ck); + zak_confi_db_plugin_get_children (pluggable, node, id, path_); + + g_node_traverse (node, G_POST_ORDER, G_TRAVERSE_ALL, -1, zak_confi_db_plugin_remove_path_traverse_func, (gpointer)pluggable); + + /* removing the path */ + ret = zak_confi_db_plugin_delete_id_from_db_values (pluggable, id); + } + else + { + g_warning ("Path %s doesn't exists.", path); + } + if (dm != NULL) + { + g_object_unref (dm); + } + + return ret; +} + +static gboolean +zak_confi_db_plugin_remove (ZakConfiPluggable *pluggable) +{ + gboolean ret; + gchar *sql; + + ZakConfiDBPluginPrivate *priv = ZAK_CONFI_DB_PLUGIN_GET_PRIVATE (pluggable); + + ret = TRUE; + sql = g_strdup_printf ("DELETE FROM %cvalues%c WHERE id_configs = %d", + priv->chrquot, + priv->chrquot, + priv->id_config); + if (gdaex_execute (priv->gdaex, sql) == -1) + { + g_free (sql); + ret = FALSE; + } + else + { + g_free (sql); + sql = g_strdup_printf ("DELETE FROM configs WHERE id = %d", + priv->id_config); + if (gdaex_execute (priv->gdaex, sql) == -1) + { + ret = FALSE; + } + g_free (sql); + } + + return ret; +} + +static void +zak_confi_db_plugin_class_init (ZakConfiDBPluginClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + g_type_class_add_private (object_class, sizeof (ZakConfiDBPluginPrivate)); + + object_class->set_property = zak_confi_db_plugin_set_property; + object_class->get_property = zak_confi_db_plugin_get_property; + object_class->finalize = zak_confi_db_plugin_finalize; + + g_object_class_override_property (object_class, PROP_CNC_STRING, "cnc_string"); + g_object_class_override_property (object_class, PROP_NAME, "name"); + g_object_class_override_property (object_class, PROP_DESCRIPTION, "description"); + g_object_class_override_property (object_class, PROP_ROOT, "root"); +} + +static void +zak_confi_pluggable_iface_init (ZakConfiPluggableInterface *iface) +{ + iface->initialize = zak_confi_db_plugin_initialize; + iface->get_configs_list = zak_confi_db_plugin_get_configs_list; + iface->path_get_value = zak_confi_db_plugin_path_get_value; + iface->path_set_value = zak_confi_db_plugin_path_set_value; + iface->get_tree = zak_confi_db_plugin_get_tree; + iface->add_config = zak_confi_db_plugin_add_config; + iface->set_config = zak_confi_db_plugin_set_config; + iface->add_key = zak_confi_db_plugin_add_key; + iface->key_set_key = zak_confi_db_plugin_key_set_key; + iface->path_get_confi_key = zak_confi_db_plugin_path_get_confi_key; + iface->remove_path = zak_confi_db_plugin_remove_path; + iface->remove = zak_confi_db_plugin_remove; +} + +static void +zak_confi_db_plugin_class_finalize (ZakConfiDBPluginClass *klass) +{ +} + +G_MODULE_EXPORT void +peas_register_types (PeasObjectModule *module) +{ + zak_confi_db_plugin_register_type (G_TYPE_MODULE (module)); + + peas_object_module_register_extension_type (module, + ZAK_CONFI_TYPE_PLUGGABLE, + ZAK_CONFI_TYPE_DB_PLUGIN); +} diff --git a/plugins/db/plgdb.h b/plugins/db/plgdb.h new file mode 100644 index 0000000..1593c93 --- /dev/null +++ b/plugins/db/plgdb.h @@ -0,0 +1,52 @@ +/* + * plgdb.h + * This file is part of libzakbookmarks + * + * Copyright (C) 2019 Andrea Zagli + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Library General Public License as published by + * the Free Software Foundation; either version 2 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 Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#ifndef __ZAK_CONFI_DB_PLUGIN_H__ +#define __ZAK_CONFI_DB_PLUGIN_H__ + +#include + +G_BEGIN_DECLS + +#define ZAK_CONFI_TYPE_DB_PLUGIN (zak_confi_db_plugin_get_type ()) +#define ZAK_CONFI_DB_PLUGIN(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), ZAK_CONFI_TYPE_DB_PLUGIN, ZakConfiDBPlugin)) +#define ZAK_CONFI_DB_PLUGIN_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), ZAK_CONFI_TYPE_DB_PLUGIN, ZakConfiDBPlugin)) +#define ZAK_CONFI_IS_DB_PLUGIN(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), ZAK_CONFI_TYPE_DB_PLUGIN)) +#define ZAK_CONFI_IS_DB_PLUGIN_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), ZAK_CONFI_TYPE_DB_PLUGIN)) +#define ZAK_CONFI_DB_PLUGIN_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), ZAK_CONFI_TYPE_DB_PLUGIN, ZakConfiDBPluginClass)) + +typedef struct _ZakConfiDBPlugin ZakConfiDBPlugin; +typedef struct _ZakConfiDBPluginClass ZakConfiDBPluginClass; + +struct _ZakConfiDBPlugin { + PeasExtensionBase parent_instance; +}; + +struct _ZakConfiDBPluginClass { + PeasExtensionBaseClass parent_class; +}; + +GType zak_confi_db_plugin_get_type (void) G_GNUC_CONST; +G_MODULE_EXPORT void peas_register_types (PeasObjectModule *module); + +G_END_DECLS + +#endif /* __ZAK_CONFI_DB_PLUGIN_H__ */ diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..9510932 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,54 @@ +AM_CPPFLAGS = $(WARN_CFLAGS) \ + $(DISABLE_DEPRECATED_CFLAGS) \ + $(LIBZAKBOOKMARKS_CFLAGS) \ + -DPLUGINSDIR=\""$(libdir)/$(PACKAGE)/plugins"\" \ + -DG_LOG_DOMAIN=\"ZakBookmarks\" + +LIBS = $(LIBZAKBOOKMARKS_LIBS) + +lib_LTLIBRARIES = libzakbookmarks.la + +libzakbookmarks_la_SOURCES = commons.c \ + bks.c \ + bkspluggable.c + +libzakbookmarks_la_LDFLAGS = -no-undefined + +libzakbookmarks_include_HEADERS = commons.h \ + libzakbookmarks.h \ + bkspluggable.h + +libzakbookmarks_includedir = $(includedir)/libzakbookmarks + +install-exec-hook: + mkdir -p "$(libdir)/$(PACKAGE)/plugins" + +uninstall-hook: + rm -rf "$(libdir)/$(PACKAGE)" + +CLEANFILES = + +-include $(INTROSPECTION_MAKEFILE) +INTROSPECTION_GIRS = +INTROSPECTION_SCANNER_ARGS = --add-include-path=$(srcdir) --warn-all --accept-unprefixed --identifier-prefix="" +INTROSPECTION_COMPILER_ARGS = --includedir=$(srcdir) +INTROSPECTION_SCANNER_ENV = CC="$(CC)" + +if HAVE_INTROSPECTION +introspection_sources = $(libzakbookmarks_la_SOURCES) $(libzakbookmarks_include_HEADERS) + +ZakBookmarks-1.0.gir: libzakbookmarks.la +ZakBookmarks_1_0_gir_INCLUDES = Gda-5.0 Peas-1.0 +ZakBookmarks_1_0_gir_CFLAGS = $(AM_CPPFLAGS) +ZakBookmarks_1_0_gir_LIBS = libzakbookmarks.la +ZakBookmarks_1_0_gir_FILES = $(introspection_sources) +INTROSPECTION_GIRS += ZakBookmarks-1.0.gir + +girdir = $(datadir)/gir-1.0 +gir_DATA = $(INTROSPECTION_GIRS) + +typelibdir = $(libdir)/girepository-1.0 +typelib_DATA = $(INTROSPECTION_GIRS:.gir=.typelib) + +CLEANFILES += $(gir_DATA) $(typelib_DATA) +endif diff --git a/src/bks.c b/src/bks.c new file mode 100644 index 0000000..7a9ce88 --- /dev/null +++ b/src/bks.c @@ -0,0 +1,807 @@ +/* + * Copyright (C) 2019 Andrea Zagli + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +#ifdef HAVE_BKSG_H + #include +#endif + +#include + +#include + +#ifdef G_OS_WIN32 +#include +#endif + +#include "libzakbookmarks.h" + + +static gchar *pluginsdir; + +enum +{ + PROP_0, + PROP_ID_BKSG, + PROP_NAME, + PROP_DESCRIPTION, + PROP_ROOT +}; + +static void zak_bks_class_init (ZakBksClass *klass); +static void zak_bks_init (ZakBks *bks); + +static void zak_bks_set_property (GObject *object, + guint property_id, + const GValue *value, + GParamSpec *pspec); +static void zak_bks_get_property (GObject *object, + guint property_id, + GValue *value, + GParamSpec *pspec); + +static ZakBksPluggable *zak_bks_get_bks_pluggable_from_cnc_string (const gchar *cnc_string); + +#define ZAK_BKS_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), ZAK_TYPE_BKS, ZakBksPrivate)) + +typedef struct _ZakBksPrivate ZakBksPrivate; +struct _ZakBksPrivate + { + gint id_bksg; + gchar *name; + gchar *description; + gchar *root; + GHashTable *values; + + ZakBksPluggable *pluggable; + }; + +G_DEFINE_TYPE (ZakBks, zak_bks, G_TYPE_OBJECT) + +#ifdef G_OS_WIN32 +static HMODULE backend_dll = NULL; + +BOOL WINAPI DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved); + +BOOL WINAPI +DllMain (HINSTANCE hinstDLL, + DWORD fdwReason, + LPVOID lpReserved) +{ + switch (fdwReason) + { + case DLL_PROCESS_ATTACH: + backend_dll = (HMODULE) hinstDLL; + break; + case DLL_THREAD_ATTACH: + case DLL_THREAD_DETACH: + case DLL_PROCESS_DETACH: + break; + } + return TRUE; +} +#endif + +static void +zak_bks_class_init (ZakBksClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + g_type_class_add_private (object_class, sizeof (ZakBksPrivate)); + + object_class->set_property = zak_bks_set_property; + object_class->get_property = zak_bks_get_property; +} + +static void +zak_bks_init (ZakBks *bks) +{ + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + priv->pluggable = NULL; +} + +static ZakBksPluggable +*zak_bks_get_bks_pluggable_from_cnc_string (const gchar *cnc_string) +{ + ZakBksPluggable *pluggable; + + const GList *lst_plugins; + + pluggable = NULL; + + PeasEngine *peas_engine; + + peas_engine = peas_engine_get_default (); + if (peas_engine == NULL) + { + return NULL; + } + + peas_engine_add_search_path (peas_engine, pluginsdir, NULL); + + lst_plugins = peas_engine_get_plugin_list (peas_engine); + while (lst_plugins) + { + PeasPluginInfo *ppinfo; + gchar *uri; + + ppinfo = (PeasPluginInfo *)lst_plugins->data; + + uri = g_strdup_printf ("%s://", peas_plugin_info_get_module_name (ppinfo)); + if (g_str_has_prefix (cnc_string, uri)) + { + if (peas_engine_load_plugin (peas_engine, ppinfo)) + { + PeasExtension *ext; + ext = peas_engine_create_extension (peas_engine, ppinfo, ZAK_BKS_TYPE_PLUGGABLE, + "cnc_string", cnc_string + strlen (uri), + NULL); + pluggable = (ZakBksPluggable *)ext; + break; + } + } + g_free (uri); + + lst_plugins = g_list_next (lst_plugins); + } + + if (pluggable == NULL) + { + g_warning ("No plugin found for connection string \"%s\".", cnc_string); + } + + return pluggable; +} + +/** + * zak_bks_new: + * @cnc_string: the connection string. + * + * Returns: (transfer none): the newly created #ZakBks object, or NULL if it fails. + */ +ZakBks +*zak_bks_new (const gchar *cnc_string) +{ + ZakBks *bks; + ZakBksPrivate *priv; + ZakBksPluggable *pluggable; + + g_return_val_if_fail (cnc_string != NULL, NULL); + +#ifdef G_OS_WIN32 + + gchar *moddir; + gchar *p; + + moddir = g_win32_get_package_installation_directory_of_module (backend_dll); + + p = g_strrstr (moddir, g_strdup_printf ("%c", G_DIR_SEPARATOR)); + if (p != NULL + && (g_ascii_strcasecmp (p + 1, "src") == 0 + || g_ascii_strcasecmp (p + 1, ".libs") == 0)) + { + pluginsdir = g_strdup (PLUGINSDIR); + } + else + { + pluginsdir = g_build_filename (moddir, "lib", PACKAGE, "plugins", NULL); + } + +#undef PLUGINSDIR + +#else + + pluginsdir = g_strdup (PLUGINSDIR); + +#endif + + bks = NULL; + + pluggable = zak_bks_get_bks_pluggable_from_cnc_string (cnc_string); + if (pluggable != NULL) + { + bks = ZAK_BKS (g_object_new (zak_bks_get_type (), NULL)); + priv = ZAK_BKS_GET_PRIVATE (bks); + priv->pluggable = pluggable; + } + + return bks; +} + +PeasPluginInfo +*zak_bks_get_plugin_info (ZakBks *bks) +{ + PeasPluginInfo *ppinfo; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ppinfo = NULL; + } + else + { + ppinfo = peas_extension_base_get_plugin_info ((PeasExtensionBase *)priv->pluggable); + } + + return ppinfo; +} + +/** + * zak_bks_get_bksgs_list: + * @cnc_string: the connection string to use to connect to database that + * contains bksguration. + * @filter: (nullable): + * + * Returns: (element-type ZakBksBks) (transfer container): a #GList of #ZakBksBks. If there's no bksgurations, returns a valid + * #GList but with a unique NULL element. + */ +GList +*zak_bks_get_bksgs_list (const gchar *cnc_string, + const gchar *filter) +{ + ZakBksPluggable *pluggable; + GList *lst; + + pluggable = zak_bks_get_bks_pluggable_from_cnc_string (cnc_string); + + if (pluggable == NULL) + { + g_warning ("Not initialized."); + lst = NULL; + } + else + { + lst = zak_bks_pluggable_get_bksgs_list (pluggable, filter); + } + + return lst; +} + +/** + * zak_bks_get_bks_bks: + * @bks: + * + * Returns: a #ZakBksBks struct. + */ +ZakBksBks +*zak_bks_get_bks_bks (ZakBks *bks) +{ + ZakBksBks *cc; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + cc = g_new0 (ZakBksBks, 1); + cc->name = g_strdup (priv->name); + cc->description = g_strdup (priv->description); + + return cc; +} + +/** + * zak_bks_add_bksg: + * @cnc_string: + * @name: + * @description: + * + * Returns: a #ZakBksBks struct just rceated. + */ +ZakBksBks +*zak_bks_add_bksg (const gchar *cnc_string, + const gchar *name, + const gchar *description) +{ + ZakBksPluggable *pluggable; + ZakBksBks *cc; + + pluggable = zak_bks_get_bks_pluggable_from_cnc_string (cnc_string); + + if (pluggable == NULL) + { + g_warning ("Not initialized."); + cc = NULL; + } + else + { + cc = zak_bks_pluggable_add_bksg (pluggable, name, description); + } + + return cc; +} + +static gboolean +add_traverse_func (GNode *node, + gpointer data) +{ + ZakBksKey *ck = (ZakBksKey *)node->data; + + if (g_strcmp0 (ck->key, "") != 0 + && g_strcmp0 (ck->key, "/") != 0) + { + zak_bks_add_key ((ZakBks *)data, ck->path, ck->key, ck->value); + } + + return FALSE; +} + +/** + * zak_bks_add_bksg_from_bks: + * @bks_source: + * @cnc_string: + * @name_new: + * @description_new: + * + * Returns: a #ZakBksBks struct just created. + */ +ZakBksBks +*zak_bks_add_bksg_from_bks (ZakBks *bks_source, + const gchar *cnc_string, + const gchar *name_new, + const gchar *description_new) +{ + ZakBks *bks; + ZakBksBks *cc; + + GNode *tree; + + gchar *bks_name; + + cc = zak_bks_add_bksg (cnc_string, name_new, description_new); + if (cc != NULL) + { + tree = zak_bks_get_tree (bks_source); + if (tree != NULL) + { + bks_name = g_strdup_printf ("%s;BKS_NAME=%s", cnc_string, cc->name); + + bks = zak_bks_new (bks_name); + + if (bks != NULL) + { + g_node_traverse (tree, G_PRE_ORDER, G_TRAVERSE_ALL, -1, add_traverse_func, (gpointer)bks); + } + + g_free (bks_name); + } + else + { + g_warning ("ZakBks source is empty."); + } + } + + return cc; +} + +/** + * zak_bks_get_tree: + * @bks: a #ZakBks object. + * + * Returns: a #GNode. + */ +GNode +*zak_bks_get_tree (ZakBks *bks) +{ + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable != NULL) + { + return zak_bks_pluggable_get_tree (priv->pluggable); + } + else + { + return NULL; + } +} + +/** + * zak_bks_normalize_set_root: + * @bks: a #ZakBks object. + * @root: the root. + * + * Returns: a correct value for root property. + */ +gchar +*zak_bks_normalize_root (const gchar *root) +{ + GString *root_; + gchar *strret; + + if (root == NULL) + { + root_ = g_string_new ("/"); + } + else + { + root_ = g_string_new (root); + g_strstrip (root_->str); + if (g_strcmp0 (root_->str, "") == 0) + { + g_string_printf (root_, "/"); + } + else + { + if (root_->str[0] != '/') + { + g_string_prepend (root_, "/"); + } + if (root_->str[root_->len - 1] != '/') + { + g_string_append (root_, "/"); + } + } + } + + strret = g_strdup (root_->str); + g_string_free (root_, TRUE); + + return strret; +} + +/** + * zak_bks_set_root: + * @bks: a #ZakBks object. + * @root: the root. + * + */ +gboolean +zak_bks_set_root (ZakBks *bks, const gchar *root) +{ + gboolean ret; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ret = FALSE; + } + else + { + g_object_set (priv->pluggable, "root", root, NULL); + ret = TRUE; + } + + return ret; +} + +/** + * zak_bks_set_bksg: + * @bks: a #ZakBks object. + * @name: + * @description: + * + * Returns: + */ +gboolean +zak_bks_set_bksg (ZakBks *bks, + const gchar *name, + const gchar *description) +{ + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + return FALSE; + } + else + { + return zak_bks_pluggable_set_bksg (priv->pluggable, + name, + description); + } +} + +/** + * zak_bks_add_key: + * @bks: a #ZakBks object. + * @parent: the path where add the key. + * @key: the key's name. + * @value: the key's value. + * + * Returns: a #ZakBksgKey struct filled with data from the key just added. + */ +ZakBksKey +*zak_bks_add_key (ZakBks *bks, const gchar *parent, const gchar *key, const gchar *value) +{ + ZakBksKey *ck; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ck = NULL; + } + else + { + ck = zak_bks_pluggable_add_key (priv->pluggable, parent, key, value); + } + + return ck; +} + +/** + * zak_bks_key_set_key: + * @bks: a #ZakBks object. + * @ck: a #ZakBksKey struct. + * + */ +gboolean +zak_bks_key_set_key (ZakBks *bks, + ZakBksKey *ck) +{ + gboolean ret; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ret = FALSE; + } + else + { + ret = zak_bks_pluggable_key_set_key (priv->pluggable, ck); + } + + return ret; +} + +/** + * zak_bks_remove_path: + * @bks: a #ZakBks object. + * @path: the path to remove. + * + * Removes @path and every child key. + */ +gboolean +zak_bks_remove_path (ZakBks *bks, const gchar *path) +{ + gboolean ret; + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ret = FALSE; + } + else + { + ret = zak_bks_pluggable_remove_path (priv->pluggable, path); + } + + return ret; +} + +/** + * zak_bks_path_get_value: + * @bks: a #ZakBks object. + * @path: the path from which retrieving the value. + * + * Returns: the bksguration's value as a string. + */ +gchar +*zak_bks_path_get_value (ZakBks *bks, const gchar *path) +{ + gchar *ret; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ret = NULL; + } + else + { + ret = zak_bks_pluggable_path_get_value (priv->pluggable, path); + } + + return ret; +} + +/** + * zak_bks_path_set_value: + * @bks: a #ZakBks object. + * @path: the key's path. + * @value: the value to set. + * + */ +gboolean +zak_bks_path_set_value (ZakBks *bks, const gchar *path, const gchar *value) +{ + gboolean ret; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ret = FALSE; + } + else + { + ret = zak_bks_pluggable_path_set_value (priv->pluggable, path, value); + } + + return ret; +} + +/** + * zak_bks_path_get_bks_key: + * @bks: a #ZakBks object. + * @path: the key's path to get. + * + * Returns: (transfer full): a #ZakBksKey from @path + */ +ZakBksKey +*zak_bks_path_get_bks_key (ZakBks *bks, const gchar *path) +{ + ZakBksKey *ck; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ck = NULL; + } + else + { + ck = zak_bks_pluggable_path_get_bks_key (priv->pluggable, path); + } + + return ck; +} + +/** + * zak_bks_remove: + * @bks: a #ZakBks object. + * + * Remove a bksguration from databases and destroy the relative object. + */ +gboolean +zak_bks_remove (ZakBks *bks) +{ + gboolean ret; + + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + if (priv->pluggable == NULL) + { + g_warning ("Not initialized."); + ret = FALSE; + } + else + { + ret = zak_bks_pluggable_remove (priv->pluggable); + } + + if (ret) + { + zak_bks_destroy (bks); + } + + return ret; +} + +/** + * zak_bks_destroy: + * @bks: a #ZakBks object. + * + * Destroy the #ZakBks object, freeing memory. + */ +void +zak_bks_destroy (ZakBks *bks) +{ + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + g_free (priv->name); + g_free (priv->description); + g_free (priv->root); + g_object_unref (priv->pluggable); +} + +/** + * zak_bks_path_normalize: + * @pluggable: a #ZakBksPluggable object. + * + * Returns: a normalize path (with root). + */ +gchar +*zak_bks_path_normalize (ZakBksPluggable *pluggable, const gchar *path) +{ + GString *ret; + gchar *strret; + + guint lead; + + gchar *root; + + if (path == NULL) + { + return NULL; + } + + ret = g_string_new (path); + g_strstrip (ret->str); + if (g_strcmp0 (ret->str, "") == 0) + { + return NULL; + } + else if (ret->str[strlen (ret->str) - 1] == '/') + { + return NULL; + } + + /* removing leading '/' */ + lead = 0; + for (lead = 0; lead < ret->len; lead++) + { + if (ret->str[lead] != '/') + { + break; + } + } + + if (lead < ret->len) + { + g_string_erase (ret, 0, lead++); + } + + g_object_get (pluggable, "root", &root, NULL); + g_string_prepend (ret, root); + + strret = g_strdup (ret->str); + g_string_free (ret, TRUE); + + return strret; +} + +/* PRIVATE */ +static void +zak_bks_set_property (GObject *object, guint property_id, const GValue *value, GParamSpec *pspec) +{ + gchar *sql; + + ZakBks *bks = ZAK_BKS (object); + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + switch (property_id) + { + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); + break; + } +} + +static void +zak_bks_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec) +{ + ZakBks *bks = ZAK_BKS (object); + ZakBksPrivate *priv = ZAK_BKS_GET_PRIVATE (bks); + + switch (property_id) + { + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); + break; + } +} diff --git a/src/bkspluggable.c b/src/bkspluggable.c new file mode 100644 index 0000000..d979258 --- /dev/null +++ b/src/bkspluggable.c @@ -0,0 +1,335 @@ +/* + * confipluggable.c + * This file is part of libzakconfi + * + * Copyright (C) 2014-2016 Andrea Zagli + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Library General Public License as published by + * the Free Software Foundation; either version 2 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 Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#ifdef HAVE_CONFIG_H +#include +#endif + +#include "confipluggable.h" + +/** + * SECTION:confipluggable + * @short_description: Interface for pluggable plugins. + * @see_also: #PeasExtensionSet + * + **/ + +G_DEFINE_INTERFACE(ZakConfiPluggable, zak_confi_pluggable, G_TYPE_OBJECT) + +void +zak_confi_pluggable_default_init (ZakConfiPluggableInterface *iface) +{ + static gboolean initialized = FALSE; + + if (!initialized) + { + /** + * ZakConfiPluggable:cnc_string: + * + */ + g_object_interface_install_property (iface, + g_param_spec_string ("cnc_string", + "Connection string", + "Connection string", + "", + G_PARAM_READWRITE)); + + /** + * ZakConfiPluggable:name: + * + */ + g_object_interface_install_property (iface, + g_param_spec_string ("name", + "Configuraton Name", + "The configuration name", + "", + G_PARAM_READABLE)); + + /** + * ZakConfiPluggable:description: + * + */ + g_object_interface_install_property (iface, + g_param_spec_string ("description", + "Configuraton Description", + "The configuration description", + "", + G_PARAM_READABLE)); + + /** + * ZakConfiPluggable:root: + * + */ + g_object_interface_install_property (iface, + g_param_spec_string ("root", + "Configuraton Root", + "The configuration root", + "/", + G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + + initialized = TRUE; + } +} + +/** + * zak_confi_pluggable_initialize: + * @pluggable: A #ZakConfiPluggable. + * @cnc_string: The connection string. + * + * Initialize the backend. + * + * Returns: #TRUE if success. + */ +gboolean +zak_confi_pluggable_initialize (ZakConfiPluggable *pluggable, const gchar *cnc_string) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->initialize != NULL, FALSE); + + return iface->initialize (pluggable, cnc_string); +} + +/** + * zak_confi_pluggable_get_configs_list: + * @pluggable: A #ZakConfiPluggable. + * @filter: (nullable): + * + * Returns: (element-type ZakConfi) (transfer container): a #GList of #ZakConfi. If there's no configurations, returns a valid + * #GList but with a unique NULL element. +*/ +GList +*zak_confi_pluggable_get_configs_list (ZakConfiPluggable *pluggable, const gchar *filter) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->get_configs_list != NULL, FALSE); + + return iface->get_configs_list (pluggable, filter); +} + +/** + * zak_confi_pluggable_path_get_value: + * @pluggable: A #ZakConfiPluggable. + * @path: + * + * Returns: the value of the @path. +*/ +gchar +*zak_confi_pluggable_path_get_value (ZakConfiPluggable *pluggable, const gchar *path) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->path_get_value != NULL, FALSE); + + return iface->path_get_value (pluggable, path); +} + +/** + * zak_confi_pluggable_path_set_value: + * @pluggable: a #ZakConfiPluggable object. + * @path: the key's path. + * @value: the value to set. + * + */ +gboolean +zak_confi_pluggable_path_set_value (ZakConfiPluggable *pluggable, const gchar *path, const gchar *value) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->path_set_value != NULL, FALSE); + + return iface->path_set_value (pluggable, path, value); +} + +/** + * zak_confi_pluggable_get_tree: + * @pluggable: a #ZakConfiPluggable object. + * + * Returns: a #GNode with the entire tree of configurations. + */ +GNode +*zak_confi_pluggable_get_tree (ZakConfiPluggable *pluggable) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->get_tree != NULL, FALSE); + + return iface->get_tree (pluggable); +} + +/** + * zak_confi_pluggable_add_config: + * @pluggable: a #ZakConfiPluggable object. + * @name: the name of the config.. + * @description: the config's description. + * + * Returns: a #ZakConfiConfi struct filled with data from the key just added. + */ +ZakConfiConfi +*zak_confi_pluggable_add_config (ZakConfiPluggable *pluggable, const gchar *name, const gchar *description) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->add_config != NULL, FALSE); + + return iface->add_config (pluggable, name, description); +} + +/** + * zak_confi_pluggable_set_config: + * @pluggable: a #ZakConfiPluggable object. + * @name: the name of the config.. + * @description: the config's description. + * + * Returns: + */ +gboolean +zak_confi_pluggable_set_config (ZakConfiPluggable *pluggable, const gchar *name, const gchar *description) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->set_config != NULL, FALSE); + + return iface->set_config (pluggable, name, description); +} + +/** + * zak_confi_pluggable_add_key: + * @pluggable: a #ZakConfiPluggable object. + * @parent: the path where add the key. + * @key: the key's name. + * @value: the key's value. + * + * Returns: a #ZakConfiKey struct filled with data from the key just added. + */ +ZakConfiKey +*zak_confi_pluggable_add_key (ZakConfiPluggable *pluggable, const gchar *parent, const gchar *key, const gchar *value) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->add_key != NULL, FALSE); + + return iface->add_key (pluggable, parent, key, value); +} + +/** + * zak_confi_pluggable_key_set_key: + * @pluggable: a #ZakConfiPluggable object. + * @ck: a #ZakConfiKey struct. + * + */ +gboolean +zak_confi_pluggable_key_set_key (ZakConfiPluggable *pluggable, + ZakConfiKey *ck) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->key_set_key != NULL, FALSE); + + return iface->key_set_key (pluggable, ck); +} + +/** + * zak_confi_pluggable_path_get_confi_key: + * @pluggable: a #ZakConfiPluggable object. + * @path: the key's path to get. + * + * Returns: (transfer full): a #ZakConfiKey from @path + */ +ZakConfiKey +*zak_confi_pluggable_path_get_confi_key (ZakConfiPluggable *pluggable, const gchar *path) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->path_get_confi_key != NULL, FALSE); + + return iface->path_get_confi_key (pluggable, path); +} + +/** + * zak_confi_pluggable_remove_path: + * @pluggable: a #ZakConfiPluggable object. + * @path: the path to remove. + * + * Removes @path and every child key. + */ +gboolean +zak_confi_pluggable_remove_path (ZakConfiPluggable *pluggable, const gchar *path) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->remove_path != NULL, FALSE); + + return iface->remove_path (pluggable, path); +} + +/** + * zak_confi_pluggable_remove: + * @pluggable: a #ZakConfiPluggable object. + * + * Remove a configuration from databases and destroy the relative object. + */ +gboolean +zak_confi_pluggable_remove (ZakConfiPluggable *pluggable) +{ + ZakConfiPluggableInterface *iface; + + g_return_val_if_fail (ZAK_CONFI_IS_PLUGGABLE (pluggable), FALSE); + + iface = ZAK_CONFI_PLUGGABLE_GET_IFACE (pluggable); + g_return_val_if_fail (iface->remove != NULL, FALSE); + + return iface->remove (pluggable); +} diff --git a/src/bkspluggable.h b/src/bkspluggable.h new file mode 100644 index 0000000..269964c --- /dev/null +++ b/src/bkspluggable.h @@ -0,0 +1,121 @@ +/* + * bkspluggable.h + * This file is part of libzakbookmarks + * + * Copyright (C) 2019 - Andrea Zagli + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Library General Public License as published by + * the Free Software Foundation; either version 2 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 Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#ifndef __ZAK_BOOKMAKRS_PLUGGABLE_H__ +#define __ZAK_BOOKMARKS_PLUGGABLE_H__ + +#include + +#include "commons.h" + +G_BEGIN_DECLS + +/* + * Type checking and casting macros + */ +#define ZAK_BKS_TYPE_PLUGGABLE (zak_bks_pluggable_get_type ()) +#define ZAK_BKS_PLUGGABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ZAK_BKS_TYPE_PLUGGABLE, ZakBksPluggable)) +#define ZAK_BKS_PLUGGABLE_IFACE(obj) (G_TYPE_CHECK_CLASS_CAST ((obj), ZAK_BKS_TYPE_PLUGGABLE, ZakBksPluggableInterface)) +#define ZAK_BKS_IS_PLUGGABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ZAK_BKS_TYPE_PLUGGABLE)) +#define ZAK_BKS_PLUGGABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ZAK_BKS_TYPE_PLUGGABLE, ZakBksPluggableInterface)) + +/** + * ZakBksPluggable: + * + * Interface for pluggable plugins. + */ +typedef struct _ZakBksPluggable ZakBksPluggable; /* dummy typedef */ +typedef struct _ZakBksPluggableInterface ZakBksPluggableInterface; + +/** + * ZakBksPluggableInterface: + * @g_iface: The parent interface. + * @initialize: Construct the plugin. + * + * Provides an interface for pluggable plugins. + */ +struct _ZakBksPluggableInterface { + GTypeInterface g_iface; + + /* Virtual public methods */ + gboolean (*initialize) (ZakBksPluggable *pluggable, const gchar *cnc_string); + GList *(*get_bksgs_list) (ZakBksPluggable *pluggable, + const gchar *filter); + gchar *(*path_get_value) (ZakBksPluggable *pluggable, const gchar *path); + gboolean (*path_set_value) (ZakBksPluggable *pluggable, + const gchar *path, + const gchar *value); + GNode *(*get_tree) (ZakBksPluggable *pluggable); + ZakBksBks *(*add_bksg) (ZakBksPluggable *pluggable, + const gchar *name, + const gchar *description); + gboolean (*set_bksg) (ZakBksPluggable *pluggable, + const gchar *name, + const gchar *description); + ZakBksKey *(*add_key) (ZakBksPluggable *pluggable, + const gchar *parent, + const gchar *key, + const gchar *value); + ZakBksKey *(*path_get_bks_key) (ZakBksPluggable *pluggable, const gchar *path); + gboolean (*remove_path) (ZakBksPluggable *pluggable, + const gchar *path); + gboolean (*remove) (ZakBksPluggable *pluggable); + gboolean (*key_set_key) (ZakBksPluggable *pluggable, + ZakBksKey *ck); +}; + +/* + * Public methods + */ +GType zak_bks_pluggable_get_type (void) G_GNUC_CONST; + +gboolean zak_bks_pluggable_initialize (ZakBksPluggable *pluggable, + const gchar *cnc_string); + +GList *zak_bks_pluggable_get_bksgs_list (ZakBksPluggable *pluggable, + const gchar *filter); +gchar *zak_bks_pluggable_path_get_value (ZakBksPluggable *pluggable, + const gchar *path); +gboolean zak_bks_pluggable_path_set_value (ZakBksPluggable *pluggable, + const gchar *path, + const gchar *value); +GNode *zak_bks_pluggable_get_tree (ZakBksPluggable *pluggable); +ZakBksBks *zak_bks_pluggable_add_bksg (ZakBksPluggable *pluggable, + const gchar *name, + const gchar *description); +gboolean zak_bks_pluggable_set_bksg (ZakBksPluggable *pluggable, + const gchar *name, + const gchar *description); +ZakBksKey *zak_bks_pluggable_add_key (ZakBksPluggable *pluggable, + const gchar *parent, + const gchar *key, + const gchar *value); +gboolean zak_bks_pluggable_key_set_key (ZakBksPluggable *pluggable, + ZakBksKey *ck); +ZakBksKey *zak_bks_pluggable_path_get_bks_key (ZakBksPluggable *pluggable, const gchar *path); +gboolean zak_bks_pluggable_remove_path (ZakBksPluggable *pluggable, const gchar *path); +gboolean zak_bks_pluggable_remove (ZakBksPluggable *pluggable); + + +G_END_DECLS + +#endif /* __ZAK_BOOKMAKRS_PLUGGABLE_H__ */ +< diff --git a/src/commons.c b/src/commons.c new file mode 100644 index 0000000..5a3a147 --- /dev/null +++ b/src/commons.c @@ -0,0 +1,76 @@ +/* + * commons.c + * This file is part of libzakbookmarks + * + * Copyright (C) 2019 Andrea Zagli + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Library General Public License as published by + * the Free Software Foundation; either version 2 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 Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#ifdef HAVE_CONFIG_H +#include +#endif + +#include "commons.h" + +ZakConfiConfi +*zak_confi_confi_copy (ZakConfiConfi *confi) +{ + ZakConfiConfi *b; + + b = g_slice_new (ZakConfiConfi); + b->name = g_strdup (confi->name); + b->description = g_strdup (confi->description); + + return b; +} + +void +zak_confi_confi_free (ZakConfiConfi *confi) +{ + g_free (confi->name); + g_free (confi->description); + g_slice_free (ZakConfiConfi, confi); +} + +G_DEFINE_BOXED_TYPE (ZakConfiConfi, zak_confi_confi, zak_confi_confi_copy, zak_confi_confi_free) + +ZakConfiKey +*zak_confi_key_copy (ZakConfiKey *key) +{ + ZakConfiKey *b; + + b = g_slice_new (ZakConfiKey); + b->config = g_strdup (key->config); + b->path = g_strdup (key->path); + b->key = g_strdup (key->key); + b->value = g_strdup (key->value); + b->description = g_strdup (key->description); + + return b; +} + +void +zak_confi_key_free (ZakConfiKey *key) +{ + g_free (key->config); + g_free (key->path); + g_free (key->key); + g_free (key->value); + g_free (key->description); + g_slice_free (ZakConfiKey, key); +} + +G_DEFINE_BOXED_TYPE (ZakConfiKey, zak_confi_key, zak_confi_key_copy, zak_confi_key_free) diff --git a/src/commons.h b/src/commons.h new file mode 100644 index 0000000..ae2e6d2 --- /dev/null +++ b/src/commons.h @@ -0,0 +1,62 @@ +/* + * Copyright (C) 2019 Andrea Zagli + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +#ifndef __LIBZAKBOOKMARKS_COMMONS_H__ +#define __LIBZAKBOOKMARKS_COMMONS_H__ + +#include + + +G_BEGIN_DECLS + + +#define ZAK_CONFI_TYPE_CONFI (zak_confi_confi_get_type ()) + +GType zak_confi_confi_get_type (); + +typedef struct _ZakConfiConfi ZakConfiConfi; +struct _ZakConfiConfi + { + gchar *name; + gchar *description; + }; + +ZakConfiConfi *zak_confi_confi_copy (ZakConfiConfi *confi); +void zak_confi_confi_free (ZakConfiConfi *confi); + +#define ZAK_CONFI_TYPE_KEY (zak_confi_key_get_type ()) + +GType zak_confi_key_get_type (); + +typedef struct _ZakConfiKey ZakConfiKey; +struct _ZakConfiKey + { + gchar *config; + gchar *path; + gchar *key; + gchar *value; + gchar *description; + }; + +ZakConfiKey *zak_confi_key_copy (ZakConfiKey *key); +void zak_confi_key_free (ZakConfiKey *key); + + +G_END_DECLS + +#endif /* __LIBZAKBOOKMARKS_COMMONS_H__ */ diff --git a/src/libzakbookmarks.h b/src/libzakbookmarks.h new file mode 100644 index 0000000..36b12b4 --- /dev/null +++ b/src/libzakbookmarks.h @@ -0,0 +1,65 @@ +/* + * Copyright (C) 2019 Andrea Zagli + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +#ifndef __LIBZAKBOOKMARKS_H__ +#define __LIBZAKBOOKMARKS_H__ + +#include + +#include + +#include "commons.h" +#include "bkspluggable.h" + + +G_BEGIN_DECLS + + +#define ZAK_TYPE_BKS (zak_bks_get_type ()) +#define ZAK_BKS(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ZAK_TYPE_BKS, ZakBks)) +#define ZAK_BKS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ZAK_TYPE_BKS, ZakBksClass)) +#define ZAK_IS_BKS(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ZAK_TYPE_BKS)) +#define ZAK_IS_BKS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ZAK_TYPE_BKS)) +#define ZAK_BKS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ZAK_TYPE_BKS, ZakBksClass)) + + +typedef struct _ZakBks ZakBks; +typedef struct _ZakBksClass ZakBksClass; + +struct _ZakBks + { + GObject parent; + }; + +struct _ZakBksClass + { + GObjectClass parent_class; + }; + +GType zak_bks_get_type (void); + +ZakBks *zak_bks_new (const gchar *cnc_string); + +PeasPluginInfo *zak_bks_get_plugin_info (ZakBks *bks); + +void zak_bks_destroy (ZakBks *bks); + + +G_END_DECLS + +#endif /* __LIBZAKBOOKMARKS_H__ */