Main Page | Data Structures | File List | Data Fields | Globals | Related Pages

html.h File Reference

#include "mod_musicindex.h"
#include <string.h>

Go to the source code of this file.

Defines

#define MAX_PREFIX   256
 Maximum expected size of the URL "prefix" (user@host stuff).


Functions

char treat_args (request_rec *r, mu_config *conf)
 Treats the URL arguments.

void send_url (request_rec *r, char *uri, char *command)
 Formats a complete url string to be sent to client.

void send_head (request_rec *r, mu_config *conf)
 Sends HTML page headers and top of the page.

void send_directories (request_rec *r, mu_ent *p, mu_config *conf)
void send_tracks (request_rec *r, mu_ent *p, mu_config *conf)
void send_playlist (request_rec *r, mu_ent *p, mu_config *conf)
 Sends playlist with url and EXTM3U info to the client.

void send_foot (request_rec *r, mu_config *conf)
 Sends HTML page footers.

void send_result (request_rec *r, mu_ent *p, mu_config *conf)


Define Documentation

#define MAX_PREFIX   256
 

Maximum expected size of the URL "prefix" (user@host stuff).

Definition at line 24 of file html.h.

Referenced by send_url().


Function Documentation

void send_directories request_rec *  r,
mu_ent p,
mu_config conf
 

Referenced by musicindex_directory().

void send_foot request_rec *  r,
mu_config conf
 

Sends HTML page footers.

This function takes care of the formating of the HTML page footers. It sends the data that is common to all pages generated by the handler. Currently it relies on apache_mp3 original stylesheets.

Parameters:
r Apache request_rec struct to handle connection details.
conf MusicIndex configuration paramaters struct.

Definition at line 744 of file html.c.

References MUSIC_AUTHORS_STRING, and MUSIC_VERSION_STRING.

Referenced by musicindex_directory().

void send_head request_rec *  r,
mu_config conf
 

Sends HTML page headers and top of the page.

This function takes care of the formating of the HTML page headers. It sends the data that is common to all pages generated by the handler.

Parameters:
r Apache request_rec struct to handle connection details.
conf MusicIndex configuration paramaters struct.

Definition at line 353 of file html.c.

References mu_config::arrow, mu_config::cd_icon, mu_config::css, MI_ALLOWSEARCH, MI_ALLOWSTREAM, mu_config::options, and mu_config::title.

Referenced by musicindex_directory().

void send_playlist request_rec *  r,
mu_ent p,
mu_config conf
 

Sends playlist with url and EXTM3U info to the client.

This function prepares an m3u playlist (with extra information where available: length, artist, title, album) and sends it to the client.

Bug:
Some browsers have trouble detecting the mime type. Try to send a ".m3u" file extension?
Parameters:
r Apache request_rec struct to handle connection details.
p struct mu_ent.
conf MusicIndex configuration paramaters struct.

Definition at line 712 of file html.c.

References mu_ent::album, mu_ent::artist, mu_ent::length, mu_ent::next, send_url(), mu_ent::title, and mu_ent::uri.

Referenced by playlist_directory(), and playlist_selected().

void send_result request_rec *  r,
mu_ent p,
mu_config conf
 

void send_tracks request_rec *  r,
mu_ent p,
mu_config conf
 

Referenced by musicindex_directory().

void send_url request_rec *  r,
char *  uri,
char *  command
 

Formats a complete url string to be sent to client.

This function does all the URL formatting, in the form: http://[user:][passwd@]hostname[:port]/uri/

Parameters:
r Apache request_rec struct to handle connection details.
uri A string (basically a path) to be sent to form a complete url.
command An eventual command (like ?action=playall).

Definition at line 302 of file html.c.

References MAX_PREFIX.

Referenced by send_playlist().

char treat_args request_rec *  r,
mu_config conf
 

Treats the URL arguments.

This function searches for keywords passed as URL arguments (with "?xxx") and sets the handler options accordingly.

Parameters:
r Apache request_rec struct to handle connection details.
conf MusicIndex configuration paramaters struct.
Returns:
The corresponding option letter.

Definition at line 222 of file html.c.

References ARG_NUMBER, mu_config::cache_path, MI_ALLOWSEARCH, MI_ALLOWSTREAM, MI_QUICKPL, MI_RECURSIVE, MI_SEARCH, mu_config::options, mu_config::order, mu_config::play_recursive, SB_DEFAULT, SB_RANDOM, SB_URI, mu_config::search, and set_fctptrs().

Referenced by handle_musicindex().


Generated on Thu Oct 30 13:50:29 2003 for mod_musicindex by doxygen 1.3.4