Mail Redirect Extension incompatible with Epyrus Topic is solved

[LeeBinder]

Mail Redirect "allows to redirect (a.k.a. "remail") mail messages to other recipients."

https://addons.thunderbird.net/en-US/th ... lredirect/

There and on its homepage you can also see screenshots of the XT in action. It's working fine in TB 52.9.0 and is the only Add-On of its sort for legacy/ XUL based TB.

In latest Epyrus (tested in both, the Windows and the Mac builds), no entry shows up, neither in the context menu of a message, nor in the message menu in the title bar.

I was able to get at least the menu entries in Mail Redirect v.0.10.2 and below, but there is no functionality behind it. But by means of comparing the changes from v.0.10.2 to v.0.10.3, it might hopefully be possible and restore the menu entries in the latest v.0.10.9 to begin with...

... and then in a second step, pinpoint the spot(s) in its code that's blocking it from working in Epyrus.

If you could look at it, that would be most awesome.

Thanks,
Lee

[Moonchild]

This would be up to the extension dev to have a look at, if they want to support Epyrus. The old adage: extensions extend the application, not the other way around.

[LeeBinder]

Hi Moonchild. The issue with that is that the dev isn't around anymore..

Certain Extensions have been adapted to work with Epyrus, by whoever, an XT's dev or other collaborator. Is there a manual - however brief - with steps to follow to make an incompatible TB Extension work with Epyrus?

[moonbat]

The issue with that is that the dev isn't around anymore..

How does that imply any obligation on anyone else to fix it for you? Epyrus is still under development and has a few rough edges; AFAIK it uses the same application ID as Thunderbird and should support installing extensions directly. If the extension is further broken despite that, you'll have to figure how to fix it yourself.

[LeeBinder]

Hi Moonbat. I don't mind trying to fix it myself and for that purpose was and am kindly asking where to start because right now I wouldn't know where. Obviously Epyrus does not 100% camouflage as Thunderbird in all aspects, otherwise all extensions WOULD run w/o any hick-ups, but not all do, see the Epyrus XT list.

No need to reply. I''ll see if someone else can give me a handler on where to start looking in the XT's code

[moonbat]

