Skip to content

Commit

Permalink
first pass on notes
Browse files Browse the repository at this point in the history
  • Loading branch information
zvr committed Mar 22, 2017
0 parents commit 3ec9892
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 0 deletions.
18 changes: 18 additions & 0 deletions Notes/commands
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Commands
--------

The exact set of commands will be determined later.

However, the following should give a reasonable first approach.

The commands can be implemented as subcommands,
like in git.

h|help provide help
v|version display the software version
l|list list all scans in a database
st|stats display statistics about the DB contents
sc|scan scan a location and add to the database
qs|quickscan quick-scan a location (ignore hashes) and add to the DB
f|find|s|search: search for a file, according to criteria

24 changes: 24 additions & 0 deletions Notes/data
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Data
----

The following data should be stored for each file:
- name
- size
- full path (relative to scan point)
- a number of hashes (md5, sha-1, xxh32, xxh64, git-sha, ssdeep, sdhash, ...)
- basename
- extension
- dirname

Less useful data that can also be stored:
- permissions
- dates (creation, modification, access)

Each database should also keep track
of all the commands (scans) that were used
to add content.

The data model should be extensible
(for example, more hashes may be added in later versions),
so the data storage should take this parameter into account.

14 changes: 14 additions & 0 deletions Notes/storage
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Storage
-------

All the information is stored into an SQL database.

Individual SQLite files seem to be
the perfect point between functionality and complexity,
allowing all operations on data
and easy transfer between systems.

All the command-line utilities should accept
a "-d|--database <arg>" to specify the location
of this file.

5 changes: 5 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
fileDB -- utilities for handling file metadata

In the direcotry "Notes", a number of text files contain
design notes describing the problem domain.

0 comments on commit 3ec9892

Please sign in to comment.