and
with a single newline 70 | text = text.replace(/<\s*br[^>]*\/?\s*>/ig, '\n'); 71 | 72 | text = text 73 | // Remove all remaining tags. 74 | .replace(/(<([^>]+)>)/ig,"") 75 | // Make sure there are never more than two 76 | // consecutive linebreaks. 77 | .replace(/\n{2,}/g,"\n\n") 78 | // Remove newlines at the beginning of the text. 79 | .replace(/^\n+/,"") 80 | // Remove newlines at the end of the text. 81 | .replace(/\n+$/,"") 82 | // Decode HTML entities. 83 | .replace(/&([^;]+);/g, decodeHtmlEntity); 84 | 85 | /* adam-p: make trailing whitespace stripping optional */ 86 | 87 | if (!extensions || !extensions['allowTrailingWhitespace']) { 88 | text = text 89 | // Trim rightmost whitespaces for all lines 90 | .replace(/([^\n\S]+)\n/g,"\n") 91 | .replace(/([^\n\S]+)$/,""); 92 | } 93 | 94 | if (extensions && extensions['postprocessing']) 95 | text = extensions['postprocessing'](text); 96 | 97 | return text; 98 | } 99 | 100 | function decodeHtmlEntity(m, n) { 101 | // Determine the character code of the entity. Range is 0 to 65535 102 | // (characters in JavaScript are Unicode, and entities can represent 103 | // Unicode characters). 104 | var code; 105 | 106 | // Try to parse as numeric entity. This is done before named entities for 107 | // speed because associative array lookup in many JavaScript implementations 108 | // is a linear search. 109 | if (n.substr(0, 1) == '#') { 110 | // Try to parse as numeric entity 111 | if (n.substr(1, 1) == 'x') { 112 | // Try to parse as hexadecimal 113 | code = parseInt(n.substr(2), 16); 114 | } else { 115 | // Try to parse as decimal 116 | code = parseInt(n.substr(1), 10); 117 | } 118 | } else { 119 | // Try to parse as named entity 120 | code = ENTITIES_MAP[n]; 121 | } 122 | 123 | // If still nothing, pass entity through 124 | return (code === undefined || code === NaN) ? 125 | '&' + n + ';' : String.fromCharCode(code); 126 | } 127 | 128 | var ENTITIES_MAP = { 129 | 'nbsp' : 160, 130 | 'iexcl' : 161, 131 | 'cent' : 162, 132 | 'pound' : 163, 133 | 'curren' : 164, 134 | 'yen' : 165, 135 | 'brvbar' : 166, 136 | 'sect' : 167, 137 | 'uml' : 168, 138 | 'copy' : 169, 139 | 'ordf' : 170, 140 | 'laquo' : 171, 141 | 'not' : 172, 142 | 'shy' : 173, 143 | 'reg' : 174, 144 | 'macr' : 175, 145 | 'deg' : 176, 146 | 'plusmn' : 177, 147 | 'sup2' : 178, 148 | 'sup3' : 179, 149 | 'acute' : 180, 150 | 'micro' : 181, 151 | 'para' : 182, 152 | 'middot' : 183, 153 | 'cedil' : 184, 154 | 'sup1' : 185, 155 | 'ordm' : 186, 156 | 'raquo' : 187, 157 | 'frac14' : 188, 158 | 'frac12' : 189, 159 | 'frac34' : 190, 160 | 'iquest' : 191, 161 | 'Agrave' : 192, 162 | 'Aacute' : 193, 163 | 'Acirc' : 194, 164 | 'Atilde' : 195, 165 | 'Auml' : 196, 166 | 'Aring' : 197, 167 | 'AElig' : 198, 168 | 'Ccedil' : 199, 169 | 'Egrave' : 200, 170 | 'Eacute' : 201, 171 | 'Ecirc' : 202, 172 | 'Euml' : 203, 173 | 'Igrave' : 204, 174 | 'Iacute' : 205, 175 | 'Icirc' : 206, 176 | 'Iuml' : 207, 177 | 'ETH' : 208, 178 | 'Ntilde' : 209, 179 | 'Ograve' : 210, 180 | 'Oacute' : 211, 181 | 'Ocirc' : 212, 182 | 'Otilde' : 213, 183 | 'Ouml' : 214, 184 | 'times' : 215, 185 | 'Oslash' : 216, 186 | 'Ugrave' : 217, 187 | 'Uacute' : 218, 188 | 'Ucirc' : 219, 189 | 'Uuml' : 220, 190 | 'Yacute' : 221, 191 | 'THORN' : 222, 192 | 'szlig' : 223, 193 | 'agrave' : 224, 194 | 'aacute' : 225, 195 | 'acirc' : 226, 196 | 'atilde' : 227, 197 | 'auml' : 228, 198 | 'aring' : 229, 199 | 'aelig' : 230, 200 | 'ccedil' : 231, 201 | 'egrave' : 232, 202 | 'eacute' : 233, 203 | 'ecirc' : 234, 204 | 'euml' : 235, 205 | 'igrave' : 236, 206 | 'iacute' : 237, 207 | 'icirc' : 238, 208 | 'iuml' : 239, 209 | 'eth' : 240, 210 | 'ntilde' : 241, 211 | 'ograve' : 242, 212 | 'oacute' : 243, 213 | 'ocirc' : 244, 214 | 'otilde' : 245, 215 | 'ouml' : 246, 216 | 'divide' : 247, 217 | 'oslash' : 248, 218 | 'ugrave' : 249, 219 | 'uacute' : 250, 220 | 'ucirc' : 251, 221 | 'uuml' : 252, 222 | 'yacute' : 253, 223 | 'thorn' : 254, 224 | 'yuml' : 255, 225 | 'quot' : 34, 226 | 'amp' : 38, 227 | 'lt' : 60, 228 | 'gt' : 62, 229 | 'OElig' : 338, 230 | 'oelig' : 339, 231 | 'Scaron' : 352, 232 | 'scaron' : 353, 233 | 'Yuml' : 376, 234 | 'circ' : 710, 235 | 'tilde' : 732, 236 | 'ensp' : 8194, 237 | 'emsp' : 8195, 238 | 'thinsp' : 8201, 239 | 'zwnj' : 8204, 240 | 'zwj' : 8205, 241 | 'lrm' : 8206, 242 | 'rlm' : 8207, 243 | 'ndash' : 8211, 244 | 'mdash' : 8212, 245 | 'lsquo' : 8216, 246 | 'rsquo' : 8217, 247 | 'sbquo' : 8218, 248 | 'ldquo' : 8220, 249 | 'rdquo' : 8221, 250 | 'bdquo' : 8222, 251 | 'dagger' : 8224, 252 | 'Dagger' : 8225, 253 | 'permil' : 8240, 254 | 'lsaquo' : 8249, 255 | 'rsaquo' : 8250, 256 | 'euro' : 8364 257 | }; 258 | 259 | var EXPORTED_SYMBOLS = ['htmlToText']; 260 | 261 | if (typeof module !== 'undefined') { 262 | module.exports = htmlToText; 263 | } else { 264 | this.htmlToText = htmlToText; 265 | this.EXPORTED_SYMBOLS = EXPORTED_SYMBOLS; 266 | } 267 | 268 | }).call(function() { 269 | return this || (typeof window !== 'undefined' ? window : global); 270 | }()); 271 | -------------------------------------------------------------------------------- /src/common/markdown-render.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright Adam Pritchard 2013 3 | * MIT License : http://adampritchard.mit-license.org/ 4 | */ 5 | 6 | /* 7 | * The function that does the basic raw-Markdown-in-HTML to rendered-HTML 8 | * conversion. 9 | * The reason we keep this function -- specifically, the function that uses our 10 | * external markdown renderer (marked.js), text-from-HTML module (jsHtmlToText.js), 11 | * and CSS -- separate is that it allows us to keep the bulk of the rendering 12 | * code (and the bulk of the code in our extension) out of the content script. 13 | * That way, we minimize the amount of code that needs to be loaded in every page. 14 | */ 15 | 16 | ;(function() { 17 | 18 | "use strict"; 19 | /*global module:false*/ 20 | 21 | /** 22 | Using the functionality provided by the functions htmlToText and markdownToHtml, 23 | render html into pretty text. 24 | @param targetDocument The document object where the action is taking place. 25 | It will be used to create elements, but those elements 26 | will not be inserted into the DOM. 27 | */ 28 | function markdownRender(userprefs, htmlToText, markdownToHtml, 29 | syntaxHighlighter, html, targetDocument, url) { 30 | var extractedText, markedOptions, keepTags, i, processed; 31 | 32 | processed = preprocessHtml(html, url); 33 | 34 | extractedText = htmlToText(processed.html, {allowTrailingWhitespace: true}); 35 | 36 | function mathify(mathcode) { 37 | return userprefs['math-value'] 38 | .replace(/\{mathcode\}/ig, mathcode) 39 | .replace(/\{urlmathcode\}/ig, encodeURIComponent(mathcode)); 40 | } 41 | 42 | markedOptions = { 43 | gfm: true, 44 | pedantic: false, 45 | sanitize: false, 46 | tables: true, 47 | smartLists: true, 48 | breaks: true, 49 | smartypants: true, 50 | langPrefix: 'language-', 51 | math: userprefs['math-enabled'] ? mathify : null, 52 | highlight: function(codeText, codeLanguage) { 53 | return highlightSyntax( 54 | targetDocument, 55 | syntaxHighlighter, 56 | codeText, 57 | codeLanguage); } 58 | }; 59 | 60 | var renderedMarkdown = markdownToHtml(extractedText, markedOptions); 61 | 62 | // Re-insert the excluded content that we removed in preprocessHtml 63 | html = postprocessHtml(renderedMarkdown, processed); 64 | 65 | return html; 66 | } 67 | 68 | /* 69 | We need to tweak the html-to-text processing to get the results we want. 70 | We also want to exclude some stuff (like reply blocks) from any processing. 71 | Returns an object that looks like this: 72 | { 73 | html: the HTML to render, 74 | exclusions: [array of { 75 | placeholder: the string added as placeholder for the excluded content 76 | content: the excluded content 77 | }] 78 | } 79 | 80 | NOTE: Maybe it would be better to do this stuff in markdown-here.js, where 81 | we have the DOM available? String-processing the HTML seems suboptimal. 82 | */ 83 | function preprocessHtml(html, url) { 84 | 85 | /* 86 | Historical note: At one time we kept lot of stuff intact: , , 87 | , -with-style-attr,
, and so on. This was nice, because
88 | it let users do some rich-edit-control formatting that would be retained
89 | when rendering.
90 | But it was a pain to get/keep working properly in Yahoo mail, and it
91 | introduced issue #18. So I tore out the feature, and now we
92 | only keep a few probably-not-problematic tags.
93 | */
94 |
95 | var preprocessInfo = { html: html, exclusions: [] };
96 |
97 | // The default behaviour for `htmlToText` is to strip out tags (and their
98 | // inner text/html) that it doesn't expect/want. But we want some tag blocks
99 | // to remain intact.
100 | preprocessInfo = excludeTagBlocks('blockquote', preprocessInfo, true);
101 |
102 | // Try to leave intact the line that Gmail adds that says:
103 | // On such-a-date, such-a-person wrote:
104 | preprocessInfo.html = preprocessInfo.html.replace(
105 | /<)((?!]*>)/ig, '$1$2$3') // a raw text node without an enclosing won't be handled properly, so add one
136 | .replace(/(<\/div>)]*><\/div>(]*>)/ig, '$1$2') // empty between other elems gets removed
137 | .replace(/]*>
<\/div>/ig, '
') //
-->
138 | .replace(/(]*>)+/ig, '
') // opening -->
(but nested just gets one
)
139 | .replace(/<\/div>/ig, '') // closing --> nothing
140 | .replace(/<(img[^>]*)>/ig, '<$1>') // ![]()
tags --> textual ![]()
tags
141 | .replace(/ /ig, ' '); // --> space
142 |
143 | return preprocessInfo;
144 |
145 | // Escape all tags between tags of type `tagName`, inclusive. Also add a
146 | // special "exclude" class to them.
147 | // If `wrapInPara` is true, `` tags will be added before and after each
148 | // tag block found.
149 | // If `ifHasAttribute` is non-null, tags will only be matched if they have
150 | // that attribute.
151 | // If `ifNotHasString` is non-null, tags that contain that string will not
152 | // be matched. Note that `ifNotHasString` will be used in a regex.
153 | // TODO: This function is pretty flawed. Wrapping block elements in paras
154 | // doesn't make much sense. And if we're going to support inline
155 | // elements, then we can't unconditionally put linebreaks around the
156 | // the wrapped elements.
157 | function excludeTagBlocks(tagName, preprocessInfo, wrapInPara, ifHasAttribute, ifNotHasString) {
158 | var depth, startIndex, openIndex, closeIndex, currentOpenIndex,
159 | openTagRegex, closeTagRegex, remainder, closeTagLength, regexFiller;
160 |
161 | regexFiller = ifNotHasString ? '(((?!'+ifNotHasString+')[^>])*)' : '[^>]*';
162 | if (ifHasAttribute) {
163 | openTagRegex = new RegExp('<'+tagName+'\\b'+regexFiller+'\\b'+ifHasAttribute+'\\b'+regexFiller+'>', 'i');
164 | }
165 | else {
166 | openTagRegex = new RegExp('<'+tagName+'\\b'+regexFiller+'>', 'i');
167 | }
168 |
169 | closeTagRegex = new RegExp('= 0 && openIndex < closeIndex)) {
185 | // Process an open tag next.
186 |
187 | // Make the index relative to the beginning of the string.
188 | openIndex += startIndex;
189 |
190 | if (depth === 0) {
191 | // Not a nested tag. Start the escape here.
192 | currentOpenIndex = openIndex;
193 | }
194 |
195 | startIndex = openIndex + 1;
196 | depth += 1;
197 | }
198 | else {
199 | // Process a close tag next.
200 |
201 | if (depth > 0) {
202 | // Make the index relative to the beginning of the string.
203 | closeIndex += startIndex;
204 |
205 | if (depth === 1) {
206 | // Not a nested tag. Time to escape.
207 | // Because we've mangled the opening and closing tags, we need to
208 | // put around them so that they don't get mashed together with the
209 | // preceeding and following Markdown.
210 |
211 | closeTagLength = ('').length;
212 |
213 | var placeholder = String(Math.random());
214 | preprocessInfo.exclusions.push({
215 | placeholder: placeholder,
216 | content:
217 | '
' +
218 | (wrapInPara ? '' : '') +
219 | preprocessInfo.html.slice(currentOpenIndex, closeIndex+closeTagLength) +
220 | (wrapInPara ? '
' : '') +
221 | ''
222 | });
223 |
224 | // We need to insert some empty lines when we extract something,
225 | // otherwise the stuff above and below would be rendered as if they
226 | // were together.
227 |
228 | preprocessInfo.html =
229 | preprocessInfo.html.slice(0, currentOpenIndex) +
230 | '
' + // three empty lines is "guaranteed" to break a Markdown block (like a bullet list)
231 | placeholder +
232 | '
' +
233 | preprocessInfo.html.slice(closeIndex+closeTagLength);
234 |
235 | // Start from the beginning again. The length of the string has
236 | // changed (so our indexes are meaningless), and we'll only find
237 | // unescaped/unprocessed tags of interest anyway.
238 | startIndex = 0;
239 | }
240 | else {
241 | startIndex = closeIndex + 1;
242 | }
243 |
244 | depth -= 1;
245 | }
246 | else {
247 | // Depth is 0. So we've found a closing tag while not in an opening
248 | // tag -- this can happen normally if `ifHasAttribute` is non-null.
249 | // Just advance the startIndex.
250 | startIndex += closeIndex + 1;
251 | }
252 | }
253 | }
254 |
255 | return preprocessInfo;
256 | }
257 |
258 | // Add the class `className` to all tags in `html`.
259 | function addClassToAllTags(className, html) {
260 | return html
261 | .replace(
262 | /<(\w+\b)(([^>]*)(class=("|')([^>]*?)\5)([^>]*))>/ig,
263 | '<$1$3class="$6 ' + className + '"$7>')
264 | .replace(
265 | /<(\w+\b)(((?!class)[^>])*)>/ig,
266 | '<$1 class="' + className + '"$2>');
267 | }
268 | }
269 |
270 | /**
271 | Converts instances of `tag` in `html` to Markdown and returns the
272 | resulting HTML.
273 | */
274 | function convertHTMLtoMarkdown(tag, html) {
275 | if (tag === 'a') {
276 | /*
277 | Make sure we do *not* convert HTML links that are inside of MD links.
278 | Otherwise we'll have problems like issue #69.
279 | We're going to use a regex that mimics a negative lookbehind. For details see: http://blog.stevenlevithan.com/archives/mimic-lookbehind-javascript
280 | Here's an attempt at an explanation of the regex:
281 | ( // begin optional prefix capture group
282 | (?:\]\([^\)]*) // match an unclosed URL portion of a MD link -- like "...](..."
283 | |(?:\[[^\]]*) // match an unclosed name portion of a MD link -- like "...[..."
284 | )? // capture group is optional so that we do the "negative" lookbehind -- that is, we can match links that are *not* preceded by the stuff we *don't* want
285 | ]*href="([^"]*)"[^>]*>(.*?)<\/a> // an HTML link
286 | Then the replace callback looks like this:
287 | return $1 ? $0 : '['+$3+']('+$2+')'
288 | So, if the first capture group is matched (i.e., $1 has value), then we've
289 | matched the bad thing -- the indication that the HTML is inside a MD link.
290 | In that case, we don't modify anything. Otherwise we use our other capture
291 | groups to create the desired MD link.
292 | */
293 | html = html.replace(
294 | /((?:\]\([^\)]*)|(?:\[[^\]]*))?]*href="([^"]*)"[^>]*>(.*?)<\/a>/ig,
295 | function($0, $1, $2, $3) {
296 | return $1 ? $0 : '['+$3+']('+$2+')';
297 | });
298 | }
299 | else {
300 | throw new Error('convertHTMLtoMarkdown: ' + tag + ' is not a supported tag');
301 | return;
302 | }
303 |
304 | return html;
305 | }
306 |
307 | // Restore the content that we extracted so that it wouldn't be processed.
308 | function postprocessHtml(renderedMarkdown, preprocessInfo) {
309 | var i;
310 | for (i = 0; i < preprocessInfo.exclusions.length; i++) {
311 | renderedMarkdown = renderedMarkdown.replace(preprocessInfo.exclusions[i].placeholder,
312 | preprocessInfo.exclusions[i].content);
313 | }
314 |
315 | return renderedMarkdown;
316 | }
317 |
318 | // Using `syntaxHighlighter`, highlight the code in `codeText` that is of
319 | // language `codeLanguage` (may be falsy).
320 | // `syntaxHighlighter` is expected to behave like (i.e., to be) highlight.js.
321 | function highlightSyntax(targetDocument, syntaxHighlighter, codeText, codeLanguage) {
322 | var codeElem, preElem, textNode;
323 |
324 | // highlight.js requires a `` element to be passed in that has a
325 | // `` parent element.
326 |
327 | preElem = targetDocument.createElement('pre');
328 | codeElem = targetDocument.createElement('code');
329 | textNode = targetDocument.createTextNode(codeText);
330 | codeElem.appendChild(textNode);
331 | preElem.appendChild(codeElem);
332 |
333 | // If we're told the language, set it as a class so that the highlighter
334 | // doesn't have to guess it. This is part of the HTML5 standard. See:
335 | // http://www.whatwg.org/specs/web-apps/current-work/multipage/text-level-semantics.html#the-code-element
336 | if (codeLanguage && codeLanguage.length > 0) {
337 | codeElem.setAttribute('class', 'language-'+codeLanguage);
338 | }
339 | else {
340 | codeElem.setAttribute('class', 'no-highlight');
341 | }
342 |
343 | syntaxHighlighter.highlightBlock(codeElem);
344 |
345 | return codeElem.innerHTML;
346 | }
347 |
348 | markdownRender._testExports = {
349 | convertHTMLtoMarkdown: convertHTMLtoMarkdown,
350 | preprocessHtml: preprocessHtml
351 | };
352 |
353 | var EXPORTED_SYMBOLS = ['markdownRender'];
354 |
355 | if (typeof module !== 'undefined') {
356 | module.exports = markdownRender;
357 | } else {
358 | this.markdownRender = markdownRender;
359 | this.EXPORTED_SYMBOLS = EXPORTED_SYMBOLS;
360 | }
361 |
362 | }).call(function() {
363 | return this || (typeof window !== 'undefined' ? window : global);
364 | }());
365 |
--------------------------------------------------------------------------------
/src/common/options-iframe.html:
--------------------------------------------------------------------------------
1 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
27 |
28 |
29 |
31 |
32 |
33 | ```javascript
34 | function syntaxHighlighting() {
35 | var n = 33;
36 | var s = "hi";
37 | console.log(s);
38 | }
39 | ```
40 |
41 | * plain
42 | * *emphasis*
43 | * **strong emphasis**
44 | * `inline code`
45 |
46 | 1. Numbered list
47 | 2. [Link](https://www.google.com)
48 |
49 |
50 | > Block quote.
51 | > *With* **some** `markdown`.
52 |
53 | If **TeX Math** support is enabled, this is the quadratic equation:
54 | $-b \pm \sqrt{b^2 - 4ac} \over 2a$
55 |
56 | # Header 1
57 | ## Header 2
58 | ### Header 3
59 | #### Header 4
60 | ##### Header 5
61 | ###### Header 6
62 |
63 | | Tables | Are | Cool |
64 | | ------------- |:-------------:| -----:|
65 | | col 3 is | right-aligned | $1600 |
66 | | col 2 is | centered | $12 |
67 | | zebra stripes | are neat | $1 |
68 |
69 | Horizontal rule
70 |
71 | ---
72 |
73 | <dl>
74 | <dt>Definition list</dt>
75 | <dd>Is something people use sometimes.</dd>
76 | </dl>
77 |
78 | ```
79 | code block
80 | with no highlighting
81 | ```
82 |
83 |
84 |
85 |
86 |
87 |
--------------------------------------------------------------------------------
/src/common/options-iframe.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | function onLoad() {
7 | // Chrome and Safari require us to manually load our content script in order
8 | // to use the button and context menu in the iframe.
9 | if (typeof(safari) !== 'undefined' || typeof(chrome) !== 'undefined') {
10 | window.LOAD_MARKDOWN_HERE_CONTENT_SCRIPT = true;
11 | var contentscript = document.createElement('script');
12 | if (typeof(safari) !== 'undefined') {
13 | contentscript.src = '../../../contentscript.js';
14 | }
15 | else if (typeof(chrome) !== 'undefined') {
16 | contentscript.src = '../chrome/contentscript.js';
17 | }
18 | document.body.appendChild(contentscript);
19 | }
20 |
21 | // The body of the iframe needs to have a (collapsed) selection range for
22 | // Markdown Here to work (simulating focus/cursor).
23 | var range = document.createRange();
24 | range.setStart(document.body, 0);
25 | var sel = document.getSelection();
26 | sel.removeAllRanges();
27 | sel.addRange(range);
28 |
29 | // Let our owner page know that we've loaded.
30 | var e = top.document.createEvent('HTMLEvents');
31 | e.initEvent('options-iframe-loaded', true, true);
32 | top.document.dispatchEvent(e);
33 | }
34 | document.addEventListener('DOMContentLoaded', onLoad, false);
35 |
--------------------------------------------------------------------------------
/src/common/test/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
8 |
9 |
10 |
11 |
12 |
13 | Markdown Here Autotests
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 |
--------------------------------------------------------------------------------
/src/common/test/markdown-render-test.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /* jshint curly:true, noempty:true, newcap:true, eqeqeq:true, eqnull:true, es5:true, undef:true, devel:true, browser:true, node:true, evil:false, latedef:false, nonew:true, trailing:false, immed:false, smarttabs:true, expr:true */
8 | /* global describe, expect, it, before, beforeEach, after, afterEach */
9 | /* global _, $, markdownRender, htmlToText, marked, hljs, Utils */
10 |
11 |
12 | describe('Markdown-Render', function() {
13 | it('should exist', function() {
14 | expect(markdownRender).to.exist;
15 | });
16 |
17 | describe('convertHTMLtoMarkdown', function() {
18 | var convertHTMLtoMarkdown = markdownRender._testExports.convertHTMLtoMarkdown;
19 |
20 | it('should throw an exception for unsupported tags', function() {
21 | expect(_.partial(convertHTMLtoMarkdown, 'badtag')).to.throw(Error);
22 | });
23 |
24 | it('should not modify the string if there is no match', function() {
25 | var s = 'aaa bbb ccc ddd eee';
26 | expect(convertHTMLtoMarkdown('a', s)).to.equal(s);
27 | });
28 |
29 | it('should replace the given tag', function() {
30 | var s, target;
31 |
32 | s = 'aaa bbb ccc ddd eee ggg hhh';
33 | target = 'aaa bbb ccc ddd eee [ggg](fff) hhh';
34 | expect(convertHTMLtoMarkdown('a', s)).to.equal(target);
35 |
36 | s = 'aaa bbb ccc ddd eee ggg hhh jjj kkk lll';
37 | target = 'aaa bbb ccc ddd eee [ggg](fff) hhh [jjj kkk](iii) lll';
38 | expect(convertHTMLtoMarkdown('a', s)).to.equal(target);
39 | });
40 | });
41 |
42 | describe('preprocessHtml', function() {
43 | var preprocessHtml = markdownRender._testExports.preprocessHtml;
44 |
45 | it ('should be okay with an empty string', function() {
46 | expect(preprocessHtml('', null).html).to.equal('');
47 | });
48 | });
49 |
50 | describe('markdownRender', function() {
51 | var userprefs = {};
52 |
53 | beforeEach(function() {
54 | userprefs = {
55 | 'math-value': null,
56 | 'math-enabled': false
57 | };
58 | });
59 |
60 | it('should be okay with an empty string', function() {
61 | expect(markdownRender(userprefs, htmlToText, marked, hljs, '', document, null)).to.equal('');
62 | });
63 |
64 | // Busted due to https://github.com/adam-p/markdown-here/issues/51, which
65 | // is busted due to https://github.com/chjj/marked/issues/56
66 | it('should NOT correctly handle links with URL text (busted due to issue #51)', function() {
67 | var s = '[http://example1.com](http://example2.com)';
68 |
69 | // Real target
70 | //var target = 'http://example1.com';
72 | expect(markdownRender(userprefs, htmlToText, marked, hljs, s, document, null)).to.contain(target);
73 | });
74 |
75 | it('should NOT quite correctly handle pre-formatted links with URL text (busted due to issue #51)', function() {
76 | var s = 'http://example2.com';
77 |
78 | // Real target
79 | //var target = 'http://example2.com';
81 | expect(markdownRender(userprefs, htmlToText, marked, hljs, s, document, null)).to.contain(target);
82 | });
83 |
84 | it('should retain pre-formatted links', function() {
85 | var s = 'aaa';
86 | expect(markdownRender(userprefs, htmlToText, marked, hljs, s, document, null)).to.contain(s);
87 | });
88 |
89 | // Test that issue #69 hasn't come back: https://github.com/adam-p/markdown-here/issues/69
90 | it('should properly render MD links that contain pre-formatted HTML links', function() {
91 | var md = '[aaa](ccc)';
92 | var html = '';
93 |
94 | var tests = [], i;
95 |
96 | // NOTE: The expected results are affected by other content massaging,
97 | // such as adding missing links schemas.
98 |
99 | // Begin tests where the link should be converted
100 |
101 | tests.push(['asdf bbb asdf',
102 | 'asdf bbb asdf
\n']);
103 |
104 | tests.push(['bbb',
105 | '\n']);
106 |
107 | tests.push(['[xxx](yyy) bbb',
108 | '\n']);
109 |
110 | tests.push(['asdf (bbb)',
111 | 'asdf (bbb)
\n']);
112 |
113 | // Begin tests where the link should *not* be converted
114 |
115 | tests.push(['asdf [yyy](bbb) asdf',
116 | 'asdf yyy asdf
\n']);
117 |
118 | tests.push(['asdf [bbb](ccc) asdf',
119 | 'asdf bbb asdf
\n']);
120 |
121 | tests.push(['[yyy](bbb)',
122 | '\n']);
123 |
124 | tests.push(['[yyy]( bbb)',
125 | '\n']);
126 |
127 | tests.push(['asdf [qwer bbb](ccc) asdf',
128 | 'asdf qwer bbb asdf
\n']);
129 |
130 | // Begin mixed tests
131 |
132 | tests.push(['asdf [aaa](bbb) asdf bbb asdf [yyy](bbb) asdf',
133 | 'asdf aaa asdf bbb asdf yyy asdf
\n']);
134 |
135 | // Begin tests that don't work quite right
136 |
137 | tests.push(['asdf [bbb] asdf',
138 | 'asdf [bbb] asdf
\n']);
139 |
140 | tests.push(['asdf ](bbb) asdf',
141 | 'asdf ](bbb) asdf
\n']);
142 |
143 | for (i = 0; i < tests.length; i++) {
144 | expect(markdownRender(userprefs, htmlToText, marked, hljs, tests[i][0], document, null)).to.equal(tests[i][1]);
145 | }
146 | });
147 |
148 | // Test issue #57: https://github.com/adam-p/markdown-here/issues/57
149 | it('should add the schema to links missing it', function() {
150 | var md = 'asdf [aaa](bbb) asdf [ccc](ftp://ddd) asdf';
151 | var target = '\n';
152 | expect(markdownRender(userprefs, htmlToText, marked, hljs, md, document, null)).to.equal(target);
153 | });
154 |
155 | it('should *not* add the schema to anchor links', function() {
156 | var md = 'asdf [aaa](#bbb) asdf [ccc](ftp://ddd) asdf';
157 | var target = '\n';
158 | expect(markdownRender(userprefs, htmlToText, marked, hljs, md, document, null)).to.equal(target);
159 | });
160 |
161 | });
162 |
163 | });
164 |
--------------------------------------------------------------------------------
/src/common/test/mocha.css:
--------------------------------------------------------------------------------
1 | @charset "utf-8";
2 |
3 | body {
4 | font: 20px/1.5 "Helvetica Neue", Helvetica, Arial, sans-serif;
5 | padding: 60px 50px;
6 | }
7 |
8 | #mocha ul, #mocha li {
9 | margin: 0;
10 | padding: 0;
11 | }
12 |
13 | #mocha ul {
14 | list-style: none;
15 | }
16 |
17 | #mocha h1, #mocha h2 {
18 | margin: 0;
19 | }
20 |
21 | #mocha h1 {
22 | margin-top: 15px;
23 | font-size: 1em;
24 | font-weight: 200;
25 | }
26 |
27 | #mocha h1 a {
28 | text-decoration: none;
29 | color: inherit;
30 | }
31 |
32 | #mocha h1 a:hover {
33 | text-decoration: underline;
34 | }
35 |
36 | #mocha .suite .suite h1 {
37 | margin-top: 0;
38 | font-size: .8em;
39 | }
40 |
41 | .hidden {
42 | display: none;
43 | }
44 |
45 | #mocha h2 {
46 | font-size: 12px;
47 | font-weight: normal;
48 | cursor: pointer;
49 | }
50 |
51 | #mocha .suite {
52 | margin-left: 15px;
53 | }
54 |
55 | #mocha .test {
56 | margin-left: 15px;
57 | overflow: hidden;
58 | }
59 |
60 | #mocha .test.pending:hover h2::after {
61 | content: '(pending)';
62 | font-family: arial;
63 | }
64 |
65 | #mocha .test.pass.medium .duration {
66 | background: #C09853;
67 | }
68 |
69 | #mocha .test.pass.slow .duration {
70 | background: #B94A48;
71 | }
72 |
73 | #mocha .test.pass::before {
74 | content: '✓';
75 | font-size: 12px;
76 | display: block;
77 | float: left;
78 | margin-right: 5px;
79 | color: #00d6b2;
80 | }
81 |
82 | #mocha .test.pass .duration {
83 | font-size: 9px;
84 | margin-left: 5px;
85 | padding: 2px 5px;
86 | color: white;
87 | -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.2);
88 | -moz-box-shadow: inset 0 1px 1px rgba(0,0,0,.2);
89 | box-shadow: inset 0 1px 1px rgba(0,0,0,.2);
90 | -webkit-border-radius: 5px;
91 | -moz-border-radius: 5px;
92 | -ms-border-radius: 5px;
93 | -o-border-radius: 5px;
94 | border-radius: 5px;
95 | }
96 |
97 | #mocha .test.pass.fast .duration {
98 | display: none;
99 | }
100 |
101 | #mocha .test.pending {
102 | color: #0b97c4;
103 | }
104 |
105 | #mocha .test.pending::before {
106 | content: '◦';
107 | color: #0b97c4;
108 | }
109 |
110 | #mocha .test.fail {
111 | color: #c00;
112 | }
113 |
114 | #mocha .test.fail pre {
115 | color: black;
116 | }
117 |
118 | #mocha .test.fail::before {
119 | content: '✖';
120 | font-size: 12px;
121 | display: block;
122 | float: left;
123 | margin-right: 5px;
124 | color: #c00;
125 | }
126 |
127 | #mocha .test pre.error {
128 | color: #c00;
129 | max-height: 300px;
130 | overflow: auto;
131 | }
132 |
133 | #mocha .test pre {
134 | display: block;
135 | float: left;
136 | clear: left;
137 | font: 12px/1.5 monaco, monospace;
138 | margin: 5px;
139 | padding: 15px;
140 | border: 1px solid #eee;
141 | border-bottom-color: #ddd;
142 | -webkit-border-radius: 3px;
143 | -webkit-box-shadow: 0 1px 3px #eee;
144 | -moz-border-radius: 3px;
145 | -moz-box-shadow: 0 1px 3px #eee;
146 | }
147 |
148 | #mocha .test h2 {
149 | position: relative;
150 | }
151 |
152 | #mocha .test a.replay {
153 | position: absolute;
154 | top: 3px;
155 | right: 0;
156 | text-decoration: none;
157 | vertical-align: middle;
158 | display: block;
159 | width: 15px;
160 | height: 15px;
161 | line-height: 15px;
162 | text-align: center;
163 | background: #eee;
164 | font-size: 15px;
165 | -moz-border-radius: 15px;
166 | border-radius: 15px;
167 | -webkit-transition: opacity 200ms;
168 | -moz-transition: opacity 200ms;
169 | transition: opacity 200ms;
170 | opacity: 0.3;
171 | color: #888;
172 | }
173 |
174 | #mocha .test:hover a.replay {
175 | opacity: 1;
176 | }
177 |
178 | #mocha-report.pass .test.fail {
179 | display: none;
180 | }
181 |
182 | #mocha-report.fail .test.pass {
183 | display: none;
184 | }
185 |
186 | #mocha-error {
187 | color: #c00;
188 | font-size: 1.5 em;
189 | font-weight: 100;
190 | letter-spacing: 1px;
191 | }
192 |
193 | #mocha-stats {
194 | position: fixed;
195 | top: 15px;
196 | right: 10px;
197 | font-size: 12px;
198 | margin: 0;
199 | color: #888;
200 | }
201 |
202 | #mocha-stats .progress {
203 | float: right;
204 | padding-top: 0;
205 | }
206 |
207 | #mocha-stats em {
208 | color: black;
209 | }
210 |
211 | #mocha-stats a {
212 | text-decoration: none;
213 | color: inherit;
214 | }
215 |
216 | #mocha-stats a:hover {
217 | border-bottom: 1px solid #eee;
218 | }
219 |
220 | #mocha-stats li {
221 | display: inline-block;
222 | margin: 0 5px;
223 | list-style: none;
224 | padding-top: 11px;
225 | }
226 |
227 | code .comment { color: #ddd }
228 | code .init { color: #2F6FAD }
229 | code .string { color: #5890AD }
230 | code .keyword { color: #8A6343 }
231 | code .number { color: #2F6FAD }
232 |
--------------------------------------------------------------------------------
/src/common/test/options-store-test.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /* jshint curly:true, noempty:true, newcap:true, eqeqeq:true, eqnull:true, es5:true, undef:true, devel:true, browser:true, node:true, evil:false, latedef:false, nonew:true, trailing:false, immed:false, smarttabs:true, expr:true */
8 | /* global describe, expect, it, before, beforeEach, after, afterEach */
9 | /* global _, $, markdownRender, htmlToText, marked, hljs, Utils, OptionsStore */
10 |
11 |
12 | describe('OptionsStore', function() {
13 | it('should exist', function() {
14 | expect(OptionsStore).to.exist;
15 | });
16 |
17 | var testKeys = ['test-option-a', 'test-option-b'];
18 |
19 | beforeEach(function(done) {
20 | OptionsStore.remove(testKeys, function() {
21 | done();
22 | });
23 | });
24 |
25 | after(function(done) {
26 | OptionsStore.remove(testKeys, function() {
27 | done();
28 | });
29 | });
30 |
31 | it('should call callback after getting', function(done) {
32 | OptionsStore.get(function() {
33 | done();
34 | });
35 | });
36 |
37 | it('should call callback after setting', function(done) {
38 | OptionsStore.set({}, function() {
39 | done();
40 | });
41 | });
42 |
43 | it('should call callback after removing', function(done) {
44 | OptionsStore.remove([], function() {
45 | done();
46 | });
47 | });
48 |
49 | it('should set and get null values', function(done) {
50 | OptionsStore.get(function(options) {
51 | expect(options).to.not.have.property(testKeys[0]);
52 |
53 | var obj = {};
54 | obj[testKeys[0]] = null;
55 |
56 | OptionsStore.set(obj, function() {
57 | OptionsStore.get(function(newOptions) {
58 | expect(newOptions).to.have.property(testKeys[0]);
59 | expect(newOptions[testKeys[0]]).to.be.null;
60 | done();
61 | });
62 | });
63 | });
64 | });
65 |
66 | it('should set and get long values', function(done) {
67 | var longString = (new Array(10*1024)).join('x');
68 |
69 | var obj = {};
70 | obj[testKeys[0]] = longString;
71 |
72 | OptionsStore.set(obj, function() {
73 | OptionsStore.get(function(newOptions) {
74 | expect(newOptions).to.have.property(testKeys[0]);
75 | expect(newOptions[testKeys[0]]).to.equal(longString);
76 | done();
77 | });
78 | });
79 | });
80 |
81 | it('should set and get objects', function(done) {
82 | OptionsStore.get(function(options) {
83 | expect(options).to.not.have.property(testKeys[0]);
84 |
85 | var obj = {};
86 | obj[testKeys[0]] = {
87 | 'aaa': 111,
88 | 'bbb': 'zzz',
89 | 'ccc': ['q', 'w', 3, 4],
90 | 'ddd': {'mmm': 'nnn'}
91 | };
92 |
93 | OptionsStore.set(obj, function() {
94 | OptionsStore.get(function(newOptions) {
95 | expect(newOptions).to.have.property(testKeys[0]);
96 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
97 | done();
98 | });
99 | });
100 | });
101 | });
102 |
103 | it('should set and get arrays', function(done) {
104 | OptionsStore.get(function(options) {
105 | expect(options).to.not.have.property(testKeys[0]);
106 |
107 | var obj = {};
108 | obj[testKeys[0]] = [1, 2, 'a', 'b', {'aa': 11}, ['q', 6]];
109 |
110 | OptionsStore.set(obj, function() {
111 | OptionsStore.get(function(newOptions) {
112 | expect(newOptions).to.have.property(testKeys[0]);
113 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
114 | expect(Array.isArray(newOptions[testKeys[0]])).to.be.true;
115 | expect(newOptions[testKeys[0]]).to.have.property('length');
116 |
117 | done();
118 | });
119 | });
120 | });
121 | });
122 |
123 | it('should remove entries', function(done) {
124 | OptionsStore.get(function(options) {
125 | expect(options).to.not.have.property(testKeys[0]);
126 |
127 | var obj = {};
128 | obj[testKeys[0]] = 'hi';
129 |
130 | OptionsStore.set(obj, function() {
131 | OptionsStore.get(function(newOptions) {
132 | expect(newOptions).to.have.property(testKeys[0]);
133 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
134 |
135 | OptionsStore.remove(testKeys[0], function() {
136 | OptionsStore.get(function(newOptions) {
137 | expect(options).to.not.have.property(testKeys[0]);
138 | done();
139 | });
140 | });
141 | });
142 | });
143 | });
144 | });
145 |
146 | it('should set and get multiple values', function(done) {
147 | OptionsStore.get(function(options) {
148 | expect(options).to.not.have.property(testKeys[0]);
149 |
150 | var obj = {};
151 | obj[testKeys[0]] = 'value the first';
152 | obj[testKeys[1]] = ['value the second'];
153 |
154 | OptionsStore.set(obj, function() {
155 | OptionsStore.get(function(newOptions) {
156 | expect(newOptions).to.have.property(testKeys[0]);
157 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
158 | expect(newOptions).to.have.property(testKeys[1]);
159 | expect(newOptions[testKeys[1]]).to.eql(obj[testKeys[1]]);
160 | done();
161 | });
162 | });
163 | });
164 | });
165 |
166 | describe('default value behaviour', function() {
167 | beforeEach(function() {
168 | delete OptionsStore.defaults[testKeys[0]];
169 | });
170 |
171 | after(function() {
172 | delete OptionsStore.defaults[testKeys[0]];
173 | });
174 |
175 | it('should not fill in defaults if there is not a default', function(done) {
176 | OptionsStore.get(function(options) {
177 | expect(options).to.not.have.property(testKeys[0]);
178 |
179 | done();
180 | });
181 | });
182 |
183 | it('should fill in defaults', function(done) {
184 | OptionsStore.get(function(options) {
185 | expect(options).to.not.have.property(testKeys[0]);
186 |
187 | // Set the default value (still pretty hacky)
188 | OptionsStore.defaults[testKeys[0]] = 'my default value';
189 |
190 | // Make sure we get the default value now
191 | OptionsStore.get(function(options) {
192 | expect(options).to.have.property(testKeys[0]);
193 | expect(options[testKeys[0]]).to.eql('my default value');
194 |
195 | done();
196 | });
197 | });
198 | });
199 |
200 | it('should not fill in default if value is set', function(done) {
201 | OptionsStore.get(function(options) {
202 | expect(options).to.not.have.property(testKeys[0]);
203 |
204 | // Set the default value (still pretty hacky)
205 | OptionsStore.defaults[testKeys[0]] = 'my default value';
206 |
207 | var obj = {};
208 | obj[testKeys[0]] = 'my non-default value';
209 |
210 | // But also set the value in the options
211 | OptionsStore.set(obj, function() {
212 | // Make sure we do *not* get the default value now
213 | OptionsStore.get(function(options) {
214 | expect(options).to.have.property(testKeys[0]);
215 | expect(options[testKeys[0]]).to.eql('my non-default value');
216 |
217 | done();
218 | });
219 | });
220 | });
221 | });
222 |
223 | it('should fill in default values from files', function(done) {
224 | OptionsStore.get(function(options) {
225 | expect(options).to.not.have.property(testKeys[0]);
226 |
227 | // Set a default value that requires a XHR
228 | OptionsStore.defaults[testKeys[0]] = {'__defaultFromFile__': window.location.href};
229 |
230 | // Note: Using $.ajax won't work because for local requests Firefox sets
231 | // status to 0 even on success. jQuery interprets this as an error.
232 | var xhr = new XMLHttpRequest();
233 | xhr.open('GET', window.location.href);
234 | // If we don't set the mimetype, Firefox will complain.
235 | xhr.overrideMimeType('text/plain');
236 | xhr.onreadystatechange = function() {
237 | if (this.readyState === this.DONE) {
238 | OptionsStore.get(function(options) {
239 | expect(options).to.have.property(testKeys[0]);
240 | expect(options[testKeys[0]]).to.eql(xhr.responseText);
241 | done();
242 | });
243 | }
244 | };
245 | xhr.send();
246 | });
247 | });
248 |
249 | });
250 |
251 | });
252 |
--------------------------------------------------------------------------------
/src/common/test/test-prep.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | mocha.setup('bdd');
7 | var expect = chai.expect;
--------------------------------------------------------------------------------
/src/common/test/test-run.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | $(function(){
7 | mocha
8 | // I'm not sure what introduces the global "schemaTypes", but it's not
9 | // Markdown Here and it causes an error on one of my Chrome instances.
10 | .globals([ 'schemaTypes' ]) // acceptable globals
11 | .run();
12 | });
13 |
--------------------------------------------------------------------------------
/src/common/test/utils-test.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /* jshint curly:true, noempty:true, newcap:true, eqeqeq:true, eqnull:true, es5:true, undef:true, devel:true, browser:true, node:true, evil:false, latedef:false, nonew:true, trailing:false, immed:false, smarttabs:true, expr:true */
8 | /* global describe, expect, it, before, beforeEach, after, afterEach */
9 | /* global _, $, markdownRender, htmlToText, marked, hljs, Utils */
10 |
11 |
12 | // This function wraps `htmlString` in a `` to make life easier for us.
13 | // It should affect the testing behaviour, though -- good/bad elements in a
14 | // `` are still good/bad.
15 | function createDocFrag(htmlString) {
16 | var docFrag = document.createDocumentFragment();
17 | var elem = document.createElement('div');
18 | elem.innerHTML = htmlString;
19 | docFrag.appendChild(elem);
20 | return docFrag;
21 | }
22 |
23 |
24 | describe('Utils', function() {
25 | it('should exist', function() {
26 | expect(Utils).to.exist;
27 | });
28 |
29 | describe('sanitizeDocumentFragment', function() {
30 | it('should not alter safe doc-frags', function() {
31 | var origFrag = createDocFrag('hi');
32 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
33 | expect(origFrag.isEqualNode(sanFrag)).to.be.true;
34 | });
35 |
36 | it('should remove there');
38 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
39 | expect(origFrag.isEqualNode(sanFrag)).to.be.false;
40 |
41 | var cleanFrag = createDocFrag('hithere');
42 | expect(cleanFrag.isEqualNode(sanFrag)).to.be.true;
43 | });
44 |
45 | it('should not remove safe attributes', function() {
46 | var origFrag = createDocFrag('hi');
47 | // Make sure the attributes are sticking in the original
48 | expect(origFrag.querySelector('#rad').style.color).to.equal('red');
49 |
50 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
51 | expect(origFrag.isEqualNode(sanFrag)).to.be.true;
52 | });
53 |
54 | it('should remove event handler attributes', function() {
55 | var origFrag = createDocFrag('hi');
56 | // Make sure the attributes are sticking in the original
57 | expect(origFrag.querySelector('#rad').attributes.onclick).to.exist;
58 |
59 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
60 | expect(origFrag.isEqualNode(sanFrag)).to.be.false;
61 |
62 | var cleanFrag = createDocFrag('hi');
63 | expect(cleanFrag.isEqualNode(sanFrag)).to.be.true;
64 | });
65 | });
66 |
67 | describe('saferSetInnerHTML', function() {
68 | it('should set safe HTML without alteration', function() {
69 | var testElem = document.createElement('div');
70 | Utils.saferSetInnerHTML(testElem, 'hi
');
71 |
72 | var checkElem = document.createElement('div');
73 | checkElem.innerHTML = 'hi
';
74 |
75 | expect(testElem.isEqualNode(checkElem)).to.be.true;
76 | });
77 |
78 | it('should remove there');
81 |
82 | var checkElem = document.createElement('div');
83 | checkElem.innerHTML = 'hithere';
84 |
85 | expect(testElem.isEqualNode(checkElem)).to.be.false;
86 |
87 | var safeElem = document.createElement('div');
88 | safeElem.innerHTML = 'hithere';
89 |
90 | expect(testElem.isEqualNode(safeElem)).to.be.true;
91 | });
92 |
93 | it('should not remove safe attributes', function() {
94 | var testElem = document.createElement('div');
95 | Utils.saferSetInnerHTML(testElem, 'hi');
96 |
97 | var checkElem = document.createElement('div');
98 | checkElem.innerHTML = 'hi';
99 |
100 | expect(testElem.isEqualNode(checkElem)).to.be.true;
101 |
102 | expect(testElem.querySelector('#rad').style.color).to.equal('red');
103 | });
104 |
105 | it('should remove event handler attributes', function() {
106 | var testElem = document.createElement('div');
107 | Utils.saferSetInnerHTML(testElem, 'hi');
108 |
109 | var checkElem = document.createElement('div');
110 | checkElem.innerHTML = 'hi';
111 |
112 | expect(testElem.isEqualNode(checkElem)).to.be.true;
113 |
114 | expect(testElem.querySelector('#rad').style.color).to.equal('red');
115 | expect(testElem.querySelector('#rad').attributes.onclick).to.not.exist;
116 | });
117 |
118 | });
119 |
120 | describe('saferSetOuterHTML', function() {
121 | beforeEach(function() {
122 | // Our test container element, which will not be modified
123 | $('body').append($(''));
124 | });
125 |
126 | afterEach(function() {
127 | $('#test-container').remove();
128 | });
129 |
130 | it('should throw exception if element not in DOM', function() {
131 | var testElem = $('bye').get(0);
132 |
133 | var fn = _.partial(Utils.saferSetOuterHTML, '');
134 |
135 | expect(fn).to.throw(Error);
136 | });
137 |
138 | it('should set safe HTML without alteration', function() {
139 | Utils.saferSetOuterHTML($('#test-container').children(':first').get(0), 'hi
');
140 |
141 | expect($('#test-container').html()).to.equal('hi
');
142 | });
143 |
144 | it('should remove there');
146 |
147 | expect($('#test-container').html()).to.equal('hithere');
148 | });
149 |
150 | it('should not remove safe attributes', function() {
151 | Utils.saferSetOuterHTML($('#test-container').children(':first').get(0), 'hi');
152 |
153 | expect($('#test-container').html()).to.equal('hi');
154 | });
155 |
156 | it('should remove event handler attributes', function() {
157 | Utils.saferSetOuterHTML($('#test-container').children(':first').get(0), 'hi');
158 |
159 | expect($('#test-container').html()).to.equal('hi');
160 | });
161 |
162 | });
163 |
164 | });
--------------------------------------------------------------------------------
/src/common/utils.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | /*
7 | * Utilitiles and helpers that are needed in multiple places.
8 | */
9 |
10 | ;(function() {
11 |
12 | "use strict";
13 | /*global module:false*/
14 |
15 |
16 | // Assigning a string directly to `element.innerHTML` is potentially dangerous:
17 | // e.g., the string can contain harmful script elements. (Additionally, Mozilla
18 | // won't let us pass validation with `innerHTML` assignments in place.)
19 | // This function provides a safer way to append a HTML string into an element.
20 | function saferSetInnerHTML(parentElem, htmlString) {
21 | // Jump through some hoops to avoid using innerHTML...
22 |
23 | var range = parentElem.ownerDocument.createRange();
24 | range.selectNodeContents(parentElem);
25 |
26 | var docFrag = range.createContextualFragment(htmlString);
27 | docFrag = sanitizeDocumentFragment(docFrag);
28 |
29 | range.deleteContents();
30 | range.insertNode(docFrag);
31 | range.detach();
32 | };
33 |
34 |
35 | // Approximating equivalent to assigning to `outerHTML` -- completely replaces
36 | // the target element with `htmlString`.
37 | // Note that some caveats apply that also apply to `outerHTML`:
38 | // - The element must be in the DOM. Otherwise an exception will be thrown.
39 | // - The original element has been removed from the DOM, but continues to exist.
40 | // Any references to it (such as the one passed into this function) will be
41 | // references to the original.
42 | function saferSetOuterHTML(elem, htmlString) {
43 | if (!isElementinDocument(elem)) {
44 | throw new Error('Element must be in document');
45 | return;
46 | }
47 |
48 | var range = elem.ownerDocument.createRange();
49 | range.selectNode(elem);
50 |
51 | var docFrag = range.createContextualFragment(htmlString);
52 | docFrag = sanitizeDocumentFragment(docFrag);
53 |
54 | range.deleteContents();
55 | range.insertNode(docFrag);
56 | range.detach();
57 | };
58 |
59 |
60 | // Removes potentially harmful elements and attributes from `docFrag`.
61 | // Returns a santized copy.
62 | function sanitizeDocumentFragment(docFrag) {
63 | var i;
64 |
65 | // Don't modify the original
66 | docFrag = docFrag.cloneNode(true);
67 |
68 | var scriptTagElems = docFrag.querySelectorAll('script');
69 | for (i = 0; i < scriptTagElems.length; i++) {
70 | scriptTagElems[i].parentNode.removeChild(scriptTagElems[i]);
71 | }
72 |
73 | function cleanAttributes(node) {
74 | var i;
75 |
76 | if (typeof(node.removeAttribute) === 'undefined') {
77 | // We can't operate on this node
78 | return;
79 | }
80 |
81 | // Remove event handler attributes
82 | for (i = node.attributes.length-1; i >= 0; i--) {
83 | if (node.attributes[i].name.match(/^on/)) {
84 | node.removeAttribute(node.attributes[i].name);
85 | }
86 | }
87 | }
88 |
89 | walkDOM(docFrag.firstChild, cleanAttributes);
90 |
91 | return docFrag;
92 | }
93 |
94 |
95 | // Walk the DOM, executing `func` on each element.
96 | // From Crockform.
97 | function walkDOM(node, func) {
98 | func(node);
99 | node = node.firstChild;
100 | while(node) {
101 | walkDOM(node, func);
102 | node = node.nextSibling;
103 | }
104 | }
105 |
106 |
107 | function isElementinDocument(element) {
108 | var doc = element.ownerDocument;
109 | while (element = element.parentNode) {
110 | if (element === doc) {
111 | return true;
112 | }
113 | }
114 | return false;
115 | }
116 |
117 |
118 | // Expose these functions
119 | var Utils = {};
120 | Utils.saferSetInnerHTML = saferSetInnerHTML;
121 | Utils.saferSetOuterHTML = saferSetOuterHTML;
122 | Utils.sanitizeDocumentFragment = sanitizeDocumentFragment;
123 |
124 | var EXPORTED_SYMBOLS = ['Utils'];
125 |
126 | if (typeof module !== 'undefined') {
127 | module.exports = Utils;
128 | } else {
129 | this.Utils = Utils;
130 | this.EXPORTED_SYMBOLS = EXPORTED_SYMBOLS;
131 | }
132 |
133 | }).call(function() {
134 | return this || (typeof window !== 'undefined' ? window : global);
135 | }());
136 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/background-services-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/background-services.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /*global Components:false, AddonManager:false*/
8 | /*jshint devel:true*/
9 |
10 | /*
11 | * This file is loaded as a background script in the main window -- even in
12 | * Thunderbird, where the other background script is only loaded for compose
13 | * windows.
14 | * This provides services for supplying access to preferences and other
15 | * background-only functions.
16 | *
17 | * From: https://developer.mozilla.org/en-US/docs/Code_snippets/Interaction_between_privileged_and_non-privileged_pages
18 | *
19 | * Note that the stored prefs are returned raw (well, after being JSON parsed).
20 | * No additional processing is done, like filling in default values.
21 | */
22 |
23 |
24 | (function() {
25 |
26 | /*
27 | * Set up the background request listeners
28 | */
29 |
30 | // analogue of chrome.extension.onRequest.addListener
31 | var createRequestListener = function(eventName, responseName, callback) {
32 | // https://developer.mozilla.org/en-US/docs/Code_snippets/Interaction_between_privileged_and_non-privileged_pages?redirectlocale=en-US&redirectslug=Code_snippets%3AInteraction_between_privileged_and_non-privileged_pages#Chromium-like_messaging.3A_json_request_with_json_callback
33 |
34 | return document.addEventListener(eventName, function(event) {
35 | var node = event.target;
36 | if (!node || node.nodeType != Node.TEXT_NODE) {
37 | return;
38 | }
39 |
40 | var doc = node.ownerDocument;
41 | var data = node.nodeValue ? JSON.parse(node.nodeValue) : null;
42 |
43 | return callback(data, doc, function(response) {
44 | node.nodeValue = JSON.stringify(null);
45 | if (response) {
46 | node.nodeValue = JSON.stringify(response);
47 | }
48 |
49 | var event = doc.createEvent('HTMLEvents');
50 | event.initEvent(responseName, true, false);
51 | return node.dispatchEvent(event);
52 | });
53 | }, false, true);
54 | };
55 |
56 | var optionsRequestHandler = function(request, sender, callback) {
57 | var prefs, prefKeys, prefsObj, i;
58 |
59 | prefs = Components.classes['@mozilla.org/preferences-service;1']
60 | .getService(Components.interfaces.nsIPrefService)
61 | .getBranch('extensions.markdown-here.');
62 |
63 | if (request.action === 'get') {
64 | prefKeys = prefs.getChildList('');
65 | prefsObj = {};
66 |
67 | for (i = 0; i < prefKeys.length; i++) {
68 | try {
69 | prefsObj[prefKeys[i]] = JSON.parse(prefs.getCharPref(prefKeys[i]));
70 | }
71 | catch(e) {
72 | // Null values and empty strings will result in JSON exceptions
73 | prefsObj[prefKeys[i]] = null;
74 | }
75 | }
76 |
77 | return callback(prefsObj);
78 | }
79 | else if (request.action === 'set') {
80 | for (var key in request.obj) {
81 | prefs.setCharPref(key, JSON.stringify(request.obj[key]));
82 | }
83 |
84 | if (callback) return callback();
85 | return;
86 | }
87 | else if (request.action === 'clear') {
88 | if (typeof(request.obj) === 'string') {
89 | request.obj = [request.obj];
90 | }
91 |
92 | for (i = 0; i < request.obj.length; i++) {
93 | prefs.clearUserPref(request.obj[i]);
94 | }
95 |
96 | if (callback) return callback();
97 | return;
98 | }
99 |
100 | return alert('Error: no matching options service action');
101 | };
102 |
103 | createRequestListener(
104 | 'markdown_here-options-query',
105 | 'markdown_here-options-response',
106 | optionsRequestHandler);
107 |
108 | var tabOpenRequestHandler = function(request, sender, callback) {
109 | var url = request;
110 | openTab(url);
111 | callback();
112 | };
113 |
114 | createRequestListener(
115 | 'markdown_here-tabOpen-query',
116 | 'markdown_here-tabOpen-response',
117 | tabOpenRequestHandler);
118 |
119 |
120 | /*
121 | * In order to check if this is a new version, etc., we need some code that runs
122 | * when the application starts. In the case of Thunderbird, our regular overlay
123 | * only loads when a new message is opened, so we're going to hijack this
124 | * overlay code to add some version checks and startup code.
125 | */
126 | try {
127 | // Firefox 4 and later; Mozilla 2 and later
128 | Components.utils.import("resource://gre/modules/AddonManager.jsm");
129 | AddonManager.getAddonByID("markdown-here@adam.pritchard", function(addon) {
130 | updateHandler(addon.version);
131 | });
132 | }
133 | catch (ex) {
134 | // Firefox 3.6 and before; Mozilla 1.9.2 and before
135 | var em = Components.classes["@mozilla.org/extensions/manager;1"]
136 | .getService(Components.interfaces.nsIExtensionManager);
137 | var addon = em.getItemForID("markdown-here@adam.pritchard");
138 | updateHandler(addon.version);
139 | }
140 |
141 | function updateHandler(currVer) {
142 |
143 | // I don't know why, but getting the extension prefs -- like last-version
144 | // -- doesn't seem to work when using prefsServ and providing the full pref
145 | // name. So we need to use prefsServ to set the sync options and prefsBranch
146 | // to get and set the extension options.
147 | var prefsServ = Components.classes['@mozilla.org/preferences-service;1']
148 | .getService(Components.interfaces.nsIPrefBranch);
149 | var prefsBranch = prefsServ.getBranch('extensions.markdown-here.');
150 |
151 |
152 | var lastVersion = '';
153 | try {
154 | lastVersion = JSON.parse(prefsBranch.getCharPref('last-version'));
155 | }
156 | catch (ex) {
157 | }
158 |
159 | var localFirstRun = false;
160 | try {
161 | // No need to assign this to anything. It shouldn't exist on first run.
162 | JSON.parse(prefsBranch.getCharPref('local-first-run'));
163 | }
164 | catch (ex) {
165 | // It's only the first run if the above throws.
166 | localFirstRun = true;
167 | }
168 |
169 | prefsBranch.setCharPref('local-first-run', JSON.stringify(localFirstRun));
170 |
171 | if (currVer !== lastVersion) {
172 | prefsBranch.setCharPref('last-version', JSON.stringify(currVer));
173 |
174 | // Set the sync flags while we're at it.
175 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.main-css', true);
176 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.syntax-css', true);
177 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.last-version', true);
178 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.math-enabled', true);
179 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.math-value', true);
180 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.hotkey', true);
181 |
182 | // Don't sync this one -- local only.
183 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.local-first-run', false);
184 |
185 | // This is a bit dirty. If we open the new tab immediately, it will get
186 | // overwritten when session restore starts creating tabs. So we'll wait a
187 | // couple of seconds after the last tab is restored to open ours.
188 | // But we'll also have to make sure we handle the case that no tabs are
189 | // being restored.
190 |
191 | var timeoutID = null;
192 |
193 | var tabRestored = function() {
194 | var postTabRestoredOptionsOpen = function() {
195 | document.removeEventListener('SSTabRestored', tabRestored);
196 |
197 | var optionsUrl = 'resource://markdown_here_common/options.html';
198 |
199 | // If this is an upgrade, open the options page in changelist mode
200 | if (lastVersion) {
201 | optionsUrl += '?prevVer=' + lastVersion;
202 | }
203 |
204 | openTab(optionsUrl);
205 | };
206 |
207 | clearTimeout(timeoutID);
208 | timeoutID = setTimeout(postTabRestoredOptionsOpen, 2000);
209 | };
210 | timeoutID = setTimeout(tabRestored, 1);
211 | document.addEventListener('SSTabRestored', tabRestored, false);
212 | }
213 |
214 | if (localFirstRun) {
215 | installButton('nav-bar', 'toolbarButton-markdown_here');
216 |
217 | // Note that we can't add the same button to more than one toolbar.
218 | // If we wanted to add the button to the addon toolbar, we'd use this
219 | // line.
220 | // The 'addon-bar' is available since Firefox 4
221 | //installButton('addon-bar', 'toolbarButton-markdown_here');
222 | }
223 | }
224 |
225 | // From: https://developer.mozilla.org/en-US/docs/Code_snippets/Toolbar?redirectlocale=en-US&redirectslug=Code_snippets%3AToolbar#Adding_button_by_default
226 | /**
227 | * Installs the toolbar button with the given ID into the given
228 | * toolbar, if it is not already present in the document.
229 | *
230 | * @param {string} toolbarId The ID of the toolbar to install to.
231 | * @param {string} id The ID of the button to install.
232 | * @param {string} afterId The ID of the element to insert after. @optional
233 | */
234 | function installButton(toolbarId, id, afterId) {
235 | if (!document.getElementById(id)) {
236 | var toolbar, elem;
237 |
238 | toolbar = document.getElementById(toolbarId);
239 |
240 | if (!toolbar) {
241 | return;
242 | }
243 |
244 | // If no afterId is given, then append the item to the toolbar
245 | var before = null;
246 | if (afterId) {
247 | elem = document.getElementById(afterId);
248 | if (elem && elem.parentNode == toolbar) {
249 | before = elem.nextElementSibling;
250 | }
251 | }
252 |
253 | toolbar.insertItem(id, before);
254 | toolbar.setAttribute('currentset', toolbar.currentSet);
255 | document.persist(toolbar.id, 'currentset');
256 |
257 | if (toolbarId == 'addon-bar') {
258 | toolbar.collapsed = false;
259 | }
260 | }
261 | }
262 |
263 |
264 | /*
265 | * Helper to open tabs, mostly for Thunderbird and friends.
266 | */
267 | function openTab(url) {
268 | var windowMediator = Components.classes['@mozilla.org/appshell/window-mediator;1']
269 | .getService(Components.interfaces.nsIWindowMediator);
270 |
271 | if (navigator.userAgent.indexOf('Thunderbird') >= 0 ||
272 | navigator.userAgent.indexOf('Icedove') >= 0) {
273 | windowMediator.getMostRecentWindow('mail:3pane')
274 | .document.getElementById('tabmail')
275 | .openTab('contentTab', {contentPage: url});
276 | }
277 | else if (navigator.userAgent.indexOf('Postbox') >= 0) {
278 | /* Haven't yet figured out how to open a tab in Postbox */
279 | }
280 | else {
281 | var win = windowMediator.getMostRecentWindow('navigator:browser');
282 | win.gBrowser.selectedTab = win.gBrowser.addTab(url);
283 | }
284 | }
285 | })();
286 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/ff-overlay.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2012
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /*global Components:false, markdownHere:false, GetCurrentEditorType:false,
8 | OptionsStore:false*/
9 | /*jshint browser:true*/
10 |
11 | /*
12 | * Firefox-specific code for responding to the context menu item and providing
13 | * rendering services.
14 | */
15 |
16 | Components.utils.import('resource://markdown_here_common/markdown-here.js');
17 |
18 |
19 | var markdown_here = {
20 |
21 | // Components.utils is somewhat more performant than mozIJSSubScriptLoader, so
22 | // we'll use it when possible. However, Components.utils usually requires
23 | // modifications to the source file, which isn't allowed for some 3rd party
24 | // code (Highlight.js, in particular) -- in that case we use mozIJSSubScriptLoader.
25 | // For details on the difference, see:
26 | // https://developer.mozilla.org/en-US/docs/Components.utils.import
27 | scriptLoader: Components.classes["@mozilla.org/moz/jssubscript-loader;1"]
28 | .getService(Components.interfaces.mozIJSSubScriptLoader),
29 |
30 | // Handle the menu-item click
31 | onMenuItemCommand: function(e) {
32 | var mdReturn, focusedElem, self = this;
33 |
34 | focusedElem = markdownHere.findFocusedElem(window.document);
35 | if (!focusedElem) {
36 | // Shouldn't happen. But if it does, just silently abort.
37 | return;
38 | }
39 |
40 | // Are we running in Thunderbird?
41 | if (typeof(GetCurrentEditorType) !== 'undefined' && GetCurrentEditorType !== null) {
42 | // Are we rich-editing?
43 | /*jshint newcap:false*/
44 | if (GetCurrentEditorType().indexOf('html') < 0) {
45 | this.alert('You are using a plain-text compose editor. You must change to a rich editor to use Markdown Here.');
46 | return;
47 | }
48 |
49 | // The focus might not be in the compose box
50 | if (!markdownHere.elementCanBeRendered(focusedElem)) {
51 | this.alert('Please put the cursor into the compose box.');
52 | return;
53 | }
54 | }
55 | else { // Firefox
56 | if (!markdownHere.elementCanBeRendered(focusedElem)) {
57 | this.alert('The selected field is not valid for Markdown rendering. Please use a rich editor.');
58 | return;
59 | }
60 | }
61 |
62 | mdReturn = markdownHere(
63 | focusedElem.ownerDocument,
64 | // We'll need the target document available later
65 | function() {
66 | self.markdownRender.apply(self, [focusedElem.ownerDocument].concat([].splice.call(arguments, 0))); },
67 | this.log);
68 |
69 | if (typeof(mdReturn) === 'string') {
70 | // Error message was returned.
71 | this.alert(mdReturn);
72 | return;
73 | }
74 | },
75 |
76 | onToolbarButtonCommand: function(e) {
77 | markdown_here.onMenuItemCommand(e);
78 | },
79 |
80 | onLoad: function() {
81 | var contextMenu, optionsStore = {};
82 |
83 | // initialization code
84 | this.initialized = true;
85 | this.strings = document.getElementById('markdown_here-strings');
86 |
87 | contextMenu = document.getElementById('contentAreaContextMenu');
88 | if (!contextMenu) contextMenu = document.getElementById('msgComposeContext');
89 | contextMenu.addEventListener('popupshowing', function (e) {
90 | markdown_here.contextMenuShowing(e);
91 | }, false);
92 |
93 | this.setupButton();
94 |
95 | // Some setup steps are dependent on options
96 | this.scriptLoader.loadSubScript('resource://markdown_here_common/options-store.js');
97 | OptionsStore.get(function(prefs) {
98 |
99 | // Register a hotkey listener
100 |
101 | function hotkeyHandler(event) {
102 | if (event.shiftKey === prefs.hotkey.shiftKey &&
103 | event.ctrlKey === prefs.hotkey.ctrlKey &&
104 | event.altKey === prefs.hotkey.altKey &&
105 | event.which === prefs.hotkey.key.toUpperCase().charCodeAt(0)) {
106 | markdown_here.onMenuItemCommand();
107 | event.preventDefault();
108 | return false;
109 | }
110 | }
111 |
112 | // Only add a listener if a key is set
113 | if (prefs.hotkey.key.length === 1) {
114 | window.addEventListener('keydown', hotkeyHandler, false);
115 | }
116 | });
117 | },
118 |
119 | contextMenuShowing: function(event) {
120 | // Hide the context menuitem if it's not on a message compose box.
121 | var focusedElem, showItem = false;
122 |
123 | // Are we running in Thunderbird?
124 | if (typeof(GetCurrentEditorType) !== 'undefined' && GetCurrentEditorType !== null) {
125 | // Always show the menu item.
126 | // If the editor isn't in rich mode, the user will get a helpful error
127 | // message telling them to change modes.
128 | showItem = true;
129 | }
130 | else { // Firefox
131 | focusedElem = markdownHere.findFocusedElem(window.document);
132 |
133 | if (!focusedElem) {
134 | showItem = false;
135 | }
136 | else if (focusedElem.type === 'textarea') {
137 | // Show the context menu item for `textarea`s. If the user clicks it,
138 | // there will be a helpful error message. This will make behaviour more
139 | // consistent with Chrome, and will hopefully help people notice that
140 | // they're not using the rich editor instead of just wondering why the
141 | // menu item just isn't showing up.
142 | showItem = true;
143 | }
144 | else {
145 | showItem = markdownHere.elementCanBeRendered(focusedElem);
146 | }
147 | }
148 |
149 | document.getElementById('context-markdown_here').hidden = !showItem;
150 | document.getElementById('context-markdown_here-separator').hidden = !showItem;
151 | },
152 |
153 | log: function(msg) {
154 | var consoleService = Components.classes['@mozilla.org/consoleservice;1']
155 | .getService(Components.interfaces.nsIConsoleService);
156 | consoleService.logStringMessage(msg);
157 | },
158 |
159 | alert: function(msg) {
160 | var prompts = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
161 | .getService(Components.interfaces.nsIPromptService);
162 | prompts.alert(null, 'Markdown Here', msg);
163 | },
164 |
165 | // The rendering service provided to the content script.
166 | // See the comment in markdown-render.js for why we do this.
167 | markdownRender: function(targetDocument, html, callback) {
168 | var markdownRender = {}, hljs = {}, marked = {}, htmlToText = {}, optionsStore = {};
169 |
170 | Components.utils.import('resource://markdown_here_common/markdown-render.js', markdownRender);
171 | Components.utils.import('resource://markdown_here_common/marked.js', marked);
172 | Components.utils.import('resource://markdown_here_common/jsHtmlToText.js', htmlToText);
173 | this.scriptLoader.loadSubScript('resource://markdown_here_common/highlightjs/highlight.js', hljs);
174 |
175 | OptionsStore.get(function(prefs) {
176 | callback(
177 | markdownRender.markdownRender(
178 | prefs,
179 | htmlToText.htmlToText,
180 | marked.marked,
181 | hljs.hljs,
182 | html,
183 | targetDocument,
184 | targetDocument.location ? targetDocument.location.href : null),
185 | prefs['main-css'] + prefs['syntax-css']);
186 | });
187 | },
188 |
189 | /*
190 | * Set up our toggle button.
191 | * Please see src/chrome/contentscript.js for more info.
192 | */
193 | setupButton: function() {
194 |
195 | // At this time, only this function differs between Chrome and Firefox.
196 | function showToggleButton(show) {
197 | var btn, tooltipString;
198 |
199 | // Page action button
200 | btn = document.getElementById('pageAction-markdown_here');
201 | if (btn) {
202 | btn.setAttribute('collapsed', !show);
203 | }
204 |
205 | // Toolbar button
206 | btn = document.getElementById('toolbarButton-markdown_here');
207 | if (btn) {
208 | var stringsBundle = document.getElementById('markdown_here-strings');
209 |
210 | if (show) {
211 | btn.removeAttribute('disabled');
212 |
213 | if (stringsBundle) {
214 | tooltipString = stringsBundle.getString('markdown_hereButton.tooltiptext');
215 | if (tooltipString) {
216 | btn.setAttribute('tooltiptext', tooltipString);
217 | }
218 | }
219 | }
220 | else {
221 | btn.setAttribute('disabled', 'true');
222 |
223 | if (stringsBundle) {
224 | tooltipString = stringsBundle.getString('markdown_hereButton.disabledtooltiptext');
225 | if (tooltipString) {
226 | btn.setAttribute('tooltiptext', tooltipString);
227 | }
228 | }
229 | }
230 | }
231 |
232 | // Zotero toolbar button
233 | btn = document.getElementById('toolbarButton-markdown_here-zotero');
234 | if (!btn) btn = document.getElementById('toolbarButton-markdown_here-zotero-pressed');
235 | if (btn) {
236 | var loc = 'resource://markdown_here_common/images/';
237 | btn.setAttribute('disabled', !show);
238 | btn.setAttribute('image', show ? (loc + "markdown.png") : (loc + "markdown-bw.png"));
239 | }
240 | }
241 |
242 | var lastElemChecked, lastRenderable;
243 | function setToggleButtonVisibility(elem) {
244 | var renderable = false;
245 |
246 | // Assumption: An element does not change renderability.
247 | if (elem === lastElemChecked) {
248 | return;
249 | }
250 | lastElemChecked = elem;
251 |
252 | if (elem && elem.ownerDocument) {
253 | // We may have gotten here via the timer, so we'll add an event handler.
254 | // Setting the event handler like this lets us better deal with iframes.
255 | // It's okay to call `addEventListener` more than once with the exact same
256 | // arguments.
257 | elem.ownerDocument.addEventListener('focus', focusChange, true);
258 |
259 | renderable = markdownHere.elementCanBeRendered(elem);
260 | }
261 |
262 | if (renderable !== lastRenderable) {
263 | showToggleButton(renderable);
264 | lastRenderable = renderable;
265 | }
266 | }
267 |
268 | // When the focus in the page changes, check if the newly focused element is
269 | // a valid Markdown Toggle target.
270 | function focusChange(event) {
271 | setToggleButtonVisibility(event.target);
272 | }
273 | window.document.addEventListener('focus', focusChange, true);
274 |
275 | // We're using a function expression rather than a function declaration
276 | // because Mozilla's automatic extension review prefers when you pass the
277 | // former to `setInterval()`.
278 | var intervalCheck = function() {
279 | var focusedElem = markdownHere.findFocusedElem(window.document);
280 | if (!focusedElem) {
281 | return;
282 | }
283 |
284 | setToggleButtonVisibility(focusedElem);
285 | };
286 | setInterval(intervalCheck, 2000);
287 | }
288 | };
289 |
290 | window.addEventListener('load', function () {
291 | markdown_here.onLoad();
292 | }, false);
293 |
294 |
295 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/ff-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
12 |
13 |
14 |
15 |
16 |
24 |
25 |
26 |
31 |
32 |
33 |
39 |
40 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/tb-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
11 |
12 |
13 |
14 |
15 |
23 |
24 |
25 |
31 |
32 |
33 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/zotero-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/src/firefox/chrome/locale/en-US/overlay.dtd:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/src/firefox/chrome/locale/en-US/overlay.properties:
--------------------------------------------------------------------------------
1 | markdown_hereButton.tooltiptext=Click to toggle Markdown rendering
2 | markdown_hereButton.disabledtooltiptext=The selected field is not valid for Markdown rendering
3 |
--------------------------------------------------------------------------------
/src/firefox/chrome/skin/overlay.css:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/src/firefox/chrome/skin/overlay.css
--------------------------------------------------------------------------------
/src/firefox/chrome/skin/toolbar.css:
--------------------------------------------------------------------------------
1 | #toolbarButton-markdown_here, #composeToolbarButton-markdown_here, #formatToolbarButton-markdown_here {
2 | list-style-image: url("resource://markdown_here_common/images/icon24.png");
3 | }
4 |
5 | #toolbarButton-markdown_here[disabled="true"],
6 | #composeToolbarButton-markdown_here[disabled="true"],
7 | #formatToolbarButton-markdown_here[disabled="true"] {
8 | list-style-image: url("resource://markdown_here_common/images/icon24-bw.png");
9 | }
10 |
11 | toolbar[iconsize="small"] #toolbarButton-markdown_here,
12 | toolbar[iconsize="small"] #composeToolbarButton-markdown_here,
13 | toolbar[iconsize="small"] #formatToolbarButton-markdown_here {
14 | list-style-image: url("resource://markdown_here_common/images/icon16.png");
15 | }
16 |
17 | toolbar[iconsize="small"] #toolbarButton-markdown_here[disabled="true"],
18 | toolbar[iconsize="small"] #composeToolbarButton-markdown_here[disabled="true"],
19 | toolbar[iconsize="small"] #formatToolbarButton-markdown_here[disabled="true"] {
20 | list-style-image: url("resource://markdown_here_common/images/icon16-bw.png");
21 | }
22 |
--------------------------------------------------------------------------------
/src/firefox/defaults/preferences/prefs.js:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/src/firefox/defaults/preferences/prefs.js
--------------------------------------------------------------------------------
/src/install.rdf:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 | 2
7 | markdown-here@adam.pritchard
8 | 2.8.1
9 |
10 |
11 |
12 |
13 | {ec8030f7-c20a-464f-9b0e-13a3a9e97384}
14 | 11.0
15 | 23.*
16 |
17 |
18 |
19 |
20 |
21 |
22 | postbox@postbox-inc.com
23 | 2.0
24 | 3.*
25 |
26 |
27 |
28 |
29 |
30 |
31 | zotero@chnm.gmu.edu
32 | 3.0b1
33 | 4.*
34 |
35 |
36 |
37 |
38 |
39 |
40 | toolkit@mozilla.org
41 | 6.0
42 | 23.*
43 |
44 |
45 |
46 | Markdown Here
47 | Write your email in Markdown, then make it pretty.
48 | Adam Pritchard
49 |
50 | resource://markdown_here_common/images/icon128.png
51 | https://github.com/adam-p/markdown-here
52 |
53 |
54 | javascript:
55 | /* This is a pretty convoluted way of getting a tab to open with
56 | our options page. */
57 | var windowMediator = Components.classes['@mozilla.org/appshell/window-mediator;1']
58 | .getService(Components.interfaces.nsIWindowMediator);
59 | var optionsUrl = 'resource://markdown_here_common/options.html';
60 | if (navigator.userAgent.indexOf('Thunderbird') >= 0 ||
61 | navigator.userAgent.indexOf('Icedove') >= 0) {
62 | windowMediator.getMostRecentWindow('mail:3pane')
63 | .document.getElementById('tabmail')
64 | .openTab('contentTab', {contentPage: optionsUrl});
65 | }
66 | else if (navigator.userAgent.indexOf('Postbox') >= 0) {
67 | /* Haven't yet figured out how to open a tab in Postbox */
68 | var prompts = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
69 | .getService(Components.interfaces.nsIPromptService);
70 | prompts.alert(null, 'Markdown Here', 'Sorry, the options page is not supported for Postbox.');
71 | }
72 | /*else {
73 | var win = windowMediator.getMostRecentWindow('navigator:browser');
74 | win.gBrowser.selectedTab = win.gBrowser.addTab(optionsUrl);
75 | }*/
76 | /* Close the stub prefs dialog that will have opened. */
77 | window.close();
78 |
79 |
80 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/src/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "manifest_version": 2,
3 | "name": "Markdown Here",
4 | "version": "2.8.1",
5 | "description": "Write your email in Markdown, then make it pretty.",
6 | "homepage_url": "http://markdown-here.com",
7 | "minimum_chrome_version": "6",
8 | "icons": {
9 | "16": "common/images/icon16.png",
10 | "32": "common/images/icon32.png",
11 | "48": "common/images/icon48.png",
12 | "128": "common/images/icon128.png",
13 | "512": "common/images/icon512.png"
14 | },
15 | "permissions": ["contextMenus", "storage"],
16 | "background": {"page": "chrome/background.html"},
17 | "content_scripts": [
18 | {
19 | "matches": [""],
20 | "js": ["common/utils.js", "common/markdown-here.js", "chrome/contentscript.js"]
21 | }
22 | ],
23 | "browser_action": {
24 | "default_icon": "common/images/icon38.png",
25 | "default_title": "Markdown Toggle"
26 | },
27 | "options_page": "common/options.html"
28 | }
29 |
--------------------------------------------------------------------------------
/store-assets/amo-reviewer-notes.txt:
--------------------------------------------------------------------------------
1 | This extension is used to manipulate the content of email before sending. It can be used in Gmail, Hotmail, or Yahoo webmail interfaces, or in Thunderbird. Make sure you use the rich-edit interface for the email client.
2 |
3 | You write email in Markdown (if you're not familiar with Markdown, I made a little reference -- https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet), then right-click, click the "Markdown Toggle" menu item, and the content of the email will be replaced with a rendered-HTML version of the Markdown you had written.
4 |
5 | If you select a subset of your email and then "Markdown Toggle", only that selection will be rendered/converted.
6 |
7 | The Markdown is "Github-flavored". Syntax highlighting is supported. So, for example, you can use fenced code blocks with the language name specified, like so:
8 |
9 | ```javascript
10 | var i = 0;
11 | ```
12 |
13 | For complete info, see the project page: https://github.com/adam-p/markdown-here
14 |
15 | Please don't hesitate to contact me with questions.
16 |
17 |
18 | A more formal test methodology, if desired:
19 |
20 | 1. Go into your webmail of choice, or Thunderbird. Make sure rich editing is enabled.
21 |
22 | 2. Write a bit of Markdown. (I'll include some at the bottom of this that you can paste, if you want. Make sure to paste as plaintext.)
23 |
24 | 3. Right-click and choose "Markdown Toggle".
25 |
26 | Test #1: The entire email should be converted to HTML, in accordance with Markdown syntax. The sample MD should have H1, H3, UL, and PRE/CODE elements, with some bold and code inline.
27 |
28 | 4. Right-click again and choose "Markdown Toggle".
29 |
30 | Test #2: The email email should be reverted back the original raw Markdown.
31 |
32 | 5. Select a few lines (but don't split the code block). Then right-click and choose "Markdown Toggle".
33 |
34 | Test #3: Only the selected lines should be rendered to HTML.
35 |
36 | 6. Right-click again and choose "Markdown Toggle".
37 |
38 | Test #4: The email should be reverted back to original Markdown.
39 |
40 | 7. Render the email again (either entirely or partially) and send it (to yourself or someone else).
41 |
42 | Test #5: The recipient of the email should see it pretty much as it was before you sent it.
43 |
44 | Test done.
45 |
46 |
47 | Caveat: Hotmail is a little flaky. Gmail and Thunderbird are the only first-class targets. Details: https://github.com/adam-p/markdown-here#compatibility
48 |
49 |
50 | A few secondary features that can be tested if desired:
51 |
52 | - Options: Should open after installation (and restart). Should open after upgrade. Should auto-save. Should sync settings.
53 | - Signatures should be excluded from the conversion. Sigs must be preceded by the standard-ish '-- ' (note the trailing space).
54 | - Images embedded in the email before conversion (Gmail and Thunderbird) should be retained by the conversion.
55 | - Quoted reply text should be excluded by the conversion.
56 | - TeX mathematical formulae should be rendered if and only if that functionality is enabled in the options.
57 |
58 |
59 | ---
60 |
61 | # Markdown Sample (H1)
62 |
63 | ### Smaller header (H3)
64 |
65 | * Bullet **with bold**
66 | * Bullet with `inline code`
67 |
68 | ```javascript
69 | var s = 'code block';
70 | console.log(s);
71 | ```
72 |
73 | This is the quadratic equation in TeX (rendered if enabled):
74 | $-b \pm \sqrt{b^2 - 4ac} \over 2a$
75 |
--------------------------------------------------------------------------------
/store-assets/description.txt:
--------------------------------------------------------------------------------
1 | Markdown Here lets you write email in Markdown and render it (make it pretty!) before sending.
2 |
3 | This is great for anyone who doesn't like fiddling around with formatting buttons while writing an email. It's especially good for programmers who write email with code in them -- it even supports syntax highlighting. And for the mathematicians among us: Markdown Here will render TeX formulae as well.
4 |
5 | Totally simple to use:
6 | 1. Write your email in your email client's rich editor using Github-flavoured Markdown.
7 | 2. Right-click in the compose area and then click "Markdown Toggle".
8 | 3. Your email is now pretty! (That is, it's been rendered to HTML.)
9 | 4. If you like the way it looks, just send it. If you want to change or add something, click "Markdown Toggle" again to get back to your original Markdown. Rinse and repeat.
10 |
11 | If only part of your email is Markdown, then select the part you want to render into pretty HTML, right click, and click "Markdown Toggle". Only your selection will be converted. To revert back to the original Markdown, right click in the rendered block and click "Markdown Toggle" again.
12 |
13 | Markdown Here is primarily targeted to work with Gmail and Thunderbird, but it also works pretty well with Yahoo and Hotmail. Additionally, it works great with Google Groups and pretty well with Evernote's web interface.
14 |
15 | Syntax highlighting note: Used fenced code blocks and specify the language name. See the project page for an example.
16 |
17 | Privacy: Markdown Here accesses and modifies the content of your email. It can, in theory, access other web content, but does not. It also makes no Internet requests itself whatsoever. You data is modified when and where you choose, and does not leave your browser.
18 |
19 | Available as a Chrome, Firefox, Safari, and Thunderbird extension.
20 |
21 | This is an open source project. Visit Markdown Here's Github page for full instructions, more information, bug reports, or to contribute.
22 |
23 | http://markdown-here.com
24 | https://github.com/adam-p/markdown-here
25 |
--------------------------------------------------------------------------------
/store-assets/dos-equis-MDH.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/dos-equis-MDH.jpg
--------------------------------------------------------------------------------
/store-assets/markdown-here-chrome-options.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-chrome-options.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-chrome-options.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-chrome-options.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/markdown-here-image1.425x265.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image1.425x265.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-image1.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image1.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-image1.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image1.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/markdown-here-image2.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image2.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-image2.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image2.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/markdown-here-promo-small.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-promo-small.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-promo-small.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-promo-small.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/md-for-screenshot.md:
--------------------------------------------------------------------------------
1 | ## Sweet Screenshot Markdown
2 |
3 | *Markdown Here* is a Google Chrome, Firefox, and Thunderbird extension that lets you write email in Markdown and render it before sending.
4 |
5 | * Markdown is **cool**. Put `code inline`.
6 | * Link to stuff, like [this project](https://github.com/adam-p/markdown-here).
7 | * Ordered, you say? **And** a sub-list?
8 | 1. Done.
9 | 2. And done.
10 |
11 | Actual review quote:
12 |
13 | > Does exactly what I need it to do. Markdown support in email without getting in the way.
14 |
15 | ### Syntax highlighting: super rad
16 |
17 | Some JavaScript:
18 |
19 | ```javascript
20 | alert('Hello Markdown');
21 | ```
22 |
23 | How about an unusual example -- a diff:
24 |
25 | ```diff
26 | diff --git a/src/common/markdown-here.js b/src/common/markdown-here.js
27 | index 24dcb97..20c36a1 100644
28 | --- a/src/common/markdown-here.js
29 | +++ b/src/common/markdown-here.js
30 | @@ -201,12 +179,14 @@ function makeStylesExplicit(wrapperElem, css) {
31 | - applyStyleToElement(rule.style, selectorMatches[j]);
32 | + styleAttr = selectorMatches[j].getAttribute('style') || '';
33 | + styleAttr += rule.style.cssText;
34 | + selectorMatches[j].setAttribute('style', styleAttr);
35 | ```
36 |
37 |
--------------------------------------------------------------------------------
/test/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 | Markdown Here Test
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
21 |
22 |
29 |
30 |
31 |
32 |
--------------------------------------------------------------------------------
$2
$3') // a raw text node without an enclosing won't be handled properly, so add one
136 | .replace(/(<\/div>)]*><\/div>(]*>)/ig, '$1$2') // empty
between other
elems gets removed
137 | .replace(/]*>
<\/div>/ig, '
') //
-->
138 | .replace(/(]*>)+/ig, '
') // opening
<\/div>/ig, '
') //
138 | .replace(/(
') // opening
-->
(but nested![]()
tags --> textual ![]()
tags
141 | .replace(/ /ig, ' '); // --> space
142 |
143 | return preprocessInfo;
144 |
145 | // Escape all tags between tags of type `tagName`, inclusive. Also add a
146 | // special "exclude" class to them.
147 | // If `wrapInPara` is true, `
' + // three empty lines is "guaranteed" to break a Markdown block (like a bullet list) 231 | placeholder + 232 | '
' + 233 | preprocessInfo.html.slice(closeIndex+closeTagLength); 234 | 235 | // Start from the beginning again. The length of the string has 236 | // changed (so our indexes are meaningless), and we'll only find 237 | // unescaped/unprocessed tags of interest anyway. 238 | startIndex = 0; 239 | } 240 | else { 241 | startIndex = closeIndex + 1; 242 | } 243 | 244 | depth -= 1; 245 | } 246 | else { 247 | // Depth is 0. So we've found a closing tag while not in an opening 248 | // tag -- this can happen normally if `ifHasAttribute` is non-null. 249 | // Just advance the startIndex. 250 | startIndex += closeIndex + 1; 251 | } 252 | } 253 | } 254 | 255 | return preprocessInfo; 256 | } 257 | 258 | // Add the class `className` to all tags in `html`. 259 | function addClassToAllTags(className, html) { 260 | return html 261 | .replace( 262 | /<(\w+\b)(([^>]*)(class=("|')([^>]*?)\5)([^>]*))>/ig, 263 | '<$1$3class="$6 ' + className + '"$7>') 264 | .replace( 265 | /<(\w+\b)(((?!class)[^>])*)>/ig, 266 | '<$1 class="' + className + '"$2>'); 267 | } 268 | } 269 | 270 | /** 271 | Converts instances of `tag` in `html` to Markdown and returns the 272 | resulting HTML. 273 | */ 274 | function convertHTMLtoMarkdown(tag, html) { 275 | if (tag === 'a') { 276 | /* 277 | Make sure we do *not* convert HTML links that are inside of MD links. 278 | Otherwise we'll have problems like issue #69. 279 | We're going to use a regex that mimics a negative lookbehind. For details see: http://blog.stevenlevithan.com/archives/mimic-lookbehind-javascript 280 | Here's an attempt at an explanation of the regex: 281 | ( // begin optional prefix capture group 282 | (?:\]\([^\)]*) // match an unclosed URL portion of a MD link -- like "...](..." 283 | |(?:\[[^\]]*) // match an unclosed name portion of a MD link -- like "...[..." 284 | )? // capture group is optional so that we do the "negative" lookbehind -- that is, we can match links that are *not* preceded by the stuff we *don't* want 285 |]*href="([^"]*)"[^>]*>(.*?)<\/a> // an HTML link
286 | Then the replace callback looks like this:
287 | return $1 ? $0 : '['+$3+']('+$2+')'
288 | So, if the first capture group is matched (i.e., $1 has value), then we've
289 | matched the bad thing -- the indication that the HTML is inside a MD link.
290 | In that case, we don't modify anything. Otherwise we use our other capture
291 | groups to create the desired MD link.
292 | */
293 | html = html.replace(
294 | /((?:\]\([^\)]*)|(?:\[[^\]]*))?]*href="([^"]*)"[^>]*>(.*?)<\/a>/ig,
295 | function($0, $1, $2, $3) {
296 | return $1 ? $0 : '['+$3+']('+$2+')';
297 | });
298 | }
299 | else {
300 | throw new Error('convertHTMLtoMarkdown: ' + tag + ' is not a supported tag');
301 | return;
302 | }
303 |
304 | return html;
305 | }
306 |
307 | // Restore the content that we extracted so that it wouldn't be processed.
308 | function postprocessHtml(renderedMarkdown, preprocessInfo) {
309 | var i;
310 | for (i = 0; i < preprocessInfo.exclusions.length; i++) {
311 | renderedMarkdown = renderedMarkdown.replace(preprocessInfo.exclusions[i].placeholder,
312 | preprocessInfo.exclusions[i].content);
313 | }
314 |
315 | return renderedMarkdown;
316 | }
317 |
318 | // Using `syntaxHighlighter`, highlight the code in `codeText` that is of
319 | // language `codeLanguage` (may be falsy).
320 | // `syntaxHighlighter` is expected to behave like (i.e., to be) highlight.js.
321 | function highlightSyntax(targetDocument, syntaxHighlighter, codeText, codeLanguage) {
322 | var codeElem, preElem, textNode;
323 |
324 | // highlight.js requires a `
(but nested
just gets one
) 139 | .replace(/<\/div>/ig, '') // closing
--> nothing
140 | .replace(/<(img[^>]*)>/ig, '<$1>') // ) 139 | .replace(/<\/div>/ig, '') // closing
` tags will be added before and after each 148 | // tag block found. 149 | // If `ifHasAttribute` is non-null, tags will only be matched if they have 150 | // that attribute. 151 | // If `ifNotHasString` is non-null, tags that contain that string will not 152 | // be matched. Note that `ifNotHasString` will be used in a regex. 153 | // TODO: This function is pretty flawed. Wrapping block elements in paras 154 | // doesn't make much sense. And if we're going to support inline 155 | // elements, then we can't unconditionally put linebreaks around the 156 | // the wrapped elements. 157 | function excludeTagBlocks(tagName, preprocessInfo, wrapInPara, ifHasAttribute, ifNotHasString) { 158 | var depth, startIndex, openIndex, closeIndex, currentOpenIndex, 159 | openTagRegex, closeTagRegex, remainder, closeTagLength, regexFiller; 160 | 161 | regexFiller = ifNotHasString ? '(((?!'+ifNotHasString+')[^>])*)' : '[^>]*'; 162 | if (ifHasAttribute) { 163 | openTagRegex = new RegExp('<'+tagName+'\\b'+regexFiller+'\\b'+ifHasAttribute+'\\b'+regexFiller+'>', 'i'); 164 | } 165 | else { 166 | openTagRegex = new RegExp('<'+tagName+'\\b'+regexFiller+'>', 'i'); 167 | } 168 | 169 | closeTagRegex = new RegExp('= 0 && openIndex < closeIndex)) { 185 | // Process an open tag next. 186 | 187 | // Make the index relative to the beginning of the string. 188 | openIndex += startIndex; 189 | 190 | if (depth === 0) { 191 | // Not a nested tag. Start the escape here. 192 | currentOpenIndex = openIndex; 193 | } 194 | 195 | startIndex = openIndex + 1; 196 | depth += 1; 197 | } 198 | else { 199 | // Process a close tag next. 200 | 201 | if (depth > 0) { 202 | // Make the index relative to the beginning of the string. 203 | closeIndex += startIndex; 204 | 205 | if (depth === 1) { 206 | // Not a nested tag. Time to escape. 207 | // Because we've mangled the opening and closing tags, we need to 208 | // put around them so that they don't get mashed together with the 209 | // preceeding and following Markdown. 210 | 211 | closeTagLength = ('').length; 212 | 213 | var placeholder = String(Math.random()); 214 | preprocessInfo.exclusions.push({ 215 | placeholder: placeholder, 216 | content: 217 | '
' +
218 | (wrapInPara ? '
'
222 | });
223 |
224 | // We need to insert some empty lines when we extract something,
225 | // otherwise the stuff above and below would be rendered as if they
226 | // were together.
227 |
228 | preprocessInfo.html =
229 | preprocessInfo.html.slice(0, currentOpenIndex) +
230 | '' : '') + 219 | preprocessInfo.html.slice(currentOpenIndex, closeIndex+closeTagLength) + 220 | (wrapInPara ? '
' : '') + 221 | '' + // three empty lines is "guaranteed" to break a Markdown block (like a bullet list) 231 | placeholder + 232 | '
' + 233 | preprocessInfo.html.slice(closeIndex+closeTagLength); 234 | 235 | // Start from the beginning again. The length of the string has 236 | // changed (so our indexes are meaningless), and we'll only find 237 | // unescaped/unprocessed tags of interest anyway. 238 | startIndex = 0; 239 | } 240 | else { 241 | startIndex = closeIndex + 1; 242 | } 243 | 244 | depth -= 1; 245 | } 246 | else { 247 | // Depth is 0. So we've found a closing tag while not in an opening 248 | // tag -- this can happen normally if `ifHasAttribute` is non-null. 249 | // Just advance the startIndex. 250 | startIndex += closeIndex + 1; 251 | } 252 | } 253 | } 254 | 255 | return preprocessInfo; 256 | } 257 | 258 | // Add the class `className` to all tags in `html`. 259 | function addClassToAllTags(className, html) { 260 | return html 261 | .replace( 262 | /<(\w+\b)(([^>]*)(class=("|')([^>]*?)\5)([^>]*))>/ig, 263 | '<$1$3class="$6 ' + className + '"$7>') 264 | .replace( 265 | /<(\w+\b)(((?!class)[^>])*)>/ig, 266 | '<$1 class="' + className + '"$2>'); 267 | } 268 | } 269 | 270 | /** 271 | Converts instances of `tag` in `html` to Markdown and returns the 272 | resulting HTML. 273 | */ 274 | function convertHTMLtoMarkdown(tag, html) { 275 | if (tag === 'a') { 276 | /* 277 | Make sure we do *not* convert HTML links that are inside of MD links. 278 | Otherwise we'll have problems like issue #69. 279 | We're going to use a regex that mimics a negative lookbehind. For details see: http://blog.stevenlevithan.com/archives/mimic-lookbehind-javascript 280 | Here's an attempt at an explanation of the regex: 281 | ( // begin optional prefix capture group 282 | (?:\]\([^\)]*) // match an unclosed URL portion of a MD link -- like "...](..." 283 | |(?:\[[^\]]*) // match an unclosed name portion of a MD link -- like "...[..." 284 | )? // capture group is optional so that we do the "negative" lookbehind -- that is, we can match links that are *not* preceded by the stuff we *don't* want 285 |
` element to be passed in that has a
325 | // `` parent element.
326 |
327 | preElem = targetDocument.createElement('pre');
328 | codeElem = targetDocument.createElement('code');
329 | textNode = targetDocument.createTextNode(codeText);
330 | codeElem.appendChild(textNode);
331 | preElem.appendChild(codeElem);
332 |
333 | // If we're told the language, set it as a class so that the highlighter
334 | // doesn't have to guess it. This is part of the HTML5 standard. See:
335 | // http://www.whatwg.org/specs/web-apps/current-work/multipage/text-level-semantics.html#the-code-element
336 | if (codeLanguage && codeLanguage.length > 0) {
337 | codeElem.setAttribute('class', 'language-'+codeLanguage);
338 | }
339 | else {
340 | codeElem.setAttribute('class', 'no-highlight');
341 | }
342 |
343 | syntaxHighlighter.highlightBlock(codeElem);
344 |
345 | return codeElem.innerHTML;
346 | }
347 |
348 | markdownRender._testExports = {
349 | convertHTMLtoMarkdown: convertHTMLtoMarkdown,
350 | preprocessHtml: preprocessHtml
351 | };
352 |
353 | var EXPORTED_SYMBOLS = ['markdownRender'];
354 |
355 | if (typeof module !== 'undefined') {
356 | module.exports = markdownRender;
357 | } else {
358 | this.markdownRender = markdownRender;
359 | this.EXPORTED_SYMBOLS = EXPORTED_SYMBOLS;
360 | }
361 |
362 | }).call(function() {
363 | return this || (typeof window !== 'undefined' ? window : global);
364 | }());
365 |
--------------------------------------------------------------------------------
/src/common/options-iframe.html:
--------------------------------------------------------------------------------
1 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
27 |
28 |
29 |
31 |
32 |
33 | ```javascript
34 | function syntaxHighlighting() {
35 | var n = 33;
36 | var s = "hi";
37 | console.log(s);
38 | }
39 | ```
40 |
41 | * plain
42 | * *emphasis*
43 | * **strong emphasis**
44 | * `inline code`
45 |
46 | 1. Numbered list
47 | 2. [Link](https://www.google.com)
48 |
49 |
50 | > Block quote.
51 | > *With* **some** `markdown`.
52 |
53 | If **TeX Math** support is enabled, this is the quadratic equation:
54 | $-b \pm \sqrt{b^2 - 4ac} \over 2a$
55 |
56 | # Header 1
57 | ## Header 2
58 | ### Header 3
59 | #### Header 4
60 | ##### Header 5
61 | ###### Header 6
62 |
63 | | Tables | Are | Cool |
64 | | ------------- |:-------------:| -----:|
65 | | col 3 is | right-aligned | $1600 |
66 | | col 2 is | centered | $12 |
67 | | zebra stripes | are neat | $1 |
68 |
69 | Horizontal rule
70 |
71 | ---
72 |
73 | <dl>
74 | <dt>Definition list</dt>
75 | <dd>Is something people use sometimes.</dd>
76 | </dl>
77 |
78 | ```
79 | code block
80 | with no highlighting
81 | ```
82 |
83 |
84 |
85 |
86 |
87 |
--------------------------------------------------------------------------------
/src/common/options-iframe.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | function onLoad() {
7 | // Chrome and Safari require us to manually load our content script in order
8 | // to use the button and context menu in the iframe.
9 | if (typeof(safari) !== 'undefined' || typeof(chrome) !== 'undefined') {
10 | window.LOAD_MARKDOWN_HERE_CONTENT_SCRIPT = true;
11 | var contentscript = document.createElement('script');
12 | if (typeof(safari) !== 'undefined') {
13 | contentscript.src = '../../../contentscript.js';
14 | }
15 | else if (typeof(chrome) !== 'undefined') {
16 | contentscript.src = '../chrome/contentscript.js';
17 | }
18 | document.body.appendChild(contentscript);
19 | }
20 |
21 | // The body of the iframe needs to have a (collapsed) selection range for
22 | // Markdown Here to work (simulating focus/cursor).
23 | var range = document.createRange();
24 | range.setStart(document.body, 0);
25 | var sel = document.getSelection();
26 | sel.removeAllRanges();
27 | sel.addRange(range);
28 |
29 | // Let our owner page know that we've loaded.
30 | var e = top.document.createEvent('HTMLEvents');
31 | e.initEvent('options-iframe-loaded', true, true);
32 | top.document.dispatchEvent(e);
33 | }
34 | document.addEventListener('DOMContentLoaded', onLoad, false);
35 |
--------------------------------------------------------------------------------
/src/common/test/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
8 |
9 |
10 |
11 |
12 |
13 | Markdown Here Autotests
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 |
--------------------------------------------------------------------------------
/src/common/test/markdown-render-test.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /* jshint curly:true, noempty:true, newcap:true, eqeqeq:true, eqnull:true, es5:true, undef:true, devel:true, browser:true, node:true, evil:false, latedef:false, nonew:true, trailing:false, immed:false, smarttabs:true, expr:true */
8 | /* global describe, expect, it, before, beforeEach, after, afterEach */
9 | /* global _, $, markdownRender, htmlToText, marked, hljs, Utils */
10 |
11 |
12 | describe('Markdown-Render', function() {
13 | it('should exist', function() {
14 | expect(markdownRender).to.exist;
15 | });
16 |
17 | describe('convertHTMLtoMarkdown', function() {
18 | var convertHTMLtoMarkdown = markdownRender._testExports.convertHTMLtoMarkdown;
19 |
20 | it('should throw an exception for unsupported tags', function() {
21 | expect(_.partial(convertHTMLtoMarkdown, 'badtag')).to.throw(Error);
22 | });
23 |
24 | it('should not modify the string if there is no match', function() {
25 | var s = 'aaa bbb ccc ddd eee';
26 | expect(convertHTMLtoMarkdown('a', s)).to.equal(s);
27 | });
28 |
29 | it('should replace the given tag', function() {
30 | var s, target;
31 |
32 | s = 'aaa bbb ccc ddd eee ggg hhh';
33 | target = 'aaa bbb ccc ddd eee [ggg](fff) hhh';
34 | expect(convertHTMLtoMarkdown('a', s)).to.equal(target);
35 |
36 | s = 'aaa bbb ccc ddd eee ggg hhh jjj kkk lll';
37 | target = 'aaa bbb ccc ddd eee [ggg](fff) hhh [jjj kkk](iii) lll';
38 | expect(convertHTMLtoMarkdown('a', s)).to.equal(target);
39 | });
40 | });
41 |
42 | describe('preprocessHtml', function() {
43 | var preprocessHtml = markdownRender._testExports.preprocessHtml;
44 |
45 | it ('should be okay with an empty string', function() {
46 | expect(preprocessHtml('', null).html).to.equal('');
47 | });
48 | });
49 |
50 | describe('markdownRender', function() {
51 | var userprefs = {};
52 |
53 | beforeEach(function() {
54 | userprefs = {
55 | 'math-value': null,
56 | 'math-enabled': false
57 | };
58 | });
59 |
60 | it('should be okay with an empty string', function() {
61 | expect(markdownRender(userprefs, htmlToText, marked, hljs, '', document, null)).to.equal('');
62 | });
63 |
64 | // Busted due to https://github.com/adam-p/markdown-here/issues/51, which
65 | // is busted due to https://github.com/chjj/marked/issues/56
66 | it('should NOT correctly handle links with URL text (busted due to issue #51)', function() {
67 | var s = '[http://example1.com](http://example2.com)';
68 |
69 | // Real target
70 | //var target = 'http://example1.com';
72 | expect(markdownRender(userprefs, htmlToText, marked, hljs, s, document, null)).to.contain(target);
73 | });
74 |
75 | it('should NOT quite correctly handle pre-formatted links with URL text (busted due to issue #51)', function() {
76 | var s = 'http://example2.com';
77 |
78 | // Real target
79 | //var target = 'http://example2.com';
81 | expect(markdownRender(userprefs, htmlToText, marked, hljs, s, document, null)).to.contain(target);
82 | });
83 |
84 | it('should retain pre-formatted links', function() {
85 | var s = 'aaa';
86 | expect(markdownRender(userprefs, htmlToText, marked, hljs, s, document, null)).to.contain(s);
87 | });
88 |
89 | // Test that issue #69 hasn't come back: https://github.com/adam-p/markdown-here/issues/69
90 | it('should properly render MD links that contain pre-formatted HTML links', function() {
91 | var md = '[aaa](ccc)';
92 | var html = '';
93 |
94 | var tests = [], i;
95 |
96 | // NOTE: The expected results are affected by other content massaging,
97 | // such as adding missing links schemas.
98 |
99 | // Begin tests where the link should be converted
100 |
101 | tests.push(['asdf bbb asdf',
102 | 'asdf bbb asdf
\n']);
103 |
104 | tests.push(['bbb',
105 | '\n']);
106 |
107 | tests.push(['[xxx](yyy) bbb',
108 | '\n']);
109 |
110 | tests.push(['asdf (bbb)',
111 | 'asdf (bbb)
\n']);
112 |
113 | // Begin tests where the link should *not* be converted
114 |
115 | tests.push(['asdf [yyy](bbb) asdf',
116 | 'asdf yyy asdf
\n']);
117 |
118 | tests.push(['asdf [bbb](ccc) asdf',
119 | 'asdf bbb asdf
\n']);
120 |
121 | tests.push(['[yyy](bbb)',
122 | '\n']);
123 |
124 | tests.push(['[yyy]( bbb)',
125 | '\n']);
126 |
127 | tests.push(['asdf [qwer bbb](ccc) asdf',
128 | 'asdf qwer bbb asdf
\n']);
129 |
130 | // Begin mixed tests
131 |
132 | tests.push(['asdf [aaa](bbb) asdf bbb asdf [yyy](bbb) asdf',
133 | 'asdf aaa asdf bbb asdf yyy asdf
\n']);
134 |
135 | // Begin tests that don't work quite right
136 |
137 | tests.push(['asdf [bbb] asdf',
138 | 'asdf [bbb] asdf
\n']);
139 |
140 | tests.push(['asdf ](bbb) asdf',
141 | 'asdf ](bbb) asdf
\n']);
142 |
143 | for (i = 0; i < tests.length; i++) {
144 | expect(markdownRender(userprefs, htmlToText, marked, hljs, tests[i][0], document, null)).to.equal(tests[i][1]);
145 | }
146 | });
147 |
148 | // Test issue #57: https://github.com/adam-p/markdown-here/issues/57
149 | it('should add the schema to links missing it', function() {
150 | var md = 'asdf [aaa](bbb) asdf [ccc](ftp://ddd) asdf';
151 | var target = '\n';
152 | expect(markdownRender(userprefs, htmlToText, marked, hljs, md, document, null)).to.equal(target);
153 | });
154 |
155 | it('should *not* add the schema to anchor links', function() {
156 | var md = 'asdf [aaa](#bbb) asdf [ccc](ftp://ddd) asdf';
157 | var target = '\n';
158 | expect(markdownRender(userprefs, htmlToText, marked, hljs, md, document, null)).to.equal(target);
159 | });
160 |
161 | });
162 |
163 | });
164 |
--------------------------------------------------------------------------------
/src/common/test/mocha.css:
--------------------------------------------------------------------------------
1 | @charset "utf-8";
2 |
3 | body {
4 | font: 20px/1.5 "Helvetica Neue", Helvetica, Arial, sans-serif;
5 | padding: 60px 50px;
6 | }
7 |
8 | #mocha ul, #mocha li {
9 | margin: 0;
10 | padding: 0;
11 | }
12 |
13 | #mocha ul {
14 | list-style: none;
15 | }
16 |
17 | #mocha h1, #mocha h2 {
18 | margin: 0;
19 | }
20 |
21 | #mocha h1 {
22 | margin-top: 15px;
23 | font-size: 1em;
24 | font-weight: 200;
25 | }
26 |
27 | #mocha h1 a {
28 | text-decoration: none;
29 | color: inherit;
30 | }
31 |
32 | #mocha h1 a:hover {
33 | text-decoration: underline;
34 | }
35 |
36 | #mocha .suite .suite h1 {
37 | margin-top: 0;
38 | font-size: .8em;
39 | }
40 |
41 | .hidden {
42 | display: none;
43 | }
44 |
45 | #mocha h2 {
46 | font-size: 12px;
47 | font-weight: normal;
48 | cursor: pointer;
49 | }
50 |
51 | #mocha .suite {
52 | margin-left: 15px;
53 | }
54 |
55 | #mocha .test {
56 | margin-left: 15px;
57 | overflow: hidden;
58 | }
59 |
60 | #mocha .test.pending:hover h2::after {
61 | content: '(pending)';
62 | font-family: arial;
63 | }
64 |
65 | #mocha .test.pass.medium .duration {
66 | background: #C09853;
67 | }
68 |
69 | #mocha .test.pass.slow .duration {
70 | background: #B94A48;
71 | }
72 |
73 | #mocha .test.pass::before {
74 | content: '✓';
75 | font-size: 12px;
76 | display: block;
77 | float: left;
78 | margin-right: 5px;
79 | color: #00d6b2;
80 | }
81 |
82 | #mocha .test.pass .duration {
83 | font-size: 9px;
84 | margin-left: 5px;
85 | padding: 2px 5px;
86 | color: white;
87 | -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.2);
88 | -moz-box-shadow: inset 0 1px 1px rgba(0,0,0,.2);
89 | box-shadow: inset 0 1px 1px rgba(0,0,0,.2);
90 | -webkit-border-radius: 5px;
91 | -moz-border-radius: 5px;
92 | -ms-border-radius: 5px;
93 | -o-border-radius: 5px;
94 | border-radius: 5px;
95 | }
96 |
97 | #mocha .test.pass.fast .duration {
98 | display: none;
99 | }
100 |
101 | #mocha .test.pending {
102 | color: #0b97c4;
103 | }
104 |
105 | #mocha .test.pending::before {
106 | content: '◦';
107 | color: #0b97c4;
108 | }
109 |
110 | #mocha .test.fail {
111 | color: #c00;
112 | }
113 |
114 | #mocha .test.fail pre {
115 | color: black;
116 | }
117 |
118 | #mocha .test.fail::before {
119 | content: '✖';
120 | font-size: 12px;
121 | display: block;
122 | float: left;
123 | margin-right: 5px;
124 | color: #c00;
125 | }
126 |
127 | #mocha .test pre.error {
128 | color: #c00;
129 | max-height: 300px;
130 | overflow: auto;
131 | }
132 |
133 | #mocha .test pre {
134 | display: block;
135 | float: left;
136 | clear: left;
137 | font: 12px/1.5 monaco, monospace;
138 | margin: 5px;
139 | padding: 15px;
140 | border: 1px solid #eee;
141 | border-bottom-color: #ddd;
142 | -webkit-border-radius: 3px;
143 | -webkit-box-shadow: 0 1px 3px #eee;
144 | -moz-border-radius: 3px;
145 | -moz-box-shadow: 0 1px 3px #eee;
146 | }
147 |
148 | #mocha .test h2 {
149 | position: relative;
150 | }
151 |
152 | #mocha .test a.replay {
153 | position: absolute;
154 | top: 3px;
155 | right: 0;
156 | text-decoration: none;
157 | vertical-align: middle;
158 | display: block;
159 | width: 15px;
160 | height: 15px;
161 | line-height: 15px;
162 | text-align: center;
163 | background: #eee;
164 | font-size: 15px;
165 | -moz-border-radius: 15px;
166 | border-radius: 15px;
167 | -webkit-transition: opacity 200ms;
168 | -moz-transition: opacity 200ms;
169 | transition: opacity 200ms;
170 | opacity: 0.3;
171 | color: #888;
172 | }
173 |
174 | #mocha .test:hover a.replay {
175 | opacity: 1;
176 | }
177 |
178 | #mocha-report.pass .test.fail {
179 | display: none;
180 | }
181 |
182 | #mocha-report.fail .test.pass {
183 | display: none;
184 | }
185 |
186 | #mocha-error {
187 | color: #c00;
188 | font-size: 1.5 em;
189 | font-weight: 100;
190 | letter-spacing: 1px;
191 | }
192 |
193 | #mocha-stats {
194 | position: fixed;
195 | top: 15px;
196 | right: 10px;
197 | font-size: 12px;
198 | margin: 0;
199 | color: #888;
200 | }
201 |
202 | #mocha-stats .progress {
203 | float: right;
204 | padding-top: 0;
205 | }
206 |
207 | #mocha-stats em {
208 | color: black;
209 | }
210 |
211 | #mocha-stats a {
212 | text-decoration: none;
213 | color: inherit;
214 | }
215 |
216 | #mocha-stats a:hover {
217 | border-bottom: 1px solid #eee;
218 | }
219 |
220 | #mocha-stats li {
221 | display: inline-block;
222 | margin: 0 5px;
223 | list-style: none;
224 | padding-top: 11px;
225 | }
226 |
227 | code .comment { color: #ddd }
228 | code .init { color: #2F6FAD }
229 | code .string { color: #5890AD }
230 | code .keyword { color: #8A6343 }
231 | code .number { color: #2F6FAD }
232 |
--------------------------------------------------------------------------------
/src/common/test/options-store-test.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /* jshint curly:true, noempty:true, newcap:true, eqeqeq:true, eqnull:true, es5:true, undef:true, devel:true, browser:true, node:true, evil:false, latedef:false, nonew:true, trailing:false, immed:false, smarttabs:true, expr:true */
8 | /* global describe, expect, it, before, beforeEach, after, afterEach */
9 | /* global _, $, markdownRender, htmlToText, marked, hljs, Utils, OptionsStore */
10 |
11 |
12 | describe('OptionsStore', function() {
13 | it('should exist', function() {
14 | expect(OptionsStore).to.exist;
15 | });
16 |
17 | var testKeys = ['test-option-a', 'test-option-b'];
18 |
19 | beforeEach(function(done) {
20 | OptionsStore.remove(testKeys, function() {
21 | done();
22 | });
23 | });
24 |
25 | after(function(done) {
26 | OptionsStore.remove(testKeys, function() {
27 | done();
28 | });
29 | });
30 |
31 | it('should call callback after getting', function(done) {
32 | OptionsStore.get(function() {
33 | done();
34 | });
35 | });
36 |
37 | it('should call callback after setting', function(done) {
38 | OptionsStore.set({}, function() {
39 | done();
40 | });
41 | });
42 |
43 | it('should call callback after removing', function(done) {
44 | OptionsStore.remove([], function() {
45 | done();
46 | });
47 | });
48 |
49 | it('should set and get null values', function(done) {
50 | OptionsStore.get(function(options) {
51 | expect(options).to.not.have.property(testKeys[0]);
52 |
53 | var obj = {};
54 | obj[testKeys[0]] = null;
55 |
56 | OptionsStore.set(obj, function() {
57 | OptionsStore.get(function(newOptions) {
58 | expect(newOptions).to.have.property(testKeys[0]);
59 | expect(newOptions[testKeys[0]]).to.be.null;
60 | done();
61 | });
62 | });
63 | });
64 | });
65 |
66 | it('should set and get long values', function(done) {
67 | var longString = (new Array(10*1024)).join('x');
68 |
69 | var obj = {};
70 | obj[testKeys[0]] = longString;
71 |
72 | OptionsStore.set(obj, function() {
73 | OptionsStore.get(function(newOptions) {
74 | expect(newOptions).to.have.property(testKeys[0]);
75 | expect(newOptions[testKeys[0]]).to.equal(longString);
76 | done();
77 | });
78 | });
79 | });
80 |
81 | it('should set and get objects', function(done) {
82 | OptionsStore.get(function(options) {
83 | expect(options).to.not.have.property(testKeys[0]);
84 |
85 | var obj = {};
86 | obj[testKeys[0]] = {
87 | 'aaa': 111,
88 | 'bbb': 'zzz',
89 | 'ccc': ['q', 'w', 3, 4],
90 | 'ddd': {'mmm': 'nnn'}
91 | };
92 |
93 | OptionsStore.set(obj, function() {
94 | OptionsStore.get(function(newOptions) {
95 | expect(newOptions).to.have.property(testKeys[0]);
96 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
97 | done();
98 | });
99 | });
100 | });
101 | });
102 |
103 | it('should set and get arrays', function(done) {
104 | OptionsStore.get(function(options) {
105 | expect(options).to.not.have.property(testKeys[0]);
106 |
107 | var obj = {};
108 | obj[testKeys[0]] = [1, 2, 'a', 'b', {'aa': 11}, ['q', 6]];
109 |
110 | OptionsStore.set(obj, function() {
111 | OptionsStore.get(function(newOptions) {
112 | expect(newOptions).to.have.property(testKeys[0]);
113 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
114 | expect(Array.isArray(newOptions[testKeys[0]])).to.be.true;
115 | expect(newOptions[testKeys[0]]).to.have.property('length');
116 |
117 | done();
118 | });
119 | });
120 | });
121 | });
122 |
123 | it('should remove entries', function(done) {
124 | OptionsStore.get(function(options) {
125 | expect(options).to.not.have.property(testKeys[0]);
126 |
127 | var obj = {};
128 | obj[testKeys[0]] = 'hi';
129 |
130 | OptionsStore.set(obj, function() {
131 | OptionsStore.get(function(newOptions) {
132 | expect(newOptions).to.have.property(testKeys[0]);
133 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
134 |
135 | OptionsStore.remove(testKeys[0], function() {
136 | OptionsStore.get(function(newOptions) {
137 | expect(options).to.not.have.property(testKeys[0]);
138 | done();
139 | });
140 | });
141 | });
142 | });
143 | });
144 | });
145 |
146 | it('should set and get multiple values', function(done) {
147 | OptionsStore.get(function(options) {
148 | expect(options).to.not.have.property(testKeys[0]);
149 |
150 | var obj = {};
151 | obj[testKeys[0]] = 'value the first';
152 | obj[testKeys[1]] = ['value the second'];
153 |
154 | OptionsStore.set(obj, function() {
155 | OptionsStore.get(function(newOptions) {
156 | expect(newOptions).to.have.property(testKeys[0]);
157 | expect(newOptions[testKeys[0]]).to.eql(obj[testKeys[0]]);
158 | expect(newOptions).to.have.property(testKeys[1]);
159 | expect(newOptions[testKeys[1]]).to.eql(obj[testKeys[1]]);
160 | done();
161 | });
162 | });
163 | });
164 | });
165 |
166 | describe('default value behaviour', function() {
167 | beforeEach(function() {
168 | delete OptionsStore.defaults[testKeys[0]];
169 | });
170 |
171 | after(function() {
172 | delete OptionsStore.defaults[testKeys[0]];
173 | });
174 |
175 | it('should not fill in defaults if there is not a default', function(done) {
176 | OptionsStore.get(function(options) {
177 | expect(options).to.not.have.property(testKeys[0]);
178 |
179 | done();
180 | });
181 | });
182 |
183 | it('should fill in defaults', function(done) {
184 | OptionsStore.get(function(options) {
185 | expect(options).to.not.have.property(testKeys[0]);
186 |
187 | // Set the default value (still pretty hacky)
188 | OptionsStore.defaults[testKeys[0]] = 'my default value';
189 |
190 | // Make sure we get the default value now
191 | OptionsStore.get(function(options) {
192 | expect(options).to.have.property(testKeys[0]);
193 | expect(options[testKeys[0]]).to.eql('my default value');
194 |
195 | done();
196 | });
197 | });
198 | });
199 |
200 | it('should not fill in default if value is set', function(done) {
201 | OptionsStore.get(function(options) {
202 | expect(options).to.not.have.property(testKeys[0]);
203 |
204 | // Set the default value (still pretty hacky)
205 | OptionsStore.defaults[testKeys[0]] = 'my default value';
206 |
207 | var obj = {};
208 | obj[testKeys[0]] = 'my non-default value';
209 |
210 | // But also set the value in the options
211 | OptionsStore.set(obj, function() {
212 | // Make sure we do *not* get the default value now
213 | OptionsStore.get(function(options) {
214 | expect(options).to.have.property(testKeys[0]);
215 | expect(options[testKeys[0]]).to.eql('my non-default value');
216 |
217 | done();
218 | });
219 | });
220 | });
221 | });
222 |
223 | it('should fill in default values from files', function(done) {
224 | OptionsStore.get(function(options) {
225 | expect(options).to.not.have.property(testKeys[0]);
226 |
227 | // Set a default value that requires a XHR
228 | OptionsStore.defaults[testKeys[0]] = {'__defaultFromFile__': window.location.href};
229 |
230 | // Note: Using $.ajax won't work because for local requests Firefox sets
231 | // status to 0 even on success. jQuery interprets this as an error.
232 | var xhr = new XMLHttpRequest();
233 | xhr.open('GET', window.location.href);
234 | // If we don't set the mimetype, Firefox will complain.
235 | xhr.overrideMimeType('text/plain');
236 | xhr.onreadystatechange = function() {
237 | if (this.readyState === this.DONE) {
238 | OptionsStore.get(function(options) {
239 | expect(options).to.have.property(testKeys[0]);
240 | expect(options[testKeys[0]]).to.eql(xhr.responseText);
241 | done();
242 | });
243 | }
244 | };
245 | xhr.send();
246 | });
247 | });
248 |
249 | });
250 |
251 | });
252 |
--------------------------------------------------------------------------------
/src/common/test/test-prep.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | mocha.setup('bdd');
7 | var expect = chai.expect;
--------------------------------------------------------------------------------
/src/common/test/test-run.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | $(function(){
7 | mocha
8 | // I'm not sure what introduces the global "schemaTypes", but it's not
9 | // Markdown Here and it causes an error on one of my Chrome instances.
10 | .globals([ 'schemaTypes' ]) // acceptable globals
11 | .run();
12 | });
13 |
--------------------------------------------------------------------------------
/src/common/test/utils-test.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /* jshint curly:true, noempty:true, newcap:true, eqeqeq:true, eqnull:true, es5:true, undef:true, devel:true, browser:true, node:true, evil:false, latedef:false, nonew:true, trailing:false, immed:false, smarttabs:true, expr:true */
8 | /* global describe, expect, it, before, beforeEach, after, afterEach */
9 | /* global _, $, markdownRender, htmlToText, marked, hljs, Utils */
10 |
11 |
12 | // This function wraps `htmlString` in a `` to make life easier for us.
13 | // It should affect the testing behaviour, though -- good/bad elements in a
14 | // `` are still good/bad.
15 | function createDocFrag(htmlString) {
16 | var docFrag = document.createDocumentFragment();
17 | var elem = document.createElement('div');
18 | elem.innerHTML = htmlString;
19 | docFrag.appendChild(elem);
20 | return docFrag;
21 | }
22 |
23 |
24 | describe('Utils', function() {
25 | it('should exist', function() {
26 | expect(Utils).to.exist;
27 | });
28 |
29 | describe('sanitizeDocumentFragment', function() {
30 | it('should not alter safe doc-frags', function() {
31 | var origFrag = createDocFrag('hi');
32 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
33 | expect(origFrag.isEqualNode(sanFrag)).to.be.true;
34 | });
35 |
36 | it('should remove there');
38 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
39 | expect(origFrag.isEqualNode(sanFrag)).to.be.false;
40 |
41 | var cleanFrag = createDocFrag('hithere');
42 | expect(cleanFrag.isEqualNode(sanFrag)).to.be.true;
43 | });
44 |
45 | it('should not remove safe attributes', function() {
46 | var origFrag = createDocFrag('hi');
47 | // Make sure the attributes are sticking in the original
48 | expect(origFrag.querySelector('#rad').style.color).to.equal('red');
49 |
50 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
51 | expect(origFrag.isEqualNode(sanFrag)).to.be.true;
52 | });
53 |
54 | it('should remove event handler attributes', function() {
55 | var origFrag = createDocFrag('hi');
56 | // Make sure the attributes are sticking in the original
57 | expect(origFrag.querySelector('#rad').attributes.onclick).to.exist;
58 |
59 | var sanFrag = Utils.sanitizeDocumentFragment(origFrag);
60 | expect(origFrag.isEqualNode(sanFrag)).to.be.false;
61 |
62 | var cleanFrag = createDocFrag('hi');
63 | expect(cleanFrag.isEqualNode(sanFrag)).to.be.true;
64 | });
65 | });
66 |
67 | describe('saferSetInnerHTML', function() {
68 | it('should set safe HTML without alteration', function() {
69 | var testElem = document.createElement('div');
70 | Utils.saferSetInnerHTML(testElem, 'hi
');
71 |
72 | var checkElem = document.createElement('div');
73 | checkElem.innerHTML = 'hi
';
74 |
75 | expect(testElem.isEqualNode(checkElem)).to.be.true;
76 | });
77 |
78 | it('should remove there');
81 |
82 | var checkElem = document.createElement('div');
83 | checkElem.innerHTML = 'hithere';
84 |
85 | expect(testElem.isEqualNode(checkElem)).to.be.false;
86 |
87 | var safeElem = document.createElement('div');
88 | safeElem.innerHTML = 'hithere';
89 |
90 | expect(testElem.isEqualNode(safeElem)).to.be.true;
91 | });
92 |
93 | it('should not remove safe attributes', function() {
94 | var testElem = document.createElement('div');
95 | Utils.saferSetInnerHTML(testElem, 'hi');
96 |
97 | var checkElem = document.createElement('div');
98 | checkElem.innerHTML = 'hi';
99 |
100 | expect(testElem.isEqualNode(checkElem)).to.be.true;
101 |
102 | expect(testElem.querySelector('#rad').style.color).to.equal('red');
103 | });
104 |
105 | it('should remove event handler attributes', function() {
106 | var testElem = document.createElement('div');
107 | Utils.saferSetInnerHTML(testElem, 'hi');
108 |
109 | var checkElem = document.createElement('div');
110 | checkElem.innerHTML = 'hi';
111 |
112 | expect(testElem.isEqualNode(checkElem)).to.be.true;
113 |
114 | expect(testElem.querySelector('#rad').style.color).to.equal('red');
115 | expect(testElem.querySelector('#rad').attributes.onclick).to.not.exist;
116 | });
117 |
118 | });
119 |
120 | describe('saferSetOuterHTML', function() {
121 | beforeEach(function() {
122 | // Our test container element, which will not be modified
123 | $('body').append($(''));
124 | });
125 |
126 | afterEach(function() {
127 | $('#test-container').remove();
128 | });
129 |
130 | it('should throw exception if element not in DOM', function() {
131 | var testElem = $('bye').get(0);
132 |
133 | var fn = _.partial(Utils.saferSetOuterHTML, '');
134 |
135 | expect(fn).to.throw(Error);
136 | });
137 |
138 | it('should set safe HTML without alteration', function() {
139 | Utils.saferSetOuterHTML($('#test-container').children(':first').get(0), 'hi
');
140 |
141 | expect($('#test-container').html()).to.equal('hi
');
142 | });
143 |
144 | it('should remove there');
146 |
147 | expect($('#test-container').html()).to.equal('hithere');
148 | });
149 |
150 | it('should not remove safe attributes', function() {
151 | Utils.saferSetOuterHTML($('#test-container').children(':first').get(0), 'hi');
152 |
153 | expect($('#test-container').html()).to.equal('hi');
154 | });
155 |
156 | it('should remove event handler attributes', function() {
157 | Utils.saferSetOuterHTML($('#test-container').children(':first').get(0), 'hi');
158 |
159 | expect($('#test-container').html()).to.equal('hi');
160 | });
161 |
162 | });
163 |
164 | });
--------------------------------------------------------------------------------
/src/common/utils.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | /*
7 | * Utilitiles and helpers that are needed in multiple places.
8 | */
9 |
10 | ;(function() {
11 |
12 | "use strict";
13 | /*global module:false*/
14 |
15 |
16 | // Assigning a string directly to `element.innerHTML` is potentially dangerous:
17 | // e.g., the string can contain harmful script elements. (Additionally, Mozilla
18 | // won't let us pass validation with `innerHTML` assignments in place.)
19 | // This function provides a safer way to append a HTML string into an element.
20 | function saferSetInnerHTML(parentElem, htmlString) {
21 | // Jump through some hoops to avoid using innerHTML...
22 |
23 | var range = parentElem.ownerDocument.createRange();
24 | range.selectNodeContents(parentElem);
25 |
26 | var docFrag = range.createContextualFragment(htmlString);
27 | docFrag = sanitizeDocumentFragment(docFrag);
28 |
29 | range.deleteContents();
30 | range.insertNode(docFrag);
31 | range.detach();
32 | };
33 |
34 |
35 | // Approximating equivalent to assigning to `outerHTML` -- completely replaces
36 | // the target element with `htmlString`.
37 | // Note that some caveats apply that also apply to `outerHTML`:
38 | // - The element must be in the DOM. Otherwise an exception will be thrown.
39 | // - The original element has been removed from the DOM, but continues to exist.
40 | // Any references to it (such as the one passed into this function) will be
41 | // references to the original.
42 | function saferSetOuterHTML(elem, htmlString) {
43 | if (!isElementinDocument(elem)) {
44 | throw new Error('Element must be in document');
45 | return;
46 | }
47 |
48 | var range = elem.ownerDocument.createRange();
49 | range.selectNode(elem);
50 |
51 | var docFrag = range.createContextualFragment(htmlString);
52 | docFrag = sanitizeDocumentFragment(docFrag);
53 |
54 | range.deleteContents();
55 | range.insertNode(docFrag);
56 | range.detach();
57 | };
58 |
59 |
60 | // Removes potentially harmful elements and attributes from `docFrag`.
61 | // Returns a santized copy.
62 | function sanitizeDocumentFragment(docFrag) {
63 | var i;
64 |
65 | // Don't modify the original
66 | docFrag = docFrag.cloneNode(true);
67 |
68 | var scriptTagElems = docFrag.querySelectorAll('script');
69 | for (i = 0; i < scriptTagElems.length; i++) {
70 | scriptTagElems[i].parentNode.removeChild(scriptTagElems[i]);
71 | }
72 |
73 | function cleanAttributes(node) {
74 | var i;
75 |
76 | if (typeof(node.removeAttribute) === 'undefined') {
77 | // We can't operate on this node
78 | return;
79 | }
80 |
81 | // Remove event handler attributes
82 | for (i = node.attributes.length-1; i >= 0; i--) {
83 | if (node.attributes[i].name.match(/^on/)) {
84 | node.removeAttribute(node.attributes[i].name);
85 | }
86 | }
87 | }
88 |
89 | walkDOM(docFrag.firstChild, cleanAttributes);
90 |
91 | return docFrag;
92 | }
93 |
94 |
95 | // Walk the DOM, executing `func` on each element.
96 | // From Crockform.
97 | function walkDOM(node, func) {
98 | func(node);
99 | node = node.firstChild;
100 | while(node) {
101 | walkDOM(node, func);
102 | node = node.nextSibling;
103 | }
104 | }
105 |
106 |
107 | function isElementinDocument(element) {
108 | var doc = element.ownerDocument;
109 | while (element = element.parentNode) {
110 | if (element === doc) {
111 | return true;
112 | }
113 | }
114 | return false;
115 | }
116 |
117 |
118 | // Expose these functions
119 | var Utils = {};
120 | Utils.saferSetInnerHTML = saferSetInnerHTML;
121 | Utils.saferSetOuterHTML = saferSetOuterHTML;
122 | Utils.sanitizeDocumentFragment = sanitizeDocumentFragment;
123 |
124 | var EXPORTED_SYMBOLS = ['Utils'];
125 |
126 | if (typeof module !== 'undefined') {
127 | module.exports = Utils;
128 | } else {
129 | this.Utils = Utils;
130 | this.EXPORTED_SYMBOLS = EXPORTED_SYMBOLS;
131 | }
132 |
133 | }).call(function() {
134 | return this || (typeof window !== 'undefined' ? window : global);
135 | }());
136 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/background-services-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/background-services.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2013
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /*global Components:false, AddonManager:false*/
8 | /*jshint devel:true*/
9 |
10 | /*
11 | * This file is loaded as a background script in the main window -- even in
12 | * Thunderbird, where the other background script is only loaded for compose
13 | * windows.
14 | * This provides services for supplying access to preferences and other
15 | * background-only functions.
16 | *
17 | * From: https://developer.mozilla.org/en-US/docs/Code_snippets/Interaction_between_privileged_and_non-privileged_pages
18 | *
19 | * Note that the stored prefs are returned raw (well, after being JSON parsed).
20 | * No additional processing is done, like filling in default values.
21 | */
22 |
23 |
24 | (function() {
25 |
26 | /*
27 | * Set up the background request listeners
28 | */
29 |
30 | // analogue of chrome.extension.onRequest.addListener
31 | var createRequestListener = function(eventName, responseName, callback) {
32 | // https://developer.mozilla.org/en-US/docs/Code_snippets/Interaction_between_privileged_and_non-privileged_pages?redirectlocale=en-US&redirectslug=Code_snippets%3AInteraction_between_privileged_and_non-privileged_pages#Chromium-like_messaging.3A_json_request_with_json_callback
33 |
34 | return document.addEventListener(eventName, function(event) {
35 | var node = event.target;
36 | if (!node || node.nodeType != Node.TEXT_NODE) {
37 | return;
38 | }
39 |
40 | var doc = node.ownerDocument;
41 | var data = node.nodeValue ? JSON.parse(node.nodeValue) : null;
42 |
43 | return callback(data, doc, function(response) {
44 | node.nodeValue = JSON.stringify(null);
45 | if (response) {
46 | node.nodeValue = JSON.stringify(response);
47 | }
48 |
49 | var event = doc.createEvent('HTMLEvents');
50 | event.initEvent(responseName, true, false);
51 | return node.dispatchEvent(event);
52 | });
53 | }, false, true);
54 | };
55 |
56 | var optionsRequestHandler = function(request, sender, callback) {
57 | var prefs, prefKeys, prefsObj, i;
58 |
59 | prefs = Components.classes['@mozilla.org/preferences-service;1']
60 | .getService(Components.interfaces.nsIPrefService)
61 | .getBranch('extensions.markdown-here.');
62 |
63 | if (request.action === 'get') {
64 | prefKeys = prefs.getChildList('');
65 | prefsObj = {};
66 |
67 | for (i = 0; i < prefKeys.length; i++) {
68 | try {
69 | prefsObj[prefKeys[i]] = JSON.parse(prefs.getCharPref(prefKeys[i]));
70 | }
71 | catch(e) {
72 | // Null values and empty strings will result in JSON exceptions
73 | prefsObj[prefKeys[i]] = null;
74 | }
75 | }
76 |
77 | return callback(prefsObj);
78 | }
79 | else if (request.action === 'set') {
80 | for (var key in request.obj) {
81 | prefs.setCharPref(key, JSON.stringify(request.obj[key]));
82 | }
83 |
84 | if (callback) return callback();
85 | return;
86 | }
87 | else if (request.action === 'clear') {
88 | if (typeof(request.obj) === 'string') {
89 | request.obj = [request.obj];
90 | }
91 |
92 | for (i = 0; i < request.obj.length; i++) {
93 | prefs.clearUserPref(request.obj[i]);
94 | }
95 |
96 | if (callback) return callback();
97 | return;
98 | }
99 |
100 | return alert('Error: no matching options service action');
101 | };
102 |
103 | createRequestListener(
104 | 'markdown_here-options-query',
105 | 'markdown_here-options-response',
106 | optionsRequestHandler);
107 |
108 | var tabOpenRequestHandler = function(request, sender, callback) {
109 | var url = request;
110 | openTab(url);
111 | callback();
112 | };
113 |
114 | createRequestListener(
115 | 'markdown_here-tabOpen-query',
116 | 'markdown_here-tabOpen-response',
117 | tabOpenRequestHandler);
118 |
119 |
120 | /*
121 | * In order to check if this is a new version, etc., we need some code that runs
122 | * when the application starts. In the case of Thunderbird, our regular overlay
123 | * only loads when a new message is opened, so we're going to hijack this
124 | * overlay code to add some version checks and startup code.
125 | */
126 | try {
127 | // Firefox 4 and later; Mozilla 2 and later
128 | Components.utils.import("resource://gre/modules/AddonManager.jsm");
129 | AddonManager.getAddonByID("markdown-here@adam.pritchard", function(addon) {
130 | updateHandler(addon.version);
131 | });
132 | }
133 | catch (ex) {
134 | // Firefox 3.6 and before; Mozilla 1.9.2 and before
135 | var em = Components.classes["@mozilla.org/extensions/manager;1"]
136 | .getService(Components.interfaces.nsIExtensionManager);
137 | var addon = em.getItemForID("markdown-here@adam.pritchard");
138 | updateHandler(addon.version);
139 | }
140 |
141 | function updateHandler(currVer) {
142 |
143 | // I don't know why, but getting the extension prefs -- like last-version
144 | // -- doesn't seem to work when using prefsServ and providing the full pref
145 | // name. So we need to use prefsServ to set the sync options and prefsBranch
146 | // to get and set the extension options.
147 | var prefsServ = Components.classes['@mozilla.org/preferences-service;1']
148 | .getService(Components.interfaces.nsIPrefBranch);
149 | var prefsBranch = prefsServ.getBranch('extensions.markdown-here.');
150 |
151 |
152 | var lastVersion = '';
153 | try {
154 | lastVersion = JSON.parse(prefsBranch.getCharPref('last-version'));
155 | }
156 | catch (ex) {
157 | }
158 |
159 | var localFirstRun = false;
160 | try {
161 | // No need to assign this to anything. It shouldn't exist on first run.
162 | JSON.parse(prefsBranch.getCharPref('local-first-run'));
163 | }
164 | catch (ex) {
165 | // It's only the first run if the above throws.
166 | localFirstRun = true;
167 | }
168 |
169 | prefsBranch.setCharPref('local-first-run', JSON.stringify(localFirstRun));
170 |
171 | if (currVer !== lastVersion) {
172 | prefsBranch.setCharPref('last-version', JSON.stringify(currVer));
173 |
174 | // Set the sync flags while we're at it.
175 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.main-css', true);
176 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.syntax-css', true);
177 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.last-version', true);
178 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.math-enabled', true);
179 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.math-value', true);
180 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.hotkey', true);
181 |
182 | // Don't sync this one -- local only.
183 | prefsServ.setBoolPref('services.sync.prefs.sync.extensions.markdown-here.local-first-run', false);
184 |
185 | // This is a bit dirty. If we open the new tab immediately, it will get
186 | // overwritten when session restore starts creating tabs. So we'll wait a
187 | // couple of seconds after the last tab is restored to open ours.
188 | // But we'll also have to make sure we handle the case that no tabs are
189 | // being restored.
190 |
191 | var timeoutID = null;
192 |
193 | var tabRestored = function() {
194 | var postTabRestoredOptionsOpen = function() {
195 | document.removeEventListener('SSTabRestored', tabRestored);
196 |
197 | var optionsUrl = 'resource://markdown_here_common/options.html';
198 |
199 | // If this is an upgrade, open the options page in changelist mode
200 | if (lastVersion) {
201 | optionsUrl += '?prevVer=' + lastVersion;
202 | }
203 |
204 | openTab(optionsUrl);
205 | };
206 |
207 | clearTimeout(timeoutID);
208 | timeoutID = setTimeout(postTabRestoredOptionsOpen, 2000);
209 | };
210 | timeoutID = setTimeout(tabRestored, 1);
211 | document.addEventListener('SSTabRestored', tabRestored, false);
212 | }
213 |
214 | if (localFirstRun) {
215 | installButton('nav-bar', 'toolbarButton-markdown_here');
216 |
217 | // Note that we can't add the same button to more than one toolbar.
218 | // If we wanted to add the button to the addon toolbar, we'd use this
219 | // line.
220 | // The 'addon-bar' is available since Firefox 4
221 | //installButton('addon-bar', 'toolbarButton-markdown_here');
222 | }
223 | }
224 |
225 | // From: https://developer.mozilla.org/en-US/docs/Code_snippets/Toolbar?redirectlocale=en-US&redirectslug=Code_snippets%3AToolbar#Adding_button_by_default
226 | /**
227 | * Installs the toolbar button with the given ID into the given
228 | * toolbar, if it is not already present in the document.
229 | *
230 | * @param {string} toolbarId The ID of the toolbar to install to.
231 | * @param {string} id The ID of the button to install.
232 | * @param {string} afterId The ID of the element to insert after. @optional
233 | */
234 | function installButton(toolbarId, id, afterId) {
235 | if (!document.getElementById(id)) {
236 | var toolbar, elem;
237 |
238 | toolbar = document.getElementById(toolbarId);
239 |
240 | if (!toolbar) {
241 | return;
242 | }
243 |
244 | // If no afterId is given, then append the item to the toolbar
245 | var before = null;
246 | if (afterId) {
247 | elem = document.getElementById(afterId);
248 | if (elem && elem.parentNode == toolbar) {
249 | before = elem.nextElementSibling;
250 | }
251 | }
252 |
253 | toolbar.insertItem(id, before);
254 | toolbar.setAttribute('currentset', toolbar.currentSet);
255 | document.persist(toolbar.id, 'currentset');
256 |
257 | if (toolbarId == 'addon-bar') {
258 | toolbar.collapsed = false;
259 | }
260 | }
261 | }
262 |
263 |
264 | /*
265 | * Helper to open tabs, mostly for Thunderbird and friends.
266 | */
267 | function openTab(url) {
268 | var windowMediator = Components.classes['@mozilla.org/appshell/window-mediator;1']
269 | .getService(Components.interfaces.nsIWindowMediator);
270 |
271 | if (navigator.userAgent.indexOf('Thunderbird') >= 0 ||
272 | navigator.userAgent.indexOf('Icedove') >= 0) {
273 | windowMediator.getMostRecentWindow('mail:3pane')
274 | .document.getElementById('tabmail')
275 | .openTab('contentTab', {contentPage: url});
276 | }
277 | else if (navigator.userAgent.indexOf('Postbox') >= 0) {
278 | /* Haven't yet figured out how to open a tab in Postbox */
279 | }
280 | else {
281 | var win = windowMediator.getMostRecentWindow('navigator:browser');
282 | win.gBrowser.selectedTab = win.gBrowser.addTab(url);
283 | }
284 | }
285 | })();
286 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/ff-overlay.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright Adam Pritchard 2012
3 | * MIT License : http://adampritchard.mit-license.org/
4 | */
5 |
6 | "use strict";
7 | /*global Components:false, markdownHere:false, GetCurrentEditorType:false,
8 | OptionsStore:false*/
9 | /*jshint browser:true*/
10 |
11 | /*
12 | * Firefox-specific code for responding to the context menu item and providing
13 | * rendering services.
14 | */
15 |
16 | Components.utils.import('resource://markdown_here_common/markdown-here.js');
17 |
18 |
19 | var markdown_here = {
20 |
21 | // Components.utils is somewhat more performant than mozIJSSubScriptLoader, so
22 | // we'll use it when possible. However, Components.utils usually requires
23 | // modifications to the source file, which isn't allowed for some 3rd party
24 | // code (Highlight.js, in particular) -- in that case we use mozIJSSubScriptLoader.
25 | // For details on the difference, see:
26 | // https://developer.mozilla.org/en-US/docs/Components.utils.import
27 | scriptLoader: Components.classes["@mozilla.org/moz/jssubscript-loader;1"]
28 | .getService(Components.interfaces.mozIJSSubScriptLoader),
29 |
30 | // Handle the menu-item click
31 | onMenuItemCommand: function(e) {
32 | var mdReturn, focusedElem, self = this;
33 |
34 | focusedElem = markdownHere.findFocusedElem(window.document);
35 | if (!focusedElem) {
36 | // Shouldn't happen. But if it does, just silently abort.
37 | return;
38 | }
39 |
40 | // Are we running in Thunderbird?
41 | if (typeof(GetCurrentEditorType) !== 'undefined' && GetCurrentEditorType !== null) {
42 | // Are we rich-editing?
43 | /*jshint newcap:false*/
44 | if (GetCurrentEditorType().indexOf('html') < 0) {
45 | this.alert('You are using a plain-text compose editor. You must change to a rich editor to use Markdown Here.');
46 | return;
47 | }
48 |
49 | // The focus might not be in the compose box
50 | if (!markdownHere.elementCanBeRendered(focusedElem)) {
51 | this.alert('Please put the cursor into the compose box.');
52 | return;
53 | }
54 | }
55 | else { // Firefox
56 | if (!markdownHere.elementCanBeRendered(focusedElem)) {
57 | this.alert('The selected field is not valid for Markdown rendering. Please use a rich editor.');
58 | return;
59 | }
60 | }
61 |
62 | mdReturn = markdownHere(
63 | focusedElem.ownerDocument,
64 | // We'll need the target document available later
65 | function() {
66 | self.markdownRender.apply(self, [focusedElem.ownerDocument].concat([].splice.call(arguments, 0))); },
67 | this.log);
68 |
69 | if (typeof(mdReturn) === 'string') {
70 | // Error message was returned.
71 | this.alert(mdReturn);
72 | return;
73 | }
74 | },
75 |
76 | onToolbarButtonCommand: function(e) {
77 | markdown_here.onMenuItemCommand(e);
78 | },
79 |
80 | onLoad: function() {
81 | var contextMenu, optionsStore = {};
82 |
83 | // initialization code
84 | this.initialized = true;
85 | this.strings = document.getElementById('markdown_here-strings');
86 |
87 | contextMenu = document.getElementById('contentAreaContextMenu');
88 | if (!contextMenu) contextMenu = document.getElementById('msgComposeContext');
89 | contextMenu.addEventListener('popupshowing', function (e) {
90 | markdown_here.contextMenuShowing(e);
91 | }, false);
92 |
93 | this.setupButton();
94 |
95 | // Some setup steps are dependent on options
96 | this.scriptLoader.loadSubScript('resource://markdown_here_common/options-store.js');
97 | OptionsStore.get(function(prefs) {
98 |
99 | // Register a hotkey listener
100 |
101 | function hotkeyHandler(event) {
102 | if (event.shiftKey === prefs.hotkey.shiftKey &&
103 | event.ctrlKey === prefs.hotkey.ctrlKey &&
104 | event.altKey === prefs.hotkey.altKey &&
105 | event.which === prefs.hotkey.key.toUpperCase().charCodeAt(0)) {
106 | markdown_here.onMenuItemCommand();
107 | event.preventDefault();
108 | return false;
109 | }
110 | }
111 |
112 | // Only add a listener if a key is set
113 | if (prefs.hotkey.key.length === 1) {
114 | window.addEventListener('keydown', hotkeyHandler, false);
115 | }
116 | });
117 | },
118 |
119 | contextMenuShowing: function(event) {
120 | // Hide the context menuitem if it's not on a message compose box.
121 | var focusedElem, showItem = false;
122 |
123 | // Are we running in Thunderbird?
124 | if (typeof(GetCurrentEditorType) !== 'undefined' && GetCurrentEditorType !== null) {
125 | // Always show the menu item.
126 | // If the editor isn't in rich mode, the user will get a helpful error
127 | // message telling them to change modes.
128 | showItem = true;
129 | }
130 | else { // Firefox
131 | focusedElem = markdownHere.findFocusedElem(window.document);
132 |
133 | if (!focusedElem) {
134 | showItem = false;
135 | }
136 | else if (focusedElem.type === 'textarea') {
137 | // Show the context menu item for `textarea`s. If the user clicks it,
138 | // there will be a helpful error message. This will make behaviour more
139 | // consistent with Chrome, and will hopefully help people notice that
140 | // they're not using the rich editor instead of just wondering why the
141 | // menu item just isn't showing up.
142 | showItem = true;
143 | }
144 | else {
145 | showItem = markdownHere.elementCanBeRendered(focusedElem);
146 | }
147 | }
148 |
149 | document.getElementById('context-markdown_here').hidden = !showItem;
150 | document.getElementById('context-markdown_here-separator').hidden = !showItem;
151 | },
152 |
153 | log: function(msg) {
154 | var consoleService = Components.classes['@mozilla.org/consoleservice;1']
155 | .getService(Components.interfaces.nsIConsoleService);
156 | consoleService.logStringMessage(msg);
157 | },
158 |
159 | alert: function(msg) {
160 | var prompts = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
161 | .getService(Components.interfaces.nsIPromptService);
162 | prompts.alert(null, 'Markdown Here', msg);
163 | },
164 |
165 | // The rendering service provided to the content script.
166 | // See the comment in markdown-render.js for why we do this.
167 | markdownRender: function(targetDocument, html, callback) {
168 | var markdownRender = {}, hljs = {}, marked = {}, htmlToText = {}, optionsStore = {};
169 |
170 | Components.utils.import('resource://markdown_here_common/markdown-render.js', markdownRender);
171 | Components.utils.import('resource://markdown_here_common/marked.js', marked);
172 | Components.utils.import('resource://markdown_here_common/jsHtmlToText.js', htmlToText);
173 | this.scriptLoader.loadSubScript('resource://markdown_here_common/highlightjs/highlight.js', hljs);
174 |
175 | OptionsStore.get(function(prefs) {
176 | callback(
177 | markdownRender.markdownRender(
178 | prefs,
179 | htmlToText.htmlToText,
180 | marked.marked,
181 | hljs.hljs,
182 | html,
183 | targetDocument,
184 | targetDocument.location ? targetDocument.location.href : null),
185 | prefs['main-css'] + prefs['syntax-css']);
186 | });
187 | },
188 |
189 | /*
190 | * Set up our toggle button.
191 | * Please see src/chrome/contentscript.js for more info.
192 | */
193 | setupButton: function() {
194 |
195 | // At this time, only this function differs between Chrome and Firefox.
196 | function showToggleButton(show) {
197 | var btn, tooltipString;
198 |
199 | // Page action button
200 | btn = document.getElementById('pageAction-markdown_here');
201 | if (btn) {
202 | btn.setAttribute('collapsed', !show);
203 | }
204 |
205 | // Toolbar button
206 | btn = document.getElementById('toolbarButton-markdown_here');
207 | if (btn) {
208 | var stringsBundle = document.getElementById('markdown_here-strings');
209 |
210 | if (show) {
211 | btn.removeAttribute('disabled');
212 |
213 | if (stringsBundle) {
214 | tooltipString = stringsBundle.getString('markdown_hereButton.tooltiptext');
215 | if (tooltipString) {
216 | btn.setAttribute('tooltiptext', tooltipString);
217 | }
218 | }
219 | }
220 | else {
221 | btn.setAttribute('disabled', 'true');
222 |
223 | if (stringsBundle) {
224 | tooltipString = stringsBundle.getString('markdown_hereButton.disabledtooltiptext');
225 | if (tooltipString) {
226 | btn.setAttribute('tooltiptext', tooltipString);
227 | }
228 | }
229 | }
230 | }
231 |
232 | // Zotero toolbar button
233 | btn = document.getElementById('toolbarButton-markdown_here-zotero');
234 | if (!btn) btn = document.getElementById('toolbarButton-markdown_here-zotero-pressed');
235 | if (btn) {
236 | var loc = 'resource://markdown_here_common/images/';
237 | btn.setAttribute('disabled', !show);
238 | btn.setAttribute('image', show ? (loc + "markdown.png") : (loc + "markdown-bw.png"));
239 | }
240 | }
241 |
242 | var lastElemChecked, lastRenderable;
243 | function setToggleButtonVisibility(elem) {
244 | var renderable = false;
245 |
246 | // Assumption: An element does not change renderability.
247 | if (elem === lastElemChecked) {
248 | return;
249 | }
250 | lastElemChecked = elem;
251 |
252 | if (elem && elem.ownerDocument) {
253 | // We may have gotten here via the timer, so we'll add an event handler.
254 | // Setting the event handler like this lets us better deal with iframes.
255 | // It's okay to call `addEventListener` more than once with the exact same
256 | // arguments.
257 | elem.ownerDocument.addEventListener('focus', focusChange, true);
258 |
259 | renderable = markdownHere.elementCanBeRendered(elem);
260 | }
261 |
262 | if (renderable !== lastRenderable) {
263 | showToggleButton(renderable);
264 | lastRenderable = renderable;
265 | }
266 | }
267 |
268 | // When the focus in the page changes, check if the newly focused element is
269 | // a valid Markdown Toggle target.
270 | function focusChange(event) {
271 | setToggleButtonVisibility(event.target);
272 | }
273 | window.document.addEventListener('focus', focusChange, true);
274 |
275 | // We're using a function expression rather than a function declaration
276 | // because Mozilla's automatic extension review prefers when you pass the
277 | // former to `setInterval()`.
278 | var intervalCheck = function() {
279 | var focusedElem = markdownHere.findFocusedElem(window.document);
280 | if (!focusedElem) {
281 | return;
282 | }
283 |
284 | setToggleButtonVisibility(focusedElem);
285 | };
286 | setInterval(intervalCheck, 2000);
287 | }
288 | };
289 |
290 | window.addEventListener('load', function () {
291 | markdown_here.onLoad();
292 | }, false);
293 |
294 |
295 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/ff-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
12 |
13 |
14 |
15 |
16 |
24 |
25 |
26 |
31 |
32 |
33 |
39 |
40 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/tb-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
11 |
12 |
13 |
14 |
15 |
23 |
24 |
25 |
31 |
32 |
33 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/src/firefox/chrome/content/zotero-overlay.xul:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/src/firefox/chrome/locale/en-US/overlay.dtd:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/src/firefox/chrome/locale/en-US/overlay.properties:
--------------------------------------------------------------------------------
1 | markdown_hereButton.tooltiptext=Click to toggle Markdown rendering
2 | markdown_hereButton.disabledtooltiptext=The selected field is not valid for Markdown rendering
3 |
--------------------------------------------------------------------------------
/src/firefox/chrome/skin/overlay.css:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/src/firefox/chrome/skin/overlay.css
--------------------------------------------------------------------------------
/src/firefox/chrome/skin/toolbar.css:
--------------------------------------------------------------------------------
1 | #toolbarButton-markdown_here, #composeToolbarButton-markdown_here, #formatToolbarButton-markdown_here {
2 | list-style-image: url("resource://markdown_here_common/images/icon24.png");
3 | }
4 |
5 | #toolbarButton-markdown_here[disabled="true"],
6 | #composeToolbarButton-markdown_here[disabled="true"],
7 | #formatToolbarButton-markdown_here[disabled="true"] {
8 | list-style-image: url("resource://markdown_here_common/images/icon24-bw.png");
9 | }
10 |
11 | toolbar[iconsize="small"] #toolbarButton-markdown_here,
12 | toolbar[iconsize="small"] #composeToolbarButton-markdown_here,
13 | toolbar[iconsize="small"] #formatToolbarButton-markdown_here {
14 | list-style-image: url("resource://markdown_here_common/images/icon16.png");
15 | }
16 |
17 | toolbar[iconsize="small"] #toolbarButton-markdown_here[disabled="true"],
18 | toolbar[iconsize="small"] #composeToolbarButton-markdown_here[disabled="true"],
19 | toolbar[iconsize="small"] #formatToolbarButton-markdown_here[disabled="true"] {
20 | list-style-image: url("resource://markdown_here_common/images/icon16-bw.png");
21 | }
22 |
--------------------------------------------------------------------------------
/src/firefox/defaults/preferences/prefs.js:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/src/firefox/defaults/preferences/prefs.js
--------------------------------------------------------------------------------
/src/install.rdf:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 | 2
7 | markdown-here@adam.pritchard
8 | 2.8.1
9 |
10 |
11 |
12 |
13 | {ec8030f7-c20a-464f-9b0e-13a3a9e97384}
14 | 11.0
15 | 23.*
16 |
17 |
18 |
19 |
20 |
21 |
22 | postbox@postbox-inc.com
23 | 2.0
24 | 3.*
25 |
26 |
27 |
28 |
29 |
30 |
31 | zotero@chnm.gmu.edu
32 | 3.0b1
33 | 4.*
34 |
35 |
36 |
37 |
38 |
39 |
40 | toolkit@mozilla.org
41 | 6.0
42 | 23.*
43 |
44 |
45 |
46 | Markdown Here
47 | Write your email in Markdown, then make it pretty.
48 | Adam Pritchard
49 |
50 | resource://markdown_here_common/images/icon128.png
51 | https://github.com/adam-p/markdown-here
52 |
53 |
54 | javascript:
55 | /* This is a pretty convoluted way of getting a tab to open with
56 | our options page. */
57 | var windowMediator = Components.classes['@mozilla.org/appshell/window-mediator;1']
58 | .getService(Components.interfaces.nsIWindowMediator);
59 | var optionsUrl = 'resource://markdown_here_common/options.html';
60 | if (navigator.userAgent.indexOf('Thunderbird') >= 0 ||
61 | navigator.userAgent.indexOf('Icedove') >= 0) {
62 | windowMediator.getMostRecentWindow('mail:3pane')
63 | .document.getElementById('tabmail')
64 | .openTab('contentTab', {contentPage: optionsUrl});
65 | }
66 | else if (navigator.userAgent.indexOf('Postbox') >= 0) {
67 | /* Haven't yet figured out how to open a tab in Postbox */
68 | var prompts = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
69 | .getService(Components.interfaces.nsIPromptService);
70 | prompts.alert(null, 'Markdown Here', 'Sorry, the options page is not supported for Postbox.');
71 | }
72 | /*else {
73 | var win = windowMediator.getMostRecentWindow('navigator:browser');
74 | win.gBrowser.selectedTab = win.gBrowser.addTab(optionsUrl);
75 | }*/
76 | /* Close the stub prefs dialog that will have opened. */
77 | window.close();
78 |
79 |
80 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/src/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "manifest_version": 2,
3 | "name": "Markdown Here",
4 | "version": "2.8.1",
5 | "description": "Write your email in Markdown, then make it pretty.",
6 | "homepage_url": "http://markdown-here.com",
7 | "minimum_chrome_version": "6",
8 | "icons": {
9 | "16": "common/images/icon16.png",
10 | "32": "common/images/icon32.png",
11 | "48": "common/images/icon48.png",
12 | "128": "common/images/icon128.png",
13 | "512": "common/images/icon512.png"
14 | },
15 | "permissions": ["contextMenus", "storage"],
16 | "background": {"page": "chrome/background.html"},
17 | "content_scripts": [
18 | {
19 | "matches": [""],
20 | "js": ["common/utils.js", "common/markdown-here.js", "chrome/contentscript.js"]
21 | }
22 | ],
23 | "browser_action": {
24 | "default_icon": "common/images/icon38.png",
25 | "default_title": "Markdown Toggle"
26 | },
27 | "options_page": "common/options.html"
28 | }
29 |
--------------------------------------------------------------------------------
/store-assets/amo-reviewer-notes.txt:
--------------------------------------------------------------------------------
1 | This extension is used to manipulate the content of email before sending. It can be used in Gmail, Hotmail, or Yahoo webmail interfaces, or in Thunderbird. Make sure you use the rich-edit interface for the email client.
2 |
3 | You write email in Markdown (if you're not familiar with Markdown, I made a little reference -- https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet), then right-click, click the "Markdown Toggle" menu item, and the content of the email will be replaced with a rendered-HTML version of the Markdown you had written.
4 |
5 | If you select a subset of your email and then "Markdown Toggle", only that selection will be rendered/converted.
6 |
7 | The Markdown is "Github-flavored". Syntax highlighting is supported. So, for example, you can use fenced code blocks with the language name specified, like so:
8 |
9 | ```javascript
10 | var i = 0;
11 | ```
12 |
13 | For complete info, see the project page: https://github.com/adam-p/markdown-here
14 |
15 | Please don't hesitate to contact me with questions.
16 |
17 |
18 | A more formal test methodology, if desired:
19 |
20 | 1. Go into your webmail of choice, or Thunderbird. Make sure rich editing is enabled.
21 |
22 | 2. Write a bit of Markdown. (I'll include some at the bottom of this that you can paste, if you want. Make sure to paste as plaintext.)
23 |
24 | 3. Right-click and choose "Markdown Toggle".
25 |
26 | Test #1: The entire email should be converted to HTML, in accordance with Markdown syntax. The sample MD should have H1, H3, UL, and PRE/CODE elements, with some bold and code inline.
27 |
28 | 4. Right-click again and choose "Markdown Toggle".
29 |
30 | Test #2: The email email should be reverted back the original raw Markdown.
31 |
32 | 5. Select a few lines (but don't split the code block). Then right-click and choose "Markdown Toggle".
33 |
34 | Test #3: Only the selected lines should be rendered to HTML.
35 |
36 | 6. Right-click again and choose "Markdown Toggle".
37 |
38 | Test #4: The email should be reverted back to original Markdown.
39 |
40 | 7. Render the email again (either entirely or partially) and send it (to yourself or someone else).
41 |
42 | Test #5: The recipient of the email should see it pretty much as it was before you sent it.
43 |
44 | Test done.
45 |
46 |
47 | Caveat: Hotmail is a little flaky. Gmail and Thunderbird are the only first-class targets. Details: https://github.com/adam-p/markdown-here#compatibility
48 |
49 |
50 | A few secondary features that can be tested if desired:
51 |
52 | - Options: Should open after installation (and restart). Should open after upgrade. Should auto-save. Should sync settings.
53 | - Signatures should be excluded from the conversion. Sigs must be preceded by the standard-ish '-- ' (note the trailing space).
54 | - Images embedded in the email before conversion (Gmail and Thunderbird) should be retained by the conversion.
55 | - Quoted reply text should be excluded by the conversion.
56 | - TeX mathematical formulae should be rendered if and only if that functionality is enabled in the options.
57 |
58 |
59 | ---
60 |
61 | # Markdown Sample (H1)
62 |
63 | ### Smaller header (H3)
64 |
65 | * Bullet **with bold**
66 | * Bullet with `inline code`
67 |
68 | ```javascript
69 | var s = 'code block';
70 | console.log(s);
71 | ```
72 |
73 | This is the quadratic equation in TeX (rendered if enabled):
74 | $-b \pm \sqrt{b^2 - 4ac} \over 2a$
75 |
--------------------------------------------------------------------------------
/store-assets/description.txt:
--------------------------------------------------------------------------------
1 | Markdown Here lets you write email in Markdown and render it (make it pretty!) before sending.
2 |
3 | This is great for anyone who doesn't like fiddling around with formatting buttons while writing an email. It's especially good for programmers who write email with code in them -- it even supports syntax highlighting. And for the mathematicians among us: Markdown Here will render TeX formulae as well.
4 |
5 | Totally simple to use:
6 | 1. Write your email in your email client's rich editor using Github-flavoured Markdown.
7 | 2. Right-click in the compose area and then click "Markdown Toggle".
8 | 3. Your email is now pretty! (That is, it's been rendered to HTML.)
9 | 4. If you like the way it looks, just send it. If you want to change or add something, click "Markdown Toggle" again to get back to your original Markdown. Rinse and repeat.
10 |
11 | If only part of your email is Markdown, then select the part you want to render into pretty HTML, right click, and click "Markdown Toggle". Only your selection will be converted. To revert back to the original Markdown, right click in the rendered block and click "Markdown Toggle" again.
12 |
13 | Markdown Here is primarily targeted to work with Gmail and Thunderbird, but it also works pretty well with Yahoo and Hotmail. Additionally, it works great with Google Groups and pretty well with Evernote's web interface.
14 |
15 | Syntax highlighting note: Used fenced code blocks and specify the language name. See the project page for an example.
16 |
17 | Privacy: Markdown Here accesses and modifies the content of your email. It can, in theory, access other web content, but does not. It also makes no Internet requests itself whatsoever. You data is modified when and where you choose, and does not leave your browser.
18 |
19 | Available as a Chrome, Firefox, Safari, and Thunderbird extension.
20 |
21 | This is an open source project. Visit Markdown Here's Github page for full instructions, more information, bug reports, or to contribute.
22 |
23 | http://markdown-here.com
24 | https://github.com/adam-p/markdown-here
25 |
--------------------------------------------------------------------------------
/store-assets/dos-equis-MDH.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/dos-equis-MDH.jpg
--------------------------------------------------------------------------------
/store-assets/markdown-here-chrome-options.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-chrome-options.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-chrome-options.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-chrome-options.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/markdown-here-image1.425x265.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image1.425x265.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-image1.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image1.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-image1.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image1.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/markdown-here-image2.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image2.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-image2.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-image2.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/markdown-here-promo-small.gimp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-promo-small.gimp.png
--------------------------------------------------------------------------------
/store-assets/markdown-here-promo-small.gimp.xcf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlegewie/markdown-here/8b97a0b83594864fb8a05b165c955e44fd678840/store-assets/markdown-here-promo-small.gimp.xcf
--------------------------------------------------------------------------------
/store-assets/md-for-screenshot.md:
--------------------------------------------------------------------------------
1 | ## Sweet Screenshot Markdown
2 |
3 | *Markdown Here* is a Google Chrome, Firefox, and Thunderbird extension that lets you write email in Markdown and render it before sending.
4 |
5 | * Markdown is **cool**. Put `code inline`.
6 | * Link to stuff, like [this project](https://github.com/adam-p/markdown-here).
7 | * Ordered, you say? **And** a sub-list?
8 | 1. Done.
9 | 2. And done.
10 |
11 | Actual review quote:
12 |
13 | > Does exactly what I need it to do. Markdown support in email without getting in the way.
14 |
15 | ### Syntax highlighting: super rad
16 |
17 | Some JavaScript:
18 |
19 | ```javascript
20 | alert('Hello Markdown');
21 | ```
22 |
23 | How about an unusual example -- a diff:
24 |
25 | ```diff
26 | diff --git a/src/common/markdown-here.js b/src/common/markdown-here.js
27 | index 24dcb97..20c36a1 100644
28 | --- a/src/common/markdown-here.js
29 | +++ b/src/common/markdown-here.js
30 | @@ -201,12 +179,14 @@ function makeStylesExplicit(wrapperElem, css) {
31 | - applyStyleToElement(rule.style, selectorMatches[j]);
32 | + styleAttr = selectorMatches[j].getAttribute('style') || '';
33 | + styleAttr += rule.style.cssText;
34 | + selectorMatches[j].setAttribute('style', styleAttr);
35 | ```
36 |
37 |
--------------------------------------------------------------------------------
/test/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 | Markdown Here Test
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
21 |
22 |
29 |
30 |
31 |
32 |
--------------------------------------------------------------------------------