X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Factivityobject.php;h=241f99564f214287cfd2bae9480054be916a334b;hb=b37c33dea2d151dcabf84357b2ea2a0b4f36be3c;hp=0a358ccabbe1c4ceb34199b7f0badc80485a64b3;hpb=e89908f26140c217e01b2f8f755712f38f3935f3;p=quix0rs-gnu-social.git

diff --git a/lib/activityobject.php b/lib/activityobject.php
index 0a358ccabb..241f99564f 100644
--- a/lib/activityobject.php
+++ b/lib/activityobject.php
@@ -49,7 +49,6 @@ if (!defined('STATUSNET')) {
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  * @link      http://status.net/
  */
-
 class ActivityObject
 {
     const ARTICLE   = 'http://activitystrea.ms/schema/1.0/article';
@@ -100,6 +99,14 @@ class ActivityObject
     public $poco;
     public $displayName;
 
+    // @todo move this stuff to it's own PHOTO activity object
+    const MEDIA_DESCRIPTION = 'description';
+
+    public $thumbnail;
+    public $largerImage;
+    public $description;
+    public $extra = array();
+
     /**
      * Constructor
      *
@@ -109,7 +116,6 @@ class ActivityObject
      *
      * @param DOMElement $element DOM thing to turn into an Activity thing
      */
-
     function __construct($element = null)
     {
         if (empty($element)) {
@@ -150,18 +156,56 @@ class ActivityObject
 
             $this->poco = new PoCo($element);
         }
+
+        if ($this->type == self::PHOTO) {
+
+            $this->thumbnail   = ActivityUtils::getLink($element, 'preview');
+            $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
+
+            $this->description = ActivityUtils::childContent(
+                $element,
+                ActivityObject::MEDIA_DESCRIPTION,
+                Activity::MEDIA
+            );
+        }
     }
 
     private function _fromAuthor($element)
     {
-        $this->type  = self::PERSON; // XXX: is this fair?
-        $this->title = $this->_childContent($element, self::NAME);
+        $this->type = $this->_childContent($element,
+                                           Activity::OBJECTTYPE,
+                                           Activity::SPEC);
+
+        if (empty($this->type)) {
+            $this->type = self::PERSON; // XXX: is this fair?
+        }
+
+        // start with <atom:title>
+
+        $title = ActivityUtils::childHtmlContent($element, self::TITLE);
+
+        if (!empty($title)) {
+            $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
+        }
+
+        // fall back to <atom:name>
 
-        $id = $this->_childContent($element, self::URI);
-        if (ActivityUtils::validateUri($id)) {
-            $this->id = $id;
+        if (empty($this->title)) {
+            $this->title = $this->_childContent($element, self::NAME);
         }
 
+        // start with <atom:id>
+
+        $this->id = $this->_childContent($element, self::ID);
+
+        // fall back to <atom:uri>
+
+        if (empty($this->id)) {
+            $this->id = $this->_childContent($element, self::URI);
+        }
+
+        // fall further back to <atom:email>
+
         if (empty($this->id)) {
             $email = $this->_childContent($element, self::EMAIL);
             if (!empty($email)) {
@@ -169,19 +213,18 @@ class ActivityObject
                 $this->id = 'mailto:'.$email;
             }
         }
+
+        $this->link = ActivityUtils::getPermalink($element);
+
+        // fall finally back to <link rel=alternate>
+
+        if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
+            $this->id = $this->link;
+        }
     }
 
     private function _fromAtomEntry($element)
     {
-        if ($element->localName == 'actor') {
-            // Old-fashioned <activity:actor>...
-            // First pull anything from <author>, then we'll add on top.
-            $author = ActivityUtils::child($element->parentNode, 'author');
-            if ($author) {
-                $this->_fromAuthor($author);
-            }
-        }
-
         $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
                                            Activity::SPEC);
 
@@ -189,11 +232,6 @@ class ActivityObject
             $this->type = ActivityObject::NOTE;
         }
 
-        $id = $this->_childContent($element, self::ID);
-        if (ActivityUtils::validateUri($id)) {
-            $this->id = $id;
-        }
-
         $this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
         $this->content = ActivityUtils::getContent($element);
 
@@ -201,15 +239,20 @@ class ActivityObject
 
         $title = ActivityUtils::childHtmlContent($element, self::TITLE);
 
-        $this->title = html_entity_decode(strip_tags($title));
+        $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
 
         $this->source  = $this->_getSource($element);
 
         $this->link = ActivityUtils::getPermalink($element);
-    }
 
