commit bb6eeec1b33ba625bad675edb13a7f3ceba6d63e Author: Levi Neely Date: Fri Mar 20 16:46:47 2026 +0100 Initial commit: denotesrv 9P server for denote notes diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b1096ba --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/denotesrv diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e32ea5c --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# denotesrv + +9P server for [denote](https://protesilaos.com/emacs/denote) notes. + +## Installation + +```sh +mk install +``` + +## Usage + +```sh +denotesrv start # background +denotesrv fgstart # foreground +denotesrv status +denotesrv stop +``` + +## Environment + +| Variable | Default | Description | +|----------|---------|-------------| +| `DENOTE_DIR` | `~/Documents/notes` | Notes directory | +| `NAMESPACE` | `/tmp/ns.$USER.:0` | 9P namespace | + +## 9P Filesystem + +``` +denote/ + ctl (write) filter , cd + event (read) Event stream + index (read) Note metadata (respects filter) + new (write) Create note: "'title' tag1,tag2" + n/ + / + backlinks (read) Notes linking to this note + ctl (write) 'd' to delete + keywords (rw) Tags + path (rw) Filesystem path + title (rw) Note title +``` + +## See Also + +- [acme-denote](https://github.com/lneely/acme-denote) — Acme frontend diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..75e083a --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module denotesrv + +go 1.23.0 + +require 9fans.net/go v0.0.5 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..5089ea2 --- /dev/null +++ b/go.sum @@ -0,0 +1,34 @@ +9fans.net/go v0.0.5 h1:u0H3Et5NowdVm56FDD+aWcDOao9zEo+zolNFsr8qyQk= +9fans.net/go v0.0.5/go.mod h1:Rxvbbc1e+1TyGMjAvLthGTyO97t+6JMQ6ly+Lcs9Uf0= +dmitri.shuralyov.com/gpu/mtl v0.0.0-20201218220906-28db891af037/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= +github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= +github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56/go.mod h1:JhuoJpWY28nO4Vef9tZUw9qufEGTyX1+7lmHxV5q5G4= +golang.org/x/exp v0.0.0-20210405174845-4513512abef3/go.mod h1:I6l2HNBLBZEcrOoCpyKLdY2lHoRZ8lI4x60KMCQDft4= +golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= +golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= +golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= +golang.org/x/mobile v0.0.0-20201217150744-e6ae53a27f4f/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= +golang.org/x/mobile v0.0.0-20210220033013-bdb1ca9a1e08/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= +golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= +golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= +golang.org/x/mod v0.1.1-0.20191209134235-331c550502dd/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.3.1-0.20200828183125-ce943fd02449/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210415045647-66c3f260301c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20200117012304-6edc0a871e69/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/internal/disk/backlinks.go b/internal/disk/backlinks.go new file mode 100644 index 0000000..18ec01f --- /dev/null +++ b/internal/disk/backlinks.go @@ -0,0 +1,74 @@ +package disk + +import ( + "bytes" + "denotesrv/pkg/metadata" + "os/exec" + "path/filepath" + "strings" +) + +func FindBacklinks(targetID, denoteDir string, allNotes metadata.Results) metadata.Results { + searchPattern := "denote:" + targetID + + duCmd := exec.Command("9", "du", "-a") + duCmd.Dir = denoteDir + + awkCmd := exec.Command("9", "awk", "$2 ~ /\\.(md|org|txt)$/ {print $2}") + + xargsCmd := exec.Command("9", "xargs", "9", "grep", "-l", searchPattern) + xargsCmd.Dir = denoteDir + + duOut, err := duCmd.StdoutPipe() + if err != nil { + return nil + } + awkCmd.Stdin = duOut + + awkOut, err := awkCmd.StdoutPipe() + if err != nil { + return nil + } + xargsCmd.Stdin = awkOut + + var output bytes.Buffer + xargsCmd.Stdout = &output + + if err := duCmd.Start(); err != nil { + return nil + } + if err := awkCmd.Start(); err != nil { + return nil + } + if err := xargsCmd.Start(); err != nil { + return nil + } + + duCmd.Wait() + awkCmd.Wait() + xargsCmd.Wait() + + result := strings.TrimSpace(output.String()) + if result == "" { + return nil + } + + var results metadata.Results + lines := strings.Split(result, "\n") + for _, line := range lines { + line = strings.TrimPrefix(line, "./") + m := metadata.ParseFilename(filepath.Join(denoteDir, line)) + if m.Identifier == "" { + continue + } + + for _, note := range allNotes { + if note.Identifier == m.Identifier { + results = append(results, note) + break + } + } + } + + return results +} diff --git a/internal/disk/loader.go b/internal/disk/loader.go new file mode 100644 index 0000000..78863fd --- /dev/null +++ b/internal/disk/loader.go @@ -0,0 +1,188 @@ +package disk + +import ( + "denotesrv/pkg/encoding/frontmatter" + "denotesrv/pkg/metadata" + "denotesrv/pkg/util" + "fmt" + "log" + "os" + "path/filepath" + "regexp" + "strings" +) + +// GetFullExtension returns the full extension, including compound extensions. +// For example: "file.md.gpg" returns ".md.gpg", "file.tar.gz" returns ".tar.gz" +func GetFullExtension(path string) string { + ext := filepath.Ext(path) + if ext == "" { + return "" + } + + // Check if there's another extension before this one + pathWithoutExt := strings.TrimSuffix(path, ext) + innerExt := filepath.Ext(pathWithoutExt) + + if innerExt != "" { + // Compound extension found, return both parts + return innerExt + ext + } + + return ext +} + +// GetContentExtension returns the content type extension, stripping encryption/compression layers. +// For example: "file.md.gpg" returns ".md", "file.tar.gz" returns ".tar", "file.md" returns ".md" +func GetContentExtension(path string) string { + fullExt := GetFullExtension(path) + + // For compound extensions, take the first part + parts := strings.Split(fullExt, ".") + if len(parts) >= 3 { // ["", "md", "gpg"] for ".md.gpg" + return "." + parts[1] + } + + return fullExt +} + +// SupportsFrontMatter returns true if the file extension supports frontmatter. +// Uses the actual extension, not the content extension, so encrypted files (.md.gpg) +// are correctly treated as binary files. +func SupportsFrontMatter(path string) bool { + ext := strings.ToLower(filepath.Ext(path)) + return ext == ".org" || ext == ".md" || ext == ".txt" +} + +// extractTitleFromContent extracts the title from file content. +// ext should be the file extension (e.g., ".md", ".org", ".txt"). +// Returns empty string if no title found or unsupported extension. +func extractTitleFromContent(content string, ext string) string { + ext = strings.ToLower(ext) + if ext != ".org" && ext != ".md" && ext != ".txt" { + return "" + } + + // Try org-mode #+title: first, then fall back to first heading + if ext == ".org" { + if m := regexp.MustCompile(`(?m)^#\+title:\s*(.+)$`).FindStringSubmatch(content); m != nil { + return strings.TrimSpace(m[1]) + } + // Fallback to first heading (lines starting with *) + if m := regexp.MustCompile(`(?m)^\*+\s+(.+)$`).FindStringSubmatch(content); m != nil { + return strings.TrimSpace(m[1]) + } + } + + // Try markdown YAML front matter title: first, then fall back to # header + if ext == ".md" { + if m := regexp.MustCompile(`(?ms)^---\n.*?^title:\s*(.+?)$.*?^---`).FindStringSubmatch(content); m != nil { + return strings.TrimSpace(strings.Trim(m[1], `"`)) + } + if m := regexp.MustCompile(`(?m)^#\s+(.+)$`).FindStringSubmatch(content); m != nil { + return strings.TrimSpace(m[1]) + } + } + + return "" +} + +// ExtractMetadata extracts metadata from a file (combines filename and content parsing). +// This is the I/O wrapper around metadata's pure functions. +func ExtractMetadata(path string) (*metadata.Metadata, error) { + // Parse filename (no I/O) + note := metadata.ParseFilename(path) + + // Check if we should try to read file content for title + ext := strings.ToLower(filepath.Ext(path)) + // Don't read unsupported file types + if ext != ".org" && ext != ".md" && ext != ".txt" { + return note, nil + } + + // Read file content + content, err := os.ReadFile(path) + if err != nil { + // If we can't read the file, just use filename metadata + return note, nil + } + + // Try to extract title from content + if title := extractTitleFromContent(string(content), ext); title != "" { + note.Title = title + } + + return note, nil +} + +// ExtractFrontMatter reads a file and parses its front matter. +// Returns the parsed FrontMatter and the detected FileType. +func ExtractFrontMatter(path string) (*metadata.FrontMatter, metadata.FileType, error) { + ext := strings.ToLower(filepath.Ext(path)) + + content, err := os.ReadFile(path) + if err != nil { + return nil, "", fmt.Errorf("failed to read file: %w", err) + } + + return frontmatter.Unmarshal(content, ext) +} + +// UpdateFrontMatter updates the front matter in a file. +func UpdateFrontMatter(path string, fm *metadata.FrontMatter, fileType metadata.FileType) error { + // Only update frontmatter for supported file types + if !SupportsFrontMatter(path) { + return nil + } + + // Read current content + content, err := os.ReadFile(path) + if err != nil { + return fmt.Errorf("failed to read file: %w", err) + } + + // Apply front matter to content + newContent, err := util.Apply(string(content), fm, fileType) + if err != nil { + return fmt.Errorf("failed to apply front matter: %w", err) + } + + // Write back to file + return os.WriteFile(path, []byte(newContent), 0644) +} + +// LoadAll walks a directory and extracts metadata from all denote files. +func LoadAll(dir string) (metadata.Results, error) { + var notes metadata.Results + + err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + if info.IsDir() { + return nil + } + + note, err := ExtractMetadata(path) + if err != nil { + return err + } + + // Only include files with valid identifiers + if note.Identifier != "" { + // Warn on invalid tags but continue loading + if invalid := metadata.ValidateTags(note.Tags); len(invalid) > 0 { + log.Printf("warning: %s:1 invalid tags %v (must be lowercase alphanumeric)", path, invalid) + } + notes = append(notes, note) + } + + return nil + }) + + if err != nil { + return nil, fmt.Errorf("failed to walk directory: %w", err) + } + + return notes, nil +} diff --git a/internal/p9/server/server.go b/internal/p9/server/server.go new file mode 100644 index 0000000..a86a4c7 --- /dev/null +++ b/internal/p9/server/server.go @@ -0,0 +1,1208 @@ +/* +The fs package provides a 9P filesystem that exposes the in-memory data set containing +denote metadata for all files in the denote directory. The filesystem is organized as +follows: + + denote/ (directory) Root filesystem + ctl (write-only) Control file (commands: filter , cd ) + event (read-only) Global event bus (listen & react to rename, update, and delete events) + index (read-only) Metadata index (respects active filter) + new (write-only) Create new note (write "'title' tag1,tag2") + n/ (directory) Notes directory + / (directory) Unique denote file identifier + backlinks (read-only) Notes that link to this note (same format as index) + ctl (write-only) Control file (publish rename, update, and delete events) + keywords (read-write) File tags + path (read-write) Path on underlying filesystem + title (read-write) Denote document title + +Notes: +- Messages written to denote/ctl affect global state (e.g., filtering, directory switching) +- Filter command syntax: filter [field:]pattern where field is date|title|tag +- Multiple filters can be specified: filter tag:journal !tag:draft +- Titles with spaces must be quoted: filter title:"My Title" +- Writing 'filter' with no arguments clears the active filter +- Index respects the current filter - returns only matching notes +- Cd command syntax: cd /path/to/directory +- After cd, run Get to reload notes from the new directory +- Messages written to denote/n//ctl may generate events that are broadcast over the global event bus +- Writing to title or keywords triggers an update ('u') event and a rename ('r') event +- Write 'd' to denote/n//ctl to delete a denote file +- Write "'document title' tag1,tag2,(...)" to denote/new to create a new denote file +*/ +package fs + +import ( + "denotesrv/internal/disk" + "denotesrv/pkg/encoding/results" + "denotesrv/pkg/metadata" + "errors" + "fmt" + "io" + "net" + "os" + "path/filepath" + "regexp" + "strings" + "sync" + "syscall" + "time" + + "9fans.net/go/plan9" + "9fans.net/go/plan9/client" +) + +// File types in our filesystem +const ( + QTDir = plan9.QTDIR + QTFile = plan9.QTFILE +) + +// Qid paths - we'll use a simple scheme: +// 0: root +// 1-1000000: note directories (qid = 1 + note_index) +// 1000001+: files (qid = 1000001 + note_index*100 + file_type) +const ( + qidRoot = 0 + qidNoteBase = 1 + qidFileBase = 1000001 + qidIndex = 999999 + qidEvent = 999998 + qidNew = 999997 + qidNDir = 999996 + qidCtl = 999995 + qidDir = 999994 +) + +var fileNames = []string{"path", "title", "keywords", "signature", "ctl", "backlinks"} + +// Callbacks for note operations +type Callbacks struct { + OnNew func(identifier string) error + OnUpdate func(identifier string) error + OnRename func(identifier string) error + OnDelete func(identifier string) error +} + +type server struct { + notes metadata.Results + denoteDir string + mu sync.RWMutex + callbacks Callbacks + filterQuery string + filteredNotes []*metadata.Metadata +} + +type connState struct { + fids map[uint32]*fid + mu sync.RWMutex +} + +type fid struct { + qid plan9.Qid + path string + offset int64 + mode uint8 +} + +var srv *server + +// GetDenoteDir returns the current denote directory. +// Returns empty string if server not yet initialized. +func GetDenoteDir() string { + if srv == nil { + return "" + } + srv.mu.RLock() + defer srv.mu.RUnlock() + return srv.denoteDir +} + +// findNote finds a note by identifier in the in-memory collection +func findNote(identifier string) (*metadata.Metadata, error) { + srv.mu.RLock() + defer srv.mu.RUnlock() + for _, n := range srv.notes { + if n.Identifier == identifier { + return n, nil + } + } + return nil, fmt.Errorf("note not found: %s", identifier) +} + +// UpdateMetadataFromDisk updates note metadata directly from disk without +// triggering callbacks or 9P protocol overhead. Used by GetAll() for bulk sync. +func UpdateMetadataFromDisk(identifier, title, keywords, signature string) error { + if srv == nil { + return fmt.Errorf("server not running") + } + + note, err := findNote(identifier) + if err != nil { + return err + } + + // Parse keywords into tags + var tags []string + if keywords != "" { + tags = strings.Split(keywords, ",") + for i := range tags { + tags[i] = strings.TrimSpace(tags[i]) + } + } + + // Update fields directly (note is a pointer, so this modifies the original) + note.Title = title + note.Tags = tags + note.Signature = signature + + return nil +} + +// Getdir returns the denote directory +// StartServer starts the 9P fileserver in the background with pre-loaded metadata. +// initialData should contain all notes to be served - typically loaded by sync.LoadAll(). +// Server is the 9P server for denote notes +type Server struct { + *server +} + +// NewServer creates a new denote 9P server +func NewServer(denoteDir string, callbacks Callbacks) (*Server, error) { + // Load notes from disk + notes, err := disk.LoadAll(denoteDir) + if err != nil { + return nil, fmt.Errorf("failed to load notes: %w", err) + } + + s := &server{ + notes: notes, + denoteDir: denoteDir, + callbacks: callbacks, + } + return &Server{s}, nil +} + +// Serve handles a single 9P connection +func (s *Server) Serve(conn net.Conn) { + s.server.serve(conn) +} + +func StartServer(initialData metadata.Results, denoteDir string, callbacks Callbacks) error { + if srv != nil { + return fmt.Errorf("server already running") + } + + srv = &server{ + notes: initialData, + denoteDir: denoteDir, + callbacks: callbacks, + } + + // Get namespace and create Unix socket path + ns := client.Namespace() + if ns == "" { + return fmt.Errorf("failed to get namespace") + } + + sockPath := ns + "/denote" + + // Try to create Unix domain socket listener + // Use stale socket detection like acme (see /usr/local/plan9/src/lib9/announce.c) + var listener net.Listener + var err error + for attempts := 0; attempts < 2; attempts++ { + listener, err = net.Listen("unix", sockPath) + if err == nil { + break // Successfully bound to socket + } + + // Check if error is "address already in use" + if errors.Is(err, syscall.EADDRINUSE) { + // Try to connect to see if socket is live or stale + conn, dialErr := net.Dial("unix", sockPath) + if dialErr == nil { + // Connection succeeded - another instance is running + conn.Close() + return fmt.Errorf("Denote already running in this namespace") + } + // Connection failed - socket is stale, remove it and retry + os.Remove(sockPath) + continue + } + + // Some other error + return fmt.Errorf("failed to listen on socket: %w", err) + } + if err != nil { + return fmt.Errorf("failed to listen on socket after cleanup: %w", err) + } + + // Start accepting connections in background + go srv.acceptLoop(listener) + + return nil +} + +func (s *server) acceptLoop(listener net.Listener) { + defer listener.Close() + + for { + conn, err := listener.Accept() + if err != nil { + fmt.Fprintf(os.Stderr, "denote fs: accept error: %v\n", err) + return + } + + go s.serve(conn) + } +} + +func (s *server) serve(conn net.Conn) { + defer conn.Close() + + cs := &connState{ + fids: make(map[uint32]*fid), + } + + for { + fc, err := plan9.ReadFcall(conn) + if err != nil { + if err != io.EOF { + fmt.Fprintf(os.Stderr, "denote fs: read error: %v\n", err) + } + return + } + + rfc := s.handle(cs, fc) + if err := plan9.WriteFcall(conn, rfc); err != nil { + fmt.Fprintf(os.Stderr, "denote fs: write error: %v\n", err) + return + } + } +} + +func (s *server) handle(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + switch fc.Type { + case plan9.Tversion: + return s.version(fc) + case plan9.Tauth: + return errorFcall(fc, "denote: authentication not required") + case plan9.Tattach: + return s.attach(cs, fc) + case plan9.Twalk: + return s.walk(cs, fc) + case plan9.Topen: + return s.open(cs, fc) + case plan9.Tread: + return s.read(cs, fc) + case plan9.Twrite: + return s.write(cs, fc) + case plan9.Tstat: + return s.stat(cs, fc) + case plan9.Tclunk: + return s.clunk(cs, fc) + default: + return errorFcall(fc, "operation not supported") + } +} + +func (s *server) version(fc *plan9.Fcall) *plan9.Fcall { + msize := min(fc.Msize, 8192) + return &plan9.Fcall{ + Type: plan9.Rversion, + Tag: fc.Tag, + Msize: msize, + Version: "9P2000", + } +} + +func (s *server) attach(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.Lock() + defer cs.mu.Unlock() + + qid := plan9.Qid{ + Type: QTDir, + Path: qidRoot, + } + + cs.fids[fc.Fid] = &fid{ + qid: qid, + path: "/", + } + + return &plan9.Fcall{ + Type: plan9.Rattach, + Tag: fc.Tag, + Qid: qid, + } +} + +func (s *server) walk(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.Lock() + defer cs.mu.Unlock() + + f, ok := cs.fids[fc.Fid] + if !ok { + return errorFcall(fc, "fid not found") + } + + // If no wnames, this is a clone operation + if len(fc.Wname) == 0 { + newFid := &fid{ + qid: f.qid, + path: f.path, + } + cs.fids[fc.Newfid] = newFid + return &plan9.Fcall{ + Type: plan9.Rwalk, + Tag: fc.Tag, + Wqid: []plan9.Qid{}, + } + } + + // Walk the path + path := f.path + qids := []plan9.Qid{} + + for _, name := range fc.Wname { + if path == "/" { + // Walking from root + found := false + if name == "index" { + qid := plan9.Qid{ + Type: QTFile, + Path: uint64(qidIndex), + } + qids = append(qids, qid) + path = "/index" + found = true + } else if name == "new" { + qid := plan9.Qid{ + Type: QTFile, + Path: uint64(qidNew), + } + qids = append(qids, qid) + path = "/new" + found = true + } else if name == "ctl" { + qid := plan9.Qid{ + Type: QTFile, + Path: uint64(qidCtl), + } + qids = append(qids, qid) + path = "/ctl" + found = true + } else if name == "dir" { + qid := plan9.Qid{ + Type: QTFile, + Path: uint64(qidDir), + } + qids = append(qids, qid) + path = "/dir" + found = true + } else if name == "n" { + qid := plan9.Qid{ + Type: QTDir, + Path: uint64(qidNDir), + } + qids = append(qids, qid) + path = "/n" + found = true + } + if !found { + return errorFcall(fc, "file not found") + } + } else if path == "/n" { + // Walking from /n - should be a note identifier + found := false + for i, note := range s.notes { + if note.Identifier == name { + qid := plan9.Qid{ + Type: QTDir, + Path: uint64(qidNoteBase + i), + } + qids = append(qids, qid) + path = "/n/" + name + found = true + break + } + } + if !found { + return errorFcall(fc, "file not found") + } + } else { + // Walking from note dir - should be a file + found := false + for i, fname := range fileNames { + if fname == name { + noteIdx := s.pathToNoteIndex(path) + qid := plan9.Qid{ + Type: QTFile, + Path: uint64(qidFileBase + noteIdx*100 + i), + } + qids = append(qids, qid) + path = path + "/" + name + found = true + break + } + } + if !found { + return errorFcall(fc, "file not found") + } + } + } + + newFid := &fid{ + qid: qids[len(qids)-1], + path: path, + } + cs.fids[fc.Newfid] = newFid + + return &plan9.Fcall{ + Type: plan9.Rwalk, + Tag: fc.Tag, + Wqid: qids, + } +} + +func (s *server) open(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.Lock() + defer cs.mu.Unlock() + + f, ok := cs.fids[fc.Fid] + if !ok { + return errorFcall(fc, "fid not found") + } + + f.mode = fc.Mode + + return &plan9.Fcall{ + Type: plan9.Ropen, + Tag: fc.Tag, + Qid: f.qid, + } +} + +func (s *server) read(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.Lock() + + f, ok := cs.fids[fc.Fid] + if !ok { + cs.mu.Unlock() + return errorFcall(fc, "fid not found") + } + + defer cs.mu.Unlock() + + var data []byte + + if f.qid.Type&QTDir != 0 { + // Reading a directory + if fc.Offset == 0 { + f.offset = 0 + } + data = s.readDir(f.path, int64(fc.Offset), fc.Count) + } else { + // Reading a file + content := s.getFileContent(f.path) + offset := int64(fc.Offset) + if offset >= int64(len(content)) { + data = []byte{} + } else { + end := min(offset+int64(fc.Count), int64(len(content))) + data = []byte(content[offset:end]) + } + } + + return &plan9.Fcall{ + Type: plan9.Rread, + Tag: fc.Tag, + Count: uint32(len(data)), + Data: data, + } +} + +func (s *server) write(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.Lock() + defer cs.mu.Unlock() + + f, ok := cs.fids[fc.Fid] + if !ok { + return errorFcall(fc, "fid not found") + } + + // Check if opened for writing + if f.mode&plan9.OWRITE == 0 && f.mode&plan9.ORDWR == 0 { + return errorFcall(fc, "file not open for writing") + } + + // Handle writes to /ctl + if f.path == "/ctl" { + return s.handleCtlCommand(fc) + } + + // Handle writes to /new + if f.path == "/new" { + input := strings.TrimSpace(string(fc.Data)) + + // Parse: 'Title' ==signature tag1,tag2,... + // Extract title (must be single-quoted) + if !strings.HasPrefix(input, "'") { + return errorFcall(fc, "title must be single-quoted") + } + + closeQuote := strings.Index(input[1:], "'") + if closeQuote == -1 { + return errorFcall(fc, "title must be single-quoted (missing closing quote)") + } + + title := input[1 : closeQuote+1] + if title == "" { + return errorFcall(fc, "title cannot be empty") + } + + // Extract signature and tags (everything after closing quote) + remainder := strings.TrimSpace(input[closeQuote+2:]) + var signature string + var tags []string + + if remainder != "" { + // Check if signature is present (starts with ==) + if strings.HasPrefix(remainder, "==") { + // Find end of signature (space before tags) + spaceIdx := strings.Index(remainder, " ") + if spaceIdx == -1 { + // No tags, just signature + signature = remainder[2:] // Skip == + } else { + signature = remainder[2:spaceIdx] // Skip == + remainder = strings.TrimSpace(remainder[spaceIdx+1:]) + } + } + + // Extract tags if present + if remainder != "" && !strings.HasPrefix(remainder, "==") { + // Validate tags + tagPattern := regexp.MustCompile(`^([\p{Ll}\p{Nd}]+,)*[\p{Ll}\p{Nd}]+$`) + if !tagPattern.MatchString(remainder) { + return errorFcall(fc, "tags must be comma-delimited lowercase unicode words (no spaces)") + } + tags = strings.Split(remainder, ",") + } + } + + // Generate timestamp identifier + identifier := time.Now().Format("20060102T150405") + + // Create metadata entry with temporary path + // (actual file will be created by denote package event handler) + meta := &metadata.Metadata{ + Identifier: identifier, + Signature: signature, + Title: title, + Tags: tags, + Path: "", // Will be set when file is created + } + + // Add to in-memory state + s.mu.Lock() + s.notes = append(s.notes, meta) + s.mu.Unlock() + + // Call new note callback + if s.callbacks.OnNew != nil { + go s.callbacks.OnNew(identifier) // async to not block write + } + + return &plan9.Fcall{ + Type: plan9.Rwrite, + Tag: fc.Tag, + Count: uint32(len(fc.Data)), + } + } + + // Extract note identifier and field name from path + parts := strings.Split(strings.Trim(f.path, "/"), "/") + if len(parts) != 3 || parts[0] != "n" { + return errorFcall(fc, "invalid path") + } + + noteID := parts[1] + fieldName := parts[2] + + note, err := findNote(noteID) + if err != nil { + return errorFcall(fc, err.Error()) + } + + // Update the field in memory only + value := strings.TrimSpace(string(fc.Data)) + + switch fieldName { + case "path": + note.Path = value + // Don't emit 'r' - path is metadata only, doesn't trigger renames + case "title": + note.Title = value + // Call update and rename callbacks synchronously + if s.callbacks.OnUpdate != nil { + s.callbacks.OnUpdate(noteID) + } + if s.callbacks.OnRename != nil { + s.callbacks.OnRename(noteID) + } + case "keywords": + if value == "" { + note.Tags = []string{} + } else { + tags := strings.Split(value, ",") + for i := range tags { + tags[i] = strings.TrimSpace(tags[i]) + } + note.Tags = tags + } + // Call update and rename callbacks synchronously + if s.callbacks.OnUpdate != nil { + s.callbacks.OnUpdate(noteID) + } + if s.callbacks.OnRename != nil { + s.callbacks.OnRename(noteID) + } + case "signature": + note.Signature = value + // Call update and rename callbacks synchronously + if s.callbacks.OnUpdate != nil { + s.callbacks.OnUpdate(noteID) + } + if s.callbacks.OnRename != nil { + s.callbacks.OnRename(noteID) + } + case "ctl": + // Handle control commands + switch value { + case "d": + // Call delete callback BEFORE removing metadata + if s.callbacks.OnDelete != nil { + s.callbacks.OnDelete(noteID) + } + + // Remove from in-memory state + s.mu.Lock() + for i, n := range s.notes { + if n.Identifier == noteID { + s.notes = append(s.notes[:i], s.notes[i+1:]...) + break + } + } + // Also remove from filtered notes + for i, n := range s.filteredNotes { + if n.Identifier == noteID { + s.filteredNotes = append(s.filteredNotes[:i], s.filteredNotes[i+1:]...) + break + } + } + s.mu.Unlock() + case "r": + // Manual rename request + if s.callbacks.OnRename != nil { + s.callbacks.OnRename(noteID) + } + } + default: + return errorFcall(fc, "field is read-only") + } + + return &plan9.Fcall{ + Type: plan9.Rwrite, + Tag: fc.Tag, + Count: uint32(len(fc.Data)), + } +} + +func (s *server) stat(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.RLock() + defer cs.mu.RUnlock() + + f, ok := cs.fids[fc.Fid] + if !ok { + return errorFcall(fc, "fid not found") + } + + dir := s.pathToDir(f.path, f.qid) + stat, err := dir.Bytes() + if err != nil { + return errorFcall(fc, err.Error()) + } + + return &plan9.Fcall{ + Type: plan9.Rstat, + Tag: fc.Tag, + Stat: stat, + } +} + +func (s *server) clunk(cs *connState, fc *plan9.Fcall) *plan9.Fcall { + cs.mu.Lock() + defer cs.mu.Unlock() + + delete(cs.fids, fc.Fid) + + return &plan9.Fcall{ + Type: plan9.Rclunk, + Tag: fc.Tag, + } +} + +func (s *server) readDir(path string, offset int64, count uint32) []byte { + var dirs []plan9.Dir + + if path == "/" { + // add index node + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTFile, + Path: uint64(qidIndex), + }, + Mode: 0444, + Name: "index", + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: 0, + }) + // add new node + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTFile, + Path: uint64(qidNew), + }, + Mode: 0222, + Name: "new", + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: 0, + }) + // add ctl node + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTFile, + Path: uint64(qidCtl), + }, + Mode: 0200, + Name: "ctl", + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: 0, + }) + // add dir node + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTFile, + Path: uint64(qidDir), + }, + Mode: 0444, + Name: "dir", + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: uint64(len(s.denoteDir)), + }) + // add n directory + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTDir, + Path: uint64(qidNDir), + }, + Mode: plan9.DMDIR | 0555, + Name: "n", + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: 0, + }) + } else if path == "/index" { + + } else if path == "/n" { + // List all note IDs + for i, note := range s.notes { + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTDir, + Path: uint64(qidNoteBase + 1 + i), + }, + Mode: plan9.DMDIR | 0555, + Name: note.Identifier, + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: 0, + }) + } + } else { + // List files in a note directory + noteIdx := s.pathToNoteIndex(path) + for i, fname := range fileNames { + content := s.getFileContent(path + "/" + fname) + mode := uint32(0444) // read-only by default + if fname == "title" || fname == "keywords" || fname == "path" { + mode = 0644 // writable + } else if fname == "ctl" { + mode = 0200 // write-only + } + dirs = append(dirs, plan9.Dir{ + Qid: plan9.Qid{ + Type: QTFile, + Path: uint64(qidFileBase + noteIdx*100 + i), + }, + Mode: plan9.Perm(mode), + Name: fname, + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: uint64(len(content)), + }) + } + } + + // Serialize all directory entries to bytes first + var allData []byte + for _, dir := range dirs { + stat, _ := dir.Bytes() + allData = append(allData, stat...) + } + + // Return slice starting from offset + if offset >= int64(len(allData)) { + return []byte{} + } + + end := offset + int64(count) + if end > int64(len(allData)) { + end = int64(len(allData)) + } + + return allData[offset:end] +} + +func (s *server) pathToDir(path string, qid plan9.Qid) plan9.Dir { + name := path + if path == "/" { + name = "." + } else if strings.Contains(path, "/") { + parts := strings.Split(path, "/") + name = parts[len(parts)-1] + } + + mode := uint32(0444) + length := uint64(0) + content := "" + + if qid.Type&QTDir != 0 { + mode = plan9.DMDIR | 0555 + } else { + content = s.getFileContent(path) + length = uint64(len(content)) + } + + return plan9.Dir{ + Qid: qid, + Mode: plan9.Perm(mode), + Name: name, + Uid: "denote", + Gid: "denote", + Muid: "denote", + Length: length, + } +} + +func (s *server) pathToNoteIndex(path string) int { + parts := strings.Split(strings.Trim(path, "/"), "/") + if len(parts) < 2 || parts[0] != "n" { + return -1 + } + + noteID := parts[1] + for i, note := range s.notes { + if note.Identifier == noteID { + return i + } + } + return -1 +} + +func (s *server) getIndexContent() string { + if s.filterQuery == "" { + // No filter: return all notes + return string(results.Marshal(s.notes)) + } + + // Return filtered notes + var filtered metadata.Results + for _, note := range s.filteredNotes { + filtered = append(filtered, note) + } + return string(results.Marshal(filtered)) +} + +func (s *server) getBacklinks(targetID string) string { + s.mu.RLock() + notes := s.notes + denoteDir := s.denoteDir + s.mu.RUnlock() + + res := disk.FindBacklinks(targetID, denoteDir, notes) + return string(results.Marshal(res)) +} + +func (s *server) getFileContent(path string) string { + if path == "/index" { + return s.getIndexContent() + } + + if path == "/dir" { + return s.denoteDir + } + + parts := strings.Split(strings.Trim(path, "/"), "/") + if len(parts) != 3 || parts[0] != "n" { + return "" + } + + noteID := parts[1] + fileName := parts[2] + + note, err := findNote(noteID) + if err != nil { + return "" + } + + switch fileName { + case "path": + return note.Path + case "title": + return note.Title + case "keywords": + return strings.Join(note.Tags, ",") + case "signature": + return note.Signature + case "backlinks": + return s.getBacklinks(noteID) + } + return "" +} + +func errorFcall(fc *plan9.Fcall, msg string) *plan9.Fcall { + return &plan9.Fcall{ + Type: plan9.Rerror, + Tag: fc.Tag, + Ename: msg, + } +} + +// handleCtlCommand processes commands written to /ctl +func (s *server) handleCtlCommand(fc *plan9.Fcall) *plan9.Fcall { + command := strings.TrimSpace(string(fc.Data)) + + // Parse command - must start with a known command word + if strings.HasPrefix(command, "filter") { + return s.handleFilterCommand(fc, command) + } + + if strings.HasPrefix(command, "cd ") { + return s.handleCdCommand(fc, command) + } + + return errorFcall(fc, fmt.Sprintf("unknown ctl command: %s", command)) +} + +// handleFilterCommand processes the 'filter' ctl command +func (s *server) handleFilterCommand(fc *plan9.Fcall, command string) *plan9.Fcall { + // Extract filter query after "filter" keyword + query := strings.TrimSpace(strings.TrimPrefix(command, "filter")) + + s.mu.Lock() + defer s.mu.Unlock() + + if query == "" { + // Clear filter: filter with no arguments + s.filterQuery = "" + s.filteredNotes = nil + + return &plan9.Fcall{ + Type: plan9.Rwrite, + Tag: fc.Tag, + Count: uint32(len(fc.Data)), + } + } + + // Parse filter query into Filter objects + filters, err := parseFilterQuery(query) + if err != nil { + return errorFcall(fc, fmt.Sprintf("invalid filter: %v", err)) + } + + // Apply filters to notes + var filtered []*metadata.Metadata + for _, note := range s.notes { + match := true + for _, filt := range filters { + if !filt.IsMatch(note) { + match = false + break + } + } + if match { + filtered = append(filtered, note) + } + } + + // Store filter state + s.filterQuery = query + s.filteredNotes = filtered + + return &plan9.Fcall{ + Type: plan9.Rwrite, + Tag: fc.Tag, + Count: uint32(len(fc.Data)), + } +} + +// handleCdCommand processes the 'cd' ctl command to change denote directory +func (s *server) handleCdCommand(fc *plan9.Fcall, command string) *plan9.Fcall { + // Extract path after "cd " keyword + newPath := strings.TrimSpace(strings.TrimPrefix(command, "cd ")) + + if newPath == "" { + return errorFcall(fc, "cd: path required") + } + + // Expand ~ to home directory + if strings.HasPrefix(newPath, "~") { + home := os.Getenv("HOME") + if home == "" { + return errorFcall(fc, "cd: cannot expand ~ (HOME not set)") + } + newPath = strings.Replace(newPath, "~", home, 1) + } + + // Clean the path + newPath = filepath.Clean(newPath) + + // Convert to absolute path + absPath, err := filepath.Abs(newPath) + if err != nil { + return errorFcall(fc, fmt.Sprintf("cd: invalid path: %v", err)) + } + + // Verify directory exists + info, err := os.Stat(absPath) + if err != nil { + return errorFcall(fc, fmt.Sprintf("cd: %v", err)) + } + if !info.IsDir() { + return errorFcall(fc, fmt.Sprintf("cd: %s is not a directory", absPath)) + } + + // Load metadata from new directory + newNotes, err := disk.LoadAll(absPath) + if err != nil { + return errorFcall(fc, fmt.Sprintf("cd: failed to load directory: %v", err)) + } + + // Update server state atomically + s.mu.Lock() + s.denoteDir = absPath + s.notes = newNotes + // Clear filter state when switching directories + s.filterQuery = "" + s.filteredNotes = nil + s.mu.Unlock() + + return &plan9.Fcall{ + Type: plan9.Rwrite, + Tag: fc.Tag, + Count: uint32(len(fc.Data)), + } +} + +// parseFilterQuery parses a filter command query into Filter objects +// Handles quoted strings for titles: title:"my title" or title:'my title' +// Multiple filters space-separated: tag:journal !tag:draft +func parseFilterQuery(query string) ([]*metadata.Filter, error) { + var filters []*metadata.Filter + + // Split by spaces while respecting quotes + parts := splitRespectingQuotes(query) + + for _, part := range parts { + part = strings.TrimSpace(part) + if part == "" { + continue + } + + // Use existing NewFilter function + filt, err := metadata.NewFilter(part) + if err != nil { + return nil, fmt.Errorf("invalid filter '%s': %w", part, err) + } + filters = append(filters, filt) + } + + if len(filters) == 0 { + return nil, fmt.Errorf("no valid filters provided") + } + + return filters, nil +} + +// splitRespectingQuotes splits a string on spaces but preserves quoted strings +// Handles both single and double quotes +func splitRespectingQuotes(s string) []string { + var result []string + var current strings.Builder + inQuote := false + quoteChar := byte(0) + + for i := 0; i < len(s); i++ { + ch := s[i] + + switch ch { + case '"', '\'': + if !inQuote { + // Start quote + inQuote = true + quoteChar = ch + current.WriteByte(ch) + } else if ch == quoteChar { + // End quote (matching) + inQuote = false + quoteChar = 0 + current.WriteByte(ch) + } else { + // Different quote char inside quotes + current.WriteByte(ch) + } + case ' ': + if inQuote { + current.WriteByte(ch) + } else { + if current.Len() > 0 { + result = append(result, current.String()) + current.Reset() + } + } + default: + current.WriteByte(ch) + } + } + + // Add final token + if current.Len() > 0 { + result = append(result, current.String()) + } + + return result +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..e6a22a6 --- /dev/null +++ b/main.go @@ -0,0 +1,154 @@ +// denotesrv - 9P server for denote notes +package main + +import ( + fs "denotesrv/internal/p9/server" + "denotesrv/pkg/config" + "flag" + "fmt" + "net" + "os" + "os/exec" + "os/signal" + "path/filepath" + "syscall" + + "9fans.net/go/plan9/client" +) + +const serviceName = "denote" + +func main() { + flag.Parse() + + if flag.NArg() < 1 { + fmt.Fprintln(os.Stderr, "usage: denotesrv ") + os.Exit(1) + } + + ns := client.Namespace() + if ns == "" { + fmt.Fprintln(os.Stderr, "no namespace") + os.Exit(1) + } + + sockPath := filepath.Join(ns, serviceName) + pidPath := filepath.Join(ns, serviceName+".pid") + + switch flag.Arg(0) { + case "start": + if isRunning(sockPath) { + fmt.Println("denotesrv already running") + os.Exit(0) + } + daemonize(pidPath) + case "fgstart": + if isRunning(sockPath) { + fmt.Println("denotesrv already running") + os.Exit(0) + } + runServer(sockPath, pidPath) + case "stop": + stopServer(sockPath, pidPath) + case "status": + if isRunning(sockPath) { + fmt.Println("denotesrv running") + } else { + fmt.Println("denotesrv not running") + os.Exit(1) + } + default: + fmt.Fprintln(os.Stderr, "usage: denotesrv ") + os.Exit(1) + } +} + +func isRunning(sockPath string) bool { + conn, err := net.Dial("unix", sockPath) + if err == nil { + conn.Close() + return true + } + return false +} + +func daemonize(pidPath string) { + exe, _ := os.Executable() + cmd := exec.Command(exe, "fgstart") + cmd.Stdout = nil + cmd.Stderr = nil + cmd.Stdin = nil + cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true} + if err := cmd.Start(); err != nil { + fmt.Fprintf(os.Stderr, "failed to start: %v\n", err) + os.Exit(1) + } + fmt.Printf("denotesrv started (pid %d)\n", cmd.Process.Pid) +} + +func stopServer(sockPath, pidPath string) { + data, err := os.ReadFile(pidPath) + if err != nil { + fmt.Println("denotesrv not running") + return + } + var pid int + fmt.Sscanf(string(data), "%d", &pid) + if pid > 0 { + syscall.Kill(pid, syscall.SIGTERM) + } + os.Remove(pidPath) + os.Remove(sockPath) + fmt.Println("denotesrv stopped") +} + +func runServer(sockPath, pidPath string) { + // Remove stale socket + if _, err := os.Stat(sockPath); err == nil { + os.Remove(sockPath) + } + + // Write PID file + os.WriteFile(pidPath, []byte(fmt.Sprintf("%d", os.Getpid())), 0644) + + // Get denote directory + denoteDir := config.DefaultDenoteDir + if envDir := os.Getenv("DENOTE_DIR"); envDir != "" { + denoteDir = envDir + } + + // Start server + srv, err := fs.NewServer(denoteDir, fs.Callbacks{}) + if err != nil { + fmt.Fprintf(os.Stderr, "failed to create server: %v\n", err) + os.Exit(1) + } + + listener, err := net.Listen("unix", sockPath) + if err != nil { + fmt.Fprintf(os.Stderr, "failed to listen: %v\n", err) + os.Exit(1) + } + + go func() { + for { + conn, err := listener.Accept() + if err != nil { + return + } + go srv.Serve(conn) + } + }() + + fmt.Printf("denotesrv listening on %s (dir: %s)\n", sockPath, denoteDir) + + // Wait for signal + sigChan := make(chan os.Signal, 1) + signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM) + <-sigChan + + fmt.Println("shutting down") + listener.Close() + os.Remove(sockPath) + os.Remove(pidPath) +} diff --git a/mkfile b/mkfile new file mode 100644 index 0000000..5128ede --- /dev/null +++ b/mkfile @@ -0,0 +1,11 @@ +INSTALL_PATH=$HOME/bin + +all:V: install + +build:V: + go build -o $INSTALL_PATH/denotesrv . + +install:V: build + +clean:V: + rm -f $INSTALL_PATH/denotesrv diff --git a/pkg/config/config.go b/pkg/config/config.go new file mode 100644 index 0000000..418ca1b --- /dev/null +++ b/pkg/config/config.go @@ -0,0 +1,16 @@ +package config + +import "os" + +// ============================================================ +// CONFIGURATION: Default Denote Directory +// +// Change this value to set your default denote directory. +// This is used at program startup. After startup, use the +// Dsilo command to switch between directories dynamically. +// ============================================================ +var DefaultDenoteDir = os.Getenv("HOME") + "/doc" + +// Examples of alternative configurations: +// var DefaultDenoteDir = "/home/lkn/notes" +// var DefaultDenoteDir = os.Getenv("DENOTE_DIR") diff --git a/pkg/encoding/frontmatter/frontmatter.go b/pkg/encoding/frontmatter/frontmatter.go new file mode 100644 index 0000000..123b4af --- /dev/null +++ b/pkg/encoding/frontmatter/frontmatter.go @@ -0,0 +1,172 @@ +package frontmatter + +import ( + "denotesrv/pkg/metadata" + "fmt" + "regexp" + "strings" + "time" +) + +// Templates for denote frontmatter (org, md, txt) +var templates = map[metadata.FileType]string{ + metadata.FileTypeOrg: `#+title: %s +#+date: %s +#+filetags: %s +#+identifier: %s +#+signature: %s + +`, + metadata.FileTypeMdYaml: `--- +title: %s +date: %s +tags: %s +identifier: %s +signature: %s +--- + +`, + metadata.FileTypeMdToml: `+++ +title = %s +date = %s +tags = %s +identifier = %s +signature = %s ++++ + +`, + metadata.FileTypeTxt: `title: %s +date: %s +tags: %s +identifier: %s +signature: %s +--------------------------- + +`, +} + +// formatTags formats tags according to file type +func formatTags(tags []string, fileType metadata.FileType) string { + if len(tags) == 0 { + return "" + } + switch fileType { + case metadata.FileTypeOrg: + return ":" + strings.Join(tags, ":") + ":" + case metadata.FileTypeMdYaml, metadata.FileTypeMdToml: + return "[" + strings.Join(tags, ", ") + "]" + default: + return strings.Join(tags, " ") + } +} + +// Marshal returns the formatted frontmatter content as bytes +func Marshal(fm *metadata.FrontMatter, fileType metadata.FileType) []byte { + template := templates[fileType] + dateStr := time.Now().Format("2006-01-02 Mon 15:04") + + // For org-mode, wrap date in brackets for timestamp + if fileType == metadata.FileTypeOrg { + dateStr = "[" + dateStr + "]" + } + + keywordsStr := formatTags(fm.Tags, fileType) + content := fmt.Sprintf(template, fm.Title, dateStr, keywordsStr, fm.Identifier, fm.Signature) + return []byte(content) +} + +// Unmarshal extracts front matter from file content. +// ext should be the file extension (e.g., ".md", ".org", ".txt"). +// Returns the parsed frontmatter and the detected FileType. +func Unmarshal(content []byte, ext string) (*metadata.FrontMatter, metadata.FileType, error) { + ext = strings.ToLower(ext) + text := string(content) + + fm := &metadata.FrontMatter{} + var fileType metadata.FileType + + switch ext { + case ".org": + fileType = metadata.FileTypeOrg + if m := regexp.MustCompile(`(?m)^#\+title:[ \t]*(.+)$`).FindStringSubmatch(text); m != nil { + fm.Title = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^#\+filetags:[ \t]*:(.+):$`).FindStringSubmatch(text); m != nil { + fm.Tags = strings.Split(m[1], ":") + } + if m := regexp.MustCompile(`(?m)^#\+identifier:[ \t]*(.+)$`).FindStringSubmatch(text); m != nil { + fm.Identifier = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^#\+signature:[ \t]*(.*)$`).FindStringSubmatch(text); m != nil { + fm.Signature = strings.TrimSpace(m[1]) + } + + case ".md": + // Try YAML first + yamlRe := regexp.MustCompile(`(?ms)^---\n(.*?)\n---`) + if m := yamlRe.FindStringSubmatch(text); m != nil { + fileType = metadata.FileTypeMdYaml + yamlContent := m[1] + if m := regexp.MustCompile(`(?m)^title:[ \t]*["']?(.+?)["']?$`).FindStringSubmatch(yamlContent); m != nil { + fm.Title = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^tags:[ \t]*\[(.+?)\]$`).FindStringSubmatch(yamlContent); m != nil { + tags := strings.Split(m[1], ",") + for i, t := range tags { + t = strings.TrimSpace(t) + t = strings.Trim(t, `"'`) + tags[i] = t + } + fm.Tags = tags + } + if m := regexp.MustCompile(`(?m)^identifier:[ \t]*["']?(.+?)["']?$`).FindStringSubmatch(yamlContent); m != nil { + fm.Identifier = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^signature:[ \t]*["']?(.*)["']?$`).FindStringSubmatch(yamlContent); m != nil { + fm.Signature = strings.TrimSpace(m[1]) + } + } else { + // Try TOML + tomlRe := regexp.MustCompile(`(?ms)^\+\+\+\n(.*?)\n\+\+\+`) + if m := tomlRe.FindStringSubmatch(text); m != nil { + fileType = metadata.FileTypeMdToml + tomlContent := m[1] + if m := regexp.MustCompile(`(?m)^title[ \t]*=[ \t]*["']?(.+?)["']?$`).FindStringSubmatch(tomlContent); m != nil { + fm.Title = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^tags[ \t]*=[ \t]*\[(.+?)\]$`).FindStringSubmatch(tomlContent); m != nil { + tags := strings.Split(m[1], ",") + for i, t := range tags { + t = strings.TrimSpace(t) + t = strings.Trim(t, `"'`) + tags[i] = t + } + fm.Tags = tags + } + if m := regexp.MustCompile(`(?m)^identifier[ \t]*=[ \t]*["']?(.+?)["']?$`).FindStringSubmatch(tomlContent); m != nil { + fm.Identifier = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^signature[ \t]*=[ \t]*["']?(.*)["']?$`).FindStringSubmatch(tomlContent); m != nil { + fm.Signature = strings.TrimSpace(m[1]) + } + } + } + + case ".txt": + fileType = metadata.FileTypeTxt + if m := regexp.MustCompile(`(?m)^title:[ \t]*(.+)$`).FindStringSubmatch(text); m != nil { + fm.Title = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^tags:[ \t]*(.+)$`).FindStringSubmatch(text); m != nil { + fm.Tags = strings.Fields(m[1]) + } + if m := regexp.MustCompile(`(?m)^identifier:[ \t]*(.+)$`).FindStringSubmatch(text); m != nil { + fm.Identifier = strings.TrimSpace(m[1]) + } + if m := regexp.MustCompile(`(?m)^signature:[ \t]*(.*)$`).FindStringSubmatch(text); m != nil { + fm.Signature = strings.TrimSpace(m[1]) + } + } + + return fm, fileType, nil +} diff --git a/pkg/encoding/frontmatter/frontmatter_test.go b/pkg/encoding/frontmatter/frontmatter_test.go new file mode 100644 index 0000000..7dcb023 --- /dev/null +++ b/pkg/encoding/frontmatter/frontmatter_test.go @@ -0,0 +1,388 @@ +package frontmatter + +import ( + "denotesrv/pkg/metadata" + "slices" + "strings" + "testing" +) + +// TestFormatTags validates tag formatting for different file types +// Maps to dt-denote--format-front-matter from original tests +func TestFormatTags(t *testing.T) { + tests := []struct { + name string + tags []string + fileType metadata.FileType + want string + }{ + { + name: "org with multiple tags", + tags: []string{"tag1", "tag2"}, + fileType: metadata.FileTypeOrg, + want: ":tag1:tag2:", + }, + { + name: "org with single tag", + tags: []string{"single"}, + fileType: metadata.FileTypeOrg, + want: ":single:", + }, + { + name: "org with empty tags", + tags: []string{}, + fileType: metadata.FileTypeOrg, + want: "", + }, + { + name: "md-yaml with multiple tags", + tags: []string{"tag1", "tag2"}, + fileType: metadata.FileTypeMdYaml, + want: "[tag1, tag2]", + }, + { + name: "md-yaml with single tag", + tags: []string{"single"}, + fileType: metadata.FileTypeMdYaml, + want: "[single]", + }, + { + name: "md-yaml with empty tags", + tags: []string{}, + fileType: metadata.FileTypeMdYaml, + want: "", + }, + { + name: "md-toml with multiple tags", + tags: []string{"tag1", "tag2"}, + fileType: metadata.FileTypeMdToml, + want: "[tag1, tag2]", + }, + { + name: "md-toml with empty tags", + tags: []string{}, + fileType: metadata.FileTypeMdToml, + want: "", + }, + { + name: "txt with multiple tags", + tags: []string{"tag1", "tag2"}, + fileType: metadata.FileTypeTxt, + want: "tag1 tag2", + }, + { + name: "txt with single tag", + tags: []string{"single"}, + fileType: metadata.FileTypeTxt, + want: "single", + }, + { + name: "txt with empty tags", + tags: []string{}, + fileType: metadata.FileTypeTxt, + want: "", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := formatTags(tt.tags, tt.fileType) + if got != tt.want { + t.Errorf("formatTags(%v, %q) = %q, want %q", tt.tags, tt.fileType, got, tt.want) + } + }) + } +} + +// TestFrontMatterBytes validates front matter formatting for all file types +// Maps to dt-denote--format-front-matter from original tests +func TestFrontMatterBytes(t *testing.T) { + identifier := "20240101T120000" + title := "Test Note" + tags := []string{"tag1", "tag2"} + + tests := []struct { + name string + fileType metadata.FileType + wantContains []string + wantNotContains []string + }{ + { + name: "org format", + fileType: metadata.FileTypeOrg, + wantContains: []string{ + "#+title: Test Note", + "#+filetags: :tag1:tag2:", + "#+identifier: 20240101T120000", + "#+date:", + }, + }, + { + name: "md-yaml format", + fileType: metadata.FileTypeMdYaml, + wantContains: []string{ + "---", + "title: Test Note", + "tags: [tag1, tag2]", + "identifier: 20240101T120000", + "date:", + }, + }, + { + name: "md-toml format", + fileType: metadata.FileTypeMdToml, + wantContains: []string{ + "+++", + "title = Test Note", + "tags = [tag1, tag2]", + "identifier = 20240101T120000", + "date =", + }, + }, + { + name: "txt format", + fileType: metadata.FileTypeTxt, + wantContains: []string{ + "title: Test Note", + "tags: tag1 tag2", + "identifier: 20240101T120000", + "date:", + "---------------------------", + }, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + fm := metadata.NewFrontMatter(title, "", tags, identifier) + got := string(Marshal(fm, tt.fileType)) + + for _, want := range tt.wantContains { + if !strings.Contains(got, want) { + t.Errorf("FrontMatter.Bytes() missing %q\nGot:\n%s", want, got) + } + } + + for _, notWant := range tt.wantNotContains { + if strings.Contains(got, notWant) { + t.Errorf("FrontMatter.Bytes() should not contain %q\nGot:\n%s", notWant, got) + } + } + }) + } +} + +// TestFrontMatterBytesEmptyTags validates front matter formatting with no tags +func TestFrontMatterBytesEmptyTags(t *testing.T) { + identifier := "20240101T120000" + title := "Test Note" + tags := []string{} + + tests := []struct { + name string + fileType metadata.FileType + wantTags string + }{ + { + name: "org with empty tags", + fileType: metadata.FileTypeOrg, + wantTags: "#+filetags:", + }, + { + name: "md-yaml with empty tags", + fileType: metadata.FileTypeMdYaml, + wantTags: "tags:", + }, + { + name: "md-toml with empty tags", + fileType: metadata.FileTypeMdToml, + wantTags: "tags =", + }, + { + name: "txt with empty tags", + fileType: metadata.FileTypeTxt, + wantTags: "tags:", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + fm := metadata.NewFrontMatter(title, "", tags, identifier) + got := string(Marshal(fm, tt.fileType)) + + if !strings.Contains(got, tt.wantTags) { + t.Errorf("FrontMatter.Bytes() with empty tags should contain %q\nGot:\n%s", + tt.wantTags, got) + } + }) + } +} + +// TestUnmarshal validates front matter parsing from content +func TestUnmarshal(t *testing.T) { + tests := []struct { + name string + content string + ext string + wantTitle string + wantTags []string + wantIdentifier string + wantFileType metadata.FileType + }{ + { + name: "org format", + content: `#+title: Org Note +#+date: [2024-01-01 Mon 12:00] +#+filetags: :work:emacs: +#+identifier: 20240101T120000 + +* First Heading`, + ext: ".org", + wantTitle: "Org Note", + wantTags: []string{"work", "emacs"}, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeOrg, + }, + { + name: "org with single tag", + content: `#+title: Single Tag +#+filetags: :single: +#+identifier: 20240101T120000`, + ext: ".org", + wantTitle: "Single Tag", + wantTags: []string{"single"}, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeOrg, + }, + { + name: "org without tags", + content: `#+title: No Tags +#+identifier: 20240101T120000`, + ext: ".org", + wantTitle: "No Tags", + wantTags: nil, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeOrg, + }, + { + name: "markdown yaml", + content: `--- +title: Markdown Note +date: 2024-01-01 +tags: [work, personal] +identifier: 20240101T120000 +--- + +# Content`, + ext: ".md", + wantTitle: "Markdown Note", + wantTags: []string{"work", "personal"}, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeMdYaml, + }, + { + name: "markdown yaml with quoted title", + content: `--- +title: "Quoted Title" +tags: [test] +identifier: 20240101T120000 +---`, + ext: ".md", + wantTitle: "Quoted Title", + wantTags: []string{"test"}, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeMdYaml, + }, + { + name: "markdown toml", + content: `+++ +title = TOML Note +date = 2024-01-01 +tags = [rust, go] +identifier = 20240101T120000 ++++ + +Content`, + ext: ".md", + wantTitle: "TOML Note", + wantTags: []string{"rust", "go"}, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeMdToml, + }, + { + name: "txt format", + content: `title: Plain Text +date: 2024-01-01 +tags: simple plain +identifier: 20240101T120000 +--------------------------- + +Content here`, + ext: ".txt", + wantTitle: "Plain Text", + wantTags: []string{"simple", "plain"}, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeTxt, + }, + { + name: "txt without tags", + content: `title: No Tags Text +identifier: 20240101T120000 +---------------------------`, + ext: ".txt", + wantTitle: "No Tags Text", + wantTags: nil, + wantIdentifier: "20240101T120000", + wantFileType: metadata.FileTypeTxt, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, fileType, err := Unmarshal([]byte(tt.content), tt.ext) + if err != nil { + t.Fatalf("Unmarshal() error = %v", err) + } + + if got.Title != tt.wantTitle { + t.Errorf("Unmarshal().Title = %q, want %q", got.Title, tt.wantTitle) + } + + if !slices.Equal(got.Tags, tt.wantTags) { + t.Errorf("Unmarshal().Tags = %v, want %v", got.Tags, tt.wantTags) + } + + if got.Identifier != tt.wantIdentifier { + t.Errorf("Unmarshal().Identifier = %q, want %q", got.Identifier, tt.wantIdentifier) + } + + if fileType != tt.wantFileType { + t.Errorf("Unmarshal() fileType = %q, want %q", fileType, tt.wantFileType) + } + }) + } +} + +// TestUnmarshalMissingFields validates handling of missing fields +func TestUnmarshalMissingFields(t *testing.T) { + content := `--- +date: 2024-01-01 +---` + + got, _, err := Unmarshal([]byte(content), ".md") + if err != nil { + t.Fatalf("Unmarshal() error = %v", err) + } + + // Should have empty values, not error + if got.Title != "" { + t.Errorf("Unmarshal().Title = %q, want empty", got.Title) + } + if got.Identifier != "" { + t.Errorf("Unmarshal().Identifier = %q, want empty", got.Identifier) + } + if got.Tags != nil { + t.Errorf("Unmarshal().Tags = %v, want nil", got.Tags) + } +} + diff --git a/pkg/encoding/results/results.go b/pkg/encoding/results/results.go new file mode 100644 index 0000000..9dd854a --- /dev/null +++ b/pkg/encoding/results/results.go @@ -0,0 +1,88 @@ +package results + +import ( + "bytes" + "fmt" + "log" + "regexp" + "strings" + + "denotesrv/pkg/metadata" +) + +// Marshal serializes Results to a pipe-delimited byte format. +// Format: identifier | title | tags (comma-separated) +func Marshal(rs metadata.Results) []byte { + var buf strings.Builder + for _, e := range rs { + title := e.Title + if title == "" { + title = "(untitled)" + } + + tags := strings.Join(e.Tags, ",") + fmt.Fprintf(&buf, "%s | %s | %s\n", e.Identifier, title, tags) + } + return []byte(buf.String()) +} + +// Unmarshal parses pipe-delimited byte data into Results. +// Format: identifier | title | tags (comma-separated) +// Invalid tags produce warnings but parsing continues. +func Unmarshal(data []byte) (metadata.Results, error) { + return unmarshal(data, false) +} + +// UnmarshalStrict parses pipe-delimited byte data into Results with strict tag validation. +// Returns an error if any tags are invalid. +func UnmarshalStrict(data []byte) (metadata.Results, error) { + return unmarshal(data, true) +} + +func unmarshal(data []byte, strict bool) (metadata.Results, error) { + var results metadata.Results + lines := bytes.Split(bytes.TrimSpace(data), []byte("\n")) + // Allow lowercase Latin letters, other letters (CJK, etc.), and digits, no spaces + tagPattern := regexp.MustCompile(`^([\p{Ll}\p{Lo}\p{Nd}]+,)*[\p{Ll}\p{Lo}\p{Nd}]+$`) + + for lineNum, line := range lines { + line = bytes.TrimSpace(line) + if len(line) == 0 { + continue + } + + parts := bytes.Split(line, []byte("|")) + if len(parts) != 3 { + return nil, fmt.Errorf("line %d: expected 3 columns, got %d (line: %q)", lineNum+1, len(parts), line) + } + + identifier := string(bytes.TrimSpace(parts[0])) + title := string(bytes.TrimSpace(parts[1])) + tagsStr := string(bytes.TrimSpace(parts[2])) + + if identifier == "" { + return nil, fmt.Errorf("line %d: identifier cannot be empty", lineNum+1) + } + + var tags []string + if tagsStr != "" { + if !tagPattern.MatchString(tagsStr) { + if strict { + return nil, fmt.Errorf("line %d: tags must be comma-delimited lowercase unicode words (no spaces): got '%s'", lineNum+1, tagsStr) + } + log.Printf("warning: line %d: invalid tags '%s' (must be lowercase alphanumeric)", lineNum+1, tagsStr) + } + tags = strings.Split(tagsStr, ",") + } else { + tags = []string{} + } + + results = append(results, &metadata.Metadata{ + Identifier: identifier, + Title: title, + Tags: tags, + }) + } + + return results, nil +} diff --git a/pkg/encoding/results/results_test.go b/pkg/encoding/results/results_test.go new file mode 100644 index 0000000..3ee0d75 --- /dev/null +++ b/pkg/encoding/results/results_test.go @@ -0,0 +1,186 @@ +package results + +import ( + "denotesrv/pkg/metadata" + "slices" + "testing" +) + +// TestMarshal validates serialization +func TestMarshal(t *testing.T) { + tests := []struct { + name string + input metadata.Results + want string + }{ + { + name: "single note with tags", + input: metadata.Results{ + { + Identifier: "20240101T120000", + Title: "Test Note", + Tags: []string{"tag1", "tag2"}, + }, + }, + want: "20240101T120000 | Test Note | tag1,tag2\n", + }, + { + name: "note without tags", + input: metadata.Results{ + { + Identifier: "20240101T120000", + Title: "Simple Note", + Tags: []string{}, + }, + }, + want: "20240101T120000 | Simple Note | \n", + }, + { + name: "note without title", + input: metadata.Results{ + { + Identifier: "20240101T120000", + Title: "", + Tags: []string{"tag"}, + }, + }, + want: "20240101T120000 | (untitled) | tag\n", + }, + { + name: "multiple notes", + input: metadata.Results{ + {Identifier: "20240101T120000", Title: "First", Tags: []string{"a"}}, + {Identifier: "20240102T120000", Title: "Second", Tags: []string{"b", "c"}}, + }, + want: "20240101T120000 | First | a\n20240102T120000 | Second | b,c\n", + }, + { + name: "empty results", + input: metadata.Results{}, + want: "", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := string(Marshal(tt.input)) + if got != tt.want { + t.Errorf("Marshal() = %q, want %q", got, tt.want) + } + }) + } +} + +// TestUnmarshal validates parsing from byte format +func TestUnmarshal(t *testing.T) { + tests := []struct { + name string + input []byte + want metadata.Results + wantErr bool + }{ + { + name: "single note with tags", + input: []byte("20240101T120000 | Test Note | tag1,tag2"), + want: metadata.Results{ + {Identifier: "20240101T120000", Title: "Test Note", Tags: []string{"tag1", "tag2"}}, + }, + wantErr: false, + }, + { + name: "note without tags", + input: []byte("20240101T120000 | Simple Note | "), + want: metadata.Results{ + {Identifier: "20240101T120000", Title: "Simple Note", Tags: []string{}}, + }, + wantErr: false, + }, + { + name: "multiple notes", + input: []byte("20240101T120000 | First | a\n20240102T120000 | Second | b,c"), + want: metadata.Results{ + {Identifier: "20240101T120000", Title: "First", Tags: []string{"a"}}, + {Identifier: "20240102T120000", Title: "Second", Tags: []string{"b", "c"}}, + }, + wantErr: false, + }, + { + name: "empty input", + input: []byte(""), + want: nil, + wantErr: false, + }, + { + name: "wrong column count", + input: []byte("20240101T120000 | Title"), + want: nil, + wantErr: true, + }, + { + name: "empty identifier", + input: []byte(" | Title | tags"), + want: nil, + wantErr: true, + }, + { + name: "invalid tags with spaces", + input: []byte("20240101T120000 | Title | tag with spaces"), + want: nil, + wantErr: true, + }, + { + name: "invalid tags with uppercase", + input: []byte("20240101T120000 | Title | Tag1,tag2"), + want: nil, + wantErr: true, + }, + { + name: "valid lowercase unicode tags", + input: []byte("20240101T120000 | Title | tag1,测试,αβγ"), + want: metadata.Results{ + {Identifier: "20240101T120000", Title: "Title", Tags: []string{"tag1", "测试", "αβγ"}}, + }, + wantErr: false, + }, + { + name: "blank lines ignored", + input: []byte("20240101T120000 | First | a\n\n20240102T120000 | Second | b"), + want: metadata.Results{ + {Identifier: "20240101T120000", Title: "First", Tags: []string{"a"}}, + {Identifier: "20240102T120000", Title: "Second", Tags: []string{"b"}}, + }, + wantErr: false, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Unmarshal(tt.input) + + if (err != nil) != tt.wantErr { + t.Errorf("Unmarshal() error = %v, wantErr %v", err, tt.wantErr) + return + } + + if tt.wantErr { + return + } + + if len(got) != len(tt.want) { + t.Fatalf("Unmarshal() length = %d, want %d", len(got), len(tt.want)) + } + + for i := range got { + if got[i].Identifier != tt.want[i].Identifier { + t.Errorf("Result[%d].Identifier = %q, want %q", i, got[i].Identifier, tt.want[i].Identifier) + } + if got[i].Title != tt.want[i].Title { + t.Errorf("Result[%d].Title = %q, want %q", i, got[i].Title, tt.want[i].Title) + } + if !slices.Equal(got[i].Tags, tt.want[i].Tags) { + t.Errorf("Result[%d].Tags = %v, want %v", i, got[i].Tags, tt.want[i].Tags) + } + } + }) + } +} diff --git a/pkg/metadata/filter.go b/pkg/metadata/filter.go new file mode 100644 index 0000000..ff5209e --- /dev/null +++ b/pkg/metadata/filter.go @@ -0,0 +1,112 @@ +package metadata + +import ( + "fmt" + "regexp" + "slices" + "strings" +) + +// Filter matches a given field in a Result to a regular expression +type Filter struct { + field FilterField + re *regexp.Regexp + negate bool +} + +type Filters []*Filter + +type FilterField string + +const ( + FilterDate FilterField = "date" + FilterTitle FilterField = "title" + FilterTag FilterField = "tag" + FilterAny FilterField = "" +) + +// Parse converts a slice of strings of the form "tag:", +// "date:", "title:''" into a Filters list +func (fs Filters) Parse(S []string) (Filters, error) { + for _, fa := range S { + f, err := NewFilter(fa) + if err != nil { + return nil, fmt.Errorf("failed to list notes: %w", err) + } + fs = append(fs, f) + } + return fs, nil +} + +// NewFilter constructs a Filter from a filter string. arg takes the form +// field:criteria, e.g., tag:/dev|meeting/, date:20251101. +func NewFilter(arg string) (*Filter, error) { + negate := strings.HasPrefix(arg, "!") + if negate { + arg = strings.TrimPrefix(arg, "!") + } + + m := regexp.MustCompile(`^(?:(date|title|tag):)?(.+)$`).FindStringSubmatch(arg) + if m == nil { + return nil, fmt.Errorf("invalid filter syntax: %s", arg) + } + + fieldStr := m[1] + value := m[2] + + // Strip surrounding quotes (both single and double) + value = strings.Trim(value, `"'`) + + // Validate: if field is title and value has spaces, original should have been quoted + if fieldStr == "title" && strings.Contains(value, " ") { + // Check if original value was quoted + if !strings.HasPrefix(m[2], `"`) && !strings.HasPrefix(m[2], `'`) { + return nil, fmt.Errorf("title with spaces must be quoted: %s", arg) + } + } + + pattern := value + if strings.HasPrefix(pattern, "/") && strings.HasSuffix(pattern, "/") { + pattern = strings.TrimPrefix(strings.TrimSuffix(pattern, "/"), "/") + } else { + pattern = regexp.QuoteMeta(pattern) + } + + re, err := regexp.Compile("(?i)" + pattern) + if err != nil { + return nil, fmt.Errorf("invalid regex: %v", err) + } + + return &Filter{field: FilterField(fieldStr), re: re, negate: negate}, nil +} + +// IsMatch checks if a note matches this filter +func (f *Filter) IsMatch(n *Metadata) bool { + result := false + switch f.field { + case FilterDate: + result = f.re.MatchString(n.Identifier) + case FilterTitle: + result = f.re.MatchString(n.Title) + case FilterTag: + result = slices.ContainsFunc(n.Tags, func(kw string) bool { + return f.re.MatchString(kw) + }) + case FilterAny: // any field + if f.re.MatchString(n.Identifier) { + result = true + } else if f.re.MatchString(n.Title) { + result = true + } else { + result = slices.ContainsFunc(n.Tags, func(kw string) bool { + return f.re.MatchString(kw) + }) + } + default: + return false + } + if f.negate { + return !result + } + return result +} diff --git a/pkg/metadata/frontmatter.go b/pkg/metadata/frontmatter.go new file mode 100644 index 0000000..1cd37a2 --- /dev/null +++ b/pkg/metadata/frontmatter.go @@ -0,0 +1,43 @@ +package metadata + +// FileType represents supported file formats for denote notes +type FileType string + +const ( + FileTypeOrg FileType = "org" + FileTypeMdYaml FileType = "md-yaml" + FileTypeMdToml FileType = "md-toml" + FileTypeTxt FileType = "txt" +) + +// fileExtensions contains the list of file extensions +// for which Denote should add front matter. +var fileExtensions = map[FileType]string{ + FileTypeOrg: ".org", + FileTypeMdYaml: ".md", + FileTypeMdToml: ".md", + FileTypeTxt: ".txt", +} + +// GetExtension returns the file extension for a given file type. +func GetExtension(fileType FileType) string { + return fileExtensions[fileType] +} + +// FrontMatter represents parsed front matter from a note +type FrontMatter struct { + Title string + Tags []string + Identifier string + Signature string +} + +// NewFrontMatter creates a new FrontMatter struct from given parameters +func NewFrontMatter(title, signature string, tags []string, identifier string) *FrontMatter { + return &FrontMatter{ + Title: title, + Tags: tags, + Identifier: identifier, + Signature: signature, + } +} diff --git a/pkg/metadata/metadata.go b/pkg/metadata/metadata.go new file mode 100644 index 0000000..00208b6 --- /dev/null +++ b/pkg/metadata/metadata.go @@ -0,0 +1,169 @@ +package metadata + +import ( + "fmt" + "path/filepath" + "regexp" + "sort" + "strings" + "time" + "unicode" +) + +// Metadata is the metadata encoded into Denote-style +// file names. +type Metadata struct { + Path string + Identifier string + Signature string + Title string + Tags []string +} + +type Results []*Metadata + +type SortBy string + +const ( + SortById SortBy = "id" + SortByDate SortBy = "date" + SortByTitle SortBy = "title" +) + +type SortOrder int + +const ( + SortOrderAsc SortOrder = iota + SortOrderDesc +) + +// Sort organizes a list of notes by sortType and order using metadata. +func Sort(md Results, sortType SortBy, order SortOrder) { + switch sortType { + case SortById, SortByDate: + sort.Slice(md, func(i, j int) bool { + if order == SortOrderAsc { + return md[i].Identifier < md[j].Identifier // Reverse chronological by default + } else { + return md[i].Identifier > md[j].Identifier // Reverse chronological by default + } + }) + case SortByTitle: + sort.Slice(md, func(i, j int) bool { + if order == SortOrderAsc { + return strings.ToLower(md[i].Title) < strings.ToLower(md[j].Title) + } else { + return strings.ToLower(md[i].Title) > strings.ToLower(md[j].Title) + } + }) + default: + sort.Slice(md, func(i, j int) bool { + return md[i].Identifier > md[j].Identifier // Reverse chronological by default + }) + } +} + +// ParseFilename extracts Denote metadata from a filename only (no file I/O). +// Returns metadata with Path, Identifier, Signature, Title (from filename), and Tags. +func ParseFilename(path string) *Metadata { + fname := filepath.Base(path) + note := &Metadata{Path: path} + + if m := regexp.MustCompile(`^(\d{8}T\d{6})`).FindStringSubmatch(fname); m != nil { + note.Identifier = m[1] + } + + // Extract signature (optional component between identifier and title) + if m := regexp.MustCompile(`==([^-]+?)--`).FindStringSubmatch(fname); m != nil { + note.Signature = m[1] + } + + // Extract title from filename + if m := regexp.MustCompile(`--([^_\.]+)`).FindStringSubmatch(fname); m != nil { + note.Title = strings.ReplaceAll(m[1], "-", " ") + } + + if m := regexp.MustCompile(`__(.+?)(?:\.|$)`).FindStringSubmatch(fname); m != nil { + note.Tags = strings.Split(m[1], "_") + } + + return note +} + +// IsValidTag returns true if the tag contains only lowercase letters, other unicode letters, or digits. +func IsValidTag(tag string) bool { + for _, r := range tag { + if !unicode.IsLetter(r) && !unicode.IsDigit(r) { + return false + } + if unicode.IsLetter(r) && unicode.IsUpper(r) { + return false + } + } + return len(tag) > 0 +} + +// ValidateTags checks all tags and returns invalid ones. +func ValidateTags(tags []string) []string { + var invalid []string + for _, tag := range tags { + if !IsValidTag(tag) { + invalid = append(invalid, tag) + } + } + return invalid +} + +// GenerateIdentifier creates a new identifier timestamp. +func GenerateIdentifier() string { + return time.Now().Format("20060102T150405") +} + +// slugifyTitle converts a title to a filesystem-safe slug. +func slugifyTitle(title string) string { + slug := strings.ToLower(title) + slug = strings.ReplaceAll(slug, " ", "-") + slug = strings.ReplaceAll(slug, "_", "-") + return regexp.MustCompile(`[^a-z0-9-]`).ReplaceAllString(slug, "") +} + +// slugifySignature converts a signature to Denote-compliant format. +// Following Denote rules: lowercase, spaces/underscores -> double equals, +// remove special chars, normalize consecutive equals to double equals. +func slugifySignature(sig string) string { + slug := strings.ToLower(sig) + slug = strings.ReplaceAll(slug, " ", "==") + slug = strings.ReplaceAll(slug, "_", "==") + // Remove special characters per Denote spec + slug = regexp.MustCompile(`[{}!@#$%^&*()+'"?,.\\|;:~\x60''""/-]`).ReplaceAllString(slug, "") + // Normalize consecutive equals signs (3 or more) to double equals + slug = regexp.MustCompile(`={3,}`).ReplaceAllString(slug, "==") + // Trim trailing equals + slug = strings.Trim(slug, "=") + return slug +} + +// formatKeywords formats keywords for a denote filename. +func formatKeywords(keywords []string) string { + if len(keywords) == 0 { + return "" + } + return "__" + strings.Join(keywords, "_") +} + +// formatSignature formats a signature for a denote filename. +// Returns empty string if signature is empty, otherwise returns ==signature. +func formatSignature(sig string) string { + if sig == "" { + return "" + } + return "==" + slugifySignature(sig) +} + +// BuildFilename constructs a denote filename from metadata components. +func BuildFilename(fm *FrontMatter, ext string) string { + titleSlug := slugifyTitle(fm.Title) + signaturePart := formatSignature(fm.Signature) + keywordsPart := formatKeywords(fm.Tags) + return fmt.Sprintf("%s%s--%s%s%s", fm.Identifier, signaturePart, titleSlug, keywordsPart, ext) +} diff --git a/pkg/metadata/metadata_test.go b/pkg/metadata/metadata_test.go new file mode 100644 index 0000000..0ebebd8 --- /dev/null +++ b/pkg/metadata/metadata_test.go @@ -0,0 +1,506 @@ +package metadata + +import ( + "regexp" + "slices" + "testing" + "time" +) + +// TestGenerateIdentifier validates timestamp format (YYYYMMDDThhmmss) +// Maps to dt-denote-identifier-p from original tests +func TestGenerateIdentifier(t *testing.T) { + id := GenerateIdentifier() + + // Validate format + pattern := regexp.MustCompile(`^\d{8}T\d{6}$`) + if !pattern.MatchString(id) { + t.Errorf("GenerateIdentifier() = %q, want format YYYYMMDDThhmmss", id) + } + + // Validate it's a valid timestamp + _, err := time.Parse("20060102T150405", id) + if err != nil { + t.Errorf("GenerateIdentifier() = %q, not a valid timestamp: %v", id, err) + } +} + +// TestSlugifyTitle validates title slugification +// Maps to dt-denote-sluggify-title and dt-denote-sluggify from original tests +func TestSlugifyTitle(t *testing.T) { + tests := []struct { + name string + input string + want string + }{ + { + name: "basic spaces to hyphens", + input: "Hello World", + want: "hello-world", + }, + { + name: "underscores to hyphens", + input: "Test_File Name", + want: "test-file-name", + }, + { + name: "remove punctuation", + input: "Test File!", + want: "test-file", + }, + { + name: "mixed case", + input: "Mixed CASE 123", + want: "mixed-case-123", + }, + { + name: "special characters", + input: "Special@#$Chars", + want: "specialchars", + }, + { + name: "multiple spaces", + input: "Multiple Spaces", + want: "multiple---spaces", + }, + { + name: "leading and trailing spaces", + input: " Trim Me ", + want: "--trim-me--", + }, + { + name: "empty string", + input: "", + want: "", + }, + { + name: "numbers only", + input: "12345", + want: "12345", + }, + { + name: "hyphens preserved", + input: "already-hyphenated", + want: "already-hyphenated", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := slugifyTitle(tt.input) + if got != tt.want { + t.Errorf("slugifyTitle(%q) = %q, want %q", tt.input, got, tt.want) + } + }) + } +} + +// TestFormatKeywords validates keyword formatting for filenames +// Maps to dt-denote-sluggify-keywords from original tests +func TestFormatKeywords(t *testing.T) { + tests := []struct { + name string + input []string + want string + }{ + { + name: "multiple keywords", + input: []string{"tag1", "tag2"}, + want: "__tag1_tag2", + }, + { + name: "single keyword", + input: []string{"single"}, + want: "__single", + }, + { + name: "empty keywords", + input: []string{}, + want: "", + }, + { + name: "nil keywords", + input: nil, + want: "", + }, + { + name: "three keywords", + input: []string{"one", "two", "three"}, + want: "__one_two_three", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := formatKeywords(tt.input) + if got != tt.want { + t.Errorf("formatKeywords(%v) = %q, want %q", tt.input, got, tt.want) + } + }) + } +} + +// TestSlugifySignature validates signature slugification +func TestSlugifySignature(t *testing.T) { + tests := []struct { + name string + input string + want string + }{ + { + name: "basic spaces to equals", + input: "Hello World", + want: "hello==world", + }, + { + name: "underscores to equals", + input: "test_file", + want: "test==file", + }, + { + name: "remove special characters", + input: "a!@#b", + want: "ab", + }, + { + name: "normalize consecutive equals", + input: "a===b", + want: "a==b", + }, + { + name: "mixed", + input: "Hello World_Test", + want: "hello==world==test", + }, + { + name: "trim trailing equals", + input: "test_", + want: "test", + }, + { + name: "empty string", + input: "", + want: "", + }, + { + name: "lowercase already", + input: "already", + want: "already", + }, + { + name: "numbers preserved", + input: "test123", + want: "test123", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := slugifySignature(tt.input) + if got != tt.want { + t.Errorf("slugifySignature(%q) = %q, want %q", tt.input, got, tt.want) + } + }) + } +} + +// TestBuildFilename validates filename construction +// Maps to dt-denote-format-file-name from original tests +func TestBuildFilename(t *testing.T) { + tests := []struct { + name string + identifier string + signature string + title string + keywords []string + ext string + want string + ftype FileType + }{ + { + name: "complete filename with keywords", + identifier: "20231225T120000", + signature: "", + title: "My Title", + keywords: []string{"tag1", "tag2"}, + ext: ".md", + want: "20231225T120000--my-title__tag1_tag2.md", + ftype: FileTypeMdYaml, + }, + { + name: "filename without keywords", + identifier: "20231225T120000", + signature: "", + title: "My Title", + keywords: []string{}, + ext: ".md", + want: "20231225T120000--my-title.md", + ftype: FileTypeMdYaml, + }, + { + name: "filename with signature", + identifier: "20231225T120000", + signature: "hello", + title: "My Title", + keywords: []string{"tag1"}, + ext: ".md", + want: "20231225T120000==hello--my-title__tag1.md", + ftype: FileTypeMdYaml, + }, + { + name: "filename with signature and no keywords", + identifier: "20231225T120000", + signature: "test", + title: "My Title", + keywords: []string{}, + ext: ".md", + want: "20231225T120000==test--my-title.md", + ftype: FileTypeMdYaml, + }, + { + name: "filename with multi-part signature", + identifier: "20231225T120000", + signature: "a==b", + title: "My Title", + keywords: []string{"work"}, + ext: ".md", + want: "20231225T120000==a==b--my-title__work.md", + ftype: FileTypeMdYaml, + }, + { + name: "filename with special chars in title", + identifier: "20231225T120000", + signature: "", + title: "Special!@# Title", + keywords: []string{"work"}, + ext: ".org", + want: "20231225T120000--special-title__work.org", + ftype: FileTypeOrg, + }, + { + name: "org format", + identifier: "20240101T000000", + signature: "", + title: "Org Note", + keywords: []string{"emacs"}, + ext: ".org", + want: "20240101T000000--org-note__emacs.org", + ftype: FileTypeOrg, + }, + { + name: "txt format", + identifier: "20240101T000000", + signature: "", + title: "Plain Text", + keywords: []string{}, + ext: ".txt", + want: "20240101T000000--plain-text.txt", + ftype: FileTypeTxt, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + fm := NewFrontMatter(tt.title, tt.signature, tt.keywords, tt.identifier) + got := BuildFilename(fm, tt.ext) + if got != tt.want { + t.Errorf("BuildFilename() = %q, want %q", got, tt.want) + } + }) + } +} + +// TestParseFilename validates filename parsing +// Maps to dt-denote-retrieve-filename-* tests from original +func TestParseFilename(t *testing.T) { + tests := []struct { + name string + path string + wantIdentifier string + wantSignature string + wantTitle string + wantTags []string + }{ + { + name: "complete filename with tags", + path: "/home/notes/20231225T120000--my-title__tag1_tag2.md", + wantIdentifier: "20231225T120000", + wantSignature: "", + wantTitle: "my title", + wantTags: []string{"tag1", "tag2"}, + }, + { + name: "filename without tags", + path: "/home/notes/20231225T120000--simple-title.md", + wantIdentifier: "20231225T120000", + wantSignature: "", + wantTitle: "simple title", + wantTags: nil, + }, + { + name: "filename with signature", + path: "20240101T000000==hello--note__work.org", + wantIdentifier: "20240101T000000", + wantSignature: "hello", + wantTitle: "note", + wantTags: []string{"work"}, + }, + { + name: "filename with signature and no tags", + path: "20240101T000000==test--title.md", + wantIdentifier: "20240101T000000", + wantSignature: "test", + wantTitle: "title", + wantTags: nil, + }, + { + name: "filename with multi-part signature", + path: "20240101T000000==a==b--note__tag.md", + wantIdentifier: "20240101T000000", + wantSignature: "a==b", + wantTitle: "note", + wantTags: []string{"tag"}, + }, + { + name: "filename with single tag", + path: "20240101T000000--note__work.org", + wantIdentifier: "20240101T000000", + wantSignature: "", + wantTitle: "note", + wantTags: []string{"work"}, + }, + { + name: "identifier only", + path: "20240101T000000.txt", + wantIdentifier: "20240101T000000", + wantSignature: "", + wantTitle: "", + wantTags: nil, + }, + { + name: "multi-word title", + path: "20240101T000000--multi-word-title__personal_ideas.md", + wantIdentifier: "20240101T000000", + wantSignature: "", + wantTitle: "multi word title", + wantTags: []string{"personal", "ideas"}, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := ParseFilename(tt.path) + + if got.Identifier != tt.wantIdentifier { + t.Errorf("ParseFilename(%q).Identifier = %q, want %q", + tt.path, got.Identifier, tt.wantIdentifier) + } + + if got.Signature != tt.wantSignature { + t.Errorf("ParseFilename(%q).Signature = %q, want %q", + tt.path, got.Signature, tt.wantSignature) + } + + if got.Title != tt.wantTitle { + t.Errorf("ParseFilename(%q).Title = %q, want %q", + tt.path, got.Title, tt.wantTitle) + } + + if !slices.Equal(got.Tags, tt.wantTags) { + t.Errorf("ParseFilename(%q).Tags = %v, want %v", + tt.path, got.Tags, tt.wantTags) + } + + if got.Path != tt.path { + t.Errorf("ParseFilename(%q).Path = %q, want %q", + tt.path, got.Path, tt.path) + } + }) + } +} + +// TestSort validates sorting functionality +func TestSort(t *testing.T) { + notes := Results{ + {Identifier: "20240103T120000", Title: "Charlie"}, + {Identifier: "20240101T120000", Title: "Alice"}, + {Identifier: "20240102T120000", Title: "Bob"}, + } + + t.Run("sort by id ascending", func(t *testing.T) { + testData := make(Results, len(notes)) + copy(testData, notes) + + Sort(testData, SortById, SortOrderAsc) + + if testData[0].Identifier != "20240101T120000" { + t.Errorf("First item identifier = %q, want %q", testData[0].Identifier, "20240101T120000") + } + if testData[2].Identifier != "20240103T120000" { + t.Errorf("Last item identifier = %q, want %q", testData[2].Identifier, "20240103T120000") + } + }) + + t.Run("sort by id descending", func(t *testing.T) { + testData := make(Results, len(notes)) + copy(testData, notes) + + Sort(testData, SortById, SortOrderDesc) + + if testData[0].Identifier != "20240103T120000" { + t.Errorf("First item identifier = %q, want %q", testData[0].Identifier, "20240103T120000") + } + if testData[2].Identifier != "20240101T120000" { + t.Errorf("Last item identifier = %q, want %q", testData[2].Identifier, "20240101T120000") + } + }) + + t.Run("sort by title ascending", func(t *testing.T) { + testData := make(Results, len(notes)) + copy(testData, notes) + + Sort(testData, SortByTitle, SortOrderAsc) + + if testData[0].Title != "Alice" { + t.Errorf("First item title = %q, want %q", testData[0].Title, "Alice") + } + if testData[2].Title != "Charlie" { + t.Errorf("Last item title = %q, want %q", testData[2].Title, "Charlie") + } + }) + + t.Run("sort by title descending", func(t *testing.T) { + testData := make(Results, len(notes)) + copy(testData, notes) + + Sort(testData, SortByTitle, SortOrderDesc) + + if testData[0].Title != "Charlie" { + t.Errorf("First item title = %q, want %q", testData[0].Title, "Charlie") + } + if testData[2].Title != "Alice" { + t.Errorf("Last item title = %q, want %q", testData[2].Title, "Alice") + } + }) + + t.Run("sort by title case insensitive", func(t *testing.T) { + testData := Results{ + {Identifier: "1", Title: "zebra"}, + {Identifier: "2", Title: "Apple"}, + {Identifier: "3", Title: "banana"}, + } + + Sort(testData, SortByTitle, SortOrderAsc) + + // Should be: Apple, banana, zebra (case-insensitive) + if testData[0].Title != "Apple" { + t.Errorf("First item title = %q, want %q", testData[0].Title, "Apple") + } + if testData[1].Title != "banana" { + t.Errorf("Second item title = %q, want %q", testData[1].Title, "banana") + } + if testData[2].Title != "zebra" { + t.Errorf("Third item title = %q, want %q", testData[2].Title, "zebra") + } + }) +} \ No newline at end of file diff --git a/pkg/util/util.go b/pkg/util/util.go new file mode 100644 index 0000000..3e086f2 --- /dev/null +++ b/pkg/util/util.go @@ -0,0 +1,70 @@ +package util + +import ( + "denotesrv/pkg/encoding/frontmatter" + "denotesrv/pkg/metadata" + "fmt" + "regexp" + "strings" +) + +// Apply applies front matter to file content, replacing existing front matter if present. +// originalContent is the current file content, fm is the new front matter to apply. +func Apply(originalContent string, fm *metadata.FrontMatter, fileType metadata.FileType) (string, error) { + text := originalContent + newFrontMatter := string(frontmatter.Marshal(fm, fileType)) + + var newText string + switch fileType { + case metadata.FileTypeOrg: + // Find end of front matter (first blank line or non-#+ line) + lines := strings.Split(text, "\n") + endIdx := 0 + for i, line := range lines { + if i > 0 && (line == "" || !strings.HasPrefix(line, "#+")) { + endIdx = i + break + } + } + // Skip any blank lines after frontmatter since template includes one + for endIdx < len(lines) && lines[endIdx] == "" { + endIdx++ + } + if endIdx > 0 { + newText = newFrontMatter + strings.Join(lines[endIdx:], "\n") + } else { + newText = newFrontMatter + text + } + + case metadata.FileTypeMdYaml: + // Replace YAML front matter (match trailing blank lines to avoid duplication) + re := regexp.MustCompile(`(?s)^---\n.*?\n---\n\n*`) + if re.MatchString(text) { + newText = re.ReplaceAllString(text, newFrontMatter) + } else { + newText = newFrontMatter + text + } + + case metadata.FileTypeMdToml: + // Replace TOML front matter (match trailing blank lines to avoid duplication) + re := regexp.MustCompile(`(?s)^\+\+\+\n.*?\n\+\+\+\n\n*`) + if re.MatchString(text) { + newText = re.ReplaceAllString(text, newFrontMatter) + } else { + newText = newFrontMatter + text + } + + case metadata.FileTypeTxt: + // Replace text front matter (match trailing blank lines to avoid duplication) + re := regexp.MustCompile(`(?s)^title:.*?\n-+\n\n*`) + if re.MatchString(text) { + newText = re.ReplaceAllString(text, newFrontMatter) + } else { + newText = newFrontMatter + text + } + default: + return "", fmt.Errorf("unsupported file type: %s", fileType) + } + + return newText, nil +} diff --git a/pkg/util/util_test.go b/pkg/util/util_test.go new file mode 100644 index 0000000..1ef6bba --- /dev/null +++ b/pkg/util/util_test.go @@ -0,0 +1,215 @@ +package util + +import ( + "denotesrv/pkg/metadata" + "strings" + "testing" +) + +func TestApply(t *testing.T) { + tests := []struct { + name string + original string + fm *metadata.FrontMatter + fileType metadata.FileType + wantContains []string + wantPreserve string + }{ + { + name: "update org front matter", + original: `#+title: Old Title +#+date: [2024-01-01 Mon 12:00] +#+filetags: :old: +#+identifier: 20240101T120000 + +* Original Content +This should be preserved`, + fm: &metadata.FrontMatter{ + Title: "New Title", + Tags: []string{"new", "updated"}, + Identifier: "20240101T120000", + }, + fileType: metadata.FileTypeOrg, + wantContains: []string{ + "#+title: New Title", + "#+filetags: :new:updated:", + "* Original Content", + "This should be preserved", + }, + wantPreserve: "* Original Content", + }, + { + name: "update markdown yaml front matter", + original: `--- +title: Old Title +tags: [old] +identifier: 20240101T120000 +--- + +# Original Heading +Content preserved`, + fm: &metadata.FrontMatter{ + Title: "New Title", + Tags: []string{"new"}, + Identifier: "20240101T120000", + }, + fileType: metadata.FileTypeMdYaml, + wantContains: []string{ + "---", + "title: New Title", + "tags: [new]", + "# Original Heading", + "Content preserved", + }, + wantPreserve: "# Original Heading", + }, + { + name: "update markdown toml front matter", + original: `+++ +title = Old Title +tags = [old] +identifier = 20240101T120000 ++++ + +Content here`, + fm: &metadata.FrontMatter{ + Title: "New Title", + Tags: []string{"updated"}, + Identifier: "20240101T120000", + }, + fileType: metadata.FileTypeMdToml, + wantContains: []string{ + "+++", + "title = New Title", + "tags = [updated]", + "Content here", + }, + wantPreserve: "Content here", + }, + { + name: "update txt front matter", + original: `title: Old Title +tags: old +identifier: 20240101T120000 +--------------------------- + +Text content`, + fm: &metadata.FrontMatter{ + Title: "New Title", + Tags: []string{"new"}, + Identifier: "20240101T120000", + }, + fileType: metadata.FileTypeTxt, + wantContains: []string{ + "title: New Title", + "tags: new", + "---------------------------", + "Text content", + }, + wantPreserve: "Text content", + }, + { + name: "add front matter when missing (org)", + original: `* Original Heading`, + fm: &metadata.FrontMatter{ + Title: "Added Title", + Tags: []string{"added"}, + Identifier: "20240101T120000", + }, + fileType: metadata.FileTypeOrg, + wantContains: []string{ + "#+title: Added Title", + "#+filetags: :added:", + "* Original Heading", + }, + wantPreserve: "* Original Heading", + }, + { + name: "add front matter when missing (md-yaml)", + original: `# Original Heading`, + fm: &metadata.FrontMatter{ + Title: "Added Title", + Tags: []string{"added"}, + Identifier: "20240101T120000", + }, + fileType: metadata.FileTypeMdYaml, + wantContains: []string{ + "---", + "title: Added Title", + "tags: [added]", + "# Original Heading", + }, + wantPreserve: "# Original Heading", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Apply(tt.original, tt.fm, tt.fileType) + if err != nil { + t.Fatalf("Apply() error = %v", err) + } + + for _, want := range tt.wantContains { + if !strings.Contains(got, want) { + t.Errorf("Apply() missing %q\nGot:\n%s", want, got) + } + } + + // Verify original content is preserved + if !strings.Contains(got, tt.wantPreserve) { + t.Errorf("Apply() didn't preserve %q\nGot:\n%s", tt.wantPreserve, got) + } + }) + } +} + +// TestApplyEmptyTags validates updating with empty tags +func TestApplyEmptyTags(t *testing.T) { + original := `--- +title: Test +tags: [old, tags] +identifier: 20240101T120000 +--- + +Content` + + fm := &metadata.FrontMatter{ + Title: "Test", + Tags: []string{}, + Identifier: "20240101T120000", + } + + got, err := Apply(original, fm, metadata.FileTypeMdYaml) + if err != nil { + t.Fatalf("Apply() error = %v", err) + } + + // Should have empty tags field, not omit it + if !strings.Contains(got, "tags:") { + t.Errorf("Apply() should include tags field even when empty") + } + + // Content should be preserved + if !strings.Contains(got, "Content") { + t.Errorf("Apply() should preserve content") + } +} + +// TestApplyUnsupportedType validates error handling +func TestApplyUnsupportedType(t *testing.T) { + fm := &metadata.FrontMatter{ + Title: "Test", + Tags: []string{"test"}, + Identifier: "20240101T120000", + } + + _, err := Apply("content", fm, "unsupported") + if err == nil { + t.Error("Apply() should error on unsupported file type") + } + + if !strings.Contains(err.Error(), "unsupported file type") { + t.Errorf("Apply() error = %v, want 'unsupported file type'", err) + } +}