actions/showgroup.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
  26  * @copyright 2008-2009 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!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', 81);
  39
  40 /**
  41  * Group main page
  42  *
  43  * @category Group
  44  * @package  Laconica
  45  * @author   Evan Prodromou <evan@controlyourself.ca>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://laconi.ca/
  48  */
  49
  50 class ShowgroupAction extends Action
  51 {
  52     /** group we're viewing. */
  53     var $group = null;
  54     /** page we're viewing. */
  55     var $page = null;
  56
  57     /**
  58      * Is this page read-only?
  59      *
  60      * @return boolean true
  61      */
  62
  63     function isReadOnly()
  64     {
  65         return true;
  66     }
  67
  68     /**
  69      * Title of the page
  70      *
  71      * @return string page title, with page number
  72      */
  73
  74     function title()
  75     {
  76         if ($this->page == 1) {
  77             return sprintf(_("%s group"), $this->group->nickname);
  78         } else {
  79             return sprintf(_("%s group, page %d"),
  80                            $this->group->nickname,
  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
  95     function prepare($args)
  96     {
  97         parent::prepare($args);
  98
  99         if (!common_config('inboxes','enabled')) {
 100             $this->serverError(_('Inboxes must be enabled for groups to work'));
 101             return false;
 102         }
 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         $this->group = User_group::staticGet('nickname', $nickname);
 126
 127         if (!$this->group) {
 128             $this->clientError(_('No such group'), 404);
 129             return false;
 130         }
 131
 132         common_set_returnto($this->selfUrl());
 133
 134         return true;
 135     }
 136
 137     /**
 138      * Handle the request
 139      *
 140      * Shows a profile for the group, some controls, and a list of
 141      * group notices.
 142      *
 143      * @return void
 144      */
 145
 146     function handle($args)
 147     {
 148         $this->showPage();
 149     }
 150
 151     /**
 152      * Local menu
 153      *
 154      * @return void
 155      */
 156
 157     function showLocalNav()
 158     {
 159         $nav = new GroupNav($this, $this->group);
 160         $nav->show();
 161     }
 162
 163     /**
 164      * Show the page content
 165      *
 166      * Shows a group profile and a list of group notices
 167      */
 168
 169     function showContent()
 170     {
 171         $this->showGroupProfile();
 172         $this->showGroupNotices();
 173     }
 174
 175     /**
 176      * Show the group notices
 177      *
 178      * @return void
 179      */
 180
 181     function showGroupNotices()
 182     {
 183         $notice = $this->group->getNotices(($this->page-1)*NOTICES_PER_PAGE,
 184                                            NOTICES_PER_PAGE + 1);
 185
 186         $nl = new NoticeList($notice, $this);
 187         $cnt = $nl->show();
 188
 189         $this->pagination($this->page > 1,
 190                           $cnt > NOTICES_PER_PAGE,
 191                           $this->page,
 192                           'showgroup',
 193                           array('nickname' => $this->group->nickname));
 194     }
 195
 196     /**
 197      * Show the group profile
 198      *
 199      * Information about the group
 200      *
 201      * @return void
 202      */
 203
 204     function showGroupProfile()
 205     {
 206         $this->elementStart('div', 'entity_profile vcard author');
 207
 208         $this->element('h2', null, _('Group profile'));
 209
 210         $this->elementStart('dl', 'entity_depiction');
 211         $this->element('dt', null, _('Avatar'));
 212         $this->elementStart('dd');
 213
 214         $logo = ($this->group->homepage_logo) ?
 215           $this->group->homepage_logo : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
 216
 217         $this->element('img', array('src' => $logo,
 218                                     'class' => 'photo avatar',
 219                                     'width' => AVATAR_PROFILE_SIZE,
 220                                     'height' => AVATAR_PROFILE_SIZE,
 221                                     'alt' => $this->group->nickname));
 222         $this->elementEnd('dd');
 223         $this->elementEnd('dl');
 224
 225         $this->elementStart('dl', 'entity_nickname');
 226         $this->element('dt', null, _('Nickname'));
 227         $this->elementStart('dd');
 228         $hasFN = ($this->group->fullname) ? 'nickname url uid' : 'fn org nickname url uid';
 229         $this->element('a', array('href' => $this->group->homeUrl(),
 230                                   'rel' => 'me', 'class' => $hasFN),
 231                             $this->group->nickname);
 232         $this->elementEnd('dd');
 233         $this->elementEnd('dl');
 234
 235         if ($this->group->fullname) {
 236             $this->elementStart('dl', 'entity_fn');
 237             $this->element('dt', null, _('Full name'));
 238             $this->elementStart('dd');
 239             $this->element('span', 'fn org', $this->group->fullname);
 240             $this->elementEnd('dd');
 241             $this->elementEnd('dl');
 242         }
 243
 244         if ($this->group->location) {
 245             $this->elementStart('dl', 'entity_location');
 246             $this->element('dt', null, _('Location'));
 247             $this->element('dd', 'label', $this->group->location);
 248             $this->elementEnd('dl');
 249         }
 250
 251         if ($this->group->homepage) {
 252             $this->elementStart('dl', 'entity_url');
 253             $this->element('dt', null, _('URL'));
 254             $this->elementStart('dd');
 255             $this->element('a', array('href' => $this->group->homepage,
 256                                       'rel' => 'me', 'class' => 'url'),
 257                            $this->group->homepage);
 258             $this->elementEnd('dd');
 259             $this->elementEnd('dl');
 260         }
 261
 262         if ($this->group->description) {
 263             $this->elementStart('dl', 'entity_note');
 264             $this->element('dt', null, _('Note'));
 265             $this->element('dd', 'note', $this->group->description);
 266             $this->elementEnd('dl');
 267         }
 268
 269         $this->elementEnd('div');
 270
 271         $this->elementStart('div', 'entity_actions');
 272         $this->element('h2', null, _('Group actions'));
 273         $this->elementStart('ul');
 274         $this->elementStart('li', 'entity_subscribe');
 275         $cur = common_current_user();
 276         if ($cur) {
 277             if ($cur->isMember($this->group)) {
 278                 $lf = new LeaveForm($this, $this->group);
 279                 $lf->show();
 280             } else {
 281                 $jf = new JoinForm($this, $this->group);
 282                 $jf->show();
 283             }
 284         }
 285
 286         $this->elementEnd('li');
 287
 288         $this->elementEnd('ul');
 289         $this->elementEnd('div');
 290     }
 291
 292     /**
 293      * Get a list of the feeds for this page
 294      *
 295      * @return void
 296      */
 297
 298     function getFeeds()
 299     {
 300         $url =
 301           common_local_url('grouprss',
 302                            array('nickname' => $this->group->nickname));
 303
 304         return array(new Feed(Feed::RSS1, $url, sprintf(_('Notice feed for %s group'),
 305                                                         $this->group->nickname)));
 306     }
 307
 308     /**
 309      * Fill in the sidebar.
 310      *
 311      * @return void
 312      */
 313
 314     function showSections()
 315     {
 316         $this->showMembers();
 317         $this->showStatistics();
 318         $cloud = new GroupTagCloudSection($this, $this->group);
 319         $cloud->show();
 320     }
 321
 322     /**
 323      * Show mini-list of members
 324      *
 325      * @return void
 326      */
 327
 328     function showMembers()
 329     {
 330         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
 331
 332         if (!$member) {
 333             return;
 334         }
 335
 336         $this->elementStart('div', array('id' => 'entity_members',
 337                                          'class' => 'section'));
 338
 339         $this->element('h2', null, _('Members'));
 340
 341         $pml = new ProfileMiniList($member, null, $this);
 342         $cnt = $pml->show();
 343         if ($cnt == 0) {
 344              $this->element('p', null, _('(None)'));
 345         }
 346
 347         if ($cnt == MEMBERS_PER_SECTION) {
 348             $this->element('a', array('href' => common_local_url('groupmembers',
 349                                                                  array('nickname' => $this->group->nickname))),
 350                            _('All members'));
 351         }
 352
 353         $this->elementEnd('div');
 354     }
 355
 356     /**
 357      * Show some statistics
 358      *
 359      * @return void
 360      */
 361
 362     function showStatistics()
 363     {
 364         // XXX: WORM cache this
 365         $members = $this->group->getMembers();
 366         $members_count = 0;
 367         /** $member->count() doesn't work. */
 368         while ($members->fetch()) {
 369             $members_count++;
 370         }
 371
 372         $this->elementStart('div', array('id' => 'entity_statistics',
 373                                          'class' => 'section'));
 374
 375         $this->element('h2', null, _('Statistics'));
 376
 377         $this->elementStart('dl', 'entity_created');
 378         $this->element('dt', null, _('Created'));
 379         $this->element('dd', null, date('j M Y',
 380                                                  strtotime($this->group->created)));
 381         $this->elementEnd('dl');
 382
 383         $this->elementStart('dl', 'entity_members');
 384         $this->element('dt', null, _('Members'));
 385         $this->element('dd', null, (is_int($members_count)) ? $members_count : '0');
 386         $this->elementEnd('dl');
 387
 388         $this->elementEnd('div');
 389     }
 390
 391     function showAnonymousMessage()
 392     {
 393         if (!(common_config('site','closed') || common_config('site','inviteonly'))) {
 394             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 395                 'based on the Free Software [Laconica](http://laconi.ca/) tool. Its members share ' .
 396                 'short messages about their life and interests. '.
 397                 '[Join now](%%%%action.register%%%%) to become part of this group and many more! ([Read more](%%%%doc.help%%%%))'),
 398                      $this->group->nickname);
 399         } else {
 400             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 401                 'based on the Free Software [Laconica](http://laconi.ca/) tool. Its members share ' .
 402                 'short messages about their life and interests. '),
 403                      $this->group->nickname);
 404         }
 405         $this->elementStart('div', array('id' => 'anon_notice'));
 406         $this->raw(common_markup_to_html($m));
 407         $this->elementEnd('div');
 408     }
 409 }