Du kan inte välja fler än 25 ämnen
Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
index.md 115KB
index.md 115KB
title: Designing better file organization around tags, not hierarchies
url: https://www.nayuki.io/page/designing-better-file-organization-around-tags-not-hierarchies
hash_url: 2fc0d9333d
Introduction
Computer users organize their files into folders because that is the primary tool offered by operating systems. But applying this standard hierarchical model to my own files, I began to notice shortcomings of this paradigm over the years. At the same time, I used some other information systems not based on hierarchical path names, and they turned out to solve a number of problems. I propose a new way of organizing files based on tagging, and describe the features and consequences of this method in detail.
Speaking personally, I’m fed up with HFSes, on Windows, Linux, and online storage alike. I struggled with file organization for just over a decade before finally writing this article to describe problems and solutions. Life would be easier if I could tolerate the limitations of hierarchical organization, or at least if the new proposal can fit on top of existing HFSes. But fundamentally, there is a mismatch between the narrowness of hierarchies and the rich structure of human knowledge, and the proposed system will not presuppose the features of HFSes. I wish to solicit public feedback on these ideas, and end up with a design plan that I can implement to solve the problems I already have today.
This article is more of a brainstorm than a prescriptive formula. I begin by illustrating how hierarchies fall short on real-life problems, and how existing alternative systems like Git and Danbooru bypass HFS problems to deliver a better user experience. Then I describe a step-by-step model, starting from basic primitives, of a proposed file organization system that includes a number of desirable features by design. Finally, I present some open questions on aspects of the proposal where I’m unsure of the right answer.
I welcome any feedback about anything written here, especially regarding errors, omissions, and alternatives. For example, I might have missed helpful features of traditional HFSes. I know I haven’t read about or tested every alternative file system out there. I know that my proposed file organization scheme might have issues with conceptual and computational complexity, be too general or not expressive enough, or fail to offer a useful feature. And certainly, I don’t know all the ramifications of the proposed system if it gets implemented, on aspects ranging from security to sharing to networks. But I try my best to present tangible ideas as a start toward designing a better system. And ultimately, I want to implement such a proposed file system so that I can store and find my data sanely.
In the arguments presented below, I care most about the data model and less about implementation details. For example in HFSes, I focus on the fact that the file system consists of a tree of labeled edges with file content at the leaves; I ignore details about inodes, journaling, defragmentation, permissions, etc. For example in my proposal, I care about what data each file should store and what each field means; I assert that querying over all files in the file system is possible but don’t go into detail about how to do it efficiently. Also, the term “file system” can mean many things – it could be just a model of what data is stored (e.g. directories and files), or an abstract API of possible commands (e.g. mkdir(), walk(), open(), etc.), or it could refer to a full-blown implementation like NTFS with all its idiosyncratic features and characteristics. When I critique hierarchical file systems, I am mostly commenting at the data model level – regardless of the implementation flavor (ext4, HFS+, etc.). When I propose a new way of organizing files, I am mainly designing the data model, and leaving the implementation details for later work.
Contents
The most important sections are denoted in bold. The other sections provide additional context for interested readers.
<li><a href="#introduction">Introduction</a></li>
<li><a href="#hierarchical-file-systems-are-useful">Hierarchical file systems are useful</a>
<ul>
<li><a href="#physical-storage-analogy">Physical storage analogy</a></li>
<li><a href="#ubiquitous-availability">Ubiquitous availability</a></li>
<li><a href="#reducing-repetition">Reducing repetition</a></li>
<li><a href="#filtering-out-items">Filtering out items</a></li>
<li><a href="#naturally-hierarchical-phenomena">Naturally hierarchical phenomena</a></li>
<li><a href="#simple-implementation">Simple implementation</a></li>
</ul>
</li>
<li class="emphasized"><a href="#hierarchical-organization-is-clumsy">Hierarchical organization is clumsy</a>
<ul>
<li><a href="#forced-unique-names">Forced unique names</a></li>
<li><a href="#one-and-only-one-classification">One and only one classification</a></li>
<li><a href="#focusing-on-path-not-content">Focusing on path, not content</a></li>
<li><a href="#hard-and-soft-links-as-non-solutions">Hard and soft links as non-solutions</a></li>
<li><a href="#mutability-as-a-liability">Mutability as a liability</a></li>
<li><a href="#difficult-backups-and-caches">Difficult backups and caches</a></li>
<li><a href="#sharding-large-folders">Sharding large folders</a></li>
<li><a href="#overly-rich-file-semantics">Overly rich file semantics</a></li>
</ul>
</li>
<li><a href="#alternative-systems-as-inspirational-examples">Alternative systems as inspirational examples</a>
<ul>
<li><a href="#git-version-control">Git version control</a></li>
<li><a href="#danbooru-style-image-boards">Danbooru-style image boards</a></li>
<li><a href="#relational-database-model">Relational database model</a></li>
<li><a href="#music-libraries">Music libraries</a></li>
<li><a href="#interplanetary-file-system-ipfs">InterPlanetary File System (IPFS)</a></li>
<li><a href="#tuple-spaces">Tuple spaces</a></li>
<li><a href="#related-articles">Related articles</a></li>
<li><a href="#related-software">Related software</a></li>
</ul>
</li>
<li class="emphasized"><a href="#designing-a-tag-based-file-system">Designing a tag-based file system</a>
<ul>
<li><a href="#immutable-file-objects-with-hash-identities">Immutable file objects with hash identities</a></li>
<li><a href="#simple-string-tags">Simple string tags</a></li>
<li><a href="#complex-indirect-tags">Complex indirect tags</a></li>
<li><a href="#internal-vs-external-metadata">Internal vs. external metadata</a></li>
<li><a href="#tag-all-the-things">Tag all the things</a></li>
<li><a href="#everything-is-a-file">Everything is a file</a></li>
<li><a href="#data-schemas">Data schemas</a></li>
<li><a href="#storage-pools-for-reading">Storage pools for reading</a></li>
<li><a href="#storage-icons-for-status-writing">Storage icons for status/writing</a></li>
<li><a href="#containers-bundles">Containers/bundles</a></li>
<li><a href="#cyclic-references">Cyclic references</a></li>
<li><a href="#externalized-relational-database">Externalized relational database</a></li>
</ul>
</li>
<li><a href="#open-questions">Open questions</a>
<ul>
<li><a href="#choice-of-hash-function">Choice of hash function</a></li>
<li><a href="#hash-string-representation">Hash string representation</a></li>
<li><a href="#schema-verification">Schema verification</a></li>
<li><a href="#containers-as-first-class-files">Containers as first-class files</a></li>
<li><a href="#legacy-hierarchies">Legacy hierarchies</a></li>
<li><a href="#mutable-files">Mutable files</a></li>
<li><a href="#selecting-metadata">Selecting metadata</a></li>
<li><a href="#query-language">Query language</a></li>
<li><a href="#user-interfaces">User interfaces</a></li>
<li><a href="#tag-implications">Tag implications</a></li>
<li><a href="#version-control">Version control</a></li>
</ul>
</li>
Hierarchical file systems are useful
Hierarchies are popular because they serve a useful purpose. They do organize files to a certain extent, and are better than having nothing at all. (Older computer systems simply had a flat file system where every file is stored in the root directory of a drive.)
<dt id="physical-storage-analogy">Physical storage analogy</dt>
<dd>
<p><abbr title="hierarchical file systems">HFSes</abbr> imitate how information is stored in the physical world. If you have a set of papers, you’d put them into a labeled folder, folders into a filing cabinet, cabinets into aisles, aisles into rooms, rooms into buildings, and so forth. Each piece of paper is stored in only one place, which can be described by a unique address. The content on a sheet of paper can be updated and the page can be stored back in the same place.</p>
</dd>
<dt id="ubiquitous-availability">Ubiquitous availability</dt>
<dd>
<p>HFSes are already available on every major computing platform – Unix (ext, XFS, ZFS, etc.), Windows (FAT, NTFS, ReFS), macOS (HFS+), Android, and web services (Dropbox, OneDrive, etc.). As a user or a developer, if you need hierarchical file organization, you will almost certainly get it.</p>
</dd>
<dt id="reducing-repetition">Reducing repetition</dt>
<dd>
<p>Instead of labeling each relevant file with a particular aspect, you group the files together and put them all in one folder named with the aspect. For example instead of writing “Bicycle” within each file name among a set of photos, you can put those files into a folder named “Bicycle” and not need to touch the individual file names.</p>
</dd>
<dt id="filtering-out-items">Filtering out items</dt>
<dd>
<p>Browsing a hierarchy is powerful because it inherently filters out unwanted information and brings wanted information to the forefront. For example when you open a folder called “Tax Documents”, you will not see the party photos which are stored elsewhere.</p>
</dd>
<dt id="naturally-hierarchical-phenomena">Naturally hierarchical phenomena</dt>
<dd>
<p>Some natural concepts have a nested structure and are already labeled in a hierarchical way. Geographic locations are hierarchical – a city belongs to a state which belongs to a country which belongs to a continent. For example if you want to organize a set of travel photos, you can make a folder for each country, a subfolder for each city, and so on. Each photo belongs to only one place, never two countries or two cities at once. Divisions of time are hierarchical. You can create a folder for each year, and put each document in one year folder. Or you can go finer and create a subfolder for each month, et cetera.</p>
</dd>
<dt id="simple-implementation">Simple implementation</dt>
<dd>
<p>Hierarchical file systems are relatively easy for an operating system designer to implement, compared to fancy relational databases or such. At their core, HFSes involve rooted trees (or directed acyclic graphs), node pointers, edge labels (directory entry names), and file blobs. Writing user-level applications that operate in a hierarchical file system is quite manageable too. A simple program might just work on single files, or list a directory non-recursively. Even in the full case of walking over files and directories recursively, the data model is simple and easy to work with.</p>
<p>Another benefit is that data retrieval can be fast in practice even when directories are stored on disk naively as unsorted lists (without applying advanced data structures like B-trees). This is because users are naturally inclined to keep the number of items in a directory at a manageable number – if a user sees a directory with a thousand items, she will likely create a few subfolders and put a few hundred items into each. This benefit of fast linear searching does not apply to flat file systems, where a root directory might have tens of thousands of files (thus B-trees must be used, but flat file systems are obsolete anyway).</p>
</dd>
Hierarchical organization is clumsy
With the benefits of hierarchical file systems out of the way, let’s discuss how they seriously fall short in helping us organize files – or more broadly speaking, how they represent and retrieve knowledge. A tricky aspect about the upcoming arguments is that HFSes appear to behave okay at the small scale (say 100 to 1000 files), but they become increasingly painful to use at the large scale (say 100 000 files).
<dt id="forced-unique-names">Forced unique names</dt>
<dd>
<p>Every file within a folder must have a unique name. (Or phrased more formally: For each directory in the file system, each item in that directory has a name different from all other items in that directory.) This seems like a reasonable design on the surface – after all, you need some way to identify and access each file – but its implications are troubling.</p>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/cat-pictures-file-names.png"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/cat-pictures-file-names.png" alt="" style="width:20em"/></a>
</div>
<p>Example: You browse the web and download a bunch of cat pictures one by one. You just want to name every file “Cat.jpg” because it’s the best description you can think of without spending extra mental effort. But saving them into the same folder, each file needs a unique name. So you might decide to append a number to them, like “Cat-0.jpg”, “Cat-1.jpg”, “Cat-2.jpg”, etc. – fine. Or you might start to describe each one in more detail, like “Cat-in-hat.jpg”, “Cat-sleeping.jpg”, “Cat-chase.jpg”. But eventually you will see a picture that deserves the same description, so you’ll still end up with numbered names like “Cat-in-hat-2.jpg”, etc. Either way, once you start numbering files, you need to check the highest existing number every time you save a file. This procedure increases mental burden without actually improving the information being stored – it merely works around the unique name requirement imposed by the system.</p>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/parallel-photoshoot.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/parallel-photoshoot.svg" alt="" style="width:12em"/></a>
</div>
<p>Example: You do a photoshoot and capture a series of images, say “Fred-01.jpg”, “Fred-02.jpg”, ..., “Fred-30.jpg”. You delete some outtakes, leaving holes in the sequential file numbering. If you publish this subset of photos as is, the consumer might wonder why there are gaps in the numbering, and get unintended insight into how many raws were shot. But it gets worse – your coworker Mary was shooting alongside you, and offers you her collection of photos of the same subject. In a stroke of bad luck (or great minds thinking alike?), she also named her photos “Fred-01.jpg”, “Fred-02.jpg”, ..., “Fred-19.jpg”. You want the benefit of being able to use her files, but now you are left with a dilemma on how to organize them. You can either put her files in a separate folder so that you end up with “Me/Fred-01.jpg” vs. “Mary/Fred-01.jpg”, or you can re-number her files to integrate them into your collection (e.g. add 30 to Mary’s numbers), or you can add a prefix to her files (e.g. “Mary-Fred-01.jpg”) and put them into your folder. The first option of keeping collections in separate folders is the easiest to do but makes retrieval awkward; the second and third are awkward due to poor tools for renaming files, and have a high potential for human error (misnaming, accidentally deleting, or overwriting files). In all cases, you have to take extraneous actions to merge two collections together or retrieve files from a merged collection. These extra steps stem from the hierarchical filing paradigm, not from the idea of merging data.</p>
<p>The requirement of unique file names is motivated by the need to make file paths meaningful. An absolute path starting from the file system root, like “/abc/def/ghi.png”, should be traversed in only one way and lead to one (or zero) files. If any component of the path is ambiguous – say there are two items named “abc” in the root directory – then the result could be a set of one or more files. Applications programs are just not designed to deal with this situation; it is a fundamental design assumption in HFSes that each path represents either zero or one file, and this behavior can’t be changed without breaking millions of existing programs. Having unique, meaningful, practical paths is a laudable goal. But asking end users to directly create unique file names and manage such a collection over time seems to cause continual low-level pain.</p>
<p>Any file organization system that allows random access to files must have a set of unique names (whether meaningful text or random garbage) in some form or another. One solution implemented in various software systems is to let the computer generate unique file names. For example when you upload a file to 4chan (image board web site), the server saves it with the name set to the current Unix millisecond timestamp (e.g. 1487783267847.gif). Unfortunately this simple-sounding scheme requires a great deal of care to implement correctly. The server could be unlucky and process two requests in the same millisecond, so it would need to keep track of the last issued timestamp and use a new number that is strictly greater. If the site continually handles more than 1000 uploads per second, then the naming scheme must be changed. If the server is part of a cluster, then they need to communicate with each other to avoid reusing file names already issued by other servers. A much more reliable alternative is to name each file by the hash of its byte-level content, for example the SHA-256 hash value of 87529003<wbr/>f42c1f04<wbr/>39b0c760<wbr/>ebfe5e6d<wbr/>ff1b436c<wbr/>3c9b4f8b<wbr/>41ad9b1f<wbr/>e6dc6795 (64 digits). Hashes are long and ugly, but have a couple of useful properties in this situation. The same file content always produces the same hash (unlike the timestamping scheme), so exact duplicates are easily detected. No communication or coordination is needed among a cluster of servers, because probability theory ensures that these random-looking names are extremely unlikely to collide.</p>
<p>Hence it may not be desirable or necessary to let the end user choose and manage unique file names. As we’ll see later, it might be a good idea to design a system where each file name is an auto-generated hash, but where files can be named, categorized, and queried using higher-level metadata systems.</p>
</dd>
<dt id="one-and-only-one-classification">One and only one classification</dt>
<dd>
<p>File names and paths in a hierarchical file system serve double duty: they tell the machine how to reach a file to in order to retrieve it, and they show the human how the file is classified. This conflated design seems reasonable at first, but hinders efforts to classify a file in more flexible ways.</p>
<p>Example: You have a folder named “School” for all the documents and files related to school activities. You have a folder named “Photos” where you store thousands of pics taken over years. Now you take a couple of photos of activities in volleyball club. Where should you store these photos? They could go under “School”, “School/<wbr/>Photos”, or “School/<wbr/>Volleyball-club/<wbr/>Photos”, but you could also argue that you want to be able to find the photos in your general life stream, so they could be filed under “Photos” or “Photos/<wbr/>Volleyball-club”. If you store the photos somewhere under the “School” folder, then your general photo album will be incomplete. Worse, if you wanted to recall a particular photo but forgot that it was stored in the “School” folder, then you are out of luck when browsing the “Photos” folder. You could copy the files and store them in both locations, but that wastes space and could lead to future problems when you need to rename or reclassify things.</p>
<p>Example: Your primary music collection has a few hundred albums in lossless quality FLAC. You decided to re-encode all the audio files to the much smaller 128 Kb/s MP3 format as a new parallel collection, because you want to store music on small flash cards or stream them over the Internet. But now you face an organization problem: Do you store the MP3 files alongside the FLACs, or do you store them in a separate hierarchy? Namely, would you make a folder structure like “My-music/<wbr/>Album-name/<wbr/>MP3/<wbr/>Track-01.mp3” or “My-music/<wbr/>MP3/<wbr/>Album-name/<wbr/>Track-01.mp3”? There are good reasons to argue both ways. If the album name is nearer to the root of the hierarchy, you can see all the audio files pertaining to a particular album. But maybe on the computer you only care about the FLAC files, and the MP3 files are a distraction so you ignore them most of the time. With the separate top-level folder for MP3s, it is easy to ignore all the FLAC files or ignore all the MP3 files once you go into the appropriate folder. But then it becomes hard to keep your albums in sync – how do you check that every FLAC album has been encoded to MP3? And if you deleted a FLAC album, how do you know that you need to go and delete the MP3 album to match? This example only involves two attributes. It only gets worse as you add more classification axes – like grouping albums together by artist, or sorting music by year of release. You will agonize over whether the correct hierarchical classification is “My-music/<wbr/>Artist/<wbr/>Year/<wbr/>Album/<wbr/>Format” or “My-music/<wbr/>Format/<wbr/>Year/<wbr/>Artist/<wbr/>Album” or “My-music/<wbr/>Year/<wbr/>Artist/<wbr/>Album/<wbr/>Format” or the numerous other permutations, when in fact all of them have equal claim in being a correct classification.</p>
</dd>
<dt id="focusing-on-path-not-content">Focusing on path, not content</dt>
<dd>
<p>In hierarchical file systems, the path to a file tells us how to retrieve it, not what is inside the file. For example, “/home/<wbr/>john/<wbr/>diary.txt” tells the computer to start from the root, go into the directory named “home”, go into the subdirectory named “john”, and follow the link named “diary.txt” to access the file. It doesn’t necessarily tell us anything about what the file contains – for all we know, it could be an actual diary or a downloaded movie. To make matters worse, the meaning of the path is relative to which computer system we’re working on. The same path “/home/<wbr/>john/<wbr/>diary.txt” might exist on a distant server, but possess completely different file content.</p>
<p>It turns out that the notions of storage location and arbitrary content are not inherent properties of file identifier strings. We can, and have designed systems where the file name reflects what the file actually contains, and moreover such file names are globally unique (thus location is unimportant). The best example comes from Git version control: Given a 40-hex-digit object hash like d5a20366<wbr/>d5d5d0fc<wbr/>5ae4350c<wbr/>fd65ba7c<wbr/>d599b6bc, there is at most one (practically computable) sequence of bytes that produces this hash; when you receive the full file you can check it against the hash. Furthermore, the global uniqueness means that it is redundant to talk about “my variation on the file d5a2...b6bc” or “your hosted copy of d5a2...b6bc”; the hash name has one meaning everywhere. Therefore regardless of whether you received a copy of the file d5a2...b6bc from GitHub or from Bitbucket, from Bob’s project or from Carol’s project, it is always identical. In Git, the name of a file describes what it contains, not where to find it. (Slight caveat: This article was written just a week before the first SHA-1 collision was publicly announced.)</p>
</dd>
<dt id="hard-and-soft-links-as-non-solutions">Hard and soft links as non-solutions</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/soft-link.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/soft-link.svg" alt="" style="width:20em"/></a>
</div>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/hard-links.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/hard-links.svg" alt="" style="width:20em"/></a>
</div>
<p>When people realize they need to classify a file in more than one way, they will start to use shortcuts/links to try to solve the problem. (Windows has shortcuts, Unix has soft/symbolic links, and Mac has aliases. This is a ubiquitous feature, but transferring shortcuts across existing platforms is very hard.) This sounds like a reasonable solution, but will face trouble in all but the simplest use cases.</p>
<p>Example: Going back to the school photo scenario, you might decide to store the actual files in “Photos”, and create a set of shortcuts in “School/<wbr/>Photos”. Fine for the time being.</p>
<p>Example: Going back to the music classification scenario, you might decide that you like multiple ways of classifying your music. So you set up three separate hierarchies, like “My-music/<wbr/>Artist/<wbr/>Year/<wbr/>Album/<wbr/>Format” and “My-music/<wbr/>Format/<wbr/>Year/<wbr/>Artist/<wbr/>Album” and “My-music/<wbr/>Year/<wbr/>Artist/<wbr/>Album/<wbr/>Format”. You begin by filing each music file into one of these hierarchy schemes, and then create hard links in the other two hierarchies. In this case, there is no distinction between the primary copy and aliases; all three hierarchies have first-class hard links to the underlying files. (<a href="https://unix.stackexchange.com/questions/340676/use-cases-for-hardlinks/340710#340710">This Unix & Linux Stack Exchange answer</a> describes this scheme.)</p>
<p>Now to discuss the problems. Hard links only work within a single file system, so you can’t link between files stored on two separate non-RAIDed hard drives – but in exchange, hard links never have problems when some of the links are renamed or moved. Working with hard links requires a great deal of care – when copying or backing up an entire directory tree, you want to preserve the hard link structure to avoid duplication and to keep the behavior when shared files are edited; when reclassifying files you need to pay special attention not to delete the last hard link to a file. Soft links have a nearly opposite set of problems as hard links – soft links can span different file systems, but they generally don’t track the target files getting moved or renamed (except that Windows provides such a system service, but may not be reliable); while hard links are all indistinguishable, some application software behaves differently on soft links than on real hard-linked files. In spite of these problems, hard and soft links still require an exponential amount of effort to classify a set of files in multiple ways, and require the user to manually remember all the possible paths that a file can be reached from (important when editing and removing files, not important when browsing/<wbr/>retrieving files). They are non-scalable kludges compared to true tagging.</p>
</dd>
<dt id="mutability-as-a-liability">Mutability as a liability</dt>
<dd>
<p>By default, all files in a hierarchical file system are mutable (a.k.a. editable, writable). This makes a lot of sense because some notion of file system mutability is required to get any work done at all. Also, because the paths pointing to a file stay the same even after it is edited, there is no ambiguity about what it means to edit a file. These factors together allow a usable file system to be implemented with low complexity.</p>
<p>Again, while mutability seems reasonable on the surface, it creates problems at the large scale. The freedom to modify any file hurts when files need to be compared, backed up, shared, synchronized, or referenced. The basic problem is that when given two file paths, say “/path/to/a.txt” and “/path/to/b.txt” (or more generally paths to two trees), the only way to reliably determine whether they have identical content is to read both files fully and compare every byte (unless the file system caches the full content hashes, which I think no file system does). So if two different people email you a document named “Project Proposal.doc”, you cannot tell at a glance whether they are the same or different just by looking at their names. If you have a collection of work files on your desktop, which you transfer to your laptop, then you edited a few files on your laptop, you cannot easily tell which files have been edited.</p>
<p>Sometimes you want to archive a set of files and be very careful to never edit or delete them. For example you might consider all the photos you shot to be an append-only collection, and you might choose to preserve some draft stages of a document you’re editing. HFSes have a partial solution to this problem, which is to disable writing for a file (Unix style) or set the read-only flag for the file (Windows style). But it is still easy to accidentally disturb the supposedly archival files. If a folder contains archival and non-archival files at the same time (such as live documents alongside draft snapshots), then you might forget this fact and accidentally move or delete the directory in such a way that violates your intent.</p>
<p>Having file paths that refer to mutable blobs of data isn’t the only way to design a file system. An alternative idea is to force the name to change every time a file’s content changes. Hashing is one mechanism that satisfies this property. (Generating a new random name every time a file is edited is also possible, but it has fewer desirable properties than hashing.)</p>
</dd>
<dt id="difficult-backups-and-caches">Difficult backups and caches</dt>
<dd>
<p>Hierarchical file systems provide no help in keeping track of how many copies you own of a particular a file or set of files. A special case of this statement is that you can’t tell if a file (or set of files) is new / freshly edited and has not been backed up at all (i.e. only one copy available, no extras).</p>
<p>Example: You have a single folder containing several gigabytes of videos, stored on your computer’s internal hard drive, which you wish to back up. You go and buy an external disk, plug it in, and copy the entire videos folder from your internal drive to the external drive – simple and easy to understand. Now you update your primary video collection by adding new files and editing a few. You want to update your backup to match, but what should you do? The simplest (and least error-prone) approach is to ignore the existing backup and add a new complete copy of your current folder; you may choose to delete the existing backup. This approach is wasteful in storage space and I/O transfer time; it works if the collection of files is small but becomes impractical if the total file size approaches the storage size (for example having 400 GB of data when you can only afford to buy a 500 GB backup drive). So you adopt an incremental backup strategy, where you only copy/manipulate files that have changed. We know that in general, it is impossible to tell if two file paths have the same content without fully reading both files. An incremental backup program would probably use the heuristic of checking file sizes, timestamps, and archive bits to see if a file needs to be re-copied. The heuristic works well in practice, but can still be subverted by accident (by a well-meaning tool that forges timestamps) or by malice. By changing some file content without changing its size or timestamp, it is possible that an incremental backup program does not copy the actually changed file to the backup storage for an arbitrarily long time.</p>
<p>Example: You keep the primary copy of all your files on your desktop computer, but copy a few files (such as books and movies) to your laptop for temporary use. You want to mark the files on your laptop as cached copies, so you put them into a folder named “Cached”. The idea is that it is safe to delete any file in the “Cached” directory or the whole directory at any time. But you have to be extremely careful to never add a non-cached file to it (such as a newly edited document), never directly modify any files in the cached directory, and never modify one of the files on your desktop without updating the laptop cache.</p>
<p>As we can see, the idea of mutable files quickly changes from a convenience to a liability, and the file system does nothing to help us keep track of file changes or duplicate copies. All this adds up to mental tracking effort and human overhead for things that the computer should take care of for us.</p>
<p>As far as my own policies go, I trust neither the primary copy, the backup(s), nor myself. For example before I delete a set of backup files, I want to check that each file still exists somewhere in the primary copy and has identical content – this protects against corruption or unnoticed accidental deletion in the primary copy. For example when I make an incremental update to an existing backup, I want to make sure that after the update finishes, the entire set of backup files contains exactly the same content as the primary copy, ignoring any excuses about timestamp and file size heuristics. In both cases, hierarchical file systems make it a laborious and error-prone process to verify identical file content and to detect the set of changed files.</p>
</dd>
<dt id="sharding-large-folders">Sharding large folders</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/directory-per-thousand.png"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/directory-per-thousand-thumb.png" alt="" style="width:20em"/></a>
</div>
<p>A folder with many thousands of files in it is not easy to handle. Command line tools like <code>ls</code> will handily overflow the screen with file names. Graphical tools like Windows Explorer might take a few seconds to load all the folder entries while the screen stays blank, and then you still have to scroll through the long list of files to find the one you want. Performance and usability are degraded because the system is designed around the assumption that you care about seeing the entire set of files in any particular folder, rather than presenting results incrementally. Because of this, when a normal user encounters a folder with a few thousand files in it, they are incentivized to create subfolders and move items into them to fix the undesirable behavior.</p>
<p>For example because of this behavior on large folders, I am forced to split up my photo collection – somewhere in the order of 100 000 files – into chunks of 1000 for sane browsing. I created folders like “00” for the zeroth thousand items (000~999), “01” for the first thousand (1000~1999), “02” for the next thousand (2000~2999), and so on. But in theory, this is extra effort to artificially work around a dumb file system concept. I would be thrilled if I could dump all my photos into one giant folder, and let the system software figure out how to present subsets of that data in a responsive, performant way. It’s almost as though hierarchical file systems have forsaken some of the beauty of a flat file system.</p>
<p>Reorganizing a large folder is done not only by humans but also by automated tools. For example, Git stores loose objects in 256 directories (one for each initial byte value), each of which can contain an unlimited number of files (but in practice contains about 1 to 30 items). For example, <a href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_fs_fs/structure">Subversion’s FSFS repository format</a> version 4+ (SVN tool version 1.6+) supports sharding so that 1000 revision files (instead of unlimited) are stored per directory. In both cases, the sharding logic is intended to work around potential poor performance in an HFS, but introduce complexity and do not improve the quality of the data being stored.</p>
<p>This point ties back to other observations about HFSes and human effort, such as the one about unique names. There is a running theme that HFSes have a simple data model and allow for simple implementations, but shove all the complexity to humans to manage manually.</p>
</dd>
<dt id="overly-rich-file-semantics">Overly rich file semantics</dt>
<dd>
<p>A “file” on a modern HFS is not a mere sequence of bytes; it comes with many pieces of extra information attached by default. General-purpose operating systems are designed for multiple users, hence each file has information about ownership and permissions (read/write/execute/etc.). A file may have special attributes like “append-only” or “cannot be moved or modified until the immutable flag is removed”. A file may be accessible from multiple paths due to hard links, which means that backup and restore tools must handle this case correctly to replicate the exact read/write behavior. A file has timestamps denoting its creation, last modification, and last access – but the former two are useless/misleading when a file is already tracked in a higher-level versioning system like Git, and the latter can be disabled to reduce I/O workload. On Windows, every time a file is modified its archive bit is set; when some backup program successfully archives the file the bit is cleared – but this presupposes that only one backup program can be responsible for managing a file. A sparse file can be created and only have some parts filled in, but why not design the file format to cope with data growth in the first place? A file can be locked by a process for exclusive access; moreover file locking and content sharing can provide a communication channel between processes. The Wikipedia pages on <a href="https://en.wikipedia.org/wiki/File_attribute">file attributes</a> and the <a href="https://en.wikipedia.org/wiki/Chattr">chattr tool</a> illustrate just some of the numerous properties a file can have.</p>
<p>It is not a universal truth that files are treated as objects with many rich properties. For example in Git, a file is a sequence of bytes with a single unique path (within a commit), and only has the executable flag as an additional property; there are no other hidden attributes, permissions, etc. (Subversion, however, has many hidden attributes on a file, such as its merge history and a unique ID.)</p>
</dd>
Alternative systems as inspirational examples
<dt id="git-version-control"><a href="https://en.wikipedia.org/wiki/Git" title="Wikipedia: Git">Git version control</a></dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/git-object-graph.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/git-object-graph.svg" alt="" style="width:20em"/></a>
</div>
<p>Git is a popular tool in the software development community, which takes snapshots of a project’s hierarchy of directories and files. Inside the world of Git, every data object is addressable by a globally unique 160-bit (or 40 hex digit) SHA-1 hash value, regardless of whose repository it’s stored in. Some of these objects, called trees, have children labeled with ordinary file names. In essence, Git is a dual system with immutable hash-addressed objects as the primary retrieval mechanism, and hierarchical tree paths as a secondary (and incomplete) retrieval mechanism.</p>
<p>The notion of hash names in Git solves a number of problems by design. Suppose you and your friend halfway across the world both own an object with the hash e4d4634d<wbr/>3d2b4fd3<wbr/>5c11864b<wbr/>b00eb0d9<wbr/>1b760c68 – in this case you can be sure that you both have the same file content, without needing to transfer every byte of a potentially large file. In another scenario, suppose you and your friend start at the exact same snapshot (commit), make some different changes, and each take a new snapshot. In other version control systems that use numbered revisions (e.g. rev 3, rev 4, rev 5 in Subversion/SVN), you can’t both claim to have created revision <var>n</var>+1 because one of you must have come first and the other come after. But Git makes these divergent changes possible because snapshots are labeled by hashes and hashes don’t have a sequential order – both of you will end up with a new commit object with different hashes, and this works fine in a model where the revision history is a directed acyclic graph rather than a straight line.</p>
<p>The immutability of files in Git makes some HFS problems non-applicable. If you take a particular object, say the one with hash 0be5...0ee7 and change a few bytes of its content, then the new object will (with extremely high probability) have a different hash. The hash gets recorded in the tree and in turn affects the snapshot hash. It is practically impossible to accidentally or intentionally change a file in an undetected way; every change, no matter how small, will be detected by Git with statistical near-certainty. So if you wanted to compare a particular file tree against a backup copy, you can simply look at the hashes to reliably tell if any new data needs to be synchronized.</p>
</dd>
<dt id="danbooru-style-image-boards"><a href="https://en.wikipedia.org/wiki/Imageboard#Danbooru-style_boards" title="Wikipedia: Imageboard - Danbooru-style boards">Danbooru-style image boards</a></dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/danbooru-screenshot.png"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/danbooru-screenshot-thumb.png" alt="" style="width:20em"/></a>
</div>
<p>Danbooru, Gelbooru, Konachan, etc. (all <abbr title="not safe for work">NSFW</abbr>) host millions of anime drawings that are categorized in multiple ways: by character, by appearance, by series, by author, et cetera. They offer these classifications without resorting to hierarchies, and instead rely on tagging. The data model works like this: Each uploaded image is saved with its MD5 hash as file name, and is also given a sequential serial number (e.g. #2638577) for compactness. Each image can have any number of tags attached, where each tag is a simple string; examples of tags include “hat”, “1girl”, “pink_hair”, “kantai_collection”, “izumi_konata”. When you open an image, the page also shows what tags are associated with that image. You can also query a tag and see the list of all images that have the tag. This two-sided query is a handy feature that hierarchical file systems are not designed to support. Note that other than the hash and serial number, each image doesn’t have a name in the traditional sense. No one forces you to name a set of images like “Nanoha 1.png”, “Nanoha 2.png”, “Nanoha 3.png”, etc. The list of tags is not required to be unique either (i.e. two different images can end up with the same tags), and in fact no tags are strictly required at all (but it would make the image rather difficult to retrieve). These concepts are a complete reversal of what we are accustomed to in hierarchical file systems.</p>
<p>The Danbooru image tagging system is actually richer than described so far, because tags are not just simple strings. Each tag has a type attribute, which can be either general, character, series, or artist – this makes it possible to distinguish between a tag for a fictional character named Yuki versus an artist named Yuki. Moreover each tag has a description page attached to it, allowing more information to be added to explain what the tag means (e.g. defining the term zettai ryouiki and setting the judgement criteria).</p>
<p>Once upon a time I tried to curate a set of anime images on a local hierarchical file system, but failed to maintain good organization as the number of files grew. I kept running into the problems of unique file names and single classification. The existence of Danbooru confirmed to me that HFSes are a lost cause and it is futile to continue working under the hierarchical model.</p>
<p><a href="https://www.flickr.com/">Flickr</a> (SFW) is a photo sharing site where photos can be classified/retrieved by tags like on Danbooru, but also by primary color, full text search, geographic location, and copyright licensing. However, I chose Danbooru as the primary example because tag browsing is a mandatory part of the user experience, whereas Flickr has fewer tags per photo and more emphasizes browsing by author instead of by tag.</p>
</dd>
<dt id="relational-database-model"><a href="https://en.wikipedia.org/wiki/Relational_model" title="Wikipedia: Relational model">Relational database model</a></dt>
<dd>
<p>The relational model along with RDBMS software is a popular and powerful way to store and access data. Relational databases power many web services and company-internal services alike. The relational data model, how to design tables, and how to design queries are all taught to novice programmers and are well known in the industry, so I will not explain their background concepts.</p>
<p>Relational databases are strictly more expressive than hierarchical file systems; you can emulate an HFS through an RDBMS, and still have room left over to add non-hierarchical features like cyclic references. The data model of the Danbooru image board can easily be reverse-engineered as a set of tables:</p>
<ul>
<li>Images: int imageId (primary), byte[16] md5Hash, byte[] fileData.</li>
<li>ImageTags: int imageId (foreign), int tagId (foreign).</li>
<li>Tags: int tagId (primary), string name, int type, string description.</li>
<li>Comments: int imageId (foreign), int sequence, string message.</li>
</ul>
<p>As we will see later, the file organization system I will propose will be a different way of phrasing the relational model.</p>
</dd>
<dt id="music-libraries">Music libraries</dt>
<dd>
<p>When I mention the example of how HFSes fail at music organization, most people will give a confused look because their favorite media player has a built-in library to manage the metadata and queries. For example, the software music players foobar2000, Winamp, Windows Media Player, and iTunes all have a music library as a feature. To choose a song (or songs) to play, users can either use their system-level file manager (Explorer, Finder, etc.) or use the library UI within the media player program. A music library can be viewed as a table with one row per song and one column per attribute (title, artist, album, length, rating, format, etc.). By default, the music library shows every song that a user is known to own. Then one can sort and filter on arbitrary columns – for example searching Hamasaki Ayumi as the artist, examining the results, then further narrowing it to ratings of 4+ stars. The ability to search and filter results in flexible ways is light years ahead of what a hierarchical file system alone can provide, and takes far less effort both when storing songs (no need to create multiple crazy hierarchies) and when retrieving songs (no need to navigate down a tree of folders).</p>
<p>A major problem with music libraries and file libraries in general is that they are proprietary and narrow. It can be taken for granted that foobar2000 and Winamp will track your music collection separately – so any changes made to one library need to be manually performed in the other library. A file library can hold facts about your music collection that are not stored in the music files themselves, such as rating or play count, but be difficult to export to an open format (e.g. CSV text file). As for narrowness, a similar concept applies to photo libraries. Adobe Lightroom, and probably many other photo editing/catalog software, maintains a library of all the photos you own, no matter where on disk they are stored. The library allows queries like by date, by camera, by rating, by text tags, etc. But again they are data silos and interact poorly with the outside world.</p>
<p>Media libraries are wonderful and have shown us how powerful and practical they are. But their limitations suggest that we should design a system where media libraries are universal (applies to any file), singular (so all music player software on a computer will share the same library), and trivial (so an application developer relies on the system-level media library instead of developing his own from scratch).</p>
</dd>
<dt id="interplanetary-file-system-ipfs"><a href="https://ipfs.io/" title="IPFS is the Distributed Web">InterPlanetary File System (IPFS)</a></dt>
<dd>
<p>The IPFS project aims to solve some of the same file organization problems that I have. IPFS gives every file a unique fingerprint (i.e. hash), detects duplication, tracks version history, provides decentralized search and distribution, allows machine-readable links within files, and much more. I picked up a few helpful ideas from reading their whitepaper, but acknowledge that many of their goals don’t correspond to mine. IPFS seems to describe at length about their <abbr title="distributed hash table">DHT</abbr>-like decentralized directory service and how nodes connect to each other, whereas I only care about how data is represented/modeled. IPFS allows a file to be composed of a list of raw blocks of byte sequences, a complexity motivated by documents that get edited over time. They propose supporting mutable files via path strings that contain public keys, which seems questionable at best and detrimental for archival at worst.</p>
</dd>
<dt id="tuple-spaces">Tuple spaces</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/tuple-space.png"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/tuple-space.png" alt="" style="width:20em"/></a>
</div>
<p>The model of tuple spaces comes from the world of parallel computing, not file storage and distribution. The idea is that every fact we might want to express is represented as a tuple of values, such as (“Kevin”, 32, “Paris”). Tuples have no path or label; they are pure values. Tuples can be stored, queried, and retrieved from a pool. If the pool is accessible by multiple processors/computers, then this becomes a way to communicate data between them. In a sense, if you take a database, examine all its tables, and make every row into a tuple floating in space, then a tuple space is what you end up with. This abstract and overly flexible idea of a tuple space will form the basis of the file organization system I describe later below. There is a lack of good descriptions of tuple spaces, but a <a href="https://software-carpentry.org/blog/2011/03/tuple-spaces-or-good-ideas-dont-always-win.html">blog post at Software Carpentry</a> paints a decent picture.</p>
</dd>
<dt id="related-articles">Related articles</dt>
<dd>
<ul>
<li>
<a href="https://1000camels.com/2012/02/08/alternatives-to-hierarchical-file-systems/">experiments in space in formation: Alternatives to hierarchical file systems</a> (1 page)<br/>
A short post that echoes my thoughts about paths, tags, and multiple classification.
</li>
<li>
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/a-novel-idea-for-a-new-filesystem.pdf">A novel idea for a new Filesystem: Storing facets as key-value pairs for individual files</a> (7 pages)<br/>
Identifies a number of limitations and pain points of hierarchical file systems clearly.
</li>
<li>
<a href="https://www.eecs.harvard.edu/margo/papers/hotos09/paper.pdf">Hierarchical File Systems are Dead</a> (5 pages) <a href="https://news.ycombinator.com/item?id=1902595">(discussion on Hacker News)</a><br/>
Short paper that covers problems in HFSes like over-emphasis on storage location and only allowing a single categorization per file, and proposes a data model (with diagrams) along with an implementation sketch.
</li>
<li>
<a href="https://web.mit.edu/6.033/2011/wwwdocs/writing-samples/sbezek_dp1.pdf">TagFS: A simple tag-based filesystem</a> (10 pages)<br/>
Presents ~15 API functions to illustrate what the system provides. Describes unions of data sources, Boolean queries, and query optimization. Advocates the use of semantic triples in tags. Talks about modifying existing hierarchical-path-based applications to fit this system.
</li>
<li>
<a href="http://pages.stern.nyu.edu/~marriaga/beyond-the-hfs.pdf">Going beyond the hierarchical file system: a new approach to document storage and retrieval</a> (6 pages)<br/>
A paper highlighting the fact that classifying a file along multiple axes is poorly modeled with hierarchies. Also shows their proposed user interface for saving, tagging, and querying files.
</li>
<li>
<a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.60.4187&rep=rep1&type=pdf">TagFS — Tag Semantics for Hierarchical File Systems</a> (6 pages)<br/>
Illustrates how to shoehorn a tag query system into a virtual legacy hierarchy that is served over the WebDAV protocol.
</li>
<li>
<a href="https://pubs.cs.uct.ac.za/archive/00000225/01/sacj-dave.pdf">Improving the Usability of the Hierarchical File System</a> (10 pages)<br/>
Identifies the relationship between classifying files and storing values in a database table.
</li>
<li>
<a href="https://www.howtogeek.com/howto/15677/zen-and-the-art-of-file-and-folder-organization/">How-To geek: Zen and the Art of File and Folder Organization</a> (~40 pages)<br/>
An earnest but ultimately doomed attempt to teach users how to organize files into folders, and to create shortcuts in secondary locations.
</li>
<li>
<a href="https://controlaltbackspace.org/filesystem/filesystem-links-everything-you-ever-wanted-to-know/">Control-Alt-Backspace: Filesystem Links: Everything You Ever Wanted to Know</a> (~10 pages)<br/>
Explains the behavior and creation of hard and soft links on multiple operating systems.
</li>
<li>
<a href="https://www.cs.yale.edu/homes/freeman/dissertation/etf.pdf">The Lifestreams Software Architecture</a> (185 pages)<br/>
Comprehensively designs and tests a system for workflow and archival, based on chronological presentation plus keyword and attribute filtering.
</li>
<li>
<a href="https://mitpress.mit.edu/books/science-managing-our-digital-stuff">The Science of Managing Our Digital Stuff</a> (book, 300 pages)<br/>
Compares hierarchies/folders, search, tagging, and team/shared spaces. Discusses user studies where they measure human performance, and repeatedly advocates hierarchical navigation. A <a href="https://www.youtube.com/watch?v=lI3XmlsiZa4" title="YouTube: The Science of Managing Our Digital Stuff">talk video</a> (65 minutes) covers part of the book’s content.
</li>
<li>
<a href="https://pdfs.semanticscholar.org/cf86/af610bf9b43256ae12de2c09bdbcffd17a8f.pdf">Representing Information About Files</a> (8 pages)<br/>
Proposes a model of metadata attributes, indexing and querying of metadata values, and file versioning – for files stored in a classic hierarchy. The sequel is a <a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.159.8568&rep=rep1&type=pdf">dissertation</a> (204 pages; table of contents near last page).
</li>
<li>
<a href="https://en.wikipedia.org/wiki/WinFS">Wikipedia: WinFS</a> (~15 pages)<br/>
The ultimate vaporware file storage project, with lofty goals to support rich metadata and queries, but was perpetually delayed and then cancelled. A series of four <a href="https://hal2020.com/2013/02/14/winfs-integratedunified-storage-and-microsoft-part-1/" title="Hal Berenson: WinFS, Integrated/Unified Storage, and Microsoft – Part 1">blog posts</a> talk about how WinFS was designed intended to organize information. An <a href="https://channel9.msdn.com/Blogs/scobleizer/Shishir-Mehrotra-WinFS-beta-1-team-meeting" title="Microsoft Channel 9: Shishir Mehrotra - WinFS beta 1 team meeting">interview video</a> (58 minutes) provides another rather detailed view of the design goals, and shows several demos of the prototype system’s functionality.
</li>
<li>More Wikipedia: <a href="https://en.wikipedia.org/wiki/Object_storage">Object storage</a>, <a href="https://en.wikipedia.org/wiki/Digital_asset_management">Digital asset management</a>, <a href="https://en.wikipedia.org/wiki/Semantic_file_system">Semantic file system</a></li>
</ul>
</dd>
<dt id="related-software">Related software</dt>
<dd>
<ul>
<li>
<a href="https://perkeep.org/">Perkeep</a> (formerly Camlistore)<br/>
Lets you store, organize, and access data on your own computer in Perkeep’s format. Provides a command line interface and web interface for access. Fairly fleshed out in terms of functionality. See their <a href="https://perkeep.org/doc/">documentation</a> section for a project overview and presentations.
</li>
<li><a href="https://www.tagsistant.net/">Tagsistant: semantic filesystem for Linux</a></li>
<li><a href="https://tabbles.net/">Tabbles: File Tagging, Document Management</a></li>
<li><a href="https://tmsu.org/">TMSU (Tag My Shit Up)</a></li>
<li><a href="https://public-inbox.org/git/91a34c5b-7844-3db2-cf29-411df5bcf886@noekeon.org/">Another proposed hash function transition plan - The Keccak Team</a></li>
</ul>
</dd>
Designing a tag-based file system
Let’s demolish all the assumptions and baggage from modern hierarchical file systems and start with a fresh slate. Step by step, we will build up a data model for what I think is a reasonable way to organize files. This plan is not final at all, and I enjoy intellectual discussions on shortcomings and hearing better ideas. We will talk in the abstract and not worry too much about implementation feasibility at the moment; just assume that all data retrieval queries can be answered by performing a brute-force linear scan of all objects in a collection.
<dt id="immutable-file-objects-with-hash-identities">Immutable file objects with hash identities</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/immutable-file.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/immutable-file.svg" alt="" style="width:20em"/></a>
</div>
<p>Define a “file” to be an immutable, finite sequence of bytes. In other words, a file is a list of numbers, and changing the length or any number produces a new file. A file has no name, no location, no attributes attached (timestamps, permissions, etc.), and no hidden semantics. You can picture a file as a block of numbers floating in space among other files. Define the “hash” of a file to be the SHA-256 hash of said sequence of bytes. Note that each file maps to exactly one hash; there is no ambiguity in how a file gets hashed.</p>
<p>Although SHA-256 is just one possible hash function we can use, it satisfies a number of useful properties, such as:</p>
<ul>
<li><p>Every hash value is the same length, namely 32 bytes long. (Variable-length hashes would be an unnecessary pain to work with.)</p></li>
<li><p>It is extremely hard to find two different files with the same hash value. (Collision resistance; this means it is extremely likely that every file we ever produce will have a different hash.)</p></li>
<li><p>Given a particular hash where we don’t already know a file that produces it, it is hard to create a file that produces the hash. (Preimage resistance; this means we can’t just see a hash and forge a file that satisfies the hash.)</p></li>
<li><p>Given a particular file, it is hard to create a different file that produces the same hash. (Second preimage resistance; this means it is hard to substitute a different file that passes a hash check.)</p></li>
</ul>
<p>At this point, assume that our file system stores an unordered, unnamed set of files (byte sequences). Furthermore, assume that if the system is given a hash, then it either locates the file possessing that hash or returns nothing. An API sketch of this hypothetical file system looks like this:</p>
<ul>
<li><code>void addFile(byte[] b)</code></li>
<li><code>bool containsFile(Sha256 h)</code></li>
<li><code>void removeFile(Sha256 h)</code></li>
<li><code>byte[] getFile(Sha256 h)</code></li>
<li><code>Sha256[] getHashesOfAllFiles()</code></li>
<li><code>byte[][] getAllFiles()</code></li>
</ul>
<p>Notice in particular that no file has a name or any tag associated with it, and no file can be changed in place (but you can remove a file, change the content in memory, and add a different file). Now based on those low-level file system operations, we can define an overwhelmingly powerful function:</p>
<ul>
<li><code>Sha256[] queryFiles(Predicate p)</code></li>
</ul>
<p>This evaluates a predicate over every file in the whole collection, and returns the set of hashes of all files that match. In this context, a predicate has a single function <code>bool check(byte[] file, byte[][] allFiles)</code> that decides whether any particular file belongs in the set of results. For example, a simple predicate might be “file is longer than 1000 bytes”, or “the first 4 bytes of file are 0x66 0x4C 0x61 0x43”. The general predicate also receives the set of all known files because then it can test whether some other file makes a reference to the current file being examined. Although arbitrary predicate functions will require a full scan of the file system and expend CPU time and I/O resources, later we will work with one useful predicate that covers many use cases. The predicate is “does some file <var>G</var> contain a hash reference to <var>F</var>?”, which allows precomputation and indexing.</p>
</dd>
<dt id="simple-string-tags">Simple string tags</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/simple-tags.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/simple-tags.svg" alt="" style="width:20em"/></a>
</div>
<p>Here, tags will largely replace the role of folders and file names in traditional HFSes. We shall define a tag as a file containing two fields: (string name, Sha256 target).</p>
<p>Example: We have a <a href="https://www.flickr.com/photos/rod_waddington/15396409041" title="Flickr: Omo Valley sunset, Ethiopia - Rod Waddington">photo</a> with the SHA-256 hash of dc0e1601<wbr/>3b70816b<wbr/>6d124163<wbr/>1fe569c1<wbr/>e47b187f<wbr/>781f929a<wbr/>066508b4<wbr/>9d4e3d98 and we wish to describe it with tags. So we can add a bunch of tag files to the nebulous file system pool, like (“photo”, dc0e...3d98), (“Africa”, dc0e...3d98), (“sunset”, dc0e...3d98), (“2003”, dc0e...3d98). It may seem verbose to write the hash of the photo each time, but this simplifies things later on and lets us continue to keep the system flexible. Furthermore, for personal collections this bit of text doesn’t take up much space compared to bulk media files, and there are strategies to store the data in a more compact way while still maintaining the same conceptual model (discussed later).</p>
<p>Remember that tags are not file names. A file can have no tags at all. A tag like “dog” could be applied to 5 files (with no sense of “uniqueness” like “dog 1”, “dog 2”, etc.). Simple tags are a great start; they provide an expressive system for classifying files and already liberate us from all the constraints of hierarchies and unique names.</p>
<p>Suppose we can query the file system by tag, with an API like this:</p>
<ul>
<li><code>Sha256[] getFilesByTag(string tagName)</code></li>
<li><code>Sha256[] getTagsByFile(Sha256 h)</code></li>
</ul>
<p>Note that these are special cases of <code>Sha256[] queryFiles(Predicate p)</code> mentioned earlier.</p>
<p>When it comes time to access our files, we have the freedom to choose any tag to find a file. For example we might query the tag “Africa”, which returns a bunch of photos, videos, and travel documents. Or we might start with the tag query “photo”, and get back photos depicting Africa, Germany, and school. Moreover, note that tag search results are inclusive whereas folders force us to dig down until there are no more subfolders. In an HFS we might have a path like /Photos/Germany/Berlin/Emily.jpg. The problem is that if we are browsing at the level of /Photos/Germany, we don’t even see all the descendant items such as the photos within the Berlin folder. This is a non-problem in tag-based systems because a photo can be classified as Germany and Berlin simultaneously, and you only need to match one tag, not necessarily all the tags, to find a particular file.</p>
</dd>
<dt id="complex-indirect-tags">Complex indirect tags</dt>
<dd>
<p>Simple tags are easy to understand and I believe offer enough functionality for the average user. But simple tags have a number of limitations:</p>
<ul>
<li><p>Renaming a tag is highly disruptive. For example the city of Edo changed its name to Tokyo. If you have a bunch of files tagged with the string “Edo”, then you need to read each tag file, create a new tag with the new name but same target, add the new tag file, and delete the old tag file.</p></li>
<li><p>Some names are ambiguous and represent multiple distinct concepts. The word “chat” means something different in English than in French. What are you going to do, disambiguate them as “chat (English)” vs. “chat (Français)”? What if you spoke English all your life and didn’t know that the word collides with French? Other examples post-disambiguation include “Apple (company)” vs. “apple (fruit)”, and “Toronto, Ontario, Canada” vs. “Toronto, Ohio, USA”. But some names are very difficult to disambiguate, such as two different people named “John Smith” – what are you going to do, call them John 1 and John 2, or add social security numbers or birth dates to people’s names?</p></li>
<li><p>Tag strings are language-centric, even though what we really care about is the underlying abstract concept. For example you might tag a bunch of photos as “Canada”. Why not tag them as (Chinese) <span lang="zh">“加拿大”</span> instead?</p></li>
<li><p>Some concepts have multiple, inconsistent, and/or disputed names and spellings. It ranges from terms like email / e-mail / electronic mail, to country names, to old and new ways of transliterating foreign words. Inconsistent names tend to fragment or bloat simple tags.</p></li>
<li><p>Simple tags offer no room to explain the meaning of the tag in detail, or to annotate the role of a tag (e.g. name of a television series, name of the director, describing something visually present in an image, describing the intentions of the author, describes image visual quality, describes the licensing status).</p></li>
</ul>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/complex-tags.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/complex-tags.svg" alt="" style="width:20em"/></a>
</div>
<p>To address these issues, let’s add one level of indirection to the tagging model. First, create a file called the tag core consisting of a unique string. In theory it could be a simple string like “tree” or “Star Wars”, but because these can suffer from issues due to renaming, uniqueness, and language-neutrality, it is better to use uniformly random garbage data as the tag core. Now take the hash of the tag core and get a result like 1ca21a98<wbr/>b21ccedf<wbr/>d10a3436<wbr/>d7a1a39d<wbr/>3acae032<wbr/>aa688256<wbr/>4c89b280<wbr/>81a27cdf. Next we add tags referring to the core’s hash, such as (“tree”, “English”, 1ca2...7cdf), (<span lang="zh">“樹”</span>, <span lang="zh">“中文”</span>, 1ca2...7cdf). At the same time, we associate other files with the tag core hash, such as (<i>some photo hash</i>, 1ca2...7cdf), (<i>some video hash</i>, 1ca2...7cdf), (<i>some document hash</i>, 1ca2...7cdf).</p>
<p>When a human performs a query, the machine will perform an extra query compared to the case of simple tags. Suppose we want to find all files associated with the/a tag named “tree”. First, we search for tags that contain the string “tree”, and make note of which tag cores these name tags point to. There might be 0, 1, 2, or more answers – but hopefully 1. Now take one of these tag cores, find every media file tag (not string tag) that points to this tag core, and take the set of file targets of these file tags as the final query result.</p>
<p>One extension of using tag cores is that we can create a public vocabulary of tags with universally accepted meanings. For example, there might be a publicly known tag core for the city of New York, NY, USA. When you tag your personal collection of photos, it would be beneficial to point to the publicly known tag core instead of creating your own tag core, because then you can compare your collection against other collections, or make it easier to publish in the future. And because tag cores can have arbitrary data pointing to it, it is possible to attach names in a variety of languages, links to a Wikipedia article, Earth coordinates, et cetera.</p>
</dd>
<dt id="internal-vs-external-metadata">Internal vs. external metadata</dt>
<dd>
<p>In any file-based system, both in traditional HFSes and in the current clean-slate proposal, metadata about a particular file can be stored within the file itself, outside the file with appropriate pointers, or both. Examples of file formats supporting internal metadata include EXIF for JPEG, ID3 for MP3, and various fields for Microsoft Office documents. The metadata is stored in some region of the file (usually the header), and the main payload is stored elsewhere within the same monolithic file. If a file containing internal metadata is transported to another location (e.g. web download), then the metadata is copied fully by default – unless extra effort is taken with a format-aware program to add/modify/remove the metadata. The problem here is that some metadata is private, in varying senses of the word.</p>
<p>Example: A benign case is that a thumbnail image can be embedded in a larger image file. Images can be huge (say 100 megapixels), but we like being able to quickly scroll through a collection of images while only seeing a small thumbnail (say 0.01 megapixels) of each image. But different people will have different ideas on what thumbnail size is appropriate. A power user might need 500×500 pixel thumbnails on a high-resolution screen. A smartphone user might only need a 60×60 thumbnail on a tiny screen. One user might want the thumbnail image compression to save more space at the expense of more CPU time, whereas another user might want the opposite. Some of us simply want no saved thumbnail at all, because our computers are fast and the original images are small enough to read and decode in their entirety. Distributing thumbnails with images ends up being a compromise that makes no one happy.</p>
<p>Example: For every song you own, you keep track of the number of times you played it, along with ratings and personal notes about what you think of the tune. If these pieces of metadata are stored within the music file, then they will likely be transmitted when you share the song with another person. But these details are personal and irrelevant to another person at best, or embarrassing and revealing at worst.</p>
<p>Because metadata is liable to change over time, internal metadata schemes don’t work well with systems based on immutable files. For example if you have an MP3 file with a bunch of internal tags, and you fix a typo in the song title, then you end up with a file with a different hash. If any other file contained a reference to the old MP3 file’s hash, then you would need to update those hashes to point to the new file.</p>
<p>Metadata is external when the main data exists in one file and the metadata exists in a different file. External metadata can exist in a couple of forms:</p>
<ul>
<li><p>Some hierarchical file systems allow files to store extra content under a derived name – the feature is called alternate data streams on Windows, resource forks on Mac, and nonexistent on Unix. For example, “Dog.gif” might have a fork named “rating” where you write how many stars you rated the picture. The path to the main data is “Dog.gif”, and the path to the fork is “Dog.gif:rating”. A benefit of forks is that when you move the file, the fork automatically moves along with the file – it is impossible to have dangling or incorrect reference. In fact, a file with a bunch of forks behaves essentially like a directory with a bunch of files. A critical disadvantage of forks is that interoperability is terrible (much like hard and soft links) – forks are not supported in web protocols (you won’t download a multi-fork file without much custom hacking), the legacy FAT32 file system (used on most flash drives and camera cards), nor the Unix world in general. Making matters worse, forks are used so rarely by users that it is very easy to forget about a file having forks, or to copy a file’s main content but forget to copy its forks. Forks can be considered as dangerous and effectively dead for conveying any meaningful metadata.</p></li>
<li><p>Metadata can be placed in the same directory alongside the main file, such as associating “symphony.info” with “symphony.mp3”. This scheme is brittle and requires conscious user effort to rename, move, and delete both files simultaneously every time. But the advantage is that the metadata file is pretty easily seen at the same time as the main file.</p></li>
<li><p>Metadata can be stored in an arbitrary location, and point to the relevant file with a path name. For example a personal music database file might contain a thousand rows of entries like (title=<wbr/>“Ode to Joy”, artist=<wbr/>“Beethoven”, storageLocation=<wbr/>“/home/jane/<wbr/>music/ode.mp3”). This is even more brittle than storing metadata beside the main file, but a centralized database has the advantage of allowing fast and easy queries (e.g. listing all known songs alphabetically by title, filtering by artist).</p></li>
<li><p>And finally, an external metadata file can point to the main file by hash reference. Say that a video file has the hash 4966d25c<wbr/>9a3d5008<wbr/>7846aa50<wbr/>f7e83300<wbr/>f1976a4b, and you foresee that you will never edit the video file directly (e.g. no internal metadata). Then you can create a new metadata file which says (title=“baby shower”, date=“20140628”, target=4966...6a4b) and store it somewhere. This style of operation is exactly how Git describes its data objects. But it presupposes that the file system supports hash-based queries, making this method of tagging in a traditional HFS nearly useless unless the video file is consciously renamed to 4966...6a4b. Even if it was named as such, it is brittle because if the file content is accidentally or unknowingly modified, then the hash no longer reflects the file content. But this style of hash-based external tagging is a good fit for an immutable file system because tags can be added and deleted without affecting the main file.</p></li>
</ul>
<p>Although we established that external tagging has some desirable properties and might work in a hash-addressed file system, there is still one benefit of internal tagging that needs to be addressed. Sometimes we do want to transfer a file along with its tags – such as a JPEG photo with details of the camera operation (standard EXIF stuff), or an MP3 file with a good description of the song. An internally tagged file just needs one file transfer to accomplish this. External tagging forces us to transfer multiple files – however we can bundle up the main file and metadata files in a container like a TAR or ZIP file – so this is still reasonably possible.</p>
</dd>
<dt id="tag-all-the-things">Tag all the things</dt>
<dd>
<p>So far, it was implied that tags describe readily visible aspects about a file, such as the media type, objects in a picture, title and author, etc. But an expressive metadata system allows us to represent much more types of knowledge; it is a deep rabbit hole that we will lightly dip our toes into.</p>
<p>For example: Normally we identify a song by its title and artist. But sometimes a song might have been performed by a number of different people over time. A piece of classical music like Für Elise will have been performed and recorded many times. While each recording is subtly or very different, they all share the same abstract melody. A more recent example is that the anime opening theme song Happy☆Material (from Mahou Sensei Negima) has been <a href="https://en.wikipedia.org/wiki/List_of_Negima_songs#Opening" title="Wikipedia: List of Negima songs - Opening">performed 8 times</a> officially as part of the TV show. Hence there might be value in creating a tag core for each abstract melody, and associating them with concrete audio files. Once the data is entered, searching for similar songs by the criterion of abstract melody is far less error-prone than searching alternative performances by the title text. It even covers the case where a song is adapted to a different language and renamed (e.g. <span lang="ja">ひとり上手</span> in Japanese vs. <span lang="zh">漫步人生路</span> in Cantonese).</p>
<p>For example: You run a photography business, where you shoot and edit photos. You want to keep the raw photo files (straight from camera) regardless of any editing work you do afterward; you save your edits as new photo files and never change or delete the originals. But you also want to remember where each edited photo came from; in particular you want the edited photo file to “point to” the original photo. Legacy HFSes make it hard to express this relationship between files, because you will probably want to store the edited photo in a completely different location (such as the customer’s folder) than the originals (such as a general archival photo stream). A partial workaround is to keep the same sequence number in both the original and the edited files (e.g. IMG_27184), but requires manual effort when saving files and retrieving files and thus is brittle. The solution is to create a tag file that points to the original and edited photo, like DerivedWork(original=(some hash), derived=(some hash)).</p>
<p>In this proposed system, tags are full-fledged standalone files. They can be published and discussed just like any traditional heavyweight file can. Moreover, it is permitted to create tags that refer to tags. So not only can you have a tag that says a particular photo depicts Antarctica, but you can also annotate that tag itself with information like “Bob made this note” or “I am unsure” or “This fact was added on 2008-12-25”.</p>
<p>This system also makes it possible to make private annotations about public files. Suppose you view a piece of art online, with the hash 15e8...9252. You can create an annotation file like CommentTag(target=15e8...9252, comment=“Reminds me of the street I grew up in”) and store it on your local file system. This way, you can make notes about public objects even though you don’t have permission to modify the public object directly. Also, you can upload such comments to a public repository so that many people’s feedback can be aggregated. This can be done without needing permission from the host of the original public object.</p>
<p>Note that I try to avoid mandatory attributes in this tag design. For example, I would not define an audio file as (title=(...), artist=(...), album=(...), rawAudioData=(...)). Because if it were defined this way, then it becomes impossible to represent facts like “this song has titles in three languages”, “there is no artist because it was published anonymously”, or “the name of the album is disputed”.</p>
</dd>
<dt id="everything-is-a-file">Everything is a file</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/chat-message-files.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/chat-message-files.svg" alt="" style="width:12em"/></a>
</div>
<p>Every fact that can be captured about the world should be expressed as a discrete file. For example, every message in a conversation should be its own file (the overhead can be dealt with later) – not as a line of text within a monolithic mutable text file. A program’s source code could have one file per function, with the documentation comments in a separate file; these files can be woven together into a legacy-format source file to feed into existing compiler tools. If we’re talking about temperature measurements, every measured sample should be a separate file (again, instead of adding a line to a long text file). Every recorded financial transaction should be its own file.</p>
<p>This notion here is orthogonal to <a href="https://en.wikipedia.org/wiki/Everything_is_a_file" title="Wikipedia: Everything is a file">Unix’s concept of “everything is a file”</a> – there, the idea is that every path should be readable and writable as a stream of bytes, even if the “file” is actually a mouse device or a network socket. In fact, the Unix concept doesn’t even apply to my proposal, because my notion of a file is an immutable, finite sequence of bytes – not a potentially bidirectional I/O pipe with fancy control functions.</p>
</dd>
<dt id="data-schemas">Data schemas</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/schemas.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/schemas.svg" alt="" style="width:20em"/></a>
</div>
<p>As soon as we moved beyond simple tags and into complex tags, we realize that not all files are created equal. For example, the first phase of the tag query looked for tags of the form (string tagName, Sha256 tagCore), whereas the second phase looked for tags of the form (Sha256 fileBeingTagged, Sha256 tagCore). It would be helpful to develop a strong typing scheme that lets us precisely target the data that we want and exclude the data that we don’t want. In particular, ad hoc file formats and heuristic/conservative scanning/matching are viewed as ugly compromises. Another reason why we might want to have schemas is to be able to find the set of all files <var>F</var> that contain a hash reference to some file <var>G</var>. To do this we need to be able to decode every file and know where its link fields are located, which implies some sort of schema.</p>
<p>The current situation with distinguishing file formats is bad enough already, relying on a mixture of file extensions (e.g. .zip), magic file headers (e.g. fLaC), <a href="https://en.wikipedia.org/wiki/Media_type" title="Wikipedia: Media type">Internet media types</a> (a.k.a. MIME) (e.g. text/html), and other proprietary systems like <a href="https://en.wikipedia.org/wiki/Uniform_Type_Identifier" title="Wikipedia: Uniform Type Identifier">Apple UTIs</a> (e.g. org.oasis.opendocument.text). My proposed system worsens the situation by introducing many new file types, such as simple tags, tag cores, tag definitions, numeric tags (e.g. song length), and so on. The notion of a schema is mandatory in relational databases, where each row of a table must conform to some user-defined data format (e.g. int id, string name, blob data). Schemas were also tried in SGML, HTML, and XML in the form of <a href="https://en.wikipedia.org/wiki/Document_type_definition" title="Wikipedia: Document type definition">document type definitions (DTDs)</a>, but they seem to be cumbersome, unpopular, and not rigorously checked against. Schemas are a core part of some data serialization formats like Protocol Buffers. One possible design for my proposed system is that each file starts with a 32-byte hash reference to a schema file, and then the rest of the file data conforms to the schema. A schema for all simple tag files might look like this:</p>
<pre>schema version1 SimpleTag {
// Prefixed with number of bytes,
// followed by strict UTF-8 data
string name;
// Field is exactly 32 bytes long
hash target;
}
<p>However this is just a toy example. Complex schemas might allow nested structures, repetition, context-free grammars, data-dependent repetition (e.g. the number <var>n</var>, followed by <var>n</var> copies of some structure). When designing such a schema scheme, a balance needs to be struck between expressiveness, simplicity of implementation, and efficiency (no Turing machines please). Schemas for legacy file formats (say FLAC) will probably do the minimum work possible, simply declaring “this is a schema for FLAC files”, and allowing arbitrary binary data to be in the file. Certainly, it would be a bad idea to completely dissect the structure of metadata, frames, and bit fields in a file format in order to produce a fully featured schema. (In fact, FLAC is a very bad example because to detect where a frame ends, you need to parse and decode Rice-coded audio data to consume the exact correct number of bits.)</p>
<p>There are two major benefits if every file is prefixed with a reference to a schema. One is that it is possible to query all files of a particular type in a precise way – for example “give me all simple tags, and collect the set of all their names”. Another is that it is possible to transform between a collection of same-type files and a relational database table. For example with the simple tag schema, the corresponding database table would be CREATE TABLE SimpleTag(name TEXT NOT NULL, target BLOB NOT NULL), and each tag file corresponds to a database row. Notice that when all tag files are collected as rows in a database table, it is no longer necessary to specify the schema on each file/row individually; the table can be described once with the schema and this saves 32 bytes per tag file. Also when framing schema-based files in terms of database tables and rows, it means all the traditional techniques of database algebra, joins, and indexing can be applied toward information retrieval in my proposed system.</p>
</dd>
<dt id="storage-pools-for-reading">Storage pools for reading</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/storage-pool.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/storage-pool.svg" alt="" style="width:20em"/></a>
</div>
<p>I hate how hierarchical file systems have an obsession about where a file is stored. For example, E:\ might be my external hard drive and /mnt/haruhi might be a remote machine connected through NFS. When I want to browse files, I am first required to navigate to the storage medium that has the file(s) I potentially want. Only then can I actually browse the user-created organization hierarchy. But what if I wanted to browse all photos among all the storage devices currently connected to my computer? Each storage device might have a “Photos” directory in its own root, but the conceptual set of all photos is spread all over places like C:\Photos, E:\Photos, /mnt/haruhi/photos, /mnt/cdrom/photos, etc.</p>
<p>“Ah but you can <a href="https://en.wikipedia.org/wiki/Union_mount" title="Wikipedia: Union mount">union mount</a> everything to one common place”, one might point out. But unions mask problems when two raw directories contain items with the same name but different content (e.g. C:\Photos\0.jpg being different from D:\Photos\0.jpg, and the union can only pick one of them). Unions do not address any of the other problems with hierarchical file organization, make hard and soft links worse, and also make the semantics of mutable files/folders worse.</p>
<p>The proposed non-hierarchical file system fixes the file-reading problem in an elegant way. First we define the storage pool as the set of all available devices that can answer queries and read files. Next we connect devices to the pool – such as our hypothetical E drive, NFS mount, USB flash drive, and so on. Finally when we perform any kind of file query, the computer automatically asks each storage device to retrieve the requested data. For a hash query, the computer could query the fast local disks first and wait for a response before performing more costly network requests – because one answer suffices, and there is no benefit to retrieving a hash-addressed file more than once. For tag queries, the computer would always query all available devices, and probably make the results available incrementally instead of potentially waiting a long time to get complete results. In either case, the onus is on the computer software to query all the storage devices – thus freeing the user from needing to manually remember where she stored a certain file.</p>
<p>Conventional HFSes manage private files by the mechanism of directory and file permissions (ownership, read/write, etc.). However this leaks information because there is always some point up the hierarchy where an unauthorized user knows of the existence of private files. For example, it might be the case that the user directory /home/john is readable by everyone, and the subdirectory /home/john/private is the starting point where only John has read access. I propose to manage private files by storage attachment: if you want to see private files, you need to be able to attach a particular storage device (enforced out of band through OS-level permissions or by encryption). If you have sensitive financial documents stored on a separate device (even if it’s an HDD partition), you can unmount it when you don’t need it, so that a rogue program won’t be able to access the sensitive data.</p>
<p>One consequence of the storage pool concept is that it becomes practical to store a partial set of files for easy access, and attach the full collection when needed. Maybe your laptop only has a small hard drive and can only afford to store the current year’s worth of emails. At the same time, you have the rest of your email history on perhaps an external hard drive or desktop computer. Your email client software should be designed to list email messages from all available storage devices. So normally on your laptop, you only see a small set of emails for this year. But when you add a network share connection to your desktop computer, your email client can query that database as well and show you a longer list of messages. In particular, you did not need to navigate through your desktop computer’s file hierarchy to take those extra emails into account – the file system should automatically consider all the data sources that it currently has access to, when answering application-level queries such as “please list all known email messages”.</p>
<p>Note that the concept of a storage pool is not static; each application/process can have a different storage pool, and even individual queries or subqueries can take place over different pools. This means that for example, a password manager app can be the only one that accesses a privileged storage device containing user passwords. As another example, you might only query a single online storage device and ignore all local files if you specifically wanted to check and manipulate what exists on that online storage.</p>
</dd>
<dt id="storage-icons-for-status-writing">Storage icons for status/writing</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/storage-icons.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/storage-icons.svg" alt="" style="width:20em"/></a>
</div>
<p>The concept of querying all attached storage devices works for reading files, but writing files needs more consideration. Here’s an idea: while a file is open in a viewer/editor, show an icon for each attached storage device. An icon should be green if a file is already stored on a device, gray if a file isn’t on the device but could be added, and red if a file isn’t on the device and can’t be added (e.g. read-only drive). While you are looking at a file, you can save it to one of your devices by simply clicking the appropriate storage icon. Click the C drive icon to save it onto that physical hard disk. Click the USB icon to save it to an attached flash drive. Click the cloud icon to save it to your favorite cloud storage provider.</p>
<p>This system actually already partially exists in the form of web browser bookmarks in Google Chrome and Mozilla Firefox. Beside the address bar is a star icon that is either empty or filled. When you visit a particular web page and its URL is not in your set of bookmarks, the star icon is empty. Clicking the icon will add the current URL to your bookmarks, and the star icon becomes filled. If you navigate to a page that is already in your bookmarks, then the star icon is filled. When you click on a filled star icon, it prompts you to edit that bookmark’s metadata (page title, categorization, etc.) and also allows you to remove the bookmark (which turns the star empty).</p>
<p>I believe this system is much more streamlined and intuitive than the classic save-file dialog window for HFSes – which forces you to navigate a hierarchy of drives and subfolders, and to give a unique name to the new file being saved. My proposal, behaving just like the web browser bookmarks, only requires you to click the save icon once (per drive). There are no names to be entered, and any further interaction such as editing metadata is strictly optional. Note that even if the user enters no metadata, the computer can automatically add tags based on the file type (e.g. PDF, AVI) and based on the current date and time (allowing you to query “What is the set of all files I saved on Dec 25, 2009?”).</p>
<p>Another benefit of the storage icon system is that you know exactly where your copies are. In a traditional HFS, you can be currently looking at /Photos/Taiwan/00.jpg but have no idea if you backed it up onto your external HDD or put it onto a USB flash to give to your aunt. You would need to tediously (and error-prone-ly) browse each storage device to somehow look for the alleged file. And if you’re paranoid, you’d also need to check the file content (not just the name, timestamp, and size) to make sure that every byte matches your primary copy. Whereas under my proposed system, querying whether a file exists on each storage device is a first-class feature.</p>
</dd>
<dt id="containers-bundles">Containers/bundles</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/audio-container.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/audio-container.svg" alt="" style="width:12em"/></a>
</div>
<p>In traditional file systems, it is common to bundle a collection of files into a single ZIP or TAR file. My proposed system will generate even more fine-grained files (such as one file per tag), which make containers necessary more often. One mundane use case of containers is to transfer a set of similar files, like a collection of photos. One special use of containers is to put some data and metadata near each other, such as a bundle containing an MP3 file with a bunch of tag files pointing to that MP3 file (by hash of course). Another special use is for file embedding – if a PowerPoint presentation contains a video, the video could either be embedded opaquely into the PPT in a proprietary way, or the PPT and video could exist as separate files and the PPT could contain a reference to the video file. A bundle containing both the PPT and video would ensure that both pieces of data stay together and work together. Out of these three scenarios, the latter two suggest that a container/bundle might want to specify that one of its files is considered “primary” – for example, double-clicking on the music file bundle should play the audio by default and also make the tags visible. (An existing example is that JAR files can specify the main executable class.)</p>
</dd>
<dt id="cyclic-references">Cyclic references</dt>
<dd>
<div class="container floatright clearright">
<a href="/res/designing-better-file-organization-around-tags-not-hierarchies/cyclic-references.svg"><img src="https://www.nayuki.io/res/designing-better-file-organization-around-tags-not-hierarchies/cyclic-references.svg" alt="" style="width:20em"/></a>
</div>
<p>One difficult disadvantage of hash-based file addressing is the inability to create cyclic references. The easiest practical example is that you are creating two web pages a.html and b.html which have links to each other. This is trivial on a hierarchical, mutable file system but needs special acrobatics to work in a hash system. The only solution I can come up with looks like this:</p>
<ul>
<li>First page file (hash=59fe...bad9):<br/>
<code>Lorem ipsum <a href="#slot0">next</a>.</code></li>
<li>Second page file (hash=1cf8...581d):<br/>
<code>Dolor sit amet <a href="#slot1">prev</a>.</code></li>
<li>Link overlay file (no name):<br/>
<code>slot0=1cf8...581d, slot1=59fe...bad9.</code></li>
</ul>
<p>The names “slot0” and “slot1” are arbitrary unique placeholders that we generate. Their values get replaced in memory when the link overlay file is read and processed. Then we put these three files into a container and distribute the container. This idea seems ugly/clumsy and deserves something better.</p>
</dd>
<dt id="externalized-relational-database">Externalized relational database</dt>
<dd>
<p>As hinted in a few places, this entire proposed scheme revolving around files, tags, and queries can be viewed in the light of the relational data model. A file in the proposed system corresponds to a database row. The schema for a file corresponds to which database table the row belongs in. The hash of a file is a de facto primary key. Hash references correspond to foreign key fields. Tag-based queries make heavy use of joins, thus we need table indexes to efficiently find the desired data.</p>
<p>This proposal does necessarily differ somewhat from the relational model. The query domain is flexible, because you can search for files over multiple storage devices instead of just one database table. As a corollary, it means you can temporarily read and query over foreign data without permanently importing it into your local collection. Database rows can be updated in place but hash-addressed files cannot. Every file has a globally unique identity, whereas database rows out in the open cannot use their small integers as primary or foreign keys. And every file can be a reference target, whereas not every database row can easily be referenced (e.g. multi-attribute keys).</p>
</dd>
Open questions
<dt id="choice-of-hash-function">Choice of hash function</dt>
<dd>
<p>The past three decades have shown us that hash functions come and hash functions go. eDonkey2000 (also eMule) is based on the MD4 hash. FLAC files contain an internal MD5 hash. BitTorrent and Git are based on the SHA-1 hash. Bitcoin is based on SHA-256 and RIPEMD-160. As of 2017, MD4 and MD5 were broken long ago, and SHA-1 broke after I started drafting this article but before I published it. But the data systems designed around these hash functions will significantly outlive the secure life of the hash functions. Heavyweight interactive network protocols like SSL/TLS and SSH are designed to allow new cryptographic primitives to be added and old ones removed, but few file and disk formats (if any) have made provisions for changeable hash functions.</p>
<p>For my proposed file organization system, these hash functions are good simple choices:</p>
<ul>
<li><p>SHA-256: In widespread use and currently not known to be broken. Executes fast in software implementations (without needing dedicated hardware). 256 bits should be more than enough space to prevent hash collisions for all of human history going forward. Not immune to length extension attacks because the entire internal hash state is dumped.</p></li>
<li><p>SHA-512/256 (the slash is part of the name): Popular and also unbroken. Executes even faster than SHA-256 when both are run on a 64-bit CPU. 512 bits of security is overkill, so we truncate to 256 bits to save space in every hash reference.</p></li>
<li><p>Whirlpool: Won the recommendation of the NESSIE project, with a similar design to the well-trusted AES cipher. Outputs a 512-bit hash, which we can truncate to 256 bits. Runs reasonably fast in software, and can be greatly sped up with specialized ASIC logic.</p></li>
<li><p>SHA-3 (a.k.a. Keccak): The next-generation hash function to replace the SHA-2 family. It hasn’t gained widespread adoption yet, but we might as well start future-proofing now, eh?</p></li>
</ul>
<p>To make matters more complicated, there are good reasons to use hash trees (a.k.a. Merkle trees) instead of monolithic hashes due to their benefits for large files. It makes it possible to calculate the hash of a large file in parallel, utilizing multiple CPUs and disks/SSDs at once. For network file transfers, it makes it possible to request a full list of hashes at a particular block level (say 1 MiB per block), request small pieces of the file from various sources, and be able to check the validity of said pieces before the whole file has been downloaded. BitTorrent implements most of this, except for the fact that it has a fixed block size per torrent. By using a hash tree instead, a download client can choose to request a list of fine-grained block hashes (say one hash per 32 KiB block) if his network connection is slow, or request a short list of coarse-grained block hashes if his speed is fast (say one hash per 128 MiB for LAN transfers).</p>
<p>The InterPlanetary File System (IPFS) uses the <a href="https://multiformats.io/multihash/">Multihash</a> scheme, where each hash value is prefixed with the name of the algorithm. This makes it possible to add new files that use new hash functions. Although existing files containing hash values from old hash functions are untouched, it means that new files can take advantage of more secure or more efficient new hash functions, when old functions become obsolete. However I think this compromise introduces considerable complexity into the system – for example each file needs to be indexed under multiple hash functions, just in case some hash reference uses an unpopular or outdated hash function. Also, this would likely make the hash value be a variable-length field.</p>
<p>Suppose we picked SHA-256 as the sole hash function for my proposed system, and we produced millions of files and tags with hash references under this scheme. Then we discover that SHA-256 is broken and some security property no longer holds. Maybe a collision was produced, thus two different files have the same hash, and users can’t store both files under the same system, and can’t transfer a different file with the same hash to another user. What would happen next? We could bury our head in the sand and pretend it will never happen. This seems to be what eDonkey2000, BitTorrent, and Git are doing – their hash functions are broken, but they do not plan to upgrade the protocol or file format. For low-value targets that don’t attract motivated attackers, this is a reasonable solution because the vast space of hash values will definitely protect us against any unintentional hash collisions. But since we want to design a good system, it would be nice to exclude this bad scenario entirely. Another solution is to implicitly overlay some new hash function (say SHA3-256) in the same hash space. This forces us to change the semantics of a hash reference – it means every 256-bit hash value of a file is either a legacy SHA-256 hash or a new SHA3-256 hash. When we ingest a new file, we must hash it both ways because a reference using either type of hash is valid. Because hash values are not tagged with the algorithm, it is impossible to tell whether a hash value is generated by SHA-256 or SHA3-256 unless we possess the actual file. If we wanted to eradicate the old SHA-256 hash references, it takes that much more work to identify every file that contains a SHA-256 reference and to produce new files that use SHA3-256 references.</p>
<p>In order to not deal with all this messiness of changing algorithms, the best hope is to choose a hash algorithm that will never be broken in the future. Maybe SHA-3, with its radically different mathematical structure compared to the SHA-2 family (which has all the same high-level structure as SHA-1), will stand the test of time. Maybe Whirlpool (especially after increasing the number of rounds), with its similar structure to AES, will also stand the test of time. Maybe we can take a couple of hash algorithms (e.g. SHA-3 + SHA-512 + Whirlpool) and combine their results using XOR or addition or something – while this would be computationally expensive, hopefully it forces an attacker to break all the underlying primitives in order to have any effect on their combined security.</p>
</dd>
<dt id="hash-string-representation">Hash string representation</dt>
<dd>
<p>Users will see raw hash values for a file at some point or another, period. I do not intend to design a system where files are presented as fully unnamed, only showing their content and tags. Thus, some consideration needs to be given to how hashes are presented. The most conventional and developer-friendly way is to use hexadecimal strings; this requires 2 characters per byte, and Git chooses this approach for its 20-byte hashes. For ASCII strings that are copied and pasted but not read or typed by a human, base64 is a decent idea; this requires 1.33 chars per byte, and YouTube uses this approach for their 8-byte video IDs. Base58 is used by Bitcoin, and is meant for human consumption – it is like base62(sic) but 0, O, I, l are excluded to avoid visual ambiguity – but takes more logic to encode and decode. IPFS uses its own custom encoding scheme that is denser than hexadecimal.</p>
</dd>
<dt id="schema-verification">Schema verification</dt>
<dd>
<p>It is debatable whether every file should have a defined schema and whether every file must be checked against the schema to be accepted for storage. The advantage is that it creates a strong, precise type system where all stored data is known to be valid, and all references can be found and accounted for. The disadvantages include: a file with a new schema requires blocking I/O to pull the schema file for verification (but Internet access might not even be available), it is harder to interoperate with less strict information systems, some references will never fall under a mechanical schema anyway (such as human-readable text in a Word document), and it places onerous demands on the expressiveness of the schema scheme(s).</p>
</dd>
<dt id="containers-as-first-class-files">Containers as first-class files</dt>
<dd>
<p>Containers might serve as ephemeral transport mechanisms, where upon receipt they are unpacked and the individual objects are added to a file system. Or a user might store a container file as-is for the long term, and possibly attach tags to the container. It is unclear to me whether each approach is a good or bad idea. For example, one problem with treating containers as first-class files is that even the slightest variation of a container will create a different file. In the example of a container containing an MP3 and music metadata, simply reordering the files within the container will produce a different container file. Or when tags are applied to a container, it might be inappropriate because the tags are actually meant for the underlying MP3 file, not the container/bundle as a whole.</p>
</dd>
<dt id="legacy-hierarchies">Legacy hierarchies</dt>
<dd>
<p>There is a wealth of good data created in legacy hierarchy systems, and it makes sense to be able to copy/archive that in its native hierarchical form without forcing a human to examine every file to add tags. The tag query data model certainly allows hierarchies to be expressed, but other aspects of the user interface and file utilities need to be able to handle this style of operation. It would also help if there was a common and shared (rather than ad hoc) format for expressing file trees, to avoid the situation where one vendor’s way of mapping hierarchies into my proposed system does not match another vendor’s way of also mapping hierarchies.</p>
<p>Many file formats used by developers presuppose a hierarchical file system. For example, C/C++ code can #include another source file by specifying a path. For example, makefiles declare and handle file paths pervasively. While it is possible to superficially tag each source file under my proposed scheme, it is not possible to follow references within a source file without having an HFS and respecting the semantics such as having unique names. Hence while it is possible to classify and look at source files under a tagging scheme, it is not possible to execute them without an HFS.</p>
</dd>
<dt id="mutable-files">Mutable files</dt>
<dd>
<p>Mutable files are very useful in some cases. Monolithic database files are mutable. Virtual machine disk images are mutable. Incomplete downloads are mutable – and in the case of BitTorrent, the pieces are filled in an arbitrary order.</p>
<p>I think the easiest way to deal with this is to exclude it from my scope. My goal is to design a system that can organize and access a set of independent, timeless facts. The ability to deal with mutable files would only dilute the impact of this system, and introduce multitudes of technical issues regarding data modeling, interoperability, semantics, etc.</p>
<p>Thus, probably the best solution is to have a traditional hierarchical file system for managing mutable files. Once a user is satisfied, she will choose to import the finished files into the immutable tag-oriented data store. And the user should hopefully keep the number of mutable files to a minimum.</p>
<p>An alternative idea is to let the tag-based file system allocate mutable files, returning a long unique ID for each one. A mutable file has read/write/seek/append semantics – this generalness supports use cases like BitTorrent (filling in pieces randomly) and writing multimedia files (writing all the payload, then going back to the header to write the length of the payload). However, these mutable files are meant to be stepping stones, not permanent files. When the mutation on a file is complete, all writers are closed, the file hash is computed, and it is imported into the main storage a hashed file that can be tagged and referenced.</p>
</dd>
<dt id="selecting-metadata">Selecting metadata</dt>
<dd>
<p>If you choose to copy a photo from one storage device to another, which tags pertaining to this photo will also be copied? This question does not have a consistent answer in conventional HFSes (there are many conflicting ad hoc semantics among implementations). There doesn’t appear to be a universal answer in a tag-based system either. There are at least two aspects to the problem. Which types of tags get copied – name tags, title tags, timestamp tags, derivation tags? How deeply should higher-order tags be copied – tag cores, tag implications, notes about tags, etc.?</p>
</dd>
<dt id="query-language">Query language</dt>
<dd>
<p>If the proposed file system only supported simple tags, then tag queries are baked into the API. But with complex and custom tags, how do we express queries regarding files, field values, and references? It is likely that the full power of the relational database model is required to express useful queries. This strongly suggests building such a file system on top of an existing RDBMS to support the necessary functionality smoothly.</p>
</dd>
<dt id="user-interfaces">User interfaces</dt>
<dd>
<p>How will a user interface look like for browsing tags and files? Danbooru, foobar2000, and Adobe Lightroom offer a start, but much more detail needs to be fleshed out. How easy should it be for a user to define custom schemas? Will fully general Boolean searches be allowed? What about implicitly searching and presenting related files? There are many questions to be answered.</p>
</dd>
<dt id="tag-implications">Tag implications</dt>
<dd>
<p>Some tags are naturally or inherently related to other tags. For example, any file associated with the tag core for Madrid (under the complex tagging model) should also be associated with Spain. In a sense, the tag Madrid implies the tag Spain. This can be enforced in an HFS by putting the folder Madrid inside of Spain, although this is not without its problems. On Danbooru, adding some tags automatically adds others – like green hat implies hat. It is unclear to me whether tag implications should be handled by creating and querying an implication graph over the tags, by letting the user interface suggest helpful implications but still making the user decide manually, or by some other mechanism.</p>
</dd>
<dt id="version-control">Version control</dt>
<dd>
<p>It is definitely possible to add tag files to express the notion of versioning. While version control on HFS is quite clear (the model of taking snapshots of a particular directory), it is not clear what should be versioned under the proposed system. Maybe versioning concerns a single file, or a group of files, or a whole storage device. This might be a case where too much freedom and power means there is no obvious solution. However, note that all objects in Git can be expressed and queried in my proposed system, so at the very least it is possible to mimic what Git already does.</p>
</dd>