nyara 0.0.1.pre.6 → 0.0.1.pre.8

data/lib/nyara/controllers/public_controller.rb

@@ -0,0 +1,14 @@
+module Nyara
+  # serve public dir
+  class PublicController < Controller
+    get '/%z' do |path|
+      path = Config.public_path path
+      if path and File.file?(path)
+        send_file path
+      else
+        status 404
+        Ext.request_send_data request, "HTTP/1.1 404 Not Found\r\nConnection: close\r\nContent-Length: 0\r\n\r\n"
+      end
+    end
+  end
+end

data/lib/nyara/cookie.rb

@@ -1,15 +1,16 @@
 module Nyara
-  # http://www.ietf.org/rfc/rfc6265.txt (don't look at rfc2109)
+  # rfc6265 (don't look at rfc2109)
   module Cookie
     extend self
 
     # encode to string value
     def encode h
       h.map do |k, v|
-        "#{CGI.escape k.to_s}=#{CGI.escape v.to_s}"
+        "#{Ext.escape k.to_s, false}=#{Ext.escape v.to_s, false}"
       end.join '; '
     end
 
+    # for test
     def decode header
       res = ParamHash.new
       if data = header['Cookie']
@@ -21,9 +22,9 @@ module Nyara
     def add_set_cookie header_lines, k, v, expires: nil, max_age: nil, domain: nil, path: nil, secure: nil, httponly: true
       r = "Set-Cookie: "
       if v.nil? or v == true
-        r << "#{CGI.escape k.to_s}; "
+        r << "#{Ext.escape k.to_s, false}; "
       else
-        r << "#{CGI.escape k.to_s}=#{CGI.escape v.to_s}; "
+        r << "#{Ext.escape k.to_s, false}=#{Ext.escape v.to_s, false}; "
       end
       r << "Expires=#{expires.to_time.gmtime.rfc2822}; " if expires
       r << "Max-Age=#{max_age.to_i}; " if max_age

data/lib/nyara/flash.rb

@@ -1,4 +1,6 @@
 module Nyara
+  # convenient thingy that let you can pass instant message to next request<br>
+  # it is consumed as soon as next request arrives
   class Flash
     def initialize session
       # NOTE no need to convert hash type because Session uses ParamHash for json parsing

data/lib/nyara/nyara.rb

@@ -8,6 +8,7 @@ require "uri"
 require "openssl"
 require "socket"
 require "tilt"
+require "time"
 
 require_relative "../../ext/nyara"
 require_relative "hashes/param_hash"
@@ -26,6 +27,9 @@ require_relative "view"
 require_relative "cpu_counter"
 require_relative "part"
 
+# default controllers
+require_relative "controllers/public_controller"
+
 module Nyara
   HTTP_STATUS_FIRST_LINES = Hash[HTTP_STATUS_CODES.map{|k,v|[k, "HTTP/1.1 #{k} #{v}\r\n".freeze]}].freeze
 
@@ -41,6 +45,18 @@ module Nyara
   OK_RESP_HEADER['X-Content-Type-Options'] = 'nosniff'
   OK_RESP_HEADER['X-Frame-Options'] = 'SAMEORIGIN'
 
+  START_CTX = {
+    0 => $0.dup,
+    argv: ARGV.map(&:dup),
+    cwd: (begin
+      a = File.stat(pwd = ENV['PWD'])
+      b = File.stat(Dir.pwd)
+      a.ino == b.ino && a.dev == b.dev ? pwd : Dir.pwd
+    rescue
+      Dir.pwd
+    end)
+  }
+
   class << self
     def config
       raise ArgumentError, 'block not accepted, did you mean Nyara::Config.config?' if block_given?
@@ -49,12 +65,14 @@ module Nyara
 
     def setup
       Session.init
+      Config.init
       Route.compile
+      # todo lint if SomeController#request is re-defined
       View.init
     end
 
     def start_server