-    // @fixme rationalize with Activity::_fromRssItem()
+        $this->id = $this->_childContent($element, self::ID);
 
+        if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
+            $this->id = $this->link;
+        }
+    }
+
+    // @todo FIXME: rationalize with Activity::_fromRssItem()
     private function _fromRssItem($item)
     {
         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
@@ -377,12 +420,17 @@ class ActivityObject
     {
         $object = new ActivityObject();
 
-        $object->type    = ActivityObject::NOTE;
+		if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
+
+			$object->type    = (empty($notice->object_type)) ? ActivityObject::NOTE : $notice->object_type;
 
-        $object->id      = $notice->uri;
-        $object->title   = $notice->content;
-        $object->content = $notice->rendered;
-        $object->link    = $notice->bestUrl();
+			$object->id      = $notice->uri;
+			$object->title   = $notice->content;
+			$object->content = $notice->rendered;
+			$object->link    = $notice->bestUrl();
+
+			Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
+		}
 
         return $object;
     }
@@ -391,47 +439,62 @@ class ActivityObject
     {
         $object = new ActivityObject();
 
-        $object->type   = ActivityObject::PERSON;
-        $object->id     = $profile->getUri();
-        $object->title  = $profile->getBestName();
-        $object->link   = $profile->profileurl;
+		if (Event::handle('StartActivityObjectFromProfile', array($profile, &$object))) {
 
-        $orig = $profile->getOriginalAvatar();
+			$object->type   = ActivityObject::PERSON;
+			$object->id     = $profile->getUri();
+			$object->title  = $profile->getBestName();
+			$object->link   = $profile->profileurl;
 
-        if (!empty($orig)) {
-            $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
-        }
+			$orig = $profile->getOriginalAvatar();
 
-        $sizes = array(
-            AVATAR_PROFILE_SIZE,
-            AVATAR_STREAM_SIZE,
-            AVATAR_MINI_SIZE
-        );
-
-        foreach ($sizes as $size) {
-
-            $alink  = null;
-            $avatar = $profile->getAvatar($size);
-
-            if (!empty($avatar)) {
-                $alink = AvatarLink::fromAvatar($avatar);
-            } else {
-                $alink = new AvatarLink();
-                $alink->type   = 'image/png';
-                $alink->height = $size;
-                $alink->width  = $size;
-                $alink->url    = Avatar::defaultImage($size);
-            }
-
-            $object->avatarLinks[] = $alink;
-        }
+			if (!empty($orig)) {
+				$object->avatarLinks[] = AvatarLink::fromAvatar($orig);
+			}
 
-        if (isset($profile->lat) && isset($profile->lon)) {
-            $object->geopoint = (float)$profile->lat
-                . ' ' . (float)$profile->lon;
-        }
+			$sizes = array(
+                AVATAR_PROFILE_SIZE,
+                AVATAR_STREAM_SIZE,
+                AVATAR_MINI_SIZE
+            );
 
-        $object->poco = PoCo::fromProfile($profile);
+			foreach ($sizes as $size) {
+				$alink  = null;
+				$avatar = $profile->getAvatar($size);
+
+				if (!empty($avatar)) {
+					$alink = AvatarLink::fromAvatar($avatar);
+				} else {
+					$alink = new AvatarLink();
+					$alink->type   = 'image/png';
+					$alink->height = $size;
+					$alink->width  = $size;
+					$alink->url    = Avatar::defaultImage($size);
+
+					if ($size == AVATAR_PROFILE_SIZE) {
+						// Hack for Twitter import: we don't have a 96x96 image,
+						// but we do have a 73x73 image. For now, fake it with that.
+						$avatar = $profile->getAvatar(73);
+						if ($avatar) {
+							$alink = AvatarLink::fromAvatar($avatar);
+							$alink->height= $size;
+							$alink->width = $size;
+						}
+					}
+				}
+
+				$object->avatarLinks[] = $alink;
+			}
+
+			if (isset($profile->lat) && isset($profile->lon)) {
+				$object->geopoint = (float)$profile->lat
+					. ' ' . (float)$profile->lon;
+			}
+
+			$object->poco = PoCo::fromProfile($profile);
+
+			Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
+		}
 
         return $object;
     }
