3 * StatusNet, the distributed open-source microblogging tool
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * Utilities for turning DOMish things into Activityish things
38 * Some common functions that I didn't have the bandwidth to try to factor
39 * into some kind of reasonable superclass, so just dumped here. Might
40 * be useful to have an ActivityObject parent class or something.
44 * @author Evan Prodromou <evan@status.net>
45 * @copyright 2010 StatusNet, Inc.
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
47 * @link http://status.net/
51 const ATOM = 'http://www.w3.org/2005/Atom';
58 const CONTENT = 'content';
62 * Get the permalink for an Activity object
64 * @param DOMElement $element A DOM element
66 * @return string related link, if any
68 static function getPermalink($element)
70 return self::getLink($element, 'alternate', 'text/html');
74 * Get the permalink for an Activity object
76 * @param DOMElement $element A DOM element
78 * @return string related link, if any
80 static function getLink(DOMNode $element, $rel, $type=null)
82 $els = $element->childNodes;
84 foreach ($els as $link) {
85 if (!($link instanceof DOMElement)) {
89 if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) {
90 $linkRel = $link->getAttribute(self::REL);
91 $linkType = $link->getAttribute(self::TYPE);
93 if ($linkRel == $rel &&
94 (is_null($type) || $linkType == $type)) {
95 return $link->getAttribute(self::HREF);
103 static function getLinks(DOMNode $element, $rel, $type=null)
105 $els = $element->childNodes;
108 for ($i = 0; $i < $els->length; $i++) {
109 $link = $els->item($i);
110 if ($link->localName == self::LINK && $link->namespaceURI == self::ATOM) {
111 $linkRel = $link->getAttribute(self::REL);
112 $linkType = $link->getAttribute(self::TYPE);
114 if ($linkRel == $rel &&
115 (is_null($type) || $linkType == $type)) {
125 * Gets the first child element with the given tag
127 * @param DOMElement $element element to pick at
128 * @param string $tag tag to look for
129 * @param string $namespace Namespace to look under
131 * @return DOMElement found element or null
133 static function child(DOMNode $element, $tag, $namespace=self::ATOM)
135 $els = $element->childNodes;
136 if (empty($els) || $els->length == 0) {
139 for ($i = 0; $i < $els->length; $i++) {
140 $el = $els->item($i);
141 if ($el->localName == $tag && $el->namespaceURI == $namespace) {
149 * Gets all immediate child elements with the given tag
151 * @param DOMElement $element element to pick at
152 * @param string $tag tag to look for
153 * @param string $namespace Namespace to look under
155 * @return array found element or null
158 static function children(DOMNode $element, $tag, $namespace=self::ATOM)
162 $els = $element->childNodes;
164 if (!empty($els) && $els->length > 0) {
165 for ($i = 0; $i < $els->length; $i++) {
166 $el = $els->item($i);
167 if ($el->localName == $tag && $el->namespaceURI == $namespace) {
177 * Grab the text content of a DOM element child of the current element
179 * @param DOMElement $element Element whose children we examine
180 * @param string $tag Tag to look up
181 * @param string $namespace Namespace to use, defaults to Atom
183 * @return string content of the child
185 static function childContent(DOMNode $element, $tag, $namespace=self::ATOM)
187 $el = self::child($element, $tag, $namespace);
192 return $el->textContent;
196 static function childHtmlContent(DOMNode $element, $tag, $namespace=self::ATOM)
198 $el = self::child($element, $tag, $namespace);
203 return self::textConstruct($el);
208 * Get the content of an atom:entry-like object
210 * @param DOMElement $element The element to examine.
212 * @return string unencoded HTML content of the element, like "This -< is <b>HTML</b>."
214 * @todo handle remote content
215 * @todo handle embedded XML mime types
216 * @todo handle base64-encoded non-XML and non-text mime types
218 static function getContent($element)
220 return self::childHtmlContent($element, self::CONTENT, self::ATOM);
223 static function textConstruct($el)
225 $src = $el->getAttribute(self::SRC);
228 // TRANS: Client exception thrown when there is no source attribute.
229 throw new ClientException(_("Can't handle remote content yet."));
232 $type = $el->getAttribute(self::TYPE);
234 // slavishly following http://atompub.org/rfc4287.html#rfc.section.4.1.3.3
236 if (empty($type) || $type == 'text') {
237 // We have plaintext saved as the XML text content.
238 // Since we want HTML, we need to escape any special chars.
239 return htmlspecialchars($el->textContent);
240 } else if ($type == 'html') {
241 // We have HTML saved as the XML text content.
242 // No additional processing required once we've got it.
243 $text = $el->textContent;
245 } else if ($type == 'xhtml') {
246 // Per spec, the <content type="xhtml"> contains a single
247 // HTML <div> with XHTML namespace on it as a child node.
248 // We need to pull all of that <div>'s child nodes and
249 // serialize them back to an (X)HTML source fragment.
250 $divEl = ActivityUtils::child($el, 'div', 'http://www.w3.org/1999/xhtml');
254 $doc = $divEl->ownerDocument;
256 $children = $divEl->childNodes;
258 for ($i = 0; $i < $children->length; $i++) {
259 $child = $children->item($i);
260 $text .= $doc->saveXML($child);
263 } else if (in_array($type, array('text/xml', 'application/xml')) ||
264 preg_match('#(+|/)xml$#', $type)) {
265 // TRANS: Client exception thrown when there embedded XML content is found that cannot be processed yet.
266 throw new ClientException(_("Can't handle embedded XML content yet."));
267 } else if (strncasecmp($type, 'text/', 5)) {
268 return $el->textContent;
270 // TRANS: Client exception thrown when base64 encoded content is found that cannot be processed yet.
271 throw new ClientException(_("Can't handle embedded Base64 content yet."));
276 * Is this a valid URI for remote profile/notice identification?
277 * Does not have to be a resolvable URL.
281 static function validateUri($uri)
283 // Check mailto: URIs first
284 $validate = new Validate();
286 if (preg_match('/^mailto:(.*)$/', $uri, $match)) {
287 return $validate->email($match[1], common_config('email', 'check_domain'));
290 if ($validate->uri($uri)) {
294 // Possibly an upstream bug; tag: URIs aren't validated properly
295 // unless you explicitly ask for them. All other schemes are accepted
296 // for basic URI validation without asking.
297 if ($validate->uri($uri, array('allowed_schemes' => array('tag')))) {
304 static function getFeedAuthor(DOMElement $feedEl)
306 // Try old and deprecated activity:subject
308 $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
310 if (!empty($subject)) {
311 return new ActivityObject($subject);
314 // Try the feed author
316 $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
318 if (!empty($author)) {
319 return new ActivityObject($author);
322 // Sheesh. Not a very nice feed! Let's try fingerpoken in the
325 $entries = $feedEl->getElementsByTagNameNS(Activity::ATOM, 'entry');
327 if (!empty($entries) && $entries->length > 0) {
329 $entry = $entries->item(0);
331 // Try the (deprecated) activity:actor
333 $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
335 if (!empty($actor)) {
336 return new ActivityObject($actor);
341 $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
343 if (!empty($author)) {
344 return new ActivityObject($author);
351 static function compareTypes($type, $objects)
353 $type = self::resolveUri($type, false);
354 foreach ((array)$objects as $object) {
355 if ($type === self::resolveUri($object)) {
362 static function compareVerbs($type, $objects)
364 return self::compareTypes($type, $objects);
367 static function resolveUri($uri, $make_relative=false)
370 throw new ServerException('No URI to resolve in ActivityUtils::resolveUri');
373 if (!$make_relative && parse_url($uri, PHP_URL_SCHEME) == '') { // relative -> absolute
374 $uri = Activity::SCHEMA . $uri;
375 } elseif ($make_relative) { // absolute -> relative
376 $uri = basename($uri); //preg_replace('/^http:\/\/activitystrea\.ms\/schema\/1\.0\//', '', $uri);
377 } // absolute schemas pass through unharmed
382 static function findLocalObject(array $uris, $type=ActivityObject::NOTE) {
384 // TODO: Extend this in plugins etc. and describe in EVENTS.txt
385 if (Event::handle('StartFindLocalActivityObject', array($uris, $type, &$obj_class))) {
386 switch (self::resolveUri($type)) {
387 case ActivityObject::PERSON:
388 // GROUP will also be here in due time...
389 $obj_class = 'Profile';
392 $obj_class = 'Notice';
396 $uris = array_unique($uris);
397 foreach ($uris as $uri) {
399 // the exception thrown will cancel before reaching $object
400 $object = call_user_func("{$obj_class}::fromUri", $uri);
402 } catch (UnknownUriException $e) {
403 common_debug('Could not find local activity object from uri: '.$e->object_uri);
406 if (!$object instanceof Managed_DataObject) {
407 throw new ServerException('Could not find any activityobject stored locally with given URIs: '.var_export($uris,true));
409 Event::handle('EndFindLocalActivityObject', array($object->getUri(), $object->getObjectType(), $object));
413 // Check authorship by supplying a Profile as a default and letting plugins
414 // set it to something else if the activity's author is actually someone
415 // else (like with a group or peopletag feed as handled in OStatus).
417 // NOTE: Returned is not necessarily the supplied profile! For example,
418 // the "feed author" may be a group, but the "activity author" is a person!
419 static function checkAuthorship(Activity $activity, Profile $profile)
421 if (Event::handle('CheckActivityAuthorship', array($activity, &$profile))) {
422 // if (empty($activity->actor)), then we generated this Activity ourselves and can trust $profile
424 $actor_uri = $profile->getUri();
426 if (!in_array($actor_uri, array($activity->actor->id, $activity->actor->link))) {
427 // A mismatch between our locally stored URI and the supplied author?
428 // Probably not more than a blog feed or something (with multiple authors or so)
429 // but log it for future inspection.
430 common_log(LOG_WARNING, "Got an actor '{$activity->actor->title}' ({$activity->actor->id}) on single-user feed for " . $actor_uri);
431 } elseif (empty($activity->actor->id)) {
432 // Plain <author> without ActivityStreams actor info.
433 // We'll just ignore this info for now and save the update under the feed's identity.
437 if (!$profile instanceof Profile) {
438 throw new ServerException('Could not get an author Profile for activity');
444 static public function typeToTitle($type)
446 return ucfirst(self::resolveUri($type, true));
449 static public function verbToTitle($verb)
451 return ucfirst(self::resolveUri($verb, true));