chiark / gitweb /
~mdw / disorder / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge tag 'branchpoint-5.1' into release
[disorder] / lib / configuration.h
diff --git a/lib/configuration.h b/lib/configuration.h
index 297555709f41aaba3bc4fc00799679d7c250f147..ed6d3f11875929ecc634595a8845be5d335866ef 100644 (file)
--- a/lib/configuration.h
+++ b/lib/configuration.h
@@ -1,21 +1,19 @@
 /*
  * This file is part of DisOrder.
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+ * Copyright (C) 2004-2010 Richard Kettlewell
  *
  *
- * This program is free software; you can redistribute it and/or modify
+ * 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
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  * (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.
- *
+ * 
+ * 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
  * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /** @file lib/configuration.h
  * @brief Configuration file support
  */
 /** @file lib/configuration.h
  * @brief Configuration file support
@@ -24,9 +22,13 @@
 #ifndef CONFIGURATION_H
 #define CONFIGURATION_H
 
 #ifndef CONFIGURATION_H
 #define CONFIGURATION_H
 
-#include <ao/ao.h>
+#include <pcre.h>
 
 
-struct real_pcre;
+#include "speaker-protocol.h"
+#include "rights.h"
+#include "addr.h"
+
+struct uaudio;
 
 /* Configuration is kept in a @struct config@; the live configuration
  * is always pointed to by @config@.  Values in @config@ are UTF-8 encoded.
 
 /* Configuration is kept in a @struct config@; the live configuration
  * is always pointed to by @config@.  Values in @config@ are UTF-8 encoded.
@@ -66,27 +68,32 @@ struct collectionlist {
   struct collection *s;
 };
 
   struct collection *s;
 };
 
+/** @brief A track name part */
 struct namepart {
   char *part;                          /* part */
 struct namepart {
   char *part;                          /* part */
-  struct real_pcre *re;                        /* regexp */
+  pcre *re;                            /* compiled regexp */
+  char *res;                            /* regexp as a string */
   char *replace;                       /* replacement string */
   char *context;                       /* context glob */
   unsigned reflags;                    /* regexp flags */
 };
 
   char *replace;                       /* replacement string */
   char *context;                       /* context glob */
   unsigned reflags;                    /* regexp flags */
 };
 
+/** @brief A list of track name parts */
 struct namepartlist {
   int n;
   struct namepart *s;
 };
 
 struct namepartlist {
   int n;
   struct namepart *s;
 };
 
+/** @brief A track name transform */
 struct transform {
   char *type;                          /* track or dir */
   char *context;                       /* sort or choose */
   char *replace;                       /* substitution string */
 struct transform {
   char *type;                          /* track or dir */
   char *context;                       /* sort or choose */
   char *replace;                       /* substitution string */
-  struct real_pcre *re;                        /* compiled re */
+  pcre *re;                            /* compiled re */
   unsigned flags;                      /* regexp flags */
 };
 
   unsigned flags;                      /* regexp flags */
 };
 
