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
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
# -*- coding: utf-8 -*-
# loggerwindow.py
# Copyright (C) 2013 LEAP
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
"""
History log window
"""
import logging
import cgi
from PySide import QtGui
from twisted.internet import threads
from ui_loggerwindow import Ui_LoggerWindow
from leap.bitmask.util.constants import PASTEBIN_API_DEV_KEY
from leap.bitmask.util.leap_log_handler import LeapLogHandler
from leap.bitmask.util.pastebin import PastebinAPI, PastebinError
from leap.common.check import leap_assert, leap_assert_type
logger = logging.getLogger(__name__)
class LoggerWindow(QtGui.QDialog):
"""
Window that displays a history of the logged messages in the app.
"""
def __init__(self, handler):
"""
Initialize the widget with the custom handler.
:param handler: Custom handler that supports history and signal.
:type handler: LeapLogHandler.
"""
from twisted.internet import reactor
self.reactor = reactor
QtGui.QDialog.__init__(self)
leap_assert(handler, "We need a handler for the logger window")
leap_assert_type(handler, LeapLogHandler)
# Load UI
self.ui = Ui_LoggerWindow()
self.ui.setupUi(self)
# Make connections
self.ui.btnSave.clicked.connect(self._save_log_to_file)
self.ui.btnDebug.toggled.connect(self._load_history),
self.ui.btnInfo.toggled.connect(self._load_history),
self.ui.btnWarning.toggled.connect(self._load_history),
self.ui.btnError.toggled.connect(self._load_history),
self.ui.btnCritical.toggled.connect(self._load_history)
self.ui.leFilterBy.textEdited.connect(self._filter_by)
self.ui.cbCaseInsensitive.stateChanged.connect(self._load_history)
self.ui.btnPastebin.clicked.connect(self._pastebin_this)
self._current_filter = ""
self._current_history = ""
# Load logging history and connect logger with the widget
self._logging_handler = handler
self._connect_to_handler()
self._load_history()
def _connect_to_handler(self):
"""
This method connects the loggerwindow with the handler through a
signal communicate the logger events.
"""
self._logging_handler.new_log.connect(self._add_log_line)
def _add_log_line(self, log):
"""
Adds a line to the history, only if it's in the desired levels to show.
:param log: a log record to be inserted in the widget
:type log: a dict with RECORD_KEY and MESSAGE_KEY.
the record contains the LogRecord of the logging module,
the message contains the formatted message for the log.
"""
html_style = {
logging.DEBUG: "background: #CDFFFF;",
logging.INFO: "background: white;",
logging.WARNING: "background: #FFFF66;",
logging.ERROR: "background: red; color: white;",
logging.CRITICAL: "background: red; color: white; font: bold;"
}
level = log[LeapLogHandler.RECORD_KEY].levelno
message = cgi.escape(log[LeapLogHandler.MESSAGE_KEY])
if self._logs_to_display[level]:
open_tag = "<tr style='" + html_style[level] + "'>"
open_tag += "<td width='100%' style='padding: 5px;'>"
close_tag = "</td></tr>"
message = open_tag + message + close_tag
filter_by = self._current_filter
msg = message
if self.ui.cbCaseInsensitive.isChecked():
msg = msg.upper()
filter_by = filter_by.upper()
if msg.find(filter_by) != -1:
self.ui.txtLogHistory.append(message)
def _load_history(self):
"""
Load the previous logged messages in the widget.
They are stored in the custom handler.
"""
self._set_logs_to_display()
self.ui.txtLogHistory.clear()
history = self._logging_handler.log_history
current_history = []
for line in history:
self._add_log_line(line)
message = cgi.escape(line[LeapLogHandler.MESSAGE_KEY])
current_history.append(message)
self._current_history = "\n".join(current_history)
def _set_logs_to_display(self):
"""
Sets the logs_to_display dict getting the toggled options from the ui
"""
self._logs_to_display = {
logging.DEBUG: self.ui.btnDebug.isChecked(),
logging.INFO: self.ui.btnInfo.isChecked(),
logging.WARNING: self.ui.btnWarning.isChecked(),
logging.ERROR: self.ui.btnError.isChecked(),
logging.CRITICAL: self.ui.btnCritical.isChecked()
}
def _filter_by(self, text):
"""
Sets the text to use for filtering logs in the log window.
:param text: the text to compare with the logs when filtering.
:type text: str
"""
self._current_filter = text
self._load_history()
def _save_log_to_file(self):
"""
Lets the user save the current log to a file
"""
fileName, filtr = QtGui.QFileDialog.getSaveFileName(
self, self.tr("Save As"),
options=QtGui.QFileDialog.DontUseNativeDialog)
if fileName:
try:
with open(fileName, 'w') as output:
history = self.ui.txtLogHistory.toPlainText()
# Chop some \n.
# html->plain adds several \n because the html is made
# using table cells.
history = history.replace('\n\n\n', '\n')
output.write(history)
logger.debug('Log saved in %s' % (fileName, ))
except IOError, e:
logger.error("Error saving log file: %r" % (e, ))
else:
logger.debug('Log not saved!')
def _pastebin_this(self):
"""
Send the current log history to pastebin.com and gives the user a link
to see it.
"""
def do_pastebin():
"""
Send content to pastebin and return the link.
"""
content = self._current_history
pb = PastebinAPI()
link = pb.paste(PASTEBIN_API_DEV_KEY, content,
paste_name="Bitmask log",
paste_expire_date='1W')
return link
def pastebin_ok(link):
"""
Callback handler for `do_pastebin`.
:param link: the recently created pastebin link.
:type link: str
"""
msg = self.tr("Your pastebin link <a href='{0}'>{0}</a>")
msg = msg.format(link)
logger.debug(msg)
show_info = lambda: QtGui.QMessageBox.information(
self, self.tr("Pastebin OK"), msg)
self.reactor.callLater(0, show_info)
def pastebin_err(failure):
"""
Errback handler for `do_pastebin`.
:param failure: the failure that triggered the errback.
:type failure: twisted.python.failure.Failure
"""
logger.error(repr(failure))
msg = self.tr("Sending logs to Pastebin failed!")
show_err = lambda: QtGui.QMessageBox.error(
self, self.tr("Pastebin Error"), msg)
self.reactor.callLater(0, show_err)
failure.trap(PastebinError)
d = threads.deferToThread(do_pastebin)
d.addCallback(pastebin_ok)
d.addErrback(pastebin_err)
|
