Skip to content

Commit 795a214

Browse files
author
Mark Vincent
committed
Initial Commit
1 parent 4c80c82 commit 795a214

9 files changed

+373
-0
lines changed

‎README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# BB Code Helper 0.0.1
2+
3+
Adds a context submenu to tag quotes, images, and links for as BB Code to be pasted into forum posts.
4+
5+
## Selection
6+
7+
Highlight text and choose `Quote Selection` from the `BB Code Helper` context submenu to copy the text as a forum quote using BB Code
8+
9+
```
10+
[quote]selected text[/quote]
11+
```
12+
13+
## Links
14+
15+
Right click a link and select `Tag Link` from the `BB Code Helper` context submenu to copy a BB Code representation of the link to the clipboard. If there is text inside the `<a/>`, it will be used as a caption for the BB Code, if not, the simple version will be used.
16+
17+
```
18+
[url=http://www.url.com]Caption[/url]
19+
20+
OR
21+
22+
[url]http://www.url.com[/url]
23+
```
24+
25+
## Images
26+
27+
Right click an image and select `Tag Image` or `Tag Image With Link` from the `BB Code Helper` context submenu to copy a BB Code representation of the image to the clipboard.
28+
29+
```
30+
[img]{imgUrl}[/img]
31+
```
32+
33+
If tagging the image and the link (if any), the link will be wrapped in `url` BB Code.
34+
35+
```
36+
[url={linkUrl}][img]{imgUrl}[/img][/url]
37+
```
38+
39+
## Multi-Mode
40+
41+
In this mode, tags are appended to the clipboard, rather than replacing the current clipboard content (default)
42+
43+
## Clear The Clipboard
44+
45+
Added for convenience.

‎_locales/en/messages.json

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"extensionName": {
3+
"message": "BB Code Helper",
4+
"description": "Name of the extension."
5+
},
6+
7+
"extensionDescription": {
8+
"message": "Adds a context submenu to tag quotes, images, and links for as BB Code to be pasted into forum posts.",
9+
"description": "Description of the add-on."
10+
},
11+
12+
"menuItemMultiMode": {
13+
"message": "Multi-mode?",
14+
"description": "Title of context menu item that toggles multiple tags when clicked."
15+
},
16+
17+
"menuItemQuote": {
18+
"message": "Quote Selection",
19+
"description": "Title of context menu item that tags the selected text when clicked."
20+
},
21+
22+
"menuItemImageFull": {
23+
"message": "Tag Image With Link",
24+
"description": "Title of context menu item that tags both the image and its link (if any) when clicked."
25+
},
26+
27+
"menuItemImage": {
28+
"message": "Tag Image",
29+
"description": "Title of context menu item that tags an image when clicked."
30+
},
31+
32+
"menuItemLink": {
33+
"message": "Tag Link",
34+
"description": "Title of context menu item that tags a link when clicked."
35+
},
36+
37+
"menuClearClipboard": {
38+
"message": "Clear Clipboard",
39+
"description": "Title of context menu item that clears the clipboard when clicked."
40+
},
41+
42+
"errorNoSelection": {
43+
"message": "No text selected...",
44+
"description": "Error message when there is no selected text."
45+
},
46+
47+
"errorNoImage": {
48+
"message": "No image...",
49+
"description": "Error message when there is no image."
50+
},
51+
52+
"errorNoLink": {
53+
"message": "There is no link...",
54+
"description": "Error message when there is no image."
55+
},
56+
57+
"errorGeneric": {
58+
"message": "Error message: ",
59+
"description": "Generic error message."
60+
}
61+
62+
}

‎background.js

