icfs 0.1.1 → 0.1.2

data/lib/icfs/web/client.rb

@@ -21,9 +21,6 @@ module Web
 ##########################################################################
 # Web Client
 #
-# @todo Improve time handling for web interface
-# @todo Scrub the javascript
-#
 class Client
 
   ###############################################
@@ -170,6 +167,7 @@ class Client
     when 'case_edit'; return _call_case_edit(env)
     when 'entry_edit'; return _call_entry_edit(env)
     when 'index_edit'; return _call_index_edit(env)
+    when 'config_edit'; return _call_config_edit(env)
 
     # view
     when 'home', ''; return _call_home(env)
@@ -369,6 +367,8 @@ class Client
     ['after'.freeze, :after, :time].freeze,
     ['tags'.freeze, :tags, :string].freeze,
     ['purpose'.freeze, :purpose, :string].freeze,
+    ['size'.freeze, :size, :integer].freeze,
+    ['page'.freeze, :page, :integer].freeze,
     ['sort'.freeze, :sort, :string].freeze,
   ].freeze
 
@@ -430,6 +430,8 @@ class Client
     ['content'.freeze, :content, :string].freeze,
     ['tags'.freeze, :tags, :string].freeze,
     ['purpose'.freeze, :purpose, :string].freeze,
+    ['size'.freeze, :size, :integer].freeze,
+    ['page'.freeze, :page, :integer].freeze,
     ['sort'.freeze, :sort, :string].freeze,
   ].freeze
 
@@ -753,6 +755,43 @@ class Client
   end # def _call_index_edit()
 
 
+  ###############################################
+  # Edit configuration
+  #
+  def _call_config_edit(env)
+    env['icfs.page'] = 'Config Edit'.freeze
+    api = env['icfs']
+    cfg = env['icfs.config']
+    _verb_getpost(env)
+
+    # get the form
+    if env['REQUEST_METHOD'] == 'GET'.freeze
+      parts = [ _form_config(env) ]
+      body = [
+        _div_nav(env),
+        _div_desc('Edit Configuration'.freeze, ''.freeze),
+        _div_form(env, '/config_edit/'.freeze, nil, parts,
+          'Save Config'.freeze),
+      ].join(''.freeze)
+      return _resp_success(env, body)
+
+    # post the form
+    elsif env['REQUEST_METHOD'] == 'POST'.freeze
+      para = _util_post(env)
+      _post_config(env, para).each{|key, val| cfg.set(key,val) }
+      cfg.save
+
+      # display the index
+      body = [
+        _div_nav(env),
+        _div_desc('Edit Configuration'.freeze, 'Settings saved'.freeze),
+        _div_info(env),
+      ].join(''.freeze)
+      return _resp_success(env, body)
+    end
+  end # def _call_config_edit()
+
+
   ###############################################
   # User Home page
   def _call_home(env)
@@ -1020,6 +1059,7 @@ class Client
             after: Time.now.to_i - 60*60*24*30,
             purpose: 'User Stats - Last 30 days'.freeze,
           }, 'Stats'.freeze),
+        _a_config_edit(env, 'Config'),
         _a_info(env, 'Info'.freeze),
       ]
     end
@@ -1067,7 +1107,7 @@ class Client
   #
   def _div_info(env)
     api = env['icfs']
-    tz = env['icfs.tz']
+    tz = env['icfs.config'].get('tz')
 
     # roles/groups/perms
     roles = api.roles.map{|rol| DivInfoList % Rack::Utils.escape_html(rol)}
@@ -2996,7 +3036,7 @@ class Client
         FormEntryStatEach % [
           stats_cnt, claim_cnt,
           stats_cnt, esc, esc,
-          stats_cnt, st['val'].to_s,
+          stats_cnt, st['value'].to_s,
           claims.join(''.freeze)
         ]
       end
@@ -3032,7 +3072,7 @@ class Client
         title, time, content,
         tags_cnt, tags,
         files_cnt, files,
-        Rack::Utils.escape(env['SCRIPT_NAME']),
+        env['SCRIPT_NAME'],
         Rack::Utils.escape(cid),
         index_cnt, index,
         stats_sel, stats_cnt, stats,
@@ -3638,6 +3678,36 @@ class Client
           </div>'.freeze
 
 
