icfs 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28031e9c5c67e30c2cf4778fbf56a7840117d256e4384e6e044e7cc888958d09
-  data.tar.gz: 3abea632e084b00bd09ac570710eab52e99a152d073c6f96779a04c23dbc1c21
+  metadata.gz: 6ba64d02837a0591aee2cab20c11795beffa59f3ec3dce2014ac7dd0b55e89e5
+  data.tar.gz: 1b452562fa4df0cf870eb0ed5bbbf0f686b4ba78579e47e7ce075e84e18b1954
 SHA512:
-  metadata.gz: cd28dc30f59e5bec1b272508d5b64ecb950a3e2b6d26d4318156069d19c338093177302ac09207a4b76b7decfa8272f84a8839f3165eeee28fdb9f15ae5c6ef3
-  data.tar.gz: '08f19a62a3d3c21cdf46c8120bd0b5846107a57409aba71939587affed4e7daf32c4d0bd805919d884baa4d24b520521527f62e8edf66ed6f886cf2237122b27'
+  metadata.gz: '02909a341866abc4eb1eaa844317dd02b72ed55c59b0df518f3e54af06a024f6cb4ac2ea8f14a2b64b99e60bdd9dc2bc87ceee421ed591c498db1f0e5c4305c4'
+  data.tar.gz: 562c4de6f8605b2ab7b414101642488a93b98fa94157ba4408ed640b6944f8cee33ecb3f710be87570760fd7d0fc6249c2b353163173f64ea53d52624b7b91fe

data/data/icfs.css

@@ -200,6 +200,12 @@ div.list-int {
 }
 
 
