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 class ShowgroupAction extends GroupDesignAction
  50 {
  51     /** page we're viewing. */
  52     var $page = null;
  53
  54     /**
  55      * Is this page read-only?
  56      *
  57      * @return boolean true
  58      */
  59     function isReadOnly($args)
  60     {
  61         return true;
  62     }
  63
  64     /**
  65      * Title of the page
  66      *
  67      * @return string page title, with page number
  68      */
  69     function title()
  70     {
  71         $base = $this->group->getFancyName();
  72
  73         if ($this->page == 1) {
  74             // TRANS: Page title for first group page. %s is a group name.
  75             return sprintf(_('%s group'), $base);
  76         } else {
  77             // TRANS: Page title for any but first group page.
  78             // TRANS: %1$s is a group name, $2$s is a page number.
  79             return sprintf(_('%1$s group, page %2$d'),
  80                            $base,
  81                            $this->page);
  82         }
  83     }
  84
  85     /**
  86      * Prepare the action
  87      *
  88      * Reads and validates arguments and instantiates the attributes.
  89      *
  90      * @param array $args $_REQUEST args
  91      *
  92      * @return boolean success flag
  93      */
  94     function prepare($args)
  95     {
  96         parent::prepare($args);
  97
  98         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  99
 100         $nickname_arg = $this->arg('nickname');
 101         $nickname = common_canonical_nickname($nickname_arg);
 102
 103         // Permanent redirect on non-canonical nickname
 104
 105         if ($nickname_arg != $nickname) {
 106             $args = array('nickname' => $nickname);
 107             if ($this->page != 1) {
 108                 $args['page'] = $this->page;
 109             }
 110             common_redirect(common_local_url('showgroup', $args), 301);
 111             return false;
 112         }
 113
 114         if (!$nickname) {
 115             // TRANS: Client error displayed if no nickname argument was given requesting a group page.
 116             $this->clientError(_('No nickname.'), 404);
 117             return false;
 118         }
 119
 120         $local = Local_group::staticGet('nickname', $nickname);
 121
 122         if (!$local) {
 123             $alias = Group_alias::staticGet('alias', $nickname);
 124             if ($alias) {
 125                 $args = array('id' => $alias->group_id);
 126                 if ($this->page != 1) {
 127                     $args['page'] = $this->page;
 128                 }
 129                 common_redirect(common_local_url('groupbyid', $args), 301);
 130                 return false;
 131             } else {
 132                 common_log(LOG_NOTICE, "Couldn't find local group for nickname '$nickname'");
 133                 // TRANS: Client error displayed if no remote group with a given name was found requesting group page.
 134                 $this->clientError(_('No such group.'), 404);
 135                 return false;
 136             }
 137         }
 138
 139         $this->group = User_group::staticGet('id', $local->group_id);
 140
 141         if (!$this->group) {
 142                 // TRANS: Client error displayed if no local group with a given name was found requesting group page.
 143             $this->clientError(_('No such group.'), 404);
 144             return false;
 145         }
 146
 147         common_set_returnto($this->selfUrl());
 148
 149         return true;
 150     }
 151
 152     /**
 153      * Handle the request
 154      *
 155      * Shows a profile for the group, some controls, and a list of
 156      * group notices.
 157      *
 158      * @return void
 159      */
 160     function handle($args)
 161     {
 162         $this->showPage();
 163     }
 164
 165     /**
 166      * Local menu
 167      *
 168      * @return void
 169      */
 170     function showLocalNav()
 171     {
 172         $nav = new GroupNav($this, $this->group);
 173         $nav->show();
 174     }
 175
 176     /**
 177      * Show the page content
 178      *
 179      * Shows a group profile and a list of group notices
 180      */
 181     function showContent()
 182     {
 183         $this->showGroupProfile();
 184         $this->showGroupNotices();
 185     }
 186
 187     /**
 188      * Show the group notices
 189      *
 190      * @return void
 191      */
 192     function showGroupNotices()
 193     {
 194         $notice = $this->group->getNotices(($this->page-1)*NOTICES_PER_PAGE,
 195                                            NOTICES_PER_PAGE + 1);
 196
 197         $nl = new NoticeList($notice, $this);
 198         $cnt = $nl->show();
 199
 200         $this->pagination($this->page > 1,
 201                           $cnt > NOTICES_PER_PAGE,
 202                           $this->page,
 203                           'showgroup',
 204                           array('nickname' => $this->group->nickname));
 205     }
 206
 207     /**
 208      * Show the group profile
 209      *
 210      * Information about the group
 211      *
 212      * @return void
 213      */
 214     function showGroupProfile()
 215     {
 216         $this->elementStart('div', array('id' => 'i',
 217                                          'class' => 'entity_profile vcard author'));
 218
 219         // TRANS: Group profile header (h2). Text hidden by default.
 220         $this->element('h2', null, _('Group profile'));
 221
 222         $this->elementStart('dl', 'entity_depiction');
 223         // TRANS: Label for group avatar (dt). Text hidden by default.
 224         $this->element('dt', null, _('Avatar'));
 225         $this->elementStart('dd');
 226
 227         $logo = ($this->group->homepage_logo) ?
 228           $this->group->homepage_logo : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
 229
 230         $this->element('img', array('src' => $logo,
 231                                     'class' => 'photo avatar',
 232                                     'width' => AVATAR_PROFILE_SIZE,
 233                                     'height' => AVATAR_PROFILE_SIZE,
 234                                     'alt' => $this->group->nickname));
 235         $this->elementEnd('dd');
 236         $this->elementEnd('dl');
 237
 238         $this->elementStart('dl', 'entity_nickname');
 239         // TRANS: Label for group nickname (dt). Text hidden by default.
 240         $this->element('dt', null, _('Nickname'));
 241         $this->elementStart('dd');
 242         $hasFN = ($this->group->fullname) ? 'nickname url uid' : 'fn org nickname url uid';
 243         $this->element('a', array('href' => $this->group->homeUrl(),
 244                                   'rel' => 'me', 'class' => $hasFN),
 245                             $this->group->nickname);
 246         $this->elementEnd('dd');
 247         $this->elementEnd('dl');
 248
 249         if ($this->group->fullname) {
 250             $this->elementStart('dl', 'entity_fn');
 251             // TRANS: Label for full group name (dt). Text hidden by default.
 252             $this->element('dt', null, _('Full name'));
 253             $this->elementStart('dd');
 254             $this->element('span', 'fn org', $this->group->fullname);
 255             $this->elementEnd('dd');
 256             $this->elementEnd('dl');
 257         }
 258
 259         if ($this->group->location) {
 260             $this->elementStart('dl', 'entity_location');
 261             // TRANS: Label for group location (dt). Text hidden by default.
 262             $this->element('dt', null, _('Location'));
 263             $this->element('dd', 'label', $this->group->location);
 264             $this->elementEnd('dl');
 265         }
 266
 267         if ($this->group->homepage) {
 268             $this->elementStart('dl', 'entity_url');
 269             // TRANS: Label for group URL (dt). Text hidden by default.
 270             $this->element('dt', null, _('URL'));
 271             $this->elementStart('dd');
 272             $this->element('a', array('href' => $this->group->homepage,
 273                                       'rel' => 'me', 'class' => 'url'),
 274                            $this->group->homepage);
 275             $this->elementEnd('dd');
 276             $this->elementEnd('dl');
 277         }
 278
 279         if ($this->group->description) {
 280             $this->elementStart('dl', 'entity_note');
 281             // TRANS: Label for group description or group note (dt). Text hidden by default.
 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                 // TRANS: Label for group aliases (dt). Text hidden by default.
 293                 $this->element('dt', null, _('Aliases'));
 294                 $this->element('dd', 'aliases', implode(' ', $aliases));
 295                 $this->elementEnd('dl');
 296             }
 297         }
 298
 299         $this->elementEnd('div');
 300
 301         $cur = common_current_user();
 302         $this->elementStart('div', 'entity_actions');
 303         // TRANS: Group actions header (h2). Text hidden by default.
 304         $this->element('h2', null, _('Group actions'));
 305         $this->elementStart('ul');
 306         if (Event::handle('StartGroupActionsList', array($this, $this->group))) {
 307             $this->elementStart('li', 'entity_subscribe');
 308             if (Event::handle('StartGroupSubscribe', array($this, $this->group))) {
 309                 if ($cur) {
 310                     if ($cur->isMember($this->group)) {
 311                         $lf = new LeaveForm($this, $this->group);
 312                         $lf->show();
 313                     } else if (!Group_block::isBlocked($this->group, $cur->getProfile())) {
 314                         $jf = new JoinForm($this, $this->group);
 315                         $jf->show();
 316                     }
 317                 }
 318                 Event::handle('EndGroupSubscribe', array($this, $this->group));
 319             }
 320             $this->elementEnd('li');
 321             if ($cur && $cur->hasRight(Right::DELETEGROUP)) {
 322                 $this->elementStart('li', 'entity_delete');
 323                 $df = new DeleteGroupForm($this, $this->group);
 324                 $df->show();
 325                 $this->elementEnd('li');
 326             }
 327             Event::handle('EndGroupActionsList', array($this, $this->group));
 328         }
 329         $this->elementEnd('ul');
 330         $this->elementEnd('div');
 331     }
 332
 333     /**
 334      * Get a list of the feeds for this page
 335      *
 336      * @return void
 337      */
 338     function getFeeds()
 339     {
 340         $url =
 341           common_local_url('grouprss',
 342                            array('nickname' => $this->group->nickname));
 343
 344         return array(new Feed(Feed::RSS1,
 345                               common_local_url('grouprss',
 346                                                array('nickname' => $this->group->nickname)),
 347                               // TRANS: Tooltip for feed link. %s is a group nickname.
 348                               sprintf(_('Notice feed for %s group (RSS 1.0)'),
 349                                       $this->group->nickname)),
 350                      new Feed(Feed::RSS2,
 351                               common_local_url('ApiTimelineGroup',
 352                                                array('format' => 'rss',
 353                                                      'id' => $this->group->id)),
 354                               // TRANS: Tooltip for feed link. %s is a group nickname.
 355                               sprintf(_('Notice feed for %s group (RSS 2.0)'),
 356                                       $this->group->nickname)),
 357                      new Feed(Feed::ATOM,
 358                               common_local_url('ApiTimelineGroup',
 359                                                array('format' => 'atom',
 360                                                      'id' => $this->group->id)),
 361                               // TRANS: Tooltip for feed link. %s is a group nickname.
 362                               sprintf(_('Notice feed for %s group (Atom)'),
 363                                       $this->group->nickname)),
 364                      new Feed(Feed::FOAF,
 365                               common_local_url('foafgroup',
 366                                                array('nickname' => $this->group->nickname)),
 367                               // TRANS: Tooltip for feed link. %s is a group nickname.
 368                               sprintf(_('FOAF for %s group'),
 369                                        $this->group->nickname)));
 370     }
 371
 372     /**
 373      * Fill in the sidebar.
 374      *
 375      * @return void
 376      */
 377     function showSections()
 378     {
 379         $this->showMembers();
 380         $this->showStatistics();
 381         $this->showAdmins();
 382         $cloud = new GroupTagCloudSection($this, $this->group);
 383         $cloud->show();
 384     }
 385
 386     /**
 387      * Show mini-list of members
 388      *
 389      * @return void
 390      */
 391     function showMembers()
 392     {
 393         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
 394
 395         if (!$member) {
 396             return;
 397         }
 398
 399         $this->elementStart('div', array('id' => 'entity_members',
 400                                          'class' => 'section'));
 401
 402         if (Event::handle('StartShowGroupMembersMiniList', array($this))) {
 403
 404             // TRANS: Header for mini list of group members on a group page (h2).
 405             $this->element('h2', null, _('Members'));
 406
 407             $gmml = new GroupMembersMiniList($member, $this);
 408             $cnt = $gmml->show();
 409             if ($cnt == 0) {
 410                 // TRANS: Description for mini list of group members on a group page when the group has no members.
 411                 $this->element('p', null, _('(None)'));
 412             }
 413
 414             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
 415             //              for example http://identi.ca/group/statusnet. Broken?
 416             if ($cnt > MEMBERS_PER_SECTION) {
 417                 $this->element('a', array('href' => common_local_url('groupmembers',
 418                                                                      array('nickname' => $this->group->nickname))),
 419                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
 420                                _('All members'));
 421             }
 422
 423             Event::handle('EndShowGroupMembersMiniList', array($this));
 424         }
 425
 426         $this->elementEnd('div');
 427     }
 428
 429     /**
 430      * Show list of admins
 431      *
 432      * @return void
 433      */
 434     function showAdmins()
 435     {
 436         $adminSection = new GroupAdminSection($this, $this->group);
 437         $adminSection->show();
 438     }
 439
 440     /**
 441      * Show some statistics
 442      *
 443      * @return void
 444      */
 445     function showStatistics()
 446     {
 447         $this->elementStart('div', array('id' => 'entity_statistics',
 448                                          'class' => 'section'));
 449
 450         // TRANS: Header for group statistics on a group page (h2).
 451         $this->element('h2', null, _('Statistics'));
 452
 453         $this->elementStart('dl', 'entity_created');
 454         // @todo FIXME: i18n issue. This label gets a colon added from somewhere. Should be part of the message.
 455         // TRANS: Label for creation date in statistics on group page.
 456         $this->element('dt', null, _m('LABEL','Created'));
 457         $this->element('dd', null, date('j M Y',
 458                                                  strtotime($this->group->created)));
 459         $this->elementEnd('dl');
 460
 461         $this->elementStart('dl', 'entity_members');
 462         // @todo FIXME: i18n issue. This label gets a colon added from somewhere. Should be part of the message.
 463         // TRANS: Label for member count in statistics on group page.
 464         $this->element('dt', null, _m('LABEL','Members'));
 465         $this->element('dd', null, $this->group->getMemberCount());
 466         $this->elementEnd('dl');
 467
 468         $this->elementEnd('div');
 469     }
 470
 471     function showAnonymousMessage()
 472     {
 473         if (!(common_config('site','closed') || common_config('site','inviteonly'))) {
 474             // @todo FIXME: use group full name here if available instead of (uglier) primary alias.
 475             // TRANS: Notice on group pages for anonymous users for StatusNet sites that accept new registrations.
 476             // TRANS: **%s** is the group alias, %%%%site.name%%%% is the site name,
 477             // TRANS: %%%%action.register%%%% is the URL for registration, %%%%doc.help%%%% is a URL to help.
 478             // TRANS: This message contains Markdown links. Ensure they are formatted correctly: [Description](link).
 479             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 480                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
 481                 'short messages about their life and interests. '.
 482                 '[Join now](%%%%action.register%%%%) to become part of this group and many more! ([Read more](%%%%doc.help%%%%))'),
 483                      $this->group->nickname);
 484         } else {
 485             // @todo FIXME: use group full name here if available instead of (uglier) primary alias.
 486             // TRANS: Notice on group pages for anonymous users for StatusNet sites that accept no new registrations.
 487             // TRANS: **%s** is the group alias, %%%%site.name%%%% is the site name,
 488             // TRANS: This message contains Markdown links. Ensure they are formatted correctly: [Description](link).
 489             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 490                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
 491                 'short messages about their life and interests. '),
 492                      $this->group->nickname);
 493         }
 494         $this->elementStart('div', array('id' => 'anon_notice'));
 495         $this->raw(common_markup_to_html($m));
 496         $this->elementEnd('div');
 497     }
 498 }
 499
 500 class GroupAdminSection extends ProfileSection
 501 {
 502     var $group;
 503
 504     function __construct($out, $group)
 505     {
 506         parent::__construct($out);
 507         $this->group = $group;
 508     }
 509
 510     function getProfiles()
 511     {
 512         return $this->group->getAdmins();
 513     }
 514
 515     function title()
 516     {
 517         // TRANS: Header for list of group administrators on a group page (h2).
 518         return _('Admins');
 519     }
 520
 521     function divId()
 522     {
 523         return 'group_admins';
 524     }
 525
 526     function moreUrl()
 527     {
 528         return null;
 529     }
 530 }
 531
 532 class GroupMembersMiniList extends ProfileMiniList
 533 {
 534     function newListItem($profile)
 535     {
 536         return new GroupMembersMiniListItem($profile, $this->action);
 537     }
 538 }
 539
 540 class GroupMembersMiniListItem extends ProfileMiniListItem
 541 {
 542     function linkAttributes()
 543     {
 544         $aAttrs = parent::linkAttributes();
 545
 546         if (common_config('nofollow', 'members')) {
 547             $aAttrs['rel'] .= ' nofollow';
 548         }
 549
 550         return $aAttrs;
 551     }
 552 }