gloo 3.2.0 → 3.4.0

data/lib/gloo/objs/web_svr/svr.rb

@@ -11,18 +11,45 @@ module Gloo
       KEYWORD = 'server'.freeze
       KEYWORD_SHORT = 'svr'.freeze
 
-      # Configuration
-      SCHEME = 'scheme'.freeze      
+      # ---------------------------------------------------------------------
+      #    CONFIGURATION KEYS
+      # ---------------------------------------------------------------------
+      CONFIG = 'config'.freeze
+      SCHEME = 'scheme'.freeze
+      HTTP = 'http'.freeze
+      HTTPS = 'https'.freeze
       HOST = 'host'.freeze
       PORT = 'port'.freeze
+      SESSION_NAME = 'session_name'.freeze
+      ENCRYPT_KEY = 'encryption_key'.freeze
+      ENCRYPT_IV = 'encryption_iv'.freeze
+      COOKIE_EXPIRES = 'cookie_expires'.freeze
+      COOKIE_PATH = 'cookie_path'.freeze
+      DEFAULT_COOKIE_PATH = '/'.freeze
 
       # SSL Configuration
       SSL_CERT = 'ssl_cert'.freeze
       SSL_KEY = 'ssl_key'.freeze
 
+      # ---------------------------------------------------------------------
+      #    OTHER KEYS
+      # ---------------------------------------------------------------------
+
       # Events
       ON_START = 'on_start'.freeze
       ON_STOP = 'on_stop'.freeze
+      ON_REQUEST = 'on_request'.freeze
+      ON_RESPONSE = 'on_response'.freeze
+      RESQUEST_DATA = 'request_data'.freeze
+      METHOD = 'method'.freeze
+      PATH = 'path'.freeze
+      QUERY = 'query'.freeze
+      IP = 'ip'.freeze
+      RESPONSE_DATA = 'response_data'.freeze
+      TYPE = 'type'.freeze
+      CODE = 'code'.freeze
+      ELAPSED = 'elapsed'.freeze
+      DB = 'db'.freeze
 
       # Container with pages in the web app.
       PAGES = 'pages'.freeze
@@ -34,6 +61,9 @@ module Gloo
       HOME = 'home'.freeze
       ERR_PAGE = 'error'.freeze
 
+      # Session
+      SESSION = 'session'.freeze
+
 
       # Messages
       SERVER_NOT_RUNNING = 'The web server is not running!'.freeze
@@ -44,6 +74,7 @@ module Gloo
       # of the one requested.
       # 
       attr_accessor :redirect, :router, :asset, :embedded_renderer
+      attr_accessor :session
 
       #
       # The name of the object type.
@@ -74,12 +105,29 @@ module Gloo
         return false
       end
 
+      # 
+      # Get the default layout for the app.
+      # 
+      def default_page_layout
+        o = find_child LAYOUT
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Configuration
+      # ---------------------------------------------------------------------
+
       #
       # Get the Scheme (http or https) from the child object.
       # Returns nil if there is none.
       #
       def scheme_value
-        scheme = find_child SCHEME
+        config = find_child CONFIG
+        scheme = config.find_child SCHEME
         return nil unless scheme
 
         return scheme.value
@@ -90,7 +138,8 @@ module Gloo
       # Returns nil if there is none.
       #
       def host_value
-        host = find_child HOST
+        config = find_child CONFIG
+        host = config.find_child HOST
         return nil unless host
 
         return host.value
@@ -101,24 +150,163 @@ module Gloo
       # Returns nil if there is none.
       #
       def port_value
-        port = find_child PORT
+        config = find_child CONFIG
+        port = config.find_child PORT
         return nil unless port
 
         return port.value
       end
 
+      # 
+      # Is this server configured to use a session?
+      # It is if theere is a non-empty session name.
+      # 
+      def use_session?
+        return ! session_name.blank?
+      end
 
       # 
-      # Get the default layout for the app.
+      # Get the session cookie name.
       # 
-      def default_page_layout
-        o = find_child LAYOUT
+      def session_name
+        config = find_child CONFIG
+        session_name = config.find_child SESSION_NAME
+        return nil unless session_name
+
+        name = session_name.value
+        return nil if name.blank?
+
+        return name
+      end
+
+      # 
+      # Get the key for the encryption cipher.
+      # 
+      def encryption_key
+        config = find_child CONFIG
+        o = config.find_child ENCRYPT_KEY
         return nil unless o
 
         o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      # 
