chiark - git - mdw - disorder/blob - server/trackdb.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005, 2006, 2007 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file server/trackdb.h
  21  * @brief Track database public interface */
  22
  23 #ifndef TRACKDB_H
  24 #define TRACKDB_H
  25
  26 struct ev_source;
  27
  28 extern const struct cache_type cache_files_type;
  29 extern unsigned long cache_files_hits, cache_files_misses;
  30 /* Cache entry type and tracking for regexp-based lookups */
  31
  32 /** @brief Do not attempt database recovery (trackdb_init()) */
  33 #define TRACKDB_NO_RECOVER 0x0000
  34
  35 /** @brief Attempt normal recovery (trackdb_init()) */
  36 #define TRACKDB_NORMAL_RECOVER 0x0001
  37
  38 /** @brief Attempt catastrophic trcovery (trackdb_init()) */
  39 #define TRACKDB_FATAL_RECOVER 0x0002
  40
  41 /** @brief Mask of recovery bits (trackdb_init()) */
  42 #define TRACKDB_RECOVER_MASK 0x0003
  43
  44 /** @brief Open for database upgrade (trackdb_open()) */
  45 #define TRACKDB_OPEN_FOR_UPGRADE 0x0004
  46
  47 /** @brief Permit upgrade (trackdb_open()) */
  48 #define TRACKDB_CAN_UPGRADE 0x0008
  49
  50 /** @brief Do not permit upgrade (trackdb_open()) */
  51 #define TRACKDB_NO_UPGRADE 0x0000
  52
  53 /** @brief Mask of upgrade bits (trackdb_open()) */
  54 #define TRACKDB_UPGRADE_MASK 0x000C
  55
  56 /** @brief May create database environment (trackdb_init()) */
  57 #define TRACKDB_MAY_CREATE 0x0010
  58
  59 void trackdb_init(int flags);
  60 void trackdb_deinit(void);
  61 /* close/close environment */
  62
  63 void trackdb_master(struct ev_source *ev);
  64 /* start deadlock manager */
  65
  66 void trackdb_open(int flags);
  67 void trackdb_close(void);
  68 /* open/close track databases */
  69
  70 extern int trackdb_existing_database;
  71
  72 char **trackdb_stats(int *nstatsp);
  73 /* return a list of database stats */
  74
  75 void trackdb_stats_subprocess(struct ev_source *ev,
  76                               void (*done)(char *data, void *u),
  77                               void *u);
  78 /* collect stats in background and call done() with results */
  79
  80 int trackdb_set(const char *track,
  81                 const char *name,
  82                 const char *value);
  83 /* set a pref (remove if value=0).  Return 0 t */
  84
  85 const char *trackdb_get(const char *track,
  86                         const char *name);
  87 /* get a pref */
  88
  89 struct kvp *trackdb_get_all(const char *track);
  90 /* get all prefs */
  91
  92 const char *trackdb_resolve(const char *track);
  93 /* resolve alias - returns a null pointer if not found */
  94
  95 int trackdb_isalias(const char *track);
  96 /* return true if TRACK is an alias */
  97
  98 int trackdb_exists(const char *track);
  99 /* test whether a track exists (perhaps an alias) */
 100
 101 const char *trackdb_random(int tries);
 102 /* Pick a random non-alias track, making at most TRIES attempts.  Returns a
 103  * null pointer on failure. */
 104
 105 char **trackdb_alltags(void);
 106 /* Return the list of all tags */
 107
 108 const char *trackdb_getpart(const char *track,
 109                             const char *context,
 110                             const char *part);
 111 /* get a track name part, like trackname_part(), but taking the database into
 112  * account. */
 113
 114 const char *trackdb_rawpath(const char *track);
 115 /* get the raw path name for TRACK (might be an alias); returns a null pointer
 116  * if not found. */
 117
 118 enum trackdb_listable {
 119   trackdb_files = 1,
 120   trackdb_directories = 2
 121 };
 122
 123 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
 124                     const pcre *rec);
 125 /* Return the directories and/or files below DIR.  If DIR is a null pointer
 126  * then concatenate the listing of all collections.
 127  *
 128  * If REC is not a null pointer then only names where the basename matches the
 129  * regexp are returned.
 130  */
 131
 132 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks);
 133 /* return a list of tracks containing all of the words given.  If you
 134  * ask for only stopwords you get no tracks. */
 135
 136 void trackdb_rescan(struct ev_source *ev);
 137 /* Start a rescan, if one is not running already */
 138
 139 int trackdb_rescan_cancel(void);
 140 /* interrupt any running rescan.  Return 1 if one was running, else 0. */
 141
 142 void trackdb_gc(void);
 143 /* tidy up old database log files */
 144
 145 void trackdb_set_global(const char *name,
 146                         const char *value,
 147                         const char *who);
 148 /* set a global pref (remove if value=0). */
 149
 150 const char *trackdb_get_global(const char *name);
 151 /* get a global pref */
 152
 153 char **trackdb_new(int *ntracksp, int maxtracks);
 154
 155 void trackdb_expire_noticed(time_t when);
 156
 157 #endif /* TRACKDB_H */
 158
 159 /*
 160 Local Variables:
 161 c-basic-offset:2
 162 comment-column:40
 163 fill-column:79
 164 indent-tabs-mode:nil
 165 End:
 166 */