+  ###############################################
+  # Config Form
+  #
+  def _form_config(env)
+    cfg = env['icfs.config']
+    tz = cfg.get('tz')
+    return FormConfig % [tz]
+  end # def _form_config()
+
+
+  # Config form
+  FormConfig = '
+    <div class="sect">
+      <div class="sect-main">
+        <div class="sect-label">Config</div>
+        <div class="tip"><div class="tip-disp"></div><div class="tip-info">
+          Configuration settings.
+        </div></div>
+        <div class="sect-fill"> </div>
+      </div>
+      <div class="form-row">
+        <div class="list-label">Timezone:</div>
+        <input class="form-tz" name="cfg-tz" type="text" value="%s">
+        <div class="tip"><div class="tip-disp"></div><div class="tip-info">
+          Timezone to display date/times, format as +/-HH:MM.
+        </div></div>
+      </div>
+    </div>'.freeze
+
+
 ###########################################################
 # Post
 ###########################################################
@@ -3948,6 +4018,17 @@ class Client
   end # def _post_index()
 
 
+  ###############################################
+  # Config edit
+  #
+  def _post_config(env, para)
+    cfg = {
+      'tz' => para['cfg-tz']
+    }
+    return cfg
+  end # def _post_config()
+
+
 ###########################################################
 # Links
 ###########################################################
@@ -4129,6 +4210,17 @@ class Client
   end
 
 
+  ###############################################
+  # Link to Config edit
+  #
+  def _a_config_edit(env, txt)
+    '<a href="%s/config_edit">%s</a>'.freeze % [
+      env['SCRIPT_NAME'],
+      Rack::Utils.escape_html(txt)
+    ]
+  end
+
+
   ###############################################
   # Link to Home
   #
@@ -4287,7 +4379,8 @@ class Client
   # Epoch time as local
   #
   def _util_time(env, time)
-    Time.at(time).getlocal(env['icfs.tz']).strftime('%F %T'.freeze)
+    tz = env['icfs.config'].get('tz')
+    Time.at(time).getlocal(tz).strftime('%F %T'.freeze)
   end
 
 
@@ -4304,7 +4397,7 @@ class Client
 
     # default use parse
     ma = /[+-]\d{2}:\d{2}$/.match str
-    tstr = ma ? str : str + env['icfs.tz']
+    tstr = ma ? str : str + env['icfs.config'].get('tz')
     time = Time.parse(tstr).to_i
   rescue ArgumentError
     return nil

data/lib/icfs/web/config.rb

@@ -0,0 +1,108 @@
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+#
+module ICFS
+module Web
+
+##########################################################################
+# Configuration storage interface
+#
+# @abstract
+#
+class Config
+
+  ###############################################
+  # Valid config options
+  ValConfig = {
+    method: :hash,
+    optional: {
+      'tz' => {
+        method: :string,
+        valid: /[+\-](0[0-9]|1[0-2]):[0-5][0-9]/.freeze,
+        whitelist: true,
+      }
+    }
+  }
+
+  ###############################################
+  # New instance
+  #
+  # @param defaults [Hash] The default options
+  #
+  def initialize(defaults={})
+    @data = {}
+    @unam = nil
+    @defaults = defaults
+  end # def initialize()
+
+
+  ###############################################
+  # The configuration values hash
+  #
+  attr_accessor :data
+
+
+  ###############################################
+  # The configuration defaults
+  #
+  attr_reader :defaults
+
+
+  ###############################################
+  # Get a value
+  #
+  # @param key [String] The name of the config setting
+  #
+  def get(key)
+    @data.key?(key) ? @data[key] : @defaults[key]
+  end
+
+
+  ###############################################
+  # Set a value
+  #
+  # @param key [String] The name of the config setting
+  # @param val [Object] The value of the config setting
+  #
+  def set(key, val)
+    @data[key] = val
+  end
+
+
+  ###############################################
+  # Where to store objects
+  #
+  def _key(unam)
+    @pre + unam
+  end # def _key()
+  private :_key
+
+
+  ###############################################
+  # Load a user configuration
+  #
+  # @param unam [String] the user name to load
+  # @return [Boolean] if any config data was found for the user
+  #
+  def load(unam); raise NotImplementedError; end
+
+
+  ###############################################
+  # Save a user configuration
+  #
+  def save; raise NotImplementedError; end
+
+
+end # class ICFS::Web::Config
+
+end # module ICFS::Web
+end # module ICFS

data/lib/icfs/web/config_redis.rb

