2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
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.
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.
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
20 /** @file lib/trackdb.h
21 * @brief Track database public interface */
31 extern const struct cache_type cache_files_type;
32 extern unsigned long cache_files_hits, cache_files_misses;
33 /* Cache entry type and tracking for regexp-based lookups */
35 /** @brief Do not attempt database recovery (trackdb_init()) */
36 #define TRACKDB_NO_RECOVER 0x0000
38 /** @brief Attempt normal recovery (trackdb_init()) */
39 #define TRACKDB_NORMAL_RECOVER 0x0001
41 /** @brief Attempt catastrophic trcovery (trackdb_init()) */
42 #define TRACKDB_FATAL_RECOVER 0x0002
44 /** @brief Mask of recovery bits (trackdb_init()) */
45 #define TRACKDB_RECOVER_MASK 0x0003
47 /** @brief Open for database upgrade (trackdb_open()) */
48 #define TRACKDB_OPEN_FOR_UPGRADE 0x0004
50 /** @brief Permit upgrade (trackdb_open()) */
51 #define TRACKDB_CAN_UPGRADE 0x0008
53 /** @brief Do not permit upgrade (trackdb_open()) */
54 #define TRACKDB_NO_UPGRADE 0x0000
56 /** @brief Mask of upgrade bits (trackdb_open()) */
57 #define TRACKDB_UPGRADE_MASK 0x000C
59 /** @brief May create database environment (trackdb_init()) */
60 #define TRACKDB_MAY_CREATE 0x0010
62 /** @brief Read-only access (trackdb_open()) */
63 #define TRACKDB_READ_ONLY 0x0020
65 void trackdb_init(int flags);
66 void trackdb_deinit(void);
67 /* close/close environment */
69 void trackdb_master(struct ev_source *ev);
70 /* start deadlock manager */
72 void trackdb_open(int flags);
73 void trackdb_close(void);
74 /* open/close track databases */
76 extern int trackdb_existing_database;
78 char **trackdb_stats(int *nstatsp);
79 /* return a list of database stats */
81 void trackdb_stats_subprocess(struct ev_source *ev,
82 void (*done)(char *data, void *u),
84 /* collect stats in background and call done() with results */
86 int trackdb_set(const char *track,
89 /* set a pref (remove if value=0). Return 0 t */
91 const char *trackdb_get(const char *track,
95 struct kvp *trackdb_get_all(const char *track);
98 const char *trackdb_resolve(const char *track);
99 /* resolve alias - returns a null pointer if not found */
101 int trackdb_isalias(const char *track);
102 /* return true if TRACK is an alias */
104 int trackdb_exists(const char *track);
105 /* test whether a track exists (perhaps an alias) */
107 const char *trackdb_random(int tries);
108 /* Pick a random non-alias track, making at most TRIES attempts. Returns a
109 * null pointer on failure. */
111 char **trackdb_alltags(void);
112 /* Return the list of all tags */
114 const char *trackdb_getpart(const char *track,
117 /* get a track name part, like trackname_part(), but taking the database into
120 const char *trackdb_rawpath(const char *track);
121 /* get the raw path name for TRACK (might be an alias); returns a null pointer
124 enum trackdb_listable {
126 trackdb_directories = 2
129 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
131 /* Return the directories and/or files below DIR. If DIR is a null pointer
132 * then concatenate the listing of all collections.
134 * If REC is not a null pointer then only names where the basename matches the
135 * regexp are returned.
138 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks);
139 /* return a list of tracks containing all of the words given. If you
140 * ask for only stopwords you get no tracks. */
142 void trackdb_rescan(struct ev_source *ev, int recheck,
143 void (*rescanned)(void *ru),
145 /* Start a rescan, if one is not running already */
147 int trackdb_rescan_cancel(void);
148 /* interrupt any running rescan. Return 1 if one was running, else 0. */
150 void trackdb_gc(void);
151 /* tidy up old database log files */
153 void trackdb_set_global(const char *name,
156 /* set a global pref (remove if value=0). */
158 const char *trackdb_get_global(const char *name);
159 /* get a global pref */
161 char **trackdb_new(int *ntracksp, int maxtracks);
163 void trackdb_expire_noticed(time_t when);
164 void trackdb_old_users(void);
165 void trackdb_create_root(void);
166 const char *trackdb_get_password(const char *user);
167 int trackdb_adduser(const char *user,
168 const char *password,
171 const char *confirmation);
172 int trackdb_deluser(const char *user);
173 struct kvp *trackdb_getuserinfo(const char *user);
174 int trackdb_edituserinfo(const char *user,
175 const char *key, const char *value);
176 char **trackdb_listusers(void);
177 int trackdb_confirm(const char *user, const char *confirmation,
178 rights_type *rightsp);
179 int trackdb_readable(void);
181 typedef void random_callback(struct ev_source *ev,
183 int trackdb_request_random(struct ev_source *ev,
184 random_callback *callback);
185 void trackdb_add_rescanned(void (*rescanned)(void *ru),
187 int trackdb_rescan_underway(void);
189 #endif /* TRACKDB_H */