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