2020-04-11 16:20:33 +02:00
|
|
|
// Copyright 2020 Vikunja and contriubtors. All rights reserved.
|
|
|
|
//
|
|
|
|
// This file is part of Vikunja.
|
|
|
|
//
|
|
|
|
// Vikunja is free software: you can redistribute it and/or modify
|
2020-12-23 16:41:52 +01:00
|
|
|
// it under the terms of the GNU Affero General Public Licensee as published by
|
2020-04-11 16:20:33 +02:00
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// Vikunja 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
|
2020-12-23 16:41:52 +01:00
|
|
|
// GNU Affero General Public Licensee for more details.
|
2020-04-11 16:20:33 +02:00
|
|
|
//
|
2020-12-23 16:41:52 +01:00
|
|
|
// You should have received a copy of the GNU Affero General Public Licensee
|
2020-04-11 16:20:33 +02:00
|
|
|
// along with Vikunja. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
package models
|
|
|
|
|
|
|
|
import (
|
2020-06-27 19:04:01 +02:00
|
|
|
"fmt"
|
2020-04-11 16:20:33 +02:00
|
|
|
"reflect"
|
|
|
|
"strconv"
|
2020-12-19 22:39:11 +01:00
|
|
|
"strings"
|
2020-06-27 19:04:01 +02:00
|
|
|
"time"
|
2020-10-11 22:10:03 +02:00
|
|
|
|
|
|
|
"code.vikunja.io/api/pkg/config"
|
|
|
|
"github.com/iancoleman/strcase"
|
2020-06-27 19:04:01 +02:00
|
|
|
"xorm.io/xorm/schemas"
|
2020-04-11 16:20:33 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
type taskFilterComparator string
|
|
|
|
|
|
|
|
const (
|
|
|
|
taskFilterComparatorInvalid taskFilterComparator = "invalid"
|
|
|
|
|
|
|
|
taskFilterComparatorEquals taskFilterComparator = "="
|
|
|
|
taskFilterComparatorGreater taskFilterComparator = ">"
|
|
|
|
taskFilterComparatorGreateEquals taskFilterComparator = ">="
|
|
|
|
taskFilterComparatorLess taskFilterComparator = "<"
|
|
|
|
taskFilterComparatorLessEquals taskFilterComparator = "<="
|
|
|
|
taskFilterComparatorNotEquals taskFilterComparator = "!="
|
2020-12-19 13:56:55 +01:00
|
|
|
taskFilterComparatorLike taskFilterComparator = "like"
|
2020-12-19 22:39:11 +01:00
|
|
|
taskFilterComparatorIn taskFilterComparator = "in"
|
2020-04-11 16:20:33 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
type taskFilter struct {
|
|
|
|
field string
|
|
|
|
value interface{} // Needs to be an interface to be able to hold the field's native value
|
|
|
|
comparator taskFilterComparator
|
|
|
|
}
|
|
|
|
|
|
|
|
func getTaskFiltersByCollections(c *TaskCollection) (filters []*taskFilter, err error) {
|
|
|
|
|
|
|
|
if len(c.FilterByArr) > 0 {
|
|
|
|
c.FilterBy = append(c.FilterBy, c.FilterByArr...)
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(c.FilterValueArr) > 0 {
|
|
|
|
c.FilterValue = append(c.FilterValue, c.FilterValueArr...)
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(c.FilterComparatorArr) > 0 {
|
2020-05-09 15:08:58 +02:00
|
|
|
c.FilterComparator = append(c.FilterComparator, c.FilterComparatorArr...)
|
2020-04-11 16:20:33 +02:00
|
|
|
}
|
|
|
|
|
2020-05-09 17:48:56 +02:00
|
|
|
if c.FilterConcat != "" && c.FilterConcat != filterConcatAnd && c.FilterConcat != filterConcatOr {
|
|
|
|
return nil, ErrInvalidTaskFilterConcatinator{
|
|
|
|
Concatinator: taskFilterConcatinator(c.FilterConcat),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-11 16:20:33 +02:00
|
|
|
filters = make([]*taskFilter, 0, len(c.FilterBy))
|
|
|
|
for i, f := range c.FilterBy {
|
|
|
|
filter := &taskFilter{
|
|
|
|
field: f,
|
|
|
|
comparator: taskFilterComparatorEquals,
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(c.FilterComparator) > i {
|
|
|
|
filter.comparator, err = getFilterComparatorFromString(c.FilterComparator[i])
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
err = validateTaskFieldComparator(filter.comparator)
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// Cast the field value to its native type
|
|
|
|
if len(c.FilterValue) > i {
|
2020-12-19 22:39:11 +01:00
|
|
|
filter.value, err = getNativeValueForTaskField(filter.field, filter.comparator, c.FilterValue[i])
|
2020-04-11 16:20:33 +02:00
|
|
|
if err != nil {
|
2020-06-27 19:04:01 +02:00
|
|
|
return nil, ErrInvalidTaskFilterValue{
|
|
|
|
Value: filter.field,
|
|
|
|
Field: c.FilterValue[i],
|
|
|
|
}
|
2020-04-11 16:20:33 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
filters = append(filters, filter)
|
|
|
|
}
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
func validateTaskFieldComparator(comparator taskFilterComparator) error {
|
|
|
|
switch comparator {
|
|
|
|
case
|
|
|
|
taskFilterComparatorEquals,
|
|
|
|
taskFilterComparatorGreater,
|
|
|
|
taskFilterComparatorGreateEquals,
|
|
|
|
taskFilterComparatorLess,
|
|
|
|
taskFilterComparatorLessEquals,
|
2020-12-19 13:56:55 +01:00
|
|
|
taskFilterComparatorNotEquals,
|
2020-12-19 22:39:11 +01:00
|
|
|
taskFilterComparatorLike,
|
|
|
|
taskFilterComparatorIn:
|
2020-04-11 16:20:33 +02:00
|
|
|
return nil
|
2020-10-11 22:10:03 +02:00
|
|
|
case taskFilterComparatorInvalid:
|
|
|
|
fallthrough
|
2020-04-11 16:20:33 +02:00
|
|
|
default:
|
|
|
|
return ErrInvalidTaskFilterComparator{Comparator: comparator}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func getFilterComparatorFromString(comparator string) (taskFilterComparator, error) {
|
|
|
|
switch comparator {
|
|
|
|
case "equals":
|
|
|
|
return taskFilterComparatorEquals, nil
|
|
|
|
case "greater":
|
|
|
|
return taskFilterComparatorGreater, nil
|
|
|
|
case "greater_equals":
|
|
|
|
return taskFilterComparatorGreateEquals, nil
|
|
|
|
case "less":
|
|
|
|
return taskFilterComparatorLess, nil
|
|
|
|
case "less_equals":
|
|
|
|
return taskFilterComparatorLessEquals, nil
|
|
|
|
case "not_equals":
|
|
|
|
return taskFilterComparatorNotEquals, nil
|
2020-12-19 13:56:55 +01:00
|
|
|
case "like":
|
|
|
|
return taskFilterComparatorLike, nil
|
2020-12-19 22:39:11 +01:00
|
|
|
case "in":
|
|
|
|
return taskFilterComparatorIn, nil
|
2020-04-11 16:20:33 +02:00
|
|
|
default:
|
|
|
|
return taskFilterComparatorInvalid, ErrInvalidTaskFilterComparator{Comparator: taskFilterComparator(comparator)}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-12-19 22:39:11 +01:00
|
|
|
func getValueForField(field reflect.StructField, rawValue string) (value interface{}, err error) {
|
2020-04-11 16:20:33 +02:00
|
|
|
switch field.Type.Kind() {
|
|
|
|
case reflect.Int64:
|
2020-12-19 22:39:11 +01:00
|
|
|
value, err = strconv.ParseInt(rawValue, 10, 64)
|
2020-04-11 16:20:33 +02:00
|
|
|
case reflect.Float64:
|
2020-12-19 22:39:11 +01:00
|
|
|
value, err = strconv.ParseFloat(rawValue, 64)
|
2020-04-11 16:20:33 +02:00
|
|
|
case reflect.String:
|
2020-12-19 22:39:11 +01:00
|
|
|
value = rawValue
|
2020-04-11 16:20:33 +02:00
|
|
|
case reflect.Bool:
|
2020-12-19 22:39:11 +01:00
|
|
|
value, err = strconv.ParseBool(rawValue)
|
2020-06-27 19:04:01 +02:00
|
|
|
case reflect.Struct:
|
|
|
|
if field.Type == schemas.TimeType {
|
2020-12-19 22:39:11 +01:00
|
|
|
value, err = time.Parse(time.RFC3339, rawValue)
|
|
|
|
value = value.(time.Time).In(config.GetTimeZone())
|
2020-06-27 19:04:01 +02:00
|
|
|
}
|
2020-12-19 16:14:20 +01:00
|
|
|
case reflect.Slice:
|
2020-12-19 22:39:11 +01:00
|
|
|
// If this is a slice of pointers we're dealing with some property which is a relation
|
|
|
|
// In that case we don't really care about what the actual type is, we just cast the value to an
|
|
|
|
// int64 since we need the id - yes, this assumes we only ever have int64 IDs, but this is fine.
|
|
|
|
if field.Type.Elem().Kind() == reflect.Ptr {
|
|
|
|
value, err = strconv.ParseInt(rawValue, 10, 64)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// There are probably better ways to do this - please let me know if you have one.
|
|
|
|
if field.Type.Elem().String() == "time.Time" {
|
|
|
|
value, err = time.Parse(time.RFC3339, rawValue)
|
|
|
|
value = value.(time.Time).In(config.GetTimeZone())
|
2020-12-19 16:14:20 +01:00
|
|
|
return
|
|
|
|
}
|
|
|
|
fallthrough
|
2020-04-11 16:20:33 +02:00
|
|
|
default:
|
2020-12-19 22:39:11 +01:00
|
|
|
panic(fmt.Errorf("unrecognized filter type %s for field %s, value %s", field.Type.String(), field.Name, value))
|
2020-04-11 16:20:33 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
2020-12-19 22:39:11 +01:00
|
|
|
|
|
|
|
func getNativeValueForTaskField(fieldName string, comparator taskFilterComparator, value string) (nativeValue interface{}, err error) {
|
|
|
|
|
2020-12-22 00:13:15 +01:00
|
|
|
realFieldName := strings.ReplaceAll(strcase.ToCamel(fieldName), "Id", "ID")
|
|
|
|
|
|
|
|
if realFieldName == "Namespace" {
|
|
|
|
if comparator == taskFilterComparatorIn {
|
|
|
|
vals := strings.Split(value, ",")
|
|
|
|
valueSlice := []interface{}{}
|
|
|
|
for _, val := range vals {
|
|
|
|
v, err := strconv.ParseInt(val, 10, 64)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
valueSlice = append(valueSlice, v)
|
|
|
|
}
|
|
|
|
return valueSlice, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
nativeValue, err = strconv.ParseInt(value, 10, 64)
|
|
|
|
return
|
2020-12-19 22:39:11 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
field, ok := reflect.TypeOf(&Task{}).Elem().FieldByName(realFieldName)
|
|
|
|
if !ok {
|
|
|
|
return nil, ErrInvalidTaskField{TaskField: fieldName}
|
|
|
|
}
|
|
|
|
|
|
|
|
if comparator == taskFilterComparatorIn {
|
|
|
|
vals := strings.Split(value, ",")
|
|
|
|
valueSlice := []interface{}{}
|
|
|
|
for _, val := range vals {
|
|
|
|
v, err := getValueForField(field, val)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
valueSlice = append(valueSlice, v)
|
|
|
|
}
|
|
|
|
return valueSlice, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return getValueForField(field, value)
|
|
|
|
}
|