sal/osl/w32/tempfile.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #define UNICODE
  21 #define _UNICODE
  22 #define _WIN32_WINNT 0x0500
  23 #include "systools/win32/uwinapi.h"
  24
  25 #include "osl/file.h"
  26
  27 #include "file_error.h"
  28 #include "file_url.h"
  29 #include "path_helper.hxx"
  30
  31 #include "osl/diagnose.h"
  32
  33 #include <malloc.h>
  34 #include <tchar.h>
  35
  36 //#####################################################
  37 // Allocate n number of t's on the stack return a pointer to it in p
  38 #ifdef __MINGW32__
  39 #define STACK_ALLOC(p, t, n) (p) = reinterpret_cast<t*>(_alloca((n)*sizeof(t)));
  40 #else
  41 #define STACK_ALLOC(p, t, n) __try {(p) = reinterpret_cast<t*>(_alloca((n)*sizeof(t)));} \
  42                              __except(EXCEPTION_EXECUTE_HANDLER) {(p) = 0;}
  43 #endif
  44
  45 extern "C" oslFileHandle SAL_CALL osl_createFileHandleFromOSHandle(HANDLE hFile, sal_uInt32 uFlags);
  46
  47 //#####################################################
  48 // Temp file functions
  49 //#####################################################
  50
  51 static oslFileError osl_setup_base_directory_impl_(
  52     rtl_uString*  pustrDirectoryURL,
  53     rtl_uString** ppustr_base_dir)
  54 {
  55     rtl_uString* dir_url = 0;
  56     rtl_uString* dir     = 0;
  57     oslFileError error   = osl_File_E_None;
  58
  59     if (pustrDirectoryURL)
  60         rtl_uString_assign(&dir_url, pustrDirectoryURL);
  61     else
  62         error = osl_getTempDirURL(&dir_url);
  63
  64     if (osl_File_E_None == error)
  65     {
  66         error = _osl_getSystemPathFromFileURL(dir_url, &dir, sal_False);
  67         rtl_uString_release(dir_url);
  68     }
  69
  70     if (osl_File_E_None == error )
  71     {
  72         rtl_uString_assign(ppustr_base_dir, dir);
  73         rtl_uString_release(dir);
  74     }
  75
  76     return error;
  77 }
  78
  79 //#####################################################
  80 static oslFileError osl_setup_createTempFile_impl_(
  81     rtl_uString*   pustrDirectoryURL,
  82     oslFileHandle* pHandle,
  83     rtl_uString**  ppustrTempFileURL,
  84     rtl_uString**  ppustr_base_dir,
  85     sal_Bool*      b_delete_on_close)
  86 {
  87     oslFileError osl_error;
  88
  89     OSL_PRECOND(((0 != pHandle) || (0 != ppustrTempFileURL)), "Invalid parameter!");
  90
  91     if ((0 == pHandle) && (0 == ppustrTempFileURL))
  92     {
  93         osl_error = osl_File_E_INVAL;
  94     }
  95     else
  96     {
  97         osl_error = osl_setup_base_directory_impl_(
  98             pustrDirectoryURL, ppustr_base_dir);
  99
 100         *b_delete_on_close = (sal_Bool)(0 == ppustrTempFileURL);
 101     }
 102
 103     return osl_error;
 104 }
 105
 106 //#####################################################
 107 static oslFileError osl_win32_GetTempFileName_impl_(
 108     rtl_uString* base_directory, LPWSTR temp_file_name)
 109 {
 110     oslFileError osl_error = osl_File_E_None;
 111
 112     if (0 == GetTempFileNameW(
 113             reinterpret_cast<LPCWSTR>(rtl_uString_getStr(base_directory)),
 114             L"",
 115             0,
 116             temp_file_name))
 117     {
 118         osl_error = oslTranslateFileError(GetLastError());
 119     }
 120
 121     return osl_error;
 122 }
 123
 124 //#####################################################
 125 static sal_Bool osl_win32_CreateFile_impl_(
 126     LPCWSTR file_name, sal_Bool b_delete_on_close, oslFileHandle* p_handle)
 127 {
 128     DWORD  flags = FILE_ATTRIBUTE_NORMAL;
 129     HANDLE hFile;
 130
 131     OSL_ASSERT(p_handle);
 132
 133     if (b_delete_on_close)
 134         flags |= FILE_FLAG_DELETE_ON_CLOSE;
 135
 136     hFile = CreateFileW(
 137         file_name,
 138         GENERIC_READ | GENERIC_WRITE,
 139         0,
 140         NULL,
 141         TRUNCATE_EXISTING,
 142         flags,
 143         NULL);
 144
 145     // @@@ ERROR HANDLING @@@
 146     if (IsValidHandle(hFile))
 147         *p_handle = osl_createFileHandleFromOSHandle(hFile, osl_File_OpenFlag_Read | osl_File_OpenFlag_Write);
 148
 149     return (sal_Bool)IsValidHandle(hFile);
 150 }
 151
 152 //#############################################
 153 static oslFileError osl_createTempFile_impl_(
 154     rtl_uString*   base_directory,
 155     LPWSTR         tmp_name,
 156     sal_Bool       b_delete_on_close,
 157     oslFileHandle* pHandle,
 158     rtl_uString**  ppustrTempFileURL)
 159 {
 160     oslFileError osl_error;
 161
 162     do
 163     {
 164         osl_error = osl_win32_GetTempFileName_impl_(base_directory, tmp_name);
 165
 166         /*  if file could not be opened try again */
 167
 168         if ((osl_File_E_None != osl_error) || (0 == pHandle) ||
 169             osl_win32_CreateFile_impl_(tmp_name, b_delete_on_close, pHandle))
 170             break;
 171
 172     } while(1); // try until success
 173
 174     if ((osl_File_E_None == osl_error) && !b_delete_on_close)
 175     {
 176         rtl_uString* pustr = 0;
 177         rtl_uString_newFromStr(&pustr, reinterpret_cast<const sal_Unicode*>(tmp_name));
 178         osl_getFileURLFromSystemPath(pustr, ppustrTempFileURL);
 179         rtl_uString_release(pustr);
 180     }
 181
 182     return osl_error;
 183 }
 184
 185 //#############################################
 186 oslFileError SAL_CALL osl_createTempFile(
 187     rtl_uString*   pustrDirectoryURL,
 188     oslFileHandle* pHandle,
 189     rtl_uString**  ppustrTempFileURL)
 190 {
 191     rtl_uString*    base_directory = 0;
 192     LPWSTR          tmp_name;
 193     sal_Bool        b_delete_on_close;
 194     oslFileError    osl_error;
 195
 196     osl_error = osl_setup_createTempFile_impl_(
 197         pustrDirectoryURL,
 198         pHandle,
 199         ppustrTempFileURL,
 200         &base_directory,
 201         &b_delete_on_close);
 202
 203     if (osl_File_E_None != osl_error)
 204         return osl_error;
 205
 206     /* allocate enough space on the stack, the file name can not be longer than MAX_PATH */
 207     STACK_ALLOC(tmp_name, WCHAR, (rtl_uString_getLength(base_directory) + MAX_PATH));
 208
 209     if (tmp_name)
 210     {
 211         osl_createTempFile_impl_(
 212             base_directory,
 213             tmp_name,
 214             b_delete_on_close,
 215             pHandle,
 216             ppustrTempFileURL);
 217     }
 218     else // stack alloc failed
 219     {
 220         osl_error = osl_File_E_NOMEM;
 221     }
 222
 223     if (base_directory)
 224         rtl_uString_release(base_directory);
 225
 226     return osl_error;
 227 }
 228
 229 //#############################################
 230 oslFileError SAL_CALL osl_getTempDirURL(rtl_uString** pustrTempDir)
 231 {
 232     ::osl::LongPathBuffer< sal_Unicode > aBuffer( MAX_LONG_PATH );
 233     LPWSTR  lpBuffer = ::osl::mingw_reinterpret_cast<LPWSTR>(aBuffer);
 234     DWORD   nBufferLength = aBuffer.getBufSizeInSymbols() - 1;
 235
 236     DWORD           nLength;
 237     oslFileError    error;
 238
 239     nLength = GetTempPathW( aBuffer.getBufSizeInSymbols(), lpBuffer );
 240
 241     if ( nLength > nBufferLength )
 242     {
 243         // the provided path has invalid length
 244         error = osl_File_E_NOENT;
 245     }
 246     else if ( nLength )
 247     {
 248         rtl_uString *ustrTempPath = NULL;
 249
 250         if ( '\\' == lpBuffer[nLength-1] )
 251             lpBuffer[nLength-1] = 0;
 252
 253         rtl_uString_newFromStr( &ustrTempPath, reinterpret_cast<const sal_Unicode*>(lpBuffer) );
 254
 255         error = osl_getFileURLFromSystemPath( ustrTempPath, pustrTempDir );
 256
 257         rtl_uString_release( ustrTempPath );
 258     }
 259     else
 260         error = oslTranslateFileError( GetLastError() );
 261
 262     return error;
 263 }
 264
 265 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */