Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/plugins/badlinks.py
blob: 85f1aa588ff4bd791c4a3f5c4d2a1473b8783806 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# badlinks.py - plugin to list bad links
#
# Copyright (C) 1998, 1999 Albert Hopkins (marduk) <marduk@python.net>
# Copyright (C) 2002 Mike Meyer <mwm@mired.org>
# Copyright (C) 2005 Arthur de Jong <arthur@tiefighter.et.tudelft.nl>
#
# 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 St, Fifth Floor, Boston, MA  02110-1301 USA

"""Present a listing of links that point to non-existant pages."""

__title__ = 'bad links'
__author__ = 'Arthur de Jong'
__version__ = '1.1'
__description__ = 'These links had problems with retreival during the ' \
                  'crawling of the website.'

import config
import plugins
import xml.sax.saxutils

HTTP_STATUS_CODES = {'100':"Continue",
                     '101':"Switching Protocols",
                     '200':"OK",
                     '201':"Created",
                     '202':"Accepted",
                     '204':"No Content",
                     '205':"Reset Content",
                     '206':"Partial Content",
                     '300':"Multiple Choices",
                     '301':"Moved Permanently",
                     '302':"Moved Temporarily",
                     '303':"See Other",
                     '304':"Not Modified",
                     '305':"Use Proxy",
                     '400':"Bad Request",
                     '401':"Unauthorized",
                     '402':"Payment Required",
                     '403':"Forbidden",
                     '404':"Not Found",
                     '405':"Method Not Allowed",
                     '406':"Not Acceptable",
                     '407':"Proxy Authentication Required",
                     '408':"Request Time-out",
                     '409':"Conflict",
                     '410':"Gone",
                     '411':"Length Required",
                     '412':"Precondition Failed",
                     '413':"Request Entity Too Large",
                     '414':"Request-URI Too Large",
                     '415':"Unsupported Media Type",
                     '500':"Internal Server Error",
                     '501':"Not Implemented",
                     '502':"Bad Gateway",
                     '503':"Service Unavailable",
                     '504':"Gateway Time-out",
                     '505':"HTTP Version not supported"
                     }

def generate(fp,site):
    """Present the list of bad links to the given file descriptor."""
    fp.write('   <ol>\n')
    urls=site.badLinks
    urls.sort()
    for url in urls:
        link=site.linkMap[url]
        status = str(link.status)
        if status in HTTP_STATUS_CODES.keys():
            status = status + "=" + HTTP_STATUS_CODES[status]
        fp.write(
          '    <li>\n' \
          '     %(badurl)s\n' \
          '     <div class="status">%(status)s</div>\n' \
          % { 'badurl':  plugins.make_link(link.URL,link.URL),
              'status':  xml.sax.saxutils.escape(status) })
        # present a list of parents
        link.parents.sort()
        plugins.print_parents(fp,link,'     ')
        # add a reference to the problem map
        for parent in site.linkMap[url].parents:
            plink=site.linkMap[parent]
            plugins.add_problem("Bad Link: " + link.URL, plink)
        fp.write('    </li>\n')
    fp.write('   </ol>\n')