Mirroring/my-links
1
0
Fork 0
mirror of https://github.com/Sonny93/my-links.git synced 2025-12-09 15:05:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: Mirroring:3.3.1
Branches Tags
Mirroring:main Mirroring:migration-tuyau Mirroring:remove_inactive_users
Mirroring:3.3.1 Mirroring:3.3.0 Mirroring:3.2.0 Mirroring:3.1.3 Mirroring:3.1.2 Mirroring:3.1.1 Mirroring:3.1.0 Mirroring:3.0.3 Mirroring:3.0.2 Mirroring:3.0.1 Mirroring:3.0.0 Mirroring:2.2.1 Mirroring:2.2.0 Mirroring:2.1.3 Mirroring:2.1.2 Mirroring:2.1.1 Mirroring:2.1.0 Mirroring:2.0.3 Mirroring:2.0.2 Mirroring:2.0.1 Mirroring:2.0.0 Mirroring:1.3.0 Mirroring:1.2.1 Mirroring:1.2.0 Mirroring:1.1.0 Mirroring:1.0.0
..
compare: Mirroring:remove_inactive_users
Branches Tags
Mirroring:main Mirroring:migration-tuyau Mirroring:remove_inactive_users
Mirroring:3.3.1 Mirroring:3.3.0 Mirroring:3.2.0 Mirroring:3.1.3 Mirroring:3.1.2 Mirroring:3.1.1 Mirroring:3.1.0 Mirroring:3.0.3 Mirroring:3.0.2 Mirroring:3.0.1 Mirroring:3.0.0 Mirroring:2.2.1 Mirroring:2.2.0 Mirroring:2.1.3 Mirroring:2.1.2 Mirroring:2.1.1 Mirroring:2.1.0 Mirroring:2.0.3 Mirroring:2.0.2 Mirroring:2.0.1 Mirroring:2.0.0 Mirroring:1.3.0 Mirroring:1.2.1 Mirroring:1.2.0 Mirroring:1.1.0 Mirroring:1.0.0

1 Commits
3.3.1 ... remove_ina

Author SHA1 Message Date
Sonny
05f067a430 feat: remove inactive users (scheduler) 2024-09-18 16:59:16 +02:00
438 changed files with 11960 additions and 15403 deletions
Expand all files Collapse all files

476
.adonisjs/api.ts
View File

@@ -1,476 +0,0 @@
// @ts-nocheck
/* eslint-disable */
// --------------------------------------------------
// This file is auto-generated by Tuyau. Do not edit manually !
// --------------------------------------------------
import type { MakeTuyauRequest, MakeTuyauResponse } from '@tuyau/utils/types';
import type { InferInput } from '@vinejs/vine/types';
type AdminGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/admin/controllers/admin_controller.ts').default['index'],
false
>;
};
type AuthCallbackGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/auth/controllers/auth_controller.ts').default['callbackAuth'],
false
>;
};
type AuthLogoutGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/auth/controllers/auth_controller.ts').default['logout'],
false
>;
};
type DashboardGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/collections/controllers/show_collections_controller.ts').default['render'],
false
>;
};
type CollectionsCreateGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/collections/controllers/create_collection_controller.ts').default['render'],
false
>;
};
type CollectionsPost = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/collections/validators/create_collection_validator.ts'))['createCollectionValidator']
>
>;
response: MakeTuyauResponse<
import('../app/collections/controllers/create_collection_controller.ts').default['execute'],
true
>;
};
type CollectionsEditGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/collections/controllers/update_collection_controller.ts').default['render'],
false
>;
};
type CollectionsIdPut = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/collections/validators/update_collection_validator.ts'))['updateCollectionValidator']
>
>;
response: MakeTuyauResponse<
import('../app/collections/controllers/update_collection_controller.ts').default['execute'],
true
>;
};
type CollectionsDeleteGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/collections/controllers/delete_collection_controller.ts').default['render'],
false
>;
};
type CollectionsIdDelete = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/collections/validators/delete_collection_validator.ts'))['deleteCollectionValidator']
>
>;
response: MakeTuyauResponse<
import('../app/collections/controllers/delete_collection_controller.ts').default['execute'],
true
>;
};
type FaviconGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/favicons/controllers/favicons_controller.ts').default['index'],
false
>;
};
type LinksCreateGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['showCreatePage'],
false
>;
};
type LinksPost = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/links/validators/create_link_validator.ts'))['createLinkValidator']
>
>;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['store'],
true
>;
};
type LinksEditGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['showEditPage'],
false
>;
};
type LinksIdPut = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/links/validators/update_link_validator.ts'))['updateLinkValidator']
>
>;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['update'],
true
>;
};
type LinksIdFavoritePut = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/links/validators/update_favorite_link_validator.ts'))['updateLinkFavoriteStatusValidator']
>
>;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['toggleFavorite'],
true
>;
};
type LinksDeleteGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['showDeletePage'],
false
>;
};
type LinksIdDelete = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/links/validators/delete_link_validator.ts'))['deleteLinkValidator']
>
>;
response: MakeTuyauResponse<
import('../app/links/controllers/delete_link_controller.js').default['execute'],
true
>;
};
type SearchGetHead = {
request: unknown;
response: MakeTuyauResponse<
import('../app/search/controllers/search_controller.ts').default['search'],
false
>;
};
type SharedIdGetHead = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/shared_collections/validators/shared_collection.ts'))['getSharedCollectionValidator']
>
>;
response: MakeTuyauResponse<
import('../app/shared_collections/controllers/shared_collections_controller.ts').default['index'],
true
>;
};
type UserThemePost = {
request: MakeTuyauRequest<
InferInput<
(typeof import('../app/user/validators/update_theme_validator.ts'))['updateThemeValidator']
>
>;
response: MakeTuyauResponse<
import('../app/user/controllers/theme_controller.ts').default['index'],
true
>;
};
export interface ApiDefinition {
admin: {
$url: {};
$get: AdminGetHead;
$head: AdminGetHead;
};
auth: {
callback: {
$url: {};
$get: AuthCallbackGetHead;
$head: AuthCallbackGetHead;
};
logout: {
$url: {};
$get: AuthLogoutGetHead;
$head: AuthLogoutGetHead;
};
};
dashboard: {
$url: {};
$get: DashboardGetHead;
$head: DashboardGetHead;
};
collections: {
create: {
$url: {};
$get: CollectionsCreateGetHead;
$head: CollectionsCreateGetHead;
};
$url: {};
$post: CollectionsPost;
edit: {
$url: {};
$get: CollectionsEditGetHead;
$head: CollectionsEditGetHead;
};
':id': {
$url: {};
$put: CollectionsIdPut;
$delete: CollectionsIdDelete;
};
delete: {
$url: {};
$get: CollectionsDeleteGetHead;
$head: CollectionsDeleteGetHead;
};
};
favicon: {
$url: {};
$get: FaviconGetHead;
$head: FaviconGetHead;
};
links: {
create: {
$url: {};
$get: LinksCreateGetHead;
$head: LinksCreateGetHead;
};
$url: {};
$post: LinksPost;
edit: {
$url: {};
$get: LinksEditGetHead;
$head: LinksEditGetHead;
};
':id': {
$url: {};
$put: LinksIdPut;
favorite: {
$url: {};
$put: LinksIdFavoritePut;
};
$delete: LinksIdDelete;
};
delete: {
$url: {};
$get: LinksDeleteGetHead;
$head: LinksDeleteGetHead;
};
};
search: {
$url: {};
$get: SearchGetHead;
$head: SearchGetHead;
};
shared: {
':id': {
$url: {};
$get: SharedIdGetHead;
$head: SharedIdGetHead;
};
};
user: {
theme: {
$url: {};
$post: UserThemePost;
};
};
}
const routes = [
{
params: [],
name: 'admin.dashboard',
path: '/admin',
method: ['GET', 'HEAD'],
types: {} as AdminGetHead,
},
{
params: [],
name: 'auth',
path: '/auth/google',
method: ['GET', 'HEAD'],
types: {} as unknown,
},
{
params: [],
name: 'auth.callback',
path: '/auth/callback',
method: ['GET', 'HEAD'],
types: {} as AuthCallbackGetHead,
},
{
params: [],
name: 'auth.logout',
path: '/auth/logout',
method: ['GET', 'HEAD'],
types: {} as AuthLogoutGetHead,
},
{
params: [],
name: 'dashboard',
path: '/dashboard',
method: ['GET', 'HEAD'],
types: {} as DashboardGetHead,
},
{
params: [],
name: 'collection.create-form',
path: '/collections/create',
method: ['GET', 'HEAD'],
types: {} as CollectionsCreateGetHead,
},
{
params: [],
name: 'collection.create',
path: '/collections',
method: ['POST'],
types: {} as CollectionsPost,
},
{
params: [],
name: 'collection.edit-form',
path: '/collections/edit',
method: ['GET', 'HEAD'],
types: {} as CollectionsEditGetHead,
},
{
params: ['id'],
name: 'collection.edit',
path: '/collections/:id',
method: ['PUT'],
types: {} as CollectionsIdPut,
},
{
params: [],
name: 'collection.delete-form',
path: '/collections/delete',
method: ['GET', 'HEAD'],
types: {} as CollectionsDeleteGetHead,
},
{
params: ['id'],
name: 'collection.delete',
path: '/collections/:id',
method: ['DELETE'],
types: {} as CollectionsIdDelete,
},
{
params: [],
name: 'favicon',
path: '/favicon',
method: ['GET', 'HEAD'],
types: {} as FaviconGetHead,
},
{
params: [],
name: 'home',
path: '/',
method: ['GET', 'HEAD'],
types: {} as unknown,
},
{
params: [],
name: 'terms',
path: '/terms',
method: ['GET', 'HEAD'],
types: {} as unknown,
},
{
params: [],
name: 'privacy',
path: '/privacy',
method: ['GET', 'HEAD'],
types: {} as unknown,
},
{
params: [],
name: 'link.create-form',
path: '/links/create',
method: ['GET', 'HEAD'],
types: {} as LinksCreateGetHead,
},
{
params: [],
name: 'link.create',
path: '/links',
method: ['POST'],
types: {} as LinksPost,
},
{
params: [],
name: 'link.edit-form',
path: '/links/edit',
method: ['GET', 'HEAD'],
types: {} as LinksEditGetHead,
},
{
params: ['id'],
name: 'link.edit',
path: '/links/:id',
method: ['PUT'],
types: {} as LinksIdPut,
},
{
params: ['id'],
name: 'link.toggle-favorite',
path: '/links/:id/favorite',
method: ['PUT'],
types: {} as LinksIdFavoritePut,
},
{
params: [],
name: 'link.delete-form',
path: '/links/delete',
method: ['GET', 'HEAD'],
types: {} as LinksDeleteGetHead,
},
{
params: ['id'],
name: 'link.delete',
path: '/links/:id',
method: ['DELETE'],
types: {} as LinksIdDelete,
},
{
params: [],
name: 'search',
path: '/search',
method: ['GET', 'HEAD'],
types: {} as SearchGetHead,
},
{
params: ['id'],
name: 'shared',
path: '/shared/:id',
method: ['GET', 'HEAD'],
types: {} as SharedIdGetHead,
},
{
params: [],
name: 'user.theme',
path: '/user/theme',
method: ['POST'],
types: {} as UserThemePost,
},
] as const;
export const api = {
routes,
definition: {} as ApiDefinition,
};
declare module '@tuyau/inertia/types' {
type InertiaApi = typeof api;
export interface Api extends InertiaApi {}
}

