/* lock-tokens-table.h : internal interface to ops on `lock-tokens' table
 *
 * ====================================================================
 *    Licensed to the Apache Software Foundation (ASF) under one
 *    or more contributor license agreements.  See the NOTICE file
 *    distributed with this work for additional information
 *    regarding copyright ownership.  The ASF licenses this file
 *    to you under the Apache License, Version 2.0 (the
 *    "License"); you may not use this file except in compliance
 *    with the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing,
 *    software distributed under the License is distributed on an
 *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *    KIND, either express or implied.  See the License for the
 *    specific language governing permissions and limitations
 *    under the License.
 * ====================================================================
 */

#ifndef SVN_LIBSVN_FS_LOCK_TOKENS_TABLE_H
#define SVN_LIBSVN_FS_LOCK_TOKENS_TABLE_H

#include "svn_fs.h"
#include "svn_error.h"
#include "../trail.h"
#include "../fs.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


/* Open a `lock-tokens' table in ENV.  If CREATE is non-zero, create
   one if it doesn't exist.  Set *LOCK_TOKENS_P to the new table.
   Return a Berkeley DB error code.  */
int svn_fs_bdb__open_lock_tokens_table(DB **locks_tokens_p,
                                       DB_ENV *env,
                                       svn_boolean_t create);


/* Add a lock-token to the `lock-tokens' table in FS, as part of TRAIL.
   Use PATH as the key and LOCK_TOKEN as the value.

   Warning: if PATH already exists as a key, then its value will be
   overwritten. */
svn_error_t *
svn_fs_bdb__lock_token_add(svn_fs_t *fs,
                           const char *path,
                           const char *lock_token,
                           trail_t *trail,
                           apr_pool_t *pool);


/* Remove the lock-token whose key is PATH from the `lock-tokens'
   table of FS, as part of TRAIL.

   If PATH doesn't exist as a key, return SVN_ERR_FS_NO_SUCH_LOCK.
*/
svn_error_t *
svn_fs_bdb__lock_token_delete(svn_fs_t *fs,
                              const char *path,
                              trail_t *trail,
                              apr_pool_t *pool);


/* Retrieve the lock-token *LOCK_TOKEN_P pointed to by PATH from the
   `lock-tokens' table of FS, as part of TRAIL.  Perform all
   allocations in POOL.

   If PATH doesn't exist as a key, return SVN_ERR_FS_NO_SUCH_LOCK.

   If PATH points to a token which points to an expired lock, return
     SVN_ERR_FS_LOCK_EXPIRED.  (After this, both the token and lock are
     gone from their respective tables.)

   If PATH points to a token which points to a non-existent lock,
     return SVN_ERR_FS_BAD_LOCK_TOKEN.  (After this, the token is also
     removed from the `lock-tokens' table.)
 */
svn_error_t *
svn_fs_bdb__lock_token_get(const char **lock_token_p,
                           svn_fs_t *fs,
                           const char *path,
                           trail_t *trail,
                           apr_pool_t *pool);



#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* SVN_LIBSVN_FS_LOCK_TOKENS_TABLE_H */