+      # Get the initialization vector for the cipher.
+      # 
+      def encryption_iv
+        config = find_child CONFIG
+        o = config.find_child ENCRYPT_IV
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      # 
+      # Get the path for the session cookie.
+      # If not specified, use the root path.
+      # 
+      def session_cookie_path
+        config = find_child CONFIG
+        o = config.find_child COOKIE_PATH
+        if o
+          return o.value
+        else
+          return DEFAULT_COOKIE_PATH
+        end
+      end
+
+      # 
+      # Get the expiration time for the session cookie.
+      # If not specified, use one week from now.
+      # 
+      def session_cookie_expires
+        config = find_child CONFIG
+        o = config.find_child COOKIE_EXPIRES
+        if o
+          dt = Chronic.parse( o.value )
+          return dt
+        else
+          return 1.week.from_now
+        end
+      end
+
+      # 
+      # Should the session cookie be secure?
+      # Get the value from the scheme settings/config.
+      # 
+      def session_cookie_secure
+        return scheme_value.downcase == HTTPS
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Session
+      # ---------------------------------------------------------------------
+
+      # 
+      # Get the session container object.
+      # If there is none, one will be created.
+      # 
+      def session_container
+        o = find_child SESSION
+
+        unless o
+          o = add_session_container
+        end
+
         return o
       end
 
+      # 
+      # Add the session container because it is missing.
+      # 
+      def add_session_container
+        fac = @engine.factory
+        return fac.create_can SESSION, self
+      end
+
+      # 
+      # Get the data from the session container.
+      # Data will be in the form of a hash ( key => value ).
+      # 
+      def get_session_data
+        data = {}
+
+        session_container.children.each do |session_var|
+          key = session_var.name
+          value = session_var.value
+          data[ key ] = value
+        end
+
+        return data
+      end
+
+      # 
+      # Get the session child object with the given value.
+      # Create the child if it does not exist.
+      # 
+      def set_session_var( key, value )
+        child_obj = session_container.find_child( key )
+        unless child_obj
+          fac = @engine.factory
+          child_obj = fac.create_string key, value, session_obj
+        end
+        child_obj.value = value
+      end
+
+      # 
+      # Clear out all session data.
+      # Important to do this after the response is sent
+      # to avoid holding on to data that is no longer needed.
+      # 
+      def clear_session_data
+        session_container.children.each do |session_var|
+          session_var.value = ''
+        end
+      end
+
 
       # ---------------------------------------------------------------------
       #    SSL
@@ -190,15 +378,20 @@ module Gloo
       def add_default_children
         fac = @engine.factory
 
-        fac.create_string SCHEME, 'http', self
-        fac.create_string HOST, 'localhost', self
-        fac.create_string PORT, '8080', self
+        # Configuration
+        config = fac.create_can CONFIG, self
+        fac.create_string SCHEME, HTTP, config
+        fac.create_string HOST, 'localhost', config
+        fac.create_string PORT, '8080', config
 
         fac.create_script ON_START, '', self
         fac.create_script ON_STOP, '', self
 
+        fac.create_alias LAYOUT, nil, self
+        fac.create_alias HOME, nil, self
+        fac.create_alias ERR_PAGE, nil, self
+
         fac.create_can PAGES, self
-        fac.create_can HOME, self
       end
 
 
@@ -274,6 +467,8 @@ module Gloo
 
         @embedded_renderer = Gloo::WebSvr::EmbeddedRenderer.new( @engine, self )
 
+        @session = Gloo::WebSvr::Session.new( @engine, self )
+        
         run_on_start
         @engine.log.info "Web server started and listening…"
       end
@@ -283,6 +478,10 @@ module Gloo
       # 
       def stop
         @engine.log.info "Stopping web server…"
+
+        # Last chance to clear out session data.
+        clear_session_data
+
         @web_server.stop
         @web_server = nil
         @router = nil
@@ -297,7 +496,7 @@ module Gloo
       # ---------------------------------------------------------------------
 
       #
-      # Run the on render script if there is one.
+      # Run the on start script if there is one.
       #
       def run_on_start
         o = find_child ON_START
@@ -307,7 +506,7 @@ module Gloo
       end
 
       #
-      # Run the on rendered script if there is one.
+      # Run the on stop script if there is one.
       #
       def run_on_stop
         o = find_child ON_STOP
@@ -316,6 +515,60 @@ module Gloo
         Gloo::Exec::Dispatch.message( @engine, 'run', o )
       end
 
