gloo-web 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f65c05593ecaa1245da14193d91d7302b3c831dc211e4e2ff3803d4c923159c7
-  data.tar.gz: 85d932c0ceca6e2108076a5e243ea4b927e2e605a36f90444d81646c023212d4
+  metadata.gz: 76804bbf747238b84d964890005f32e2a6d801b3926169120da712ff542d52b1
+  data.tar.gz: 907cac263a2583f2c8fa6d1a9b59a5aa2f4542c4e5bad0a7f9a025fb2c153029
 SHA512:
-  metadata.gz: 48c826d58586853dee37b4a616748847f7111bb5f4fe4afc90d2ca56f052dd4d3c45b76ec10e5ced598b6051bd2ab6770da49fecd0da569df9d832a693a76296
-  data.tar.gz: 44df546269144ffcaac4efe96404ab061ecf4f2dfd49fefb4c3dd2add2904702dfa51e5fe69ad40a5c0051365fd4d9c95a5a8c185b49deb1dca925e98b773aee
+  metadata.gz: ef2ae150df15c224c1106a5ef35a0f5ad38b498f5791f36add563a90655b2428ca0ba5ee4710938821287a887a2baa663fed53a84e53aaa8a8085c179d489930
+  data.tar.gz: d5e7582e24bf8b1a0418dbe9c9c20cf02a73acebbf61bd70215f971a0353faf8bf53a2017f368f125f2df19b768b4231ff4cc8e572c0b0cc96ca5f17b3e0878a

data/lib/objs/element.rb

@@ -169,7 +169,7 @@ module Objs
     end
 
     #
-    # Get the expiration date for the certificate.
+    # Render the element as HTML and put it in it.
     #
     def msg_render
       content = self.render_html
@@ -239,11 +239,15 @@ module Objs
       return rendered_obj_content
     end
 
+    #
+    # Render a string or other object; an unexpected failure is
+    # handled and renders as blank.
+    #
     def self.render_thing e, render_ƒ, engine
       begin
         return e.render( render_ƒ )
       rescue => e
-        engine.log_exception e
+        engine.handle_exception e
         return ''
       end
     end
@@ -265,7 +269,7 @@ module Objs
           'content (container) — The element contents.'
         ],
         :messages => [
-          'render — Manually render the HTML element. Normally the render is called by the web server when the page containing the element is requested.'
+          'render — Manually render the HTML element; the HTML is put in it. Normally the render is called by the web server when the page containing the element is requested.'
         ],
         :examples => <<~EXAMPLES.strip
           div_sub [e] :

data/lib/objs/field.rb

@@ -453,7 +453,7 @@ module Objs
           'checked (boolean) — Optional; only used for checkbox fields. Whether the checkbox field is checked.'
         ],
         :messages => [
-          'render — Manually render the HTML field. Normally the render is called by the web server when the page containing the element is requested.'
+          'render — Manually render the HTML field; the HTML is put in it. Normally the render is called by the web server when the page containing the element is requested.'
         ],
         :examples => <<~EXAMPLES.strip
           f [form] :

data/lib/objs/form.rb

@@ -260,7 +260,7 @@ module Objs
       begin
         return e.render( 'render_html' )
       rescue => e
-        @engine.log_exception e
+        @engine.handle_exception e
         return ''
       end
     end
@@ -286,7 +286,7 @@ module Objs
           'content (container) — The collection of form fields. Other elements can also be included here, for formatting or extra buttons.'
         ],
         :messages => [
-          'render — Manually render the HTML form. Normally the render is called by the web server when the page containing the element is requested.'
+          'render — Manually render the HTML form; the HTML is put in it. Normally the render is called by the web server when the page containing the element is requested.'
         ],
         :examples => <<~EXAMPLES.strip
           page [can] :

data/lib/objs/page.rb

@@ -314,14 +314,30 @@ module Objs
     end
 
     #
-    # Get the expiration date for the certificate.
+    # Render the page and put the content (HTML, JSON or text) in it,
+    # or false if it can't render. Only works inside a running web app.
     #
     def msg_render
