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 #include <systools/win32/uwinapi.h>
  21
  22 #include <osl/file.h>
  23 #include <o3tl/char16_t2wchar_t.hxx>
  24 #include <rtl/ustring.hxx>
  25
  26 #include "file-impl.hxx"
  27 #include "file_error.hxx"
  28 #include "file_url.hxx"
  29 #include "path_helper.hxx"
  30
  31 #include <malloc.h>
  32 #include <cassert>
  33
  34 // Allocate n number of t's on the stack return a pointer to it in p
  35 #define STACK_ALLOC(p, t, n) __try {(p) = static_cast<t*>(_alloca((n)*sizeof(t)));} \
  36                              __except(EXCEPTION_EXECUTE_HANDLER) {(p) = nullptr;}
  37
  38 // Temp file functions
  39
  40 static oslFileError osl_setup_base_directory_impl_(
  41     rtl_uString*  pustrDirectoryURL,
  42     rtl_uString** ppustr_base_dir)
  43 {
  44     OUString dir_url;
  45     OUString dir;
  46     oslFileError error   = osl_File_E_None;
  47
  48     if (pustrDirectoryURL)
  49         dir_url = pustrDirectoryURL;
  50     else
  51         error = osl_getTempDirURL(&dir_url.pData);
  52
  53     if (error == osl_File_E_None)
  54         error = osl_getSystemPathFromFileURL_(dir_url, &dir.pData, false);
  55
  56     if (error == osl_File_E_None)
  57         rtl_uString_assign(ppustr_base_dir, dir.pData);
  58
  59     return error;
  60 }
  61
  62 static oslFileError osl_setup_createTempFile_impl_(
  63     rtl_uString*   pustrDirectoryURL,
  64     oslFileHandle* pHandle,
  65     rtl_uString**  ppustrTempFileURL,
  66     rtl_uString**  ppustr_base_dir,
  67     sal_Bool*      b_delete_on_close)
  68 {
  69     oslFileError osl_error;
  70
  71     OSL_PRECOND(((pHandle != nullptr) || (ppustrTempFileURL != nullptr)), "Invalid parameter!");
  72
  73     if ((pHandle == nullptr) && (ppustrTempFileURL == nullptr))
  74     {
  75         osl_error = osl_File_E_INVAL;
  76     }
  77     else
  78     {
  79         osl_error = osl_setup_base_directory_impl_(
  80             pustrDirectoryURL, ppustr_base_dir);
  81
  82         *b_delete_on_close = (ppustrTempFileURL == nullptr);
  83     }
  84
  85     return osl_error;
  86 }
  87
  88 static oslFileError osl_win32_GetTempFileName_impl_(
  89     rtl_uString* base_directory, LPWSTR temp_file_name)
  90 {
  91     oslFileError osl_error = osl_File_E_None;
  92
  93     if (GetTempFileNameW(
  94             o3tl::toW(rtl_uString_getStr(base_directory)),
  95             L"",
  96             0,
  97             temp_file_name) == 0)
  98     {
  99         osl_error = oslTranslateFileError(GetLastError());
 100     }
 101
 102     return osl_error;
 103 }
 104
 105 static bool osl_win32_CreateFile_impl_(
 106     LPCWSTR file_name, bool b_delete_on_close, oslFileHandle* p_handle)
 107 {
 108     DWORD  flags = FILE_ATTRIBUTE_NORMAL;
 109     HANDLE hFile;
 110
 111     assert(p_handle);
 112
 113     if (b_delete_on_close)
 114         flags |= FILE_FLAG_DELETE_ON_CLOSE;
 115
 116     hFile = CreateFileW(
 117         file_name,
 118         GENERIC_READ | GENERIC_WRITE,
 119         0,
 120         nullptr,
 121         TRUNCATE_EXISTING,
 122         flags,
 123         nullptr);
 124
 125     // @@@ ERROR HANDLING @@@
 126     if (IsValidHandle(hFile))
 127         *p_handle = osl_createFileHandleFromOSHandle(hFile, osl_File_OpenFlag_Read | osl_File_OpenFlag_Write);
 128
 129     return IsValidHandle(hFile);
 130 }
 131
 132 static oslFileError osl_createTempFile_impl_(
 133     rtl_uString*   base_directory,
 134     LPWSTR         tmp_name,
 135     bool           b_delete_on_close,
 136     oslFileHandle* pHandle,
 137     rtl_uString**  ppustrTempFileURL)
 138 {
 139     oslFileError osl_error;
 140
 141     do
 142     {
 143         osl_error = osl_win32_GetTempFileName_impl_(base_directory, tmp_name);
 144
 145         /*  if file could not be opened try again */
 146
 147         if ((osl_File_E_None != osl_error) || (nullptr == pHandle) ||
 148             osl_win32_CreateFile_impl_(tmp_name, b_delete_on_close, pHandle))
 149             break;
 150
 151     } while(true); // try until success
 152
 153     if ((osl_error == osl_File_E_None) && !b_delete_on_close)
 154     {
 155         rtl_uString* pustr = nullptr;
 156         rtl_uString_newFromStr(&pustr, o3tl::toU(tmp_name));
 157         osl_getFileURLFromSystemPath(pustr, ppustrTempFileURL);
 158         rtl_uString_release(pustr);
 159     }
 160
 161     return osl_error;
 162 }
 163
 164 oslFileError SAL_CALL osl_createTempFile(
 165     rtl_uString*   pustrDirectoryURL,
 166     oslFileHandle* pHandle,
 167     rtl_uString**  ppustrTempFileURL)
 168 {
 169     rtl_uString*    base_directory = nullptr;
 170     LPWSTR          tmp_name;
 171     sal_Bool        b_delete_on_close;
 172     oslFileError    osl_error;
 173
 174     osl_error = osl_setup_createTempFile_impl_(
 175         pustrDirectoryURL,
 176         pHandle,
 177         ppustrTempFileURL,
 178         &base_directory,
 179         &b_delete_on_close);
 180
 181     if (osl_error != osl_File_E_None)
 182         return osl_error;
 183
 184     /* allocate enough space on the stack, the file name can not be longer than MAX_PATH */
 185     STACK_ALLOC(tmp_name, WCHAR, (rtl_uString_getLength(base_directory) + MAX_PATH));
 186
 187     if (tmp_name)
 188     {
 189         osl_error = osl_createTempFile_impl_(
 190             base_directory,
 191             tmp_name,
 192             b_delete_on_close,
 193             pHandle,
 194             ppustrTempFileURL);
 195     }
 196     else // stack alloc failed
 197     {
 198         osl_error = osl_File_E_NOMEM;
 199     }
 200
 201     if (base_directory)
 202         rtl_uString_release(base_directory);
 203
 204     return osl_error;
 205 }
 206
 207 oslFileError SAL_CALL osl_getTempDirURL(rtl_uString** pustrTempDir)
 208 {
 209     ::osl::LongPathBuffer< sal_Unicode > aBuffer( MAX_LONG_PATH );
 210     LPWSTR  lpBuffer = o3tl::toW(aBuffer);
 211     DWORD   nBufferLength = aBuffer.getBufSizeInSymbols() - 1;
 212
 213     DWORD           nLength;
 214     oslFileError    error;
 215
 216     nLength = GetTempPathW( aBuffer.getBufSizeInSymbols(), lpBuffer );
 217
 218     if ( nLength > nBufferLength )
 219     {
 220         // the provided path has invalid length
 221         error = osl_File_E_NOENT;
 222     }
 223     else if ( nLength )
 224     {
 225         if ( '\\' == lpBuffer[nLength-1] )
 226             --nLength;
 227
 228         const OUString ustrTempPath(o3tl::toU(lpBuffer), static_cast<sal_Int32>(nLength));
 229
 230         error = osl_getFileURLFromSystemPath(ustrTempPath.pData, pustrTempDir);
 231     }
 232     else
 233         error = oslTranslateFileError( GetLastError() );
 234
 235     return error;
 236 }
 237
 238 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */