X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=client_common.c;h=1b53f705423556040736a4e70dbd8fc7460a38f2;hp=12c8365661e6c8f7e0608c66cd7d65a659e219cb;hb=6ce1f648d6e34e49472ce938c83e5bf8e65cd429;hpb=1b46ae4193cddb7d589b0f2f7d8158b84f7e9f6d diff --git a/client_common.c b/client_common.c index 12c83656..1b53f705 100644 --- a/client_common.c +++ b/client_common.c @@ -1,19 +1,7 @@ /* * Copyright (C) 1997-2007 Andre Noll * - * 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 - * the Free Software Foundation; either version 2 of the License, or - * (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. - * - * 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, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file client_common.c common functions of para_client and para_audiod */ @@ -31,21 +19,45 @@ #include "client.h" #include "error.h" -void rc4_send(unsigned long len, const unsigned char *indata, +/* + * rc4 encrypt data before sending + * + * \param len the number of bytes to encrypt + * \param indata pointer to the input data of length \a len to be encrypted + * \param outdata pointer that holds the encrypted data after return + * \param private_data pointer to the private client data containing + * the rc4 key + * */ +static void rc4_send(unsigned long len, const unsigned char *indata, unsigned char *outdata, void *private_data) { struct private_client_data *pcd = private_data; RC4(&pcd->rc4_send_key, len, indata, outdata); } -void rc4_recv(unsigned long len, const unsigned char *indata, +/* + * rc4 decrypt received data + * + * \param len the number of bytes to decrypt + * \param indata pointer to the input data of length \a len + * \param outdata pointer that holds the decrypted data after return + * \param private_data pointer to the private client data containing + * the rc4 key + * */ +static void rc4_recv(unsigned long len, const unsigned char *indata, unsigned char *outdata, void *private_data) { struct private_client_data *pcd = private_data; RC4(&pcd->rc4_recv_key, len, indata, outdata); } - +/** + * close the connection to para_server and free all resources + * + * \param pcd pointer to the client data + * + * \sa client_open. + * */ void client_close(struct private_client_data *pcd) { if (!pcd) @@ -57,6 +69,7 @@ void client_close(struct private_client_data *pcd) free(pcd->user); free(pcd->config_file); free(pcd->key_file); + client_cmdline_parser_free(&pcd->conf); free(pcd); } @@ -96,6 +109,20 @@ err_out: return ret; } +/** + * open connection to para_server + * + * \param argc usual argument count + * \param argv usual argument vector + * \param pcd_ptr points to dynamically allocated and initialized private client data + * upon successful return + * + * Check the command line options given by \a argc and argv, set default values + * for user name and rsa key file, read further option from the config file. + * Finally, establish a connection to para_server. + * + * \return Positive on success, negative on errors. + */ int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr) { char *home = para_homedir(); @@ -107,6 +134,7 @@ int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr) *pcd_ptr = pcd; pcd->fd = -1; ret = client_cmdline_parser(argc, argv, &pcd->conf); + HANDLE_VERSION_FLAG("client", pcd->conf); ret = -E_CLIENT_SYNTAX; if (!pcd->conf.inputs_num) goto out; @@ -125,9 +153,16 @@ int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr) ret = -E_NO_CONFIG; goto out; } - if (!ret) - client_cmdline_parser_configfile(pcd->config_file, - &pcd->conf, 0, 0, 0); + if (!ret) { + struct client_cmdline_parser_params params = { + .override = 0, + .initialize = 0, + .check_required = 0, + .check_ambiguity = 0 + }; + client_cmdline_parser_config_file(pcd->config_file, + &pcd->conf, ¶ms); + } ret = 1; PARA_INFO_LOG("loglevel: %d\n", pcd->conf.loglevel_arg); PARA_INFO_LOG("config_file: %s\n", pcd->config_file); @@ -140,10 +175,25 @@ out: if (ret < 0) { PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret)); client_close(pcd); + *pcd_ptr = NULL; } return ret; } +/** + * the preselect hook for server commands + * + * \param s pointer to the scheduler + * \param t pointer to the task struct for this command + * + * The task pointer must contain a pointer to the initialized client data + * structure as it is returned by client_open(). + * + * This function checks the state of the connection and adds the file descriptor + * of the connection to the read or write fd set of \a s accordingly. + * + * \sa register_task() client_open(), struct sched, struct task + */ void client_pre_select(struct sched *s, struct task *t) { struct private_client_data *pcd = t->private_data; @@ -203,6 +253,19 @@ static ssize_t client_recv_buffer(struct private_client_data *pcd) } +/** + * the post select hook for client commands + * + * \param s pointer to the scheduler + * \param t pointer to the task struct for this command + * + * Depending on the current state of the connection and the status of the read + * and write fd sets of \a s, this function performs the neccessary steps to + * authenticate the connection, to send the commmand given by \a + * t->private_data and to receive para_server's output, if any. + * + * \sa struct sched, struct task + */ void client_post_select(struct sched *s, struct task *t) { struct private_client_data *pcd = t->private_data; @@ -324,5 +387,4 @@ void client_post_select(struct sched *s, struct task *t) t->ret = client_recv_buffer(pcd); return; } - }