├── .styleci.yml
├── composer.json
├── README.md
├── examples
└── publisher_example.php
├── library
└── Publisher.php
└── LICENSE
/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: recommended
2 |
3 | enabled:
4 | - concat_with_spaces
5 | - no_useless_else
6 | - not_operator_with_successor_space
7 |
8 | disabled:
9 | - concat_without_spaces
10 |
11 | finder:
12 | exclude:
13 | - "examples"
14 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "pubsubhubbub/publisher",
3 | "type": "library",
4 | "description": "pubsubhubbub implementation of publisher.",
5 | "keywords": ["pubsubhubbub", "publishers", "data", "feeds", "websub"],
6 | "homepage": "https://github.com/pubsubhubbub/php-publisher",
7 | "license": "Apache-2.0",
8 | "authors": [
9 | {
10 | "name": "pubsubhubbub publisher Contributors",
11 | "homepage": "https://github.com/pubsubhubbub/php-publisher/contributors"
12 | }
13 | ],
14 | "require": {
15 | "php": "~5.4 || ~7.0 || ~8.0",
16 | "ext-curl": "*"
17 | },
18 | "autoload": {
19 | "psr-4": { "pubsubhubbub\\publisher\\": "library/" }
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | This PHP library for PubSubHubbub was written by [Josh Fraser](http://joshfraser.com) and is released under the Apache 2.0 License
2 |
3 | # Install
4 | Update your `composer` require block:
5 | ```json
6 | "require": { "pubsubhubbub/publisher": "*" }
7 | ```
8 |
9 | # Usage
10 | ```php
11 | use pubsubhubbub\publisher\Publisher;
12 |
13 | // specify which hub you want to use. In this case we'll use the demo hub on app engine.
14 | $hub_url = "http://pubsubhubbub.appspot.com/";
15 |
16 | // create a new pubsubhubbub publisher
17 | $p = new Publisher($hub_url);
18 |
19 | // specify the feed that has been updated
20 | $topic_url = "http://www.onlineaspect.com";
21 |
22 | // notify the hub that the specified topic_url (ATOM feed) has been updated
23 | // alternatively, publish_update() also accepts an array of topic urls
24 | if ($p->publish_update($topic_url)) {
25 | echo "$topic_url was successfully published to $hub_url";
26 | } else {
27 | echo "Ooops...";
28 | print_r($p->last_response());
29 | }
30 | ```
31 |
--------------------------------------------------------------------------------
/examples/publisher_example.php:
--------------------------------------------------------------------------------
1 | ";
13 |
14 | // process form
15 | if ($_POST['sub']) {
16 |
17 | $hub_url = $_POST['hub_url'];
18 | $topic_url = $_POST['topic_url'];
19 |
20 | // check that a hub url is specified
21 | if (!$hub_url) {
22 | echo "Please specify a hub url.
back";
23 | exit();
24 | }
25 | // check that a topic url is specified
26 | if (!$topic_url) {
27 | echo "Please specify a topic url to publish.
back";
28 | exit();
29 | }
30 |
31 | // $hub_url = "http://pubsubhubbub.appspot.com/publish";
32 | $p = new Publisher($hub_url);
33 | if ($p->publish_update($topic_url)) {
34 | echo "$topic_url was successfully published to $hub_url
back";
35 | } else {
36 | echo "ooops...";
37 | print_r($p->last_response());
38 | }
39 |
40 | } else {
41 |
42 | // display a primitive form for testing
43 | echo "
";
48 |
49 | }
50 |
51 | echo "";
52 |
--------------------------------------------------------------------------------
/library/Publisher.php:
--------------------------------------------------------------------------------
1 | hub_url = $hub_url;
42 | }
43 |
44 | /**
45 | * Accepts either a single url or an array of urls.
46 | *
47 | * @param string|array $topic_urls
48 | * @param callable $http_function
49 | *
50 | * @return mixed
51 | */
52 | public function publish_update($topic_urls, $http_function = false)
53 | {
54 | if (! isset($topic_urls)) {
55 | throw new InvalidArgumentException('Please specify a topic url');
56 | }
57 |
58 | // check that we're working with an array
59 | if (! is_array($topic_urls)) {
60 | $topic_urls = [$topic_urls];
61 | }
62 |
63 | // set the mode to publish
64 | $post_string = 'hub.mode=publish';
65 | // loop through each topic url
66 | foreach ($topic_urls as $topic_url) {
67 |
68 | // lightweight check that we're actually working w/ a valid url
69 | if (! preg_match('|^https?://|i', $topic_url)) {
70 | throw new InvalidArgumentException('The specified topic url does not appear to be valid: ' . $topic_url);
71 | }
72 |
73 | // append the topic url parameters
74 | $post_string .= '&hub.url=' . urlencode($topic_url);
75 | }
76 |
77 | // make the http post request and return true/false
78 | // easy to over-write to use your own http function
79 | if ($http_function) {
80 | return $http_function($this->hub_url, $post_string);
81 | }
82 |
83 | return $this->http_post($this->hub_url, $post_string);
84 | }
85 |
86 | /**
87 | * Returns any error message from the latest request.
88 | *
89 | * @return string
90 | */
91 | public function last_response()
92 | {
93 | return $this->last_response;
94 | }
95 |
96 | /**
97 | * Default http function that uses curl to post to the hub endpoint.
98 | *
99 | * @param string $url
100 | * @param string $post_string
101 | *
102 | * @return bool
103 | */
104 | private function http_post($url, $post_string)
105 | {
106 | // add any additional curl options here
107 | $options = [
108 | CURLOPT_URL => $url,
109 | CURLOPT_POST => true,
110 | CURLOPT_POSTFIELDS => $post_string,
111 | CURLOPT_USERAGENT => 'PubSubHubbub-Publisher-PHP/1.0',
112 | ];
113 |
114 | $ch = curl_init();
115 | curl_setopt_array($ch, $options);
116 |
117 | $response = curl_exec($ch);
118 | $this->last_response = $response;
119 | $info = curl_getinfo($ch);
120 |
121 | curl_close($ch);
122 |
123 | return $info['http_code'] == 204;
124 | }
125 | }
126 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------