3
.adonisjs/index.ts
View File

@@ -1,3 +0,0 @@
/// <reference path="../adonisrc.ts" />
export * from './api.js';

3
.babelrc Normal file
View File

@@ -0,0 +1,3 @@
{
"plugins": ["@emotion"]
}

2
.dockerignore
View File

@@ -13,7 +13,7 @@ storage
# Additional good to have ignores for dockerignore # Additional good to have ignores for dockerignore
Dockerfile* Dockerfile*
compose* docker-compose*
.dockerignore .dockerignore
*.md *.md
.git .git

12
.editorconfig
View File

@@ -3,12 +3,22 @@
root = true root = true
[*] [*]
indent_style = tab indent_style = space
indent_size = 2 indent_size = 2
end_of_line = lf end_of_line = lf
charset = utf-8 charset = utf-8
trim_trailing_whitespace = true trim_trailing_whitespace = true
insert_final_newline = true insert_final_newline = true
[*.json]
insert_final_newline = unset
[**.min.js] [**.min.js]
indent_style = unset indent_style = unset
insert_final_newline = unset
[MakeFile]
indent_style = space
[*.md]
trim_trailing_whitespace = false

20
.env.example
View File

@@ -1,22 +1,16 @@
# App # node ace generate:key
APP_KEY=soY8ZAtItT_fCkNUADfgffZUUo675lOj
TZ=UTC TZ=UTC
PORT=3333 PORT=3333
HOST=localhost HOST=localhost
LOG_LEVEL=debug LOG_LEVEL=info
APP_KEY=soY8ZAtItT_fCkNUADfgffZUUo675lOj # node ace generate:key
NODE_ENV=development NODE_ENV=development
SESSION_DRIVER=cookie SESSION_DRIVER=cookie
# App url
APP_URL=http://localhost:3333
# Database
DB_HOST=127.0.0.1 DB_HOST=127.0.0.1
DB_PORT=5432 DB_PORT=5432
DB_USER=root DB_USER=postgres
DB_PASSWORD=root DB_PASSWORD=my-links-pwd
DB_DATABASE=app DB_DATABASE=my-links
# Google
GOOGLE_CLIENT_ID= GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET= GOOGLE_CLIENT_SECRET=
GOOGLE_CLIENT_CALLBACK_URL=http://localhost:3333/auth/callback

7
.release-it.json
View File

@@ -1,6 +1,9 @@
{ {
"hooks": { "hooks": {
"before:init": ["pnpm lint", "pnpm run typecheck"] "before:init": [
"pnpm format",
"pnpm lint"
]
}, },
"git": { "git": {
"commitMessage": "chore: release v${version}", "commitMessage": "chore: release v${version}",
@@ -14,4 +17,4 @@
"npm": { "npm": {
"publish": false "publish": false
} }
} }

31
.vscode/settings.json vendored
View File

@@ -1,20 +1,13 @@
{ {
"typescript.preferences.importModuleSpecifier": "non-relative", "typescript.preferences.importModuleSpecifier": "non-relative",
/* Prefer tabs over spaces for accessibility */ /* Prefer tabs over spaces for accessibility */
"editor.insertSpaces": false, "editor.insertSpaces": true,
"editor.detectIndentation": false, "editor.detectIndentation": false,
/* Explorer */ /* Explorer */
"explorer.fileNesting.enabled": true, "explorer.fileNesting.enabled": true,
"explorer.fileNesting.patterns": { "explorer.fileNesting.patterns": {
"*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts", "*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
"package.json": "pnpm-lock.yaml, pnpm-workspace.yaml, tsconfig.json, eslint.config.js, .babelrc, vite.config.ts, .editorconfig", "package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml, rollup.config.mjs, tsconfig.json, eslint.config.js",
"Makefile": "*compose.yml, Dockerfile, servers_pgadmin.json, .dockerignore" "Makefile": "*compose.yml, Dockerfile, .dockerignore, *startup.sh"
}, }
"cssVariables.lookupFiles": [ }
"**/*.css",
"**/*.scss",
"**/*.sass",
"**/*.less",
"node_modules/@mantine/core/styles.css"
]
}

61
CONTRIBUTING
View File

@@ -1,61 +0,0 @@
## 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!

9
Dockerfile
View File

@@ -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:24.11-alpine3.22 AS base FROM node:20-alpine3.18 AS base
RUN apk --no-cache add curl RUN apk --no-cache add curl
RUN corepack enable RUN corepack enable
@@ -15,7 +15,7 @@ RUN pnpm install --ignore-scripts
FROM base AS production-deps FROM base AS production-deps
WORKDIR /app WORKDIR /app
ADD package.json pnpm-lock.yaml ./ ADD package.json pnpm-lock.yaml ./
RUN pnpm install --ignore-scripts --prod RUN pnpm install --ignore-scripts
# Build stage # Build stage
FROM base AS build FROM base AS build
@@ -34,9 +34,9 @@ ENV DB_PORT=5432
ENV DB_USER=db_user ENV DB_USER=db_user
ENV DB_PASSWORD=db_password ENV DB_PASSWORD=db_password
ENV DB_DATABASE=db_db ENV DB_DATABASE=db_db
ENV APP_URL=http://localhost:3333
ENV GOOGLE_CLIENT_ID=client_id ENV GOOGLE_CLIENT_ID=client_id
ENV GOOGLE_CLIENT_SECRET=client_secret ENV GOOGLE_CLIENT_SECRET=client_secret
ENV GOOGLE_CLIENT_CALLBACK_URL=http://localhost:3333/auth/callback
RUN node ace izzy:routes RUN node ace izzy:routes
RUN node ace build RUN node ace build
@@ -53,9 +53,10 @@ ENV PORT=$PORT
WORKDIR /app WORKDIR /app
COPY --from=production-deps /app/node_modules /app/node_modules COPY --from=production-deps /app/node_modules /app/node_modules
COPY --from=build /app/build /app COPY --from=build /app/build /app
COPY --from=build /app/startup.sh /app/startup.sh
# Expose port # Expose port
EXPOSE $PORT EXPOSE $PORT
# Start app # Start app
CMD node bin/console.js migration:run --force && node bin/server.js CMD node bin/console.js migration:run --force && sh startup.sh

674
LICENSE
View File

@@ -1,674 +0,0 @@
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>.

23
Makefile
View File

@@ -1,32 +1,19 @@
tuyau:
@node ace tuyau:generate
@pnpm run format
dev: dev:
@docker compose down @docker compose down
@docker compose -f dev.compose.yml pull @docker compose -f dev.docker-compose.yml up -d --wait
@docker compose -f dev.compose.yml up -d --wait --remove-orphans
@node ace migration:fresh @node ace migration:fresh
@pnpm run dev @./dev.startup.sh
prod: prod:
@docker compose -f dev.compose.yml down @docker compose -f dev.docker-compose.yml down
@docker compose pull @docker compose up -d --build --wait
@docker compose up -d --build --wait --remove-orphans
seed: seed:
@node ace db:seed @node ace db:seed
fresh:
@node ace migration:fresh
down: down:
@-docker compose down @-docker compose down
@-docker compose -f dev.compose.yml down @-docker compose -f dev.docker-compose.yml down
release: release:
@pnpm run release @pnpm run release
docker-weight:
@DOCKER_IMAGE_WEIGHT=$$(docker save axekin-axekin:latest | wc -c | awk '{printf "%.3f", $$1/1024/1024}'); \
echo "Docker image weight: $${DOCKER_IMAGE_WEIGHT} Mo"

98
README.md
View File

@@ -1,59 +1,25 @@
![](./docs//imgs/ml_dashboard_dark.png) # MyLinks
<div align="center"> MyLinks is a tool that lets you manage your favorite links in an intuitive interface.
<h1>MyLinks</h1> Free and open source software, focused on privacy and self-hosting.
<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>
## Table of Contents # Setup
- [Main Features](#main-features) Copy `example.env` file as `.env` and edit the properties.
- [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)
## 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
``` ```
#### PNPM ### PNPM
```shell ```shell
# reset database and (force) apply all migrations # reset database and (force) apply all migrations
@@ -62,15 +28,15 @@ node ace migration:fresh
pnpm run dev pnpm run dev
``` ```
### Start as prod ## Start as prod
#### Docker ### Docker
```shell ```shell
make prod make prod
``` ```
#### PNPM ### PNPM
```shell ```shell
# create production build # create production build
@@ -83,37 +49,14 @@ cp ../.env .
pnpm run start pnpm run start
``` ```
## Configuration ## Generate app_key
### Generate app_key
```shell ```shell
# generate a random app key # generate a random app key
openssl rand -base64 32 openssl rand -base64 32
``` ```
### Google OAuth ## GitHub Actions
Pour obtenir le Client ID et Secret Google nécessaires à l'authentification :
1. Accédez à la [Console Google Cloud](https://console.cloud.google.com/)
2. Créez un nouveau projet ou sélectionnez un projet existant
3. Activez l'API **Google+ API** (ou utilisez directement l'API OAuth 2.0)
4. Allez dans **Identifiants** (Credentials) > **Créer des identifiants** > **ID client OAuth 2.0**
5. Configurez l'écran de consentement OAuth si ce n'est pas déjà fait :
- Type d'application : **Interne** ou **Externe**
- Remplissez les informations requises (nom de l'application, email de support, etc.)
6. Créez l'ID client OAuth 2.0 :
- Type d'application : **Application Web**
- Nom : choisissez un nom pour votre application
- URI de redirection autorisés : ajoutez `http://localhost:3333/auth/callback` pour le développement (ou votre URL de production + `/auth/callback`)
7. Une fois créé, vous obtiendrez :
- **Client ID** : à définir dans `GOOGLE_CLIENT_ID`
- **Client Secret** : à définir dans `GOOGLE_CLIENT_SECRET`
> **Note** : Pour la production, assurez-vous d'ajouter votre URL de production dans les URI de redirection autorisés (ex: `https://votre-domaine.com/auth/callback`)
### GitHub Actions
Env var to define : Env var to define :
@@ -144,16 +87,3 @@ 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).

220
adonisrc.ts
View File

@@ -1,116 +1,122 @@
import { defineConfig } from '@adonisjs/core/app'; import { defineConfig } from '@adonisjs/core/app';
export default defineConfig({ export default defineConfig({
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Commands | Commands
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| |
| List of ace commands to register from packages. The application commands | List of ace commands to register from packages. The application commands
| 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'),
() => import('@tuyau/core/commands'), () => import('adonisjs-scheduler/commands'),
], ],
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Service providers | Service providers
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| |
| List of service providers to import and register when booting the | List of service providers to import and register when booting the
| 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'),
() => import('@tuyau/core/tuyau_provider'), {
], file: () => import('adonisjs-scheduler/scheduler_provider'),
environment: ['console'],
},
],
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Preloads | Preloads
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| |
| List of modules to import before starting the application. | List of modules to import before starting the application.
| |
*/ */
preloads: [ preloads: [
() => import('#start/routes'), () => import('#start/routes'),
() => import('#start/kernel'), () => import('#start/kernel'),
() => import('#start/view'), {
], file: () => import('#start/scheduler'),
environment: ['console'],
},
],
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Tests | Tests
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| |
| List of test suites to organize tests by their type. Feel free to remove | List of test suites to organize tests by their type. Feel free to remove
| 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
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| |
| A collection of files you want to copy to the build folder when creating | A collection of files you want to copy to the build folder when creating
| 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,
hooks: { 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')],
}, },
}); });

