Break out MagicEnvelope->toXML() functionality to allow for plugin flexibility

This commit is contained in:
Mikael Nordfeldth 2015-10-04 00:17:07 +02:00
parent bc9e3b1843
commit 184293c634
3 changed files with 66 additions and 41 deletions

View File

@ -1351,4 +1351,35 @@ class OStatusPlugin extends Plugin
} }
return true; return true;
} }
public function onSalmonSlap($endpoint_uri, MagicEnvelope $magic_env)
{
$envxml = $magic_env->toXML();
$headers = array('Content-Type: application/magic-envelope+xml');
try {
$client = new HTTPClient();
$client->setBody($envxml);
$response = $client->post($endpoint_uri, $headers);
} catch (HTTP_Request2_Exception $e) {
common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage());
return false;
}
if ($response->getStatus() === 422) {
common_debug(sprintf('Salmon (from profile %d) endpoint %s returned status %s. We assume it is a Diaspora seed, will adapt and try again if that plugin is enabled!'));
return true;
}
// 200 OK is the best response
// 202 Accepted is what we get from Diaspora for example
if (!in_array($response->getStatus(), array(200, 202))) {
common_log(LOG_ERR, sprintf('Salmon (from profile %d) endpoint %s returned status %s: %s',
$user->id, $endpoint_uri, $response->getStatus(), $response->getBody()));
return true;
}
// Since we completed the salmon slap, we discontinue the event
return false;
}
} }

View File

@ -205,7 +205,10 @@ class MagicEnvelope
* *
* @return string representation of XML document * @return string representation of XML document
*/ */
public function toXML() { public function toXML($flavour=null) {
$xml = null;
if (Event::handle('MagicEnvelopeToXML', array($this, $flavour, &$xml))) {
// fall back to our default, normal Magic Envelope XML.
$xs = new XMLStringer(); $xs = new XMLStringer();
$xs->startXML(); $xs->startXML();
$xs->elementStart('me:env', array('xmlns:me' => self::NS)); $xs->elementStart('me:env', array('xmlns:me' => self::NS));
@ -215,8 +218,12 @@ class MagicEnvelope
$xs->element('me:sig', null, $this->getSignature()); $xs->element('me:sig', null, $this->getSignature());
$xs->elementEnd('me:env'); $xs->elementEnd('me:env');
$string = $xs->getString(); $xml = $xs->getString();
return $string; }
if (is_null($xml)) {
throw new ServerException('No Magic Envelope XML string was created.');
}
return $xml;
} }
/* /*
@ -265,6 +272,21 @@ class MagicEnvelope
return $this->sig; return $this->sig;
} }
public function getSignatureAlgorithm()
{
return $this->alg;
}
public function getDataType()
{
return $this->data_type;
}
public function getEncoding()
{
return $this->encoding;
}
/** /**
* Find the author URI referenced in the payload Atom entry. * Find the author URI referenced in the payload Atom entry.
* *

View File

@ -60,39 +60,11 @@ class Salmon
return false; return false;
} }
$envxml = $magic_env->toXML(); if (Event::handle('SalmonSlap', array($magic_env))) {
$headers = array('Content-Type: application/magic-envelope+xml');
try {
$client = new HTTPClient();
$client->setBody($envxml);
$response = $client->post($endpoint_uri, $headers);
} catch (HTTP_Request2_Exception $e) {
common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage());
return false; return false;
//throw new ServerException('Could not distribute salmon slap as no plugin completed the event.');
} }
// Diaspora wants a slightly different formatting on the POST (other Content-type, so body needs "xml=")
// This also gives us the opportunity to send the specially formatted Diaspora salmon slap, which
// encrypts the content of me:data
if ($response->getStatus() === 422) {
common_debug(sprintf('Salmon (from profile %d) endpoint %s returned status %s. We assume it is a Diaspora seed, will adapt and try again! Body: %s',
$user->id, $endpoint_uri, $response->getStatus(), $response->getBody()));
$headers = array('Content-Type: application/x-www-form-urlencoded');
$client->setBody('xml=' . Magicsig::base64_url_encode($envxml));
$response = $client->post($endpoint_uri, $headers);
}
// 200 OK is the best response
// 202 Accepted is what we get from Diaspora for example
if (!in_array($response->getStatus(), array(200, 202))) {
common_log(LOG_ERR, sprintf('Salmon (from profile %d) endpoint %s returned status %s: %s',
$user->id, $endpoint_uri, $response->getStatus(), $response->getBody()));
return false;
}
// Success!
return true; return true;
} }
} }