mirror of
https://github.com/go-vikunja/vikunja.git
synced 2026-02-01 22:47:40 +00:00
9a61453e86
Closes https://github.com/go-vikunja/vikunja/pull/2133 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: kolaente <k@knt.li>
73 lines
2.4 KiB
Go
73 lines
2.4 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-present Vikunja and contributors. All rights reserved.
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package web
|
|
|
|
import (
|
|
"github.com/labstack/echo/v5"
|
|
"xorm.io/xorm"
|
|
)
|
|
|
|
// Permissions defines permissions methods
|
|
type Permissions interface {
|
|
CanRead(*xorm.Session, Auth) (bool, int, error)
|
|
CanDelete(*xorm.Session, Auth) (bool, error)
|
|
CanUpdate(*xorm.Session, Auth) (bool, error)
|
|
CanCreate(*xorm.Session, Auth) (bool, error)
|
|
}
|
|
|
|
// CRUDable defines the CRUD methods
|
|
type CRUDable interface {
|
|
Create(*xorm.Session, Auth) error
|
|
ReadOne(*xorm.Session, Auth) error
|
|
ReadAll(s *xorm.Session, auth Auth, search string, page int, perPage int) (result interface{}, resultCount int, numberOfTotalItems int64, err error)
|
|
Update(*xorm.Session, Auth) error
|
|
Delete(*xorm.Session, Auth) error
|
|
}
|
|
|
|
// HTTPErrorProcessor is executed when the defined error is thrown, it will make sure the user sees an appropriate error message and http status code
|
|
type HTTPErrorProcessor interface {
|
|
HTTPError() HTTPError
|
|
}
|
|
|
|
// HTTPError holds information about an http error
|
|
type HTTPError struct {
|
|
HTTPCode int `json:"-"`
|
|
Code int `json:"code"`
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
type HTTPErrorWithDetails struct {
|
|
HTTPError
|
|
Details interface{} `json:"details"`
|
|
}
|
|
|
|
// Auth defines the interface used to retrieve authentication information
|
|
type Auth interface {
|
|
// Most of the time, we need an ID from the auth object only. Having this method saves the need to cast it.
|
|
GetID() int64
|
|
}
|
|
|
|
// Authprovider holds the implementation of an auth provider used by the application
|
|
type Authprovider interface {
|
|
GetAuthObject(echo.Context) (Auth, error)
|
|
}
|
|
|
|
// Auths holds the auth object
|
|
type Auths struct {
|
|
AuthObject func(echo.Context) (Auth, error)
|
|
}
|