1.0.0-beta

Civix upgrade should fix install error

.gitignore

@@ -1,3 +1,5 @@
 secrets.php
 proxy/file_cache
+proxy/config.php
 debug.log
+.idea

Dockerfile

@@ -0,0 +1,8 @@
+# You may find this Dockerfile useful in development or production
+# From the CiviProxy directory
+# * Build a docker image with `docker build . -t civiproxy`
+# * Run a development container with `run -d -p 4050:80 -v $PWD/proxy:/var/www/html --name civiproxy civiproxy`
+
+FROM php:7-apache
+
+COPY proxy/ /var/www/html

LIBRARIES.md

@@ -0,0 +1,10 @@
+# Libraries
+
+This module uses the following libraries
+
+
+## PEAR Cache Lite
+
+by Fabien MARTY <fab@php.net> and Markus Tacker <tacker@php.net>
+
+URL: [https://travis-ci.org/pear/Cache_Lite](https://travis-ci.org/pear/Cache_Lite)

LICENSE

@@ -0,0 +1,662 @@
+                    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/>.
+

README.md

@@ -0,0 +1,8 @@
+## About
+CiviProxy is a tool to set up a security proxy server specifically for your CiviCRM instance. It uses whitelisting and parameter sanitation to allow only legitimate requests to pass through. 
+## Documentation
+The documentation on CiviProxy can be found here: https://docs.civicrm.org/civiproxy/en/latest/
+## We need your support
+This software is provided as Free and Open Source Software, and we are happy if you find it useful. However, we have put a lot of work into it (and continue to do so), much of it unpaid for. So if you benefit from our software, please consider making a financial contribution so we can continue to maintain and develop it further.
+
+If you are willing to support us in developing this tool, please send an email to info@systopia.de to get an invoice or agree a different payment method. Thank you! 

de.systopia.civiproxy/CRM/Admin/Form/Setting/ProxySettings.php

@@ -1,4 +1,12 @@
 <?php
+/*-------------------------------------------------------+
+| CiviProxy                                              |
+| Copyright (C) 2015-2021 SYSTOPIA                       |
+| Author: B. Endres (endres -at- systopia.de)            |
+| http://www.systopia.de/                                |
++--------------------------------------------------------+
+| License: AGPLv3, see /LICENSE                          |
++--------------------------------------------------------*/
 
 require_once 'CRM/Admin/Form/Setting.php';
 require_once 'CRM/Core/BAO/CustomField.php';
@@ -97,9 +105,9 @@ class CRM_Admin_Form_Setting_ProxySettings extends CRM_Admin_Form_Setting
     if($response === FALSE) {
       return array('is_error' => 1, 'message' => sprintf(ts('Error: cannot access "%s"'), $url));
     }else{
-      $result = preg_match("/<p id=\"version\">CiviProxy Version ([0-9]+\.[0-9]+|[0-9]+\.[0-9]+\.[0-9]+)<\/p>/", $response, $output_array);
+      $result = preg_match("/<p id=\"version\">CiviProxy Version (([0-9]+\.[0-9]+|[0-9]+\.[0-9]+\.[0-9]+)(?:-[0-9A-Za-z-]+)?)<\/p>/", $response, $output_array);
       if ($result === FALSE || $result === 0){
-        return array('is_error' => 1, 'message' => sprintf(ts('Error: failed to parse version information'), $url));
+        return array('is_error' => 1, 'message' => sprintf(ts('Error: failed to parse version information: (%s)'), $url));
       }else{
         return array('is_error' => 0, 'version' => $output_array[1]);
       }

de.systopia.civiproxy/CRM/Civiproxy/Mailer.php

@@ -1,11 +1,11 @@
 <?php
 /*-------------------------------------------------------+
 | CiviProxy                                              |
-| Copyright (C) 2015 SYSTOPIA                            |
+| Copyright (C) 2015-2021 SYSTOPIA                       |
 | Author: B. Endres (endres -at- systopia.de)            |
 | http://www.systopia.de/                                |
 +--------------------------------------------------------+
-| TODO: License                                          |
+| License: AGPLv3, see /LICENSE                          |
 +--------------------------------------------------------*/
 
 /**
@@ -17,12 +17,23 @@ class CRM_Civiproxy_Mailer {
    * this is the orginal, wrapped mailer
    */
   protected $mailer = NULL;
+  /**
+   * @var Mail Driver
+   */
+  protected $driver = NULL;
+
+  /**
+   * @var array Mail Params, currently not used
+   */
+  protected $params = [];
 
   /**
    * construct this mailer wrapping another one
    */
-  public function __construct($mailer) {
+  public function __construct($mailer, $driver, $params) {
     $this->mailer = $mailer;
+    $this->driver = $driver;
+    $this->params = $params;
   }
 
   /**
@@ -30,7 +41,9 @@ class CRM_Civiproxy_Mailer {
    *  mending the URLs contained
    */
   function send($recipients, $headers, $body) {
-    CRM_CiviProxy_Mailer::mendURLs($headers);
+    foreach ($headers as &$header) {
+      CRM_CiviProxy_Mailer::mendURLs($header);
+    }
     CRM_CiviProxy_Mailer::mendURLs($body);
     $this->mailer->send($recipients, $headers, $body);
   }
@@ -45,15 +58,26 @@ class CRM_Civiproxy_Mailer {
     $enabled = CRM_Core_BAO_Setting::getItem('CiviProxy Settings', 'proxy_enabled');
     if (!$enabled) return;
 
+    $mosaico = CRM_Civiproxy_Mosaico::singleton();
+
     // get the URLs
     $config      = CRM_Core_Config::singleton();
     $system_base = $config->userFrameworkBaseURL;
     $proxy_base  = CRM_Core_BAO_Setting::getItem('CiviProxy Settings', 'proxy_url');
 
     // General external functions
-    $value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/url.php#i",  $proxy_base.'/url.php',      $value);
+    $value = preg_replace("#{$system_base}civicrm/mailing/url#i",                       $proxy_base.'/url.php',         $value);
-    $value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/open.php#i", $proxy_base.'/open.php',     $value);
+    $value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/url.php#i",  $proxy_base.'/url.php',         $value);
-    $value = preg_replace("#{$system_base}sites/default/files/civicrm/persist/#i",      $proxy_base.'/file.php?id=', $value);
+    $value = preg_replace("#{$system_base}civicrm/mailing/open#i",                      $proxy_base.'/open.php',        $value);
+    $value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/open.php#i", $proxy_base.'/open.php',        $value);
+    $value = preg_replace("#{$system_base}sites/default/files/civicrm/persist/#i",      $proxy_base.'/file.php?id=',    $value);
+    $value = preg_replace("#{$system_base}civicrm/mosaico/img\?src=#i",                 $proxy_base.'/mosaico.php?id=', $value);
+    $value = preg_replace("#{$system_base}civicrm/mosaico/img/\?src=#i", $proxy_base.'/mosaico.php?id=', $value);
+    if ($mosaico->isMosaicoInstalled()) {
+      $value = preg_replace_callback("#({$mosaico->getMosaicoExtensionUrl()}/packages/mosaico/templates/)(\S*)([\"'])#i", function($matches) use ($proxy_base) {
+        return $proxy_base . '/mosaico.php?template_url=' . urlencode($matches[2]) . $matches[3];
+      }, $value);
+    }
 
     // Mailing related functions
     $value = preg_replace("#{$system_base}civicrm/mailing/view#i",                      $proxy_base.'/mailing/mail.php', $value);
@@ -68,4 +92,11 @@ class CRM_Civiproxy_Mailer {
       $value = preg_replace("#{$system_base}civicrm/mailing/{$function}#i", $new_url, $value);
     }
   }
+
+    /**
+     * @return Mail|null
+     */
+    public function getDriver() {
+        return $this->driver;
+    }
 }

de.systopia.civiproxy/CRM/Civiproxy/Mosaico.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * Copyright (C) 2021  Jaap Jansma (jaap.jansma@civicoop.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 <https://www.gnu.org/licenses/>.
+ */
+
+class CRM_Civiproxy_Mosaico {
+
+  /**
+   * @var CRM_Civiproxy_Mosaico
+   */
+  private static $singleton;
+
+  /**
+   * @var String
+   */
+  private $mosiacoExtenionUrl;
+
+  /**
+   * @var bool
+   */
+  private $isMosaicoInstalled = false;
+
+  private function __construct() {
+    try {
+      $mosaicoExt = civicrm_api3('Extension', 'getsingle', ['full_name' => "uk.co.vedaconsulting.mosaico"]);
+      $this->isMosaicoInstalled = true;
+      $this->mosiacoExtenionUrl = CRM_Mosaico_ExtensionUtil::url();
+    } catch (\Exception $ex) {
+      // Do nothing
+    }
+  }
+
+  /**
+   * @return CRM_Civiproxy_Mosaico
+   */
+  public static function singleton() {
+    if (!self::$singleton) {
+      self::$singleton = new CRM_Civiproxy_Mosaico();
+    }
+    return self::$singleton;
+  }
+
+  /**
+   * @return bool
+   */
+  public function isMosaicoInstalled() {
+    return $this->isMosaicoInstalled;
+  }
+
+  /**
+   * @return string
+   */
+  public function getMosaicoExtensionUrl() {
+    return $this->mosiacoExtenionUrl;
+  }
+
+}

de.systopia.civiproxy/civiproxy.civix.php

@@ -3,240 +3,199 @@
 // AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
 
 /**
- * (Delegated) Implementation of hook_civicrm_config
+ * The ExtensionUtil class provides small stubs for accessing resources of this
+ * extension.
  */
-function _civiproxy_civix_civicrm_config(&$config = NULL) {
+class CRM_Civiproxy_ExtensionUtil {
+  const SHORT_NAME = 'civiproxy';
+  const LONG_NAME = 'de.systopia.civiproxy';
+  const CLASS_PREFIX = 'CRM_Civiproxy';
+
+  /**
+   * Translate a string using the extension's domain.
+   *
+   * If the extension doesn't have a specific translation
+   * for the string, fallback to the default translations.
+   *
+   * @param string $text
+   *   Canonical message text (generally en_US).
+   * @param array $params
+   * @return string
+   *   Translated text.
+   * @see ts
+   */
+  public static function ts($text, $params = []): string {
+    if (!array_key_exists('domain', $params)) {
+      $params['domain'] = [self::LONG_NAME, NULL];
+    }
+    return ts($text, $params);
+  }
+
+  /**
+   * Get the URL of a resource file (in this extension).
+   *
+   * @param string|NULL $file
+   *   Ex: NULL.
+   *   Ex: 'css/foo.css'.
+   * @return string
+   *   Ex: 'http://example.org/sites/default/ext/org.example.foo'.
+   *   Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
+   */
+  public static function url($file = NULL): string {
+    if ($file === NULL) {
+      return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
+    }
+    return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
+  }
+
+  /**
+   * Get the path of a resource file (in this extension).
+   *
+   * @param string|NULL $file
+   *   Ex: NULL.
+   *   Ex: 'css/foo.css'.
+   * @return string
+   *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
+   *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
+   */
+  public static function path($file = NULL) {
+    // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
+    return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
+  }
+
+  /**
+   * Get the name of a class within this extension.
+   *
+   * @param string $suffix
+   *   Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
+   * @return string
+   *   Ex: 'CRM_Foo_Page_HelloWorld'.
+   */
+  public static function findClass($suffix) {
+    return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
+  }
+
+
+}
+
+use CRM_Civiproxy_ExtensionUtil as E;
+
+/**
+ * (Delegated) Implements hook_civicrm_config().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
+ */
+function _civiproxy_civix_civicrm_config($config = NULL) {
   static $configured = FALSE;
-  if ($configured) return;
+  if ($configured) {
+    return;
+  }
   $configured = TRUE;
 
-  $template =& CRM_Core_Smarty::singleton();
+  $extRoot = __DIR__ . DIRECTORY_SEPARATOR;
-
+  $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
-  $extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
+  set_include_path($include_path);
-  $extDir = $extRoot . 'templates';
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
-
-  if ( is_array( $template->template_dir ) ) {
-      array_unshift( $template->template_dir, $extDir );
-  } else {
-      $template->template_dir = array( $extDir, $template->template_dir );
-  }
-
-  $include_path = $extRoot . PATH_SEPARATOR . get_include_path( );
-  set_include_path( $include_path );
 }
 
 /**
- * (Delegated) Implementation of hook_civicrm_xmlMenu
+ * Implements hook_civicrm_install().
  *
- * @param $files array(string)
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
- */
-function _civiproxy_civix_civicrm_xmlMenu(&$files) {
-  foreach (_civiproxy_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
-    $files[] = $file;
-  }
-}
-
-/**
- * Implementation of hook_civicrm_install
  */
 function _civiproxy_civix_civicrm_install() {
   _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
-    return $upgrader->onInstall();
-  }
 }
 
 /**
- * Implementation of hook_civicrm_uninstall
+ * (Delegated) Implements hook_civicrm_enable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
  */
-function _civiproxy_civix_civicrm_uninstall() {
+function _civiproxy_civix_civicrm_enable(): void {
   _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
-    return $upgrader->onUninstall();
-  }
 }
 
 /**
- * (Delegated) Implementation of hook_civicrm_enable
+ * Inserts a navigation menu item at a given place in the hierarchy.
+ *
+ * @param array $menu - menu hierarchy
+ * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
+ *    'Mailing', or 'Administer/System Settings'
+ * @param array $item - the item to insert (parent/child attributes will be
+ *    filled for you)
+ *
+ * @return bool
  */
-function _civiproxy_civix_civicrm_enable() {
+function _civiproxy_civix_insert_navigation_menu(&$menu, $path, $item) {
-  _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
-    if (is_callable(array($upgrader, 'onEnable'))) {
-      return $upgrader->onEnable();
-    }
-  }
-}
-
-/**
- * (Delegated) Implementation of hook_civicrm_disable
- */
-function _civiproxy_civix_civicrm_disable() {
-  _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
-    if (is_callable(array($upgrader, 'onDisable'))) {
-      return $upgrader->onDisable();
-    }
-  }
-}
-
-/**
- * (Delegated) Implementation of hook_civicrm_upgrade
- *
- * @param $op string, the type of operation being performed; 'check' or 'enqueue'
- * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
- *
- * @return mixed  based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
- *                for 'enqueue', returns void
- */
-function _civiproxy_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
-  if ($upgrader = _civiproxy_civix_upgrader()) {
-    return $upgrader->onUpgrade($op, $queue);
-  }
-}
-
-function _civiproxy_civix_upgrader() {
-  if (!file_exists(__DIR__.'/CRM/Civiproxy/Upgrader.php')) {
-    return NULL;
-  } else {
-    return CRM_Civiproxy_Upgrader_Base::instance();
-  }
-}
-
-/**
- * Search directory tree for files which match a glob pattern
- *
- * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
- * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
- *
- * @param $dir string, base dir
- * @param $pattern string, glob pattern, eg "*.txt"
- * @return array(string)
- */
-function _civiproxy_civix_find_files($dir, $pattern) {
-  if (is_callable(array('CRM_Utils_File', 'findFiles'))) {
-    return CRM_Utils_File::findFiles($dir, $pattern);
-  }
-
-  $todos = array($dir);
-  $result = array();
-  while (!empty($todos)) {
-    $subdir = array_shift($todos);
-    foreach (_civiproxy_civix_glob("$subdir/$pattern") as $match) {
-      if (!is_dir($match)) {
-        $result[] = $match;
-      }
-    }
-    if ($dh = opendir($subdir)) {
-      while (FALSE !== ($entry = readdir($dh))) {
-        $path = $subdir . DIRECTORY_SEPARATOR . $entry;
-        if ($entry{0} == '.') {
-        } elseif (is_dir($path)) {
-          $todos[] = $path;
-        }
-      }
-      closedir($dh);
-    }
-  }
-  return $result;
-}
-/**
- * (Delegated) Implementation of hook_civicrm_managed
- *
- * Find any *.mgd.php files, merge their content, and return.
- */
-function _civiproxy_civix_civicrm_managed(&$entities) {
-  $mgdFiles = _civiproxy_civix_find_files(__DIR__, '*.mgd.php');
-  foreach ($mgdFiles as $file) {
-    $es = include $file;
-    foreach ($es as $e) {
-      if (empty($e['module'])) {
-        $e['module'] = 'de.systopia.civiproxy';
-      }
-      $entities[] = $e;
-    }
-  }
-}
-
-/**
- * (Delegated) Implementation of hook_civicrm_caseTypes
- *
- * Find any and return any files matching "xml/case/*.xml"
- *
- * Note: This hook only runs in CiviCRM 4.4+.
- */
-function _civiproxy_civix_civicrm_caseTypes(&$caseTypes) {
-  if (!is_dir(__DIR__ . '/xml/case')) {
-    return;
-  }
-
-  foreach (_civiproxy_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
-    $name = preg_replace('/\.xml$/', '', basename($file));
-    if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
-      $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
-      CRM_Core_Error::fatal($errorMessage);
-      // throw new CRM_Core_Exception($errorMessage);
-    }
-    $caseTypes[$name] = array(
-      'module' => 'de.systopia.civiproxy',
-      'name' => $name,
-      'file' => $file,
-    );
-  }
-}
-
-/**
- * Glob wrapper which is guaranteed to return an array.
- *
- * The documentation for glob() says, "On some systems it is impossible to
- * distinguish between empty match and an error." Anecdotally, the return
- * result for an empty match is sometimes array() and sometimes FALSE.
- * This wrapper provides consistency.
- *
- * @see http://php.net/glob
- * @param string $pattern
- * @return array, possibly empty
- */
-function _civiproxy_civix_glob($pattern) {
-  $result = glob($pattern);
-  return is_array($result) ? $result : array();
-}
-
-/**
- * Inserts a navigation menu item at a given place in the hierarchy
- *
- * $menu - menu hierarchy
- * $path - path where insertion should happen (ie. Administer/System Settings)
- * $item - menu you need to insert (parent/child attributes will be filled for you)
- * $parentId - used internally to recurse in the menu structure
- */
-function _civiproxy_civix_insert_navigation_menu(&$menu, $path, $item, $parentId = NULL) {
-  static $navId;
-
   // If we are done going down the path, insert menu
   if (empty($path)) {
-    if (!$navId) $navId = CRM_Core_DAO::singleValueQuery("SELECT max(id) FROM civicrm_navigation");
+    $menu[] = [
-    $navId ++;
+      'attributes' => array_merge([
-    $menu[$navId] = array (
+        'label' => $item['name'] ?? NULL,
-      'attributes' => array_merge($item, array(
+        'active' => 1,
-        'label'      => CRM_Utils_Array::value('name', $item),
+      ], $item),
-        'active'     => 1,
+    ];
-        'parentID'   => $parentId,
+    return TRUE;
-        'navID'      => $navId,
+  }
-      ))
+  else {
-    );
-    return true;
-  } else {
     // Find an recurse into the next level down
-    $found = false;
+    $found = FALSE;
     $path = explode('/', $path);
     $first = array_shift($path);
     foreach ($menu as $key => &$entry) {
       if ($entry['attributes']['name'] == $first) {
-        if (!$entry['child']) $entry['child'] = array();
+        if (!isset($entry['child'])) {
-        $found = _civiproxy_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key);
+          $entry['child'] = [];
+        }
+        $found = _civiproxy_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
       }
     }
     return $found;
   }
 }