46
app/admin/controllers/admin_controller.ts
View File

@@ -1,46 +0,0 @@
import AuthController from '#auth/controllers/auth_controller';
import { CollectionService } from '#collections/services/collection_service';
import LinksController from '#links/controllers/delete_link_controller';
import User from '#user/models/user';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
class UserWithRelationCountDto {
constructor(private user: User) {}
toJson = () => ({
id: this.user.id,
email: this.user.email,
fullname: this.user.name,
avatarUrl: this.user.avatarUrl,
isAdmin: this.user.isAdmin,
createdAt: this.user.createdAt.toString(),
updatedAt: this.user.updatedAt.toString(),
lastSeenAt:
this.user.lastSeenAt?.toString() ?? this.user.updatedAt.toString(),
linksCount: Number(this.user.$extras.totalLinks),
collectionsCount: Number(this.user.$extras.totalCollections),
});
}
@inject()
export default class AdminController {
constructor(
protected usersController: AuthController,
protected linksController: LinksController,
protected collectionService: CollectionService
) {}
async index({ inertia }: HttpContext) {
const users = await this.usersController.getAllUsersWithTotalRelations();
const linksCount = await this.linksController.getTotalLinksCount();
const collectionsCount =
await this.collectionService.getTotalCollectionsCount();
return inertia.render('admin/dashboard', {
users: users.map((user) => new UserWithRelationCountDto(user).toJson()),
totalLinks: linksCount,
totalCollections: collectionsCount,
});
}
}

11
app/admin/middlewares/is_admin_middleware.ts
View File

@@ -1,11 +0,0 @@
import type { HttpContext } from '@adonisjs/core/http';
import type { NextFn } from '@adonisjs/core/types/http';
export default class AdminMiddleware {
async handle(ctx: HttpContext, next: NextFn) {
if (!ctx.auth.user?.isAdmin) {
return ctx.response.redirectToNamedRoute('dashboard');
}
return next();
}
}

14
app/admin/routes/admin_routes.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const AdminController = () => import('#admin/controllers/admin_controller');
/**
* Routes for admin dashboard
*/
router
.group(() => {
router.get('/', [AdminController, 'index']).as('admin.dashboard');
})
.middleware([middleware.auth(), middleware.admin()])
.prefix('/admin');

1
app/admin/routes/routes.ts
View File

@@ -1 +0,0 @@
import './admin_routes.js';

20
app/api/collections/controllers/create_collection_controller.ts
View File

@@ -1,20 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { createCollectionValidator } from '#collections/validators/create_collection_validator';
import { inject } from '@adonisjs/core';
import { type HttpContext } from '@adonisjs/core/http';
@inject()
export default class CreateCollectionController {
constructor(private collectionService: CollectionService) {}
async execute({ request, response }: HttpContext) {
console.log('avant');
const payload = await request.validateUsing(createCollectionValidator);
const collection = await this.collectionService.createCollection(payload);
console.log('après', collection);
return response.json({
message: 'Collection created successfully',
collection: collection.serialize(),
});
}
}

17
app/api/collections/controllers/delete_collection_controller.ts
View File

@@ -1,17 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { deleteCollectionValidator } from '#collections/validators/delete_collection_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class DeleteCollectionController {
constructor(private collectionService: CollectionService) {}
async execute({ request, response }: HttpContext) {
const { params } = await request.validateUsing(deleteCollectionValidator);
await this.collectionService.deleteCollection(params.id);
return response.json({
message: 'Collection deleted successfully',
});
}
}

16
app/api/collections/controllers/get_collections_controller.ts
View File

@@ -1,16 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class GetCollectionsController {
constructor(private collectionService: CollectionService) {}
async show({ response }: HttpContext) {
const collections =
await this.collectionService.getCollectionsForAuthenticatedUser();
return response.json({
collections: collections.map((collection) => collection.serialize()),
});
}
}

21
app/api/collections/controllers/update_collection_controller.ts
View File

@@ -1,21 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { updateCollectionValidator } from '#collections/validators/update_collection_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class UpdateCollectionController {
constructor(private collectionService: CollectionService) {}
async execute({ request, response }: HttpContext) {
const {
params: { id: collectionId },
...payload
} = await request.validateUsing(updateCollectionValidator);
await this.collectionService.updateCollection(collectionId, payload);
return response.json({
message: 'Collection updated successfully',
});
}
}

14
app/api/collections/routes/api_create_collections_routes.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const CreateCollectionsController = () =>
import('#api/collections/controllers/create_collection_controller');
router
.group(() => {
router
.post('', [CreateCollectionsController, 'execute'])
.as('api-collections.create');
})
.prefix('/api/v1/collections')
.middleware([middleware.auth({ guards: ['api'] })]);

14
app/api/collections/routes/api_delete_collections_routes.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const DeleteCollectionsController = () =>
import('#api/collections/controllers/delete_collection_controller');
router
.group(() => {
router
.delete('/:id', [DeleteCollectionsController, 'execute'])
.as('api-collections.delete');
})
.prefix('/api/v1/collections')
.middleware([middleware.auth({ guards: ['api'] })]);

14
app/api/collections/routes/api_get_collections_routes.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const GetCollectionsController = () =>
import('#api/collections/controllers/get_collections_controller');
router
.group(() => {
router
.get('', [GetCollectionsController, 'show'])
.as('api-collections.index');
})
.prefix('/api/v1/collections')
.middleware([middleware.auth({ guards: ['api'] })]);

14
app/api/collections/routes/api_update_collections_routes.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const UpdateCollectionsController = () =>
import('#api/collections/controllers/update_collection_controller');
router
.group(() => {
router
.put('/:id', [UpdateCollectionsController, 'execute'])
.as('api-collections.update');
})
.prefix('/api/v1/collections')
.middleware([middleware.auth({ guards: ['api'] })]);

4
app/api/collections/routes/routes.ts
View File

@@ -1,4 +0,0 @@
import '#api/collections/routes/api_create_collections_routes';
import '#api/collections/routes/api_delete_collections_routes';
import '#api/collections/routes/api_get_collections_routes';
import '#api/collections/routes/api_update_collections_routes';

23
app/api/links/controllers/create_link_controller.ts
View File

@@ -1,23 +0,0 @@
import { LinkService } from '#links/services/link_service';
import { createLinkValidator } from '#links/validators/create_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class CreateLinkController {
constructor(private linkService: LinkService) {}
async execute({ request, response }: HttpContext) {
const { collectionId, ...payload } =
await request.validateUsing(createLinkValidator);
const link = await this.linkService.createLink({
...payload,
collectionId,
});
return response.json({
message: 'Link created successfully',
link: link.serialize(),
});
}
}

39
app/api/links/controllers/delete_link_controller.ts
View File

@@ -1,39 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { LinkService } from '#links/services/link_service';
import { deleteLinkValidator } from '#links/validators/delete_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
import db from '@adonisjs/lucid/services/db';
@inject()
export default class DeleteLinkController {
constructor(
protected collectionsService: CollectionService,
protected linkService: LinkService
) {}
async render({ auth, inertia, request }: HttpContext) {
const linkId = request.qs()?.linkId;
if (!linkId) {
return this.collectionsService.redirectToDashboard();
}
const link = await this.linkService.getLinkById(linkId, auth.user!.id);
await link.load('collection');
return inertia.render('links/delete', { link });
}
async execute({ request, auth }: HttpContext) {
const { params } = await request.validateUsing(deleteLinkValidator);
const link = await this.linkService.getLinkById(params.id, auth.user!.id);
await this.linkService.deleteLink(params.id);
return this.collectionsService.redirectToCollectionId(link.collectionId);
}
async getTotalLinksCount() {
const totalCount = await db.from('links').count('* as total');
return Number(totalCount[0].total);
}
}

13
app/api/links/controllers/get_favorite_links_controller.ts
View File

@@ -1,13 +0,0 @@
import { LinkService } from '#links/services/link_service';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class GetFavoriteLinksController {
constructor(private linkService: LinkService) {}
public async execute({ response }: HttpContext) {
const links = await this.linkService.getFavoriteLinksForAuthenticatedUser();
return response.json(links);
}
}

19
app/api/links/controllers/update_link_controller.ts
View File

@@ -1,19 +0,0 @@
import { LinkService } from '#links/services/link_service';
import { updateLinkValidator } from '#links/validators/update_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class UpdateLinkController {
constructor(private linkService: LinkService) {}
async execute({ request, response }: HttpContext) {
const { params, ...payload } =
await request.validateUsing(updateLinkValidator);
await this.linkService.updateLink(params.id, payload);
return response.json({
message: 'Link updated successfully',
});
}
}

12
app/api/links/routes/api_create_link_routes.ts
View File

@@ -1,12 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const CreateLinkController = () =>
import('#api/links/controllers/create_link_controller');
router
.group(() => {
router.post('', [CreateLinkController, 'execute']).as('api-links.create');
})
.prefix('/api/v1/links')
.middleware([middleware.auth({ guards: ['api'] })]);

14
app/api/links/routes/api_delete_link_route.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const DeleteLinkController = () =>
import('#api/links/controllers/delete_link_controller');
router
.group(() => {
router
.delete('/:id', [DeleteLinkController, 'execute'])
.as('api-links.delete');
})
.prefix('/api/v1/links')
.middleware([middleware.auth({ guards: ['api'] })]);

14
app/api/links/routes/api_get_favorite_links_routes.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const GetFavoriteLinksController = () =>
import('#api/links/controllers/get_favorite_links_controller');
router
.group(() => {
router
.get('', [GetFavoriteLinksController, 'execute'])
.as('api-links.get-favorite-links');
})
.prefix('/api/v1/links/favorites')
.middleware([middleware.auth({ guards: ['api'] })]);

14
app/api/links/routes/api_update_link_route.ts
View File

