File: gxml.py

package info (click to toggle)
linkchecker 10.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,132 kB
  • sloc: python: 13,154; makefile: 134; sh: 71; xml: 36; sql: 20; javascript: 19; php: 2
file content (89 lines) | stat: -rw-r--r-- 3,253 bytes parent folder | download | duplicates (4)
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
# Copyright (C) 2000-2014 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
A GraphXML logger.
"""

from .xmllog import _XMLLogger
from .graph import _GraphLogger


class GraphXMLLogger(_XMLLogger, _GraphLogger):
    """XML output mirroring the GML structure. Easy to parse with any XML
    tool."""

    LoggerName = 'gxml'

    LoggerArgs = {
        "filename": "linkchecker-out.gxml",
    }

    def __init__(self, **kwargs):
        """Initialize graph node list and internal id counter."""
        args = self.get_args(kwargs)
        super().__init__(**args)
        self.nodes = {}
        self.nodeid = 0

    def start_output(self):
        """Write start of checking info as xml comment."""
        super().start_output()
        self.xml_start_output()
        self.xml_starttag('GraphXML')
        self.xml_starttag('graph', attrs={"isDirected": "true"})
        self.flush()

    def log_url(self, url_data):
        """Write one node and all possible edges."""
        node = self.get_node(url_data)
        if node:
            self.xml_starttag('node', attrs={"name": "%d" % node["id"]})
            self.xml_tag("label", node["label"])
            if self.has_part("realurl"):
                self.xml_tag("url", node["url"])
            self.xml_starttag("data")
            if node["dltime"] >= 0 and self.has_part("dltime"):
                self.xml_tag("dltime", "%f" % node["dltime"])
            if node["size"] >= 0 and self.has_part("dlsize"):
                self.xml_tag("size", "%d" % node["size"])
            if node["checktime"] and self.has_part("checktime"):
                self.xml_tag("checktime", "%f" % node["checktime"])
            if self.has_part("extern"):
                self.xml_tag("extern", "%d" % node["extern"])
            self.xml_endtag("data")
            self.xml_endtag("node")

    def write_edge(self, node):
        """Write one edge."""
        attrs = {
            "source": "%d" % self.nodes[node["parent_url"]]["id"],
            "target": "%d" % node["id"],
        }
        self.xml_starttag("edge", attrs=attrs)
        self.xml_tag("label", node["label"])
        self.xml_starttag("data")
        if self.has_part("result"):
            self.xml_tag("valid", "%d" % node["valid"])
        self.xml_endtag("data")
        self.xml_endtag("edge")

    def end_output(self, **kwargs):
        """Finish graph output, and print end of checking info as xml
        comment."""
        self.xml_endtag("graph")
        self.xml_endtag("GraphXML")
        self.xml_end_output()
        self.close_fileoutput()