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