@@ -1,14 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const UpdateLinkController = () =>
import('#api/links/controllers/update_link_controller');
router
.group(() => {
router
.put('/:id', [UpdateLinkController, 'execute'])
.as('api-links.update');
})
.prefix('/api/v1/links')
.middleware([middleware.auth({ guards: ['api'] })]);

4
app/api/links/routes/routes.ts
View File

@@ -1,4 +0,0 @@
import '#api/links/routes/api_create_link_routes';
import '#api/links/routes/api_delete_link_route';
import '#api/links/routes/api_get_favorite_links_routes';
import '#api/links/routes/api_update_link_route';

18
app/api/tokens/controllers/api_token_controller.ts
View File

@@ -1,18 +0,0 @@
import UnAuthorizedException from '#api/tokens/exceptions/un_authorized_exception';
import { getTokenFromHeader } from '#api/tokens/lib/index';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class ApiTokenController {
async index(ctx: HttpContext) {
const token = getTokenFromHeader(ctx);
if (!token) {
throw new UnAuthorizedException();
}
return ctx.response.json({
message: 'Token is valid',
});
}
}

7
app/api/tokens/exceptions/un_authorized_exception.ts
View File

@@ -1,7 +0,0 @@
import { Exception } from '@adonisjs/core/exceptions';
export default class UnAuthorizedException extends Exception {
static status = 401;
message = 'Missing or invalid authorization header';
code = 'UNAUTHORIZED';
}

11
app/api/tokens/lib/index.ts
View File

@@ -1,11 +0,0 @@
import { HttpContext } from '@adonisjs/core/http';
export function getTokenFromHeader(ctx: HttpContext) {
const authHeader = ctx.request.header('Authorization');
if (!authHeader || !authHeader.startsWith('Bearer ')) {
return null;
}
return authHeader.substring(7);
}

12
app/api/tokens/routes/api_token_routes.ts
View File

@@ -1,12 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const ApiTokenController = () =>
import('#api/tokens/controllers/api_token_controller');
router
.group(() => {
router.get('/check', [ApiTokenController, 'index']).as('api-tokens.index');
})
.prefix('/api/v1/tokens')
.middleware([middleware.auth({ guards: ['api'] })]);

1
app/api/tokens/routes/routes.ts
View File

@@ -1 +0,0 @@
import '#api/tokens/routes/api_token_routes';

78
app/auth/controllers/auth_controller.ts
View File

@@ -1,78 +0,0 @@
import User from '#user/models/user';
import type { HttpContext } from '@adonisjs/core/http';
import logger from '@adonisjs/core/services/logger';
import db from '@adonisjs/lucid/services/db';
import { RouteName } from '@izzyjs/route/types';
export default class AuthController {
private redirectTo: RouteName = 'auth';
login({ inertia }: HttpContext) {
return inertia.render('login');
}
google = ({ ally }: HttpContext) => ally.use('google').redirect();
async callbackAuth({ ally, auth, response, session }: HttpContext) {
const google = ally.use('google');
if (google.accessDenied()) {
// TODO: translate error messages + show them in UI
session.flash('flash', 'Access was denied');
return response.redirectToNamedRoute(this.redirectTo);
}
if (google.stateMisMatch()) {
session.flash('flash', 'Request expired. Retry again');
return response.redirectToNamedRoute(this.redirectTo);
}
if (google.hasError()) {
session.flash('flash', google.getError() || 'Something went wrong');
return response.redirectToNamedRoute(this.redirectTo);
}
const userCount = await db.from('users').count('* as total');
const {
email,
id: providerId,
name,
nickName,
avatarUrl,
token,
} = await google.user();
const user = await User.updateOrCreate(
{
email,
},
{
email,
providerId,
name,
nickName,
avatarUrl,
token,
providerType: 'google',
isAdmin: userCount[0].total === '0' ? true : undefined,
}
);
await auth.use('web').login(user);
session.flash('flash', 'Successfully authenticated');
logger.info(`[${user.email}] auth success`);
response.redirectToNamedRoute('dashboard');
}
async logout({ auth, response, session }: HttpContext) {
await auth.use('web').logout();
session.flash('flash', 'Successfully disconnected');
logger.info(`[${auth.user?.email}] disconnected successfully`);
response.redirect('/');
}
async getAllUsersWithTotalRelations() {
return User.query()
.withCount('collections', (q) => q.as('totalCollections'))
.withCount('links', (q) => q.as('totalLinks'));
}
}

9
app/auth/middlewares/silent_auth_middleware.ts
View File

@@ -1,9 +0,0 @@
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();
}
}

27
app/auth/routes/auth_routes.ts
View File

@@ -1,27 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const AuthController = () => import('#auth/controllers/auth_controller');
const ROUTES_PREFIX = '/auth';
/**
* Auth routes for unauthicated users
*/
router
.group(() => {
router.get('/google', [AuthController, 'google']).as('auth');
router
.get('/callback', [AuthController, 'callbackAuth'])
.as('auth.callback');
})
.prefix(ROUTES_PREFIX);
/**
* Routes for authenticated users
*/
router
.group(() => {
router.get('/logout', [AuthController, 'logout']).as('auth.logout');
})
.middleware([middleware.auth()])
.prefix(ROUTES_PREFIX);

1
app/auth/routes/routes.ts
View File

@@ -1 +0,0 @@
import './auth_routes.js';

23
app/collections/controllers/create_collection_controller.ts
View File

@@ -1,23 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { createCollectionValidator } from '#collections/validators/create_collection_validator';
import { inject } from '@adonisjs/core';
import { type HttpContext } from '@adonisjs/core/http';
@inject()
export default class CreateCollectionController {
constructor(private collectionService: CollectionService) {}
async render({ inertia }: HttpContext) {
const collections =
await this.collectionService.getCollectionsForAuthenticatedUser();
return inertia.render('collections/create', {
disableHomeLink: collections.length === 0,
});
}
async execute({ request }: HttpContext) {
const payload = await request.validateUsing(createCollectionValidator);
const collection = await this.collectionService.createCollection(payload);
return this.collectionService.redirectToCollectionId(collection.id);
}
}

26
app/collections/controllers/delete_collection_controller.ts
View File

@@ -1,26 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { deleteCollectionValidator } from '#collections/validators/delete_collection_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class DeleteCollectionController {
constructor(private collectionService: CollectionService) {}
async render({ inertia }: HttpContext) {
const collectionId = await this.collectionService.validateCollectionId();
if (!collectionId) return;
const collection =
await this.collectionService.getCollectionById(collectionId);
return inertia.render('collections/delete', {
collection,
});
}
async execute({ request, response }: HttpContext) {
const { params } = await request.validateUsing(deleteCollectionValidator);
await this.collectionService.deleteCollection(params.id);
return response.redirectToNamedRoute('dashboard');
}
}

36
app/collections/controllers/show_collections_controller.ts
View File

@@ -1,36 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { LinkService } from '#links/services/link_service';
import { inject } from '@adonisjs/core';
import type { HttpContext } from '@adonisjs/core/http';
@inject()
export default class ShowCollectionsController {
constructor(
private collectionService: CollectionService,
private linkService: LinkService
) {}
// Dashboard
async render({ inertia, response }: HttpContext) {
const activeCollectionId =
await this.collectionService.validateCollectionId(false);
const [collections, favoriteLinks] = await Promise.all([
this.collectionService.getCollectionsForAuthenticatedUser(),
this.linkService.getFavoriteLinksForAuthenticatedUser(),
]);
const activeCollection = collections.find(
(c) => c.id === activeCollectionId
);
if (!activeCollection && !!activeCollectionId) {
return response.redirectToNamedRoute('dashboard');
}
return inertia.render('dashboard', {
collections: collections.map((collection) => collection.serialize()),
favoriteLinks: favoriteLinks.map((link) => link.serialize()),
activeCollection: activeCollection?.serialize(),
});
}
}

30
app/collections/controllers/update_collection_controller.ts
View File

@@ -1,30 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { updateCollectionValidator } from '#collections/validators/update_collection_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class UpdateCollectionController {
constructor(private collectionService: CollectionService) {}
async render({ inertia }: HttpContext) {
const collectionId = await this.collectionService.validateCollectionId();
if (!collectionId) return;
const collection =
await this.collectionService.getCollectionById(collectionId);
return inertia.render('collections/edit', {
collection: collection.serialize(),
});
}
async execute({ request }: HttpContext) {
const {
params: { id: collectionId },
...payload
} = await request.validateUsing(updateCollectionValidator);
await this.collectionService.updateCollection(collectionId, payload);
return this.collectionService.redirectToCollectionId(collectionId);
}
}

4
app/collections/enums/visibility.ts
View File

@@ -1,4 +0,0 @@
export enum Visibility {
PUBLIC = 'PUBLIC',
PRIVATE = 'PRIVATE',
}

26
app/collections/models/collection.ts
View File

@@ -1,26 +0,0 @@
import { Visibility } from '#collections/enums/visibility';
import AppBaseModel from '#core/models/app_base_model';
import Link from '#links/models/link';
import User from '#user/models/user';
import { belongsTo, column, hasMany } from '@adonisjs/lucid/orm';
import type { BelongsTo, HasMany } from '@adonisjs/lucid/types/relations';
export default class Collection extends AppBaseModel {
@column()
declare name: string;
@column()
declare description: string | null;
@column()
declare visibility: Visibility;
@column()
declare authorId: number;
@belongsTo(() => User, { foreignKey: 'authorId' })
declare author: BelongsTo<typeof User>;
@hasMany(() => Link)
declare links: HasMany<typeof Link>;
}

47
app/collections/routes/collections_routes.ts
View File

@@ -1,47 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const ShowCollectionsController = () =>
import('#collections/controllers/show_collections_controller');
const CreateCollectionController = () =>
import('#collections/controllers/create_collection_controller');
const UpdateCollectionController = () =>
import('#collections/controllers/update_collection_controller');
const DeleteCollectionController = () =>
import('#collections/controllers/delete_collection_controller');
router
.group(() => {
router
.get('/dashboard', [ShowCollectionsController, 'render'])
.as('dashboard');
router
.group(() => {
// Create
router
.get('/create', [CreateCollectionController, 'render'])
.as('collection.create-form');
router
.post('/', [CreateCollectionController, 'execute'])
.as('collection.create');
// Update
router
.get('/edit', [UpdateCollectionController, 'render'])
.as('collection.edit-form');
router
.put('/:id', [UpdateCollectionController, 'execute'])
.as('collection.edit');
// Delete
router
.get('/delete', [DeleteCollectionController, 'render'])
.as('collection.delete-form');
router
.delete('/:id', [DeleteCollectionController, 'execute'])
.as('collection.delete');
})
.prefix('/collections');
})
.middleware([middleware.auth()]);

1
app/collections/routes/routes.ts
View File

@@ -1 +0,0 @@
import './collections_routes.js';

104
app/collections/services/collection_service.ts
View File

