gloo-web 1.0

data/lib/web_svr/embedded_renderer.rb

@@ -0,0 +1,152 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A helper class used to render parameters (ERB) in text.
+# Also uses helper functions to render.
+# 
+
+module WebSvr
+  class EmbeddedRenderer
+    
+    HELPER = 'helper'.freeze
+
+    attr_reader :engine, :log, :web_svr_obj
+
+
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+
+    #
+    # Set up the web server.
+    #
+    def initialize( engine, web_svr_obj )
+      @engine = engine
+      @log = @engine.log
+
+      @web_svr_obj = web_svr_obj
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Tag Helpers
+    # ---------------------------------------------------------------------
+
+    # 
+    # Render a favicon tag.
+    # By default the name is 'favicon.ico' and does not need to be provided
+    # if that is the correct file name.
+    # 
+    def favicon_tag( name = 'favicon.ico' )
+      icon_path = "/#{Asset::ASSET_FOLDER}/#{Asset::IMAGE_FOLDER}/#{name}"
+      published_name = @engine.running_app.obj.asset.published_name( icon_path )
+      return "<link rel='shortcut icon' type='image/x-icon' href='#{published_name}' />"
+    end
+
+    # 
+    # Render a Apple Touch Icon tag.
+    # By default the name is 'apple-touch-icon.png' and does not need to be provided
+    # if that is the correct file name.
+    # 
+    def apple_touch_icon_tag( name = 'apple-touch-icon.png', type = 'image/png' )
+      icon_path = "/#{Asset::ASSET_FOLDER}/#{Asset::IMAGE_FOLDER}/#{name}"
+      published_name = @engine.running_app.obj.asset.published_name( icon_path )
+      return "<link rel='apple-touch-icon' type='#{type}' href='#{published_name}' />"
+    end
+
+    # 
+    # Render an image tag for the given image name.
+    # Include optional proterties as part of the tag.
+    #
+    def image_tag( img_name, properties = '' )
+      image_path = "/#{Asset::ASSET_FOLDER}/#{Asset::IMAGE_FOLDER}/#{img_name}"
+      published_name = @engine.running_app.obj.asset.published_name( image_path )
+      return "<image src='#{published_name}' #{properties} />"
+    end
+
+    # 
+    # Render a script tag for the given script name.
+    #
+    def js_tag( name )
+      js_path = "/#{Asset::ASSET_FOLDER}/#{Asset::JAVASCRIPT_FOLDER}/#{name}"
+      published_name = @engine.running_app.obj.asset.published_name( js_path )
+      return "<script src='#{published_name}'></script>"
+    end
+
+    #
+    # Render a stylesheet tag for the given stylesheet name.
+    #
+    def css_tag( name )
+      css_path = "/#{Asset::ASSET_FOLDER}/#{Asset::STYLESHEET_FOLDER}/#{name}"
+      published_name = @engine.running_app.obj.asset.published_name( css_path )
+      return "<link rel='stylesheet' media='all' href='#{published_name}' />"
+    end
+
+    # 
+    # Embed a hidden field with the autenticity token.
+    # 
+    def autenticity_token_tag
+      session_id = @engine.running_app.obj&.session&.get_session_id
+      return Gloo::Objs::CsrfToken.get_csrf_token_hidden_field( session_id )
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Obj Helper Functions
+    # ---------------------------------------------------------------------
+
+    # 
+    # 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.
+    # 
+    def method_missing( method_name, *args )
+      @log.debug "missing method '#{method_name}' with args #{args}"
+
+      helper_pn = "#{HELPER}.#{method_name}"
+      @log.debug "looking for function: #{helper_pn}"
+
+      pn = Gloo::Core::Pn.new( @engine, helper_pn )
+      obj = pn.resolve
+      if obj
+        @log.debug "found obj: #{obj.pn}"
+        return obj.invoke args
+      else
+        @log.error "Function not found: #{helper_pn}"        
+      end
+
+      return nil
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Renderer
+    # ---------------------------------------------------------------------
+
+    # 
+    # Render content with the given params.
+    # Params might be nil, in which case the content
+    # is returned with no changes.
+    # 
+    def render content, params
+      # If the params is nil, let's make it an empty hash.
+      params = {} unless params
+
+      # Get the binding context for this render.
+      b = binding
+
+      # Add the params to the binding context.
+      params.each_pair do |key, value|
+        b.local_variable_set key.to_sym, value
+      end
+    
+      # Render in the current binding content.
+      renderer = ERB.new( content )
+      content = renderer.result( b )
+    
+      return content
+    end
+
+  end
+  
+end

