source: vendor/current/source3/libsmb/clierror.c

/* 
   Unix SMB/CIFS implementation.
   client error handling routines
   Copyright (C) Andrew Tridgell 1994-1998
   Copyright (C) Jelmer Vernooij 2003
   Copyright (C) Jeremy Allison 2006

   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 3 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, see <http://www.gnu.org/licenses/>.
*/

#include "includes.h"
#include "libsmb/libsmb.h"
#include "../libcli/smb/smbXcli_base.h"

/***************************************************************************
 Return an error message - either an NT error, SMB error or a RAP error.
 Note some of the NT errors are actually warnings or "informational" errors
 in which case they can be safely ignored.
****************************************************************************/

const char *cli_errstr(struct cli_state *cli)
{   
        fstring cli_error_message;
        char *result;

        if (!cli->initialised) {
                fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
                goto done;
        }

        /* Case #1: RAP error */
        if (cli->rap_error) {
                strlcpy(cli_error_message, win_errstr(W_ERROR(cli->rap_error)),
                        sizeof(cli_error_message));
                goto done;
        }

        if (!cli_state_is_connected(cli) && NT_STATUS_IS_OK(cli->raw_status)) {
                return nt_errstr(NT_STATUS_CONNECTION_DISCONNECTED);
        }

        return nt_errstr(cli->raw_status);
 done:
        result = talloc_strdup(talloc_tos(), cli_error_message);
        SMB_ASSERT(result);
        return result;
}


/****************************************************************************
 Return the 32-bit NT status code from the last packet.
****************************************************************************/

NTSTATUS cli_nt_error(struct cli_state *cli)
{
        /* Deal with socket errors first. */
        if (!cli_state_is_connected(cli)) {
                return NT_STATUS_CONNECTION_DISCONNECTED;
        }

        if (NT_STATUS_IS_DOS(cli->raw_status)) {
                int e_class = NT_STATUS_DOS_CLASS(cli->raw_status);
                int code = NT_STATUS_DOS_CODE(cli->raw_status);
                return dos_to_ntstatus(e_class, code);
        }

        return cli->raw_status;
}


/****************************************************************************
 Return the DOS error from the last packet - an error class and an error
 code.
****************************************************************************/

void cli_dos_error(struct cli_state *cli, uint8_t *eclass, uint32_t *ecode)
{
        if (!cli_state_is_connected(cli)) {
                *eclass = ERRDOS;
                *ecode = ERRnotconnected;
                return;
        }

        if (!NT_STATUS_IS_DOS(cli->raw_status)) {
                ntstatus_to_dos(cli->raw_status, eclass, ecode);
                return;
        }

        *eclass = NT_STATUS_DOS_CLASS(cli->raw_status);
        *ecode = NT_STATUS_DOS_CODE(cli->raw_status);
}


/* Return a UNIX errno appropriate for the error received in the last
   packet. */

int cli_errno(struct cli_state *cli)
{
        NTSTATUS status;

        if (cli_is_nt_error(cli)) {
                status = cli_nt_error(cli);
                return map_errno_from_nt_status(status);
        }

        if (cli_is_dos_error(cli)) {
                uint8_t eclass;
                uint32_t ecode;

                cli_dos_error(cli, &eclass, &ecode);
                status = dos_to_ntstatus(eclass, ecode);
                return map_errno_from_nt_status(status);
        }

        /*
         * Yuck!  A special case for this Vista error.  Since its high-order
         * byte isn't 0xc0, it doesn't match cli_is_nt_error() above.
         */
        status = cli_nt_error(cli);
        if (NT_STATUS_V(status) == NT_STATUS_V(NT_STATUS_INACCESSIBLE_SYSTEM_SHORTCUT)) {
            return EACCES;
        }

        /* for other cases */
        return EINVAL;
}

/* Return true if the last packet was in error */

bool cli_is_error(struct cli_state *cli)
{
        /* A socket error is always an error. */
        if (!cli_state_is_connected(cli)) {
                return true;
        }

        if (NT_STATUS_IS_DOS(cli->raw_status)) {
                /* Return error if error class in non-zero */
                uint8_t rcls = NT_STATUS_DOS_CLASS(cli->raw_status);
                return rcls != 0;
        }

        return NT_STATUS_IS_ERR(cli->raw_status);
}

/* Return true if the last error was an NT error */

bool cli_is_nt_error(struct cli_state *cli)
{
        /* A socket error is always an NT error. */
        if (!cli_state_is_connected(cli)) {
                return true;
        }

        return cli_is_error(cli) && !NT_STATUS_IS_DOS(cli->raw_status);
}

/* Return true if the last error was a DOS error */

bool cli_is_dos_error(struct cli_state *cli)
{
        /* A socket error is always a DOS error. */
        if (!cli_state_is_connected(cli)) {
                return true;
        }

        return cli_is_error(cli) && NT_STATUS_IS_DOS(cli->raw_status);
}

bool cli_state_is_connected(struct cli_state *cli)
{
        if (cli == NULL) {
                return false;
        }

        if (!cli->initialised) {
                return false;
        }

        return smbXcli_conn_is_connected(cli->conn);
}