plezi 0.7.0

data/lib/plezi/server/protocols/http_protocol.rb

@@ -0,0 +1,318 @@
+module Plezi
+
+	# this module is the protocol (controller) for the HTTP server.
+	#
+	#
+	# to do: implemet logging, support body types: multipart (non-ASCII form data / uploaded files), json & xml
+	class HTTPProtocol
+
+		HTTP_METHODS = %w{GET HEAD POST PUT DELETE TRACE OPTIONS}
+
+		attr_accessor :service
+
+		def initialize service, params
+			@service = service
+			@parser_stage = 0
+			@parser_data = {}
+			@parser_body = ''
+			@parser_chunk = ''
+			@parser_length = 0
+			@locker = Mutex.new
+			@@rack_dictionary ||= {"HOST".freeze => :host_name, 'REQUEST_METHOD'.freeze => :method,
+								'PATH_INFO'.freeze => :path, 'QUERY_STRING'.freeze => :query,
+								'SERVER_NAME'.freeze => :host_name, 'SERVER_PORT'.freeze => :port,
+								'rack.url_scheme'.freeze => :requested_protocol}
+		end
+
+		# called when connection is initialized.
+		def on_connect service
+		end
+
+		# called when data is recieved.
+		#
+		# this method is called within a lock on the service (Mutex) - craeful from double locking.
+		#
+		# typically returns an Array with any data not yet processed (to be returned to the in-que)... but here it always processes (or discards) the data.
+		def on_message(service)
+			# parse the request
+			@locker.synchronize { parse_message }
+			if (@parser_stage == 1) && @parser_data[:version] >= 1.1
+				# send 100 continue message????? doesn't work! both Crome and Safari go crazy if this is sent after the request was sent (but before all the packets were recieved... msgs over 1 Mb).
+				# Plezi.push_event Proc.new { Plezi.info "sending continue signal."; service.send_nonblock "100 Continue\r\n\r\n" }
+				# service.send_unsafe_interrupt "100 Continue\r\n\r\n" # causes double lock on service
+			end
+			true
+		end
+
+		# # called when a disconnect is fired
+		# # (socket was disconnected / service should be disconnected / shutdown / socket error)
+		def on_disconnect service
+		end
+
+		# called when an exception was raised
+		# (socket was disconnected / service should be disconnected / shutdown / socket error)
+		def on_exception service, e
+			Plezi.error e
+		end
+
+
+		# Protocol specific helper methods.
+
+		# parses incoming data
+		def parse_message data = nil
+			data ||= service.read.to_s.lines.to_a
+			# require 'pry'; binding.pry
+			if 	@parser_stage == 0
+				return false unless parse_method data
+			end
+			if 	@parser_stage == 1
+				return false unless parse_head data
+			end
+			if 	@parser_stage == 2
+				return false unless parse_body data
+			end
+			true
+		end
+
+		# parses the method request (the first line in the HTTP request).
+		def parse_method data
+			return false unless data[0] && data[0].match(/^#{HTTP_METHODS.join('|')}/)
+			@parser_data[:time_recieved] = Time.now
+			@parser_data[:params] = {}
+			@parser_data[:cookies] = Cookies.new
+			@parser_data[:method] = ''
+			@parser_data[:query] = ''
+			@parser_data[:original_path] = ''
+			@parser_data[:path] = ''
+			if defined? Rack
+				@parser_data['rack.version'] = Rack::VERSION
+				@parser_data['rack.multithread'] = true
+				@parser_data['rack.multiprocess'] = false
+				@parser_data['rack.hijack?'] = false
+				@parser_data['rack.logger'] = Plezi.logger
+			end
+			@parser_data[:method], @parser_data[:query], @parser_data[:version] = data.shift.split(/[\s]+/)
+			@parser_data[:version] = (@parser_data[:version] || 'HTTP/1.1').match(/[0-9\.]+/).to_s.to_f
+			data.shift while data[0].to_s.match /^[\r\n]+/
+			@parser_stage = 1
+		end
+
+		#parses the head on a request (headers and values).
+		def parse_head data
+			until data[0].nil? || data[0].match(/^[\r\n]+$/)
+				m = data.shift.match(/^([^:]*):[\s]*([^\r\n]*)/)
+				# move cookies to cookie-jar, all else goes to headers
+				case m[1].downcase
+				when 'cookie'
+					HTTP.extract_data m[2].split(/[;,][\s]?/), @parser_data[:cookies], :uri
+				end
+				@parser_data[ HTTP.make_utf8!(m[1]).downcase ] ? (@parser_data[ HTTP.make_utf8!(m[1]).downcase ] << ", #{HTTP.make_utf8! m[2]}"): (@parser_data[ HTTP.make_utf8!(m[1]).downcase ] =  HTTP.make_utf8! m[2])
+			end
+			return false unless data[0]
+			data.shift while data[0] && data[0].match(/^[\r\n]+$/)
+			if @parser_data["transfer-coding"] || (@parser_data["content-length"] && @parser_data["content-length"].to_i != 0) || @parser_data["content-type"]
+				@parser_stage = 2
+			else					
+				# create request object and hand over to handler
+				complete_request
+				return parse_message data unless data.empty?
+			end
+			true
+		end
+
+		#parses the body of a request.
+		def parse_body data
+			# check for body is needed, if exists and if complete
+			if @parser_data["transfer-coding"] == "chunked"
+				until data.empty? || data[0].to_s.match(/0(\r)?\n/)
+					if @parser_length == 0
+						@parser_length = data.to_s.shift.match(/^[a-z0-9A-Z]+/).to_i(16)
+						@parser_chunk.clear
+					end
+					unless @parser_length == 0
+						@parser_chunk << data.shift while ( (@parser_length >= @parser_chunk.bytesize) && data[0])
+					end
+					if @parser_length <= @parser_chunk.bytesize
+						@parser_body << @parser_chunk.byteslice(0, @parser_body.bytesize)
+						@parser_length = 0
+						@parser_chunk.clear
+					end
+				end
+				return false unless data[0].to_s.match(/0(\r)?\n/)
+				true until data.empty? || data.shift.match(/^[\r\n]+$/)
+				data.shift while data[0].to_s.match /^[\r\n]+$/
+			elsif @parser_data["content-length"].to_i
+				@parser_length = @parser_data["content-length"].to_i if @parser_length == 0
+				@parser_chunk << data.shift while @parser_length > @parser_chunk.bytesize && data[0]
+				return false if @parser_length > @parser_chunk.bytesize
+				@parser_body = @parser_chunk.byteslice(0, @parser_length)
+				@parser_chunk.clear
+			else 
+				Plezi.warn 'bad body request - trying to read'
+				@parser_body << data.shift while data[0] && !data[0].match(/^[\r\n]+$/)
+			end
+			# parse body (POST parameters)
+			read_body
+
+			# complete request
+			complete_request
+
+			#read next request unless data is finished
+			return parse_message data unless data.empty?
+			true 
+		end
+
+		# completes the parsing of the request and sends the request to the handler.
+		def complete_request
+			#finalize params and query properties
+			m = @parser_data[:query].match /(([a-z0-9A-Z]+):\/\/)?(([^\/\:]+))?(:([0-9]+))?([^\?\#]*)(\?([^\#]*))?/
+			@parser_data[:requested_protocol] = m[1] || (service.ssl? ? 'https' : 'http')
+			@parser_data[:host_name] = m[4] || (@parser_data['host'] ? @parser_data['host'].match(/^[^:]*/).to_s : nil)
+			@parser_data[:port] = m[6] || (@parser_data['host'] ? @parser_data['host'].match(/:([0-9]*)/).to_a[1] : nil)
+			@parser_data[:original_path] = HTTP.decode(m[7], :uri) || '/'
+			@parser_data['host'] ||= "#{@parser_data[:host_name]}:#{@parser_data[:port]}"
+			# parse query for params - m[9] is the data part of the query
+			if m[9]
+				HTTP.extract_data m[9].split(/[&;]/), @parser_data[:params]
+			end
+
+			HTTP.make_utf8! @parser_data[:original_path]
+			@parser_data[:path] = @parser_data[:original_path].chomp('/')
+			@parser_data[:original_path].freeze
+
+			HTTP.make_utf8! @parser_data[:host_name] if @parser_data[:host_name]
+			HTTP.make_utf8! @parser_data[:query]
+
+			@parser_data[:client_ip] = @parser_data['x-forwarded-for'].to_s.split(/,[\s]?/)[0] || (service.socket.remote_address.ip_address) rescue 'unknown IP'
+
+			@@rack_dictionary.each {|k,v| @parser_data[k] = @parser_data[v]}
+
+			#create request
+			request = HTTPRequest.new service
+			request.update @parser_data
+
+			#clear current state
+			@parser_data.clear
+			@parser_body.clear
+			@parser_chunk.clear
+			@parser_length = 0
+			@parser_stage = 0
+
+			#check for server-responses
+			case request.request_method
+			when "TRACE"
+				return true
+			when "OPTIONS"
+				Plezi.push_event Proc.new do
+					response = HTTPResponse.new request
+					response[:Allow] = "GET,HEAD,POST,PUT,DELETE,OPTIONS"
+					response["access-control-allow-origin"] = "*"
+					response['content-length'] = 0
+					response.finish
+				end
+				return true
+			end
+
+			#pass it to the handler or decler error.
+			if service && service.handler
+				Plezi.callback service.handler, :on_request, request
+			else
+				Plezi.error "No Handler for this HTTP service."
+			end
+		end
+
+		# read the body's data and parse any incoming data.
+		def read_body
+			# parse content
+			case @parser_data["content-type"].to_s
+			when /x-www-form-urlencoded/
+				HTTP.extract_data @parser_body.split(/[&;]/), @parser_data[:params], :uri
+			when /multipart\/form-data/
+				read_multipart @parser_data, @parser_body
+			when /text\/xml/
+				# to-do support xml? support json?
+				@parser_data[:body] = @parser_body.dup
+			when /application\/json/
+				@parser_data[:body] = @parser_body.dup
+				JSON.parse(HTTP.make_utf8! @parser_data[:body]).each {|k, v| HTTP.add_param_to_hash k, v, @parser_data[:params]}
+			else
+				@parser_data[:body] = @parser_body.dup
+				Plezi.error "POST body type (#{@parser_data["content-type"]}) cannot be parsed. raw body is kept in the request's data as request[:body]: #{@parser_body}"
+			end
+		end
+
+		# parse a mime/multipart body or part.
+		def read_multipart headers, part, name_prefix = ''
+			if headers["content-type"].to_s.match /multipart/
+				boundry = headers["content-type"].match(/boundary=([^\s]+)/)[1]
+				if headers["content-disposition"].to_s.match /name=/
+					if name_prefix.empty?
+						name_prefix << HTTP.decode(headers["content-disposition"].to_s.match(/name="([^"]*)"/)[1])
+					else
+						name_prefix << "[#{HTTP.decode(headers["content-disposition"].to_s.match(/name="([^"]*)"/)[1])}]"
+					end
+				end
+				part.split(/([\r]?\n)?--#{boundry}(--)?[\r]?\n/).each do |p|
+					unless p.strip.empty? || p=='--'
+						# read headers
+						h = {}
+						p = p.lines
+						while p[0].match(/^[^:]+:[^\r\n]+/) 
+							m = p.shift.match(/^([^:]+):[\s]?([^\r\n]+)/)
+							h[m[1].downcase] = m[2]
+						end
+						if p[0].strip.empty?
+							p.shift
+						else
+							Plezi.error 'Expected empty line after last header - empty line missing.'
+						end
+						# send headers and body to be read
+						read_multipart h, p.join, name_prefix
+					end
+				end
+				return
+			end
+
+			# require a part body to exist (data exists) for parsing
+			return true if part.to_s.empty?
+
+			# convert part to `charset` if charset is defined?
+
+			if !headers["content-disposition"]
+				Plezi.error "Wrong multipart format with headers: #{headers} and body: #{part}"
+				return
+			end
+
+			cd = {}
+
+			HTTP.extract_data headers["content-disposition"].match(/[^;];([^\r\n]*)/)[1].split(/[;,][\s]?/), cd, :uri
+
+			name = name_prefix.dup
+
+			if name_prefix.empty?
+				name << HTTP.decode(cd[:name][1..-2])
+			else
+				name << "[#{HTTP.decode(cd[:name][1..-2])}]"
+			end
+			if headers["content-type"]
+				HTTP.add_param_to_hash "#{name}[data]", part, @parser_data[:params]
+				HTTP.add_param_to_hash "#{name}[type]", HTTP.make_utf8!(headers["content-type"]), @parser_data[:params]
+				cd.each {|k,v|  HTTP.add_param_to_hash "#{name}[#{k.to_s}]", HTTP.make_utf8!(v[1..-2]), @parser_data[:params] unless k == :name}
+			else
+				HTTP.add_param_to_hash name, HTTP.decode(part, :utf8), @parser_data[:params]
+			end
+			true
+		end
+	end
+end
+
+## Heroku/extra headers info
+
+# All headers are considered to be case-insensitive, as per HTTP Specification.
+# X-Forwarded-For: the originating IP address of the client connecting to the Heroku router
+# X-Forwarded-Proto: the originating protocol of the HTTP request (example: https)
+# X-Forwarded-Port: the originating port of the HTTP request (example: 443)
+# X-Request-Start: unix timestamp (milliseconds) when the request was received by the router
+# X-Request-Id: the Heroku HTTP Request ID
+# Via: a code name for the Heroku router
+

data/lib/plezi/server/protocols/http_request.rb

@@ -0,0 +1,133 @@
+module Plezi
+
+	# class is the base for the HTTP server.
+	#
+	# the class is initialized with a TCP/IP connection socket and starts
+	# an event driven cycle using the `EventStack.push` and `EventStack.reverse_async`.
+	#
+	# to-do: fox logging.
+	class HTTPRequest < Hash
+
+		def initialize service
+			super()
+			self[:plezi_service] = service
+		end
+
+		public
+
+		# the request's headers
+		def headers
+			self.select {|k,v| k.is_a? String }
+		end
+		# the request's method (GET, POST... etc').
+		def request_method
+			self[:method]
+		end
+		# set request's method (GET, POST... etc').
+		def request_method= value
+			self[:method] = value
+		end
+		# the parameters sent by the client.
+		def params
+			self[:params]
+		end
+		# the cookies sent by the client.
+		def cookies
+			self[:cookies]
+		end
+
+		# the query string
+		def query
+			self[:query]
+		end
+
+		# the original (frozen) path (resource requested).
+		def original_path
+			self[:original_path]
+		end
+
+		# the requested path (rewritable).
+		def path
+			self[:path]
+		end
+		def path=(new_path)
+			self[:path] = new_path
+		end
+
+		# the base url ([http/https]://host[:port])
+		def base_url switch_protocol = nil
+			"#{switch_protocol || self[:requested_protocol]}://#{self[:host_name]}#{self[:port]? ":#{self[:port]}" : ''}"
+		end
+
+		# the service (socket wrapper) that answered this request
+		def service
+			self[:plezi_service]
+		end
+		# the protocol managing this request
+		def protocol
+			self[:requested_protocol]
+		end
+		# the handler dealing with this request
+		def handler
+			self[:plezi_service].handler
+		end
+
+		# method recognition
+
+		# returns true of the method == GET
+		def get?
+			self[:method] == 'GET'
+		end
+		# returns true of the method == HEAD
+		def head?
+			self[:method] == 'HEAD'
+		end
+		# returns true of the method == POST
+		def post?
+			self[:method] == 'POST'
+		end
+		# returns true of the method == PUT
+		def put?
+			self[:method] == 'PUT'
+		end
+		# returns true of the method == DELETE
+		def delete?
+			self[:method] == 'DELETE'
+		end
+		# returns true of the method == TRACE
+		def trace?
+			self[:method] == 'TRACE'
+		end
+		# returns true of the method == OPTIONS
+		def options?
+			self[:method] == 'OPTIONS'
+		end
+		# returns true of the method == CONNECT
+		def connect?
+			self[:method] == 'CONNECT'
+		end
+		# returns true of the method == PATCH
+		def patch?
+			self[:method] == 'PATCH'
+		end
+
+	end
+end
+
+
+######
+## example requests
+
+# GET / HTTP/1.1
+# Host: localhost:2000
+# Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+# Cookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w
+# User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25
+# Accept-Language: en-us
+# Accept-Encoding: gzip, deflate
+# Connection: keep-alive
+#
+# => "GET / HTTP/1.1\n\rHost: localhost:2000\n\rAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\rCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\n\rUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\n\rAccept-Language: en-us\n\rAccept-Encoding: gzip, deflate\n\rConnection: keep-alive\n\r\n\r"
+# => "GET /people/are/friendly HTTP/1.1\n\rHost: localhost:2000\n\rAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\rCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\n\rUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\n\rAccept-Language: en-us\n\rAccept-Encoding: gzip, deflate\n\rConnection: keep-alive\n\r\n\r"
+# => "GET /girls?sexy=true HTTP/1.1\n\rHost: localhost:2000\n\rAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\rCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\n\rUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\n\rAccept-Language: en-us\n\rAccept-Encoding: gzip, deflate\n\rConnection: keep-alive\n\r\n\r"
+# chunked => "17d; ignored data=boaz\r\nGET / HTTP/1.1\r\nHost: localhost:3000\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\nCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\r\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\r\nAccept-Language: en-us\r\nAccept-Encoding: gzip, deflate\r\nConnection: keep-alive\r\nc\r\n\r\nparsed as:\r\n\r\n4f4\r\n{:raw=>\"GET / HTTP/1.1\\r\\nHost: localhost:3000\\r\\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\\r\\nCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\\r\\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\\r\\nAccept-Language: en-us\\r\\nAccept-Encoding: gzip, deflate\\r\\nConnection: keep-alive\\r\\n\\r\\n\", :plezi_service=>#<Plezi::BasicService:0x007ff4daab5ac8 @handler=Plezi::HTTPEcho, @socket=#<TCPSocket:fd 9>, @in_que=\"\", @out_que=[], @locker=#<Mutex:0x007ff4daab5a28>, @parameters={:protocol=>Plezi::HTTPProtocol, :handler=>Plezi::HTTPEcho}, @protocol=Plezi::HTTPProtocol>, :params=>{}, :cookies=>{:user_token=>\"2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\"}, :method=>\"GET\", :query=>\"/\", :original_path=>\"/\", :path=>\"/\", :version=>\"HTTP/1.1\", \"host\"=>\"localhost:3000\", \"accept\"=>\"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\", \"cookie\"=>\"user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\", \"user-agent\"=>\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\", \"accept-language\"=>\"en-us\", \"accept-encoding\"=>\"gzip, deflate\", \"connection\"=>\"keep-alive\"}\r\n0\r\n\r\n"