actions/tag.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('GNUSOCIAL')) { exit(1); }
  21
  22 // @todo FIXME: documentation missing.
  23 class TagAction extends ManagedAction
  24 {
  25     var $notice;
  26     var $tag;
  27     var $page;
  28
  29     protected function prepare(array $args=array())
  30     {
  31         parent::prepare($args);
  32
  33         $taginput = $this->trimmed('tag');
  34         $this->tag = common_canonical_tag($taginput);
  35
  36         if (empty($this->tag)) {
  37             common_redirect(common_local_url('publictagcloud'), 301);
  38         }
  39
  40         // after common_canonical_tag we have a lowercase, no-specials tag string
  41         if ($this->tag !== $taginput) {
  42             common_redirect(common_local_url('tag', array('tag' => $this->tag)), 301);
  43         }
  44
  45         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  46
  47         common_set_returnto($this->selfUrl());
  48
  49         $this->notice = Notice_tag::getStream($this->tag)->getNotices(($this->page-1)*NOTICES_PER_PAGE,
  50                                                                        NOTICES_PER_PAGE + 1);
  51
  52         if($this->page > 1 && $this->notice->N == 0){
  53             // TRANS: Client error when page not found (404).
  54             $this->clientError(_('No such page.'), 404);
  55         }
  56
  57         return true;
  58     }
  59
  60     function title()
  61     {
  62         if ($this->page == 1) {
  63             // TRANS: Title for first page of notices with tags.
  64             // TRANS: %s is the tag.
  65             return sprintf(_('Notices tagged with %s'), $this->tag);
  66         } else {
  67             // TRANS: Title for all but the first page of notices with tags.
  68             // TRANS: %1$s is the tag, %2$d is the page number.
  69             return sprintf(_('Notices tagged with %1$s, page %2$d'),
  70                            $this->tag,
  71                            $this->page);
  72         }
  73     }
  74
  75     function getFeeds()
  76     {
  77         return array(new Feed(Feed::JSON,
  78                               common_local_url('ApiTimelineTag',
  79                                                array('format' => 'as',
  80                                                      'tag' => $this->tag)),
  81                               // TRANS: Link label for feed on "notices with tag" page.
  82                               // TRANS: %s is the tag the feed is for.
  83                               sprintf(_('Notice feed for tag %s (Activity Streams JSON)'),
  84                                       $this->tag)),
  85                      new Feed(Feed::RSS1,
  86                               common_local_url('tagrss',
  87                                                array('tag' => $this->tag)),
  88                               // TRANS: Link label for feed on "notices with tag" page.
  89                               // TRANS: %s is the tag the feed is for.
  90                               sprintf(_('Notice feed for tag %s (RSS 1.0)'),
  91                                       $this->tag)),
  92                      new Feed(Feed::RSS2,
  93                               common_local_url('ApiTimelineTag',
  94                                                array('format' => 'rss',
  95                                                      'tag' => $this->tag)),
  96                               // TRANS: Link label for feed on "notices with tag" page.
  97                               // TRANS: %s is the tag the feed is for.
  98                               sprintf(_('Notice feed for tag %s (RSS 2.0)'),
  99                                       $this->tag)),
 100                      new Feed(Feed::ATOM,
 101                               common_local_url('ApiTimelineTag',
 102                                                array('format' => 'atom',
 103                                                      'tag' => $this->tag)),
 104                               // TRANS: Link label for feed on "notices with tag" page.
 105                               // TRANS: %s is the tag the feed is for.
 106                               sprintf(_('Notice feed for tag %s (Atom)'),
 107                                       $this->tag)));
 108     }
 109
 110     protected function showContent()
 111     {
 112         if(Event::handle('StartTagShowContent', array($this))) {
 113
 114             $nl = new PrimaryNoticeList($this->notice, $this, array('show_n'=>NOTICES_PER_PAGE));
 115
 116             $cnt = $nl->show();
 117
 118             $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 119                               $this->page, 'tag', array('tag' => $this->tag));
 120
 121             Event::handle('EndTagShowContent', array($this));
 122         }
 123     }
 124
 125     function isReadOnly(array $args=array())
 126     {
 127         return true;
 128     }
 129 }