Merge branch 'SNSv2' into HEAD
This commit is contained in:
Jon-William Lewis
339
LICENSE
339
LICENSE
@@ -1,339 +0,0 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 2, June 1991
|
|
||||||
|
|
||||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
|
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The licenses for most software are designed to take away your
|
|
||||||
freedom to share and change it. By contrast, the GNU General Public
|
|
||||||
License is intended to guarantee your freedom to share and change free
|
|
||||||
software--to make sure the software is free for all its users. This
|
|
||||||
General Public License applies to most of the Free Software
|
|
||||||
Foundation's software and to any other program whose authors commit to
|
|
||||||
using it. (Some other Free Software Foundation software is covered by
|
|
||||||
the GNU Lesser General Public License instead.) You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
this service if you wish), that you receive source code or can get it
|
|
||||||
if you want it, that you can change the software or use pieces of it
|
|
||||||
in new free programs; and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to make restrictions that forbid
|
|
||||||
anyone to deny you these rights or to ask you to surrender the rights.
|
|
||||||
These restrictions translate to certain responsibilities for you if you
|
|
||||||
distribute copies of the software, or if you modify it.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must give the recipients all the rights that
|
|
||||||
you have. You must make sure that they, too, receive or can get the
|
|
||||||
source code. And you must show them these terms so they know their
|
|
||||||
rights.
|
|
||||||
|
|
||||||
We protect your rights with two steps: (1) copyright the software, and
|
|
||||||
(2) offer you this license which gives you legal permission to copy,
|
|
||||||
distribute and/or modify the software.
|
|
||||||
|
|
||||||
Also, for each author's protection and ours, we want to make certain
|
|
||||||
that everyone understands that there is no warranty for this free
|
|
||||||
software. If the software is modified by someone else and passed on, we
|
|
||||||
want its recipients to know that what they have is not the original, so
|
|
||||||
that any problems introduced by others will not reflect on the original
|
|
||||||
authors' reputations.
|
|
||||||
|
|
||||||
Finally, any free program is threatened constantly by software
|
|
||||||
patents. We wish to avoid the danger that redistributors of a free
|
|
||||||
program will individually obtain patent licenses, in effect making the
|
|
||||||
program proprietary. To prevent this, we have made it clear that any
|
|
||||||
patent must be licensed for everyone's free use or not licensed at all.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
||||||
|
|
||||||
0. This License applies to any program or other work which contains
|
|
||||||
a notice placed by the copyright holder saying it may be distributed
|
|
||||||
under the terms of this General Public License. The "Program", below,
|
|
||||||
refers to any such program or work, and a "work based on the Program"
|
|
||||||
means either the Program or any derivative work under copyright law:
|
|
||||||
that is to say, a work containing the Program or a portion of it,
|
|
||||||
either verbatim or with modifications and/or translated into another
|
|
||||||
language. (Hereinafter, translation is included without limitation in
|
|
||||||
the term "modification".) Each licensee is addressed as "you".
|
|
||||||
|
|
||||||
Activities other than copying, distribution and modification are not
|
|
||||||
covered by this License; they are outside its scope. The act of
|
|
||||||
running the Program is not restricted, and the output from the Program
|
|
||||||
is covered only if its contents constitute a work based on the
|
|
||||||
Program (independent of having been made by running the Program).
|
|
||||||
Whether that is true depends on what the Program does.
|
|
||||||
|
|
||||||
1. You may copy and distribute verbatim copies of the Program's
|
|
||||||
source code as you receive it, in any medium, provided that you
|
|
||||||
conspicuously and appropriately publish on each copy an appropriate
|
|
||||||
copyright notice and disclaimer of warranty; keep intact all the
|
|
||||||
notices that refer to this License and to the absence of any warranty;
|
|
||||||
and give any other recipients of the Program a copy of this License
|
|
||||||
along with the Program.
|
|
||||||
|
|
||||||
You may charge a fee for the physical act of transferring a copy, and
|
|
||||||
you may at your option offer warranty protection in exchange for a fee.
|
|
||||||
|
|
||||||
2. You may modify your copy or copies of the Program or any portion
|
|
||||||
of it, thus forming a work based on the Program, and copy and
|
|
||||||
distribute such modifications or work under the terms of Section 1
|
|
||||||
above, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) You must cause the modified files to carry prominent notices
|
|
||||||
stating that you changed the files and the date of any change.
|
|
||||||
|
|
||||||
b) You must cause any work that you distribute or publish, that in
|
|
||||||
whole or in part contains or is derived from the Program or any
|
|
||||||
part thereof, to be licensed as a whole at no charge to all third
|
|
||||||
parties under the terms of this License.
|
|
||||||
|
|
||||||
c) If the modified program normally reads commands interactively
|
|
||||||
when run, you must cause it, when started running for such
|
|
||||||
interactive use in the most ordinary way, to print or display an
|
|
||||||
announcement including an appropriate copyright notice and a
|
|
||||||
notice that there is no warranty (or else, saying that you provide
|
|
||||||
a warranty) and that users may redistribute the program under
|
|
||||||
these conditions, and telling the user how to view a copy of this
|
|
||||||
License. (Exception: if the Program itself is interactive but
|
|
||||||
does not normally print such an announcement, your work based on
|
|
||||||
the Program is not required to print an announcement.)
|
|
||||||
|
|
||||||
These requirements apply to the modified work as a whole. If
|
|
||||||
identifiable sections of that work are not derived from the Program,
|
|
||||||
and can be reasonably considered independent and separate works in
|
|
||||||
themselves, then this License, and its terms, do not apply to those
|
|
||||||
sections when you distribute them as separate works. But when you
|
|
||||||
distribute the same sections as part of a whole which is a work based
|
|
||||||
on the Program, the distribution of the whole must be on the terms of
|
|
||||||
this License, whose permissions for other licensees extend to the
|
|
||||||
entire whole, and thus to each and every part regardless of who wrote it.
|
|
||||||
|
|
||||||
Thus, it is not the intent of this section to claim rights or contest
|
|
||||||
your rights to work written entirely by you; rather, the intent is to
|
|
||||||
exercise the right to control the distribution of derivative or
|
|
||||||
collective works based on the Program.
|
|
||||||
|
|
||||||
In addition, mere aggregation of another work not based on the Program
|
|
||||||
with the Program (or with a work based on the Program) on a volume of
|
|
||||||
a storage or distribution medium does not bring the other work under
|
|
||||||
the scope of this License.
|
|
||||||
|
|
||||||
3. You may copy and distribute the Program (or a work based on it,
|
|
||||||
under Section 2) in object code or executable form under the terms of
|
|
||||||
Sections 1 and 2 above provided that you also do one of the following:
|
|
||||||
|
|
||||||
a) Accompany it with the complete corresponding machine-readable
|
|
||||||
source code, which must be distributed under the terms of Sections
|
|
||||||
1 and 2 above on a medium customarily used for software interchange; or,
|
|
||||||
|
|
||||||
b) Accompany it with a written offer, valid for at least three
|
|
||||||
years, to give any third party, for a charge no more than your
|
|
||||||
cost of physically performing source distribution, a complete
|
|
||||||
machine-readable copy of the corresponding source code, to be
|
|
||||||
distributed under the terms of Sections 1 and 2 above on a medium
|
|
||||||
customarily used for software interchange; or,
|
|
||||||
|
|
||||||
c) Accompany it with the information you received as to the offer
|
|
||||||
to distribute corresponding source code. (This alternative is
|
|
||||||
allowed only for noncommercial distribution and only if you
|
|
||||||
received the program in object code or executable form with such
|
|
||||||
an offer, in accord with Subsection b above.)
|
|
||||||
|
|
||||||
The source code for a work means the preferred form of the work for
|
|
||||||
making modifications to it. For an executable work, complete source
|
|
||||||
code means all the source code for all modules it contains, plus any
|
|
||||||
associated interface definition files, plus the scripts used to
|
|
||||||
control compilation and installation of the executable. However, as a
|
|
||||||
special exception, the source code distributed need not include
|
|
||||||
anything that is normally distributed (in either source or binary
|
|
||||||
form) with the major components (compiler, kernel, and so on) of the
|
|
||||||
operating system on which the executable runs, unless that component
|
|
||||||
itself accompanies the executable.
|
|
||||||
|
|
||||||
If distribution of executable or object code is made by offering
|
|
||||||
access to copy from a designated place, then offering equivalent
|
|
||||||
access to copy the source code from the same place counts as
|
|
||||||
distribution of the source code, even though third parties are not
|
|
||||||
compelled to copy the source along with the object code.
|
|
||||||
|
|
||||||
4. You may not copy, modify, sublicense, or distribute the Program
|
|
||||||
except as expressly provided under this License. Any attempt
|
|
||||||
otherwise to copy, modify, sublicense or distribute the Program is
|
|
||||||
void, and will automatically terminate your rights under this License.
|
|
||||||
However, parties who have received copies, or rights, from you under
|
|
||||||
this License will not have their licenses terminated so long as such
|
|
||||||
parties remain in full compliance.
|
|
||||||
|
|
||||||
5. You are not required to accept this License, since you have not
|
|
||||||
signed it. However, nothing else grants you permission to modify or
|
|
||||||
distribute the Program or its derivative works. These actions are
|
|
||||||
prohibited by law if you do not accept this License. Therefore, by
|
|
||||||
modifying or distributing the Program (or any work based on the
|
|
||||||
Program), you indicate your acceptance of this License to do so, and
|
|
||||||
all its terms and conditions for copying, distributing or modifying
|
|
||||||
the Program or works based on it.
|
|
||||||
|
|
||||||
6. Each time you redistribute the Program (or any work based on the
|
|
||||||
Program), the recipient automatically receives a license from the
|
|
||||||
original licensor to copy, distribute or modify the Program subject to
|
|
||||||
these terms and conditions. You may not impose any further
|
|
||||||
restrictions on the recipients' exercise of the rights granted herein.
|
|
||||||
You are not responsible for enforcing compliance by third parties to
|
|
||||||
this License.
|
|
||||||
|
|
||||||
7. If, as a consequence of a court judgment or allegation of patent
|
|
||||||
infringement or for any other reason (not limited to patent issues),
|
|
||||||
conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot
|
|
||||||
distribute so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you
|
|
||||||
may not distribute the Program at all. For example, if a patent
|
|
||||||
license would not permit royalty-free redistribution of the Program by
|
|
||||||
all those who receive copies directly or indirectly through you, then
|
|
||||||
the only way you could satisfy both it and this License would be to
|
|
||||||
refrain entirely from distribution of the Program.
|
|
||||||
|
|
||||||
If any portion of this section is held invalid or unenforceable under
|
|
||||||
any particular circumstance, the balance of the section is intended to
|
|
||||||
apply and the section as a whole is intended to apply in other
|
|
||||||
circumstances.
|
|
||||||
|
|
||||||
It is not the purpose of this section to induce you to infringe any
|
|
||||||
patents or other property right claims or to contest validity of any
|
|
||||||
such claims; this section has the sole purpose of protecting the
|
|
||||||
integrity of the free software distribution system, which is
|
|
||||||
implemented by public license practices. Many people have made
|
|
||||||
generous contributions to the wide range of software distributed
|
|
||||||
through that system in reliance on consistent application of that
|
|
||||||
system; it is up to the author/donor to decide if he or she is willing
|
|
||||||
to distribute software through any other system and a licensee cannot
|
|
||||||
impose that choice.
|
|
||||||
|
|
||||||
This section is intended to make thoroughly clear what is believed to
|
|
||||||
be a consequence of the rest of this License.
|
|
||||||
|
|
||||||
8. If the distribution and/or use of the Program is restricted in
|
|
||||||
certain countries either by patents or by copyrighted interfaces, the
|
|
||||||
original copyright holder who places the Program under this License
|
|
||||||
may add an explicit geographical distribution limitation excluding
|
|
||||||
those countries, so that distribution is permitted only in or among
|
|
||||||
countries not thus excluded. In such case, this License incorporates
|
|
||||||
the limitation as if written in the body of this License.
|
|
||||||
|
|
||||||
9. The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program
|
|
||||||
specifies a version number of this License which applies to it and "any
|
|
||||||
later version", you have the option of following the terms and conditions
|
|
||||||
either of that version or of any later version published by the Free
|
|
||||||
Software Foundation. If the Program does not specify a version number of
|
|
||||||
this License, you may choose any version ever published by the Free Software
|
|
||||||
Foundation.
|
|
||||||
|
|
||||||
10. If you wish to incorporate parts of the Program into other free
|
|
||||||
programs whose distribution conditions are different, write to the author
|
|
||||||
to ask for permission. For software which is copyrighted by the Free
|
|
||||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
||||||
make exceptions for this. Our decision will be guided by the two goals
|
|
||||||
of preserving the free status of all derivatives of our free software and
|
|
||||||
of promoting the sharing and reuse of software generally.
|
|
||||||
|
|
||||||
NO WARRANTY
|
|
||||||
|
|
||||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
||||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
||||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
||||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
||||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
||||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
||||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
||||||
REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
||||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
||||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
||||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
||||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
||||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
||||||
POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
convey the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
{description}
|
|
||||||
Copyright (C) {year} {fullname}
|
|
||||||
|
|
||||||
This program is free software; you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation; either version 2 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along
|
|
||||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program is interactive, make it output a short notice like this
|
|
||||||
when it starts in an interactive mode:
|
|
||||||
|
|
||||||
Gnomovision version 69, Copyright (C) year name of author
|
|
||||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, the commands you use may
|
|
||||||
be called something other than `show w' and `show c'; they could even be
|
|
||||||
mouse-clicks or menu items--whatever suits your program.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or your
|
|
||||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
|
||||||
necessary. Here is a sample; alter the names:
|
|
||||||
|
|
||||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
|
||||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
||||||
|
|
||||||
{signature of Ty Coon}, 1 April 1989
|
|
||||||
Ty Coon, President of Vice
|
|
||||||
|
|
||||||
This General Public License does not permit incorporating your program into
|
|
||||||
proprietary programs. If your program is a subroutine library, you may
|
|
||||||
consider it more useful to permit linking proprietary applications with the
|
|
||||||
library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License.
|
|
||||||
67
README.md
Normal file
67
README.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
Simple Note System
|
||||||
|
==================
|
||||||
|
|
||||||
|
## About
|
||||||
|
The Simple Note System is a shell script partially inspired by [pass], in that
|
||||||
|
it stores notes as normal, plaintext, files in normal folders. It uses the
|
||||||
|
environment-specified editor, and can be configured to use GPG encryption.
|
||||||
|
|
||||||
|
SNS was originally conceived one morning during an update to a popular note-taking
|
||||||
|
app. The thought occurred that a note system need not reinvent the wheel with
|
||||||
|
its own GUI editor and proprietary file format, but instead could use the tools
|
||||||
|
already provided by the operating system.
|
||||||
|
|
||||||
|
As it developed, OpenSSL encryption was dropped in favor of GPG, and the script
|
||||||
|
was almost entirely rewritten as SNSv2.
|
||||||
|
|
||||||
|
simple note system
|
||||||
|
==================
|
||||||
|
|
||||||
|
usage: sns [-cedp] NAME NOTEBOOK SECTION
|
||||||
|
sns [-l] NOTEBOOK
|
||||||
|
sns [-hi]
|
||||||
|
-c | --create : Create note
|
||||||
|
-d | --delete : Delete note
|
||||||
|
-e | --edit : Open note for editing
|
||||||
|
-h | --help : Display this message
|
||||||
|
-p | --print : Print note to console
|
||||||
|
-l | --list : List all notes in NOTEBOOK
|
||||||
|
-i | --init : Write default config and initalize SNS store"
|
||||||
|
|
||||||
|
## Installing
|
||||||
|
To install, place `sns.sh` in your path, and copy `src/bash-completion/sns`
|
||||||
|
to `/usr/share/bash-completion/completions/sns`.
|
||||||
|
|
||||||
|
Or simply run `./install.sh`.
|
||||||
|
|
||||||
|
To uninstall, remove the files you copied, or run `./install.sh --uninstall`
|
||||||
|
|
||||||
|
Once installed, SNS will require you to run `sns -i`, to indicate you would like
|
||||||
|
to create its note store and write its default configuration.
|
||||||
|
|
||||||
|
By default, SNS will set itself up in `~/.config/sns`, with `~/.config/sns/sns.conf`
|
||||||
|
as its configuration file.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
In SNS's configuration file, you can change the editor SNS uses, along with
|
||||||
|
the date format used in notes, and whether or not to use GPG encryption.
|
||||||
|
|
||||||
|
**A word about encryption**: Enabling encryption will cause problems if
|
||||||
|
previously un-encrypted notes exist. In the future, I'd like to resolve these,
|
||||||
|
however for the time being it's best to decide when you install SNS if you'd
|
||||||
|
like to enable encryption or not.
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
The majority of the code here is my own, however the bash completion
|
||||||
|
code comes from [pass], the standard UNIX package manager, along with some
|
||||||
|
design and feature ideas.
|
||||||
|
|
||||||
|
## License
|
||||||
|
Simple Note System is licensed under the terms of the GNU General Public License
|
||||||
|
Version 2, as detailed in `LICENSE`.
|
||||||
|
|
||||||
|
## Bugs
|
||||||
|
If something seems off, or just doesn't work, please open an issue and I'll look
|
||||||
|
into it.
|
||||||
|
|
||||||
|
[pass]: http://passwordstore.org
|
||||||
22
errors.md
Normal file
22
errors.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# Simple Note System, version 2
|
||||||
|
## Error Code Reference
|
||||||
|
|
||||||
|
### General Codes
|
||||||
|
| Name | Code | Meaning |
|
||||||
|
|--------------|------|---------------------------------------|
|
||||||
|
| ERR_NO_STORE | 5 | the SNS store needs to be initialized |
|
||||||
|
| ERR_NO_ARGS | 10 | No arguments were specified |
|
||||||
|
| ERR_NO_OP | 20 | No operation was specified |
|
||||||
|
| ERR_NO_NOTE | 30 | A required argument was not provided |
|
||||||
|
|
||||||
|
### Encryption-related codes
|
||||||
|
|Name | Code | Meaning |
|
||||||
|
|------------|------|-------------------------------------------------------|
|
||||||
|
| ERR_NO_GPG | 100 | Encryption is enabled, but GPG is not installed |
|
||||||
|
| ERR_NO_KEY | 110 | Encryption is enabled, but no recipient was specified |
|
||||||
|
|
||||||
|
### Creation-related codes
|
||||||
|
|Name | Code | Meaning |
|
||||||
|
|-----------------|------|-----------------------------------|
|
||||||
|
| ERR_NOTE_EXiSTS | 200 | The specified note already exists |
|
||||||
|
| ERR_NOTE_NO_READ| 205 | The specified note cannot be read |
|
||||||
42
header.sh
Normal file
42
header.sh
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
PROD_STR="Simple Note System"
|
||||||
|
VER_STR="v2.0a9"
|
||||||
|
YEAR=2016
|
||||||
|
|
||||||
|
cat << EOF
|
||||||
|
#!/bin/bash
|
||||||
|
# Simple Note System
|
||||||
|
# Copyright (C) 2016, Jon Lewis
|
||||||
|
#
|
||||||
|
# This program is free software; you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation; either version 2 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License along
|
||||||
|
# with this program; if not, write to the Free Software Foundation, Inc.,
|
||||||
|
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||||
|
|
||||||
|
# Prevent freak accidents involving the root directory
|
||||||
|
if [ -z "\$HOME" ]; then HOME=/home/"\$(whoami)"; fi
|
||||||
|
|
||||||
|
# Store files and locations
|
||||||
|
readonly PROD_STR="$PROD_STR"
|
||||||
|
readonly VER_STR="$VER_STR"
|
||||||
|
readonly ROOT_DIR="\$HOME"/.config/sns
|
||||||
|
readonly NOTES_DIR="\$ROOT_DIR"/notes
|
||||||
|
readonly TMP_DIR="\$ROOT_DIR"/tmp
|
||||||
|
readonly CONFIG_FILE="\$ROOT_DIR/sns.conf"
|
||||||
|
|
||||||
|
#Color codes for error reporting
|
||||||
|
readonly RED_COLOR='\033[1;31m'
|
||||||
|
readonly RESET_COLOR='\033[0m'
|
||||||
|
|
||||||
|
#Print the program header to stdout
|
||||||
|
printf "%s\n" "\$PROD_STR"
|
||||||
|
printf "%s\n" "------------------"
|
||||||
|
EOF
|
||||||
57
install.sh
Executable file
57
install.sh
Executable file
@@ -0,0 +1,57 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# Simple Note System - Install Script
|
||||||
|
# Copyright (C) 2016, Jon Lewis
|
||||||
|
#
|
||||||
|
# This program is free software; you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation; either version 2 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License along
|
||||||
|
# with this program; if not, write to the Free Software Foundation, Inc.,
|
||||||
|
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||||
|
|
||||||
|
if [ "$1" == "--uninstall" ]; then
|
||||||
|
rm /bin/sns
|
||||||
|
rm /usr/share/bash-completion/completions/sns
|
||||||
|
exit
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir build
|
||||||
|
|
||||||
|
S=build/sns.sh
|
||||||
|
|
||||||
|
bash header.sh > "$S"
|
||||||
|
echo -e "\n# Section: Functions" >> "$S"
|
||||||
|
cat ./src/includes/init_store.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/verify_store.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/help.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/p_header.sh >> "$S"
|
||||||
|
cat ./src/includes/libencryption.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/create.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/delete.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/edit.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/print.sns.sh >> "$S"
|
||||||
|
cat ./src/includes/list.sns.sh >> "$S"
|
||||||
|
printf "%s\n" "# End Section: Functions" >> "$S"
|
||||||
|
cat ./src/main/stage1.sns.sh >> "$S"
|
||||||
|
cat ./src/main/stage2.sns.sh >> "$S"
|
||||||
|
cat ./src/main/stage3.sns.sh >> "$S"
|
||||||
|
|
||||||
|
chmod u+x "$S"
|
||||||
|
# Install SNS
|
||||||
|
if [ ! -r "/bin/sns" ] || [ grep "Simple Note System" < "/bin/sns" ];
|
||||||
|
sudo cp "$S" > "/bin/sns"
|
||||||
|
fi
|
||||||
|
# Install Bash completion
|
||||||
|
if [ ! -r "/usr/share/bash-completion/completions/sns" ]\
|
||||||
|
|| [ grep "Simple Note System" < "/usr/share/bash-completion/completions/sns" ]; then
|
||||||
|
sudo cp "src/bash-completion/sns" >\
|
||||||
|
"/usr/share/bash-completion/completions/sns"
|
||||||
|
fi
|
||||||
|
exit
|
||||||
132
sns.xcodeproj/project.pbxproj
Normal file
132
sns.xcodeproj/project.pbxproj
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
// !$*UTF8*$!
|
||||||
|
{
|
||||||
|
archiveVersion = 1;
|
||||||
|
classes = {
|
||||||
|
};
|
||||||
|
objectVersion = 46;
|
||||||
|
objects = {
|
||||||
|
|
||||||
|
/* Begin PBXFileReference section */
|
||||||
|
5D22D6A21AFC4F5A0036DC52 /* create.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = create.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6A31AFC4F5A0036DC52 /* delete.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = delete.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6A41AFC4F5A0036DC52 /* edit.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = edit.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6A51AFC4F5A0036DC52 /* help.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = help.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6A71AFC4F5A0036DC52 /* list.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = list.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6A81AFC4F5A0036DC52 /* p_header.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = p_header.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6A91AFC4F5A0036DC52 /* pause.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = pause.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6AA1AFC4F5A0036DC52 /* print.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = print.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6AB1AFC4F5A0036DC52 /* init_store.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = init_store.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6AD1AFC4F5A0036DC52 /* stage1.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage1.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6AE1AFC4F5A0036DC52 /* stage2.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage2.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6AF1AFC4F5A0036DC52 /* stage3.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage3.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D22D6B01AFC5B100036DC52 /* libencryption.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = libencryption.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D75D24F1C5F13DF001E7B33 /* verify_store.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = verify_store.sns.sh; sourceTree = "<group>"; };
|
||||||
|
5D7E611F1AB74D33001D49B9 /* build.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = build.sh; sourceTree = "<group>"; };
|
||||||
|
5D7E91FB1B27FB620030B30D /* header.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = header.sh; sourceTree = "<group>"; };
|
||||||
|
5DE839831AB9DACE006CB4F6 /* sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = sns.sh; sourceTree = "<group>"; };
|
||||||
|
5DE839881ABA04DD006CB4F6 /* errors.ref */ = {isa = PBXFileReference; lastKnownFileType = text; path = errors.ref; sourceTree = "<group>"; };
|
||||||
|
/* End PBXFileReference section */
|
||||||
|
|
||||||
|
/* Begin PBXGroup section */
|
||||||
|
5D22D6A01AFC4F5A0036DC52 /* src */ = {
|
||||||
|
isa = PBXGroup;
|
||||||
|
children = (
|
||||||
|
5D22D6A11AFC4F5A0036DC52 /* includes */,
|
||||||
|
5D22D6AC1AFC4F5A0036DC52 /* main */,
|
||||||
|
);
|
||||||
|
path = src;
|
||||||
|
sourceTree = "<group>";
|
||||||
|
};
|
||||||
|
5D22D6A11AFC4F5A0036DC52 /* includes */ = {
|
||||||
|
isa = PBXGroup;
|
||||||
|
children = (
|
||||||
|
5D22D6A21AFC4F5A0036DC52 /* create.sns.sh */,
|
||||||
|
5D22D6A31AFC4F5A0036DC52 /* delete.sns.sh */,
|
||||||
|
5D22D6A41AFC4F5A0036DC52 /* edit.sns.sh */,
|
||||||
|
5D22D6A51AFC4F5A0036DC52 /* help.sns.sh */,
|
||||||
|
5D22D6A71AFC4F5A0036DC52 /* list.sns.sh */,
|
||||||
|
5D22D6A81AFC4F5A0036DC52 /* p_header.sh */,
|
||||||
|
5D22D6A91AFC4F5A0036DC52 /* pause.sns.sh */,
|
||||||
|
5D22D6AA1AFC4F5A0036DC52 /* print.sns.sh */,
|
||||||
|
5D22D6AB1AFC4F5A0036DC52 /* init_store.sns.sh */,
|
||||||
|
5D22D6B01AFC5B100036DC52 /* libencryption.sns.sh */,
|
||||||
|
5D75D24F1C5F13DF001E7B33 /* verify_store.sns.sh */,
|
||||||
|
);
|
||||||
|
path = includes;
|
||||||
|
sourceTree = "<group>";
|
||||||
|
};
|
||||||
|
5D22D6AC1AFC4F5A0036DC52 /* main */ = {
|
||||||
|
isa = PBXGroup;
|
||||||
|
children = (
|
||||||
|
5D22D6AD1AFC4F5A0036DC52 /* stage1.sns.sh */,
|
||||||
|
5D22D6AE1AFC4F5A0036DC52 /* stage2.sns.sh */,
|
||||||
|
5D22D6AF1AFC4F5A0036DC52 /* stage3.sns.sh */,
|
||||||
|
);
|
||||||
|
path = main;
|
||||||
|
sourceTree = "<group>";
|
||||||
|
};
|
||||||
|
5D7E61181AB74D11001D49B9 = {
|
||||||
|
isa = PBXGroup;
|
||||||
|
children = (
|
||||||
|
5D22D6A01AFC4F5A0036DC52 /* src */,
|
||||||
|
5DE839881ABA04DD006CB4F6 /* errors.ref */,
|
||||||
|
5DE839831AB9DACE006CB4F6 /* sns.sh */,
|
||||||
|
5D7E611F1AB74D33001D49B9 /* build.sh */,
|
||||||
|
5D7E91FB1B27FB620030B30D /* header.sh */,
|
||||||
|
);
|
||||||
|
sourceTree = "<group>";
|
||||||
|
};
|
||||||
|
/* End PBXGroup section */
|
||||||
|
|
||||||
|
/* Begin PBXProject section */
|
||||||
|
5D7E61191AB74D11001D49B9 /* Project object */ = {
|
||||||
|
isa = PBXProject;
|
||||||
|
attributes = {
|
||||||
|
LastUpgradeCheck = 0700;
|
||||||
|
};
|
||||||
|
buildConfigurationList = 5D7E611C1AB74D11001D49B9 /* Build configuration list for PBXProject "sns" */;
|
||||||
|
compatibilityVersion = "Xcode 3.2";
|
||||||
|
developmentRegion = English;
|
||||||
|
hasScannedForEncodings = 0;
|
||||||
|
knownRegions = (
|
||||||
|
en,
|
||||||
|
);
|
||||||
|
mainGroup = 5D7E61181AB74D11001D49B9;
|
||||||
|
projectDirPath = "";
|
||||||
|
projectRoot = "";
|
||||||
|
targets = (
|
||||||
|
);
|
||||||
|
};
|
||||||
|
/* End PBXProject section */
|
||||||
|
|
||||||
|
/* Begin XCBuildConfiguration section */
|
||||||
|
5D7E611D1AB74D11001D49B9 /* Debug */ = {
|
||||||
|
isa = XCBuildConfiguration;
|
||||||
|
buildSettings = {
|
||||||
|
ENABLE_TESTABILITY = YES;
|
||||||
|
ONLY_ACTIVE_ARCH = YES;
|
||||||
|
};
|
||||||
|
name = Debug;
|
||||||
|
};
|
||||||
|
5D7E611E1AB74D11001D49B9 /* Release */ = {
|
||||||
|
isa = XCBuildConfiguration;
|
||||||
|
buildSettings = {
|
||||||
|
};
|
||||||
|
name = Release;
|
||||||
|
};
|
||||||
|
/* End XCBuildConfiguration section */
|
||||||
|
|
||||||
|
/* Begin XCConfigurationList section */
|
||||||
|
5D7E611C1AB74D11001D49B9 /* Build configuration list for PBXProject "sns" */ = {
|
||||||
|
isa = XCConfigurationList;
|
||||||
|
buildConfigurations = (
|
||||||
|
5D7E611D1AB74D11001D49B9 /* Debug */,
|
||||||
|
5D7E611E1AB74D11001D49B9 /* Release */,
|
||||||
|
);
|
||||||
|
defaultConfigurationIsVisible = 0;
|
||||||
|
defaultConfigurationName = Release;
|
||||||
|
};
|
||||||
|
/* End XCConfigurationList section */
|
||||||
|
};
|
||||||
|
rootObject = 5D7E61191AB74D11001D49B9 /* Project object */;
|
||||||
|
}
|
||||||
7
sns.xcodeproj/project.xcworkspace/contents.xcworkspacedata
generated
Normal file
7
sns.xcodeproj/project.xcworkspace/contents.xcworkspacedata
generated
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<Workspace
|
||||||
|
version = "1.0">
|
||||||
|
<FileRef
|
||||||
|
location = "self:sns.xcodeproj">
|
||||||
|
</FileRef>
|
||||||
|
</Workspace>
|
||||||
BIN
sns.xcodeproj/project.xcworkspace/xcuserdata/xilmwa.xcuserdatad/UserInterfaceState.xcuserstate
generated
Normal file
BIN
sns.xcodeproj/project.xcworkspace/xcuserdata/xilmwa.xcuserdatad/UserInterfaceState.xcuserstate
generated
Normal file
Binary file not shown.
@@ -0,0 +1,10 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||||
|
<plist version="1.0">
|
||||||
|
<dict>
|
||||||
|
<key>HasAskedToTakeAutomaticSnapshotBeforeSignificantChanges</key>
|
||||||
|
<true/>
|
||||||
|
<key>SnapshotAutomaticallyBeforeSignificantChanges</key>
|
||||||
|
<true/>
|
||||||
|
</dict>
|
||||||
|
</plist>
|
||||||
96
src/bash-completion/sns
Normal file
96
src/bash-completion/sns
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# Simple Note System, bash completion file
|
||||||
|
# ========================================
|
||||||
|
# Copyright (C) 2016, Jon Lewis <jon.lewis@xenami.net>
|
||||||
|
# Simple Note System is licensed under the GPLv2. Please see LICENSE for more
|
||||||
|
# information.
|
||||||
|
#
|
||||||
|
# **Notice**
|
||||||
|
# This file was adapted from pass, the standard unix password manager under the
|
||||||
|
# terms of the GPLv2 license. Pass may be found at https://passwordstore.org.
|
||||||
|
#
|
||||||
|
# The original file bore the following copyright notice:
|
||||||
|
#
|
||||||
|
# Copyright (C) 2012 - 2014 Jason A. Donenfeld <Jason@zx2c4.com> and
|
||||||
|
# Brian Mattern <rephorm@rephorm.com>. All Rights Reserved.
|
||||||
|
# This file is licensed under the GPLv2+. Please see COPYING for more information.
|
||||||
|
|
||||||
|
_sns_complete_entries () {
|
||||||
|
prefix="${SNS_STORE_DIR:-$HOME/.config/sns/notes/}"
|
||||||
|
suffix=".note"
|
||||||
|
autoexpand=${1:-0}
|
||||||
|
|
||||||
|
local IFS=$'\n'
|
||||||
|
local items=($(compgen -f $prefix$cur))
|
||||||
|
for item in "${items[@]}"; do
|
||||||
|
[[ $item =~ /\.[^/]*$ ]] && continue
|
||||||
|
|
||||||
|
# if there is a unique match, and it is a directory with one entry
|
||||||
|
# autocomplete the subentry as well (recursively)
|
||||||
|
if [[ ${#items[@]} -eq 1 && $autoexpand -eq 1 ]]; then
|
||||||
|
while [[ -d $item ]]; do
|
||||||
|
local subitems=($(compgen -f "$item/"))
|
||||||
|
local filtereditems=( )
|
||||||
|
for item2 in "${subitems[@]}"; do
|
||||||
|
[[ $item2 =~ /\.[^/]*$ ]] && continue
|
||||||
|
filtereditems+=( "$item2" )
|
||||||
|
done
|
||||||
|
if [[ ${#filtereditems[@]} -eq 1 ]]; then
|
||||||
|
item="${filtereditems[0]}"
|
||||||
|
else
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
# append / to directories
|
||||||
|
[[ -d $item ]] && item="$item/"
|
||||||
|
|
||||||
|
item="${item%$suffix}"
|
||||||
|
item="${item%.gpg}"
|
||||||
|
COMPREPLY+=("${item#$prefix}")
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
_sns_complete_folders () {
|
||||||
|
prefix="${SNS_STORE_DIR:-$HOME/.config/sns/notes/}"
|
||||||
|
|
||||||
|
local IFS=$'\n'
|
||||||
|
local items=($(compgen -d $prefix$cur))
|
||||||
|
for item in "${items[@]}"; do
|
||||||
|
[[ $item == $prefix.* ]] && continue
|
||||||
|
COMPREPLY+=("${item#$prefix}/")
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
_sns_complete_keys () {
|
||||||
|
local IFS=$'\n'
|
||||||
|
# Extract names and email addresses from gpg --list-keys
|
||||||
|
local keys="$(gpg2 --list-secret-keys --with-colons | cut -d : -f 10 | sort -u | sed '/^$/d')"
|
||||||
|
COMPREPLY+=($(compgen -W "${keys}" -- ${cur}))
|
||||||
|
}
|
||||||
|
|
||||||
|
_sns()
|
||||||
|
{
|
||||||
|
COMPREPLY=()
|
||||||
|
local cur="${COMP_WORDS[COMP_CWORD]}"
|
||||||
|
local commands="--create --delete --edit --help --print --list --init"
|
||||||
|
if [[ $COMP_CWORD -gt 1 ]]; then
|
||||||
|
local lastarg="${COMP_WORDS[$COMP_CWORD-1]}"
|
||||||
|
case "${COMP_WORDS[1]}" in
|
||||||
|
--list|-l)
|
||||||
|
_sns_complete_folders
|
||||||
|
;;
|
||||||
|
--edit|-e|--print|-p|--delete|-d)
|
||||||
|
_sns_complete_entries
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
else
|
||||||
|
COMPREPLY+=($(compgen -W "${commands}" -- ${cur}))
|
||||||
|
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
complete -o filenames -o nospace -F _sns sns
|
||||||
35
src/includes/create.sns.sh
Normal file
35
src/includes/create.sns.sh
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
function create(){
|
||||||
|
# Depends : p_header
|
||||||
|
# Requires: $NOTE, $NOTE_DIR,
|
||||||
|
# Optional: $ENCRYPTION, $SESSION_ID, $TMP_DIR encrypt
|
||||||
|
# Given a valid setup, create writes the standard note header as specified
|
||||||
|
# by p_header, to $NOTE.
|
||||||
|
|
||||||
|
# Refuse to overwrite a note
|
||||||
|
if [ -e "$NOTES_DIR/$NOTE" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n\t%s\n"\
|
||||||
|
"Note already exists"\
|
||||||
|
"Hint: use -e to edit the note."
|
||||||
|
exit 200
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If the note's notebook/section does not exist,
|
||||||
|
# create the appropriate folders.
|
||||||
|
mkdir -p "$NOTES_DIR"/"$(dirname "$NOTE")"
|
||||||
|
|
||||||
|
# Write the standard note header
|
||||||
|
if [ "$ENCRYPTION" == "TRUE" ]; then
|
||||||
|
TMP_NOTE="$TMP_DIR"/"$SESSION_ID"
|
||||||
|
p_header > "$TMP_NOTE"
|
||||||
|
encrypt
|
||||||
|
else
|
||||||
|
p_header > "$NOTES_DIR/$NOTE"
|
||||||
|
fi
|
||||||
|
# Make sure the note exists, and inform the user of the result.
|
||||||
|
if [ -e "$NOTES_DIR/$NOTE" ]; then
|
||||||
|
printf " - %s\n" "Created note: ${NOTE%.*}"
|
||||||
|
else
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n"\
|
||||||
|
"Something went wrong, and the note was not created."
|
||||||
|
fi
|
||||||
|
}
|
||||||
18
src/includes/delete.sns.sh
Normal file
18
src/includes/delete.sns.sh
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
function delete(){
|
||||||
|
# Requires: $NOTE, $NOTE_DIR
|
||||||
|
# Given a valid $NOTE, delete removes $NOTE from sns.
|
||||||
|
|
||||||
|
if [ -e "$NOTES_DIR/$NOTE" ]; then
|
||||||
|
rm "$NOTES_DIR/$NOTE"
|
||||||
|
printf " - %s\n" "Deleted note: ${NOTE%.*}."
|
||||||
|
#Cleanup empty notebooks/sections]
|
||||||
|
find "$NOTES_DIR" -mindepth 1 -type d | tac |\
|
||||||
|
while read -r DIR ; do
|
||||||
|
if [ ! "$(ls -A $DIR)" ]; then
|
||||||
|
rmdir "$DIR"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
else
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n" "Note ${NOTE%.*} does not exist."
|
||||||
|
fi
|
||||||
|
}
|
||||||
51
src/includes/edit.sns.sh
Normal file
51
src/includes/edit.sns.sh
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
function edit(){
|
||||||
|
# Requires: $EDITOR, $NOTE
|
||||||
|
# Optional: $ENCRYPTION, $TMP_DIR, $SESSION_ID, decrypt, encrypt
|
||||||
|
|
||||||
|
# Verify an editor was specified
|
||||||
|
if [ -z "$EDITOR" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n"\
|
||||||
|
"No editor specified in environment."
|
||||||
|
exit
|
||||||
|
# Verify the note exists
|
||||||
|
elif [ ! -r "$NOTES_DIR/$NOTE" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n"\
|
||||||
|
"Note cannot be opened for editing."
|
||||||
|
exit 40;
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If encryption is enabled, decrypt $NOTE to a temp file, otherwise
|
||||||
|
# operate on the note directly.
|
||||||
|
if [ "$ENCRYPTION" == "TRUE" ]; then
|
||||||
|
cp "$NOTES_DIR/$NOTE" "$NOTES_DIR/$NOTE.bk" #Insurance
|
||||||
|
TMP_NOTE="$TMP_DIR/$SESSION_ID"
|
||||||
|
decrypt > "$TMP_NOTE"
|
||||||
|
else
|
||||||
|
TMP_NOTE="$NOTES_DIR/$NOTE";
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Write an ammendment header
|
||||||
|
if [ -z "$CREATE" ]; then
|
||||||
|
printf "\n%s\n" "edit - $(date "$DATE_FMT")" >> "$TMP_NOTE"
|
||||||
|
printf "%s\n" "===================================" >> "$TMP_NOTE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Call the editor
|
||||||
|
printf " - %s\n" "editing ${NOTE%.*}"
|
||||||
|
"$EDITOR" "$TMP_NOTE"
|
||||||
|
|
||||||
|
# If the file was previously decrypted, encrypt it back
|
||||||
|
if [ "$ENCRYPTION" == "TRUE" ]; then
|
||||||
|
echo "reencrypting"
|
||||||
|
rm "$NOTES_DIR/$NOTE"
|
||||||
|
encrypt;
|
||||||
|
rm "$TMP_NOTE"
|
||||||
|
if [ ! -r "$NOTES_DIR/$NOTE" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n" "error: note was not saved."
|
||||||
|
cp "$NOTES_DIR/$NOTE.bk" "$NOTES_DIR/$NOTE"
|
||||||
|
else
|
||||||
|
rm "$NOTES_DIR/$NOTE.bk";
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
}
|
||||||
14
src/includes/help.sns.sh
Normal file
14
src/includes/help.sns.sh
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
function help {
|
||||||
|
printf "\n%s" "usage: sns [-cedp] NAME NOTEBOOK SECTION"
|
||||||
|
printf "\n%s" " sns [-l] NOTEBOOK"
|
||||||
|
printf "\n%s" " sns [-hi ]"
|
||||||
|
|
||||||
|
printf "\n%s" " -c | --create : Create note"
|
||||||
|
printf "\n%s" " -d | --delete : Delete note"
|
||||||
|
printf "\n%s" " -e | --edit : Open note for editing"
|
||||||
|
printf "\n%s" " -h | --help : Display this message"
|
||||||
|
printf "\n%s" " -p | --print : Print note to console"
|
||||||
|
printf "\n%s" " -l | --list : List all notes in NOTEBOOK"
|
||||||
|
printf "\n%s" " -i | --init : Write default config and initalize SNS store"
|
||||||
|
printf "\n"
|
||||||
|
}
|
||||||
39
src/includes/init_store.sns.sh
Normal file
39
src/includes/init_store.sns.sh
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
function init_store {
|
||||||
|
|
||||||
|
if [ ! -d "$ROOT_DIR" ]; then mkdir -p "$ROOT_DIR"; WILL_INIT="TRUE"; fi
|
||||||
|
if [ ! -d "$TMP_DIR" ]; then mkdir -p "$TMP_DIR" ; WILL_INIT="TRUE"; fi
|
||||||
|
|
||||||
|
|
||||||
|
cat > "$CONFIG_FILE" << EOF
|
||||||
|
# This file contains directives for the Simple Note System.
|
||||||
|
|
||||||
|
EXT=note # File extension to use (for listing notes)
|
||||||
|
|
||||||
|
#EDITOR= # Preferred Editor:
|
||||||
|
# If you would like to specify a different editor for
|
||||||
|
# sns to use, you may do so here, otherwise, sns will
|
||||||
|
# use the editor specified in the environment.
|
||||||
|
|
||||||
|
DATE_FMT="+%D %T" # Date Format:
|
||||||
|
# If you would like to modify the date format, you may
|
||||||
|
# specify one appropriate to the \`date\` command.
|
||||||
|
|
||||||
|
ENCRYPTION="FALSE" # Main Encryption Toggle:
|
||||||
|
# WARNING: ANY PREVIOUSLY UNENCRYPTED NOTES WILL BE LOST
|
||||||
|
# Change this to TRUE to enable encryption.
|
||||||
|
|
||||||
|
PUBKEY="" # Public Key
|
||||||
|
# Encryption is done using GPG. You must enter your
|
||||||
|
# public key's identifier here.
|
||||||
|
EOF
|
||||||
|
|
||||||
|
chmod 600 "$CONFIG_FILE"
|
||||||
|
|
||||||
|
printf " - %s\n" "Rewrote Default Configuration"
|
||||||
|
|
||||||
|
if [ "$WILL_INIT" == "TRUE" ]; then
|
||||||
|
printf " - %s\n" "Environment initialized in $ROOT_DIR"
|
||||||
|
else
|
||||||
|
printf " - %s\n" "Store already initialized."
|
||||||
|
fi
|
||||||
|
}
|
||||||
15
src/includes/libencryption.sns.sh
Normal file
15
src/includes/libencryption.sns.sh
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
function encrypt(){
|
||||||
|
# This function, given a recipient, $PUBKEY; a file to encrypt, $TMP_NOTE; and an
|
||||||
|
# output file, $NOTE, will encrypt $TMP_NOTE to $NOTE against $PUBKEY's private
|
||||||
|
# GPG key.
|
||||||
|
|
||||||
|
gpg -r "$PUBKEY" -o "$NOTES_DIR/$NOTE" -e "$TMP_NOTE"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function decrypt(){
|
||||||
|
# This function, given a file to decrypt, will attempt to decrypt the file
|
||||||
|
# against the specified recipient's private key, and print the result to
|
||||||
|
# stdout.
|
||||||
|
gpg -d "$NOTES_DIR/$NOTE"
|
||||||
|
}
|
||||||
4
src/includes/list.sns.sh
Normal file
4
src/includes/list.sns.sh
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
function list(){
|
||||||
|
# This function, given a folder, $NOTE, will list the contents of $NOTE.
|
||||||
|
ls "$NOTES_DIR/${NOTE%.*}"
|
||||||
|
}
|
||||||
3
src/includes/p_header.sh
Normal file
3
src/includes/p_header.sh
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
function p_header(){
|
||||||
|
printf "# %s\n## %s\n" "$(basename ${NOTE%.*})" "$(date "$DATE_FMT")"
|
||||||
|
}
|
||||||
12
src/includes/print.sns.sh
Normal file
12
src/includes/print.sns.sh
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
function print(){
|
||||||
|
# Given an existing file, $NOTE, print prints the contents of $NOTE to stdout.
|
||||||
|
|
||||||
|
if [ -r "$NOTE" ]; then
|
||||||
|
if [ "$ENCRYPTION" == "TRUE" ]; then decrypt #to stdout
|
||||||
|
else cat "$NOTE"; fi
|
||||||
|
else
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n\t%s\n"\
|
||||||
|
"Note cannot be found."
|
||||||
|
exit 205 #ERR_NOTE_NO_READ
|
||||||
|
fi
|
||||||
|
}
|
||||||
11
src/includes/verify_store.sns.sh
Normal file
11
src/includes/verify_store.sns.sh
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
function verify_store {
|
||||||
|
|
||||||
|
ETC_DIR=$(dirname "$CONFIG_FILE")
|
||||||
|
|
||||||
|
STORE_DIRS=("$ROOT_DIR" "$NOTES_DIR" "$TMP_DIR" "$ETC_DIR")
|
||||||
|
for DIR in "${STORE_DIRS[@]}"; do
|
||||||
|
if [ ! -d "$DIR" ]; then
|
||||||
|
mkdir -p "$DIR"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
24
src/main/stage1.sns.sh
Normal file
24
src/main/stage1.sns.sh
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
#==============================================================================
|
||||||
|
# Stage 1: Read Configuration / Verify Integrity
|
||||||
|
#==============================================================================
|
||||||
|
|
||||||
|
if [ -r "$CONFIG_FILE" ]; then
|
||||||
|
source "$CONFIG_FILE"
|
||||||
|
verify_store
|
||||||
|
elif [ $1 != "-i" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n\t%s\n"\
|
||||||
|
"Configuration not found. Please run sns -i."
|
||||||
|
exit 5 #ERR_NO_STORE
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$ENCRYPTION" == "TRUE" ]; then
|
||||||
|
if [ ! -r "$(which gpg)" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n\t%s\n"\
|
||||||
|
"Encryption was specified, but GPG is not installed."
|
||||||
|
exit 100
|
||||||
|
elif [ -z "$PUBKEY" ]; then
|
||||||
|
>&2 printf " $RED_COLOR!$RESET_COLOR %s\n\t%s\n"\
|
||||||
|
"No GPG recipient was provided in $CONFIG_FILE. "
|
||||||
|
exit 110
|
||||||
|
fi
|
||||||
|
fi
|
||||||
48
src/main/stage2.sns.sh
Normal file
48
src/main/stage2.sns.sh
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
#==============================================================================
|
||||||
|
# Stage 2: Argument Parsing
|
||||||
|
#==============================================================================
|
||||||
|
NOTE=""
|
||||||
|
if [ -z "$1" ]; then help; exit 20
|
||||||
|
else
|
||||||
|
for ARG in "$@"; do
|
||||||
|
case "$ARG" in
|
||||||
|
-c|--create)
|
||||||
|
CREATE="TRUE"
|
||||||
|
OP="TRUE"
|
||||||
|
;;
|
||||||
|
-d|--delete)
|
||||||
|
DELETE="TRUE"
|
||||||
|
OP="TRUE"
|
||||||
|
;;
|
||||||
|
-e|--edit)
|
||||||
|
EDIT="TRUE"
|
||||||
|
OP="TRUE"
|
||||||
|
;;
|
||||||
|
-ce|-ec)
|
||||||
|
CREATE="TRUE"
|
||||||
|
EDIT="TRUE"
|
||||||
|
OP="TRUE"
|
||||||
|
;;
|
||||||
|
-l|--list)
|
||||||
|
LIST="TRUE"
|
||||||
|
OP="TRUE"
|
||||||
|
;;
|
||||||
|
-p|--print)
|
||||||
|
PRINT="TRUE"
|
||||||
|
OP="TRUE"
|
||||||
|
;;
|
||||||
|
-h|--help)
|
||||||
|
help
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
-i|--init-store)
|
||||||
|
init_store
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
NOTE="$ARG"
|
||||||
|
break;
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
fi
|
||||||
30
src/main/stage3.sns.sh
Normal file
30
src/main/stage3.sns.sh
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
#==============================================================================
|
||||||
|
# Section: Actions / Stage 3
|
||||||
|
#==============================================================================
|
||||||
|
# Default behavior
|
||||||
|
# If no operation was specified, print help and exit on ERR_NO_OP
|
||||||
|
if [ "$OP" != "TRUE" ]; then
|
||||||
|
help; exit 20
|
||||||
|
fi
|
||||||
|
# All options not requiring a note to be specified have been dealt
|
||||||
|
# with; if one isn't specified, exit on ERR_NO_NOTE.
|
||||||
|
if [ -z "$NOTE" ]; then
|
||||||
|
printf " $RED_COLOR!$RESET_COLOR %s\n" "No note specified."
|
||||||
|
exit 30
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$ENCRYPTION" == "TRUE" ]; then
|
||||||
|
SESSION_ID="$RANDOM" #SESSION_ID later becomes the temporary filename
|
||||||
|
readonly NOTE="$NOTE.gpg.$EXT"
|
||||||
|
else
|
||||||
|
readonly NOTE="$NOTE.$EXT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$LIST" == "TRUE" ]; then list ; exit 0; fi
|
||||||
|
if [ "$PRINT" == "TRUE" ]; then print ; exit 0; fi
|
||||||
|
if [ "$DELETE" == "TRUE" ]; then delete; exit 0; fi
|
||||||
|
if [ "$CREATE" == "TRUE" ]; then create; fi
|
||||||
|
if [ "$EDIT" == "TRUE" ]; then edit ; fi
|
||||||
|
#==============================================================================
|
||||||
|
# End Section: Actions / Stage 3
|
||||||
|
#==============================================================================
|
||||||
Reference in New Issue
Block a user