@@ -0,0 +1,78 @@
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+require_relative 'config'
+
+module ICFS
+module Web
+
+##########################################################################
+# Implement Config with a Redis cache
+#
+class ConfigRedis < Config
+
+
+  ###############################################
+  # New instance
+  #
+  # @param redis [Redis] The redis client
+  # @param base [Config] The base Config store
+  # @param opts [Hash] Options
+  # @option opts [String] :prefix Prefix for Redis key
+  # @option opts [Integer] :expires Expiration time in seconds
+  #
+  def initialize(redis, base, opts={})
+    super(base.defaults)
+    @redis = redis
+    @base = base
+    @pre = opts[:prefix] || ''.freeze
+    @exp = opts[:expires] || 1*60*60 # 1 hour default
+  end
+
+
+  ###############################################
+  # (see Config#load)
+  #
+  def load(unam)
+    Items.validate(unam, 'User/Role/Group name'.freeze, Items::FieldUsergrp)
+    @unam = unam.dup
+    key = _key(unam)
+
+    # try cache
+    json = @redis.get(key)
+    if json
+      @data = Items.parse(json, 'Config values'.freeze, Config::ValConfig)
+      return true
+    end
+
+    # get base object
+    succ = @base.load(unam)
+    @data = @base.data
+    return succ
+  end # def load()
+
+
+  ###############################################
+  # (see Config#save)
+  #
+  def save()
+    raise(RuntimeError, 'Save requires a user name'.freeze) if !@unam
+    json = Items.generate(@data, 'Config values'.freeze, Config::ValConfig)
+    @redis.del(_key(@unam))
+    @base.data = @data
+    @base.save
+  end # def save()
+
+
+end # class ICFS::Web::Config
+
+end # module ICFS::Web
+end # module ICFS

data/lib/icfs/web/config_s3.rb

@@ -0,0 +1,66 @@
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+require_relative 'config'
+
+module ICFS
+module Web
+
+##########################################################################
+# Configuration storage implemented in S3
+#
+class ConfigS3 < Config
+
+
+  ###############################################
+  # New instance
+  #
+  # @param defaults [Hash] The default options
+  # @param s3 [Aws::S3::Client] the configured S3 client
+  # @param bucket [String] The bucket name
+  # @param prefix [String] Prefix to use for object keys
+  #
+  def initialize(defaults, s3, bucket, prefix=nil)
+    super(defaults)
+    @s3 = s3
+    @bck = bucket
+    @pre = prefix || ''.freeze
+  end
+
+
+  ###############################################
+  # (see Config#load)
+  #
+  def load(unam)
+    Items.validate(unam, 'User/Role/Group name'.freeze, Items::FieldUsergrp)
+    @unam = unam.dup
+    json = @s3.get_object( bucket: @bck, key: _key(unam) ).body.read
+    @data = Items.parse(json, 'Config values'.freeze, Config::ValConfig)
+    return true
+  rescue
+    @data = {}
+    return false
+  end # def load()
+
+
+  ###############################################
+  # (see Config#save)
+  #
+  def save()
+    raise(RuntimeError, 'Save requires a user name'.freeze) if !@unam
+    json = Items.generate(@data, 'Config values'.freeze, Config::ValConfig)
+    @s3.put_object( bucket: @bck, key: _key(@unam), body: json )
+  end # def save()
+
+end # class ICFS::Web::ConfigS3
+
+end # module ICFS::Web
+end # module ICFS

data/lib/icfs.rb

@@ -16,8 +16,6 @@ require_relative 'icfs/validate'
 ##########################################################################
 # Investigative Case File System
 #
-# @todo Delete Items and move into this module
-#
 module ICFS
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icfs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Graham A. Field
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies: []
 description: |2-
 
@@ -29,7 +29,6 @@ files:
 - bin/icfs_demo_fcgi.rb
 - bin/icfs_demo_ssl_gen.rb
 - bin/icfs_demo_web.rb
-- bin/icfs_dev_todo.rb
 - data/demo_config.yml
 - data/docker/build-web.sh
 - data/docker/compose-demo.yml
@@ -42,6 +41,17 @@ files:
 - data/docker/nginx.conf
 - data/icfs.css
 - data/icfs.js
+- devel/create.sh
+- devel/elastic.sh
+- devel/icfs-wrk/Dockerfile
+- devel/minio.sh
+- devel/redis.sh
+- devel/server.sh
+- devel/test/es-s3-fs-init.rb
+- devel/test/es-s3-fs-webrick.rb
+- devel/test/es-s3-restore.rb
+- devel/test/init.rb
+- devel/test/run.rb
 - lib/icfs.rb
 - lib/icfs/api.rb
 - lib/icfs/cache.rb
@@ -55,13 +65,17 @@ files:
 - lib/icfs/store_fs.rb
 - lib/icfs/store_s3.rb
 - lib/icfs/users.rb
-- lib/icfs/users_elastic.rb
 - lib/icfs/users_fs.rb
