aboutsummaryrefslogtreecommitdiffstats
path: root/data/lib/bugzillaDOMFunctions.js
blob: 0f7e1e088b14633cd1dd55c7c1027c18dedc5583 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
// Released under the MIT/X11 license
// http://www.opensource.org/licenses/mit-license.php
"use strict";

/**
 * Select option with given value on the <SELECT> element with given id.
 *
 * Also execute change HTMLEvent, so that the form behaves accordingly.
 *
 * @param id
 * @param label
 * @return none
 *
 */
function selectOption (id, label, fireEvent) {
  if (!fireEvent) {
    fireEvent = true;
  }
  var sel = document.getElementById(id);
  sel.value = label;
  if (fireEvent) {
    var intEvent = document.createEvent("HTMLEvents");
    intEvent.initEvent("change", true, true);
    sel.dispatchEvent(intEvent);
  }
}

function selectOptionByLabel(id, label, fireEvent) {
  if (!fireEvent) {
    fireEvent = true;
  }
  var sel = document.getElementById(id);
  var labelRE = new RegExp(label.trim());
  var ourOption = Array.filter(sel.options, function (op) {
    return op.textContent.trim() === label;
  });

  if (ourOption[0]) {
    sel.value = ourOption[0].value;
  }

  if (fireEvent) {
    var intEvent = document.createEvent("HTMLEvents");
    intEvent.initEvent("change", true, true);
    sel.dispatchEvent(intEvent);
  }
}

/**
 * Add object to the text box (comment box or status whiteboard)
 *
 * @param id
 *          String with the id of the element
 * @param stuff
 *          String/Array to be added to the comment box
 *
 * @return none
 */
function addStuffToTextBox (id, stuff) {
  var saveFocus = document.activeElement;
  var textBox = document.getElementById(id);
  if (textBox.tagName.toLowerCase() === "textarea") {
    stuff = textBox.value ? "\n\n" + stuff : stuff;
    textBox.value += stuff;
  }
  else {
    textBox.value = addCSVValue(textBox.value,stuff);
  }
  saveFocus.focus();
}

/**
 * Remove a keyword from the element if it is there
 *
 * @param id
 *          String with the id of the element
 * @param stuff
 *          String/Array with keyword(s) to be removed
 */
function removeStuffFromTextBox (id, stuff) {
  var changedElement = document.getElementById(id);
  changedElement.value = removeCSVValue(changedElement.value,stuff);
}

/**
 * generalized hasKeyword ... search in the value of the box with given id
 *
 * @param id
 *          String with ID of the element we want to check
 * @param str
 *          String to be searched for
 * @return Boolean found?
 */
function idContainsWord (id, str) {
  var kwd = "";
  try {
    kwd = document.getElementById(id).value;
  } catch (e) {
    // For those who don't have particular element at all or if it is empty
    return false;
  }
  return (isInList(str, kwd.trim().split(/[,\s]+/)));
}

/**
 * Check for the presence of a keyword
 *
 * @param str
 *          String with the keyword
 * @return Boolean
 */
function hasKeyword (str) {
  return (idContainsWord('keywords', str));
}

/**
 * Set the bug to NEEDINFO state
 *
 * Working function.
 *
 * @return none
 * @todo TODO we may extend this to general setNeedinfo function with parameter
 *       [reporter|assignee|general-email-address]
 */
function setNeedinfoReporter () {
  clickMouse("needinfo");
  selectOption("needinfo_role", "reporter");
}

/**
 *
 */
function getOwner () {
  // TODO(maemo) doesn't work on maemo
  var assigneeAElement = getOptionTableCell("bz_show_bug_column_1","Assigned To");
  return parseMailto(assigneeAElement);
}

/**
 * Return maintainer which is per default by bugzilla (which is not necessarily
 * the one who is default maintainer per component)
 *
 * @return String with the maintainer's email address
 */
function getDefaultBugzillaMaintainer (component) {
  return filterByRegexp(constantData.defBugzillaMaintainerArr, component);
}

/**
 * Generic function to add new button to the page. Actually copies new button
 * from the old one (in order to have the same look-and-feel, etc.
 *
 * @param location
 *          Object around which the new button will be added
 * @param after
 *          Boolean before or after location ?
 * @param pkg
 *          String which package to take the command from
 * @param id
 *          String which command to take
 * @return none
 */
function createNewButton (location, after, cmdObj) {
  try {
    var newId = cmdObj.name.toLowerCase().replace(/[^a-z0-9]+/,"","g") + "_btn";
  } catch (e) {
    console.error("createNewButton : e = " + e +
      "\ncreateNewButton : cmdObj.toSource() = " +
      cmdObj.toSource());
  }

  // protection against double-firings
  if (document.getElementById(newId)) {
    console.log("Element with id " + newId + " already exists!");
    return ;
  }

  var newButton = document.createElement("input");
  newButton.setAttribute("id", newId);
  newButton.setAttribute("type", "button");
  newButton.value = cmdObj.name;
  newButton.addEventListener("click", function(evt) {
    executeCommand(cmdObj);
  }, false);

  var originalLocation = document.getElementById(location);

  try {
    if (after) {
      originalLocation.parentNode.insertBefore(newButton,
          originalLocation.nextSibling);
      originalLocation.parentNode.insertBefore(document
          .createTextNode("\u00A0"), newButton);
    }
    else {
      originalLocation.parentNode.insertBefore(newButton, originalLocation);
      originalLocation.parentNode.insertBefore(document
          .createTextNode("\u00A0"), originalLocation);
    }
  } catch (e) {
    if (e instanceof TypeError) {
      console.error("cannot find originalLocation element with id " + location);
    }
    else {
      throw e;
    }
  }
}