+
+/**
+ * (Delegated) Implements hook_civicrm_navigationMenu().
+ */
+function _civiproxy_civix_navigationMenu(&$nodes) {
+  if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
+    _civiproxy_civix_fixNavigationMenu($nodes);
+  }
+}
+
+/**
+ * Given a navigation menu, generate navIDs for any items which are
+ * missing them.
+ */
+function _civiproxy_civix_fixNavigationMenu(&$nodes) {
+  $maxNavID = 1;
+  array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
+    if ($key === 'navID') {
+      $maxNavID = max($maxNavID, $item);
+    }
+  });
+  _civiproxy_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
+}
+
+function _civiproxy_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
+  $origKeys = array_keys($nodes);
+  foreach ($origKeys as $origKey) {
+    if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
+      $nodes[$origKey]['attributes']['parentID'] = $parentID;
+    }
+    // If no navID, then assign navID and fix key.
+    if (!isset($nodes[$origKey]['attributes']['navID'])) {
+      $newKey = ++$maxNavID;
+      $nodes[$origKey]['attributes']['navID'] = $newKey;
+      $nodes[$newKey] = $nodes[$origKey];
+      unset($nodes[$origKey]);
+      $origKey = $newKey;
+    }
+    if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
+      _civiproxy_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
+    }
+  }
+}

de.systopia.civiproxy/civiproxy.php

@@ -1,11 +1,11 @@
 <?php
 /*-------------------------------------------------------+
 | CiviProxy                                              |
-| Copyright (C) 2015 SYSTOPIA                            |
+| Copyright (C) 2015-2021 SYSTOPIA                       |
 | Author: B. Endres (endres -at- systopia.de)            |
 | http://www.systopia.de/                                |
 +--------------------------------------------------------+
-| TODO: License                                          |
+| License: AGPLv3, see /LICENSE                          |
 +--------------------------------------------------------*/
 
 require_once 'civiproxy.civix.php';
@@ -15,7 +15,7 @@ require_once 'civiproxy.civix.php';
  * so we can mend all the URLs in outgoing emails
  */
 function civiproxy_civicrm_alterMailer(&$mailer, $driver, $params) {
-  $mailer = new CRM_Civiproxy_Mailer($mailer);
+  $mailer = new CRM_Civiproxy_Mailer($mailer, $driver, $params);
 }
 
 /**
@@ -25,15 +25,6 @@ function civiproxy_civicrm_config(&$config) {
   _civiproxy_civix_civicrm_config($config);
 }
 
-/**
- * Implementation of hook_civicrm_xmlMenu
- *
- * @param $files array(string)
- */
-function civiproxy_civicrm_xmlMenu(&$files) {
-  _civiproxy_civix_civicrm_xmlMenu($files);
-}
-
 /**
  * Implementation of hook_civicrm_install
  */
@@ -41,13 +32,6 @@ function civiproxy_civicrm_install() {
   return _civiproxy_civix_civicrm_install();
 }
 
-/**
- * Implementation of hook_civicrm_uninstall
- */
-function civiproxy_civicrm_uninstall() {
-  return _civiproxy_civix_civicrm_uninstall();
-}
-
 /**
  * Implementation of hook_civicrm_enable
  */
@@ -55,61 +39,9 @@ function civiproxy_civicrm_enable() {
   return _civiproxy_civix_civicrm_enable();
 }
 
-/**
- * Implementation of hook_civicrm_disable
- */
-function civiproxy_civicrm_disable() {
-  return _civiproxy_civix_civicrm_disable();
-}
-
-/**
- * Implementation of hook_civicrm_upgrade
- *
- * @param $op string, the type of operation being performed; 'check' or 'enqueue'
- * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
- *
- * @return mixed  based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
- *                for 'enqueue', returns void
- */
-function civiproxy_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
-  return _civiproxy_civix_civicrm_upgrade($op, $queue);
-}
-
-/**
- * Implementation of hook_civicrm_managed
- *
- * Generate a list of entities to create/deactivate/delete when this module
- * is installed, disabled, uninstalled.
- */
-function civiproxy_civicrm_managed(&$entities) {
-  return _civiproxy_civix_civicrm_managed($entities);
-}
-
-/**
- * Implementation of hook_civicrm_caseTypes
- *
- * Generate a list of case-types
- *
- * Note: This hook only runs in CiviCRM 4.4+.
- */
-function civiproxy_civicrm_caseTypes(&$caseTypes) {
-  _civiproxy_civix_civicrm_caseTypes($caseTypes);
-}
-
 /**
 * Implementation of hook_civicrm_alterSettingsFolders
 *
 * Scan for settings in custom folder and import them
 *
 */
-function civiproxy_civicrm_alterSettingsFolders(&$metaDataFolders = NULL){
-  static $configured = FALSE;
-  if ($configured) return;
-  $configured = TRUE;
-
-  $extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
-  $extDir = $extRoot . 'settings';
-  if(!in_array($extDir, $metaDataFolders)){
-    $metaDataFolders[] = $extDir;
-  }
-}

de.systopia.civiproxy/info.xml

@@ -3,19 +3,36 @@
   <file>civiproxy</file>
   <name>CiviProxy</name>
   <description>This will enable CiviProxy support for mailings</description>
-  <license></license>
+  <license>AGPL</license>
   <maintainer>
     <author>B. Endres</author>
     <email>endres@systopia.de</email>
   </maintainer>
-  <releaseDate></releaseDate>
+  <urls>
-  <version>0.3</version>
+    <url desc="Main Extension Page">https://github.com/systopia/CiviProxy</url>
-  <develStage>alpha</develStage>
+    <url desc="Documentation">https://docs.civicrm.org/civiproxy/en/latest/</url>
+    <url desc="Support">https://github.com/systopia/CiviProxy/issues</url>
+    <url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
+  </urls>
+  <releaseDate>2024-01-07</releaseDate>
+  <version>1.0.0-beta</version>
+  <develStage>beta</develStage>
   <compatibility>
-    <ver>4.4</ver>
+    <ver>5.45</ver>
   </compatibility>
-  <comments>This is an addition to SYSTOPIA's CiviProxy security system</comments>
+  <comments>This is the companion extension to SYSTOPIA's CiviProxy security system</comments>
   <civix>
     <namespace>CRM/Civiproxy</namespace>
+    <format>24.09.1</format>
   </civix>
+  <mixins>
+    <mixin>menu-xml@1.0.0</mixin>
+    <mixin>setting-php@1.0.0</mixin>
+    <mixin>smarty-v2@1.0.3</mixin>
+    <mixin>entity-types-php@2.0.0</mixin>
+  </mixins>
+  <classloader>
+    <psr0 prefix="CRM_" path="."/>
+    <psr4 prefix="Civi\" path="Civi"/>
+  </classloader>
 </extension>

de.systopia.civiproxy/mixin/entity-types-php@2.0.0.mixin.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Auto-register entity declarations from `schema/*.entityType.php`.
+ *
+ * @mixinName entity-types-php
+ * @mixinVersion 2.0.0
+ * @since 5.73
+ *
+ * Changelog:
+ *  - v2.0 scans /schema directory instead of /xml/schema/*
+ *  - v2.0 supports only one entity per file
+ *  - v2.0 adds 'module' key to each entity
+ *
+ * @param CRM_Extension_MixInfo $mixInfo
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ * @param \CRM_Extension_BootCache $bootCache
+ *   On newer deployments, this will be an instance of BootCache. On older deployments, Civix may polyfill with a work-a-like.
+ */
+return function ($mixInfo, $bootCache) {
+
+  /**
+   * @param \Civi\Core\Event\GenericHookEvent $e
+   * @see CRM_Utils_Hook::entityTypes()
+   */
+  Civi::dispatcher()->addListener('hook_civicrm_entityTypes', function ($e) use ($mixInfo) {
+    // When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically.
+    if (!$mixInfo->isActive() || !is_dir($mixInfo->getPath('schema'))) {
+      return;
+    }
+
+    $files = (array) glob($mixInfo->getPath('schema/*.entityType.php'));
+    foreach ($files as $file) {
+      $entity = include $file;
+      $entity['module'] = $mixInfo->longName;
+      $e->entityTypes[$entity['name']] = $entity;
+    }
+  });
+
+};

de.systopia.civiproxy/mixin/smarty-v2@1.0.3.mixin.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * Auto-register "templates/" folder.
+ *
+ * @mixinName smarty-v2
+ * @mixinVersion 1.0.3
+ * @since 5.59
+ *
+ * @deprecated - it turns out that the mixin is not version specific so the 'smarty'
+ * mixin is preferred over smarty-v2 (they are the same but not having the version
+ * in the name is less misleading.)
+ *
+ * @param CRM_Extension_MixInfo $mixInfo
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ * @param \CRM_Extension_BootCache $bootCache
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ */
+return function ($mixInfo, $bootCache) {
+  $dir = $mixInfo->getPath('templates');
+  if (!file_exists($dir)) {
+    return;
+  }
+
+  $register = function($newDirs) {
+    $smarty = CRM_Core_Smarty::singleton();
+    $v2 = isset($smarty->_version) && version_compare($smarty->_version, 3, '<');
+    $templateDirs = (array) ($v2 ? $smarty->template_dir : $smarty->getTemplateDir());
+    $templateDirs = array_merge($newDirs, $templateDirs);
+    $templateDirs = array_unique(array_map(function($v) {
+      $v = str_replace(DIRECTORY_SEPARATOR, '/', $v);
+      $v = rtrim($v, '/') . '/';
+      return $v;
+    }, $templateDirs));
+    if ($v2) {
+      $smarty->template_dir = $templateDirs;
+    }
+    else {
+      $smarty->setTemplateDir($templateDirs);
+    }
+  };
+
+  // Let's figure out what environment we're in -- so that we know the best way to call $register().
+
+  if (!empty($GLOBALS['_CIVIX_MIXIN_POLYFILL'])) {
+    // Polyfill Loader (v<=5.45): We're already in the middle of firing `hook_config`.
+    if ($mixInfo->isActive()) {
+      $register([$dir]);
+    }
+    return;
+  }
+
+  if (CRM_Extension_System::singleton()->getManager()->extensionIsBeingInstalledOrEnabled($mixInfo->longName)) {
+    // New Install, Standard Loader: The extension has just been enabled, and we're now setting it up.
+    // System has already booted. New templates may be needed for upcoming installation steps.
+    $register([$dir]);
+    return;
+  }
+
+  // Typical Pageview, Standard Loader: Defer the actual registration for a moment -- to ensure that Smarty is online.
+  // We need to bundle-up all dirs -- Smarty 3/4/5 is inefficient with processing repeated calls to `getTemplateDir()`+`setTemplateDir()`
+  if (!isset(Civi::$statics[__FILE__]['event'])) {
+    Civi::$statics[__FILE__]['event'] = 'civi.smarty-v2.addPaths.' . md5(__FILE__);
+    Civi::dispatcher()->addListener('hook_civicrm_config', function() use ($register) {
+      $dirs = [];
+      $event = \Civi\Core\Event\GenericHookEvent::create(['dirs' => &$dirs]);
+      Civi::dispatcher()->dispatch(Civi::$statics[__FILE__]['event'], $event);
+      $register($dirs);
+    });
+  }
+
+  Civi::dispatcher()->addListener(Civi::$statics[__FILE__]['event'], function($event) use ($mixInfo, $dir) {
+    if ($mixInfo->isActive()) {
+      array_unshift($event->dirs, $dir);
+    }
+  });
+
+};

de.systopia.civiproxy/settings/civiproxy.setting.php

@@ -1,4 +1,12 @@
 <?php
