summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorknu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-04-19 11:56:22 +0000
committerknu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-04-19 11:56:22 +0000
commitcfe710763e7eb44555cd01999534ed569e9fbf44 (patch)
tree7cd47ee99ede0bd1ce681a2a709288b4fce5694a /lib
parent09f5560c5721ad779cc2e740c4a77ad6aca1b530 (diff)
Merge this too.
* lib/uri/ftp.rb, lib/uri/generic.rb, test/uri/test_common.rb, test/uri/test_ftp.rb, test/uri/test_generic.rb: backported from 1.9. [ruby-dev:31318] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8_7@16085 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r--lib/uri/ftp.rb86
-rw-r--r--lib/uri/generic.rb104
2 files changed, 120 insertions, 70 deletions
diff --git a/lib/uri/ftp.rb b/lib/uri/ftp.rb
index 26109e4d27..1a18e9cae7 100644
--- a/lib/uri/ftp.rb
+++ b/lib/uri/ftp.rb
@@ -11,7 +11,7 @@ require 'uri/generic'
module URI
#
- # RFC1738 section 3.2.
+ # FTP URI syntax is defined by RFC1738 section 3.2.
#
class FTP < Generic
DEFAULT_PORT = 21
@@ -22,12 +22,11 @@ module URI
:path, :typecode
].freeze
#
- # Typecode is, "a", "i" or "d".
- # As for "a" the text, as for "i" binary,
- # as for "d" the directory is displayed.
- # "A" with the text, as for "i" being binary,
- # is because the respective data type was called ASCII and
- # IMAGE with the protocol of FTP.
+ # Typecode is "a", "i" or "d".
+ #
+ # * "a" indicates a text file (the FTP command was ASCII)
+ # * "i" indicates a binary file (FTP command IMAGE)
+ # * "d" indicates the contents of a directory should be displayed
#
TYPECODE = ['a', 'i', 'd'].freeze
TYPECODE_PREFIX = ';type='.freeze
@@ -52,11 +51,43 @@ module URI
#
# == Description
#
- # Creates a new URI::FTP object from components of URI::FTP with
- # check. It is scheme, userinfo, host, port, path and typecode. It
- # provided by an Array or a Hash. typecode is "a", "i" or "d".
+ # Creates a new URI::FTP object from components, with syntax checking.
+ #
+ # The components accepted are +userinfo+, +host+, +port+, +path+ and
+ # +typecode+.
+ #
+ # The components should be provided either as an Array, or as a Hash
+ # with keys formed by preceding the component names with a colon.
+ #
+ # If an Array is used, the components must be passed in the order
+ # [userinfo, host, port, path, typecode]
+ #
+ # If the path supplied is absolute, it will be escaped in order to
+ # make it absolute in the URI. Examples:
+ #
+ # require 'uri'
+ #
+ # uri = URI::FTP.build(['user:password', 'ftp.example.com', nil,
+ # '/path/file.> zip', 'i'])
+ # puts uri.to_s -> ftp://user:password@ftp.example.com/%2Fpath/file.zip;type=a
+ #
+ # uri2 = URI::FTP.build({:host => 'ftp.example.com',
+ # :path => 'ruby/src'})
+ # puts uri2.to_s -> ftp://ftp.example.com/ruby/src
#
def self.build(args)
+
+ # Fix the incoming path to be generic URL syntax
+ # FTP path -> URL path
+ # foo/bar /foo/bar
+ # /foo/bar /%2Ffoo/bar
+ #
+ if args.kind_of?(Array)
+ args[3] = '/' + args[3].sub(/^\//, '%2F')
+ else
+ args[:path] = '/' + args[:path].sub(/^\//, '%2F')
+ end
+
tmp = Util::make_components_hash(self, args)
if tmp[:typecode]
@@ -72,16 +103,14 @@ module URI
#
# == Description
#
- # Create a new URI::FTP object from ``generic'' components with no
- # check.
+ # Creates a new URI::FTP object from generic URL components with no
+ # syntax checking.
#
- # == Usage
+ # Unlike build(), this method does not escape the path component as
+ # required by RFC1738; instead it is treated as per RFC2396.
#
- # require 'uri'
- # p ftp = URI.parse("ftp://ftp.ruby-lang.org/pub/ruby/;type=d")
- # # => #<URI::FTP:0x201fad08 URL:ftp://ftp.ruby-lang.org/pub/ruby/;type=d>
- # p ftp.typecode
- # # => "d"
+ # Arguments are +scheme+, +userinfo+, +host+, +port+, +registry+, +path+,
+ # +opaque+, +query+ and +fragment+, in that order.
#
def initialize(*arg)
super(*arg)
@@ -130,6 +159,27 @@ module URI
return tmp
end
+ # Returns the path from an FTP URI.
+ #
+ # RFC 1738 specifically states that the path for an FTP URI does not
+ # include the / which separates the URI path from the URI host. Example:
+ #
+ # ftp://ftp.example.com/pub/ruby
+ #
+ # The above URI indicates that the client should connect to
+ # ftp.example.com then cd pub/ruby from the initial login directory.
+ #
+ # If you want to cd to an absolute directory, you must include an
+ # escaped / (%2F) in the path. Example:
+ #
+ # ftp://ftp.example.com/%2Fpub/ruby
+ #
+ # This method will then return "/pub/ruby"
+ #
+ def path
+ return @path.sub(/^\//,'').sub(/^%2F/i,'/')
+ end
+
def to_s
save_path = nil
if @typecode
diff --git a/lib/uri/generic.rb b/lib/uri/generic.rb
index 88b5078466..d907e0b4b2 100644
--- a/lib/uri/generic.rb
+++ b/lib/uri/generic.rb
@@ -616,65 +616,65 @@ module URI
private :split_path
def merge_path(base, rel)
+
# RFC2396, Section 5.2, 5)
- if rel[0] == ?/ #/
- # RFC2396, Section 5.2, 5)
- return rel
+ # RFC2396, Section 5.2, 6)
+ base_path = split_path(base)
+ rel_path = split_path(rel)
+
+ # RFC2396, Section 5.2, 6), a)
+ base_path << '' if base_path.last == '..'
+ while i = base_path.index('..')
+ base_path.slice!(i - 1, 2)
+ end
- else
- # RFC2396, Section 5.2, 6)
- base_path = split_path(base)
- rel_path = split_path(rel)
-
- # RFC2396, Section 5.2, 6), a)
- base_path << '' if base_path.last == '..'
- while i = base_path.index('..')
- base_path.slice!(i - 1, 2)
- end
- if base_path.empty?
- base_path = [''] # keep '/' for root directory
- else
- base_path.pop
- end
+ if (first = rel_path.first) and first.empty?
+ base_path.clear
+ rel_path.shift
+ end
- # RFC2396, Section 5.2, 6), c)
- # RFC2396, Section 5.2, 6), d)
- rel_path.push('') if rel_path.last == '.' || rel_path.last == '..'
- rel_path.delete('.')
-
- # RFC2396, Section 5.2, 6), e)
- tmp = []
- rel_path.each do |x|
- if x == '..' &&
- !(tmp.empty? || tmp.last == '..')
- tmp.pop
- else
- tmp << x
- end
+ # RFC2396, Section 5.2, 6), c)
+ # RFC2396, Section 5.2, 6), d)
+ rel_path.push('') if rel_path.last == '.' || rel_path.last == '..'
+ rel_path.delete('.')
+
+ # RFC2396, Section 5.2, 6), e)
+ tmp = []
+ rel_path.each do |x|
+ if x == '..' &&
+ !(tmp.empty? || tmp.last == '..')
+ tmp.pop
+ else
+ tmp << x
end
+ end
- add_trailer_slash = true
- while x = tmp.shift
- if x == '..' && base_path.size > 1
- # RFC2396, Section 4
- # a .. or . in an absolute path has no special meaning
- base_path.pop
- else
- # if x == '..'
- # valid absolute (but abnormal) path "/../..."
- # else
- # valid absolute path
- # end
- base_path << x
- tmp.each {|t| base_path << t}
- add_trailer_slash = false
- break
- end
+ add_trailer_slash = !tmp.empty?
+ if base_path.empty?
+ base_path = [''] # keep '/' for root directory
+ elsif add_trailer_slash
+ base_path.pop
+ end
+ while x = tmp.shift
+ if x == '..'
+ # RFC2396, Section 4
+ # a .. or . in an absolute path has no special meaning
+ base_path.pop if base_path.size > 1
+ else
+ # if x == '..'
+ # valid absolute (but abnormal) path "/../..."
+ # else
+ # valid absolute path
+ # end
+ base_path << x
+ tmp.each {|t| base_path << t}
+ add_trailer_slash = false
+ break
end
- base_path.push('') if add_trailer_slash
-
- return base_path.join('/')
end
+ base_path.push('') if add_trailer_slash
+
+ return base_path.join('/')
end
private :merge_path