-
Notifications
You must be signed in to change notification settings - Fork 190
/
Html.jl
1180 lines (885 loc) · 39.8 KB
/
Html.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
module Html
import EzXML, HTTP, Logging, Markdown, Millboard, OrderedCollections, Reexport, YAML
Reexport.@reexport using Genie
Reexport.@reexport using Genie.Renderer
Reexport.@reexport using HttpCommon
const DEFAULT_LAYOUT_FILE = :app
const LAYOUTS_FOLDER = "layouts"
const HTML_FILE_EXT = ".jl"
const TEMPLATE_EXT = [".jl.html", ".jl"]
const MARKDOWN_FILE_EXT = [".md", ".jl.md"]
const SUPPORTED_HTML_OUTPUT_FILE_FORMATS = TEMPLATE_EXT
const HTMLParser = EzXML
const NBSP_REPLACEMENT = (" "=>"!!nbsp;;")
const NORMAL_ELEMENTS = [ :html, :head, :body, :title, :style, :address, :article, :aside, :footer,
:header, :h1, :h2, :h3, :h4, :h5, :h6, :hgroup, :nav, :section,
:dd, :div, :d, :dl, :dt, :figcaption, :figure, :li, :main, :ol, :p, :pre, :ul, :span,
:a, :abbr, :b, :bdi, :bdo, :cite, :code, :data, :dfn, :em, :i, :kbd, :mark,
:q, :rp, :rt, :rtc, :ruby, :s, :samp, :small, :spam, :strong, :sub, :sup, :time,
:u, :var, :wrb, :audio, :void, :embed, :object, :canvas, :noscript, :script,
:del, :ins, :caption, :col, :colgroup, :table, :tbody, :td, :tfoot, :th, :thead, :tr,
:button, :datalist, :fieldset, :label, :legend, :meter,
:output, :progress, :select, :option, :textarea, :details, :dialog, :menu, :menuitem, :summary,
:slot, :template, :blockquote, :center, :iframe]
const VOID_ELEMENTS = [:base, :link, :meta, :hr, :br, :area, :img, :track, :param, :source, :input]
const CUSTOM_ELEMENTS = [:form, :select]
const NON_EXPORTED = [:main, :map, :filter]
const SVG_ELEMENTS = [:animate, :circle, :animateMotion, :animateTransform, :clipPath, :defs, :desc, :discard,
:ellipse, :feComponentTransfer, :feComposite, :feDiffuseLighting, :feBlend, :feColorMatrix,
:feConvolveMatrix, :feDisplacementMap, :feDistantLight, :feDropShadow, :feFlood, :feFuncA, :feFuncB, :feFuncG,
:feFuncR, :feGaussianBlur, :feImage, :feMerge, :feMergeNode, :feMorphology, :feOffset, :fePointLight, :feSpecularLighting,
:feSpotLight, :feTile, :feTurbulence, :foreignObject, :g, :hatch, :hatchpath, :image, :line, :linearGradient,
:marker, :mask, :metadata, :mpath, :path, :pattern, :polygon, :polyline, :radialGradient, :rect, :set, :stop, :svg,
:switch, :symbol, :text, :textPath, :tspan, :use, :view]
const EMBEDDED_JULIA_PLACEHOLDER = "~~~~~|~~~~~"
# ParsedHTMLStrings
struct ParsedHTMLString <: AbstractString
data::String
end
function ParsedHTMLString(v::Vector{T}) where {T}
join(v) |> ParsedHTMLString
end
Base.string(v::Vector{ParsedHTMLString}) = join(v)
ParsedHTMLString(args...) = ParsedHTMLString([args...])
Base.string(s::ParsedHTMLString) = s.data
Base.String(s::ParsedHTMLString) = string(s)
Base.iterate(s::ParsedHTMLString) = iterate(s.data)
Base.iterate(s::ParsedHTMLString, x::Int) = iterate(s.data, x)
Base.ncodeunits(s::ParsedHTMLString) = Base.ncodeunits(s.data)
Base.codeunit(s::ParsedHTMLString) = Base.codeunit(s.data)
Base.codeunit(s::ParsedHTMLString, i::Int) = Base.codeunit(s.data, i)
Base.isvalid(s::ParsedHTMLString, i::Int) = Base.isvalid(s.data, i)
Base.convert(::Type{ParsedHTMLString}, v::Vector{T}) where {T} = ParsedHTMLString(v)
import Base: (*)
(*)(s::ParsedHTMLString, t::ParsedHTMLString) = string(s.data, t.data)
# end ParsedHTMLStrings
# HTMLStrings
struct HTMLString <: AbstractString
data::String
end
function HTMLString(v::Vector{T}) where {T}
join(v) |> HTMLString
end
Base.string(v::Vector{HTMLString}) = join(v)
Base.string(v::Vector{AbstractString}) = join(v)
HTMLString(args...) = HTMLString([args...])
Base.string(s::HTMLString) = s.data
Base.String(s::HTMLString) = string(s)
Base.iterate(s::HTMLString) = iterate(s.data)
Base.iterate(s::HTMLString, x::Int) = iterate(s.data, x)
Base.ncodeunits(s::HTMLString) = Base.ncodeunits(s.data)
Base.codeunit(s::HTMLString) = Base.codeunit(s.data)
Base.codeunit(s::HTMLString, i::Int) = Base.codeunit(s.data, i)
Base.isvalid(s::HTMLString, i::Int) = Base.isvalid(s.data, i)
Base.convert(::Type{HTMLString}, v::Vector{T}) where {T} = HTMLString(v)
import Base: (*)
(*)(s::HTMLString, t::HTMLString) = string(s.data, t.data)
# end HTMLStrings
# const HTMLString = String
export HTMLString, html, doc, doctype, ParsedHTMLString, html!
export @yield, collection, view!, for_each
export partial, template
task_local_storage(:__yield, "")
include("MdHtml.jl")
function contentargs(args...)
join(join.(filter((x -> isa(x, AbstractArray)), args)), ""), [filter((x -> !isa(x, AbstractArray)), args)...]
end
"""
normal_element(f::Function, elem::String, attrs::Vector{Pair{Symbol,Any}} = Pair{Symbol,Any}[]) :: HTMLString
Generates a HTML element in the form <...></...>
"""
function normal_element(f::Function, elem::Any, args::Vector = [], attrs::Vector{Pair{Symbol,Any}} = Pair{Symbol,Any}[]) :: HTMLString
normal_element(Base.invokelatest(f), string(elem), args, attrs...)
end
function normal_element(children::Union{T,Vector{T}}, elem::Any, args::Vector, attrs::Pair{Symbol,Any})::HTMLString where {T<:AbstractString}
normal_element(children, string(elem), args, Pair{Symbol,Any}[attrs])
end
function normal_element(children::Tuple, elem::Any, args::Vector, attrs::Pair{Symbol,Any}) :: HTMLString
normal_element([children...], string(elem), args, Pair{Symbol,Any}[attrs])
end
function normal_element(children::Union{T,Vector{T}}, elem::Any, args::Vector, attrs...)::HTMLString where {T<:AbstractString}
normal_element(children, string(elem), args, Pair{Symbol,Any}[attrs...])
end
function normal_element(children::Union{T,Vector{T}}, elem::Any, args::Vector = [], attrs::Vector{Pair{Symbol,Any}} = Pair{Symbol,Any}[])::HTMLString where {T<:AbstractString}
content_args, args = contentargs(args...)
children = string(join(children), content_args)
idx = findfirst(x -> x == :inner, getindex.(attrs, 1))
if idx !== nothing
children *= join(attrs[idx][2])
deleteat!(attrs, idx)
end
ii = (x -> x isa Symbol && occursin(Genie.config.html_parser_char_dash, "$x")).(args)
args[ii] .= Symbol.(replace.(string.(args[ii]), Ref(Genie.config.html_parser_char_dash=>"-")))
htmlsourceindent = extractindent!(attrs)
elem = normalize_element(string(elem))
attribs = rstrip(attributes(attrs))
string(
htmlsourceindent, # indentation opening tag
"<", elem, (isempty(attribs) ? "" : " $attribs"), (isempty(args) ? "" : " $(join(args, " "))"), ">", # opening tag
prepare_template(children), (endswith(children, '>') ? htmlsourceindent : ""), # content/children
"</", elem, ">" # closing tag
)
end
function normal_element(elem::Any, attrs::Vector{Pair{Symbol,Any}} = Pair{Symbol,Any}[]) :: HTMLString
normal_element("", string(elem), attrs...)
end
function normal_element(elems::Vector, elem::Any, args = [], attrs...) :: HTMLString
io = IOBuffer()
for e in elems
e === nothing && continue
if isa(e, Vector)
print(io, join(e))
elseif isa(e, Function)
print(io, e())
else
print(io, e)
end
end
normal_element(String(take!(io)), string(elem), args, attrs...)
end
function normal_element(_::Nothing, __::Any) :: HTMLString
""
end
function normal_element(children::Vector{T}, elem::Any, args::Vector{T})::HTMLString where {T}
normal_element(join([(isa(f, Function) ? f() : string(f)) for f in children]), elem, args)
end
function extractindent!(attrs) :: String
indent = if Genie.config.format_html_output
htmlsidx = findfirst(x -> x == :htmlsourceindent, getindex.(attrs, 1))
if htmlsidx !== nothing
indent = Base.parse(Int, attrs[htmlsidx][2])
deleteat!(attrs, htmlsidx)
indent
else
0
end
else
0
end
if indent > 0
'\n' * repeat(Genie.config.format_html_indentation_string, indent)
else
""
end
end
"""
prepare_template(s::String)
prepare_template{T}(v::Vector{T})
Cleans up the template before rendering (ex by removing empty nodes).
"""
function prepare_template(s::String) :: String
s
end
function prepare_template(v::Vector{T})::String where {T}
filter!(v) do (x)
! isa(x, Nothing)
end
join(v)
end
"""
attributes(attrs::Vector{Pair{Symbol,String}} = Vector{Pair{Symbol,String}}()) :: Vector{String}
Parses HTML attributes.
"""
function attributes(attrs::Vector{Pair{Symbol,Any}} = Vector{Pair{Symbol,Any}}()) :: String
a = IOBuffer()
for (k,v) in attrs
v === nothing && continue # skip nothing values
v == "false" && (v = false)
print(a, attrparser(k, v))
end
String(take!(a))
end
function attrparser(k::Symbol, v::Bool) :: String
v ? "$(k |> parseattr) " : ""
end
function attrparser(k::Symbol, v::Union{AbstractString,Symbol}) :: String
isempty(string(v)) && return attrparser(k, true)
"$(k |> parseattr)=\"$(v)\" "
end
function attrparser(k::Symbol, v::Any) :: String
default_attrparser(k, v)
end
function default_attrparser(k::Symbol, v::Any) :: String
"$(k |> parseattr)=$(v) "
end
"""
parseattr(attr) :: String
Converts Julia keyword arguments to HTML attributes with illegal Julia chars.
"""
function parseattr(attr) :: String
attr = string(attr)
for (k,v) in Genie.config.html_attributes_replacements
attr = replace(attr, k=>v)
end
endswith(attr, Genie.config.html_parser_char_at) && (attr = string("v-on:", attr[1:end-(length(Genie.config.html_parser_char_at))]))
endswith(attr, Genie.config.html_parser_char_column) && (attr = string(":", attr[1:end-(length(Genie.config.html_parser_char_column))]))
attr = replace(attr, Regex(Genie.config.html_parser_char_dash)=>"-")
attr = replace(attr, Regex(Genie.config.html_parser_char_column * Genie.config.html_parser_char_column)=>":")
replace(attr, Regex(Genie.config.html_parser_char_dot)=>".")
end
"""
normalize_element(elem::String)
Cleans up problematic characters or DOM elements.
"""
function normalize_element(elem::String) :: String
replace(elem, Genie.config.html_parser_char_dash=>"-")
end
"""
denormalize_element(elem::String)
Replaces `-` with the char defined to replace dashes, as Julia does not support them in names.
"""
function denormalize_element(elem::String) :: String
uppercase(elem) == elem && (elem = lowercase(elem))
elem = replace(elem, "-"=>Genie.config.html_parser_char_dash)
endswith(elem, "_") ? elem[1:end-1] : elem
end
"""
void_element(elem::String, attrs::Vector{Pair{Symbol,String}} = Vector{Pair{Symbol,String}}()) :: HTMLString
Generates a void HTML element in the form <...>
"""
function void_element(elem::String, args = [], attrs::Vector{Pair{Symbol,Any}} = Pair{Symbol,Any}[]) :: HTMLString
htmlsourceindent = extractindent!(attrs)
attribs = rstrip(attributes(attrs))
string(
htmlsourceindent, # tag indentation
"<", normalize_element(elem), (isempty(attribs) ? "" : " $attribs"), (isempty(args) ? "" : " $(join(args, " "))"), Genie.config.html_parser_close_tag, ">"
)
end
"""
get_template(path::String; partial::Bool = true, context::Module = @__MODULE__, vars...) :: Function
Resolves the inclusion and rendering of a template file
"""
function get_template(path::String; partial::Bool = true, context::Module = @__MODULE__, vars...) :: Function
path, extension = Genie.Renderer.view_file_info(path, SUPPORTED_HTML_OUTPUT_FILE_FORMATS)
f_name = Genie.Renderer.function_name(string(path, partial)) |> Symbol
mod_name = Genie.Renderer.m_name(string(path, partial)) * HTML_FILE_EXT
f_path = joinpath(Genie.config.path_build, Genie.Renderer.BUILD_NAME, mod_name)
f_stale = Genie.Renderer.build_is_stale(path, f_path)
if f_stale || ! isdefined(context, f_name)
if extension in MARKDOWN_FILE_EXT
path = MdHtml.md_to_html(path, context = context)
end
parsingfunction = (extension == HTML_FILE_EXT ? julia_to_julia : html_to_julia)
f_stale && Genie.Renderer.build_module(parsingfunction(path, partial = partial, extension = extension), path, mod_name)
return Base.include(context, joinpath(Genie.config.path_build, Genie.Renderer.BUILD_NAME, mod_name))
end
getfield(context, f_name)
end
"""
Outputs document's doctype.
"""
@inline function doctype(doctype::Symbol = :html) :: ParsedHTMLString
string("<!DOCTYPE $doctype>")
end
"""
Outputs document's doctype.
"""
function doc(html::AbstractString) :: ParsedHTMLString
string(doctype(), html)
end
function doc(doctype::Symbol, html::AbstractString) :: ParsedHTMLString
string(doctype(doctype), html)
end
"""
parseview(data::String; partial = false, context::Module = @__MODULE__) :: Function
Parses a view file, returning a rendering function. If necessary, the function is JIT-compiled, persisted and loaded into memory.
"""
function parseview(data::S; partial = false, context::Module = @__MODULE__)::Function where {S<:AbstractString}
data_hash = hash(data)
path = "Genie_" * string(data_hash)
func_name = Genie.Renderer.function_name(string(data_hash, partial)) |> Symbol
mod_name = Genie.Renderer.m_name(string(path, partial)) * HTML_FILE_EXT
f_path = joinpath(Genie.config.path_build, Genie.Renderer.BUILD_NAME, mod_name)
f_stale = Genie.Renderer.build_is_stale(f_path, f_path)
if f_stale || ! isdefined(context, func_name)
if f_stale
Genie.Renderer.build_module(string_to_julia(data, partial = partial), path, mod_name)
end
return Base.include(context, joinpath(Genie.config.path_build, Genie.Renderer.BUILD_NAME, mod_name))
end
getfield(context, func_name)
end
"""
render(data::String; context::Module = @__MODULE__, layout::Union{String,Nothing} = nothing, vars...) :: Function
Renders the string as an HTML view.
"""
function render(data::S; context::Module = @__MODULE__, layout::Union{String,Nothing} = nothing, vars...)::Function where {S<:AbstractString}
Genie.Renderer.registervars(; context = context, vars...)
if layout !== nothing
task_local_storage(:__yield, parseview(data, partial = true, context = context))
parseview(layout, partial = false, context = context)
else
parseview(data, partial = false, context = context)
end
end
"""
render(viewfile::Genie.Renderer.FilePath; layout::Union{Nothing,Genie.Renderer.FilePath} = nothing, context::Module = @__MODULE__, vars...) :: Function
Renders the template file as an HTML view.
"""
function render(viewfile::Genie.Renderer.FilePath; layout::Union{Nothing,Genie.Renderer.FilePath} = nothing, context::Module = @__MODULE__, vars...) :: Function
Genie.Renderer.registervars(; context = context, vars...)
if layout !== nothing
task_local_storage(:__yield, get_template(string(viewfile); partial = true, context = context, vars...))
get_template(string(layout); partial = false, context = context, vars...)
else
get_template(string(viewfile); partial = false, context = context, vars...)
end
end
"""
parsehtml(input::String; partial::Bool = true) :: String
"""
function parsehtml(input::String; partial::Bool = true) :: String
content = replace(input, NBSP_REPLACEMENT)
isempty(content) && return ""
# let's get rid of the annoying xml parser warnings
Logging.with_logger(Logging.SimpleLogger(stdout, Logging.Error)) do
parsehtml(HTMLParser.parsehtml(content).root, partial = partial)
end
end
function Genie.Renderer.render(::Type{MIME"text/html"}, data::S; context::Module = @__MODULE__,
layout::Union{String,Nothing} = nothing, vars...)::Genie.Renderer.WebRenderable where {S<:AbstractString}
try
render(data; context = context, layout = layout, vars...) |> Genie.Renderer.WebRenderable
catch ex
isa(ex, KeyError) && Genie.Renderer.changebuilds() # it's a view error so don't reuse them
rethrow(ex)
end
end
function Genie.Renderer.render(::Type{MIME"text/html"}, viewfile::Genie.Renderer.FilePath; layout::Union{Nothing,Genie.Renderer.FilePath} = nothing, context::Module = @__MODULE__, vars...) :: Genie.Renderer.WebRenderable
try
render(viewfile; layout = layout, context = context, vars...) |> Genie.Renderer.WebRenderable
catch ex
isa(ex, KeyError) && Genie.Renderer.changebuilds() # it's a view error so don't reuse them
rethrow(ex)
end
end
function html(resource::Genie.Renderer.ResourcePath, action::Genie.Renderer.ResourcePath;
layout::Union{Genie.Renderer.ResourcePath,Nothing} = DEFAULT_LAYOUT_FILE,
context::Module = @__MODULE__, status::Int = 200, headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(), vars...) :: Genie.Renderer.HTTP.Response
html(Genie.Renderer.Path(joinpath(Genie.config.path_resources, string(resource), Renderer.VIEWS_FOLDER, string(action)));
layout = (layout === nothing ? nothing : Genie.Renderer.Path(joinpath(Genie.config.path_app, LAYOUTS_FOLDER, string(layout)))),
context = context, status = status, headers = headers, vars...)
end
"""
html(data::String; context::Module = @__MODULE__, status::Int = 200, headers::HTTPHeaders = HTTPHeaders(), layout::Union{String,Nothing} = nothing, vars...) :: HTTP.Response
Parses the `data` input as HTML, returning a HTML HTTP Response.
# Arguments
- `data::String`: the HTML string to be rendered
- `context::Module`: the module in which the variables are evaluated (in order to provide the scope for vars). Usually the controller.
- `status::Int`: status code of the response
- `headers::HTTPHeaders`: HTTP response headers
- `layout::Union{String,Nothing}`: layout file for rendering `data`
# Example
```jldoctest
julia> html("<h1>Welcome \$(vars(:name))</h1>", layout = "<div><% @yield %></div>", name = "Adrian")
HTTP.Messages.Response:
"
HTTP/1.1 200 OK
Content-Type: text/html; charset=utf-8
<html><head></head><body><div><h1>Welcome Adrian</h1>
</div></body></html>"
```
"""
function html(data::String; context::Module = @__MODULE__, status::Int = 200, headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(),
layout::Union{String,Nothing,Genie.Renderer.FilePath} = nothing, forceparse::Bool = false, noparse::Bool = false, vars...) :: Genie.Renderer.HTTP.Response
isa(layout, Genie.Renderer.FilePath) && (layout = read(layout, String))
if (occursin(raw"$", data) || occursin("<%", data) || layout !== nothing || forceparse) && ! noparse
html(HTMLString(data); context = context, status = status, headers = headers, layout = layout, vars...)
else
html(ParsedHTMLString(data); context, status, headers, layout, vars...)
end
end
function html(data::HTMLString; context::Module = @__MODULE__, status::Int = 200, headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(),
layout::Union{String,Nothing,Genie.Renderer.FilePath} = nothing, forceparse::Bool = false, noparse::Bool = false, vars...) :: Genie.Renderer.HTTP.Response
Genie.Renderer.WebRenderable(Genie.Renderer.render(MIME"text/html", data; context = context, layout = layout, vars...), status, headers) |> Genie.Renderer.respond
end
function html(data::ParsedHTMLString; status::Int = 200,
headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(), vars...) :: Genie.Renderer.HTTP.Response
Genie.Renderer.WebRenderable(body = data.data, status = status, headers = headers) |> Genie.Renderer.respond
end
function html!(data::Union{S,Vector{S}}; status::Int = 200,
headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(),
vars...)::Genie.Renderer.HTTP.Response where {S<:AbstractString}
html(ParsedHTMLString(join(data)); headers, vars...)
end
"""
html(md::Markdown.MD; context::Module = @__MODULE__, status::Int = 200, headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(), layout::Union{String,Nothing} = nothing, forceparse::Bool = false, vars...) :: Genie.Renderer.HTTP.Response
Markdown view rendering
"""
function html(md::Markdown.MD; context::Module = @__MODULE__, status::Int = 200, headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(), layout::Union{String,Nothing} = nothing, forceparse::Bool = false, vars...) :: Genie.Renderer.HTTP.Response
data = MdHtml.eval_markdown(string(md)) |> Markdown.parse |> Markdown.html
for kv in vars
data = replace(data, ":" * string(kv[1]) => "\$" * string(kv[1]))
end
html(data; context = context, status = status, headers = headers, layout = layout, forceparse = forceparse, vars...)
end
"""
html(viewfile::FilePath; layout::Union{Nothing,FilePath} = nothing,
context::Module = @__MODULE__, status::Int = 200, headers::HTTPHeaders = HTTPHeaders(), vars...) :: HTTP.Response
Parses and renders the HTML `viewfile`, optionally rendering it within the `layout` file. Valid file format is `.html.jl`.
# Arguments
- `viewfile::FilePath`: filesystem path to the view file as a `Renderer.FilePath`, ie `Renderer.FilePath("/path/to/file.html.jl")`
- `layout::FilePath`: filesystem path to the layout file as a `Renderer.FilePath`, ie `Renderer.FilePath("/path/to/file.html.jl")`
- `context::Module`: the module in which the variables are evaluated (in order to provide the scope for vars). Usually the controller.
- `status::Int`: status code of the response
- `headers::HTTPHeaders`: HTTP response headers
"""
function html(viewfile::Genie.Renderer.FilePath; layout::Union{Nothing,Genie.Renderer.FilePath} = nothing,
context::Module = @__MODULE__, status::Int = 200, headers::Genie.Renderer.HTTPHeaders = Genie.Renderer.HTTPHeaders(), vars...) :: Genie.Renderer.HTTP.Response
Genie.Renderer.WebRenderable(Genie.Renderer.render(MIME"text/html", viewfile; layout = layout, context = context, vars...), status, headers) |> Genie.Renderer.respond
end
"""
safe_attr(attr) :: String
Replaces illegal Julia characters from HTML attributes with safe ones, to be used as keyword arguments.
"""
function safe_attr(attr) :: String
attr = string(attr)
occursin("-", attr) && replace!(attr, "-"=>Genie.config.html_parser_char_dash)
occursin(":", attr) && replace!(attr, ":"=>Genie.config.html_parser_char_column)
occursin("@", attr) && replace!(attr, "@"=>Genie.config.html_parser_char_at)
occursin(".", attr) && replace!(attr, "."=>Genie.config.html_parser_char_dot)
attr
end
function matchbrackets(v::String, ob = "(", cb = ")")
positions = Int[]
substrings = Any[]
counter = 1
for x in v
if x == ob
push!(positions, counter)
end
if x == cb
px = try
pop!(positions)
catch
error("Parse error: possibly unmatched bracket in `$v`")
end
push!(substrings, px:counter)
end
counter += 1
end
substrings |> sort!
end
function matchjuliaexpr(v::String, ob = "(", cb = ")", dollar = true)
substrings = matchbrackets(v, ob, cb)
matches = String[]
for i in substrings
pii = prevind(v, i.start)
if ! dollar || (dollar && pii > 0 && v[pii] == '$')
push!(matches, v[i.start:i.stop])
end
end
matches
end
function parse_attributes!(elem_attributes, io::IOBuffer) :: IOBuffer
attributes = IOBuffer()
attributes_keys = String[]
attributes_values = String[]
for (k,v) in elem_attributes
# x = v
k = string(k) |> lowercase
if isa(v, AbstractString) && occursin("\"", v)
# we need to escape double quotes but only if it's not embedded Julia code
mx = vcat(matchjuliaexpr(v, '(', ')', true), matchjuliaexpr(v, "<%", "%>", false))
if ! isempty(mx)
index = 1
for value in mx
label = "$(EMBEDDED_JULIA_PLACEHOLDER)_$(index)"
v = replace(v, value => label)
index += 1
end
if occursin("\"", v) # do we still need to escape double quotes?
v = replace(v, "\"" => "\\\"") # we need to escape " as this will be inside julia strings
end
# now we need to put back the embedded Julia
index = 1
for value in mx
label = "$(EMBEDDED_JULIA_PLACEHOLDER)_$(index)"
v = replace(v, label => value)
index += 1
end
elseif occursin("\"", v) # do we still need to escape double quotes?
v = replace(string(v), "\"" => "'") #
end
end
if startswith(k, raw"$") # do not process embedded julia code
print(attributes, k[2:end], ", ") # strip the $, this is rendered directly in Julia code
continue
end
if occursin("-", k) ||
occursin(":", k) ||
occursin("@", k) ||
occursin(".", k) ||
occursin("for", k)
push!(attributes_keys, Symbol(k) |> repr)
v = string(v) |> repr
occursin(raw"\$", v) && (v = replace(v, raw"\$"=>raw"$"))
push!(attributes_values, v)
else
print(attributes, """$k="$v" """, ", ")
end
end
attributes_string = String(take!(attributes))
endswith(attributes_string, ", ") && (attributes_string = attributes_string[1:end-2])
print(io, attributes_string)
! isempty(attributes_string) && ! isempty(attributes_keys) && print(io, ", ")
! isempty(attributes_keys) &&
print(io, "; NamedTuple{($(join(attributes_keys, ", "))$(length(attributes_keys) == 1 ? ", " : ""))}(($(join(attributes_values, ", "))$(length(attributes_keys) == 1 ? ", " : "")))...")
io
end
"""
parsehtml(elem, output; partial = true) :: String
Parses a HTML tree structure into a `string` of Julia code.
"""
function parsehtml(elem::HTMLParser.Node; partial::Bool = true, indent = 0) :: String
io = IOBuffer()
tag_name = denormalize_element(string(elem.name))
invalid_tag = partial && (tag_name == "html" || tag_name == "head" || tag_name == "body")
if tag_name == "script" && haskey(elem, "type") && elem["type"] == "julia/eval"
if ! isempty(HTMLParser.nodes(elem))
print(io, string(HTMLParser.nodes(elem)[1] |> HTMLParser.nodecontent), "\n")
end
else
mdl = isdefined(@__MODULE__, Symbol(tag_name)) ? string(@__MODULE__, ".") : ""
invalid_tag || print(io, "$mdl$(tag_name)(" )
if (elem.type == HTMLParser.ELEMENT_NODE)
attrs_dict = Dict{String,Any}()
for a in HTMLParser.attributes(elem)
try
attrs_dict[a.name] = elem[a.name]
catch ex
parts = split(string(a), '=')
if length(parts) == 2
val = strip(parts[2])
(startswith(val, '"') || startswith(val, "'")) && (val = val[2:end])
(endswith(val, '"') || endswith(val, "'")) && (val = val[1:end-1])
attrs_dict[strip(parts[1])] = val
elseif length(parts) == 1
attrs_dict[strip(parts[1])] = strip(parts[1])
else
string(a)
end
end
end
! invalid_tag && Genie.config.format_html_output && (attrs_dict["htmlsourceindent"] = indent)
io = parse_attributes!(attrs_dict, io)
end
invalid_tag || print(io, " )")
inner = ""
if ! isempty(HTMLParser.nodes(elem))
children_count = HTMLParser.countnodes(elem)
invalid_tag ? print(io, "") : print(io, " do;[\n")
idx = 0
indent += 1
for child in HTMLParser.nodes(elem)
idx += 1
inner *= (child.type == HTMLParser.TEXT_NODE || child.type == HTMLParser.CDATA_SECTION_NODE ||
child.type == HTMLParser.COMMENT_NODE) ?
parsenode(child) :
parsehtml(child; partial = partial, indent = indent)
if idx < children_count
if ( child.type == HTMLParser.TEXT_NODE || child.type == HTMLParser.CDATA_SECTION_NODE ||
child.type == HTMLParser.COMMENT_NODE) ||
( child.type == HTMLParser.ELEMENT_NODE &&
( ! haskey(elem, "type") ||
( haskey(elem, "type") && (elem["type"] == "julia/eval") ) ) )
isempty(inner) || (inner = string(inner, "\n"))
end
end
end
if ! isempty(inner)
endswith(inner, "\n\n") && (inner = inner[1:end-2])
print(io, inner)
invalid_tag || print(io, " ; ")
end
invalid_tag ? print(io, "") : print(io, " ]end\n")
end
end
String(take!(io))
end
function parsenode(elem::HTMLParser.Node; partial::Bool = true) :: String
content = elem |> HTMLParser.nodecontent
endswith(content, "\"") && (content *= Char(0x0))
content = replace(content, NBSP_REPLACEMENT[2]=>NBSP_REPLACEMENT[1])
isempty(strip(content)) && return ""
elem.type == HTMLParser.COMMENT_NODE && return string("\"\"\"<!-- $(content) -->\"\"\"")
string("\"\"\"$(content)\"\"\"")
end
"""
html_to_julia(file_path::String; partial = true) :: String
Converts a HTML document to Julia code.
"""
function html_to_julia(file_path::String; partial = true, extension = TEMPLATE_EXT) :: String
to_julia(file_path, parse_template; partial = partial, extension = extension)
end
"""
string_to_julia(content::String; partial = true, f_name::Union{Symbol,Nothing} = nothing, prepend = "") :: String
Converts string view data to Julia code
"""
function string_to_julia(content::S; partial = true, f_name::Union{Symbol,Nothing} = nothing, prepend::String = "\n")::String where {S<:AbstractString}
to_julia(content, parse_string, partial = partial, f_name = f_name, prepend = prepend)
end
function julia_to_julia(file_path::String; partial = true, extension = HTML_FILE_EXT) :: String
to_julia(read_template_file(file_path; extension = extension), nothing; partial = partial, extension = extension)
end
"""
to_julia(input::String, f::Function; partial = true, f_name::Union{Symbol,Nothing} = nothing, prepend = "") :: String
Converts an input file to Julia code
"""
function to_julia(input::S, f::Union{Function,Nothing};
partial = true, f_name::Union{Symbol,Nothing} = nothing,
prepend::String = "\n", extension = TEMPLATE_EXT)::ParsedHTMLString where {S<:AbstractString}
f_name = (f_name === nothing) ? Genie.Renderer.function_name(string(input, partial)) : f_name
string("function $(f_name)(; $(Genie.Renderer.injectkwvars())) \n",
"
[
",
prepend,
(partial ? "" : "\nGenie.Renderer.Html.doctype() \n"),
f !== nothing ? f(input; partial = partial, extension = extension) : input,
"
]
end
")
end
"""
partial(path::String; context::Module = @__MODULE__, vars...) :: String
Renders (includes) a view partial within a larger view or layout file.
"""
function partial(path::String; context::Module = @__MODULE__, kwvars...) :: String
for (k,v) in kwvars
vars()[k] = v
end
template(path, partial = true, context = context)
end
function partial(path::Genie.Renderer.FilePath; context::Module = @__MODULE__, kwvars...)
partial(string(path); context = context, kwvars...)
end
function partial(resource::Genie.Renderer.ResourcePath, view::Genie.Renderer.ResourcePath, args...; kwargs...)
partial(joinpath(Genie.config.path_resources, string(resource), Renderer.VIEWS_FOLDER, string(view)), args...; kwargs...)
end
"""
template(path::String; partial::Bool = true, context::Module = @__MODULE__, vars...) :: String
Renders a template file.
"""
function template(path::String; partial::Bool = true, context::Module = @__MODULE__, vars...) :: String
try
get_template(path; partial = partial, context = context, vars...)() |> join
catch ex
if isa(ex, MethodError) && (string(ex.f) == "get_template" || startswith(string(ex.f), "func_"))
Base.invokelatest(get_template(path; partial = partial, context = context, vars...)) |> join
else
rethrow(ex)
end
end
end
"""
read_template_file(file_path::String) :: String
Reads `file_path` template from disk.
"""
function read_template_file(file_path::String; extension = TEMPLATE_EXT) :: String
io = IOBuffer()
# endswith(file_path, extension) || (file_path *= extension)
# extension == TEMPLATE_EXT && print(io, """
# \"\"\"
# """)
open(file_path) do f
for line in eachline(f)
isempty(strip(line)) && continue
print(io, parse_embed_tags(line), "\n")
end
end
# extension == TEMPLATE_EXT && print(io, """
# \"\"\"
# """)
String(take!(io))
end
"""
parse_template(file_path::String; partial = true) :: String
Parses a HTML file into Julia code.
"""
function parse_template(file_path::S; partial::Bool = true, extension = TEMPLATE_EXT)::ParsedHTMLString where {S<:AbstractString}
parse(read_template_file(file_path; extension = extension)::String; partial = partial)
end
"""
parse_string(data::String; partial = true) :: String
Parses a HTML string into Julia code.
"""
function parse_string(data::S; partial::Bool = true, extension = TEMPLATE_EXT)::ParsedHTMLString where {S<:AbstractString}
parse(parse_embed_tags(data), partial = partial)
end
function parse(input::S; partial::Bool = true)::ParsedHTMLString where {S<:AbstractString}
parsehtml(input, partial = partial)
end
function parse_embed_tags(code::S)::String where {S<:AbstractString}
replace(
replace(code, "<%"=>"""<script type="julia/eval">"""),
"%>"=>"""</script>""")
end
"""
register_elements() :: Nothing
Generated functions that represent Julia functions definitions corresponding to HTML elements.
"""
function register_elements(; context = @__MODULE__) :: Nothing
for elem in NORMAL_ELEMENTS
register_normal_element(elem)
end
for elem in VOID_ELEMENTS
register_void_element(elem)
end
for elem in CUSTOM_ELEMENTS
Core.eval(@__MODULE__, """include("html/$elem.jl")""" |> Meta.parse)
elem in NON_EXPORTED || Core.eval(context, "export $elem" |> Meta.parse)
end
for elem in SVG_ELEMENTS
register_normal_element(elem)
end
nothing
end
"""
register_element(elem::Union{Symbol,String}, elem_type::Union{Symbol,String} = :normal; context = @__MODULE__) :: Nothing
Generates a Julia function representing an HTML element.
"""
function register_element(elem::Union{Symbol,String}, elem_type::Union{Symbol,String} = :normal; context = @__MODULE__) :: Nothing
elem = string(elem)
occursin("-", elem) && (elem = denormalize_element(elem))
elem_type == :normal ? register_normal_element(elem) : register_void_element(elem)
end
"""
register_normal_element(elem::Union{Symbol,String}; context = @__MODULE__) :: Nothing
Generates a Julia function representing a "normal" HTML element: that is an element with a closing tag, <tag>...</tag>
"""
function register_normal_element(elem::Union{Symbol,String}; context = @__MODULE__) :: Nothing
Core.eval(context, """
function $elem(f::Function, args...; attrs...) :: ParsedHTMLString
\"\"\"\$(normal_element(f, "$(string(elem))", [args...], Pair{Symbol,Any}[attrs...]))\"\"\"
end