+/*-------------------------------------------------------+
+| CiviProxy                                              |
+| Copyright (C) 2015 SYSTOPIA                            |
+| Author: B. Endres (endres -at- systopia.de)            |
+| http://www.systopia.de/                                |
++--------------------------------------------------------+
+| License: AGPLv3, see /LICENSE                          |
++--------------------------------------------------------*/
 
 /*
 * Settings metadata file

de.systopia.civiproxy/templates/CRM/Admin/Form/Setting/ProxySettings.hlp

@@ -1,3 +1,12 @@
+{*-------------------------------------------------------+
+| CiviProxy                                              |
+| Copyright (C) 2015-2021 SYSTOPIA                       |
+| Author: B. Endres (endres -at- systopia.de)            |
+| http://www.systopia.de/                                |
++--------------------------------------------------------+
+| License: AGPLv3, see /LICENSE                          |
++-------------------------------------------------------*}
+
 {htxt id='id-proxy-enabled'}
 <p>
   {ts}Activating CiviProxy will cause all resource URLs (images, URL trackers, mail open tracers, etc.) to point to the proxy.{/ts}
@@ -18,6 +27,6 @@
 
 {htxt id='id-custom-mailing-base'}
 <p>
-  {ts}TADDAAAA{/ts}
+  {ts}The path for the default unsubscribe page. You can use the default in CiviProxy or create your own and add the path here{/ts}
 </p>
 {/htxt}

de.systopia.civiproxy/templates/CRM/Admin/Form/Setting/ProxySettings.tpl

@@ -1,3 +1,11 @@
+{*-------------------------------------------------------+
+| CiviProxy                                              |
+| Copyright (C) 2015-2021 SYSTOPIA                       |
+| Author: B. Endres (endres -at- systopia.de)            |
+| http://www.systopia.de/                                |
++--------------------------------------------------------+
+| License: AGPLv3, see /LICENSE                          |
++-------------------------------------------------------*}
 <div class="crm-block crm-form-block">
   <div>
     <h3>{ts}Basic Settings{/ts}</h3>

docs/configuration.md

@@ -0,0 +1,223 @@
+# How to configure CiviProxy
+!!! caution
+    We assume you have a very basic understanding of PHP and editing PHP files. If you do not, it is probably a good idea to get some support from a CiviCRM expert. You can find one on [Find an Expert](https://civicrm.org/partners-contributors).
+## Configuration of the CiviCRM extension
+You can use CiviProxy to do a couple of things related to mails and mailing for you.
+
+* You can still see all the stuff on the CiviMailing report like the click-throughs and bounces and such.
+* You do not want the links in your bulk mailing or individual mails to immediately feed back to your CiviCRM installation but pass through CiviProxy.
+* You want your subscribe/unsubscribe links to pass through CiviProxy rather than go directly to your CiviCRM installation.
+
+If you want to do any of these things, you will need to install and configure the CiviCRM extension **de.systopia.civiproxy** in your CiviCRM installation.
+
+If you have not installed the extension already, check [Installing CiviCRM](installation.md) for instructions how to.
+
+!!! note
+    If you do not install the **de.systopia.civiproxy** extension you can still use CiviProxy to whitelist your API requests.
+
+Once you have installed the CiviCRM extension you will need to configure the CiviProxy settings. To do this, go to **Administer>Administration Console**. You will see the CiviProxy Settings in the System Settings section of the menu as you can see below.
+
+![Administration Console - System Settings](img/administration_console.png)
+
+If you click on the CiviProxy Settings you will get a page with a few settings for CiviProxy. If you access the page for the first time these will be empty. The settings you can enter are:
+
+1. A checkbox CiviProxy Enabled to enable or disable the CiviProxy functionality with your CiviCRM mailing links.
+1. A text field Proxy URL where you can add the URL of your CiviProxy server. This link will be validated and the version of the CiviProxy will be shown. If the URL does not meet the validation (does not contain a valid CiviProxy installation), there will be an error message.
+1. A text field Custom Subscribe/Unsubscribe Pages for a path to the unsubscribe page that will be used. There is a basic unsubscribe page on your CiviProxy server, the path to this page will be the default. If the default unsubscribe page is not what you would like, then you can either update the page in the CiviProxy installation on your server or create your own page and set the URL here.
+
+!!! note
+    If you do create your own subscription page make sure the parameters and returns and such are the same as in the default unsubscribe page!
+
+In the screen print below you can see the CiviProxy Settings page with the values I have used for my test installation when producing this guide.
+
+![Example CiviProxy Settings](img/civicrm_proxy_settings.png)
+## Configuration of the CiviProxy server
+The CiviProxy server is the actual policeman that receives all requests and decides if they are allowed to send data to or retrieve data from CiviCRM. It consists of a series of scripts which you need to install on the server as explained in [Installing CiviProxy](installation.md).
+
+Once you have installed your CiviProxy server you need to complete a few configuration steps.
+### The Config.php file
+
+The configuration of CiviProxy is mainly controlled with one PHP file called `config.php`. Create this file by copying or renaming the `config.dist.php` file.
+
+![List of files on your CiviProxy server](img/file%20list%20proxy.png)
+
+### Configuring the URL of your CiviProxy server
+
+First thing you need to configure is the base URL of your CiviProxy server using the `$proxy_base` variable in the `config.php` file. As I have used a local test installation I have used `http://localhost/proxy`:
+```php
+ // this should point to the base address of the CiviProxy installation
+ $proxy_base     = 'http://localhost/proxy';
+```
+
+!!! note
+    This guide assumes a Drupal7 target CiviCRM with clean URLs enabled. If this is not the case for you, you might have to adjust the URLs and/or encounter issues. If so, please report on GitHub! 
+
+### Configuring the link to the secure target CiviCRM
+
+Next thing you want to configure is what your target CiviCRM is. This is the CiviCRM installation which you want CiviProxy to police, so the one where the actual data resides and is collected from or sent to.
+
+The assumption is that this CiviCRM resides in some kind of VPN and will accept traffic only from the CiviProxy IP address (and probably a few trusted others like home workers or support people).
+You can set the URL of the target CiviCRM using the variable `$target_civirm` in the `config.php` file. Again, I have used a local test installation:
+```php
+ // this should point to the target CiviCRM system
+ $target_civicrm = 'http://localhost/ehdev';
+```
+### Setting for the click tracking url
+There is a setting in CiviCRM which is used for tracking the clicks in your mailing. On your CiviProxy server this setting is captured in the variable `$target_url` in the `config.php` file:
+```php
+$target_url       = $target_civicrm . '/civicrm/mailing/url';
+```
+If you set it to the value NULL this functionality will not be available on your CiviProxy server.
+### Setting for the open tracking
+CiviCRM tracks if a mailing has been opened in a certain way. CiviProxy has this setting in the variable `$target_open` in the `config.php` file:
+```php
+$target_open      = $target_civicrm . '/civicrm/mailing/url/open.php';
+```
+If you set it to the value NULL this functionality will not be available on your CiviProxy server.
+### Setting for the location of images and included files in your mail(ing)
+CiviCRM stores images and attachments you include in your (bulk) mail in a specific folder. In CiviProxy the name of this folder is stored in variable `$target_file` in the `config.php` file:
+```php
+$target_file      = $target_civicrm . '/sites/default/files/civicrm/persist/';
+```
+If you set it to the value NULL this functionality will not be available on your CiviProxy server.
+
+!!! note
+    By default CiviProxy will cache the files so it does not have to file from CiviCRM for each individual mail that is part of a bulk mailing. The default settings can be found in the `config.php` file:
+    ```php
+    /****************************************************************
+     **                   File Caching Options                     **
+     ****************************************************************/
+    // define file cache options, see http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php
+    $file_cache_options = array(
+        'cacheDir' => 'file_cache/',
+        'lifeTime' => 86400
+    );
+    // define regex patterns that shoud NOT be accepted
+    $file_cache_exclude = array();
+    // if set, cached file must match at least one of these regex patterns
+    $file_cache_include = array(
+            //'#.+[.](png|jpe?g|gif)#i'           // only media files
+    );
+    ```
+    You can update these settings if you should want to.
+
+    You can find documentation on the caching engine used in CiviProxy [here](http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php)
+### Setting for the view unformatted mail link
+If CiviCRM sends a mail you can get a link to view the mail unformatted. CiviProxy keeps this setting in a variable `$target_mail_view` in the `config.php` file:
+```php
+$target_mail_view = $target_civicrm . '/civicrm/mailing/view';
+```
+If you set it to the value NULL this functionality will not be available on your CiviProxy server.
+### Setting for the REST API requests
+When you want to use the CiviCRM API from another server than the one CiviCRM itself resides on you will do so using the REST interface.
+
+!!! seealso
+    Generic information on CiviCRM with REST [here](https://wiki.civicrm.org/confluence/display/CRMDOC/REST+interface)
+
+CiviProxy has a setting which specifies where the REST script is located in the variable `$target_rest` in the `config.php` file:
+```php
+$target_rest      = $target_civicrm . '/sites/all/modules/civicrm/extern/rest.php';
+```
+If you set it to the value NULL this functionality will not be available on your CiviProxy server.
+### Configuring the API key for (un)subscribe
+CiviCRM allows subscribe/unsubscribe links in mailings. To process these a user needs to be configured with a specific API key. In CiviProxy this API key is held in the `config.php` file in variable ``:
+```php
+$mail_subscription_user_key = 123teSt!ExaMpl1;
+```
+If you set it to the value NULL this functionality will not be available on your CiviProxy server.
+### Configuring the API and Site key
+To be able to access your target CiviCRM with the API using REST you will need to configure an API key and a site key. Actually, you will most likely need more to be able if more outside applications are allowed to access your target CiviCRM.
+
+!!! seealso
+    Generic information on CiviCRM with REST [here](https://wiki.civicrm.org/confluence/display/CRMDOC/REST+interface)
+
+In CiviProxy you can either store the API and Site keys directly in the `config.php` file or you can include a `secrets.php` file in your installation which holds your key values.
+
+Whatever method you prefer, you will have to end up with an array like the one below:
+```php
+$api_key_map = array('eR1k!tSt4321' => 'cal1Mer0#tST');
+$sys_key_map = array('1234#tsT#eR1k' => 'p1P0!tEst1Ng5678');
+```
+As you can see you can give the application that is accessing you different keys than the ones you use to access your target CiviCRM.
+
+So in this example I will explain to the party wanting to access my CiviProxy that they have to use the key _1234#tsT#eR1k_ and the api key _eR1k!tSt4321_. My target CiviCRM will expect site key _p1P0!tEst1Ng5678_ and the api key _cal1Mer0#tST_.
+
+### Whitelisting API requests
+Even if you have entered your API and Site key, and the setting for the target REST is ok, you will not be able to use any API calls through CiviProxy just yet. As CiviProxy uses the **whitelisting** principle by default **no** API calls are allowed unless they have been whilelisted.
+
+Also **parameter sanitation** is used. This means that only the specified parameters are allowed, and only content data of the specified type will be allowed.
+
+You can whitelist an API entity and action (and a set of allowed parameters) for all request from outside, but you can also whitelist an API entity and action ONLY if it comes from a specific IP address.
+
+!!! note
+    The address of the request is checked with the PHP variable `$_SERVER['REMOTE_ADDR']`
+
+In the example below you will see the possible configuration:
+
+* the API `Contact getsingle` with parameter `email` is allowed for all servers making a request to CiviProxy,
+* the API `Contact getsingle` with parameters `first_name` and `last_name` is only allowed if it is requested from IP address 123.45.678.1.
+
+```php
+$rest_allowed_actions = array(
+  'all' => array(
+    'Contact' => array(
+      'getsingle' => array(
+        'email' => 'string',
+      ),
+    ),
+  ),
+  '123.45.678.1' => array(
+    'Contact' => array(
+      'getsingle' => array(
+        'first_name' => 'string',
+        'last_name' => 'string',
+      ),
+    ),
+  ),
+);
+```
+
+!!! note
+    In earlier versions of CiviProxy this format was allowed for `$rest_allowed_actions`:
+    ```php
+    $rest_allowed_actions = array(
+    	'Contact' => array(
+    		'getsingle' => array(
+    			'email' => 'string',
+    		),
+    	),
+    );
+    ```
+    That format will still work, but is considered **deprecated** and you are encouraged to adapt to the new format described in the section above.
+
+!!! caution
+    A little bit of developer background....Obviously you can use the core CiviCRM API's but you have to think carefully of the parameter sanitation. Techically what happens is that if any parameters are passed to CiviProxy that are not _allowed_, they are ignored when the API request is passed to CiviCRM. This could lead to undesired behaviour. Consider this example:
+
+    * we have allowed the `Contact Get` API with only the parameter `email`
+
+    * the request we get in CiviProxy has the `Contact Get` but the parameters `first_name` and `last_name`
+
+    * because `first_name` and `last_name` are not whitelisted, they get ignored and a `Contact Get` without parameters if passed to the target CiviCRM, returning the first 25 contacts are a result...which is not what we wanted.
+
+    We recommend solving these situations by developing specific API's rather than using the core ones. And if you think of a good solution feel free to raise an issue or do a PR!
+
+### Debug setting
+CiviProxy has a `$debug` setting which allows you to add the name of a text file where all requests are send to. This can be used during the initial testing to see if everything is processed correcty.
+```php
+// CAREFUL: only enable temporarily on debug systems. Will log all queries to given PUBLIC file
+$debug                      = NULL; //'debug.log';
+```
+If you set the `$debug` setting to NULL this feature will not be used.
+
+!!! warning
+    We recommend only using this debug feature in the testing face, never on an active production installation as it can produce a massive log file quite easily.
+### Target Interface setting
+There is a setting for a local network interface or IP to be used for relayed queries. If you have no idea what this is about, just leave it as is.
+```php
+// Local network interface or IP to be used for the relayed query
+// This is usefull in some VPN configurations (see CURLOPT_INTERFACE)
+$target_interface           = NULL;
+```
+
+!!! tip
+    We do advice you to monitor what request are still being fired directly to your target CiviCRM once you installed and configured CiviProxy, and then find solutions for the situations if you still see some undesired access requests.

docs/enhancements.md

@@ -0,0 +1,5 @@
+# Future enhancements for CiviProxy
+At the moment there are a few future enhancements, bug fixes and small suggested changes, as you can see on the [issue list](https://github.com/systopia/CiviProxy/issues).
+
+!!! tip
+    If you want to report bugs or suggest future enhancements please do so on the [issue list](https://github.com/systopia/CiviProxy/issues).

docs/index.md

@@ -0,0 +1,68 @@
+# Introduction
+
+## Public facing website and CiviCRM
+In the CiviCRM world it is a fairly typical requirement to want your public facing website and CiviCRM to communicate with each other.
+You would probably want to do stuff like:
+
+* Allow website visitors to sign a petition, make a donation or register for an event.
+* Allow registered website visitors to view and perhaps update their own data.
+* Get website visitors to sign up (or unsubscribe) for newsletters.
+
+However, for security and maintainability purposes it is recommended that you separate your CiviCRM installation and your public facing website. Factors that might influence this:
+
+* Your biggest security risk is probably your public facing website where you want the whole world to be able to check, browse and do stuff, even without identifying themselves.
+* The data you want to protect the most is quite likely to be part of CiviCRM (data on your donors, peope who sign petitions, email addresses etc.).
+* You will need to install security upgrades on your website regularly as this is exposed to the public. However, you do not want to test all your business processes with each upgrade (which you will need to do if you have both website and CiviCRM on the same server to be sure they continue to work together).
+
+So we think it is a sound practise to separate CiviCRM and your public facing website, and mainly use the CiviCRM API to send data to or get data from CiviCRM. 
+
+However, we do not want every authorized user to be able to use all the API possibilities. And we also do not want to allow any user access to the CiviCRM API.
+
+And that is where **CiviProxy** comes in!
+## How does it work?
+The basic idea is to first put your CiviCRM (with probably a dummy CMS which you could use for your intranet) server into a VPN. This makes the server virtually inaccessible from the internet, and your users or your whole office will access it via a secure connection.
+
+But what about your public web pages, donation pages, data exchange with other systems, API request? This is where CiviProxy comes in: You get a small, secure, extra server and give it access to both, the internet and your VPN. It will act as a safe gateway for selected features of your CiviCRM that you would like to expose.
+
+In an example picture:
+
+![a picture of an example network architecture](img/network.png)
+    
+The advantages in a nutshell :thumbsup:
+
+* CiviProxy is CiviCRM specific, so it kind of understands how CiviCRM works. It is **designed** to work with CiviCRM in a fairly simple way.
+* CiviProxy uses **whitelisting**. This means it starts with the principle _nothing is allowed_ and then lets you configure what is allowed, rather than the other way around.
+* CiviProxy uses **parameter sanitation**, meaning that only named parameters are allowed, and then only with the allowed content type (string, integer etc.).
+## What can it do?
+Currently CiviProxy can expose/relay the following CiviCRM functions
+
+1. Serve resources for newsletters and mailings.
+1. Cache those resources, taking load off your CiviCRM server.
+1. Pass-through of tracking data on opening and click-through rates.
+1. Sign-on and off of your newsletter (Webpage templates).
+1. Relay of whitelisted REST API calls for data exchange with other systems.
+1. Perform input sanitation and parameter whitelisting for the REST API calls.
+
+!!! attention
+    This software has not (yet) been audited for security.
+## Why not an application firewall?
+The traditional approach to this problem would be an application firewall / reverse proxy setup. However, CiviCRM can have very complex interactions with other systems (e.g. via the API), and a malicious request can sometimes only be detected by understanding the meaning of the individual parameters.
+
+Creating firewall rules for this level of detail is very complex and is very hard to maintain.
+
+For this reason we wanted to take another approach and build a simple "bridgehead" system that *understands* CiviCRM, thus making its configuration and maintenance as easy as possible.
+
+## Contents of this guide
+In this guide you will find pages on:
+
+* [technical requirements for CiviProxy](requirements.md)
+* [how to install CiviProxy](installation.md)
+* [how to configure CiviProxy](configuration.md)
+* [what to do if an outside application wants to communicate with CiviProxy](outside.md)
+* [future enhancements for CiviProxy](enhancements.md)
+
+!!! note
+    This documentation is based on release 0.4 of CiviProxy. 
+    
+!!! note
+    In the guide we assume Drupal is the CMS of your target CiviCRM. Most of the stuff is CMS agnostic but you might have to change some of the URL's in the examples. 

docs/installation.md

@@ -0,0 +1,56 @@
+# Installation
+CiviProxy has to run on its own server (with its own IP address) for maximum effect.
+
+The best option for a server on which you can install CiviProxy is a simple managed webspace, that you can rent cheaply from the hoster of your choice. It should have its own IP address, but other than that there are virtually no restrictions. This approach comes with a lot of advantages:
+
+* Since there are a multitude of clients like you on such a server, the level of security can be expected to be very high, and it should be managed and monitored by professionals 24/7.
+* For the same reason, the bandwith and connectivity of such a server should be very high as well.
+* The price should not have to be huge.
+
+!!! note
+    Obviously there is nothing stopping you from installing CiviProxy on a server you manage yourself, but that then automatically means you have to ensure you maintain a high level of security and update the stuff regularly!
+
+Installing CiviProxy should be pretty straightforward:
+
+* Download the GitHub repository from [https://github.com/systopia/CiviProxy](https://github.com/systopia/CiviProxy).
+* In your repository are actually two relevant parts:
+
+    * A CiviCRM extension called **de.systopia.civiproxy** that you can use to send mailings (newsletters) from CiviCRM. This should be installed on your target CiviCRM installation.
+    * A **proxy** folder with the scripts that you need to install on your CiviProxy server.
+    * On top of that there will also be a **docs** folder containing this guide and a few necessary files (which are needed but you can ignore):
+        * LIBRARIES.md
+        * LICENSE
+        * README.md
+        * mkdocs.yml
+## Installing the CiviCRM extension on your target CiviCRM
+* copy the folder **de.systopia.civiproxy** that you downloaded in the previous step into your CiviCRM extensions folder. You should be able to find your civicrm extensions folder in **Administer>System Settings>Directories**. If you have never touched or changed this it will look like screen print below. In that case your folder is probably `<your civicrm folder>/sites/default/files/civicrm/ext/`
+
+!!! seealso
+    ![Screen print of the Administer>System Settings>Directories form](img/civicrm_directories.png)
+
+* go to **Administer>System Settings>Extensions** to see a page with all the installed extensions on your CiviCRM installation. You will have to click the **Refresh** button to see the **de.systopia.civiproxy** extension. Click the **Install** action listed behind the extension information. Upon successfull installation you should see a list like the one below (although you will probably see a larger list as you will have more extensions installed).
+
+!!! seealso
+    ![Screen print of the extensions page after successfull installation](img/extensions_list.png)
+
+* type the URL`http://example.org/civicrm/clearcache` to clear the caches and rebuild the menu. This is necessary to add the CiviProxy settings page to CiviCRM.
+
+!!! note
+    use the URL `http://example.org/?q=civicrm/clearcache` if CleanUrls are not enabled
+
+* you should now be able to access the CiviProxy Settings page with **Administer>Administration Console** (in the menu section System Settings) or with the URL `http://example.org/civicrm/admin/setting/civiproxy`.
+
+!!! note
+    use the URL `http://example.org/?q=civicrm/admin/setting/civiproxy` if CleanUrls are not enabled
+
+!!! note
+    If you want to you can add the CiviProxy Settings page to your Administration menu with Administer/Customize Data and Screens/Navigation Menu.
+
+* check the [Configuring CiviProxy](configuration.md) page to see how to configure the CiviProxy extension.
+
+## Installing the Proxy scripts your your CiviProxy server
+
+1. Copy the **proxy** folder on the webspace you want to use for CiviProxy
+2. Create a `config.php` file using `config.dist.php` as a template.
+
+See [Configuring CiviProxy](configuration.md) for  details on what you need to include in the `config.php` file.