-      content = self.render
-      @engine.heap.it.set_to content 
+      return nil unless Page.can_render?( @engine, self )
+
+      response = self.render
+      content = response&.data
+      @engine.heap.it.set_to( content.nil? ? false : content )
       return content
     end
 
+    #
+    # Is a web app running, so the object can render? If not, report
+    # it and put false in it. Shared with partial.
+    #
+    def self.can_render?( engine, obj )
+      return true if engine.app_running?
+
+      engine.err "#{obj.type_display} '#{obj.name}' can only render inside a web app (gloo-web)."
+      engine.heap.it.set_to false
+      return false
+    end
+
 
     # ---------------------------------------------------------------------
     #    Render
@@ -584,7 +600,7 @@ module Objs
           'download_file (boolean) — Optional, default false. If true, the browser is instructed to download the file instead of rendering it.'
         ],
         :messages => [
-          'render — Manually render the content of the page. Normally the render is called by the web server when the page is requested.'
+          'render — Manually render the content of the page; the content (HTML, JSON or text) is put in it, or false if it can\'t render. Only works inside a running web app (it is an error otherwise). Normally the render is called by the web server when the page is requested.'
         ],
         :examples => <<~EXAMPLES.strip
           page [can] :

data/lib/objs/partial.rb

@@ -140,11 +140,14 @@ module Objs
     end
 
     #
-    # Get the expiration date for the certificate.
+    # Render the partial and put the HTML in it, or false if it can't
+    # render. Only works inside a running web app.
     #
     def msg_render
+      return nil unless Page.can_render?( @engine, self )
+
       part_content = self.render
-      @engine.heap.it.set_to part_content 
+      @engine.heap.it.set_to( part_content.nil? ? false : part_content )
       return part_content
     end
 
@@ -226,7 +229,7 @@ module Objs
           'content (element) — The contents of the partial page.'
         ],
         :messages => [
-          'render — Manually render the content of the partial page. Normally the render is called by the web server when the page containing the partial is requested.'
+          'render — Manually render the content of the partial page; the HTML is put in it, or false if it can\'t render. Only works inside a running web app (it is an error otherwise). Normally the render is called by the web server when the page containing the partial is requested.'
         ],
         :examples => <<~EXAMPLES.strip
           shared [can] :

data/lib/objs/svr.rb

@@ -58,9 +58,10 @@ module Objs
     # Default layout for pages.
     LAYOUT = 'layout'.freeze
 
-    # Alias to the home and error pages
+    # Alias to the home, error and not found pages
     HOME = 'home'.freeze
     ERR_PAGE = 'error'.freeze
+    NOT_FOUND_PAGE = 'not_found'.freeze
 
     # Session
     SESSION = 'session'.freeze
@@ -68,6 +69,7 @@ module Objs
 
     # Messages
     SERVER_NOT_RUNNING = 'The web server is not running!'.freeze
+    SERVER_ALREADY_RUNNING = 'The web server is already running!'.freeze
 
     # 
     # Should the current request be redirected?
@@ -123,13 +125,20 @@ module Objs
     #    Configuration
     # ---------------------------------------------------------------------
 
+    #
+    # Get the config child with the given name.
+    # Returns nil if there is none, or no config container.
+    #
+    def config_child( name )
+      return find_child( CONFIG )&.find_child( name )
+    end
+
     #
     # Get the Scheme (http or https) from the child object.
     # Returns nil if there is none.
     #
     def scheme_value
-      config = find_child CONFIG
-      scheme = config.find_child SCHEME
+      scheme = config_child SCHEME
       return nil unless scheme
 
       return scheme.value
@@ -140,8 +149,7 @@ module Objs
     # Returns nil if there is none.
     #
     def host_value
-      config = find_child CONFIG
-      host = config.find_child HOST
+      host = config_child HOST
       return nil unless host
 
       return host.value
@@ -152,8 +160,7 @@ module Objs
     # Returns nil if there is none.
     #
     def port_value
-      config = find_child CONFIG
-      port = config.find_child PORT
+      port = config_child PORT
       return nil unless port
 
       return port.value