-      port = Config[:port] || 3000
+      port = Config[:port]
 
       puts "starting #{Config[:env]} server at 0.0.0.0:#{port}"
       case Config[:env].to_s
@@ -74,28 +92,11 @@ module Nyara
       require_relative "patches/tcp_socket"
     end
 
-    def start_production_server port
-      workers = Config[:workers] || ((CpuCounter.count + 1)/ 2)
-
-      puts "workers: #{workers}"
-      server = TCPServer.new '0.0.0.0', port
-      server.listen 1000
+    def start_development_server port
       trap :INT do
-        @workers.each do |w|
-          Process.kill :KILL, w
-        end
+        exit!
       end
-      GC.start
-      @workers = workers.times.map do
-        fork {
-          Ext.init_queue
-          Ext.run_queue server.fileno
-        }
-      end
-      Process.waitall
-    end
 
-    def start_development_server port
       t = Thread.new do
         server = TCPServer.new '0.0.0.0', port
         server.listen 1000
@@ -104,5 +105,137 @@ module Nyara
       end
       t.join
     end
+
+    # Signals:
+    #
+    # [INT]   kill -9 all workers, and exit
+    # [QUIT]  graceful quit all workers, and exit if all children terminated
+    # [TERM]  same as QUIT
+    # [USR1]  restore worker number
+    # [USR2]  graceful spawn a new master and workers, with all content respawned
+    # [TTIN]  increase worker number
+    # [TTOUT] decrease worker number
+    #
+    # To make a graceful hot-restart:
+    #
+    # 1. USR2 -> old master
+    # 2. if good (workers are up, etc), QUIT -> old master, else QUIT -> new master and fail
+    # 3. if good (requests are working, etc), INT -> old master
+    #    else QUIT -> new master and USR1 -> old master to restore workers
+    #
+    # NOTE in step 2/3 if an additional fork executed in new master and hangs,
+    #      you may need send an additional INT to terminate it.<br>
+    # NOTE hot-restart reloads almost everything, including Gemfile changes and configures except port.
+    #      but, if some critical environment variable or port configure needs change, you still need cold-restart.<br>
+    # TODO write to a file to show workers are good<br>
+    # TODO detect port config change
+    def start_production_server port
+      workers = Config[:workers]
+
+      puts "workers: #{workers}"
+
+      if (server_fd = ENV['NYARA_FD'].to_i) > 0
+        puts "inheriting server fd #{server_fd}"
+        @server = TCPServer.for_fd server_fd
+      end
+      unless @server
+        @server = TCPServer.new '0.0.0.0', port
+        @server.listen 1000
+        ENV['NYARA_FD'] = @server.fileno.to_s
+      end
+
+      GC.start
+      @workers = []
+      workers.times do
+        incr_workers nil
+      end
+
+      trap :INT,  &method(:kill_all)
+      trap :QUIT, &method(:quit_all)
+      trap :TERM, &method(:quit_all)
+      trap :USR2, &method(:spawn_new_master)
+      trap :USR1, &method(:restore_workers)
+      trap :TTIN do
+        if Config[:workers] > 1
+          Config[:workers] -= 1
+          decr_workers nil
+        end
+      end
+      trap :TTOU do
+        Config[:workers] += 1
+        incr_workers nil
+      end
+      Process.waitall
+    end
+
+    private
+
+    # kill all workers and exit
+    def kill_all sig
+      @workers.each do |w|
+        Process.kill :KILL, w
+      end
+      exit!
+    end
+
+    # graceful quit all workers and exit
+    def quit_all sig
+      until @workers.empty?
+        decr_workers sig
+      end
+      # wait will finish the wait-and-quit job
+    end
+
+    # spawn a new master
+    def spawn_new_master sig
+      fork do
+        @server.close_on_exec = false
+        Dir.chdir START_CTX[:cwd]
+        if File.executable?(START_CTX[0])
+          exec START_CTX[0], *START_CTX[:argv], close_others: false
+        else
+          # gemset env should be correct because env is inherited
+          require "rbconfig"
+          ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
+          exec ruby, START_CTX[0], *START_CTX[:argv], close_others: false
+        end
+      end
+    end
+
+    # restore number of workers as Config
+    def restore_workers sig
+      (Config[:workers] - @workers.size).times do
+        incr_workers sig
+      end
+    end
+
+    # graceful decrease worker number by 1
+    def decr_workers sig
+      w = @workers.shift
+      puts "killing worker #{w}"
+      Process.kill :QUIT, w
+    end
+
+    # increase worker number by 1
+    def incr_workers sig
+      pid = fork {
+        $0 = "(nyara:worker) ruby #{$0}"
+
+        trap :QUIT do
+          Ext.graceful_quit @server.fileno
+        end
+
+        trap :TERM do
+          Ext.graceful_quit @server.fileno
+        end
+
+        t = Thread.new do
+          Ext.init_queue
+          Ext.run_queue @server.fileno
+        end
+        t.join
+      }
+      @workers << pid
+    end
   end
 end