docs/outside.md

@@ -0,0 +1,12 @@
+# What to do if an outside application wants to communicate with CiviProxy
+In most cases when an outside application (for example the public website, or maybe even a  center webservice) wants to access CiviProxy to be able to retreive data from CiviCRM or send data to CiviCRM they will want to use the API. 
+
+In that case you should provide them with the Site key and an API key they can use. We recommend you do NOT use the CiviCRM Site Key and API Key.
+
+!!! tip
+    If you do not know how to do this check [Configuring CiviProxy](configuration.md).
+ 
+They will have to use your CiviProxy URL in their REST request, and you will need to provide them with that URL. In my local example the call to the CiviProxy server would be:
+```
+http://localhost/proxy/rest.php?entity=Contact&action=getsingle&key=erikhtestkey&version=3&json=1&api_key=testerikhapikey&email=pipotest@example.org
+```

docs/requirements.md

@@ -0,0 +1,10 @@
+# Technical Requirements
+
+There shouldn't be any requirements that any web hoster wouldn't comply with, but here they are:
+
+ 1. PHP 5.3+
+ 2. PHP PEAR (to install on Debian/Ubuntu, run `apt-get install php-pear`)
+ 3. The `php-curl` module
+ 4. Read/write permissions on your webspace
+ 5. Reasonable amount of protection, i.e. only authorised users (you) can upload/download the files
+ 6. Ideally with it's own IP address (makes configuring the VPN easier)

mkdocs.yml

@@ -0,0 +1,25 @@
+site_name: CiviProxy Guide
+site_description: Guide using and installing CiviProxy to manage the traffic to and from your CiviCRM installation
+repo_url: https://github.com/systopia/CiviProxy
+theme: 
+  name: material
+nav:
+- Introduction: index.md
+- Technical Requirements: requirements.md
+- Installing CiviProxy: installation.md
+- Configuring CiviProxy: configuration.md
+- Directing an outside application to CiviProxy: outside.md
+- Future enhancements to CiviProxy: enhancements.md
+
+markdown_extensions:
+  - attr_list
+  - admonition
+  - def_list
+  - codehilite
+  - toc:
+      permalink: true
+  - pymdownx.superfences
+  - pymdownx.emoji
+
+
+

proxy/.htaccess

@@ -0,0 +1,6 @@
+# Serve
+<IfModule mod_rewrite.c>
+  RewriteEngine on
+  RewriteCond %{REQUEST_URI} ^/civicrm/ajax/api4
+  RewriteRule ^civicrm/ajax/api4/([^/]*)/([^/]*) rest4.php?entity=$1&action=$2 [QSA,B]
+</IfModule>

proxy/checks.php

@@ -0,0 +1,82 @@
+<?php
+
+/**
+ * generates a CiviCRM REST API compliant error
+ * and ends processing
+ */
+function civiproxy_rest_error($message) {
+  $error = array( 'is_error'      => 1,
+                  'error_message' => $message);
+  // TODO: Implement header();
+  print json_encode($error);
+  exit();
+}
+
+/**
+ * Updates $credentials['api_key'] in-place, or displays an error if api key
+ * is missing or does not correspond to an entry in $api_key_map (which should
+ * be set in config.php).
+ * @param array $credentials
+ * @param array $api_key_map
+ */
+function civiproxy_map_api_key(array &$credentials, array $api_key_map) {
+  if (empty($credentials['api_key'])) {
+    civiproxy_rest_error("No API key given");
+  }
+  else {
+    if (isset($api_key_map[$credentials['api_key']])) {
+      $credentials['api_key'] = $api_key_map[$credentials['api_key']];
+    }
+    else {
+      civiproxy_rest_error("Invalid api key");
+    }
+  }
+}
+
+/**
+ * Updates $credentials['key'] in-place, or displays an error if site key
+ * is missing or does not correspond to an entry in $sys_key_map (which should
+ * be set in config.php).
+ * @param array $credentials
+ * @param array $sys_key_map
+ */
+function civiproxy_map_site_key(array &$credentials, array $sys_key_map) {
+  if (empty($credentials['key'])) {
+    civiproxy_rest_error("No site key given");
+  }
+  else {
+    if (isset($sys_key_map[$credentials['key']])) {
+      $credentials['key'] = $sys_key_map[$credentials['key']];
+    }
+	else {
+      civiproxy_rest_error("Invalid site key");
+    }
+  }
+}
+
+/**
+ * @param array $action should have both 'entity' and 'action' keys set
+ * @param array $rest_allowed_actions from config.php
+ * @return array
+ */
+function civiproxy_get_valid_parameters(array $action, array $rest_allowed_actions) {
+  // in release 0.4, allowed entity/actions per IP were introduced. To introduce backward compatibility,
+  // the previous test is still used when no 'all' key is found in the array
+  if (isset($rest_allowed_actions['all'])) {
+    // get valid key for the rest_allowed_actions
+    $valid_allowed_key = civiproxy_get_valid_allowed_actions_key($action, $rest_allowed_actions);
+    $valid_parameters = civiproxy_retrieve_api_parameters($valid_allowed_key, $action['entity'], $action['action'], $rest_allowed_actions);
+    if (!$valid_parameters) {
+      civiproxy_rest_error("Invalid entity/action.");
+    }
+  }
+  else {
+    if (isset($rest_allowed_actions[$action['entity']]) && isset($rest_allowed_actions[$action['entity']][$action['action']])) {
+      $valid_parameters = $rest_allowed_actions[$action['entity']][$action['action']];
+    }
+    else {
+      civiproxy_rest_error("Invalid entity/action.");
+    }
+  }
+  return $valid_parameters;
+}

proxy/config.dist.php

