asciidoctor 1.5.8 → 2.0.17

data/lib/asciidoctor/path_resolver.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
 # Public: Handles all operations for resolving, cleaning and joining paths.
 # This class includes operations for handling both web paths (request URIs) and
@@ -84,7 +84,7 @@ module Asciidoctor
 #     => 'C:/data/docs/css'
 #
 #     begin
-#       resolver.system_path('../../../css', '../../..', '/path/to/docs', :recover => false)
+#       resolver.system_path('../../../css', '../../..', '/path/to/docs', recover: false)
 #     rescue SecurityError => e
 #       puts e.message
 #     end
@@ -109,7 +109,7 @@ class PathResolver
   SLASH = '/'
   BACKSLASH = '\\'
   DOUBLE_SLASH = '//'
-  WindowsRootRx = /^(?:[a-zA-Z]:)?[\\\/]/
+  WindowsRootRx = %r(^(?:[a-zA-Z]:)?[\\/])
 
   attr_accessor :file_separator
   attr_accessor :working_dir
@@ -206,8 +206,9 @@ class PathResolver
 
   # Public: Calculate the relative path to this absolute path from the specified base directory
   #
-  # If neither path or base are absolute paths, or the path is not contained
-  # within the base directory, no work is done.
+  # If neither path or base are absolute paths, the path is not contained
+  # within the base directory, or the relative path cannot be computed, the
+  # original path is returned work is done.
   #
   # path - [String] an absolute filename.
   # base - [String] an absolute base directory.
@@ -218,7 +219,11 @@ class PathResolver
       if (offset = descends_from? path, base)
         path.slice offset, path.length
       else
-        (Pathname.new path).relative_path_from(Pathname.new base).to_s
+        begin
+          (Pathname.new path).relative_path_from(Pathname.new base).to_s
+        rescue
+          path
+        end
       end
     else
       path
@@ -285,8 +290,8 @@ class PathResolver
       # ex. ./sample/path
       elsif posix_path.start_with? DOT_SLASH
         root = DOT_SLASH
-      # else ex. sample/path
       end
+      # otherwise ex. sample/path
     elsif root? posix_path
       # ex. //sample/path
       if unc? posix_path
@@ -301,8 +306,8 @@ class PathResolver
     # ex. ./sample/path
     elsif posix_path.start_with? DOT_SLASH
       root = DOT_SLASH
-    # else ex. sample/path
     end
+    # otherwise ex. sample/path
 
     path_segments = (root ? (posix_path.slice root.length, posix_path.length) : posix_path).split SLASH
     # strip out all dot entries
@@ -326,11 +331,12 @@ class PathResolver
 
   # Public: Securely resolve a system path
   #
-  # Resolve a system path from the target relative to the start path, jail path, or working
-  # directory (specified in the constructor), in that order. If a jail path is specified, enforce
-  # that the resolved path descends from the jail path. If a jail path is not provided, the resolved
-  # path may be any location on the system. If the resolved path is absolute, use it as is (unless
-  # it breaches the jail path). Expand all parent and self references in the resolved path.
+  # Resolves the target to an absolute path on the current filesystem. The target is assumed to be
+  # relative to the start path, jail path, or working directory (specified in the constructor), in
+  # that order. If a jail path is specified, the resolved path is forced to descend from the jail
+  # path. If a jail path is not provided, the resolved path may be any location on the system. If
+  # the target is an absolute path, use it as is (unless it breaches the jail path). Expands all
+  # parent and self references in the resolved path.
   #
   # target - the String target path
   # start  - the String start path from which to resolve a relative target; falls back to jail, if
@@ -342,8 +348,9 @@ class PathResolver
   #            automatically recover when an illegal path is encountered
   #          * :target_name is used in messages to refer to the path being resolved
   #
