Use users.db. trackdb* moves to lib/, as it's now used by client.c to

[disorder] / lib / trackdb.h

/*
 * This file is part of DisOrder
 * Copyright (C) 2005, 2006, 2007 Richard Kettlewell
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */
/** @file lib/trackdb.h
 * @brief Track database public interface */

#ifndef TRACKDB_H
#define TRACKDB_H

struct ev_source;

extern const struct cache_type cache_files_type;
extern unsigned long cache_files_hits, cache_files_misses;
/* Cache entry type and tracking for regexp-based lookups */

/** @brief User can perform read-only operations */
#define RIGHT_READ            0x00000001

/** @brief User can add tracks to the queue */
#define RIGHT_PLAY            0x00000002

/** @brief User can move any track */
#define RIGHT_MOVE_ANY        0x00000004

/** @brief User can move their own tracks */
#define RIGHT_MOVE_MINE       0x00000008

/** @brief User can move randomly chosen tracks */
#define RIGHT_MOVE_RANDOM     0x00000010

#define RIGHT_MOVE__MASK      0x0000001c

/** @brief User can remove any track */
#define RIGHT_REMOVE_ANY      0x00000020

/** @brief User can remove their own tracks */
#define RIGHT_REMOVE_MINE     0x00000040

/** @brief User can remove randomly chosen tracks */
#define RIGHT_REMOVE_RANDOM   0x00000080

#define RIGHT_REMOVE__MASK    0x000000e0

/** @brief User can scratch any track */
#define RIGHT_SCRATCH_ANY     0x00000100

/** @brief User can scratch their own tracks */
#define RIGHT_SCRATCH_MINE    0x00000200

/** @brief User can scratch randomly chosen tracks */
#define RIGHT_SCRATCH_RANDOM  0x00000400

#define RIGHT_SCRATCH__MASK   0x00000700

/** @brief User can change the volume */
#define RIGHT_VOLUME          0x00000800

/** @brief User can perform admin operations */
#define RIGHT_ADMIN           0x00001000

/** @brief User can initiate a rescan */
#define RIGHT_RESCAN          0x00002000

/** @brief User can register new users */
#define RIGHT_REGISTER        0x00004000

/** @brief User can edit their own userinfo */
#define RIGHT_USERINFO        0x00008000

/** @brief User can modify track preferences */
#define RIGHT_PREFS           0x00010000

/** @brief User can modify global preferences */
#define RIGHT_GLOBAL_PREFS    0x00020000

/** @brief Current rights mask */
#define RIGHTS__MASK          0x0003ffff

/** @brief Unsigned type big enough for rights */
typedef uint32_t rights_type;

/** @brief Do not attempt database recovery (trackdb_init()) */
#define TRACKDB_NO_RECOVER 0x0000

/** @brief Attempt normal recovery (trackdb_init()) */
#define TRACKDB_NORMAL_RECOVER 0x0001

/** @brief Attempt catastrophic trcovery (trackdb_init()) */
#define TRACKDB_FATAL_RECOVER 0x0002

/** @brief Mask of recovery bits (trackdb_init()) */
#define TRACKDB_RECOVER_MASK 0x0003

/** @brief Open for database upgrade (trackdb_open()) */
#define TRACKDB_OPEN_FOR_UPGRADE 0x0004

/** @brief Permit upgrade (trackdb_open()) */
#define TRACKDB_CAN_UPGRADE 0x0008

/** @brief Do not permit upgrade (trackdb_open()) */
#define TRACKDB_NO_UPGRADE 0x0000

/** @brief Mask of upgrade bits (trackdb_open()) */
#define TRACKDB_UPGRADE_MASK 0x000C

/** @brief May create database environment (trackdb_init()) */
#define TRACKDB_MAY_CREATE 0x0010

/** @brief Read-only access (trackdb_open()) */
#define TRACKDB_READ_ONLY 0x0020

void trackdb_init(int flags);
void trackdb_deinit(void);
/* close/close environment */

void trackdb_master(struct ev_source *ev);
/* start deadlock manager */

void trackdb_open(int flags);
void trackdb_close(void);
/* open/close track databases */

extern int trackdb_existing_database;

char **trackdb_stats(int *nstatsp);
/* return a list of database stats */

void trackdb_stats_subprocess(struct ev_source *ev,
                              void (*done)(char *data, void *u),
                              void *u);
/* collect stats in background and call done() with results */

int trackdb_set(const char *track,
                const char *name,
                const char *value);
/* set a pref (remove if value=0).  Return 0 t */

const char *trackdb_get(const char *track,
                        const char *name);
/* get a pref */

struct kvp *trackdb_get_all(const char *track);
/* get all prefs */

const char *trackdb_resolve(const char *track);
/* resolve alias - returns a null pointer if not found */

int trackdb_isalias(const char *track);
/* return true if TRACK is an alias */

int trackdb_exists(const char *track);
/* test whether a track exists (perhaps an alias) */

const char *trackdb_random(int tries);
/* Pick a random non-alias track, making at most TRIES attempts.  Returns a
 * null pointer on failure. */

char **trackdb_alltags(void);
/* Return the list of all tags */

const char *trackdb_getpart(const char *track,
                            const char *context,
                            const char *part);
/* get a track name part, like trackname_part(), but taking the database into
 * account. */

const char *trackdb_rawpath(const char *track);
/* get the raw path name for TRACK (might be an alias); returns a null pointer
 * if not found. */

enum trackdb_listable {
  trackdb_files = 1,
  trackdb_directories = 2
};

char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
                    const pcre *rec);
/* Return the directories and/or files below DIR.  If DIR is a null pointer
 * then concatenate the listing of all collections.
 *
 * If REC is not a null pointer then only names where the basename matches the
 * regexp are returned.
 */

char **trackdb_search(char **wordlist, int nwordlist, int *ntracks);
/* return a list of tracks containing all of the words given.  If you
 * ask for only stopwords you get no tracks. */

void trackdb_rescan(struct ev_source *ev);
/* Start a rescan, if one is not running already */

int trackdb_rescan_cancel(void);
/* interrupt any running rescan.  Return 1 if one was running, else 0. */

void trackdb_gc(void);
/* tidy up old database log files */

void trackdb_set_global(const char *name,
                        const char *value,
                        const char *who);
/* set a global pref (remove if value=0). */

const char *trackdb_get_global(const char *name);
/* get a global pref */

char **trackdb_new(int *ntracksp, int maxtracks);

void trackdb_expire_noticed(time_t when);
void trackdb_old_users(void);
void trackdb_create_root(void);
const char *trackdb_get_password(const char *user);
int trackdb_adduser(const char *user,
                    const char *password,
                    rights_type rights,
                    const char *email);
int trackdb_deluser(const char *user);
struct kvp *trackdb_getuserinfo(const char *user);
int trackdb_edituserinfo(const char *user,
                         const char *key, const char *value);

rights_type default_rights(void);

#endif /* TRACKDB_H */

/*
Local Variables:
c-basic-offset:2
comment-column:40
fill-column:79
indent-tabs-mode:nil
End:
*/