icfs 0.1.0

data/lib/icfs/store.rb

@@ -0,0 +1,278 @@
+#
+# 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
+
+##########################################################################
+# Permanent store for items
+#
+# Provides storage for:
+# * Case
+# * Log
+# * Entry
+# * Attached files
+# * Action
+# * Indexes
+#
+# @abstract
+#
+class Store
+
+  ###############################################
+  # Read a case
+  #
+  # @param cid [String] caseid
+  # @param lnum [Integer] Log number
+  # @return [String] The JSON encoded item
+  #
+  def case_read(cid, lnum); _read(_case(cid, lnum)); end
+
+
+  ###############################################
+  # Write a case
+  #
+  # @param cid [String] caseid
+  # @param lnum [Integer] Log number
+  # @param item [String] the JSON encoded item
+  #
+  def case_write(cid, lnum, item); _write(_case(cid, lnum), item); end
+
+
+  ###############################################
+  # Read a log
+  #
+  # @param cid [String] caseid
+  # @param lnum [Integer] Log number
+  # @return [String] The JSON encoded item
+  #
+  def log_read(cid, lnum); _read(_log(cid, lnum)); end
+
+
+  ###############################################
+  # Write a log
+  #
+  # @param cid [String] caseid
+  # @param lnum [Integer] Log number
+  # @param item [String] the JSON encoded item
+  #
+  def log_write(cid, lnum, item); _write(_log(cid, lnum), item); end
+
+
+  ###############################################
+  # Read an entry
+  #
+  # @param cid [String] caseid
+  # @param enum [Integer] Entry number
+  # @param lnum [Integer] Log number
+  # @return [String] The JSON encoded item
+  #
+  def entry_read(cid, enum, lnum); _read(_entry(cid, enum, lnum)); end
+
+
+  ###############################################
+  # Write an entry
+  #
+  # @param cid [String] caseid
+  # @param enum [Integer] Entry number
+  # @param lnum [Integer] Log number
+  # @param item [String] the JSON encoded item
+  #
+  def entry_write(cid, enum, lnum, item)
+    _write(_entry(cid, enum, lnum), item)
+  end
+
+
+  ###############################################
+  # Read a file
+  #
+  # @param cid [String] caseid
+  # @param enum [Integer] Entry number
+  # @param lnum [Integer] Log number
+  # @param fnum [Integer] File number
+  # @return [File,Tempfile] Read only copy of the file
+  #
+  def file_read(cid, enum, lnum, fnum); raise NotImplementedError; end
+
+
+  ###############################################
+  # Write a file
+  #
+  # @param cid [String] caseid
+  # @param enum [Integer] Entry number
+  # @param lnum [Integer] Log number
+  # @param fnum [Integer] File number
+  # @param tmpf [Tempfile] A Tempfile obtained from #tempfile
+  #
+  def file_write(cid, enum, lnum, fnum, tmpf); raise NotImplementedError; end
+
+
+  ###############################################
+  # Read an action
+  #
+  # @param cid [String] caseid
+  # @param anum [Integer] Action number
+  # @param lnum [Integer] Log number
+  # @return [String] The JSON encoded item
+  #
+  def action_read(cid, anum, lnum)
+    _read(_action(cid, anum, lnum))
+  end
+
+
+  ###############################################
+  # Write an action
+  #
+  # @param cid [String] caseid
+  # @param anum [Integer] Action number
+  # @param lnum [Integer] Log number
+  # @param item [String] the JSON encoded item
+  #
+  def action_write(cid, anum, lnum, item)
+    _write(_action(cid, anum, lnum), item)
+  end
+
+
+  ###############################################
+  # Read an Index
+  #
+  # @param cid [String] caseid
+  # @param xnum [Integer] Index number
+  # @param lnum [Integer] Log number
+  # @return [String] the JSON encoded item
+  #
+  def index_read(cid, xnum, lnum)
+    _read(_index(cid, xnum, lnum))
+  end
+
+
+  ###############################################
+  # Write an Index
+  #
+  # @param cid [String] caseid
+  # @param xnum [Integer] Index number
+  # @param lnum [Integer] Log number
+  # @param item [String] the JSON encoded item
+  #
+  def index_write(cid, xnum, lnum, item)
+    _write(_index(cid, xnum, lnum), item)
+  end
+
+
+  ###############################################
+  # Get a Tempfile to use to write files
+  #
+  # @return [Tempfile] a Tempfile which can be written and passed to
+  #   #file_write
+  #
+  def tempfile; raise NotImplementedError; end
+
+
+  private
+
+
+  ###############################################
+  # Read an item
+  #
+  def _read(path); raise NotImplementedError; end
+
+
+  ###############################################
+  # Write an item
+  #
+  def _write(path, item); raise NotImplementedError; end
+
+
+  ###############################################
+  # Path for case
+  #
+  def _case(cid, lnum)
+    [
+      @base,
+      cid,
+      'c'.freeze,
+      '%d.json'.freeze % lnum
+    ].join('/'.freeze)
+  end
+
+
+  ###############################################
+  # Path for log
+  #
+  def _log(cid, lnum)
+    [
+      @base,
+      cid,
+      'l'.freeze,
+      '%d.json'.freeze % lnum
+    ].join('/'.freeze)
+  end
+
+
+  ###############################################
+  # Path for entry
+  #
+  def _entry(cid, enum, lnum)
+    [
+      @base,
+      cid,
+      'e'.freeze,
+      enum.to_s,
+      '%d.json'.freeze % lnum
+    ].join('/'.freeze)
+  end
+
+
+  ###############################################
+  # Path for file
+  #
+  def _file(cid, enum, lnum, fnum)
+    [
+      @base,
+      cid,
+      'e'.freeze,
+      enum.to_s,
+      '%d-%d.bin'.freeze % [lnum, fnum]
+    ].join('/'.freeze)
+  end
+
+
+  ###############################################
+  # Filename for action
+  #
+  def _action(cid, anum, lnum)
+    [
+      @base,
+      cid,
+      'a'.freeze,
+      anum.to_s,
+      lnum.to_s + '.json'.freeze
+    ].join('/'.freeze)
+  end
+
+
+  ###############################################
+  # Filename for index
+  #
+  def _index(cid, xnum, lnum)
+    [
+      @base,
+      cid,
+      'i'.freeze,
+      xnum.to_s,
+      lnum.to_s + '.json'.freeze
+    ].join('/'.freeze)
+  end
+
+
+end # class ICFS::Store
+
+end # module ICFS