data/lib/web_svr/handler.rb

@@ -0,0 +1,152 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Web application request handler.
+# Takes a request and does what is needed to create a response.
+# 
+
+module WebSvr
+  class Handler
+    
+    attr_reader :server_obj
+
+
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+
+    #
+    # Set up the web server.
+    #
+    def initialize( engine, obj )
+      @engine = engine
+      @log = @engine.log
+      @server_obj = obj
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Process Request
+    # ---------------------------------------------------------------------
+
+    #
+    # Process the request and return a result.
+    # 
+    def handle request
+      @request = request
+      page_obj = nil
+      route_params = nil
+
+      page, id, route_params = @server_obj.router.page_for_route( @request.path, @request.method )
+      @engine.log.debug "Found Page: #{page&.name}" if page
+
+      request.request_params.id = id
+      request.request_params.route_params = route_params
+      request.request_params.log_id_keys
+
+      if page
+        # Run the on_request script with the found page.
+        @server_obj.run_on_request( page )
+
+        if page.is_a? Gloo::Objs::FileHandle
+          result = handle_file page
+        else
+          result = handle_page page
+          page_obj = page
+        end
+      else
+        result = server_error_result
+      end
+
+      return result, page_obj
+    end
+
+    # 
+    # Handle request for a page.
+    # Render the page, with possible redirect.
+    # 
+    def handle_page page
+      result = page.render @request
+      if redirect_hard_set?
+        result = server_redirect_result
+        @engine.running_app.obj.redirect_hard = nil
+      elsif redirect_set?
+        page = @engine.running_app.obj.redirect
+        @log.debug "Redirecting to: #{page.pn}"
+        @engine.running_app.obj.redirect = nil
+        result = page.render
+      end
+      return result
+    end
+
+    # 
+    # Handle a request for a static file such as an image.
+    # 
+    def handle_file file
+      pn = @server_obj.asset.path_for_file file
+
+      # Check to make sure it is a valid file
+      # return error if it is not
+      return file_error_result unless File.exist? pn
+
+      return @server_obj.asset.render_file pn
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Errors
+    # ---------------------------------------------------------------------
+
+    # 
+    # Return a server error result.
+    # Use the app's error if there is one, otherwise a generic message.
+    # 
+    def server_error_result
+      err_page = @server_obj.err_page
+      return err_page.render if err_page
+
+      # 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.
+    # 
+    def file_error_result
+      return WebSvr::Response.text_response( @engine, 
+        "File not found!", WebSvr::ResponseCode::NOT_FOUND )
+    end    
+
+
+    # ---------------------------------------------------------------------
+    #    Redirect Helper functions
+    # ---------------------------------------------------------------------
+
+    # 
+    # Is there a redirect page set in the running app?
+    # 
+    def redirect_set?
+      return false unless @engine.app_running?
+      return @engine.running_app.obj.redirect
+    end
+
+    # 
+    # Is there a redirect page set in the running app?
+    # 
+    def redirect_hard_set?
+      return false unless @engine.app_running?
+      return @engine.running_app.obj.redirect_hard
+    end
+
+    # 
+    # Return a redirect result.
+    # 
+    def server_redirect_result
+      target = @engine.running_app.obj.redirect_hard
+
+      return WebSvr::Response.redirect_response( @engine, target )
+    end    
+
+  end
+end

data/lib/web_svr/request.rb

