plugins/Realtime/actions/keepalivechannel.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * action periodically pinged by a page to keep a channel alive
   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  Realtime
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 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  * Action periodically pinged by a page to keep a channel alive
  39  *
  40  * @category  Realtime
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 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 KeepalivechannelAction extends Action
  48 {
  49     protected $channelKey = null;
  50     protected $channel    = null;
  51
  52     /**
  53      * For initializing members of the class.
  54      *
  55      * @param array $argarray misc. arguments
  56      *
  57      * @return boolean true
  58      */
  59     function prepare($argarray)
  60     {
  61         parent::prepare($argarray);
  62
  63         if (!$this->isPost()) {
  64             // TRANS: Client exception. Do not translate POST.
  65             throw new ClientException(_m('You have to POST it.'));
  66         }
  67
  68         $this->channelKey = $this->trimmed('channelkey');
  69
  70         if (empty($this->channelKey)) {
  71             // TRANS: Client exception thrown when the channel key argument is missing.
  72             throw new ClientException(_m('No channel key argument.'));
  73         }
  74
  75         $this->channel = Realtime_channel::getKV('channel_key', $this->channelKey);
  76
  77         if (empty($this->channel)) {
  78             // TRANS: Client exception thrown when referring to a non-existing channel.
  79             throw new ClientException(_m('No such channel.'));
  80         }
  81
  82         return true;
  83     }
  84
  85     /**
  86      * Handler method
  87      *
  88      * @param array $argarray is ignored since it's now passed in in prepare()
  89      *
  90      * @return void
  91      */
  92     function handle($argarray=null)
  93     {
  94         $this->channel->touch();
  95
  96         header('HTTP/1.1 204 No Content');
  97
  98         return;
  99     }
 100
 101     /**
 102      * Return true if read only.
 103      *
 104      * MAY override
 105      *
 106      * @param array $args other arguments
 107      * @return boolean is read only action?
 108      */
 109     function isReadOnly(array $args=array())
 110     {
 111         return false;
 112     }
 113 }