@@ -440,109 +503,244 @@ class ActivityObject
     {
         $object = new ActivityObject();
 
-        $object->type   = ActivityObject::GROUP;
-        $object->id     = $group->getUri();
-        $object->title  = $group->getBestName();
-        $object->link   = $group->getUri();
+		if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
 
-        $object->avatarLinks[] = AvatarLink::fromFilename(
-            $group->homepage_logo,
-            AVATAR_PROFILE_SIZE
-        );
+			$object->type   = ActivityObject::GROUP;
+			$object->id     = $group->getUri();
+			$object->title  = $group->getBestName();
+			$object->link   = $group->getUri();
 
-        $object->avatarLinks[] = AvatarLink::fromFilename(
-            $group->stream_logo,
-            AVATAR_STREAM_SIZE
-        );
+			$object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
+															  AVATAR_PROFILE_SIZE);
 
-        $object->avatarLinks[] = AvatarLink::fromFilename(
-            $group->mini_logo,
-            AVATAR_MINI_SIZE
-        );
+			$object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
+															  AVATAR_STREAM_SIZE);
+
+			$object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
+															  AVATAR_MINI_SIZE);
 
-        $object->poco = PoCo::fromGroup($group);
+			$object->poco = PoCo::fromGroup($group);
+
+			Event::handle('EndActivityObjectFromGroup', array($group, &$object));
+		}
 
         return $object;
     }
 
