1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-file-win.c windows related file implementation (internal to D-Bus implementation)
4 * Copyright (C) 2002, 2003, 2006 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "dbus-protocol.h"
27 #include "dbus-string.h"
28 #include "dbus-internals.h"
29 #include "dbus-sysdeps-win.h"
30 #include "dbus-pipe.h"
36 * Thin wrapper around the read() system call that appends
37 * the data it reads to the DBusString buffer. It appends
38 * up to the given count.
40 * @param hnd the HANDLE to read from
41 * @param buffer the buffer to append data to
42 * @param count the amount of data to read
43 * @param error place to set an error
44 * @returns the number of bytes read or -1
47 _dbus_file_read (HANDLE hnd,
57 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
59 _dbus_assert (count >= 0);
61 start = _dbus_string_get_length (buffer);
63 if (!_dbus_string_lengthen (buffer, count))
65 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
69 data = _dbus_string_get_data_len (buffer, start, count);
71 result = ReadFile (hnd, data, count, &bytes_read, NULL);
74 char *emsg = _dbus_win_error_string (GetLastError ());
75 dbus_set_error (error, _dbus_win_error_from_last_error (),
76 "Failed to read from %p: %s", hnd, emsg);
77 _dbus_win_free_error_string (emsg);
83 /* put length back (doesn't actually realloc) */
84 _dbus_string_set_length (buffer, start + bytes_read);
88 _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
97 * Appends the contents of the given file to the string,
98 * returning error code. At the moment, won't open a file
99 * more than a megabyte in size.
101 * @param str the string to append to
102 * @param filename filename to load
103 * @param error place to set an error
104 * @returns #FALSE if error was set
107 _dbus_file_get_contents (DBusString *str,
108 const DBusString *filename,
116 const char *filename_c;
118 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
120 filename_c = _dbus_string_get_const_data (filename);
122 hnd = CreateFileA (filename_c, GENERIC_READ,
123 FILE_SHARE_READ | FILE_SHARE_WRITE,
124 NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
125 if (hnd == INVALID_HANDLE_VALUE)
127 char *emsg = _dbus_win_error_string (GetLastError ());
128 dbus_set_error (error, _dbus_win_error_from_last_error (),
129 "Failed to open \"%s\": %s", filename_c, emsg);
130 _dbus_win_free_error_string (emsg);
134 _dbus_verbose ("file %s hnd %p opened\n", filename_c, hnd);
136 fsize = GetFileSize (hnd, &fsize_hi);
137 if (fsize == 0xFFFFFFFF && GetLastError() != NO_ERROR)
139 char *emsg = _dbus_win_error_string (GetLastError ());
140 dbus_set_error (error, _dbus_win_error_from_last_error (),
141 "Failed to get file size for \"%s\": %s",
143 _dbus_win_free_error_string (emsg);
145 _dbus_verbose ("GetFileSize() failed: %s", emsg);
152 if (fsize_hi != 0 || fsize > _DBUS_ONE_MEGABYTE)
154 dbus_set_error (error, DBUS_ERROR_FAILED,
155 "File size %lu/%lu of \"%s\" is too large.",
156 (unsigned long) fsize_hi,
157 (unsigned long) fsize, filename_c);
163 orig_len = _dbus_string_get_length (str);
168 while (total < fsize)
170 bytes_read = _dbus_file_read (hnd, str, fsize - total, error);
175 dbus_set_error (error, DBUS_ERROR_FAILED,
176 "Premature EOF reading \"%s\"",
180 _DBUS_ASSERT_ERROR_IS_SET (error);
183 _dbus_string_set_length (str, orig_len);
202 * Writes a string out to a file. If the file exists,
203 * it will be atomically overwritten by the new data.
205 * @param str the string to write out
206 * @param filename the file to save string to
207 * @param world_readable if true, ensure file is world readable
208 * @param error error to be filled in on failure
209 * @returns #FALSE on failure
212 _dbus_string_save_to_file (const DBusString *str,
213 const DBusString *filename,
214 dbus_bool_t world_readable,
219 const char *filename_c;
220 DBusString tmp_filename;
221 const char *tmp_filename_c;
224 dbus_bool_t need_unlink;
227 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
229 hnd = INVALID_HANDLE_VALUE;
233 if (!_dbus_string_init (&tmp_filename))
235 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
239 if (!_dbus_string_copy (filename, 0, &tmp_filename, 0))
241 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
242 _dbus_string_free (&tmp_filename);
246 if (!_dbus_string_append (&tmp_filename, "."))
248 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
249 _dbus_string_free (&tmp_filename);
253 #define N_TMP_FILENAME_RANDOM_BYTES 8
254 if (!_dbus_generate_random_ascii (&tmp_filename, N_TMP_FILENAME_RANDOM_BYTES,
257 _dbus_string_free (&tmp_filename);
261 filename_c = _dbus_string_get_const_data (filename);
262 tmp_filename_c = _dbus_string_get_const_data (&tmp_filename);
264 /* TODO - support world-readable in an atomic fashion */
265 hnd = CreateFileA (tmp_filename_c, GENERIC_WRITE,
266 FILE_SHARE_READ | FILE_SHARE_WRITE,
267 NULL, CREATE_NEW, FILE_ATTRIBUTE_NORMAL,
268 INVALID_HANDLE_VALUE);
269 if (hnd == INVALID_HANDLE_VALUE)
271 char *emsg = _dbus_win_error_string (GetLastError ());
272 dbus_set_error (error, _dbus_win_error_from_last_error (),
273 "Could not create \"%s\": %s", filename_c, emsg);
274 _dbus_win_free_error_string (emsg);
279 if (! _dbus_make_file_world_readable (&tmp_filename, error))
283 _dbus_verbose ("tmp file %s hnd %p opened\n", tmp_filename_c, hnd);
288 bytes_to_write = _dbus_string_get_length (str);
289 str_c = _dbus_string_get_const_data (str);
291 while (total < bytes_to_write)
296 res = WriteFile (hnd, str_c + total, bytes_to_write - total,
297 &bytes_written, NULL);
299 if (res == 0 || bytes_written <= 0)
301 char *emsg = _dbus_win_error_string (GetLastError ());
302 dbus_set_error (error, _dbus_win_error_from_last_error (),
303 "Could not write to %s: %s", tmp_filename_c, emsg);
304 _dbus_win_free_error_string (emsg);
308 total += bytes_written;
311 if (CloseHandle (hnd) == 0)
313 char *emsg = _dbus_win_error_string (GetLastError ());
314 dbus_set_error (error, _dbus_win_error_from_last_error (),
315 "Could not close file %s: %s", tmp_filename_c, emsg);
316 _dbus_win_free_error_string (emsg);
320 hnd = INVALID_HANDLE_VALUE;
322 /* Unlike rename(), MoveFileEx() can replace existing files */
323 if (!MoveFileExA (tmp_filename_c, filename_c, MOVEFILE_REPLACE_EXISTING))
325 char *emsg = _dbus_win_error_string (GetLastError ());
326 dbus_set_error (error, _dbus_win_error_from_last_error (),
327 "Could not rename %s to %s: %s",
328 tmp_filename_c, filename_c, emsg);
329 _dbus_win_free_error_string (emsg);
339 /* close first, then unlink */
341 if (hnd != INVALID_HANDLE_VALUE)
344 if (need_unlink && DeleteFileA (tmp_filename_c) == 0)
346 char *emsg = _dbus_win_error_string (GetLastError ());
347 _dbus_verbose ("Failed to unlink temp file %s: %s", tmp_filename_c,
349 _dbus_win_free_error_string (emsg);
352 _dbus_string_free (&tmp_filename);
355 _DBUS_ASSERT_ERROR_IS_SET (error);
361 /** Creates the given file, failing if the file already exists.
363 * @param filename the filename
364 * @param error error location
365 * @returns #TRUE if we created the file and it didn't exist
368 _dbus_create_file_exclusively (const DBusString *filename,
372 const char *filename_c;
374 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
376 filename_c = _dbus_string_get_const_data (filename);
378 hnd = CreateFileA (filename_c, GENERIC_WRITE,
379 FILE_SHARE_READ | FILE_SHARE_WRITE,
380 NULL, CREATE_NEW, FILE_ATTRIBUTE_NORMAL,
381 INVALID_HANDLE_VALUE);
382 if (hnd == INVALID_HANDLE_VALUE)
384 char *emsg = _dbus_win_error_string (GetLastError ());
385 dbus_set_error (error, _dbus_win_error_from_last_error (),
386 "Could not create file %s: %s",
388 _dbus_win_free_error_string (emsg);
392 _dbus_verbose ("exclusive file %s hnd %p opened\n", filename_c, hnd);
394 if (CloseHandle (hnd) == 0)
396 char *emsg = _dbus_win_error_string (GetLastError ());
397 dbus_set_error (error, _dbus_win_error_from_last_error (),
398 "Could not close file %s: %s",
400 _dbus_win_free_error_string (emsg);