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