+      #
+      # Run the on request script if there is one.
+      #
+      def run_on_request
+        o = find_child ON_REQUEST
+        return unless o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+      #
+      # Run the on response script if there is one.
+      #
+      def run_on_response
+        o = find_child ON_RESPONSE
+        return unless o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+      # 
+      # Set up the request data for the page load.
+      # This is done before the on_request event is fired.
+      # 
+      def set_request_data( request )
+        data = find_child RESQUEST_DATA
+        return unless data
+        data = Gloo::Objs::Alias.resolve_alias( @engine, data )
+
+        data.find_child( METHOD )&.set_value( request.method )
+        data.find_child( HOST )&.set_value( request.host )
+        data.find_child( PATH )&.set_value( request.path )
+        data.find_child( QUERY )&.set_value( request.query )
+        data.find_child( IP )&.set_value( request.ip )
+      end
+
+      # 
+      # Set up the response data for the page load.
+      # This is done after the page is rendered and before
+      # the on_response event is fired.
+      # 
+      def set_response_data( request, response )
+        data = find_child RESPONSE_DATA
+        return unless data
+        data = Gloo::Objs::Alias.resolve_alias( @engine, data )
+
+        data.find_child( ELAPSED )&.set_value( request.elapsed )
+        data.find_child( DB )&.set_value( request.db )
+        data.find_child( TYPE )&.set_value( response.type )
+        data.find_child( CODE )&.set_value( response.code )
+      end
+
 
       # ---------------------------------------------------------------------
       #    Pages and standard elements.

data/lib/gloo/verbs/invoke.rb

@@ -0,0 +1,80 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Invoke a function from a script.
+#
+
+module Gloo
+  module Verbs
+    class Invoke < Gloo::Core::Verb
+
+      KEYWORD = 'invoke'.freeze
+      KEYWORD_SHORT = '~>'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        if @tokens.token_count > 1
+          ob = @tokens.first
+
+          # Get the function object
+          pn = Gloo::Core::Pn.new( @engine, @tokens.second ) 
+          func = pn.resolve
+
+          # Is the object a function?
+          if func&.is_function?
+            params = get_params_arr
+          
+            @engine.log.debug "invoking function: #{func.pn}"
+            result = func.invoke( params ) 
+            @engine.log.debug "function returned: #{result}"
+            @engine.heap.it.set_to result
+            return result
+          end
+        end
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get params array.
+      #
+      def get_params_arr
+        @engine.log.debug "token params: #{@tokens.params}"
+        params = @tokens.params[1..-1]
+
+        @engine.log.info "params: #{params}"
+        evaluated_params = []
+
+        params.each do |p|
+          expr = Gloo::Expr::Expression.new( @engine, [ p ] )
+          evaluated_params << expr.evaluate
+        end
+
+        @engine.log.debug "evaluated_params: #{evaluated_params}"
+
+        return evaluated_params
+      end
+
+    end
+  end
+end

data/lib/gloo/verbs/version.rb

@@ -55,7 +55,7 @@ module Gloo
       def show_vers_notes
         @engine.log.show "Gloo version notes..."
         notes = Gloo::App::Info.get_version_notes
-        @engine.platform.show( notes, false, true )
+        @engine.platform.show notes
       end
 
       # 

data/lib/gloo/web_svr/asset.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # A helper class for static assets.
 # 
@@ -8,9 +8,9 @@ module Gloo
   module WebSvr
     class Asset
       
-      ASSETS_FOLDER = 'assets'.freeze
-      IMAGES_FOLDER = 'images'.freeze
-      STYLESHEETS_FOLDER = 'stylesheets'.freeze
+      ASSET_FOLDER = 'asset'.freeze
+      IMAGE_FOLDER = 'image'.freeze
+      STYLESHEET_FOLDER = 'stylesheet'.freeze
       JAVASCRIPT_FOLDER = 'javascript'.freeze
 
       CSS_TYPE = 'text/css'.freeze
@@ -42,29 +42,29 @@ module Gloo
       # 
       # Get the asset folder in the project.
       #
-      def assets_folder
-        return File.join( @engine.settings.project_path, ASSETS_FOLDER )
+      def asset_folder
+        return File.join( @engine.settings.project_path, ASSET_FOLDER )
       end
 
       #
       # Get the images folder in the project.
       #
-      def images_folder
-        return File.join( assets_folder, IMAGES_FOLDER )
+      def image_folder
+        return File.join( asset_folder, IMAGE_FOLDER )
       end
 
       # 
       # Get the stylesheets folder in the project.
       #
-      def stylesheets_folder
-        return File.join( assets_folder, STYLESHEETS_FOLDER )
+      def stylesheet_folder
+        return File.join( asset_folder, STYLESHEET_FOLDER )
       end
 
       # 
       # Get the stylesheets folder in the project.
       #
       def javascript_folder
-        return File.join( assets_folder, JAVASCRIPT_FOLDER )
+        return File.join( asset_folder, JAVASCRIPT_FOLDER )
       end
 
       # 
@@ -77,7 +77,7 @@ module Gloo
         return pn if File.exist? pn
 
         # Look in the web server's asset folder.
-        pn = File.join( assets_folder, pn )
+        pn = File.join( asset_folder, pn )
 
         return pn
       end