@@ -1,104 +0,0 @@
import { Visibility } from '#collections/enums/visibility';
import Collection from '#collections/models/collection';
import { collectionIdValidator } from '#collections/validators/collection_id_validator';
import { HttpContext } from '@adonisjs/core/http';
import db from '@adonisjs/lucid/services/db';
type CreateCollectionPayload = {
name: string;
description: string | null;
visibility: Visibility;
};
type UpdateCollectionPayload = CreateCollectionPayload;
export class CollectionService {
async getCollectionById(id: Collection['id']) {
const context = this.getAuthContext();
return await Collection.query()
.where('id', id)
.andWhere('author_id', context.auth.user!.id)
.firstOrFail();
}
async getCollectionsForAuthenticatedUser() {
const context = this.getAuthContext();
return await Collection.query()
.where('author_id', context.auth.user!.id)
.orderBy('created_at')
.preload('links', (q) => q.orderBy('favorite', 'desc'));
}
async getTotalCollectionsCount() {
const totalCount = await db.from('collections').count('* as total');
return Number(totalCount[0].total);
}
createCollection(payload: CreateCollectionPayload) {
const context = this.getAuthContext();
return Collection.create({
...payload,
authorId: context.auth.user!.id,
});
}
async updateCollection(
id: Collection['id'],
payload: UpdateCollectionPayload
) {
const context = this.getAuthContext();
return await Collection.query()
.where('id', id)
.andWhere('author_id', context.auth.user!.id)
.update(payload);
}
deleteCollection(id: Collection['id']) {
const context = this.getAuthContext();
return Collection.query()
.where('id', id)
.andWhere('author_id', context.auth.user!.id)
.delete();
}
getPublicCollectionById(id: Collection['id']) {
return Collection.query()
.where('id', id)
.andWhere('visibility', Visibility.PUBLIC)
.preload('links')
.preload('author')
.firstOrFail();
}
private getAuthContext() {
const context = HttpContext.getOrFail();
if (!context.auth.user || !context.auth.user.id) {
throw new Error('User not authenticated');
}
return context;
}
async validateCollectionId(collectionIdRequired: boolean = true) {
const ctx = HttpContext.getOrFail();
const { collectionId } = await ctx.request.validateUsing(
collectionIdValidator
);
if (!collectionId && collectionIdRequired) {
this.redirectToDashboard();
return null;
}
return collectionId;
}
redirectToCollectionId(collectionId: Collection['id']) {
const ctx = HttpContext.getOrFail();
return ctx.response.redirectToNamedRoute('dashboard', {
qs: { collectionId },
});
}
redirectToDashboard() {
const ctx = HttpContext.getOrFail();
return ctx.response.redirectToNamedRoute('dashboard');
}
}

7
app/collections/validators/collection_id_validator.ts
View File

@@ -1,7 +0,0 @@
import vine from '@vinejs/vine';
export const collectionIdValidator = vine.compile(
vine.object({
collectionId: vine.number().positive().optional(),
})
);

15
app/collections/validators/create_collection_validator.ts
View File

@@ -1,15 +0,0 @@
import { Visibility } from '#collections/enums/visibility';
import vine, { SimpleMessagesProvider } from '@vinejs/vine';
export const createCollectionValidator = vine.compile(
vine.object({
name: vine.string().trim().minLength(1).maxLength(254),
description: vine.string().trim().maxLength(254).nullable(),
visibility: vine.enum(Visibility),
})
);
createCollectionValidator.messagesProvider = new SimpleMessagesProvider({
name: 'Collection name is required',
'visibility.required': 'Collection visibiliy is required',
});

8
app/collections/validators/delete_collection_validator.ts
View File

@@ -1,8 +0,0 @@
import { params } from '#core/validators/params_object';
import vine from '@vinejs/vine';
export const deleteCollectionValidator = vine.compile(
vine.object({
params,
})
);

13
app/collections/validators/update_collection_validator.ts
View File

@@ -1,13 +0,0 @@
import { Visibility } from '#collections/enums/visibility';
import { params } from '#core/validators/params_object';
import vine from '@vinejs/vine';
export const updateCollectionValidator = vine.compile(
vine.object({
name: vine.string().trim().minLength(1).maxLength(254),
description: vine.string().trim().maxLength(254).nullable(),
visibility: vine.enum(Visibility),
params,
})
);

12
app/core/constants/keys.ts → app/constants/keys.ts
View File

@@ -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;

8
app/constants/paths.ts Normal file
View File

@@ -0,0 +1,8 @@
const PATHS = {
AUTHOR: 'https://www.sonny.dev/',
REPO_GITHUB: 'https://github.com/Sonny93/my-links',
EXTENSION:
'https://chromewebstore.google.com/detail/mylinks/agkmlplihacolkakgeccnbhphnepphma',
} as const;
export default PATHS;

2
app/constants/session.ts Normal file
View File

@@ -0,0 +1,2 @@
export const PREFER_DARK_THEME = 'prefer_dark_theme';
export const DARK_THEME_DEFAULT_VALUE = true;

46
app/controllers/admin_controller.ts Normal file
View File

@@ -0,0 +1,46 @@
import CollectionsController from '#controllers/collections_controller';
import LinksController from '#controllers/links_controller';
import UsersController from '#controllers/users_controller';
import User from '#models/user';
import { inject } from '@adonisjs/core';
import type { HttpContext } from '@adonisjs/core/http';
class UserWithRelationCountDto {
constructor(private user: User) {}
toJson = () => ({
id: this.user.id,
email: this.user.email,
fullname: this.user.name,
avatarUrl: this.user.avatarUrl,
isAdmin: this.user.isAdmin,
createdAt: this.user.createdAt,
updatedAt: this.user.updatedAt,
count: {
link: Number(this.user.$extras.totalLinks),
collection: Number(this.user.$extras.totalCollections),
},
});
}
@inject()
export default class AdminController {
constructor(
protected usersController: UsersController,
protected linksController: LinksController,
protected collectionsController: CollectionsController
) {}
async index({ inertia }: HttpContext) {
const users = await this.usersController.getAllUsersWithTotalRelations();
const linksCount = await this.linksController.getTotalLinksCount();
const collectionsCount =
await this.collectionsController.getTotalCollectionsCount();
return inertia.render('admin/dashboard', {
users: users.map((user) => new UserWithRelationCountDto(user).toJson()),
totalLinks: linksCount,
totalCollections: collectionsCount,
});
}
}

13
app/controllers/apps_controller.ts Normal file
View File

@@ -0,0 +1,13 @@
import { PREFER_DARK_THEME } from '#constants/session';
import { updateUserThemeValidator } from '#validators/user';
import type { HttpContext } from '@adonisjs/core/http';
export default class AppsController {
async updateUserTheme({ request, session, response }: HttpContext) {
const { preferDarkTheme } = await request.validateUsing(
updateUserThemeValidator
);
session.put(PREFER_DARK_THEME, preferDarkTheme);
return response.ok({ message: 'ok' });
}
}

143
app/controllers/collections_controller.ts Normal file
View File

@@ -0,0 +1,143 @@
import Collection from '#models/collection';
import User from '#models/user';
import {
createCollectionValidator,
deleteCollectionValidator,
updateCollectionValidator,
} from '#validators/collection';
import type { HttpContext } from '@adonisjs/core/http';
import db from '@adonisjs/lucid/services/db';
export default class CollectionsController {
// Dashboard
async index({ auth, inertia, request, response }: HttpContext) {
const collections = await this.getCollectionsByAuthorId(auth.user!.id);
if (collections.length === 0) {
return response.redirectToNamedRoute('collection.create-form');
}
const activeCollectionId = Number(request.qs()?.collectionId ?? '');
const activeCollection = collections.find(
(c) => c.id === activeCollectionId
);
if (!activeCollection && !!activeCollectionId) {
return response.redirectToNamedRoute('dashboard');
}
// TODO: Create DTOs
return inertia.render('dashboard', {
collections: collections.map((collection) => collection.serialize()),
activeCollection:
activeCollection?.serialize() || collections[0].serialize(),
});
}
// Create collection form
async showCreatePage({ inertia, auth }: HttpContext) {
const collections = await this.getCollectionsByAuthorId(auth.user!.id);
return inertia.render('collections/create', {
disableHomeLink: collections.length === 0,
});
}
// Method called when creating a collection
async store({ request, response, auth }: HttpContext) {
const payload = await request.validateUsing(createCollectionValidator);
const collection = await Collection.create({
...payload,
authorId: auth.user?.id!,
});
return this.redirectToCollectionId(response, collection.id);
}
async showEditPage({ auth, request, inertia, response }: HttpContext) {
const collectionId = request.qs()?.collectionId;
if (!collectionId) {
return response.redirectToNamedRoute('dashboard');
}
const collection = await this.getCollectionById(
collectionId,
auth.user!.id
);
return inertia.render('collections/edit', {
collection,
});
}
async update({ request, auth, response }: HttpContext) {
const { params, ...payload } = await request.validateUsing(
updateCollectionValidator
);
// Cant use validator (vinejs) custom rule 'cause its too generic,
// because we have to find a collection by identifier and
// check whether the current user is the author.
// https://vinejs.dev/docs/extend/custom_rules
await this.getCollectionById(params.id, auth.user!.id);
await Collection.updateOrCreate(
{
id: params.id,
},
payload
);
return this.redirectToCollectionId(response, params.id);
}
async showDeletePage({ auth, request, inertia, response }: HttpContext) {
const collectionId = request.qs()?.collectionId;
if (!collectionId) {
return response.redirectToNamedRoute('dashboard');
}
const collection = await this.getCollectionById(
collectionId,
auth.user!.id
);
return inertia.render('collections/delete', {
collection,
});
}
async delete({ request, auth, response }: HttpContext) {
const { params } = await request.validateUsing(deleteCollectionValidator);
const collection = await this.getCollectionById(params.id, auth.user!.id);
await collection.delete();
return response.redirectToNamedRoute('dashboard');
}
async getTotalCollectionsCount() {
const totalCount = await db.from('collections').count('* as total');
return Number(totalCount[0].total);
}
/**
* Get collection by id.
*
* /!\ Only return private collection (create by the current user)
*/
async getCollectionById(id: Collection['id'], userId: User['id']) {
return await Collection.query()
.where('id', id)
.andWhere('author_id', userId)
.firstOrFail();
}
async getCollectionsByAuthorId(authorId: User['id']) {
return await Collection.query()
.where('author_id', authorId)
.orderBy('created_at')
.preload('links');
}
redirectToCollectionId(
response: HttpContext['response'],
collectionId: Collection['id']
) {
return response.redirectToNamedRoute('dashboard', {
qs: { collectionId },
});
}
}

160
app/controllers/favicons_controller.ts Normal file
View File