@@ -0,0 +1,217 @@
+<?php
+/*--------------------------------------------------------+
+| SYSTOPIA CiviProxy                                      |
+|  a simple proxy solution for external access to CiviCRM |
+|                                                         |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
+| Author: B. Endres (endres -at- systopia.de)             |
+| http://www.systopia.de/                                 |
++---------------------------------------------------------*/
+
+
+/****************************************************************
+ **                      INSTALLATION                          **
+ **                                                            **
+ **  0. Read https://docs.civicrm.org/civiproxy/en/latest      **
+ **  1. Make a copy of this file called config.php             **
+ **  2. Adjust the parameters and enable needed features       **
+ **  3. Some features (like mailings) require the CiviProxy    **
+ **     extension to be enabled on the target CiviCRM          **
+ **                                                            **
+ ****************************************************************/
+
+
+
+
+/****************************************************************
+ **                            URLS                            **
+ ****************************************************************/
+// this should point to the base address of the CiviProxy installation
+$proxy_base     = 'https://proxy.yourdomain.org';
+
+// this should point to the target CiviCRM system
+$target_civicrm = 'https://your.civicrm.installation.org';
+
+
+/****************************************************************
+ **                FEATURES / DEFAULT PATHS                    **
+ **                                                            **
+ **          set to NULL to disable a feature                  **
+ ****************************************************************/
+
+// default paths, override if you want. Set to NULL to disable
+$target_rest      = $target_civicrm . '/sites/all/modules/civicrm/extern/rest.php';
+// base URL for api4 calls. Will append entity and action path segments
+$target_rest4     = $target_civicrm . '/civicrm/ajax/api4/';
+$target_file      = $target_civicrm . '/sites/default/files/civicrm/persist/';
+$target_mosaico   = NULL; // (disabled by default): $target_civicrm . '/civicrm/mosaico/img?src=';
+$target_mosaico_template_url = NULL; // (disabled by default): $target_civicrm . '/wp-content/uploads/civicrm/ext/uk.co.vedaconsulting.mosaico/packages/mosaico/templates/';
+$target_mail_view = $target_civicrm . '/civicrm/mailing/view';
+$target_url       = $target_civicrm . '/civicrm/mailing/url';
+$target_open      = $target_civicrm . '/civicrm/mailing/open';
+
+// CAUTION: use the following for CiviCRM < 5.27 or "Extern URL Style" = "Standalone Scripts" 
+//$target_url       = $target_civicrm . '/sites/all/modules/civicrm/extern/url.php';
+//$target_open      = $target_civicrm . '/sites/all/modules/civicrm/extern/open.php';
+
+/****************************************************************
+ **                    GENERAL OPTIONS                         **
+ ****************************************************************/
+
+// This logo is shown if the proxy server is address with a web browser
+//  add your own logo here
+$civiproxy_logo = "<img src='{$proxy_base}/static/images/proxy-logo.png' alt='SYSTOPIA Organisationsberatung'></img>";
+
+// Set api-key for mail subscribe/unsubscribe user
+// Set to NULL/FALSE to disable the feature
+// Can/shoud also be defined in secrets.php
+$mail_subscription_user_key = NULL;
+
+// CAREFUL: only enable temporarily on debug systems.
+//  Will log all queries to given PUBLIC file
+//  Also: use some random name (not this one!)
+$debug                      = NULL; //'LUXFbiaoz4dVWuAHEcuBAe7YQ4YP96rN4MCDmKj89p.log';
+
+// Local network interface or IP to be used for the relayed query
+// This is useful in some VPN configurations (see CURLOPT_INTERFACE)
+$target_interface           = NULL;
+
+
+/***************************************************************
+ **                Authentication Options                     **
+ ***************************************************************/
+// API and SITE keys (you may add keys here)
+$api_key_map = [
+  'my_api_key'   => 'my_api_key',   // use this to allow API key
+  'ext_api_key'  => 'real_api_key'  // use this to allow and map API key
+];
+$sys_key_map = [
+  'REAL_SITE_KEY' => 'REAL_SITE_KEY', // use this to allow site key
+  'EXT_SITE_KEY'  => 'REAL_SITE_KEY'  // use this to allow and map site key
+];
+
+// source secrets.php to overwrite keys
+if (file_exists(dirname(__FILE__)."/secrets.php")) {
+  // keys can also be stored in 'secrets.php'
+  require "secrets.php";
+}
+
+// Parameter whitelisting for open tracking and URL tracking
+// basic civicrm URL/open parameter are u, q and qid (as int)
+// If additional parameters are needed, best practise would be to whitelist each one as needed in
+// $valid_url_parameters and/or $valid_open_parameters.
+// Alternatively it is also possible to allow all parameters with the wildcard parameter '*' => 'string'
+$valid_url_parameters = [
+    'u'   => 'int',
+    'q'   => 'int',
+    'qid' => 'int',
+//    '*'   => 'string'     // whildcard, whitelist all url parameters
+];
+$valid_open_parameters = [
+    'u'   => 'int',
+    'q'   => 'int',
+    'qid' => 'int',
+//    '*'   => 'string'     // wildcard, whitelist *all* open parameters
+];
+// CiviCRM's API can authenticate with different flows
+// https://docs.civicrm.org/dev/en/latest/framework/authx/#flows
+// CiviProxy supports 'header', 'xheader', 'legacyrest', and 'param'.
+// These flows are supported for API4 but could be extended to API3.
+// $authx_internal_flow controls how CiviProxy sends credentials to CiviCRM, and
+// $authx_external_flow where CiviProxy looks for credentials on incoming requests.
+// The internal setting needs to have a single scalar value, but the
+// external setting can be an array of accepted flows.
+// There is no standard header for site key, so in both header and xheader
+// flows it uses X-Civi-Key
+$authx_internal_flow = 'header';
+$authx_external_flow = ['legacyrest'];
+
+
+/****************************************************************
+ **                   File Caching Options                     **
+ ****************************************************************/
+
+// define file cache options, see http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php
+$file_cache_options = [
+    'cacheDir' => 'file_cache/',
+    'lifeTime' => 86400
+];
+
+// define regex patterns that shoud NOT be accepted
+$file_cache_exclude = [];
+
+// if set, cached file must match at least one of these regex patterns
+$file_cache_include = [
+        //'#.+[.](png|jpe?g|gif)#i'           // only media files
+    ];
+
+
+
+/****************************************************************
+ **                   REST API OPTIONS                         **
+ ****************************************************************/
+
+// if you enable this, the system will also try to
+// parse the 'json' parameter, which holds additional
+// input data according to the CiviCRM REST API specs
+$rest_evaluate_json_parameter = FALSE;
+
+// whitelisting is done per IP address ($_SERVER['REMOTE_ADDR']) with a 'all' for the generic stuff that applies to all IP addresses
+// - if a request comes in and the IP is not a key in the array, the whitelisted in 'all' are used
+// - if a request comes in and the IP is indeed a key in the array, the whitelisted in the IP are checked first. If nothing is
+//   found ,the 'all' ones are checked next.
+$rest_allowed_actions = [
+  'all' => [
+    'Contact' => [
+      'getsingle' => [
+        'email' => 'string',
+      ],
+    ],
+  ],
+  '123.45.67.8' => [
+    'Contact' => [
+      'getsingle' => [
+        'first_name' => 'string',
+        'last_name' => 'string',
+        // the following means *all* remaining parameters will be
+        //   added and sanitised as 'string'. Better leave it out
+        //   if you know which parameters you expect
+        '*' => 'string',
+      ],
+    ],
+  ],
+];
+
+
+/****************************************************************
+ **                WebHook2API CONFIGURATIONS                  **
+ **  Translates typical webhook calls into CiviCRM API calls   **
+ ****************************************************************/
+// Example configuration:
+// remove if you don't want this feature or rename to $webhook2api to activate
+$_webhook2api = [
+    "configurations" => [
+        "default" => [
+            "name"                 => "Example",
+            "ip_sources"           => ['172.10.0.1/24', '192.168.1.1/24'],  // only accept source ID from the given range
+            "data_sources"         => ["POST/json", "REQUEST"],             // POST/json json-decodes the post data, REQUEST is PHP's $_REQUEST array
+            "sentinel"             => [["type", "equal:customer.created"]], // only execute if all of these are true
+            "entity"               => "Contact",
+            "action"               => "create",
+            "api_key"              => "api key",
+            "parameter_mapping"    => [
+                [["data", "object", "metadata", "salutation"], ["prefix_id"]],
+                [["data", "object", "metadata", "first_name"], ["first_name"]],
+                [["data", "object", "metadata", "last_name"],  ["last_name"]],
+                [["data", "object", "metadata", "street"],     ["street_address"]],
+                [["data", "object", "metadata", "zip_code"],   ["postal_code"]],
+                [["data", "object", "metadata", "city"],       ["city"]],
+                [["data", "object", "metadata", "country"],    ["country_id"]],
+                [["data", "object", "metadata", "telephone"],  ["phone"]],
+                [["data", "object", "metadata", "birthday"],   ["birth_date"]],
+                [["data", "object", "metadata", "email"],      ["email"]]
+            ],
+            "parameter_sanitation" => [],
+        ]
+    ]
+];

proxy/config.php

@@ -1,81 +0,0 @@
-<?php
-/*--------------------------------------------------------+
-| SYSTOPIA CiviProxy                                      |
-|  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
-| Author: B. Endres (endres -at- systopia.de)             |
-| http://www.systopia.de/                                 |
-+---------------------------------------------------------*/
-
-
-/****************************************************************
- **                            URLS                            **
- ****************************************************************/
-// this should point to the base address of the CiviProxy installation
-$proxy_base     = 'https://proxy.yourdomain.org';
-
-// this should point to the target CiviCRM system
-$target_civicrm = 'https://your.civicrm.installation.org';
-
-
-/****************************************************************
- **                      DEFAULT PATHS                         **
- **                                                            **
- **          set to NULL to disable a feature                  **
- ****************************************************************/
-
-// default paths, override if you want. Set to NULL to disable
-$target_rest      = $target_civicrm . '/sites/all/modules/civicrm/extern/rest.php';
-$target_url       = $target_civicrm . '/sites/all/modules/civicrm/extern/url.php';
-$target_open      = $target_civicrm . '/sites/all/modules/civicrm/extern/open.php';
-$target_file      = $target_civicrm . '/sites/default/files/civicrm/persist/';
-$target_mail_view = $target_civicrm . '/civicrm/mailing/view';
-
-// Set api-key for mail subscribe/unsubscribe user
-// Set to NULL/FALSE to disable the feature
-$mail_subscription_user_key = NULL;
-
-// CAREFUL: only enable temporarily on debug systems. Will log all queries to given PUBLIC file
-$debug                      = NULL; //'debug.log';
-
-
-/****************************************************************
- **                   File Caching Options                     **
- ****************************************************************/
-
-// API and SITE keys
-$api_key_map = array();
-$sys_key_map = array();
-
-if (file_exists(dirname(__FILE__)."/secrets.php")) {
-  // keys can also be stored in 'secrets.php'
-  require "secrets.php";
-}
-
-// define file cache options, see http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php
-$file_cache_options = array(
-    'cacheDir' => 'file_cache/',
-    'lifeTime' => 86400
-);
-
-// define regex patterns that shoud NOT be accepted
-$file_cache_exclude = array();
-
-// if set, cached file must match at least one of these regex patterns
-$file_cache_include = array(
-        //'#.+[.](png|jpe?g|gif)#i'           // only media files
-    );
-
-
-
-/****************************************************************
- **                   REST API OPTIONS                         **
- ****************************************************************/
-$rest_allowed_actions = array(
-  // this is an example:
-  'Contact' => array(
-      'getsingle'      => array(
-                            'email' => 'string'
-                            ),
-    )
-  );

proxy/error.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -15,7 +15,6 @@ require_once "proxy.php";
  <head>
   <meta charset="UTF-8">
   <title>CiviProxy Error</title>
-  <link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
   <style type="text/css">
     body {
       margin: 0;

proxy/file.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -76,7 +76,10 @@ curl_setopt($curlSession, CURLOPT_URL, $url);
 curl_setopt($curlSession, CURLOPT_HEADER, 1);
 curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
 curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
-curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 1);
+curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
+if (!empty($target_interface)) {
+  curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
+}
 if (file_exists(dirname(__FILE__).'/target.pem')) {
   curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
 }

proxy/index.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -16,7 +16,6 @@ require_once "proxy.php";
  <head>
   <meta charset="UTF-8">
   <title>CiviProxy Version <?php echo $civiproxy_version;?></title>
-  <link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
   <style type="text/css">
     body {
       margin: 0;

proxy/libs/Cache/Lite.php

@@ -294,7 +294,7 @@ class Cache_Lite
     * @param array $options options
     * @access public
     */
-    function Cache_Lite($options = array(NULL))
+    function __construct($options = array(NULL))
     {
         foreach($options as $key => $value) {
             $this->setOption($key, $value);
@@ -304,6 +304,16 @@ class Cache_Lite
         }
     }
 
+    /**
+     * PHP4 constructor for backwards compatibility with older code
+     *
+     * @param array $options Options
+     */
+    function Cache_Lite($options = array(NULL))
+    {
+        self::__construct($options);
+    }
+
     /**
     * Generic way to set a Cache_Lite option
     *
@@ -554,7 +564,6 @@ class Cache_Lite
     */
     function raiseError($msg, $code)
     {
-        include_once('PEAR.php');
         return PEAR::raiseError($msg, $code, $this->_pearErrorMode);
     }
 
@@ -629,7 +638,7 @@ class Cache_Lite
                 return true;
             }
         }
-        if (!($dh = opendir($dir))) {
+        if (!($dh = @opendir($dir))) {
             return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
         }
         $result = true;
@@ -698,8 +707,10 @@ class Cache_Lite
         $this->_touchCacheFile();
         $this->_memoryCachingArray[$this->_file] = $data;
         if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) {
-            list($key, ) = each($this->_memoryCachingArray);
+            $key = key($this->_memoryCachingArray);
+            next($this->_memoryCachingArray);
             unset($this->_memoryCachingArray[$key]);
+
         } else {
             $this->_memoryCachingCounter = $this->_memoryCachingCounter + 1;
         }
@@ -744,7 +755,7 @@ class Cache_Lite
 	    if ($this->_fileLocking) @flock($fp, LOCK_SH);
             clearstatcache();
             $length = @filesize($this->_file);
-            $mqr = get_magic_quotes_runtime();
+            $mqr = (function_exists('get_magic_quotes_runtime') ? @get_magic_quotes_runtime() : 0);
             if ($mqr) {
                 set_magic_quotes_runtime(0);
             }
@@ -823,7 +834,7 @@ class Cache_Lite
             if ($this->_readControl) {
                 @fwrite($fp, $this->_hash($data, $this->_readControlType), 32);
             }
-            $mqr = get_magic_quotes_runtime();
+            $mqr = (function_exists('get_magic_quotes_runtime') ? @get_magic_quotes_runtime() : 0);
             if ($mqr) {
                 set_magic_quotes_runtime(0);
             }

proxy/libs/Cache/Lite/File.php

@@ -52,10 +52,10 @@ class Cache_Lite_File extends Cache_Lite
     * @param array $options options
     * @access public
     */
-    function Cache_Lite_File($options = array(NULL))
+    function __construct($options = array(NULL))
     {   
         $options['lifetime'] = 0;
-        $this->Cache_Lite($options);
+        parent::__construct($options);
         if (isset($options['masterFile'])) {
             $this->_masterFile = $options['masterFile'];
         } else {
@@ -66,6 +66,16 @@ class Cache_Lite_File extends Cache_Lite
         }
     }
 
+    /**
+     * PHP4 constructor for backwards compatibility with older code
+     *
+     * @param array $options Options
+     */
+    function Cache_Lite_File($options = array(NULL))
+    {
+        self::__construct($options);
+    }
+    
     /**
     * Test if a cache is available and (if yes) return it
     *

proxy/libs/Cache/Lite/Function.php

@@ -81,17 +81,27 @@ class Cache_Lite_Function extends Cache_Lite
     * @param array $options options
     * @access public
     */
