friendica/src/Model/PushSubscriber.php

158 lines
5.5 KiB
PHP
Raw Normal View History

2018-05-18 01:30:49 +02:00
<?php
/**
* @file src/Model/PushSubscriber.php
*/
namespace Friendica\Model;
2018-10-29 22:20:46 +01:00
use Friendica\Core\Logger;
2018-05-18 01:30:49 +02:00
use Friendica\Core\Worker;
use Friendica\Database\DBA;
use Friendica\Util\DateTimeFormat;
2018-05-18 01:30:49 +02:00
class PushSubscriber
{
/**
* @brief Send subscription notifications for the given user
*
2019-01-06 22:06:53 +01:00
* @param integer $uid User ID
* @param int $default_priority
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function publishFeed($uid, $default_priority = PRIORITY_HIGH)
{
$condition = ['push' => 0, 'uid' => $uid];
DBA::update('push_subscriber', ['push' => 1, 'next_try' => DBA::NULL_DATETIME], $condition);
self::requeue($default_priority);
}
/**
* @brief start workers to transmit the feed data
*
2019-01-06 22:06:53 +01:00
* @param int $default_priority
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
2018-05-18 01:30:49 +02:00
*/
public static function requeue($default_priority = PRIORITY_HIGH)
2018-05-18 01:30:49 +02:00
{
// We'll push to each subscriber that has push > 0,
// i.e. there has been an update (set in notifier.php).
$subscribers = DBA::select('push_subscriber', ['id', 'push', 'callback_url', 'nickname'], ["`push` > 0 AND `next_try` < UTC_TIMESTAMP()"]);
2018-05-18 01:30:49 +02:00
while ($subscriber = DBA::fetch($subscribers)) {
2018-05-18 01:43:44 +02:00
// We always handle retries with low priority
if ($subscriber['push'] > 1) {
2018-05-18 01:43:44 +02:00
$priority = PRIORITY_LOW;
2018-05-18 01:47:15 +02:00
} else {
$priority = $default_priority;
2018-05-18 01:43:44 +02:00
}
2018-05-18 01:47:15 +02:00
Logger::log('Publish feed to ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' with priority ' . $priority, Logger::DEBUG);
Worker::add($priority, 'PubSubPublish', (int)$subscriber['id']);
2018-05-18 01:30:49 +02:00
}
DBA::close($subscribers);
2018-05-18 01:30:49 +02:00
}
/**
* @brief Renew the feed subscription
*
* @param integer $uid User ID
* @param string $nick Priority for push workers
* @param integer $subscribe Subscribe (Unsubscribe = false)
* @param string $hub_callback Callback address
* @param string $hub_topic Feed topic
* @param string $hub_secret Subscription secret
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public static function renew($uid, $nick, $subscribe, $hub_callback, $hub_topic, $hub_secret)
{
// fetch the old subscription if it exists
$subscriber = DBA::selectFirst('push_subscriber', ['last_update', 'push'], ['callback_url' => $hub_callback]);
// delete old subscription if it exists
DBA::delete('push_subscriber', ['callback_url' => $hub_callback]);
if ($subscribe) {
// if we are just updating an old subscription, keep the
// old values for last_update but reset the push
2018-07-21 14:46:04 +02:00
if (DBA::isResult($subscriber)) {
$last_update = $subscriber['last_update'];
$push_flag = min($subscriber['push'], 1);
} else {
$last_update = DateTimeFormat::utcNow();
$push_flag = 0;
}
// subscribe means adding the row to the table
$fields = ['uid' => $uid, 'callback_url' => $hub_callback,
'topic' => $hub_topic, 'nickname' => $nick, 'push' => $push_flag,
'last_update' => $last_update, 'renewed' => DateTimeFormat::utcNow(),
'secret' => $hub_secret];
DBA::insert('push_subscriber', $fields);
2018-10-29 22:20:46 +01:00
Logger::log("Successfully subscribed [$hub_callback] for $nick");
} else {
2018-10-29 22:20:46 +01:00
Logger::log("Successfully unsubscribed [$hub_callback] for $nick");
// we do nothing here, since the row was already deleted
}
}
/**
* @brief Delay the push subscriber
*
* @param integer $id Subscriber ID
2019-01-06 22:06:53 +01:00
* @throws \Exception
*/
public static function delay($id)
{
$subscriber = DBA::selectFirst('push_subscriber', ['push', 'callback_url', 'renewed', 'nickname'], ['id' => $id]);
2018-07-21 14:46:04 +02:00
if (!DBA::isResult($subscriber)) {
return;
}
$retrial = $subscriber['push'];
if ($retrial > 14) {
// End subscriptions if they weren't renewed for more than two months
$days = round((time() - strtotime($subscriber['renewed'])) / (60 * 60 * 24));
if ($days > 60) {
DBA::update('push_subscriber', ['push' => -1, 'next_try' => DBA::NULL_DATETIME], ['id' => $id]);
Logger::log('Delivery error: Subscription ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' is marked as ended.', Logger::DEBUG);
} else {
DBA::update('push_subscriber', ['push' => 0, 'next_try' => DBA::NULL_DATETIME], ['id' => $id]);
Logger::log('Delivery error: Giving up ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' for now.', Logger::DEBUG);
}
} else {
// Calculate the delay until the next trial
$delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
$next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
$retrial = $retrial + 1;
DBA::update('push_subscriber', ['push' => $retrial, 'next_try' => $next], ['id' => $id]);
Logger::log('Delivery error: Next try (' . $retrial . ') ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' at ' . $next, Logger::DEBUG);
}
}
/**
* @brief Reset the push subscriber
*
* @param integer $id Subscriber ID
2019-01-06 22:06:53 +01:00
* @param string $last_update Date of last transmitted item
* @throws \Exception
*/
public static function reset($id, $last_update)
{
$subscriber = DBA::selectFirst('push_subscriber', ['callback_url', 'nickname'], ['id' => $id]);
2018-07-21 14:46:04 +02:00
if (!DBA::isResult($subscriber)) {
return;
}
// set last_update to the 'created' date of the last item, and reset push=0
$fields = ['push' => 0, 'next_try' => DBA::NULL_DATETIME, 'last_update' => $last_update];
DBA::update('push_subscriber', $fields, ['id' => $id]);
Logger::log('Subscriber ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' is marked as vital', Logger::DEBUG);
}
2018-05-18 01:30:49 +02:00
}