actions/foaf.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 define('LISTENER', 1);
  23 define('LISTENEE', -1);
  24 define('BOTH', 0);
  25
  26 // @todo XXX: Documentation missing.
  27 class FoafAction extends Action
  28 {
  29     function isReadOnly($args)
  30     {
  31         return true;
  32     }
  33
  34     function prepare($args)
  35     {
  36         parent::prepare($args);
  37
  38         $nickname_arg = $this->arg('nickname');
  39
  40         if (empty($nickname_arg)) {
  41             // TRANS: Client error displayed when requesting Friends of a Friend feed without providing a user nickname.
  42             $this->clientError(_('No such user.'), 404);
  43             return false;
  44         }
  45
  46         $this->nickname = common_canonical_nickname($nickname_arg);
  47
  48         // Permanent redirect on non-canonical nickname
  49
  50         if ($nickname_arg != $this->nickname) {
  51             common_redirect(common_local_url('foaf',
  52                                              array('nickname' => $this->nickname)),
  53                             301);
  54             return false;
  55         }
  56
  57         $this->user = User::getKV('nickname', $this->nickname);
  58
  59         if (!$this->user) {
  60             // TRANS: Client error displayed when requesting Friends of a Friend feed for an object that is not a user.
  61             $this->clientError(_('No such user.'), 404);
  62             return false;
  63         }
  64
  65         $this->profile = $this->user->getProfile();
  66
  67         if (!$this->profile) {
  68             // TRANS: Error message displayed when referring to a user without a profile.
  69             $this->serverError(_('User has no profile.'), 500);
  70             return false;
  71         }
  72
  73         return true;
  74     }
  75
  76     function handle($args)
  77     {
  78         parent::handle($args);
  79
  80         header('Content-Type: application/rdf+xml');
  81
  82         $this->startXML();
  83         $this->elementStart('rdf:RDF', array('xmlns:rdf' =>
  84                                               'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
  85                                               'xmlns:rdfs' =>
  86                                               'http://www.w3.org/2000/01/rdf-schema#',
  87                                               'xmlns:geo' =>
  88                                               'http://www.w3.org/2003/01/geo/wgs84_pos#',
  89                                               'xmlns:bio' =>
  90                                               'http://purl.org/vocab/bio/0.1/',
  91                                               'xmlns:sioc' =>
  92                                               'http://rdfs.org/sioc/ns#',
  93                                               'xmlns' => 'http://xmlns.com/foaf/0.1/'));
  94
  95         // This is the document about the user
  96
  97         $this->showPpd('', $this->user->uri);
  98
  99         // Would be nice to tell if they were a Person or not (e.g. a #person usertag?)
 100         $this->elementStart('Agent', array('rdf:about' =>
 101                                              $this->user->uri));
 102         if ($this->user->email) {
 103             $this->element('mbox_sha1sum', null, sha1('mailto:' . $this->user->email));
 104         }
 105         if ($this->profile->fullname) {
 106             $this->element('name', null, $this->profile->fullname);
 107         }
 108         if ($this->profile->homepage) {
 109             $this->element('homepage', array('rdf:resource' => $this->profile->homepage));
 110         }
 111         if ($this->profile->profileurl) {
 112             $this->element('weblog', array('rdf:resource' => $this->profile->profileurl));
 113         }
 114         if ($this->profile->bio) {
 115             $this->element('bio:olb', null, $this->profile->bio);
 116         }
 117
 118         $location = $this->profile->getLocation();
 119         if ($location) {
 120             $attr = array();
 121             if ($location->getRdfURL()) {
 122                 $attr['rdf:about'] = $location->getRdfURL();
 123             }
 124             $location_name = $location->getName();
 125
 126             $this->elementStart('based_near');
 127             $this->elementStart('geo:SpatialThing', $attr);
 128             if ($location_name) {
 129                 $this->element('name', null, $location_name);
 130             }
 131             if ($location->lat) {
 132                 $this->element('geo:lat', null, $location->lat);
 133             }
 134             if ($location->lon) {
 135                 $this->element('geo:long', null, $location->lon);
 136             }
 137             if ($location->getURL()) {
 138                 $this->element('page', array('rdf:resource'=>$location->getURL()));
 139             }
 140             $this->elementEnd('geo:SpatialThing');
 141             $this->elementEnd('based_near');
 142         }
 143
 144         $avatar = Avatar::getOriginal($this->profile);
 145         if ($avatar) {
 146             $this->elementStart('img');
 147             $this->elementStart('Image', array('rdf:about' => $avatar->url));
 148             foreach (array(AVATAR_PROFILE_SIZE, AVATAR_STREAM_SIZE, AVATAR_MINI_SIZE) as $size) {
 149                 try {
 150                     $scaled = Avatar::getOriginal($this->profile);
 151                     $this->elementStart('thumbnail');
 152                     $this->element('Image', array('rdf:about' => $scaled->url));
 153                     $this->elementEnd('thumbnail');
 154                 } catch (Exception $e) {
 155                     // This avatar did not exist
 156                 }
 157             }
 158             $this->elementEnd('Image');
 159             $this->elementEnd('img');
 160         }
 161
 162         $person = $this->showMicrobloggingAccount($this->profile,
 163                                      common_root_url(), $this->user->uri,
 164                                      /*$fetchSubscriptions*/true,
 165                                      /*$isSubscriber*/false);
 166
 167         // Get people who subscribe to user
 168
 169         $sub = new Subscription();
 170         $sub->subscribed = $this->profile->id;
 171         $sub->whereAdd('subscriber != subscribed');
 172
 173         if ($sub->find()) {
 174             while ($sub->fetch()) {
 175                 $profile = Profile::getKV('id', $sub->subscriber);
 176                 if (empty($profile)) {
 177                     common_debug('Got a bad subscription: '.print_r($sub,true));
 178                     continue;
 179                 }
 180                 $other_uri = $profile->getUri();
 181                 if (array_key_exists($other_uri, $person)) {
 182                     $person[$other_uri][0] = BOTH;
 183                 } else {
 184                     $person[$other_uri] = array(LISTENER,
 185                                                 $profile->id,
 186                                                 $profile->nickname,
 187                                                 $profile->isLocal() ? 'local' : 'remote');
 188                 }
 189                 unset($profile);
 190             }
 191         }
 192
 193         unset($sub);
 194
 195         foreach ($person as $uri => $p) {
 196             list($type, $id, $nickname, $local) = $p;
 197             if ($type == BOTH) {
 198                 $this->element('knows', array('rdf:resource' => $uri));
 199             }
 200         }
 201
 202         $this->elementEnd('Agent');
 203
 204
 205         foreach ($person as $uri => $p) {
 206             $foaf_url = null;
 207             list($type, $id, $nickname, $local) = $p;
 208             if ($local == 'local') {
 209                 $foaf_url = common_local_url('foaf', array('nickname' => $nickname));
 210             }
 211             $profile = Profile::getKV($id);
 212             $this->elementStart('Agent', array('rdf:about' => $uri));
 213             if ($type == BOTH) {
 214                 $this->element('knows', array('rdf:resource' => $this->user->uri));
 215             }
 216             $this->showMicrobloggingAccount($profile,
 217                                    ($local == 'local') ? common_root_url() : null,
 218                                    $uri,
 219                                    /*$fetchSubscriptions*/false,
 220                                    /*$isSubscriber*/($type == LISTENER || $type == BOTH));
 221             if ($foaf_url) {
 222                 $this->element('rdfs:seeAlso', array('rdf:resource' => $foaf_url));
 223             }
 224             $this->elementEnd('Agent');
 225             if ($foaf_url) {
 226                 $this->showPpd($foaf_url, $uri);
 227             }
 228             $profile->free();
 229             $profile = null;
 230             unset($profile);
 231         }
 232
 233         $this->elementEnd('rdf:RDF');
 234         $this->endXML();
 235     }
 236
 237     function showPpd($foaf_url, $person_uri)
 238     {
 239         $this->elementStart('PersonalProfileDocument', array('rdf:about' => $foaf_url));
 240         $this->element('maker', array('rdf:resource' => $person_uri));
 241         $this->element('primaryTopic', array('rdf:resource' => $person_uri));
 242         $this->elementEnd('PersonalProfileDocument');
 243     }
 244
 245     /**
 246      * Output FOAF <account> bit for the given profile.
 247      *
 248      * @param Profile $profile
 249      * @param mixed $service Root URL of this StatusNet instance for a local
 250      *                       user, otherwise null.
 251      * @param mixed $useruri URI string for the referenced profile..
 252      * @param boolean $fetchSubscriptions Should we load and list all their subscriptions?
 253      * @param boolean $isSubscriber if not fetching subs, we can still mark the user as following the current page.
 254      *
 255      * @return array if $fetchSubscribers is set, return a list of info on those
 256      *               subscriptions.
 257      */
 258     function showMicrobloggingAccount($profile, $service=null, $useruri=null, $fetchSubscriptions=false, $isSubscriber=false)
 259     {
 260         $attr = array();
 261         if ($useruri) {
 262             $attr['rdf:about'] = $useruri . '#acct';
 263         }
 264
 265         // Their account
 266         $this->elementStart('account');
 267         $this->elementStart('OnlineAccount', $attr);
 268         if ($service) {
 269             $this->element('accountServiceHomepage', array('rdf:resource' =>
 270                                                            $service));
 271         }
 272         $this->element('accountName', null, $profile->nickname);
 273         $this->element('accountProfilePage', array('rdf:resource' => $profile->profileurl));
 274         if ($useruri) {
 275             $this->element('sioc:account_of', array('rdf:resource'=>$useruri));
 276         }
 277
 278         $person = array();
 279
 280         if ($fetchSubscriptions) {
 281             // Get people user is subscribed to
 282             $sub = new Subscription();
 283             $sub->subscriber = $profile->id;
 284             $sub->whereAdd('subscriber != subscribed');
 285
 286             if ($sub->find()) {
 287                 while ($sub->fetch()) {
 288                     $profile = Profile::getKV('id', $sub->subscribed);
 289                     if (empty($profile)) {
 290                         common_debug('Got a bad subscription: '.print_r($sub,true));
 291                         continue;
 292                     }
 293                     $other_uri = $profile->getUri();
 294                     $this->element('sioc:follows', array('rdf:resource' => $other_uri.'#acct'));
 295                     $person[$other_uri] = array(LISTENEE,
 296                                                 $profile->id,
 297                                                 $profile->nickname,
 298                                                 $profile->isLocal() ? 'local' : 'remote');
 299                     unset($profile);
 300                 }
 301             }
 302
 303             unset($sub);
 304         } else if ($isSubscriber) {
 305             // Just declare that they follow the user whose FOAF we're showing.
 306             $this->element('sioc:follows', array('rdf:resource' => $this->user->uri . '#acct'));
 307         }
 308
 309         $this->elementEnd('OnlineAccount');
 310         $this->elementEnd('account');
 311
 312         return $person;
 313     }
 314 }