+- lib/icfs/users_redis.rb
+- lib/icfs/users_s3.rb
 - lib/icfs/utils/backup.rb
 - lib/icfs/utils/check.rb
 - lib/icfs/validate.rb
 - lib/icfs/web/auth_ssl.rb
 - lib/icfs/web/client.rb
+- lib/icfs/web/config.rb
+- lib/icfs/web/config_redis.rb
+- lib/icfs/web/config_s3.rb
 homepage: https://github.com/g4field/icfs
 licenses:
 - GPL-3.0

data/lib/icfs/users_elastic.rb

@@ -1,168 +0,0 @@
-#
-# Investigative Case File System
-#
-# Copyright 2019 by Graham A. Field
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 3.
-#
-# This program is distributed WITHOUT ANY WARRANTY; without even the
-# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-
-require 'set'
-require_relative 'elastic'
-
-module ICFS
-
-##########################################################################
-# Implements {ICFS::Users Users} using Elasticsearch to cache
-# details from another {ICFS::Users Users} instance.
-# 
-# @todo Add logging
-#
-class UsersElastic < Users
-
-  include Elastic
-
-  private
-
-  ###############################################
-  # The ES mappings for the indexes
-  #
-  Maps = {
-    :users => '{
-  "mappings": { "_doc": { "properties": {
-    "name": { "type": "text" },
-    "type": { "type": "keyword" },
-    "roles": { "type": "keyword" },
-    "groups": { "type": "keyword" },
-    "perms": { "type": "keyword" },
-    "first": { "enabled": false },
-    "last": { "type": "date", "format": "epoch_second" },
-    "active": { "type": "boolean" }
-  }}}
-}'.freeze,
-  }.freeze
-
-  public
-
-  ###############################################
-  # New instance
-  #
-  # @param map [Hash] Symbol to String of the indexes.
-  #    Must provide :user
-  # @param es [Faraday] Faraday instance to the Elasticsearch cluster
-  # @param src [Users] Source of authoritative information
-  # @param exp [Integer] Maximum time to cache a response
-  #
-  def initialize(map, es, src, exp=3600)
-    @map = map
-    @es = es
-    @src = src
-    @exp = exp
-  end
-
-
-  ###############################################
-  # Validate a user
-  #
-  ValUserCache = {
-    method: :hash,
-    required: {
-      'name' => Items::FieldUsergrp,
-      'type' => {
-        method: :string,
-        allowed: Set[
-          'user'.freeze,
-          'role'.freeze,
-          'group'.freeze,
-        ].freeze
-      }.freeze,
-      'first' => Validate::IsIntPos,
-      'last' => Validate::IsIntPos,
-      'active' => Validate::IsBoolean,
-    }.freeze,
-    optional: {
-      'roles' => {
-        method: :array,
-        check: Items::FieldUsergrp,
-        uniq: true
-      }.freeze,
-      'groups' => {
-        method: :array,
-        check: Items::FieldUsergrp,
-        uniq: true
-      }.freeze,
-      'perms' => {
-        method: :array,
-        check: Items::FieldPermGlobal,
-        uniq: true
-      }.freeze
-    }.freeze
-  }.freeze
-
-
-  ###############################################
-  # (see Users#read)
-  #
-  def read(urg)
-    json = _read(:users, urg)
-    now = Time.now.to_i
-
-    # not in the cache
-    if !json
-
-      # read from source
-      obj = @src.read(urg)
-      return nil if !obj
-
-      # first time
-      obj['first'] = now
-      obj['last'] = now
-      obj['active'] = true
-
-      # store in cache
-      json = Items.generate(obj, 'User/Role/Group'.freeze, ValUserCache)
-      _write(:users, urg, json)
-
-    # use cached version
-    else
-      obj = Items.parse(json, 'User/Role/Group'.freeze, ValUserCache)
-    end
-
-    # expired
-    if (obj['last'] + @exp) < now
-
-      # read from source
-      obj2 = @src.read(urg)
-
-      # update
-      if obj2
-        obj['active'] = true
-        obj['roles'] = obj2['roles']
-        obj['groups'] = obj2['groups']
-        obj['perms'] = obj2['perms']
-      else
-        obj['active'] = false
-      end
-      obj['last'] = now
-
-      # and store in cache
-      json = Items.generate(obj, 'User/Role/Group'.freeze, ValUserCache)
-      _write(:users, urg, json)
-    end
-
-    # not active
-    return nil unless obj['active']
-
-    # clean out cached info
-    obj.delete('first'.freeze)
-    obj.delete('last'.freeze)
-    obj.delete('active'.freeze)
-
-    return obj
-  end # def read()
-
-end # class ICFS::Users
-
-end # module ICFS