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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
|
<?php
/**
* ownCloud - News app
*
* @author Alessandro Cosentino
* @author Bernhard Posselt
* @copyright 2012 Alessandro Cosentino cosenal@gmail.com
* @copyright 2012 Bernhard Posselt nukeawhale@gmail.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\News\Db;
use \OCA\AppFramework\Db\DoesNotExistException;
use \OCA\AppFramework\Db\MultipleObjectsReturnedException;
use \OCA\AppFramework\Db\Mapper;
use \OCA\AppFramework\Core\API;
class ItemMapper extends NewsMapper {
public function __construct(API $api){
parent::__construct($api, 'news_items');
}
protected function findAllRows($sql, $params, $limit=null, $offset=null) {
$result = $this->execute($sql, $params, $limit, $offset);
$items = array();
while($row = $result->fetchRow()){
$item = new Item();
$item->fromRow($row);
array_push($items, $item);
}
return $items;
}
/**
* Queries to find all items that belong to a user
*/
// private function makeFindAllFromFeedQuery($custom) {
// return 'SELECT * FROM `*PREFIX*news_items` ' .
// 'WHERE user_id = ? ' .
// 'AND feed_id = ?' .
// $custom;
// }
//
// public function findAllFromFeed($feedId, $userId){
// $sql = $this->makeFindAllFromFeedQuery('');
// $params = array($feedId, $userId);
// return $this->findAllRows($sql, $params);
// }
//
// public function findAllFromFeedByStatus($feedId, $userId, $status){
// $sql = $this->makeFindAllFromFeedQuery(' AND ((`*dbprefix*news_items`.`status` & ?) > 0)');
// $params = array($feedId, $userId, $status);
// return $this->findAllRows($sql, $params);
// }
//
// public function findAllFromFeedByLastMofified($userId, $feedId, $lastModified){
// $sql = $this->makeFindAllFromFeedQuery(' AND `*dbprefix*news_items`.last_modified >= ? ');
// $params = array($feedId, $userId, $lastModified);
// return $this->findAllRows($sql, $params);
// }
//
// public function findAllFromFeedByOffset($userId, $feedId, $limit, $offset){
// $sql = $this->makeFindAllFromFeedQuery(' AND `*dbprefix*news_items`.last_modified >= ? ');
// $params = array($feedId, $userId, $limit, $offset);
// return $this->findAllRows($sql, $params);
// }
/**
* Queries to find all items from a folder that belongs to a user
*/
private function makeFindAllFromFolderQuery($custom) {
return 'SELECT `*dbprefix*news_items`.* FROM `*dbprefix*news_items` ' .
'JOIN `*dbprefix*news_feeds` ' .
'ON `*dbprefix*news_feeds`.`id` = `*dbprefix*news_items`.`feed_id` ' .
'WHERE `*dbprefix*news_feeds`.`user_id` = ? ' .
'AND `*dbprefix*news_feeds`.`folder_id` = ? ' .
'AND ((`*dbprefix*news_items`.`status` & ?) > 0) ' .
$custom;
}
public function findAllFromFolderByOffset($userId, $folderId, $status, $limit=null, $offset=null) {
$sql = $this->makeFindAllFromFolderQuery('');
$params = array($userId, $folderId, $status);
return $this->findAllRows($sql, $params, $limit, $offset);
}
public function findAllFromFolderByLastMofified($userId, $folderId, $status, $lastModified) {
$sql = $this->makeFindAllFromFolderQuery(' AND (`*dbprefix*news_items`.`last_modified` >= ?)');
$params = array($userId, $folderId, $status, $lastModified);
return $this->findAllRows($sql, $params);
}
/*
request: get all items of a folder of a user (unread and read)
SELECT * FROM items
JOIN feeds
ON feed.id = feed_id
WHERE user_id = ? AND status = ? AND feed.folder_id = ?
(AND id < ? LIMIT ?)
(AND items.lastmodified >= ?)
*/
public function find($id, $userId){
$sql = 'SELECT `*dbprefix*news_items`.* FROM `*dbprefix*news_items` ' .
'JOIN `*dbprefix*news_feeds` ' .
'ON `*dbprefix*news_feeds`.`id` = `*dbprefix*news_items`.`feed_id` ' .
'WHERE `*dbprefix*news_items`.`id` = ? ' .
'AND `*dbprefix*news_feeds`.`user_id` = ? ';
$row = $this->findRow($sql, $id, $userId);
$item = new Item();
$item->fromRow($row);
return $item;
}
public function readFeed($feedId, $userId){
// TODO
}
public function starredCount($userId){
// TODO
}
}
/**
* This class maps an item to a row of the items table in the database.
* It follows the Data Mapper pattern (see http://martinfowler.com/eaaCatalog/dataMapper.html).
*/
/*
class ItemMapper {
const tableName = '*PREFIX*news_items';
private $userid;
public function __construct($userid = null) {
if ($userid !== null) {
$this->userid = $userid;
}
else {
$this->userid = \OCP\USER::getUser();
}
}
* @brief
* @param row a row from the items table of the database
* @returns an object of the class OC_News_Item
*
public function fromRow($row) {
$url = $row['url'];
$title = $row['title'];
$guid = $row['guid'];
$body = $row['body'];
$id = $row['id'];
$item = new Item($url, $title, $guid, $body, $id);
$item->setStatus($row['status']);
$item->setAuthor($row['author']);
$item->setFeedId($row['feed_id']);
$item->setDate(Utils::dbtimestampToUnixtime($row['pub_date']));
$feedmapper = new FeedMapper($this->userid);
$feed = $feedmapper->findById($row['feed_id']);
$item->setFeedTitle($feed->getTitle());
if($row['enclosure_mime'] !== null && $row['enclosure_link'] !== null) {
$enclosure = new Enclosure();
$enclosure->setMimeType($row['enclosure_mime']);
$enclosure->setLink($row['enclosure_link']);
$item->setEnclosure($enclosure);
}
return $item;
}
/**
* @brief Retrieve all the item corresponding to a feed from the database
* @param feedid The id of the feed in the database table.
*
public function findByFeedId($feedid) {
$stmt = \OCP\DB::prepare('SELECT * FROM ' . self::tableName . ' WHERE feed_id = ? ORDER BY pub_date DESC');
$result = $stmt->execute(array($feedid));
$items = array();
while ($row = $result->fetchRow()) {
$item = $this->fromRow($row);
$items[] = $item;
}
return $items;
}
/**
* @brief Retrieve all the items corresponding to a feed from the database with a particular status
* @param feedid The id of the feed in the database table.
* @param status one of the constants defined in OCA\News\StatusFlag
*
public function findAllStatus($feedid, $status) {
$stmt = \OCP\DB::prepare('SELECT * FROM ' . self::tableName . '
WHERE feed_id = ?
AND ((status & ?) > 0)
ORDER BY pub_date DESC');
$result = $stmt->execute(array($feedid, $status));
$items = array();
while ($row = $result->fetchRow()) {
$item = $this->fromRow($row);
$items[] = $item;
}
return $items;
}
/*
* @brief Retrieve all the items from the database with a particular status
* @param status one of the constants defined in OCA\News\StatusFlag
*
public function findEveryItemByStatus($status) {
$stmt = \OCP\DB::prepare('SELECT ' . self::tableName . '.* FROM ' . self::tableName . '
JOIN '. FeedMapper::tableName .' ON
'. FeedMapper::tableName .'.id = ' . self::tableName . '.feed_id
WHERE '. FeedMapper::tableName .'.user_id = ?
AND ((' . self::tableName . '.status & ?) > 0)
ORDER BY ' . self::tableName . '.pub_date DESC');
$result = $stmt->execute(array($this->userid, $status));
$items = array();
while ($row = $result->fetchRow()) {
$item = $this->fromRow($row);
$items[] = $item;
}
return $items;
}
public function countAllStatus($feedid, $status) {
$stmt = \OCP\DB::prepare('SELECT COUNT(*) as size FROM ' . self::tableName . '
WHERE feed_id = ?
AND ((status & ?) > 0)');
$result=$stmt->execute(array($feedid, $status))->fetchRow();
return $result['size'];
}
/**
* @brief Count all the items from the database with a particular status
* @param status one of the constants defined in OCA\News\StatusFlag
*
public function countEveryItemByStatus($status) {
$stmt = \OCP\DB::prepare('SELECT COUNT(*) as size FROM ' . self::tableName . '
JOIN '. FeedMapper::tableName .' ON
'. FeedMapper::tableName .'.id = ' . self::tableName . '.feed_id
WHERE '. FeedMapper::tableName .'.user_id = ?
AND ((' . self::tableName . '.status & ?) > 0)');
$result = $stmt->execute(array($this->userid, $status))->fetchRow();;
return $result['size'];
}
public function findIdFromGuid($guid_hash, $guid, $feedid) {
$stmt = \OCP\DB::prepare('
SELECT * FROM ' . self::tableName . '
WHERE guid_hash = ?
AND feed_id = ?
');
$result = $stmt->execute(array($guid_hash, $feedid));
//TODO: if there is more than one row, falling back to comparing $guid
$row = $result->fetchRow();
$id = null;
if ($row != null) {
$id = $row['id'];
}
return $id;
}
/**
* @brief marks all items read
* @param int $feedId: the id of the feed
* @param int $mostRecentItemId: every item with the same or lower id will
* be marked read
*
public function markAllRead($feedId, $mostRecentItemId){
if($mostRecentItemId === 0){
$stmt = \OCP\DB::prepare('
UPDATE ' . self::tableName .
' SET status = status & ?
WHERE
feed_id = ?');
$params = array(
~StatusFlag::UNREAD,
$feedId
);
} else {
$stmt = \OCP\DB::prepare('
UPDATE ' . self::tableName .
' SET status = status & ?
WHERE
feed_id = ?
AND
id <= ?');
$params = array(
~StatusFlag::UNREAD,
$feedId,
$mostRecentItemId
);
}
$stmt->execute($params);
}
/**
* @brief Update the item after its status has changed
* @returns The item whose status has changed.
*
public function update(Item $item) {
$itemid = $item->getId();
$status = $item->getStatus();
$stmt = \OCP\DB::prepare('
UPDATE ' . self::tableName .
' SET status = ?
WHERE id = ?
');
$params=array(
$status,
$itemid
);
$result = $stmt->execute($params);
return true;
}
/**
* @brief Save the feed and all its items into the database
* @returns The id of the feed in the database table.
*
public function save(Item $item, $feedid) {
$guid = $item->getGuid();
$guid_hash = md5($guid);
$status = $item->getStatus();
$itemid = $this->findIdFromGuid($guid_hash, $guid, $feedid);
if ($itemid == null) {
$title = $item->getTitle();
$body = $item->getBody();
$author = $item->getAuthor();
$enclosure_mime = null;
$enclosure_link = null;
if($enclosure = $item->getEnclosure()) {
$enclosure_mime = $enclosure->getMimeType();
$enclosure_link = $enclosure->getLink();
}
$stmt = \OCP\DB::prepare('
INSERT INTO ' . self::tableName .
'(url, title, body, author, guid, guid_hash, pub_date, enclosure_mime, enclosure_link, feed_id, status)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
');
if(empty($title)) {
$l = \OC_L10N::get('news');
$title = $l->t('no title');
}
if(empty($body)) {
$l = \OC_L10N::get('news');
$body = $l->t('no body');
}
$pub_date = Utils::unixtimeToDbtimestamp($item->getDate());
$params=array(
$item->getUrl(),
$title,
$body,
$author,
$guid,
$guid_hash,
$pub_date,
$enclosure_mime,
$enclosure_link,
$feedid,
$status
);
$stmt->execute($params);
$itemid = \OCP\DB::insertid(self::tableName);
}
else {
$this->update($item);
}
$item->setId($itemid);
return $itemid;
}
/**
* @brief Retrieve an item from the database
* @param id The id of the item in the database table.
*
public function findById($id) {
$stmt = \OCP\DB::prepare('SELECT ' . self::tableName . '.id AS id, ' . self::tableName .
'.url AS url, ' . self::tableName . '.title AS title, guid, body, status, author, feed_id, pub_date, enclosure_mime, enclosure_link' .
' FROM ' . self::tableName . ' JOIN ' . FeedMapper::tableName .
' ON ' . self::tableName . '.feed_id = ' . FeedMapper::tableName . '.id WHERE (' . self::tableName .
'.id = ? AND ' . FeedMapper::tableName . '.user_id = ? )');
$result = $stmt->execute(array($id, $this->userid));
/*
$stmt = \OCP\DB::prepare('SELECT * FROM ' . self::tableName . ' WHERE id = ?');
$result = $stmt->execute(array($id));
*
$row = $result->fetchRow();
$item = $this->fromRow($row);
return $item;
}
/**
* @brief Permanently delete all items belonging to a feed from the database
* @param feedid The id of the feed that we wish to delete
* @return
*
public function deleteAll($feedid) {
if ($feedid == null) {
return false;
}
$stmt = \OCP\DB::prepare('DELETE FROM ' . self::tableName .' WHERE feed_id = ?');
$result = $stmt->execute(array($feedid));
return $result;
}
/**
* Returns the unread count
* @param $feedType the type of the feed
* @param $feedId the id of the feed or folder
* @return the unread count
*
public function getUnreadCount($feedType, $feedId){
$unreadCount = 0;
switch ($feedType) {
case FeedType::STARRED:
$unreadCount = $this->countEveryItemByStatus(StatusFlag::IMPORTANT);
break;
case FeedType::SUBSCRIPTIONS:
$unreadCount = $this->countEveryItemByStatus(StatusFlag::UNREAD);
break;
case FeedType::FOLDER:
$feedMapper = new FeedMapper($this->userid);
$feeds = $feedMapper->findByFolderId($feedId);
foreach($feeds as $feed){
$unreadCount += $this->countAllStatus($feed->getId(), StatusFlag::UNREAD);
}
break;
case FeedType::FEED:
$unreadCount = $this->countAllStatus($feedId, StatusFlag::UNREAD);
break;
}
return (int)$unreadCount;
}
/**
* Returns all items
* @param $feedType the type of the feed
* @param $feedId the id of the feed or folder
* @param $showAll if true, it will also include unread items
* @return an array with all items
*
public function getItems($feedType, $feedId, $showAll){
$items = array();
// starred or subscriptions
if ($feedType === FeedType::STARRED || $feedType === FeedType::SUBSCRIPTIONS) {
if($feedType === FeedType::STARRED){
$statusFlag = StatusFlag::IMPORTANT;
}
if($feedType === FeedType::SUBSCRIPTIONS){
$statusFlag = StatusFlag::UNREAD;
}
$items = $this->findEveryItemByStatus($statusFlag);
// feed
} elseif ($feedType === FeedType::FEED){
if($showAll) {
$items = $this->findByFeedId($feedId);
} else {
$items = $this->findAllStatus($feedId, StatusFlag::UNREAD);
}
// folder
|