diff options
Diffstat (limited to 'lib/Service/FeedServiceV2.php')
-rw-r--r-- | lib/Service/FeedServiceV2.php | 336 |
1 files changed, 336 insertions, 0 deletions
diff --git a/lib/Service/FeedServiceV2.php b/lib/Service/FeedServiceV2.php new file mode 100644 index 000000000..58217a1ce --- /dev/null +++ b/lib/Service/FeedServiceV2.php @@ -0,0 +1,336 @@ +<?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 2012 Alessandro Cosentino + * @copyright 2012-2014 Bernhard Posselt + */ + +namespace OCA\News\Service; + +use FeedIo\Reader\ReadErrorException; +use HTMLPurifier; + +use OCA\News\Db\FeedMapperV2; +use OCA\News\Fetcher\FeedFetcher; +use OCA\News\Service\Exceptions\ServiceConflictException; +use OCA\News\Service\Exceptions\ServiceNotFoundException; +use OCP\AppFramework\Db\Entity; +use OCP\AppFramework\Db\MultipleObjectsReturnedException; +use OCP\ILogger; +use OCP\IL10N; +use OCP\AppFramework\Db\DoesNotExistException; + +use OCA\News\Db\Feed; +use OCA\News\Db\Item; +use OCA\News\Db\FeedMapper; +use OCA\News\Db\ItemMapper; +use OCA\News\Fetcher\Fetcher; +use OCA\News\Config\Config; +use OCA\News\Utility\Time; +use Psr\Log\LoggerInterface; + +/** + * Class FeedService + * + * @package OCA\News\Service + */ +class FeedServiceV2 extends Service +{ + /** + * Class to fetch feeds. + * @var FeedFetcher + */ + protected $feedFetcher; + /** + * Items service. + * + * @var ItemServiceV2 + */ + protected $itemService; + /** + * HTML Purifier + * @var HTMLPurifier + */ + protected $purifier; + + /** + * FeedService constructor. + * + * @param FeedMapperV2 $mapper DB layer for feeds + * @param FeedFetcher $feedFetcher FeedIO interface + * @param ItemServiceV2 $itemService Service to manage items + * @param HTMLPurifier $purifier HTML Purifier + * @param LoggerInterface $logger Logger + */ + public function __construct( + FeedMapperV2 $mapper, + FeedFetcher $feedFetcher, + ItemServiceV2 $itemService, + HTMLPurifier $purifier, + LoggerInterface $logger + ) { + parent::__construct($mapper, $logger); + + $this->feedFetcher = $feedFetcher; + $this->itemService = $itemService; + $this->purifier = $purifier; + } + + /** + * Finds all feeds of a user + * + * @param string $userId the name of the user + * + * @return Feed[] + */ + public function findAllForUser(string $userId): array + { + return $this->mapper->findAllFromUser($userId); + } + + /** + * Finds a feed of a user + * + * @param string $userId the name of the user + * @param string $id the id of the feed + * + * @return Feed + * + * @throws DoesNotExistException + * @throws MultipleObjectsReturnedException + */ + public function findForUser(string $userId, string $id): Feed + { + return $this->mapper->findFromUser($userId, $id); + } + + /** + * @param int $id + * + * @return Feed[] + */ + public function findAllFromFolder(int $id): array + { + return $this->mapper->findAllFromFolder($id); + } + + /** + * Finds all feeds of a user and all items in it + * + * @param string $userId the name of the user + * + * @return Feed[] + */ + public function findAllForUserRecursive(string $userId): array + { + $feeds = $this->mapper->findAllFromUser($userId); + + foreach ($feeds as &$feed) { + $items = $this->itemService->findAllForFeed($feed->getId()); + $feed->items = $items; + } + return $feeds; + } + + /** + * Finds all feeds + * + * @return Feed[] + */ + public function findAll(): array + { + return $this->mapper->findAll(); + } + + /** + * Check if a feed exists for a user + * + * @param string $userID the name of the user + * @param string $url the feed URL + * + * @return bool + */ + public function existsForUser(string $userID, string $url): bool + { + try { + $this->mapper->findByURL($userID, $url); + return true; + } catch (DoesNotExistException $e) { + return false; + } + } + + + /** + * Creates a new feed + * + * @param string $userId Feed owner + * @param string $feedUrl Feed URL + * @param int $folderId Target folder, defaults to root + * @param string|null $title The OPML feed title + * @param string|null $user Basic auth username, if set + * @param string|null $password Basic auth password if username is set + * + * @return Feed the newly created feed + * + * @throws ServiceConflictException The feed already exists + * @throws ServiceNotFoundException The url points to an invalid feed + */ + public function create( + string $userId, + string $feedUrl, + int $folderId = 0, + bool $full_text = false, + ?string $title = null, + ?string $user = null, + ?string $password = null + ): Feed { + if ($this->existsForUser($userId, $feedUrl)) { + throw new ServiceConflictException('Feed with this URL exists'); + } + + try { + /** + * @var Feed $feed + * @var Item[] $items + */ + list($feed, $items) = $this->feedFetcher->fetch($feedUrl, true, $full_text, false, $user, $password); + if ($feed === null) { + throw new ServiceNotFoundException('Failed to fetch feed'); + } + + $feed->setFolderId($folderId) + ->setUserId($userId) + ->setArticlesPerUpdate(count($items)); + + if (!is_null($title)) { + $feed->setTitle($title); + } + + if (!is_null($user)) { + $feed->setBasicAuthUser($user) + ->setBasicAuthUser($password); + } + + $feed = $this->mapper->insert($feed); + + return $feed; + } catch (ReadErrorException $ex) { + $this->logger->debug($ex->getMessage()); + throw new ServiceNotFoundException($ex->getMessage()); + } + } + + + /** + * Update a feed + * + * @param Feed $feed Feed item + * @param bool $force update even if the article exists already + * + * @return Feed|Entity Database feed entity + */ + public function fetch(Feed $feed, bool $force = false) + { + if ($feed->getPreventUpdate() === true) { + return $feed; + } + + // for backwards compability it can be that the location is not set + // yet, if so use the url + $location = $feed->getLocation() ?? $feed->getUrl(); + + try { + /** + * @var Feed $feed + * @var Item[] $items + */ + list($fetchedFeed, $items) = $this->feedFetcher->fetch( + $location, + false, + $feed->getHttpLastModified(), + $feed->getFullTextEnabled(), + $feed->getBasicAuthUser(), + $feed->getBasicAuthPassword() + ); + + // if there is no feed it means that no update took place + if (!$fetchedFeed) { + return $feed; + } + + // update number of articles on every feed update + $itemCount = count($items); + + // this is needed to adjust to updates that add more items + // than when the feed was created. You can't update the count + // if it's lower because it may be due to the caching headers + // that were sent as the request and it might cause unwanted + // deletion and reappearing of feeds + if ($itemCount > $feed->getArticlesPerUpdate()) { + $feed->setArticlesPerUpdate($itemCount); + } + + $feed->setHttpLastModified($fetchedFeed->getHttpLastModified()); + $feed->setHttpEtag($fetchedFeed->getHttpEtag()); + $feed->setLocation($fetchedFeed->getLocation()); + + // insert items in reverse order because the first one is + // usually the newest item + for ($i = $itemCount - 1; $i >= 0; $i--) { + $item = $items[$i]; + $item->setFeedId($feed->getId()); + + $item->setTitle($item->getTitle()); + $item->setUrl($item->getUrl()); + $item->setAuthor($item->getAuthor()); + $item->setSearchIndex($item->getSearchIndex()); + $item->setRtl($item->getRtl()); + $item->setLastModified($item->getLastModified()); + $item->setPubDate($item->getPubDate()); + $item->setUpdatedDate($item->getUpdatedDate()); + $item->setEnclosureMime($item->getEnclosureMime()); + $item->setEnclosureLink($item->getEnclosureLink()); + $item->setBody($this->purifier->purify($item->getBody())); + + // update modes: 0 nothing, 1 set unread + if ($feed->getUpdateMode() === 1) { + $item->setUnread(true); + } + + $this->itemService->insertOrUpdate($item); + } + + // mark feed as successfully updated + $feed->setUpdateErrorCount(0); + $feed->setLastUpdateError(null); + } catch (ReadErrorException $ex) { + $feed->setUpdateErrorCount($feed->getUpdateErrorCount() + 1); + $feed->setLastUpdateError($ex->getMessage()); + } + + return $this->mapper->update($feed); + } + + public function delete(string $user, int $id) + { + $feed = $this->mapper->findFromUser($user, $id); + $this->mapper->delete($feed); + } + + public function purgeDeleted() + { + $this->mapper->purgeDeleted(); + } + + public function fetchAll() + { + return $this->mapper->findAll(); + } +} |