/usr/lib/python3/dist-packages/rss2email/feed.py is in rss2email 1:3.9-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 | # -*- coding: utf-8 -*-
# Copyright (C) 2004-2014 Aaron Swartz
# Brian Lalor
# Dean Jackson
# Dennis Keitzel <github@pinshot.net>
# Erik Hetzner
# Etienne Millon <me@emillon.org>
# George Saunders <georgesaunders@gmail.com>
# J. Lewis Muir <jlmuir@imca-cat.org>
# Joey Hess
# Lindsey Smith <lindsey.smith@gmail.com>
# Marcel Ackermann
# Martin 'Joey' Schulze
# Matej Cepl
# W. Trevor King <wking@tremily.us>
#
# This file is part of rss2email.
#
# rss2email 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, either version 2 of the License, or (at your option) version 3 of
# the License.
#
# rss2email 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
# rss2email. If not, see <http://www.gnu.org/licenses/>.
"""Define the ``Feed`` class for handling a single feed
"""
import collections as _collections
from email.mime.message import MIMEMessage as _MIMEMessage
from email.mime.multipart import MIMEMultipart as _MIMEMultipart
from email.utils import formataddr as _formataddr
import hashlib as _hashlib
import html.parser as _html_parser
import re as _re
import socket as _socket
import time as _time
import urllib.error as _urllib_error
import urllib.request as _urllib_request
import uuid as _uuid
import xml.sax as _sax
import xml.sax.saxutils as _saxutils
import feedparser as _feedparser
import html2text as _html2text
from . import __url__
from . import __version__
from . import LOG as _LOG
from . import config as _config
from . import email as _email
from . import error as _error
from . import util as _util
_USER_AGENT = 'rss2email/{} ({})'.format(__version__, __url__)
_feedparser.USER_AGENT = _USER_AGENT
_urllib_request.install_opener(_urllib_request.build_opener())
_SOCKET_ERRORS = []
for e in ['error', 'herror', 'gaierror']:
if hasattr(_socket, e):
_SOCKET_ERRORS.append(getattr(_socket, e))
del e # cleanup namespace
_SOCKET_ERRORS = tuple(_SOCKET_ERRORS)
# drv_libxml2 raises:
# TypeError: 'str' does not support the buffer interface
_feedparser.PREFERRED_XML_PARSERS = []
class Feed (object):
"""Utility class for feed manipulation and storage.
>>> import pickle
>>> import sys
>>> from .config import CONFIG
>>> feed = Feed(
... name='test-feed', url='http://example.com/feed.atom', to='a@b.com')
>>> print(feed)
test-feed (http://example.com/feed.atom -> a@b.com)
>>> feed.section
'feed.test-feed'
>>> feed.from_email
'user@rss2email.invalid'
>>> feed.from_email = 'a@b.com'
>>> feed.save_to_config()
>>> feed.config.write(sys.stdout) # doctest: +REPORT_UDIFF, +ELLIPSIS
[DEFAULT]
from = user@rss2email.invalid
...
verbose = warning
<BLANKLINE>
[feed.test-feed]
url = http://example.com/feed.atom
from = a@b.com
to = a@b.com
<BLANKLINE>
>>> feed.etag = 'dummy etag'
>>> string = pickle.dumps(feed)
>>> feed = pickle.loads(string)
>>> feed.load_from_config(config=CONFIG)
>>> feed.etag
'dummy etag'
>>> feed.url
'http://example.com/feed.atom'
Names can only contain letters, digits, and '._-'. Here the
invalid space causes an exception:
>>> Feed(name='invalid name')
Traceback (most recent call last):
...
rss2email.error.InvalidFeedName: invalid feed name 'invalid name'
However, you aren't restricted to ASCII letters:
>>> Feed(name='Αθήνα')
<Feed Αθήνα (None -> )>
You must define a URL:
>>> Feed(name='feed-without-a-url', to='a@b.com').run(send=False)
Traceback (most recent call last):
...
rss2email.error.InvalidFeedConfig: invalid feed configuration {'url': None}
Cleanup `CONFIG`.
>>> CONFIG['DEFAULT']['to'] = ''
>>> test_section = CONFIG.pop('feed.test-feed')
"""
_name_regexp = _re.compile('^[\w\d.-]+$')
# saved/loaded from feed.dat using __getstate__/__setstate__.
_dynamic_attributes = [
'name',
'etag',
'modified',
'seen',
]
## saved/loaded from ConfigParser instance
# attributes that aren't in DEFAULT
_non_default_configured_attributes = [
'url',
]
# attributes that are in DEFAULT
_default_configured_attributes = [
key.replace('-', '_') for key in _config.CONFIG['DEFAULT'].keys()]
_default_configured_attributes[
_default_configured_attributes.index('from')
] = 'from_email' # `from` is a Python keyword
# all attributes that are saved/loaded from .config
_configured_attributes = (
_non_default_configured_attributes + _default_configured_attributes)
# attribute name -> .config option
_configured_attribute_translations = dict(
(attr,attr) for attr in _non_default_configured_attributes)
_configured_attribute_translations.update(dict(
zip(_default_configured_attributes,
_config.CONFIG['DEFAULT'].keys())))
# .config option -> attribute name
_configured_attribute_inverse_translations = dict(
(v,k) for k,v in _configured_attribute_translations.items())
# hints for value conversion
_boolean_attributes = [
'digest',
'force_from',
'use_publisher_email',
'active',
'date_header',
'trust_guid',
'trust_link',
'html_mail',
'use_css',
'unicode_snob',
'links_after_each_paragraph',
'use_smtp',
'smtp_ssl',
]
_integer_attributes = [
'feed_timeout',
'body_width',
]
_list_attributes = [
'date_header_order',
'encodings',
]
_function_attributes = [
'post_process',
'digest_post_process',
]
def __init__(self, name=None, url=None, to=None, config=None):
self._set_name(name=name)
self.reset()
self.__setstate__(dict(
(attr, getattr(self, attr))
for attr in self._dynamic_attributes))
self.load_from_config(config=config)
if url:
self.url = url
if to:
self.to = to
def __str__(self):
return '{} ({} -> {})'.format(self.name, self.url, self.to)
def __repr__(self):
return '<Feed {}>'.format(str(self))
def __getstate__(self):
"Save dyamic attributes"
return dict(
(key,getattr(self,key)) for key in self._dynamic_attributes)
get_state = __getstate__ # make it publicly accessible
def __setstate__(self, state):
"Restore dynamic attributes"
keys = sorted(state.keys())
if keys != sorted(self._dynamic_attributes):
raise ValueError(state)
self._set_name(name=state['name'])
self.__dict__.update(state)
set_state = __setstate__ # make it publicly accessible
def save_to_config(self):
"Save configured attributes"
data = _collections.OrderedDict()
default = self.config['DEFAULT']
for attr in self._configured_attributes:
key = self._configured_attribute_translations[attr]
value = getattr(self, attr)
if value is not None:
value = self._get_configured_option_value(
attribute=attr, value=value)
if (attr in self._non_default_configured_attributes or
value != default[key]):
data[key] = value
self.config[self.section] = data
def load_from_config(self, config=None):
"Restore configured attributes"
if config is None:
config = _config.CONFIG
self.config = config
if self.section in self.config:
data = self.config[self.section]
else:
data = self.config['DEFAULT']
keys = sorted(data.keys())
expected = sorted(self._configured_attribute_translations.values())
if keys != expected:
for key in expected:
if (key not in keys and
key not in self._non_default_configured_attributes):
raise _error.InvalidFeedConfig(
setting=key, feed=self,
message='missing configuration key: {}'.format(key))
for key in keys:
if key not in expected:
raise _error.InvalidFeedConfig(
setting=key, feed=self,
message='extra configuration key: {}'.format(key))
data = dict(
(self._configured_attribute_inverse_translations[k],
self._get_configured_attribute_value(
attribute=self._configured_attribute_inverse_translations[k],
key=k, data=data))
for k in data.keys())
for attr in self._non_default_configured_attributes:
if attr not in data:
data[attr] = None
self.__dict__.update(data)
def _get_configured_option_value(self, attribute, value):
if value is None:
return ''
elif attribute in self._list_attributes:
return ', '.join(value)
elif attribute in self._function_attributes:
return _util.import_name(value)
return str(value)
def _get_configured_attribute_value(self, attribute, key, data):
if attribute in self._boolean_attributes:
return data.getboolean(key)
elif attribute in self._integer_attributes:
return data.getint(key)
elif attribute in self._list_attributes:
return [x.strip() for x in data[key].split(',')]
elif attribute in self._function_attributes:
if data[key]:
return _util.import_function(data[key])
return None
return data[key]
def reset(self):
"""Reset dynamic data
"""
self.etag = None
self.modified = None
self.seen = {}
def _set_name(self, name):
if not self._name_regexp.match(name):
raise _error.InvalidFeedName(name=name, feed=self)
self.name = name
self.section = 'feed.{}'.format(self.name)
def _fetch(self):
"""Fetch and parse a feed using feedparser.
>>> feed = Feed(
... name='test-feed',
... url='http://feeds.feedburner.com/allthingsrss/hJBr')
>>> parsed = feed._fetch()
>>> parsed.status
200
"""
_LOG.info('fetch {}'.format(self))
if not self.url:
raise _error.InvalidFeedConfig(setting='url', feed=self)
if self.section in self.config:
config = self.config[self.section]
else:
config = self.config['DEFAULT']
proxy = config['proxy']
timeout = config.getint('feed-timeout')
kwargs = {}
if proxy:
kwargs['handlers'] = [_urllib_request.ProxyHandler({'http':proxy})]
f = _util.TimeLimitedFunction(timeout, _feedparser.parse)
return f(self.url, self.etag, modified=self.modified, **kwargs)
def _process(self, parsed):
_LOG.info('process {}'.format(self))
self._check_for_errors(parsed)
for entry in reversed(parsed.entries):
_LOG.debug('processing {}'.format(entry.get('id', 'no-id')))
processed = self._process_entry(parsed=parsed, entry=entry)
if processed:
guid,id_,sender,message = processed
if self.post_process:
message = self.post_process(
feed=self, parsed=parsed, entry=entry, guid=guid,
message=message)
if not message:
continue
yield (guid, id_, sender, message)
def _check_for_errors(self, parsed):
warned = False
status = getattr(parsed, 'status', 200)
_LOG.debug('HTTP status {}'.format(status))
if status == 301:
_LOG.info('redirect {} from {} to {}'.format(
self.name, self.url, parsed['url']))
self.url = parsed['url']
elif status not in [200, 302, 304]:
raise _error.HTTPError(status=status, feed=self)
http_headers = parsed.get('headers', {})
if http_headers:
_LOG.debug('HTTP headers: {}'.format(http_headers))
if not http_headers:
_LOG.warning('could not get HTTP headers: {}'.format(self))
warned = True
else:
if 'html' in http_headers.get('content-type', 'rss'):
_LOG.warning('looks like HTML: {}'.format(self))
warned = True
if http_headers.get('content-length', '1') == '0':
_LOG.warning('empty page: {}'.format(self))
warned = True
version = parsed.get('version', None)
if version:
_LOG.debug('feed version {}'.format(version))
else:
_LOG.warning('unrecognized version: {}'.format(self))
warned = True
exc = parsed.get('bozo_exception', None)
if isinstance(exc, _socket.timeout):
_LOG.error('timed out: {}'.format(self))
warned = True
elif isinstance(exc, OSError):
_LOG.error('{}: {}'.format(exc, self))
warned = True
elif isinstance(exc, _SOCKET_ERRORS):
_LOG.error('{}: {}'.format(exc, self))
warned = True
elif isinstance(exc, _feedparser.zlib.error):
_LOG.error('broken compression: {}'.format(self))
warned = True
elif isinstance(exc, (IOError, AttributeError)):
_LOG.error('{}: {}'.format(exc, self))
warned = True
elif isinstance(exc, KeyboardInterrupt):
raise exc
elif isinstance(exc, _sax.SAXParseException):
_LOG.error('sax parsing error: {}: {}'.format(exc, self))
warned = True
elif (parsed.bozo and
isinstance(exc, _feedparser.CharacterEncodingOverride)):
_LOG.warning(
'incorrectly declared encoding: {}: {}'.format(exc, self))
warned = True
elif (parsed.bozo and isinstance(exc, _feedparser.NonXMLContentType)):
_LOG.warning('non XML Content-Type: {}: {}'.format(exc, self))
warned = True
elif parsed.bozo or exc:
if exc is None:
exc = "can't process"
_LOG.error('processing error: {}: {}'.format(exc, self))
warned = True
if (not warned and
status in [200, 302] and
not parsed.entries and
not version):
raise _error.ProcessingError(parsed=parsed, feed=feed)
def _html2text(self, html, baseurl='', default=None):
self.config.setup_html2text(section=self.section)
try:
return _html2text.html2text(html=html, baseurl=baseurl)
except _html_parser.HTMLParseError as e:
if default is not None:
return default
raise
def _process_entry(self, parsed, entry):
id_ = self._get_entry_id(entry)
# If .trust_guid isn't set, we get back hashes of the content.
# Instead of letting these run wild, we put them in context
# by associating them with the actual ID (if it exists).
guid = entry.get('id', id_)
if isinstance(guid, dict):
guid = guid.values()[0]
if guid in self.seen:
if self.seen[guid]['id'] == id_:
_LOG.debug('already seen {}'.format(id_))
return # already seen
sender = self._get_entry_email(parsed=parsed, entry=entry)
subject = self._get_entry_title(entry)
extra_headers = _collections.OrderedDict((
('Date', self._get_entry_date(entry)),
('Message-ID', '<{}@dev.null.invalid>'.format(_uuid.uuid4())),
('User-Agent', _USER_AGENT),
('X-RSS-Feed', self.url),
('X-RSS-ID', id_),
('X-RSS-URL', self._get_entry_link(entry)),
('X-RSS-TAGS', self._get_entry_tags(entry)),
))
for k,v in extra_headers.items(): # remove empty tags, etc.
if v is None:
extra_headers.pop(k)
if self.bonus_header:
for header in self.bonus_header.splitlines():
if ':' in header:
key,value = header.split(':', 1)
extra_headers[key.strip()] = value.strip()
else:
_LOG.warning(
'malformed bonus-header: {}'.format(
self.bonus_header))
content = self._get_entry_content(entry)
try:
content = self._process_entry_content(
entry=entry, content=content, subject=subject)
except _error.ProcessingError as e:
e.parsed = parsed
raise
message = _email.get_message(
sender=sender,
recipient=self.to,
subject=subject,
body=content['value'],
content_type=content['type'].split('/', 1)[1],
extra_headers=extra_headers,
config=self.config,
section=self.section)
return (guid, id_, sender, message)
def _get_entry_id(self, entry):
"""Get best ID from an entry."""
if self.trust_link:
return entry.get('link', None)
if self.trust_guid:
if getattr(entry, 'id', None):
# Newer versions of feedparser could return a dictionary
if isinstance(entry.id, dict):
return entry.id.values()[0]
return entry.id
content = self._get_entry_content(entry)
content_value = content['value'].strip()
if content_value:
return _hashlib.sha1(
content_value.encode('unicode-escape')).hexdigest()
elif getattr(entry, 'link', None):
return _hashlib.sha1(
entry.link.encode('unicode-escape')).hexdigest()
elif getattr(entry, 'title', None):
return _hashlib.sha1(
entry.title.encode('unicode-escape')).hexdigest()
def _get_entry_link(self, entry):
return entry.get('link', None)
def _get_entry_title(self, entry):
if hasattr(entry, 'title_detail') and entry.title_detail:
title = entry.title_detail.value
if 'html' in entry.title_detail.type:
title = self._html2text(title, default=title)
else:
content = self._get_entry_content(entry)
value = content['value']
if content['type'] in ('text/html', 'application/xhtml+xml'):
value = self._html2text(value, default=value)
title = value[:70]
title = title.replace('\n', ' ').strip()
return title
def _get_entry_date(self, entry):
datetime = _time.gmtime()
if self.date_header:
for datetype in self.date_header_order:
kind = datetype + '_parsed'
if entry.get(kind, None):
datetime = entry[kind]
break
return _time.strftime("%a, %d %b %Y %H:%M:%S -0000", datetime)
def _get_entry_name(self, parsed, entry):
"""Get the best name
>>> import feedparser
>>> f = Feed(name='test-feed')
>>> parsed = feedparser.parse(
... '<feed xmlns="http://www.w3.org/2005/Atom">\\n'
... ' <entry>\\n'
... ' <author>\\n'
... ' <name>Example author</name>\\n'
... ' <email>me@example.com</email>\\n'
... ' <url>http://example.com/</url>\\n'
... ' </author>\\n'
... ' </entry>\\n'
... '</feed>\\n'
... )
>>> entry = parsed.entries[0]
>>> f.name_format = ''
>>> f._get_entry_name(parsed, entry)
''
>>> f.name_format = '{author}'
>>> f._get_entry_name(parsed, entry)
'Example author'
>>> f.name_format = '{feed-title}: {author}'
>>> f._get_entry_name(parsed, entry)
': Example author'
>>> f.name_format = '{author} ({feed.name})'
>>> f._get_entry_name(parsed, entry)
'Example author (test-feed)'
"""
if not self.name_format:
return ''
data = {
'feed': self,
'feed-title': '<feed title>',
'author': '<author>',
'publisher': '<publisher>',
}
feed = parsed.feed
data['feed-title'] = feed.get('title', '')
for x in [entry, feed]:
if 'name' in x.get('author_detail', []):
if x.author_detail.name:
data['author'] = x.author_detail.name
break
if 'name' in feed.get('publisher_detail', []):
data['publisher'] = feed.publisher_detail.name
name = self.name_format.format(**data)
return _html2text.unescape(name)
def _validate_email(self, email, default=None):
"""Do a basic quality check on email address
Return `default` if the address doesn't appear to be
well-formed. If `default` is `None`, return
`self.from_email`.
>>> f = Feed(name='test-feed')
>>> f._validate_email('valid@example.com', 'default@example.com')
'valid@example.com'
>>> f._validate_email('invalid@', 'default@example.com')
'default@example.com'
>>> f._validate_email('@invalid', 'default@example.com')
'default@example.com'
>>> f._validate_email('invalid', 'default@example.com')
'default@example.com'
"""
parts = email.split('@')
if len(parts) != 2 or '' in parts:
if default is None:
return self.from_email
return default
return email
def _get_entry_address(self, parsed, entry):
"""Get the best From email address ('<jdoe@a.com>')
If the best guess isn't well-formed (something@somthing.com),
use `self.from_email` instead.
"""
if self.force_from:
return self.from_email
feed = parsed.feed
if 'email' in entry.get('author_detail', []):
return self._validate_email(entry.author_detail.email)
elif 'email' in feed.get('author_detail', []):
return self._validate_email(feed.author_detail.email)
if self.use_publisher_email:
if 'email' in feed.get('publisher_detail', []):
return self._validate_email(feed.publisher_detail.email)
if feed.get('errorreportsto', None):
return self._validate_email(feed.errorreportsto)
_LOG.debug('no sender address found, fallback to default')
return self.from_email
def _get_entry_email(self, parsed, entry):
"""Get the best From email address ('John <jdoe@a.com>')
"""
name = self._get_entry_name(parsed=parsed, entry=entry)
address = self._get_entry_address(parsed=parsed, entry=entry)
return _formataddr((name, address))
def _get_entry_tags(self, entry):
"""Add post tags, if available
>>> f = Feed(name='test-feed')
>>> f._get_entry_tags({
... 'tags': [{'term': 'tag1',
... 'scheme': None,
... 'label': None}]})
'tag1'
>>> f._get_entry_tags({
... 'tags': [{'term': 'tag1',
... 'scheme': None,
... 'label': None},
... {'term': 'tag2',
... 'scheme': None,
... 'label': None}]})
'tag1,tag2'
Test some troublesome cases. No tags:
>>> f._get_entry_tags({})
Empty tags:
>>> f._get_entry_tags({'tags': []})
Tags without a ``term`` entry:
>>> f._get_entry_tags({
... 'tags': [{'scheme': None,
... 'label': None}]})
Tags with an empty term:
>>> f._get_entry_tags({
... 'tags': [{'term': '',
... 'scheme': None,
... 'label': None}]})
"""
taglist = [tag['term'] for tag in entry.get('tags', [])
if tag.get('term', '')]
if taglist:
return ','.join(taglist)
def _get_entry_content(self, entry):
"""Select the best content from an entry.
Returns a feedparser content dict.
"""
# How this works:
# * We have a bunch of potential contents.
# * We go thru looking for our first choice.
# (HTML or text, depending on self.html_mail)
# * If that doesn't work, we go thru looking for our second choice.
# * If that still doesn't work, we just take the first one.
#
# Possible future improvement:
# * Instead of just taking the first one
# pick the one in the "best" language.
# * HACK: hardcoded .html_mail, should take a tuple of media types
contents = list(entry.get('content', []))
if entry.get('summary_detail', None):
contents.append(entry.summary_detail)
if self.html_mail:
types = ['text/html', 'text/plain']
else:
types = ['text/plain', 'text/html']
for content_type in types:
for content in contents:
if content['type'] == content_type:
return content
if contents:
return contents[0]
return {'type': 'text/plain', 'value': ''}
def _process_entry_content(self, entry, content, subject):
"Convert entry content to the requested format."
link = self._get_entry_link(entry)
if self.html_mail:
lines = [
'<!DOCTYPE html>',
'<html>',
' <head>',
]
if self.use_css and self.css:
lines.extend([
' <style type="text/css">',
self.css,
' </style>',
])
lines.extend([
'</head>',
'<body>',
'<div id="entry">',
'<h1 class="header"><a href="{}">{}</a></h1>'.format(
link, subject),
'<div id="body">',
])
if content['type'] in ('text/html', 'application/xhtml+xml'):
lines.append(content['value'].strip())
else:
lines.append(_saxutils.escape(content['value'].strip()))
lines.append('</div>')
lines.extend([
'<div class="footer">'
'<p>URL: <a href="{0}">{0}</a></p>'.format(link),
])
for enclosure in getattr(entry, 'enclosures', []):
if getattr(enclosure, 'url', None):
lines.append(
'<p>Enclosure: <a href="{0}">{0}</a></p>'.format(
enclosure.url))
if getattr(enclosure, 'src', None):
lines.append(
'<p>Enclosure: <a href="{0}">{0}</a></p>'.format(
enclosure.src))
lines.append(
'<p><img src="{}" /></p>'.format(enclosure.src))
for elink in getattr(entry, 'links', []):
if elink.get('rel', None) == 'via':
url = elink['href']
title = elink.get('title', url)
lines.append('<p>Via <a href="{}">{}</a></p>'.format(
url, title))
lines.extend([
'</div>', # /footer
'</div>', # /entry
'</body>',
'</html>',
''])
content['type'] = 'text/html'
content['value'] = '\n'.join(lines)
return content
else: # not self.html_mail
if content['type'] in ('text/html', 'application/xhtml+xml'):
try:
lines = [self._html2text(content['value'])]
except _html_parser.HTMLParseError as e:
raise _error.ProcessingError(parsed=None, feed=self)
else:
lines = [content['value']]
lines.append('')
lines.append('URL: {}'.format(link))
for enclosure in getattr(entry, 'enclosures', []):
if getattr(enclosure, 'url', None):
lines.append('Enclosure: {}'.format(enclosure.url))
if getattr(enclosure, 'src', None):
lines.append('Enclosure: {}'.format(enclosure.src))
for elink in getattr(entry, 'links', []):
if elink.get('rel', None) == 'via':
url = elink['href']
title = elink.get('title', url)
lines.append('Via: {} {}'.format(title, url))
content['type'] = 'text/plain'
content['value'] = '\n'.join(lines)
return content
def _send(self, sender, message):
_LOG.info('send message for {}'.format(self))
section = self.section
if section not in self.config:
section = 'DEFAULT'
_email.send(sender=sender, recipient=self.to, message=message,
config=self.config, section=section)
def run(self, send=True):
"""Fetch and process the feed, mailing entry emails.
>>> feed = Feed(
... name='test-feed',
... url='http://feeds.feedburner.com/allthingsrss/hJBr')
>>> def send(sender, message):
... print('send from {}:'.format(sender))
... print(message.as_string())
>>> feed._send = send
>>> feed.to = 'jdoe@dummy.invalid'
>>> #parsed = feed.run() # enable for debugging
"""
if not self.to:
raise _error.NoToEmailAddress(feed=self)
parsed = self._fetch()
if self.digest:
digest = self._new_digest()
seen = []
for (guid, id_, sender, message) in self._process(parsed):
_LOG.debug('new message: {}'.format(message['Subject']))
if self.digest:
seen.append((guid, id_))
self._append_to_digest(digest=digest, message=message)
else:
if send:
self._send(sender=sender, message=message)
if guid not in self.seen:
self.seen[guid] = {}
self.seen[guid]['id'] = id_
if self.digest and seen:
if self.digest_post_process:
digest = self.digest_post_process(
feed=self, parsed=parsed, seen=seen, message=digest)
if not digest:
return
self._send_digest(
digest=digest, seen=seen, sender=sender, send=send)
self.etag = parsed.get('etag', None)
self.modified = parsed.get('modified', None)
def _new_digest(self):
digest = _MIMEMultipart('digest')
digest['To'] = self.to # TODO: _Header(), _formataddr((recipient_name, recipient_addr))
digest['Subject'] = 'digest for {}'.format(self.name)
digest['Message-ID'] = '<{}@dev.null.invalid>'.format(_uuid.uuid4())
digest['User-Agent'] = _USER_AGENT
digest['X-RSS-Feed'] = self.url
return digest
def _append_to_digest(self, digest, message):
part = _MIMEMessage(message)
part.add_header('Content-Disposition', 'attachment')
digest.attach(part)
def _send_digest(self, digest, seen, sender, send=True):
"""Send a digest message
The date is extracted from the last message in the digest
payload. We assume that this part exists. If you don't have
any messages in the digest, don't call this function.
"""
digest['From'] = sender # TODO: _Header(), _formataddr()...
last_part = digest.get_payload()[-1]
last_message = last_part.get_payload()[0]
digest['Date'] = last_message['Date']
_LOG.debug('new digest for {}'.format(self))
if send:
self._send(sender=sender, message=digest)
for (guid, id_) in seen:
if guid not in self.seen:
self.seen[guid] = {}
self.seen[guid]['id'] = id_
|