0x80
/
simple-gitv
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Publish old simple-gitv code.

This commit is contained in:
0x80 2021-11-29 00:00:00 +00:00
commit 04d294d611
Signed by: 0x80
GPG Key ID: 00B9C3A6C02F71F6
34 changed files with 3550 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CHANGELOG.md Normal file
View File

@ -0,0 +1,16 @@
# Changelog
## [1.1.1] - 2020-06-15
- Remove "master" terminology.
### Fixed
- Switched from calling the active branch "master" to calling it the name of the branch itself. Replaced the word "master" with "main" in documentation.
## [1.1.0] - 2020-05-09
- Implement caching.
### Added
- Added a cache.
## [1.0.0] - 2020-04-15
- First release.

661
COPYING Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are 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.
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.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
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 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 work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
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 AGPL, see
<https://www.gnu.org/licenses/>.

72
README.md Normal file
View File

@ -0,0 +1,72 @@
# simple-gitv
a simple, libre web-based Git project viewer
## Why?
I tried lots of other options, and none of them were what I wanted. So I decided to write my own.
## Features (& Ideology)
- No JavaScript. None at all. I don't even know JavaScript.
- More generally, no client-side code execution.
- Easy to setup and run!
- (Aims to be) user-friendly and intuitive.
- Easy to write a new theme, or at least change the colors.
## Limitations
### By Design
- simple-gitv is not a platform for code development, like GitHub, GitLab, or Gitea. It's just a website to view information about Git projects, like GitWeb or GitList.
- No telemetry, vendor lock-in, JavaScript, or proprietary nonsense.
### Because I Haven't Implemented Something Yet
- Users cannot view the project at a certain commit.
- Tags are listed but effectively meaningless for the above reason.
- No blame, history, etc. support yet.
- Lacking instructions for other webservers like nginx and lighttpd.
- Currently only supports the active branch of a repo properly. (Not yet suitable for repos with multiple branches.)
- Probably lots of other missing features.
## Dependencies
### Mandatory Dependencies
- A webserver (httpd)
- PHP
- Git
### Optional Dependencies
- pandoc
## Installing
Before installing:
1. Register your domain name.
2. Set up DNS to point your domain to your IP address.
3. Set up port forwarding to forward incoming TCP connections on ports 80 and 443 to your server.
4. Install [dependencies](#dependencies)
Then follow the instructions in docs/install.md to install.
## Modifying
See docs/modifying.md.
## License
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
## Credits
Thanks to [Klaus Silveira](http://www.klaussilveira.com/) who wrote [GitList](https://gitlist.org/) and the [Gitea](https://gitea.io/) Authors. The codebase for this project is primarily independent, but I drew inspiration from those projects when designing the project.
Thanks to [Marmoy](https://stackoverflow.com/users/584405/marmoy) on Stack Overflow ([x](https://stackoverflow.com/questions/26734933/how-to-set-up-git-over-http)) and Klaus Silveira/GitList for unknowingly helping me configure Apache.

49
docs/code-overview.md Normal file
View File

@ -0,0 +1,49 @@
# Code Overview
This document seeks to outline how the project is organized, to help anyone who wants to use or modify the code.
## index.php
index.php is the file that always runs when a client requests a page. It then loads other PHP files from the src/ folder to build the page that the user has requested.
## src/utils.php
utils.php is a collection of useful functions for this project. Any function called in this project that's not native to PHP is defined in utils.php, and these functions are organized into two categories - string processing (which do not require system calls to git) and git methods (which do) - and organized alphabetically within their category.
## src/pages/
PHP files in src/pages give instructions for specific types of pages:
- home.php: The homepage, which lists the repositories. Located at https://example.com/
- repo.php: The front page of a repository. This is basically a tree page, with a preview of the readme (if applicable). Located at https://example.com/projectname/
- tree.php: A directory within the project, which holds its own files. Located at https://example.com/projectname/tree/main/path/to/directory/
- blob.php: A file within the project. A preview of the file is displayed, if possible. Located at https://example.com/projectname/blob/main/path/to/file/
- raw.php: The raw data of a file. Currently should support jpg, png, gif, and text data correctly. Located at https://example.com/projectname/raw/main/path/to/file/
- commits.php: Lists the commit history. Located at https://example.com/projectname/commits/
- commit.php: Shows a single commit with an overview, and the changes ade to each file. Located at https://example.com/projectname/commit/commithash/
- tags.php: Shows a list of the tags and the date they were made. Right now this is not super helpful, but in the future I want to be able to show the whole repository at a given commit, and tags will be more useful then. Located at https://example.com/projectname/tags/
## src/parts/
PHP files in src/parts/ are sections of a page, which may be reused often. The src/pages/ files generally include multiple src/parts/ files.
- header.php: The top of the HTML page. This file determines the theme to use.
- description.php: Lists the current path, clickable to any point in the path (example.com / projectname / path / to / current). Lists the project description beneath this.
- menu.php: Links to different parts of the repository: Code, Commits, Tags, License (if present and detected).
- table.php: Lists the subdirectories and files in the current directory in a table, with links to their page and their most recent commit.
- preview.php: Attempts to display a file. If it is a .md file, it will try to render it as Markdown using pandoc.
- footer.php: The bottom of the HTML page. This file also adds a link to the source code. You may remove or modify this link in your version, but you must prominently offer the source code of the version running on your server to any user who connects to your site. See [modifying.md](modifying.md) for more information.
## config.ini
This is the configuration file. (It should be copied from templates/config.ini.template) Lines beginning with a semicolon are comments and will not be interpreted. Modify this to show your site title, set the path to your repositories, and change the theme.
## themes/
CSS files in the themes/ directory are theme options for the page. To add your own theme, add a new .css file (example.css), and to enable that theme, change the value of "theme" in config.ini (theme = "example").
If you just want to change the color scheme, this is easy to do. Just change the values of --primary-color, --secondary-color, and --background-color at the top of the file.
## git.conf
This is an Apache configuration file to add a virtualhost for this service. It should be copied from templates/httpd-git.conf.template. It contains all necessary configurations, so an .htaccess file should not be needed.

104
docs/install.md Normal file
View File

@ -0,0 +1,104 @@
# Installing simple-gitv
These instructions will setup an Apache server which will serve pages from /var/www/git/ showing information about Git repositories stored in /srv/git/. If you want to use different paths, change those whenever they are shown.
I have only tested this on Fedora. If you're installing on a different distribution like Debian or Arch, you may need different packages (such as apache2 instead of httpd) or put settings in different places. I also assume SystemD. If you're using a different init system, you'll have a different command to run the webserver.
## 0. Do this stuff first
1. Register your domain name.
2. Set up DNS to point your domain to your IP address.
3. Set up port forwarding to forward incoming TCP connections on ports 80 and 443 to your server.
4. Install dependencies:
### Mandatory Dependencies
- A webserver (httpd)[^1]
- PHP
- Git
### Optional Dependencies
- pandoc[^2]
## 1. Download Project
Clone the repository using Git and switch to that directory (for later steps).
## 2. Configure Webserver
A default configuration file has been included. Copy it to /etc/httpd/conf.d/ so you can use it as a virtualhost:
`sudo cp templates/httpd-git.conf.template /etc/httpd/conf.d/git.conf`
Edit /etc/httpd/conf.d/git.conf so it shows your domain name instead of example.com.
This file also assumes that you are using a LetsEncrypt certificate stored in /etc/letsencrypt/live/example.com/ and redirects all HTTP traffic to HTTPS. If this is not the desired behavior for you, change it.
To enable caching, create a directory called "cache" in the root directory of the project:
`mkdir cache`
Set the permissions to 777 to enable httpd to write to the cache directory:
`sudo chmod 777 cache`
## 3. Run Webserver
If you're using SystemD as your init system, run:
`sudo systemctl start httpd`
to start the server, and:
`sudo systemctl enable httpd`
to enable the server to run at startup.
## 4. Add Git Repositories
Create the directory /srv/git/ if it doesn't already exist:
`sudo mkdir -p /srv/git`
You may want to change the owner of /srv/git/ to you so you can more easily modify your repos:
`sudo chown -R myusername:myusername /srv/git`
replacing "myusername" with your username.
Now `cd /srv/git` and put your Git repositories there. If you want to create a new repo:
`git init --bare newrepo`
If you want to clone a repo from somewhere else, you can do so with:
`git clone --bare https://example.com/path/to/project.git`
replacing the URL above with the repo you want to clone.
## 5. Configure SELinux (if you use it)
SELinux will prevent httpd from reading /srv/git/ to view your repositories. If you use SELinux (e.g., if you're on Fedora, CentOS, or RHEL), add an exception for this:
- `semanage fcontext -a -t httpd_sys_content_t "/srv/git(/.*)?"`
- `restorecon -Rv /srv/git`
Note, we are only giving Apache **read** permission, but not **write** permission on /srv/git. If you want users to be able to git push over HTTP, you will need to also allow write permission.
To enable caching, you will need to enable httpd to read and write to cache:
- `semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/git/cache/*"`
- `restorecon -Rv /var/www/git/cache/`
## 6. Configure
Go back to the project code:
`cd /var/www/git/`
Copy the config.ini template to the root directory of the project:
`cp templates/config.ini.template config.ini`
Edit config.ini to your needs. Lines beginning with a semicolon (;) are comments are will not affect anything.
Set the title of your page. For example, you can use the domain or a name like "Suzan's Code".
If you used a different path for your repositories, change the value of repositories.
If the default theme is not to your liking, you're welcome to change it.
[^1]: Currently I only have a config file for Apache. I hope to add nginx and lighttpd support soon. If you want to write your own configurations for those, please do and let me know how you did it!
[^2]: Pandoc is used to interpret Markdown files as HTML. If pandoc is missing, Markdown files will be previewed as plaintext.

661
docs/licenses/AGPLv3 Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are 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.
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.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
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 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 work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
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 AGPL, see
<https://www.gnu.org/licenses/>.

121
docs/licenses/CC0 Normal file
View File

@ -0,0 +1,121 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

45
docs/modifying.md Normal file
View File

@ -0,0 +1,45 @@
# Modifying simple-gitv
See [code-overview.md](code-overview.md) to understand the organization of the codebase and get started.
## License and Providing Source Code
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Per the AGPLv3: "Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software."
Simply put, if you use this program on a site which other people will access, you should include a link to the source code of the version running on your site.
(You are not obligated to let me know, but please do! I may want to incorporate your changes into my version.)
### Exceptions
#### Configuration Files
Modified configuration files do not need to be provided to users, as long as the available source is sufficient such that a user should reasonably be able to create their own configuration files, e.g., from templates or directions in the documentation.
If you modify the program sufficiently such that requires a modified or additional configuration file to those provided in the templates of the previous version, please include a usable template.
The goal is to include sufficient instructions for running the software on **a** server, not to include instructions for running the software on **your** server specifically.
#### Themes
If you use a modified theme and have not otherwise modified the program, you are not obligated to publish your own version of the program as a whole, only the modified theme.
As the modified theme in CSS form will be served to clients who connect to your site, it is not necessary to publish the theme separately; however, to ensure that other users may use the themes, you must either declare the theme to be in the public domain or license the theme under a [GPL-compatible free software license](https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses). Recommended licenses:
- [Creative Commons CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode)
- [Unlicense](https://unlicense.org/)
- [DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE, version 2](http://www.wtfpl.net/txt/copying/)
If the theme is generated by a program, you must publish instructions for recreating the theme in addition to the theme itself.
### How to Publish the Source Code
If you are running an unmodified version of simple-gitv, you do not have to do anything. src/parts/footer.php already includes a link to the project.
If you are running a modified version of simple-gitv, the best way to publish your changes is to host the code on simple-gitv (or another Git hosting service). The easiest way to do this is to commit changes to the code when you make them, and clone your own repo. For example, if your repositories are in /srv/git/ and your running code is in /var/www/git/ then you can run:
`git clone /srv/git/simple-gitv /var/www/git`
Change the link in src/parts/footer.php to point to your version of the program.

1
docs/version Normal file
View File

@ -0,0 +1 @@
1.1.1

80
index.php Normal file
View File

@ -0,0 +1,80 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// get version
$version = trim(file_get_contents("docs/version"));
// include assorted important utilities
include "src/utils.php";
// read arguments from user config
$config = parse_ini_file("config.ini");
$repos = strip_trailing_slash($config["repositories"]);
$title = $config["title"];
$theme = $config["theme"];
// get file to serve based on URL
$url = strip_trailing_slash(substr($_SERVER['REQUEST_URI'], 1));
$page_type = get_page_type($url);
if ($page_type === "invalid") {
include "src/errors/404.php";
die();
}
// homepage does not need to check for Git repo
if ($page_type === "home") {
include "src/pages/home.php";
die();
}
// get Git repo
$project = before_first_slash($url);
$git_dir = get_git_dir("$repos/$project");
// 404 if not a git directory
if (! $git_dir) {
include "src/errors/404.php";
die();
}
// use cached version if it exists, otherwise make it
$last_commit = get_last_commit_time($git_dir);
if (file_exists("cache/$url.html") && $last_commit < filemtime("cache/$url.html")) {
include "cache/$url.html";
} else {
// create directory in cache if it doesn't exist
$directory = "cache/" . before_last_slash($url);
if (!file_exists($directory)) {
mkdir($directory, 0777, true);
}
// create cached file
ob_start();
// get default branch
$branch = get_main_git_branch($git_dir);
include "src/pages/$page_type.php";
$cache_file = fopen("cache/$url.html", 'w');
fwrite($cache_file, ob_get_contents());
fclose($cache_file);
ob_end_flush();
}
?>

26
src/errors/404.php Normal file
View File

@ -0,0 +1,26 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
$title = "404 Not Found";
include "src/parts/header.php";
echo "\t\t<h1>Not Found</h1>\n";
echo "\t\t<p>Sorry, that does not appear to be a valid page.</p>\n";
echo "\t\t<p>Check that the repository is correct and that the link is to a valid object.</p>\n";
include "src/parts/footer.php";
?>

46
src/pages/blob.php Normal file
View File

@ -0,0 +1,46 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// strip repo/blob/
$path = $url;
for ($i = 0; $i < 2; $i++) {
$path = after_first_slash($path);
}
$branch = before_first_slash($path);
// strip branch name
$path = after_first_slash($path);
$url = strip_trailing_slash($url);
$name = after_last_slash($url);
$git_dir = get_git_dir("$repos/$project");
// if no contents, it's not a valid URL
if (! is_git_file("$git_dir", "$path")) {
include "src/errors/404.php";
die();
}
include "src/parts/header.php";
include "src/parts/description.php";
include "src/parts/menu.php";
include "src/parts/preview.php";
include "src/parts/footer.php";
?>

54
src/pages/commit.php Normal file
View File

@ -0,0 +1,54 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// get commit ID (strip project/commit), then strip any trailing slashes
$commit = before_first_slash(after_first_slash(after_first_slash($url)));
include "src/parts/header.php";
include "src/parts/description.php";
include "src/parts/menu.php";
// get commit stats
$commit_stats = explode("\n",trim(shell_exec("cd $git_dir && git show --stat $commit")));
// display commit table
echo "\t\t<pre>\n";
foreach($commit_stats as $stat) {
echo htmlspecialchars($stat)."\n";
}
echo "\t\t</pre>\n\n";
// display changed files
$files_changed = explode("\n",trim(shell_exec("cd $git_dir && git show --format=tformat: --name-only $commit")));
foreach ($files_changed as $file) {
echo "\t\t<div class=\"box\">\n";
echo "\t\t\t<p>$file</p>\n";
echo "\t\t\t<hr/>\n";
$changes = explode("\n",trim(shell_exec("cd $git_dir && git show $commit -- $file")));
echo "\t\t\t<pre>\n";
foreach ($changes as $change) {
echo htmlspecialchars($change)."\n";
}
echo "\t\t\t</pre>\n";
echo "\t\t</div>\n";
echo "\t\t<br/>\n\n";
}
include "src/parts/footer.php";
?>

38
src/pages/commits.php Normal file
View File

@ -0,0 +1,38 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
include "src/parts/header.php";
include "src/parts/description.php";
include "src/parts/menu.php";
// get commits
$commits = explode("\n",trim(shell_exec("cd $git_dir && TZ=UTC git log --date=format-local:'%Y-%m-%d %H:%M:%S' --pretty=format:\"<a href=\\\"/$project/commit/%H\\\" title=\\\"Commit %h: %s\\\">%h</a> - %an, %ad : %s\"")));
// display commit table
foreach($commits as $commit) {
if (!empty($commit)) {
echo "\t\t<p>$commit</p>\n";
}
}
echo "\t\t<hr/>\n\n";
include "src/parts/footer.php";
?>

61
src/pages/home.php Normal file
View File

@ -0,0 +1,61 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// get subdirectories in specified repos directory
$dirs = scandir($repos);
// remove all dirs that are not git repos
$dir_length = sizeof($dirs);
$git_dirs = array();
for ($i = 0; $i < $dir_length; $i++) {
// I could just start indexing from 2 instead
if ($dirs[$i] === "." || $dirs[$i] === "..") {
unset($dirs[$i]);
} else {
$git_dir = get_git_dir("$repos/$dirs[$i]");
if (! $git_dir) {
unset ($dirs[$i]);
} else {
$git_dirs[$dirs[$i]] = $git_dir;
}
}
}
// include header
include "src/parts/header.php";
// domain link
echo "\t\t<h2><a href=\"/\">$title</a></h2>\n";
// list git repos
echo "\t\t<div class=\"box\">\n";
echo "\t\t<h1>Repositories</h1>\n";
echo "\t\t<hr/>\n";
foreach ($dirs as $dir) {
echo "\t\t\t<h3><a href=\"/$dir\">$dir</a></h3>\n";
$git_dir = $git_dirs[$dir];
$description = get_repo_description($git_dir);
echo "\t\t\t<p>$description</p>\n";
echo "\t\t\t<br/>\n";
}
echo "\t\t</div>\n";
// include footer
include "src/parts/footer.php";
?>

40
src/pages/raw.php Normal file
View File

@ -0,0 +1,40 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// strip repo/raw/master/
$path = $url;
for ($i = 0; $i < 3; $i++) {
$path = after_first_slash($path);
}
// set header by filetype
// TODO: add other filetypes
if (ends_with($path,".jpg") || ends_with($path,".jpeg")) {
header("Content-type: image/jpeg");
} elseif (ends_with($path,".png")) {
header("Content-type: image/png");
} elseif (ends_with($path,".gif")) {
header("Content-type: image/gif");
} else {
header("Content-type: text/plain");
}
// output file bytes
passthru("cd $git_dir && git show --pretty=raw HEAD:$path");
?>

37
src/pages/repo.php Normal file
View File

@ -0,0 +1,37 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
include "src/parts/header.php";
include "src/parts/description.php";
include "src/parts/menu.php";
// no path for the table because it's the repo root
$path = "";
include "src/parts/table.php";
// display readme
$readme = get_readme(list_files($git_dir));
if (!empty($readme)) {
$path = $readme;
$name = $readme;
include "src/parts/preview.php";
}
include "src/parts/footer.php";
?>

37
src/pages/tags.php Normal file
View File

@ -0,0 +1,37 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
include "src/parts/header.php";
include "src/parts/description.php";
include "src/parts/menu.php";
// get tags
$tags = explode("\n",trim(shell_exec("cd $git_dir && git tag --sort=\"-creatordate\" --format='%(creatordate:short) - %(refname:strip=2)'")));
// display tags
foreach ($tags as $tag) {
if (!empty($tag)) {
echo "\t\t\t<p>$tag</p>\n";
}
}
echo "\t\t<hr/>\n\n";
include "src/parts/footer.php";
?>

45
src/pages/tree.php Normal file
View File

@ -0,0 +1,45 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// strip repo/tree/
$path = $url;
for ($i = 0; $i < 2; $i++) {
$path = after_first_slash($path);
}
$branch = before_first_slash($path);
// strip branch name
$path = after_first_slash($path);
$name = after_last_slash($url);
// if no contents, it's not a valid URL
$files = list_files("$git_dir", "$path");
if (! $files) {
include "src/errors/404.php";
die();
}
include "src/parts/header.php";
include "src/parts/description.php";
include "src/parts/menu.php";
include "src/parts/table.php";
include "src/parts/footer.php";
?>

45
src/parts/description.php Normal file
View File

@ -0,0 +1,45 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// page name / repo name / path / to / current
echo "\t\t<h2>\n";
echo "\t\t\t<a href=\"/\">$title</a> / \n";
echo "\t\t\t<a href=\"/$project\">$project</a>";
if ($page_type === "tree" || $page_type === "blob") {
echo " / \n";
$path_before = "/";
$path_remaining = strip_trailing_slash($path);
while ($path_remaining !== $name) {
$slash = strpos($path_remaining,"/");
$this_tree = substr($path_remaining,0,$slash);
echo "\t\t\t<a href=\"/$project/tree/$branch$path_before$this_tree\">$this_tree</a> / \n";
$path_before = "$path_before$this_tree/";
$path_remaining = substr($path_remaining,$slash+1);
}
echo "\t\t\t<a href=\"/$url\">$name</a>\n";
echo "\t\t</h2>\n";
} else { // domain / repo name
echo "\n\t\t</h2>\n";
}
// repo description
$description = get_repo_description($git_dir);
echo "\t\t<p>$description</p>\n";
echo "\t\t<br/>\n\n";
?>

22
src/parts/footer.php Normal file
View File

@ -0,0 +1,22 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
echo "\t\t<p class=\"footnote\"><a href=\"https://negativezero.link/code/0x80/simple-gitv\">simple-gitv</a> - a simple, libre web-based Git project viewer, v$version</p>\n";
echo "\t</body>\n";
echo "</html>";

28
src/parts/header.php Normal file
View File

@ -0,0 +1,28 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
echo "<!DOCTYPE html>\n";
echo "<html>\n";
echo "\t<head>\n";
echo "\t\t<meta charset=\"UTF-8\"/>\n";
echo "\t\t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/>\n";
echo "\t\t<link rel=\"stylesheet\" href=\"/themes/$theme.css\"/>\n";
echo "\t\t<title>$title</title>\n";
echo "\t</head>\n";
echo "\t<body>\n";

46
src/parts/menu.php Normal file
View File

@ -0,0 +1,46 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// only include license link if license file found
$license = get_license(list_files($git_dir));
if (!empty($license)) {
$license_path = "$project/blob/$branch/$license";
$current = strip_trailing_slash($url) === $license_path ? " class=\"current\"" : "";
}
echo "\t\t<div id=\"menu\">\n";
echo "\t\t\t<ul>\n";
// code link
echo "\t\t\t\t<li><a href=\"/$project\"" . (($page_type === "repo" || $page_type === "tree" || $page_type === "blob" && empty($current)) ? " class=\"current\"" : "") . ">Code</a></li>\n";
// commits link
echo "\t\t\t\t<li><a href=\"/$project/commits\"" . (($page_type === "commits" || $page_type === "commit") ? " class=\"current\"" : "") . ">Commits</a></li>\n";
// tags link
echo "\t\t\t\t<li><a href=\"/$project/tags\"" . (($page_type === "tags" || $page_type === "tag") ? " class=\"current\"" : "") . ">Tags</a></li>\n";
// license link (if project has a license)
if (!empty($license)) {
echo
"\t\t\t\t<li><a href=\"/$license_path\"$current>License</a></li>\n";
}
echo "\t\t\t</ul>\n";
echo "\t\t</div>\n";
echo "\t\t<br/>\n\n";

68
src/parts/preview.php Normal file
View File

@ -0,0 +1,68 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// create preview box
echo "\t\t<div class=\"box\">\n";
// filename on left, options on right
echo "\t\t\t<div>\n";
echo "\t\t\t\t<p style=\"float: left;\"><b>$name</b></p>\n";
echo "\t\t\t\t<p style=\"float: right;\"><a href=\"/$project/raw/$branch/$path\">Raw</a></p>\n";
echo "\t\t\t</div>\n";
echo "\t\t\t<div style=\"clear: both;\"></div>\n";
echo "\t\t\t<hr/>\n\n";
// this will output the raw data
$command = "cd $git_dir && git show --pretty=raw HEAD:$path";
// determine if file is text or binary
$file_info = exec("$command | file -");
if (strpos($file_info,"ASCII text") || strpos($file_info,"UTF-8 Unicode text") || strpos($file_info,"JSON data")) {
// display data as text
if (ends_with($path,".md") && exec("command -v pandoc")) {
// run markdown through pandoc
$file_data = explode("\n",trim(shell_exec("$command | pandoc")));
foreach ($file_data as $line) {
echo "\t\t\t$line\n";
}
} else {
// output as plaintext
$file_data = explode("\n",shell_exec("$command"));
// output plaintext as pre
echo "\t\t\t<pre>\n";
foreach ($file_data as $line) {
echo htmlspecialchars($line) . "\n";
}
echo "\t\t\t</pre>\n";
}
} elseif (ends_with($path,".jpg") || ends_with($path,".jpeg") || ends_with($path,".png") || ends_with($path,".gif")) {
// display image in img element
echo "\t\t\t<img src=\"/$project/raw/$branch/$path\"/>\n";
} else {
// other - do not try to output
echo "\t\t\t<p>Unable to generate a preview. <a href=\"/$project/raw/$branch/$path\">Open raw</a>\n";
}
// close preview box
echo "\t\t</div>\n";
echo "\t\t<br/>\n";
?>

79
src/parts/table.php Normal file
View File

@ -0,0 +1,79 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
echo "\t\t<table width=\"100%\">\n";
// get files and directories in current path
$tree = list_files_verbose($git_dir, $path);
// separate into files and directories
$files = array();
$num_files = 0;
$directories = array();
$num_dirs = 0;
foreach($tree as $item) {
$ind1 = strpos($item," ");
$ind2 = strpos($item," ",$ind1+1);
$type = substr($item,$ind1+1,$ind2-$ind1-1);
$ind3 = strrpos($item,"\t");
$name = substr($item,$ind3+1);
if ($type === "tree") {
$directories[$num_dirs] = after_last_slash($name);
$num_dirs++;
} else if ($type === "blob") {
$files[$num_files] = after_last_slash($name);
$num_files++;
}
}
// TODO: add support for other branches?
$tree_path = "/$project/tree/$branch" . (empty($path) ? "" : "/$path");
$blob_path = "/$project/blob/$branch" . (empty($path) ? "" : "/$path");
// command to get latest commit for an item, formatted
$latest_commit_cmd = "git log -n 1 --pretty=format:\"\t\t\t\t<td><a href=\\\"/$project/commit/%H\\\">%s</a></td>\n\t\t\t\t<td><a href=\\\"/$project/commit/%H\\\">%ar</a></td>\n\" -- ";
if (!empty($path)) {
$latest_commit_cmd = $latest_commit_cmd . "$path/";
}
// show directories first
foreach($directories as $dir) {
echo "\t\t\t<tr class=\"dir\">\n";
echo "\t\t\t\t<td><a href=\"$tree_path/$dir\">$dir</a></td>\n";
$rows = explode("\n",shell_exec("cd $git_dir && $latest_commit_cmd$dir"));
foreach ($rows as $row) {
echo "$row\n";
}
echo "\t\t\t</tr>\n";
}
// show files second
foreach($files as $file) {
echo "\t\t\t<tr class=\"file\">\n";
echo "\t\t\t\t<td><a href=\"$blob_path/$file\">$file</a></td>\n";
$rows = explode("\n",shell_exec("cd $git_dir && $latest_commit_cmd$file"));
foreach ($rows as $row) {
echo "$row\n";
}
echo "\t\t\t</tr>\n";
}
echo "\t\t</table>\n";
echo "\t\t<br/>\n\n";
?>

351
src/utils.php Normal file
View File

@ -0,0 +1,351 @@
<?php
/*
simple-gitv - a simple, libre web-based Git project viewer
Copyright (C) 2020
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
// STRING PROCESSING
/**
* If the string does not end in a slash, add one.
*
* @param $str a string
* @return the string with a final slash
*/
function add_trailing_slash($str) {
if (!empty($str) && substr($str,strlen($str)-1) !== "/") {
$str = $str . "/";
}
return $str;
}
/**
* Trim beginning until the first slash, if present.
*
* @param $str a string
* @return the substring after the first slash, or the
* original string if no slash was present
*/
function after_first_slash($str) {
$slash = strpos($str,"/");
if ($slash) {
return substr($str,$slash+1);
}
return $str;
}
/**
* Trim beginning until the last slash, if present.
*
* @param $str a string
* @return the substring after the last slash, or the
* original string if no slash was present
*/
function after_last_slash($str) {
$slash = strrpos($str,"/");
if ($slash) {
return substr($str,$slash+1);
}
return $str;
}
/**
* Trim end after the first slash, if present.
*
* @param $str a string
* @return the substring before the first slash, or the
* original string if no slash was present
*/
function before_first_slash($str) {
$slash = strpos($str,"/");
if ($slash) {
return substr($str,0,$slash);
}
return $str;
}
/**
* Trim end after the last slash, if present.
*
* @param $str a string
* @return the substring before the last slash, or the
* original string if no slash was present
*/
function before_last_slash($str) {
$slash = strrpos($str,"/");
if ($slash) {
return substr($str,0,$slash);
}
return $str;
}
/**
* @param $str a string which may begin with $target
* @param $target a string
* @return true if $str begins with $target, false otherwise
*/
function begins_with($str,$target) {
return substr($str,0,strlen($target)) === $target;
}
/**
* @param $str a string which may end with $target
* @param $target a string
* @return true if $str ends with $target, false otherwise
*/
function ends_with($str,$target) {
return substr($str,strlen($str) - strlen($target)) === $target;
}
/**
* Try to find a matching (str1 + str2)
* in the array of strings.
*
* @param $strings an array of strings
* @param $str1_arr an array of prefixes
* @param $str2_arr an array of suffixes
* @return a prefix+suffix concatenated string if it exists in $strings, an empty string otherwise
*/
function find_matching_string($strings,$str1_arr,$str2_arr) {
foreach ($strings as $str) {
foreach ($str1_arr as $str1) {
foreach ($str2_arr as $str2) {
if (strcasecmp($str,($str1 . $str2)) === 0) {
return $str;
}
}
}
}
return "";
}
/**
* Attempts to get the project's license from an array
* of project files, based on common naming conventions
*
* It was an intentional choice to use an explicit
* whitelist of filenames and extensions, instead of
* checking if it contains "license", "copying", etc. to
* avoid filenames that happen to contain those words.
*
* @param $filenames an array of filenames
* @return the filename of the license file if found, an empty string otherwise
*/
function get_license($filenames) {
$license_names = array(
"COPYING",
"LICENSE",
"COPYRIGHT"
);
$license_extensions = array(
"",
".md",
".txt"
);
return find_matching_string($filenames,$license_names,$license_extensions);
}
/**
* @param $url the URL following the domain (e.g., if the user goes to https://example.com/project/tree/main/file, $url will be project/tree/main/file)
* @return page type (specific to simple-gitv)
*/
function get_page_type($url) {
if (empty($url)) {
return "home";
} elseif (!strpos(strip_trailing_slash($url),"/")) {
return "repo";
} else {
$tree_path = "tree/";
$blob_path = "blob/";
$raw_path = "raw/";
$commits_path = "commits";
$commit_path = "commit/";
$tags_path = "tags";
if (begins_with(after_first_slash($url),$tree_path)) {
return "tree";
} elseif (begins_with(after_first_slash($url),$blob_path)) {
return "blob";
} elseif (begins_with(after_first_slash($url),$raw_path)) {
return "raw";
} elseif (begins_with(after_first_slash($url),$commits_path)) {
return "commits";
} elseif (begins_with(after_first_slash($url),$commit_path)) {
return "commit";
} elseif (begins_with(after_first_slash($url),$tags_path)) {
return "tags";
}
}
return "invalid";
}
/**
* Attempts to get the project's readme from an array
* of project files, based on common naming conventions
*
* It was an intentional choice to use an explicit
* whitelist of filenames and extensions, instead of
* checking if it contains "readme", "read_me", etc. to
* avoid filenames that happen to contain those words.
*
* @param $filenames an array of filenames
* @return the filename of the readme file if found, an empty string otherwise
*/
function get_readme($filenames) {
$license_names = array(
"README",
"READ_ME"
);
$license_extensions = array(
"",
".md",
".txt"
);
return find_matching_string($filenames,$license_names,$license_extensions);
}
/**
* @param $git_dir a git repository directory
* @return the description of the repository
*/
function get_repo_description($git_dir) {
return trim(file_get_contents("$git_dir/description"));
}
/**
* If the string ends in a slash, remove it.
*
* @param str a string
* @return the string without the final slash
*/
function strip_trailing_slash($str) {
if (!empty($str) && substr($str,strlen($str)-1) === "/") {
$str = substr($str,0,strlen($str)-1);
}
return $str;
}
// GIT METHODS
/**
* Returns a list of the names of all the branches of
* a git repo. Note, it does not prettify these names.
* The active branch will have an asterisk (*) before it.
*
* @param $git_dir a git directory
* @return a list of the names of all the branches
*/
function get_git_branches($git_dir) {
$res = shell_exec("cd $git_dir && git branch");
if (!$res) {
return false;
}
return explode("\n",trim($res));
}
/**
* Finds the git directory of a repo (e.g.,
* /srv/git/projectname or /srv/git/projectname/.git)
*
* @param $dir a directory
* @return the git directory, false if not a git directory
*/
function get_git_dir($dir) {
$git_dir = exec("cd $dir && git rev-parse --git-dir");
if (! $git_dir) {
return false;
} elseif ($git_dir === ".") {
$git_dir = "$dir";
} else {
$git_dir = "$dir/$git_dir";
}
return $git_dir;
}
/**
* @param $git_dir a git directory
* @return an integer value for the time of the last commit, returns -1 if invalid value
*/
function get_last_commit_time($git_dir) {
$time = strtotime(trim(shell_exec("cd $git_dir && git log -1 --format=%cd")));
if (!is_numeric($time)) {
return -1;
} else {
return $time;
}
}
/**
* @param $git_dir a git directory
* @return the name of the active branch
*/
function get_main_git_branch($git_dir) {
$branches = get_git_branches($git_dir);
if (! $branches) {
return false;
}
foreach ($branches as $branch) {
if (begins_with($branch,"*")) {
return substr($branch,2);
}
}
return false;
}
/**
* Determines whether a file/directory is actually in the
* git repo.
*
* @param $git_dir a git directory
* @param $path the path in the project to the blob/tree
* @return true if $path is an actual blob/tree in the project, false otherwise
*/
function is_git_file($git_dir, $path) {
$result = trim(shell_exec("cd $git_dir && git ls-tree HEAD $path"));
return !empty($result);
}
/**
* @param $git_dir a git directory
* @param $dir the path within the project to check
* @return an array of items in current directory in git
* repo, false if none
*/
function list_files($git_dir, $dir = ".") {
$dir = add_trailing_slash($dir);
$res = shell_exec("cd $git_dir && git ls-tree --name-only HEAD $dir");
if (!$res) {
return false;
}
return explode("\n",trim($res));
}
/**
* @param $git_dir a git directory
* @param $dir the path within the project to check
* @return git-ls-tree of directory, false if none
*/
function list_files_verbose($git_dir, $dir = ".") {
$dir = add_trailing_slash($dir);
$result = trim(shell_exec("cd $git_dir && git ls-tree HEAD $dir"));
if (empty($result)) {
return false;
}
$result = explode("\n",$result);
return $result;
}
?>

8
templates/config.ini.template Normal file
View File

@ -0,0 +1,8 @@
; site title or domain
title = "example.com"
; path to repositories
repositories = "/srv/git"
; theme... options: hacker, dark, dark-red, light
theme = "hacker"

86
templates/httpd-git.conf.template Normal file
View File

@ -0,0 +1,86 @@
# HTTP
<VirtualHost *:80>
# CHANGE THIS to your domain
ServerName example.com
# redirect insecure connections to HTTPS
Redirect permanent / https://example.com/
</VirtualHost>
# HTTPS
<VirtualHost *:443>
# CHANGE THIS to your domain
ServerName example.com
### TLS
SSLEngine on
# CHANGE THIS to your certificate files
SSLCertificateFile "/etc/letsencrypt/live/example.com/fullchain.pem"
SSLCertificateKeyFile "/etc/letsencrypt/live/example.com/privkey.pem"
### GIT OVER HTTP
# change this if you need
SetEnv GIT_PROJECT_ROOT /srv/git
SetEnv GIT_HTTP_EXPORT_ALL
SetEnv REMOTE_USER=$REDIRECT_REMOTE_USER
ScriptAliasMatch \
"(?x)^/(.*/(HEAD | \
info/refs | \
objects/(info/[^/]+ | \
0-9a-f]{2}/[0-9a-f]{38} | \
pack/pack-[0-9a-f]{40}\.(pack|idx)) | \
git-(upload|receive)-pack))$" \
"/usr/libexec/git-core/git-http-backend/$1"
# change this if you need
Alias /git /srv/git
<Directory /usr/libexec/git-core>
Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
AllowOverride None
Require all granted
</Directory>
<Files "git-http-backend">
AuthType Basic
AuthName "Git Access"
# change this if you need
AuthUserFile /srv/git/.htpasswd
Require expr !(%{QUERY_STRING} -strmatch '*service=git-receive-pack*' || %{REQUEST_URI} =~ m#/git-receive-pack$#)
Require valid-user
</Files>
### SERVE PROJECT FILES
# change this if you need
DocumentRoot "/var/www/git"
# change this if you need
<Directory /var/www/git>
Options FollowSymLinks
AllowOverride All
<IfModule mod_rewrite.c>
Options -MultiViews +SymLinksIfOwnerMatch
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php/$1 [L,NC]
</IfModule>
<Files config.ini>
order allow,deny
deny from all
</Files>
</Directory>
</VirtualHost>

21
templates/lighttpd-git.conf.template Normal file
View File

@ -0,0 +1,21 @@
# NOTE: This is not a complete config file, as it does not yet provide Git-over-HTTP support.
# CHANGE THIS to your domain
$HTTP["host"] == "example.com" {
# TODO: add TLS support
# TODO: add Git-over-HTTP support
server.document-root="/var/www/git"
server.modules += ("mod_rewrite", "mod_access")
# Configure url-rewriting
url.rewrite-if-not-file = (
"^/(.*)$" => "/index.php/$1"
)
# deny access to /config.ini
$HTTP["url"] =~ "^/config.ini" {
url.access-deny = ("")
}
}

70
templates/nginx-git.conf.template Normal file
View File

@ -0,0 +1,70 @@
# HTTP
server {
listen 80;
listen [::]:80;
# CHANGE THIS to your domain
server_name git.example.com;
# redirect insecure connections to HTTPS
location / {
return 301 https://$host$request_uri;
}
}
# HTTPS
server {
# TLS
listen 443 ssl;
listen [::]:443 ssl;
# CHANGE THIS to your domain
server_name git.example.com;
# CHANGE THIS to your certificate files
ssl_certificate /etc/letsencrypt/live/git.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/git.example.com/privkey.pem;
### GIT OVER HTTP
# change this if you need
# code from https://github.com/ynohat/git-http-backend/blob/master/nginx.conf
# Thank you, Anthony Hogg!
location ~ /git(/.*) {
# Set chunks to unlimited, as the bodies can be huge
client_max_body_size 0;
fastcgi_param SCRIPT_FILENAME /usr/libexec/git-core/git-http-backend;
include fastcgi_params;
fastcgi_param GIT_HTTP_EXPORT_ALL "";
fastcgi_param GIT_PROJECT_ROOT /git;
fastcgi_param PATH_INFO $1;
# Forward REMOTE_USER as we want to know when we are authenticated
fastcgi_param REMOTE_USER $remote_user;
fastcgi_pass unix:/run/fcgi.sock;
}
### SERVE PROJECT FILES
# change this if you need
root /var/www/git;
# Add index.php to the list if you are using PHP
index index.php;
location ~ \.php$ {
include snippets/fastcgi-php.conf;
fastcgi_pass unix:/run/php/php7.3-fpm.sock;
}
location ~* {
try_files $uri $uri/ /index.php;
}
}

133
themes/dark-red.css Normal file
View File

@ -0,0 +1,133 @@
/*
dark red theme - a black/red theme for simple-gitv
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
*/
/* color scheme */
:root {
--primary-color: #FF0000;
--secondary-color: #AA0000;
--background-color: #000000;
}
/* general purpose */
body {
color: var(--primary-color);
background: var(--background-color);
font-family: monospace, monospace;
overflow-wrap: break-word;
word-wrap: break-word;
}
a {
color: var(--secondary-color);
}
p.small {
font-size: small;
}
td,th {
border:1px solid var(--secondary-color);
padding: 2px;
}
code {
color: var(--background-color);
background: var(--secondary-color);
padding-bottom: 6px;
padding-left: 12px;
padding-right: 12px;
padding-top: 6px;
line-height: 2;
}
pre {
font-size: 125%;
white-space: pre-wrap;
}
hr {
color: var(--secondary-color);
}
img {
height: auto;
width: auto;
max-width: 100%;
}
/* menu */
#menu {
display: block;
clear: none;
}
#menu ul {
margin: 0;
overflow: auto;
padding: 0;
}
#menu li {
display: block;
float: left;
white-space: nowrap;
}
#menu li a {
display: block;
padding: 5px 20px 5px 20px;
text-decoration: none;
color: var(--secondary-color);
}
#menu li a:hover {
color: var(--background-color);
background: var(--secondary-color);
}
#menu li a.current {
font-weight: bold;
color: var(--primary-color);
}
#menu li a.current:hover {
color: var(--background-color);
background: var(--primary-color);
}
tr.dir {
color: var(--background-color);
background: var(--secondary-color);
border:1px solid var(--background-color);
}
tr a {
text-decoration: none;
font-weight: bold;
}
tr.dir a {
color: var(--background-color);
}
tr.file {
color: var(--primary-color);
background: var(--background-color);
border: 1px solid var(--secondary-color);
}
.box {
border: 1px solid var(--secondary-color);
padding: 2.5% 5% 2.5% 5%;
}
p.footnote {
font-size: 85%;
}