@@ -125,7 +125,7 @@ module Gloo
       # Add all asssets to the web server pages (routes).
       # 
       def add_asset_routes
-        return unless File.exist? assets_folder
+        return unless File.exist? asset_folder
 
         @log.debug 'Adding asset routes to web server…'
         @factory = @engine.factory
@@ -142,33 +142,50 @@ module Gloo
       def add_containers
         pages = @web_svr_obj.pages_container
 
-        @assets = pages.find_child( ASSETS_FOLDER ) || 
-          @factory.create_can( ASSETS_FOLDER, pages )
+        @assets = pages.find_child( ASSET_FOLDER ) || 
+          @factory.create_can( ASSET_FOLDER, pages )
 
-        @images = @assets.find_child( IMAGES_FOLDER ) || 
-          @factory.create_can( IMAGES_FOLDER, @assets )
+        @images = @assets.find_child( IMAGE_FOLDER ) || 
+          @factory.create_can( IMAGE_FOLDER, @assets )
 
-        @stylesheets = @assets.find_child( STYLESHEETS_FOLDER ) || 
-          @factory.create_can( STYLESHEETS_FOLDER, @assets )
+        @stylesheets = @assets.find_child( STYLESHEET_FOLDER ) || 
+          @factory.create_can( STYLESHEET_FOLDER, @assets )
 
         @javascript = @assets.find_child( JAVASCRIPT_FOLDER ) || 
           @factory.create_can( JAVASCRIPT_FOLDER, @assets )
       end
 
+      # 
+      # Traverse the given folder and add all files to the container.
+      # This is a recursive method and look look for files in subfolders.
+      # 
+      def add_files_in_folder( folder, container, path )
+        Dir.each_child( folder ) do |name|
+          pn = File.join( path, name )
+          full_path = File.join( folder, name )
+
+          if File.directory? full_path
+            child = container.find_child( name )
+            child = @factory.create_can( name, container ) if child.nil?
+
+            add_files_in_folder( full_path, child, pn )
+          else
+            add_file_obj( container, name, pn )
+          end
+        end
+      end
+
       #
       # Add the images to the web server pages.
       #
       def add_images
         @log.debug 'Adding image asset routes to web server…'
         
-        return unless File.exist? images_folder
+        return unless File.exist? image_folder
 
         # for each file in the images folder
         # create a file object and add it to the images container
-        Dir.each_child( images_folder ) do |name|
-          pn = File.join( IMAGES_FOLDER, name )
-          add_file_obj( @images, name, pn )
-        end
+        add_files_in_folder( image_folder, @images, IMAGE_FOLDER )
       end
 
       #
@@ -177,14 +194,16 @@ module Gloo
       def add_stylesheets
         @log.debug 'Adding stylesheet asset routes to web server…'
 
-        return unless File.exist? stylesheets_folder
+        return unless File.exist? stylesheet_folder
 
         # for each file in the stylesheets folder
         # create a file object and add it to the stylesheets container
-        Dir.each_child( stylesheets_folder ) do |name|
-          pn = File.join( STYLESHEETS_FOLDER, name )
-          add_file_obj( @stylesheets, name, pn )
-        end
+        add_files_in_folder( stylesheet_folder, @stylesheets, STYLESHEET_FOLDER )
+
+        # Dir.each_child( stylesheet_folder ) do |name|
+        #   pn = File.join( STYLESHEET_FOLDER, name )
+        #   add_file_obj( @stylesheets, name, pn )
+        # end
       end
 
       #
@@ -197,10 +216,12 @@ module Gloo
 
         # for each file in the javascript folder
         # create a file object and add it to the javascript container
-        Dir.each_child( javascript_folder ) do |name|
-          pn = File.join( JAVASCRIPT_FOLDER, name )
-          add_file_obj( @javascript, name, pn )
-        end
+        add_files_in_folder( javascript_folder, @javascript, JAVASCRIPT_FOLDER )
+
+        # Dir.each_child( javascript_folder ) do |name|
+        #   pn = File.join( JAVASCRIPT_FOLDER, name )
+        #   add_file_obj( @javascript, name, pn )
+        # end
       end
 
       # 

data/lib/gloo/web_svr/config.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # Configuration for a gloo web server.
 #

data/lib/gloo/web_svr/embedded_renderer.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# 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.

data/lib/gloo/web_svr/handler.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# 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.
@@ -41,13 +41,15 @@ module Gloo
         request.id = id
         if page
           if page.is_a? Gloo::Objs::FileHandle
-            return handle_file page
+            result = handle_file page
           else
-            return handle_page page
+            result = handle_page page
           end
+        else
+          result = server_error_result
         end
 
-        return server_error_result
+        return result
       end
 
       #