forked from GNUsocial/gnu-social
105 lines
2.8 KiB
PHP
105 lines
2.8 KiB
PHP
<?php
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// GNU social is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Action periodically pinged by a page to keep a channel alive
|
|
*
|
|
* @category Realtime
|
|
* @package GNUsocial
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
|
|
defined('GNUSOCIAL') || die();
|
|
|
|
/**
|
|
* Action periodically pinged by a page to keep a channel alive
|
|
*
|
|
* @category Realtime
|
|
* @package GNUsocial
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
class KeepalivechannelAction extends Action
|
|
{
|
|
protected $channelKey = null;
|
|
protected $channel = null;
|
|
|
|
/**
|
|
* For initializing members of the class.
|
|
*
|
|
* @param array $args misc. arguments
|
|
*
|
|
* @return bool true
|
|
* @throws ClientException
|
|
*/
|
|
public function prepare(array $args = []): bool
|
|
{
|
|
parent::prepare($args);
|
|
|
|
if (!$this->isPost()) {
|
|
// TRANS: Client exception. Do not translate POST.
|
|
throw new ClientException(_m('You have to POST it.'));
|
|
}
|
|
|
|
$this->channelKey = $this->trimmed('channelkey');
|
|
|
|
if (empty($this->channelKey)) {
|
|
// TRANS: Client exception thrown when the channel key argument is missing.
|
|
throw new ClientException(_m('No channel key argument.'));
|
|
}
|
|
|
|
$this->channel = Realtime_channel::getKV('channel_key', $this->channelKey);
|
|
|
|
if (empty($this->channel)) {
|
|
// TRANS: Client exception thrown when referring to a non-existing channel.
|
|
throw new ClientException(_m('No such channel.'));
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Handler method
|
|
*
|
|
* @return void
|
|
*/
|
|
public function handle(): void
|
|
{
|
|
$this->channel->touch();
|
|
|
|
http_response_code(204);
|
|
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Return true if read only.
|
|
*
|
|
* MAY override
|
|
*
|
|
* @param array $args other arguments
|
|
*
|
|
* @return bool is read only action?
|
|
*/
|
|
public function isReadOnly($args): bool
|
|
{
|
|
return false;
|
|
}
|
|
}
|