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
|
<?php
/**
* ownCloud - 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 Alessandro Cosentino 2012
* @copyright Bernhard Posselt 2012, 2014
*/
namespace OCA\News\Service;
use OCP\IConfig;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCA\News\Db\ItemMapper;
use OCA\News\Db\StatusFlag;
use OCA\News\Db\FeedType;
use OCA\News\Config\Config;
class ItemService extends Service {
private $statusFlag;
private $config;
private $timeFactory;
private $itemMapper;
private $systemConfig;
public function __construct(ItemMapper $itemMapper,
StatusFlag $statusFlag,
ITimeFactory $timeFactory,
Config $config,
IConfig $systemConfig){
parent::__construct($itemMapper);
$this->statusFlag = $statusFlag;
$this->config = $config;
$this->timeFactory = $timeFactory;
$this->itemMapper = $itemMapper;
$this->systemConfig = $systemConfig;
}
/**
* Returns all new items
* @param int $id the id of the feed, 0 for starred or all items
* @param int $type the type of the feed
* @param int $updatedSince a timestamp with the last modification date
* returns only items with a >= modified timestamp
* @param boolean $showAll if unread items should also be returned
* @param string $userId the name of the user
* @return array of items
*/
public function findAllNew($id, $type, $updatedSince, $showAll, $userId){
$status = $this->statusFlag->typeToStatus($type, $showAll);
switch($type){
case FeedType::FEED:
return $this->itemMapper->findAllNewFeed(
$id, $updatedSince, $status, $userId
);
case FeedType::FOLDER:
return $this->itemMapper->findAllNewFolder(
$id, $updatedSince, $status, $userId
);
default:
return $this->itemMapper->findAllNew(
$updatedSince, $status, $userId
);
}
}
/**
* Returns all items
* @param int $id the id of the feed, 0 for starred or 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 $showAll 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 findAll($id, $type, $limit, $offset, $showAll, $oldestFirst,
$userId, $search=[]){
$status = $this->statusFlag->typeToStatus($type, $showAll);
switch($type){
case FeedType::FEED:
return $this->itemMapper->findAllFeed(
$id, $limit, $offset, $status, $oldestFirst, $userId,
$search
);
case FeedType::FOLDER:
return $this->itemMapper->findAllFolder(
$id, $limit, $offset, $status, $oldestFirst, $userId,
$search
);
default:
return $this->itemMapper->findAll(
$limit, $offset, $status, $oldestFirst, $userId, $search
);
}
}
/**
* Star or unstar an item
* @param int $feedId the id of the item's feed that should be starred
* @param string $guidHash the guidHash of the item that should be starred
* @param boolean $isStarred if true the item will be marked as starred,
* if false unstar
* @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException if the item does not exist
*/
public function star($feedId, $guidHash, $isStarred, $userId){
try {
$item = $this->itemMapper->findByGuidHash(
$guidHash, $feedId, $userId
);
$item->setLastModified($this->timeFactory->getTime());
if($isStarred){
$item->setStarred();
} else {
$item->setUnstarred();
}
$this->itemMapper->update($item);
} catch(DoesNotExistException $ex) {
throw new ServiceNotFoundException($ex->getMessage());
}
}
/**
* Read or unread an item
* @param int $itemId the id of the item that should be read
* @param boolean $isRead if true the item will be marked as read,
* if false unread
* @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException if the item does not exist
*/
public function read($itemId, $isRead, $userId){
$lastModified = $this->timeFactory->getTime();
$this->itemMapper->readItem($itemId, $isRead, $lastModified, $userId);
}
/**
* Set all items read
* @param int $highestItemId all items below that are marked read. This is
* used to prevent marking items as read that the users hasn't seen yet
* @param string $userId the name of the user
*/
public function readAll($highestItemId, $userId){
$time = $this->timeFactory->getTime();
$this->itemMapper->readAll($highestItemId, $time, $userId);
}
/**
* Set a folder read
* @param int $folderId the id of the folder that should be marked read
* @param int $highestItemId all items below that are marked read. This is
* used to prevent marking items as read that the users hasn't seen yet
* @param string $userId the name of the user
*/
public function readFolder($folderId, $highestItemId, $userId){
$time = $this->timeFactory->getTime();
$this->itemMapper->readFolder(
$folderId, $highestItemId, $time, $userId
);
}
/**
* Set a feed read
* @param int $feedId the id of the feed that should be marked read
* @param int $highestItemId all items below that are marked read. This is
* used to prevent marking items as read that the users hasn't seen yet
* @param string $userId the name of the user
*/
public function readFeed($feedId, $highestItemId, $userId){
$time = $this->timeFactory->getTime();
$this->itemMapper->readFeed($feedId, $highestItemId, $time, $userId);
}
/**
* This method deletes all unread feeds that are not starred and over the
* count of $this->autoPurgeCount starting by the oldest. This is to clean
* up the database so that old entries don't spam your db. As criteria for
* old, the id is taken
*/
public function autoPurgeOld(){
$count = $this->config->getAutoPurgeCount();
if ($count >= 0) {
$this->itemMapper->deleteReadOlderThanThreshold($count);
}
}
/**
* Returns the newest item id, use this for marking feeds read
* @param string $userId the name of the user
* @throws ServiceNotFoundException if there is no newest item
* @return int
*/
public function getNewestItemId($userId) {
try {
return $this->itemMapper->getNewestItemId($userId);
} catch(DoesNotExistException $ex) {
throw new ServiceNotFoundException($ex->getMessage());
}
}
/**
* Returns the starred count
* @param string $userId the name of the user
* @return int the count
*/
public function starredCount($userId){
return $this->itemMapper->starredCount($userId);
}
/**
* @param string $userId from which user the items should be taken
* @return array of items which are starred or unread
*/
public function getUnreadOrStarred($userId) {
return $this->itemMapper->findAllUnreadOrStarred($userId);
}
/**
* Deletes all items of a user
* @param string $userId the name of the user
*/
public function deleteUser($userId) {
$this->itemMapper->deleteUser($userId);
}
/**
* Regenerates the search index for all items
*/
public function generateSearchIndices() {
$this->itemMapper->updateSearchIndices();
}
}
|
