diff --git a/platypush/backend/http/request/__init__.py b/platypush/backend/http/request/__init__.py deleted file mode 100644 index c9a41426e7..0000000000 --- a/platypush/backend/http/request/__init__.py +++ /dev/null @@ -1,123 +0,0 @@ -import logging -import time -from threading import Thread - -import requests -from frozendict import frozendict - -from platypush.message.event.http import HttpEvent - - -class HttpRequest: - """ - Backend used for polling HTTP resources. - """ - - poll_seconds = 60 - timeout = 5 - - class HttpRequestArguments: - """ - Models the properties of an HTTP request. - """ - - def __init__(self, url, *args, method='get', **kwargs): - self.method = method.lower() - self.url = url - self.args = args - self.kwargs = kwargs - - def __init__( - self, args, bus=None, poll_seconds=None, timeout=None, skip_first_call=True, **_ - ): - super().__init__() - - self.poll_seconds = poll_seconds or self.poll_seconds - self.timeout = timeout or self.timeout - self.bus = bus - self.skip_first_call = skip_first_call - self.last_request_timestamp = 0 - self.logger = logging.getLogger('platypush') - - if isinstance(args, self.HttpRequestArguments): - self.args = args - elif isinstance(args, dict): - self.args = self.HttpRequestArguments(**args) - else: - raise RuntimeError('{} is neither a dictionary nor an HttpRequest') - - if 'timeout' not in self.args.kwargs: - self.args.kwargs['timeout'] = self.timeout - - self.request_args = { - 'method': self.args.method, - 'url': self.args.url, - **self.args.kwargs, - } - - def execute(self): - def _thread_func(): - is_first_call = self.last_request_timestamp == 0 - self.last_request_timestamp = time.time() - - try: - method = getattr(requests, self.args.method.lower()) - response = method(self.args.url, *self.args.args, **self.args.kwargs) - new_items = self.get_new_items(response) - - if isinstance(new_items, HttpEvent): - event = new_items - new_items = event.args['response'] - else: - event = HttpEvent(dict(self), new_items) - - if ( - new_items - and self.bus - and ( - not self.skip_first_call - or (self.skip_first_call and not is_first_call) - ) - ): - self.bus.post(event) - - response.raise_for_status() - except Exception as e: - self.logger.exception(e) - self.logger.warning( - 'Encountered an error while retrieving %s: %s', self.args.url, e - ) - - Thread(target=_thread_func, name='HttpPoll').start() - - def get_new_items(self, *_, **__): - """Gets new items out of a response""" - raise NotImplementedError( - "get_new_items must be implemented in a derived class" - ) - - def __iter__(self): - """ - :return: The ``request_args`` as key-value pairs. - """ - for key, value in self.request_args.items(): - yield key, value - - -def deep_freeze(x): - """ - Deep freezes a Python object - works for strings, dictionaries, sets and - iterables. - """ - - if isinstance(x, str) or not hasattr(x, "__len__"): - return x - if hasattr(x, "keys") and hasattr(x, "values"): - return frozendict({deep_freeze(k): deep_freeze(v) for k, v in x.items()}) - if hasattr(x, "__getitem__"): - return tuple(map(deep_freeze, x)) - - return frozenset(map(deep_freeze, x)) - - -# vim:sw=4:ts=4:et: diff --git a/platypush/backend/http/request/rss/__init__.py b/platypush/backend/http/request/rss/__init__.py deleted file mode 100644 index dc6b2c42f6..0000000000 --- a/platypush/backend/http/request/rss/__init__.py +++ /dev/null @@ -1,377 +0,0 @@ -import datetime -import enum -import os - -from sqlalchemy import ( - create_engine, - Column, - Integer, - String, - DateTime, - Enum, - ForeignKey, -) - -from sqlalchemy.orm import sessionmaker, scoped_session -from sqlalchemy.sql.expression import func - -from platypush.backend.http.request import HttpRequest -from platypush.common.db import declarative_base -from platypush.config import Config -from platypush.context import get_plugin -from platypush.message.event.http.rss import NewFeedEvent - -Base = declarative_base() -Session = scoped_session(sessionmaker()) - - -class RssUpdates(HttpRequest): - """ - Gets new items in an RSS feed. You can use this type of object within the context of the - :class:`platypush.backend.http.poll.HttpPollBackend` backend. Example: - - .. code-block:: yaml - - backend.http.poll: - requests: - - type: platypush.backend.http.request.rss.RssUpdates - url: https://www.technologyreview.com/feed/ - title: MIT Technology Review - poll_seconds: 86400 # Poll once a day - digest_format: html # Generate an HTML feed with the new items - - """ - - user_agent = ( - 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) ' - + 'Chrome/62.0.3202.94 Safari/537.36' - ) - - def __init__( - self, - url, - title=None, - headers=None, - params=None, - max_entries=None, - extract_content=False, - digest_format=None, - user_agent: str = user_agent, - body_style: str = 'font-size: 22px; ' - + 'font-family: "Merriweather", Georgia, "Times New Roman", Times, serif;', - title_style: str = 'margin-top: 30px', - subtitle_style: str = 'margin-top: 10px; page-break-after: always', - article_title_style: str = 'page-break-before: always', - article_link_style: str = 'color: #555; text-decoration: none; border-bottom: 1px dotted', - article_content_style: str = '', - *argv, - **kwargs, - ): - """ - :param url: URL to the RSS feed to be monitored. - :param title: Optional title for the feed. - :param headers: Extra headers to be passed to the request. - :param params: Extra GET parameters to be appended to the URL. - :param max_entries: Maximum number of entries that will be returned in a single - :class:`platypush.message.event.http.rss.NewFeedEvent` event. - :param extract_content: Whether the context should also be extracted (through the - :class:`platypush.plugins.http.webpage.HttpWebpagePlugin` plugin) (default: ``False``). - :param digest_format: Format of the digest output file (default: None, text. Other supported types: ``html`` - and ``pdf`` (requires the ``weasyprint`` module installed). - :param user_agent: User agent string to be passed on the request. - :param body_style: CSS style for the body. - :param title_style: CSS style for the feed title. - :param subtitle_style: CSS style for the feed subtitle. - :param article_title_style: CSS style for the article titles. - :param article_link_style: CSS style for the article link. - :param article_content_style: CSS style for the article content. - """ - self.workdir = os.path.join(os.path.expanduser(Config.get('workdir')), 'feeds') - self.dbfile = os.path.join(self.workdir, 'rss.db') - self.url = url - self.title = title - self.max_entries = max_entries - self.user_agent = user_agent - self.body_style = body_style - self.title_style = title_style - self.subtitle_style = subtitle_style - self.article_title_style = article_title_style - self.article_link_style = article_link_style - self.article_content_style = article_content_style - - # If true, then the http.webpage plugin will be used to parse the content - self.extract_content = extract_content - - self.digest_format = ( - digest_format.lower() if digest_format else None - ) # Supported formats: html, pdf - - os.makedirs(os.path.expanduser(os.path.dirname(self.dbfile)), exist_ok=True) - - if headers is None: - headers = {} - headers['User-Agent'] = self.user_agent - - request_args = { - 'method': 'get', - 'url': self.url, - 'headers': headers, - 'params': params or {}, - } - - super().__init__(skip_first_call=False, args=request_args, *argv, **kwargs) - - def _get_or_create_source(self, session): - record = session.query(FeedSource).filter_by(url=self.url).first() - if record is None: - record = FeedSource(url=self.url, title=self.title) - session.add(record) - - session.commit() - return record - - @staticmethod - def _get_latest_update(session, source_id): - return ( - session.query(func.max(FeedEntry.published)) - .filter_by(source_id=source_id) - .scalar() - ) - - def _parse_entry_content(self, link): - self.logger.info('Extracting content from {}'.format(link)) - - parser = get_plugin('http.webpage') - response = parser.simplify(link) - output = response.output - errors = response.errors - - if not output: - self.logger.warning( - 'Mercury parser error: {}'.format(errors or '[unknown error]') - ) - return - - return output.get('content') - - def get_new_items(self, response): - import feedparser - - engine = create_engine( - 'sqlite:///{}'.format(self.dbfile), - connect_args={'check_same_thread': False}, - ) - - Base.metadata.create_all(engine) - Session.configure(bind=engine) - self._get_or_create_source(session=Session()) - - feed = feedparser.parse(response.text) - session = Session() - source_record = self._get_or_create_source(session=session) - session.add(source_record) - parse_start_time = datetime.datetime.utcnow() - entries = [] - latest_update = self._get_latest_update(session, source_record.id) - - if not self.title and 'title' in feed.feed: - self.title = feed.feed['title'] - source_record.title = self.title - - content = u''' -