133
themes/dark.css Normal file
View File

@ -0,0 +1,133 @@
/*
dark theme - a dark theme for simple-gitv
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
*/
/* color scheme */
:root {
--primary-color: #BABABA;
--secondary-color: #FFFFFF;
--background-color: #000000;
}
/* general purpose */
body {
color: var(--primary-color);
background: var(--background-color);
font-family: monospace, monospace;
overflow-wrap: break-word;
word-wrap: break-word;
}
a {
color: var(--secondary-color);
}
p.small {
font-size: small;
}
td,th {
border:1px solid var(--secondary-color);
padding: 2px;
}
code {
color: var(--background-color);
background: var(--secondary-color);
padding-bottom: 6px;
padding-left: 12px;
padding-right: 12px;
padding-top: 6px;
line-height: 2;
}
pre {
font-size: 125%;
white-space: pre-wrap;
}
hr {
color: var(--secondary-color);
}
img {
height: auto;
width: auto;
max-width: 100%;
}
/* menu */
#menu {
display: block;
clear: none;
}
#menu ul {
margin: 0;
overflow: auto;
padding: 0;
}
#menu li {
display: block;
float: left;
white-space: nowrap;
}
#menu li a {
display: block;
padding: 5px 20px 5px 20px;
text-decoration: none;
color: var(--secondary-color);
}
#menu li a:hover {
color: var(--background-color);
background: var(--secondary-color);
}
#menu li a.current {
font-weight: bold;
color: var(--primary-color);
}
#menu li a.current:hover {
color: var(--background-color);
background: var(--primary-color);
}
tr.dir {
color: var(--background-color);
background: var(--secondary-color);
border:1px solid var(--background-color);
}
tr a {
text-decoration: none;
font-weight: bold;
}
tr.dir a {
color: var(--background-color);
}
tr.file {
color: var(--primary-color);
background: var(--background-color);
border: 1px solid var(--secondary-color);
}
.box {
border: 1px solid var(--secondary-color);
padding: 2.5% 5% 2.5% 5%;
}
p.footnote {
font-size: 85%;
}

