lib/profilelist.php

   1 <?php
   2
   3 /**
   4  * StatusNet, the distributed open-source microblogging tool
   5  *
   6  * Widget to show a list of profiles
   7  *
   8  * PHP version 5
   9  *
  10  * LICENCE: This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Public
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2008-2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/widget.php';
  36
  37 /**
  38  * Widget to show a list of profiles
  39  *
  40  * @category Public
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class ProfileList extends Widget
  49 {
  50     /** Current profile, profile query. */
  51     var $profile = null;
  52     /** Action object using us. */
  53     var $action = null;
  54
  55     function __construct($profile, $action=null)
  56     {
  57         parent::__construct($action);
  58
  59         $this->profile = $profile;
  60         $this->action = $action;
  61     }
  62
  63     function show()
  64     {
  65         $cnt = 0;
  66
  67         if (Event::handle('StartProfileList', array($this))) {
  68             $this->startList();
  69             $cnt = $this->showProfiles();
  70             $this->endList();
  71             Event::handle('EndProfileList', array($this));
  72         }
  73
  74         return $cnt;
  75     }
  76
  77     function startList()
  78     {
  79         $this->out->elementStart('ul', 'profiles xoxo');
  80     }
  81
  82     function endList()
  83     {
  84         $this->out->elementEnd('ul');
  85     }
  86
  87     function showProfiles()
  88     {
  89         $cnt = 0;
  90
  91         while ($this->profile->fetch()) {
  92             $cnt++;
  93             if($cnt > PROFILES_PER_PAGE) {
  94                 break;
  95             }
  96             $pli = $this->newListItem($this->profile);
  97             $pli->show();
  98         }
  99
 100         return $cnt;
 101     }
 102
 103     function newListItem($profile)
 104     {
 105         return new ProfileListItem($this->profile, $this->action);
 106     }
 107 }
 108
 109 class ProfileListItem extends Widget
 110 {
 111     /** Current profile. */
 112     var $profile = null;
 113     /** Action object using us. */
 114     var $action = null;
 115
 116     function __construct($profile, $action)
 117     {
 118         parent::__construct($action);
 119
 120         $this->profile = $profile;
 121         $this->action  = $action;
 122     }
 123
 124     function show()
 125     {
 126         if (Event::handle('StartProfileListItem', array($this))) {
 127             $this->startItem();
 128             if (Event::handle('StartProfileListItemProfile', array($this))) {
 129                 $this->showProfile();
 130                 Event::handle('EndProfileListItemProfile', array($this));
 131             }
 132             if (Event::handle('StartProfileListItemActions', array($this))) {
 133                 $this->showActions();
 134                 Event::handle('EndProfileListItemActions', array($this));
 135             }
 136             $this->endItem();
 137             Event::handle('EndProfileListItem', array($this));
 138         }
 139     }
 140
 141     function startItem()
 142     {
 143         $this->out->elementStart('li', array('class' => 'profile hentry',
 144                                              'id' => 'profile-' . $this->profile->id));
 145     }
 146
 147     function showProfile()
 148     {
 149         $this->startProfile();
 150         if (Event::handle('StartProfileListItemProfileElements', array($this))) {
 151             if (Event::handle('StartProfileListItemAvatar', array($this))) {
 152                 $this->showAvatar();
 153                 Event::handle('EndProfileListItemAvatar', array($this));
 154             }
 155             if (Event::handle('StartProfileListItemFullName', array($this))) {
 156                 $this->showFullName();
 157                 Event::handle('EndProfileListItemFullName', array($this));
 158             }
 159             if (Event::handle('StartProfileListItemLocation', array($this))) {
 160                 $this->showLocation();
 161                 Event::handle('EndProfileListItemLocation', array($this));
 162             }
 163             if (Event::handle('StartProfileListItemHomepage', array($this))) {
 164                 $this->showHomepage();
 165                 Event::handle('EndProfileListItemHomepage', array($this));
 166             }
 167             if (Event::handle('StartProfileListItemBio', array($this))) {
 168                 $this->showBio();
 169                 Event::handle('EndProfileListItemBio', array($this));
 170             }
 171             Event::handle('EndProfileListItemProfileElements', array($this));
 172         }
 173         $this->endProfile();
 174     }
 175
 176     function startProfile()
 177     {
 178         $this->out->elementStart('div', 'entity_profile vcard entry-content');
 179     }
 180
 181     function showAvatar()
 182     {
 183         $avatar = $this->profile->getAvatar(AVATAR_STREAM_SIZE);
 184         $aAttrs = $this->linkAttributes();
 185         $this->out->elementStart('a', $aAttrs);
 186         $this->out->element('img', array('src' => ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_STREAM_SIZE),
 187                                          'class' => 'photo avatar',
 188                                          'width' => AVATAR_STREAM_SIZE,
 189                                          'height' => AVATAR_STREAM_SIZE,
 190                                          'alt' =>
 191                                          ($this->profile->fullname) ? $this->profile->fullname :
 192                                          $this->profile->nickname));
 193         $this->out->text(' ');
 194         $hasFN = (!empty($this->profile->fullname)) ? 'nickname' : 'fn nickname';
 195         $this->out->elementStart('span', $hasFN);
 196         $this->out->raw($this->highlight($this->profile->nickname));
 197         $this->out->elementEnd('span');
 198         $this->out->elementEnd('a');
 199     }
 200
 201     function showFullName()
 202     {
 203         if (!empty($this->profile->fullname)) {
 204             $this->out->text(' ');
 205             $this->out->elementStart('span', 'fn');
 206             $this->out->raw($this->highlight($this->profile->fullname));
 207             $this->out->elementEnd('span');
 208         }
 209     }
 210
 211     function showLocation()
 212     {
 213         if (!empty($this->profile->location)) {
 214             $this->out->text(' ');
 215             $this->out->elementStart('span', 'label');
 216             $this->out->raw($this->highlight($this->profile->location));
 217             $this->out->elementEnd('span');
 218         }
 219     }
 220
 221     function showHomepage()
 222     {
 223         if (!empty($this->profile->homepage)) {
 224             $this->out->text(' ');
 225             $aAttrs = $this->homepageAttributes();
 226             $this->out->elementStart('a', $aAttrs);
 227             $this->out->raw($this->highlight($this->profile->homepage));
 228             $this->out->elementEnd('a');
 229         }
 230     }
 231
 232     function showBio()
 233     {
 234         if (!empty($this->profile->bio)) {
 235             $this->out->elementStart('p', 'note');
 236             $this->out->raw($this->highlight($this->profile->bio));
 237             $this->out->elementEnd('p');
 238         }
 239     }
 240
 241     function endProfile()
 242     {
 243         $this->out->elementEnd('div');
 244     }
 245
 246     function showActions()
 247     {
 248         $this->startActions();
 249         if (Event::handle('StartProfileListItemActionElements', array($this))) {
 250             $this->showSubscribeButton();
 251             Event::handle('EndProfileListItemActionElements', array($this));
 252         }
 253         $this->endActions();
 254     }
 255
 256     function startActions()
 257     {
 258         $this->out->elementStart('div', 'entity_actions');
 259         $this->out->elementStart('ul');
 260     }
 261
 262     function showSubscribeButton()
 263     {
 264         // Is this a logged-in user, looking at someone else's
 265         // profile?
 266
 267         $user = common_current_user();
 268
 269         if (!empty($user) && $this->profile->id != $user->id) {
 270             $this->out->elementStart('li', 'entity_subscribe');
 271             if ($user->isSubscribed($this->profile)) {
 272                 $usf = new UnsubscribeForm($this->out, $this->profile);
 273                 $usf->show();
 274             } else {
 275                 // We can't initiate sub for a remote OMB profile.
 276                 $remote = Remote_profile::staticGet('id', $this->profile->id);
 277                 if (empty($remote)) {
 278                     $sf = new SubscribeForm($this->out, $this->profile);
 279                     $sf->show();
 280                 }
 281             }
 282             $this->out->elementEnd('li');
 283         }
 284     }
 285
 286     function endActions()
 287     {
 288         $this->out->elementEnd('ul');
 289         $this->out->elementEnd('div');
 290     }
 291
 292     function endItem()
 293     {
 294         $this->out->elementEnd('li');
 295     }
 296
 297     function highlight($text)
 298     {
 299         return htmlspecialchars($text);
 300     }
 301
 302     function linkAttributes()
 303     {
 304         return array('href' => $this->profile->profileurl,
 305                      'class' => 'url entry-title',
 306                      'rel' => 'contact');
 307     }
 308
 309     function homepageAttributes()
 310     {
 311         return array('href' => $this->profile->homepage,
 312                      'class' => 'url');
 313     }
 314 }