@@ -171,8 +178,7 @@ module Objs
     # Get the session cookie name.
     # 
     def session_name
-      config = find_child CONFIG
-      session_name = config.find_child SESSION_NAME
+      session_name = config_child SESSION_NAME
       return nil unless session_name
 
       name = session_name.value
@@ -185,8 +191,7 @@ module Objs
     # Get the key for the encryption cipher.
     # 
     def encryption_key
-      config = find_child CONFIG
-      o = config.find_child ENCRYPT_KEY
+      o = config_child ENCRYPT_KEY
       return nil unless o
 
       o = Gloo::Objs::Alias.resolve_alias( @engine, o )
@@ -197,8 +202,7 @@ module Objs
     # Get the initialization vector for the cipher.
     # 
     def encryption_iv
-      config = find_child CONFIG
-      o = config.find_child ENCRYPT_IV
+      o = config_child ENCRYPT_IV
       return nil unless o
 
       o = Gloo::Objs::Alias.resolve_alias( @engine, o )
@@ -210,8 +214,7 @@ module Objs
     # If not specified, use the root path.
     # 
     def session_cookie_path
-      config = find_child CONFIG
-      o = config.find_child COOKIE_PATH
+      o = config_child COOKIE_PATH
       if o
         return o.value
       else
@@ -224,8 +227,7 @@ module Objs
     # If not specified, use one week from now.
     # 
     def session_cookie_expires
-      config = find_child CONFIG
-      o = config.find_child COOKIE_EXPIRES
+      o = config_child COOKIE_EXPIRES
       if o
         dt = Chronic.parse( o.value )
         return dt
@@ -239,7 +241,7 @@ module Objs
     # Get the value from the scheme settings/config.
     # 
     def session_cookie_secure
-      return scheme_value.downcase == HTTPS
+      return scheme_value&.downcase == HTTPS
     end
 
 
@@ -392,6 +394,7 @@ module Objs
       fac.create_alias LAYOUT, nil, self
       fac.create_alias HOME, nil, self
       fac.create_alias ERR_PAGE, nil, self
+      fac.create_alias NOT_FOUND_PAGE, nil, self
 
       fac.create_can PAGES, self
     end
@@ -415,6 +418,11 @@ module Objs
     # Start the gloo web server.
     #
     def msg_start
+      if @engine.app_running?
+        @engine.err SERVER_ALREADY_RUNNING
+        return
+      end
+
       @engine.log.debug "Starting web server…"
       # @engine.log.quiet = true
 
@@ -522,12 +530,14 @@ module Objs
     # Start running the web server.
     # 
     def start
-      config = WebSvr::Config.new( scheme_value, host_value, port_value )
+      # Settings that aren't given use the defaults.
+      config = WebSvr::Config.new( scheme_value || WebSvr::Config::HTTP,
+        host_value || WebSvr::Config::LOCALHOST,
+        port_value || WebSvr::Config::PORT_DEFAULT )
       @engine.log.info "Web Server URL: #{config.base_url}"
 
       handler = WebSvr::Handler.new( @engine, self )
       @web_server = WebSvr::Server.new( @engine, handler, config, ssl_config )
-      @web_server.start
 
       @router = Routing::Router.new( @engine, self )
       @router.add_page_routes
@@ -540,6 +550,10 @@ module Objs
       @session = WebSvr::Session.new( @engine, self )
       
       run_on_start
+
+      # Listen last: if the server can't start, it stops the running
+      # app from its own thread, so everything else must be done.
+      @web_server.start
       @engine.log.info "Web server started and listening…"
     end
 
@@ -658,7 +672,7 @@ module Objs
           data.find_child( PAGE )&.set_value( page_obj.pn ) 
         end
       rescue => e
-        @engine.log_exception e
+        @engine.handle_exception e
       end
     end
 
@@ -696,6 +710,17 @@ module Objs
       return o
     end
 
+    # 
+    # Get the application not found page.
+    # 
+    def not_found_page
+      o = find_child NOT_FOUND_PAGE
+      return nil unless o
+
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o
+    end
+
     #
     # Get the default layout for pages.
     #
