3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009-2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * @package OStatusPlugin
22 * @maintainer Brion Vibber <brion@status.net>
25 class Ostatus_profile extends Memcached_DataObject
27 public $__table = 'ostatus_profile';
40 public /*static*/ function staticGet($k, $v=null)
42 return parent::staticGet(__CLASS__, $k, $v);
46 * return table definition for DB_DataObject
48 * DB_DataObject needs to know something about the table to manipulate
49 * instances. This method provides all the DB_DataObject needs to know.
51 * @return array array of column definitions
56 return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
57 'profile_id' => DB_DATAOBJECT_INT,
58 'group_id' => DB_DATAOBJECT_INT,
59 'feeduri' => DB_DATAOBJECT_STR,
60 'salmonuri' => DB_DATAOBJECT_STR,
61 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
62 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
65 static function schemaDef()
67 return array(new ColumnDef('uri', 'varchar',
69 new ColumnDef('profile_id', 'integer',
71 new ColumnDef('group_id', 'integer',
73 new ColumnDef('feeduri', 'varchar',
75 new ColumnDef('salmonuri', 'text',
77 new ColumnDef('created', 'datetime',
79 new ColumnDef('modified', 'datetime',
84 * return key definitions for DB_DataObject
86 * DB_DataObject needs to know about keys that the table has; this function
89 * @return array key definitions
94 return array_keys($this->keyTypes());
98 * return key definitions for Memcached_DataObject
100 * Our caching system uses the same key definitions, but uses a different
101 * method to get them.
103 * @return array key definitions
108 return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
111 function sequenceKey()
113 return array(false, false, false);
117 * Fetch the StatusNet-side profile for this feed
120 public function localProfile()
122 if ($this->profile_id) {
123 return Profile::staticGet('id', $this->profile_id);
129 * Fetch the StatusNet-side profile for this feed
132 public function localGroup()
134 if ($this->group_id) {
135 return User_group::staticGet('id', $this->group_id);
141 * Returns an XML string fragment with profile information as an
142 * Activity Streams noun object with the given element type.
144 * Assumes that 'activity' namespace has been previously defined.
146 * @param string $element one of 'actor', 'subject', 'object', 'target'
149 function asActivityNoun($element)
151 $xs = new XMLStringer(true);
153 $avatarHref = Avatar::defaultImage(AVATAR_PROFILE_SIZE);
154 $avatarType = 'image/png';
155 if ($this->isGroup()) {
156 $type = 'http://activitystrea.ms/schema/1.0/group';
157 $self = $this->localGroup();
159 // @fixme put a standard getAvatar() interface on groups too
160 if ($self->homepage_logo) {
161 $avatarHref = $self->homepage_logo;
162 $map = array('png' => 'image/png',
163 'jpg' => 'image/jpeg',
164 'jpeg' => 'image/jpeg',
165 'gif' => 'image/gif');
166 $extension = pathinfo(parse_url($avatarHref, PHP_URL_PATH), PATHINFO_EXTENSION);
167 if (isset($map[$extension])) {
168 $avatarType = $map[$extension];
172 $type = 'http://activitystrea.ms/schema/1.0/person';
173 $self = $this->localProfile();
174 $avatar = $self->getAvatar(AVATAR_PROFILE_SIZE);
176 $avatarHref = $avatar->
177 $avatarType = $avatar->mediatype;
180 $xs->elementStart('activity:' . $element);
182 'activity:object-type',
190 $xs->element('title', null, $self->getBestName());
194 'type' => $avatarType,
195 'href' => $avatarHref
200 $xs->elementEnd('activity:' . $element);
202 return $xs->getString();
210 return (strpos($this->feeduri, '/groups/') !== false);
214 * Subscribe a local user to this remote user.
215 * PuSH subscription will be started if necessary, and we'll
216 * send a Salmon notification to the remote server if available
217 * notifying them of the sub.
220 * @return boolean success
221 * @throws FeedException
223 public function subscribeLocalToRemote(User $user)
225 if ($this->isGroup()) {
226 throw new ServerException("Can't subscribe to a remote group");
229 if ($this->subscribe()) {
230 if ($user->subscribeTo($this->localProfile())) {
231 $this->notify($user->getProfile(), ActivityVerb::FOLLOW, $this);
239 * Mark this remote profile as subscribing to the given local user,
240 * and send appropriate notifications to the user.
242 * This will generally be in response to a subscription notification
243 * from a foreign site to our local Salmon response channel.
246 * @return boolean success
248 public function subscribeRemoteToLocal(User $user)
250 if ($this->isGroup()) {
251 throw new ServerException("Remote groups can't subscribe to local users");
254 // @fixme use regular channels for subbing, once they accept remote profiles
255 $sub = new Subscription();
256 $sub->subscriber = $this->profile_id;
257 $sub->subscribed = $user->id;
258 $sub->created = common_sql_now(); // current time
260 if ($sub->insert()) {
261 // @fixme use subs_notify() if refactored to take profiles?
262 mail_subscribe_notify_profile($user, $this->localProfile());
269 * Send a subscription request to the hub for this feed.
270 * The hub will later send us a confirmation POST to /main/push/callback.
272 * @return bool true on success, false on failure
273 * @throws ServerException if feed state is not valid
275 public function subscribe()
277 $feedsub = FeedSub::ensureFeed($this->feeduri);
278 if ($feedsub->sub_state == 'active' || $feedsub->sub_state == 'subscribe') {
280 } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
281 return $feedsub->subscribe();
282 } else if ('unsubscribe') {
283 throw new FeedSubException("Unsub is pending, can't subscribe...");
288 * Send a PuSH unsubscription request to the hub for this feed.
289 * The hub will later send us a confirmation POST to /main/push/callback.
291 * @return bool true on success, false on failure
292 * @throws ServerException if feed state is not valid
294 public function unsubscribe() {
295 $feedsub = FeedSub::staticGet('uri', $this->feeduri);
296 if ($feedsub->sub_state == 'active') {
297 return $feedsub->unsubscribe();
298 } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive' || $feedsub->sub_state == 'unsubscribe') {
300 } else if ($feedsub->sub_state == 'subscribe') {
301 throw new FeedSubException("Feed is awaiting subscription, can't unsub...");
306 * Send an Activity Streams notification to the remote Salmon endpoint,
309 * @param Profile $actor
310 * @param $verb eg Activity::SUBSCRIBE or Activity::JOIN
311 * @param $object object of the action; if null, the remote entity itself is assumed
313 public function notify($actor, $verb, $object=null)
315 if (!($actor instanceof Profile)) {
316 $type = gettype($actor);
317 if ($type == 'object') {
318 $type = get_class($actor);
320 throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
322 if ($object == null) {
325 if ($this->salmonuri) {
326 $text = 'update'; // @fixme
327 $id = 'tag:' . common_config('site', 'server') .
330 ':' . time(); // @fixme
332 //$entry = new Atom10Entry();
333 $entry = new XMLStringer();
334 $entry->elementStart('entry');
335 $entry->element('id', null, $id);
336 $entry->element('title', null, $text);
337 $entry->element('summary', null, $text);
338 $entry->element('published', null, common_date_w3dtf(common_sql_now()));
340 $entry->element('activity:verb', null, $verb);
341 $entry->raw($actor->asAtomAuthor());
342 $entry->raw($actor->asActivityActor());
343 $entry->raw($object->asActivityNoun('object'));
344 $entry->elementEnd('entry');
346 $feed = $this->atomFeed($actor);
347 $feed->addEntry($entry);
349 $xml = $feed->getString();
350 common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
352 $salmon = new Salmon(); // ?
353 $salmon->post($this->salmonuri, $xml);
357 function getBestName()
359 if ($this->isGroup()) {
360 return $this->localGroup()->getBestName();
362 return $this->localProfile()->getBestName();
366 function atomFeed($actor)
368 $feed = new Atom10Feed();
369 // @fixme should these be set up somewhere else?
370 $feed->addNamespace('activity', 'http://activitystrea.ms/spec/1.0/');
371 $feed->addNamespace('thr', 'http://purl.org/syndication/thread/1.0');
372 $feed->addNamespace('georss', 'http://www.georss.org/georss');
373 $feed->addNamespace('ostatus', 'http://ostatus.org/schema/1.0');
375 $taguribase = common_config('integration', 'taguri');
376 $feed->setId("tag:{$taguribase}:UserTimeline:{$actor->id}"); // ???
378 $feed->setTitle($actor->getBestName() . ' timeline'); // @fixme
379 $feed->setUpdated(time());
380 $feed->setPublished(time());
382 $feed->addLink(common_local_url('ApiTimelineUser',
383 array('id' => $actor->id,
385 array('rel' => 'self',
386 'type' => 'application/atom+xml'));
388 $feed->addLink(common_local_url('userbyid',
389 array('id' => $actor->id)),
390 array('rel' => 'alternate',
391 'type' => 'text/html'));
397 * Read and post notices for updates from the feed.
398 * Currently assumes that all items in the feed are new,
399 * coming from a PuSH hub.
401 * @param DOMDocument $feed
403 public function processFeed($feed)
405 $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
406 if ($entries->length == 0) {
407 common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
411 for ($i = 0; $i < $entries->length; $i++) {
412 $entry = $entries->item($i);
413 $this->processEntry($entry, $feed);
418 * Process a posted entry from this feed source.
420 * @param DOMElement $entry
421 * @param DOMElement $feed for context
423 protected function processEntry($entry, $feed)
425 $activity = new Activity($entry, $feed);
427 $debug = var_export($activity, true);
428 common_log(LOG_DEBUG, $debug);
430 if ($activity->verb == ActivityVerb::POST) {
431 $this->processPost($activity);
433 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
438 * Process an incoming post activity from this remote feed.
439 * @param Activity $activity
441 protected function processPost($activity)
443 if ($this->isGroup()) {
444 // @fixme validate these profiles in some way!
445 $oprofile = self::ensureActorProfile($activity);
447 $actorUri = self::getActorProfileURI($activity);
448 if ($actorUri == $this->uri) {
449 // @fixme check if profile info has changed and update it
451 // @fixme drop or reject the messages once we've got the canonical profile URI recorded sanely
452 common_log(LOG_INFO, "OStatus: Warning: non-group post with unexpected author: $actorUri expected $this->uri");
458 if ($activity->object->link) {
459 $sourceUri = $activity->object->link;
460 } else if (preg_match('!^https?://!', $activity->object->id)) {
461 $sourceUri = $activity->object->id;
463 common_log(LOG_INFO, "OStatus: ignoring post with no source link: id $activity->object->id");
467 $dupe = Notice::staticGet('uri', $sourceUri);
469 common_log(LOG_INFO, "OStatus: ignoring duplicate post: $noticeLink");
473 // @fixme sanitize and save HTML content if available
474 $content = $activity->object->title;
476 $params = array('is_local' => Notice::REMOTE_OMB,
477 'uri' => $sourceUri);
479 $location = $this->getEntryLocation($activity->entry);
481 $params['lat'] = $location->lat;
482 $params['lon'] = $location->lon;
483 if ($location->location_id) {
484 $params['location_ns'] = $location->location_ns;
485 $params['location_id'] = $location->location_id;
489 // @fixme save detailed ostatus source info
490 // @fixme ensure that groups get handled correctly
492 $saved = Notice::saveNew($oprofile->localProfile()->id,
499 * @param string $profile_url
500 * @return Ostatus_profile
501 * @throws FeedSubException
503 public static function ensureProfile($profile_uri)
505 // Get the canonical feed URI and check it
506 $discover = new FeedDiscovery();
507 $feeduri = $discover->discoverFromURL($profile_uri);
509 //$feedsub = FeedSub::ensureFeed($feeduri, $discover->feed);
510 $huburi = $discover->getAtomLink('hub');
511 $salmonuri = $discover->getAtomLink('salmon');
514 // We can only deal with folks with a PuSH hub
515 throw new FeedSubNoHubException();
518 // Ok this is going to be a terrible hack!
519 // Won't be suitable for groups, empty feeds, or getting
520 // info that's only available on the profile page.
521 $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
522 if (!$entries || $entries->length == 0) {
523 throw new FeedSubException('empty feed');
525 $first = new Activity($entries->item(0), $discover->feed);
526 return self::ensureActorProfile($first, $feeduri, $salmonuri);
530 * Download and update given avatar image
532 * @throws Exception in various failure cases
534 protected function updateAvatar($url)
536 // @fixme this should be better encapsulated
537 // ripped from oauthstore.php (for old OMB client)
538 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
539 copy($url, $temp_filename);
541 if ($this->isGroup()) {
542 $id = $this->group_id;
544 $id = $this->profile_id;
546 // @fixme should we be using different ids?
547 $imagefile = new ImageFile($id, $temp_filename);
548 $filename = Avatar::filename($id,
549 image_type_to_extension($imagefile->type),
552 rename($temp_filename, Avatar::path($filename));
553 if ($this->isGroup()) {
554 $group = $this->localGroup();
555 $group->setOriginal($filename);
557 $profile = $this->localProfile();
558 $profile->setOriginal($filename);
563 * Get an appropriate avatar image source URL, if available.
565 * @param ActivityObject $actor
566 * @param DOMElement $feed
569 protected static function getAvatar($actor, $feed)
573 if ($actor->avatar) {
574 $url = trim($actor->avatar);
577 // Check <atom:logo> and <atom:icon> on the feed
578 $els = $feed->childNodes();
579 if ($els && $els->length) {
580 for ($i = 0; $i < $els->length; $i++) {
581 $el = $els->item($i);
582 if ($el->namespaceURI == Activity::ATOM) {
583 if (empty($url) && $el->localName == 'logo') {
584 $url = trim($el->textContent);
587 if (empty($icon) && $el->localName == 'icon') {
589 $icon = trim($el->textContent);
594 if ($icon && !$url) {
599 $opts = array('allowed_schemes' => array('http', 'https'));
600 if (Validate::uri($url, $opts)) {
604 return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
608 * Fetch, or build if necessary, an Ostatus_profile for the actor
609 * in a given Activity Streams activity.
611 * @param Activity $activity
612 * @param string $feeduri if we already know the canonical feed URI!
613 * @param string $salmonuri if we already know the salmon return channel URI
614 * @return Ostatus_profile
616 public static function ensureActorProfile($activity, $feeduri=null, $salmonuri=null)
618 $profile = self::getActorProfile($activity);
620 $profile = self::createActorProfile($activity, $feeduri, $salmonuri);
626 * @param Activity $activity
627 * @return mixed matching Ostatus_profile or false if none known
629 protected static function getActorProfile($activity)
631 $homeuri = self::getActorProfileURI($activity);
632 return self::staticGet('uri', $homeuri);
636 * @param Activity $activity
638 * @throws ServerException
640 protected static function getActorProfileURI($activity)
642 $opts = array('allowed_schemes' => array('http', 'https'));
643 $actor = $activity->actor;
644 if ($actor->id && Validate::uri($actor->id, $opts)) {
647 if ($actor->link && Validate::uri($actor->link, $opts)) {
650 throw new ServerException("No author ID URI found");
654 * @fixme validate stuff somewhere
656 protected static function createActorProfile($activity, $feeduri=null, $salmonuri=null)
658 $actor = $activity->actor;
659 $homeuri = self::getActorProfileURI($activity);
660 $nickname = self::getAuthorNick($activity);
661 $avatar = self::getAvatar($actor, $activity->feed);
664 common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
665 throw new ServerException("No profile URI");
668 if (!$feeduri || !$salmonuri) {
669 // Get the canonical feed URI and check it
670 $discover = new FeedDiscovery();
671 $feeduri = $discover->discoverFromURL($homeuri);
673 $huburi = $discover->getAtomLink('hub');
674 $salmonuri = $discover->getAtomLink('salmon');
677 // We can only deal with folks with a PuSH hub
678 throw new FeedSubNoHubException();
682 $profile = new Profile();
683 $profile->nickname = $nickname;
684 $profile->fullname = $actor->displayName;
685 $profile->homepage = $actor->link; // @fixme
686 $profile->profileurl = $homeuri;
688 // @fixme tags/categories
690 // @todo tags from categories
691 // @todo lat/lon/location?
693 $ok = $profile->insert();
695 throw new ServerException("Can't save local profile");
698 // @fixme either need to do feed discovery here
699 // or need to split out some of the feed stuff
700 // so we can leave it empty until later.
701 $oprofile = new Ostatus_profile();
702 $oprofile->uri = $homeuri;
703 $oprofile->feeduri = $feeduri;
704 $oprofile->salmonuri = $salmonuri;
705 $oprofile->profile_id = $profile->id;
707 $oprofile->created = common_sql_now();
708 $oprofile->modified = common_sql_now();
710 $ok = $oprofile->insert();
712 $oprofile->updateAvatar($avatar);
715 throw new ServerException("Can't save OStatus profile");
720 * @fixme move this into Activity?
721 * @param Activity $activity
724 protected static function getAuthorNick($activity)
726 // @fixme not technically part of the actor?
727 foreach (array($activity->entry, $activity->feed) as $source) {
728 $author = ActivityUtils::child($source, 'author', Activity::ATOM);
730 $name = ActivityUtils::child($author, 'name', Activity::ATOM);
732 return trim($name->textContent);