Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Initial push to GitHub

  • Loading branch information...
commit fb32aa20265a01110d212fbfdf27b17fa901e9b5 0 parents
Troy Davisson authored
674 LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 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 General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <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 General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
123 README.md
@@ -0,0 +1,123 @@
+flexmls API - version 2
+=====================
+A PHP wrapper for the flexmls REST API. This version has enough differences from version 1 that upgrading will
+require changes to existing code.
+
+
+Documentation
+-------------
+For full information on the API, see http://www.flexmls.com/developers
+
+
+Usage Examples
+------------------------
+ // include the flexmlsAPI core which autoloads other classes as necessary
+ require_once("lib/Core.php");
+
+ // connect using flexmls API authentication
+ $api = new flexmlsAPI_APIAuth("api_key_goes_here", "api_secret_goes_here");
+
+ // identify your application (optional)
+ $api->SetApplicationName("MyPHPApplication/1.0");
+
+ // authenticate
+ $result = $api->Authenticate();
+ if ($result === false) {
+ echo "API Error Code: {$api->last_error_code}<br>\n";
+ echo "API Error Message: {$api->last_error_mess}<br>\n";
+ exit;
+ }
+
+ // get your listings
+ $result = $api->GetMyListings();
+
+ // see the included examples.php for more complete usage
+
+
+Error Codes
+---------------------
+<table>
+ <thead>
+ <tr>
+ <th>HTTP Code</th>
+ <th>flexmls API Error Code</th>
+ <th>Automatic Retry</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><tt>401</tt></td>
+ <td><tt>1000</tt></td>
+ <td><tt>Yes</tt></td>
+ <td>Invalid API Key and/or Request signed improperly</td>
+ </tr>
+ <tr>
+ <td><tt>401</tt></td>
+ <td><tt>1010</tt></td>
+ <td><tt>No</tt></td>
+ <td>API key is disabled</td>
+ </tr>
+ <tr>
+ <td><tt>403</tt></td>
+ <td><tt>1015</tt></td>
+ <td><tt>No</tt></td>
+ <td><tt>ApiUser</tt> must be supplied, or the provided key does not have access to the supplied user</td>
+ </tr>
+ <tr>
+ <td><tt>401</tt></td>
+ <td><tt>1020</tt></td>
+ <td><tt>Yes</tt></td>
+ <td>Session token has expired</td>
+ </tr>
+ <tr>
+ <td><tt>403</tt></td>
+ <td><tt>1030</tt></td>
+ <td><tt>No</tt></td>
+ <td>SSL required for this type of request</td>
+ </tr>
+ <tr>
+ <td><tt>400</tt></td>
+ <td><tt>1035</tt></td>
+ <td><tt>No</tt></td>
+ <td>POST data not supplied as valid JSON. Issued if the <tt>Content-Type</tt> header is not <tt>application/json/</tt> and/or if the POST data is not in valid JSON format.</td>
+ </tr>
+ <tr>
+ <td><tt>400</tt></td>
+ <td><tt>1040</tt></td>
+ <td><tt>No</tt></td>
+ <td>The <tt>_filter</tt> syntax was invalid or a specified field to search on does not exist</td>
+ </tr>
+ <tr>
+ <td><tt>400</tt></td>
+ <td><tt>1050</tt></td>
+ <td><tt>No</tt></td>
+ <td>(message varies) A required parameter was not provided</td>
+ </tr>
+ <tr>
+ <td><tt>400</tt></td>
+ <td><tt>1053</tt></td>
+ <td><tt>No</tt></td>
+ <td>(message varies) A parameter was provided but does not adhere to constraints</td>
+ </tr>
+ <tr>
+ <td><tt>409</tt></td>
+ <td><tt>1055</tt></td>
+ <td><tt>No</tt></td>
+ <td>(message varies)Issued when a write is requested that will conflict with existing data. For example, adding a new contact with an e-mail that already exists.</td>
+ </tr>
+ <tr>
+ <td><tt>403</tt></td>
+ <td><tt>1500</tt></td>
+ <td><tt>No</tt></td>
+ <td>The resource is not available at the current API key's service level. For example, this error applies if a user attempts to access the IDX Links API via a free API key. </td>
+ </tr>
+ <tr>
+ <td><tt>503</tt></td>
+ <td><tt>1550</tt></td>
+ <td><tt>No</tt></td>
+ <td>Over rate limit</td>
+ </tbody>
+</table>
+
+
215 examples.php
@@ -0,0 +1,215 @@
+<?php
+
+// include the flexmlsAPI core which autoloads other classes as necessary
+require_once("lib/Core.php");
+
+
+/*
+ * authenticate with the API
+ * Changed in version 2.0
+ *
+ * The newest version of the PHP API client (version 2.0) allows you to select which authentication method
+ * you'd like to use against the API. Version 1.0 was limited to the flexmls API authentication method and is
+ * now done using:
+ *
+ * $api = new flexmlsAPI_APIAuth("api_key_goes_here", "api_secret_goes_here");
+ *
+ * With version 2.0, you can now authenticate using OAuth2 support. For more details on OAuth2 with the flexmls API,
+ * see https://www.flexmls.com/developers/api/api-services/authentication/
+ *
+ * $api = new flexmlsAPI_OAuth($client_id, $client_secret, $application_uri);
+ *
+ * To issue a Grant request with the "code" value provided by the API:
+ *
+ * $result = $api->Grant($code_value);
+ *
+ * A successful response will populate 2 new variables:
+ *
+ * $api->oauth_access_token
+ * $api->oauth_refresh_token
+ *
+ * These values can be saved and re-used in future requests using:
+ *
+ * $api->SetAccessToken($previous_access_token);
+ * $api->SetRefreshToken($previous_refresh_token);
+ *
+ * Also, for convenience, if the access token has expired and the refresh token is used to automatically have a new access
+ * token generated, a hook is available to notify you of the new tokens:
+ *
+ * $api->SetNewAccessCallback('new_token_given');
+ *
+ * which executes a function called "new_token_given" with 2 arguments:
+ *
+ * * the type of grant which resulted in new tokens. "authorization_code" or "refresh_token"
+ * * the values (in array format). "access_token", "refresh_token" and "expires_in" are the 3 array keys
+ *
+ */
+
+$api = new flexmlsAPI_APIAuth("api_key_goes_here", "api_secret_goes_here");
+
+// identify your application (optional)
+$api->SetApplicationName("PHP-API-Code-Examples/1.0");
+
+// enable developer mode. this points you to a sandbox for development use
+$api->SetDeveloperMode(true);
+
+
+/*
+ * enable built-in caching system
+ * New in version 2.0
+ *
+ * The newest version of the PHP API client (version 2.0) contains a system for enabling a
+ * built-in cache. The following options currently exist:
+ *
+ * * Memcache (Uses http://pecl.php.net/package/memcache)
+ * * Memcached (Uses http://pecl.php.net/package/memcached)
+ * * WordPress (for use within plugins or themes)
+ * * MySQLi for storing the cache in a MySQL database
+ *
+ * To enable a particular caching system, you must create an instance of the desired object and pass it to
+ * the API core.
+ *
+ *
+ * To enable Memcache or Memcached cache support, the host and port (both optional) can be given:
+ *
+ * $api->SetCache( new flexmlsAPI_MemcacheCache() ); // defaults to localhost and port 11211
+ * or:
+ * $api->SetCache( new flexmlsAPI_MemcachedCache('remotehost', 12345) ); // overrides both defaults
+ *
+ * depending on the Memcached-compliant driver you choose.
+ *
+ *
+ * To enable WordPress caching, no arguments are required: this method uses the set_transient() and get_transient()
+ * functions created by WordPress which can be extended by other WP plugins for additional (or modified) functionality.
+ *
+ * $api->SetCache( new flexmlsAPI_WordPressCache() );
+ *
+ *
+ * To enable database caching via the MySQLi extension, you can either pass connection details to the class:
+ *
+ * $api->SetCache( new flexmlsAPI_MySQLiCache($hostname, $database, $username, $password, $table_name));
+ *
+ * or you can re-use an existing MySQLi connection by passing the object:
+ *
+ * $api->SetCache( new flexmlsAPI_MySQLiCache($my_mysqli_object) );
+ *
+ * By default, a $table_name of "api_cache" is assumed if none is given. The structure for that table is:
+ *
+ * CREATE TABLE api_cache (
+ * cache_key VARCHAR(125),
+ * cache_value TEXT,
+ * expiration INT(10),
+ * PRIMARY KEY(cache_key)
+ * )
+ *
+ */
+
+
+// authenticate
+$result = $api->Authenticate();
+if ($result === false) {
+ echo "API Error Code: {$api->last_error_code}<br>\n";
+ echo "API Error Message: {$api->last_error_mess}<br>\n";
+ exit;
+}
+
+/*
+ * request some basic account and system information
+ */
+$result = $api->GetSystemInfo();
+// https://www.flexmls.com/developers/api/api-services/system-info/
+print_r($result);
+
+$result = $api->GetPropertyTypes();
+// https://www.flexmls.com/developers/api/api-services/property-types/
+print_r($result);
+
+$result = $api->GetStandardFields();
+// https://www.flexmls.com/developers/api/api-services/standard-fields/
+print_r($result);
+
+$result = $api->GetMyAccount();
+// https://www.flexmls.com/developers/api/api-services/my-account/
+print_r($result);
+
+
+/*
+ * different requests for listings based on context
+ */
+
+$result = $api->GetMyListings();
+// https://www.flexmls.com/developers/api/api-services/listings/
+print_r($result);
+
+$result = $api->GetOfficeListings();
+// https://www.flexmls.com/developers/api/api-services/listings/
+print_r($result);
+
+$result = $api->GetCompanyListings();
+// https://www.flexmls.com/developers/api/api-services/listings/
+print_r($result);
+
+/*
+ * request for listings with some parameters. the above listing requests this argument and most of the options within
+ */
+$result = $api->GetListings(
+ array(
+ '_pagination' => 1,
+ '_limit' => 3,
+ '_page' => 2,
+ '_filter' => "PropertyType Eq 'A'",
+ '_expand' => 'PrimaryPhoto'
+ )
+);
+// https://www.flexmls.com/developers/api/api-services/listings/
+print_r($result);
+
+/*
+ * with a particular listing Id known, several additional API calls are available
+ */
+
+$id = "20100912153422758914000000"; // this comes from the Id value in a listing response
+
+$result = $api->GetListingPhotos($id);
+// https://www.flexmls.com/developers/api/api-services/listing-photos/
+$result = $api->GetListingDocuments($id);
+// https://www.flexmls.com/developers/api/api-services/listing-documents/
+$result = $api->GetListingOpenHouses($id);
+// https://www.flexmls.com/developers/api/api-services/open-houses/
+$result = $api->GetListingVideos($id);
+// https://www.flexmls.com/developers/api/api-services/listing-videos/
+$result = $api->GetListingVirtualTours($id);
+// https://www.flexmls.com/developers/api/api-services/virtual-tours/
+
+
+/*
+ * with a particular object Id known, you can request additional information about that one item
+ */
+
+$photo_id = "20080917142739989238000000";
+
+$result = $api->GetListingPhoto($id, $photo_id);
+// https://www.flexmls.com/developers/api/api-services/listing-photos/
+
+
+/*
+ * contact management
+ * https://www.flexmls.com/developers/api/api-services/contacts/
+ */
+
+$result = $api->GetContacts();
+
+$new_contact = array(
+ "DisplayName" => "Example Contact",
+ "PrimaryEmail" => "apiexample@flexmls.com",
+ "PrimaryPhoneNumber" => "888-123-4567",
+ "HomeStreetAddress" => "123 S. Main St",
+ "HomeLocality" => "Fargo",
+ "HomeRegion" => "ND",
+ "HomePostalCode" => "58104",
+ "Tag" => "Example Group"
+);
+
+// $result = $api->AddContact($new_contact); // creates a new contact
+
+$result = $api->GetContact("20090816141725963238000000"); // get a contact by their Id
114 lib/APIAuth.php
@@ -0,0 +1,114 @@
+<?php
+
+class flexmlsAPI_APIAuth extends flexmlsAPI_Core implements flexmlsAPI_AuthInterface {
+ protected $api_key = null;
+ protected $api_secret = null;
+
+
+ function __construct($api_key, $api_secret) {
+ $this->api_key = $api_key;
+ $this->api_secret = $api_secret;
+
+ $this->auth_mode = 'api';
+
+ parent::__construct();
+ }
+
+ function is_auth_request($request) {
+ return ($request['uri'] == '/'. $this->api_version .'/session') ? true : false;
+ }
+
+
+ function sign_request($request) {
+
+ $http_parameters = $request['params'];
+ $cache_http_parameters = $http_parameters;
+
+ $sec_string = "{$this->api_secret}ApiKey{$this->api_key}";
+ $post_body = "";
+
+ if ($request['method'] == "POST" && !empty($request['post_data']) > 0) {
+ // the request is to post some JSON data back to the API (like adding a contact)
+ $post_body = $request['post_data'];
+ }
+
+ $is_auth_request = ($request['uri'] == '/'. $this->api_version .'/session') ? true : false;
+
+ if ($is_auth_request) {
+ $http_parameters['ApiKey'] = $this->api_key;
+ }
+ else {
+
+ if ( empty($this->last_token) ) {
+ // attempt to pull this from the cache if it's turned on
+ if ($this->cache) {
+ $cached_token = $this->cache->get($this->cache_prefix . 'authtoken');
+ if ($cached_token != null) {
+ $this->SetAuthToken($cached_token);
+ }
+ }
+ }
+
+ $http_parameters['AuthToken'] = $this->last_token;
+
+ // since this isn't an authentication request, add the ServicePath to the security string
+ $sec_string .= "ServicePath" . rawurldecode($request['uri']);
+
+ ksort($http_parameters);
+
+ // add each of the HTTP query string parameters to the security string
+ foreach ($http_parameters as $k => $v) {
+ $sec_string .= $k . $v;
+ }
+ }
+
+ if (!empty($post_body)) {
+ // add the post data to the end of the security string if it exists
+ $sec_string .= $post_body;
+ }
+
+ // calculate the security string as ApiSig
+ $api_sig = md5($sec_string);
+ $http_parameters['ApiSig'] = $api_sig;
+
+ $request['query_string'] = http_build_query($http_parameters);
+ $request['cacheable_query_string'] = http_build_query($cache_http_parameters);
+ }
+
+ function SetAuthToken($token) {
+ $this->last_token = $token;
+ }
+
+
+ /*
+ * Authentication
+ */
+
+ function Authenticate() {
+ $response = $this->MakeAPICall("POST", "session");
+
+ if ($response['success']) {
+ $this->last_token = $response['results'][0]['AuthToken'];
+ $this->last_token_expire = $response['results'][0]['Expires'];
+
+ if ($this->cache) {
+ $this->cache->set($this->cache_prefix . 'authtoken', $this->last_token, 86400);
+ }
+
+ if ( is_callable($this->access_change_callback) ) {
+ call_user_func($this->access_change_callback, 'api', array('auth_token' => $this->last_token) );
+ }
+
+ return true;
+ }
+
+ return false;
+ }
+
+ function ReAuthenticate() {
+ return $this->Authenticate();
+ }
+
+
+
+}
5 lib/AuthInterface.php
@@ -0,0 +1,5 @@
+<?php
+
+interface flexmlsAPI_AuthInterface {
+
+}
8 lib/CacheInterface.php
@@ -0,0 +1,8 @@
+<?php
+
+interface flexmlsAPI_CacheInterface {
+
+ function get($key);
+ function set($key, $value, $expire);
+
+}
657 lib/Core.php
@@ -0,0 +1,657 @@
+<?php
+
+/**
+ * A PHP wrapper for the flexmls REST API
+ *
+ * Version: 2.0
+ *
+ * Source URI: https://github.com/flexmls/flexmls_api4p2
+ * Author: (c) Financial Business Systems, Inc. 2011, 2012
+ * Author URI: http://flexmls.com/developers
+ *
+ * This file is part of the flexmls PHP API client..
+
+ * The flexmls PHP API client is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+
+ * The flexmls PHP API client is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with the flexmls PHP API client. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+spl_autoload_register(array('flexmlsAPI_Core', 'autoload'));
+
+
+class flexmlsAPI_Core {
+ public $api_client_version = '2.0';
+
+ public $api_base = "api.flexmls.com";
+ public $api_version = "v1";
+
+ private $debug_mode = false;
+ private $debug_log = null;
+ protected $force_https = false;
+ protected $transport = null;
+ protected $cache = null;
+ protected $cache_prefix = "flexmlsAPI_";
+
+ protected $headers = array();
+
+ public $last_token = null;
+ protected $access_change_callback = null;
+
+ public $auth_mode = null;
+
+ public $last_count = null;
+ public $total_pages = null;
+ public $current_page = null;
+ public $page_size = null;
+
+ public $last_error_code = null;
+ public $last_error_mess = null;
+
+
+ /*
+ * Core functions
+ */
+
+ function __construct() {
+ $this->SetHeader("Content-Type", "application/json");
+ $this->SetHeader('User-Agent', 'flexmls API PHP Client/' . $this->api_client_version);
+ }
+
+ static function autoload($class_name) {
+ if (preg_match('/^flexmlsAPI/', $class_name)) {
+ $file_name = preg_replace('/^flexmlsAPI\_/', '', $class_name);
+ include_once(dirname(realpath(__FILE__)) . '/' . $file_name . '.php');
+ }
+ }
+
+ function SetApplicationName($name) {
+ $this->SetHeader('X-flexmlsApi-User-Agent', str_replace(array("\r", "\r\n", "\n"), '', trim($name)));
+ }
+
+ function SetDebugMode($mode = false) {
+ $this->debug_mode = $mode;
+ }
+
+ function SetDeveloperMode($enable = false) {
+ if ($enable) {
+ $this->api_base = "api.developers.flexmls.com";
+ return true;
+ }
+ else {
+ return false;
+ }
+ }
+
+ function SetTransport($transport) {
+ if (is_object($transport)) {
+ $this->transport = $transport;
+ }
+ else {
+ throw new Exception("SetTransport() called but value isn't a valid transport object");
+ }
+ }
+
+ function SetCache($cache) {
+ if (is_object($cache)) {
+ $this->cache = $cache;
+ }
+ else {
+ throw new Exception("SetCache() called but value isn't a valid cache object");
+ }
+ }
+
+ function SetCachePrefix($prefix) {
+ $this->cache_prefix = $prefix;
+ return true;
+ }
+
+ function Log($message) {
+ $this->debug_log .= $message . PHP_EOL;
+ }
+
+ function SetHeader($key, $value) {
+ $this->headers[$key] = $value;
+ return true;
+ }
+
+ function ClearHeader($key) {
+ unset($this->headers[$key]);
+ return true;
+ }
+
+ function SetNewAccessCallback($func) {
+ $this->access_change_callback = $func;
+ return true;
+ }
+
+ function make_sendable_body($data) {
+ return json_encode(array('D' => $data));
+ }
+
+ function parse_cache_time($val) {
+ $val = trim($val);
+
+ $tag = substr($val, -1);
+ $time = substr($val, 0, -1);
+
+ if (empty($time)) {
+ // no trailing identifier given so assuming that what was given was in seconds
+ $time = $val;
+ }
+
+ switch ($tag) {
+ case 'w':
+ $time = $time * 7;
+ case 'd':
+ $time = $time * 24;
+ case 'h':
+ $time = $time * 60;
+ case 'm':
+ $time = $time * 60;
+ }
+
+ return $time;
+ }
+
+ // source: http://www.php.net/manual/en/function.utf8-encode.php#83777
+ function utf8_encode_mix($input, $encode_keys = false) {
+
+ if (is_array($input)) {
+ $result = array();
+ foreach ($input as $k => $v) {
+ $key = ($encode_keys) ? utf8_encode($k) : $k;
+ $result[$key] = $this->utf8_encode_mix($v, $encode_keys);
+ }
+ }
+ elseif (is_object($input)) {
+ return $input;
+ }
+ else {
+ $result = utf8_encode($input);
+ }
+
+ return $result;
+
+ }
+
+ function make_cache_key($request) {
+ $string = $request['uri'] . '|' . serialize($request['headers']) . '|' . $request['cacheable_query_string'];
+ return $this->cache_prefix . md5($string);
+ }
+
+ function return_all_results($response) {
+ if ($response['success'] == true) {
+ return $response['results'];
+ }
+ else {
+ return false;
+ }
+ }
+
+ function return_first_result($response) {
+ if ($response['success'] == true) {
+ if (count($response['results']) > 0) {
+ return $response['results'][0];
+ }
+ else {
+ return null;
+ }
+ }
+ else {
+ return false;
+ }
+ }
+
+
+ /*
+ * API services
+ */
+
+ function MakeAPICall($method, $service, $cache_time = 0, $params = array(), $post_data = null, $a_retry = false) {
+
+ if ($this->transport == null) {
+ $this->SetTransport(new flexmlsAPI_CurlTransport);
+ }
+
+ // parse format like "5m" into 300 seconds
+ $seconds_to_cache = $this->parse_cache_time($cache_time);
+
+ $request = array(
+ 'protocol' => ($this->force_https or $service == 'session') ? 'https' : 'http',
+ 'method' => $method,
+ 'uri' => '/' . $this->api_version . '/' . $service,
+ 'host' => $this->api_base,
+ 'headers' => $this->headers,
+ 'params' => $params,
+ 'post_data' => $post_data
+ );
+
+ // delegate to chosen authentication method for necessary changes to request
+ $this->sign_request(&$request);
+
+ $served_from_cache = false;
+
+ if ($this->cache and $method == "GET" and $a_retry != true and $seconds_to_cache > 0) {
+ $response = $this->cache->get($this->make_cache_key($request));
+ if ($response !== null) {
+ $served_from_cache = true;
+ }
+ }
+
+ if ($served_from_cache !== true) {
+ $response = $this->transport->make_request($request);
+ $response = $this->utf8_encode_mix($response);
+ }
+
+ $json = json_decode($response['body'], true);
+
+
+ $return = array();
+ $return['http_code'] = $response['http_code'];
+
+ if (!is_array($json)) {
+ // the response wasn't JSON as expected so bail out with the original, unparsed body
+ $return['body'] = $response['body'];
+ return $return;
+ }
+
+ if (array_key_exists('D', $json)) {
+ if (array_key_exists('Code', $json['D'])) {
+ $this->last_error_code = $json['D']['Code'];
+ $return['api_code'] = $json['D']['Code'];
+ }
+
+ if (array_key_exists('Message', $json['D'])) {
+ $this->last_error_mess = $json['D']['Message'];
+ $return['api_message'] = $json['D']['Message'];
+ }
+
+ if (array_key_exists('Pagination', $json['D'])) {
+ $this->last_count = $json['D']['Pagination']['TotalRows'];
+ $this->page_size = $json['D']['Pagination']['PageSize'];
+ $this->total_pages = $json['D']['Pagination']['TotalPages'];
+ $this->current_page = $json['D']['Pagination']['CurrentPage'];
+ }
+ else {
+ $this->last_count = null;
+ $this->page_size = null;
+ $this->total_pages = null;
+ $this->current_page = null;
+ }
+
+ if ($json['D']['Success'] == true) {
+ $return['success'] = true;
+ $return['results'] = $json['D']['Results'];
+ }
+ else {
+ $return['success'] = false;
+ }
+ }
+
+ if (array_key_exists('access_token', $json)) {
+ // looks like a successful OAuth grant response
+ $return['success'] = true;
+ $return['results'] = $json;
+ }
+
+ if (array_key_exists('error', $json)) {
+ // looks like a failed OAuth grant response
+ $return['success'] = false;
+ $this->last_error_code = $json['error'];
+ $this->last_error_mess = $json['error_description'];
+ }
+
+ if ($return['success'] == true and $served_from_cache != true and $method == "GET" and $seconds_to_cache > 0) {
+ if ($this->cache) {
+ $this->cache->set($this->make_cache_key($request), $response, $seconds_to_cache);
+ }
+ }
+
+ if ($return['success'] == false and $a_retry == false) {
+ // see if this is a retry-type request
+ if ($this->is_auth_request($request) == false and ($this->last_error_code == 1020 or $this->last_error_code == 1000)) {
+ $retry = $this->ReAuthenticate();
+ if (!$retry) {
+ return $retry;
+ }
+ $return = $this->MakeAPICall($method, $service, $cache_time, $params, $post_data, true);
+ return $return;
+ }
+ }
+
+ return $return;
+
+ }
+
+
+ function HasBasicRole() {
+ return false;
+ }
+
+
+ /*
+ * Listing services
+ */
+
+ function GetListings($params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings", '10m', $params));
+ }
+
+ function GetListing($id, $params = array()) {
+ return $this->return_first_result($this->MakeAPICall("GET", "listings/" . $id, '10m', $params));
+ }
+
+ function GetMyListings($params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "my/listings", '10m', $params));
+ }
+
+ function GetOfficeListings($params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "office/listings", '10m', $params));
+ }
+
+ function GetCompanyListings($params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "company/listings", '10m', $params));
+ }
+
+ function GetListingPhotos($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/photos", '10m'));
+ }
+
+ function GetListingPhoto($id, $sid) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/photos/" . $sid, '10m'));
+ }
+
+ function GetListingVideos($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/videos", '10m'));
+ }
+
+ function GetListingVideo($id, $sid) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/videos/" . $sid, '10m'));
+ }
+
+ function GetListingOpenHouses($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/openhouses", '10m'));
+ }
+
+ function GetListingOpenHouse($id, $sid) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/openhouses/" . $sid, '10m'));
+ }
+
+ function GetListingVirtualTours($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/virtualtours", '10m'));
+ }
+
+ function GetListingVirtualTour($id, $sid) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/virtualtours/" . $sid, '10m'));
+ }
+
+ function GetListingDocuments($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/documents", '10m'));
+ }
+
+ function GetListingDocument($id, $sid) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/documents/" . $sid, '10m'));
+ }
+
+ function GetSharedListingNotes($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listings/" . $id . "/shared/notes", '10m'));
+ }
+
+
+ /*
+ * Account services
+ */
+
+ function GetAccounts($params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "accounts", '1h', $params));
+ }
+
+ function GetAccount($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "accounts/" . $id, '1h'));
+ }
+
+ function GetAccountsByOffice($id, $params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "accounts/by/office/" . $id, '1h', $params));
+ }
+
+ function GetMyAccount() {
+ return $this->return_first_result($this->MakeAPICall("GET", "my/account", '1h'));
+ }
+
+ function UpdateMyAccount($data) {
+ return $this->return_all_results($this->MakeAPICall("PUT", "my/account", '1h', array(), $this->make_sendable_body($data)));
+ }
+
+
+ /*
+ * Contacts services
+ */
+
+ function GetContacts($tags = null, $params = array()) {
+ if (!is_null($tags)) {
+ return $this->return_all_results($this->MakeAPICall("GET", "contacts/tags/" . rawurlencode($tags), 0, $params));
+ }
+ else {
+ return $this->return_all_results($this->MakeAPICall("GET", "contacts", 0, $params));
+ }
+ }
+
+ function AddContact($contact_data) {
+ $data = array('Contacts' => array($contact_data));
+ return $this->return_all_results($this->MakeAPICall("POST", "contacts", 0, array(), $this->make_sendable_body($data)));
+ }
+
+ function GetContact($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "contacts/" . $id));
+ }
+
+ function MyContact() {
+ return $this->return_first_result($this->MakeAPICall("GET", "my/contact"));
+ }
+
+
+ /*
+ * Listing Carts services
+ */
+
+ function GetListingCarts() {
+ return $this->return_all_results($this->MakeAPICall("GET", "listingcarts"));
+ }
+
+ function GetListingCartsWithListing($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listingcarts/for/listing/" . $id));
+ }
+
+ function GetPortalListingCarts() {
+ return $this->return_all_results($this->MakeAPICall("GET", "listingcarts/portal"));
+ }
+
+ function AddListingCart($name, $listings) {
+ $data = array('ListingCarts' => array(array('Name' => $name, 'ListingIds' => $listings)));
+ return $this->return_all_results($this->MakeAPICall("POST", "listingcarts", 0, array(), $this->make_sendable_body($data)));
+ }
+
+ function GetListingCart($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "listingcarts/" . $id));
+ }
+
+ function AddListingsToCart($id, $listings) {
+ $data = array('ListingIds' => $listings);
+ return $this->return_all_results($this->MakeAPICall("POST", "listingcarts/" . $id, 0, array(), $this->make_sendable_body($data)));
+ }
+
+ function UpdateListingsInCart($id, $listings) {
+ $data = array('ListingIds' => $listings);
+ return $this->return_all_results($this->MakeAPICall("PUT", "listingcarts/" . $id, 0, array(), $this->make_sendable_body($data)));
+ }
+
+ function DeleteListingCart($id) {
+ return $this->return_all_results($this->MakeAPICall("DELETE", "listingcarts/" . $id));
+ }
+
+ function DeleteListingsFromCart($id, $listings) {
+ return $this->return_all_results($this->MakeAPICall("DELETE", "listingcarts/" . $id . "/listings/" . $listings));
+ }
+
+
+ /*
+ * Market Statistics services
+ */
+
+ function GetMarketStats($type, $options = "", $property_type = "", $location_name = "", $location_value = "") {
+
+ $args = array();
+
+ if (!empty($options)) {
+ $args['Options'] = $options;
+ }
+
+ if (!empty($property_type)) {
+ $args['PropertyTypeCode'] = $property_type;
+ }
+
+ if (!empty($location_name)) {
+ $args['LocationField'] = $location_name;
+ $args['LocationValue'] = $location_value;
+ }
+
+ return $this->return_first_result($this->MakeAPICall("GET", "marketstatistics/" . $type, '48h', $args));
+ }
+
+
+ /*
+ * Messaging services
+ */
+
+ function AddMessage($data) {
+ $data = array('Messages' => $data);
+ return $this->return_all_results($this->MakeAPICall("POST", "messages", 0, array(), $this->make_sendable_body($data)));
+ }
+
+ /*
+ * Saved Searches services
+ */
+
+ function GetSavedSearches() {
+ return $this->return_all_results($this->MakeAPICall("GET", "savedsearches", '30m'));
+ }
+
+ function GetSavedSearch($id) {
+ return $this->return_all_results($this->MakeAPICall("GET", "savedsearches/" . $id, '30m'));
+ }
+
+
+ /*
+ * Shared Listings services
+ * TODO
+ */
+
+
+ /*
+ * IDX Links services
+ */
+
+ function GetIDXLinks($params = array()) {
+ return $this->return_all_results($this->MakeAPICall("GET", "idxlinks", '24h', $params));
+ }
+
+ function GetIDXLink($id) {
+ return $this->return_first_result($this->MakeAPICall("GET", "idxlinks/" . $id, '24h'));
+ }
+
+ function GetTransformedIDXLink($link, $args = array()) {
+ $response = $this->return_first_result($this->MakeAPICall("GET", "redirect/idxlink/" . $link, '30m', $args));
+
+ if ($response != null) {
+ return $response['Uri'];
+ }
+
+ return $response;
+ }
+
+
+ /*
+ * Preferences services
+ */
+
+ function GetPreferences() {
+ $response = $this->return_all_results($this->MakeAPICall("GET", "connect/prefs", '24h'));
+
+ $records = array();
+ foreach ($response as $pref) {
+ $records[$pref['Name']] = $pref['Value'];
+ }
+
+ return $records;
+ }
+
+
+ /*
+ * Property Types services
+ */
+
+ function GetPropertyTypes() {
+ $response = $this->MakeAPICall("GET", "propertytypes", '24h');
+
+ if ($response['success'] == true) {
+ $records = array();
+ foreach ($response['results'] as $res) {
+ $records[$res['MlsCode']] = $res['MlsName'];
+ }
+
+ return $records;
+ }
+ else {
+ return false;
+ }
+ }
+
+
+ /*
+ * Standard Fields services
+ */
+
+ function GetStandardFields() {
+ return $this->return_all_results($this->MakeAPICall("GET", "standardfields", '24h'));
+ }
+
+ function GetStandardFieldList($field) {
+ $data = $this->return_first_result($this->MakeAPICall("GET", "standardfields/" . $field, '24h'));
+ if ($data) {
+ return $data[$field]['FieldList'];
+ }
+ else {
+ return $data;
+ }
+ }
+
+
+ /*
+ * Custom Fields services
+ */
+
+ function GetCustomFields($prop_type) {
+ return $this->return_all_results($this->MakeAPICall("GET", "customfields/" . $prop_type, '24h'));
+ }
+
+
+ /*
+ * System Info services
+ */
+
+ function GetSystemInfo() {
+ return $this->return_first_result($this->MakeAPICall("GET", "system", '24h'));
+ }
+
+
+}
12 lib/CoreTransport.php
@@ -0,0 +1,12 @@
+<?php
+
+class flexmlsAPI_CoreTransport {
+
+
+ function __construct() {
+
+ }
+
+
+
+}
59 lib/CurlTransport.php
@@ -0,0 +1,59 @@
+<?php
+
+class flexmlsAPI_CurlTransport extends flexmlsAPI_CoreTransport implements flexmlsAPI_TransportInterface {
+ protected $ch = null;
+
+ function __construct() {
+ // initialize cURL for use later
+ $this->ch = curl_init();
+ curl_setopt($this->ch, CURLOPT_HEADER, false);
+ curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($this->ch, CURLOPT_TIMEOUT, 0);
+ curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, false);
+ curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, false);
+ curl_setopt($this->ch, CURLOPT_ENCODING, "gzip");
+ }
+
+ function __destruct() {
+ // clean cURL up
+ curl_close($this->ch);
+ }
+
+ function make_request($request = array()) {
+
+// print_r($request);
+
+ $request_headers_flat = "";
+ foreach ($request['headers'] as $k => $v) {
+ $request_headers_flat .= "{$k}: {$v}\r\n";
+ }
+
+ $full_url = $request['protocol'] .'://'. $request['host'] . $request['uri'];
+ if ( !empty($request['query_string']) ) {
+ $full_url .= '?'. $request['query_string'];
+ }
+
+ curl_setopt($this->ch, CURLOPT_URL, $full_url);
+
+ if ($request['method'] == "POST") {
+ curl_setopt($this->ch, CURLOPT_POST, 1);
+ curl_setopt($this->ch, CURLOPT_POSTFIELDS, $request['post_data']);
+ }
+ else {
+ curl_setopt($this->ch, CURLOPT_POST, 0);
+ }
+
+ curl_setopt($this->ch, CURLOPT_HTTPHEADER, array(trim($request_headers_flat)));
+
+ $response_body = curl_exec($this->ch);
+ $response_info = curl_getinfo($this->ch);
+
+ $response_info['body'] = $response_body;
+
+// print_r($response_info);
+
+ return $response_info;
+
+ }
+
+}
30 lib/MemcacheCache.php
@@ -0,0 +1,30 @@
+<?php
+
+class flexmlsAPI_MemcacheCache implements flexmlsAPI_CacheInterface {
+ protected $cache = null;
+
+ protected $host = null;
+ protected $port = null;
+
+
+ function __construct($host = 'localhost', $port = 11211) {
+ $this->host = $host;
+ $this->port = $port;
+ $this->cache = new Memcache;
+ $this->cache->connect($host, $port);
+ }
+
+ function get($key) {
+ $value = $this->cache->get($key);
+ if ($value !== false) {
+ return $value;
+ }
+ return null;
+ }
+
+ function set($key, $value, $expire) {
+ return $this->cache->set($key, $value, 0, $expire);
+ }
+
+
+}
30 lib/MemcachedCache.php
@@ -0,0 +1,30 @@
+<?php
+
+class flexmlsAPI_MemcachedCache implements flexmlsAPI_CacheInterface {
+ protected $cache = null;
+
+ protected $host = null;
+ protected $port = null;
+
+
+ function __construct($host = 'localhost', $port = 11211) {
+ $this->host = $host;
+ $this->port = $port;
+ $this->cache = new Memcached;
+ $this->cache->addServer($host, $port);
+ }
+
+ function get($key) {
+ $value = $this->cache->get($key);
+ if ($value !== false) {
+ return $value;
+ }
+ return null;
+ }
+
+ function set($key, $value, $expire) {
+ return $this->cache->set($key, $value, time() + $expire);
+ }
+
+
+}
89 lib/MySQLiCache.php
@@ -0,0 +1,89 @@
+<?php
+
+class flexmlsAPI_MySQLiCache implements flexmlsAPI_CacheInterface {
+ protected $cache = null;
+
+ protected $hostname = null;
+ protected $database = null;
+ protected $username = null;
+ protected $password = null;
+ protected $table_name = null;
+ protected $conn = null;
+
+
+ function __construct($hostname = 'localhost', $database = '', $username = '', $password = '', $table_name = 'api_cache') {
+
+ // check if $hostname given is actually an object (pre-existing mysqli connection)
+ if ( is_object($hostname)) {
+ $this->conn = $hostname;
+ }
+ else {
+ // make a new connection to the database
+ $this->conn = new mysqli($hostname, $username, $password, $database);
+ if ($this->conn->connect_error) {
+ $this->conn = null;
+ }
+ }
+
+ $this->table_name = $table_name;
+
+ }
+
+ function get($key) {
+ // check if
+ if (!$this->conn) {
+ return null;
+ }
+
+ $this->check_gc();
+
+ $sql = "SELECT `cache_value`
+ FROM `". $this->table_name ."`
+ WHERE `cache_key` = '". $this->quote($key) ."' AND `expiration` > unix_timestamp()
+ LIMIT 1";
+
+ if ($result = $this->conn->query($sql)) {
+ $row = $result->fetch_assoc();
+ if ($row !== null) {
+ return unserialize($row['cache_value']);
+ }
+ }
+
+ return null;
+ }
+
+ function set($key, $value, $expire) {
+ if (!$this->conn) {
+ return null;
+ }
+
+ $this->check_gc();
+
+ $value = serialize($value);
+
+ $new_expire = time() + $expire;
+
+ $sql = "INSERT INTO `". $this->table_name ."` (`cache_key`, `cache_value`, `expiration`)
+ VALUES ('". $this->quote($key) ."', '". $this->quote($value) ."', ". $this->quote($new_expire) .")
+ ON DUPLICATE KEY UPDATE `cache_value`='". $this->quote($value) ."', `expiration`=". $this->quote($new_expire);
+
+ return $this->conn->query($sql);
+ }
+
+ function quote($value) {
+ return $this->conn->real_escape_string($value);
+ }
+
+ function check_gc() {
+ $random_number = rand(1, 1000);
+ if ($random_number === 1) {
+ $this->gc();
+ }
+ }
+
+ function gc() {
+ return $this->conn->query("DELETE FROM `". $this->table_name ."` WHERE `expiration` < unit_timestamp()");
+ }
+
+
+}
98 lib/OAuth.php
@@ -0,0 +1,98 @@
+<?php
+
+class flexmlsAPI_OAuth extends flexmlsAPI_Core implements flexmlsAPI_AuthInterface {
+ protected $force_https = true;
+ protected $api_client_id = null;
+ protected $api_client_secret = null;
+ protected $oauth_redirect_uri = null;
+ public $oauth_access_token = null;
+ public $oauth_refresh_token = null;
+ protected $oauth_grant_code = null;
+
+ function __construct($api_client_id, $api_client_secret, $redirect_uri, $access_token = null) {
+ $this->api_client_id = $api_client_id;
+ $this->api_client_secret = $api_client_secret;
+ $this->oauth_redirect_uri = $redirect_uri;
+ $this->SetAccessToken($access_token);
+
+ $this->auth_mode = 'oauth';
+
+ parent::__construct();
+ }
+
+ function sign_request($request) {
+ $this->SetHeader('Authorization', 'OAuth '. $this->last_token);
+
+ // reload headers into request
+ $request['headers'] = $this->headers;
+ $request['query_string'] = http_build_query($request['params']);
+ $request['cacheable_query_string'] = $request['query_string'];
+ }
+
+ function is_auth_request($request) {
+ return ($request['uri'] == '/'. $this->api_version .'/oauth2/grant') ? true : false;
+ }
+
+ function Grant($code, $type = 'authorization_code') {
+ $body = array(
+ 'client_id' => $this->api_client_id,
+ 'client_secret' => $this->api_client_secret,
+ 'grant_type' => $type,
+ 'redirect_uri' => $this->oauth_redirect_uri
+ );
+
+ if ($type == 'authorization_code') {
+ $body['code'] = $code;
+ }
+ if ($type == 'refresh_token') {
+ $body['refresh_token'] = $code;
+ }
+
+ $response = $this->MakeAPICall("POST", "oauth2/grant", '0s', array(), json_encode($body) );
+
+ if ($response['success'] == true) {
+ $this->SetAccessToken( $response['results']['access_token'] );
+ $this->SetRefreshToken( $response['results']['refresh_token'] );
+
+ if ( is_callable($this->access_change_callback) ) {
+ call_user_func($this->access_change_callback, 'oauth', array('access_token' => $this->oauth_access_token, 'refresh_token' => $this->oauth_refresh_token) );
+ }
+
+ return true;
+ }
+ else {
+ return false;
+ }
+
+ }
+
+ function SetAccessToken($token) {
+ $this->oauth_access_token = $token;
+ $this->last_token = $token;
+ }
+
+ function SetRefreshToken($token) {
+ $this->oauth_refresh_token = $token;
+ }
+
+
+ /*
+ * Authentication
+ */
+
+ function Authenticate() {
+ return true;
+ }
+
+ function ReAuthenticate() {
+ if ( !empty($this->oauth_refresh_token) ) {
+ return $this->Grant($this->oauth_refresh_token, 'refresh_token');
+ }
+ return false;
+ }
+
+ function Ping() {
+ return $this->return_all_results( $this->MakeAPICall("GET", "my/account") );
+ }
+
+}
7 lib/TransportInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+interface flexmlsAPI_TransportInterface {
+
+ function make_request($req = array());
+
+}
19 lib/WordPressCache.php
@@ -0,0 +1,19 @@
+<?php
+
+class flexmlsAPI_WordPressCache implements flexmlsAPI_CacheInterface {
+
+
+ function get($key) {
+ $value = get_transient($key);
+ if ($value !== false) {
+ return $value;
+ }
+ return null;
+ }
+
+ function set($key, $value, $expire) {
+ return set_transient($key, $value, $expire);
+ }
+
+
+}
0  lib/WordPressTransport.php
No changes.
Please sign in to comment.
Something went wrong with that request. Please try again.