EntryDAO.php 64 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723
  1. <?php
  2. declare(strict_types=1);
  3. class FreshRSS_EntryDAO extends Minz_ModelPdo {
  4. public static function isCompressed(): bool {
  5. return true;
  6. }
  7. public static function hasNativeHex(): bool {
  8. return true;
  9. }
  10. protected static function sqlConcat(string $s1, string $s2): string {
  11. return 'CONCAT(' . $s1 . ',' . $s2 . ')'; //MySQL
  12. }
  13. public static function sqlHexDecode(string $x): string {
  14. return 'unhex(' . $x . ')';
  15. }
  16. public static function sqlHexEncode(string $x): string {
  17. return 'hex(' . $x . ')';
  18. }
  19. public static function sqlIgnoreConflict(string $sql): string {
  20. return str_replace('INSERT INTO ', 'INSERT IGNORE INTO ', $sql);
  21. }
  22. public static function sqlRandom(): string {
  23. return 'RAND()';
  24. }
  25. /** @return array{pattern?:string,matchType?:string} */
  26. protected static function regexToSql(string $regex): array {
  27. if (preg_match('#^/(?P<pattern>.*)/(?P<matchType>[im]*)$#', $regex, $matches)) {
  28. return $matches;
  29. }
  30. return [];
  31. }
  32. /** @param list<int|string> $values */
  33. protected static function sqlRegex(string $expression, string $regex, array &$values): string {
  34. // The implementation of this function is solely for MySQL and MariaDB
  35. static $databaseDAOMySQL = null;
  36. if (!($databaseDAOMySQL instanceof FreshRSS_DatabaseDAO)) {
  37. $databaseDAOMySQL = new FreshRSS_DatabaseDAO();
  38. }
  39. $matches = static::regexToSql($regex);
  40. if (isset($matches['pattern'])) {
  41. $matchType = $matches['matchType'] ?? '';
  42. if ($databaseDAOMySQL->isMariaDB()) {
  43. if (str_contains($matchType, 'm')) {
  44. // multiline mode
  45. $matches['pattern'] = '(?m)' . $matches['pattern'];
  46. }
  47. if (str_contains($matchType, 'i')) {
  48. // case-insensitive match
  49. $matches['pattern'] = '(?i)' . $matches['pattern'];
  50. } else {
  51. $matches['pattern'] = '(?-i)' . $matches['pattern'];
  52. }
  53. $values[] = $matches['pattern'];
  54. return "{$expression} REGEXP ?";
  55. } else { // MySQL
  56. if (!str_contains($matchType, 'i')) {
  57. // Case-sensitive matching
  58. $matchType .= 'c';
  59. }
  60. $values[] = $matches['pattern'];
  61. return "REGEXP_LIKE({$expression},?,'{$matchType}')";
  62. }
  63. }
  64. return '';
  65. }
  66. /** Register any needed SQL function for the query, e.g. application-defined functions for SQLite */
  67. protected function registerSqlFunctions(string $sql): void {
  68. // Nothing to do for MySQL
  69. }
  70. private function updateToMediumBlob(): bool {
  71. if ($this->pdo->dbType() !== 'mysql') {
  72. return false;
  73. }
  74. Minz_Log::warning('Update MySQL table to use MEDIUMBLOB...');
  75. $sql = <<<'SQL'
  76. ALTER TABLE `_entry` MODIFY `content_bin` MEDIUMBLOB;
  77. ALTER TABLE `_entrytmp` MODIFY `content_bin` MEDIUMBLOB;
  78. SQL;
  79. try {
  80. $ok = $this->pdo->exec($sql) !== false;
  81. } catch (Exception $e) {
  82. $ok = false;
  83. Minz_Log::error(__METHOD__ . ' error: ' . $e->getMessage());
  84. }
  85. return $ok;
  86. }
  87. protected function addColumn(string $name): bool {
  88. if ($this->pdo->inTransaction()) {
  89. $this->pdo->commit();
  90. }
  91. Minz_Log::warning(__METHOD__ . ': ' . $name);
  92. try {
  93. if ($name === 'attributes') { //v1.20.0
  94. $sql = <<<'SQL'
  95. ALTER TABLE `_entry` ADD COLUMN attributes TEXT;
  96. ALTER TABLE `_entrytmp` ADD COLUMN attributes TEXT;
  97. SQL;
  98. return $this->pdo->exec($sql) !== false;
  99. }
  100. } catch (Exception $e) {
  101. Minz_Log::error(__METHOD__ . ' error: ' . $e->getMessage());
  102. }
  103. return false;
  104. }
  105. //TODO: Move the database auto-updates to DatabaseDAO
  106. /** @param array{0:string,1:int,2:string} $errorInfo */
  107. protected function autoUpdateDb(array $errorInfo): bool {
  108. if (isset($errorInfo[0])) {
  109. if ($errorInfo[0] === FreshRSS_DatabaseDAO::ER_BAD_FIELD_ERROR || $errorInfo[0] === FreshRSS_DatabaseDAOPGSQL::UNDEFINED_COLUMN) {
  110. $errorLines = explode("\n", $errorInfo[2], 2); // The relevant column name is on the first line, other lines are noise
  111. foreach (['attributes'] as $column) {
  112. if (str_contains($errorLines[0], $column)) {
  113. return $this->addColumn($column);
  114. }
  115. }
  116. }
  117. }
  118. if (isset($errorInfo[1])) {
  119. // May be a string or an int
  120. if ($errorInfo[1] == FreshRSS_DatabaseDAO::ER_DATA_TOO_LONG) {
  121. if (str_contains($errorInfo[2], 'content_bin')) {
  122. return $this->updateToMediumBlob(); //v1.15.0
  123. }
  124. }
  125. }
  126. return false;
  127. }
  128. private PDOStatement|null|false $addEntryPrepared = null;
  129. /** @param array{'id':string,'guid':string,'title':string,'author':string,'content':string,'link':string,'date':int,'lastSeen':int,'hash':string,
  130. * 'is_read':bool|int|null,'is_favorite':bool|int|null,'id_feed':int,'tags':string,'attributes'?:null|string|array<string,mixed>} $valuesTmp */
  131. public function addEntry(array $valuesTmp, bool $useTmpTable = true): bool {
  132. if ($this->addEntryPrepared == null) {
  133. $sql = static::sqlIgnoreConflict(
  134. 'INSERT INTO `_' . ($useTmpTable ? 'entrytmp' : 'entry') . '` (id, guid, title, author, '
  135. . (static::isCompressed() ? 'content_bin' : 'content')
  136. . ', link, date, `lastSeen`, hash, is_read, is_favorite, id_feed, tags, attributes) '
  137. . 'VALUES(:id, :guid, :title, :author, '
  138. . (static::isCompressed() ? 'COMPRESS(:content)' : ':content')
  139. . ', :link, :date, :last_seen, '
  140. . static::sqlHexDecode(':hash')
  141. . ', :is_read, :is_favorite, :id_feed, :tags, :attributes)');
  142. $this->addEntryPrepared = $this->pdo->prepare($sql);
  143. }
  144. if ($this->addEntryPrepared != false) {
  145. $this->addEntryPrepared->bindParam(':id', $valuesTmp['id']);
  146. $valuesTmp['guid'] = substr($valuesTmp['guid'], 0, 767);
  147. $valuesTmp['guid'] = safe_ascii($valuesTmp['guid']);
  148. $this->addEntryPrepared->bindParam(':guid', $valuesTmp['guid']);
  149. $valuesTmp['title'] = mb_strcut($valuesTmp['title'], 0, 8192, 'UTF-8');
  150. $valuesTmp['title'] = safe_utf8($valuesTmp['title']);
  151. $this->addEntryPrepared->bindParam(':title', $valuesTmp['title']);
  152. $valuesTmp['author'] = mb_strcut($valuesTmp['author'], 0, 1024, 'UTF-8');
  153. $valuesTmp['author'] = safe_utf8($valuesTmp['author']);
  154. $this->addEntryPrepared->bindParam(':author', $valuesTmp['author']);
  155. $valuesTmp['content'] = safe_utf8($valuesTmp['content']);
  156. $this->addEntryPrepared->bindParam(':content', $valuesTmp['content']);
  157. $valuesTmp['link'] = substr($valuesTmp['link'], 0, 16383);
  158. $valuesTmp['link'] = safe_ascii($valuesTmp['link']);
  159. $this->addEntryPrepared->bindParam(':link', $valuesTmp['link']);
  160. $this->addEntryPrepared->bindParam(':date', $valuesTmp['date'], PDO::PARAM_INT);
  161. if (empty($valuesTmp['lastSeen'])) {
  162. $valuesTmp['lastSeen'] = time();
  163. }
  164. $this->addEntryPrepared->bindParam(':last_seen', $valuesTmp['lastSeen'], PDO::PARAM_INT);
  165. $valuesTmp['is_read'] = $valuesTmp['is_read'] ? 1 : 0;
  166. $this->addEntryPrepared->bindParam(':is_read', $valuesTmp['is_read'], PDO::PARAM_INT);
  167. $valuesTmp['is_favorite'] = $valuesTmp['is_favorite'] ? 1 : 0;
  168. $this->addEntryPrepared->bindParam(':is_favorite', $valuesTmp['is_favorite'], PDO::PARAM_INT);
  169. $this->addEntryPrepared->bindParam(':id_feed', $valuesTmp['id_feed'], PDO::PARAM_INT);
  170. $valuesTmp['tags'] = mb_strcut($valuesTmp['tags'], 0, 2048, 'UTF-8');
  171. $valuesTmp['tags'] = safe_utf8($valuesTmp['tags']);
  172. $this->addEntryPrepared->bindParam(':tags', $valuesTmp['tags']);
  173. if (!isset($valuesTmp['attributes'])) {
  174. $valuesTmp['attributes'] = [];
  175. }
  176. $this->addEntryPrepared->bindValue(':attributes', is_string($valuesTmp['attributes']) ? $valuesTmp['attributes'] :
  177. json_encode($valuesTmp['attributes'], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
  178. if (static::hasNativeHex()) {
  179. $this->addEntryPrepared->bindParam(':hash', $valuesTmp['hash']);
  180. } else {
  181. $valuesTmp['hashBin'] = hex2bin($valuesTmp['hash']);
  182. $this->addEntryPrepared->bindParam(':hash', $valuesTmp['hashBin']);
  183. }
  184. }
  185. if ($this->addEntryPrepared != false && $this->addEntryPrepared->execute()) {
  186. return true;
  187. } else {
  188. $info = $this->addEntryPrepared == false ? $this->pdo->errorInfo() : $this->addEntryPrepared->errorInfo();
  189. /** @var array{id:string,guid:string,title:string,author:string,content:string,link:string,date:int,lastSeen:int,hash:string,
  190. * is_read:bool|int|null,is_favorite:bool|int|null,id_feed:int,tags:string,attributes?:null|string|array<string,mixed>} $valuesTmp */
  191. /** @var array{0:string,1:int,2:string} $info */
  192. if ($this->autoUpdateDb($info)) {
  193. $this->addEntryPrepared = null;
  194. return $this->addEntry($valuesTmp);
  195. } elseif ((int)((int)$info[0] / 1000) !== 23) { //Filter out "SQLSTATE Class code 23: Constraint Violation" because of expected duplicate entries
  196. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info)
  197. . ' while adding entry in feed ' . $valuesTmp['id_feed'] . ' with title: ' . $valuesTmp['title']);
  198. }
  199. return false;
  200. }
  201. }
  202. public function commitNewEntries(): bool {
  203. $sql = <<<'SQL'
  204. SET @rank=(SELECT MAX(id) - COUNT(*) FROM `_entrytmp`);
  205. INSERT IGNORE INTO `_entry` (
  206. id, guid, title, author, content_bin, link, date, `lastSeen`,
  207. hash, is_read, is_favorite, id_feed, tags, attributes
  208. )
  209. SELECT @rank:=@rank+1 AS id, guid, title, author, content_bin, link, date, `lastSeen`, hash, is_read, is_favorite, id_feed, tags, attributes
  210. FROM `_entrytmp`
  211. ORDER BY date, id;
  212. DELETE FROM `_entrytmp` WHERE id <= @rank;
  213. SQL;
  214. $hadTransaction = $this->pdo->inTransaction();
  215. if (!$hadTransaction) {
  216. $this->pdo->beginTransaction();
  217. }
  218. $result = $this->pdo->exec($sql) !== false;
  219. if (!$hadTransaction) {
  220. $this->pdo->commit();
  221. }
  222. return $result;
  223. }
  224. private PDOStatement|null|false $updateEntryPrepared = null;
  225. /** @param array{'id':string,'guid':string,'title':string,'author':string,'content':string,'link':string,'date':int,'lastSeen':int,'hash':string,
  226. * 'is_read':bool|int|null,'is_favorite':bool|int|null,'id_feed':int,'tags':string,'attributes':array<string,mixed>} $valuesTmp */
  227. public function updateEntry(array $valuesTmp): bool {
  228. if (!isset($valuesTmp['is_read'])) {
  229. $valuesTmp['is_read'] = null;
  230. }
  231. if (!isset($valuesTmp['is_favorite'])) {
  232. $valuesTmp['is_favorite'] = null;
  233. }
  234. if ($this->updateEntryPrepared == null) {
  235. $sql = 'UPDATE `_entry` '
  236. . 'SET title=:title, author=:author, '
  237. . (static::isCompressed() ? 'content_bin=COMPRESS(:content)' : 'content=:content')
  238. . ', link=:link, date=:date, `lastSeen`=:last_seen'
  239. . ', hash=' . static::sqlHexDecode(':hash')
  240. . ', is_read=COALESCE(:is_read, is_read)'
  241. . ', is_favorite=COALESCE(:is_favorite, is_favorite)'
  242. . ', tags=:tags, attributes=:attributes '
  243. . 'WHERE id_feed=:id_feed AND guid=:guid';
  244. $this->updateEntryPrepared = $this->pdo->prepare($sql);
  245. }
  246. if ($this->updateEntryPrepared != false) {
  247. $valuesTmp['guid'] = substr($valuesTmp['guid'], 0, 767);
  248. $valuesTmp['guid'] = safe_ascii($valuesTmp['guid']);
  249. $this->updateEntryPrepared->bindParam(':guid', $valuesTmp['guid']);
  250. $valuesTmp['title'] = mb_strcut($valuesTmp['title'], 0, 8192, 'UTF-8');
  251. $valuesTmp['title'] = safe_utf8($valuesTmp['title']);
  252. $this->updateEntryPrepared->bindParam(':title', $valuesTmp['title']);
  253. $valuesTmp['author'] = mb_strcut($valuesTmp['author'], 0, 1024, 'UTF-8');
  254. $valuesTmp['author'] = safe_utf8($valuesTmp['author']);
  255. $this->updateEntryPrepared->bindParam(':author', $valuesTmp['author']);
  256. $valuesTmp['content'] = safe_utf8($valuesTmp['content']);
  257. $this->updateEntryPrepared->bindParam(':content', $valuesTmp['content']);
  258. $valuesTmp['link'] = substr($valuesTmp['link'], 0, 16383);
  259. $valuesTmp['link'] = safe_ascii($valuesTmp['link']);
  260. $this->updateEntryPrepared->bindParam(':link', $valuesTmp['link']);
  261. $this->updateEntryPrepared->bindParam(':date', $valuesTmp['date'], PDO::PARAM_INT);
  262. $this->updateEntryPrepared->bindParam(':last_seen', $valuesTmp['lastSeen'], PDO::PARAM_INT);
  263. if ($valuesTmp['is_read'] === null) {
  264. $this->updateEntryPrepared->bindValue(':is_read', null, PDO::PARAM_NULL);
  265. } else {
  266. $this->updateEntryPrepared->bindValue(':is_read', $valuesTmp['is_read'] ? 1 : 0, PDO::PARAM_INT);
  267. }
  268. if ($valuesTmp['is_favorite'] === null) {
  269. $this->updateEntryPrepared->bindValue(':is_favorite', null, PDO::PARAM_NULL);
  270. } else {
  271. $this->updateEntryPrepared->bindValue(':is_favorite', $valuesTmp['is_favorite'] ? 1 : 0, PDO::PARAM_INT);
  272. }
  273. $this->updateEntryPrepared->bindParam(':id_feed', $valuesTmp['id_feed'], PDO::PARAM_INT);
  274. $valuesTmp['tags'] = mb_strcut($valuesTmp['tags'], 0, 2048, 'UTF-8');
  275. $valuesTmp['tags'] = safe_utf8($valuesTmp['tags']);
  276. $this->updateEntryPrepared->bindParam(':tags', $valuesTmp['tags']);
  277. if (!isset($valuesTmp['attributes'])) {
  278. $valuesTmp['attributes'] = [];
  279. }
  280. $this->updateEntryPrepared->bindValue(':attributes', is_string($valuesTmp['attributes']) ? $valuesTmp['attributes'] :
  281. json_encode($valuesTmp['attributes'], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
  282. if (static::hasNativeHex()) {
  283. $this->updateEntryPrepared->bindParam(':hash', $valuesTmp['hash']);
  284. } else {
  285. $valuesTmp['hashBin'] = hex2bin($valuesTmp['hash']);
  286. $this->updateEntryPrepared->bindParam(':hash', $valuesTmp['hashBin']);
  287. }
  288. }
  289. if ($this->updateEntryPrepared != false && $this->updateEntryPrepared->execute()) {
  290. return true;
  291. } else {
  292. $info = $this->updateEntryPrepared == false ? $this->pdo->errorInfo() : $this->updateEntryPrepared->errorInfo();
  293. /** @var array{id:string,guid:string,title:string,author:string,content:string,link:string,date:int,lastSeen:int,hash:string,
  294. * is_read:bool|int|null,is_favorite:bool|int|null,id_feed:int,tags:string,attributes:array<string,mixed>} $valuesTmp */
  295. /** @var array{0:string,1:int,2:string} $info */
  296. if ($this->autoUpdateDb($info)) {
  297. return $this->updateEntry($valuesTmp);
  298. }
  299. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info)
  300. . ' while updating entry with GUID ' . $valuesTmp['guid'] . ' in feed ' . $valuesTmp['id_feed']);
  301. return false;
  302. }
  303. }
  304. /**
  305. * Count the number of new entries in the temporary table (which have not yet been committed).
  306. */
  307. public function countNewEntries(): int {
  308. $sql = <<<'SQL'
  309. SELECT COUNT(id) AS nb_entries FROM `_entrytmp`
  310. SQL;
  311. $res = $this->fetchColumn($sql, 0);
  312. return isset($res[0]) ? (int)$res[0] : -1;
  313. }
  314. /**
  315. * Toggle favorite marker on one or more article
  316. *
  317. * @todo simplify the query by removing the str_repeat. I am pretty sure
  318. * there is an other way to do that.
  319. *
  320. * @param numeric-string|list<numeric-string> $ids
  321. */
  322. public function markFavorite(string|array $ids, bool $is_favorite = true): int|false {
  323. if (!is_array($ids)) {
  324. $ids = [$ids];
  325. }
  326. if (count($ids) < 1) {
  327. return 0;
  328. }
  329. FreshRSS_UserDAO::touch();
  330. if (count($ids) > FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER) {
  331. // Split a query with too many variables parameters
  332. $affected = 0;
  333. $idsChunks = array_chunk($ids, FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER);
  334. foreach ($idsChunks as $idsChunk) {
  335. $affected += ($this->markFavorite($idsChunk, $is_favorite) ?: 0);
  336. }
  337. return $affected;
  338. }
  339. $sql = 'UPDATE `_entry` '
  340. . 'SET is_favorite=? '
  341. . 'WHERE id IN (' . str_repeat('?,', count($ids) - 1) . '?)';
  342. $values = [$is_favorite ? 1 : 0];
  343. $values = array_merge($values, $ids);
  344. $stm = $this->pdo->prepare($sql);
  345. if ($stm !== false && $stm->execute($values)) {
  346. Minz_ExtensionManager::callHook('entries_favorite', $ids, $is_favorite);
  347. return $stm->rowCount();
  348. } else {
  349. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  350. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  351. return false;
  352. }
  353. }
  354. /**
  355. * Update the unread article cache held on every feed details.
  356. * Depending on the parameters, it updates the cache on one feed, on all
  357. * feeds from one category or on all feeds.
  358. */
  359. protected function updateCacheUnreads(?int $catId = null, ?int $feedId = null): bool {
  360. // Help MySQL/MariaDB's optimizer with the query plan:
  361. $useIndex = $this->pdo->dbType() === 'mysql' ? 'USE INDEX (entry_feed_read_index)' : '';
  362. $sql = <<<SQL
  363. UPDATE `_feed`
  364. SET `cache_nbUnreads`=(
  365. SELECT COUNT(*) AS nbUnreads FROM `_entry` e {$useIndex}
  366. WHERE e.id_feed=`_feed`.id AND e.is_read=0)
  367. SQL;
  368. $hasWhere = false;
  369. $values = [];
  370. if ($feedId != null) {
  371. $sql .= ' WHERE';
  372. $hasWhere = true;
  373. $sql .= ' id=?';
  374. $values[] = $feedId;
  375. }
  376. if ($catId != null) {
  377. $sql .= $hasWhere ? ' AND' : ' WHERE';
  378. $hasWhere = true;
  379. $sql .= ' category=?';
  380. $values[] = $catId;
  381. }
  382. $stm = $this->pdo->prepare($sql);
  383. if ($stm !== false && $stm->execute($values)) {
  384. return true;
  385. } else {
  386. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  387. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  388. return false;
  389. }
  390. }
  391. /**
  392. * Toggle the read marker on one or more article.
  393. * Then the cache is updated.
  394. *
  395. * @param numeric-string|list<numeric-string> $ids
  396. * @return int|false affected rows
  397. */
  398. public function markRead(array|string $ids, bool $is_read = true): int|false {
  399. if (is_array($ids)) { //Many IDs at once
  400. if (count($ids) < 6) { //Speed heuristics
  401. $affected = 0;
  402. foreach ($ids as $id) {
  403. $affected += ($this->markRead($id, $is_read) ?: 0);
  404. }
  405. return $affected;
  406. } elseif (count($ids) > FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER) {
  407. // Split a query with too many variables parameters
  408. $affected = 0;
  409. $idsChunks = array_chunk($ids, FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER);
  410. foreach ($idsChunks as $idsChunk) {
  411. $affected += ($this->markRead($idsChunk, $is_read) ?: 0);
  412. }
  413. return $affected;
  414. }
  415. FreshRSS_UserDAO::touch();
  416. $sql = 'UPDATE `_entry` '
  417. . 'SET is_read=? '
  418. . 'WHERE id IN (' . str_repeat('?,', count($ids) - 1) . '?)';
  419. $values = [$is_read ? 1 : 0];
  420. $values = array_merge($values, $ids);
  421. $stm = $this->pdo->prepare($sql);
  422. if ($stm === false || !$stm->execute($values)) {
  423. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  424. Minz_Log::error('SQL error ' . __METHOD__ . ' A ' . json_encode($info));
  425. return false;
  426. }
  427. $affected = $stm->rowCount();
  428. if (($affected > 0) && (!$this->updateCacheUnreads(null, null))) {
  429. return false;
  430. }
  431. return $affected;
  432. } else {
  433. FreshRSS_UserDAO::touch();
  434. $sql = 'UPDATE `_entry` e INNER JOIN `_feed` f ON e.id_feed=f.id '
  435. . 'SET e.is_read=?,'
  436. . 'f.`cache_nbUnreads`=f.`cache_nbUnreads`' . ($is_read ? '-' : '+') . '1 '
  437. . 'WHERE e.id=? AND e.is_read=?';
  438. $values = [$is_read ? 1 : 0, $ids, $is_read ? 0 : 1];
  439. $stm = $this->pdo->prepare($sql);
  440. if ($stm !== false && $stm->execute($values)) {
  441. return $stm->rowCount();
  442. } else {
  443. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  444. Minz_Log::error('SQL error ' . __METHOD__ . ' B ' . json_encode($info));
  445. return false;
  446. }
  447. }
  448. }
  449. /**
  450. * Mark all entries as read depending on parameters.
  451. * If $onlyFavorites is true, it is used when the user mark as read in
  452. * the favorite pseudo-category.
  453. * If $priorityMin is greater than 0, it is used when the user mark as
  454. * read in the main feed pseudo-category.
  455. * Then the cache is updated.
  456. *
  457. * If $idMax equals 0, a deprecated debug message is logged
  458. *
  459. * @param numeric-string $idMax fail safe article ID
  460. * @return int|false affected rows
  461. */
  462. public function markReadEntries(string $idMax = '0', bool $onlyFavorites = false, ?int $priorityMin = null, ?int $priorityMax = null,
  463. ?FreshRSS_BooleanSearch $filters = null, int $state = 0, bool $is_read = true) {
  464. FreshRSS_UserDAO::touch();
  465. if ($idMax == '0') {
  466. $idMax = uTimeString();
  467. Minz_Log::debug('Calling markReadEntries(0) is deprecated!');
  468. }
  469. $sql = 'UPDATE `_entry` SET is_read = ? WHERE is_read <> ? AND id <= ?';
  470. $values = [$is_read ? 1 : 0, $is_read ? 1 : 0, $idMax];
  471. if ($onlyFavorites) {
  472. $sql .= ' AND is_favorite=1';
  473. }
  474. if ($priorityMin !== null || $priorityMax !== null) {
  475. $sql .= ' AND id_feed IN (SELECT f.id FROM `_feed` f WHERE 1=1';
  476. if ($priorityMin !== null) {
  477. $sql .= ' AND f.priority >= ?';
  478. $values[] = $priorityMin;
  479. }
  480. if ($priorityMax !== null) {
  481. $sql .= ' AND f.priority < ?';
  482. $values[] = $priorityMax;
  483. }
  484. $sql .= ')';
  485. }
  486. [$searchValues, $search] = $this->sqlListEntriesWhere(alias: '', state: $state, filters: $filters);
  487. $stm = $this->pdo->prepare($sql . $search);
  488. if ($stm === false || !$stm->execute(array_merge($values, $searchValues))) {
  489. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  490. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  491. return false;
  492. }
  493. $affected = $stm->rowCount();
  494. if (($affected > 0) && (!$this->updateCacheUnreads(null, null))) {
  495. return false;
  496. }
  497. return $affected;
  498. }
  499. /**
  500. * Mark all the articles in a category as read.
  501. * There is a fail safe to prevent to mark as read articles that are
  502. * loaded during the mark as read action. Then the cache is updated.
  503. *
  504. * If $idMax equals 0, a deprecated debug message is logged
  505. *
  506. * @param int $id category ID
  507. * @param numeric-string $idMax fail safe article ID
  508. * @return int|false affected rows
  509. */
  510. public function markReadCat(int $id, string $idMax = '0', ?FreshRSS_BooleanSearch $filters = null, int $state = 0, bool $is_read = true): int|false {
  511. FreshRSS_UserDAO::touch();
  512. if ($idMax == '0') {
  513. $idMax = uTimeString();
  514. Minz_Log::debug('Calling markReadCat(0) is deprecated!');
  515. }
  516. $sql = <<<'SQL'
  517. UPDATE `_entry`
  518. SET is_read = ?
  519. WHERE is_read <> ? AND id <= ?
  520. AND id_feed IN (SELECT f.id FROM `_feed` f WHERE f.category=?)
  521. SQL;
  522. $values = [$is_read ? 1 : 0, $is_read ? 1 : 0, $idMax, $id];
  523. [$searchValues, $search] = $this->sqlListEntriesWhere(alias: '', state: $state, filters: $filters);
  524. $stm = $this->pdo->prepare($sql . $search);
  525. if ($stm === false || !$stm->execute(array_merge($values, $searchValues))) {
  526. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  527. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  528. return false;
  529. }
  530. $affected = $stm->rowCount();
  531. if (($affected > 0) && (!$this->updateCacheUnreads($id, null))) {
  532. return false;
  533. }
  534. return $affected;
  535. }
  536. /**
  537. * Mark all the articles in a feed as read.
  538. * There is a fail safe to prevent to mark as read articles that are
  539. * loaded during the mark as read action. Then the cache is updated.
  540. *
  541. * If $idMax equals 0, a deprecated debug message is logged
  542. *
  543. * @param int $id_feed feed ID
  544. * @param numeric-string $idMax fail safe article ID
  545. * @return int|false affected rows
  546. */
  547. public function markReadFeed(int $id_feed, string $idMax = '0', ?FreshRSS_BooleanSearch $filters = null, int $state = 0, bool $is_read = true): int|false {
  548. FreshRSS_UserDAO::touch();
  549. if ($idMax == '0') {
  550. $idMax = uTimeString();
  551. Minz_Log::debug('Calling markReadFeed(0) is deprecated!');
  552. }
  553. $hadTransaction = $this->pdo->inTransaction();
  554. if (!$hadTransaction) {
  555. $this->pdo->beginTransaction();
  556. }
  557. $sql = 'UPDATE `_entry` '
  558. . 'SET is_read=? '
  559. . 'WHERE id_feed=? AND is_read <> ? AND id <= ?';
  560. $values = [$is_read ? 1 : 0, $id_feed, $is_read ? 1 : 0, $idMax];
  561. [$searchValues, $search] = $this->sqlListEntriesWhere(alias: '', state: $state, filters: $filters);
  562. $stm = $this->pdo->prepare($sql . $search);
  563. if ($stm === false || !$stm->execute(array_merge($values, $searchValues))) {
  564. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  565. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info) . ' with SQL: ' . $sql . $search);
  566. $this->pdo->rollBack();
  567. return false;
  568. }
  569. $affected = $stm->rowCount();
  570. if ($affected > 0) {
  571. $sql = 'UPDATE `_feed` '
  572. . 'SET `cache_nbUnreads`=`cache_nbUnreads`-' . $affected
  573. . ' WHERE id=:id';
  574. $stm = $this->pdo->prepare($sql);
  575. if (!($stm !== false &&
  576. $stm->bindParam(':id', $id_feed, PDO::PARAM_INT) &&
  577. $stm->execute())) {
  578. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  579. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  580. $this->pdo->rollBack();
  581. return false;
  582. }
  583. }
  584. if (!$hadTransaction) {
  585. $this->pdo->commit();
  586. }
  587. return $affected;
  588. }
  589. /**
  590. * Mark all the articles in a tag as read.
  591. * @param int $id tag ID, or empty for targeting any tag
  592. * @param numeric-string $idMax max article ID
  593. * @return int|false affected rows
  594. */
  595. public function markReadTag(int $id = 0, string $idMax = '0', ?FreshRSS_BooleanSearch $filters = null,
  596. int $state = 0, bool $is_read = true) {
  597. FreshRSS_UserDAO::touch();
  598. if ($idMax == '0') {
  599. $idMax = uTimeString();
  600. Minz_Log::debug('Calling markReadTag(0) is deprecated!');
  601. }
  602. $sql = 'UPDATE `_entry` e INNER JOIN `_entrytag` et ON et.id_entry = e.id '
  603. . 'SET e.is_read = ? '
  604. . 'WHERE '
  605. . ($id == 0 ? '' : 'et.id_tag = ? AND ')
  606. . 'e.is_read <> ? AND e.id <= ?';
  607. $values = [$is_read ? 1 : 0];
  608. if ($id != 0) {
  609. $values[] = $id;
  610. }
  611. $values[] = $is_read ? 1 : 0;
  612. $values[] = $idMax;
  613. [$searchValues, $search] = $this->sqlListEntriesWhere(alias: 'e.', state: $state, filters: $filters);
  614. $stm = $this->pdo->prepare($sql . $search);
  615. if ($stm === false || !$stm->execute(array_merge($values, $searchValues))) {
  616. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  617. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  618. return false;
  619. }
  620. $affected = $stm->rowCount();
  621. if (($affected > 0) && (!$this->updateCacheUnreads(null, null))) {
  622. return false;
  623. }
  624. return $affected;
  625. }
  626. /**
  627. * Remember to call updateCachedValues($id_feed) or updateCachedValues() just after.
  628. * @param array<string,bool|int|string> $options
  629. */
  630. public function cleanOldEntries(int $id_feed, array $options = []): int|false {
  631. $sql = 'DELETE FROM `_entry` WHERE id_feed = :id_feed1'; //No alias for MySQL / MariaDB
  632. $params = [];
  633. $params[':id_feed1'] = $id_feed;
  634. //==Exclusions==
  635. if (!empty($options['keep_favourites'])) {
  636. $sql .= ' AND is_favorite = 0';
  637. }
  638. if (!empty($options['keep_unreads'])) {
  639. $sql .= ' AND is_read = 1';
  640. }
  641. if (!empty($options['keep_labels'])) {
  642. $sql .= ' AND NOT EXISTS (SELECT 1 FROM `_entrytag` WHERE id_entry = id)';
  643. }
  644. if (!empty($options['keep_min']) && $options['keep_min'] > 0) {
  645. //Double SELECT for MySQL workaround ERROR 1093 (HY000)
  646. $sql .= ' AND `lastSeen` < (SELECT `lastSeen`'
  647. . ' FROM (SELECT e2.`lastSeen` FROM `_entry` e2 WHERE e2.id_feed = :id_feed2'
  648. . ' ORDER BY e2.`lastSeen` DESC LIMIT 1 OFFSET :keep_min) last_seen2)';
  649. $params[':id_feed2'] = $id_feed;
  650. $params[':keep_min'] = (int)$options['keep_min'];
  651. }
  652. //Keep at least the articles seen at the last refresh
  653. $sql .= ' AND `lastSeen` < (SELECT maxlastseen'
  654. . ' FROM (SELECT MAX(e3.`lastSeen`) AS maxlastseen FROM `_entry` e3 WHERE e3.id_feed = :id_feed3) last_seen3)';
  655. $params[':id_feed3'] = $id_feed;
  656. //==Inclusions==
  657. $sql .= ' AND (1=0';
  658. if (!empty($options['keep_period']) && is_string($options['keep_period'])) {
  659. $sql .= ' OR `lastSeen` < :max_last_seen';
  660. $now = new DateTime('now');
  661. $now->sub(new DateInterval($options['keep_period']));
  662. $params[':max_last_seen'] = $now->format('U');
  663. }
  664. if (!empty($options['keep_max']) && $options['keep_max'] > 0) {
  665. $sql .= ' OR `lastSeen` <= (SELECT `lastSeen`'
  666. . ' FROM (SELECT e4.`lastSeen` FROM `_entry` e4 WHERE e4.id_feed = :id_feed4'
  667. . ' ORDER BY e4.`lastSeen` DESC LIMIT 1 OFFSET :keep_max) last_seen4)';
  668. $params[':id_feed4'] = $id_feed;
  669. $params[':keep_max'] = (int)$options['keep_max'];
  670. }
  671. $sql .= ')';
  672. $stm = $this->pdo->prepare($sql);
  673. if ($stm !== false && $stm->execute($params)) {
  674. return $stm->rowCount();
  675. } else {
  676. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  677. /** @var array{0:string,1:int,2:string} $info */
  678. if ($this->autoUpdateDb($info)) {
  679. return $this->cleanOldEntries($id_feed, $options);
  680. }
  681. Minz_Log::error(__METHOD__ . ' error:' . json_encode($info));
  682. return false;
  683. }
  684. }
  685. /** @return Traversable<array{id:string,guid:string,title:string,author:string,content:string,link:string,date:int,lastSeen:int,
  686. * hash:string,is_read:bool,is_favorite:bool,id_feed:int,tags:string,attributes:?string}> */
  687. public function selectAll(?int $limit = null): Traversable {
  688. $content = static::isCompressed() ? 'UNCOMPRESS(content_bin) AS content' : 'content';
  689. $hash = static::sqlHexEncode('hash');
  690. $sql = <<<SQL
  691. SELECT id, guid, title, author, {$content}, link, date, `lastSeen`, {$hash} AS hash, is_read, is_favorite, id_feed, tags, attributes
  692. FROM `_entry`
  693. SQL;
  694. if (is_int($limit) && $limit >= 0) {
  695. $sql .= ' ORDER BY id DESC LIMIT ' . $limit;
  696. }
  697. $stm = $this->pdo->query($sql);
  698. if ($stm !== false) {
  699. while (is_array($row = $stm->fetch(PDO::FETCH_ASSOC))) {
  700. /** @var array{id:string,guid:string,title:string,author:string,content:string,link:string,date:int,lastSeen:int,
  701. * hash:string,is_read:bool,is_favorite:bool,id_feed:int,tags:string,attributes:?string} $row */
  702. yield $row;
  703. }
  704. } else {
  705. $info = $this->pdo->errorInfo();
  706. /** @var array{0:string,1:int,2:string} $info */
  707. if ($this->autoUpdateDb($info)) {
  708. yield from $this->selectAll();
  709. } else {
  710. Minz_Log::error(__METHOD__ . ' error: ' . json_encode($info));
  711. }
  712. }
  713. }
  714. public function searchByGuid(int $id_feed, string $guid): ?FreshRSS_Entry {
  715. $content = static::isCompressed() ? 'UNCOMPRESS(content_bin) AS content' : 'content';
  716. $hash = static::sqlHexEncode('hash');
  717. $sql = <<<SQL
  718. SELECT id, guid, title, author, link, date, is_read, is_favorite, {$hash} AS hash, id_feed, tags, attributes, {$content}
  719. FROM `_entry` WHERE id_feed=:id_feed AND guid=:guid
  720. SQL;
  721. $res = $this->fetchAssoc($sql, [':id_feed' => $id_feed, ':guid' => $guid]);
  722. /** @var list<array{id:string,id_feed:int,guid:string,title:string,author:string,content:string,link:string,date:int,
  723. * is_read:int,is_favorite:int,tags:string,attributes:?string}> $res */
  724. return isset($res[0]) ? FreshRSS_Entry::fromArray($res[0]) : null;
  725. }
  726. public function searchById(string $id): ?FreshRSS_Entry {
  727. $content = static::isCompressed() ? 'UNCOMPRESS(content_bin) AS content' : 'content';
  728. $hash = static::sqlHexEncode('hash');
  729. $sql = <<<SQL
  730. SELECT id, guid, title, author, link, date, is_read, is_favorite, {$hash} AS hash, id_feed, tags, attributes, {$content}
  731. FROM `_entry` WHERE id=:id
  732. SQL;
  733. $res = $this->fetchAssoc($sql, [':id' => $id]);
  734. /** @var list<array{'id':string,'id_feed':int,'guid':string,'title':string,'author':string,'content':string,'link':string,'date':int,
  735. * 'is_read':int,'is_favorite':int,'tags':string,'attributes':?string}> $res */
  736. return isset($res[0]) ? FreshRSS_Entry::fromArray($res[0]) : null;
  737. }
  738. public function searchIdByGuid(int $id_feed, string $guid): ?string {
  739. $sql = 'SELECT id FROM `_entry` WHERE id_feed=:id_feed AND guid=:guid';
  740. $res = $this->fetchColumn($sql, 0, [':id_feed' => $id_feed, ':guid' => $guid]);
  741. return empty($res[0]) ? null : (string)($res[0]);
  742. }
  743. /** @return array{0:list<int|string>,1:string} */
  744. public static function sqlBooleanSearch(string $alias, FreshRSS_BooleanSearch $filters, int $level = 0): array {
  745. $search = '';
  746. $values = [];
  747. $isOpen = false;
  748. foreach ($filters->searches() as $filter) {
  749. if ($filter == null) {
  750. continue;
  751. }
  752. if ($filter instanceof FreshRSS_BooleanSearch) {
  753. // BooleanSearches are combined by AND (default) or OR (special case) operator and are recursive
  754. [$filterValues, $filterSearch] = self::sqlBooleanSearch($alias, $filter, $level + 1);
  755. $filterSearch = trim($filterSearch);
  756. if ($filterSearch !== '') {
  757. if ($search !== '') {
  758. $search .= $filter->operator();
  759. } elseif (in_array($filter->operator(), ['AND NOT', 'OR NOT'], true)) {
  760. // Special case if we start with a negation (there is already the default AND before)
  761. $search .= ' NOT';
  762. }
  763. $search .= ' (' . $filterSearch . ') ';
  764. $values = array_merge($values, $filterValues);
  765. }
  766. continue;
  767. }
  768. // Searches are combined by OR and are not recursive
  769. $sub_search = '';
  770. if ($filter->getEntryIds() !== null) {
  771. $sub_search .= 'AND ' . $alias . 'id IN (';
  772. foreach ($filter->getEntryIds() as $entry_id) {
  773. $sub_search .= '?,';
  774. $values[] = $entry_id;
  775. }
  776. $sub_search = rtrim($sub_search, ',');
  777. $sub_search .= ') ';
  778. }
  779. if ($filter->getNotEntryIds() !== null) {
  780. $sub_search .= 'AND ' . $alias . 'id NOT IN (';
  781. foreach ($filter->getNotEntryIds() as $entry_id) {
  782. $sub_search .= '?,';
  783. $values[] = $entry_id;
  784. }
  785. $sub_search = rtrim($sub_search, ',');
  786. $sub_search .= ') ';
  787. }
  788. if ($filter->getMinDate() !== null) {
  789. $sub_search .= 'AND ' . $alias . 'id >= ? ';
  790. $values[] = "{$filter->getMinDate()}000000";
  791. }
  792. if ($filter->getMaxDate() !== null) {
  793. $sub_search .= 'AND ' . $alias . 'id <= ? ';
  794. $values[] = "{$filter->getMaxDate()}000000";
  795. }
  796. if ($filter->getMinPubdate() !== null) {
  797. $sub_search .= 'AND ' . $alias . 'date >= ? ';
  798. $values[] = $filter->getMinPubdate();
  799. }
  800. if ($filter->getMaxPubdate() !== null) {
  801. $sub_search .= 'AND ' . $alias . 'date <= ? ';
  802. $values[] = $filter->getMaxPubdate();
  803. }
  804. //Negation of date intervals must be combined by OR
  805. if ($filter->getNotMinDate() !== null || $filter->getNotMaxDate() !== null) {
  806. $sub_search .= 'AND (';
  807. if ($filter->getNotMinDate() !== null) {
  808. $sub_search .= $alias . 'id < ?';
  809. $values[] = "{$filter->getNotMinDate()}000000";
  810. if ($filter->getNotMaxDate()) {
  811. $sub_search .= ' OR ';
  812. }
  813. }
  814. if ($filter->getNotMaxDate() !== null) {
  815. $sub_search .= $alias . 'id > ?';
  816. $values[] = "{$filter->getNotMaxDate()}000000";
  817. }
  818. $sub_search .= ') ';
  819. }
  820. if ($filter->getNotMinPubdate() !== null || $filter->getNotMaxPubdate() !== null) {
  821. $sub_search .= 'AND (';
  822. if ($filter->getNotMinPubdate() !== null) {
  823. $sub_search .= $alias . 'date < ?';
  824. $values[] = $filter->getNotMinPubdate();
  825. if ($filter->getNotMaxPubdate()) {
  826. $sub_search .= ' OR ';
  827. }
  828. }
  829. if ($filter->getNotMaxPubdate() !== null) {
  830. $sub_search .= $alias . 'date > ?';
  831. $values[] = $filter->getNotMaxPubdate();
  832. }
  833. $sub_search .= ') ';
  834. }
  835. if ($filter->getFeedIds() !== null) {
  836. $sub_search .= 'AND ' . $alias . 'id_feed IN (';
  837. foreach ($filter->getFeedIds() as $feed_id) {
  838. $sub_search .= '?,';
  839. $values[] = $feed_id;
  840. }
  841. $sub_search = rtrim($sub_search, ',');
  842. $sub_search .= ') ';
  843. }
  844. if ($filter->getNotFeedIds() !== null) {
  845. $sub_search .= 'AND ' . $alias . 'id_feed NOT IN (';
  846. foreach ($filter->getNotFeedIds() as $feed_id) {
  847. $sub_search .= '?,';
  848. $values[] = $feed_id;
  849. }
  850. $sub_search = rtrim($sub_search, ',');
  851. $sub_search .= ') ';
  852. }
  853. if ($filter->getCategoryIds() !== null) {
  854. $sub_search .= 'AND ' . $alias . 'id_feed IN (SELECT f.id FROM `_feed` f WHERE f.category IN (';
  855. foreach ($filter->getCategoryIds() as $category_id) {
  856. $sub_search .= '?,';
  857. $values[] = $category_id;
  858. }
  859. $sub_search = rtrim($sub_search, ',');
  860. $sub_search .= ')) ';
  861. }
  862. if ($filter->getNotCategoryIds() !== null) {
  863. $sub_search .= 'AND ' . $alias . 'id_feed NOT IN (SELECT f.id FROM `_feed` f WHERE f.category IN (';
  864. foreach ($filter->getNotCategoryIds() as $category_id) {
  865. $sub_search .= '?,';
  866. $values[] = $category_id;
  867. }
  868. $sub_search = rtrim($sub_search, ',');
  869. $sub_search .= ')) ';
  870. }
  871. if ($filter->getLabelIds() !== null) {
  872. if ($filter->getLabelIds() === '*') {
  873. $sub_search .= 'AND EXISTS (SELECT et.id_tag FROM `_entrytag` et WHERE et.id_entry = ' . $alias . 'id) ';
  874. } else {
  875. $sub_search .= 'AND ' . $alias . 'id IN (SELECT et.id_entry FROM `_entrytag` et WHERE et.id_tag IN (';
  876. foreach ($filter->getLabelIds() as $label_id) {
  877. $sub_search .= '?,';
  878. $values[] = $label_id;
  879. }
  880. $sub_search = rtrim($sub_search, ',');
  881. $sub_search .= ')) ';
  882. }
  883. }
  884. if ($filter->getNotLabelIds() !== null) {
  885. if ($filter->getNotLabelIds() === '*') {
  886. $sub_search .= 'AND NOT EXISTS (SELECT et.id_tag FROM `_entrytag` et WHERE et.id_entry = ' . $alias . 'id) ';
  887. } else {
  888. $sub_search .= 'AND ' . $alias . 'id NOT IN (SELECT et.id_entry FROM `_entrytag` et WHERE et.id_tag IN (';
  889. foreach ($filter->getNotLabelIds() as $label_id) {
  890. $sub_search .= '?,';
  891. $values[] = $label_id;
  892. }
  893. $sub_search = rtrim($sub_search, ',');
  894. $sub_search .= ')) ';
  895. }
  896. }
  897. if ($filter->getLabelNames() !== null) {
  898. $sub_search .= 'AND ' . $alias . 'id IN (SELECT et.id_entry FROM `_entrytag` et, `_tag` t WHERE et.id_tag = t.id AND t.name IN (';
  899. foreach ($filter->getLabelNames() as $label_name) {
  900. $sub_search .= '?,';
  901. $values[] = $label_name;
  902. }
  903. $sub_search = rtrim($sub_search, ',');
  904. $sub_search .= ')) ';
  905. }
  906. if ($filter->getNotLabelNames() !== null) {
  907. $sub_search .= 'AND ' . $alias . 'id NOT IN (SELECT et.id_entry FROM `_entrytag` et, `_tag` t WHERE et.id_tag = t.id AND t.name IN (';
  908. foreach ($filter->getNotLabelNames() as $label_name) {
  909. $sub_search .= '?,';
  910. $values[] = $label_name;
  911. }
  912. $sub_search = rtrim($sub_search, ',');
  913. $sub_search .= ')) ';
  914. }
  915. if ($filter->getAuthor() !== null) {
  916. foreach ($filter->getAuthor() as $author) {
  917. $sub_search .= 'AND ' . $alias . 'author LIKE ? ';
  918. $values[] = "%{$author}%";
  919. }
  920. }
  921. if ($filter->getAuthorRegex() !== null) {
  922. foreach ($filter->getAuthorRegex() as $author) {
  923. $sub_search .= 'AND ' . static::sqlRegex("REPLACE({$alias}author, ';', '\n')", $author, $values) . ' ';
  924. }
  925. }
  926. if ($filter->getIntitle() !== null) {
  927. foreach ($filter->getIntitle() as $title) {
  928. $sub_search .= 'AND ' . $alias . 'title LIKE ? ';
  929. $values[] = "%{$title}%";
  930. }
  931. }
  932. if ($filter->getIntitleRegex() !== null) {
  933. foreach ($filter->getIntitleRegex() as $title) {
  934. $sub_search .= 'AND ' . static::sqlRegex($alias . 'title', $title, $values) . ' ';
  935. }
  936. }
  937. if ($filter->getIntext() !== null) {
  938. if (static::isCompressed()) { // MySQL-only
  939. foreach ($filter->getIntext() as $content) {
  940. $sub_search .= "AND UNCOMPRESS({$alias}content_bin) LIKE ? ";
  941. $values[] = "%{$content}%";
  942. }
  943. } else {
  944. foreach ($filter->getIntext() as $content) {
  945. $sub_search .= 'AND ' . $alias . 'content LIKE ? ';
  946. $values[] = "%{$content}%";
  947. }
  948. }
  949. }
  950. if ($filter->getIntextRegex() !== null) {
  951. if (static::isCompressed()) { // MySQL-only
  952. foreach ($filter->getIntextRegex() as $content) {
  953. $sub_search .= 'AND ' . static::sqlRegex("UNCOMPRESS({$alias}content_bin)", $content, $values) . ') ';
  954. }
  955. } else {
  956. foreach ($filter->getIntextRegex() as $content) {
  957. $sub_search .= 'AND ' . static::sqlRegex($alias . 'content', $content, $values) . ' ';
  958. }
  959. }
  960. }
  961. if ($filter->getTags() !== null) {
  962. foreach ($filter->getTags() as $tag) {
  963. $sub_search .= 'AND ' . static::sqlConcat('TRIM(' . $alias . 'tags) ', " ' #'") . ' LIKE ? ';
  964. $values[] = "%{$tag} #%";
  965. }
  966. }
  967. if ($filter->getTagsRegex() !== null) {
  968. foreach ($filter->getTagsRegex() as $tag) {
  969. $sub_search .= 'AND ' . static::sqlRegex("REPLACE(REPLACE({$alias}tags, ' #', '#'), '#', '\n')", $tag, $values) . ' ';
  970. }
  971. }
  972. if ($filter->getInurl() !== null) {
  973. foreach ($filter->getInurl() as $url) {
  974. $sub_search .= 'AND ' . $alias . 'link LIKE ? ';
  975. $values[] = "%{$url}%";
  976. }
  977. }
  978. if ($filter->getInurlRegex() !== null) {
  979. foreach ($filter->getInurlRegex() as $url) {
  980. $sub_search .= 'AND ' . static::sqlRegex($alias . 'link', $url, $values) . ' ';
  981. }
  982. }
  983. if ($filter->getNotAuthor() !== null) {
  984. foreach ($filter->getNotAuthor() as $author) {
  985. $sub_search .= 'AND ' . $alias . 'author NOT LIKE ? ';
  986. $values[] = "%{$author}%";
  987. }
  988. }
  989. if ($filter->getNotAuthorRegex() !== null) {
  990. foreach ($filter->getNotAuthorRegex() as $author) {
  991. $sub_search .= 'AND NOT ' . static::sqlRegex("REPLACE({$alias}author, ';', '\n')", $author, $values) . ' ';
  992. }
  993. }
  994. if ($filter->getNotIntitle() !== null) {
  995. foreach ($filter->getNotIntitle() as $title) {
  996. $sub_search .= 'AND ' . $alias . 'title NOT LIKE ? ';
  997. $values[] = "%{$title}%";
  998. }
  999. }
  1000. if ($filter->getNotIntitleRegex() !== null) {
  1001. foreach ($filter->getNotIntitleRegex() as $title) {
  1002. $sub_search .= 'AND NOT ' . static::sqlRegex($alias . 'title', $title, $values) . ' ';
  1003. }
  1004. }
  1005. if ($filter->getNotIntext() !== null) {
  1006. if (static::isCompressed()) { // MySQL-only
  1007. foreach ($filter->getNotIntext() as $content) {
  1008. $sub_search .= "AND UNCOMPRESS({$alias}content_bin) NOT LIKE ? ";
  1009. $values[] = "%{$content}%";
  1010. }
  1011. } else {
  1012. foreach ($filter->getNotIntext() as $content) {
  1013. $sub_search .= 'AND ' . $alias . 'content NOT LIKE ? ';
  1014. $values[] = "%{$content}%";
  1015. }
  1016. }
  1017. }
  1018. if ($filter->getNotIntextRegex() !== null) {
  1019. if (static::isCompressed()) { // MySQL-only
  1020. foreach ($filter->getNotIntextRegex() as $content) {
  1021. $sub_search .= 'AND NOT ' . static::sqlRegex("UNCOMPRESS({$alias}content_bin)", $content, $values) . ') ';
  1022. }
  1023. } else {
  1024. foreach ($filter->getNotIntextRegex() as $content) {
  1025. $sub_search .= 'AND NOT ' . static::sqlRegex($alias . 'content', $content, $values) . ' ';
  1026. }
  1027. }
  1028. }
  1029. if ($filter->getNotTags() !== null) {
  1030. foreach ($filter->getNotTags() as $tag) {
  1031. $sub_search .= 'AND ' . static::sqlConcat('TRIM(' . $alias . 'tags) ', " ' #'") . ' NOT LIKE ? ';
  1032. $values[] = "%{$tag} #%";
  1033. }
  1034. }
  1035. if ($filter->getNotTagsRegex() !== null) {
  1036. foreach ($filter->getNotTagsRegex() as $tag) {
  1037. $sub_search .= 'AND NOT ' . static::sqlRegex("REPLACE(REPLACE({$alias}tags, ' #', '#'), '#', '\n')", $tag, $values) . ' ';
  1038. }
  1039. }
  1040. if ($filter->getNotInurl() !== null) {
  1041. foreach ($filter->getNotInurl() as $url) {
  1042. $sub_search .= 'AND ' . $alias . 'link NOT LIKE ? ';
  1043. $values[] = "%{$url}%";
  1044. }
  1045. }
  1046. if ($filter->getNotInurlRegex() !== null) {
  1047. foreach ($filter->getNotInurlRegex() as $url) {
  1048. $sub_search .= 'AND NOT ' . static::sqlRegex($alias . 'link', $url, $values) . ' ';
  1049. }
  1050. }
  1051. if ($filter->getSearch() !== null) {
  1052. foreach ($filter->getSearch() as $search_value) {
  1053. if (static::isCompressed()) { // MySQL-only
  1054. $sub_search .= "AND CONCAT({$alias}title, '\\n', UNCOMPRESS({$alias}content_bin)) LIKE ? ";
  1055. $values[] = "%{$search_value}%";
  1056. } else {
  1057. $sub_search .= 'AND (' . $alias . 'title LIKE ? OR ' . $alias . 'content LIKE ?) ';
  1058. $values[] = "%{$search_value}%";
  1059. $values[] = "%{$search_value}%";
  1060. }
  1061. }
  1062. }
  1063. if ($filter->getSearchRegex() !== null) {
  1064. foreach ($filter->getSearchRegex() as $search_value) {
  1065. if (static::isCompressed()) { // MySQL-only
  1066. $sub_search .= 'AND (' . static::sqlRegex($alias . 'title', $search_value, $values) .
  1067. ' OR ' . static::sqlRegex("UNCOMPRESS({$alias}content_bin)", $search_value, $values) . ') ';
  1068. } else {
  1069. $sub_search .= 'AND (' . static::sqlRegex($alias . 'title', $search_value, $values) .
  1070. ' OR ' . static::sqlRegex($alias . 'content', $search_value, $values) . ') ';
  1071. }
  1072. }
  1073. }
  1074. if ($filter->getNotSearch() !== null) {
  1075. foreach ($filter->getNotSearch() as $search_value) {
  1076. if (static::isCompressed()) { // MySQL-only
  1077. $sub_search .= "AND CONCAT({$alias}title, '\\n', UNCOMPRESS({$alias}content_bin)) NOT LIKE ? ";
  1078. $values[] = "%{$search_value}%";
  1079. } else {
  1080. $sub_search .= 'AND ' . $alias . 'title NOT LIKE ? AND ' . $alias . 'content NOT LIKE ? ';
  1081. $values[] = "%{$search_value}%";
  1082. $values[] = "%{$search_value}%";
  1083. }
  1084. }
  1085. }
  1086. if ($filter->getNotSearchRegex() !== null) {
  1087. foreach ($filter->getNotSearchRegex() as $search_value) {
  1088. if (static::isCompressed()) { // MySQL-only
  1089. $sub_search .= 'AND NOT ' . static::sqlRegex($alias . 'title', $search_value, $values) .
  1090. ' ANT NOT ' . static::sqlRegex("UNCOMPRESS({$alias}content_bin)", $search_value, $values) . ' ';
  1091. } else {
  1092. $sub_search .= 'AND NOT ' . static::sqlRegex($alias . 'title', $search_value, $values) .
  1093. ' AND NOT ' . static::sqlRegex($alias . 'content', $search_value, $values) . ' ';
  1094. }
  1095. }
  1096. }
  1097. if ($sub_search != '') {
  1098. if ($isOpen) {
  1099. $search .= ' OR ';
  1100. } else {
  1101. $isOpen = true;
  1102. }
  1103. // Remove superfluous leading 'AND '
  1104. $search .= '(' . substr($sub_search, 4) . ')';
  1105. }
  1106. }
  1107. return [ $values, $search ];
  1108. }
  1109. /**
  1110. * @param numeric-string $id_min
  1111. * @param numeric-string $id_max
  1112. * @param 'id'|'c.name'|'date'|'f.name'|'link'|'title'|'rand' $sort
  1113. * @param 'ASC'|'DESC' $order
  1114. * @param numeric-string $continuation_id
  1115. * @param list<string|int> $continuation_values
  1116. * @return array{0:list<int|string>,1:string}
  1117. */
  1118. protected function sqlListEntriesWhere(string $alias = '', int $state = FreshRSS_Entry::STATE_ALL, ?FreshRSS_BooleanSearch $filters = null,
  1119. string $id_min = '0', string $id_max = '0', string $sort = 'id', string $order = 'DESC',
  1120. string $continuation_id = '0', array $continuation_values = []): array {
  1121. $search = ' ';
  1122. $values = [];
  1123. if ($state & FreshRSS_Entry::STATE_ANDS) {
  1124. if ($state & FreshRSS_Entry::STATE_NOT_READ) {
  1125. if (!($state & FreshRSS_Entry::STATE_READ)) {
  1126. $search .= 'AND (' . $alias . 'is_read=0) ';
  1127. }
  1128. } elseif ($state & FreshRSS_Entry::STATE_READ) {
  1129. $search .= 'AND (' . $alias . 'is_read=1) ';
  1130. }
  1131. if ($state & FreshRSS_Entry::STATE_FAVORITE) {
  1132. if (!($state & FreshRSS_Entry::STATE_NOT_FAVORITE)) {
  1133. $search .= 'AND (' . $alias . 'is_favorite=1) ';
  1134. }
  1135. } elseif ($state & FreshRSS_Entry::STATE_NOT_FAVORITE) {
  1136. $search .= 'AND (' . $alias . 'is_favorite=0) ';
  1137. }
  1138. }
  1139. if ($state & FreshRSS_Entry::STATE_ORS) {
  1140. if (trim($search) === '') {
  1141. $search = 'AND (1=0) ';
  1142. }
  1143. if ($state & FreshRSS_Entry::STATE_OR_NOT_READ) {
  1144. $search = rtrim($search, ') ');
  1145. $search .= ' OR ' . $alias . 'is_read=0) ';
  1146. }
  1147. if ($state & FreshRSS_Entry::STATE_OR_FAVORITE) {
  1148. $search = rtrim($search, ') ');
  1149. $search .= ' OR ' . $alias . 'is_favorite=1) ';
  1150. }
  1151. }
  1152. if (!ctype_digit($id_min)) {
  1153. $id_min = '0';
  1154. }
  1155. if (!ctype_digit($id_max)) {
  1156. $id_max = '0';
  1157. }
  1158. if (!ctype_digit($continuation_id)) {
  1159. $continuation_id = '0';
  1160. }
  1161. if ($continuation_id !== '0' && $sort === 'id') {
  1162. if ($order === 'ASC') {
  1163. $id_min = $id_min === '0' ? $continuation_id : max($id_min, $continuation_id);
  1164. } else {
  1165. $id_max = $id_max === '0' ? $continuation_id : min($id_max, $continuation_id);
  1166. }
  1167. }
  1168. if ($id_max !== '0') {
  1169. $search .= 'AND ' . $alias . 'id <= ? ';
  1170. $values[] = $id_max;
  1171. }
  1172. if ($id_min !== '0') {
  1173. $search .= 'AND ' . $alias . 'id >= ? ';
  1174. $values[] = $id_min;
  1175. }
  1176. if ($continuation_id !== '0' && in_array($sort, ['c.name', 'date', 'f.name', 'link', 'title'], true)) {
  1177. $sign = $order === 'ASC' ? '>' : '<';
  1178. $orderBy = match ($sort) {
  1179. 'c.name' => 'c.name',
  1180. 'f.name' => 'f.name',
  1181. default => $alias . $sort,
  1182. };
  1183. // Keyset pagination (Compatibility syntax due to poor performance of tuple syntax in MySQL https://bugs.mysql.com/bug.php?id=104128)
  1184. if ($sort === 'c.name') {
  1185. // Includes a secondary sort by feed name
  1186. $search .= "AND ((c.name {$sign} ?) OR (c.name = ? AND f.name {$sign} ?) OR (c.name = ? AND f.name = ? AND {$alias}id {$sign}= ?)) ";
  1187. $values[] = $continuation_values[0];
  1188. $values[] = $continuation_values[0];
  1189. $values[] = $continuation_values[1];
  1190. $values[] = $continuation_values[0];
  1191. $values[] = $continuation_values[1];
  1192. $values[] = $continuation_id;
  1193. } else {
  1194. $search .= "AND ({$orderBy} {$sign} ? OR ({$orderBy} = ? AND {$alias}id {$sign}= ?)) ";
  1195. $values[] = $continuation_values[0];
  1196. $values[] = $continuation_values[0];
  1197. $values[] = $continuation_id;
  1198. }
  1199. }
  1200. if ($filters !== null && count($filters->searches()) > 0) {
  1201. [$filterValues, $filterSearch] = self::sqlBooleanSearch($alias, $filters);
  1202. $filterSearch = trim($filterSearch);
  1203. if ($filterSearch !== '') {
  1204. $search .= 'AND (' . $filterSearch . ') ';
  1205. $values = array_merge($values, $filterValues);
  1206. $this->registerSqlFunctions($search);
  1207. }
  1208. }
  1209. return [$values, $search];
  1210. }
  1211. /**
  1212. * @param 'a'|'A'|'i'|'s'|'S'|'c'|'f'|'t'|'T'|'ST'|'Z' $type
  1213. * @param int $id category/feed/tag ID
  1214. * @param numeric-string $id_min
  1215. * @param numeric-string $id_max
  1216. * @param 'id'|'c.name'|'date'|'f.name'|'link'|'title'|'rand' $sort
  1217. * @param 'ASC'|'DESC' $order
  1218. * @param numeric-string $continuation_id
  1219. * @param list<string|int> $continuation_values
  1220. * @return array{0:list<int|string>,1:string}
  1221. * @throws FreshRSS_EntriesGetter_Exception
  1222. */
  1223. private function sqlListWhere(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL, ?FreshRSS_BooleanSearch $filters = null,
  1224. string $id_min = '0', string $id_max = '0', string $sort = 'id', string $order = 'DESC',
  1225. string $continuation_id = '0', array $continuation_values = [], int $limit = 1, int $offset = 0): array {
  1226. if (!$state) {
  1227. $state = FreshRSS_Entry::STATE_ALL;
  1228. }
  1229. $where = '';
  1230. $values = [];
  1231. switch ($type) {
  1232. case 'a': // All PRIORITY_MAIN_STREAM
  1233. $where .= 'f.priority >= ' . FreshRSS_Feed::PRIORITY_MAIN_STREAM . ' ';
  1234. break;
  1235. case 'A': // All except PRIORITY_ARCHIVED
  1236. $where .= 'f.priority >= ' . FreshRSS_Feed::PRIORITY_CATEGORY . ' ';
  1237. break;
  1238. case 'Z': // All including PRIORITY_ARCHIVED
  1239. $where .= 'f.priority >= ' . FreshRSS_Feed::PRIORITY_ARCHIVED . ' ';
  1240. break;
  1241. case 'i': // Priority important feeds
  1242. $where .= 'f.priority >= ' . FreshRSS_Feed::PRIORITY_IMPORTANT . ' ';
  1243. break;
  1244. case 's': //Starred. Deprecated: use $state instead
  1245. $where .= 'f.priority > ' . FreshRSS_Feed::PRIORITY_ARCHIVED . ' ';
  1246. $where .= 'AND e.is_favorite=1 ';
  1247. break;
  1248. case 'S': //Starred
  1249. $where .= 'e.is_favorite=1 ';
  1250. break;
  1251. case 'c': //Category
  1252. $where .= 'f.priority >= ' . FreshRSS_Feed::PRIORITY_CATEGORY . ' ';
  1253. $where .= 'AND f.category=? ';
  1254. $values[] = $id;
  1255. break;
  1256. case 'f': //Feed
  1257. $where .= 'e.id_feed=? ';
  1258. $values[] = $id;
  1259. break;
  1260. case 't': //Tag (label)
  1261. $where .= 'et.id_tag=? ';
  1262. $values[] = $id;
  1263. break;
  1264. case 'T': //Any tag (label)
  1265. $where .= '1=1 ';
  1266. break;
  1267. case 'ST': //Starred or tagged (label)
  1268. $where .= 'e.is_favorite=1 OR EXISTS (SELECT et2.id_tag FROM `_entrytag` et2 WHERE et2.id_entry = e.id) ';
  1269. break;
  1270. default:
  1271. throw new FreshRSS_EntriesGetter_Exception('Bad type in Entry->listByType: [' . $type . ']!');
  1272. }
  1273. $order = in_array($order, ['ASC', 'DESC'], true) ? $order : 'DESC';
  1274. $sort = in_array($sort, ['id', 'c.name', 'date', 'f.name', 'link', 'title', 'rand'], true) ? $sort : 'id';
  1275. $orderBy = match ($sort) {
  1276. 'c.name' => 'c.name',
  1277. 'f.name' => 'f.name',
  1278. 'rand' => static::sqlRandom(),
  1279. default => 'e.' . $sort,
  1280. };
  1281. [$searchValues, $search] = $this->sqlListEntriesWhere(alias: 'e.', state: $state, filters: $filters, id_min: $id_min, id_max: $id_max,
  1282. sort: $sort, order: $order, continuation_id: $continuation_id, continuation_values: $continuation_values);
  1283. return [array_merge($values, $searchValues), 'SELECT '
  1284. . ($type === 'T' ? 'DISTINCT ' : '')
  1285. . 'e.id'
  1286. . ($type === 'T' && $sort !== 'id' ? ', ' . $orderBy : '') // SELECT DISTINCT, ORDER BY expressions must appear in SELECT
  1287. . ' FROM `_entry` e '
  1288. . 'INNER JOIN `_feed` f ON f.id = e.id_feed '
  1289. . ($sort === 'c.name' ? 'INNER JOIN `_category` c ON c.id = f.category ' : '')
  1290. . ($type === 't' || $type === 'T' ? 'INNER JOIN `_entrytag` et ON et.id_entry = e.id ' : '')
  1291. . 'WHERE ' . $where
  1292. . $search
  1293. . 'ORDER BY ' . $orderBy . ' ' . $order
  1294. . ($sort === 'c.name' ? ', f.name ' . $order : '') // Secondary sort
  1295. . ($sort === 'id' ? '' : ', e.id ' . $order) // For keyset pagination
  1296. . ($limit > 0 ? ' LIMIT ' . $limit : '') // http://explainextended.com/2009/10/23/mysql-order-by-limit-performance-late-row-lookups/
  1297. . ($offset > 0 ? ' OFFSET ' . $offset : '')
  1298. ];
  1299. }
  1300. /**
  1301. * @param 'a'|'A'|'s'|'S'|'i'|'c'|'f'|'t'|'T'|'ST'|'Z' $type
  1302. * @param int $id category/feed/tag ID
  1303. * @param numeric-string $id_min
  1304. * @param numeric-string $id_max
  1305. * @param 'id'|'c.name'|'date'|'f.name'|'link'|'title'|'rand' $sort
  1306. * @param 'ASC'|'DESC' $order
  1307. * @param numeric-string $continuation_id
  1308. * @param list<string|int> $continuation_values
  1309. * @throws FreshRSS_EntriesGetter_Exception
  1310. */
  1311. private function listWhereRaw(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL, ?FreshRSS_BooleanSearch $filters = null,
  1312. string $id_min = '0', string $id_max = '0', string $sort = 'id', string $order = 'DESC',
  1313. string $continuation_id = '0', array $continuation_values = [], int $limit = 1, int $offset = 0): PDOStatement|false {
  1314. $order = in_array($order, ['ASC', 'DESC'], true) ? $order : 'DESC';
  1315. $sort = in_array($sort, ['id', 'c.name', 'date', 'f.name', 'link', 'title', 'rand'], true) ? $sort : 'id';
  1316. [$values, $sql] = $this->sqlListWhere($type, $id, $state, $filters, id_min: $id_min, id_max: $id_max, sort: $sort, order: $order,
  1317. continuation_id: $continuation_id, continuation_values: $continuation_values, limit: $limit, offset: $offset);
  1318. $orderBy = match ($sort) {
  1319. 'c.name' => 'c0.name',
  1320. 'f.name' => 'f0.name',
  1321. 'rand' => static::sqlRandom(),
  1322. default => 'e0.' . $sort,
  1323. };
  1324. $content = static::isCompressed() ? 'UNCOMPRESS(e0.content_bin) AS content' : 'e0.content';
  1325. $hash = static::sqlHexEncode('e0.hash');
  1326. $sql = <<<SQL
  1327. SELECT e0.id, e0.guid, e0.title, e0.author, {$content}, e0.link, e0.date, {$hash} AS hash, e0.is_read, e0.is_favorite, e0.id_feed, e0.tags, e0.attributes
  1328. FROM `_entry` e0
  1329. INNER JOIN ({$sql}) e2 ON e2.id=e0.id
  1330. SQL;
  1331. if ($sort === 'f.name' || $sort === 'c.name') {
  1332. $sql .= ' INNER JOIN `_feed` f0 ON f0.id = e0.id_feed ';
  1333. }
  1334. if ($sort === 'c.name') {
  1335. $sql .= ' INNER JOIN `_category` c0 ON c0.id = f0.category ';
  1336. }
  1337. $sql .= ' ORDER BY ' . $orderBy . ' ' . $order;
  1338. if ($sort === 'c.name') {
  1339. $sql .= ', f0.name ' . $order; // Secondary sort
  1340. }
  1341. if ($sort !== 'id') {
  1342. // For keyset pagination
  1343. $sql .= ', e0.id ' . $order;
  1344. }
  1345. $stm = $this->pdo->prepare($sql);
  1346. if ($stm !== false && $stm->execute($values)) {
  1347. return $stm;
  1348. } else {
  1349. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  1350. /** @var array{0:string,1:int,2:string} $info */
  1351. if ($this->autoUpdateDb($info)) {
  1352. return $this->listWhereRaw($type, $id, $state, $filters, id_min: $id_min, id_max: $id_max, sort: $sort, order: $order,
  1353. continuation_id: $continuation_id, continuation_values: $continuation_values, limit: $limit, offset: $offset);
  1354. }
  1355. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  1356. return false;
  1357. }
  1358. }
  1359. /**
  1360. * @param 'a'|'A'|'s'|'S'|'i'|'c'|'f'|'t'|'T'|'ST'|'Z' $type
  1361. * @param int $id category/feed/tag ID
  1362. * @param numeric-string $id_min
  1363. * @param numeric-string $id_max
  1364. * @param 'id'|'c.name'|'date'|'f.name'|'link'|'title'|'rand' $sort
  1365. * @param 'ASC'|'DESC' $order
  1366. * @param numeric-string $continuation_id
  1367. * @param list<string|int> $continuation_values
  1368. * @return Traversable<FreshRSS_Entry>
  1369. * @throws FreshRSS_EntriesGetter_Exception
  1370. */
  1371. public function listWhere(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL, ?FreshRSS_BooleanSearch $filters = null,
  1372. string $id_min = '0', string $id_max = '0', string $sort = 'id', string $order = 'DESC',
  1373. string $continuation_id = '0', array $continuation_values = [], int $limit = 1, int $offset = 0): Traversable {
  1374. $stm = $this->listWhereRaw($type, $id, $state, $filters, id_min: $id_min, id_max: $id_max, sort: $sort, order: $order,
  1375. continuation_id: $continuation_id, continuation_values: $continuation_values, limit: $limit, offset: $offset);
  1376. if ($stm !== false) {
  1377. while (is_array($row = $stm->fetch(PDO::FETCH_ASSOC))) {
  1378. /** @var array{'id':string,'id_feed':int,'guid':string,'title':string,'author':string,'content':string,'link':string,'date':int,
  1379. * 'hash':string,'is_read':int,'is_favorite':int,'tags':string,'attributes'?:?string} $row */
  1380. yield FreshRSS_Entry::fromArray($row);
  1381. }
  1382. }
  1383. }
  1384. /**
  1385. * For API.
  1386. * @param array<numeric-string> $ids
  1387. * @param 'ASC'|'DESC' $order
  1388. * @return Traversable<FreshRSS_Entry>
  1389. */
  1390. public function listByIds(array $ids, string $order = 'DESC'): Traversable {
  1391. if (count($ids) < 1) {
  1392. return;
  1393. }
  1394. if (count($ids) > FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER) {
  1395. // Split a query with too many variables parameters
  1396. $idsChunks = array_chunk($ids, FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER);
  1397. foreach ($idsChunks as $idsChunk) {
  1398. foreach ($this->listByIds($idsChunk, order: $order) as $entry) {
  1399. yield $entry;
  1400. }
  1401. }
  1402. return;
  1403. }
  1404. $order = in_array($order, ['ASC', 'DESC'], true) ? $order : 'DESC';
  1405. $content = static::isCompressed() ? 'UNCOMPRESS(content_bin) AS content' : 'content';
  1406. $hash = static::sqlHexEncode('hash');
  1407. $repeats = str_repeat('?,', count($ids) - 1) . '?';
  1408. $sql = <<<SQL
  1409. SELECT id, guid, title, author, link, date, {$hash} AS hash, is_read, is_favorite, id_feed, tags, attributes, {$content}
  1410. FROM `_entry`
  1411. WHERE id IN ({$repeats})
  1412. ORDER BY id {$order}
  1413. SQL;
  1414. $stm = $this->pdo->prepare($sql);
  1415. if ($stm === false || !$stm->execute($ids)) {
  1416. return;
  1417. }
  1418. while (is_array($row = $stm->fetch(PDO::FETCH_ASSOC))) {
  1419. /** @var array{'id':string,'id_feed':int,'guid':string,'title':string,'author':string,'content':string,'link':string,'date':int,
  1420. * 'hash':string,'is_read':int,'is_favorite':int,'tags':string,'attributes':?string} $row */
  1421. yield FreshRSS_Entry::fromArray($row);
  1422. }
  1423. }
  1424. /**
  1425. * @param 'a'|'A'|'s'|'S'|'c'|'f'|'t'|'T'|'ST'|'Z' $type
  1426. * @param int $id category/feed/tag ID
  1427. * @param numeric-string $id_min
  1428. * @param numeric-string $id_max
  1429. * @param 'ASC'|'DESC' $order
  1430. * @param numeric-string $continuation_id
  1431. * @param list<string|int> $continuation_values
  1432. * @return list<numeric-string>|null
  1433. * @throws FreshRSS_EntriesGetter_Exception
  1434. */
  1435. public function listIdsWhere(string $type = 'a', int $id = 0, int $state = FreshRSS_Entry::STATE_ALL, ?FreshRSS_BooleanSearch $filters = null,
  1436. string $id_min = '0', string $id_max = '0', string $order = 'DESC',
  1437. string $continuation_id = '0', array $continuation_values = [], int $limit = 1, int $offset = 0): ?array {
  1438. [$values, $sql] = $this->sqlListWhere($type, $id, $state, $filters, id_min: $id_min, id_max: $id_max, order: $order,
  1439. continuation_id: $continuation_id, continuation_values: $continuation_values, limit: $limit, offset: $offset);
  1440. $stm = $this->pdo->prepare($sql);
  1441. if ($stm !== false && $stm->execute($values)) {
  1442. /** @var list<int|numeric-string> $res */
  1443. $res = $stm->fetchAll(PDO::FETCH_COLUMN, 0);
  1444. $res = array_map('strval', $res);
  1445. /** @var list<numeric-string> $res */
  1446. return $res;
  1447. }
  1448. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  1449. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info));
  1450. return null;
  1451. }
  1452. /**
  1453. * @param array<string> $guids
  1454. * @return array<string,string> guid => hash
  1455. */
  1456. public function listHashForFeedGuids(int $id_feed, array $guids): array {
  1457. $result = [];
  1458. if (count($guids) < 1) {
  1459. return $result;
  1460. } elseif (count($guids) > FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER) {
  1461. // Split a query with too many variables parameters
  1462. $guidsChunks = array_chunk($guids, FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER);
  1463. foreach ($guidsChunks as $guidsChunk) {
  1464. $result += $this->listHashForFeedGuids($id_feed, $guidsChunk);
  1465. }
  1466. return $result;
  1467. }
  1468. $guids = array_unique($guids);
  1469. $sql = 'SELECT guid, ' . static::sqlHexEncode('hash') .
  1470. ' AS hex_hash FROM `_entry` WHERE id_feed=? AND guid IN (' . str_repeat('?,', count($guids) - 1) . '?)';
  1471. $stm = $this->pdo->prepare($sql);
  1472. $values = [$id_feed];
  1473. $values = array_merge($values, $guids);
  1474. if ($stm !== false && $stm->execute($values)) {
  1475. $rows = $stm->fetchAll(PDO::FETCH_ASSOC);
  1476. foreach ($rows as $row) {
  1477. /** @var array{guid:string,hex_hash:string} $row */
  1478. $result[$row['guid']] = $row['hex_hash'];
  1479. }
  1480. return $result;
  1481. } else {
  1482. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  1483. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info)
  1484. . ' while querying feed ' . $id_feed);
  1485. return [];
  1486. }
  1487. }
  1488. /**
  1489. * @param array<string> $guids
  1490. * @return int|false The number of affected entries, or false if error
  1491. */
  1492. public function updateLastSeen(int $id_feed, array $guids, int $mtime = 0): int|false {
  1493. if (count($guids) < 1) {
  1494. return 0;
  1495. } elseif (count($guids) > FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER) {
  1496. // Split a query with too many variables parameters
  1497. $affected = 0;
  1498. $guidsChunks = array_chunk($guids, FreshRSS_DatabaseDAO::MAX_VARIABLE_NUMBER);
  1499. foreach ($guidsChunks as $guidsChunk) {
  1500. $affected += ($this->updateLastSeen($id_feed, $guidsChunk, $mtime) ?: 0);
  1501. }
  1502. return $affected;
  1503. }
  1504. $sql = 'UPDATE `_entry` SET `lastSeen`=? WHERE id_feed=? AND guid IN (' . str_repeat('?,', count($guids) - 1) . '?)';
  1505. $stm = $this->pdo->prepare($sql);
  1506. if ($mtime <= 0) {
  1507. $mtime = time();
  1508. }
  1509. $values = [$mtime, $id_feed];
  1510. $values = array_merge($values, $guids);
  1511. if ($stm !== false && $stm->execute($values)) {
  1512. return $stm->rowCount();
  1513. } else {
  1514. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  1515. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info)
  1516. . ' while updating feed ' . $id_feed);
  1517. return false;
  1518. }
  1519. }
  1520. /**
  1521. * Update (touch) the last seen attribute of the latest entries of a given feed.
  1522. * Useful when a feed is unchanged / cached.
  1523. * To be performed just before {@see FreshRSS_FeedDAO::updateLastUpdate()}
  1524. * @return int|false The number of affected entries, or false in case of error
  1525. */
  1526. public function updateLastSeenUnchanged(int $id_feed, int $mtime = 0): int|false {
  1527. $sql = <<<'SQL'
  1528. UPDATE `_entry` SET `lastSeen` = :mtime
  1529. WHERE id_feed = :id_feed1 AND `lastSeen` = (
  1530. SELECT `lastUpdate` FROM `_feed` f
  1531. WHERE f.id = :id_feed2
  1532. )
  1533. SQL;
  1534. $stm = $this->pdo->prepare($sql);
  1535. if ($mtime <= 0) {
  1536. $mtime = time();
  1537. }
  1538. if ($stm !== false &&
  1539. $stm->bindValue(':mtime', $mtime, PDO::PARAM_INT) &&
  1540. $stm->bindValue(':id_feed1', $id_feed, PDO::PARAM_INT) &&
  1541. $stm->bindValue(':id_feed2', $id_feed, PDO::PARAM_INT) &&
  1542. $stm->execute()) {
  1543. return $stm->rowCount();
  1544. } else {
  1545. $info = $stm === false ? $this->pdo->errorInfo() : $stm->errorInfo();
  1546. Minz_Log::error('SQL error ' . __METHOD__ . json_encode($info) . ' while updating feed ' . $id_feed);
  1547. return false;
  1548. }
  1549. }
  1550. /** @return array<string,int> */
  1551. public function countUnreadRead(): array {
  1552. $sql = <<<'SQL'
  1553. SELECT COUNT(e.id) AS count FROM `_entry` e
  1554. INNER JOIN `_feed` f ON e.id_feed=f.id
  1555. WHERE f.priority > 0
  1556. UNION
  1557. SELECT COUNT(e.id) AS count FROM `_entry` e
  1558. INNER JOIN `_feed` f ON e.id_feed=f.id
  1559. WHERE f.priority > 0 AND e.is_read=0
  1560. SQL;
  1561. $res = $this->fetchColumn($sql, 0);
  1562. if ($res === null) {
  1563. return ['all' => -1, 'unread' => -1, 'read' => -1];
  1564. }
  1565. rsort($res);
  1566. $all = (int)($res[0] ?? 0);
  1567. $unread = (int)($res[1] ?? 0);
  1568. return ['all' => $all, 'unread' => $unread, 'read' => $all - $unread];
  1569. }
  1570. public function count(?int $minPriority = null): int {
  1571. $sql = 'SELECT COUNT(e.id) AS count FROM `_entry` e';
  1572. $values = [];
  1573. if ($minPriority !== null) {
  1574. $sql .= ' INNER JOIN `_feed` f ON e.id_feed=f.id';
  1575. $sql .= ' WHERE f.priority > :priority';
  1576. $values[':priority'] = $minPriority;
  1577. }
  1578. $res = $this->fetchColumn($sql, 0, $values);
  1579. return isset($res[0]) ? (int)($res[0]) : -1;
  1580. }
  1581. public function countNotRead(?int $minPriority = null): int {
  1582. $sql = 'SELECT COUNT(e.id) AS count FROM `_entry` e';
  1583. if ($minPriority !== null) {
  1584. $sql .= ' INNER JOIN `_feed` f ON e.id_feed=f.id';
  1585. }
  1586. $sql .= ' WHERE e.is_read=0';
  1587. $values = [];
  1588. if ($minPriority !== null) {
  1589. $sql .= ' AND f.priority > :priority';
  1590. $values[':priority'] = $minPriority;
  1591. }
  1592. $res = $this->fetchColumn($sql, 0, $values);
  1593. return isset($res[0]) ? (int)($res[0]) : -1;
  1594. }
  1595. /** @return array{'all':int,'read':int,'unread':int} */
  1596. public function countUnreadReadFavorites(): array {
  1597. $sql = <<<'SQL'
  1598. SELECT c FROM (
  1599. SELECT COUNT(e1.id) AS c, 1 AS o
  1600. FROM `_entry` AS e1
  1601. JOIN `_feed` AS f1 ON e1.id_feed = f1.id
  1602. WHERE e1.is_favorite = 1
  1603. AND f1.priority >= :priority1
  1604. UNION
  1605. SELECT COUNT(e2.id) AS c, 2 AS o
  1606. FROM `_entry` AS e2
  1607. JOIN `_feed` AS f2 ON e2.id_feed = f2.id
  1608. WHERE e2.is_favorite = 1
  1609. AND e2.is_read = 0 AND f2.priority >= :priority2
  1610. ) u
  1611. ORDER BY o
  1612. SQL;
  1613. //Binding a value more than once is not standard and does not work with native prepared statements (e.g. MySQL) https://bugs.php.net/bug.php?id=40417
  1614. $res = $this->fetchColumn($sql, 0, [
  1615. ':priority1' => FreshRSS_Feed::PRIORITY_CATEGORY,
  1616. ':priority2' => FreshRSS_Feed::PRIORITY_CATEGORY,
  1617. ]);
  1618. if ($res === null) {
  1619. return ['all' => -1, 'unread' => -1, 'read' => -1];
  1620. }
  1621. rsort($res);
  1622. $all = (int)($res[0] ?? 0);
  1623. $unread = (int)($res[1] ?? 0);
  1624. return ['all' => $all, 'unread' => $unread, 'read' => $all - $unread];
  1625. }
  1626. }