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 LPCWSTR getEyeCatcher()
  89 {
  90     static const OUString sEyeCatcher = []
  91     {
  92         OUString eyeCatcher = u"\0"_ustr;
  93 #ifdef DBG_UTIL
  94         if (const wchar_t* eye = _wgetenv(L"LO_TESTNAME"))
  95             eyeCatcher = OUString(o3tl::toU(eye), wcslen(eye) + 1); // including terminating nul
  96 #endif
  97         return eyeCatcher;
  98     }();
  99     return o3tl::toW(sEyeCatcher.getStr());
 100 }
 101
 102 static oslFileError osl_win32_GetTempFileName_impl_(
 103     rtl_uString* base_directory, LPWSTR temp_file_name)
 104 {
 105     oslFileError osl_error = osl_File_E_None;
 106
 107     if (GetTempFileNameW(
 108             o3tl::toW(rtl_uString_getStr(base_directory)),
 109             getEyeCatcher(),
 110             0,
 111             temp_file_name) == 0)
 112     {
 113         osl_error = oslTranslateFileError(GetLastError());
 114     }
 115
 116     return osl_error;
 117 }
 118
 119 static bool osl_win32_CreateFile_impl_(
 120     LPCWSTR file_name, bool b_delete_on_close, oslFileHandle* p_handle)
 121 {
 122     DWORD  flags = FILE_ATTRIBUTE_NORMAL;
 123     HANDLE hFile;
 124
 125     assert(p_handle);
 126
 127     if (b_delete_on_close)
 128         flags |= FILE_FLAG_DELETE_ON_CLOSE;
 129
 130     hFile = CreateFileW(
 131         file_name,
 132         GENERIC_READ | GENERIC_WRITE,
 133         0,
 134         nullptr,
 135         TRUNCATE_EXISTING,
 136         flags,
 137         nullptr);
 138
 139     // @@@ ERROR HANDLING @@@
 140     if (IsValidHandle(hFile))
 141         *p_handle = osl_createFileHandleFromOSHandle(hFile, osl_File_OpenFlag_Read | osl_File_OpenFlag_Write);
 142
 143     return IsValidHandle(hFile);
 144 }
 145
 146 static oslFileError osl_createTempFile_impl_(
 147     rtl_uString*   base_directory,
 148     LPWSTR         tmp_name,
 149     bool           b_delete_on_close,
 150     oslFileHandle* pHandle,
 151     rtl_uString**  ppustrTempFileURL)
 152 {
 153     oslFileError osl_error;
 154
 155     do
 156     {
 157         osl_error = osl_win32_GetTempFileName_impl_(base_directory, tmp_name);
 158
 159         /*  if file could not be opened try again */
 160
 161         if ((osl_File_E_None != osl_error) || (nullptr == pHandle) ||
 162             osl_win32_CreateFile_impl_(tmp_name, b_delete_on_close, pHandle))
 163             break;
 164
 165     } while(true); // try until success
 166
 167     if ((osl_error == osl_File_E_None) && !b_delete_on_close)
 168     {
 169         rtl_uString* pustr = nullptr;
 170         rtl_uString_newFromStr(&pustr, o3tl::toU(tmp_name));
 171         osl_getFileURLFromSystemPath(pustr, ppustrTempFileURL);
 172         rtl_uString_release(pustr);
 173     }
 174
 175     return osl_error;
 176 }
 177
 178 oslFileError SAL_CALL osl_createTempFile(
 179     rtl_uString*   pustrDirectoryURL,
 180     oslFileHandle* pHandle,
 181     rtl_uString**  ppustrTempFileURL)
 182 {
 183     rtl_uString*    base_directory = nullptr;
 184     LPWSTR          tmp_name;
 185     sal_Bool        b_delete_on_close;
 186     oslFileError    osl_error;
 187
 188     osl_error = osl_setup_createTempFile_impl_(
 189         pustrDirectoryURL,
 190         pHandle,
 191         ppustrTempFileURL,
 192         &base_directory,
 193         &b_delete_on_close);
 194
 195     if (osl_error != osl_File_E_None)
 196         return osl_error;
 197
 198     /* allocate enough space on the stack, the file name can not be longer than MAX_PATH */
 199     STACK_ALLOC(tmp_name, WCHAR, (rtl_uString_getLength(base_directory) + MAX_PATH));
 200
 201     if (tmp_name)
 202     {
 203         osl_error = osl_createTempFile_impl_(
 204             base_directory,
 205             tmp_name,
 206             b_delete_on_close,
 207             pHandle,
 208             ppustrTempFileURL);
 209     }
 210     else // stack alloc failed
 211     {
 212         osl_error = osl_File_E_NOMEM;
 213     }
 214
 215     if (base_directory)
 216         rtl_uString_release(base_directory);
 217
 218     return osl_error;
 219 }
 220
 221 oslFileError SAL_CALL osl_getTempDirURL(rtl_uString** pustrTempDir)
 222 {
 223     ::osl::LongPathBuffer< sal_Unicode > aBuffer( MAX_LONG_PATH );
 224     LPWSTR  lpBuffer = o3tl::toW(aBuffer);
 225     DWORD   nBufferLength = aBuffer.getBufSizeInSymbols() - 1;
 226
 227     DWORD           nLength;
 228     oslFileError    error;
 229
 230     nLength = GetTempPathW( aBuffer.getBufSizeInSymbols(), lpBuffer );
 231
 232     if ( nLength > nBufferLength )
 233     {
 234         // the provided path has invalid length
 235         error = osl_File_E_NOENT;
 236     }
 237     else if ( nLength )
 238     {
 239         if ( '\\' == lpBuffer[nLength-1] )
 240             --nLength;
 241
 242         const OUString ustrTempPath(o3tl::toU(lpBuffer), static_cast<sal_Int32>(nLength));
 243
 244         error = osl_getFileURLFromSystemPath(ustrTempPath.pData, pustrTempDir);
 245     }
 246     else
 247         error = oslTranslateFileError( GetLastError() );
 248
 249     return error;
 250 }
 251
 252 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */