summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2014-09-19 08:48:17 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2014-09-19 08:48:17 +0200
commitb329a335ad10648e64b3de049c083bc04638a072 (patch)
tree8f6b2d26957a67f9b6424a1d4f24149fb3c637bb
Imported Upstream version 1.7.2upstream/1.7.2
-rw-r--r--.gitignore7
-rw-r--r--LICENSE339
-rw-r--r--README.md125
-rw-r--r--config_template.py56
-rwxr-xr-xmwc.py345
-rwxr-xr-xmwcfeedserver.py43
6 files changed, 915 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4ccd411
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+/soupselect.py
+/config.py
+/config_*.py
+/*.txt
+*~
+*.pyc
+
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ce58946
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,339 @@
+GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ Python script to keep track of website changes (or parts of websites); sends email notifications on updates
+ Copyright (C) 2013 Debianguru
+
+ 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 2 of the License, or
+ (at your option) 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, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ {signature of Ty Coon}, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7419ad2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,125 @@
+# MailWebsiteChanges
+
+Python script to keep track of website changes; sends email notifications on updates and/or also provides an RSS feed
+
+To specify which parts of a website should be monitored, <b>XPath selectors</b> (e.g. "//h1"), <b>CSS selectors</b> (e.g. "h1"), <b>and regular expressions can be used</b> (just choose the tools you like!).
+
+MailWebsiteChanges is related to <a href="http://code.google.com/p/pagemon-chrome-ext/">PageMonitor</a> for Chrome and <a href="https://addons.mozilla.org/de/firefox/addon/alertbox/">AlertBox</a> / <a href="https://addons.mozilla.org/de/firefox/addon/check4change/">Check4Change</a> for Firefox. However, instead of living in your web browser, you can run it independently from command line / bash and install it as a simple cron job running on your linux server.
+
+
+<i>This is Open Source -- so please contribute eagerly! ;-)</i>
+
+
+## Configuration
+Configuration can be done by creating a <code>config.py</code> file (just place this file in the program folder):
+Some examples:
+
+### Website definitions
+<pre>
+<code>
+sites = [
+
+ {'shortname': 'mywebsite1',
+ 'uri': 'http://www.mywebsite1.com/info',
+ 'contentcss': 'div'},
+
+ {'shortname': 'mywebsite2',
+ 'uri': 'http://www.mywebsite2.com/info',
+ 'contentxpath': '//*[contains(concat(\' \', normalize-space(@class), \' \'), \' news-list-container \')]',
+ 'titlexpath': '//title'},
+
+ {'shortname': 'mywebsite3',
+ 'uri': 'http://www.mywebsite3.com/info',
+ 'type': 'text',
+ 'contentregex': 'Version\"\:\d*\.\d*'}
+
+]
+</code>
+</pre>
+
+ * parameters:
+
+ * <b>shortname</b>
+ short name of the entry, used as an identifier when sending email notifications
+ * <b>uri</b>
+ URI of the website; If the scheme of the uri is 'cmd://', the string is interpreted as a command and the standard output (stdout) is parsed.
+ * <b>type</b> (optional; default: 'html')
+ content type, e.g., 'xml'/'html'/'text'.
+ * <b>contentxpath</b> / <b>titlexpath</b> (optional)
+ XPath expression for the content/title sections to extract. If you prefer, you could use contentcss/titlecss instead.
+ * <b>contentcss</b> / <b>titlecss</b> (optional)
+ CSS expression for the content/title sections to extract. This is ignored if there is a corresponding XPath definition.
+ * <b>contentregex</b> / <b>titleregex</b> (optional)
+ Regular expression. If XPath/CSS selector is defined, the regular expression is applied afterwards.
+ * <b>encoding</b> (optional; default: 'utf-8')
+ Character encoding of the website, e.g., 'utf-8' or 'iso-8859-1'.
+ * <b>receiver</b> (optional)
+ Overwrites global receiver specification.
+
+
+ * We collect some XPath/CSS snippets at this place: <a href="https://github.com/Debianguru/MailWebsiteChanges/wiki/snippets">Snippet collection</a> - please feel free to add your own definitions!
+
+ * The <b>--dry-run="shortname"</b> option might be useful in order to validate and fine-tune a definition.
+
+ * If you would like to keep the data stored in a different place than the working directory, you can include something like this:
+ <pre>
+ <code>
+ os.chdir('/path/to/data/directory')
+ </code>
+ </pre>
+
+### Mail settings
+<pre>
+<code>
+enableMailNotifications = True #enable/disable notification messages; if set to False, only send error messages
+subjectPostfix = 'A website has been updated!'
+
+sender = 'me@mymail.com'
+smtphost = 'mysmtpprovider.com'
+useTLS = True
+smtpport = 587
+smtpusername = sender
+smtppwd = 'mypassword'
+receiver = 'me2@mymail.com' # set to '' to also disable notifications in case of errors (not recommended)
+</code>
+</pre>
+
+
+### RSS Feeds
+If you prefer to use the RSS feature, you just have to specify the path of the feed file which should be generated by the script (e.g., rssfile = 'feed.xml') and then point your webserver to that file. You can also invoke the mwcfeedserver.py script which implements a very basic webserver.
+
+<pre>
+ <code>
+enableRSSFeed = True #enable/disable RSS feed
+
+rssfile = 'feed.xml'
+maxFeeds = 100
+ </code>
+</pre>
+
+
+### Program execution
+To setup a job that periodically runs the script, simply attach something like this to your /etc/crontab:
+<pre>
+ <code>
+0 8-22/2 * * * root /usr/bin/python3 /usr/bin/mwc
+ </code>
+</pre>
+This will run the script every two hours between 8am and 10pm.
+
+If you prefer invoking the script with an alternate configuration files, simply pass the name of the configuration file as an argument, e.g., for <code>my_alternate_config.py</code>, use <code>mwc --config=my_alternate_config</code>.
+
+
+## Requirements
+Requires Python 3, <a href="http://lxml.de/">lxml</a>, and <a href="http://pythonhosted.org/cssselect/">cssselect</a>.
+For <b>Ubuntu 12.04</b>, type:
+
+ * sudo apt-get install python3 python3-dev python3-setuptools libxml2 libxslt1.1 libxml2-dev libxslt1-dev python-libxml2 python-libxslt1
+ * sudo easy\_install3 pip
+ * sudo pip-3.2 install lxml cssselect
+
+For <b>Ubuntu 14.04</b>, type:
+
+ * sudo apt-get install python3-lxml python3-pip
+ * sudo pip3 install cssselect
+
diff --git a/config_template.py b/config_template.py
new file mode 100644
index 0000000..d7069bb
--- /dev/null
+++ b/config_template.py
@@ -0,0 +1,56 @@
+import os.path
+
+# Copyright: (2013-2014) Michael Till Beck <Debianguru@gmx.de>
+# License: GPL-2.0+
+
+#We collect xpath snippets at this place: <a href="https://github.com/Debianguru/MailWebsiteChanges/wiki/snippets">Snippet collection</a> - please feel free to add your own definitions!
+
+sites = [
+
+ {'shortname': 'mywebsite1',
+ 'uri': 'http://www.mywebsite1.com/info',
+ 'type': 'html',
+ 'titlexpath': '//h1',
+ 'contentxpath': '//div',
+ 'titleregex': '',
+ 'contentregex': '',
+ 'encoding': 'utf-8'},
+
+ {'shortname': 'mywebsite2',
+ 'uri': 'http://www.mywebsite2.com/info',
+ 'type': 'html',
+ 'contentxpath': '//*[contains(concat(\' \', normalize-space(@class), \' \'), \' news-list-container \')]',
+ 'regex': '',
+ 'encoding': 'utf-8'},
+
+ {'shortname': 'mywebsite3',
+ 'uri': 'http://www.mywebsite3.com/info',
+ 'type': 'text',
+ 'contentxpath': '',
+ 'contentregex': 'Version\"\:\d*\.\d*',
+ 'encoding': 'utf-8'},
+
+ {'shortname': 'lscmd',
+ 'uri': 'cmd://ls -l /home/pi',
+ 'contentregex': '.*Desktop.*'
+ }
+
+]
+
+subjectPostfix = 'A website has been updated!'
+
+enableMailNotifications = True
+sender = 'me@mymail.com'
+smtphost = 'mysmtpprovider.com'
+useTLS = True
+smtpport = 587
+smtpusername = sender
+smtppwd = 'mypassword'
+receiver = 'me2@mymail.com'
+
+os.chdir('/var/cache/mwc')
+
+enableRSSFeed = True
+rssfile = 'feed.xml'
+maxFeeds = 100
+
diff --git a/mwc.py b/mwc.py
new file mode 100755
index 0000000..5d7278e
--- /dev/null
+++ b/mwc.py
@@ -0,0 +1,345 @@
+#!/usr/bin/python3
+
+# Copyright: (2013-2014) Michael Till Beck <Debianguru@gmx.de>
+# License: GPL-2.0+
+
+import urllib.request, urllib.error, urllib.parse
+import urllib.parse
+from lxml import etree
+from cssselect import GenericTranslator
+import re
+import io
+
+import smtplib
+from email.mime.text import MIMEText
+from email.header import Header
+from urllib.parse import urljoin
+
+import os
+import sys
+import getopt
+import traceback
+
+import subprocess
+
+import time
+from time import strftime
+import random
+
+import importlib
+config = None
+
+defaultEncoding = 'utf-8'
+maxTitleLength = 150
+
+# this is how an empty feed looks like
+emptyfeed = """<?xml version="1.0"?>
+<rss version="2.0">
+ <channel>
+ <title>MailWebsiteChanges Feed</title>
+ <link>https://github.com/Debianguru/MailWebsiteChanges</link>
+ <description>MailWebsiteChanges Feed</description>
+ </channel>
+</rss>"""
+
+# Attributes in HTML files storing URI values. These values are automatically translated to absolute URIs.
+uriAttributes = [['//img[@src]', 'src'], ['//a[@href]', 'href']]
+cmdscheme = 'cmd://'
+
+mailsession = None
+
+
+# translates all relative URIs found in trees to absolute URIs
+def toAbsoluteURIs(trees, baseuri):
+ for tree in trees:
+ for uriAttribute in uriAttributes:
+ tags = tree.xpath(uriAttribute[0])
+ for tag in tags:
+ if tag.attrib.get(uriAttribute[1]) != None:
+ if urllib.parse.urlparse(tag.attrib[uriAttribute[1]]).scheme == '':
+ tag.attrib[uriAttribute[1]] = urllib.parse.urljoin(baseuri, tag.attrib[uriAttribute[1]])
+
+
+def parseSite(site):
+ file, content, titles, warning = None, None, None, None
+
+ uri = site['uri']
+ contenttype = site.get('type', 'html')
+ contentregex = site.get('contentregex', '')
+ titleregex = site.get('titleregex', '')
+ enc = site.get('encoding', defaultEncoding)
+
+ contentxpath = site.get('contentxpath', '')
+ if contentxpath == '' and site.get('contentcss', '') != '':
+ # CSS
+ contentxpath = GenericTranslator().css_to_xpath(site.get('contentcss'))
+ titlexpath = site.get('titlexpath', '')
+ if titlexpath == '' and site.get('titlecss', '') != '':
+ titlexpath = GenericTranslator().css_to_xpath(site.get('titlecss'))
+
+ try:
+
+ if uri.startswith(cmdscheme):
+ # run command and retrieve output
+ process = subprocess.Popen(uri[len(cmdscheme):], stdout=subprocess.PIPE, shell=True, close_fds=True)
+ file = process.stdout
+ else:
+ # open website
+ file = urllib.request.urlopen(uri)
+
+
+ if contenttype == 'text' or (contentxpath == '' and titlexpath == ''):
+ contents = [file.read().decode(enc)]
+ titles = []
+ else:
+ baseuri = uri
+ if contenttype == 'html':
+ parser = etree.HTMLParser(encoding=enc)
+ else:
+ parser = etree.XMLParser(recover=True, encoding=enc)
+
+ tree = etree.parse(file, parser)
+
+ # xpath
+ contentresult = tree.xpath(contentxpath) if contentxpath else []
+ titleresult = tree.xpath(titlexpath) if titlexpath else []
+
+ # translate relative URIs to absolute URIs
+ if contenttype == 'html':
+ basetaglist = tree.xpath('/html/head/base')
+ if len(basetaglist) != 0:
+ baseuri = basetaglist[0].attrib['href']
+ if len(contentresult) != 0:
+ toAbsoluteURIs(contentresult, baseuri)
+ if len(titleresult) != 0:
+ toAbsoluteURIs(titleresult, baseuri)
+
+ if contentxpath != '' and titlexpath != '' and len(contentresult) != len(titleresult):
+ warning = 'WARNING: number of title blocks (' + str(len(titleresult)) + ') does not match number of content blocks (' + str(len(contentresult)) + ')'
+ elif contentxpath and len(contentresult) == 0:
+ warning = 'WARNING: content selector became invalid!'
+ elif titlexpath and len(titleresult) == 0:
+ warning = 'WARNING: title selector became invalid!'
+ else:
+ if len(contentresult) == 0:
+ contentresult = titleresult
+ if len(titleresult) == 0:
+ titleresult = contentresult
+
+ contents = [etree.tostring(s, encoding=defaultEncoding, pretty_print=True).decode(defaultEncoding) for s in contentresult]
+ titles = [getSubject(' '.join(s.xpath('.//text()'))) for s in titleresult]
+
+ except IOError as e:
+ warning = 'WARNING: could not open URL; maybe content was moved?\n\n' + str(e)
+
+ if file is not None:
+ file.close()
+
+ if uri.startswith(cmdscheme) and process.wait() != 0:
+ warning = 'WARNING: process terminated with an error'
+
+ if warning:
+ return {'content': content, 'titles': titles, 'warning': warning}
+
+ # parse regex
+ if contentregex:
+ contents = [x for y in [re.findall(r'' + contentregex, c, re.S) for c in contents] for x in y]
+ if titleregex:
+ titles = [x for y in [re.findall(r'' + titleregex, c, re.S) for c in titles] for x in y]
+
+ if contentregex and titleregex and len(contents) != len(titles):
+ warning = 'WARNING: number of title blocks (' + str(len(titles)) + ') does not match number of content blocks (' + str(len(contents)) + ') after regex'
+ elif contentregex and len(contents) == 0:
+ warning = 'WARNING: content regex became invalid!'
+ elif titleregex and len(titles) == 0:
+ warning = 'WARNING: title regex became invalid!'
+ else:
+ if len(contents) == 0:
+ contents = titles
+ if len(titles) == 0:
+ titles = [getSubject(c) for c in contents]
+
+ return {'contents': contents, 'titles': titles, 'warning': warning}
+
+
+# returns a short subject line
+def getSubject(textContent):
+ if textContent == None or textContent == '':
+ return config.subjectPostfix
+ textContent = re.sub(' +', ' ', re.sub('\s', ' ', textContent)).strip()
+ return (textContent[:maxTitleLength] + ' [..]') if len(textContent) > maxTitleLength else textContent
+
+
+# generates a new RSS feed item
+def genFeedItem(subject, content, link, change):
+ feeditem = etree.Element('item')
+ titleitem = etree.Element('title')
+ titleitem.text = subject + ' #' + str(change)
+ feeditem.append(titleitem)
+ linkitem = etree.Element('link')
+ linkitem.text = link
+ feeditem.append(linkitem)
+ descriptionitem = etree.Element('description')
+ descriptionitem.text = content
+ feeditem.append(descriptionitem)
+ guiditem = etree.Element('guid')
+ guiditem.text = str(random.getrandbits(32))
+ feeditem.append(guiditem)
+ dateitem = etree.Element('pubDate')
+ dateitem.text = strftime("%a, %d %b %Y %H:%M:%S %Z", time.localtime())
+ feeditem.append(dateitem)
+
+ return feeditem
+
+
+# sends mail notification
+def sendmail(receiver, subject, content, sendAsHtml, link):
+ global mailsession
+
+ if sendAsHtml:
+ baseurl = None
+ if link != None:
+ content = '<p><a href="' + link + '">' + subject + '</a></p>\n' + content
+ baseurl = urljoin(link, '/')
+ mail = MIMEText('<html><head><title>' + subject + '</title>' + ('<base href="' + baseurl + '">' if baseurl else '') + '</head><body>' + content + '</body></html>', 'html', defaultEncoding)
+ else:
+ if link != None:
+ content = link + '\n\n' + content
+ mail = MIMEText(content, 'text', defaultEncoding)
+
+ mail['From'] = config.sender
+ mail['To'] = receiver
+ mail['Subject'] = Header(subject, defaultEncoding)
+
+ # initialize session once, not each time this method gets called
+ if mailsession is None:
+ mailsession = smtplib.SMTP(config.smtphost, config.smtpport)
+ if config.useTLS:
+ mailsession.ehlo()
+ mailsession.starttls()
+ mailsession.login(config.smtpusername, config.smtppwd)
+
+ mailsession.sendmail(config.sender, receiver.split(','), mail.as_string())
+
+
+# returns a list of all content that is stored locally for a specific site
+def getFileContents(shortname):
+ result = []
+ for f in os.listdir('.'):
+ if f.startswith(shortname + '.') and f.endswith('.txt'):
+ file = open(f, 'r')
+ result.append(file.read())
+ file.close()
+ return result
+
+
+# updates list of content that is stored locally for a specific site
+def storeFileContents(shortname, parseResult):
+ for f in os.listdir('.'):
+ if f.startswith(shortname + '.') and f.endswith('.txt'):
+ os.remove(f)
+
+ i = 0
+ for c in parseResult['contents']:
+ file = open(shortname + '.' + str(i) + '.txt', 'w')
+ file.write(c)
+ file.close()
+ i += 1
+
+
+def pollWebsites():
+
+ # parse existing feed or create a new one
+ if config.enableRSSFeed:
+ if os.path.isfile(config.rssfile):
+ feedXML = etree.parse(config.rssfile)
+ else:
+ feedXML = etree.parse(io.StringIO(emptyfeed))
+
+ # start polling sites
+ for site in config.sites:
+
+ print('polling site [' + site['shortname'] + '] ...')
+ parseResult = parseSite(site)
+ receiver = site.get('receiver', config.receiver)
+
+ # if something went wrong, notify the user
+ if parseResult['warning']:
+ subject = '[' + site['shortname'] + '] WARNING'
+ print('WARNING: ' + parseResult['warning'])
+ if config.enableMailNotifications:
+ sendmail(receiver, subject, parseResult['warning'], False, None)
+ if config.enableRSSFeed:
+ feedXML.xpath('//channel')[0].append(genFeedItem(subject, parseResult['warning'], site['uri'], 0))
+ else:
+ # otherwise, check which parts of the site were updated
+ changes = 0
+ fileContents = getFileContents(site['shortname'])
+ i = 0
+ for content in parseResult['contents']:
+ if content not in fileContents:
+ changes += 1
+
+ subject = '[' + site['shortname'] + '] ' + parseResult['titles'][i]
+ print(' ' + subject)
+ if config.enableMailNotifications and len(fileContents) > 0:
+ sendmail(receiver, subject, content, (site.get('type', 'html') == 'html'), site['uri'])
+
+ if config.enableRSSFeed:
+ feedXML.xpath('//channel')[0].append(genFeedItem(subject, content, site['uri'], changes))
+ i += 1
+
+
+ if changes > 0:
+ storeFileContents(site['shortname'], parseResult)
+ print(' ' + str(changes) + ' updates')
+
+ # store feed
+ if config.enableRSSFeed:
+ for o in feedXML.xpath('//channel/item[position()<last()-' + str(config.maxFeeds - 1) + ']'):
+ o.getparent().remove(o)
+ file = open(config.rssfile, 'w')
+ file.write(etree.tostring(feedXML, pretty_print=True, xml_declaration=True, encoding=defaultEncoding).decode(defaultEncoding))
+ file.close()
+
+
+if __name__ == "__main__":
+
+ configMod = 'config'
+ dryrun = None
+
+ try:
+ opts, args = getopt.getopt(sys.argv[1:], 'hc:d:', ['help', 'config=', 'dry-run='])
+ except getopt.GetoptError:
+ print('Usage: mwc.py --config=config --dry-run=shortname')
+ sys.exit(1)
+ for opt, arg in opts:
+ if opt == '-h':
+ print('Usage: mwc.py --config=config')
+ exit()
+ elif opt in ('-c', '--config'):
+ configMod = arg
+ elif opt in ('-d', '--dry-run'):
+ dryrun = arg
+
+ config = importlib.import_module(configMod)
+
+ if dryrun:
+ for site in config.sites:
+ if site['shortname'] == dryrun:
+ parseResult = parseSite(site)
+ print(parseResult)
+ break
+ else:
+ try:
+ pollWebsites()
+ except:
+ msg = str(sys.exc_info()[0]) + '\n\n' + traceback.format_exc()
+ print(msg)
+ if config.receiver != '':
+ sendmail(config.receiver, '[mwc] Something went wrong ...', msg, False, None)
+
+ if mailsession:
+ mailsession.quit()
+ mailsession = None
+
diff --git a/mwcfeedserver.py b/mwcfeedserver.py
new file mode 100755
index 0000000..98093b9
--- /dev/null
+++ b/mwcfeedserver.py
@@ -0,0 +1,43 @@
+#!/usr/bin/python3
+
+# Copyright: (2013-2014) Michael Till Beck <Debianguru@gmx.de>
+# License: GPL-2.0+
+
+import http.server
+import socketserver
+import importlib
+import sys
+import getopt
+
+bind = 'localhost'
+port = 8000
+configMod = 'config'
+
+
+try:
+ opts, args = getopt.getopt(sys.argv[1:], 'hc:b:p:', ['help', 'config=', 'bind=', 'port='])
+except getopt.GetoptError:
+ print('Usage: FeedServer.py --config=config --port=8000')
+ sys.exit(1)
+
+for opt, arg in opts:
+ if opt == '-h':
+ print('Usage: FeedServer.py --config=config --bind=localhost --port=8000')
+ exit()
+ elif opt in ('-c', '--config'):
+ configMod = arg
+ elif opt in ('-b', '--bind'):
+ bind = arg
+ elif opt in ('-p', '--port'):
+ port = int(arg)
+
+config = importlib.import_module(configMod)
+
+
+handler = http.server.SimpleHTTPRequestHandler
+
+httpd = socketserver.TCPServer((bind, port), handler)
+
+print('Bond to ' + bind + ', listening on port ' + str(port))
+httpd.serve_forever()
+