@@ -0,0 +1,160 @@
import FaviconNotFoundException from '#exceptions/favicon_not_found_exception';
import { cache } from '#lib/cache';
import type { HttpContext } from '@adonisjs/core/http';
import logger from '@adonisjs/core/services/logger';
import { parse } from 'node-html-parser';
interface Favicon {
buffer: Buffer;
url: string;
type: string;
size: number;
}
export default class FaviconsController {
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';
private relList = [
'icon',
'shortcut icon',
'apple-touch-icon',
'apple-touch-icon-precomposed',
'apple-touch-startup-image',
'mask-icon',
'fluid-icon',
];
async index(ctx: HttpContext) {
const url = ctx.request.qs()?.url;
if (!url) {
throw new Error('Missing URL');
}
const cacheNs = cache.namespace('favicon');
const favicon = await cacheNs.getOrSet({
key: url,
ttl: '1h',
factory: () => this.tryGetFavicon(url),
});
return this.sendImage(ctx, favicon);
}
private async tryGetFavicon(url: string): Promise<Favicon> {
const faviconUrl = this.buildFaviconUrl(url, '/favicon.ico');
try {
return await this.fetchFavicon(faviconUrl);
} catch {
logger.debug(`Unable to retrieve favicon from ${faviconUrl}`);
}
const documentText = await this.fetchDocumentText(url);
const faviconPath = this.extractFaviconPath(documentText);
if (!faviconPath) {
throw new FaviconNotFoundException(`No favicon path found in ${url}`);
}
if (faviconPath.startsWith('http')) {
try {
return await this.fetchFavicon(faviconPath);
} catch {
logger.debug(`Unable to retrieve favicon from ${faviconPath}`);
}
}
return this.fetchFaviconFromPath(url, faviconPath);
}
private async fetchFavicon(url: string): Promise<Favicon> {
const response = await this.fetchWithUserAgent(url);
if (!response.ok) {
throw new FaviconNotFoundException(`Request to favicon ${url} failed`);
}
const blob = await response.blob();
if (!this.isImage(blob.type) || blob.size === 0) {
throw new FaviconNotFoundException(`Invalid image at ${url}`);
}
return {
buffer: Buffer.from(await blob.arrayBuffer()),
url: response.url,
type: blob.type,
size: blob.size,
};
}
private async fetchDocumentText(url: string): Promise<string> {
const response = await this.fetchWithUserAgent(url);
if (!response.ok) {
throw new FaviconNotFoundException(`Request to ${url} failed`);
}
return await response.text();
}
private extractFaviconPath(html: string): string | undefined {
const document = parse(html);
const link = document
.getElementsByTagName('link')
.find((element) => this.relList.includes(element.getAttribute('rel')!));
return link?.getAttribute('href');
}
private async fetchFaviconFromPath(
baseUrl: string,
path: string
): Promise<Favicon> {
if (this.isBase64Image(path)) {
const buffer = this.convertBase64ToBuffer(path);
return {
buffer,
type: 'image/x-icon',
size: buffer.length,
url: path,
};
}
const faviconUrl = this.buildFaviconUrl(baseUrl, path);
return this.fetchFavicon(faviconUrl);
}
private buildFaviconUrl(base: string, path: string): string {
const { origin } = new URL(base);
if (path.startsWith('/')) {
return origin + path;
}
const basePath = this.urlWithoutSearchParams(base);
const baseUrl = basePath.endsWith('/') ? basePath.slice(0, -1) : basePath;
return `${baseUrl}/${path}`;
}
private urlWithoutSearchParams(url: string): string {
const { protocol, host, pathname } = new URL(url);
return `${protocol}//${host}${pathname}`;
}
private isImage(type: string): boolean {
return type.startsWith('image/');
}
private isBase64Image(data: string): boolean {
return data.startsWith('data:image/');
}
private convertBase64ToBuffer(base64: string): Buffer {
return Buffer.from(base64.split(',')[1], 'base64');
}
private async fetchWithUserAgent(url: string): Promise<Response> {
const headers = new Headers({ 'User-Agent': this.userAgent });
return fetch(url, { headers });
}
private sendImage(ctx: HttpContext, { buffer, type, size }: Favicon) {
ctx.response.header('Content-Type', type);
ctx.response.header('Content-Length', size.toString());
ctx.response.send(buffer, true);
}
}

131
app/controllers/links_controller.ts Normal file
View File

@@ -0,0 +1,131 @@
import CollectionsController from '#controllers/collections_controller';
import Link from '#models/link';
import {
createLinkValidator,
deleteLinkValidator,
updateLinkFavoriteStatusValidator,
updateLinkValidator,
} from '#validators/link';
import { inject } from '@adonisjs/core';
import type { HttpContext } from '@adonisjs/core/http';
import db from '@adonisjs/lucid/services/db';
@inject()
export default class LinksController {
constructor(protected collectionsController: CollectionsController) {}
async showCreatePage({ auth, inertia }: HttpContext) {
const collections =
await this.collectionsController.getCollectionsByAuthorId(auth.user!.id);
return inertia.render('links/create', { collections });
}
async store({ auth, request, response }: HttpContext) {
const { collectionId, ...payload } =
await request.validateUsing(createLinkValidator);
await this.collectionsController.getCollectionById(
collectionId,
auth.user!.id
);
await Link.create({
...payload,
collectionId,
authorId: auth.user?.id!,
});
return this.collectionsController.redirectToCollectionId(
response,
collectionId
);
}
async showEditPage({ auth, inertia, request, response }: HttpContext) {
const linkId = request.qs()?.linkId;
if (!linkId) {
return response.redirectToNamedRoute('dashboard');
}
const userId = auth.user!.id;
const collections =
await this.collectionsController.getCollectionsByAuthorId(userId);
const link = await this.getLinkById(linkId, userId);
return inertia.render('links/edit', { collections, link });
}
async update({ request, auth, response }: HttpContext) {
const { params, ...payload } =
await request.validateUsing(updateLinkValidator);
// Throw if invalid link id provided
await this.getLinkById(params.id, auth.user!.id);
await Link.updateOrCreate(
{
id: params.id,
},
payload
);
return response.redirectToNamedRoute('dashboard', {
qs: { collectionId: payload.collectionId },
});
}
async toggleFavorite({ request, auth, response }: HttpContext) {
const { params, favorite } = await request.validateUsing(
updateLinkFavoriteStatusValidator
);
// Throw if invalid link id provided
await this.getLinkById(params.id, auth.user!.id);
await Link.updateOrCreate(
{
id: params.id,
},
{ favorite }
);
return response.json({ status: 'ok' });
}
async showDeletePage({ auth, inertia, request, response }: HttpContext) {
const linkId = request.qs()?.linkId;
if (!linkId) {
return response.redirectToNamedRoute('dashboard');
}
const link = await this.getLinkById(linkId, auth.user!.id);
await link.load('collection');
return inertia.render('links/delete', { link });
}
async delete({ request, auth, response }: HttpContext) {
const { params } = await request.validateUsing(deleteLinkValidator);
const link = await this.getLinkById(params.id, auth.user!.id);
await link.delete();
return response.redirectToNamedRoute('dashboard', {
qs: { collectionId: link.id },
});
}
async getTotalLinksCount() {
const totalCount = await db.from('links').count('* as total');
return Number(totalCount[0].total);
}
/**
* Get link by id.
*
* /!\ Only return private link (create by the current user)
*/
private async getLinkById(id: Link['id'], userId: Link['id']) {
return await Link.query()
.where('id', id)
.andWhere('author_id', userId)
.firstOrFail();
}
}

18
app/controllers/searches_controller.ts Normal file
View File

@@ -0,0 +1,18 @@
import type { HttpContext } from '@adonisjs/core/http';
import db from '@adonisjs/lucid/services/db';
export default class SearchesController {
async search({ request, auth }: HttpContext) {
const term = request.qs()?.term;
if (!term) {
console.warn('qs term null');
return { error: 'missing "term" query param' };
}
const { rows } = await db.rawQuery('SELECT * FROM search_text(?, ?)', [
term,
auth.user!.id,
]);
return { results: rows };
}
}

24
app/controllers/shared_collections_controller.ts Normal file
View File

@@ -0,0 +1,24 @@
import { Visibility } from '#enums/visibility';
import Collection from '#models/collection';
import { getSharedCollectionValidator } from '#validators/shared_collection';
import type { HttpContext } from '@adonisjs/core/http';
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']) {
return await Collection.query()
.where('id', id)
.andWhere('visibility', Visibility.PUBLIC)
.preload('links')
.preload('author')
.firstOrFail();
}
}

94
app/controllers/users_controller.ts Normal file
View File

@@ -0,0 +1,94 @@
import User from '#models/user';
import type { HttpContext } from '@adonisjs/core/http';
import logger from '@adonisjs/core/services/logger';
import db from '@adonisjs/lucid/services/db';
import { RouteName } from '@izzyjs/route/types';
const INACTIVE_USER_THRESHOLD = 7;
export default class UsersController {
private redirectTo: RouteName = 'auth.login';
login({ inertia }: HttpContext) {
return inertia.render('login');
}
google = ({ ally }: HttpContext) => ally.use('google').redirect();
async callbackAuth({ ally, auth, response, session }: HttpContext) {
const google = ally.use('google');
if (google.accessDenied()) {
// TODO: translate error messages + show them in UI
session.flash('flash', 'Access was denied');
return response.redirectToNamedRoute(this.redirectTo);
}
if (google.stateMisMatch()) {
session.flash('flash', 'Request expired. Retry again');
return response.redirectToNamedRoute(this.redirectTo);
}
if (google.hasError()) {
session.flash('flash', google.getError() || 'Something went wrong');
return response.redirectToNamedRoute(this.redirectTo);
}
const userCount = await db.from('users').count('* as total');
const {
email,
id: providerId,
name,
nickName,
avatarUrl,
token,
} = await google.user();
const user = await User.updateOrCreate(
{
email,
},
{
email,
providerId,
name,
nickName,
avatarUrl,
token,
providerType: 'google',
isAdmin: userCount[0].total === '0' ? true : undefined,
}
);
await auth.use('web').login(user);
session.flash('flash', 'Successfully authenticated');
logger.info(`[${user.email}] auth success`);
response.redirectToNamedRoute('dashboard');
}
async logout({ auth, response, session }: HttpContext) {
await auth.use('web').logout();
session.flash('flash', 'Successfully disconnected');
logger.info(`[${auth.user?.email}] disconnected successfully`);
response.redirectToNamedRoute(this.redirectTo);
}
async getAllUsersWithTotalRelations() {
return User.query()
.withCount('collections', (q) => q.as('totalCollections'))
.withCount('links', (q) => q.as('totalLinks'));
}
async getAllInactiveUsers() {
const users = await this.getAllUsersWithTotalRelations();
const inactiveUsers = users.filter((user) => {
const totalLinks = Number(user.$extras.totalLinks);
const totalCollections = Number(user.$extras.totalCollections);
const isOlderThan7Days =
Math.abs(user.updatedAt.diffNow('days').days) > INACTIVE_USER_THRESHOLD;
return (totalLinks === 0 || totalCollections === 0) && isOlderThan7Days;
});
return inactiveUsers ?? [];
}
}

