mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-03-17 06:20:27 +00:00
e9805dbd8a
git-svn-id: https://linkchecker.svn.sourceforge.net/svnroot/linkchecker/trunk/linkchecker@3887 e7d03fd6-7b0d-0410-9947-9c21f3af8025
313 lines
12 KiB
Python
313 lines
12 KiB
Python
# -*- coding: iso-8859-1 -*-
|
|
# Copyright (C) 2000-2009 Bastian Kleineidam
|
|
#
|
|
# 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., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
"""
|
|
A HTML logger.
|
|
"""
|
|
import time
|
|
import cgi
|
|
import os
|
|
from . import Logger
|
|
from .. import strformat, configuration
|
|
|
|
|
|
# ss=1 enables show source
|
|
validate_html = "http://validator.w3.org/check?ss=1&uri=%(uri)s"
|
|
# options are the default
|
|
validate_css = "http://jigsaw.w3.org/css-validator/validator?" \
|
|
"uri=%(uri)s&warning=1&profile=css2&usermedium=all"
|
|
|
|
HTML_HEADER = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=%(encoding)s">
|
|
<title>%(title)s</title>
|
|
<style type="text/css">
|
|
<!--
|
|
h2 { font-family: Verdana,sans-serif; font-size: 22pt; font-weight: bold }
|
|
body { font-family: Arial,sans-serif; font-size: 11pt }
|
|
td { font-family: Arial,sans-serif; font-size: 11pt }
|
|
code { font-family: Courier }
|
|
a:hover { color: #34a4ef }
|
|
-->
|
|
</style>
|
|
</head>
|
|
<body bgcolor="%(body)s" link="%(link)s" vlink="%(vlink)s" alink="%(alink)s">
|
|
"""
|
|
|
|
class HtmlLogger (Logger):
|
|
"""
|
|
Logger with HTML output.
|
|
"""
|
|
|
|
def __init__ (self, **args):
|
|
"""
|
|
Initialize default HTML color values.
|
|
"""
|
|
super(HtmlLogger, self).__init__(**args)
|
|
self.init_fileoutput(args)
|
|
self.colorbackground = args['colorbackground']
|
|
self.colorurl = args['colorurl']
|
|
self.colorborder = args['colorborder']
|
|
self.colorlink = args['colorlink']
|
|
self.colorwarning = args['colorwarning']
|
|
self.colorerror = args['colorerror']
|
|
self.colorok = args['colorok']
|
|
|
|
def part (self, name):
|
|
"""
|
|
Return non-space-breakable part name.
|
|
"""
|
|
return super(HtmlLogger, self).part(name).replace(" ", " ")
|
|
|
|
def comment (self, s, **args):
|
|
"""
|
|
Write HTML comment.
|
|
"""
|
|
self.write(u"<!-- ")
|
|
self.write(s, **args)
|
|
self.write(u" -->")
|
|
|
|
def start_output (self):
|
|
"""Write start of checking info."""
|
|
super(HtmlLogger, self).start_output()
|
|
self.starttime = time.time()
|
|
header = {
|
|
"encoding": self.output_encoding,
|
|
"title": configuration.App,
|
|
"body": self.colorbackground,
|
|
"link": self.colorlink,
|
|
"vlink": self.colorlink,
|
|
"alink": self.colorlink,
|
|
}
|
|
self.write(HTML_HEADER % header)
|
|
self.comment("Generated by %s" % configuration.App)
|
|
if self.has_part('intro'):
|
|
self.write(u"<center><h2>"+configuration.App+
|
|
"</h2></center><br><blockquote>"+
|
|
configuration.Freeware+"<br><br>"+
|
|
(_("Start checking at %s") %
|
|
strformat.strtime(self.starttime))+
|
|
os.linesep+"<br>")
|
|
self.check_date()
|
|
self.flush()
|
|
|
|
def log_url (self, url_data):
|
|
"""
|
|
Write url checking info as HTML.
|
|
"""
|
|
self.write_table_start()
|
|
if self.has_part("url"):
|
|
self.write_url(url_data)
|
|
if url_data.name and self.has_part("name"):
|
|
self.write_name(url_data)
|
|
if url_data.parent_url and self.has_part("parenturl"):
|
|
self.write_parent(url_data)
|
|
if url_data.base_ref and self.has_part("base"):
|
|
self.write_base(url_data)
|
|
if url_data.url and self.has_part("realurl"):
|
|
self.write_real(url_data)
|
|
if url_data.dltime >= 0 and self.has_part("dltime"):
|
|
self.write_dltime(url_data)
|
|
if url_data.dlsize >= 0 and self.has_part("dlsize"):
|
|
self.write_dlsize(url_data)
|
|
if url_data.checktime and self.has_part("checktime"):
|
|
self.write_checktime(url_data)
|
|
if url_data.info and self.has_part("info"):
|
|
self.write_info(url_data)
|
|
if url_data.warnings and self.has_part("warning"):
|
|
self.write_warning(url_data)
|
|
if self.has_part("result"):
|
|
self.write_result(url_data)
|
|
self.write_table_end()
|
|
self.flush()
|
|
|
|
def write_table_start (self):
|
|
"""
|
|
Start html table.
|
|
"""
|
|
self.writeln(u'<br clear="all"><br>')
|
|
self.writeln(u'<table align="left" border="0" cellspacing="0"'
|
|
u' cellpadding="1"')
|
|
self.writeln(u' bgcolor="%s" summary="Border">' % self.colorborder)
|
|
self.writeln(u"<tr>")
|
|
self.writeln(u"<td>")
|
|
self.writeln(u'<table align="left" border="0" cellspacing="0"'
|
|
u' cellpadding="3"')
|
|
self.writeln(u' summary="%s" bgcolor="%s">' %
|
|
(cgi.escape(_("checked link")), self.colorbackground))
|
|
|
|
def write_table_end (self):
|
|
"""
|
|
End html table.
|
|
"""
|
|
self.write(u'</table></td></tr></table><br clear="all">')
|
|
|
|
def write_url (self, url_data):
|
|
"""
|
|
Write url_data.base_url.
|
|
"""
|
|
self.writeln(u"<tr>")
|
|
self.writeln(u'<td bgcolor="%s">%s</td>' %
|
|
(self.colorurl, self.part("url")))
|
|
self.write(u'<td bgcolor="%s">' % self.colorurl)
|
|
self.write(u"`%s'" % cgi.escape(url_data.base_url or u""))
|
|
if url_data.cached:
|
|
self.write(_(" (cached)"))
|
|
self.writeln(u"</td></tr>")
|
|
|
|
def write_name (self, url_data):
|
|
"""
|
|
Write url_data.name.
|
|
"""
|
|
args = (self.part("name"), cgi.escape(url_data.name))
|
|
self.writeln(u"<tr><td>%s</td><td>`%s'</td></tr>" % args)
|
|
|
|
def write_parent (self, url_data):
|
|
"""
|
|
Write url_data.parent_url.
|
|
"""
|
|
self.write(u"<tr><td>"+self.part("parenturl")+
|
|
u'</td><td><a target="top" href="'+
|
|
url_data.parent_url+u'">'+
|
|
cgi.escape(url_data.parent_url)+u"</a>")
|
|
self.write(_(", line %d") % url_data.line)
|
|
self.write(_(", col %d") % url_data.column)
|
|
if not url_data.valid:
|
|
# on errors show HTML and CSS validation for parent url
|
|
vhtml = validate_html % {'uri': url_data.parent_url}
|
|
vcss = validate_css % {'uri': url_data.parent_url}
|
|
self.writeln()
|
|
self.writeln(u'(<a href="'+vhtml+u'">HTML</a>)')
|
|
self.write(u'(<a href="'+vcss+u'">CSS</a>)')
|
|
self.writeln(u"</td></tr>")
|
|
|
|
def write_base (self, url_data):
|
|
"""
|
|
Write url_data.base_ref.
|
|
"""
|
|
self.writeln(u"<tr><td>"+self.part("base")+u"</td><td>"+
|
|
cgi.escape(url_data.base_ref)+u"</td></tr>")
|
|
|
|
def write_real (self, url_data):
|
|
"""
|
|
Write url_data.url.
|
|
"""
|
|
self.writeln("<tr><td>"+self.part("realurl")+u"</td><td>"+
|
|
u'<a target="top" href="'+url_data.url+
|
|
u'">'+cgi.escape(url_data.url)+u"</a></td></tr>")
|
|
|
|
def write_dltime (self, url_data):
|
|
"""
|
|
Write url_data.dltime.
|
|
"""
|
|
self.writeln(u"<tr><td>"+self.part("dltime")+u"</td><td>"+
|
|
(_("%.3f seconds") % url_data.dltime)+
|
|
u"</td></tr>")
|
|
|
|
def write_dlsize (self, url_data):
|
|
"""
|
|
Write url_data.dlsize.
|
|
"""
|
|
self.writeln(u"<tr><td>"+self.part("dlsize")+u"</td><td>"+
|
|
strformat.strsize(url_data.dlsize)+
|
|
u"</td></tr>")
|
|
|
|
def write_checktime (self, url_data):
|
|
"""
|
|
Write url_data.checktime.
|
|
"""
|
|
self.writeln(u"<tr><td>"+self.part("checktime")+u"</td><td>"+
|
|
(_("%.3f seconds") % url_data.checktime)+u"</td></tr>")
|
|
|
|
def write_info (self, url_data):
|
|
"""
|
|
Write url_data.info.
|
|
"""
|
|
sep = u"<br>"+os.linesep
|
|
text = sep.join(cgi.escape(x[1]) for x in url_data.info)
|
|
self.writeln(u'<tr><td valign="top">' + self.part("info")+
|
|
u"</td><td>"+text+u"</td></tr>")
|
|
|
|
def write_warning (self, url_data):
|
|
"""
|
|
Write url_data.warnings.
|
|
"""
|
|
sep = u"<br>"+os.linesep
|
|
text = sep.join(cgi.escape(x[1]) for x in url_data.warnings)
|
|
self.writeln(u'<tr><td bgcolor="' + self.colorwarning + u'" '+
|
|
u'valign="top">' + self.part("warning") +
|
|
u'</td><td bgcolor="' + self.colorwarning + u'">' +
|
|
text + u"</td></tr>")
|
|
|
|
def write_result (self, url_data):
|
|
"""
|
|
Write url_data.result.
|
|
"""
|
|
if url_data.valid:
|
|
self.write(u'<tr><td bgcolor="%s">' % self.colorok)
|
|
self.write(self.part("result"))
|
|
self.write(u'</td><td bgcolor="%s">' % self.colorok)
|
|
self.write(cgi.escape(_("Valid")))
|
|
else:
|
|
self.write(u'<tr><td bgcolor="%s">' % self.colorerror)
|
|
self.write(self.part("result"))
|
|
self.write(u'</td><td bgcolor="%s">' % self.colorerror)
|
|
self.write(cgi.escape(_("Error")))
|
|
if url_data.result:
|
|
self.write(u": "+cgi.escape(url_data.result))
|
|
self.writeln(u"</td></tr>")
|
|
|
|
def end_output (self):
|
|
"""
|
|
Write end of checking info as HTML.
|
|
"""
|
|
if self.has_part("outro"):
|
|
self.writeln()
|
|
self.write(_("That's it.")+" ")
|
|
if self.number >= 0:
|
|
self.write(_n("%d link checked.", "%d links checked.",
|
|
self.number) % self.number)
|
|
self.write(u" ")
|
|
self.write(_n("%d warning found", "%d warnings found",
|
|
self.warnings_printed) % self.warnings_printed)
|
|
if self.warnings != self.warnings_printed:
|
|
self.write(_(" (%d duplicates ignored)") %
|
|
(self.warnings - self.warnings_printed))
|
|
self.write(u". ")
|
|
self.write(_n("%d error found", "%d errors found",
|
|
self.errors_printed) % self.errors_printed)
|
|
if self.errors != self.errors_printed:
|
|
self.write(_(" (%d duplicates ignored)") %
|
|
(self.errors - self.errors_printed))
|
|
self.writeln(u".")
|
|
self.writeln(u"<br>")
|
|
self.stoptime = time.time()
|
|
duration = self.stoptime - self.starttime
|
|
self.writeln(_("Stopped checking at %(time)s (%(duration)s)") %
|
|
{"time": strformat.strtime(self.stoptime),
|
|
"duration": strformat.strduration_long(duration)})
|
|
self.writeln(u'</blockquote><br><hr noshade size="1"><small>'+
|
|
configuration.HtmlAppInfo+u"<br>")
|
|
self.writeln(_("Get the newest version at %s") %
|
|
(u'<a href="'+configuration.Url+u'" target="_top">'+
|
|
configuration.Url+u"</a>.<br>"))
|
|
self.writeln(_("Write comments and bugs to %s") %
|
|
(u'<a href="mailto:'+configuration.Email+u'">'+
|
|
configuration.Email+u"</a>."))
|
|
self.writeln(u"</small></body></html>")
|
|
self.close_fileoutput()
|