icfs 0.1.0 → 0.1.1

data/lib/icfs.rb

@@ -11,12 +11,12 @@
 
 require 'digest/sha2'
 
+require_relative 'icfs/validate'
+
 ##########################################################################
 # Investigative Case File System
 #
 # @todo Delete Items and move into this module
-# @todo Verification tool written
-# @todo Archive/move case tool written
 #
 module ICFS
 
@@ -101,7 +101,6 @@ end # module ICFS::Error
 
 end # module ICFS
 
-require_relative 'icfs/validate'
 require_relative 'icfs/cache'
 require_relative 'icfs/store'
 require_relative 'icfs/items'

data/lib/icfs/api.rb

@@ -265,12 +265,12 @@ class Api
   def case_read(cid, lnum=0)
     if lnum != 0
       json = @store.case_read(cid, lnum)
-      return Validate.parse(json, 'case'.freeze, Items::ItemCase)
+      return Items.parse(json, 'case'.freeze, Items::ItemCase)
     end
 
     if !@cases.key?(cid)
       json = @cache.case_read(cid)
-      cur = Validate.parse(json, 'case'.freeze, Items::ItemCase)
+      cur = Items.parse(json, 'case'.freeze, Items::ItemCase)
       @cases[cid] = cur
     end
     return @cases[cid]
@@ -295,7 +295,7 @@ class Api
 
     # read
     json = @cache.log_read(cid, lnum)
-    return Validate.parse(json, 'log'.freeze, Items::ItemLog)
+    return Items.parse(json, 'log'.freeze, Items::ItemLog)
   end # def log_read()
 
 
@@ -313,7 +313,7 @@ class Api
     # get access list and current entry
     al = access_list(cid)
     json = @cache.entry_read(cid, enum)
-    ec = Validate.parse(json, 'entry'.freeze, Items::ItemEntry)
+    ec = Items.parse(json, 'entry'.freeze, Items::ItemEntry)
 
     # see if we can read the entry
     need = Set.new
@@ -330,7 +330,7 @@ class Api
       return ec
     else
       json = @store.entry_read(cid, enum, lnum)
-      return Validate.parse(json, 'entry'.freeze, Items::ItemEntry)
+      return Items.parse(json, 'entry'.freeze, Items::ItemEntry)
     end
   end # def entry_read()
 
@@ -362,7 +362,7 @@ class Api
     id = '%s.%d'.freeze % [cid, anum]
     unless @actions.key?(id)
       json = @cache.action_read(cid, anum)
-      act = Validate.parse(json, 'action'.freeze, Items::ItemAction)
+      act = Items.parse(json, 'action'.freeze, Items::ItemAction)
       @actions[id] = act
     end
     return @actions[id]
@@ -395,7 +395,7 @@ class Api
       return ac
     else
       json = @store.action_read( cid, anum, lnum)
-      return Validate.parse(json, 'action'.freeze, Items::ItemAction)
+      return Items.parse(json, 'action'.freeze, Items::ItemAction)
     end
   end # def action_read()
 
@@ -419,14 +419,14 @@ class Api
 
     # read curent index
     json = @cache.index_read(cid, xnum)
-    xc = Validate.parse(json, 'index'.freeze, Items::ItemIndex)
+    xc = Items.parse(json, 'index'.freeze, Items::ItemIndex)
 
     # return the requested version
     if( lnum == 0 || xc['log'] == lnum )
       return xc
     else
       json = @store.index_read(cid, xnum, lnum)
-      return Validate.parse(json, 'index'.freeze, Items::ItemIndex)
+      return Items.parse(json, 'index'.freeze, Items::ItemIndex)
     end
   end # def index_read()
 
@@ -444,7 +444,7 @@ class Api
     end
 
     json = @cache.current_read(cid)
-    return Validate.parse(json, 'current'.current, Items::ItemCurrent)
+    return Items.parse(json, 'current'.current, Items::ItemCurrent)
   end # end def current_read()
 
 
@@ -476,7 +476,7 @@ class Api
   # @param query [Hash] a query
   #
   def case_search(query)
-    Validate.validate(query, 'Case Search'.freeze, ValCaseSearch)
+    Items.validate(query, 'Case Search'.freeze, ValCaseSearch)
     @cache.case_search(query)
   end
 
@@ -513,7 +513,7 @@ class Api
   # @param query [Hash] a query
   #
   def log_search(query)
-    Validate.validate(query, 'Log Search'.freeze, ValLogSearch)
+    Items.validate(query, 'Log Search'.freeze, ValLogSearch)
     @cache.log_search(query)
   end
 
