first commit

feed2toot/filterentry.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+# Copyright © 2015-2017 Carl Chenet <carl.chenet@ohmytux.com>
+# 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, either version 3 of the License, or
+# any later version.
+#
+# 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/
+
+# Filter an entry of the RSS feeds
+'''Filter an entry of the RSS feeds'''
+
+# standard library imports
+from configparser import SafeConfigParser, NoOptionError, NoSectionError
+import os
+import os.path
+import sys
+
+# 3rd party library imports
+import feedparser
+
+class FilterEntry(object):
+    '''FilterEntry class'''
+    def __init__(self, elements, entry, options, byrsspatterns, rssobject):
+        '''Constructor of the FilterEntry class'''
+        self.matching = {}
+        self.entry = entry
+        self.elements = elements
+        self.options = options
+        self.byrsspatterns = byrsspatterns
+        self.rssobject = rssobject
+        self.main()
+
+    def main(self):
+        '''Main of the FilterEntry class'''
+        for i in self.elements:
+            if i not in self.entry:
+                sys.exit('The element {} is not available in the RSS feed. The available ones are: {}'.format(i, [j for j in self.entry]))
+            # for the case if no pattern at all is defined
+            if not self.options['patterns'] and not self.byrsspatterns and not self.rssobject:
+                self.matching[i] = self.entry[i]
+            # global filter only
+            elif self.options['patterns'] and not self.byrsspatterns and not self.rssobject:
+                if not self.options['nopatternurinoglobalpattern']:
+                    self.applyglobalfilter(i)
+                else:
+                    self.matching[i] = self.entry[i]
+            # global filter and then by rss filter
+            elif self.options['patterns'] and self.byrsspatterns and self.rssobject:
+                # patterns by rss
+                self.applyglobalfilter(i)
+                self.applyspecificfilter(i)
+            elif not self.options['patterns'] and self.byrsspatterns and self.rssobject:
+                self.applyspecificfilter(i)
+            else:
+                self.matching[i] = self.entry[i]
+
+    def applyglobalfilter(self, i):
+        '''Apply the global filter'''
+        for patternlist in self.options['patterns']:
+            if not self.options['patternscasesensitive']['{}_case_sensitive'.format(patternlist)]:
+                # not case sensitive, so we compare the lower case
+                for pattern in self.options['patterns'][patternlist]:
+                    finalpattern = pattern.lower() 
+                    finaltitle = self.entry[patternlist.split('_')[0]].lower()
+                    if finalpattern in finaltitle:
+                        self.matching[i] = self.entry[i]
+            else:
+                # case sensitive, so we use the user-defined pattern
+                for pattern in self.options['patterns'][patternlist]:
+                    if pattern in self.entry['title']:
+                        self.matching[i] = self.entry[i]
+
+    def applyspecificfilter(self, i):
+        '''Apply specific filters for by-rss pattern matching'''
+        for byrsspattern in self.byrsspatterns:
+            byrssfinalpattern = byrsspattern.lower()
+            if byrssfinalpattern in self.entry[self.rssobject].lower():
+                self.matching[i] = self.entry[i]
+
+    @property
+    def finalentry(self):
+        '''Return the processed entry'''
+        return self.matching