data/lib/icfs/store_fs.rb

@@ -0,0 +1,98 @@
+#
+# 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 'fileutils'
+require 'tempfile'
+
+module ICFS
+
+##########################################################################
+# Permanent store for items using the filesystem
+#
+# @deprecated Using a filesystem for a production system is a horrible idea.
+#   This is provided as an example and should be used for development use
+#   only.
+#
+class StoreFs < Store
+
+  ###############################################
+  # New instance
+  #
+  # @param base [String] the base directory
+  #
+  def initialize(base)
+    @base = base.freeze
+  end
+
+
+  ###############################################
+  # (see Store#file_read)
+  #
+  def file_read(cid, enum, lnum, fnum)
+    File.open(_file(cid, enum, lnum, fnum), 'rb')
+  rescue Errno::ENOENT
+    return nil
+  end
+
+
+  ###############################################
+  # (see Store#file_write)
+  #
+  def file_write(cid, enum, lnum, fnum, tmpf)
+    fn = _file(cid, enum, lnum, fnum)
+    FileUtils.ln(tmpf.path, fn, force: true)
+    tmpf.close!
+  rescue Errno::ENOENT
+    FileUtils.mkdir_p(File.dirname(fn))
+    FileUtils.ln(tmpf.path, fn, force: true)
+    tmpf.close!
+  end
+
+
+  ###############################################
+  # (see Store#tempfile)
+  #
+  def tempfile
+    Tempfile.new('tmp'.freeze, @base, :encoding => 'ascii-8bit'.freeze)
+  end
+
+
+  private
+
+
+  ###############################################
+  # Read an item
+  #
+  def _read(fnam)
+    return File.read(fnam, encoding: 'utf-8'.freeze)
+  rescue Errno::ENOENT
+    return nil
+  end
+
+
+  ###############################################
+  # Write an item
+  #
+  def _write(fnam, item)
+    File.open(fnam, 'w'.freeze, encoding: 'utf-8'.freeze) do |fi|
+      fi.write(item)
+    end
+  rescue Errno::ENOENT
+    FileUtils.mkdir_p(File.dirname(fnam))
+    File.open(fnam, 'w'.freeze, encoding: 'utf-8'.freeze) do |fi|
+      fi.write(item)
+    end
+  end
+
+
+end # class StoreFs
+
+end # module ICFS

data/lib/icfs/store_s3.rb

@@ -0,0 +1,97 @@
+#
+# 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 'aws-sdk-s3'
+require 'tempfile'
+
+module ICFS
+
+##########################################################################
+# Permanent store for items using AWS S3
+#
+class StoreS3 < Store
+
+
+  ###############################################
+  # New store
+  #
+  # @param client [Aws::S3::Client] The configured S3 client
+  # @param bucket [String] The bucket name
+  # @param prefix [String] Prefix to use for object keys
+  #
+  def initialize(client, bucket, prefix=nil)
+    @s3 = client
+    @bck = bucket
+    @base = prefix || ''.freeze
+  end # def initialize()
+
+
+  ###############################################
+  # (see Store#file_read)
+  #
+  def file_read(cid, enum, lnum, fnum)
+    tmp = tempfile
+    key = _file(cid, enum, lnum, fnum)
+    @s3.get_object( bucket: @bck, key: key, response_target: tmp)
+    tmp.rewind
+    return tmp
+  rescue Aws::S3::Errors::NoSuchKey
+    return nil
+  end
+
+
+  ###############################################
+  # (see Store#file_write)
+  #
+  def file_write(cid, enum, lnum, fnum, tmpf)
+    key = _file(cid, enum, lnum, fnum)
+    tmpf.rewind
+    @s3.put_object( bucket: @bck, key: key, body: tmpf )
+
+    if tmpf.respond_to?( :close! )
+      tmpf.close!
+    else
+      tmpf.close
+    end
+  end
+
+
+  ###############################################
+  # (see Store#tempfile)
+  #
+  def tempfile
+    Tempfile.new('tmp'.freeze, encoding: 'ascii-8bit'.freeze)
+  end
+
+
+  private
+
+
+  ###############################################
+  # (see Store#_read)
+  #
+  def _read(path)
+    @s3.get_object( bucket: @bck, key: path).body.read
+  rescue Aws::S3::Errors::NoSuchKey
+    return nil
+  end # def _read()
+
+
+  ###############################################
+  # (see Store#_write)
+  #
+  def _write(path, item)
+    @s3.put_object( bucket: @bck, key: path, body: item )
+  end
+
+end # class ICFS::Store
+
+end # module ICFS