mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-05-06 06:05:20 -04:00
f6e10579f2
* Add category order Each category has a new 'priority' attribute. It is used to sort categories in views. Categories with the same priority are sorted alphabetically. Categories with no priority are displayed after those with one. For example, if we have the following categories: - A (priority: 2) - B (no priority) - C (priority: 1) - D (priority: 2) - E (no priority) - F (priority: 1) They will be displayed in the following order: - C - F - A - D - B - E See #190 * Shorten help text It took too much room and will not be so necessary once we have drag & drop
413 lines
12 KiB
PHP
413 lines
12 KiB
PHP
<?php
|
|
|
|
class FreshRSS_CategoryDAO extends Minz_ModelPdo implements FreshRSS_Searchable {
|
|
|
|
const DEFAULTCATEGORYID = 1;
|
|
|
|
protected function addColumn($name) {
|
|
Minz_Log::warning(__method__ . ': ' . $name);
|
|
try {
|
|
if ('attributes' === $name) { //v1.15.0
|
|
$ok = $this->pdo->exec('ALTER TABLE `_category` ADD COLUMN attributes TEXT') !== false;
|
|
|
|
$stm = $this->pdo->query('SELECT * FROM `_feed`');
|
|
$feeds = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
|
|
$stm = $this->pdo->prepare('UPDATE `_feed` SET attributes = :attributes WHERE id = :id');
|
|
foreach ($feeds as $feed) {
|
|
if (empty($feed['keep_history']) || empty($feed['id'])) {
|
|
continue;
|
|
}
|
|
$keepHistory = $feed['keep_history'];
|
|
$attributes = empty($feed['attributes']) ? [] : json_decode($feed['attributes'], true);
|
|
if (is_string($attributes)) { //Legacy risk of double-encoding
|
|
$attributes = json_decode($attributes, true);
|
|
}
|
|
if (!is_array($attributes)) {
|
|
$attributes = [];
|
|
}
|
|
if ($keepHistory > 0) {
|
|
$attributes['archiving']['keep_min'] = intval($keepHistory);
|
|
} elseif ($keepHistory == -1) { //Infinite
|
|
$attributes['archiving']['keep_period'] = false;
|
|
$attributes['archiving']['keep_max'] = false;
|
|
$attributes['archiving']['keep_min'] = false;
|
|
} else {
|
|
continue;
|
|
}
|
|
$stm->bindValue(':id', $feed['id'], PDO::PARAM_INT);
|
|
$stm->bindValue(':attributes', json_encode($attributes, JSON_UNESCAPED_SLASHES));
|
|
$stm->execute();
|
|
}
|
|
|
|
if ($this->pdo->dbType() !== 'sqlite') { //SQLite does not support DROP COLUMN
|
|
$this->pdo->exec('ALTER TABLE `_feed` DROP COLUMN keep_history');
|
|
} else {
|
|
$this->pdo->exec('DROP INDEX IF EXISTS feed_keep_history_index'); //SQLite at least drop index
|
|
}
|
|
return $ok;
|
|
}
|
|
} catch (Exception $e) {
|
|
Minz_Log::error(__method__ . ': ' . $e->getMessage());
|
|
}
|
|
return false;
|
|
}
|
|
|
|
protected function autoUpdateDb($errorInfo) {
|
|
if (isset($errorInfo[0])) {
|
|
if ($errorInfo[0] === FreshRSS_DatabaseDAO::ER_BAD_FIELD_ERROR || $errorInfo[0] === FreshRSS_DatabaseDAOPGSQL::UNDEFINED_COLUMN) {
|
|
foreach (['attributes'] as $column) {
|
|
if (stripos($errorInfo[2], $column) !== false) {
|
|
return $this->addColumn($column);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
public function addCategory($valuesTmp) {
|
|
$sql = 'INSERT INTO `_category`(name, attributes) '
|
|
. 'SELECT * FROM (SELECT TRIM(?), ?) c2 ' //TRIM() to provide a type hint as text for PostgreSQL
|
|
. 'WHERE NOT EXISTS (SELECT 1 FROM `_tag` WHERE name = TRIM(?))'; //No tag of the same name
|
|
$stm = $this->pdo->prepare($sql);
|
|
|
|
$valuesTmp['name'] = mb_strcut(trim($valuesTmp['name']), 0, FreshRSS_DatabaseDAO::LENGTH_INDEX_UNICODE, 'UTF-8');
|
|
if (!isset($valuesTmp['attributes'])) {
|
|
$valuesTmp['attributes'] = [];
|
|
}
|
|
$values = array(
|
|
$valuesTmp['name'],
|
|
is_string($valuesTmp['attributes']) ? $valuesTmp['attributes'] : json_encode($valuesTmp['attributes'], JSON_UNESCAPED_SLASHES),
|
|
$valuesTmp['name'],
|
|
);
|
|
|
|
if ($stm && $stm->execute($values)) {
|
|
return $this->pdo->lastInsertId('`_category_id_seq`');
|
|
} else {
|
|
$info = $stm == null ? $this->pdo->errorInfo() : $stm->errorInfo();
|
|
if ($this->autoUpdateDb($info)) {
|
|
return $this->addCategory($valuesTmp);
|
|
}
|
|
Minz_Log::error('SQL error addCategory: ' . json_encode($info));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function addCategoryObject($category) {
|
|
$cat = $this->searchByName($category->name());
|
|
if (!$cat) {
|
|
// Category does not exist yet in DB so we add it before continue
|
|
$values = array(
|
|
'name' => $category->name(),
|
|
);
|
|
return $this->addCategory($values);
|
|
}
|
|
|
|
return $cat->id();
|
|
}
|
|
|
|
public function updateCategory($id, $valuesTmp) {
|
|
$sql = 'UPDATE `_category` SET name=?, attributes=? WHERE id=? '
|
|
. 'AND NOT EXISTS (SELECT 1 FROM `_tag` WHERE name = ?)'; //No tag of the same name
|
|
$stm = $this->pdo->prepare($sql);
|
|
|
|
$valuesTmp['name'] = mb_strcut(trim($valuesTmp['name']), 0, FreshRSS_DatabaseDAO::LENGTH_INDEX_UNICODE, 'UTF-8');
|
|
if (!isset($valuesTmp['attributes'])) {
|
|
$valuesTmp['attributes'] = [];
|
|
}
|
|
$values = array(
|
|
$valuesTmp['name'],
|
|
is_string($valuesTmp['attributes']) ? $valuesTmp['attributes'] : json_encode($valuesTmp['attributes'], JSON_UNESCAPED_SLASHES),
|
|
$id,
|
|
$valuesTmp['name'],
|
|
);
|
|
|
|
if ($stm && $stm->execute($values)) {
|
|
return $stm->rowCount();
|
|
} else {
|
|
$info = $stm == null ? $this->pdo->errorInfo() : $stm->errorInfo();
|
|
if ($this->autoUpdateDb($info)) {
|
|
return $this->updateCategory($valuesTmp);
|
|
}
|
|
Minz_Log::error('SQL error updateCategory: ' . json_encode($info));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function deleteCategory($id) {
|
|
if ($id <= self::DEFAULTCATEGORYID) {
|
|
return false;
|
|
}
|
|
$sql = 'DELETE FROM `_category` WHERE id=:id';
|
|
$stm = $this->pdo->prepare($sql);
|
|
$stm->bindParam(':id', $id, PDO::PARAM_INT);
|
|
if ($stm && $stm->execute()) {
|
|
return $stm->rowCount();
|
|
} else {
|
|
$info = $stm == null ? $this->pdo->errorInfo() : $stm->errorInfo();
|
|
Minz_Log::error('SQL error deleteCategory: ' . json_encode($info));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function selectAll() {
|
|
$sql = 'SELECT id, name, attributes FROM `_category`';
|
|
$stm = $this->pdo->query($sql);
|
|
if ($stm != false) {
|
|
while ($row = $stm->fetch(PDO::FETCH_ASSOC)) {
|
|
yield $row;
|
|
}
|
|
} else {
|
|
$info = $this->pdo->errorInfo();
|
|
if ($this->autoUpdateDb($info)) {
|
|
foreach ($this->selectAll() as $category) { // `yield from` requires PHP 7+
|
|
yield $category;
|
|
}
|
|
}
|
|
Minz_Log::error(__method__ . ' error: ' . json_encode($info));
|
|
yield false;
|
|
}
|
|
}
|
|
|
|
public function searchById($id) {
|
|
$sql = 'SELECT * FROM `_category` WHERE id=:id';
|
|
$stm = $this->pdo->prepare($sql);
|
|
$stm->bindParam(':id', $id, PDO::PARAM_INT);
|
|
$stm->execute();
|
|
$res = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
$cat = self::daoToCategory($res);
|
|
|
|
if (isset($cat[0])) {
|
|
return $cat[0];
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
public function searchByName($name) {
|
|
$sql = 'SELECT * FROM `_category` WHERE name=:name';
|
|
$stm = $this->pdo->prepare($sql);
|
|
if ($stm == false) {
|
|
return false;
|
|
}
|
|
$stm->bindParam(':name', $name);
|
|
$stm->execute();
|
|
$res = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
$cat = self::daoToCategory($res);
|
|
if (isset($cat[0])) {
|
|
return $cat[0];
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
public function listSortedCategories($prePopulateFeeds = true, $details = false) {
|
|
$categories = $this->listCategories($prePopulateFeeds, $details);
|
|
|
|
if (!is_array($categories)) {
|
|
return $categories;
|
|
}
|
|
|
|
usort($categories, function ($a, $b) {
|
|
$aPosition = $a->attributes('position');
|
|
$bPosition = $b->attributes('position');
|
|
if ($aPosition === $bPosition) {
|
|
return ($a->name() < $b->name()) ? -1 : 1;
|
|
} elseif (null === $aPosition) {
|
|
return 1;
|
|
} elseif (null === $bPosition) {
|
|
return -1;
|
|
}
|
|
return ($aPosition < $bPosition) ? -1 : 1;
|
|
});
|
|
|
|
return $categories;
|
|
}
|
|
|
|
public function listCategories($prePopulateFeeds = true, $details = false) {
|
|
if ($prePopulateFeeds) {
|
|
$sql = 'SELECT c.id AS c_id, c.name AS c_name, c.attributes AS c_attributes, '
|
|
. ($details ? 'f.* ' : 'f.id, f.name, f.url, f.website, f.priority, f.error, f.`cache_nbEntries`, f.`cache_nbUnreads`, f.ttl ')
|
|
. 'FROM `_category` c '
|
|
. 'LEFT OUTER JOIN `_feed` f ON f.category=c.id '
|
|
. 'WHERE f.priority >= :priority_normal '
|
|
. 'GROUP BY f.id, c_id '
|
|
. 'ORDER BY c.name, f.name';
|
|
$stm = $this->pdo->prepare($sql);
|
|
$values = [ ':priority_normal' => FreshRSS_Feed::PRIORITY_NORMAL ];
|
|
if ($stm && $stm->execute($values)) {
|
|
return self::daoToCategoryPrepopulated($stm->fetchAll(PDO::FETCH_ASSOC));
|
|
} else {
|
|
$info = $stm == null ? $this->pdo->errorInfo() : $stm->errorInfo();
|
|
if ($this->autoUpdateDb($info)) {
|
|
return $this->listCategories($prePopulateFeeds, $details);
|
|
}
|
|
Minz_Log::error('SQL error listCategories: ' . json_encode($info));
|
|
return false;
|
|
}
|
|
} else {
|
|
$sql = 'SELECT * FROM `_category` ORDER BY name';
|
|
$stm = $this->pdo->query($sql);
|
|
return self::daoToCategory($stm->fetchAll(PDO::FETCH_ASSOC));
|
|
}
|
|
}
|
|
|
|
public function getDefault() {
|
|
$sql = 'SELECT * FROM `_category` WHERE id=:id';
|
|
$stm = $this->pdo->prepare($sql);
|
|
$stm->bindValue(':id', self::DEFAULTCATEGORYID, PDO::PARAM_INT);
|
|
$stm->execute();
|
|
$res = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
$cat = self::daoToCategory($res);
|
|
|
|
if (isset($cat[0])) {
|
|
return $cat[0];
|
|
} else {
|
|
if (FreshRSS_Context::$isCli) {
|
|
fwrite(STDERR, 'FreshRSS database error: Default category not found!' . "\n");
|
|
}
|
|
Minz_Log::error('FreshRSS database error: Default category not found!');
|
|
return null;
|
|
}
|
|
}
|
|
public function checkDefault() {
|
|
$def_cat = $this->searchById(self::DEFAULTCATEGORYID);
|
|
|
|
if ($def_cat == null) {
|
|
$cat = new FreshRSS_Category(_t('gen.short.default_category'));
|
|
$cat->_id(self::DEFAULTCATEGORYID);
|
|
|
|
$sql = 'INSERT INTO `_category`(id, name) VALUES(?, ?)';
|
|
if ($this->pdo->dbType() === 'pgsql') {
|
|
//Force call to nextval()
|
|
$sql .= " RETURNING nextval('`_category_id_seq`');";
|
|
}
|
|
$stm = $this->pdo->prepare($sql);
|
|
|
|
$values = array(
|
|
$cat->id(),
|
|
$cat->name(),
|
|
);
|
|
|
|
if ($stm && $stm->execute($values)) {
|
|
return $this->pdo->lastInsertId('`_category_id_seq`');
|
|
} else {
|
|
$info = $stm == null ? $this->pdo->errorInfo() : $stm->errorInfo();
|
|
Minz_Log::error('SQL error check default category: ' . json_encode($info));
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function count() {
|
|
$sql = 'SELECT COUNT(*) AS count FROM `_category`';
|
|
$stm = $this->pdo->query($sql);
|
|
$res = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
return $res[0]['count'];
|
|
}
|
|
|
|
public function countFeed($id) {
|
|
$sql = 'SELECT COUNT(*) AS count FROM `_feed` WHERE category=:id';
|
|
$stm = $this->pdo->prepare($sql);
|
|
$stm->bindParam(':id', $id, PDO::PARAM_INT);
|
|
$stm->execute();
|
|
$res = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
return $res[0]['count'];
|
|
}
|
|
|
|
public function countNotRead($id) {
|
|
$sql = 'SELECT COUNT(*) AS count FROM `_entry` e INNER JOIN `_feed` f ON e.id_feed=f.id WHERE category=:id AND e.is_read=0';
|
|
$stm = $this->pdo->prepare($sql);
|
|
$stm->bindParam(':id', $id, PDO::PARAM_INT);
|
|
$stm->execute();
|
|
$res = $stm->fetchAll(PDO::FETCH_ASSOC);
|
|
return $res[0]['count'];
|
|
}
|
|
|
|
public static function findFeed($categories, $feed_id) {
|
|
foreach ($categories as $category) {
|
|
foreach ($category->feeds() as $feed) {
|
|
if ($feed->id() === $feed_id) {
|
|
return $feed;
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
public static function CountUnreads($categories, $minPriority = 0) {
|
|
$n = 0;
|
|
foreach ($categories as $category) {
|
|
foreach ($category->feeds() as $feed) {
|
|
if ($feed->priority() >= $minPriority) {
|
|
$n += $feed->nbNotRead();
|
|
}
|
|
}
|
|
}
|
|
return $n;
|
|
}
|
|
|
|
public static function daoToCategoryPrepopulated($listDAO) {
|
|
$list = array();
|
|
|
|
if (!is_array($listDAO)) {
|
|
$listDAO = array($listDAO);
|
|
}
|
|
|
|
$previousLine = null;
|
|
$feedsDao = array();
|
|
$feedDao = FreshRSS_Factory::createFeedDAO();
|
|
foreach ($listDAO as $line) {
|
|
if ($previousLine['c_id'] != null && $line['c_id'] !== $previousLine['c_id']) {
|
|
// End of the current category, we add it to the $list
|
|
$cat = new FreshRSS_Category(
|
|
$previousLine['c_name'],
|
|
$feedDao->daoToFeed($feedsDao, $previousLine['c_id'])
|
|
);
|
|
$cat->_id($previousLine['c_id']);
|
|
$cat->_attributes('', $previousLine['c_attributes']);
|
|
$list[$previousLine['c_id']] = $cat;
|
|
|
|
$feedsDao = array(); //Prepare for next category
|
|
}
|
|
|
|
$previousLine = $line;
|
|
$feedsDao[] = $line;
|
|
}
|
|
|
|
// add the last category
|
|
if ($previousLine != null) {
|
|
$cat = new FreshRSS_Category(
|
|
$previousLine['c_name'],
|
|
$feedDao->daoToFeed($feedsDao, $previousLine['c_id'])
|
|
);
|
|
$cat->_id($previousLine['c_id']);
|
|
$cat->_attributes('', $previousLine['c_attributes']);
|
|
$list[$previousLine['c_id']] = $cat;
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
|
|
public static function daoToCategory($listDAO) {
|
|
$list = array();
|
|
|
|
if (!is_array($listDAO)) {
|
|
$listDAO = array($listDAO);
|
|
}
|
|
|
|
foreach ($listDAO as $key => $dao) {
|
|
$cat = new FreshRSS_Category(
|
|
$dao['name']
|
|
);
|
|
$cat->_id($dao['id']);
|
|
$cat->_attributes('', isset($dao['attributes']) ? $dao['attributes'] : '');
|
|
$cat->_isDefault(static::DEFAULTCATEGORYID === intval($dao['id']));
|
|
$list[$key] = $cat;
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
}
|