]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/showgroup.php
Give NoticeListItem its own class
[quix0rs-gnu-social.git] / 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 showObjectNav()
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->showGroupActions();
185         $this->showGroupNotices();
186     }
187
188     /**
189      * Show the group notices
190      *
191      * @return void
192      */
193     function showGroupNotices()
194     {
195         $notice = $this->group->getNotices(($this->page-1)*NOTICES_PER_PAGE,
196                                            NOTICES_PER_PAGE + 1);
197
198         $nl = new ThreadedNoticeList($notice, $this);
199         $cnt = $nl->show();
200
201         $this->pagination($this->page > 1,
202                           $cnt > NOTICES_PER_PAGE,
203                           $this->page,
204                           'showgroup',
205                           array('nickname' => $this->group->nickname));
206     }
207
208     /**
209      * Show the group profile
210      *
211      * Information about the group
212      *
213      * @return void
214      */
215     function showGroupProfile()
216     {
217         $this->elementStart('div', array('id' => 'i',
218                                          'class' => 'entity_profile vcard author'));
219
220         $logo = ($this->group->homepage_logo) ?
221           $this->group->homepage_logo : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
222
223         $this->element('img', array('src' => $logo,
224                                     'class' => 'photo avatar entity_depiction',
225                                     'width' => AVATAR_PROFILE_SIZE,
226                                     'height' => AVATAR_PROFILE_SIZE,
227                                     'alt' => $this->group->nickname));
228
229         $hasFN = ($this->group->fullname) ? 'entity_nickname nickname url uid' :
230             'entity_nickname fn org nickname url uid';
231         $this->element('a', array('href' => $this->group->homeUrl(),
232                                   'rel' => 'me', 'class' => $hasFN),
233                             $this->group->nickname);
234
235         if ($this->group->fullname) {
236             $this->element('div', 'entity_fn fn org', $this->group->fullname);
237         }
238
239         if ($this->group->location) {
240             $this->element('div', 'entity_location label', $this->group->location);
241         }
242
243         if ($this->group->homepage) {
244             $this->element('a', array('href' => $this->group->homepage,
245                                       'rel' => 'me',
246                                       'class' => 'url entity_url'),
247                            $this->group->homepage);
248         }
249
250         if ($this->group->description) {
251             $this->element('div', 'note entity_note', $this->group->description);
252         }
253
254         if (common_config('group', 'maxaliases') > 0) {
255             $aliases = $this->group->getAliases();
256
257             if (!empty($aliases)) {
258                 $this->element('div',
259                                'aliases entity_aliases',
260                                implode(' ', $aliases));
261             }
262
263             if ($this->group->description) {
264                 $this->elementStart('dl', 'entity_note');
265                 // TRANS: Label for group description or group note (dt). Text hidden by default.
266                 $this->element('dt', null, _('Note'));
267                 $this->element('dd', 'note', $this->group->description);
268                 $this->elementEnd('dl');
269             }
270
271             if (common_config('group', 'maxaliases') > 0) {
272                 $aliases = $this->group->getAliases();
273
274                 if (!empty($aliases)) {
275                     $this->elementStart('dl', 'entity_aliases');
276                     // TRANS: Label for group aliases (dt). Text hidden by default.
277                     $this->element('dt', null, _('Aliases'));
278                     $this->element('dd', 'aliases', implode(' ', $aliases));
279                     $this->elementEnd('dl');
280                 }
281             }
282
283             Event::handle('EndGroupProfileElements', array($this, $this->group));
284         }
285
286         $this->elementEnd('div');
287     }
288
289     function showGroupActions()
290     {
291         $cur = common_current_user();
292         $this->elementStart('div', 'entity_actions');
293         // TRANS: Group actions header (h2). Text hidden by default.
294         $this->element('h2', null, _('Group actions'));
295         $this->elementStart('ul');
296         if (Event::handle('StartGroupActionsList', array($this, $this->group))) {
297             $this->elementStart('li', 'entity_subscribe');
298             if (Event::handle('StartGroupSubscribe', array($this, $this->group))) {
299                 if ($cur) {
300                     if ($cur->isMember($this->group)) {
301                         $lf = new LeaveForm($this, $this->group);
302                         $lf->show();
303                     } else if (!Group_block::isBlocked($this->group, $cur->getProfile())) {
304                         $jf = new JoinForm($this, $this->group);
305                         $jf->show();
306                     }
307                 }
308                 Event::handle('EndGroupSubscribe', array($this, $this->group));
309             }
310             $this->elementEnd('li');
311             if ($cur && $cur->hasRight(Right::DELETEGROUP)) {
312                 $this->elementStart('li', 'entity_delete');
313                 $df = new DeleteGroupForm($this, $this->group);
314                 $df->show();
315                 $this->elementEnd('li');
316             }
317             Event::handle('EndGroupActionsList', array($this, $this->group));
318         }
319         $this->elementEnd('ul');
320         $this->elementEnd('div');
321     }
322
323     /**
324      * Get a list of the feeds for this page
325      *
326      * @return void
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                               // TRANS: Tooltip for feed link. %s is a group nickname.
338                               sprintf(_('Notice feed for %s group (RSS 1.0)'),
339                                       $this->group->nickname)),
340                      new Feed(Feed::RSS2,
341                               common_local_url('ApiTimelineGroup',
342                                                array('format' => 'rss',
343                                                      'id' => $this->group->id)),
344                               // TRANS: Tooltip for feed link. %s is a group nickname.
345                               sprintf(_('Notice feed for %s group (RSS 2.0)'),
346                                       $this->group->nickname)),
347                      new Feed(Feed::ATOM,
348                               common_local_url('ApiTimelineGroup',
349                                                array('format' => 'atom',
350                                                      'id' => $this->group->id)),
351                               // TRANS: Tooltip for feed link. %s is a group nickname.
352                               sprintf(_('Notice feed for %s group (Atom)'),
353                                       $this->group->nickname)),
354                      new Feed(Feed::FOAF,
355                               common_local_url('foafgroup',
356                                                array('nickname' => $this->group->nickname)),
357                               // TRANS: Tooltip for feed link. %s is a group nickname.
358                               sprintf(_('FOAF for %s group'),
359                                        $this->group->nickname)));
360     }
361
362     /**
363      * Fill in the sidebar.
364      *
365      * @return void
366      */
367     function showSections()
368     {
369         $this->showMembers();
370         $this->showStatistics();
371         $this->showAdmins();
372         $cloud = new GroupTagCloudSection($this, $this->group);
373         $cloud->show();
374     }
375
376     /**
377      * Show mini-list of members
378      *
379      * @return void
380      */
381     function showMembers()
382     {
383         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
384
385         if (!$member) {
386             return;
387         }
388
389         $this->elementStart('div', array('id' => 'entity_members',
390                                          'class' => 'section'));
391
392         if (Event::handle('StartShowGroupMembersMiniList', array($this))) {
393
394             // TRANS: Header for mini list of group members on a group page (h2).
395             $this->element('h2', null, _('Members'));
396
397             $gmml = new GroupMembersMiniList($member, $this);
398             $cnt = $gmml->show();
399             if ($cnt == 0) {
400                 // TRANS: Description for mini list of group members on a group page when the group has no members.
401                 $this->element('p', null, _('(None)'));
402             }
403
404             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
405             //              for example http://identi.ca/group/statusnet. Broken?
406             if ($cnt > MEMBERS_PER_SECTION) {
407                 $this->element('a', array('href' => common_local_url('groupmembers',
408                                                                      array('nickname' => $this->group->nickname))),
409                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
410                                _('All members'));
411             }
412
413             Event::handle('EndShowGroupMembersMiniList', array($this));
414         }
415
416         $this->elementEnd('div');
417     }
418
419     /**
420      * Show list of admins
421      *
422      * @return void
423      */
424     function showAdmins()
425     {
426         $adminSection = new GroupAdminSection($this, $this->group);
427         $adminSection->show();
428     }
429
430     /**
431      * Show some statistics
432      *
433      * @return void
434      */
435     function showStatistics()
436     {
437         $this->elementStart('div', array('id' => 'entity_statistics',
438                                          'class' => 'section'));
439
440         // TRANS: Header for group statistics on a group page (h2).
441         $this->element('h2', null, _('Statistics'));
442
443         $this->elementEnd('dl');
444         $this->element('dt', null, _m('LABEL','Created'));
445         $this->element('dd', 'entity_created', date('j M Y',
446                                                  strtotime($this->group->created)));
447         // @todo FIXME: i18n issue. This label gets a colon added from somewhere. Should be part of the message.
448         // TRANS: Label for member count in statistics on group page.
449         $this->element('dt', null, _m('LABEL','Members'));
450         $this->element('dd', null, $this->group->getMemberCount());
451         $this->elementEnd('dl');
452
453         $this->elementEnd('div');
454     }
455
456     function showAnonymousMessage()
457     {
458         if (!(common_config('site','closed') || common_config('site','inviteonly'))) {
459             // @todo FIXME: use group full name here if available instead of (uglier) primary alias.
460             // TRANS: Notice on group pages for anonymous users for StatusNet sites that accept new registrations.
461             // TRANS: **%s** is the group alias, %%%%site.name%%%% is the site name,
462             // TRANS: %%%%action.register%%%% is the URL for registration, %%%%doc.help%%%% is a URL to help.
463             // TRANS: This message contains Markdown links. Ensure they are formatted correctly: [Description](link).
464             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
465                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
466                 'short messages about their life and interests. '.
467                 '[Join now](%%%%action.register%%%%) to become part of this group and many more! ([Read more](%%%%doc.help%%%%))'),
468                      $this->group->nickname);
469         } else {
470             // @todo FIXME: use group full name here if available instead of (uglier) primary alias.
471             // TRANS: Notice on group pages for anonymous users for StatusNet sites that accept no new registrations.
472             // TRANS: **%s** is the group alias, %%%%site.name%%%% is the site name,
473             // TRANS: This message contains Markdown links. Ensure they are formatted correctly: [Description](link).
474             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
475                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
476                 'short messages about their life and interests. '),
477                      $this->group->nickname);
478         }
479         $this->elementStart('div', array('id' => 'anon_notice'));
480         $this->raw(common_markup_to_html($m));
481         $this->elementEnd('div');
482     }
483 }
484
485 class GroupAdminSection extends ProfileSection
486 {
487     var $group;
488
489     function __construct($out, $group)
490     {
491         parent::__construct($out);
492         $this->group = $group;
493     }
494
495     function getProfiles()
496     {
497         return $this->group->getAdmins();
498     }
499
500     function title()
501     {
502         // TRANS: Header for list of group administrators on a group page (h2).
503         return _('Admins');
504     }
505
506     function divId()
507     {
508         return 'group_admins';
509     }
510
511     function moreUrl()
512     {
513         return null;
514     }
515 }
516
517 class GroupMembersMiniList extends ProfileMiniList
518 {
519     function newListItem($profile)
520     {
521         return new GroupMembersMiniListItem($profile, $this->action);
522     }
523 }
524
525 class GroupMembersMiniListItem extends ProfileMiniListItem
526 {
527     function linkAttributes()
528     {
529         $aAttrs = parent::linkAttributes();
530
531         if (common_config('nofollow', 'members')) {
532             $aAttrs['rel'] .= ' nofollow';
533         }
534
535         return $aAttrs;
536     }
537 }