class LogWindow(wx.Dialog):
def __init__(self, parent, logFile):
wx.Dialog.__init__(self,
parent,
style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)
self.SetIcon(APP_logo)
self.LogFile = FileItem(logFile)
self.SetTitle()
self.LogPollThread = Thread(self.PollLogFile)
self.DspLog = TextAreaPanel(self, style=wx.TE_READONLY)
self.DspLog.font_size = 8
self.DspLog.SetFont(GetMonospacedFont(self.DspLog.font_size))
btn_open = CreateButton(self, btnid.BROWSE,
GT(u'Open and Display Log File'), u'browse')
btn_font = CreateButton(self, btnid.ZOOM, GT(u'Zoom Text'), u'zoom')
btn_refresh = CreateButton(self, btnid.REFRESH, GT(u'Refresh'),
u'refresh')
btn_hide = CreateButton(self, btnid.CLOSE, GT(u'Hide'), u'hide')
# *** Event Handling *** #
EVT_REFRESH_LOG(self, wx.ID_ANY, self.OnLogTimestampChanged)
wx.EVT_BUTTON(self, btnid.BROWSE, self.OnOpenLogFile)
wx.EVT_BUTTON(self, btnid.ZOOM, self.OnChangeFont)
wx.EVT_BUTTON(self, btnid.REFRESH, self.RefreshLog)
wx.EVT_BUTTON(self, btnid.CLOSE, self.OnClose)
wx.EVT_CLOSE(self, self.OnClose)
wx.EVT_SHOW(self, self.OnShow)
wx.EVT_SHOW(GetMainWindow(), self.OnShowMainWindow)
# *** Layout *** #
layout_btnF1 = wx.FlexGridSizer(cols=5)
layout_btnF1.AddGrowableCol(1, 1)
layout_btnF1.Add(btn_open, 0, wx.LEFT, 5)
layout_btnF1.AddStretchSpacer(1)
layout_btnF1.Add(btn_font, 0, wx.RIGHT, 5)
layout_btnF1.Add(btn_refresh, 0, wx.RIGHT, 5)
layout_btnF1.Add(btn_hide, 0, wx.RIGHT, 5)
layout_mainV1 = BoxSizer(wx.VERTICAL)
layout_mainV1.Add(self.DspLog, 1, wx.ALL | wx.EXPAND, 5)
layout_mainV1.Add(layout_btnF1, 0, wx.EXPAND | wx.BOTTOM, 5)
self.SetAutoLayout(True)
self.SetSizer(layout_mainV1)
self.Layout()
self.SetMinSize(self.GetSize())
self.SetSize(wx.Size(600, 600))
self.AlignWithMainWindow()
# Make sure log window is not shown at initialization
self.Show(False)
## Positions the log window relative to the main window
def AlignWithMainWindow(self):
debreate_pos = GetMainWindow().GetPosition()
width = self.GetSize()[0]
posX = debreate_pos[0] - width
posY = debreate_pos[1]
self.SetPosition(wx.Point(posX, posY))
## Hides the log window & clears contents
def HideLog(self):
self.Show(False)
self.DspLog.Clear()
## Changes the font size
def OnChangeFont(self, event=None):
font_sizes = {
7: 8,
8: 10,
10: 7,
}
current_font_size = self.DspLog.font_size
for S in font_sizes:
if S == current_font_size:
self.DspLog.SetFont(GetMonospacedFont(font_sizes[S]))
self.DspLog.font_size = font_sizes[S]
return
Logger.Error(__name__, GT(u'Can\'t change log window font'))
## Hides the log window when close event occurs
def OnClose(self, event=None):
self.HideLog()
## Called by refresh event to update the log display
def OnLogTimestampChanged(self, event=None):
self.RefreshLog()
## Opens a new log file
def OnOpenLogFile(self, event=None):
log_select = GetFileOpenDialog(self,
GT(u'Open Log'),
directory=PATH_logs)
if ShowDialog(log_select):
logFile = log_select.GetPath()
if os.path.isfile(logFile):
self.SetLogFile(logFile)
return
ShowErrorDialog(u'{}: {}'.format(GT(u'File does not exist'),
logFile),
parent=self)
## Guarantees that menu item is synced with window's shown status
def OnShow(self, event=None):
menu_debug = GetMenu(menuid.DEBUG)
# In case main window has been destroyed, but sub thread still active
if GetMainWindow():
window_shown = self.IsShown()
m_checked = menu_debug.IsChecked(menuid.LOG)
if m_checked != window_shown:
menu_debug.Check(menuid.LOG, window_shown)
else:
Logger.Warn(__name__, u'Log thread still active!')
## Use an event to show the log window
#
# By waiting until the main window emits a show event
# a separate item is not added in the system window
# list for the log.
def OnShowMainWindow(self, event=None):
main_window = GetMainWindow()
# Make sure the main window has not been destroyed before showing log
if main_window and main_window.IsShown():
if GetMenu(menuid.DEBUG).IsChecked(menuid.LOG):
self.ShowLog()
## Toggles the log window shown or hidden
def OnToggleWindow(self, event=None):
show = GetMenu(menuid.DEBUG).IsChecked(menuid.LOG)
if show:
self.ShowLog()
return
self.HideLog()
if event:
event.Skip(True)
## Creates a thread that polls for changes in log file
def PollLogFile(self, args=None):
while self and self.IsShown():
if self.LogFile.TimestampChanged():
print(u'Log timestamp changed, loading new log ...')
wx.PostEvent(self, RefreshLogEvent(0))
time.sleep(LOG_WINDOW_REFRESH_INTERVAL)
## Fills log with text file contents
def RefreshLog(self, event=None):
if self.LogFile.IsFile():
log_data = self.LogFile.Read()
if not self.DspLog.IsEmpty():
self.DspLog.Clear()
self.DspLog.SetValue(log_data)
try:
# Yield here to make sure last line is displayed
# FIXME: Causes delay when debug enabled
wx.SafeYield()
self.DspLog.ShowPosition(self.DspLog.GetLastPosition())
except wx.PyDeadObjectError:
tb_error = GS(traceback.format_exc())
Logger.Warn(
__name__,
u'Error refreshing log window. Details below:\n\n{}'.
format(tb_error))
## Changes the file to be loaded & displayed
#
# \param logFile
# Absolute path of file to load
def SetLogFile(self, logFile):
self.LogFile = FileItem(logFile)
self.RefreshLog()
self.SetTitle()
## Updates the window's title using path of log file
def SetTitle(self):
new_title = self.LogFile.GetPath()
if new_title:
return wx.Dialog.SetTitle(self, new_title)
## Shows the log window
def ShowLog(self):
self.RefreshLog()
self.Show(True)
if not self.LogPollThread.IsActive():
Logger.Debug(__name__, u'Starting log polling thread ...')
self.LogPollThread.Start()
else:
Logger.Debug(__name__, u'Log polling thread is already started')
class Page(WizardPage):
## Constructor
#
# \param parent
# Parent <b><i>wx.Window</i></b> instance
def __init__(self, parent):
WizardPage.__init__(self, parent, pgid.CHANGELOG)
txt_package = wx.StaticText(self,
label=GT(u'Package'),
name=u'package')
self.ti_package = TextArea(self,
inputid.PACKAGE,
name=txt_package.Name)
txt_version = wx.StaticText(self,
label=GT(u'Version'),
name=u'version')
self.ti_version = TextArea(self,
inputid.VERSION,
name=txt_version.Name)
dist_names = GetOSDistNames()
txt_dist = wx.StaticText(self, label=GT(u'Distribution'), name=u'dist')
if dist_names:
self.ti_dist = ComboBox(self,
inputid.DIST,
choices=dist_names,
name=txt_dist.Name)
# Use regular text input if could not retrieve distribution names list
else:
self.ti_dist = TextArea(self, inputid.DIST, name=txt_dist.Name)
opts_urgency = (
u'low',
u'medium',
u'high',
u'emergency',
)
txt_urgency = wx.StaticText(self,
label=GT(u'Urgency'),
name=u'urgency')
self.sel_urgency = Choice(self,
selid.URGENCY,
choices=opts_urgency,
name=txt_urgency.Name)
txt_maintainer = wx.StaticText(self,
label=GT(u'Maintainer'),
name=u'maintainer')
self.ti_maintainer = TextArea(self,
inputid.MAINTAINER,
name=txt_maintainer.Name)
txt_email = wx.StaticText(self, label=GT(u'Email'), name=u'email')
self.ti_email = TextArea(self, inputid.EMAIL, name=txt_email.Name)
btn_import = CreateButton(self,
btnid.IMPORT,
GT(u'Import'),
u'import',
name=u'btn import')
txt_import = wx.StaticText(
self, label=GT(u'Import information from Control page'))
# Changes input
self.ti_changes = TextAreaPanel(self, size=(20, 150), name=u'changes')
# *** Target installation directory
# FIXME: Should this be set by config or project file???
self.pnl_target = FileOTarget(self,
u'/usr/share/doc/<package>',
name=u'target default',
defaultType=CheckBoxESS,
customType=PathCtrlESS,
pathIds=(
chkid.TARGET,
inputid.TARGET,
))
self.btn_add = CreateButton(self,
btnid.ADD,
GT(u'Add'),
u'add',
name=u'btn add')
txt_add = wx.StaticText(self, label=GT(u'Insert new changelog entry'))
self.chk_indentation = CheckBox(self,
label=GT(u'Preserve indentation'),
name=u'indent')
self.dsp_changes = TextAreaPanelESS(self,
inputid.CHANGES,
monospace=True,
name=u'log')
self.dsp_changes.EnableDropTarget()
SetPageToolTips(self)
# *** Event Handling *** #
btn_import.Bind(wx.EVT_BUTTON, self.OnImportFromControl)
self.btn_add.Bind(wx.EVT_BUTTON, self.AddInfo)
# *** Layout *** #
LEFT_BOTTOM = lyt.ALGN_LB
LEFT_CENTER = wx.ALIGN_LEFT | wx.ALIGN_CENTER_VERTICAL
RIGHT_CENTER = wx.ALIGN_RIGHT | wx.ALIGN_CENTER_VERTICAL
lyt_info = wx.FlexGridSizer(2, 6)
lyt_info.AddGrowableCol(1)
lyt_info.AddGrowableCol(3)
lyt_info.AddGrowableCol(5)
lyt_info.AddMany(
((txt_package, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_package, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_version, 0, RIGHT_CENTER | wx.RIGHT, 5),
(self.ti_version, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_dist, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_dist, 1, wx.EXPAND | wx.BOTTOM,
5), (txt_urgency, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.sel_urgency, 1, wx.RIGHT, 5),
(txt_maintainer, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_maintainer, 1, wx.EXPAND | wx.RIGHT,
5), (txt_email, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_email, 1, wx.EXPAND)))
lyt_details = wx.GridBagSizer()
lyt_details.SetCols(3)
lyt_details.AddGrowableRow(2)
lyt_details.AddGrowableCol(1)
lyt_details.Add(btn_import, (0, 0))
lyt_details.Add(txt_import, (0, 1), flag=LEFT_CENTER)
lyt_details.Add(wx.StaticText(self, label=GT(u'Changes')), (1, 0),
flag=LEFT_BOTTOM)
lyt_details.Add(wx.StaticText(self, label=GT(u'Target')), (1, 2),
flag=LEFT_BOTTOM)
lyt_details.Add(self.ti_changes, (2, 0), (1, 2), wx.EXPAND | wx.RIGHT,
5)
lyt_details.Add(self.pnl_target, (2, 2))
lyt_details.Add(self.btn_add, (3, 0), (2, 1))
lyt_details.Add(txt_add, (3, 1), flag=LEFT_BOTTOM | wx.TOP, border=5)
lyt_details.Add(self.chk_indentation, (4, 1), flag=LEFT_BOTTOM)
lyt_main = BoxSizer(wx.VERTICAL)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_info, 0, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_details, 1, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.Add(wx.StaticText(self, label=u'Changelog Output'), 0,
LEFT_BOTTOM | lyt.PAD_LT, 5)
lyt_main.Add(self.dsp_changes, 1, wx.EXPAND | lyt.PAD_LR | wx.BOTTOM,
5)
self.SetAutoLayout(True)
self.SetSizer(lyt_main)
self.Layout()
## Formats input text from 'changes' field for new entry in changelog
def AddInfo(self, event=None):
new_changes = self.ti_changes.GetValue()
if TextIsEmpty(new_changes):
DetailedMessageDialog(
GetMainWindow(), GT(u'Warning'), ICON_WARNING,
GT(u'"Changes" section is empty')).ShowModal()
self.ti_changes.SetInsertionPointEnd()
self.ti_changes.SetFocus()
return
package = self.ti_package.GetValue()
version = self.ti_version.GetValue()
dist = self.ti_dist.GetValue()
urgency = self.sel_urgency.GetStringSelection()
maintainer = self.ti_maintainer.GetValue()
email = self.ti_email.GetValue()
new_changes = FormatChangelog(new_changes, package, version, dist,
urgency, maintainer, email,
self.chk_indentation.GetValue())
# Clean up leading & trailing whitespace in old changes
old_changes = self.dsp_changes.GetValue().strip(u' \t\n\r')
# Only append newlines if log isn't already empty
if not TextIsEmpty(old_changes):
new_changes = u'{}\n\n\n{}'.format(new_changes, old_changes)
# Add empty line to end of log
if not new_changes.endswith(u'\n'):
new_changes = u'{}\n'.format(new_changes)
self.dsp_changes.SetValue(new_changes)
# Clear "Changes" text
self.ti_changes.Clear()
self.ti_changes.SetFocus()
## Exports page's data to file
#
# \param out_dir
# Target directory where file will be written
# \out_name
# Filename of output file
# \compress
# If <b><i>True</i></b>, compresses file with gzip
def Export(self, out_dir, out_name=wx.EmptyString, compress=False):
ret_value = WizardPage.Export(self, out_dir, out_name=out_name)
absolute_filename = u'{}/{}'.format(out_dir,
out_name).replace(u'//', u'/')
CMD_gzip = GetExecutable(u'gzip')
if compress and CMD_gzip:
commands.getstatusoutput(u'{} -n9 "{}"'.format(
CMD_gzip, absolute_filename))
return ret_value
## Export instructions specifically for build phase
#
# \param stage
# Formatted staged directory where file heirarchy is temporarily kept
# \return
# <b><i>Tuple</i></b> containing a return code & string value of page data
def ExportBuild(self, stage):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target.replace(u'<package>',
GetFieldValue(pgid.CONTROL, inputid.PACKAGE))
stage = ConcatPaths((stage, target))
if not os.path.isdir(stage):
os.makedirs(stage)
# FIXME: Allow user to set filename
self.Export(stage, u'changelog', True)
export_summary = GT(u'Changelog export failed')
changelog = ConcatPaths((stage, u'changelog.gz'))
if os.path.isfile(changelog):
export_summary = GT(u'Changelog export to: {}').format(changelog)
return (0, export_summary)
## Retrieves changelog text
#
# The output is a text file that uses sections defined by braces ([, ])
#
# \param getModule
# If <b><i>True</i></b>, returns a <b><i>tuple</b></i> of the module name
# & page data, otherwise return only page data string
# \return
# <b><i>tuple(str, str)</i></b>: Filename & formatted string of changelog target & body
def Get(self, getModule=False):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target = u'DEFAULT'
body = self.dsp_changes.GetValue()
if TextIsEmpty(body):
page = None
else:
page = u'[TARGET={}]\n\n[BODY]\n{}'.format(target, body)
if getModule:
page = (
__name__,
page,
)
return page
## Retrieves plain text of the changelog field
#
# \return
# Formatted changelog text
def GetChangelog(self):
return self.dsp_changes.GetValue()
## Reads & parses page data from a formatted text file
#
# \param filename
# File path to open
def ImportFromFile(self, filename):
if not os.path.isfile(filename):
return dbrerrno.ENOENT
clog_data = ReadFile(filename, split=True)
sections = {}
def parse_section(key, lines):
value = u'\n'.join(lines).split(u'\n[')[0]
if u'=' in key:
key = key.split(u'=')
value = (key[-1], value)
key = key[0]
sections[key] = value
# NOTE: This would need to be changed were more sections added to project file
for L in clog_data:
line_index = clog_data.index(L)
if not TextIsEmpty(L) and u'[' in L and u']' in L:
L = L.split(u'[')[-1].split(u']')[0]
parse_section(L, clog_data[line_index + 1:])
for S in sections:
Logger.Debug(
__name__,
GT(u'Changelog section: "{}", Value:\n{}').format(
S, sections[S]))
if isinstance(sections[S], (tuple, list)):
value_index = 0
for I in sections[S]:
Logger.Debug(__name__,
GT(u'Value {}: {}').format(value_index, I))
value_index += 1
if S == u'TARGET':
Logger.Debug(__name__, u'SECTION TARGET FOUND')
if sections[S][0] == u'DEFAULT':
Logger.Debug(__name__, u'Using default target')
if not self.pnl_target.UsingDefault():
self.pnl_target.Reset()
else:
Logger.Debug(
__name__,
GT(u'Using custom target: {}').format(sections[S][0]))
self.pnl_target.SetPath(sections[S][0])
continue
if S == u'BODY':
Logger.Debug(__name__, u'SECTION BODY FOUND')
self.dsp_changes.SetValue(sections[S])
continue
return 0
## Checks the page's fields for exporting
#
# \return
# <b><i>False</i></b> if page cannot be exported
def IsOkay(self):
return not TextIsEmpty(self.dsp_changes.GetValue())
## Imports select field values from the 'Control' page
def OnImportFromControl(self, event=None):
fields = (
(self.ti_package, inputid.PACKAGE),
(self.ti_version, inputid.VERSION),
(self.ti_maintainer, inputid.MAINTAINER),
(self.ti_email, inputid.EMAIL),
)
for F, FID in fields:
field_value = GetFieldValue(pgid.CONTROL, FID)
if isinstance(field_value, ErrorTuple):
err_msg1 = GT(
u'Got error when attempting to retrieve field value')
err_msg2 = u'\tError code: {}\n\tError message: {}'.format(
field_value.GetCode(), field_value.GetString())
Logger.Error(__name__, u'{}:\n{}'.format(err_msg1, err_msg2))
continue
if not TextIsEmpty(field_value):
F.SetValue(field_value)
## Sets values of page's fields with given input
#
# \param data
# Text to parse for values
def Set(self, data):
changelog = data.split(u'\n')
target = changelog[0].split(u'<<DEST>>')[1].split(u'<</DEST>>')[0]
if target == u'DEFAULT':
if not self.pnl_target.UsingDefault():
self.pnl_target.Reset()
else:
self.pnl_target.SetPath(target)
self.dsp_changes.SetValue(u'\n'.join(changelog[1:]))
class Page(WizardPage):
## Constructor
#
# \param parent
# Parent <b><i>wx.Window</i></b> instance
def __init__(self, parent):
WizardPage.__init__(self, parent, pgid.CHANGELOG)
txt_package = wx.StaticText(self,
label=GT(u'Package'),
name=u'package')
self.ti_package = TextArea(self,
inputid.PACKAGE,
name=txt_package.Name)
txt_version = wx.StaticText(self,
label=GT(u'Version'),
name=u'version')
self.ti_version = TextArea(self,
inputid.VERSION,
name=txt_version.Name)
dist_names = GetOSDistNames()
txt_dist = wx.StaticText(self, label=GT(u'Distribution'), name=u'dist')
if dist_names:
self.ti_dist = ComboBox(self,
inputid.DIST,
choices=dist_names,
name=txt_dist.Name)
# Use regular text input if could not retrieve distribution names list
else:
self.ti_dist = TextArea(self, inputid.DIST, name=txt_dist.Name)
opts_urgency = (
u'low',
u'medium',
u'high',
u'emergency',
)
txt_urgency = wx.StaticText(self,
label=GT(u'Urgency'),
name=u'urgency')
self.sel_urgency = Choice(self,
selid.URGENCY,
choices=opts_urgency,
name=txt_urgency.Name)
txt_maintainer = wx.StaticText(self,
label=GT(u'Maintainer'),
name=u'maintainer')
self.ti_maintainer = TextArea(self,
inputid.MAINTAINER,
name=txt_maintainer.Name)
txt_email = wx.StaticText(self, label=GT(u'Email'), name=u'email')
self.ti_email = TextArea(self, inputid.EMAIL, name=txt_email.Name)
btn_import = CreateButton(self,
btnid.IMPORT,
GT(u'Import'),
u'import',
name=u'btn import')
txt_import = wx.StaticText(
self, label=GT(u'Import information from Control page'))
# Changes input
self.ti_changes = TextAreaPanel(self, size=(20, 150), name=u'changes')
# *** Target installation directory
# FIXME: Should this be set by config or project file???
self.pnl_target = FileOTarget(self,
u'/usr/share/doc/<package>',
name=u'target default',
defaultType=CheckBoxESS,
customType=PathCtrlESS,
pathIds=(
chkid.TARGET,
inputid.TARGET,
))
self.btn_add = CreateButton(self,
btnid.ADD,
GT(u'Add'),
u'add',
name=u'btn add')
txt_add = wx.StaticText(self, label=GT(u'Insert new changelog entry'))
self.chk_indentation = CheckBox(self,
label=GT(u'Preserve indentation'),
name=u'indent')
self.dsp_changes = TextAreaPanelESS(self,
inputid.CHANGES,
monospace=True,
name=u'log')
self.dsp_changes.EnableDropTarget()
SetPageToolTips(self)
# *** Event Handling *** #
btn_import.Bind(wx.EVT_BUTTON, self.OnImportFromControl)
self.btn_add.Bind(wx.EVT_BUTTON, self.AddInfo)
# *** Layout *** #
LEFT_BOTTOM = lyt.ALGN_LB
LEFT_CENTER = wx.ALIGN_LEFT | wx.ALIGN_CENTER_VERTICAL
RIGHT_CENTER = wx.ALIGN_RIGHT | wx.ALIGN_CENTER_VERTICAL
lyt_info = wx.FlexGridSizer(2, 6)
lyt_info.AddGrowableCol(1)
lyt_info.AddGrowableCol(3)
lyt_info.AddGrowableCol(5)
lyt_info.AddMany(
((txt_package, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_package, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_version, 0, RIGHT_CENTER | wx.RIGHT, 5),
(self.ti_version, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_dist, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_dist, 1, wx.EXPAND | wx.BOTTOM,
5), (txt_urgency, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.sel_urgency, 1, wx.RIGHT, 5),
(txt_maintainer, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_maintainer, 1, wx.EXPAND | wx.RIGHT,
5), (txt_email, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_email, 1, wx.EXPAND)))
lyt_details = wx.GridBagSizer()
lyt_details.SetCols(3)
lyt_details.AddGrowableRow(2)
lyt_details.AddGrowableCol(1)
lyt_details.Add(btn_import, (0, 0))
lyt_details.Add(txt_import, (0, 1), flag=LEFT_CENTER)
lyt_details.Add(wx.StaticText(self, label=GT(u'Changes')), (1, 0),
flag=LEFT_BOTTOM)
lyt_details.Add(wx.StaticText(self, label=GT(u'Target')), (1, 2),
flag=LEFT_BOTTOM)
lyt_details.Add(self.ti_changes, (2, 0), (1, 2), wx.EXPAND | wx.RIGHT,
5)
lyt_details.Add(self.pnl_target, (2, 2))
lyt_details.Add(self.btn_add, (3, 0), (2, 1))
lyt_details.Add(txt_add, (3, 1), flag=LEFT_BOTTOM | wx.TOP, border=5)
lyt_details.Add(self.chk_indentation, (4, 1), flag=LEFT_BOTTOM)
lyt_main = BoxSizer(wx.VERTICAL)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_info, 0, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_details, 1, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.Add(wx.StaticText(self, label=u'Changelog Output'), 0,
LEFT_BOTTOM | lyt.PAD_LT, 5)
lyt_main.Add(self.dsp_changes, 1, wx.EXPAND | lyt.PAD_LR | wx.BOTTOM,
5)
self.SetAutoLayout(True)
self.SetSizer(lyt_main)
self.Layout()
## Formats input text from 'changes' field for new entry in changelog
def AddInfo(self, event=None):
new_changes = self.ti_changes.GetValue()
if TextIsEmpty(new_changes):
DetailedMessageDialog(
GetMainWindow(), GT(u'Warning'), ICON_WARNING,
GT(u'"Changes" section is empty')).ShowModal()
self.ti_changes.SetInsertionPointEnd()
self.ti_changes.SetFocus()
return
package = self.ti_package.GetValue()
version = self.ti_version.GetValue()
dist = self.ti_dist.GetValue()
urgency = self.sel_urgency.GetStringSelection()
maintainer = self.ti_maintainer.GetValue()
email = self.ti_email.GetValue()
new_changes = FormatChangelog(new_changes, package, version, dist,
urgency, maintainer, email,
self.chk_indentation.GetValue())
# Clean up leading & trailing whitespace in old changes
old_changes = self.dsp_changes.GetValue().strip(u' \t\n\r')
# Only append newlines if log isn't already empty
if not TextIsEmpty(old_changes):
new_changes = u'{}\n\n\n{}'.format(new_changes, old_changes)
# Add empty line to end of log
if not new_changes.endswith(u'\n'):
new_changes = u'{}\n'.format(new_changes)
self.dsp_changes.SetValue(new_changes)
# Clear "Changes" text
self.ti_changes.Clear()
self.ti_changes.SetFocus()
## Retrieves changelog text
#
# The output is a text file that uses sections defined by braces ([, ])
#
# \return
# <b><i>tuple(str, str)</i></b>: Filename & formatted string of changelog target & body
def Get(self):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target = u'STANDARD'
return (target, self.GetChangelog())
## Retrieves plain text of the changelog field
#
# \return
# Formatted changelog text
def GetChangelog(self):
return self.dsp_changes.GetValue()
## TODO: Doxygen
def GetSaveData(self):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target = u'<<DEST>>DEFAULT<</DEST>>'
else:
target = u'<<DEST>>{}<</DEST>>'.format(target)
return u'\n'.join((u'<<CHANGELOG>>', target,
self.dsp_changes.GetValue(), u'<</CHANGELOG>>'))
## Checks the page's fields for exporting
#
# \return
# <b><i>False</i></b> if page cannot be exported
def IsOkay(self):
return not TextIsEmpty(self.dsp_changes.GetValue())
## Imports select field values from the 'Control' page
def OnImportFromControl(self, event=None):
fields = (
(self.ti_package, inputid.PACKAGE),
(self.ti_version, inputid.VERSION),
(self.ti_maintainer, inputid.MAINTAINER),
(self.ti_email, inputid.EMAIL),
)
for F, FID in fields:
field_value = GetFieldValue(pgid.CONTROL, FID)
if isinstance(field_value, ErrorTuple):
err_msg1 = GT(
u'Got error when attempting to retrieve field value')
err_msg2 = u'\tError code: {}\n\tError message: {}'.format(
field_value.GetCode(), field_value.GetString())
Logger.Error(__name__, u'{}:\n{}'.format(err_msg1, err_msg2))
continue
if not TextIsEmpty(field_value):
F.SetValue(field_value)
## Sets values of page's fields with given input
#
# \param data
# Text to parse for values
def Set(self, data):
changelog = data.split(u'\n')
target = changelog[0].split(u'<<DEST>>')[1].split(u'<</DEST>>')[0]
if target == u'DEFAULT':
if not self.pnl_target.UsingDefault():
self.pnl_target.Reset()
else:
self.pnl_target.SetPath(target)
self.dsp_changes.SetValue(u'\n'.join(changelog[1:]))