From 123c8bc8b3d621d0e259ae9ce99ebe753036ac0b Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Tue, 30 Jun 2015 21:10:13 +0100 Subject: split out windows file operations into a separeate module --- windows/Makefile.target | 2 +- windows/file.c | 301 ++++++++++++++++++++++++++++++++++++++++++++++++ windows/file.h | 29 +++++ windows/gui.c | 262 ----------------------------------------- windows/gui.h | 1 - windows/main.c | 1 + windows/windbg.h | 2 +- 7 files changed, 333 insertions(+), 265 deletions(-) create mode 100644 windows/file.c create mode 100644 windows/file.h (limited to 'windows') diff --git a/windows/Makefile.target b/windows/Makefile.target index 5773a0c36..6b8ce6a8c 100644 --- a/windows/Makefile.target +++ b/windows/Makefile.target @@ -58,7 +58,7 @@ S_RESOURCES := windows_resource.o # S_WINDOWS are sources purely for the windows build S_WINDOWS := main.c window.c gui.c drawable.c misc.c plot.c findfile.c \ - font.c bitmap.c about.c prefs.c download.c filetype.c \ + font.c bitmap.c about.c prefs.c download.c filetype.c file.c \ localhistory.c schedule.c windbg.c pointers.c S_WINDOWS := $(addprefix windows/,$(S_WINDOWS)) diff --git a/windows/file.c b/windows/file.c new file mode 100644 index 000000000..f8372b453 --- /dev/null +++ b/windows/file.c @@ -0,0 +1,301 @@ +/* + * Copyright 2014, 2015 Vincent Sanders + * + * This file is part of NetSurf, http://www.netsurf-browser.org/ + * + * NetSurf 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; version 2 of the License. + * + * NetSurf 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 . + */ + +/** + * \file + * Windows file operation table implementation. + */ + +#include +#include +#include +#include +#include + +#include "utils/errors.h" +#include "utils/nsurl.h" +#include "utils/log.h" +#include "utils/utils.h" +#include "utils/corestrings.h" +#include "utils/url.h" +#include "utils/file.h" +#include "desktop/browser.h" + +#include "windows/file.h" + +/** + * Generate a windows path from one or more component elemnts. + * + * If a string is allocated it must be freed by the caller. + * + * @param[in,out] str pointer to string pointer if this is NULL enough + * storage will be allocated for the complete path. + * @param[in,out] size The size of the space available if \a str not + * NULL on input and if not NULL set to the total + * output length on output. + * @param[in] nelm The number of elements. + * @param[in] ap The elements of the path as string pointers. + * @return NSERROR_OK and the complete path is written to str + * or error code on faliure. + */ +static nserror windows_mkpath(char **str, size_t *size, size_t nelm, va_list ap) +{ + return vsnstrjoin(str, size, '\\', nelm, ap); +} + + +/** + * Get the basename of a file using windows path handling. + * + * This gets the last element of a path and returns it. + * + * @param[in] path The path to extract the name from. + * @param[in,out] str Pointer to string pointer if this is NULL enough + * storage will be allocated for the path element. + * @param[in,out] size The size of the space available if \a + * str not NULL on input and set to the total + * output length on output. + * @return NSERROR_OK and the complete path is written to str + * or error code on faliure. + */ +static nserror windows_basename(const char *path, char **str, size_t *size) +{ + const char *leafname; + char *fname; + + if (path == NULL) { + return NSERROR_BAD_PARAMETER; + } + + leafname = strrchr(path, '\\'); + if (!leafname) { + leafname = path; + } else { + leafname += 1; + } + + fname = strdup(leafname); + if (fname == NULL) { + return NSERROR_NOMEM; + } + + *str = fname; + if (size != NULL) { + *size = strlen(fname); + } + return NSERROR_OK; +} + + +/** + * Create a path from a nsurl using windows file handling. + * + * @param[in] url The url to encode. + * @param[out] path_out A string containing the result path which should + * be freed by the caller. + * @return NSERROR_OK and the path is written to \a path or error code + * on faliure. + */ +static nserror windows_nsurl_to_path(struct nsurl *url, char **path_out) +{ + lwc_string *urlpath; + char *path; + bool match; + lwc_string *scheme; + nserror res; + + if ((url == NULL) || (path_out == NULL)) { + return NSERROR_BAD_PARAMETER; + } + + scheme = nsurl_get_component(url, NSURL_SCHEME); + + if (lwc_string_caseless_isequal(scheme, corestring_lwc_file, + &match) != lwc_error_ok) + { + return NSERROR_BAD_PARAMETER; + } + lwc_string_unref(scheme); + if (match == false) { + return NSERROR_BAD_PARAMETER; + } + + urlpath = nsurl_get_component(url, NSURL_PATH); + if (urlpath == NULL) { + return NSERROR_BAD_PARAMETER; + } + + res = url_unescape(lwc_string_data(urlpath), &path); + lwc_string_unref(urlpath); + if (res != NSERROR_OK) { + return res; + } + + /* if there is a drive: prefix treat path as DOS filename */ + if ((path[2] == ':') || (path[2] == '|')) { + char *sidx; /* slash index */ + + /* move the string down to remove leading / note the + * strlen is *not* copying too much data as we are + * moving the null too! + */ + memmove(path, path + 1, strlen(path)); + + /* swap / for \ */ + sidx = strrchr(path, '/'); + while (sidx != NULL) { + *sidx = '\\'; + sidx = strrchr(path, '/'); + } + } + /* if the path does not have a drive letter we return the + * complete path. + */ + /** @todo Need to check returning the unaltered path in this + * case is correct + */ + + *path_out = path; + + return NSERROR_OK; +} + + +/** + * Create a nsurl from a path using windows file handling. + * + * Perform the necessary operations on a path to generate a nsurl. + * + * @param[in] path The path to convert. + * @param[out] url_out pointer to recive the nsurl, The returned url + * should be unreferenced by the caller. + * @return NSERROR_OK and the url is placed in \a url or error code on + * faliure. + */ +static nserror windows_path_to_nsurl(const char *path, struct nsurl **url_out) +{ + nserror ret; + int urllen; + char *urlstr; + char *sidx; /* slash index */ + + if ((path == NULL) || (url_out == NULL) || (*path == 0)) { + return NSERROR_BAD_PARAMETER; + } + + /* build url as a string for nsurl constructor */ + urllen = strlen(path) + FILE_SCHEME_PREFIX_LEN + 5; + urlstr = malloc(urllen); + if (urlstr == NULL) { + return NSERROR_NOMEM; + } + + /** @todo check if this should be url escaping the path. */ + if (*path == '/') { + /* unix style path start, so try wine Z: */ + snprintf(urlstr, urllen, "%sZ%%3A%s", FILE_SCHEME_PREFIX, path); + } else { + snprintf(urlstr, urllen, "%s%s", FILE_SCHEME_PREFIX, path); + } + + sidx = strrchr(urlstr, '\\'); + while (sidx != NULL) { + *sidx = '/'; + sidx = strrchr(urlstr, '\\'); + } + + ret = nsurl_create(urlstr, url_out); + free(urlstr); + + return ret; +} + + +/** + * Ensure that all directory elements needed to store a filename exist. + * + * @param fname The filename to ensure the path to exists. + * @return NSERROR_OK on success or error code on failure. + */ +static nserror windows_mkdir_all(const char *fname) +{ + char *dname; + char *sep; + struct stat sb; + + dname = strdup(fname); + + sep = strrchr(dname, '\\'); + if (sep == NULL) { + /* no directory separator path is just filename so its ok */ + free(dname); + return NSERROR_OK; + } + + *sep = 0; /* null terminate directory path */ + + if (stat(dname, &sb) == 0) { + free(dname); + if (S_ISDIR(sb.st_mode)) { + /* path to file exists and is a directory */ + return NSERROR_OK; + } + return NSERROR_NOT_DIRECTORY; + } + *sep = '\\'; /* restore separator */ + + sep = dname; + while (*sep == '\\') { + sep++; + } + while ((sep = strchr(sep, '\\')) != NULL) { + *sep = 0; + if (stat(dname, &sb) != 0) { + if (nsmkdir(dname, S_IRWXU) != 0) { + /* could not create path element */ + free(dname); + return NSERROR_NOT_FOUND; + } + } else { + if (! S_ISDIR(sb.st_mode)) { + /* path element not a directory */ + free(dname); + return NSERROR_NOT_DIRECTORY; + } + } + *sep = '\\'; /* restore separator */ + /* skip directory separators */ + while (*sep == '\\') { + sep++; + } + } + + free(dname); + return NSERROR_OK; +} + +/* windows file handling */ +static struct gui_file_table file_table = { + .mkpath = windows_mkpath, + .basename = windows_basename, + .nsurl_to_path = windows_nsurl_to_path, + .path_to_nsurl = windows_path_to_nsurl, + .mkdir_all = windows_mkdir_all, +}; + +struct gui_file_table *win32_file_table = &file_table; diff --git a/windows/file.h b/windows/file.h new file mode 100644 index 000000000..5262dde2c --- /dev/null +++ b/windows/file.h @@ -0,0 +1,29 @@ +/* + * Copyright 2015 Vincent Sanders + * + * This file is part of NetSurf, http://www.netsurf-browser.org/ + * + * NetSurf 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; version 2 of the License. + * + * NetSurf 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 . + */ + +/** + * \file + * Windows file operation table interface. + */ + +#ifndef _NETSURF_WINDOWS_FILE_H_ +#define _NETSURF_WINDOWS_FILE_H_ + +struct gui_file_table *win32_file_table; + +#endif diff --git a/windows/gui.c b/windows/gui.c index 431e5c9bb..f9aca5a9c 100644 --- a/windows/gui.c +++ b/windows/gui.c @@ -149,268 +149,6 @@ static void gui_set_clipboard(const char *buffer, size_t length, } -/** - * Generate a windows path from one or more component elemnts. - * - * If a string is allocated it must be freed by the caller. - * - * @param[in,out] str pointer to string pointer if this is NULL enough - * storage will be allocated for the complete path. - * @param[in,out] size The size of the space available if \a str not - * NULL on input and if not NULL set to the total - * output length on output. - * @param[in] nelm The number of elements. - * @param[in] ap The elements of the path as string pointers. - * @return NSERROR_OK and the complete path is written to str - * or error code on faliure. - */ -static nserror windows_mkpath(char **str, size_t *size, size_t nelm, va_list ap) -{ - return vsnstrjoin(str, size, '\\', nelm, ap); -} - - -/** - * Get the basename of a file using windows path handling. - * - * This gets the last element of a path and returns it. - * - * @param[in] path The path to extract the name from. - * @param[in,out] str Pointer to string pointer if this is NULL enough - * storage will be allocated for the path element. - * @param[in,out] size The size of the space available if \a - * str not NULL on input and set to the total - * output length on output. - * @return NSERROR_OK and the complete path is written to str - * or error code on faliure. - */ -static nserror windows_basename(const char *path, char **str, size_t *size) -{ - const char *leafname; - char *fname; - - if (path == NULL) { - return NSERROR_BAD_PARAMETER; - } - - leafname = strrchr(path, '\\'); - if (!leafname) { - leafname = path; - } else { - leafname += 1; - } - - fname = strdup(leafname); - if (fname == NULL) { - return NSERROR_NOMEM; - } - - *str = fname; - if (size != NULL) { - *size = strlen(fname); - } - return NSERROR_OK; -} - - -/** - * Create a path from a nsurl using windows file handling. - * - * @param[in] url The url to encode. - * @param[out] path_out A string containing the result path which should - * be freed by the caller. - * @return NSERROR_OK and the path is written to \a path or error code - * on faliure. - */ -static nserror windows_nsurl_to_path(struct nsurl *url, char **path_out) -{ - lwc_string *urlpath; - char *path; - bool match; - lwc_string *scheme; - nserror res; - - if ((url == NULL) || (path_out == NULL)) { - return NSERROR_BAD_PARAMETER; - } - - scheme = nsurl_get_component(url, NSURL_SCHEME); - - if (lwc_string_caseless_isequal(scheme, corestring_lwc_file, - &match) != lwc_error_ok) - { - return NSERROR_BAD_PARAMETER; - } - lwc_string_unref(scheme); - if (match == false) { - return NSERROR_BAD_PARAMETER; - } - - urlpath = nsurl_get_component(url, NSURL_PATH); - if (urlpath == NULL) { - return NSERROR_BAD_PARAMETER; - } - - res = url_unescape(lwc_string_data(urlpath), &path); - lwc_string_unref(urlpath); - if (res != NSERROR_OK) { - return res; - } - - /* if there is a drive: prefix treat path as DOS filename */ - if ((path[2] == ':') || (path[2] == '|')) { - char *sidx; /* slash index */ - - /* move the string down to remove leading / note the - * strlen is *not* copying too much data as we are - * moving the null too! - */ - memmove(path, path + 1, strlen(path)); - - /* swap / for \ */ - sidx = strrchr(path, '/'); - while (sidx != NULL) { - *sidx = '\\'; - sidx = strrchr(path, '/'); - } - } - /* if the path does not have a drive letter we return the - * complete path. - */ - /** @todo Need to check returning the unaltered path in this - * case is correct - */ - - *path_out = path; - - return NSERROR_OK; -} - - -/** - * Create a nsurl from a path using windows file handling. - * - * Perform the necessary operations on a path to generate a nsurl. - * - * @param[in] path The path to convert. - * @param[out] url_out pointer to recive the nsurl, The returned url - * should be unreferenced by the caller. - * @return NSERROR_OK and the url is placed in \a url or error code on - * faliure. - */ -static nserror windows_path_to_nsurl(const char *path, struct nsurl **url_out) -{ - nserror ret; - int urllen; - char *urlstr; - char *sidx; /* slash index */ - - if ((path == NULL) || (url_out == NULL) || (*path == 0)) { - return NSERROR_BAD_PARAMETER; - } - - /* build url as a string for nsurl constructor */ - urllen = strlen(path) + FILE_SCHEME_PREFIX_LEN + 5; - urlstr = malloc(urllen); - if (urlstr == NULL) { - return NSERROR_NOMEM; - } - - /** @todo check if this should be url escaping the path. */ - if (*path == '/') { - /* unix style path start, so try wine Z: */ - snprintf(urlstr, urllen, "%sZ%%3A%s", FILE_SCHEME_PREFIX, path); - } else { - snprintf(urlstr, urllen, "%s%s", FILE_SCHEME_PREFIX, path); - } - - sidx = strrchr(urlstr, '\\'); - while (sidx != NULL) { - *sidx = '/'; - sidx = strrchr(urlstr, '\\'); - } - - ret = nsurl_create(urlstr, url_out); - free(urlstr); - - return ret; -} - - -/** - * Ensure that all directory elements needed to store a filename exist. - * - * @param fname The filename to ensure the path to exists. - * @return NSERROR_OK on success or error code on failure. - */ -static nserror windows_mkdir_all(const char *fname) -{ - char *dname; - char *sep; - struct stat sb; - - dname = strdup(fname); - - sep = strrchr(dname, '\\'); - if (sep == NULL) { - /* no directory separator path is just filename so its ok */ - free(dname); - return NSERROR_OK; - } - - *sep = 0; /* null terminate directory path */ - - if (stat(dname, &sb) == 0) { - free(dname); - if (S_ISDIR(sb.st_mode)) { - /* path to file exists and is a directory */ - return NSERROR_OK; - } - return NSERROR_NOT_DIRECTORY; - } - *sep = '\\'; /* restore separator */ - - sep = dname; - while (*sep == '\\') { - sep++; - } - while ((sep = strchr(sep, '\\')) != NULL) { - *sep = 0; - if (stat(dname, &sb) != 0) { - if (nsmkdir(dname, S_IRWXU) != 0) { - /* could not create path element */ - free(dname); - return NSERROR_NOT_FOUND; - } - } else { - if (! S_ISDIR(sb.st_mode)) { - /* path element not a directory */ - free(dname); - return NSERROR_NOT_DIRECTORY; - } - } - *sep = '\\'; /* restore separator */ - /* skip directory separators */ - while (*sep == '\\') { - sep++; - } - } - - free(dname); - return NSERROR_OK; -} - -/* windows file handling */ -static struct gui_file_table file_table = { - .mkpath = windows_mkpath, - .basename = windows_basename, - .nsurl_to_path = windows_nsurl_to_path, - .path_to_nsurl = windows_path_to_nsurl, - .mkdir_all = windows_mkdir_all, -}; - -struct gui_file_table *win32_file_table = &file_table; - static struct gui_clipboard_table clipboard_table = { .get = gui_get_clipboard, diff --git a/windows/gui.h b/windows/gui.h index 690cd9333..f72cb2cc2 100644 --- a/windows/gui.h +++ b/windows/gui.h @@ -21,7 +21,6 @@ #define _NETSURF_WINDOWS_GUI_H_ struct gui_window; -struct gui_file_table *win32_file_table; struct gui_clipboard_table *win32_clipboard_table; extern HINSTANCE hInstance; diff --git a/windows/main.c b/windows/main.c index b9ef44a3c..f4eec12e3 100644 --- a/windows/main.c +++ b/windows/main.c @@ -35,6 +35,7 @@ #include "desktop/netsurf.h" #include "windows/findfile.h" +#include "windows/file.h" #include "windows/drawable.h" #include "windows/download.h" #include "windows/localhistory.h" diff --git a/windows/windbg.h b/windows/windbg.h index bb23b2335..b2d8640f4 100644 --- a/windows/windbg.h +++ b/windows/windbg.h @@ -29,6 +29,6 @@ void win_perror(const char *lpszFunction); ((m) != WM_MOUSEMOVE) && \ ((m) != WM_NCHITTEST) && \ ((m) != WM_ENTERIDLE)) \ - LOG("%s, hwnd %p, w 0x%x, l 0x%x", msg_num_to_name(m), h, w, l); + LOG("%s, hwnd %p, w 0x%x, l 0x%Ix", msg_num_to_name(m), h, w, l); #endif -- cgit v1.2.3