├── .gitignore
├── LICENSE
├── README.md
├── class
├── class-wpfbbk-messaging.php
└── class-wpfbbk-plugin.php
├── readme.txt
├── templates
└── admin_page.php
└── wpfbbotkit.php
/.gitignore:
--------------------------------------------------------------------------------
1 | *.log
2 | wp-config.php
3 | wp-content/advanced-cache.php
4 | wp-content/backup-db/
5 | wp-content/backups/
6 | wp-content/blogs.dir/
7 | wp-content/cache/
8 | wp-content/upgrade/
9 | wp-content/uploads/
10 | wp-content/wp-cache-config.php
11 | wp-content/plugins/hello.php
12 |
13 | /.htaccess
14 | /license.txt
15 | /readme.html
16 | /sitemap.xml
17 | /sitemap.xml.gz
18 |
19 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # WPFBBotKit
2 |
3 | WPFBBotKit provides an easy way for developers to start creating bots with the Facebook Messenger Platform.
4 | WPFBBotKit is not a bot itself, but allows you to easily verify and receive webhook requests from the Messenger
5 | Platform and send responses from your bot via a simplified API.
6 |
7 | ## Getting Started
8 |
9 | 1. Download or clone this repo and install via the WordPress plugin installer.
10 | 2. Access WPFBBotKit Settings via the "WPFBBotKit" menu option under "Settings" in the wp-admin.
11 | 3. Follow the Messenger Platform [setup guide](https://developers.facebook.com/docs/messenger-platform/guides/setup)
12 | to set up your bot using the Webhook URL and Verification String from the WPFBBotKit Settings page.
13 |
14 | ## Usage
15 |
16 | Receive messages via the `wpfbbk_message_received` hook which will provide an instance of [`WPFBBK_Messaging`](class/class-wpfbbk-messaging.php) as its only argument.
17 |
18 | ```php
19 | add_action( 'wpfbbk_message_received', function( $M ) {
20 | # bot code here
21 | }, 10, 1 );
22 | ```
23 |
24 | When a message has been received, you'll have access to the message's text and/or postback content as well as a few helper functions to help you respond to the message and find out information about the sender.
25 |
26 | ```php
27 | add_action( 'wpfbbk_message_received', function( $M ) {
28 |
29 | // Retrieve user's info from Facebook API
30 | $info = $M->get_user_info();
31 |
32 | // set fallback since user info is not guaranteed
33 | $name = $info->first_name ? $info->first_name : 'Human';
34 |
35 | if ( ! $M->postback ){
36 |
37 | // if no postback is set, respond to text message
38 | if ( 'hello' === $M->text || 'hi' === $M->text ) {
39 | $M->reply_with_text( "Hi $name!", true );
40 | $M->reply_with_image_url( 'https://media.giphy.com/media/13TXV4kfn7r2iA/giphy.gif' );
41 | } else {
42 |
43 | // reply_with_buttons is one of a few reply helpers provided by `WPFBBK_Messaging`
44 | $M->reply_with_buttons(
45 | "Sorry, $name. I don't understand what you said. Do you want me to send you a gif?",
46 | array(
47 | array(
48 | 'type' => 'postback',
49 | 'title' => '👍 Sure.',
50 | 'payload' => 'REPLY_WITH_GIF',
51 | ),
52 | array(
53 | 'type' => 'postback',
54 | 'title' => '👎 No, go away.',
55 | 'payload' => 'NO_REPLY',
56 | ),
57 | )
58 | );
59 | }
60 | } else {
61 |
62 | // postback has been received
63 | if( 'REPLY_WITH_GIF' === $M->postback ) {
64 | $M->reply_with_image_url( 'https://media.giphy.com/media/13TXV4kfn7r2iA/giphy.gif' );
65 | }
66 | }
67 | }, 10, 1 );
68 | ```
69 |
70 | Additionally, a `wpfbbk_request_received` action is fired whenever the webhook url is hit and provides an instance
71 | of the [WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/) object for the request.
72 |
73 | ```php
74 | // debug requests sent to webhook
75 | add_action( 'wpfbbk_request_received', function( $req ) {
76 | error_log( print_r( $req->get_raw_data(), 1 ) );
77 | }, 10, 1 );
78 | ```
79 |
80 | Finally, a `wpfbbk_before_send_request` filter is applied before sending any request via `WPFBBK::api_send()` which
81 | provides an opportunity to bypass the built-in sending functionality and offload sending API requests to a queue.
82 | Documentation for this hook can be found inline in `WPFBBK::api_send()`.
83 |
84 | ```php
85 | // send requests to queue instead of using WPFBBK::api_send()
86 | apply_filters( 'wpfbbk_before_send_request', function( $request_handled, $method, $url, $data ) {
87 | if ( ! $request_handled ) {
88 | $request_handled = SomeOtherClass::queueRequest( $method, $url, $data );
89 | }
90 | return $request_handled;
91 | }, 10, 4 );
92 | ```
93 |
94 | ## Requirements
95 |
96 | Requires WordPress 4.7 or better since WPFBBotKit utilizes the WordPress Rest API.
97 |
98 | ## License
99 |
100 | This project is licensed under the GPL V2 License - see the [LICENSE](LICENSE) file for details
101 |
102 | ## Credits
103 |
104 | WPFBBotKit was created by [Jeff Gould](https://twitter.com/jrgould/) from [Delicious Brains](https://deliciousbrains.com)
105 |
--------------------------------------------------------------------------------
/class/class-wpfbbk-messaging.php:
--------------------------------------------------------------------------------
1 | plugin = $plugin;
21 | $this->page_access_token = $plugin->get_page_access_token();
22 | $this->entry = $entry;
23 |
24 | if ( isset( $entry['sender'] ) ) {
25 | $this->sender = $entry['sender'];
26 | }
27 | if ( isset( $entry['message'] ) ) {
28 | $this->message = $entry['message'];
29 | if ( isset( $entry['message']['text'] ) ) {
30 | $this->text = $entry['message']['text'];
31 | }
32 | if ( isset( $entry['message']['quick_reply'] ) ) {
33 | $this->postback = $entry['message']['quick_reply']['payload'];
34 | $this->payload_type = 'quick_reply';
35 | }
36 | }
37 |
38 | if ( isset( $entry['postback'] ) ) {
39 | $this->postback = $entry['postback']['payload'];
40 | $this->payload_type = 'postback';
41 | }
42 |
43 | $this->messages_api = $this->fb_api_base . '/me/messages?access_token=' . urlencode( $this->page_access_token );
44 | $this->user_api = $this->fb_api_base . '/' . $this->sender['id'] . '?access_token=' . urlencode( $this->page_access_token );
45 | }
46 |
47 | /**
48 | * Make protected properties gettable so they're read-only
49 | *
50 | * @param $name
51 | *
52 | * @return mixed
53 | * @throws Exception
54 | */
55 | function __get( $name ) {
56 | if ( property_exists( $this, $name ) ) {
57 | return $this->{$name};
58 | }
59 |
60 | throw new Exception( "Can not get property: {$name}", 1 );
61 | }
62 |
63 | /**
64 | * Attempts to send a 200 response to the requester before continuing execution to
65 | * ensure that Facebook doesn't retry the webhook while we're processing. It is
66 | *
67 | * TODO: Appears not to work with WordPress, but this would be really nice to have
68 | */
69 | protected function send_200_continue() {
70 | ob_start();
71 | echo '0';
72 | http_response_code( 200 );
73 | header( 'Content-Encoding: none' );
74 | header( 'Connection: close' );
75 | header( 'Content-Length: ' . ob_get_length() );
76 | ob_end_flush();
77 | flush();
78 | session_write_close();
79 | }
80 |
81 | /**
82 | * Send data to the specified API URL and handle the response
83 | *
84 | * @param string $method POST or GET
85 | * @param string $url
86 | * @param null $data
87 | *
88 | * @return mixed|WP_Error
89 | */
90 | function api_send( $method, $url, $data = null ) {
91 | if ( ! in_array( strtolower( $method ), array( 'get', 'post' ) ) ) {
92 | return new WP_Error( 'wpfbbk_type_error', '$method must be one of \'get\', \'post\'' );
93 | }
94 |
95 | /**
96 | * Opportunity to hijack API Requests.
97 | *
98 | * Ideal for sending requests via a queue rather than blocking execution by sending immediately.
99 | *
100 | * @param bool $request_handled Return `true` to skip sending immediately via Requests API
101 | * @param string $method Request method (get or post)
102 | * @param string $url Request URL
103 | * @param array $data Request data
104 | *
105 | */
106 | $request_handled = apply_filters( 'wpfbbk_before_send_request', false, $method, $url, $data );
107 | if ( false !== $request_handled ) {
108 | error_log( print_r( [ $request_handled ], 1 ) );
109 |
110 | return $request_handled;
111 | }
112 |
113 | $req = Requests::{$method}( $url, array(), $data );
114 | $this->last_request = $req;
115 |
116 | $decoded_body = json_decode( $req->body );
117 | $response_body = $decoded_body ? $decoded_body : $req->body;
118 |
119 | if ( $req->success ) {
120 | return $response_body;
121 | } else {
122 | return new WP_Error( 'wpfbbk_fb_api_error', $response_body );
123 | }
124 | }
125 |
126 | /**
127 | * Send reply to current sender via Messages API.
128 | *
129 | * @param array $message formatted message to send to current sender
130 | * @param bool $set_typing_on Should 'typing_on' action be sent after message to indicate further messages will be sent
131 | *
132 | * @return mixed|WP_Error
133 | */
134 | function reply( $message, $set_typing_on = false ) {
135 | $return = $this->api_send( 'post', $this->messages_api, array( 'message' => $message,' recipient' => $this->sender ) );
136 |
137 | if ( $set_typing_on && true === $return ) {
138 | $this->set_typing_on();
139 | }
140 |
141 | return $return;
142 | }
143 |
144 | /**
145 | * Sends the 'typing_on' action to the current sender to show that bot is working/typing.
146 | * Typically indicates that more messages will be sent.
147 | *
148 | * @return mixed|WP_Error
149 | */
150 | function set_typing_on() {
151 | return $this->reply( array(
152 | 'sender_action' => 'typing_on',
153 | ), false );
154 | }
155 |
156 | /**
157 | * Sends a plain text reply to current sender.
158 | *
159 | * @param string $text message to send
160 | * @param bool $set_typing_on Should 'typing_on' action be sent after message to indicate further messages will be sent
161 | *
162 | * @return mixed|WP_Error
163 | */
164 | function reply_with_text( $text, $set_typing_on = false ) {
165 | return $this->reply( array( 'text' => $text ), $set_typing_on );
166 | }
167 |
168 | /**
169 | * Sends an image to current sender. Image url must be HTTPS with valid cert.
170 | * Todo: add is_reusable param and handle attachment_id response
171 | *
172 | * @param string $url Valid HTTPS url of image (or,
173 | * @param bool $set_typing_on Should 'typing_on' action be sent after message to indicate further messages will be sent
174 | *
175 | * @return mixed|WP_Error
176 | */
177 | function reply_with_image_url( $url, $set_typing_on = false ) {
178 | return $this->reply( array(
179 | 'attachment' => array(
180 | 'type' => 'image',
181 | 'payload' => array( 'url' => $url ),
182 | ),
183 | ), $set_typing_on );
184 | }
185 |
186 | /**
187 | * Sends a button or multiple buttons along with text message to current sender
188 | *
189 | * @param string $text Text message that will preceed buttons
190 | * @param array $buttons Array of buttons as defined at
191 | * https://developers.facebook.com/docs/messenger-platform/send-api-reference/buttons
192 | * @param bool $set_typing_on Should 'typing_on' action be sent after message to indicate further messages will
193 | * be sent
194 | *
195 | * @return mixed|WP_Error
196 | */
197 | function reply_with_buttons( $text = '', $buttons, $set_typing_on = false ) {
198 | return $this->reply( array(
199 | 'attachment' => array(
200 | 'type' => 'template',
201 | 'payload' => array(
202 | 'template_type' => 'button',
203 | 'buttons' => $buttons,
204 | 'text' => $text,
205 | ),
206 | ),
207 | ), $set_typing_on );
208 | }
209 |
210 | /**
211 | * Sends a "generic template" to current sender. Specifically a version of the generic template with a clickable
212 | * image that leads to aa url An array of buttons can also be sent with additional links or postback actions
213 | *
214 | * @param string $title Title of card that will be overlaid on top of image in large text
215 | * @param string $subtitle Subtitle, will be smaller text just below title
216 | * @param string $image Image url or reusable attachment_id of image for card
217 | * @param string $url Web url for card link
218 | * @param null $buttons Array of buttons as defined at
219 | * https://developers.facebook.com/docs/messenger-platform/send-api-reference/buttons
220 | * @param bool $set_typing_on Should 'typing_on' action be sent after message to indicate further messages will
221 | * be sent
222 | *
223 | * @return mixed|WP_Error
224 | */
225 | function reply_with_generic_template_link( $title, $subtitle, $image, $url, $buttons = null, $set_typing_on = false ) {
226 | $reply = array(
227 | 'attachment' => array(
228 | 'type' => 'template',
229 | 'payload' => array(
230 | 'template_type' => 'generic',
231 | 'elements' => array(
232 | array(
233 | 'title' => $title,
234 | 'subtitle' => $subtitle,
235 | 'image_url' => $image,
236 | 'default_action' => array(
237 | 'type' => 'web_url',
238 | 'url' => $url,
239 | ),
240 | 'buttons' => $buttons,
241 | ),
242 | ),
243 | ),
244 | ),
245 | );
246 |
247 | return $this->reply( $reply, $set_typing_on );
248 | }
249 |
250 | /**
251 | * Sends a request to the Facebook User API to request more information about current sender.
252 | * Fields are not guaranteed to be populated, so it is recommended to check that values
253 | * are set and provide fallback text when utilizing user info in messages.
254 | *
255 | * @param string $fields
256 | *
257 | * @return stdClass|WP_Error
258 | */
259 | function get_user_info( $fields = 'all' ) {
260 | if ( 'all' === $fields ) {
261 | $fields = 'first_name,last_name,profile_pic,locale,timezone,gender';
262 | }
263 |
264 | return $this->api_send( 'get', $this->user_api . '&fields=' . urlencode( $fields ) );
265 | }
266 |
267 |
268 | }
269 |
--------------------------------------------------------------------------------
/class/class-wpfbbk-plugin.php:
--------------------------------------------------------------------------------
1 | register_hooks();
11 | }
12 |
13 | /**
14 | * Make protected properties gettable so they're read-only.
15 | *
16 | * @param $name
17 | *
18 | * @return mixed
19 | * @throws Exception
20 | */
21 | function __get( $name ) {
22 | if ( property_exists( $this, $name ) ) {
23 | return $this->{$name};
24 | }
25 |
26 | throw new Exception( "Can not get property: {$name}", 1 );
27 | }
28 |
29 | /**
30 | * Register any hooks that we need for plugin operation.
31 | */
32 | function register_hooks() {
33 | add_action( 'admin_menu', array( $this, 'admin_menu' ) );
34 | add_action( 'rest_api_init', array( $this, 'rest_api_init' ), 10 );
35 | add_action( 'admin_init', array( $this, 'save_page_access_token' ) );
36 | }
37 |
38 | /**
39 | * Adds the "WPFBBotKit" admin menuu.
40 | */
41 | function admin_menu() {
42 | add_options_page(
43 | 'WPFBBotKit',
44 | 'WPFBBotKit',
45 | 'manage_options',
46 | 'wpfbbotkit',
47 | array( $this, 'admin_page' )
48 | );
49 | }
50 |
51 | /**
52 | * The WPFBBotKit Settings Page
53 | */
54 | function admin_page() {
55 | require dirname( __FILE__ ) . '/../templates/admin_page.php';
56 | }
57 |
58 | /**
59 | * Handles form submission on the settings page.
60 | */
61 | function save_page_access_token() {
62 | if ( isset( $_POST['wpfbbk_access_token'] ) && check_admin_referer( 'wpfbbk_save_page_access_token' ) ) {
63 | $this->set_page_access_token( $_POST['wpfbbk_access_token'] );
64 | }
65 | }
66 |
67 | /**
68 | * Retrieve and cache the page access token string from options table
69 | * or use cached value if its set.
70 | * @return string|false
71 | */
72 | function get_page_access_token() {
73 | if ( ! $this->access_token ) {
74 | $this->access_token = get_site_option( 'wpfbbk_page_access_token' );
75 | }
76 |
77 | return $this->access_token;
78 | }
79 |
80 | /**
81 | * Set or Update the page access token option and cached value.
82 | *
83 | * @param $token the new access token string
84 | *
85 | * @return boolean
86 | */
87 | function set_page_access_token( $token ) {
88 | $this->access_token = $token;
89 |
90 | return update_site_option( 'wpfbbk_page_access_token', trim( $token ) );
91 | }
92 |
93 | /**
94 | * Retrieves verification string transient or generates verification string and stores
95 | * it as a transient and then returns it.
96 | * @return string
97 | */
98 | function get_verification_string() {
99 | $transient_name = 'wpfbbk_verification_string';
100 | if ( ! $verification_string = get_site_transient( $transient_name ) ) {
101 | $verification_string = md5( $this->string_ns . time() );
102 | set_site_transient( $transient_name, $verification_string );
103 | }
104 |
105 | return $verification_string;
106 | }
107 |
108 | /**
109 | * Set up our webhook endpoint
110 | */
111 | function rest_api_init() {
112 | $webhook_url = $this->get_webhook_url( true );
113 | register_rest_route( $webhook_url['namespace'], $webhook_url['endpoint'], array(
114 | 'methods' => 'GET,POST',
115 | 'callback' => array( $this, 'receive_api_request' ),
116 | ) );
117 | }
118 |
119 | /**
120 | * Retrieve the url for the webhook endpoint
121 | *
122 | * @param bool $parts If true, method will return an associative array of the url parts.
123 | *
124 | * @return array|string
125 | */
126 | function get_webhook_url( $parts = false ) {
127 | $base_url = network_site_url( null, 'https' );
128 | $namespace = apply_filters( 'wpfbbk_api_namespace', trim( $this->string_ns, '_' ) );
129 | $endpoint = apply_filters( 'wpfbbk_api_endpoint', 'webhook' );
130 | $rest_prefix = rest_get_url_prefix();
131 |
132 | $url_parts = compact( 'base_url', 'rest_prefix', 'namespace', 'endpoint' );
133 |
134 | if ( $parts ) {
135 | return $url_parts;
136 | }
137 |
138 | return implode( '/', $url_parts );
139 | }
140 |
141 | /**
142 | * Handles requests to our webhook endpoint
143 | *
144 | * @param WP_REST_Response $req
145 | *
146 | * @return WP_REST_Response
147 | */
148 | function receive_api_request( $req ) {
149 | do_action( 'wpfbbk_request_received', $req );
150 |
151 | $method = $req->get_method();
152 |
153 | if ( 'GET' === $method && isset( $req['hub_mode'] ) && 'subscribe' == $req['hub_mode'] ) {
154 | $this->verify_webhook_subscription( $req );
155 | }
156 |
157 | if ( 'POST' === $method && isset( $req['object'] ) && 'page' === $req['object'] && isset( $req['entry'] ) ) {
158 | require_once dirname( __FILE__ ) . '/class-wpfbbk-messaging.php';
159 |
160 | $entries = $req['entry'];
161 | if ( ! is_array( $entries ) ) {
162 | $entries = array( $entries );
163 | }
164 |
165 | foreach ( $entries as $entry ) {
166 | if ( ! isset( $entry['messaging'] ) ) {
167 | continue;
168 | }
169 | if ( ! is_array( $entry['messaging'] ) ) {
170 | $entry['messaging'] = array( $entry['messaging'] );
171 | }
172 | foreach ( $entry['messaging'] as $message ) {
173 | do_action( 'wpfbbk_message_received', new WPFBBotKit_Messaging( $message, $this ) );
174 | }
175 | }
176 | }
177 |
178 | return new WP_REST_Response( 0, 200 );
179 | }
180 |
181 | /**
182 | * Handles webhook subscription verification for your facebook App
183 | * @param WP_REST_Request $req
184 | */
185 | function verify_webhook_subscription( $req ) {
186 | if ( $this->get_verification_string() === $req['hub_verify_token'] ) {
187 | http_response_code( 200 );
188 | update_site_option( 'wpfbbk_verified', true );
189 | exit( $req['hub_challenge'] );
190 | } else {
191 | error_log( 'Recieved invalid webhook validation request. Expected: "' . $this->get_verification_string . '" Received: "' . $req['hub_verify_token'] . '"' );
192 | http_response_code( 403 );
193 | exit( 0 );
194 | }
195 | }
196 |
197 | }
198 |
--------------------------------------------------------------------------------
/readme.txt:
--------------------------------------------------------------------------------
1 | === WPFBBotKit ===
2 | Contributors: jrgould, deliciousbrains
3 | Tags: messenger, facebook, bot, developer
4 | Requires at least: 4.7
5 | Tested up to: 4.8
6 | Stable tag: 0.1.0
7 | License: GPLv2
8 |
9 | WPFBBotKit provides an easy way for developers to start creating bots with the Facebook Messenger Platform.
10 |
11 | == Description ==
12 |
13 | WPFBBotKit provides an easy way for developers to start creating bots with the [Facebook Messenger Platform].
14 | WPFBBotKit is not a bot itself, but allows you to easily verify and receive webhook requests from the Messenger
15 | Platform and send responses from your bot via a simplified API.
16 |
17 | == Installation ==
18 |
19 | 1. Install WPFBBotKit using WordPress' built-in installer
20 | 2. Access WPFBBotKit Settings via the "WPFBBotKit" menu option under "Settings" in the wp-admin.
21 | 3. Follow the Messenger Platform [setup guide](https://developers.facebook.com/docs/messenger-platform/guides/setup)
22 | to set up your bot using the Webhook URL and Verification String from the WPFBBotKit Settings page.
23 | 4. Receive and respond to messages using the `wpfbbk_message_received` action.
24 |
25 | == Frequently Asked Questions ==
26 |
27 | == Screenshots ==
28 |
29 | 1. WPFBBotKit Settings screen
30 |
31 | == Changelog ==
32 |
33 | == Upgrade Notice ==
34 |
--------------------------------------------------------------------------------
/templates/admin_page.php:
--------------------------------------------------------------------------------
1 |
8 |
9 |