From cf84b279f403c18ed0c3fbf29d806e3255d705bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Lebleu?= Date: Tue, 17 May 2016 14:06:45 +0200 Subject: [PATCH] [fix] Include ldapAliasSync since ynh cannot retrieve submodules --- .gitmodules | 3 - sources/plugins/ldapAliasSync | 1 - sources/plugins/ldapAliasSync/COPYING | 583 ++++++++++++ sources/plugins/ldapAliasSync/README.md | 16 + sources/plugins/ldapAliasSync/composer.json | 14 + .../ldapAliasSync/config-default.inc.php | 248 ++++++ .../plugins/ldapAliasSync/ldapAliasSync.php | 831 ++++++++++++++++++ 7 files changed, 1692 insertions(+), 4 deletions(-) delete mode 100644 .gitmodules delete mode 160000 sources/plugins/ldapAliasSync create mode 100644 sources/plugins/ldapAliasSync/COPYING create mode 100644 sources/plugins/ldapAliasSync/README.md create mode 100644 sources/plugins/ldapAliasSync/composer.json create mode 100644 sources/plugins/ldapAliasSync/config-default.inc.php create mode 100644 sources/plugins/ldapAliasSync/ldapAliasSync.php diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 7596b51..0000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "sources/plugins/ldapAliasSync"] - path = sources/plugins/ldapAliasSync - url = https://github.com/dim-0/ldapAliasSync diff --git a/sources/plugins/ldapAliasSync b/sources/plugins/ldapAliasSync deleted file mode 160000 index addf1e8..0000000 --- a/sources/plugins/ldapAliasSync +++ /dev/null @@ -1 +0,0 @@ -Subproject commit addf1e870166a36e3abc8c2b5305315644a04532 diff --git a/sources/plugins/ldapAliasSync/COPYING b/sources/plugins/ldapAliasSync/COPYING new file mode 100644 index 0000000..52d1b97 --- /dev/null +++ b/sources/plugins/ldapAliasSync/COPYING @@ -0,0 +1,583 @@ + 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 all +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 yourganization, 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 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, aLAR 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/sources/plugins/ldapAliasSync/README.md b/sources/plugins/ldapAliasSync/README.md new file mode 100644 index 0000000..9221c92 --- /dev/null +++ b/sources/plugins/ldapAliasSync/README.md @@ -0,0 +1,16 @@ +ldapAliasSync +============= + +Roundcube Plugin for fetching Identities (name, email, organization, reply, bcc, signature) from LDAP Aliases at login + +Based on the 'Identiteam' Plugin (https://github.com/arodier/Roundcube-Plugins/tree/master/plugins/identiteam) by André Rodier . +Special thanks to Rocco (https://github.com/roccosportal), who made this plugin work :) +Extended features by Dominik George . + +Copyright according to GPLv3 (see COPYING). + +Bugs & Issues: +- Enter bug reports in https://github.com/dim-0/ldapAliasSync/issues + +Basic Installation: +- Copy config-default.inc.php in config.inc.php, and modify the values you need. diff --git a/sources/plugins/ldapAliasSync/composer.json b/sources/plugins/ldapAliasSync/composer.json new file mode 100644 index 0000000..3dd3980 --- /dev/null +++ b/sources/plugins/ldapAliasSync/composer.json @@ -0,0 +1,14 @@ +{ + "name": "dim-0/ldap-alias-sync", + "type": "roundcube-plugin", + "license": "GPLv3", + "repositories": [ + { + "type": "composer", + "url": "https://plugins.roundcube.net" + } + ], + "require": { + "roundcube/plugin-installer": ">=0.1.3" + } +} diff --git a/sources/plugins/ldapAliasSync/config-default.inc.php b/sources/plugins/ldapAliasSync/config-default.inc.php new file mode 100644 index 0000000..279f33d --- /dev/null +++ b/sources/plugins/ldapAliasSync/config-default.inc.php @@ -0,0 +1,248 @@ + array( + # Domain to use for LDAP searches (required, if 'replace_domain' is true) + # If no login name is given (or 'replace_domain' is true), + # the domain part for the LDAP filter is set to this value + # Default: none + #'search_domain' => '', + + # Replace domain part for LDAP searches (optional) + # This parameter can be used in order to override the login domain part with + # the value maintained in 'search_domain' + # Possible values: true, false + # Default: false + #'replace_domain' => false, + + # Dovecot master user separator (optional) + # If you use the dovecot impersonation feature, this separator will be used + # in order to determine the actual login name. + # Set it to the same character if using this feature, otherwise you can also + # leave it empty. + # Default: none + #'dovecot_separator' => '', + ), + + // LDAP parameters + 'ldap' => array( + # LDAP connection scheme (optional) + # Possible values: 'ldap', 'ldaps', 'ldapi' + # Default: 'ldap' + #'scheme' => 'ldap', + + # LDAP server address (optional) + # Default: 'localhost' + #'server' => 'localhost', + + # LDAP server port (optional) + # Default: '389' + #'port' => '389', + + # LDAP Bind DN (requried, if no anonymous read rights are set for the accounts) + # Default: none + #'bind_dn' => '', + + # Bind password (required, if the bind DN needs to authenticate) + # Default: none + #'bind_pw' => '', + ), + + # 'user_search' holds all config variables for the user search + 'user_search' => array( + # LDAP search base (required) + # - Use '%login' as a place holder for the login name + # - Use '%local' as a place holder for the login name local part + # - Use '%domain' as a place holder for the login name domain part (/'search_domain', if not given or replaced) + # - Use '%email' as a place holder for the email address ('%local'@'%domain') + # - Use '%%' as a place holder for '%' + 'base_dn' => 'uid=%local,ou=users,dc=example,dc=com', + + # LDAP search filter (optional) + # This open filter possibility is the heart of the LDAP search. + # - Use '%login' as a place holder for the login name + # - Use '%local' as a place holder for the login name local part + # - Use '%domain' as a place holder for the login name domain part (/'search_domain', if not given or replaced) + # - Use '%email' as a place holder for the email address ('%local'@'%domain') + # - Use '%%' as a place holder for '%' + # Default: '(objectClass=*)' + #'filter' => '(objectClass=*)', + + # LDAP alias derefencing (optional) + # Possible values: never, search, find, always + # Default: 'never' + #'deref' => 'never', + + # How to find the e-mail addresses (required) + # Possible values are: + # - 'attribute' - e-mail address will be taken from the entry's 'attr_mail' attribute + # - 'dn' - e-mail address local part will be taken from the entry's 'attr_local'; + # e-mail address domain part will be taken from the DN's 'attr_dom' attributes + # - 'memberof' - e-mail address local part will be taken form the entry's 'attr_local'; + # e-mail address domain part will be taken from the memberof attributes' 'attr_dom' attributes + # - 'static' - e-mail address local part will be taken form the entry's 'attr_local'; + # e-mail address domain part will be copied from 'domain_static' + 'mail_by' => 'attribute', + + # LDAP e-mail attribute (required, if 'mail_by' is 'attribute') + 'attr_mail' => 'mail', + + # LDAP e-mail local part attribute (required, if 'mail_by' is 'dn', 'memberof' or 'static') + # Default: none + #'attr_local' => '', + + # LDAP e-mail domain part attribute (required, if 'mail_by' is 'dn' or 'memberof') + # Default: none + #'attr_dom' => '', + + # Static domain to append to local parts (required, if 'mail_by' is 'static') + # Default: none + #'domain_static' => '', + + # Users with one of the following domains will be ignored (optional) + # Default: none + #'ignore_domains' => array(), + + # How to handle non-domain attributes in a DN (optional) + # Set to 'stop', if you want to stop the search (e.g. uid=u1,dc=mail,dc=de,ou=dom,dc=example,dc=com --> mail.de) + # Set to 'stop', if you want to skip non-domain attributes (e.g. uid=u1,dc=mail,dc=de,ou=dom,dc=example,dc=com --> mail.de.example.com) + # Possible values: 'stop', 'skip' + # Default: 'stop' + #'non_domain_attr' => 'stop', + + ### The following attributes can be fetched from LDAP in order to provide additional identity information + + # LDAP name attribute (optional) + # Default: none + #'attr_name' => '', + + # LDAP organization attribute (optional) + # Default: none + #'attr_org' => '', + + # LDAP reply-to attribute (optional) + # Default: none + #'attr_reply' => '', + + # LDAP bcc (blind carbon copy) attribute (optional) + # Default: none + #'attr_bcc' => '', + + # LDAP signature attribute (optional) + # Default: none + #'attr_sig' => '', + ), + + # 'alias_search' holds all config variables for the alias search + 'alias_search' => array( + # LDAP search base (required) + # - Use '%login' as a place holder for the login name + # - Use '%local' as a place holder for the login name local part + # - Use '%domain' as a place holder for the login name domain part (/'search_domain', if not given or replaced) + # - Use '%email' as a place holder for the email address ('%local'@'%domain') + # - Use '%dn' as a place holder for the DN returned by the user search + # - Use '%%' as a place holder for '%' + 'base_dn' => 'ou=aliases,dc=example,dc=com', + + # LDAP search filter (optional) + # This open filter possibility is the heart of the LDAP search. + # - Use '%login' as a place holder for the login name + # - Use '%local' as a place holder for the login name local part + # - Use '%domain' as a place holder for the login name domain part (/'search_domain', if not given or replaced) + # - Use '%email' as a place holder for the email address ('%local'@'%domain') + # - Use '%dn' as a place holder for the DN returned by the user search + # - Use '%%' as a place holder for '%' + # Default: '(objectClass=*)' + #'filter' => '(objectClass=*)', + + # LDAP alias derefencing (optional) + # Possible values: never, search, find, always + # Default: 'never' + #'deref' => 'never', + + # How to find the e-mail addresses (required) + # Possible values are: + # - 'attribute' - e-mail address will be taken from the entry's 'attr_mail' attribute + # - 'dn' - e-mail address local part will be taken from the entry's 'attr_local'; + # e-mail address domain part will be taken from the DN's 'attr_dom' attributes + # - 'memberof' - e-mail address local part will be taken form the entry's 'attr_local'; + # e-mail address domain part will be taken from the memberOf attributes' 'attr_dom' attributes + # - 'static' - e-mail address local part will be taken form the entry's 'attr_local'; + # e-mail address domain part will be copied from 'domain_static' + 'mail_by' => 'attribute', + + # LDAP e-mail attribute (required, if 'mail_by' is 'attribute') + 'attr_mail' => 'mail', + + # LDAP e-mail local part attribute (required, if 'mail_by' is 'dn', 'memberof' or 'static') + # Default: none + #'attr_local' => '', + + # LDAP e-mail domain part attribute (required, if 'mail_by' is 'dn' or 'memberof') + # Default: none + #'attr_dom' => '', + + # Static domain to append to local parts (required, if 'mail_by' is 'static') + # Default: none + #'domain_static' => '', + + # Users with one of the following domains will be ignored (optional) + # Default: none + #'ignore_domains' => array(), + + # How to handle non-domain attributes in a DN (optional) + # Set to 'stop', if you want to stop the search (e.g. uid=u1,dc=mail,dc=de,ou=dom,dc=example,dc=com --> mail.de) + # Set to 'skip', if you want to skip non-domain attributes (e.g. uid=u1,dc=mail,dc=de,ou=dom,dc=example,dc=com --> mail.de.example.com) + # Possible values: 'stop', 'skip' + # Default: 'stop' + #'non_domain_attr' => 'stop', + + ### The following attributes can be fetched from LDAP in order to provide additional identity information + + # LDAP name attribute (optional) + # Default: none + #'attr_name' => '', + + # LDAP organization attribute (optional) + # Default: none + #'attr_org' => '', + + # LDAP reply-to attribute (optional) + # Default: none + #'attr_reply' => '', + + # LDAP bcc (blind carbon copy) attribute (optional) + # Default: none + #'attr_bcc' => '', + + # LDAP signature attribute (optional) + # Default: none + #'attr_sig' => '', + ), + + 'general' => array( + # Log level (optional) + # Set the level of log details to be logged by this plugin + # Possible values: 'error', 'warn', 'info', 'debug' + # Default: 'error' + #'log_level' => 'error', + + # Update identity (optional) + # Set to true, if you want update an existing identity with the same e-mail address in the database + # Possible values: true, false + # Default: false + #'update_existing' => false, + + # Update empty fields of the identity (optional) + # Set to true, if you want to also update empty fields of the identity. + # Possible values: true, false + # Default: false + #'update_empty_fields' => false, + ), +); +?> diff --git a/sources/plugins/ldapAliasSync/ldapAliasSync.php b/sources/plugins/ldapAliasSync/ldapAliasSync.php new file mode 100644 index 0000000..6b81144 --- /dev/null +++ b/sources/plugins/ldapAliasSync/ldapAliasSync.php @@ -0,0 +1,831 @@ + + * Author: Lukas Mika + * Licence: GPLv3. (See copying) + */ +class ldapAliasSync extends rcube_plugin { +// ---------- Global variables + // Internal variables + public $task = 'login'; + private $initialised; + private $app; + private $rc_user; + + // Config variables + private $config = array(); + private $cfg_ldap = array(); + private $cfg_mail = array(); + private $cfg_user = array(); + private $cfg_alias = array(); + private $cfg_general = array(); + + // Plugin variables + private $ldap_con; + +// ---------- Main functions + // Plugin initialization + function init() { + try { + $this->log_debug('Initialising...'); + + // Load general roundcube config settings + $this->load_config('config.inc.php'); + $this->app = rcmail::get_instance(); + + // Load plugin config settings + $this->config = $this->app->config->get('ldapAliasSync'); + + $this->cfg_ldap = $this->check_ldap_config($this->config['ldap']); + $this->cfg_mail = $this->check_mail_config($this->config['mail']); + $this->cfg_user = $this->check_user_config($this->config['user_search']); + $this->cfg_alias = $this->check_alias_config($this->config['alias_search']); + $this->cfg_general = $this->check_general_config($this->config['general']); + $this->log_debug('Configuration successfully loaded'); + + // register hook + $this->add_hook('login_after', array($this, 'login_after')); + $this->initialised = true; + $this->log_debug('Plugin Hook \'login_after\' set'); + } catch ( Exception $exc ) { + $this->log_error('Failed to initialise: '.$exc->getMessage()); + } + + if ( $this->initialised ) { + $this->log_info('Plugin initialised'); + } + } + + /** + * login_after + * + * See http://trac.roundcube.net/wiki/Plugin_Hooks + * Arguments: + * - URL parameters (e.g. task, action, etc.) + * Return values: + * - task + * - action + * - more URL parameters + */ + function login_after($args) { + $login = array(); + + try { + $this->rc_user = rcmail::get_instance()->user; + $login = $this->get_login_info($this->rc_user->get_username('mail'), $this->cfg_mail); + $this->log_debug("User information: %login: ".$login['login'].", %local: ".$login['local'].", %domain: ".$login['domain'].", %email: ".$login['email']); + + $this->ldap_con = $this->initialize_ldap($this->cfg_ldap); + $this->log_debug("LDAP connection established"); + + $identities = $this->fetch_identities($login); + $this->log_info("Fetched ".count($identities)." identities"); + + $this->sync_identities_db($identities); + $this->log_info("Identities in DB synchronized"); + } catch ( Exception $exc ) { + $this->log_error('Runtime error: '.$exc->getMessage()); + } + + ldap_close($this->ldap_con); + $this->log_debug("LDAP connection closed"); + + return $args; + } + +// ---------- Helper functions + function initialize_ldap($config) { + $uri = ''; + $con = null; + + $uri = $config['scheme'].'://'.$config['server'].':'.$config['port']; + + $con = ldap_connect($uri); + + if ( is_resource($con) ) { + $this->log_debug("LDAP resource: ".$uri); + ldap_set_option($con, LDAP_OPT_PROTOCOL_VERSION, 3); + } else { + throw new Exception(sprintf("Connection to the server failed: (Error=%s)", ldap_errno($con))); + } + + // Bind to server + if ( $this->cfg_ldap['bind_dn'] ){ + $bound = @ldap_bind($con, $this->cfg_ldap['bind_dn'], $this->cfg_ldap['bind_pw']); + } else { + $bound = @ldap_bind($con); + } + + if ( ! $bound ) { + throw new Exception(sprintf("Bind to server '%s' failed. Con: (%s), Error: (%s)", $this->cfg_ldap['server'], $con, ldap_errno($con))); + } else { + $this->log_debug("LDAP Bind successfull"); + } + + return $con; + } + + function get_login_info($info, $config) { + $login = array(); + + $login['login'] = $info; + + if ( strstr($info, '@') ) { + $login_parts = explode('@', $info); + + $login['local'] = $login_parts[0]; + $login['domain'] = $login_parts[1]; + + if ( $config['replace_domain'] && $config['search_domain'] ) { + $login['domain'] = $config['search_domain']; + } + } else { + $login['local'] = $login; + + if ( $config['search_domain'] ) { + $login['domain'] = $config['search_domain']; + } + } + + if ( $config['dovecot_separator'] && strstr($login['local'], $config['dovecot_separator']) ) { + $login['local'] = array_shift(explode($config['dovecot_separator'], $login['local'])); + } + + if ( $login['local'] && $login['domain'] ) { + $login['email'] = $login['local']."@".$login['domain']; + } + + return $login; + } + + function fetch_identities($login) { + $ldap_users = array(); + $ldap_user = array(); + $aliases = array(); + $alias = array(); + $identities = array(); + + $ldap_users = $this->get_ldap_identities($login, $this->cfg_user, ''); + + if ( count($ldap_users) == 0 ) { + throw new Exception(sprintf("User '%s' not found.", $login['login'])); + } else { + $this->log_debug("Found ".count($ldap_users)." for user ".$login['login']); + } + + foreach ( $ldap_users as $ldap_user ) { + array_push($identities, $ldap_user); + $aliases = $this->get_ldap_identities($login, $this->cfg_alias, $ldap_user['dn']); + $this->log_debug("Found ".count($aliases)." aliases"); + foreach ( $aliases as $alias ) { + array_push($identities, $alias); + } + } + + return $identities; + } + + function get_ldap_identities($login, $config, $dn) { + $base_dn = $config['base_dn']; + $filter = $config['filter']; + $fields = array(); + $bound = false; + $result = null; + $entries = array(); + $identities = array(); + + // Prepare LDAP query base DN + $base_dn = str_replace('%login', $login['login'], $base_dn); + $base_dn = str_replace('%local', $login['local'], $base_dn); + $base_dn = str_replace('%domain', $login['domain'], $base_dn); + $base_dn = str_replace('%email', $login['email'], $base_dn); + $base_dn = str_replace('%dn', $dn, $base_dn); + $base_dn = str_replace('%%', '%', $base_dn); + + // Prepare LDAP query filter + $filter = str_replace('%login', $login['login'], $filter); + $filter = str_replace('%local', $login['local'], $filter); + $filter = str_replace('%domain', $login['domain'], $filter); + $filter = str_replace('%email', $login['email'], $filter); + $filter = str_replace('%dn', $dn, $filter); + $filter = str_replace('%%', '%', $filter); + + // Prepare LDAP query attributes + if ( $config['attr_mail'] ) { + array_push($fields, $config['attr_mail']); + } + if ( $config['attr_local'] ) { + array_push($fields, $config['attr_local']); + } + if ( $config['attr_dom'] ) { + array_push($fields, $config['attr_dom']); + } + if ( $config['attr_name'] ) { + array_push($fields, $config['attr_name']); + } + if ( $config['attr_org'] ) { + array_push($fields, $config['attr_org']); + } + if ( $config['attr_reply'] ) { + array_push($fields, $config['attr_reply']); + } + if ( $config['attr_bcc'] ) { + array_push($fields, $config['attr_bcc']); + } + if ( $config['attr_sig'] ) { + array_push($fields, $config['attr_sig']); + } + if ( $config['mail_by'] == 'memberof' ) { + array_push($fields, 'memberof'); + } + + $this->log_debug("LDAP Query: base DN: ".$base_dn.", filter: ".$filter); + $result = @ldap_search($this->ldap_con, $base_dn, $filter, $fields, 0, 0, 0, $config['deref']); + + if ( $result ) { + $entries = @ldap_get_entries($this->ldap_con, $result); + } else { + $this->log_warning("LDAP Message: ".ldap_errno($this->ldap_con).": ".ldap_error($this->ldap_con)); + } + + $this->log_debug("LDAP Query returned ".$entries['count']." entries."); + for ($i=0; $i<$entries['count']; $i++) { + $entry = null; + $entry = $entries["$i"]; + $ids = $this->get_ids_from_obj($entry, $config); + $this->log_debug(count($ids)." IDs fetched"); + foreach ( $ids as $id ) { + array_push($identities, $id); + } + } + $this->log_debug(count($identities)." IDs fetched in total for this LDAP query"); + return $identities; + } + + function get_ids_from_obj($ldap_id, $config) { + $identity = array(); + $identities = array(); + $entries = array(); + $entry = array(); + $local = ''; + $domain = ''; + $stop = true; + + // Get attributes + $identity['dn'] = $ldap_id['dn']; + + if ( $config['attr_name'] ) { + $ldap_temp = $ldap_id[$config['attr_name']]; + $identity['name'] = $ldap_temp[0]; + } + + if ( $config['attr_org'] ) { + $ldap_temp = $ldap_id[$config['attr_org']]; + $identity['organization'] = $ldap_temp[0]; + } + + if ( $config['attr_reply'] ) { + $ldap_temp = $ldap_id[$config['attr_reply']]; + $identity['reply-to'] = $ldap_temp[0]; + } + + if ( $config['attr_bcc'] ) { + $ldap_temp = $ldap_id[$config['attr_bcc']]; + $identity['bcc'] = $ldap_temp[0]; + } + + if ( $config['attr_sig'] ) { + $ldap_temp = $ldap_id[$config['attr_sig']]; + $identity['signature'] = $ldap_temp[0]; + } + + if ( preg_match('/^\s*<[a-zA-Z]+/', $identity['signature']) ) { + $identity['html_signature'] = 1; + } else { + $identity['html_signature'] = 0; + } + + // Get e-mail address + switch ( $config['mail_by'] ) { + case 'attribute': + $ldap_temp = $ldap_id[$config['attr_mail']]; + foreach ( $ldap_temp as $attr ) { + if ( strstr($attr, '@') ) { + $domain_expl = explode('@', $attr); + $domain = $domain_expl[1]; + if ( $domain && ! in_array( $domain, $config['ignore_domains']) ) { + $identity['email'] = $attr; + if ( ! $identity['name'] ) { + $identity_expl = explode('@', $attr); + $identity['name'] = $identity_expl[0]; + } + array_push($identities, $identity); + $this->log_debug("Found address ".$identity['email']); + } + } + } + break; + case 'dn': + $ldap_temp = $ldap_id[$config['attr_local']]; + $local = $ldap_temp[0]; + if ( $config['non_domain_attr'] == 'skip' ) { + $stop = false; + } else { + $stop = true; + } + $domain = $this->get_domain_name($ldap_id['dn'], $config['attr_dom'], $stop); + if ( $local && $domain && ! in_array($domain, $config['ignore_domains']) ) { + $identity['email'] = $local.'@'.$domain; + if ( ! $identity['name'] ) { + $identity['name'] = $local; + } + array_push($identities, $identity); + $this->log_debug("Found address ".$identity['email']); + } + break; + case 'memberof': + $ldap_temp = $ldap_id[$config['attr_local']]; + $local = $ldap_temp[0]; + if ( $config['non_domain_attr'] == 'skip' ) { + $stop = false; + } else { + $stop = true; + } + $ldap_temp = $ldap_id['memberof']; + foreach ( $ldap_temp as $memberof ) { + $domain = $this->get_domain_name($memberof, $config['attr_dom'], $stop); + if ( $local && $domain && ! in_array($domain, $config['ignore_domains']) ) { + $identity['email'] = $local.'@'.$domain; + if ( ! $identity['name'] ) { + $identity['name'] = $local; + } + array_push($identities, $identity); + $this->log_debug("Found address ".$identity['email']); + } + } + break; + case 'static': + $ldap_temp = $ldap_id[$config['attr_local']]; + $local = $ldap_temp[0]; + if ( $local && $config['domain_static'] && ! in_array($config['domain_static'], $config['ignore_domains']) ) { + $identity['email'] = $local.'@'.$config['domain_static']; + if ( ! $identity['name'] ) { + $identity['name'] = $local; + } + array_push($identities, $identity); + $this->log_debug("Found address ".$identity['email']); + } + break; + } + return $identities; + } + + function get_domain_name( $dn, $attr, $stop = true ) { + $found = false; + $domain = ''; + + $dn_parts = explode(',', $dn); + + foreach( $dn_parts as $dn_part ) { + $objs = explode('=', $dn_part); + if ($objs[0] == $attr) { + $found = true; + if ( strlen( $domain ) == 0 ) { + $domain = $objs[1]; + } else { + $domain .= ".".$objs[1]; + } + } elseif ( $found == true && $stop == true ) { + break; + } + } + return $domain; + } + + function sync_identities_db($identities) { + $db_identities = array(); + $db_identity = array(); + $identity = array(); + $key = ''; + $value = ''; + $in_db = false; + $in_ldap = false; + + if ( count($identities) > 0 && $db_identities = $this->rc_user->list_identities() ) { + + # Check which identities not yet contained in the database + foreach ( $identities as $identity ) { + $in_db = false; + unset($identity['dn']); + + foreach ( $db_identities as $db_identity ) { + # email is our only comparison parameter + if( $db_identity['email'] == $identity['email'] ) { + if ( $this->cfg_general['update_existing'] ) { + if ( ! $this->cfg_general['update_empty_fields']) { + foreach ($identity as $key => $value) { + if ( empty($identity[$key]) ) { + unset($identity[$key]); + } + } + } + $this->rc_user->update_identity ( $db_identity['identity_id'], $identity ); + $this->log_info("Updated identity ".$identity['email']); + } + $in_db = true; + break; + } + } + + if( !$in_db ) { + $this->rc_user->insert_identity( $identity ); + $this->log_info("Inserted identity ".$identity['email']); + } + } + + # Check which identities are available in database but nut in LDAP and delete those + foreach ( $db_identities as $db_identity ) { + $in_ldap = false; + + foreach ( $identities as $identity ) { + # email is our only comparison parameter + if( $db_identity['email'] == $identity['email'] ) { + $in_ldap = true; + break; + } + } + + # If this identity does not exist in LDAP, delete it from database + if( !$in_ldap ) { + $this->rc_user->delete_identity($db_identity['identity_id']); + $this->log_warning("Deleted identity ".$db_identity['email']); + } + } + } + } + + function log_error($msg) { + write_log('ldapAliasSync', "ERROR: ".$msg); + } + + function log_warning($msg) { + if ( $this->cfg_general['log_level'] >= 1 ) { + write_log('ldapAliasSync', "WARNING: ".$msg); + } + } + + function log_info($msg) { + if ( $this->cfg_general['log_level'] >= 2 ) { + write_log('ldapAliasSync', "INFO: ".$msg); + } + } + + function log_debug($msg) { + if ( $this->cfg_general['log_level'] >= 3 ) { + write_log('ldapAliasSync', "DEBUG: ".$msg); + } + } + +// ---------- Configuration functions + function check_ldap_config($config) { + $SCHEMES = array('ldap', 'ldaps', 'ldapi'); + + // Set default values for empty config parameters + if (! $config['scheme']) { + $config['scheme'] = 'ldap'; + } + if (! $config['server']) { + $config['server'] = 'localhost'; + } + if (! $config['port']) { + $config['port'] = '389'; + } + if (! $config['bind_dn']) { + $config['bind_dn'] = ''; + } + if (! $config['bind_pw']) { + $config['bind_pw'] = ''; + } + + // Check parameters with fixed value set + if (! in_array($config['scheme'], $SCHEMES)) { + throw new Exception('[ldap] scheme "'.$config['scheme'].'" is invalid'); + } + + return $config; + } + + function check_mail_config($config) { + // Set default values for empty config parameters + if (! $config['search_domain']) { + $config['search_domain'] = ''; + } + if (! $config['replace_domain']) { + $config['replace_domain'] = false; + } + if (! $config['dovecot_separator']) { + $config['dovecot_separator'] = ''; + } + + // Check parameter combinations + if ($config['replace_domain'] && ! $config['search_domain']) { + throw new Exception('[mail] search_domain must not be initial, if replace_domain is set to "true"!'); + } + + return $config; + } + + function check_user_config($config) { + $DEREFS = array($LDAP_DEREF_NEVER, $LDAP_DEREF_FINDING, $LDAP_DEREF_SEARCHING, $LDAP_DEREF_ALWAYS); + $MAIL_BYS = array('attribute', 'dn', 'memberof', 'static'); + $NDATTRS = array('stop', 'skip'); + + // Set default values for empty config parameters + if (! $config['base_dn']) { + $config['base_dn'] = ''; + } + if (! $config['filter']) { + $config['filter'] = '(objectClass=*)'; + } + if (! $config['deref']) { + $config['deref'] = 'never'; + } + if (! $config['mail_by']) { + $config['mail_by'] = 'attribute'; + } + if (! $config['attr_mail']) { + $config['attr_mail'] = 'mail'; + } else { + $config['attr_mail'] = strtolower($config['attr_mail']); + } + if (! $config['attr_local']) { + $config['attr_local'] = ''; + } else { + $config['attr_local'] = strtolower($config['attr_local']); + } + if (! $config['attr_dom']) { + $config['attr_dom'] = ''; + } else { + $config['attr_dom'] = strtolower($config['attr_dom']); + } + if (! $config['domain_static']) { + $config['domain_static'] = ''; + } + if (! $config['ignore_domains']) { + $config['ignore_domains'] = array(); + } + if (! $config['non_domain_attr']) { + $config['non_domain_attr'] = 'stop'; + } + if (! $config['attr_name']) { + $config['attr_name'] = ''; + } else { + $config['attr_name'] = strtolower($config['attr_name']); + } + if (! $config['attr_org']) { + $config['attr_org'] = ''; + } else { + $config['attr_org'] = strtolower($config['attr_org']); + } + if (! $config['attr_reply']) { + $config['attr_reply'] = ''; + } else { + $config['attr_reply'] = strtolower($config['attr_reply']); + } + if (! $config['attr_bcc']) { + $config['attr_bcc'] = ''; + } else { + $config['attr_bcc'] = strtolower($config['attr_bcc']); + } + if (! $config['attr_sig']) { + $config['attr_sig'] = ''; + } else { + $config['attr_sig'] = strtolower($config['attr_sig']); + } + + // Override values + switch ( $config['deref'] ) { + case 'never': + $config['deref'] = $LDAP_DEREF_NEVER; + break; + case 'search': + $config['deref'] = $LDAP_DEREF_SEARCHING; + break; + case 'find': + $config['deref'] = $LDAP_DEREF_FINDING; + break; + case 'always': + $config['deref'] = $LDAP_DEREF_ALWAYS; + break; + } + + // Check on empty parameters + if (! $config['base_dn']) { + throw new Exception('[user_search] base_dn must not be initial!'); + } + + // Check parameters with fixed value set + if (! in_array($config['deref'], $DEREFS)) { + throw new Exception('[user_search] deref "'.$config['deref'].'" is invalid'); + } + if (! in_array($config['mail_by'], $MAIL_BYS)) { + throw new Exception('[user_search] mail_by "'.$config['mail_by'].'" is invalid'); + } + if (! in_array($config['non_domain_attr'], $NDATTRS)) { + throw new Exception('[user_search] non_domain_attr "'.$config['non_domain_attr'].'" is invalid'); + } + + // Check parameter combinations + if ($config['mail_by'] == 'attribute' && ! $config['attr_mail']) { + throw new Exception('[user_search] attr_mail must not be initial, if mail_by is set to "attribute"!'); + } + if ($config['mail_by'] == 'dn' && ! $config['attr_local']) { + throw new Exception('[user_search] attr_local must not be initial, if mail_by is set to "dn"!'); + } + if ($config['mail_by'] == 'dn' && ! $config['attr_dom']) { + throw new Exception('[user_search] attr_dom must not be initial, if mail_by is set to "dn"!'); + } + if ($config['mail_by'] == 'memberof' && ! $config['attr_local']) { + throw new Exception('[user_search] attr_local must not be initial, if mail_by is set to "memberof"!'); + } + if ($config['mail_by'] == 'memberof' && ! $config['attr_dom']) { + throw new Exception('[user_search] attr_dom must not be initial, if mail_by is set to "memberof"!'); + } + if ($config['mail_by'] == 'static' && ! $config['attr_local']) { + throw new Exception('[user_search] attr_local must not be initial, if mail_by is set to "static"!'); + } + if ($config['mail_by'] == 'static' && ! $config['domain_static']) { + throw new Exception('[user_search] domain_static must not be initial, if mail_by is set to "static"!'); + } + + return $config; + } + + function check_alias_config($config) { + $DEREFS = array($LDAP_DEREF_NEVER, $LDAP_DEREF_SEARCHING, $LDAP_DEREF_FINDING, $LDAP_DEREF_ALWAYS); + $MAIL_BYS = array('attribute', 'dn', 'memberof', 'static'); + $NDATTRS = array('stop', 'skip'); + + // Set default values for empty config parameters + if (! $config['base_dn']) { + $config['base_dn'] = ''; + } + if (! $config['filter']) { + $config['filter'] = '(objectClass=*)'; + } + if (! $config['deref']) { + $config['deref'] = 'never'; + } + if (! $config['mail_by']) { + $config['mail_by'] = 'attribute'; + } + if (! $config['attr_mail']) { + $config['attr_mail'] = 'mail'; + } else { + $config['attr_mail'] = strtolower($config['attr_mail']); + } + if (! $config['attr_local']) { + $config['attr_local'] = ''; + } else { + $config['attr_local'] = strtolower($config['attr_local']); + } + if (! $config['attr_dom']) { + $config['attr_dom'] = ''; + } else { + $config['attr_dom'] = strtolower($config['attr_dom']); + } + if (! $config['domain_static']) { + $config['domain_static'] = ''; + } + if (! $config['ignore_domains']) { + $config['ignore_domains'] = array(); + } + if (! $config['non_domain_attr']) { + $config['non_domain_attr'] = 'stop'; + } + if (! $config['attr_name']) { + $config['attr_name'] = ''; + } else { + $config['attr_name'] = strtolower($config['attr_name']); + } + if (! $config['attr_org']) { + $config['attr_org'] = ''; + } else { + $config['attr_org'] = strtolower($config['attr_org']); + } + if (! $config['attr_reply']) { + $config['attr_reply'] = ''; + } else { + $config['attr_reply'] = strtolower($config['attr_reply']); + } + if (! $config['attr_bcc']) { + $config['attr_bcc'] = ''; + } else { + $config['attr_bcc'] = strtolower($config['attr_bcc']); + } + if (! $config['attr_sig']) { + $config['attr_sig'] = ''; + } else { + $config['attr_sig'] = strtolower($config['attr_sig']); + } + + // Override values + switch ( $config['deref'] ) { + case 'never': + $config['deref'] = $LDAP_DEREF_NEVER; + break; + case 'search': + $config['deref'] = $LDAP_DEREF_SEARCHING; + break; + case 'find': + $config['deref'] = $LDAP_DEREF_FINDING; + break; + case 'always': + $config['deref'] = $LDAP_DEREF_ALWAYS; + break; + } + + // Check on empty parameters + if (! $config['base_dn']) { + throw new Exception('[alias_search] base_dn must not be initial!'); + } + + // Check parameters with fixed value set + if (! in_array($config['deref'], $DEREFS)) { + throw new Exception('[alias_search] deref "'.$config['deref'].'" is invalid'); + } + if (! in_array($config['mail_by'], $MAIL_BYS)) { + throw new Exception('[alias_search] mail_by "'.$config['mail_by'].'" is invalid'); + } + if (! in_array($config['non_domain_attr'], $NDATTRS)) { + throw new Exception('[alias_search] non_domain_attr "'.$config['non_domain_attr'].'" is invalid'); + } + + // Check parameter combinations + if ($config['mail_by'] == 'attribute' && ! $config['attr_mail']) { + throw new Exception('[alias_search] attr_mail must not be initial, if mail_by is set to "attribute"!'); + } + if ($config['mail_by'] == 'dn' && ! $config['attr_local']) { + throw new Exception('[alias_search] attr_local must not be initial, if mail_by is set to "dn"!'); + } + if ($config['mail_by'] == 'dn' && ! $config['attr_dom']) { + throw new Exception('[alias_search] attr_dom must not be initial, if mail_by is set to "dn"!'); + } + if ($config['mail_by'] == 'memberof' && ! $config['attr_local']) { + throw new Exception('[alias_search] attr_local must not be initial, if mail_by is set to "memberof"!'); + } + if ($config['mail_by'] == 'memberof' && ! $config['attr_dom']) { + throw new Exception('[alias_search] attr_dom must not be initial, if mail_by is set to "memberof"!'); + } + if ($config['mail_by'] == 'static' && ! $config['attr_local']) { + throw new Exception('[alias_search] attr_local must not be initial, if mail_by is set to "static"!'); + } + if ($config['mail_by'] == 'static' && ! $config['domain_static']) { + throw new Exception('[alias_search] domain_static must not be initial, if mail_by is set to "static"!'); + } + + return $config; + } + + function check_general_config($config) { + $LOG_LEVELS = array(3, 2, 1, 0); + + // Set default values for empty parameters + if (! $config['log_level']) { + $config['log_level'] = 'error'; + } + if (! $config['update_existing']) { + $config['update_existing'] = false; + } + if (! $config['update_empty_fields']) { + $config['update_empty_fields'] = false; + } + + // Override values + switch ( $config['log_level'] ) { + case 'debug': + $config['log_level'] = 3; + break; + case 'info': + $config['log_level'] = 2; + break; + case 'warning': + $config['log_level'] = 1; + break; + case 'error': + $config['log_level'] = 0; + break; + } + + // Check parameters with fixed value set + if (! in_array($config['log_level'], $LOG_LEVELS)) { + throw new Exception('[general] log_level "'.$config['log_level'].'" is invalid'); + } + + return $config; + } +} +?>