mod_musicindex  1.4.1
Functions | Variables
mod_musicindex.c File Reference

Core file. More...

#include "mod_musicindex.h"
#include "playlist.h"
#include "config.h"
#include "html.h"
#include "http.h"
#include "sort.h"
#include <http_core.h>
#include <http_main.h>

Go to the source code of this file.

Functions

static int is_msie_user_agent (request_rec *r)
 Check whether we're serving MS IE.
static int handle_musicindex (request_rec *r)
 This is where the magic happens.
static int handle_musicfile (request_rec *r)
 Handler for requests on music files.
static void musicindex_init (server_rec *s, apr_pool_t *p)
 Adds the mod signature into Apache's headers.

Variables

static const handler_rec musicindex_handlers []
module MODULE_VAR_EXPORT musicindex_module

Detailed Description

Core file.

This file is the core of the module. It contains Apache's mandatory stuff.

Author
Regis Boudin
Version
Revision:
1012
Date
2002-2008
2010-2012

http://httpd.apache.org/docs-2.0/developer/API.html http://httpd.apache.org/dev/apidoc/ http://www.apachetutor.org/dev/pools

Warning
Use it at your own risks!
sub requests are EXTREMELY cpu expensive
Todo:

Complete code documentation.

(low pri whishlist) On the fly tag rewriting or metadata support.

prepare the possibility to generate ices/mpd playlists.

enforce strict type policy.

get rid of str*cmp() whenever possible.

review the randomdir implementation.

Todo:
Check how much overhead a DAAP implementation would bring. The protocol works on top of HTTP (where we are) and could make use of the cache.
Todo:
Audit the code: in many places we are using a lot of arguments passed to functions that could easily be gotten otherwise by dereferencing a few pointers. Passing too many args increases stack usage.
Todo:
Decide how long we want to support Apache 1.3. APR provides lots of useful features, and the API compatibility between 1.3 and 2.2 is not certain.
Todo:
Check whether it'd make sense to abstract Apache's primitives so as to make the module portable to other webservers.

Definition in file mod_musicindex.c.

Function Documentation

static int handle_musicfile ( request_rec *  r)
static

Handler for requests on music files.

At the moment it can only forbid acces to files if neither streaming nor download is allowed.

Parameters
rApache request_rec to get and send data
Returns
Standard HTTP code (see httpd.h for more infos)

Definition at line 419 of file mod_musicindex.c.

References ap_set_content_type, apr_psprintf, apr_table_setn, mu_config::cache, cache_backend::epilogue, mu_pack::fhead, mu_pack::head, mu_config::iceserver, mu_ent::length, make_music_entry(), MI_ACTIVE, MI_ALLOWDWNLD, MI_ALLOWSTREAM, musicindex_module, mu_config::options, cache_backend::prologue, and send_playlist().

static int handle_musicindex ( request_rec *  r)
static

This is where the magic happens.

Definition at line 227 of file mod_musicindex.c.

References ap_set_content_type, apr_psprintf, apr_pstrcat, apr_table_set, apr_table_setn, build_custom_list(), mu_config::cache, cookie_and_stream_work(), mu_config::custom_list, mu_config::dir_per_line, cache_backend::epilogue, mu_pack::head, is_msie_user_agent(), listsort(), make_music_entry(), MI_ACTIVE, MI_COOKIEDWNLD, MI_COOKIESTREAM, MI_DWNLDCOOKIE, MI_DWNLDLST, MI_DWNLDRQ, MI_RANDOMDIR, MI_RECURSIVE, mi_rerror, MI_RSS, MI_STREAM, MI_STREAMCOOKIE, MI_STREAMLST, MI_STREAMRQ, MI_TARBALL, musicindex_module, mu_config::options, mu_config::order, cache_backend::prologue, mu_config::search, send_customlist(), send_directories(), send_foot(), send_head(), send_playlist(), send_randomdir(), send_rss(), send_tarball(), send_tracks(), STRUCTTV, tarball_size(), treat_get_args(), and treat_post_args().

static int is_msie_user_agent ( request_rec *  r)
static

Check whether we're serving MS IE.

Parameters
rApache request_rec
Returns
1 if client is MSIE, 0 otherwise

Definition at line 216 of file mod_musicindex.c.

References apr_table_get.

Referenced by handle_musicindex().

static void musicindex_init ( server_rec *  s,
apr_pool_t *  p 
)
static

Adds the mod signature into Apache's headers.

Parameters
sserver_rec
ppool

Definition at line 515 of file mod_musicindex.c.

References MUSIC_HEADER_STRING.

Variable Documentation

const handler_rec musicindex_handlers[]
static
Initial value:
{
{DIR_MAGIC_TYPE, handle_musicindex},
{"audio/mpeg", handle_musicfile},
{"audio/ogg", handle_musicfile},
{"audio/x-ogg", handle_musicfile},
{"application/ogg", handle_musicfile},
{"audio/flac", handle_musicfile},
{"audio/x-flac", handle_musicfile},
{"application/x-flac", handle_musicfile},
{"audio/mp4", handle_musicfile},
{NULL}
}

Definition at line 529 of file mod_musicindex.c.

module MODULE_VAR_EXPORT musicindex_module
Initial value:
{
STANDARD_MODULE_STUFF,
musicindex_init,
create_musicindex_config,
merge_musicindex_configs,
NULL,
NULL,
musicindex_cmds,
musicindex_handlers,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL
}

Definition at line 543 of file mod_musicindex.c.

Referenced by build_custom_list(), cache_file_opendir(), cache_file_write(), cookie_add(), cookie_addall(), cookie_and_stream_work(), cookie_remove(), file_make_cache_entry(), go_through_directory(), handle_musicfile(), handle_musicindex(), list_songs(), make_cache_entry(), make_flac_entry(), make_mp3_entry(), make_mp4_entry(), make_music_entry(), make_ogg_entry(), musicindex_closedir(), musicindex_opendir(), musicindex_readdir(), mysql_cache_dircontents(), mysql_cache_epilogue(), mysql_cache_make_entry(), mysql_cache_opendir(), mysql_cache_prologue(), mysql_cache_write(), send_directories(), send_foot(), send_head(), send_rss(), send_tracks(), send_url(), treat_get_args(), and treat_post_args().