lib/mogilefs/mogilefs.rb

   1 # -*- encoding: binary -*-
   2
   3 # \MogileFS file manipulation client.
   4 #
   5 #   Create a new instance that will communicate with these trackers:
   6 #   hosts = %w[192.168.1.69:6001 192.168.1.70:6001]
   7 #   mg = MogileFS::MogileFS.new(:domain => 'test', :hosts => hosts)
   8 #
   9 #   # Stores "A bunch of text to store" into 'some_key' with a class of 'text'.
  10 #   mg.store_content('some_key', 'text', "A bunch of text to store")
  11 #
  12 #   # Retrieve data from 'some_key' as a string
  13 #   data = mg.get_file_data('some_key')
  14 #
  15 #   # Store the contents of 'image.jpeg' into the key 'my_image' with a
  16 #   # class of 'image'.
  17 #   mg.store_file('my_image', 'image', 'image.jpeg')
  18 #
  19 #   # Store the contents of 'image.jpeg' into the key 'my_image' with a
  20 #   # class of 'image' using an open IO object.
  21 #   File.open('image.jpeg') { |fp| mg.store_file('my_image', 'image', fp) }
  22 #
  23 #   # Retrieve the contents of 'my_image' into '/path/to/huge_file'
  24 #   # without slurping the entire contents into memory:
  25 #   mg.get_file_data('my_image', '/path/to/huge_file')
  26 #
  27 #   # Remove the key 'my_image' and 'some_key'.
  28 #   mg.delete('my_image')
  29 #   mg.delete('some_key')
  30 #
  31 class MogileFS::MogileFS < MogileFS::Client
  32   include MogileFS::Bigfile
  33
  34   # The domain of keys for this MogileFS client.
  35   attr_accessor :domain
  36
  37   # The timeout for get_file_data.  Defaults to five seconds.
  38   attr_accessor :get_file_data_timeout
  39
  40   # Creates a new MogileFS::MogileFS instance.  +args+ must include a key
  41   # :domain specifying the domain of this client.
  42   def initialize(args = {})
  43     @domain = args[:domain]
  44
  45     @get_file_data_timeout = 5
  46
  47     raise ArgumentError, "you must specify a domain" unless @domain
  48
  49     if @backend = args[:db_backend]
  50       @readonly = true
  51     else
  52       super
  53     end
  54   end
  55
  56   # Enumerates keys, limited by optional +prefix+
  57   def each_key(prefix = "", &block)
  58     after = nil
  59     begin
  60       keys, after = list_keys(prefix, after, 1000, &block)
  61     end while keys && keys[0]
  62     nil
  63   end
  64
  65   # Retrieves the contents of +key+.  If +dst+ is specified, +dst+
  66   # should be an IO-like object capable of receiving the +write+ method
  67   # or a path name.  +copy_length+ may be specified to limit the number of
  68   # bytes to retrieve, and +src_offset+ can be specified to specified the
  69   # start position of the copy.
  70   def get_file_data(key, dst = nil, copy_length = nil, src_offset = nil)
  71     paths = get_paths(key)
  72     sock = MogileFS::HTTPReader.first(paths, @get_file_data_timeout,
  73                                       copy_length, src_offset)
  74     if dst
  75       sock.stream_to(dst)
  76     elsif block_given?
  77       yield(sock)
  78     else
  79       sock.to_s
  80     end
  81     ensure
  82       sock.close if sock && ! sock.closed?
  83   end
  84
  85   # Get the paths (URLs as strings) for +key+.  If +args+ is specified,
  86   # it may contain:
  87   # - :noverify -> boolean, whether or not the tracker checks (default: true)
  88   # - :pathcount -> a positive integer of URLs to retrieve (default: 2)
  89   # - :zone -> "alt" or nil (default: nil)
  90   #
  91   # :noverify defaults to false because this client library is capable of
  92   # verifying paths for readability itself.  It is also faster and more
  93   # reliable to verify paths on the client.
  94   def get_paths(key, *args)
  95     opts = {
  96       :domain => @domain,
  97       :key => key,
  98       :noverify => args[0],
  99       :zone => args[1],
 100     }
 101     if Hash === args[0]
 102       args = args[0]
 103       opts[:noverify] = args[:noverify]
 104       opts[:zone] = args[:zone]
 105       pathcount = args[:pathcount] and opts[:pathcount] = pathcount.to_i
 106     end
 107
 108     opts[:noverify] = false == opts[:noverify] ? 0 : 1
 109     @backend.respond_to?(:_get_paths) and return @backend._get_paths(opts)
 110     res = @backend.get_paths(opts)
 111     (1..res['paths'].to_i).map { |i| res["path#{i}"] }
 112   end
 113
 114   # Returns +true+ if +key+ exists, +false+ if not
 115   def exist?(key)
 116     rv = nil
 117     args = { :key => key, :domain => @domain }
 118     @backend.pipeline_dispatch(:get_paths, args) { |x| rv = (Hash === x) }
 119     @backend.pipeline_wait(1)
 120     rv
 121   end
 122
 123   # Get the URIs for +key+ (paths) as URI::HTTP objects
 124   def get_uris(key, *args)
 125     get_paths(key, *args).map! { |path| URI.parse(path) }
 126   end
 127
 128   # Creates a new file +key+ in +klass+.  +bytes+ is currently unused.
 129   # Consider using store_file instead of this method for large files.
 130   # This requires a block passed to it and operates like File.open.
 131   # This atomically replaces existing data stored as +key+ when
 132   def new_file(key, args = nil, bytes = 0) # :yields: file
 133     raise MogileFS::ReadOnlyError if readonly?
 134     opts = { :key => key, :multi_dest => 1 }
 135     case args
 136     when Hash
 137       opts[:domain] = args[:domain]
 138       klass = args[:class] and "default" != klass and opts[:class] = klass
 139     when String
 140       opts[:class] = args if "default" != args
 141     end
 142     opts[:domain] ||= @domain
 143     res = @backend.create_open(opts)
 144
 145     dests = if dev_count = res['dev_count'] # multi_dest succeeded
 146       (1..dev_count.to_i).map { |i| [res["devid_#{i}"], res["path_#{i}"]] }
 147     else # single destination returned
 148       # 0x0040:  d0e4 4f4b 2064 6576 6964 3d31 2666 6964  ..OK.devid=1&fid
 149       # 0x0050:  3d33 2670 6174 683d 6874 7470 3a2f 2f31  =3&path=http://1
 150       # 0x0060:  3932 2e31 3638 2e31 2e37 323a 3735 3030  92.168.1.72:7500
 151       # 0x0070:  2f64 6576 312f 302f 3030 302f 3030 302f  /dev1/0/000/000/
 152       # 0x0080:  3030 3030 3030 3030 3033 2e66 6964 0d0a  0000000003.fid..
 153
 154       [[res['devid'], res['path']]]
 155     end
 156
 157     opts.merge!(args) if Hash === args
 158     opts[:backend] = @backend
 159     opts[:fid] = res['fid']
 160
 161     case (dests[0][1] rescue nil)
 162     when %r{\Ahttp://}
 163       http_file = MogileFS::HTTPFile.new(dests, opts)
 164       if block_given?
 165         yield http_file
 166         return http_file.commit # calls create_close
 167       else
 168         return http_file
 169       end
 170     when nil, ''
 171       raise MogileFS::EmptyPathError,
 172             "Empty path for mogile upload res=#{res.inspect}"
 173     else
 174       raise MogileFS::UnsupportedPathError,
 175             "paths '#{dests.inspect}' returned by backend is not supported"
 176     end
 177   end
 178
 179   # Copies the contents of +file+ into +key+ in class +klass+.  +file+ can be
 180   # either a path name (String or Pathname object) or an IO-like object that
 181   # responds to #read or #readpartial.  Returns size of +file+ stored.
 182   # This atomically replaces existing data stored as +key+
 183   def store_file(key, klass, file)
 184     raise MogileFS::ReadOnlyError if readonly?
 185
 186     new_file(key, klass) { |mfp| mfp.big_io = file }
 187   end
 188
 189   # Stores +content+ into +key+ in class +klass+, where +content+ is a String
 190   # This atomically replaces existing data stored as +key+
 191   def store_content(key, klass, content)
 192     raise MogileFS::ReadOnlyError if readonly?
 193
 194     new_file key, klass do |mfp|
 195       if content.is_a?(MogileFS::Util::StoreContent)
 196         mfp.streaming_io = content
 197       else
 198         mfp << content
 199       end
 200     end
 201   end
 202
 203   # Removes +key+.
 204   def delete(key)
 205     raise MogileFS::ReadOnlyError if readonly?
 206
 207     @backend.delete :domain => @domain, :key => key
 208     true
 209   end
 210
 211   # Sleeps +duration+, only used for testing
 212   def sleep(duration) # :nodoc:
 213     @backend.sleep :duration => duration
 214   end
 215
 216   # Renames a key +from+ to key +to+.
 217   def rename(from, to)
 218     raise MogileFS::ReadOnlyError if readonly?
 219
 220     @backend.rename :domain => @domain, :from_key => from, :to_key => to
 221     nil
 222   end
 223
 224   # Returns the size of +key+.
 225   def size(key)
 226     @backend.respond_to?(:_size) and return @backend._size(domain, key)
 227     begin
 228       file_info(key)["length"].to_i
 229     rescue MogileFS::Backend::UnknownCommandError
 230       paths_size(get_paths(key))
 231     end
 232   end
 233
 234   def paths_size(paths) # :nodoc:
 235     require "mogilefs/paths_size"
 236     MogileFS::PathsSize.call(paths)
 237   end
 238
 239   # Lists keys starting with +prefix+ following +after+ up to +limit+.  If
 240   # +after+ is nil the list starts at the beginning.
 241   def list_keys(prefix = "", after = nil, limit = 1000, &block)
 242     @backend.respond_to?(:_list_keys) and
 243       return @backend._list_keys(domain, prefix, after, limit, &block)
 244
 245     begin
 246       res = @backend.list_keys(:domain => domain, :prefix => prefix,
 247                                :after => after, :limit => limit)
 248     rescue MogileFS::Backend::NoneMatchError
 249       return
 250     end
 251
 252     keys = (1..res['key_count'].to_i).map { |i| res["key_#{i}"] }
 253     if block
 254       if 1 == block.arity
 255         keys.each { |key| block.call(key) }
 256       else
 257         list_keys_verbose(keys, block)
 258       end
 259     end
 260
 261     [ keys, res['next_after'] ]
 262   end
 263
 264   def list_keys_verbose(keys, block) # :nodoc:
 265     # emulate the MogileFS::Mysql interface, slowly...
 266     ordered = keys.dup
 267     ready = {}
 268     on_file_info = lambda do |info|
 269       Hash === info or raise info
 270       file_info_cleanup(info)
 271
 272       # deal with trackers with multiple queryworkers responding out-of-order
 273       ready[info["key"]] = info
 274       while info = ready.delete(ordered[0])
 275         block.call(ordered.shift, info["length"], info["devcount"])
 276       end
 277     end
 278     opts = { :domain => @domain }
 279     begin
 280       keys.each do |key|
 281         opts[:key] = key
 282         @backend.pipeline_dispatch(:file_info, opts, &on_file_info)
 283       end
 284       @backend.pipeline_wait
 285     rescue MogileFS::Backend::UnknownCommandError # MogileFS < 2.45
 286       @backend.shutdown # reset the socket
 287       args = { :pathcount => 0x7fffffff }
 288       keys.each do |key|
 289         paths = get_paths(key, args)
 290         block.call(key, paths_size(paths), paths.size)
 291       end
 292     rescue MogileFS::PipelineError, SystemCallError,
 293            MogileFS::RequestTruncatedError,
 294            MogileFS::UnreadableSocketError,
 295            MogileFS::InvalidResponseError, # truncated response
 296            MogileFS::Timeout
 297       @backend.shutdown
 298       keys = ordered - ready.keys
 299       retry
 300     rescue
 301       @backend.shutdown
 302       raise
 303     end
 304   end
 305
 306   # Return metadata about a file as a hash.
 307   # Returns the domain, class, length, devcount, etc. as keys.
 308   # Optionally, device ids (not paths) can be returned as
 309   # well if :devices is specified and +true+.
 310   #
 311   # This should only be used for informational purposes, and not usually
 312   # for dynamically serving files.
 313   #
 314   #   mg.file_info("bar")
 315   #
 316   # Returns:
 317   #
 318   #   {
 319   #     "domain" => "foo",
 320   #     "key" => "bar",
 321   #     "class" => "default",
 322   #     "devcount" => 2,
 323   #     "length => 666
 324   #   }
 325   def file_info(key, args = nil)
 326     opts = { :domain => @domain, :key => key }
 327     args and devices = args[:devices] and opts[:devices] = devices ? 1 : 0
 328     file_info_cleanup(@backend.file_info(opts))
 329   end
 330
 331   def file_info_cleanup(rv) # :nodoc:
 332     %w(fid length devcount).each { |f| rv[f] = rv[f].to_i }
 333     devids = rv["devids"] and
 334       rv["devids"] = devids.split(/,/).map! { |x| x.to_i }
 335     rv
 336   end
 337
 338   # Given an Integer +fid+ or String +key+ and domain, thorougly search
 339   # the database for all occurences of a particular fid.
 340   #
 341   # Use this sparingly, this command hits the master database numerous
 342   # times and is very expensive.  This is not for production use, only
 343   # troubleshooting and debugging.
 344   #
 345   # Searches for fid=666:
 346   #
 347   #   client.file_debug(666)
 348   #
 349   # Search for key=foo using the default domain for this object:
 350   #
 351   #   client.file_debug("foo")
 352   #
 353   # Search for key=foo in domain="bar":
 354   #
 355   #   client.file_debug(:key => "foo", :domain => "bar")
 356   #
 357   def file_debug(args)
 358     case args
 359     when Integer then args = { "fid" => args }
 360     when String then args = { "key" => args }
 361     end
 362     opts = { :domain => args[:domain] || @domain }.merge!(args)
 363
 364     rv = @backend.file_debug(opts)
 365     rv.each do |k,v|
 366       case k
 367       when /_(?:classid|devcount|dmid|fid|length|
 368             nexttry|fromdevid|failcount|flags|devid|type)\z/x
 369         rv[k] = v.to_i
 370       when /devids\z/
 371         rv[k] = v.split(/,/).map! { |x| x.to_i }
 372       end
 373     end
 374   end
 375 end