src/Model/PushSubscriber.php

   1 <?php
   2 /**
   3  * @file src/Model/PushSubscriber.php
   4  */
   5 namespace Friendica\Model;
   6
   7 use Friendica\Core\Logger;
   8 use Friendica\Core\Worker;
   9 use Friendica\Database\DBA;
  10 use Friendica\Util\DateTimeFormat;
  11
  12 require_once 'include/dba.php';
  13
  14 class PushSubscriber
  15 {
  16         /**
  17          * @brief Send subscription notifications for the given user
  18          *
  19          * @param integer $uid      User ID
  20          * @param string  $priority Priority for push workers
  21          */
  22         public static function publishFeed($uid, $default_priority = PRIORITY_HIGH)
  23         {
  24                 $condition = ['push' => 0, 'uid' => $uid];
  25                 DBA::update('push_subscriber', ['push' => 1, 'next_try' => DBA::NULL_DATETIME], $condition);
  26
  27                 self::requeue($default_priority);
  28         }
  29
  30         /**
  31          * @brief start workers to transmit the feed data
  32          *
  33          * @param string $priority Priority for push workers
  34          */
  35         public static function requeue($default_priority = PRIORITY_HIGH)
  36         {
  37                 // We'll push to each subscriber that has push > 0,
  38                 // i.e. there has been an update (set in notifier.php).
  39                 $subscribers = DBA::select('push_subscriber', ['id', 'push', 'callback_url', 'nickname'], ["`push` > 0 AND `next_try` < UTC_TIMESTAMP()"]);
  40
  41                 while ($subscriber = DBA::fetch($subscribers)) {
  42                         // We always handle retries with low priority
  43                         if ($subscriber['push'] > 1) {
  44                                 $priority = PRIORITY_LOW;
  45                         } else {
  46                                 $priority = $default_priority;
  47                         }
  48
  49                         Logger::log('Publish feed to ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' with priority ' . $priority, Logger::DEBUG);
  50                         Worker::add($priority, 'PubSubPublish', (int)$subscriber['id']);
  51                 }
  52
  53                 DBA::close($subscribers);
  54         }
  55
  56         /**
  57          * @brief Renew the feed subscription
  58          *
  59          * @param integer $uid          User ID
  60          * @param string  $nick         Priority for push workers
  61          * @param integer $subscribe    Subscribe (Unsubscribe = false)
  62          * @param string  $hub_callback Callback address
  63          * @param string  $hub_topic    Feed topic
  64          * @param string  $hub_secret   Subscription secret
  65          */
  66         public static function renew($uid, $nick, $subscribe, $hub_callback, $hub_topic, $hub_secret)
  67         {
  68                 // fetch the old subscription if it exists
  69                 $subscriber = DBA::selectFirst('push_subscriber', ['last_update', 'push'], ['callback_url' => $hub_callback]);
  70
  71                 // delete old subscription if it exists
  72                 DBA::delete('push_subscriber', ['callback_url' => $hub_callback]);
  73
  74                 if ($subscribe) {
  75                         // if we are just updating an old subscription, keep the
  76                         // old values for last_update but reset the push
  77                         if (DBA::isResult($subscriber)) {
  78                                 $last_update = $subscriber['last_update'];
  79                                 $push_flag = min($subscriber['push'], 1);
  80                         } else {
  81                                 $last_update = DateTimeFormat::utcNow();
  82                                 $push_flag = 0;
  83                         }
  84
  85                         // subscribe means adding the row to the table
  86                         $fields = ['uid' => $uid, 'callback_url' => $hub_callback,
  87                                 'topic' => $hub_topic, 'nickname' => $nick, 'push' => $push_flag,
  88                                 'last_update' => $last_update, 'renewed' => DateTimeFormat::utcNow(),
  89                                 'secret' => $hub_secret];
  90                         DBA::insert('push_subscriber', $fields);
  91
  92                         Logger::log("Successfully subscribed [$hub_callback] for $nick");
  93                 } else {
  94                         Logger::log("Successfully unsubscribed [$hub_callback] for $nick");
  95                         // we do nothing here, since the row was already deleted
  96                 }
  97         }
  98
  99         /**
 100          * @brief Delay the push subscriber
 101          *
 102          * @param integer $id Subscriber ID
 103          */
 104         public static function delay($id)
 105         {
 106                 $subscriber = DBA::selectFirst('push_subscriber', ['push', 'callback_url', 'renewed', 'nickname'], ['id' => $id]);
 107                 if (!DBA::isResult($subscriber)) {
 108                         return;
 109                 }
 110
 111                 $retrial = $subscriber['push'];
 112
 113                 if ($retrial > 14) {
 114                         // End subscriptions if they weren't renewed for more than two months
 115                         $days = round((time() -  strtotime($subscriber['renewed'])) / (60 * 60 * 24));
 116
 117                         if ($days > 60) {
 118                                 DBA::update('push_subscriber', ['push' => -1, 'next_try' => DBA::NULL_DATETIME], ['id' => $id]);
 119                                 Logger::log('Delivery error: Subscription ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' is marked as ended.', Logger::DEBUG);
 120                         } else {
 121                                 DBA::update('push_subscriber', ['push' => 0, 'next_try' => DBA::NULL_DATETIME], ['id' => $id]);
 122                                 Logger::log('Delivery error: Giving up ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' for now.', Logger::DEBUG);
 123                         }
 124                 } else {
 125                         // Calculate the delay until the next trial
 126                         $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
 127                         $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
 128
 129                         $retrial = $retrial + 1;
 130
 131                         DBA::update('push_subscriber', ['push' => $retrial, 'next_try' => $next], ['id' => $id]);
 132                         Logger::log('Delivery error: Next try (' . $retrial . ') ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' at ' . $next, Logger::DEBUG);
 133                 }
 134         }
 135
 136         /**
 137          * @brief Reset the push subscriber
 138          *
 139          * @param integer $id          Subscriber ID
 140          * @param date    $last_update Date of last transmitted item
 141          */
 142         public static function reset($id, $last_update)
 143         {
 144                 $subscriber = DBA::selectFirst('push_subscriber', ['callback_url', 'nickname'], ['id' => $id]);
 145                 if (!DBA::isResult($subscriber)) {
 146                         return;
 147                 }
 148
 149                 // set last_update to the 'created' date of the last item, and reset push=0
 150                 $fields = ['push' => 0, 'next_try' => DBA::NULL_DATETIME, 'last_update' => $last_update];
 151                 DBA::update('push_subscriber', $fields, ['id' => $id]);
 152                 Logger::log('Subscriber ' . $subscriber['callback_url'] . ' for ' . $subscriber['nickname'] . ' is marked as vital', Logger::DEBUG);
 153         }
 154 }