+173
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
/*
2+
* BB Code Helper
3+
* Copyright 2017 Mark Vincent
4+
* https://github.com/WildcardSearch/BB-Code-Helper
5+
*
6+
* this file contains content scripts for clipboard manipulation
7+
*/
8+
9+
browser.contextMenus.create({
10+
id: "mft-selection",
11+
title: browser.i18n.getMessage("menuItemQuote"),
12+
contexts: ["selection"],
13+
});
14+
15+
browser.contextMenus.create({
16+
id: "mft-image-full",
17+
title: browser.i18n.getMessage("menuItemImageFull"),
18+
contexts: ["image"],
19+
});
20+
21+
browser.contextMenus.create({
22+
id: "mft-image",
23+
title: browser.i18n.getMessage("menuItemImage"),
24+
contexts: ["image"],
25+
});
26+
27+
browser.contextMenus.create({
28+
id: "mft-link",
29+
title: browser.i18n.getMessage("menuItemLink"),
30+
contexts: ["link"],
31+
});
32+
33+
browser.contextMenus.create({
34+
id: "mft-clear-clipboard",
35+
title: browser.i18n.getMessage("menuClearClipboard"),
36+
contexts: ["all"],
37+
});
38+
39+
var multiMode = false;
40+
browser.contextMenus.create({
41+
id: "mft-multi-mode",
42+
title: browser.i18n.getMessage("menuItemMultiMode"),
43+
type: "checkbox",
44+
contexts: ["all"],
45+
checked: multiMode,
46+
});
47+
48+
browser.contextMenus.onClicked.addListener(onClicked);
49+
50+
/**
51+
* event handler for context menu click
52+
*
53+
* @param object
54+
* @param object
55+
* @return void
56+
*/
57+
function onClicked(info, tab) {
58+
if (["mft-selection", "mft-image-full", "mft-image", "mft-link", "mft-multi-mode", "mft-clear-clipboard"].indexOf(info.menuItemId) === -1) {
59+
return;
60+
}
61+
62+
var text = "",
63+
mmString = "false";
64+
65+
switch (info.menuItemId) {
66+
case "mft-multi-mode":
67+
multiMode = !multiMode;
68+
break;
69+
case "mft-clear-clipboard":
70+
clearClipboard(tab);
71+
return;
72+
break;
73+
case "mft-selection":
74+
if (typeof info.selectionText == "undefined" ||
75+
!info.selectionText) {
76+
return;
77+
}
78+
79+
text = "[quote]" + info.selectionText + "[/quote]";
80+
break;
81+
case "mft-image-full":
82+
if (typeof info.srcUrl === "undefined" ||
83+
!info.srcUrl) {
84+
return;
85+
}
86+
87+
if (typeof info.linkUrl !== "undefined" &&
88+
info.linkUrl) {
89+
text = "[url=" + info.linkUrl + "][img]" + info.srcUrl + "[/img][/url]";
90+
} else {
91+
text = "[img]" + info.srcUrl + "[/img]";
92+
}
93+
break;
94+
case "mft-image":
95+
if (typeof info.srcUrl == "undefined" ||
96+
!info.srcUrl) {
97+
return;
98+
}
99+
100+
text = "[img]" + info.srcUrl + "[/img]";
101+
break;
102+
case "mft-link":
103+
if (typeof info.linkUrl == "undefined" ||
104+
!info.linkUrl) {
105+
return;
106+
}
107+
108+
if (typeof info.linkText != "undefined" &&
109+
info.linkText &&
110+
info.linkText != info.linkUrl) {
111+
text = "[url=" + info.linkUrl + "]" + info.linkText + "[/url]";
112+
} else {
113+
text = "[url]" + info.linkUrl + "[/url]";
114+
}
115+
break;
116+
}
117+
118+
if (multiMode) {
119+
mmString = "true";
120+
}
121+
122+
text = text
123+
.replace(/&/g, "&amp;")
124+
.replace(/"/g, "&quot;")
125+
.replace(/'/g, "&#39;")
126+
.replace(/</g, "&lt;")
127+
.replace(/>/g, "&gt;");
128+
129+
browser.tabs.executeScript(tab.id, {
130+
code: "typeof copyTag === 'function';",
131+
}).then((results) => {
132+
if (!results ||
133+
results[0] !== true) {
134+
return browser.tabs.executeScript(tab.id, {
135+
file: "clipboard-helper.js",
136+
});
137+
}
138+
}).then(() => {
139+
return browser.tabs.executeScript(tab.id, {
140+
code: "getClipboardData();",
141+
});
142+
}).then(() => {
143+
return browser.tabs.executeScript(tab.id, {
144+
code: "copyTag(" +
145+
JSON.stringify(text) + "," +
146+
mmString + ");",
147+
});
148+
}).catch((error) => {
149+
console.error(browser.i18n.getMessage("errorGeneric") + error);
150+
});
151+
}
152+
153+
/**
154+
* @return void
155+
*/
156+
function clearClipboard(tab) {
157+
browser.tabs.executeScript(tab.id, {
158+
code: "typeof copyTag === 'function';",
159+
}).then((results) => {
160+
if (!results ||
161+
results[0] !== true) {
162+
return browser.tabs.executeScript(tab.id, {
163+
file: "clipboard-helper.js",
164+
});
165+
}
166+
}).then(() => {
167+
return browser.tabs.executeScript(tab.id, {
168+
code: "copyTag(\"\", false);",
169+
});
170+
}).catch((error) => {
171+
console.error(browser.i18n.getMessage("errorGeneric") + error);
172+
});
173+
}

‎clipboard-helper.js

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/*
2+
* BB Code Helper
3+
* Copyright 2017 Mark Vincent
4+
* https://github.com/WildcardSearch/BB-Code-Helper
5+
*
6+
* this file contains content scripts for clipboard manipulation
7+
*/
8+
9+
/**
10+
* @var string
11+
*/
12+
var clipboardText = "";
13+
14+
/**
15+
* launch a fake copy event and hijack it with our own text
16+
*
17+
* @param string
18+
* @param boolean
19+
* @return void
20+
*/
21+
function copyTag(text, append) {
22+
/**
23+
* event handler for synthetic copy event
24+
*
25+
* @param event
26+
* @return void
27+
*/
28+
function onCopy(e) {
29+
document.removeEventListener("copy", onCopy, true);
30+
e.stopImmediatePropagation();
31+
e.preventDefault();
32+
33+
// multi-mode
34+
if (append) {
35+
text = clipboardText + "\n" + text;
36+
}
37+
38+
e.clipboardData.setData("text/plain", text);
39+
e.clipboardData.setData("text/html", "");
40+
}
41+
document.addEventListener("copy", onCopy, true);
42+
document.execCommand("copy");
43+
}
44+
45+
/**
46+
* launch a fake paste event and use it to fetch the clipboard data
47+
*
48+
* @return void
49+
*/
50+
function getClipboardData() {
51+
/**
52+
* event handler for synthetic paste event
53+
*
54+
* @return void
55+
*/
56+
function onPaste(e) {
57+
document.removeEventListener("paste", onPaste, true);
58+
e.stopImmediatePropagation();
59+
60+
// set global variables to be used when copying tags
61+
clipboardText = e.clipboardData.getData("text/plain");
62+
}
63+
document.addEventListener("paste", onPaste, true);
64+
document.execCommand("paste");
65+
}

‎icons/icon-16.png

847 Bytes
Loading

‎icons/icon-32.png

2.18 KB
Loading

‎icons/icon-48.png

3.69 KB
Loading

‎icons/icon-96.png

10.5 KB
Loading

‎manifest.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"manifest_version": 2,
3+
"name": "__MSG_extensionName__",
4+
"description": "__MSG_extensionDescription__",
5+
"version": "0.0.1",
6+
"default_locale": "en",
7+
"homepage_url": "https://github.com/WildcardSearch/BB-Code-Helper",
8+
9+
"background": {
10+
"scripts": [
11+
"background.js"
12+
]
13+
},
14+
15+
"permissions": [
16+
"activeTab",
17+
"contextMenus",
18+
"clipboardRead",
19+
"clipboardWrite"
20+
],
21+
22+
"icons": {
23+
"16": "icons/icon-16.png",
24+
"32": "icons/icon-32.png",
25+
"48": "icons/icon-48.png",
26+
"96": "icons/icon-96.png"
27+
}
28+
}

0 commit comments

Comments
 (0)