FileFerret design - Revision history

Woozle: /* Data Concepts */ notes for next version

2007-02-27T22:11:04Z

Data Concepts: notes for next version

← Older revision		Revision as of 22:11, 27 February 2007
Line 33:		Line 33:
	** '''isPrimary''': is Machine primarily responsible for maintaining the record of this Location (i.e. the mapped Folder and all files under it)?		** '''isPrimary''': is Machine primarily responsible for maintaining the record of this Location (i.e. the mapped Folder and all files under it)?
	*: '''Note''': Location x Machine must be unique		*: '''Note''': Location x Machine must be unique
			====Notes for Next Version====
			* Is there any real reason for Locations to have its own table? If the problem is just that we want to be able to choose from a shorter list than "all folders", wouldn't a flag be good enough? (Filtering on ID_Parent IS NULL wouldn't be sufficient in cases where a share is below the root-folder.)

Woozle: /* Data Concepts */ background & more clarification

2007-02-25T02:05:20Z

Data Concepts: background & more clarification

← Older revision		Revision as of 02:05, 25 February 2007
Line 2:		Line 2:
	==Overview==		==Overview==
	This page is for [[FileFerret]] design details, as I create them.		This page is for [[FileFerret]] design details, as I create them.
			===Background===
			FileFerret must know how to access a file from different machines. This complicates things a little bit. (It is necessary so that FileFerret can manage accessible files across all machines, not just machines with a FileFerret agent installed, thus maximizing its ability to track files with a minimum of deployment.)

			FileFerret also has the idea of an "elemental" file ("'''Filament'''"), which is an abstraction of a particular data pattern that may be contained by multiple '''File'''s on multiple machines (e.g. backup copies).

			A '''Filament''' can correspond to zero or more '''File'''s. A '''File''' is contained within a hierarchy of '''Folder'''s; at some point in the hierarchy of folders must be a '''Location''' which can be '''Map'''ped for each machine in order for that machine to be able to access it. The file/folder objects contain only relative path information; the mapping gives an absolute path for the top level of the hierarchy, to which the relative path is added to get the full local (i.e. machine-specific) filespec.

			From the user's point of view, this should all be hidden as much as possible by assuming the mappings available to the user's machine, but I haven't worked out a good conceptual system for handling this; so far the technique has been to provide a set of utility routines for translating between local filespecs, '''File'''s, and '''Filament'''s.
	===Data Concepts===		===Data Concepts===
	* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by:		* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by:
Line 17:		Line 25:
	*: There are currently two classes of machine, from a file-access point of view:		*: There are currently two classes of machine, from a file-access point of view:
	: "root level" machines can access the entire file structure (including local file structures) if they have the right user/password		: "root level" machines can access the entire file structure (including local file structures) if they have the right user/password
	: "~~Windows~~" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols)		: "share level" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols), typically due to limitations in the network protocols available for them to use.
	* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:		* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:
	** '''ID''': unique identifier for easy reference		** '''ID''': unique identifier for easy reference

Woozle: /* Data Concepts */ unique ID for Mappings

2007-01-01T14:17:43Z

Data Concepts: unique ID for Mappings

Woozle: /* Data Concepts */ Locations are one-to-one mapping with Folders

2007-01-01T14:01:44Z

Data Concepts: Locations are one-to-one mapping with Folders

Woozle: /* Concepts */ mappings.isPrimary

2006-12-31T21:23:46Z

Concepts: mappings.isPrimary

← Older revision		Revision as of 21:23, 31 December 2006
Line 2:		Line 2:
	==Overview==		==Overview==
	This page is for [[FileFerret]] design details, as I create them.		This page is for [[FileFerret]] design details, as I create them.
	===Concepts===		===Data Concepts===
	* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by:		* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by:
	** the ability to locate files in non-local and offline media		** the ability to locate files in non-local and offline media
Line 23:		Line 23:
	** '''ID_Machine''': which machine this location is being mapped for		** '''ID_Machine''': which machine this location is being mapped for
	** '''FileSpec''': how to access the location on the specified machine; includes "protocol://user@servername:password" where applicable		** '''FileSpec''': how to access the location on the specified machine; includes "protocol://user@servername:password" where applicable
			** '''isPrimary''': is Machine primarily responsible for maintaining the record of this Location (i.e. the mapped Folder and all files under it)?

Woozle: /* Concepts */ more definitions

2006-12-31T21:02:41Z

Concepts: more definitions

← Older revision		Revision as of 21:02, 31 December 2006
Line 9:		Line 9:
	** a description		** a description
	** one or more topics		** one or more topics
			* A '''Folder''' corresponds to the traditional operating system concept of a folder or directory, i.e. it is a named location which may contain zero or more files, and also has a number of OS-dependent attributes such as creation time, access permissions, etc. Any given folder may or may not be reachable by any particular machine; if a folder is reachable by a particular machine, however, it is assumed that all folders underneath it are also reachable by that machine (although a given folder's contents may be inaccessible due to security restrictions).
			* A '''Summit''' (table: Folders x Locations) is a record of the highest-level folder which is accessible to any particular class of machine. It consists of:
			** '''ID_Folder''': ID of Folder which is at the summit
			** '''ID_Location''' generalized location for accessing that folder, to be mapped for each machine-class
			*: Summits will be entirely human-maintained in early versions of FileFerret; later on it may be possible to have FileFerret detect known folders which have been moved to other filespecs
			*: Summits generally correspond to the root folders of storage media (including fixed disks) and folders shared over the network.
			*: There are currently two classes of machine, from a file-access point of view:
			: "root level" machines can access the entire file structure (including local file structures) if they have the right user/password
			: "Windows" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols)
			* A '''Location''' is mainly a place-holder for Summits and Location Mappings to refer to, though it includes descriptive fields for human convenience.
			* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:
			** '''ID_Location''': which location is being mapped
			** '''ID_Machine''': which machine this location is being mapped for
			** '''FileSpec''': how to access the location on the specified machine; includes "protocol://user@servername:password" where applicable

Woozle: /* Concepts */ revision & clarification

2006-12-28T14:11:33Z

Concepts: revision & clarification

← Older revision		Revision as of 14:11, 28 December 2006
Line 3:		Line 3:
	This page is for [[FileFerret]] design details, as I create them.		This page is for [[FileFerret]] design details, as I create them.
	===Concepts===		===Concepts===
	* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by the ability to locate files in non-local and offline media		* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by:
	* A '''Filament''' (portmanteau for "elemental file") corresponds to a particular ~~stream~~ of data values which in turn may correspond to zero or more actual '''file'''s (if more than one file corresponds to the same filament, then those files contain identical data, though they do not necessarily have the same filename, timestamps, security attributes, etc.). Any filament may also have the following attributes in FileFerret's database:		** the ability to locate files in non-local and offline media
			** the need for different machines to be able to locate the same file from the same information
			* A '''Filament''' (portmanteau for "elemental file") corresponds to a particular ordered set of data values which in turn may correspond to zero or more actual '''file'''s (if more than one file corresponds to the same filament, then those files contain identical data, though they do not necessarily have the same filename, timestamps, security attributes, etc.). Any filament may also have the following attributes in FileFerret's database:
	** a description		** a description
	** one or more topics		** one or more topics

Woozle: /* Concepts */ rewritings

2006-12-27T23:45:17Z

Concepts: rewritings

← Older revision		Revision as of 23:45, 27 December 2006
Line 3:		Line 3:
	This page is for [[FileFerret]] design details, as I create them.		This page is for [[FileFerret]] design details, as I create them.
	===Concepts===		===Concepts===
	* '''~~Files~~''' ~~are~~ files ~~stored~~ in ~~a particular location~~		* A '''File''' corresponds to the traditional operating system concept of a file, extended somewhat by the ability to locate files in non-local and offline media
	* '''~~Filaments~~''' ~~are files~~ of which the database ~~has particular knowledge~~:		* A '''Filament''' (portmanteau for "elemental file") corresponds to a particular stream of data values which in turn may correspond to zero or more actual '''file'''s (if more than one file corresponds to the same filament, then those files contain identical data, though they do not necessarily have the same filename, timestamps, security attributes, etc.). Any filament may also have the following attributes in FileFerret's database:
	** a description		** a description
	** one or more topics		** one or more topics

Woozle: /* Concepts */ fileoids -> filaments

2006-02-19T02:22:46Z

Concepts: fileoids -> filaments

← Older revision		Revision as of 02:22, 19 February 2006
Line 4:		Line 4:
	===Concepts===		===Concepts===
	* '''Files''' are files stored in a particular location		* '''Files''' are files stored in a particular location
	* '''~~Fileoids~~''' are files of which the database has particular knowledge ~~& ndash; either~~:		* '''Filaments''' are files of which the database has particular knowledge:
	** a description		** a description
	** one or more topics		** one or more topics

Woozle at 18:34, 16 February 2006

2006-02-16T18:34:38Z

New page

[[Woozle]]: [[Woozle's Projects|Projects]]: [[FileFerret]]: [[FileFerret design|design]]
==Overview==
This page is for [[FileFerret]] design details, as I create them.
===Concepts===
* '''Files''' are files stored in a particular location
* '''Fileoids''' are files of which the database has particular knowledge & ndash; either:
** a description
** one or more topics

← Older revision		Revision as of 14:17, 1 January 2007
Line 11:		Line 11:
	* A '''Folder''' corresponds to the traditional operating system concept of a folder or directory, i.e. it is a named location which may contain zero or more files, and also has a number of OS-dependent attributes such as creation time, access permissions, etc. Any given folder may or may not be reachable by any particular machine; if a folder is reachable by a particular machine, however, it is assumed that all folders underneath it are also reachable by that machine (although a given folder's contents may be inaccessible due to security restrictions).		* A '''Folder''' corresponds to the traditional operating system concept of a folder or directory, i.e. it is a named location which may contain zero or more files, and also has a number of OS-dependent attributes such as creation time, access permissions, etc. Any given folder may or may not be reachable by any particular machine; if a folder is reachable by a particular machine, however, it is assumed that all folders underneath it are also reachable by that machine (although a given folder's contents may be inaccessible due to security restrictions).
	* A '''Location''' is a record of the highest-level folders which are accessible to any particular class of machine. It consists of:		* A '''Location''' is a record of the highest-level folders which are accessible to any particular class of machine. It consists of:
	** '''ID''' unique ID, to ~~be mapped (~~by ~~a Mapping) for each machine-class~~		** '''ID''' unique identifier, referred to by Mappings
	** '''ID_Folder''': ID of highest-level Folder which is being pinned down		** '''ID_Folder''': ID of highest-level Folder which is being pinned down
	*: Locations will be entirely human-maintained in early versions of FileFerret; later on it may be possible to have FileFerret detect known folders which have been moved to other filespecs		*: Locations will be entirely human-maintained in early versions of FileFerret; later on it may be possible to have FileFerret detect known folders which have been moved to other filespecs
Line 19:		Line 19:
	: "Windows" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols)		: "Windows" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols)
	* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:		* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:
			** '''ID''': unique identifier for easy reference
	** '''ID_Location''': which location is being mapped		** '''ID_Location''': which location is being mapped
	** '''ID_Machine''': which machine this location is being mapped for		** '''ID_Machine''': which machine this location is being mapped for
	** '''FileSpec''': how to access the location on the specified machine; includes "protocol://user@servername:password" where applicable		** '''FileSpec''': how to access the location on the specified machine; includes "protocol://user@servername:password" where applicable
	** '''isPrimary''': is Machine primarily responsible for maintaining the record of this Location (i.e. the mapped Folder and all files under it)?		** '''isPrimary''': is Machine primarily responsible for maintaining the record of this Location (i.e. the mapped Folder and all files under it)?
			*: '''Note''': Location x Machine must be unique

← Older revision		Revision as of 14:01, 1 January 2007
Line 10:		Line 10:
	** one or more topics		** one or more topics
	* A '''Folder''' corresponds to the traditional operating system concept of a folder or directory, i.e. it is a named location which may contain zero or more files, and also has a number of OS-dependent attributes such as creation time, access permissions, etc. Any given folder may or may not be reachable by any particular machine; if a folder is reachable by a particular machine, however, it is assumed that all folders underneath it are also reachable by that machine (although a given folder's contents may be inaccessible due to security restrictions).		* A '''Folder''' corresponds to the traditional operating system concept of a folder or directory, i.e. it is a named location which may contain zero or more files, and also has a number of OS-dependent attributes such as creation time, access permissions, etc. Any given folder may or may not be reachable by any particular machine; if a folder is reachable by a particular machine, however, it is assumed that all folders underneath it are also reachable by that machine (although a given folder's contents may be inaccessible due to security restrictions).
	* A '''~~Summit~~''' ~~(table: Folders x Locations)~~ is a record of the highest-level ~~folder~~ which is accessible to any particular class of machine. It consists of:		* A '''Location''' is a record of the highest-level folders which are accessible to any particular class of machine. It consists of:
	** '''~~ID_Folder~~''': ID ~~of Folder which is at the summit~~		** '''ID''' unique ID, to be mapped (by a Mapping) for each machine-class
	** '''~~ID_Location~~''' ~~generalized location for accessing that folder, to be mapped for each machine~~-~~class~~		** '''ID_Folder''': ID of highest-level Folder which is being pinned down
	*: ~~Summits~~ will be entirely human-maintained in early versions of FileFerret; later on it may be possible to have FileFerret detect known folders which have been moved to other filespecs		*: Locations will be entirely human-maintained in early versions of FileFerret; later on it may be possible to have FileFerret detect known folders which have been moved to other filespecs
	*: ~~Summits~~ generally correspond to the root folders of storage media (including fixed disks) and folders shared over the network.		*: Locations generally correspond to the root folders of storage media (including fixed disks) and folders shared over the network.
	*: There are currently two classes of machine, from a file-access point of view:		*: There are currently two classes of machine, from a file-access point of view:
	: "root level" machines can access the entire file structure (including local file structures) if they have the right user/password		: "root level" machines can access the entire file structure (including local file structures) if they have the right user/password
	: "Windows" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols)		: "Windows" machines can only access explicitly shared folders (via Samba or other network file-sharing protocols)
	* A '''Location''' is mainly a place-holder for Summits and Location Mappings to refer to, though it includes descriptive fields for human convenience.
	* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:		* A '''Mapping''' represents to a particular machine's view of a Location, i.e. how to access it. Mappings generally correspond to storage media reading devices (including fixed disks) and network shares. Each mapping consists of:
	** '''ID_Location''': which location is being mapped		** '''ID_Location''': which location is being mapped