doc/html/mod__musicindex_8h_source.html

/*

 *  mod_musicindex.h

 *  mod_musicindex

 *

 *  $Id: mod_musicindex.h 1013 2012-09-01 17:42:41Z varenet $

 *

 *  Created by Thibaut VARENE on Thu Mar 20 2003.

 *  Copyright (c) 2003-2006 Regis BOUDIN

 *  Copyright (c) 2003-2012 Thibaut VARENE

 *

 *  This program is free software; you can redistribute it and/or modify

 *  it under the terms of the GNU Lesser General Public License version 2.1,

 *  as published by the Free Software Foundation.

 *

 */


#ifndef MOD_MUSICINDEX_H

#define MOD_MUSICINDEX_H


#include <httpd.h>

#include <http_config.h>

#include <http_request.h>

#include <http_protocol.h>

#include <http_log.h>


/* AP24 bw compat 2.0/2.2 */

#ifdef APLOG_USE_MODULE

APLOG_USE_MODULE(musicindex);

#endif


/* Define to the address where bug reports for this package should be sent. */

#undef PACKAGE_BUGREPORT


/* Define to the full name of this package. */

#undef PACKAGE_NAME


/* Define to the full name and version of this package. */

#undef PACKAGE_STRING


/* Define to the one symbol short name of this package. */

#undef PACKAGE_TARNAME


/* Define to the version of this package. */

#undef PACKAGE_VERSION


#include "mod_musicindex_config.h"


/*

 * Current version number & authors

 */

#define MUSIC_VERSION_STRING    PACKAGE_VERSION

#define MUSIC_AUTHORS_STRING    "R. Boudin & T. Varene"

#define MUSIC_HEADER_STRING     "mod_musicindex/" MUSIC_VERSION_STRING


/*

 * Compile time configuration options

 * Comment explains what happens when they are #define'd

 * TODO some of these should be ./configure'able

 */

#undef NO_TITLE_STRIP   /* Disable title pretty printing for untagged files */

#undef NO_BR_NOMINAL    /* Disable display of nominal bitrate when available */

#undef BE_INSECURE      /* Enable insecure auth credential leaking in urls */

#undef DEBUG            /* Enable debug output */


/* these are not defined on BSD */

#ifndef FALSE

 #define FALSE 0

 #define TRUE !FALSE

#endif


#ifndef C_HAS_ATTRIBUTE

 #define __attribute__(x)       /* NOTHING */

#endif


#ifdef C_HAS_BUILTIN_EXPECT

 #define likely(x)       __builtin_expect(!!(x), 1)

 #define unlikely(x)     __builtin_expect(!!(x), 0)

#else

 #define likely(x)      (x)

 #define unlikely(x)    (x)

#endif