133
themes/hacker.css Normal file
View File

@ -0,0 +1,133 @@
/*
hacker theme - a hacker theme for simple-gitv
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
*/
/* color scheme */
:root {
--primary-color: #5DFC0A;
--secondary-color: #00FF00;
--background-color: #000000;
}
/* general purpose */
body {
color: var(--primary-color);
background: var(--background-color);
font-family: monospace, monospace;
overflow-wrap: break-word;
word-wrap: break-word;
}
a {
color: var(--secondary-color);
}
p.small {
font-size: small;
}
td,th {
border:1px solid var(--secondary-color);
padding: 2px;
}
code {
color: var(--background-color);
background: var(--secondary-color);
padding-bottom: 6px;
padding-left: 12px;
padding-right: 12px;
padding-top: 6px;
line-height: 2;
}
pre {
font-size: 125%;
white-space: pre-wrap;
}
hr {
color: var(--secondary-color);
}
img {
height: auto;
width: auto;
max-width: 100%;
}
/* menu */
#menu {
display: block;
clear: none;
}
#menu ul {
margin: 0;
overflow: auto;
padding: 0;
}
#menu li {
display: block;
float: left;
white-space: nowrap;
}
#menu li a {
display: block;
padding: 5px 20px 5px 20px;
text-decoration: none;
color: var(--secondary-color);
}
#menu li a:hover {
color: var(--background-color);
background: var(--secondary-color);
}
#menu li a.current {
font-weight: bold;
color: var(--primary-color);
}
#menu li a.current:hover {
color: var(--background-color);
background: var(--primary-color);
}
tr.dir {
color: var(--background-color);
background: var(--secondary-color);
border:1px solid var(--background-color);
}
tr a {
text-decoration: none;
font-weight: bold;
}
tr.dir a {
color: var(--background-color);
}
tr.file {
color: var(--primary-color);
background: var(--background-color);
border: 1px solid var(--secondary-color);
}
.box {
border: 1px solid var(--secondary-color);
padding: 2.5% 5% 2.5% 5%;
}
p.footnote {
font-size: 85%;
}

