Compare commits
63 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b4ff25fb91 | ||
|
|
6eca51dcab | ||
|
|
ffd88080ce | ||
|
|
9d789d8f1c | ||
|
|
e7ffe470c7 | ||
|
|
b9741559ab | ||
|
|
8e2d915b93 | ||
|
|
6865f8f2dc | ||
|
|
c7a6d89c25 | ||
|
|
277e173f95 | ||
|
|
c8eb8437aa | ||
|
|
72d22b2b3b | ||
|
|
cb6f31bfa5 | ||
|
|
5bd3261dc2 | ||
|
|
0c31d8c37a | ||
|
|
56f9d06435 | ||
|
|
408e0d7695 | ||
|
|
da3f333f98 | ||
|
|
254d5fdd9e | ||
|
|
6d26584d34 | ||
|
|
a7fd1e385e | ||
|
|
9c75e5a1e2 | ||
|
|
0b1475d938 | ||
|
|
c4c8660215 | ||
|
|
bf23afd8ac | ||
|
|
16fcb8852c | ||
|
|
30e3d5cd93 | ||
|
|
cfdb4e92f8 | ||
|
|
04dfc947a8 | ||
|
|
1706ba074f | ||
|
|
c810243106 | ||
|
|
160aa190e3 | ||
|
|
832042595e | ||
|
|
cd968b7a41 | ||
|
|
0822766698 | ||
|
|
8a363dc4be | ||
|
|
66056a9ee9 | ||
|
|
1d06634bb8 | ||
|
|
8c6cbc98fd | ||
|
|
b8d8558977 | ||
|
|
de3f278132 | ||
|
|
0dce812f8a | ||
|
|
b3509b8db3 | ||
|
|
9df19dc4e2 | ||
|
|
db0468b870 | ||
|
|
00a1e1411a | ||
|
|
c51c003d3a | ||
|
|
d63c941421 | ||
|
|
cb1c1848c4 | ||
|
|
3822d78687 | ||
|
|
946ce60586 | ||
|
|
74dd9ad140 | ||
|
|
95f76a8269 | ||
|
|
180592d391 | ||
|
|
b4b3766d15 | ||
|
|
986f6eea03 | ||
|
|
a11aab28b0 | ||
|
|
d75147073f | ||
|
|
66419e0fc0 | ||
|
|
720f5e5288 | ||
|
|
8650e86feb | ||
|
|
ef025f4472 | ||
|
|
0c87fa3021 |
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
||||
<http://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
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
141
README.md
141
README.md
@@ -1,19 +1,22 @@
|
||||
# TinyTinyRSS Fever API plugin
|
||||
# Tiny Tiny RSS Fever API Plugin
|
||||
|
||||
## Description
|
||||
|
||||
This plugin is an open source module for TinyTinyRSS which simulates the Fever API for reading the RSS Feeds with your Fever clients.
|
||||
This is an open source plugin for Tiny Tiny RSS which simulates the Fever API. This allows Fever compatible RSS clients to use Tiny Tiny RSS.
|
||||
|
||||
See also: [Fever API](fever-api.md)
|
||||
|
||||
- - -
|
||||
|
||||
* <a href="#features">Features</a>
|
||||
* <a href="#download">Downloads</a>
|
||||
* <a href="#supported">Supported/Tested Clients</a>
|
||||
* <a href="#supported">Supported / Tested Clients</a>
|
||||
* <a href="#installation">Installation</a>
|
||||
* <a href="#upgrading">Upgrading</a>
|
||||
* <a href="#debug">Debugging</a>
|
||||
* <a href="#error">Error reporting</a>
|
||||
* <a href="#error">Error Reporting</a>
|
||||
* <a href="#license">License</a>
|
||||
* <a href="#changelog">Changelog</a>
|
||||
* <a href="#changelog">Change Log</a>
|
||||
|
||||
## <a name="features">Features</a>
|
||||
|
||||
@@ -23,76 +26,148 @@ Following Features are implemented:
|
||||
* getting starred RSS items
|
||||
* setting read marker for item(s)
|
||||
* setting starred marker for item(s)
|
||||
* hot is **not** supported
|
||||
* hot links
|
||||
|
||||
## <a name="downloads">Downloads</a>
|
||||
Like Tiny Tiny RSS, the Fever API plugin is a rolling release model and there are no periodic updates. You should use git to clone the repository to install the plugin. If you must manually download a snapshot of the master branch, you can click the [`Download ZIP`](https://github.com/DigitalDJ/tinytinyrss-fever-plugin/archive/master.zip) button.
|
||||
|
||||
Please click the ```ZIP``` Button to download current version. ;)
|
||||
## <a name="supported">Supported / Tested Clients</a>
|
||||
|
||||
## <a name="supported">Supported/Tested Clients</a>
|
||||
These clients should work with Fever API emulation.
|
||||
|
||||
These clients should be working fine with this API emulation.
|
||||
|
||||
* Reeder - iPhone
|
||||
* Mr.Reader - iPad
|
||||
* [Reeder](http://reederapp.com) - iPhone
|
||||
* [Mr.Reader](https://www.curioustimes.de/mrreader/index.html) - iPad
|
||||
* [ReadKit](http://readkitapp.com) - OS X
|
||||
* [Press](https://play.google.com/store/apps/details?id=com.twentyfivesquares.press) - Android
|
||||
* [Meltdown](https://github.com/phubbard/Meltdown) - Android
|
||||
* displays feeds as 'orphan' items, but runs fine
|
||||
|
||||
## <a name="installation">Installation</a>
|
||||
|
||||
Upload the ```fever``` folder in the ```plugins``` folder of your TinyTinyRSS installation. Enable the plugin in the preferences and set your password for the Fever API.
|
||||
**IMPORTANT** You must enable the option `Enable API access` in your Tiny Tiny RSS preferences, for every user that wants to use the Fever plugin.
|
||||
|
||||
See [here](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) for more detailed informations.
|
||||
Clone this repository to your `plugins.local` folder of your Tiny Tiny RSS installation.
|
||||
|
||||
```
|
||||
$ cd tt-rss/plugins.local
|
||||
$ git clone https://github.com/DigitalDJ/tinytinyrss-fever-plugin fever
|
||||
```
|
||||
|
||||
Enable the `fever` plugin in the Tiny Tiny RSS Preferences and reload.
|
||||
|
||||
A `Fever Emulation` accordion pane should appear in your Tiny Tiny RSS preferences that will allow you to set a password for the Fever API. This is the password you will use to login to your Fever client, and should be different to your Tiny Tiny RSS login password.
|
||||
|
||||
**IMPORTANT** The Fever API uses insecure unsalted MD5 hash. You should choose a disposable application-specific password and consider the use of HTTPS with your Tiny Tiny RSS installation. [Let's Encrypt](https://letsencrypt.org/) is an excellent resource to setup free SSL certificates for your HTTP server.
|
||||
|
||||
Once the password is saved, you may login to your Fever client using your Tiny Tiny RSS username, the password you set in the previous step and the following server / endpoint URL:
|
||||
|
||||
```
|
||||
https://example.com/tt-rss/plugins.local/fever/
|
||||
```
|
||||
|
||||
See the [archived forum post](https://tt-rss.org/forum/viewtopic.php?f=22&t=1981) for more detailed and outdated information.
|
||||
|
||||
## <a name="upgrading">Upgrading</a>
|
||||
|
||||
Upgrading the Fever plugin follows the same steps as your Tiny Tiny RSS installation:
|
||||
|
||||
```
|
||||
$ cd tt-rss/plugins.local
|
||||
$ git pull origin master
|
||||
```
|
||||
|
||||
## <a name="debug">Debugging</a>
|
||||
|
||||
In the file ```fever_api.php``` there are two flags for debugging at the beginning of the file.
|
||||
|
||||
* ```DEBUG``` - set this to true to get a fever_debug.txt file in your root folder of the Tiny Tiny RSS installation.
|
||||
* ```DEBUG_USER``` - set this to the id (from ttrss_users) of your user you would like to always authenticate on your Tiny Tiny RSS installation. The authentication process is then skipped and the api gets always authentication.
|
||||
* ```DEBUG_FILE``` - set this to a filename that suits you for debugging this plugin if you need to.
|
||||
* ```DEBUG``` - set this to `TRUE` to produce extra debugging output. The location of the log is dependent on your PHP `log_errors` and `error_log` configuration directives.
|
||||
* ```DEBUG_USER``` - set this to the ID (from `ttrss_users` database table) of your user you would like to force authenticate with. The authentication process is then skipped and the API is always authenticated using this ID.
|
||||
|
||||
## <a name="error">Error reporting</a>
|
||||
## <a name="error">Error Reporting</a>
|
||||
|
||||
When you find an error you may post it in the plugin [thread](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) or here on github.com in the ```Issues``` section.
|
||||
If you have problems with authentication after updating the plugin, try to re-enter the password in Tiny Tiny RSS Fever plugin and save it again.
|
||||
|
||||
Please include your debug log which should be cleaned up. Please remove your username, password and apikey before posting it.
|
||||
If you encounter any defects please [create an issue](https://github.com/DigitalDJ/tinytinyrss-fever-plugin/issues/new) on GitHub.
|
||||
|
||||
Please include any debug logs and any output from the Tiny Tiny RSS `Error Log` (located in Preferences > System).
|
||||
|
||||
**IMPORTANT** Ensure logs are sanitized by removing any usernames, passwords and API keys.
|
||||
|
||||
Also specify versions and variants of the software you are using:
|
||||
* Tiny Tiny RSS commit
|
||||
* PHP (and integration with your HTTP server, e.g. php-fpm)
|
||||
* Operating System (e.g. FreeBSD, Debian)
|
||||
* HTTP Server (e.g. Apache, nginx)
|
||||
* Database Server (e.g. MySQL, PostgreSQL)
|
||||
|
||||
## <a name="license">License</a>
|
||||
|
||||
Licensed under GNU GPL version 2 (<- I think this is okay for this plugin…)
|
||||
GPL-3.0
|
||||
|
||||
## <a name="changelog">Changelog</a>
|
||||
## <a name="changelog">Change Log</a>
|
||||
|
||||
v1.0-v1.2 - 2013/5/27 - DigitalDJ version
|
||||
v1.0-v1.2 - 2013/05/27
|
||||
|
||||
* see this [thread](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) in the TinyTinyRSS Forum
|
||||
* see this [thread](https://tt-rss.org/forum/viewtopic.php?f=22&t=1981) in the Tiny Tiny RSS Forum
|
||||
|
||||
v1.3 - 2013/6/27
|
||||
v1.3 - 2013/06/27
|
||||
|
||||
* fixed several bugs in json output from the plugin
|
||||
* added a small fix for Mr.Reader 2.0 so it can complete loading of all items (see [FAQ](http://www.curioustimes.de/mrreader/faq/))
|
||||
* added first Mr.Reader compatiblity without marking items read/starred
|
||||
* changed the field ```date_entered``` to ```updated``` for better reading experience
|
||||
* changed the field date_entered to updated for better reading experience
|
||||
|
||||
v1.4 - 2013/6/28
|
||||
v1.4 - 2013/06/28
|
||||
|
||||
* fixed authentication with Mr.Reader 2.0
|
||||
* fixed debugging options
|
||||
|
||||
v1.4.1 - 2013/6/28
|
||||
v1.4.1 - 2013/06/28
|
||||
|
||||
* removed password from debug log file
|
||||
|
||||
v1.4.2 - 2013/6/28
|
||||
v1.4.2 - 2013/06/28
|
||||
|
||||
* changed the ```DEBUG_USER``` evaluation a little bit for disabling authentication without DEBUG = true
|
||||
* changed the DEBUG_USER evaluation a little bit for disabling authentication without DEBUG = true
|
||||
|
||||
v1.4.3 - 2013/6/28
|
||||
v1.4.3 - 2013/06/28
|
||||
|
||||
* added ```DEBUG_FILE``` to debug configuration
|
||||
* added DEBUG_FILE to debug configuration
|
||||
* changed authentication call from Mr.Reader so that the reply is also uppercase, since the API-KEY comes in uppercase from clients
|
||||
* fixed debug output while authentication in Mr.Reader with displaying the email adress
|
||||
|
||||
v1.4.4 - 2013/6/28
|
||||
v1.4.4 - 2013/06/28
|
||||
|
||||
* updated the documentation
|
||||
* changed some in saving the generated API-KEY - now its generated like in the Fever API documentation
|
||||
|
||||
v1.4.5 - 2013/06/29
|
||||
|
||||
* fixed the cannot mark/star bug in Mr.Reader
|
||||
|
||||
v1.4.6 - 2014/01/15
|
||||
|
||||
* merged bigger pull request to get more Fever API RSS Readers to work
|
||||
|
||||
v1.4.7 - 2014/01/15
|
||||
|
||||
* added rewrite url function to module, since it was removed from Tiny Tiny RSS
|
||||
|
||||
v2.0 - 2017/05/16
|
||||
|
||||
* Fix ccache exceptions
|
||||
* Sync previously copied snipets with latest tt-rss source
|
||||
* General clean up / refactor
|
||||
* Replace clunky sanitization with what is provided by tt-rss
|
||||
* Use new Article class for enclosures
|
||||
|
||||
v2.1 - 2017/12/25
|
||||
|
||||
* Sync previously copied snipets with latest tt-rss source
|
||||
* Use PDO API for DB queries
|
||||
|
||||
v2.2 - 2018/01/22
|
||||
|
||||
* Fix finding config.php for obscure tt-rss installations
|
||||
* Use PDO query for saving passwords
|
||||
* Fix PHP5 only having single unserialize argument
|
||||
247
fever-api.md
Normal file
247
fever-api.md
Normal file
@@ -0,0 +1,247 @@
|
||||
# API Public Beta
|
||||
|
||||
## Information
|
||||
|
||||
Currently it is a copy of [http://www.feedafever.com/api](http://www.feedafever.com/api), but as a Markdown File.
|
||||
|
||||
At the end of this document there is some undocumented stuff from the API.
|
||||
|
||||
## Description
|
||||
|
||||
Fever 1.14 introduces the new Fever API. This API is in public beta and currently supports basic syncing and consuming of content. A subsequent update will allow for adding, editing and deleting feeds and groups. The API’s primary focus is maintaining a local cache of the data in a remote Fever installation.
|
||||
|
||||
I am [soliciting feedback](http://www.feedafever.com/contact) from interested developers and as such the beta API may expand to reflect that feedback. The current API is incomplete but stable. Existing features may be expanded on but will not be removed or modified. New features may be added.
|
||||
|
||||
I’ve created a simple [HTML widget](http://www.feedafever.com/gateway/public/api-widget.html.zip) that allows you to query the Fever API and view the response.
|
||||
|
||||
# Authentication
|
||||
|
||||
Without further ado, the Fever API endpoint URL looks like:
|
||||
|
||||
`http://yourdomain.com/fever/?api`
|
||||
|
||||
All requests must be authenticated with a `POST`ed `api_key`. The value of `api_key` should be the md5 checksum of the Fever accounts email address and password concatenated with a colon. An example of a valid value for `api_key` using PHP’s native `md5()` function:
|
||||
|
||||
```php
|
||||
$email = 'you@yourdomain.com';
|
||||
$pass = 'b3stp4s4wd3v4';
|
||||
$api_key = md5($email.':'.$pass);
|
||||
```
|
||||
|
||||
A user may specify that `https` be used to connect to their Fever installation for additional security but you should not assume that all Fever installations support `https`.
|
||||
|
||||
The default response is a JSON object containing two members:
|
||||
|
||||
* `api_version` contains the version of the API responding (positive integer)
|
||||
* `auth` whether the request was successfully authenticated (boolean integer)
|
||||
|
||||
The API can also return XML by passing `xml` as the optional value of the `api` argument like so:
|
||||
|
||||
`http://yourdomain.com/fever/?api=xml`
|
||||
|
||||
The top level XML element is named `response`.
|
||||
|
||||
The response to each successfully authenticated request will have `auth` set to `1` and include at least one additional member:
|
||||
|
||||
* `last_refreshed_on_time` contains the time of the most recently refreshed (not *updated*) feed (Unix timestamp/integer)
|
||||
|
||||
When reading from the Fever API you add arguments to the query string of the API endpoint URL. If you attempt to `POST` these arguments (and their optional values) Fever will not recognize the request.
|
||||
|
||||
## Groups
|
||||
|
||||
`http://yourdomain.com/fever/?api&groups`
|
||||
|
||||
A request with the groups argument will return two additional members:
|
||||
|
||||
* `groups` contains an array of `group` objects
|
||||
* `feeds_groups` contains an array of `feeds_group` objects
|
||||
|
||||
A `group` object has the following members:
|
||||
|
||||
* `id` (positive integer)
|
||||
* `title` (utf-8 string)
|
||||
|
||||
The `feeds_group` object is documented under “Feeds/Groups Relationships.”
|
||||
|
||||
The “Kindling” super group is not included in this response and is composed of all feeds with an `is_spark` equal to `0`. The “Sparks” super group is not included in this response and is composed of all feeds with an `is_spark` equal to `1`.
|
||||
|
||||
## Feeds
|
||||
|
||||
`http://yourdomain.com/fever/?api&feeds`
|
||||
|
||||
A request with the `feeds` argument will return two additional members:
|
||||
|
||||
* `feeds` contains an array of `group` objects
|
||||
* `feeds_groups` contains an array of `feeds_group` objects
|
||||
|
||||
A `feed` object has the following members:
|
||||
|
||||
* `id` (positive integer)
|
||||
* `favicon_id` (positive integer)
|
||||
* `title` (utf-8 string)
|
||||
* `url` (utf-8 string)
|
||||
* `site_url` (utf-8 string)
|
||||
* `is_spark` (boolean integer)
|
||||
* `last_updated_on_time` (Unix timestamp/integer)
|
||||
|
||||
The `feeds_group` object is documented under “Feeds/Groups Relationships.”
|
||||
|
||||
The “All Items” super feed is not included in this response and is composed of all items from all feeds that belong to a given group. For the “Kindling” super group and all user created groups the items should be limited to feeds with an `is_spark` equal to `0`. For the “Sparks” super group the items should be limited to feeds with an `is_spark` equal to `1`.
|
||||
|
||||
## Feeds/Groups Relationships
|
||||
|
||||
A request with either the `groups` or `feeds` arguments will return an additional member:
|
||||
|
||||
A `feeds_group` object has the following members:
|
||||
|
||||
* `group_id` (positive integer)
|
||||
* `feed_ids` (string/comma-separated list of positive integers)
|
||||
|
||||
## Favicons
|
||||
|
||||
`http://yourdomain.com/fever/?api&favicons`
|
||||
|
||||
A request with the `favicons` argument will return one additional member:
|
||||
|
||||
* `favicons` contains an array of `favicon` objects
|
||||
|
||||
A `favicon` object has the following members:
|
||||
|
||||
* `id` (positive integer)
|
||||
* `data` (base64 encoded image data; prefixed by image type)
|
||||
|
||||
An example `data` value:
|
||||
|
||||
`image/gif;base64,R0lGODlhAQABAIAAAObm5gAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==`
|
||||
|
||||
The `data` member of a `favicon` object can be used with the `data:` protocol to embed an image in CSS or HTML. A PHP/HTML example:
|
||||
|
||||
`echo '<img src="data:'.$favicon['data'].'">';`
|
||||
|
||||
## Items
|
||||
|
||||
`http://yourdomain.com/fever/?api&items`
|
||||
|
||||
A request with the `items` argument will return two additional members:
|
||||
|
||||
* `items` contains an array of item objects
|
||||
* `total_items` contains the total number of items stored in the database (added in API version 2)
|
||||
|
||||
An `item` object has the following members:
|
||||
|
||||
* `id` (positive integer)
|
||||
* `feed_id` (positive integer)
|
||||
* `title` (utf-8 string)
|
||||
* `author` (utf-8 string)
|
||||
* `html` (utf-8 string)
|
||||
* `url` (utf-8 string)
|
||||
* `is_saved` (boolean integer)
|
||||
* `is_read` (boolean integer)
|
||||
* `created_on_time` (Unix timestamp/integer)
|
||||
|
||||
Most servers won’t have enough memory allocated to PHP to dump all items at once. Three optional arguments control determine the items included in the response.
|
||||
|
||||
Use the `since_id` argument with the highest id of locally cached items to request 50 additional items. Repeat until the items array in the response is empty.
|
||||
|
||||
Use the `max_id` argument with the lowest id of locally cached items (or `0` initially) to request 50 previous items. Repeat until the items array in the response is empty. (added in API version 2)
|
||||
|
||||
Use the `with_ids` argument with a comma-separated list of item ids to request (a maximum of 50) specific items. (added in API version 2)
|
||||
|
||||
## Hot Links
|
||||
|
||||
`http://yourdomain.com/fever/?api&links`
|
||||
|
||||
A request with the `links` argument will return one additional member:
|
||||
|
||||
* `links` contains an array of `link` objects
|
||||
|
||||
A `link` object has the following members:
|
||||
|
||||
* `id` (positive integer)
|
||||
* `feed_id` (positive integer) only use when is_item equals 1
|
||||
* `item_id` (positive integer) only use when is_item equals 1
|
||||
* `temperature` (positive float)
|
||||
* `is_item` (boolean integer)
|
||||
* `is_local` (boolean integer) used to determine if the source feed and favicon should be displayed
|
||||
* `is_saved` (boolean integer) only use when is_item equals 1
|
||||
* `title` (utf-8 string)
|
||||
* `url` (utf-8 string)
|
||||
* `item_ids` (string/comma-separated list of positive integers)
|
||||
|
||||
When requesting hot links you can control the range and offset by specifying a length of days for each as well as a page to fetch additional hot links. A request with just the `links` argument is equivalent to:
|
||||
|
||||
`http://yourdomain.com/fever/?api&links&offset=0&range=7&page=1`
|
||||
|
||||
Or the first page (`page=1`) of Hot links for the past week (`range=7`) starting now (`offset=0`).
|
||||
|
||||
# Link Caveats
|
||||
|
||||
Fever calculates Hot link temperatures in real-time. The API assumes you have an up-to-date local cache of items, feeds and favicons with which to construct a meaningful Hot view. Because they are ephemeral Hot links should not be cached in the same relational manner as items, feeds, groups and favicons.
|
||||
|
||||
Because Fever saves items and not individual links you can only "save" a Hot link when `is_item` equals `1`.
|
||||
|
||||
The `unread_item_ids` and `saved_item_ids` arguments can be used to keep your local cache synced with the remote Fever installation.
|
||||
|
||||
`http://yourdomain.com/fever/?api&unread_item_ids`
|
||||
|
||||
A request with the `unread_item_ids` argument will return one additional member:
|
||||
|
||||
* `unread_item_ids` (string/comma-separated list of positive integers)
|
||||
|
||||
`http://yourdomain.com/fever/?api&saved_item_ids`
|
||||
|
||||
A request with the `saved_item_ids` argument will return one additional member:
|
||||
|
||||
* saved_item_ids (string/comma-separated list of positive integers)
|
||||
|
||||
One of these members will be returned as appropriate when marking an item as read, unread, saved, or unsaved and when marking a feed or group as read.
|
||||
|
||||
Because groups and feeds will be limited in number compared to items, they should be synced by comparing an array of locally cached feed or group ids to an array of feed or group ids returned by their respective API request.
|
||||
|
||||
# Write
|
||||
|
||||
The public beta of the API does not provide a way to add, edit or delete feeds or groups but you can mark items, feeds and groups as read and save or unsave items. You can also unread recently read items. When writing to the Fever API you add arguments to the POST data you submit to the API endpoint URL.
|
||||
|
||||
Adding `unread_recently_read=1` to your POST data will mark recently read items as unread.
|
||||
|
||||
You can update an individual item by adding the following three arguments to your POST data:
|
||||
|
||||
* `mark=item`
|
||||
* `as=?` where `?` is replaced with `read`, `saved` or `unsaved`
|
||||
* `id=?` where `?` is replaced with the `id` of the item to modify
|
||||
|
||||
Marking a feed or group as read is similar but requires one additional argument to prevent marking new, unreceived items as read:
|
||||
|
||||
* `mark=?` where `?` is replaced with `feed` or `group`
|
||||
* `as=read`
|
||||
* `id=?` where `?` is replaced with the id of the feed or group to modify
|
||||
* `before=?` where `?` is replaced with the Unix timestamp of the the local client’s most recent `items` API request
|
||||
|
||||
You can mark the “Kindling” super group (and the “Sparks” super group) as read by adding the following four arguments to your POST data:
|
||||
|
||||
* `mark=group`
|
||||
* `as=read`
|
||||
* `id=0`
|
||||
* `before=?` where `?` is replaced with the Unix timestamp of the the local client’s last `items` API request
|
||||
|
||||
Similarly you can mark just the “Sparks” super group as read by adding the following four arguments to your POST data:
|
||||
|
||||
* `mark=group`
|
||||
* `as=read`
|
||||
* `id=-1`
|
||||
* `before=?` where `?` is replaced with the Unix timestamp of the the local client’s last `items` API request
|
||||
|
||||
# inoffical/undocumented API
|
||||
|
||||
This is the extension which represents some things which will be used from Mr.Reader App in iPad and are not documented as normal API, but allows it because the Fever API point is the same as the webpage requests.
|
||||
|
||||
## login
|
||||
|
||||
`http://yourdomain.com/fever/?action=login&username=[username]&password=[password]`
|
||||
|
||||
A request with the `action=login` argument will return a cookie `fever_auth`. This must be equal to the API key. This is a call which is created normally from the login dialog of the Fever webpage.
|
||||
|
||||
* `username` - the username for your login
|
||||
* `password` - the password you set for the api
|
||||
|
||||
As return a cookie named `fever_auth` will be set with the API key.
|
||||
@@ -1,753 +0,0 @@
|
||||
<?php
|
||||
|
||||
// v1.4.3
|
||||
|
||||
class FeverAPI extends Handler {
|
||||
|
||||
const API_LEVEL = 3;
|
||||
|
||||
const STATUS_OK = 1;
|
||||
const STATUS_ERR = 0;
|
||||
|
||||
// debugging only functions with JSON
|
||||
const DEBUG = false; // enable if you need some debug output in your tinytinyrss root
|
||||
const DEBUG_USER = 0; // your user id you need to debug - look it up in your mysql database and set it to a value bigger than 0
|
||||
const DEBUG_FILE = './debug_fever.txt'; // the file for debugging output
|
||||
|
||||
private $xml;
|
||||
|
||||
// always include api_version, status as 'auth'
|
||||
// output json/xml
|
||||
function wrap($status, $reply)
|
||||
{
|
||||
$arr = array("api_version" => self::API_LEVEL,
|
||||
"auth" => $status);
|
||||
|
||||
if ($status == self::STATUS_OK)
|
||||
{
|
||||
$arr["last_refreshed_on_time"] = $this->lastRefreshedOnTime()."";
|
||||
if (!empty($reply) && is_array($reply))
|
||||
$arr = array_merge($arr, $reply);
|
||||
}
|
||||
|
||||
if ($this->xml)
|
||||
{
|
||||
print $this->array_to_xml($arr);
|
||||
}
|
||||
else
|
||||
{
|
||||
print json_encode($arr);
|
||||
if (self::DEBUG) {
|
||||
// debug output
|
||||
file_put_contents(self::DEBUG_FILE,'answer : '.json_encode($arr)."\n",FILE_APPEND);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// fever supports xml wrapped in <response> tags
|
||||
private function array_to_xml($array, $container = 'response', $is_root = true)
|
||||
{
|
||||
if (!is_array($array)) return array_to_xml(array($array));
|
||||
|
||||
$xml = '';
|
||||
|
||||
if ($is_root)
|
||||
{
|
||||
$xml .= '<?xml version="1.0" encoding="utf-8"?>';
|
||||
$xml .= "<{$container}>";
|
||||
}
|
||||
|
||||
foreach($array as $key => $value)
|
||||
{
|
||||
// make sure key is a string
|
||||
$elem = $key;
|
||||
|
||||
if (!is_string($key) && !empty($container))
|
||||
{
|
||||
$elem = $container;
|
||||
}
|
||||
|
||||
$xml .= "<{$elem}>";
|
||||
|
||||
if (is_array($value))
|
||||
{
|
||||
if (array_keys($value) !== array_keys(array_keys($value)))
|
||||
{
|
||||
$xml .= array_to_xml($value, '', false);
|
||||
}
|
||||
else
|
||||
{
|
||||
$xml .= array_to_xml($value, r('/s$/', '', $elem), false);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$xml .= (htmlspecialchars($value, ENT_COMPAT, 'ISO-8859-1') != $value) ? "<![CDATA[{$value}]]>" : $value;
|
||||
}
|
||||
|
||||
$xml .= "</{$elem}>";
|
||||
}
|
||||
|
||||
if ($is_root)
|
||||
{
|
||||
$xml .= "</{$container}>";
|
||||
}
|
||||
|
||||
return preg_replace('/[\x00-\x1F\x7F]/', '', $xml);
|
||||
}
|
||||
|
||||
// every authenticated method includes last_refreshed_on_time
|
||||
private function lastRefreshedOnTime()
|
||||
{
|
||||
$result = $this->dbh->query("SELECT last_updated
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = " . $_SESSION["uid"] . "
|
||||
ORDER BY last_updated DESC");
|
||||
|
||||
if ($this->dbh->num_rows($result) > 0)
|
||||
{
|
||||
$last_refreshed_on_time = strtotime($this->dbh->fetch_result($result, 0, "last_updated"));
|
||||
}
|
||||
else
|
||||
{
|
||||
$last_refreshed_on_time = 0;
|
||||
}
|
||||
|
||||
return $last_refreshed_on_time;
|
||||
}
|
||||
|
||||
// find the user in the db with a particular api key
|
||||
private function setUser()
|
||||
{
|
||||
$apikey = isset($_REQUEST["api_key"])?$_REQUEST["api_key"]:'';
|
||||
// here comes Mr.Reader special API for logging in
|
||||
if ((strlen($apikey)==0)&&
|
||||
(isset($_REQUEST["action"]))&&
|
||||
($_REQUEST["action"]=='login')&&
|
||||
(isset($_REQUEST["email"]))&&
|
||||
(isset($_REQUEST["password"]))) {
|
||||
$email = $_REQUEST["email"];
|
||||
$password = $_REQUEST["password"];
|
||||
$apikey = strtoupper(md5($email.":".$password));
|
||||
setcookie('fever_auth',$apikey,time()+60*60*24*30);
|
||||
if (self::DEBUG) {
|
||||
// debug output
|
||||
$output = array();
|
||||
$output['email'] = $email;
|
||||
$output['apikey'] = $apikey;
|
||||
file_put_contents(self::DEBUG_FILE,'auth POST: '.json_encode($output)."\n",FILE_APPEND);
|
||||
}
|
||||
}
|
||||
if ((strlen($apikey)==0)&&isset($_REQUEST['fever_auth'])) { // override for Mr.Reader when doing some stuff
|
||||
$apikey = $_REQUEST['fever_auth'];
|
||||
}
|
||||
if (strlen($apikey)>0)
|
||||
{
|
||||
$result = $this->dbh->query("SELECT owner_uid
|
||||
FROM ttrss_plugin_storage
|
||||
WHERE content = '".db_escape_string('a:1:{s:8:"password";s:32:"'.strtolower($apikey).'";}') . "'");
|
||||
|
||||
if ($this->dbh->num_rows($result) > 0)
|
||||
{
|
||||
$_SESSION["uid"] = $this->dbh->fetch_result($result, 0, "owner_uid");
|
||||
}
|
||||
|
||||
if (self::DEBUG_USER>0) {
|
||||
$_SESSION["uid"] = self::DEBUG_USER; // always authenticate and set debug user
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// set whether xml or json
|
||||
private function setXml()
|
||||
{
|
||||
$this->xml = false;
|
||||
if (isset($_REQUEST["api"]))
|
||||
{
|
||||
if (strtolower($_REQUEST["api"]) == "xml")
|
||||
$this->xml = true;
|
||||
}
|
||||
}
|
||||
|
||||
private function flattenGroups(&$groupsToGroups, &$groups, &$groupsToTitle, $index)
|
||||
{
|
||||
foreach ($groupsToGroups[$index] as $item)
|
||||
{
|
||||
$id = substr($item, strpos($item, "-") + 1);
|
||||
array_push($groups, array("id" => intval($id), "title" => $groupsToTitle[$id]));
|
||||
if (isset($groupsToGroups[$id]))
|
||||
$this->flattenGroups($groupsToGroups, $groups, $groupsToTitle, $id);
|
||||
}
|
||||
}
|
||||
|
||||
function getGroups()
|
||||
{
|
||||
// TODO: ordering of child categories etc
|
||||
$groups = array();
|
||||
|
||||
$result = $this->dbh->query("SELECT id, title, parent_cat
|
||||
FROM ttrss_feed_categories
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
|
||||
ORDER BY order_id ASC");
|
||||
|
||||
$groupsToGroups = array();
|
||||
$groupsToTitle = array();
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
if ($line["parent_cat"] === NULL)
|
||||
{
|
||||
if (!isset($groupsToGroups[-1]))
|
||||
{
|
||||
$groupsToGroups[-1] = array();
|
||||
}
|
||||
|
||||
array_push($groupsToGroups[-1], $line["order_id"] . "-" . $line["id"]);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!isset($groupsToGroups[$line["parent_cat"]]))
|
||||
{
|
||||
$groupsToGroups[$line["parent_cat"]] = array();
|
||||
}
|
||||
|
||||
array_push($groupsToGroups[$line["parent_cat"]], $line["order_id"] . "-" . $line["id"]);
|
||||
}
|
||||
|
||||
$groupsToTitle[$line["id"]] = $line["title"];
|
||||
}
|
||||
|
||||
foreach ($groupsToGroups as $key => $value)
|
||||
{
|
||||
sort($value);
|
||||
}
|
||||
|
||||
if (isset($groupsToGroups[-1]))
|
||||
$this->flattenGroups($groupsToGroups, $groups, $groupsToTitle, -1);
|
||||
|
||||
return $groups;
|
||||
}
|
||||
|
||||
function getFeeds()
|
||||
{
|
||||
$feeds = array();
|
||||
|
||||
$result = $this->dbh->query("SELECT id, title, feed_url, site_url, last_updated
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
|
||||
ORDER BY order_id ASC");
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
array_push($feeds, array("id" => intval($line["id"]),
|
||||
"favicon_id" => intval($line["id"]),
|
||||
"title" => $line["title"],
|
||||
"url" => $line["feed_url"],
|
||||
"site_url" => $line["site_url"],
|
||||
"is_spark" => 0, // unsported
|
||||
"last_updated_on_time" => strtotime($line["last_updated"])
|
||||
));
|
||||
}
|
||||
return $feeds;
|
||||
}
|
||||
|
||||
function getFavicons()
|
||||
{
|
||||
$favicons = array();
|
||||
|
||||
$result = $this->dbh->query("SELECT id
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
|
||||
ORDER BY order_id ASC");
|
||||
|
||||
// data = "image/gif;base64,<base64 encoded image>
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
$filename = "feed-icons/" . $line["id"] . ".ico";
|
||||
if (file_exists($filename))
|
||||
{
|
||||
array_push($favicons, array("id" => intval($line["id"]),
|
||||
"data" => image_type_to_mime_type(exif_imagetype($filename)) . ";base64," . base64_encode(file_get_contents($filename))
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
return $favicons;
|
||||
}
|
||||
|
||||
function getLinks()
|
||||
{
|
||||
// TODO: is there a 'hot links' alternative in ttrss?
|
||||
// use ttrss_user_entries / score>0
|
||||
$links = array();
|
||||
|
||||
return $links;
|
||||
}
|
||||
|
||||
function getItems()
|
||||
{
|
||||
// items from specific groups, feeds
|
||||
$items = array();
|
||||
|
||||
$item_limit = 50;
|
||||
$where = " owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND ref_id = id ";
|
||||
|
||||
if (isset($_REQUEST["feed_ids"]) || isset($_REQUEST["group_ids"])) // added 0.3
|
||||
{
|
||||
$feed_ids = array();
|
||||
if (isset($_REQUEST["feed_ids"]))
|
||||
{
|
||||
$feed_ids = explode(",", $_REQUEST["feed_ids"]);
|
||||
}
|
||||
if (isset($_REQUEST["group_ids"]))
|
||||
{
|
||||
$group_ids = explode(",", $_REQUEST["group_ids"]);
|
||||
$num_group_ids = sizeof($group_ids);
|
||||
$groups_query = " AND cat_id IN (";
|
||||
foreach ($group_ids as $group_id)
|
||||
{
|
||||
if (is_numeric($group_id))
|
||||
$groups_query .= db_escape_string(intval($group_id)) . ",";
|
||||
else
|
||||
$num_group_ids--;
|
||||
}
|
||||
if ($num_group_ids <= 0)
|
||||
$groups_query = " AND cat_id IN ('') ";
|
||||
else
|
||||
$groups_query = trim($groups_query, ",") . ")";
|
||||
|
||||
$feeds_in_group_result = $this->dbh->query("SELECT id
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' " . $groups_query);
|
||||
|
||||
$group_feed_ids = array();
|
||||
while ($line = $this->dbh->fetch_assoc($feeds_in_group_result))
|
||||
{
|
||||
array_push($group_feed_ids, $line["id"]);
|
||||
}
|
||||
|
||||
$feed_ids = array_unique(array_merge($feed_ids, $group_feed_ids));
|
||||
}
|
||||
|
||||
$query = " feed_id IN (";
|
||||
$num_feed_ids = sizeof($feed_ids);
|
||||
foreach ($feed_ids as $feed_id)
|
||||
{
|
||||
if (is_numeric($feed_id))
|
||||
$query.= db_escape_string(intval($feed_id)) . ",";
|
||||
else
|
||||
$num_feed_ids--;
|
||||
}
|
||||
|
||||
if ($num_feed_ids <= 0)
|
||||
$query = " feed_id IN ('') ";
|
||||
else
|
||||
$query = trim($query, ",") . ")";
|
||||
|
||||
if (!empty($where)) $where .= " AND ";
|
||||
$where .= $query;
|
||||
}
|
||||
|
||||
if (isset($_REQUEST["max_id"])) // descending from most recently added
|
||||
{
|
||||
// use the max_id argument to request the previous $item_limit items
|
||||
if (is_numeric($_REQUEST["max_id"]))
|
||||
{
|
||||
$max_id = ($_REQUEST["max_id"] > 0) ? intval($_REQUEST["max_id"]) : 0;
|
||||
if ($max_id)
|
||||
{
|
||||
if (!empty($where)) $where .= " AND ";
|
||||
$where .= "id < " . db_escape_string($max_id) . " ";
|
||||
}
|
||||
else if (empty($where))
|
||||
{
|
||||
$where .= "1";
|
||||
}
|
||||
|
||||
$where .= " ORDER BY id DESC";
|
||||
}
|
||||
}
|
||||
else if (isset($_REQUEST["with_ids"])) // selective
|
||||
{
|
||||
if (!empty($where)) $where .= " AND "; // group_ids & feed_ids don't make sense with this query but just in case
|
||||
|
||||
$item_ids = explode(",", $_REQUEST["with_ids"]);
|
||||
$query = "id IN (";
|
||||
$num_ids = sizeof($item_ids);
|
||||
foreach ($item_ids as $item_id)
|
||||
{
|
||||
if (is_numeric($item_id))
|
||||
$query .= db_escape_string(intval($item_id)) . ",";
|
||||
else
|
||||
$num_ids--;
|
||||
}
|
||||
|
||||
if ($num_ids <= 0)
|
||||
$query = "id IN ('') ";
|
||||
else
|
||||
$query = trim($query, ",") . ") ";
|
||||
|
||||
$where .= $query;
|
||||
}
|
||||
else // ascending from first added
|
||||
{
|
||||
if (is_numeric($_REQUEST["since_id"]))
|
||||
{
|
||||
// use the since_id argument to request the next $item_limit items
|
||||
$since_id = isset($_GET["since_id"]) ? intval($_GET["since_id"]) : 0;
|
||||
|
||||
if ($since_id)
|
||||
{
|
||||
if (!empty($where)) $where .= " AND ";
|
||||
//$where .= "id > " . db_escape_string($since_id) . " ";
|
||||
$where .= "id > " . db_escape_string($since_id*1000) . " "; // NASTY hack for Mr. Reader 2.0 on iOS and TinyTiny RSS Fever
|
||||
}
|
||||
else if (empty($where))
|
||||
{
|
||||
$where .= "1";
|
||||
}
|
||||
|
||||
$where .= " ORDER BY id ASC";
|
||||
}
|
||||
}
|
||||
|
||||
$where .= " LIMIT " . $item_limit;
|
||||
|
||||
// id, feed_id, title, author, html, url, is_saved, is_read, created_on_time
|
||||
$result = $this->dbh->query("SELECT ref_id, feed_id, title, link, content, id, marked, unread, author, updated
|
||||
FROM ttrss_entries, ttrss_user_entries
|
||||
WHERE " . $where);
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
array_push($items, array("id" => intval($line["id"]),
|
||||
"feed_id" => intval($line["feed_id"]),
|
||||
"title" => $line["title"],
|
||||
"author" => $line["author"],
|
||||
"html" => $line["content"],
|
||||
"url" => $line["link"],
|
||||
"is_saved" => (sql_bool_to_bool($line["marked"]) ? 1 : 0),
|
||||
"is_read" => ( (!sql_bool_to_bool($line["unread"])) ? 1 : 0),
|
||||
"created_on_time" => strtotime($line["updated"])
|
||||
));
|
||||
}
|
||||
|
||||
return $items;
|
||||
}
|
||||
|
||||
function getTotalItems()
|
||||
{
|
||||
// number of total items
|
||||
$total_items = 0;
|
||||
|
||||
$where = " owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'";
|
||||
$result = $this->dbh->query("SELECT COUNT(ref_id) as total_items
|
||||
FROM ttrss_user_entries
|
||||
WHERE " . $where);
|
||||
|
||||
if ($this->dbh->num_rows($result) > 0)
|
||||
{
|
||||
$total_items = $this->dbh->fetch_result($result, 0, "total_items");
|
||||
}
|
||||
|
||||
return $total_items;
|
||||
}
|
||||
|
||||
function getFeedsGroup()
|
||||
{
|
||||
$feeds_groups = array();
|
||||
|
||||
$result = $this->dbh->query("SELECT id, cat_id
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
|
||||
AND cat_id IS NOT NULL
|
||||
ORDER BY id ASC");
|
||||
|
||||
$groupsToFeeds = array();
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
if (!array_key_exists($line["cat_id"], $groupsToFeeds))
|
||||
$groupsToFeeds[$line["cat_id"]] = array();
|
||||
|
||||
array_push($groupsToFeeds[$line["cat_id"]], $line["id"]);
|
||||
}
|
||||
|
||||
foreach ($groupsToFeeds as $group => $feeds)
|
||||
{
|
||||
$feedsStr = "";
|
||||
foreach ($feeds as $feed)
|
||||
$feedsStr .= $feed . ",";
|
||||
$feedsStr = trim($feedsStr, ",");
|
||||
|
||||
array_push($feeds_groups, array("group_id" => $group,
|
||||
"feed_ids" => $feedsStr));
|
||||
}
|
||||
return $feeds_groups;
|
||||
}
|
||||
|
||||
function getUnreadItemIds()
|
||||
{
|
||||
$unreadItemIdsCSV = "";
|
||||
$result = $this->dbh->query("SELECT ref_id, unread
|
||||
FROM ttrss_user_entries
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'"); // ORDER BY red_id DESC
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
if (sql_bool_to_bool($line["unread"]))
|
||||
$unreadItemIdsCSV .= $line["ref_id"] . ",";
|
||||
}
|
||||
$unreadItemIdsCSV = trim($unreadItemIdsCSV, ",");
|
||||
|
||||
return $unreadItemIdsCSV;
|
||||
}
|
||||
|
||||
function getSavedItemIds()
|
||||
{
|
||||
$savedItemIdsCSV = "";
|
||||
$result = $this->dbh->query("SELECT ref_id, marked
|
||||
FROM ttrss_user_entries
|
||||
WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'");
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result))
|
||||
{
|
||||
if (sql_bool_to_bool($line["marked"]))
|
||||
$savedItemIdsCSV .= $line["ref_id"] . ",";
|
||||
}
|
||||
$savedItemIdsCSV = trim($savedItemIdsCSV, ",");
|
||||
|
||||
return $savedItemIdsCSV;
|
||||
}
|
||||
|
||||
function setItem($id, $field_raw, $mode, $before = 0)
|
||||
{
|
||||
$field = "";
|
||||
$set_to = "";
|
||||
|
||||
switch ($field_raw) {
|
||||
case 0:
|
||||
$field = "marked";
|
||||
$additional_fields = ",last_marked = NOW()";
|
||||
break;
|
||||
case 1:
|
||||
$field = "unread";
|
||||
$additional_fields = ",last_read = NOW()";
|
||||
break;
|
||||
};
|
||||
|
||||
switch ($mode) {
|
||||
case 1:
|
||||
$set_to = "true";
|
||||
break;
|
||||
case 0:
|
||||
$set_to = "false";
|
||||
break;
|
||||
}
|
||||
|
||||
if ($field && $set_to)
|
||||
{
|
||||
$article_ids = db_escape_string($id);
|
||||
|
||||
$result = $this->dbh->query("UPDATE ttrss_user_entries SET $field = $set_to $additional_fields WHERE ref_id IN ($article_ids) AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'");
|
||||
|
||||
$num_updated = $this->dbh->affected_rows($result);
|
||||
|
||||
if ($num_updated > 0 && $field == "unread") {
|
||||
$result = $this->dbh->query("SELECT DISTINCT feed_id FROM ttrss_user_entries
|
||||
WHERE ref_id IN ($article_ids)");
|
||||
|
||||
while ($line = $this->dbh->fetch_assoc($result)) {
|
||||
ccache_update($line["feed_id"], $_SESSION["uid"]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function setItemAsRead($id)
|
||||
{
|
||||
$this->setItem($id, 1, 0);
|
||||
}
|
||||
|
||||
function setItemAsUnread($id)
|
||||
{
|
||||
$this->setItem($id, 1, 1);
|
||||
}
|
||||
|
||||
function setItemAsSaved($id)
|
||||
{
|
||||
$this->setItem($id, 0, 1);
|
||||
}
|
||||
|
||||
function setItemAsUnsaved($id)
|
||||
{
|
||||
$this->setItem($id, 0, 0);
|
||||
}
|
||||
|
||||
function setFeed($id, $cat, $before=0)
|
||||
{
|
||||
// if before is zero, set it to now so feeds all items are read from before this point in time
|
||||
if ($before == 0)
|
||||
$before = time();
|
||||
|
||||
if (is_numeric($id))
|
||||
{
|
||||
// this is a category
|
||||
if ($cat)
|
||||
{
|
||||
// if not special feed
|
||||
if ($id > 0)
|
||||
{
|
||||
db_query("UPDATE ttrss_user_entries
|
||||
SET unread = false, last_read = NOW() WHERE ref_id IN
|
||||
(SELECT id FROM
|
||||
(SELECT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
|
||||
AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND unread = true AND feed_id IN
|
||||
(SELECT id FROM ttrss_feeds WHERE cat_id IN (" . intval($id) . ")) AND date_entered < '" . date("Y-m-d H:i:s", $before) . "' ) as tmp)");
|
||||
|
||||
}
|
||||
// this is "all" to fever, but internally "all" is -4
|
||||
else if ($id == 0)
|
||||
{
|
||||
$id = -4;
|
||||
db_query("UPDATE ttrss_user_entries
|
||||
SET unread = false, last_read = NOW() WHERE ref_id IN
|
||||
(SELECT id FROM
|
||||
(SELECT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
|
||||
AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND unread = true AND date_entered < '" . date("Y-m-d H:i:s", $before) . "' ) as tmp)");
|
||||
}
|
||||
}
|
||||
// not a category
|
||||
else if ($id > 0)
|
||||
{
|
||||
db_query("UPDATE ttrss_user_entries
|
||||
SET unread = false, last_read = NOW() WHERE ref_id IN
|
||||
(SELECT id FROM
|
||||
(SELECT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
|
||||
AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND unread = true AND feed_id = " . intval($id) . " AND date_entered < '" . date("Y-m-d H:i:s", $before) . "' ) as tmp)");
|
||||
|
||||
}
|
||||
ccache_update($id,$_SESSION["uid"], $cat);
|
||||
}
|
||||
}
|
||||
|
||||
function setFeedAsRead($id, $before)
|
||||
{
|
||||
$this->setFeed($id, false, $before);
|
||||
}
|
||||
|
||||
function setGroupAsRead($id, $before)
|
||||
{
|
||||
$this->setFeed($id, true, $before);
|
||||
}
|
||||
|
||||
// this does all the processing, since the fever api does not have a specific variable that specifies the operation
|
||||
function index()
|
||||
{
|
||||
$response_arr = array();
|
||||
|
||||
if (isset($_REQUEST["groups"]))
|
||||
{
|
||||
$response_arr["groups"] = $this->getGroups();
|
||||
$response_arr["feeds_groups"] = $this->getFeedsGroup();
|
||||
}
|
||||
if (isset($_REQUEST["feeds"]))
|
||||
{
|
||||
$response_arr["feeds"] = $this->getFeeds();
|
||||
$response_arr["feeds_groups"] = $this->getFeedsGroup();
|
||||
}
|
||||
// TODO: favicon support
|
||||
if (isset($_REQUEST["favicons"]))
|
||||
{
|
||||
$response_arr["favicons"] = $this->getFavicons();
|
||||
}
|
||||
if (isset($_REQUEST["items"]))
|
||||
{
|
||||
$response_arr["total_items"] = $this->getTotalItems();
|
||||
$response_arr["items"] = $this->getItems();
|
||||
}
|
||||
if (isset($_REQUEST["links"]))
|
||||
{
|
||||
$response_arr["links"] = $this->getLinks();
|
||||
}
|
||||
if (isset($_REQUEST["unread_item_ids"]))
|
||||
{
|
||||
$response_arr["unread_item_ids"] = $this->getUnreadItemIds();
|
||||
}
|
||||
if (isset($_REQUEST["saved_item_ids"]))
|
||||
{
|
||||
$response_arr["saved_item_ids"] = $this->getSavedItemIds();
|
||||
}
|
||||
|
||||
if (isset($_REQUEST["mark"], $_REQUEST["as"], $_REQUEST["id"]))
|
||||
{
|
||||
if (is_numeric($_REQUEST["id"]))
|
||||
{
|
||||
$before = (isset($_REQUEST["before"])) ? $_REQUEST["before"] : null;
|
||||
$method_name = "set" . ucfirst($_REQUEST["mark"]) . "As" . ucfirst($_REQUEST["as"]);
|
||||
|
||||
if (method_exists($this, $method_name))
|
||||
{
|
||||
$id = intval($_REQUEST["id"]);
|
||||
$this->{$method_name}($id, $before);
|
||||
switch($_REQUEST["as"])
|
||||
{
|
||||
case "read":
|
||||
case "unread":
|
||||
$response_arr["unread_item_ids"] = $this->getUnreadItemIds();
|
||||
break;
|
||||
|
||||
case 'saved':
|
||||
case 'unsaved':
|
||||
$response_arr["saved_item_ids"] = $this->getSavedItemIds();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($_SESSION["uid"])
|
||||
$this->wrap(self::STATUS_OK, $response_arr);
|
||||
else if (!$_SESSION["uid"])
|
||||
$this->wrap(self::STATUS_ERR, NULL);
|
||||
|
||||
}
|
||||
|
||||
// validate the api_key, user preferences
|
||||
function before($method) {
|
||||
if (parent::before($method)) {
|
||||
if (self::DEBUG) {
|
||||
// add request to debug log
|
||||
file_put_contents(self::DEBUG_FILE,'parameter: '.json_encode($_REQUEST)."\n",FILE_APPEND);
|
||||
}
|
||||
|
||||
// set the user from the db
|
||||
$this->setUser();
|
||||
|
||||
// are we xml or json?
|
||||
$this->setXml();
|
||||
|
||||
if ($this->xml)
|
||||
header("Content-Type: text/xml");
|
||||
else
|
||||
header("Content-Type: text/json");
|
||||
|
||||
// check we have a valid user
|
||||
if (!$_SESSION["uid"]) {
|
||||
$this->wrap(self::STATUS_ERR, NULL);
|
||||
return false;
|
||||
}
|
||||
|
||||
// check if user has api access enabled
|
||||
if ($_SESSION["uid"] && !get_pref('ENABLE_API_ACCESS')) {
|
||||
$this->wrap(self::STATUS_ERR, NULL);
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
@@ -1,52 +0,0 @@
|
||||
<?php
|
||||
|
||||
// do not support refresh command, this could take ages.
|
||||
if (isset($_REQUEST["refresh"]))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
|
||||
error_reporting(E_ERROR | E_PARSE);
|
||||
|
||||
require_once "../../config.php";
|
||||
|
||||
set_include_path(dirname(__FILE__) . PATH_SEPARATOR .
|
||||
dirname(dirname(dirname(__FILE__))) . PATH_SEPARATOR .
|
||||
dirname(dirname(dirname(__FILE__))) . "/include" . PATH_SEPARATOR .
|
||||
get_include_path());
|
||||
|
||||
chdir("../..");
|
||||
|
||||
define('NO_SESSION_AUTOSTART', true);
|
||||
|
||||
require_once "autoload.php";
|
||||
require_once "db.php";
|
||||
require_once "db-prefs.php";
|
||||
require_once "functions.php";
|
||||
require_once "fever_api.php";
|
||||
|
||||
define('AUTH_DISABLE_OTP', true);
|
||||
|
||||
if (defined('ENABLE_GZIP_OUTPUT') && ENABLE_GZIP_OUTPUT &&
|
||||
function_exists("ob_gzhandler")) {
|
||||
|
||||
ob_start("ob_gzhandler");
|
||||
} else {
|
||||
ob_start();
|
||||
}
|
||||
|
||||
if (!init_plugins()) return;
|
||||
|
||||
$handler = new FeverAPI(Db::get(), $_REQUEST);
|
||||
|
||||
if ($handler->before($method)) {
|
||||
if (method_exists($handler, 'index')) {
|
||||
$handler->index($method);
|
||||
}
|
||||
$handler->after();
|
||||
}
|
||||
|
||||
ob_end_flush();
|
||||
|
||||
?>
|
||||
@@ -1,88 +0,0 @@
|
||||
<?php
|
||||
|
||||
class Fever extends Plugin {
|
||||
private $host;
|
||||
|
||||
function about() {
|
||||
return array(1.2,
|
||||
"Emulates the Fever API for Tiny Tiny RSS",
|
||||
"digitaldj & murphy");
|
||||
}
|
||||
|
||||
function init($host) {
|
||||
$this->host = $host;
|
||||
$host->add_hook($host::HOOK_PREFS_TAB, $this);
|
||||
}
|
||||
|
||||
function before($method) {
|
||||
return true;
|
||||
}
|
||||
|
||||
function csrf_ignore($method) {
|
||||
return true;
|
||||
}
|
||||
|
||||
function hook_prefs_tab($args) {
|
||||
if ($args != "prefPrefs") return;
|
||||
|
||||
print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"" . __("Fever Emulation") . "\">";
|
||||
|
||||
print "<h3>" . __("Fever Emulation") . "</h3>";
|
||||
|
||||
print "<p>" . __("Since the Fever API uses a different authentication mechanism to Tiny Tiny RSS, you must set a separate password to login. This password may be the same as your Tiny Tiny RSS password.") . "</p>";
|
||||
|
||||
print "<p>" . __("Set a password to login with Fever:") . "</p>";
|
||||
|
||||
print "<form dojoType=\"dijit.form.Form\">";
|
||||
|
||||
print "<script type=\"dojo/method\" event=\"onSubmit\" args=\"evt\">
|
||||
evt.preventDefault();
|
||||
if (this.validate()) {
|
||||
new Ajax.Request('backend.php', {
|
||||
parameters: dojo.objectToQuery(this.getValues()),
|
||||
onComplete: function(transport) {
|
||||
notify_info(transport.responseText);
|
||||
}
|
||||
});
|
||||
//this.reset();
|
||||
}
|
||||
</script>";
|
||||
print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"op\" value=\"pluginhandler\" />";
|
||||
print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"method\" value=\"save\" />";
|
||||
print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"plugin\" value=\"fever\" />";
|
||||
print "<input dojoType=\"dijit.form.ValidationTextBox\" required=\"1\" type=\"password\" name=\"password\" />";
|
||||
print "<button dojoType=\"dijit.form.Button\" type=\"submit\">" . __("Set Password") . "</button>";
|
||||
print "</form>";
|
||||
|
||||
print "<p>" . __("To login with the Fever API, set your server details in your favourite RSS application to: ") . ($_SERVER["HTTPS"] == "on" ? "https://" : "http://") . dirname($_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"]) . "/plugins/fever/" . "</p>";
|
||||
print "<p>" . __("Additional details can be found at ") . "<a href=\"http://www.feedafever.com/api\" target=\"_blank\">http://www.feedafever.com/api</a></p>";
|
||||
|
||||
print "<p>" . __("Note: Due to the limitations of the API and some RSS clients (for example, Reeder on iOS), some features are unavailable: \"Special\" Feeds (Published / Tags / Labels / Fresh / Recent), Nested Categories (hierarchy is flattened)") . "</p>";
|
||||
|
||||
print "</div>";
|
||||
}
|
||||
|
||||
function save()
|
||||
{
|
||||
if (isset($_POST["password"]) && isset($_SESSION["uid"]))
|
||||
{
|
||||
$result = db_query("SELECT login FROM ttrss_users WHERE id = '" . db_escape_string($_SESSION["uid"]) . "'");
|
||||
if ($line = db_fetch_assoc($result))
|
||||
{
|
||||
$password = md5($line["login"] . ":" . $_POST["password"]);
|
||||
$this->host->set($this, "password", $password);
|
||||
echo __("Password saved.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function after() {
|
||||
|
||||
}
|
||||
|
||||
function api_version() {
|
||||
return 2;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
954
fever_api.php
Normal file
954
fever_api.php
Normal file
@@ -0,0 +1,954 @@
|
||||
<?php
|
||||
class FeverAPI extends Handler {
|
||||
|
||||
const API_LEVEL = 3;
|
||||
|
||||
const STATUS_OK = 1;
|
||||
const STATUS_ERR = 0;
|
||||
|
||||
// enable if you need some debug output in your tinytinyrss root
|
||||
const DEBUG = FALSE;
|
||||
// your user id you need to debug - look it up in your mysql database and set it to a value bigger than 0
|
||||
const DEBUG_USER = 0;
|
||||
|
||||
const PLUGIN_NAME = "Fever";
|
||||
|
||||
private $id_hack = FALSE;
|
||||
|
||||
// add link in bottom for attached files
|
||||
private $add_attached_files = TRUE;
|
||||
|
||||
// output as xml or json
|
||||
private $xml;
|
||||
|
||||
// find the user in the db with a particular api key
|
||||
private function setUser()
|
||||
{
|
||||
$apikey = isset($_REQUEST["api_key"]) ? clean($_REQUEST["api_key"]) : "";
|
||||
|
||||
// Login for Mr. Reader
|
||||
if (strlen($apikey) <= 0 &&
|
||||
isset($_REQUEST["action"]) &&
|
||||
clean($_REQUEST["action"]) === "login" &&
|
||||
isset($_REQUEST["email"])&&
|
||||
isset($_REQUEST["password"]))
|
||||
{
|
||||
$email = $_REQUEST["email"];
|
||||
$password = $_REQUEST["password"];
|
||||
|
||||
$apikey = strtoupper(md5($email . ":" . $password));
|
||||
|
||||
setcookie("fever_auth", $apikey, time() + max(SESSION_COOKIE_LIFETIME, 60 * 60 * 24));
|
||||
}
|
||||
|
||||
// override for Mr.Reader when doing some stuff
|
||||
if (strlen($apikey) <= 0 && isset($_COOKIE["fever_auth"]))
|
||||
{
|
||||
$apikey = $_COOKIE['fever_auth'];
|
||||
}
|
||||
|
||||
if (strlen($apikey) > 0)
|
||||
{
|
||||
$sth = $this->pdo->prepare("SELECT owner_uid, content FROM ttrss_plugin_storage
|
||||
WHERE name = ?");
|
||||
$sth->execute([self::PLUGIN_NAME]);
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
$obj = unserialize($line["content"]);
|
||||
if ($obj &&
|
||||
isset($obj["password"]) &&
|
||||
strtolower($obj["password"]) === strtolower($apikey))
|
||||
{
|
||||
$_SESSION["uid"] = $line["owner_uid"];
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (self::DEBUG_USER > 0)
|
||||
{
|
||||
$_SESSION["uid"] = self::DEBUG_USER; // always authenticate and set debug user
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// set whether xml or json
|
||||
private function setXml()
|
||||
{
|
||||
$this->xml = false;
|
||||
if (isset($_REQUEST["api"]))
|
||||
{
|
||||
if (strtolower(clean($_REQUEST["api"])) === "xml")
|
||||
{
|
||||
$this->xml = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private function setIdHack()
|
||||
{
|
||||
$this->id_hack = false;
|
||||
|
||||
$user_agent = false;
|
||||
if (isset($_SERVER["HTTP_USER_AGENT"]))
|
||||
{
|
||||
$user_agent = $_SERVER["HTTP_USER_AGENT"];
|
||||
}
|
||||
|
||||
// Check for all client in Android except ReadKit in Mac, Mr. Reader and Dalvik
|
||||
if ($user_agent &&
|
||||
(strpos($user_agent, "Dalvik") !== FALSE ||
|
||||
strpos($user_agent, "ReadKit") !== FALSE ||
|
||||
strpos($user_agent, "Mr. Reader") !== FALSE))
|
||||
{
|
||||
$this->id_hack = true;
|
||||
}
|
||||
}
|
||||
|
||||
// validate the api_key, user preferences
|
||||
function before($method) {
|
||||
/* classes/api.php before */
|
||||
|
||||
if (parent::before($method)) {
|
||||
if (self::DEBUG) {
|
||||
// add request to debug log
|
||||
error_log(print_r($_REQUEST, true));
|
||||
}
|
||||
|
||||
// set the user from the db
|
||||
$this->setUser();
|
||||
|
||||
// are we xml or json?
|
||||
$this->setXml();
|
||||
|
||||
// do we need to apply the ID hack
|
||||
$this->setIdHack();
|
||||
|
||||
if ($this->xml)
|
||||
header("Content-Type: text/xml");
|
||||
else
|
||||
header("Content-Type: text/json");
|
||||
|
||||
// check we have a valid user
|
||||
if (!$_SESSION["uid"]) {
|
||||
$this->wrap(self::STATUS_ERR, array("error" => 'NOT_LOGGED_IN'));
|
||||
return false;
|
||||
}
|
||||
|
||||
// check if user has api access enabled
|
||||
if ($_SESSION["uid"] && !get_pref('ENABLE_API_ACCESS')) {
|
||||
$this->wrap(self::STATUS_ERR, array("error" => 'API_DISABLED'));
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// always include api_version, status as 'auth'
|
||||
// output json/xml
|
||||
function wrap($status, $reply)
|
||||
{
|
||||
/* classes/api.php wrap */
|
||||
$arr = array("api_version" => self::API_LEVEL,
|
||||
"auth" => $status);
|
||||
|
||||
if (!empty($reply) && is_array($reply))
|
||||
{
|
||||
$arr = array_merge($arr, $reply);
|
||||
}
|
||||
|
||||
if ($status == self::STATUS_OK)
|
||||
{
|
||||
$arr["last_refreshed_on_time"] = (string)$this->lastRefreshedOnTime();
|
||||
}
|
||||
|
||||
$resp = "";
|
||||
if ($this->xml)
|
||||
{
|
||||
$resp = $this->array_to_xml($arr);
|
||||
}
|
||||
else
|
||||
{
|
||||
$resp = json_encode($arr);
|
||||
}
|
||||
|
||||
print $resp;
|
||||
|
||||
if (self::DEBUG)
|
||||
{
|
||||
// debug output
|
||||
error_log(print_r($resp, true));
|
||||
}
|
||||
}
|
||||
|
||||
// fever supports xml wrapped in <response> tags
|
||||
// TODO: holy crap replace this junk
|
||||
private function array_to_xml($array, $container = 'response', $is_root = true)
|
||||
{
|
||||
if (!is_array($array)) return array_to_xml(array($array));
|
||||
|
||||
$xml = '';
|
||||
|
||||
if ($is_root)
|
||||
{
|
||||
$xml .= '<?xml version="1.0" encoding="utf-8"?>';
|
||||
$xml .= "<{$container}>";
|
||||
}
|
||||
|
||||
foreach($array as $key => $value)
|
||||
{
|
||||
// make sure key is a string
|
||||
$elem = $key;
|
||||
|
||||
if (!is_string($key) && !empty($container))
|
||||
{
|
||||
$elem = $container;
|
||||
}
|
||||
|
||||
$xml .= "<{$elem}>";
|
||||
|
||||
if (is_array($value))
|
||||
{
|
||||
if (array_keys($value) !== array_keys(array_keys($value)))
|
||||
{
|
||||
$xml .= array_to_xml($value, '', false);
|
||||
}
|
||||
else
|
||||
{
|
||||
$xml .= array_to_xml($value, r('/s$/', '', $elem), false);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$xml .= (htmlspecialchars($value, ENT_COMPAT, 'ISO-8859-1') != $value) ? "<![CDATA[{$value}]]>" : $value;
|
||||
}
|
||||
|
||||
$xml .= "</{$elem}>";
|
||||
}
|
||||
|
||||
if ($is_root)
|
||||
{
|
||||
$xml .= "</{$container}>";
|
||||
}
|
||||
|
||||
return preg_replace('/[\x00-\x1F\x7F]/', '', $xml);
|
||||
}
|
||||
|
||||
// every authenticated method includes last_refreshed_on_time
|
||||
private function lastRefreshedOnTime()
|
||||
{
|
||||
$sth = $this->pdo->prepare("SELECT " . SUBSTRING_FOR_DATE . "(last_updated,1,19) AS last_updated
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = ?
|
||||
ORDER BY last_updated DESC");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
if ($row = $sth->fetch())
|
||||
{
|
||||
$last_refreshed_on_time = (int) strtotime($row["last_updated"]);
|
||||
}
|
||||
else
|
||||
{
|
||||
$last_refreshed_on_time = 0;
|
||||
}
|
||||
|
||||
return $last_refreshed_on_time;
|
||||
}
|
||||
|
||||
private function flattenGroups(&$groupsToGroups, &$groups, &$groupsToTitle, $index)
|
||||
{
|
||||
foreach ($groupsToGroups[$index] as $item)
|
||||
{
|
||||
$id = substr($item, strpos($item, "-") + 1);
|
||||
array_push($groups, array("id" => intval($id), "title" => $groupsToTitle[$id]));
|
||||
if (isset($groupsToGroups[$id]))
|
||||
$this->flattenGroups($groupsToGroups, $groups, $groupsToTitle, $id);
|
||||
}
|
||||
}
|
||||
|
||||
function getGroups()
|
||||
{
|
||||
// TODO: ordering of child categories etc
|
||||
$groups = array();
|
||||
|
||||
$sth = $this->pdo->prepare("SELECT id, title, parent_cat
|
||||
FROM ttrss_feed_categories
|
||||
WHERE owner_uid = ?
|
||||
ORDER BY order_id ASC");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
$groupsToGroups = array();
|
||||
$groupsToTitle = array();
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
if ($line["parent_cat"] === NULL)
|
||||
{
|
||||
if (!isset($groupsToGroups[-1]))
|
||||
{
|
||||
$groupsToGroups[-1] = array();
|
||||
}
|
||||
|
||||
array_push($groupsToGroups[-1], $line["order_id"] . "-" . $line["id"]);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!isset($groupsToGroups[$line["parent_cat"]]))
|
||||
{
|
||||
$groupsToGroups[$line["parent_cat"]] = array();
|
||||
}
|
||||
|
||||
array_push($groupsToGroups[$line["parent_cat"]], $line["order_id"] . "-" . $line["id"]);
|
||||
}
|
||||
|
||||
$groupsToTitle[$line["id"]] = $line["title"];
|
||||
}
|
||||
|
||||
foreach ($groupsToGroups as $key => $value)
|
||||
{
|
||||
sort($value);
|
||||
}
|
||||
|
||||
if (isset($groupsToGroups[-1]))
|
||||
$this->flattenGroups($groupsToGroups, $groups, $groupsToTitle, -1);
|
||||
|
||||
return $groups;
|
||||
}
|
||||
|
||||
function getFeeds()
|
||||
{
|
||||
$feeds = array();
|
||||
|
||||
$sth = $this->pdo->prepare("SELECT id, title, feed_url, site_url, " . SUBSTRING_FOR_DATE . "(last_updated,1,19) AS last_updated
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = ?
|
||||
ORDER BY order_id ASC");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
array_push($feeds, array("id" => intval($line["id"]),
|
||||
"favicon_id" => intval($line["id"]),
|
||||
"title" => $line["title"],
|
||||
"url" => $line["feed_url"],
|
||||
"site_url" => $line["site_url"],
|
||||
"is_spark" => 0, // unsupported
|
||||
"last_updated_on_time" => (int) strtotime($line["last_updated"])
|
||||
));
|
||||
}
|
||||
return $feeds;
|
||||
}
|
||||
|
||||
function getFavicons()
|
||||
{
|
||||
$favicons = array();
|
||||
|
||||
$sth = $this->pdo->prepare("SELECT id
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = ?
|
||||
ORDER BY order_id ASC");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
// data = "image/gif;base64,<base64 encoded image>
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
$filename = "feed-icons/" . $line["id"] . ".ico";
|
||||
if (file_exists($filename))
|
||||
{
|
||||
array_push($favicons, array("id" => intval($line["id"]),
|
||||
"data" => image_type_to_mime_type(exif_imagetype($filename)) . ";base64," . base64_encode(file_get_contents($filename))
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
return $favicons;
|
||||
}
|
||||
|
||||
function getLinks()
|
||||
{
|
||||
// TODO: is there a 'hot links' alternative in ttrss?
|
||||
// use ttrss_user_entries / score > 0 / unread
|
||||
$links = array();
|
||||
|
||||
$item_limit = 50;
|
||||
$where = "owner_uid = ? AND ref_id = id AND score > 0 AND unread = true";
|
||||
$where_items = array();
|
||||
array_push($where_items, clean($_SESSION["uid"]));
|
||||
|
||||
if (isset($_REQUEST["range"]))
|
||||
{
|
||||
// use the range argument to request a limited "updated" items
|
||||
if (is_numeric($_REQUEST["range"]))
|
||||
{
|
||||
$range = ($_REQUEST["range"] > 0) ? intval(clean($_REQUEST["range"])) : 0;
|
||||
if ($range)
|
||||
{
|
||||
|
||||
$offset = 0;
|
||||
if (isset($_REQUEST["offset"]))
|
||||
{
|
||||
// use the range argument to request a limited "updated" items
|
||||
if (is_numeric($_REQUEST["offset"]))
|
||||
{
|
||||
$offset = ($_REQUEST["offset"] > 0) ? intval(clean($_REQUEST["offset"])) : 0;
|
||||
}
|
||||
}
|
||||
|
||||
if ($range) {
|
||||
if ($offset == 0) {
|
||||
//range > 1 AND offset = 0
|
||||
$where .= " AND updated < NOW()";
|
||||
$where .= " AND updated > NOW()-INTERVAL ? DAY";
|
||||
array_push($where_items, $range);
|
||||
} else {
|
||||
//range > 1 AND offset > 0
|
||||
$where .= " AND updated < NOW()-INTERVAL ? DAY";
|
||||
$where .= " AND updated > NOW()-INTERVAL ? DAY";
|
||||
array_push($where_items, $offset, $offset+$range);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$where .= " ORDER BY score DESC, updated DESC" ;
|
||||
|
||||
if (is_numeric($_REQUEST["page"]))
|
||||
{
|
||||
// use the page argument to request the next $item_limit items
|
||||
// page = 1 --> 1st Page will be convertet to 0
|
||||
$page = isset($_REQUEST["page"]) ? intval(clean($_REQUEST["page"]))-1 : 0;
|
||||
$page = ($page<0) ? 0 : $page;
|
||||
|
||||
$where .= " LIMIT " . $item_limit . " OFFSET " . intval($page * $item_limit);
|
||||
// array_push($where_items, $item_limit);
|
||||
// array_push($where_items, ($page * $item_limit));
|
||||
} else {
|
||||
$where .= " LIMIT ?";
|
||||
array_push($where_items, $item_limit);
|
||||
}
|
||||
|
||||
/* classes/api.php getLinks */
|
||||
|
||||
// id, feed_id, title, author, html, url, is_saved, is_read, created_on_time
|
||||
$sth = $this->pdo->prepare("SELECT ref_id, feed_id, title, link, score, id, marked, unread, updated
|
||||
FROM ttrss_entries, ttrss_user_entries
|
||||
WHERE " . $where);
|
||||
$sth->execute($where_items);
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
array_push($links, array("id" => intval($line["id"]),
|
||||
"feed_id" => intval($line["feed_id"]),
|
||||
"item_id" => intval($line["ref_id"]),
|
||||
"temperature" => intval($line["score"]),
|
||||
"is_item" => 1,
|
||||
"is_local" => 1,
|
||||
"is_saved" => (API::param_to_bool($line["marked"]) ? 1 : 0),
|
||||
"title" => $line["title"],
|
||||
"url" => $line["link"],
|
||||
"item_ids" => ""
|
||||
));
|
||||
}
|
||||
|
||||
return $links;
|
||||
}
|
||||
|
||||
function formatBytes($bytes, $precision = 2) {
|
||||
$units = array('B', 'KB', 'MB', 'GB', 'TB');
|
||||
|
||||
$bytes = max($bytes, 0);
|
||||
$pow = floor(($bytes ? log($bytes) : 0) / log(1024));
|
||||
$pow = min($pow, count($units) - 1);
|
||||
|
||||
// Uncomment one of the following alternatives
|
||||
$bytes /= pow(1024, $pow);
|
||||
// $bytes /= (1 << (10 * $pow));
|
||||
|
||||
return round($bytes, $precision) . ' ' . $units[$pow];
|
||||
}
|
||||
|
||||
function getItems()
|
||||
{
|
||||
// items from specific groups, feeds
|
||||
$items = array();
|
||||
|
||||
$item_limit = 50;
|
||||
$where = " owner_uid = ? AND ref_id = id ";
|
||||
$where_items = array();
|
||||
array_push($where_items, clean($_SESSION["uid"]));
|
||||
|
||||
if (isset($_REQUEST["feed_ids"]) || isset($_REQUEST["group_ids"])) // added 0.3
|
||||
{
|
||||
$feed_ids = array();
|
||||
if (isset($_REQUEST["feed_ids"]))
|
||||
{
|
||||
$feed_ids = explode(",", clean($_REQUEST["feed_ids"]));
|
||||
}
|
||||
if (isset($_REQUEST["group_ids"]))
|
||||
{
|
||||
$group_ids = array_map("intval", array_filter(explode(",", clean($_REQUEST["group_ids"])), "is_numeric"));
|
||||
$group_ids_qmarks = arr_qmarks($group_ids);
|
||||
|
||||
$sth = $this->pdo->prepare("SELECT id
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = ? AND cat_id IN ($group_ids_qmarks)");
|
||||
|
||||
$sth->execute(array_merge([clean($_SESSION["uid"])], $group_ids));
|
||||
|
||||
$group_feed_ids = array();
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
array_push($group_feed_ids, $line["id"]);
|
||||
}
|
||||
|
||||
$feed_ids = array_unique(array_merge($feed_ids, $group_feed_ids));
|
||||
}
|
||||
|
||||
$feed_ids = array_map("intval", array_filter($feed_ids, "is_numeric"));
|
||||
$feed_ids_qmarks = arr_qmarks($feed_ids);
|
||||
|
||||
$where .= " AND feed_id IN ($feed_ids_qmarks) ";
|
||||
$where_items = array_merge($where_items, $feed_ids);
|
||||
}
|
||||
|
||||
if (isset($_REQUEST["max_id"])) // descending from most recently added
|
||||
{
|
||||
// use the max_id argument to request the previous $item_limit items
|
||||
if (is_numeric($_REQUEST["max_id"]))
|
||||
{
|
||||
$max_id = ($_REQUEST["max_id"] > 0) ? intval(clean($_REQUEST["max_id"])) : 0;
|
||||
if ($max_id)
|
||||
{
|
||||
$where .= " AND id < ? ";
|
||||
array_push($where_items, $max_id);
|
||||
}
|
||||
|
||||
$where .= " ORDER BY id DESC ";
|
||||
}
|
||||
}
|
||||
else if (isset($_REQUEST["with_ids"])) // selective
|
||||
{
|
||||
$item_ids = array_map("intval", array_filter(explode(",", clean($_REQUEST["with_ids"])), "is_numeric"));
|
||||
$item_ids_qmarks = arr_qmarks($item_ids);
|
||||
|
||||
$where .= " AND id IN ($item_ids_qmarks) ";
|
||||
$where_items = array_merge($where_items, $item_ids);
|
||||
}
|
||||
else // ascending from first added
|
||||
{
|
||||
if (is_numeric($_REQUEST["since_id"]))
|
||||
{
|
||||
// use the since_id argument to request the next $item_limit items
|
||||
$since_id = isset($_GET["since_id"]) ? intval(clean($_GET["since_id"])) : 0;
|
||||
|
||||
if ($since_id)
|
||||
{
|
||||
$where .= " AND id > ? ";
|
||||
|
||||
if ($this->id_hack)
|
||||
{
|
||||
$val = $since_id * 1000; // NASTY hack for Mr. Reader 2.0 on iOS and TinyTiny RSS Fever
|
||||
}
|
||||
else
|
||||
{
|
||||
$val = $since_id;
|
||||
}
|
||||
|
||||
array_push($where_items, $val);
|
||||
}
|
||||
|
||||
$where .= " ORDER BY id ASC ";
|
||||
}
|
||||
}
|
||||
|
||||
$where .= " LIMIT " . $item_limit;
|
||||
|
||||
/* classes/api.php getArticle */
|
||||
|
||||
// id, feed_id, title, author, html, url, is_saved, is_read, created_on_time
|
||||
$sth = $this->pdo->prepare("SELECT ref_id, feed_id, title, link, content, id, marked, unread, author,
|
||||
" . SUBSTRING_FOR_DATE . "(updated,1,16) as updated,
|
||||
(SELECT site_url FROM ttrss_feeds WHERE id = feed_id) AS site_url,
|
||||
(SELECT hide_images FROM ttrss_feeds WHERE id = feed_id) AS hide_images
|
||||
FROM ttrss_entries, ttrss_user_entries
|
||||
WHERE " . $where);
|
||||
$sth->execute($where_items);
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
$line_content = sanitize(
|
||||
$line["content"],
|
||||
API::param_to_bool($line['hide_images']),
|
||||
false, $line["site_url"], false, $line["id"]);
|
||||
|
||||
if ($this->add_attached_files){
|
||||
$enclosures = Article::get_article_enclosures($line["id"]);
|
||||
if (count($enclosures) > 0) {
|
||||
$line_content .= '<ul type="lower-greek">';
|
||||
foreach ($enclosures as $enclosure) {
|
||||
if (!empty($enclosure["content_url"])) {
|
||||
$enc_type = "";
|
||||
if (!empty($enclosure["content_type"])) {
|
||||
$enc_type = ", " . $enclosure["content_type"];
|
||||
}
|
||||
$enc_size = "";
|
||||
if (!empty($enclosure["duration"])) {
|
||||
$enc_size = " , " . $this->formatBytes($enclosure["duration"]);
|
||||
}
|
||||
$line_content .= '<li><a href="' . $enclosure["content_url"] . '" target="_blank">' . basename($enclosure["content_url"]) . $enc_type . $enc_size . '</a></li>';
|
||||
}
|
||||
}
|
||||
$line_content .= '</ul>';
|
||||
}
|
||||
}
|
||||
|
||||
array_push($items, array("id" => intval($line["id"]),
|
||||
"feed_id" => intval($line["feed_id"]),
|
||||
"title" => $line["title"],
|
||||
"author" => $line["author"],
|
||||
"html" => $line_content,
|
||||
"url" => $line["link"],
|
||||
"is_saved" => (API::param_to_bool($line["marked"]) ? 1 : 0),
|
||||
"is_read" => ( (!API::param_to_bool($line["unread"])) ? 1 : 0),
|
||||
"created_on_time" => (int) strtotime($line["updated"])
|
||||
));
|
||||
}
|
||||
|
||||
return $items;
|
||||
}
|
||||
|
||||
function getTotalItems()
|
||||
{
|
||||
// number of total items
|
||||
$total_items = 0;
|
||||
|
||||
$sth = $this->pdo->prepare("SELECT COUNT(ref_id) as total_items
|
||||
FROM ttrss_user_entries
|
||||
WHERE owner_uid = ?");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
if ($line = $sth->fetch())
|
||||
{
|
||||
$total_items = $line["total_items"];
|
||||
}
|
||||
|
||||
return $total_items;
|
||||
}
|
||||
|
||||
function getFeedsGroup()
|
||||
{
|
||||
$feeds_groups = array();
|
||||
|
||||
$sth = $this->pdo->prepare("SELECT id, cat_id
|
||||
FROM ttrss_feeds
|
||||
WHERE owner_uid = ?
|
||||
AND cat_id IS NOT NULL
|
||||
ORDER BY id ASC");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
$groupsToFeeds = array();
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
if (!array_key_exists($line["cat_id"], $groupsToFeeds))
|
||||
$groupsToFeeds[$line["cat_id"]] = array();
|
||||
|
||||
array_push($groupsToFeeds[$line["cat_id"]], $line["id"]);
|
||||
}
|
||||
|
||||
foreach ($groupsToFeeds as $group => $feeds)
|
||||
{
|
||||
$feedsStr = "";
|
||||
foreach ($feeds as $feed)
|
||||
$feedsStr .= $feed . ",";
|
||||
$feedsStr = trim($feedsStr, ",");
|
||||
|
||||
array_push($feeds_groups, array("group_id" => $group,
|
||||
"feed_ids" => $feedsStr));
|
||||
}
|
||||
return $feeds_groups;
|
||||
}
|
||||
|
||||
function getUnreadItemIds()
|
||||
{
|
||||
$unreadItemIdsCSV = "";
|
||||
$sth = $this->pdo->prepare("SELECT ref_id
|
||||
FROM ttrss_user_entries
|
||||
WHERE owner_uid = ? AND unread = true"); // ORDER BY red_id DESC
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
$unreadItemIdsCSV .= $line["ref_id"] . ",";
|
||||
}
|
||||
$unreadItemIdsCSV = trim($unreadItemIdsCSV, ",");
|
||||
|
||||
return $unreadItemIdsCSV;
|
||||
}
|
||||
|
||||
function getSavedItemIds()
|
||||
{
|
||||
$savedItemIdsCSV = "";
|
||||
$sth = $this->pdo->prepare("SELECT ref_id
|
||||
FROM ttrss_user_entries
|
||||
WHERE owner_uid = ? AND marked = true");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
$savedItemIdsCSV .= $line["ref_id"] . ",";
|
||||
}
|
||||
$savedItemIdsCSV = trim($savedItemIdsCSV, ",");
|
||||
|
||||
return $savedItemIdsCSV;
|
||||
}
|
||||
|
||||
function getEqualItems($id)
|
||||
{
|
||||
//get all ids which have identical links (Reference is found by id)
|
||||
$sth = $this->pdo->prepare("SELECT id
|
||||
FROM ttrss_entries,ttrss_user_entries
|
||||
WHERE id=ref_id AND owner_uid = ?
|
||||
AND link=(SELECT link FROM ttrss_entries WHERE id = ?)");
|
||||
$sth->execute(array_merge([clean($_SESSION["uid"]), $id]));
|
||||
|
||||
$ids = "";
|
||||
while ($line = $sth->fetch())
|
||||
{
|
||||
$ids .= $line["id"] . ",";
|
||||
}
|
||||
$ids = trim($ids, ",");
|
||||
|
||||
if (self::DEBUG) {
|
||||
// add request to debug log
|
||||
error_log(print_r($ids, true));
|
||||
}
|
||||
|
||||
return $ids;
|
||||
}
|
||||
|
||||
function setItem($id, $field_raw, $mode)
|
||||
{
|
||||
/* classes/api.php updateArticle */
|
||||
|
||||
$article_ids = array_map("intval", array_filter(explode(",", clean($id)), "is_numeric"));
|
||||
$mode = (int) clean($mode);
|
||||
$field_raw = (int) clean($field_raw);
|
||||
|
||||
$field = "";
|
||||
$set_to = "";
|
||||
|
||||
switch ($field_raw) {
|
||||
case 0:
|
||||
$field = "marked";
|
||||
$additional_fields = ",last_marked = NOW()";
|
||||
break;
|
||||
case 1:
|
||||
$field = "unread";
|
||||
$additional_fields = ",last_read = NOW()";
|
||||
break;
|
||||
};
|
||||
|
||||
switch ($mode) {
|
||||
case 1:
|
||||
$set_to = "true";
|
||||
break;
|
||||
case 0:
|
||||
$set_to = "false";
|
||||
break;
|
||||
}
|
||||
|
||||
if ($field && $set_to && count($article_ids) > 0) {
|
||||
$article_qmarks = arr_qmarks($article_ids);
|
||||
|
||||
$sth = $this->pdo->prepare("UPDATE ttrss_user_entries SET
|
||||
$field = $set_to $additional_fields
|
||||
WHERE ref_id IN ($article_qmarks) AND owner_uid = ?");
|
||||
$sth->execute(array_merge($article_ids, [clean($_SESSION["uid"])]));
|
||||
|
||||
$num_updated = $sth->rowCount();
|
||||
|
||||
if ($num_updated > 0 && $field == "unread") {
|
||||
$sth = $this->pdo->prepare("SELECT DISTINCT feed_id FROM ttrss_user_entries
|
||||
WHERE ref_id IN ($article_qmarks)");
|
||||
$sth->execute($article_ids);
|
||||
|
||||
while ($line = $sth->fetch()) {
|
||||
CCache::update($line["feed_id"], clean($_SESSION["uid"]));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function setItemAsRead($id)
|
||||
{
|
||||
//action is true for all Equal Items
|
||||
$ids = $this->getEqualItems($id);
|
||||
$this->setItem($ids, 1, 0);
|
||||
}
|
||||
|
||||
function setItemAsUnread($id)
|
||||
{
|
||||
$ids = $this->getEqualItems($id);
|
||||
$this->setItem($ids, 1, 1);
|
||||
}
|
||||
|
||||
function setItemAsSaved($id)
|
||||
{
|
||||
$this->setItem($id, 0, 1);
|
||||
}
|
||||
|
||||
function setItemAsUnsaved($id)
|
||||
{
|
||||
$this->setItem($id, 0, 0);
|
||||
}
|
||||
|
||||
function setFeed($id, $cat, $before=0)
|
||||
{
|
||||
/* classes/feeds.php catchup_feed */
|
||||
|
||||
// if before is zero, set it to now so feeds all items are read from before this point in time
|
||||
if ($before == 0)
|
||||
$before = time();
|
||||
|
||||
if (is_numeric($id))
|
||||
{
|
||||
// this is a category
|
||||
if ($cat)
|
||||
{
|
||||
// if not special feed
|
||||
if ($id > 0)
|
||||
{
|
||||
$sth = $this->pdo->prepare("UPDATE ttrss_user_entries
|
||||
SET unread = false, last_read = NOW() WHERE ref_id IN
|
||||
(SELECT id FROM
|
||||
(SELECT DISTINCT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
|
||||
AND owner_uid = ? AND unread = true AND feed_id IN
|
||||
(SELECT id FROM ttrss_feeds WHERE cat_id IN (?)) AND updated < ? ) as tmp)");
|
||||
$sth->execute([clean($_SESSION["uid"]), intval($id), date("Y-m-d H:i:s", $before)]);
|
||||
}
|
||||
// this is "all" to fever, but internally "all" is -4
|
||||
else if ($id == 0)
|
||||
{
|
||||
$id = -4;
|
||||
$sth = $this->pdo->prepare("UPDATE ttrss_user_entries
|
||||
SET unread = false, last_read = NOW() WHERE ref_id IN
|
||||
(SELECT id FROM
|
||||
(SELECT DISTINCT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
|
||||
AND owner_uid = ? AND unread = true AND updated < ? ) as tmp)");
|
||||
$sth->execute([clean($_SESSION["uid"]), date("Y-m-d H:i:s", $before)]);
|
||||
}
|
||||
}
|
||||
// not a category
|
||||
else if ($id > 0)
|
||||
{
|
||||
$sth = $this->pdo->prepare("UPDATE ttrss_user_entries
|
||||
SET unread = false, last_read = NOW() WHERE ref_id IN
|
||||
(SELECT id FROM
|
||||
(SELECT DISTINCT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
|
||||
AND owner_uid = ? AND unread = true AND feed_id = ? AND updated < ? ) as tmp)");
|
||||
$sth->execute([clean($_SESSION["uid"]), intval($id), date("Y-m-d H:i:s", $before)]);
|
||||
|
||||
}
|
||||
CCache::update($id, clean($_SESSION["uid"]), $cat);
|
||||
}
|
||||
}
|
||||
|
||||
function setFeedAsRead($id, $before)
|
||||
{
|
||||
$this->setFeed($id, false, $before);
|
||||
}
|
||||
|
||||
function setGroupAsRead($id, $before)
|
||||
{
|
||||
$this->setFeed($id, true, $before);
|
||||
}
|
||||
|
||||
// this does all the processing, since the fever api does not have a specific variable that specifies the operation
|
||||
function index()
|
||||
{
|
||||
$response_arr = array();
|
||||
|
||||
if (isset($_REQUEST["groups"]))
|
||||
{
|
||||
$response_arr["groups"] = $this->getGroups();
|
||||
$response_arr["feeds_groups"] = $this->getFeedsGroup();
|
||||
}
|
||||
if (isset($_REQUEST["feeds"]))
|
||||
{
|
||||
$response_arr["feeds"] = $this->getFeeds();
|
||||
$response_arr["feeds_groups"] = $this->getFeedsGroup();
|
||||
}
|
||||
// TODO: favicon support
|
||||
if (isset($_REQUEST["favicons"]))
|
||||
{
|
||||
$response_arr["favicons"] = $this->getFavicons();
|
||||
}
|
||||
if (isset($_REQUEST["items"]))
|
||||
{
|
||||
$response_arr["total_items"] = $this->getTotalItems();
|
||||
$response_arr["items"] = $this->getItems();
|
||||
}
|
||||
if (isset($_REQUEST["links"]))
|
||||
{
|
||||
$response_arr["links"] = $this->getLinks();
|
||||
}
|
||||
if (isset($_REQUEST["unread_item_ids"]))
|
||||
{
|
||||
$response_arr["unread_item_ids"] = $this->getUnreadItemIds();
|
||||
}
|
||||
if (isset($_REQUEST["saved_item_ids"]))
|
||||
{
|
||||
$response_arr["saved_item_ids"] = $this->getSavedItemIds();
|
||||
}
|
||||
|
||||
if (isset($_REQUEST["mark"], $_REQUEST["as"], $_REQUEST["id"]))
|
||||
{
|
||||
foreach (explode(",", clean($_REQUEST["id"])) as $id) {
|
||||
$this->markId($id);
|
||||
}
|
||||
}
|
||||
|
||||
/* classes/api.php index */
|
||||
if ($_SESSION["uid"])
|
||||
$this->wrap(self::STATUS_OK, $response_arr);
|
||||
else if (!$_SESSION["uid"])
|
||||
$this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD'));
|
||||
|
||||
}
|
||||
|
||||
function markId($id)
|
||||
{
|
||||
if (is_numeric($id))
|
||||
{
|
||||
$before = (isset($_REQUEST["before"])) ? clean($_REQUEST["before"]) : null;
|
||||
if ($before !== null && $before > pow(10,10)) {
|
||||
$before = round($before / 1000);
|
||||
}
|
||||
|
||||
$method_name = "set" . ucfirst(clean($_REQUEST["mark"])) . "As" . ucfirst(clean($_REQUEST["as"]));
|
||||
|
||||
if (method_exists($this, $method_name))
|
||||
{
|
||||
$this->{$method_name}(intval($id), $before);
|
||||
switch(clean($_REQUEST["as"]))
|
||||
{
|
||||
case "read":
|
||||
case "unread":
|
||||
$response_arr["unread_item_ids"] = $this->getUnreadItemIds();
|
||||
break;
|
||||
|
||||
case 'saved':
|
||||
case 'unsaved':
|
||||
$response_arr["saved_item_ids"] = $this->getSavedItemIds();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
78
index.php
Normal file
78
index.php
Normal file
@@ -0,0 +1,78 @@
|
||||
<?php
|
||||
|
||||
// do not support refresh command, this could take ages.
|
||||
if (isset($_REQUEST["refresh"]))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
/* api/index.php */
|
||||
error_reporting(E_ERROR | E_PARSE);
|
||||
|
||||
$tt_root = dirname(dirname(dirname($_SERVER["SCRIPT_FILENAME"])));
|
||||
$tt_root2 = $tt_root;
|
||||
if (file_exists($tt_root . "/config.php"))
|
||||
{
|
||||
require_once $tt_root . "/config.php";
|
||||
}
|
||||
else //if (file_exists("../../config.php")) {
|
||||
{
|
||||
$tt_root = "../..";
|
||||
$tt_root2 = dirname(dirname(dirname(__FILE__)));
|
||||
require_once $tt_root . "/config.php";
|
||||
}
|
||||
|
||||
set_include_path(dirname(__FILE__) . PATH_SEPARATOR .
|
||||
$tt_root2 . PATH_SEPARATOR .
|
||||
$tt_root2 . "/include" . PATH_SEPARATOR .
|
||||
get_include_path());
|
||||
|
||||
chdir($tt_root);
|
||||
|
||||
define('TTRSS_SESSION_NAME', 'ttrss_api_sid');
|
||||
define('NO_SESSION_AUTOSTART', true);
|
||||
|
||||
require_once "autoload.php";
|
||||
require_once "db.php";
|
||||
require_once "db-prefs.php";
|
||||
require_once "functions.php";
|
||||
require_once "sessions.php";
|
||||
|
||||
require_once "fever_api.php";
|
||||
|
||||
ini_set("session.gc_maxlifetime", 86400);
|
||||
|
||||
define('AUTH_DISABLE_OTP', true);
|
||||
|
||||
if (defined('ENABLE_GZIP_OUTPUT') && ENABLE_GZIP_OUTPUT &&
|
||||
function_exists("ob_gzhandler")) {
|
||||
|
||||
ob_start("ob_gzhandler");
|
||||
} else {
|
||||
ob_start();
|
||||
}
|
||||
|
||||
if ($_REQUEST["sid"]) {
|
||||
session_id($_REQUEST["sid"]);
|
||||
@session_start();
|
||||
} else if (defined('_API_DEBUG_HTTP_ENABLED')) {
|
||||
@session_start();
|
||||
}
|
||||
|
||||
startup_gettext();
|
||||
|
||||
if (!init_plugins()) return;
|
||||
|
||||
$handler = new FeverAPI($_REQUEST);
|
||||
|
||||
if ($handler->before("")) {
|
||||
if (method_exists($handler, 'index')) {
|
||||
$handler->index();
|
||||
}
|
||||
$handler->after();
|
||||
}
|
||||
|
||||
header("Api-Content-Length: " . ob_get_length());
|
||||
|
||||
ob_end_flush();
|
||||
?>
|
||||
83
init.php
Normal file
83
init.php
Normal file
@@ -0,0 +1,83 @@
|
||||
<?php
|
||||
class Fever extends Plugin {
|
||||
private $host;
|
||||
|
||||
function about() {
|
||||
return array(2.2,
|
||||
"Emulates the Fever API for Tiny Tiny RSS",
|
||||
"DigitalDJ, mestrode & murphy");
|
||||
}
|
||||
|
||||
function init($host) {
|
||||
$this->host = $host;
|
||||
|
||||
$host->add_hook($host::HOOK_PREFS_TAB, $this);
|
||||
}
|
||||
|
||||
/* plugins/main/init.php hook_prefs_tab */
|
||||
|
||||
function hook_prefs_tab($args) {
|
||||
if ($args != "prefPrefs") return;
|
||||
|
||||
print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"" . __("Fever Emulation") . "\">";
|
||||
|
||||
print "<h3>" . __("Fever Emulation") . "</h3>";
|
||||
|
||||
print "<p>" . __("Since the Fever API uses a different authentication mechanism to Tiny Tiny RSS, you must set a separate password to login. This password may be the same as your Tiny Tiny RSS password.") . "</p>";
|
||||
|
||||
print "<p>" . __("Set a password to login with Fever:") . "</p>";
|
||||
|
||||
print "<p><b>" . __("WARNING: The Fever API uses an UNSECURE unsalted MD5 hash. Consider the use of a disposable application-specific password and use HTTPS.") . "</b></p>";
|
||||
|
||||
print "<form dojoType=\"dijit.form.Form\">";
|
||||
|
||||
print "<script type=\"dojo/method\" event=\"onSubmit\" args=\"evt\">
|
||||
evt.preventDefault();
|
||||
if (this.validate()) {
|
||||
new Ajax.Request('backend.php', {
|
||||
parameters: dojo.objectToQuery(this.getValues()),
|
||||
onComplete: function(transport) {
|
||||
notify_info(transport.responseText);
|
||||
}
|
||||
});
|
||||
//this.reset();
|
||||
}
|
||||
</script>";
|
||||
|
||||
print_hidden("op", "pluginhandler");
|
||||
print_hidden("method", "save");
|
||||
print_hidden("plugin", "fever");
|
||||
|
||||
print "<input dojoType=\"dijit.form.ValidationTextBox\" required=\"1\" type=\"password\" name=\"password\" />";
|
||||
print "<button dojoType=\"dijit.form.Button\" type=\"submit\">" . __("Set Password") . "</button>";
|
||||
print "</form>";
|
||||
|
||||
print "<p>" . __("To login with the Fever API, set your server details in your favourite RSS application to: ") . get_self_url_prefix() . "/plugins/fever/" . "</p>";
|
||||
print "<p>" . __("Additional details can be found at ") . "<a href=\"http://www.feedafever.com/api\" target=\"_blank\">https://feedafever.com/api</a></p>";
|
||||
|
||||
print "<p>" . __("Note: Due to the limitations of the API and some RSS clients (for example, Reeder on iOS), some features are unavailable: \"Special\" Feeds (Published / Tags / Labels / Fresh / Recent), Nested Categories (hierarchy is flattened)") . "</p>";
|
||||
|
||||
print "</div>";
|
||||
}
|
||||
|
||||
function save()
|
||||
{
|
||||
if (isset($_POST["password"]) && isset($_SESSION["uid"]))
|
||||
{
|
||||
$sth = $this->pdo->prepare("SELECT login FROM ttrss_users WHERE id = ?");
|
||||
$sth->execute([clean($_SESSION["uid"])]);
|
||||
if ($line = $sth->fetch())
|
||||
{
|
||||
$password = md5($line["login"] . ":" . $_POST["password"]);
|
||||
$this->host->set($this, "password", $password);
|
||||
echo __("Password saved.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function api_version() {
|
||||
return 2;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
Reference in New Issue
Block a user