2018-12-07 05:52:14 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2020-02-09 14:45:36 +00:00
|
|
|
* @copyright Copyright (C) 2020, Friendica
|
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* This program 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.
|
|
|
|
*
|
|
|
|
* This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
*
|
2018-12-07 05:52:14 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Friendica\Model;
|
|
|
|
|
|
|
|
use Friendica\Database\DBA;
|
2019-02-19 00:56:41 +00:00
|
|
|
use \BadMethodCallException;
|
2018-12-07 05:52:14 +00:00
|
|
|
|
|
|
|
class ItemDeliveryData
|
|
|
|
{
|
2018-12-08 20:22:54 +00:00
|
|
|
const LEGACY_FIELD_LIST = [
|
2018-12-07 05:52:14 +00:00
|
|
|
// Legacy fields moved from item table
|
|
|
|
'postopts',
|
|
|
|
'inform',
|
2018-12-08 20:22:54 +00:00
|
|
|
];
|
|
|
|
|
|
|
|
const FIELD_LIST = [
|
2018-12-07 05:52:14 +00:00
|
|
|
// New delivery fields with virtual field name in item fields
|
|
|
|
'queue_count' => 'delivery_queue_count',
|
|
|
|
'queue_done' => 'delivery_queue_done',
|
2019-08-20 07:39:13 +00:00
|
|
|
'queue_failed' => 'delivery_queue_failed',
|
2018-12-07 05:52:14 +00:00
|
|
|
];
|
|
|
|
|
2019-06-28 09:03:58 +00:00
|
|
|
const ACTIVITYPUB = 1;
|
|
|
|
const DFRN = 2;
|
|
|
|
const LEGACY_DFRN = 3;
|
|
|
|
const DIASPORA = 4;
|
|
|
|
const OSTATUS = 5;
|
2019-11-23 04:31:40 +00:00
|
|
|
const MAIL = 6;
|
2019-06-28 09:03:58 +00:00
|
|
|
|
2018-12-07 05:52:14 +00:00
|
|
|
/**
|
|
|
|
* Extract delivery data from the provided item fields
|
|
|
|
*
|
|
|
|
* @param array $fields
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public static function extractFields(array &$fields)
|
|
|
|
{
|
|
|
|
$delivery_data = [];
|
2019-01-24 21:06:53 +00:00
|
|
|
foreach (array_merge(ItemDeliveryData::FIELD_LIST, ItemDeliveryData::LEGACY_FIELD_LIST) as $key => $field) {
|
2018-12-07 05:52:14 +00:00
|
|
|
if (is_int($key) && isset($fields[$field])) {
|
|
|
|
// Legacy field moved from item table
|
|
|
|
$delivery_data[$field] = $fields[$field];
|
|
|
|
$fields[$field] = null;
|
|
|
|
} elseif (isset($fields[$field])) {
|
|
|
|
// New delivery field with virtual field name in item fields
|
|
|
|
$delivery_data[$key] = $fields[$field];
|
|
|
|
unset($fields[$field]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $delivery_data;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Increments the queue_done for the given item ID.
|
|
|
|
*
|
|
|
|
* Avoids racing condition between multiple delivery threads.
|
|
|
|
*
|
|
|
|
* @param integer $item_id
|
2019-06-28 09:03:58 +00:00
|
|
|
* @param integer $protocol
|
2018-12-07 05:52:14 +00:00
|
|
|
* @return bool
|
2019-01-06 21:06:53 +00:00
|
|
|
* @throws \Exception
|
2018-12-07 05:52:14 +00:00
|
|
|
*/
|
2019-06-28 09:03:58 +00:00
|
|
|
public static function incrementQueueDone($item_id, $protocol = 0)
|
2018-12-07 05:52:14 +00:00
|
|
|
{
|
2019-06-28 09:03:58 +00:00
|
|
|
$sql = '';
|
|
|
|
|
|
|
|
switch ($protocol) {
|
|
|
|
case self::ACTIVITYPUB:
|
|
|
|
$sql = ", `activitypub` = `activitypub` + 1";
|
|
|
|
break;
|
|
|
|
case self::DFRN:
|
|
|
|
$sql = ", `dfrn` = `dfrn` + 1";
|
|
|
|
break;
|
|
|
|
case self::LEGACY_DFRN:
|
|
|
|
$sql = ", `legacy_dfrn` = `legacy_dfrn` + 1";
|
|
|
|
break;
|
|
|
|
case self::DIASPORA:
|
|
|
|
$sql = ", `diaspora` = `diaspora` + 1";
|
|
|
|
break;
|
|
|
|
case self::OSTATUS:
|
|
|
|
$sql = ", `ostatus` = `ostatus` + 1";
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return DBA::e('UPDATE `item-delivery-data` SET `queue_done` = `queue_done` + 1' . $sql . ' WHERE `iid` = ?', $item_id);
|
2018-12-07 05:52:14 +00:00
|
|
|
}
|
|
|
|
|
2019-08-20 07:39:13 +00:00
|
|
|
/**
|
|
|
|
* Increments the queue_failed for the given item ID.
|
|
|
|
*
|
|
|
|
* Avoids racing condition between multiple delivery threads.
|
|
|
|
*
|
|
|
|
* @param integer $item_id
|
|
|
|
* @return bool
|
|
|
|
* @throws \Exception
|
|
|
|
*/
|
|
|
|
public static function incrementQueueFailed($item_id)
|
|
|
|
{
|
|
|
|
return DBA::e('UPDATE `item-delivery-data` SET `queue_failed` = `queue_failed` + 1 WHERE `iid` = ?', $item_id);
|
|
|
|
}
|
|
|
|
|
2019-09-02 03:25:05 +00:00
|
|
|
/**
|
|
|
|
* Increments the queue_count for the given item ID.
|
|
|
|
*
|
|
|
|
* @param integer $item_id
|
|
|
|
* @param integer $increment
|
|
|
|
* @return bool
|
|
|
|
* @throws \Exception
|
|
|
|
*/
|
2019-09-03 03:59:46 +00:00
|
|
|
public static function incrementQueueCount(int $item_id, int $increment = 1)
|
2019-09-02 03:25:05 +00:00
|
|
|
{
|
|
|
|
return DBA::e('UPDATE `item-delivery-data` SET `queue_count` = `queue_count` + ? WHERE `iid` = ?', $increment, $item_id);
|
|
|
|
}
|
|
|
|
|
2018-12-07 05:52:14 +00:00
|
|
|
/**
|
|
|
|
* Insert a new item delivery data entry
|
|
|
|
*
|
|
|
|
* @param integer $item_id
|
|
|
|
* @param array $fields
|
|
|
|
* @return bool
|
2019-01-06 21:06:53 +00:00
|
|
|
* @throws \Exception
|
2018-12-07 05:52:14 +00:00
|
|
|
*/
|
|
|
|
public static function insert($item_id, array $fields)
|
|
|
|
{
|
|
|
|
if (empty($item_id)) {
|
2019-02-19 00:56:41 +00:00
|
|
|
throw new BadMethodCallException('Empty item_id');
|
2018-12-07 05:52:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
$fields['iid'] = $item_id;
|
|
|
|
|
|
|
|
return DBA::insert('item-delivery-data', $fields);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update/Insert item delivery data
|
|
|
|
*
|
|
|
|
* If you want to update queue_done, please use incrementQueueDone instead.
|
|
|
|
*
|
|
|
|
* @param integer $item_id
|
|
|
|
* @param array $fields
|
|
|
|
* @return bool
|
2019-01-06 21:06:53 +00:00
|
|
|
* @throws \Exception
|
2018-12-07 05:52:14 +00:00
|
|
|
*/
|
|
|
|
public static function update($item_id, array $fields)
|
|
|
|
{
|
|
|
|
if (empty($item_id)) {
|
2019-02-19 00:56:41 +00:00
|
|
|
throw new BadMethodCallException('Empty item_id');
|
2018-12-07 05:52:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (empty($fields)) {
|
|
|
|
// Nothing to do, update successful
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return DBA::update('item-delivery-data', $fields, ['iid' => $item_id], true);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete item delivery data
|
|
|
|
*
|
|
|
|
* @param integer $item_id
|
|
|
|
* @return bool
|
2019-01-06 21:06:53 +00:00
|
|
|
* @throws \Exception
|
2018-12-07 05:52:14 +00:00
|
|
|
*/
|
|
|
|
public static function delete($item_id)
|
|
|
|
{
|
|
|
|
if (empty($item_id)) {
|
2019-02-19 00:56:41 +00:00
|
|
|
throw new BadMethodCallException('Empty item_id');
|
2018-12-07 05:52:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return DBA::delete('item-delivery-data', ['iid' => $item_id]);
|
|
|
|
}
|
|
|
|
}
|