+div.list-int-sm {
+  width: 2em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
 div.list-perm {
   width: 15em;
   padding: 0 0.15em 0 0.15em;
@@ -238,7 +244,7 @@ div.list-text-m {
 
 
 div.list-time {
-  width: 12em;
+  width: 15em;
   padding: 0 0.15em 0 0.15em;
 }
 

data/data/icfs.js

@@ -167,6 +167,23 @@
 
 // Entry
 
+  ///////////////////////////////////////////////
+  // Enable/disable editing the entry
+  function entEnable(){
+    var ena = document.getElementById("ent-ena");
+    var bdy = document.getElementById("ent-body");
+
+    var enabled = ena.getAttribute("value");
+    if( enabled == "true" ){
+      ena.setAttribute("value", "false");
+      bdy.setAttribute("class", "ent-body hidden");
+    } else {
+      ena.setAttribute("value", "true");
+      bdy.setAttribute("class", "ent-body");
+    }
+  }
+
+
   ///////////////////////////////////////////////
   // Add an index
   function entAddIndex(){
@@ -376,25 +393,6 @@
 
 // Action
 
-  ///////////////////////////////////////////////
-  // Enable/disable editing the action
-  function actEnable(){
-    var but = document.getElementById("act-task-add");
-    var ena = document.getElementById("act-ena");
-    var tsk = document.getElementById("act-tasks");
-
-    var enabled = ena.getAttribute("value");
-    if( enabled == "true" ){
-      ena.setAttribute("value", "false");
-      tsk.setAttribute("class", "sect-right hidden");
-      but.setAttribute("class", "sect-right invisible");
-    } else {
-      ena.setAttribute("value", "true");
-      tsk.setAttribute("class", "sect-right");
-      but.setAttribute("class", "sect-right");
-    }
-  }
-
 
   ///////////////////////////////////////////////
   // Add a row to a task

data/devel/run/base.rb

@@ -61,7 +61,8 @@ def get_base
 
   # default config
   defaults = {
-    'tz' => '-04:00'
+    'tz' => '-04:00',
+    'rel_time' => true,
   }
 
   # base objects

data/devel/run/case-backup.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#
+# 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.
+
+# usage: <case-backup> <fs_store_dir> <caseid>
+
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative '../../lib/icfs/store_fs'
+require_relative '../../lib/icfs/utils/backup'
+
+base = get_base()
+backup = ICFS::Utils::Backup.new(base[:cache], base[:store], base[:log])
+dst = ICFS::StoreFs.new(ARGV[0])
+backup.copy(ARGV[1], dst)

data/devel/run/case-restore.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#
+# 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.
+
+# usage: <case-restore> <fs_store_dir> <caseid>
+
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative '../../lib/icfs/store_fs'
+require_relative '../../lib/utils/backup'
+
+base = get_base()
+backup = ICFS::Utils::Backup.new(base[:cache], base[:store], base[:log])
+src = ICFS::StoreFs.new(ARGV[0])
+backup.restore(ARGV[1], src)

data/devel/run/copy-s3.rb

@@ -10,6 +10,8 @@
 # This program is distributed WITHOUT ANY WARRANTY; without even the
 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
+# usage: ./copy-s3.rb <source_dir> <prefix>
+
 # frozen_string_literal: true
 
 require 'aws-sdk-s3'

data/devel/run/init-icfs.rb

@@ -18,17 +18,6 @@ require 'aws-sdk-s3'
 
 require_relative '../../lib/icfs'
 require_relative '../../lib/icfs/cache_elastic'
-require_relative '../../lib/icfs/store_s3'
-
-
-# Minio config
-Aws.config.update(
-  endpoint: 'http://minio:9000',
-  access_key_id: 'minio_key',
-  secret_access_key: 'minio_secret',
-  force_path_style: true,
-  region: 'us-east-1'
-)
 
 # default mapping
 map = {
@@ -42,10 +31,15 @@ map = {
 }.freeze
 
 # base items
-s3 = Aws::S3::Client.new
+s3 = Aws::S3::Client.new(
+  endpoint: 'http://minio:9000',
+  access_key_id: 'minio_key',
+  secret_access_key: 'minio_secret',
+  force_path_style: true,
+  region: 'us-east-1'
+)
 es = Faraday.new('http://elastic:9200')
 cache = ICFS::CacheElastic.new(map, es)
-store = ICFS::StoreS3.new(s3, 'icfs', 'case/')
 
 # create the indexes
 cache.create(ICFS::CacheElastic::Maps)
@@ -54,27 +48,3 @@ puts "Indexes created"
 # create a bucket
 s3.create_bucket(bucket: 'icfs')
 puts "S3 bucket created"
-
-api = ICFS::Api.new([], nil, cache, store)
-
-# add a template
-tmpl = {
-  'template' => true,
-  'status' => true,
-  'title' => 'Test template',
-  'access' => [
-    {
-      'perm' => '[manage]',
-      'grant' => [
-        'role2'
-      ]
-    }
-  ]
-}
-ent = {
-  'caseid' => 'test_tmpl',
-  'title' => 'Create template',
-  'content' => 'To test'
-}
-api.case_create(ent, tmpl, nil, 'user1')
-puts "Create template"

data/devel/run/init-template.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#
+# 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.
+
+# usage: ./init-template.sh <template.json> <user>
+
+# frozen_string_literal: true
+
+require_relative 'base'
+
+json = File.read(ARGV[0])
+tmpl = ICFS::Items.parse(json, 'Template', ICFS::Items::ItemCase)
+tmpl.delete('icfs')
+tmpl.delete('log')
+
+ent = {
+  'caseid' => tmpl['caseid'],
+  'title' => 'Create case',
+  'content' => 'Added case using manual script',
+}
+
+base = get_base()
+api = base[:api]
+
+api.case_create(ent, tmpl, nil, ARGV[1])

data/lib/icfs/api.rb

@@ -518,6 +518,7 @@ class Api
       after: Validate::IsIntPos,
       before: Validate::IsIntPos,
       user: Items::FieldUsergrp,
+      case_edit: Validate::IsBoolean,
       entry: Validate::IsIntPos,
       index: Validate::IsIntPos,
       action: Validate::IsIntPos,
@@ -908,6 +909,13 @@ class Api
     Items.validate(ent, 'entry', Items::ItemEntryNew)
     Items.validate(cse, 'case', Items::ItemCaseEdit)
 
+    # get caseid
+    cid = ent['caseid']
+    cid ||= cse['caseid']
+    unless cid
+      raise(Error::Values, 'No caseid provided')
+    end
+
     # access users/roles/groups are valid, unless manually specifying user
     unless unam
       cse["access"].each do |acc|
@@ -953,11 +961,11 @@ class Api
     # Prep
 
     # case
-    cid = ent['caseid']
     cse['icfs'] = 1
     cse['caseid'] = cid
     cse['log'] = 1
     cse['tags'] ||= [ ICFS::TagNone ]
+    cse['entry'] = 1
     citem = Items.generate(cse, 'case', Items::ItemCase)
 
     # entry
@@ -979,7 +987,10 @@ class Api
       'entry' => {
         'num' => 1,
        },
-       'case_hash' => ICFS.hash(citem),
+       'case' => {
+         'set' => true,
+         'hash' => ICFS.hash(citem),
+       },
     }
     log['files_hash'] = fhash if fhash
 
@@ -1040,7 +1051,7 @@ class Api
   ###############################################
   # Write items to a case
   #
-  # @param ent [Hash] Entry to record, required
+  # @param ent [Hash] Entry to record, optional
   # @param act [Hash, Nilclass] Action to record, optional
   # @param idx [Hash, Nilclass] Index to record, optional
   # @param cse [Hash, Nilclass] Case to record, optional
@@ -1051,22 +1062,36 @@ class Api
     # Sanity checks
 
     # form & content
-    if idx || cse
-      Items.validate(ent, 'New Entry', Items::ItemEntryNew)
-    else
-      Items.validate(ent, 'Editable Entry', Items::ItemEntryEdit)
+    if ent
+      if (act || idx || cse)
+        Items.validate(ent, 'New Entry', Items::ItemEntryNew)
+      else
+        Items.validate(ent, 'Editable Entry', Items::ItemEntryEdit)
+      end
     end
     Items.validate(act, 'action', Items::ItemActionEdit) if act
     Items.validate(idx, 'index', Items::ItemIndexEdit) if idx
     Items.validate(cse, 'case', Items::ItemCaseEdit) if cse
 
-    # edit index OR case, not both
-    if idx && cse
-      raise(Error::Value, 'May not edit both case and index at once')
+    # get caseid
+    cid ||= ent['caseid'] if ent
+    cid ||= cse['caseid'] if cse
+    cid ||= act['caseid'] if act
+    cid ||= idx['caseid'] if idx
+    unless cid
+      raise(Error::Values, 'No caseid provided')
+    end
+
+    # no conflicting caseids
+    if( (cse && cse['caseid'] && cse['caseid'] != cid) ||
+        (act && act['caseid'] && act['caseid'] != cid) ||
+        (idx && idx['caseid'] && idx['caseid'] != cid) )
+      raise(Error::Values, 'Conflicting caseids provided')
     end
 
     # no changing the action
-    if act && ent['action'] && act['action'] && act['action'] != ent['action']
+    if( act && ent && ent['action'] && act['action'] &&
+        act['action'] != ent['action'] )
       raise(Error::Conflict, 'May not change entry\'s action')
     end
 
@@ -1103,17 +1128,21 @@ class Api
 
     ####################
     # Prep
-    cid = ent['caseid']
 
     # entry
-    ent['icfs'] = 1
-    ent['tags'] ||= [ ]
-    ent['user'] = @user
-    files, fhash = _pre_files(ent)
+    if ent
+      ent['icfs'] = 1
+      ent['tags'] ||= [ ]
+      ent['user'] = @user
+      ent['caseid'] = cid
+      files, fhash = _pre_files(ent)
+    else
+      files = []
+    end
 
     # action
     if act
-      ent['tags'] << ICFS::TagAction
+      ent['tags'] << ICFS::TagAction if ent
       act['icfs'] = 1
       act['caseid'] = cid
       act['tasks'].each do |tk|
@@ -1123,7 +1152,7 @@ class Api
 
     # index
     if idx
-      ent['tags'] << ICFS::TagIndex
+      ent['tags'] << ICFS::TagIndex if ent
       idx['icfs'] = 1
       idx['caseid'] = cid
       idx['tags'] ||= [ ICFS::TagNone ]
@@ -1131,7 +1160,7 @@ class Api
 
     # case
     if cse
-      ent['tags'] << ICFS::TagCase
+      ent['tags'] << ICFS::TagCase if ent
       cse['icfs'] = 1
       cse['caseid'] = cid
       cse['tags'] ||= [ ICFS::TagNone ]
@@ -1146,7 +1175,7 @@ class Api
     log['files_hash'] = fhash if fhash
 
     # no tags
-    ent['tags'] = [ ICFS::TagNone ] if ent['tags'].empty?
+    ent['tags'] = [ ICFS::TagNone ] if ent && ent['tags'].empty?
 
     # current
     nxt = {
@@ -1171,14 +1200,18 @@ class Api
       cur = Items.parse(json, 'current', Items::ItemCurrent)
 
       # entry
-      if ent['entry']
-        enum = ent['entry']
-        json = @cache.entry_read(cid, enum)
-        ent_pri = Items.parse(json, 'entry', Items::ItemEntry)
-        nxt['entry'] = cur['entry']
+      if ent
+        if ent['entry']
+          enum = ent['entry']
+          json = @cache.entry_read(cid, enum)
+          ent_pri = Items.parse(json, 'entry', Items::ItemEntry)
+          nxt['entry'] = cur['entry']
+        else
+          enum = cur['entry'] + 1
+          nxt['entry'] = enum
+        end
       else
-        enum = cur['entry'] + 1
-        nxt['entry'] = enum
+        nxt['entry'] = cur['entry']
       end
 
       # action
@@ -1186,7 +1219,7 @@ class Api
         anum = ent_pri['action']
       elsif act && act['action']
         anum = act['action']
-      elsif ent['action']
+      elsif ent && ent['action']
         anum = ent['action']
       end
       if anum
@@ -1228,7 +1261,7 @@ class Api
       perms = Set.new
 
       # entry
-      perms.merge(ent['perms']) if ent['perms']
+      perms.merge(ent['perms']) if ent && ent['perms']
       if ent_pri
 
         # must have those perms
@@ -1326,7 +1359,7 @@ class Api
 
       # write unless a case or pre-existing action
       unless cse || act_pri
-        perms.add( ICFS::PermWrite)
+        perms.add( ICFS::PermWrite )
       end
 
       # permissions
@@ -1341,28 +1374,32 @@ class Api
       # Items
 
       # entry
-      ent['entry'] = enum
-      ent['log'] = lnum
-      ent['time'] ||= now
-      ent['action'] = anum if act
-      if idx
-        if ent['index']
-          ent['index'] = ent['index'].push(xnum).uniq.sort
-        else
-          ent['index'] = [ xnum ]
+      if ent
+        ent['entry'] = enum
+        ent['log'] = lnum
+        ent['time'] ||= now
+        ent['action'] = anum if act
+        if idx
+          if ent['index']
+            ent['index'] << xnum
+          else
+            ent['index'] = [ xnum ]
+          end
         end
+        ent['index'].sort!.uniq! if ent['index']
+        ent['files'].each{|fi| fi['log'] ||= lnum } if ent['files']
+        eitem = Items.generate(ent, 'entry', Items::ItemEntry)
+        log['entry'] = {
+          'num' => enum,
+          'hash' => ICFS.hash(eitem)
+        }
       end
-      ent['files'].each{|fi| fi['log'] ||= lnum } if ent['files']
-      eitem = Items.generate(ent, 'entry', Items::ItemEntry)
-      log['entry'] = {
-        'num' => enum,
-        'hash' => ICFS.hash(eitem)
-      }
 
       # action
       if act
         act['action'] = anum
         act['log'] = lnum
+        act['entry'] = enum if ent
         aitem = Items.generate(act, 'action', Items::ItemAction)
         log['action'] = {
           'num' => anum,
@@ -1374,6 +1411,7 @@ class Api
       if idx
         idx['index'] = xnum
         idx['log'] = lnum
+        idx['entry'] = enum if ent
         xitem = Items.generate(idx, 'index', Items::ItemIndex)
         log['index'] = {
           'num' => xnum,
@@ -1384,8 +1422,12 @@ class Api
       # case
       if cse
         cse['log'] = lnum
+        cse['entry'] = enum if ent
         citem = Items.generate(cse, 'case', Items::ItemCase)
-        log['case_hash'] = ICFS.hash(citem)
+        log['case'] = {
+          'set' => true,
+          'hash' => ICFS.hash(citem),
+        }
       end
 
       # log
@@ -1403,8 +1445,10 @@ class Api
       # Write
 
       # entry
-      @cache.entry_write(cid, enum, eitem)
-      @store.entry_write(cid, enum, lnum, eitem)
+      if ent
+        @cache.entry_write(cid, enum, eitem)
+        @store.entry_write(cid, enum, lnum, eitem)
+      end
 
       # action
       if act

data/lib/icfs/cache_elastic.rb

@@ -35,6 +35,7 @@ class CacheElastic < Cache
     "icfs": { "enabled": false },
     "caseid": { "type": "keyword" },
     "log": { "enabled": false },
+    "entry": { "enabled": false },
     "template": { "type": "boolean" },
     "status": { "type": "boolean" },
     "title": { "type": "text" },
@@ -66,7 +67,10 @@ class CacheElastic < Cache
       "num": { "type": "integer" },
       "hash": { "enabled": false }
     }},
-    "case_hash": { "enabled": false },
+    "case": { "properties": {
+      "set": { "type": "boolean" },
+      "hash": { "enabled": false }
+    }},
     "files_hash": { "enabled": false }
   }}}
 }',
@@ -104,6 +108,7 @@ class CacheElastic < Cache
     "caseid": { "type": "keyword" },
     "action": { "type": "integer" },
     "log": { "enabled": false },
+    "entry": { "enabled": false },
     "tasks": { "type": "nested","properties": {
       "assigned": { "type": "keyword" },
       "title": { "type": "text" },
@@ -121,6 +126,7 @@ class CacheElastic < Cache
     "caseid": { "type": "keyword" },
     "index": { "type": "integer" },
     "log": { "enabled": false },
+    "entry": { "enabled": false },
     "title": {
       "type": "text",
       "fields": { "raw": { "type": "keyword" }}
@@ -532,7 +538,7 @@ class CacheElastic < Cache
     tags: 'tags',
     perms: ['perms', :empty],
     action: ['action', :zero],
-    index: ['index', :size],
+    indexes: ['index', :size],
     files: ['files', :size],
     stats: ['stats', :size],
   }.freeze
@@ -792,6 +798,7 @@ class CacheElastic < Cache
     entry: ['entry', :sub, 'num'].freeze,
     index: ['index', :sub, 'num'].freeze,
     action: ['action', :sub, 'num'].freeze,
+    case: ['case', :sub, 'set'].freeze,
     files: ['files_hash', :size].freeze,
   }.freeze
 
@@ -806,6 +813,7 @@ class CacheElastic < Cache
       _query_term('caseid', query[:caseid]),
       _query_times('times', query[:after], query[:before]),
       _query_term('user', query[:user]),
+      _query_exists('case.set', query[:case_edit]),
       _query_term('entry.num', query[:entry]),
       _query_term('index.num', query[:index]),
       _query_term('action.num', query[:action]),

data/lib/icfs/config.rb

@@ -30,9 +30,10 @@ class Config
         method: :string,
         valid: /[+\-](0[0-9]|1[0-2]):[0-5][0-9]/.freeze,
         whitelist: true,
-      }
-    }
-  }
+      }.freeze,
+      'rel_time' => Validate::IsBoolean,      
+    }.freeze
+  }.freeze
 
   ###############################################
   # New instance