@@ -0,0 +1,141 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A web Request for a page, action, or static resource.
+#
+# Kinds of Resources
+#   Web Page
+#   Action - does something and redirects to a page (or returns nothing)
+#   API - returns JSON instead of HTML (but is that different from Web Page?)
+#   Static Resource - File, PDF, Image, etc.
+# 
+# 
+# See More doc here:
+#    https://www.rubydoc.info/gems/rack/Rack/Request/Helpers#path-instance_method
+# 
+
+module WebSvr
+  class Request
+
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+    REQUEST_PATH = 'REQUEST_PATH'.freeze
+    HTTP_HOST = 'HTTP_HOST'.freeze
+    QUERY_STRING = 'QUERY_STRING'.freeze
+
+    attr_reader :method, :host, :path, :ip, :query
+    attr_reader :db, :elapsed
+    attr_accessor :request_params
+
+    
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+
+    #
+    # Set up the web server.
+    #
+    def initialize( engine, handler, env = nil )
+      @engine = engine
+      @log = @engine.log
+      @request_params = RequestParams.new( @log )
+
+      @handler = handler
+
+      @env = env
+      detect_env
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Process Request
+    # ---------------------------------------------------------------------
+
+    #
+    # Process the request and return a result.
+    # 
+    def process
+      start_timer
+
+      # Run the on_request script if there is one.
+      @handler.server_obj.set_request_data self
+      
+      # Check authenticity token if it's given.
+      if @request_params.check_authenticity_token( @engine )
+        result, page_obj = @handler.handle self
+      else
+        # Render the error page.
+        result = @handler.server_error_result
+      end
+
+      finish_timer
+
+      # Run the on_response script if there is one.
+      @handler.server_obj.set_response_data( self, result, page_obj )
+      @handler.server_obj.run_on_response
+
+      return result
+    end
+
+    
+    # ---------------------------------------------------------------------
+    #    ENV
+    # ---------------------------------------------------------------------
+
+    # 
+    # Write the request information to the log.
+    # 
+    def detect_env
+      req = Rack::Request.new( @env )
+
+      @method = req.request_method
+      @path = req.path
+      @host = req.host_with_port
+      @query = req.query_string
+
+      @request_params.init_query_params( @query )
+      @ip = req.ip
+      @handler.server_obj.session.set_session_data_for_request( @env )
+
+      @request_params.init_body_params( @env[ 'rack.input' ].read )
+      @method = @request_params.get_body_method_override @method
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Request timer
+    # ---------------------------------------------------------------------
+
+    # 
+    # Keep track of the request start time.
+    # 
+    def start_timer
+      @start = Time.now
+      @engine.running_app.reset_db_time
+    end
+  
+    # 
+    # Write the request completion time to the log.
+    # 
+    def finish_timer
+      @finish = Time.now
+      @elapsed = ( ( @finish - @start ) * 1000.0 ).round(2)
+      @db = @engine.running_app.db_time
+      @log.info "*** Web request complete.  DB: #{@db} ms.  Elapsed time: #{@elapsed} ms"
+    end
+  
+
+    # ---------------------------------------------------------------------
+    #    Helper functions
+    # ---------------------------------------------------------------------
+
+    # 
+    # Write the request information to the log.
+    # 
+    def log
+      @log.info "#{@method} #{@host}#{@path}"
+
+      @request_params.log_params
+    end
+
+  end
+end

data/lib/web_svr/request_params.rb

