1 # Copyright 2015 Jason Woofenden
2 # This file implements an WYSIWYG editor in the browser (no contenteditable)
4 # This program is free software: you can redistribute it and/or modify it under
5 # the terms of the GNU Affero General Public License as published by the Free
6 # Software Foundation, either version 3 of the License, or (at your option) any
9 # This program is distributed in the hope that it will be useful, but WITHOUT
10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 # FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 timeout = (ms, cb) -> return setTimeout cb, ms
22 # xml 1.0 spec, chromium and firefox accept these, plus lots of unicode chars
23 valid_attr_regex = new RegExp '^[a-zA-Z_:][-a-zA-Z0-9_:.]*$'
24 # html5 spec is much more lax, but chromium won't let me make at attribute with the name "4"
25 js_attr_regex = new RegExp '^[oO][nN].'
27 debug_dot_at = (doc, x, y) ->
29 el = doc.createElement 'div'
30 el.setAttribute 'style', "position: absolute; left: #{x}px; top: #{y}px; width: 1px; height: 3px; background-color: red"
31 doc.body.appendChild el
32 #console.log(new Error().stack)
34 # text nodes don't have getBoundingClientRect(), so use selection api to find
36 get_el_bounds = (el) ->
37 if el.getBoundingClientRect?
38 rect = el.getBoundingClientRect()
40 # text nodes don't have getBoundingClientRect(), so use range api
41 range = el.ownerDocument.createRange()
42 range.selectNodeContents el
43 rect = range.getBoundingClientRect()
44 doc = el.ownerDocument.documentElement
45 win = el.ownerDocument.defaultView
46 y_fix = win.pageYOffset - doc.clientTop
47 x_fix = win.pageXOffset - doc.clientLeft
51 w: rect.width ? (rect.right - rect.left)
52 h: rect.height ? (rect.top - rect.bottom)
55 is_display_block = (el) ->
57 return el.currentStyle.display is 'block'
59 return window.getComputedStyle(el, null).getPropertyValue('display') is 'block'
61 # Pass return value from dom event handlers to this.
62 # If they return false, this will addinionally stop propagation and default.
63 event_return = (e, bool) ->
70 # Warning: currently assumes you're asking about a single character
71 # Note: chromium returns multiple bounding rects for a space at a line-break
72 # Note: chromium's getBoundingClientRect() is broken (when zero-area client rects)
73 # Note: sometimes returns null (eg for whitespace that is not visible)
74 text_range_bounds = (el, start, end) ->
75 range = document.createRange()
76 range.setStart el, start
78 rects = range.getClientRects()
83 doc = el.ownerDocument.documentElement
84 win = el.ownerDocument.defaultView
85 y_fix = win.pageYOffset - doc.clientTop
86 x_fix = win.pageXOffset - doc.clientLeft
90 w: rect.width ? (rect.right - rect.left)
91 h: rect.height ? (rect.top - rect.bottom)
93 bounding: range.getBoundingClientRect()
96 # figure out the x/y coordinates of where the cursor should be if it's at
97 # position ``i`` within text node ``n``
98 # sometimes returns null (eg for whitespace that is not visible)
99 window.cursor_to_xyh = cursor_to_xyh = (n, i) ->
100 range = document.createRange()
101 if n.text.length is 0
102 ret = text_range_bounds n.el, 0, 0
103 else if i is n.text.length
104 ret = text_range_bounds n.el, i - 1, i
108 ret = text_range_bounds n.el, i, i + 1
110 debug_dot_at n.el.ownerDocument, ret.x, ret.y
113 # encode text so it can be safely placed inside an html attribute
114 enc_attr_regex = new RegExp '(&)|(")|(\u00A0)', 'g'
116 return txt.replace enc_attr_regex, (match, amp, quote) ->
117 return '&' if (amp)
118 return '"' if (quote)
120 enc_text_regex = new RegExp '(&)|(<)|(\u00A0)', 'g'
122 return txt.replace enc_text_regex, (match, amp, lt) ->
123 return '&' if (amp)
124 return '<' if (lt)
144 # TODO make these always pretty-print (on the inside) like blocks
145 no_text_elements = { # these elements never contain text
155 domify = (doc, hash) ->
156 for tag, attrs of hash
158 return document.createTextNode attrs
159 el = document.createElement tag
168 outer_css = (args) ->
171 inner_padding = args.inner_padding ? overlay_padding
172 frame_width = args.frame_width ? inner_padding
173 # TODO editor controls height...
174 occupy = (left, top = left, right = left, bottom = top) ->
177 return Math.max(left, top, right, bottom)
184 ret += "border: #{occupy 1}px solid black;"
185 ret += "padding: #{occupy frame_width}px;"
188 ret += "border: #{occupy 1}px solid black;"
189 ret += "padding: #{occupy inner_padding}px;"
190 ret += "padding-right: #{inner_padding + occupy 0, 0, 15, 0}px;" # for scroll bar
191 ret += "width: #{w}px;"
192 ret += "height: #{h}px;"
193 ret += 'overflow-x: hidden;'
194 ret += 'overflow-y: scroll;'
197 ret += 'position: relative;'
198 ret += "width: #{w}px;"
199 ret += "min-height: #{h}px;"
202 ret += 'box-sizing: border-box;'
204 ret += 'border: none;'
206 ret += "width: #{w}px;"
207 #ret += "height: #{h}px;" # height auto-set when content set/changed
208 ret += '-ms-user-select: none;'
209 ret += '-webkit-user-select: none;'
210 ret += '-moz-user-select: none;'
211 ret += 'user-select: none;'
214 ret += 'position: absolute;'
215 ret += "left: -#{inner_padding}px;"
216 ret += "top: -#{inner_padding}px;"
217 ret += "right: -#{inner_padding}px;"
218 ret += "bottom: -#{inner_padding}px;"
219 ret += 'overflow: hidden;'
222 ret += 'position: absolute;'
223 ret += 'background: rgba(100,100,100,0.2);'
226 ret += 'position: absolute;'
227 ret += 'height: 1em;' # FIXME adjust for hight of text
229 ret += 'background: #444;'
230 ret += '-webkit-animation: blink 1s steps(2, start) infinite;'
231 ret += 'animation: blink 1s steps(2, start) infinite;'
233 ret += '@-webkit-keyframes blink {'
234 ret += 'to { visibility: hidden; }'
236 ret += '@keyframes blink {'
237 ret += 'to { visibility: hidden; }'
241 ret += 'position: absolute;'
242 ret += 'border: 1px solid rgba(0,0,0,0.1);'
243 ret += 'outline: 1px solid rgba(255,255,255,0.1);' # in case there's a black background
246 ret += 'z-index: 10;'
247 ret += 'position: absolute;'
248 ret += 'font-size: 8px;'
249 ret += 'white-space: pre;'
250 ret += 'background: rgba(255,255,255,0.4);'
257 '20': true # capslock
259 '144': true # numlock
261 '91': true # windows "start" key
262 # key codes: (valid on keydown, not keypress)
267 KEY_BACKSPACE = 8 # <--
268 KEY_DELETE = 46 # -->
277 control_key_codes = # we react to these, but they aren't typing
293 instantiate_tree = (tree, parent) ->
298 c.el = parent.ownerDocument.createTextNode c.text
299 parent.appendChild c.el
301 if c.name in ['script', 'object', 'iframe', 'link']
302 # TODO put placeholders instead
305 # TODO create in correct namespace
306 c.el = parent.ownerDocument.createElement c.name
308 # FIXME if attr_whitelist[k]?
309 if valid_attr_regex.test k
310 unless js_attr_regex.test k
311 c.el.setAttribute k, v
312 parent.appendChild c.el
314 instantiate_tree c.children, c.el
318 traverse_tree = (tree, cb) ->
324 done = traverse_tree c.children, cb
328 find_next_cursor_position = (tree, n, i) ->
329 if n.type is 'text' and n.text.length > i
330 orig_xyh = cursor_to_xyh n, i
332 console.log "ERROR: couldn't find xy for current cursor location"
334 for next_i in [i+1 .. n.text.length] # inclusive is valid (after last char)
335 next_xyh = cursor_to_xyh n, next_i
337 if next_xyh.x > orig_xyh.x or next_xyh.y > orig_xyh.y
341 traverse_tree tree, (node, state) ->
342 if node.type is 'text' and state_before is false
343 if cursor_to_xyh(node, 0)?
353 find_prev_cursor_position = (tree, n, i) ->
354 if n? and n.type is 'text' and i > 0
355 orig_xyh = cursor_to_xyh n, i
357 console.log "ERROR: couldn't find xy for current cursor location"
359 for prev_i in [i-1 .. 0]
360 prev_xyh = cursor_to_xyh n, prev_i
362 if prev_xyh.x < orig_xyh.x or prev_xyh.y < orig_xyh.y
367 traverse_tree tree, (node) ->
368 if node.type is 'text'
376 if cursor_to_xyh found, found.text.length # text visible?
377 return [found, found.text.length]
378 return find_prev_cursor_position tree, found, 0
381 find_loc_cursor_position = (tree, loc) ->
383 if c.type is 'tag' or c.type is 'text'
384 bounds = get_el_bounds c.el
385 continue if loc.x < bounds.x
386 continue if loc.x > bounds.x + bounds.w
387 continue if loc.y < bounds.y
388 continue if loc.y > bounds.y + bounds.h
390 ret = find_loc_cursor_position c.children, loc
393 # click is within bounding box that contains all text.
394 return [c, 0] if c.text.length is 0
396 before = cursor_to_xyh c, before_i
398 console.log "error: failed to find cursor pixel location for start of", c
400 after_i = c.text.length
401 after = cursor_to_xyh c, after_i
403 console.log "error: failed to find cursor pixel location for end of", c
405 if loc.y < before.y + before.h and loc.x < before.x
406 # console.log 'before first char on first line'
408 if loc.y > after.y and loc.x > after.x
409 # console.log 'after last char on last line'
412 console.log "Warning: click in bounding box but above first line"
413 continue # above first line (runaround?)
414 if loc.y > after.y + after.h
415 console.log "Warning: click in bounding box but below last line", loc.y, after.y, after.h
416 continue # below last line (shouldn't happen?)
417 while after_i - before_i > 1
418 cur_i = Math.round((before_i + after_i) / 2)
419 cur = cursor_to_xyh c, cur_i
421 console.log "error: failed to find cursor pixel location for", c, cur_i
423 if loc.y < cur.y or (loc.y <= cur.y + cur.h and loc.x < cur.x)
429 # which one is closest?
430 if Math.abs(before.x - loc.x) < Math.abs(after.x - loc.x)
436 # browsers collapse these (html5 spec calls these "space characters")
437 is_space_code = (char_code) ->
439 when 9, 10, 12, 13, 32
443 return is_space_code chr.charCodeAt 0
445 tree_remove_empty_text_nodes = (tree) ->
447 traverse_tree tree, (n) ->
449 if n.text.length is 0
453 # don't completely empty the tree
455 if tree[0].type is 'text'
456 console.log "oop, leaving a blank node because it's the only thing"
458 n.el.parentNode.removeChild n.el
459 for c, i in n.parent.children
461 n.parent.children.splice i, 1
464 # pass a array of nodes (from parser library, ie it should have .el and .text)
465 tree_dedup_space = (tree) ->
466 prev = cur = next = null
467 prev_i = cur_i = next_i = 0
468 prev_pos = pos = next_pos = null
469 prev_px = cur_px = next_px = null
473 tree_remove_empty_text_nodes(tree)
475 iterate = (tree, cb) ->
479 while i < n.text.length # don't foreach, cb might remove chars
484 block = is_display_block n.el
487 if n.children.length > 0
488 iterate n.children, cb
493 removed_char = cur.text.charAt(cur_i)
494 cur.el.textContent = cur.text = (cur.text.substr 0, cur_i) + (cur.text.substr cur_i + 1)
495 if next is cur # in same text node
497 throw "how is this possible?"
502 cur.el.textContent = cur.text = (cur.text.substr 0, cur_i) + removed_char + (cur.text.substr cur_i)
503 if next is cur # in same text node
506 # return true if cur was removed from the dom (ie re-use same prev)
508 # cur definitately set
509 # prev and/or next might be null, indicating the start/end of a display:block
510 return false unless is_space_code cur.text.charCodeAt cur_i
511 bounds = text_range_bounds cur.el, cur_i, cur_i + 1
513 # 1. zero rects returned by getClientRects() means collapsed space
516 # 2. width greater than zero means visible space
519 # now the weird edge cases...
521 # firefox and chromium both report zero width for characters at the end
522 # of a line where the text wraps (automatically, due to word-wrap) to
523 # the next line. These do not appear to be distinguishable from
524 # collapsed spaces via the range/bounds api, so...
526 # remove it from the dom, and if prev or next moves, put it back.
527 if prev? and not prev_px?
528 prev_px = cursor_to_xyh prev, prev_i
529 if next? and not next_px?
530 next_px = cursor_to_xyh next, next_i
531 #if prev is null and next is null
532 # parent_px = cur.parent.el.getBoundingClientRect()
536 new_prev_px = cursor_to_xyh prev, prev_i
537 if new_prev_px.x isnt prev_px.x or new_prev_px.y isnt prev_px.y
540 console.log "this shouldn't happen, we remove spaces that don't locate"
543 new_next_px = cursor_to_xyh next, next_i
544 if new_next_px.x isnt next_px.x or new_next_px.y isnt next_px.y
547 # console.log "removing space becase space after it is collapsed"
549 # pass null at start/end of display:block
557 # don't advance (to the next character next time) if we removed a
558 # character from the same text node as ``next``, because doing so
559 # renumbers the indexes in that string
560 if removed and cur is next
576 tree_remove_empty_text_nodes(tree)
578 class PeachHTML5Editor
579 # Options: (all optional)
580 # editor_id: "id" attribute for outer-most element created by/for editor
581 # on_init: callback for when the editable content is in place
582 constructor: (in_el, options) ->
583 @options = options ? {}
587 @inited = false # when iframes have loaded
588 @outer_iframe # iframe to hold editor
589 @outer_idoc # "document" object for @outer_iframe
590 @wrap2 = null # scrollbar is on this
591 @iframe = null # iframe to hold editable content
592 @idoc = null # "document" object for @iframe
595 @cursor_visible = false
596 @iframe_offset = null
597 opt_fragment = @options.fragment ? true
600 @parser_opts.fragment = 'body'
602 @outer_iframe = domify document, iframe: {}
603 outer_iframe_style = 'border: none !important; margin: 0 !important; padding: 0 !important; height: 100% !important; width: 100% !important;'
604 if @options.editor_id?
605 @outer_iframe.setAttribute 'id', @options.editor_id
606 @outer_iframe.onload = =>
607 @outer_idoc = @outer_iframe.contentDocument
608 icss = domify @outer_idoc, style: children: [
609 domify @outer_idoc, text: css
611 @outer_idoc.head.appendChild icss
612 @iframe = domify @outer_idoc, iframe: {}
615 setTimeout (=> @init() unless @inited), 200 # firefox never fires this onload
616 @outer_idoc.body.appendChild(
617 domify @outer_idoc, div: id: 'wrap1', children: [
618 @wrap2 = domify @outer_idoc, div: id: 'wrap2', children: [
619 domify @outer_idoc, div: id: 'wrap3', children: [
621 @overlay = domify @outer_idoc, div: id: 'overlay'
626 outer_wrap = domify document, div: class: 'peach_html5_editor'
627 @in_el.parentNode.appendChild outer_wrap
628 outer_bounds = get_el_bounds outer_wrap
629 if outer_bounds.w < 300
631 if outer_bounds.h < 300
633 outer_iframe_style += "width: #{outer_bounds.w}px; height: #{outer_bounds.h}px;"
634 @outer_iframe.setAttribute 'style', outer_iframe_style
635 css = outer_css w: outer_bounds.w, h: outer_bounds.h
636 outer_wrap.appendChild @outer_iframe
637 init: -> # called by @iframe's onload (or timeout on firefox)
638 @idoc = @iframe.contentDocument
639 @overlay.onclick = (e) =>
640 return event_return e, @onclick e
641 @overlay.ondoubleclick = (e) =>
642 return event_return e, @ondoubleclick e
643 @outer_idoc.body.onkeyup = (e) =>
644 return event_return e, @onkeyup e
645 @outer_idoc.body.onkeydown = (e) =>
646 return event_return e, @onkeydown e
647 @outer_idoc.body.onkeypress = (e) =>
648 return event_return e, @onkeypress e
649 if @options.stylesheet
651 @idoc.head.appendChild domify @idoc, style: src: @options.stylesheet
652 @load_html @in_el.value
656 overlay_event_to_inner_xy: (e) ->
657 unless @iframe_offset?
658 @iframe_offset = get_el_bounds @iframe
659 x = e.pageX # TODO ?cross-browserify
660 y = e.pageY + @wrap2.scrollTop # TODO ?cross-browserify
661 # TODO adjust for scrolling
662 return x: x - @iframe_offset.x, y: y - @iframe_offset.y
664 xy = @overlay_event_to_inner_xy e
665 new_cursor = find_loc_cursor_position @tree, xy
667 @move_cursor new_cursor
671 ondoubleclick: (e) ->
675 return false if ignore_key_codes[e.keyCode]?
676 #return false if control_key_codes[e.keyCode]?
679 return false if ignore_key_codes[e.keyCode]?
680 #return false if control_key_codes[e.keyCode]?
684 new_cursor = find_prev_cursor_position @tree, @cursor...
686 @move_cursor new_cursor
689 new_cursor = find_next_cursor_position @tree, c, -1
691 @move_cursor new_cursor
698 new_cursor = find_next_cursor_position @tree, @cursor...
700 @move_cursor new_cursor
703 new_cursor = find_prev_cursor_position @tree, c, -1
705 @move_cursor new_cursor
713 return false unless @cursor?
714 return false unless @cursor[1] > 0
715 @cursor[0].text = @cursor[0].text.substr(0, @cursor[1] - 1) + @cursor[0].text.substr(@cursor[1])
716 @cursor[0].el.nodeValue = @cursor[0].text
717 @move_cursor [@cursor[0], @cursor[1] - 1]
721 return false unless @cursor?
722 return false unless @cursor[1] < @cursor[0].text.length
723 @cursor[0].text = @cursor[0].text.substr(0, @cursor[1]) + @cursor[0].text.substr(@cursor[1] + 1)
724 @cursor[0].el.nodeValue = @cursor[0].text
725 @move_cursor [@cursor[0], @cursor[1]]
744 return false if ignore_key_codes[e.keyCode]?
745 # return false if control_key_codes[e.keyCode]? # handled in keydown
746 char = e.charCode ? e.keyCode
748 char = String.fromCharCode char
750 @cursor[0].text = char + @cursor[0].text
751 else if @cursor[1] is @cursor[0].text.length - 1
752 @cursor[0].text += char
755 @cursor[0].text.substr(0, @cursor[1]) +
757 @cursor[0].text.substr(@cursor[1])
758 @cursor[0].el.nodeValue = @cursor[0].text
759 @move_cursor [@cursor[0], @cursor[1] + 1]
762 clear_dom: -> # remove all the editable content (and cursor, overlays, etc)
763 while @idoc.body.childNodes.length
764 @idoc.body.removeChild @idoc.body.childNodes[0]
768 @tree = peach_parser.parse html, @parser_opts
770 instantiate_tree @tree, @idoc.body
771 tree_dedup_space @tree
774 @in_el.onchange = null
775 @in_el.value = @pretty_html @tree
777 @load_html @in_el.value
778 @iframe.style.height = "0"
779 @iframe.style.height = "#{@idoc.body.scrollHeight}px"
780 kill_cursor: -> # remove it, forget where it was
782 @cursor_el.parentNode.removeChild @cursor_el
783 @cursor_visible = false
786 move_cursor: (cursor) ->
787 loc = cursor_to_xyh cursor[0], cursor[1]
789 console.log "error: tried to move cursor to position that has no pixel location", cursor[0], cursor[1]
792 # replace cursor element, to reset blink animation
794 @cursor_el.parentNode.removeChild @cursor_el
795 @cursor_el = domify @outer_idoc, div: id: 'cursor'
796 @overlay.appendChild @cursor_el
797 @cursor_visible = true
798 @cursor_el.style.left = "#{loc.x + overlay_padding - 1}px"
803 @cursor_el.style.top = "#{loc.y + overlay_padding + Math.round(height * .07)}px"
804 @cursor_el.style.height = "#{Math.round height * 0.82}px"
807 while @matting.length > 0
808 @overlay.removeChild @matting[0]
811 prev_bounds = x: 0, y: 0, w: 0, h: 0
817 bounds = get_el_bounds n.el
818 return unless bounds?
819 if bounds.x is prev_bounds.x and bounds.y is prev_bounds.y and bounds.w is prev_bounds.w and bounds.h is prev_bounds.h
822 matt = domify @outer_idoc, div: class: 'ann_box', style: "left: #{bounds.x - 1 + overlay_padding}px; top: #{bounds.y - 2 + overlay_padding}px; width: #{bounds.w}px; height: #{bounds.h}px" # outline: 1000px solid rgba(0,153,255,#{alpha});
823 @overlay.appendChild matt
825 ann = domify @outer_idoc, div: class: 'ann_tag', style: "left: #{bounds.x + 1 + overlay_padding}px; top: #{bounds.y - 7 + overlay_padding}px", children: [domify @outer_idoc, text: " #{n.name} "]
826 @overlay.appendChild ann
830 pretty_html: (tree, indent = '', parent_flags = pre_ish: false, block: true, want_nl: false) ->
832 want_nl = parent_flags.want_nl
833 prev_in_flow_is_text = false
834 prev_in_flow_is_block = false
837 inner_flags = want_nl: true
844 if n.el.currentStyle?
845 cs = n.el.currentStyle
846 whitespace = cs['white-space']
847 display = cs['display']
848 position = cs['position']
851 cs = @iframe.contentWindow.getComputedStyle(n.el, null)
852 whitespace = cs.getPropertyValue 'white-space'
853 display = cs.getPropertyValue 'display'
854 position = cs.getPropertyValue 'position'
855 float = cs.getPropertyValue 'float'
856 if n.name is 'textarea'
857 inner_flags.pre_ish = true
859 inner_flags.pre_ish = whitespace.substr(0, 3) is 'pre'
865 when 'absolute', 'fixed'
868 if 'display' is 'none'
873 when 'inline', 'none'
874 inner_flags.block = false
875 is_block = in_flow_block = false
877 inner_flags.block = true
878 is_block = in_flow_block = false
879 else # block, table, etc
880 inner_flags.block = true
882 in_flow_block = in_flow
887 in_flow_block = false
888 else # 'comment', 'doctype'
892 in_flow_block = false
893 # print whitespace if we can
894 unless parent_flags.pre_ish
895 unless prev_in_flow_is_text and is_br
896 if (i is 0 and parent_flags.block) or in_flow_block or prev_in_flow_is_block
909 if n.attrs[k].length > 0
910 ret += "=\"#{enc_attr n.attrs[k]}\""
912 unless void_elements[n.name]?
914 next_indent = indent + ' '
918 ret += @pretty_html n.children, next_indent, inner_flags
919 ret += "</#{n.name}>"
921 ret += enc_text n.text
923 ret += "<!--#{n.text}-->" # TODO encode?
925 ret += "<!DOCTYPE #{n.name}"
926 if n.public_identifier? and n.public_identifier.length > 0
927 ret += " \"#{n.public_identifier}\""
928 if n.system_identifier? and n.system_identifier.length > 0
929 ret += " \"#{n.system_identifier}\""
933 prev_in_flow_is_text = is_text
934 prev_in_flow_is_block = is_block or (in_flow and is_br)
936 # output final newline if allowed
937 unless parent_flags.pre_ish
938 if prev_in_flow_is_block or parent_flags.block
939 ret += "\n#{indent.substr 4}"
942 window.peach_html5_editor = (args...) ->
943 return new PeachHTML5Editor args...
945 # test in browser: peach_html5_editor(document.getElementsByTagName('textarea')[0])