/**
 * Get the current title of the bug
 *
 * @return string
 */
function getSummary() {
  return document.getElementById("short_desc_nonedit_display").textContent;
}

/**
 * Get the current title of the bug
 *
 * @return string
 */
function getSeverity() {
  return document.getElementById("bug_severity").value;
}

/**
 * Get the current email of the reporter of the bug.
 *
 * @return string
 */
function getReporter () {
  var reporterElement = getOptionTableCell("bz_show_bug_column_2", "Reported");
  // RH Bugzilla after upgrade to 3.6.2 moved the information to other column
  if (!reporterElement) {
    reporterElement = getOptionTableCell("bz_show_bug_column_1", "Reported", true);
  }
  // Maemo calls the label "Reporter" and it doesn't have ids on table columns
  // ... TODO(maemo)
  return parseMailto(reporterElement);
}

function getComponent() {
  var elem = document.getElementById("component");
  if (elem) {
    return elem.value;
  }
  return null;
}

function getProduct() {
  var elem = document.getElementById("product");
  if (elem) {
    return elem.value;
  }
  return null;
}

function commentsWalker (fce) {
  var comments = document.getElementById("comments").
    getElementsByClassName("bz_comment");
  Array.forEach(comments, function(item) {
    fce(item);
  });
}

/**
 * collect the list of attachments in a structured format
 *
 * @return Array of arrays, one for each attachments; each record has string
 *         name of the attachment, integer its id number, string of MIME type,
 *         integer of size in kilobytes, and the whole element itself
 */
function getAttachments () {
  var outAtts = [];
  var atts = document.getElementById("attachment_table").
      getElementsByTagName("tr");
  for ( var i = 1, ii = atts.length - 1; i < ii; i++) {
    outAtts.push(parseAttachmentLine(atts[i]));
  }
  return outAtts;
}

/**
 * Get login of the currently logged-in user.
 *
 * @return String with the login name of the currently logged-in user
 */
function getLogin () {
  var lastLIElement = document.querySelector("#header ul.links li:last-of-type");
  var loginArr = lastLIElement.textContent.split("\n");
  var loginStr = loginArr[loginArr.length - 1].trim();
  return loginStr;
}

/**
 * adds a person to the CC list, if it isn't already there
 *
 * @param who
 *          String with email address or "self" if the current user of the
 *          bugzilla should be added
 */
function addToCCList (who) {
  if (!who) {
    return ;
  }
  if (who === "self") {
    document.getElementById("addselfcc").checked = true;
  }
  else {
    clickMouse("cc_edit_area_showhide");
    if (!isInList(who, getCCList())) {
      addStuffToTextBox("newcc",who);
    }
  }
}

/**
 * a collect a list of emails on CC list
 *
 * @return Array with email addresses as Strings.
 */
function getCCList () {
  var CCListSelect = document.getElementById("cc");
  var outCCList = [];
  if (CCListSelect) {
    outCCList = Array.map(CCListSelect.options, function(item) {
      return item.value;
    });
  }
  return outCCList;
}

/**
 * remove elements from the page based on their IDs
 *
 * @param doc
 *          Document object
 * @param target
 *          Array with querySelector parameters
 * @param remove
 *          Boolean indicating whether the node should be actually removed or
 *          just hidden.
 * @return none TODO remove parameter could be replaced by function which would
 *         do actual activity.
 */
function killNodes(doc, target, remove) {
  var victimElements = [];

  target.forEach(function(x) {
    var targetNode = doc.querySelector(x);
    if (targetNode) {
      if (remove) {
        victimElements.push([x,targetNode]);
      }
      else {
        targetNode.style.display = "none";
      }
    }
  });

  var elem = {};
  // Don't run victimElements.forEach here as we are effectively
  // removing its members.
  for(var i = 0, ii = victimElements.length; i < ii; i++) {
    elem = victimElements[i];
    try {
      elem[1].parentNode.removeChild(elem[1]);
//      elem[1].style.backgroundColor = "red";
    }
    catch (e if e instanceof TypeError) {
      console.error("Cannot remove: " + elem[0]);
    }
  }
}

/**
 * Is this bug a RHEL bug?
 *
 * @return Boolean true if it is a RHEL bug
 */
function isEnterprise() {
  var result = ProfessionalProducts.some(function(elem,idx,arr) {
    return new RegExp(elem).test(getProduct());
  });
  return result;
}

/**
 * Find out whether the bug is needed an attention of bugZappers
 *
 * @return Boolean whether the bug has been triaged or not
 */
function isTriaged() {
    return hasKeyword("Triaged");
}

/**
 * Return string with the ID for the external_id SELECT for external bugzilla
 *
 * @param URLhostname
 *          String hostname of the external bugzilla
 * @return String with the string for the external_id SELECT
 */
function getBugzillaName(URLhostname, bzLabelNames) {
  var bugzillaID = "";
  if (bzLabelNames[URLhostname]) {
    bugzillaID = bzLabelNames[URLhostname];
  }
  else {
    bugzillaID = "";
  }
  return bugzillaID;
}