diff --git a/pnut/LICENSE b/pnut/LICENSE
new file mode 100644
index 00000000..fe6b9036
--- /dev/null
+++ b/pnut/LICENSE
@@ -0,0 +1,662 @@
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU 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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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
+.
+
diff --git a/pnut/README.md b/pnut/README.md
new file mode 100644
index 00000000..d935efe7
--- /dev/null
+++ b/pnut/README.md
@@ -0,0 +1,5 @@
+# Pnut connector
+
+With this addon to friendica you can give your users the possibility to post their *public* messages to pnut.io.
+
+No setup is needed for the admins to make it work for their users.
diff --git a/pnut/lib/LICENSE b/pnut/lib/LICENSE
new file mode 100644
index 00000000..579599a8
--- /dev/null
+++ b/pnut/lib/LICENSE
@@ -0,0 +1,24 @@
+Copyright (c) 2013, Josh Dolitsky
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of the Josh Dolitsky nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL TRAVIS RICHARDSON BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/pnut/lib/phpnut.php b/pnut/lib/phpnut.php
new file mode 100644
index 00000000..303a860b
--- /dev/null
+++ b/pnut/lib/phpnut.php
@@ -0,0 +1,2504 @@
+_clientId = $client_id_or_token;
+ $this->_clientSecret = $client_secret;
+ } else {
+ $this->_accessToken = $client_id_or_token;
+ }
+
+ // if the digicert certificate exists in the same folder as this file,
+ // remember that fact for later
+ if (file_exists(__DIR__ . '/DigiCertHighAssuranceEVRootCA.pem')) {
+ $this->_sslCA = __DIR__ . '/DigiCertHighAssuranceEVRootCA.pem';
+ }
+ }
+
+ /**
+ * Set whether or not to strip Envelope Response (meta) information
+ * This option will be deprecated in the future. Is it to allow
+ * a stepped migration path between code expecting the old behavior
+ * and new behavior. When not stripped, you still can use the proper
+ * method to pull the meta information. Please start converting your code ASAP
+ */
+ public function includeResponseEnvelope(): void
+ {
+ $this->_stripResponseEnvelope = false;
+ }
+
+ /**
+ * Construct the proper Auth URL for the user to visit and either grant
+ * or not access to your app. Usually you would place this as a link for
+ * the user to client, or a redirect to send them to the auth URL.
+ * Also can be called after authentication for additional scopes
+ * @param string $callbackUri Where you want the user to be directed
+ * after authenticating with pnut.io. This must be one of the URIs
+ * allowed by your pnut.io application settings.
+ * @param array $scope An array of scopes (permissions) you wish to obtain
+ * from the user. If you don't specify anything, you'll only receive
+ * access to the user's basic profile (the default).
+ */
+ public function getAuthUrl(?string $callback_uri=null, array|string|null $scope=null): string
+ {
+ if (empty($this->_clientId)) {
+ throw new phpnutException('You must specify your pnut client ID');
+ }
+
+ if (is_null($callback_uri)) {
+ if (defined('PNUT_REDIRECT_URI')) {
+ $callback_uri = PNUT_REDIRECT_URI;
+ } elseif (isset($_ENV['PNUT_REDIRECT_URI'])) {
+ $callback_uri = $_ENV['PNUT_REDIRECT_URI'];
+ } else {
+ throw new phpnutException('You must specify your pnut callback URI');
+ }
+ }
+
+ if (is_null($scope)) {
+ if (defined('PNUT_APP_SCOPE')) {
+ $scope = PNUT_APP_SCOPE;
+ } elseif (isset($_ENV['PNUT_APP_SCOPE'])) {
+ $scope = $_ENV['PNUT_APP_SCOPE'];
+ } else {
+ $scope = 'basic';
+ }
+ }
+
+ if (is_array($scope)) {
+ $scope = implode(',', $scope);
+ }
+
+ // construct an authorization url based on our client id and other data
+ $data = [
+ 'client_id'=>$this->_clientId,
+ 'response_type'=>'code',
+ 'redirect_uri'=>$callback_uri,
+ 'scope'=>$scope,
+ ];
+
+ $url = $this->_authUrl;
+ if ($this->_accessToken) {
+ $url .= 'authorize?';
+ } else {
+ $url .= 'authenticate?';
+ }
+ $url .= $this->buildQueryString($data);
+
+ // return the constructed url
+ return $url;
+ }
+
+ /**
+ * Call this after they return from the auth page, or anytime you need the
+ * token. For example, you could store it in a database and use
+ * setAccessToken() later on to return on behalf of the user.
+ */
+ public function getAccessToken(string $callback_uri)
+ {
+ // if there's no access token set, and they're returning from
+ // the auth page with a code, use the code to get a token
+ if (!$this->_accessToken && isset($_GET['code']) && $_GET['code'] !== '') {
+
+ if (empty($this->_clientId) || empty($this->_clientSecret)) {
+ throw new phpnutException('You must specify your Pnut client ID and client secret');
+ }
+
+ // construct the necessary elements to get a token
+ $data = [
+ 'client_id'=>$this->_clientId,
+ 'client_secret'=>$this->_clientSecret,
+ 'grant_type'=>'authorization_code',
+ 'redirect_uri'=>$callback_uri,
+ 'code'=>$_GET['code'],
+ ];
+
+ // try and fetch the token with the above data
+ $res = $this->httpReq(
+ 'post',
+ "{$this->_baseUrl}oauth/access_token",
+ $data
+ );
+
+ // store it for later
+ $this->_accessToken = $res['access_token'];
+ $this->_username = $res['username'];
+ $this->_user_id = $res['user_id'];
+ }
+
+ // return what we have (this may be a token, or it may be nothing)
+ return $this->_accessToken;
+ }
+
+ /**
+ * Check the scope of current token to see if it has required scopes
+ * has to be done after a check
+ */
+ public function checkScopes(array $app_scopes): int|array
+ {
+ if (count($this->_scopes) === 0) {
+ return -1; // _scope is empty
+ }
+ $missing = [];
+ foreach($app_scopes as $scope) {
+ if (!in_array($scope, $this->_scopes)) {
+ if ($scope === 'public_messages') {
+ // messages works for public_messages
+ if (in_array('messages', $this->_scopes)) {
+ // if we have messages in our scopes
+ continue;
+ }
+ }
+ $missing[] = $scope;
+ }
+ }
+ // identify the ones missing
+ if (count($missing) !== 0) {
+ // do something
+ return $missing;
+ }
+ return 0; // 0 missing
+ }
+
+ /**
+ * Set the access token (eg: after retrieving it from offline storage)
+ * @param string $token A valid access token you're previously received
+ * from calling getAccessToken().
+ */
+ public function setAccessToken(?string $token=null): void
+ {
+ $this->_accessToken = $token;
+ }
+
+ /**
+ * Deauthorize the current token (delete your authorization from the API)
+ * Generally this is useful for logging users out from a web app, so they
+ * don't get automatically logged back in the next time you redirect them
+ * to the authorization URL.
+ */
+ public function deauthorizeToken()
+ {
+ return $this->httpReq('delete', "{$this->_baseUrl}token");
+ }
+
+ /**
+ * Retrieve an app access token from the app.net API. This allows you
+ * to access the API without going through the user access flow if you
+ * just want to (eg) consume global. App access tokens are required for
+ * some actions (like streaming global). DO NOT share the return value
+ * of this function with any user (or save it in a cookie, etc). This
+ * is considered secret info for your app only.
+ * @return string The app access token
+ */
+ public function getAppAccessToken()
+ {
+ if (empty($this->_clientId) || empty($this->_clientSecret)) {
+ throw new phpnutException('You must specify your Pnut client ID and client secret');
+ }
+
+ // construct the necessary elements to get a token
+ $data = [
+ 'client_id'=>$this->_clientId,
+ 'client_secret'=>$this->_clientSecret,
+ 'grant_type'=>'client_credentials',
+ ];
+ // try and fetch the token with the above data
+ $res = $this->httpReq(
+ 'post',
+ "{$this->_baseUrl}oauth/access_token",
+ $data
+ );
+ // store it for later
+ $this->_appAccessToken = $res['access_token'];
+ $this->_accessToken = $res['access_token'];
+ $this->_username = null;
+ $this->_user_id = null;
+ return $this->_accessToken;
+ }
+
+ /**
+ * Returns the total number of requests you're allowed within the
+ * alloted time period.
+ * @see getRateLimitReset()
+ */
+ public function getRateLimit()
+ {
+ return $this->_rateLimit;
+ }
+
+ /**
+ * The number of requests you have remaining within the alloted time period
+ * @see getRateLimitReset()
+ */
+ public function getRateLimitRemaining()
+ {
+ return $this->_rateLimitRemaining;
+ }
+
+ /**
+ * The number of seconds remaining in the alloted time period.
+ * When this time is up you'll have getRateLimit() available again.
+ */
+ public function getRateLimitReset()
+ {
+ return $this->_rateLimitReset;
+ }
+
+ /**
+ * The scope the user has
+ */
+ public function getScope()
+ {
+ return $this->_scope;
+ }
+
+ /**
+ * Internal function, parses out important information pnut.io adds
+ * to the headers.
+ */
+ protected function parseHeaders(string $response)
+ {
+ // take out the headers
+ // set internal variables
+ // return the body/content
+ $this->_rateLimit = null;
+ $this->_rateLimitRemaining = null;
+ $this->_rateLimitReset = null;
+ $this->_scope = null;
+
+ $response = explode("\r\n\r\n", $response, 2);
+ $headers = $response[0];
+
+ if ($headers === 'HTTP/1.1 100 Continue') {
+ $response = explode("\r\n\r\n", $response[1], 2);
+ $headers = $response[0];
+ }
+
+ // this is not a good way to parse http headers
+ // it will not (for example) take into account multiline headers
+ // but what we're looking for is pretty basic, so we can ignore those shortcomings
+ $headers = explode("\r\n", $headers);
+ foreach ($headers as $header) {
+ $header = explode(': ', $header, 2);
+ if (count($header) < 2) {
+ continue;
+ }
+ list($k, $v) = $header;
+ switch ($k) {
+ case 'X-RateLimit-Remaining':
+ $this->_rateLimitRemaining = $v;
+ break;
+ case 'X-RateLimit-Limit':
+ $this->_rateLimit = $v;
+ break;
+ case 'X-RateLimit-Reset':
+ $this->_rateLimitReset = $v;
+ break;
+ case 'X-OAuth-Scopes':
+ $this->_scope = $v;
+ $this->_scopes = explode(',', $v);
+ break;
+ }
+ }
+ return $response[1] ?? null;
+ }
+
+ /**
+ * Internal function. Used to turn things like TRUE into 1, and then
+ * calls http_build_query.
+ */
+ protected function buildQueryString(array $array): string
+ {
+ foreach ($array as $k => &$v) {
+ if (is_array($v)) {
+ $v = implode(',', $v);
+ } elseif ($v === true) {
+ $v = '1';
+ }
+ elseif ($v === false) {
+ $v = '0';
+ }
+ unset($v);
+ }
+ return http_build_query($array);
+ }
+
+
+ /**
+ * Internal function to handle all
+ * HTTP requests (POST,PUT,GET,DELETE)
+ */
+ protected function httpReq(string $act, string $req, string|array $params=[], string $contentType='application/x-www-form-urlencoded')
+ {
+ $ch = curl_init($req);
+ $headers = [];
+ if($act !== 'get') {
+ curl_setopt($ch, CURLOPT_POST, true);
+ // if they passed an array, build a list of parameters from it
+ if (is_array($params) && $act !== 'post-raw') {
+ $params = $this->buildQueryString($params);
+ }
+ curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
+ $headers[] = "Content-Type: {$contentType}";
+ }
+ if($act !== 'post' && $act !== 'post-raw') {
+ curl_setopt($ch, CURLOPT_CUSTOMREQUEST, strtoupper($act));
+ }
+ if($act === 'get' && isset($params['access_token'])) {
+ $headers[] = "Authorization: Bearer {$params['access_token']}";
+ } elseif ($this->_accessToken) {
+ $headers[] = "Authorization: Bearer {$this->_accessToken}";
+ }
+ curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
+ curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($ch, CURLINFO_HEADER_OUT, true);
+ curl_setopt($ch, CURLOPT_HEADER, true);
+ if ($this->_sslCA) {
+ curl_setopt($ch, CURLOPT_CAINFO, $this->_sslCA);
+ }
+ $this->_last_response = curl_exec($ch);
+ $this->_last_request = curl_getinfo($ch, CURLINFO_HEADER_OUT);
+ $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+ curl_close($ch);
+
+ if ($http_status === 0) {
+ throw new phpnutException("Unable to connect to {$req}");
+ }
+ if ($this->_last_request === false) {
+ if (!curl_getinfo($ch, CURLINFO_SSL_VERIFYRESULT)) {
+ throw new phpnutException('SSL verification failed, connection terminated.');
+ }
+ }
+ if ($this->_last_response) {
+ $response = $this->parseHeaders($this->_last_response);
+ if ($response) {
+ $response = json_decode($response, true);
+
+ if (isset($response['meta'])) {
+ if (isset($response['meta']['max_id'])) {
+ $this->_maxid = $response['meta']['max_id'];
+ $this->_minid = $response['meta']['min_id'];
+ }
+ if (isset($response['meta']['more'])) {
+ $this->_more = $response['meta']['more'];
+ }
+ if (isset($response['meta']['marker'])) {
+ $this->_last_marker = $response['meta']['marker'];
+ }
+ }
+
+ // look for errors
+ if (isset($response['error'])) {
+ if (is_array($response['error'])) {
+ throw new phpnutException(
+ $response['error']['message'],
+ $response['error']['code']
+ );
+ } else {
+ throw new phpnutException($response['error']);
+ }
+ }
+
+ // look for response migration errors
+ elseif (isset($response['meta'], $response['meta']['error_message'])) {
+ throw new phpnutException(
+ $response['meta']['error_message'],
+ $response['meta']['code']
+ );
+ }
+ }
+ }
+
+ if ($http_status < 200 || $http_status >= 300) {
+ throw new phpnutException("HTTP error {$http_status}");
+ }
+
+ // if we've received a migration response, handle it and return data only
+ elseif ($this->_stripResponseEnvelope && isset($response['meta'], $response['data'])) {
+ return $response['data'];
+ }
+
+ // else non response migration response, just return it
+ elseif (isset($response)) {
+ return $response;
+ }
+
+ else {
+ throw new phpnutException('No response');
+ }
+ }
+
+
+ /**
+ * Get max_id from last meta response data envelope
+ */
+ public function getResponseMaxID()
+ {
+ return $this->_maxid;
+ }
+
+ /**
+ * Get min_id from last meta response data envelope
+ */
+ public function getResponseMinID()
+ {
+ return $this->_minid;
+ }
+
+ /**
+ * Get more from last meta response data envelope
+ */
+ public function getResponseMore()
+ {
+ return $this->_more;
+ }
+
+ /**
+ * Get marker from last meta response data envelope
+ */
+ public function getResponseMarker()
+ {
+ return $this->_last_marker;
+ }
+
+ public function getLastRequest()
+ {
+ return $this->_last_request;
+ }
+
+ public function getLastResponse()
+ {
+ return $this->_last_response;
+ }
+
+ /**
+ * Fetch API configuration object
+ * @return array
+ */
+ public function getConfig()
+ {
+ return $this->httpReq('get', "{$this->_baseUrl}sys/config");
+ }
+
+ /**
+ * Fetch basic API statistics
+ * @return array
+ */
+ public function getStats()
+ {
+ return $this->httpReq('get', "{$this->_baseUrl}sys/stats");
+ }
+
+ /**
+ * Process user content, message or post text.
+ * Mentions and hashtags will be parsed out of the
+ * text, as will bare URLs. To create a link in the text without using a
+ * bare URL, include the anchor text in the object text and include a link
+ * entity in the function call.
+ * @param string $text The text of the user/message/post
+ * @param array $data An associative array of optional post data. This
+ * will likely change as the API evolves, as of this writing allowed keys are:
+ * reply_to, and raw. "raw" may be a complex object represented
+ * by an associative array.
+ * @param array $params An associative array of optional data to be included
+ * in the URL (such as 'include_raw')
+ * @return array An associative array representing the post.
+ */
+ public function processText(string $text, array $data=[], array $params=[])
+ {
+ $data['text'] = $text;
+ $json = json_encode($data);
+ $qs = '';
+ if (!empty($params)) {
+ $qs = '?' . $this->buildQueryString($params);
+ }
+ return $this->httpReq(
+ 'post',
+ $this->_baseUrl . 'text/process' . $qs,
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Create a new Post object. Mentions and hashtags will be parsed out of the
+ * post text, as will bare URLs. To create a link in a post without using a
+ * bare URL, include the anchor text in the post's text and include a link
+ * entity in the post creation call.
+ * @param string $text The text of the post
+ * @param array $data An associative array of optional post data. This
+ * will likely change as the API evolves, as of this writing allowed keys are:
+ * reply_to, is_nsfw, and raw. "raw" may be a complex object represented
+ * by an associative array.
+ * @param array $params An associative array of optional data to be included
+ * in the URL (such as 'include_raw')
+ * @return array An associative array representing the post.
+ */
+ public function createPost(string $text, array $data=[], array $params=[])
+ {
+ $data['text'] = $text;
+ $json = json_encode($data);
+ $qs = '';
+ if (!empty($params)) {
+ $qs = '?' . $this->buildQueryString($params);
+ }
+ return $this->httpReq(
+ 'post',
+ $this->_baseUrl . 'posts' . $qs,
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Create a new Post object. Mentions and hashtags will be parsed out of the
+ * post text, as will bare URLs. To create a link in a post without using a
+ * bare URL, include the anchor text in the post's text and include a link
+ * entity in the post creation call.
+ * @param integer $post_id The ID of the post to revise
+ * @param string $text The new text of the post
+ * @param array $data An associative array of optional post data. This
+ * will likely change as the API evolves, as of this writing allowed keys are:
+ * is_nsfw.
+ * @param array $params An associative array of optional data to be included
+ * in the URL (such as 'include_raw')
+ * @return array An associative array representing the post.
+ */
+ public function revisePost(int $post_id, string $text, array $data=[], array $params=[])
+ {
+ $data['text'] = $text;
+ $json = json_encode($data);
+ $qs = '';
+ if (!empty($params)) {
+ $qs = '?' . $this->buildQueryString($params);
+ }
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . $qs,
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Returns a specific Post.
+ * @param integer $post_id The ID of the post to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * @return array An associative array representing the post
+ */
+ public function getPost(int $post_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a list of Posts.
+ * @param array $post_ids The list of post IDs to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * @return array An array of arrays representing the posts
+ */
+ public function getMultiplePosts(array $post_ids, array $params=[])
+ {
+ $params['ids'] = $post_ids;
+
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts?' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Delete a Post. The current user must be the same user who created the Post.
+ * It returns the deleted Post on success.
+ * @param integer $post_id The ID of the post to delete
+ * @param array An associative array representing the post that was deleted
+ */
+ public function deletePost(int $post_id)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl . 'posts/' . urlencode($post_id)
+ );
+ }
+
+ /**
+ * Retrieve the Posts that are 'in reply to' a specific Post.
+ * @param integer $post_id The ID of the post you want to retrieve replies for.
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getPostThread(int $post_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/thread?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Retrieve revisions of a post. Currently only one can be created.
+ * @param integer $post_id The ID of the post you want to retrieve previous revisions of.
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getPostRevisions(int $post_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/revisions?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Get the most recent Posts created by a specific User in reverse
+ * chronological order (most recent first).
+ * @param mixed $user_id Either the ID of the user you wish to retrieve posts by,
+ * or the string "me", which will retrieve posts for the user you're authenticated
+ * as.
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getUserPosts(string|int $user_id='me', array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/posts?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Get the most recent Posts mentioning by a specific User in reverse
+ * chronological order (newest first).
+ * @param mixed $user_id Either the ID of the user who is being mentioned, or
+ * the string "me", which will retrieve posts for the user you're authenticated
+ * as.
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getUserMentions(string|int $user_id='me', array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/mentions?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Get the currently authenticated user's recent messages
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getUserMessages(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/me/messages?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Return the 20 most recent posts from the current User and
+ * the Users they follow.
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getUserStream(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/me?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Retrieve a list of all public Posts on pnut.io, often referred to as the
+ * global stream.
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getPublicPosts(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/global?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Retrieve a list of "explore" streams
+ * @return An array of associative arrays, each representing a single explore stream.
+ */
+ public function getPostExploreStreams()
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/explore'
+ );
+ }
+
+ /**
+ * Retrieve a list of posts from an "explore" stream on pnut.io.
+ * @param string $slug []
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getPostExploreStream(string $slug, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/explore/' . urlencode($slug) . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Bookmark a post
+ * @param integer $post_id The post ID to bookmark
+ */
+ public function bookmarkPost(int $post_id)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/bookmark'
+ );
+ }
+
+ /**
+ * Unbookmark a post
+ * @param integer $post_id The post ID to unbookmark
+ */
+ public function unbookmarkPost(int $post_id)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/bookmark'
+ );
+ }
+
+ /**
+ * List the posts bookmarked by the current user
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: count, before_id, since_id, include_muted, include_deleted,
+ * and include_post_raw.
+ * See https://github.com/phpnut/api-spec/blob/master/resources/posts.md#general-parameters
+ * @return array An array of associative arrays, each representing a single
+ * user who has bookmarked a post
+ */
+ public function getBookmarked(string|int $user_id='me', array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/bookmarks?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * List the interactions with a post (bookmark, repost, reply)
+ * @param integer $post_id the post ID to get interactions from
+ * @param array $params optional parameters like filters or excludes
+ * @return array An array of associative arrays, each representing one post interaction.
+ */
+ public function getPostInteractions(int $post_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/interactions?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * List the bookmarks of a post
+ * @param integer $post_id the post ID to get stars from
+ * @return array An array of associative arrays, each representing one bookmark action.
+ */
+ public function getPostBookmarks(int $post_id)
+ {
+ return $this->getPostInteractions($post_id, ['filters'=>['bookmark']]);
+ }
+
+ /**
+ * Returns an array of User objects of users who reposted the specified post.
+ * @param integer $post_id the post ID to
+ * @return array An array of associative arrays, each representing a single
+ * user who reposted $post_id
+ */
+ public function getPostReposts(int $post_id)
+ {
+ return $this->getPostInteractions($post_id, ['filters'=>['repost']]);
+ }
+
+ /**
+ * Repost an existing Post object.
+ * @param integer $post_id The id of the post
+ * @return the reposted post
+ */
+ public function repost(int $post_id)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/repost'
+ );
+ }
+
+ /**
+ * Delete a post that the user has reposted.
+ * @param integer $post_id The id of the post
+ * @return the un-reposted post
+ */
+ public function deleteRepost(int $post_id)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl . 'posts/' . urlencode($post_id) . '/repost'
+ );
+ }
+
+ /**
+ * Return Posts matching a specific #hashtag.
+ * @param string $hashtag The hashtag you're looking for.
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: count, before_id, since_id, include_muted, include_deleted,
+ * include_directed_posts, and include_raw.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function searchHashtags(string $hashtag, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/tags/' . urlencode($hashtag) . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * List the posts who match a specific search term
+ * @param array $params a list of filter, search query, and general Post parameters
+ * see: https://docs.pnut.io/resources/posts/search
+ * @param string $query The search query. Supports
+ * normal search terms. Searches post text.
+ * @return array An array of associative arrays, each representing one post.
+ * or false on error
+ */
+ public function searchPosts(array $params=[], string $query='', string $order='default')
+ {
+ if (!is_array($params)) {
+ return false;
+ }
+ if (!empty($query)) {
+ $params['q'] = $query;
+ }
+ if ($order === 'default') {
+ if (!empty($query)) {
+ $params['order'] = 'relevance';
+ } else {
+ $params['order'] = 'id';
+ }
+ }
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/search?' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Return the 20 most recent posts for a stream using a valid Token
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: count, before_id, since_id, include_muted, include_deleted,
+ * and include_post_raw.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getUserPersonalStream(array $params=[])
+ {
+ if ($params['access_token']) {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/me?'
+ . $this->buildQueryString($params),
+ $params
+ );
+ } else {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/me?'
+ . $this->buildQueryString($params)
+ );
+ }
+ }
+
+ /**
+ * Return the 20 most recent Posts from the current User's personalized stream
+ * and mentions stream merged into one stream.
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: count, before_id, since_id, include_muted, include_deleted,
+ * include_directed_posts, and include_raw.
+ * @return An array of associative arrays, each representing a single post.
+ */
+ public function getUserUnifiedStream(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'posts/streams/unified?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * List User interactions
+ */
+ public function getMyActions(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/me/interactions?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a specific user object.
+ * @param mixed $user_id The ID of the user you want to retrieve, or the string "@-username", or the string
+ * "me" to retrieve data for the users you're currently authenticated as.
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: include_raw|include_user_raw.
+ * @return array An associative array representing the user data.
+ */
+ public function getUser(string|int $user_id='me', array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns multiple users request by an array of user ids
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: include_raw|include_user_raw.
+ * @return array An associative array representing the users data.
+ */
+ public function getUsers(array $user_arr, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users?ids=' . implode(',', $user_arr)
+ . '&' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Add the specified user ID to the list of users followed.
+ * Returns the User object of the user being followed.
+ * @param integer $user_id The user ID of the user to follow.
+ * @return array An associative array representing the user you just followed.
+ */
+ public function followUser(string|int $user_id)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/follow'
+ );
+ }
+
+ /**
+ * Removes the specified user ID to the list of users followed.
+ * Returns the User object of the user being unfollowed.
+ * @param integer $user_id The user ID of the user to unfollow.
+ * @return array An associative array representing the user you just unfollowed.
+ */
+ public function unfollowUser(string|int $user_id)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/follow'
+ );
+ }
+
+ /**
+ * Returns an array of User objects the specified user is following.
+ * @param mixed $user_id Either the ID of the user being followed, or
+ * the string "me", which will retrieve posts for the user you're authenticated
+ * as.
+ * @return array An array of associative arrays, each representing a single
+ * user following $user_id
+ */
+ public function getFollowing(string|int $user_id='me', array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/following?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns an array of User ids the specified user is following.
+ * @param mixed $user_id Either the ID of the user being followed, or
+ * the string "me", which will retrieve posts for the user you're authenticated
+ * as.
+ * @return array user ids the specified user is following.
+ */
+ public function getFollowingIDs(string|int $user_id='me')
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}users/{$user_id}/following?include_user=0"
+ );
+ }
+
+ /**
+ * Returns an array of User objects for users following the specified user.
+ * @param mixed $user_id Either the ID of the user being followed, or
+ * the string "me", which will retrieve posts for the user you're authenticated
+ * as.
+ * @return array An array of associative arrays, each representing a single
+ * user following $user_id
+ */
+ public function getFollowers(string|int $user_id='me', array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/followers?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns an array of User ids for users following the specified user.
+ * @param mixed $user_id Either the ID of the user being followed, or
+ * the string "me", which will retrieve posts for the user you're authenticated
+ * as.
+ * @return array user ids for users following the specified user
+ */
+ public function getFollowersIDs(string|int $user_id='me')
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}users/{$user_id}/followers?include_user=0"
+ );
+ }
+
+ /**
+ * Retrieve a user's user ID by specifying their username.
+ * @param string $username The username of the user you want the ID of, without
+ * an @ symbol at the beginning.
+ * @return integer The user's user ID
+ */
+ public function getIdByUsername(string $username)
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}users/@{$username}?include_user=0"
+ );
+ }
+
+ /**
+ * Mute a user
+ * @param integer $user_id The user ID to mute
+ */
+ public function muteUser(string|int $user_id)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/mute'
+ );
+ }
+
+ /**
+ * Unmute a user
+ * @param integer $user_id The user ID to unmute
+ */
+ public function unmuteUser(string|int $user_id)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/mute'
+ );
+ }
+
+ /**
+ * List the users muted by the current user
+ * @return array An array of associative arrays, each representing one muted user.
+ */
+ public function getMuted()
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}users/me/muted"
+ );
+ }
+
+ /**
+ * Get a user object by username
+ * @param string $name the @name to get
+ * @return array representing one user
+ */
+ public function getUserByName(string $name)
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}users/@{$name}"
+ );
+ }
+
+ /**
+ * List the users who match a specific search term
+ * @param string $search The search query. Supports @username or #tag searches as
+ * well as normal search terms. Searches username, display name, bio information.
+ * Does not search posts.
+ * @return array An array of associative arrays, each representing one user.
+ */
+ public function searchUsers(array $params=[], string $query='')
+ {
+ if (!is_array($params)) {
+ return false;
+ }
+ if ($query === '') {
+ return false;
+ }
+ $params['q'] = $query;
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/search?q=' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Update Profile Data via JSON
+ * @data array containing user descriptors
+ */
+ public function updateUserData(array $data=[], array $params=[])
+ {
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl . 'users/me?'
+ . $this->buildQueryString($params),
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Update a user image
+ * @image path reference to image
+ * @which avatar|cover
+ */
+ protected function updateUserImage(string $image, string $which='avatar')
+ {
+ $test = @getimagesize($image);
+ if ($test && array_key_exists('mime', $test)) {
+ $mimeType = $test['mime'];
+ }
+ $data = [
+ $which => new CurlFile($image, $mimeType)
+ ];
+ return $this->httpReq(
+ 'post-raw',
+ "{$this->_baseUrl}users/me/{$which}",
+ $data,
+ 'multipart/form-data'
+ );
+ }
+
+ public function updateUserAvatar($avatar)
+ {
+ return $this->updateUserImage('avatar', $avatar);
+ }
+
+ public function updateUserCover($cover)
+ {
+ return $this->updateUserImage('cover', $cover);
+ }
+
+ /**
+ * Returns a Client object
+ * @param string $client_id
+ * @return array An array representing the client
+ */
+ public function getClient(string $client_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'clients/' . urlencode($client_id) . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a list of truncated client details made by a user
+ * @param string $user_id
+ * @return array A list of arrays representing clients
+ */
+ public function getUserClients(string $user_id)
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/' . urlencode($user_id) . '/clients'
+ );
+ }
+
+ /**
+ * update stream marker
+ */
+ public function updateStreamMarker(array $data=[])
+ {
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'post',
+ "{$this->_baseUrl}markers",
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * get a page of current user subscribed channels
+ */
+ public function getMyChannelSubscriptions(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/me/channels/subscribed?' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * get user channels
+ */
+ public function getMyChannels(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/me/channels?' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * create a channel
+ * note: you cannot create a channel with type=io.pnut.core.pm (see createMessage)
+ */
+ public function createChannel(array $data=[])
+ {
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'post',
+ "{$this->_baseUrl}channels",
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * get channelid info
+ */
+ public function getChannel(int $channelid, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels/' . $channelid . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * get an existing private message channel between multiple users
+ * @param mixed $users Can be a comma- or space-separated string, or an array.
+ * Usernames with @-symbol, or user ids.
+ */
+ public function getExistingPM(string|array $users, array $params=[])
+ {
+ if (is_string($users)) {
+ $users = explode(',', str_replace(' ', ',', $users));
+ }
+ foreach($users as $key=>$user) {
+ if (!is_numeric($user) && substr($user, 0, 1) !== '@') {
+ $users[$key] = "@{$user}";
+ }
+ }
+ $params['ids'] = $users;
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'users/me/channels/existing_pm?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * get multiple channels' info by an array of channelids
+ */
+ public function getChannels(array $channels, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels?ids=' . implode(',', $channels) . '&'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * update channelid
+ */
+ public function updateChannel(int $channelid, array $data=[])
+ {
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'put',
+ "{$this->_baseUrl}channels/{$channelid}",
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * subscribe from channelid
+ */
+ public function channelSubscribe(int $channelid)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl.'channels/'.$channelid.'/subscribe'
+ );
+ }
+
+ /**
+ * unsubscribe from channelid
+ */
+ public function channelUnsubscribe(int $channelid)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'channels/'.$channelid.'/subscribe'
+ );
+ }
+
+ /**
+ * mute channelid
+ */
+ public function channelMute(int $channelid)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl.'channels/'.$channelid.'/mute'
+ );
+ }
+
+ /**
+ * unmute channelid
+ */
+ public function channelUnmute(int $channelid)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'channels/'.$channelid.'/mute'
+ );
+ }
+
+ /**
+ * get all user objects subscribed to channelid
+ */
+ public function getChannelSubscriptions(int $channelid, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'channels/'.$channelid.'/subscribers?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * get all user IDs subscribed to channelid
+ */
+ public function getChannelSubscriptionsById(int $channelid)
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}channels/{$channelid}/subscribers?include_user=0"
+ );
+ }
+
+ /**
+ * Retrieve a list of "explore" streams
+ * @return An array of associative arrays, each representing a single explore stream.
+ */
+ public function getChannelExploreStreams()
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels/streams/explore'
+ );
+ }
+
+ /**
+ * Retrieve a list of channels from an "explore" stream on pnut.io.
+ * @param string $slug []
+ * @param array $params An associative array of optional general parameters.
+ * @return An array of associative arrays, each representing a single channel.
+ */
+ public function getChannelExploreStream(string $slug, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels/streams/explore/' . urlencode($slug) . '?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * mark channel inactive
+ */
+ public function deleteChannel(int $channelid)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'channels/'.$channelid
+ );
+ }
+
+ /**
+ * List the channels that match a specific search term
+ * @param array $params a list of filter, search query, and general Channel parameters
+ * see: https://docs.pnut.io/resources/channels/search
+ * @param string $query The search query. Supports
+ * normal search terms. Searches common channel raw.
+ * @return array An array of associative arrays, each representing one channel.
+ * or false on error
+ */
+ public function searchChannels(array $params=[], string $query='', string $order='default')
+ {
+ if (!empty($query)) {
+ $params['q'] = $query;
+ }
+ if ($order === 'default') {
+ if (!empty($query)) {
+ $params['order'] = 'id';
+ } else {
+ $params['order'] = 'activity';
+ }
+ }
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels/search?' . $this->buildQueryString($params)
+ );
+ }
+
+
+ /**
+ * get a page of messages in channelid
+ */
+ public function getMessages(int $channelid, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'channels/'.$channelid.'/messages?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * get a page of messages in channelid in a thread
+ */
+ public function getMessageThread(int $channelid, int $messageid, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'channels/'.$channelid.'/messages/'.$messageid.'/thread?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * get a page of sticky messages in channelid
+ */
+ public function getStickyMessages(int $channelid, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'channels/'.$channelid.'/sticky_messages?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * sticky messsage
+ */
+ public function stickyMessage(int $channelid, int $messageid)
+ {
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl.'channels/'.$channelid.'/messages/'.$messageid.'/sticky'
+ );
+ }
+
+ /**
+ * unsticky messsage
+ */
+ public function unstickyMessage(int $channelid, int $messageid)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'channels/'.$channelid.'/messages/'.$messageid.'/sticky'
+ );
+ }
+
+ /**
+ * create message
+ * @param $channelid numeric or "pm" for auto-channel (type=io.pnut.core.pm)
+ * @param array $data array('text'=>'YOUR_MESSAGE') If a type=io.pnut.core.pm, then "destinations" key can be set to address as an array of people to send this PM too
+ * @param array $params query parameters
+ */
+ public function createMessage(string|int $channelid, array $data, array $params=[])
+ {
+ if (isset($data['destinations'])) {
+ if (is_string($data['destinations'])) {
+ $data['destinations'] = explode(',', str_replace(' ', ',', $data['destinations']));
+ }
+ foreach($data['destinations'] as $key=>$user) {
+ if (!is_numeric($user) && substr($user, 0,1 ) !== '@') {
+ $data['destinations'][$key] = "@{$user}";
+ }
+ }
+ }
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'post',
+ $this->_baseUrl.'channels/'.$channelid.'/messages?'
+ . $this->buildQueryString($params),
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * get message
+ */
+ public function getMessage(int $channelid, int $messageid, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'channels/'.$channelid.'/messages/'.$messageid.'?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a list of Messages.
+ * @param array $message_ids The list of message IDs to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * @return array An array of arrays representing the messages
+ */
+ public function getMultipleMessages(array $message_ids, array $params=[])
+ {
+ $params['ids'] = $message_ids;
+
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels/messages?' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * delete messsage
+ */
+ public function deleteMessage(int $channelid, int $messageid)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'channels/'.$channelid.'/messages/'.$messageid
+ );
+ }
+
+ /**
+ * List the messages that match a specific search term
+ * @param array $params a list of filter, search query, and general Message parameters
+ * see: https://docs.pnut.io/resources/messages/search
+ * @param string $query The search query. Supports
+ * normal search terms. Searches common channel raw.
+ * @return array An array of associative arrays, each representing one channel.
+ * or false on error
+ */
+ public function searchMessages(array $params=[], string $query='', string $order='default')
+ {
+ if (!is_array($params)) {
+ return false;
+ }
+ if (!empty($query)) {
+ $params['q'] = $query;
+ }
+ if ($order === 'default') {
+ if (!empty($query)) {
+ $params['order'] = 'id';
+ } else {
+ $params['order'] = 'relevance';
+ }
+ }
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'channels/messages/search?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Upload a file to a user's file store
+ * @param string $file A string containing the path of the file to upload.
+ * @param array $data Additional data about the file you're uploading. At the
+ * moment accepted keys are: mime-type, kind, type, name, public and raw.
+ * - If you don't specify mime-type, phpnut will attempt to guess the mime type
+ * based on the file, however this isn't always reliable.
+ * - If you don't specify kind phpnut will attempt to determine if the file is
+ * an image or not.
+ * - If you don't specify name, phpnut will use the filename of the first
+ * parameter.
+ * - If you don't specify is_public, your file will be uploaded as a private file.
+ * - Type is REQUIRED.
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: include_raw|include_file_raw.
+ * @return array An associative array representing the file
+ */
+ public function createFile($file, array $data, array $params=[])
+ {
+ if (!$file) {
+ throw new PhpnutException('You must specify a path to a file');
+ }
+ if (!file_exists($file)) {
+ throw new PhpnutException('File path specified does not exist');
+ }
+ if (!is_readable($file)) {
+ throw new PhpnutException('File path specified is not readable');
+ }
+ if (!array_key_exists('type', $data) || !$data['type']) {
+ throw new PhpnutException('Type is required when creating a file');
+ }
+ if (!array_key_exists('name', $data)) {
+ $data['name'] = basename($file);
+ }
+ if (array_key_exists('mime-type', $data)) {
+ $mimeType = $data['mime-type'];
+ unset($data['mime-type']);
+ } else {
+ $mimeType = null;
+ }
+ if (!array_key_exists('kind', $data)) {
+ $test = @getimagesize($path);
+ if ($test && array_key_exists('mime', $test)) {
+ $data['kind'] = 'image';
+ if (!$mimeType) {
+ $mimeType = $test['mime'];
+ }
+ }
+ else {
+ $data['kind'] = 'other';
+ }
+ }
+ if (!$mimeType) {
+ $finfo = finfo_open(FILEINFO_MIME_TYPE);
+ $mimeType = finfo_file($finfo, $file);
+ finfo_close($finfo);
+ }
+ if (!$mimeType) {
+ throw new PhpnutException('Unable to determine mime type of file, try specifying it explicitly');
+ }
+ $data['content'] = new \CurlFile($file, $mimeType);
+ return $this->httpReq(
+ 'post-raw',
+ "{$this->_baseUrl}files",
+ $data,
+ 'multipart/form-data'
+ );
+ }
+
+ public function createFilePlaceholder($file, array $params=[])
+ {
+ $name = basename($file);
+ $data = [
+ 'raw' => $params['raw'],
+ 'kind' => $params['kind'],
+ 'name' => $name,
+ 'type' => $params['metadata']
+ ];
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'post',
+ $this->_baseUrl.'files',
+ $json,
+ 'application/json'
+ );
+ }
+
+ public function updateFileContent(int $fileid, string $file)
+ {
+ $data = file_get_contents($file);
+ $finfo = finfo_open(FILEINFO_MIME_TYPE);
+ $mime = finfo_file($finfo, $file);
+ finfo_close($finfo);
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl.'files/'.$fileid.'/content',
+ $data,
+ $mime
+ );
+ }
+
+ /**
+ * Allows for file rename and annotation changes.
+ * @param integer $file_id The ID of the file to update
+ * @param array $params An associative array of file parameters.
+ * @return array An associative array representing the updated file
+ */
+ public function updateFile(int $file_id, array $params=[])
+ {
+ $data = [
+ 'raw' => $params['raw'],
+ 'name' => $params['name'],
+ ];
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl.'files/'.urlencode($file_id),
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Returns a specific File.
+ * @param integer $file_id The ID of the file to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: include_raw|include_file_raw.
+ * @return array An associative array representing the file
+ */
+ public function getFile(int $file_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'files/'.urlencode($file_id).'?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ public function getFileContent(int $file_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'files/'.urlencode($file_id).'/content?'
+ . $this->buildQueryString($params)
+ );
+ }
+
+ /** $file_key : derived_file_key */
+ public function getDerivedFileContent(int $file_id, string $file_key, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'files/'.urlencode($file_id).'/content/'.urlencode($file_key).'?'.$this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns file objects.
+ * @param array $file_ids The IDs of the files to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: include_raw|include_file_raw.
+ * @return array An associative array representing the file data.
+ */
+ public function getFiles(array $file_ids, array $params=[])
+ {
+ $ids = '';
+ foreach($file_ids as $id) {
+ $ids .= $id . ',';
+ }
+ $params['ids'] = substr($ids, 0, -1);
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'files?'.$this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a user's file objects.
+ * @param array $params An associative array of optional general parameters.
+ * This will likely change as the API evolves, as of this writing allowed keys
+ * are: include_raw|include_file_raw|include_user_raw.
+ * @return array An associative array representing the file data.
+ */
+ public function getUserFiles(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'users/me/files?'.$this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Delete a File. The current user must be the same user who created the File.
+ * It returns the deleted File on success.
+ * @param integer $file_id The ID of the file to delete
+ * @return array An associative array representing the file that was deleted
+ */
+ public function deleteFile(int $file_id)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'files/'.urlencode($file_id)
+ );
+ }
+
+ /**
+ * Create a poll
+ * @param array $data An associative array of the required parameters.
+ * @param array $params An associative array of optional general parameters.
+ * Allowed keys: include_raw,include_poll_raw, ...
+ * @return array An associative array representing the poll
+ */
+ public function createPoll(array $data, array $params=[])
+ {
+ $json = json_encode($data);
+ return $this->httpReq(
+ 'post',
+ $this->_baseUrl.'polls?'.$this->buildQueryString($params),
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Responds to a poll.
+ * @param integer $poll_id The ID of the poll to respond to
+ * @param array list of positions for the poll response
+ * @param array $params An associative array of optional general parameters.
+ */
+ public function respondToPoll(int $poll_id, array $positions, array $params=[])
+ {
+ $json = json_encode(['positions' => $positions]);
+ return $this->httpReq(
+ 'put',
+ $this->_baseUrl.'polls/'.urlencode($poll_id).'/response?'.$this->buildQueryString($params),
+ $json,
+ 'application/json'
+ );
+ }
+
+ /**
+ * Returns a specific Poll.
+ * @param integer $poll_id The ID of the poll to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * @return array An associative array representing the poll
+ */
+ public function getPoll(int $poll_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'polls/'.urlencode($poll_id).'?'.$this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a list of Polls.
+ * @param array $poll_ids The list of poll IDs to retrieve
+ * @param array $params An associative array of optional general parameters.
+ * @return array An array of arrays representing the polls
+ */
+ public function getMultiplePolls(array $poll_ids, array $params=[])
+ {
+ $params['ids'] = $poll_ids;
+
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'polls?' . $this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Returns a user's poll objects.
+ * @param array $params An associative array of optional general parameters.
+ * @return array An associative array representing the poll data.
+ */
+ public function getUserPolls(array $params=[])
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'users/me/polls?'.$this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * Delete a Poll. The current user must be the same user who created the Poll.
+ * @param integer $poll_id The ID of the poll to delete
+ * @param array $params An associative array of optional general parameters.
+ * @return array An associative array representing the poll that was deleted
+ */
+ public function deletePoll(int $poll_id, array $params=[])
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'polls/'.urlencode($poll_id).'?'.$this->buildQueryString($params)
+ );
+ }
+
+ /**
+ * List the polls that match a specific search term
+ * @param array $params a list of filter, search query, and general Poll parameters
+ * see: https://docs.pnut.io/resources/channels/search
+ * @param string $query The search query. Supports
+ * normal search terms.
+ * @return array An array of associative arrays, each representing one poll.
+ * or false on error
+ */
+ public function searchPolls(array $params=[], string $order='id')
+ {
+ $params['order'] = $order;
+
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl . 'polls/search?' . $this->buildQueryString($params)
+ );
+ }
+
+
+ /**
+ * Get Application Information
+ */
+ public function getAppTokenInfo()
+ {
+ // requires appAccessToken
+ if (!$this->_appAccessToken) {
+ $this->getAppAccessToken();
+ }
+ // ensure request is made with our appAccessToken
+ $params['access_token'] = $this->_appAccessToken;
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}token",
+ $params
+ );
+ }
+
+ /**
+ * Get User Information
+ */
+ public function getUserTokenInfo()
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}token"
+ );
+ }
+
+ /**
+ * Get Application Authorized User IDs
+ */
+ public function getAppUserIDs()
+ {
+ // requires appAccessToken
+ if (!$this->_appAccessToken) {
+ $this->getAppAccessToken();
+ }
+ // ensure request is made with our appAccessToken
+ $params['access_token'] = $this->_appAccessToken;
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}apps/me/users/ids",
+ $params
+ );
+ }
+
+ /**
+ * Get Application Authorized User Tokens
+ */
+ public function getAppUserTokens()
+ {
+ // requires appAccessToken
+ if (!$this->_appAccessToken) {
+ $this->getAppAccessToken();
+ }
+ // ensure request is made with our appAccessToken
+ $params['access_token'] = $this->_appAccessToken;
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}apps/me/users/tokens",
+ $params
+ );
+ }
+
+
+
+ /**
+ * Registers your function (or an array of object and method) to be called
+ * whenever an event is received via an open pnut.io stream. Your function
+ * will receive a single parameter, which is the object wrapper containing
+ * the meta and data.
+ * @param mixed A PHP callback (either a string containing the function name,
+ * or an array where the first element is the class/object and the second
+ * is the method).
+ */
+ public function registerStreamFunction($function): void
+ {
+ $this->_streamCallback = $function;
+ }
+
+ /**
+ * Opens a stream that's been created for this user/app and starts sending
+ * events/objects to your defined callback functions. You must define at
+ * least one callback function before opening a stream.
+ * @param mixed $stream Either a stream ID or the endpoint of a stream
+ * you've already created. This stream must exist and must be valid for
+ * your current access token. If you pass a stream ID, the library will
+ * make an API call to get the endpoint.
+ *
+ * This function will return immediately, but your callback functions
+ * will continue to receive events until you call closeStream() or until
+ * pnut.io terminates the stream from their end with an error.
+ *
+ * If you're disconnected due to a network error, the library will
+ * automatically attempt to reconnect you to the same stream, no action
+ * on your part is necessary for this. However if the pnut.io API returns
+ * an error, a reconnection attempt will not be made.
+ *
+ * Note there is no closeStream, because once you open a stream you
+ * can't stop it (unless you exit() or die() or throw an uncaught
+ * exception, or something else that terminates the script).
+ * @return boolean True
+ * @see createStream()
+ */
+ public function openStream($stream): bool
+ {
+ // if there's already a stream running, don't allow another
+ if ($this->_currentStream) {
+ throw new phpnutException('There is already a stream being consumed, only one stream can be consumed per phpnutStream instance');
+ }
+ // must register a callback (or the exercise is pointless)
+ if (!$this->_streamCallback) {
+ throw new phpnutException('You must define your callback function using registerStreamFunction() before calling openStream');
+ }
+ // if the stream is a numeric value, get the stream info from the api
+ if (is_numeric($stream)) {
+ $stream = $this->getStream($stream);
+ $this->_streamUrl = $stream['endpoint'];
+ }
+ else {
+ $this->_streamUrl = $stream;
+ }
+ // continue doing this until we get an error back or something...?
+ $this->httpStream(
+ 'get',
+ $this->_streamUrl
+ );
+ return true;
+ }
+
+ /**
+ * Close the currently open stream.
+ * @return true;
+ */
+ public function closeStream(): void
+ {
+ if (!$this->_lastStreamActivity) {
+ // never opened
+ return;
+ }
+ if (!$this->_multiStream) {
+ throw new phpnutException('You must open a stream before calling closeStream()');
+ }
+ curl_close($this->_currentStream);
+ curl_multi_remove_handle($this->_multiStream, $this->_currentStream);
+ curl_multi_close($this->_multiStream);
+ $this->_currentStream = null;
+ $this->_multiStream = null;
+ }
+
+ /**
+ * Retrieve all streams for the current access token.
+ * @return array An array of stream definitions.
+ */
+ public function getAllStreams()
+ {
+ return $this->httpReq(
+ 'get',
+ "{$this->_baseUrl}streams"
+ );
+ }
+
+ /**
+ * Returns a single stream specified by a stream ID. The stream must have been
+ * created with the current access token.
+ * @return array A stream definition
+ */
+ public function getStream(string $streamId)
+ {
+ return $this->httpReq(
+ 'get',
+ $this->_baseUrl.'streams/'.urlencode($streamId)
+ );
+ }
+
+ /**
+ * Creates a stream for the current app access token.
+ *
+ * @param array $objectTypes The objects you want to retrieve data for from the
+ * stream. At time of writing these can be 'post', 'bookmark', 'user_follow', 'mute', 'block', 'stream_marker', 'message', 'channel', 'channel_subscription', 'token', and/or 'user'.
+ * If you don't specify, a few standard events will be retrieved.
+ */
+ public function createStream(?array $objectTypes=null)
+ {
+ // default object types to everything
+ if (is_null($objectTypes)) {
+ $objectTypes = [
+ 'post',
+ 'bookmark',
+ 'user_follow',
+ ];
+ }
+ $data = [
+ 'object_types'=>$objectTypes,
+ 'type'=>'long_poll',
+ ];
+ $data = json_encode($data);
+ $response = $this->httpReq(
+ 'post',
+ "{$this->_baseUrl}streams",
+ $data,
+ 'application/json'
+ );
+ return $response;
+ }
+
+ /**
+ * Update stream for the current app access token
+ *
+ * @param string $streamId The stream ID to update. This stream must have been
+ * created by the current access token.
+ * @param array $data allows object_types, type, filter_id and key to be updated. filter_id/key can be omitted
+ */
+ public function updateStream(string $streamId, array $data)
+ {
+ // objectTypes is likely required
+ if (is_null($data['object_types'])) {
+ $data['object_types'] = [
+ 'post',
+ 'bookmark',
+ 'user_follow',
+ ];
+ }
+ // type can still only be long_poll
+ if (is_null($data['type'])) {
+ $data['type'] = 'long_poll';
+ }
+ $data = json_encode($data);
+ $response = $this->httpReq(
+ 'put',
+ $this->_baseUrl.'streams/'.urlencode($streamId),
+ $data,
+ 'application/json'
+ );
+ return $response;
+ }
+
+ /**
+ * Deletes a stream if you no longer need it.
+ *
+ * @param string $streamId The stream ID to delete. This stream must have been
+ * created by the current access token.
+ */
+ public function deleteStream(string $streamId)
+ {
+ return $this->httpReq(
+ 'delete',
+ $this->_baseUrl.'streams/'.urlencode($streamId)
+ );
+ }
+
+ /**
+ * Deletes all streams created by the current access token.
+ */
+ public function deleteAllStreams()
+ {
+ return $this->httpReq(
+ 'delete',
+ "{$this->_baseUrl}streams"
+ );
+ }
+
+ /**
+ * Internal function used to process incoming chunks from the stream. This is only
+ * public because it needs to be accessed by CURL. Do not call or use this function
+ * in your own code.
+ * @ignore
+ */
+ public function httpStreamReceive($ch, $data)
+ {
+ $this->_lastStreamActivity = time();
+ $this->_streamBuffer .= $data;
+ if (!$this->_streamHeaders) {
+ $pos = strpos($this->_streamBuffer, "\r\n\r\n");
+ if ($pos !== false) {
+ $this->_streamHeaders = substr($this->_streamBuffer, 0, $pos);
+ $this->_streamBuffer = substr($this->_streamBuffer, $pos+4);
+ }
+ } else {
+ $pos = strpos($this->_streamBuffer, "\r\n");
+ while ($pos !== false) {
+ $command = substr($this->_streamBuffer, 0, $pos);
+ $this->_streamBuffer = substr($this->_streamBuffer, $pos+2);
+ $command = json_decode($command, true);
+ if ($command) {
+ call_user_func($this->_streamCallback, $command);
+ }
+ $pos = strpos($this->_streamBuffer, "\r\n");
+ }
+ }
+ return strlen($data);
+ }
+
+ /**
+ * Opens a long lived HTTP connection to the pnut.io servers, and sends data
+ * received to the httpStreamReceive function. As a general rule you should not
+ * directly call this method, it's used by openStream().
+ */
+ protected function httpStream(string $act, $req, array $params=[], string $contentType='application/x-www-form-urlencoded'): void
+ {
+ if ($this->_currentStream) {
+ throw new phpnutException('There is already an open stream, you must close the existing one before opening a new one');
+ }
+ $headers = [];
+ $this->_streamBuffer = '';
+ if ($this->_accessToken) {
+ $headers[] = "Authorization: Bearer {$this->_accessToken}";
+ }
+ $this->_currentStream = curl_init($req);
+ curl_setopt($this->_currentStream, CURLOPT_HTTPHEADER, $headers);
+ curl_setopt($this->_currentStream, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($this->_currentStream, CURLINFO_HEADER_OUT, true);
+ curl_setopt($this->_currentStream, CURLOPT_HEADER, true);
+ if ($this->_sslCA) {
+ curl_setopt($this->_currentStream, CURLOPT_CAINFO, $this->_sslCA);
+ }
+ // every time we receive a chunk of data, forward it to httpStreamReceive
+ curl_setopt($this->_currentStream, CURLOPT_WRITEFUNCTION, array($this, 'httpStreamReceive'));
+ // curl_exec($ch);
+ // return;
+ $this->_multiStream = curl_multi_init();
+ $this->_lastStreamActivity = time();
+ curl_multi_add_handle($this->_multiStream, $this->_currentStream);
+ }
+
+ public function reconnectStream(): void
+ {
+ $this->closeStream();
+ $this->_connectFailCounter++;
+ // if we've failed a few times, back off
+ if ($this->_connectFailCounter > 1) {
+ $sleepTime = pow(2, $this->_connectFailCounter);
+ // don't sleep more than 60 seconds
+ if ($sleepTime > 60) {
+ $sleepTime = 60;
+ }
+ sleep($sleepTime);
+ }
+ $this->httpStream('get', $this->_streamUrl);
+ }
+
+ /**
+ * Process an open stream for x microseconds, then return. This is useful if you want
+ * to be doing other things while processing the stream. If you just want to
+ * consume the stream without other actions, you can call processForever() instead.
+ * @param float @microseconds The number of microseconds to process for before
+ * returning. There are 1,000,000 microseconds in a second.
+ *
+ * @return void
+ */
+ public function processStream($microseconds=null): void
+ {
+ if (!$this->_multiStream) {
+ throw new phpnutException('You must open a stream before calling processStream()');
+ }
+ $start = microtime(true);
+ $active = null;
+ $inQueue = null;
+ $sleepFor = 0;
+ do {
+ // if we haven't received anything within 5.5 minutes, reconnect
+ // keepalives are sent every 5 minutes (measured on 2013-3-12 by @ryantharp)
+ if (time()-$this->_lastStreamActivity >= 330) {
+ $this->reconnectStream();
+ }
+ curl_multi_exec($this->_multiStream, $active);
+ if (!$active) {
+ $httpCode = curl_getinfo($this->_currentStream, CURLINFO_HTTP_CODE);
+ // don't reconnect on 400 errors
+ if ($httpCode >= 400 && $httpCode <= 499) {
+ throw new phpnutException("Received HTTP error {$httpCode} check your URL and credentials before reconnecting");
+ }
+ $this->reconnectStream();
+ }
+ // sleep for a max of 2/10 of a second
+ $timeSoFar = (microtime(true)-$start)*1000000;
+ $sleepFor = $this->streamingSleepFor;
+ if ($timeSoFar+$sleepFor > $microseconds) {
+ $sleepFor = $microseconds - $timeSoFar;
+ }
+ if ($sleepFor > 0) {
+ usleep($sleepFor);
+ }
+ } while ($timeSoFar+$sleepFor < $microseconds);
+ }
+
+ /**
+ * Process an open stream forever. This function will never return, if you
+ * want to perform other actions while consuming the stream, you should use
+ * processFor() instead.
+ * @return void This function will never return
+ * @see processFor();
+ */
+ public function processStreamForever(): void
+ {
+ while (true) {
+ $this->processStream(600);
+ }
+ }
+}
diff --git a/pnut/lib/phpnutException.php b/pnut/lib/phpnutException.php
new file mode 100644
index 00000000..77e768fe
--- /dev/null
+++ b/pnut/lib/phpnutException.php
@@ -0,0 +1,5 @@
+
+ * Status: In Development
+ */
+
+require_once 'addon/pnut/lib/phpnut.php';
+require_once 'addon/pnut/lib/phpnutException.php';
+
+use Friendica\Content\Text\BBCode;
+use Friendica\Content\Text\Plaintext;
+use Friendica\Core\Config\Util\ConfigFileManager;
+use Friendica\Core\Hook;
+use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\Core\System;
+use Friendica\DI;
+use Friendica\Model\Item;
+use Friendica\Model\Photo;
+use Friendica\Object\Image;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
+use Friendica\Network\HTTPClient\Client\HttpClientOptions;
+use Friendica\Util\DateTimeFormat;
+
+function pnut_install()
+{
+ Hook::register('load_config', __FILE__, 'pnut_load_config');
+ Hook::register('hook_fork', __FILE__, 'pnut_hook_fork');
+ Hook::register('post_local', __FILE__, 'pnut_post_local');
+ Hook::register('notifier_normal', __FILE__, 'pnut_post_hook');
+ Hook::register('jot_networks', __FILE__, 'pnut_jot_nets');
+ Hook::register('connector_settings', __FILE__, 'pnut_settings');
+ Hook::register('connector_settings_post', __FILE__, 'pnut_settings_post');
+}
+
+function pnut_module() {}
+
+function pnut_content()
+{
+ if (!DI::userSession()->getLocalUserId()) {
+ DI::sysmsg()->addNotice(DI::l10n()->t('Permission denied.'));
+ return '';
+ }
+
+ if (isset(DI::args()->getArgv()[1])) {
+ switch (DI::args()->getArgv()[1]) {
+ case 'connect':
+ $o = pnut_connect();
+ break;
+
+ default:
+ $o = print_r(DI::args()->getArgv(), true);
+ break;
+ }
+ } else {
+ $o = pnut_connect();
+ }
+ return $o;
+}
+
+function pnut_connect()
+{
+ $client_id = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'client_id');
+ $client_secret = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'client_secret');
+ $callback_url = DI::baseUrl() . '/pnut/connect';
+
+ $nut = new phpnut\phpnut($client_id, $client_secret);
+
+ try {
+ $token = $nut->getAccessToken($callback_url);
+ Logger::debug('TOKEN', [$token]);
+ $o = DI::l10n()->t('You are now authenticated with pnut.io.');
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'pnut', 'access_token', $token);
+ } catch (phpnutException $e) {
+ $o = DI::l10n()->t('Error fetching token. Please try again.');
+ }
+
+ $o .= ' ' . DI::l10n()->t("return to the connector page").'';
+
+ return $o;
+}
+
+function pnut_load_config(ConfigFileManager $loader)
+{
+ DI::app()->getConfigCache()->load($loader->loadAddonConfig('pnut'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
+}
+
+function pnut_settings(array &$data)
+{
+ if (!DI::userSession()->getLocalUserId()) {
+ return;
+ }
+
+ $redirectUri = DI::baseUrl() . '/pnut/connect';
+ $scope = ['write_post','files'];
+
+ $enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'post') ?? false;
+ $def_enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'post_by_default') ?? false;
+ $client_id = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'client_id');
+ $client_secret = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'client_secret');
+ $token = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'access_token');
+
+ Logger::debug('CLIENT_ID', [$client_id]);
+ Logger::debug('CLIENT_SECRET', [$client_secret]);
+
+ if (!empty($client_id) && !empty($client_secret) && empty($token)) {
+ $nut = new phpnut\phpnut($client_id, $client_secret);
+ $authorize_url = $nut->getAuthUrl($redirectUri, $scope);
+ $authorize_text = DI::l10n()->t('Authenticate with pnut.io');
+ }
+
+ if (!empty($token)) {
+ $disconn_btn = DI::l10n()->t('Disconnect');
+ }
+
+ $t = Renderer::getMarkupTemplate('connector_settings.tpl', 'addon/pnut/');
+ $html = Renderer::replaceMacros($t, [
+ '$enable' => ['pnut', DI::l10n()->t('Enable Pnut Post Addon'), $enabled],
+ '$bydefault' => ['pnut_bydefault', DI::l10n()->t('Post to Pnut by default'), $def_enabled],
+ '$client_id' => ['pnut_client_id', DI::l10n()->t('Client ID'), $client_id],
+ '$client_secret' => ['pnut_client_secret', DI::l10n()->t('Client Secret'), $client_secret],
+ '$access_token' => ['pnut_access_token', DI::l10n()->t('Access Token'), $token, '', '', 'readonly'],
+ '$authorize_url' => $authorize_url ?? '',
+ '$authorize_text' => $authorize_text ?? '',
+ '$disconn_btn' => $disconn_btn ?? '',
+ ]);
+
+ $data = [
+ 'connector' => 'pnut',
+ 'title' => DI::l10n()->t('Pnut Import/Export'),
+ 'image' => 'addon/pnut/pnut.svg',
+ 'enabled' => $enabled,
+ 'html' => $html,
+ ];
+}
+
+function pnut_settings_post(array &$b)
+{
+ if (empty($_POST['pnut-submit']) && empty($_POST['pnut-disconnect'])) {
+ return;
+ }
+
+ if (!empty($_POST['pnut-disconnect'])) {
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'pnut', 'post');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'pnut', 'post_by_default');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'pnut', 'client_id');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'pnut', 'client_secret');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'pnut', 'access_token');
+ } else {
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'pnut', 'post', intval($_POST['pnut']));
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'pnut', 'post_by_default', intval($_POST['pnut_bydefault']));
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'pnut', 'client_id', $_POST['pnut_client_id']);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'pnut', 'client_secret', $_POST['pnut_client_secret']);
+ }
+}
+
+function pnut_jot_nets(array &$jotnets_fields)
+{
+ if (!DI::userSession()->getLocalUserId()) {
+ return;
+ }
+
+ if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'post')) {
+ $jotnets_fields[] = [
+ 'type' => 'checkbox',
+ 'field' => [
+ 'pnut_enable',
+ DI::l10n()->t('Post to Pnut'),
+ DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'post_by_default')
+ ]
+ ];
+ }
+}
+
+function pnut_hook_fork(array &$b)
+{
+ if ($b['name'] != 'notifier_normal') {
+ return;
+ }
+
+ $post = $b['data'];
+
+ if (($post['created'] !== $post['edited']) && !$post['deleted']) {
+ DI::logger()->info('Editing is not supported by the addon');
+ $b['execute'] = false;
+ return;
+ }
+
+ if (!strstr($post['postopts'] ?? '', 'pnut') || ($post['parent'] != $post['id']) || $post['private']) {
+ $b['execute'] = false;
+ return;
+ }
+}
+
+function pnut_post_local(array &$b)
+{
+ if ($b['edit']) {
+ return;
+ }
+
+ if (!DI::userSession()->getLocalUserId() || (DI::userSession()->getLocalUserId() != $b['uid'])) {
+ return;
+ }
+
+ if ($b['private'] || $b['parent']) {
+ return;
+ }
+
+ $pnut_post = intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'post'));
+ $pnut_enable = (($pnut_post && !empty($_REQUEST['pnut_enable'])) ? intval($_REQUEST['pnut_enable']) : 0);
+
+ // if API is used, default to the chosen settings
+ if ($b['api_source'] && intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'pnut', 'post_by_default'))) {
+ $pnut_enable = 1;
+ }
+
+ if (!$pnut_enable) {
+ return;
+ }
+
+ if (strlen($b['postopts'])) {
+ $b['postopts'] .= ',';
+ }
+
+ $b['postopts'] .= 'pnut';
+}
+
+function pnut_post_hook(array &$b)
+{
+ /**
+ * Post to pnut.io
+ */
+ if ($b['deleted'] || $b['private'] || ($b['created'] !== $b['edited'])) {
+ return;
+ }
+
+ Logger::notice('PNUT post invoked', ['id' => $b['id'], 'guid' => $b['guid'], 'plink' => $b['plink']]);
+ Logger::debug('PNUT array', $b);
+
+ $token = DI::pConfig()->get($b['uid'], 'pnut', 'access_token');
+ $nut = new phpnut\phpnut($token);
+
+ $msgarr = Plaintext::getPost($b, 256, true, BBCode::EXTERNAL);
+ $text = $msgarr['text'];
+ $raw = [];
+
+ Logger::debug('PNUT msgarr', $msgarr);
+
+ if (count($msgarr['parts']) > 1) {
+ $tstamp = time();
+ $raw['nl.chimpnut.blog.post'][] = ['body' => $b['body'], 'tstamp' => $tstamp];
+ $text = Plaintext::shorten($text, 252 - strlen($b['plink']), $b['uid']);
+ $text .= "\n" . $b['plink'];
+ }
+
+ if ($msgarr['type'] == 'link') {
+ $text .= "\n[" . $msgarr['title'] . "](" . $msgarr['url'] . ")";
+ }
+
+ if ($msgarr['type'] == 'photo') {
+ $fileraw = ['type' => 'dev.mcmillian.friendica.image', 'kind' => 'image', 'is_public' => true];
+ foreach ($msgarr['images'] as $image) {
+ Logger::debug('PNUT image', $image);
+
+ if (!empty($image['id'])) {
+ $photo = Photo::selectFirst([], ['id' => $image['id']]);
+ Logger::debug('PNUT selectFirst');
+ } else {
+ $photo = Photo::createPhotoForExternalResource($image['url']);
+ Logger::debug('PNUT createPhotoForExternalResource');
+ }
+ $picturedata = Photo::getImageForPhoto($photo);
+
+ Logger::debug('PNUT photo', $photo);
+ $picurefile = System::getTempPath() . DIRECTORY_SEPARATOR . $photo['filename'];
+ file_put_contents($picurefile, $picturedata);
+ Logger::debug('PNUT got file?', ['filename' => $picurefile]);
+ $imagefile = $nut->createFile($picurefile, $fileraw);
+ Logger::debug('PNUT file', ['pnutimagefile' => $imagefile]);
+ unlink($picurefile);
+
+ $raw['io.pnut.core.oembed'][] = ['+io.pnut.core.file' => ['file_id' => $imagefile['id'], 'file_token' => $imagefile['file_token'], 'format' => 'oembed']];
+ }
+ }
+
+ $raw['io.pnut.core.crosspost'][] = ['canonical_url' => $b['plink']];
+ $nut->createPost($text, ['raw' => $raw]);
+
+ Logger::debug('PNUT post complete', ['id' => $b['id'], 'text' => $text, 'raw' => $raw]);
+}
diff --git a/pnut/pnut.svg b/pnut/pnut.svg
new file mode 100644
index 00000000..6cc64b01
--- /dev/null
+++ b/pnut/pnut.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/pnut/templates/connector_settings.tpl b/pnut/templates/connector_settings.tpl
new file mode 100644
index 00000000..7d1ad3f2
--- /dev/null
+++ b/pnut/templates/connector_settings.tpl
@@ -0,0 +1,12 @@
+