class Jekyll::Tags::IncludeTag
Constants
- FULL_VALID_SYNTAX
- INVALID_SEQUENCES
- VALID_FILENAME_CHARS
- VALID_SYNTAX
- VARIABLE_SYNTAX
Public Class Methods
new(tag_name, markup, tokens)
click to toggle source
Calls superclass method
# File lib/jekyll/tags/include.rb, line 19 def initialize(tag_name, markup, tokens) super markup = markup.strip matched = markup.match(VARIABLE_SYNTAX) if matched @file = matched["variable"].strip @params = matched["params"].strip else @file, @params = markup.split(%r!\s+!, 2) end validate_params if @params @tag_name = tag_name end
Public Instance Methods
add_include_to_dependency(site, path, context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 131 def add_include_to_dependency(site, path, context) if context.registers[:page]&.key?("path") site.regenerator.add_dependency( site.in_source_dir(context.registers[:page]["path"]), path ) end end
file_read_opts(context)
click to toggle source
Grab file read opts in the context
# File lib/jekyll/tags/include.rb, line 84 def file_read_opts(context) context.registers[:site].file_read_opts end
load_cached_partial(path, context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 140 def load_cached_partial(path, context) context.registers[:cached_partials] ||= {} cached_partial = context.registers[:cached_partials] if cached_partial.key?(path) cached_partial[path] else unparsed_file = context.registers[:site] .liquid_renderer .file(path) begin cached_partial[path] = unparsed_file.parse(read_file(path, context)) rescue Liquid::Error => e e.template_name = path e.markup_context = "included " if e.markup_context.nil? raise e end end end
locate_include_file(context, file, safe)
click to toggle source
# File lib/jekyll/tags/include.rb, line 97 def locate_include_file(context, file, safe) includes_dirs = tag_includes_dirs(context) includes_dirs.each do |dir| path = PathManager.join(dir, file) return path if valid_include_file?(path, dir.to_s, safe) end raise IOError, could_not_locate_message(file, includes_dirs, safe) end
outside_site_source?(path, dir, safe)
click to toggle source
# File lib/jekyll/tags/include.rb, line 164 def outside_site_source?(path, dir, safe) safe && !realpath_prefixed_with?(path, dir) end
parse_params(context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 37 def parse_params(context) params = {} @params.scan(VALID_SYNTAX) do |key, d_quoted, s_quoted, variable| value = if d_quoted d_quoted.include?('\\"') ? d_quoted.gsub('\\"', '"') : d_quoted elsif s_quoted s_quoted.include?("\\'") ? s_quoted.gsub("\\'", "'") : s_quoted elsif variable context[variable] end params[key] = value end params end
read_file(file, context)
click to toggle source
This method allows to modify the file content by inheriting from the class.
# File lib/jekyll/tags/include.rb, line 175 def read_file(file, context) File.read(file, **file_read_opts(context)) end
realpath_prefixed_with?(path, dir)
click to toggle source
# File lib/jekyll/tags/include.rb, line 168 def realpath_prefixed_with?(path, dir) File.exist?(path) && File.realpath(path).start_with?(dir) rescue StandardError false end
render(context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 106 def render(context) site = context.registers[:site] file = render_variable(context) || @file validate_file_name(file) path = locate_include_file(context, file, site.safe) return unless path add_include_to_dependency(site, path, context) partial = load_cached_partial(path, context) context.stack do context["include"] = parse_params(context) if @params begin partial.render!(context) rescue Liquid::Error => e e.template_name = path e.markup_context = "included " if e.markup_context.nil? raise e end end end
render_variable(context)
click to toggle source
Render the variable if required
# File lib/jekyll/tags/include.rb, line 89 def render_variable(context) Liquid::Template.parse(@file).render(context) if VARIABLE_SYNTAX.match?(@file) end
syntax_example()
click to toggle source
# File lib/jekyll/tags/include.rb, line 33 def syntax_example "{% #{@tag_name} file.ext param='value' param2='value' %}" end
tag_includes_dirs(context)
click to toggle source
# File lib/jekyll/tags/include.rb, line 93 def tag_includes_dirs(context) context.registers[:site].includes_load_paths.freeze end
valid_include_file?(path, dir, safe)
click to toggle source
# File lib/jekyll/tags/include.rb, line 160 def valid_include_file?(path, dir, safe) !outside_site_source?(path, dir, safe) && File.file?(path) end
validate_file_name(file)
click to toggle source
# File lib/jekyll/tags/include.rb, line 53 def validate_file_name(file) if INVALID_SEQUENCES.match?(file) || !VALID_FILENAME_CHARS.match?(file) raise ArgumentError, <<~MSG Invalid syntax for include tag. File contains invalid characters or sequences: #{file} Valid syntax: #{syntax_example} MSG end end
validate_params()
click to toggle source
# File lib/jekyll/tags/include.rb, line 68 def validate_params unless FULL_VALID_SYNTAX.match?(@params) raise ArgumentError, <<~MSG Invalid syntax for include tag: #{@params} Valid syntax: #{syntax_example} MSG end end
Private Instance Methods
could_not_locate_message(file, includes_dirs, safe)
click to toggle source
# File lib/jekyll/tags/include.rb, line 181 def could_not_locate_message(file, includes_dirs, safe) message = "Could not locate the included file '#{file}' in any of #{includes_dirs}. " \ "Ensure it exists in one of those directories and" message + if safe " is not a symlink as those are not allowed in safe mode." else ", if it is a symlink, does not point outside your site source." end end