-    function asString($tag='activity:object')
-    {
-        $xs = new XMLStringer(true);
-
-        $xs->elementStart($tag);
+	function outputTo($xo, $tag='activity:object')
+	{
+		if (!empty($tag)) {
+			$xo->elementStart($tag);
+		}
 
-        $xs->element('activity:object-type', null, $this->type);
+        if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
+            $xo->element('activity:object-type', null, $this->type);
 
-        $xs->element(self::ID, null, $this->id);
+            // <author> uses URI
 
-        if (!empty($this->title)) {
-            $xs->element(
-                self::TITLE,
-                null,
-                common_xml_safe_str($this->title)
-            );
-        }
+            if ($tag == 'author') {
+                $xo->element(self::URI, null, $this->id);
+            } else {
+                $xo->element(self::ID, null, $this->id);
+            }
 
-        if (!empty($this->summary)) {
-            $xs->element(
-                self::SUMMARY,
-                null,
-                common_xml_safe_str($this->summary)
-            );
-        }
+            if (!empty($this->title)) {
+                $name = common_xml_safe_str($this->title);
+                if ($tag == 'author') {
+                    // XXX: Backward compatibility hack -- atom:name should contain
+                    // full name here, instead of nickname, i.e.: $name. Change
+                    // this in the next version.
+                    $xo->element(self::NAME, null, $this->poco->preferredUsername);
+                } else {
+                    $xo->element(self::TITLE, null, $name);
+                }
+            }
 
-        if (!empty($this->content)) {
-            // XXX: assuming HTML content here
-            $xs->element(
-                ActivityUtils::CONTENT,
-                array('type' => 'html'),
-                common_xml_safe_str($this->content)
-            );
-        }
+            if (!empty($this->summary)) {
+                $xo->element(
+                    self::SUMMARY,
+                    null,
+                    common_xml_safe_str($this->summary)
+                );
+            }
 
-        if (!empty($this->link)) {
-            $xs->element(
-                'link',
-                array(
-                    'rel' => 'alternate',
-                    'type' => 'text/html',
-                    'href' => $this->link
-                ),
-                null
-            );
-        }
+            if (!empty($this->content)) {
+                // XXX: assuming HTML content here
+                $xo->element(
+                    ActivityUtils::CONTENT,
+                    array('type' => 'html'),
+                    common_xml_safe_str($this->content)
+                );
+            }
 
-        if ($this->type == ActivityObject::PERSON
-            || $this->type == ActivityObject::GROUP) {
-
-            foreach ($this->avatarLinks as $avatar) {
-                $xs->element(
-                    'link', array(
-                        'rel'  => 'avatar',
-                        'type'         => $avatar->type,
-                        'media:width'  => $avatar->width,
-                        'media:height' => $avatar->height,
-                        'href' => $avatar->url
+            if (!empty($this->link)) {
+                $xo->element(
+                    'link',
+                    array(
+                        'rel' => 'alternate',
+                        'type' => 'text/html',
+                        'href' => $this->link
                     ),
                     null
                 );
             }
-        }
 
-        if (!empty($this->geopoint)) {
-            $xs->element(
-                'georss:point',
-                null,
-                $this->geopoint
-            );
-        }
+            if ($this->type == ActivityObject::PERSON
+                || $this->type == ActivityObject::GROUP) {
+
+                foreach ($this->avatarLinks as $avatar) {
+                    $xo->element(
+                        'link', array(
+                            'rel'  => 'avatar',
+                            'type'         => $avatar->type,
+                            'media:width'  => $avatar->width,
+                            'media:height' => $avatar->height,
+                            'href' => $avatar->url
+                        ),
+                        null
+                    );
+                }
+            }
 
-        if (!empty($this->poco)) {
-            $xs->raw($this->poco->asString());
+            if (!empty($this->geopoint)) {
+                $xo->element(
+                    'georss:point',
+                    null,
+                    $this->geopoint
+                );
+            }
+
+            if (!empty($this->poco)) {
+                $this->poco->outputTo($xo);
+            }
+
+            // @fixme there's no way here to make a tree; elements can only contain plaintext
+            // @fixme these may collide with JSON extensions
+            foreach ($this->extra as $el) {
+                list($extraTag, $attrs, $content) = $el;
+                $xo->element($extraTag, $attrs, $content);
+            }
+
+            Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
         }
 
-        $xs->elementEnd($tag);
+		if (!empty($tag)) {
+			$xo->elementEnd($tag);
+		}
+
+        return;
+	}
+
+    function asString($tag='activity:object')
+    {
+        $xs = new XMLStringer(true);
+
+		$this->outputTo($xs, $tag);
 
         return $xs->getString();
     }
+
+    /*
+     * Returns an array based on this Activity Object suitable for
+     * encoding as JSON.
+     *
+     * @return array $object the activity object array
+     */
+
+    function asArray()
+    {
+        $object = array();
+
+        if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
+            // XXX: attachedObjects are added by Activity
+
+            // displayName
+            $object['displayName'] = $this->title;
+
+            // TODO: downstreamDuplicates
+
+            // embedCode (used for video)
+
+            // id
+            //
+            // XXX: Should we use URL here? or a crazy tag URI?
+            $object['id'] = $this->id;
+
+            if ($this->type == ActivityObject::PERSON
+                || $this->type == ActivityObject::GROUP) {
+
+                // XXX: Not sure what the best avatar is to use for the
+                // author's "image". For now, I'm using the large size.
+
+                $avatarLarge      = null;
+                $avatarMediaLinks = array();
+
+                foreach ($this->avatarLinks as $a) {
+
+                    // Make a MediaLink for every other Avatar
+                    $avatar = new ActivityStreamsMediaLink(
+                        $a->url,
+                        $a->width,
+                        $a->height,
+                        $a->type,
+                        'avatar'
+                    );
+
+                    // Find the big avatar to use as the "image"
+                    if ($a->height == AVATAR_PROFILE_SIZE) {
+                        $imgLink = $avatar;
+                    }
+
+                    $avatarMediaLinks[] = $avatar->asArray();
+                }
+
+                $object['avatarLinks'] = $avatarMediaLinks; // extension
+
+                // image
+                $object['image']  = $imgLink->asArray();
+            }
+
+            // objectType
+            //
+            // We can probably use the whole schema URL here but probably the
+            // relative simple name is easier to parse
+            // @fixme this breaks extension URIs
+            $object['type'] = substr($this->type, strrpos($this->type, '/') + 1);
+
+            // summary
+            $object['summary'] = $this->summary;
+
+            // TODO: upstreamDuplicates
+
+            // url (XXX: need to put the right thing here...)
+            $object['url'] = $this->id;
+
+            /* Extensions */
+            // @fixme these may collide with XML extensions
+            // @fixme multiple tags of same name will overwrite each other
+            // @fixme text content from XML extensions will be lost
+            foreach ($this->extra as $e) {
+                list($objectName, $props, $txt) = $e;
+                $object[$objectName] = $props;
+            }
+
+            // GeoJSON
+
+            if (!empty($this->geopoint)) {
+
+                list($lat, $long) = explode(' ', $this->geopoint);
+
+                $object['geopoint'] = array(
+                    'type'        => 'Point',
+                    'coordinates' => array($lat, $long)
+                );
+            }
+
+            if (!empty($this->poco)) {
+                $object['contact'] = $this->poco->asArray();
+            }
+            Event::handle('EndActivityObjectOutputJson', array($this, &$object));
+        }
+        return array_filter($object);
+    }
 }