___ ___ _______ _______ ________________________________________
| | | | | \ / | /
| | | | !___ | | ____! /
| !_! |_ __! | _! !__ /
| || / | | /
!_____ _!!__ \ !_ __! \
| | ___! | | | \
| | | | | | \
!___! !_______/ !___! ____________________________________________\
by Morgan Aldridge [email protected]
43f is a simple date-based storage management utility based on the forty-three
folders concept from David Allen's "Getting Things Done" program. It maintains
43 folders per year (one for every month (12) and one for every possible date in
a month (31), therefore allowing you to store up to 31 daily file sets, 12
monthly file sets, and as many annual file sets as you would like. It is ideal
for managing backup/snapshot sets, but should be flexible enough for any number
of uses.
43f has been tested on Mac OS X and Linux, OpenBSD support is in-progress.
NOTE: 43f is a destructive utility (it is designed to manage--and
therefore delete--files), so please proceed with caution, have a backup,
run the unit tests, and test thoroughly before deploying!
- Bash 3+
- Sebastian Freundt's Dateutils
43f is intended to be fairly transparent in it's functionality, so once
installed & configured (see INSTALLING 43f for details),
you need only move files into various day or month directories within your
43f repository. 43f will then manage the storage nightly.
The basic directory structure will be something like the following (not in alphabetical order for greater clarity):
43f/
|-- 2013/
| |-- d01/
| |-- d02/
| |-- ...
| |-- d30/
| |-- d31/
| |-- m01/
| |-- m02/
| |-- ...
| |-- m11/
| `-- m12/
|-- today/
|-- yesterday/
|-- sunday/
|-- monday/
|-- tuesday/
|-- wednesday/
|-- thursday/
|-- friday/
`-- saturday/
So, you can move (esp. useful when automated) any files into a particular
day or month directory (even better, use the today, yesterday, or
sunday through monday symlinks, when convenient) and 43f will
preserve those within X days, Y months, and Z years worth (as specified
in the configuration file). You can always run 43f stats for disk usage
details.
Run 43f -h or 43f --help for further usage instructions.
[ ] Add logging to `syslog` and/or a file
[ ] Switch from a config file to a hidden .43f directory and .43f/config
file within the repository (like many VCS/SCM implementations use)?
[ ] Smart advance notifications based on disk usage rates gleaned from stats
v0.1 - Initial release.
v0.1.1 - Added optional year parameter to init command. Fixed bug causing old
files to be moved to incorrect month folder on the 1st day of a month.
Files outside the number of months to keep are now rolled properly. Fix
in launchd.plist. Linux support.
v0.1.2 - Fixed bug causing fatal error when moving files to month folder when
destination month was greater than or equal to 8 (August).
v0.1.3 - Fixed bug causing file consolidation to fail for files in an October
month folder.
v0.1.4 - Fixed disk usage statistics calculation bugs.
v0.1.5 - Automatically create new year directory on 1st of year.
v0.1.6 - Fixed bug causing daily files to be moved to month folders in current
year instead of previous year when crossing year boundary within past
31 days. Fixed bug preventing files from being consolidated in monthly
folders from previous years.
v0.1.7 - Fixed bug in Linux date parsing which failed for the month of October,
causing issues similar to those fixed in v0.1.3.
v0.1.8 - Fixed bug causing convenience symlinks to not correctly link to
previous year directories during the first week of January.
v0.1.9 - Cross platform compatibility updates, esp. for OpenBSD.
v0.1.10 - Fix for OpenBSD compatibility when consolidating files.
v0.2 - Don't create repository symlinks in dry-run mode or if repo isn't
initialized. Fix zero date offset calculations on OpenBSD. Support
long TLDs in notify lines in config file. Improved functions input
validation. Fix too few days' data kept if previous month's length
is less than days to keep.
v0.2.1 - Fixed bug causing monthly archives to be incorrectly moved to current
month directory.
v0.2.2 - Fixed errors in stats command.
v0.2.3 - Fixed potential function input validation issue. Minor refactor of
verbose output.
v0.2.4 - Fixed errors in validating days & months with leading zeros.
v0.3 - Added command line & configuration file options for
specifying file mode for repository & subdirectories.
Naturally, I wouldn't have envisioned this without David Allen's "Getting Things Done" program (books & CDs) or the GTD craze sparked in the mid-2000's and further fueled by the likes of Merlin Mann.
The concept and some very early code was collecting dust in a proverbial pile on my hard drive until Small Dog Electronics agreed to sponsor further development for internal use. It may never have seen the light of day otherwise.
Development and troubleshooting was greatly simplified by the use of Rocky
Bernstein's bashdb debugger for bash.
Functional tests are implemented using Blake Mizerany's roundup.
NOTE: Since 43f relies so heavily on date calculations, there are some
functional tests that will change & restore your system's date & time, however
these tests are disabled by default (look for xit_ tests).
Copyright (c) 2009-2022, Morgan Aldridge. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.