1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
<?php
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Alessandro Cosentino <cosenal@gmail.com>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @copyright 2020 Sean Molenaar
*/
namespace OCA\News\Service;
use OCA\News\AppInfo\Application;
use OCA\News\Db\Feed;
use OCA\News\Db\ListType;
use OCA\News\Db\Item;
use OCA\News\Db\ItemMapperV2;
use OCA\News\Service\Exceptions\ServiceConflictException;
use OCA\News\Service\Exceptions\ServiceNotFoundException;
use OCA\News\Service\Exceptions\ServiceValidationException;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Db\Entity;
use OCP\AppFramework\Db\MultipleObjectsReturnedException;
use OCP\IConfig;
use Psr\Log\LoggerInterface;
/**
* Class ItemService
*
* @package OCA\News\Service
*/
class ItemServiceV2 extends Service
{
/**
* @var IConfig
*/
protected $config;
/**
* ItemService constructor.
*
* @param ItemMapperV2 $mapper
* @param IConfig $config
* @param LoggerInterface $logger
*/
public function __construct(
ItemMapperV2 $mapper,
IConfig $config,
LoggerInterface $logger
) {
parent::__construct($mapper, $logger);
$this->config = $config;
}
/**
* Finds all items of a user
*
* @param string $userId The ID/name of the user
* @param array $params Filter parameters
*
*
* @return Item[]
*/
public function findAllForUser(string $userId, array $params = []): array
{
return $this->mapper->findAllFromUser($userId, $params);
}
/**
* Find all items
*
* @return Item[]
*/
public function findAll(): array
{
return $this->mapper->findAll();
}
/**
* Insert an item or update.
*
* @param Item $item
*
* @return Entity|Item The updated/inserted item
*/
public function insertOrUpdate(Item $item): Entity
{
try {
/** @var Item $db_item */
$db_item = $this->findByGuidHash($item->getFeedId(), $item->getGuidHash());
// Transfer user modifications
$item->setUnread($db_item->isUnread())
->setStarred($db_item->isStarred())
->setId($db_item->getId());
$item->generateSearchIndex();//generates fingerprint
// We don't want to update the database record if there is no
// change in the fetched item
if ($db_item->getFingerprint() === $item->getFingerprint()) {
$item->resetUpdatedFields();
}
return $this->mapper->update($item);
} catch (DoesNotExistException $exception) {
return $this->mapper->insert($item);
}
}
/**
* Return all starred items
*
* @param string $userId
*
* @return Item[]
*/
public function starred(string $userId): array
{
return $this->findAllForUser($userId, ['starred' => 1]);
}
/**
* Mark an item as read
*
* @param string $userId Item owner
* @param int $id Item ID
* @param bool $read
*
* @return Item
* @throws ServiceNotFoundException
* @throws ServiceConflictException
*/
public function read(string $userId, int $id, bool $read): Entity
{
/** @var Item $item */
$item = $this->find($userId, $id);
$item->setUnread(!$read);
return $this->mapper->update($item);
}
/**
* @param int|null $threshold
* @param bool|null $purgeUnread
*
* @return int|null Amount of deleted items or null if not applicable
*/
public function purgeOverThreshold(int $threshold = null, bool $purgeUnread = null): ?int
{
$threshold = (int) ($threshold ?? $this->config->getAppValue(
Application::NAME,
'autoPurgeCount',
Application::DEFAULT_SETTINGS['autoPurgeCount']
));
$purgeUnread = (bool) ($purgeUnread ?? $this->config->getAppValue(
Application::NAME,
'purgeUnread',
Application::DEFAULT_SETTINGS['purgeUnread']
));
if ($threshold <= 0) {
return null;
}
return $this->mapper->deleteOverThreshold($threshold, $purgeUnread);
}
/**
* Mark an item as starred
*
* @param string $userId Item owner
* @param int $id Item ID
* @param bool $starred
*
* @return Item
* @throws ServiceNotFoundException|ServiceConflictException
*/
public function star(string $userId, int $id, bool $starred): Entity
{
/** @var Item $item */
$item = $this->find($userId, $id);
$item->setStarred($starred);
return $this->mapper->update($item);
}
/**
* Mark an item as starred by GUID hash
*
* @param string $userId Item owner
* @param int $feedId Item ID
* @param string $guidHash
* @param bool $starred
*
* @return Item
* @throws ServiceConflictException
* @throws ServiceNotFoundException
*/
public function starByGuid(string $userId, int $feedId, string $guidHash, bool $starred): Entity
{
try {
$item = $this->mapper->findForUserByGuidHash($userId, $feedId, $guidHash);
} catch (DoesNotExistException $ex) {
throw ServiceNotFoundException::from($ex);
} catch (MultipleObjectsReturnedException $ex) {
throw ServiceConflictException::from($ex);
}
$item->setStarred($starred);
return $this->mapper->update($item);
}
/**
* Mark all items as read
*
* @param string $userId Item owner
* @param int $maxItemId
*
* @return int
*/
public function readAll(string $userId, int $maxItemId): int
{
return $this->mapper->readAll($userId, $maxItemId);
}
/**
* @param string $userId
*
* @return Item
*/
public function newest(string $userId): Entity
{
try {
return $this->mapper->newest($userId);
} catch (DoesNotExistException $e) {
throw ServiceNotFoundException::from($e);
} catch (MultipleObjectsReturnedException $e) {
throw ServiceConflictException::from($e);
}
}
/**
* @param int $feedId
* @param string $guidHash
*
* @return Item
*
* @throws DoesNotExistException
* @throws MultipleObjectsReturnedException
*/
public function findByGuidHash(int $feedId, string $guidHash): Entity
{
return $this->mapper->findByGuidHash($feedId, $guidHash);
}
/**
* Convenience method to find all items in a feed.
*
* @param string $userId
* @param int $feedId
*
* @return array
*/
public function findAllInFeed(string $userId, int $feedId): array
{
return $this->findAllInFeedAfter($userId, $feedId, PHP_INT_MIN, false);
}
/**
* Returns all new items in a feed
* @param string $userId the name of the user
* @param int $feedId the id of the feed
* @param int $updatedSince a timestamp with the minimal modification date
* @param boolean $hideRead if unread items should also be returned
*
* @return array of items
*/
public function findAllInFeedAfter(string $userId, int $feedId, int $updatedSince, bool $hideRead): array
{
return $this->mapper->findAllInFeedAfter($userId, $feedId, $updatedSince, $hideRead);
}
/**
* Returns all new items in a folder
* @param string $userId the name of the user
* @param int|null $folderId the id of the folder
* @param int $updatedSince a timestamp with the minimal modification date
* @param boolean $hideRead if unread items should also be returned
*
* @return array of items
*/
public function findAllInFolderAfter(string $userId, ?int $folderId, int $updatedSince, bool $hideRead): array
{
return $this->mapper->findAllInFolderAfter($userId, $folderId, $updatedSince, $hideRead);
}
/**
* Returns all new items of a type
*
* @param string $userId the name of the user
* @param int $feedType the type of feed items to fetch. (starred || unread)
* @param int $updatedSince a timestamp with the minimal modification date
*
* @return array of items
*
* @throws ServiceValidationException
*/
public function findAllAfter(string $userId, int $feedType, int $updatedSince): array
{
if (!in_array($feedType, [ListType::STARRED, ListType::UNREAD, ListType::ALL_ITEMS], true)) {
throw new ServiceValidationException('Trying to find in unknown type');
}
return $this->mapper->findAllAfter($userId, $feedType, $updatedSince);
}
/**
* Returns all items
*
* @param int $feedId the id of the feed
* @param int $limit how many items should be returned
* @param int $offset the offset
* @param boolean $hideRead if unread items should also be returned
* @param boolean $oldestFirst if it should be ordered by oldest first
* @param string $userId the name of the user
* @param string[] $search an array of keywords that the result should
* contain in either the author, title, link
* or body
*
* @return array of items
*/
public function findAllInFeedWithFilters(
string $userId,
int $feedId,
int $limit,
int $offset,
bool $hideRead,
bool $oldestFirst,
array $search = []
): array {
return $this->mapper->findAllFeed($userId, $feedId, $limit, $offset, $hideRead, $oldestFirst, $search);
}
/**
* Returns all items
*
* @param int|null $folderId the id of the folder
* @param int $limit how many items should be returned
* @param int $offset the offset
* @param boolean $hideRead if unread items should also be returned
* @param boolean $oldestFirst if it should be ordered by oldest first
* @param string $userId the name of the user
* @param string[] $search an array of keywords that the result should
* contain in either the author, title, link
* or body
*
* @return array of items
*/
public function findAllInFolderWithFilters(
string $userId,
?int $folderId,
int $limit,
int $offset,
bool $hideRead,
bool $oldestFirst,
array $search = []
): array {
return $this->mapper->findAllFolder($userId, $folderId, $limit, $offset, $hideRead, $oldestFirst, $search);
}
/**
* Returns all items
*
* @param int $type the type of the feed
* @param int $limit how many items should be returned
* @param int $offset the offset
* @param boolean $oldestFirst if it should be ordered by oldest first
* @param string $userId the name of the user
* @param string[] $search an array of keywords that the result should
* contain in either the author, title, link
* or body
*
* @return array of items
*/
public function findAllWithFilters
|