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