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

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005-2008 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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/trackdb.h
  19  * @brief Track database public interface */
  20
  21 #ifndef TRACKDB_H
  22 #define TRACKDB_H
  23
  24 #include "event.h"
  25 #include "regexp.h"
  26 #include "rights.h"
  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 /** @brief Read-only access (trackdb_open()) */
  60 #define TRACKDB_READ_ONLY 0x0020
  61
  62 void trackdb_init(int flags);
  63 void trackdb_deinit(ev_source *ev);
  64 /* close/close environment */
  65
  66 void trackdb_master(struct ev_source *ev);
  67 /* start deadlock manager */
  68
  69 void trackdb_open(int flags);
  70 void trackdb_close(void);
  71 /* open/close track databases */
  72
  73 extern int trackdb_existing_database;
  74
  75 char **trackdb_stats(int *nstatsp);
  76 /* return a list of database stats */
  77
  78 void trackdb_stats_subprocess(struct ev_source *ev,
  79                               void (*done)(char *data, void *u),
  80                               void *u);
  81 /* collect stats in background and call done() with results */
  82
  83 int trackdb_set(const char *track,
  84                 const char *name,
  85                 const char *value);
  86 /* set a pref (remove if value=0).  Return 0 t */
  87
  88 const char *trackdb_get(const char *track,
  89                         const char *name);
  90 /* get a pref */
  91
  92 struct kvp *trackdb_get_all(const char *track);
  93 /* get all prefs */
  94
  95 const char *trackdb_resolve(const char *track);
  96 /* resolve alias - returns a null pointer if not found */
  97
  98 int trackdb_isalias(const char *track);
  99 /* return true if TRACK is an alias */
 100
 101 int trackdb_exists(const char *track);
 102 /* test whether a track exists (perhaps an alias) */
 103
 104 const char *trackdb_random(int tries);
 105 /* Pick a random non-alias track, making at most TRIES attempts.  Returns a
 106  * null pointer on failure. */
 107
 108 char **trackdb_alltags(void);
 109 /* Return the list of all tags */
 110
 111 const char *trackdb_getpart(const char *track,
 112                             const char *context,
 113                             const char *part);
 114 /* get a track name part, like trackname_part(), but taking the database into
 115  * account. */
 116
 117 const char *trackdb_rawpath(const char *track);
 118 /* get the raw path name for TRACK (might be an alias); returns a null pointer
 119  * if not found. */
 120
 121 enum trackdb_listable {
 122   trackdb_files = 1,
 123   trackdb_directories = 2
 124 };
 125
 126 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
 127                     const regexp *rec);
 128 /* Return the directories and/or files below DIR.  If DIR is a null pointer
 129  * then concatenate the listing of all collections.
 130  *
 131  * If REC is not a null pointer then only names where the basename matches the
 132  * regexp are returned.
 133  */
 134
 135 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks);
 136 /* return a list of tracks containing all of the words given.  If you
 137  * ask for only stopwords you get no tracks. */
 138
 139 void trackdb_rescan(struct ev_source *ev, int recheck,
 140                     void (*rescanned)(void *ru),
 141                     void *ru);
 142 /* Start a rescan, if one is not running already */
 143
 144 int trackdb_rescan_cancel(void);
 145 /* interrupt any running rescan.  Return 1 if one was running, else 0. */
 146
 147 void trackdb_gc(void);
 148 /* tidy up old database log files */
 149
 150 int trackdb_set_global(const char *name,
 151                        const char *value,
 152                        const char *who);
 153 /* set a global pref (remove if value=0). */
 154
 155 const char *trackdb_get_global(const char *name);
 156 /* get a global pref */
 157
 158 char **trackdb_new(int *ntracksp, int maxtracks);
 159
 160 void trackdb_expire_noticed(time_t when);
 161 void trackdb_create_root(void);
 162 const char *trackdb_get_password(const char *user);
 163 int trackdb_adduser(const char *user,
 164                     const char *password,
 165                     const char *rights,
 166                     const char *email,
 167                     const char *confirmation);
 168 int trackdb_deluser(const char *user);
 169 struct kvp *trackdb_getuserinfo(const char *user);
 170 int trackdb_edituserinfo(const char *user,
 171                          const char *key, const char *value);
 172 char **trackdb_listusers(void);
 173 int trackdb_confirm(const char *user, const char *confirmation,
 174                     rights_type *rightsp);
 175 int trackdb_readable(void);
 176
 177 typedef void random_callback(struct ev_source *ev,
 178                              const char *track);
 179 int trackdb_request_random(struct ev_source *ev,
 180                            random_callback *callback);
 181 void trackdb_add_rescanned(void (*rescanned)(void *ru),
 182                            void *ru);
 183 int trackdb_rescan_underway(void);
 184
 185 int trackdb_playlist_get(const char *name,
 186                          const char *who,
 187                          char ***tracksp,
 188                          int *ntracksp,
 189                          char **sharep);
 190 int trackdb_playlist_set(const char *name,
 191                          const char *who,
 192                          char **tracks,
 193                          int ntracks,
 194                          const char *share);
 195 void trackdb_playlist_list(const char *who,
 196                            char ***playlistsp,
 197                            int *nplaylistsp);
 198 int trackdb_playlist_delete(const char *name,
 199                             const char *who);
 200
 201 #endif /* TRACKDB_H */
 202
 203 /*
 204 Local Variables:
 205 c-basic-offset:2
 206 comment-column:40
 207 fill-column:79
 208 indent-tabs-mode:nil
 209 End:
 210 */