diff options
Diffstat (limited to 'objectapp/ping.py')
-rw-r--r-- | objectapp/ping.py | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/objectapp/ping.py b/objectapp/ping.py new file mode 100644 index 0000000..3a816e3 --- /dev/null +++ b/objectapp/ping.py @@ -0,0 +1,231 @@ +# Copyright (c) 2011, 2012 Free Software Foundation + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details. + +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + + +# This project incorporates work covered by the following copyright and permission notice: + +# Copyright (c) 2009, Julien Fache +# All rights reserved. + +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: + +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of the author nor the names of other +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. + +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +# OF THE POSSIBILITY OF SUCH DAMAGE. + +# Copyright (c) 2011, 2012 Free Software Foundation + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details. + +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + + +"""Pings utilities for Objectapp""" +import socket +import xmlrpclib +import threading +from urllib2 import urlopen +from urlparse import urlsplit +from logging import getLogger + +from BeautifulSoup import BeautifulSoup + +from django.contrib.sites.models import Site +from django.core.urlresolvers import reverse + +from objectapp.settings import PROTOCOL + + +class URLRessources(object): + """Object defining the ressources of the website""" + + def __init__(self): + self.current_site = Site.objects.get_current() + self.site_url = '%s://%s' % (PROTOCOL, self.current_site.domain) + self.blog_url = '%s%s' % (self.site_url, + reverse('objectapp_gbobject_archive_index')) + self.blog_feed = '%s%s' % (self.site_url, + reverse('objectapp_gbobject_latest_feed')) + + +class DirectoryPinger(threading.Thread): + """Threaded Directory Pinger""" + + def __init__(self, server_name, gbobjects, timeout=10, start_now=True): + self.results = [] + self.timeout = timeout + self.gbobjects = gbobjects + self.server_name = server_name + self.server = xmlrpclib.ServerProxy(self.server_name) + self.ressources = URLRessources() + + threading.Thread.__init__(self) + if start_now: + self.start() + + def run(self): + """Ping gbobjects to a Directory in a Thread""" + logger = getLogger('objectapp.ping.directory') + socket.setdefaulttimeout(self.timeout) + for gbobject in self.gbobjects: + reply = self.ping_gbobject(gbobject) + self.results.append(reply) + logger.info('%s : %s' % (self.server_name, reply['message'])) + socket.setdefaulttimeout(None) + + def ping_gbobject(self, gbobject): + """Ping an gbobject to a Directory""" + gbobject_url = '%s%s' % (self.ressources.site_url, + gbobject.get_absolute_url()) + objecttypes = '|'.join([c.title for c in gbobject.objecttypes.all()]) + + try: + reply = self.server.weblogUpdates.extendedPing( + self.ressources.current_site.name, + self.ressources.blog_url, gbobject_url, + self.ressources.blog_feed, objecttypes) + except Exception: + try: + reply = self.server.weblogUpdates.ping( + self.ressources.current_site.name, + self.ressources.blog_url, gbobject_url, + objecttypes) + except Exception: + reply = {'message': '%s is an invalid directory.' % \ + self.server_name, + 'flerror': True} + return reply + + +class ExternalUrlsPinger(threading.Thread): + """Threaded ExternalUrls Pinger""" + + def __init__(self, gbobject, timeout=10, start_now=True): + self.results = [] + self.gbobject = gbobject + self.timeout = timeout + self.ressources = URLRessources() + self.gbobject_url = '%s%s' % (self.ressources.site_url, + self.gbobject.get_absolute_url()) + + threading.Thread.__init__(self) + if start_now: + self.start() + + def run(self): + """Ping external URLS in a Thread""" + logger = getLogger('objectapp.ping.external_urls') + socket.setdefaulttimeout(self.timeout) + + external_urls = self.find_external_urls(self.gbobject) + external_urls_pingable = self.find_pingback_urls(external_urls) + + for url, server_name in external_urls_pingable.items(): + reply = self.pingback_url(server_name, url) + self.results.append(reply) + logger.info('%s : %s' % (url, reply)) + + socket.setdefaulttimeout(None) + + def is_external_url(self, url, site_url): + """Check of the url in an external url""" + url_splitted = urlsplit(url) + if not url_splitted.netloc: + return False + return url_splitted.netloc != urlsplit(site_url).netloc + + def find_external_urls(self, gbobject): + """Find external urls in an gbobject""" + soup = BeautifulSoup(gbobject.html_content) + external_urls = [a['href'] for a in soup.findAll('a') + if self.is_external_url( + a['href'], self.ressources.site_url)] + return external_urls + + def find_pingback_href(self, content): + """Try to find Link markup to pingback url""" + soup = BeautifulSoup(content) + for link in soup.findAll('link'): + dict_attr = dict(link.attrs) + if 'rel' in dict_attr and 'href' in dict_attr: + if dict_attr['rel'].lower() == 'pingback': + return dict_attr.get('href') + + def find_pingback_urls(self, urls): + """Find the pingback urls of each urls""" + pingback_urls = {} + + for url in urls: + try: + page = urlopen(url) + headers = page.info() + + if 'text/' not in headers.get('Content-Type', '').lower(): + continue + + server_url = headers.get('X-Pingback') + if not server_url: + server_url = self.find_pingback_href(page.read()) + + if server_url: + server_url_splitted = urlsplit(server_url) + if not server_url_splitted.netloc: + url_splitted = urlsplit(url) + server_url = '%s://%s%s' % (url_splitted.scheme, + url_splitted.netloc, + server_url) + pingback_urls[url] = server_url + except IOError: + pass + return pingback_urls + + def pingback_url(self, server_name, target_url): + """Do a pingback call for the target url""" + try: + server = xmlrpclib.ServerProxy(server_name) + reply = server.pingback.ping(self.gbobject_url, target_url) + except (xmlrpclib.Error, socket.error): + reply = '%s cannot be pinged.' % target_url + return reply |