granicus.if.org Git - apache/blob - modules/dav/fs/repos.h

   1 /* Copyright 2000-2005 The Apache Software Foundation or its licensors, as
   2  * applicable.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file  repos.h
  19  * @brief Declarations for the filesystem repository implementation
  20  *
  21  * @addtogroup MOD_DAV
  22  * @{
  23  */
  24
  25 #ifndef _DAV_FS_REPOS_H_
  26 #define _DAV_FS_REPOS_H_
  27
  28 /* the subdirectory to hold all DAV-related information for a directory */
  29 #define DAV_FS_STATE_DIR                ".DAV"
  30 #define DAV_FS_STATE_FILE_FOR_DIR       ".state_for_dir"
  31 #define DAV_FS_LOCK_NULL_FILE           ".locknull"
  32
  33
  34 /* ensure that our state subdirectory is present */
  35 void dav_fs_ensure_state_dir(apr_pool_t *p, const char *dirname);
  36
  37 /* return the storage pool associated with a resource */
  38 apr_pool_t *dav_fs_pool(const dav_resource *resource);
  39
  40 /* return the full pathname for a resource */
  41 const char *dav_fs_pathname(const dav_resource *resource);
  42
  43 /* return the directory and filename for a resource */
  44 dav_error * dav_fs_dir_file_name(const dav_resource *resource,
  45                                  const char **dirpath,
  46                                  const char **fname);
  47
  48 /* return the list of locknull members in this resource's directory */
  49 dav_error * dav_fs_get_locknull_members(const dav_resource *resource,
  50                                         dav_buffer *pbuf);
  51
  52
  53 /* DBM functions used by the repository and locking providers */
  54 extern const dav_hooks_db dav_hooks_db_dbm;
  55
  56 dav_error * dav_dbm_open_direct(apr_pool_t *p, const char *pathname, int ro,
  57                                 dav_db **pdb);
  58 void dav_dbm_get_statefiles(apr_pool_t *p, const char *fname,
  59                             const char **state1, const char **state2);
  60 dav_error * dav_dbm_delete(dav_db *db, apr_datum_t key);
  61 dav_error * dav_dbm_store(dav_db *db, apr_datum_t key, apr_datum_t value);
  62 dav_error * dav_dbm_fetch(dav_db *db, apr_datum_t key, apr_datum_t *pvalue);
  63 void dav_dbm_freedatum(dav_db *db, apr_datum_t data);
  64 int dav_dbm_exists(dav_db *db, apr_datum_t key);
  65 void dav_dbm_close(dav_db *db);
  66
  67 /* where is the lock database located? */
  68 const char *dav_get_lockdb_path(const request_rec *r);
  69
  70 const dav_hooks_locks *dav_fs_get_lock_hooks(request_rec *r);
  71 const dav_hooks_propdb *dav_fs_get_propdb_hooks(request_rec *r);
  72
  73 void dav_fs_gather_propsets(apr_array_header_t *uris);
  74 int dav_fs_find_liveprop(const dav_resource *resource,
  75                          const char *ns_uri, const char *name,
  76                          const dav_hooks_liveprop **hooks);
  77 void dav_fs_insert_all_liveprops(request_rec *r, const dav_resource *resource,
  78                                  dav_prop_insert what, apr_text_header *phdr);
  79
  80 void dav_fs_register(apr_pool_t *p);
  81
  82 #endif /* _DAV_FS_REPOS_H_ */
  83 /** @} */
  84