lib/mogilefs/new_file/common.rb

   1 # -*- encoding: binary -*-
   2 # here are internal implementation details, do not use them in your code
   3 require 'socket'
   4 require 'uri'
   5 require 'digest/md5'
   6 require 'mogilefs/chunker'
   7
   8 module MogileFS::NewFile::Common
   9   # :stopdoc:
  10   class RetryableError < MogileFS::Error; end
  11   class EmptyResponseError < RetryableError; end
  12   class BadResponseError < RetryableError; end
  13   class UnparseableResponseError < RetryableError; end
  14   class NoStorageNodesError < MogileFS::Error
  15     def message; 'Unable to open socket to storage node'; end
  16   end
  17   class NonRetryableError < MogileFS::Error; end
  18
  19   MD5_TRAILER_NODES = {} # :nodoc: # EXPERIMENTAL
  20
  21   def read_response(sock)
  22     tout = @opts[:new_file_max_time] || 3600.0
  23     start_time = @opts[:start_time] and tout -= Time.now - start_time
  24     set_socket_options(sock)
  25     case line = sock.timed_read(23, "", tout > 0.0 ? tout : 0)
  26     when %r{^HTTP/\d\.\d\s+(2\d\d)\s} # success!
  27     when nil
  28       raise EmptyResponseError, 'Unable to read response line from server'
  29     when %r{^HTTP/\d\.\d\s+(\d+)}
  30       raise BadResponseError, "HTTP response status from upload: #$1"
  31     else
  32       raise UnparseableResponseError,
  33             "Response line not understood: #{line.inspect}"
  34     end
  35   end
  36
  37   def create_close(devid, uri, bytes_uploaded)
  38     dest_info = @opts[:info] ||= {}
  39     dest_info["fid"] = @opts[:fid].to_i
  40     dest_info["key"] = @opts[:key]
  41     dest_info["domain"] = @opts[:domain]
  42     dest_info[:devid] = devid
  43     dest_info[:path] = uri.to_s
  44     dest_info[:size] = bytes_uploaded
  45     if @md5
  46       dest_info["checksum"] = "MD5:#{@md5.hexdigest}"
  47     elsif String === @opts[:content_md5]
  48       hex = @opts[:content_md5].unpack('m')[0].unpack('H*')[0]
  49       dest_info["checksum"] = "MD5:#{hex}"
  50     end
  51
  52     dest_info[:checksumverify] = 1 if @opts[:checksumverify]
  53     backend = @opts[:backend]
  54
  55     # upload could've taken a long time, ping and try to ensure socket
  56     # is valid to minimize (but not completely eliminate) the chance
  57     # create_close hits a stale socket (while reading the response after
  58     # writing to it) and becomes non-retryable.  We treat create_close
  59     # specially as its less idempotent than any other command
  60     # (even other non-idempotent ones).  There may be no hope of retrying
  61     # the upload at all if data was streamed and calling create_close
  62     # twice will hurt us...
  63     backend.noop
  64
  65     backend.create_close(dest_info)
  66
  67     # make this look like file_info + get_uris
  68     dest_info.delete(:checksumverify)
  69     dest_info.delete(:path)
  70     dest_info[:uris] = [ uri ]
  71     dest_info["devcount"] = 1
  72     dest_info["devids"] = [ dest_info.delete(:devid).to_i ]
  73     dest_info["length"] = dest_info.delete(:size)
  74
  75     bytes_uploaded
  76   end
  77
  78   # aggressive keepalive settings on Linux + Ruby 1.9.2+
  79   TCP_KEEPALIVE = {
  80     :TCP_KEEPIDLE => 60, # seconds time before keepalive packet is sent
  81     :TCP_KEEPINTVL => 5,
  82     :TCP_KEEPCNT => 2,  # number of retries
  83   }
  84
  85   req_consts = TCP_KEEPALIVE.keys
  86   if (Socket.constants & req_consts).size == req_consts.size
  87     def set_socket_options(sock)
  88       sock.setsockopt(:SOL_SOCKET, :SO_KEEPALIVE, 1)
  89       TCP_KEEPALIVE.each do |k,v|
  90         sock.setsockopt(:IPPROTO_TCP, k, v)
  91       end
  92     end
  93   else
  94     def set_socket_options(sock)
  95       sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
  96     end
  97   end
  98   # :startdoc:
  99 end