1 /* lock.h : internal interface to lock functions
3 * ====================================================================
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
20 * ====================================================================
23 #ifndef SVN_LIBSVN_FS_LOCK_H
24 #define SVN_LIBSVN_FS_LOCK_H
28 #endif /* __cplusplus */
32 /* These functions implement some of the calls in the FS loader
33 library's fs vtables. */
35 /* See svn_fs_lock(), svn_fs_lock_many(). */
37 svn_fs_x__lock(svn_fs_t *fs,
40 svn_boolean_t is_dav_comment,
41 apr_time_t expiration_date,
42 svn_boolean_t steal_lock,
43 svn_fs_lock_callback_t lock_callback,
45 apr_pool_t *result_pool,
46 apr_pool_t *scratch_pool);
48 /* See svn_fs_generate_lock_token(). */
50 svn_fs_x__generate_lock_token(const char **token,
54 /* See svn_fs_unlock(), svn_fs_unlock_many(). */
56 svn_fs_x__unlock(svn_fs_t *fs,
58 svn_boolean_t break_lock,
59 svn_fs_lock_callback_t lock_callback,
61 apr_pool_t *result_pool,
62 apr_pool_t *scratch_pool);
64 /* See svn_fs_get_lock(). */
66 svn_fs_x__get_lock(svn_lock_t **lock,
71 /* See svn_fs_get_locks2(). */
73 svn_fs_x__get_locks(svn_fs_t *fs,
76 svn_fs_get_locks_callback_t get_locks_func,
77 void *get_locks_baton,
78 apr_pool_t *scratch_pool);
81 /* Examine PATH for existing locks, and check whether they can be
82 used. Use SCRATCH_POOL for temporary allocations.
84 If no locks are present, return SVN_NO_ERROR.
86 If PATH is locked (or contains locks "below" it, when RECURSE is
87 set), then verify that:
89 1. a username has been supplied to TRAIL->fs's access-context,
90 else return SVN_ERR_FS_NO_USER.
92 2. for every lock discovered, the current username in the access
93 context of TRAIL->fs matches the "owner" of the lock, else
94 return SVN_ERR_FS_LOCK_OWNER_MISMATCH.
96 3. for every lock discovered, a matching lock token has been
97 passed into TRAIL->fs's access-context, else return
98 SVN_ERR_FS_BAD_LOCK_TOKEN.
100 If all three conditions are met, return SVN_NO_ERROR.
102 If the caller (directly or indirectly) has the FS write lock,
103 HAVE_WRITE_LOCK should be true.
106 svn_fs_x__allow_locked_operation(const char *path,
108 svn_boolean_t recurse,
109 svn_boolean_t have_write_lock,
110 apr_pool_t *scratch_pool);
114 #endif /* __cplusplus */
116 #endif /* SVN_LIBSVN_FS_LOCK_H */