+/** @brief A list of track name transforms */
 struct transformlist {
   int n;
   struct transform *t;
 struct transformlist {
   int n;
   struct transform *t;
@@ -96,24 +103,24 @@ struct transformlist {
 struct config {
   /* server config */
 
 struct config {
   /* server config */
 
+  /** @brief Authorization algorithm */
+  char *authorization_algorithm;
+  
   /** @brief All players */
   struct stringlistlist player;
 
   /** @brief All players */
   struct stringlistlist player;
 
-  /** @brief Allowed users */
-  struct stringlistlist allow;
+  /** @brief All tracklength plugins */
+  struct stringlistlist tracklength;
 
   /** @brief Scratch tracks */
   struct stringlist scratch;
 
 
   /** @brief Scratch tracks */
   struct stringlist scratch;
 
-  /** @brief Gap between tracks in seconds */
-  long gap;
-
   /** @brief Maximum number of recent tracks to record in history */
   long history;
 
   /** @brief Maximum number of recent tracks to record in history */
   long history;
 
-  /** @brief Trusted users */
-  struct stringlist trust;
-
+  /** @brief Expiry limit for noticed.db */
+  long noticed_history;
+  
   /** @brief User for server to run as */
   const char *user;
 
   /** @brief User for server to run as */
   const char *user;
 
@@ -141,17 +148,12 @@ struct config {
   /** @brief Mixer channel to use */
   char *channel;
 
   /** @brief Mixer channel to use */
   char *channel;
 
-  long prefsync;                       /* preflog sync interval */
-
   /** @brief Secondary listen address */
   /** @brief Secondary listen address */
-  struct stringlist listen;
+  struct netaddress listen;
 
   /** @brief Alias format string */
   const char *alias;
 
 
   /** @brief Alias format string */
   const char *alias;
 
-  /** @brief Enable server locking */
-  int lock;
-
   /** @brief Nice value for server */
   long nice_server;
 
   /** @brief Nice value for server */
   long nice_server;
 
@@ -161,56 +163,57 @@ struct config {
   /** @brief Command execute by speaker to play audio */
   const char *speaker_command;
 
   /** @brief Command execute by speaker to play audio */
   const char *speaker_command;
 
+  /** @brief Pause mode for command backend */
+  const char *pause_mode;
+  
   /** @brief Target sample format */
   /** @brief Target sample format */
-  ao_sample_format sample_format;
+  struct stream_header sample_format;
 
   /** @brief Sox syntax generation */
   long sox_generation;
 
 
   /** @brief Sox syntax generation */
   long sox_generation;
 
-  /** @brief Speaker backend
-   *
-   * Choices are @ref BACKEND_ALSA, @ref BACKEND_COMMAND or @ref
-   * BACKEND_NETWORK.
-   */
-  int speaker_backend;
-#define BACKEND_ALSA 0                 /**< Use ALSA (Linux only) */
-#define BACKEND_COMMAND 1              /**< Execute a command */
-#define BACKEND_NETWORK 2              /**< Transmit RTP  */
+  /** @brief API used to play sound */
+  const char *api;
+
+  /** @brief Maximum size of a playlist */
+  long playlist_max;
+
+  /** @brief Maximum lifetime of a playlist lock */
+  long playlist_lock_timeout;
 
   /** @brief Home directory for state files */
   const char *home;
 
   /** @brief Login username */
 
   /** @brief Home directory for state files */
   const char *home;
 
   /** @brief Login username */
-  const char *username;
+  char *username;
 
   /** @brief Login password */
 
   /** @brief Login password */
-  const char *password;
+  char *password;
 
   /** @brief Address to connect to */
 
   /** @brief Address to connect to */
-  struct stringlist connect;
+  struct netaddress connect;
 
   /** @brief Directories to search for web templates */
   struct stringlist templates;
 
   /** @brief Canonical URL of web interface */
 
   /** @brief Directories to search for web templates */
   struct stringlist templates;
 
   /** @brief Canonical URL of web interface */
-  const char *url;
+  char *url;
+
+  /** @brief Short display limit */
+  long short_display;
 
   /** @brief Maximum refresh interval for web interface (seconds) */
   long refresh;
 
 
   /** @brief Maximum refresh interval for web interface (seconds) */
   long refresh;
 
-  /** @brief Facilities restricted to trusted users
-   *
-   * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
-   * RESTRICT_MOVE.
-   */
-  unsigned restrictions;               /* restrictions */
-#define RESTRICT_SCRATCH 1             /**< Restrict scratching */
-#define RESTRICT_REMOVE 2              /**< Restrict removal */
-#define RESTRICT_MOVE 4                        /**< Restrict rearrangement */
+  /** @brief Minimum refresh interval for web interface (seconds) */
+  long refresh_min;
 
   /** @brief Target queue length */
   long queue_pad;
 
 
   /** @brief Target queue length */
   long queue_pad;
 
+  /** @brief Minimum time between a track being played again */
+  long replay_min;
+  
   struct namepartlist namepart;                /* transformations */
 
   /** @brief Termination signal for subprocesses */
   struct namepartlist namepart;                /* transformations */
 
   /** @brief Termination signal for subprocesses */
@@ -220,21 +223,77 @@ struct config {
   const char *device;
   struct transformlist transform;      /* path name transformations */
 
   const char *device;
   struct transformlist transform;      /* path name transformations */
 
-  struct stringlist broadcast;         /* audio broadcast address */
-  struct stringlist broadcast_from;    /* audio broadcast source address */
+  /** @brief Address to send audio data to */
+  struct netaddress broadcast;
+
+  /** @brief Source address for network audio transmission */
+  struct netaddress broadcast_from;
+
+  /** @brief RTP delay threshold */
+  long rtp_delay_threshold;
+
+  /** @brief Verbose RTP transmission logging */
+  int rtp_verbose;
+  
+  /** @brief TTL for multicast packets */
+  long multicast_ttl;
+
+  /** @brief Whether to loop back multicast packets */
+  int multicast_loop;
+
+  /** @brief Login lifetime in seconds */
+  long cookie_login_lifetime;
+
+  /** @brief Signing key lifetime in seconds */
+  long cookie_key_lifetime;
+
+  /** @brief Default rights for a new user */
+  char *default_rights;
+
+  /** @brief Path to sendmail executable */
+  char *sendmail;
+
+  /** @brief SMTP server for sending mail */
+  char *smtp_server;
+
+  /** @brief Origin address for outbound mail */
+  char *mail_sender;
+
+  /** @brief Maximum number of tracks in response to 'new' */
+  long new_max;
+
+  /** @brief Minimum interval between password reminder emails */
+  long reminder_interval;
+
+  /** @brief Whether to allow user management over TCP */
+  int remote_userman;
+
+  /** @brief Maximum age of biased-up tracks */
+  long new_bias_age;
+
+  /** @brief Maximum bias */
+  long new_bias;
+
+  /** @brief Rescan on (un)mount */
+  int mount_rescan;
 
   /* derived values: */
   int nparts;                          /* number of distinct name parts */
   char **parts;                                /* name part list  */
 
   /* derived values: */
   int nparts;                          /* number of distinct name parts */
   char **parts;                                /* name part list  */
+
+  /* undocumented, for testing only */
+  long dbversion;
 };
 
 extern struct config *config;
 /* the current configuration */
 
 };
 
 extern struct config *config;
 /* the current configuration */
 
-int config_read(void);
+int config_read(int server,
+                const struct config *oldconfig);
 /* re-read config, return 0 on success or non-0 on error.
  * Only updates @config@ if the new configuration is valid. */
 
 /* re-read config, return 0 on success or non-0 on error.
  * Only updates @config@ if the new configuration is valid. */
 
+char *config_get_file2(struct config *c, const char *name);
 char *config_get_file(const char *name);
 /* get a filename within the home directory */
 
 char *config_get_file(const char *name);
 /* get a filename within the home directory */
 
@@ -250,7 +309,14 @@ char *config_usersysconf(const struct passwd *pw );
 char *config_private(void);
 /* get the private config file */
 
 char *config_private(void);
 /* get the private config file */
 
+int config_verify(void);
+
+void config_free(struct config *c);
+
 extern char *configfile;
 extern char *configfile;
+extern int config_per_user;
+
+extern const struct uaudio *const *config_uaudio_apis;
 
 #endif /* CONFIGURATION_H */
 
 
 #endif /* CONFIGURATION_H */
 
Multi-user software jukebox -- https://www.greenend.org.uk/rjk/disorder/