From 25d03c42e605a4c443d8795bd5e44618a0d13cd1 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Sat, 18 Dec 2010 17:24:41 -0500 Subject: [PATCH 1/6] Add events for representing objects as activity:object Add 6 new events to make it easier to override the type of an activity object. --- EVENTS.txt | 24 ++++++++ lib/activityobject.php | 137 ++++++++++++++++++++++------------------- 2 files changed, 97 insertions(+), 64 deletions(-) diff --git a/EVENTS.txt b/EVENTS.txt index 6035077953..65265cdf0f 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -999,3 +999,27 @@ StartAdminPanelNav: Before displaying the first item in the list of admin panels EndAdminPanelNav: After displaying the last item in the list of admin panels - $nav The AdminPanelNav widget + +StartActivityObjectFromNotice: When converting a notice to an activity:object +- $notice: The notice being converted +- &$object: The resulting object. Fill this and return false to override defaults. + +EndActivityObjectFromNotice: After converting a notice to an activity:object +- $notice: The notice being converted +- &$object: The resulting object. Can be edited + +StartActivityObjectFromProfile: When converting a profile to an activity:object +- $profile: The profile being converted +- &$object: The (empty) object. Fill it up and return false to override defaults. + +EndActivityObjectFromProfile: After converting a profile to an activity:object +- $profile: The profile being converted +- &$object: The finished object. Can be tweaked + +StartActivityObjectFromGroup: When converting a group to an activity:object +- $group: The group being converted +- &$object: The (empty) object. Fill and return false to override. + +EndActivityObjectFromGroup: After converting a group to an activity:object +- $group: The group being converted +- &$object: The finished object. Tweak as needed. diff --git a/lib/activityobject.php b/lib/activityobject.php index e89c8db4e9..536e021334 100644 --- a/lib/activityobject.php +++ b/lib/activityobject.php @@ -381,13 +381,18 @@ class ActivityObject static function fromNotice(Notice $notice) { $object = new ActivityObject(); + + if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) { - $object->type = ActivityObject::NOTE; + $object->type = ActivityObject::NOTE; - $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; } @@ -396,57 +401,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 - ); + if (!empty($orig)) { + $object->avatarLinks[] = AvatarLink::fromAvatar($orig); + } - foreach ($sizes as $size) { - $alink = null; - $avatar = $profile->getAvatar($size); + $sizes = array( + AVATAR_PROFILE_SIZE, + AVATAR_STREAM_SIZE, + AVATAR_MINI_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); + foreach ($sizes as $size) { + $alink = null; + $avatar = $profile->getAvatar($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; - } - } - } + 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 ($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; + } + } + } - if (isset($profile->lat) && isset($profile->lon)) { - $object->geopoint = (float)$profile->lat - . ' ' . (float)$profile->lon; - } + $object->avatarLinks[] = $alink; + } - $object->poco = PoCo::fromProfile($profile); + 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; } @@ -455,27 +465,26 @@ 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->poco = PoCo::fromGroup($group); + $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo, + AVATAR_MINI_SIZE); + + $object->poco = PoCo::fromGroup($group); + + Event::handle('EndActivityObjectFromGroup', array($group, &$object)); + } return $object; } From 24f9a991b6ac8edfc7936b7adfcb7dd5955c66a3 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Mon, 20 Dec 2010 13:26:57 -0500 Subject: [PATCH 2/6] Let activity objects write directly to activity's own outputter --- lib/activity.php | 33 +++---------------------- lib/activityobject.php | 56 +++++++++++++++++++++++++++--------------- 2 files changed, 40 insertions(+), 49 deletions(-) diff --git a/lib/activity.php b/lib/activity.php index c3a984a7b9..3458c76b9a 100644 --- a/lib/activity.php +++ b/lib/activity.php @@ -349,32 +349,7 @@ class Activity if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) { $obj = $this->objects[0]; - - $xs->element('id', null, $obj->id); - $xs->element('activity:object-type', null, $obj->type); - - if (!empty($obj->title)) { - $xs->element('title', null, $obj->title); - } else { - // XXX need a better default title - $xs->element('title', null, _('Post')); - } - - if (!empty($obj->content)) { - $xs->element('content', array('type' => 'html'), $obj->content); - } - - if (!empty($obj->summary)) { - $xs->element('summary', null, $obj->summary); - } - - if (!empty($obj->link)) { - $xs->element('link', array('rel' => 'alternate', - 'type' => 'text/html'), - $obj->link); - } - - // XXX: some object types might have other values here. + $obj->outputTo($xs, null); } else { $xs->element('id', null, $this->id); @@ -408,12 +383,12 @@ class Activity $xs->element('name', array(), $this->actor->title); } $xs->elementEnd('author'); - $xs->raw($this->actor->asString('activity:actor')); + $this->actor->outputTo($xs, 'activity:actor'); } if ($this->verb != ActivityVerb::POST || count($this->objects) != 1) { foreach($this->objects as $object) { - $xs->raw($object->asString()); + $object->outputTo($xs, 'activity:object'); } } @@ -467,7 +442,7 @@ class Activity } if ($this->target) { - $xs->raw($this->target->asString('activity:target')); + $this->target->outputTo($xs, 'activity:target'); } foreach ($this->categories as $cat) { diff --git a/lib/activityobject.php b/lib/activityobject.php index 536e021334..61614935f1 100644 --- a/lib/activityobject.php +++ b/lib/activityobject.php @@ -415,10 +415,10 @@ class ActivityObject } $sizes = array( - AVATAR_PROFILE_SIZE, - AVATAR_STREAM_SIZE, - AVATAR_MINI_SIZE - ); + AVATAR_PROFILE_SIZE, + AVATAR_STREAM_SIZE, + AVATAR_MINI_SIZE + ); foreach ($sizes as $size) { $alink = null; @@ -488,19 +488,19 @@ class ActivityObject return $object; } + + function outputTo($xo, $tag='activity:object') + { + if (!empty($tag)) { + $xo->elementStart($tag); + } - function asString($tag='activity:object') - { - $xs = new XMLStringer(true); + $xo->element('activity:object-type', null, $this->type); - $xs->elementStart($tag); - - $xs->element('activity:object-type', null, $this->type); - - $xs->element(self::ID, null, $this->id); + $xo->element(self::ID, null, $this->id); if (!empty($this->title)) { - $xs->element( + $xo->element( self::TITLE, null, common_xml_safe_str($this->title) @@ -508,7 +508,7 @@ class ActivityObject } if (!empty($this->summary)) { - $xs->element( + $xo->element( self::SUMMARY, null, common_xml_safe_str($this->summary) @@ -517,7 +517,7 @@ class ActivityObject if (!empty($this->content)) { // XXX: assuming HTML content here - $xs->element( + $xo->element( ActivityUtils::CONTENT, array('type' => 'html'), common_xml_safe_str($this->content) @@ -525,7 +525,7 @@ class ActivityObject } if (!empty($this->link)) { - $xs->element( + $xo->element( 'link', array( 'rel' => 'alternate', @@ -540,7 +540,7 @@ class ActivityObject || $this->type == ActivityObject::GROUP) { foreach ($this->avatarLinks as $avatar) { - $xs->element( + $xo->element( 'link', array( 'rel' => 'avatar', 'type' => $avatar->type, @@ -554,7 +554,7 @@ class ActivityObject } if (!empty($this->geopoint)) { - $xs->element( + $xo->element( 'georss:point', null, $this->geopoint @@ -562,10 +562,26 @@ class ActivityObject } if (!empty($this->poco)) { - $xs->raw($this->poco->asString()); + $xo->raw($this->poco->asString()); } - $xs->elementEnd($tag); + foreach ($this->extra as $el) { + list($extraTag, $attrs, $content) = $el; + $xo->element($extraTag, $attrs, $content); + } + + if (!empty($tag)) { + $xo->elementEnd($tag); + } + + return; + } + + function asString($tag='activity:object') + { + $xs = new XMLStringer(true); + + $this->outputTo($xs, $tag); return $xs->getString(); } From c71d701a3f32472bb71ae38d21a4dd16ea1dcb97 Mon Sep 17 00:00:00 2001 From: Brion Vibber Date: Mon, 20 Dec 2010 10:46:23 -0800 Subject: [PATCH 3/6] Logging helper for bogus hmacs on PuSH in -- record the url & hub with the err msg to help tell what broke --- plugins/OStatus/classes/FeedSub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/OStatus/classes/FeedSub.php b/plugins/OStatus/classes/FeedSub.php index 140f323846..b34d7cd854 100644 --- a/plugins/OStatus/classes/FeedSub.php +++ b/plugins/OStatus/classes/FeedSub.php @@ -487,7 +487,7 @@ class FeedSub extends Memcached_DataObject if ($their_hmac === $our_hmac) { return true; } - common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac"); + common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi"); } else { common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bogus HMAC '$hmac'"); } From dd48bdb1c41986b68f8c855728a9285bb22c916e Mon Sep 17 00:00:00 2001 From: Brion Vibber Date: Mon, 20 Dec 2010 10:46:23 -0800 Subject: [PATCH 4/6] Logging helper for bogus hmacs on PuSH in -- record the url & hub with the err msg to help tell what broke --- plugins/OStatus/classes/FeedSub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/OStatus/classes/FeedSub.php b/plugins/OStatus/classes/FeedSub.php index 140f323846..b34d7cd854 100644 --- a/plugins/OStatus/classes/FeedSub.php +++ b/plugins/OStatus/classes/FeedSub.php @@ -487,7 +487,7 @@ class FeedSub extends Memcached_DataObject if ($their_hmac === $our_hmac) { return true; } - common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac"); + common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi"); } else { common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bogus HMAC '$hmac'"); } From a4e2f3835643c1d4b6d228151de2f863c02cb63c Mon Sep 17 00:00:00 2001 From: Brion Vibber Date: Mon, 20 Dec 2010 13:05:17 -0800 Subject: [PATCH 5/6] Slightly fancier debug code for PuSH hmac mismatches -- save the post to a temp file if feedsub/debug is on in config. --- plugins/OStatus/classes/FeedSub.php | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/plugins/OStatus/classes/FeedSub.php b/plugins/OStatus/classes/FeedSub.php index b34d7cd854..97245203d5 100644 --- a/plugins/OStatus/classes/FeedSub.php +++ b/plugins/OStatus/classes/FeedSub.php @@ -483,11 +483,19 @@ class FeedSub extends Memcached_DataObject if ($this->secret) { if (preg_match('/^sha1=([0-9a-fA-F]{40})$/', $hmac, $matches)) { $their_hmac = strtolower($matches[1]); - $our_hmac = hash_hmac('sha1', $post, $this->secret); + $our_hmac = hash_hmac('sha1', $post, $this->secret) . 'x'; if ($their_hmac === $our_hmac) { return true; } - common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi"); + if (common_config('feedsub', 'debug')) { + $tempfile = tempnam(sys_get_temp_dir(), 'feedsub-receive'); + if ($tempfile) { + file_put_contents($tempfile, $post); + } + common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi; saved to $tempfile"); + } else { + common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi"); + } } else { common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bogus HMAC '$hmac'"); } From 46123e37543be4ea784e90528176fd205bfece49 Mon Sep 17 00:00:00 2001 From: Brion Vibber Date: Mon, 20 Dec 2010 13:06:58 -0800 Subject: [PATCH 6/6] *cough* don't commit the code that breaks your code that you used to test the debug code :D --- plugins/OStatus/classes/FeedSub.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/OStatus/classes/FeedSub.php b/plugins/OStatus/classes/FeedSub.php index 97245203d5..7756f6a234 100644 --- a/plugins/OStatus/classes/FeedSub.php +++ b/plugins/OStatus/classes/FeedSub.php @@ -483,7 +483,7 @@ class FeedSub extends Memcached_DataObject if ($this->secret) { if (preg_match('/^sha1=([0-9a-fA-F]{40})$/', $hmac, $matches)) { $their_hmac = strtolower($matches[1]); - $our_hmac = hash_hmac('sha1', $post, $this->secret) . 'x'; + $our_hmac = hash_hmac('sha1', $post, $this->secret); if ($their_hmac === $our_hmac) { return true; }