forked from vikunja/vikunja
konrad
8d1a09b5a2
Fix lint Fix lint Fix loading tasks with search Fix loading lists Fix loading task Fix loading lists and namespaces Fix tests Fix user commands Fix upload Fix migration handlers Fix all manual root handlers Fix session in avatar Fix session in list duplication & routes Use sessions in migration code Make sure the openid stuff uses a session Add alias for db type in db package Use sessions for file Use a session for everything in users Use a session for everything in users Make sure to use a session everywhere in models Create new session from db Add session handling for user list Add session handling for unsplash Add session handling for teams and related Add session handling for tasks and related entities Add session handling for task reminders Add session handling for task relations Add session handling for task comments Add session handling for task collections Add session handling for task attachments Add session handling for task assignees Add session handling for saved filters Add session handling for namespace and related types Add session handling for namespace and related types Add session handling for list users Add session handling for list tests Add session handling to list teams and related entities Add session handling for link shares and related entities Add session handling for labels and related entities Add session handling for kanban and related entities Add session handling for bulk task and related entities Add session handling for lists and related entities Add session configuration for web handler Update web handler Co-authored-by: kolaente <k@knt.li> Reviewed-on: vikunja/api#750 Co-Authored-By: konrad <konrad@kola-entertainments.de> Co-Committed-By: konrad <konrad@kola-entertainments.de>
187 lines
6.1 KiB
Go
187 lines
6.1 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-2020 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 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/>.
|
|
|
|
package models
|
|
|
|
import (
|
|
"time"
|
|
|
|
"code.vikunja.io/api/pkg/user"
|
|
"code.vikunja.io/web"
|
|
"xorm.io/xorm"
|
|
)
|
|
|
|
// SavedFilter represents a saved bunch of filters
|
|
type SavedFilter struct {
|
|
// The unique numeric id of this saved filter
|
|
ID int64 `xorm:"autoincr not null unique pk" json:"id" param:"filter"`
|
|
// The actual filters this filter contains
|
|
Filters *TaskCollection `xorm:"JSON not null" json:"filters"`
|
|
// The title of the filter.
|
|
Title string `xorm:"varchar(250) not null" json:"title" valid:"required,runelength(1|250)" minLength:"1" maxLength:"250"`
|
|
// The description of the filter
|
|
Description string `xorm:"longtext null" json:"description"`
|
|
OwnerID int64 `xorm:"bigint not null INDEX" json:"-"`
|
|
|
|
// The user who owns this filter
|
|
Owner *user.User `xorm:"-" json:"owner" valid:"-"`
|
|
|
|
// A timestamp when this filter was created. You cannot change this value.
|
|
Created time.Time `xorm:"created not null" json:"created"`
|
|
// A timestamp when this filter was last updated. You cannot change this value.
|
|
Updated time.Time `xorm:"updated not null" json:"updated"`
|
|
|
|
web.CRUDable `xorm:"-" json:"-"`
|
|
web.Rights `xorm:"-" json:"-"`
|
|
}
|
|
|
|
// TableName returns a better table name for saved filters
|
|
func (sf *SavedFilter) TableName() string {
|
|
return "saved_filters"
|
|
}
|
|
|
|
func (sf *SavedFilter) getTaskCollection() *TaskCollection {
|
|
// We're resetting the listID to return tasks from all lists
|
|
sf.Filters.ListID = 0
|
|
return sf.Filters
|
|
}
|
|
|
|
// Returns the saved filter ID from a list ID. Will not check if the filter actually exists.
|
|
// If the returned ID is zero, means that it is probably invalid.
|
|
func getSavedFilterIDFromListID(listID int64) (filterID int64) {
|
|
// We get the id of the saved filter by multiplying the ListID with -1 and subtracting one
|
|
filterID = listID*-1 - 1
|
|
// FilterIDs from listIDs are always positive
|
|
if filterID < 0 {
|
|
filterID = 0
|
|
}
|
|
return
|
|
}
|
|
|
|
func getListIDFromSavedFilterID(filterID int64) (listID int64) {
|
|
listID = filterID*-1 - 1
|
|
// ListIDs from saved filters are always negative
|
|
if listID > 0 {
|
|
listID = 0
|
|
}
|
|
return
|
|
}
|
|
|
|
func getSavedFiltersForUser(s *xorm.Session, auth web.Auth) (filters []*SavedFilter, err error) {
|
|
// Link shares can't view or modify saved filters, therefore we can error out right away
|
|
if _, is := auth.(*LinkSharing); is {
|
|
return nil, ErrSavedFilterNotAvailableForLinkShare{LinkShareID: auth.GetID()}
|
|
}
|
|
|
|
err = s.Where("owner_id = ?", auth.GetID()).Find(&filters)
|
|
return
|
|
}
|
|
|
|
// Create creates a new saved filter
|
|
// @Summary Creates a new saved filter
|
|
// @Description Creates a new saved filter
|
|
// @tags filter
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Success 200 {object} models.SavedFilter "The Saved Filter"
|
|
// @Failure 403 {object} web.HTTPError "The user does not have access to that saved filter."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /filters [put]
|
|
func (sf *SavedFilter) Create(s *xorm.Session, auth web.Auth) error {
|
|
sf.OwnerID = auth.GetID()
|
|
_, err := s.Insert(sf)
|
|
return err
|
|
}
|
|
|
|
func getSavedFilterSimpleByID(s *xorm.Session, id int64) (sf *SavedFilter, err error) {
|
|
sf = &SavedFilter{}
|
|
exists, err := s.
|
|
Where("id = ?", id).
|
|
Get(sf)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if !exists {
|
|
return nil, ErrSavedFilterDoesNotExist{SavedFilterID: id}
|
|
}
|
|
return
|
|
}
|
|
|
|
// ReadOne returns one saved filter
|
|
// @Summary Gets one saved filter
|
|
// @Description Returns a saved filter by its ID.
|
|
// @tags filter
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param id path int true "Filter ID"
|
|
// @Success 200 {object} models.SavedFilter "The Saved Filter"
|
|
// @Failure 403 {object} web.HTTPError "The user does not have access to that saved filter."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /filters/{id} [get]
|
|
func (sf *SavedFilter) ReadOne(s *xorm.Session) error {
|
|
// s already contains almost the full saved filter from the rights check, we only need to add the user
|
|
u, err := user.GetUserByID(s, sf.OwnerID)
|
|
sf.Owner = u
|
|
return err
|
|
}
|
|
|
|
// Update updates an existing filter
|
|
// @Summary Updates a saved filter
|
|
// @Description Updates a saved filter by its ID.
|
|
// @tags filter
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param id path int true "Filter ID"
|
|
// @Success 200 {object} models.SavedFilter "The Saved Filter"
|
|
// @Failure 403 {object} web.HTTPError "The user does not have access to that saved filter."
|
|
// @Failure 404 {object} web.HTTPError "The saved filter does not exist."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /filters/{id} [post]
|
|
func (sf *SavedFilter) Update(s *xorm.Session) error {
|
|
_, err := s.
|
|
Where("id = ?", sf.ID).
|
|
Cols(
|
|
"title",
|
|
"description",
|
|
"filters",
|
|
).
|
|
Update(sf)
|
|
return err
|
|
}
|
|
|
|
// Delete removes a saved filter
|
|
// @Summary Removes a saved filter
|
|
// @Description Removes a saved filter by its ID.
|
|
// @tags filter
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param id path int true "Filter ID"
|
|
// @Success 200 {object} models.SavedFilter "The Saved Filter"
|
|
// @Failure 403 {object} web.HTTPError "The user does not have access to that saved filter."
|
|
// @Failure 404 {object} web.HTTPError "The saved filter does not exist."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /filters/{id} [delete]
|
|
func (sf *SavedFilter) Delete(s *xorm.Session) error {
|
|
_, err := s.
|
|
Where("id = ?", sf.ID).
|
|
Delete(sf)
|
|
return err
|
|
}
|