@@ -552,7 +552,7 @@ class Api
   # Search for entries
   #
   def entry_search(query)
-    Validate.validate(query, 'Entry Search'.freeze, ValEntrySearch)
+    Items.validate(query, 'Entry Search'.freeze, ValEntrySearch)
 
     # check permissions
     # - have global search permissions / read access to the case
@@ -640,7 +640,7 @@ class Api
   # Search for actions
   #
   def action_search(query)
-    Validate.validate(query, 'Action Search'.freeze, ValActionSearch)
+    Items.validate(query, 'Action Search'.freeze, ValActionSearch)
 
     # permissions check
     # - have global search permissions / read access to the case
@@ -686,7 +686,7 @@ class Api
   # Search for indexes
   #
   def index_search(query)
-    Validate.validate(query, 'Index Search'.freeze, ValIndexSearch)
+    Items.validate(query, 'Index Search'.freeze, ValIndexSearch)
 
     # permissions check
     # - have global search permissions / read access to the case
@@ -701,7 +701,7 @@ class Api
     res[:list].each do |se|
       idx = se[:object]
 
-      unless access_list(idx[:caseid].include?(ICFS::PermRead))
+      unless access_list(idx[:caseid]).include?(ICFS::PermRead)
         idx[:title] = nil
         idx[:tags] = nil
       end
@@ -728,7 +728,7 @@ class Api
   # Analyze stats
   #
   def stats(query)
-    Validate.validate(query, 'Stats Search'.freeze, ValStatsSearch)
+    Items.validate(query, 'Stats Search'.freeze, ValStatsSearch)
 
     # permissions check
     # - have global search permissions / read access to the case
@@ -757,7 +757,7 @@ class Api
   # Get case tags
   #
   def case_tags(query)
-    Validate.validate(query, 'Case Tags Search'.freeze, ValCaseTags)
+    Items.validate(query, 'Case Tags Search'.freeze, ValCaseTags)
     return @cache.case_tags(query)
   end # def case_tags()
 
@@ -778,7 +778,7 @@ class Api
   # Get entry tags
   #
   def entry_tags(query)
-    Validate.validate(query, 'Entry Tags Search'.freeze, ValEntryTags)
+    Items.validate(query, 'Entry Tags Search'.freeze, ValEntryTags)
 
     # permissions
     # - read access to case
@@ -819,7 +819,7 @@ class Api
   # Get action tags
   #
   def action_tags(query)
-    Validate.validate(query, 'Task Tags Search'.freeze, ValActionTags)
+    Items.validate(query, 'Task Tags Search'.freeze, ValActionTags)
 
     # only allow searches for user/roles you have
     unless @ur.include?(query[:assigned]) ||
@@ -849,7 +849,7 @@ class Api
   # Get index tags
   #
   def index_tags(query)
-    Validate.validate(query, 'Index Tags'.freeze, ValIndexTags)
+    Items.validate(query, 'Index Tags'.freeze, ValIndexTags)
     unless access_list(query[:caseid]).include?(ICFS::PermRead)
       raise(Error::Perms, 'missing perms: %s'.freeze % ICFS::PermRead)
     end
@@ -875,8 +875,8 @@ class Api
     # Sanity checks
 
     # form & values
-    Validate.validate(ent, 'entry'.freeze, Items::ItemEntryNew)
-    Validate.validate(cse, 'case'.freeze, Items::ItemCaseEdit)
+    Items.validate(ent, 'entry'.freeze, Items::ItemEntryNew)
+    Items.validate(cse, 'case'.freeze, Items::ItemCaseEdit)
 
     # access users/roles/groups are valid
     cse["access"].each do |acc|
@@ -923,7 +923,7 @@ class Api
     cse['caseid'] = cid
     cse['log'] = 1
     cse['tags'] ||= [ ICFS::TagNone ]
-    citem = Validate.generate(cse, 'case'.freeze, Items::ItemCase)
+    citem = Items.generate(cse, 'case'.freeze, Items::ItemCase)
 
     # entry
     ent['icfs'] = 1
@@ -973,12 +973,12 @@ class Api
       # finish items
       ent['time'] ||= now
       ent['files'].each{|fi| fi['log'] ||= 1 } if ent['files']
-      eitem = Validate.generate(ent, 'entry'.freeze, Items::ItemEntry)
+      eitem = Items.generate(ent, 'entry'.freeze, Items::ItemEntry)
       log['time'] = now
       log['entry']['hash'] = ICFS.hash(eitem)
