mirror of
https://github.com/Sonny93/my-links.git
synced 2025-12-09 07:03:25 +00:00
Compare commits
84 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
466c8dec3a | ||
|
|
b2b388b77e | ||
|
|
a073fac47b | ||
|
|
4c2e9ddc82 | ||
|
|
ea8350bb61 | ||
|
|
9463a711f6 | ||
|
|
d68fcd9fc8 | ||
|
|
a984b53686 | ||
|
|
1346bc33f6 | ||
|
|
3ecbe78671 | ||
|
|
1ad7c2d56c | ||
|
|
276abc4009 | ||
|
|
9250e5f0b4 | ||
|
|
81f4cd7f87 | ||
|
|
a3651e8370 | ||
|
|
83c1966946 | ||
|
|
798ff0fbe4 | ||
|
|
d3de34bd41 | ||
|
|
9781363282 | ||
|
|
174a21288a | ||
|
|
6eb88871e8 | ||
|
|
34d2abcc13 | ||
|
|
69d0487777 | ||
|
|
9a215f3e41 | ||
|
|
5c37fe9c31 | ||
|
|
861906d29b | ||
|
|
8bd87b5bba | ||
|
|
db578dbe51 | ||
|
|
41f82a8070 | ||
|
|
7fba156168 | ||
|
|
8b24354c0e | ||
|
|
8953b9a64e | ||
|
|
6f807e51e8 | ||
|
|
40069905fa | ||
|
|
d01bfaeec2 | ||
|
|
343160f324 | ||
|
|
cc1e7b91c0 | ||
|
|
c7c70b1767 | ||
|
|
d796e4d38a | ||
|
|
01a21ddef8 | ||
|
|
bcad333783 | ||
|
|
13bff28876 | ||
|
|
757788bf9b | ||
|
|
907dda300e | ||
|
|
edc7972a2f | ||
|
|
d66e92adbc | ||
|
|
6d568b133f | ||
|
|
0ce3e3d39d | ||
|
|
e77b7cc176 | ||
|
|
1a102ebc5f | ||
|
|
1da9f0baf4 | ||
|
|
bce00c7855 | ||
|
|
5c4ee3a1cd | ||
|
|
8d474f74eb | ||
|
|
5453b7f965 | ||
|
|
71ce65e2aa | ||
|
|
05c867f44f | ||
|
|
57373ff0b6 | ||
|
|
2fda4aabdd | ||
|
|
bc376a72ee | ||
|
|
d360a9044c | ||
|
|
8b4e5740d7 | ||
|
|
c8fb5af44d | ||
|
|
24cea2b0b2 | ||
|
|
eea9732100 | ||
|
|
f425decf2c | ||
|
|
8b57f6dd47 | ||
|
|
dda6fc299a | ||
|
|
b0e3bfa0f6 | ||
|
|
9d4eb08bc9 | ||
|
|
f8e7e7cd64 | ||
|
|
cda3a89f32 | ||
|
|
ed4dbca329 | ||
|
|
f8a92b7219 | ||
|
|
161db362b3 | ||
|
|
a5e542a33f | ||
|
|
f0ec6d6b3d | ||
|
|
442a1003bb | ||
|
|
2c499a7789 | ||
|
|
5baa9e1c35 | ||
|
|
fd896db872 | ||
|
|
a45d534fa0 | ||
|
|
5d083327a8 | ||
|
|
136fcfac5d |
@@ -3,7 +3,7 @@
|
|||||||
root = true
|
root = true
|
||||||
|
|
||||||
[*]
|
[*]
|
||||||
indent_style = space
|
indent_style = tab
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
end_of_line = lf
|
end_of_line = lf
|
||||||
charset = utf-8
|
charset = utf-8
|
||||||
@@ -17,8 +17,5 @@ insert_final_newline = unset
|
|||||||
indent_style = unset
|
indent_style = unset
|
||||||
insert_final_newline = unset
|
insert_final_newline = unset
|
||||||
|
|
||||||
[MakeFile]
|
|
||||||
indent_style = space
|
|
||||||
|
|
||||||
[*.md]
|
[*.md]
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# node ace generate:key
|
# node ace generate:key
|
||||||
APP_KEY=UfdS996001I_koCN1OiZiSh-DJZTyvGc
|
APP_KEY=soY8ZAtItT_fCkNUADfgffZUUo675lOj
|
||||||
TZ=UTC
|
TZ=UTC
|
||||||
PORT=3333
|
PORT=3333
|
||||||
HOST=localhost
|
HOST=localhost
|
||||||
|
|||||||
30
.github/workflows/cd.yml
vendored
30
.github/workflows/cd.yml
vendored
@@ -36,18 +36,18 @@ jobs:
|
|||||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||||
labels: ${{ steps.docker_meta.outputs.labels }}
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||||
|
|
||||||
# execute_commands_via_ssh:
|
execute_commands_via_ssh:
|
||||||
# name: Pull latest docker image and start up the application with Docker Compose
|
name: Pull latest docker image and start up the application with Docker Compose
|
||||||
# runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
# needs: push_image_to_docker_hub
|
needs: push_image_to_docker_hub
|
||||||
# steps:
|
steps:
|
||||||
# - name: Executing remote ssh commands
|
- name: Executing remote ssh commands
|
||||||
# uses: appleboy/ssh-action@master
|
uses: appleboy/ssh-action@master
|
||||||
# with:
|
with:
|
||||||
# host: ${{ secrets.SSH_HOST }}
|
host: ${{ secrets.SSH_HOST }}
|
||||||
# port: ${{ secrets.SSH_PORT }}
|
port: ${{ secrets.SSH_PORT }}
|
||||||
# username: ${{ secrets.SSH_USERNAME }}
|
username: ${{ secrets.SSH_USERNAME }}
|
||||||
# key: ${{ secrets.SSH_KEY }}
|
key: ${{ secrets.SSH_KEY }}
|
||||||
# script: |
|
script: |
|
||||||
# cd /infra/my-links
|
cd /infra/my-links
|
||||||
# sh startup.sh
|
sh startup.sh
|
||||||
|
|||||||
@@ -1,4 +1 @@
|
|||||||
#!/usr/bin/env sh
|
|
||||||
. "$(dirname -- "$0")/_/husky.sh"
|
|
||||||
|
|
||||||
npx lint-staged
|
npx lint-staged
|
||||||
|
|||||||
3
.vscode/extensions.json
vendored
Normal file
3
.vscode/extensions.json
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"recommendations": ["vunguyentuan.vscode-css-variables"]
|
||||||
|
}
|
||||||
19
.vscode/settings.json
vendored
19
.vscode/settings.json
vendored
@@ -1,3 +1,20 @@
|
|||||||
{
|
{
|
||||||
"typescript.preferences.importModuleSpecifier": "non-relative"
|
"typescript.preferences.importModuleSpecifier": "non-relative",
|
||||||
|
/* Prefer tabs over spaces for accessibility */
|
||||||
|
"editor.insertSpaces": false,
|
||||||
|
"editor.detectIndentation": false,
|
||||||
|
/* Explorer */
|
||||||
|
"explorer.fileNesting.enabled": true,
|
||||||
|
"explorer.fileNesting.patterns": {
|
||||||
|
"*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
|
||||||
|
"package.json": "pnpm-lock.yaml, tsconfig.json, eslint.config.js, .babelrc, vite.config.ts, .editorconfig",
|
||||||
|
"Makefile": "*compose.yml, Dockerfile, servers_pgadmin.json, .dockerignore"
|
||||||
|
},
|
||||||
|
"cssVariables.lookupFiles": [
|
||||||
|
"**/*.css",
|
||||||
|
"**/*.scss",
|
||||||
|
"**/*.sass",
|
||||||
|
"**/*.less",
|
||||||
|
"node_modules/@mantine/core/styles.css"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
61
CONTRIBUTING
Normal file
61
CONTRIBUTING
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
## Contributing to MyLinks
|
||||||
|
|
||||||
|
First of all, thank you for considering contributing to MyLinks! We appreciate your time and efforts, and we want to make the contribution process as smooth and transparent as possible.
|
||||||
|
|
||||||
|
### Table of Contents
|
||||||
|
|
||||||
|
- [How to Contribute](#how-to-contribute)
|
||||||
|
- [Code of Conduct](#code-of-conduct)
|
||||||
|
- [Bug Reports and Feature Requests](#bug-reports-and-feature-requests)
|
||||||
|
- [Pull Requests](#pull-requests)
|
||||||
|
- [Development Setup](#development-setup)
|
||||||
|
- [Community](#community)
|
||||||
|
|
||||||
|
### How to Contribute
|
||||||
|
|
||||||
|
There are several ways to contribute to MyLinks:
|
||||||
|
- Reporting bugs
|
||||||
|
- Suggesting new features
|
||||||
|
- Improving the documentation
|
||||||
|
- Writing or improving tests
|
||||||
|
- Submitting code enhancements
|
||||||
|
|
||||||
|
### Code of Conduct
|
||||||
|
|
||||||
|
We are committed to fostering a welcoming community. Please review our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand our expectations for all contributors.
|
||||||
|
|
||||||
|
### Bug Reports and Feature Requests
|
||||||
|
|
||||||
|
If you encounter any bugs or have ideas for new features, please create an issue in our [GitHub Issues](https://github.com/your-repo-url/issues). When reporting bugs, please provide:
|
||||||
|
- A clear description of the problem.
|
||||||
|
- Steps to reproduce the issue.
|
||||||
|
- Any relevant log/error messages.
|
||||||
|
|
||||||
|
For feature requests, please describe:
|
||||||
|
- The problem you aim to solve.
|
||||||
|
- How the feature could benefit users.
|
||||||
|
|
||||||
|
### Pull Requests
|
||||||
|
|
||||||
|
When making a pull request (PR), please adhere to the following guidelines:
|
||||||
|
1. Fork the repository and create your branch from `main` (or the default branch).
|
||||||
|
2. Run `pnpm run lint` and ensure your code passes the linter checks.
|
||||||
|
3. Add tests for new features or bug fixes.
|
||||||
|
4. Ensure your code passes existing tests (`pnpm run test`).
|
||||||
|
5. Clearly describe the purpose of your pull request. Provide relevant issue numbers if applicable.
|
||||||
|
|
||||||
|
To create a pull request:
|
||||||
|
1. Push your branch to your forked repository.
|
||||||
|
2. Submit a pull request (PR) to the `main` branch of MyLinks.
|
||||||
|
|
||||||
|
> **Note:** All contributions are reviewed by maintainers. We may request changes or improvements before merging.
|
||||||
|
|
||||||
|
### Development Setup
|
||||||
|
|
||||||
|
For instructions on setting up your development environment, please refer to the [Getting Started](./README.md#getting-started) section in the `README.md`.
|
||||||
|
|
||||||
|
### Community
|
||||||
|
|
||||||
|
Feel free to join our community discussions on [our Trello board](https://trello.com/b/CwxkMeZp/mylinks) to collaborate on ideas, issues, and features!
|
||||||
|
|
||||||
|
Thank you for helping make MyLinks better!
|
||||||
10
Dockerfile
10
Dockerfile
@@ -1,6 +1,6 @@
|
|||||||
# Source : https://github.com/adonisjs-community/adonis-packages/blob/main/Dockerfile
|
# Source : https://github.com/adonisjs-community/adonis-packages/blob/main/Dockerfile
|
||||||
|
|
||||||
FROM node:20-alpine3.18 AS base
|
FROM node:22.11-alpine3.20 AS base
|
||||||
|
|
||||||
RUN apk --no-cache add curl
|
RUN apk --no-cache add curl
|
||||||
RUN corepack enable
|
RUN corepack enable
|
||||||
@@ -8,14 +8,14 @@ RUN corepack enable
|
|||||||
# All deps stage
|
# All deps stage
|
||||||
FROM base AS deps
|
FROM base AS deps
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
ADD package.json package-lock.json ./
|
ADD package.json pnpm-lock.yaml ./
|
||||||
RUN npm install --ignore-scripts
|
RUN pnpm install --ignore-scripts
|
||||||
|
|
||||||
# Production only deps stage
|
# Production only deps stage
|
||||||
FROM base AS production-deps
|
FROM base AS production-deps
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
ADD package.json package-lock.json ./
|
ADD package.json pnpm-lock.yaml ./
|
||||||
RUN npm install --ignore-scripts
|
RUN pnpm install --ignore-scripts --prod
|
||||||
|
|
||||||
# Build stage
|
# Build stage
|
||||||
FROM base AS build
|
FROM base AS build
|
||||||
|
|||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
22
Makefile
22
Makefile
@@ -1,19 +1,21 @@
|
|||||||
dev:
|
dev:
|
||||||
docker compose down
|
@docker compose down
|
||||||
docker compose -f dev.docker-compose.yml up -d --wait
|
@docker compose -f dev.compose.yml pull
|
||||||
node ace migration:fresh
|
@docker compose -f dev.compose.yml up -d --wait
|
||||||
npm run dev
|
@node ace migration:fresh
|
||||||
|
@pnpm run dev
|
||||||
|
|
||||||
prod:
|
prod:
|
||||||
docker compose -f dev.docker-compose.yml down
|
@docker compose -f dev.compose.yml down
|
||||||
docker compose up -d --build --wait
|
@docker compose pull
|
||||||
|
@docker compose up -d --build --wait
|
||||||
|
|
||||||
seed:
|
seed:
|
||||||
node ace db:seed
|
@node ace db:seed
|
||||||
|
|
||||||
down:
|
down:
|
||||||
-docker compose down
|
@-docker compose down
|
||||||
-docker compose -f dev.docker-compose.yml down
|
@-docker compose -f dev.compose.yml down
|
||||||
|
|
||||||
release:
|
release:
|
||||||
npm run release
|
@pnpm run release
|
||||||
|
|||||||
81
README.md
81
README.md
@@ -1,62 +1,97 @@
|
|||||||
# MyLinks
|

|
||||||
|
|
||||||
MyLinks is a tool that lets you manage your favorite links in an intuitive interface.
|
<div align="center">
|
||||||
Free and open source software, focused on privacy and self-hosting.
|
<h1>MyLinks</h1>
|
||||||
|
<p>Another bookmark manager that lets you manage and share<br>your favorite links in an intuitive interface</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://github.com/my-links/my-links/issues"><img src="https://img.shields.io/github/issues/my-links/my-links.svg" alt="GitHub Issues"></a>
|
||||||
|
<a href="https://github.com/my-links/my-links/blob/main/LICENSE"><img src="https://img.shields.io/github/license/my-links/my-links.svg" alt="License"></a>
|
||||||
|
<a href="https://trello.com/b/CwxkMeZp/mylinks"><img src="https://img.shields.io/badge/roadmap-Trello-blue" alt="Project Roadmap"></a>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
# Setup
|
## Table of Contents
|
||||||
|
- [Main Features](#main-features)
|
||||||
|
- [Getting Started](#getting-started)
|
||||||
|
- [Setup](#setup)
|
||||||
|
- [Development](#development)
|
||||||
|
- [Using Docker](#docker)
|
||||||
|
- [Using PNPM](#pnpm)
|
||||||
|
- [Production](#start-as-prod)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Generate app_key](#generate_app_key)
|
||||||
|
- [GitHub Actions](#github-actions)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
Copy `example.env` file as `.env` and edit the properties.
|
## Main Features
|
||||||
|
|
||||||
```
|
- **Organize bookmarks with collections**: Keep your links tidy and easily accessible by grouping them into customizable collections.
|
||||||
|
- **Intuitive link management**: Add, edit, and manage your bookmarks effortlessly with a user-friendly interface.
|
||||||
|
- **Powerful search functionality**: Quickly locate any bookmark using the robust search feature, enhancing your productivity.
|
||||||
|
- **Privacy-focused and open-source**: Enjoy a secure, transparent experience with an open-source platform that prioritizes your privacy.
|
||||||
|
- **Browser extension (coming soon)**: Seamlessly integrate MyLinks into your browsing experience with the upcoming official browser extension.
|
||||||
|
- **Shareable collections**: Easily share your curated collections with others, facilitating collaboration and information sharing.
|
||||||
|
- **Community-driven development**: Contribute to MyLinks by suggesting improvements and features, helping to shape the tool to better meet user needs.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
Copy the `example.env` file to `.env` and edit the properties:
|
||||||
|
|
||||||
|
```bash
|
||||||
cp example.env .env
|
cp example.env .env
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
### Development
|
||||||
|
|
||||||
### Docker
|
#### Docker
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make dev
|
make dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### NPM
|
#### PNPM
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# reset database and (force) apply all migrations
|
# reset database and (force) apply all migrations
|
||||||
node ace migration:fresh
|
node ace migration:fresh
|
||||||
# start dev server
|
# start dev server
|
||||||
npm run dev
|
pnpm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Start as prod
|
### Start as prod
|
||||||
|
|
||||||
### Docker
|
#### Docker
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make prod
|
make prod
|
||||||
```
|
```
|
||||||
|
|
||||||
### NPM
|
#### PNPM
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# create production build
|
# create production build
|
||||||
npm run build
|
pnpm run build
|
||||||
# go to the build folder
|
# go to the build folder
|
||||||
cd build
|
cd build
|
||||||
# clone your .env
|
# clone your .env
|
||||||
cp ../.env .
|
cp ../.env .
|
||||||
# then start the production build
|
# then start the production build
|
||||||
npm run start
|
pnpm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
## Generate app_key
|
## Configuration
|
||||||
|
|
||||||
|
### Generate app_key
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# generate a random app key
|
# generate a random app key
|
||||||
openssl rand -base64 32
|
openssl rand -base64 32
|
||||||
```
|
```
|
||||||
|
|
||||||
## GitHub Actions
|
### GitHub Actions
|
||||||
|
|
||||||
Env var to define :
|
Env var to define :
|
||||||
|
|
||||||
@@ -87,3 +122,15 @@ ssh-copy-id -i ./id_rsa.pub user@host
|
|||||||
```
|
```
|
||||||
|
|
||||||
> Source: https://github.com/appleboy/ssh-action#setting-up-a-ssh-key
|
> Source: https://github.com/appleboy/ssh-action#setting-up-a-ssh-key
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
We welcome contributions! Please visit our Trello board for project management and roadmap details. You can contribute by:
|
||||||
|
|
||||||
|
- Creating issues for bugs, features, or discussions.
|
||||||
|
- Submitting pull requests (PRs) with bug fixes, new features, or documentation updates.
|
||||||
|
|
||||||
|
For detailed contribution guidelines, refer to the CONTRIBUTING.md file.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the [GPLv3 License](./LICENCE).
|
||||||
|
|||||||
3
ace.js
3
ace.js
@@ -19,8 +19,7 @@
|
|||||||
/**
|
/**
|
||||||
* Register hook to process TypeScript files using ts-node
|
* Register hook to process TypeScript files using ts-node
|
||||||
*/
|
*/
|
||||||
import { register } from 'node:module';
|
import 'ts-node-maintained/register/esm';
|
||||||
register('ts-node/esm', import.meta.url);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Import ace console entrypoint
|
* Import ace console entrypoint
|
||||||
|
|||||||
124
adonisrc.ts
124
adonisrc.ts
@@ -1,7 +1,7 @@
|
|||||||
import { defineConfig } from '@adonisjs/core/app';
|
import { defineConfig } from '@adonisjs/core/app';
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Commands
|
| Commands
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
@@ -10,13 +10,13 @@ export default defineConfig({
|
|||||||
| will be scanned automatically from the "./commands" directory.
|
| will be scanned automatically from the "./commands" directory.
|
||||||
|
|
|
|
||||||
*/
|
*/
|
||||||
commands: [
|
commands: [
|
||||||
() => import('@adonisjs/core/commands'),
|
() => import('@adonisjs/core/commands'),
|
||||||
() => import('@adonisjs/lucid/commands'),
|
() => import('@adonisjs/lucid/commands'),
|
||||||
() => import('@izzyjs/route/commands'),
|
() => import('@izzyjs/route/commands'),
|
||||||
],
|
],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Service providers
|
| Service providers
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
@@ -25,29 +25,29 @@ export default defineConfig({
|
|||||||
| application
|
| application
|
||||||
|
|
|
|
||||||
*/
|
*/
|
||||||
providers: [
|
providers: [
|
||||||
() => import('@adonisjs/core/providers/app_provider'),
|
() => import('@adonisjs/core/providers/app_provider'),
|
||||||
() => import('@adonisjs/core/providers/hash_provider'),
|
() => import('@adonisjs/core/providers/hash_provider'),
|
||||||
{
|
{
|
||||||
file: () => import('@adonisjs/core/providers/repl_provider'),
|
file: () => import('@adonisjs/core/providers/repl_provider'),
|
||||||
environment: ['repl', 'test'],
|
environment: ['repl', 'test'],
|
||||||
},
|
},
|
||||||
() => import('@adonisjs/core/providers/vinejs_provider'),
|
() => import('@adonisjs/core/providers/vinejs_provider'),
|
||||||
() => import('@adonisjs/core/providers/edge_provider'),
|
() => import('@adonisjs/core/providers/edge_provider'),
|
||||||
() => import('@adonisjs/session/session_provider'),
|
() => import('@adonisjs/session/session_provider'),
|
||||||
() => import('@adonisjs/vite/vite_provider'),
|
() => import('@adonisjs/vite/vite_provider'),
|
||||||
() => import('@adonisjs/shield/shield_provider'),
|
() => import('@adonisjs/shield/shield_provider'),
|
||||||
() => import('@adonisjs/static/static_provider'),
|
() => import('@adonisjs/static/static_provider'),
|
||||||
() => import('@adonisjs/cors/cors_provider'),
|
() => import('@adonisjs/cors/cors_provider'),
|
||||||
() => import('@adonisjs/lucid/database_provider'),
|
() => import('@adonisjs/lucid/database_provider'),
|
||||||
() => import('@adonisjs/auth/auth_provider'),
|
() => import('@adonisjs/auth/auth_provider'),
|
||||||
() => import('@adonisjs/inertia/inertia_provider'),
|
() => import('@adonisjs/inertia/inertia_provider'),
|
||||||
() => import('@adonisjs/ally/ally_provider'),
|
() => import('@adonisjs/ally/ally_provider'),
|
||||||
() => import('@izzyjs/route/izzy_provider'),
|
() => import('@izzyjs/route/izzy_provider'),
|
||||||
() => import('#providers/route_provider'),
|
() => import('#providers/route_provider'),
|
||||||
],
|
],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Preloads
|
| Preloads
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
@@ -55,9 +55,9 @@ export default defineConfig({
|
|||||||
| List of modules to import before starting the application.
|
| List of modules to import before starting the application.
|
||||||
|
|
|
|
||||||
*/
|
*/
|
||||||
preloads: [() => import('#start/routes'), () => import('#start/kernel')],
|
preloads: [() => import('#start/routes'), () => import('#start/kernel')],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Tests
|
| Tests
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
@@ -66,23 +66,23 @@ export default defineConfig({
|
|||||||
| and add additional suites.
|
| and add additional suites.
|
||||||
|
|
|
|
||||||
*/
|
*/
|
||||||
tests: {
|
tests: {
|
||||||
suites: [
|
suites: [
|
||||||
{
|
{
|
||||||
files: ['tests/unit/**/*.spec(.ts|.js)'],
|
files: ['tests/unit/**/*.spec(.ts|.js)'],
|
||||||
name: 'unit',
|
name: 'unit',
|
||||||
timeout: 2000,
|
timeout: 2000,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
files: ['tests/functional/**/*.spec(.ts|.js)'],
|
files: ['tests/functional/**/*.spec(.ts|.js)'],
|
||||||
name: 'functional',
|
name: 'functional',
|
||||||
timeout: 30000,
|
timeout: 30000,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
forceExit: false,
|
forceExit: false,
|
||||||
},
|
},
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Metafiles
|
| Metafiles
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
@@ -91,20 +91,20 @@ export default defineConfig({
|
|||||||
| the production build.
|
| the production build.
|
||||||
|
|
|
|
||||||
*/
|
*/
|
||||||
metaFiles: [
|
metaFiles: [
|
||||||
{
|
{
|
||||||
pattern: 'resources/views/**/*.edge',
|
pattern: 'resources/views/**/*.edge',
|
||||||
reloadServer: false,
|
reloadServer: false,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
pattern: 'public/**',
|
pattern: 'public/**',
|
||||||
reloadServer: false,
|
reloadServer: false,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|
||||||
assetsBundler: false,
|
assetsBundler: false,
|
||||||
unstable_assembler: {
|
unstable_assembler: {
|
||||||
onBuildStarting: [() => import('@adonisjs/vite/build_hook')],
|
onBuildStarting: [() => import('@adonisjs/vite/build_hook')],
|
||||||
onDevServerStarted: [() => import('@izzyjs/route/dev_hook')],
|
onDevServerStarted: [() => import('@izzyjs/route/dev_hook')],
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -8,12 +8,12 @@ const ARROW_UP = 'ArrowUp';
|
|||||||
const ARROW_DOWN = 'ArrowDown';
|
const ARROW_DOWN = 'ArrowDown';
|
||||||
|
|
||||||
const KEYS = {
|
const KEYS = {
|
||||||
ARROW_DOWN,
|
ARROW_DOWN,
|
||||||
ARROW_UP,
|
ARROW_UP,
|
||||||
ESCAPE_KEY,
|
ESCAPE_KEY,
|
||||||
OPEN_CREATE_COLLECTION_KEY,
|
OPEN_CREATE_COLLECTION_KEY,
|
||||||
OPEN_CREATE_LINK_KEY,
|
OPEN_CREATE_LINK_KEY,
|
||||||
OPEN_SEARCH_KEY,
|
OPEN_SEARCH_KEY,
|
||||||
};
|
};
|
||||||
|
|
||||||
export default KEYS;
|
export default KEYS;
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
const PATHS = {
|
const PATHS = {
|
||||||
AUTHOR: 'https://www.sonny.dev/',
|
AUTHOR: 'https://www.sonny.dev/?utm_source=mylinks',
|
||||||
REPO_GITHUB: 'https://github.com/Sonny93/my-links',
|
REPO_GITHUB: 'https://github.com/Sonny93/my-links',
|
||||||
EXTENSION:
|
EXTENSION:
|
||||||
'https://chromewebstore.google.com/detail/mylinks/agkmlplihacolkakgeccnbhphnepphma',
|
'https://chromewebstore.google.com/detail/mylinks/agkmlplihacolkakgeccnbhphnepphma',
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
export default PATHS;
|
export default PATHS;
|
||||||
|
|||||||
@@ -6,41 +6,41 @@ import { inject } from '@adonisjs/core';
|
|||||||
import type { HttpContext } from '@adonisjs/core/http';
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
|
|
||||||
class UserWithRelationCountDto {
|
class UserWithRelationCountDto {
|
||||||
constructor(private user: User) {}
|
constructor(private user: User) {}
|
||||||
|
|
||||||
toJson = () => ({
|
toJson = () => ({
|
||||||
id: this.user.id,
|
id: this.user.id,
|
||||||
email: this.user.email,
|
email: this.user.email,
|
||||||
fullname: this.user.name,
|
fullname: this.user.name,
|
||||||
avatarUrl: this.user.avatarUrl,
|
avatarUrl: this.user.avatarUrl,
|
||||||
isAdmin: this.user.isAdmin,
|
isAdmin: this.user.isAdmin,
|
||||||
createdAt: this.user.createdAt,
|
createdAt: this.user.createdAt.toString(),
|
||||||
updatedAt: this.user.updatedAt,
|
updatedAt: this.user.updatedAt.toString(),
|
||||||
count: {
|
lastSeenAt:
|
||||||
link: Number(this.user.$extras.totalLinks),
|
this.user.lastSeenAt?.toString() ?? this.user.updatedAt.toString(),
|
||||||
collection: Number(this.user.$extras.totalCollections),
|
linksCount: Number(this.user.$extras.totalLinks),
|
||||||
},
|
collectionsCount: Number(this.user.$extras.totalCollections),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@inject()
|
@inject()
|
||||||
export default class AdminController {
|
export default class AdminController {
|
||||||
constructor(
|
constructor(
|
||||||
protected usersController: UsersController,
|
protected usersController: UsersController,
|
||||||
protected linksController: LinksController,
|
protected linksController: LinksController,
|
||||||
protected collectionsController: CollectionsController
|
protected collectionsController: CollectionsController
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
async index({ inertia }: HttpContext) {
|
async index({ inertia }: HttpContext) {
|
||||||
const users = await this.usersController.getAllUsersWithTotalRelations();
|
const users = await this.usersController.getAllUsersWithTotalRelations();
|
||||||
const linksCount = await this.linksController.getTotalLinksCount();
|
const linksCount = await this.linksController.getTotalLinksCount();
|
||||||
const collectionsCount =
|
const collectionsCount =
|
||||||
await this.collectionsController.getTotalCollectionsCount();
|
await this.collectionsController.getTotalCollectionsCount();
|
||||||
|
|
||||||
return inertia.render('admin/dashboard', {
|
return inertia.render('admin/dashboard', {
|
||||||
users: users.map((user) => new UserWithRelationCountDto(user).toJson()),
|
users: users.map((user) => new UserWithRelationCountDto(user).toJson()),
|
||||||
totalLinks: linksCount,
|
totalLinks: linksCount,
|
||||||
totalCollections: collectionsCount,
|
totalCollections: collectionsCount,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,11 +3,11 @@ import { updateUserThemeValidator } from '#validators/user';
|
|||||||
import type { HttpContext } from '@adonisjs/core/http';
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
|
|
||||||
export default class AppsController {
|
export default class AppsController {
|
||||||
async updateUserTheme({ request, session, response }: HttpContext) {
|
async updateUserTheme({ request, session, response }: HttpContext) {
|
||||||
const { preferDarkTheme } = await request.validateUsing(
|
const { preferDarkTheme } = await request.validateUsing(
|
||||||
updateUserThemeValidator
|
updateUserThemeValidator
|
||||||
);
|
);
|
||||||
session.put(PREFER_DARK_THEME, preferDarkTheme);
|
session.put(PREFER_DARK_THEME, preferDarkTheme);
|
||||||
return response.ok({ message: 'ok' });
|
return response.ok({ message: 'ok' });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,141 +1,143 @@
|
|||||||
import Collection from '#models/collection';
|
import Collection from '#models/collection';
|
||||||
import User from '#models/user';
|
import User from '#models/user';
|
||||||
import {
|
import {
|
||||||
createCollectionValidator,
|
createCollectionValidator,
|
||||||
deleteCollectionValidator,
|
deleteCollectionValidator,
|
||||||
updateCollectionValidator,
|
updateCollectionValidator,
|
||||||
} from '#validators/collection';
|
} from '#validators/collection';
|
||||||
import type { HttpContext } from '@adonisjs/core/http';
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
import db from '@adonisjs/lucid/services/db';
|
import db from '@adonisjs/lucid/services/db';
|
||||||
|
|
||||||
export default class CollectionsController {
|
export default class CollectionsController {
|
||||||
// Dashboard
|
// Dashboard
|
||||||
async index({ auth, inertia, request, response }: HttpContext) {
|
async index({ auth, inertia, request, response }: HttpContext) {
|
||||||
const collections = await this.getCollectionsByAuthorId(auth.user!.id);
|
const collections = await this.getCollectionsByAuthorId(auth.user!.id);
|
||||||
if (collections.length === 0) {
|
if (collections.length === 0) {
|
||||||
return response.redirectToNamedRoute('collection.create-form');
|
return response.redirectToNamedRoute('collection.create-form');
|
||||||
}
|
}
|
||||||
|
|
||||||
const activeCollectionId = Number(request.qs()?.collectionId ?? '');
|
const activeCollectionId = Number(request.qs()?.collectionId ?? '');
|
||||||
const activeCollection = collections.find(
|
const activeCollection = collections.find(
|
||||||
(c) => c.id === activeCollectionId
|
(c) => c.id === activeCollectionId
|
||||||
);
|
);
|
||||||
|
|
||||||
if (!activeCollection && !!activeCollectionId) {
|
if (!activeCollection && !!activeCollectionId) {
|
||||||
return response.redirectToNamedRoute('dashboard');
|
return response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
return inertia.render('dashboard', {
|
// TODO: Create DTOs
|
||||||
collections,
|
return inertia.render('dashboard', {
|
||||||
activeCollection: activeCollection || collections[0],
|
collections: collections.map((collection) => collection.serialize()),
|
||||||
});
|
activeCollection:
|
||||||
}
|
activeCollection?.serialize() || collections[0].serialize(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// Create collection form
|
// Create collection form
|
||||||
async showCreatePage({ inertia, auth }: HttpContext) {
|
async showCreatePage({ inertia, auth }: HttpContext) {
|
||||||
const collections = await this.getCollectionsByAuthorId(auth.user!.id);
|
const collections = await this.getCollectionsByAuthorId(auth.user!.id);
|
||||||
return inertia.render('collections/create', {
|
return inertia.render('collections/create', {
|
||||||
disableHomeLink: collections.length === 0,
|
disableHomeLink: collections.length === 0,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// Method called when creating a collection
|
// Method called when creating a collection
|
||||||
async store({ request, response, auth }: HttpContext) {
|
async store({ request, response, auth }: HttpContext) {
|
||||||
const payload = await request.validateUsing(createCollectionValidator);
|
const payload = await request.validateUsing(createCollectionValidator);
|
||||||
const collection = await Collection.create({
|
const collection = await Collection.create({
|
||||||
...payload,
|
...payload,
|
||||||
authorId: auth.user?.id!,
|
authorId: auth.user?.id!,
|
||||||
});
|
});
|
||||||
return this.redirectToCollectionId(response, collection.id);
|
return this.redirectToCollectionId(response, collection.id);
|
||||||
}
|
}
|
||||||
|
|
||||||
async showEditPage({ auth, request, inertia, response }: HttpContext) {
|
async showEditPage({ auth, request, inertia, response }: HttpContext) {
|
||||||
const collectionId = request.qs()?.collectionId;
|
const collectionId = request.qs()?.collectionId;
|
||||||
if (!collectionId) {
|
if (!collectionId) {
|
||||||
return response.redirectToNamedRoute('dashboard');
|
return response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
const collection = await this.getCollectionById(
|
const collection = await this.getCollectionById(
|
||||||
collectionId,
|
collectionId,
|
||||||
auth.user!.id
|
auth.user!.id
|
||||||
);
|
);
|
||||||
return inertia.render('collections/edit', {
|
return inertia.render('collections/edit', {
|
||||||
collection,
|
collection,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async update({ request, auth, response }: HttpContext) {
|
async update({ request, auth, response }: HttpContext) {
|
||||||
const { params, ...payload } = await request.validateUsing(
|
const { params, ...payload } = await request.validateUsing(
|
||||||
updateCollectionValidator
|
updateCollectionValidator
|
||||||
);
|
);
|
||||||
|
|
||||||
// Cant use validator (vinejs) custom rule 'cause its too generic,
|
// Cant use validator (vinejs) custom rule 'cause its too generic,
|
||||||
// because we have to find a collection by identifier and
|
// because we have to find a collection by identifier and
|
||||||
// check whether the current user is the author.
|
// check whether the current user is the author.
|
||||||
// https://vinejs.dev/docs/extend/custom_rules
|
// https://vinejs.dev/docs/extend/custom_rules
|
||||||
await this.getCollectionById(params.id, auth.user!.id);
|
await this.getCollectionById(params.id, auth.user!.id);
|
||||||
|
|
||||||
await Collection.updateOrCreate(
|
await Collection.updateOrCreate(
|
||||||
{
|
{
|
||||||
id: params.id,
|
id: params.id,
|
||||||
},
|
},
|
||||||
payload
|
payload
|
||||||
);
|
);
|
||||||
return this.redirectToCollectionId(response, params.id);
|
return this.redirectToCollectionId(response, params.id);
|
||||||
}
|
}
|
||||||
|
|
||||||
async showDeletePage({ auth, request, inertia, response }: HttpContext) {
|
async showDeletePage({ auth, request, inertia, response }: HttpContext) {
|
||||||
const collectionId = request.qs()?.collectionId;
|
const collectionId = request.qs()?.collectionId;
|
||||||
if (!collectionId) {
|
if (!collectionId) {
|
||||||
return response.redirectToNamedRoute('dashboard');
|
return response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
const collection = await this.getCollectionById(
|
const collection = await this.getCollectionById(
|
||||||
collectionId,
|
collectionId,
|
||||||
auth.user!.id
|
auth.user!.id
|
||||||
);
|
);
|
||||||
return inertia.render('collections/delete', {
|
return inertia.render('collections/delete', {
|
||||||
collection,
|
collection,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async delete({ request, auth, response }: HttpContext) {
|
async delete({ request, auth, response }: HttpContext) {
|
||||||
const { params } = await request.validateUsing(deleteCollectionValidator);
|
const { params } = await request.validateUsing(deleteCollectionValidator);
|
||||||
const collection = await this.getCollectionById(params.id, auth.user!.id);
|
const collection = await this.getCollectionById(params.id, auth.user!.id);
|
||||||
await collection.delete();
|
await collection.delete();
|
||||||
return response.redirectToNamedRoute('dashboard');
|
return response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
async getTotalCollectionsCount() {
|
async getTotalCollectionsCount() {
|
||||||
const totalCount = await db.from('collections').count('* as total');
|
const totalCount = await db.from('collections').count('* as total');
|
||||||
return Number(totalCount[0].total);
|
return Number(totalCount[0].total);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get collection by id.
|
* Get collection by id.
|
||||||
*
|
*
|
||||||
* /!\ Only return private collection (create by the current user)
|
* /!\ Only return private collection (create by the current user)
|
||||||
*/
|
*/
|
||||||
async getCollectionById(id: Collection['id'], userId: User['id']) {
|
async getCollectionById(id: Collection['id'], userId: User['id']) {
|
||||||
return await Collection.query()
|
return await Collection.query()
|
||||||
.where('id', id)
|
.where('id', id)
|
||||||
.andWhere('author_id', userId)
|
.andWhere('author_id', userId)
|
||||||
.firstOrFail();
|
.firstOrFail();
|
||||||
}
|
}
|
||||||
|
|
||||||
async getCollectionsByAuthorId(authorId: User['id']) {
|
async getCollectionsByAuthorId(authorId: User['id']) {
|
||||||
return await Collection.query()
|
return await Collection.query()
|
||||||
.where('author_id', authorId)
|
.where('author_id', authorId)
|
||||||
.orderBy('created_at')
|
.orderBy('created_at')
|
||||||
.preload('links');
|
.preload('links');
|
||||||
}
|
}
|
||||||
|
|
||||||
redirectToCollectionId(
|
redirectToCollectionId(
|
||||||
response: HttpContext['response'],
|
response: HttpContext['response'],
|
||||||
collectionId: Collection['id']
|
collectionId: Collection['id']
|
||||||
) {
|
) {
|
||||||
return response.redirectToNamedRoute('dashboard', {
|
return response.redirectToNamedRoute('dashboard', {
|
||||||
qs: { collectionId },
|
qs: { collectionId },
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,156 +5,156 @@ import logger from '@adonisjs/core/services/logger';
|
|||||||
import { parse } from 'node-html-parser';
|
import { parse } from 'node-html-parser';
|
||||||
|
|
||||||
interface Favicon {
|
interface Favicon {
|
||||||
buffer: Buffer;
|
buffer: Buffer;
|
||||||
url: string;
|
url: string;
|
||||||
type: string;
|
type: string;
|
||||||
size: number;
|
size: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default class FaviconsController {
|
export default class FaviconsController {
|
||||||
private userAgent =
|
private userAgent =
|
||||||
'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.0.0';
|
'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.0.0';
|
||||||
private relList = [
|
private relList = [
|
||||||
'icon',
|
'icon',
|
||||||
'shortcut icon',
|
'shortcut icon',
|
||||||
'apple-touch-icon',
|
'apple-touch-icon',
|
||||||
'apple-touch-icon-precomposed',
|
'apple-touch-icon-precomposed',
|
||||||
'apple-touch-startup-image',
|
'apple-touch-startup-image',
|
||||||
'mask-icon',
|
'mask-icon',
|
||||||
'fluid-icon',
|
'fluid-icon',
|
||||||
];
|
];
|
||||||
|
|
||||||
async index(ctx: HttpContext) {
|
async index(ctx: HttpContext) {
|
||||||
const url = ctx.request.qs()?.url;
|
const url = ctx.request.qs()?.url;
|
||||||
if (!url) {
|
if (!url) {
|
||||||
throw new Error('Missing URL');
|
throw new Error('Missing URL');
|
||||||
}
|
}
|
||||||
|
|
||||||
const cacheNs = cache.namespace('favicon');
|
const cacheNs = cache.namespace('favicon');
|
||||||
const favicon = await cacheNs.getOrSet({
|
const favicon = await cacheNs.getOrSet({
|
||||||
key: url,
|
key: url,
|
||||||
ttl: '1h',
|
ttl: '1h',
|
||||||
factory: () => this.tryGetFavicon(url),
|
factory: () => this.tryGetFavicon(url),
|
||||||
});
|
});
|
||||||
return this.sendImage(ctx, favicon);
|
return this.sendImage(ctx, favicon);
|
||||||
}
|
}
|
||||||
|
|
||||||
private async tryGetFavicon(url: string): Promise<Favicon> {
|
private async tryGetFavicon(url: string): Promise<Favicon> {
|
||||||
const faviconUrl = this.buildFaviconUrl(url, '/favicon.ico');
|
const faviconUrl = this.buildFaviconUrl(url, '/favicon.ico');
|
||||||
try {
|
try {
|
||||||
return await this.fetchFavicon(faviconUrl);
|
return await this.fetchFavicon(faviconUrl);
|
||||||
} catch {
|
} catch {
|
||||||
logger.debug(`Unable to retrieve favicon from ${faviconUrl}`);
|
logger.debug(`Unable to retrieve favicon from ${faviconUrl}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const documentText = await this.fetchDocumentText(url);
|
const documentText = await this.fetchDocumentText(url);
|
||||||
const faviconPath = this.extractFaviconPath(documentText);
|
const faviconPath = this.extractFaviconPath(documentText);
|
||||||
|
|
||||||
if (!faviconPath) {
|
if (!faviconPath) {
|
||||||
throw new FaviconNotFoundException(`No favicon path found in ${url}`);
|
throw new FaviconNotFoundException(`No favicon path found in ${url}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (faviconPath.startsWith('http')) {
|
if (faviconPath.startsWith('http')) {
|
||||||
try {
|
try {
|
||||||
return await this.fetchFavicon(faviconPath);
|
return await this.fetchFavicon(faviconPath);
|
||||||
} catch {
|
} catch {
|
||||||
logger.debug(`Unable to retrieve favicon from ${faviconPath}`);
|
logger.debug(`Unable to retrieve favicon from ${faviconPath}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return this.fetchFaviconFromPath(url, faviconPath);
|
return this.fetchFaviconFromPath(url, faviconPath);
|
||||||
}
|
}
|
||||||
|
|
||||||
private async fetchFavicon(url: string): Promise<Favicon> {
|
private async fetchFavicon(url: string): Promise<Favicon> {
|
||||||
const response = await this.fetchWithUserAgent(url);
|
const response = await this.fetchWithUserAgent(url);
|
||||||
if (!response.ok) {
|
if (!response.ok) {
|
||||||
throw new FaviconNotFoundException(`Request to favicon ${url} failed`);
|
throw new FaviconNotFoundException(`Request to favicon ${url} failed`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const blob = await response.blob();
|
const blob = await response.blob();
|
||||||
if (!this.isImage(blob.type) || blob.size === 0) {
|
if (!this.isImage(blob.type) || blob.size === 0) {
|
||||||
throw new FaviconNotFoundException(`Invalid image at ${url}`);
|
throw new FaviconNotFoundException(`Invalid image at ${url}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
buffer: Buffer.from(await blob.arrayBuffer()),
|
buffer: Buffer.from(await blob.arrayBuffer()),
|
||||||
url: response.url,
|
url: response.url,
|
||||||
type: blob.type,
|
type: blob.type,
|
||||||
size: blob.size,
|
size: blob.size,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
private async fetchDocumentText(url: string): Promise<string> {
|
private async fetchDocumentText(url: string): Promise<string> {
|
||||||
const response = await this.fetchWithUserAgent(url);
|
const response = await this.fetchWithUserAgent(url);
|
||||||
if (!response.ok) {
|
if (!response.ok) {
|
||||||
throw new FaviconNotFoundException(`Request to ${url} failed`);
|
throw new FaviconNotFoundException(`Request to ${url} failed`);
|
||||||
}
|
}
|
||||||
|
|
||||||
return await response.text();
|
return await response.text();
|
||||||
}
|
}
|
||||||
|
|
||||||
private extractFaviconPath(html: string): string | undefined {
|
private extractFaviconPath(html: string): string | undefined {
|
||||||
const document = parse(html);
|
const document = parse(html);
|
||||||
const link = document
|
const link = document
|
||||||
.getElementsByTagName('link')
|
.getElementsByTagName('link')
|
||||||
.find((element) => this.relList.includes(element.getAttribute('rel')!));
|
.find((element) => this.relList.includes(element.getAttribute('rel')!));
|
||||||
return link?.getAttribute('href');
|
return link?.getAttribute('href');
|
||||||
}
|
}
|
||||||
|
|
||||||
private async fetchFaviconFromPath(
|
private async fetchFaviconFromPath(
|
||||||
baseUrl: string,
|
baseUrl: string,
|
||||||
path: string
|
path: string
|
||||||
): Promise<Favicon> {
|
): Promise<Favicon> {
|
||||||
if (this.isBase64Image(path)) {
|
if (this.isBase64Image(path)) {
|
||||||
const buffer = this.convertBase64ToBuffer(path);
|
const buffer = this.convertBase64ToBuffer(path);
|
||||||
return {
|
return {
|
||||||
buffer,
|
buffer,
|
||||||
type: 'image/x-icon',
|
type: 'image/x-icon',
|
||||||
size: buffer.length,
|
size: buffer.length,
|
||||||
url: path,
|
url: path,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const faviconUrl = this.buildFaviconUrl(baseUrl, path);
|
const faviconUrl = this.buildFaviconUrl(baseUrl, path);
|
||||||
return this.fetchFavicon(faviconUrl);
|
return this.fetchFavicon(faviconUrl);
|
||||||
}
|
}
|
||||||
|
|
||||||
private buildFaviconUrl(base: string, path: string): string {
|
private buildFaviconUrl(base: string, path: string): string {
|
||||||
const { origin } = new URL(base);
|
const { origin } = new URL(base);
|
||||||
if (path.startsWith('/')) {
|
if (path.startsWith('/')) {
|
||||||
return origin + path;
|
return origin + path;
|
||||||
}
|
}
|
||||||
|
|
||||||
const basePath = this.urlWithoutSearchParams(base);
|
const basePath = this.urlWithoutSearchParams(base);
|
||||||
const baseUrl = basePath.endsWith('/') ? basePath.slice(0, -1) : basePath;
|
const baseUrl = basePath.endsWith('/') ? basePath.slice(0, -1) : basePath;
|
||||||
return `${baseUrl}/${path}`;
|
return `${baseUrl}/${path}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
private urlWithoutSearchParams(url: string): string {
|
private urlWithoutSearchParams(url: string): string {
|
||||||
const { protocol, host, pathname } = new URL(url);
|
const { protocol, host, pathname } = new URL(url);
|
||||||
return `${protocol}//${host}${pathname}`;
|
return `${protocol}//${host}${pathname}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
private isImage(type: string): boolean {
|
private isImage(type: string): boolean {
|
||||||
return type.startsWith('image/');
|
return type.startsWith('image/');
|
||||||
}
|
}
|
||||||
|
|
||||||
private isBase64Image(data: string): boolean {
|
private isBase64Image(data: string): boolean {
|
||||||
return data.startsWith('data:image/');
|
return data.startsWith('data:image/');
|
||||||
}
|
}
|
||||||
|
|
||||||
private convertBase64ToBuffer(base64: string): Buffer {
|
private convertBase64ToBuffer(base64: string): Buffer {
|
||||||
return Buffer.from(base64.split(',')[1], 'base64');
|
return Buffer.from(base64.split(',')[1], 'base64');
|
||||||
}
|
}
|
||||||
|
|
||||||
private async fetchWithUserAgent(url: string): Promise<Response> {
|
private async fetchWithUserAgent(url: string): Promise<Response> {
|
||||||
const headers = new Headers({ 'User-Agent': this.userAgent });
|
const headers = new Headers({ 'User-Agent': this.userAgent });
|
||||||
return fetch(url, { headers });
|
return fetch(url, { headers });
|
||||||
}
|
}
|
||||||
|
|
||||||
private sendImage(ctx: HttpContext, { buffer, type, size }: Favicon) {
|
private sendImage(ctx: HttpContext, { buffer, type, size }: Favicon) {
|
||||||
ctx.response.header('Content-Type', type);
|
ctx.response.header('Content-Type', type);
|
||||||
ctx.response.header('Content-Length', size.toString());
|
ctx.response.header('Content-Length', size.toString());
|
||||||
ctx.response.send(buffer, true);
|
ctx.response.send(buffer, true);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
import CollectionsController from '#controllers/collections_controller';
|
import CollectionsController from '#controllers/collections_controller';
|
||||||
import Link from '#models/link';
|
import Link from '#models/link';
|
||||||
import {
|
import {
|
||||||
createLinkValidator,
|
createLinkValidator,
|
||||||
deleteLinkValidator,
|
deleteLinkValidator,
|
||||||
updateLinkFavoriteStatusValidator,
|
updateLinkFavoriteStatusValidator,
|
||||||
updateLinkValidator,
|
updateLinkValidator,
|
||||||
} from '#validators/link';
|
} from '#validators/link';
|
||||||
import { inject } from '@adonisjs/core';
|
import { inject } from '@adonisjs/core';
|
||||||
import type { HttpContext } from '@adonisjs/core/http';
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
@@ -12,120 +12,120 @@ import db from '@adonisjs/lucid/services/db';
|
|||||||
|
|
||||||
@inject()
|
@inject()
|
||||||
export default class LinksController {
|
export default class LinksController {
|
||||||
constructor(protected collectionsController: CollectionsController) {}
|
constructor(protected collectionsController: CollectionsController) {}
|
||||||
|
|
||||||
async showCreatePage({ auth, inertia }: HttpContext) {
|
async showCreatePage({ auth, inertia }: HttpContext) {
|
||||||
const collections =
|
const collections =
|
||||||
await this.collectionsController.getCollectionsByAuthorId(auth.user!.id);
|
await this.collectionsController.getCollectionsByAuthorId(auth.user!.id);
|
||||||
return inertia.render('links/create', { collections });
|
return inertia.render('links/create', { collections });
|
||||||
}
|
}
|
||||||
|
|
||||||
async store({ auth, request, response }: HttpContext) {
|
async store({ auth, request, response }: HttpContext) {
|
||||||
const { collectionId, ...payload } =
|
const { collectionId, ...payload } =
|
||||||
await request.validateUsing(createLinkValidator);
|
await request.validateUsing(createLinkValidator);
|
||||||
|
|
||||||
await this.collectionsController.getCollectionById(
|
await this.collectionsController.getCollectionById(
|
||||||
collectionId,
|
collectionId,
|
||||||
auth.user!.id
|
auth.user!.id
|
||||||
);
|
);
|
||||||
await Link.create({
|
await Link.create({
|
||||||
...payload,
|
...payload,
|
||||||
collectionId,
|
collectionId,
|
||||||
authorId: auth.user?.id!,
|
authorId: auth.user?.id!,
|
||||||
});
|
});
|
||||||
return this.collectionsController.redirectToCollectionId(
|
return this.collectionsController.redirectToCollectionId(
|
||||||
response,
|
response,
|
||||||
collectionId
|
collectionId
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
async showEditPage({ auth, inertia, request, response }: HttpContext) {
|
async showEditPage({ auth, inertia, request, response }: HttpContext) {
|
||||||
const linkId = request.qs()?.linkId;
|
const linkId = request.qs()?.linkId;
|
||||||
if (!linkId) {
|
if (!linkId) {
|
||||||
return response.redirectToNamedRoute('dashboard');
|
return response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
const userId = auth.user!.id;
|
const userId = auth.user!.id;
|
||||||
const collections =
|
const collections =
|
||||||
await this.collectionsController.getCollectionsByAuthorId(userId);
|
await this.collectionsController.getCollectionsByAuthorId(userId);
|
||||||
const link = await this.getLinkById(linkId, userId);
|
const link = await this.getLinkById(linkId, userId);
|
||||||
|
|
||||||
return inertia.render('links/edit', { collections, link });
|
return inertia.render('links/edit', { collections, link });
|
||||||
}
|
}
|
||||||
|
|
||||||
async update({ request, auth, response }: HttpContext) {
|
async update({ request, auth, response }: HttpContext) {
|
||||||
const { params, ...payload } =
|
const { params, ...payload } =
|
||||||
await request.validateUsing(updateLinkValidator);
|
await request.validateUsing(updateLinkValidator);
|
||||||
|
|
||||||
// Throw if invalid link id provided
|
// Throw if invalid link id provided
|
||||||
await this.getLinkById(params.id, auth.user!.id);
|
await this.getLinkById(params.id, auth.user!.id);
|
||||||
|
|
||||||
await Link.updateOrCreate(
|
await Link.updateOrCreate(
|
||||||
{
|
{
|
||||||
id: params.id,
|
id: params.id,
|
||||||
},
|
},
|
||||||
payload
|
payload
|
||||||
);
|
);
|
||||||
|
|
||||||
return response.redirectToNamedRoute('dashboard', {
|
return response.redirectToNamedRoute('dashboard', {
|
||||||
qs: { collectionId: payload.collectionId },
|
qs: { collectionId: payload.collectionId },
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async toggleFavorite({ request, auth, response }: HttpContext) {
|
async toggleFavorite({ request, auth, response }: HttpContext) {
|
||||||
const { params, favorite } = await request.validateUsing(
|
const { params, favorite } = await request.validateUsing(
|
||||||
updateLinkFavoriteStatusValidator
|
updateLinkFavoriteStatusValidator
|
||||||
);
|
);
|
||||||
|
|
||||||
// Throw if invalid link id provided
|
// Throw if invalid link id provided
|
||||||
await this.getLinkById(params.id, auth.user!.id);
|
await this.getLinkById(params.id, auth.user!.id);
|
||||||
|
|
||||||
await Link.updateOrCreate(
|
await Link.updateOrCreate(
|
||||||
{
|
{
|
||||||
id: params.id,
|
id: params.id,
|
||||||
},
|
},
|
||||||
{ favorite }
|
{ favorite }
|
||||||
);
|
);
|
||||||
|
|
||||||
return response.json({ status: 'ok' });
|
return response.json({ status: 'ok' });
|
||||||
}
|
}
|
||||||
|
|
||||||
async showDeletePage({ auth, inertia, request, response }: HttpContext) {
|
async showDeletePage({ auth, inertia, request, response }: HttpContext) {
|
||||||
const linkId = request.qs()?.linkId;
|
const linkId = request.qs()?.linkId;
|
||||||
if (!linkId) {
|
if (!linkId) {
|
||||||
return response.redirectToNamedRoute('dashboard');
|
return response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
const link = await this.getLinkById(linkId, auth.user!.id);
|
const link = await this.getLinkById(linkId, auth.user!.id);
|
||||||
await link.load('collection');
|
await link.load('collection');
|
||||||
return inertia.render('links/delete', { link });
|
return inertia.render('links/delete', { link });
|
||||||
}
|
}
|
||||||
|
|
||||||
async delete({ request, auth, response }: HttpContext) {
|
async delete({ request, auth, response }: HttpContext) {
|
||||||
const { params } = await request.validateUsing(deleteLinkValidator);
|
const { params } = await request.validateUsing(deleteLinkValidator);
|
||||||
|
|
||||||
const link = await this.getLinkById(params.id, auth.user!.id);
|
const link = await this.getLinkById(params.id, auth.user!.id);
|
||||||
await link.delete();
|
await link.delete();
|
||||||
|
|
||||||
return response.redirectToNamedRoute('dashboard', {
|
return response.redirectToNamedRoute('dashboard', {
|
||||||
qs: { collectionId: link.id },
|
qs: { collectionId: link.id },
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async getTotalLinksCount() {
|
async getTotalLinksCount() {
|
||||||
const totalCount = await db.from('links').count('* as total');
|
const totalCount = await db.from('links').count('* as total');
|
||||||
return Number(totalCount[0].total);
|
return Number(totalCount[0].total);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get link by id.
|
* Get link by id.
|
||||||
*
|
*
|
||||||
* /!\ Only return private link (create by the current user)
|
* /!\ Only return private link (create by the current user)
|
||||||
*/
|
*/
|
||||||
private async getLinkById(id: Link['id'], userId: Link['id']) {
|
private async getLinkById(id: Link['id'], userId: Link['id']) {
|
||||||
return await Link.query()
|
return await Link.query()
|
||||||
.where('id', id)
|
.where('id', id)
|
||||||
.andWhere('author_id', userId)
|
.andWhere('author_id', userId)
|
||||||
.firstOrFail();
|
.firstOrFail();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,17 +2,17 @@ import type { HttpContext } from '@adonisjs/core/http';
|
|||||||
import db from '@adonisjs/lucid/services/db';
|
import db from '@adonisjs/lucid/services/db';
|
||||||
|
|
||||||
export default class SearchesController {
|
export default class SearchesController {
|
||||||
async search({ request, auth }: HttpContext) {
|
async search({ request, auth }: HttpContext) {
|
||||||
const term = request.qs()?.term;
|
const term = request.qs()?.term;
|
||||||
if (!term) {
|
if (!term) {
|
||||||
console.warn('qs term null');
|
console.warn('qs term null');
|
||||||
return { error: 'missing "term" query param' };
|
return { error: 'missing "term" query param' };
|
||||||
}
|
}
|
||||||
|
|
||||||
const { rows } = await db.rawQuery('SELECT * FROM search_text(?, ?)', [
|
const { rows } = await db.rawQuery('SELECT * FROM search_text(?, ?)', [
|
||||||
term,
|
term,
|
||||||
auth.user!.id,
|
auth.user!.id,
|
||||||
]);
|
]);
|
||||||
return { results: rows };
|
return { results: rows };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,24 +1,61 @@
|
|||||||
import { Visibility } from '#enums/visibility';
|
import { Visibility } from '#enums/visibility';
|
||||||
import Collection from '#models/collection';
|
import Collection from '#models/collection';
|
||||||
|
import Link from '#models/link';
|
||||||
|
import User from '#models/user';
|
||||||
import { getSharedCollectionValidator } from '#validators/shared_collection';
|
import { getSharedCollectionValidator } from '#validators/shared_collection';
|
||||||
import type { HttpContext } from '@adonisjs/core/http';
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
|
|
||||||
export default class SharedCollectionsController {
|
class LinkWithoutFavoriteDto {
|
||||||
async index({ request, inertia }: HttpContext) {
|
constructor(private link: Link) {}
|
||||||
const { params } = await request.validateUsing(
|
|
||||||
getSharedCollectionValidator
|
|
||||||
);
|
|
||||||
|
|
||||||
const collection = await this.getSharedCollectionById(params.id);
|
toJson = () => ({
|
||||||
return inertia.render('shared', { collection });
|
id: this.link.id,
|
||||||
}
|
name: this.link.name,
|
||||||
|
description: this.link.description,
|
||||||
private async getSharedCollectionById(id: Collection['id']) {
|
url: this.link.url,
|
||||||
return await Collection.query()
|
collectionId: this.link.collectionId,
|
||||||
.where('id', id)
|
createdAt: this.link.createdAt.toString(),
|
||||||
.andWhere('visibility', Visibility.PUBLIC)
|
updatedAt: this.link.updatedAt.toString(),
|
||||||
.preload('links')
|
});
|
||||||
.preload('author')
|
}
|
||||||
.firstOrFail();
|
|
||||||
}
|
class UserWithoutEmailDto {
|
||||||
|
constructor(private user: User) {}
|
||||||
|
|
||||||
|
toJson = () => ({
|
||||||
|
id: this.user.id,
|
||||||
|
fullname: this.user.name,
|
||||||
|
avatarUrl: this.user.avatarUrl,
|
||||||
|
isAdmin: this.user.isAdmin,
|
||||||
|
createdAt: this.user.createdAt.toString(),
|
||||||
|
updatedAt: this.user.updatedAt.toString(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export default class SharedCollectionsController {
|
||||||
|
async index({ request, inertia }: HttpContext) {
|
||||||
|
const { params } = await request.validateUsing(
|
||||||
|
getSharedCollectionValidator
|
||||||
|
);
|
||||||
|
|
||||||
|
const collection = await this.getSharedCollectionById(params.id);
|
||||||
|
return inertia.render('shared', { collection });
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getSharedCollectionById(id: Collection['id']) {
|
||||||
|
const collection = await Collection.query()
|
||||||
|
.where('id', id)
|
||||||
|
.andWhere('visibility', Visibility.PUBLIC)
|
||||||
|
.preload('links')
|
||||||
|
.preload('author')
|
||||||
|
.firstOrFail();
|
||||||
|
|
||||||
|
return {
|
||||||
|
...collection.serialize(),
|
||||||
|
links: collection.links.map((link) =>
|
||||||
|
new LinkWithoutFavoriteDto(link).toJson()
|
||||||
|
),
|
||||||
|
author: new UserWithoutEmailDto(collection.author).toJson(),
|
||||||
|
};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,74 +5,74 @@ import db from '@adonisjs/lucid/services/db';
|
|||||||
import { RouteName } from '@izzyjs/route/types';
|
import { RouteName } from '@izzyjs/route/types';
|
||||||
|
|
||||||
export default class UsersController {
|
export default class UsersController {
|
||||||
private redirectTo: RouteName = 'auth.login';
|
private redirectTo: RouteName = 'auth';
|
||||||
|
|
||||||
login({ inertia }: HttpContext) {
|
login({ inertia }: HttpContext) {
|
||||||
return inertia.render('login');
|
return inertia.render('login');
|
||||||
}
|
}
|
||||||
|
|
||||||
google = ({ ally }: HttpContext) => ally.use('google').redirect();
|
google = ({ ally }: HttpContext) => ally.use('google').redirect();
|
||||||
|
|
||||||
async callbackAuth({ ally, auth, response, session }: HttpContext) {
|
async callbackAuth({ ally, auth, response, session }: HttpContext) {
|
||||||
const google = ally.use('google');
|
const google = ally.use('google');
|
||||||
if (google.accessDenied()) {
|
if (google.accessDenied()) {
|
||||||
// TODO: translate error messages + show them in UI
|
// TODO: translate error messages + show them in UI
|
||||||
session.flash('flash', 'Access was denied');
|
session.flash('flash', 'Access was denied');
|
||||||
return response.redirectToNamedRoute(this.redirectTo);
|
return response.redirectToNamedRoute(this.redirectTo);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (google.stateMisMatch()) {
|
if (google.stateMisMatch()) {
|
||||||
session.flash('flash', 'Request expired. Retry again');
|
session.flash('flash', 'Request expired. Retry again');
|
||||||
return response.redirectToNamedRoute(this.redirectTo);
|
return response.redirectToNamedRoute(this.redirectTo);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (google.hasError()) {
|
if (google.hasError()) {
|
||||||
session.flash('flash', google.getError() || 'Something went wrong');
|
session.flash('flash', google.getError() || 'Something went wrong');
|
||||||
return response.redirectToNamedRoute(this.redirectTo);
|
return response.redirectToNamedRoute(this.redirectTo);
|
||||||
}
|
}
|
||||||
|
|
||||||
const userCount = await db.from('users').count('* as total');
|
const userCount = await db.from('users').count('* as total');
|
||||||
const {
|
const {
|
||||||
email,
|
email,
|
||||||
id: providerId,
|
id: providerId,
|
||||||
name,
|
name,
|
||||||
nickName,
|
nickName,
|
||||||
avatarUrl,
|
avatarUrl,
|
||||||
token,
|
token,
|
||||||
} = await google.user();
|
} = await google.user();
|
||||||
const user = await User.updateOrCreate(
|
const user = await User.updateOrCreate(
|
||||||
{
|
{
|
||||||
email,
|
email,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
email,
|
email,
|
||||||
providerId,
|
providerId,
|
||||||
name,
|
name,
|
||||||
nickName,
|
nickName,
|
||||||
avatarUrl,
|
avatarUrl,
|
||||||
token,
|
token,
|
||||||
providerType: 'google',
|
providerType: 'google',
|
||||||
isAdmin: userCount[0].total === '0' ? true : undefined,
|
isAdmin: userCount[0].total === '0' ? true : undefined,
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
await auth.use('web').login(user);
|
await auth.use('web').login(user);
|
||||||
session.flash('flash', 'Successfully authenticated');
|
session.flash('flash', 'Successfully authenticated');
|
||||||
logger.info(`[${user.email}] auth success`);
|
logger.info(`[${user.email}] auth success`);
|
||||||
|
|
||||||
response.redirectToNamedRoute('dashboard');
|
response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
|
|
||||||
async logout({ auth, response, session }: HttpContext) {
|
async logout({ auth, response, session }: HttpContext) {
|
||||||
await auth.use('web').logout();
|
await auth.use('web').logout();
|
||||||
session.flash('flash', 'Successfully disconnected');
|
session.flash('flash', 'Successfully disconnected');
|
||||||
logger.info(`[${auth.user?.email}] disconnected successfully`);
|
logger.info(`[${auth.user?.email}] disconnected successfully`);
|
||||||
response.redirectToNamedRoute(this.redirectTo);
|
response.redirect('/');
|
||||||
}
|
}
|
||||||
|
|
||||||
async getAllUsersWithTotalRelations() {
|
async getAllUsersWithTotalRelations() {
|
||||||
return User.query()
|
return User.query()
|
||||||
.withCount('collections', (q) => q.as('totalCollections'))
|
.withCount('collections', (q) => q.as('totalCollections'))
|
||||||
.withCount('links', (q) => q.as('totalLinks'));
|
.withCount('links', (q) => q.as('totalLinks'));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
export enum Visibility {
|
export enum Visibility {
|
||||||
PUBLIC = 'PUBLIC',
|
PUBLIC = 'PUBLIC',
|
||||||
PRIVATE = 'PRIVATE',
|
PRIVATE = 'PRIVATE',
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,16 +5,16 @@ import { createReadStream } from 'node:fs';
|
|||||||
import { resolve } from 'node:path';
|
import { resolve } from 'node:path';
|
||||||
|
|
||||||
export default class FaviconNotFoundException extends Exception {
|
export default class FaviconNotFoundException extends Exception {
|
||||||
static status = 404;
|
static status = 404;
|
||||||
static code = 'E_FAVICON_NOT_FOUND';
|
static code = 'E_FAVICON_NOT_FOUND';
|
||||||
|
|
||||||
async handle(error: this, ctx: HttpContext) {
|
async handle(error: this, ctx: HttpContext) {
|
||||||
const readStream = createReadStream(
|
const readStream = createReadStream(
|
||||||
resolve(process.cwd(), './public/empty-image.png')
|
resolve(process.cwd(), './public/empty-image.png')
|
||||||
);
|
);
|
||||||
|
|
||||||
ctx.response.header('Content-Type', 'image/png');
|
ctx.response.header('Content-Type', 'image/png');
|
||||||
ctx.response.stream(readStream);
|
ctx.response.stream(readStream);
|
||||||
logger.debug(error.message);
|
logger.debug(error.message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,54 +1,54 @@
|
|||||||
import { ExceptionHandler, HttpContext } from '@adonisjs/core/http';
|
import { ExceptionHandler, HttpContext } from '@adonisjs/core/http';
|
||||||
import app from '@adonisjs/core/services/app';
|
import app from '@adonisjs/core/services/app';
|
||||||
import type {
|
import type {
|
||||||
StatusPageRange,
|
StatusPageRange,
|
||||||
StatusPageRenderer,
|
StatusPageRenderer,
|
||||||
} from '@adonisjs/core/types/http';
|
} from '@adonisjs/core/types/http';
|
||||||
import { errors } from '@adonisjs/lucid';
|
import { errors } from '@adonisjs/lucid';
|
||||||
|
|
||||||
export default class HttpExceptionHandler extends ExceptionHandler {
|
export default class HttpExceptionHandler extends ExceptionHandler {
|
||||||
/**
|
/**
|
||||||
* In debug mode, the exception handler will display verbose errors
|
* In debug mode, the exception handler will display verbose errors
|
||||||
* with pretty printed stack traces.
|
* with pretty printed stack traces.
|
||||||
*/
|
*/
|
||||||
protected debug = !app.inProduction;
|
protected debug = !app.inProduction;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Status pages are used to display a custom HTML pages for certain error
|
* Status pages are used to display a custom HTML pages for certain error
|
||||||
* codes. You might want to enable them in production only, but feel
|
* codes. You might want to enable them in production only, but feel
|
||||||
* free to enable them in development as well.
|
* free to enable them in development as well.
|
||||||
*/
|
*/
|
||||||
protected renderStatusPages = app.inProduction;
|
protected renderStatusPages = app.inProduction;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Status pages is a collection of error code range and a callback
|
* Status pages is a collection of error code range and a callback
|
||||||
* to return the HTML contents to send as a response.
|
* to return the HTML contents to send as a response.
|
||||||
*/
|
*/
|
||||||
protected statusPages: Record<StatusPageRange, StatusPageRenderer> = {
|
protected statusPages: Record<StatusPageRange, StatusPageRenderer> = {
|
||||||
'404': (error, { inertia }) =>
|
'404': (error, { inertia }) =>
|
||||||
inertia.render('errors/not_found', { error }),
|
inertia.render('errors/not_found', { error }),
|
||||||
'500..599': (error, { inertia }) =>
|
'500..599': (error, { inertia }) =>
|
||||||
inertia.render('errors/server_error', { error }),
|
inertia.render('errors/server_error', { error }),
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The method is used for handling errors and returning
|
* The method is used for handling errors and returning
|
||||||
* response to the client
|
* response to the client
|
||||||
*/
|
*/
|
||||||
async handle(error: unknown, ctx: HttpContext) {
|
async handle(error: unknown, ctx: HttpContext) {
|
||||||
if (error instanceof errors.E_ROW_NOT_FOUND) {
|
if (error instanceof errors.E_ROW_NOT_FOUND) {
|
||||||
return ctx.response.redirectToNamedRoute('dashboard');
|
return ctx.response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
return super.handle(error, ctx);
|
return super.handle(error, ctx);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The method is used to report error to the logging service or
|
* The method is used to report error to the logging service or
|
||||||
* the a third party error monitoring service.
|
* the a third party error monitoring service.
|
||||||
*
|
*
|
||||||
* @note You should not attempt to send a response from this method.
|
* @note You should not attempt to send a response from this method.
|
||||||
*/
|
*/
|
||||||
async report(error: unknown, ctx: HttpContext) {
|
async report(error: unknown, ctx: HttpContext) {
|
||||||
return super.report(error, ctx);
|
return super.report(error, ctx);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,9 +2,9 @@ import { BentoCache, bentostore } from 'bentocache';
|
|||||||
import { memoryDriver } from 'bentocache/drivers/memory';
|
import { memoryDriver } from 'bentocache/drivers/memory';
|
||||||
|
|
||||||
export const cache = new BentoCache({
|
export const cache = new BentoCache({
|
||||||
default: 'cache',
|
default: 'cache',
|
||||||
|
|
||||||
stores: {
|
stores: {
|
||||||
cache: bentostore().useL1Layer(memoryDriver({ maxSize: 10_000 })),
|
cache: bentostore().useL1Layer(memoryDriver({ maxSize: 10_000 })),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,10 +2,10 @@ import type { HttpContext } from '@adonisjs/core/http';
|
|||||||
import type { NextFn } from '@adonisjs/core/types/http';
|
import type { NextFn } from '@adonisjs/core/types/http';
|
||||||
|
|
||||||
export default class AdminMiddleware {
|
export default class AdminMiddleware {
|
||||||
async handle(ctx: HttpContext, next: NextFn) {
|
async handle(ctx: HttpContext, next: NextFn) {
|
||||||
if (!ctx.auth.user?.isAdmin) {
|
if (!ctx.auth.user?.isAdmin) {
|
||||||
return ctx.response.redirectToNamedRoute('dashboard');
|
return ctx.response.redirectToNamedRoute('dashboard');
|
||||||
}
|
}
|
||||||
return next();
|
return next();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,21 +8,21 @@ import { route } from '@izzyjs/route/client';
|
|||||||
* access to unauthenticated users.
|
* access to unauthenticated users.
|
||||||
*/
|
*/
|
||||||
export default class AuthMiddleware {
|
export default class AuthMiddleware {
|
||||||
/**
|
/**
|
||||||
* The URL to redirect to, when authentication fails
|
* The URL to redirect to, when authentication fails
|
||||||
*/
|
*/
|
||||||
redirectTo = route('auth.login').url;
|
redirectTo = route('auth').path;
|
||||||
|
|
||||||
async handle(
|
async handle(
|
||||||
ctx: HttpContext,
|
ctx: HttpContext,
|
||||||
next: NextFn,
|
next: NextFn,
|
||||||
options: {
|
options: {
|
||||||
guards?: (keyof Authenticators)[];
|
guards?: (keyof Authenticators)[];
|
||||||
} = {}
|
} = {}
|
||||||
) {
|
) {
|
||||||
await ctx.auth.authenticateUsing(options.guards, {
|
await ctx.auth.authenticateUsing(options.guards, {
|
||||||
loginRoute: this.redirectTo,
|
loginRoute: this.redirectTo,
|
||||||
});
|
});
|
||||||
return next();
|
return next();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ import { NextFn } from '@adonisjs/core/types/http';
|
|||||||
* - And bind "Logger" class to the "ctx.logger" object
|
* - And bind "Logger" class to the "ctx.logger" object
|
||||||
*/
|
*/
|
||||||
export default class ContainerBindingsMiddleware {
|
export default class ContainerBindingsMiddleware {
|
||||||
handle(ctx: HttpContext, next: NextFn) {
|
handle(ctx: HttpContext, next: NextFn) {
|
||||||
ctx.containerResolver.bindValue(HttpContext, ctx);
|
ctx.containerResolver.bindValue(HttpContext, ctx);
|
||||||
ctx.containerResolver.bindValue(Logger, ctx.logger);
|
ctx.containerResolver.bindValue(Logger, ctx.logger);
|
||||||
|
|
||||||
return next();
|
return next();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,22 +10,22 @@ import type { Authenticators } from '@adonisjs/auth/types';
|
|||||||
* is already logged-in
|
* is already logged-in
|
||||||
*/
|
*/
|
||||||
export default class GuestMiddleware {
|
export default class GuestMiddleware {
|
||||||
/**
|
/**
|
||||||
* The URL to redirect to when user is logged-in
|
* The URL to redirect to when user is logged-in
|
||||||
*/
|
*/
|
||||||
redirectTo = '/';
|
redirectTo = '/';
|
||||||
|
|
||||||
async handle(
|
async handle(
|
||||||
ctx: HttpContext,
|
ctx: HttpContext,
|
||||||
next: NextFn,
|
next: NextFn,
|
||||||
options: { guards?: (keyof Authenticators)[] } = {}
|
options: { guards?: (keyof Authenticators)[] } = {}
|
||||||
) {
|
) {
|
||||||
for (let guard of options.guards || [ctx.auth.defaultGuard]) {
|
for (let guard of options.guards || [ctx.auth.defaultGuard]) {
|
||||||
if (await ctx.auth.use(guard).check()) {
|
if (await ctx.auth.use(guard).check()) {
|
||||||
return ctx.response.redirect(this.redirectTo, true);
|
return ctx.response.redirect(this.redirectTo, true);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return next();
|
return next();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,16 +2,16 @@ import { HttpContext } from '@adonisjs/core/http';
|
|||||||
import logger from '@adonisjs/core/services/logger';
|
import logger from '@adonisjs/core/services/logger';
|
||||||
|
|
||||||
export default class LogRequest {
|
export default class LogRequest {
|
||||||
async handle({ request }: HttpContext, next: () => Promise<void>) {
|
async handle({ request }: HttpContext, next: () => Promise<void>) {
|
||||||
if (
|
if (
|
||||||
!request.url().startsWith('/node_modules') &&
|
!request.url().startsWith('/node_modules') &&
|
||||||
!request.url().startsWith('/inertia') &&
|
!request.url().startsWith('/inertia') &&
|
||||||
!request.url().startsWith('/@vite') &&
|
!request.url().startsWith('/@vite') &&
|
||||||
!request.url().startsWith('/@react-refresh') &&
|
!request.url().startsWith('/@react-refresh') &&
|
||||||
!request.url().includes('.ts')
|
!request.url().includes('.ts')
|
||||||
) {
|
) {
|
||||||
logger.debug(`[${request.method()}]: ${request.url()}`);
|
logger.debug(`[${request.method()}]: ${request.url()}`);
|
||||||
}
|
}
|
||||||
await next();
|
await next();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
9
app/middleware/silent_auth_middleware.ts
Normal file
9
app/middleware/silent_auth_middleware.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
|
import type { NextFn } from '@adonisjs/core/types/http';
|
||||||
|
|
||||||
|
export default class SilentAuthMiddleware {
|
||||||
|
async handle(ctx: HttpContext, next: NextFn) {
|
||||||
|
await ctx.auth.check();
|
||||||
|
return next();
|
||||||
|
}
|
||||||
|
}
|
||||||
16
app/middleware/update_user_last_seen_middleware.ts
Normal file
16
app/middleware/update_user_last_seen_middleware.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import type { HttpContext } from '@adonisjs/core/http';
|
||||||
|
import type { NextFn } from '@adonisjs/core/types/http';
|
||||||
|
import { DateTime } from 'luxon';
|
||||||
|
|
||||||
|
export default class UpdateUserLastSeenMiddleware {
|
||||||
|
async handle(ctx: HttpContext, next: NextFn) {
|
||||||
|
const user = ctx.auth.user;
|
||||||
|
if (user) {
|
||||||
|
user.lastSeenAt = DateTime.local();
|
||||||
|
await user.save();
|
||||||
|
}
|
||||||
|
|
||||||
|
const output = await next();
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,25 +1,25 @@
|
|||||||
import {
|
import {
|
||||||
BaseModel,
|
BaseModel,
|
||||||
CamelCaseNamingStrategy,
|
CamelCaseNamingStrategy,
|
||||||
column,
|
column,
|
||||||
} from '@adonisjs/lucid/orm';
|
} from '@adonisjs/lucid/orm';
|
||||||
import { DateTime } from 'luxon';
|
import { DateTime } from 'luxon';
|
||||||
|
|
||||||
export default class AppBaseModel extends BaseModel {
|
export default class AppBaseModel extends BaseModel {
|
||||||
static namingStrategy = new CamelCaseNamingStrategy();
|
static namingStrategy = new CamelCaseNamingStrategy();
|
||||||
serializeExtras = true;
|
serializeExtras = true;
|
||||||
|
|
||||||
@column({ isPrimary: true })
|
@column({ isPrimary: true })
|
||||||
declare id: number;
|
declare id: number;
|
||||||
|
|
||||||
@column.dateTime({
|
@column.dateTime({
|
||||||
autoCreate: true,
|
autoCreate: true,
|
||||||
})
|
})
|
||||||
declare createdAt: DateTime;
|
declare createdAt: DateTime;
|
||||||
|
|
||||||
@column.dateTime({
|
@column.dateTime({
|
||||||
autoCreate: true,
|
autoCreate: true,
|
||||||
autoUpdate: true,
|
autoUpdate: true,
|
||||||
})
|
})
|
||||||
declare updatedAt: DateTime;
|
declare updatedAt: DateTime;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,24 +6,24 @@ import type { BelongsTo, HasMany } from '@adonisjs/lucid/types/relations';
|
|||||||
import { Visibility } from '#enums/visibility';
|
import { Visibility } from '#enums/visibility';
|
||||||
|
|
||||||
export default class Collection extends AppBaseModel {
|
export default class Collection extends AppBaseModel {
|
||||||
@column()
|
@column()
|
||||||
declare name: string;
|
declare name: string;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare description: string | null;
|
declare description: string | null;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare visibility: Visibility;
|
declare visibility: Visibility;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare nextId: number;
|
declare nextId: number;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare authorId: number;
|
declare authorId: number;
|
||||||
|
|
||||||
@belongsTo(() => User, { foreignKey: 'authorId' })
|
@belongsTo(() => User, { foreignKey: 'authorId' })
|
||||||
declare author: BelongsTo<typeof User>;
|
declare author: BelongsTo<typeof User>;
|
||||||
|
|
||||||
@hasMany(() => Link)
|
@hasMany(() => Link)
|
||||||
declare links: HasMany<typeof Link>;
|
declare links: HasMany<typeof Link>;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,27 +5,27 @@ import { belongsTo, column } from '@adonisjs/lucid/orm';
|
|||||||
import type { BelongsTo } from '@adonisjs/lucid/types/relations';
|
import type { BelongsTo } from '@adonisjs/lucid/types/relations';
|
||||||
|
|
||||||
export default class Link extends AppBaseModel {
|
export default class Link extends AppBaseModel {
|
||||||
@column()
|
@column()
|
||||||
declare name: string;
|
declare name: string;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare description: string | null;
|
declare description: string | null;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare url: string;
|
declare url: string;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare favorite: boolean;
|
declare favorite: boolean;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare collectionId: number;
|
declare collectionId: number;
|
||||||
|
|
||||||
@belongsTo(() => Collection, { foreignKey: 'collectionId' })
|
@belongsTo(() => Collection, { foreignKey: 'collectionId' })
|
||||||
declare collection: BelongsTo<typeof Collection>;
|
declare collection: BelongsTo<typeof Collection>;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare authorId: number;
|
declare authorId: number;
|
||||||
|
|
||||||
@belongsTo(() => User, { foreignKey: 'authorId' })
|
@belongsTo(() => User, { foreignKey: 'authorId' })
|
||||||
declare author: BelongsTo<typeof User>;
|
declare author: BelongsTo<typeof User>;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,44 +4,51 @@ import type { GoogleToken } from '@adonisjs/ally/types';
|
|||||||
import { column, computed, hasMany } from '@adonisjs/lucid/orm';
|
import { column, computed, hasMany } from '@adonisjs/lucid/orm';
|
||||||
import type { HasMany } from '@adonisjs/lucid/types/relations';
|
import type { HasMany } from '@adonisjs/lucid/types/relations';
|
||||||
import AppBaseModel from './app_base_model.js';
|
import AppBaseModel from './app_base_model.js';
|
||||||
|
import { DateTime } from 'luxon';
|
||||||
|
|
||||||
export default class User extends AppBaseModel {
|
export default class User extends AppBaseModel {
|
||||||
@column()
|
@column()
|
||||||
declare email: string;
|
declare email: string;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare name: string;
|
declare name: string;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare nickName: string; // public username
|
declare nickName: string; // public username
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare avatarUrl: string;
|
declare avatarUrl: string;
|
||||||
|
|
||||||
@column()
|
@column()
|
||||||
declare isAdmin: boolean;
|
declare isAdmin: boolean;
|
||||||
|
|
||||||
@column({ serializeAs: null })
|
@column({ serializeAs: null })
|
||||||
declare token?: GoogleToken;
|
declare token?: GoogleToken;
|
||||||
|
|
||||||
@column({ serializeAs: null })
|
@column({ serializeAs: null })
|
||||||
declare providerId: number;
|
declare providerId: number;
|
||||||
|
|
||||||
@column({ serializeAs: null })
|
@column({ serializeAs: null })
|
||||||
declare providerType: 'google';
|
declare providerType: 'google';
|
||||||
|
|
||||||
@hasMany(() => Collection, {
|
@hasMany(() => Collection, {
|
||||||
foreignKey: 'authorId',
|
foreignKey: 'authorId',
|
||||||
})
|
})
|
||||||
declare collections: HasMany<typeof Collection>;
|
declare collections: HasMany<typeof Collection>;
|
||||||
|
|
||||||
@hasMany(() => Link, {
|
@hasMany(() => Link, {
|
||||||
foreignKey: 'authorId',
|
foreignKey: 'authorId',
|
||||||
})
|
})
|
||||||
declare links: HasMany<typeof Link>;
|
declare links: HasMany<typeof Link>;
|
||||||
|
|
||||||
@computed()
|
@computed()
|
||||||
get fullname() {
|
get fullname() {
|
||||||
return this.nickName || this.name;
|
return this.nickName || this.name;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@column.dateTime({
|
||||||
|
autoCreate: true,
|
||||||
|
autoUpdate: true,
|
||||||
|
})
|
||||||
|
declare lastSeenAt: DateTime;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,36 +2,36 @@ import { Visibility } from '#enums/visibility';
|
|||||||
import vine, { SimpleMessagesProvider } from '@vinejs/vine';
|
import vine, { SimpleMessagesProvider } from '@vinejs/vine';
|
||||||
|
|
||||||
const params = vine.object({
|
const params = vine.object({
|
||||||
id: vine.number(),
|
id: vine.number(),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const createCollectionValidator = vine.compile(
|
export const createCollectionValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
name: vine.string().trim().minLength(1).maxLength(254),
|
name: vine.string().trim().minLength(1).maxLength(254),
|
||||||
description: vine.string().trim().maxLength(254).nullable(),
|
description: vine.string().trim().maxLength(254).nullable(),
|
||||||
visibility: vine.enum(Visibility),
|
visibility: vine.enum(Visibility),
|
||||||
nextId: vine.number().optional(),
|
nextId: vine.number().optional(),
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
export const updateCollectionValidator = vine.compile(
|
export const updateCollectionValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
name: vine.string().trim().minLength(1).maxLength(254),
|
name: vine.string().trim().minLength(1).maxLength(254),
|
||||||
description: vine.string().trim().maxLength(254).nullable(),
|
description: vine.string().trim().maxLength(254).nullable(),
|
||||||
visibility: vine.enum(Visibility),
|
visibility: vine.enum(Visibility),
|
||||||
nextId: vine.number().optional(),
|
nextId: vine.number().optional(),
|
||||||
|
|
||||||
params,
|
params,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
export const deleteCollectionValidator = vine.compile(
|
export const deleteCollectionValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
params,
|
params,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
createCollectionValidator.messagesProvider = new SimpleMessagesProvider({
|
createCollectionValidator.messagesProvider = new SimpleMessagesProvider({
|
||||||
name: 'Collection name is required',
|
name: 'Collection name is required',
|
||||||
'visibility.required': 'Collection visibiliy is required',
|
'visibility.required': 'Collection visibiliy is required',
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,43 +1,43 @@
|
|||||||
import vine from '@vinejs/vine';
|
import vine from '@vinejs/vine';
|
||||||
|
|
||||||
const params = vine.object({
|
const params = vine.object({
|
||||||
id: vine.number(),
|
id: vine.number(),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const createLinkValidator = vine.compile(
|
export const createLinkValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
name: vine.string().trim().minLength(1).maxLength(254),
|
name: vine.string().trim().minLength(1).maxLength(254),
|
||||||
description: vine.string().trim().maxLength(300).optional(),
|
description: vine.string().trim().maxLength(300).optional(),
|
||||||
url: vine.string().trim(),
|
url: vine.string().trim(),
|
||||||
favorite: vine.boolean(),
|
favorite: vine.boolean(),
|
||||||
collectionId: vine.number(),
|
collectionId: vine.number(),
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
export const updateLinkValidator = vine.compile(
|
export const updateLinkValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
name: vine.string().trim().minLength(1).maxLength(254),
|
name: vine.string().trim().minLength(1).maxLength(254),
|
||||||
description: vine.string().trim().maxLength(300).optional(),
|
description: vine.string().trim().maxLength(300).optional(),
|
||||||
url: vine.string().trim(),
|
url: vine.string().trim(),
|
||||||
favorite: vine.boolean(),
|
favorite: vine.boolean(),
|
||||||
collectionId: vine.number(),
|
collectionId: vine.number(),
|
||||||
|
|
||||||
params,
|
params,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
export const deleteLinkValidator = vine.compile(
|
export const deleteLinkValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
params,
|
params,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
export const updateLinkFavoriteStatusValidator = vine.compile(
|
export const updateLinkFavoriteStatusValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
favorite: vine.boolean(),
|
favorite: vine.boolean(),
|
||||||
|
|
||||||
params: vine.object({
|
params: vine.object({
|
||||||
id: vine.number(),
|
id: vine.number(),
|
||||||
}),
|
}),
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
import vine from '@vinejs/vine';
|
import vine from '@vinejs/vine';
|
||||||
|
|
||||||
const params = vine.object({
|
const params = vine.object({
|
||||||
id: vine.number(),
|
id: vine.number(),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const getSharedCollectionValidator = vine.compile(
|
export const getSharedCollectionValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
params,
|
params,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import vine from '@vinejs/vine';
|
import vine from '@vinejs/vine';
|
||||||
|
|
||||||
export const updateUserThemeValidator = vine.compile(
|
export const updateUserThemeValidator = vine.compile(
|
||||||
vine.object({
|
vine.object({
|
||||||
preferDarkTheme: vine.boolean(),
|
preferDarkTheme: vine.boolean(),
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -25,23 +25,23 @@ const APP_ROOT = new URL('../', import.meta.url);
|
|||||||
* application.
|
* application.
|
||||||
*/
|
*/
|
||||||
const IMPORTER = (filePath: string) => {
|
const IMPORTER = (filePath: string) => {
|
||||||
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
||||||
return import(new URL(filePath, APP_ROOT).href);
|
return import(new URL(filePath, APP_ROOT).href);
|
||||||
}
|
}
|
||||||
return import(filePath);
|
return import(filePath);
|
||||||
};
|
};
|
||||||
|
|
||||||
new Ignitor(APP_ROOT, { importer: IMPORTER })
|
new Ignitor(APP_ROOT, { importer: IMPORTER })
|
||||||
.tap((app) => {
|
.tap((app) => {
|
||||||
app.booting(async () => {
|
app.booting(async () => {
|
||||||
await import('#start/env');
|
await import('#start/env');
|
||||||
});
|
});
|
||||||
app.listen('SIGTERM', () => app.terminate());
|
app.listen('SIGTERM', () => app.terminate());
|
||||||
app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
|
app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
|
||||||
})
|
})
|
||||||
.ace()
|
.ace()
|
||||||
.handle(process.argv.splice(2))
|
.handle(process.argv.splice(2))
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
process.exitCode = 1;
|
process.exitCode = 1;
|
||||||
prettyPrintError(error);
|
prettyPrintError(error);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -23,23 +23,23 @@ const APP_ROOT = new URL('../', import.meta.url);
|
|||||||
* application.
|
* application.
|
||||||
*/
|
*/
|
||||||
const IMPORTER = (filePath: string) => {
|
const IMPORTER = (filePath: string) => {
|
||||||
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
||||||
return import(new URL(filePath, APP_ROOT).href);
|
return import(new URL(filePath, APP_ROOT).href);
|
||||||
}
|
}
|
||||||
return import(filePath);
|
return import(filePath);
|
||||||
};
|
};
|
||||||
|
|
||||||
new Ignitor(APP_ROOT, { importer: IMPORTER })
|
new Ignitor(APP_ROOT, { importer: IMPORTER })
|
||||||
.tap((app) => {
|
.tap((app) => {
|
||||||
app.booting(async () => {
|
app.booting(async () => {
|
||||||
await import('#start/env');
|
await import('#start/env');
|
||||||
});
|
});
|
||||||
app.listen('SIGTERM', () => app.terminate());
|
app.listen('SIGTERM', () => app.terminate());
|
||||||
app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
|
app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
|
||||||
})
|
})
|
||||||
.httpServer()
|
.httpServer()
|
||||||
.start()
|
.start()
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
process.exitCode = 1;
|
process.exitCode = 1;
|
||||||
prettyPrintError(error);
|
prettyPrintError(error);
|
||||||
});
|
});
|
||||||
|
|||||||
58
bin/test.ts
58
bin/test.ts
@@ -27,36 +27,36 @@ const APP_ROOT = new URL('../', import.meta.url);
|
|||||||
* application.
|
* application.
|
||||||
*/
|
*/
|
||||||
const IMPORTER = (filePath: string) => {
|
const IMPORTER = (filePath: string) => {
|
||||||
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
if (filePath.startsWith('./') || filePath.startsWith('../')) {
|
||||||
return import(new URL(filePath, APP_ROOT).href);
|
return import(new URL(filePath, APP_ROOT).href);
|
||||||
}
|
}
|
||||||
return import(filePath);
|
return import(filePath);
|
||||||
};
|
};
|
||||||
|
|
||||||
new Ignitor(APP_ROOT, { importer: IMPORTER })
|
new Ignitor(APP_ROOT, { importer: IMPORTER })
|
||||||
.tap((app) => {
|
.tap((app) => {
|
||||||
app.booting(async () => {
|
app.booting(async () => {
|
||||||
await import('#start/env');
|
await import('#start/env');
|
||||||
});
|
});
|
||||||
app.listen('SIGTERM', () => app.terminate());
|
app.listen('SIGTERM', () => app.terminate());
|
||||||
app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
|
app.listenIf(app.managedByPm2, 'SIGINT', () => app.terminate());
|
||||||
})
|
})
|
||||||
.testRunner()
|
.testRunner()
|
||||||
.configure(async (app) => {
|
.configure(async (app) => {
|
||||||
const { runnerHooks, ...config } = await import('../tests/bootstrap.js');
|
const { runnerHooks, ...config } = await import('../tests/bootstrap.js');
|
||||||
|
|
||||||
processCLIArgs(process.argv.splice(2));
|
processCLIArgs(process.argv.splice(2));
|
||||||
configure({
|
configure({
|
||||||
...app.rcFile.tests,
|
...app.rcFile.tests,
|
||||||
...config,
|
...config,
|
||||||
...{
|
...{
|
||||||
setup: runnerHooks.setup,
|
setup: runnerHooks.setup,
|
||||||
teardown: runnerHooks.teardown.concat([() => app.terminate()]),
|
teardown: runnerHooks.teardown.concat([() => app.terminate()]),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
})
|
})
|
||||||
.run(() => run())
|
.run(() => run())
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
process.exitCode = 1;
|
process.exitCode = 1;
|
||||||
prettyPrintError(error);
|
prettyPrintError(error);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ services:
|
|||||||
- POSTGRES_USER=${DB_USER}
|
- POSTGRES_USER=${DB_USER}
|
||||||
- POSTGRES_PASSWORD=${DB_PASSWORD}
|
- POSTGRES_PASSWORD=${DB_PASSWORD}
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: ['CMD-SHELL', 'pg_isready']
|
test: ['CMD-SHELL', 'pg_isready', '-U', '${DB_USER}']
|
||||||
volumes:
|
volumes:
|
||||||
- postgres-volume:/var/lib/postgresql/data
|
- postgres-volume:/var/lib/postgresql/data
|
||||||
ports:
|
ports:
|
||||||
@@ -17,22 +17,30 @@ services:
|
|||||||
|
|
||||||
pgadmin:
|
pgadmin:
|
||||||
container_name: pgadmin
|
container_name: pgadmin
|
||||||
image: dpage/pgadmin4:8.6
|
image: dpage/pgadmin4:8
|
||||||
restart: always
|
restart: always
|
||||||
|
entrypoint: /bin/sh -c "chmod 0600 /pgpass; /entrypoint.sh;"
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: ['CMD', 'wget', '-O', '-', 'http://localhost:80/misc/ping']
|
test: ['CMD', 'wget', '-O', '-', 'http://localhost:80/misc/ping']
|
||||||
interval: 2s
|
interval: 2s
|
||||||
timeout: 10s
|
timeout: 10s
|
||||||
retries: 30
|
retries: 30
|
||||||
|
env_file: .env
|
||||||
environment:
|
environment:
|
||||||
- PGADMIN_DEFAULT_EMAIL=myemail@gmail.com
|
- PGADMIN_DEFAULT_EMAIL=myemail@gmail.com
|
||||||
- PGADMIN_DEFAULT_PASSWORD=a12345678
|
- PGADMIN_DEFAULT_PASSWORD=a12345678
|
||||||
|
- PGADMIN_CONFIG_SERVER_MODE=False
|
||||||
|
- PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED=False
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgres
|
- postgres
|
||||||
volumes:
|
|
||||||
- ./docker-config/servers_pgadmin.json:/pgadmin4/servers.json
|
|
||||||
ports:
|
ports:
|
||||||
- '5050:80'
|
- '5050:80'
|
||||||
|
user: root
|
||||||
|
configs:
|
||||||
|
- source: servers.json
|
||||||
|
target: /pgadmin4/servers.json
|
||||||
|
- source: pgpass
|
||||||
|
target: /pgpass
|
||||||
|
|
||||||
my-links:
|
my-links:
|
||||||
container_name: my-links
|
container_name: my-links
|
||||||
@@ -53,4 +61,19 @@ services:
|
|||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
postgres-volume:
|
postgres-volume:
|
||||||
name: postgres-prod-my-links
|
|
||||||
|
configs:
|
||||||
|
pgpass:
|
||||||
|
content: postgres:${DB_PORT}:*:${DB_USER}:${DB_PASSWORD}
|
||||||
|
servers.json:
|
||||||
|
content: |
|
||||||
|
{"Servers": {"1": {
|
||||||
|
"Group": "Servers",
|
||||||
|
"Name": "project",
|
||||||
|
"Host": "postgres",
|
||||||
|
"Port": ${DB_PORT},
|
||||||
|
"MaintenanceDB": "${DB_DATABASE}",
|
||||||
|
"Username": "${DB_USER}",
|
||||||
|
"PassFile": "/pgpass",
|
||||||
|
"SSLMode": "prefer"
|
||||||
|
}}}
|
||||||
@@ -2,18 +2,18 @@ import env from '#start/env';
|
|||||||
import { defineConfig, services } from '@adonisjs/ally';
|
import { defineConfig, services } from '@adonisjs/ally';
|
||||||
|
|
||||||
const allyConfig = defineConfig({
|
const allyConfig = defineConfig({
|
||||||
google: services.google({
|
google: services.google({
|
||||||
clientId: env.get('GOOGLE_CLIENT_ID'),
|
clientId: env.get('GOOGLE_CLIENT_ID'),
|
||||||
clientSecret: env.get('GOOGLE_CLIENT_SECRET'),
|
clientSecret: env.get('GOOGLE_CLIENT_SECRET'),
|
||||||
callbackUrl: env.get('GOOGLE_CLIENT_CALLBACK_URL'),
|
callbackUrl: env.get('GOOGLE_CLIENT_CALLBACK_URL'),
|
||||||
prompt: 'select_account',
|
prompt: 'select_account',
|
||||||
display: 'page',
|
display: 'page',
|
||||||
scopes: ['userinfo.email', 'userinfo.profile'],
|
scopes: ['userinfo.email', 'userinfo.profile'],
|
||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
export default allyConfig;
|
export default allyConfig;
|
||||||
|
|
||||||
declare module '@adonisjs/ally/types' {
|
declare module '@adonisjs/ally/types' {
|
||||||
interface SocialProviders extends InferSocialProviders<typeof allyConfig> {}
|
interface SocialProviders extends InferSocialProviders<typeof allyConfig> {}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -16,25 +16,25 @@ export const appKey = new Secret(env.get('APP_KEY'));
|
|||||||
* The configuration settings used by the HTTP server
|
* The configuration settings used by the HTTP server
|
||||||
*/
|
*/
|
||||||
export const http = defineConfig({
|
export const http = defineConfig({
|
||||||
generateRequestId: true,
|
generateRequestId: true,
|
||||||
allowMethodSpoofing: false,
|
allowMethodSpoofing: false,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Enabling async local storage will let you access HTTP context
|
* Enabling async local storage will let you access HTTP context
|
||||||
* from anywhere inside your application.
|
* from anywhere inside your application.
|
||||||
*/
|
*/
|
||||||
useAsyncLocalStorage: false,
|
useAsyncLocalStorage: false,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Manage cookies configuration. The settings for the session id cookie are
|
* Manage cookies configuration. The settings for the session id cookie are
|
||||||
* defined inside the "config/session.ts" file.
|
* defined inside the "config/session.ts" file.
|
||||||
*/
|
*/
|
||||||
cookie: {
|
cookie: {
|
||||||
domain: '',
|
domain: '',
|
||||||
path: '/',
|
path: '/',
|
||||||
maxAge: '2h',
|
maxAge: '2h',
|
||||||
httpOnly: true,
|
httpOnly: true,
|
||||||
secure: app.inProduction,
|
secure: app.inProduction,
|
||||||
sameSite: 'lax',
|
sameSite: 'lax',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,15 +3,15 @@ import { InferAuthEvents, Authenticators } from '@adonisjs/auth/types';
|
|||||||
import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session';
|
import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session';
|
||||||
|
|
||||||
const authConfig = defineConfig({
|
const authConfig = defineConfig({
|
||||||
default: 'web',
|
default: 'web',
|
||||||
guards: {
|
guards: {
|
||||||
web: sessionGuard({
|
web: sessionGuard({
|
||||||
useRememberMeTokens: false,
|
useRememberMeTokens: false,
|
||||||
provider: sessionUserProvider({
|
provider: sessionUserProvider({
|
||||||
model: () => import('#models/user'),
|
model: () => import('#models/user'),
|
||||||
}),
|
}),
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default authConfig;
|
export default authConfig;
|
||||||
@@ -21,8 +21,8 @@ export default authConfig;
|
|||||||
* guards.
|
* guards.
|
||||||
*/
|
*/
|
||||||
declare module '@adonisjs/auth/types' {
|
declare module '@adonisjs/auth/types' {
|
||||||
interface Authenticators extends InferAuthenticators<typeof authConfig> {}
|
interface Authenticators extends InferAuthenticators<typeof authConfig> {}
|
||||||
}
|
}
|
||||||
declare module '@adonisjs/core/types' {
|
declare module '@adonisjs/core/types' {
|
||||||
interface EventsList extends InferAuthEvents<Authenticators> {}
|
interface EventsList extends InferAuthEvents<Authenticators> {}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,55 +1,55 @@
|
|||||||
import { defineConfig } from '@adonisjs/core/bodyparser';
|
import { defineConfig } from '@adonisjs/core/bodyparser';
|
||||||
|
|
||||||
const bodyParserConfig = defineConfig({
|
const bodyParserConfig = defineConfig({
|
||||||
/**
|
/**
|
||||||
* The bodyparser middleware will parse the request body
|
* The bodyparser middleware will parse the request body
|
||||||
* for the following HTTP methods.
|
* for the following HTTP methods.
|
||||||
*/
|
*/
|
||||||
allowedMethods: ['POST', 'PUT', 'PATCH', 'DELETE'],
|
allowedMethods: ['POST', 'PUT', 'PATCH', 'DELETE'],
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Config for the "application/x-www-form-urlencoded"
|
* Config for the "application/x-www-form-urlencoded"
|
||||||
* content-type parser
|
* content-type parser
|
||||||
*/
|
*/
|
||||||
form: {
|
form: {
|
||||||
convertEmptyStringsToNull: true,
|
convertEmptyStringsToNull: true,
|
||||||
types: ['application/x-www-form-urlencoded'],
|
types: ['application/x-www-form-urlencoded'],
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Config for the JSON parser
|
* Config for the JSON parser
|
||||||
*/
|
*/
|
||||||
json: {
|
json: {
|
||||||
convertEmptyStringsToNull: true,
|
convertEmptyStringsToNull: true,
|
||||||
types: [
|
types: [
|
||||||
'application/json',
|
'application/json',
|
||||||
'application/json-patch+json',
|
'application/json-patch+json',
|
||||||
'application/vnd.api+json',
|
'application/vnd.api+json',
|
||||||
'application/csp-report',
|
'application/csp-report',
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Config for the "multipart/form-data" content-type parser.
|
* Config for the "multipart/form-data" content-type parser.
|
||||||
* File uploads are handled by the multipart parser.
|
* File uploads are handled by the multipart parser.
|
||||||
*/
|
*/
|
||||||
multipart: {
|
multipart: {
|
||||||
/**
|
/**
|
||||||
* Enabling auto process allows bodyparser middleware to
|
* Enabling auto process allows bodyparser middleware to
|
||||||
* move all uploaded files inside the tmp folder of your
|
* move all uploaded files inside the tmp folder of your
|
||||||
* operating system
|
* operating system
|
||||||
*/
|
*/
|
||||||
autoProcess: true,
|
autoProcess: true,
|
||||||
convertEmptyStringsToNull: true,
|
convertEmptyStringsToNull: true,
|
||||||
processManually: [],
|
processManually: [],
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Maximum limit of data to parse including all files
|
* Maximum limit of data to parse including all files
|
||||||
* and fields
|
* and fields
|
||||||
*/
|
*/
|
||||||
limit: '20mb',
|
limit: '20mb',
|
||||||
types: ['multipart/form-data'],
|
types: ['multipart/form-data'],
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default bodyParserConfig;
|
export default bodyParserConfig;
|
||||||
|
|||||||
@@ -7,13 +7,13 @@ import { defineConfig } from '@adonisjs/cors';
|
|||||||
* https://docs.adonisjs.com/guides/security/cors
|
* https://docs.adonisjs.com/guides/security/cors
|
||||||
*/
|
*/
|
||||||
const corsConfig = defineConfig({
|
const corsConfig = defineConfig({
|
||||||
enabled: true,
|
enabled: true,
|
||||||
origin: [],
|
origin: [],
|
||||||
methods: ['GET', 'HEAD', 'POST', 'PUT', 'DELETE'],
|
methods: ['GET', 'HEAD', 'POST', 'PUT', 'DELETE'],
|
||||||
headers: true,
|
headers: true,
|
||||||
exposeHeaders: [],
|
exposeHeaders: [],
|
||||||
credentials: true,
|
credentials: true,
|
||||||
maxAge: 90,
|
maxAge: 90,
|
||||||
});
|
});
|
||||||
|
|
||||||
export default corsConfig;
|
export default corsConfig;
|
||||||
|
|||||||
@@ -2,26 +2,26 @@ import env from '#start/env';
|
|||||||
import { defineConfig } from '@adonisjs/lucid';
|
import { defineConfig } from '@adonisjs/lucid';
|
||||||
|
|
||||||
const dbConfig = defineConfig({
|
const dbConfig = defineConfig({
|
||||||
connection: 'postgres',
|
connection: 'postgres',
|
||||||
connections: {
|
connections: {
|
||||||
postgres: {
|
postgres: {
|
||||||
client: 'pg',
|
client: 'pg',
|
||||||
connection: {
|
connection: {
|
||||||
host: env.get('DB_HOST'),
|
host: env.get('DB_HOST'),
|
||||||
port: env.get('DB_PORT'),
|
port: env.get('DB_PORT'),
|
||||||
user: env.get('DB_USER'),
|
user: env.get('DB_USER'),
|
||||||
password: env.get('DB_PASSWORD'),
|
password: env.get('DB_PASSWORD'),
|
||||||
database: env.get('DB_DATABASE'),
|
database: env.get('DB_DATABASE'),
|
||||||
},
|
},
|
||||||
migrations: {
|
migrations: {
|
||||||
naturalSort: true,
|
naturalSort: true,
|
||||||
paths: ['database/migrations'],
|
paths: ['database/migrations'],
|
||||||
},
|
},
|
||||||
seeders: {
|
seeders: {
|
||||||
paths: ['./database/seeders/main'],
|
paths: ['./database/seeders/main'],
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default dbConfig;
|
export default dbConfig;
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
import { defineConfig, drivers } from '@adonisjs/core/hash';
|
import { defineConfig, drivers } from '@adonisjs/core/hash';
|
||||||
|
|
||||||
const hashConfig = defineConfig({
|
const hashConfig = defineConfig({
|
||||||
default: 'scrypt',
|
default: 'scrypt',
|
||||||
|
|
||||||
list: {
|
list: {
|
||||||
scrypt: drivers.scrypt({
|
scrypt: drivers.scrypt({
|
||||||
cost: 16384,
|
cost: 16384,
|
||||||
blockSize: 8,
|
blockSize: 8,
|
||||||
parallelization: 1,
|
parallelization: 1,
|
||||||
maxMemory: 33554432,
|
maxMemory: 33554432,
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default hashConfig;
|
export default hashConfig;
|
||||||
@@ -20,5 +20,5 @@ export default hashConfig;
|
|||||||
* in your application.
|
* in your application.
|
||||||
*/
|
*/
|
||||||
declare module '@adonisjs/core/types' {
|
declare module '@adonisjs/core/types' {
|
||||||
export interface HashersList extends InferHashers<typeof hashConfig> {}
|
export interface HashersList extends InferHashers<typeof hashConfig> {}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,36 +1,36 @@
|
|||||||
import {
|
import {
|
||||||
DARK_THEME_DEFAULT_VALUE,
|
DARK_THEME_DEFAULT_VALUE,
|
||||||
PREFER_DARK_THEME,
|
PREFER_DARK_THEME,
|
||||||
} from '#constants/session';
|
} from '#constants/session';
|
||||||
import { defineConfig } from '@adonisjs/inertia';
|
import { defineConfig } from '@adonisjs/inertia';
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
/**
|
/**
|
||||||
* Path to the Edge view that will be used as the root view for Inertia responses
|
* Path to the Edge view that will be used as the root view for Inertia responses
|
||||||
*/
|
*/
|
||||||
rootView: 'inertia_layout',
|
rootView: 'inertia_layout',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Data that should be shared with all rendered pages
|
* Data that should be shared with all rendered pages
|
||||||
*/
|
*/
|
||||||
sharedData: {
|
sharedData: {
|
||||||
errors: (ctx) => ctx.session?.flashMessages.get('errors'),
|
errors: (ctx) => ctx.session?.flashMessages.get('errors'),
|
||||||
preferDarkTheme: (ctx) =>
|
preferDarkTheme: (ctx) =>
|
||||||
ctx.session?.get(PREFER_DARK_THEME, DARK_THEME_DEFAULT_VALUE),
|
ctx.session?.get(PREFER_DARK_THEME, DARK_THEME_DEFAULT_VALUE),
|
||||||
auth: async (ctx) => {
|
auth: async (ctx) => {
|
||||||
await ctx.auth?.check();
|
await ctx.auth?.check();
|
||||||
return {
|
return {
|
||||||
user: ctx.auth?.user || null,
|
user: ctx.auth?.user || null,
|
||||||
isAuthenticated: ctx.auth?.isAuthenticated || false,
|
isAuthenticated: ctx.auth?.isAuthenticated || false,
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Options for the server-side rendering
|
* Options for the server-side rendering
|
||||||
*/
|
*/
|
||||||
ssr: {
|
ssr: {
|
||||||
enabled: true,
|
enabled: true,
|
||||||
entrypoint: 'inertia/app/ssr.tsx',
|
entrypoint: 'inertia/app/ssr.tsx',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,25 +3,25 @@ import app from '@adonisjs/core/services/app';
|
|||||||
import { defineConfig, targets } from '@adonisjs/core/logger';
|
import { defineConfig, targets } from '@adonisjs/core/logger';
|
||||||
|
|
||||||
const loggerConfig = defineConfig({
|
const loggerConfig = defineConfig({
|
||||||
default: 'app',
|
default: 'app',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The loggers object can be used to define multiple loggers.
|
* The loggers object can be used to define multiple loggers.
|
||||||
* By default, we configure only one logger (named "app").
|
* By default, we configure only one logger (named "app").
|
||||||
*/
|
*/
|
||||||
loggers: {
|
loggers: {
|
||||||
app: {
|
app: {
|
||||||
enabled: true,
|
enabled: true,
|
||||||
name: env.get('APP_NAME'),
|
name: env.get('APP_NAME'),
|
||||||
level: env.get('LOG_LEVEL'),
|
level: env.get('LOG_LEVEL'),
|
||||||
transport: {
|
transport: {
|
||||||
targets: targets()
|
targets: targets()
|
||||||
.pushIf(!app.inProduction, targets.pretty())
|
.pushIf(!app.inProduction, targets.pretty())
|
||||||
.pushIf(app.inProduction, targets.file({ destination: 1 }))
|
.pushIf(app.inProduction, targets.file({ destination: 1 }))
|
||||||
.toArray(),
|
.toArray(),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default loggerConfig;
|
export default loggerConfig;
|
||||||
@@ -31,5 +31,5 @@ export default loggerConfig;
|
|||||||
* in your application.
|
* in your application.
|
||||||
*/
|
*/
|
||||||
declare module '@adonisjs/core/types' {
|
declare module '@adonisjs/core/types' {
|
||||||
export interface LoggersList extends InferLoggers<typeof loggerConfig> {}
|
export interface LoggersList extends InferLoggers<typeof loggerConfig> {}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,48 +1,49 @@
|
|||||||
import env from '#start/env';
|
import env from '#start/env';
|
||||||
import app from '@adonisjs/core/services/app';
|
|
||||||
import { defineConfig, stores } from '@adonisjs/session';
|
import { defineConfig, stores } from '@adonisjs/session';
|
||||||
|
|
||||||
const sessionConfig = defineConfig({
|
const sessionConfig = defineConfig({
|
||||||
enabled: true,
|
enabled: true,
|
||||||
cookieName: 'adonis-session',
|
cookieName: 'adonis-session',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* When set to true, the session id cookie will be deleted
|
* When set to true, the session id cookie will be deleted
|
||||||
* once the user closes the browser.
|
* once the user closes the browser.
|
||||||
*/
|
*/
|
||||||
clearWithBrowser: false,
|
clearWithBrowser: false,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Define how long to keep the session data alive without
|
* Define how long to keep the session data alive without
|
||||||
* any activity.
|
* any activity.
|
||||||
*/
|
*/
|
||||||
age: '2h',
|
age: '7d',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Configuration for session cookie and the
|
* Configuration for session cookie and the
|
||||||
* cookie store
|
* cookie store
|
||||||
*/
|
*/
|
||||||
cookie: {
|
cookie: {
|
||||||
path: '/',
|
path: '/',
|
||||||
httpOnly: true,
|
httpOnly: true,
|
||||||
secure: app.inProduction,
|
secure: true,
|
||||||
sameSite: 'lax',
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
// TODO: set this to lax and found a solution to keep auth when using extension
|
||||||
* The store to use. Make sure to validate the environment
|
sameSite: 'none',
|
||||||
* variable in order to infer the store name without any
|
},
|
||||||
* errors.
|
|
||||||
*/
|
|
||||||
store: env.get('SESSION_DRIVER'),
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* List of configured stores. Refer documentation to see
|
* The store to use. Make sure to validate the environment
|
||||||
* list of available stores and their config.
|
* variable in order to infer the store name without any
|
||||||
*/
|
* errors.
|
||||||
stores: {
|
*/
|
||||||
cookie: stores.cookie(),
|
store: env.get('SESSION_DRIVER'),
|
||||||
},
|
|
||||||
|
/**
|
||||||
|
* List of configured stores. Refer documentation to see
|
||||||
|
* list of available stores and their config.
|
||||||
|
*/
|
||||||
|
stores: {
|
||||||
|
cookie: stores.cookie(),
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default sessionConfig;
|
export default sessionConfig;
|
||||||
|
|||||||
@@ -1,52 +1,50 @@
|
|||||||
import { defineConfig } from '@adonisjs/shield';
|
import { defineConfig } from '@adonisjs/shield';
|
||||||
|
|
||||||
const shieldConfig = defineConfig({
|
const shieldConfig = defineConfig({
|
||||||
/**
|
/**
|
||||||
* Configure CSP policies for your app. Refer documentation
|
* Configure CSP policies for your app. Refer documentation
|
||||||
* to learn more
|
* to learn more
|
||||||
*/
|
*/
|
||||||
csp: {
|
csp: {
|
||||||
enabled: false,
|
enabled: false,
|
||||||
directives: {},
|
directives: {},
|
||||||
reportOnly: false,
|
reportOnly: false,
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Configure CSRF protection options. Refer documentation
|
* Configure CSRF protection options. Refer documentation
|
||||||
* to learn more
|
* to learn more
|
||||||
*/
|
*/
|
||||||
csrf: {
|
csrf: {
|
||||||
enabled: false,
|
enabled: false,
|
||||||
exceptRoutes: [],
|
exceptRoutes: [],
|
||||||
enableXsrfCookie: true,
|
enableXsrfCookie: true,
|
||||||
methods: ['POST', 'PUT', 'PATCH', 'DELETE'],
|
methods: ['POST', 'PUT', 'PATCH', 'DELETE'],
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Control how your website should be embedded inside
|
* Control how your website should be embedded inside
|
||||||
* iFrames
|
* iFrames
|
||||||
*/
|
*/
|
||||||
xFrame: {
|
xFrame: {
|
||||||
enabled: true,
|
enabled: false,
|
||||||
action: 'ALLOW-FROM',
|
},
|
||||||
domain: '*',
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Force browser to always use HTTPS
|
* Force browser to always use HTTPS
|
||||||
*/
|
*/
|
||||||
hsts: {
|
hsts: {
|
||||||
enabled: true,
|
enabled: true,
|
||||||
maxAge: '180 days',
|
maxAge: '180 days',
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Disable browsers from sniffing the content type of a
|
* Disable browsers from sniffing the content type of a
|
||||||
* response and always rely on the "content-type" header.
|
* response and always rely on the "content-type" header.
|
||||||
*/
|
*/
|
||||||
contentTypeSniffing: {
|
contentTypeSniffing: {
|
||||||
enabled: true,
|
enabled: true,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default shieldConfig;
|
export default shieldConfig;
|
||||||
|
|||||||
@@ -8,10 +8,10 @@ import { defineConfig } from '@adonisjs/static';
|
|||||||
* https://docs.adonisjs.com/guides/static-assets
|
* https://docs.adonisjs.com/guides/static-assets
|
||||||
*/
|
*/
|
||||||
const staticServerConfig = defineConfig({
|
const staticServerConfig = defineConfig({
|
||||||
enabled: true,
|
enabled: true,
|
||||||
etag: true,
|
etag: true,
|
||||||
lastModified: true,
|
lastModified: true,
|
||||||
dotFiles: 'ignore',
|
dotFiles: 'ignore',
|
||||||
});
|
});
|
||||||
|
|
||||||
export default staticServerConfig;
|
export default staticServerConfig;
|
||||||
|
|||||||
@@ -1,28 +1,28 @@
|
|||||||
import { defineConfig } from '@adonisjs/vite';
|
import { defineConfig } from '@adonisjs/vite';
|
||||||
|
|
||||||
const viteBackendConfig = defineConfig({
|
const viteBackendConfig = defineConfig({
|
||||||
/**
|
/**
|
||||||
* The output of vite will be written inside this
|
* The output of vite will be written inside this
|
||||||
* directory. The path should be relative from
|
* directory. The path should be relative from
|
||||||
* the application root.
|
* the application root.
|
||||||
*/
|
*/
|
||||||
buildDirectory: 'public/assets',
|
buildDirectory: 'public/assets',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The path to the manifest file generated by the
|
* The path to the manifest file generated by the
|
||||||
* "vite build" command.
|
* "vite build" command.
|
||||||
*/
|
*/
|
||||||
manifestFile: 'public/assets/.vite/manifest.json',
|
manifestFile: 'public/assets/.vite/manifest.json',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Feel free to change the value of the "assetsUrl" to
|
* Feel free to change the value of the "assetsUrl" to
|
||||||
* point to a CDN in production.
|
* point to a CDN in production.
|
||||||
*/
|
*/
|
||||||
assetsUrl: '/assets',
|
assetsUrl: '/assets',
|
||||||
|
|
||||||
scriptAttributes: {
|
scriptAttributes: {
|
||||||
defer: true,
|
defer: true,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
export default viteBackendConfig;
|
export default viteBackendConfig;
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import { Knex } from 'knex';
|
import { Knex } from 'knex';
|
||||||
|
|
||||||
export function defaultTableFields(table: Knex.CreateTableBuilder) {
|
export function defaultTableFields(table: Knex.CreateTableBuilder) {
|
||||||
table.increments('id').primary().first().unique().notNullable();
|
table.increments('id').primary().first().unique().notNullable();
|
||||||
|
|
||||||
table.timestamp('created_at').notNullable();
|
table.timestamp('created_at').notNullable();
|
||||||
table.timestamp('updated_at').nullable();
|
table.timestamp('updated_at').nullable();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,25 +2,32 @@ import { defaultTableFields } from '#database/default_table_fields';
|
|||||||
import { BaseSchema } from '@adonisjs/lucid/schema';
|
import { BaseSchema } from '@adonisjs/lucid/schema';
|
||||||
|
|
||||||
export default class CreateUsersTable extends BaseSchema {
|
export default class CreateUsersTable extends BaseSchema {
|
||||||
static tableName = 'users';
|
static tableName = 'users';
|
||||||
|
|
||||||
async up() {
|
async up() {
|
||||||
this.schema.createTableIfNotExists(CreateUsersTable.tableName, (table) => {
|
const exists = await this.schema.hasTable(CreateUsersTable.tableName);
|
||||||
table.string('email', 254).notNullable().unique();
|
if (exists) {
|
||||||
table.string('name', 254).notNullable();
|
return console.warn(
|
||||||
table.string('nick_name', 254).nullable();
|
`Table ${CreateUsersTable.tableName} already exists.`
|
||||||
table.text('avatar_url').notNullable();
|
);
|
||||||
table.boolean('is_admin').defaultTo(0).notNullable();
|
}
|
||||||
|
|
||||||
table.json('token').nullable();
|
this.schema.createTable(CreateUsersTable.tableName, (table) => {
|
||||||
table.string('provider_id').notNullable();
|
table.string('email', 254).notNullable().unique();
|
||||||
table.enum('provider_type', ['google']).notNullable().defaultTo('google');
|
table.string('name', 254).notNullable();
|
||||||
|
table.string('nick_name', 254).nullable();
|
||||||
|
table.text('avatar_url').notNullable();
|
||||||
|
table.boolean('is_admin').defaultTo(0).notNullable();
|
||||||
|
|
||||||
defaultTableFields(table);
|
table.json('token').nullable();
|
||||||
});
|
table.string('provider_id').notNullable();
|
||||||
}
|
table.enum('provider_type', ['google']).notNullable().defaultTo('google');
|
||||||
|
|
||||||
async down() {
|
defaultTableFields(table);
|
||||||
this.schema.dropTable(CreateUsersTable.tableName);
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async down() {
|
||||||
|
this.schema.dropTable(CreateUsersTable.tableName);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,42 +3,46 @@ import { Visibility } from '#enums/visibility';
|
|||||||
import { BaseSchema } from '@adonisjs/lucid/schema';
|
import { BaseSchema } from '@adonisjs/lucid/schema';
|
||||||
|
|
||||||
export default class CreateCollectionTable extends BaseSchema {
|
export default class CreateCollectionTable extends BaseSchema {
|
||||||
static tableName = 'collections';
|
static tableName = 'collections';
|
||||||
private visibilityEnumName = 'collection_visibility';
|
private visibilityEnumName = 'collection_visibility';
|
||||||
|
|
||||||
async up() {
|
async up() {
|
||||||
this.schema.raw(`DROP TYPE IF EXISTS ${this.visibilityEnumName}`);
|
this.schema.raw(`DROP TYPE IF EXISTS ${this.visibilityEnumName}`);
|
||||||
this.schema.createTableIfNotExists(
|
const exists = await this.schema.hasTable(CreateCollectionTable.tableName);
|
||||||
CreateCollectionTable.tableName,
|
if (exists) {
|
||||||
(table) => {
|
return console.warn(
|
||||||
table.string('name', 254).notNullable();
|
`Table ${CreateCollectionTable.tableName} already exists.`
|
||||||
table.string('description', 254).nullable();
|
);
|
||||||
table
|
}
|
||||||
.enum('visibility', Object.values(Visibility), {
|
|
||||||
useNative: true,
|
|
||||||
enumName: this.visibilityEnumName,
|
|
||||||
existingType: false,
|
|
||||||
})
|
|
||||||
.nullable()
|
|
||||||
.defaultTo(Visibility.PRIVATE);
|
|
||||||
table
|
|
||||||
.integer('next_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable('collections')
|
|
||||||
.defaultTo(null);
|
|
||||||
table
|
|
||||||
.integer('author_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable('users')
|
|
||||||
.onDelete('CASCADE');
|
|
||||||
|
|
||||||
defaultTableFields(table);
|
this.schema.createTable(CreateCollectionTable.tableName, (table) => {
|
||||||
}
|
table.string('name', 254).notNullable();
|
||||||
);
|
table.string('description', 254).nullable();
|
||||||
}
|
table
|
||||||
|
.enum('visibility', Object.values(Visibility), {
|
||||||
|
useNative: true,
|
||||||
|
enumName: this.visibilityEnumName,
|
||||||
|
existingType: false,
|
||||||
|
})
|
||||||
|
.nullable()
|
||||||
|
.defaultTo(Visibility.PRIVATE);
|
||||||
|
table
|
||||||
|
.integer('next_id')
|
||||||
|
.references('id')
|
||||||
|
.inTable('collections')
|
||||||
|
.defaultTo(null);
|
||||||
|
table
|
||||||
|
.integer('author_id')
|
||||||
|
.references('id')
|
||||||
|
.inTable('users')
|
||||||
|
.onDelete('CASCADE');
|
||||||
|
|
||||||
async down() {
|
defaultTableFields(table);
|
||||||
this.schema.raw(`DROP TYPE IF EXISTS ${this.visibilityEnumName}`);
|
});
|
||||||
this.schema.dropTable(CreateCollectionTable.tableName);
|
}
|
||||||
}
|
|
||||||
|
async down() {
|
||||||
|
this.schema.raw(`DROP TYPE IF EXISTS ${this.visibilityEnumName}`);
|
||||||
|
this.schema.dropTable(CreateCollectionTable.tableName);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,30 +2,36 @@ import { defaultTableFields } from '#database/default_table_fields';
|
|||||||
import { BaseSchema } from '@adonisjs/lucid/schema';
|
import { BaseSchema } from '@adonisjs/lucid/schema';
|
||||||
|
|
||||||
export default class CreateLinksTable extends BaseSchema {
|
export default class CreateLinksTable extends BaseSchema {
|
||||||
static tableName = 'links';
|
static tableName = 'links';
|
||||||
|
|
||||||
async up() {
|
async up() {
|
||||||
this.schema.createTableIfNotExists(CreateLinksTable.tableName, (table) => {
|
const exists = await this.schema.hasTable(CreateLinksTable.tableName);
|
||||||
table.string('name', 254).notNullable();
|
if (exists) {
|
||||||
table.string('description', 254).nullable();
|
return console.warn(`Table ${CreateLinksTable.tableName} already
|
||||||
table.text('url').notNullable();
|
exists.`);
|
||||||
table.boolean('favorite').notNullable().defaultTo(0);
|
}
|
||||||
table
|
|
||||||
.integer('collection_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable('collections')
|
|
||||||
.onDelete('CASCADE');
|
|
||||||
table
|
|
||||||
.integer('author_id')
|
|
||||||
.references('id')
|
|
||||||
.inTable('users')
|
|
||||||
.onDelete('CASCADE');
|
|
||||||
|
|
||||||
defaultTableFields(table);
|
this.schema.createTable(CreateLinksTable.tableName, (table) => {
|
||||||
});
|
table.string('name', 254).notNullable();
|
||||||
}
|
table.string('description', 254).nullable();
|
||||||
|
table.text('url').notNullable();
|
||||||
|
table.boolean('favorite').notNullable().defaultTo(0);
|
||||||
|
table
|
||||||
|
.integer('collection_id')
|
||||||
|
.references('id')
|
||||||
|
.inTable('collections')
|
||||||
|
.onDelete('CASCADE');
|
||||||
|
table
|
||||||
|
.integer('author_id')
|
||||||
|
.references('id')
|
||||||
|
.inTable('users')
|
||||||
|
.onDelete('CASCADE');
|
||||||
|
|
||||||
async down() {
|
defaultTableFields(table);
|
||||||
this.schema.dropTable(CreateLinksTable.tableName);
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async down() {
|
||||||
|
this.schema.dropTable(CreateLinksTable.tableName);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
import { BaseSchema } from '@adonisjs/lucid/schema';
|
import { BaseSchema } from '@adonisjs/lucid/schema';
|
||||||
|
|
||||||
export default class extends BaseSchema {
|
export default class extends BaseSchema {
|
||||||
async up() {
|
async up() {
|
||||||
this.schema.raw(`
|
this.schema.raw(`
|
||||||
CREATE EXTENSION IF NOT EXISTS unaccent;
|
CREATE EXTENSION IF NOT EXISTS unaccent;
|
||||||
CREATE EXTENSION IF NOT EXISTS pg_trgm;
|
CREATE EXTENSION IF NOT EXISTS pg_trgm;
|
||||||
`);
|
`);
|
||||||
this.schema.raw(`
|
this.schema.raw(`
|
||||||
CREATE INDEX ON links USING gin(to_tsvector('english', name));
|
CREATE INDEX ON links USING gin(to_tsvector('english', name));
|
||||||
CREATE INDEX ON collections USING gin(to_tsvector('english', name));
|
CREATE INDEX ON collections USING gin(to_tsvector('english', name));
|
||||||
CREATE INDEX ON links USING gin(to_tsvector('french', name));
|
CREATE INDEX ON links USING gin(to_tsvector('french', name));
|
||||||
CREATE INDEX ON collections USING gin(to_tsvector('french', name));
|
CREATE INDEX ON collections USING gin(to_tsvector('french', name));
|
||||||
`);
|
`);
|
||||||
this.schema.raw(`
|
this.schema.raw(`
|
||||||
CREATE OR REPLACE FUNCTION search_text(search_query TEXT, p_author_id INTEGER)
|
CREATE OR REPLACE FUNCTION search_text(search_query TEXT, p_author_id INTEGER)
|
||||||
RETURNS TABLE (
|
RETURNS TABLE (
|
||||||
id INTEGER,
|
id INTEGER,
|
||||||
@@ -45,9 +45,9 @@ export default class extends BaseSchema {
|
|||||||
$$
|
$$
|
||||||
LANGUAGE plpgsql;
|
LANGUAGE plpgsql;
|
||||||
`);
|
`);
|
||||||
}
|
}
|
||||||
|
|
||||||
async down() {
|
async down() {
|
||||||
this.schema.raw('DROP FUNCTION IF EXISTS search_text');
|
this.schema.raw('DROP FUNCTION IF EXISTS search_text');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
import { BaseSchema } from '@adonisjs/lucid/schema';
|
||||||
|
|
||||||
|
export default class extends BaseSchema {
|
||||||
|
protected tableName = 'users';
|
||||||
|
|
||||||
|
async up() {
|
||||||
|
this.schema.alterTable(this.tableName, (table) => {
|
||||||
|
table.timestamp('last_seen_at');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async down() {
|
||||||
|
this.schema.dropTable(this.tableName);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,35 +5,36 @@ import { BaseSeeder } from '@adonisjs/lucid/seeders';
|
|||||||
import { faker } from '@faker-js/faker';
|
import { faker } from '@faker-js/faker';
|
||||||
|
|
||||||
export default class extends BaseSeeder {
|
export default class extends BaseSeeder {
|
||||||
static environment = ['development', 'testing'];
|
static environment = ['development', 'testing'];
|
||||||
|
|
||||||
async run() {
|
async run() {
|
||||||
// eslint-disable-next-line unicorn/no-await-expression-member
|
const users = await getUserIds();
|
||||||
const users = await getUserIds();
|
|
||||||
|
|
||||||
const collections = faker.helpers.multiple(
|
const collections = faker.helpers.multiple(
|
||||||
() => createRandomCollection(users),
|
() => createRandomCollection(users),
|
||||||
{
|
{
|
||||||
count: 50,
|
count: 50,
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
await Collection.createMany(collections);
|
await Collection.createMany(collections);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function getUserIds() {
|
export async function getUserIds() {
|
||||||
const users = await User.all();
|
const users = await User.all();
|
||||||
return users.map(({ id }) => id);
|
return users.map(({ id }) => id);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let collectionId = 0;
|
||||||
function createRandomCollection(userIds: User['id'][]) {
|
function createRandomCollection(userIds: User['id'][]) {
|
||||||
const authorId = faker.helpers.arrayElements(userIds, 1).at(0);
|
const authorId = faker.helpers.arrayElements(userIds, 1).at(0);
|
||||||
return {
|
collectionId++;
|
||||||
id: faker.string.uuid(),
|
return {
|
||||||
name: faker.string.alphanumeric({ length: { min: 5, max: 25 } }),
|
id: collectionId,
|
||||||
description: faker.string.alphanumeric({ length: { min: 0, max: 254 } }),
|
name: faker.string.alphanumeric({ length: { min: 5, max: 25 } }),
|
||||||
visibility: Visibility.PRIVATE,
|
description: faker.string.alphanumeric({ length: { min: 0, max: 254 } }),
|
||||||
nextId: undefined,
|
visibility: Visibility.PRIVATE,
|
||||||
authorId,
|
nextId: collectionId + 1,
|
||||||
};
|
authorId,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,42 +6,41 @@ import { BaseSeeder } from '@adonisjs/lucid/seeders';
|
|||||||
import { faker } from '@faker-js/faker';
|
import { faker } from '@faker-js/faker';
|
||||||
|
|
||||||
export default class extends BaseSeeder {
|
export default class extends BaseSeeder {
|
||||||
static environment = ['development', 'testing'];
|
static environment = ['development', 'testing'];
|
||||||
|
|
||||||
async run() {
|
async run() {
|
||||||
// eslint-disable-next-line unicorn/no-await-expression-member
|
const users = await getUserIds();
|
||||||
const users = await getUserIds();
|
|
||||||
|
|
||||||
const links = await Promise.all(
|
const links = await Promise.all(
|
||||||
faker.helpers.multiple(async () => createRandomLink(users), {
|
faker.helpers.multiple(async () => createRandomLink(users), {
|
||||||
count: 500,
|
count: 500,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
await Link.createMany(links.filter((a) => typeof a !== 'undefined') as any);
|
await Link.createMany(links.filter((a) => typeof a !== 'undefined') as any);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function getCollectionIds(authorId: User['id']) {
|
async function getCollectionIds(authorId: User['id']) {
|
||||||
const collection = await Collection.findManyBy('author_id', authorId);
|
const collection = await Collection.findManyBy('author_id', authorId);
|
||||||
return collection.map(({ id }) => id);
|
return collection.map(({ id }) => id);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function createRandomLink(userIds: User['id'][]) {
|
async function createRandomLink(userIds: User['id'][]) {
|
||||||
const authorId = faker.helpers.arrayElements(userIds, 1).at(0)!;
|
const authorId = faker.helpers.arrayElements(userIds, 1).at(0)!;
|
||||||
const collections = await getCollectionIds(authorId);
|
const collections = await getCollectionIds(authorId);
|
||||||
|
|
||||||
const collectionId = faker.helpers.arrayElements(collections, 1).at(0);
|
const collectionId = faker.helpers.arrayElements(collections, 1).at(0);
|
||||||
if (!collectionId) {
|
if (!collectionId) {
|
||||||
return undefined;
|
return undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
id: faker.string.uuid(),
|
id: faker.string.uuid(),
|
||||||
name: faker.string.alphanumeric({ length: { min: 5, max: 25 } }),
|
name: faker.string.alphanumeric({ length: { min: 5, max: 25 } }),
|
||||||
description: faker.string.alphanumeric({ length: { min: 0, max: 254 } }),
|
description: faker.string.alphanumeric({ length: { min: 0, max: 254 } }),
|
||||||
url: faker.internet.url(),
|
url: faker.internet.url(),
|
||||||
favorite: faker.number.int({ min: 0, max: 1 }),
|
favorite: faker.number.int({ min: 0, max: 1 }),
|
||||||
authorId,
|
authorId,
|
||||||
collectionId,
|
collectionId,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,31 +3,31 @@ import logger from '@adonisjs/core/services/logger';
|
|||||||
import { BaseSeeder } from '@adonisjs/lucid/seeders';
|
import { BaseSeeder } from '@adonisjs/lucid/seeders';
|
||||||
|
|
||||||
export default class IndexSeeder extends BaseSeeder {
|
export default class IndexSeeder extends BaseSeeder {
|
||||||
private async seed(Seeder: { default: typeof BaseSeeder }) {
|
private async seed(Seeder: { default: typeof BaseSeeder }) {
|
||||||
/**
|
/**
|
||||||
* Do not run when not in a environment specified in Seeder
|
* Do not run when not in a environment specified in Seeder
|
||||||
*/
|
*/
|
||||||
if (
|
if (
|
||||||
!Seeder.default.environment ||
|
!Seeder.default.environment ||
|
||||||
(!Seeder.default.environment.includes('development') && app.inDev) ||
|
(!Seeder.default.environment.includes('development') && app.inDev) ||
|
||||||
(!Seeder.default.environment.includes('testing') && app.inTest) ||
|
(!Seeder.default.environment.includes('testing') && app.inTest) ||
|
||||||
(!Seeder.default.environment.includes('production') && app.inProduction)
|
(!Seeder.default.environment.includes('production') && app.inProduction)
|
||||||
) {
|
) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
await new Seeder.default(this.client).run();
|
await new Seeder.default(this.client).run();
|
||||||
}
|
}
|
||||||
|
|
||||||
async run() {
|
async run() {
|
||||||
logger.info('Start user seed');
|
logger.info('Start user seed');
|
||||||
await this.seed(await import('#database/seeders/user_seeder'));
|
await this.seed(await import('#database/seeders/user_seeder'));
|
||||||
logger.info('User seed done');
|
logger.info('User seed done');
|
||||||
logger.info('Collection user seed');
|
logger.info('Collection user seed');
|
||||||
await this.seed(await import('#database/seeders/collection_seeder'));
|
await this.seed(await import('#database/seeders/collection_seeder'));
|
||||||
logger.info('Collection seed done');
|
logger.info('Collection seed done');
|
||||||
logger.info('Link user seed');
|
logger.info('Link user seed');
|
||||||
await this.seed(await import('#database/seeders/link_seeder'));
|
await this.seed(await import('#database/seeders/link_seeder'));
|
||||||
logger.info('Link seed done');
|
logger.info('Link seed done');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,26 +4,26 @@ import { BaseSeeder } from '@adonisjs/lucid/seeders';
|
|||||||
import { faker } from '@faker-js/faker';
|
import { faker } from '@faker-js/faker';
|
||||||
|
|
||||||
export default class extends BaseSeeder {
|
export default class extends BaseSeeder {
|
||||||
static environment = ['development', 'testing'];
|
static environment = ['development', 'testing'];
|
||||||
|
|
||||||
async run() {
|
async run() {
|
||||||
const users = faker.helpers.multiple(createRandomUser, {
|
const users = faker.helpers.multiple(createRandomUser, {
|
||||||
count: 25,
|
count: 25,
|
||||||
});
|
});
|
||||||
await User.createMany(users);
|
await User.createMany(users);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function createRandomUser() {
|
export function createRandomUser() {
|
||||||
return {
|
return {
|
||||||
id: faker.number.int(),
|
id: faker.number.int(),
|
||||||
email: faker.internet.email(),
|
email: faker.internet.email(),
|
||||||
name: faker.internet.userName(),
|
name: faker.internet.userName(),
|
||||||
nickName: faker.internet.displayName(),
|
nickName: faker.internet.displayName(),
|
||||||
avatarUrl: faker.image.avatar(),
|
avatarUrl: faker.image.avatar(),
|
||||||
isAdmin: false,
|
isAdmin: false,
|
||||||
providerId: faker.number.int(),
|
providerId: faker.number.int(),
|
||||||
providerType: 'google' as const,
|
providerType: 'google' as const,
|
||||||
token: {} as GoogleToken,
|
token: {} as GoogleToken,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
62
dev.compose.yml
Normal file
62
dev.compose.yml
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
name: my-links-dev
|
||||||
|
services:
|
||||||
|
postgres:
|
||||||
|
container_name: postgres
|
||||||
|
image: postgres:16
|
||||||
|
restart: always
|
||||||
|
environment:
|
||||||
|
- POSTGRES_DB=${DB_DATABASE}
|
||||||
|
- POSTGRES_USER=${DB_USER}
|
||||||
|
- POSTGRES_PASSWORD=${DB_PASSWORD}
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD-SHELL", "pg_isready", "-U", "${DB_USER}"]
|
||||||
|
volumes:
|
||||||
|
- postgres-volume:/var/lib/postgresql/data
|
||||||
|
ports:
|
||||||
|
- "${DB_PORT}:5432"
|
||||||
|
|
||||||
|
pgadmin:
|
||||||
|
container_name: pgadmin
|
||||||
|
image: dpage/pgadmin4:8
|
||||||
|
restart: always
|
||||||
|
entrypoint: /bin/sh -c "chmod 0600 /pgpass; /entrypoint.sh;"
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "wget", "-O", "-", "http://localhost:80/misc/ping"]
|
||||||
|
interval: 2s
|
||||||
|
timeout: 10s
|
||||||
|
retries: 30
|
||||||
|
env_file: .env
|
||||||
|
environment:
|
||||||
|
- PGADMIN_DEFAULT_EMAIL=myemail@gmail.com
|
||||||
|
- PGADMIN_DEFAULT_PASSWORD=a12345678
|
||||||
|
- PGADMIN_CONFIG_SERVER_MODE=False
|
||||||
|
- PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED=False
|
||||||
|
depends_on:
|
||||||
|
- postgres
|
||||||
|
ports:
|
||||||
|
- "5050:80"
|
||||||
|
user: root
|
||||||
|
configs:
|
||||||
|
- source: servers.json
|
||||||
|
target: /pgadmin4/servers.json
|
||||||
|
- source: pgpass
|
||||||
|
target: /pgpass
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
postgres-volume:
|
||||||
|
|
||||||
|
configs:
|
||||||
|
pgpass:
|
||||||
|
content: postgres:${DB_PORT}:*:${DB_USER}:${DB_PASSWORD}
|
||||||
|
servers.json:
|
||||||
|
content: |
|
||||||
|
{"Servers": {"1": {
|
||||||
|
"Group": "Servers",
|
||||||
|
"Name": "project",
|
||||||
|
"Host": "postgres",
|
||||||
|
"Port": ${DB_PORT},
|
||||||
|
"MaintenanceDB": "${DB_DATABASE}",
|
||||||
|
"Username": "${DB_USER}",
|
||||||
|
"PassFile": "/pgpass",
|
||||||
|
"SSLMode": "prefer"
|
||||||
|
}}}
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
name: dev-stack
|
|
||||||
services:
|
|
||||||
postgres:
|
|
||||||
container_name: postgres
|
|
||||||
image: postgres:16
|
|
||||||
restart: always
|
|
||||||
environment:
|
|
||||||
- POSTGRES_DB=${DB_DATABASE}
|
|
||||||
- POSTGRES_USER=${DB_USER}
|
|
||||||
- POSTGRES_PASSWORD=${DB_PASSWORD}
|
|
||||||
healthcheck:
|
|
||||||
test: ['CMD-SHELL', 'pg_isready']
|
|
||||||
volumes:
|
|
||||||
- postgres_volume:/var/lib/postgresql/data
|
|
||||||
ports:
|
|
||||||
- '${DB_PORT}:5432'
|
|
||||||
|
|
||||||
pgadmin:
|
|
||||||
container_name: pgadmin
|
|
||||||
image: dpage/pgadmin4:8.6
|
|
||||||
restart: always
|
|
||||||
environment:
|
|
||||||
- PGADMIN_DEFAULT_EMAIL=myemail@gmail.com
|
|
||||||
- PGADMIN_DEFAULT_PASSWORD=a12345678
|
|
||||||
depends_on:
|
|
||||||
- postgres
|
|
||||||
volumes:
|
|
||||||
- ./docker-config/servers_pgadmin.json:/pgadmin4/servers.json
|
|
||||||
ports:
|
|
||||||
- '5050:80'
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
postgres_volume:
|
|
||||||
name: postgres_test_dev_stack
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
{
|
|
||||||
"Servers": {
|
|
||||||
"1": {
|
|
||||||
"Name": "project",
|
|
||||||
"Group": "Servers",
|
|
||||||
"Port": 5432,
|
|
||||||
"Username": "postgres",
|
|
||||||
"Host": "postgres",
|
|
||||||
"SSLMode": "prefer",
|
|
||||||
"MaintenanceDB": "my-links"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
BIN
docs/imgs/ml_dashboard_dark.png
Normal file
BIN
docs/imgs/ml_dashboard_dark.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
4
eslint.config.js
Normal file
4
eslint.config.js
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
import { configApp } from '@adonisjs/eslint-config';
|
||||||
|
export default configApp({
|
||||||
|
files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
|
||||||
|
});
|
||||||
@@ -3,25 +3,23 @@ import { createInertiaApp } from '@inertiajs/react';
|
|||||||
import 'dayjs/locale/en';
|
import 'dayjs/locale/en';
|
||||||
import 'dayjs/locale/fr';
|
import 'dayjs/locale/fr';
|
||||||
import { hydrateRoot } from 'react-dom/client';
|
import { hydrateRoot } from 'react-dom/client';
|
||||||
import 'react-toggle/style.css';
|
|
||||||
import { primaryColor } from '~/styles/common_colors';
|
|
||||||
import '../i18n/index';
|
import '../i18n/index';
|
||||||
|
|
||||||
const appName = import.meta.env.VITE_APP_NAME || 'MyLinks';
|
const appName = import.meta.env.VITE_APP_NAME || 'MyLinks';
|
||||||
|
|
||||||
createInertiaApp({
|
createInertiaApp({
|
||||||
progress: { color: primaryColor },
|
progress: { color: '#5474B4' },
|
||||||
|
|
||||||
title: (title) => `${appName}${title && ` - ${title}`}`,
|
title: (title) => `${appName}${title && ` - ${title}`}`,
|
||||||
|
|
||||||
resolve: (name) => {
|
resolve: (name) => {
|
||||||
return resolvePageComponent(
|
return resolvePageComponent(
|
||||||
`../pages/${name}.tsx`,
|
`../pages/${name}.tsx`,
|
||||||
import.meta.glob('../pages/**/*.tsx')
|
import.meta.glob('../pages/**/*.tsx')
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
|
|
||||||
setup({ el, App, props }) {
|
setup({ el, App, props }) {
|
||||||
hydrateRoot(el, <App {...props} />);
|
hydrateRoot(el, <App {...props} />);
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,13 +2,13 @@ import { createInertiaApp } from '@inertiajs/react';
|
|||||||
import ReactDOMServer from 'react-dom/server';
|
import ReactDOMServer from 'react-dom/server';
|
||||||
|
|
||||||
export default function render(page: any) {
|
export default function render(page: any) {
|
||||||
return createInertiaApp({
|
return createInertiaApp({
|
||||||
page,
|
page,
|
||||||
render: ReactDOMServer.renderToString,
|
render: ReactDOMServer.renderToString,
|
||||||
resolve: (name) => {
|
resolve: (name) => {
|
||||||
const pages = import.meta.glob('../pages/**/*.tsx', { eager: true });
|
const pages = import.meta.glob('../pages/**/*.tsx', { eager: true });
|
||||||
return pages[`../pages/${name}.tsx`];
|
return pages[`../pages/${name}.tsx`];
|
||||||
},
|
},
|
||||||
setup: ({ App, props }) => <App {...props} />,
|
setup: ({ App, props }) => <App {...props} />,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
28
inertia/components/admin/users/th.tsx
Normal file
28
inertia/components/admin/users/th.tsx
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
import { Center, Group, rem, Table, Text, UnstyledButton } from '@mantine/core';
|
||||||
|
import { PropsWithChildren } from 'react';
|
||||||
|
import { TbChevronDown, TbChevronUp, TbSelector } from 'react-icons/tb';
|
||||||
|
import classes from './users_table.module.css';
|
||||||
|
|
||||||
|
interface ThProps extends PropsWithChildren {
|
||||||
|
reversed: boolean;
|
||||||
|
sorted: boolean;
|
||||||
|
onSort(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Th({ children, reversed, sorted, onSort }: ThProps) {
|
||||||
|
const Icon = sorted ? (reversed ? TbChevronUp : TbChevronDown) : TbSelector;
|
||||||
|
return (
|
||||||
|
<Table.Th className={classes.th}>
|
||||||
|
<UnstyledButton onClick={onSort} className={classes.control}>
|
||||||
|
<Group justify="space-between">
|
||||||
|
<Text fw={500} fz="sm">
|
||||||
|
{children}
|
||||||
|
</Text>
|
||||||
|
<Center className={classes.icon}>
|
||||||
|
<Icon style={{ width: rem(16), height: rem(16) }} />
|
||||||
|
</Center>
|
||||||
|
</Group>
|
||||||
|
</UnstyledButton>
|
||||||
|
</Table.Th>
|
||||||
|
);
|
||||||
|
}
|
||||||
21
inertia/components/admin/users/users_table.module.css
Normal file
21
inertia/components/admin/users/users_table.module.css
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
.th {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.control {
|
||||||
|
width: 100%;
|
||||||
|
padding: var(--mantine-spacing-xs) var(--mantine-spacing-md);
|
||||||
|
|
||||||
|
@mixin hover {
|
||||||
|
background-color: light-dark(
|
||||||
|
var(--mantine-color-gray-0),
|
||||||
|
var(--mantine-color-dark-6)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon {
|
||||||
|
width: rem(21px);
|
||||||
|
height: rem(21px);
|
||||||
|
border-radius: rem(21px);
|
||||||
|
}
|
||||||
174
inertia/components/admin/users/users_table.tsx
Normal file
174
inertia/components/admin/users/users_table.tsx
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
import {
|
||||||
|
ScrollArea,
|
||||||
|
Table,
|
||||||
|
Text,
|
||||||
|
TextInput,
|
||||||
|
Tooltip,
|
||||||
|
rem,
|
||||||
|
} from '@mantine/core';
|
||||||
|
import dayjs from 'dayjs';
|
||||||
|
import relativeTime from 'dayjs/plugin/relativeTime';
|
||||||
|
import { ChangeEvent, useState } from 'react';
|
||||||
|
import { useTranslation } from 'react-i18next';
|
||||||
|
import { TbSearch } from 'react-icons/tb';
|
||||||
|
import { Th } from '~/components/admin/users/th';
|
||||||
|
import { sortData } from '~/components/admin/users/utils';
|
||||||
|
import { UserBadgeRole } from '~/components/common/user_badge_role';
|
||||||
|
import { DATE_FORMAT } from '~/constants';
|
||||||
|
import { User } from '~/types/app';
|
||||||
|
|
||||||
|
dayjs.extend(relativeTime);
|
||||||
|
|
||||||
|
export type UserWithCounts = User & {
|
||||||
|
linksCount: number;
|
||||||
|
collectionsCount: number;
|
||||||
|
};
|
||||||
|
export type UsersWithCounts = UserWithCounts[];
|
||||||
|
|
||||||
|
export type Columns = keyof UserWithCounts;
|
||||||
|
|
||||||
|
const DEFAULT_SORT_BY: Columns = 'lastSeenAt';
|
||||||
|
const DEFAULT_SORT_DIRECTION = true;
|
||||||
|
|
||||||
|
export interface UsersTableProps {
|
||||||
|
users: UsersWithCounts;
|
||||||
|
totalCollections: number;
|
||||||
|
totalLinks: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function UsersTable({
|
||||||
|
users,
|
||||||
|
totalCollections,
|
||||||
|
totalLinks,
|
||||||
|
}: UsersTableProps) {
|
||||||
|
const { t } = useTranslation();
|
||||||
|
|
||||||
|
const [search, setSearch] = useState<string>('');
|
||||||
|
const [sortBy, setSortBy] = useState<Columns | null>(DEFAULT_SORT_BY);
|
||||||
|
const [reverseSortDirection, setReverseSortDirection] = useState(
|
||||||
|
DEFAULT_SORT_DIRECTION
|
||||||
|
);
|
||||||
|
const [sortedData, setSortedData] = useState(() =>
|
||||||
|
sortData(users, {
|
||||||
|
sortBy: sortBy,
|
||||||
|
reversed: reverseSortDirection,
|
||||||
|
search: '',
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
const setSorting = (field: keyof UserWithCounts) => {
|
||||||
|
const reversed = field === sortBy ? !reverseSortDirection : false;
|
||||||
|
setReverseSortDirection(reversed);
|
||||||
|
setSortBy(field);
|
||||||
|
setSortedData(sortData(users, { sortBy: field, reversed, search }));
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleSearchChange = (event: ChangeEvent<HTMLInputElement>) => {
|
||||||
|
const { value } = event.currentTarget;
|
||||||
|
setSearch(value);
|
||||||
|
setSortedData(
|
||||||
|
sortData(users, {
|
||||||
|
sortBy: sortBy,
|
||||||
|
reversed: reverseSortDirection,
|
||||||
|
search: value,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const renderDateCell = (date: string) => (
|
||||||
|
<Tooltip label={dayjs(date).format(DATE_FORMAT).toString()}>
|
||||||
|
<Text>{dayjs(date).fromNow()}</Text>
|
||||||
|
</Tooltip>
|
||||||
|
);
|
||||||
|
|
||||||
|
const rows = sortedData.map((user) => (
|
||||||
|
<Table.Tr key={user.id}>
|
||||||
|
<Table.Td>{user.fullname}</Table.Td>
|
||||||
|
<Table.Td>
|
||||||
|
<UserBadgeRole user={user} />
|
||||||
|
</Table.Td>
|
||||||
|
<Table.Td>{user.collectionsCount}</Table.Td>
|
||||||
|
<Table.Td>{user.linksCount}</Table.Td>
|
||||||
|
<Table.Td>{renderDateCell(user.createdAt)}</Table.Td>
|
||||||
|
<Table.Td>{renderDateCell(user.lastSeenAt)}</Table.Td>
|
||||||
|
</Table.Tr>
|
||||||
|
));
|
||||||
|
|
||||||
|
return (
|
||||||
|
<ScrollArea>
|
||||||
|
<TextInput
|
||||||
|
placeholder={`Search by any field (${users.length} users)`}
|
||||||
|
mb="md"
|
||||||
|
leftSection={<TbSearch style={{ width: rem(16), height: rem(16) }} />}
|
||||||
|
value={search}
|
||||||
|
onChange={handleSearchChange}
|
||||||
|
/>
|
||||||
|
<Table
|
||||||
|
horizontalSpacing="md"
|
||||||
|
verticalSpacing="xs"
|
||||||
|
miw={700}
|
||||||
|
layout="fixed"
|
||||||
|
>
|
||||||
|
<Table.Tbody>
|
||||||
|
<Table.Tr>
|
||||||
|
<Th
|
||||||
|
sorted={sortBy === 'fullname'}
|
||||||
|
reversed={reverseSortDirection}
|
||||||
|
onSort={() => setSorting('fullname')}
|
||||||
|
>
|
||||||
|
{t('common:name')}
|
||||||
|
</Th>
|
||||||
|
<Th
|
||||||
|
sorted={sortBy === 'isAdmin'}
|
||||||
|
reversed={reverseSortDirection}
|
||||||
|
onSort={() => setSorting('isAdmin')}
|
||||||
|
>
|
||||||
|
{t('admin:role')}
|
||||||
|
</Th>
|
||||||
|
<Th
|
||||||
|
sorted={sortBy === 'collectionsCount'}
|
||||||
|
reversed={reverseSortDirection}
|
||||||
|
onSort={() => setSorting('collectionsCount')}
|
||||||
|
>
|
||||||
|
{t('common:collection.collections')} ({totalCollections})
|
||||||
|
</Th>
|
||||||
|
<Th
|
||||||
|
sorted={sortBy === 'linksCount'}
|
||||||
|
reversed={reverseSortDirection}
|
||||||
|
onSort={() => setSorting('linksCount')}
|
||||||
|
>
|
||||||
|
{t('common:link.links')} ({totalLinks})
|
||||||
|
</Th>
|
||||||
|
<Th
|
||||||
|
sorted={sortBy === 'createdAt'}
|
||||||
|
reversed={reverseSortDirection}
|
||||||
|
onSort={() => setSorting('createdAt')}
|
||||||
|
>
|
||||||
|
{t('admin:created_at')}
|
||||||
|
</Th>
|
||||||
|
<Th
|
||||||
|
sorted={sortBy === 'lastSeenAt'}
|
||||||
|
reversed={reverseSortDirection}
|
||||||
|
onSort={() => setSorting('lastSeenAt')}
|
||||||
|
>
|
||||||
|
{t('admin:last_seen_at')}
|
||||||
|
</Th>
|
||||||
|
</Table.Tr>
|
||||||
|
</Table.Tbody>
|
||||||
|
<Table.Tbody>
|
||||||
|
{rows.length > 0 ? (
|
||||||
|
rows
|
||||||
|
) : (
|
||||||
|
<Table.Tr>
|
||||||
|
<Table.Td colSpan={4}>
|
||||||
|
<Text fw={500} ta="center">
|
||||||
|
Nothing found
|
||||||
|
</Text>
|
||||||
|
</Table.Td>
|
||||||
|
</Table.Tr>
|
||||||
|
)}
|
||||||
|
</Table.Tbody>
|
||||||
|
</Table>
|
||||||
|
</ScrollArea>
|
||||||
|
);
|
||||||
|
}
|
||||||
39
inertia/components/admin/users/utils.ts
Normal file
39
inertia/components/admin/users/utils.ts
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import {
|
||||||
|
UsersWithCounts,
|
||||||
|
UserWithCounts,
|
||||||
|
} from '~/components/admin/users/users_table';
|
||||||
|
|
||||||
|
export function filterData(data: UsersWithCounts, search: string) {
|
||||||
|
const query = search.toLowerCase().trim();
|
||||||
|
return data.filter((item) =>
|
||||||
|
['email', 'name', 'nickName', 'fullname'].some((key) => {
|
||||||
|
const value = item[key as keyof UserWithCounts];
|
||||||
|
return typeof value === 'string' && value.toLowerCase().includes(query);
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function sortData(
|
||||||
|
data: UsersWithCounts,
|
||||||
|
payload: {
|
||||||
|
sortBy: keyof UserWithCounts | null;
|
||||||
|
reversed: boolean;
|
||||||
|
search: string;
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
const { sortBy } = payload;
|
||||||
|
|
||||||
|
if (!sortBy) {
|
||||||
|
return filterData(data, payload.search);
|
||||||
|
}
|
||||||
|
|
||||||
|
return filterData(
|
||||||
|
[...data].sort((a, b) => {
|
||||||
|
if (payload.reversed) {
|
||||||
|
return b[sortBy] > a[sortBy] ? 1 : -1;
|
||||||
|
}
|
||||||
|
return a[sortBy] > b[sortBy] ? 1 : -1;
|
||||||
|
}),
|
||||||
|
payload.search
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
import { ReactNode, useRef } from 'react';
|
|
||||||
import DropdownContainer from '~/components/common/dropdown/dropdown_container';
|
|
||||||
import DropdownLabel from '~/components/common/dropdown/dropdown_label';
|
|
||||||
import useClickOutside from '~/hooks/use_click_outside';
|
|
||||||
import useToggle from '~/hooks/use_modal';
|
|
||||||
import useShortcut from '~/hooks/use_shortcut';
|
|
||||||
|
|
||||||
const DropdownStyle = styled.div<{ opened: boolean; svgSize?: number }>(
|
|
||||||
({ opened, theme, svgSize = 24 }) => ({
|
|
||||||
cursor: 'pointer',
|
|
||||||
userSelect: 'none',
|
|
||||||
position: 'relative',
|
|
||||||
minWidth: 'fit-content',
|
|
||||||
width: 'fit-content',
|
|
||||||
maxWidth: '250px',
|
|
||||||
backgroundColor: opened ? theme.colors.secondary : theme.colors.background,
|
|
||||||
padding: '4px',
|
|
||||||
borderRadius: theme.border.radius,
|
|
||||||
|
|
||||||
'&:hover': {
|
|
||||||
backgroundColor: theme.colors.secondary,
|
|
||||||
},
|
|
||||||
|
|
||||||
'& svg': {
|
|
||||||
height: `${svgSize}px`,
|
|
||||||
width: `${svgSize}px`,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
export default function Dropdown({
|
|
||||||
children,
|
|
||||||
label,
|
|
||||||
className,
|
|
||||||
svgSize,
|
|
||||||
}: {
|
|
||||||
children: ReactNode;
|
|
||||||
label: ReactNode | string;
|
|
||||||
className?: string;
|
|
||||||
svgSize?: number;
|
|
||||||
}) {
|
|
||||||
const dropdownRef = useRef<HTMLDivElement>(null);
|
|
||||||
const { isShowing, toggle, close } = useToggle();
|
|
||||||
|
|
||||||
useClickOutside(dropdownRef, close);
|
|
||||||
useShortcut('ESCAPE_KEY', close, { disableGlobalCheck: true });
|
|
||||||
|
|
||||||
return (
|
|
||||||
<DropdownStyle
|
|
||||||
opened={isShowing}
|
|
||||||
onClick={toggle}
|
|
||||||
ref={dropdownRef}
|
|
||||||
className={className}
|
|
||||||
svgSize={svgSize}
|
|
||||||
>
|
|
||||||
<DropdownLabel>{label}</DropdownLabel>
|
|
||||||
<DropdownContainer show={isShowing}>{children}</DropdownContainer>
|
|
||||||
</DropdownStyle>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
import TransitionLayout from '~/components/layouts/_transition_layout';
|
|
||||||
|
|
||||||
const DropdownContainer = styled(TransitionLayout)<{ show: boolean }>(
|
|
||||||
({ show, theme }) => ({
|
|
||||||
zIndex: 99,
|
|
||||||
position: 'absolute',
|
|
||||||
top: 'calc(100% + 0.5em)',
|
|
||||||
right: 0,
|
|
||||||
minWidth: '175px',
|
|
||||||
backgroundColor: show ? theme.colors.secondary : theme.colors.background,
|
|
||||||
border: `2px solid ${theme.colors.secondary}`,
|
|
||||||
borderRadius: theme.border.radius,
|
|
||||||
boxShadow: theme.colors.boxShadow,
|
|
||||||
display: show ? 'flex' : 'none',
|
|
||||||
flexDirection: 'column',
|
|
||||||
overflow: 'hidden',
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
export default DropdownContainer;
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
import { Link } from '@inertiajs/react';
|
|
||||||
|
|
||||||
const DropdownItemBase = styled('div', {
|
|
||||||
shouldForwardProp: (propName) => propName !== 'danger',
|
|
||||||
})<{ danger?: boolean }>(({ theme, danger }) => ({
|
|
||||||
fontSize: '14px',
|
|
||||||
whiteSpace: 'nowrap',
|
|
||||||
color: danger ? theme.colors.lightRed : theme.colors.primary,
|
|
||||||
padding: '8px 12px',
|
|
||||||
borderRadius: theme.border.radius,
|
|
||||||
|
|
||||||
'&:hover': {
|
|
||||||
backgroundColor: theme.colors.background,
|
|
||||||
},
|
|
||||||
}));
|
|
||||||
|
|
||||||
const DropdownItemButton = styled(DropdownItemBase)({
|
|
||||||
display: 'flex',
|
|
||||||
gap: '0.75em',
|
|
||||||
alignItems: 'center',
|
|
||||||
});
|
|
||||||
|
|
||||||
const DropdownItemLink = styled(DropdownItemBase.withComponent(Link))({
|
|
||||||
width: '100%',
|
|
||||||
display: 'flex',
|
|
||||||
gap: '0.75em',
|
|
||||||
alignItems: 'center',
|
|
||||||
});
|
|
||||||
|
|
||||||
export { DropdownItemButton, DropdownItemLink };
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const DropdownLabel = styled.div(({ theme }) => ({
|
|
||||||
height: 'auto',
|
|
||||||
width: 'auto',
|
|
||||||
color: theme.colors.font,
|
|
||||||
display: 'flex',
|
|
||||||
gap: '0.35em',
|
|
||||||
}));
|
|
||||||
|
|
||||||
export default DropdownLabel;
|
|
||||||
@@ -1,18 +1,18 @@
|
|||||||
import { AnchorHTMLAttributes, CSSProperties, ReactNode } from 'react';
|
import { AnchorHTMLAttributes, CSSProperties, ReactNode } from 'react';
|
||||||
|
|
||||||
export default function ExternalLink({
|
export default function ExternalLink({
|
||||||
children,
|
children,
|
||||||
title,
|
title,
|
||||||
...props
|
...props
|
||||||
}: AnchorHTMLAttributes<HTMLAnchorElement> & {
|
}: AnchorHTMLAttributes<HTMLAnchorElement> & {
|
||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
style?: CSSProperties;
|
style?: CSSProperties;
|
||||||
title?: string;
|
title?: string;
|
||||||
className?: string;
|
className?: string;
|
||||||
}) {
|
}) {
|
||||||
return (
|
return (
|
||||||
<a target="_blank" rel="noreferrer" title={title} {...props}>
|
<a target="_blank" rel="noreferrer" title={title} {...props}>
|
||||||
{children}
|
{children}
|
||||||
</a>
|
</a>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
26
inertia/components/common/external_link_styled.tsx
Normal file
26
inertia/components/common/external_link_styled.tsx
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import { Anchor } from '@mantine/core';
|
||||||
|
import { AnchorHTMLAttributes, CSSProperties, ReactNode } from 'react';
|
||||||
|
|
||||||
|
export function ExternalLinkStyled({
|
||||||
|
children,
|
||||||
|
title,
|
||||||
|
...props
|
||||||
|
}: AnchorHTMLAttributes<HTMLAnchorElement> & {
|
||||||
|
children: ReactNode;
|
||||||
|
style?: CSSProperties;
|
||||||
|
title?: string;
|
||||||
|
className?: string;
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<Anchor<'a'>
|
||||||
|
component="a"
|
||||||
|
underline="never"
|
||||||
|
target="_blank"
|
||||||
|
rel="noreferrer"
|
||||||
|
title={title}
|
||||||
|
{...props}
|
||||||
|
>
|
||||||
|
{children}
|
||||||
|
</Anchor>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const Button = styled.button<{ danger?: boolean }>(({ theme, danger }) => {
|
|
||||||
const btnColor = !danger ? theme.colors.primary : theme.colors.lightRed;
|
|
||||||
const btnDarkColor = !danger ? theme.colors.darkBlue : theme.colors.lightRed;
|
|
||||||
return {
|
|
||||||
cursor: 'pointer',
|
|
||||||
width: '100%',
|
|
||||||
textTransform: 'uppercase',
|
|
||||||
fontSize: '14px',
|
|
||||||
color: theme.colors.white,
|
|
||||||
background: btnColor,
|
|
||||||
padding: '0.75em',
|
|
||||||
border: `1px solid ${btnColor}`,
|
|
||||||
borderRadius: theme.border.radius,
|
|
||||||
transition: theme.transition.delay,
|
|
||||||
|
|
||||||
'&:disabled': {
|
|
||||||
cursor: 'not-allowed',
|
|
||||||
opacity: '0.5',
|
|
||||||
},
|
|
||||||
|
|
||||||
'&:not(:disabled):hover': {
|
|
||||||
boxShadow: `${btnDarkColor} 0 0 3px 1px`,
|
|
||||||
background: btnDarkColor,
|
|
||||||
color: theme.colors.white,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
export default Button;
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const Form = styled.form({
|
|
||||||
width: '100%',
|
|
||||||
display: 'flex',
|
|
||||||
gap: '1em',
|
|
||||||
flexDirection: 'column',
|
|
||||||
});
|
|
||||||
|
|
||||||
export default Form;
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const FormField = styled('div', {
|
|
||||||
shouldForwardProp: (propName) => propName !== 'required',
|
|
||||||
})<{ required?: boolean }>(({ required, theme }) => ({
|
|
||||||
display: 'flex',
|
|
||||||
gap: '0.25em',
|
|
||||||
flexDirection: 'column',
|
|
||||||
|
|
||||||
'& label': {
|
|
||||||
position: 'relative',
|
|
||||||
userSelect: 'none',
|
|
||||||
width: 'fit-content',
|
|
||||||
},
|
|
||||||
|
|
||||||
'& label::after': {
|
|
||||||
position: 'absolute',
|
|
||||||
top: 0,
|
|
||||||
right: '-0.75em',
|
|
||||||
color: theme.colors.lightRed,
|
|
||||||
content: (required ? '"*"' : '""') as any,
|
|
||||||
},
|
|
||||||
}));
|
|
||||||
|
|
||||||
export default FormField;
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
// TODO: create a global style variable (fontSize)
|
|
||||||
const FormFieldError = styled.p(({ theme }) => ({
|
|
||||||
fontSize: '12px',
|
|
||||||
color: theme.colors.lightRed,
|
|
||||||
}));
|
|
||||||
|
|
||||||
export default FormFieldError;
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const Input = styled.input(({ theme }) => ({
|
|
||||||
width: '100%',
|
|
||||||
color: theme.colors.font,
|
|
||||||
backgroundColor: theme.colors.secondary,
|
|
||||||
padding: '0.75em',
|
|
||||||
border: `1px solid ${theme.colors.lightGrey}`,
|
|
||||||
borderBottom: `2px solid ${theme.colors.lightGrey}`,
|
|
||||||
borderRadius: theme.border.radius,
|
|
||||||
transition: theme.transition.delay,
|
|
||||||
|
|
||||||
'&:focus': {
|
|
||||||
borderBottom: `2px solid ${theme.colors.primary}`,
|
|
||||||
},
|
|
||||||
|
|
||||||
'&:disabled': {
|
|
||||||
opacity: 0.85,
|
|
||||||
},
|
|
||||||
|
|
||||||
'&::placeholder': {
|
|
||||||
fontStyle: 'italic',
|
|
||||||
color: theme.colors.grey,
|
|
||||||
},
|
|
||||||
}));
|
|
||||||
|
|
||||||
export default Input;
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
import { ChangeEvent, Fragment, InputHTMLAttributes, useState } from 'react';
|
|
||||||
import Toggle from 'react-toggle';
|
|
||||||
import FormField from '~/components/common/form/_form_field';
|
|
||||||
import FormFieldError from '~/components/common/form/_form_field_error';
|
|
||||||
|
|
||||||
interface InputProps
|
|
||||||
extends Omit<InputHTMLAttributes<HTMLInputElement>, 'onChange'> {
|
|
||||||
label: string;
|
|
||||||
name: string;
|
|
||||||
checked: boolean;
|
|
||||||
errors?: string[];
|
|
||||||
onChange?: (name: string, checked: boolean) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function Checkbox({
|
|
||||||
name,
|
|
||||||
label,
|
|
||||||
checked = false,
|
|
||||||
errors = [],
|
|
||||||
onChange,
|
|
||||||
required = false,
|
|
||||||
...props
|
|
||||||
}: InputProps): JSX.Element {
|
|
||||||
const [checkboxChecked, setCheckboxChecked] = useState<boolean>(checked);
|
|
||||||
|
|
||||||
if (typeof window === 'undefined') return <Fragment />;
|
|
||||||
|
|
||||||
function _onChange({ target }: ChangeEvent<HTMLInputElement>) {
|
|
||||||
setCheckboxChecked(target.checked);
|
|
||||||
if (onChange) {
|
|
||||||
onChange(target.name, target.checked);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<FormField
|
|
||||||
css={{ alignItems: 'center', gap: '1em', flexDirection: 'row' }}
|
|
||||||
required={required}
|
|
||||||
>
|
|
||||||
<label htmlFor={name} title={label}>
|
|
||||||
{label}
|
|
||||||
</label>
|
|
||||||
<Toggle
|
|
||||||
{...props}
|
|
||||||
onChange={_onChange}
|
|
||||||
checked={checkboxChecked}
|
|
||||||
placeholder={props.placeholder ?? 'Type something...'}
|
|
||||||
name={name}
|
|
||||||
id={name}
|
|
||||||
/>
|
|
||||||
{errors.length > 0 &&
|
|
||||||
errors.map((error) => <FormFieldError>{error}</FormFieldError>)}
|
|
||||||
</FormField>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
import { useTheme } from '@emotion/react';
|
|
||||||
import { InputHTMLAttributes, ReactNode, useEffect, useState } from 'react';
|
|
||||||
import Select, {
|
|
||||||
FormatOptionLabelMeta,
|
|
||||||
GroupBase,
|
|
||||||
OptionsOrGroups,
|
|
||||||
} from 'react-select';
|
|
||||||
import FormField from '~/components/common/form/_form_field';
|
|
||||||
|
|
||||||
type Option = { label: string | number; value: string | number };
|
|
||||||
|
|
||||||
interface SelectorProps
|
|
||||||
extends Omit<InputHTMLAttributes<HTMLInputElement>, 'onChange'> {
|
|
||||||
label: string;
|
|
||||||
name: string;
|
|
||||||
errors?: string[];
|
|
||||||
options: OptionsOrGroups<Option, GroupBase<Option>>;
|
|
||||||
value: number | string;
|
|
||||||
onChangeCallback?: (value: number | string) => void;
|
|
||||||
formatOptionLabel?: (
|
|
||||||
data: Option,
|
|
||||||
formatOptionLabelMeta: FormatOptionLabelMeta<Option>
|
|
||||||
) => ReactNode;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function Selector({
|
|
||||||
name,
|
|
||||||
label,
|
|
||||||
value,
|
|
||||||
errors = [],
|
|
||||||
options,
|
|
||||||
onChangeCallback,
|
|
||||||
formatOptionLabel,
|
|
||||||
required = false,
|
|
||||||
...props
|
|
||||||
}: SelectorProps): JSX.Element {
|
|
||||||
const theme = useTheme();
|
|
||||||
const [selectorValue, setSelectorValue] = useState<Option>();
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (options.length === 0) return;
|
|
||||||
|
|
||||||
const option = options.find((o: any) => o.value === value);
|
|
||||||
if (option) {
|
|
||||||
setSelectorValue(option as Option);
|
|
||||||
}
|
|
||||||
}, [options, value]);
|
|
||||||
|
|
||||||
const handleChange = (selectedOption: Option) => {
|
|
||||||
setSelectorValue(selectedOption);
|
|
||||||
if (onChangeCallback) {
|
|
||||||
onChangeCallback(selectedOption.value);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
return (
|
|
||||||
<FormField required={required}>
|
|
||||||
{label && (
|
|
||||||
<label htmlFor={name} title={`${name} field`}>
|
|
||||||
{label}
|
|
||||||
</label>
|
|
||||||
)}
|
|
||||||
<Select
|
|
||||||
value={selectorValue}
|
|
||||||
onChange={(newValue) => handleChange(newValue as Option)}
|
|
||||||
options={options}
|
|
||||||
isDisabled={props.disabled}
|
|
||||||
menuPlacement="auto"
|
|
||||||
formatOptionLabel={
|
|
||||||
formatOptionLabel
|
|
||||||
? (val, formatOptionLabelMeta) =>
|
|
||||||
formatOptionLabel(val, formatOptionLabelMeta)
|
|
||||||
: undefined
|
|
||||||
}
|
|
||||||
css={{ color: theme.colors.black }}
|
|
||||||
/>
|
|
||||||
</FormField>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
import { ChangeEvent, InputHTMLAttributes, useState } from 'react';
|
|
||||||
import FormField from '~/components/common/form/_form_field';
|
|
||||||
import FormFieldError from '~/components/common/form/_form_field_error';
|
|
||||||
import Input from '~/components/common/form/_input';
|
|
||||||
|
|
||||||
interface InputProps
|
|
||||||
extends Omit<InputHTMLAttributes<HTMLInputElement>, 'onChange'> {
|
|
||||||
label: string;
|
|
||||||
name: string;
|
|
||||||
value?: string;
|
|
||||||
errors?: string[];
|
|
||||||
onChange?: (name: string, value: string) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function TextBox({
|
|
||||||
name,
|
|
||||||
label,
|
|
||||||
value = '',
|
|
||||||
errors = [],
|
|
||||||
onChange,
|
|
||||||
required = false,
|
|
||||||
...props
|
|
||||||
}: InputProps): JSX.Element {
|
|
||||||
const [inputValue, setInputValue] = useState<string>(value);
|
|
||||||
|
|
||||||
function _onChange({ target }: ChangeEvent<HTMLInputElement>) {
|
|
||||||
setInputValue(target.value);
|
|
||||||
if (onChange) {
|
|
||||||
onChange(target.name, target.value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<FormField required={required}>
|
|
||||||
<label htmlFor={name} title={label}>
|
|
||||||
{label}
|
|
||||||
</label>
|
|
||||||
<Input
|
|
||||||
{...props}
|
|
||||||
name={name}
|
|
||||||
onChange={_onChange}
|
|
||||||
value={inputValue}
|
|
||||||
placeholder={props.placeholder ?? 'Type something...'}
|
|
||||||
/>
|
|
||||||
{errors.length > 0 &&
|
|
||||||
errors.map((error) => <FormFieldError>{error}</FormFieldError>)}
|
|
||||||
</FormField>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
21
inertia/components/common/language_switcher.tsx
Normal file
21
inertia/components/common/language_switcher.tsx
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import { ActionIcon, Image } from '@mantine/core';
|
||||||
|
import { useTranslation } from 'react-i18next';
|
||||||
|
import { LS_LANG_KEY } from '~/constants';
|
||||||
|
|
||||||
|
export function MantineLanguageSwitcher() {
|
||||||
|
const { i18n } = useTranslation();
|
||||||
|
const newLanguage = i18n.language === 'en' ? 'fr' : 'en';
|
||||||
|
return (
|
||||||
|
<ActionIcon
|
||||||
|
variant="light"
|
||||||
|
aria-label="Toggle color scheme"
|
||||||
|
onClick={() => {
|
||||||
|
i18n.changeLanguage(newLanguage);
|
||||||
|
localStorage.setItem(LS_LANG_KEY, newLanguage);
|
||||||
|
}}
|
||||||
|
size="lg"
|
||||||
|
>
|
||||||
|
<Image src={`/icons/${newLanguage}.svg`} alt={newLanguage} w={18} />
|
||||||
|
</ActionIcon>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const ModalBody = styled.div({
|
|
||||||
width: '100%',
|
|
||||||
display: 'flex',
|
|
||||||
flex: 1,
|
|
||||||
alignItems: 'center',
|
|
||||||
flexDirection: 'column',
|
|
||||||
});
|
|
||||||
|
|
||||||
export default ModalBody;
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
import TransitionLayout from '~/components/layouts/_transition_layout';
|
|
||||||
|
|
||||||
const ModalContainer = styled(TransitionLayout)(({ theme }) => ({
|
|
||||||
minWidth: '500px',
|
|
||||||
background: theme.colors.background,
|
|
||||||
padding: '1em',
|
|
||||||
borderRadius: theme.border.radius,
|
|
||||||
marginTop: '6em',
|
|
||||||
display: 'flex',
|
|
||||||
alignItems: 'center',
|
|
||||||
justifyContent: 'center',
|
|
||||||
flexDirection: 'column',
|
|
||||||
boxShadow: theme.colors.boxShadow,
|
|
||||||
|
|
||||||
[`@media (max-width: ${theme.media.mobile})`]: {
|
|
||||||
maxHeight: 'calc(100% - 2em)',
|
|
||||||
width: 'calc(100% - 2em)',
|
|
||||||
minWidth: 'unset',
|
|
||||||
marginTop: '1em',
|
|
||||||
},
|
|
||||||
}));
|
|
||||||
|
|
||||||
export default ModalContainer;
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
|
|
||||||
const ModalHeader = styled.h3({
|
|
||||||
width: '100%',
|
|
||||||
marginBottom: '0.75em',
|
|
||||||
display: 'flex',
|
|
||||||
alignItems: 'center',
|
|
||||||
justifyContent: 'space-between',
|
|
||||||
});
|
|
||||||
|
|
||||||
const ModalCloseBtn = styled.button(({ theme }) => ({
|
|
||||||
cursor: 'pointer',
|
|
||||||
color: theme.colors.primary,
|
|
||||||
backgroundColor: 'transparent',
|
|
||||||
border: 0,
|
|
||||||
padding: 0,
|
|
||||||
margin: 0,
|
|
||||||
}));
|
|
||||||
|
|
||||||
export { ModalHeader, ModalCloseBtn };
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
import styled from '@emotion/styled';
|
|
||||||
import { rgba } from '~/lib/color';
|
|
||||||
|
|
||||||
const ModalWrapper = styled.div(({ theme }) => ({
|
|
||||||
zIndex: 9999,
|
|
||||||
position: 'absolute',
|
|
||||||
top: 0,
|
|
||||||
left: 0,
|
|
||||||
height: '100%',
|
|
||||||
width: '100%',
|
|
||||||
background: rgba(theme.colors.black, 0.35),
|
|
||||||
backdropFilter: 'blur(0.1em)',
|
|
||||||
display: 'flex',
|
|
||||||
alignItems: 'center',
|
|
||||||
flexDirection: 'column',
|
|
||||||
transition: theme.transition.delay,
|
|
||||||
}));
|
|
||||||
|
|
||||||
export default ModalWrapper;
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user