8
app/core/constants/paths.ts
View File

@@ -1,8 +0,0 @@
const PATHS = {
AUTHOR: 'https://www.sonny.dev/?utm_source=mylinks',
REPO_GITHUB: 'https://github.com/my-links/my-links',
EXTENSION:
'https://chromewebstore.google.com/detail/mylinks/agkmlplihacolkakgeccnbhphnepphma',
} as const;
export default PATHS;

61
app/core/exceptions/handler.ts
View File

@@ -1,61 +0,0 @@
import { ExceptionHandler, HttpContext } from '@adonisjs/core/http';
import app from '@adonisjs/core/services/app';
import type {
StatusPageRange,
StatusPageRenderer,
} from '@adonisjs/core/types/http';
import { errors } from '@adonisjs/lucid';
export default class HttpExceptionHandler extends ExceptionHandler {
/**
* In debug mode, the exception handler will display verbose errors
* with pretty printed stack traces.
*/
protected debug = !app.inProduction;
/**
* 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
* free to enable them in development as well.
*/
protected renderStatusPages = app.inProduction;
/**
* Status pages is a collection of error code range and a callback
* to return the HTML contents to send as a response.
*/
protected statusPages: Record<StatusPageRange, StatusPageRenderer> = {
'404': (error, { inertia }) =>
inertia.render('errors/not_found', { error }),
'500..599': (error, { inertia }) =>
inertia.render('errors/server_error', { error }),
};
/**
* The method is used for handling errors and returning
* response to the client
*/
async handle(error: unknown, ctx: HttpContext) {
if (ctx.request.url()?.startsWith('/api/v1')) {
return ctx.response.status(400).json({
message: 'Bad Request',
errors: [error],
});
}
if (error instanceof errors.E_ROW_NOT_FOUND) {
return ctx.response.redirectToNamedRoute('dashboard');
}
return super.handle(error, ctx);
}
/**
* The method is used to report error to the logging service or
* the a third party error monitoring service.
*
* @note You should not attempt to send a response from this method.
*/
async report(error: unknown, ctx: HttpContext) {
return super.report(error, ctx);
}
}

17
app/core/middlewares/log_request.ts
View File

@@ -1,17 +0,0 @@
import { HttpContext } from '@adonisjs/core/http';
import logger from '@adonisjs/core/services/logger';
export default class LogRequest {
async handle({ request }: HttpContext, next: () => Promise<void>) {
if (
!request.url().startsWith('/node_modules') &&
!request.url().startsWith('/inertia') &&
!request.url().startsWith('/@vite') &&
!request.url().startsWith('/@react-refresh') &&
!request.url().includes('.ts')
) {
logger.debug(`[${request.method()}]: ${request.url()}`);
}
await next();
}
}

18
app/core/middlewares/service_worker_scope_extender.ts
View File

@@ -1,18 +0,0 @@
import { HttpContext } from '@adonisjs/core/http';
const HEADER_NAME = 'Service-Worker-Allowed';
export default class ServiceWorkerScopeExtender {
async handle(
{ request, response, logger }: HttpContext,
next: () => Promise<void>
) {
if (request.url().startsWith('/assets/sw.js')) {
response.header(HEADER_NAME, '/');
logger.debug(
`Header ${HEADER_NAME} for ${request.url()} set to ${response.getHeader(HEADER_NAME)}`
);
}
await next();
}
}

25
app/core/models/app_base_model.ts
View File

@@ -1,25 +0,0 @@
import {
BaseModel,
CamelCaseNamingStrategy,
column,
} from '@adonisjs/lucid/orm';
import { DateTime } from 'luxon';
export default class AppBaseModel extends BaseModel {
static namingStrategy = new CamelCaseNamingStrategy();
serializeExtras = true;
@column({ isPrimary: true })
declare id: number;
@column.dateTime({
autoCreate: true,
})
declare createdAt: DateTime;
@column.dateTime({
autoCreate: true,
autoUpdate: true,
})
declare updatedAt: DateTime;
}

5
app/core/validators/params_object.ts
View File

@@ -1,5 +0,0 @@
import vine from '@vinejs/vine';
export const params = vine.object({
id: vine.number(),
});

4
app/enums/visibility.ts Normal file
View File

@@ -0,0 +1,4 @@
export enum Visibility {
PUBLIC = 'PUBLIC',
PRIVATE = 'PRIVATE',
}

20
app/exceptions/favicon_not_found_exception.ts Normal file
View File

@@ -0,0 +1,20 @@
import { Exception } from '@adonisjs/core/exceptions';
import { HttpContext } from '@adonisjs/core/http';
import logger from '@adonisjs/core/services/logger';
import { createReadStream } from 'node:fs';
import { resolve } from 'node:path';
export default class FaviconNotFoundException extends Exception {
static status = 404;
static code = 'E_FAVICON_NOT_FOUND';
async handle(error: this, ctx: HttpContext) {
const readStream = createReadStream(
resolve(process.cwd(), './public/empty-image.png')
);
ctx.response.header('Content-Type', 'image/png');
ctx.response.stream(readStream);
logger.debug(error.message);
}
}

54
app/exceptions/handler.ts Normal file
View File

@@ -0,0 +1,54 @@
import { ExceptionHandler, HttpContext } from '@adonisjs/core/http';
import app from '@adonisjs/core/services/app';
import type {
StatusPageRange,
StatusPageRenderer,
} from '@adonisjs/core/types/http';
import { errors } from '@adonisjs/lucid';
export default class HttpExceptionHandler extends ExceptionHandler {
/**
* In debug mode, the exception handler will display verbose errors
* with pretty printed stack traces.
*/
protected debug = !app.inProduction;
/**
* 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
* free to enable them in development as well.
*/
protected renderStatusPages = app.inProduction;
/**
* Status pages is a collection of error code range and a callback
* to return the HTML contents to send as a response.
*/
protected statusPages: Record<StatusPageRange, StatusPageRenderer> = {
'404': (error, { inertia }) =>
inertia.render('errors/not_found', { error }),
'500..599': (error, { inertia }) =>
inertia.render('errors/server_error', { error }),
};
/**
* The method is used for handling errors and returning
* response to the client
*/
async handle(error: unknown, ctx: HttpContext) {
if (error instanceof errors.E_ROW_NOT_FOUND) {
return ctx.response.redirectToNamedRoute('dashboard');
}
return super.handle(error, ctx);
}
/**
* The method is used to report error to the logging service or
* the a third party error monitoring service.
*
* @note You should not attempt to send a response from this method.
*/
async report(error: unknown, ctx: HttpContext) {
return super.report(error, ctx);
}
}

34
app/favicons/controllers/favicons_controller.ts
View File

@@ -1,34 +0,0 @@
import { CacheService } from '#favicons/services/cache_service';
import { FaviconService } from '#favicons/services/favicons_service';
import { Favicon } from '#favicons/types/favicon_type';
import { inject } from '@adonisjs/core';
import type { HttpContext } from '@adonisjs/core/http';
@inject()
export default class FaviconsController {
private faviconService: FaviconService;
private cacheService: CacheService;
constructor(faviconService: FaviconService, cacheService: CacheService) {
this.faviconService = faviconService;
this.cacheService = cacheService;
}
async index(ctx: HttpContext) {
const url = ctx.request.qs()?.url;
if (!url) {
throw new Error('Missing URL');
}
const favicon = await this.cacheService.getOrSetFavicon(url, () =>
this.faviconService.getFavicon(url)
);
return this.sendImage(ctx, favicon);
}
private sendImage(ctx: HttpContext, { buffer, type, size }: Favicon) {
ctx.response.header('Content-Type', type);
ctx.response.header('Content-Length', size.toString());
ctx.response.send(buffer, true);
}
}

20
app/favicons/exceptions/favicon_not_found_exception.ts
View File

@@ -1,20 +0,0 @@
import { Exception } from '@adonisjs/core/exceptions';
import { HttpContext } from '@adonisjs/core/http';
import logger from '@adonisjs/core/services/logger';
import { createReadStream } from 'node:fs';
import { resolve } from 'node:path';
export default class FaviconNotFoundException extends Exception {
static status = 404;
static code = 'E_FAVICON_NOT_FOUND';
async handle(error: this, ctx: HttpContext) {
const readStream = createReadStream(
resolve(process.cwd(), './public/empty-image.png')
);
ctx.response.header('Content-Type', 'image/png');
ctx.response.stream(readStream);
logger.debug(error.message);
}
}

10
app/favicons/routes/favicons_routes.ts
View File

@@ -1,10 +0,0 @@
import router from '@adonisjs/core/services/router';
const FaviconsController = () =>
import('#favicons/controllers/favicons_controller');
/**
* Favicon routes
*/
router.group(() => {
router.get('/favicon', [FaviconsController, 'index']).as('favicon');
});

1
app/favicons/routes/routes.ts
View File

@@ -1 +0,0 @@
import './favicons_routes.js';

17
app/favicons/services/cache_service.ts
View File

@@ -1,17 +0,0 @@
import { cache } from '#core/lib/cache';
import { Favicon } from '#favicons/types/favicon_type';
export class CacheService {
private cacheNs = cache.namespace('favicon');
async getOrSetFavicon(
url: string,
factory: () => Promise<Favicon>
): Promise<Favicon> {
return this.cacheNs.getOrSet({
key: url,
ttl: '1h',
factory,
});
}
}

124
app/favicons/services/favicons_service.ts
View File