Install the extension in Epyrus, then observe the console for errors and look at the corresponding source files to see what's busted. Once you fix the error, you'll have to repackage the extension (making sure you don't zip up the top level directory in which its files are) and reinstall it. You can look at RealityRipple's archive of Mozilla documentation for reference.

[LeeBinder]

great, thank you, have started debugging. When I filter "redirect" in the Error Console, I only see one gFolderDisplay related error (red):

Code: Select all

JavaScript Error: "MailredirectController cannot determine isCommandEnabled state for cmd_mailredirect, because gFolderDisplay is not yet initialized"

Source file: "chrome://mailredirect/content/mailredirect.js" line: 90

isCommandEnabled@chrome://mailredirect/content/mailredirect.js:90:15
goUpdateCommand@chrome://global/content/globalOverlay.js:64:17
SetupController/<@chrome://mailredirect/content/mailredirect.js:118:7

and three warnings (blue):

Code: Select all

No chrome package registered for chrome://mailredirect-os/skin/mailredirect.css
No chrome package registered for chrome://mailredirect-os/skin/mailredirect-subjectCol.css
No chrome package registered for chrome://mailredirect-os/skin/messageHeader.css

As a matter of fact, in mailredirect.js the XT distiguishes between Thunderbird and SeaMonkey.

mailredirect.js:

// authors: Pawel Krzesniak, Ronald Wahl, Onno Ekker

"use strict";

(function() {

const THUNDERBIRD_ID = "{3550f703-e582-4d05-9a08-453d09bdfdc6}";
const SEAMONKEY_ID = "{92650c4d-4b8e-4d2a-b7eb-24ecf4f6b63a}";

const Cc = Components.classes, Ci = Components.interfaces;

window.MailredirectExtension = {

appInfo: Cc["@mozilla.org/xre/app-info;1"].
getService(Ci.nsIXULAppInfo),

isOffline: Cc["@mozilla.org/network/io-service;1"].
getService(Ci.nsIIOService).
offline,

addToForwardAs: true,
hideRedirectMenuitems: false,

OpenMailredirectComposeWindow: function()
{
var selectedURIs;
var server;
var folder;
if (typeof gFolderDisplay !== "undefined") {
selectedURIs = gFolderDisplay.selectedMessageUris;
folder = gFolderDisplay.displayedFolder;
} else {
var mailWindow = Cc["@mozilla.org/appshell/window-mediator;1"].
getService(Ci.nsIWindowMediator).getMostRecentWindow("");
selectedURIs = mailWindow.GetSelectedMessages();
folder = GetLoadedMsgFolder();
}
if (folder) {
server = folder.server;
}

var currentIdentity = {key: null};
if (server && (server.type === "imap" || server.type === "pop3")) {
currentIdentity = getIdentityForServer(server);
}

if (MailredirectExtension.appInfo.ID === THUNDERBIRD_ID) {
window.openDialog("chrome://mailredirect/content/mailredirect-compose-thunderbird.xul", "_blank",
"chrome,extrachrome,menubar,resizable,scrollbars,status,toolbar,center,dialog=no",
selectedURIs, currentIdentity.key);
} else if (MailredirectExtension.appInfo.ID === SEAMONKEY_ID) {
window.openDialog("chrome://mailredirect/content/mailredirect-compose-seamonkey.xul", "_blank",
"chrome,extrachrome,menubar,resizable,scrollbars,status,toolbar,center,dialog=no",
selectedURIs, currentIdentity.key);
}
},

MailredirectController: {
supportsCommand: function(aCommand)
{
switch(aCommand) {
case "cmd_mailredirect":
return true;
default:
return false;
}
},
isCommandEnabled: function(aCommand)
{
switch(aCommand) {
case "cmd_mailredirect":
if (!MailredirectExtension.isOffline) {
// Extra check for issue #9 (Init error in TB24 on Mac breaking the status bar)
if (gFolderDisplay) {
var windowMediator = Cc["@mozilla.org/appshell/window-mediator;1"].
getService(Ci.nsIWindowMediator);
var currWindow = windowMediator.getMostRecentWindow("");
var currWindowType = currWindow.document.documentElement.getAttribute("windowtype");
if (currWindowType === "mail:messageWindow") {
return true;
} else if (currWindowType === "mail:3pane") {
return (GetNumSelectedMessages() > 0 && !gFolderDisplay.selectedMessageIsFeed);
}
} else {
Components.utils.reportError("MailredirectController cannot determine isCommandEnabled state for cmd_mailredirect, because gFolderDisplay is not yet initialized");
}
}
return false;
default:
return false;
}
},
doCommand: function(aCommand)
{
// if the user invoked a key short cut then it is possible that we got here for a command which is
// really disabled. kick out if the command should be disabled.
if (!this.isCommandEnabled(aCommand)) {
return;
}

switch(aCommand) {
case "cmd_mailredirect":
MailredirectExtension.OpenMailredirectComposeWindow();
break;
}
}
},

SetupController: function(event)
{
setTimeout(function() {
top.controllers.appendController(MailredirectExtension.MailredirectController);
goUpdateCommand("cmd_mailredirect");
MailredirectExtension.UpdateCommand();
}, 0);
},

OfflineObserver: {
observe: function(subject, topic, state)
{
// Sanity check
if (topic !== "network:offline-status-changed") {
return;
}
MailredirectExtension.isOffline = (state === "offline");
goUpdateCommand("cmd_mailredirect");
}
},

UpdateCommand: function(event)
{
goUpdateCommand("cmd_mailredirect");
},

FillMailContextMenu: function(event)
{
MailredirectExtension.UpdateCommand(event);

var item = document.getElementById("mailContext-mailredirect");
if (item !== null) {
// don't show mail items for links/images
// and don't show mail items when there are no messages selected
item.hidden = gContextMenu.onImage || gContextMenu.onLink || (gFolderDisplay.selectedCount === 0);
}

var multiForward = document.getElementById("mailContext-multiForwardAsAttachment");
var multiRedirect = document.getElementById("mailContext-multiMailredirect");
multiRedirect.hidden = multiForward.hidden;
if (multiRedirect.hidden !== true && item !== null) {
// Only show one Redirect menuitem
item.hidden = true;
}
},

MultimessageClick: function(event)
{
if (event.button === 0) {
goDoCommand("cmd_mailredirect")
}
},

AddRedirectButtonToElement: function(el)
{
var head = el.contentDocument.getElementsByTagName("head").item(0);
var newEl = document.createElement("link");
newEl.setAttribute("rel", "stylesheet");
newEl.setAttribute("type", "text/css");
newEl.setAttribute("href", "chrome://mailredirect-os/skin/messageHeader.css");
head.appendChild(newEl);

var hdrMailredirectButton = document.getElementById("hdrMailredirectButton");
if (hdrMailredirectButton === null) {
// The CompactHeader extension can hide the hdrMailredirectButton and add a copy of
// the mailredirect-toolbarbutton button from the Mail toolbar to the msgHeaderViewDeck
hdrMailredirectButton = document.getElementById("msgHeaderViewDeck").getElementsByClassName("customize-header-toolbar-mailredirect-toolbarbutton").item(0);
}
if (hdrMailredirectButton === null) {
// Try the mail toolbar header button when the message hader redirect button is not found
hdrMailredirectButton = document.getElementById("mailredirect-toolbarbutton");
}
if (hdrMailredirectButton !== null) {
// Only create a redirect button for multimessage view if one is found on message header or toolbar
var disabled = hdrMailredirectButton.getAttribute("disabled");
var label = hdrMailredirectButton.getAttribute("label");
var image = window.getComputedStyle(hdrMailredirectButton, null).getPropertyValue("list-style-image");
var region = window.getComputedStyle(hdrMailredirectButton, null).getPropertyValue("-moz-image-region");
if (disabled && region !== "auto") {
// Calculate the right region...
// Disabled: -moz-image-region: rect(32px, 16px, 48px, 0px);
// Normal: -moz-image-region: rect(16px, 16px, 32px, 0px);
// Normal is always the rect above Disabled
let coords = region.replace("rect(", "").replace("px)", "").replace("px", "", "g").split(", ");
if (coords[0] !== "0") {
coords[0] = coords[0].toString() - coords[1].toString();
coords[2] = coords[2].toString() - coords[1].toString();
region = "rect(" + coords[0] + "px, " + coords[1] + "px, " + coords[2] + "px, " + coords[3] + "px)";
}
}
// headingwrapper was renamed to heading_wrapper in tb32 (bug 942638 patch part 5 v5)
el = el.contentDocument.getElementById("heading_wrapper") || el.contentDocument.getElementById("headingwrapper");
var parentEl = el && el.getElementsByTagName("toolbar").item(0); // header-view-toolbar
var oldEl = el && el.getElementsByTagName("toolbarbutton").item(0); // hdrArchiveButton
if (parentEl !== null && oldEl !== null) {
// Thunderbird 10+
var newEl = document.createElement("toolbarbutton");
newEl.setAttribute("id", "hdrMailredirectButton");
newEl.setAttribute("class", "toolbarbutton-1 msgHeaderView-button hdrMailredirectButton");
if (hdrMailredirectButton !== null) {
newEl.setAttribute("style", "list-style-image: " + image + "; -moz-image-region: " + region + ";");
newEl.setAttribute("label", label);
}
newEl.addEventListener("click", MailredirectExtension.MultimessageClick, false);
var insEl = parentEl.insertBefore(newEl, oldEl);
} else {
// Thunderbird 10-
var parentEl = el && el.getElementsByTagName("hbox").item(0); // buttonhbox
var oldEl = el && el.getElementsByTagName("button").item(0); // archive
if (parentEl !== null && oldEl !== null) {
var newEl = document.createElement("button");
newEl.setAttribute("id", "hdrMailredirectButton");
newEl.setAttribute("class", "toolbarbutton-1 msgHeaderView-button hdrMailredirectButton");
if (hdrMailredirectButton !== null) {
newEl.setAttribute("style", "list-style-image: " + image + "; -moz-image-region: " + region + ";");
newEl.setAttribute("label", label);
}
newEl.addEventListener("click", MailredirectExtension.MultimessageClick, false);
var insEl = parentEl.insertBefore(newEl, oldEl);
}
}
}
},

PrefObserver: {
observe: function(subject, topic, data)
{
// Sanity check
if (topic !== "nsPref:changed") {
return;
}

switch(data) {
case "addToForwardAs":
MailredirectExtension.addToForwardAs = MailredirectPrefs.getPref("extensions.mailredirect.addToForwardAs");
MailredirectExtension.UpdateForwardAsMenus();
break;
case "hideRedirectMenuitems":
MailredirectExtension.hideRedirectMenuitems = MailredirectPrefs.getPref("extensions.mailredirect.hideRedirectMenuitems");
MailredirectExtension.UpdateRedirectMenuitems();
break;
}
}
},

UpdateForwardAsMenus: function()
{
let addToForwardAs = MailredirectExtension.addToForwardAs;
let elementArray = [ "menu_forwardAsRedirect",
"button-ForwardAsRedirect",
"mailContext-forwardAsMailredirect",
"hdrForwardAsRedirectMenu",
"appmenu_forwardAsMailredirect" ];

for (var i = 0; i < elementArray.length; i++) {
var el = document.getElementById(elementArray);
if (el) {
el.collapsed = !addToForwardAs;
}
}

MailredirectExtension.UpdateRedirectMenuitems();
},

UpdateRedirectMenuitems: function()
{
let hideRedirectMenuitems = MailredirectExtension.addToForwardAs &&
MailredirectExtension.hideRedirectMenuitems;
let elementArray = [ "MailredirectMenuItem",
"mailContext-mailredirect",
"appmenu_mailredirect" ]

if (!document.getElementById("mailContext-forwardAsMenu")) {
// SeaMonkey doesn't have a Forward As context menu, so don't hide the context menu item
elementArray.splice(1, 1);
}

for (var i = 0; i < elementArray.length; i++) {
var el = document.getElementById(elementArray);
if (el) {
el.collapsed = hideRedirectMenuitems;
}
}

let submenuitem = document.getElementById("menu_forwardAsRedirect");
let menuitem = document.getElementById("MailredirectMenuItem");
if (hideRedirectMenuitems) {
submenuitem.setAttribute("key", "key_mailredirect");
if (menuitem.hasAttribute("key")) {
menuitem.removeAttribute("key");
}
} else {
if (submenuitem.hasAttribute("key")) {
submenuitem.removeAttribute("key");
}
menuitem.setAttribute("key", "key_mailredirect");
}
},

InstallListeners: function(event)
{
var el = document.getElementById("threadTree");
if (el !== null) {
el.addEventListener("select", MailredirectExtension.UpdateCommand, false);
}

el = document.getElementById("mailContext");
if (el !== null) {
el.addEventListener("popupshowing", MailredirectExtension.FillMailContextMenu, false);
}

// I've got to perform some tricks for multimessage redirect button, because it is in an iframe
el = document.getElementById("multimessage");
if (el !== null) {
MailredirectExtension.AddRedirectButtonToElement(el);
}
},

addButtonToMultimessageView: function(event)
{
if (event.target.id === "multimessage") {
MailredirectExtension.AddRedirectButtonToElement(event.target);
}
},

UninstallListeners: function(event)
{
var el = document.getElementById("threadTree");
if (el !== null) {
el.removeEventListener("select", MailredirectExtension.UpdateCommand, false);
}

el = document.getElementById("mailContext");
if (el !== null) {
el.removeEventListener("popupshowing", MailredirectExtension.FillMailContextMenu, false);
}

el = document.getElementById("multimessage");
if (el !== null) {
el = el.contentDocument.getElementById("hdrMailredirectButton");
if (el !== null) {
el.removeEventListener("click", MailredirectExtension.MultimessageClick, false);
}
}
},

AddObservers: function()
{
var observerService = Cc["@mozilla.org/observer-service;1"].
getService(Ci.nsIObserverService);
observerService.addObserver(MailredirectExtension.OfflineObserver, "network:offline-status-changed", false);

var prefService = Cc["@mozilla.org/preferences-service;1"].
getService(Ci.nsIPrefService);
window.prefBranch = prefService.getBranch("extensions.mailredirect.");
if (!("addObserver" in window.prefBranch)) {
// Only necessary prior to Gecko 13
try {
window.prefBranch = window.prefBranch.QueryInterface(Ci.nsIPrefBranch2);
} catch(ex) {
// windows doesn't know nsIPrefBranch2 interface
window.prefBranch = window.prefBranch.QueryInterface(Ci.nsIPrefBranchInternal);
}
}
window.prefBranch.addObserver("", MailredirectExtension.PrefObserver, false);

MailredirectExtension.addToForwardAs = MailredirectPrefs.getPref("extensions.mailredirect.addToForwardAs");
MailredirectExtension.hideRedirectMenuitems = MailredirectPrefs.getPref("extensions.mailredirect.hideRedirectMenuitems");
MailredirectExtension.UpdateForwardAsMenus();
},

RemoveObservers: function()
{
var observerService = Cc["@mozilla.org/observer-service;1"].
getService(Ci.nsIObserverService);
observerService.removeObserver(MailredirectExtension.OfflineObserver, "network:offline-status-changed");
window.prefBranch.removeObserver("", MailredirectExtension.PrefObserver);
}
};

window.MailredirectPrefs.init();

window.addEventListener("load", MailredirectExtension.InstallListeners, false);
window.addEventListener("load", MailredirectExtension.AddObservers, false);
window.addEventListener("load", MailredirectExtension.SetupController, false);

var appInfo = Cc["@mozilla.org/xre/app-info;1"].getService(Ci.nsIXULAppInfo);
var versionChecker = Cc["@mozilla.org/xpcom/version-comparator;1"].getService(Ci.nsIVersionComparator);
if (appInfo.ID === THUNDERBIRD_ID && versionChecker.compare(appInfo.version, "36.0") >= 0) {
window.addEventListener("DOMFrameContentLoaded", MailredirectExtension.addButtonToMultimessageView, true);
}
if (appInfo.ID === THUNDERBIRD_ID && versionChecker.compare(appInfo.version, "60.0") >= 0) {
// Starting in Thunderbird 60 add-ons aren't unpacked anymore
window.MailredirectPrefs.unpackIcon();
}

window.addEventListener("unload", MailredirectExtension.UninstallListeners, false);
window.addEventListener("unload", MailredirectExtension.RemoveObservers, false);

})();

// Override InitMessageForward from Suite because it highlights the wrong element
function InitMessageForward(aPopup)
{
var kMsgForwardAsAttachment = 0;
var forwardType = Services.prefs.getIntPref("mail.forward_message_mode");

if (forwardType != kMsgForwardAsAttachment) {
// forward inline is the first menuitem
aPopup.firstChild.setAttribute("default", "true");
aPopup.getElementsByTagName("menuitem")[1].removeAttribute("default");
} else {
// attachment is the second menuitem
aPopup.getElementsByTagName("menuitem")[1].setAttribute("default", "true");
aPopup.firstChild.removeAttribute("default");
}
}

// Override MsgForwardMessage because it also triggers forward as attachment in Suite when Redirect is chosen
function MsgForwardMessage(event)
{
var kMsgForwardAsAttachment = 0;
if (event === null || event.target.id !== "button-ForwardAsRedirect") {
var forwardType = 0;
try {
forwardType = Services.prefs.getIntPref("mail.forward_message_mode");
}
catch (ex) {}

// mail.forward_message_mode could be 1, if the user migrated from 4.x
// 1 (forward as quoted) is obsolete, so we treat is as forward inline
// since that is more like forward as quoted then forward as attachment
if (forwardType === kMsgForwardAsAttachment) {
MsgForwardAsAttachment(event);
} else {
MsgForwardAsInline(event);
}
}
}

Right now trying to figure out what the "gFolderDisplay is not yet initialized error" means. So far what I've found is:

gFolderDisplay is a variable on each main Thunderbird window, you need to find the right one first. The extension api does not run in the window context.

See the implementation of the mailTabs api for some details.

[moonbat]

There are significant differences between TB and Epyrus - you'll have to wait for the latter's creator athenian200 to help resolve the gFolderDisplay stuff. You could try sending him a private message, he's been busy and off the forums lately.

[LeeBinder]

Done! And good we've arrived at the realization that the extension is not (further) broken, but rather that in this case Epyrus requires a fix or implementation.

So we'll wait patiently and see when athenian200 can spare some coding/ debugging time for this.

[athenian200]

I am only aware of this thread because I got an e-mail notification of a PM. But yeah, honestly, I don't have the first clue what is going on with this or how you would adapt the extension to Epyrus. The differences between Epyrus and Thunderbird are mostly in the frontend code, and I haven't worked with that very much because I don't know JavaScript well.

I'm just want you to know that I'm aware of the issue and am willing to look into it. Honestly, I think the main reason I'm struggling is that I got out of the habit of logging into the forums, and this is where I really need to be in order to be reminded to work on Epyrus.

[LeeBinder]

Hi athenian200 - good to see you back, and thanks for the insights.

From what you write I conclude that for now not even you would know yet how to tackle this 'gFolderDisplay' issue, so I hope that someone with some knowledge about that shows up and chips in

[back2themoon]

I am only aware of this thread because I got an e-mail notification of a PM... ...I got out of the habit of logging into the forums, and this is where I really need to be in order to be reminded to work on Epyrus.

Subscribing to the Epyrus forum for notifications, should alert/email you for every new thread created.