-    function Cache_Lite_Function($options = array(NULL))
+    function __construct($options = array(NULL))
     {
         $availableOptions = array('debugCacheLiteFunction', 'defaultGroup', 'dontCacheWhenTheOutputContainsNOCACHE', 'dontCacheWhenTheResultIsFalse', 'dontCacheWhenTheResultIsNull');
-        while (list($name, $value) = each($options)) {
+        foreach ($options as $name => $value) {
             if (in_array($name, $availableOptions)) {
                 $property = '_'.$name;
                 $this->$property = $value;
             }
         }
         reset($options);
-        $this->Cache_Lite($options);
+        parent::__construct($options);
+    }
+
+    /**
+     * PHP4 constructor for backwards compatibility with older code
+     *
+     * @param array $options Options
+     */
+    function Cache_Lite_Function($options = array(NULL))
+    {
+        self::__construct($options);
     }
 
     /**

proxy/libs/Cache/Lite/Output.php

@@ -26,9 +26,19 @@ class Cache_Lite_Output extends Cache_Lite
     * @param array $options options
     * @access public
     */
-    function Cache_Lite_Output($options)
+    function __construct($options)
     {
-        $this->Cache_Lite($options);
+        parent::__construct($options);
+    }
+
+    /**
+     * PHP4 constructor for backwards compatibility with older code
+     *
+     * @param array $options Options
+     */
+    function Cache_Lite_Output($options = array(NULL))
+    {
+        self::__construct($options);
     }
 
     /**

proxy/libs/Cache/README.md

@@ -1,19 +1,25 @@
 # PEAR Cache_Lite
 
+Fast and safe little cache system.
+
+This package is a little cache system optimized for file containers.
+t is fast and safe (because it uses file locking and/or anti-corruption tests).
+
 [![Build Status](https://travis-ci.org/pear/Cache_Lite.svg)](https://travis-ci.org/pear/Cache_Lite)
 
-This package is [Cache_Lite](http://pear.php.net/package/Cache_Lite).
-
-Please report all new issues via the [PEAR bug tracker](http://pear.php.net/bugs/).
 
+## Building
 To test this package, run
 
     phpunit tests/
 
-To build, simply
+To build, simply execute
 
     pear package
 
+
+## Installation
+### PEAR
 To install from scratch
 
     pear install package.xml
@@ -21,3 +27,15 @@ To install from scratch
 To upgrade
 
     pear upgrade -f package.xml
+
+### Composer
+
+    composer require pear/cache_lite
+
+
+## Links
+- Homepage: http://pear.php.net/package/Cache_Lite
+- Source code: https://github.com/pear/Cache_Lite
+- Issue tracker: http://pear.php.net/bugs/search.php?cmd=display&package_name[]=Cache_Lite
+- Unit test status: https://travis-ci.org/pear/Cache_Lite
+- Packagist: https://packagist.org/packages/pear/cache_lite

proxy/mailing/confirm.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -19,7 +19,7 @@ civiproxy_security_check('mail-confirm');
 // basic restraints
 $valid_parameters = array(    'sid'          => 'int',
                               'cid'          => 'int', 
-                              'h'            => 'hex');
+                              'h'            => 'string');
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if parameters specified
@@ -45,7 +45,6 @@ if (!empty($group_query['is_error'])) {
  <head>
   <meta charset="UTF-8">
   <title>CiviProxy Version <?php echo $civiproxy_version;?></title>
-  <link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
   <style type="text/css">
     body {
       margin: 0;

proxy/mailing/mail.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -17,7 +17,7 @@ if (!$target_mail_view) civiproxy_http_error("Feature disabled", 405);
 civiproxy_security_check('mail-view');
 
 // basic restraints
-$valid_parameters = array(  'id'   => 'int'  );
+$valid_parameters = array(  'id'   => 'int', 'cid' => 'int', 'cs' => 'string'  );
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if id specified

proxy/mailing/optout.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/

proxy/mailing/resubscribe.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -19,7 +19,7 @@ civiproxy_security_check('mail-resubscribe');
 // basic restraints
 $valid_parameters = array(    'jid'          => 'int',
                               'qid'          => 'int', 
-                              'h'            => 'hex');
+                              'h'            => 'string');
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if parameters specified
@@ -45,7 +45,6 @@ if (!empty($group_query['is_error'])) {
  <head>
   <meta charset="UTF-8">
   <title>CiviProxy Version <?php echo $civiproxy_version;?></title>
-  <link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
   <style type="text/css">
     body {
       margin: 0;

proxy/mailing/subscribe.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -83,7 +83,6 @@ if (!empty($_REQUEST['email'])) {
  <head>
   <meta charset="UTF-8">
   <title>CiviProxy Version <?php echo $civiproxy_version;?></title>
-  <link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
   <style type="text/css">
     body {
       margin: 0;

proxy/mailing/unsubscribe.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -19,7 +19,7 @@ civiproxy_security_check('mail-unsubscribe');
 // basic restraints
 $valid_parameters = array(    'jid'          => 'int',
                               'qid'          => 'int', 
-                              'h'            => 'hex');
+                              'h'            => 'string');
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if parameters specified
@@ -45,7 +45,6 @@ if (!empty($group_query['is_error'])) {
  <head>
   <meta charset="UTF-8">
   <title>CiviProxy Version <?php echo $civiproxy_version;?></title>
-  <link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
   <style type="text/css">
     body {
       margin: 0;

proxy/mosaico.php

@@ -0,0 +1,146 @@
+<?php
+/*--------------------------------------------------------+
+| SYSTOPIA CiviProxy                                      |
+|  a simple proxy solution for external access to CiviCRM |
+| Copyright (C) 2017-2021 SYSTOPIA                        |
+| Author: B. Endres (endres -at- systopia.de)             |
+| http://www.systopia.de/                                 |
++---------------------------------------------------------*/
+
+require_once "config.php";
+require_once "proxy.php";
+
+// see if file caching is enabled
+if (!$target_mosaico) civiproxy_http_error("Feature disabled", 405);
+
+// basic check
+civiproxy_security_check('file');
+
+// basic restraints
+$valid_parameters = array( 'id'   => 'string', 'template_url' => 'string' );
+$parameters = civiproxy_get_parameters($valid_parameters);
+
+if (!empty($parameters['id'])) {
+  // check restrictions
+  if (!empty($file_cache_exclude)) {
+    foreach ($file_cache_exclude as $pattern) {
+      if (preg_match($pattern, $parameters['id'])) {
+        civiproxy_http_error("Invalid Resource", 403);
+      }
+    }
+  }
+  if (!empty($file_cache_include)) {
+    $accept_id = FALSE;
+    foreach ($file_cache_include as $pattern) {
+      if (preg_match($pattern, $parameters['id'])) {
+        $accept_id = TRUE;
+      }
+    }
+    if (!$accept_id) {
+      civiproxy_http_error("Invalid Resource", 403);
+    }
+  }
+
+  // look up the required resource
+  $header_key = 'header&' . $parameters['id'];
+  $data_key   = 'data&'   . $parameters['id'];
+  $url = $target_mosaico . $parameters['id'];
+} elseif (!empty($parameters['template_url'])) {
+  // check restrictions
+  if (!empty($file_cache_exclude)) {
+    foreach ($file_cache_exclude as $pattern) {
+      if (preg_match($pattern, $parameters['template_url'])) {
+        civiproxy_http_error("Invalid Resource", 403);
+      }
+    }
+  }
+  if (!empty($file_cache_include)) {
+    $accept_id = FALSE;
+    foreach ($file_cache_include as $pattern) {
+      if (preg_match($pattern, $parameters['template_url'])) {
+        $accept_id = TRUE;
+      }
+    }
+    if (!$accept_id) {
+      civiproxy_http_error("Invalid Resource", 403);
+    }
+  }
+
+  // look up the required resource
+  $header_key = 'header&' . $parameters['template_url'];
+  $data_key   = 'data&'   . $parameters['template_url'];
+  $url = $target_mosaico_template_url . $parameters['template_url'];
+} else {
+  civiproxy_http_error("Resource not found");
+}
+
+// load PEAR file cache
+ini_set('include_path', ini_get('include_path') . PATH_SEPARATOR . 'libs');
+if (!file_exists($file_cache_options['cacheDir'])) mkdir($file_cache_options['cacheDir']);
+require_once('Cache/Lite.php');
+$file_cache = new Cache_Lite($file_cache_options);
+
+
+$header = $file_cache->get($header_key);
+$data   = $file_cache->get($data_key);
+
+if ($header && $data) {
+  // error_log("CACHE HIT");
+  $header_lines = json_decode($header);
+  foreach ($header_lines as $header_line) {
+    header($header_line);
+  }
+
+  print $data;
+  exit();
+}
+
+// if we get here, we have a cache miss => load
+$curlSession = curl_init();
+curl_setopt($curlSession, CURLOPT_URL, $url);
+curl_setopt($curlSession, CURLOPT_HEADER, 1);
+curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
+curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
+curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
+if (!empty($target_interface)) {
+  curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
+}
+if (file_exists(dirname(__FILE__).'/target.pem')) {
+  curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
+}
+
+//Send the request and store the result in an array
+$response = curl_exec($curlSession);
+
+// Check that a connection was made
+if (curl_error($curlSession)) {
+  error_log(curl_error($curlSession));
+  civiproxy_http_error(curl_error($curlSession), curl_errno($curlSession));
+}
+
+// process the results
+$content = explode("\r\n\r\n", $response, 2);
+$header  = $content[0];
+$body    = $content[1];
+
+// extract headers
+$header_lines = explode(chr(10), $header);
+
+// Remove chunked encoding header
+foreach ($header_lines as $k => $header_line) {
+  if(strpos($header_line,'Transfer-Encoding: chunked') !== FALSE) {
+    unset($header_lines[$k]);
+  }
+}
+
+// store the information in the cache
+$file_cache->save(json_encode($header_lines), $header_key);
+$file_cache->save($body, $data_key);
+
+// and reply
+foreach ($header_lines as $header_line) {
+  header($header_line);
+}
+
+print $body;
+curl_close ($curlSession);

proxy/open.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -16,8 +16,5 @@ if (!$target_open) civiproxy_http_error("Feature disabled", 405);
 // basic check
 civiproxy_security_check('open');
 
-// basic restraints
+$parameters = civiproxy_get_parameters($valid_open_parameters);
-$valid_parameters = array(  'q'   => 'int'  );
-
-$parameters = civiproxy_get_parameters($valid_parameters);
 civiproxy_redirect($target_open, $parameters);

proxy/proxy.php

@@ -2,14 +2,13 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
 
 require_once "config.php";
-$civiproxy_version = '0.3';
+$civiproxy_version = '1.0.0-beta';
-$civiproxy_logo    = "<img src='{$proxy_base}/static/images/proxy-logo.png' alt='SYSTOPIA Organisationsberatung'></img>";
 
 /**
  * this will redirect the request to another URL,
@@ -21,6 +20,7 @@ $civiproxy_logo    = "<img src='{$proxy_base}/static/images/proxy-logo.png' alt=
  *                               where type can be 'int', 'string' (unchecked),
  */
 function civiproxy_redirect($url_requested, $parameters) {
+  global $target_interface;
   $url = $url_requested;
   $curlSession = curl_init();
 
@@ -48,7 +48,10 @@ function civiproxy_redirect($url_requested, $parameters) {
   curl_setopt($curlSession, CURLOPT_HEADER, 1);
   curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
   curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
-  curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 1);
+  curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
+  if (!empty($target_interface)) {
+    curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
+  }
   if (file_exists(dirname(__FILE__).'/target.pem')) {
     curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
   }
@@ -87,28 +90,180 @@ function civiproxy_redirect($url_requested, $parameters) {
   curl_close ($curlSession);
 }
 
+/**
+ * this will redirect the request to an API4 URL,
+ *  i.e. will pass the reply on to this request
+ *
+ * @see losely based on https://code.google.com/p/php-proxy/
+ *
+ * @param $url_requested string the URL to which the request should be sent
+ * @param $parameters array
+ * @param $credentials array
+ */
+function civiproxy_redirect4($url_requested, $parameters, $credentials) {
+  global $target_interface, $authx_internal_flow;
+  $url = $url_requested;
+  $curlSession = curl_init();
+  $credential_params = civiproxy_build_credential_params($credentials, $authx_internal_flow);
+  $credential_headers = civiproxy_build_credential_headers($credentials, $authx_internal_flow);
+
+  if ($_SERVER['REQUEST_METHOD'] == 'POST'){
+    // POST requests should be passed on as POST
+    curl_setopt($curlSession, CURLOPT_POST, 1);
+    $urlparams = 'params=' . urlencode(json_encode($parameters)) . $credential_params;
+    curl_setopt($curlSession, CURLOPT_POSTFIELDS, $urlparams);
+  } else {
+    // GET requests will get the parameters as url params
+    if (!empty($parameters)) {
+      $url .= '?params=' . urlencode(json_encode($parameters)) . $credential_params;
+    }
+  }
+
+  curl_setopt($curlSession, CURLOPT_HTTPHEADER, array_merge([
+    'Content-Type: application/x-www-form-urlencoded'
+  ], $credential_headers));
+  curl_setopt($curlSession, CURLOPT_URL, $url);
+  curl_setopt($curlSession, CURLOPT_HEADER, 1);
+  curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
+  curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
+  curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
+  if (!empty($target_interface)) {
+    curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
+  }
+  if (file_exists(dirname(__FILE__).'/target.pem')) {
+    curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
+  }
+
+  //Send the request and store the result in an array
+  $response = curl_exec($curlSession);
+
+  // Check that a connection was made
+  if (curl_error($curlSession)){
+    civiproxy_http_error(curl_error($curlSession), curl_errno($curlSession));
+
+  } else {
+    //clean duplicate header that seems to appear on fastcgi with output buffer on some servers!!
+    $response = str_replace("HTTP/1.1 100 Continue\r\n\r\n","",$response);
+
+    // split header / content
+    $content = explode("\r\n\r\n", $response, 2);
+    $header = $content[0];
+    $body = $content[1];
+
+    // handle headers - simply re-outputing them
+    $header_ar = explode(chr(10), $header);
+    foreach ($header_ar as $header_line){
+      if (!preg_match("/^Transfer-Encoding/", $header_line)){
+        civiproxy_mend_URLs($header_line);
+        header(trim($header_line));
+      }
+    }
+
+    //rewrite all hard coded urls to ensure the links still work!
+    civiproxy_mend_URLs($body);
+
+    print $body;
+  }
+
+  curl_close($curlSession);
+}
+
+/**
+ * Creates a string with the API credentials to be appended to an API4 GET or POST request.
+ * When $api4_internal_auth_flow is 'header' or 'xheader', returns a blank string
+ *
+ * @param array $credentials
+ * @param string $authx_internal_flow
+ * @return string credential string, including leading '&'
+ */
+function civiproxy_build_credential_params(array $credentials, string $authx_internal_flow): string {
+  switch($authx_internal_flow) {
+    case 'legacyrest':
+      $map = ['api_key' => 'api_key', 'key' => 'key'];
+      break;
+    case 'param':
+      $map = ['api_key' => '_authx', 'key' => '_authxSiteKey'];
+      break;
+    default:
+      return '';
+  }
+  $params = [];
+  foreach($map as $credential_key => $param_name) {
+    if (isset($credentials[$credential_key])) {
+      $credential_value = $credentials[$credential_key];
+      if ($param_name === '_authx') {
+        $credential_value = 'Bearer ' . $credential_value;
+      }
+      $params[$param_name] = $credential_value;
+    }
+  }
+
+  $param_string = http_build_query($params);
+  if (!empty($param_string)) {
+    $param_string = '&' . $param_string;
+  }
+  return $param_string;
+}
+
+/**
+ * Builds an array of headers to send on an API4 request. When $api4_internal_auth_flow
+ * is 'param' or 'legacyrest', will always return an empty array.
+ *
+ * @param array $credentials
+ * @param string $authx_internal_flow
+ * @return array
+ */
+function civiproxy_build_credential_headers(array $credentials, string $authx_internal_flow): array {
+  switch($authx_internal_flow) {
+    case 'header':
+      $map = ['api_key' => 'Authorization: Bearer', 'key' => 'X-Civi-Key:'];
+      break;
+    case 'xheader':
+      $map = ['api_key' => 'X-Civi-Auth: Bearer', 'key' => 'X-Civi-Key:'];
+      break;
+    default:
+      return [];
+  }
+  $headers = [];
+  foreach($map as $credential_key => $header_prefix) {
+    if (isset($credentials[$credential_key])) {
+      $headers[] = $header_prefix . ' ' . $credentials[$credential_key];
+    }
+  }
+  return $headers;
+}
 
 /**
  * Will mend all the URLs in the string that point to the target,
  *  so they will point to this proxy instead
  */
 function civiproxy_mend_URLs(&$string) {
-  global $target_rest, $target_url, $target_open, $target_file, $target_mail, $proxy_base;
+  global $target_rest, $target_url, $target_open, $target_file, $target_mail, $proxy_base, $target_mosaico, $target_civicrm;
 
   if ($target_rest) {
-    $string = preg_replace("#$target_rest#", $proxy_base . '/rest.php', $string);
+    $string = preg_replace("#{$target_rest}#", $proxy_base . '/rest.php', $string);
   }
   if ($target_url) {
-    $string = preg_replace("#$target_url#",  $proxy_base . '/url.php', $string); 
+    $string = preg_replace("#{$target_url}#",  $proxy_base . '/url.php', $string);
   }
   if ($target_open) {
-    $string = preg_replace("#$target_open#", $proxy_base . '/open.php', $string); 
+    $string = preg_replace("#{$target_open}#", $proxy_base . '/open.php', $string);
   }
   if ($target_mail) {
-    $string = preg_replace("#$target_mail#", $proxy_base . '/mail.php', $string); 
+    $string = preg_replace("#{$target_mail}#", $proxy_base . '/mail.php', $string);
   }
   if ($target_file) {
-    $string = preg_replace("#$target_file#", $proxy_base . '/file.php?id=', $string); 
+    $string = preg_replace("#{$target_file}#", $proxy_base . '/file.php?id=', $string);
+    // https://github.com/systopia/CiviProxy/issues/38
+    // fix for relative
+    if ($target_mosaico) {
+      $string = preg_replace("#src=\"\/sites\/default\/files\/civicrm\/persist\/#", 'src="' . $proxy_base . '/file.php?id=', $string);
+    }
+  }
+  if ($target_mosaico) {
+    // replace full, and relative URL
+    // $string = preg_replace("#{$target_mosaico}#",           $proxy_base . '/mosaico.php?id=', $string);
+    $string = preg_replace("#{$target_civicrm}/civicrm/mosaico/img\?src=#", $proxy_base . '/mosaico.php?id=', $string);
   }
 }
 
@@ -118,11 +273,12 @@ function civiproxy_mend_URLs(&$string) {
  * unauthorized access quantities, etc.
  *
  * @param $target
- * @param $quit    if TRUE, quit immediately if access denied
+ * @param $quit bool if TRUE, quit immediately if access denied
+ * @param $log_headers array add these headers (sanitized) to log data
  *
  * @return TRUE if allowed, FALSE if not (or quits if $quit is set)
  */
-function civiproxy_security_check($target, $quit=TRUE) {
+function civiproxy_security_check($target, $quit=TRUE, $log_headers = []) {
   // verify that we're SSL encrypted
   if ($_SERVER['HTTPS'] != "on") {
     civiproxy_http_error("This CiviProxy installation requires SSL encryption.", 400);
@@ -130,69 +286,159 @@ function civiproxy_security_check($target, $quit=TRUE) {
 
   global $debug;
   if (!empty($debug)) {
-    $file = fopen($debug, 'a');
+    // filter log data
-    fwrite($file, "REQUEST FROM " . $_SERVER['REMOTE_ADDR'] . " ON " . date('Y-m-d H:i:s') . ' -- ' . print_r($_REQUEST,1));
+    $log_data = $_REQUEST;
-    fclose($file);
+    $sanitize_params = ['api_key', 'key', '_authxSiteKey', '_authx'];
+    foreach ($sanitize_params as $param) {
+      if (isset($log_data[$param])) {
+        $log_data[$param] = substr($log_data[$param], 0, 4) . '...';
+      }
+    }
+
+    foreach($log_headers as $header) {
+      if (!empty($_SERVER[$header]))
+      $log_data[$header] = substr($_SERVER[$header], 0, 4) . '...';
+    }
+
+    // log
+    civiproxy_log("REQUEST FROM " . $_SERVER['REMOTE_ADDR'] . " ON " . date('Y-m-d H:i:s') . ' -- ' . print_r($log_data ,1));
   }
 
   // TODO: implement
   return TRUE;
 }
 
+/**
+ * Log a message to the proxy log - if enabled
+ *
+ * @param $message string the log message
+ */
+function civiproxy_log($message) {
+  global $debug;
+  if (!empty($debug)) {
+    $file = fopen($debug, 'a');
+    fwrite($file, $message);
+    fclose($file);
+  }
+}
+
 
 /**
  * extract and type check the parameters from the call params
  *
  * @param $valid_parameters   array '<parameter name> => '<expected type>'
  *                               where type can be 'int', 'string' (unchecked),
+ * @param $request            provides the request data to use,
+ *                               defaults to $_REQUEST
  */
-function civiproxy_get_parameters($valid_parameters) {
+function civiproxy_get_parameters($valid_parameters, $request = NULL) {
+  if ($request === NULL) {
+    $request = $_REQUEST;
+  }
+
   $result = array();
+  $default_sanitation = NULL;
 
   foreach ($valid_parameters as $name => $type) {
-    if (isset($_REQUEST[$name])) {
+    if ($name == '*') {
-      $value = $_REQUEST[$name];
+      // this sets default_sanitation
-      if ($type=='int') {
+      $default_sanitation = $type;
-        $value = (int) $value;
+      continue;
-      } elseif ($type == 'string') {
+    }
-        // TODO: sanitize? SQL?
+
-        $value = $value;
+    if (isset($request[$name])) {
-      } elseif ($type == 'float2') {
+      $result[$name] = civiproxy_sanitise($request[$name], $type);
-        // TODO: check if safe wrt l10n. rather use sprintf
+    }
-        $value = number_format($value, 2, '.', '');
+  }
-      } elseif ($type == 'hex') {
+  // process wildcard elements
-        // hex code
+  if ($default_sanitation !== NULL) {
-        if (!preg_match("#^[0-9a-f]*$#i", $value)) {
+    // i.e. we want the others too
-          error_log("CiviProxy: removed invalid hex parameter: " . $value);
+    $remove_parameters = array('key', 'api_key', '_authx', '_authxSiteKey', 'version', 'entity', 'action');
-          $value = '';
+    foreach ($request as $name => $value) {
-        }
+      if (!in_array($name, $remove_parameters) && !isset($valid_parameters[$name])) {
-      } elseif ($type == 'email') {
+        $result[$name] = civiproxy_sanitise($value, $default_sanitation);
-        // valid email
-        if (!preg_match("#^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,3})$#i", $value)) {
-          error_log("CiviProxy: removed invalid email parameter: " . $value);
-          $value = '';
-        }
-      } elseif (is_array($type)) {
-        // this is a list of valid options
-        $requested_value = $value;
-        $value = '';
-        foreach ($type as $allowed_value) {
-          if ($requested_value === $allowed_value) {
-            $value = $requested_value;
-            break;
-          }
-        }
-      } else {
-        error_log("CiviProxy: unknown type '$type'. Ignored.");
-        $value = '';
       }
-      $result[$name] = $value;
     }
   }
 
   return $result;
 }
 
+/**
+ * Get the value of a header on the incoming request
+ *
+ * @param string $header name of the header, in all uppercase
+ * @param string $prefix to be stripped off the value of the header
+ * @return string|null value of the header, or null if not found.
+ */
+function civiproxy_get_header($header, $prefix = ''): ?string {
+  if (!empty($_SERVER['HTTP_' . $header])) {
+    $value = $_SERVER['HTTP_' . $header];
+    if ($prefix === '') {
+      return $value;
+    }
+    if (strpos($value, $prefix) === 0) {
+      return trim(substr($value, strlen($prefix)));
+    }
+  }
+  return NULL;
+}
+
+/**
+ * sanitise the given value with the given sanitiation type
+ */
+function civiproxy_sanitise($value, $type) {
+  if ($type=='int') {
+    $value = (int) $value;
+  } elseif ($type == 'string') {
+    // TODO: sanitize? SQL?
+    $value = $value;
+  } elseif ($type == 'float2') {
+    // TODO: check if safe wrt l10n. rather use sprintf
+    $value = number_format($value, 2, '.', '');
+  } elseif ($type == 'hex') {
+    // hex code
+    if (!preg_match("#^[0-9a-f]*$#i", $value)) {
+      error_log("CiviProxy: removed invalid hex parameter: " . $value);
+      $value = '';
+    }
+  } elseif ($type == 'email') {
+    // valid email
+    if (!preg_match("#^[_a-z0-9-]+[._a-z0-9-+]*@[a-z0-9-]+[.a-z0-9-]*\.[a-z]{2,3}$#i", $value)) {
+      error_log("CiviProxy: removed invalid email parameter: " . $value);
+      $value = '';
+    }
+  } elseif ($type == 'json') {
+    // valid json
+    $json_data = json_decode($value, true);
+    if ($json_data === NULL) {
+      $value = '';
+    } else {
+      $value = json_encode($value);
+    }
+  } elseif ($type == 'array') {
+    // this should only happen _inside_ the json field
+    if (!is_array($value)) {
+      $value = '';
+    }
+  } elseif (is_array($type)) {
+    // this is a list of valid options
+    $requested_value = $value;
+    $value = '';
+    foreach ($type as $allowed_value) {
+      if ($requested_value === $allowed_value) {
+        $value = $requested_value;
+        break;
+      }
+    }
+  } else {
+    error_log("CiviProxy: unknown type '$type'. Ignored.");
+    $value = '';
+  }
+  return $value;
+}
+
+
 /**
  * generates a CiviCRM REST API compliant error
  * and ends processing
@@ -215,7 +461,7 @@ function civiproxy_http_error($message, $code = 404) {
  * call the CiviCRM REST API via CURL
  */
 function civicrm_api3($entity, $action, $data) {
-  global $target_rest, $sys_key_map;
+  global $target_rest, $sys_key_map, $target_interface;
 
   // extract site key
   $site_keys = array_values($sys_key_map);
@@ -228,23 +474,126 @@ function civicrm_api3($entity, $action, $data) {
   $query['entity']     = $entity;
   $query['action']     = $action;
 
-  $curl = curl_init();
+  $curlSession = curl_init();
-  curl_setopt($curl, CURLOPT_POST,           1);
+  curl_setopt($curlSession, CURLOPT_POST,           1);
-  curl_setopt($curl, CURLOPT_POSTFIELDS,     $query);
+  curl_setopt($curlSession, CURLOPT_POSTFIELDS,     $query);
-  curl_setopt($curl, CURLOPT_URL,            $target_rest);
+  curl_setopt($curlSession, CURLOPT_URL,            $target_rest);
-  curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+  curl_setopt($curlSession, CURLOPT_RETURNTRANSFER, 1);
-  // curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 1);
+  if (!empty($target_interface)) {
-  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 1);
+    curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
+  }
+  // curl_setopt($curlSession, CURLOPT_SSL_VERIFYPEER, 1);
+  curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
   if (file_exists(dirname(__FILE__).'/target.pem')) {
     curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
   }
 
-  $response = curl_exec($curl);
+  $response = curl_exec($curlSession);
 
-  if (curl_error($curl)){
+  if (curl_error($curlSession)){
-    civiproxy_http_error(curl_error($curl));
+    civiproxy_http_error(curl_error($curlSession));
   } else {
     return json_decode($response, true);
   }
 }
 
+/**
+ * Function to get the valid rest_allowed_actions key
+ *
+ * @param $action
+ * @param $rest_allowed_actions
+ * @return bool
+ */
+function civiproxy_get_valid_allowed_actions_key($action, $rest_allowed_actions) {
+  $remote_addr = $_SERVER['REMOTE_ADDR'];
+  // check IP specific whitelisting if specified for this address
+  if (isset($rest_allowed_actions[$remote_addr])) {
+    if (civiproxy_validate_api_entity_and_action($remote_addr, $action['entity'], $action['action'], $rest_allowed_actions)) {
+      $valid_key = $remote_addr;
+    } else {
+      $valid_key = 'all';
+    }
+  } else {
+    $valid_key = 'all';
+  }
+  return $valid_key;
+}
+
+/**
+ * Function to check whether the api entity and api action are valid for the remote address.
+ * This function does a case insensitive comparison.
+ *
+ * @param $remote_addr
+ *   'all', or the remote address.
+ * @param $api_entity
+ *   The api entity.
+ * @param $api_action
+ *   The api action.
+ * @param $rest_allowed_actions
+ *   The array with the allowed actions.
+ * @return bool
+ */
+function civiproxy_validate_api_entity_and_action($remote_addr, $api_entity, $api_action, $rest_allowed_actions) {
+  if (!isset($rest_allowed_actions[$remote_addr])) {
+    return false;
+  }
+
+  $api_entity = strtolower($api_entity);
+  $api_action = strtolower($api_action);
+  if (isset($rest_allowed_actions[$remote_addr][$api_entity]) && isset($rest_allowed_actions[$remote_addr][$api_entity][$api_action])) {
+    return true;
+  }
+
+  // Did not find the lower case variant.
+  // loop through the array
+  foreach($rest_allowed_actions[$remote_addr] as $allowed_entity => $allowed_actions) {
+    if (strtolower($allowed_entity) == $api_entity) {
+      foreach($allowed_actions as $allowed_action => $fields) {
+        if (strtolower($allowed_action) == $api_action) {
+          return true;
+        }
+      }
+    }
+  }
+  return false;
+}
+
+/**
+ * Function to retrieve the valid parameters of an api call
+ * This function does a case insensitive comparison.
+ *
+ * @param $remote_addr
+ *   'all', or the remote address.
+ * @param $api_entity
+ *   The api entity.
+ * @param $api_action
+ *   The api action.
+ * @param $rest_allowed_actions
+ *   The array with the allowed actions.
+ * @return array()|null
+ **/
+function civiproxy_retrieve_api_parameters($remote_addr, $api_entity, $api_action, $rest_allowed_actions) {
+  if (!isset($rest_allowed_actions[$remote_addr])) {
+    return null;
+  }
+
+  $api_entity = strtolower($api_entity);
+  $api_action = strtolower($api_action);
+  if (isset($rest_allowed_actions[$remote_addr][$api_entity]) && isset($rest_allowed_actions[$remote_addr][$api_entity][$api_action])) {
+    return $rest_allowed_actions[$remote_addr][$api_entity][$api_action];
+  }
+
+  // Did not find the lower case variant.
+  // loop through the array
+  foreach($rest_allowed_actions[$remote_addr] as $allowed_entity => $allowed_actions) {
+    if (strtolower($allowed_entity) == $api_entity) {
+      foreach($allowed_actions as $allowed_action => $parameters) {
+        if (strtolower($allowed_action) == $api_action) {
+          return $parameters;
+        }
+      }
+    }
+  }
+  return null;
+}
+

proxy/rest.php

@@ -2,18 +2,18 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
 
 require_once "config.php";
 require_once "proxy.php";
+require_once "checks.php";
 
 // see if REST API is enabled
 if (!$target_rest) civiproxy_http_error("Feature disabled", 405);
 
-
 // basic check
 if (!civiproxy_security_check('rest')) {
   civiproxy_rest_error("Access denied.");
@@ -21,37 +21,18 @@ if (!civiproxy_security_check('rest')) {
 
 // check credentials
 $credentials = civiproxy_get_parameters(array('key' => 'string', 'api_key' => 'string'));
-if (empty($credentials['key'])) {
-  civiproxy_rest_error("No site key given");
-} else {
-  if (isset($sys_key_map[$credentials['key']])) {
-    $credentials['key'] = $sys_key_map[$credentials['key']];
-  } else {
-    civiproxy_rest_error("Invalid site key");
-  }
-}
 
-if (empty($credentials['api_key'])) {
+civiproxy_map_site_key($credentials, $sys_key_map);
-  civiproxy_rest_error("No API key given");
+civiproxy_map_api_key($credentials, $api_key_map);
-} else {
-  if (isset($api_key_map[$credentials['api_key']])) {
-    $credentials['api_key'] = $api_key_map[$credentials['api_key']];
-  } else {
-    civiproxy_rest_error("Invalid api key");
-  }
-}
 
 // check if the call itself is allowed
 $action = civiproxy_get_parameters(array('entity' => 'string', 'action' => 'string', 'version' => 'int', 'json' => 'int', 'sequential' => 'int'));
 if (!isset($action['version']) || $action['version'] != 3) {
-  civiproxy_rest_error("Invalid entity/action.");
+  civiproxy_rest_error("API 'version' information missing.");
-}
-if (isset($rest_allowed_actions[$action['entity']]) && isset($rest_allowed_actions[$action['entity']][$action['action']])) {
-  $valid_parameters = $rest_allowed_actions[$action['entity']][$action['action']];
-} else {
-  civiproxy_rest_error("Invalid entity/action.");
 }
 
+$valid_parameters= civiproxy_get_valid_parameters($action, $rest_allowed_actions);
+
 // extract parameters and add credentials and action data
 $parameters = civiproxy_get_parameters($valid_parameters);
 foreach ($credentials as $key => $value) {
@@ -61,19 +42,18 @@ foreach ($action as $key => $value) {
   $parameters[$key] = $value;
 }
 
-// finally execute query
+// evaluate the JSON parameter
-civiproxy_redirect($target_rest, $parameters);
+global $rest_evaluate_json_parameter;
-
+if ($rest_evaluate_json_parameter) {
-
+  if (isset($_REQUEST['json'])) {
-/**
+    $json_data = json_decode($_REQUEST['json'], true);
- * generates a CiviCRM REST API compliant error
+    if (!empty($json_data) && is_array($json_data)) {
- * and ends processing
+      $json_parameters = civiproxy_get_parameters($valid_parameters, $json_data);
- */
+      $parameters['json'] = json_encode($json_parameters);
-function civiproxy_rest_error($message) {
+    }
-  $error = array( 'is_error'      => 1,
+  }
-                  'error_message' => $message);
-  // TODO: Implement
-  //header();
-  print json_encode($error);
-  exit();
 }
+
+// finally execute query
+civiproxy_log($target_rest);
+civiproxy_redirect($target_rest, $parameters);

proxy/rest4.php

@@ -0,0 +1,89 @@
+<?php
+/*--------------------------------------------------------+
+| SYSTOPIA CiviProxy                                      |
+|  a simple proxy solution for external access to CiviCRM |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
+| Author: B. Endres (endres -at- systopia.de)             |
+| http://www.systopia.de/                                 |
++---------------------------------------------------------*/
+
+require_once "config.php";
+require_once "proxy.php";
+require_once "checks.php";
+
+// see if REST API is enabled
+if (!$target_rest4) {
+  civiproxy_http_error("Feature disabled");
+}
+$valid_flows = ['header', 'xheader', 'legacyrest', 'param'];
+$headers_by_flow = [
+ 'header' => ['HTTP_AUTHORIZATION', 'HTTP_X_CIVI_KEY'],
+ 'xheader' => ['HTTP_X_CIVI_AUTH', 'HTTP_X_CIVI_KEY'],
+ 'legacyrest' => [],
+ 'param' => [],
+];
+if (!in_array($authx_internal_flow, $valid_flows)) {
+  civiproxy_http_error("Invalid internal auth flow '$authx_internal_flow'", 500);
+}
+$headers_to_log = [];
+foreach ($authx_external_flow as $external_flow) {
+  if (!in_array($external_flow, $valid_flows)) {
+    civiproxy_http_error("Invalid external auth flow '$external_flow'", 500);
+  }
+  $headers_to_log = array_merge($headers_to_log, $headers_by_flow[$external_flow]);
+}
+
+// basic check
+if (!civiproxy_security_check('rest', TRUE, $headers_to_log)) {
+  civiproxy_rest_error("Access denied.");
+}
+
+$credentials = [];
+// Find credentials on the incoming request
+foreach ($authx_external_flow as $external_flow) {
+  switch($external_flow) {
+    case 'header':
+      $credentials['api_key'] = civiproxy_get_header('AUTHORIZATION', 'Bearer ');
+      $credentials['key'] = civiproxy_get_header('HTTP_X_CIVI_KEY');
+      break;
+    case 'xheader':
+      $credentials['api_key'] = civiproxy_get_header('X_CIVI_AUTH', 'Bearer ');
+      $credentials['key'] = civiproxy_get_header('HTTP_X_CIVI_KEY');
+      break;
+    case 'legacyrest':
+      $credentials = civiproxy_get_parameters(array('api_key' => 'string', 'key' => 'string'));
+      break;
+    case 'param':
+      $authx_credentials = civiproxy_get_parameters(array('_authx' => 'string', '_authxSiteKey' => 'string'));
+      if (!empty($authx_credentials['_authx'])) {
+        // Snip off leading 'Bearer ' or 'Bearer+'
+        if (substr($authx_credentials['_authx'], 0, 6) === 'Bearer') {
+          $credentials['api_key'] = substr($authx_credentials['_authx'], 7);
+        }
+      }
+      if (!empty($authx_credentials['_authxSiteKey'])) {
+        $credentials['key'] = $authx_credentials['_authxSiteKey'];
+      }
+      break;
+  }
+  if (!empty($credentials['api_key'])) {
+    break;
+  }
+}
+
+civiproxy_map_api_key($credentials, $api_key_map);
+if (!empty($credentials['key'])) {
+  civiproxy_map_site_key( $credentials, $sys_key_map);
+}
+
+// check if the call itself is allowed
+$action = civiproxy_get_parameters(array('entity' => 'string', 'action' => 'string'));
+
+$valid_parameters = civiproxy_get_valid_parameters($action, $rest_allowed_actions);
+
+// extract parameters and add action data
+$parameters = civiproxy_get_parameters($valid_parameters, json_decode($_REQUEST['params'], true));
+
+// finally execute query
+civiproxy_log($target_rest4);
+civiproxy_redirect4($target_rest4 . $action['entity'] . '/' . $action['action'] , $parameters, $credentials);

proxy/url.php

@@ -2,7 +2,7 @@
 /*--------------------------------------------------------+
 | SYSTOPIA CiviProxy                                      |
 |  a simple proxy solution for external access to CiviCRM |
-| Copyright (C) 2015 SYSTOPIA                             |
+| Copyright (C) 2015-2021 SYSTOPIA                        |
 | Author: B. Endres (endres -at- systopia.de)             |
 | http://www.systopia.de/                                 |
 +---------------------------------------------------------*/
@@ -16,10 +16,5 @@ if (!$target_url) civiproxy_http_error("Feature disabled", 405);
 // basic check
 civiproxy_security_check('url');
 
-// basic restraints
+$parameters = civiproxy_get_parameters($valid_url_parameters);
-$valid_parameters = array(  'u'   => 'int',
-                            'q'   => 'int',
-                            'qid' => 'int');
-
-$parameters = civiproxy_get_parameters($valid_parameters);
 civiproxy_redirect($target_url, $parameters);

proxy/webhook2api.php

@@ -0,0 +1,298 @@
+<?php
+/*--------------------------------------------------------+
+| SYSTOPIA CiviProxy                                      |
+|  a simple proxy solution for external access to CiviCRM |
+| Copyright (C) 2019-2021 SYSTOPIA                        |
+| Author: B. Endres (endres -at- systopia.de)             |
+| http://www.systopia.de/                                 |
++---------------------------------------------------------*/
+
+require_once "config.php";
+require_once "proxy.php";
+
+// first check if webhooks are enabled
+if (empty($webhook2api)) civiproxy_http_error("Feature disabled", 405);
+
+// basic check
+if (!civiproxy_security_check('webhook2api')) {
+  civiproxy_http_error("Access denied", 403);
+}
+
+// find the right configuration
+if (!empty($_REQUEST['id']) && isset($webhook2api['configurations'][$_REQUEST['id']])) {
+  // we found the if in the configurations
+  $configurations = [$webhook2api['configurations'][$_REQUEST['id']]];
+} elseif (empty($_REQUEST['id']) && isset($webhook2api['configurations']['default'])) {
+  // this is teh default configuration
+  $configurations = [$webhook2api['configurations']['default']];
+} else {
+  // use all of them (first one matching is executed)
+  $configurations = $webhook2api['configurations'];
+}
+
+// read some input
+$post_input = @file_get_contents('php://input');
+
+// MAIN: iterate through all (eligible) configurations
+$last_error = ["No handler found", 501];
+foreach ($configurations as $configuration) {
+  $last_error = webhook2api_processConfiguration($configuration, $post_input);
+  if ($last_error == NULL) {
+    // success!
+    break;
+  }
+}
+
+// finally - if there was only errors, return the last one
+if ($last_error) {
+  civiproxy_http_error($last_error[0], $last_error[1]);
+}
+
+
+
+
+/**
+ * Apply the given configuration. If it matches and executes,
+ *  it returns NULL, otherwise
+ *
+ * @param $configuration array configuration/specification
+ * @return null|array [status_code, error message]
+ */
+function webhook2api_processConfiguration($configuration, $post_input) {
+  // check the IP/range restrictions
+  if (!empty($configuration['ip_sources']) && is_array($configuration['ip_sources'])) {
+    $ip = $_SERVER['REMOTE_ADDR'];
+    $access_granted = FALSE;
+    foreach ($configuration['ip_sources'] as $netmask) {
+      // copied from https://secure.php.net/manual/de/ref.network.php
+      list ($net, $mask) = explode("/", $netmask);
+      $ip_net = ip2long ($net);
+      $ip_mask = ~((1 << (32 - $mask)) - 1);
+      $ip_ip = ip2long ($ip);
+      $ip_ip_net = $ip_ip & $ip_mask;
+      if ($ip_ip_net == $ip_net) {
+        $access_granted = TRUE;
+        break;
+      }
+    }
+    if (!$access_granted) {
+      // this configuration is not eligible
+      return ["Access denied", 403];
+    }
+  }
+
+  // gather source data
+  $data = [];
+  if (!empty($configuration['data_sources']) && is_array($configuration['data_sources'])) {
+    foreach ($configuration['data_sources'] as $data_source) {
+      switch ($data_source) {
+        case 'POST/json': # JSON data in POST field
+          $more_data = json_decode($post_input, TRUE);
+          $data = array_merge_recursive($data, $more_data);
+          break;
+        case 'REQUEST': # simple request parameters
+          $data = array_merge_recursive($data, $_REQUEST);
+          break;
+        default:
+          civiproxy_log("Webhook2API[{$configuration['name']}]: unknown source '{$data_source}' in configuration. Ignored.");
+      }
+    }
+  }
+
+  // default return code if everything goes according to plan
+  $http_code = 200;
+  // check if we have a json_array and react accordingly
+  if (isset($data[0]) && is_array($data[0])) {
+    foreach ($data as $d) {
+      $result = webhook2api_callCiviApi($configuration, $d);
+      if(isset($result['internal_error'])) {
+        // internal communication Error occurred. Aborting process
+        civiproxy_log("Webhook2API[{$configuration['name']}]: internal error occurred: " . json_encode($result['internal_error']));
+        return $result['internal_error'];
+      }
+      if (!empty($result['values']['http_code'])) {
+        $http_code = $result['values']['http_code'];
+      } else {
+        $http_code = 403;
+        break;
+      }
+    }
+  } else {
+    $result = webhook2api_callCiviApi($configuration, $data);
+    if(isset($result['internal_error'])) {
+      // internal communication Error occurred. Aborting process
+      civiproxy_log("Webhook2API[{$configuration['name']}]: internal error occurred: " . json_encode($result['internal_error']));
+      return $result['internal_error'];
+    }
+    if (!empty($result['values']['http_code'])) {
+      $http_code = $result['values']['http_code'];
+    } elseif ($result['is_error'] != 0) {
+        $http_code = 403;
+    }
+  }
+  if ($http_code != '200') {
+    // we received and parsed the webhook event successfully, but an error occurred with civicrm:
+    civiproxy_log("Webhook2API[{$configuration['name']}]: Internal CiviCRM Error. Error Code: {$http_code}. Full Message: " . json_encode($result));
+  }
+
+  // process result
+  if (!empty($configuration['response_mapping']) && is_array($configuration['response_mapping'])) {
+    // TODO: implement
+    http_response_code('200');
+    civiproxy_log("Webhook successful, response mapped.");
+  } else {
+    // default behaviour:
+    http_response_code('200');
+    civiproxy_log("Webhook successful.");
+  }
+  // all done
+  exit();
+}
+
+
+/**
+ * Parse Configuration and given data set, apply it and send it to civicrm.
+ * Returns an internal error if communication to civicrm isn't successful
+ *
+ * @param $configuration
+ * @param $data
+ *
+ * @return array|mixed|void
+ * @throws \CiviCRM_API3_Exception
+ */
+function webhook2api_callCiviApi($configuration, $data) {
+  // evaluate sentinels
+  if (!empty($configuration['sentinel']) && is_array($configuration['sentinel'])) {
+    foreach ($configuration['sentinel'] as $sentinel) {
+      list($value_source, $check) = $sentinel;
+      $value = webhook2api_getValue($data, $value_source);
+      if (substr($check, 0, 6) == "equal:") {
+        // check if terms a equal
+        if (substr($check, 6) != $value) {
+          return ["internal_error" => "Access denied", 403];
+        }
+      } else {
+        echo "Error";
+        // unknown instruction
+        civiproxy_log("Webhook2API[{$configuration['name']}]: don't understand sentinel '{$check}'. Ignored.");
+      }
+    }
+  }
+
+  // compile API query
+  $params = [];
+  if (!empty($configuration['parameter_mapping']) && is_array($configuration['parameter_mapping'])) {
+    foreach ($configuration['parameter_mapping'] as $mapping) {
+      $source_path = $mapping[0];
+      $target_path = $mapping[1];
+      $modifiers   = isset($mapping[2]) ? $mapping[2] : [];
+
+      // get value
+      $value = webhook2api_getValue($data, $source_path);
+
+      // run modifiers
+      foreach ($modifiers as $modifier) {
+        // TODO: implement
+
+        civiproxy_log("Webhook2API.modifiers: not implemented!");
+      }
+
+      // set to target
+      webhook2api_setValue($params, $target_path, $value);
+    }
+  } else {
+    $params = $data;
+  }
+
+  // sanitise data
+  if (!empty($configuration['parameter_sanitation']) && is_array($configuration['parameter_sanitation'])) {
+    // TODO: implement
+    civiproxy_log("Webhook2API.sanitation: not implemented!");
+  }
+
+  // send to target REST API
+  if (empty($configuration['entity']) || empty($configuration['action'])) {
+    civiproxy_log("Webhook2API[{$configuration['name']}]: Missing entity/action.");
+    return ["internal_error" => "Configuration error", 403];
+  }
+  if (empty($configuration['api_key'])) {
+    civiproxy_log("Webhook2API[{$configuration['name']}]: Missing api_key.");
+    return ["internal_error" => "Configuration error", 403];
+  }
+  $params['api_key'] = $configuration['api_key'];
+
+  // run API call
+  return civicrm_api3($configuration['entity'], $configuration['action'], $params);
+
+}
+
+
+/**
+ * Get the value from a multidimensional array,
+ *  specified by the path
+ *
+ * @param $data array         multidimensional data array
+ * @param $path array|string  path description
+ * @return mixed value
+ */
+function webhook2api_getValue($data, $path) {
+  if (is_string($path)) {
+    if (isset($data[$path])) {
+      return $data[$path];
+    } else {
+      return NULL;
+    }
+  } elseif (is_array($path)) {
+    if (count($path) == 0) {
+      return NULL;
+    } elseif (count($path) == 1) {
+      return webhook2api_getValue($data, $path[0]);
+    } else {
+      $path_element = array_shift($path);
+      $sub_data = webhook2api_getValue($data, $path_element);
+      if (is_array($sub_data)) {
+        return webhook2api_getValue($sub_data, $path);
+      } else {
+        return NULL;
+      }
+    }
+  }
+}
+
+/**
+ * Set the value from a multidimensional array as specified by the path
+ *
+ * @param $data        array the data
+ * @param $target_path array destination
+ * @param $value       mixed value
+ */
+function webhook2api_setValue(&$data, $target_path, $value) {
+  if (is_array($target_path)) {
+    if (count($target_path) == 0) {
+      civiproxy_log("Webhook2API.setValue: Empty target path!");
+      return;
+
+    } elseif (count($target_path) == 1) {
+      // last element -> set value
+      $data[$target_path[0]] = $value;
+
+    } else {
+      // not last element
+      $element = array_shift($target_path);
+      if (!isset($data[$element])) {
+        $data[$element] = [];
+      }
+      if (is_array($data[$element])) {
+        webhook2api_setValue($data[$element], $target_path, $value);
+      } else {
+        civiproxy_log("Webhook2API.setValue: path node is not an array!");
+      }
+    }
+
+  } elseif (is_string($target_path)) {
+    webhook2api_setValue($data, [$target_path], $value);
+
+  } else {
+    civiproxy_log("Webhook2API.setValue: path neither string nor array!");
+  }
+}