]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/showgroup.php
Merge branch 'master' into 0.9.x
[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 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         $this->elementStart('li', 'entity_subscribe');
307         if (Event::handle('StartGroupSubscribe', array($this, $this->group))) {
308             if ($cur) {
309                 if ($cur->isMember($this->group)) {
310                     $lf = new LeaveForm($this, $this->group);
311                     $lf->show();
312                 } else if (!Group_block::isBlocked($this->group, $cur->getProfile())) {
313                     $jf = new JoinForm($this, $this->group);
314                     $jf->show();
315                 }
316             }
317             Event::handle('EndGroupSubscribe', array($this, $this->group));
318         }
319         $this->elementEnd('li');
320         if ($cur && $cur->hasRight(Right::DELETEGROUP)) {
321             $this->elementStart('li', 'entity_delete');
322             $df = new DeleteGroupForm($this, $this->group);
323             $df->show();
324             $this->elementEnd('li');
325         }
326         $this->elementEnd('ul');
327         $this->elementEnd('div');
328     }
329
330     /**
331      * Get a list of the feeds for this page
332      *
333      * @return void
334      */
335     function getFeeds()
336     {
337         $url =
338           common_local_url('grouprss',
339                            array('nickname' => $this->group->nickname));
340
341         return array(new Feed(Feed::RSS1,
342                               common_local_url('grouprss',
343                                                array('nickname' => $this->group->nickname)),
344                               // TRANS: Tooltip for feed link. %s is a group nickname.
345                               sprintf(_('Notice feed for %s group (RSS 1.0)'),
346                                       $this->group->nickname)),
347                      new Feed(Feed::RSS2,
348                               common_local_url('ApiTimelineGroup',
349                                                array('format' => 'rss',
350                                                      'id' => $this->group->id)),
351                               // TRANS: Tooltip for feed link. %s is a group nickname.
352                               sprintf(_('Notice feed for %s group (RSS 2.0)'),
353                                       $this->group->nickname)),
354                      new Feed(Feed::ATOM,
355                               common_local_url('ApiTimelineGroup',
356                                                array('format' => 'atom',
357                                                      'id' => $this->group->id)),
358                               // TRANS: Tooltip for feed link. %s is a group nickname.
359                               sprintf(_('Notice feed for %s group (Atom)'),
360                                       $this->group->nickname)),
361                      new Feed(Feed::FOAF,
362                               common_local_url('foafgroup',
363                                                array('nickname' => $this->group->nickname)),
364                               // TRANS: Tooltip for feed link. %s is a group nickname.
365                               sprintf(_('FOAF for %s group'),
366                                        $this->group->nickname)));
367     }
368
369     /**
370      * Fill in the sidebar.
371      *
372      * @return void
373      */
374     function showSections()
375     {
376         $this->showMembers();
377         $this->showStatistics();
378         $this->showAdmins();
379         $cloud = new GroupTagCloudSection($this, $this->group);
380         $cloud->show();
381     }
382
383     /**
384      * Show mini-list of members
385      *
386      * @return void
387      */
388     function showMembers()
389     {
390         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
391
392         if (!$member) {
393             return;
394         }
395
396         $this->elementStart('div', array('id' => 'entity_members',
397                                          'class' => 'section'));
398
399         if (Event::handle('StartShowGroupMembersMiniList', array($this))) {
400
401             // TRANS: Header for mini list of group members on a group page (h2).
402             $this->element('h2', null, _('Members'));
403
404             $gmml = new GroupMembersMiniList($member, $this);
405             $cnt = $gmml->show();
406             if ($cnt == 0) {
407                 // TRANS: Description for mini list of group members on a group page when the group has no members.
408                 $this->element('p', null, _('(None)'));
409             }
410
411             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
412             //              for example http://identi.ca/group/statusnet. Broken?
413             if ($cnt > MEMBERS_PER_SECTION) {
414                 $this->element('a', array('href' => common_local_url('groupmembers',
415                                                                      array('nickname' => $this->group->nickname))),
416                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
417                                _('All members'));
418             }
419
420             Event::handle('EndShowGroupMembersMiniList', array($this));
421         }
422
423         $this->elementEnd('div');
424     }
425
426     /**
427      * Show list of admins
428      *
429      * @return void
430      */
431     function showAdmins()
432     {
433         $adminSection = new GroupAdminSection($this, $this->group);
434         $adminSection->show();
435     }
436
437     /**
438      * Show some statistics
439      *
440      * @return void
441      */
442     function showStatistics()
443     {
444         $this->elementStart('div', array('id' => 'entity_statistics',
445                                          'class' => 'section'));
446
447         // TRANS: Header for group statistics on a group page (h2).
448         $this->element('h2', null, _('Statistics'));
449
450         $this->elementStart('dl', 'entity_created');
451         // @todo FIXME: i18n issue. This label gets a colon added from somewhere. Should be part of the message.
452         // TRANS: Label for creation date in statistics on group page.
453         $this->element('dt', null, _m('LABEL','Created'));
454         $this->element('dd', null, date('j M Y',
455                                                  strtotime($this->group->created)));
456         $this->elementEnd('dl');
457
458         $this->elementStart('dl', 'entity_members');
459         // @todo FIXME: i18n issue. This label gets a colon added from somewhere. Should be part of the message.
460         // TRANS: Label for member count in statistics on group page.
461         $this->element('dt', null, _m('LABEL','Members'));
462         $this->element('dd', null, $this->group->getMemberCount());
463         $this->elementEnd('dl');
464
465         $this->elementEnd('div');
466     }
467
468     function showAnonymousMessage()
469     {
470         if (!(common_config('site','closed') || common_config('site','inviteonly'))) {
471             // @todo FIXME: use group full name here if available instead of (uglier) primary alias.
472             // TRANS: Notice on group pages for anonymous users for StatusNet sites that accept new registrations.
473             // TRANS: **%s** is the group alias, %%%%site.name%%%% is the site name,
474             // TRANS: %%%%action.register%%%% is the URL for registration, %%%%doc.help%%%% is a URL to help.
475             // TRANS: This message contains Markdown links. Ensure they are formatted correctly: [Description](link).
476             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
477                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
478                 'short messages about their life and interests. '.
479                 '[Join now](%%%%action.register%%%%) to become part of this group and many more! ([Read more](%%%%doc.help%%%%))'),
480                      $this->group->nickname);
481         } else {
482             // @todo FIXME: use group full name here if available instead of (uglier) primary alias.
483             // TRANS: Notice on group pages for anonymous users for StatusNet sites that accept no new registrations.
484             // TRANS: **%s** is the group alias, %%%%site.name%%%% is the site name,
485             // TRANS: This message contains Markdown links. Ensure they are formatted correctly: [Description](link).
486             $m = sprintf(_('**%s** is a user group on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
487                 'based on the Free Software [StatusNet](http://status.net/) tool. Its members share ' .
488                 'short messages about their life and interests. '),
489                      $this->group->nickname);
490         }
491         $this->elementStart('div', array('id' => 'anon_notice'));
492         $this->raw(common_markup_to_html($m));
493         $this->elementEnd('div');
494     }
495 }
496
497 class GroupAdminSection extends ProfileSection
498 {
499     var $group;
500
501     function __construct($out, $group)
502     {
503         parent::__construct($out);
504         $this->group = $group;
505     }
506
507     function getProfiles()
508     {
509         return $this->group->getAdmins();
510     }
511
512     function title()
513     {
514         // TRANS: Header for list of group administrators on a group page (h2).
515         return _('Admins');
516     }
517
518     function divId()
519     {
520         return 'group_admins';
521     }
522
523     function moreUrl()
524     {
525         return null;
526     }
527 }
528
529 class GroupMembersMiniList extends ProfileMiniList
530 {
531     function newListItem($profile)
532     {
533         return new GroupMembersMiniListItem($profile, $this->action);
534     }
535 }
536
537 class GroupMembersMiniListItem extends ProfileMiniListItem
538 {
539     function linkAttributes()
540     {
541         $aAttrs = parent::linkAttributes();
542
543         if (common_config('nofollow', 'members')) {
544             $aAttrs['rel'] .= ' nofollow';
545         }
546
547         return $aAttrs;
548     }
549 }