-      litem = Validate.generate(log, 'log'.freeze, Items::ItemLog)
+      litem = Items.generate(log, 'log'.freeze, Items::ItemLog)
       cur['hash'] = ICFS.hash(litem)
-      nitem = Validate.generate(cur, 'current'.freeze, Items::ItemCurrent)
+      nitem = Items.generate(cur, 'current'.freeze, Items::ItemCurrent)
 
       # write to cache
       @cache.entry_write(cid, 1, eitem)
@@ -1017,13 +1017,13 @@ class Api
 
     # form & content
     if idx || cse
-      Validate.validate(ent, 'New Entry'.freeze, Items::ItemEntryNew)
+      Items.validate(ent, 'New Entry'.freeze, Items::ItemEntryNew)
     else
-      Validate.validate(ent, 'Editable Entry'.freeze, Items::ItemEntryEdit)
+      Items.validate(ent, 'Editable Entry'.freeze, Items::ItemEntryEdit)
     end
-    Validate.validate(act, 'action'.freeze, Items::ItemActionEdit) if act
-    Validate.validate(idx, 'index'.freeze, Items::ItemIndexEdit) if idx
-    Validate.validate(cse, 'case'.freeze, Items::ItemCaseEdit) if cse
+    Items.validate(act, 'action'.freeze, Items::ItemActionEdit) if act
+    Items.validate(idx, 'index'.freeze, Items::ItemIndexEdit) if idx
+    Items.validate(cse, 'case'.freeze, Items::ItemCaseEdit) if cse
 
     # edit index OR case, not both
     if idx && cse
@@ -1133,13 +1133,13 @@ class Api
 
       # current
       json = @cache.current_read(cid)
-      cur = Validate.parse(json, 'current'.freeze, Items::ItemCurrent)
+      cur = Items.parse(json, 'current'.freeze, Items::ItemCurrent)
 
       # entry
       if ent['entry']
         enum = ent['entry']
         json = @cache.entry_read(cid, enum)
-        ent_pri = Validate.parse(json, 'entry'.freeze, Items::ItemEntry)
+        ent_pri = Items.parse(json, 'entry'.freeze, Items::ItemEntry)
         nxt['entry'] = cur['entry']
       else
         enum = cur['entry'] + 1
@@ -1156,7 +1156,7 @@ class Api
       end
       if anum
         json = @cache.action_read(cid, anum)
-        act_pri = Validate.parse(json, 'action'.freeze, Items::ItemAction)
+        act_pri = Items.parse(json, 'action'.freeze, Items::ItemAction)
         nxt['action'] = cur['action']
       elsif act
         anum = cur['action'] + 1
@@ -1318,7 +1318,7 @@ class Api
         end
       end
       ent['files'].each{|fi| fi['log'] ||= lnum } if ent['files']