data/lib/nyara/patches/to_query.rb

@@ -1,5 +1,4 @@
 # copied from activesupport
-require "cgi"
 
 =begin
 Copyright (c) 2005-2013 David Heinemeier Hansson
@@ -93,7 +92,7 @@ class Object
   #
   # Note: This method is defined as a default implementation for all Objects for Hash#to_query to work.
   def to_query(key)
-    "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+    "#{Nyara::Ext.escape key.to_param, false}=#{Nyara::Ext.escape to_param.to_s, false}"
   end
 end
 

data/lib/nyara/request.rb

@@ -128,10 +128,5 @@ module Nyara
         q
       end
     end
-
-    # todo rename and move it into Ext
-    def not_found # :nodoc:
-      Ext.request_send_data self, "HTTP/1.1 404 Not Found\r\nConnection: close\r\nContent-Length: 0\r\n\r\n"
-    end
   end
 end

data/lib/nyara/route.rb

@@ -8,7 +8,7 @@ module Nyara
         raise ArgumentError, "route prefix should be a string"
       end
       scope = scope.dup.freeze
-      (@controllers ||= {})[scope] = controller
+      (@controllers ||= []) << [scope, controller]
     end
 
     def compile
@@ -51,7 +51,7 @@ module Nyara
     def clear
       # gc mark fail if wrong order?
       Ext.clear_route
-      @controllers = {}
+      @controllers = []
     end
 
     # private

data/lib/nyara/route_entry.rb

@@ -70,7 +70,7 @@ module Nyara
     def compile_re suffix
       return ['', []] unless suffix
       conv = []
-      re_segs = suffix.split(/(?<=%[dfsux])|(?=%[dfsux])/).map do |s|
+      re_segs = suffix.split(/(?<=%[dfsuxz])|(?=%[dfsuxz])/).map do |s|
         case s
         when '%d'
           conv << :to_i
@@ -90,7 +90,7 @@ module Nyara
           '([^/]+)'
         when '%z'
           conv << :to_s
-          '(.+)'
+          '(.*)'
         else
           Regexp.quote s
         end
@@ -98,13 +98,14 @@ module Nyara
       ["^#{re_segs.join}$", conv]
     end
 
-    # split the path into parts
+    # split the path into 2 parts: <br>
+    # fixed prefix and variable suffix
     def analyse_path path
       raise 'path must contain no new line' if path.index "\n"
       raise 'path must start with /' unless path.start_with? '/'
       path = path.sub(/\/$/, '') if path != '/'
 
-      path.split(/(?=%[dfsux])/, 2)
+      path.split(/(?=%[dfsuxz])/, 2)
     end
   end
 end

data/lib/nyara/session.rb

@@ -1,5 +1,5 @@
 module Nyara