@@ -720,12 +745,13 @@ module Objs
         :shortcut => KEYWORD_SHORT,
         :description => 'A web server running inside gloo.',
         :children => [
-          'config (container) — Configuration and settings for the server. See below for its children.',
+          'config (container) — Configuration and settings for the server. See below for its children. Settings left out use the defaults.',
           'on_start (script) — Run when the web server is started.',
           'on_stop (script) — Run when the web server is stopped.',
           "layout (partial) — By convention an alias pointing to the layout used for all pages (layouts live in the layout root-level folder).",
           'home (page) — By convention an alias pointing to the home page object (pages live in the page root-level folder).',
-          'error (page) — By convention an alias pointing to the default error page object.',
+          'error (page) — By convention an alias pointing to the default error page object. Sent with a 500 when a request fails; without one, a plain "Server error!" is sent.',
+          'not_found (page) — By convention an alias pointing to the page sent with a 404 when no route or file matches the request; without one, a plain "Not found" is sent.',
           'pages (container) — Routes. By convention, aliases pointing to pages in the page root-level folder.',
           'config.scheme (string) — \'http\' or \'https\'.',
           "config.host (string) — Default: 'localhost'.",
@@ -735,16 +761,16 @@ module Objs
           'config.encryption_iv (string) — Optional. Initialization vector for the session cookie encryption key.',
           "config.cookie_expires (string) — Optional, default 'in 1 week'. When the session expires.",
           "config.cookie_path (string) — Optional, default '/'. The path for the session cookie.",
-          'config.ssl_cert (string) — Optional, required for SSL. Path to certificate.pem.',
-          'config.ssl_key (string) — Optional, required for SSL. Path to key.pem.',
+          'ssl_cert (string or file) — Optional, required for SSL; a child of the server, not of config. Path to certificate.pem. May be an alias.',
+          'ssl_key (string or file) — Optional, required for SSL; a child of the server, not of config. Path to key.pem. May be an alias.',
           'on_request (script) — Optional. Run when the web server receives a request.',
           'request_data (container) — Optional. Data available for use in on_request or elsewhere in the page rendering life-cycle: method, host, path, query, ip (all string, all optional, populated only if present).',
           'on_response (script) — Optional. Run when the web server is done rendering and about to return a response.',
           'response_data (container) — Optional. Data available for use in on_response (request_data is also available at this point): page, type, code, elapsed, db (all string, all optional, populated only if present).'
         ],
         :messages => [
-          'start — Start the web server.',
-          'stop — Stop the web server.',
+          'start — Start the web server. It is an error if a web server is already running. If it can\'t listen on its port (in use, or needs root privileges), that is reported as an error and the server stops.',
+          'stop — Stop the web server. It is an error if it is not running.',
           'list_routes — Show the routing table. A debugging tool.',
           'list_assets — Show the list of assets. A debugging tool.',
           'list_asset_img — Show the list of image assets. A debugging tool.',
@@ -773,6 +799,7 @@ module Objs
               layout [alias] : layout.primary
               home [alias] : page.home
               error [alias] : page.err
+              not_found [alias] : page.not_found
 
               # Routes for the web server.
               pages [container] :

data/lib/web_svr/embedded_renderer.rb

@@ -98,7 +98,7 @@ module WebSvr
     # 
     # Handle a missing method by looking for a helper function.
     # If there is one, then call it and return the result.
-    # If not, log an error and return nil.
+    # If not, report an error and return nil (it renders as blank).
     # 
     def method_missing( method_name, *args )
       @log.debug "missing method '#{method_name}' with args #{args}"
@@ -108,11 +108,13 @@ module WebSvr
 
       pn = Gloo::Core::Pn.new( @engine, helper_pn )
       obj = pn.resolve
-      if obj
+      if obj.nil?
+        @engine.err "Helper function '#{method_name}' was not found; add it as #{helper_pn}."
+      elsif !obj.respond_to?( :invoke )
+        @engine.err "'#{helper_pn}' is not a function."
+      else
         @log.debug "found obj: #{obj.pn}"
         return obj.invoke args
-      else
-        @log.error "Function not found: #{helper_pn}"        
       end
 
       return nil

data/lib/web_svr/handler.rb

@@ -7,7 +7,10 @@
 
 module WebSvr
   class Handler
-    
+
+    SERVER_ERR_MSG = 'Server error!'.freeze
+    NOT_FOUND_MSG = 'Not found'.freeze
+
     attr_reader :server_obj
 
 
@@ -55,7 +58,7 @@ module WebSvr
           page_obj = page
         end
       else
-        result = server_error_result
+        result = not_found_result
       end
 
       return result, page_obj
@@ -87,7 +90,7 @@ module WebSvr
 
       # Check to make sure it is a valid file
       # return error if it is not
-      return file_error_result unless File.exist? pn
+      return not_found_result unless File.exist? pn
 
       return @server_obj.asset.render_file pn
     end
@@ -98,25 +101,37 @@ module WebSvr
     # ---------------------------------------------------------------------
 
     # 
-    # Return a server error result.
-    # Use the app's error if there is one, otherwise a generic message.
+    # Return a server error result: the app's error page, or a generic
+    # message, sent as a 500.
     # 
     def server_error_result
-      err_page = @server_obj.err_page
-      return err_page.render if err_page
+      return page_or_text_result( @server_obj.err_page,
+        SERVER_ERR_MSG, WebSvr::ResponseCode::SERVER_ERR )
+    end
 
-      # Last resort, just return a generic error message.
-      return WebSvr::Response.text_response( @engine, 
-        "Server error!", WebSvr::ResponseCode::SERVER_ERR )
-    end    
-  
     # 
-    # Get a file not found error result.
+    # Return a not found result: the app's not found page, or a generic
+    # message, sent as a 404.
     # 
-    def file_error_result
-      return WebSvr::Response.text_response( @engine, 
-        "File not found!", WebSvr::ResponseCode::NOT_FOUND )
-    end    
+    def not_found_result
+      return page_or_text_result( @server_obj.not_found_page,
+        NOT_FOUND_MSG, WebSvr::ResponseCode::NOT_FOUND )
+    end
+
+    # 
+    # Render the given page with the given status code, whatever the
+    # page's own return code. Without a page, or if it doesn't render,
+    # send the message as text.
+    # 
+    def page_or_text_result( page, msg, code )
+      result = page.render if page.is_a?( Objs::Page )
+      if result
+        result.code = code
+        return result
+      end
+
+      return WebSvr::Response.text_response( @engine, msg, code )
+    end
 
 
     # ---------------------------------------------------------------------

data/lib/web_svr/request_params.rb

@@ -53,6 +53,9 @@ module WebSvr
         begin
           @body_params = Rack::Utils.parse_query body
         rescue => exception
+          # A binary body (a file upload) isn't a query string and
+          # fails to parse; read it as multipart instead. Any problem
+          # with that is reported there.
           init_multipart body 
         end
       else
@@ -101,8 +104,7 @@ module WebSvr
         @body_params[ 'file_size' ] = binary_data.length
         @body_params[ 'file_data' ] = binary_data
       rescue => ex
-        @engine.log_exception ex
-        # @log.error "Error parsing multipart request", ex
+        @engine.err "Could not read the uploaded file: #{ex.message}"
       end
     end
 

data/lib/web_svr/response.rb

@@ -16,7 +16,8 @@ module WebSvr
     JSON_TYPE = 'application/json'.freeze
     HTML_TYPE = 'text/html'.freeze
           
-    attr_reader :code, :type, :data
+    attr_reader :type, :data
+    attr_accessor :code
     attr_accessor :location
     attr_accessor :file_name
     

data/lib/web_svr/server.rb

@@ -25,7 +25,11 @@ require 'rack'
 
 module WebSvr
   class Server
-  
+
+    # EventMachine (under Thin) raises a RuntimeError starting with this
+    # when it can't listen: the port is in use or needs root.
+    NO_ACCEPTOR = 'no acceptor'.freeze
+
     # ---------------------------------------------------------------------
     #    Initialization
     # ---------------------------------------------------------------------
@@ -52,20 +56,34 @@ module WebSvr
     # Start the web server.
     # 
     def start
+      @server_thread = Thread.new { run_server }
+      @log.debug 'Web server has started.'
+    end
+
+    # 
+    # Run the web server. This doesn't return while the server is
+    # running, so it runs in its own thread. If the server fails, it is
+    # reported here and the running app is stopped.
+    # 
+    def run_server
       opts = {
         :Port => @config.port,
         :Host => @config.host
       }
-      Thread.abort_on_exception = true
-      @server_thread = Thread.new { 
-        Rack::Handler::Thin.run( self, **options=opts ) do |server|
-          if @ssl_config
-            server.ssl = true
-            server.ssl_options = @ssl_config
-          end
+      Rack::Handler::Thin.run( self, **opts ) do |server|
+        if @ssl_config
+          server.ssl = true
+          server.ssl_options = @ssl_config
         end
-      }
-      @log.debug 'Web server has started.'
+      end
+    rescue => e
+      if e.message.start_with?( NO_ACCEPTOR )
+        @engine.err "Could not start the web server on #{@config.host}:#{@config.port}: " \
+          'the port is in use or needs root privileges.'
+      else
+        @engine.handle_exception e
+      end
+      @engine.stop_running_app
     end
 
     # 
@@ -74,7 +92,8 @@ module WebSvr
     def stop
       @log.debug 'Stopping the web server…'
 
-      @server_thread.kill
+      # When the server thread itself failed, it is ending already.
+      @server_thread.kill unless Thread.current == @server_thread
 
       @log.debug 'The web server has been stopped.'
     end
@@ -92,9 +111,31 @@ module WebSvr
       request.log
 
       response = request.process
-      response.log if response
 
-      return response ? response.result : nil
+      # A page that failed to render gives no response.
+      response ||= @handler.server_error_result
+      response.log
+
+      return response.result
+    rescue => e
+      # A bug in gloo-web's own code. Errors in gloo statements are
+      # handled where they happen, so this is the unexpected case:
+      # report it and send the error page.
+      @engine.handle_exception e
+      return error_result
+    end
+
+    # 
+    # The result for a request that failed: the app's error page, or a
+    # plain 500 if that fails too.
+    # 
+    def error_result
+      return @handler.server_error_result.result
+    rescue => e
+      @engine.handle_exception e
+      return [ WebSvr::ResponseCode::SERVER_ERR,
+        { WebSvr::Response::CONTENT_TYPE => WebSvr::Response::TEXT_TYPE },
+        WebSvr::Handler::SERVER_ERR_MSG ]
     end
 
   

data/lib/web_svr/session.rb

@@ -9,12 +9,14 @@
 #   https://en.wikipedia.org/wiki/HTTP_cookie
 #   
 require 'base64'
+require 'openssl'
 
 module WebSvr
   class Session
 
     SESSION_CONTAINER = 'session'.freeze
     SESSION_ID_NAME = 'session_id'.freeze
+    SESSION_UNREADABLE = 'Session cookie could not be read; starting a new session.'.freeze
 
     
     # ---------------------------------------------------------------------
@@ -64,7 +66,8 @@ module WebSvr
           end
         end
       rescue => e
-        @engine.log_exception e
+        # Not expected: a bad cookie is handled in decode_decrypt.
+        @engine.handle_exception e
       end
     end
 
@@ -166,8 +169,10 @@ module WebSvr
       begin
         data = Gloo::Objs::Cipher.decrypt( data, key, iv )
         return JSON.parse( data )
-      rescue => e
-        @engine.log_exception e
+      rescue OpenSSL::Cipher::CipherError, JSON::ParserError
+        # The cookie was made with another key, or has been changed.
+        # Not the app's error: the visitor gets a new session.
+        @engine.warn SESSION_UNREADABLE
         return nil
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gloo-web
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Eric Crane
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gloo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement