feed
This commit is contained in:
Levi Neely
parent
407bc9d285
commit
9a12075139
|
|
@ -0,0 +1,675 @@
|
|||
# GNU GENERAL PUBLIC LICENSE
|
||||
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||
<https://fsf.org/>
|
||||
|
||||
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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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 <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
# acme-feed
|
||||
|
||||
RSS/Atom feed reader for the [acme](https://en.wikipedia.org/wiki/Acme_(text_editor)) text editor. Embeds a 9P file server and mounts it at `~/mnt/feeds` via `9pfuse`.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
mk install
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
Feeds
|
||||
```
|
||||
|
||||
Middle-click `Feeds` in Acme to launch, or run from a shell. The `/+Feeds` window opens automatically.
|
||||
|
||||
## Main Window (`/+Feeds`)
|
||||
|
||||
| Tag command | Action |
|
||||
|---|---|
|
||||
| `Get` | Refresh the window from disk |
|
||||
| `Put` | Apply edits (read/unread/pin/unpin marks) |
|
||||
| `Refresh` | Re-fetch all subscribed feeds |
|
||||
| `Sub <url>` | Subscribe to a feed |
|
||||
| `Unsub <slug>` | Unsubscribe from a feed (opens picker if no arg) |
|
||||
| `Pins` | Open the pinned entries window |
|
||||
|
||||
Each line shows an entry index, timestamp, feed slug, and title. Middle-click a line number to open the entry.
|
||||
|
||||
**Bulk editing with `Put`:** prefix lines in the body and click `Put`:
|
||||
|
||||
| Prefix | Action |
|
||||
|---|---|
|
||||
| `r N` | Mark entry N read |
|
||||
| `u N` | Mark entry N unread |
|
||||
| `+ N` | Pin entry N |
|
||||
| `- N` | Unpin entry N |
|
||||
|
||||
## Entry Windows (`/+Feeds/{slug}/{entry}`)
|
||||
|
||||
Tag commands: `Read`, `Unread`, `Pin`, `Unpin`.
|
||||
|
||||
Right-clicking a URL in an entry window fetches the page as plain Markdown rather than plumbing it to a browser. A `Get` tag in the content window re-fetches.
|
||||
|
||||
## Pins Window (`/+Pins`)
|
||||
|
||||
Shows all pinned entries. Middle-click a line to open the entry. Use `Put` with `- N` prefixes to unpin entries.
|
||||
|
||||
## 9P File Server (`~/mnt/feeds`)
|
||||
|
||||
The server is also accessible as a filesystem:
|
||||
|
||||
```
|
||||
~/mnt/feeds/
|
||||
ctl — write commands: sub, unsub, refresh [slug]
|
||||
unread — index of all unread entries
|
||||
all — index of all entries
|
||||
pinned — index of pinned entries
|
||||
feeds/{slug}/
|
||||
meta — feed title and URL
|
||||
ctl — per-feed commands: refresh, unsub, mark-all-read, read <guid>
|
||||
unread/ — unread entry files
|
||||
all/ — all entry files
|
||||
```
|
||||
|
||||
## Storage
|
||||
|
||||
Data is stored in `~/.local/share/acme-feed/`:
|
||||
|
||||
```
|
||||
subscriptions.jsonl — feed list
|
||||
feeds/{slug}.jsonl — entry cache
|
||||
read/{slug} — read GUIDs
|
||||
pinned/{slug} — pinned GUIDs
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Acme editor (Plan 9 from User Space)
|
||||
- `9pfuse` (for filesystem mount; optional)
|
||||
|
||||
## License
|
||||
|
||||
GPLv3 — see [LICENSE](LICENSE).
|
||||
|
|
@ -0,0 +1,607 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"9fans.net/go/acme"
|
||||
)
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Main window
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
var mainDone = make(chan struct{})
|
||||
var mainWin *acme.Win
|
||||
var mainSnapshot []mainRow // guarded by mainSnapshotMu
|
||||
var mainSnapshotMu sync.RWMutex
|
||||
|
||||
// openMainWindow opens the /+Feeds window and starts its event loop.
|
||||
func openMainWindow(store *FeedStore) error {
|
||||
w, err := acme.New()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
mainWin = w
|
||||
w.Name("/+Feeds")
|
||||
w.Write("tag", []byte("Get Put Pins Refresh Unsub Sub "))
|
||||
refreshMainWindow(w, store)
|
||||
go handleMainWindow(w, store)
|
||||
return nil
|
||||
}
|
||||
|
||||
func handleMainWindow(w *acme.Win, store *FeedStore) {
|
||||
defer w.CloseFiles()
|
||||
defer close(mainDone)
|
||||
|
||||
// snapshot of entries for middle-click resolution
|
||||
var snapshot []mainRow
|
||||
snapshot = buildSnapshot(store)
|
||||
|
||||
for e := range w.EventChan() {
|
||||
switch e.C2 {
|
||||
case 'x', 'X':
|
||||
cmd := strings.TrimSpace(string(e.Text))
|
||||
arg := strings.TrimSpace(string(e.Arg))
|
||||
// Accept "Cmd argument" typed inline in the tag bar as an
|
||||
// alternative to chording, since chord e.Arg is unreliable
|
||||
// across acme builds and mouse configurations.
|
||||
if fields := strings.Fields(cmd); len(fields) > 1 {
|
||||
cmd = fields[0]
|
||||
if arg == "" {
|
||||
arg = strings.Join(fields[1:], " ")
|
||||
}
|
||||
}
|
||||
switch cmd {
|
||||
case "Get":
|
||||
snapshot = buildSnapshot(store)
|
||||
refreshMainWindow(w, store)
|
||||
|
||||
case "Put":
|
||||
body, _ := w.ReadAll("body")
|
||||
applyReadMarks(w, store, &snapshot, string(body))
|
||||
|
||||
case "Pins":
|
||||
openPinsWindow(store)
|
||||
|
||||
case "Refresh":
|
||||
if err := doRefreshAll(store); err != nil {
|
||||
w.Err(err.Error())
|
||||
}
|
||||
snapshot = buildSnapshot(store)
|
||||
refreshMainWindow(w, store)
|
||||
|
||||
case "Sub":
|
||||
if arg == "" {
|
||||
w.Err("Sub: chord a URL first")
|
||||
continue
|
||||
}
|
||||
if err := doSubscribe(store, arg, ""); err != nil {
|
||||
w.Err(fmt.Sprintf("Sub: %v", err))
|
||||
continue
|
||||
}
|
||||
snapshot = buildSnapshot(store)
|
||||
refreshMainWindow(w, store)
|
||||
|
||||
case "Unsub":
|
||||
if arg != "" {
|
||||
if err := store.unsubscribe(arg); err != nil {
|
||||
w.Err(err.Error())
|
||||
continue
|
||||
}
|
||||
snapshot = buildSnapshot(store)
|
||||
refreshMainWindow(w, store)
|
||||
} else {
|
||||
openUnsubWindow(store, func() {
|
||||
snapshot = buildSnapshot(store)
|
||||
refreshMainWindow(w, store)
|
||||
})
|
||||
}
|
||||
|
||||
default:
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
|
||||
case 'l', 'L':
|
||||
text := strings.TrimSpace(string(e.Text))
|
||||
// Middle-click on a line number opens the entry.
|
||||
if idx := parseLineIndex(text); idx >= 1 && idx <= len(snapshot) {
|
||||
row := snapshot[idx-1]
|
||||
openEntryWindow(store, row.slug, row.ef)
|
||||
store.markRead(row.slug, row.ef.entry.GUID)
|
||||
// Annotate the line in place rather than refreshing the
|
||||
// whole window, so the user doesn't lose their place.
|
||||
line := fmt.Sprintf("%4d %-20s %-20s %s [read]\n",
|
||||
idx,
|
||||
formatTS(row.ef.entry.Timestamp),
|
||||
row.slug,
|
||||
row.ef.entry.Title,
|
||||
)
|
||||
w.Addr("%d", idx)
|
||||
w.Write("data", []byte(line))
|
||||
w.Ctl("clean")
|
||||
} else {
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
|
||||
default:
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// annotateReadInMainWindow finds the entry by slug+guid in the current
|
||||
// mainSnapshot and annotates its line with "[read]" in place.
|
||||
func annotateReadInMainWindow(slug, guid string) {
|
||||
if mainWin == nil {
|
||||
return
|
||||
}
|
||||
mainSnapshotMu.RLock()
|
||||
snap := mainSnapshot
|
||||
mainSnapshotMu.RUnlock()
|
||||
for i, row := range snap {
|
||||
if row.slug == slug && row.ef.entry.GUID == guid {
|
||||
idx := i + 1
|
||||
line := fmt.Sprintf("%4d %-20s %-20s %s [read]\n",
|
||||
idx,
|
||||
formatTS(row.ef.entry.Timestamp),
|
||||
row.slug,
|
||||
row.ef.entry.Title,
|
||||
)
|
||||
mainWin.Addr("%d", idx)
|
||||
mainWin.Write("data", []byte(line))
|
||||
mainWin.Ctl("clean")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func refreshMainWindow(w *acme.Win, store *FeedStore) {
|
||||
rows := store.globalIndex(true) // unread only
|
||||
|
||||
var sb strings.Builder
|
||||
for i, row := range rows {
|
||||
e := row.ef.entry
|
||||
fmt.Fprintf(&sb, "%4d %-20s %-20s %s\n",
|
||||
i+1,
|
||||
formatTS(e.Timestamp),
|
||||
row.slug,
|
||||
e.Title,
|
||||
)
|
||||
}
|
||||
if len(rows) == 0 {
|
||||
sb.WriteString("(no unread entries)\n")
|
||||
}
|
||||
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(sb.String()))
|
||||
w.Ctl("clean")
|
||||
w.Addr("0")
|
||||
w.Ctl("dot=addr")
|
||||
w.Ctl("show")
|
||||
}
|
||||
|
||||
// mainRow maps display index → entry.
|
||||
type mainRow struct {
|
||||
slug string
|
||||
ef entryFile
|
||||
}
|
||||
|
||||
func buildSnapshot(store *FeedStore) []mainRow {
|
||||
rows := store.globalIndex(true)
|
||||
snap := make([]mainRow, len(rows))
|
||||
for i, r := range rows {
|
||||
snap[i] = mainRow{slug: r.slug, ef: r.ef}
|
||||
}
|
||||
mainSnapshotMu.Lock()
|
||||
mainSnapshot = snap
|
||||
mainSnapshotMu.Unlock()
|
||||
return snap
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Pins window
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func openPinsWindow(store *FeedStore) {
|
||||
w, err := acme.New()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
w.Name("/+Pins")
|
||||
w.Write("tag", []byte("Get Put "))
|
||||
var snapshot []mainRow
|
||||
snapshot = buildPinsSnapshot(store)
|
||||
refreshPinsWindow(w, store, snapshot)
|
||||
|
||||
go func() {
|
||||
defer w.CloseFiles()
|
||||
for e := range w.EventChan() {
|
||||
switch e.C2 {
|
||||
case 'x', 'X':
|
||||
cmd := strings.TrimSpace(string(e.Text))
|
||||
switch cmd {
|
||||
case "Get":
|
||||
snapshot = buildPinsSnapshot(store)
|
||||
refreshPinsWindow(w, store, snapshot)
|
||||
case "Put":
|
||||
body, _ := w.ReadAll("body")
|
||||
applyPinsEdits(store, &snapshot, string(body))
|
||||
refreshPinsWindow(w, store, snapshot)
|
||||
default:
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
case 'l', 'L':
|
||||
text := strings.TrimSpace(string(e.Text))
|
||||
if idx := parseLineIndex(text); idx >= 1 && idx <= len(snapshot) {
|
||||
row := snapshot[idx-1]
|
||||
openEntryWindow(store, row.slug, row.ef)
|
||||
} else {
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
default:
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
func buildPinsSnapshot(store *FeedStore) []mainRow {
|
||||
rows := store.globalPinned()
|
||||
snap := make([]mainRow, len(rows))
|
||||
for i, r := range rows {
|
||||
snap[i] = mainRow{slug: r.slug, ef: r.ef}
|
||||
}
|
||||
return snap
|
||||
}
|
||||
|
||||
func refreshPinsWindow(w *acme.Win, store *FeedStore, snapshot []mainRow) {
|
||||
var sb strings.Builder
|
||||
for i, row := range snapshot {
|
||||
e := row.ef.entry
|
||||
fmt.Fprintf(&sb, "%4d %-20s %-20s %s\n",
|
||||
i+1,
|
||||
formatTS(e.Timestamp),
|
||||
row.slug,
|
||||
e.Title,
|
||||
)
|
||||
}
|
||||
if len(snapshot) == 0 {
|
||||
sb.WriteString("(no pinned entries)\n")
|
||||
}
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(sb.String()))
|
||||
w.Ctl("clean")
|
||||
w.Addr("0")
|
||||
w.Ctl("dot=addr")
|
||||
w.Ctl("show")
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Unsub window
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func openUnsubWindow(store *FeedStore, onChanged func()) {
|
||||
w, err := acme.New()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
w.Name("/+Unsub")
|
||||
w.Write("tag", []byte("Get "))
|
||||
refreshUnsubWindow(w, store)
|
||||
|
||||
go func() {
|
||||
defer w.CloseFiles()
|
||||
var lines []string
|
||||
lines = buildUnsubLines(store)
|
||||
|
||||
for e := range w.EventChan() {
|
||||
switch e.C2 {
|
||||
case 'x', 'X':
|
||||
if strings.TrimSpace(string(e.Text)) == "Get" {
|
||||
lines = buildUnsubLines(store)
|
||||
refreshUnsubWindow(w, store)
|
||||
} else {
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
|
||||
case 'l', 'L':
|
||||
text := strings.TrimSpace(string(e.Text))
|
||||
fields := strings.Fields(text)
|
||||
if len(fields) == 0 {
|
||||
w.WriteEvent(e)
|
||||
continue
|
||||
}
|
||||
// Middle-click: text is the slug (first field of the line).
|
||||
slug := fields[0]
|
||||
// Verify it's a known slug.
|
||||
found := false
|
||||
for _, l := range lines {
|
||||
if strings.Fields(l)[0] == slug {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
w.WriteEvent(e)
|
||||
continue
|
||||
}
|
||||
if err := store.unsubscribe(slug); err != nil {
|
||||
w.Err(err.Error())
|
||||
continue
|
||||
}
|
||||
lines = buildUnsubLines(store)
|
||||
refreshUnsubWindow(w, store)
|
||||
if onChanged != nil {
|
||||
onChanged()
|
||||
}
|
||||
|
||||
default:
|
||||
w.WriteEvent(e)
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
func buildUnsubLines(store *FeedStore) []string {
|
||||
store.mu.RLock()
|
||||
defer store.mu.RUnlock()
|
||||
lines := make([]string, len(store.subs))
|
||||
for i, sub := range store.subs {
|
||||
lines[i] = fmt.Sprintf("%-30s %s", sub.Slug, sub.URL)
|
||||
}
|
||||
return lines
|
||||
}
|
||||
|
||||
func refreshUnsubWindow(w *acme.Win, store *FeedStore) {
|
||||
lines := buildUnsubLines(store)
|
||||
var sb strings.Builder
|
||||
if len(lines) == 0 {
|
||||
sb.WriteString("(no subscriptions)\n")
|
||||
} else {
|
||||
for _, l := range lines {
|
||||
sb.WriteString(l + "\n")
|
||||
}
|
||||
}
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(sb.String()))
|
||||
w.Ctl("clean")
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Entry window
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// populateEntryWindow writes entry content into an existing window.
|
||||
func populateEntryWindow(w *acme.Win, store *FeedStore, slug string, ef entryFile) {
|
||||
e := ef.entry
|
||||
w.Name("/+Feeds/%s/%s", slug, ef.filename)
|
||||
|
||||
store.mu.RLock()
|
||||
sub := store.subscriptionBySlug(slug)
|
||||
store.mu.RUnlock()
|
||||
feedTitle := slug
|
||||
if sub != nil {
|
||||
feedTitle = sub.Title
|
||||
}
|
||||
|
||||
var sb strings.Builder
|
||||
fmt.Fprintf(&sb, "%s\n", e.Title)
|
||||
fmt.Fprintf(&sb, "%s\n", e.URL)
|
||||
fmt.Fprintf(&sb, "%s | %s\n", feedTitle, e.Timestamp)
|
||||
if e.Summary != "" {
|
||||
fmt.Fprintf(&sb, "\n%s\n", e.Summary)
|
||||
}
|
||||
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(sb.String()))
|
||||
w.Ctl("clean")
|
||||
w.Addr("0")
|
||||
w.Ctl("dot=addr")
|
||||
w.Ctl("show")
|
||||
}
|
||||
|
||||
func openEntryWindow(store *FeedStore, slug string, ef entryFile) {
|
||||
w, err := acme.New()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
w.Write("tag", []byte("Read Unread Pin Unpin Prev Next "))
|
||||
populateEntryWindow(w, store, slug, ef)
|
||||
|
||||
curSlug := slug
|
||||
curEF := ef
|
||||
|
||||
go func() {
|
||||
defer w.CloseFiles()
|
||||
for ev := range w.EventChan() {
|
||||
switch ev.C2 {
|
||||
case 'x', 'X':
|
||||
switch strings.TrimSpace(string(ev.Text)) {
|
||||
case "Read":
|
||||
store.markRead(curSlug, curEF.entry.GUID)
|
||||
case "Unread":
|
||||
store.unmarkRead(curSlug, curEF.entry.GUID)
|
||||
case "Pin":
|
||||
store.pin(curSlug, curEF.entry.GUID)
|
||||
case "Unpin":
|
||||
store.unpin(curSlug, curEF.entry.GUID)
|
||||
case "Prev", "Next":
|
||||
files := store.feedFiles(curSlug)
|
||||
idx := -1
|
||||
for i, f := range files {
|
||||
if f.filename == curEF.filename {
|
||||
idx = i
|
||||
break
|
||||
}
|
||||
}
|
||||
cmd := strings.TrimSpace(string(ev.Text))
|
||||
var target *entryFile
|
||||
if cmd == "Prev" && idx >= 0 && idx+1 < len(files) {
|
||||
ef2 := files[idx+1]
|
||||
target = &ef2
|
||||
} else if cmd == "Next" && idx > 0 {
|
||||
ef2 := files[idx-1]
|
||||
target = &ef2
|
||||
}
|
||||
if target != nil {
|
||||
curEF = *target
|
||||
store.markRead(curSlug, curEF.entry.GUID)
|
||||
annotateReadInMainWindow(curSlug, curEF.entry.GUID)
|
||||
populateEntryWindow(w, store, curSlug, curEF)
|
||||
}
|
||||
default:
|
||||
w.WriteEvent(ev)
|
||||
}
|
||||
case 'l', 'L':
|
||||
// Intercept right-click on URLs: fetch as Markdown instead
|
||||
// of plumbing to the browser.
|
||||
text := strings.TrimSpace(string(ev.Text))
|
||||
if strings.HasPrefix(text, "http://") || strings.HasPrefix(text, "https://") {
|
||||
go openContentWindow(store, text, curSlug, curEF.filename)
|
||||
continue // consumed — do not plumb
|
||||
}
|
||||
w.WriteEvent(ev)
|
||||
default:
|
||||
w.WriteEvent(ev)
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Content window
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func openContentWindow(store *FeedStore, url, slug, entryFilename string) {
|
||||
w, err := acme.New()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
w.Name("/+Feeds/%s/%s/content", slug, entryFilename)
|
||||
w.Write("tag", []byte("Get "))
|
||||
|
||||
writeContent := func(md string) {
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(md))
|
||||
w.Ctl("clean")
|
||||
w.Addr("0")
|
||||
w.Ctl("dot=addr")
|
||||
w.Ctl("show")
|
||||
}
|
||||
|
||||
// Serve from cache if available; otherwise fetch and cache.
|
||||
if md, ok := store.loadCachedContent(slug, entryFilename); ok {
|
||||
writeContent(md)
|
||||
} else {
|
||||
w.Write("body", []byte("fetching…\n"))
|
||||
w.Ctl("clean")
|
||||
md, err := fetchMarkdown(url)
|
||||
if err != nil {
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(fmt.Sprintf("error: %v\n", err)))
|
||||
w.Ctl("clean")
|
||||
} else {
|
||||
store.saveCachedContent(slug, entryFilename, md)
|
||||
writeContent(md)
|
||||
}
|
||||
}
|
||||
|
||||
go func() {
|
||||
defer w.CloseFiles()
|
||||
for ev := range w.EventChan() {
|
||||
switch {
|
||||
case (ev.C2 == 'x' || ev.C2 == 'X') && strings.TrimSpace(string(ev.Text)) == "Get":
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte("fetching…\n"))
|
||||
w.Ctl("clean")
|
||||
md, err := fetchMarkdown(url)
|
||||
if err != nil {
|
||||
w.Addr(",")
|
||||
w.Write("data", []byte(fmt.Sprintf("error: %v\n", err)))
|
||||
w.Ctl("clean")
|
||||
} else {
|
||||
store.saveCachedContent(slug, entryFilename, md)
|
||||
writeContent(md)
|
||||
}
|
||||
default:
|
||||
w.WriteEvent(ev)
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// applyPinsEdits processes the Pins window body after Put.
|
||||
// Lines prefixed with "- N" unpin entry N.
|
||||
func applyPinsEdits(store *FeedStore, snapshot *[]mainRow, body string) {
|
||||
for _, line := range strings.Split(body, "\n") {
|
||||
trimmed := strings.TrimSpace(line)
|
||||
if !strings.HasPrefix(trimmed, "- ") {
|
||||
continue
|
||||
}
|
||||
fields := strings.Fields(trimmed[2:])
|
||||
if len(fields) == 0 {
|
||||
continue
|
||||
}
|
||||
idx := parseLineIndex(fields[0])
|
||||
if idx < 1 || idx > len(*snapshot) {
|
||||
continue
|
||||
}
|
||||
row := (*snapshot)[idx-1]
|
||||
store.unpin(row.slug, row.ef.entry.GUID)
|
||||
}
|
||||
*snapshot = buildPinsSnapshot(store)
|
||||
}
|
||||
|
||||
func parseLineIndex(s string) int {
|
||||
s = strings.TrimSpace(s)
|
||||
var n int
|
||||
fmt.Sscanf(s, "%d", &n)
|
||||
return n
|
||||
}
|
||||
|
||||
// applyEdits processes the window body after Put.
|
||||
// Recognised line prefixes:
|
||||
//
|
||||
// r N — mark entry N read
|
||||
// u N — mark entry N unread
|
||||
// + N — pin entry N
|
||||
// - N — unpin entry N
|
||||
func applyReadMarks(w *acme.Win, store *FeedStore, snapshot *[]mainRow, body string) {
|
||||
for _, line := range strings.Split(body, "\n") {
|
||||
trimmed := strings.TrimSpace(line)
|
||||
if len(trimmed) < 2 || trimmed[1] != ' ' {
|
||||
continue
|
||||
}
|
||||
verb := trimmed[0]
|
||||
if verb != 'r' && verb != 'u' && verb != '+' && verb != '-' {
|
||||
continue
|
||||
}
|
||||
fields := strings.Fields(trimmed[2:])
|
||||
if len(fields) == 0 {
|
||||
continue
|
||||
}
|
||||
idx := parseLineIndex(fields[0])
|
||||
if idx < 1 || idx > len(*snapshot) {
|
||||
continue
|
||||
}
|
||||
row := (*snapshot)[idx-1]
|
||||
switch verb {
|
||||
case 'r':
|
||||
store.markRead(row.slug, row.ef.entry.GUID)
|
||||
case 'u':
|
||||
store.unmarkRead(row.slug, row.ef.entry.GUID)
|
||||
case '+':
|
||||
store.pin(row.slug, row.ef.entry.GUID)
|
||||
case '-':
|
||||
store.unpin(row.slug, row.ef.entry.GUID)
|
||||
}
|
||||
}
|
||||
*snapshot = buildSnapshot(store)
|
||||
refreshMainWindow(w, store)
|
||||
}
|
||||
|
|
@ -0,0 +1,299 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"golang.org/x/net/html"
|
||||
"golang.org/x/net/html/atom"
|
||||
)
|
||||
|
||||
var httpClient = &http.Client{Timeout: 30 * time.Second}
|
||||
|
||||
// fetchMarkdown fetches a URL and returns its main content as Markdown.
|
||||
// On failure it tries the Wayback Machine as a fallback.
|
||||
func fetchMarkdown(rawURL string) (string, error) {
|
||||
md, err := fetchMarkdownDirect(rawURL)
|
||||
if err == nil {
|
||||
return md, nil
|
||||
}
|
||||
// Fallback: Wayback Machine.
|
||||
md, waybackErr := fetchMarkdownWayback(rawURL)
|
||||
if waybackErr == nil {
|
||||
return md + "\n\n---\n*Retrieved from the Wayback Machine.*\n", nil
|
||||
}
|
||||
return "", fmt.Errorf("%v (wayback: %v)", err, waybackErr)
|
||||
}
|
||||
|
||||
// fetchMarkdownDirect performs a plain HTTP GET and converts HTML to Markdown.
|
||||
func fetchMarkdownDirect(rawURL string) (string, error) {
|
||||
req, err := http.NewRequest("GET", rawURL, nil)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
req.Header.Set("User-Agent", "Mozilla/5.0 (X11; Linux x86_64; rv:128.0) Gecko/20100101 Firefox/128.0")
|
||||
req.Header.Set("Accept", "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8")
|
||||
req.Header.Set("Accept-Language", "en-US,en;q=0.5")
|
||||
resp, err := httpClient.Do(req)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("HTTP %d", resp.StatusCode)
|
||||
}
|
||||
return parseHTMLToMarkdown(resp.Body)
|
||||
}
|
||||
|
||||
// fetchMarkdownWayback looks up the most recent Wayback Machine snapshot
|
||||
// for rawURL and fetches its content as Markdown.
|
||||
func fetchMarkdownWayback(rawURL string) (string, error) {
|
||||
apiURL := "https://archive.org/wayback/available?url=" + url.QueryEscape(rawURL)
|
||||
resp, err := httpClient.Get(apiURL)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("wayback API: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
var result struct {
|
||||
ArchivedSnapshots struct {
|
||||
Closest struct {
|
||||
Available bool `json:"available"`
|
||||
URL string `json:"url"`
|
||||
Status string `json:"status"`
|
||||
} `json:"closest"`
|
||||
} `json:"archived_snapshots"`
|
||||
}
|
||||
if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
|
||||
return "", fmt.Errorf("wayback parse: %w", err)
|
||||
}
|
||||
snap := result.ArchivedSnapshots.Closest
|
||||
if !snap.Available || snap.URL == "" {
|
||||
return "", fmt.Errorf("no snapshot available")
|
||||
}
|
||||
if snap.Status != "200" {
|
||||
return "", fmt.Errorf("snapshot status %s", snap.Status)
|
||||
}
|
||||
wresp, err := httpClient.Get(snap.URL)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("wayback fetch: %w", err)
|
||||
}
|
||||
defer wresp.Body.Close()
|
||||
if wresp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("wayback HTTP %d", wresp.StatusCode)
|
||||
}
|
||||
return parseHTMLToMarkdown(wresp.Body)
|
||||
}
|
||||
|
||||
// parseHTMLToMarkdown reads HTML from r and returns Markdown.
|
||||
func parseHTMLToMarkdown(r io.Reader) (string, error) {
|
||||
body, err := io.ReadAll(io.LimitReader(r, 4<<20)) // 4 MiB
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
doc, err := html.Parse(bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("HTML parse: %w", err)
|
||||
}
|
||||
// Prefer <article> or <main>; fall back to <body>.
|
||||
root := findNode(doc, atom.Article)
|
||||
if root == nil {
|
||||
root = findNode(doc, atom.Main)
|
||||
}
|
||||
if root == nil {
|
||||
root = findNode(doc, atom.Body)
|
||||
}
|
||||
if root == nil {
|
||||
root = doc
|
||||
}
|
||||
var sb strings.Builder
|
||||
renderMarkdown(&sb, root, 0)
|
||||
return cleanupMarkdown(sb.String()), nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// HTML → Markdown walker
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func renderMarkdown(sb *strings.Builder, n *html.Node, depth int) {
|
||||
switch n.Type {
|
||||
case html.TextNode:
|
||||
sb.WriteString(n.Data)
|
||||
return
|
||||
case html.ElementNode:
|
||||
// skip invisible/structural elements
|
||||
switch n.DataAtom {
|
||||
case atom.Script, atom.Style, atom.Nav, atom.Header,
|
||||
atom.Footer, atom.Form, atom.Button, atom.Input,
|
||||
atom.Iframe, atom.Noscript, atom.Aside:
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if n.Type != html.ElementNode {
|
||||
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||
renderMarkdown(sb, c, depth)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
switch n.DataAtom {
|
||||
case atom.H1, atom.H2, atom.H3, atom.H4, atom.H5, atom.H6:
|
||||
var level int
|
||||
switch n.DataAtom {
|
||||
case atom.H1:
|
||||
level = 1
|
||||
case atom.H2:
|
||||
level = 2
|
||||
case atom.H3:
|
||||
level = 3
|
||||
case atom.H4:
|
||||
level = 4
|
||||
case atom.H5:
|
||||
level = 5
|
||||
default:
|
||||
level = 6
|
||||
}
|
||||
sb.WriteString("\n" + strings.Repeat("#", level) + " ")
|
||||
renderChildren(sb, n, depth)
|
||||
sb.WriteString("\n\n")
|
||||
|
||||
case atom.P:
|
||||
sb.WriteString("\n")
|
||||
renderChildren(sb, n, depth)
|
||||
sb.WriteString("\n\n")
|
||||
|
||||
case atom.Br:
|
||||
sb.WriteString("\n")
|
||||
|
||||
case atom.Hr:
|
||||
sb.WriteString("\n---\n\n")
|
||||
|
||||
case atom.A:
|
||||
href := attr(n, "href")
|
||||
var inner strings.Builder
|
||||
renderChildren(&inner, n, depth)
|
||||
text := strings.TrimSpace(inner.String())
|
||||
if text == "" {
|
||||
return // icon-only link — skip (social share buttons, etc.)
|
||||
}
|
||||
if href == "" || href == text {
|
||||
sb.WriteString(text)
|
||||
} else {
|
||||
fmt.Fprintf(sb, "[%s](%s)", text, href)
|
||||
}
|
||||
|
||||
case atom.Strong, atom.B:
|
||||
sb.WriteString("**")
|
||||
renderChildren(sb, n, depth)
|
||||
sb.WriteString("**")
|
||||
|
||||
case atom.Em, atom.I:
|
||||
sb.WriteString("*")
|
||||
renderChildren(sb, n, depth)
|
||||
sb.WriteString("*")
|
||||
|
||||
case atom.Code:
|
||||
// Check if parent is <pre> — handled there.
|
||||
if n.Parent != nil && n.Parent.DataAtom == atom.Pre {
|
||||
renderChildren(sb, n, depth)
|
||||
return
|
||||
}
|
||||
sb.WriteString("`")
|
||||
renderChildren(sb, n, depth)
|
||||
sb.WriteString("`")
|
||||
|
||||
case atom.Pre:
|
||||
sb.WriteString("\n```\n")
|
||||
renderChildren(sb, n, depth)
|
||||
sb.WriteString("\n```\n\n")
|
||||
|
||||
case atom.Blockquote:
|
||||
var inner strings.Builder
|
||||
renderChildren(&inner, n, depth+1)
|
||||
for _, line := range strings.Split(strings.TrimRight(inner.String(), "\n"), "\n") {
|
||||
fmt.Fprintf(sb, "> %s\n", line)
|
||||
}
|
||||
sb.WriteString("\n")
|
||||
|
||||
case atom.Ul:
|
||||
sb.WriteString("\n")
|
||||
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||
if c.DataAtom == atom.Li {
|
||||
var inner strings.Builder
|
||||
renderChildren(&inner, c, depth)
|
||||
text := strings.TrimSpace(inner.String())
|
||||
fmt.Fprintf(sb, "%s- %s\n", strings.Repeat(" ", depth), text)
|
||||
}
|
||||
}
|
||||
sb.WriteString("\n")
|
||||
|
||||
case atom.Ol:
|
||||
sb.WriteString("\n")
|
||||
i := 1
|
||||
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||
if c.DataAtom == atom.Li {
|
||||
var inner strings.Builder
|
||||
renderChildren(&inner, c, depth)
|
||||
text := strings.TrimSpace(inner.String())
|
||||
fmt.Fprintf(sb, "%s%d. %s\n", strings.Repeat(" ", depth), i, text)
|
||||
i++
|
||||
}
|
||||
}
|
||||
sb.WriteString("\n")
|
||||
|
||||
case atom.Img:
|
||||
alt := attr(n, "alt")
|
||||
src := attr(n, "src")
|
||||
if alt != "" || src != "" {
|
||||
fmt.Fprintf(sb, "", alt, src)
|
||||
}
|
||||
|
||||
default:
|
||||
renderChildren(sb, n, depth)
|
||||
}
|
||||
}
|
||||
|
||||
func renderChildren(sb *strings.Builder, n *html.Node, depth int) {
|
||||
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||
renderMarkdown(sb, c, depth)
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func findNode(n *html.Node, a atom.Atom) *html.Node {
|
||||
if n.Type == html.ElementNode && n.DataAtom == a {
|
||||
return n
|
||||
}
|
||||
for c := n.FirstChild; c != nil; c = c.NextSibling {
|
||||
if found := findNode(c, a); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func attr(n *html.Node, key string) string {
|
||||
for _, a := range n.Attr {
|
||||
if a.Key == key {
|
||||
return a.Val
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
var multiNewline = regexp.MustCompile(`\n{3,}`)
|
||||
|
||||
func cleanupMarkdown(s string) string {
|
||||
s = multiNewline.ReplaceAllString(s, "\n\n")
|
||||
return strings.TrimSpace(s) + "\n"
|
||||
}
|
||||
|
|
@ -0,0 +1,354 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// nsDecl strips xmlns and xmlns:prefix declarations (both quote styles).
|
||||
// Go's encoding/xml only matches unqualified tags against elements with no
|
||||
// namespace; Atom feeds put every element in the Atom namespace, so without
|
||||
// stripping the declaration none of our struct field tags would match.
|
||||
var nsDecl = regexp.MustCompile(`\s+xmlns(?::\w+)?=(?:"[^"]*"|'[^']*')`)
|
||||
|
||||
// nsPrefix strips namespace prefixes from element start/end tags
|
||||
// (e.g. <dc:creator> → <creator>, </rdf:RDF> → </RDF>).
|
||||
// After stripping xmlns declarations the prefixes become undeclared; Go's
|
||||
// xml decoder may reject them even in non-strict mode.
|
||||
var nsPrefix = regexp.MustCompile(`(</?)[A-Za-z][\w-]*:`)
|
||||
|
||||
func normalizeXML(data []byte) []byte {
|
||||
data = nsDecl.ReplaceAll(data, nil)
|
||||
data = nsPrefix.ReplaceAll(data, []byte("$1"))
|
||||
return data
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// RSS / Atom XML structures
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type rssFeed struct {
|
||||
XMLName xml.Name `xml:"rss"`
|
||||
Channel rssChannel `xml:"channel"`
|
||||
}
|
||||
|
||||
type rssChannel struct {
|
||||
Title string `xml:"title"`
|
||||
Items []rssItem `xml:"item"`
|
||||
}
|
||||
|
||||
type rssItem struct {
|
||||
Title string `xml:"title"`
|
||||
Link string `xml:"link"`
|
||||
GUID string `xml:"guid"`
|
||||
PubDate string `xml:"pubDate"`
|
||||
Description string `xml:"description"`
|
||||
}
|
||||
|
||||
type atomFeed struct {
|
||||
XMLName xml.Name `xml:"feed"`
|
||||
Title atomText `xml:"title"`
|
||||
Entries []atomEntry `xml:"entry"`
|
||||
}
|
||||
|
||||
type atomText struct {
|
||||
Value string `xml:",chardata"`
|
||||
}
|
||||
|
||||
type atomEntry struct {
|
||||
ID string `xml:"id"`
|
||||
Title atomText `xml:"title"`
|
||||
Updated string `xml:"updated"`
|
||||
Links []struct {
|
||||
Href string `xml:"href,attr"`
|
||||
Rel string `xml:"rel,attr"`
|
||||
} `xml:"link"`
|
||||
Summary atomText `xml:"summary"`
|
||||
Content atomText `xml:"content"`
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Fetch result
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type FetchResult struct {
|
||||
FeedTitle string
|
||||
Entries []*Entry
|
||||
ETag string
|
||||
LastModified string
|
||||
NotModified bool
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Fetch and parse
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func fetchFeed(url, etag, lastModified string) (*FetchResult, error) {
|
||||
req, err := http.NewRequest("GET", url, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if etag != "" {
|
||||
req.Header.Set("If-None-Match", etag)
|
||||
}
|
||||
if lastModified != "" {
|
||||
req.Header.Set("If-Modified-Since", lastModified)
|
||||
}
|
||||
req.Header.Set("User-Agent", "Feeds/1.0 (acme feed reader)")
|
||||
|
||||
client := &http.Client{Timeout: 30 * time.Second}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if resp.StatusCode == http.StatusNotModified {
|
||||
return &FetchResult{NotModified: true}, nil
|
||||
}
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("HTTP %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
body, err := io.ReadAll(io.LimitReader(resp.Body, 8<<20)) // 8 MiB limit
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
result, err := parseFeed(body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result.ETag = resp.Header.Get("ETag")
|
||||
result.LastModified = resp.Header.Get("Last-Modified")
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func parseFeed(data []byte) (*FetchResult, error) {
|
||||
// Normalise: strip xmlns declarations and namespace prefixes from element
|
||||
// names so encoding/xml plain-name tags match regardless of feed format.
|
||||
clean := normalizeXML(data)
|
||||
|
||||
// Peek at root element local name to decide RSS vs Atom.
|
||||
dec := xml.NewDecoder(bytes.NewReader(clean))
|
||||
dec.Strict = false
|
||||
dec.Entity = xml.HTMLEntity
|
||||
|
||||
for {
|
||||
tok, err := dec.Token()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("XML parse: %w", err)
|
||||
}
|
||||
se, ok := tok.(xml.StartElement)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch se.Name.Local {
|
||||
case "rss":
|
||||
return parseRSS(clean)
|
||||
case "feed":
|
||||
return parseAtom(clean)
|
||||
case "RDF":
|
||||
return parseRDF1(clean)
|
||||
default:
|
||||
return nil, fmt.Errorf("unrecognized feed root element: %s", se.Name.Local)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func parseRSS(data []byte) (*FetchResult, error) {
|
||||
var feed rssFeed
|
||||
dec := xml.NewDecoder(bytes.NewReader(data))
|
||||
dec.Strict = false
|
||||
dec.Entity = xml.HTMLEntity
|
||||
if err := dec.Decode(&feed); err != nil {
|
||||
return nil, fmt.Errorf("RSS decode: %w", err)
|
||||
}
|
||||
|
||||
fetchedAt := time.Now().UTC().Format(time.RFC3339)
|
||||
result := &FetchResult{FeedTitle: strings.TrimSpace(feed.Channel.Title)}
|
||||
|
||||
for _, item := range feed.Channel.Items {
|
||||
ts := parseRSSDate(item.PubDate)
|
||||
if ts == "" {
|
||||
ts = fetchedAt
|
||||
}
|
||||
guid := strings.TrimSpace(item.GUID)
|
||||
if guid == "" {
|
||||
guid = synthGUID(item.Link, item.Title)
|
||||
}
|
||||
summary := strings.TrimSpace(item.Description)
|
||||
if len(summary) > 4096 {
|
||||
summary = truncateUTF8(summary, 4096)
|
||||
}
|
||||
result.Entries = append(result.Entries, &Entry{
|
||||
GUID: guid,
|
||||
Timestamp: ts,
|
||||
Title: strings.TrimSpace(item.Title),
|
||||
URL: strings.TrimSpace(item.Link),
|
||||
Summary: summary,
|
||||
FetchedAt: fetchedAt,
|
||||
})
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// RSS 1.0 / RDF Site Summary structures.
|
||||
// After namespace stripping, the root is <RDF>, <channel> holds the feed
|
||||
// title, and <item> elements are direct children of <RDF> (not of <channel>).
|
||||
// dc:date is stripped to <date>; dc:description may appear too but we use
|
||||
// <description> which is in the core RSS 1.0 namespace.
|
||||
type rdf1Feed struct {
|
||||
XMLName xml.Name `xml:"RDF"`
|
||||
Channel rdf1Channel `xml:"channel"`
|
||||
Items []rdf1Item `xml:"item"`
|
||||
}
|
||||
|
||||
type rdf1Channel struct {
|
||||
Title string `xml:"title"`
|
||||
}
|
||||
|
||||
type rdf1Item struct {
|
||||
Title string `xml:"title"`
|
||||
Link string `xml:"link"`
|
||||
Description string `xml:"description"`
|
||||
Date string `xml:"date"` // dc:date → <date>
|
||||
Identifier string `xml:"identifier"` // dc:identifier → <identifier>
|
||||
}
|
||||
|
||||
func parseRDF1(data []byte) (*FetchResult, error) {
|
||||
var feed rdf1Feed
|
||||
dec := xml.NewDecoder(bytes.NewReader(data))
|
||||
dec.Strict = false
|
||||
dec.Entity = xml.HTMLEntity
|
||||
if err := dec.Decode(&feed); err != nil {
|
||||
return nil, fmt.Errorf("RSS 1.0 decode: %w", err)
|
||||
}
|
||||
|
||||
fetchedAt := time.Now().UTC().Format(time.RFC3339)
|
||||
result := &FetchResult{FeedTitle: strings.TrimSpace(feed.Channel.Title)}
|
||||
|
||||
for _, item := range feed.Items {
|
||||
ts := parseRSSDate(item.Date)
|
||||
if ts == "" {
|
||||
ts = fetchedAt
|
||||
}
|
||||
guid := strings.TrimSpace(item.Identifier)
|
||||
if guid == "" {
|
||||
guid = synthGUID(item.Link, item.Title)
|
||||
}
|
||||
summary := strings.TrimSpace(item.Description)
|
||||
if len(summary) > 4096 {
|
||||
summary = truncateUTF8(summary, 4096)
|
||||
}
|
||||
result.Entries = append(result.Entries, &Entry{
|
||||
GUID: guid,
|
||||
Timestamp: ts,
|
||||
Title: strings.TrimSpace(item.Title),
|
||||
URL: strings.TrimSpace(item.Link),
|
||||
Summary: summary,
|
||||
FetchedAt: fetchedAt,
|
||||
})
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func parseAtom(data []byte) (*FetchResult, error) {
|
||||
var feed atomFeed
|
||||
dec := xml.NewDecoder(bytes.NewReader(data))
|
||||
dec.Strict = false
|
||||
dec.Entity = xml.HTMLEntity
|
||||
if err := dec.Decode(&feed); err != nil {
|
||||
return nil, fmt.Errorf("Atom decode: %w", err)
|
||||
}
|
||||
|
||||
fetchedAt := time.Now().UTC().Format(time.RFC3339)
|
||||
result := &FetchResult{FeedTitle: strings.TrimSpace(feed.Title.Value)}
|
||||
|
||||
for _, e := range feed.Entries {
|
||||
ts := strings.TrimSpace(e.Updated)
|
||||
if ts == "" {
|
||||
ts = fetchedAt
|
||||
} else {
|
||||
ts = normalizeTimestamp(ts, fetchedAt)
|
||||
}
|
||||
link := ""
|
||||
for _, l := range e.Links {
|
||||
if l.Rel == "alternate" || l.Rel == "" {
|
||||
link = l.Href
|
||||
break
|
||||
}
|
||||
}
|
||||
guid := strings.TrimSpace(e.ID)
|
||||
if guid == "" {
|
||||
guid = synthGUID(link, e.Title.Value)
|
||||
}
|
||||
summary := strings.TrimSpace(e.Summary.Value)
|
||||
if summary == "" {
|
||||
summary = strings.TrimSpace(e.Content.Value)
|
||||
}
|
||||
if len(summary) > 4096 {
|
||||
summary = truncateUTF8(summary, 4096)
|
||||
}
|
||||
result.Entries = append(result.Entries, &Entry{
|
||||
GUID: guid,
|
||||
Timestamp: ts,
|
||||
Title: strings.TrimSpace(e.Title.Value),
|
||||
URL: link,
|
||||
Summary: summary,
|
||||
FetchedAt: fetchedAt,
|
||||
})
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Date helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
var rssDateFormats = []string{
|
||||
time.RFC1123Z,
|
||||
time.RFC1123,
|
||||
"Mon, 2 Jan 2006 15:04:05 -0700",
|
||||
"Mon, 2 Jan 2006 15:04:05 MST",
|
||||
"2006-01-02T15:04:05Z07:00",
|
||||
"2006-01-02T15:04:05Z",
|
||||
"2006-01-02",
|
||||
}
|
||||
|
||||
func parseRSSDate(s string) string {
|
||||
s = strings.TrimSpace(s)
|
||||
if s == "" {
|
||||
return ""
|
||||
}
|
||||
now := time.Now().UTC()
|
||||
for _, f := range rssDateFormats {
|
||||
if t, err := time.Parse(f, s); err == nil {
|
||||
if t.After(now) {
|
||||
t = now
|
||||
}
|
||||
return t.UTC().Format(time.RFC3339)
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func normalizeTimestamp(s, fallback string) string {
|
||||
s = strings.TrimSpace(s)
|
||||
now := time.Now().UTC()
|
||||
for _, f := range rssDateFormats {
|
||||
if t, err := time.Parse(f, s); err == nil {
|
||||
if t.After(now) {
|
||||
t = now
|
||||
}
|
||||
return t.UTC().Format(time.RFC3339)
|
||||
}
|
||||
}
|
||||
return fallback
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
module feeds
|
||||
|
||||
go 1.25.7
|
||||
|
||||
require 9fans.net/go v0.0.7
|
||||
|
||||
require golang.org/x/net v0.52.0 // indirect
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
9fans.net/go v0.0.7 h1:H5CsYJTf99C8EYAQr+uSoEJnLP/iZU8RmDuhyk30iSM=
|
||||
9fans.net/go v0.0.7/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/net v0.52.0 h1:He/TN1l0e4mmR3QqHMT2Xab3Aj3L9qjbhRm78/6jrW0=
|
||||
golang.org/x/net v0.52.0/go.mod h1:R1MAz7uMZxVMualyPXb+VaqGSa3LIaUqk0eEt3w36Sw=
|
||||
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=
|
||||
|
|
@ -0,0 +1,186 @@
|
|||
// Feeds — RSS/Atom feed reader for the acme text editor.
|
||||
// Embeds a 9P server, mounts it at ~/mnt/feeds via 9pfuse,
|
||||
// and opens an acme window for browsing and managing feeds.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"os/exec"
|
||||
"os/signal"
|
||||
"path/filepath"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"9fans.net/go/plan9/client"
|
||||
)
|
||||
|
||||
const serviceName = "feeds"
|
||||
|
||||
func main() {
|
||||
// Locate Plan 9 namespace directory.
|
||||
ns := client.Namespace()
|
||||
if ns == "" {
|
||||
log.Fatal("no Plan 9 namespace (NAMESPACE not set?)")
|
||||
}
|
||||
sockPath := filepath.Join(ns, serviceName)
|
||||
|
||||
// Load or create the feed store.
|
||||
store, err := newFeedStore()
|
||||
if err != nil {
|
||||
log.Fatalf("store: %v", err)
|
||||
}
|
||||
|
||||
// Remove stale socket.
|
||||
os.Remove(sockPath)
|
||||
|
||||
// Start 9P server.
|
||||
srv, err := newP9Server(sockPath, store)
|
||||
if err != nil {
|
||||
log.Fatalf("9P listen: %v", err)
|
||||
}
|
||||
go srv.serve()
|
||||
log.Printf("9P server on %s", sockPath)
|
||||
|
||||
// Mount via 9pfuse at ~/mnt/feeds.
|
||||
mnt, fuseCmd := mountFeeds(sockPath)
|
||||
defer unmount(fuseCmd, mnt, sockPath)
|
||||
|
||||
// Open acme main window.
|
||||
if err := openMainWindow(store); err != nil {
|
||||
log.Fatalf("acme: %v", err)
|
||||
}
|
||||
|
||||
// Wait for window close or signal.
|
||||
sigCh := make(chan os.Signal, 1)
|
||||
signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM)
|
||||
select {
|
||||
case <-mainDone:
|
||||
case <-sigCh:
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mount / unmount
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func mountFeeds(sockPath string) (string, *exec.Cmd) {
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
log.Printf("cannot determine home dir: %v", err)
|
||||
return "", nil
|
||||
}
|
||||
mnt := filepath.Join(home, "mnt", "feeds")
|
||||
if err := os.MkdirAll(mnt, 0755); err != nil {
|
||||
log.Printf("cannot create mount dir %s: %v", mnt, err)
|
||||
return mnt, nil
|
||||
}
|
||||
cmd := exec.Command("9pfuse", sockPath, mnt)
|
||||
if err := cmd.Start(); err != nil {
|
||||
log.Printf("9pfuse: %v (continuing without mount)", err)
|
||||
return mnt, nil
|
||||
}
|
||||
log.Printf("mounted at %s", mnt)
|
||||
return mnt, cmd
|
||||
}
|
||||
|
||||
func unmount(fuseCmd *exec.Cmd, mnt, sockPath string) {
|
||||
if fuseCmd != nil {
|
||||
exec.Command("fusermount", "-u", mnt).Run()
|
||||
fuseCmd.Wait()
|
||||
}
|
||||
os.Remove(sockPath)
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Refresh helpers (called from acme.go and p9.go)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// doSubscribe fetches a feed URL, derives a slug, subscribes, and polls entries.
|
||||
func doSubscribe(store *FeedStore, url, alias string) error {
|
||||
result, err := fetchFeed(url, "", "")
|
||||
if err != nil {
|
||||
return fmt.Errorf("fetch %s: %w", url, err)
|
||||
}
|
||||
if result.NotModified || result.FeedTitle == "" {
|
||||
result.FeedTitle = url
|
||||
}
|
||||
|
||||
store.mu.Lock()
|
||||
slug := store.feedSlugFromTitle(result.FeedTitle, alias)
|
||||
store.mu.Unlock()
|
||||
|
||||
sub := &Subscription{
|
||||
URL: url,
|
||||
Slug: slug,
|
||||
Title: result.FeedTitle,
|
||||
SubscribedAt: time.Now().UTC().Format(time.RFC3339),
|
||||
// Do not store ETag/LastModified yet. If parsing yields zero entries
|
||||
// the cached validator would cause every subsequent refresh to return
|
||||
// 304 and never recover. They are written by doRefresh after a
|
||||
// successful fetch that produces at least one new entry.
|
||||
}
|
||||
if err := store.subscribe(sub); err != nil {
|
||||
return err
|
||||
}
|
||||
log.Printf("fetched %s: %d raw entries", sub.Slug, len(result.Entries))
|
||||
// Use sub.Slug, not the local slug variable: subscribe() may have
|
||||
// adjusted it for uniqueness.
|
||||
n, err := store.addEntries(sub.Slug, result.Entries)
|
||||
if err != nil {
|
||||
return fmt.Errorf("save entries: %w", err)
|
||||
}
|
||||
log.Printf("subscribed %s (%s): %d entries added", sub.Slug, url, n)
|
||||
return nil
|
||||
}
|
||||
|
||||
// doRefresh re-polls a single feed.
|
||||
func doRefresh(store *FeedStore, slug string) error {
|
||||
store.mu.RLock()
|
||||
sub := store.subscriptionBySlug(slug)
|
||||
store.mu.RUnlock()
|
||||
if sub == nil {
|
||||
return fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
|
||||
result, err := fetchFeed(sub.URL, sub.ETag, sub.LastModified)
|
||||
if err != nil {
|
||||
return fmt.Errorf("fetch %s: %w", slug, err)
|
||||
}
|
||||
if result.NotModified {
|
||||
log.Printf("refresh %s: not modified", slug)
|
||||
return nil
|
||||
}
|
||||
log.Printf("refresh %s: %d raw entries", slug, len(result.Entries))
|
||||
n, err := store.addEntries(slug, result.Entries)
|
||||
if err != nil {
|
||||
return fmt.Errorf("save entries: %w", err)
|
||||
}
|
||||
// Only advance the cached validators when we actually stored something;
|
||||
// if parsing returned zero entries we want the next refresh to re-fetch.
|
||||
if n > 0 {
|
||||
store.updateSubscriptionHTTPMeta(slug, result.ETag, result.LastModified)
|
||||
}
|
||||
log.Printf("refresh %s: %d new entries", slug, n)
|
||||
return nil
|
||||
}
|
||||
|
||||
// doRefreshAll re-polls every subscribed feed.
|
||||
func doRefreshAll(store *FeedStore) error {
|
||||
store.mu.RLock()
|
||||
slugs := make([]string, len(store.subs))
|
||||
for i, s := range store.subs {
|
||||
slugs[i] = s.Slug
|
||||
}
|
||||
store.mu.RUnlock()
|
||||
|
||||
var lastErr error
|
||||
for _, slug := range slugs {
|
||||
if err := doRefresh(store, slug); err != nil {
|
||||
log.Printf("refresh %s: %v", slug, err)
|
||||
lastErr = err
|
||||
}
|
||||
}
|
||||
return lastErr
|
||||
}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
INSTALL_PATH=$HOME/bin
|
||||
|
||||
all:V: install
|
||||
|
||||
build:V:
|
||||
go build -o $INSTALL_PATH/Feeds .
|
||||
|
||||
install:V: build
|
||||
|
||||
clean:V:
|
||||
rm -f $INSTALL_PATH/Feeds
|
||||
|
|
@ -0,0 +1,723 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"net"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"9fans.net/go/plan9"
|
||||
)
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Qid constants
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const (
|
||||
qidRoot uint64 = 0
|
||||
qidCtl uint64 = 1
|
||||
qidUnread uint64 = 2
|
||||
qidAll uint64 = 3
|
||||
qidFeedsDir uint64 = 4
|
||||
qidPinned uint64 = 5
|
||||
// Dynamic qids are computed via pathQid() from the path string.
|
||||
// Static ones above are reserved in the low range.
|
||||
)
|
||||
|
||||
// pathQid computes a stable Qid path from an arbitrary string.
|
||||
// Uses FNV-1a to avoid import of crypto packages.
|
||||
func pathQid(s string) uint64 {
|
||||
var h uint64 = 14695981039346656037
|
||||
for i := 0; i < len(s); i++ {
|
||||
h ^= uint64(s[i])
|
||||
h *= 1099511628211
|
||||
}
|
||||
// Keep top bit clear (reserved for QTDIR in some plan9 implementations).
|
||||
return (h & 0x7FFFFFFFFFFFFFFF) | 0x1000
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// FID state
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type fidState struct {
|
||||
qid plan9.Qid
|
||||
path string
|
||||
open bool
|
||||
// write buffer — accumulated across Twrite calls, dispatched on Tclunk
|
||||
writeBuf []byte
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// P9Server
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type P9Server struct {
|
||||
listener net.Listener
|
||||
store *FeedStore
|
||||
sockPath string
|
||||
}
|
||||
|
||||
func newP9Server(sockPath string, store *FeedStore) (*P9Server, error) {
|
||||
ln, err := net.Listen("unix", sockPath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &P9Server{listener: ln, store: store, sockPath: sockPath}, nil
|
||||
}
|
||||
|
||||
func (srv *P9Server) serve() {
|
||||
for {
|
||||
conn, err := srv.listener.Accept()
|
||||
if err != nil {
|
||||
if !errors.Is(err, net.ErrClosed) {
|
||||
log.Printf("9P accept: %v", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
go srv.handleConn(conn)
|
||||
}
|
||||
}
|
||||
|
||||
func (srv *P9Server) close() {
|
||||
srv.listener.Close()
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Connection handler
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (srv *P9Server) handleConn(conn net.Conn) {
|
||||
defer conn.Close()
|
||||
|
||||
fids := make(map[uint32]*fidState)
|
||||
var mu sync.Mutex
|
||||
|
||||
get := func(fid uint32) *fidState {
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
return fids[fid]
|
||||
}
|
||||
set := func(fid uint32, f *fidState) {
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
fids[fid] = f
|
||||
}
|
||||
del := func(fid uint32) {
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
delete(fids, fid)
|
||||
}
|
||||
|
||||
for {
|
||||
fcall, err := plan9.ReadFcall(conn)
|
||||
if err != nil {
|
||||
if err != io.EOF {
|
||||
log.Printf("9P read: %v", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
resp := plan9.Fcall{Tag: fcall.Tag}
|
||||
|
||||
switch fcall.Type {
|
||||
|
||||
case plan9.Tversion:
|
||||
resp.Type = plan9.Rversion
|
||||
resp.Msize = fcall.Msize
|
||||
resp.Version = "9P2000"
|
||||
|
||||
case plan9.Tattach:
|
||||
resp.Type = plan9.Rattach
|
||||
resp.Qid = plan9.Qid{Type: plan9.QTDIR, Path: qidRoot}
|
||||
set(fcall.Fid, &fidState{qid: resp.Qid, path: "/"})
|
||||
|
||||
case plan9.Twalk:
|
||||
f := get(fcall.Fid)
|
||||
if f == nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "bad fid"
|
||||
break
|
||||
}
|
||||
if len(fcall.Wname) == 0 {
|
||||
// Clone.
|
||||
nf := &fidState{qid: f.qid, path: f.path}
|
||||
set(fcall.Newfid, nf)
|
||||
resp.Type = plan9.Rwalk
|
||||
break
|
||||
}
|
||||
cur := f.path
|
||||
var wqids []plan9.Qid
|
||||
for _, name := range fcall.Wname {
|
||||
qid, next, err := srv.walk(cur, name)
|
||||
if err != nil {
|
||||
break
|
||||
}
|
||||
wqids = append(wqids, qid)
|
||||
cur = next
|
||||
}
|
||||
if len(wqids) == 0 {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "file not found"
|
||||
break
|
||||
}
|
||||
resp.Type = plan9.Rwalk
|
||||
resp.Wqid = wqids
|
||||
if len(wqids) == len(fcall.Wname) {
|
||||
set(fcall.Newfid, &fidState{
|
||||
qid: wqids[len(wqids)-1],
|
||||
path: cur,
|
||||
})
|
||||
}
|
||||
|
||||
case plan9.Topen:
|
||||
f := get(fcall.Fid)
|
||||
if f == nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "bad fid"
|
||||
break
|
||||
}
|
||||
f.open = true
|
||||
resp.Type = plan9.Ropen
|
||||
resp.Qid = f.qid
|
||||
resp.Iounit = 0
|
||||
|
||||
case plan9.Tread:
|
||||
f := get(fcall.Fid)
|
||||
if f == nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "bad fid"
|
||||
break
|
||||
}
|
||||
data, err := srv.read(f, int64(fcall.Offset), fcall.Count)
|
||||
if err != nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = err.Error()
|
||||
break
|
||||
}
|
||||
resp.Type = plan9.Rread
|
||||
resp.Data = data
|
||||
|
||||
case plan9.Twrite:
|
||||
f := get(fcall.Fid)
|
||||
if f == nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "bad fid"
|
||||
break
|
||||
}
|
||||
// Buffer writes; dispatch on Tclunk.
|
||||
f.writeBuf = append(f.writeBuf, fcall.Data...)
|
||||
resp.Type = plan9.Rwrite
|
||||
resp.Count = uint32(len(fcall.Data))
|
||||
|
||||
case plan9.Tclunk:
|
||||
f := get(fcall.Fid)
|
||||
if f != nil && len(f.writeBuf) > 0 {
|
||||
if err := srv.dispatch(f.path, f.writeBuf); err != nil {
|
||||
// Log but don't fail the clunk.
|
||||
log.Printf("dispatch %s: %v", f.path, err)
|
||||
}
|
||||
}
|
||||
del(fcall.Fid)
|
||||
resp.Type = plan9.Rclunk
|
||||
|
||||
case plan9.Tstat:
|
||||
f := get(fcall.Fid)
|
||||
if f == nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "bad fid"
|
||||
break
|
||||
}
|
||||
dir, err := srv.stat(f.path)
|
||||
if err != nil {
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = err.Error()
|
||||
break
|
||||
}
|
||||
resp.Type = plan9.Rstat
|
||||
resp.Stat, _ = dir.Bytes()
|
||||
|
||||
default:
|
||||
resp.Type = plan9.Rerror
|
||||
resp.Ename = "not implemented"
|
||||
}
|
||||
|
||||
if err := plan9.WriteFcall(conn, &resp); err != nil {
|
||||
log.Printf("9P write: %v", err)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// walk
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (srv *P9Server) walk(cur, name string) (plan9.Qid, string, error) {
|
||||
parts := splitPath(cur)
|
||||
depth := len(parts)
|
||||
|
||||
switch {
|
||||
// Root → top-level names.
|
||||
case depth == 0:
|
||||
switch name {
|
||||
case "ctl":
|
||||
return plan9.Qid{Type: plan9.QTFILE, Path: qidCtl}, "/ctl", nil
|
||||
case "unread":
|
||||
return plan9.Qid{Type: plan9.QTFILE, Path: qidUnread}, "/unread", nil
|
||||
case "all":
|
||||
return plan9.Qid{Type: plan9.QTFILE, Path: qidAll}, "/all", nil
|
||||
case "pinned":
|
||||
return plan9.Qid{Type: plan9.QTFILE, Path: qidPinned}, "/pinned", nil
|
||||
case "feeds":
|
||||
return plan9.Qid{Type: plan9.QTDIR, Path: qidFeedsDir}, "/feeds", nil
|
||||
}
|
||||
|
||||
// /feeds → slug directory.
|
||||
case depth == 1 && parts[0] == "feeds":
|
||||
srv.store.mu.RLock()
|
||||
exists := srv.store.slugExists(name)
|
||||
srv.store.mu.RUnlock()
|
||||
if exists {
|
||||
p := "/feeds/" + name
|
||||
return plan9.Qid{Type: plan9.QTDIR, Path: pathQid(p)}, p, nil
|
||||
}
|
||||
|
||||
// /feeds/{slug} → per-feed files and subdirs.
|
||||
case depth == 2 && parts[0] == "feeds":
|
||||
slug := parts[1]
|
||||
p := cur + "/" + name
|
||||
switch name {
|
||||
case "meta", "ctl", "unread", "all":
|
||||
return plan9.Qid{Type: plan9.QTFILE, Path: pathQid(p)}, p, nil
|
||||
case "new", "read":
|
||||
return plan9.Qid{Type: plan9.QTDIR, Path: pathQid(p)}, p, nil
|
||||
}
|
||||
_ = slug
|
||||
|
||||
// /feeds/{slug}/new or /feeds/{slug}/read → entry files.
|
||||
case depth == 3 && parts[0] == "feeds":
|
||||
slug := parts[1]
|
||||
bucket := parts[2] // "new" or "read"
|
||||
if bucket != "new" && bucket != "read" {
|
||||
break
|
||||
}
|
||||
srv.store.mu.RLock()
|
||||
files := srv.store.files[slug]
|
||||
srv.store.mu.RUnlock()
|
||||
for _, ef := range files {
|
||||
if ef.filename == name {
|
||||
wantRead := bucket == "read"
|
||||
if ef.read == wantRead {
|
||||
p := cur + "/" + name
|
||||
return plan9.Qid{Type: plan9.QTFILE, Path: pathQid(p)}, p, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return plan9.Qid{}, "", errors.New("not found")
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// read
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (srv *P9Server) read(f *fidState, offset int64, count uint32) ([]byte, error) {
|
||||
if f.qid.Type&plan9.QTDIR != 0 {
|
||||
return srv.readDir(f.path, offset, count)
|
||||
}
|
||||
data, err := srv.readFile(f.path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return sliceAt(data, offset, count), nil
|
||||
}
|
||||
|
||||
func (srv *P9Server) readDir(path string, offset int64, count uint32) ([]byte, error) {
|
||||
parts := splitPath(path)
|
||||
depth := len(parts)
|
||||
|
||||
var entries []plan9.Dir
|
||||
|
||||
switch {
|
||||
case depth == 0: // root
|
||||
entries = []plan9.Dir{
|
||||
fileDir("ctl", 0644, qidCtl),
|
||||
fileDir("unread", 0444, qidUnread),
|
||||
fileDir("all", 0444, qidAll),
|
||||
fileDir("pinned", 0444, qidPinned),
|
||||
dirEntry("feeds", qidFeedsDir),
|
||||
}
|
||||
|
||||
case depth == 1 && parts[0] == "feeds": // /feeds
|
||||
srv.store.mu.RLock()
|
||||
for _, sub := range srv.store.subs {
|
||||
p := "/feeds/" + sub.Slug
|
||||
entries = append(entries, dirEntry(sub.Slug, pathQid(p)))
|
||||
}
|
||||
srv.store.mu.RUnlock()
|
||||
|
||||
case depth == 2 && parts[0] == "feeds": // /feeds/{slug}
|
||||
slug := parts[1]
|
||||
base := path
|
||||
entries = []plan9.Dir{
|
||||
fileDir("meta", 0444, pathQid(base+"/meta")),
|
||||
fileDir("ctl", 0644, pathQid(base+"/ctl")),
|
||||
fileDir("unread", 0444, pathQid(base+"/unread")),
|
||||
fileDir("all", 0444, pathQid(base+"/all")),
|
||||
dirEntry("new", pathQid(base+"/new")),
|
||||
dirEntry("read", pathQid(base+"/read")),
|
||||
}
|
||||
_ = slug
|
||||
|
||||
case depth == 3 && parts[0] == "feeds": // /feeds/{slug}/new or /feeds/{slug}/read
|
||||
slug := parts[1]
|
||||
bucket := parts[2]
|
||||
wantRead := bucket == "read"
|
||||
srv.store.mu.RLock()
|
||||
files := srv.store.files[slug]
|
||||
srv.store.mu.RUnlock()
|
||||
for _, ef := range files {
|
||||
if ef.read == wantRead {
|
||||
p := path + "/" + ef.filename
|
||||
entries = append(entries, fileDir(ef.filename, 0444, pathQid(p)))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return serializeDirs(entries, offset, count), nil
|
||||
}
|
||||
|
||||
func (srv *P9Server) readFile(path string) ([]byte, error) {
|
||||
parts := splitPath(path)
|
||||
|
||||
switch {
|
||||
case path == "/ctl":
|
||||
return []byte("sub <url> [slug]\nunsub <slug>\nrefresh [slug]\n"), nil
|
||||
|
||||
case path == "/unread":
|
||||
return []byte(srv.globalIndexText(true)), nil
|
||||
|
||||
case path == "/all":
|
||||
return []byte(srv.globalIndexText(false)), nil
|
||||
|
||||
case path == "/pinned":
|
||||
return []byte(srv.pinnedIndexText()), nil
|
||||
|
||||
case len(parts) == 3 && parts[0] == "feeds" && parts[2] == "meta":
|
||||
slug := parts[1]
|
||||
srv.store.mu.RLock()
|
||||
sub := srv.store.subscriptionBySlug(slug)
|
||||
srv.store.mu.RUnlock()
|
||||
if sub == nil {
|
||||
return nil, fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
var sb strings.Builder
|
||||
fmt.Fprintf(&sb, "url: %s\n", sub.URL)
|
||||
fmt.Fprintf(&sb, "slug: %s\n", sub.Slug)
|
||||
fmt.Fprintf(&sb, "title: %s\n", sub.Title)
|
||||
fmt.Fprintf(&sb, "subscribed: %s\n", sub.SubscribedAt)
|
||||
fmt.Fprintf(&sb, "last_fetched: %s\n", sub.LastFetched)
|
||||
return []byte(sb.String()), nil
|
||||
|
||||
case len(parts) == 3 && parts[0] == "feeds" && parts[2] == "ctl":
|
||||
return []byte("refresh\nunsub\nmark-all-read\nread <guid>\n"), nil
|
||||
|
||||
case len(parts) == 3 && parts[0] == "feeds" && parts[2] == "unread":
|
||||
return []byte(srv.feedIndexText(parts[1], true)), nil
|
||||
|
||||
case len(parts) == 3 && parts[0] == "feeds" && parts[2] == "all":
|
||||
return []byte(srv.feedIndexText(parts[1], false)), nil
|
||||
|
||||
case len(parts) == 4 && parts[0] == "feeds":
|
||||
return srv.readEntryFile(parts[1], parts[2], parts[3])
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("not found: %s", path)
|
||||
}
|
||||
|
||||
func (srv *P9Server) readEntryFile(slug, bucket, filename string) ([]byte, error) {
|
||||
wantRead := bucket == "read"
|
||||
srv.store.mu.RLock()
|
||||
files := srv.store.files[slug]
|
||||
srv.store.mu.RUnlock()
|
||||
|
||||
for _, ef := range files {
|
||||
if ef.filename == filename && ef.read == wantRead {
|
||||
e := ef.entry
|
||||
var sb strings.Builder
|
||||
fmt.Fprintf(&sb, "%s\n", e.Title)
|
||||
fmt.Fprintf(&sb, "%s\n", e.URL)
|
||||
|
||||
srv.store.mu.RLock()
|
||||
sub := srv.store.subscriptionBySlug(slug)
|
||||
srv.store.mu.RUnlock()
|
||||
feedTitle := slug
|
||||
if sub != nil {
|
||||
feedTitle = sub.Title
|
||||
}
|
||||
fmt.Fprintf(&sb, "%s | %s\n", feedTitle, e.Timestamp)
|
||||
|
||||
if e.Summary != "" {
|
||||
fmt.Fprintf(&sb, "\n%s\n", e.Summary)
|
||||
}
|
||||
return []byte(sb.String()), nil
|
||||
}
|
||||
}
|
||||
return nil, fmt.Errorf("not found")
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// dispatch — handle writes to ctl files (called on Tclunk)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (srv *P9Server) dispatch(path string, data []byte) error {
|
||||
cmd := strings.TrimSpace(string(data))
|
||||
parts := splitPath(path)
|
||||
|
||||
switch {
|
||||
case path == "/ctl":
|
||||
return srv.handleGlobalCtl(cmd)
|
||||
|
||||
case len(parts) == 3 && parts[0] == "feeds" && parts[2] == "ctl":
|
||||
return srv.handleFeedCtl(parts[1], cmd)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (srv *P9Server) handleGlobalCtl(cmd string) error {
|
||||
fields := strings.Fields(cmd)
|
||||
if len(fields) == 0 {
|
||||
return nil
|
||||
}
|
||||
switch fields[0] {
|
||||
case "sub":
|
||||
if len(fields) < 2 {
|
||||
return fmt.Errorf("sub: missing URL")
|
||||
}
|
||||
url := fields[1]
|
||||
alias := ""
|
||||
if len(fields) >= 3 {
|
||||
alias = fields[2]
|
||||
}
|
||||
return doSubscribe(srv.store, url, alias)
|
||||
|
||||
case "unsub":
|
||||
if len(fields) < 2 {
|
||||
return fmt.Errorf("unsub: missing slug")
|
||||
}
|
||||
return srv.store.unsubscribe(fields[1])
|
||||
|
||||
case "refresh":
|
||||
if len(fields) >= 2 {
|
||||
return doRefresh(srv.store, fields[1])
|
||||
}
|
||||
return doRefreshAll(srv.store)
|
||||
}
|
||||
return fmt.Errorf("unknown command: %s", fields[0])
|
||||
}
|
||||
|
||||
func (srv *P9Server) handleFeedCtl(slug, cmd string) error {
|
||||
fields := strings.Fields(cmd)
|
||||
if len(fields) == 0 {
|
||||
return nil
|
||||
}
|
||||
switch fields[0] {
|
||||
case "refresh":
|
||||
return doRefresh(srv.store, slug)
|
||||
case "unsub":
|
||||
return srv.store.unsubscribe(slug)
|
||||
case "mark-all-read":
|
||||
return srv.store.markAllRead(slug)
|
||||
case "read":
|
||||
if len(fields) < 2 {
|
||||
return fmt.Errorf("read: missing guid")
|
||||
}
|
||||
return srv.store.markRead(slug, fields[1])
|
||||
}
|
||||
return fmt.Errorf("unknown command: %s", fields[0])
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// stat
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (srv *P9Server) stat(path string) (plan9.Dir, error) {
|
||||
parts := splitPath(path)
|
||||
name := "/"
|
||||
if len(parts) > 0 {
|
||||
name = parts[len(parts)-1]
|
||||
}
|
||||
d := plan9.Dir{Name: name, Uid: "feeds", Gid: "feeds", Muid: "feeds"}
|
||||
|
||||
switch {
|
||||
case path == "/":
|
||||
d.Mode = plan9.DMDIR | 0755
|
||||
d.Qid = plan9.Qid{Type: plan9.QTDIR, Path: qidRoot}
|
||||
|
||||
case path == "/ctl":
|
||||
d.Mode = 0644
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: qidCtl}
|
||||
|
||||
case path == "/unread":
|
||||
d.Mode = 0444
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: qidUnread}
|
||||
|
||||
case path == "/all":
|
||||
d.Mode = 0444
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: qidAll}
|
||||
|
||||
case path == "/pinned":
|
||||
d.Mode = 0444
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: qidPinned}
|
||||
|
||||
case path == "/feeds":
|
||||
d.Mode = plan9.DMDIR | 0755
|
||||
d.Qid = plan9.Qid{Type: plan9.QTDIR, Path: qidFeedsDir}
|
||||
|
||||
case len(parts) == 2 && parts[0] == "feeds":
|
||||
slug := parts[1]
|
||||
srv.store.mu.RLock()
|
||||
exists := srv.store.slugExists(slug)
|
||||
srv.store.mu.RUnlock()
|
||||
if !exists {
|
||||
return plan9.Dir{}, fmt.Errorf("not found")
|
||||
}
|
||||
d.Mode = plan9.DMDIR | 0755
|
||||
d.Qid = plan9.Qid{Type: plan9.QTDIR, Path: pathQid(path)}
|
||||
|
||||
case len(parts) == 3 && parts[0] == "feeds":
|
||||
switch parts[2] {
|
||||
case "new", "read":
|
||||
d.Mode = plan9.DMDIR | 0755
|
||||
d.Qid = plan9.Qid{Type: plan9.QTDIR, Path: pathQid(path)}
|
||||
case "meta", "unread", "all":
|
||||
d.Mode = 0444
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: pathQid(path)}
|
||||
case "ctl":
|
||||
d.Mode = 0644
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: pathQid(path)}
|
||||
default:
|
||||
return plan9.Dir{}, fmt.Errorf("not found")
|
||||
}
|
||||
|
||||
case len(parts) == 4 && parts[0] == "feeds":
|
||||
d.Mode = 0444
|
||||
d.Qid = plan9.Qid{Type: plan9.QTFILE, Path: pathQid(path)}
|
||||
|
||||
default:
|
||||
return plan9.Dir{}, fmt.Errorf("not found: %s", path)
|
||||
}
|
||||
|
||||
return d, nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Index text helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (srv *P9Server) globalIndexText(unreadOnly bool) string {
|
||||
rows := srv.store.globalIndex(unreadOnly)
|
||||
var sb strings.Builder
|
||||
for i, row := range rows {
|
||||
e := row.ef.entry
|
||||
fmt.Fprintf(&sb, "%4d %-20s %-20s %s\n",
|
||||
i+1,
|
||||
formatTS(e.Timestamp),
|
||||
row.slug,
|
||||
e.Title,
|
||||
)
|
||||
}
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
func (srv *P9Server) pinnedIndexText() string {
|
||||
rows := srv.store.globalPinned()
|
||||
var sb strings.Builder
|
||||
for i, row := range rows {
|
||||
e := row.ef.entry
|
||||
fmt.Fprintf(&sb, "%4d %-20s %-20s %s\n",
|
||||
i+1,
|
||||
formatTS(e.Timestamp),
|
||||
row.slug,
|
||||
e.Title,
|
||||
)
|
||||
}
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
func (srv *P9Server) feedIndexText(slug string, unreadOnly bool) string {
|
||||
srv.store.mu.RLock()
|
||||
files := srv.store.files[slug]
|
||||
srv.store.mu.RUnlock()
|
||||
|
||||
var sb strings.Builder
|
||||
n := 0
|
||||
for _, ef := range files {
|
||||
if unreadOnly && ef.read {
|
||||
continue
|
||||
}
|
||||
n++
|
||||
fmt.Fprintf(&sb, "%4d %-20s %s\n", n, formatTS(ef.entry.Timestamp), ef.entry.Title)
|
||||
}
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
func formatTS(ts string) string {
|
||||
if len(ts) >= 10 {
|
||||
return ts[:10]
|
||||
}
|
||||
return ts
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Utility
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func splitPath(path string) []string {
|
||||
trimmed := strings.TrimPrefix(path, "/")
|
||||
if trimmed == "" {
|
||||
return nil
|
||||
}
|
||||
return strings.Split(trimmed, "/")
|
||||
}
|
||||
|
||||
func sliceAt(data []byte, offset int64, count uint32) []byte {
|
||||
if offset >= int64(len(data)) {
|
||||
return []byte{}
|
||||
}
|
||||
end := offset + int64(count)
|
||||
if end > int64(len(data)) {
|
||||
end = int64(len(data))
|
||||
}
|
||||
return data[offset:end]
|
||||
}
|
||||
|
||||
func serializeDirs(entries []plan9.Dir, offset int64, count uint32) []byte {
|
||||
var buf []byte
|
||||
for _, d := range entries {
|
||||
b, _ := d.Bytes()
|
||||
buf = append(buf, b...)
|
||||
}
|
||||
return sliceAt(buf, offset, count)
|
||||
}
|
||||
|
||||
func fileDir(name string, mode plan9.Perm, qidPath uint64) plan9.Dir {
|
||||
return plan9.Dir{
|
||||
Name: name,
|
||||
Mode: mode,
|
||||
Qid: plan9.Qid{Type: plan9.QTFILE, Path: qidPath},
|
||||
}
|
||||
}
|
||||
|
||||
func dirEntry(name string, qidPath uint64) plan9.Dir {
|
||||
return plan9.Dir{
|
||||
Name: name,
|
||||
Mode: plan9.DMDIR | 0755,
|
||||
Qid: plan9.Qid{Type: plan9.QTDIR, Path: qidPath},
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,718 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"crypto/sha256"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
"unicode"
|
||||
)
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Data types
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type Subscription struct {
|
||||
URL string `json:"url"`
|
||||
Slug string `json:"slug"`
|
||||
Title string `json:"title"`
|
||||
SubscribedAt string `json:"subscribed_at"`
|
||||
LastFetched string `json:"last_fetched,omitempty"`
|
||||
ETag string `json:"etag,omitempty"`
|
||||
LastModified string `json:"last_modified,omitempty"`
|
||||
}
|
||||
|
||||
type Entry struct {
|
||||
GUID string `json:"guid"`
|
||||
Timestamp string `json:"timestamp"`
|
||||
Title string `json:"title"`
|
||||
URL string `json:"url"`
|
||||
Summary string `json:"summary"`
|
||||
FetchedAt string `json:"fetched_at"`
|
||||
}
|
||||
|
||||
// entryFile pairs an entry with its generated filename and state flags.
|
||||
type entryFile struct {
|
||||
filename string
|
||||
entry *Entry
|
||||
read bool
|
||||
pinned bool
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// FeedStore — in-memory state + disk persistence
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type FeedStore struct {
|
||||
mu sync.RWMutex
|
||||
subs []*Subscription // ordered by SubscribedAt
|
||||
// slug → entries sorted by timestamp descending
|
||||
entries map[string][]*Entry
|
||||
// slug → set of read GUIDs
|
||||
readSets map[string]map[string]bool
|
||||
// slug → set of pinned GUIDs
|
||||
pinnedSets map[string]map[string]bool
|
||||
// slug → computed entryFile list (rebuilt after any mutation)
|
||||
files map[string][]entryFile
|
||||
|
||||
dataDir string // ~/.local/share/acme-feed
|
||||
}
|
||||
|
||||
func newFeedStore() (*FeedStore, error) {
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
dataDir := filepath.Join(home, ".local", "share", "acme-feed")
|
||||
for _, d := range []string{
|
||||
dataDir,
|
||||
filepath.Join(dataDir, "feeds"),
|
||||
filepath.Join(dataDir, "read"),
|
||||
filepath.Join(dataDir, "pinned"),
|
||||
filepath.Join(dataDir, "content"),
|
||||
} {
|
||||
if err := os.MkdirAll(d, 0755); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
fs := &FeedStore{
|
||||
entries: make(map[string][]*Entry),
|
||||
readSets: make(map[string]map[string]bool),
|
||||
pinnedSets: make(map[string]map[string]bool),
|
||||
files: make(map[string][]entryFile),
|
||||
dataDir: dataDir,
|
||||
}
|
||||
if err := fs.load(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return fs, nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Load from disk
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (s *FeedStore) load() error {
|
||||
subs, err := s.loadSubscriptions()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
s.subs = subs
|
||||
|
||||
for _, sub := range subs {
|
||||
entries, err := s.loadEntries(sub.Slug)
|
||||
if err != nil {
|
||||
return fmt.Errorf("load entries %s: %w", sub.Slug, err)
|
||||
}
|
||||
s.entries[sub.Slug] = entries
|
||||
|
||||
readSet, err := s.loadReadSet(sub.Slug)
|
||||
if err != nil {
|
||||
return fmt.Errorf("load read set %s: %w", sub.Slug, err)
|
||||
}
|
||||
s.readSets[sub.Slug] = readSet
|
||||
|
||||
pinnedSet, err := s.loadGUIDFile(filepath.Join(s.dataDir, "pinned", sub.Slug))
|
||||
if err != nil {
|
||||
return fmt.Errorf("load pinned set %s: %w", sub.Slug, err)
|
||||
}
|
||||
s.pinnedSets[sub.Slug] = pinnedSet
|
||||
s.rebuildFiles(sub.Slug)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *FeedStore) loadSubscriptions() ([]*Subscription, error) {
|
||||
path := filepath.Join(s.dataDir, "subscriptions.jsonl")
|
||||
f, err := os.Open(path)
|
||||
if os.IsNotExist(err) {
|
||||
return nil, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
var subs []*Subscription
|
||||
sc := bufio.NewScanner(f)
|
||||
for sc.Scan() {
|
||||
line := strings.TrimSpace(sc.Text())
|
||||
if line == "" {
|
||||
continue
|
||||
}
|
||||
var sub Subscription
|
||||
if err := json.Unmarshal([]byte(line), &sub); err != nil {
|
||||
continue
|
||||
}
|
||||
subs = append(subs, &sub)
|
||||
}
|
||||
return subs, sc.Err()
|
||||
}
|
||||
|
||||
func (s *FeedStore) loadEntries(slug string) ([]*Entry, error) {
|
||||
path := filepath.Join(s.dataDir, "feeds", slug+".jsonl")
|
||||
f, err := os.Open(path)
|
||||
if os.IsNotExist(err) {
|
||||
return nil, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
seen := make(map[string]bool)
|
||||
var entries []*Entry
|
||||
sc := bufio.NewScanner(f)
|
||||
sc.Buffer(make([]byte, 1<<20), 1<<20)
|
||||
for sc.Scan() {
|
||||
line := strings.TrimSpace(sc.Text())
|
||||
if line == "" {
|
||||
continue
|
||||
}
|
||||
var e Entry
|
||||
if err := json.Unmarshal([]byte(line), &e); err != nil {
|
||||
continue
|
||||
}
|
||||
if seen[e.GUID] {
|
||||
continue
|
||||
}
|
||||
seen[e.GUID] = true
|
||||
entries = append(entries, &e)
|
||||
}
|
||||
// Sort descending by timestamp.
|
||||
sort.Slice(entries, func(i, j int) bool {
|
||||
return entries[i].Timestamp > entries[j].Timestamp
|
||||
})
|
||||
return entries, sc.Err()
|
||||
}
|
||||
|
||||
func (s *FeedStore) loadReadSet(slug string) (map[string]bool, error) {
|
||||
return s.loadGUIDFile(filepath.Join(s.dataDir, "read", slug))
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Content cache
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// contentCachePath returns the path for a cached Markdown content file.
|
||||
func (s *FeedStore) contentCachePath(slug, entryFilename string) string {
|
||||
dir := filepath.Join(s.dataDir, "content", slug)
|
||||
os.MkdirAll(dir, 0755)
|
||||
return filepath.Join(dir, entryFilename+".md")
|
||||
}
|
||||
|
||||
// loadCachedContent returns cached Markdown, or ("", false) if not present.
|
||||
func (s *FeedStore) loadCachedContent(slug, entryFilename string) (string, bool) {
|
||||
data, err := os.ReadFile(s.contentCachePath(slug, entryFilename))
|
||||
if err != nil {
|
||||
return "", false
|
||||
}
|
||||
return string(data), true
|
||||
}
|
||||
|
||||
// saveCachedContent writes Markdown to the content cache.
|
||||
func (s *FeedStore) saveCachedContent(slug, entryFilename, md string) {
|
||||
os.WriteFile(s.contentCachePath(slug, entryFilename), []byte(md), 0644)
|
||||
}
|
||||
|
||||
// loadGUIDFile reads a newline-separated file of GUIDs into a set.
|
||||
func (s *FeedStore) loadGUIDFile(path string) (map[string]bool, error) {
|
||||
f, err := os.Open(path)
|
||||
if os.IsNotExist(err) {
|
||||
return make(map[string]bool), nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
set := make(map[string]bool)
|
||||
sc := bufio.NewScanner(f)
|
||||
for sc.Scan() {
|
||||
if g := strings.TrimSpace(sc.Text()); g != "" {
|
||||
set[g] = true
|
||||
}
|
||||
}
|
||||
return set, sc.Err()
|
||||
}
|
||||
|
||||
// rewriteGUIDFile atomically rewrites a GUID set file.
|
||||
func rewriteGUIDFile(path string, set map[string]bool) error {
|
||||
f, err := os.Create(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer f.Close()
|
||||
for guid := range set {
|
||||
fmt.Fprintln(f, guid)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Persist to disk
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (s *FeedStore) saveSubscriptions() error {
|
||||
path := filepath.Join(s.dataDir, "subscriptions.jsonl")
|
||||
f, err := os.Create(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer f.Close()
|
||||
enc := json.NewEncoder(f)
|
||||
for _, sub := range s.subs {
|
||||
if err := enc.Encode(sub); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *FeedStore) appendEntries(slug string, entries []*Entry) error {
|
||||
if len(entries) == 0 {
|
||||
return nil
|
||||
}
|
||||
path := filepath.Join(s.dataDir, "feeds", slug+".jsonl")
|
||||
f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer f.Close()
|
||||
enc := json.NewEncoder(f)
|
||||
for _, e := range entries {
|
||||
if err := enc.Encode(e); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *FeedStore) appendGUID(path, guid string) error {
|
||||
f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer f.Close()
|
||||
_, err = fmt.Fprintln(f, guid)
|
||||
return err
|
||||
}
|
||||
|
||||
func (s *FeedStore) removeSubscriptionFiles(slug string) {
|
||||
os.Remove(filepath.Join(s.dataDir, "feeds", slug+".jsonl"))
|
||||
os.Remove(filepath.Join(s.dataDir, "read", slug))
|
||||
os.Remove(filepath.Join(s.dataDir, "pinned", slug))
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mutations (all hold mu.Lock)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// Subscribe adds a new feed. Returns an error if the slug already exists.
|
||||
func (s *FeedStore) subscribe(sub *Subscription) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
for _, existing := range s.subs {
|
||||
if existing.Slug == sub.Slug {
|
||||
// Make slug unique by appending -2, -3, etc.
|
||||
for i := 2; ; i++ {
|
||||
candidate := fmt.Sprintf("%s-%d", sub.Slug, i)
|
||||
found := false
|
||||
for _, e := range s.subs {
|
||||
if e.Slug == candidate {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
sub.Slug = candidate
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
if existing.URL == sub.URL {
|
||||
return fmt.Errorf("already subscribed: %s", existing.Slug)
|
||||
}
|
||||
}
|
||||
s.subs = append(s.subs, sub)
|
||||
s.entries[sub.Slug] = nil
|
||||
s.readSets[sub.Slug] = make(map[string]bool)
|
||||
s.pinnedSets[sub.Slug] = make(map[string]bool)
|
||||
s.files[sub.Slug] = nil
|
||||
return s.saveSubscriptions()
|
||||
}
|
||||
|
||||
// Unsubscribe removes a feed by slug.
|
||||
func (s *FeedStore) unsubscribe(slug string) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
found := false
|
||||
var remaining []*Subscription
|
||||
for _, sub := range s.subs {
|
||||
if sub.Slug == slug {
|
||||
found = true
|
||||
} else {
|
||||
remaining = append(remaining, sub)
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
return fmt.Errorf("no feed with slug %q", slug)
|
||||
}
|
||||
s.subs = remaining
|
||||
delete(s.entries, slug)
|
||||
delete(s.readSets, slug)
|
||||
delete(s.pinnedSets, slug)
|
||||
delete(s.files, slug)
|
||||
s.removeSubscriptionFiles(slug)
|
||||
return s.saveSubscriptions()
|
||||
}
|
||||
|
||||
// addEntries deduplicates and appends new entries for a feed.
|
||||
func (s *FeedStore) addEntries(slug string, newEntries []*Entry) (int, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
existing := s.entries[slug]
|
||||
seen := make(map[string]bool, len(existing))
|
||||
for _, e := range existing {
|
||||
seen[e.GUID] = true
|
||||
}
|
||||
|
||||
var toAdd []*Entry
|
||||
for _, e := range newEntries {
|
||||
if !seen[e.GUID] {
|
||||
seen[e.GUID] = true
|
||||
toAdd = append(toAdd, e)
|
||||
}
|
||||
}
|
||||
if len(toAdd) == 0 {
|
||||
return 0, nil
|
||||
}
|
||||
|
||||
if err := s.appendEntries(slug, toAdd); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
s.entries[slug] = append(s.entries[slug], toAdd...)
|
||||
sort.Slice(s.entries[slug], func(i, j int) bool {
|
||||
return s.entries[slug][i].Timestamp > s.entries[slug][j].Timestamp
|
||||
})
|
||||
s.rebuildFiles(slug)
|
||||
return len(toAdd), nil
|
||||
}
|
||||
|
||||
// updateSubscriptionHTTPMeta persists ETag/LastModified after a fetch.
|
||||
func (s *FeedStore) updateSubscriptionHTTPMeta(slug, etag, lastModified string) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
for _, sub := range s.subs {
|
||||
if sub.Slug == slug {
|
||||
sub.ETag = etag
|
||||
sub.LastModified = lastModified
|
||||
sub.LastFetched = time.Now().UTC().Format(time.RFC3339)
|
||||
break
|
||||
}
|
||||
}
|
||||
s.saveSubscriptions()
|
||||
}
|
||||
|
||||
// markRead moves a GUID from unread → read for the given slug.
|
||||
func (s *FeedStore) markRead(slug, guid string) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
rs := s.readSets[slug]
|
||||
if rs == nil {
|
||||
return fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
if rs[guid] {
|
||||
return nil // already read
|
||||
}
|
||||
rs[guid] = true
|
||||
if err := s.appendGUID(filepath.Join(s.dataDir, "read", slug), guid); err != nil {
|
||||
return err
|
||||
}
|
||||
s.rebuildFiles(slug)
|
||||
return nil
|
||||
}
|
||||
|
||||
// markAllRead marks every entry in a feed as read.
|
||||
func (s *FeedStore) markAllRead(slug string) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
rs := s.readSets[slug]
|
||||
if rs == nil {
|
||||
return fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
path := filepath.Join(s.dataDir, "read", slug)
|
||||
f, err := os.Create(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer f.Close()
|
||||
for _, e := range s.entries[slug] {
|
||||
rs[e.GUID] = true
|
||||
fmt.Fprintln(f, e.GUID)
|
||||
}
|
||||
s.rebuildFiles(slug)
|
||||
return nil
|
||||
}
|
||||
|
||||
// unmarkRead removes a GUID from the read set (marks the entry unread).
|
||||
func (s *FeedStore) unmarkRead(slug, guid string) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
rs := s.readSets[slug]
|
||||
if rs == nil {
|
||||
return fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
if !rs[guid] {
|
||||
return nil // already unread
|
||||
}
|
||||
delete(rs, guid)
|
||||
if err := rewriteGUIDFile(filepath.Join(s.dataDir, "read", slug), rs); err != nil {
|
||||
return err
|
||||
}
|
||||
s.rebuildFiles(slug)
|
||||
return nil
|
||||
}
|
||||
|
||||
// pin adds a GUID to the pinned set for a feed.
|
||||
func (s *FeedStore) pin(slug, guid string) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
ps := s.pinnedSets[slug]
|
||||
if ps == nil {
|
||||
return fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
if ps[guid] {
|
||||
return nil // already pinned
|
||||
}
|
||||
ps[guid] = true
|
||||
if err := s.appendGUID(filepath.Join(s.dataDir, "pinned", slug), guid); err != nil {
|
||||
return err
|
||||
}
|
||||
s.rebuildFiles(slug)
|
||||
return nil
|
||||
}
|
||||
|
||||
// unpin removes a GUID from the pinned set.
|
||||
func (s *FeedStore) unpin(slug, guid string) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
ps := s.pinnedSets[slug]
|
||||
if ps == nil {
|
||||
return fmt.Errorf("no feed %q", slug)
|
||||
}
|
||||
if !ps[guid] {
|
||||
return nil
|
||||
}
|
||||
delete(ps, guid)
|
||||
if err := rewriteGUIDFile(filepath.Join(s.dataDir, "pinned", slug), ps); err != nil {
|
||||
return err
|
||||
}
|
||||
s.rebuildFiles(slug)
|
||||
return nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Read-only accessors (caller must hold mu.RLock or mu.Lock)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
func (s *FeedStore) slugExists(slug string) bool {
|
||||
for _, sub := range s.subs {
|
||||
if sub.Slug == slug {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (s *FeedStore) subscriptionBySlug(slug string) *Subscription {
|
||||
for _, sub := range s.subs {
|
||||
if sub.Slug == slug {
|
||||
return sub
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// IndexRow is one entry in the global or per-feed index.
|
||||
type IndexRow struct {
|
||||
slug string
|
||||
ef entryFile
|
||||
}
|
||||
|
||||
// globalIndex returns all entryFiles across all feeds, sorted by timestamp desc.
|
||||
func (s *FeedStore) globalIndex(unreadOnly bool) []IndexRow {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
|
||||
var rows []IndexRow
|
||||
for slug, files := range s.files {
|
||||
for _, ef := range files {
|
||||
if unreadOnly && ef.read {
|
||||
continue
|
||||
}
|
||||
rows = append(rows, IndexRow{slug: slug, ef: ef})
|
||||
}
|
||||
}
|
||||
sort.Slice(rows, func(i, j int) bool {
|
||||
return rows[i].ef.entry.Timestamp > rows[j].ef.entry.Timestamp
|
||||
})
|
||||
return rows
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// File list builder
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// rebuildFiles rebuilds the entryFile list for a slug.
|
||||
// Caller must hold mu.Lock.
|
||||
func (s *FeedStore) rebuildFiles(slug string) {
|
||||
entries := s.entries[slug]
|
||||
rs := s.readSets[slug]
|
||||
if rs == nil {
|
||||
rs = make(map[string]bool)
|
||||
}
|
||||
ps := s.pinnedSets[slug]
|
||||
if ps == nil {
|
||||
ps = make(map[string]bool)
|
||||
}
|
||||
|
||||
seen := make(map[string]int) // base filename → collision count
|
||||
files := make([]entryFile, 0, len(entries))
|
||||
for _, e := range entries {
|
||||
base := makeEntryFilename(e)
|
||||
n := seen[base]
|
||||
seen[base]++
|
||||
name := base
|
||||
if n > 0 {
|
||||
name = fmt.Sprintf("%s-%d", base, n+1)
|
||||
}
|
||||
files = append(files, entryFile{
|
||||
filename: name,
|
||||
entry: e,
|
||||
read: rs[e.GUID],
|
||||
pinned: ps[e.GUID],
|
||||
})
|
||||
}
|
||||
s.files[slug] = files
|
||||
}
|
||||
|
||||
// feedFiles returns a snapshot of all entryFiles for a slug, sorted by
|
||||
// timestamp descending (newest first). Index 0 is newest; last is oldest.
|
||||
func (s *FeedStore) feedFiles(slug string) []entryFile {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
src := s.files[slug]
|
||||
snap := make([]entryFile, len(src))
|
||||
copy(snap, src)
|
||||
return snap
|
||||
}
|
||||
|
||||
// globalPinned returns all pinned entryFiles across all feeds, sorted by
|
||||
// timestamp descending.
|
||||
func (s *FeedStore) globalPinned() []IndexRow {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
|
||||
var rows []IndexRow
|
||||
for slug, files := range s.files {
|
||||
for _, ef := range files {
|
||||
if ef.pinned {
|
||||
rows = append(rows, IndexRow{slug: slug, ef: ef})
|
||||
}
|
||||
}
|
||||
}
|
||||
sort.Slice(rows, func(i, j int) bool {
|
||||
return rows[i].ef.entry.Timestamp > rows[j].ef.entry.Timestamp
|
||||
})
|
||||
return rows
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Slug and filename helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
var multiDash = regexp.MustCompile(`-{2,}`)
|
||||
|
||||
func slugify(s string) string {
|
||||
var b strings.Builder
|
||||
for _, r := range strings.ToLower(s) {
|
||||
switch {
|
||||
case unicode.IsLetter(r) || unicode.IsDigit(r):
|
||||
b.WriteRune(r)
|
||||
case unicode.IsSpace(r) || r == '-' || r == '_':
|
||||
b.WriteByte('-')
|
||||
}
|
||||
}
|
||||
return strings.Trim(multiDash.ReplaceAllString(b.String(), "-"), "-")
|
||||
}
|
||||
|
||||
// feedSlugFromTitle derives a unique slug. Caller must hold mu.Lock.
|
||||
func (s *FeedStore) feedSlugFromTitle(title, userAlias string) string {
|
||||
base := userAlias
|
||||
if base == "" {
|
||||
base = slugify(title)
|
||||
}
|
||||
if base == "" {
|
||||
base = "feed"
|
||||
}
|
||||
candidate := base
|
||||
for i := 2; ; i++ {
|
||||
taken := false
|
||||
for _, sub := range s.subs {
|
||||
if sub.Slug == candidate {
|
||||
taken = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !taken {
|
||||
return candidate
|
||||
}
|
||||
candidate = fmt.Sprintf("%s-%d", base, i)
|
||||
}
|
||||
}
|
||||
|
||||
func makeEntryFilename(e *Entry) string {
|
||||
ts := "00000000T000000Z"
|
||||
if t, err := time.Parse(time.RFC3339, e.Timestamp); err == nil {
|
||||
ts = t.UTC().Format("20060102T150405Z")
|
||||
}
|
||||
titleSlug := slugify(e.Title)
|
||||
if titleSlug == "" {
|
||||
// Fall back to hash of GUID.
|
||||
h := sha256.Sum256([]byte(e.GUID))
|
||||
titleSlug = fmt.Sprintf("%x", h[:8])
|
||||
}
|
||||
// Max 128 bytes total; ts is 17 bytes + 1 dash = 18.
|
||||
titleSlug = truncateUTF8(titleSlug, 128-18)
|
||||
return ts + "-" + titleSlug
|
||||
}
|
||||
|
||||
// truncateUTF8 truncates s to at most maxBytes bytes without splitting a rune.
|
||||
func truncateUTF8(s string, maxBytes int) string {
|
||||
if len(s) <= maxBytes {
|
||||
return s
|
||||
}
|
||||
b := []byte(s)
|
||||
// Walk back from maxBytes to find a valid rune boundary.
|
||||
for maxBytes > 0 && (b[maxBytes]&0xC0) == 0x80 {
|
||||
maxBytes--
|
||||
}
|
||||
return string(b[:maxBytes])
|
||||
}
|
||||
|
||||
// synthGUID synthesises a stable GUID when the feed provides none.
|
||||
func synthGUID(url, title string) string {
|
||||
h := sha256.Sum256([]byte(url + "\x00" + title))
|
||||
return fmt.Sprintf("synth:%x", h[:16])
|
||||
}
|
||||
Loading…
Reference in New Issue