. * * @category Feed * @package StatusNet * @author Evan Prodromou * @author Zach Copley * @copyright 2010 StatusNet, Inc. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3 * @link http://status.net/ */ if (!defined('STATUSNET')) { exit(1); } /** * Utilities for turning DOMish things into Activityish things * * Some common functions that I didn't have the bandwidth to try to factor * into some kind of reasonable superclass, so just dumped here. Might * be useful to have an ActivityObject parent class or something. * * @category OStatus * @package StatusNet * @author Evan Prodromou * @copyright 2010 StatusNet, Inc. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3 * @link http://status.net/ */ class ActivityUtils { const ATOM = 'http://www.w3.org/2005/Atom'; const LINK = 'link'; const REL = 'rel'; const TYPE = 'type'; const HREF = 'href'; const CONTENT = 'content'; const SRC = 'src'; /** * Get the permalink for an Activity object * * @param DOMElement $element A DOM element * * @return string related link, if any */ static function getPermalink($element) { return self::getLink($element, 'alternate', 'text/html'); } /** * Get the permalink for an Activity object * * @param DOMElement $element A DOM element * * @return string related link, if any */ static function getLink(DOMNode $element, $rel, $type=null) { $els = $element->childNodes; foreach ($els as $link) { if (!($link instanceof DOMElement)) { continue; } if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) { $linkRel = $link->getAttribute(self::REL); $linkType = $link->getAttribute(self::TYPE); if ($linkRel == $rel && (is_null($type) || $linkType == $type)) { return $link->getAttribute(self::HREF); } } } return null; } static function getLinks(DOMNode $element, $rel, $type=null) { $els = $element->childNodes; $out = array(); for ($i = 0; $i < $els->length; $i++) { $link = $els->item($i); if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) { $linkRel = $link->getAttribute(self::REL); $linkType = $link->getAttribute(self::TYPE); if ($linkRel == $rel && (is_null($type) || $linkType == $type)) { $out[] = $link; } } } return $out; } /** * Gets the first child element with the given tag * * @param DOMElement $element element to pick at * @param string $tag tag to look for * @param string $namespace Namespace to look under * * @return DOMElement found element or null */ static function child(DOMNode $element, $tag, $namespace=self::ATOM) { $els = $element->childNodes; if (empty($els) || $els->length == 0) { return null; } else { for ($i = 0; $i < $els->length; $i++) { $el = $els->item($i); if ($el->localName == $tag && $el->namespaceURI == $namespace) { return $el; } } } } /** * Gets all immediate child elements with the given tag * * @param DOMElement $element element to pick at * @param string $tag tag to look for * @param string $namespace Namespace to look under * * @return array found element or null */ static function children(DOMNode $element, $tag, $namespace=self::ATOM) { $results = array(); $els = $element->childNodes; if (!empty($els) && $els->length > 0) { for ($i = 0; $i < $els->length; $i++) { $el = $els->item($i); if ($el->localName == $tag && $el->namespaceURI == $namespace) { $results[] = $el; } } } return $results; } /** * Grab the text content of a DOM element child of the current element * * @param DOMElement $element Element whose children we examine * @param string $tag Tag to look up * @param string $namespace Namespace to use, defaults to Atom * * @return string content of the child */ static function childContent(DOMNode $element, $tag, $namespace=self::ATOM) { $el = self::child($element, $tag, $namespace); if (empty($el)) { return null; } else { return $el->textContent; } } static function childHtmlContent(DOMNode $element, $tag, $namespace=self::ATOM) { $el = self::child($element, $tag, $namespace); if (empty($el)) { return null; } else { return self::textConstruct($el); } } /** * Get the content of an atom:entry-like object * * @param DOMElement $element The element to examine. * * @return string unencoded HTML content of the element, like "This -< is HTML." * * @todo handle remote content * @todo handle embedded XML mime types * @todo handle base64-encoded non-XML and non-text mime types */ static function getContent($element) { return self::childHtmlContent($element, self::CONTENT, self::ATOM); } static function textConstruct($el) { $src = $el->getAttribute(self::SRC); if (!empty($src)) { // TRANS: Client exception thrown when there is no source attribute. throw new ClientException(_("Can't handle remote content yet.")); } $type = $el->getAttribute(self::TYPE); // slavishly following http://atompub.org/rfc4287.html#rfc.section.4.1.3.3 if (empty($type) || $type == 'text') { // We have plaintext saved as the XML text content. // Since we want HTML, we need to escape any special chars. return htmlspecialchars($el->textContent); } else if ($type == 'html') { // We have HTML saved as the XML text content. // No additional processing required once we've got it. $text = $el->textContent; return $text; } else if ($type == 'xhtml') { // Per spec, the contains a single // HTML
with XHTML namespace on it as a child node. // We need to pull all of that
's child nodes and // serialize them back to an (X)HTML source fragment. $divEl = ActivityUtils::child($el, 'div', 'http://www.w3.org/1999/xhtml'); if (empty($divEl)) { return null; } $doc = $divEl->ownerDocument; $text = ''; $children = $divEl->childNodes; for ($i = 0; $i < $children->length; $i++) { $child = $children->item($i); $text .= $doc->saveXML($child); } return trim($text); } else if (in_array($type, array('text/xml', 'application/xml')) || preg_match('#(+|/)xml$#', $type)) { // TRANS: Client exception thrown when there embedded XML content is found that cannot be processed yet. throw new ClientException(_("Can't handle embedded XML content yet.")); } else if (strncasecmp($type, 'text/', 5)) { return $el->textContent; } else { // TRANS: Client exception thrown when base64 encoded content is found that cannot be processed yet. throw new ClientException(_("Can't handle embedded Base64 content yet.")); } } /** * Is this a valid URI for remote profile/notice identification? * Does not have to be a resolvable URL. * @param string $uri * @return boolean */ static function validateUri($uri) { // Check mailto: URIs first if (preg_match('/^mailto:(.*)$/', $uri, $match)) { return Validate::email($match[1], common_config('email', 'check_domain')); } if (Validate::uri($uri)) { return true; } // Possibly an upstream bug; tag: URIs aren't validated properly // unless you explicitly ask for them. All other schemes are accepted // for basic URI validation without asking. if (Validate::uri($uri, array('allowed_scheme' => array('tag')))) { return true; } return false; } static function getFeedAuthor($feedEl) { // Try old and deprecated activity:subject $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC); if (!empty($subject)) { return new ActivityObject($subject); } // Try the feed author $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM); if (!empty($author)) { return new ActivityObject($author); } // Sheesh. Not a very nice feed! Let's try fingerpoken in the // entries. $entries = $feedEl->getElementsByTagNameNS(Activity::ATOM, 'entry'); if (!empty($entries) && $entries->length > 0) { $entry = $entries->item(0); // Try the (deprecated) activity:actor $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC); if (!empty($actor)) { return new ActivityObject($actor); } // Try the author $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM); if (!empty($author)) { return new ActivityObject($author); } } return null; } static function compareTypes($type, $objects) // this does verbs too! { $type = self::resolveUri($type); foreach ((array)$objects as $object) { if ($type === self::resolveUri($object)) { return true; } } return false; } static function resolveUri($uri, $make_relative=false) { if (empty($uri)) { throw new ServerException('No URI to resolve in ActivityUtils::resolveUri'); } if (!$make_relative && parse_url($uri, PHP_URL_SCHEME) == '') { // relative -> absolute $uri = Activity::SCHEMA . $uri; } elseif ($make_relative) { // absolute -> relative $uri = basename($uri); //preg_replace('/^http:\/\/activitystrea\.ms\/schema\/1\.0\//', '', $uri); } // absolute schemas pass through unharmed return $uri; } static function findLocalObject(array $uris, $type=ActivityObject::NOTE) { $object = null; // TODO: Extend this in plugins etc. if (Event::handle('StartFindLocalActivityObject', array($uris, $type, &$object))) { switch (self::resolveUri($type)) { case ActivityObject::PERSON: // GROUP will also be here in due time... $object = new Profile(); break; default: $object = new Notice(); } } foreach (array_unique($uris) as $uri) { try { // the exception thrown will cancel before reaching $object $object = call_user_func(array($object, 'fromUri'), $uri); break; } catch (Exception $e) { common_debug('Could not find local activity object from uri: '.$uri); } } if (!empty($object)) { Event::handle('EndFindLocalActivityObject', array($object->getUri(), $type, $object)); } else { throw new Exception('Could not find any activityobject stored locally with given URI'); } return $object; } }