3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * Integrated PuSH hub; lets us only ping them what need it.
23 * @maintainer Brion Vibber <brion@status.net>
26 if (!defined('STATUSNET')) {
31 * Things to consider...
32 * should we purge incomplete subscriptions that never get a verification pingback?
33 * when can we send subscription renewal checks?
34 * - at next send time probably ok
35 * when can we handle trimming of subscriptions?
36 * - at next send time probably ok
37 * should we keep a fail count?
39 class PushHubAction extends Action
41 function arg($arg, $def=null)
43 // PHP converts '.'s in incoming var names to '_'s.
44 // It also merges multiple values, which'll break hub.verify and hub.topic for publishing
45 // @fixme handle multiple args
46 $arg = str_replace('hub.', 'hub_', $arg);
47 return parent::arg($arg, $def);
50 protected function prepare(array $args=array())
52 GNUsocial::setApi(true); // reduce exception reports to aid in debugging
53 return parent::prepare($args);
56 protected function handle()
58 $mode = $this->trimmed('hub.mode');
62 $this->subunsub($mode);
65 // TRANS: Client exception.
66 throw new ClientException(_m('Publishing outside feeds not supported.'), 400);
68 // TRANS: Client exception. %s is a mode.
69 throw new ClientException(sprintf(_m('Unrecognized mode "%s".'),$mode), 400);
74 * Process a request for a new or modified PuSH feed subscription.
75 * If asynchronous verification is requested, updates won't be saved immediately.
78 * 202 Accepted - request saved and awaiting verification
79 * 204 No Content - already subscribed
80 * 400 Bad Request - rejecting this (not specifically spec'd)
82 function subunsub($mode)
84 $callback = $this->argUrl('hub.callback');
86 common_debug('New PuSH hub request ('._ve($mode).') for callback '._ve($callback));
87 $topic = $this->argUrl('hub.topic');
88 if (!$this->recognizedFeed($topic)) {
89 common_debug('PuSH hub request had unrecognized feed topic=='._ve($topic));
90 // TRANS: Client exception. %s is a topic.
91 throw new ClientException(sprintf(_m('Unsupported hub.topic %s this hub only serves local user and group Atom feeds.'),$topic));
94 $lease = $this->arg('hub.lease_seconds', null);
95 if ($mode == 'subscribe' && $lease != '' && !preg_match('/^\d+$/', $lease)) {
96 common_debug('PuSH hub request had invalid lease_seconds=='._ve($lease));
97 // TRANS: Client exception. %s is the invalid lease value.
98 throw new ClientException(sprintf(_m('Invalid hub.lease "%s". It must be empty or positive integer.'),$lease));
101 $secret = $this->arg('hub.secret', null);
102 if ($secret != '' && strlen($secret) >= 200) {
103 common_debug('PuSH hub request had invalid secret=='._ve($secret));
104 // TRANS: Client exception. %s is the invalid hub secret.
105 throw new ClientException(sprintf(_m('Invalid hub.secret "%s". It must be under 200 bytes.'),$secret));
108 $sub = HubSub::getByHashkey($topic, $callback);
109 if (!$sub instanceof HubSub) {
110 // Creating a new one!
111 common_debug('PuSH creating new HubSub entry for topic=='._ve($topic).' to remote callback '._ve($callback));
113 $sub->topic = $topic;
114 $sub->callback = $callback;
116 if ($mode == 'subscribe') {
118 $sub->secret = $secret;
121 common_debug('PuSH hub setting dataobject lease to:'._ve(intval($lease)));
122 $sub->setLease(intval($lease));
125 common_debug('PuSH hub request is now:'._ve($sub));
127 $verify = $this->arg('hub.verify'); // TODO: deprecated
128 $token = $this->arg('hub.verify_token', null); // TODO: deprecated
129 if ($verify == 'sync') { // pre-0.4 PuSH
130 $sub->verify($mode, $token);
131 header('HTTP/1.1 204 No Content');
132 } else { // If $verify is not "sync", we might be using PuSH 0.4
133 $sub->scheduleVerify($mode, $token); // If we were certain it's PuSH 0.4, token could be removed
134 header('HTTP/1.1 202 Accepted');
139 * Check whether the given URL represents one of our canonical
140 * user or group Atom feeds.
142 * @param string $feed URL
143 * @return boolean true if it matches, false if not a recognized local feed
144 * @throws exception if local entity does not exist
146 protected function recognizedFeed($feed)
149 // Simple mapping to local ID for user or group
150 if (preg_match('!/(\d+)\.atom$!', $feed, $matches)) {
152 $params = array('id' => $id, 'format' => 'atom');
154 // Double-check against locally generated URLs
156 case common_local_url('ApiTimelineUser', $params):
157 $user = User::getKV('id', $id);
158 if (!$user instanceof User) {
159 // TRANS: Client exception. %s is a feed URL.
160 throw new ClientException(sprintf(_m('Invalid hub.topic "%s". User does not exist.'),$feed));
164 case common_local_url('ApiTimelineGroup', $params):
165 $group = Local_group::getKV('group_id', $id);
166 if (!$group instanceof Local_group) {
167 // TRANS: Client exception. %s is a feed URL.
168 throw new ClientException(sprintf(_m('Invalid hub.topic "%s". Local_group does not exist.'),$feed));
172 common_debug("Feed was not recognized by any local User or Group Atom feed URLs: {$feed}");
176 // Profile lists are unique per user, so we need both IDs
177 if (preg_match('!/(\d+)/lists/(\d+)/statuses\.atom$!', $feed, $matches)) {
180 $params = array('user' => $user, 'id' => $id, 'format' => 'atom');
182 // Double-check against locally generated URLs
184 case common_local_url('ApiTimelineList', $params):
185 $list = Profile_list::getKV('id', $id);
186 $user = User::getKV('id', $user);
187 if (!$list instanceof Profile_list || !$user instanceof User || $list->tagger != $user->id) {
188 // TRANS: Client exception. %s is a feed URL.
189 throw new ClientException(sprintf(_m('Invalid hub.topic %s; list does not exist.'),$feed));
193 common_debug("Feed was not recognized by any local Profile_list Atom feed URL: {$feed}");
197 common_debug("Unknown feed URL structure, can't match against local user, group or profile_list: {$feed}");
202 * Grab and validate a URL from POST parameters.
203 * @throws ClientException for malformed or non-http/https URLs
205 protected function argUrl($arg)
207 $url = $this->arg($arg);
208 $params = array('domain_check' => false, // otherwise breaks my local tests :P
209 'allowed_schemes' => array('http', 'https'));
210 $validate = new Validate();
211 if ($validate->uri($url, $params)) {
214 // TRANS: Client exception.
215 // TRANS: %1$s is this argument to the method this exception occurs in, %2$s is a URL.
216 throw new ClientException(sprintf(_m('Invalid URL passed for %1$s: "%2$s"'),$arg,$url));
221 * Get HubSub subscription record for a given feed & subscriber.
223 * @param string $feed
224 * @param string $callback
225 * @return mixed HubSub or false
227 protected function getSub($feed, $callback)
229 return HubSub::getByHashkey($feed, $callback);