# -*- coding: iso-8859-1 -*- """a html logger""" # Copyright (C) 2000-2004 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. import time import cgi import os import linkcheck.logger import linkcheck.strformat import linkcheck.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 = """ %s """ class HtmlLogger (linkcheck.logger.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 field (self, name): """return non-space-breakable field name""" return super(HtmlLogger, self).field(name).replace(" ", " ") def comment (self, s, **args): """Print HTML comment.""" self.write(u"") def start_output (self): """print start of checking info""" super(HtmlLogger, self).start_output() if self.fd is None: return self.starttime = time.time() self.write(HTML_HEADER % (linkcheck.configuration.App, self.colorbackground, self.colorlink, self.colorlink, self.colorlink)) if self.has_field('intro'): self.write(u"

"+linkcheck.configuration.App+ "


"+ linkcheck.configuration.Freeware+"

"+ (_("Start checking at %s") % \ linkcheck.strformat.strtime(self.starttime))+ os.linesep+"
") self.check_date() self.flush() def new_url (self, url_data): """print url checking info as HTML""" if self.fd is None: return self.write_table_start() if self.has_field("url"): self.write_url(url_data) if url_data.name and self.has_field("name"): self.write_name(url_data) if url_data.parent_url and self.has_field("parenturl"): self.write_parent(url_data) if url_data.base_ref and self.has_field("base"): self.write_base(url_data) if url_data.url and self.has_field("realurl"): self.write_real(url_data) if url_data.dltime >= 0 and self.has_field("dltime"): self.write_dltime(url_data) if url_data.dlsize >= 0 and self.has_field("dlsize"): self.write_dlsize(url_data) if url_data.checktime and self.has_field("checktime"): self.write_checktime(url_data) if url_data.info and self.has_field("info"): self.write_info(url_data) if url_data.warning and self.has_field("warning"): self.write_warning(url_data) if self.has_field("result"): self.write_result(url_data) self.write_table_end() self.flush() def write_table_start (self): """start html table""" self.writeln(u"

") self.writeln(u"") self.writeln(u"") self.writeln(u"
") self.writeln(u"") def write_table_end (self): """end html table""" self.write(u"

") def write_url (self, url_data): """write url_data.base_url""" self.writeln(u"") self.writeln(u""+ self.field("url")+u"") self.write(u""+ cgi.escape(repr(url_data.base_url)[1:])) if url_data.cached: self.write(_(" (cached)")) self.writeln(u"") def write_name (self, url_data): """write url_data.name""" self.writeln(u""+self.field("name")+u""+ cgi.escape(repr(url_data.name)[1:])+u"") def write_parent (self, url_data): """write url_data.parent_url""" self.write(u""+self.field("parenturl")+ u''+ cgi.escape(url_data.parent_url)+u"") 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'(HTML)') self.write(u'(CSS)') self.writeln(u"") def write_base (self, url_data): """write url_data.base_ref""" self.writeln(u""+self.field("base")+u""+ cgi.escape(url_data.base_ref)+u"") def write_real (self, url_data): """write url_data.url""" self.writeln(""+self.field("realurl")+u""+ u''+cgi.escape(url_data.url)+u"") def write_dltime (self, url_data): """write url_data.dltime""" self.writeln(u""+self.field("dltime")+u""+ (_("%.3f seconds") % url_data.dltime)+ u"") def write_dlsize (self, url_data): """write url_data.dlsize""" self.writeln(u""+self.field("dlsize")+u""+ linkcheck.strformat.strsize(url_data.dlsize)+ u"") def write_checktime (self, url_data): """write url_data.checktime""" self.writeln(u""+self.field("checktime")+u""+ (_("%.3f seconds") % url_data.checktime)+u"") def write_info (self, url_data): """write url_data.info""" text = os.linesep.join(url_data.info) self.writeln(u""+self.field("info")+ u""+cgi.escape(text).replace(os.linesep, "
")+ u"") def write_warning (self, url_data): """write url_data.warning""" sep = u"
"+os.linesep text = sep.join([cgi.escape(x) for x in url_data.warning]) self.writeln(u""+self.field("warning")+ u""+ text+u"") def write_result (self, url_data): """write url_data.result""" if url_data.valid: self.write(u""+ self.field("result")+u"") self.write(_("Valid")) else: self.errors += 1 self.write(u""+ self.field("result")+u"") self.write(_("Error")) if url_data.result: self.write(u": "+cgi.escape(url_data.result)) self.writeln(u"") def end_output (self, linknumber=-1): """print end of checking info as HTML""" if self.fd is None: return if self.has_field("outro"): self.writeln() self.write(_("That's it.")+" ") if linknumber >= 0: self.write(_n("%d link checked.", "%d links checked.", linknumber) % linknumber) self.write(u" ") self.writeln(_n("%d error found.", "%d errors found.", self.errors) % self.errors) self.writeln(u"
") self.stoptime = time.time() duration = self.stoptime - self.starttime self.writeln(_("Stopped checking at %s (%s)") % \ (linkcheck.strformat.strtime(self.stoptime), linkcheck.strformat.strduration(duration))) self.writeln(u"


"+ linkcheck.configuration.HtmlAppInfo+u"
") self.writeln(_("Get the newest version at %s") % \ (u''+ linkcheck.configuration.Url+u".
")) self.writeln(_("Write comments and bugs to %s") % \ (u''+ linkcheck.configuration.Email+u".")) self.writeln(u"
") self.flush() if self.close_fd: self.fd.close() self.fd = None