-      eitem = Validate.generate(ent, 'entry'.freeze, Items::ItemEntry)
+      eitem = Items.generate(ent, 'entry'.freeze, Items::ItemEntry)
       log['entry'] = {
         'num' => enum,
         'hash' => ICFS.hash(eitem)
@@ -1328,7 +1328,7 @@ class Api
       if act
         act['action'] = anum
         act['log'] = lnum
-        aitem = Validate.generate(act, 'action'.freeze, Items::ItemAction)
+        aitem = Items.generate(act, 'action'.freeze, Items::ItemAction)
         log['action'] = {
           'num' => anum,
           'hash' => ICFS.hash(aitem)
@@ -1339,7 +1339,7 @@ class Api
       if idx
         idx['index'] = xnum
         idx['log'] = lnum
-        xitem = Validate.generate(idx, 'index'.freeze, Items::ItemIndex)
+        xitem = Items.generate(idx, 'index'.freeze, Items::ItemIndex)
         log['index'] = {
           'num' => xnum,
           'hash' => ICFS.hash(xitem)
@@ -1349,7 +1349,7 @@ class Api
       # case
       if cse
         cse['log'] = lnum
-        citem = Validate.generate(cse, 'case'.freeze, Items::ItemCase)
+        citem = Items.generate(cse, 'case'.freeze, Items::ItemCase)
         log['case_hash'] = ICFS.hash(citem)
       end
 
@@ -1357,11 +1357,11 @@ class Api
       log['log'] = lnum
       log['prev'] = cur['hash']
       log['time'] = now
-      litem = Validate.generate(log, 'log'.freeze, Items::ItemLog)
+      litem = Items.generate(log, 'log'.freeze, Items::ItemLog)
       nxt['hash'] = ICFS.hash(litem)
 
       # next
-      nitem = Validate.generate(nxt, 'current'.freeze, Items::ItemCurrent)
+      nitem = Items.generate(nxt, 'current'.freeze, Items::ItemCurrent)
 
 
       ####################

data/lib/icfs/cache_elastic.rb

@@ -9,6 +9,8 @@
 # This program is distributed WITHOUT ANY WARRANTY; without even the
 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
+require 'json'
+require 'socket'
 require_relative 'elastic'
 
 
@@ -153,6 +155,8 @@ class CacheElastic < Cache
   def initialize(map, es)
     @map = map
     @es = es
+    @name = '%s:%d' % [Socket.gethostname, Process.pid]
+    @name.freeze
   end
 
 
@@ -165,11 +169,9 @@ class CacheElastic < Cache
   ###############################################
   # (see Cache#lock_take)
   #
-  # @todo Include client info to help with debugging
-  #
   def lock_take(cid)
 
-    json = '{"client":"TODO"}'.freeze
+    json = '{"client":"%s"}'.freeze % @name
     url = '%s/_doc/%s/_create'.freeze % [@map[:lock], CGI.escape(cid)]
     head = {'Content-Type'.freeze => 'application/json'.freeze}.freeze
 
@@ -656,7 +658,7 @@ class CacheElastic < Cache
     filter = [
       _query_term('caseid'.freeze, query[:caseid]),
       _query_term('tags'.freeze, query[:tags]),
-      _query_prefix('title'.freeze, query[:prefix]),
+      _query_prefix('title.raw'.freeze, query[:prefix]),
     ].compact
     req = { 'query' => _query_bool(must, filter, nil, nil) }
 

data/lib/icfs/items.rb

@@ -9,7 +9,9 @@
 # This program is distributed WITHOUT ANY WARRANTY; without even the
 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-#
+require 'json'
+
+
 module ICFS
 
 
@@ -18,6 +20,65 @@ module ICFS
 #
 module Items
 
+
+    ###############################################
+    # Parse JSON string and validate
+    #
+    # @param json [String] the JSON to parse
+    # @param name [String] description of the item
+    # @param val [Hash] the check to use
+    # @return [Object] the item
+    #
+    # @raise [Error::NotFound] if json is nil
+    # @raise [Error::Value] if parsing or validation fails
+    #
+    def self.parse(json, name, val)
+      if json.nil?
+        raise(Error::NotFound, '%s not found'.freeze % name)
+      end
+      begin
+        itm = JSON.parse(json)
+      rescue
+        raise(Error::Value, 'JSON parsing failed'.freeze)
+      end
+      Items.validate(itm, name, val)
+      return itm
+    end # def self.parse()
+
+
+    ###############################################
+    # Validate and generate JSON
+    #
+    # @param itm [Object] item to validate
+    # @param name [String] description of the item
+    # @param val [Hash] the check to use
+    # @return [String] JSON encoded item
+    #
+    # @raise [Error::Value] if validation fails
+    #
+    def self.generate(itm, name, val)
+      Items.validate(itm, name, val)
+      return JSON.pretty_generate(itm)
+    end # def self.generate()
+
+
+    ###############################################
+    # Validate an object
+    #
+    # @param obj [Object] object to validate
+    # @param name [String] description of the object
+    # @param val [Hash] the check to use
+    #
+    # @raise [Error::Value] if validation fails
+    #
+    def self.validate(obj, name, val)
+      err = Validate.check(obj, val)
+      if err
+        raise(Error::Value, '%s has bad values: %s'.freeze %
+          [name, err.inspect])
+      end
+    end
+
   ##############################################################
   # Base fields
   ##############################################################

data/lib/icfs/store.rb

@@ -115,6 +115,18 @@ class Store
   def file_write(cid, enum, lnum, fnum, tmpf); raise NotImplementedError; end
 
 
+  ###############################################
+  # Get a file size
+  #
+  # @param cid [String] caseid
+  # @param enum [Integer] Entry number
+  # @param lnum [Integer] Log number
+  # @param fnum [Integer] File number
+  # @return [Integer] The size of the file
+  #
+  def file_size(cid, enum, lnum, fnum); raise NotImplementedError; end
+
+
   ###############################################
   # Read an action
   #
@@ -176,6 +188,19 @@ class Store
   def tempfile; raise NotImplementedError; end
 
 
+  ###############################################
+  # Close the file returned by file_read()
+  #
+  # @param fi [File] The file to close
+  #
+  def close(fi)
+    if fi.respond_to?( :close! )
+      fi.close!
+    else
+      fi.close
+    end
+  end
+
   private