debug_source_code.py 6.36 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# copyright 2019 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
#
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""
Debug view for pyramid debug toolbar and others to help development
"""

import os
25
26
import logging
import inspect
27

28
29
from itertools import dropwhile

30
31
32
33
34
35
36
37
from pyramid.response import Response
from mako.template import Template

from cubicweb.misc.source_highlight import highlight_html, generate_css, has_pygments


DEBUG_DISPLAY_SOURCE_CODE_PATH = '_debug_display_source_code'

38
39
FILES_WHITE_LIST = set()

40

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def _generate_link_to_source(file_path, start=None, end=None, tag_body="&lt;&gt;"):
    if start:
        # step back a bit so we have a bit of top padding wen displaying the page
        # and the highlighted line isn't glued to top of the browser window
        line_anchor = max(0, start - 10)

        if end:
            return '<a href="../%s?file=%s&line=%s&end=%s#line-%s" target="_blank">%s</a>' % (
                DEBUG_DISPLAY_SOURCE_CODE_PATH, file_path, start, end, line_anchor, tag_body
            )
        else:
            return '<a href="../%s?file=%s&line=%s#line-%s" target="_blank">%s</a>' % (
                DEBUG_DISPLAY_SOURCE_CODE_PATH, file_path, start, line_anchor, tag_body
            )

    return '<a href="../%s?file=%s" target="_blank">%s</a>' % (
        DEBUG_DISPLAY_SOURCE_CODE_PATH, file_path, tag_body
    )


61
62
63
64
65
66
67
68
69
70
71
72
73
def source_code_url(object_or_class):
    if object_or_class is None:
        return ""

    if not inspect.isclass(object_or_class):
        object_or_class = object_or_class.__class__

    try:
        file_path = inspect.getsourcefile(object_or_class)
    except TypeError:
        logging.debug("Error while trying to source code of '%s'" % object_or_class)
        return ""

74
75
    FILES_WHITE_LIST.add(file_path)

76
77
78
    try:
        source_code, line = inspect.getsourcelines(object_or_class)
    except OSError:  # when we couldn't read the source code/line
79
        return _generate_link_to_source(file_path)
80

81
    return _generate_link_to_source(file_path, line, line + len(source_code))
82
83


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def source_code_url_in_stack(stack, highlighted=False):
    new_stack = []

    if highlighted:
        for i in stack.split(" File "):
            # expecting this format:
            # '<span class="nb">&quot;/path/to/file.py&quot;</span>,
            # line <span class="m">885</span>,...'
            if not i.startswith('<span class="nb">'):
                new_stack.append(i)
                continue

            # this will give:
            # ['<span class="nb">', '/file/to/path.py', '</span>, ...']
            tag, file_path, rest = i.split("&quot;", 2)

            # "rest" is like that: '</span>, line <span class="m">885</span>, ...'
            # we want to extrait "885" here
            line_number = int("".join(dropwhile(lambda x: not x.isdigit(), rest)).split("<")[0])

            new_stack.append("%s%s%s" % (
                tag,
                _generate_link_to_source(file_path, start=line_number,
                                         tag_body="&quot;%s&quot;" % file_path),
                rest,
            ))

            FILES_WHITE_LIST.add(file_path)

        new_stack = " File ".join(new_stack)

    # no syntax
    else:
        for i in stack.split("\n"):
            # expecting this format:
            # File "/path/to/file.py", line 885, in stuf\n  some_code\nFile "/stuff.py", line...
            if not i.startswith("  File "):
                new_stack.append(i)
                continue

            # this will give:
            # ['File "', '/path/to/file.py', '", line 885, in stuf']
            beginning, file_path, rest = i.split('"', 2)
            line_number = int("".join(dropwhile(lambda x: not x.isdigit(), rest)).split(",")[0])

            new_stack.append("%s%s%s" % (
                beginning,
                _generate_link_to_source(file_path, start=line_number,
                                         tag_body='"%s"' % file_path),
                rest,
            ))

            FILES_WHITE_LIST.add(file_path)

        new_stack = "\n".join(new_stack)

    return new_stack


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def debug_display_source_code(request):
    """
    This view display a python source file content for making debugging easier.

    It is only activated on debug mode (-D) for pyramid during development.

    It will uses pygment if installed to colorize the source code.
    """

    if "file" not in request.params:
        return Response('Error: you should have end up on this page following a link in the '
                        'pyramid debug toolbar with the correct parameters.')

    source_code_file = request.params["file"]

    if not os.path.exists(source_code_file):
        return Response("Error: file '%s' doesn't exist on the filesystem." % source_code_file)

161
162
163
164
    # security
    if source_code_file not in FILES_WHITE_LIST:
        return Response("Error: access to file is not authorized")

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
    try:
        content = open(source_code_file, "r").read()
    except Exception as e:
        return Response("Error: while opening file '%s' got the error: %s" % (source_code_file, e))

    lines = []
    line_begin = request.params.get("line", None)
    if line_begin:
        line_end = request.params.get("end", line_begin)
        lines = list(range(int(line_begin), int(line_end) + 1))

    this_file_directory = os.path.split(os.path.realpath(__file__))[0]
    template_filename = os.path.join(this_file_directory,
                                     "debug_toolbar_templates/debug_source_code.mako")

    html = Template(filename=template_filename).render(
        file_path=source_code_file,
        content=content,
        has_pygments=has_pygments,
        highlight_html=highlight_html,
        css=generate_css(),
        lines=lines,
    )

    return Response(html)