2 * Copyright (C) 1997-2006 Andre Noll <maan@systemlinux.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
19 /** \file server.h common server data structures */
23 #include <openssl/pem.h>
25 /** size of the selector_info and audio_file info strings of struct misc_meta_data */
26 #define MMD_INFO_SIZE 16384
29 * permission flags that can be set individually for any server command
31 * - DB_READ: command reads from the database
32 * - DB_WRITE: command changes the contents of the database
33 * - AFS_READ: command reads information about the current audio stream
34 * - AFS_WRITE: command changes the current audio stream
36 enum {DB_READ = 1, DB_WRITE = 2, AFS_READ = 4, AFS_WRITE = 8};
39 * data needed to authenticate the user
42 /** the position of this user in the list of users */
43 struct list_head node;
46 /** the public RSA key */
48 /** the privileges that this user has */
53 * defines one command of para_server
55 struct server_command {
56 /** the name of the command */
58 /** pointer to the function that handles the command */
59 int (*handler)(int, int, char **);
60 /** the privileges a user must have to execute this command */
62 /** one-line description of the command */
63 const char *description;
64 /** summary of the command line options */
66 /** the long help text */
70 /** holds the arguments for the para_server's sender command */
71 struct sender_command_data{
72 /** greater than 0 indicates that a sender cmd is already queued */
74 /** the number of the sender in question */
76 /** used for the allow/deny/add/remove subcommands */
78 /** used for allow/deny */
80 /** the portnumber for add/remove */
85 * used for parent-child communication
87 * There's only one struct of this type which lives in shared memory
88 * for communication between the server instances. Access to this
89 * area is serialized via mmd_lock() and mmd_unlock(). There are two
90 * reasons for a variable to be included here:
92 * - At least one command (i.e. child of the server) must be able to
97 * - The contents are listed in the stat command and have to be up to
100 struct misc_meta_data{
101 /** the size of the current audio file in bytes */
102 long unsigned int size;
103 /** the full path of the current audio file */
104 char filename[_POSIX_PATH_MAX];
105 /** the last modification file of the current audio file */
107 /* the number of the current audio format */
109 /** the "old" status flags -- commands may only read them */
110 unsigned int afs_status_flags;
111 /** the new status flags -- commands may set them **/
112 unsigned int new_afs_status_flags;
113 /** the number of data chunks sent for the current audio file */
114 long unsigned chunks_sent;
115 /** the number of chunks this audio file contains */
116 long unsigned chunks_total;
117 /** set by the jmp/ff commands to the new position in chunks */
118 long unsigned repos_request;
119 /** the number of the chunk currently sent out*/
120 long unsigned current_chunk;
121 /** the milliseconds that have been skipped of the current audio file */
123 /** the length of the audio file in seconds */
125 /** the time para_server started to stream */
126 struct timeval stream_start;
127 /** a string that gets filled in by the audio format handler */
128 char audio_file_info[MMD_INFO_SIZE];
129 /** the event counter
131 * commands may increase this to force a status update to be sent to all
135 /** the number of audio files already sent */
136 unsigned int num_played;
137 /** the number of executed commands */
138 unsigned int num_commands;
139 /** the number of connections para_server received so far */
140 unsigned int num_connects;
141 /** the number of connections currently active */
142 unsigned int active_connections;
143 /** the process id of para_server */
145 /** a string that gets filled in by the current audio file selector */
146 char selector_info[MMD_INFO_SIZE];
147 /** the number if the current audio file selector */
149 /** commands set this to non-zero to change the current selector */
151 /** used by the sender command */
152 struct sender_command_data sender_cmd_data;
155 extern struct server_args_info conf;
157 int handle_connect(int fd, struct sockaddr_in *addr);
158 int _get_user(struct _user *user);
159 void mmd_unlock(void);