actions/showgroup.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Group main page
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Group
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@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/noticelist.php';
  36 require_once INSTALLDIR.'/lib/feedlist.php';
  37
  38 define('MEMBERS_PER_SECTION', 27);
  39
  40 /**
  41  * Group main page
  42  *
  43  * @category Group
  44  * @package  StatusNet
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  */
  49
  50 class ShowgroupAction extends GroupDesignAction
  51 {
  52
  53     /** page we're viewing. */
  54     var $page = null;
  55
  56     /**
  57      * Is this page read-only?
  58      *
  59      * @return boolean true
  60      */
  61
  62     function isReadOnly($args)
  63     {
  64         return true;
  65     }
  66
  67     /**
  68      * Title of the page
  69      *
  70      * @return string page title, with page number
  71      */
  72
  73     function title()
  74     {
  75         if (!empty($this->group->fullname)) {
  76             $base = $this->group->fullname . ' (' . $this->group->nickname . ')';
  77         } else {
  78             $base = $this->group->nickname;
  79         }
  80
  81         if ($this->page == 1) {
  82             return sprintf(_('%s group'), $base);
  83         } else {
  84             return sprintf(_('%1$s group, page %2$d'),
  85                            $base,
  86                            $this->page);
  87         }
  88     }
  89
  90     /**
  91      * Prepare the action
  92      *
  93      * Reads and validates arguments and instantiates the attributes.
  94      *
  95      * @param array $args $_REQUEST args
  96      *
  97      * @return boolean success flag
  98      */
  99
 100     function prepare($args)
 101     {
 102         parent::prepare($args);
 103
 104         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
 105
 106         $nickname_arg = $this->arg('nickname');
 107         $nickname = common_canonical_nickname($nickname_arg);
 108
 109         // Permanent redirect on non-canonical nickname
 110
 111         if ($nickname_arg != $nickname) {
 112             $args = array('nickname' => $nickname);
 113             if ($this->page != 1) {
 114                 $args['page'] = $this->page;
 115             }
 116             common_redirect(common_local_url('showgroup', $args), 301);
 117             return false;
 118         }
 119
 120         if (!$nickname) {
 121             $this->clientError(_('No nickname.'), 404);
 122             return false;
 123         }
 124
 125         $local = Local_group::staticGet('nickname', $nickname);
 126
 127         if (!$local) {
 128             $alias = Group_alias::staticGet('alias', $nickname);
 129             if ($alias) {
 130                 $args = array('id' => $alias->group_id);
 131                 if ($this->page != 1) {
 132                     $args['page'] = $this->page;
 133                 }
 134                 common_redirect(common_local_url('groupbyid', $args), 301);
 135                 return false;
 136             } else {
 137                 common_log(LOG_NOTICE, "Couldn't find local group for nickname '$nickname'");
 138                 $this->clientError(_('No such group.'), 404);
 139                 return false;
 140             }
 141         }
 142
 143         $this->group = User_group::staticGet('id', $local->group_id);
 144
 145         if (!$this->group) {
 146             $this->clientError(_('No such group.'), 404);
 147             return false;
 148         }
 149
 150         common_set_returnto($this->selfUrl());
 151
 152         return true;
 153     }
 154
 155     /**
 156      * Handle the request
 157      *
 158      * Shows a profile for the group, some controls, and a list of
 159      * group notices.
 160      *
 161      * @return void
 162      */
 163
 164     function handle($args)
 165     {
 166         $this->showPage();
 167     }
 168
 169     /**
 170      * Local menu
 171      *
 172      * @return void
 173      */
 174
 175     function showLocalNav()
 176     {
 177         $nav = new GroupNav($this, $this->group);
 178         $nav->show();
 179     }
 180
 181     /**
 182      * Show the page content
 183      *
 184      * Shows a group profile and a list of group notices
 185      */
 186
 187     function showContent()
 188     {
 189         $this->showGroupProfile();
 190         $this->showGroupNotices();
 191     }
 192
 193     /**
 194      * Show the group notices
 195      *
 196      * @return void
 197      */
 198
 199     function showGroupNotices()
 200     {
 201         $notice = $this->group->getNotices(($this->page-1)*NOTICES_PER_PAGE,
 202                                            NOTICES_PER_PAGE + 1);
 203
 204         $nl = new NoticeList($notice, $this);
 205         $cnt = $nl->show();
 206
 207         $this->pagination($this->page > 1,
 208                           $cnt > NOTICES_PER_PAGE,
 209                           $this->page,
 210                           'showgroup',
 211                           array('nickname' => $this->group->nickname));
 212     }
 213
 214     /**
 215      * Show the group profile
 216      *
 217      * Information about the group
 218      *
 219      * @return void
 220      */
 221
 222     function showGroupProfile()
 223     {
 224         $this->elementStart('div', 'entity_profile vcard author');
 225
 226         $this->element('h2', null, _('Group profile'));
 227
 228         $this->elementStart('dl', 'entity_depiction');
 229         $this->element('dt', null, _('Avatar'));
 230         $this->elementStart('dd');
 231
 232         $logo = ($this->group->homepage_logo) ?
 233           $this->group->homepage_logo : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
 234
 235         $this->element('img', array('src' => $logo,
 236                                     'class' => 'photo avatar',
 237                                     'width' => AVATAR_PROFILE_SIZE,
 238                                     'height' => AVATAR_PROFILE_SIZE,
 239                                     'alt' => $this->group->nickname));
 240         $this->elementEnd('dd');
 241         $this->elementEnd('dl');
 242
 243         $this->elementStart('dl', 'entity_nickname');
 244         $this->element('dt', null, _('Nickname'));
 245         $this->elementStart('dd');
 246         $hasFN = ($this->group->fullname) ? 'nickname url uid' : 'fn org nickname url uid';
 247         $this->element('a', array('href' => $this->group->homeUrl(),
 248                                   'rel' => 'me', 'class' => $hasFN),
 249                             $this->group->nickname);
 250         $this->elementEnd('dd');
 251         $this->elementEnd('dl');
 252
 253         if ($this->group->fullname) {
 254             $this->elementStart('dl', 'entity_fn');
 255             $this->element('dt', null, _('Full name'));
 256             $this->elementStart('dd');
 257             $this->element('span', 'fn org', $this->group->fullname);
 258             $this->elementEnd('dd');
 259             $this->elementEnd('dl');
 260         }
 261
 262         if ($this->group->location) {
 263             $this->elementStart('dl', 'entity_location');
 264             $this->element('dt', null, _('Location'));
 265             $this->element('dd', 'label', $this->group->location);
 266             $this->elementEnd('dl');
 267         }
 268
 269         if ($this->group->homepage) {
 270             $this->elementStart('dl', 'entity_url');
 271             $this->element('dt', null, _('URL'));
 272             $this->elementStart('dd');
 273             $this->element('a', array('href' => $this->group->homepage,
 274                                       'rel' => 'me', 'class' => 'url'),
 275                            $this->group->homepage);
 276             $this->elementEnd('dd');
 277             $this->elementEnd('dl');
 278         }
 279
 280         if ($this->group->description) {
 281             $this->elementStart('dl', 'entity_note');
 282             $this->element('dt', null, _('Note'));
 283             $this->element('dd', 'note', $this->group->description);
 284             $this->elementEnd('dl');
 285         }
 286
 287         if (common_config('group', 'maxaliases') > 0) {
 288             $aliases = $this->group->getAliases();
 289
 290             if (!empty($aliases)) {
 291                 $this->elementStart('dl', 'entity_aliases');
 292                 $this->element('dt', null, _('Aliases'));
 293                 $this->element('dd', 'aliases', implode(' ', $aliases));
 294                 $this->elementEnd('dl');
 295             }
 296         }
 297
 298         $this->elementEnd('div');
 299
 300         $this->elementStart('div', 'entity_actions');
 301         $this->element('h2', null, _('Group actions'));
 302         $this->elementStart('ul');
 303         $this->elementStart('li', 'entity_subscribe');
 304         if (Event::handle('StartGroupSubscribe', array($this, $this->group))) {
 305             $cur = common_current_user();
 306             if ($cur) {
 307                 if ($cur->isMember($this->group)) {
 308                     $lf = new LeaveForm($this, $this->group);
 309                     $lf->show();
 310                 } else if (!Group_block::isBlocked($this->group, $cur->getProfile())) {
 311                     $jf = new JoinForm($this, $this->group);
 312                     $jf->show();
 313                 }
 314             }
 315             Event::handle('EndGroupSubscribe', array($this, $this->group));
 316         }
 317         $this->elementEnd('li');
 318         $this->elementEnd('ul');
 319         $this->elementEnd('div');
 320     }
 321
 322     /**
 323      * Get a list of the feeds for this page
 324      *
 325      * @return void
 326      */
 327
 328     function getFeeds()
 329     {
 330         $url =
 331           common_local_url('grouprss',
 332                            array('nickname' => $this->group->nickname));
 333
 334         return array(new Feed(Feed::RSS1,
 335                               common_local_url('grouprss',
 336                                                array('nickname' => $this->group->nickname)),
 337                               sprintf(_('Notice feed for %s group (RSS 1.0)'),
 338                                       $this->group->nickname)),
 339                      new Feed(Feed::RSS2,
 340                               common_local_url('ApiTimelineGroup',
 341                                                array('format' => 'rss',
 342                                                      'id' => $this->group->id)),
 343                               sprintf(_('Notice feed for %s group (RSS 2.0)'),
 344                                       $this->group->nickname)),
 345                      new Feed(Feed::ATOM,
 346                               common_local_url('ApiTimelineGroup',
 347                                                array('format' => 'atom',
 348                                                      'id' => $this->group->id)),
 349                               sprintf(_('Notice feed for %s group (Atom)'),
 350                                       $this->group->nickname)),
 351                      new Feed(Feed::FOAF,
 352                               common_local_url('foafgroup',
 353                                                array('nickname' => $this->group->nickname)),
 354                               sprintf(_('FOAF for %s group'),
 355                                        $this->group->nickname)));
 356     }
 357
 358     /**
 359      * Fill in the sidebar.
 360      *
 361      * @return void
 362      */
 363
 364     function showSections()
 365     {
 366         $this->showMembers();
 367         $this->showStatistics();
 368         $this->showAdmins();
 369         $cloud = new GroupTagCloudSection($this, $this->group);
 370         $cloud->show();
 371     }
 372
 373     /**
 374      * Show mini-list of members
 375      *
 376      * @return void
 377      */
 378
 379     function showMembers()
 380     {
 381         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
 382
 383         if (!$member) {
 384             return;
 385         }
 386
 387         $this->elementStart('div', array('id' => 'entity_members',
 388                                          'class' => 'section'));
 389
 390         $this->element('h2', null, _('Members'));
 391
 392         $pml = new ProfileMiniList($member, $this);
 393         $cnt = $pml->show();
 394         if ($cnt == 0) {
 395              $this->element('p', null, _('(None)'));
 396         }
 397
 398         if ($cnt > MEMBERS_PER_SECTION) {
 399             $this->element('a', array('href' => common_local_url('groupmembers',
 400                                                                  array('nickname' => $this->group->nickname))),
 401                            _('All members'));
 402         }
 403
 404         $this->elementEnd('div');
 405     }
 406
 407     /**
 408      * Show list of admins
 409      *
 410      * @return void
 411      */
 412
 413     function showAdmins()
 414     {
 415         $adminSection = new GroupAdminSection($this, $this->group);
 416         $adminSection->show();
 417     }
 418
 419     /**
 420      * Show some statistics
 421      *
 422      * @return void
 423      */
 424
 425     function showStatistics()
 426     {
 427         // XXX: WORM cache this
 428         $members = $this->group->getMembers();
 429         $members_count = 0;
 430         /** $member->count() doesn't work. */
 431         while ($members->fetch()) {
 432             $members_count++;
 433         }
 434
 435         $this->elementStart('div', array('id' => 'entity_statistics',
 436                                          'class' => 'section'));
 437
 438         $this->element('h2', null, _('Statistics'));
 439
 440         $this->elementStart('dl', 'entity_created');
 441         $this->element('dt', null, _('Created'));
 442         $this->element('dd', null, date('j M Y',
 443                                                  strtotime($this->group->created)));
 444         $this->elementEnd('dl');
 445
 446         $this->elementStart('dl', 'entity_members');
 447         $this->element('dt', null, _('Members'));
 448         $this->element('dd', null, (is_int($members_count)) ? $members_count : '0');
 449         $this->elementEnd('dl');
 450
 451         $this->elementEnd('div');
 452     }
 453
 454     function showAnonymousMessage()
 455     {
 456         if (!(common_config('site','closed') || common_config('site','inviteonly'))) {
 457             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 458                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
 459                 'short messages about their life and interests. '.
 460                 '[Join now](%%%%action.register%%%%) to become part of this group and many more! ([Read more](%%%%doc.help%%%%))'),
 461                      $this->group->nickname);
 462         } else {
 463             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 464                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
 465                 'short messages about their life and interests. '),
 466                      $this->group->nickname);
 467         }
 468         $this->elementStart('div', array('id' => 'anon_notice'));
 469         $this->raw(common_markup_to_html($m));
 470         $this->elementEnd('div');
 471     }
 472 }
 473
 474 class GroupAdminSection extends ProfileSection
 475 {
 476     var $group;
 477
 478     function __construct($out, $group)
 479     {
 480         parent::__construct($out);
 481         $this->group = $group;
 482     }
 483
 484     function getProfiles()
 485     {
 486         return $this->group->getAdmins();
 487     }
 488
 489     function title()
 490     {
 491         return _('Admins');
 492     }
 493
 494     function divId()
 495     {
 496         return 'group_admins';
 497     }
 498
 499     function moreUrl()
 500     {
 501         return null;
 502     }
 503 }