SUMMARY
New field is added to settings to receive email of the admin of the
instance. source_code is a link to the repository of the source code
of a GitPad instance, set_source_code is defined to build a HTTP
link to the exact commit from which the instance binary was built.
NOTE
Current Settings::set_source_code assumes the provided HTTP link to
point to a forge belonging to the GitHub-family(GitHub, Gitea and
GitLab), provisions must be made to accommodate other forges as
well.
DESCRIPTION
Each comment is uniquely identified by database assigned, serially
incremented ID. Access controlled REST endpoint is added to delete
comment by ID.
ERRORS RETURNED
- Gist doesn't exist: 404 GistNotFound
- Gist is private and requesting user is not owner or is not visible
to user: 404 GistNotFound
- Gist exists and is visible to requesting user but comment doesn't
exist: 404 CommentNotFound
- Gist exists and is visible to requesting user is not comment owner
: 401 UnauthorizedOperation
DESCRIPTION
Get all comments on a gist. Access controlled but optionally
authenticated HTTP REST endpoint is added to get comment by ID.
ERRORS RETURNED
- Gist doesn't exist: 404 GistNotFound
- Gist is private and requesting user is not owner or is not
authenticated: 404 GistNotFound
DESCRIPTION
Each comment is uniquely identified by database assigned, serially
incremented ID. Access controlled but optionally authenticated HTTP
REST endpoint is added to get comment by ID.
ERRORS RETURNED
- Gist doesn't exist: 404 GistNotFound
- Gist is private and requesting user is not ower or is not
authenticated: 404 GistNotFound
- Comment is empty: 400 EmptyComment
- Gist exists and is visible to requesting user but comment doesn't
exist: 404 CommentNotFound
SUMMARY
Comment on gist and utilities to generate post comment REST
endpoint route from username and gist public ID component
ERRORS
- Gist doesn't exist, 404 GistNotFound is returned
- Gist is private and commenting user is not ower, 404 GistNotFound
is returned
- Comment is empty, 400 EmptyComment is returned
SUMMARY
Optionally authenticated endpoint to read file in gist repository.
Subject to gist visibility.
DESCRIPTION
crate::api::v1::gists::read_file
- Parses URI for gist owner, gist public ID and file path.
- Contents of gists with private visibility are only returned
to owner of gists. Identity determined using session cookies.
- Contents are Unlisted and Public visibility gists are
accessible by both unauthenticated and authenticated
users(authenticated but not owner).
SUMMARY
This program supports directories in gists. This patch modifies
Data::read_file to support directory reads. Additionally,
CreateGistRequest is modified to accept files in subdirectories.
DESCRIPTION
Data::read_file
When repository contains subdirectories, it will recursively
read all files and return their contents.
crate::data::api::v1::gists::GitFileMode
Set of known(to me) file modes that Git uses.
GitFileMode::Unsupported is used to take advantage of
num_enum::FromPrimitive. The alternative would have been
num_enum::TryFromPrimitive, which returns errors on unsupported
values. I felt the former was cleaner.
SUMMARY
Binary content is essential to store images. ContentType enum
accommodates both utf-8 and and non utf-8 encodings.
Data::write_file and Data::read_file are modified to handle
ContentType enum
SUMMARY
Data::write_file
Creates a new files and commits them to "master" branch on the
bare repository allocated for the gist. If multiple files are
supplied, all files are written and committed in a single
commit.
Currently, empty commit message is used but this should probably
be changed.
If filename includes spaces it is escaped. Example "foo bar".txt
is escaped and converted into "foo\ bar".txt.
Data::read_file
Reads files already committed to the repository allocated for
the gist. This method expects filenames provided to be already
escaped. Failure would result in file not found errors
Data::get_repository_path
Receives gist public ID and returns path of the repository
allocated for the gist. Programmers are expected to use this
method to work on the repositories instead of manually
constructing paths.
crate::utils::escape_spaces
Escapes spaces in the provided string, "foo bar".txt is
converted to "foo\ bar".txt
DESCRIPTION
Data::new_gist creates a bare repository in the supplied
Data.settings.repository.root directory and saves metadata in the
database
See accompanying test for usage
The following changes are implemented for both db-sqlx-postgres and
db-sqlx-sqlite:
TABLE gists_gists
Stores gist metadata with unique index on gists_gists.public_id for fast
lookups
TABLE gists_comments
Stores comment metadata
TABLE gists_privacy
Stores gist privacy: sqlx currently doesn't have support Postgres
enums(ref: https://github.com/launchbadge/sqlx/issues/1171), so storing
possible privacy values as references from this table.
This table shouldn't be mutated during runtime. Possible values are
already recorded in database during migrations. All runtime operations
on this table must only take references.
Each implementation of GistDatabase also includes a method called
privacy_exists, which is called during tests to ensure that
migrations are successful.
VIEW gists_gists_view
Gist lookups combines data from gists_users, gists_gists and
gists_privacy. This SQL view boots performance(I think?). At any rate,
it is much nicer to work with.
QUIRKS
Database indexes are i64 in SQLite while i32 in Postgres
AUTHENTICATION
- Sign Up
- Sign IN
ACCOUNT
- Username Exists
- Email Exists
- Account delete
- Password update
- Email update
- Username update
- Get account secret
- Update secret
All routes are implemented with proper error handling and testing
CONFIGURATION
See ./config/default.toml for full list