133
themes/light.css Normal file
View File

@ -0,0 +1,133 @@
/*
light theme - a light theme for simple-gitv
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
*/
/* color scheme */
:root {
--primary-color: #000000;
--secondary-color: #666666;
--background-color: #FFFFFF;
}
/* general purpose */
body {
color: var(--primary-color);
background: var(--background-color);
font-family: monospace, monospace;
overflow-wrap: break-word;
word-wrap: break-word;
}
a {
color: var(--secondary-color);
}
p.small {
font-size: small;
}
td,th {
border:1px solid var(--secondary-color);
padding: 2px;
}
code {
color: var(--background-color);
background: var(--secondary-color);
padding-bottom: 6px;
padding-left: 12px;
padding-right: 12px;
padding-top: 6px;
line-height: 2;
}
pre {
font-size: 125%;
white-space: pre-wrap;
}
hr {
color: var(--secondary-color);
}
img {
height: auto;
width: auto;
max-width: 100%;
}
/* menu */
#menu {
display: block;
clear: none;
}
#menu ul {
margin: 0;
overflow: auto;
padding: 0;
}
#menu li {
display: block;
float: left;
white-space: nowrap;
}
#menu li a {
display: block;
padding: 5px 20px 5px 20px;
text-decoration: none;
color: var(--secondary-color);
}
#menu li a:hover {
color: var(--background-color);
background: var(--secondary-color);
}
#menu li a.current {
font-weight: bold;
color: var(--primary-color);
}
#menu li a.current:hover {
color: var(--background-color);
background: var(--primary-color);
}
tr.dir {
color: var(--background-color);
background: var(--secondary-color);
border:1px solid var(--background-color);
}
tr a {
text-decoration: none;
font-weight: bold;
}
tr.dir a {
color: var(--background-color);
}
tr.file {
color: var(--primary-color);
background: var(--background-color);
border: 1px solid var(--secondary-color);
}
.box {
border: 1px solid var(--secondary-color);
padding: 2.5% 5% 2.5% 5%;
}
p.footnote {
font-size: 85%;
}