plugins/Bookmark/actions/noticebyurl.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Notice stream of notices with a given attachment
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Bookmark
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * List notices that contain/link to/use a given URL
  39  *
  40  * @category  Bookmark
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2010 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class NoticebyurlAction extends Action
  48 {
  49     protected $url     = null;
  50     protected $file    = null;
  51     protected $notices = null;
  52     protected $page    = null;
  53
  54     /**
  55      * For initializing members of the class.
  56      *
  57      * @param array $args misc. arguments
  58      *
  59      * @return boolean true
  60      * @throws ClientException
  61      */
  62     function prepare(array $args = [])
  63     {
  64         parent::prepare($args);
  65
  66         $this->file = File::getKV('id', $this->trimmed('id'));
  67
  68         if (empty($this->file)) {
  69             // TRANS: Client exception thrown when an unknown URL is provided.
  70             throw new ClientException(_m('Unknown URL.'));
  71         }
  72
  73         $pageArg = $this->trimmed('page');
  74
  75         $this->page = (empty($pageArg)) ? 1 : intval($pageArg);
  76
  77         $this->notices = $this->file->stream(($this->page - 1) * NOTICES_PER_PAGE,
  78                                              NOTICES_PER_PAGE + 1);
  79
  80         return true;
  81     }
  82
  83     /**
  84      * Title of the page
  85      *
  86      * @return string page title
  87      */
  88     function title()
  89     {
  90         if ($this->page == 1) {
  91             // TRANS: Title of notice stream of notices with a given attachment (first page).
  92             // TRANS: %s is the URL.
  93             return sprintf(_m('Notices linking to %s'), $this->file->url);
  94         } else {
  95             // TRANS: Title of notice stream of notices with a given attachment (all but first page).
  96             // TRANS: %1$s is the URL, %2$s is the page number.
  97             return sprintf(_m('Notices linking to %1$s, page %2$d'),
  98                            $this->file->url,
  99                            $this->page);
 100         }
 101     }
 102
 103     /**
 104      * Handler method
 105      *
 106      * @return void
 107      */
 108     function handle()
 109     {
 110         $this->showPage();
 111     }
 112
 113     /**
 114      * Show main page content.
 115      *
 116      * Shows a list of the notices that link to the given URL
 117      *
 118      * @return void
 119      */
 120     function showContent()
 121     {
 122         $nl = new NoticeList($this->notices, $this);
 123
 124         $nl->show();
 125
 126         $cnt = $nl->show();
 127
 128         $this->pagination($this->page > 1,
 129                           $cnt > NOTICES_PER_PAGE,
 130                           $this->page,
 131                           'noticebyurl',
 132                           array('id' => $this->file->id));
 133     }
 134
 135     /**
 136      * Return true if read only.
 137      *
 138      * MAY override
 139      *
 140      * @param array $args other arguments
 141      *
 142      * @return boolean is read only action?
 143      */
 144     function isReadOnly($args)
 145     {
 146         return true;
 147     }
 148
 149     /**
 150      * Return last modified, if applicable.
 151      *
 152      * MAY override
 153      *
 154      * @return string last modified http header
 155      */
 156     function lastModified()
 157     {
 158         // For comparison with If-Last-Modified
 159         // If not applicable, return null
 160         return null;
 161     }
 162
 163     /**
 164      * Return etag, if applicable.
 165      *
 166      * MAY override
 167      *
 168      * @return string etag http header
 169      */
 170     function etag()
 171     {
 172         return null;
 173     }
 174 }