-  # helper module for session management, cookie based<br>
+  # cookie based session<br>
   # (usually it's no need to call cache or database data a "session")<br><br>
   # session is by default DSA + SHA2/SHA1 signed, sub config options are:
   #
@@ -10,8 +10,11 @@ module Nyara
   #              - +true+: always add +Secure+
   #              - +false+: always no +Secure+
   # [key]        DSA private key string, in der or pem format, use random if not given
-  # [cipher_key] if exist, use aes-256-cbc to cipher the "sig/json"<br>
-  #              NOTE: it's no need to set +cipher_key+ if using https
+  # [cipher_key] if exist, use aes-256-cbc to cipher the json instead of just base64 it<br>
+  #              it's useful if you need to hide something but can't stop yourself from putting it into session,<br>
+  #              and one of the following condition matches:
+  #              - not using http, and need to hide the info from middlemen
+  #              - you've put something in session current_user should not see
   #
   # = example
   #
@@ -20,15 +23,27 @@ module Nyara
   #     set 'session', 'expire', 30 * 60
   #   end
   #
-  module Session
-    extend self
+  # Please be careful with session key and cipher key, they should be separated from source code, and never shown to public.
+  class Session < ParamHash
+    attr_reader :init_digest, :init_data
+
+    # if the session is init with nothing, and flash is clear
+    def vanila?
+      if @init_digest.nil?
+        empty? or size == 1 && has_key?('flash.next') && self['flash.next'].empty?
+      end
+    end
+  end
 
+  class << Session
     CIPHER_BLOCK_SIZE = 256/8
+    CIPHER_RAND_MAX = 36**CIPHER_BLOCK_SIZE
+    JSON_DECODE_OPTS = {create_additions: false, object_class: Session}
 
     # init from config
     def init
       c = Config['session'] ? Config['session'].dup : {}
-      @name = (c.delete('name') || 'spare_me_plz').to_s
+      @name = Ext.escape (c.delete('name') || 'spare_me_plz').to_s, false
 
       if c['key']
         @dsa = OpenSSL::PKey::DSA.new c.delete 'key'
@@ -56,41 +71,51 @@ module Nyara
       cookie[@name] = encode h
     end
 
-    # encode to value
+    # encode to value<br>
+    # return h.init_data if not changed
     def encode h
+      return h.init_data if h.vanila?
       str = h.to_json
-      sig = @dsa.syssign @dss.digest str
-      str = "#{encode64 sig}/#{encode64 str}"
-      @cipher_key ? cipher(str) : str
+      str = @cipher_key ? cipher(str) : encode64(str)
+      digest = @dss.digest str
+      return h.init_data if digest == h.init_digest
+
+      sig = @dsa.syssign digest
+      "#{encode64 sig}/#{str}"
     end
 
     # encode as header line
     def encode_set_cookie h, secure
       secure = @secure unless @secure.nil?
       expire = (Time.now + @expire).gmtime.rfc2822 if @expire
-      "Set-Cookie: #{@name}=#{encode h}; HttpOnly#{'; Secure' if secure}#{"; Expires=#{expire}" if expire}\r\n"
+      # NOTE +encode h+ may return empty value, but it's still fine
+      "Set-Cookie: #{@name}=#{encode h}; Path=/; HttpOnly#{'; Secure' if secure}#{"; Expires=#{expire}" if expire}\r\n"
     end
 
+    # decode the session hash from cookie
     def decode cookie
-      str = cookie[@name].to_s
-      return empty_hash if str.empty?
+      data = cookie[@name].to_s
+      return empty_hash if data.empty?
 
-      str = decipher(str) if @cipher_key
-      sig, str = str.split '/', 2
+      sig, str = data.split '/', 2
       return empty_hash unless str
 
+      h = nil
+      digest = nil
       begin
         sig = decode64 sig
