Bump version

[sid.git] / sid / feeds.py

diff --git a/sid/feeds.py b/sid/feeds.py
index 64ddf1217300b548ded94d947a14cc22aba3b9af..3fe7ce9ecdd406dbe9d9ba43b977e01c5e6144ba 100644 (file)
--- a/sid/feeds.py
+++ b/sid/feeds.py
@@ -1,24 +1,30 @@
 # -*- coding: utf-8 -*-
+# SPDX-FileCopyrightText: 2011, 2014, 2020 kaliko <kaliko@azylum.org>
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""Publish news from various Debian feeds (security, planet, package tracker, see :py:obj:`sid.feeds.Feeds.FEEDS` for defaults).
 
-# Copyright (C) 2011, 2014 kaliko <kaliko@azylum.org>
+Can easily be used for other feeds (rss, atom).
 
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 only.
+.. note::
+  Feeds plugin depends on external module: **feedparser**
 
-# This program 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 General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+>>> from sid.feeds import Feeds
+>>> # Time between check in seconds
+>>> Feeds.TEMPO = 60
+>>> # Fedds to monitor, cf. sid.feeds.Feeds.FEEDS for defaults
+>>> Feeds.FEEDS = [
+        'https://example.org/feeds/atom/news.atom.xml'
+        ]
+"""
 
 import datetime
 import threading
 import time
 import traceback
 
+from urllib.error import URLError
+from urllib.parse import urlparse
+
 from feedparser import parse as feed_parse
 
 from .plugin import Plugin, botcmd
@@ -122,7 +128,11 @@ class FeedMonitor(threading.Thread):
             for feed in self.feeds_list:
                 try:
                     self.new_posts(feed)
-                except Exception as err:
+                except ConnectionError as err:  # Non fatal exception
+                    self.plugin.log.error('connection error on %s: %s', feed, err)
+                except URLError as err:  # Non fatal exception
+                    self.plugin.log.error('error for "%s": %s', feed, err.reason)
+                except Exception as err:  # Unknown execption, killing thread anyway
                     self.plugin.log.error('feeds thread crashed: %s', err)
                     self.plugin.log.error(''.join(traceback.format_exc()))
                     self.thread_killed = True
@@ -134,7 +144,14 @@ class FeedMonitor(threading.Thread):
 
 
 class Feeds(Plugin):
+    """
+    .. note::
+      Feeds plugin depends on external module: **feedparser**
+    """
+
+    #: Time between feeds check
     TEMPO = 60
+    #: Default feeds to monitor
     FEEDS = [
         'https://www.debian.org/security/dsa',
         'https://www.debian.org/News/news',
@@ -156,15 +173,18 @@ class Feeds(Plugin):
 
     @botcmd
     def feeds(self, rcv, args):
-        """feeds monitors debian project related feeds.
-        !feeds : registred feeds list
-        !feeds last : last check time"""
+        """Monitors debian project related feeds.
+
+        * ``!feeds``      : registred feeds list
+        * ``!feeds last`` : last check time"""
         if 'last' in args:
-            self.reply(rcv, 'Last feeds check: %s' % self.th_mon.last_check)
+            date = '{:%Y-%m-%d %H:%M} (utc)'.format(self.th_mon.last_check)
+            self.reply(rcv, f'Last feeds check: {date}')
             return
-        html = ['<a href="{0}">{1}</a>'.format(html_escape(u),
-                                               html_escape(u[7:])
-                                              ) for u in Feeds.FEEDS]
+        html = ['<a href="{0}">{1}</a>'.format(
+                                     html_escape(u),
+                                     html_escape('{1}{2}'.format(*urlparse(u)))
+                                     ) for u in Feeds.FEEDS]
         msg = {'mbody': 'Feeds:\n' + '\n'.join(Feeds.FEEDS),
                'mhtml': 'Feeds:<br />' + '<br />'.join(html)}
         self.reply(rcv, msg)