@@ -1,124 +0,0 @@
import FaviconNotFoundException from '#favicons/exceptions/favicon_not_found_exception';
import { Favicon } from '#favicons/types/favicon_type';
import logger from '@adonisjs/core/services/logger';
import { parse } from 'node-html-parser';
export class FaviconService {
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';
private relList = [
'icon',
'shortcut icon',
'apple-touch-icon',
'apple-touch-icon-precomposed',
'apple-touch-startup-image',
'mask-icon',
'fluid-icon',
];
async getFavicon(url: string): Promise<Favicon> {
try {
return await this.fetchFavicon(this.buildFaviconUrl(url, '/favicon.ico'));
} catch {
logger.debug(`Unable to retrieve favicon from ${url}/favicon.ico`);
}
const documentText = await this.fetchDocumentText(url);
const faviconPath = this.extractFaviconPath(documentText);
if (!faviconPath) {
throw new FaviconNotFoundException(`No favicon path found in ${url}`);
}
return await this.fetchFaviconFromPath(url, faviconPath);
}
private async fetchFavicon(url: string): Promise<Favicon> {
const response = await this.fetchWithUserAgent(url);
if (!response.ok) {
throw new FaviconNotFoundException(`Request to favicon ${url} failed`);
}
const blob = await response.blob();
if (!this.isImage(blob.type) || blob.size === 0) {
throw new FaviconNotFoundException(`Invalid image at ${url}`);
}
return {
buffer: Buffer.from(await blob.arrayBuffer()),
url: response.url,
type: blob.type,
size: blob.size,
};
}
private async fetchDocumentText(url: string): Promise<string> {
const response = await this.fetchWithUserAgent(url);
if (!response.ok) {
throw new FaviconNotFoundException(`Request to ${url} failed`);
}
return await response.text();
}
private extractFaviconPath(html: string): string | undefined {
const document = parse(html);
const link = document
.getElementsByTagName('link')
.find((element) => this.relList.includes(element.getAttribute('rel')!));
return link?.getAttribute('href');
}
private async fetchFaviconFromPath(
baseUrl: string,
path: string
): Promise<Favicon> {
if (this.isBase64Image(path)) {
const buffer = this.convertBase64ToBuffer(path);
return {
buffer,
type: 'image/x-icon',
size: buffer.length,
url: path,
};
}
const faviconUrl = this.buildFaviconUrl(baseUrl, path);
return this.fetchFavicon(faviconUrl);
}
private buildFaviconUrl(base: string, path: string): string {
const { origin } = new URL(base);
if (path.startsWith('/')) {
return origin + path;
}
const basePath = this.urlWithoutSearchParams(base);
const baseUrl = basePath.endsWith('/') ? basePath.slice(0, -1) : basePath;
const finalUrl = `${baseUrl}/${path}`;
logger.debug(`Built favicon URL: ${finalUrl}`);
return finalUrl;
}
private urlWithoutSearchParams(url: string): string {
const { protocol, host, pathname } = new URL(url);
return `${protocol}//${host}${pathname}`;
}
private isImage(type: string): boolean {
return type.startsWith('image/');
}
private isBase64Image(data: string): boolean {
return data.startsWith('data:image/');
}
private convertBase64ToBuffer(base64: string): Buffer {
return Buffer.from(base64.split(',')[1], 'base64');
}
private async fetchWithUserAgent(url: string): Promise<Response> {
const headers = new Headers({ 'User-Agent': this.userAgent });
return fetch(url, { headers });
}
}

6
app/favicons/types/favicon_type.ts
View File

@@ -1,6 +0,0 @@
export type Favicon = {
buffer: Buffer;
url: string;
type: string;
size: number;
};

3
app/home/routes/home_routes.ts
View File

@@ -1,3 +0,0 @@
import router from '@adonisjs/core/services/router';
router.on('/').renderInertia('home').as('home');

1
app/home/routes/routes.ts
View File

@@ -1 +0,0 @@
import './home_routes.js';

4
app/legal/routes/legal_routes.ts
View File

@@ -1,4 +0,0 @@
import router from '@adonisjs/core/services/router';
router.on('/terms').renderInertia('terms').as('terms');
router.on('/privacy').renderInertia('privacy').as('privacy');

1
app/legal/routes/routes.ts
View File

@@ -1 +0,0 @@
import './legal_routes.js';

8
app/core/lib/cache.ts → app/lib/cache.ts
View File

@@ -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 })),
}, },
}); });

30
app/links/controllers/create_link_controller.ts
View File

@@ -1,30 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { LinkService } from '#links/services/link_service';
import { createLinkValidator } from '#links/validators/create_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class CreateLinkController {
constructor(
private linkService: LinkService,
private collectionsService: CollectionService
) {}
async render({ inertia }: HttpContext) {
const collections =
await this.collectionsService.getCollectionsForAuthenticatedUser();
return inertia.render('links/create', { collections });
}
async execute({ request }: HttpContext) {
const { collectionId, ...payload } =
await request.validateUsing(createLinkValidator);
await this.linkService.createLink({
...payload,
collectionId,
});
return this.collectionsService.redirectToCollectionId(collectionId);
}
}

39
app/links/controllers/delete_link_controller.ts
View File

@@ -1,39 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { LinkService } from '#links/services/link_service';
import { deleteLinkValidator } from '#links/validators/delete_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
import db from '@adonisjs/lucid/services/db';
@inject()
export default class DeleteLinkController {
constructor(
protected collectionsService: CollectionService,
protected linkService: LinkService
) {}
async render({ auth, inertia, request }: HttpContext) {
const linkId = request.qs()?.linkId;
if (!linkId) {
return this.collectionsService.redirectToDashboard();
}
const link = await this.linkService.getLinkById(linkId, auth.user!.id);
await link.load('collection');
return inertia.render('links/delete', { link });
}
async execute({ request, auth }: HttpContext) {
const { params } = await request.validateUsing(deleteLinkValidator);
const link = await this.linkService.getLinkById(params.id, auth.user!.id);
await this.linkService.deleteLink(params.id);
return this.collectionsService.redirectToCollectionId(link.collectionId);
}
async getTotalLinksCount() {
const totalCount = await db.from('links').count('* as total');
return Number(totalCount[0].total);
}
}

19
app/links/controllers/toggle_favorite_controller.ts
View File

@@ -1,19 +0,0 @@
import { LinkService } from '#links/services/link_service';
import { updateLinkFavoriteStatusValidator } from '#links/validators/update_favorite_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class ToggleFavoriteController {
constructor(private linkService: LinkService) {}
async toggleFavorite({ request, response }: HttpContext) {
const { params, favorite } = await request.validateUsing(
updateLinkFavoriteStatusValidator
);
await this.linkService.updateFavorite(params.id, favorite);
return response.json({ status: 'ok' });
}
}

34
app/links/controllers/update_link_controller.ts
View File

@@ -1,34 +0,0 @@
import { CollectionService } from '#collections/services/collection_service';
import { LinkService } from '#links/services/link_service';
import { updateLinkValidator } from '#links/validators/update_link_validator';
import { inject } from '@adonisjs/core';
import { HttpContext } from '@adonisjs/core/http';
@inject()
export default class UpdateLinkController {
constructor(
private linkService: LinkService,
private collectionsService: CollectionService
) {}
async render({ auth, inertia, request, response }: HttpContext) {
const linkId = request.qs()?.linkId;
if (!linkId) {
return response.redirectToNamedRoute('dashboard');
}
const collections =
await this.collectionsService.getCollectionsForAuthenticatedUser();
const link = await this.linkService.getLinkById(linkId, auth.user!.id);
return inertia.render('links/edit', { collections, link });
}
async execute({ request }: HttpContext) {
const { params, ...payload } =
await request.validateUsing(updateLinkValidator);
await this.linkService.updateLink(params.id, payload);
return this.collectionsService.redirectToCollectionId(payload.collectionId);
}
}

31
app/links/models/link.ts
View File

@@ -1,31 +0,0 @@
import Collection from '#collections/models/collection';
import AppBaseModel from '#core/models/app_base_model';
import User from '#user/models/user';
import { belongsTo, column } from '@adonisjs/lucid/orm';
import type { BelongsTo } from '@adonisjs/lucid/types/relations';
export default class Link extends AppBaseModel {
@column()
declare name: string;
@column()
declare description: string | null;
@column()
declare url: string;
@column()
declare favorite: boolean;
@column()
declare collectionId: number;
@belongsTo(() => Collection, { foreignKey: 'collectionId' })
declare collection: BelongsTo<typeof Collection>;
@column()
declare authorId: number;
@belongsTo(() => User, { foreignKey: 'authorId' })
declare author: BelongsTo<typeof User>;
}

36
app/links/routes/links_routes.ts
View File

@@ -1,36 +0,0 @@
import { middleware } from '#start/kernel';
import router from '@adonisjs/core/services/router';
const CreateLinkController = () =>
import('#links/controllers/create_link_controller');
const DeleteLinkController = () =>
import('#links/controllers/delete_link_controller');
const UpdateLinkController = () =>
import('#links/controllers/update_link_controller');
const ToggleFavoriteController = () =>
import('#links/controllers/toggle_favorite_controller');
/**
* Routes for authenticated users
*/
router
.group(() => {
router
.get('/create', [CreateLinkController, 'render'])
.as('link.create-form');
router.post('/', [CreateLinkController, 'execute']).as('link.create');
router.get('/edit', [UpdateLinkController, 'render']).as('link.edit-form');
router.put('/:id', [UpdateLinkController, 'execute']).as('link.edit');
router
.put('/:id/favorite', [ToggleFavoriteController, 'toggleFavorite'])
.as('link.toggle-favorite');
router
.get('/delete', [DeleteLinkController, 'render'])
.as('link.delete-form');
router.delete('/:id', [DeleteLinkController, 'execute']).as('link.delete');
})
.middleware([middleware.auth()])
.prefix('/links');

1
app/links/routes/routes.ts
View File

@@ -1 +0,0 @@
import './links_routes.js';

68
app/links/services/link_service.ts
View File

@@ -1,68 +0,0 @@
import Link from '#links/models/link';
import { HttpContext } from '@adonisjs/core/http';
type CreateLinkPayload = {
name: string;
description?: string;
url: string;
favorite: boolean;
collectionId: number;
};
type UpdateLinkPayload = CreateLinkPayload;
export class LinkService {
createLink(payload: CreateLinkPayload) {
const context = this.getAuthContext();
return Link.create({
...payload,
authorId: context.auth.user!.id,
});
}
updateLink(id: number, payload: UpdateLinkPayload) {
const context = this.getAuthContext();
return Link.query()
.where('id', id)
.andWhere('author_id', context.auth.user!.id)
.update(payload);
}
deleteLink(id: number) {
const context = this.getAuthContext();
return Link.query()
.where('id', id)
.andWhere('author_id', context.auth.user!.id)
.delete();
}
async getLinkById(id: Link['id'], userId: Link['id']) {
return await Link.query()
.where('id', id)
.andWhere('author_id', userId)
.firstOrFail();
}
updateFavorite(id: number, favorite: boolean) {
return Link.query()
.where('id', id)
.andWhere('author_id', this.getAuthContext().auth.user!.id)
.update({ favorite });
}
async getFavoriteLinksForAuthenticatedUser() {
const context = this.getAuthContext();
return await Link.query()
.where('author_id', context.auth.user!.id)
.where('favorite', true)
.orderBy('created_at');
}
getAuthContext() {
const context = HttpContext.getOrFail();
if (!context.auth.user || !context.auth.user.id) {
throw new Error('User not authenticated');
}
return context;
}
}

9
app/links/validators/base_link_validator.ts
View File

@@ -1,9 +0,0 @@
import vine from '@vinejs/vine';
export const baseLinkValidator = vine.object({
name: vine.string().trim().minLength(1).maxLength(254),
description: vine.string().trim().maxLength(300).optional(),
url: vine.string().url({ require_tld: false }).trim(),
favorite: vine.boolean(),
collectionId: vine.number(),
});

8
app/links/validators/create_link_validator.ts
View File

@@ -1,8 +0,0 @@
import { baseLinkValidator } from '#links/validators/base_link_validator';
import vine from '@vinejs/vine';
export const createLinkValidator = vine.compile(
vine.object({
...baseLinkValidator.getProperties(),
})
);

Some files were not shown because too many files have changed in this diff Show More