rhodecode/model/validation_schema/schemas/search_schema.py

# Copyright (C) 2016-2024 RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# 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 Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/


import colander


def sort_validator(node, value):
    if value in ['oldfirst', 'newfirst']:
        return value
    if value.startswith('asc:'):
        return value
    if value.startswith('desc:'):
        return value

    msg = 'Invalid search sort, must be `oldfirst`, `newfirst`, or start with asc: or desc:'
    raise colander.Invalid(node, msg)


class SearchParamsSchema(colander.MappingSchema):
    search_query = colander.SchemaNode(
        colander.String(),
        missing='')
    search_type = colander.SchemaNode(
        colander.String(),
        missing='content',
        validator=colander.OneOf(['content', 'path', 'commit', 'repository']))
    search_sort = colander.SchemaNode(
        colander.String(),
        missing='desc:date',
        validator=sort_validator)
    search_max_lines = colander.SchemaNode(
        colander.Integer(),
        missing=10)
    page_limit = colander.SchemaNode(
        colander.Integer(),
        missing=10,
        validator=colander.Range(1, 500))
    requested_page = colander.SchemaNode(
        colander.Integer(),
        missing=1)