client_common.c: Trivial cosmetic cleanups.

[paraslash.git] / client_common.c

diff --git a/client_common.c b/client_common.c
index c738079b6b1f92ab47435bfea9eb6185aa52eef2..78f9cb39af8f34c26f8f082da23bee076c9d26de 100644 (file)
--- a/client_common.c
+++ b/client_common.c
@@ -1,24 +1,16 @@
 /*
 /*

- * Copyright (C) 1997-2006 Andre Noll <maan@systemlinux.org>
+ * 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 "para.h"

+#include "error.h"

 #include "list.h"
 #include "sched.h"
 #include "client.cmdline.h"
 #include "list.h"
 #include "sched.h"
 #include "client.cmdline.h"


@@ -29,26 +21,44 @@
 #include "string.h"
 #include "client.cmdline.h"
 #include "client.h"
 #include "string.h"
 #include "client.cmdline.h"
 #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 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)
 {
        struct private_client_data *pcd = private_data;
        RC4(&pcd->rc4_send_key, len, indata, outdata);
 }
 
                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.
+ *
+ * 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)
 {
        struct private_client_data *pcd = private_data;
        RC4(&pcd->rc4_recv_key, len, indata, outdata);
 }
 
                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)
 {
 void client_close(struct private_client_data *pcd)
 {

-       if (pcd)
+       if (!pcd)

                return;
        if (pcd->fd >= 0) {
                disable_crypt(pcd->fd);
                return;
        if (pcd->fd >= 0) {
                disable_crypt(pcd->fd);


@@ -57,11 +67,52 @@ void client_close(struct private_client_data *pcd)
        free(pcd->user);
        free(pcd->config_file);
        free(pcd->key_file);
        free(pcd->user);
        free(pcd->config_file);
        free(pcd->key_file);

+       client_cmdline_parser_free(&pcd->conf);

        free(pcd);
 }
 
        free(pcd);
 }
 

-int client_parse_config(int argc, char *argv[],
-               struct private_client_data **pcd_ptr)
+/* connect to para_server and register the client task */
+static int client_connect(struct private_client_data *pcd)
+{
+       int ret;
+
+       pcd->fd = -1;
+       ret = makesock(AF_UNSPEC, IPPROTO_TCP, 0, pcd->conf.hostname_arg,
+               pcd->conf.server_port_arg);
+       if (ret < 0)
+               return ret;
+       pcd->fd = ret;
+       pcd->status = CL_CONNECTED;
+       ret = mark_fd_nonblocking(pcd->fd);
+       if (ret < 0)
+               goto err_out;
+       pcd->task.pre_select = client_pre_select;
+       pcd->task.post_select = client_post_select;
+       pcd->task.private_data = pcd;
+       sprintf(pcd->task.status, "client");
+       register_task(&pcd->task);
+       return 1;
+err_out:
+       close(pcd->fd);
+       pcd->fd = -1;
+       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 Standard.
+ */
+int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr)

 {
        char *home = para_homedir();
        struct stat statbuf;
 {
        char *home = para_homedir();
        struct stat statbuf;


@@ -69,9 +120,11 @@ int client_parse_config(int argc, char *argv[],
        struct private_client_data *pcd =
                para_calloc(sizeof(struct private_client_data));
 
        struct private_client_data *pcd =
                para_calloc(sizeof(struct private_client_data));
 

+       *pcd_ptr = pcd;

        pcd->fd = -1;
        pcd->fd = -1;

-       client_cmdline_parser(argc, argv, &pcd->conf);
-       ret = - E_CLIENT_SYNTAX;
+       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;
        pcd->user = pcd->conf.user_given?
        if (!pcd->conf.inputs_num)
                goto out;
        pcd->user = pcd->conf.user_given?


@@ -89,23 +142,47 @@ int client_parse_config(int argc, char *argv[],
                ret = -E_NO_CONFIG;
                goto out;
        }
                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;
        ret = 1;

-       *pcd_ptr = pcd;

        PARA_INFO_LOG("loglevel: %d\n", pcd->conf.loglevel_arg);
        PARA_INFO_LOG("config_file: %s\n", pcd->config_file);
        PARA_INFO_LOG("key_file: %s\n", pcd->key_file);
        PARA_NOTICE_LOG("connecting %s:%d\n", pcd->conf.hostname_arg,
                pcd->conf.server_port_arg);
        PARA_INFO_LOG("loglevel: %d\n", pcd->conf.loglevel_arg);
        PARA_INFO_LOG("config_file: %s\n", pcd->config_file);
        PARA_INFO_LOG("key_file: %s\n", pcd->key_file);
        PARA_NOTICE_LOG("connecting %s:%d\n", pcd->conf.hostname_arg,
                pcd->conf.server_port_arg);

+       ret = client_connect(pcd);

 out:
        free(home);
 out:
        free(home);

-       if (ret < 0)
+       if (ret < 0) {
+               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));

                client_close(pcd);
                client_close(pcd);

+               *pcd_ptr = NULL;
+       }

        return ret;
 }
 
        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;
 void client_pre_select(struct sched *s, struct task *t)
 {
        struct private_client_data *pcd = t->private_data;


@@ -143,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 {
                        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;
                        }
                                s->timeout.tv_sec = 0;
                                s->timeout.tv_usec = 1;
                        }


@@ -165,6 +242,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 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.
+ */

 void client_post_select(struct sched *s, struct task *t)
 {
        struct private_client_data *pcd = t->private_data;
 void client_post_select(struct sched *s, struct task *t)
 {
        struct private_client_data *pcd = t->private_data;


@@ -280,44 +370,10 @@ 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;
                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);
                return;
        }
                return;
        case CL_RECEIVING:
                t->ret = client_recv_buffer(pcd);
                return;
        }

-
-}
-
-int client_open(struct private_client_data *pcd)
-{
-       int ret;
-       struct hostent *he;
-       struct sockaddr_in their_addr;
-
-       ret = get_host_info(pcd->conf.hostname_arg, &he);
-       if (ret < 0)
-               goto out;
-       /* get new socket */
-       ret = get_socket();
-       if (ret < 0)
-               goto out;
-       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 out;
-       pcd->status = CL_CONNECTED;
-       ret = mark_fd_nonblock(pcd->fd);
-       if (ret < 0)
-               goto out;
-       pcd->task.pre_select = client_pre_select;
-       pcd->task.post_select = client_post_select;
-       pcd->task.private_data = pcd;
-       sprintf(pcd->task.status, "client");
-       register_task(&pcd->task);
-       ret = 1;
-out:
-       return ret;

 }
 }