-        str = decode64 str
-        verified = @dsa.sysverify @dss.digest(str), sig
-        if verified
-          h = JSON.parse str, create_additions: false, object_class: ParamHash
+        digest = @dss.digest str
+        if @dsa.sysverify(digest, sig)
+          str = @cipher_key ? decipher(str) : decode64(str)
+          h = JSON.parse str, JSON_DECODE_OPTS
         end
       ensure
         return empty_hash unless h
       end
 
-      if h.is_a?(ParamHash)
+      if h.is_a?(Session)
+        h.instance_variable_set :@init_digest, digest
+        h.instance_variable_set :@init_data, data
         h
       else
         empty_hash
@@ -112,7 +137,7 @@ module Nyara
     end
 
     def cipher str
-      iv = rand(36**CIPHER_BLOCK_SIZE).to_s(36).ljust CIPHER_BLOCK_SIZE
+      iv = rand(CIPHER_RAND_MAX).to_s(36).ljust CIPHER_BLOCK_SIZE
       c = new_cipher true, iv
       encode64(iv.dup << c.update(str) << c.final)
     end
@@ -135,7 +160,7 @@ module Nyara
 
     def empty_hash
       # todo invoke hook?
-      ParamHash.new
+      Session.new
     end
 
     def new_cipher encrypt, iv

data/lib/nyara/test.rb

@@ -26,7 +26,7 @@ module Nyara
       def initialize response_size_limit=5_000_000
         self.response_size_limit = response_size_limit
         self.cookie = ParamHash.new
-        self.session = ParamHash.new
+        self.session = Session.new
       end
 
       def process_request_data data
@@ -39,14 +39,17 @@ module Nyara
         response_data = client.read_nonblock response_size_limit
         self.response = Response.new response_data
 
-        # merge session
-        session.clear
-        session.merge! request.session
-
-        # merge Set-Cookie
-        response.set_cookies.each do |cookie_seg|
-          # todo distinguish delete, value and set
-          Ext.parse_url_encoded_seg cookie, cookie_seg, false
+        # no env when route not found
+        if request.session
+          # merge session
+          session.clear
+          session.merge! request.session
+
+          # merge Set-Cookie
+          response.set_cookies.each do |cookie_seg|
+            # todo distinguish delete, value and set
+            Ext.parse_url_encoded_seg cookie, cookie_seg, false
+          end
         end
 
         server.close
@@ -77,7 +80,7 @@ module Nyara
         Session.encode_to_cookie session, cookie
         headers['Cookie'] = Cookie.encode cookie
 
-        request_data = ["#{meth.upcase} #{path} HTTP/1.1\r\n"]
+        request_data = ["#{meth.upcase} #{Ext.escape path, true} HTTP/1.1\r\n"]
         headers.each do |k, v|
           request_data << "#{k}: #{v}\r\n"
         end

data/lib/nyara/view.rb

@@ -17,8 +17,6 @@ module Nyara
   #
   # Friend layout and friend page shares one buffer, but enemy layout just concats +buffer.join+ before we flush friend layout.
   # So the simple solution is: templates other than stream-friendly ones are not allowed to be a layout.
-  #
-  # Note on Erubis: to support streaming, Erubis is disabled even loaded.
   class View
     # ext (without dot) => most preferrable content type (e.g. "text/html")
     ENGINE_DEFAULT_CONTENT_TYPES = ParamHash.new
@@ -26,7 +24,18 @@ module Nyara
     # ext (without dot) => stream friendly
     ENGINE_STREAM_FRIENDLY = ParamHash.new
 
+    autoload :ERB,    File.join(__dir__, "view_handlers/erb")
+    autoload :Erubis, File.join(__dir__, "view_handlers/erubis")
+    autoload :Haml,   File.join(__dir__, "view_handlers/haml")
+    autoload :Slim,   File.join(__dir__, "view_handlers/slim")
+
     class Buffer < Array
