├── .gitignore ├── LICENSE ├── README.md ├── config_template.py ├── mwc.py ├── mwcfeedserver.py └── mwctools.py /.gitignore: -------------------------------------------------------------------------------- 1 | /soupselect.py 2 | /config.py 3 | /config_*.py 4 | /*.txt 5 | *~ 6 | *.pyc 7 | 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | Python script to keep track of website changes (or parts of websites); sends email notifications on updates 294 | Copyright (C) 2013 Debianguru 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MailWebsiteChanges 2 | 3 | Python script to keep track of website changes; sends email notifications on updates and/or also provides an RSS feed 4 | 5 | To specify which parts of a website should be monitored, XPath selectors (e.g. "//h1"), CSS selectors (e.g. "h1"), and regular expressions can be used (just choose the tools you like!). 6 | 7 | MailWebsiteChanges is related to PageMonitor for Chrome and AlertBox / Check4Change 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. 8 | 9 | 10 | This is Open Source -- so please contribute eagerly! ;-) 11 | 12 | 13 | ## Configuration 14 | Configuration can be done by creating a config.py file (just place this file in the program folder): 15 | Some examples: 16 | 17 | ### Website definitions 18 | 
 19 | 
 20 | sites = [
 21 | 
 22 |          {'name': 'example-css',
 23 |           'parsers': [uri(uri='https://github.com/mtill', contenttype='html'),
 24 |                       css(contentcss='div')
 25 |                      ]
 26 |          },
 27 | 
 28 |          {'name': 'example-xpath',
 29 |           'parsers': [uri(uri='https://example-webpage.com/test', contenttype='html'),
 30 |                       xpath(contentxpath='//div[contains(concat(\' \', normalize-space(@class), \' \'), \' package-version-header \')]')
 31 |                      ]
 32 |          },
 33 | 
 34 |          {'name': 'my-script',
 35 |           'parsers': [command(command='/home/user/script.sh', contenttype='text'),
 36 |                       regex(contentregex='^.*$')
 37 |                      ]
 38 |          }
 39 | 
 40 | ]
 41 | 
 42 |
43 | 44 | * parameters: 45 | 46 | * name 47 | name of the entry, used as an identifier when sending email notifications 48 | * receiver (optional) 49 | Overrides global receiver specification. 50 | 51 | * parameters for the URL receiver: 52 | 53 | * uri 54 | URI of the website 55 | * contenttype (optional; default: 'html') 56 | content type, e.g., 'xml'/'html'/'text'. 57 | * enc (optional; default: 'utf-8') 58 | Character encoding of the website, e.g., 'utf-8' or 'iso-8859-1'. 59 | * userAgent (optional) 60 | Defines the user agent string, e.g., 61 | 'userAgent': 'Mozilla/5.0 (X11; Fedora; Linux x86_64; rv:49.0) Gecko/20100101 Firefox/49.0' 62 | * accept (optional) 63 | Defines the accept string, e.g., 64 | 'accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8' 65 | 66 | * parameters for the Command receiver 67 | 68 | * command 69 | the command 70 | * contenttype (optional; default: 'text') 71 | content type, e.g., 'xml'/'html'/'text'. 72 | * enc (optional; default: 'utf-8') 73 | Character encoding of the website, e.g., 'utf-8' or 'iso-8859-1'. 74 | 75 | * parameters for the XPath parser: 76 | 77 | * contentxpath 78 | XPath expression for the content sections to extract 79 | * titlexpath (optional) 80 | XPath expression for the title sections to extract 81 | 82 | * parameters for the CSS parser: 83 | 84 | * contentcss 85 | CSS expression for the content sections to extract 86 | * titlecss (optional) 87 | CSS expression for the title sections to extract 88 | 89 | * parameters for the RegEx parser: 90 | 91 | * contentregex 92 | Regular expression for content parsing 93 | * titleregex (optional) 94 | Regular expression for title parsing 95 | 96 | * We collect some XPath/CSS snippets at this place: Snippet collection - please feel free to add your own definitions! 97 | 98 | * The --dry-run="shortname" option might be useful in order to validate and fine-tune a definition. 99 | 100 | * If you would like to keep the data stored in a different place than the working directory, you can include something like this: 101 | 
102 |    
103 |   os.chdir('/path/to/data/directory')
104 |    
105 |
106 | 107 | ### Mail settings 108 | 
109 | 
110 | enableMailNotifications = True   #enable/disable notification messages; if set to False, only send error messages
111 | maxMailsPerSession = -1   #max. number of mails to send per session; ignored when set to -1
112 | subjectPostfix = 'A website has been updated!'
113 | 
114 | sender = 'me@mymail.com'
115 | smtphost = 'mysmtpprovider.com'
116 | useTLS = True
117 | smtpport = 587
118 | smtpusername = sender
119 | smtppwd = 'mypassword'
120 | receiver = 'me2@mymail.com'   # set to '' to also disable notifications in case of errors (not recommended)
121 | 
122 |
123 | 124 | 125 | ### RSS Feeds 126 | 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. 127 | 128 | 
129 |  
130 | enableRSSFeed = True   #enable/disable RSS feed
131 | 
132 | rssfile = 'feed.xml'
133 | maxFeeds = 100
134 |  
135 |
136 | 137 | 138 | ### Program execution 139 | To setup a job that periodically runs the script, simply attach something like this to your /etc/crontab: 140 | 
141 |  
142 | 0 8-22/2    * * *   root	/usr/bin/python3 /usr/bin/mwc
143 |  
144 |
145 | This will run the script every two hours between 8am and 10pm. 146 | 147 | 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 my_alternate_config.py, use mwc --config=my_alternate_config. 148 | 149 | 150 | ## Requirements 151 | Requires Python 3, lxml, and cssselect. 152 | 153 | For Ubuntu, type: 154 | 155 | * sudo apt-get install python3-lxml python3-pip 156 | * sudo pip3 install cssselect 157 | 158 | -------------------------------------------------------------------------------- /config_template.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright: (2013-2017) Michael Till Beck 5 | # License: GPL-2.0+ 6 | 7 | 8 | # We collect xpath snippets at this place: 9 | # Snippet collection 10 | # Feel free to contribute! 11 | 12 | 13 | from mwctools import URLReceiver as uri 14 | from mwctools import CommandReceiver as command 15 | from mwctools import XPathParser as xpath 16 | from mwctools import CSSParser as css 17 | from mwctools import RegExParser as regex 18 | from mwctools import Content 19 | from mwctools import Parser 20 | 21 | 22 | sites = [ 23 | 24 | {'name': 'example-css', 25 | 'parsers': [uri(uri='https://github.com/mtill', contenttype='html'), 26 | css(contentcss='div') 27 | ] 28 | }, 29 | 30 | {'name': 'example-xpath', 31 | 'parsers': [uri(uri='https://example-webpage.com/test', contenttype='html'), 32 | xpath(contentxpath='//div[contains(concat(\' \', normalize-space(@class), \' \'), \' package-version-header \')]') 33 | ] 34 | }, 35 | 36 | {'name': 'my-script', 37 | 'parsers': [command(command='/home/user/script.sh', contenttype='text'), 38 | regex(contentregex='^.*$') 39 | ] 40 | } 41 | 42 | ] 43 | 44 | workingDirectory = '/path-to-data-dir/MailWebsiteChanges-data' 45 | 46 | enableMailNotifications = False 47 | maxMailsPerSession = -1 48 | sender = 'me@mymail.com' 49 | smtphost = 'mysmtpprovider.com' 50 | useTLS = True 51 | smtpport = 587 52 | smtpusername = sender 53 | smtppwd = 'mypassword' 54 | receiver = 'me2@mymail.com' 55 | 56 | enableRSSFeed = False 57 | rssfile = 'feed.xml' 58 | maxFeeds = 100 59 | 60 | -------------------------------------------------------------------------------- /mwc.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright: (2013-2017) Michael Till Beck 5 | # License: GPL-2.0+ 6 | 7 | #test 8 | 9 | import io 10 | from lxml import etree 11 | import hashlib 12 | 13 | import smtplib 14 | from email.mime.text import MIMEText 15 | from email.header import Header 16 | from urllib.parse import urljoin 17 | 18 | import os 19 | import sys 20 | import getopt 21 | import traceback 22 | 23 | import time 24 | from time import strftime 25 | import random 26 | 27 | import importlib 28 | config = None 29 | 30 | defaultEncoding = 'utf-8' 31 | 32 | # this is how an empty RSS feed looks like 33 | emptyfeed = """ 34 | 35 | 36 | MailWebsiteChanges Feed 37 | https://github.com/mtill/MailWebsiteChanges 38 | MailWebsiteChanges Feed 39 | 40 | """ 41 | 42 | mailsession = None 43 | 44 | 45 | # generates a new RSS feed item 46 | def genFeedItem(subject, content, link, change): 47 | feeditem = etree.Element('item') 48 | titleitem = etree.Element('title') 49 | titleitem.text = subject + ' #' + str(change) 50 | feeditem.append(titleitem) 51 | linkitem = etree.Element('link') 52 | linkitem.text = link 53 | feeditem.append(linkitem) 54 | descriptionitem = etree.Element('description') 55 | descriptionitem.text = content 56 | feeditem.append(descriptionitem) 57 | guiditem = etree.Element('guid') 58 | guiditem.text = str(random.getrandbits(32)) 59 | feeditem.append(guiditem) 60 | dateitem = etree.Element('pubDate') 61 | dateitem.text = strftime("%a, %d %b %Y %H:%M:%S %Z", time.localtime()) 62 | feeditem.append(dateitem) 63 | 64 | return feeditem 65 | 66 | 67 | # sends mail notification 68 | def sendmail(receivers, subject, content, sendAsHtml, link, encoding=None): 69 | global mailsession, defaultEncoding 70 | 71 | if encoding is None: 72 | encoding = defaultEncoding 73 | 74 | if sendAsHtml: 75 | baseurl = None 76 | if link is not None: 77 | content = '

' + subject + '

\n' + content 78 | baseurl = urljoin(link, '/') 79 | mail = MIMEText('' + subject + '' + ('' if baseurl else '') + '' + content + '', 'html', encoding) 80 | else: 81 | if link is not None: 82 | content = link + '\n\n' + content 83 | mail = MIMEText(content, 'plain', encoding) 84 | 85 | mail['From'] = config.sender 86 | mail['To'] = ", ".join(receivers) 87 | mail['Subject'] = Header(subject, encoding) 88 | 89 | # initialize session once, not each time this method gets called 90 | if mailsession is None: 91 | mailsession = smtplib.SMTP(config.smtphost, config.smtpport) 92 | if config.useTLS: 93 | mailsession.ehlo() 94 | mailsession.starttls() 95 | if config.smtpusername is not None: 96 | mailsession.login(config.smtpusername, config.smtppwd) 97 | 98 | mailsession.send_message(mail) 99 | 100 | 101 | # returns a list of all content that is stored locally for a specific site 102 | def getStoredHashes(name): 103 | result = [] 104 | filename = os.path.join(config.workingDirectory, name + ".txt") 105 | if os.path.exists(filename): 106 | with open(filename, 'r') as thefile: 107 | for line in thefile: 108 | result.append(line.rstrip()) 109 | 110 | return result 111 | 112 | 113 | # updates list of content that is stored locally for a specific site 114 | def storeHashes(name, contentHashes): 115 | with open(os.path.join(config.workingDirectory, name + '.txt'), 'w') as thefile: 116 | for h in contentHashes: 117 | thefile.write(h + "\n") 118 | 119 | 120 | def runParsers(parsers, contentList=None): 121 | if contentList is None: 122 | contentList = [] 123 | 124 | for parser in parsers: 125 | contentList = parser.performAction(contentList) 126 | 127 | return contentList 128 | 129 | 130 | def pollWebsites(): 131 | global defaultEncoding 132 | 133 | # parse existing feed or create a new one 134 | rssfile = config.rssfile 135 | if not os.path.isabs(rssfile): 136 | rssfile = os.path.join(config.workingDirectory, rssfile) 137 | 138 | if config.enableRSSFeed: 139 | if os.path.isfile(rssfile): 140 | feedXML = etree.parse(rssfile) 141 | else: 142 | feedXML = etree.parse(io.StringIO(emptyfeed)) 143 | 144 | # start polling sites 145 | mailsSent = 0 146 | for site in config.sites: 147 | print('polling site [' + site['name'] + '] ...') 148 | receiver = site.get('receiver', config.receiver) 149 | 150 | try: 151 | contentList = runParsers(site['parsers']) 152 | except Exception as e: 153 | # if something went wrong, notify the user 154 | subject = '[' + site['name'] + '] WARNING' 155 | print('WARNING: ' + str(e)) 156 | if config.enableMailNotifications: 157 | if config.maxMailsPerSession == -1 or mailsSent < config.maxMailsPerSession: 158 | sendmail(receivers=[receiver], subject=subject, content=str(e), sendAsHtml=False, link=None) 159 | mailsSent = mailsSent + 1 160 | if config.enableRSSFeed: 161 | feedXML.xpath('//channel')[0].append(genFeedItem(subject, str(e), "", 0)) 162 | continue 163 | 164 | sessionHashes = [] 165 | changedContents = [] 166 | fileHashes = getStoredHashes(site['name']) 167 | for content in contentList: 168 | 169 | contenthash = hashlib.md5(content.content.encode(content.encoding)).hexdigest() 170 | if contenthash not in fileHashes: 171 | if (not config.enableMailNotifications) or config.maxMailsPerSession == -1 or mailsSent < config.maxMailsPerSession: 172 | sessionHashes.append(contenthash) 173 | changedContents.append(content) 174 | 175 | subject = '[' + site['name'] + '] ' + ("Update available" if content.title is None else content.title) 176 | print(' ' + subject) 177 | if config.enableMailNotifications and len(fileHashes) > 0: 178 | sendAsHtml = (content.contenttype == 'html') 179 | contentReceivers = [receiver] 180 | if content.receivers is not None: 181 | contentReceivers.extend(content.receivers) 182 | sendmail(receivers=contentReceivers, subject=subject, content=content.content, sendAsHtml=sendAsHtml, link=content.uri, encoding=content.encoding) 183 | mailsSent = mailsSent + 1 184 | 185 | if config.enableRSSFeed: 186 | feedXML.xpath('//channel')[0].append(genFeedItem(subject, content.content, content.uri, len(changedContents))) 187 | else: 188 | sessionHashes.append(contenthash) 189 | 190 | if 'postRun' in site: 191 | runParsers(site['postRun'], changedContents) 192 | 193 | if len(changedContents) > 0: 194 | if site.get("keepHashes", False): 195 | sessionHashes.extend(fileHashes) 196 | storeHashes(site['name'], sessionHashes) 197 | print(' ' + str(len(changedContents)) + ' updates') 198 | 199 | # store feed 200 | if config.enableRSSFeed: 201 | for o in feedXML.xpath('//channel/item[position() 5 | # License: GPL-2.0+ 6 | 7 | 8 | import http.server 9 | import socketserver 10 | import importlib 11 | import sys 12 | import getopt 13 | 14 | 15 | bind = 'localhost' 16 | port = 8000 17 | configMod = 'config' 18 | 19 | 20 | try: 21 | opts, args = getopt.getopt(sys.argv[1:], 'hc:b:p:', ['help', 'config=', 'bind=', 'port=']) 22 | except getopt.GetoptError: 23 | print('Usage: FeedServer.py --config=config --port=8000 --bind=localhost') 24 | sys.exit(1) 25 | 26 | for opt, arg in opts: 27 | if opt == '-h': 28 | print('Usage: FeedServer.py --config=config --bind=localhost --port=8000') 29 | exit() 30 | elif opt in ('-c', '--config'): 31 | configMod = arg 32 | elif opt in ('-b', '--bind'): 33 | bind = arg 34 | elif opt in ('-p', '--port'): 35 | port = int(arg) 36 | 37 | config = importlib.import_module(configMod) 38 | 39 | 40 | handler = http.server.SimpleHTTPRequestHandler 41 | 42 | httpd = socketserver.TCPServer((bind, port), handler) 43 | 44 | print('Bond to ' + bind + ', listening on port ' + str(port)) 45 | httpd.serve_forever() 46 | 47 | -------------------------------------------------------------------------------- /mwctools.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright: (2013-2017) Michael Till Beck 5 | # License: GPL-2.0+ 6 | 7 | 8 | import urllib.request 9 | import urllib.error 10 | import urllib.parse 11 | import subprocess 12 | 13 | from lxml import etree 14 | from cssselect import GenericTranslator 15 | import re 16 | 17 | 18 | # Attributes in HTML files storing URI values. These values are automatically translated to absolute URIs. 19 | uriAttributes = [['//img[@src]', 'src'], ['//a[@href]', 'href']] 20 | 21 | maxTitleLength = 150 22 | 23 | 24 | class Parser: 25 | # input: [Content], output: [Content] 26 | def performAction(self, contentList): 27 | pass 28 | 29 | 30 | class Receiver(Parser): 31 | def __init__(self, uri): 32 | self.uri = uri 33 | 34 | 35 | class Content: 36 | def __init__(self, uri, encoding, title, content, contenttype, additional=None, receivers=None): 37 | self.uri = uri 38 | self.encoding = encoding 39 | self.title = title 40 | self.content = content 41 | self.contenttype = contenttype 42 | self.additional = additional 43 | self.receivers = receivers 44 | 45 | 46 | # returns a short subject line 47 | def getSubject(textContent): 48 | global maxTitleLength 49 | 50 | if textContent is None or len(textContent.strip()) == 0: 51 | return 'Website has been updated' 52 | textContent = re.sub(' +', ' ', re.sub('\\s', ' ', textContent)).strip() 53 | return (textContent[:maxTitleLength] + ' [..]') if len(textContent) > maxTitleLength else textContent 54 | 55 | 56 | # translates all relative URIs found in trees to absolute URIs 57 | def toAbsoluteURIs(trees, baseuri): 58 | global uriAttributes 59 | 60 | for tree in trees: 61 | if isinstance(tree, str): 62 | continue 63 | for uriAttribute in uriAttributes: 64 | tags = tree.xpath(uriAttribute[0]) 65 | for tag in tags: 66 | if tag.attrib.get(uriAttribute[1]) is not None: 67 | if urllib.parse.urlparse(tag.attrib[uriAttribute[1]]).scheme == '': 68 | tag.attrib[uriAttribute[1]] = urllib.parse.urljoin(baseuri, tag.attrib[uriAttribute[1]]) 69 | 70 | 71 | class URLReceiver(Receiver): 72 | def __init__(self, uri, contenttype='html', encoding='utf-8', userAgent=None, accept=None): 73 | super().__init__(uri) 74 | self.contenttype = contenttype 75 | self.encoding = encoding 76 | self.userAgent = userAgent 77 | self.accept = accept 78 | 79 | # input: [Content], output: [Content] 80 | def performAction(self, contentList=None): 81 | if contentList is None: 82 | contentList = [] 83 | 84 | # open website 85 | req = urllib.request.Request(self.uri) 86 | if self.userAgent is not None: 87 | req.add_header('User-Agent', self.userAgent) 88 | if self.accept is not None: 89 | req.add_header('Accept', self.accept) 90 | 91 | with urllib.request.urlopen(req) as thefile: 92 | filecontent = thefile.read().decode(self.encoding, errors='ignore') 93 | contentList.append(Content(uri=self.uri, encoding=self.encoding, title=None, content=filecontent, contenttype=self.contenttype)) 94 | 95 | return contentList 96 | 97 | 98 | class CommandReceiver(Receiver): 99 | def __init__(self, command, contenttype='text', encoding='utf-8'): 100 | super().__init__(command) 101 | self.encoding = encoding 102 | self.command = command 103 | self.contenttype = contenttype 104 | 105 | # input: [Content], output: [Content] 106 | def performAction(self, contentList=None): 107 | if contentList is None: 108 | contentList = [] 109 | 110 | # run command and retrieve output 111 | process = subprocess.Popen(self.command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, shell=True, close_fds=True) 112 | thefile = process.stdout 113 | result = thefile.read().decode(self.encoding, errors='ignore') 114 | thefile.close() 115 | 116 | if process.wait() != 0: 117 | raise Exception("process terminated with an error: " + str(process.stderr) + "\n" + result) 118 | 119 | contentList.append(Content(uri=None, encoding=self.encoding, title=None, content=result, contenttype=self.contenttype)) 120 | return contentList 121 | 122 | 123 | class XPathParser(Parser): 124 | def __init__(self, contentxpath, titlexpath=None): 125 | self.contentxpath = contentxpath 126 | self.titlexpath = titlexpath 127 | 128 | # input: [Content], output: [Content] 129 | def performAction(self, contentList): 130 | result = [] 131 | for content in contentList: 132 | result.extend(self.parseOneObject(content)) 133 | return result 134 | 135 | # input: Content, output: [Content] 136 | def parseOneObject(self, content): 137 | baseuri = content.uri 138 | if content.contenttype == 'html': 139 | parser = etree.HTMLParser(encoding=content.encoding) 140 | else: 141 | parser = etree.XMLParser(recover=True, encoding=content.encoding) 142 | 143 | tree = etree.fromstring(content.content, parser=parser) 144 | 145 | # xpath 146 | contentresult = [] if self.contentxpath is None else tree.xpath(self.contentxpath) 147 | titleresult = [] if self.titlexpath is None else tree.xpath(self.titlexpath) 148 | 149 | # translate relative URIs to absolute URIs 150 | if content.contenttype == 'html': 151 | basetaglist = tree.xpath('/html/head/base') 152 | if len(basetaglist) != 0: 153 | baseuri = basetaglist[0].attrib['href'] 154 | if len(contentresult) != 0: 155 | toAbsoluteURIs(contentresult, baseuri) 156 | if len(titleresult) != 0: 157 | toAbsoluteURIs(titleresult, baseuri) 158 | 159 | if self.contentxpath and len(contentresult) == 0: 160 | raise Exception('WARNING: content selector became invalid!') 161 | if self.titlexpath and len(titleresult) == 0: 162 | raise Exception('WARNING: title selector became invalid!') 163 | 164 | contents = [] 165 | titles = [] 166 | if isinstance(contentresult, str): 167 | contents = [contentresult] 168 | else: 169 | if len(contentresult) == 0: 170 | contentresult = titleresult 171 | contents = [etree.tostring(s, encoding=content.encoding, pretty_print=True).decode(content.encoding, errors='ignore') for s in contentresult] 172 | 173 | if isinstance(titleresult, str): 174 | titles = [getSubject(titleresult)]*len(contents) 175 | else: 176 | if len(titleresult) == 0 or len(titleresult) != len(contentresult): 177 | titleresult = contentresult 178 | titles = [getSubject(etree.tostring(s, method='text', encoding=content.encoding).decode(content.encoding, errors='ignore')) for s in titleresult] 179 | 180 | result = [] 181 | for i in range(0, len(contents)): 182 | result.append(Content(uri=content.uri, encoding=content.encoding, title=titles[i], content=contents[i], contenttype=content.contenttype)) 183 | 184 | return result 185 | 186 | 187 | class CSSParser(Parser): 188 | def __init__(self, contentcss, titlecss=None): 189 | contentxpath = GenericTranslator().css_to_xpath(contentcss) 190 | titlexpath = None 191 | if titlecss is not None: 192 | titlexpath = GenericTranslator().css_to_xpath(titlecss) 193 | 194 | self.xpathparser = XPathParser(contentxpath=contentxpath, titlexpath=titlexpath) 195 | 196 | # input: [Content], output: [Content] 197 | def performAction(self, contentList): 198 | return self.xpathparser.performAction(contentList) 199 | 200 | 201 | class RegExParser(Parser): 202 | def __init__(self, contentregex, titleregex=None): 203 | self.contentregex = contentregex 204 | self.titleregex = titleregex 205 | 206 | # input: [Content], output: [Content] 207 | def performAction(self, contentList): 208 | result = [] 209 | for content in contentList: 210 | result.extend(self.parseOneObject(content)) 211 | return result 212 | 213 | # input: Content, output: [Content] 214 | def parseOneObject(self, content): 215 | contents = [] 216 | titles = [] 217 | if self.contentregex is not None: 218 | for c in re.findall(r'' + self.contentregex, content.content, re.M): 219 | if len(c.strip()) != 0: 220 | contents.append(c) 221 | if self.titleregex is not None: 222 | for c in re.findall(r'' + self.titleregex, content.title, re.M): 223 | if len(c.strip()) != 0: 224 | titles.append(c) 225 | 226 | if self.contentregex is not None and len(contents) == 0: 227 | raise Exception('WARNING: content regex became invalid!') 228 | elif self.titleregex is not None and len(titles) == 0: 229 | raise Exception('WARNING: title regex became invalid!') 230 | else: 231 | if len(contents) == 0: 232 | contents = titles 233 | if len(titles) == 0 or len(titles) != len(contents): 234 | titles = [getSubject(c) for c in contents] 235 | 236 | result = [] 237 | for i in range(0, len(contents)): 238 | result.append(Content(uri=content.uri, encoding=content.encoding, title=titles[i], content=contents[i], contenttype=content.contenttype)) 239 | 240 | return result 241 | 242 | --------------------------------------------------------------------------------