diff options
| -rw-r--r-- | COPYING | 661 | ||||
| -rw-r--r-- | actions/groups/edit.php | 247 | ||||
| -rw-r--r-- | activate.php | 30 | ||||
| -rw-r--r-- | languages/ca.php | 39 | ||||
| -rw-r--r-- | languages/en.php | 42 | ||||
| -rw-r--r-- | languages/es.php | 37 | ||||
| -rw-r--r-- | languages/fr.php | 39 | ||||
| -rw-r--r-- | lib/group_alias.php | 84 | ||||
| -rw-r--r-- | manifest.xml | 38 | ||||
| -rw-r--r-- | start.php | 188 | ||||
| -rw-r--r-- | tests/group_alias_test.php | 99 | ||||
| -rw-r--r-- | upgrade.php | 37 | ||||
| -rw-r--r-- | upgrades/2012100501.php | 117 | ||||
| -rw-r--r-- | views/default/group_alias/js.php | 36 | ||||
| -rw-r--r-- | views/default/input/group_alias.php | 31 | ||||
| -rw-r--r-- | views/default/output/group_alias.php | 46 | ||||
| -rw-r--r-- | views/default/plugins/group_alias/settings.php | 46 |
17 files changed, 1817 insertions, 0 deletions
diff --git a/COPYING b/COPYING new file mode 100644 index 000000000..dba13ed2d --- /dev/null +++ b/COPYING @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +<http://www.gnu.org/licenses/>. diff --git a/actions/groups/edit.php b/actions/groups/edit.php new file mode 100644 index 000000000..8588cf3ed --- /dev/null +++ b/actions/groups/edit.php @@ -0,0 +1,247 @@ +<?php +/** + * Elgg groups plugin edit action. + * + * @package ElggGroups + */ + +// Load configuration +global $CONFIG; + +elgg_make_sticky_form('groups'); + +$group_guid = (int)get_input('group_guid'); +$new_group_flag = ($group_guid == 0); + +if ($new_group_flag && elgg_get_plugin_setting('limited_groups', 'groups') == 'yes' + && !elgg_is_admin_logged_in()) { + + register_error(elgg_echo("groups:cantcreate")); + forward(REFERER); +} + +$sticky_alias = ('no' == elgg_get_plugin_setting('changeable_group_alias', 'group_alias')); + +/** + * wrapper for recursive array walk decoding + */ +function profile_array_decoder(&$v) { + $v = html_entity_decode($v, ENT_COMPAT, 'UTF-8'); +} + +// Get group fields +$input = array(); +foreach ($CONFIG->group as $shortname => $valuetype) { + // another work around for Elgg's encoding problems: #561, #1963 + $input[$shortname] = get_input($shortname); + if (is_array($input[$shortname])) { + array_walk_recursive($input[$shortname], 'profile_array_decoder'); + } else { + $input[$shortname] = html_entity_decode($input[$shortname], ENT_COMPAT, 'UTF-8'); + } + + if ($valuetype == 'tags') { + $input[$shortname] = string_to_tag_array($input[$shortname]); + } + + if ($shortname == 'alias' && ($new_group_flag || !$sticky_alias)) { + elgg_load_library('elgg:group_alias'); + try { + group_alias_validate($input['alias']); + $existing_group = get_group_from_group_alias($input['alias']); + if ($existing_group && $existing_group->guid != get_input('group_guid')) { + throw new Exception(elgg_echo('groups:alias:already_taken')); + } + } catch(Exception $e) { + register_error($e->getMessage()); + forward(REFERER); + } + } + +} + +$input['name'] = get_input('name'); +$input['name'] = html_entity_decode($input['name'], ENT_COMPAT, 'UTF-8'); + +$user = elgg_get_logged_in_user_entity(); + +$group = new ElggGroup($group_guid); // load if present, if not create a new group +if (($group_guid) && (!$group->canEdit())) { + register_error(elgg_echo("groups:cantedit")); + + forward(REFERER); +} + +// Keep existing alias unless explicit update +if ($input['alias'] == $group->alias || (!$new_group_flag && $sticky_alias)) { + unset($input['alias']); +} + +// Assume we can edit or this is a new group +if (sizeof($input) > 0) { + foreach($input as $shortname => $value) { + $group->$shortname = $value; + } +} + +// Validate create +if (!$group->name) { + register_error(elgg_echo("groups:notitle")); + + forward(REFERER); +} + + +// Set group tool options +if (isset($CONFIG->group_tool_options)) { + foreach ($CONFIG->group_tool_options as $group_option) { + $group_option_toggle_name = $group_option->name . "_enable"; + if ($group_option->default_on) { + $group_option_default_value = 'yes'; + } else { + $group_option_default_value = 'no'; + } + $group->$group_option_toggle_name = get_input($group_option_toggle_name, $group_option_default_value); + } +} + +// Group membership - should these be treated with same constants as access permissions? +switch (get_input('membership')) { + case ACCESS_PUBLIC: + $group->membership = ACCESS_PUBLIC; + break; + default: + $group->membership = ACCESS_PRIVATE; +} + +if ($new_group_flag) { + $group->access_id = ACCESS_PUBLIC; +} + +$owner_guid = (int) get_input('owner_guid'); +$loggedin_guid = elgg_get_logged_in_user_guid(); +$is_admin = elgg_is_admin_logged_in(); + +if (!$new_group_flag && $owner_guid && $owner_guid != $group->owner_guid) { + if($group->isMember($owner_guid) && ($group->owner_guid == $loggedin_guid || $is_admin)) { + $old_owner_guid = $group->owner_guid; + $group->owner_guid = $owner_guid; + + // @todo Remove this when #4683 fixed + $owner_changed_flag = true; + $old_icontime = $group->icontime; + } +} + +$group->save(); + +// group saved so clear sticky form +elgg_clear_sticky_form('groups'); + +// Invisible group support +// @todo this requires save to be called to create the acl for the group. This +// is an odd requirement and should be removed. Either the acl creation happens +// in the action or the visibility moves to a plugin hook +if (elgg_get_plugin_setting('hidden_groups', 'groups') == 'yes') { + $visibility = (int)get_input('vis', '', false); + if ($visibility != ACCESS_PUBLIC && $visibility != ACCESS_LOGGED_IN) { + $visibility = $group->group_acl; + } + + if ($group->access_id != $visibility) { + $group->access_id = $visibility; + } +} + +$group->save(); + +// group creator needs to be member of new group and river entry created +if ($new_group_flag) { + elgg_set_page_owner_guid($group->guid); + $group->join($user); + add_to_river('river/group/create', 'create', $user->guid, $group->guid, $group->access_id); +} + +// Now see if we have a file icon +if ((isset($_FILES['icon'])) && (substr_count($_FILES['icon']['type'],'image/'))) { + + $icon_sizes = elgg_get_config('icon_sizes'); + + $prefix = "groups/" . $group->guid; + + $filehandler = new ElggFile(); + $filehandler->owner_guid = $group->owner_guid; + $filehandler->setFilename($prefix . ".jpg"); + $filehandler->open("write"); + $filehandler->write(get_uploaded_file('icon')); + $filehandler->close(); + + $thumbtiny = get_resized_image_from_existing_file($filehandler->getFilenameOnFilestore(), $icon_sizes['tiny']['w'], $icon_sizes['tiny']['h'], $icon_sizes['tiny']['square']); + $thumbsmall = get_resized_image_from_existing_file($filehandler->getFilenameOnFilestore(), $icon_sizes['small']['w'], $icon_sizes['small']['h'], $icon_sizes['small']['square']); + $thumbmedium = get_resized_image_from_existing_file($filehandler->getFilenameOnFilestore(), $icon_sizes['medium']['w'], $icon_sizes['medium']['h'], $icon_sizes['medium']['square']); + $thumblarge = get_resized_image_from_existing_file($filehandler->getFilenameOnFilestore(), $icon_sizes['large']['w'], $icon_sizes['large']['h'], $icon_sizes['large']['square']); + if ($thumbtiny) { + + $thumb = new ElggFile(); + $thumb->owner_guid = $group->owner_guid; + $thumb->setMimeType('image/jpeg'); + + $thumb->setFilename($prefix."tiny.jpg"); + $thumb->open("write"); + $thumb->write($thumbtiny); + $thumb->close(); + + $thumb->setFilename($prefix."small.jpg"); + $thumb->open("write"); + $thumb->write($thumbsmall); + $thumb->close(); + + $thumb->setFilename($prefix."medium.jpg"); + $thumb->open("write"); + $thumb->write($thumbmedium); + $thumb->close(); + + $thumb->setFilename($prefix."large.jpg"); + $thumb->open("write"); + $thumb->write($thumblarge); + $thumb->close(); + + $group->icontime = time(); + } + + if ($owner_changed_flag && $old_icontime) { // @todo Remove this when #4683 fixed + + $filehandler = new ElggFile(); + $filehandler->setFilename('groups'); + + $filehandler->owner_guid = $old_owner_guid; + $old_path = $filehandler->getFilenameOnFilestore(); + + $sizes = array('', 'tiny', 'small', 'medium', 'large'); + + foreach($sizes as $size) { + unlink("$old_path/{$group_guid}{$size}.jpg"); + } + } + +} elseif ($owner_changed_flag && $old_icontime) { // @todo Remove this when #4683 fixed + + $filehandler = new ElggFile(); + $filehandler->setFilename('groups'); + + $filehandler->owner_guid = $old_owner_guid; + $old_path = $filehandler->getFilenameOnFilestore(); + + $filehandler->owner_guid = $group->owner_guid; + $new_path = $filehandler->getFilenameOnFilestore(); + + $sizes = array('', 'tiny', 'small', 'medium', 'large'); + + foreach ($sizes as $size) { + rename("$old_path/{$group_guid}{$size}.jpg", "$new_path/{$group_guid}{$size}.jpg"); + } +} + +system_message(elgg_echo("groups:saved")); + +forward($group->getUrl()); diff --git a/activate.php b/activate.php new file mode 100644 index 000000000..630e0362a --- /dev/null +++ b/activate.php @@ -0,0 +1,30 @@ +<?php +/** + * Group Alias activation script + * It sets an alias if group hasn't. + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +foreach(elgg_get_entities(array('type' => 'group')) as $group){ + group_alias_update_from_name($group); +} diff --git a/languages/ca.php b/languages/ca.php new file mode 100644 index 000000000..7639f654b --- /dev/null +++ b/languages/ca.php @@ -0,0 +1,39 @@ +<?php +/** + * GroupAlias -- Translation strings for Catalan + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +$language = array ( + 'groups:alias' => 'Àlies del grup', + 'groups:alias:already_taken' => 'Aquest àlies de grup ja apunta a un altre grup', + 'groups:alias:registration:usernametooshort' => "L'àlies del grup ha de tenir menys de %u caràcters.", + 'groups:alias:registration:usernametoolong' => "L'àlies del grup és massa llarg. Com a màxim pot tenir %u caràcters.", + 'groups:alias:registration:invalidchars' => "Perdona, l'àlies del grup conté el caràcter %s que és invàlid. Els caràcters sigüents són invàlids: %s", + 'groups:alias:registration:invalidctrlchars' => "Perdona, l'àlies del grup conté caràcteres de control, o invisibles.", + 'groups:alias:changeable' => "Permetre canviar l'àlies d'un grup?", + 'groups:alias:changeable:may_break_urls' => "Atenció: això pot portar a URL trencats quan l'àlies està ben establert.", + +); + +add_translation('ca', $language); diff --git a/languages/en.php b/languages/en.php new file mode 100644 index 000000000..4045566e8 --- /dev/null +++ b/languages/en.php @@ -0,0 +1,42 @@ +<?php +/** + * GroupAlias -- Translation strings for English + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +$language = array( + + /** + * Menu items and titles + */ + 'groups:alias' => "Group alias", + 'groups:alias:already_taken' => "This group alias is already pointing to another group", + 'groups:alias:registration:usernametooshort' => 'Group alias must be a minimum of %u characters long.', + 'groups:alias:registration:usernametoolong' => "Group alias is too long. It can have a maximum of %u characters.", + 'groups:alias:registration:invalidchars' => "Sorry, your group alias contains the character %s which is invalid. The following characters are invalid: %s", + 'groups:alias:registration:invalidctrlchars' => "Sorry, your group alias contains control or non-printable characters.", + 'groups:alias:changeable' => "Allow changing a group's alias?", + 'groups:alias:changeable:may_break_urls' => 'Warning: this can lead to broken URLs when the alias is well-established.', +); + +add_translation('en', $language); diff --git a/languages/es.php b/languages/es.php new file mode 100644 index 000000000..bf29223e4 --- /dev/null +++ b/languages/es.php @@ -0,0 +1,37 @@ +<?php +/** + * GroupAlias -- Translation strings for Spanish + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ +$language = array ( + 'groups:alias' => 'Alias del grupo', + 'groups:alias:already_taken' => 'El alias del grupo ya está cogido', + 'groups:alias:registration:usernametooshort' => 'El alias del grupo debe tener menos de %u carácteres.', + 'groups:alias:registration:usernametoolong' => "El alias del grupo es demasiado largo. Como máximo puede tener %u carácteres.", + 'groups:alias:registration:invalidchars' => "Perdona, el alias del grupo contiene el carácter %s que es inválido. Los carácteres siguientes son inválidos: %s", + 'groups:alias:registration:invalidctrlchars' => "Perdona, el alias del grupo contiene carácteres de control, o invisibles.", + 'groups:alias:changeable' => "Permitir cambiar el alias de un grupo", + 'groups:alias:changeable:may_break_urls' => 'Advertencia: esto puede llevar a URLs rotos cuando el alias está bien establecido.', +); + +add_translation('es', $language); diff --git a/languages/fr.php b/languages/fr.php new file mode 100644 index 000000000..54c3f837a --- /dev/null +++ b/languages/fr.php @@ -0,0 +1,39 @@ +<?php +/** + * GroupAlias -- Translation strings for French + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +$language = array ( + 'groups:alias' => 'Alias du groupe', + 'groups:alias:already_taken' => 'Cet alias est déjà utilisé par un autre groupe', + 'groups:alias:registration:usernametooshort' => "L'alias du groupe doit compter au-moins %u caractères.", + 'groups:alias:registration:usernametoolong' => "L'alias du groupe est trop long. Il ne doit pas dépasser %u caractères.", + 'groups:alias:registration:invalidchars' => "Pardon, l'alias du groupe contient le caractère %s qui est invalide. Les caractères suivants sont invalides : %s", + 'groups:alias:registration:invalidctrlchars' => "Pardon, l'alias du groupe contient des caractères de contrôle ou invisibles.", + 'groups:alias:changeable' => "Permettre le changement de l'alias d'un groupe ?", + 'groups:alias:changeable:may_break_urls' => "Attention : cela peut conduire à des URLs invalides lorsque l'alias d'un groupe est déjà bien établi.", + +); + +add_translation('fr', $language); diff --git a/lib/group_alias.php b/lib/group_alias.php new file mode 100644 index 000000000..eb421e49e --- /dev/null +++ b/lib/group_alias.php @@ -0,0 +1,84 @@ +<?php +/** + * GroupAlias -- Shared Library + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +/** + * Simple function which ensures that a group alias contains only valid characters. + * + * This should only permit chars that are valid on the file system as well. + * + * @param string $alias Group alias + * + * @return bool + * @throws RegistrationException on invalid + */ +function group_alias_validate($alias) { + + // Basic, check length + $min_length = elgg_get_config('minusername', 4); + if (strlen($alias) < $min_length) { + $msg = elgg_echo('groups:alias:registration:usernametooshort', array($min_length)); + throw new RegistrationException($msg); + } + + // username in the database has a limit of 128 characters + if (strlen($alias) > 128) { + $msg = elgg_echo('groups:alias:registration:usernametoolong', array(128)); + throw new RegistrationException($msg); + } + + // Blacklist for bad characters (partially nicked from mediawiki) + $blacklist = '/[' . + '\x{0080}-\x{009f}' . // iso-8859-1 control chars + '\x{00a0}' . // non-breaking space + '\x{2000}-\x{200f}' . // various whitespace + '\x{2028}-\x{202f}' . // breaks and control chars + '\x{3000}' . // ideographic space + '\x{e000}-\x{f8ff}' . // private use + ']/u'; + + if ( + preg_match($blacklist, $alias) + ) { + throw new RegistrationException(elgg_echo('groups:alias:registration:invalidctrlchars')); + } + + // Belts and braces + // @todo Tidy into main unicode + //$blacklist2 = '\'/\\"*& ?#%^(){}[]~?<>;|¬`@-+='; + $blacklist2 = '\'/\\"*& ?#%^(){}[]~?<>;|¬`='; + + for ($n = 0; $n < strlen($blacklist2); $n++) { + if (strpos($alias, $blacklist2[$n]) !== false) { + $msg = elgg_echo('groups:alias:registration:invalidchars', array($blacklist2[$n], $blacklist2)); + $msg = htmlentities($msg, ENT_COMPAT, 'UTF-8'); + throw new RegistrationException($msg); + } + } + + $result = true; + return elgg_trigger_plugin_hook('group_alias:validate', 'all', + array('alias' => $alias), $result); +} diff --git a/manifest.xml b/manifest.xml new file mode 100644 index 000000000..33bb9bbc2 --- /dev/null +++ b/manifest.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +<plugin_manifest xmlns="http://www.elgg.org/plugin_manifest/1.8"> + <name>Group Alias</name> + <author>Lorea Developers</author> + <version>1.8.1</version> + <category>lorea</category> + <category>groups</category> + <category>enhancement</category> + <description>Provide clean URLs for groups using an unique alphanumeric identifier.</description> + <website>https://lorea.org/plugins/group_alias</website> + <bugtracker></bugtracker> + <repository>https://gitorious.org/lorea/group_alias</repository> + <donations>https://lorea.org/support</donations> + <copyright>Copryright 2012,2013 Lorea Faeries <federation@lorea.org></copyright> + <license>GNU Affero General Public License version 3, or later</license> + + <requires> + <type>elgg_release</type> + <version>1.8</version> + </requires> + <requires> + <type>plugin</type> + <name>groups</name> + </requires> + <requires> + <type>priority</type> + <priority>after</priority> + <plugin>groups</plugin> + </requires> + <suggests> + <type>plugin</type> + <name>linkup</name> + </suggests> + <suggests> + <type>plugin</type> + <name>upgrade-tools</name> + </suggests> +</plugin_manifest> diff --git a/start.php b/start.php new file mode 100644 index 000000000..01d4bb080 --- /dev/null +++ b/start.php @@ -0,0 +1,188 @@ +<?php +/** + * Elgg Group Alias + * + * @package Lorea + * @subpackage GroupAlias + * @homepage http://lorea.org/plugin/group_alias + * @copyright 2011-2012 Lorea Faeries <federation@lorea.org> + * @license COPYING, http://www.gnu.org/licenses/agpl + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This program is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +elgg_register_event_handler('init', 'system', 'group_alias_init'); + +/** + * Initialize the group alias plugin. + * + */ +function group_alias_init() { + + // Register group alias library + $library_path = elgg_get_plugins_path() . 'group_alias/lib/group_alias.php'; + elgg_register_library('elgg:group_alias', $library_path); + + // Register a page handler, so we can have nice URLs + elgg_register_page_handler('g', 'group_alias_page_handler'); + + // Override URL handlers for groups + elgg_register_entity_url_handler('group', 'all', 'group_alias_url'); + + // Add alias field + elgg_register_plugin_hook_handler('profile:fields', 'group', 'group_alias_fields_setup'); + + // Override groups/edit action + $action_base = elgg_get_plugins_path() . 'group_alias/actions/groups'; + elgg_register_action("groups/edit", "$action_base/edit.php"); + + // Extend the main css view + elgg_extend_view('css/elgg', 'group_alias/css'); + elgg_extend_view('js/elgg', 'group_alias/js'); + + // Register tests + elgg_register_plugin_hook_handler('unit_test', 'system', 'group_alias_test'); + elgg_register_event_handler('upgrade', 'system', 'group_alias_run_upgrades'); + +} + +function group_alias_run_upgrades() { + $upgrade_tools = elgg_get_plugins_path() . 'upgrade-tools/lib/upgrade_tools.php'; + if (file_exists($upgrade_tools) && include_once($upgrade_tools)) { + upgrade_module_run('group_alias'); + } +} + + +function group_alias_test($hook, $type, $value, $params) { + $value[] = elgg_get_config('pluginspath') . "group_alias/tests/group_alias_test.php"; + return $value; +} + +function get_group_from_group_alias($alias){ + return current(elgg_get_entities_from_metadata(array( + 'type' => 'group', + 'metadata_name' => 'alias', + 'metadata_value' => $alias, + 'limit' => 1, + ))); +} + +/** + * Dispatcher for group alias. + * URLs take the form of + * All groups: g/ + * Group profile: g/<alias> + * Group Tools: g/<alias>/<handler> => <handler>/group/<guid> + * + * @param array $page + * @return bool + */ +function group_alias_page_handler($page) { + + elgg_set_context('groups'); + + if (!isset($page[0])) { + groups_page_handler(array('all'), 'groups'); + return true; + } + + $group = get_group_from_group_alias(str_replace(' ', '+', urldecode($page[0]))); + + if($group && !isset($page[1])){ + groups_page_handler(array('profile', $group->guid)); + + } elseif($group && isset($page[1])) { + forward("$page[1]/group/$group->guid"); + + } else { + return groups_page_handler($page); + } + + return true; +} + +function group_alias_fields_setup($hook, $type, $return, $params) { + return array_merge($return, array('alias' => 'group_alias')); +} + +function group_alias_from_name($group) { + + $alias = elgg_get_friendly_title($group->name); + $alias = preg_replace("/-/", "_", $alias); + $alias = urldecode($alias); + + return $alias; +} + +/** + * This is an event hook for create/update group to handle the alias + * without overriding the groups/edit action. + */ +function group_alias_save_hook($event, $type, $entity) { + + $alias_from_name = group_alias_from_name($entity); + $aliased_group = get_group_from_group_alias($alias_from_name); + + // If the alias is already taken by another group, append GUID. + if (elgg_instanceof($aliased_group, 'group') + && $aliased_group->guid != $entity->guid) { + $entity->set('alias', "$alias_from_name$entity->guid"); + return TRUE; + } + // Force keeping default or existing alias if empty or not changeable + if (empty($entity->alias) || !elgg_get_config('changeable_group_alias')) { + $entity->set('alias', $alias_from_name); + } + + return TRUE; +} + +/** + * Override the group url + * + * @param ElggObject $group Group object + * @return string + */ +function group_alias_url($group) { + if(!$group->alias){ + return groups_url($group); + } + return "g/$group->alias"; +} + +/** + * Convert a group name to an alias if it does not exist already. + * Return the newly, or existing group alias. + * + * @param ElggGroup $group Group object + * @return string + */ +function group_alias_update_from_name($group) { + if (!empty($group->alias)) { + return $group->alias; + } + $alias = group_alias_from_name($group); + // If alias is taken, append GUID + $g = get_group_from_group_alias($alias); + if (elgg_instanceof($g, 'group') && $g->guid != $group->guid) { + $alias .= $group->guid; + } + $group->set('alias', $alias); + + return $alias; +} diff --git a/tests/group_alias_test.php b/tests/group_alias_test.php new file mode 100644 index 000000000..fe33bd69d --- /dev/null +++ b/tests/group_alias_test.php @@ -0,0 +1,99 @@ +<?php +/** + * Elgg Group Alias Tests + * + * Plugin authors: copy this file to your plugin's test directory. Register an Elgg + * plugin hook and function similar to: + * + * elgg_register_plugin_hook_handler('unit_test', 'system', 'my_new_unit_test'); + * + * function my_new_unit_test($hook, $type, $value, $params) { + * $value[] = "path/to/my/unit_test.php"; + * return $value; + * } + * + * @package Elgg + * @subpackage Test + */ +class ElggGroupAliasTest extends ElggCoreUnitTest { + + // New group + var $new_group; + + // Saved (aliased) group + var $existing_group; + + /** + * Called before each test object. + */ + public function __construct() { + parent::__construct(); + + // all __construct() code should come after here + } + + /** + * Called before each test method. + */ + public function setUp() { + $this->existing_group = new ElggGroup(); + $this->existing_group->name = "Aliased Test Group"; + $this->existing_group->alias = 'aliased_test_group'; + $this->existing_group->save(); + + $this->new_group = new ElggGroup(); + $this->new_group->name = 'group_alias test group'; + } + + /** + * Called after each test method. + */ + public function tearDown() { + // do not allow SimpleTest to interpret Elgg notices as exceptions + $this->swallowErrors(); + // Remove created objects + $this->existing_group->delete(); + $this->new_group->delete(); + } + + /** + * Called after each test object. + */ + public function __destruct() { + // all __destruct() code should go above here + parent::__destruct(); + } + + public function testNewGroupHasNoAlias() { + $this->assertNull($this->new_group->alias); + } + + public function testGroupAliasSave() { + $this->new_group->alias = 'sample_alias'; + $this->assertTrue($this->new_group->save()); + $this->assertIdentical('sample_alias', $this->new_group->alias); + $this->assertNotNull($this->new_group->alias); + } + + public function testGroupAliasUpdate() { + $alias = $this->existing_group->alias; + $this->assertEqual($alias, 'aliased_test_group'); + $this->existing_group->set('alias', 'new_alias'); + $this->assertTrue($this->existing_group->save()); + $this->assertIdentical($this->existing_group->get('alias'), 'new_alias'); + } + + public function testGroupAliasPersistence() { + $this->existing_group->name = 'Changed Name'; + $this->assertTrue($this->existing_group->save()); + $this->assertIdentical($this->existing_group->alias, 'aliased_test_group'); + } + +// @todo: how to tell ElggGroup to save default metadata? +// public function testGroupAliasDefault() { +// $this->new_group->name = 'A group without an alias'; +// $this->assertTrue($this->new_group->save()); +// $this->assertIdentical('a_group_without_an_alias', $this->new_group->alias); +// } + +} diff --git a/upgrade.php b/upgrade.php new file mode 100644 index 000000000..42b7f794e --- /dev/null +++ b/upgrade.php @@ -0,0 +1,37 @@ +<?php +/** + * Upgrade file + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +require_once(dirname(dirname(dirname(__FILE__))) . "/engine/start.php"); + +admin_gatekeeper(); +set_time_limit(0); + +echo "upgrade group alias"; +$previous_access = elgg_set_ignore_access(true); +group_alias_run_upgrades(); +elgg_set_ignore_access($previous_access); + +echo "DONE"; diff --git a/upgrades/2012100501.php b/upgrades/2012100501.php new file mode 100644 index 000000000..9deeda2a7 --- /dev/null +++ b/upgrades/2012100501.php @@ -0,0 +1,117 @@ +<?php +/** + * GroupAlias -- Create missing aliases + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +global $MIGRATED; + +$local_version = (int)elgg_get_plugin_setting('version', 'group_alias'); + +if (2012022501 <= $local_version) { + error_log("Group alias requires no upgrade"); + return; +} + +elgg_load_library("elgg:group_alias"); + +function group_alias_filtername($name) { + $group_name = str_replace(' ','-' ,$name); + $group_name = str_replace(']','' ,$group_name); + $group_name = str_replace('[','' ,$group_name); + $group_name = strtolower($group_name); + + return $group_name; +} + +function group_alias_get_groupmail($group) { + $group_name = group_alias_filtername($group->name); + $group_email = $group_name; + $parent = get_entity($group->container_guid); + if ($parent instanceof ElggGroup) { + $group_email = group_alias_filtername($parent->name)."+".$group_email; + } + + return $group_email; +} + + +function group_alias_find_alias($group) { + return group_alias_get_groupmail($group); +} + +/** + * Save previous pad name, adapt subtype, river, clean up. + */ +function group_alias_2012100501($group) { + require_once(elgg_get_plugins_path() . 'upgrade-tools/lib/upgrade_tools.php'); + if (empty($group->alias)) { + //if (true) { + $alias = group_alias_find_alias($group); + $ngroups = elgg_get_entities_from_metadata(array( + 'type' => 'group', + 'metadata_name' => 'alias', + 'metadata_value' => $alias, + 'limit' => 0, + 'count' => true, + )); + try { + $validates = group_alias_validate($alias); + } catch (RegistrationException $e) { + $validates = false; + } + if (!$validates || $ngroups > 1 || ($ngroups == 1 && $alias != $group->alias)) { + $alias = elgg_get_friendly_title($group->name); + $alias = preg_replace("/-/", "_", $alias); + $alias = urldecode($alias); + $g = get_group_from_group_alias($alias); + if (elgg_instanceof($g, 'group') && $g->getGUID() != $group->guid){ + $alias .= $group->guid; + } + + } + if ($group->alias != $alias) { + $group->alias = $alias; + } + } + return true; +} + +/* + * Run upgrade. First users, then pads + */ +// users +$options = array('type' => 'group', 'limit' => 0); + +$MIGRATED = 0; + +$previous_access = elgg_set_ignore_access(true); +$batch = new ElggBatch('elgg_get_entities', $options, "group_alias_2012100501", 100); +elgg_set_ignore_access($previous_access); + +if ($batch->callbackResult) { + error_log("Group alias upgrade (201210050) succeeded"); + elgg_set_plugin_setting('version', 2012022501, 'group_alias'); +} else { + error_log("Group alias upgrade (201210050) failed"); +} diff --git a/views/default/group_alias/js.php b/views/default/group_alias/js.php new file mode 100644 index 000000000..b2c2811f5 --- /dev/null +++ b/views/default/group_alias/js.php @@ -0,0 +1,36 @@ +<?php +/** + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ +?> +$(function(){ + $('input.elgg-input-text[name="name"]').keyup(function(){ + $('input.elgg-input-text[name="alias"][disabled!="disabled"]').val(function(title){ + return title.replace(/[^\w ]/g, "") + .replace(/^\s+/g,'').replace(/\s+$/g,'') //trim + .replace(/ /g, "_") + .replace(/__/g, "_") + .toLowerCase(); + }($(this).val())); + }); +}); diff --git a/views/default/input/group_alias.php b/views/default/input/group_alias.php new file mode 100644 index 000000000..467e45c59 --- /dev/null +++ b/views/default/input/group_alias.php @@ -0,0 +1,31 @@ +<?php +/** + * GroupAlias -- Input a group alias field + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +if ('no' == elgg_get_plugin_setting('changeable_group_alias', 'group_alias') + && elgg_instanceof(elgg_get_page_owner_entity(), 'group')) { + $vars['disabled'] = true; +} +echo elgg_view('input/text', $vars); diff --git a/views/default/output/group_alias.php b/views/default/output/group_alias.php new file mode 100644 index 000000000..cb8b19756 --- /dev/null +++ b/views/default/output/group_alias.php @@ -0,0 +1,46 @@ +<?php +/** + * GroupAlias output + * + * - Only show in the Group Profile + * - If linkup is available, hint about the syntax + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +if ('group_profile' != elgg_get_context()) { + + return false; + +} + +$alias = htmlspecialchars($vars['value'], ENT_QUOTES, 'UTF-8', false); +$target_url = elgg_get_config('url') . "g/$alias"; + +if (elgg_is_active_plugin('linkup')) { + + $hint = elgg_echo('linkup:hint:group', array($alias, $target_url)); + +} else { + + $hint = $target_url; + +} + +echo "<span title=\"$hint\">$alias </span><span title=\"$hint\" class=\"elgg-icon elgg-icon-info\"></span>"; diff --git a/views/default/plugins/group_alias/settings.php b/views/default/plugins/group_alias/settings.php new file mode 100644 index 000000000..d558b4825 --- /dev/null +++ b/views/default/plugins/group_alias/settings.php @@ -0,0 +1,46 @@ +<?php +/** + * Group Alias plugin settings + * + * @package Lorea + * @subpackage GroupAlias + * + * Copyright 2011-2013 Lorea Faeries <federation@lorea.org> + * + * This file is part of the GroupAlias plugin for Elgg. + * + * GroupAlias is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * GroupAlias 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/>. + */ + +// set default value +if (!isset($vars['entity']->changeable_group_alias)) { + $vars['entity']->changeable_group_alias = 'no'; +} + +echo '<div>'; +echo elgg_echo('groups:alias:changeable'); +echo ' '; +echo elgg_view('input/select', array( + 'name' => 'params[changeable_group_alias]', + 'options_values' => array( + 'no' => elgg_echo('option:no'), + 'yes' => elgg_echo('option:yes') + ), + 'value' => $vars['entity']->changeable_group_alias, +)); +echo '<p class="tip">'; +echo elgg_echo('groups:alias:changeable:may_break_urls'); +echo '</p>'; +echo '</div>'; |