client_common.c: Trivial cosmetic cleanups.
[paraslash.git] / client_common.c
index bf8a1a4..78f9cb3 100644 (file)
@@ -1,24 +1,16 @@
 /*
  * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
  *
- *     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 */
+/** \file client_common.c Common functions of para_client and para_audiod. */
+
+#include <sys/types.h>
+#include <dirent.h>
 
 #include "para.h"
+#include "error.h"
 #include "list.h"
 #include "sched.h"
 #include "client.cmdline.h"
 #include "string.h"
 #include "client.cmdline.h"
 #include "client.h"
-#include "error.h"
 
 /*
- * rc4 encrypt data before sending
+ * 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
- * */
+ * \param len The number of bytes to encrypt.
+ * \param indata Pointer to the input data of length \a len to be encrypted.
+ * \param outdata Result-pointer that holds the encrypted data.
+ * \param private_data Contains the rc4 key.
+ */
 static void rc4_send(unsigned long len, const unsigned char *indata,
                unsigned char *outdata, void *private_data)
 {
@@ -48,14 +38,10 @@ static void rc4_send(unsigned long len, const unsigned char *indata,
 }
 
 /*
- * rc4 decrypt received data
+ * 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
- * */
+ * Parameters are identical to those of rc4_send.
+ */
 static void rc4_recv(unsigned long len, const unsigned char *indata,
                unsigned char *outdata, void *private_data)
 {
@@ -64,12 +50,12 @@ static void rc4_recv(unsigned long len, const unsigned char *indata,
 }
 
 /**
- * close the connection to para_server and free all resources
+ * Close the connection to para_server and free all resources.
  *
- * \param pcd pointer to the client data
+ * \param pcd Pointer to the client data.
  *
  * \sa client_open.
- * */
+ */
 void client_close(struct private_client_data *pcd)
 {
        if (!pcd)
@@ -81,31 +67,23 @@ 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);
 }
 
+/* connect to para_server and register the client task */
 static int client_connect(struct private_client_data *pcd)
 {
        int ret;
-       struct hostent *he;
-       struct sockaddr_in their_addr;
 
        pcd->fd = -1;
-       ret = get_host_info(pcd->conf.hostname_arg, &he);
-       if (ret < 0)
-               return ret;
-       /* get new socket */
-       ret = get_socket();
+       ret = makesock(AF_UNSPEC, IPPROTO_TCP, 0, pcd->conf.hostname_arg,
+               pcd->conf.server_port_arg);
        if (ret < 0)
                return ret;
        pcd->fd = ret;
-       /* init their_addr */
-       init_sockaddr(&their_addr, pcd->conf.server_port_arg, he);
-       ret = para_connect(pcd->fd, &their_addr);
-       if (ret < 0)
-               goto err_out;
        pcd->status = CL_CONNECTED;
-       ret = mark_fd_nonblock(pcd->fd);
+       ret = mark_fd_nonblocking(pcd->fd);
        if (ret < 0)
                goto err_out;
        pcd->task.pre_select = client_pre_select;
@@ -121,18 +99,18 @@ err_out:
 }
 
 /**
- * open connection to para_server
+ * 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
+ * \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.
+ * \return Standard.
  */
 int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr)
 {
@@ -164,9 +142,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, &params);
+       }
        ret = 1;
        PARA_INFO_LOG("loglevel: %d\n", pcd->conf.loglevel_arg);
        PARA_INFO_LOG("config_file: %s\n", pcd->config_file);
@@ -185,10 +170,10 @@ out:
 }
 
 /**
- * the preselect hook for server commands
+ * The preselect hook for server commands.
  *
- * \param s pointer to the scheduler
- * \param t pointer to the task struct for this command
+ * \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().
@@ -196,7 +181,7 @@ out:
  * 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
+ * \sa register_task() client_open(), struct sched, struct task.
  */
 void client_pre_select(struct sched *s, struct task *t)
 {
@@ -235,8 +220,8 @@ void client_pre_select(struct sched *s, struct task *t)
                        para_fd_set(pcd->fd, &s->wfds, &s->max_fileno);
                        pcd->check_w = 1;
                } else {
-                       if (*pcd->in_eof) {
-                               t->ret = -E_INPUT_EOF;
+                       if (*pcd->in_error) {
+                               t->ret = *pcd->in_error;
                                s->timeout.tv_sec = 0;
                                s->timeout.tv_usec = 1;
                        }
@@ -258,17 +243,17 @@ static ssize_t client_recv_buffer(struct private_client_data *pcd)
 }
 
 /**
- * the post select hook for client commands
+ * The post select hook for client commands.
  *
- * \param s pointer to the scheduler
- * \param t pointer to the task struct for this command
+ * \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.
+ * and write fd sets of \a s, this function performs the necessary steps to
+ * authenticate the connection, to send the command given by \a t->private_data
+ * and to receive para_server's output, if any.
  *
- * \sa struct sched, struct task
+ * \sa struct sched, struct task.
  */
 void client_post_select(struct sched *s, struct task *t)
 {
@@ -385,7 +370,7 @@ void client_post_select(struct sched *s, struct task *t)
                t->ret = send_bin_buffer(pcd->fd, pcd->inbuf, *pcd->in_loaded);
                if (t->ret < 0)
                        return;
-               *pcd->in_loaded = 0; /* FIXME: short writes */
+               *pcd->in_loaded = 0;
                return;
        case CL_RECEIVING:
                t->ret = client_recv_buffer(pcd);