+      alias safe_append= <<
+
+      def append= thingy
+        self << CGI.escape_html(thingy.to_s)
+      end
+
       def join
         r = super
         clear
@@ -39,6 +48,11 @@ module Nyara
         @root = Config['views']
         @meth2ext = {} # meth => ext (without dot)
         @meth2sig = {}
+        @ext_list = Tilt.mappings.keys.delete_if(&:empty?).join ','
+        if @ext_list !~ /\bslim\b/
+          @ext_list = "slim,#{@ext_list}"
+        end
+        @ext_list = "{#{@ext_list}}"
       end
       attr_reader :root
 
@@ -80,7 +94,7 @@ module Nyara
           sig = @meth2sig[meth].map{|k| "#{k}: nil" }.join ','
           sig = '_={}' if sig.empty?
           sig = "(#{sig})" # 2.0.0-p0 requirement
-          Renderable.class_eval <<-RUBY, path, 1
+          Renderable.class_eval <<-RUBY, path, 0
             def render#{sig}
               #{src}
             end
@@ -133,7 +147,6 @@ module Nyara
       # returns +[meth, ext_without_dot]+
       def template path, locals={}
         if File.extname(path).empty?
-          @ext_list ||= Tilt.mappings.keys.delete_if(&:empty?).join ','
           Dir.chdir @root do
             paths = Dir.glob("#{path}.{#@ext_list}")
             if paths.size > 1
@@ -157,53 +170,18 @@ module Nyara
 
       # Block is lazy invoked when it's ok to read the template source.
       def precompile ext
-        src_method =\
-          case ext
-          when 'slim'
-            :slim_src
-          when 'erb', 'rhtml'
-            :erb_src
-          when 'haml'
-            :haml_src
+        case ext
+        when 'slim'
+          Slim.src yield
+        when 'erb', 'rhtml'
+          if Config['prefer_erb']
+            ERB.src yield
+          else
+            Erubis.src yield
           end
-        return unless src_method
-
-        send src_method, yield
-      end
-
-      def erb_src template
-        @erb_compiler ||= begin
-          c            = ERB::Compiler.new '<>' # trim mode
-          c.pre_cmd    = ["_erbout = @_nyara_view.out"]
-          c.put_cmd    = "_erbout.push"   # after newline
-          c.insert_cmd = "_erbout.push"   # before newline
-          c.post_cmd   = ["_erbout.join"]
-          c
+        when 'haml'
+          Haml.src yield
         end
-        src, enc = @erb_compiler.compile template
-        # todo do sth with enc?
-        src
-      end
-
-      def slim_src template
-        # todo pretty by env
-        t = Slim::Template.new(nil, nil, pretty: false){ template }
-        src = t.instance_variable_get :@src
-        if src.start_with?('_buf = []')
-          src.sub! '_buf = []', '_buf = @_nyara_view.out'
-        end
-        src
-      end
-
-      def haml_src template
-        e = Haml::Engine.new template
-        # todo trim mode
-        <<-RUBY
-_hamlout = Haml::Buffer.new(nil, encoding: 'utf-8')
-_hamlout.buffer = @_nyara_view.out
-#{e.precompiled}
-_hamlout.buffer.join
-RUBY
       end
 
       def path2meth path

data/lib/nyara/view_handlers/erb.rb

@@ -0,0 +1,21 @@
+require "erb"
+
+module Nyara
+  class View
+    module ERB
+      def self.src template
+        @erb_compiler ||= begin
+          c            = ::ERB::Compiler.new '<>' # trim mode
+          c.pre_cmd    = ["_erbout = @_nyara_view.out"]
+          c.put_cmd    = "_erbout.push"   # after newline
+          c.insert_cmd = "_erbout.push"   # before newline
+          c.post_cmd   = ["_erbout.join"]
+          c
+        end
+        src, enc = @erb_compiler.compile template
+        # todo do sth with enc?
+        src
+      end
+    end
+  end
+end