5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews/*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Copyright (C) 1999-2001, 2004, 2005, 2007, 2016 Internet Systems Consortium, Inc. ("ISC")
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews *
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * This Source Code Form is subject to the terms of the Mozilla Public
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * License, v. 2.0. If a copy of the MPL was not distributed with this
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * file, You can obtain one at http://mozilla.org/MPL/2.0/.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews/* $Id: dbiterator.c,v 1.18 2007/06/19 23:47:16 tbox Exp $ */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews/*! \file */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews#include <config.h>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews#include <isc/util.h>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews#include <dns/dbiterator.h>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews#include <dns/name.h>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsvoid
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_destroy(dns_dbiterator_t **iteratorp) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Destroy '*iteratorp'.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(iteratorp != NULL);
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(*iteratorp));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews (*iteratorp)->methods->destroy(iteratorp);
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews ENSURE(*iteratorp == NULL);
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_first(dns_dbiterator_t *iterator) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Move the node cursor to the first node in the database (if any).
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->first(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_last(dns_dbiterator_t *iterator) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Move the node cursor to the first node in the database (if any).
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->last(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_seek(dns_dbiterator_t *iterator, dns_name_t *name) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Move the node cursor to the node with name 'name'.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->seek(iterator, name));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_prev(dns_dbiterator_t *iterator) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Move the node cursor to the previous node in the database (if any).
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->prev(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_next(dns_dbiterator_t *iterator) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Move the node cursor to the next node in the database (if any).
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->next(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_current(dns_dbiterator_t *iterator, dns_dbnode_t **nodep,
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews dns_name_t *name)
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews{
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Return the current node.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(nodep != NULL && *nodep == NULL);
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(name == NULL || dns_name_hasbuffer(name));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->current(iterator, nodep, name));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_pause(dns_dbiterator_t *iterator) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Pause iteration.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->pause(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsisc_result_t
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrewsdns_dbiterator_origin(dns_dbiterator_t *iterator, dns_name_t *name) {
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews /*
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews * Return the origin to which returned node names are relative.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews */
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(DNS_DBITERATOR_VALID(iterator));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(iterator->relative_names);
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews REQUIRE(dns_name_hasbuffer(name));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews return (iterator->methods->origin(iterator, name));
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews}
void
dns_dbiterator_setcleanmode(dns_dbiterator_t *iterator, isc_boolean_t mode) {
REQUIRE(DNS_DBITERATOR_VALID(iterator));
iterator->cleaning = mode;
}