-  # returns a String path relative to the start path, if specified, and confined to the jail path,
-  # if specified. The path is posixified and all parent and self references in the path are expanded.
+  # Returns an absolute String path relative to the start path, if specified, and confined to the
+  # jail path, if specified. The path is posixified and all parent and self references in the path
+  # are expanded.
   def system_path target, start = nil, jail = nil, opts = {}
     if jail
       raise ::SecurityError, %(Jail is not an absolute path: #{jail}) unless root? jail
@@ -357,7 +364,7 @@ class PathResolver
         if jail && !(descends_from? target_path, jail)
           if opts.fetch :recover, true
             logger.warn %(#{opts[:target_name] || 'path'} is outside of jail; recovering automatically)
-            target_segments, _ = partition_path target_path
+            target_segments, = partition_path target_path
             jail_segments, jail_root = partition_path jail
             return join_path jail_segments + target_segments, jail_root
           else
@@ -366,7 +373,7 @@ class PathResolver
         end
         return target_path
       else
-        target_segments, _ = partition_path target
+        target_segments, = partition_path target
       end
     else
       target_segments = []
@@ -382,7 +389,7 @@ class PathResolver
           return expand_path start
         end
       else
-        target_segments, _ = partition_path start
+        target_segments, = partition_path start
         start = jail || @working_dir
       end
     elsif start.nil_or_empty?
@@ -414,7 +421,7 @@ class PathResolver
     if (resolved_segments = start_segments + target_segments).include? DOT_DOT
       unresolved_segments, resolved_segments = resolved_segments, []
       if jail
-        jail_segments, _ = partition_path jail unless jail_segments
+        jail_segments, = partition_path jail unless jail_segments
         warned = false
         unresolved_segments.each do |segment|
           if segment == DOT_DOT
@@ -445,7 +452,7 @@ class PathResolver
         target_path
       elsif opts.fetch :recover, true
         logger.warn %(#{opts[:target_name] || 'path'} is outside of jail; recovering automatically)
-        jail_segments, _ = partition_path jail unless jail_segments
+        jail_segments, = partition_path jail unless jail_segments
         join_path jail_segments + target_segments, jail_root
       else
         raise ::SecurityError, %(#{opts[:target_name] || 'path'} #{target} is outside of jail: #{jail} (disallowed in safe mode))
@@ -471,25 +478,15 @@ class PathResolver
   def web_path target, start = nil
     target = posixify target
     start = posixify start
-    uri_prefix = nil
 
     unless start.nil_or_empty? || (web_root? target)
-      target = (start.end_with? SLASH) ? %(#{start}#{target}) : %(#{start}#{SLASH}#{target})
-      if (uri_prefix = Helpers.uri_prefix target)
-        target = target[uri_prefix.length..-1]
-      end
+      target, uri_prefix = extract_uri_prefix %(#{start}#{(start.end_with? SLASH) ? '' : SLASH}#{target})
     end
 
     # use this logic instead if we want to normalize target if it contains a URI
     #unless web_root? target
-    #  if preserve_uri_target && (uri_prefix = Helpers.uri_prefix target)
-    #    target = target[uri_prefix.length..-1]
-    #  elsif !start.nil_or_empty?
-    #    target = %(#{start}#{SLASH}#{target})
-    #    if (uri_prefix = Helpers.uri_prefix target)
-    #      target = target[uri_prefix.length..-1]
-    #    end
-    #  end
+    #  target, uri_prefix = extract_uri_prefix target if preserve_uri_target
+    #  target, uri_prefix = extract_uri_prefix %(#{start}#{SLASH}#{target}) unless uri_prefix || start.nil_or_empty?
     #end
 
     target_segments, target_root = partition_path target, true
@@ -516,5 +513,23 @@ class PathResolver
 
     uri_prefix ? %(#{uri_prefix}#{resolved_path}) : resolved_path
   end
+
+  private
+
+  # Internal: Efficiently extracts the URI prefix from the specified String if the String is a URI
+  #
+  # Uses the Asciidoctor::UriSniffRx regex to match the URI prefix in the specified String (e.g., http://). If present,
+  # the prefix is removed.
+  #
+  # str - the String to check
+  #
+  # returns a tuple containing the specified string without the URI prefix, if present, and the extracted URI prefix.
+  def extract_uri_prefix str
+    if (str.include? ':') && UriSniffRx =~ str
+      [(str.slice $&.length, str.length), $&]
+    else
+      str
+    end
+  end
 end
 end