s3:libsmb: don't use the cli->inbuf to store the last error
[kai/samba.git] / source3 / libsmb / clierror.c
1 /* 
2    Unix SMB/CIFS implementation.
3    client error handling routines
4    Copyright (C) Andrew Tridgell 1994-1998
5    Copyright (C) Jelmer Vernooij 2003
6    Copyright (C) Jeremy Allison 2006
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23 #include "libsmb/libsmb.h"
24
25 /***************************************************************************
26  Return an error message - either an NT error, SMB error or a RAP error.
27  Note some of the NT errors are actually warnings or "informational" errors
28  in which case they can be safely ignored.
29 ****************************************************************************/
30
31 const char *cli_errstr(struct cli_state *cli)
32 {   
33         fstring cli_error_message;
34         char *result;
35
36         if (!cli->initialised) {
37                 fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
38                 goto done;
39         }
40
41         /* Case #1: RAP error */
42         if (cli->rap_error) {
43                 strlcpy(cli_error_message, win_errstr(W_ERROR(cli->rap_error)),
44                         sizeof(cli_error_message));
45                 goto done;
46         }
47
48         if (cli->fd == -1 && NT_STATUS_IS_OK(cli->raw_status)) {
49                 return nt_errstr(NT_STATUS_CONNECTION_DISCONNECTED);
50         }
51
52         return nt_errstr(cli->raw_status);
53  done:
54         result = talloc_strdup(talloc_tos(), cli_error_message);
55         SMB_ASSERT(result);
56         return result;
57 }
58
59
60 /****************************************************************************
61  Return the 32-bit NT status code from the last packet.
62 ****************************************************************************/
63
64 NTSTATUS cli_nt_error(struct cli_state *cli)
65 {
66         /* Deal with socket errors first. */
67         if (cli->fd == -1) {
68                 return NT_STATUS_CONNECTION_DISCONNECTED;
69         }
70
71         if (NT_STATUS_IS_DOS(cli->raw_status)) {
72                 int e_class = NT_STATUS_DOS_CLASS(cli->raw_status);
73                 int code = NT_STATUS_DOS_CODE(cli->raw_status);
74                 return dos_to_ntstatus(e_class, code);
75         }
76
77         return cli->raw_status;
78 }
79
80
81 /****************************************************************************
82  Return the DOS error from the last packet - an error class and an error
83  code.
84 ****************************************************************************/
85
86 void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
87 {
88         if(!cli->initialised) {
89                 return;
90         }
91
92         if (cli->fd == -1) {
93                 *eclass = ERRDOS;
94                 *ecode = ERRnotconnected;
95                 return;
96         }
97
98         if (!NT_STATUS_IS_DOS(cli->raw_status)) {
99                 ntstatus_to_dos(cli->raw_status, eclass, ecode);
100                 return;
101         }
102
103         *eclass = NT_STATUS_DOS_CLASS(cli->raw_status);
104         *ecode = NT_STATUS_DOS_CODE(cli->raw_status);
105 }
106
107
108 /* Return a UNIX errno appropriate for the error received in the last
109    packet. */
110
111 int cli_errno(struct cli_state *cli)
112 {
113         NTSTATUS status;
114
115         if (cli_is_nt_error(cli)) {
116                 status = cli_nt_error(cli);
117                 return map_errno_from_nt_status(status);
118         }
119
120         if (cli_is_dos_error(cli)) {
121                 uint8 eclass;
122                 uint32 ecode;
123
124                 cli_dos_error(cli, &eclass, &ecode);
125                 status = dos_to_ntstatus(eclass, ecode);
126                 return map_errno_from_nt_status(status);
127         }
128
129         /*
130          * Yuck!  A special case for this Vista error.  Since its high-order
131          * byte isn't 0xc0, it doesn't match cli_is_nt_error() above.
132          */
133         status = cli_nt_error(cli);
134         if (NT_STATUS_V(status) == NT_STATUS_V(NT_STATUS_INACCESSIBLE_SYSTEM_SHORTCUT)) {
135             return EACCES;
136         }
137
138         /* for other cases */
139         return EINVAL;
140 }
141
142 /* Return true if the last packet was in error */
143
144 bool cli_is_error(struct cli_state *cli)
145 {
146         /* A socket error is always an error. */
147         if (cli->fd == -1) {
148                 return True;
149         }
150
151         if (NT_STATUS_IS_DOS(cli->raw_status)) {
152                 /* Return error if error class in non-zero */
153                 uint8_t rcls = NT_STATUS_DOS_CLASS(cli->raw_status);
154                 return rcls != 0;
155         }
156
157         return NT_STATUS_IS_ERR(cli->raw_status);
158 }
159
160 /* Return true if the last error was an NT error */
161
162 bool cli_is_nt_error(struct cli_state *cli)
163 {
164         /* A socket error is always an NT error. */
165         if (cli->fd == -1) {
166                 return True;
167         }
168
169         return cli_is_error(cli) && !NT_STATUS_IS_DOS(cli->raw_status);
170 }
171
172 /* Return true if the last error was a DOS error */
173
174 bool cli_is_dos_error(struct cli_state *cli)
175 {
176         /* A socket error is always a DOS error. */
177         if (cli->fd == -1) {
178                 return True;
179         }
180
181         return cli_is_error(cli) && NT_STATUS_IS_DOS(cli->raw_status);
182 }
183
184 bool cli_state_is_connected(struct cli_state *cli)
185 {
186         if (cli == NULL) {
187                 return false;
188         }
189
190         if (!cli->initialised) {
191                 return false;
192         }
193
194         if (cli->fd == -1) {
195                 return false;
196         }
197
198         return true;
199 }
200