/*jslint forin: true, rhino: true, onevar: false, browser: true, evil: true, laxbreak: true, undef: true, nomen: true, eqeqeq: true, bitwise: true, maxerr: 1000, immed: false, white: false, plusplus: false, regexp: false, undef: false */
// Released under the MIT/X11 license
// http://www.opensource.org/licenses/mit-license.php
"use strict";
var util = require("util");
var apiUtils = require("api-utils");
var simpleStorage = require("simple-storage");
var preferences = require("preferences-service");
var Color = require("color").Color;
var TriagedDistro = 13;
var NumberOfFrames = 7;
var bugURL = "https://bugzilla.redhat.com/show_bug.cgi?id=";
var BSTPrefNS = "bugzilla-triage.setting.";
exports.BSTPrefNS = BSTPrefNS;
// ====================================================================================
// BZPage's methods
var BZPage = function BZPage(win, config) {
var keys = "";
for (var key in config) {
keys += key + ", ";
}
console.log("config keys = " + keys);
// constants
this.SalmonPink = new Color(255, 224, 176); // RGB 255, 224, 176; HSL 36, 2,
// 85
this.ReporterColor = new Color(255, 255, 166); // RGB 255, 255, 166; HSL 60, 2,
// 83
// initialize dynamic properties
var that = this;
this.win = win;
this.doc = win.document;
this.packages = this.getInstalledPackages(config);
if ("commentStrings" in config.gJSONData) {
this.commentStrings = config.gJSONData.commentStrings;
}
if ("constantData" in config.gJSONData) {
this.constantData = config.gJSONData.constantData;
}
if ("CCmaintainer" in config.gJSONData.constantData) {
this.defBugzillaMaintainerArr = config.gJSONData.constantData.CCmaintainer;
}
if ("suspiciousComponents" in config.gJSONData.configData) {
this.suspiciousComponents = config.gJSONData.configData.suspiciousComponents;
}
if ("submitsLogging" in config.gJSONData.configData &&
config.gJSONData.configData.submitsLogging) {
this.log = config.logger;
console.log("length of this.log.store = " + this.log.getLength());
this.setUpLogging();
}
// configuration button
var additionalButtons = this.doc.querySelector("#bugzilla-body *.related_actions");
var configurationButtonUI = this.doc.createElement("li");
configurationButtonUI.innerHTML = "\u00A0-\u00A0<a href='#' id='configurationButton'>"
+ "Configuration buttons</a>";
additionalButtons.appendChild(configurationButtonUI);
this.doc.getElementById("configurationButton").addEventListener(
"click",
function(evt) {
var prfNm = BSTPrefNS+"JSONURL";
var url = preferences.get(prfNm,"");
var reply = that.win.prompt("New location of JSON configuration file",url);
if (reply) {
preferences.set(prfNm,reply.trim());
that.win.alert("For now, you should really restart Firefox!");
}
evt.stopPropagation();
evt.preventDefault();
}, false);
this.submitHandlerInstalled = false;
this.bugNo = util.getBugNo(this.doc.location.toString());
this.reporter = this.getReporter();
this.product = this.getOptionValue("product");
this.component = this.getOptionValue("component");
this.version = this.getVersion();
this.title = this.doc.getElementById("short_desc_nonedit_display").textContent;
this.CCList = this.getCCList();
// Prepare for query buttons
// element ID brElementPlace_location is later used in JSON files
// Stay with this add_comment element even if RH BZ upgrades, this seems
// to be generally much more stable (even with other bugzillas, e.g. b.gnome.org)
// then some getElementById.
var commentArea = this.doc.getElementsByName("add_comment")[0].parentNode;
if (commentArea) {
var brElementPlacer = commentArea.getElementsByTagName("br");
brElementPlacer = brElementPlacer[0];
if (brElementPlacer) {
brElementPlacer.setAttribute("id","brElementPlacer_location");
brElementPlacer.parentNode.insertBefore(this.doc.createElement("br"),
brElementPlacer);
}
} else {
console.log("Cannot find element with 'comment_status_commit' ID!");
}
this.generateButtons();
};
/**
* Get the ID of the bug.
*
* @return string
*/
BZPage.prototype.getBugId = function getBugId () {
return util.getBugNo(this.doc.location.href);
};
/**
*
*/
BZPage.prototype.getInstalledPackages = function getInstalledPackages(cfg) {
var installedPackages = {};
var enabledPackages = [];
var hostname = this.win.location.hostname;
// Collect enabled packages per hostname (plus default ones)
if (cfg.gJSONData && ("commentPackages" in cfg.gJSONData)) {
if ("enabledPackages" in cfg.gJSONData.configData) {
var epObject = cfg.gJSONData.configData.enabledPackages;
if (hostname in epObject) {
enabledPackages = enabledPackages.concat(epObject[hostname].split(/[, ]/));
}
if ("any" in epObject) {
enabledPackages = enabledPackages.concat(epObject["any"].split(/[, ]/));
}
} else {
// Default to collecting all comment packages available
enabledPackages = [];
for (var key in cfg.gJSONData.commentPackages) {
enabledPackages.push(key);
}
}
enabledPackages.forEach(function (pkg, idx, arr) {
if (pkg in cfg.gJSONData.commentPackages) {
installedPackages[pkg] = cfg.gJSONData.commentPackages[pkg];
}
});
}
return installedPackages;
};
/**
* Actual execution function
*
* @param cmdLabel String with the name of the command to be executed
* @param cmdParams Object with the appropriate parameters for the command
*/
BZPage.prototype.centralCommandDispatch = function centralCommandDispatch (cmdLabel, cmdParams) {
switch (cmdLabel) {
case "resolution":
case "product":
case "component":
case "version":
case "priority":
this.selectOption(cmdLabel, cmdParams);
break;
case "status":
this.selectOption("bug_status", cmdParams);
break;
case "platform":
this.selectOption("rep_platform", cmdParams);
break;
case "os":
this.selectOption("op_sys", cmdParams);
break;
case "severity":
this.selectOption("bug_severity", cmdParams);
break;
case "target":
this.selectOption("target_milestone", cmdParams);
break;
case "addKeyword":
this.addStuffToTextBox("keywords",cmdParams);
break;
case "removeKeyword":
this.removeStuffFromTextBox("keywords", cmdParams);
break;
case "addWhiteboard":
this.addStuffToTextBox("status_whiteboard",cmdParams);
break;
case "removeWhiteboard":
this.removeStuffFromTextBox("status_whiteboard",cmdParams);
break;
case "assignee":
this.changeAssignee(cmdParams);
break;
case "qacontact":
this.clickMouse("bz_qa_contact_edit_action");
this.doc.getElementById("qa_contact").value = cmdParams;
break;
case "url":
this.clickMouse("bz_url_edit_action");
this.doc.getElementById("bug_file_loc").value = cmdParams;
break;
// TODO dependson/blocked doesn't work. Find out why.
case "addDependsOn":
this.clickMouse("dependson_edit_action");
this.addStuffToTextBox("dependson", cmdParams);
break;
case "removeDependsOn":
this.clickMouse("dependson_edit_action");
this.removeStuffFromTextBox("dependson", cmdParams);
break;
case "addBlocks":
this.clickMouse("blocked_edit_action");
this.addStuffToTextBox("blocked", cmdParams);
break;
case "removeBlocks":
this.clickMouse("blocked_edit_action");
this.removeStuffFromTextBox("blocked", cmdParams);
break;
case "comment":
this.addStuffToTextBox("comment", cmdParams);
break;
case "commentIdx":
var commentText = this.commentStrings[cmdParams];
this.addStuffToTextBox("comment", commentText);
break;
case "setNeedinfo":
// cmdParams are actually ignored for now; we may in future
// distinguish different actors to be target of needinfo
this.setNeedinfoReporter();
break;
case "addCC":
this.addToCCList(cmdParams);
break;
// TODO flags, see also
case "commit":
if (cmdParams) {
// Directly commit the form
this.doc.forms.namedItem("changeform").submit();
}
break;
}
};
/**
* Take the ID of the package/id combination, and execute it
*
* @param String combined package + "//" + id combination
* Fetches the command object from this.installedPackages and then
* goes through all commands contained in it, and calls
* this.centralCommandDispatch to execute them.
*/
BZPage.prototype.executeCommand = function executeCommand (cmd) {
var cmdArr = cmd.split("//");
var commentObj = this.packages[cmdArr[0]][cmdArr[1]];
for (var key in commentObj) {
this.centralCommandDispatch(key,commentObj[key]);
}
};
/**
* Change assignee of the bug
*
* @param newAssignee String with the email address of new assigneeAElement
* or 'default' if the component's default assignee should be used.
* Value null clears "Reset Assignee to default for component" checkbox
* @return none
*/
BZPage.prototype.changeAssignee = function changeAssignee (newAssignee) {
var defAssigneeButton = null;
// Previous assignee should know what's going on in his bug
this.addToCCList(this.owner);
// Optional value null
if (newAssignee === null) {
this.doc.getElementById("set_default_assignee").removeAttribute(
"checked");
return ;
}
if (this.getDefaultAssignee) {
if (newAssignee === "default") {
var defAss = this.getDefaultAssignee();
if (defAss) {
newAssignee = defAss;
} else {
return ;
}
}
}
if (newAssignee) {
this.clickMouse("bz_assignee_edit_action");
this.doc.getElementById("assigned_to").value = newAssignee;
this.doc.getElementById("set_default_assignee").checked = false;
defAssigneeButton = this.doc.getElementById("setDefaultAssignee_btn");
if (defAssigneeButton) {
defAssigneeButton.style.display = "none";
}
}
};
/**
* Adds new option to the 'comment_action' scroll down box
*
* @param pkg String package name
* @param cmd String with the name of the command
* If the 'comment_action' scroll down box doesn't exist, this
* function will set up new one.
*/
BZPage.prototype.addToCommentsDropdown = function addToCommentsDropdown (pkg, cmd) {
var select = this.doc.getElementById("comment_action");
if (!select) {
var that = this;
this.doc.getElementById("comments").innerHTML +=
"<div id='make_bugzilla_comment_action'>" +
" <label for='comment_action'>Add Comment: </label>" +
" <select id='comment_action'>" +
" <option value=''>-- Select Comment from List --</option>" +
"</div>";
select = this.doc.getElementById("comment_action");
select.addEventListener("change", function () {
var value = "";
var valueElement = that.doc.getElementById("comment_action");
if (valueElement) {
value = valueElement.getAttribute("value");
} else {
return;
}
that.executeCommand(value);
}, false);
}
var opt = this.doc.createElement("option");
opt.value = pkg + "//" + cmd;
opt.textContent = this.packages[pkg][cmd].name;
select.appendChild(opt);
};
/**
* 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
*/
BZPage.prototype.createNewButton = function createNewButton (location, after, pkg, id) {
var that = this;
var cmdObj = this.packages[pkg][id];
var newId = id + "_btn";
var label = cmdObj.name;
// protection against double-firings
if (this.doc.getElementById(newId)) {
console.log("Element with id " + newId + "already exists!");
return ;
}
// creation of button might be conditional on existence of data in constantData
if ("ifExist" in cmdObj) {
if (!(cmdObj.ifExist in this.constantData)) {
return ;
}
}
var newButton = this.doc.createElement("input");
newButton.setAttribute("id", newId);
newButton.setAttribute("type", "button");
newButton.value = label;
newButton.addEventListener("click", function(evt) {
that.executeCommand(pkg + "//" + id);
}, false);
var originalLocation = this.doc.getElementById(location);
if (!originalLocation) {
console.log("location = " + location);
}
if (after) {
originalLocation.parentNode.insertBefore(newButton,
originalLocation.nextSibling);
originalLocation.parentNode.insertBefore(this.doc
.createTextNode("\u00A0"), newButton);
} else {
originalLocation.parentNode.insertBefore(newButton, originalLocation);
originalLocation.parentNode.insertBefore(this.doc
.createTextNode("\u00A0"), originalLocation);
}
};
/**
*
*/
BZPage.prototype.generateButtons = function generateButtons () {
var topRowPosition = "topRowPositionID";
var bottomRowPosition = "commit";
// create anchor for the top toolbar
var commentBox = this.doc.getElementById("comment");
var brElement = this.doc.createElement("br");
brElement.setAttribute("id",topRowPosition);
commentBox.parentNode.normalize();
commentBox.parentNode.insertBefore(brElement, commentBox);
for (var pkg in this.packages) {
for (var cmdIdx in this.packages[pkg]) {
var cmdObj = this.packages[pkg][cmdIdx];
switch (cmdObj.position) {
case "topRow":
this.createNewButton(topRowPosition, false, pkg, cmdIdx);
break;
case "bottomRow":
this.createNewButton(bottomRowPosition, false, pkg, cmdIdx);
break;
case "dropDown":
this.addToCommentsDropdown(pkg,cmdIdx);
break;
default: // [+-]ID
var firstChr = cmdObj.position.charAt(0);
var newId = cmdObj.position.substr(1);
this.createNewButton(newId, firstChr === "+", pkg, cmdIdx);
break;
}
}
}
};
/**
* Get the current email of the reporter of the bug.
*
* @return string
*/
BZPage.prototype.getReporter = function getReporter () {
var reporterElement = this.doc.
querySelector("#bz_show_bug_column_2 > table .vcard:first-of-type > a");
if (reporterElement) {
return reporterElement.textContent;
}
return "";
};
/**
* Get the current version of the Fedora release ... even if changed meanwhile
* by bug triager.
*
* @return string (integer for released Fedora, float for RHEL, rawhide)
*/
BZPage.prototype.getVersion = function getVersion () {
var verStr = this.getOptionValue("version").toLowerCase();
var verNo = 0;
if (/rawhide/.test(verStr)) {
verNo = 999;
} else {
verNo = Number(verStr);
}
return verNo;
};
BZPage.prototype.commentsWalker = function commentsWalker (fce) {
var comments = this.doc.getElementById("comments").getElementsByClassName(
"bz_comment");
Array.forEach(comments, function(item) {
fce(item);
}, this);
};
/**
* Set background color of all comments made by reporter in ReporterColor color
*
*/
BZPage.prototype.checkComments = function checkComments () {
var that = this;
this.commentsWalker(function(x) {
var email = x.getElementsByClassName("vcard")[0]
.getElementsByTagName("a")[0].textContent;
if (new RegExp(that.reporter).test(email)) {
x.style.backgroundColor = that.ReporterColor.toString();
}
});
};
BZPage.prototype.collectComments = function collectComments () {
var outStr = "";
this.commentsWalker(function(x) {
outStr += x.getElementsByTagName("pre")[0].textContent + "\n";
});
return outStr.trim();
};
/**
* Select option with given label on the <SELECT> element with given id.
*
* Also execute change HTMLEvent, so that the form behaves accordingly.
*
* @param id
* @param label
* @return none
*
*/
BZPage.prototype.selectOption = function selectOption (id, label, fireEvent) {
if (fireEvent === null) {
fireEvent = true;
}
var sel = this.doc.getElementById(id);
sel.value = label;
if (fireEvent) {
var intEvent = this.doc.createEvent("HTMLEvents");
intEvent.initEvent("change", true, true);
sel.dispatchEvent(intEvent);
}
};
/**
* Send mouse click to the specified element
*
* @param String ID of the element to send mouseclick to
* @return None
*/
BZPage.prototype.clickMouse = function clickMouse (targetID) {
var localEvent = this.doc.createEvent("MouseEvents");
localEvent.initMouseEvent("click", true, true, this.doc.defaultView, 0, 0,
0, 0, 0, false, false, false, false, 0, null);
this.doc.getElementById(targetID).dispatchEvent(localEvent);
};
/**
* 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
*/
BZPage.prototype.addStuffToTextBox = function addStuffToTextBox (id, stuff) {
var textBox = this.doc.getElementById(id);
if (textBox.tagName.toLowerCase() === "textarea") {
stuff = textBox.value ? "\n\n" + stuff : stuff;
textBox.value += stuff;
} else {
textBox.value = util.addCSVValue(textBox.value,stuff);
}
};
/**
* 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
*/
BZPage.prototype.removeStuffFromTextBox = function removeStuffFromTextBox (id, stuff) {
var changedElement = this.getElementById(id);
changedElement.value = util.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?
*/
BZPage.prototype.idContainsWord = function idContainsWord (id, str) {
var kwd = "";
try {
kwd = this.doc.getElementById(id).value;
} catch (e) {
// For those who don't have particular element at all or if it is empty
return false;
}
return (kwd.trim().indexOf(str) !== -1);
};
/**
* Check for the presence of a keyword
*
* @param str String with the keyword
* @return Boolean
*/
BZPage.prototype.hasKeyword = function hasKeyword (str) {
return (this.idContainsWord('keywords', str));
};
/**
*
*/
BZPage.prototype.getOptionValue = function getOptionValue (id) {
// Some special bugs don't have version for example
var element = this.doc.getElementById(id);
if (element) {
return element.value;
} else {
console.error("Failed to find element with id = " + id);
return "#NA";
}
};
/**
* 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]
*/
BZPage.prototype.setNeedinfoReporter = function setNeedinfoReporter () {
this.clickMouse("needinfo");
this.selectOption("needinfo_role", "reporter");
};
/**
*
*/
BZPage.prototype.getOwner = function getOwner () {
var priorityParent = this.doc.querySelector("label[for~='target_milestone']")
.parentNode.parentNode.parentNode;
var assigneeAElement = priorityParent.querySelector("tr:nth-of-type(1) a.email");
var assgineeHref = decodeURI(assigneeAElement.getAttribute("href"));
var email = assgineeHref.split(":")[1];
return email;
};
/**
* Get login of the currently logged-in user.
*
* @return String with the login name of the currently logged-in user
*/
BZPage.prototype.getLogin = function getLogin () {
var lastLIElement = this.doc.querySelector("#header ul.links li:last-of-type");
var loginArr = lastLIElement.textContent.split("\n");
var loginStr = loginArr[loginArr.length - 1].trim();
return loginStr;
};
/**
* 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
*/
BZPage.prototype.getDefaultBugzillaMaintainer = function getDefaultBugzillaMaintainer (component) {
var address = util.filterByRegexp(this.defBugzillaMaintainerArr, component);
return address;
};
/**
* 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
*/
BZPage.prototype.getAttachments = function getAttachments () {
var outAtts = [];
var atts = this.doc.getElementById("attachment_table")
.getElementsByTagName("tr");
for ( var i = 1, ii = atts.length - 1; i < ii; i++) {
outAtts.push(this.parseAttachmentLine(atts[i]));
}
return outAtts;
};
/**
* returns password from the current storage, or if there isn't
* one, then it will ask user for it.
*
* @return String with the password
*/
BZPage.prototype.getPassword = function getPassword () {
var prefName = BSTPrefNS+"BZpassword";
if (preferences.isSet(prefName)) {
return preferences.get(prefName,undefined);
} else {
var passwordText = util.getPassword();
if (passwordText) {
preferences.set(prefName, passwordText);
}
}
};
/**
*
*/
BZPage.prototype.setUpLogging = function setUpLogging () {
// Protection against double-call
if (this.doc.getElementById("generateTSButton")) {
console.log("Logging has been already set up!");
return ;
}
// For adding additional buttons to the top toolbar
var additionalButtons = this.doc.querySelector("#bugzilla-body *.related_actions");
var that = this;
// logging all submits for timesheet
if (!this.submitHandlerInstalled) {
console.log("Installing submit callback!");
this.doc.forms.namedItem("changeform").addEventListener("submit",function (evt) {
console.log("Submit callback!");
var resp = that.log.addLogRecord(that);
if (resp === null) {
console.log("Avoiding submitting!");
// TODO doesn't work ... still submitting'
evt.stopPropagation();
evt.preventDefault();
}
}, false);
this.submitHandlerInstalled = true;
}
var generateTimeSheetUI = this.doc.createElement("li");
generateTimeSheetUI.innerHTML = "\u00A0-\u00A0<a href='#' id='generateTSButton'>"
+ "Generate timesheet</a>";
additionalButtons.appendChild(generateTimeSheetUI);
this.doc.getElementById("generateTSButton").addEventListener(
"click",
function(evt) {
that.log.createBlankPage.call(that.log, "TimeSheet",
that.log.generateTimeSheet);
evt.stopPropagation();
evt.preventDefault();
}, false);
var clearLogsUI = this.doc.createElement("li");
clearLogsUI.innerHTML = "\u00A0-\u00A0<a href='#' id='clearLogs'>"
+ "Clear logs</a>";
additionalButtons.appendChild(clearLogsUI);
var clearLogAElem = this.doc.getElementById("clearLogs");
clearLogAElem.addEventListener("click", function() {
that.log.store = {};
this.style.color = that.log.EmptyLogsColor;
this.style.fontWeight = "normal";
console.log("this.store wiped out!");
}, false);
if (this.log.store.length > 0) {
clearLogAElem.style.color = this.log.FullLogsColor;
clearLogAElem.style.fontWeight = "bolder";
} else {
clearLogAElem.style.color = this.log.EmptyLogsColor;
clearLogAElem.style.fontWeight = "normal";
}
};
/**
* 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
*/
BZPage.prototype.addToCCList = function addToCCList (who) {
if (!who) {
return ;
}
if (who === "self") {
this.doc.getElementById("addselfcc").checked = true;
} else {
this.clickMouse("cc_edit_area_showhide");
if (!util.isInList(who, this.CCList)) {
this.addStuffToTextBox("newcc",who);
}
}
};
/**
* a collect a list of emails on CC list
*
* @return Array with email addresses as Strings.
*/
BZPage.prototype.getCCList = function getCCList () {
var CCListSelect = this.doc.getElementById("cc");
outCCList = [];
if (CCListSelect) {
outCCList = Array.map(CCListSelect.options, function(item) {
return item.value;
});
}
return outCCList;
};
// exports.BZPage = apiUtils.publicConstructor(BZPage);
exports.BZPage = BZPage;
