summaryrefslogtreecommitdiff
path: root/lib/pubsubhubbub/Subscriber.php
blob: 5b980a111f4f861b25b06d6ad7770e171765cb36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?php
/**
 * A PHP client library for pubsubhubbub.
 *
 * @link    http://code.google.com/p/pubsubhubbub/
 *
 * @author  Josh Fraser | joshfraser.com | [email protected]
 * @license Apache License 2.0
 */
namespace Pubsubhubbub\Subscriber;

use InvalidArgumentException;

class Subscriber
{
    /**
     * Put your google key here.
     * Required if you want to use the google feed API to lookup RSS feeds.
     *
     * @var string
     */
    protected $google_key = '';

    /**
     * @var string
     */
    protected $hub_url;

    /**
     * @var string
     */
    protected $callback_url;

    /**
     * @var string
     */
    protected $credentials;

    /**
     * @var string accepted values are "async" and "sync"
     */
    protected $verify = 'async';

    /**
     * @var string
     */
    protected $verify_token;

    /**
     * @var string
     */
    protected $lease_seconds;

    /**
     * Create a new Subscriber (credentials added for SuperFeedr support).
     *
     * @param string $hub_url
     * @param string $callback_url
     * @param string $credentials
     */
    public function __construct($hub_url, $callback_url, $credentials = false)
    {
        if (! isset($hub_url)) {
            throw new InvalidArgumentException('Please specify a hub url');
        }

        if (! preg_match('|^https?://|i', $hub_url)) {
            throw new InvalidArgumentException('The specified hub url does not appear to be valid: ' . $hub_url);
        }

        if (! isset($callback_url)) {
            throw new InvalidArgumentException('Please specify a callback');
        }

        $this->hub_url = $hub_url;
        $this->callback_url = $callback_url;
        $this->credentials = $credentials;
    }

    /**
     * $use_regexp lets you choose whether to use google AJAX feed api (faster, but cached) or a regexp to read from site.
     *
     * @param string   $url
     * @param callable $http_function
     *
     * @return string
     */
    public function find_feed($url, $http_function = false)
    {
        // using google feed API
        $url = "http://ajax.googleapis.com/ajax/services/feed/lookup?key={$this->google_key}&v=1.0&q=" . urlencode($url);
        // fetch the content
        if ($http_function) {
            $response = $http_function($url);
        } else {
            $response = $this->http($url);
        }

        $result = json_decode($response, true);
        $rss_url = $result['responseData']['url'];

        return $rss_url;
    }

    /**
     * Subscribe to a topic.
     *
     * @param string   $topic_url
     * @param callable $http_function
     *
     * @return mixed
     */
    public function subscribe($topic_url, $http_function = false)
    {
        return $this->change_subscription('subscribe', $topic_url, $http_function);
    }

    /**
     * Unsubscribe from a topic.
     *
     * @param string   $topic_url
     * @param callable $http_function
     *
     * @return mixed
     */
    public function unsubscribe($topic_url, $http_function = false)
    {
        return $this->change_subscription('unsubscribe', $topic_url, $http_function);
    }

    /**
     * Helper function since sub/unsub are handled the same way.
     *
     * @param string   $mode
     * @param string   $topic_url
     * @param callable $http_function
     *
     * @return mixed
     */
    private function change_subscription($mode, $topic_url, $http_function = false)
    {
        if (! isset($topic_url)) {
            throw new InvalidArgumentException('Please specify a topic url');
        }

        // lightweight check that we're actually working w/ a valid url
        if (! preg_match('|^https?://|i', $topic_url)) {
            throw new InvalidArgumentException('The specified topic url does not appear to be valid: ' . $topic_url);
        }

        // set the mode subscribe/unsubscribe
        $post_string = 'hub.mode=' . $mode;
        $post_string .= '&hub.callback=' . urlencode($this->callback_url);
        $post_string .= '&hub.verify=' . $this->verify;
        $post_string .= '&hub.verify_token=' . $this->verify_token;
        $post_string .= '&hub.lease_seconds=' . $this->lease_seconds;

        // append the topic url parameters
        $post_string .= '&hub.topic=' . urlencode($topic_url);

        // make the http post request and return true/false
        // easy to over-write to use your own http function
        if ($http_function) {
            return call_user_func_array($http_function, [$this->hub_url, $post_string]);
        }

        return $this->http($this->hub_url, $post_string);
    }

    /**
     * Default http function that uses curl to post to the hub endpoint.
     *
     * @param string $url
     * @param string $post_string
     *
     * @return mixed
     */
    private function http($url, $post_string)
    {

        // add any additional curl options here
        $options = [
            CURLOPT_URL            => $url,
            CURLOPT_USERAGENT      => 'PubSubHubbub-Subscriber-PHP/1.0',
            CURLOPT_RETURNTRANSFER => true,
        ];

        if ($post_string) {
            $options[CURLOPT_POST] = true;
            $options[CURLOPT_POSTFIELDS] = $post_string;
        }

        if ($this->credentials) {
            $options[CURLOPT_USERPWD] = $this->credentials;
        }

        $ch = curl_init();
        curl_setopt_array($ch, $options);

        $response = curl_exec($ch);
        $info = curl_getinfo($ch);

        // all good -- anything in the 200 range
        if (substr($info['http_code'], 0, 1) == '2') {
            return $response;
        }

        return false;
    }
}