#ifdef HAVE_SYS_TIME_H

 #define STRUCTTV struct timeval

 #if (!defined(HAVE_TIMERSUB) && !defined(timersub))

  #define timersub(tvp, uvp, vvp)                                       \

        do {                                                            \

                (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \

                (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \

                if ((vvp)->tv_usec < 0) {                               \

                        (vvp)->tv_sec--;                                \

                        (vvp)->tv_usec += 1000000;                      \

                }                                                       \

        } while (0)

 #endif

#else

 #define STRUCTTV int

#endif


/* a very common macro */

#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))


enum {

        SB_NULL,

        SB_ALBUM,

        SB_POSN,

        SB_TRACK,

        SB_ARTIST,

        SB_TITLE,

        SB_LENGTH,

        SB_BITRATE,

        SB_FREQ,

        SB_FILETYPE,

        SB_FILENAME,

        SB_URI,

        SB_GENRE,

        SB_DATE,

        SB_SIZE,

        SB_MTIME,

        SB_RANDOM,

        SB_DIR,

        SB_MAX,

};


#define SB_DEFAULT      SB_URI

/*

 * Flags used in mu_config struct, fields "options" and "options_not".

 * 16 bits max.

 */


/* First, the flags set by the configuration */

#define MI_ACTIVE       (1 << 0)

#define MI_ALLOWSTREAM  (1 << 1)

#define MI_ALLOWDWNLD   (1 << 2)

#define MI_ALLOWSEARCH  (1 << 3)

#define MI_ALLOWTARBALL (1 << 4)

#define MI_ALLOWFETCH   (MI_ALLOWSTREAM | MI_ALLOWDWNLD | MI_ALLOWTARBALL)


/* XXX TODO : move these flags to a different parameter in the structure */

/* The flags set on requests */

#define MI_STREAM       (1 << 5)

#define MI_ALL          (1 << 6)

#define MI_RECURSIVE    (1 << 7)

#define MI_RSS          (1 << 8)

#define MI_PODCAST      (1 << 9)

#define MI_RANDOMDIR    (1 << 10)

#define MI_TARBALL      (1 << 11)

#define MI_STREAMLST    (MI_STREAM)

#define MI_STREAMALL    (MI_STREAM | MI_ALL)

#define MI_STREAMCOOKIE (MI_STREAM | MI_COOKIEOP)

#define MI_STREAMRQ     (MI_STREAMLST | MI_STREAMALL | MI_STREAMCOOKIE)


#define MI_DWNLDLST     (MI_TARBALL)

#define MI_DWNLDALL     (MI_TARBALL | MI_ALL)

#define MI_DWNLDCOOKIE  (MI_TARBALL | MI_COOKIEOP)

#define MI_DWNLDRQ      (MI_DWNLDLST | MI_DWNLDALL | MI_DWNLDCOOKIE)


/* The cookie-related flags */

#define MI_COOKIEOP     (1 << 12)

#define MI_COOKIEADD    (1 << 13)

#define MI_COOKIEDEL    (1 << 14)

#define MI_COOKIEADDLST (MI_COOKIEOP | MI_COOKIEADD)

#define MI_COOKIEDELLST (MI_COOKIEOP | MI_COOKIEDEL)

#define MI_COOKIEADDALL (MI_COOKIEOP | MI_COOKIEADD | MI_ALL)

#define MI_COOKIEPURGE  (MI_COOKIEOP | MI_COOKIEDEL | MI_ALL)

#define MI_COOKIESTREAM (MI_COOKIEOP | MI_STREAM)

#define MI_COOKIEDWNLD  (MI_COOKIEOP | MI_TARBALL)


#define MI_ALLOPS       (MI_COOKIEOP | \

                        MI_COOKIEADD | \

                        MI_COOKIEDEL | \

                        MI_STREAM    | \

                        MI_TARBALL   | \

                        MI_ALL)


/* Flags for internal use */

#define MI_QUICKPL      (1 << 15)

/* Extended options set: Flags not stored in config options but used directly.

   These can exceed the 16bit boundary, with care. */

#define MI_CUSTOM       (1 << 16)

#define MI_ALLOWRSS     (1 << 17)

/*** End of mu_config flags ***/


/*

 * Flags used in mu_ent struct, field "flags".

 * 8 bits max.

 */


/* Following can be cached */

#define EF_VBR          (1 << 0)

/* Following can *NOT* be cached and must be updated everytime */

#define EF_INCACHE      (1 << 1)

#define EF_ALLOWSTREAM  (1 << 2)

#define EF_ALLOWDWNLD   (1 << 3)

#define EF_ALLOWTARBALL (1 << 4)

#define EF_ALLOWRSS     (1 << 5)

#define EF_FLAGSTOSAVE  (EF_VBR)


/*** End of mu_ent flags ***/


#define MAX_STRING      1024

#define MAX_GENRE       64

#define MAX_FNAME       255

#define MAX_PATHNAME    4096

#define MI_LOG_PREFIX   "[mod_musicindex] "

#ifndef BUILD_FOR_APACHE2


 /* some things have to be redefined for apache 1.3 to use the same declaration

    in both apache 1&2 versions of the program */

 #define apr_pool_t     pool

 #define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \

    { directive, func, mconfig, where, NO_ARGS, help }

 #define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \

    { directive, func, mconfig, where, RAW_ARGS, help }

 #define AP_INIT_TAKE1(directive, func, mconfig, where, help) \

    { directive, func, mconfig, where, TAKE1, help }

 #define AP_INIT_FLAG(directive, func, mconfig, where, help) \

    { directive, func, mconfig, where, FLAG, help }


 #define ap_is_directory(pool, name) ap_is_directory(name)

 #define ap_set_content_type(r, string) (r->content_type = string)

 #define apr_pool_create(child, parent) ((*(child)) = ap_make_sub_pool(parent))

 #define ap_sub_req_lookup_uri(p, r, ptr) ap_sub_req_lookup_uri(p, r)

 #define REQUEST_USER(rec) (rec->connection->user)


 #define apr_pool_destroy ap_destroy_pool


 #define apr_table_get ap_table_get

 #define apr_table_set ap_table_set

 #define apr_table_setn ap_table_setn

 #define apr_palloc ap_palloc

 #define apr_pcalloc ap_pcalloc

 #define apr_pstrdup ap_pstrdup

 #define apr_pstrndup ap_pstrndup

 #define apr_pstrcat ap_pstrcat

 #define apr_psprintf ap_psprintf

 #define apr_base64_encode_len ap_base64encode_len

 #define apr_base64_encode ap_base64encode

 #define apr_base64_decode_len ap_base64decode_len

 #define apr_base64_decode ap_base64decode


#else


 #if defined(AP20)

  /* nada */

 #elif defined(AP22)

  #define ap_http_method ap_http_scheme

 #elif defined(AP24)

  #define ap_http_method ap_http_scheme

  #define ap_get_server_name(r) ap_get_server_name_for_url(r)

 #else

  #error "unknown apache API"

 #endif


 #include <apr_strings.h>

 #include <apr_base64.h>

 #include <ap_compat.h>


 #ifdef APLOG_ERR

  #undef APLOG_ERR

  #define APLOG_ERR LOG_ERR, 0

 #endif

 #ifdef APLOG_WARNING

  #undef APLOG_WARNING

  #define APLOG_WARNING LOG_WARNING, 0

 #endif

 #ifdef APLOG_NOTICE

  #undef APLOG_NOTICE

  #define APLOG_NOTICE LOG_NOTICE, 0

 #endif

 #ifdef APLOG_DEBUG

  #undef APLOG_DEBUG

  #define APLOG_DEBUG LOG_DEBUG, 0

 #endif


 #define REQUEST_USER(rec) (rec->user)


#endif  /* ! __BUILD_FOR_APACHE2 */


typedef struct mu_ent {

        const struct mu_ent *next;

        const char *file;

        const char *filename;

        const char *uri;

        const char * restrict album;

        const char * restrict artist;

        const char * restrict title;

        const char * restrict genre;

        unsigned long bitrate;

        unsigned long size;

        unsigned long mtime;

        unsigned short freq;

        unsigned short length;

        unsigned short date;

        unsigned char flags;

        unsigned char track;

        unsigned char posn;

        signed char filetype;

} /* __attribute__((packed)) */ mu_ent;


typedef struct {

        const mu_ent *head;

        const mu_ent *fhead;

        unsigned long filenb;

        unsigned long fsize;

        unsigned short dirnb;

} mu_pack;


typedef struct mu_config mu_config;


typedef struct {

        void* (*opendir)(request_rec *r, mu_pack *const pack,

                        const char * const filename, const char * const uri, unsigned long soptions);


        const char* (*readdir)(void *dir);


        void (*closedir)(void *dir);


        mu_ent* (*make_entry)(request_rec *r, apr_pool_t *pool, FILE *const in,

                const char *const filename);


        void (*write)(request_rec *r, const mu_ent *const entry,

                                  const char * const name);


        void (*prologue)(request_rec *r);


        void (*epilogue)(request_rec *r);

} cache_backend;


struct mu_config {

        /* non settings, these are piggy-backed on the config struct */

        char * restrict search;

        const char * restrict custom_list;

        /* actual settings */

        const char * restrict title;

        const char * restrict directory;

        const char * restrict css;

        const char * restrict iceserver;

        const cache_backend * restrict cache;

        void * restrict cache_setup;

        signed short dir_per_line;

        unsigned short cookie_life;

        short rss_items;

        unsigned short options;

        unsigned short options_not;

        unsigned short sets;

        unsigned char order[SB_MAX+1];

        unsigned char fields[SB_MAX+1];

};


/* i18n stuff */

#ifdef HAVE_GETTEXT

 #include <libintl.h>

 #define _(String)      gettext(String)

#else

 #define _(String)      String

#endif  /* HAVE_GETTEXT */


#define mi_rerror(format, ...) \

        ap_log_rerror(APLOG_MARK, APLOG_ERR, r, MI_LOG_PREFIX "(%s) " format, __func__, ## __VA_ARGS__)

#define mi_serror(format, ...) \

        ap_log_error(APLOG_MARK, APLOG_ERR, s, MI_LOG_PREFIX "(%s) " format, __func__, ## __VA_ARGS__)


/* this could arguably use APLOG_DEBUG but in most configurations this is never logged. Use it later ;-) */

#ifdef DEBUG

 #define mi_rdebug(format, ...) \

        ap_log_rerror(APLOG_MARK, APLOG_NOTICE, r, MI_LOG_PREFIX "(%s) " format, __func__, ## __VA_ARGS__)

#else

 #define mi_rdebug(format, ...) /* nothing */

#endif


extern module MODULE_VAR_EXPORT musicindex_module;


#endif  /* MOD_MUSICINDEX_H */