@@ -0,0 +1,179 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A Parameters associated with a request.
+#
+# Kinds of Params
+#   Id - The entity id
+#   Key - URL parameter key
+#   URL Params - Parameters in the URL
+#   Body Params - Data from the body of the request
+# 
+
+module WebSvr
+  class RequestParams
+
+    attr_accessor :id, :route_params
+    attr_reader :query_params, :body_params, :body_binary
+    
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+
+    #
+    # Set up the web server.
+    #
+    def initialize( log )
+      @log = log
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Value Detection
+    # ---------------------------------------------------------------------
+
+    # 
+    # Detect the parameters from query string.
+    # 
+    def init_query_params query_string
+      if query_string
+        @query_params = Rack::Utils.parse_query( query_string )
+      else
+        @query_params = {} 
+      end
+    end
+
+    # 
+    # Detect the parameters from the body of the request.
+    # 
+    def init_body_params body
+      if body && body.length > 0
+        # if body is binary, then it is not a query string
+        begin
+          @body_params = Rack::Utils.parse_query body
+        rescue => exception
+          init_multipart body 
+        end
+      else
+        @body_params = {} 
+      end
+    end
+
+    # 
+    # Set the body to a binary file.
+    # 
+    # TODO: find a lib or method to handle this.
+    # This is very rough and will need to be fixed.
+    # 
+    def init_multipart body
+      # puts "*********** first lines: *********** "
+      # body.lines[0..3].each { |line| puts line }
+      # puts "*********** last lines: *********** "
+      # body.lines.last(5).each { |line| puts line }
+      # puts "************************************"
+
+      # boundary = body.lines.first
+      # puts "boundary: #{boundary}"
+
+      header = body.lines[1..3].join
+      # puts "header: #{header}"
+
+      footer = body.lines.last(5).join
+      # puts "footer: #{footer}"
+
+      binary_data = body.lines[4..-6].join
+      # puts "binary_data length: #{binary_data.length}"
+      # puts "binary first line: #{binary_data.lines.first}"
+      # puts "binary last line: #{binary_data.lines.last}"
+
+      i = header.lines.first.index( 'filename=' )
+      filename = header.lines.first[ i+10..-4 ]
+      content_type = header.lines.second[14..-3]
+      # puts "filename: #{filename}"
+      # puts "content_type: #{content_type}"
+
+      @body_binary = body
+      @body_params = {}
+      @body_params[ 'content_type' ] = content_type
+      @body_params[ 'file_name' ] = filename
+      @body_params[ 'file_size' ] = binary_data.length
+      @body_params[ 'file_data' ] = binary_data
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Authenticity Token checking
+    # ---------------------------------------------------------------------
+
+    # 
+    # Check the authenticity token if it is present.
+    # Returns true if it is present and valid, and
+    # also if it is not present.
+    # Returns false if it is present but not valid.
+    # 
+    def check_authenticity_token engine
+      auth_token = @query_params[ Gloo::Objs::CsrfToken::AUTHENTICITY_TOKEN ]
+      if auth_token
+        session_id = engine.running_app.obj&.session&.get_session_id
+        return false unless session_id
+
+        return Gloo::Objs::CsrfToken.valid_csrf_token?( session_id, auth_token )
+      end
+
+      return true
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Helper functions
+    # ---------------------------------------------------------------------
+
+    # 
+    # Check the body to see if there is a PATCH or a PUT in 
+    # the method override.
+    # 
+    def get_body_method_override orig_method
+      if @body_params[ '_method' ]
+        return @body_params[ '_method' ].upcase
+      end
+      return orig_method
+    end
+
+    # 
+    # Write the querey and body params to the log.
+    # 
+    def log_params
+      return unless @log
+
+      if @query_params && ! @query_params.empty?
+        @log.info "--- Query Parameters: #{@query_params}" 
+      end
+
+      if @body_params && ! @body_params.empty?
+        if @body_params[ 'file_data' ]
+          # exclude the file data from the params shown
+          params = @body_params.dup
+          params.delete( 'file_data' )
+          params[ 'file_data' ] = '...'
+          @log.info "--- Body Parameters: #{params}"
+        else
+          @log.info "--- Body Parameters: #{@body_params}"
+        end
+      end
+    end
+
+    # 
+    # Write the id and route params to the log.
+    # 
+    def log_id_keys
+      return unless @log
+
+      @log.info "--- ID Parameter: #{@id}" if @id
+
+      if @route_params && ! @route_params.empty?
+        @log.info "--- Route Parameters: #{@route_params}"
+      end
+    end
+
+  end
+end