wuicontentbase.py@ 65039

Last change on this file since 65039 was 65039, checked in by vboxsync, 8 years ago
testmanager: Simple system wide changelog.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 41.9 KB

Line
1	# -- coding: utf-8 --
2	# $Id: wuicontentbase.py 65039 2016-12-30 15:35:30Z vboxsync $
3
4	"""
5	Test Manager Web-UI - Content Base Classes.
6	"""
7
8	__copyright__ = \
9	"""
10	Copyright (C) 2012-2016 Oracle Corporation
11
12	This file is part of VirtualBox Open Source Edition (OSE), as
13	available from http://www.virtualbox.org. This file is free software;
14	you can redistribute it and/or modify it under the terms of the GNU
15	General Public License (GPL) as published by the Free Software
16	Foundation, in version 2 as it comes in the "COPYING" file of the
17	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19
20	The contents of this file may alternatively be used under the terms
21	of the Common Development and Distribution License Version 1.0
22	(CDDL) only, as it comes in the "COPYING.CDDL" file of the
23	VirtualBox OSE distribution, in which case the provisions of the
24	CDDL are applicable instead of those of the GPL.
25
26	You may elect to license modified versions of this file under the
27	terms and conditions of either the GPL or the CDDL or both.
28	"""
29	__version__ = "$Revision: 65039 $"
30
31
32	# Standard python imports.
33	import copy;
34
35	# Validation Kit imports.
36	from common import webutils;
37	from testmanager import config;
38	from testmanager.webui.wuibase import WuiDispatcherBase, WuiException;
39	from testmanager.webui.wuihlpform import WuiHlpForm;
40	from testmanager.core import db;
41	from testmanager.core.base import AttributeChangeEntryPre;
42
43
44	class WuiHtmlBase(object): # pylint: disable=R0903
45	"""
46	Base class for HTML objects.
47	"""
48
49	def __init__(self):
50	"""Dummy init to shut up pylint."""
51	pass;
52
53	def toHtml(self):
54	"""
55	Must be overridden by sub-classes.
56	"""
57	assert False;
58	return '';
59
60	def __str__(self):
61	""" String representation is HTML, simplifying formatting and such. """
62	return self.toHtml();
63
64
65	class WuiLinkBase(WuiHtmlBase): # pylint: disable=R0903
66	"""
67	For passing links from WuiListContentBase._formatListEntry.
68	"""
69
70	def __init__(self, sName, sUrlBase, dParams = None, sConfirm = None, sTitle = None,
71	sFragmentId = None, fBracketed = True, sExtraAttrs = ''):
72	WuiHtmlBase.__init__(self);
73	self.sName = sName
74	self.sUrl = sUrlBase
75	self.sConfirm = sConfirm;
76	self.sTitle = sTitle;
77	self.fBracketed = fBracketed;
78	self.sExtraAttrs = sExtraAttrs;
79
80	if dParams is not None and len(dParams) > 0:
81	# Do some massaging of None arguments.
82	dParams = dict(dParams);
83	for sKey in dParams:
84	if dParams[sKey] is None:
85	dParams[sKey] = '';
86	self.sUrl += '?' + webutils.encodeUrlParams(dParams)
87
88	if sFragmentId is not None:
89	self.sUrl += '#' + sFragmentId;
90
91	def setBracketed(self, fBracketed):
92	"""Changes the bracketing style."""
93	self.fBracketed = fBracketed;
94	return True;
95
96	def toHtml(self):
97	"""
98	Returns a simple HTML anchor element.
99	"""
100	sExtraAttrs = self.sExtraAttrs;
101	if self.sConfirm is not None:
102	sExtraAttrs += 'onclick=\'return confirm("%s");\' ' % (webutils.escapeAttr(self.sConfirm),);
103	if self.sTitle is not None:
104	sExtraAttrs += 'title="%s" ' % (webutils.escapeAttr(self.sTitle),);
105	if len(sExtraAttrs) > 0 and sExtraAttrs[-1] != ' ':
106	sExtraAttrs += ' ';
107
108	sFmt = '[<a %shref="%s">%s</a>]';
109	if not self.fBracketed:
110	sFmt = '<a %shref="%s">%s</a>';
111	return sFmt % (sExtraAttrs, webutils.escapeAttr(self.sUrl), webutils.escapeElem(self.sName));
112
113	class WuiTmLink(WuiLinkBase): # pylint: disable=R0903
114	""" Local link to the test manager. """
115
116	kdDbgParams = None;
117
118	def __init__(self, sName, sUrlBase, dParams = None, sConfirm = None, sTitle = None,
119	sFragmentId = None, fBracketed = True):
120
121	# Add debug parameters if necessary.
122	if self.kdDbgParams is not None and len(self.kdDbgParams) > 0:
123	if dParams is None or len(dParams) == 0:
124	dParams = dict(self.kdDbgParams);
125	else:
126	dParams = dict(dParams);
127	for sKey in self.kdDbgParams:
128	if sKey not in dParams:
129	dParams[sKey] = self.kdDbgParams[sKey];
130
131	WuiLinkBase.__init__(self, sName, sUrlBase, dParams, sConfirm, sTitle, sFragmentId, fBracketed);
132
133
134	class WuiSvnLink(WuiLinkBase): # pylint: disable=R0903
135	"""
136	For linking to a SVN revision.
137	"""
138	def __init__(self, iRevision, sName = None, fBracketed = True, sExtraAttrs = ''):
139	if sName is None:
140	sName = 'r%s' % (iRevision,);
141	WuiLinkBase.__init__(self, sName, config.g_ksTracLogUrlPrefix, { 'rev': iRevision,},
142	fBracketed = fBracketed, sExtraAttrs = sExtraAttrs);
143
144	class WuiSvnLinkWithTooltip(WuiSvnLink): # pylint: disable=R0903
145	"""
146	For linking to a SVN revision with changelog tooltip.
147	"""
148	def __init__(self, iRevision, sRepository, sName = None, fBracketed = True):
149	sExtraAttrs = ' onmouseover="return svnHistoryTooltipShow(event,\'%s\',%s);" onmouseout="return tooltipHide();"' \
150	% ( sRepository, iRevision, );
151	WuiSvnLink.__init__(self, iRevision, sName = sName, fBracketed = fBracketed, sExtraAttrs = sExtraAttrs);
152
153	class WuiBuildLogLink(WuiLinkBase):
154	"""
155	For linking to a build log.
156	"""
157	def __init__(self, sUrl, sName = None, fBracketed = True):
158	assert sUrl is not None; assert len(sUrl) > 0;
159	if sName is None:
160	sName = 'Build log';
161	if not webutils.hasSchema(sUrl):
162	WuiLinkBase.__init__(self, sName, config.g_ksBuildLogUrlPrefix + sUrl, fBracketed = fBracketed);
163	else:
164	WuiLinkBase.__init__(self, sName, sUrl, fBracketed = fBracketed);
165
166	class WuiRawHtml(WuiHtmlBase): # pylint: disable=R0903
167	"""
168	For passing raw html from WuiListContentBase._formatListEntry.
169	"""
170	def __init__(self, sHtml):
171	self.sHtml = sHtml;
172	WuiHtmlBase.__init__(self);
173
174	def toHtml(self):
175	return self.sHtml;
176
177	class WuiHtmlKeeper(WuiHtmlBase): # pylint: disable=R0903
178	"""
179	For keeping a list of elements, concatenating their toHtml output together.
180	"""
181	def __init__(self, aoInitial = None, sSep = ' '):
182	WuiHtmlBase.__init__(self);
183	self.sSep = sSep;
184	self.aoKept = [];
185	if aoInitial is not None:
186	if isinstance(aoInitial, WuiHtmlBase):
187	self.aoKept.append(aoInitial);
188	else:
189	self.aoKept.extend(aoInitial);
190
191	def append(self, oObject):
192	""" Appends one objects. """
193	self.aoKept.append(oObject);
194
195	def extend(self, aoObjects):
196	""" Appends a list of objects. """
197	self.aoKept.extend(aoObjects);
198
199	def toHtml(self):
200	return self.sSep.join(oObj.toHtml() for oObj in self.aoKept);
201
202	class WuiSpanText(WuiRawHtml): # pylint: disable=R0903
203	"""
204	Outputs the given text within a span of the given CSS class.
205	"""
206	def __init__(self, sSpanClass, sText, sTitle = None):
207	if sTitle is None:
208	WuiRawHtml.__init__(self,
209	u'<span class="%s">%s</span>'
210	% ( webutils.escapeAttr(sSpanClass), webutils.escapeElem(sText),));
211	else:
212	WuiRawHtml.__init__(self,
213	u'<span class="%s" title="%s">%s</span>'
214	% ( webutils.escapeAttr(sSpanClass), webutils.escapeAttr(sTitle), webutils.escapeElem(sText),));
215
216
217
218	class WuiContentBase(object): # pylint: disable=R0903
219	"""
220	Base for the content classes.
221	"""
222
223	## The text/symbol for a very short add link.
224	ksShortAddLink = u'\u2795'
225	## HTML hex entity string for ksShortAddLink.
226	ksShortAddLinkHtml = '➕;'
227	## The text/symbol for a very short edit link.
228	ksShortEditLink = u'\u270D'
229	## HTML hex entity string for ksShortDetailsLink.
230	ksShortEditLinkHtml = '✍'
231	## The text/symbol for a very short details link.
232	ksShortDetailsLink = u'\u2318'
233	## HTML hex entity string for ksShortDetailsLink.
234	ksShortDetailsLinkHtml = '⌘'
235	## The text/symbol for a very short change log / details / previous page link.
236	ksShortChangeLogLink = u'\u2397'
237	## HTML hex entity string for ksShortDetailsLink.
238	ksShortChangeLogLinkHtml = '⎗'
239	## The text/symbol for a very short reports link.
240	ksShortReportLink = u'\u2397'
241	## HTML hex entity string for ksShortReportLink.
242	ksShortReportLinkHtml = '⎗'
243
244
245	def __init__(self, fnDPrint = None, oDisp = None):
246	self._oDisp = oDisp; # WuiDispatcherBase.
247	self._fnDPrint = fnDPrint;
248	if fnDPrint is None and oDisp is not None:
249	self._fnDPrint = oDisp.dprint;
250
251	def dprint(self, sText):
252	""" Debug printing. """
253	if self._fnDPrint:
254	self._fnDPrint(sText);
255
256	def formatTsShort(self, oTs):
257	"""
258	Formats a timestamp (db rep) into a short form.
259	"""
260	oTsZulu = db.dbTimestampToZuluDatetime(oTs);
261	sTs = oTsZulu.strftime('%Y-%m-%d %H:%M:%SZ');
262	return unicode(sTs).replace('-', u'\u2011').replace(' ', u'\u00a0');
263
264	def getNowTs(self):
265	""" Gets a database compatible current timestamp from python. See db.dbTimestampPythonNow(). """
266	return db.dbTimestampPythonNow();
267
268	def formatIntervalShort(self, oInterval):
269	"""
270	Formats an interval (db rep) into a short form.
271	"""
272	# default formatting for negative intervals.
273	if oInterval.days < 0:
274	return str(oInterval);
275
276	# Figure the hour, min and sec counts.
277	cHours = oInterval.seconds / 3600;
278	cMinutes = (oInterval.seconds % 3600) / 60;
279	cSeconds = oInterval.seconds - cHours * 3600 - cMinutes * 60;
280
281	# Tailor formatting to the interval length.
282	if oInterval.days > 0:
283	if oInterval.days > 1:
284	return '%d days, %d:%02d:%02d' % (oInterval.days, cHours, cMinutes, cSeconds);
285	return '1 day, %d:%02d:%02d' % (cHours, cMinutes, cSeconds);
286	if cMinutes > 0 or cSeconds >= 30 or cHours > 0:
287	return '%d:%02d:%02d' % (cHours, cMinutes, cSeconds);
288	if cSeconds >= 10:
289	return '%d.%ds' % (cSeconds, oInterval.microseconds / 100000);
290	if cSeconds > 0:
291	return '%d.%02ds' % (cSeconds, oInterval.microseconds / 10000);
292	return '%d ms' % (oInterval.microseconds / 1000,);
293
294	@staticmethod
295	def genericPageWalker(iCurItem, cItems, sHrefFmt, cWidth = 11, iBase = 1, sItemName = 'page'):
296	"""
297	Generic page walker generator.
298
299	sHrefFmt has three %s sequences:
300	1. The first is the page number link parameter (0-based).
301	2. The title text, iBase-based number or text.
302	3. The link text, iBase-based number or text.
303	"""
304
305	# Calc display range.
306	iStart = 0 if iCurItem - cWidth / 2 <= cWidth / 4 else iCurItem - cWidth / 2;
307	iEnd = iStart + cWidth;
308	if iEnd > cItems:
309	iEnd = cItems;
310	if cItems > cWidth:
311	iStart = cItems - cWidth;
312
313	sHtml = u'';
314
315	# Previous page (using << >> because « and &raquo are too tiny).
316	if iCurItem > 0:
317	sHtml += '%s  ' % sHrefFmt % (iCurItem - 1, 'previous ' + sItemName, '<<');
318	else:
319	sHtml += '<<  ';
320
321	# 1 2 3 4...
322	if iStart > 0:
323	sHtml += '%s  ...  \n' % (sHrefFmt % (0, 'first %s' % (sItemName,), 0 + iBase),);
324
325	sHtml += ' \n'.join(sHrefFmt % (i, '%s %d' % (sItemName, i + iBase), i + iBase) if i != iCurItem
326	else unicode(i + iBase)
327	for i in range(iStart, iEnd));
328	if iEnd < cItems:
329	sHtml += '  ...  %s\n' % (sHrefFmt % (cItems - 1, 'last %s' % (sItemName,), cItems - 1 + iBase));
330
331	# Next page.
332	if iCurItem + 1 < cItems:
333	sHtml += '  %s' % sHrefFmt % (iCurItem + 1, 'next ' + sItemName, '>>');
334	else:
335	sHtml += '  >>';
336
337	return sHtml;
338
339	class WuiSingleContentBase(WuiContentBase): # pylint: disable=R0903
340	"""
341	Base for the content classes working on a single data object (oData).
342	"""
343	def __init__(self, oData, oDisp = None, fnDPrint = None):
344	WuiContentBase.__init__(self, oDisp = oDisp, fnDPrint = fnDPrint);
345	self._oData = oData; # Usually ModelDataBase.
346
347
348	class WuiFormContentBase(WuiSingleContentBase): # pylint: disable=R0903
349	"""
350	Base class for simple input form content classes (single data object).
351	"""
352
353	## @name Form mode.
354	## @{
355	ksMode_Add = 'add';
356	ksMode_Edit = 'edit';
357	ksMode_Show = 'show';
358	## @}
359
360	## Default action mappings.
361	kdSubmitActionMappings = {
362	ksMode_Add: 'AddPost',
363	ksMode_Edit: 'EditPost',
364	};
365
366	def __init__(self, oData, sMode, sCoreName, oDisp, sTitle, sId = None, fEditable = True, sSubmitAction = None):
367	WuiSingleContentBase.__init__(self, copy.copy(oData), oDisp);
368	assert sMode in [self.ksMode_Add, self.ksMode_Edit, self.ksMode_Show];
369	assert len(sTitle) > 1;
370	assert sId is None or len(sId) > 0;
371
372	self._sMode = sMode;
373	self._sCoreName = sCoreName;
374	self._sActionBase = 'ksAction' + sCoreName;
375	self._sTitle = sTitle;
376	self._sId = sId if sId is not None else (type(oData).__name__.lower() + 'form');
377	self._fEditable = fEditable;
378	self._sSubmitAction = sSubmitAction;
379	if sSubmitAction is None and sMode != self.ksMode_Show:
380	self._sSubmitAction = getattr(oDisp, self._sActionBase + self.kdSubmitActionMappings[sMode]);
381	self._sRedirectTo = None;
382
383
384	def _populateForm(self, oForm, oData):
385	"""
386	Populates the form. oData has parameter NULL values.
387	This must be reimplemented by the child.
388	"""
389	_ = oForm; _ = oData;
390	raise Exception('Reimplement me!');
391
392	def _generatePostFormContent(self, oData):
393	"""
394	Generate optional content that comes below the form.
395	Returns a list of tuples, where the first tuple element is the title
396	and the second the content. I.e. similar to show() output.
397	"""
398	_ = oData;
399	return [];
400
401	def _calcChangeLogEntryLinks(self, aoEntries, iEntry):
402	"""
403	Returns an array of links to go with the change log entry.
404	"""
405	_ = aoEntries; _ = iEntry;
406	## @todo detect deletion and recreation.
407	## @todo view details link.
408	## @todo restore link (need new action)
409	## @todo clone link.
410	return [];
411
412	def _guessChangeLogEntryDescription(self, aoEntries, iEntry):
413	"""
414	Guesses the action + author that caused the change log entry.
415	Returns descriptive string.
416	"""
417	oEntry = aoEntries[iEntry];
418
419	# Figure the author of the change.
420	if oEntry.sAuthor is not None:
421	sAuthor = '%s (#%s)' % (oEntry.sAuthor, oEntry.uidAuthor,);
422	elif oEntry.uidAuthor is not None:
423	sAuthor = '#%d (??)' % (oEntry.uidAuthor,);
424	else:
425	sAuthor = None;
426
427	# Figure the action.
428	if oEntry.oOldRaw is None:
429	if sAuthor is None:
430	return 'Created by batch job.';
431	return 'Created by %s.' % (sAuthor,);
432
433	if sAuthor is None:
434	return 'Automatically updated.'
435	return 'Modified by %s.' % (sAuthor,);
436
437	def _formatChangeLogEntry(self, aoEntries, iEntry):
438	"""
439	Formats one change log entry into one or more HTML table rows.
440
441	Note! The parameters are given as array + index in case someone wishes
442	to access adjacent entries later in order to generate better
443	change descriptions.
444	"""
445	oEntry = aoEntries[iEntry];
446
447	# The primary row.
448	sRowClass = 'tmodd' if (iEntry + 1) & 1 else 'tmeven';
449	sContent = ' <tr class="%s">\n' \
450	' <td rowspan="%d">%s</td>\n' \
451	' <td rowspan="%d">%s</td>\n' \
452	' <td colspan="3">%s%s</td>\n' \
453	' </tr>\n' \
454	% ( sRowClass,
455	len(oEntry.aoChanges) + 1, webutils.escapeElem(self.formatTsShort(oEntry.tsEffective)),
456	len(oEntry.aoChanges) + 1, webutils.escapeElem(self.formatTsShort(oEntry.tsExpire)),
457	self._guessChangeLogEntryDescription(aoEntries, iEntry),
458	' '.join(oLink.toHtml() for oLink in self._calcChangeLogEntryLinks(aoEntries, iEntry)),);
459
460	# Additional rows for each changed attribute.
461	j = 0;
462	for oChange in oEntry.aoChanges:
463	if isinstance(oChange, AttributeChangeEntryPre):
464	sContent += ' <tr class="%s%s"><td>%s</td>'\
465	'<td><div class="tdpre"><pre>%s</pre></div></td>' \
466	'<td><div class="tdpre"><pre>%s</pre></div></td></tr>\n' \
467	% ( sRowClass, 'odd' if j & 1 else 'even',
468	webutils.escapeElem(oChange.sAttr),
469	webutils.escapeElem(oChange.sOldText),
470	webutils.escapeElem(oChange.sNewText), );
471	else:
472	sContent += ' <tr class="%s%s"><td>%s</td><td>%s</td><td>%s</td></tr>\n' \
473	% ( sRowClass, 'odd' if j & 1 else 'even',
474	webutils.escapeElem(oChange.sAttr),
475	webutils.escapeElem(oChange.sOldText),
476	webutils.escapeElem(oChange.sNewText), );
477	j += 1;
478
479	return sContent;
480
481	def _showChangeLogNavi(self, fMoreEntries, iPageNo, cEntriesPerPage, tsNow, sWhere):
482	"""
483	Returns the HTML for the change log navigator.
484	Note! See also _generateNavigation.
485	"""
486	sNavigation = '<div class="tmlistnav-%s">\n' % sWhere;
487	sNavigation += ' <table class="tmlistnavtab">\n' \
488	' <tr>\n';
489	dParams = self._oDisp.getParameters();
490	dParams[WuiDispatcherBase.ksParamChangeLogEntriesPerPage] = cEntriesPerPage;
491	dParams[WuiDispatcherBase.ksParamChangeLogPageNo] = iPageNo;
492	if tsNow is not None:
493	dParams[WuiDispatcherBase.ksParamEffectiveDate] = tsNow;
494
495	# Prev and combo box in one cell. Both inside the form for formatting reasons.
496	sNavigation += ' <td align="left">\n' \
497	' <form name="ChangeLogEntriesPerPageForm" method="GET">\n'
498
499	# Prev
500	if iPageNo > 0:
501	dParams[WuiDispatcherBase.ksParamChangeLogPageNo] = iPageNo - 1;
502	sNavigation += '<a href="?%s#tmchangelog">Previous</a>\n' \
503	% (webutils.encodeUrlParams(dParams),);
504	dParams[WuiDispatcherBase.ksParamChangeLogPageNo] = iPageNo;
505	else:
506	sNavigation += 'Previous\n';
507
508	# Entries per page selector.
509	del dParams[WuiDispatcherBase.ksParamChangeLogEntriesPerPage];
510	sNavigation += '   \n' \
511	' <select name="%s" onchange="window.location=\'?%s&%s=\' + ' \
512	'this.options[this.selectedIndex].value + \'#tmchangelog\';" ' \
513	'title="Max change log entries per page">\n' \
514	% (WuiDispatcherBase.ksParamChangeLogEntriesPerPage,
515	webutils.encodeUrlParams(dParams),
516	WuiDispatcherBase.ksParamChangeLogEntriesPerPage);
517	dParams[WuiDispatcherBase.ksParamChangeLogEntriesPerPage] = cEntriesPerPage;
518
519	for iEntriesPerPage in [2, 4, 8, 16, 32, 64, 128, 256, 384, 512, 768, 1024, 1536, 2048, 3072, 4096, 8192]:
520	sNavigation += ' <option value="%d" %s>%d entries per page</option>\n' \
521	% ( iEntriesPerPage,
522	'selected="selected"' if iEntriesPerPage == cEntriesPerPage else '',
523	iEntriesPerPage );
524	sNavigation += ' </select>\n';
525
526	# End of cell (and form).
527	sNavigation += ' </form>\n' \
528	' </td>\n';
529
530	# Next
531	if fMoreEntries:
532	dParams[WuiDispatcherBase.ksParamChangeLogPageNo] = iPageNo + 1;
533	sNavigation += ' <td align="right"><a href="?%s#tmchangelog">Next</a></td>\n' \
534	% (webutils.encodeUrlParams(dParams),);
535	else:
536	sNavigation += ' <td align="right">Next</td>\n';
537
538	sNavigation += ' </tr>\n' \
539	' </table>\n' \
540	'</div>\n';
541	return sNavigation;
542
543	def setRedirectTo(self, sRedirectTo):
544	"""
545	For setting the hidden redirect-to field.
546	"""
547	self._sRedirectTo = sRedirectTo;
548	return True;
549
550	def showChangeLog(self, aoEntries, fMoreEntries, iPageNo, cEntriesPerPage, tsNow, fShowNavigation = True):
551	"""
552	Render the change log, returning raw HTML.
553	aoEntries is an array of ChangeLogEntry.
554	"""
555	sContent = '\n' \
556	'<hr>\n' \
557	'<div id="tmchangelog">\n' \
558	' <h3>Change Log </h3>\n';
559	if fShowNavigation:
560	sContent += self._showChangeLogNavi(fMoreEntries, iPageNo, cEntriesPerPage, tsNow, 'top');
561	sContent += ' <table class="tmtable tmchangelog">\n' \
562	' <thead class="tmheader">' \
563	' <tr>' \
564	' <th rowspan="2">When</th>\n' \
565	' <th rowspan="2">Expire (excl)</th>\n' \
566	' <th colspan="3">Changes</th>\n' \
567	' </tr>\n' \
568	' <tr>\n' \
569	' <th>Attribute</th>\n' \
570	' <th>Old value</th>\n' \
571	' <th>New value</th>\n' \
572	' </tr>\n' \
573	' </thead>\n' \
574	' <tbody>\n';
575
576	for iEntry in range(len(aoEntries)):
577	sContent += self._formatChangeLogEntry(aoEntries, iEntry);
578
579	sContent += ' <tbody>\n' \
580	' </table>\n';
581	if fShowNavigation and len(aoEntries) >= 8:
582	sContent += self._showChangeLogNavi(fMoreEntries, iPageNo, cEntriesPerPage, tsNow, 'bottom');
583	sContent += '</div>\n\n';
584	return sContent;
585
586	def _generateTopRowFormActions(self, oData):
587	"""
588	Returns a list of WuiTmLinks.
589	"""
590	aoActions = [];
591	if self._sMode == self.ksMode_Show and self._fEditable:
592	# Remove _idGen and effective date since we're always editing the current data,
593	# and make sure the primary ID is present.
594	dParams = self._oDisp.getParameters();
595	if hasattr(oData, 'ksIdGenAttr'):
596	sIdGenParam = getattr(oData, 'ksParam_' + oData.ksIdGenAttr);
597	if sIdGenParam in dParams:
598	del dParams[sIdGenParam];
599	if WuiDispatcherBase.ksParamEffectiveDate in dParams:
600	del dParams[WuiDispatcherBase.ksParamEffectiveDate];
601	dParams[getattr(oData, 'ksParam_' + oData.ksIdAttr)] = getattr(oData, oData.ksIdAttr);
602
603	dParams[WuiDispatcherBase.ksParamAction] = getattr(self._oDisp, self._sActionBase + 'Edit');
604	aoActions.append(WuiTmLink('Edit', '', dParams));
605
606	# Add clone operation if available. This uses the same data selection as for showing details.
607	if hasattr(self._oDisp, self._sActionBase + 'Clone'):
608	dParams = self._oDisp.getParameters();
609	dParams[WuiDispatcherBase.ksParamAction] = getattr(self._oDisp, self._sActionBase + 'Clone');
610	aoActions.append(WuiTmLink('Clone', '', dParams));
611
612	elif self._sMode == self.ksMode_Edit:
613	# Details views the details at a given time, so we need either idGen or an effecive date + regular id.
614	dParams = {};
615	if hasattr(oData, 'ksIdGenAttr'):
616	sIdGenParam = getattr(oData, 'ksParam_' + oData.ksIdGenAttr);
617	dParams[sIdGenParam] = getattr(oData, oData.ksIdGenAttr);
618	elif hasattr(oData, 'tsEffective'):
619	dParams[WuiDispatcherBase.ksParamEffectiveDate] = oData.tsEffective;
620	dParams[getattr(oData, 'ksParam_' + oData.ksIdAttr)] = getattr(oData, oData.ksIdAttr);
621	dParams[WuiDispatcherBase.ksParamAction] = getattr(self._oDisp, self._sActionBase + 'Details');
622	aoActions.append(WuiTmLink('Details', '', dParams));
623
624	# Add delete operation if available.
625	if hasattr(self._oDisp, self._sActionBase + 'DoRemove'):
626	dParams = self._oDisp.getParameters();
627	dParams[WuiDispatcherBase.ksParamAction] = getattr(self._oDisp, self._sActionBase + 'DoRemove');
628	dParams[getattr(oData, 'ksParam_' + oData.ksIdAttr)] = getattr(oData, oData.ksIdAttr);
629	aoActions.append(WuiTmLink('Delete', '', dParams, sConfirm = "Are you absolutely sure?"));
630
631	return aoActions;
632
633	def showForm(self, dErrors = None, sErrorMsg = None):
634	"""
635	Render the form.
636	"""
637	oForm = WuiHlpForm(self._sId,
638	'?' + webutils.encodeUrlParams({WuiDispatcherBase.ksParamAction: self._sSubmitAction}),
639	dErrors if dErrors is not None else dict(),
640	fReadOnly = self._sMode == self.ksMode_Show);
641
642	self._oData.convertToParamNull();
643
644	# If form cannot be constructed due to some reason we
645	# need to show this reason
646	try:
647	self._populateForm(oForm, self._oData);
648	if self._sRedirectTo is not None:
649	oForm.addTextHidden(self._oDisp.ksParamRedirectTo, self._sRedirectTo);
650	except WuiException, oXcpt:
651	sContent = unicode(oXcpt)
652	else:
653	sContent = oForm.finalize();
654
655	# Add any post form content.
656	atPostFormContent = self._generatePostFormContent(self._oData);
657	if atPostFormContent is not None and len(atPostFormContent) > 0:
658	for iSection, tSection in enumerate(atPostFormContent):
659	(sSectionTitle, sSectionContent) = tSection;
660	sContent += u'<div id="postform-%d" class="tmformpostsection">\n' % (iSection,);
661	if sSectionTitle is not None and len(sSectionTitle) > 0:
662	sContent += '<h3 class="tmformpostheader">%s</h3>\n' % (webutils.escapeElem(sSectionTitle),);
663	sContent += u' <div id="postform-%d-content" class="tmformpostcontent">\n' % (iSection,);
664	sContent += sSectionContent;
665	sContent += u' </div>\n' \
666	u'</div>\n';
667
668	# Add action to the top.
669	aoActions = self._generateTopRowFormActions(self._oData);
670	if len(aoActions) > 0:
671	sActionLinks = '<p>%s</p>' % (' '.join(unicode(oLink) for oLink in aoActions));
672	sContent = sActionLinks + sContent;
673
674	# Add error info to the top.
675	if sErrorMsg is not None:
676	sContent = '<p class="tmerrormsg">' + webutils.escapeElem(sErrorMsg) + '</p>\n' + sContent;
677
678	return (self._sTitle, sContent);
679
680	def getListOfItems(self, asListItems = tuple(), asSelectedItems = tuple()):
681	"""
682	Format generic list which should be used by HTML form
683	"""
684	aoRet = []
685	for sListItem in asListItems:
686	fEnabled = True if sListItem in asSelectedItems else False
687	aoRet.append((sListItem, fEnabled, sListItem))
688	return aoRet
689
690
691	class WuiListContentBase(WuiContentBase):
692	"""
693	Base for the list content classes.
694	"""
695
696	def __init__(self, aoEntries, iPage, cItemsPerPage, tsEffectiveDate, sTitle, sId = None, fnDPrint = None, oDisp = None):
697	WuiContentBase.__init__(self, fnDPrint = fnDPrint, oDisp = oDisp);
698	self._aoEntries = aoEntries; ## @todo should replace this with a Logic object and define methods for querying.
699	self._iPage = iPage;
700	self._cItemsPerPage = cItemsPerPage;
701	self._tsEffectiveDate = tsEffectiveDate;
702	self._sTitle = sTitle; assert len(sTitle) > 1;
703	if sId is None:
704	sId = sTitle.strip().replace(' ', '').lower();
705	assert len(sId.strip()) > 0;
706	self._sId = sId;
707	self._asColumnHeaders = [];
708	self._asColumnAttribs = [];
709
710	def _formatCommentCell(self, sComment, cMaxLines = 3, cchMaxLine = 63):
711	"""
712	Helper functions for formatting comment cell.
713	Returns None or WuiRawHtml instance.
714	"""
715	# Nothing to do for empty comments.
716	if sComment is None:
717	return None;
718	sComment = sComment.strip();
719	if len(sComment) == 0:
720	return None;
721
722	# Restrict the text if necessary, making the whole text available thru mouse-over.
723	## @todo this would be better done by java script or smth, so it could automatically adjust to the table size.
724	if len(sComment) > cchMaxLine or sComment.count('\n') >= cMaxLines:
725	sShortHtml = '';
726	for iLine, sLine in enumerate(sComment.split('\n')):
727	if iLine >= cMaxLines:
728	break;
729	if iLine > 0:
730	sShortHtml += '<br>\n';
731	if len(sLine) > cchMaxLine:
732	sShortHtml += webutils.escapeElem(sLine[:(cchMaxLine - 3)]);
733	sShortHtml += '...';
734	else:
735	sShortHtml += webutils.escapeElem(sLine);
736	return WuiRawHtml('<span class="tmcomment" title="%s">%s</span>' % (webutils.escapeAttr(sComment), sShortHtml,));
737
738	return WuiRawHtml('<span class="tmcomment">%s</span>' % (webutils.escapeElem(sComment).replace('\n', '<br>'),));
739
740	def _formatListEntry(self, iEntry):
741	"""
742	Formats the specified list entry as a list of column values.
743	Returns HTML for a table row.
744
745	The child class really need to override this!
746	"""
747	# ASSUMES ModelDataBase children.
748	asRet = [];
749	for sAttr in self._aoEntries[0].getDataAttributes():
750	asRet.append(getattr(self._aoEntries[iEntry], sAttr));
751	return asRet;
752
753	def _formatListEntryHtml(self, iEntry):
754	"""
755	Formats the specified list entry as HTML.
756	Returns HTML for a table row.
757
758	The child class can override this to
759	"""
760	if (iEntry + 1) & 1:
761	sRow = u' <tr class="tmodd">\n';
762	else:
763	sRow = u' <tr class="tmeven">\n';
764
765	aoValues = self._formatListEntry(iEntry);
766	assert len(aoValues) == len(self._asColumnHeaders), '%s vs %s' % (len(aoValues), len(self._asColumnHeaders));
767
768	for i, _ in enumerate(aoValues):
769	if i < len(self._asColumnAttribs) and len(self._asColumnAttribs[i]) > 0:
770	sRow += u' <td ' + self._asColumnAttribs[i] + '>';
771	else:
772	sRow += u' <td>';
773
774	if isinstance(aoValues[i], WuiHtmlBase):
775	sRow += aoValues[i].toHtml();
776	elif isinstance(aoValues[i], list):
777	if len(aoValues[i]) > 0:
778	for oElement in aoValues[i]:
779	if isinstance(oElement, WuiHtmlBase):
780	sRow += oElement.toHtml();
781	elif db.isDbTimestamp(oElement):
782	sRow += webutils.escapeElem(self.formatTsShort(oElement));
783	else:
784	sRow += webutils.escapeElem(unicode(oElement));
785	sRow += ' ';
786	elif db.isDbTimestamp(aoValues[i]):
787	sRow += webutils.escapeElem(self.formatTsShort(aoValues[i]));
788	elif db.isDbInterval(aoValues[i]):
789	sRow += webutils.escapeElem(self.formatIntervalShort(aoValues[i]));
790	elif aoValues[i] is not None:
791	sRow += webutils.escapeElem(unicode(aoValues[i]));
792
793	sRow += u'</td>\n';
794
795	return sRow + u' </tr>\n';
796
797	def _generateTimeNavigation(self, sWhere):
798	"""
799	Returns HTML for time navigation.
800
801	Note! Views without a need for a timescale just stubs this method.
802	"""
803	_ = sWhere;
804	sNavigation = '';
805
806	dParams = self._oDisp.getParameters();
807	dParams[WuiDispatcherBase.ksParamItemsPerPage] = self._cItemsPerPage;
808	dParams[WuiDispatcherBase.ksParamPageNo] = self._iPage;
809
810	if WuiDispatcherBase.ksParamEffectiveDate in dParams:
811	del dParams[WuiDispatcherBase.ksParamEffectiveDate];
812	sNavigation += ' [<a href="?%s">Now</a>]' % (webutils.encodeUrlParams(dParams),);
813
814	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-00 01:00:00.00';
815	sNavigation += ' [<a href="?%s">1</a>' % (webutils.encodeUrlParams(dParams),);
816
817	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-00 02:00:00.00';
818	sNavigation += ', <a href="?%s">2</a>' % (webutils.encodeUrlParams(dParams),);
819
820	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-00 06:00:00.00';
821	sNavigation += ', <a href="?%s">6</a>' % (webutils.encodeUrlParams(dParams),);
822
823	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-00 12:00:00.00';
824	sNavigation += ', <a href="?%s">12</a>' % (webutils.encodeUrlParams(dParams),);
825
826	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-01 00:00:00.00';
827	sNavigation += ', or <a href="?%s">24</a> hours ago]' % (webutils.encodeUrlParams(dParams),);
828
829
830	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-02 00:00:00.00';
831	sNavigation += ' [<a href="?%s">2</a>' % (webutils.encodeUrlParams(dParams),);
832
833	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-03 00:00:00.00';
834	sNavigation += ', <a href="?%s">3</a>' % (webutils.encodeUrlParams(dParams),);
835
836	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-05 00:00:00.00';
837	sNavigation += ', <a href="?%s">5</a>' % (webutils.encodeUrlParams(dParams),);
838
839	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-07 00:00:00.00';
840	sNavigation += ', <a href="?%s">7</a>' % (webutils.encodeUrlParams(dParams),);
841
842	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-14 00:00:00.00';
843	sNavigation += ', <a href="?%s">14</a>' % (webutils.encodeUrlParams(dParams),);
844
845	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-21 00:00:00.00';
846	sNavigation += ', <a href="?%s">21</a>' % (webutils.encodeUrlParams(dParams),);
847
848	dParams[WuiDispatcherBase.ksParamEffectiveDate] = '-0000-00-28 00:00:00.00';
849	sNavigation += ', or <a href="?%s">28</a> days ago]' % (webutils.encodeUrlParams(dParams),);
850
851	return sNavigation;
852
853
854	def _generateNavigation(self, sWhere):
855	"""
856	Return HTML for navigation.
857	"""
858
859	#
860	# ASSUMES the dispatcher/controller code fetches one entry more than
861	# needed to fill the page to indicate further records.
862	#
863	sNavigation = '<div class="tmlistnav-%s">\n' % sWhere;
864	sNavigation += ' <table class="tmlistnavtab">\n' \
865	' <tr>\n';
866	dParams = self._oDisp.getParameters();
867	dParams[WuiDispatcherBase.ksParamItemsPerPage] = self._cItemsPerPage;
868	dParams[WuiDispatcherBase.ksParamPageNo] = self._iPage;
869	if self._tsEffectiveDate is not None:
870	dParams[WuiDispatcherBase.ksParamEffectiveDate] = self._tsEffectiveDate;
871
872	# Prev
873	if self._iPage > 0:
874	dParams[WuiDispatcherBase.ksParamPageNo] = self._iPage - 1;
875	sNavigation += ' <td align="left"><a href="?%s">Previous</a></td>\n' % (webutils.encodeUrlParams(dParams),);
876	else:
877	sNavigation += ' <td></td>\n';
878
879	# Time scale.
880	sNavigation += '<td align="center" class="tmtimenav">';
881	sNavigation += self._generateTimeNavigation(sWhere);
882	sNavigation += '</td>';
883
884	# Next
885	if len(self._aoEntries) > self._cItemsPerPage:
886	dParams[WuiDispatcherBase.ksParamPageNo] = self._iPage + 1;
887	sNavigation += ' <td align="right"><a href="?%s">Next</a></td>\n' % (webutils.encodeUrlParams(dParams),);
888	else:
889	sNavigation += ' <td></td>\n';
890
891	sNavigation += ' </tr>\n' \
892	' </table>\n' \
893	'</div>\n';
894	return sNavigation;
895
896	def _generateTable(self):
897	"""
898	show worker that just generates the table.
899	"""
900
901	#
902	# Create a table.
903	# If no colum headers are provided, fall back on database field
904	# names, ASSUMING that the entries are ModelDataBase children.
905	# Note! the cellspacing is for IE8.
906	#
907	sPageBody = '<table class="tmtable" id="' + self._sId + '" cellspacing="0">\n';
908
909	if len(self._asColumnHeaders) == 0:
910	self._asColumnHeaders = self._aoEntries[0].getDataAttributes();
911
912	sPageBody += ' <thead class="tmheader"><tr>';
913	for oHeader in self._asColumnHeaders:
914	if isinstance(oHeader, WuiHtmlBase):
915	sPageBody += '<th>' + oHeader.toHtml() + '</th>';
916	else:
917	sPageBody += '<th>' + webutils.escapeElem(oHeader) + '</th>';
918	sPageBody += '</tr><thead>\n';
919
920	#
921	# Format the body and close the table.
922	#
923	sPageBody += ' <tbody>\n';
924	for iEntry in range(min(len(self._aoEntries), self._cItemsPerPage)):
925	sPageBody += self._formatListEntryHtml(iEntry);
926	sPageBody += ' </tbody>\n' \
927	'</table>\n';
928	return sPageBody;
929
930	def _composeTitle(self):
931	"""Composes the title string (return value)."""
932	sTitle = self._sTitle;
933	if self._iPage != 0:
934	sTitle += ' (page ' + unicode(self._iPage + 1) + ')'
935	if self._tsEffectiveDate is not None:
936	sTitle += ' as per ' + unicode(self._tsEffectiveDate); ## @todo shorten this.
937	return sTitle;
938
939
940	def show(self, fShowNavigation = True):
941	"""
942	Displays the list.
943	Returns (Title, HTML) on success, raises exception on error.
944	"""
945
946	sPageBody = ''
947	if fShowNavigation:
948	sPageBody += self._generateNavigation('top');
949
950	if len(self._aoEntries):
951	sPageBody += self._generateTable();
952	if fShowNavigation:
953	sPageBody += self._generateNavigation('bottom');
954	else:
955	sPageBody += '<p>No entries.</p>'
956
957	return (self._composeTitle(), sPageBody);
958
959
960	class WuiListContentWithActionBase(WuiListContentBase):
961	"""
962	Base for the list content with action classes.
963	"""
964
965	def __init__(self, aoEntries, iPage, cItemsPerPage, tsEffectiveDate, sTitle, sId = None, fnDPrint = None, oDisp = None):
966	WuiListContentBase.__init__(self, aoEntries, iPage, cItemsPerPage, tsEffectiveDate, sTitle,
967	sId = sId, fnDPrint = fnDPrint, oDisp = oDisp);
968	self._aoActions = None; # List of [ oValue, sText, sHover ] provided by the child class.
969	self._sAction = None; # Set by the child class.
970	self._sCheckboxName = None; # Set by the child class.
971	self._asColumnHeaders = [ WuiRawHtml('<input type="checkbox" onClick="toggle%s(this)">'
972	% ('' if sId is None else sId)), ];
973	self._asColumnAttribs = [ 'align="center"', ];
974
975	def _getCheckBoxColumn(self, iEntry, sValue):
976	"""
977	Used by _formatListEntry implementations, returns a WuiRawHtmlBase object.
978	"""
979	_ = iEntry;
980	return WuiRawHtml('<input type="checkbox" name="%s" value="%s">'
981	% (webutils.escapeAttr(self._sCheckboxName), webutils.escapeAttr(unicode(sValue))));
982
983	def show(self, fShowNavigation=True):
984	"""
985	Displays the list.
986	Returns (Title, HTML) on success, raises exception on error.
987	"""
988	assert self._aoActions is not None;
989	assert self._sAction is not None;
990
991	sPageBody = '<script language="JavaScript">\n' \
992	'function toggle%s(oSource) {\n' \
993	' aoCheckboxes = document.getElementsByName(\'%s\');\n' \
994	' for(var i in aoCheckboxes)\n' \
995	' aoCheckboxes[i].checked = oSource.checked;\n' \
996	'}\n' \
997	'</script>\n' \
998	% ('' if self._sId is None else self._sId, self._sCheckboxName,);
999	if fShowNavigation:
1000	sPageBody += self._generateNavigation('top');
1001	if len(self._aoEntries) > 0:
1002
1003	sPageBody += '<form action="?%s" method="post" class="tmlistactionform">\n' \
1004	% (webutils.encodeUrlParams({WuiDispatcherBase.ksParamAction: self._sAction,}),);
1005	sPageBody += self._generateTable();
1006
1007	sPageBody += ' <label>Actions</label>\n' \
1008	' <select name="%s" id="%s-action-combo" class="tmlistactionform-combo">\n' \
1009	% (webutils.escapeAttr(WuiDispatcherBase.ksParamListAction), webutils.escapeAttr(self._sId),);
1010	for oValue, sText, _ in self._aoActions:
1011	sPageBody += ' <option value="%s">%s</option>\n' \
1012	% (webutils.escapeAttr(unicode(oValue)), webutils.escapeElem(sText), );
1013	sPageBody += ' </select>\n';
1014	sPageBody += ' <input type="submit"></input>\n';
1015	sPageBody += '</form>\n';
1016	if fShowNavigation:
1017	sPageBody += self._generateNavigation('bottom');
1018	else:
1019	sPageBody += '<p>No entries.</p>'
1020
1021	return (self._composeTitle(), sPageBody);
1022

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/ValidationKit/testmanager/webui/wuicontentbase.py@ 65039

Download in other formats: