3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * A sample module to show best practices for StatusNet plugins
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author James Walker <james@status.net>
25 * @copyright 2010 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
27 * @link http://status.net/
32 const NS_REPLIES = "http://salmon-protocol.org/ns/salmon-replies";
34 const NS_MENTIONS = "http://salmon-protocol.org/ns/salmon-mention";
37 * Sign and post the given Atom entry as a Salmon message.
39 * @fixme pass through the actor for signing?
41 * @param string $endpoint_uri
43 * @return boolean success
45 public function post($endpoint_uri, $xml, $actor)
47 if (empty($endpoint_uri)) {
52 $xml = $this->createMagicEnv($xml, $actor);
53 } catch (Exception $e) {
54 common_log(LOG_ERR, "Salmon unable to sign: " . $e->getMessage());
58 $headers = array('Content-Type: application/magic-envelope+xml');
61 $client = new HTTPClient();
62 $client->setBody($xml);
63 $response = $client->post($endpoint_uri, $headers);
64 } catch (HTTP_Request2_Exception $e) {
65 common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage());
68 if ($response->getStatus() != 200) {
69 common_log(LOG_ERR, "Salmon at $endpoint_uri returned status " .
70 $response->getStatus() . ': ' . $response->getBody());
76 public function createMagicEnv($text, $actor)
78 $magic_env = new MagicEnvelope();
80 $user = User::staticGet('id', $actor->id);
83 $magickey = Magicsig::staticGet('user_id', $user->id);
85 // No keypair yet, let's generate one.
86 $magickey = new Magicsig();
87 $magickey->generate($user->id);
90 throw new Exception("Salmon invalid actor for signing");
94 $env = $magic_env->signMessage($text, 'application/atom+xml', $magickey->toString());
95 } catch (Exception $e) {
98 return $magic_env->toXML($env);
102 public function verifyMagicEnv($text)
104 $magic_env = new MagicEnvelope();
106 $env = $magic_env->parse($text);
108 return $magic_env->verify($env);